# GroupDocs API References — Complete API Reference

> Class library and REST API 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. |
| 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; }
```

### 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. |
| 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; }
```

### 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 attribute-value pairs are placed in a single line.

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

##### getLeafTextNodesOnNewline()
```
public final boolean 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. By default is false (disabled) \\u2014 leaf text nodes are placed on the same line as their parents, without new indent.

**Returns:**
boolean
##### setLeafTextNodesOnNewline(boolean value)
```
public final void 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. By default is false (disabled) \\u2014 leaf text nodes are placed on the same line as their parents, without new indent.

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

##### getLeftIndent()
```
public final Length getLeftIndent()
```

Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt

**Returns:**
Length
##### setLeftIndent(Length value)
```
public final void setLeftIndent(Length value)
```

Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt

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

##### isDefault()
```
public final boolean isDefault()
```

Indicates whether this instance of XML formatting options has a default value

**Returns:**
boolean

### XmlHighlightOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/xmlhighlightoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class XmlHighlightOptions implements IEditOptions
```

Contains options, that allow to customize the XML highlighting during XML-to-HTML conversion
#### Methods

| Method | Description |
| --- | --- |
| getXmlTagsFontSettings() | Responsible for representing the font of XML tags (angle brackets with tag names) |
| getAttributeNamesFontSettings() | Responsible for representing the font of attribute names |
| getAttributeValuesFontSettings() | Responsible for representing the font of attribute values |
| getInnerTextFontSettings() | Responsible for representing the font of inner-tag text |
| getHtmlCommentsFontSettings() | Responsible for representing the font of HTML comments (including pair of opening and closing tags) |
| getCDataFontSettings() | Responsible for representing the font of CDATA sections (including pair of opening and closing tags) |
| isDefault() | Determines whether this XML Highlight options object has a default font settings |
| resetToDefault() | Resets the current font settings to their default values |
##### getXmlTagsFontSettings()
```
public final WebFont getXmlTagsFontSettings()
```

Responsible for representing the font of XML tags (angle brackets with tag names)

**Returns:**
WebFont
##### getAttributeNamesFontSettings()
```
public final WebFont getAttributeNamesFontSettings()
```

Responsible for representing the font of attribute names

**Returns:**
WebFont
##### getAttributeValuesFontSettings()
```
public final WebFont getAttributeValuesFontSettings()
```

Responsible for representing the font of attribute values

**Returns:**
WebFont
##### getInnerTextFontSettings()
```
public final WebFont getInnerTextFontSettings()
```

Responsible for representing the font of inner-tag text

**Returns:**
WebFont
##### getHtmlCommentsFontSettings()
```
public final WebFont getHtmlCommentsFontSettings()
```

Responsible for representing the font of HTML comments (including pair of opening and closing tags)

**Returns:**
WebFont
##### getCDataFontSettings()
```
public final WebFont getCDataFontSettings()
```

Responsible for representing the font of CDATA sections (including pair of opening and closing tags)

**Returns:**
WebFont
##### isDefault()
```
public final boolean isDefault()
```

Determines whether this XML Highlight options object has a default font settings

**Returns:**
boolean
##### resetToDefault()
```
public final void resetToDefault()
```

Resets the current font settings to their default values

### XpsSaveOptions
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.options/xpssaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class XpsSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving XPS (XML Paper Specifications) documents

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. It was developed 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.
#### Constructors

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

| Method | Description |
| --- | --- |
| getFontEmbedding() | Responsible for embedding font resources into resultant XPS 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. |
##### XpsSaveOptions()
```
public XpsSaveOptions()
```

##### getFontEmbedding()
```
public final byte getFontEmbedding()
```

Responsible for embedding font resources into resultant XPS document, which are used in the original document. By default doesn't embed any fonts (NotEmbed).

**Returns:**
byte
##### 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 |  |

### com.groupdocs.editor.words.fieldmanagement
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement.md

The **com.groupdocs.editor.words.fieldmanagement** namespace contains classes and interfaces related to the management and manipulation of form fields within documents. This namespace provides functionality to work with various types of form fields, such as text fields, checkboxes, dropdowns, etc., allowing users to interact with and modify form fields programmatically.

#### Classes

| Class | Description |
| --- | --- |
| CheckBoxForm | Represents a form field that displays a checkbox. |
| CurrentDateFormField | Represents a form field that displays the current date. |
| CurrentTimeFormField | Represents a form field that displays the current time. |
| DateFormField | Represents a form field that displays a date. |
| DropDownFormField | Represents a form field that displays a drop-down list. |
| FormFieldCollection | Represents a collection of form fields. |
| FormFieldType | Specifies the type of form field. |
| HelpText | Represents help text for a form field. |
| InvalidFormField | Represents the update of invalid form field names during the  FormFieldManager.FixInvalidFormFieldNames  operation. |
| NumberFormField | Represents a form field that accepts a number input. |
| TextFormField | Represents a form field that accepts text input. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IFormField | Represents a form field. |

### CheckBoxForm
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/checkboxform.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CheckBoxForm implements IFormField
```

Represents a form field that displays a checkbox.
#### Constructors

| Constructor | Description |
| --- | --- |
| CheckBoxForm(String stylesheet, String name) | Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CheckBox for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the state of the checkbox. |
| setValue(boolean value) | Gets or sets the value of the form field, which represents the state of the checkbox. |
##### CheckBoxForm(String stylesheet, String name)
```
public CheckBoxForm(String stylesheet, String name)
```

Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CheckBox for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  checkBoxField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  checkBoxField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final boolean getValue()
```

Gets or sets the value of the form field, which represents the state of the checkbox.

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

Gets or sets the value of the form field, which represents the state of the checkbox.

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

### CurrentDateFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/currentdateformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CurrentDateFormField implements IFormField
```

Represents a form field that displays the current date.
#### Constructors

| Constructor | Description |
| --- | --- |
| CurrentDateFormField(String stylesheet, String name) | Initializes a new instance of the CurrentDateFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CurrentDate for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the current date. |
| setValue(Date value) | Gets or sets the value of the form field, which represents the current date. |
##### CurrentDateFormField(String stylesheet, String name)
```
public CurrentDateFormField(String stylesheet, String name)
```

Initializes a new instance of the CurrentDateFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CurrentDate for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents the current date.

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

Gets or sets the value of the form field, which represents the current date.

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

### CurrentTimeFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/currenttimeformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CurrentTimeFormField implements IFormField
```

Represents a form field that displays the current time.
#### Constructors

| Constructor | Description |
| --- | --- |
| CurrentTimeFormField(String stylesheet, String name) | Initializes a new instance of the CurrentTimeFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CurrentTime for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the current time. |
| setValue(Date value) | Gets or sets the value of the form field, which represents the current time. |
##### CurrentTimeFormField(String stylesheet, String name)
```
public CurrentTimeFormField(String stylesheet, String name)
```

Initializes a new instance of the CurrentTimeFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CurrentTime for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents the current time.

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

Gets or sets the value of the form field, which represents the current time.

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

### DateFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/dateformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class DateFormField implements IFormField
```

Represents a form field that displays a date.
#### Constructors

| Constructor | Description |
| --- | --- |
| DateFormField(String stylesheet, String name) | Initializes a new instance of the DateFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Date for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents a date. |
| setValue(Date value) | Gets or sets the value of the form field, which represents a date. |
##### DateFormField(String stylesheet, String name)
```
public DateFormField(String stylesheet, String name)
```

Initializes a new instance of the DateFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Date for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dateField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dateField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents a date.

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

Gets or sets the value of the form field, which represents a date.

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

### DropDownFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/dropdownformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class DropDownFormField implements IFormField
```

Represents a form field that displays a drop-down list.
#### Constructors

| Constructor | Description |
| --- | --- |
| DropDownFormField(String stylesheet, String name) | Initializes a new instance of the DropDownFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getSelectedIndex() | Gets or sets the index of the selected item in the drop-down list. |
| setSelectedIndex(int value) | Gets or sets the index of the selected item in the drop-down list. |
| getType() | Gets the type of the form field, which is always FormFieldType.DropDown for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the list of options in the drop-down list. |
| setValue(List<String> value) | Gets or sets the value of the form field, which represents the list of options in the drop-down list. |
##### DropDownFormField(String stylesheet, String name)
```
public DropDownFormField(String stylesheet, String name)
```

Initializes a new instance of the DropDownFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getSelectedIndex()
```
public final int getSelectedIndex()
```

Gets or sets the index of the selected item in the drop-down list.

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

Gets or sets the index of the selected item in the drop-down list.

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

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

Gets the type of the form field, which is always FormFieldType.DropDown for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dropDownField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dropDownField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

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

Gets or sets the value of the form field, which represents the list of options in the drop-down list.

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

Gets or sets the value of the form field, which represents the list of options in the drop-down list.

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

### FormFieldCollection
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/formfieldcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class FormFieldCollection implements Iterable<IFormField>
```

Represents a collection of form fields.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldCollection() | Initializes a new instance of the FormFieldCollection class. |
#### Methods

| Method | Description |
| --- | --- |
| iterator() | Returns an enumerator that iterates through the collection. |
| insert(IFormField field) | Inserts a form field into the collection. |
| get(String name) | Gets the form field with the specified name. |
| <T>getFormField(String name, Class<T> type) | Gets the form field with the specified name and type. |
##### FormFieldCollection()
```
public FormFieldCollection()
```

Initializes a new instance of the FormFieldCollection class.

##### iterator()
```
public Iterator<IFormField> iterator()
```

Returns an enumerator that iterates through the collection.

**Returns:**
java.util.Iterator<com.groupdocs.editor.words.fieldmanagement.IFormField> - An enumerator that can be used to iterate through the collection.
##### insert(IFormField field)
```
public void insert(IFormField field)
```

Inserts a form field into the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| field | IFormField | The form field to insert. |

##### get(String name)
```
public IFormField get(String name)
```

Gets the form field with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the form field. |

**Returns:**
IFormField - The form field with the specified name, if found; otherwise,  null .
##### <T>getFormField(String name, Class<T> type)
```
public T <T>getFormField(String name, Class<T> type)
```

Gets the form field with the specified name and type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the form field.

 T : The type of the form field. |
| type | java.lang.Class<T> |  |

**Returns:**
T - The form field with the specified name and type, if found; otherwise, the default value for the type.

### FormFieldType
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/formfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormFieldType
```

Specifies the type of form field.
#### Fields

| Field | Description |
| --- | --- |
| Text | The text form field can contain any text. |
| Number | The text form field can contain only numbers. |
| Date | The text form field can contain only a valid date value. |
| CurrentDate | The text form field value is the current date when the field is updated. |
| CurrentTime | The text form field value is the current time when the field is updated. |
| CheckBox | The checkbox form field. |
| DropDown | The drop-down field. |
##### Text
```
public static final int Text
```

The text form field can contain any text.

##### Number
```
public static final int Number
```

The text form field can contain only numbers.

##### Date
```
public static final int Date
```

The text form field can contain only a valid date value.

##### CurrentDate
```
public static final int CurrentDate
```

The text form field value is the current date when the field is updated.

##### CurrentTime
```
public static final int CurrentTime
```

The text form field value is the current time when the field is updated.

##### CheckBox
```
public static final int CheckBox
```

The checkbox form field.

##### DropDown
```
public static final int DropDown
```

The drop-down field.

### HelpText
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/helptext.md

**Inheritance:**
java.lang.Object
```
public final class HelpText
```

Represents help text for a form field.
#### Constructors

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

| Method | Description |
| --- | --- |
| getUseOwn() | Gets or sets a value indicating whether the form field should use its own help text. |
| setUseOwn(boolean value) | Gets or sets a value indicating whether the form field should use its own help text. |
| getText() | Gets or sets the text content of the help text. |
| setText(String value) | Gets or sets the text content of the help text. |
##### HelpText()
```
public HelpText()
```

##### getUseOwn()
```
public final boolean getUseOwn()
```

Gets or sets a value indicating whether the form field should use its own help text.

If set to  false , the help text will not be applied.

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

Gets or sets a value indicating whether the form field should use its own help text.

If set to  false , the help text will not be applied.

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

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

Gets or sets the text content of the help text.

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

Gets or sets the text content of the help text.

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

### IFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/iformfield.md

### InvalidFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/invalidformfield.md

**Inheritance:**
java.lang.Object
```
public final class InvalidFormField
```

Represents the update of invalid form field names during the  FormFieldManager.FixInvalidFormFieldNames  operation.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFormField(String name) | Initializes a new instance of the InvalidFormField class with the specified name. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the original name of the form field that cannot be modified outside  FormFieldManager . |
| getFixedName() | Gets or sets the new name for the form field after repair. |
| setFixedName(String value) | Gets or sets the new name for the form field after repair. |
##### InvalidFormField(String name)
```
public InvalidFormField(String name)
```

Initializes a new instance of the InvalidFormField class with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The original name of the form field. |

##### getName()
```
public final String getName()
```

Gets the original name of the form field that cannot be modified outside  FormFieldManager .

**Returns:**
java.lang.String
##### getFixedName()
```
public final String getFixedName()
```

Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name.

```
FixedName = String.format("%s_fixed", name); // as default value.
```

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

Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name.

```
FixedName = string.Format("{0}_fixed", name) // as default value.
```

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

### NumberFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/numberformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class NumberFormField implements IFormField
```

Represents a form field that accepts a number input.
#### Constructors

| Constructor | Description |
| --- | --- |
| NumberFormField(String stylesheet, String name) | Initializes a new instance of the NumberFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Number for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents a number. |
| setValue(float value) | Gets or sets the value of the form field, which represents a number. |
| getMaxLength() | Gets or sets the maximum length of the input for the form field. |
| setMaxLength(int value) | Gets or sets the maximum length of the input for the form field. |
##### NumberFormField(String stylesheet, String name)
```
public NumberFormField(String stylesheet, String name)
```

Initializes a new instance of the NumberFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Number for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  numberField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  numberField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final float getValue()
```

Gets or sets the value of the form field, which represents a number.

**Returns:**
float
##### setValue(float value)
```
public final void setValue(float value)
```

Gets or sets the value of the form field, which represents a number.

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

##### getMaxLength()
```
public final int getMaxLength()
```

Gets or sets the maximum length of the input for the form field.

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

Gets or sets the maximum length of the input for the form field.

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

### TextFormField
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.words.fieldmanagement/textformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class TextFormField implements IFormField
```

Represents a form field that accepts text input.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFormField(String stylesheet, String name) | Initializes a new instance of the TextFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Text for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the text input. |
| setValue(String value) | Gets or sets the value of the form field, which represents the text input. |
| getMaxLength() | Gets or sets the maximum length of the input for the form field. |
| setMaxLength(int value) | Gets or sets the maximum length of the input for the form field. |
##### TextFormField(String stylesheet, String name)
```
public TextFormField(String stylesheet, String name)
```

Initializes a new instance of the TextFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Text for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  textField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  textField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final String getValue()
```

Gets or sets the value of the form field, which represents the text input.

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

Gets or sets the value of the form field, which represents the text input.

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

##### getMaxLength()
```
public final int getMaxLength()
```

Gets or sets the maximum length of the input for the form field.

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

Gets or sets the maximum length of the input for the form field.

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

### com.groupdocs.editor
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor.md

The **com.groupdocs.editor** namespace is a root namespace, which provides classes for editing multiple document formats in your Java applications.

#### Classes

| Class | Description |
| --- | --- |
| EditableDocument | Intermediate document, that contains content before and after editing |
| Editor | Main class, which encapsulates conversion methods. |
| EncryptedException | The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates. |
| FormFieldManager |  |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| InvalidFormatException | The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format. |
| PasswordRequiredException | The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document. |

### EditableDocument
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/editabledocument.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IAuxDisposable
```
public final class EditableDocument implements IAuxDisposable
```

Intermediate document, that contains content before and after editing

Instance of EditableDocument class can be produced by the Editor.edit() method or created by the user himself using static factories. EditableDocument internally stores document in its own closed format, which is compatible (convertible) with all import and export formats, that GroupDocs.Editor supports. In order to make document editable in any WYSIWYG client-side editor (like CKEditor or TinyMCE), EditableDocument provides methods for generating HTML markup and producing resources, that can be accepted by the user.
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| getImages() | Allows to obtain external image resources (raster images), which are used by this HTML document |
| getFonts() | Allows to obtain external font resources, which are used by this HTML document |
| getCss() | Returns a list of CSS resources |
| getAudio() | Returns a list of audio resources |
| getAllResources() | Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts |
| getContent(OutputStream storage, Charset encoding) | Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding |
| getBodyContent() | Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string. |
| getBodyContent(String externalImagesTemplate) | Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix. |
| getContent() | Returns overall content of the HTML document as a string. |
| getContentString(String externalImagesTemplate, String externalCssTemplate) | Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix. |
| getCssContent() | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. |
| getCssContent(String externalImagesPrefix, String externalFontsPrefix) | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. |
| getEmbeddedHtml() | Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form. |
| save(String htmlFilePath) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources. |
| save(String htmlFilePath, String resourcesFolderPath) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path. |
| save(Writer htmlMarkup, HtmlSaveOptions saveOptions) |  |
| fromMarkup(String newHtmlContent, List<IHtmlResource> resources) | Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources |
| fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath) | Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path |
| fromFile(String htmlFilePath, String resourceFolderPath) | Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the \*.html file itself and a folder with linked resources |
| dispose() | Disposes this Editable document instance, disposing its content and making its methods and properties non-working |
| isDisposed() | Determines whether this Editable document was already disposed (true) or not (false) |
##### Disposed
```
public final Event<EventHandler> Disposed
```

##### getImages()
```
public final List<IImageResource> getImages()
```

Allows to obtain external image resources (raster images), which are used by this HTML document

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.images.IImageResource>
##### getFonts()
```
public final List<FontResourceBase> getFonts()
```

Allows to obtain external font resources, which are used by this HTML document

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase>
##### getCss()
```
public final List<CssText> getCss()
```

Returns a list of CSS resources

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.textual.CssText>
##### getAudio()
```
public final List<Mp3Audio> getAudio()
```

Returns a list of audio resources

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.audio.Mp3Audio>
##### getAllResources()
```
public final List<IHtmlResource> getAllResources()
```

Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts

This property returns a concatenated result of 'Images', 'Fonts', and 'Css' properties

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.IHtmlResource>
##### getContent(OutputStream storage, Charset encoding)
```
public OutputStream getContent(OutputStream storage, Charset encoding)
```

Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storage | java.io.OutputStream | Non-null byte stream, which supports writing |
| encoding | java.nio.charset.Charset | Non-null text encoding, which should be apllied while writing text content into specified  storage

 TStream : Any implementation of the java.io.InputStream |

**Returns:**
java.io.OutputStream - Instance of specified  storage
##### getBodyContent()
```
public final String getBodyContent()
```

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string.

**Returns:**
java.lang.String - String, which contains the body of the HTML document

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload doesn't allow to adjust URIs for external resource requests.
##### getBodyContent(String externalImagesTemplate)
```
public final String getBodyContent(String externalImagesTemplate)
```

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added.

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload allows to adjust URIs for external resource requests. |

**Returns:**
java.lang.String - String, which contains the body of the HTML document with links, adjusted to the external images
##### getContent()
```
public String getContent()
```

Returns overall content of the HTML document as a string.

**Returns:**
java.lang.String - String, which contains the content of the HTML document
##### getContentString(String externalImagesTemplate, String externalCssTemplate)
```
public String getContentString(String externalImagesTemplate, String externalCssTemplate)
```

Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added. |
| externalCssTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external stylesheets in LINK elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added. |

**Returns:**
java.lang.String - String, which contains the content of the HTML document with links, adjusted to the external resources
##### getCssContent()
```
public final List<String> getCssContent()
```

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document.

**Returns:**
java.util.List<java.lang.String> - A list of strings, where each string holds a content of one CSS document
##### getCssContent(String externalImagesPrefix, String externalFontsPrefix)
```
public final List<String> getCssContent(String externalImagesPrefix, String externalFontsPrefix)
```

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesPrefix | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images, which will be present in CSS declarations in the resultant CSS strings. If NULL or empty, prefixes will not be added. |
| externalFontsPrefix | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external fonts in the |

**Returns:**
java.util.List<java.lang.String> - A list of strings, where each string holds a content of one CSS document
##### getEmbeddedHtml()
```
public final String getEmbeddedHtml()
```

Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.

**Returns:**
java.lang.String - String, which is not NULL or empty in any case
##### save(String htmlFilePath)
```
public final void save(String htmlFilePath)
```

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | Full path to the file, where HTML markup will be stored. File will be created or overwritten, if exists. Accompanying resource folder will be created in the same folder, where HTML file exist. |

##### save(String htmlFilePath, String resourcesFolderPath)
```
public final void save(String htmlFilePath, String resourcesFolderPath)
```

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | Full path to the file, where HTML markup will be stored. Cannot be NULL or empty. File will be created or overwritten, if exists. |
| resourcesFolderPath | java.lang.String | Full path to the accompanying folder, where all related resources will be stored. If NULL or empty, folder will be created automatically in the same directory, where \*.html file. If specified and not exists, will be created. |

##### save(Writer htmlMarkup, HtmlSaveOptions saveOptions)
```
public void save(Writer htmlMarkup, HtmlSaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlMarkup | java.io.Writer |  |
| saveOptions | HtmlSaveOptions |  |

##### fromMarkup(String newHtmlContent, List<IHtmlResource> resources)
```
public static EditableDocument fromMarkup(String newHtmlContent, List<IHtmlResource> resources)
```

Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | java.lang.String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resources | java.util.List<com.groupdocs.editor.htmlcss.resources.IHtmlResource> | Collection of all resources (images, stylesheets, fonts), that are used in the HTML-document, specified in  newHtmlContent  parameter. May be absent (NULL or empty collection). |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath)
```
public static EditableDocument fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath)
```

Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | java.lang.String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resourceFolderPath | java.lang.String | Mandatory path to the folder with resources. All stylesheets, which are located in this folder, will be used. Cannot be NULL or empty string, and this folder should exists.

This static factory is useful when content of HTML document is presented as a string, but all resources are located in some folder, and often links to these resources in HTML markup are invalid and absent. When invoking this method, it scans specified folder and automatically applies all found stylesheets to the document. This method is very useful when obtaining content from different HTML editors, which usually cut off the document metadata and so on. |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### fromFile(String htmlFilePath, String resourceFolderPath)
```
public static EditableDocument fromFile(String htmlFilePath, String resourceFolderPath)
```

Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the \*.html file itself and a folder with linked resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | String, that contains a full path to the HTML file. Cannot be null, should be valid file path, and file itself should exists. |
| resourceFolderPath | java.lang.String | Optional path to the folder with HTML resources. If NULL, invalid or such folder doesn't exist, Editor will try to find the this folder by itself, analyzing the HTML markup |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### dispose()
```
public final void dispose()
```

Disposes this Editable document instance, disposing its content and making its methods and properties non-working

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this Editable document was already disposed (true) or not (false)

**Returns:**
boolean

### Editor
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/editor.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IAuxDisposable
```
public final class Editor implements IAuxDisposable
```

Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a 'using' directive or dispose its resources manually via 'Dispose()' method call. Document loading is performed through constructors. Document editing - through method 'Edit', and saving back to the resultant document after edit - through method 'Save'.

Editor class should be considered as an entry point and the root object of the GroupDocs.Editor. All operations are performed using this class. Typical usage of the Editor class for performing a full document editing pipeline is the next:

 *  Load a document into the Editor instance through its constructor.
 *  Optionally, detect a document type using a  method.
 *  Open a document for editing by calling an  method and obtaining an instance of  class from it..
 *  Editing a document content on client-side using any WYSIWYG HTML-editor.
 *  Creating a new instance of  from edited document content.
 *  Saving an edited document to some output format by calling a  method.
 *  Disposing an instance of Editor class via 'using' operator or manually.
#### Constructors

| Constructor | Description |
| --- | --- |
| Editor(DocumentFormatBase format) | Initializes a new instance of the Editor class and creates a new empty document based on the specified format. |
| Editor(InputStream document) | Initializes new Editor instance with specified input document (as a stream) |
| Editor(InputStream document, ILoadOptions loadOptions) | Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings |
| Editor(String filePath) | Initializes new Editor instance with specified input document (as a full file path) |
| Editor(String filePath, ILoadOptions loadOptions) | Initializes new Editor instance with specified input document (as a full file path) with its load options |
#### Methods

| Method | Description |
| --- | --- |
| edit(IEditOptions editOptions) | Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| edit() | Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions) | Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream |
| save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions) | Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path |
| save(EditableDocument inputDocument, String filePath) | Converts the specified edited document (represented by an EditableDocument) to an output document whose format is determined from the filename extension, and saves it to the specified file path. |
| save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions) | Converts the original document after modification (for example,  FormFieldManager (\#getFormFieldManager.getFormFieldManager)), to the resultant document of the specified format and saves its content to the provided stream. |
| save(OutputStream outputDocument) | Save the current document content to the specified output stream. |
| getDocumentInfo(String password) | Returns metadata about the document, that was loaded to this 'Editor' instance |
| dispose() | Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage |
| isDisposed() | Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false) |
##### Editor(DocumentFormatBase format)
```
public Editor(DocumentFormatBase format)
```

Initializes a new instance of the Editor class and creates a new empty document based on the specified format.

> ```
> IDocumentFormat format = WordProcessingFormats.Docx;
>  Editor editor = new Editor(format);
>  {
>      // Use the editor instance to edit and save documents
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | DocumentFormatBase | represents the file format of the document that will be created. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(InputStream document)
```
public Editor(InputStream document)
```

Initializes new Editor instance with specified input document (as a stream)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Delegate, that should return a stream with document content. Should not be NULL. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(InputStream document, ILoadOptions loadOptions)
```
public Editor(InputStream document, ILoadOptions loadOptions)
```

Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Delegate, that should return a stream with document content. Should not be NULL. |
| loadOptions | ILoadOptions | Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied. |

##### Editor(String filePath)
```
public Editor(String filePath)
```

Initializes new Editor instance with specified input document (as a full file path)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Full path to the file. Should not be NULL. Should be valid, and file should exist. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(String filePath, ILoadOptions loadOptions)
```
public Editor(String filePath, ILoadOptions loadOptions)
```

Initializes new Editor instance with specified input document (as a full file path) with its load options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Full path to the file. Should not be NULL. Should be valid, and file should exist. |
| loadOptions | ILoadOptions | Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]
 *  More about how to open and edit password-protected documents and document from different storages: [Load and edit documents using GroupDocs.Editor][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/
[Load and edit documents using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/load-document/ |

##### edit(IEditOptions editOptions)
```
public final EditableDocument edit(IEditOptions editOptions)
```

Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| editOptions | IEditOptions | Format-specific document options, which allows to tune-up conversion process. Should not be NULL. Should not conflict with previously applied load options.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload obtains edit options, which are specific for family formats.

[How to edit document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Edit+document |

**Returns:**
EditableDocument
##### edit()
```
public final EditableDocument edit()
```

Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources.

**Returns:**
EditableDocument - Instance of the 'EditableDocument' class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload applies edit options, which are default for the format, to which the input document belongs.

[How to edit document using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/edit-document/
##### save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions)
```
public final void save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions)
```

Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of 'EditableDocument' class, which should be converted to output document of some specific format |
| outputDocument | java.io.OutputStream | Output stream, in which the content of the resultant document will be recorded. Should not be NULL, disposed, should support writing. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. **Learn more**

 *  More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

##### save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions)
```
public final void save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions)
```

Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '' class, which should be converted to output document of some specific format. Must not be null or disposed. |
| filePath | java.lang.String | Path to the file, in which the output document will be saved. It file with the same name exists, it will be completely rewritten. String with path must not be null, empty or contain only whitespaces. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Must not be null. **Learn more**

 *  More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

##### save(EditableDocument inputDocument, String filePath)
```
public final void save(EditableDocument inputDocument, String filePath)
```

Converts the specified edited document (represented by an EditableDocument) to an output document whose format is determined from the filename extension, and saves it to the specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document that was edited in a WYSIWYG HTML editor and is stored as an EditableDocument instance. Must not be  null  or disposed. |
| filePath | java.lang.String | Path to the file where the output document will be saved. If a file with the same name exists, it will be completely overwritten. The path string must not be  null , empty, or contain only whitespaces. Because the default save options and output format are determined from this filename, it must have a valid extension. |

##### save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions)
```
public final OutputStream save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions)
```

Converts the original document after modification (for example,  FormFieldManager (\#getFormFieldManager.getFormFieldManager)), to the resultant document of the specified format and saves its content to the provided stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | java.io.OutputStream | The stream to which the output document will be saved. This stream should be writable and positioned at the start of the document content. Must not be null. |
| saveOptions | WordProcessingSaveOptions | Document saving options that define the format of the resultant document, as well as general and format-specific saving options. Must not be null.

If the  outputDocument  or  saveOptions  is null, an NullPointerException will be thrown. If the document to save is missing, an NullPointerException will be thrown.

 **Learn more:**

 *   |

**Returns:**
java.io.OutputStream - The stream containing the saved document content.
##### save(OutputStream outputDocument)
```
public final OutputStream save(OutputStream outputDocument)
```

Save the current document content to the specified output stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | java.io.OutputStream | The stream to which the document content will be saved. This cannot be null.

This method copies the content from the internal document representation to the provided output stream. The stream's original position is preserved after the save operation. |

**Returns:**
java.io.OutputStream - The stream with the saved document content.
##### getDocumentInfo(String password)
```
public final IDocumentInfo getDocumentInfo(String password)
```

Returns metadata about the document, that was loaded to this 'Editor' instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | User can specify a password for a document, if this document is encrypted with the password. May be NULL or empty string, that is equivalent to the absent password. For those document formats, which do not have a password protection feature, this argument will be ignored. If the document is encrypted, and password in not specified in this parameter, but it was specified before in the load options while creating this  instance, it will be used. **Learn more**

 *  Learn more about obtaining document specific properties in code: [How to get document info using GroupDocs.Editor][]

[How to get document info using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/extracting-document-metainfo/ |

**Returns:**
IDocumentInfo
##### dispose()
```
public final void dispose()
```

Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage

##### isDisposed()
```
public final boolean isDisposed()
```

Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false)

**Returns:**
boolean

### EncryptedException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/encryptedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception
```
public final class EncryptedException extends System.Exception
```

The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates.
#### Constructors

| Constructor | Description |
| --- | --- |
| EncryptedException() |  |
| EncryptedException(String message) |  |
| EncryptedException(String message, RuntimeException inner) |  |
##### EncryptedException()
```
public EncryptedException()
```

##### EncryptedException(String message)
```
public EncryptedException(String message)
```

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

##### EncryptedException(String message, RuntimeException inner)
```
public EncryptedException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### FormFieldManager
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/formfieldmanager.md

**Inheritance:**
java.lang.Object
```
public class FormFieldManager
```
#### Methods

| Method | Description |
| --- | --- |
| getFormFieldCollection() |  |
| updateFormFields(FormFieldCollection formFieldCollection) |  |
| fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames) |  |
| hasInvalidFormFields() |  |
| removeFormField(IFormField formField) |  |
| getInvalidFormFieldNames() |  |
| removeFormFields(List<IFormField> formFields) |  |
##### getFormFieldCollection()
```
public FormFieldCollection getFormFieldCollection()
```

**Returns:**
FormFieldCollection
##### updateFormFields(FormFieldCollection formFieldCollection)
```
public void updateFormFields(FormFieldCollection formFieldCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formFieldCollection | FormFieldCollection |  |

##### fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames)
```
public void fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateInvalidFormFieldNames | java.util.List<com.groupdocs.editor.words.fieldmanagement.InvalidFormField> |  |

##### hasInvalidFormFields()
```
public boolean hasInvalidFormFields()
```

**Returns:**
boolean
##### removeFormField(IFormField formField)
```
public void removeFormField(IFormField formField)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formField | IFormField |  |

##### getInvalidFormFieldNames()
```
public Collection<InvalidFormField> getInvalidFormFieldNames()
```

**Returns:**
java.util.Collection<com.groupdocs.editor.words.fieldmanagement.InvalidFormField>
##### removeFormFields(List<IFormField> formFields)
```
public void removeFormFields(List<IFormField> formFields)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formFields | java.util.List<com.groupdocs.editor.words.fieldmanagement.IFormField> |  |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class IncorrectPasswordException extends RuntimeException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() |  |
| IncorrectPasswordException(String message) |  |
| IncorrectPasswordException(String message, RuntimeException inner) |  |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

##### IncorrectPasswordException(String message)
```
public IncorrectPasswordException(String message)
```

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

##### IncorrectPasswordException(String message, RuntimeException inner)
```
public IncorrectPasswordException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### InvalidFormatException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/invalidformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class InvalidFormatException extends RuntimeException
```

The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format.

For example, this exception will be thrown, if try to open Spreadsheet document with WordProcessing document options.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFormatException() |  |
| InvalidFormatException(String message) |  |
| InvalidFormatException(String message, RuntimeException inner) |  |
##### InvalidFormatException()
```
public InvalidFormatException()
```

##### InvalidFormatException(String message)
```
public InvalidFormatException(String message)
```

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

##### InvalidFormatException(String message, RuntimeException inner)
```
public InvalidFormatException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### PasswordRequiredException
Path: https://reference.groupdocs.com/editor/java/com.groupdocs.editor/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class PasswordRequiredException extends RuntimeException
```

The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() |  |
| PasswordRequiredException(String message) |  |
| PasswordRequiredException(String message, RuntimeException inner) |  |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

##### PasswordRequiredException(String message)
```
public PasswordRequiredException(String message)
```

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

##### PasswordRequiredException(String message, RuntimeException inner)
```
public PasswordRequiredException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

## .NET

### GroupDocs.Editor for .NET
Path: https://reference.groupdocs.com/editor/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Editor | The GroupDocs.Editor namespace provides classes for editing documents using 3rd party front-end WYSIWYG editors without any additional applications. |
| GroupDocs.Editor.Formats | The GroupDocs.Editor.Formats namespace provides interfaces and classes that describes supported document formats. |
| GroupDocs.Editor.Formats.Abstraction | The Abstraction namespace provides interfaces and classes that describe supported document formats in the GroupDocs.Editor library. |
| GroupDocs.Editor.HtmlCss.Css.DataTypes | The GroupDocs.Editor.HtmlCss.Css.DataTypes namespace provides classes that represent CSS data types. |
| GroupDocs.Editor.HtmlCss.Css.Properties | The GroupDocs.Editor.HtmlCss.Css.Properties namespace provides types that represent different CSS properties (components of CSS declarations). |
| GroupDocs.Editor.HtmlCss.Exceptions | The GroupDocs.Editor.HtmlCss.Exceptions namespace provides classes that are responsible for all HTML-, CSS-, images-, fonts-, and other resource-related processing. |
| GroupDocs.Editor.HtmlCss.Resources | The GroupDocs.Editor.HtmlCss.Resources namespace provides classes that represent all kinds of the HTML resources. |
| GroupDocs.Editor.HtmlCss.Resources.Audio | The GroupDocs.Editor.HtmlCss.Resources.Audio namespace provides types that represent audio resources. |
| GroupDocs.Editor.HtmlCss.Resources.Fonts | The GroupDocs.Editor.HtmlCss.Resources.Fonts namespace provides classes that represent font resources. |
| GroupDocs.Editor.HtmlCss.Resources.Images | The GroupDocs.Editor.HtmlCss.Resources.Images namespace provides classes that represent image resources of all types in general. |
| GroupDocs.Editor.HtmlCss.Resources.Images.Raster | The GroupDocs.Editor.HtmlCss.Resources.Images.Raster namespace provides classes that represent only raster image resources. |
| GroupDocs.Editor.HtmlCss.Resources.Images.Vector | The GroupDocs.Editor.HtmlCss.Resources.Images.Vector namespace provides classes that represent only vector image resources. |
| GroupDocs.Editor.HtmlCss.Resources.Textual | The GroupDocs.Editor.HtmlCss.Resources.Textual namespace provides classes that represent text resources. |
| GroupDocs.Editor.HtmlCss.Serialization | The GroupDocs.Editor.HtmlCss.Serialization namespace provides types, that are responsible for tuning HTML and CSS markup serialization process. |
| GroupDocs.Editor.Metadata | The GroupDocs.Editor.Metadata namespace provides classes for describing basic document properties dependent on document type. |
| GroupDocs.Editor.Options | The GroupDocs.Editor.Options namespace provides interfaces for load and save options. |
| GroupDocs.Editor.Words.FieldManagement | Contains classes and interfaces related to the management and manipulation of form fields within documents. This namespace provides functionality to work with various types of form fields, such as text fields, checkboxes, dropdowns, etc., allowing users to interact with and modify form fields programmatically. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### GroupDocs.Editor.Formats.Abstraction
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction.md

The Abstraction namespace provides interfaces and classes that describe supported document formats in the GroupDocs.Editor library.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatBase | Represents the base class for document formats, providing common functionality for format instances. |
| FormatFamilyBase | Represents the base class for format families, providing common functionality for format family instances. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentFormat | Represents the root interface for all supporting document formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### DocumentFormatBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase.md

#### DocumentFormatBase class

Represents the base class for document formats, providing common functionality for format instances.

```csharp
public abstract class DocumentFormatBase : FormatFamilyBase, IDocumentFormat
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| static FromMime&lt;T&gt;(string) | Retrieves an instance of the specified type *T* that has the specified MIME type. |
| implicit operator | Converts a `DocumentFormatBase` instance to a string implicitly. |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/equals.md

#### Equals(IDocumentFormat)

Determines whether this instance is equal to the specified `IDocumentFormat` instance.

```csharp
public bool Equals(IDocumentFormat other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IDocumentFormat | The `IDocumentFormat` instance to compare with the current instance. |

##### Return Value

`true` if the specified `IDocumentFormat` is equal to the current instance; otherwise, `false`.

#### Equals(object)

Determines whether this instance is equal to the specified `DocumentFormatBase` instance.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The `DocumentFormatBase` instance to compare with the current instance. |

##### Return Value

`true` if the specified `DocumentFormatBase` is equal to the current instance; otherwise, `false`.

### Extension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/extension.md

#### DocumentFormatBase.Extension property

Gets the file extension of the document format.

```csharp
public string Extension { get; }
```

### FormatFamily
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/formatfamily.md

#### DocumentFormatBase.FormatFamily property

Gets the format family to which the document format belongs.

```csharp
public FormatFamilies FormatFamily { get; }
```

### FromMime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/frommime.md

#### DocumentFormatBase.FromMime&lt;T&gt; method

Retrieves an instance of the specified type *T* that has the specified MIME type.

```csharp
public static T FromMime<T>(string mime)
    where T : DocumentFormatBase
```

| Parameter | Description |
| --- | --- |
| T | The type of document format. |
| mime | The MIME type of the document format. |

##### Return Value

An instance of the specified type *T* with the specified MIME type.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/gethashcode.md

#### DocumentFormatBase.GetHashCode method

Returns a hash code for the current object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current object, combining the hash codes of the base object, MIME type, file extension, and format family.

### Mime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/mime.md

#### DocumentFormatBase.Mime property

Gets the MIME type of the document format.

```csharp
public string Mime { get; }
```

### op_Implicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/documentformatbase/op_implicit.md

#### DocumentFormatBase Implicit operator

Converts a `DocumentFormatBase` instance to a string implicitly.

```csharp
public static implicit operator string(DocumentFormatBase extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | DocumentFormatBase | The `DocumentFormatBase` instance to convert. |

##### Return Value

The file extension of the `DocumentFormatBase` instance.

### FormatFamilyBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase.md

#### FormatFamilyBase class

Represents the base class for format families, providing common functionality for format family instances.

```csharp
public abstract class FormatFamilyBase : IEquatable<FormatFamilyBase>
```

#### Properties

| Name | Description |
| --- | --- |
| Id { get; } | Gets the unique identifier for the format family. |
| Name { get; } | Gets the name of the format family. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| static FromName&lt;T&gt;(string) | Retrieves an instance of the specified type *T* that has the specified name. |
| static FromValue&lt;T&gt;(int) | Retrieves an instance of the specified type *T* that has the specified identifier. |
| static GetAll&lt;T&gt;() | Retrieves all instances of the specified type *T* that derive from `FormatFamilyBase`. |
| operator == | Determines whether two `FormatFamilyBase` instances are equal. (2 operators) |
| explicit operator | Converts a string representing a format family name to a `FormatFamilyBase` object. (2 operators) |
| implicit operator | Converts a `FormatFamilyBase` instance to an integer implicitly. (2 operators) |
| operator != | Determines whether two `FormatFamilyBase` instances are not equal. (2 operators) |

##### Remarks

This class is abstract and must be inherited by a derived class that specifies the actual format family details.

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/equals.md

#### Equals(object)

Determines whether this instance is equal to the specified `FormatFamilyBase` instance.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The `FormatFamilyBase` instance to compare with the current instance. |

##### Return Value

`true` if the specified `FormatFamilyBase` is equal to the current instance; otherwise, `false`.

#### Equals(FormatFamilyBase)

Determines whether this instance is equal to the specified `FormatFamilyBase` instance.

```csharp
public bool Equals(FormatFamilyBase other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FormatFamilyBase | The `FormatFamilyBase` instance to compare with the current instance. |

##### Return Value

`true` if the specified `FormatFamilyBase` is equal to the current instance; otherwise, `false`.

### FromName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/fromname.md

#### FormatFamilyBase.FromName&lt;T&gt; method

Retrieves an instance of the specified type *T* that has the specified name.

```csharp
public static T FromName<T>(string name)
    where T : FormatFamilyBase
```

| Parameter | Description |
| --- | --- |
| T | The type of format family. |
| name | The name of the format family. |

##### Return Value

An instance of the specified type *T* with the specified name.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching format family is found. |

### FromValue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/fromvalue.md

#### FormatFamilyBase.FromValue&lt;T&gt; method

Retrieves an instance of the specified type *T* that has the specified identifier.

```csharp
public static T FromValue<T>(int value)
    where T : FormatFamilyBase
```

| Parameter | Description |
| --- | --- |
| T | The type of format family. |
| value | The identifier of the format family. |

##### Return Value

An instance of the specified type *T* with the specified identifier.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching format family is found. |

### GetAll
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/getall.md

#### FormatFamilyBase.GetAll&lt;T&gt; method

Retrieves all instances of the specified type *T* that derive from `FormatFamilyBase`.

```csharp
public static IEnumerable<T> GetAll<T>()
    where T : FormatFamilyBase
```

| Parameter | Description |
| --- | --- |
| T | The type of format family. |

##### Return Value

An enumerable collection of instances of the specified type *T*.

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/gethashcode.md

#### FormatFamilyBase.GetHashCode method

Returns a hash code for the current object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current object, suitable for use in hashing algorithms and data structures like a hash table.

##### Remarks

This method overrides GetHashCode. The hash code is computed using the object's `Id` and `Name` properties. The `unchecked` context allows overflow, which is acceptable in a hash code calculation context.

### Id
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/id.md

#### FormatFamilyBase.Id property

Gets the unique identifier for the format family.

```csharp
public int Id { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/name.md

#### FormatFamilyBase.Name property

Gets the name of the format family.

```csharp
public string Name { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/op_equality.md

#### operator ==

Determines whether two `FormatFamilyBase` instances are equal.

```csharp
public static bool operator ==(FormatFamilyBase first, FormatFamilyBase second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FormatFamilyBase | The first `FormatFamilyBase` instance to compare. |
| second | FormatFamilyBase | The second `FormatFamilyBase` instance to compare. |

##### Return Value

true if the two `FormatFamilyBase` instances are equal; otherwise, false.

#### operator ==

Determines whether a `FormatFamilyBase` instance is equal to a specified string name.

```csharp
public static bool operator ==(FormatFamilyBase first, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FormatFamilyBase | The `FormatFamilyBase` instance to compare. |
| name | String | The string name to compare with the `FormatFamilyBase` instance. |

##### Return Value

true if the `FormatFamilyBase` instance's name is equal to the specified string name; otherwise, false.

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/op_explicit.md

#### explicit operator

Converts a string representing a format family name to a `FormatFamilyBase` object.

```csharp
public static explicit operator FormatFamilyBase(string family)
```

| Parameter | Type | Description |
| --- | --- | --- |
| family | String | The name of the format family to convert. |

##### Return Value

A `FormatFamilyBase` object corresponding to the specified format family name.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when the specified format family name is invalid. |

#### explicit operator

Converts an integer representing a format family ID to a `FormatFamilyBase` object.

```csharp
public static explicit operator FormatFamilyBase(int id)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | Int32 | The ID of the format family to convert. |

##### Return Value

A `FormatFamilyBase` object corresponding to the specified format family ID.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when the specified format family ID is invalid. |

### op_Implicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/op_implicit.md

#### implicit operator

Converts a `FormatFamilyBase` instance to an integer implicitly.

```csharp
public static implicit operator int(FormatFamilyBase family)
```

| Parameter | Type | Description |
| --- | --- | --- |
| family | FormatFamilyBase | The `FormatFamilyBase` instance to convert. |

##### Return Value

The unique identifier of the `FormatFamilyBase` instance.

#### implicit operator

Converts a `FormatFamilyBase` instance to a string implicitly.

```csharp
public static implicit operator string(FormatFamilyBase family)
```

| Parameter | Type | Description |
| --- | --- | --- |
| family | FormatFamilyBase | The `FormatFamilyBase` instance to convert. |

##### Return Value

The name of the `FormatFamilyBase` instance.

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/op_inequality.md

#### operator !=

Determines whether two `FormatFamilyBase` instances are not equal.

```csharp
public static bool operator !=(FormatFamilyBase first, FormatFamilyBase second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FormatFamilyBase | The first `FormatFamilyBase` instance to compare. |
| second | FormatFamilyBase | The second `FormatFamilyBase` instance to compare. |

##### Return Value

true if the two `FormatFamilyBase` instances are not equal; otherwise, false.

#### operator !=

Determines whether a `FormatFamilyBase` instance is not equal to a specified string name.

```csharp
public static bool operator !=(FormatFamilyBase first, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FormatFamilyBase | The `FormatFamilyBase` instance to compare. |
| name | String | The string name to compare with the `FormatFamilyBase` instance. |

##### Return Value

true if the `FormatFamilyBase` instance's name is not equal to the specified string name; otherwise, false.

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/formatfamilybase/tostring.md

#### FormatFamilyBase.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object, which is the value of the `Name` property.

##### Remarks

This method overrides ToString to return the `Name` property of the object.

### IDocumentFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/idocumentformat.md

#### IDocumentFormat interface

Represents the root interface for all supporting document formats.

```csharp
public interface IDocumentFormat : IEquatable<IDocumentFormat>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the full formal name of the document format. |

### Extension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/idocumentformat/extension.md

#### IDocumentFormat.Extension property

Gets the file extension of the document format.

```csharp
public string Extension { get; }
```

### FormatFamily
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/idocumentformat/formatfamily.md

#### IDocumentFormat.FormatFamily property

Gets the format family to which the document format belongs.

```csharp
public FormatFamilies FormatFamily { get; }
```

### Mime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/idocumentformat/mime.md

#### IDocumentFormat.Mime property

Gets the MIME type of the document format.

```csharp
public string Mime { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.abstraction/idocumentformat/name.md

#### IDocumentFormat.Name property

Gets the full formal name of the document format.

```csharp
public string Name { get; }
```

### GroupDocs.Editor.Formats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats.md

The GroupDocs.Editor.Formats namespace provides interfaces and classes that describes supported document formats.

#### Classes

| Class | Description |
| --- | --- |
| EBookFormats | Encapsulates all eBook formats. Includes the following file types: `Mobi`, `Epub`, `Azw3`. |
| EmailFormats | Encapsulates all emails formats. Includes the following file types: `Tnef`, `Eml`, `Emlx`, `Msg`, `Html`, `Mhtml`. |
| FixedLayoutFormats | Represents fixed-layout (fixed-page) document formats, such as PDF, excluding raster image formats. |
| FormatFamilies | Represents the different format families available in the system. |
| PresentationFormats | Encapsulates all Presentation formats. Includes the following 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. Includes the following formats: `Xls`, `Xlt`, `Xlsx`, `Xlsm`, `Xlsb`, `Xltx`, `Xltm`, `Xlam`, `SpreadsheetML`, `Ods`, `Fods`, `Sxc`, `Dif`, `Csv`, `Tsv`. Learn more about Spreadsheet formats [here](https://wiki.fileformat.com/spreadsheet). |
| TextualFormats | Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others. Includes the following formats: `Html`, `Txt`, `Xml`, `Md`, `Json`, `Mhtml`, `Chm`. |
| WordProcessingFormats | Encapsulates all WordProcessing formats. Includes the following file types: |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### EBookFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats.md

#### EBookFormats class

Encapsulates all eBook formats. Includes the following file types: `Mobi`, `Epub`, `Azw3`.

```csharp
public class EBookFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `EBookFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `EBookFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `EBookFormats` object. |

#### 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. Learn more about this file format [here](https://docs.fileformat.com/ebook/azw3/). |
| static readonly 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](https://docs.fileformat.com/ebook/epub/). |
| static readonly 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](https://docs.fileformat.com/ebook/mobi/). |

##### Remarks

Learn more about Mobi format [here](https://docs.fileformat.com/ebook/mobi/), about AZW3 format [here](https://docs.fileformat.com/ebook/azw3/), and about ePub format [here](https://docs.fileformat.com/ebook/epub/).

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/all.md

#### EBookFormats.All property

Gets an enumerable collection of all `EBookFormats`.

```csharp
public static IEnumerable<EBookFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `EBookFormats`.

### Azw3
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/azw3.md

#### EBookFormats.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. Learn more about this file format [here](https://docs.fileformat.com/ebook/azw3/).

```csharp
public static readonly EBookFormats Azw3;
```

### Epub
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/epub.md

#### EBookFormats.Epub field

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](https://docs.fileformat.com/ebook/epub/).

```csharp
public static readonly EBookFormats Epub;
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/fromextension.md

#### EBookFormats.FromExtension method

Retrieves an instance of the specified type `EBookFormats` that has the specified file extension.

```csharp
public static EBookFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `EBookFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Mobi
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/mobi.md

#### EBookFormats.Mobi field

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](https://docs.fileformat.com/ebook/mobi/).

```csharp
public static readonly EBookFormats Mobi;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/ebookformats/op_explicit.md

#### EBookFormats Explicit operator

Converts a string representing a file extension to a `EBookFormats` object.

```csharp
public static explicit operator EBookFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `EBookFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| EBookFormats | Thrown when the specified file extension is null. |

### EmailFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats.md

#### EmailFormats class

Encapsulates all emails formats. Includes the following file types: `Tnef`, `Eml`, `Emlx`, `Msg`, `Html`, `Mhtml`.

```csharp
public class EmailFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `EmailFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `EmailFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `EmailFormats` object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Eml | EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://docs.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://docs.fileformat.com/email/emlx/). |
| static readonly Html | HTML formatted emails. |
| static readonly 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](https://docs.fileformat.com/email/ics/). |
| static readonly 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](https://docs.fileformat.com/email/mbox/). |
| static readonly Mhtml | MHTML, an initialism of "MIME encapsulation of aggregate HTML documents". |
| 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://docs.fileformat.com/email/msg/). |
| static readonly Oft | Files with .oft extension are template files that are created using Microsoft Outlook. Learn more about this file format [here](https://docs.fileformat.com/email/oft/). |
| static readonly Ost | Offline Storage Table (OST) file represents 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://docs.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://docs.fileformat.com/email/pst/). |
| static readonly 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](https://docs.fileformat.com/email/tnef/). |
| static readonly Vcf | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. Learn more about this file format [here](https://docs.fileformat.com/email/vcf/). |

##### Remarks

Learn more about emails format [here](https://docs.fileformat.com/email/).

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/all.md

#### EmailFormats.All property

Gets an enumerable collection of all `EmailFormats`.

```csharp
public static IEnumerable<EmailFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `EmailFormats`.

### Eml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/eml.md

#### EmailFormats.Eml field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://docs.fileformat.com/email/eml/).

```csharp
public static readonly EmailFormats Eml;
```

### Emlx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/emlx.md

#### EmailFormats.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://docs.fileformat.com/email/emlx/).

```csharp
public static readonly EmailFormats Emlx;
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/fromextension.md

#### EmailFormats.FromExtension method

Retrieves an instance of the specified type `EmailFormats` that has the specified file extension.

```csharp
public static EmailFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `EmailFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Html
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/html.md

#### EmailFormats.Html field

HTML formatted emails.

```csharp
public static readonly EmailFormats Html;
```

### Ics
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/ics.md

#### EmailFormats.Ics field

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](https://docs.fileformat.com/email/ics/).

```csharp
public static readonly EmailFormats Ics;
```

### Mbox
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/mbox.md

#### EmailFormats.Mbox field

MBox file format is a generic term that represents a container for collection of electronic mail messages. Learn more about this file format [here](https://docs.fileformat.com/email/mbox/).

```csharp
public static readonly EmailFormats Mbox;
```

### Mhtml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/mhtml.md

#### EmailFormats.Mhtml field

MHTML, an initialism of "MIME encapsulation of aggregate HTML documents".

```csharp
public static readonly EmailFormats Mhtml;
```

### Msg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/msg.md

#### EmailFormats.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://docs.fileformat.com/email/msg/).

```csharp
public static readonly EmailFormats Msg;
```

### Oft
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/oft.md

#### EmailFormats.Oft field

Files with .oft extension are template files that are created using Microsoft Outlook. Learn more about this file format [here](https://docs.fileformat.com/email/oft/).

```csharp
public static readonly EmailFormats Oft;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/op_explicit.md

#### EmailFormats Explicit operator

Converts a string representing a file extension to a `EmailFormats` object.

```csharp
public static explicit operator EmailFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `EmailFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| EmailFormats | Thrown when the specified file extension is null. |

### Ost
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/ost.md

#### EmailFormats.Ost field

Offline Storage Table (OST) file represents 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://docs.fileformat.com/email/ost/).

```csharp
public static readonly EmailFormats Ost;
```

### Pst
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/pst.md

#### EmailFormats.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://docs.fileformat.com/email/pst/).

```csharp
public static readonly EmailFormats Pst;
```

### Tnef
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/tnef.md

#### EmailFormats.Tnef field

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](https://docs.fileformat.com/email/tnef/).

```csharp
public static readonly EmailFormats Tnef;
```

### Vcf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/emailformats/vcf.md

#### EmailFormats.Vcf field

VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. Learn more about this file format [here](https://docs.fileformat.com/email/vcf/).

```csharp
public static readonly EmailFormats Vcf;
```

### FixedLayoutFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/fixedlayoutformats.md

#### FixedLayoutFormats class

Represents fixed-layout (fixed-page) document formats, such as PDF, excluding raster image formats.

```csharp
public class FixedLayoutFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets all available instances of `FixedLayoutFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves a `FixedLayoutFormats` instance matching the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Explicitly converts a file extension string to a `FixedLayoutFormats` instance. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Pdf | Portable Document Format (PDF), introduced by Adobe, provides standardized representation of documents independent of software, hardware, and operating systems. For additional details, see: [PDF file format](https://docs.fileformat.com/pdf/). |

##### Remarks

Fixed-layout formats precisely specify the placement and rendering of content on each page. Commonly used in document viewing, publishing, or editing applications like Adobe Acrobat and Adobe InDesign. These formats internally define page layouts and content positioning using vector graphics and text instructions.

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/fixedlayoutformats/all.md

#### FixedLayoutFormats.All property

Gets all available instances of `FixedLayoutFormats`.

```csharp
public static IEnumerable<FixedLayoutFormats> All { get; }
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/fixedlayoutformats/fromextension.md

#### FixedLayoutFormats.FromExtension method

Retrieves a `FixedLayoutFormats` instance matching the specified file extension.

```csharp
public static FixedLayoutFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension to match (e.g., "pdf"). |

##### Return Value

The matching `FixedLayoutFormats` instance.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown if no matching format is found. |

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/fixedlayoutformats/op_explicit.md

#### FixedLayoutFormats Explicit operator

Explicitly converts a file extension string to a `FixedLayoutFormats` instance.

```csharp
public static explicit operator FixedLayoutFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension string, possibly containing periods. |

##### Return Value

The corresponding `FixedLayoutFormats` instance.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown if *extension* is null. |

### Pdf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/fixedlayoutformats/pdf.md

#### FixedLayoutFormats.Pdf field

Portable Document Format (PDF), introduced by Adobe, provides standardized representation of documents independent of software, hardware, and operating systems. For additional details, see: [PDF file format](https://docs.fileformat.com/pdf/).

```csharp
public static readonly FixedLayoutFormats Pdf;
```

### FormatFamilies
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies.md

#### FormatFamilies class

Represents the different format families available in the system.

```csharp
public class FormatFamilies : FormatFamilyBase
```

#### Properties

| Name | Description |
| --- | --- |
| Id { get; } | Gets the unique identifier for the format family. |
| Name { get; } | Gets the name of the format family. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly EBook | Represents the eBook format family. Learn more about Mobi format [here](https://docs.fileformat.com/ebook/mobi/), about AZW3 format [here](https://docs.fileformat.com/ebook/azw3/), and about ePub format [here](https://docs.fileformat.com/ebook/epub/). |
| static readonly Email | Represents the Email format family. Learn more about emails format [here](https://docs.fileformat.com/email/). |
| static readonly FixedLayout | Represents the Fixed Layout format family. 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 “fixed-page” format documents. Such a document format describes precisely where a document’s 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. |
| static readonly Presentation | Represents the Presentation format family. Learn more about Presentation formats [here](https://wiki.fileformat.com/presentation). |
| static readonly Spreadsheet | Represents the Spreadsheet format family. 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. |
| static readonly Textual | Represents the Textual format family. Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others. |
| static readonly WordProcessing | Represents the Word Processing format family. Learn more about Word Processing formats [here](https://wiki.fileformat.com/word-processing). |

### EBook
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/ebook.md

#### FormatFamilies.EBook field

Represents the eBook format family. Learn more about Mobi format [here](https://docs.fileformat.com/ebook/mobi/), about AZW3 format [here](https://docs.fileformat.com/ebook/azw3/), and about ePub format [here](https://docs.fileformat.com/ebook/epub/).

```csharp
public static readonly FormatFamilies EBook;
```

### Email
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/email.md

#### FormatFamilies.Email field

Represents the Email format family. Learn more about emails format [here](https://docs.fileformat.com/email/).

```csharp
public static readonly FormatFamilies Email;
```

### FixedLayout
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/fixedlayout.md

#### FormatFamilies.FixedLayout field

Represents the Fixed Layout format family. 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 “fixed-page” format documents. Such a document format describes precisely where a document’s 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.

```csharp
public static readonly FormatFamilies FixedLayout;
```

### Presentation
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/presentation.md

#### FormatFamilies.Presentation field

Represents the Presentation format family. Learn more about Presentation formats [here](https://wiki.fileformat.com/presentation).

```csharp
public static readonly FormatFamilies Presentation;
```

### Spreadsheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/spreadsheet.md

#### FormatFamilies.Spreadsheet field

Represents the Spreadsheet format family. 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.

```csharp
public static readonly FormatFamilies Spreadsheet;
```

### Textual
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/textual.md

#### FormatFamilies.Textual field

Represents the Textual format family. Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others.

```csharp
public static readonly FormatFamilies Textual;
```

### WordProcessing
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/formatfamilies/wordprocessing.md

#### FormatFamilies.WordProcessing field

Represents the Word Processing format family. Learn more about Word Processing formats [here](https://wiki.fileformat.com/word-processing).

```csharp
public static readonly FormatFamilies WordProcessing;
```

##### Remarks

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)

### PresentationFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats.md

#### PresentationFormats class

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](https://wiki.fileformat.com/presentation).

```csharp
public class PresentationFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `PresentationFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `PresentationFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `PresentationFormats` object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Odp | OpenDocument Presentation (ODP). Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp). |
| static readonly Otp | OpenDocument Presentation template (OTP). Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp). |
| static readonly Pot | Microsoft PowerPoint 97-2003 Presentation Template (POT). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot). |
| static readonly Potm | Microsoft Office Open XML PresentationML Macro-Enabled Template (POTM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm). |
| static readonly Potx | Microsoft Office Open XML PresentationML Macro-Free Template (POTX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx). |
| static readonly Pps | Microsoft PowerPoint 97-2003 SlideShow (PPS). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps). |
| static readonly Ppsm | Microsoft Office Open XML PresentationML Macro-Enabled SlideShow (PPSM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm). |
| static readonly Ppsx | Microsoft Office Open XML PresentationML Macro-Free SlideShow (PPSX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx). |
| static readonly Ppt | Microsoft PowerPoint 97-2003 Presentation (PPT). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt). |
| static readonly Ppt95 | Microsoft PowerPoint 95 Presentation (PPT). |
| static readonly Pptm | Microsoft Office Open XML PresentationML Macro-Enabled Document (PPTM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm). |
| static readonly Pptx | Microsoft Office Open XML PresentationML Macro-Free Document (PPTX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx). |

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/all.md

#### PresentationFormats.All property

Gets an enumerable collection of all `PresentationFormats`.

```csharp
public static IEnumerable<PresentationFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `PresentationFormats`.

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/fromextension.md

#### PresentationFormats.FromExtension method

Retrieves an instance of the specified type `PresentationFormats` that has the specified file extension.

```csharp
public static PresentationFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `PresentationFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Odp
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/odp.md

#### PresentationFormats.Odp field

OpenDocument Presentation (ODP). Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp).

```csharp
public static readonly PresentationFormats Odp;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/op_explicit.md

#### PresentationFormats Explicit operator

Converts a string representing a file extension to a `PresentationFormats` object.

```csharp
public static explicit operator PresentationFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `PresentationFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| PresentationFormats | Thrown when the specified file extension is null. |

### Otp
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/otp.md

#### PresentationFormats.Otp field

OpenDocument Presentation template (OTP). Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp).

```csharp
public static readonly PresentationFormats Otp;
```

### Pot
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/pot.md

#### PresentationFormats.Pot field

Microsoft PowerPoint 97-2003 Presentation Template (POT). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot).

```csharp
public static readonly PresentationFormats Pot;
```

### Potm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/potm.md

#### PresentationFormats.Potm field

Microsoft Office Open XML PresentationML Macro-Enabled Template (POTM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm).

```csharp
public static readonly PresentationFormats Potm;
```

### Potx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/potx.md

#### PresentationFormats.Potx field

Microsoft Office Open XML PresentationML Macro-Free Template (POTX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx).

```csharp
public static readonly PresentationFormats Potx;
```

### Pps
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/pps.md

#### PresentationFormats.Pps field

Microsoft PowerPoint 97-2003 SlideShow (PPS). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps).

```csharp
public static readonly PresentationFormats Pps;
```

### Ppsm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/ppsm.md

#### PresentationFormats.Ppsm field

Microsoft Office Open XML PresentationML Macro-Enabled SlideShow (PPSM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm).

```csharp
public static readonly PresentationFormats Ppsm;
```

### Ppsx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/ppsx.md

#### PresentationFormats.Ppsx field

Microsoft Office Open XML PresentationML Macro-Free SlideShow (PPSX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx).

```csharp
public static readonly PresentationFormats Ppsx;
```

### Ppt
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/ppt.md

#### PresentationFormats.Ppt field

Microsoft PowerPoint 97-2003 Presentation (PPT). Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt).

```csharp
public static readonly PresentationFormats Ppt;
```

### Ppt95
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/ppt95.md

#### PresentationFormats.Ppt95 field

Microsoft PowerPoint 95 Presentation (PPT).

```csharp
public static readonly PresentationFormats Ppt95;
```

### Pptm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/pptm.md

#### PresentationFormats.Pptm field

Microsoft Office Open XML PresentationML Macro-Enabled Document (PPTM). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm).

```csharp
public static readonly PresentationFormats Pptm;
```

### Pptx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/presentationformats/pptx.md

#### PresentationFormats.Pptx field

Microsoft Office Open XML PresentationML Macro-Free Document (PPTX). Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx).

```csharp
public static readonly PresentationFormats Pptx;
```

### SpreadsheetFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats.md

#### SpreadsheetFormats class

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: `Xls`, `Xlt`, `Xlsx`, `Xlsm`, `Xlsb`, `Xltx`, `Xltm`, `Xlam`, `SpreadsheetML`, `Ods`, `Fods`, `Sxc`, `Dif`, `Csv`, `Tsv`. Learn more about Spreadsheet formats [here](https://wiki.fileformat.com/spreadsheet).

```csharp
public class SpreadsheetFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `SpreadsheetFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `SpreadsheetFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `SpreadsheetFormats` object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Csv | Comma Separated Values (CSV). Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/csv/). |
| static readonly Dif | Data Interchange Format (DIF). |
| static readonly Fods | Flat OpenDocument Spreadsheet (FODS). |
| static readonly Ods | OpenDocument Spreadsheet (ODS). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods). |
| static readonly SpreadsheetML | SpreadsheetML — Microsoft Office Excel 2002 and Excel 2003 XML Format. |
| static readonly Sxc | StarOffice or OpenOffice.org Calc XML Spreadsheet (SXC). |
| static readonly Tsv | Tab-Separated Values (TSV). Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/tsv/). |
| static readonly Xlam | Excel Add-in (XLAM). |
| static readonly Xls | Excel 97-2003 Binary File Format (XLS). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls). |
| static readonly Xlsb | Excel Binary Workbook (XLSB). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb). |
| static readonly Xlsm | Office Open XML Workbook Macro-Enabled (XLSM). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm). |
| static readonly Xlsx | Office Open XML Workbook Macro-Free (XLSX). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx). |
| static readonly Xlt | Excel 97-2003 Template (XLT). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt). |
| static readonly Xltm | Office Open XML Template Macro-Enabled (XLTM). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm). |
| static readonly Xltx | Office Open XML Template Macro-Free (XLTX). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltx). |

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/all.md

#### SpreadsheetFormats.All property

Gets an enumerable collection of all `SpreadsheetFormats`.

```csharp
public static IEnumerable<SpreadsheetFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `SpreadsheetFormats`.

### Csv
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/csv.md

#### SpreadsheetFormats.Csv field

Comma Separated Values (CSV). Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/csv/).

```csharp
public static readonly SpreadsheetFormats Csv;
```

### Dif
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/dif.md

#### SpreadsheetFormats.Dif field

Data Interchange Format (DIF).

```csharp
public static readonly SpreadsheetFormats Dif;
```

### Fods
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/fods.md

#### SpreadsheetFormats.Fods field

Flat OpenDocument Spreadsheet (FODS).

```csharp
public static readonly SpreadsheetFormats Fods;
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/fromextension.md

#### SpreadsheetFormats.FromExtension method

Retrieves an instance of the specified type `SpreadsheetFormats` that has the specified file extension.

```csharp
public static SpreadsheetFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `SpreadsheetFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Ods
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/ods.md

#### SpreadsheetFormats.Ods field

OpenDocument Spreadsheet (ODS). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods).

```csharp
public static readonly SpreadsheetFormats Ods;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/op_explicit.md

#### SpreadsheetFormats Explicit operator

Converts a string representing a file extension to a `SpreadsheetFormats` object.

```csharp
public static explicit operator SpreadsheetFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `SpreadsheetFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| SpreadsheetFormats | Thrown when the specified file extension is null. |

### SpreadsheetML
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/spreadsheetml.md

#### SpreadsheetFormats.SpreadsheetML field

SpreadsheetML — Microsoft Office Excel 2002 and Excel 2003 XML Format.

```csharp
public static readonly SpreadsheetFormats SpreadsheetML;
```

### Sxc
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/sxc.md

#### SpreadsheetFormats.Sxc field

StarOffice or OpenOffice.org Calc XML Spreadsheet (SXC).

```csharp
public static readonly SpreadsheetFormats Sxc;
```

### Tsv
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/tsv.md

#### SpreadsheetFormats.Tsv field

Tab-Separated Values (TSV). Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/tsv/).

```csharp
public static readonly SpreadsheetFormats Tsv;
```

### Xlam
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xlam.md

#### SpreadsheetFormats.Xlam field

Excel Add-in (XLAM).

```csharp
public static readonly SpreadsheetFormats Xlam;
```

### Xls
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xls.md

#### SpreadsheetFormats.Xls field

Excel 97-2003 Binary File Format (XLS). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls).

```csharp
public static readonly SpreadsheetFormats Xls;
```

### Xlsb
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xlsb.md

#### SpreadsheetFormats.Xlsb field

Excel Binary Workbook (XLSB). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb).

```csharp
public static readonly SpreadsheetFormats Xlsb;
```

### Xlsm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xlsm.md

#### SpreadsheetFormats.Xlsm field

Office Open XML Workbook Macro-Enabled (XLSM). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm).

```csharp
public static readonly SpreadsheetFormats Xlsm;
```

### Xlsx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xlsx.md

#### SpreadsheetFormats.Xlsx field

Office Open XML Workbook Macro-Free (XLSX). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx).

```csharp
public static readonly SpreadsheetFormats Xlsx;
```

### Xlt
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xlt.md

#### SpreadsheetFormats.Xlt field

Excel 97-2003 Template (XLT). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt).

```csharp
public static readonly SpreadsheetFormats Xlt;
```

### Xltm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xltm.md

#### SpreadsheetFormats.Xltm field

Office Open XML Template Macro-Enabled (XLTM). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm).

```csharp
public static readonly SpreadsheetFormats Xltm;
```

### Xltx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/spreadsheetformats/xltx.md

#### SpreadsheetFormats.Xltx field

Office Open XML Template Macro-Free (XLTX). Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltx).

```csharp
public static readonly SpreadsheetFormats Xltx;
```

### TextualFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats.md

#### TextualFormats class

Encapsulates all textual (text-based) formats, including markup (XML, HTML) and others. Includes the following formats: `Html`, `Txt`, `Xml`, `Md`, `Json`, `Mhtml`, `Chm`.

```csharp
public class TextualFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `TextualFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `TextualFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `TextualFormats` object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly 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](https://docs.fileformat.com/web/chm/). |
| static readonly Html | HyperText Markup Language document (HTML) 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 Md | Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Learn more about this file format [here](https://docs.fileformat.com/word-processing/md/). |
| static readonly 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](https://docs.fileformat.com/web/mhtml/). |
| static readonly 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](https://wiki.fileformat.com/word-processing/txt). |
| static readonly 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](https://wiki.fileformat.com/web/xml). |

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/all.md

#### TextualFormats.All property

Gets an enumerable collection of all `TextualFormats`.

```csharp
public static IEnumerable<TextualFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `TextualFormats`.

### Chm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/chm.md

#### TextualFormats.Chm field

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](https://docs.fileformat.com/web/chm/).

```csharp
public static readonly TextualFormats Chm;
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/fromextension.md

#### TextualFormats.FromExtension method

Retrieves an instance of the specified type `TextualFormats` that has the specified file extension.

```csharp
public static TextualFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `TextualFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Html
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/html.md

#### TextualFormats.Html field

HyperText Markup Language document (HTML) 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 TextualFormats Html;
```

### Json
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/json.md

#### TextualFormats.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 TextualFormats Json;
```

### Md
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/md.md

#### TextualFormats.Md field

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Learn more about this file format [here](https://docs.fileformat.com/word-processing/md/).

```csharp
public static readonly TextualFormats Md;
```

### Mhtml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/mhtml.md

#### TextualFormats.Mhtml field

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](https://docs.fileformat.com/web/mhtml/).

```csharp
public static readonly TextualFormats Mhtml;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/op_explicit.md

#### TextualFormats Explicit operator

Converts a string representing a file extension to a `TextualFormats` object.

```csharp
public static explicit operator TextualFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `TextualFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| TextualFormats | Thrown when the specified file extension is null. |

### Txt
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/txt.md

#### TextualFormats.Txt field

Plain Text Document (TXT) 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 TextualFormats Txt;
```

### Xml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/textualformats/xml.md

#### TextualFormats.Xml field

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](https://wiki.fileformat.com/web/xml).

```csharp
public static readonly TextualFormats Xml;
```

### WordProcessingFormats
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats.md

#### WordProcessingFormats class

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](https://wiki.fileformat.com/word-processing).

```csharp
public class WordProcessingFormats : DocumentFormatBase
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file extension of the document format. |
| FormatFamily { get; } | Gets the format family to which the document format belongs. |
| Id { get; } | Gets the unique identifier for the format family. |
| Mime { get; } | Gets the MIME type of the document format. |
| Name { get; } | Gets the name of the format family. |
| static All { get; } | Gets an enumerable collection of all `WordProcessingFormats`. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Retrieves an instance of the specified type `WordProcessingFormats` that has the specified file extension. |
| Equals(FormatFamilyBase) | Determines whether this instance is equal to the specified `FormatFamilyBase` instance. |
| Equals(IDocumentFormat) | Determines whether this instance is equal to the specified `IDocumentFormat` instance. |
| override Equals(object) | Determines whether this instance is equal to the specified `DocumentFormatBase` instance. |
| override GetHashCode() | Returns a hash code for the current object. |
| override ToString() | Returns a string that represents the current object. |
| explicit operator | Converts a string representing a file extension to a `WordProcessingFormats` object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly 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](https://wiki.fileformat.com/word-processing/doc). |
| static readonly 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](https://wiki.fileformat.com/word-processing/docm). |
| static readonly 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](https://wiki.fileformat.com/word-processing/docx). |
| static readonly 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](https://wiki.fileformat.com/word-processing/dot). |
| static readonly 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](https://wiki.fileformat.com/word-processing/dotm). |
| static readonly 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](https://wiki.fileformat.com/word-processing/dotx). |
| static readonly FlatOpc | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package. |
| static readonly 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](https://wiki.fileformat.com/word-processing/odt). |
| static readonly 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](https://wiki.fileformat.com/word-processing/ott). |
| static readonly 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](https://wiki.fileformat.com/word-processing/rtf). |
| static readonly WordML | Microsoft Office Word 2003 XML Format — WordProcessingML or WordML (.XML). |

### All
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/all.md

#### WordProcessingFormats.All property

Gets an enumerable collection of all `WordProcessingFormats`.

```csharp
public static IEnumerable<WordProcessingFormats> All { get; }
```

##### Property Value

An IEnumerable containing all instances of `WordProcessingFormats`.

### Doc
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/doc.md

#### WordProcessingFormats.Doc field

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](https://wiki.fileformat.com/word-processing/doc).

```csharp
public static readonly WordProcessingFormats Doc;
```

### Docm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/docm.md

#### WordProcessingFormats.Docm field

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](https://wiki.fileformat.com/word-processing/docm).

```csharp
public static readonly WordProcessingFormats Docm;
```

### Docx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/docx.md

#### WordProcessingFormats.Docx field

Office Open XML WordProcessingML Macro-Free Document (DOCX) is a well-known format for Microsoft Word documents. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx).

```csharp
public static readonly WordProcessingFormats Docx;
```

### Dot
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/dot.md

#### WordProcessingFormats.Dot field

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](https://wiki.fileformat.com/word-processing/dot).

```csharp
public static readonly WordProcessingFormats Dot;
```

### Dotm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/dotm.md

#### WordProcessingFormats.Dotm field

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](https://wiki.fileformat.com/word-processing/dotm).

```csharp
public static readonly WordProcessingFormats Dotm;
```

### Dotx
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/dotx.md

#### WordProcessingFormats.Dotx field

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](https://wiki.fileformat.com/word-processing/dotx).

```csharp
public static readonly WordProcessingFormats Dotx;
```

### FlatOpc
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/flatopc.md

#### WordProcessingFormats.FlatOpc field

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.

```csharp
public static readonly WordProcessingFormats FlatOpc;
```

### FromExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/fromextension.md

#### WordProcessingFormats.FromExtension method

Retrieves an instance of the specified type `WordProcessingFormats` that has the specified file extension.

```csharp
public static WordProcessingFormats FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension of the document format. |

##### Return Value

An instance of the specified type `WordProcessingFormats` with the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown when no matching document format is found. |

### Odt
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/odt.md

#### WordProcessingFormats.Odt field

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](https://wiki.fileformat.com/word-processing/odt).

```csharp
public static readonly WordProcessingFormats Odt;
```

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/op_explicit.md

#### WordProcessingFormats Explicit operator

Converts a string representing a file extension to a `WordProcessingFormats` object.

```csharp
public static explicit operator WordProcessingFormats(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension to convert. If the extension contains multiple periods, the part after the last period is used. |

##### Return Value

A `WordProcessingFormats` object corresponding to the specified file extension.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when the specified file extension is null. |

### Ott
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/ott.md

#### WordProcessingFormats.Ott field

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](https://wiki.fileformat.com/word-processing/ott).

```csharp
public static readonly WordProcessingFormats Ott;
```

### Rtf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/rtf.md

#### WordProcessingFormats.Rtf field

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 WordProcessingFormats Rtf;
```

### WordML
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.formats/wordprocessingformats/wordml.md

#### WordProcessingFormats.WordML field

Microsoft Office Word 2003 XML Format — WordProcessingML or WordML (.XML).

```csharp
public static readonly WordProcessingFormats WordML;
```

##### Remarks

https://en.wikipedia.org/wiki/Microsoft_Office_XML_formats

### GroupDocs.Editor.HtmlCss.Css.DataTypes
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes.md

The GroupDocs.Editor.HtmlCss.Css.DataTypes namespace provides classes that represent CSS data types.

#### Classes

| Class | Description |
| --- | --- |
| ArgbColor.KnownColors | Contains all "known colors", that have fixed unique name and value in CSS standart |
#### Structures

| Structure | Description |
| --- | --- |
| ArgbColor | Represents one color value in 32-bit ARGB format (8 bits per channel including transparency) with converters and serializers |
| Length | 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. |
| 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". Immutable struct. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICssDataType | Common interface for all CSS data types, which are used in the CSS properties |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| Length.Unit | All supported length units |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### ArgbColor.KnownColors.CssLevel1
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1.md

#### ArgbColor.KnownColors.CssLevel1 class

Named colors, specified in the CSS level 1. All are fully opaque.

```csharp
public static class CssLevel1
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aqua | Aqua color |
| static readonly Black | Black color |
| static readonly Blue | Blue color |
| static readonly Fuchsia | Fuchsia color, also known as Magenta |
| static readonly Gray | Gray color |
| static readonly Green | Green color |
| static readonly Lime | Lime color, also known as Pure Green |
| static readonly Maroon | Maroon color |
| static readonly Navy | Navy color |
| static readonly Olive | Olive color |
| static readonly Purple | Purple color |
| static readonly Red | Red color |
| static readonly Silver | Silver color |
| static readonly Teal | Teal color |
| static readonly White | White color |
| static readonly Yellow | Yellow color |

##### Remarks

https://www.w3.org/TR/CSS1/#color-units

### Aqua
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/aqua.md

#### ArgbColor.KnownColors.CssLevel1.Aqua field

Aqua color

```csharp
public static readonly ArgbColor Aqua;
```

### Black
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/black.md

#### ArgbColor.KnownColors.CssLevel1.Black field

Black color

```csharp
public static readonly ArgbColor Black;
```

### Blue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/blue.md

#### ArgbColor.KnownColors.CssLevel1.Blue field

Blue color

```csharp
public static readonly ArgbColor Blue;
```

### Fuchsia
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/fuchsia.md

#### ArgbColor.KnownColors.CssLevel1.Fuchsia field

Fuchsia color, also known as Magenta

```csharp
public static readonly ArgbColor Fuchsia;
```

### Gray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/gray.md

#### ArgbColor.KnownColors.CssLevel1.Gray field

Gray color

```csharp
public static readonly ArgbColor Gray;
```

### Green
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/green.md

#### ArgbColor.KnownColors.CssLevel1.Green field

Green color

```csharp
public static readonly ArgbColor Green;
```

### Lime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/lime.md

#### ArgbColor.KnownColors.CssLevel1.Lime field

Lime color, also known as Pure Green

```csharp
public static readonly ArgbColor Lime;
```

### Maroon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/maroon.md

#### ArgbColor.KnownColors.CssLevel1.Maroon field

Maroon color

```csharp
public static readonly ArgbColor Maroon;
```

### Navy
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/navy.md

#### ArgbColor.KnownColors.CssLevel1.Navy field

Navy color

```csharp
public static readonly ArgbColor Navy;
```

### Olive
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/olive.md

#### ArgbColor.KnownColors.CssLevel1.Olive field

Olive color

```csharp
public static readonly ArgbColor Olive;
```

### Purple
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/purple.md

#### ArgbColor.KnownColors.CssLevel1.Purple field

Purple color

```csharp
public static readonly ArgbColor Purple;
```

### Red
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/red.md

#### ArgbColor.KnownColors.CssLevel1.Red field

Red color

```csharp
public static readonly ArgbColor Red;
```

### Silver
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/silver.md

#### ArgbColor.KnownColors.CssLevel1.Silver field

Silver color

```csharp
public static readonly ArgbColor Silver;
```

### Teal
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/teal.md

#### ArgbColor.KnownColors.CssLevel1.Teal field

Teal color

```csharp
public static readonly ArgbColor Teal;
```

### White
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/white.md

#### ArgbColor.KnownColors.CssLevel1.White field

White color

```csharp
public static readonly ArgbColor White;
```

### Yellow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel1/yellow.md

#### ArgbColor.KnownColors.CssLevel1.Yellow field

Yellow color

```csharp
public static readonly ArgbColor Yellow;
```

### ArgbColor.KnownColors.CssLevel2
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel2.md

#### ArgbColor.KnownColors.CssLevel2 class

Named colors, specified in the CSS level 2. All are fully opaque.

```csharp
public static class CssLevel2
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Orange | Orange color |

##### Remarks

https://www.w3.org/TR/CSS2/syndata.html#color-units

### Orange
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel2/orange.md

#### ArgbColor.KnownColors.CssLevel2.Orange field

Orange color

```csharp
public static readonly ArgbColor Orange;
```

### ArgbColor.KnownColors.CssLevel3
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3.md

#### ArgbColor.KnownColors.CssLevel3 class

Named colors, specified in the CSS Colors level 3. All are fully opaque.

```csharp
public static class CssLevel3
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aliceblue | Alice Blue color |
| static readonly Antiquewhite | Antique White color |
| static readonly Aquamarine | Aquamarine color |
| static readonly Azure | Azure color |
| static readonly Beige | Beige color |
| static readonly Bisque | Bisque color |
| static readonly Blanchedalmond | Blanched Almond color |
| static readonly Blueviolet | Blue Violet color |
| static readonly Brown | Brown color |
| static readonly Burlywood | Burly Wood color |
| static readonly Cadetblue | Cadet Blue color |
| static readonly Chartreuse | Chart Reuse color |
| static readonly Chocolate | Chocolate color |
| static readonly Coral | Coral color |
| static readonly Cornflowerblue | Corn flower blue color |
| static readonly Cornsilk | Corn silk color |
| static readonly Crimson | Crimson color |
| static readonly Cyan | Cyan color, also known as Aqua from CssLevel1 |
| static readonly Darkblue | Dark blue color |
| static readonly Darkcyan | Dark cyan color |
| static readonly Darkgoldenrod | Dark golden rod color |
| static readonly Darkgray | Dark gray color |
| static readonly Darkgreen | Dark green color |
| static readonly Darkgrey | Dark grey color - same as Dark gray |
| static readonly Darkkhaki | Dark khaki color |
| static readonly Darkmagenta | Dark magenta color |
| static readonly Darkolivegreen | Dark olive green color |
| static readonly Darkorange | Dark orange color |
| static readonly Darkorchid | Dark orchid color |
| static readonly Darkred | Dark red color |
| static readonly Darksalmon | Dark salmon color |
| static readonly Darkseagreen | Dark sea green color |
| static readonly Darkslateblue | Dark slate blue color |
| static readonly Darkslategray | Dark slate gray color |
| static readonly Darkslategrey | Dark slate grey color - same as Dark slate gray |
| static readonly Darkturquoise | Dark turquoise color |
| static readonly Darkviolet | Dark violet color |
| static readonly Deeppink | Deep pink color |
| static readonly Deepskyblue | Deep sky blue color |
| static readonly Dimgray | Dim gray color |
| static readonly Dimgrey | Dim grey color - same as Dim gray |
| static readonly Dodgerblue | Dodger blue color |
| static readonly Firebrick | Fire brick color |
| static readonly Floralwhite | Floral white color |
| static readonly Forestgreen | Forest green color |
| static readonly Gainsboro | Gains boro color |
| static readonly Ghostwhite | Ghost white color |
| static readonly Gold | Gold color |
| static readonly Goldenrod | Goldenrod color |
| static readonly Greenyellow | Green yellow color |
| static readonly Grey | Grey color - same as Gray from CSS Level 1 |
| static readonly Honeydew | Honey dew color |
| static readonly Hotpink | Hot pink color |
| static readonly Indianred | Indian red color |
| static readonly Indigo | Indigo color |
| static readonly Ivory | Ivory color |
| static readonly Khaki | Khaki color |
| static readonly Lavender | Lavender color |
| static readonly Lavenderblush | Lavender blush color |
| static readonly Lawngreen | Lawngreen color |
| static readonly Lemonchiffon | Lemonchiffon color |
| static readonly Lightblue | Lightblue color |
| static readonly Lightcoral | Lightcoral color |
| static readonly Lightcyan | Lightcyan color |
| static readonly Lightgoldenrodyellow | Lightgoldenrodyellow color |
| static readonly Lightgray | Lightgray color - same as Lightgrey |
| static readonly Lightgreen | Lightgreen color |
| static readonly Lightgrey | Lightgrey color - same as Lightgray |
| static readonly Lightpink | Lightpink color |
| static readonly Lightsalmon | Lightsalmon color |
| static readonly Lightseagreen | Lightseagreen color |
| static readonly Lightskyblue | Lightskyblue color |
| static readonly Lightslategray | Lightslategray color - same as Lightslategrey |
| static readonly Lightslategrey | Lightslategrey color - same as Lightslategray |
| static readonly Lightsteelblue | Lightsteelblue color |
| static readonly Lightyellow | Lightyellow color |
| static readonly Limegreen | Limegreen color |
| static readonly Linen | Linen color |
| static readonly Magenta | Magenta color, also known as Fuchsia from CssLevel1 |
| static readonly Mediumaquamarine | Mediumaquamarine color |
| static readonly Mediumblue | Mediumblue color |
| static readonly Mediumorchid | Mediumorchid color |
| static readonly Mediumpurple | Mediumpurple color |
| static readonly Mediumseagreen | Mediumseagreen color |
| static readonly Mediumslateblue | Mediumslateblue color |
| static readonly Mediumspringgreen | Mediumspringgreen color |
| static readonly Mediumturquoise | Mediumturquoise color |
| static readonly Mediumvioletred | Mediumvioletred color |
| static readonly Midnightblue | Midnightblue color |
| static readonly Mintcream | Mintcream color |
| static readonly Mistyrose | Mistyrose color |
| static readonly Moccasin | Moccasin color |
| static readonly Navajowhite | Navajowhite color |
| static readonly Oldlace | Oldlace color |
| static readonly Olivedrab | Olivedrab color |
| static readonly Orangered | Orangered color |
| static readonly Orchid | Orchid color |
| static readonly Palegoldenrod | Palegoldenrod color |
| static readonly Palegreen | Palegreen color |
| static readonly Paleturquoise | Paleturquoise color |
| static readonly Palevioletred | Palevioletred color |
| static readonly Papayawhip | Papayawhip color |
| static readonly Peachpuff | Peachpuff color |
| static readonly Peru | Peru color |
| static readonly Pink | Pink color |
| static readonly Plum | Plum color |
| static readonly Powderblue | Powderblue color |
| static readonly Rosybrown | Rosybrown color |
| static readonly Royalblue | Royalblue color |
| static readonly Saddlebrown | Saddlebrown color |
| static readonly Salmon | Salmon color |
| static readonly Sandybrown | Sandybrown color |
| static readonly Seagreen | Seagreen color |
| static readonly Seashell | Seashell color |
| static readonly Sienna | Sienna color |
| static readonly Skyblue | Skyblue color |
| static readonly Slateblue | Slateblue color |
| static readonly Slategray | Slategray color - same as Slategrey |
| static readonly Slategrey | Slategrey color - same as Slategray |
| static readonly Snow | Snow color |
| static readonly Springgreen | Springgreen color |
| static readonly Steelblue | Steelblue color |
| static readonly Tan | Tan color |
| static readonly Thistle | Thistle color |
| static readonly Tomato | Tomato color |
| static readonly Turquoise | Turquoise color |
| static readonly Violet | Violet color |
| static readonly Wheat | Wheat color |
| static readonly Whitesmoke | Whitesmoke color |
| static readonly Yellowgreen | Yellowgreen color |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color#css_level_3_values https://drafts.csswg.org/css-color-3/#svg-color

### Aliceblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/aliceblue.md

#### ArgbColor.KnownColors.CssLevel3.Aliceblue field

Alice Blue color

```csharp
public static readonly ArgbColor Aliceblue;
```

### Antiquewhite
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/antiquewhite.md

#### ArgbColor.KnownColors.CssLevel3.Antiquewhite field

Antique White color

```csharp
public static readonly ArgbColor Antiquewhite;
```

### Aquamarine
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/aquamarine.md

#### ArgbColor.KnownColors.CssLevel3.Aquamarine field

Aquamarine color

```csharp
public static readonly ArgbColor Aquamarine;
```

### Azure
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/azure.md

#### ArgbColor.KnownColors.CssLevel3.Azure field

Azure color

```csharp
public static readonly ArgbColor Azure;
```

### Beige
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/beige.md

#### ArgbColor.KnownColors.CssLevel3.Beige field

Beige color

```csharp
public static readonly ArgbColor Beige;
```

### Bisque
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/bisque.md

#### ArgbColor.KnownColors.CssLevel3.Bisque field

Bisque color

```csharp
public static readonly ArgbColor Bisque;
```

### Blanchedalmond
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/blanchedalmond.md

#### ArgbColor.KnownColors.CssLevel3.Blanchedalmond field

Blanched Almond color

```csharp
public static readonly ArgbColor Blanchedalmond;
```

### Blueviolet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/blueviolet.md

#### ArgbColor.KnownColors.CssLevel3.Blueviolet field

Blue Violet color

```csharp
public static readonly ArgbColor Blueviolet;
```

### Brown
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/brown.md

#### ArgbColor.KnownColors.CssLevel3.Brown field

Brown color

```csharp
public static readonly ArgbColor Brown;
```

### Burlywood
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/burlywood.md

#### ArgbColor.KnownColors.CssLevel3.Burlywood field

Burly Wood color

```csharp
public static readonly ArgbColor Burlywood;
```

### Cadetblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/cadetblue.md

#### ArgbColor.KnownColors.CssLevel3.Cadetblue field

Cadet Blue color

```csharp
public static readonly ArgbColor Cadetblue;
```

### Chartreuse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/chartreuse.md

#### ArgbColor.KnownColors.CssLevel3.Chartreuse field

Chart Reuse color

```csharp
public static readonly ArgbColor Chartreuse;
```

### Chocolate
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/chocolate.md

#### ArgbColor.KnownColors.CssLevel3.Chocolate field

Chocolate color

```csharp
public static readonly ArgbColor Chocolate;
```

### Coral
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/coral.md

#### ArgbColor.KnownColors.CssLevel3.Coral field

Coral color

```csharp
public static readonly ArgbColor Coral;
```

### Cornflowerblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/cornflowerblue.md

#### ArgbColor.KnownColors.CssLevel3.Cornflowerblue field

Corn flower blue color

```csharp
public static readonly ArgbColor Cornflowerblue;
```

### Cornsilk
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/cornsilk.md

#### ArgbColor.KnownColors.CssLevel3.Cornsilk field

Corn silk color

```csharp
public static readonly ArgbColor Cornsilk;
```

### Crimson
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/crimson.md

#### ArgbColor.KnownColors.CssLevel3.Crimson field

Crimson color

```csharp
public static readonly ArgbColor Crimson;
```

### Cyan
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/cyan.md

#### ArgbColor.KnownColors.CssLevel3.Cyan field

Cyan color, also known as Aqua from CssLevel1

```csharp
public static readonly ArgbColor Cyan;
```

### Darkblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkblue.md

#### ArgbColor.KnownColors.CssLevel3.Darkblue field

Dark blue color

```csharp
public static readonly ArgbColor Darkblue;
```

### Darkcyan
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkcyan.md

#### ArgbColor.KnownColors.CssLevel3.Darkcyan field

Dark cyan color

```csharp
public static readonly ArgbColor Darkcyan;
```

### Darkgoldenrod
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkgoldenrod.md

#### ArgbColor.KnownColors.CssLevel3.Darkgoldenrod field

Dark golden rod color

```csharp
public static readonly ArgbColor Darkgoldenrod;
```

### Darkgray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkgray.md

#### ArgbColor.KnownColors.CssLevel3.Darkgray field

Dark gray color

```csharp
public static readonly ArgbColor Darkgray;
```

### Darkgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkgreen.md

#### ArgbColor.KnownColors.CssLevel3.Darkgreen field

Dark green color

```csharp
public static readonly ArgbColor Darkgreen;
```

### Darkgrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkgrey.md

#### ArgbColor.KnownColors.CssLevel3.Darkgrey field

Dark grey color - same as Dark gray

```csharp
public static readonly ArgbColor Darkgrey;
```

### Darkkhaki
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkkhaki.md

#### ArgbColor.KnownColors.CssLevel3.Darkkhaki field

Dark khaki color

```csharp
public static readonly ArgbColor Darkkhaki;
```

### Darkmagenta
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkmagenta.md

#### ArgbColor.KnownColors.CssLevel3.Darkmagenta field

Dark magenta color

```csharp
public static readonly ArgbColor Darkmagenta;
```

### Darkolivegreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkolivegreen.md

#### ArgbColor.KnownColors.CssLevel3.Darkolivegreen field

Dark olive green color

```csharp
public static readonly ArgbColor Darkolivegreen;
```

### Darkorange
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkorange.md

#### ArgbColor.KnownColors.CssLevel3.Darkorange field

Dark orange color

```csharp
public static readonly ArgbColor Darkorange;
```

### Darkorchid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkorchid.md

#### ArgbColor.KnownColors.CssLevel3.Darkorchid field

Dark orchid color

```csharp
public static readonly ArgbColor Darkorchid;
```

### Darkred
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkred.md

#### ArgbColor.KnownColors.CssLevel3.Darkred field

Dark red color

```csharp
public static readonly ArgbColor Darkred;
```

### Darksalmon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darksalmon.md

#### ArgbColor.KnownColors.CssLevel3.Darksalmon field

Dark salmon color

```csharp
public static readonly ArgbColor Darksalmon;
```

### Darkseagreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkseagreen.md

#### ArgbColor.KnownColors.CssLevel3.Darkseagreen field

Dark sea green color

```csharp
public static readonly ArgbColor Darkseagreen;
```

### Darkslateblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkslateblue.md

#### ArgbColor.KnownColors.CssLevel3.Darkslateblue field

Dark slate blue color

```csharp
public static readonly ArgbColor Darkslateblue;
```

### Darkslategray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkslategray.md

#### ArgbColor.KnownColors.CssLevel3.Darkslategray field

Dark slate gray color

```csharp
public static readonly ArgbColor Darkslategray;
```

### Darkslategrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkslategrey.md

#### ArgbColor.KnownColors.CssLevel3.Darkslategrey field

Dark slate grey color - same as Dark slate gray

```csharp
public static readonly ArgbColor Darkslategrey;
```

### Darkturquoise
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkturquoise.md

#### ArgbColor.KnownColors.CssLevel3.Darkturquoise field

Dark turquoise color

```csharp
public static readonly ArgbColor Darkturquoise;
```

### Darkviolet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/darkviolet.md

#### ArgbColor.KnownColors.CssLevel3.Darkviolet field

Dark violet color

```csharp
public static readonly ArgbColor Darkviolet;
```

### Deeppink
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/deeppink.md

#### ArgbColor.KnownColors.CssLevel3.Deeppink field

Deep pink color

```csharp
public static readonly ArgbColor Deeppink;
```

### Deepskyblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/deepskyblue.md

#### ArgbColor.KnownColors.CssLevel3.Deepskyblue field

Deep sky blue color

```csharp
public static readonly ArgbColor Deepskyblue;
```

### Dimgray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/dimgray.md

#### ArgbColor.KnownColors.CssLevel3.Dimgray field

Dim gray color

```csharp
public static readonly ArgbColor Dimgray;
```

### Dimgrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/dimgrey.md

#### ArgbColor.KnownColors.CssLevel3.Dimgrey field

Dim grey color - same as Dim gray

```csharp
public static readonly ArgbColor Dimgrey;
```

### Dodgerblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/dodgerblue.md

#### ArgbColor.KnownColors.CssLevel3.Dodgerblue field

Dodger blue color

```csharp
public static readonly ArgbColor Dodgerblue;
```

### Firebrick
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/firebrick.md

#### ArgbColor.KnownColors.CssLevel3.Firebrick field

Fire brick color

```csharp
public static readonly ArgbColor Firebrick;
```

### Floralwhite
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/floralwhite.md

#### ArgbColor.KnownColors.CssLevel3.Floralwhite field

Floral white color

```csharp
public static readonly ArgbColor Floralwhite;
```

### Forestgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/forestgreen.md

#### ArgbColor.KnownColors.CssLevel3.Forestgreen field

Forest green color

```csharp
public static readonly ArgbColor Forestgreen;
```

### Gainsboro
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/gainsboro.md

#### ArgbColor.KnownColors.CssLevel3.Gainsboro field

Gains boro color

```csharp
public static readonly ArgbColor Gainsboro;
```

### Ghostwhite
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/ghostwhite.md

#### ArgbColor.KnownColors.CssLevel3.Ghostwhite field

Ghost white color

```csharp
public static readonly ArgbColor Ghostwhite;
```

### Gold
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/gold.md

#### ArgbColor.KnownColors.CssLevel3.Gold field

Gold color

```csharp
public static readonly ArgbColor Gold;
```

### Goldenrod
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/goldenrod.md

#### ArgbColor.KnownColors.CssLevel3.Goldenrod field

Goldenrod color

```csharp
public static readonly ArgbColor Goldenrod;
```

### Greenyellow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/greenyellow.md

#### ArgbColor.KnownColors.CssLevel3.Greenyellow field

Green yellow color

```csharp
public static readonly ArgbColor Greenyellow;
```

### Grey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/grey.md

#### ArgbColor.KnownColors.CssLevel3.Grey field

Grey color - same as Gray from CSS Level 1

```csharp
public static readonly ArgbColor Grey;
```

### Honeydew
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/honeydew.md

#### ArgbColor.KnownColors.CssLevel3.Honeydew field

Honey dew color

```csharp
public static readonly ArgbColor Honeydew;
```

### Hotpink
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/hotpink.md

#### ArgbColor.KnownColors.CssLevel3.Hotpink field

Hot pink color

```csharp
public static readonly ArgbColor Hotpink;
```

### Indianred
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/indianred.md

#### ArgbColor.KnownColors.CssLevel3.Indianred field

Indian red color

```csharp
public static readonly ArgbColor Indianred;
```

### Indigo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/indigo.md

#### ArgbColor.KnownColors.CssLevel3.Indigo field

Indigo color

```csharp
public static readonly ArgbColor Indigo;
```

### Ivory
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/ivory.md

#### ArgbColor.KnownColors.CssLevel3.Ivory field

Ivory color

```csharp
public static readonly ArgbColor Ivory;
```

### Khaki
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/khaki.md

#### ArgbColor.KnownColors.CssLevel3.Khaki field

Khaki color

```csharp
public static readonly ArgbColor Khaki;
```

### Lavender
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lavender.md

#### ArgbColor.KnownColors.CssLevel3.Lavender field

Lavender color

```csharp
public static readonly ArgbColor Lavender;
```

### Lavenderblush
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lavenderblush.md

#### ArgbColor.KnownColors.CssLevel3.Lavenderblush field

Lavender blush color

```csharp
public static readonly ArgbColor Lavenderblush;
```

### Lawngreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lawngreen.md

#### ArgbColor.KnownColors.CssLevel3.Lawngreen field

Lawngreen color

```csharp
public static readonly ArgbColor Lawngreen;
```

### Lemonchiffon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lemonchiffon.md

#### ArgbColor.KnownColors.CssLevel3.Lemonchiffon field

Lemonchiffon color

```csharp
public static readonly ArgbColor Lemonchiffon;
```

### Lightblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightblue.md

#### ArgbColor.KnownColors.CssLevel3.Lightblue field

Lightblue color

```csharp
public static readonly ArgbColor Lightblue;
```

### Lightcoral
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightcoral.md

#### ArgbColor.KnownColors.CssLevel3.Lightcoral field

Lightcoral color

```csharp
public static readonly ArgbColor Lightcoral;
```

### Lightcyan
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightcyan.md

#### ArgbColor.KnownColors.CssLevel3.Lightcyan field

Lightcyan color

```csharp
public static readonly ArgbColor Lightcyan;
```

### Lightgoldenrodyellow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightgoldenrodyellow.md

#### ArgbColor.KnownColors.CssLevel3.Lightgoldenrodyellow field

Lightgoldenrodyellow color

```csharp
public static readonly ArgbColor Lightgoldenrodyellow;
```

### Lightgray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightgray.md

#### ArgbColor.KnownColors.CssLevel3.Lightgray field

Lightgray color - same as Lightgrey

```csharp
public static readonly ArgbColor Lightgray;
```

### Lightgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightgreen.md

#### ArgbColor.KnownColors.CssLevel3.Lightgreen field

Lightgreen color

```csharp
public static readonly ArgbColor Lightgreen;
```

### Lightgrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightgrey.md

#### ArgbColor.KnownColors.CssLevel3.Lightgrey field

Lightgrey color - same as Lightgray

```csharp
public static readonly ArgbColor Lightgrey;
```

### Lightpink
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightpink.md

#### ArgbColor.KnownColors.CssLevel3.Lightpink field

Lightpink color

```csharp
public static readonly ArgbColor Lightpink;
```

### Lightsalmon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightsalmon.md

#### ArgbColor.KnownColors.CssLevel3.Lightsalmon field

Lightsalmon color

```csharp
public static readonly ArgbColor Lightsalmon;
```

### Lightseagreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightseagreen.md

#### ArgbColor.KnownColors.CssLevel3.Lightseagreen field

Lightseagreen color

```csharp
public static readonly ArgbColor Lightseagreen;
```

### Lightskyblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightskyblue.md

#### ArgbColor.KnownColors.CssLevel3.Lightskyblue field

Lightskyblue color

```csharp
public static readonly ArgbColor Lightskyblue;
```

### Lightslategray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightslategray.md

#### ArgbColor.KnownColors.CssLevel3.Lightslategray field

Lightslategray color - same as Lightslategrey

```csharp
public static readonly ArgbColor Lightslategray;
```

### Lightslategrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightslategrey.md

#### ArgbColor.KnownColors.CssLevel3.Lightslategrey field

Lightslategrey color - same as Lightslategray

```csharp
public static readonly ArgbColor Lightslategrey;
```

### Lightsteelblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightsteelblue.md

#### ArgbColor.KnownColors.CssLevel3.Lightsteelblue field

Lightsteelblue color

```csharp
public static readonly ArgbColor Lightsteelblue;
```

### Lightyellow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/lightyellow.md

#### ArgbColor.KnownColors.CssLevel3.Lightyellow field

Lightyellow color

```csharp
public static readonly ArgbColor Lightyellow;
```

### Limegreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/limegreen.md

#### ArgbColor.KnownColors.CssLevel3.Limegreen field

Limegreen color

```csharp
public static readonly ArgbColor Limegreen;
```

### Linen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/linen.md

#### ArgbColor.KnownColors.CssLevel3.Linen field

Linen color

```csharp
public static readonly ArgbColor Linen;
```

### Magenta
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/magenta.md

#### ArgbColor.KnownColors.CssLevel3.Magenta field

Magenta color, also known as Fuchsia from CssLevel1

```csharp
public static readonly ArgbColor Magenta;
```

### Mediumaquamarine
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumaquamarine.md

#### ArgbColor.KnownColors.CssLevel3.Mediumaquamarine field

Mediumaquamarine color

```csharp
public static readonly ArgbColor Mediumaquamarine;
```

### Mediumblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumblue.md

#### ArgbColor.KnownColors.CssLevel3.Mediumblue field

Mediumblue color

```csharp
public static readonly ArgbColor Mediumblue;
```

### Mediumorchid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumorchid.md

#### ArgbColor.KnownColors.CssLevel3.Mediumorchid field

Mediumorchid color

```csharp
public static readonly ArgbColor Mediumorchid;
```

### Mediumpurple
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumpurple.md

#### ArgbColor.KnownColors.CssLevel3.Mediumpurple field

Mediumpurple color

```csharp
public static readonly ArgbColor Mediumpurple;
```

### Mediumseagreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumseagreen.md

#### ArgbColor.KnownColors.CssLevel3.Mediumseagreen field

Mediumseagreen color

```csharp
public static readonly ArgbColor Mediumseagreen;
```

### Mediumslateblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumslateblue.md

#### ArgbColor.KnownColors.CssLevel3.Mediumslateblue field

Mediumslateblue color

```csharp
public static readonly ArgbColor Mediumslateblue;
```

### Mediumspringgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumspringgreen.md

#### ArgbColor.KnownColors.CssLevel3.Mediumspringgreen field

Mediumspringgreen color

```csharp
public static readonly ArgbColor Mediumspringgreen;
```

### Mediumturquoise
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumturquoise.md

#### ArgbColor.KnownColors.CssLevel3.Mediumturquoise field

Mediumturquoise color

```csharp
public static readonly ArgbColor Mediumturquoise;
```

### Mediumvioletred
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mediumvioletred.md

#### ArgbColor.KnownColors.CssLevel3.Mediumvioletred field

Mediumvioletred color

```csharp
public static readonly ArgbColor Mediumvioletred;
```

### Midnightblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/midnightblue.md

#### ArgbColor.KnownColors.CssLevel3.Midnightblue field

Midnightblue color

```csharp
public static readonly ArgbColor Midnightblue;
```

### Mintcream
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mintcream.md

#### ArgbColor.KnownColors.CssLevel3.Mintcream field

Mintcream color

```csharp
public static readonly ArgbColor Mintcream;
```

### Mistyrose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/mistyrose.md

#### ArgbColor.KnownColors.CssLevel3.Mistyrose field

Mistyrose color

```csharp
public static readonly ArgbColor Mistyrose;
```

### Moccasin
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/moccasin.md

#### ArgbColor.KnownColors.CssLevel3.Moccasin field

Moccasin color

```csharp
public static readonly ArgbColor Moccasin;
```

### Navajowhite
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/navajowhite.md

#### ArgbColor.KnownColors.CssLevel3.Navajowhite field

Navajowhite color

```csharp
public static readonly ArgbColor Navajowhite;
```

### Oldlace
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/oldlace.md

#### ArgbColor.KnownColors.CssLevel3.Oldlace field

Oldlace color

```csharp
public static readonly ArgbColor Oldlace;
```

### Olivedrab
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/olivedrab.md

#### ArgbColor.KnownColors.CssLevel3.Olivedrab field

Olivedrab color

```csharp
public static readonly ArgbColor Olivedrab;
```

### Orangered
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/orangered.md

#### ArgbColor.KnownColors.CssLevel3.Orangered field

Orangered color

```csharp
public static readonly ArgbColor Orangered;
```

### Orchid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/orchid.md

#### ArgbColor.KnownColors.CssLevel3.Orchid field

Orchid color

```csharp
public static readonly ArgbColor Orchid;
```

### Palegoldenrod
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/palegoldenrod.md

#### ArgbColor.KnownColors.CssLevel3.Palegoldenrod field

Palegoldenrod color

```csharp
public static readonly ArgbColor Palegoldenrod;
```

### Palegreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/palegreen.md

#### ArgbColor.KnownColors.CssLevel3.Palegreen field

Palegreen color

```csharp
public static readonly ArgbColor Palegreen;
```

### Paleturquoise
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/paleturquoise.md

#### ArgbColor.KnownColors.CssLevel3.Paleturquoise field

Paleturquoise color

```csharp
public static readonly ArgbColor Paleturquoise;
```

### Palevioletred
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/palevioletred.md

#### ArgbColor.KnownColors.CssLevel3.Palevioletred field

Palevioletred color

```csharp
public static readonly ArgbColor Palevioletred;
```

### Papayawhip
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/papayawhip.md

#### ArgbColor.KnownColors.CssLevel3.Papayawhip field

Papayawhip color

```csharp
public static readonly ArgbColor Papayawhip;
```

### Peachpuff
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/peachpuff.md

#### ArgbColor.KnownColors.CssLevel3.Peachpuff field

Peachpuff color

```csharp
public static readonly ArgbColor Peachpuff;
```

### Peru
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/peru.md

#### ArgbColor.KnownColors.CssLevel3.Peru field

Peru color

```csharp
public static readonly ArgbColor Peru;
```

### Pink
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/pink.md

#### ArgbColor.KnownColors.CssLevel3.Pink field

Pink color

```csharp
public static readonly ArgbColor Pink;
```

### Plum
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/plum.md

#### ArgbColor.KnownColors.CssLevel3.Plum field

Plum color

```csharp
public static readonly ArgbColor Plum;
```

### Powderblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/powderblue.md

#### ArgbColor.KnownColors.CssLevel3.Powderblue field

Powderblue color

```csharp
public static readonly ArgbColor Powderblue;
```

### Rosybrown
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/rosybrown.md

#### ArgbColor.KnownColors.CssLevel3.Rosybrown field

Rosybrown color

```csharp
public static readonly ArgbColor Rosybrown;
```

### Royalblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/royalblue.md

#### ArgbColor.KnownColors.CssLevel3.Royalblue field

Royalblue color

```csharp
public static readonly ArgbColor Royalblue;
```

### Saddlebrown
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/saddlebrown.md

#### ArgbColor.KnownColors.CssLevel3.Saddlebrown field

Saddlebrown color

```csharp
public static readonly ArgbColor Saddlebrown;
```

### Salmon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/salmon.md

#### ArgbColor.KnownColors.CssLevel3.Salmon field

Salmon color

```csharp
public static readonly ArgbColor Salmon;
```

### Sandybrown
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/sandybrown.md

#### ArgbColor.KnownColors.CssLevel3.Sandybrown field

Sandybrown color

```csharp
public static readonly ArgbColor Sandybrown;
```

### Seagreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/seagreen.md

#### ArgbColor.KnownColors.CssLevel3.Seagreen field

Seagreen color

```csharp
public static readonly ArgbColor Seagreen;
```

### Seashell
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/seashell.md

#### ArgbColor.KnownColors.CssLevel3.Seashell field

Seashell color

```csharp
public static readonly ArgbColor Seashell;
```

### Sienna
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/sienna.md

#### ArgbColor.KnownColors.CssLevel3.Sienna field

Sienna color

```csharp
public static readonly ArgbColor Sienna;
```

### Skyblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/skyblue.md

#### ArgbColor.KnownColors.CssLevel3.Skyblue field

Skyblue color

```csharp
public static readonly ArgbColor Skyblue;
```

### Slateblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/slateblue.md

#### ArgbColor.KnownColors.CssLevel3.Slateblue field

Slateblue color

```csharp
public static readonly ArgbColor Slateblue;
```

### Slategray
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/slategray.md

#### ArgbColor.KnownColors.CssLevel3.Slategray field

Slategray color - same as Slategrey

```csharp
public static readonly ArgbColor Slategray;
```

### Slategrey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/slategrey.md

#### ArgbColor.KnownColors.CssLevel3.Slategrey field

Slategrey color - same as Slategray

```csharp
public static readonly ArgbColor Slategrey;
```

### Snow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/snow.md

#### ArgbColor.KnownColors.CssLevel3.Snow field

Snow color

```csharp
public static readonly ArgbColor Snow;
```

### Springgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/springgreen.md

#### ArgbColor.KnownColors.CssLevel3.Springgreen field

Springgreen color

```csharp
public static readonly ArgbColor Springgreen;
```

### Steelblue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/steelblue.md

#### ArgbColor.KnownColors.CssLevel3.Steelblue field

Steelblue color

```csharp
public static readonly ArgbColor Steelblue;
```

### Tan
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/tan.md

#### ArgbColor.KnownColors.CssLevel3.Tan field

Tan color

```csharp
public static readonly ArgbColor Tan;
```

### Thistle
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/thistle.md

#### ArgbColor.KnownColors.CssLevel3.Thistle field

Thistle color

```csharp
public static readonly ArgbColor Thistle;
```

### Tomato
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/tomato.md

#### ArgbColor.KnownColors.CssLevel3.Tomato field

Tomato color

```csharp
public static readonly ArgbColor Tomato;
```

### Turquoise
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/turquoise.md

#### ArgbColor.KnownColors.CssLevel3.Turquoise field

Turquoise color

```csharp
public static readonly ArgbColor Turquoise;
```

### Violet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/violet.md

#### ArgbColor.KnownColors.CssLevel3.Violet field

Violet color

```csharp
public static readonly ArgbColor Violet;
```

### Wheat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/wheat.md

#### ArgbColor.KnownColors.CssLevel3.Wheat field

Wheat color

```csharp
public static readonly ArgbColor Wheat;
```

### Whitesmoke
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/whitesmoke.md

#### ArgbColor.KnownColors.CssLevel3.Whitesmoke field

Whitesmoke color

```csharp
public static readonly ArgbColor Whitesmoke;
```

### Yellowgreen
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel3/yellowgreen.md

#### ArgbColor.KnownColors.CssLevel3.Yellowgreen field

Yellowgreen color

```csharp
public static readonly ArgbColor Yellowgreen;
```

### ArgbColor.KnownColors.CssLevel4
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel4.md

#### ArgbColor.KnownColors.CssLevel4 class

Named colors, specified in the CSS Colors level 4. All are fully opaque.

```csharp
public static class CssLevel4
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Rebeccapurple | Rebecca Purple color |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color#css_level_4_values https://drafts.csswg.org/css-color-4/#changes-from-3

### Rebeccapurple
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.csslevel4/rebeccapurple.md

#### ArgbColor.KnownColors.CssLevel4.Rebeccapurple field

Rebecca Purple color

```csharp
public static readonly ArgbColor Rebeccapurple;
```

##### Remarks

CSS Colors Level 4 added the '**rebeccapurple**' keyword to honor web pioneer Eric Meyer: https://codepen.io/trezy/post/honoring-a-great-man

### ArgbColor.KnownColors
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors.md

#### ArgbColor.KnownColors class

Contains all "known colors", that have fixed unique name and value in CSS standart

```csharp
public static class KnownColors
```

#### Methods

| Name | Description |
| --- | --- |
| static TryFind(string, out ArgbColor) | Tries to find a color by its string name |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | Returns an empty color, which has no channels info and is fully transparent. Same as '`Transparent`'. Default value. |
| static readonly Transparent | Fully transparent empty color. The same as default '`Empty`' color value. |

#### Other Members

| Name | Description |
| --- | --- |
| static class CssLevel1 | Named colors, specified in the CSS level 1. All are fully opaque. |
| static class CssLevel2 | Named colors, specified in the CSS level 2. All are fully opaque. |
| static class CssLevel3 | Named colors, specified in the CSS Colors level 3. All are fully opaque. |
| static class CssLevel4 | Named colors, specified in the CSS Colors level 4. All are fully opaque. |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color

### Empty
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors/empty.md

#### ArgbColor.KnownColors.Empty field

Returns an empty color, which has no channels info and is fully transparent. Same as '`Transparent`'. Default value.

```csharp
public static readonly ArgbColor Empty;
```

### Transparent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors/transparent.md

#### ArgbColor.KnownColors.Transparent field

Fully transparent empty color. The same as default '`Empty`' color value.

```csharp
public static readonly ArgbColor Transparent;
```

### TryFind
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.knowncolors/tryfind.md

#### ArgbColor.KnownColors.TryFind method

Tries to find a color by its string name

```csharp
public static bool TryFind(string keyword, out ArgbColor output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | A color name |
| output | ArgbColor& | The resultant color value on success or `Transparent` value on failure |

##### Return Value

True if color was successfully found by its name, or false otherwise

### ArgbColor
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor.md

#### ArgbColor structure

Represents one color value in 32-bit ARGB format (8 bits per channel including transparency) with converters and serializers

```csharp
public struct ArgbColor : ICssDataType, IEquatable<ArgbColor>
```

#### Properties

| Name | Description |
| --- | --- |
| A { get; } | Gets the alpha part of the color. |
| Alpha { get; } | Gets the alpha part of the color in percent (0..1). |
| B { get; } | Gets the blue part of the color. |
| G { get; } | Gets the green part of the color. |
| IsDefault { get; } | Indicates whether this `ArgbColor` instance is default (Transparent) - all 4 channels are set to 0 |
| IsEmpty { get; } | Uninitialized color - all 4 channels are set to 0. Same as Default and Transparent. |
| IsFullyOpaque { get; } | Indicates whether this `ArgbColor` instance is fully opaque, without transparency (its Alpha channel has max value) |
| IsFullyTransparent { get; } | 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 { get; } | Indicates whether this `ArgbColor` instance is translucent (not fully transparent, but also not fully opaque) |
| R { get; } | Gets the red part of the color. |
| Value { get; } | Gets the Int32 value of the color. |

#### Methods

| Name | Description |
| --- | --- |
| static FromRgb(byte, byte, byte) | Creates one `ArgbColor` value from specified Red, Green, Blue channels, while Alpha channel is fully opaque |
| static FromRgba(byte, byte, byte, byte) | Creates one `ArgbColor` value from specified Red, Green, Blue, and Alpha channels |
| static FromSingleValueRgb(byte) | Creates a fully opaque (A=255) color from single value, which will be applied to all channels |
| Equals(ArgbColor) | Checks two `ArgbColor` colors for equality |
| override Equals(object) | Tests if another object is equal to this `ArgbColor` instance. |
| override GetHashCode() | Returns a hash code that defines the current color. |
| SerializeDefault() | Serializes this `ArgbColor` instance to the most appropriate CSS function notation depending on translucency |
| ToRGB() | Serializes this `ArgbColor` instance to the 'rgb' CSS function notation |
| ToRGBA() | Serializes this `ArgbColor` instance to the 'rgba' CSS function notation |
| override ToString() | Same as `SerializeDefault` |
| operator == | Compares two colors and returns a boolean indicating if the two do match. |
| operator != | Compares two colors and returns a boolean indicating if the two do not match. |

#### Other Members

| Name | Description |
| --- | --- |
| static class KnownColors | Contains all "known colors", that have fixed unique name and value in CSS standart |

##### Remarks

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

### A
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/a.md

#### ArgbColor.A property

Gets the alpha part of the color.

```csharp
public byte A { get; }
```

### Alpha
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/alpha.md

#### ArgbColor.Alpha property

Gets the alpha part of the color in percent (0..1).

```csharp
public double Alpha { get; }
```

### B
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/b.md

#### ArgbColor.B property

Gets the blue part of the color.

```csharp
public byte B { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/equals.md

#### Equals(ArgbColor)

Checks two `ArgbColor` colors for equality

```csharp
public bool Equals(ArgbColor other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ArgbColor | The other `ArgbColor` color |

##### Return Value

True if both colors or equal, otherwise false.

#### Equals(object)

Tests if another object is equal to this `ArgbColor` instance.

```csharp
public override bool Equals(object other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Object | The object to test with. |

##### Return Value

True if the two objects are equal, otherwise false.

### FromRgb
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/fromrgb.md

#### ArgbColor.FromRgb method

Creates one `ArgbColor` value from specified Red, Green, Blue channels, while Alpha channel is fully opaque

```csharp
public static ArgbColor FromRgb(byte red, byte green, byte blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red channel value |
| green | Byte | Green channel value |
| blue | Byte | Blue channel value |

##### Return Value

New `ArgbColor` value

### FromRgba
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/fromrgba.md

#### ArgbColor.FromRgba method

Creates one `ArgbColor` value from specified Red, Green, Blue, and Alpha channels

```csharp
public static ArgbColor FromRgba(byte red, byte green, byte blue, byte alpha)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red channel value |
| green | Byte | Green channel value |
| blue | Byte | Blue channel value |
| alpha | Byte | Alpha channel value |

##### Return Value

New `ArgbColor` value

### FromSingleValueRgb
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/fromsinglevaluergb.md

#### ArgbColor.FromSingleValueRgb method

Creates a fully opaque (A=255) color from single value, which will be applied to all channels

```csharp
public static ArgbColor FromSingleValueRgb(byte value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Byte | A byte value, same for Red, Green, and Blue channels |

##### Return Value

New `ArgbColor` instance

### G
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/g.md

#### ArgbColor.G property

Gets the green part of the color.

```csharp
public byte G { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/gethashcode.md

#### ArgbColor.GetHashCode method

Returns a hash code that defines the current color.

```csharp
public override int GetHashCode()
```

##### Return Value

The integer value of the hashcode.

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/isdefault.md

#### ArgbColor.IsDefault property

Indicates whether this `ArgbColor` instance is default (Transparent) - all 4 channels are set to 0

```csharp
public bool IsDefault { get; }
```

### IsEmpty
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/isempty.md

#### ArgbColor.IsEmpty property

Uninitialized color - all 4 channels are set to 0. Same as Default and Transparent.

```csharp
public bool IsEmpty { get; }
```

### IsFullyOpaque
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/isfullyopaque.md

#### ArgbColor.IsFullyOpaque property

Indicates whether this `ArgbColor` instance is fully opaque, without transparency (its Alpha channel has max value)

```csharp
public bool IsFullyOpaque { get; }
```

### IsFullyTransparent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/isfullytransparent.md

#### ArgbColor.IsFullyTransparent property

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.

```csharp
public bool IsFullyTransparent { get; }
```

### IsTranslucent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/istranslucent.md

#### ArgbColor.IsTranslucent property

Indicates whether this `ArgbColor` instance is translucent (not fully transparent, but also not fully opaque)

```csharp
public bool IsTranslucent { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/op_equality.md

#### ArgbColor Equality operator

Compares two colors and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(ArgbColor left, ArgbColor right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | ArgbColor | The first color to use. |
| right | ArgbColor | The second color to use. |

##### Return Value

True if both colors are equal, otherwise false.

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/op_inequality.md

#### ArgbColor Inequality operator

Compares two colors and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(ArgbColor left, ArgbColor right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | ArgbColor | The first color to use. |
| right | ArgbColor | The second color to use. |

##### Return Value

True if both colors are not equal, otherwise false.

### R
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/r.md

#### ArgbColor.R property

Gets the red part of the color.

```csharp
public byte R { get; }
```

### SerializeDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/serializedefault.md

#### ArgbColor.SerializeDefault method

Serializes this `ArgbColor` instance to the most appropriate CSS function notation depending on translucency

```csharp
public string SerializeDefault()
```

##### Return Value

A string with 'rgba(r, g, b, a)' or 'rgb(r, g, b)' format

### ToRGB
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/torgb.md

#### ArgbColor.ToRGB method

Serializes this `ArgbColor` instance to the 'rgb' CSS function notation

```csharp
public string ToRGB()
```

##### Return Value

A string with 'rgb(r, g, b)' format

### ToRGBA
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/torgba.md

#### ArgbColor.ToRGBA method

Serializes this `ArgbColor` instance to the 'rgba' CSS function notation

```csharp
public string ToRGBA()
```

##### Return Value

A string with 'rgba(r, g, b, a)' format

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/tostring.md

#### ArgbColor.ToString method

Same as `SerializeDefault`

```csharp
public override string ToString()
```

##### Return Value

Same return value as in `SerializeDefault`

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/argbcolor/value.md

#### ArgbColor.Value property

Gets the Int32 value of the color.

```csharp
public int Value { get; }
```

### ICssDataType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/icssdatatype.md

#### ICssDataType interface

Common interface for all CSS data types, which are used in the CSS properties

```csharp
public interface ICssDataType : IEquatable<ICssDataType>
```

#### Properties

| Name | Description |
| --- | --- |
| IsDefault { get; } | Should define whether the current value of the data type is the default value for this specific data type (true) or not (false) |

#### Methods

| Name | Description |
| --- | --- |
| SerializeDefault() | Should return a default string representation of the current value of the data type |

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/icssdatatype/isdefault.md

#### ICssDataType.IsDefault property

Should define whether the current value of the data type is the default value for this specific data type (true) or not (false)

```csharp
public bool IsDefault { get; }
```

### SerializeDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/icssdatatype/serializedefault.md

#### ICssDataType.SerializeDefault method

Should return a default string representation of the current value of the data type

```csharp
public string SerializeDefault()
```

##### Return Value

A new string with value of this data type

### Length.Unit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length.unit.md

#### Length.Unit enumeration

All supported length units

```csharp
public enum Unit
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unitless | `0` | Unitless - no defined length unit. Default value. |
| Px | `1` | Pixel. Relative to the viewing device. For screen display, typically one device pixel (dot) of the display. |
| Em | `2` | Em. This unit represents the calculated font-size of the element. |
| Ex | `3` | 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 ≈ 0.5em in many fonts. |
| Cm | `4` | Cm. One centimeter (10 millimeters). |
| Mm | `5` | Mm. One millimeter. |
| In | `6` | In. One inch (2.54 centimeters). |
| Pt | `7` | Pt. One point is 1/72th of an inch or 0.353 mm. |
| Pc | `8` | Pc. One pica (12 points). |
| Ch | `9` | 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 | `10` | Rem. This unit represents the font-size of the root element (e.g. the font-size of the &lt;html&gt; element). When used on the font-size on this root element, it represents its initial value. |
| Vw | `11` | Vw - viewport width. 1/100th of the width of the viewport. |
| Vh | `12` | Vh - viewport height. 1/100th of the height of the viewport. |
| Vmin | `13` | Vmin. 1/100th of the minimum value between the height and the width of the viewport. |
| Vmax | `14` | Vmax. 1/100th of the maximum value between the height and the width of the viewport. |
| Percent | `15` | The value is relative to a fixed (external) value, that is context dependent. 1% = 1/100 of the external value. |

##### Remarks

https://developer.mozilla.org/en-US/docs/Web/CSS/length#Units

### Length
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length.md

#### Length structure

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.

```csharp
public struct Length : ICloneable, ICssDataType, IEquatable<Length>
```

#### Properties

| Name | Description |
| --- | --- |
| FloatValue { get; } | Returns a float numeric value of the Length instance. Never throws an exception - converts Integer value to Float if necessary. |
| IntegerValue { get; } | 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 { get; } | Gets if the length is given in absolute units. Such a length may be converted to pixels. |
| IsDefault { get; } | Indicates whether this Length instance has a default value — unitless zero. Same as IsUnitlessZero property. |
| IsFloat { get; } | Indicates whether the numeric value of this Length instance was originally specified and stored as a float (FP32) number |
| IsInteger { get; } | Indicates whether the numeric value of this Length instance was originally specified and stored as an integer (INT32) number |
| IsNegative { get; } | Determines whether the numeric value of this length is a negative number |
| IsPositive { get; } | Determines whether the numeric value of this length is a positive number |
| IsRelative { get; } | Gets if the length is given in relative units. Such a length cannot be converted to pixels. |
| IsUnitlessNonZero { get; } | The value has unitless type, but is not a zero - positive or negative number |
| IsUnitlessZero { get; } | Determines whether this instance is a unitless zero or not. Unitless zero is default value of this type. Same as IsDefault property. |
| IsZero { get; } | Determines whether the numeric value of this length is a zero number |
| UnitType { get; } | Returns a unit type of this Length instance. |

#### Methods

| Name | Description |
| --- | --- |
| static FromValueWithUnit(double, Unit) | Creates and returns an instance of Length type by specified double number and unit |
| static FromValueWithUnit(float, Unit) | Creates and returns an instance of Length type by specified float number and unit |
| static FromValueWithUnit(int, Unit) | Creates and returns an instance of Length type by specified integer number and unit |
| static Parse(string) | Parses and returns specified string as a Length value, including its numeric value and unit name, or throws an exception on failure |
| Clone() | Returns a full copy of this Length instance |
| Equals(Length) | Defines whether this value is equal to the other specified length |
| override Equals(object) | Determines whether this length is equal to specified object |
| override GetHashCode() | Calculates and returns a hash-code of this Length instance by combining hash-codes of the value and 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 |
| To(Unit) | Converts the length to the given unit, if possible. If the current or given unit is relative, then an exception will be thrown. |
| ToPixel() | Converts the length to a number of pixels, if possible. If the current unit is relative, then an exception will be thrown. |
| ToStringSpecified(Unit) | Returns a string representation of this length in specified unit type. Numeric value will be converted in corresponding to unit type change. |
| static GetUnitFromName(string) | Tries to parse specified unit name and return corresponding value of a Unit enum. Returns Unit.Unitless if cannot find appropriate unit. |
| static TryParse(string, out Length) | Tries to parse a specified string as a Length value, including its numeric value and unit name |
| operator == | Checks the equality of the two given lengths. |
| operator != | Checks the inequality of the two given lengths. |
| operator * | Multiplicates the given Length onto the given factor |

#### Fields

| Name | Description |
| --- | --- |
| static readonly FiftyPercents | 50% |
| static readonly OneHundredPercents | 100% |
| static readonly UnitlessZero | Unitless integer zero - default value, the same as default parameterless constructor |
| static readonly ZeroPercents | 0% |

#### Other Members

| Name | Description |
| --- | --- |
| enum Unit | All supported length units |

##### Remarks

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

### Clone
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/clone.md

#### Length.Clone method

Returns a full copy of this Length instance

```csharp
public Length Clone()
```

##### Return Value

New separate instance of this Length, that is absolutely identical to this one

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/equals.md

#### Equals(Length)

Defines whether this value is equal to the other specified length

```csharp
public bool Equals(Length other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Length | Other instance of Length type |

##### Return Value

True if equal, otherwise false

#### Equals(object)

Determines whether this length is equal to specified object

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other instance of Length type, that is boxed to the System.Object or any other abstract type or interface |

##### Return Value

True if equal, otherwise false

### FiftyPercents
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/fiftypercents.md

#### Length.FiftyPercents field

50%

```csharp
public static readonly Length FiftyPercents;
```

### FloatValue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/floatvalue.md

#### Length.FloatValue property

Returns a float numeric value of the Length instance. Never throws an exception - converts Integer value to Float if necessary.

```csharp
public float FloatValue { get; }
```

### FromValueWithUnit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/fromvaluewithunit.md

#### FromValueWithUnit(float, Unit)

Creates and returns an instance of Length type by specified float number and unit

```csharp
public static Length FromValueWithUnit(float value, Unit unit)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Single | &gt;Any float (FP32) number |
| unit | Unit | Any valid unit type |

##### Return Value

New instance of Length type

#### FromValueWithUnit(double, Unit)

Creates and returns an instance of Length type by specified double number and unit

```csharp
public static Length FromValueWithUnit(double value, Unit unit)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Double | Any double (FP64) number, that will be converted to float (FP32) |
| unit | Unit | Any valid unit type |

##### Return Value

New instance of Length type

#### FromValueWithUnit(int, Unit)

Creates and returns an instance of Length type by specified integer number and unit

```csharp
public static Length FromValueWithUnit(int value, Unit unit)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int32 | Any integer number |
| unit | Unit | Any valid unit type |

##### Return Value

New instance of Length type

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/gethashcode.md

#### Length.GetHashCode method

Calculates and returns a hash-code of this Length instance by combining hash-codes of the value and unit type

```csharp
public override int GetHashCode()
```

##### Return Value

Integer number

### GetUnitFromName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/getunitfromname.md

#### Length.GetUnitFromName method

Tries to parse specified unit name and return corresponding value of a Unit enum. Returns Unit.Unitless if cannot find appropriate unit.

```csharp
public static Unit GetUnitFromName(string unitName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| unitName | String | String, that represents a unit name |

##### Return Value

Value of Unit enum in any case, Unit.Unitless when cannot find appropriate unit

### IntegerValue
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/integervalue.md

#### Length.IntegerValue property

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.

```csharp
public int IntegerValue { get; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException |  |

### IsAbsolute
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isabsolute.md

#### Length.IsAbsolute property

Gets if the length is given in absolute units. Such a length may be converted to pixels.

```csharp
public bool IsAbsolute { get; }
```

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isdefault.md

#### Length.IsDefault property

Indicates whether this Length instance has a default value — unitless zero. Same as IsUnitlessZero property.

```csharp
public bool IsDefault { get; }
```

### IsFloat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isfloat.md

#### Length.IsFloat property

Indicates whether the numeric value of this Length instance was originally specified and stored as a float (FP32) number

```csharp
public bool IsFloat { get; }
```

### IsInteger
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isinteger.md

#### Length.IsInteger property

Indicates whether the numeric value of this Length instance was originally specified and stored as an integer (INT32) number

```csharp
public bool IsInteger { get; }
```

### IsNegative
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isnegative.md

#### Length.IsNegative property

Determines whether the numeric value of this length is a negative number

```csharp
public bool IsNegative { get; }
```

### IsPositive
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/ispositive.md

#### Length.IsPositive property

Determines whether the numeric value of this length is a positive number

```csharp
public bool IsPositive { get; }
```

### IsRelative
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isrelative.md

#### Length.IsRelative property

Gets if the length is given in relative units. Such a length cannot be converted to pixels.

```csharp
public bool IsRelative { get; }
```

### IsUnitlessNonZero
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isunitlessnonzero.md

#### Length.IsUnitlessNonZero property

The value has unitless type, but is not a zero - positive or negative number

```csharp
public bool IsUnitlessNonZero { get; }
```

### IsUnitlessZero
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/isunitlesszero.md

#### Length.IsUnitlessZero property

Determines whether this instance is a unitless zero or not. Unitless zero is default value of this type. Same as IsDefault property.

```csharp
public bool IsUnitlessZero { get; }
```

### IsZero
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/iszero.md

#### Length.IsZero property

Determines whether the numeric value of this length is a zero number

```csharp
public bool IsZero { get; }
```

### OneHundredPercents
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/onehundredpercents.md

#### Length.OneHundredPercents field

100%

```csharp
public static readonly Length OneHundredPercents;
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/op_equality.md

#### Length Equality operator

Checks the equality of the two given lengths.

```csharp
public static bool operator ==(Length left, Length right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Length | The left length operand. |
| right | Length | The right length operand. |

##### Return Value

True if both lengths are equal, otherwise false.

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/op_inequality.md

#### Length Inequality operator

Checks the inequality of the two given lengths.

```csharp
public static bool operator !=(Length left, Length right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Length | The left length operand. |
| right | Length | The right length operand. |

##### Return Value

True if both lengths are not equal, otherwise false.

### op_Multiply
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/op_multiply.md

#### Length Multiply operator

Multiplicates the given Length onto the given factor

```csharp
public static Length operator *(Length multiplicand, int factor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| multiplicand | Length | Length - multiplicand |
| factor | Int32 | Arbitrary integer - factor |

##### Return Value

A new Length - a product of multiplication

### Parse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/parse.md

#### Length.Parse method

Parses and returns specified string as a Length value, including its numeric value and unit name, or throws an exception on failure

```csharp
public static Length Parse(string input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | String | Input string, that should be parsed |

##### Return Value

Valid parsed Length instance

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |

### SerializeDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/serializedefault.md

#### Length.SerializeDefault method

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

```csharp
public string SerializeDefault()
```

##### Return Value

String instance

### To
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/to.md

#### Length.To method

Converts the length to the given unit, if possible. If the current or given unit is relative, then an exception will be thrown.

```csharp
public float To(Unit unit)
```

| Parameter | Type | Description |
| --- | --- | --- |
| unit | Unit | The unit to convert to. |

##### Return Value

The value in the given unit of the current length.

### ToPixel
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/topixel.md

#### Length.ToPixel method

Converts the length to a number of pixels, if possible. If the current unit is relative, then an exception will be thrown.

```csharp
public float ToPixel()
```

##### Return Value

The number of pixels represented by the current length.

### ToStringSpecified
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/tostringspecified.md

#### Length.ToStringSpecified method

Returns a string representation of this length in specified unit type. Numeric value will be converted in corresponding to unit type change.

```csharp
public string ToStringSpecified(Unit unit)
```

| Parameter | Type | Description |
| --- | --- | --- |
| unit | Unit | Specified unit, to which this instance should be converted before serializing to the string. Should be valid. Cannot be unitless. |

##### Return Value

String representation

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidEnumArgumentException | Value is not defined |
| ArgumentOutOfRangeException | Unitless value is prohibited |

### TryParse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/tryparse.md

#### Length.TryParse method

Tries to parse a specified string as a Length value, including its numeric value and unit name

```csharp
public static bool TryParse(string input, out Length result)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | 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 — a unitless zero. |

##### Return Value

True if parsing is successful, false if unsuccessful

### UnitlessZero
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/unitlesszero.md

#### Length.UnitlessZero field

Unitless integer zero - default value, the same as default parameterless constructor

```csharp
public static readonly Length UnitlessZero;
```

### UnitType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/unittype.md

#### Length.UnitType property

Returns a unit type of this Length instance.

```csharp
public Unit UnitType { get; }
```

### ZeroPercents
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/length/zeropercents.md

#### Length.ZeroPercents field

0%

```csharp
public static readonly Length ZeroPercents;
```

### Ratio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio.md

#### Ratio structure

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.

```csharp
public struct Ratio : ICloneable, ICssDataType, IEquatable<Ratio>
```

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Returns a denominator of this ratio |
| IsDefault { get; } | Determines whether this ratio has default value or is a "1/1" (Single) |
| Numerator { get; } | Returns a numerator of this ratio |

#### Methods

| Name | Description |
| --- | --- |
| static Create(ushort, ushort) | Creates and returns one Ratio instance from specified numerator and denominator |
| Calculate() | Calculates and returns this ratio as a single floating point number |
| Clone() | Returns a full copy of this ratio |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance |
| Equals(Ratio) | Determines whether this instance is equal with specified "Ratio" instance |
| override GetHashCode() | Returns a hashcode for this instance, which cannot be changed during its lifetime |
| GetInverseRatio() | Generates and returns an inverse (reciprocal) ratio for this ratio |
| SerializeDefault() | Serializes this ratio to the string and returns it |
| override ToString() | Returns a string representation of this ratio; same as "SerializeDefault()" |
| operator == | Compares two ratios and returns a boolean indicating if the two do match. |
| operator != | Compares two ratios and returns a boolean indicating if the two do not match. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Single | Single default ratio 1/1 |

##### Remarks

https://developer.mozilla.org/en-US/docs/Web/CSS/ratio

### Calculate
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/calculate.md

#### Ratio.Calculate method

Calculates and returns this ratio as a single floating point number

```csharp
public double Calculate()
```

##### Return Value

Floating-point number with double precision

### Clone
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/clone.md

#### Ratio.Clone method

Returns a full copy of this ratio

```csharp
public Ratio Clone()
```

##### Return Value

New Ratio instance, that is a full and deep copy of this one

### Create
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/create.md

#### Ratio.Create method

Creates and returns one Ratio instance from specified numerator and denominator

```csharp
public static Ratio Create(ushort numerator, ushort denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | UInt16 | Numerator for the ratio. Should be a strictly positive integer number. |
| denominator | UInt16 | Denominator for the ratio. Should be a strictly positive integer number. |

##### Return Value

New Ratio instance

### Denominator
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/denominator.md

#### Ratio.Denominator property

Returns a denominator of this ratio

```csharp
public ushort Denominator { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/equals.md

#### Equals(Ratio)

Determines whether this instance is equal with specified "Ratio" instance

```csharp
public bool Equals(Ratio other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Ratio | Other Ratio instance to check on equality with this |

##### Return Value

True if are equal, false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance

```csharp
public override bool Equals(object other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Object | Other System.Object instance, that is presumably of Ratio type, to check on equality with this |

##### Return Value

True if are equal, false if are unequal

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/gethashcode.md

#### Ratio.GetHashCode method

Returns a hashcode for this instance, which cannot be changed during its lifetime

```csharp
public override int GetHashCode()
```

##### Return Value

Signed 4-byte integer, that is immutable for this instance

### GetInverseRatio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/getinverseratio.md

#### Ratio.GetInverseRatio method

Generates and returns an inverse (reciprocal) ratio for this ratio

```csharp
public Ratio GetInverseRatio()
```

##### Return Value

New Ratio instance, that is an inverse ratio for this one

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/isdefault.md

#### Ratio.IsDefault property

Determines whether this ratio has default value or is a "1/1" (Single)

```csharp
public bool IsDefault { get; }
```

### Numerator
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/numerator.md

#### Ratio.Numerator property

Returns a numerator of this ratio

```csharp
public ushort Numerator { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/op_equality.md

#### Ratio Equality operator

Compares two ratios and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(Ratio left, Ratio right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Ratio | The first ratio to use. |
| right | Ratio | The second ratio to use. |

##### Return Value

True if both ratios are equal, otherwise false.

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/op_inequality.md

#### Ratio Inequality operator

Compares two ratios and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(Ratio left, Ratio right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Ratio | The first ratio to use. |
| right | Ratio | The second ratio to use. |

##### Return Value

True if both ratios are not equal, otherwise false.

### SerializeDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/serializedefault.md

#### Ratio.SerializeDefault method

Serializes this ratio to the string and returns it

```csharp
public string SerializeDefault()
```

##### Return Value

String in "numerator/denominator" format

### Single
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/single.md

#### Ratio.Single field

Single default ratio 1/1

```csharp
public static readonly Ratio Single;
```

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.datatypes/ratio/tostring.md

#### Ratio.ToString method

Returns a string representation of this ratio; same as "SerializeDefault()"

```csharp
public override string ToString()
```

##### Return Value

String in "numerator/denominator" format

### GroupDocs.Editor.HtmlCss.Css.Properties
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties.md

The GroupDocs.Editor.HtmlCss.Css.Properties namespace provides types that represent different CSS properties (components of CSS declarations).

#### Structures

| Structure | 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. The weights available depend on the font-family that is currently set. |
| TextDecorationLineType | Represents types of the text decoration line: underline (underscore), overline, and line-through (strikethrough) |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### FontSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize.md

#### FontSize structure

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").

```csharp
public struct FontSize : IEquatable<FontSize>
```

#### Properties

| Name | Description |
| --- | --- |
| IsAbsoluteSize { get; } | 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) |
| IsInitial { get; } | Indicates whether this font-size has an initial value (Medium) |
| IsLengthDefined { get; } | Indicates whether this font-size is defined with a `Length` value |
| IsRelativeSize { get; } | 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. |
| Length { get; } | A length value, if this font-size was defined with it, or throwed exception otherwise |
| Value { get; } | Returns a value of this font size as a string |

#### Methods

| Name | Description |
| --- | --- |
| static FromLength(Length) | Creates a font-size from specified length |
| Equals(FontSize) | Determines whether this font-size instance is equal to specified |
| override Equals(object) | Determines whether this font-size instance is equal to specified uncasted |
| override GetHashCode() | Returns a hash-code for this instance |
| static TryParse(string, out FontSize) | Tries to recognize a specified keyword as a proper keyword value of the 'font-size' and return it on success or NULL on failure. |
| operator == | Checks whether two "FontSize" values are equal |
| operator != | Checks whether two "FontSize" values are not equal |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Large | The normally large absolute-size |
| static readonly 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. |
| static readonly Medium | Medium size. Initial value. |
| static readonly Small | The normally small absolute-size |
| static readonly 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. |
| static readonly XLarge | The mediocre large absolute-size |
| static readonly XSmall | The mediocre small absolute-size |
| static readonly XxLarge | The very large absolute-size |
| static readonly XxSmall | The very small absolute-size |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/equals.md

#### Equals(FontSize)

Determines whether this font-size instance is equal to specified

```csharp
public bool Equals(FontSize other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontSize | Other font-size instance |

##### Return Value

true if are equal, false otherwise

#### Equals(object)

Determines whether this font-size instance is equal to specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other uncasted font-size instance, may be null |

##### Return Value

true if are equal, false if not equal, null or of other type

### FromLength
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/fromlength.md

#### FontSize.FromLength method

Creates a font-size from specified length

```csharp
public static FontSize FromLength(Length length)
```

| Parameter | Type | Description |
| --- | --- | --- |
| length | Length | A length value, cannot be unitless or negative |

##### Return Value

New FontSize instance

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Font size value is unit-less or negative |

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/gethashcode.md

#### FontSize.GetHashCode method

Returns a hash-code for this instance

```csharp
public override int GetHashCode()
```

##### Return Value

Hash-code as an signed integer

### IsAbsoluteSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/isabsolutesize.md

#### FontSize.IsAbsoluteSize property

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)

```csharp
public bool IsAbsoluteSize { get; }
```

### IsInitial
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/isinitial.md

#### FontSize.IsInitial property

Indicates whether this font-size has an initial value (Medium)

```csharp
public bool IsInitial { get; }
```

### IsLengthDefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/islengthdefined.md

#### FontSize.IsLengthDefined property

Indicates whether this font-size is defined with a `Length` value

```csharp
public bool IsLengthDefined { get; }
```

### IsRelativeSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/isrelativesize.md

#### FontSize.IsRelativeSize property

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.

```csharp
public bool IsRelativeSize { get; }
```

### Large
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/large.md

#### FontSize.Large field

The normally large absolute-size

```csharp
public static readonly FontSize Large;
```

### Larger
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/larger.md

#### FontSize.Larger field

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.

```csharp
public static readonly FontSize Larger;
```

### Length
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/length.md

#### FontSize.Length property

A length value, if this font-size was defined with it, or throwed exception otherwise

```csharp
public Length Length { get; }
```

### Medium
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/medium.md

#### FontSize.Medium field

Medium size. Initial value.

```csharp
public static readonly FontSize Medium;
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/op_equality.md

#### FontSize Equality operator

Checks whether two "FontSize" values are equal

```csharp
public static bool operator ==(FontSize first, FontSize second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontSize | First value to check |
| second | FontSize | Second value to check |

##### Return Value

true if are equal, false otherwise

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/op_inequality.md

#### FontSize Inequality operator

Checks whether two "FontSize" values are not equal

```csharp
public static bool operator !=(FontSize first, FontSize second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontSize | First value to check |
| second | FontSize | Second value to check |

##### Return Value

false if are equal, true otherwise

### Small
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/small.md

#### FontSize.Small field

The normally small absolute-size

```csharp
public static readonly FontSize Small;
```

### Smaller
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/smaller.md

#### FontSize.Smaller field

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.

```csharp
public static readonly FontSize Smaller;
```

### TryParse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/tryparse.md

#### FontSize.TryParse method

Tries to recognize a specified keyword as a proper keyword value of the 'font-size' and return it on success or NULL on failure.

```csharp
public static bool TryParse(string keyword, out FontSize result)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | A keyword to parse |
| result | FontSize& | Result, of parsing was successful, or `Medium` otherwise |

##### Return Value

true if parsing was successful, false otherwise

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/value.md

#### FontSize.Value property

Returns a value of this font size as a string

```csharp
public string Value { get; }
```

### XLarge
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/xlarge.md

#### FontSize.XLarge field

The mediocre large absolute-size

```csharp
public static readonly FontSize XLarge;
```

### XSmall
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/xsmall.md

#### FontSize.XSmall field

The mediocre small absolute-size

```csharp
public static readonly FontSize XSmall;
```

### XxLarge
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/xxlarge.md

#### FontSize.XxLarge field

The very large absolute-size

```csharp
public static readonly FontSize XxLarge;
```

### XxSmall
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontsize/xxsmall.md

#### FontSize.XxSmall field

The very small absolute-size

```csharp
public static readonly FontSize XxSmall;
```

### FontStyle
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle.md

#### FontStyle structure

Defines how the font should be styled with: a normal, italic, or oblique face from its font-family.

```csharp
public struct FontStyle
```

#### Properties

| Name | Description |
| --- | --- |
| IsInitial { get; } | Indicates whether this font-style has an initial value (Normal) |
| Value { get; } | Returns a value of this font style as a string |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FontStyle) | Determines whether this font-style instance is equal to specified |
| override Equals(object) | Determines whether this font-style instance is equal to specified uncasted |
| override GetHashCode() | Returns a hash-code for this instance |
| static TryParse(string, out FontStyle) | Tries to recognize a specified keyword as a proper keyword value of the 'font-style' and return it on success or NULL on failure. |
| operator == | Checks whether two "FontStyle" values are equal |
| operator != | Checks whether two "FontStyle" values are not equal |

#### Fields

| Name | Description |
| --- | --- |
| static readonly 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. |
| static readonly Normal | Selects a font that is classified as normal within a font-family. Initial value. |
| static readonly 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. |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/equals.md

#### Equals(FontStyle)

Determines whether this font-style instance is equal to specified

```csharp
public bool Equals(FontStyle other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontStyle | Other font-style instance |

##### Return Value

true if are equal, false otherwise

#### Equals(object)

Determines whether this font-style instance is equal to specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other uncasted font-style instance, may be null |

##### Return Value

true if are equal, false if not equal, null or of other type

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/gethashcode.md

#### FontStyle.GetHashCode method

Returns a hash-code for this instance

```csharp
public override int GetHashCode()
```

##### Return Value

Hash-code as an signed integer

### IsInitial
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/isinitial.md

#### FontStyle.IsInitial property

Indicates whether this font-style has an initial value (Normal)

```csharp
public bool IsInitial { get; }
```

### Italic
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/italic.md

#### FontStyle.Italic field

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.

```csharp
public static readonly FontStyle Italic;
```

### Normal
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/normal.md

#### FontStyle.Normal field

Selects a font that is classified as normal within a font-family. Initial value.

```csharp
public static readonly FontStyle Normal;
```

### Oblique
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/oblique.md

#### FontStyle.Oblique field

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.

```csharp
public static readonly FontStyle Oblique;
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/op_equality.md

#### FontStyle Equality operator

Checks whether two "FontStyle" values are equal

```csharp
public static bool operator ==(FontStyle first, FontStyle second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyle | First value to check |
| second | FontStyle | Second value to check |

##### Return Value

true if are equal, false otherwise

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/op_inequality.md

#### FontStyle Inequality operator

Checks whether two "FontStyle" values are not equal

```csharp
public static bool operator !=(FontStyle first, FontStyle second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyle | First value to check |
| second | FontStyle | Second value to check |

##### Return Value

false if are equal, true otherwise

### TryParse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/tryparse.md

#### FontStyle.TryParse method

Tries to recognize a specified keyword as a proper keyword value of the 'font-style' and return it on success or NULL on failure.

```csharp
public static bool TryParse(string keyword, out FontStyle result)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | A keyword to parse |
| result | FontStyle& | Result, of parsing was successful, or `Normal` otherwise |

##### Return Value

true if parsing was successful, false otherwise

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontstyle/value.md

#### FontStyle.Value property

Returns a value of this font style as a string

```csharp
public string Value { get; }
```

### FontWeight
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight.md

#### FontWeight structure

Font-weight property sets the weight (or boldness) of the font. The weights available depend on the font-family that is currently set.

```csharp
public struct FontWeight : IEquatable<FontWeight>
```

#### Properties

| Name | Description |
| --- | --- |
| IsAbsolute { get; } | Indicates whether this font-weight instance stores an absolute value of the weight (boldness) of the font, as an integer number |
| IsInitial { get; } | Indicates whether this font-size has an initial value (Medium) |
| IsRelative { get; } | 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 |
| Number { get; } | 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 |
| Value { get; } | Returns a value of this font-weight as a string |

#### Methods

| Name | Description |
| --- | --- |
| static FromNumber(ushort) | Creates a font-weight from specified number |
| Equals(FontWeight) | Determines whether specified FontWeight instances are equal |
| override Equals(object) | Determines whether this FontWeight instance is equal to specified uncasted |
| override GetHashCode() | Returns a hash-code for this instance |
| static TryParse(string, out FontWeight) | Tries to parse a specified string and return a valid FontWeight instance on success |
| operator == | Checks whether two "FontWeight" values are equal |
| operator != | Checks whether two "FontWeight" values are not equal |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Bold | Bold font weight. Same as 700. |
| static readonly Bolder | One relative font weight heavier than the parent element |
| static readonly Lighter | One relative font weight lighter than the parent element |
| static readonly Normal | Normal font weight. Same as 400. |

### Bold
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/bold.md

#### FontWeight.Bold field

Bold font weight. Same as 700.

```csharp
public static readonly FontWeight Bold;
```

### Bolder
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/bolder.md

#### FontWeight.Bolder field

One relative font weight heavier than the parent element

```csharp
public static readonly FontWeight Bolder;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/equals.md

#### Equals(FontWeight)

Determines whether specified FontWeight instances are equal

```csharp
public bool Equals(FontWeight other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontWeight | Other FontWeight instance to check the equality |

##### Return Value

true if are equal, false if are unequal

#### Equals(object)

Determines whether this FontWeight instance is equal to specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other uncasted FontWeight instance, may be null |

##### Return Value

true if are equal, false if not equal, null or of other type

### FromNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/fromnumber.md

#### FontWeight.FromNumber method

Creates a font-weight from specified number

```csharp
public static FontWeight FromNumber(ushort number)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | UInt16 | Unsigned integer, must be within [1..1000] range |

##### Return Value

New FontWeight instance or exception

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified number is out from [1..1000] range |

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/gethashcode.md

#### FontWeight.GetHashCode method

Returns a hash-code for this instance

```csharp
public override int GetHashCode()
```

##### Return Value

Hash-code as an signed integer

### IsAbsolute
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/isabsolute.md

#### FontWeight.IsAbsolute property

Indicates whether this font-weight instance stores an absolute value of the weight (boldness) of the font, as an integer number

```csharp
public bool IsAbsolute { get; }
```

### IsInitial
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/isinitial.md

#### FontWeight.IsInitial property

Indicates whether this font-size has an initial value (Medium)

```csharp
public bool IsInitial { get; }
```

### IsRelative
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/isrelative.md

#### FontWeight.IsRelative property

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

```csharp
public bool IsRelative { get; }
```

### Lighter
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/lighter.md

#### FontWeight.Lighter field

One relative font weight lighter than the parent element

```csharp
public static readonly FontWeight Lighter;
```

### Normal
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/normal.md

#### FontWeight.Normal field

Normal font weight. Same as 400.

```csharp
public static readonly FontWeight Normal;
```

### Number
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/number.md

#### FontWeight.Number property

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

```csharp
public ushort Number { get; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| InvalidOperationException | Thrown if current font-weight holds a relative value of the font boldness |

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/op_equality.md

#### FontWeight Equality operator

Checks whether two "FontWeight" values are equal

```csharp
public static bool operator ==(FontWeight first, FontWeight second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontWeight | First value to check |
| second | FontWeight | Second value to check |

##### Return Value

true if are equal, false otherwise

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/op_inequality.md

#### FontWeight Inequality operator

Checks whether two "FontWeight" values are not equal

```csharp
public static bool operator !=(FontWeight first, FontWeight second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontWeight | First value to check |
| second | FontWeight | Second value to check |

##### Return Value

false if are equal, true otherwise

### TryParse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/tryparse.md

#### FontWeight.TryParse method

Tries to parse a specified string and return a valid FontWeight instance on success

```csharp
public static bool TryParse(string input, out FontWeight result)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | String | Input string to parse |
| result | FontWeight& | Valid FontWeight value on success or `Normal` on failure |

##### Return Value

Success (true) or failure (false) of the parsing

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/fontweight/value.md

#### FontWeight.Value property

Returns a value of this font-weight as a string

```csharp
public string Value { get; }
```

### TextDecorationLineType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype.md

#### TextDecorationLineType structure

Represents types of the text decoration line: underline (underscore), overline, and line-through (strikethrough)

```csharp
public struct TextDecorationLineType : IEquatable<TextDecorationLineType>
```

#### Properties

| Name | Description |
| --- | --- |
| IsInitial { get; } | Indicates whether this instance has an initial value — None |
| IsLineThrough { get; } | Indicates whether line-through (strikethrough) is enabled |
| IsOverline { get; } | Indicates whether overline is enabled |
| IsUnderline { get; } | Indicates whether underline (underscore) is enabled |
| Value { get; } | Returns a value of all flags in this instance as text |

#### Methods

| Name | Description |
| --- | --- |
| static FromFlags(bool, bool, bool) | Creates and returns a `TextDecorationLineType` instance with flags, defined by the specified parameters |
| override Equals(object) | Indicates whether this `TextDecorationLineType` instance is equal to specified uncasted |
| Equals(TextDecorationLineType) | Indicates whether this `TextDecorationLineType` instance is equal to specified |
| override GetHashCode() | Returns a hash-code of this instance |
| override ToString() | Returns a value of all flags in this instance as text |
| static TryParse(string, out TextDecorationLineType) | Tries to parse a specified string and return a valid `TextDecorationLineType` instance |
| operator + | Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union) |
| operator / | 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) |
| operator == | Checks whether two "TextDecorationLineType" values are equal |
| explicit operator | Casts specific Byte (8-bit octet) to the corresponding `TextDecorationLineType`, throws exception if casting is invalid (2 operators) |
| operator != | Checks whether two "TextDecorationLineType" values are not equal |
| operator - | 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) |

#### Fields

| Name | Description |
| --- | --- |
| static readonly LineThrough | Each line of text has a line through the middle. |
| static readonly None | Produces no text decoration. Initial value. |
| static readonly Overline | Each line of text has a line above it. |
| static readonly Underline | Each line of text is underlined. |

##### Remarks

Immutable struct. Similar to the https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration-line

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/equals.md

#### Equals(TextDecorationLineType)

Indicates whether this `TextDecorationLineType` instance is equal to specified

```csharp
public bool Equals(TextDecorationLineType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TextDecorationLineType | Other `TextDecorationLineType` instance |

##### Return Value

`true` if are equal, `false` otherwise

#### Equals(object)

Indicates whether this `TextDecorationLineType` instance is equal to specified uncasted

```csharp
public override bool Equals(object other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Object | Other `TextDecorationLineType` instance, casted to object |

##### Return Value

`true` if are equal, `false` otherwise

### FromFlags
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/fromflags.md

#### TextDecorationLineType.FromFlags method

Creates and returns a `TextDecorationLineType` instance with flags, defined by the specified parameters

```csharp
public static TextDecorationLineType FromFlags(bool isUnderline, bool isOverline, 
    bool isLineThrough)
```

| 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 |

##### Return Value

New `TextDecorationLineType` instance

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/gethashcode.md

#### TextDecorationLineType.GetHashCode method

Returns a hash-code of this instance

```csharp
public override int GetHashCode()
```

##### Return Value

Signed integer hash-code

### IsInitial
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/isinitial.md

#### TextDecorationLineType.IsInitial property

Indicates whether this instance has an initial value — None

```csharp
public bool IsInitial { get; }
```

### IsLineThrough
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/islinethrough.md

#### TextDecorationLineType.IsLineThrough property

Indicates whether line-through (strikethrough) is enabled

```csharp
public bool IsLineThrough { get; }
```

### IsOverline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/isoverline.md

#### TextDecorationLineType.IsOverline property

Indicates whether overline is enabled

```csharp
public bool IsOverline { get; }
```

### IsUnderline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/isunderline.md

#### TextDecorationLineType.IsUnderline property

Indicates whether underline (underscore) is enabled

```csharp
public bool IsUnderline { get; }
```

### LineThrough
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/linethrough.md

#### TextDecorationLineType.LineThrough field

Each line of text has a line through the middle.

```csharp
public static readonly TextDecorationLineType LineThrough;
```

### None
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/none.md

#### TextDecorationLineType.None field

Produces no text decoration. Initial value.

```csharp
public static readonly TextDecorationLineType None;
```

### op_Addition
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_addition.md

#### TextDecorationLineType Addition operator

Combines (merges) two specified line types and produces new resultant line type, where flags are merged (union)

```csharp
public static TextDecorationLineType operator +(TextDecorationLineType first, 
    TextDecorationLineType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

##### Return Value

Result of the union between specified operands

### op_Division
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_division.md

#### TextDecorationLineType Division operator

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)

```csharp
public static TextDecorationLineType operator /(TextDecorationLineType first, 
    TextDecorationLineType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

##### Return Value

Result of the intersection between specified operands

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_equality.md

#### TextDecorationLineType Equality operator

Checks whether two "TextDecorationLineType" values are equal

```csharp
public static bool operator ==(TextDecorationLineType first, TextDecorationLineType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First operand to check |
| second | TextDecorationLineType | Second operand to check |

##### Return Value

`true` if are equal, `false` otherwise

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_explicit.md

#### explicit operator

Casts specific Byte (8-bit octet) to the corresponding `TextDecorationLineType`, throws exception if casting is invalid

```csharp
public static explicit operator TextDecorationLineType(byte octet)
```

| Parameter | Type | Description |
| --- | --- | --- |
| octet | Byte | A 8-bit octet (bitfield), where 5 leading bits are zeros, while last 3 indicate flags |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified *octet* has invalid value |

#### explicit operator

Casts specified `TextDecorationLineType` instance to the equivalint octet (8-bit bitfield)

```csharp
public static explicit operator byte(TextDecorationLineType input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | TextDecorationLineType | `TextDecorationLineType` instance to cast |

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_inequality.md

#### TextDecorationLineType Inequality operator

Checks whether two "TextDecorationLineType" values are not equal

```csharp
public static bool operator !=(TextDecorationLineType first, TextDecorationLineType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First operand to check |
| second | TextDecorationLineType | Second operand to check |

##### Return Value

`true` if are unequal, `false` otherwise

### op_Subtraction
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/op_subtraction.md

#### TextDecorationLineType Subtraction operator

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)

```csharp
public static TextDecorationLineType operator -(TextDecorationLineType first, 
    TextDecorationLineType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextDecorationLineType | First line type operand |
| second | TextDecorationLineType | Second line type operand |

##### Return Value

Result of the difference between the first (minuend) and second (subtrahend) operands

### Overline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/overline.md

#### TextDecorationLineType.Overline field

Each line of text has a line above it.

```csharp
public static readonly TextDecorationLineType Overline;
```

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/tostring.md

#### TextDecorationLineType.ToString method

Returns a value of all flags in this instance as text

```csharp
public override string ToString()
```

### TryParse
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/tryparse.md

#### TextDecorationLineType.TryParse method

Tries to parse a specified string and return a valid `TextDecorationLineType` instance

```csharp
public static bool TryParse(string input, out TextDecorationLineType output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | String | Input string |
| output | TextDecorationLineType& | Result. If parsing is invalid, it is a `None` value |

##### Return Value

`true` if parsing was successful, `false` on failure

### Underline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/underline.md

#### TextDecorationLineType.Underline field

Each line of text is underlined.

```csharp
public static readonly TextDecorationLineType Underline;
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.css.properties/textdecorationlinetype/value.md

#### TextDecorationLineType.Value property

Returns a value of all flags in this instance as text

```csharp
public string Value { get; }
```

### GroupDocs.Editor.HtmlCss.Exceptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.exceptions.md

The GroupDocs.Editor.HtmlCss.Exceptions namespace provides classes that are responsible for all HTML-, CSS-, images-, fonts-, and other resource-related processing.

#### 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 unexpected and/or unsupported 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 and/or unsupported format or not an image at all. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### InvalidFontFormatException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.exceptions/invalidfontformatexception.md

#### InvalidFontFormatException class

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 unexpected and/or unsupported format or not a font at all.

```csharp
public class InvalidFontFormatException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidFontFormatException(string) | Creates new instance of `InvalidFontFormatException` with specified error message |
| InvalidFontFormatException(string, Exception) | Creates new instance of `InvalidFontFormatException` with specified error message and a reference to the inner exception that is the cause of this exception |

### InvalidFontFormatException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.exceptions/invalidfontformatexception/invalidfontformatexception.md

#### InvalidFontFormatException(string)

Creates new instance of `InvalidFontFormatException` with specified error message

```csharp
public InvalidFontFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |

#### InvalidFontFormatException(string, Exception)

Creates new instance of `InvalidFontFormatException` with specified error message and a reference to the inner exception that is the cause of this exception

```csharp
public InvalidFontFormatException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |
| innerException | Exception | 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/net/groupdocs.editor.htmlcss.exceptions/invalidimageformatexception.md

#### InvalidImageFormatException class

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 and/or unsupported format or not an image at all.

```csharp
public class InvalidImageFormatException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidImageFormatException(string) | Creates new instance of `InvalidImageFormatException` with specified error message |
| InvalidImageFormatException(string, Exception) | Creates new instance of `InvalidImageFormatException` with specified error message and a reference to the inner exception that is the cause of this exception |

### InvalidImageFormatException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.exceptions/invalidimageformatexception/invalidimageformatexception.md

#### InvalidImageFormatException(string)

Creates new instance of `InvalidImageFormatException` with specified error message

```csharp
public InvalidImageFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |

#### InvalidImageFormatException(string, Exception)

Creates new instance of `InvalidImageFormatException` with specified error message and a reference to the inner exception that is the cause of this exception

```csharp
public InvalidImageFormatException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference if no inner exception is specified. |

### GroupDocs.Editor.HtmlCss.Resources.Audio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio.md

The GroupDocs.Editor.HtmlCss.Resources.Audio namespace provides types that represent audio resources.

#### Classes

| Class | Description |
| --- | --- |
| Mp3Audio | Represents one audio resource of arbitrary format |
#### Structures

| Structure | Description |
| --- | --- |
| AudioType | Represents one supportable audio type (format) |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### AudioType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype.md

#### AudioType structure

Represents one supportable audio type (format)

```csharp
public struct AudioType : IEquatable<AudioType>, IResourceType
```

#### Properties

| Name | Description |
| --- | --- |
| static Mp3 { get; } | Represents a MPEG-1 Audio Layer III audio format |
| static Undefined { get; } | Special value, which marks undefined, unknown or unsupported audio format |
| FileExtension { get; } | Filename extension (without dot character) for this audio format |
| FormalName { get; } | Formal name of this audio format |
| MimeCode { get; } | MIME code for this audio format |

#### Methods

| Name | Description |
| --- | --- |
| static ParseFromFilenameWithExtension(string) | Returns AudioType value, which is equivalent of filename extension, which is extracted from specified filename |
| Equals(AudioType) | Determines whether this instance is equal with specified "AudioType" instance |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "AudioType" instance |
| override GetHashCode() | Returns a hash-code, which is a constant number for this specific value type |
| operator == | Checks whether two "AudioType" values are equal |
| operator != | Checks whether two "AudioType" values are not equal |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/equals.md

#### Equals(AudioType)

Determines whether this instance is equal with specified "AudioType" instance

```csharp
public bool Equals(AudioType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | AudioType | Other AudioType instance to check with this |

##### Return Value

True if are equal, false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "AudioType" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other instance presumably of AudioType struct, that was boxed to System.Object |

##### Return Value

True if are equal, false if are unequal

### FileExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/fileextension.md

#### AudioType.FileExtension property

Filename extension (without dot character) for this audio format

```csharp
public string FileExtension { get; }
```

### FormalName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/formalname.md

#### AudioType.FormalName property

Formal name of this audio format

```csharp
public string FormalName { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/gethashcode.md

#### AudioType.GetHashCode method

Returns a hash-code, which is a constant number for this specific value type

```csharp
public override int GetHashCode()
```

##### Return Value

4-byte signed integer, 0 for Undefined value

### MimeCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/mimecode.md

#### AudioType.MimeCode property

MIME code for this audio format

```csharp
public string MimeCode { get; }
```

### Mp3
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/mp3.md

#### AudioType.Mp3 property

Represents a MPEG-1 Audio Layer III audio format

```csharp
public static AudioType Mp3 { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/op_equality.md

#### AudioType Equality operator

Checks whether two "AudioType" values are equal

```csharp
public static bool operator ==(AudioType first, AudioType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | AudioType | First AudioType to check |
| second | AudioType | Second AudioType to check |

##### Return Value

True if are equal, false if are unequal

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/op_inequality.md

#### AudioType Inequality operator

Checks whether two "AudioType" values are not equal

```csharp
public static bool operator !=(AudioType first, AudioType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | AudioType | First AudioType to check |
| second | AudioType | Second AudioType to check |

##### Return Value

True if are equal, false if are unequal

### ParseFromFilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/parsefromfilenamewithextension.md

#### AudioType.ParseFromFilenameWithExtension method

Returns AudioType value, which is equivalent of filename extension, which is extracted from specified filename

```csharp
public static AudioType ParseFromFilenameWithExtension(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Arbitrary filename, can be a relative or full path |

##### Return Value

AudioType value. Returns AudioType.Undefined, if extension cannot be recognized.

### Undefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/audiotype/undefined.md

#### AudioType.Undefined property

Special value, which marks undefined, unknown or unsupported audio format

```csharp
public static AudioType Undefined { get; }
```

### Mp3Audio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio.md

#### Mp3Audio class

Represents one audio resource of arbitrary format

```csharp
public sealed class Mp3Audio : IEquatable<Mp3Audio>, IHtmlResource
```

#### Constructors

| Name | Description |
| --- | --- |
| Mp3Audio(string, Stream) | Creates new Mp3Audio class from MP3 content, represented as byte stream, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this MP3 content, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this MP3 content is disposed or not |
| Name { get; } | Returns name of this MP3 content. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this MP3 resource as base64-encoded string. This value is cached after first invoke. |
| Type { get; } | Returns a AudioType.Mp3 |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this MP3 resource, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Equals(Mp3Audio) | Checks this instance with specified font resource on reference equality |
| Save(string) | Saves this MP3 resource to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid MP3 content |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this MP3 content is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/bytecontent.md

#### Mp3Audio.ByteContent property

Returns content of this font as byte stream

```csharp
public Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/dispose.md

#### Mp3Audio.Dispose method

Disposes this MP3 resource, disposing its content and making most methods and properties non-working

```csharp
public void Dispose()
```

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/disposed.md

#### Mp3Audio.Disposed event

Event, which occurs when this MP3 content is disposed

```csharp
public event EventHandler Disposed;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/equals.md

#### Equals(IHtmlResource)

Checks this instance with specified HTML resource on reference equality

```csharp
public bool Equals(IHtmlResource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other inheritor of IHtmlResource interface |

##### Return Value

True if are equal, false if are unequal

#### Equals(Mp3Audio)

Checks this instance with specified font resource on reference equality

```csharp
public bool Equals(Mp3Audio other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Mp3Audio | Other instance of Mp3Audio class |

##### Return Value

True if are equal, false if are unequal

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/filenamewithextension.md

#### Mp3Audio.FilenameWithExtension property

Returns correct filename of this MP3 content, which consists of name and extension. Theoretically can differ from the name.

```csharp
public string FilenameWithExtension { get; }
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/isdisposed.md

#### Mp3Audio.IsDisposed property

Determines whether this MP3 content is disposed or not

```csharp
public bool IsDisposed { get; }
```

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/isvalid.md

#### Mp3Audio.IsValid method

Checks whether specified stream is a valid MP3 content

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a MP3 content |

##### Return Value

True if specified stream contains valid MP3 content, false otherwise

### Mp3Audio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/mp3audio.md

#### Mp3Audio constructor

Creates new Mp3Audio class from MP3 content, represented as byte stream, and with specified name

```csharp
public Mp3Audio(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the MP3 content. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/name.md

#### Mp3Audio.Name property

Returns name of this MP3 content. Usually doesn't contain filename extension and theoretically can differ from filename.

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/save.md

#### Mp3Audio.Save method

Saves this MP3 resource to the specified file

```csharp
public void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String | Full path to the file, which will be created or rewritten |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/textcontent.md

#### Mp3Audio.TextContent property

Returns content of this MP3 resource as base64-encoded string. This value is cached after first invoke.

```csharp
public string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.audio/mp3audio/type.md

#### Mp3Audio.Type property

Returns a AudioType.Mp3

```csharp
public AudioType Type { get; }
```

### GroupDocs.Editor.HtmlCss.Resources.Fonts
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts.md

The 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 |
| OtfFont | Represents one font in the OTF (Open Type Format) format |
| TtcFont | Represents one font in the TTC (TrueType Collection) 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 |
#### Structures

| Structure | Description |
| --- | --- |
| FontType | Represents one supportable font type |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### EotFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/eotfont.md

#### EotFont class

Represents one font in the EOT (Embedded OpenType) format

```csharp
public sealed class EotFont : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| EotFont(string, Stream) | Creates new EotFont class from content, represented as byte stream, and with specified name |
| EotFont(string, string) | Creates new EotFont class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns FontType.Eot |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid EOT font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid EOT font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | EOT header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### EotFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/eotfont/eotfont.md

#### EotFont(string, string)

Creates new EotFont class from content, represented as base64-encoded string, and with specified name

```csharp
public EotFont(string eotName, string eotContentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| eotName | String | Name of the EOT font. Cannot be null, empty or whitespaces. |
| eotContentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a EOT content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### EotFont(string, Stream)

Creates new EotFont class from content, represented as byte stream, and with specified name

```csharp
public EotFont(string eotName, Stream eotBinaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| eotName | String | Name of the EOT font. Cannot be null, empty or whitespaces. |
| eotBinaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/eotfont/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid EOT font

```csharp
public static bool IsValid(Stream eotBinaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| eotBinaryContent | Stream | Byte stream, that presumably contains a EOT resource |

##### Return Value

True if specified stream contains valid EOT font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid EOT font

```csharp
public static bool IsValid(string eotContentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| eotContentInBase64 | String | Content of the presumably EOT font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid EOT font, false otherwise

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/eotfont/requiredheadersize.md

#### EotFont.RequiredHeaderSize field

EOT header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/eotfont/type.md

#### EotFont.Type property

Returns FontType.Eot

```csharp
public override FontType Type { get; }
```

### FontResourceBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase.md

#### FontResourceBase class

Base class for any supported font type as a resource for the HTML document with all its properties

```csharp
public abstract class FontResourceBase : IEquatable<FontResourceBase>, IHtmlResource
```

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| abstract Type { get; } | 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 |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/bytecontent.md

#### FontResourceBase.ByteContent property

Returns content of this font as byte stream

```csharp
public Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/dispose.md

#### FontResourceBase.Dispose method

Disposes this font resource, disposing its content and making most methods and properties non-working

```csharp
public void Dispose()
```

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/disposed.md

#### FontResourceBase.Disposed event

Event, which occurs when this font is disposed

```csharp
public event EventHandler Disposed;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/equals.md

#### Equals(IHtmlResource)

Checks this instance with specified HTML resource on reference equality

```csharp
public bool Equals(IHtmlResource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other inheritor of IHtmlResource interface |

##### Return Value

True if are equal, false if are unequal

#### Equals(FontResourceBase)

Checks this instance with specified font resource on reference equality

```csharp
public bool Equals(FontResourceBase other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontResourceBase | Other inheritor of FontResourceBase abstract class |

##### Return Value

True if are equal, false if are unequal

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/filenamewithextension.md

#### FontResourceBase.FilenameWithExtension property

Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name.

```csharp
public string FilenameWithExtension { get; }
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/isdisposed.md

#### FontResourceBase.IsDisposed property

Determines whether this font is disposed or not

```csharp
public bool IsDisposed { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/name.md

#### FontResourceBase.Name property

Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename.

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/save.md

#### FontResourceBase.Save method

Saves this font to the specified file

```csharp
public void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String | Full path to the file, which will be created or rewritten |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/textcontent.md

#### FontResourceBase.TextContent property

Returns content of this font as base64-encoded string. This value is cached after first invoke.

```csharp
public string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fontresourcebase/type.md

#### FontResourceBase.Type property

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

```csharp
public abstract FontType Type { get; }
```

### FontType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype.md

#### FontType structure

Represents one supportable font type

```csharp
public struct FontType : IEquatable<FontType>, IResourceType
```

#### Properties

| Name | Description |
| --- | --- |
| static Eot { get; } | Represents a EOT (Embedded OpenType) font type |
| static Otf { get; } | Represents a OTF (OpenType Font) font type |
| static Ttc { get; } | Represents a TrueType Collection (TTC) font |
| static Ttf { get; } | Represents a TTF (TrueType Font) font type |
| static Undefined { get; } | Special value, which marks undefined, unknown or unsupported font resource |
| static Woff { get; } | Represents a WOFF (Web Open Font Format) font type |
| static Woff2 { get; } | Represents a WOFF2 (Web Open Font Format version 2) font type |
| CssName { get; } | Returns CSS-compatible name of this font type, which is used in the @font-face at-rule |
| FileExtension { get; } | Filename extension (without dot character) for this font type |
| FontFormat { get; } | Font format for @font-face format |
| FormalName { get; } | Returns a formal name of this font type |
| MimeCode { get; } | MIME code of a particular font type |

#### Methods

| Name | Description |
| --- | --- |
| static GetFirstDefined(params FontType[]) | Returns a first font type from specified set, which is not an "Undefined" value, or "Undefined" font type otherwise (when all items are "Undefined") |
| static ParseFromCssName(string) | Returns FontType value, which is equivalent of specified CSS-compatible name of the font type |
| static ParseFromFilenameWithExtension(string) | Returns FontType value, which is equivalent of filename extension, which is extracted from specified filename |
| static ParseFromMime(string) | Returns FontType value, which is equivalent of specified MIME-code |
| Equals(FontType) | Determines whether this instance is equal with specified "FontType" instance |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "FontType" instance |
| override GetHashCode() | Returns a hash-code, which is a constant number for this specific value type |
| operator == | Checks whether two "FontType" values are equal |
| operator != | Checks whether two "FontType" values are not equal |

### CssName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/cssname.md

#### FontType.CssName property

Returns CSS-compatible name of this font type, which is used in the @font-face at-rule

```csharp
public string CssName { get; }
```

### Eot
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/eot.md

#### FontType.Eot property

Represents a EOT (Embedded OpenType) font type

```csharp
public static FontType Eot { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/equals.md

#### Equals(FontType)

Determines whether this instance is equal with specified "FontType" instance

```csharp
public bool Equals(FontType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontType | Other FontType instance to check with this |

##### Return Value

True if are equal, false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "FontType" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other instance presumably of FontType struct, that was boxed to System.Object |

##### Return Value

True if are equal, false if are unequal

### FileExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/fileextension.md

#### FontType.FileExtension property

Filename extension (without dot character) for this font type

```csharp
public string FileExtension { get; }
```

### FontFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/fontformat.md

#### FontType.FontFormat property

Font format for @font-face format

```csharp
public string FontFormat { get; }
```

### FormalName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/formalname.md

#### FontType.FormalName property

Returns a formal name of this font type

```csharp
public string FormalName { get; }
```

### GetFirstDefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/getfirstdefined.md

#### FontType.GetFirstDefined method

Returns a first font type from specified set, which is not an "Undefined" value, or "Undefined" font type otherwise (when all items are "Undefined")

```csharp
public static FontType GetFirstDefined(params FontType[] fonts)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fonts | FontType[] | One or more FontType values, NULL or empty collection is not allowed |

##### Return Value

First FontType value from specified collection, that is not Undefined, or Undefined, if all items are Undefined

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/gethashcode.md

#### FontType.GetHashCode method

Returns a hash-code, which is a constant number for this specific value type

```csharp
public override int GetHashCode()
```

##### Return Value

4-byte signed integer, 0 for Undefined value

### MimeCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/mimecode.md

#### FontType.MimeCode property

MIME code of a particular font type

```csharp
public string MimeCode { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/op_equality.md

#### FontType Equality operator

Checks whether two "FontType" values are equal

```csharp
public static bool operator ==(FontType first, FontType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontType | First FontType to check |
| second | FontType | Second FontType to check |

##### Return Value

True if are equal, false if are unequal

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/op_inequality.md

#### FontType Inequality operator

Checks whether two "FontType" values are not equal

```csharp
public static bool operator !=(FontType first, FontType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontType | First FontType to check |
| second | FontType | Second FontType to check |

##### Return Value

True if are equal, false if are unequal

### Otf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/otf.md

#### FontType.Otf property

Represents a OTF (OpenType Font) font type

```csharp
public static FontType Otf { get; }
```

### ParseFromCssName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/parsefromcssname.md

#### FontType.ParseFromCssName method

Returns FontType value, which is equivalent of specified CSS-compatible name of the font type

```csharp
public static FontType ParseFromCssName(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | CSS-compatible name of the font type |

##### Return Value

Valid FontType value on success or FontType.Undefined on failure

### ParseFromFilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/parsefromfilenamewithextension.md

#### FontType.ParseFromFilenameWithExtension method

Returns FontType value, which is equivalent of filename extension, which is extracted from specified filename

```csharp
public static FontType ParseFromFilenameWithExtension(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Filename with extension, may be a full name |

##### Return Value

Valid FontType value on success or FontType.Undefined on failure

### ParseFromMime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/parsefrommime.md

#### FontType.ParseFromMime method

Returns FontType value, which is equivalent of specified MIME-code

```csharp
public static FontType ParseFromMime(string mimeCode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | String | MIME-code |

##### Return Value

Valid FontType value on success or FontType.Undefined on failure

### Ttc
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/ttc.md

#### FontType.Ttc property

Represents a TrueType Collection (TTC) font

```csharp
public static FontType Ttc { get; }
```

### Ttf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/ttf.md

#### FontType.Ttf property

Represents a TTF (TrueType Font) font type

```csharp
public static FontType Ttf { get; }
```

### Undefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/undefined.md

#### FontType.Undefined property

Special value, which marks undefined, unknown or unsupported font resource

```csharp
public static FontType Undefined { get; }
```

### Woff
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/woff.md

#### FontType.Woff property

Represents a WOFF (Web Open Font Format) font type

```csharp
public static FontType Woff { get; }
```

### Woff2
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/fonttype/woff2.md

#### FontType.Woff2 property

Represents a WOFF2 (Web Open Font Format version 2) font type

```csharp
public static FontType Woff2 { get; }
```

### OtfFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/otffont.md

#### OtfFont class

Represents one font in the OTF (Open Type Format) format

```csharp
public sealed class OtfFont : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| OtfFont(string, Stream) | Creates new OtfFont class from content, represented as byte stream, and with specified name |
| OtfFont(string, string) | Creates new OtfFont class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns `Otf` |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid OTF font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid OTF font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | OTF header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/otffont/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid OTF font

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a OTF resource |

##### Return Value

True if specified stream contains valid OTF font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid OTF font

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably OTF font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid OTF font, false otherwise

### OtfFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/otffont/otffont.md

#### OtfFont(string, string)

Creates new OtfFont class from content, represented as base64-encoded string, and with specified name

```csharp
public OtfFont(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the OTF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a OTF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### OtfFont(string, Stream)

Creates new OtfFont class from content, represented as byte stream, and with specified name

```csharp
public OtfFont(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the OTF font. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/otffont/requiredheadersize.md

#### OtfFont.RequiredHeaderSize field

OTF header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/otffont/type.md

#### OtfFont.Type property

Returns `Otf`

```csharp
public override FontType Type { get; }
```

### TtcFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont.md

#### TtcFont class

Represents one font in the TTC (TrueType Collection) format

```csharp
public sealed class TtcFont : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| TtcFont(string, Stream) | Creates new TtcFont class from content, represented as byte stream, and with specified name |
| TtcFont(string, string) | Creates new TtcFont class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| FontsNumber { get; } | Number of fonts in this TTC |
| HasDsigTable { get; } | Indicates whether this TTC has a DSIG table exists. DSIG table may be present only if TTC has a Header version 2.0. |
| HeaderVersion { get; } | TTC Header Version, may be "1" or "2" |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns FontType.Ttc |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid TTC font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid TTF font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | TTC header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

##### Remarks

See more: https://docs.fileformat.com/font/ttc/

### FontsNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/fontsnumber.md

#### TtcFont.FontsNumber property

Number of fonts in this TTC

```csharp
public uint FontsNumber { get; }
```

### HasDsigTable
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/hasdsigtable.md

#### TtcFont.HasDsigTable property

Indicates whether this TTC has a DSIG table exists. DSIG table may be present only if TTC has a Header version 2.0.

```csharp
public bool HasDsigTable { get; }
```

### HeaderVersion
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/headerversion.md

#### TtcFont.HeaderVersion property

TTC Header Version, may be "1" or "2"

```csharp
public byte HeaderVersion { get; }
```

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid TTC font

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a TTC resource |

##### Return Value

True if specified stream contains valid TTC font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid TTF font

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably TTF font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid TTF font, false otherwise

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/requiredheadersize.md

#### TtcFont.RequiredHeaderSize field

TTC header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### TtcFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/ttcfont.md

#### TtcFont(string, string)

Creates new TtcFont class from content, represented as base64-encoded string, and with specified name

```csharp
public TtcFont(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the TTC font. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a TTC content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Any of input strings are `null`, empty or whitespace-only |
| InvalidImageFormatException | Content in *contentInBase64* argument cannot be recognized a valid TTC font |

#### TtcFont(string, Stream)

Creates new TtcFont class from content, represented as byte stream, and with specified name

```csharp
public TtcFont(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the TTC font. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | *name* argument is `null`, empty or whitespace-only |
| InvalidFontFormatException | Thrown when specified binary content cannot be properly interpreted as a valid TTF font |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttcfont/type.md

#### TtcFont.Type property

Returns FontType.Ttc

```csharp
public override FontType Type { get; }
```

### TtfFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttffont.md

#### TtfFont class

Represents one font in the TTF (TrueType Font) format

```csharp
public sealed class TtfFont : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| TtfFont(string, Stream) | Creates new TtfFont class from content, represented as byte stream, and with specified name |
| TtfFont(string, string) | Creates new TtfFont class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns FontType.Ttf |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid TTF font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid TTF font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | TTF header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttffont/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid TTF font

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a TTF resource |

##### Return Value

True if specified stream contains valid TTF font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid TTF font

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably TTF font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid TTF font, false otherwise

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttffont/requiredheadersize.md

#### TtfFont.RequiredHeaderSize field

TTF header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### TtfFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttffont/ttffont.md

#### TtfFont(string, string)

Creates new TtfFont class from content, represented as base64-encoded string, and with specified name

```csharp
public TtfFont(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the TTF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a TTF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### TtfFont(string, Stream)

Creates new TtfFont class from content, represented as byte stream, and with specified name

```csharp
public TtfFont(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the TTF font. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidFontFormatException | Thrown when specified binary content cannot be properly interpreted as a valid TTF font |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/ttffont/type.md

#### TtfFont.Type property

Returns FontType.Ttf

```csharp
public override FontType Type { get; }
```

### Woff2Font
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/woff2font.md

#### Woff2Font class

Represents one font in the WOFF2 (Web Open Font Format) format

```csharp
public sealed class Woff2Font : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| Woff2Font(string, Stream) | Creates new Woff2Font class from content, represented as byte stream, and with specified name |
| Woff2Font(string, string) | Creates new Woff2Font class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns FontType.Woff2 |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid WOFF2 font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid WOFF2 font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | WOFF2 header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/woff2font/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid WOFF2 font

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a WOFF2 resource |

##### Return Value

True if specified stream contains valid WOFF2 font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid WOFF2 font

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably WOFF2 font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid WOFF2 font, false otherwise

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/woff2font/requiredheadersize.md

#### Woff2Font.RequiredHeaderSize field

WOFF2 header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/woff2font/type.md

#### Woff2Font.Type property

Returns FontType.Woff2

```csharp
public override FontType Type { get; }
```

### Woff2Font
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/woff2font/woff2font.md

#### Woff2Font(string, string)

Creates new Woff2Font class from content, represented as base64-encoded string, and with specified name

```csharp
public Woff2Font(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WOFF2 font. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WOFF2 content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### Woff2Font(string, Stream)

Creates new Woff2Font class from content, represented as byte stream, and with specified name

```csharp
public Woff2Font(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WOFF2 font. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### WoffFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/wofffont.md

#### WoffFont class

Represents one font in the WOFF (Web Open Font Format) format

```csharp
public sealed class WoffFont : FontResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| WoffFont(string, Stream) | Creates new WoffFont class from content, represented as byte stream, and with specified name |
| WoffFont(string, string) | Creates new WoffFont class from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this font as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this font resource, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this font is disposed or not |
| Name { get; } | Returns name of this font resource. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this font as base64-encoded string. This value is cached after first invoke. |
| override Type { get; } | Returns FontType.Woff |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this font resource, disposing its content and making most methods and properties non-working |
| Equals(FontResourceBase) | Checks this instance with specified font resource on reference equality |
| Equals(IHtmlResource) | Checks this instance with specified HTML resource on reference equality |
| Save(string) | Saves this font to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid WOFF font |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid WOFF font |

#### Fields

| Name | Description |
| --- | --- |
| const RequiredHeaderSize | WOFF header size (in bytes), which is required for its validation |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this font is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/wofffont/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid WOFF font

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a WOFF resource |

##### Return Value

True if specified stream contains valid WOFF font, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid WOFF font

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably WOFF font in a form of base64-encoded string |

##### Return Value

True if specified string contains valid WOFF font, false otherwise

### RequiredHeaderSize
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/wofffont/requiredheadersize.md

#### WoffFont.RequiredHeaderSize field

WOFF header size (in bytes), which is required for its validation

```csharp
public const int RequiredHeaderSize;
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/wofffont/type.md

#### WoffFont.Type property

Returns FontType.Woff

```csharp
public override FontType Type { get; }
```

### WoffFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.fonts/wofffont/wofffont.md

#### WoffFont(string, string)

Creates new WoffFont class from content, represented as base64-encoded string, and with specified name

```csharp
public WoffFont(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WOFF font. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WOFF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### WoffFont(string, Stream)

Creates new WoffFont class from content, represented as byte stream, and with specified name

```csharp
public WoffFont(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WOFF font. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### GroupDocs.Editor.HtmlCss.Resources.Images.Raster
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster.md

The 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 |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### BmpImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/bmpimage.md

#### BmpImage class

Represents one image in BMP (BitMap Picture) format with its metadata and additional methods

```csharp
public sealed class BmpImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| BmpImage(string, Stream) | Creates new BmpImage instance from content, represented as byte stream, and with specified name |
| BmpImage(string, string) | Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns ImageType.Bmp |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid BMP image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid BMP image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### BmpImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/bmpimage/bmpimage.md

#### BmpImage(string, string)

Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public BmpImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the BMP image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a BMP content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### BmpImage(string, Stream)

Creates new BmpImage instance from content, represented as byte stream, and with specified name

```csharp
public BmpImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the BMP image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/bmpimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid BMP image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a BMP image |

##### Return Value

True if specified stream contains valid BMP image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid BMP image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably BMP image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid BMP image, false otherwise

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/bmpimage/type.md

#### BmpImage.Type property

Returns ImageType.Bmp

```csharp
public override ImageType Type { get; }
```

### GifImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/gifimage.md

#### GifImage class

Represents one image in GIF (Graphics Interchange Format) format with its metadata and additional methods

```csharp
public sealed class GifImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| GifImage(string, Stream) | Creates new GifImage instance from content, represented as byte stream, and with specified name |
| GifImage(string, string) | Creates new GifImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns ImageType.Gif |
| Version { get; } | Returns internal version of this GIF image (version is extracted from header) |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid GIF image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid GIF image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### GifImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/gifimage/gifimage.md

#### GifImage(string, string)

Creates new GifImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public GifImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a GIF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### GifImage(string, Stream)

Creates new GifImage instance from content, represented as byte stream, and with specified name

```csharp
public GifImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/gifimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid GIF image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a GIF image |

##### Return Value

True if specified stream contains valid GIF image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid GIF image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably GIF image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid GIF image, false otherwise

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/gifimage/type.md

#### GifImage.Type property

Returns ImageType.Gif

```csharp
public override ImageType Type { get; }
```

### Version
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/gifimage/version.md

#### GifImage.Version property

Returns internal version of this GIF image (version is extracted from header)

```csharp
public string Version { get; }
```

### IconImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/iconimage.md

#### IconImage class

Represents one image in ICON format with its metadata and additional methods

```csharp
public sealed class IconImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| IconImage(string, Stream) | Creates new IconImage instance from content, represented as byte stream, and with specified name |
| IconImage(string, string) | Creates new IconImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| NumberOfImages { get; } | Returns number of images, which are present in this ICON file |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns ImageType.Icon |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid ICON image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid ICON image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### IconImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/iconimage/iconimage.md

#### IconImage(string, string)

Creates new IconImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public IconImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the ICON image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a ICON content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### IconImage(string, Stream)

Creates new IconImage instance from content, represented as byte stream, and with specified name

```csharp
public IconImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the ICON image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/iconimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid ICON image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a ICON image |

##### Return Value

True if specified stream contains valid ICON image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid ICON image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably ICON image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid ICON image, false otherwise

### NumberOfImages
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/iconimage/numberofimages.md

#### IconImage.NumberOfImages property

Returns number of images, which are present in this ICON file

```csharp
public ushort NumberOfImages { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/iconimage/type.md

#### IconImage.Type property

Returns ImageType.Icon

```csharp
public override ImageType Type { get; }
```

### JpegImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/jpegimage.md

#### JpegImage class

Represents one image in JPEG (Joint Photographic Experts Group) format with its metadata and additional methods

```csharp
public sealed class JpegImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| JpegImage(string, Stream) | Creates new JpegImage instance from content, represented as byte stream, and with specified name |
| JpegImage(string, string) | Creates new JpegImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns ImageType.Jpeg |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid JPEG image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid JPEG image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/jpegimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid JPEG image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a JPEG image |

##### Return Value

True if specified stream contains valid JPEG image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid JPEG image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably JPEG image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid JPEG image, false otherwise

### JpegImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/jpegimage/jpegimage.md

#### JpegImage(string, string)

Creates new JpegImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public JpegImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the JPEG image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a JPEG content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### JpegImage(string, Stream)

Creates new JpegImage instance from content, represented as byte stream, and with specified name

```csharp
public JpegImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the JPEG image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/jpegimage/type.md

#### JpegImage.Type property

Returns ImageType.Jpeg

```csharp
public override ImageType Type { get; }
```

### PngImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/pngimage.md

#### PngImage class

Represents one image in PNG (Portable Network Graphics) format with its metadata and additional methods

```csharp
public sealed class PngImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| PngImage(string, Stream) | Creates new PngImage instance from content, represented as byte stream, and with specified name |
| PngImage(string, string) | Creates new PngImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns ImageType.Png |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid PNG image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid PNG image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/pngimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid PNG image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a PNG image |

##### Return Value

True if specified stream contains valid PNG image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid PNG image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably PNG image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid PNG image, false otherwise

### PngImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/pngimage/pngimage.md

#### PngImage(string, string)

Creates new PngImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public PngImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the PNG image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a PNG content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### PngImage(string, Stream)

Creates new PngImage instance from content, represented as byte stream, and with specified name

```csharp
public PngImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the PNG image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/pngimage/type.md

#### PngImage.Type property

Returns ImageType.Png

```csharp
public override ImageType Type { get; }
```

### RasterImageResourceBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase.md

#### RasterImageResourceBase class

Base class for any supported raster image with fixed name, dimensions, aspect ratio, type, size, and content.

```csharp
public abstract class RasterImageResourceBase : IImageResource
```

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| abstract Type { get; } | In implementing type should return information about type of the raster image |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### AspectRatio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/aspectratio.md

#### RasterImageResourceBase.AspectRatio property

Returns an aspect ratio of this image as the width-to-height relation

```csharp
public Ratio AspectRatio { get; }
```

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/bytecontent.md

#### RasterImageResourceBase.ByteContent property

Returns content of this raster image as byte stream

```csharp
public Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/dispose.md

#### RasterImageResourceBase.Dispose method

Disposes this raster image, disposing its content and making most methods and properties non-working

```csharp
public void Dispose()
```

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/disposed.md

#### RasterImageResourceBase.Disposed event

Event, which occurs when this raster image is disposed

```csharp
public event EventHandler Disposed;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/equals.md

#### RasterImageResourceBase.Equals method

Checks this instance with specified on reference equality.

```csharp
public bool Equals(IHtmlResource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other IHtmlResource inheritor |

##### Return Value

True if are equal, false if are unequal

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/filenamewithextension.md

#### RasterImageResourceBase.FilenameWithExtension property

Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name.

```csharp
public string FilenameWithExtension { get; }
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/isdisposed.md

#### RasterImageResourceBase.IsDisposed property

Determines whether this raster image is disposed or not

```csharp
public bool IsDisposed { get; }
```

### Length
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/length.md

#### RasterImageResourceBase.Length property

Returns the length of this raster image file in bytes

```csharp
public int Length { get; }
```

### LinearDimensions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/lineardimensions.md

#### RasterImageResourceBase.LinearDimensions property

Returns linear dimensions of this raster image (width and height)

```csharp
public Dimensions LinearDimensions { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/name.md

#### RasterImageResourceBase.Name property

Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename.

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/save.md

#### RasterImageResourceBase.Save method

Saves this raster image to the specified file

```csharp
public void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String | Full path to the file, which will be created or rewritten |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/textcontent.md

#### RasterImageResourceBase.TextContent property

Returns content of this raster image as base64-encoded string

```csharp
public string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/rasterimageresourcebase/type.md

#### RasterImageResourceBase.Type property

In implementing type should return information about type of the raster image

```csharp
public abstract ImageType Type { get; }
```

### TiffImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/tiffimage.md

#### TiffImage class

Represents one image in TIFF (Tagged Image File Format) format with its metadata and additional methods

```csharp
public sealed class TiffImage : RasterImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffImage(string, Stream) | Creates new GifImage instance from content, represented as byte stream, and with specified name |
| TiffImage(string, string) | Creates new TiffImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns an aspect ratio of this image as the width-to-height relation |
| ByteContent { get; } | Returns content of this raster image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed or not |
| Length { get; } | Returns the length of this raster image file in bytes |
| LinearDimensions { get; } | Returns linear dimensions of this raster image (width and height) |
| Name { get; } | Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| TextContent { get; } | Returns content of this raster image as base64-encoded string |
| override Type { get; } | Returns `Tiff` |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| Save(string) | Saves this raster image to the specified file |
| static IsValid(Stream) | Checks whether specified stream is a valid TIFF image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid TIFF image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

##### Remarks

See https://en.wikipedia.org/wiki/TIFF for details. In very rare cases TIFF is present inside WordProcessing documents.

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/tiffimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid TIFF image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Byte stream, that presumably contains a TIFF image |

##### Return Value

True if specified stream contains valid TIFF image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid TIFF image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Content of the presumably TIFF image in a form of base64-encoded string |

##### Return Value

True if specified string contains valid TIFF image, false otherwise

### TiffImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/tiffimage/tiffimage.md

#### TiffImage(string, string)

Creates new TiffImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public TiffImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the TIFF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a TIFF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### TiffImage(string, Stream)

Creates new GifImage instance from content, represented as byte stream, and with specified name

```csharp
public TiffImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the GIF image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.raster/tiffimage/type.md

#### TiffImage.Type property

Returns `Tiff`

```csharp
public override ImageType Type { get; }
```

### GroupDocs.Editor.HtmlCss.Resources.Images.Vector
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector.md

The 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 (dimensions) and additional methods (saving to PNG) |
| VectorImageResourceBase | Base class for any supported vector image |
| WmfImage | Represents one vector image in WMF (Windows MetaFile) format with its metadata and additional methods |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### EmfImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage.md

#### EmfImage class

Represents one vector image in Enhanced metafile format (EMF) format with its metadata and additional methods

```csharp
public sealed class EmfImage : MetaImageBase
```

#### Constructors

| Name | Description |
| --- | --- |
| EmfImage(string, Stream) | Creates new EmfImage instance from content, represented as byte stream, and with specified name |
| EmfImage(string, string) | Creates new EmfImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns aspect ratio of this vector image |
| override ByteContent { get; } | Returns a content of this EMF image as a binary stream |
| FilenameWithExtension { get; } | Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed (`true`) or not (`false`) |
| LinearDimensions { get; } | Returns linear dimensions of this vector image (width and height) |
| Name { get; } | Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| override TextContent { get; } | Returns a content of this EMF image as a plain text |
| override Type { get; } | Returns ImageType.Emf |

#### Methods

| Name | Description |
| --- | --- |
| override Dispose() | Disposes this EMF image by disposing its content and making most its methods and properties non-working. |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| override Save(string) | Saves this EMF image to the file |
| override SaveToPng(Stream) | Saves this vector EMF image into raster PNG image |
| override SaveToSvg(Stream) | Saves this vector EMF image into vector SVG image |
| static IsValid(Stream) | Checks whether specified stream is a valid EMF image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid EMF image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/bytecontent.md

#### EmfImage.ByteContent property

Returns a content of this EMF image as a binary stream

```csharp
public override Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/dispose.md

#### EmfImage.Dispose method

Disposes this EMF image by disposing its content and making most its methods and properties non-working.

```csharp
public override void Dispose()
```

### EmfImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/emfimage.md

#### EmfImage(string, string)

Creates new EmfImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public EmfImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the EMF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a EMF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### EmfImage(string, Stream)

Creates new EmfImage instance from content, represented as byte stream, and with specified name

```csharp
public EmfImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the EMF image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid EMF image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Input byte stream. Cannot be NULL, should support reading and seeking. |

##### Return Value

True if specified stream holds a valid EMF image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid EMF image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Input string, where content of EMF image is stored in base64 encoding. Cannot be NULL or empty. |

##### Return Value

True if specified string holds a valid EMF image, false otherwise

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/save.md

#### EmfImage.Save method

Saves this EMF image to the file

```csharp
public override void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | 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
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/savetopng.md

#### EmfImage.SaveToPng method

Saves this vector EMF image into raster PNG image

```csharp
public override void SaveToPng(Stream outputPngContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | Stream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

### SaveToSvg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/savetosvg.md

#### EmfImage.SaveToSvg method

Saves this vector EMF image into vector SVG image

```csharp
public override void SaveToSvg(Stream outputSvgContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | Stream | Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable. |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/textcontent.md

#### EmfImage.TextContent property

Returns a content of this EMF image as a plain text

```csharp
public override string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/emfimage/type.md

#### EmfImage.Type property

Returns ImageType.Emf

```csharp
public override ImageType Type { get; }
```

### MetaImageBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/metaimagebase.md

#### MetaImageBase class

Base abstract class for WMF and EMF image formats

```csharp
public abstract class MetaImageBase : VectorImageResourceBase
```

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns aspect ratio of this vector image |
| abstract ByteContent { get; } | In implementing type should return a content of this vector image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed (`true`) or not (`false`) |
| LinearDimensions { get; } | Returns linear dimensions of this vector image (width and height) |
| Name { get; } | Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| abstract TextContent { get; } | In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type |
| abstract Type { get; } | In implementing type should return information about type of the vector image |

#### Methods

| Name | Description |
| --- | --- |
| abstract Dispose() | In implementing type should dispose this instance |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| abstract Save(string) | In implementing type should save this image to the disk by specified path |
| abstract SaveToPng(Stream) | In implementing type should save a current vector image to the raster PNG format into specified byte stream |
| abstract SaveToSvg(Stream) | In implementing WMF or EMF type should save a current vector meta-image to the vector SVG format to the specified byte stream |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

##### Remarks

This abstract class is inherited by `WmfImage` and `EmfImage`

### SaveToSvg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/metaimagebase/savetosvg.md

#### MetaImageBase.SaveToSvg method

In implementing WMF or EMF type should save a current vector meta-image to the vector SVG format to the specified byte stream

```csharp
public abstract void SaveToSvg(Stream outputSvgContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | Stream | 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/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage.md

#### SvgImage class

Represents one vector image in SVG (Scalable Vector Graphics) format with its metadata (dimensions) and additional methods (saving to PNG)

```csharp
public sealed class SvgImage : VectorImageResourceBase
```

#### Constructors

| Name | Description |
| --- | --- |
| SvgImage(string, Stream) | Creates new SvgImage instance from content, represented as byte stream, and with specified name |
| SvgImage(string, string) | Creates new SvgImage instance from content, represented as usual string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns aspect ratio of this vector image |
| override ByteContent { get; } | Returns a content of this SVG image as a binary stream with original position |
| FilenameWithExtension { get; } | Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed (`true`) or not (`false`) |
| LinearDimensions { get; } | Returns linear dimensions of this vector image (width and height) |
| Name { get; } | Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| override TextContent { get; } | Returns a content of this SVG image as a base64-encoded binary content (not as a raw text in XML format) |
| override Type { get; } | Returns `Svg` |
| XmlContent { get; } | Returns a content of this SVG image in its original XML-compliant textual form |

#### Methods

| Name | Description |
| --- | --- |
| override Dispose() | Disposes this raster image, disposing its content and making most methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| override Save(string) | Saves this SVG image to the file |
| override SaveToPng(Stream) | Saves this vector SVG image into raster PNG image |
| static IsValid(string) | Performs a surface check whether specified textual XML-compliant content represents a SVG image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/bytecontent.md

#### SvgImage.ByteContent property

Returns a content of this SVG image as a binary stream with original position

```csharp
public override Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/dispose.md

#### SvgImage.Dispose method

Disposes this raster image, disposing its content and making most methods and properties non-working

```csharp
public override void Dispose()
```

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/isvalid.md

#### SvgImage.IsValid method

Performs a surface check whether specified textual XML-compliant content represents a SVG image

```csharp
public static bool IsValid(string content)
```

| Parameter | Type | Description |
| --- | --- | --- |
| content | String | XML content of an SVG image as simple text, not a base64-encoded content |

##### Return Value

True if specified string can be treated as valid SVG at first look, false if it is not SVG for sure

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/save.md

#### SvgImage.Save method

Saves this SVG image to the file

```csharp
public override void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | 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 |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when specified file path is invalid |
| ObjectDisposedException | Thrown when this instance was already disposed |

### SaveToPng
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/savetopng.md

#### SvgImage.SaveToPng method

Saves this vector SVG image into raster PNG image

```csharp
public override void SaveToPng(Stream outputPngContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | Stream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

### SvgImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/svgimage.md

#### SvgImage(string, string)

Creates new SvgImage instance from content, represented as usual string, and with specified name

```csharp
public SvgImage(string name, string content)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the SVG image. Cannot be null, empty or whitespaces. |
| content | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Some of parameters are invalid |
| InvalidImageFormatException | *content* argument contains invalid SVG content |

#### SvgImage(string, Stream)

Creates new SvgImage instance from content, represented as byte stream, and with specified name

```csharp
public SvgImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the SVG image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/textcontent.md

#### SvgImage.TextContent property

Returns a content of this SVG image as a base64-encoded binary content (not as a raw text in XML format)

```csharp
public override string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/type.md

#### SvgImage.Type property

Returns `Svg`

```csharp
public override ImageType Type { get; }
```

### XmlContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/svgimage/xmlcontent.md

#### SvgImage.XmlContent property

Returns a content of this SVG image in its original XML-compliant textual form

```csharp
public string XmlContent { get; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| ObjectDisposedException | Thrown when this instance was already disposed |

### VectorImageResourceBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase.md

#### VectorImageResourceBase class

Base class for any supported vector image

```csharp
public abstract class VectorImageResourceBase : IImageResource
```

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns aspect ratio of this vector image |
| abstract ByteContent { get; } | In implementing type should return a content of this vector image as byte stream |
| FilenameWithExtension { get; } | Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed (`true`) or not (`false`) |
| LinearDimensions { get; } | Returns linear dimensions of this vector image (width and height) |
| Name { get; } | Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| abstract TextContent { get; } | In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type |
| abstract Type { get; } | In implementing type should return information about type of the vector image |

#### Methods

| Name | Description |
| --- | --- |
| abstract Dispose() | In implementing type should dispose this instance |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| abstract Save(string) | In implementing type should save this image to the disk by specified path |
| abstract SaveToPng(Stream) | In implementing type should save a current vector image to the raster PNG format into specified byte stream |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### AspectRatio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/aspectratio.md

#### VectorImageResourceBase.AspectRatio property

Returns aspect ratio of this vector image

```csharp
public Ratio AspectRatio { get; }
```

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/bytecontent.md

#### VectorImageResourceBase.ByteContent property

In implementing type should return a content of this vector image as byte stream

```csharp
public abstract Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/dispose.md

#### VectorImageResourceBase.Dispose method

In implementing type should dispose this instance

```csharp
public abstract void Dispose()
```

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/disposed.md

#### VectorImageResourceBase.Disposed event

Event, which occurs when this raster image is disposed

```csharp
public event EventHandler Disposed;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/equals.md

#### VectorImageResourceBase.Equals method

Checks this instance with specified on reference equality.

```csharp
public bool Equals(IHtmlResource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other instance of vector image |

##### Return Value

True if are equal, false if are unequal

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/filenamewithextension.md

#### VectorImageResourceBase.FilenameWithExtension property

Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name.

```csharp
public string FilenameWithExtension { get; }
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/isdisposed.md

#### VectorImageResourceBase.IsDisposed property

Determines whether this raster image is disposed (`true`) or not (`false`)

```csharp
public bool IsDisposed { get; }
```

### LinearDimensions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/lineardimensions.md

#### VectorImageResourceBase.LinearDimensions property

Returns linear dimensions of this vector image (width and height)

```csharp
public Dimensions LinearDimensions { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/name.md

#### VectorImageResourceBase.Name property

Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename.

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/save.md

#### VectorImageResourceBase.Save method

In implementing type should save this image to the disk by specified path

```csharp
public abstract void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String |  |

### SaveToPng
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/savetopng.md

#### VectorImageResourceBase.SaveToPng method

In implementing type should save a current vector image to the raster PNG format into specified byte stream

```csharp
public abstract void SaveToPng(Stream outputPngContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | Stream | Byte stream, into which the PNG version of this raster image will be stored. Should not be NULL and should support writing. |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/textcontent.md

#### VectorImageResourceBase.TextContent property

In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type

```csharp
public abstract string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/vectorimageresourcebase/type.md

#### VectorImageResourceBase.Type property

In implementing type should return information about type of the vector image

```csharp
public abstract ImageType Type { get; }
```

### WmfImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage.md

#### WmfImage class

Represents one vector image in WMF (Windows MetaFile) format with its metadata and additional methods

```csharp
public sealed class WmfImage : MetaImageBase
```

#### Constructors

| Name | Description |
| --- | --- |
| WmfImage(string, Stream) | Creates new WmfImage instance from content, represented as byte stream, and with specified name |
| WmfImage(string, string) | Creates new WmfImage instance from content, represented as base64-encoded string, and with specified name |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Returns aspect ratio of this vector image |
| override ByteContent { get; } | Returns a content of this WMF image as a binary stream |
| FilenameWithExtension { get; } | Returns correct filename of this vector image, which consists of name and extension. Theoretically can differ from the name. |
| IsDisposed { get; } | Determines whether this raster image is disposed (`true`) or not (`false`) |
| LinearDimensions { get; } | Returns linear dimensions of this vector image (width and height) |
| Name { get; } | Returns name of this vector image. Usually doesn't contain filename extension and theoretically can differ from filename. |
| override TextContent { get; } | Returns a content of this WMF image as a plain text |
| override Type { get; } | Returns ImageType.Wmf |

#### Methods

| Name | Description |
| --- | --- |
| override Dispose() | Disposes this WMF image by disposing its content and making most its methods and properties non-working |
| Equals(IHtmlResource) | Checks this instance with specified on reference equality. |
| override Save(string) | Saves this WMF image to the file |
| override SaveToPng(Stream) | Saves this vector WMF image into raster PNG image |
| override SaveToSvg(Stream) | Saves this vector WMF image into vector SVG image |
| static IsValid(Stream) | Checks whether specified stream is a valid WMF image |
| static IsValid(string) | Checks whether specified base64-encoded string is a valid WMF image |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this raster image is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/bytecontent.md

#### WmfImage.ByteContent property

Returns a content of this WMF image as a binary stream

```csharp
public override Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/dispose.md

#### WmfImage.Dispose method

Disposes this WMF image by disposing its content and making most its methods and properties non-working

```csharp
public override void Dispose()
```

### IsValid
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/isvalid.md

#### IsValid(Stream)

Checks whether specified stream is a valid WMF image

```csharp
public static bool IsValid(Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| binaryContent | Stream | Input byte stream. Cannot be NULL, should support reading and seeking. |

##### Return Value

True if specified stream holds a valid WMF image, false otherwise

#### IsValid(string)

Checks whether specified base64-encoded string is a valid WMF image

```csharp
public static bool IsValid(string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contentInBase64 | String | Input string, where content of WMF image is stored in base64 encoding. Cannot be NULL or empty. |

##### Return Value

True if specified string holds a valid WMF image, false otherwise

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/save.md

#### WmfImage.Save method

Saves this WMF image to the file

```csharp
public override void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | 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
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/savetopng.md

#### WmfImage.SaveToPng method

Saves this vector WMF image into raster PNG image

```csharp
public override void SaveToPng(Stream outputPngContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputPngContent | Stream | Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable. |

### SaveToSvg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/savetosvg.md

#### WmfImage.SaveToSvg method

Saves this vector WMF image into vector SVG image

```csharp
public override void SaveToSvg(Stream outputSvgContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputSvgContent | Stream | Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable. |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/textcontent.md

#### WmfImage.TextContent property

Returns a content of this WMF image as a plain text

```csharp
public override string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/type.md

#### WmfImage.Type property

Returns ImageType.Wmf

```csharp
public override ImageType Type { get; }
```

### WmfImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.vector/wmfimage/wmfimage.md

#### WmfImage(string, string)

Creates new WmfImage instance from content, represented as base64-encoded string, and with specified name

```csharp
public WmfImage(string name, string contentInBase64)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WMF image. Cannot be null, empty or whitespaces. |
| contentInBase64 | String | Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a WMF content, exception will be thrown. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

#### WmfImage(string, Stream)

Creates new WmfImage instance from content, represented as byte stream, and with specified name

```csharp
public WmfImage(string name, Stream binaryContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of the WMF image. Cannot be null, empty or whitespaces. |
| binaryContent | Stream | 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException |  |
| InvalidImageFormatException |  |

### GroupDocs.Editor.HtmlCss.Resources.Images
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images.md

The GroupDocs.Editor.HtmlCss.Resources.Images namespace provides classes that represent image resources of all types in general.

#### Structures

| Structure | Description |
| --- | --- |
| Dimensions | Represents the linear dimensions (width and height) of one raster rectangular image in arbitrary unit. Immutable struct. |
| 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 |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### Dimensions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions.md

#### Dimensions structure

Represents the linear dimensions (width and height) of one raster rectangular image in arbitrary unit. Immutable struct.

```csharp
public struct Dimensions : ICloneable, IEquatable<Dimensions>
```

#### Constructors

| Name | Description |
| --- | --- |
| Dimensions(ushort, ushort) | Creates a new instance from specified width and height. |

#### Properties

| Name | Description |
| --- | --- |
| static Empty { get; } | Returns an empty Dimensions instance |
| Area { get; } | Returns an area (Width x Height) |
| AspectRatio { get; } | Aspect ratio of this dimensions as width/height |
| Height { get; } | Returns height of the image. |
| IsEmpty { get; } | Determines whether this "Dimensions" instance is empty and default, i.e. it doesn't store correct width and height |
| IsSquare { get; } | Determines whether specified 'Dimensions' represents square, i.e. if width is equal to height |
| Width { get; } | Returns width of the image |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Returns a full copy of this instance |
| Equals(Dimensions) | Determines whether this instance is equal with specified "Dimensions" instance |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "Dimensions" instance |
| override GetHashCode() | Returns a hashcode for this instance, which cannot be changed during its lifetime |
| ProportionallyResizeForNewHeight(ushort) | Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified height |
| ProportionallyResizeForNewWidth(ushort) | Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified width |
| override ToString() | Returns a string representation of this "Dimensions" |
| operator == | Checks whether two "Dimensions" values are equal, i.e. they have equal width and height, or both are empty |
| operator != | Checks whether two "Dimensions" values are not equal, i.e. their corresponding width and/or height are different |

### Area
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/area.md

#### Dimensions.Area property

Returns an area (Width x Height)

```csharp
public uint Area { get; }
```

### AspectRatio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/aspectratio.md

#### Dimensions.AspectRatio property

Aspect ratio of this dimensions as width/height

```csharp
public Ratio AspectRatio { get; }
```

### Clone
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/clone.md

#### Dimensions.Clone method

Returns a full copy of this instance

```csharp
public Dimensions Clone()
```

##### Return Value

New instance, that is a full and deep copy of this one

### Dimensions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/dimensions.md

#### Dimensions constructor

Creates a new instance from specified width and height.

```csharp
public Dimensions(ushort width, ushort height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | UInt16 | Width of image |
| height | UInt16 | Height of image |

### Empty
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/empty.md

#### Dimensions.Empty property

Returns an empty Dimensions instance

```csharp
public static Dimensions Empty { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/equals.md

#### Equals(Dimensions)

Determines whether this instance is equal with specified "Dimensions" instance

```csharp
public bool Equals(Dimensions other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Dimensions | Other "Dimensions" instance to check on equality |

##### Return Value

True if are equal, false if are not equal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "Dimensions" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other object, that is presumably of "Dimensions" type, that should be checked on equality with this |

##### Return Value

True if are equal, false if are not equal

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/gethashcode.md

#### Dimensions.GetHashCode method

Returns a hashcode for this instance, which cannot be changed during its lifetime

```csharp
public override int GetHashCode()
```

##### Return Value

Immutable (for this instance) hash-code as signed 4-byte integer

### Height
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/height.md

#### Dimensions.Height property

Returns height of the image.

```csharp
public ushort Height { get; }
```

### IsEmpty
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/isempty.md

#### Dimensions.IsEmpty property

Determines whether this "Dimensions" instance is empty and default, i.e. it doesn't store correct width and height

```csharp
public bool IsEmpty { get; }
```

### IsSquare
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/issquare.md

#### Dimensions.IsSquare property

Determines whether specified 'Dimensions' represents square, i.e. if width is equal to height

```csharp
public bool IsSquare { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/op_equality.md

#### Dimensions Equality operator

Checks whether two "Dimensions" values are equal, i.e. they have equal width and height, or both are empty

```csharp
public static bool operator ==(Dimensions first, Dimensions second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | Dimensions | First instance to check |
| second | Dimensions | Second instance to check |

##### Return Value

True if are equal, false if are not equal

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/op_inequality.md

#### Dimensions Inequality operator

Checks whether two "Dimensions" values are not equal, i.e. their corresponding width and/or height are different

```csharp
public static bool operator !=(Dimensions first, Dimensions second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | Dimensions | First instance to check |
| second | Dimensions | Second instance to check |

##### Return Value

True if are unequal, false if are equal

### ProportionallyResizeForNewHeight
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/proportionallyresizefornewheight.md

#### Dimensions.ProportionallyResizeForNewHeight method

Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified height

```csharp
public Dimensions ProportionallyResizeForNewHeight(ushort targetHeight)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetHeight | UInt16 | New target height, that will be present in resultant Dimension |

##### Return Value

New "Dimensions" instance with specified target height and proportionally resized width

### ProportionallyResizeForNewWidth
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/proportionallyresizefornewwidth.md

#### Dimensions.ProportionallyResizeForNewWidth method

Creates and returns new "Dimensions" instance, which is proportionally resized from current, based on specified width

```csharp
public Dimensions ProportionallyResizeForNewWidth(ushort targetWidth)
```

| Parameter | Type | Description |
| --- | --- | --- |
| targetWidth | UInt16 | New target width, that will be present in resultant Dimension |

##### Return Value

New "Dimensions" instance with specified target width and proportionally resized height

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/tostring.md

#### Dimensions.ToString method

Returns a string representation of this "Dimensions"

```csharp
public override string ToString()
```

##### Return Value

String instance, that contains a width and height in W:(width)×H:(height) format

##### Examples

W640×H480

### Width
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/dimensions/width.md

#### Dimensions.Width property

Returns width of the image

```csharp
public ushort Width { get; }
```

### IImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/iimage.md

#### IImage interface

Image CSS data type represents a two-dimensional image

```csharp
public interface IImage
```

##### Remarks

https://developer.mozilla.org/en-US/docs/Web/CSS/image CSS reference declares 4 types of images, that can be handled: 1. Images with intrinsic dimensions (a natural size) and thus fixed aspect ratio, that includes all raster images. 2. Images with multiple intrinsic dimensions, existing in multiple versions inside a single file, that includes ICON (*.ico) files. This may be also TIFF, as they support multiple images inside one file, however TIFF format is not supported in web. 3. Images with no intrinsic dimensions but with an intrinsic aspect ratio between its width and height. This includes all vector images, SVG first of all. 4. Images with neither intrinsic dimensions, nor an intrinsic aspect ratio. This includes all gradients.

### IImageResource
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/iimageresource.md

#### IImageResource interface

Represents image resource of any type, raster or vector

```csharp
public interface IImageResource : IHtmlResource, IImage
```

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | 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. |
| LinearDimensions { get; } | 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. |
| Type { get; } | In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info |

##### Remarks

https://developer.mozilla.org/en-US/docs/Web/CSS/image

### AspectRatio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/iimageresource/aspectratio.md

#### IImageResource.AspectRatio property

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.

```csharp
public Ratio AspectRatio { get; }
```

### LinearDimensions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/iimageresource/lineardimensions.md

#### IImageResource.LinearDimensions property

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.

```csharp
public Dimensions LinearDimensions { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/iimageresource/type.md

#### IImageResource.Type property

In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info

```csharp
public ImageType Type { get; }
```

### ImageType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype.md

#### ImageType structure

Represents one supportable image type (format), supports both raster and vector formats

```csharp
public struct ImageType : IEquatable<ImageType>, IResourceType
```

#### Properties

| Name | Description |
| --- | --- |
| static Bmp { get; } | BMP image type |
| static Emf { get; } | EMF (Enhanced MetaFile) vector image type |
| static Gif { get; } | GIF image type |
| static Icon { get; } | ICON image type |
| static Jpeg { get; } | JPEG image type |
| static Png { get; } | PNG image type |
| static Svg { get; } | SVG vector image type |
| static Tiff { get; } | TIFF (Tagged Image File Format) raster image type |
| static Undefined { get; } | Undefined image type - special value, which should not normally occur |
| static Wmf { get; } | WMF (Windows MetaFile) vector image type |
| FileExtension { get; } | File extension (without leading dot character) of a particular image type in lower case. For the Undefined type returns a string 'unsefined'. |
| FormalName { get; } | Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception. |
| IsVector { get; } | Indicates whether this particular format is vector (true) or raster (false) |
| MimeCode { get; } | MIME code of a particular image type as a string. For the Undefined type returns a string 'unsefined'. |

#### Methods

| Name | Description |
| --- | --- |
| static ParseFromFilenameWithExtension(string) | Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename |
| static ParseFromMime(string) | Returns ImageType value, which is equivalent of specified MIME code |
| Equals(ImageType) | Determines whether this instance is equal with specified "ImageType" instance |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "ImageType" instance |
| override GetHashCode() | Returns a hash-code, which is an immutable number for this specific instance |
| override ToString() | Returns a FormalName property |
| operator == | Defines whether two specific ImageType instances are equal |
| operator != | Defines whether two specific ImageType instances are not equal |

### Bmp
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/bmp.md

#### ImageType.Bmp property

BMP image type

```csharp
public static ImageType Bmp { get; }
```

### Emf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/emf.md

#### ImageType.Emf property

EMF (Enhanced MetaFile) vector image type

```csharp
public static ImageType Emf { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/equals.md

#### Equals(ImageType)

Determines whether this instance is equal with specified "ImageType" instance

```csharp
public bool Equals(ImageType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ImageType | Other ImageType instance to check on equality with this |

##### Return Value

True if are equal, false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "ImageType" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other System.Object instance, that is presumably of ImageType type, to check on equality with this |

##### Return Value

True if are equal, false if are unequal

### FileExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/fileextension.md

#### ImageType.FileExtension property

File extension (without leading dot character) of a particular image type in lower case. For the Undefined type returns a string 'unsefined'.

```csharp
public string FileExtension { get; }
```

### FormalName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/formalname.md

#### ImageType.FormalName property

Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception.

```csharp
public string FormalName { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/gethashcode.md

#### ImageType.GetHashCode method

Returns a hash-code, which is an immutable number for this specific instance

```csharp
public override int GetHashCode()
```

##### Return Value

Signed 4-byte integer

### Gif
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/gif.md

#### ImageType.Gif property

GIF image type

```csharp
public static ImageType Gif { get; }
```

### Icon
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/icon.md

#### ImageType.Icon property

ICON image type

```csharp
public static ImageType Icon { get; }
```

### IsVector
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/isvector.md

#### ImageType.IsVector property

Indicates whether this particular format is vector (true) or raster (false)

```csharp
public bool IsVector { get; }
```

### Jpeg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/jpeg.md

#### ImageType.Jpeg property

JPEG image type

```csharp
public static ImageType Jpeg { get; }
```

### MimeCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/mimecode.md

#### ImageType.MimeCode property

MIME code of a particular image type as a string. For the Undefined type returns a string 'unsefined'.

```csharp
public string MimeCode { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/op_equality.md

#### ImageType Equality operator

Defines whether two specific ImageType instances are equal

```csharp
public static bool operator ==(ImageType first, ImageType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | ImageType | First ImageType instance to check |
| second | ImageType | Second ImageType instance to check |

##### Return Value

True if are equal, false if are unequal

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/op_inequality.md

#### ImageType Inequality operator

Defines whether two specific ImageType instances are not equal

```csharp
public static bool operator !=(ImageType first, ImageType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | ImageType | First ImageType instance to check |
| second | ImageType | Second ImageType instance to check |

##### Return Value

True if are unequal, false if are equal

### ParseFromFilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/parsefromfilenamewithextension.md

#### ImageType.ParseFromFilenameWithExtension method

Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename

```csharp
public static ImageType ParseFromFilenameWithExtension(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Arbitrary filename, can be a relative or full path |

##### Return Value

ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.

### ParseFromMime
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/parsefrommime.md

#### ImageType.ParseFromMime method

Returns ImageType value, which is equivalent of specified MIME code

```csharp
public static ImageType ParseFromMime(string mimeCode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | String | Arbitrary MIME-code |

##### Return Value

ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.

### Png
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/png.md

#### ImageType.Png property

PNG image type

```csharp
public static ImageType Png { get; }
```

### Svg
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/svg.md

#### ImageType.Svg property

SVG vector image type

```csharp
public static ImageType Svg { get; }
```

### Tiff
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/tiff.md

#### ImageType.Tiff property

TIFF (Tagged Image File Format) raster image type

```csharp
public static ImageType Tiff { get; }
```

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/tostring.md

#### ImageType.ToString method

Returns a FormalName property

```csharp
public override string ToString()
```

### Undefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/undefined.md

#### ImageType.Undefined property

Undefined image type - special value, which should not normally occur

```csharp
public static ImageType Undefined { get; }
```

### Wmf
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.images/imagetype/wmf.md

#### ImageType.Wmf property

WMF (Windows MetaFile) vector image type

```csharp
public static ImageType Wmf { get; }
```

### GroupDocs.Editor.HtmlCss.Resources.Textual
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual.md

The 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 |
| XmlText | Represents one textual resource, which is a XML. |
#### Structures

| Structure | Description |
| --- | --- |
| TextType | Represents one supportable textual resource type |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### CssText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/csstext.md

#### CssText class

Represents one CSS textual resource

```csharp
public sealed class CssText : TextResourceBase
```

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this text resource as byte stream with original encoding |
| Encoding { get; } | Returns encoding of this textual resource. Usually returns UTF-8. |
| FilenameWithExtension { get; } | Returns correct filename of this text resource, which consists of name and extension |
| IsDisposed { get; } | Determines whether this text resource is disposed or not |
| Name { get; } | Returns name of this text resource without file extension |
| TextContent { get; } | Returns content of this text resource as a standard string |
| override Type { get; } | Returns TextType.Css |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls. |
| Equals(IHtmlResource) | Checks this instance with specified on equality. |
| Save(string) | Saves this text resource to the specified file |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this text resource is disposed |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/csstext/type.md

#### CssText.Type property

Returns TextType.Css

```csharp
public override TextType Type { get; }
```

### TextResourceBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase.md

#### TextResourceBase class

Base class for any supported text resource with text content and encoding

```csharp
public abstract class TextResourceBase : IHtmlResource
```

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this text resource as byte stream with original encoding |
| Encoding { get; } | Returns encoding of this textual resource. Usually returns UTF-8. |
| FilenameWithExtension { get; } | Returns correct filename of this text resource, which consists of name and extension |
| IsDisposed { get; } | Determines whether this text resource is disposed or not |
| Name { get; } | Returns name of this text resource without file extension |
| TextContent { get; } | Returns content of this text resource as a standard string |
| abstract Type { get; } | In implementing type should return information about type of the text resource |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls. |
| Equals(IHtmlResource) | Checks this instance with specified on equality. |
| Save(string) | Saves this text resource to the specified file |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this text resource is disposed |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/bytecontent.md

#### TextResourceBase.ByteContent property

Returns content of this text resource as byte stream with original encoding

```csharp
public Stream ByteContent { get; }
```

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/dispose.md

#### TextResourceBase.Dispose method

Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls.

```csharp
public void Dispose()
```

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/disposed.md

#### TextResourceBase.Disposed event

Event, which occurs when this text resource is disposed

```csharp
public event EventHandler Disposed;
```

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/encoding.md

#### TextResourceBase.Encoding property

Returns encoding of this textual resource. Usually returns UTF-8.

```csharp
public Encoding Encoding { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/equals.md

#### TextResourceBase.Equals method

Checks this instance with specified on equality.

```csharp
public bool Equals(IHtmlResource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | IHtmlResource | Other HTML resource of unknown type, that is also presumable TextResourceBase inheritor |

##### Return Value

Returns true if are equal, or false if are unequal

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/filenamewithextension.md

#### TextResourceBase.FilenameWithExtension property

Returns correct filename of this text resource, which consists of name and extension

```csharp
public string FilenameWithExtension { get; }
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/isdisposed.md

#### TextResourceBase.IsDisposed property

Determines whether this text resource is disposed or not

```csharp
public bool IsDisposed { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/name.md

#### TextResourceBase.Name property

Returns name of this text resource without file extension

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/save.md

#### TextResourceBase.Save method

Saves this text resource to the specified file

```csharp
public void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String | Full path to the file, which will be created or rewritten if already exists |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/textcontent.md

#### TextResourceBase.TextContent property

Returns content of this text resource as a standard string

```csharp
public string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/textresourcebase/type.md

#### TextResourceBase.Type property

In implementing type should return information about type of the text resource

```csharp
public abstract TextType Type { get; }
```

### TextType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype.md

#### TextType structure

Represents one supportable textual resource type

```csharp
public struct TextType : IEquatable<TextType>, IResourceType
```

#### Properties

| Name | Description |
| --- | --- |
| static Css { get; } | CSS type of the textual resource |
| static Undefined { get; } | Special value, which marks undefined, unknown or unsupported textual resource |
| static Xml { get; } | XML type of the textual resource |
| FileExtension { get; } | File extension (without leading dot character) of a particular textual resource |
| FormalName { get; } | Returns a formal name of this textual resource type |
| MimeCode { get; } | MIME code of a particular textual resource type |

#### Methods

| Name | Description |
| --- | --- |
| static ParseFromFilenameWithExtension(string) | Returns TextType value, which is equivalent of filename extension, which is extracted from specified filename with extension or pure extension |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "TextType" instance |
| Equals(TextType) | Determines whether this instance is equal with specified "TextType" instance |
| override GetHashCode() | Returns a hash-code, which is a constant number for this specific value type |
| operator == | Defines whether two specific "TextType" instances are equal |
| operator != | Defines whether two specific "TextType" instances are not equal |

### Css
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/css.md

#### TextType.Css property

CSS type of the textual resource

```csharp
public static TextType Css { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/equals.md

#### Equals(TextType)

Determines whether this instance is equal with specified "TextType" instance

```csharp
public bool Equals(TextType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TextType | Other TextType instance, that should be compared with this on equality |

##### Return Value

Returns true if are equal or false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "TextType" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other TextType instance, that is boxed to object |

##### Return Value

Returns true if are equal or false if are unequal

### FileExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/fileextension.md

#### TextType.FileExtension property

File extension (without leading dot character) of a particular textual resource

```csharp
public string FileExtension { get; }
```

### FormalName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/formalname.md

#### TextType.FormalName property

Returns a formal name of this textual resource type

```csharp
public string FormalName { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/gethashcode.md

#### TextType.GetHashCode method

Returns a hash-code, which is a constant number for this specific value type

```csharp
public override int GetHashCode()
```

##### Return Value

Signed 4-byte integer number. Returns 0 if this instance has default value.

### MimeCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/mimecode.md

#### TextType.MimeCode property

MIME code of a particular textual resource type

```csharp
public string MimeCode { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/op_equality.md

#### TextType Equality operator

Defines whether two specific "TextType" instances are equal

```csharp
public static bool operator ==(TextType first, TextType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextType | First TextType instance |
| second | TextType | Second TextType instance |

##### Return Value

Returns true if are equal or false if are unequal

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/op_inequality.md

#### TextType Inequality operator

Defines whether two specific "TextType" instances are not equal

```csharp
public static bool operator !=(TextType first, TextType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | TextType | First TextType instance |
| second | TextType | Second TextType instance |

##### Return Value

Returns true if are unequal or false if are equal

### ParseFromFilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/parsefromfilenamewithextension.md

#### TextType.ParseFromFilenameWithExtension method

Returns TextType value, which is equivalent of filename extension, which is extracted from specified filename with extension or pure extension

```csharp
public static TextType ParseFromFilenameWithExtension(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Filename with extension, can be relative or absolute path, or pure extension itself |

##### Return Value

Parsed TextType instance on success or TextType.Undefined on failure

### Undefined
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/undefined.md

#### TextType.Undefined property

Special value, which marks undefined, unknown or unsupported textual resource

```csharp
public static TextType Undefined { get; }
```

### Xml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/texttype/xml.md

#### TextType.Xml property

XML type of the textual resource

```csharp
public static TextType Xml { get; }
```

### XmlText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/xmltext.md

#### XmlText class

Represents one textual resource, which is a XML.

```csharp
public sealed class XmlText : TextResourceBase
```

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Returns content of this text resource as byte stream with original encoding |
| Encoding { get; } | Returns encoding of this textual resource. Usually returns UTF-8. |
| FilenameWithExtension { get; } | Returns correct filename of this text resource, which consists of name and extension |
| IsDisposed { get; } | Determines whether this text resource is disposed or not |
| Name { get; } | Returns name of this text resource without file extension |
| ParsedDocument { get; } | Returns an "XmlDocument" from this XML resource |
| TextContent { get; } | Returns content of this text resource as a standard string |
| override Type { get; } | Returns TextType.Xml |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls. |
| Equals(IHtmlResource) | Checks this instance with specified on equality. |
| Save(string) | Saves this text resource to the specified file |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this text resource is disposed |

### ParsedDocument
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/xmltext/parseddocument.md

#### XmlText.ParsedDocument property

Returns an "XmlDocument" from this XML resource

```csharp
public XmlDocument ParsedDocument { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.textual/xmltext/type.md

#### XmlText.Type property

Returns TextType.Xml

```csharp
public override TextType Type { get; }
```

### GroupDocs.Editor.HtmlCss.Resources
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources.md

The 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 the disposing event |
| IHtmlResource | Represents one instance of the unknown HTML resource (raster or vector image, stylesheet, font, text resource (CSS, XML), audio etc.) |
| IResourceType | Represents one instance of the unknown resource type/format (image, font, text) |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### IAuxDisposable
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iauxdisposable.md

#### IAuxDisposable interface

Expands the standard IDisposable interface, allows to obtain a current state of an object and subscribe to the disposing event

```csharp
public interface IAuxDisposable : IDisposable
```

#### Properties

| Name | Description |
| --- | --- |
| IsDisposed { get; } | Determines whether a resource is closed (true) or not (false) |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Occurs when object is disposed |

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iauxdisposable/disposed.md

#### IAuxDisposable.Disposed event

Occurs when object is disposed

```csharp
public event EventHandler Disposed;
```

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iauxdisposable/isdisposed.md

#### IAuxDisposable.IsDisposed property

Determines whether a resource is closed (true) or not (false)

```csharp
public bool IsDisposed { get; }
```

### IHtmlResource
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource.md

#### IHtmlResource interface

Represents one instance of the unknown HTML resource (raster or vector image, stylesheet, font, text resource (CSS, XML), audio etc.)

```csharp
public interface IHtmlResource : IAuxDisposable, IEquatable<IHtmlResource>
```

#### Properties

| Name | Description |
| --- | --- |
| ByteContent { get; } | Content of the HTML resource in a form of a byte stream |
| FilenameWithExtension { get; } | Correct filename of the specified resource with appropriate file extension |
| Name { get; } | Name of the HTML resource |
| TextContent { get; } | Content of the HTML resource in a form of a base64-encoded text string for binary resources or a simple text for textual resources |
| Type { get; } | Type of the HTML resource |

#### Methods

| Name | Description |
| --- | --- |
| Save(string) | Saves a current resource to the specified file |

### ByteContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/bytecontent.md

#### IHtmlResource.ByteContent property

Content of the HTML resource in a form of a byte stream

```csharp
public Stream ByteContent { get; }
```

### FilenameWithExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/filenamewithextension.md

#### IHtmlResource.FilenameWithExtension property

Correct filename of the specified resource with appropriate file extension

```csharp
public string FilenameWithExtension { get; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/name.md

#### IHtmlResource.Name property

Name of the HTML resource

```csharp
public string Name { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/save.md

#### IHtmlResource.Save method

Saves a current resource to the specified file

```csharp
public void Save(string fullPathToFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fullPathToFile | String | Full path to the file, which will be created or rewritten with the content of a current resource |

### TextContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/textcontent.md

#### IHtmlResource.TextContent property

Content of the HTML resource in a form of a base64-encoded text string for binary resources or a simple text for textual resources

```csharp
public string TextContent { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/ihtmlresource/type.md

#### IHtmlResource.Type property

Type of the HTML resource

```csharp
public IResourceType Type { get; }
```

### IResourceType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iresourcetype.md

#### IResourceType interface

Represents one instance of the unknown resource type/format (image, font, text)

```csharp
public interface IResourceType
```

#### Properties

| Name | Description |
| --- | --- |
| FileExtension { get; } | File extension for the specified resource type without dot divider |
| FormalName { get; } | Formal name of the resource type |
| MimeCode { get; } | MIME code for the specific resource type |

### FileExtension
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iresourcetype/fileextension.md

#### IResourceType.FileExtension property

File extension for the specified resource type without dot divider

```csharp
public string FileExtension { get; }
```

### FormalName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iresourcetype/formalname.md

#### IResourceType.FormalName property

Formal name of the resource type

```csharp
public string FormalName { get; }
```

### MimeCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/iresourcetype/mimecode.md

#### IResourceType.MimeCode property

MIME code for the specific resource type

```csharp
public string MimeCode { get; }
```

### ResourceTypeDetector
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/resourcetypedetector.md

#### ResourceTypeDetector class

Utility static methods for detecting resource types (formats)

```csharp
public static class ResourceTypeDetector
```

#### Methods

| Name | Description |
| --- | --- |
| static DetectTypeFromFilename(string) | Detects a type from specified filename and returns an instance of respective IResourceType |
| static TryDetectResource(Stream, string, IResourceType) | 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 |

### DetectTypeFromFilename
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/resourcetypedetector/detecttypefromfilename.md

#### ResourceTypeDetector.DetectTypeFromFilename method

Detects a type from specified filename and returns an instance of respective IResourceType

```csharp
public static IResourceType DetectTypeFromFilename(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Input filename, from which this method will try to extract the resultant IResourceType implementation |

##### Return Value

IResourceType implementation on success or NULL on failure

### TryDetectResource
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.resources/resourcetypedetector/trydetectresource.md

#### ResourceTypeDetector.TryDetectResource method

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

```csharp
public static IHtmlResource TryDetectResource(Stream inputResourceStream, string name, 
    IResourceType assumptiveFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| inputResourceStream | Stream | Input stream, which presumably contains an HTML resource. If invalid, an exception will be thrown. |
| name | 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. |

##### Return Value

Instance, which implements 'IHtmlResource' interface and represents one of supportable HTML resources on success, or NULL on failure

### GroupDocs.Editor.HtmlCss.Serialization
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization.md

The GroupDocs.Editor.HtmlCss.Serialization namespace provides types, that are responsible for tuning HTML and CSS markup serialization process.

#### Structures

| Structure | Description |
| --- | --- |
| QuoteType | Represents quote characters - single quote (') and double quote (") |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| TagRenderingCase | Represents different types of serialization the HTML tag names |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### QuoteType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype.md

#### QuoteType structure

Represents quote characters - single quote (') and double quote (")

```csharp
public struct QuoteType : IEquatable<QuoteType>
```

#### Properties

| Name | Description |
| --- | --- |
| Character { get; } | Character to enquote |
| Code { get; } | Code point of the current character (U+0027 or U+0022) |
| HtmlEncoded { get; } | HTML-encoded character |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether this instance of the quote type is equal to specified uncasted |
| Equals(QuoteType) | Indicates whether this instance of the quote type is equal to specified |
| override GetHashCode() | Returns a hash-code for this character |
| override ToString() | Returns a "SingleQuote" or "DoubleQuote" string depending on the current value |
| operator == | Checks whether two "QuoteType" values are equal |
| explicit operator | Casts specified `QuoteType` instance to the Char (2 operators) |
| operator != | Checks whether two "QuoteType" values are not equal |

#### Fields

| Name | Description |
| --- | --- |
| static readonly DoubleQuote | Double quote (U+0022 QUOTATION MARK character) |
| static readonly SingleQuote | Single quote (U+0027 APOSTROPHE character) |

### Character
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/character.md

#### QuoteType.Character property

Character to enquote

```csharp
public char Character { get; }
```

### Code
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/code.md

#### QuoteType.Code property

Code point of the current character (U+0027 or U+0022)

```csharp
public int Code { get; }
```

### DoubleQuote
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/doublequote.md

#### QuoteType.DoubleQuote field

Double quote (U+0022 QUOTATION MARK character)

```csharp
public static readonly QuoteType DoubleQuote;
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/equals.md

#### Equals(QuoteType)

Indicates whether this instance of the quote type is equal to specified

```csharp
public bool Equals(QuoteType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | QuoteType | Other instance of QuoteType to check |

##### Return Value

true if are equal, false if are unequal

#### Equals(object)

Indicates whether this instance of the quote type is equal to specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Uncasted object, expected to be of `QuoteType` type |

##### Return Value

true if are equal, false if are unequal

### GetHashCode
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/gethashcode.md

#### QuoteType.GetHashCode method

Returns a hash-code for this character

```csharp
public override int GetHashCode()
```

##### Return Value

Hash-code as an signed integer

### HtmlEncoded
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/htmlencoded.md

#### QuoteType.HtmlEncoded property

HTML-encoded character

```csharp
public string HtmlEncoded { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/op_equality.md

#### QuoteType Equality operator

Checks whether two "QuoteType" values are equal

```csharp
public static bool operator ==(QuoteType first, QuoteType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | QuoteType | First value to check |
| second | QuoteType | Second value to check |

##### Return Value

true if are equal, false otherwise

### op_Explicit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/op_explicit.md

#### explicit operator

Casts specified `QuoteType` instance to the Char

```csharp
public static explicit operator char(QuoteType quote)
```

| Parameter | Type | Description |
| --- | --- | --- |
| quote | QuoteType | Quote type instance to cast |

#### explicit operator

Casts specific Char to the corresponding `QuoteType`, throws exception if casting is invalid

```csharp
public static explicit operator QuoteType(char character)
```

| 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified Char is not either a quotation mark or apostrophe |

### op_Inequality
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/op_inequality.md

#### QuoteType Inequality operator

Checks whether two "QuoteType" values are not equal

```csharp
public static bool operator !=(QuoteType first, QuoteType second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | QuoteType | First value to check |
| second | QuoteType | Second value to check |

##### Return Value

false if are equal, true otherwise

### SingleQuote
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/singlequote.md

#### QuoteType.SingleQuote field

Single quote (U+0027 APOSTROPHE character)

```csharp
public static readonly QuoteType SingleQuote;
```

### ToString
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/quotetype/tostring.md

#### QuoteType.ToString method

Returns a "SingleQuote" or "DoubleQuote" string depending on the current value

```csharp
public override string ToString()
```

### TagRenderingCase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.htmlcss.serialization/tagrenderingcase.md

#### TagRenderingCase enumeration

Represents different types of serialization the HTML tag names

```csharp
public enum TagRenderingCase
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| LowerCase | `0` | all-lower - all letters in the tag name will be serialized in lower case |
| UpperCase | `1` | ALL-CAPITAL - all letters in the tag name will be serialized in UPPER case |
| FirstLetterUpperCase | `2` | First letter in the tag name will be serialized in Upper case, while all others - in lower. |

### GroupDocs.Editor.Metadata
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata.md

The GroupDocs.Editor.Metadata namespace provides classes for describing basic document properties dependent on document type.

#### Structures

| Structure | Description |
| --- | --- |
| EbookDocumentInfo | Represents metadata of one e-Book 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 |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### EbookDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo.md

#### EbookDocumentInfo structure

Represents metadata of one e-Book document

```csharp
public struct EbookDocumentInfo : IDocumentInfo, IEquatable<EbookDocumentInfo>
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this e-Book |
| IsEncrypted { get; } | Because e-Book documents cannot be encrypted with password, this property always returns 'false' |
| PageCount { get; } | Returns number of pages in case of MOBI or AZW3 or number of chapters in case of ePub. |
| Size { get; } | Returns size in bytes of this eBook document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(EbookDocumentInfo) | Determines whether this instance is equal to the other specified EbookDocumentInfo instance |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo/equals.md

#### EbookDocumentInfo.Equals method

Determines whether this instance is equal to the other specified EbookDocumentInfo instance

```csharp
public bool Equals(EbookDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | EbookDocumentInfo | Other EbookDocumentInfo instance, that should be checked on equality with this |

##### Return Value

True if are equal, false if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo/format.md

#### EbookDocumentInfo.Format property

Returns a format of this e-Book

```csharp
public DocumentFormatBase Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo/isencrypted.md

#### EbookDocumentInfo.IsEncrypted property

Because e-Book documents cannot be encrypted with password, this property always returns 'false'

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo/pagecount.md

#### EbookDocumentInfo.PageCount property

Returns number of pages in case of MOBI or AZW3 or number of chapters in case of ePub.

```csharp
public int PageCount { get; }
```

##### Remarks

e-Book 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.

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/ebookdocumentinfo/size.md

#### EbookDocumentInfo.Size property

Returns size in bytes of this eBook document

```csharp
public long Size { get; }
```

### EmailDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo.md

#### EmailDocumentInfo structure

Represents metadata of one email document of any supported email format

```csharp
public struct EmailDocumentInfo : IDocumentInfo, IEquatable<EmailDocumentInfo>
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this email document |
| IsEncrypted { get; } | Because email documents cannot be encrypted with password, this property always returns 'false' |
| PageCount { get; } | Always returs 1, because email documents don't have paged view |
| Size { get; } | Returns size in bytes of this email document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(EmailDocumentInfo) | Determines whether this instance is equal to the other specified EmailDocumentInfo instance |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo/equals.md

#### EmailDocumentInfo.Equals method

Determines whether this instance is equal to the other specified EmailDocumentInfo instance

```csharp
public bool Equals(EmailDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | EmailDocumentInfo | Other EmailDocumentInfo instance, that should be checked on equality with this |

##### Return Value

True if are equal, false if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo/format.md

#### EmailDocumentInfo.Format property

Returns a format of this email document

```csharp
public DocumentFormatBase Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo/isencrypted.md

#### EmailDocumentInfo.IsEncrypted property

Because email documents cannot be encrypted with password, this property always returns 'false'

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo/pagecount.md

#### EmailDocumentInfo.PageCount property

Always returs 1, because email documents don't have paged view

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/emaildocumentinfo/size.md

#### EmailDocumentInfo.Size property

Returns size in bytes of this email document

```csharp
public long Size { get; }
```

### FixedLayoutDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo.md

#### FixedLayoutDocumentInfo structure

Represents metadata of one document with fixed layout format like PDF or XPS

```csharp
public struct FixedLayoutDocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this fixed-layout format document |
| IsEncrypted { get; } | Determines whether this specific fixed-layout format document in encrypted and requires password for opening |
| PageCount { get; } | Returns number of pages |
| Size { get; } | Returns size in bytes of this fixed-layout format document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FixedLayoutDocumentInfo) | Determines whether this instance is equal to the other specified FixedLayoutDocumentInfo instance |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/equals.md

#### FixedLayoutDocumentInfo.Equals method

Determines whether this instance is equal to the other specified FixedLayoutDocumentInfo instance

```csharp
public bool Equals(FixedLayoutDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FixedLayoutDocumentInfo | Other FixedLayoutDocumentInfo instance, that should be checked on equality with this |

##### Return Value

True if are equal, false if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/format.md

#### FixedLayoutDocumentInfo.Format property

Returns a format of this fixed-layout format document

```csharp
public DocumentFormatBase Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/isencrypted.md

#### FixedLayoutDocumentInfo.IsEncrypted property

Determines whether this specific fixed-layout format document in encrypted and requires password for opening

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/pagecount.md

#### FixedLayoutDocumentInfo.PageCount property

Returns number of pages

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/size.md

#### FixedLayoutDocumentInfo.Size property

Returns size in bytes of this fixed-layout format document

```csharp
public long Size { get; }
```

### IDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/idocumentinfo.md

#### IDocumentInfo interface

Common interface for all file metadata wrappers

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | In implementing type should return a document format as a single value from a type, that represents one format family and inherits from IDocumentFormat interface |
| IsEncrypted { get; } | Indicates whether specific file is encrypted and requires password for opening. For the document types, that cannot be encrypted (like all text-based) should always return 'false'. |
| PageCount { get; } | In implementing type should return count (number) of pages or other similar format-dependent entities (tabs, slides etc.). For those family types, that don't have something similar (like plain text documents or XML) should return 1. |
| Size { get; } | Document size in bytes |

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/idocumentinfo/format.md

#### IDocumentInfo.Format property

In implementing type should return a document format as a single value from a type, that represents one format family and inherits from IDocumentFormat interface

```csharp
public DocumentFormatBase Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/idocumentinfo/isencrypted.md

#### IDocumentInfo.IsEncrypted property

Indicates whether specific file is encrypted and requires password for opening. For the document types, that cannot be encrypted (like all text-based) should always return 'false'.

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

In implementing type should return count (number) of pages or other similar format-dependent entities (tabs, slides etc.). For those family types, that don't have something similar (like plain text documents or XML) should return 1.

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/idocumentinfo/size.md

#### IDocumentInfo.Size property

Document size in bytes

```csharp
public long Size { get; }
```

### MarkdownDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo.md

#### MarkdownDocumentInfo structure

Represents metadata of one Markdown document

```csharp
public struct MarkdownDocumentInfo : IDocumentInfo, IEquatable<MarkdownDocumentInfo>
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this Markdown document — always is `Md` |
| IsEncrypted { get; } | Because Markdown documents cannot be encrypted with password, this property always returns ``false`' |
| PageCount { get; } | 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. |
| Size { get; } | Returns size in bytes of this Markdown document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(MarkdownDocumentInfo) | Determines whether this instance is equal to the other specified `MarkdownDocumentInfo` instance. |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo/equals.md

#### MarkdownDocumentInfo.Equals method

Determines whether this instance is equal to the other specified `MarkdownDocumentInfo` instance.

```csharp
public bool Equals(MarkdownDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | MarkdownDocumentInfo | Other `MarkdownDocumentInfo` instance, that should be checked on equality with this |

##### Return Value

`true` if are equal, `false` if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo/format.md

#### MarkdownDocumentInfo.Format property

Returns a format of this Markdown document — always is `Md`

```csharp
public DocumentFormatBase Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo/isencrypted.md

#### MarkdownDocumentInfo.IsEncrypted property

Because Markdown documents cannot be encrypted with password, this property always returns ``false`'

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo/pagecount.md

#### MarkdownDocumentInfo.PageCount property

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.

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/markdowndocumentinfo/size.md

#### MarkdownDocumentInfo.Size property

Returns size in bytes of this Markdown document

```csharp
public long Size { get; }
```

### PresentationDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo.md

#### PresentationDocumentInfo structure

Represents metadata of one Presentation document

```csharp
public struct PresentationDocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this Presentation document |
| IsEncrypted { get; } | Indicates whether this specific Presentation document in encrypted and requires password for opening |
| PageCount { get; } | Returns number of slides in this Presentation document |
| Size { get; } | Returns size in bytes of this Presentation document |

#### Methods

| Name | Description |
| --- | --- |
| GeneratePreview(int) | Generates and returns a preview of the selected slide in a form of SVG image |

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo/format.md

#### PresentationDocumentInfo.Format property

Returns a format of this Presentation document

```csharp
public PresentationFormats Format { get; }
```

### GeneratePreview
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo/generatepreview.md

#### PresentationDocumentInfo.GeneratePreview method

Generates and returns a preview of the selected slide in a form of SVG image

```csharp
public SvgImage GeneratePreview(int slideIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| slideIndex | Int32 | 0-based index of the desired slide. Cannot be lesser then 0, cannot exceed the number of slides in this presentation. |

##### Return Value

SVG image as the non-null instance of the `SvgImage` class

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specidied *slideIndex* is lesser then 0 or bigger then the number of slides in this presentation |

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo/isencrypted.md

#### PresentationDocumentInfo.IsEncrypted property

Indicates whether this specific Presentation document in encrypted and requires password for opening

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo/pagecount.md

#### PresentationDocumentInfo.PageCount property

Returns number of slides in this Presentation document

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/presentationdocumentinfo/size.md

#### PresentationDocumentInfo.Size property

Returns size in bytes of this Presentation document

```csharp
public long Size { get; }
```

### SpreadsheetDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo.md

#### SpreadsheetDocumentInfo structure

Represents metadata of one Spreadsheet document

```csharp
public struct SpreadsheetDocumentInfo : IDocumentInfo, IEquatable<SpreadsheetDocumentInfo>
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this Spreadsheet document |
| IsEncrypted { get; } | Indicates whether this specific Spreadsheet document in encrypted and requires password for opening |
| PageCount { get; } | Returns number of tabs |
| Size { get; } | Returns size in bytes of this Spreadsheet document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(SpreadsheetDocumentInfo) | Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance |
| GeneratePreview(int) | Generates and returns a preview of the selected worksheet in a form of SVG image |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/equals.md

#### SpreadsheetDocumentInfo.Equals method

Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance

```csharp
public bool Equals(SpreadsheetDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | SpreadsheetDocumentInfo | Other SpreadsheetDocumentInfo instance, that should be checked on equality with this |

##### Return Value

True if are equal, false if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/format.md

#### SpreadsheetDocumentInfo.Format property

Returns a format of this Spreadsheet document

```csharp
public SpreadsheetFormats Format { get; }
```

### GeneratePreview
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/generatepreview.md

#### SpreadsheetDocumentInfo.GeneratePreview method

Generates and returns a preview of the selected worksheet in a form of SVG image

```csharp
public SvgImage GeneratePreview(int worksheetIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | 0-based index of the desired worksheet. Cannot be lesser then 0, cannot exceed the number of worksheets in this spreadsheet. |

##### Return Value

SVG image as the non-null instance of the `SvgImage` class

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified *worksheetIndex* is lesser then 0 or bigger then the number of worksheets in this spreadsheet |

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/isencrypted.md

#### SpreadsheetDocumentInfo.IsEncrypted property

Indicates whether this specific Spreadsheet document in encrypted and requires password for opening

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/pagecount.md

#### SpreadsheetDocumentInfo.PageCount property

Returns number of tabs

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/spreadsheetdocumentinfo/size.md

#### SpreadsheetDocumentInfo.Size property

Returns size in bytes of this Spreadsheet document

```csharp
public long Size { get; }
```

### TextualDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo.md

#### TextualDocumentInfo structure

Represents metadata of one textual document like XML, HTML or plain text (TXT)

```csharp
public struct TextualDocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; } | Returns detected presumable encoding of the text document |
| Format { get; } | Returns a format of this textual document. May be not 100% correct in some cases. |
| IsEncrypted { get; } | Always returns ``false``, as textual documents cannot be encrypted |
| PageCount { get; } | Always returns 1 |
| Size { get; } | Returns size in bytes (not the number of characters) of this textual document |

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo/encoding.md

#### TextualDocumentInfo.Encoding property

Returns detected presumable encoding of the text document

```csharp
public Encoding Encoding { get; }
```

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo/format.md

#### TextualDocumentInfo.Format property

Returns a format of this textual document. May be not 100% correct in some cases.

```csharp
public TextualFormats Format { get; }
```

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo/isencrypted.md

#### TextualDocumentInfo.IsEncrypted property

Always returns ``false``, as textual documents cannot be encrypted

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo/pagecount.md

#### TextualDocumentInfo.PageCount property

Always returns 1

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/textualdocumentinfo/size.md

#### TextualDocumentInfo.Size property

Returns size in bytes (not the number of characters) of this textual document

```csharp
public long Size { get; }
```

### WordProcessingDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo.md

#### WordProcessingDocumentInfo structure

Represents metadata of one WordProcessing document

```csharp
public struct WordProcessingDocumentInfo : IDocumentInfo, IEquatable<WordProcessingDocumentInfo>
```

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Returns a format of this WordProcessing document |
| IsEncrypted { get; } | Determines whether this specific WordProcessing document in encrypted and requires password for opening |
| PageCount { get; } | Returns number of pages |
| Size { get; } | Returns size in bytes of this WordProcessing document |

#### Methods

| Name | Description |
| --- | --- |
| Equals(WordProcessingDocumentInfo) | Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance |
| GeneratePreview(int) | Generates and returns a preview of the selected page in a form of SVG image |

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/equals.md

#### WordProcessingDocumentInfo.Equals method

Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance

```csharp
public bool Equals(WordProcessingDocumentInfo other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | WordProcessingDocumentInfo | Other WordProcessingDocumentInfo instance, that should be checked on equality with this |

##### Return Value

True if are equal, false if are unequal

### Format
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/format.md

#### WordProcessingDocumentInfo.Format property

Returns a format of this WordProcessing document

```csharp
public WordProcessingFormats Format { get; }
```

### GeneratePreview
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/generatepreview.md

#### WordProcessingDocumentInfo.GeneratePreview method

Generates and returns a preview of the selected page in a form of SVG image

```csharp
public SvgImage GeneratePreview(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | 0-based index of the desired page. Cannot be lesser then 0, cannot exceed the number of pages in this WordProcessing document. |

##### Return Value

SVG image as the non-null instance of the `SvgImage` class

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified *pageIndex* is lesser then 0 or bigger then the number of pages in this WordProcessing document |

### IsEncrypted
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/isencrypted.md

#### WordProcessingDocumentInfo.IsEncrypted property

Determines whether this specific WordProcessing document in encrypted and requires password for opening

```csharp
public bool IsEncrypted { get; }
```

### PageCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/pagecount.md

#### WordProcessingDocumentInfo.PageCount property

Returns number of pages

```csharp
public int PageCount { get; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.metadata/wordprocessingdocumentinfo/size.md

#### WordProcessingDocumentInfo.Size property

Returns size in bytes of this WordProcessing document

```csharp
public long Size { get; }
```

### GroupDocs.Editor.Options
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options.md

The 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 |
| HtmlSaveOptions | Allows to specify custom options for saving the `EditableDocument` instance to the HTML format |
| MarkdownEditOptions | Allows to specify custom options for editing documents in Markdown (MD) format |
| MarkdownImageLoadArgs | Provides data for the ProcessImage event. |
| MarkdownSaveOptions | Allows to specify custom options for generating and saving Markdown documents |
| MhtmlSaveOptions | Allows to specify custom options for generating and saving the MHTML (MIME encapsulation of aggregate HTML documents) documents |
| PdfEditOptions | Allows to specify custom options for editing PDF documents |
| PdfLoadOptions | Contains options for loading PDF documents into Editor class |
| 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. into Editor class |
| SpreadsheetSaveOptions | Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents |
| TextEditOptions | Allows to specify custom options for loading plain text (TXT) documents |
| TextSaveOptions | Allows to specify custom options for generating and saving plain text (TXT) documents |
| 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. into Editor class |
| WordProcessingProtection | Encapsulates document protection options for the WordProcessing document, which is generated from HTML |
| 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. |
| XmlEditOptions | Allows to specify custom options for editing 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 |
#### Structures

| Structure | Description |
| --- | --- |
| 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. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IEditOptions | Common interface for all options, which are responsible for document-to-HTML conversions. Declares no members. |
| 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 loading the file in Markdown format |
| ISaveOptions | Interface for all saving options for all documents types. Declares no members. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FontEmbeddingOptions | Font embedding options controls which font resources should be embedded into the output WordProcessing or PDF document |
| FontExtractionOptions | Font extraction options control which fonts should be extracted and from where |
| MailMessageOutput | Controls which parts of the mail message should be delivered to the output processing |
| MarkdownImageLoadingAction | Defines the mode of image loading while opening for editing the file in Markdown format |
| MarkdownTableContentAlignment | Allows to specify the alignment of the content of the table to be used when exporting into Markdown format |
| PdfCompliance | Specifies the PDF standards compliance level |
| TextDirection | Represents 3 possible variants how to treat text direction in the plain text documents |
| TextLeadingSpacesOptions | Contains available options for leading space handling during opening plain text document (TXT) |
| TextTrailingSpacesOptions | Contains available options for trailing space handling during opening plain text document (TXT) |
| WordProcessingProtectionType | Represents all available protection types of the WordProcessing document |
| WorksheetProtectionType | Represents Spreadsheet worksheet (tab) protection types |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### DelimitedTextEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions.md

#### DelimitedTextEditOptions class

Options for loading text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

```csharp
public sealed class DelimitedTextEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DelimitedTextEditOptions(string) | Creates an instance of options class for delimited text with mandatory separator (delimiter) |

#### Properties

| Name | Description |
| --- | --- |
| ConvertDateTimeData { get; set; } | Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is `false`. |
| ConvertNumericData { get; set; } | Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is `false`. |
| OptimizeMemoryUsage { get; set; } | 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). |
| Separator { get; set; } | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| TreatConsecutiveDelimitersAsOne { get; set; } | Defines whether consecutive delimiters should be treated as one. By default is `false`. |

##### Remarks

https://en.wikipedia.org/wiki/Delimiter-separated_values

### ConvertDateTimeData
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/convertdatetimedata.md

#### DelimitedTextEditOptions.ConvertDateTimeData property

Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is `false`.

```csharp
public bool ConvertDateTimeData { get; set; }
```

### ConvertNumericData
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/convertnumericdata.md

#### DelimitedTextEditOptions.ConvertNumericData property

Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is `false`.

```csharp
public bool ConvertNumericData { get; set; }
```

### DelimitedTextEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/delimitedtexteditoptions.md

#### DelimitedTextEditOptions constructor

Creates an instance of options class for delimited text with mandatory separator (delimiter)

```csharp
public DelimitedTextEditOptions(string separator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| separator | String | Mandatory separator (delimiter), that cannot be NULL or empty |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Is thrown when specxified separator is a null or empty string |

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/optimizememoryusage.md

#### DelimitedTextEditOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### Separator
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/separator.md

#### DelimitedTextEditOptions.Separator property

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

```csharp
public string Separator { get; set; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Is thrown when specified separator is a null or empty string |

### TreatConsecutiveDelimitersAsOne
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtexteditoptions/treatconsecutivedelimitersasone.md

#### DelimitedTextEditOptions.TreatConsecutiveDelimitersAsOne property

Defines whether consecutive delimiters should be treated as one. By default is `false`.

```csharp
public bool TreatConsecutiveDelimitersAsOne { get; set; }
```

### DelimitedTextSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions.md

#### DelimitedTextSaveOptions class

Contains options for generating and saving text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

```csharp
public sealed class DelimitedTextSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DelimitedTextSaveOptions() | This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through `Separator` property) |
| DelimitedTextSaveOptions(string) | Creates an instance of options class for delimited text with mandatory separator (delimiter) |

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; set; } | Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8. |
| KeepSeparatorsForBlankRow { get; set; } | Indicates whether separators should be output for blank row. Default value is `false` which means the content for blank row will be empty. |
| Separator { get; set; } | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| TrimLeadingBlankRowAndColumn { get; set; } | Indicates whether leading blank rows and columns should be trimmed like what MS Excel does |

##### Remarks

https://en.wikipedia.org/wiki/Delimiter-separated_values

### DelimitedTextSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions/delimitedtextsaveoptions.md

#### DelimitedTextSaveOptions()

This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through `Separator` property)

```csharp
public DelimitedTextSaveOptions()
```

#### DelimitedTextSaveOptions(string)

Creates an instance of options class for delimited text with mandatory separator (delimiter)

```csharp
public DelimitedTextSaveOptions(string separator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| separator | String | String separator (delimiter), that cannot be NULL or empty |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Is thrown when specxified separator is a null or empty string |

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions/encoding.md

#### DelimitedTextSaveOptions.Encoding property

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8.

```csharp
public Encoding Encoding { get; set; }
```

### KeepSeparatorsForBlankRow
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions/keepseparatorsforblankrow.md

#### DelimitedTextSaveOptions.KeepSeparatorsForBlankRow property

Indicates whether separators should be output for blank row. Default value is `false` which means the content for blank row will be empty.

```csharp
public bool KeepSeparatorsForBlankRow { get; set; }
```

### Separator
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions/separator.md

#### DelimitedTextSaveOptions.Separator property

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

```csharp
public string Separator { get; set; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Is thrown when specified separator is a null or empty string |

### TrimLeadingBlankRowAndColumn
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/delimitedtextsaveoptions/trimleadingblankrowandcolumn.md

#### DelimitedTextSaveOptions.TrimLeadingBlankRowAndColumn property

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does

```csharp
public bool TrimLeadingBlankRowAndColumn { get; set; }
```

### EbookEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebookeditoptions.md

#### EbookEditOptions class

Allows to specify and adjust custom options for editing E-book documents in all supported formats: ePub, MOBI, and AZW3.

```csharp
public sealed class EbookEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EbookEditOptions() | Initializes a new instance of the `EbookEditOptions` class, where all options are set to their default values |
| EbookEditOptions(bool) | Initializes a new instance of the `EbookEditOptions` class with specified pagination mode |

#### Properties

| Name | Description |
| --- | --- |
| EnableLanguageInformation { get; set; } | 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`). |
| EnablePagination { get; set; } | Allows to enable or disable pagination in the resultant HTML document. By default is disabled (`false`). |

##### Remarks

Supported E-book formats:

1. [ePub](https://docs.fileformat.com/ebook/epub/) (Electronic Publication)
2. [MOBI](https://docs.fileformat.com/ebook/mobi/) (MobiPocket)
3. [AZW3](https://docs.fileformat.com/ebook/azw3/) (Kindle Format 8t)

### EbookEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebookeditoptions/ebookeditoptions.md

#### EbookEditOptions()

Initializes a new instance of the `EbookEditOptions` class, where all options are set to their default values

```csharp
public EbookEditOptions()
```

#### EbookEditOptions(bool)

Initializes a new instance of the `EbookEditOptions` class with specified pagination mode

```csharp
public EbookEditOptions(bool enablePagination)
```

| 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`). |

### EnableLanguageInformation
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebookeditoptions/enablelanguageinformation.md

#### EbookEditOptions.EnableLanguageInformation property

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`).

```csharp
public bool EnableLanguageInformation { get; set; }
```

### EnablePagination
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebookeditoptions/enablepagination.md

#### EbookEditOptions.EnablePagination property

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (`false`).

```csharp
public bool EnablePagination { get; set; }
```

##### Remarks

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) — not. This option allows to control how the e-book content should be represented in HTML/CSS while editing — in the float (`false`) or paged (`true`) view.

### EbookSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebooksaveoptions.md

#### EbookSaveOptions class

Allows to specify custom options for generating and saving the document in all supportable e-Book formats: ePub, MOBI, and AZW3.

```csharp
public sealed class EbookSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EbookSaveOptions() | This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through `OutputFormat` property) |
| EbookSaveOptions(EBookFormats) | Creates a new instance of `EbookSaveOptions` with specified mandatory e-Book output format, while all other parameters are default |

#### Properties

| Name | Description |
| --- | --- |
| ExportDocumentProperties { get; set; } | Specifies whether to export built-in and custom document properties in resultant file. Default value is `false`. |
| OutputFormat { get; set; } | Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3. |
| SplitHeadingLevel { get; set; } | 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. |

##### Remarks

Supported E-book formats:

1. [ePub](https://docs.fileformat.com/ebook/epub/) (Electronic Publication)
2. [MOBI](https://docs.fileformat.com/ebook/mobi/) (MobiPocket)
3. [AZW3](https://docs.fileformat.com/ebook/azw3/) (Kindle Format 8t)

### EbookSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebooksaveoptions/ebooksaveoptions.md

#### EbookSaveOptions()

This parameterless constructor creates a new instance of EbookSaveOptions with ePub output format (can be modified then through `OutputFormat` property)

```csharp
public EbookSaveOptions()
```

#### EbookSaveOptions(EBookFormats)

Creates a new instance of `EbookSaveOptions` with specified mandatory e-Book output format, while all other parameters are default

```csharp
public EbookSaveOptions(EBookFormats outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | EBookFormats | andatory output format, in which the e-Book should be saved |

### ExportDocumentProperties
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebooksaveoptions/exportdocumentproperties.md

#### EbookSaveOptions.ExportDocumentProperties property

Specifies whether to export built-in and custom document properties in resultant file. Default value is `false`.

```csharp
public bool ExportDocumentProperties { get; set; }
```

### OutputFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebooksaveoptions/outputformat.md

#### EbookSaveOptions.OutputFormat property

Specifies the format of the resultant e-Book file: IDPF ePub, MOBI, or AZW3.

```csharp
public EBookFormats OutputFormat { get; set; }
```

### SplitHeadingLevel
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ebooksaveoptions/splitheadinglevel.md

#### EbookSaveOptions.SplitHeadingLevel property

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.

```csharp
public int SplitHeadingLevel { get; set; }
```

##### Remarks

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.

### EmailEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emaileditoptions.md

#### EmailEditOptions class

Allows to specify custom options for editing documents in the different electronic mail (email) formats

```csharp
public sealed class EmailEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailEditOptions() | Initializes a new instance of the `EmailEditOptions` class, where all options are set to their default values |
| EmailEditOptions(MailMessageOutput) | Initializes a new instance of the `EmailEditOptions` class with `MailMessageOutput` parameter |

#### Properties

| Name | Description |
| --- | --- |
| MailMessageOutput { get; set; } | Allows to control which parts of the mail message should be delivered to the output `EditableDocument` and then to the emitted HTML |

### EmailEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emaileditoptions/emaileditoptions.md

#### EmailEditOptions()

Initializes a new instance of the `EmailEditOptions` class, where all options are set to their default values

```csharp
public EmailEditOptions()
```

#### EmailEditOptions(MailMessageOutput)

Initializes a new instance of the `EmailEditOptions` class with `MailMessageOutput` parameter

```csharp
public EmailEditOptions(MailMessageOutput mailMessageOutput)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mailMessageOutput | MailMessageOutput | The mail message output, which also can be specified through the property |

### MailMessageOutput
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emaileditoptions/mailmessageoutput.md

#### EmailEditOptions.MailMessageOutput property

Allows to control which parts of the mail message should be delivered to the output `EditableDocument` and then to the emitted HTML

```csharp
public MailMessageOutput MailMessageOutput { get; set; }
```

##### Property Value

Flagged enum that controls the parts of the mail message, which should be processed. Default value is All

### EmailSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emailsaveoptions.md

#### EmailSaveOptions class

Allows to specify custom options for generating and saving electronic mail (email) documents

```csharp
public sealed class EmailSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailSaveOptions() | Initializes a new instance of the `EmailSaveOptions` class, where all options are set to their default values |
| EmailSaveOptions(MailMessageOutput) | Initializes a new instance of the `EmailSaveOptions` class with `MailMessageOutput` parameter |

#### Properties

| Name | Description |
| --- | --- |
| MailMessageOutput { get; set; } | 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 `Save` method |

### EmailSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emailsaveoptions/emailsaveoptions.md

#### EmailSaveOptions()

Initializes a new instance of the `EmailSaveOptions` class, where all options are set to their default values

```csharp
public EmailSaveOptions()
```

#### EmailSaveOptions(MailMessageOutput)

Initializes a new instance of the `EmailSaveOptions` class with `MailMessageOutput` parameter

```csharp
public EmailSaveOptions(MailMessageOutput mailMessageOutput)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mailMessageOutput | MailMessageOutput | The mail message output, which also can be specified through the property |

### MailMessageOutput
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/emailsaveoptions/mailmessageoutput.md

#### EmailSaveOptions.MailMessageOutput property

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 `Save` method

```csharp
public MailMessageOutput MailMessageOutput { get; set; }
```

##### Property Value

Flagged enum that controls the parts of the mail message, which should be processed. Default value is All

### FixedLayoutEditOptionsBase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fixedlayouteditoptionsbase.md

#### FixedLayoutEditOptionsBase class

Base abstract class for the options for all documents of fixed-layout formats like PDF and XPS

```csharp
public abstract class FixedLayoutEditOptionsBase : IEditOptions
```

#### Properties

| Name | Description |
| --- | --- |
| EnablePagination { get; set; } | Allows to enable (true) or disable (false) pagination in the resultant HTML document. By default is disabled (false). |
| Pages { get; set; } | Allows to set a page range to process. By default all pages of a fixed-layout document are processed. |
| SkipImages { get; set; } | 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. |

### EnablePagination
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fixedlayouteditoptionsbase/enablepagination.md

#### FixedLayoutEditOptionsBase.EnablePagination property

Allows to enable (true) or disable (false) pagination in the resultant HTML document. By default is disabled (false).

```csharp
public bool EnablePagination { get; set; }
```

##### Remarks

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.

### Pages
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fixedlayouteditoptionsbase/pages.md

#### FixedLayoutEditOptionsBase.Pages property

Allows to set a page range to process. By default all pages of a fixed-layout document are processed.

```csharp
public PageRange Pages { get; set; }
```

### SkipImages
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fixedlayouteditoptionsbase/skipimages.md

#### FixedLayoutEditOptionsBase.SkipImages property

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.

```csharp
public bool SkipImages { get; set; }
```

### FontEmbeddingOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fontembeddingoptions.md

#### FontEmbeddingOptions enumeration

Font embedding options controls which font resources should be embedded into the output WordProcessing or PDF document

```csharp
public enum FontEmbeddingOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NotEmbed | `0` | Do not embed any font resource neither from EditableDocument nor from the system. Default value. |
| EmbedAll | `1` | Analize document content from input EditableDocument, find all used fonts and embed them into output WordProcessing or PDF 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. |
| EmbedWithoutSystem | `2` | Exact to EmbedAll, but exclude those fonts, which are treated by OS as system fonts |

##### Remarks

Font embedding options are applied during document saving (from intermediate EditableDocument into output WordProcessing or PDF format), this enum is included as a property in the WordProcessingSaveOptions and PdfSaveOptions, from where it should be used

### FontExtractionOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/fontextractionoptions.md

#### FontExtractionOptions enumeration

Font extraction options control which fonts should be extracted and from where

```csharp
public enum FontExtractionOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NotExtract | `0` | Does not extract any font resource neither from document nor from the system. Default value. |
| ExtractAllEmbedded | `1` | Extracts all font resources, which are embedded into the input Word document, regardless of what they are: custom or system. |
| ExtractEmbeddedWithoutSystem | `2` | Extracts only those embedded font resources, which are custom (not system) |
| ExtractAll | `3` | Tries to extract all fonts, which are used in the input WordProcessing document, including system fonts. |

### HtmlSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions.md

#### HtmlSaveOptions class

Allows to specify custom options for saving the `EditableDocument` instance to the HTML format

```csharp
public sealed class HtmlSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| HtmlSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AttributeValueDelimiter { get; set; } | Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote |
| EmbedStylesheetsIntoMarkup { get; set; } | 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-&gt;HEAD section (`true`) |
| HtmlTagCase { get; set; } | 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 |
| SavingCallback { get; set; } | Interface, which must be implemented by the end-user for saving all the external HTML resources. This property **must** not be `null`, otherwise the GroupDocs.Editor will throw an exception while saving `EditableDocument` to HTML format. |

### AttributeValueDelimiter
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions/attributevaluedelimiter.md

#### HtmlSaveOptions.AttributeValueDelimiter property

Controls which delimiter around the attribute values in HTML elements will be used: single quote (default value) or double quote

```csharp
public QuoteType AttributeValueDelimiter { get; set; }
```

### EmbedStylesheetsIntoMarkup
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions/embedstylesheetsintomarkup.md

#### HtmlSaveOptions.EmbedStylesheetsIntoMarkup property

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-&gt;HEAD section (`true`)

```csharp
public bool EmbedStylesheetsIntoMarkup { get; set; }
```

### HtmlSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions/htmlsaveoptions.md

#### HtmlSaveOptions constructor

The default constructor.

```csharp
public HtmlSaveOptions()
```

### HtmlTagCase
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions/htmltagcase.md

#### HtmlSaveOptions.HtmlTagCase property

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

```csharp
public TagRenderingCase HtmlTagCase { get; set; }
```

### SavingCallback
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/htmlsaveoptions/savingcallback.md

#### HtmlSaveOptions.SavingCallback property

Interface, which must be implemented by the end-user for saving all the external HTML resources. This property **must** not be `null`, otherwise the GroupDocs.Editor will throw an exception while saving `EditableDocument` to HTML format.

```csharp
public IHtmlSavingCallback SavingCallback { get; set; }
```

##### Remarks

If the value of `EmbedStylesheetsIntoMarkup` property is set to `true`, all the stylesheets will be embedded to the HTML markup and thus they will not be passed to this saving callback

### IEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ieditoptions.md

#### IEditOptions interface

Common interface for all options, which are responsible for document-to-HTML conversions. Declares no members.

```csharp
public interface IEditOptions
```

### IHtmlSavingCallback
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ihtmlsavingcallback.md

#### IHtmlSavingCallback interface

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

```csharp
public interface IHtmlSavingCallback
```

#### Methods

| Name | Description |
| --- | --- |
| SaveOneResource(IHtmlResource) | Instance method, that is triggered during the `Save` method call and which must be implemented by the end-user in order to obtain and save the provided HTML resource and then return a link to this resource back to the invoker. |

### SaveOneResource
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/ihtmlsavingcallback/saveoneresource.md

#### IHtmlSavingCallback.SaveOneResource method

Instance method, that is triggered during the `Save` method call and which must be implemented by the end-user in order to obtain and save the provided HTML resource and then return a link to this resource back to the invoker.

```csharp
public string SaveOneResource(IHtmlResource resource)
```

| Parameter | Type | Description |
| --- | --- | --- |
| resource | IHtmlResource | HTML resource of any kind (images and fonts, my be stylesheets if they are not embedded in the HTML markup), that is passed by the GroupDocs.Editor to the user-defined implementation of this interface, obtained by the user, and user is able to do any necessary procedures like saving, sending, converting it etc. GroupDocs.Editor will never pass a `null` HTML resource to this method. |

##### Return Value

A link (reference) to the resource, obtained in the *resource* parameter, that user must provide to the GroupDocs.Editor, so the GroupDocs.Editor will put this link to the HTML markup.

##### Remarks

GroupDocs.Editor expects that the user-defined implementation of this method does not throw exception while execution. However, when exception do occur, GroupDocs.Editor will write a value of `FilenameWithExtension` property to the HTML markup.

### ILoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/iloadoptions.md

#### ILoadOptions interface

Common interface for all option classes, responsible for loading documents of different type formats

```csharp
public interface ILoadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | In implementing class should allow to set a password for the encoded password-protected document. By default password is not used - string has a NULL value. |

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/iloadoptions/password.md

#### ILoadOptions.Password property

In implementing class should allow to set a password for the encoded password-protected document. By default password is not used - string has a NULL value.

```csharp
public string Password { get; set; }
```

### IMarkdownImageLoadCallback
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/imarkdownimageloadcallback.md

#### IMarkdownImageLoadCallback interface

Implement this interface if you want to control how GroupDocs.Editor load images when loading the file in Markdown format

```csharp
public interface IMarkdownImageLoadCallback
```

#### Methods

| Name | Description |
| --- | --- |
| ProcessImage(MarkdownImageLoadArgs) | Called when GroupDocs.Editor finds a link to the external image while parsing the Markdown code |

### ProcessImage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/imarkdownimageloadcallback/processimage.md

#### IMarkdownImageLoadCallback.ProcessImage method

Called when GroupDocs.Editor finds a link to the external image while parsing the Markdown code

```csharp
public MarkdownImageLoadingAction ProcessImage(MarkdownImageLoadArgs args)
```

| Parameter | Type | Description |
| --- | --- | --- |
| args | MarkdownImageLoadArgs | The arguments, provided by the GroupDocs.Editor to the end-user code |

### ISaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/isaveoptions.md

#### ISaveOptions interface

Interface for all saving options for all documents types. Declares no members.

```csharp
public interface ISaveOptions
```

### MailMessageOutput
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mailmessageoutput.md

#### MailMessageOutput enumeration

Controls which parts of the mail message should be delivered to the output processing

```csharp
[Flags]
public enum MailMessageOutput
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | None of the email message parts will be processed |
| Body | `1` | Process body of the mail message |
| Subject | `2` | Process subject of the mail message |
| Date | `4` | Process date and time when message was delivered |
| To | `8` | Process all recipients of the mail message |
| Cc | `10` | Process all CC recipients of the mail message |
| Bcc | `20` | Process all BCC recipients of the mail message |
| From | `40` | Process sender of the mail message |
| Attachments | `80` | Process all attachments of the mail message |
| Metadata | `100` | Process all other technical metadata (sensitivity, priority, encoding, MIME, X-Mailer, etc) |
| Common | `7B` | Common output - body with all main metadata |
| All | `1FF` | Full output - body with all metadata |

### MarkdownEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdowneditoptions.md

#### MarkdownEditOptions class

Allows to specify custom options for editing documents in Markdown (MD) format

```csharp
public sealed class MarkdownEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MarkdownEditOptions() | Creates and returns a new instance of the MarkdownEditOptions class, where all options are set to their default values |

#### Properties

| Name | Description |
| --- | --- |
| ImageLoadCallback { get; set; } | Allows to control how external images are loaded when opening a Markdown document for editing |

### ImageLoadCallback
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdowneditoptions/imageloadcallback.md

#### MarkdownEditOptions.ImageLoadCallback property

Allows to control how external images are loaded when opening a Markdown document for editing

```csharp
public IMarkdownImageLoadCallback ImageLoadCallback { get; set; }
```

##### Property Value

The image loading callback, that should be provided by the user for correct loading of the external images

### MarkdownEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdowneditoptions/markdowneditoptions.md

#### MarkdownEditOptions constructor

Creates and returns a new instance of the MarkdownEditOptions class, where all options are set to their default values

```csharp
public MarkdownEditOptions()
```

### MarkdownImageLoadArgs
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadargs.md

#### MarkdownImageLoadArgs class

Provides data for the ProcessImage event.

```csharp
public class MarkdownImageLoadArgs
```

#### Constructors

| Name | Description |
| --- | --- |
| MarkdownImageLoadArgs() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ImageFileName { get; set; } | Gets or sets the image filename (as is in the Markdown document) that was discovered in the Markdown code and is processing |
| IsAbsoluteUri { get; set; } | Get a value indicating whether this image has absolute URI link. |

#### Methods

| Name | Description |
| --- | --- |
| SetData(byte[]) | Sets user provided data of the image which is used in ProcessImage |

### ImageFileName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadargs/imagefilename.md

#### MarkdownImageLoadArgs.ImageFileName property

Gets or sets the image filename (as is in the Markdown document) that was discovered in the Markdown code and is processing

```csharp
public string ImageFileName { get; set; }
```

### IsAbsoluteUri
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadargs/isabsoluteuri.md

#### MarkdownImageLoadArgs.IsAbsoluteUri property

Get a value indicating whether this image has absolute URI link.

```csharp
public bool IsAbsoluteUri { get; set; }
```

##### Property Value

`true` if this image has absolute URI link; otherwise, `false`.

### MarkdownImageLoadArgs
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadargs/markdownimageloadargs.md

#### MarkdownImageLoadArgs constructor

The default constructor.

```csharp
public MarkdownImageLoadArgs()
```

### SetData
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadargs/setdata.md

#### MarkdownImageLoadArgs.SetData method

Sets user provided data of the image which is used in ProcessImage

```csharp
public void SetData(byte[] data)
```

### MarkdownImageLoadingAction
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownimageloadingaction.md

#### MarkdownImageLoadingAction enumeration

Defines the mode of image loading while opening for editing the file in Markdown format

```csharp
public enum MarkdownImageLoadingAction
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | GroupDocs.Editor will load this resource as usual |
| Skip | `1` | GroupDocs.Editor will skip loading of this image |
| UserProvided | `2` | GroupDocs.Editor will use byte array provided by user in `SetData` as image data |

### MarkdownSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions.md

#### MarkdownSaveOptions class

Allows to specify custom options for generating and saving Markdown documents

```csharp
public sealed class MarkdownSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MarkdownSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ExportImagesAsBase64 { get; set; } | Specifies whether images are saved in Base64 format to the output file. Default is `false`. |
| ImagesFolder { get; set; } | Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null. |
| OptimizeMemoryUsage { get; set; } | 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). |
| TableContentAlignment { get; set; } | Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is Auto. |

##### Remarks

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.

### ExportImagesAsBase64
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions/exportimagesasbase64.md

#### MarkdownSaveOptions.ExportImagesAsBase64 property

Specifies whether images are saved in Base64 format to the output file. Default is `false`.

```csharp
public bool ExportImagesAsBase64 { get; set; }
```

##### Remarks

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 `ImagesFolder` property.

### ImagesFolder
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions/imagesfolder.md

#### MarkdownSaveOptions.ImagesFolder property

Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null.

```csharp
public string ImagesFolder { get; set; }
```

##### Remarks

If neither the `ImagesFolder` nor `ExportImagesAsBase64` are specified by the user, then the GroupDocs.Editor will try to determine the `ImagesFolder` by itself and apply it on success

### MarkdownSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions/markdownsaveoptions.md

#### MarkdownSaveOptions constructor

The default constructor.

```csharp
public MarkdownSaveOptions()
```

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions/optimizememoryusage.md

#### MarkdownSaveOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### TableContentAlignment
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdownsaveoptions/tablecontentalignment.md

#### MarkdownSaveOptions.TableContentAlignment property

Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is Auto.

```csharp
public MarkdownTableContentAlignment TableContentAlignment { get; set; }
```

##### Property Value

The table content alignment

### MarkdownTableContentAlignment
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/markdowntablecontentalignment.md

#### MarkdownTableContentAlignment enumeration

Allows to specify the alignment of the content of the table to be used when exporting into Markdown format

```csharp
public enum MarkdownTableContentAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | The alignment will be taken from the first paragraph in corresponding table column |
| Left | `1` | The content of tables will be aligned to the Left |
| Center | `2` | The content of tables will be aligned to the Center |
| Right | `3` | The content of tables will be aligned to the Right |

### MhtmlSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mhtmlsaveoptions.md

#### MhtmlSaveOptions class

Allows to specify custom options for generating and saving the MHTML (MIME encapsulation of aggregate HTML documents) documents

```csharp
public sealed class MhtmlSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MhtmlSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ExportCidUrls { get; set; } | Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. Default value is `false`. |
| ExportDocumentProperties { get; set; } | Specifies whether to export built-in and custom document properties to MHTML. Default value is `false`. |
| ExportLanguageInformation { get; set; } | Specifies whether language information is exported to MHTML. Default value is `false`. |

### ExportCidUrls
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mhtmlsaveoptions/exportcidurls.md

#### MhtmlSaveOptions.ExportCidUrls property

Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. Default value is `false`.

```csharp
public bool ExportCidUrls { get; set; }
```

##### Remarks

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.

### ExportDocumentProperties
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mhtmlsaveoptions/exportdocumentproperties.md

#### MhtmlSaveOptions.ExportDocumentProperties property

Specifies whether to export built-in and custom document properties to MHTML. Default value is `false`.

```csharp
public bool ExportDocumentProperties { get; set; }
```

### ExportLanguageInformation
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mhtmlsaveoptions/exportlanguageinformation.md

#### MhtmlSaveOptions.ExportLanguageInformation property

Specifies whether language information is exported to MHTML. Default value is `false`.

```csharp
public bool ExportLanguageInformation { get; set; }
```

##### Remarks

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.

### MhtmlSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/mhtmlsaveoptions/mhtmlsaveoptions.md

#### MhtmlSaveOptions constructor

The default constructor.

```csharp
public MhtmlSaveOptions()
```

### PageRange
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange.md

#### PageRange structure

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.

```csharp
public struct PageRange : IEquatable<PageRange>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Numbers of pages within range. If 0 - page range spreads until end of the document no matter how much pages it consists of |
| EndNumber { get; } | 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 |
| IsDefault { get; } | Indicates whether this instance represents a default "fully open" page range i.e. it represents all pages of a document (true) or not (false) |
| StartNumber { get; } | Inclusive start page number, from which this page range starts. If 1 - page range starts from the first page of a document |

#### Methods

| Name | Description |
| --- | --- |
| static FromBeginningWithCount(ushort) | Creates a page range, that starts from the first page and has specified amount of pages |
| static FromStartPageTillEnd(ushort) | Creates a page range, that starts from the specified page number and continues till the end of the document |
| static FromStartPageTillEndPage(ushort, ushort) | Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively) |
| static FromStartPageWithCount(ushort, ushort) | Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end) |
| Equals(PageRange) | Detects whether this instance of PageRange is equal to specified |

#### Fields

| Name | Description |
| --- | --- |
| static readonly AllPages | Represents all existing pages of a document. Default value. |

##### Remarks

Immutable struct, that encapsulates a page range, which is not related to any specific document, and can represent a page range for any document.

### AllPages
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/allpages.md

#### PageRange.AllPages field

Represents all existing pages of a document. Default value.

```csharp
public static readonly PageRange AllPages;
```

### Count
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/count.md

#### PageRange.Count property

Numbers of pages within range. If 0 - page range spreads until end of the document no matter how much pages it consists of

```csharp
public ushort Count { get; }
```

### EndNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/endnumber.md

#### PageRange.EndNumber property

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

```csharp
public ushort EndNumber { get; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/equals.md

#### PageRange.Equals method

Detects whether this instance of PageRange is equal to specified

```csharp
public bool Equals(PageRange other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | PageRange | Other PageRange instance to check on equality |

##### Return Value

true is are equal; false if are unequal

### FromBeginningWithCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/frombeginningwithcount.md

#### PageRange.FromBeginningWithCount method

Creates a page range, that starts from the first page and has specified amount of pages

```csharp
public static PageRange FromBeginningWithCount(ushort pageCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageCount | UInt16 | Number of pages, must be strictly bigger than zero |

##### Return Value

New PageRange instance

### FromStartPageTillEnd
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/fromstartpagetillend.md

#### PageRange.FromStartPageTillEnd method

Creates a page range, that starts from the specified page number and continues till the end of the document

```csharp
public static PageRange FromStartPageTillEnd(ushort startPageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | UInt16 | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |

##### Return Value

New PageRange instance

### FromStartPageTillEndPage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/fromstartpagetillendpage.md

#### PageRange.FromStartPageTillEndPage method

Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively)

```csharp
public static PageRange FromStartPageTillEndPage(ushort startPageNumber, ushort endPageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | UInt16 | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| endPageNumber | UInt16 | 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* |

### FromStartPageWithCount
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/fromstartpagewithcount.md

#### PageRange.FromStartPageWithCount method

Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end)

```csharp
public static PageRange FromStartPageWithCount(ushort startPageNumber, ushort pageCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startPageNumber | UInt16 | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| pageCount | UInt16 | Number of pages, must be strictly bigger than zero. If zero - this means all pages till the end of a document |

##### Return Value

New PageRange instance

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/isdefault.md

#### PageRange.IsDefault property

Indicates whether this instance represents a default "fully open" page range i.e. it represents all pages of a document (true) or not (false)

```csharp
public bool IsDefault { get; }
```

### StartNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pagerange/startnumber.md

#### PageRange.StartNumber property

Inclusive start page number, from which this page range starts. If 1 - page range starts from the first page of a document

```csharp
public ushort StartNumber { get; }
```

### PdfCompliance
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfcompliance.md

#### PdfCompliance enumeration

Specifies the PDF standards compliance level

```csharp
public enum PdfCompliance
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pdf17 | `0` | PDF 1.7 (ISO 32000-1) standard |
| Pdf20 | `1` | PDF 2.0 (ISO 32000-2) standard |
| PdfA1a | `2` | 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. |
| PdfA1b | `3` | PDF/A-1b (ISO 19005-1). PDF/A-1b has the objective of ensuring reliable reproduction of the visual appearance of the document. |
| PdfA2a | `4` | 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. |
| PdfA2u | `5` | 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 | `6` | 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. |

### PdfEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfeditoptions.md

#### PdfEditOptions class

Allows to specify custom options for editing PDF documents

```csharp
public sealed class PdfEditOptions : FixedLayoutEditOptionsBase
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfEditOptions() | Creates and returns a new instance of the PdfEditOptions class, where all options are set to their default values |
| PdfEditOptions(bool) | Creates and returns a new instance of the PdfEditOptions class with specified pagination and default all other options |

#### Properties

| Name | Description |
| --- | --- |
| EnablePagination { get; set; } | Allows to enable (true) or disable (false) pagination in the resultant HTML document. By default is disabled (false). |
| Pages { get; set; } | Allows to set a page range to process. By default all pages of a fixed-layout document are processed. |
| SkipImages { get; set; } | 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. |

### PdfEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfeditoptions/pdfeditoptions.md

#### PdfEditOptions()

Creates and returns a new instance of the PdfEditOptions class, where all options are set to their default values

```csharp
public PdfEditOptions()
```

#### PdfEditOptions(bool)

Creates and returns a new instance of the PdfEditOptions class with specified pagination and default all other options

```csharp
public PdfEditOptions(bool enablePagination)
```

| Parameter | Type | Description |
| --- | --- | --- |
| enablePagination | Boolean | Pagination flag, that enables HTML output, adjusted for paged mode |

### PdfLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfloadoptions.md

#### PdfLoadOptions class

Contains options for loading PDF documents into Editor class

```csharp
public sealed class PdfLoadOptions : ILoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfLoadOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Allows to specify, modify and obtain the password, which will be used for opening a PDF document, if it is encoded. Set to NULL or empty string in order to not use the password (default value). |

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfloadoptions/password.md

#### PdfLoadOptions.Password property

Allows to specify, modify and obtain the password, which will be used for opening a PDF document, if it is encoded. Set to NULL or empty string in order to not use the password (default value).

```csharp
public string Password { get; set; }
```

### PdfLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfloadoptions/pdfloadoptions.md

#### PdfLoadOptions constructor

The default constructor.

```csharp
public PdfLoadOptions()
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions.md

#### PdfSaveOptions class

Allows to specify custom options for generating and saving PDF (Portable Document Format) documents

```csharp
public sealed class PdfSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Compliance { get; set; } | Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf17. |
| FontEmbedding { get; set; } | Responsible for embedding font resources, which are used in the original document, into the resultant PDF document. By default doesn't embed any fonts (NotEmbed). |
| OptimizeMemoryUsage { get; set; } | 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). |
| Password { get; set; } | 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 — password is not applied. |

### Compliance
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions/compliance.md

#### PdfSaveOptions.Compliance property

Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf17.

```csharp
public PdfCompliance Compliance { get; set; }
```

### FontEmbedding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions/fontembedding.md

#### PdfSaveOptions.FontEmbedding property

Responsible for embedding font resources, which are used in the original document, into the resultant PDF document. By default doesn't embed any fonts (NotEmbed).

```csharp
public FontEmbeddingOptions FontEmbedding { get; set; }
```

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions/optimizememoryusage.md

#### PdfSaveOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions/password.md

#### PdfSaveOptions.Password property

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 — password is not applied.

```csharp
public string Password { get; set; }
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/pdfsaveoptions/pdfsaveoptions.md

#### PdfSaveOptions constructor

The default constructor.

```csharp
public PdfSaveOptions()
```

### PresentationEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationeditoptions.md

#### PresentationEditOptions class

Allows to specify custom options for editing documents of all supportable Presentation (PowerPoint-compatible) formats

```csharp
public class PresentationEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationEditOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ShowHiddenSlides { get; set; } | 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. |
| SlideNumber { get; set; } | Allows to specify the slide numbers, which should be opened for editing |

### PresentationEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationeditoptions/presentationeditoptions.md

#### PresentationEditOptions constructor

The default constructor.

```csharp
public PresentationEditOptions()
```

### ShowHiddenSlides
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationeditoptions/showhiddenslides.md

#### PresentationEditOptions.ShowHiddenSlides property

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.

```csharp
public bool ShowHiddenSlides { get; set; }
```

### SlideNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationeditoptions/slidenumber.md

#### PresentationEditOptions.SlideNumber property

Allows to specify the slide numbers, which should be opened for editing

```csharp
public int SlideNumber { get; set; }
```

##### Remarks

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` option is set to 'false', the exception will be thrown.

### PresentationLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationloadoptions.md

#### PresentationLoadOptions class

Allows to specify custom options for loading documents of all supportable Presentation formats like PPT(X), PPTM, PPS(X) etc.

```csharp
public class PresentationLoadOptions : ILoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationLoadOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | 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. |

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationloadoptions/password.md

#### PresentationLoadOptions.Password property

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.

```csharp
public string Password { get; set; }
```

##### Remarks

By default this property has NULL value — 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.

### PresentationLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationloadoptions/presentationloadoptions.md

#### PresentationLoadOptions constructor

The default constructor.

```csharp
public PresentationLoadOptions()
```

### PresentationSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions.md

#### PresentationSaveOptions class

Allows to specify custom options for generating and saving Presentation (PowerPoint-compatible) documents

```csharp
public sealed class PresentationSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationSaveOptions() | This parameterless constructor creates a new instance of PresentationSaveOptions with PPTX output format (can be modified then through `OutputFormat` property) |
| PresentationSaveOptions(PresentationFormats) | Creates a new instance of PresentationSaveOptions with specified mandatory Presentation output format, while all other parameters are default |

#### Properties

| Name | Description |
| --- | --- |
| InsertAsNewSlide { get; set; } | Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the `SlideNumber` property, or it should be injected between existing slide and previous one, without replacing its content. By default is `false` — existing slide will be replaced. This property is ignored, if value of `SlideNumber` property is set to `'0'`. |
| OutputFormat { get; set; } | Allows to specify a Presentation format, which will be used for saving the document |
| Password { get; set; } | 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. |
| SlideNumber { get; set; } | 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. |
| SlideNumbersToDelete { get; set; } | 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 |

##### Remarks

Instance of this class should be passed into the  method in order to save edited presentation into the final document of some Presentation-specific format. All other parameters are optional and may be omitted, by default the format of the saving presentation is PPTX, but it can be changed through constructor or property.

### InsertAsNewSlide
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/insertasnewslide.md

#### PresentationSaveOptions.InsertAsNewSlide property

Boolean flag, which specifies whether edited slide should replace the existing slide in original presentation on the position, specified by the `SlideNumber` property, or it should be injected between existing slide and previous one, without replacing its content. By default is `false` — existing slide will be replaced. This property is ignored, if value of `SlideNumber` property is set to `'0'`.

```csharp
public bool InsertAsNewSlide { get; set; }
```

##### Remarks

By default slide is replaced. This means that if given presentation has 5 slides, and `SlideNumber`=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.

### OutputFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/outputformat.md

#### PresentationSaveOptions.OutputFormat property

Allows to specify a Presentation format, which will be used for saving the document

```csharp
public PresentationFormats OutputFormat { get; set; }
```

##### Remarks

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.

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/password.md

#### PresentationSaveOptions.Password property

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.

```csharp
public string Password { get; set; }
```

### PresentationSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/presentationsaveoptions.md

#### PresentationSaveOptions()

This parameterless constructor creates a new instance of PresentationSaveOptions with PPTX output format (can be modified then through `OutputFormat` property)

```csharp
public PresentationSaveOptions()
```

#### PresentationSaveOptions(PresentationFormats)

Creates a new instance of PresentationSaveOptions with specified mandatory Presentation output format, while all other parameters are default

```csharp
public PresentationSaveOptions(PresentationFormats outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | PresentationFormats | Mandatory output format, in which the Presentation document should be saved |

### SlideNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/slidenumber.md

#### PresentationSaveOptions.SlideNumber property

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.

```csharp
public int SlideNumber { get; set; }
```

##### Remarks

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" — 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` boolean property is tightly coupled with this one.

##### Examples

Given presentation has 5 slides: SlideNumber = 0; — ignore given presentation, create a new presentation and put edited slide into it. SlideNumber = 1; — replace the first slide with edited SlideNumber = 2; — replace the second slide with edited SlideNumber = 5; — replace the last (5th) slide with edited SlideNumber = 6; — replace the last (5th) slide with edited, because 6 is greater then 5 and thus is adjusted SlideNumber = -1; — replace the last (5th) slide with edited, because "-1" means "last existing" SlideNumber = -2; — replace the 4th slide with edited SlideNumber = -3; — replace the 3rd slide with edited SlideNumber = -4; — replace the 2nd slide with edited SlideNumber = -5; — replace the first slide with edited SlideNumber = -6; — replace the first slide with edited, because "-6" is greater then 5 and thus is adjusted

### SlideNumbersToDelete
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/presentationsaveoptions/slidenumberstodelete.md

#### PresentationSaveOptions.SlideNumbersToDelete property

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

```csharp
public int[] SlideNumbersToDelete { get; set; }
```

##### Remarks

When the edited slide is saved not as a new single-slide presentation (default behavior), but instead is saved into an existing presentation (using `SlideNumber` property), 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` — 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 (lesser than 1 or greater than the total number of slides) will be ignored.

### SpreadsheetEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions.md

#### SpreadsheetEditOptions class

Allows to specify custom options for editing documents of all supportable Spreadsheet (Excel-compatible) formats

```csharp
public class SpreadsheetEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetEditOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ExcludeHiddenWorksheets { get; set; } | 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. |
| ExportBogusRowData { get; set; } | When enabled, the HTML table in produced HTML document contains an empty bottom hidden row with zero height and empty cells, where only width is specified. This row with empty cells contains exact width values for each column and improves backward conversion from HTML to Spreadsheet. By default is enabled (`true`). |
| MergeEmptyAdjacentCells { get; set; } | When enabled, the empty adjucent horizontal cells from the input Spreadsheet document will be represented in editable HTML document as merged into a single cell with corresponding `colspan` attribute. By default is disabled (`false`). |
| WorksheetIndex { get; set; } | 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). |

### ExcludeHiddenWorksheets
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions/excludehiddenworksheets.md

#### SpreadsheetEditOptions.ExcludeHiddenWorksheets property

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.

```csharp
public bool ExcludeHiddenWorksheets { get; set; }
```

##### Remarks

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`' property.

### ExportBogusRowData
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions/exportbogusrowdata.md

#### SpreadsheetEditOptions.ExportBogusRowData property

When enabled, the HTML table in produced HTML document contains an empty bottom hidden row with zero height and empty cells, where only width is specified. This row with empty cells contains exact width values for each column and improves backward conversion from HTML to Spreadsheet. By default is enabled (`true`).

```csharp
public bool ExportBogusRowData { get; set; }
```

### MergeEmptyAdjacentCells
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions/mergeemptyadjacentcells.md

#### SpreadsheetEditOptions.MergeEmptyAdjacentCells property

When enabled, the empty adjucent horizontal cells from the input Spreadsheet document will be represented in editable HTML document as merged into a single cell with corresponding `colspan` attribute. By default is disabled (`false`).

```csharp
public bool MergeEmptyAdjacentCells { get; set; }
```

##### Remarks

By default the GroupDocs.Editor converts a table from input Spreadsheet document to the output HTML document by preserving each cell. However, the Spreadsheet documents may be sparse — they may contain huge amount of "empty areas", where a lot of cells are empty. This option, when enabled, merges such empty cells into one with `colspan` attribute in the `TD` element, and thus can significantly reduce the size of the produced HTML markup.

### SpreadsheetEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions/spreadsheeteditoptions.md

#### SpreadsheetEditOptions constructor

The default constructor.

```csharp
public SpreadsheetEditOptions()
```

### WorksheetIndex
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheeteditoptions/worksheetindex.md

#### SpreadsheetEditOptions.WorksheetIndex property

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).

```csharp
public int WorksheetIndex { get; set; }
```

##### 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).

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

Contains options for loading binary Spreadsheet (Cells, Excel-compatible) documents like XLS(X), ODS etc. into Editor class

```csharp
public sealed class SpreadsheetLoadOptions : ILoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Default parameterless constructor - all parameters have default values |

#### Properties

| Name | Description |
| --- | --- |
| OptimizeMemoryUsage { get; set; } | 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). |
| Password { get; set; } | 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). |

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetloadoptions/optimizememoryusage.md

#### SpreadsheetLoadOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetloadoptions/password.md

#### SpreadsheetLoadOptions.Password property

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).

```csharp
public string Password { get; set; }
```

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetloadoptions/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions constructor

Default parameterless constructor - all parameters have default values

```csharp
public SpreadsheetLoadOptions()
```

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents

```csharp
public sealed class SpreadsheetSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetSaveOptions() | This parameterless constructor creates a new instance of SpreadsheetSaveOptions with XLSX output format (can be modified then through `OutputFormat` property) |
| SpreadsheetSaveOptions(SpreadsheetFormats) | Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default |

#### Properties

| Name | Description |
| --- | --- |
| InsertAsNewWorksheet { get; set; } | Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the `WorksheetNumber` property, or it should be injected between existing worksheet and previous one, without replacing its content. By default is false — existing worksheet will be replaced. This property is ignored, if value of `WorksheetNumber` property is set to '0'. |
| OutputFormat { get; set; } | Allows to specify a Spreadsheet format, which will be used for saving the document |
| Password { get; set; } | 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. |
| WorksheetNumber { get; set; } | 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. |
| WorksheetNumbersToDelete { get; set; } | 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 |
| WorksheetProtection { get; set; } | 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. |

### InsertAsNewWorksheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/insertasnewworksheet.md

#### SpreadsheetSaveOptions.InsertAsNewWorksheet property

Boolean flag, which specifies whether edited worksheet should replace the existing worksheet in original spreadsheet on the position, specified by the `WorksheetNumber` property, or it should be injected between existing worksheet and previous one, without replacing its content. By default is false — existing worksheet will be replaced. This property is ignored, if value of `WorksheetNumber` property is set to '0'.

```csharp
public bool InsertAsNewWorksheet { get; set; }
```

##### Remarks

By default worksheet is replaced. This means that if given spreadsheet has 5 worksheets, and `WorksheetNumber`=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.

### OutputFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/outputformat.md

#### SpreadsheetSaveOptions.OutputFormat property

Allows to specify a Spreadsheet format, which will be used for saving the document

```csharp
public SpreadsheetFormats OutputFormat { get; set; }
```

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/password.md

#### SpreadsheetSaveOptions.Password property

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.

```csharp
public string Password { get; set; }
```

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions()

This parameterless constructor creates a new instance of SpreadsheetSaveOptions with XLSX output format (can be modified then through `OutputFormat` property)

```csharp
public SpreadsheetSaveOptions()
```

#### SpreadsheetSaveOptions(SpreadsheetFormats)

Creates a new instance of SpreadsheetSaveOptions with specified mandatory Spreadsheet output format, while all other parameters are default

```csharp
public SpreadsheetSaveOptions(SpreadsheetFormats outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | SpreadsheetFormats | Mandatory output format, in which the Spreadsheet document should be saved |

### WorksheetNumber
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/worksheetnumber.md

#### SpreadsheetSaveOptions.WorksheetNumber property

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.

```csharp
public int WorksheetNumber { get; set; }
```

##### Remarks

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" — 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` boolean property is tightly coupled with this one.

##### Examples

Given spreadsheet has 5 worksheets: WorksheetNumber = 0; — ignore given spreadsheet, create a new spreadsheet and put edited worksheet into it. WorksheetNumber = 1; — replace the first worksheet with edited WorksheetNumber = 2; — replace the second worksheet with edited WorksheetNumber = 5; — replace the last (5th) worksheet with edited WorksheetNumber = 6; — replace the last (5th) worksheet with edited, because 6 is greater then 5 and thus is adjusted WorksheetNumber = -1; — replace the last (5th) worksheet with edited, because "-1" means "last existing" WorksheetNumber = -2; — replace the 4th worksheet with edited WorksheetNumber = -3; — replace the 3rd worksheet with edited WorksheetNumber = -4; — replace the 2nd worksheet with edited WorksheetNumber = -5; — replace the first worksheet with edited WorksheetNumber = -6; — replace the first worksheet with edited, because "-6" is greater then 5 and thus is adjusted

### WorksheetNumbersToDelete
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/worksheetnumberstodelete.md

#### SpreadsheetSaveOptions.WorksheetNumbersToDelete property

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

```csharp
public int[] WorksheetNumbersToDelete { get; set; }
```

##### Remarks

When the edited worksheet is saved not as a new single-worksheet spreadsheet (default behavior), but instead is saved into an existing spreadsheet (using `WorksheetNumber` property), 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` — 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 (lesser than 1 or greater than the total number of worksheets) will be ignored.

### WorksheetProtection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/spreadsheetsaveoptions/worksheetprotection.md

#### SpreadsheetSaveOptions.WorksheetProtection property

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.

```csharp
public WorksheetProtection WorksheetProtection { get; set; }
```

### TextDirection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textdirection.md

#### TextDirection enumeration

Represents 3 possible variants how to treat text direction in the plain text documents

```csharp
public enum TextDirection
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| LeftToRight | `0` | Left-to-Right direction, usual text, default value. |
| RightToLeft | `1` | Right-to-Left direction |
| Auto | `2` | 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. |

### TextEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions.md

#### TextEditOptions class

Allows to specify custom options for loading plain text (TXT) documents

```csharp
public class TextEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextEditOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Direction { get; set; } | Allows to specify the direction of text flow in the input plain text document. By default is Left-to-Right. |
| EnablePagination { get; set; } | Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false). |
| Encoding { get; set; } | Character encoding of the text document, which will be applied for its opening |
| LeadingSpaces { get; set; } | Gets or sets preferred option of a leading space handling. By default converts leading spaces to the left indent. |
| RecognizeLists { get; set; } | Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true. |
| TrailingSpaces { get; set; } | Gets or sets preferred option of a trailing space handling. By default truncates all trailing spaces. |

### Direction
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/direction.md

#### TextEditOptions.Direction property

Allows to specify the direction of text flow in the input plain text document. By default is Left-to-Right.

```csharp
public TextDirection Direction { get; set; }
```

### EnablePagination
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/enablepagination.md

#### TextEditOptions.EnablePagination property

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

```csharp
public bool EnablePagination { get; set; }
```

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/encoding.md

#### TextEditOptions.Encoding property

Character encoding of the text document, which will be applied for its opening

```csharp
public Encoding Encoding { get; set; }
```

### LeadingSpaces
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/leadingspaces.md

#### TextEditOptions.LeadingSpaces property

Gets or sets preferred option of a leading space handling. By default converts leading spaces to the left indent.

```csharp
public TextLeadingSpacesOptions LeadingSpaces { get; set; }
```

### RecognizeLists
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/recognizelists.md

#### TextEditOptions.RecognizeLists property

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.

```csharp
public bool RecognizeLists { 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.

### TextEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/texteditoptions.md

#### TextEditOptions constructor

The default constructor.

```csharp
public TextEditOptions()
```

### TrailingSpaces
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texteditoptions/trailingspaces.md

#### TextEditOptions.TrailingSpaces property

Gets or sets preferred option of a trailing space handling. By default truncates all trailing spaces.

```csharp
public TextTrailingSpacesOptions TrailingSpaces { get; set; }
```

### TextLeadingSpacesOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textleadingspacesoptions.md

#### TextLeadingSpacesOptions enumeration

Contains available options for leading space handling during opening plain text document (TXT)

```csharp
public enum TextLeadingSpacesOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ConvertToIndent | `0` | Convert one or more consecutive spaces to the left indent. Default value. |
| Preserve | `1` | Pass all leading spaces to the output HTML "as is", without touching them |
| Trim | `2` | Trim (truncate) all leading spaces completely |

### TextSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textsaveoptions.md

#### TextSaveOptions class

Allows to specify custom options for generating and saving plain text (TXT) documents

```csharp
public sealed class TextSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AddBidiMarks { get; set; } | Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. Default is 'false' — do not add BiDi marks. |
| Encoding { get; set; } | Character encoding of the text document, which will be applied for its saving |
| PreserveTableLayout { get; set; } | Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false. |

### AddBidiMarks
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textsaveoptions/addbidimarks.md

#### TextSaveOptions.AddBidiMarks property

Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format. Default is 'false' — do not add BiDi marks.

```csharp
public bool AddBidiMarks { get; set; }
```

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textsaveoptions/encoding.md

#### TextSaveOptions.Encoding property

Character encoding of the text document, which will be applied for its saving

```csharp
public Encoding Encoding { get; set; }
```

### PreserveTableLayout
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textsaveoptions/preservetablelayout.md

#### TextSaveOptions.PreserveTableLayout property

Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false.

```csharp
public bool PreserveTableLayout { get; set; }
```

### TextSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/textsaveoptions/textsaveoptions.md

#### TextSaveOptions constructor

The default constructor.

```csharp
public TextSaveOptions()
```

### TextTrailingSpacesOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/texttrailingspacesoptions.md

#### TextTrailingSpacesOptions enumeration

Contains available options for trailing space handling during opening plain text document (TXT)

```csharp
public enum TextTrailingSpacesOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Trim | `0` | Trim (truncate) all trailing spaces completely. Default value. |
| Preserve | `1` | Pass all trailing spaces to the output HTML "as is", without touching them |

### WebFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont.md

#### WebFont class

Represents a font settings for the web

```csharp
public sealed class WebFont : ICloneable, IEquatable<WebFont>
```

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | Font color in ARGB32 format |
| Line { get; set; } | Sets a line or combination of lines, applied to the text |
| Name { get; set; } | Sets the font name. If not specified, the default font will be used |
| Size { get; set; } | Sets the size of the font in absolute or relative units |
| Style { get; set; } | Sets whether a font should be styled with a normal, italic, or oblique face from its font-family. |
| Weight { get; set; } | Sets the weight (or boldness) of the font |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Creates and returns a full deep copy of this `WebFont` instance |
| override Equals(object) | Determines whether this instance of WebFont is equal to specified uncasted object |
| Equals(WebFont) | Determines whether this instance of WebFont is equal to specified |

### Clone
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/clone.md

#### WebFont.Clone method

Creates and returns a full deep copy of this `WebFont` instance

```csharp
public WebFont Clone()
```

##### Return Value

New `WebFont` instance, that is a full and deep copy of this one

### Color
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/color.md

#### WebFont.Color property

Font color in ARGB32 format

```csharp
public ArgbColor Color { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/equals.md

#### Equals(WebFont)

Determines whether this instance of WebFont is equal to specified

```csharp
public bool Equals(WebFont other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | WebFont | Another WebFont to check equality, may be NULL |

##### Return Value

true if equal, false if unequal

#### Equals(object)

Determines whether this instance of WebFont is equal to specified uncasted object

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Object, that is expected to be a `WebFont` instance |

##### Return Value

true if equal, false if unequal

### Line
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/line.md

#### WebFont.Line property

Sets a line or combination of lines, applied to the text

```csharp
public TextDecorationLineType Line { get; set; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/name.md

#### WebFont.Name property

Sets the font name. If not specified, the default font will be used

```csharp
public string Name { get; set; }
```

### Size
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/size.md

#### WebFont.Size property

Sets the size of the font in absolute or relative units

```csharp
public FontSize Size { get; set; }
```

### Style
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/style.md

#### WebFont.Style property

Sets whether a font should be styled with a normal, italic, or oblique face from its font-family.

```csharp
public FontStyle Style { get; set; }
```

### Weight
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/webfont/weight.md

#### WebFont.Weight property

Sets the weight (or boldness) of the font

```csharp
public FontWeight Weight { get; set; }
```

### WordProcessingEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions.md

#### WordProcessingEditOptions class

Allows to specify custom options for editing documents of all supportable WordProcessing (Words-compliant) formats like DOC(X), RTF, ODT etc.

```csharp
public class WordProcessingEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingEditOptions() | Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values |
| WordProcessingEditOptions(bool) | Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options |

#### Properties

| Name | Description |
| --- | --- |
| EnableLanguageInformation { get; set; } | 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). |
| EnablePagination { get; set; } | Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false). |
| ExtractOnlyUsedFont { get; set; } | Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document. |
| FontExtraction { get; set; } | Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract). |
| InputControlsClassName { get; set; } | 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. |
| UseInlineStyles { get; set; } | 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`). |

### EnableLanguageInformation
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/enablelanguageinformation.md

#### WordProcessingEditOptions.EnableLanguageInformation property

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).

```csharp
public bool EnableLanguageInformation { get; set; }
```

### EnablePagination
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/enablepagination.md

#### WordProcessingEditOptions.EnablePagination property

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

```csharp
public bool EnablePagination { get; set; }
```

### ExtractOnlyUsedFont
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/extractonlyusedfont.md

#### WordProcessingEditOptions.ExtractOnlyUsedFont property

Gets or sets a value indicating whether extract only font resources that are used in the textual content of the document.

```csharp
public bool ExtractOnlyUsedFont { get; set; }
```

##### Property 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`.

##### Remarks

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.

### FontExtraction
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/fontextraction.md

#### WordProcessingEditOptions.FontExtraction property

Responsible for extracting font resources, which are used in the input WordProcessing document. By default doesn't extract any fonts (NotExtract).

```csharp
public FontExtractionOptions FontExtraction { get; set; }
```

### InputControlsClassName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/inputcontrolsclassname.md

#### WordProcessingEditOptions.InputControlsClassName property

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.

```csharp
public string InputControlsClassName { get; set; }
```

##### Remarks

Almost all formats from WordProcessing format family contain fields — 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.

### UseInlineStyles
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/useinlinestyles.md

#### WordProcessingEditOptions.UseInlineStyles property

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`).

```csharp
public bool UseInlineStyles { get; set; }
```

### WordProcessingEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingeditoptions/wordprocessingeditoptions.md

#### WordProcessingEditOptions()

Creates and returns a new instance of the WordProcessingEditOptions class, where all options are set to their default values

```csharp
public WordProcessingEditOptions()
```

#### WordProcessingEditOptions(bool)

Creates and returns a new instance of the WordProcessingEditOptions class with specified pagination and default all other options

```csharp
public WordProcessingEditOptions(bool enablePagination)
```

| Parameter | Type | Description |
| --- | --- | --- |
| enablePagination | Boolean | Pagination flag, that enables HTML output, adjusted for paged mode |

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

Contains options for loading WordProcessing (Word-compatible) documents like DOC(X), RTF, ODT etc. into Editor class

```csharp
public sealed class WordProcessingLoadOptions : ILoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingLoadOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | 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). |

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingloadoptions/password.md

#### WordProcessingLoadOptions.Password property

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).

```csharp
public string Password { get; set; }
```

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingloadoptions/wordprocessingloadoptions.md

#### WordProcessingLoadOptions constructor

The default constructor.

```csharp
public WordProcessingLoadOptions()
```

### WordProcessingProtection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingprotection.md

#### WordProcessingProtection class

Encapsulates document protection options for the WordProcessing document, which is generated from HTML

```csharp
public sealed class WordProcessingProtection
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingProtection() | Parameterless constructor - all parameters have default values |
| WordProcessingProtection(WordProcessingProtectionType, string) | Allows to set all parameters during class instantiation |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | The password to protect the document with. If null or empty string - the protection will not be applied to the document. |
| ProtectionType { get; set; } | Allows to set a protection type of the document. By default is set to not protect the document at all. |

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingprotection/password.md

#### WordProcessingProtection.Password property

The password to protect the document with. If null or empty string - the protection will not be applied to the document.

```csharp
public string Password { get; set; }
```

### ProtectionType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingprotection/protectiontype.md

#### WordProcessingProtection.ProtectionType property

Allows to set a protection type of the document. By default is set to not protect the document at all.

```csharp
public WordProcessingProtectionType ProtectionType { get; set; }
```

### WordProcessingProtection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingprotection/wordprocessingprotection.md

#### WordProcessingProtection()

Parameterless constructor - all parameters have default values

```csharp
public WordProcessingProtection()
```

#### WordProcessingProtection(WordProcessingProtectionType, string)

Allows to set all parameters during class instantiation

```csharp
public WordProcessingProtection(WordProcessingProtectionType protectionType, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | WordProcessingProtectionType | Set the protection type of the document |
| password | String | Set the protection password |

### WordProcessingProtectionType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingprotectiontype.md

#### WordProcessingProtectionType enumeration

Represents all available protection types of the WordProcessing document

```csharp
public enum WordProcessingProtectionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NoProtection | `0` | The document is not protected. Default value. |
| AllowOnlyRevisions | `1` | User can only add revision marks to the document |
| AllowOnlyComments | `2` | User can only modify comments in the document |
| AllowOnlyFormFields | `3` | User can only enter data in the form fields in the document |
| ReadOnly | `4` | No changes are allowed to the document |

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Allows to specify custom options for generating and saving WordProcessing-compliant documents after they were edited

```csharp
public sealed class WordProcessingSaveOptions : ICloneable, ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingSaveOptions() | This parameterless constructor creates a new instance of WordProcessingSaveOptions with DOCX output format (can be modified then through `OutputFormat` property) |
| WordProcessingSaveOptions(WordProcessingFormats) | Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default |

#### Properties

| Name | Description |
| --- | --- |
| EnablePagination { get; set; } | Allows to enable or disable pagination which will be used for saving the WordProcessing document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled. |
| FontEmbedding { get; set; } | Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed). |
| Locale { get; set; } | 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. |
| LocaleBi { get; set; } | 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. |
| LocaleFarEast { get; set; } | 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. |
| OptimizeMemoryUsage { get; set; } | 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). |
| OutputFormat { get; set; } | Allows to specify a WordProcessing format, which will be used for saving the document |
| Password { get; set; } | 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. |
| Protection { get; set; } | 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. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Creates and returns a full copy of this instance of WordProcessingSaveOptions class |

##### Remarks

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.

### Clone
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/clone.md

#### WordProcessingSaveOptions.Clone method

Creates and returns a full copy of this instance of WordProcessingSaveOptions class

```csharp
public WordProcessingSaveOptions Clone()
```

##### Return Value

New WordProcessingSaveOptions instance

### EnablePagination
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/enablepagination.md

#### WordProcessingSaveOptions.EnablePagination property

Allows to enable or disable pagination which will be used for saving the WordProcessing document. If the original document was opened and edited in pagination mode, this option also should be enabled. By default is disabled.

```csharp
public bool EnablePagination { get; set; }
```

### FontEmbedding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/fontembedding.md

#### WordProcessingSaveOptions.FontEmbedding property

Responsible for embedding font resources into output WordProcessing document. By default doesn't embed any fonts (NotEmbed).

```csharp
public FontEmbeddingOptions FontEmbedding { get; set; }
```

### Locale
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/locale.md

#### WordProcessingSaveOptions.Locale property

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.

```csharp
public CultureInfo Locale { get; set; }
```

##### Remarks

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.

### LocaleBi
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/localebi.md

#### WordProcessingSaveOptions.LocaleBi property

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.

```csharp
public CultureInfo LocaleBi { get; set; }
```

##### Remarks

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.

### LocaleFarEast
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/localefareast.md

#### WordProcessingSaveOptions.LocaleFarEast property

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.

```csharp
public CultureInfo LocaleFarEast { get; set; }
```

##### Remarks

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.

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/optimizememoryusage.md

#### WordProcessingSaveOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### OutputFormat
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/outputformat.md

#### WordProcessingSaveOptions.OutputFormat property

Allows to specify a WordProcessing format, which will be used for saving the document

```csharp
public WordProcessingFormats OutputFormat { get; set; }
```

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/password.md

#### WordProcessingSaveOptions.Password property

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.

```csharp
public string Password { get; set; }
```

### Protection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/protection.md

#### WordProcessingSaveOptions.Protection property

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.

```csharp
public WordProcessingProtection Protection { get; set; }
```

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/wordprocessingsaveoptions/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions()

This parameterless constructor creates a new instance of WordProcessingSaveOptions with DOCX output format (can be modified then through `OutputFormat` property)

```csharp
public WordProcessingSaveOptions()
```

#### WordProcessingSaveOptions(WordProcessingFormats)

Creates a new instance of WordProcessingSaveOptions with specified mandatory WordProcessing output format, while all other parameters are default

```csharp
public WordProcessingSaveOptions(WordProcessingFormats outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | WordProcessingFormats | Mandatory output format, in which the WordProcessing document should be saved |

### WorksheetProtection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/worksheetprotection.md

#### WorksheetProtection class

Encapsulates worksheet protection options, which allow to protect a worksheet in the output Spreadsheet document from modification of specified type with a specified password.

```csharp
public sealed class WorksheetProtection
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetProtection() | Creates new instance with default parameters. If not modified and passed to SpreadsheetSaveOptions, no worksheet protection will be applied |
| WorksheetProtection(WorksheetProtectionType, string) | Creates new instance with specified worksheet protection type and password |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Password, which is used for protecting a worksheet. If NULL or empty string, the protection will not be applied. |
| ProtectionType { get; set; } | Allows to specify a type of worksheet protection. By default is 'None' - protection is not applied. |

##### Remarks

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.

### Password
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/worksheetprotection/password.md

#### WorksheetProtection.Password property

Password, which is used for protecting a worksheet. If NULL or empty string, the protection will not be applied.

```csharp
public string Password { get; set; }
```

### ProtectionType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/worksheetprotection/protectiontype.md

#### WorksheetProtection.ProtectionType property

Allows to specify a type of worksheet protection. By default is 'None' - protection is not applied.

```csharp
public WorksheetProtectionType ProtectionType { get; set; }
```

### WorksheetProtection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/worksheetprotection/worksheetprotection.md

#### WorksheetProtection()

Creates new instance with default parameters. If not modified and passed to SpreadsheetSaveOptions, no worksheet protection will be applied

```csharp
public WorksheetProtection()
```

#### WorksheetProtection(WorksheetProtectionType, string)

Creates new instance with specified worksheet protection type and password

```csharp
public WorksheetProtection(WorksheetProtectionType protectionType, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | WorksheetProtectionType | Type of worksheet protection |
| password | String | Password, that locks the protection |

### WorksheetProtectionType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/worksheetprotectiontype.md

#### WorksheetProtectionType enumeration

Represents Spreadsheet worksheet (tab) protection types

```csharp
public enum WorksheetProtectionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Protection is not applied (default value) |
| All | `1` | User cannot modify anything on the worksheet |
| Contents | `2` | User cannot enter data in the worksheet |
| Objects | `3` | User cannot modify drawing objects |
| Scenarios | `4` | User cannot modify saved scenarios |
| Structure | `5` | User cannot modify the structure |
| Window | `6` | User cannot modify the window |

### XmlEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions.md

#### XmlEditOptions class

Allows to specify custom options for editing XML (eXtensible Markup Language) documents and converting them to the HTML

```csharp
public sealed class XmlEditOptions : IEditOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlEditOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AttributeValuesQuoteType { get; set; } | Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default. |
| Encoding { get; set; } | Character encoding of the text document, which will be applied for its opening. By default is null — internal document encoding will be applied. |
| FixIncorrectStructure { get; set; } | Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false). |
| FormatOptions { get; } | 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. |
| HighlightOptions { get; } | 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. |
| RecognizeEmails { get; set; } | Allows to enable recognition algorithm for email addresses in attribute values |
| RecognizeUris { get; set; } | Allows to enable URI recognition algorithm |
| TrimTrailingWhitespaces { get; set; } | Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) — trailing whitespaces will be preserved. |

### AttributeValuesQuoteType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/attributevaluesquotetype.md

#### XmlEditOptions.AttributeValuesQuoteType property

Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.

```csharp
public QuoteType AttributeValuesQuoteType { get; set; }
```

### Encoding
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/encoding.md

#### XmlEditOptions.Encoding property

Character encoding of the text document, which will be applied for its opening. By default is null — internal document encoding will be applied.

```csharp
public Encoding Encoding { get; set; }
```

### FixIncorrectStructure
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/fixincorrectstructure.md

#### XmlEditOptions.FixIncorrectStructure property

Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).

```csharp
public bool FixIncorrectStructure { get; set; }
```

##### Remarks

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.

### FormatOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/formatoptions.md

#### XmlEditOptions.FormatOptions property

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.

```csharp
public XmlFormatOptions FormatOptions { get; }
```

### HighlightOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/highlightoptions.md

#### XmlEditOptions.HighlightOptions property

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.

```csharp
public XmlHighlightOptions HighlightOptions { get; }
```

### RecognizeEmails
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/recognizeemails.md

#### XmlEditOptions.RecognizeEmails property

Allows to enable recognition algorithm for email addresses in attribute values

```csharp
public bool RecognizeEmails { get; set; }
```

### RecognizeUris
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/recognizeuris.md

#### XmlEditOptions.RecognizeUris property

Allows to enable URI recognition algorithm

```csharp
public bool RecognizeUris { get; set; }
```

### TrimTrailingWhitespaces
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/trimtrailingwhitespaces.md

#### XmlEditOptions.TrimTrailingWhitespaces property

Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) — trailing whitespaces will be preserved.

```csharp
public bool TrimTrailingWhitespaces { get; set; }
```

### XmlEditOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmleditoptions/xmleditoptions.md

#### XmlEditOptions constructor

The default constructor.

```csharp
public XmlEditOptions()
```

### XmlFormatOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlformatoptions.md

#### XmlFormatOptions class

Contains options, that allow to adjust the formatting of XML document, when it is represented as HTML

```csharp
public sealed class XmlFormatOptions : IEditOptions
```

#### Properties

| Name | Description |
| --- | --- |
| EachAttributeFromNewline { get; set; } | 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) — all attribute-value pairs are placed in a single line. |
| IsDefault { get; } | Indicates whether this instance of XML formatting options has a default value |
| LeafTextNodesOnNewline { get; set; } | 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. By default is false (disabled) — leaf text nodes are placed on the same line as their parents, without new indent. |
| LeftIndent { get; set; } | Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt |

### EachAttributeFromNewline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlformatoptions/eachattributefromnewline.md

#### XmlFormatOptions.EachAttributeFromNewline property

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) — all attribute-value pairs are placed in a single line.

```csharp
public bool EachAttributeFromNewline { get; set; }
```

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlformatoptions/isdefault.md

#### XmlFormatOptions.IsDefault property

Indicates whether this instance of XML formatting options has a default value

```csharp
public bool IsDefault { get; }
```

### LeafTextNodesOnNewline
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlformatoptions/leaftextnodesonnewline.md

#### XmlFormatOptions.LeafTextNodesOnNewline property

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. By default is false (disabled) — leaf text nodes are placed on the same line as their parents, without new indent.

```csharp
public bool LeafTextNodesOnNewline { get; set; }
```

### LeftIndent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlformatoptions/leftindent.md

#### XmlFormatOptions.LeftIndent property

Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt

```csharp
public Length LeftIndent { get; set; }
```

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Specified length value is unitless non-zero |

### XmlHighlightOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions.md

#### XmlHighlightOptions class

Contains options, that allow to customize the XML highlighting during XML-to-HTML conversion

```csharp
public sealed class XmlHighlightOptions : IEditOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AttributeNamesFontSettings { get; } | Responsible for representing the font of attribute names |
| AttributeValuesFontSettings { get; } | Responsible for representing the font of attribute values |
| CDataFontSettings { get; } | Responsible for representing the font of CDATA sections (including pair of opening and closing tags) |
| HtmlCommentsFontSettings { get; } | Responsible for representing the font of HTML comments (including pair of opening and closing tags) |
| InnerTextFontSettings { get; } | Responsible for representing the font of inner-tag text |
| IsDefault { get; } | Determines whether this XML Highlight options object has a default font settings |
| XmlTagsFontSettings { get; } | Responsible for representing the font of XML tags (angle brackets with tag names) |

#### Methods

| Name | Description |
| --- | --- |
| ResetToDefault() | Resets the current font settings to their default values |

### AttributeNamesFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/attributenamesfontsettings.md

#### XmlHighlightOptions.AttributeNamesFontSettings property

Responsible for representing the font of attribute names

```csharp
public WebFont AttributeNamesFontSettings { get; }
```

### AttributeValuesFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/attributevaluesfontsettings.md

#### XmlHighlightOptions.AttributeValuesFontSettings property

Responsible for representing the font of attribute values

```csharp
public WebFont AttributeValuesFontSettings { get; }
```

### CDataFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/cdatafontsettings.md

#### XmlHighlightOptions.CDataFontSettings property

Responsible for representing the font of CDATA sections (including pair of opening and closing tags)

```csharp
public WebFont CDataFontSettings { get; }
```

### HtmlCommentsFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/htmlcommentsfontsettings.md

#### XmlHighlightOptions.HtmlCommentsFontSettings property

Responsible for representing the font of HTML comments (including pair of opening and closing tags)

```csharp
public WebFont HtmlCommentsFontSettings { get; }
```

### InnerTextFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/innertextfontsettings.md

#### XmlHighlightOptions.InnerTextFontSettings property

Responsible for representing the font of inner-tag text

```csharp
public WebFont InnerTextFontSettings { get; }
```

### IsDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/isdefault.md

#### XmlHighlightOptions.IsDefault property

Determines whether this XML Highlight options object has a default font settings

```csharp
public bool IsDefault { get; }
```

### ResetToDefault
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/resettodefault.md

#### XmlHighlightOptions.ResetToDefault method

Resets the current font settings to their default values

```csharp
public void ResetToDefault()
```

### XmlTagsFontSettings
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xmlhighlightoptions/xmltagsfontsettings.md

#### XmlHighlightOptions.XmlTagsFontSettings property

Responsible for representing the font of XML tags (angle brackets with tag names)

```csharp
public WebFont XmlTagsFontSettings { get; }
```

### XpsSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xpssaveoptions.md

#### XpsSaveOptions class

Allows to specify custom options for generating and saving XPS (XML Paper Specifications) documents

```csharp
public sealed class XpsSaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| XpsSaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| OptimizeMemoryUsage { get; set; } | 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). |

##### Remarks

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. It was developed 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.

### OptimizeMemoryUsage
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xpssaveoptions/optimizememoryusage.md

#### XpsSaveOptions.OptimizeMemoryUsage property

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).

```csharp
public bool OptimizeMemoryUsage { get; set; }
```

### XpsSaveOptions
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.options/xpssaveoptions/xpssaveoptions.md

#### XpsSaveOptions constructor

The default constructor.

```csharp
public XpsSaveOptions()
```

### GroupDocs.Editor.Words.FieldManagement
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement.md

Contains classes and interfaces related to the management and manipulation of form fields within documents. This namespace provides functionality to work with various types of form fields, such as text fields, checkboxes, dropdowns, etc., allowing users to interact with and modify form fields programmatically.

#### Classes

| Class | Description |
| --- | --- |
| CheckBoxForm | Represents a form field that displays a checkbox. |
| CurrentDateFormField | Represents a form field that displays the current date. |
| CurrentTimeFormField | Represents a form field that displays the current time. |
| DateFormField | Represents a form field that displays a date. |
| DropDownFormField | Represents a form field that displays a drop-down list. |
| FormFieldCollection | Represents a collection of form fields. |
| HelpText | Represents help text for a form field. |
| InvalidFormField | Represents the update of invalid form field names during the `FixInvalidFormFieldNames` operation. |
| NumberFormField | Represents a form field that accepts a number input. |
| TextFormField | Represents a form field that accepts text input. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IFormField | Represents a form field. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FormFieldType | Specifies the type of form field. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### CheckBoxForm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform.md

#### CheckBoxForm class

Represents a form field that displays a checkbox.

```csharp
public sealed class CheckBoxForm : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| CheckBoxForm(string, string) | Initializes a new instance of the `CheckBoxForm` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.CheckBox for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents the state of the checkbox. |

### CheckBoxForm
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/checkboxform.md

#### CheckBoxForm constructor

Initializes a new instance of the `CheckBoxForm` class with the specified stylesheet and name.

```csharp
public CheckBoxForm(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/helptext.md

#### CheckBoxForm.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/localeid.md

#### CheckBoxForm.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
checkBoxField.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/name.md

#### CheckBoxForm.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/readonly.md

#### CheckBoxForm.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/statustext.md

#### CheckBoxForm.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/stylesheet.md

#### CheckBoxForm.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/type.md

#### CheckBoxForm.Type property

Gets the type of the form field, which is always FormFieldType.CheckBox for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/checkboxform/value.md

#### CheckBoxForm.Value property

Gets or sets the value of the form field, which represents the state of the checkbox.

```csharp
public bool Value { get; set; }
```

### CurrentDateFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield.md

#### CurrentDateFormField class

Represents a form field that displays the current date.

```csharp
public sealed class CurrentDateFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| CurrentDateFormField(string, string) | Initializes a new instance of the `CurrentDateFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.CurrentDate for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents the current date. |

### CurrentDateFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/currentdateformfield.md

#### CurrentDateFormField constructor

Initializes a new instance of the `CurrentDateFormField` class with the specified stylesheet and name.

```csharp
public CurrentDateFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/helptext.md

#### CurrentDateFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/localeid.md

#### CurrentDateFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/name.md

#### CurrentDateFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/readonly.md

#### CurrentDateFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/statustext.md

#### CurrentDateFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/stylesheet.md

#### CurrentDateFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/type.md

#### CurrentDateFormField.Type property

Gets the type of the form field, which is always FormFieldType.CurrentDate for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currentdateformfield/value.md

#### CurrentDateFormField.Value property

Gets or sets the value of the form field, which represents the current date.

```csharp
public DateTime Value { get; set; }
```

### CurrentTimeFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield.md

#### CurrentTimeFormField class

Represents a form field that displays the current time.

```csharp
public sealed class CurrentTimeFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| CurrentTimeFormField(string, string) | Initializes a new instance of the `CurrentTimeFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.CurrentTime for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents the current time. |

### CurrentTimeFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/currenttimeformfield.md

#### CurrentTimeFormField constructor

Initializes a new instance of the `CurrentTimeFormField` class with the specified stylesheet and name.

```csharp
public CurrentTimeFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/helptext.md

#### CurrentTimeFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/localeid.md

#### CurrentTimeFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/name.md

#### CurrentTimeFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/readonly.md

#### CurrentTimeFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/statustext.md

#### CurrentTimeFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/stylesheet.md

#### CurrentTimeFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/type.md

#### CurrentTimeFormField.Type property

Gets the type of the form field, which is always FormFieldType.CurrentTime for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/currenttimeformfield/value.md

#### CurrentTimeFormField.Value property

Gets or sets the value of the form field, which represents the current time.

```csharp
public DateTime Value { get; set; }
```

### DateFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield.md

#### DateFormField class

Represents a form field that displays a date.

```csharp
public sealed class DateFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| DateFormField(string, string) | Initializes a new instance of the `DateFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.Date for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents a date. |

### DateFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/dateformfield.md

#### DateFormField constructor

Initializes a new instance of the `DateFormField` class with the specified stylesheet and name.

```csharp
public DateFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/helptext.md

#### DateFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/localeid.md

#### DateFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
dateField.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/name.md

#### DateFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/readonly.md

#### DateFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/statustext.md

#### DateFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/stylesheet.md

#### DateFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/type.md

#### DateFormField.Type property

Gets the type of the form field, which is always FormFieldType.Date for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dateformfield/value.md

#### DateFormField.Value property

Gets or sets the value of the form field, which represents a date.

```csharp
public DateTime Value { get; set; }
```

### DropDownFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield.md

#### DropDownFormField class

Represents a form field that displays a drop-down list.

```csharp
public sealed class DropDownFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| DropDownFormField(string, string) | Initializes a new instance of the `DropDownFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| SelectedIndex { get; set; } | Gets or sets the index of the selected item in the drop-down list. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.DropDown for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents the list of options in the drop-down list. |

### DropDownFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/dropdownformfield.md

#### DropDownFormField constructor

Initializes a new instance of the `DropDownFormField` class with the specified stylesheet and name.

```csharp
public DropDownFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/helptext.md

#### DropDownFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/localeid.md

#### DropDownFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
dropDownField.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/name.md

#### DropDownFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/readonly.md

#### DropDownFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### SelectedIndex
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/selectedindex.md

#### DropDownFormField.SelectedIndex property

Gets or sets the index of the selected item in the drop-down list.

```csharp
public int SelectedIndex { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/statustext.md

#### DropDownFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/stylesheet.md

#### DropDownFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/type.md

#### DropDownFormField.Type property

Gets the type of the form field, which is always FormFieldType.DropDown for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/dropdownformfield/value.md

#### DropDownFormField.Value property

Gets or sets the value of the form field, which represents the list of options in the drop-down list.

```csharp
public List<string> Value { get; set; }
```

### FormFieldCollection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldcollection.md

#### FormFieldCollection class

Represents a collection of form fields.

```csharp
public sealed class FormFieldCollection : IEnumerable<IFormField>
```

#### Constructors

| Name | Description |
| --- | --- |
| FormFieldCollection() | Initializes a new instance of the `FormFieldCollection` class. |

#### Properties

| Name | Description |
| --- | --- |
| Item { get; } | Gets the form field with the specified name. |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetFormField&lt;T&gt;(string) | Gets the form field with the specified name and type. |

### FormFieldCollection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldcollection/formfieldcollection.md

#### FormFieldCollection constructor

Initializes a new instance of the `FormFieldCollection` class.

```csharp
public FormFieldCollection()
```

### GetEnumerator
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldcollection/getenumerator.md

#### FormFieldCollection.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<IFormField> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldcollection/getformfield.md

#### FormFieldCollection.GetFormField&lt;T&gt; method

Gets the form field with the specified name and type.

```csharp
public T GetFormField<T>(string name)
    where T : IFormField
```

| Parameter | Description |
| --- | --- |
| T | The type of the form field. |
| name | The name of the form field. |

##### Return Value

The form field with the specified name and type, if found; otherwise, the default value for the type.

### Item
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldcollection/item.md

#### FormFieldCollection indexer

Gets the form field with the specified name.

```csharp
public IFormField this[string name] { get; }
```

| Parameter | Description |
| --- | --- |
| name | The name of the form field. |

##### Return Value

The form field with the specified name, if found; otherwise, `null`.

### FormFieldType
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/formfieldtype.md

#### FormFieldType enumeration

Specifies the type of form field.

```csharp
public enum FormFieldType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Text | `0` | The text form field can contain any text. |
| Number | `1` | The text form field can contain only numbers. |
| Date | `2` | The text form field can contain only a valid date value. |
| CurrentDate | `3` | The text form field value is the current date when the field is updated. |
| CurrentTime | `4` | The text form field value is the current time when the field is updated. |
| CheckBox | `5` | The checkbox form field. |
| DropDown | `6` | The drop-down field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/helptext.md

#### HelpText class

Represents help text for a form field.

```csharp
public sealed class HelpText
```

#### Constructors

| Name | Description |
| --- | --- |
| HelpText() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Text { get; set; } | Gets or sets the text content of the help text. |
| UseOwn { get; set; } | Gets or sets a value indicating whether the form field should use its own help text. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/helptext/helptext.md

#### HelpText constructor

The default constructor.

```csharp
public HelpText()
```

### Text
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/helptext/text.md

#### HelpText.Text property

Gets or sets the text content of the help text.

```csharp
public string Text { get; set; }
```

### UseOwn
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/helptext/useown.md

#### HelpText.UseOwn property

Gets or sets a value indicating whether the form field should use its own help text.

```csharp
public bool UseOwn { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### IFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield.md

#### IFormField interface

Represents a form field.

```csharp
public interface IFormField
```

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether this `IFormField` is readonly. Some analog of [HTML attribute: readonly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly). |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/helptext.md

#### IFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/localeid.md

#### IFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
field.LocaleId = new CultureInfo("en-US").LCID;
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/name.md

#### IFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/readonly.md

#### IFormField.Readonly property

Gets or sets a value indicating whether this `IFormField` is readonly. Some analog of [HTML attribute: readonly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly).

```csharp
public bool Readonly { get; set; }
```

##### Property Value

`true` if readonly; otherwise, `false`.

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/statustext.md

#### IFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/stylesheet.md

#### IFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

##### Property Value

The stylesheet.

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/iformfield/type.md

#### IFormField.Type property

Gets the type of the form field.

```csharp
public FormFieldType Type { get; }
```

### InvalidFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/invalidformfield.md

#### InvalidFormField class

Represents the update of invalid form field names during the `FixInvalidFormFieldNames` operation.

```csharp
public sealed class InvalidFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidFormField(string) | Initializes a new instance of the `InvalidFormField` class with the specified name. |

#### Properties

| Name | Description |
| --- | --- |
| FixedName { get; set; } | Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name. |
| Name { get; } | Gets the original name of the form field that cannot be modified outside `FormFieldManager`. |

### FixedName
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/invalidformfield/fixedname.md

#### InvalidFormField.FixedName property

Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name.

```csharp
public string FixedName { get; set; }
```

##### Remarks

```csharp
FixedName = string.Format("{0}_fixed", name) // as default value.
```

### InvalidFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/invalidformfield/invalidformfield.md

#### InvalidFormField constructor

Initializes a new instance of the `InvalidFormField` class with the specified name.

```csharp
public InvalidFormField(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The original name of the form field. |

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/invalidformfield/name.md

#### InvalidFormField.Name property

Gets the original name of the form field that cannot be modified outside `FormFieldManager`.

```csharp
public string Name { get; }
```

### NumberFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield.md

#### NumberFormField class

Represents a form field that accepts a number input.

```csharp
public sealed class NumberFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| NumberFormField(string, string) | Initializes a new instance of the `NumberFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| MaxLength { get; set; } | Gets or sets the maximum length of the input for the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.Number for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents a number. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/helptext.md

#### NumberFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/localeid.md

#### NumberFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
numberField.LocaleId = new CultureInfo("en-US").LCID;
```

### MaxLength
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/maxlength.md

#### NumberFormField.MaxLength property

Gets or sets the maximum length of the input for the form field.

```csharp
public int MaxLength { get; set; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/name.md

#### NumberFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### NumberFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/numberformfield.md

#### NumberFormField constructor

Initializes a new instance of the `NumberFormField` class with the specified stylesheet and name.

```csharp
public NumberFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/readonly.md

#### NumberFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/statustext.md

#### NumberFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/stylesheet.md

#### NumberFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/type.md

#### NumberFormField.Type property

Gets the type of the form field, which is always FormFieldType.Number for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/numberformfield/value.md

#### NumberFormField.Value property

Gets or sets the value of the form field, which represents a number.

```csharp
public float Value { get; set; }
```

### TextFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield.md

#### TextFormField class

Represents a form field that accepts text input.

```csharp
public sealed class TextFormField : IFormField
```

#### Constructors

| Name | Description |
| --- | --- |
| TextFormField(string, string) | Initializes a new instance of the `TextFormField` class with the specified stylesheet and name. |

#### Properties

| Name | Description |
| --- | --- |
| HelpText { get; set; } | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| LocaleId { get; set; } | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| MaxLength { get; set; } | Gets or sets the maximum length of the input for the form field. |
| Name { get; } | Gets the name of the form field. |
| Readonly { get; set; } | Gets or sets a value indicating whether the form field is read-only. |
| StatusText { get; set; } | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| Stylesheet { get; } | Gets the stylesheet applied to the form field. |
| Type { get; } | Gets the type of the form field, which is always FormFieldType.Text for this class. |
| Value { get; set; } | Gets or sets the value of the form field, which represents the text input. |

### HelpText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/helptext.md

#### TextFormField.HelpText property

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

```csharp
public HelpText HelpText { get; set; }
```

##### Remarks

If set to `false`, the help text will not be applied.

### LocaleId
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/localeid.md

#### TextFormField.LocaleId property

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

```csharp
public int LocaleId { get; set; }
```

##### Remarks

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

##### Examples

The following example demonstrates how to set the LocaleId property:

```csharp
Set the LocaleId to represent the English (United States) culture
textField.LocaleId = new CultureInfo("en-US").LCID;
```

### MaxLength
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/maxlength.md

#### TextFormField.MaxLength property

Gets or sets the maximum length of the input for the form field.

```csharp
public int MaxLength { get; set; }
```

### Name
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/name.md

#### TextFormField.Name property

Gets the name of the form field.

```csharp
public string Name { get; }
```

### Readonly
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/readonly.md

#### TextFormField.Readonly property

Gets or sets a value indicating whether the form field is read-only.

```csharp
public bool Readonly { get; set; }
```

### StatusText
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/statustext.md

#### TextFormField.StatusText property

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

```csharp
public HelpText StatusText { get; set; }
```

##### Remarks

If set to `false`, the status text will not be applied.

### Stylesheet
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/stylesheet.md

#### TextFormField.Stylesheet property

Gets the stylesheet applied to the form field.

```csharp
public string Stylesheet { get; }
```

### TextFormField
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/textformfield.md

#### TextFormField constructor

Initializes a new instance of the `TextFormField` class with the specified stylesheet and name.

```csharp
public TextFormField(string stylesheet, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | String | The stylesheet to apply to the form field. |
| name | String | The name of the form field. |

### Type
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/type.md

#### TextFormField.Type property

Gets the type of the form field, which is always FormFieldType.Text for this class.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.words.fieldmanagement/textformfield/value.md

#### TextFormField.Value property

Gets or sets the value of the form field, which represents the text input.

```csharp
public string Value { get; set; }
```

### GroupDocs.Editor
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor.md

The GroupDocs.Editor namespace provides classes for editing documents using 3rd party front-end WYSIWYG editors without any additional applications.

#### Classes

| Class | Description |
| --- | --- |
| EditableDocument | Intermediate document, that contains content before and after editing |
| Editor | Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a 'using' directive or dispose its resources manually via 'Dispose()' method call. Document loading is performed through constructors. Document editing - through method 'Edit', and saving back to the resultant document after edit - through method 'Save'. |
| EncryptedException | The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates. |
| FormFieldManager | Manage a Form with Legacy Form Fields. Legacy form fields are the field types that were available in earlier versions of Word processing. The Legacy Forms group (visible after you click the Legacy Tools icon) includes three types of form fields you can insert in a document: text, check box, drop-down, date etc., see more `FormFieldType`. Each of these form fields allows the user of the form to select or enter information of the type that you deem appropriate. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| InvalidFormatException | The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format. |
| 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. |
| PasswordRequiredException | The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.editor.dll -->

### EditableDocument
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument.md

#### EditableDocument class

Intermediate document, that contains content before and after editing

```csharp
public sealed class EditableDocument : IAuxDisposable
```

#### Properties

| Name | Description |
| --- | --- |
| AllResources { get; } | Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts, audio |
| Audio { get; } | Returns a list of audio resources |
| Css { get; } | Allows to obtain stylesheet (CSS) resources (both external and embedded, but not inline), which are used by this HTML document |
| Fonts { get; } | Allows to obtain external font resources, which are used by this HTML document |
| Images { get; } | Allows to obtain external image resources (raster and vector images), which are used by this HTML document |
| IsDisposed { get; } | Determines whether this Editable document was already disposed (true) or not (false) |

#### Methods

| Name | Description |
| --- | --- |
| static FromFile(string, string) | Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the *.html file itself and a folder with linked resources |
| static FromMarkup(string) | Static factory, that creates an instance of `EditableDocument` from specified HTML markup |
| static FromMarkup(string, IEnumerable&lt;IHtmlResource&gt;) | Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources |
| static FromMarkupAndResourceFolder(string, string) | Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path |
| Dispose() | Disposes this Editable document instance, disposing its content and making its methods and properties non-working |
| GetBodyContent() | Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string. |
| GetBodyContent(string) | Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified template with placeholders. |
| GetContent() | Returns overall content of the HTML document as a string. |
| GetContent(string, string) | Returns overall content of the HTML document as a string, where links to the external resources contain specified template with placeholders. |
| GetContent&lt;TStream&gt;(TStream, Encoding) | Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding |
| GetCssContent() | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document. |
| GetCssContent(string, string) | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document. |
| GetEmbeddedHtml() | Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form. |
| Save(string) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources. |
| Save(string, string) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path. |
| Save(TextWriter, HtmlSaveOptions) | Saves the content of this `EditableDocument` as the HTML document to the specified text writer, while the second options parameter allows to customize the saving procedure and specify the resource saving callback |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this Editable document is disposed, right after finishing the disposing process |

##### Remarks

Instance of `EditableDocument` class can be produced by the '`Edit`' method or created by the user himself using static factories. `EditableDocument` internally stores document in its own closed format, which is compatible (convertible) with all import and export formats, that GroupDocs.Editor supports. In order to make document editable in any WYSIWYG client-side editor (like CKEditor or TinyMCE), `EditableDocument` provides methods for generating HTML markup and producing resources, that can be accepted by the user.

### AllResources
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/allresources.md

#### EditableDocument.AllResources property

Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts, audio

```csharp
public List<IHtmlResource> AllResources { get; }
```

##### Remarks

This property returns a concatenated result of 'Images', 'Fonts', 'Css', and 'Audio' properties

### Audio
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/audio.md

#### EditableDocument.Audio property

Returns a list of audio resources

```csharp
public List<Mp3Audio> Audio { get; }
```

### Css
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/css.md

#### EditableDocument.Css property

Allows to obtain stylesheet (CSS) resources (both external and embedded, but not inline), which are used by this HTML document

```csharp
public List<CssText> Css { get; }
```

##### Remarks

This method returns a swallow copy of all used stylesheet resources: `List` is a new instance for every call, but resource instances are the same.

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/dispose.md

#### EditableDocument.Dispose method

Disposes this Editable document instance, disposing its content and making its methods and properties non-working

```csharp
public void Dispose()
```

##### Remarks

After this method was invoked, calling all other methods of this instance will throw an ObjectDisposedException. It is safe to call this method multiple times — all subsequent calls are ignored.

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/disposed.md

#### EditableDocument.Disposed event

Event, which occurs when this Editable document is disposed, right after finishing the disposing process

```csharp
public event EventHandler Disposed;
```

### Fonts
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/fonts.md

#### EditableDocument.Fonts property

Allows to obtain external font resources, which are used by this HTML document

```csharp
public List<FontResourceBase> Fonts { get; }
```

##### Remarks

This method returns a swallow copy of all used font resources: `List` is a new instance for every call, but resource instances are the same.

### FromFile
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/fromfile.md

#### EditableDocument.FromFile method

Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the *.html file itself and a folder with linked resources

```csharp
public static EditableDocument FromFile(string htmlFilePath, string resourceFolderPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | String | String, that contains a full path to the HTML file. Cannot be null, should be valid file path, and file itself should exists. |
| resourceFolderPath | String | Optional path to the folder with HTML resources. If NULL, invalid or such folder doesn't exist, Editor will try to find the this folder by itself, analyzing the HTML markup |

##### Return Value

New non-null instance of EditableDocument

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | HTML file path, and/or the resource folder path is/are invalid |
| FileNotFoundException | Specified HTML file cannot be found |

### FromMarkup
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/frommarkup.md

#### FromMarkup(string)

Static factory, that creates an instance of `EditableDocument` from specified HTML markup

```csharp
public static EditableDocument FromMarkup(string newHtmlContent)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |

##### Return Value

New non-null instance of EditableDocument

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | String with input raw HTML markup cannot be null or empty |

##### Remarks

THis static method is useful for creating the `EditableDocument` instance from the single-string HTML markup, where all resources are embedded into it with base64 encoding.

#### FromMarkup(string, IEnumerable&lt;IHtmlResource&gt;)

Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources

```csharp
public static EditableDocument FromMarkup(string newHtmlContent, 
    IEnumerable<IHtmlResource> resources)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resources | IEnumerable`1 | Collection of all resources (images, stylesheets, fonts), that are used in the HTML-document, specified in *newHtmlContent* parameter. May be absent (NULL or empty collection). |

##### Return Value

New non-null instance of EditableDocument

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | String with input raw HTML markup cannot be null or empty |

### FromMarkupAndResourceFolder
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/frommarkupandresourcefolder.md

#### EditableDocument.FromMarkupAndResourceFolder method

Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path

```csharp
public static EditableDocument FromMarkupAndResourceFolder(string newHtmlContent, 
    string resourceFolderPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resourceFolderPath | String | Mandatory path to the folder with resources. All stylesheets, which are located in this folder, will be used. Cannot be NULL or empty string, and this folder should exists. |

##### Return Value

New non-null instance of EditableDocument

##### Remarks

This static factory is useful when content of HTML document is presented as a string, but all resources are located in some folder, and often links to these resources in HTML markup are invalid and absent. When invoking this method, it scans specified folder and automatically applies all found stylesheets to the document. This method is very useful when obtaining content from different HTML editors, which usually cut off the document metadata and so on.

### GetBodyContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/getbodycontent.md

#### GetBodyContent()

Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string.

```csharp
public string GetBodyContent()
```

##### Return Value

String, which contains the body of the HTML document (without opening and closing BODY tags)

##### Remarks

Most of WYSIWYG editors usually operate with the inner content of the BODY of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload doesn't allow to adjust URIs for external resource requests.

#### GetBodyContent(string)

Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified template with placeholders.

```csharp
public string GetBodyContent(string externalImagesTemplate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | String | Through this parameter used can specify a string template with one placeholder, which will be applied to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, template will not be added, and pure filenames will be present in the resultant HTML markup. Is template is invalid, it will be treated as a prefix, so filenames will be concatenated to the its end. |

##### Return Value

String, which contains the body of the HTML document (without opening and closing BODY tags) with links, adjusted to the external images

##### Remarks

Most of WYSIWYG editors usually operate with the inner content of the BODY of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload allows to adjust URIs for external resource requests.

### GetContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/getcontent.md

#### GetContent&lt;TStream&gt;(TStream, Encoding)

Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding

```csharp
public TStream GetContent<TStream>(TStream storage, Encoding encoding)
    where TStream : Stream
```

| Parameter | Description |
| --- | --- |
| TStream | Any implementation of the Stream |
| storage | Non-null byte stream, which supports writing |
| encoding | Non-null text encoding, which should be apllied while writing text content into specified *storage* |

##### Return Value

Instance of specified *storage*

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Any of input arguments are null |
| ArgumentException | Specified stream is not writable |

#### GetContent()

Returns overall content of the HTML document as a string.

```csharp
public string GetContent()
```

##### Return Value

String, which contains the content of the HTML document

#### GetContent(string, string)

Returns overall content of the HTML document as a string, where links to the external resources contain specified template with placeholders.

```csharp
public string GetContent(string externalImagesTemplate, string externalCssTemplate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | String | Through this parameter used can specify a string template with one placeholder, which will be applied to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, template will not be added, and pure filenames will be present in the resultant HTML markup. Is template is invalid, it will be treated as a prefix, so filenames will be concatenated to the its end. |
| externalCssTemplate | String | Through this parameter used can specify a string template with one placeholder, which will be added to the links to all external stylesheets in LINK elements, which will be present in the resultant HTML string. If NULL or empty, template will not be added, and pure filenames will be present in the resultant HTML markup. Is template is invalid, it will be treated as a prefix, so filenames will be concatenated to the its end. |

##### Return Value

String, which contains the content of the HTML document with links, adjusted to the external resources

### GetCssContent
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/getcsscontent.md

#### GetCssContent()

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document.

```csharp
public List<string> GetCssContent()
```

##### Return Value

A list of strings, where each string holds a content of one CSS document

#### GetCssContent(string, string)

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document.

```csharp
public List<string> GetCssContent(string externalImagesPrefix, string externalFontsPrefix)
```

| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesPrefix | String | Through this parameter used can specify a prefix, which will be added to the links to all external images, which will be present in CSS declarations in the resultant CSS strings. If NULL or empty, prefixes will not be added. |
| externalFontsPrefix | String | Through this parameter used can specify a prefix, which will be added to the links to all external fonts in the @font-face at-rules in the resultant CSS strings. If NULL or empty, prefixes will not be added. |

##### Return Value

A list of strings, where each string holds a content of one CSS document

### GetEmbeddedHtml
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/getembeddedhtml.md

#### EditableDocument.GetEmbeddedHtml method

Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.

```csharp
public string GetEmbeddedHtml()
```

##### Return Value

String, which is not NULL or empty in any case

##### Exceptions

| exception | condition |
| --- | --- |
| ObjectDisposedException | This EditableDocument instance was already disposed |

##### Remarks

This method converts this EditableDocument into HTML and serializes in into single string, where all resources are embedded into string along with HTML markup:

* All images from HTML-&gt;BODY are converted to base64 format and are located in the IMG 'src' attribute
* All stylesheets are stored in the STYLE elements inside HTML-&gt;HEAD sections
* All images from stylesheets are converted to base64 format and located in the appropriate CSS declarations
* All fonts from stylesheets are converted to base64 format and located in the appropriate @font-face at-rules

### Images
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/images.md

#### EditableDocument.Images property

Allows to obtain external image resources (raster and vector images), which are used by this HTML document

```csharp
public List<IImageResource> Images { get; }
```

##### Remarks

This method returns a swallow copy of all used image resources: `List` is a new instance for every call, but resource instances are the same.

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/isdisposed.md

#### EditableDocument.IsDisposed property

Determines whether this Editable document was already disposed (true) or not (false)

```csharp
public bool IsDisposed { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editabledocument/save.md

#### Save(string)

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.

```csharp
public void Save(string htmlFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | String | Full path to the file, where HTML markup will be stored. File will be created or overwritten, if exists. Accompanying resource folder will be created in the same folder, where HTML file exist. |

#### Save(string, string)

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.

```csharp
public void Save(string htmlFilePath, string resourcesFolderPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | String | Full path to the file, where HTML markup will be stored. Cannot be NULL or empty. File will be created or overwritten, if exists. |
| resourcesFolderPath | String | Full path to the accompanying folder, where all related resources will be stored. If NULL or empty, folder will be created automatically in the same directory, where *.html file. If specified and not exists, will be created. |

#### Save(TextWriter, HtmlSaveOptions)

Saves the content of this `EditableDocument` as the HTML document to the specified text writer, while the second options parameter allows to customize the saving procedure and specify the resource saving callback

```csharp
public void Save(TextWriter htmlMarkup, HtmlSaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| htmlMarkup | TextWriter | Implementation of the text writer, into which the HTML markup will be written. Can not be null. |
| saveOptions | HtmlSaveOptions | HTML save options, that control the saving procedure: how the HTML-markup is stored (tag names, quote types) and how and where will be saved CSS and other resources like images or fonts. User should specify the inheritor of  interface in the `SavingCallback` property for controlling how resources should be saved and referenced from HTML-markup. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Any of specified arguments or `SavingCallback` property in *saveOptions* are `null` |

### Editor
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor.md

#### Editor class

Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a 'using' directive or dispose its resources manually via 'Dispose()' method call. Document loading is performed through constructors. Document editing - through method 'Edit', and saving back to the resultant document after edit - through method 'Save'.

```csharp
public sealed class Editor : IAuxDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Editor(DocumentFormatBase) | Initializes a new instance of the `Editor` class and creates a new empty document based on the specified format. |
| Editor(Stream) | Initializes new Editor instance with specified input document (as a stream). |
| Editor(string) | Initializes new Editor instance with specified input document (as a full file path) and Editor settings |
| Editor(Stream, ILoadOptions) | Initializes new Editor instance with specified input document (as a stream) with its load options. |
| Editor(string, ILoadOptions) | Initializes new Editor instance with specified input document (as a full file path) with its load options. |

#### Properties

| Name | Description |
| --- | --- |
| FormFieldManager { get; } | Provides access to functionality for managing form fields within the document. |
| IsDisposed { get; } | Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or it was not disposed yet and thus is active (false) |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage |
| Edit() | Opens a previously loaded document for editing using default options by generating and returning an instance of '`EditableDocument`' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| Edit(IEditOptions) | Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '`EditableDocument`' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| GetDocumentInfo(string) | Returns metadata about the document, that was loaded to this 'Editor' instance |
| Save(Stream) | Save the current document content to the specified output stream. |
| Save(EditableDocument, string) | Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of format, determined from the filename extension, and saves its content to file by specified file path |
| Save(Stream, WordProcessingSaveOptions) | Converts the original document after modification (for example, `FormFieldManager`), to the resultant document of the specified format and saves its content to the provided stream. |
| Save(EditableDocument, Stream, ISaveOptions) | Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of specified format and saves its content to specified stream |
| Save(EditableDocument, string, ISaveOptions) | Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of specified format and saves its content to file by specified file path |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Event, which occurs when this Editor instance is disposed with all its internal resources |

##### Remarks

Editor class should be considered as an entry point and the root object of the GroupDocs.Editor. All operations are performed using this class. Typical usage of the Editor class for performing a full document editing pipeline is the next:

1. Load a document into the Editor instance through its constructor.
2. Optionally, detect a document type using a `GetDocumentInfo` method.
3. Open a document for editing by calling an `Edit` method and obtaining an instance of `EditableDocument` class from it.
4. Editing a document content on client-side using any WYSIWYG HTML-editor.
5. Creating a new instance of `EditableDocument` from edited document content.
6. Saving an edited document to some output format by calling a `Save` method.
7. Disposing an instance of Editor class via 'using' operator or manually.

### Dispose
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/dispose.md

#### Editor.Dispose method

Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage

```csharp
public void Dispose()
```

##### Remarks

After this method was invoked, calling all other methods of this instance will throw an ObjectDisposedException. It is safe to call this method multiple times — all subsequent calls are ignored.

### Disposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/disposed.md

#### Editor.Disposed event

Event, which occurs when this Editor instance is disposed with all its internal resources

```csharp
public event EventHandler Disposed;
```

##### Remarks

This **Disposed** event will be fired right after disposing of the Editor instance is finished.

### Edit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/edit.md

#### Edit(IEditOptions)

Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '`EditableDocument`' class, that, in turn, contains methods for producing HTML markup and associated resources.

```csharp
public EditableDocument Edit(IEditOptions editOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| editOptions | IEditOptions | Format-specific document options, which allows to tune-up conversion process. May be NULL — in that case GroupDocs.Editor detects a format of previously loaded document and applies options, default for this format. Should not conflict with previously applied load options. |

##### Return Value

Instance of the '`EditableDocument`' class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

##### Remarks

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. '`EditableDocument`', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload obtains edit options, which are specific for family formats. **Learn more**

* More about editing documents using GroupDocs.Editor: [How to edit document using GroupDocs.Editor](https://docs.groupdocs.com/display/editornet/Edit+document)

#### Edit()

Opens a previously loaded document for editing using default options by generating and returning an instance of '`EditableDocument`' class, that, in turn, contains methods for producing HTML markup and associated resources.

```csharp
public EditableDocument Edit()
```

##### Return Value

Instance of the '`EditableDocument`' class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

##### Remarks

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of '`EditableDocument`' class. '`EditableDocument`', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload applies edit options, which are default for the format, to which the input document belongs. **Learn more**

* More about editing documents using GroupDocs.Editor: [How to edit document using GroupDocs.Editor](https://docs.groupdocs.com/display/editornet/Edit+document)

### Editor
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/editor.md

#### Editor(DocumentFormatBase)

Initializes a new instance of the `Editor` class and creates a new empty document based on the specified format.

```csharp
public Editor(DocumentFormatBase format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | DocumentFormatBase | Represents the file format of the document that will be created. |

##### Examples

```csharp
IDocumentFormat format = new WordProcessingFormats.Docx();
using (Editor editor = new Editor(format))
{
    // Use the editor instance to edit and save documents
}
```

#### Editor(Stream)

Initializes new Editor instance with specified input document (as a stream).

```csharp
public Editor(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Stream that contains document content. Should not be null. |

##### Examples

```csharp
using (FileStream fs = new FileStream("input.docx", FileMode.Open, FileAccess.Read))
{
    using (Editor editor = new Editor(fs))
    {
        // Use the editor instance to edit and save documents
    }
}
```

#### Editor(Stream, ILoadOptions)

Initializes new Editor instance with specified input document (as a stream) with its load options.

```csharp
public Editor(Stream document, ILoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Stream that contains document content. Should not be null. |
| loadOptions | ILoadOptions | Document load options. May be null. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when the document stream is null. |
| ArgumentException | Thrown when the document stream is invalid. |

##### Examples

```csharp
using (FileStream fs = new FileStream("input.docx", FileMode.Open, FileAccess.Read))
{
    ILoadOptions loadOptions = new WordProcessingLoadOptions();
    using (Editor editor = new Editor(fs, loadOptions))
    {
        // Use the editor instance to edit and save documents
    }
}
```

#### Editor(string, ILoadOptions)

Initializes new Editor instance with specified input document (as a full file path) with its load options.

```csharp
public Editor(string filePath, ILoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Full path to the file. Should not be null, empty or contain only whitespaces. Should be valid, and file should exist. |
| loadOptions | ILoadOptions | Document load options. May be null. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when the file path is invalid. |
| FileNotFoundException | Thrown when the file does not exist. |

##### Examples

```csharp
string filePath = "input.docx";
ILoadOptions loadOptions = new WordProcessingLoadOptions();
using (Editor editor = new Editor(filePath, loadOptions))
{
    // Use the editor instance to edit and save documents
}
```

#### Editor(string)

Initializes new Editor instance with specified input document (as a full file path) and Editor settings

```csharp
public Editor(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Full path to the file. Should not be NULL. Should be valid, and file should exist. |

### FormFieldManager
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/formfieldmanager.md

#### Editor.FormFieldManager property

Provides access to functionality for managing form fields within the document.

```csharp
public FormFieldManager FormFieldManager { get; }
```

##### Return Value

A `FormFieldManager` instance for managing form fields within the document.

##### Remarks

The `FormFieldManager` property creates a new instance of the `FormFieldManager` class, which allows access to methods and properties for managing form fields within the document. Form fields are interactive elements within the document that can capture user input or trigger actions. The `FormFieldManager` instance provides methods for various form field operations, including checking for invalid form fields, updating form field data, and fixing naming issues. It also facilitates the retrieval of form field names and their associated data. This property is useful for interacting with and manipulating form fields programmatically, enabling tasks such as form field validation, synchronization, and customization.

### GetDocumentInfo
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/getdocumentinfo.md

#### Editor.GetDocumentInfo method

Returns metadata about the document, that was loaded to this 'Editor' instance

```csharp
public IDocumentInfo GetDocumentInfo(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | User can specify a password for a document, if this document is encrypted with the password. May be NULL or empty string, that is equivalent to the absent password. For those document formats, which do not have a password protection feature, this argument will be ignored. If the document is encrypted, and password in not specified in this parameter, but it was specified before in the load options while creating this `Editor` instance, it will be used. |

##### Return Value

Format-specific inheritor of `IDocumentInfo` interface, that indicates detected format with format-specific metadata, or NULL, if document was not recognized as supportable or is corrupted.

##### Exceptions

| exception | condition |
| --- | --- |
| ObjectDisposedException | Is thrown when Editor instance was already disposed when "GetDocumentInfo" is invoked |
| PasswordRequiredException | Is thrown when loaded document is password protected, but the password was not specified in the parameter "*password*" and in the loading options during creation of the  instance |
| IncorrectPasswordException | Is thrown when loaded document is password protected, password is specified, but is incorrect |
| InvalidOperationException | Is thrown when unexpected error of unknown nature has occured |

##### Remarks

GetDocumentInfo method is useful when it is unclear of which format is the input document, is it password-protected and/or how many pages/worksheets/slides it contains. Based on this metadata, returned by GetDocumentInfo, it is possible to correctly adjust the load and edit options for the main processing pipeline.

GetDocumentInfo method always returns full data, it is not affected by the trial mode, its usage doesn't write off the consumed bytes or credits.

### IsDisposed
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/isdisposed.md

#### Editor.IsDisposed property

Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or it was not disposed yet and thus is active (false)

```csharp
public bool IsDisposed { get; }
```

### Save
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/editor/save.md

#### Save(EditableDocument, Stream, ISaveOptions)

Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of specified format and saves its content to specified stream

```csharp
public void Save(EditableDocument inputDocument, Stream outputDocument, ISaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '`EditableDocument`' class, which should be converted to output document of some specific format. Must not be null or disposed. |
| outputDocument | Stream | Output stream, in which the content of the resultant document will be recorded. Must not be null, disposed, must support writing. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Must not be null. |

#### Save(EditableDocument, string, ISaveOptions)

Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of specified format and saves its content to file by specified file path

```csharp
public void Save(EditableDocument inputDocument, string filePath, ISaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '`EditableDocument`' class, which should be converted to output document of some specific format. Must not be null or disposed. |
| filePath | String | Path to the file, in which the output document will be saved. It file with the same name exists, it will be completely rewritten. String with path must not be null, empty or contain only whitespaces. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Must not be null. |

#### Save(EditableDocument, string)

Converts specified edited document, represented as instance of '`EditableDocument`', to the resultant document of format, determined from the filename extension, and saves its content to file by specified file path

```csharp
public void Save(EditableDocument inputDocument, string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '`EditableDocument`' class, which should be converted to output document of some specific format. Must not be null or disposed. |
| filePath | String | Path to the file, in which the output document will be saved. It file with the same name exists, it will be completely rewritten. String with path must not be null, empty or contain only whitespaces. Because default save options and output format are determined from this filename, it must have the valid extension. |

#### Save(Stream, WordProcessingSaveOptions)

Converts the original document after modification (for example, `FormFieldManager`), to the resultant document of the specified format and saves its content to the provided stream.

```csharp
public Stream Save(Stream outputDocument, WordProcessingSaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | Stream | The stream to which the output document will be saved. This stream should be writable and positioned at the start of the document content. Must not be null. |
| saveOptions | WordProcessingSaveOptions | Document saving options that define the format of the resultant document, as well as general and format-specific saving options. Must not be null. |

##### Return Value

The stream containing the saved document content.

##### Remarks

If the *outputDocument* or *saveOptions* is null, an ArgumentNullException will be thrown. If the document to save is missing, an ArgumentNullException will be thrown.

Thrown when *outputDocument* or *saveOptions* is null, or when the document to save is missing.**Learn more:**

* More about saving documents after modification using GroupDocs.Editor: [How to save documents using GroupDocs.Editor](https://docs.groupdocs.com/display/editornet/Save+document)

#### Save(Stream)

Save the current document content to the specified output stream.

```csharp
public Stream Save(Stream outputDocument)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | Stream | The stream to which the document content will be saved. This cannot be null. |

##### Return Value

The stream with the saved document content.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *outputDocument* is null or if the document content is missing. |

##### Remarks

This method copies the content from the internal document representation to the provided output stream. The stream's original position is preserved after the save operation.

### EncryptedException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/encryptedexception.md

#### EncryptedException class

The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates.

```csharp
public sealed class EncryptedException : Exception
```

### FormFieldManager
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager.md

#### FormFieldManager class

Manage a Form with Legacy Form Fields. Legacy form fields are the field types that were available in earlier versions of Word processing. The Legacy Forms group (visible after you click the Legacy Tools icon) includes three types of form fields you can insert in a document: text, check box, drop-down, date etc., see more `FormFieldType`. Each of these form fields allows the user of the form to select or enter information of the type that you deem appropriate.

```csharp
public sealed class FormFieldManager
```

#### Properties

| Name | Description |
| --- | --- |
| FormFieldCollection { get; } | Gets the collection of form fields in the document. |

#### Methods

| Name | Description |
| --- | --- |
| FixInvalidFormFieldNames(IEnumerable&lt;InvalidFormField&gt;) | Fixes invalid form field names in the document by applying specified updates or automatically generating unique names. |
| GetInvalidFormFieldNames() | Retrieves a collection of invalid form field names from the document. |
| HasInvalidFormFields() | Checks whether the document contains any invalid form fields. |
| RemoveFormFields(IEnumerable&lt;IFormField&gt;) | Removes multiple form fields from the document. |
| RemoveFormFiled(IFormField) | Removes a specific form field from the document. |
| UpdateFormFiled(FormFieldCollection) | Updates form fields in the document based on the provided collection of form fields. |

##### Remarks

The `FormFieldManager` class provides functionality for handling form fields in a document. It allows users to obtain, update, fix, check for invalidity, and remove form fields from the document.

### FixInvalidFormFieldNames
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/fixinvalidformfieldnames.md

#### FormFieldManager.FixInvalidFormFieldNames method

Fixes invalid form field names in the document by applying specified updates or automatically generating unique names.

```csharp
public void FixInvalidFormFieldNames(IEnumerable<InvalidFormField> updateInvalidFormFieldNames)
```

| Parameter | Type | Description |
| --- | --- | --- |
| updateInvalidFormFieldNames | IEnumerable`1 | A collection of updates for invalid form field names. Each update contains the original name of the form field and its corresponding new name. If left empty, invalid form field names will be automatically renamed to ensure uniqueness. |

##### Remarks

The `FixInvalidFormFieldNames` method resolves naming conflicts or inconsistencies within the form fields of the document by applying updates specified in the *updateInvalidFormFieldNames* collection, or automatically generating unique names if the collection is empty. This method is useful when certain form field names are invalid or conflicting with other elements in the document, and need to be corrected to ensure proper functionality. ; ;

### FormFieldCollection
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/formfieldcollection.md

#### FormFieldManager.FormFieldCollection property

Gets the collection of form fields in the document.

```csharp
public FormFieldCollection FormFieldCollection { get; }
```

### GetInvalidFormFieldNames
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/getinvalidformfieldnames.md

#### FormFieldManager.GetInvalidFormFieldNames method

Retrieves a collection of invalid form field names from the document.

```csharp
public IEnumerable<InvalidFormField> GetInvalidFormFieldNames()
```

##### Return Value

An enumerable collection of strings representing the names of invalid form fields found in the document.

##### Remarks

The `GetInvalidFormFieldNames` method scans the document content to identify form fields with invalid names. It returns a collection of strings containing the names of these invalid form fields. A form field is considered invalid if it duplicates a unique identifier with other form fields and does not have a unique bookmark name associated with it. These bookmark names serve as identifiers for each form field. The returned collection maintains the order of form field names as they appear in the document. This method is useful for detecting and analyzing naming issues within form fields, which may need to be addressed using the `FixInvalidFormFieldNames` method.

### HasInvalidFormFields
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/hasinvalidformfields.md

#### FormFieldManager.HasInvalidFormFields method

Checks whether the document contains any invalid form fields.

```csharp
public bool HasInvalidFormFields()
```

##### Return Value

`true` if the document contains one or more invalid form fields; otherwise, `false`.

##### Remarks

The `HasInvalidFormFields` method scans the document content to determine whether it contains any form fields with invalid names. A form field is considered invalid if it duplicates a unique identifier with other form fields and does not have a unique bookmark name associated with it. These bookmark names serve as identifiers for each form field. This method is useful for quickly checking whether the document requires further inspection and potential correction of form field names. ; ; ;

### RemoveFormFields
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/removeformfields.md

#### FormFieldManager.RemoveFormFields method

Removes multiple form fields from the document.

```csharp
public void RemoveFormFields(IEnumerable<IFormField> formFields)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formFields | IEnumerable`1 | The collection of form fields to remove. |

### RemoveFormFiled
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/removeformfiled.md

#### FormFieldManager.RemoveFormFiled method

Removes a specific form field from the document.

```csharp
public void RemoveFormFiled(IFormField formField)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formField | IFormField | The form field to remove. |

### UpdateFormFiled
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/formfieldmanager/updateformfiled.md

#### FormFieldManager.UpdateFormFiled method

Updates form fields in the document based on the provided collection of form fields.

```csharp
public void UpdateFormFiled(FormFieldCollection formFieldCollection)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formFieldCollection | FormFieldCollection | The collection of form fields containing the updates to apply to the document. |

##### Remarks

The `UpdateFormFiled` method updates form fields in the document based on the provided *formFieldCollection*. Each form field in the collection corresponds to a form field in the document, and the updates specified in the collection are applied accordingly. This method is useful for synchronizing form field data between the document and an external source, such as a user interface or database.

### IncorrectPasswordException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public sealed class IncorrectPasswordException : Exception
```

### InvalidFormatException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/invalidformatexception.md

#### InvalidFormatException class

The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format.

```csharp
public sealed class InvalidFormatException : Exception
```

##### Remarks

For example, this exception will be thrown, if try to open a Spreadsheet document with WordProcessing document options.

### License
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/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
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/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.Editor.License lic = new GroupDocs.Editor.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.Editor.lic";
GroupDocs.Editor.License lic = new GroupDocs.Editor.License();
lic.SetLicense(licensePath);
```

### Metered
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/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. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves count of credits consumed.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

Count of already used credits

##### 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/editor/net/groupdocs.editor/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/editor/net/groupdocs.editor/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/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);
```

### PasswordRequiredException
Path: https://reference.groupdocs.com/editor/net/groupdocs.editor/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document.

```csharp
public sealed class PasswordRequiredException : Exception
```

## Node.js

### GroupDocs.Editor for Node.js via Java
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-java/com.groupdocs.editor.formats.abstraction/idocumentformat.md

### com.groupdocs.editor.formats
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-java/com.groupdocs.editor.htmlcss.resources.images/iimage.md

### IImageResource
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-java/com.groupdocs.editor.htmlcss.resources/iresourcetype.md

### ResourceTypeDetector
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-java/com.groupdocs.editor.metadata/idocumentinfo.md

### MarkdownDocumentInfo
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-java/com.groupdocs.editor.options/ieditoptions.md

### IHtmlSavingCallback
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/ihtmlsavingcallback.md

### ILoadOptions
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/iloadoptions.md

### IMarkdownImageLoadCallback
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/imarkdownimageloadcallback.md

### ISaveOptions
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/isaveoptions.md

### MailMessageOutput
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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 |
##### 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 |  |

### SpreadsheetEditOptions
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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. |
##### 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 |  |

### TextDirection
Path: https://reference.groupdocs.com/editor/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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/nodejs-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 attribute-value pairs are placed in a single line.

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

##### getLeafTextNodesOnNewline()
```
public final boolean 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. By default is false (disabled) \\u2014 leaf text nodes are placed on the same line as their parents, without new indent.

**Returns:**
boolean
##### setLeafTextNodesOnNewline(boolean value)
```
public final void 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. By default is false (disabled) \\u2014 leaf text nodes are placed on the same line as their parents, without new indent.

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

##### getLeftIndent()
```
public final Length getLeftIndent()
```

Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt

**Returns:**
Length
##### setLeftIndent(Length value)
```
public final void setLeftIndent(Length value)
```

Allows to specify an offset for the left indent of every new line. Cannot be a unitless non-zero value. By default is 10pt

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

##### isDefault()
```
public final boolean isDefault()
```

Indicates whether this instance of XML formatting options has a default value

**Returns:**
boolean

### XmlHighlightOptions
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/xmlhighlightoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.IEditOptions
```
public class XmlHighlightOptions implements IEditOptions
```

Contains options, that allow to customize the XML highlighting during XML-to-HTML conversion
#### Methods

| Method | Description |
| --- | --- |
| getXmlTagsFontSettings() | Responsible for representing the font of XML tags (angle brackets with tag names) |
| getAttributeNamesFontSettings() | Responsible for representing the font of attribute names |
| getAttributeValuesFontSettings() | Responsible for representing the font of attribute values |
| getInnerTextFontSettings() | Responsible for representing the font of inner-tag text |
| getHtmlCommentsFontSettings() | Responsible for representing the font of HTML comments (including pair of opening and closing tags) |
| getCDataFontSettings() | Responsible for representing the font of CDATA sections (including pair of opening and closing tags) |
| isDefault() | Determines whether this XML Highlight options object has a default font settings |
| resetToDefault() | Resets the current font settings to their default values |
##### getXmlTagsFontSettings()
```
public final WebFont getXmlTagsFontSettings()
```

Responsible for representing the font of XML tags (angle brackets with tag names)

**Returns:**
WebFont
##### getAttributeNamesFontSettings()
```
public final WebFont getAttributeNamesFontSettings()
```

Responsible for representing the font of attribute names

**Returns:**
WebFont
##### getAttributeValuesFontSettings()
```
public final WebFont getAttributeValuesFontSettings()
```

Responsible for representing the font of attribute values

**Returns:**
WebFont
##### getInnerTextFontSettings()
```
public final WebFont getInnerTextFontSettings()
```

Responsible for representing the font of inner-tag text

**Returns:**
WebFont
##### getHtmlCommentsFontSettings()
```
public final WebFont getHtmlCommentsFontSettings()
```

Responsible for representing the font of HTML comments (including pair of opening and closing tags)

**Returns:**
WebFont
##### getCDataFontSettings()
```
public final WebFont getCDataFontSettings()
```

Responsible for representing the font of CDATA sections (including pair of opening and closing tags)

**Returns:**
WebFont
##### isDefault()
```
public final boolean isDefault()
```

Determines whether this XML Highlight options object has a default font settings

**Returns:**
boolean
##### resetToDefault()
```
public final void resetToDefault()
```

Resets the current font settings to their default values

### XpsSaveOptions
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.options/xpssaveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.options.ISaveOptions
```
public final class XpsSaveOptions implements ISaveOptions
```

Allows to specify custom options for generating and saving XPS (XML Paper Specifications) documents

An XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. It was developed 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.
#### Constructors

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

| Method | Description |
| --- | --- |
| getFontEmbedding() | Responsible for embedding font resources into resultant XPS 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. |
##### XpsSaveOptions()
```
public XpsSaveOptions()
```

##### getFontEmbedding()
```
public final byte getFontEmbedding()
```

Responsible for embedding font resources into resultant XPS document, which are used in the original document. By default doesn't embed any fonts (NotEmbed).

**Returns:**
byte
##### 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 |  |

### com.groupdocs.editor.words.fieldmanagement
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement.md

The **com.groupdocs.editor.words.fieldmanagement** namespace contains classes and interfaces related to the management and manipulation of form fields within documents. This namespace provides functionality to work with various types of form fields, such as text fields, checkboxes, dropdowns, etc., allowing users to interact with and modify form fields programmatically.

#### Classes

| Class | Description |
| --- | --- |
| CheckBoxForm | Represents a form field that displays a checkbox. |
| CurrentDateFormField | Represents a form field that displays the current date. |
| CurrentTimeFormField | Represents a form field that displays the current time. |
| DateFormField | Represents a form field that displays a date. |
| DropDownFormField | Represents a form field that displays a drop-down list. |
| FormFieldCollection | Represents a collection of form fields. |
| FormFieldType | Specifies the type of form field. |
| HelpText | Represents help text for a form field. |
| InvalidFormField | Represents the update of invalid form field names during the  FormFieldManager.FixInvalidFormFieldNames  operation. |
| NumberFormField | Represents a form field that accepts a number input. |
| TextFormField | Represents a form field that accepts text input. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IFormField | Represents a form field. |

### CheckBoxForm
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/checkboxform.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CheckBoxForm implements IFormField
```

Represents a form field that displays a checkbox.
#### Constructors

| Constructor | Description |
| --- | --- |
| CheckBoxForm(String stylesheet, String name) | Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CheckBox for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the state of the checkbox. |
| setValue(boolean value) | Gets or sets the value of the form field, which represents the state of the checkbox. |
##### CheckBoxForm(String stylesheet, String name)
```
public CheckBoxForm(String stylesheet, String name)
```

Initializes a new instance of the CheckBoxForm class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CheckBox for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  checkBoxField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  checkBoxField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final boolean getValue()
```

Gets or sets the value of the form field, which represents the state of the checkbox.

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

Gets or sets the value of the form field, which represents the state of the checkbox.

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

### CurrentDateFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/currentdateformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CurrentDateFormField implements IFormField
```

Represents a form field that displays the current date.
#### Constructors

| Constructor | Description |
| --- | --- |
| CurrentDateFormField(String stylesheet, String name) | Initializes a new instance of the CurrentDateFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CurrentDate for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the current date. |
| setValue(Date value) | Gets or sets the value of the form field, which represents the current date. |
##### CurrentDateFormField(String stylesheet, String name)
```
public CurrentDateFormField(String stylesheet, String name)
```

Initializes a new instance of the CurrentDateFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CurrentDate for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents the current date.

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

Gets or sets the value of the form field, which represents the current date.

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

### CurrentTimeFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/currenttimeformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class CurrentTimeFormField implements IFormField
```

Represents a form field that displays the current time.
#### Constructors

| Constructor | Description |
| --- | --- |
| CurrentTimeFormField(String stylesheet, String name) | Initializes a new instance of the CurrentTimeFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.CurrentTime for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the current time. |
| setValue(Date value) | Gets or sets the value of the form field, which represents the current time. |
##### CurrentTimeFormField(String stylesheet, String name)
```
public CurrentTimeFormField(String stylesheet, String name)
```

Initializes a new instance of the CurrentTimeFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.CurrentTime for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  currentTimeField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus..

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents the current time.

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

Gets or sets the value of the form field, which represents the current time.

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

### DateFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/dateformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class DateFormField implements IFormField
```

Represents a form field that displays a date.
#### Constructors

| Constructor | Description |
| --- | --- |
| DateFormField(String stylesheet, String name) | Initializes a new instance of the DateFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Date for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents a date. |
| setValue(Date value) | Gets or sets the value of the form field, which represents a date. |
##### DateFormField(String stylesheet, String name)
```
public DateFormField(String stylesheet, String name)
```

Initializes a new instance of the DateFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Date for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dateField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dateField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final Date getValue()
```

Gets or sets the value of the form field, which represents a date.

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

Gets or sets the value of the form field, which represents a date.

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

### DropDownFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/dropdownformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class DropDownFormField implements IFormField
```

Represents a form field that displays a drop-down list.
#### Constructors

| Constructor | Description |
| --- | --- |
| DropDownFormField(String stylesheet, String name) | Initializes a new instance of the DropDownFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getSelectedIndex() | Gets or sets the index of the selected item in the drop-down list. |
| setSelectedIndex(int value) | Gets or sets the index of the selected item in the drop-down list. |
| getType() | Gets the type of the form field, which is always FormFieldType.DropDown for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the list of options in the drop-down list. |
| setValue(List<String> value) | Gets or sets the value of the form field, which represents the list of options in the drop-down list. |
##### DropDownFormField(String stylesheet, String name)
```
public DropDownFormField(String stylesheet, String name)
```

Initializes a new instance of the DropDownFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getSelectedIndex()
```
public final int getSelectedIndex()
```

Gets or sets the index of the selected item in the drop-down list.

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

Gets or sets the index of the selected item in the drop-down list.

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

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

Gets the type of the form field, which is always FormFieldType.DropDown for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dropDownField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  dropDownField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

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

Gets or sets the value of the form field, which represents the list of options in the drop-down list.

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

Gets or sets the value of the form field, which represents the list of options in the drop-down list.

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

### FormFieldCollection
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/formfieldcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public final class FormFieldCollection implements Iterable<IFormField>
```

Represents a collection of form fields.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldCollection() | Initializes a new instance of the FormFieldCollection class. |
#### Methods

| Method | Description |
| --- | --- |
| iterator() | Returns an enumerator that iterates through the collection. |
| insert(IFormField field) | Inserts a form field into the collection. |
| get(String name) | Gets the form field with the specified name. |
| <T>getFormField(String name, Class<T> type) | Gets the form field with the specified name and type. |
##### FormFieldCollection()
```
public FormFieldCollection()
```

Initializes a new instance of the FormFieldCollection class.

##### iterator()
```
public Iterator<IFormField> iterator()
```

Returns an enumerator that iterates through the collection.

**Returns:**
java.util.Iterator<com.groupdocs.editor.words.fieldmanagement.IFormField> - An enumerator that can be used to iterate through the collection.
##### insert(IFormField field)
```
public void insert(IFormField field)
```

Inserts a form field into the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| field | IFormField | The form field to insert. |

##### get(String name)
```
public IFormField get(String name)
```

Gets the form field with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the form field. |

**Returns:**
IFormField - The form field with the specified name, if found; otherwise,  null .
##### <T>getFormField(String name, Class<T> type)
```
public T <T>getFormField(String name, Class<T> type)
```

Gets the form field with the specified name and type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the form field.

 T : The type of the form field. |
| type | java.lang.Class<T> |  |

**Returns:**
T - The form field with the specified name and type, if found; otherwise, the default value for the type.

### FormFieldType
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/formfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormFieldType
```

Specifies the type of form field.
#### Fields

| Field | Description |
| --- | --- |
| Text | The text form field can contain any text. |
| Number | The text form field can contain only numbers. |
| Date | The text form field can contain only a valid date value. |
| CurrentDate | The text form field value is the current date when the field is updated. |
| CurrentTime | The text form field value is the current time when the field is updated. |
| CheckBox | The checkbox form field. |
| DropDown | The drop-down field. |
##### Text
```
public static final int Text
```

The text form field can contain any text.

##### Number
```
public static final int Number
```

The text form field can contain only numbers.

##### Date
```
public static final int Date
```

The text form field can contain only a valid date value.

##### CurrentDate
```
public static final int CurrentDate
```

The text form field value is the current date when the field is updated.

##### CurrentTime
```
public static final int CurrentTime
```

The text form field value is the current time when the field is updated.

##### CheckBox
```
public static final int CheckBox
```

The checkbox form field.

##### DropDown
```
public static final int DropDown
```

The drop-down field.

### HelpText
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/helptext.md

**Inheritance:**
java.lang.Object
```
public final class HelpText
```

Represents help text for a form field.
#### Constructors

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

| Method | Description |
| --- | --- |
| getUseOwn() | Gets or sets a value indicating whether the form field should use its own help text. |
| setUseOwn(boolean value) | Gets or sets a value indicating whether the form field should use its own help text. |
| getText() | Gets or sets the text content of the help text. |
| setText(String value) | Gets or sets the text content of the help text. |
##### HelpText()
```
public HelpText()
```

##### getUseOwn()
```
public final boolean getUseOwn()
```

Gets or sets a value indicating whether the form field should use its own help text.

If set to  false , the help text will not be applied.

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

Gets or sets a value indicating whether the form field should use its own help text.

If set to  false , the help text will not be applied.

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

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

Gets or sets the text content of the help text.

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

Gets or sets the text content of the help text.

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

### IFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/iformfield.md

### InvalidFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/invalidformfield.md

**Inheritance:**
java.lang.Object
```
public final class InvalidFormField
```

Represents the update of invalid form field names during the  FormFieldManager.FixInvalidFormFieldNames  operation.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFormField(String name) | Initializes a new instance of the InvalidFormField class with the specified name. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the original name of the form field that cannot be modified outside  FormFieldManager . |
| getFixedName() | Gets or sets the new name for the form field after repair. |
| setFixedName(String value) | Gets or sets the new name for the form field after repair. |
##### InvalidFormField(String name)
```
public InvalidFormField(String name)
```

Initializes a new instance of the InvalidFormField class with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The original name of the form field. |

##### getName()
```
public final String getName()
```

Gets the original name of the form field that cannot be modified outside  FormFieldManager .

**Returns:**
java.lang.String
##### getFixedName()
```
public final String getFixedName()
```

Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name.

```
FixedName = string.Format("{0}_fixed", name) // as default value.
```

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

Gets or sets the new name for the form field after repair. This name removes duplicate unique identifiers with other form fields and sets a unique bookmark name.

```
FixedName = string.Format("{0}_fixed", name) // as default value.
```

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

### NumberFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/numberformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class NumberFormField implements IFormField
```

Represents a form field that accepts a number input.
#### Constructors

| Constructor | Description |
| --- | --- |
| NumberFormField(String stylesheet, String name) | Initializes a new instance of the NumberFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Number for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents a number. |
| setValue(float value) | Gets or sets the value of the form field, which represents a number. |
| getMaxLength() | Gets or sets the maximum length of the input for the form field. |
| setMaxLength(int value) | Gets or sets the maximum length of the input for the form field. |
##### NumberFormField(String stylesheet, String name)
```
public NumberFormField(String stylesheet, String name)
```

Initializes a new instance of the NumberFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Number for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  numberField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  numberField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final float getValue()
```

Gets or sets the value of the form field, which represents a number.

**Returns:**
float
##### setValue(float value)
```
public final void setValue(float value)
```

Gets or sets the value of the form field, which represents a number.

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

##### getMaxLength()
```
public final int getMaxLength()
```

Gets or sets the maximum length of the input for the form field.

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

Gets or sets the maximum length of the input for the form field.

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

### TextFormField
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.words.fieldmanagement/textformfield.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.words.fieldmanagement.IFormField
```
public final class TextFormField implements IFormField
```

Represents a form field that accepts text input.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFormField(String stylesheet, String name) | Initializes a new instance of the TextFormField class with the specified stylesheet and name. |
#### Methods

| Method | Description |
| --- | --- |
| getStylesheet() | Gets the stylesheet applied to the form field. |
| getReadonly() | Gets or sets a value indicating whether the form field is read-only. |
| setReadonly(boolean value) | Gets or sets a value indicating whether the form field is read-only. |
| getName() | Gets the name of the form field. |
| getType() | Gets the type of the form field, which is always FormFieldType.Text for this class. |
| getLocaleId() | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| setLocaleId(int value) | Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field. |
| getStatusText() | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| setStatusText(HelpText value) | Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus. |
| getHelpText() | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| setHelpText(HelpText value) | Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1. |
| getValue() | Gets or sets the value of the form field, which represents the text input. |
| setValue(String value) | Gets or sets the value of the form field, which represents the text input. |
| getMaxLength() | Gets or sets the maximum length of the input for the form field. |
| setMaxLength(int value) | Gets or sets the maximum length of the input for the form field. |
##### TextFormField(String stylesheet, String name)
```
public TextFormField(String stylesheet, String name)
```

Initializes a new instance of the TextFormField class with the specified stylesheet and name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stylesheet | java.lang.String | The stylesheet to apply to the form field. |
| name | java.lang.String | The name of the form field. |

##### getStylesheet()
```
public final String getStylesheet()
```

Gets the stylesheet applied to the form field.

**Returns:**
java.lang.String
##### getReadonly()
```
public final boolean getReadonly()
```

Gets or sets a value indicating whether the form field is read-only.

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

Gets or sets a value indicating whether the form field is read-only.

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

##### getName()
```
public final String getName()
```

Gets the name of the form field.

**Returns:**
java.lang.String
##### getType()
```
public final int getType()
```

Gets the type of the form field, which is always FormFieldType.Text for this class.

**Returns:**
int
##### getLocaleId()
```
public final int getLocaleId()
```

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  textField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

Gets or sets the locale ID of the form field, which represents the culture or regional settings associated with the form field.

> ```
> The following example demonstrates how to set the LocaleId property:
>
>  Set the LocaleId to represent the English (United States) culture
>  textField.LocaleId = new CultureInfo("en-US").LCID;
> ```

The LocaleId property specifies a locale identifier (LCID) that corresponds to a particular culture or region.

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

##### getStatusText()
```
public final HelpText getStatusText()
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

**Returns:**
HelpText
##### setStatusText(HelpText value)
```
public final void setStatusText(HelpText value)
```

Gets or sets the status text associated with the form field, the source of the text that's displayed in the status bar when a form field has the focus.

If set to  false , the status text will not be applied.

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

##### getHelpText()
```
public final HelpText getHelpText()
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

**Returns:**
HelpText
##### setHelpText(HelpText value)
```
public final void setHelpText(HelpText value)
```

Gets or sets the help text associated with the form field, the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.

If set to  false , the help text will not be applied.

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

##### getValue()
```
public final String getValue()
```

Gets or sets the value of the form field, which represents the text input.

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

Gets or sets the value of the form field, which represents the text input.

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

##### getMaxLength()
```
public final int getMaxLength()
```

Gets or sets the maximum length of the input for the form field.

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

Gets or sets the maximum length of the input for the form field.

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

### com.groupdocs.editor
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor.md

The **com.groupdocs.editor** namespace is a root namespace, which provides classes for editing multiple document formats in your Java applications.

#### Classes

| Class | Description |
| --- | --- |
| EditableDocument | Intermediate document, that contains content before and after editing |
| Editor | Main class, which encapsulates conversion methods. |
| EncryptedException | The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates. |
| FormFieldManager |  |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| InvalidFormatException | The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format. |
| PasswordRequiredException | The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document. |

### EditableDocument
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/editabledocument.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IAuxDisposable
```
public final class EditableDocument implements IAuxDisposable
```

Intermediate document, that contains content before and after editing

Instance of EditableDocument class can be produced by the Editor.edit() method or created by the user himself using static factories. EditableDocument internally stores document in its own closed format, which is compatible (convertible) with all import and export formats, that GroupDocs.Editor supports. In order to make document editable in any WYSIWYG client-side editor (like CKEditor or TinyMCE), EditableDocument provides methods for generating HTML markup and producing resources, that can be accepted by the user.
#### Fields

| Field | Description |
| --- | --- |
| Disposed |  |
#### Methods

| Method | Description |
| --- | --- |
| getImages() | Allows to obtain external image resources (raster images), which are used by this HTML document |
| getFonts() | Allows to obtain external font resources, which are used by this HTML document |
| getCss() | Returns a list of CSS resources |
| getAudio() | Returns a list of audio resources |
| getAllResources() | Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts |
| getContent(OutputStream storage, Charset encoding) | Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding |
| getBodyContent() | Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string. |
| getBodyContent(String externalImagesTemplate) | Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix. |
| getContent() | Returns overall content of the HTML document as a string. |
| getContentString(String externalImagesTemplate, String externalCssTemplate) | Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix. |
| getCssContent() | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. |
| getCssContent(String externalImagesPrefix, String externalFontsPrefix) | Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. |
| getEmbeddedHtml() | Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form. |
| save(String htmlFilePath) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources. |
| save(String htmlFilePath, String resourcesFolderPath) | Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path. |
| save(Writer htmlMarkup, HtmlSaveOptions saveOptions) |  |
| fromMarkup(String newHtmlContent, List<IHtmlResource> resources) | Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources |
| fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath) | Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path |
| fromFile(String htmlFilePath, String resourceFolderPath) | Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the \*.html file itself and a folder with linked resources |
| dispose() | Disposes this Editable document instance, disposing its content and making its methods and properties non-working |
| isDisposed() | Determines whether this Editable document was already disposed (true) or not (false) |
##### Disposed
```
public final Event<EventHandler> Disposed
```

##### getImages()
```
public final List<IImageResource> getImages()
```

Allows to obtain external image resources (raster images), which are used by this HTML document

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.images.IImageResource>
##### getFonts()
```
public final List<FontResourceBase> getFonts()
```

Allows to obtain external font resources, which are used by this HTML document

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.fonts.FontResourceBase>
##### getCss()
```
public final List<CssText> getCss()
```

Returns a list of CSS resources

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.textual.CssText>
##### getAudio()
```
public final List<Mp3Audio> getAudio()
```

Returns a list of audio resources

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.audio.Mp3Audio>
##### getAllResources()
```
public final List<IHtmlResource> getAllResources()
```

Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts

This property returns a concatenated result of 'Images', 'Fonts', and 'Css' properties

**Returns:**
java.util.List<com.groupdocs.editor.htmlcss.resources.IHtmlResource>
##### getContent(OutputStream storage, Charset encoding)
```
public OutputStream getContent(OutputStream storage, Charset encoding)
```

Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storage | java.io.OutputStream | Non-null byte stream, which supports writing |
| encoding | java.nio.charset.Charset | Non-null text encoding, which should be apllied while writing text content into specified  storage

 TStream : Any implementation of the java.io.InputStream |

**Returns:**
java.io.OutputStream - Instance of specified  storage
##### getBodyContent()
```
public final String getBodyContent()
```

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string.

**Returns:**
java.lang.String - String, which contains the body of the HTML document

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload doesn't allow to adjust URIs for external resource requests.
##### getBodyContent(String externalImagesTemplate)
```
public final String getBodyContent(String externalImagesTemplate)
```

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added.

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload allows to adjust URIs for external resource requests. |

**Returns:**
java.lang.String - String, which contains the body of the HTML document with links, adjusted to the external images
##### getContent()
```
public String getContent()
```

Returns overall content of the HTML document as a string.

**Returns:**
java.lang.String - String, which contains the content of the HTML document
##### getContentString(String externalImagesTemplate, String externalCssTemplate)
```
public String getContentString(String externalImagesTemplate, String externalCssTemplate)
```

Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added. |
| externalCssTemplate | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external stylesheets in LINK elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added. |

**Returns:**
java.lang.String - String, which contains the content of the HTML document with links, adjusted to the external resources
##### getCssContent()
```
public final List<String> getCssContent()
```

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document.

**Returns:**
java.util.List<java.lang.String> - A list of strings, where each string holds a content of one CSS document
##### getCssContent(String externalImagesPrefix, String externalFontsPrefix)
```
public final List<String> getCssContent(String externalImagesPrefix, String externalFontsPrefix)
```

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalImagesPrefix | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external images, which will be present in CSS declarations in the resultant CSS strings. If NULL or empty, prefixes will not be added. |
| externalFontsPrefix | java.lang.String | Through this parameter used can specify a prefix, which will be added to the links to all external fonts in the |

**Returns:**
java.util.List<java.lang.String> - A list of strings, where each string holds a content of one CSS document
##### getEmbeddedHtml()
```
public final String getEmbeddedHtml()
```

Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.

**Returns:**
java.lang.String - String, which is not NULL or empty in any case
##### save(String htmlFilePath)
```
public final void save(String htmlFilePath)
```

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | Full path to the file, where HTML markup will be stored. File will be created or overwritten, if exists. Accompanying resource folder will be created in the same folder, where HTML file exist. |

##### save(String htmlFilePath, String resourcesFolderPath)
```
public final void save(String htmlFilePath, String resourcesFolderPath)
```

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | Full path to the file, where HTML markup will be stored. Cannot be NULL or empty. File will be created or overwritten, if exists. |
| resourcesFolderPath | java.lang.String | Full path to the accompanying folder, where all related resources will be stored. If NULL or empty, folder will be created automatically in the same directory, where \*.html file. If specified and not exists, will be created. |

##### save(Writer htmlMarkup, HtmlSaveOptions saveOptions)
```
public void save(Writer htmlMarkup, HtmlSaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlMarkup | java.io.Writer |  |
| saveOptions | HtmlSaveOptions |  |

##### fromMarkup(String newHtmlContent, List<IHtmlResource> resources)
```
public static EditableDocument fromMarkup(String newHtmlContent, List<IHtmlResource> resources)
```

Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | java.lang.String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resources | java.util.List<com.groupdocs.editor.htmlcss.resources.IHtmlResource> | Collection of all resources (images, stylesheets, fonts), that are used in the HTML-document, specified in  newHtmlContent  parameter. May be absent (NULL or empty collection). |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath)
```
public static EditableDocument fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath)
```

Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newHtmlContent | java.lang.String | String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid. |
| resourceFolderPath | java.lang.String | Mandatory path to the folder with resources. All stylesheets, which are located in this folder, will be used. Cannot be NULL or empty string, and this folder should exists.

This static factory is useful when content of HTML document is presented as a string, but all resources are located in some folder, and often links to these resources in HTML markup are invalid and absent. When invoking this method, it scans specified folder and automatically applies all found stylesheets to the document. This method is very useful when obtaining content from different HTML editors, which usually cut off the document metadata and so on. |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### fromFile(String htmlFilePath, String resourceFolderPath)
```
public static EditableDocument fromFile(String htmlFilePath, String resourceFolderPath)
```

Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the \*.html file itself and a folder with linked resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| htmlFilePath | java.lang.String | String, that contains a full path to the HTML file. Cannot be null, should be valid file path, and file itself should exists. |
| resourceFolderPath | java.lang.String | Optional path to the folder with HTML resources. If NULL, invalid or such folder doesn't exist, Editor will try to find the this folder by itself, analyzing the HTML markup |

**Returns:**
EditableDocument - New non-null instance of EditableDocument
##### dispose()
```
public final void dispose()
```

Disposes this Editable document instance, disposing its content and making its methods and properties non-working

##### isDisposed()
```
public final boolean isDisposed()
```

Determines whether this Editable document was already disposed (true) or not (false)

**Returns:**
boolean

### Editor
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/editor.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.editor.htmlcss.resources.IAuxDisposable
```
public final class Editor implements IAuxDisposable
```

Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a 'using' directive or dispose its resources manually via 'Dispose()' method call. Document loading is performed through constructors. Document editing - through method 'Edit', and saving back to the resultant document after edit - through method 'Save'.

Editor class should be considered as an entry point and the root object of the GroupDocs.Editor. All operations are performed using this class. Typical usage of the Editor class for performing a full document editing pipeline is the next:

 *  Load a document into the Editor instance through its constructor.
 *  Optionally, detect a document type using a  method.
 *  Open a document for editing by calling an  method and obtaining an instance of  class from it..
 *  Editing a document content on client-side using any WYSIWYG HTML-editor.
 *  Creating a new instance of  from edited document content.
 *  Saving an edited document to some output format by calling a  method.
 *  Disposing an instance of Editor class via 'using' operator or manually.
#### Constructors

| Constructor | Description |
| --- | --- |
| Editor(DocumentFormatBase format) | Initializes a new instance of the Editor class and creates a new empty document based on the specified format. |
| Editor(InputStream document) | Initializes new Editor instance with specified input document (as a stream) |
| Editor(InputStream document, ILoadOptions loadOptions) | Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings |
| Editor(String filePath) | Initializes new Editor instance with specified input document (as a full file path) |
| Editor(String filePath, ILoadOptions loadOptions) | Initializes new Editor instance with specified input document (as a full file path) with its load options |
#### Methods

| Method | Description |
| --- | --- |
| edit(IEditOptions editOptions) | Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| edit() | Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources. |
| save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions) | Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream |
| save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions) | Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path |
| save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions) | Converts the original document after modification (for example,  FormFieldManager (\#getFormFieldManager.getFormFieldManager)), to the resultant document of the specified format and saves its content to the provided stream. |
| save(OutputStream outputDocument) | Save the current document content to the specified output stream. |
| getDocumentInfo(String password) | Returns metadata about the document, that was loaded to this 'Editor' instance |
| dispose() | Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage |
| isDisposed() | Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false) |
##### Editor(DocumentFormatBase format)
```
public Editor(DocumentFormatBase format)
```

Initializes a new instance of the Editor class and creates a new empty document based on the specified format.

> ```
> IDocumentFormat format = WordProcessingFormats.Docx;
>  Editor editor = new Editor(format);
>  {
>      // Use the editor instance to edit and save documents
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | DocumentFormatBase | represents the file format of the document that will be created. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(InputStream document)
```
public Editor(InputStream document)
```

Initializes new Editor instance with specified input document (as a stream)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Delegate, that should return a stream with document content. Should not be NULL. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(InputStream document, ILoadOptions loadOptions)
```
public Editor(InputStream document, ILoadOptions loadOptions)
```

Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Delegate, that should return a stream with document content. Should not be NULL. |
| loadOptions | ILoadOptions | Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied. |

##### Editor(String filePath)
```
public Editor(String filePath)
```

Initializes new Editor instance with specified input document (as a full file path)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Full path to the file. Should not be NULL. Should be valid, and file should exist. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/ |

##### Editor(String filePath, ILoadOptions loadOptions)
```
public Editor(String filePath, ILoadOptions loadOptions)
```

Initializes new Editor instance with specified input document (as a full file path) with its load options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Full path to the file. Should not be NULL. Should be valid, and file should exist. |
| loadOptions | ILoadOptions | Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied. **Learn more**

 *  More about file types supported by GroupDocs.Editor: [Document formats supported by GroupDocs.Editor][]
 *  More about GroupDocs.Editor for Java features: [Developer Guide][]
 *  More about how to open and edit password-protected documents and document from different storages: [Load and edit documents using GroupDocs.Editor][]

[Document formats supported by GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/editor/java/developer-guide/
[Load and edit documents using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/load-document/ |

##### edit(IEditOptions editOptions)
```
public final EditableDocument edit(IEditOptions editOptions)
```

Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| editOptions | IEditOptions | Format-specific document options, which allows to tune-up conversion process. Should not be NULL. Should not conflict with previously applied load options.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload obtains edit options, which are specific for family formats.

[How to edit document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Edit+document |

**Returns:**
EditableDocument
##### edit()
```
public final EditableDocument edit()
```

Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources.

**Returns:**
EditableDocument - Instance of the 'EditableDocument' class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload applies edit options, which are default for the format, to which the input document belongs.

[How to edit document using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/edit-document/
##### save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions)
```
public final void save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions)
```

Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of 'EditableDocument' class, which should be converted to output document of some specific format |
| outputDocument | java.io.OutputStream | Output stream, in which the content of the resultant document will be recorded. Should not be NULL, disposed, should support writing. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. **Learn more**

 *  More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

##### save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions)
```
public final void save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions)
```

Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| inputDocument | EditableDocument | Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '' class, which should be converted to output document of some specific format. Must not be null or disposed. |
| filePath | java.lang.String | Path to the file, in which the output document will be saved. It file with the same name exists, it will be completely rewritten. String with path must not be null, empty or contain only whitespaces. |
| saveOptions | ISaveOptions | Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Must not be null. **Learn more**

 *  More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

##### save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions)
```
public final OutputStream save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions)
```

Converts the original document after modification (for example,  FormFieldManager (\#getFormFieldManager.getFormFieldManager)), to the resultant document of the specified format and saves its content to the provided stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | java.io.OutputStream | The stream to which the output document will be saved. This stream should be writable and positioned at the start of the document content. Must not be null. |
| saveOptions | WordProcessingSaveOptions | Document saving options that define the format of the resultant document, as well as general and format-specific saving options. Must not be null.

If the  outputDocument  or  saveOptions  is null, an NullPointerException will be thrown. If the document to save is missing, an NullPointerException will be thrown.

 **Learn more:**

 *   |

**Returns:**
java.io.OutputStream - The stream containing the saved document content.
##### save(OutputStream outputDocument)
```
public final OutputStream save(OutputStream outputDocument)
```

Save the current document content to the specified output stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputDocument | java.io.OutputStream | The stream to which the document content will be saved. This cannot be null.

This method copies the content from the internal document representation to the provided output stream. The stream's original position is preserved after the save operation. |

**Returns:**
java.io.OutputStream - The stream with the saved document content.
##### getDocumentInfo(String password)
```
public final IDocumentInfo getDocumentInfo(String password)
```

Returns metadata about the document, that was loaded to this 'Editor' instance

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | User can specify a password for a document, if this document is encrypted with the password. May be NULL or empty string, that is equivalent to the absent password. For those document formats, which do not have a password protection feature, this argument will be ignored. If the document is encrypted, and password in not specified in this parameter, but it was specified before in the load options while creating this  instance, it will be used. **Learn more**

 *  Learn more about obtaining document specific properties in code: [How to get document info using GroupDocs.Editor][]

[How to get document info using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/extracting-document-metainfo/ |

**Returns:**
IDocumentInfo
##### dispose()
```
public final void dispose()
```

Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage

##### isDisposed()
```
public final boolean isDisposed()
```

Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false)

**Returns:**
boolean

### EncryptedException
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/encryptedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception
```
public final class EncryptedException extends System.Exception
```

The exception that is thrown when user tries to open a document that was encrypted using the X509Certificates.
#### Constructors

| Constructor | Description |
| --- | --- |
| EncryptedException() |  |
| EncryptedException(String message) |  |
| EncryptedException(String message, RuntimeException inner) |  |
##### EncryptedException()
```
public EncryptedException()
```

##### EncryptedException(String message)
```
public EncryptedException(String message)
```

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

##### EncryptedException(String message, RuntimeException inner)
```
public EncryptedException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### FormFieldManager
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/formfieldmanager.md

**Inheritance:**
java.lang.Object
```
public class FormFieldManager
```
#### Methods

| Method | Description |
| --- | --- |
| getFormFieldCollection() |  |
| updateFormFields(FormFieldCollection formFieldCollection) |  |
| fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames) |  |
| hasInvalidFormFields() |  |
| removeFormField(IFormField formField) |  |
| getInvalidFormFieldNames() |  |
| removeFormFields(List<IFormField> formFields) |  |
##### getFormFieldCollection()
```
public FormFieldCollection getFormFieldCollection()
```

**Returns:**
FormFieldCollection
##### updateFormFields(FormFieldCollection formFieldCollection)
```
public void updateFormFields(FormFieldCollection formFieldCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formFieldCollection | FormFieldCollection |  |

##### fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames)
```
public void fixInvalidFormFieldNames(List<InvalidFormField> updateInvalidFormFieldNames)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateInvalidFormFieldNames | java.util.List<com.groupdocs.editor.words.fieldmanagement.InvalidFormField> |  |

##### hasInvalidFormFields()
```
public boolean hasInvalidFormFields()
```

**Returns:**
boolean
##### removeFormField(IFormField formField)
```
public void removeFormField(IFormField formField)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formField | IFormField |  |

##### getInvalidFormFieldNames()
```
public Collection<InvalidFormField> getInvalidFormFieldNames()
```

**Returns:**
java.util.Collection<com.groupdocs.editor.words.fieldmanagement.InvalidFormField>
##### removeFormFields(List<IFormField> formFields)
```
public void removeFormFields(List<IFormField> formFields)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formFields | java.util.List<com.groupdocs.editor.words.fieldmanagement.IFormField> |  |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class IncorrectPasswordException extends RuntimeException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() |  |
| IncorrectPasswordException(String message) |  |
| IncorrectPasswordException(String message, RuntimeException inner) |  |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

##### IncorrectPasswordException(String message)
```
public IncorrectPasswordException(String message)
```

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

##### IncorrectPasswordException(String message, RuntimeException inner)
```
public IncorrectPasswordException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### InvalidFormatException
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/invalidformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class InvalidFormatException extends RuntimeException
```

The exception that is thrown when user tries to open some document with format-specific options that are incompatible with original document format.

For example, this exception will be thrown, if try to open Spreadsheet document with WordProcessing document options.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFormatException() |  |
| InvalidFormatException(String message) |  |
| InvalidFormatException(String message, RuntimeException inner) |  |
##### InvalidFormatException()
```
public InvalidFormatException()
```

##### InvalidFormatException(String message)
```
public InvalidFormatException(String message)
```

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

##### InvalidFormatException(String message, RuntimeException inner)
```
public InvalidFormatException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

### PasswordRequiredException
Path: https://reference.groupdocs.com/editor/nodejs-java/com.groupdocs.editor/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public final class PasswordRequiredException extends RuntimeException
```

The exception that is thrown when user tries to open a password-protected encrypted document of some format and doesn't provide a password for opening this document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() |  |
| PasswordRequiredException(String message) |  |
| PasswordRequiredException(String message, RuntimeException inner) |  |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

##### PasswordRequiredException(String message)
```
public PasswordRequiredException(String message)
```

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

##### PasswordRequiredException(String message, RuntimeException inner)
```
public PasswordRequiredException(String message, RuntimeException inner)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| inner | java.lang.RuntimeException |  |

## Python

### GroupDocs.Editor for Python via .NET
Path: https://reference.groupdocs.com/editor/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.editor` | Main GroupDocs.Editor namespace with top-level API classes. |
| `groupdocs.editor.formats` | Types under `groupdocs.editor.formats`. |
| `groupdocs.editor.formats.abstraction` | Types under `groupdocs.editor.formats.abstraction`. |
| `groupdocs.editor.metadata` | Types under `groupdocs.editor.metadata`. |
| `groupdocs.editor.options` | Option classes for configuring conversions and operations. |

### groupdocs.editor.formats.abstraction
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction.md

Types under `groupdocs.editor.formats.abstraction`.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentFormatBase` |  |
| `FormatFamilyBase` |  |
| `IDocumentFormat` |  |

### DocumentFormatBase class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase.md

#### DocumentFormatBase class

The DocumentFormatBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_idocument_format |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| equals |  |
| equals_idocument_format |  |
| equals_object |  |
| from_mime |  |
| get_hash_code |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### _equals_idocument_format method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/_equals_idocument_format.md

#### _equals_idocument_format

```python
def _equals_idocument_format(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `IDocumentFormat` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/_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/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/_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/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_idocument_format method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/equals_idocument_format.md

#### equals_idocument_format

```python
def equals_idocument_format(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_mime method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/from_mime.md

#### from_mime

```python
def from_mime(cls, mime):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mime | `str` |  |

**Returns:** Any

### get_hash_code method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/documentformatbase/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### FormatFamilyBase class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase.md

#### FormatFamilyBase class

The FormatFamilyBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_format_family_base |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_format_family_base |  |
| equals_object |  |
| from_name |  |
| from_value |  |
| get_all |  |
| get_hash_code |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| id |  |
| name |  |

### _equals_format_family_base method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/_equals_format_family_base.md

#### _equals_format_family_base

```python
def _equals_format_family_base(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FormatFamilyBase` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/_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/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/_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/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_format_family_base method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/equals_format_family_base.md

#### equals_format_family_base

```python
def equals_format_family_base(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### from_name method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/from_name.md

#### from_name

```python
def from_name(cls, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | `str` |  |

**Returns:** Any

### from_value method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/from_value.md

#### from_value

```python
def from_value(cls, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

**Returns:** Any

### get_all method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/get_all.md

#### get_all

```python
def get_all(cls):
    ...
```

**Returns:** Any

### get_hash_code method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/id.md

##### Definition:
```python
@property
def id(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/formatfamilybase/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### IDocumentFormat class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/idocumentformat.md

#### IDocumentFormat class

The IDocumentFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/idocumentformat/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/idocumentformat/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/idocumentformat/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.abstraction/idocumentformat/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### groupdocs.editor.formats
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats.md

Types under `groupdocs.editor.formats`.

##### Classes
| Class | Description |
| :- | :- |
| `EBookFormats` |  |
| `EmailFormats` |  |
| `FixedLayoutFormats` |  |
| `PresentationFormats` |  |
| `SpreadsheetFormats` |  |
| `TextualFormats` |  |
| `WordProcessingFormats` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FormatFamilies` |  |

### EBookFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats.md

#### EBookFormats class

The EBookFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** EBookFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/ebookformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### EmailFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats.md

#### EmailFormats class

The EmailFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** EmailFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/emailformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### FixedLayoutFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats.md

#### FixedLayoutFormats class

The FixedLayoutFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** FixedLayoutFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/fixedlayoutformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### FormatFamilies class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/formatfamilies.md

#### FormatFamilies class

The FormatFamilies type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_object |  (inherited from `FormatFamilyBase`) |
| _get_hash_code_noargs |  (inherited from `FormatFamilyBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `FormatFamilyBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_object |  (inherited from `FormatFamilyBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `FormatFamilyBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| id |  (inherited from `FormatFamilyBase`) |
| name |  (inherited from `FormatFamilyBase`) |

### PresentationFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats.md

#### PresentationFormats class

The PresentationFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** PresentationFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/presentationformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### SpreadsheetFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats.md

#### SpreadsheetFormats class

The SpreadsheetFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** SpreadsheetFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/spreadsheetformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### TextualFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats.md

#### TextualFormats class

The TextualFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** TextualFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/textualformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### WordProcessingFormats class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats.md

#### WordProcessingFormats class

The WordProcessingFormats type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| from_extension |  |
| _equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| _equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| _equals_object |  (inherited from `DocumentFormatBase`) |
| _get_hash_code_noargs |  (inherited from `DocumentFormatBase`) |
| _to_string_noargs |  (inherited from `FormatFamilyBase`) |
| equals |  (inherited from `DocumentFormatBase`) |
| equals_format_family_base |  (inherited from `FormatFamilyBase`) |
| equals_idocument_format |  (inherited from `DocumentFormatBase`) |
| equals_object |  (inherited from `DocumentFormatBase`) |
| from_mime |  (inherited from `DocumentFormatBase`) |
| from_name |  (inherited from `FormatFamilyBase`) |
| from_value |  (inherited from `FormatFamilyBase`) |
| get_all |  (inherited from `FormatFamilyBase`) |
| get_hash_code |  (inherited from `DocumentFormatBase`) |
| to_string |  (inherited from `FormatFamilyBase`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| format_family |  |
| mime |  |
| name |  |
| id |  (inherited from `FormatFamilyBase`) |

### extension property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats/format_family.md

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** WordProcessingFormats

### mime property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats/mime.md

##### Definition:
```python
@property
def mime(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.formats/wordprocessingformats/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### groupdocs.editor.metadata
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata.md

Types under `groupdocs.editor.metadata`.

##### Classes
| Class | Description |
| :- | :- |
| `EbookDocumentInfo` |  |
| `EmailDocumentInfo` |  |
| `FixedLayoutDocumentInfo` |  |
| `IDocumentInfo` |  |
| `MarkdownDocumentInfo` |  |
| `PresentationDocumentInfo` |  |
| `SpreadsheetDocumentInfo` |  |
| `TextualDocumentInfo` |  |
| `WordProcessingDocumentInfo` |  |

### EbookDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo.md

#### EbookDocumentInfo class

The EbookDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_ebook_document_info |  |
| equals |  |
| equals_ebook_document_info |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_ebook_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/_equals_ebook_document_info.md

#### _equals_ebook_document_info

```python
def _equals_ebook_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `EbookDocumentInfo` |  |

**Returns:** bool

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_ebook_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/equals_ebook_document_info.md

#### equals_ebook_document_info

```python
def equals_ebook_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/ebookdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### EmailDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo.md

#### EmailDocumentInfo class

The EmailDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_email_document_info |  |
| equals |  |
| equals_email_document_info |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_email_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/_equals_email_document_info.md

#### _equals_email_document_info

```python
def _equals_email_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `EmailDocumentInfo` |  |

**Returns:** bool

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_email_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/equals_email_document_info.md

#### equals_email_document_info

```python
def equals_email_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/emaildocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### FixedLayoutDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo.md

#### FixedLayoutDocumentInfo class

The FixedLayoutDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_fixed_layout_document_info |  |
| equals |  |
| equals_fixed_layout_document_info |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_fixed_layout_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/_equals_fixed_layout_document_info.md

#### _equals_fixed_layout_document_info

```python
def _equals_fixed_layout_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FixedLayoutDocumentInfo` |  |

**Returns:** bool

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_fixed_layout_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/equals_fixed_layout_document_info.md

#### equals_fixed_layout_document_info

```python
def equals_fixed_layout_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/fixedlayoutdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### IDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/idocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/idocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/idocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### MarkdownDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo.md

#### MarkdownDocumentInfo class

The MarkdownDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_markdown_document_info |  |
| equals |  |
| equals_markdown_document_info |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_markdown_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/_equals_markdown_document_info.md

#### _equals_markdown_document_info

```python
def _equals_markdown_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `MarkdownDocumentInfo` |  |

**Returns:** bool

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_markdown_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/equals_markdown_document_info.md

#### equals_markdown_document_info

```python
def equals_markdown_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/markdowndocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### PresentationDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo.md

#### PresentationDocumentInfo class

The PresentationDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _generate_preview_int32 |  |
| generate_preview |  |
| generate_preview_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/_generate_preview_int32.md

#### _generate_preview_int32

```python
def _generate_preview_int32(self, slide_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| slide_index | `int` |  |

**Returns:** SvgImage

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/generate_preview_int32.md

#### generate_preview_int32

```python
def generate_preview_int32(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/presentationdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### SpreadsheetDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo.md

#### SpreadsheetDocumentInfo class

The SpreadsheetDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_spreadsheet_document_info |  |
| _generate_preview_int32 |  |
| equals |  |
| equals_spreadsheet_document_info |  |
| generate_preview |  |
| generate_preview_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_spreadsheet_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/_equals_spreadsheet_document_info.md

#### _equals_spreadsheet_document_info

```python
def _equals_spreadsheet_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `SpreadsheetDocumentInfo` |  |

**Returns:** bool

### _generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/_generate_preview_int32.md

#### _generate_preview_int32

```python
def _generate_preview_int32(self, worksheet_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | `int` |  |

**Returns:** SvgImage

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_spreadsheet_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/equals_spreadsheet_document_info.md

#### equals_spreadsheet_document_info

```python
def equals_spreadsheet_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/generate_preview_int32.md

#### generate_preview_int32

```python
def generate_preview_int32(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/spreadsheetdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### TextualDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo.md

#### TextualDocumentInfo class

The TextualDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### encoding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/textualdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### WordProcessingDocumentInfo class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo.md

#### WordProcessingDocumentInfo class

The WordProcessingDocumentInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_word_processing_document_info |  |
| _generate_preview_int32 |  |
| equals |  |
| equals_word_processing_document_info |  |
| generate_preview |  |
| generate_preview_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| format |  |
| is_encrypted |  |
| page_count |  |
| size |  |

### _equals_word_processing_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/_equals_word_processing_document_info.md

#### _equals_word_processing_document_info

```python
def _equals_word_processing_document_info(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `WordProcessingDocumentInfo` |  |

**Returns:** bool

### _generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/_generate_preview_int32.md

#### _generate_preview_int32

```python
def _generate_preview_int32(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | `int` |  |

**Returns:** SvgImage

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_word_processing_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/equals_word_processing_document_info.md

#### equals_word_processing_document_info

```python
def equals_word_processing_document_info(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_int32 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/generate_preview_int32.md

#### generate_preview_int32

```python
def generate_preview_int32(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.metadata/wordprocessingdocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### groupdocs.editor.options
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `DelimitedTextEditOptions` |  |
| `DelimitedTextSaveOptions` |  |
| `EbookEditOptions` |  |
| `EbookSaveOptions` |  |
| `EmailEditOptions` |  |
| `EmailSaveOptions` |  |
| `FixedLayoutEditOptionsBase` |  |
| `HtmlSaveOptions` |  |
| `IHtmlSavingCallback` |  |
| `ILoadOptions` |  |
| `IMarkdownImageLoadCallback` |  |
| `MarkdownEditOptions` |  |
| `MarkdownImageLoadArgs` |  |
| `MarkdownSaveOptions` |  |
| `MhtmlSaveOptions` |  |
| `PageRange` |  |
| `PdfEditOptions` |  |
| `PdfLoadOptions` |  |
| `PdfSaveOptions` |  |
| `PresentationEditOptions` |  |
| `PresentationLoadOptions` |  |
| `PresentationSaveOptions` |  |
| `SpreadsheetEditOptions` |  |
| `SpreadsheetLoadOptions` |  |
| `SpreadsheetSaveOptions` |  |
| `TextEditOptions` |  |
| `TextSaveOptions` |  |
| `WebFont` |  |
| `WordProcessingEditOptions` |  |
| `WordProcessingLoadOptions` |  |
| `WordProcessingProtection` |  |
| `WordProcessingSaveOptions` |  |
| `WorksheetProtection` |  |
| `XmlEditOptions` |  |
| `XmlFormatOptions` |  |
| `XmlHighlightOptions` |  |
| `XpsSaveOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FontEmbeddingOptions` |  |
| `FontExtractionOptions` |  |
| `IEditOptions` |  |
| `ISaveOptions` |  |
| `MailMessageOutput` |  |
| `MarkdownImageLoadingAction` |  |
| `MarkdownTableContentAlignment` |  |
| `PdfCompliance` |  |
| `TextDirection` |  |
| `TextLeadingSpacesOptions` |  |
| `TextTrailingSpacesOptions` |  |
| `WordProcessingProtectionType` |  |
| `WorksheetProtectionType` |  |

### DelimitedTextEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions.md

#### DelimitedTextEditOptions class

The DelimitedTextEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| convert_date_time_data |  |
| convert_numeric_data |  |
| optimize_memory_usage |  |
| separator |  |
| treat_consecutive_delimiters_as_one |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/_init_string.md

#### _init_string

```python
def _init_string(self, separator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| separator | `str` |  |

### convert_date_time_data property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/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/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/convert_numeric_data.md

##### Definition:
```python
@property
def convert_numeric_data(self):
    ...
@convert_numeric_data.setter
def convert_numeric_data(self, value):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### separator property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/separator.md

##### Definition:
```python
@property
def separator(self):
    ...
@separator.setter
def separator(self, value):
    ...
```

### treat_consecutive_delimiters_as_one property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtexteditoptions/treat_consecutive_delimiters_as_one.md

##### Definition:
```python
@property
def treat_consecutive_delimiters_as_one(self):
    ...
@treat_consecutive_delimiters_as_one.setter
def treat_consecutive_delimiters_as_one(self, value):
    ...
```

### DelimitedTextSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions.md

#### DelimitedTextSaveOptions class

The DelimitedTextSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| keep_separators_for_blank_row |  |
| separator |  |
| trim_leading_blank_row_and_column |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/_init_string.md

#### _init_string

```python
def _init_string(self, separator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| separator | `str` |  |

### encoding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### keep_separators_for_blank_row property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/keep_separators_for_blank_row.md

##### Definition:
```python
@property
def keep_separators_for_blank_row(self):
    ...
@keep_separators_for_blank_row.setter
def keep_separators_for_blank_row(self, value):
    ...
```

### separator property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/separator.md

##### Definition:
```python
@property
def separator(self):
    ...
@separator.setter
def separator(self, value):
    ...
```

### trim_leading_blank_row_and_column property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/delimitedtextsaveoptions/trim_leading_blank_row_and_column.md

##### Definition:
```python
@property
def trim_leading_blank_row_and_column(self):
    ...
@trim_leading_blank_row_and_column.setter
def trim_leading_blank_row_and_column(self, value):
    ...
```

### EbookEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions.md

#### EbookEditOptions class

The EbookEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| enable_language_information |  |
| enable_pagination |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, enable_pagination):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| enable_pagination | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### enable_language_information property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions/enable_language_information.md

##### Definition:
```python
@property
def enable_language_information(self):
    ...
@enable_language_information.setter
def enable_language_information(self, value):
    ...
```

### enable_pagination property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebookeditoptions/enable_pagination.md

##### Definition:
```python
@property
def enable_pagination(self):
    ...
@enable_pagination.setter
def enable_pagination(self, value):
    ...
```

### EbookSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions.md

#### EbookSaveOptions class

The EbookSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_ebook_formats |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| export_document_properties |  |
| output_format |  |
| split_heading_level |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_ebook_formats method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/_init_ebook_formats.md

#### _init_ebook_formats

```python
def _init_ebook_formats(self, output_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_format | `EBookFormats` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### export_document_properties property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/export_document_properties.md

##### Definition:
```python
@property
def export_document_properties(self):
    ...
@export_document_properties.setter
def export_document_properties(self, value):
    ...
```

### output_format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/output_format.md

##### Definition:
```python
@property
def output_format(self):
    ...
@output_format.setter
def output_format(self, value):
    ...
```

### split_heading_level property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ebooksaveoptions/split_heading_level.md

##### Definition:
```python
@property
def split_heading_level(self):
    ...
@split_heading_level.setter
def split_heading_level(self, value):
    ...
```

### EmailEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emaileditoptions.md

#### EmailEditOptions class

The EmailEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_mail_message_output |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| mail_message_output |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emaileditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_mail_message_output method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emaileditoptions/_init_mail_message_output.md

#### _init_mail_message_output

```python
def _init_mail_message_output(self, mail_message_output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mail_message_output | `MailMessageOutput` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emaileditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### mail_message_output property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emaileditoptions/mail_message_output.md

##### Definition:
```python
@property
def mail_message_output(self):
    ...
@mail_message_output.setter
def mail_message_output(self, value):
    ...
```

### EmailSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emailsaveoptions.md

#### EmailSaveOptions class

The EmailSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_mail_message_output |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| mail_message_output |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emailsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_mail_message_output method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emailsaveoptions/_init_mail_message_output.md

#### _init_mail_message_output

```python
def _init_mail_message_output(self, mail_message_output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mail_message_output | `MailMessageOutput` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emailsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### mail_message_output property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/emailsaveoptions/mail_message_output.md

##### Definition:
```python
@property
def mail_message_output(self):
    ...
@mail_message_output.setter
def mail_message_output(self, value):
    ...
```

### FixedLayoutEditOptionsBase class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fixedlayouteditoptionsbase.md

#### FixedLayoutEditOptionsBase class

The FixedLayoutEditOptionsBase type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| enable_pagination |  |
| pages |  |
| skip_images |  |

### enable_pagination property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fixedlayouteditoptionsbase/enable_pagination.md

##### Definition:
```python
@property
def enable_pagination(self):
    ...
@enable_pagination.setter
def enable_pagination(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fixedlayouteditoptionsbase/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### skip_images property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fixedlayouteditoptionsbase/skip_images.md

##### Definition:
```python
@property
def skip_images(self):
    ...
@skip_images.setter
def skip_images(self, value):
    ...
```

### FontEmbeddingOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontembeddingoptions.md

#### FontEmbeddingOptions class

The FontEmbeddingOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NOT_EMBED |  |
| EMBED_ALL |  |
| EMBED_WITHOUT_SYSTEM |  |

### EMBED_ALL field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontembeddingoptions/embed_all.md

##### Value
`1`

### EMBED_WITHOUT_SYSTEM field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontembeddingoptions/embed_without_system.md

##### Value
`2`

### NOT_EMBED field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontembeddingoptions/not_embed.md

##### Value
`0`

### FontExtractionOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontextractionoptions.md

#### FontExtractionOptions class

The FontExtractionOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NOT_EXTRACT |  |
| EXTRACT_ALL_EMBEDDED |  |
| EXTRACT_EMBEDDED_WITHOUT_SYSTEM |  |
| EXTRACT_ALL |  |

### EXTRACT_ALL field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontextractionoptions/extract_all.md

##### Value
`3`

### EXTRACT_ALL_EMBEDDED field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontextractionoptions/extract_all_embedded.md

##### Value
`1`

### EXTRACT_EMBEDDED_WITHOUT_SYSTEM field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontextractionoptions/extract_embedded_without_system.md

##### Value
`2`

### NOT_EXTRACT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/fontextractionoptions/not_extract.md

##### Value
`0`

### HtmlSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions.md

#### HtmlSaveOptions class

The HtmlSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| attribute_value_delimiter |  |
| embed_stylesheets_into_markup |  |
| html_tag_case |  |
| saving_callback |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### attribute_value_delimiter property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/attribute_value_delimiter.md

##### Definition:
```python
@property
def attribute_value_delimiter(self):
    ...
@attribute_value_delimiter.setter
def attribute_value_delimiter(self, value):
    ...
```

### embed_stylesheets_into_markup property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/embed_stylesheets_into_markup.md

##### Definition:
```python
@property
def embed_stylesheets_into_markup(self):
    ...
@embed_stylesheets_into_markup.setter
def embed_stylesheets_into_markup(self, value):
    ...
```

### html_tag_case property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/html_tag_case.md

##### Definition:
```python
@property
def html_tag_case(self):
    ...
@html_tag_case.setter
def html_tag_case(self, value):
    ...
```

### saving_callback property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/htmlsaveoptions/saving_callback.md

##### Definition:
```python
@property
def saving_callback(self):
    ...
@saving_callback.setter
def saving_callback(self, value):
    ...
```

### IEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ieditoptions.md

#### IEditOptions class

The IEditOptions type exposes the following members:

### IHtmlSavingCallback class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ihtmlsavingcallback.md

#### IHtmlSavingCallback class

The IHtmlSavingCallback type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _save_one_resource_ihtml_resource |  |
| save_one_resource |  |
| save_one_resource_ihtml_resource |  |

### _save_one_resource_ihtml_resource method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ihtmlsavingcallback/_save_one_resource_ihtml_resource.md

#### _save_one_resource_ihtml_resource

```python
def _save_one_resource_ihtml_resource(self, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| resource | `IHtmlResource` |  |

**Returns:** str

### save_one_resource method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ihtmlsavingcallback/save_one_resource.md

#### save_one_resource

```python
def save_one_resource(self):
    ...
```

### save_one_resource_ihtml_resource method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/ihtmlsavingcallback/save_one_resource_ihtml_resource.md

#### save_one_resource_ihtml_resource

```python
def save_one_resource_ihtml_resource(self):
    ...
```

### ILoadOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/iloadoptions.md

#### ILoadOptions class

The ILoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/iloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### IMarkdownImageLoadCallback class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/imarkdownimageloadcallback.md

#### IMarkdownImageLoadCallback class

The IMarkdownImageLoadCallback type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _process_image_markdown_image_load_args |  |
| process_image |  |
| process_image_markdown_image_load_args |  |

### _process_image_markdown_image_load_args method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/imarkdownimageloadcallback/_process_image_markdown_image_load_args.md

#### _process_image_markdown_image_load_args

```python
def _process_image_markdown_image_load_args(self, args):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| args | `MarkdownImageLoadArgs` |  |

**Returns:** MarkdownImageLoadingAction

### process_image method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/imarkdownimageloadcallback/process_image.md

#### process_image

```python
def process_image(self):
    ...
```

### process_image_markdown_image_load_args method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/imarkdownimageloadcallback/process_image_markdown_image_load_args.md

#### process_image_markdown_image_load_args

```python
def process_image_markdown_image_load_args(self):
    ...
```

### ISaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/isaveoptions.md

#### ISaveOptions class

The ISaveOptions type exposes the following members:

### MailMessageOutput class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput.md

#### MailMessageOutput class

The MailMessageOutput type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| BODY |  |
| SUBJECT |  |
| DATE |  |
| TO |  |
| CC |  |
| BCC |  |
| FROM |  |
| COMMON |  |
| ATTACHMENTS |  |
| METADATA |  |
| ALL |  |

### ALL field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/all.md

##### Value
`511`

### ATTACHMENTS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/attachments.md

##### Value
`128`

### BCC field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/bcc.md

##### Value
`32`

### BODY field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/body.md

##### Value
`1`

### CC field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/cc.md

##### Value
`16`

### COMMON field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/common.md

##### Value
`123`

### DATE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/date.md

##### Value
`4`

### FROM field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/from.md

##### Value
`64`

### METADATA field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/metadata.md

##### Value
`256`

### NONE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/none.md

##### Value
`0`

### SUBJECT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/subject.md

##### Value
`2`

### TO field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mailmessageoutput/to.md

##### Value
`8`

### MarkdownEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowneditoptions.md

#### MarkdownEditOptions class

The MarkdownEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| image_load_callback |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowneditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowneditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### image_load_callback property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowneditoptions/image_load_callback.md

##### Definition:
```python
@property
def image_load_callback(self):
    ...
@image_load_callback.setter
def image_load_callback(self, value):
    ...
```

### MarkdownImageLoadArgs class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs.md

#### MarkdownImageLoadArgs class

The MarkdownImageLoadArgs type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _set_data_byte_array |  |
| set_data |  |
| set_data_bytes |  |

##### Properties
| Property | Description |
| :- | :- |
| image_file_name |  |
| is_absolute_uri |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _set_data_byte_array method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/_set_data_byte_array.md

#### _set_data_byte_array

```python
def _set_data_byte_array(self, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data | `bytes` |  |

### image_file_name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/image_file_name.md

##### Definition:
```python
@property
def image_file_name(self):
    ...
@image_file_name.setter
def image_file_name(self, value):
    ...
```

### is_absolute_uri property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/is_absolute_uri.md

##### Definition:
```python
@property
def is_absolute_uri(self):
    ...
@is_absolute_uri.setter
def is_absolute_uri(self, value):
    ...
```

### set_data method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/set_data.md

#### set_data

```python
def set_data(self):
    ...
```

### set_data_bytes method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadargs/set_data_bytes.md

#### set_data_bytes

```python
def set_data_bytes(self):
    ...
```

### MarkdownImageLoadingAction class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadingaction.md

#### MarkdownImageLoadingAction class

The MarkdownImageLoadingAction type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT |  |
| SKIP |  |
| USER_PROVIDED |  |

### DEFAULT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadingaction/default.md

##### Value
`0`

### SKIP field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadingaction/skip.md

##### Value
`1`

### USER_PROVIDED field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownimageloadingaction/user_provided.md

##### Value
`2`

### MarkdownSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions.md

#### MarkdownSaveOptions class

The MarkdownSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| export_images_as_base64 |  |
| images_folder |  |
| optimize_memory_usage |  |
| table_content_alignment |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### export_images_as_base64 property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/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):
    ...
```

### images_folder property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/images_folder.md

##### Definition:
```python
@property
def images_folder(self):
    ...
@images_folder.setter
def images_folder(self, value):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### table_content_alignment property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdownsaveoptions/table_content_alignment.md

##### Definition:
```python
@property
def table_content_alignment(self):
    ...
@table_content_alignment.setter
def table_content_alignment(self, value):
    ...
```

### MarkdownTableContentAlignment class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowntablecontentalignment.md

#### MarkdownTableContentAlignment class

The MarkdownTableContentAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO |  |
| LEFT |  |
| CENTER |  |
| RIGHT |  |

### AUTO field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowntablecontentalignment/auto.md

##### Value
`0`

### CENTER field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowntablecontentalignment/center.md

##### Value
`2`

### LEFT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowntablecontentalignment/left.md

##### Value
`1`

### RIGHT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/markdowntablecontentalignment/right.md

##### Value
`3`

### MhtmlSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions.md

#### MhtmlSaveOptions class

The MhtmlSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| export_cid_urls |  |
| export_document_properties |  |
| export_language_information |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### export_cid_urls property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions/export_cid_urls.md

##### Definition:
```python
@property
def export_cid_urls(self):
    ...
@export_cid_urls.setter
def export_cid_urls(self, value):
    ...
```

### export_document_properties property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions/export_document_properties.md

##### Definition:
```python
@property
def export_document_properties(self):
    ...
@export_document_properties.setter
def export_document_properties(self, value):
    ...
```

### export_language_information property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/mhtmlsaveoptions/export_language_information.md

##### Definition:
```python
@property
def export_language_information(self):
    ...
@export_language_information.setter
def export_language_information(self, value):
    ...
```

### PageRange class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange.md

#### PageRange class

The PageRange type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_page_range |  |
| equals |  |
| equals_page_range |  |
| from_beginning_with_count |  |
| from_start_page_till_end |  |
| from_start_page_till_end_page |  |
| from_start_page_with_count |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| end_number |  |
| is_default |  |
| start_number |  |

### _equals_page_range method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/_equals_page_range.md

#### _equals_page_range

```python
def _equals_page_range(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `PageRange` |  |

**Returns:** bool

### count property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### end_number property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/end_number.md

##### Definition:
```python
@property
def end_number(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_page_range method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/equals_page_range.md

#### equals_page_range

```python
def equals_page_range(self):
    ...
```

### from_beginning_with_count method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/from_beginning_with_count.md

#### from_beginning_with_count

```python
def from_beginning_with_count(cls, page_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_count | `int` |  |

**Returns:** PageRange

### from_start_page_till_end method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/from_start_page_till_end.md

#### from_start_page_till_end

```python
def from_start_page_till_end(cls, start_page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_page_number | `int` |  |

**Returns:** PageRange

### from_start_page_till_end_page method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/from_start_page_till_end_page.md

#### from_start_page_till_end_page

```python
def from_start_page_till_end_page(cls, start_page_number, end_page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_page_number | `int` |  |
| end_page_number | `int` |  |

**Returns:** PageRange

### from_start_page_with_count method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/from_start_page_with_count.md

#### from_start_page_with_count

```python
def from_start_page_with_count(cls, start_page_number, page_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_page_number | `int` |  |
| page_count | `int` |  |

**Returns:** PageRange

### is_default property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/is_default.md

##### Definition:
```python
@property
def is_default(self):
    ...
```

### start_number property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pagerange/start_number.md

##### Definition:
```python
@property
def start_number(self):
    ...
```

### PdfCompliance class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance.md

#### PdfCompliance class

The PdfCompliance type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PDF17 |  |
| PDF20 |  |
| PDF_A1A |  |
| PDF_A1B |  |
| PDF_A2A |  |
| PDF_A2U |  |
| PDF_UA1 |  |

### PDF17 field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf17.md

##### Value
`0`

### PDF20 field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf20.md

##### Value
`1`

### PDF_A1A field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf_a1a.md

##### Value
`2`

### PDF_A1B field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf_a1b.md

##### Value
`3`

### PDF_A2A field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf_a2a.md

##### Value
`4`

### PDF_A2U field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf_a2u.md

##### Value
`5`

### PDF_UA1 field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfcompliance/pdf_ua1.md

##### Value
`6`

### PdfEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfeditoptions.md

#### PdfEditOptions class

The PdfEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| enable_pagination |  (inherited from `FixedLayoutEditOptionsBase`) |
| pages |  (inherited from `FixedLayoutEditOptionsBase`) |
| skip_images |  (inherited from `FixedLayoutEditOptionsBase`) |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfeditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfeditoptions/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, enable_pagination):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| enable_pagination | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfeditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### PdfLoadOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfloadoptions.md

#### PdfLoadOptions class

The PdfLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### PdfSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions.md

#### PdfSaveOptions class

The PdfSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| compliance |  |
| font_embedding |  |
| optimize_memory_usage |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compliance property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/compliance.md

##### Definition:
```python
@property
def compliance(self):
    ...
@compliance.setter
def compliance(self, value):
    ...
```

### font_embedding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/font_embedding.md

##### Definition:
```python
@property
def font_embedding(self):
    ...
@font_embedding.setter
def font_embedding(self, value):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/pdfsaveoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### PresentationEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationeditoptions.md

#### PresentationEditOptions class

The PresentationEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| show_hidden_slides |  |
| slide_number |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationeditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationeditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### show_hidden_slides property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationeditoptions/show_hidden_slides.md

##### Definition:
```python
@property
def show_hidden_slides(self):
    ...
@show_hidden_slides.setter
def show_hidden_slides(self, value):
    ...
```

### slide_number property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationeditoptions/slide_number.md

##### Definition:
```python
@property
def slide_number(self):
    ...
@slide_number.setter
def slide_number(self, value):
    ...
```

### PresentationLoadOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationloadoptions.md

#### PresentationLoadOptions class

The PresentationLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### PresentationSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions.md

#### PresentationSaveOptions class

The PresentationSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_presentation_formats |  |

##### Properties
| Property | Description |
| :- | :- |
| insert_as_new_slide |  |
| output_format |  |
| password |  |
| slide_number |  |
| slide_numbers_to_delete |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_presentation_formats method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/_init_presentation_formats.md

#### _init_presentation_formats

```python
def _init_presentation_formats(self, output_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_format | `PresentationFormats` |  |

### insert_as_new_slide property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/insert_as_new_slide.md

##### Definition:
```python
@property
def insert_as_new_slide(self):
    ...
@insert_as_new_slide.setter
def insert_as_new_slide(self, value):
    ...
```

### output_format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/output_format.md

##### Definition:
```python
@property
def output_format(self):
    ...
@output_format.setter
def output_format(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### slide_number property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/slide_number.md

##### Definition:
```python
@property
def slide_number(self):
    ...
@slide_number.setter
def slide_number(self, value):
    ...
```

### slide_numbers_to_delete property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/presentationsaveoptions/slide_numbers_to_delete.md

##### Definition:
```python
@property
def slide_numbers_to_delete(self):
    ...
@slide_numbers_to_delete.setter
def slide_numbers_to_delete(self, value):
    ...
```

### SpreadsheetEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheeteditoptions.md

#### SpreadsheetEditOptions class

The SpreadsheetEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| exclude_hidden_worksheets |  |
| worksheet_index |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheeteditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheeteditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### exclude_hidden_worksheets property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheeteditoptions/exclude_hidden_worksheets.md

##### Definition:
```python
@property
def exclude_hidden_worksheets(self):
    ...
@exclude_hidden_worksheets.setter
def exclude_hidden_worksheets(self, value):
    ...
```

### worksheet_index property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheeteditoptions/worksheet_index.md

##### Definition:
```python
@property
def worksheet_index(self):
    ...
@worksheet_index.setter
def worksheet_index(self, value):
    ...
```

### SpreadsheetLoadOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

The SpreadsheetLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| optimize_memory_usage |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetloadoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### SpreadsheetSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

The SpreadsheetSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_spreadsheet_formats |  |

##### Properties
| Property | Description |
| :- | :- |
| insert_as_new_worksheet |  |
| output_format |  |
| password |  |
| worksheet_number |  |
| worksheet_numbers_to_delete |  |
| worksheet_protection |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_spreadsheet_formats method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/_init_spreadsheet_formats.md

#### _init_spreadsheet_formats

```python
def _init_spreadsheet_formats(self, output_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_format | `SpreadsheetFormats` |  |

### insert_as_new_worksheet property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/insert_as_new_worksheet.md

##### Definition:
```python
@property
def insert_as_new_worksheet(self):
    ...
@insert_as_new_worksheet.setter
def insert_as_new_worksheet(self, value):
    ...
```

### output_format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/output_format.md

##### Definition:
```python
@property
def output_format(self):
    ...
@output_format.setter
def output_format(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### worksheet_number property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/worksheet_number.md

##### Definition:
```python
@property
def worksheet_number(self):
    ...
@worksheet_number.setter
def worksheet_number(self, value):
    ...
```

### worksheet_numbers_to_delete property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/worksheet_numbers_to_delete.md

##### Definition:
```python
@property
def worksheet_numbers_to_delete(self):
    ...
@worksheet_numbers_to_delete.setter
def worksheet_numbers_to_delete(self, value):
    ...
```

### worksheet_protection property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/spreadsheetsaveoptions/worksheet_protection.md

##### Definition:
```python
@property
def worksheet_protection(self):
    ...
@worksheet_protection.setter
def worksheet_protection(self, value):
    ...
```

### TextDirection class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textdirection.md

#### TextDirection class

The TextDirection type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LEFT_TO_RIGHT |  |
| RIGHT_TO_LEFT |  |
| AUTO |  |

### AUTO field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textdirection/auto.md

##### Value
`2`

### LEFT_TO_RIGHT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textdirection/left_to_right.md

##### Value
`0`

### RIGHT_TO_LEFT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textdirection/right_to_left.md

##### Value
`1`

### TextEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions.md

#### TextEditOptions class

The TextEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| direction |  |
| enable_pagination |  |
| encoding |  |
| leading_spaces |  |
| recognize_lists |  |
| trailing_spaces |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### direction property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/direction.md

##### Definition:
```python
@property
def direction(self):
    ...
@direction.setter
def direction(self, value):
    ...
```

### enable_pagination property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/enable_pagination.md

##### Definition:
```python
@property
def enable_pagination(self):
    ...
@enable_pagination.setter
def enable_pagination(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### leading_spaces property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/leading_spaces.md

##### Definition:
```python
@property
def leading_spaces(self):
    ...
@leading_spaces.setter
def leading_spaces(self, value):
    ...
```

### recognize_lists property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/recognize_lists.md

##### Definition:
```python
@property
def recognize_lists(self):
    ...
@recognize_lists.setter
def recognize_lists(self, value):
    ...
```

### trailing_spaces property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texteditoptions/trailing_spaces.md

##### Definition:
```python
@property
def trailing_spaces(self):
    ...
@trailing_spaces.setter
def trailing_spaces(self, value):
    ...
```

### TextLeadingSpacesOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textleadingspacesoptions.md

#### TextLeadingSpacesOptions class

The TextLeadingSpacesOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CONVERT_TO_INDENT |  |
| PRESERVE |  |
| TRIM |  |

### CONVERT_TO_INDENT field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textleadingspacesoptions/convert_to_indent.md

##### Value
`0`

### PRESERVE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textleadingspacesoptions/preserve.md

##### Value
`1`

### TRIM field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textleadingspacesoptions/trim.md

##### Value
`2`

### TextSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions.md

#### TextSaveOptions class

The TextSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| add_bidi_marks |  |
| encoding |  |
| preserve_table_layout |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### add_bidi_marks property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions/add_bidi_marks.md

##### Definition:
```python
@property
def add_bidi_marks(self):
    ...
@add_bidi_marks.setter
def add_bidi_marks(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### preserve_table_layout property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/textsaveoptions/preserve_table_layout.md

##### Definition:
```python
@property
def preserve_table_layout(self):
    ...
@preserve_table_layout.setter
def preserve_table_layout(self, value):
    ...
```

### TextTrailingSpacesOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texttrailingspacesoptions.md

#### TextTrailingSpacesOptions class

The TextTrailingSpacesOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TRIM |  |
| PRESERVE |  |

### PRESERVE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texttrailingspacesoptions/preserve.md

##### Value
`1`

### TRIM field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/texttrailingspacesoptions/trim.md

##### Value
`0`

### WebFont class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont.md

#### WebFont class

The WebFont type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _equals_object |  |
| _equals_web_font |  |
| clone |  |
| equals |  |
| equals_object |  |
| equals_web_font |  |

##### Properties
| Property | Description |
| :- | :- |
| color |  |
| line |  |
| name |  |
| size |  |
| style |  |
| weight |  |

### _clone_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** WebFont

### _equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_web_font method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/_equals_web_font.md

#### _equals_web_font

```python
def _equals_web_font(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `WebFont` |  |

**Returns:** bool

### clone method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/clone.md

#### clone

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/color.md

##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_web_font method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/equals_web_font.md

#### equals_web_font

```python
def equals_web_font(self):
    ...
```

### line property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/line.md

##### Definition:
```python
@property
def line(self):
    ...
@line.setter
def line(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/size.md

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### style property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/style.md

##### Definition:
```python
@property
def style(self):
    ...
@style.setter
def style(self, value):
    ...
```

### weight property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/webfont/weight.md

##### Definition:
```python
@property
def weight(self):
    ...
@weight.setter
def weight(self, value):
    ...
```

### WordProcessingEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions.md

#### WordProcessingEditOptions class

The WordProcessingEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| enable_language_information |  |
| enable_pagination |  |
| extract_only_used_font |  |
| font_extraction |  |
| input_controls_class_name |  |
| use_inline_styles |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, enable_pagination):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| enable_pagination | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### enable_language_information property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/enable_language_information.md

##### Definition:
```python
@property
def enable_language_information(self):
    ...
@enable_language_information.setter
def enable_language_information(self, value):
    ...
```

### enable_pagination property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/enable_pagination.md

##### Definition:
```python
@property
def enable_pagination(self):
    ...
@enable_pagination.setter
def enable_pagination(self, value):
    ...
```

### extract_only_used_font property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/extract_only_used_font.md

##### Definition:
```python
@property
def extract_only_used_font(self):
    ...
@extract_only_used_font.setter
def extract_only_used_font(self, value):
    ...
```

### font_extraction property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/font_extraction.md

##### Definition:
```python
@property
def font_extraction(self):
    ...
@font_extraction.setter
def font_extraction(self, value):
    ...
```

### input_controls_class_name property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/input_controls_class_name.md

##### Definition:
```python
@property
def input_controls_class_name(self):
    ...
@input_controls_class_name.setter
def input_controls_class_name(self, value):
    ...
```

### use_inline_styles property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingeditoptions/use_inline_styles.md

##### Definition:
```python
@property
def use_inline_styles(self):
    ...
@use_inline_styles.setter
def use_inline_styles(self, value):
    ...
```

### WordProcessingLoadOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

The WordProcessingLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingloadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingloadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### WordProcessingProtection class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection.md

#### WordProcessingProtection class

The WordProcessingProtection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_word_processing_protection_type_string |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |
| protection_type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_word_processing_protection_type_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection/_init_word_processing_protection_type_string.md

#### _init_word_processing_protection_type_string

```python
def _init_word_processing_protection_type_string(self, protection_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| protection_type | `WordProcessingProtectionType` |  |
| password | `str` |  |

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### protection_type property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotection/protection_type.md

##### Definition:
```python
@property
def protection_type(self):
    ...
@protection_type.setter
def protection_type(self, value):
    ...
```

### WordProcessingProtectionType class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype.md

#### WordProcessingProtectionType class

The WordProcessingProtectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NO_PROTECTION |  |
| ALLOW_ONLY_REVISIONS |  |
| ALLOW_ONLY_COMMENTS |  |
| ALLOW_ONLY_FORM_FIELDS |  |
| READ_ONLY |  |

### ALLOW_ONLY_COMMENTS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype/allow_only_comments.md

##### Value
`2`

### ALLOW_ONLY_FORM_FIELDS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype/allow_only_form_fields.md

##### Value
`3`

### ALLOW_ONLY_REVISIONS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype/allow_only_revisions.md

##### Value
`1`

### NO_PROTECTION field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype/no_protection.md

##### Value
`0`

### READ_ONLY field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingprotectiontype/read_only.md

##### Value
`4`

### WordProcessingSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

The WordProcessingSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _init_noargs |  |
| _init_word_processing_formats |  |
| clone |  |

##### Properties
| Property | Description |
| :- | :- |
| enable_pagination |  |
| font_embedding |  |
| locale |  |
| locale_bi |  |
| locale_far_east |  |
| optimize_memory_usage |  |
| output_format |  |
| password |  |
| protection |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** WordProcessingSaveOptions

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_word_processing_formats method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/_init_word_processing_formats.md

#### _init_word_processing_formats

```python
def _init_word_processing_formats(self, output_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_format | `WordProcessingFormats` |  |

### clone method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### enable_pagination property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/enable_pagination.md

##### Definition:
```python
@property
def enable_pagination(self):
    ...
@enable_pagination.setter
def enable_pagination(self, value):
    ...
```

### font_embedding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/font_embedding.md

##### Definition:
```python
@property
def font_embedding(self):
    ...
@font_embedding.setter
def font_embedding(self, value):
    ...
```

### locale property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/locale.md

##### Definition:
```python
@property
def locale(self):
    ...
@locale.setter
def locale(self, value):
    ...
```

### locale_bi property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/locale_bi.md

##### Definition:
```python
@property
def locale_bi(self):
    ...
@locale_bi.setter
def locale_bi(self, value):
    ...
```

### locale_far_east property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/locale_far_east.md

##### Definition:
```python
@property
def locale_far_east(self):
    ...
@locale_far_east.setter
def locale_far_east(self, value):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### output_format property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/output_format.md

##### Definition:
```python
@property
def output_format(self):
    ...
@output_format.setter
def output_format(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### protection property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/wordprocessingsaveoptions/protection.md

##### Definition:
```python
@property
def protection(self):
    ...
@protection.setter
def protection(self, value):
    ...
```

### WorksheetProtection class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection.md

#### WorksheetProtection class

The WorksheetProtection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_worksheet_protection_type_string |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |
| protection_type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_worksheet_protection_type_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection/_init_worksheet_protection_type_string.md

#### _init_worksheet_protection_type_string

```python
def _init_worksheet_protection_type_string(self, protection_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| protection_type | `WorksheetProtectionType` |  |
| password | `str` |  |

### password property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### protection_type property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotection/protection_type.md

##### Definition:
```python
@property
def protection_type(self):
    ...
@protection_type.setter
def protection_type(self, value):
    ...
```

### WorksheetProtectionType class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype.md

#### WorksheetProtectionType class

The WorksheetProtectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| ALL |  |
| CONTENTS |  |
| OBJECTS |  |
| SCENARIOS |  |
| STRUCTURE |  |
| WINDOW |  |

### ALL field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/all.md

##### Value
`1`

### CONTENTS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/contents.md

##### Value
`2`

### NONE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/none.md

##### Value
`0`

### OBJECTS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/objects.md

##### Value
`3`

### SCENARIOS field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/scenarios.md

##### Value
`4`

### STRUCTURE field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/structure.md

##### Value
`5`

### WINDOW field
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/worksheetprotectiontype/window.md

##### Value
`6`

### XmlEditOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions.md

#### XmlEditOptions class

The XmlEditOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| attribute_values_quote_type |  |
| encoding |  |
| fix_incorrect_structure |  |
| format_options |  |
| highlight_options |  |
| recognize_emails |  |
| recognize_uris |  |
| trim_trailing_whitespaces |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### attribute_values_quote_type property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/attribute_values_quote_type.md

##### Definition:
```python
@property
def attribute_values_quote_type(self):
    ...
@attribute_values_quote_type.setter
def attribute_values_quote_type(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### fix_incorrect_structure property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/fix_incorrect_structure.md

##### Definition:
```python
@property
def fix_incorrect_structure(self):
    ...
@fix_incorrect_structure.setter
def fix_incorrect_structure(self, value):
    ...
```

### format_options property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/format_options.md

##### Definition:
```python
@property
def format_options(self):
    ...
```

### highlight_options property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/highlight_options.md

##### Definition:
```python
@property
def highlight_options(self):
    ...
```

### recognize_emails property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/recognize_emails.md

##### Definition:
```python
@property
def recognize_emails(self):
    ...
@recognize_emails.setter
def recognize_emails(self, value):
    ...
```

### recognize_uris property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/recognize_uris.md

##### Definition:
```python
@property
def recognize_uris(self):
    ...
@recognize_uris.setter
def recognize_uris(self, value):
    ...
```

### trim_trailing_whitespaces property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmleditoptions/trim_trailing_whitespaces.md

##### Definition:
```python
@property
def trim_trailing_whitespaces(self):
    ...
@trim_trailing_whitespaces.setter
def trim_trailing_whitespaces(self, value):
    ...
```

### XmlFormatOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlformatoptions.md

#### XmlFormatOptions class

The XmlFormatOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| each_attribute_from_newline |  |
| is_default |  |
| leaf_text_nodes_on_newline |  |
| left_indent |  |

### each_attribute_from_newline property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlformatoptions/each_attribute_from_newline.md

##### Definition:
```python
@property
def each_attribute_from_newline(self):
    ...
@each_attribute_from_newline.setter
def each_attribute_from_newline(self, value):
    ...
```

### is_default property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlformatoptions/is_default.md

##### Definition:
```python
@property
def is_default(self):
    ...
```

### leaf_text_nodes_on_newline property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlformatoptions/leaf_text_nodes_on_newline.md

##### Definition:
```python
@property
def leaf_text_nodes_on_newline(self):
    ...
@leaf_text_nodes_on_newline.setter
def leaf_text_nodes_on_newline(self, value):
    ...
```

### left_indent property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlformatoptions/left_indent.md

##### Definition:
```python
@property
def left_indent(self):
    ...
@left_indent.setter
def left_indent(self, value):
    ...
```

### XmlHighlightOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions.md

#### XmlHighlightOptions class

The XmlHighlightOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _reset_to_default_noargs |  |
| reset_to_default |  |

##### Properties
| Property | Description |
| :- | :- |
| attribute_names_font_settings |  |
| attribute_values_font_settings |  |
| cdata_font_settings |  |
| html_comments_font_settings |  |
| inner_text_font_settings |  |
| is_default |  |
| xml_tags_font_settings |  |

### _reset_to_default_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/_reset_to_default_noargs.md

#### _reset_to_default_noargs

```python
def _reset_to_default_noargs(self):
    ...
```

### attribute_names_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/attribute_names_font_settings.md

##### Definition:
```python
@property
def attribute_names_font_settings(self):
    ...
```

### attribute_values_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/attribute_values_font_settings.md

##### Definition:
```python
@property
def attribute_values_font_settings(self):
    ...
```

### cdata_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/cdata_font_settings.md

##### Definition:
```python
@property
def cdata_font_settings(self):
    ...
```

### html_comments_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/html_comments_font_settings.md

##### Definition:
```python
@property
def html_comments_font_settings(self):
    ...
```

### inner_text_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/inner_text_font_settings.md

##### Definition:
```python
@property
def inner_text_font_settings(self):
    ...
```

### is_default property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/is_default.md

##### Definition:
```python
@property
def is_default(self):
    ...
```

### reset_to_default method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/reset_to_default.md

#### reset_to_default

```python
def reset_to_default(self):
    ...
```

### xml_tags_font_settings property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xmlhighlightoptions/xml_tags_font_settings.md

##### Definition:
```python
@property
def xml_tags_font_settings(self):
    ...
```

### XpsSaveOptions class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xpssaveoptions.md

#### XpsSaveOptions class

The XpsSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| optimize_memory_usage |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xpssaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xpssaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### optimize_memory_usage property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.options/xpssaveoptions/optimize_memory_usage.md

##### Definition:
```python
@property
def optimize_memory_usage(self):
    ...
@optimize_memory_usage.setter
def optimize_memory_usage(self, value):
    ...
```

### groupdocs.editor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor.md

Main GroupDocs.Editor namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `EditableDocument` |  |
| `Editor` |  |
| `FormFieldManager` |  |
| `License` | Manages GroupDocs.Editor licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `EncryptedException` |  |
| `GroupDocsEditorException` | Product-root exception for 'editor' — every |
| `IncorrectPasswordException` |  |
| `InvalidFontFormatException` |  |
| `InvalidFormatException` |  |
| `InvalidImageFormatException` |  |
| `PasswordRequiredException` |  |

### EditableDocument class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument.md

#### EditableDocument class

The EditableDocument type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _dispose_noargs |  |
| _from_markup_string |  |
| _from_markup_string_ienumerable_1_aeba |  |
| _get_body_content_noargs |  |
| _get_body_content_string |  |
| _get_content_arg_encoding |  |
| _get_content_noargs |  |
| _get_content_string_string |  |
| _get_css_content_noargs |  |
| _get_css_content_string_string |  |
| _get_embedded_html_noargs |  |
| _save_string |  |
| _save_string_string |  |
| _save_text_writer_html_save_options |  |
| dispose |  |
| from_file |  |
| from_markup |  |
| from_markup_and_resource_folder |  |
| from_markup_file |  |
| from_markup_string |  |
| get_body_content |  |
| get_body_content_file |  |
| get_body_content_string |  |
| get_content |  |
| get_content_file |  |
| get_content_string |  |
| get_css_content |  |
| get_css_content_file |  |
| get_css_content_string |  |
| get_embedded_html |  |
| save |  |
| save_file |  |
| save_string |  |
| save_text_writer |  |

##### Properties
| Property | Description |
| :- | :- |
| all_resources |  |
| audio |  |
| css |  |
| fonts |  |
| images |  |
| is_disposed |  |

### _dispose_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _from_markup_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_from_markup_string.md

#### _from_markup_string

```python
def _from_markup_string(cls, new_html_content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_html_content | `str` |  |

**Returns:** EditableDocument

### _from_markup_string_ienumerable_1_aeba method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_from_markup_string_ienumerable_1_aeba.md

#### _from_markup_string_ienumerable_1_aeba

```python
def _from_markup_string_ienumerable_1_aeba(cls, new_html_content, resources):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_html_content | `str` |  |
| resources | `List[Any]` |  |

**Returns:** EditableDocument

### _get_body_content_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_body_content_noargs.md

#### _get_body_content_noargs

```python
def _get_body_content_noargs(self):
    ...
```

**Returns:** str

### _get_body_content_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_body_content_string.md

#### _get_body_content_string

```python
def _get_body_content_string(self, external_images_template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| external_images_template | `str` |  |

**Returns:** str

### _get_content_arg_encoding method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_content_arg_encoding.md

#### _get_content_arg_encoding

```python
def _get_content_arg_encoding(self, storage, encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| storage | `Any` |  |
| encoding | `Encoding` |  |

**Returns:** Any

### _get_content_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_content_noargs.md

#### _get_content_noargs

```python
def _get_content_noargs(self):
    ...
```

**Returns:** str

### _get_content_string_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_content_string_string.md

#### _get_content_string_string

```python
def _get_content_string_string(self, external_images_template, external_css_template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| external_images_template | `str` |  |
| external_css_template | `str` |  |

**Returns:** str

### _get_css_content_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_css_content_noargs.md

#### _get_css_content_noargs

```python
def _get_css_content_noargs(self):
    ...
```

**Returns:** List[Any]

### _get_css_content_string_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_css_content_string_string.md

#### _get_css_content_string_string

```python
def _get_css_content_string_string(self, external_images_prefix, external_fonts_prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| external_images_prefix | `str` |  |
| external_fonts_prefix | `str` |  |

**Returns:** List[Any]

### _get_embedded_html_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_get_embedded_html_noargs.md

#### _get_embedded_html_noargs

```python
def _get_embedded_html_noargs(self):
    ...
```

**Returns:** str

### _save_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_save_string.md

#### _save_string

```python
def _save_string(self, html_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| html_file_path | `str` |  |

### _save_string_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_save_string_string.md

#### _save_string_string

```python
def _save_string_string(self, html_file_path, resources_folder_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| html_file_path | `str` |  |
| resources_folder_path | `str` |  |

### _save_text_writer_html_save_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/_save_text_writer_html_save_options.md

#### _save_text_writer_html_save_options

```python
def _save_text_writer_html_save_options(self, html_markup, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| html_markup | `TextWriter` |  |
| save_options | `HtmlSaveOptions` |  |

### all_resources property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/all_resources.md

##### Definition:
```python
@property
def all_resources(self):
    ...
```

### audio property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/audio.md

##### Definition:
```python
@property
def audio(self):
    ...
```

### css property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/css.md

##### Definition:
```python
@property
def css(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### fonts property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/fonts.md

##### Definition:
```python
@property
def fonts(self):
    ...
```

### from_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/from_file.md

#### from_file

```python
def from_file(cls, html_file_path, resource_folder_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| html_file_path | `str` |  |
| resource_folder_path | `str` |  |

**Returns:** EditableDocument

### from_markup method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/from_markup.md

#### from_markup

```python
def from_markup(cls):
    ...
```

### from_markup_and_resource_folder method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/from_markup_and_resource_folder.md

#### from_markup_and_resource_folder

```python
def from_markup_and_resource_folder(cls, new_html_content, resource_folder_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_html_content | `str` |  |
| resource_folder_path | `str` |  |

**Returns:** EditableDocument

### from_markup_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/from_markup_file.md

#### from_markup_file

```python
def from_markup_file(cls):
    ...
```

### from_markup_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/from_markup_string.md

#### from_markup_string

```python
def from_markup_string(cls):
    ...
```

### get_body_content method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_body_content.md

#### get_body_content

```python
def get_body_content(self):
    ...
```

### get_body_content_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_body_content_file.md

#### get_body_content_file

```python
def get_body_content_file(self):
    ...
```

### get_body_content_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_body_content_string.md

#### get_body_content_string

```python
def get_body_content_string(self):
    ...
```

### get_content method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_content.md

#### get_content

```python
def get_content(self):
    ...
```

### get_content_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_content_file.md

#### get_content_file

```python
def get_content_file(self):
    ...
```

### get_content_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_content_string.md

#### get_content_string

```python
def get_content_string(self):
    ...
```

### get_css_content method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_css_content.md

#### get_css_content

```python
def get_css_content(self):
    ...
```

### get_css_content_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_css_content_file.md

#### get_css_content_file

```python
def get_css_content_file(self):
    ...
```

### get_css_content_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_css_content_string.md

#### get_css_content_string

```python
def get_css_content_string(self):
    ...
```

### get_embedded_html method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/get_embedded_html.md

#### get_embedded_html

```python
def get_embedded_html(self):
    ...
```

### images property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/images.md

##### Definition:
```python
@property
def images(self):
    ...
```

### is_disposed property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/is_disposed.md

##### Definition:
```python
@property
def is_disposed(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/save.md

#### save

```python
def save(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### save_text_writer method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editabledocument/save_text_writer.md

#### save_text_writer

```python
def save_text_writer(self):
    ...
```

### Editor class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor.md

#### Editor class

The Editor type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _dispose_noargs |  |
| _edit_iedit_options |  |
| _edit_noargs |  |
| _get_document_info_string |  |
| _init_document_format_base |  |
| _init_stream |  |
| _init_stream_iload_options |  |
| _init_string |  |
| _init_string_iload_options |  |
| _save_editable_document_stream_isave_options |  |
| _save_editable_document_string |  |
| _save_editable_document_string_isave_options |  |
| _save_stream |  |
| _save_stream_word_processing_save_options |  |
| dispose |  |
| edit |  |
| edit_iedit_options |  |
| get_document_info |  |
| get_document_info_file |  |
| get_document_info_string |  |
| save |  |
| save_editable_document |  |
| save_file |  |
| save_stream |  |
| save_streams |  |
| save_string |  |

##### Properties
| Property | Description |
| :- | :- |
| form_field_manager |  |
| is_disposed |  |

### __init__ constructor
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _dispose_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _edit_iedit_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_edit_iedit_options.md

#### _edit_iedit_options

```python
def _edit_iedit_options(self, edit_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| edit_options | `IEditOptions` |  |

**Returns:** EditableDocument

### _edit_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_edit_noargs.md

#### _edit_noargs

```python
def _edit_noargs(self):
    ...
```

**Returns:** EditableDocument

### _get_document_info_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_get_document_info_string.md

#### _get_document_info_string

```python
def _get_document_info_string(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |

**Returns:** IDocumentInfo

### _init_document_format_base method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_init_document_format_base.md

#### _init_document_format_base

```python
def _init_document_format_base(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | `DocumentFormatBase` |  |

### _init_stream method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_init_stream.md

#### _init_stream

```python
def _init_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _init_stream_iload_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_init_stream_iload_options.md

#### _init_stream_iload_options

```python
def _init_stream_iload_options(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `ILoadOptions` |  |

### _init_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_iload_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_init_string_iload_options.md

#### _init_string_iload_options

```python
def _init_string_iload_options(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `ILoadOptions` |  |

### _save_editable_document_stream_isave_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_save_editable_document_stream_isave_options.md

#### _save_editable_document_stream_isave_options

```python
def _save_editable_document_stream_isave_options(self, input_document, output_document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input_document | `EditableDocument` |  |
| output_document | `Stream` |  |
| save_options | `ISaveOptions` |  |

### _save_editable_document_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_save_editable_document_string.md

#### _save_editable_document_string

```python
def _save_editable_document_string(self, input_document, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input_document | `EditableDocument` |  |
| file_path | `str` |  |

### _save_editable_document_string_isave_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_save_editable_document_string_isave_options.md

#### _save_editable_document_string_isave_options

```python
def _save_editable_document_string_isave_options(self, input_document, file_path, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input_document | `EditableDocument` |  |
| file_path | `str` |  |
| save_options | `ISaveOptions` |  |

### _save_stream method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_save_stream.md

#### _save_stream

```python
def _save_stream(self, output_document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_document | `Stream` |  |

**Returns:** Stream

### _save_stream_word_processing_save_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/_save_stream_word_processing_save_options.md

#### _save_stream_word_processing_save_options

```python
def _save_stream_word_processing_save_options(self, output_document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_document | `Stream` |  |
| save_options | `WordProcessingSaveOptions` |  |

**Returns:** Stream

### dispose method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### edit method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/edit.md

#### edit

```python
def edit(self):
    ...
```

### edit_iedit_options method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/edit_iedit_options.md

#### edit_iedit_options

```python
def edit_iedit_options(self):
    ...
```

### form_field_manager property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/form_field_manager.md

##### Definition:
```python
@property
def form_field_manager(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### get_document_info_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/get_document_info_file.md

#### get_document_info_file

```python
def get_document_info_file(self):
    ...
```

### get_document_info_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/get_document_info_string.md

#### get_document_info_string

```python
def get_document_info_string(self):
    ...
```

### is_disposed property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/is_disposed.md

##### Definition:
```python
@property
def is_disposed(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save.md

#### save

```python
def save(self):
    ...
```

### save_editable_document method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save_editable_document.md

#### save_editable_document

```python
def save_editable_document(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/editor/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### EncryptedException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/encryptedexception.md

#### EncryptedException class

The EncryptedException type exposes the following members:

### FormFieldManager class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager.md

#### FormFieldManager class

The FormFieldManager type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _fix_invalid_form_field_names_ienumerable_1_2e10 |  |
| _get_invalid_form_field_names_noargs |  |
| _has_invalid_form_fields_noargs |  |
| _remove_form_fields_ienumerable_1_1ef7 |  |
| _remove_form_filed_iform_field |  |
| _update_form_filed_form_field_collection |  |
| fix_invalid_form_field_names |  |
| fix_invalid_form_field_names_ienumerable |  |
| get_invalid_form_field_names |  |
| has_invalid_form_fields |  |
| remove_form_fields |  |
| remove_form_fields_ienumerable |  |
| remove_form_filed |  |
| remove_form_filed_iform_field |  |
| update_form_filed |  |
| update_form_filed_form_field_collection |  |

##### Properties
| Property | Description |
| :- | :- |
| form_field_collection |  |

### _fix_invalid_form_field_names_ienumerable_1_2e10 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_fix_invalid_form_field_names_ienumerable_1_2e10.md

#### _fix_invalid_form_field_names_ienumerable_1_2e10

```python
def _fix_invalid_form_field_names_ienumerable_1_2e10(self, update_invalid_form_field_names):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| update_invalid_form_field_names | `List[Any]` |  |

### _get_invalid_form_field_names_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_get_invalid_form_field_names_noargs.md

#### _get_invalid_form_field_names_noargs

```python
def _get_invalid_form_field_names_noargs(self):
    ...
```

**Returns:** List[Any]

### _has_invalid_form_fields_noargs method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_has_invalid_form_fields_noargs.md

#### _has_invalid_form_fields_noargs

```python
def _has_invalid_form_fields_noargs(self):
    ...
```

**Returns:** bool

### _remove_form_fields_ienumerable_1_1ef7 method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_remove_form_fields_ienumerable_1_1ef7.md

#### _remove_form_fields_ienumerable_1_1ef7

```python
def _remove_form_fields_ienumerable_1_1ef7(self, form_fields):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| form_fields | `List[Any]` |  |

### _remove_form_filed_iform_field method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_remove_form_filed_iform_field.md

#### _remove_form_filed_iform_field

```python
def _remove_form_filed_iform_field(self, form_field):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| form_field | `IFormField` |  |

### _update_form_filed_form_field_collection method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/_update_form_filed_form_field_collection.md

#### _update_form_filed_form_field_collection

```python
def _update_form_filed_form_field_collection(self, form_field_collection):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| form_field_collection | `FormFieldCollection` |  |

### fix_invalid_form_field_names method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/fix_invalid_form_field_names.md

#### fix_invalid_form_field_names

```python
def fix_invalid_form_field_names(self):
    ...
```

### fix_invalid_form_field_names_ienumerable method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/fix_invalid_form_field_names_ienumerable.md

#### fix_invalid_form_field_names_ienumerable

```python
def fix_invalid_form_field_names_ienumerable(self):
    ...
```

### form_field_collection property
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/form_field_collection.md

##### Definition:
```python
@property
def form_field_collection(self):
    ...
```

### get_invalid_form_field_names method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/get_invalid_form_field_names.md

#### get_invalid_form_field_names

```python
def get_invalid_form_field_names(self):
    ...
```

### has_invalid_form_fields method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/has_invalid_form_fields.md

#### has_invalid_form_fields

```python
def has_invalid_form_fields(self):
    ...
```

### remove_form_fields method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/remove_form_fields.md

#### remove_form_fields

```python
def remove_form_fields(self):
    ...
```

### remove_form_fields_ienumerable method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/remove_form_fields_ienumerable.md

#### remove_form_fields_ienumerable

```python
def remove_form_fields_ienumerable(self):
    ...
```

### remove_form_filed method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/remove_form_filed.md

#### remove_form_filed

```python
def remove_form_filed(self):
    ...
```

### remove_form_filed_iform_field method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/remove_form_filed_iform_field.md

#### remove_form_filed_iform_field

```python
def remove_form_filed_iform_field(self):
    ...
```

### update_form_filed method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/update_form_filed.md

#### update_form_filed

```python
def update_form_filed(self):
    ...
```

### update_form_filed_form_field_collection method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/formfieldmanager/update_form_filed_form_field_collection.md

#### update_form_filed_form_field_collection

```python
def update_form_filed_form_field_collection(self):
    ...
```

### GroupDocsEditorException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/groupdocseditorexception.md

#### GroupDocsEditorException class

Product-root exception for 'editor' — every

generated exception subclasses this, and callers can
``except GroupDocsEditorException:`` as a catch-all for
this product without catching other GroupDocs errors.

The GroupDocsEditorException type exposes the following members:

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/incorrectpasswordexception.md

#### IncorrectPasswordException class

The IncorrectPasswordException type exposes the following members:

### InvalidFontFormatException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/invalidfontformatexception.md

#### InvalidFontFormatException class

The InvalidFontFormatException type exposes the following members:

### InvalidFormatException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/invalidformatexception.md

#### InvalidFormatException class

The InvalidFormatException type exposes the following members:

### InvalidImageFormatException class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/invalidimageformatexception.md

#### InvalidImageFormatException class

The InvalidImageFormatException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/license.md

#### License class

Manages GroupDocs.Editor 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. |

### set_license method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/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/editor/python-net/groupdocs.editor/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. |

### get_consumption_credit method
Path: https://reference.groupdocs.com/editor/python-net/groupdocs.editor/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/editor/python-net/groupdocs.editor/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/editor/python-net/groupdocs.editor/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/editor/python-net/groupdocs.editor/passwordrequiredexception.md

#### PasswordRequiredException class

The PasswordRequiredException type exposes the following members:


# GroupDocs.Markdown

> Export PDF, Word, Excel, and other formats to clean Markdown.

## .NET

### GroupDocs.Markdown for .NET
Path: https://reference.groupdocs.com/markdown/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Markdown | The **GroupDocs.Markdown** namespace provides classes for converting documents to Markdown format and exporting Markdown to other document formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

### GroupDocs.Markdown
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown.md

The **GroupDocs.Markdown** namespace provides classes for converting documents to Markdown format and exporting Markdown to other document formats.

#### Classes

| Class | Description |
| --- | --- |
| ConvertOptions | Provides options for customizing the document conversion process to Markdown format. |
| ConvertResult | Contains the output of a successful document-to-Markdown conversion. |
| CustomImageSavingArgs | Provides information and controls for saving a single image during document-to-Markdown conversion. An instance of this class is passed to the callback registered with `CustomImagesStrategy` for each image found in the source document. |
| CustomImagesStrategy | Implements an image export strategy that gives you full control over how images are saved during conversion. |
| CustomUriExportStrategy | Implements a URI export strategy that lets you customize how resource URIs are written to Markdown. |
| DefaultUriExportStrategy | Provides default URI handling that keeps the URIs generated by the library unchanged. |
| DocumentInfo | Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status. |
| DocumentProtectedException | The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via `Password`. |
| ExportImagesAsBase64Strategy | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
| ExportImagesToFileSystemStrategy | Saves images to a folder on disk during conversion. |
| ExportOptions | Options for exporting Markdown to a document format (reverse conversion). |
| GroupDocsMarkdownException | Represents a product-specific exception that is thrown during file processing. |
| ImageExportContext | Contains read-only information about a single image encountered during conversion. Passed to `GetImageStream`. |
| InvalidFormatException | The exception that is thrown when a file has an invalid format. |
| License | Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing). |
| LoadOptions | Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files. |
| MarkdownConverter | Converts documents from Word, Excel, PDF, and other formats to Markdown. Provides both static one-liner methods and an instance-based API with full control over conversion options. |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |
| SkipImagesStrategy | Implements an image export strategy that skips saving images during document conversion. |
| UriExportContext | Contains information about a resource URI being written during conversion. Passed to `UpdateResourceUri`. |
| UriSavingArgs | Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. An instance of this class is created for each resource and can be used to override the default URI or file name. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IImageExportStrategy | Defines a strategy for handling image export during document-to-Markdown conversion. Implement this interface to control where and how images extracted from the source document are stored. |
| IImageSavingHandler | Callback interface invoked for each image encountered during conversion when using `CustomImagesStrategy`. Implement this interface to rename images, redirect output to a custom stream, or apply other custom logic. |
| IUriExportStrategy | Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion. |
| IUriSavingHandler | Callback interface invoked for each resource URI during conversion when using `CustomUriExportStrategy`. Implement this interface to rewrite resource URIs in the Markdown output. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FileFormat | Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document). |
| MarkdownFlavor | Specifies the target Markdown dialect for the conversion output. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

### ConvertOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions.md

#### ConvertOptions class

Provides options for customizing the document conversion process to Markdown format.

```csharp
public class ConvertOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ConvertOptions() | Initializes a new instance of the `ConvertOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Flavor { get; set; } | Gets or sets the target Markdown dialect. |
| HeadingLevelOffset { get; set; } | Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns `#` into `###`, `##` into `####`, etc. Heading levels are clamped to the range 1-6. |
| ImageExportStrategy { get; set; } | Gets or sets the strategy for handling images during conversion. |
| IncludeFrontMatter { get; set; } | Gets or sets a value indicating whether to prepend YAML front matter to the Markdown output. When enabled, document metadata (title, author, format, page count) is extracted and written as a YAML block at the beginning of the output. |
| IncludeHiddenSheets { get; set; } | Gets or sets whether hidden worksheets are included in spreadsheet conversions. |
| MaxColumns { get; set; } | Gets or sets the maximum number of columns to include per table when converting spreadsheets. Columns beyond this limit are truncated with an ellipsis indicator. |
| MaxRows { get; set; } | Gets or sets the maximum number of data rows to include per worksheet when converting spreadsheets. Rows beyond this limit are truncated with an ellipsis indicator. |
| PageNumbers { get; set; } | Gets or sets an array of page or worksheet numbers to convert. Numbering starts from 1. |
| SheetSeparator { get; set; } | Gets or sets the separator inserted between worksheets in spreadsheet conversions. |
| UriExportStrategy { get; set; } | Gets or sets the strategy for customizing resource URIs written to Markdown output. |

##### Remarks

This class allows you to configure how documents are converted to Markdown, including how images are exported, how resource URIs are written, which pages to convert, and how heading levels are adjusted.

By default, images are embedded as Base64 strings in the Markdown output.

##### Examples

The following examples show different ways to configure conversion options:

```csharp
// Example 1: Using default options (images embedded as Base64)
var options = new ConvertOptions();

// Example 2: Saving images to a folder
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesToFileSystemStrategy("output/images")
};

// Example 3: Skipping image export
var options = new ConvertOptions
{
    ImageExportStrategy = new SkipImagesStrategy()
};

// Example 4: Converting only the first 3 pages
var options = new ConvertOptions
{
    PageNumbers = new[] { 1, 2, 3 }
};

// Example 5: Shifting headings down by 2 levels (# becomes ###)
var options = new ConvertOptions
{
    HeadingLevelOffset = 2
};

// Example 6: Generating YAML front matter from document metadata
var options = new ConvertOptions
{
    IncludeFrontMatter = true
};

// Example 7: Combining multiple options
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesToFileSystemStrategy("images"),
    HeadingLevelOffset = 1,
    IncludeFrontMatter = true,
    PageNumbers = new[] { 1, 2 }
};
```

### ConvertOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/convertoptions.md

#### ConvertOptions constructor

Initializes a new instance of the `ConvertOptions` class.

```csharp
public ConvertOptions()
```

##### Remarks

By default, `ImageExportStrategy` is set to `ExportImagesAsBase64Strategy`, which embeds images as Base64 strings directly in the Markdown output.

### Flavor
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/flavor.md

#### ConvertOptions.Flavor property

Gets or sets the target Markdown dialect.

```csharp
public MarkdownFlavor Flavor { get; set; }
```

##### Property Value

Default is GitHub.

### HeadingLevelOffset
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/headingleveloffset.md

#### ConvertOptions.HeadingLevelOffset property

Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns `#` into `###`, `##` into `####`, etc. Heading levels are clamped to the range 1-6.

```csharp
public int HeadingLevelOffset { get; set; }
```

##### Property Value

Default is 0 (no change).

##### Remarks

This is useful when you are embedding the converted Markdown inside a larger document where top-level headings are already in use. For example, setting this to 1 ensures the converted content starts at `##` instead of `#`.

##### Examples

Shift all headings down by one level so that source `H1` becomes Markdown `##`:

```csharp
var options = new ConvertOptions { HeadingLevelOffset = 1 };
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
```

### ImageExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/imageexportstrategy.md

#### ConvertOptions.ImageExportStrategy property

Gets or sets the strategy for handling images during conversion.

```csharp
public IImageExportStrategy ImageExportStrategy { get; set; }
```

##### Property Value

The image export strategy. Default is `ExportImagesAsBase64Strategy`.

##### Remarks

Built-in strategies:

* `ExportImagesAsBase64Strategy` - Embeds images as Base64 strings (default)
* `ExportImagesToFileSystemStrategy` - Saves images to a specified folder
* `SkipImagesStrategy` - Skips image saving
* `CustomImagesStrategy` - Custom image saving handler

Or implement `IImageExportStrategy` for a fully custom strategy.

### IncludeFrontMatter
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/includefrontmatter.md

#### ConvertOptions.IncludeFrontMatter property

Gets or sets a value indicating whether to prepend YAML front matter to the Markdown output. When enabled, document metadata (title, author, format, page count) is extracted and written as a YAML block at the beginning of the output.

```csharp
public bool IncludeFrontMatter { get; set; }
```

##### Property Value

Default is `false`.

##### Remarks

Front matter is commonly used by static site generators such as Jekyll, Hugo, and Docusaurus. Only non-empty metadata fields are included.

##### Examples

```csharp
var options = new ConvertOptions { IncludeFrontMatter = true };
string markdown = MarkdownConverter.ToMarkdown("report.docx", options);
// Output starts with:
// ---
// title: "Q3 Report"
// author: "Jane Doe"
// format: Docx
// pages: 12
// ---
```

### IncludeHiddenSheets
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/includehiddensheets.md

#### ConvertOptions.IncludeHiddenSheets property

Gets or sets whether hidden worksheets are included in spreadsheet conversions.

```csharp
public bool IncludeHiddenSheets { get; set; }
```

##### Property Value

Default is `false`.

### MaxColumns
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/maxcolumns.md

#### ConvertOptions.MaxColumns property

Gets or sets the maximum number of columns to include per table when converting spreadsheets. Columns beyond this limit are truncated with an ellipsis indicator.

```csharp
public int MaxColumns { get; set; }
```

##### Property Value

0 means unlimited (default).

### MaxRows
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/maxrows.md

#### ConvertOptions.MaxRows property

Gets or sets the maximum number of data rows to include per worksheet when converting spreadsheets. Rows beyond this limit are truncated with an ellipsis indicator.

```csharp
public int MaxRows { get; set; }
```

##### Property Value

0 means unlimited (default).

### PageNumbers
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/pagenumbers.md

#### ConvertOptions.PageNumbers property

Gets or sets an array of page or worksheet numbers to convert. Numbering starts from 1.

```csharp
public int[] PageNumbers { get; set; }
```

##### Property Value

An array of 1-based page numbers to convert, or `null` to convert all pages. Default is `null`.

### SheetSeparator
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/sheetseparator.md

#### ConvertOptions.SheetSeparator property

Gets or sets the separator inserted between worksheets in spreadsheet conversions.

```csharp
public string SheetSeparator { get; set; }
```

##### Property Value

Default is a horizontal rule (`\n---\n`).

### UriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertoptions/uriexportstrategy.md

#### ConvertOptions.UriExportStrategy property

Gets or sets the strategy for customizing resource URIs written to Markdown output.

```csharp
public IUriExportStrategy UriExportStrategy { get; set; }
```

##### Property Value

The URI export strategy, or `null` to keep the default URIs. Default is `null`.

### ConvertResult
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult.md

#### ConvertResult class

Contains the output of a successful document-to-Markdown conversion.

```csharp
public class ConvertResult
```

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Gets the converted Markdown content as a string. |
| ErrorMessage { get; } | Gets the error message if the conversion failed, or `null` if it succeeded. |
| Exception { get; } | Gets the exception that caused the conversion to fail, or `null` if the conversion succeeded. |
| IsSuccess { get; } | Gets a value indicating whether the conversion completed successfully. |
| Warnings { get; } | Gets a list of non-fatal warnings that occurred during conversion. |

#### Methods

| Name | Description |
| --- | --- |
| static Failure(string, Exception) | Creates a failed result with error information. |
| static Success() | Creates a successful result without content. Used when the output was written to a stream or file. |
| static Success(string) | Creates a successful result containing the converted Markdown content. |

##### Remarks

All `Convert` methods throw on failure, so a returned `ConvertResult` always represents a successful conversion. Use `Content` to read the Markdown string (when converting to string) and `Warnings` to check for non-fatal issues.

##### Examples

```csharp
using var converter = new MarkdownConverter("report.docx");
ConvertResult result = converter.Convert(); // throws on failure
Console.WriteLine(result.Content);           // always valid

foreach (string warning in result.Warnings)
    Console.WriteLine("Warning: " + warning);
```

### Content
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/content.md

#### ConvertResult.Content property

Gets the converted Markdown content as a string.

```csharp
public string Content { get; }
```

##### Property Value

The Markdown content when conversion is performed without an output stream or file path. Returns `null` if the conversion failed, or if the output was written to a stream or file.

### ErrorMessage
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/errormessage.md

#### ConvertResult.ErrorMessage property

Gets the error message if the conversion failed, or `null` if it succeeded.

```csharp
public string ErrorMessage { get; }
```

### Exception
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/exception.md

#### ConvertResult.Exception property

Gets the exception that caused the conversion to fail, or `null` if the conversion succeeded.

```csharp
public Exception Exception { get; }
```

### Failure
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/failure.md

#### ConvertResult.Failure method

Creates a failed result with error information.

```csharp
public static ConvertResult Failure(string errorMessage, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| errorMessage | String | A human-readable description of the error. |
| exception | Exception | The exception that caused the failure. |

##### Return Value

A `ConvertResult` with `IsSuccess` set to `false`.

### IsSuccess
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/issuccess.md

#### ConvertResult.IsSuccess property

Gets a value indicating whether the conversion completed successfully.

```csharp
public bool IsSuccess { get; }
```

##### Property Value

`true` if the conversion succeeded; otherwise, `false`.

### Success
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/success.md

#### Success()

Creates a successful result without content. Used when the output was written to a stream or file.

```csharp
public static ConvertResult Success()
```

##### Return Value

A `ConvertResult` with `IsSuccess` set to `true` and `Content` set to `null`.

#### Success(string)

Creates a successful result containing the converted Markdown content.

```csharp
public static ConvertResult Success(string content)
```

| Parameter | Type | Description |
| --- | --- | --- |
| content | String | The Markdown content produced by the conversion. |

##### Return Value

A `ConvertResult` with `IsSuccess` set to `true` and the specified content.

### Warnings
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/convertresult/warnings.md

#### ConvertResult.Warnings property

Gets a list of non-fatal warnings that occurred during conversion.

```csharp
public IReadOnlyList<string> Warnings { get; }
```

##### Property Value

A read-only list of warning messages. The list is empty when no warnings were generated. Warnings describe issues that did not prevent conversion but may affect the output (for example, unsupported formatting or missing resources).

### CustomImageSavingArgs
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs.md

#### CustomImageSavingArgs class

Provides information and controls for saving a single image during document-to-Markdown conversion. An instance of this class is passed to the callback registered with `CustomImagesStrategy` for each image found in the source document.

```csharp
public class CustomImageSavingArgs
```

#### Properties

| Name | Description |
| --- | --- |
| ImageFileName { get; } | Gets the default file name (without path) suggested by the library for this image. |
| ImageFileNameOutput { get; } | Gets the overridden file name set by `SetOutputImageFileName`, or `null` if no override was specified. |
| OutputDirectory { get; } | Gets the output directory where images are being saved. |
| OutputStream { get; } | Gets the custom output stream set by `SetOutputStream`, or `null` if no custom stream was specified. |
| ReplacementImageStream { get; } | Gets the replacement image stream set by `SetReplacementImage`, or `null` if no replacement was specified. |
| ShapeType { get; } | Gets the type of the shape that contains the image in the source document (for example, "Picture" or "Shape"). |

#### Methods

| Name | Description |
| --- | --- |
| SetOutputImageFileName(string) | Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated `ImageFileName`. |
| SetOutputStream(Stream) | Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion. |
| SetReplacementImage(Stream) | Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g. PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image. |

##### Remarks

Use `SetOutputImageFileName` to change the file name the image is saved under, or `SetOutputStream` to redirect the image data to a custom stream. If neither method is called, the library uses the defaults provided by `ImageFileName` and `OutputDirectory`.

##### Examples

Renaming images in a custom callback:

```csharp
var strategy = new CustomImagesStrategy(args =>
{
    // Change the output file name
    args.SetOutputImageFileName("thumb-" + args.ImageFileName);
});

var options = new ConvertOptions { ImageExportStrategy = strategy };
```

### ImageFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/imagefilename.md

#### CustomImageSavingArgs.ImageFileName property

Gets the default file name (without path) suggested by the library for this image.

```csharp
public string ImageFileName { get; }
```

### ImageFileNameOutput
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/imagefilenameoutput.md

#### CustomImageSavingArgs.ImageFileNameOutput property

Gets the overridden file name set by `SetOutputImageFileName`, or `null` if no override was specified.

```csharp
public string ImageFileNameOutput { get; }
```

### OutputDirectory
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/outputdirectory.md

#### CustomImageSavingArgs.OutputDirectory property

Gets the output directory where images are being saved.

```csharp
public string OutputDirectory { get; }
```

### OutputStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/outputstream.md

#### CustomImageSavingArgs.OutputStream property

Gets the custom output stream set by `SetOutputStream`, or `null` if no custom stream was specified.

```csharp
public Stream OutputStream { get; }
```

### ReplacementImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/replacementimagestream.md

#### CustomImageSavingArgs.ReplacementImageStream property

Gets the replacement image stream set by `SetReplacementImage`, or `null` if no replacement was specified.

```csharp
public Stream ReplacementImageStream { get; }
```

### SetOutputImageFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/setoutputimagefilename.md

#### CustomImageSavingArgs.SetOutputImageFileName method

Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated `ImageFileName`.

```csharp
public void SetOutputImageFileName(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | The new file name (without path) to use for the image. |

### SetOutputStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/setoutputstream.md

#### CustomImageSavingArgs.SetOutputStream method

Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion.

```csharp
public void SetOutputStream(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | A writable stream where the image data will be written. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is `null`. |

### SetReplacementImage
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/setreplacementimage.md

#### CustomImageSavingArgs.SetReplacementImage method

Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g. PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image.

```csharp
public void SetReplacementImage(Stream imageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | A readable stream containing the replacement image data. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *imageStream* is `null`. |

### ShapeType
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesavingargs/shapetype.md

#### CustomImageSavingArgs.ShapeType property

Gets the type of the shape that contains the image in the source document (for example, "Picture" or "Shape").

```csharp
public string ShapeType { get; }
```

### CustomImagesStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesstrategy.md

#### CustomImagesStrategy class

Implements an image export strategy that gives you full control over how images are saved during conversion.

```csharp
public class CustomImagesStrategy : IImageExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| CustomImagesStrategy(string, IImageSavingHandler) | Initializes a new instance of the `CustomImagesStrategy` class. |

#### Properties

| Name | Description |
| --- | --- |
| ImagesFolder { get; } | Gets the physical folder where images will be saved on disk. |
| ImagesRelativePath { get; set; } | Gets or sets the path used in the Markdown image references. When `null` or empty, the full `ImagesFolder` path is used. Set this to a relative path (e.g. `"images"`) for portable Markdown output. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream(ImageExportContext) | Gets a stream for writing the exported image to the file system. |

##### Remarks

Supply an `IImageSavingHandler` implementation to rename images, redirect them to a custom stream, or apply any other custom logic when each image is encountered.

##### Examples

Rename every image with a sequential prefix:

```csharp
var handler = new RenameHandler();
var options = new ConvertOptions
{
    ImageExportStrategy = new CustomImagesStrategy("images", handler)
};
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
```

### CustomImagesStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesstrategy/customimagesstrategy.md

#### CustomImagesStrategy constructor

Initializes a new instance of the `CustomImagesStrategy` class.

```csharp
public CustomImagesStrategy(string imagesFolder, IImageSavingHandler handler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imagesFolder | String | The folder where images will be exported. |
| handler | IImageSavingHandler | The handler that is called for each image during conversion. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *imagesFolder* is null. |

### GetImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesstrategy/getimagestream.md

#### CustomImagesStrategy.GetImageStream method

Gets a stream for writing the exported image to the file system.

```csharp
public Stream GetImageStream(ImageExportContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | ImageExportContext | The image export context containing information about the image being processed. |

##### Return Value

A stream for writing the image data to the file system.

### ImagesFolder
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesstrategy/imagesfolder.md

#### CustomImagesStrategy.ImagesFolder property

Gets the physical folder where images will be saved on disk.

```csharp
public string ImagesFolder { get; }
```

### ImagesRelativePath
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customimagesstrategy/imagesrelativepath.md

#### CustomImagesStrategy.ImagesRelativePath property

Gets or sets the path used in the Markdown image references. When `null` or empty, the full `ImagesFolder` path is used. Set this to a relative path (e.g. `"images"`) for portable Markdown output.

```csharp
public string ImagesRelativePath { get; set; }
```

### CustomUriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customuriexportstrategy.md

#### CustomUriExportStrategy class

Implements a URI export strategy that lets you customize how resource URIs are written to Markdown.

```csharp
public class CustomUriExportStrategy : IUriExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| CustomUriExportStrategy(IUriSavingHandler) | Initializes a new instance of the `CustomUriExportStrategy` class. |

#### Methods

| Name | Description |
| --- | --- |
| UpdateResourceUri(UriExportContext) |  |

##### Remarks

Supply an `IUriSavingHandler` implementation to rewrite resource URIs (for example, to prepend a CDN base URL).

##### Examples

```csharp
var handler = new CdnUriHandler();
var options = new ConvertOptions
{
    UriExportStrategy = new CustomUriExportStrategy(handler)
};
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
```

### CustomUriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customuriexportstrategy/customuriexportstrategy.md

#### CustomUriExportStrategy constructor

Initializes a new instance of the `CustomUriExportStrategy` class.

```csharp
public CustomUriExportStrategy(IUriSavingHandler handler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| handler | IUriSavingHandler | The handler that is called for each resource URI during conversion. |

### UpdateResourceUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/customuriexportstrategy/updateresourceuri.md

#### CustomUriExportStrategy.UpdateResourceUri method

```csharp
public void UpdateResourceUri(UriExportContext context)
```

### DefaultUriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/defaulturiexportstrategy.md

#### DefaultUriExportStrategy class

Provides default URI handling that keeps the URIs generated by the library unchanged.

```csharp
public class DefaultUriExportStrategy : IUriExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| DefaultUriExportStrategy() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| UpdateResourceUri(UriExportContext) |  |

### DefaultUriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/defaulturiexportstrategy/defaulturiexportstrategy.md

#### DefaultUriExportStrategy constructor

The default constructor.

```csharp
public DefaultUriExportStrategy()
```

### UpdateResourceUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/defaulturiexportstrategy/updateresourceuri.md

#### DefaultUriExportStrategy.UpdateResourceUri method

```csharp
public void UpdateResourceUri(UriExportContext context)
```

### DocumentInfo
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo.md

#### DocumentInfo class

Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status.

```csharp
public class DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets the document author extracted from its metadata, or Empty if no author is available. |
| FileFormat { get; } | Gets the detected file format of the document. |
| IsEncrypted { get; } | Gets a value indicating whether the document is password-protected. |
| PageCount { get; } | Gets the number of pages in the document. For spreadsheets this returns the number of worksheets. |
| Title { get; } | Gets the document title extracted from its metadata, or Empty if no title is available. |

##### Remarks

Use `GetDocumentInfo` or `GetInfo` to obtain an instance of this class. The information is extracted from the source document without performing a full conversion, so it is a lightweight way to inspect a file before converting it.

##### Examples

Inspect a document before converting it:

```csharp
// Using the static helper
DocumentInfo info = MarkdownConverter.GetInfo("report.docx");
Console.WriteLine($"Format: {info.FileFormat}");
Console.WriteLine($"Pages:  {info.PageCount}");
Console.WriteLine($"Title:  {info.Title}");
Console.WriteLine($"Author: {info.Author}");

if (info.IsEncrypted)
    Console.WriteLine("The document is password-protected.");
```

Using the instance method:

```csharp
using (var converter = new MarkdownConverter("spreadsheet.xlsx"))
{
    DocumentInfo info = converter.GetDocumentInfo();
    Console.WriteLine($"Worksheets: {info.PageCount}");
}
```

### Author
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo/author.md

#### DocumentInfo.Author property

Gets the document author extracted from its metadata, or Empty if no author is available.

```csharp
public string Author { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo/fileformat.md

#### DocumentInfo.FileFormat property

Gets the detected file format of the document.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

A `FileFormat` value indicating the document type (e.g., Docx, Pdf).

### IsEncrypted
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo/isencrypted.md

#### DocumentInfo.IsEncrypted property

Gets a value indicating whether the document is password-protected.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

`true` if the document requires a password to open; otherwise, `false`.

### PageCount
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

Gets the number of pages in the document. For spreadsheets this returns the number of worksheets.

```csharp
public int PageCount { get; }
```

##### Property Value

A non-negative integer representing the page or worksheet count.

### Title
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentinfo/title.md

#### DocumentInfo.Title property

Gets the document title extracted from its metadata, or Empty if no title is available.

```csharp
public string Title { get; }
```

### DocumentProtectedException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentprotectedexception.md

#### DocumentProtectedException class

The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via `Password`.

```csharp
public sealed class DocumentProtectedException : GroupDocsMarkdownException
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentProtectedException() | Initializes a new instance of the `DocumentProtectedException` class with the default message. |
| DocumentProtectedException(string, Exception) | Initializes a new instance of the `DocumentProtectedException` class. |

### DocumentProtectedException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/documentprotectedexception/documentprotectedexception.md

#### DocumentProtectedException()

Initializes a new instance of the `DocumentProtectedException` class with the default message.

```csharp
public DocumentProtectedException()
```

#### DocumentProtectedException(string, Exception)

Initializes a new instance of the `DocumentProtectedException` class.

```csharp
public DocumentProtectedException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| innerException | Exception | The exception that caused this error. |

### ExportImagesAsBase64Strategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagesasbase64strategy.md

#### ExportImagesAsBase64Strategy class

Implements an image export strategy that embeds images as Base64 strings directly in the Markdown.

```csharp
public class ExportImagesAsBase64Strategy : IImageExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportImagesAsBase64Strategy() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ImagesFolder { get; } | Gets an empty string as this strategy does not use an images folder. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream(ImageExportContext) | Returns null to indicate that the image should be embedded as Base64. |

##### Remarks

This strategy converts all images to Base64 format and embeds them directly in the Markdown document using the data URI scheme. This eliminates the need for separate image files, making the Markdown document self-contained. However, this approach increases the size of the Markdown file and may not be supported by all Markdown viewers.

##### Examples

The following example shows how to use ExportImagesAsBase64Strategy when converting a document:

```csharp
// Base64 is the default, but can be set explicitly:
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesAsBase64Strategy()
};
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
```

### ExportImagesAsBase64Strategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagesasbase64strategy/exportimagesasbase64strategy.md

#### ExportImagesAsBase64Strategy constructor

The default constructor.

```csharp
public ExportImagesAsBase64Strategy()
```

### GetImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagesasbase64strategy/getimagestream.md

#### ExportImagesAsBase64Strategy.GetImageStream method

Returns null to indicate that the image should be embedded as Base64.

```csharp
public Stream GetImageStream(ImageExportContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | ImageExportContext | The image export context (not used in this implementation). |

##### Return Value

Always returns null to indicate Base64 embedding.

### ImagesFolder
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagesasbase64strategy/imagesfolder.md

#### ExportImagesAsBase64Strategy.ImagesFolder property

Gets an empty string as this strategy does not use an images folder.

```csharp
public string ImagesFolder { get; }
```

##### Property Value

An empty string since images are embedded directly in the Markdown.

### ExportImagesToFileSystemStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagestofilesystemstrategy.md

#### ExportImagesToFileSystemStrategy class

Saves images to a folder on disk during conversion.

```csharp
public class ExportImagesToFileSystemStrategy : IImageExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportImagesToFileSystemStrategy(string) | Initializes a new instance of the `ExportImagesToFileSystemStrategy` class. |

#### Properties

| Name | Description |
| --- | --- |
| ImagesFolder { get; } | Gets the physical folder where images will be saved on disk. |
| ImagesRelativePath { get; set; } | Gets or sets the path used in the Markdown image references. When `null` or empty, the full `ImagesFolder` path is used (which may be absolute). Set this to a relative path (e.g. `"images"`) so the Markdown output contains portable references. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream(ImageExportContext) | Gets a stream for writing the exported image to the file system. |

##### Remarks

By default, the Markdown output references images using the full `ImagesFolder` path. Set `ImagesRelativePath` to control the path that appears in the Markdown image links — typically a path relative to the output `.md` file.

##### Examples

Save images next to the output file and reference them with a relative path:

```csharp
var strategy = new ExportImagesToFileSystemStrategy("c:/output/images")
{
    ImagesRelativePath = "images"
};
var options = new ConvertOptions { ImageExportStrategy = strategy };
MarkdownConverter.ToFile("document.docx", "c:/output/doc.md", options);
// Markdown contains: ![](images/img-001.png)
// Image file at:     c:/output/images/img-001.png
```

### ExportImagesToFileSystemStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagestofilesystemstrategy/exportimagestofilesystemstrategy.md

#### ExportImagesToFileSystemStrategy constructor

Initializes a new instance of the `ExportImagesToFileSystemStrategy` class.

```csharp
public ExportImagesToFileSystemStrategy(string imagesFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imagesFolder | String | The physical folder where images will be saved. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *imagesFolder* is null. |

### GetImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagestofilesystemstrategy/getimagestream.md

#### ExportImagesToFileSystemStrategy.GetImageStream method

Gets a stream for writing the exported image to the file system.

```csharp
public Stream GetImageStream(ImageExportContext context)
```

### ImagesFolder
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagestofilesystemstrategy/imagesfolder.md

#### ExportImagesToFileSystemStrategy.ImagesFolder property

Gets the physical folder where images will be saved on disk.

```csharp
public string ImagesFolder { get; }
```

### ImagesRelativePath
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportimagestofilesystemstrategy/imagesrelativepath.md

#### ExportImagesToFileSystemStrategy.ImagesRelativePath property

Gets or sets the path used in the Markdown image references. When `null` or empty, the full `ImagesFolder` path is used (which may be absolute). Set this to a relative path (e.g. `"images"`) so the Markdown output contains portable references.

```csharp
public string ImagesRelativePath { get; set; }
```

##### Property Value

Default is `null` (uses `ImagesFolder` as-is).

### ExportOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportoptions.md

#### ExportOptions class

Options for exporting Markdown to a document format (reverse conversion).

```csharp
public class ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportOptions() | Initializes a new instance of the `ExportOptions` class. |
| ExportOptions(FileFormat) | Initializes a new instance of the `ExportOptions` class with the specified target format. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; set; } | Gets or sets the target document format. If not set, the format is inferred from the output file extension. |

##### Remarks

Use this class with `FromMarkdown` to control how the Markdown content is converted to a document format such as DOCX or PDF.

##### Examples

```csharp
var options = new ExportOptions
{
    Format = FileFormat.Pdf
};
MarkdownConverter.FromMarkdown("input.md", "output.pdf", options);
```

### ExportOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportoptions/exportoptions.md

#### ExportOptions()

Initializes a new instance of the `ExportOptions` class.

```csharp
public ExportOptions()
```

#### ExportOptions(FileFormat)

Initializes a new instance of the `ExportOptions` class with the specified target format.

```csharp
public ExportOptions(FileFormat format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | FileFormat | The target document format. |

### Format
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/exportoptions/format.md

#### ExportOptions.Format property

Gets or sets the target document format. If not set, the format is inferred from the output file extension.

```csharp
public FileFormat Format { get; set; }
```

##### Property Value

Default is Unknown (infer from file extension).

### FileFormat
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/fileformat.md

#### FileFormat enumeration

Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document).

```csharp
public enum FileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The file format is not specified. The library will attempt to detect the format automatically. |
| Doc | `1` | Microsoft Word 97-2003 Document (.doc). |
| Docx | `2` | Microsoft Word Document (.docx). |
| Docm | `3` | Microsoft Word Macro-Enabled Document (.docm). |
| Dot | `4` | Microsoft Word 97-2003 Template (.dot). |
| Dotx | `5` | Microsoft Word Template (.dotx). |
| Dotm | `6` | Microsoft Word Macro-Enabled Template (.dotm). |
| Rtf | `7` | Rich Text Format (.rtf). |
| Odt | `8` | OpenDocument Text (.odt). |
| Ott | `9` | OpenDocument Text Template (.ott). |
| Xlsx | `10` | Microsoft Excel Spreadsheet (.xlsx). |
| Xls | `11` | Microsoft Excel 97-2003 Spreadsheet (.xls). |
| Xlsb | `12` | Microsoft Excel Binary Spreadsheet (.xlsb). |
| Xlsm | `13` | Microsoft Excel Macro-Enabled Spreadsheet (.xlsm). |
| Csv | `14` | Comma-Separated Values (.csv). |
| Tsv | `15` | Tab-Separated Values (.tsv). |
| Ods | `16` | OpenDocument Spreadsheet (.ods). |
| Ots | `17` | OpenDocument Spreadsheet Template (.ots). |
| Pdf | `18` | Portable Document Format (.pdf). |
| Epub | `19` | Electronic Publication (.epub). |
| Mobi | `20` | Mobipocket E-Book (.mobi). |
| Txt | `21` | Plain Text (.txt). |
| Md | `22` | Markdown (.md). Used as input format for reverse conversion (Markdown to document). |
| Chm | `23` | Compiled HTML Help (.chm). |

##### Remarks

Pass a value from this enum to the `LoadOptions` constructor to explicitly specify the source document format, or use Unknown to let the library detect it automatically. Use `GetSupportedFormats` to retrieve all formats supported for conversion.

### GroupDocsMarkdownException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/groupdocsmarkdownexception.md

#### GroupDocsMarkdownException class

Represents a product-specific exception that is thrown during file processing.

```csharp
public class GroupDocsMarkdownException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsMarkdownException() | Initializes a new instance of the `GroupDocsMarkdownException` class. |
| GroupDocsMarkdownException(string) | Initializes a new instance of the `GroupDocsMarkdownException` class. |
| GroupDocsMarkdownException(string, Exception) | Initializes a new instance of the `GroupDocsMarkdownException` class. |

### GroupDocsMarkdownException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/groupdocsmarkdownexception/groupdocsmarkdownexception.md

#### GroupDocsMarkdownException()

Initializes a new instance of the `GroupDocsMarkdownException` class.

```csharp
public GroupDocsMarkdownException()
```

#### GroupDocsMarkdownException(string)

Initializes a new instance of the `GroupDocsMarkdownException` class.

```csharp
public GroupDocsMarkdownException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### GroupDocsMarkdownException(string, Exception)

Initializes a new instance of the `GroupDocsMarkdownException` class.

```csharp
public GroupDocsMarkdownException(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. |

### IImageExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iimageexportstrategy.md

#### IImageExportStrategy interface

Defines a strategy for handling image export during document-to-Markdown conversion. Implement this interface to control where and how images extracted from the source document are stored.

```csharp
public interface IImageExportStrategy
```

#### Properties

| Name | Description |
| --- | --- |
| ImagesFolder { get; } | Gets the folder path where exported images will be stored. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream(ImageExportContext) | Returns a writable stream for the image described by *context*. The library writes the image bytes to this stream during conversion. |

##### Remarks

The library ships with several built-in strategies:

* `ExportImagesAsBase64Strategy` -- embeds images inline as Base64 (the default).
* `ExportImagesToFileSystemStrategy` -- writes images to a folder on disk.
* `SkipImagesStrategy` -- omits images entirely.
* `CustomImagesStrategy` -- delegates to a callback you supply.

Implement this interface directly when none of the built-in strategies meet your needs.

##### Examples

Custom strategy that uploads images to cloud storage:

```csharp
public class CloudImageExportStrategy : IImageExportStrategy
{
    public string ImagesFolder => "cloud-images";

    public Stream GetImageStream(ImageExportContext context)
    {
        // Rename the image file if needed
        context.ImageFileName = "doc-" + context.ImageFileName;

        // Return a stream that the library will write image bytes to
        return new MemoryStream(); // replace with your cloud upload stream
    }
}
```

### GetImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iimageexportstrategy/getimagestream.md

#### IImageExportStrategy.GetImageStream method

Returns a writable stream for the image described by *context*. The library writes the image bytes to this stream during conversion.

```csharp
public Stream GetImageStream(ImageExportContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | ImageExportContext | The image export context containing the default image file name and other metadata. You may modify `ImageFileName` before returning the stream to change the file name that appears in the Markdown output. |

##### Return Value

A writable Stream where the image data will be written, or `null` to use the default behavior.

### ImagesFolder
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iimageexportstrategy/imagesfolder.md

#### IImageExportStrategy.ImagesFolder property

Gets the folder path where exported images will be stored.

```csharp
public string ImagesFolder { get; }
```

##### Property Value

A relative or absolute folder path. This value is used to construct image URIs in the Markdown output.

### IImageSavingHandler
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iimagesavinghandler.md

#### IImageSavingHandler interface

Callback interface invoked for each image encountered during conversion when using `CustomImagesStrategy`. Implement this interface to rename images, redirect output to a custom stream, or apply other custom logic.

```csharp
public interface IImageSavingHandler
```

#### Methods

| Name | Description |
| --- | --- |
| Handle(CustomImageSavingArgs) | Called once for each image found in the source document during conversion. |

##### Examples

Rename images with a sequential prefix:

```csharp
public class RenameHandler : IImageSavingHandler
{
    private int _index;

    public void Handle(CustomImageSavingArgs args)
    {
        args.SetOutputImageFileName($"img_{_index}_{args.ImageFileName}");
        _index++;
    }
}
```

### Handle
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iimagesavinghandler/handle.md

#### IImageSavingHandler.Handle method

Called once for each image found in the source document during conversion.

```csharp
public void Handle(CustomImageSavingArgs args)
```

| Parameter | Type | Description |
| --- | --- | --- |
| args | CustomImageSavingArgs | Provides the default image file name and allows you to override the file name via `SetOutputImageFileName` or redirect the output via `SetOutputStream`. |

### ImageExportContext
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/imageexportcontext.md

#### ImageExportContext class

Contains read-only information about a single image encountered during conversion. Passed to `GetImageStream`.

```csharp
public class ImageExportContext
```

#### Properties

| Name | Description |
| --- | --- |
| ImageFileName { get; } | Gets the image file name (without directory path). The default value is generated by the library in the format `img-001.png`. |

### ImageFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/imageexportcontext/imagefilename.md

#### ImageExportContext.ImageFileName property

Gets the image file name (without directory path). The default value is generated by the library in the format `img-001.png`.

```csharp
public string ImageFileName { get; }
```

### InvalidFormatException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/invalidformatexception.md

#### InvalidFormatException class

The exception that is thrown when a file has an invalid format.

```csharp
public sealed class InvalidFormatException : GroupDocsMarkdownException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidFormatException() | Initializes a new instance of the `InvalidFormatException` class. |
| InvalidFormatException(string) | Initializes a new instance of the `InvalidFormatException` class. |
| InvalidFormatException(string, Exception) | Initializes a new instance of the `InvalidFormatException` class. |

### InvalidFormatException
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/invalidformatexception/invalidformatexception.md

#### InvalidFormatException()

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException()
```

#### InvalidFormatException(string)

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### InvalidFormatException(string, Exception)

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException(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. |

### IUriExportStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iuriexportstrategy.md

#### IUriExportStrategy interface

Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion.

```csharp
public interface IUriExportStrategy
```

#### Methods

| Name | Description |
| --- | --- |
| UpdateResourceUri(UriExportContext) | Called for each resource URI that will be written to the Markdown output. Modify properties on *context* to customize the resulting URI. |

##### Remarks

Implement this interface to rewrite or transform the URIs that reference images or other external resources in the generated Markdown. For example, you can prepend a CDN base URL or change relative paths to absolute URLs.

##### Examples

Prepend a CDN base URL to every resource URI:

```csharp
public class CdnUriExportStrategy : IUriExportStrategy
{
    public void UpdateResourceUri(UriExportContext context)
    {
        context.ResourceFileUri = "https://cdn.example.com/assets/" + context.ResourceFileName;
    }
}
```

### UpdateResourceUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iuriexportstrategy/updateresourceuri.md

#### IUriExportStrategy.UpdateResourceUri method

Called for each resource URI that will be written to the Markdown output. Modify properties on *context* to customize the resulting URI.

```csharp
public void UpdateResourceUri(UriExportContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | UriExportContext | The URI export context. Set `ResourceFileUri` to override the URI that appears in the Markdown output, or modify `ResourceFileName` to change the resource file name. |

### IUriSavingHandler
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iurisavinghandler.md

#### IUriSavingHandler interface

Callback interface invoked for each resource URI during conversion when using `CustomUriExportStrategy`. Implement this interface to rewrite resource URIs in the Markdown output.

```csharp
public interface IUriSavingHandler
```

#### Methods

| Name | Description |
| --- | --- |
| Handle(UriSavingArgs) | Called once for each resource URI that will be written to the Markdown output. |

##### Examples

Prepend a CDN base URL to every resource:

```csharp
public class CdnUriHandler : IUriSavingHandler
{
    public void Handle(UriSavingArgs args)
    {
        args.SetResourceFileUri("https://cdn.example.com/" + args.ResourceFileName);
    }
}
```

### Handle
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/iurisavinghandler/handle.md

#### IUriSavingHandler.Handle method

Called once for each resource URI that will be written to the Markdown output.

```csharp
public void Handle(UriSavingArgs args)
```

| Parameter | Type | Description |
| --- | --- | --- |
| args | UriSavingArgs | Provides the default resource file name and URI, and allows you to override the URI via `SetResourceFileUri`. |

### License
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/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. |
| static Set(Stream) | Sets the license from a stream. |
| static Set(string) | Sets the license from a file path. |

### License
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### Set
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/license/set.md

#### Set(string)

Sets the license from a file path.

```csharp
public static void Set(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The path to the license file. |

##### Examples

///

```csharp
// initialize License class
// set path to .lic file
License.Set(@"C:\\GroupDocs.Markdown.lic");    
```

#### Set(Stream)

Sets the license from a stream.

```csharp
public static void Set(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The stream that contains the license. |

##### Examples

```csharp
using (FileStream stream = new FileStream("C:\\GroupDocs.Markdown.lic", FileMode.Open))
{
    License.Set(stream);
}
```

### SetLicense
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/license/setlicense.md

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The license stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *licenseStream* is null. |

##### Examples

The following example demonstrates how to set a license passing Stream of the license file.

```csharp
using (FileStream licenseStream = File.OpenRead("GroupDocs.Markdown.lic"))
{
    License license = new License();
    license.SetLicense(licenseStream);
}
```

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The license file path. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *licensePath* is null or empty string. |

##### Examples

The following example demonstrates how to set a license passing a path to the license file.

```csharp
string licensePath = "GroupDocs.Markdown.lic";
License license = new License();
license.SetLicense(licensePath);
```

### LoadOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/loadoptions.md

#### LoadOptions class

Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the `LoadOptions` class with automatic format detection. |
| LoadOptions(FileFormat) | Initializes a new instance of the `LoadOptions` class with an explicit file format. |

#### Properties

| Name | Description |
| --- | --- |
| FileFormat { get; } | Gets the file format of the document to load. |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

##### Remarks

By default, the library detects the file format automatically from the file extension or content. Use this class when you need to override automatic detection (for example, when loading from a stream without a file name) or when the document is password-protected.

##### Examples

Specifying the file format explicitly (useful when loading from a stream):

```csharp
var loadOptions = new LoadOptions(FileFormat.Docx);

using (var stream = File.OpenRead("document"))
using (var converter = new MarkdownConverter(stream, loadOptions))
{
    ConvertResult result = converter.Convert();
    Console.WriteLine(result.Content);
}
```

Loading a password-protected document:

```csharp
var loadOptions = new LoadOptions(FileFormat.Docx)
{
    Password = "secret"
};
string markdown = MarkdownConverter.ToMarkdown("protected.docx", loadOptions);
```

### FileFormat
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/loadoptions/fileformat.md

#### LoadOptions.FileFormat property

Gets the file format of the document to load.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

The file format specified via the constructor, or Unknown (the default) which means the format will be detected automatically.

### LoadOptions
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of the `LoadOptions` class with automatic format detection.

```csharp
public LoadOptions()
```

#### LoadOptions(FileFormat)

Initializes a new instance of the `LoadOptions` class with an explicit file format.

```csharp
public LoadOptions(FileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The file format of the document to load. This bypasses automatic format detection, which is especially useful when loading documents from streams that lack a file extension. |

### Password
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/loadoptions/password.md

#### LoadOptions.Password property

Gets or sets the password for opening an encrypted document.

```csharp
public string Password { get; set; }
```

##### Property Value

Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string.

### MarkdownConverter
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter.md

#### MarkdownConverter class

Converts documents from Word, Excel, PDF, and other formats to Markdown. Provides both static one-liner methods and an instance-based API with full control over conversion options.

```csharp
public class MarkdownConverter : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| MarkdownConverter(Stream) | Creates a new converter that reads the document from the supplied stream. The file format is detected automatically from the stream content. If automatic detection is not possible, use the `MarkdownConverter` overload and specify the format via `LoadOptions`. |
| MarkdownConverter(string) | Creates a new converter for the document at the specified file path. The file format is detected automatically from the file extension and content. |
| MarkdownConverter(Stream, LoadOptions) | Creates a new converter that reads the document from the supplied stream, using the given load options. Use this overload when reading from a MemoryStream, network stream, or any non-file stream where format detection from a file name is not available. |
| MarkdownConverter(string, LoadOptions) | Creates a new converter for the document at the specified file path, using the given load options. Use this overload to supply a password for encrypted documents or to explicitly specify the file format. |

#### Methods

| Name | Description |
| --- | --- |
| Convert() | Converts the loaded document to Markdown using default options and returns the result with the Markdown content in `Content`. |
| Convert(ConvertOptions) | Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in `Content`. |
| Convert(Stream) | Converts the loaded document to Markdown and writes the output to the specified stream. The `Content` property will be `null`; the Markdown bytes are written directly to *outputStream*. |
| Convert(string) | Converts the loaded document to Markdown and saves the result to a file. The file is created (or overwritten) at *outputFilePath*. |
| Convert(Stream, ConvertOptions) | Converts the loaded document to Markdown with the specified options, writing the output to a stream. |
| Convert(string, ConvertOptions) | Converts the loaded document to Markdown with the specified options and saves the result to a file. The file is created (or overwritten) at *outputFilePath*. |
| ConvertAsync(CancellationToken) | Asynchronously converts the loaded document to Markdown and returns the result as a string. |
| ConvertAsync(ConvertOptions, CancellationToken) | Asynchronously converts the loaded document to Markdown with the specified options. |
| ConvertAsync(string, ConvertOptions, CancellationToken) | Asynchronously converts the loaded document and saves the result to a file. The source file read and output file write are performed asynchronously. |
| Dispose() | Releases all resources used by this `MarkdownConverter` instance, including the internal copy of the source document stream. Always call `Dispose` when you are finished, or use a `using` statement to ensure timely cleanup. |
| GetDocumentInfo() | Retrieves metadata about the loaded document without performing a full conversion. Use this to inspect properties such as page count, title, author, and whether the document is encrypted before deciding how to convert. |
| GetDocumentInfoAsync(CancellationToken) | Asynchronously retrieves metadata about the loaded document. |
| static FromMarkdown(string, string) | Converts a Markdown file to a document format. The output format is inferred from the file extension of *outputPath* (e.g. `.docx`, `.pdf`). |
| static FromMarkdown(string, string, ExportOptions) | Converts a Markdown file to a document format with the specified export options. |
| static FromMarkdownString(string, Stream, ExportOptions) | Converts a Markdown string to a document and writes it to a stream. |
| static FromMarkdownString(string, string, ExportOptions) | Converts a Markdown string to a document and saves it to a file. |
| static GetInfo(string) | Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion. This is a lightweight way to inspect a file. |
| static GetInfo(string, LoadOptions) | Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document. |
| static GetInfoAsync(string, LoadOptions, CancellationToken) | Asynchronously retrieves metadata about the document at the specified path. |
| static GetSupportedFormats() | Returns the complete list of `FileFormat` values that can be converted to Markdown. Use this to check at runtime whether a particular format is supported before attempting conversion. |
| static ToFile(string, string) | Converts a document to Markdown and saves the result directly to a file. This is the simplest way to produce a Markdown file from a supported document format. |
| static ToFile(string, string, ConvertOptions) | Converts a document to Markdown with the specified conversion options and saves the result to a file. |
| static ToFile(string, string, LoadOptions, ConvertOptions) | Converts a document to Markdown with the specified load and conversion options, saving the result to a file. This is the most flexible static overload for file-based output. |
| static ToFileAsync(string, string, ConvertOptions, CancellationToken) | Asynchronously converts the document and saves the result to a file. Both source reading and output writing are performed asynchronously. |
| static ToMarkdown(string) | Converts a document to Markdown in a single call and returns the Markdown string. This is the simplest way to convert a file. The format is detected automatically. |
| static ToMarkdown(string, ConvertOptions) | Converts a document to Markdown using the specified conversion options and returns the Markdown string. Use this overload to control image handling, heading offsets, or page selection. |
| static ToMarkdown(string, LoadOptions) | Converts a document to Markdown using the specified load options and returns the Markdown string. Use this overload to supply a password for encrypted documents or to specify the file format explicitly. |
| static ToMarkdown(string, LoadOptions, ConvertOptions) | Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string. This is the most flexible static overload, combining format/password control with full conversion customization. |
| static ToMarkdownAsync(string, CancellationToken) | Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously. |
| static ToMarkdownAsync(string, LoadOptions, ConvertOptions, CancellationToken) | Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously; conversion runs on the thread pool. |

##### Remarks

Supported input formats include Word (DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT), Excel (XLS, XLSX, XLSB, XLSM, CSV, TSV, ODS, OTS), PDF, e-books (EPUB, MOBI), plain text (TXT), and CHM help files. Call `GetSupportedFormats` for the full list.

For quick, one-shot conversions use the static methods `ToMarkdown`, `ToFile`, and `GetInfo`. When you need to customize the conversion (image handling, heading offsets, page selection) or retrieve document metadata alongside conversion, create an instance and call `Convert` or `GetDocumentInfo`.

The instance implements IDisposable. Always dispose it when you are done, preferably with a `using` statement.

##### Examples

Convert a document to a Markdown string in one line:

```csharp
string md = MarkdownConverter.ToMarkdown("document.docx");
```

Convert a document and save the result directly to a file:

```csharp
MarkdownConverter.ToFile("document.docx", "output.md");
```

Use the instance API with options for full control:

```csharp
using var converter = new MarkdownConverter("document.docx");
var result = converter.Convert(new ConvertOptions { HeadingLevelOffset = 1 });
if (result.IsSuccess)
    Console.WriteLine(result.Content);
```

### Convert
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/convert.md

#### Convert()

Converts the loaded document to Markdown using default options and returns the result with the Markdown content in `Content`.

```csharp
public ConvertResult Convert()
```

##### Return Value

A `ConvertResult` whose `IsSuccess` indicates whether the conversion succeeded. On success, `Content` contains the Markdown string.

##### Examples

```csharp
using var converter = new MarkdownConverter("report.pdf");
ConvertResult result = converter.Convert();
if (result.IsSuccess)
    File.WriteAllText("report.md", result.Content);
```

#### Convert(Stream)

Converts the loaded document to Markdown and writes the output to the specified stream. The `Content` property will be `null`; the Markdown bytes are written directly to *outputStream*.

```csharp
public ConvertResult Convert(Stream outputStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | Stream | A writable stream that will receive the UTF-8 encoded Markdown output. |

##### Return Value

A `ConvertResult` indicating success or failure. On success, `Content` is `null` because the output was written to the stream.

#### Convert(string)

Converts the loaded document to Markdown and saves the result to a file. The file is created (or overwritten) at *outputFilePath*.

```csharp
public ConvertResult Convert(string outputFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | String | The path where the Markdown file will be written. |

##### Return Value

A `ConvertResult` indicating success or failure. On success, `Content` is `null` because the output was written to the file.

#### Convert(ConvertOptions)

Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in `Content`.

```csharp
public ConvertResult Convert(ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | Options that control the conversion, such as `HeadingLevelOffset`, `ImageExportStrategy`, and `PageNumbers`. Pass `null` to use defaults. |

##### Return Value

A `ConvertResult` whose `Content` contains the Markdown string on success.

##### Examples

```csharp
using var converter = new MarkdownConverter("document.docx");
var options = new ConvertOptions
{
    HeadingLevelOffset = 1,
    PageNumbers = new[] { 1, 2, 3 }
};
ConvertResult result = converter.Convert(options);
```

#### Convert(Stream, ConvertOptions)

Converts the loaded document to Markdown with the specified options, writing the output to a stream.

```csharp
public ConvertResult Convert(Stream outputStream, ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | Stream | A writable stream that will receive the UTF-8 encoded Markdown output. |
| convertOptions | ConvertOptions | Options that control the conversion. Pass `null` to use defaults. |

##### Return Value

A `ConvertResult` indicating success or failure. `Content` is `null` because the output was written to the stream.

#### Convert(string, ConvertOptions)

Converts the loaded document to Markdown with the specified options and saves the result to a file. The file is created (or overwritten) at *outputFilePath*.

```csharp
public ConvertResult Convert(string outputFilePath, ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | String | The path where the Markdown file will be written. |
| convertOptions | ConvertOptions | Options that control the conversion. Pass `null` to use defaults. |

##### Return Value

A `ConvertResult` indicating success or failure. `Content` is `null` because the output was written to the file.

##### Examples

```csharp
using var converter = new MarkdownConverter("spreadsheet.xlsx");
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesToFileSystemStrategy("images")
};
converter.Convert("output.md", options);
```

### ConvertAsync
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/convertasync.md

#### ConvertAsync(CancellationToken)

Asynchronously converts the loaded document to Markdown and returns the result as a string.

```csharp
public Task<ConvertResult> ConvertAsync(CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cancellationToken | CancellationToken | A token to cancel the operation. |

#### ConvertAsync(ConvertOptions, CancellationToken)

Asynchronously converts the loaded document to Markdown with the specified options.

```csharp
public Task<ConvertResult> ConvertAsync(ConvertOptions convertOptions, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| convertOptions | ConvertOptions | Options that control the conversion. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

#### ConvertAsync(string, ConvertOptions, CancellationToken)

Asynchronously converts the loaded document and saves the result to a file. The source file read and output file write are performed asynchronously.

```csharp
public Task<ConvertResult> ConvertAsync(string outputFilePath, 
    ConvertOptions convertOptions = null, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | String | The path where the Markdown file will be written. |
| convertOptions | ConvertOptions | Options that control the conversion. Pass `null` for defaults. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

### Dispose
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/dispose.md

#### MarkdownConverter.Dispose method

Releases all resources used by this `MarkdownConverter` instance, including the internal copy of the source document stream. Always call `Dispose` when you are finished, or use a `using` statement to ensure timely cleanup.

```csharp
public void Dispose()
```

### FromMarkdown
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/frommarkdown.md

#### FromMarkdown(string, string)

Converts a Markdown file to a document format. The output format is inferred from the file extension of *outputPath* (e.g. `.docx`, `.pdf`).

```csharp
public static void FromMarkdown(string markdownPath, string outputPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| markdownPath | String | Path to the source Markdown file. |
| outputPath | String | Path where the output document will be saved. The extension determines the format. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |
| NotSupportedException | Thrown when the output format is not supported. |

##### Examples

```csharp
MarkdownConverter.FromMarkdown("readme.md", "readme.docx");
MarkdownConverter.FromMarkdown("readme.md", "readme.pdf");
```

#### FromMarkdown(string, string, ExportOptions)

Converts a Markdown file to a document format with the specified export options.

```csharp
public static void FromMarkdown(string markdownPath, string outputPath, ExportOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| markdownPath | String | Path to the source Markdown file. |
| outputPath | String | Path where the output document will be saved. |
| options | ExportOptions | Export options. Use `Format` to override format detection, or pass `null` to infer from the output file extension. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |
| NotSupportedException | Thrown when the output format is not supported. |

##### Examples

```csharp
var options = new ExportOptions(FileFormat.Pdf);
MarkdownConverter.FromMarkdown("readme.md", "output.pdf", options);
```

### FromMarkdownString
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/frommarkdownstring.md

#### FromMarkdownString(string, string, ExportOptions)

Converts a Markdown string to a document and saves it to a file.

```csharp
public static void FromMarkdownString(string markdownContent, string outputPath, 
    ExportOptions options = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| markdownContent | String | The Markdown content as a string. |
| outputPath | String | Path where the output document will be saved. |
| options | ExportOptions | Export options, or `null` to infer format from the file extension. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |
| NotSupportedException | Thrown when the output format is not supported. |

##### Examples

```csharp
string markdown = "# Hello\n\nThis is a test.";
MarkdownConverter.FromMarkdownString(markdown, "output.docx");
```

#### FromMarkdownString(string, Stream, ExportOptions)

Converts a Markdown string to a document and writes it to a stream.

```csharp
public static void FromMarkdownString(string markdownContent, Stream outputStream, 
    ExportOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| markdownContent | String | The Markdown content as a string. |
| outputStream | Stream | A writable stream that will receive the document bytes. |
| options | ExportOptions | Export options. `Format` must be set since there is no file extension to infer from. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |
| ArgumentNullException | Thrown when *options* is null or `Format` is Unknown. |

##### Examples

```csharp
string markdown = "# Report\n\nGenerated content.";
using var stream = new MemoryStream();
MarkdownConverter.FromMarkdownString(markdown, stream, new ExportOptions(FileFormat.Docx));
```

### GetDocumentInfo
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/getdocumentinfo.md

#### MarkdownConverter.GetDocumentInfo method

Retrieves metadata about the loaded document without performing a full conversion. Use this to inspect properties such as page count, title, author, and whether the document is encrypted before deciding how to convert.

```csharp
public DocumentInfo GetDocumentInfo()
```

##### Return Value

A `DocumentInfo` containing the detected `FileFormat`, `PageCount`, `Title`, `Author`, and `IsEncrypted` flag.

##### Examples

```csharp
using var converter = new MarkdownConverter("report.docx");
DocumentInfo info = converter.GetDocumentInfo();
Console.WriteLine($"Format: {info.FileFormat}, Pages: {info.PageCount}");
```

### GetDocumentInfoAsync
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/getdocumentinfoasync.md

#### MarkdownConverter.GetDocumentInfoAsync method

Asynchronously retrieves metadata about the loaded document.

```csharp
public Task<DocumentInfo> GetDocumentInfoAsync(CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cancellationToken | CancellationToken | A token to cancel the operation. |

### GetInfo
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/getinfo.md

#### GetInfo(string)

Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion. This is a lightweight way to inspect a file.

```csharp
public static DocumentInfo GetInfo(string sourcePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |

##### Return Value

A `DocumentInfo` with the detected format, page count, and other metadata.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
DocumentInfo info = MarkdownConverter.GetInfo("report.docx");
Console.WriteLine($"Format: {info.FileFormat}, Pages: {info.PageCount}, Encrypted: {info.IsEncrypted}");
```

#### GetInfo(string, LoadOptions)

Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document.

```csharp
public static DocumentInfo GetInfo(string sourcePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| loadOptions | LoadOptions | Options for loading the document (password, format hint). May be `null`. |

##### Return Value

A `DocumentInfo` with the detected format, page count, and other metadata.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| NotSupportedException | Thrown when the file format is not supported. |

### GetInfoAsync
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/getinfoasync.md

#### MarkdownConverter.GetInfoAsync method

Asynchronously retrieves metadata about the document at the specified path.

```csharp
public static Task<DocumentInfo> GetInfoAsync(string sourcePath, LoadOptions loadOptions = null, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| loadOptions | LoadOptions | Options for loading the document. May be `null`. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

### GetSupportedFormats
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/getsupportedformats.md

#### MarkdownConverter.GetSupportedFormats method

Returns the complete list of `FileFormat` values that can be converted to Markdown. Use this to check at runtime whether a particular format is supported before attempting conversion.

```csharp
public static IReadOnlyList<FileFormat> GetSupportedFormats()
```

##### Return Value

A read-only list of all supported `FileFormat` values.

##### Examples

```csharp
IReadOnlyList<FileFormat> formats = MarkdownConverter.GetSupportedFormats();
foreach (FileFormat fmt in formats)
    Console.WriteLine(fmt);
```

### MarkdownConverter
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/markdownconverter.md

#### MarkdownConverter(string)

Creates a new converter for the document at the specified file path. The file format is detected automatically from the file extension and content.

```csharp
public MarkdownConverter(string sourcePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | Absolute or relative path to the source document (e.g. `"report.docx"`). |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| FileNotFoundException | Thrown when the file at *sourcePath* does not exist. |
| NotSupportedException | Thrown when the file format is not supported. Call `GetSupportedFormats` to see which formats are accepted. |

#### MarkdownConverter(Stream)

Creates a new converter that reads the document from the supplied stream. The file format is detected automatically from the stream content. If automatic detection is not possible, use the `MarkdownConverter` overload and specify the format via `LoadOptions`.

```csharp
public MarkdownConverter(Stream sourceStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourceStream* is `null`. |
| NotSupportedException | Thrown when the file format cannot be detected or is not supported. |

#### MarkdownConverter(string, LoadOptions)

Creates a new converter for the document at the specified file path, using the given load options. Use this overload to supply a password for encrypted documents or to explicitly specify the file format.

```csharp
public MarkdownConverter(string sourcePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | Absolute or relative path to the source document. |
| loadOptions | LoadOptions | Options that control how the document is loaded. Pass a `LoadOptions` with `Password` set to open encrypted files, or with a specific `FileFormat` to override automatic format detection. May be `null`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| FileNotFoundException | Thrown when the file at *sourcePath* does not exist. |
| NotSupportedException | Thrown when the file format is not supported. |

#### MarkdownConverter(Stream, LoadOptions)

Creates a new converter that reads the document from the supplied stream, using the given load options. Use this overload when reading from a MemoryStream, network stream, or any non-file stream where format detection from a file name is not available.

```csharp
public MarkdownConverter(Stream sourceStream, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | Stream | A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction. |
| loadOptions | LoadOptions | Options that control how the document is loaded. Specify `Password` for encrypted files or a `FileFormat` to override automatic detection. May be `null`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *sourceStream* is `null`. |
| NotSupportedException | Thrown when the file format cannot be detected or is not supported. |

### ToFile
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/tofile.md

#### ToFile(string, string)

Converts a document to Markdown and saves the result directly to a file. This is the simplest way to produce a Markdown file from a supported document format.

```csharp
public static void ToFile(string sourcePath, string outputPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document (e.g. `"report.pdf"`). |
| outputPath | String | The path where the Markdown file will be created or overwritten. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
MarkdownConverter.ToFile("document.docx", "output.md");
```

#### ToFile(string, string, ConvertOptions)

Converts a document to Markdown with the specified conversion options and saves the result to a file.

```csharp
public static void ToFile(string sourcePath, string outputPath, ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| outputPath | String | The path where the Markdown file will be created or overwritten. |
| convertOptions | ConvertOptions | Options that customize the conversion (image strategy, heading offset, page numbers). May be `null`. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesToFileSystemStrategy("images")
};
MarkdownConverter.ToFile("report.docx", "report.md", options);
```

#### ToFile(string, string, LoadOptions, ConvertOptions)

Converts a document to Markdown with the specified load and conversion options, saving the result to a file. This is the most flexible static overload for file-based output.

```csharp
public static void ToFile(string sourcePath, string outputPath, LoadOptions loadOptions, 
    ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| outputPath | String | The path where the Markdown file will be created or overwritten. |
| loadOptions | LoadOptions | Options for loading the document (password, format hint). May be `null`. |
| convertOptions | ConvertOptions | Options that customize the conversion. May be `null`. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| NotSupportedException | Thrown when the file format is not supported. |

### ToFileAsync
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/tofileasync.md

#### MarkdownConverter.ToFileAsync method

Asynchronously converts the document and saves the result to a file. Both source reading and output writing are performed asynchronously.

```csharp
public static Task ToFileAsync(string sourcePath, string outputPath, 
    ConvertOptions convertOptions = null, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| outputPath | String | The path where the Markdown file will be saved. |
| convertOptions | ConvertOptions | Options for the conversion. May be `null`. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |

### ToMarkdown
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/tomarkdown.md

#### ToMarkdown(string)

Converts a document to Markdown in a single call and returns the Markdown string. This is the simplest way to convert a file. The format is detected automatically.

```csharp
public static string ToMarkdown(string sourcePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document (e.g. `"report.docx"`). |

##### Return Value

The converted Markdown content as a UTF-8 string.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| ArgumentNullException | Thrown when *sourcePath* is `null` or empty. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
string markdown = MarkdownConverter.ToMarkdown("document.docx");
Console.WriteLine(markdown);
```

#### ToMarkdown(string, LoadOptions)

Converts a document to Markdown using the specified load options and returns the Markdown string. Use this overload to supply a password for encrypted documents or to specify the file format explicitly.

```csharp
public static string ToMarkdown(string sourcePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| loadOptions | LoadOptions | Options for loading the document (password, format hint). May be `null`. |

##### Return Value

The converted Markdown content as a UTF-8 string.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
var loadOptions = new LoadOptions(FileFormat.Docx) { Password = "secret" };
string markdown = MarkdownConverter.ToMarkdown("encrypted.docx", loadOptions);
```

#### ToMarkdown(string, ConvertOptions)

Converts a document to Markdown using the specified conversion options and returns the Markdown string. Use this overload to control image handling, heading offsets, or page selection.

```csharp
public static string ToMarkdown(string sourcePath, ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| convertOptions | ConvertOptions | Options that customize the conversion (image strategy, heading offset, page numbers). May be `null`. |

##### Return Value

The converted Markdown content as a UTF-8 string.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| NotSupportedException | Thrown when the file format is not supported. |

##### Examples

```csharp
var options = new ConvertOptions { HeadingLevelOffset = 2 };
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
```

#### ToMarkdown(string, LoadOptions, ConvertOptions)

Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string. This is the most flexible static overload, combining format/password control with full conversion customization.

```csharp
public static string ToMarkdown(string sourcePath, LoadOptions loadOptions, 
    ConvertOptions convertOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| loadOptions | LoadOptions | Options for loading the document (password, format hint). May be `null`. |
| convertOptions | ConvertOptions | Options that customize the conversion. May be `null`. |

##### Return Value

The converted Markdown content as a UTF-8 string.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when the conversion fails. |
| NotSupportedException | Thrown when the file format is not supported. |

### ToMarkdownAsync
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownconverter/tomarkdownasync.md

#### ToMarkdownAsync(string, CancellationToken)

Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously.

```csharp
public static Task<string> ToMarkdownAsync(string sourcePath, 
    CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

##### Return Value

The converted Markdown content.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |

#### ToMarkdownAsync(string, LoadOptions, ConvertOptions, CancellationToken)

Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously; conversion runs on the thread pool.

```csharp
public static Task<string> ToMarkdownAsync(string sourcePath, LoadOptions loadOptions, 
    ConvertOptions convertOptions = null, CancellationToken cancellationToken = default)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | String | The path to the source document. |
| loadOptions | LoadOptions | Options for loading the document. May be `null`. |
| convertOptions | ConvertOptions | Options for the conversion. May be `null`. |
| cancellationToken | CancellationToken | A token to cancel the operation. |

##### Return Value

The converted Markdown content.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMarkdownException | Thrown when conversion fails. |

### MarkdownFlavor
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/markdownflavor.md

#### MarkdownFlavor enumeration

Specifies the target Markdown dialect for the conversion output.

```csharp
public enum MarkdownFlavor
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| GitHub | `0` | GitHub Flavored Markdown — supports tables, strikethrough, and task lists. This is the default. |
| CommonMark | `1` | Strict CommonMark output. Tables are rendered as code blocks since CommonMark does not have native table syntax. |

### Metered
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/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. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/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/markdown/net/groupdocs.markdown/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/markdown/net/groupdocs.markdown/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/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);
```

### SkipImagesStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/skipimagesstrategy.md

#### SkipImagesStrategy class

Implements an image export strategy that skips saving images during document conversion.

```csharp
public class SkipImagesStrategy : IImageExportStrategy
```

#### Constructors

| Name | Description |
| --- | --- |
| SkipImagesStrategy() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| ImagesFolder { get; } | Gets an empty string as this strategy does not use an images folder. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream(ImageExportContext) | Returns null to indicate that the image should be skipped. |

##### Remarks

This strategy is useful when you want to convert a document to Markdown without saving the actual image files. When this strategy is used, the output Markdown will still contain image references (e.g., !), but the actual image files will not be saved to disk.

##### Examples

The following example shows how to use SkipImagesStrategy when converting a document:

```csharp
var options = new ConvertOptions
{
    ImageExportStrategy = new SkipImagesStrategy()
};
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
// Image references remain in the markdown but no files are written
```

### GetImageStream
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/skipimagesstrategy/getimagestream.md

#### SkipImagesStrategy.GetImageStream method

Returns null to indicate that the image should be skipped.

```csharp
public Stream GetImageStream(ImageExportContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | ImageExportContext | The image export context (not used in this implementation). |

##### Return Value

Always returns null to skip the image.

### ImagesFolder
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/skipimagesstrategy/imagesfolder.md

#### SkipImagesStrategy.ImagesFolder property

Gets an empty string as this strategy does not use an images folder.

```csharp
public string ImagesFolder { get; }
```

##### Property Value

An empty string since no images are exported.

### SkipImagesStrategy
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/skipimagesstrategy/skipimagesstrategy.md

#### SkipImagesStrategy constructor

The default constructor.

```csharp
public SkipImagesStrategy()
```

### UriExportContext
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext.md

#### UriExportContext class

Contains information about a resource URI being written during conversion. Passed to `UpdateResourceUri`.

```csharp
public class UriExportContext
```

#### Properties

| Name | Description |
| --- | --- |
| ResourceFileName { get; } | Gets the default resource file name generated by the library. |
| ResourceFileNameOutput { get; } | Gets the overridden file name, or `null` if no override was set. |
| ResourceFileUri { get; } | Gets the default URI that the library would write into the Markdown output. |
| ResourceFileUriOutput { get; } | Gets the overridden URI, or `null` if no override was set. |

#### Methods

| Name | Description |
| --- | --- |
| SetResourceFileName(string) | Overrides the resource file name in the Markdown output. |
| SetResourceFileUri(string) | Overrides the URI that will appear in the Markdown output. |

##### Remarks

Read the default values from `ResourceFileName` and `ResourceFileUri`, then call `SetResourceFileName` or `SetResourceFileUri` to override them.

### ResourceFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/resourcefilename.md

#### UriExportContext.ResourceFileName property

Gets the default resource file name generated by the library.

```csharp
public string ResourceFileName { get; }
```

### ResourceFileNameOutput
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/resourcefilenameoutput.md

#### UriExportContext.ResourceFileNameOutput property

Gets the overridden file name, or `null` if no override was set.

```csharp
public string ResourceFileNameOutput { get; }
```

### ResourceFileUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/resourcefileuri.md

#### UriExportContext.ResourceFileUri property

Gets the default URI that the library would write into the Markdown output.

```csharp
public string ResourceFileUri { get; }
```

### ResourceFileUriOutput
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/resourcefileurioutput.md

#### UriExportContext.ResourceFileUriOutput property

Gets the overridden URI, or `null` if no override was set.

```csharp
public string ResourceFileUriOutput { get; }
```

### SetResourceFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/setresourcefilename.md

#### UriExportContext.SetResourceFileName method

Overrides the resource file name in the Markdown output.

```csharp
public void SetResourceFileName(string resourceFileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| resourceFileName | String | The new file name. |

### SetResourceFileUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/uriexportcontext/setresourcefileuri.md

#### UriExportContext.SetResourceFileUri method

Overrides the URI that will appear in the Markdown output.

```csharp
public void SetResourceFileUri(string resourceFileUri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| resourceFileUri | String | The new URI (for example, a CDN URL). |

### UriSavingArgs
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs.md

#### UriSavingArgs class

Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. An instance of this class is created for each resource and can be used to override the default URI or file name.

```csharp
public class UriSavingArgs
```

#### Properties

| Name | Description |
| --- | --- |
| ResourceFileName { get; } | Gets the default file name (without path) generated by the library for this resource. |
| ResourceFileNameOutput { get; } | Gets the overridden file name set by the caller, or `null` if no override was specified. |
| ResourceFileUri { get; } | Gets the default resource URI that the library would write into the Markdown output. |
| ResourceFileUriOutput { get; } | Gets the overridden URI set by `SetResourceFileUri`, or `null` if no override was specified. |

#### Methods

| Name | Description |
| --- | --- |
| SetResourceFileUri(string) | Overrides the URI that will be written to the Markdown output for this resource. |

##### Remarks

Call `SetResourceFileUri` to change the URI that appears in the Markdown output. If no override is set, the library uses the default `ResourceFileUri`.

##### Examples

Rewriting a resource URI in a callback:

```csharp
// Inside a custom URI export callback
args.SetResourceFileUri("https://cdn.example.com/assets/" + args.ResourceFileName);
```

### ResourceFileName
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs/resourcefilename.md

#### UriSavingArgs.ResourceFileName property

Gets the default file name (without path) generated by the library for this resource.

```csharp
public string ResourceFileName { get; }
```

### ResourceFileNameOutput
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs/resourcefilenameoutput.md

#### UriSavingArgs.ResourceFileNameOutput property

Gets the overridden file name set by the caller, or `null` if no override was specified.

```csharp
public string ResourceFileNameOutput { get; }
```

### ResourceFileUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs/resourcefileuri.md

#### UriSavingArgs.ResourceFileUri property

Gets the default resource URI that the library would write into the Markdown output.

```csharp
public string ResourceFileUri { get; }
```

### ResourceFileUriOutput
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs/resourcefileurioutput.md

#### UriSavingArgs.ResourceFileUriOutput property

Gets the overridden URI set by `SetResourceFileUri`, or `null` if no override was specified.

```csharp
public string ResourceFileUriOutput { get; }
```

### SetResourceFileUri
Path: https://reference.groupdocs.com/markdown/net/groupdocs.markdown/urisavingargs/setresourcefileuri.md

#### UriSavingArgs.SetResourceFileUri method

Overrides the URI that will be written to the Markdown output for this resource.

```csharp
public void SetResourceFileUri(string resourceFileUri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| resourceFileUri | String | The new URI to use (for example, a CDN URL or an absolute path). |

## Python

### GroupDocs.Markdown for Python via .NET
Path: https://reference.groupdocs.com/markdown/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.markdown` | Main GroupDocs.Markdown namespace with top-level API classes. |

### groupdocs.markdown
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown.md

Main GroupDocs.Markdown namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `ConvertOptions` | Provides options for customizing the document conversion process to Markdown format. |
| `ConvertResult` | Contains the output of a successful document-to-Markdown conversion. |
| `CustomImageSavingArgs` | Provides information and controls for saving a single image during document-to-Markdown conversion. |
| `CustomImagesStrategy` | Implements an image export strategy that gives you full control over how images are saved during conversion. |
| `CustomUriExportStrategy` | Implements a URI export strategy that lets you customize how resource URIs are written to Markdown. |
| `DefaultUriExportStrategy` | Provides default URI handling that keeps the URIs generated by the library unchanged. |
| `DocumentInfo` | Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status. |
| `ExportImagesAsBase64Strategy` | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
| `ExportImagesToFileSystemStrategy` | Saves images to a folder on disk during conversion. |
| `ExportOptions` | Options for exporting Markdown to a document format (reverse conversion). |
| `IImageExportStrategy` | Defines a strategy for handling image export during document-to-Markdown conversion. |
| `IImageSavingHandler` | Callback interface invoked for each image encountered during conversion when using `CustomImagesStrategy`. |
| `IUriExportStrategy` | Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion. |
| `IUriSavingHandler` | Callback interface invoked for each resource URI during conversion when using `CustomUriExportStrategy`; implement it to rewrite resource URIs in the Markdown output. |
| `ImageExportContext` | Contains read-only information about a single image encountered during conversion, and is passed to `IImageExportStrategy.get_image_stream(ImageExportContext)`. |
| `License` | Manages GroupDocs.Markdown licensing. |
| `LoadOptions` | Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files. |
| `MarkdownConverter` | Converts documents from Word, Excel, PDF, and other formats to Markdown, offering static one-liner methods and an instance-based API with full control over conversion options. |
| `Metered` | Manages metered (pay-per-use) licensing. |
| `SkipImagesStrategy` | Implements an image export strategy that skips saving images during document conversion. |
| `UriExportContext` | Contains information about a resource URI being written during conversion and is passed to `IUriExportStrategy.update_resource_uri`. |
| `UriSavingArgs` | Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FileFormat` | Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document). |
| `MarkdownFlavor` | Specifies the target Markdown dialect for the conversion output. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `DocumentProtectedException` | The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via `LoadOptions.password`. |
| `GroupDocsMarkdownException` | Represents a product-specific exception that is thrown during file processing. |
| `InvalidFormatException` | The exception that is thrown when a file has an invalid format. |

### ConvertOptions class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions.md

#### ConvertOptions class

Provides options for customizing the document conversion process to Markdown format.

This class allows you to configure how documents are converted to Markdown, including how images are exported, how resource URIs are written, which pages to convert, and how heading levels are adjusted.

By default, images are embedded as Base64 strings in the Markdown output.

The ConvertOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ConvertOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| flavor | The target Markdown dialect. Default is `MarkdownFlavor.git_hub`. |
| heading_level_offset | The offset to apply to all heading levels in the Markdown output. Default is 0 (no change). |
| image_export_strategy | The strategy for handling images during conversion. Default is `ExportImagesAsBase64Strategy`. |
| include_front_matter | The option indicating whether to prepend YAML front matter to the Markdown output. Default is False. |
| include_hidden_sheets | The property indicates whether hidden worksheets are included in spreadsheet conversions. |
| max_columns | The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
| max_rows | The maximum number of data rows to include per worksheet when converting spreadsheets; rows beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
| page_numbers | The page numbers to convert, as a list of 1‑based page or worksheet numbers. |
| sheet_separator | The separator inserted between worksheets in spreadsheet conversions. |
| uri_export_strategy | The strategy for customizing resource URIs written to Markdown output. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/__init__.md

#### __init__

Initializes a new instance of the `ConvertOptions` class.

By default, `ConvertOptions.image_export_strategy` is set to `ExportImagesAsBase64Strategy`, which embeds images as Base64 strings directly in the Markdown output.

```python
def __init__(self):
    ...
```

### flavor property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/flavor.md

#### flavor property

The target Markdown dialect. Default is `MarkdownFlavor.git_hub`.

##### Definition:
```python
@property
def flavor(self):
    ...
@flavor.setter
def flavor(self, value):
    ...
```

### heading_level_offset property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/heading_level_offset.md

#### heading_level_offset property

The offset to apply to all heading levels in the Markdown output. Default is 0 (no change).

This is useful when you are embedding the converted Markdown inside a larger document where top-level headings are already in use. For example, setting this to 1 ensures the converted content starts at `##` instead of `#`.

##### Definition:
```python
@property
def heading_level_offset(self):
    ...
@heading_level_offset.setter
def heading_level_offset(self, value):
    ...
```

### image_export_strategy property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/image_export_strategy.md

#### image_export_strategy property

The strategy for handling images during conversion. Default is `ExportImagesAsBase64Strategy`.

Built-in strategies:
- `ExportImagesAsBase64Strategy` - Embeds images as Base64 strings (default)
- `ExportImagesToFileSystemStrategy` - Saves images to a specified folder
- `SkipImagesStrategy` - Skips image saving
- `CustomImagesStrategy` - Custom image saving handler

Or implement `IImageExportStrategy` for a fully custom strategy.

##### Definition:
```python
@property
def image_export_strategy(self):
    ...
@image_export_strategy.setter
def image_export_strategy(self, value):
    ...
```

### include_front_matter property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/include_front_matter.md

#### include_front_matter property

The option indicating whether to prepend YAML front matter to the Markdown output. Default is False.

Front matter is commonly used by static site generators such as Jekyll, Hugo, and Docusaurus. Only non-empty metadata fields are included.

##### Definition:
```python
@property
def include_front_matter(self):
    ...
@include_front_matter.setter
def include_front_matter(self, value):
    ...
```

### include_hidden_sheets property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/include_hidden_sheets.md

#### include_hidden_sheets property

The property indicates whether hidden worksheets are included in spreadsheet conversions.

Default is False.

##### Definition:
```python
@property
def include_hidden_sheets(self):
    ...
@include_hidden_sheets.setter
def include_hidden_sheets(self, value):
    ...
```

### max_columns property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/max_columns.md

#### max_columns property

The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default).

##### Definition:
```python
@property
def max_columns(self):
    ...
@max_columns.setter
def max_columns(self, value):
    ...
```

### max_rows property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/max_rows.md

#### max_rows property

The maximum number of data rows to include per worksheet when converting spreadsheets; rows beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default).

##### Definition:
```python
@property
def max_rows(self):
    ...
@max_rows.setter
def max_rows(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/page_numbers.md

#### page_numbers property

The page numbers to convert, as a list of 1‑based page or worksheet numbers.

If set to None, all pages are converted. The default is None.

##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### sheet_separator property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/sheet_separator.md

#### sheet_separator property

The separator inserted between worksheets in spreadsheet conversions.

Default is a horizontal rule (`
`).

##### Definition:
```python
@property
def sheet_separator(self):
    ...
@sheet_separator.setter
def sheet_separator(self, value):
    ...
```

### uri_export_strategy property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertoptions/uri_export_strategy.md

#### uri_export_strategy property

The strategy for customizing resource URIs written to Markdown output.

The URI export strategy, or None to keep the default URIs. Default is None.

##### Definition:
```python
@property
def uri_export_strategy(self):
    ...
@uri_export_strategy.setter
def uri_export_strategy(self, value):
    ...
```

### ConvertResult class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult.md

#### ConvertResult class

Contains the output of a successful document-to-Markdown conversion.

All `Convert` methods throw on failure, so a returned `ConvertResult` always represents a successful conversion. Use `ConvertResult.content` to read the Markdown string (when converting to string) and `ConvertResult.warnings` to check for non-fatal issues.

The ConvertResult type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| failure | Creates a failed result with error information. |
| success | Creates a successful result without content. Used when the output was written to a stream or file. |
| success | Creates a successful result containing the converted Markdown content. |

##### Properties
| Property | Description |
| :- | :- |
| content | The converted Markdown content as a string. |
| error_message | The error message if the conversion failed, or None if it succeeded. |
| exception | The exception that caused the conversion to fail, or None if the conversion succeeded. |
| is_success | The conversion succeeded flag indicating whether the conversion completed successfully. |
| warnings | The non-fatal warnings that occurred during conversion. |

### content property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/content.md

#### content property

The converted Markdown content as a string.

The Markdown content when conversion is performed without an output stream or file path. Returns None if the conversion failed, or if the output was written to a stream or file.

##### Definition:
```python
@property
def content(self):
    ...
```

### error_message property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/error_message.md

#### error_message property

The error message if the conversion failed, or None if it succeeded.

##### Definition:
```python
@property
def error_message(self):
    ...
```

### exception property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/exception.md

#### exception property

The exception that caused the conversion to fail, or None if the conversion succeeded.

##### Definition:
```python
@property
def exception(self):
    ...
```

### failure method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/failure.md

#### failure

Creates a failed result with error information.

```python
def failure(cls, error_message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| error_message | `str` | A human-readable description of the error. |
| exception | `Exception` | The exception that caused the failure. |

**Returns:** ConvertResult: A ConvertResult with `IsSuccess` set to `False`.

### is_success property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/is_success.md

#### is_success property

The conversion succeeded flag indicating whether the conversion completed successfully.

True if the conversion succeeded; otherwise, False.

##### Definition:
```python
@property
def is_success(self):
    ...
```

### success method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/success.md

#### success

Creates a successful result without content. Used when the output was written to a stream or file.

```python
def success(cls):
    ...
```

**Returns:** ConvertResult: A result with `IsSuccess` set to `True` and `Content` set to `None`.

#### success

Creates a successful result containing the converted Markdown content.

```python
def success(cls, content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| content | `str` | The Markdown content produced by the conversion. |

**Returns:** ConvertResult: A result with `IsSuccess` set to True and the specified content.

### warnings property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/convertresult/warnings.md

#### warnings property

The non-fatal warnings that occurred during conversion.

A read‑only list of warning messages. The list is empty when no warnings were generated. Warnings describe issues that did not prevent conversion but may affect the output (for example, unsupported formatting or missing resources).

##### Definition:
```python
@property
def warnings(self):
    ...
```

### CustomImageSavingArgs class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs.md

#### CustomImageSavingArgs class

Provides information and controls for saving a single image during document-to-Markdown conversion.

An instance of this class is passed to the callback registered with `CustomImagesStrategy` for each image found in the source document.

Use `CustomImageSavingArgs.set_output_image_file_name` to change the file name the image is saved under, or `CustomImageSavingArgs.set_output_stream` to redirect the image data to a custom stream. If neither method is called, the library uses the defaults provided by `CustomImageSavingArgs.image_file_name` and `CustomImageSavingArgs.output_directory`.

The CustomImageSavingArgs type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_output_image_file_name | Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated `CustomImageSavingArgs.image_file_name`. |
| set_output_stream | Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion. |
| set_replacement_image | Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g., PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image. |

##### Properties
| Property | Description |
| :- | :- |
| image_file_name | The default file name (without path) suggested by the library for this image. |
| image_file_name_output | The overridden file name set by `CustomImageSavingArgs.set_output_image_file_name`, or `None` if no override was specified. |
| output_directory | The output directory where images are being saved. |
| output_stream | The custom output stream set by `CustomImageSavingArgs.set_output_stream`, or `None` if no custom stream was specified. |
| replacement_image_stream | The replacement image stream set by `CustomImageSavingArgs.set_replacement_image`, or `None` if no replacement was specified. |
| shape_type | The type of the shape that contains the image in the source document (e.g., "Picture" or "Shape"). |

### image_file_name property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/image_file_name.md

#### image_file_name property

The default file name (without path) suggested by the library for this image.

##### Definition:
```python
@property
def image_file_name(self):
    ...
```

### image_file_name_output property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/image_file_name_output.md

#### image_file_name_output property

The overridden file name set by `CustomImageSavingArgs.set_output_image_file_name`, or `None` if no override was specified.

##### Definition:
```python
@property
def image_file_name_output(self):
    ...
```

### output_directory property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/output_directory.md

#### output_directory property

The output directory where images are being saved.

##### Definition:
```python
@property
def output_directory(self):
    ...
```

### output_stream property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/output_stream.md

#### output_stream property

The custom output stream set by `CustomImageSavingArgs.set_output_stream`, or `None` if no custom stream was specified.

##### Definition:
```python
@property
def output_stream(self):
    ...
```

### replacement_image_stream property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/replacement_image_stream.md

#### replacement_image_stream property

The replacement image stream set by `CustomImageSavingArgs.set_replacement_image`, or `None` if no replacement was specified.

##### Definition:
```python
@property
def replacement_image_stream(self):
    ...
```

### set_output_image_file_name method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/set_output_image_file_name.md

#### set_output_image_file_name

Overrides the default file name for this image. The image will be saved under the specified name instead of the library-generated `CustomImageSavingArgs.image_file_name`.

```python
def set_output_image_file_name(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` | The new file name (without path) to use for the image. |

### set_output_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/set_output_stream.md

#### set_output_stream

Redirects the image data to a custom writable stream instead of the default file output. The library will write the image bytes to this stream during conversion.

```python
def set_output_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | A writable stream where the image data will be written. |

| Raises | Description |
| :- | :- |
| `ValueError` | When `stream` is None. |

### set_replacement_image method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/set_replacement_image.md

#### set_replacement_image

Provides a replacement image to use instead of the original image from the source document. The stream must contain the complete replacement image data (e.g., PNG or JPEG bytes). When set, the library writes this data to the output instead of the original image.

```python
def set_replacement_image(self, image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | `io.RawIOBase` | A readable stream containing the replacement image data. |

| Raises | Description |
| :- | :- |
| `ValueError` | Raised when `image_stream` is None. |

### shape_type property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesavingargs/shape_type.md

#### shape_type property

The type of the shape that contains the image in the source document (e.g., "Picture" or "Shape").

##### Definition:
```python
@property
def shape_type(self):
    ...
```

### CustomImagesStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesstrategy.md

#### CustomImagesStrategy class

Implements an image export strategy that gives you full control over how images are saved during conversion.

Supply an `IImageSavingHandler` implementation to rename images, redirect them to a custom stream, or apply any other custom logic when each image is encountered.

The CustomImagesStrategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the CustomImagesStrategy class. |

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Gets a stream for writing the exported image to the file system. |

##### Properties
| Property | Description |
| :- | :- |
| images_folder | The physical folder where images will be saved on disk. |
| images_relative_path | The path used in the Markdown image references; when None or empty, the full `CustomImagesStrategy.images_folder` path is used, and it can be set to a relative path (e.g., "images") for portable Markdown output. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesstrategy/__init__.md

#### __init__

Initializes a new instance of the CustomImagesStrategy class.

```python
def __init__(self, images_folder, handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| images_folder | `str` | The folder where images will be exported. |
| handler | `IImageSavingHandler` | The handler that is called for each image during conversion. |

| Raises | Description |
| :- | :- |
| `ValueError` | Thrown when `images_folder` is None. |

### get_image_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesstrategy/get_image_stream.md

#### get_image_stream

Gets a stream for writing the exported image to the file system.

```python
def get_image_stream(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `ImageExportContext` | The image export context containing information about the image being processed. |

**Returns:** io.RawIOBase: A stream for writing the image data to the file system.

### images_folder property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesstrategy/images_folder.md

#### images_folder property

The physical folder where images will be saved on disk.

##### Definition:
```python
@property
def images_folder(self):
    ...
```

### images_relative_path property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customimagesstrategy/images_relative_path.md

#### images_relative_path property

The path used in the Markdown image references; when None or empty, the full `CustomImagesStrategy.images_folder` path is used, and it can be set to a relative path (e.g., "images") for portable Markdown output.

##### Definition:
```python
@property
def images_relative_path(self):
    ...
@images_relative_path.setter
def images_relative_path(self, value):
    ...
```

### CustomUriExportStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customuriexportstrategy.md

#### CustomUriExportStrategy class

Implements a URI export strategy that lets you customize how resource URIs are written to Markdown.

Supply a `IUriSavingHandler` implementation to rewrite resource URIs (for example, to prepend a CDN base URL).

The CustomUriExportStrategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `CustomUriExportStrategy` class. |

##### Methods
| Method | Description |
| :- | :- |
| update_resource_uri | Inherits documentation from the base `CustomUriExportStrategy.update_resource_uri` method. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customuriexportstrategy/__init__.md

#### __init__

Initializes a new instance of the `CustomUriExportStrategy` class.

```python
def __init__(self, handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| handler | `IUriSavingHandler` | The handler that is called for each resource URI during conversion. |

### update_resource_uri method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/customuriexportstrategy/update_resource_uri.md

#### update_resource_uri

Inherits documentation from the base `CustomUriExportStrategy.update_resource_uri` method.

```python
def update_resource_uri(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `UriExportContext` |  |

### DefaultUriExportStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/defaulturiexportstrategy.md

#### DefaultUriExportStrategy class

Provides default URI handling that keeps the URIs generated by the library unchanged.

The DefaultUriExportStrategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| update_resource_uri | Inherits documentation from the base implementation. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/defaulturiexportstrategy/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### update_resource_uri method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/defaulturiexportstrategy/update_resource_uri.md

#### update_resource_uri

Inherits documentation from the base implementation.

```python
def update_resource_uri(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `UriExportContext` |  |

### DocumentInfo class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo.md

#### DocumentInfo class

Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status.

Use `MarkdownConverter.get_document_info` or `MarkdownConverter.get_info` to obtain an instance of this class. The information is extracted from the source document without performing a full conversion, so it is a lightweight way to inspect a file before converting it.

The DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| author | The document author extracted from its metadata, or an empty string if no author is available. |
| file_format | The detected file format of the document. |
| is_encrypted | The document is password-protected. Returns True if the document requires a password to open; otherwise, False. |
| page_count | The number of pages in the document, or the number of worksheets for spreadsheets, as a non‑negative integer. |
| title | The document title extracted from its metadata, or an empty string if no title is available. |

### author property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo/author.md

#### author property

The document author extracted from its metadata, or an empty string if no author is available.

##### Definition:
```python
@property
def author(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo/file_format.md

#### file_format property

The detected file format of the document.

A `FileFormat` value indicating the document type (e.g., `FileFormat.docx`, `FileFormat.pdf`).

##### Definition:
```python
@property
def file_format(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo/is_encrypted.md

#### is_encrypted property

The document is password-protected. Returns True if the document requires a password to open; otherwise, False.

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo/page_count.md

#### page_count property

The number of pages in the document, or the number of worksheets for spreadsheets, as a non‑negative integer.

##### Definition:
```python
@property
def page_count(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentinfo/title.md

#### title property

The document title extracted from its metadata, or an empty string if no title is available.

##### Definition:
```python
@property
def title(self):
    ...
```

### DocumentProtectedException class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/documentprotectedexception.md

#### DocumentProtectedException class

The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via `LoadOptions.password`.

The DocumentProtectedException type exposes the following members:

### ExportImagesAsBase64Strategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy.md

#### ExportImagesAsBase64Strategy class

Implements an image export strategy that embeds images as Base64 strings directly in the Markdown.

This strategy converts all images to Base64 format and embeds them directly in the Markdown document using the data URI scheme. This eliminates the need for separate image files, making the Markdown document self-contained. However, this approach increases the size of the Markdown file and may not be supported by all Markdown viewers.

The ExportImagesAsBase64Strategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Returns None to indicate that the image should be embedded as Base64. |

##### Properties
| Property | Description |
| :- | :- |
| images_folder | The images folder path is always an empty string because this strategy embeds images directly in the Markdown. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### get_image_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/get_image_stream.md

#### get_image_stream

Returns None to indicate that the image should be embedded as Base64.

```python
def get_image_stream(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `ImageExportContext` | The image export context (not used in this implementation). |

**Returns:** None: Always returns None to indicate Base64 embedding.

### images_folder property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/images_folder.md

#### images_folder property

The images folder path is always an empty string because this strategy embeds images directly in the Markdown.

##### Definition:
```python
@property
def images_folder(self):
    ...
```

### ExportImagesToFileSystemStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy.md

#### ExportImagesToFileSystemStrategy class

Saves images to a folder on disk during conversion.

By default, the Markdown output references images using the full `ExportImagesToFileSystemStrategy.images_folder` path. Set `ExportImagesToFileSystemStrategy.images_relative_path` to control the path that appears in the Markdown image links — typically a path relative to the output `.md` file.

The ExportImagesToFileSystemStrategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ExportImagesToFileSystemStrategy` class. |

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Returns a stream for writing the exported image to the file system. |

##### Properties
| Property | Description |
| :- | :- |
| images_folder | The physical folder where images will be saved on disk. |
| images_relative_path | The path used in the Markdown image references. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/__init__.md

#### __init__

Initializes a new instance of the `ExportImagesToFileSystemStrategy` class.

```python
def __init__(self, images_folder):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| images_folder | `str` | The physical folder where images will be saved. |

| Raises | Description |
| :- | :- |
| `ValueError` | When `images_folder` is None. |

### get_image_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/get_image_stream.md

#### get_image_stream

Returns a stream for writing the exported image to the file system.

```python
def get_image_stream(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `ImageExportContext` |  |

### images_folder property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/images_folder.md

#### images_folder property

The physical folder where images will be saved on disk.

##### Definition:
```python
@property
def images_folder(self):
    ...
```

### images_relative_path property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/images_relative_path.md

#### images_relative_path property

The path used in the Markdown image references.

When `None` or empty, the full `ExportImagesToFileSystemStrategy.images_folder` path is used (which may be absolute). Set this to a relative path (e.g. `"images"`) so the Markdown output contains portable references.

Default is `None` (uses `ExportImagesToFileSystemStrategy.images_folder` as‑is).

##### Definition:
```python
@property
def images_relative_path(self):
    ...
@images_relative_path.setter
def images_relative_path(self, value):
    ...
```

### ExportOptions class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportoptions.md

#### ExportOptions class

Options for exporting Markdown to a document format (reverse conversion).

Use this class with `MarkdownConverter.from_markdown` to control how the Markdown content is converted to a document format such as DOCX or PDF.

The ExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ExportOptions class. |
| __init__ | Initializes a new instance of the `ExportOptions` class with the specified target format. |

##### Properties
| Property | Description |
| :- | :- |
| format | The target document format. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportoptions/__init__.md

#### __init__

Initializes a new instance of the ExportOptions class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `ExportOptions` class with the specified target format.

```python
def __init__(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | `FileFormat` | The target document format. |

### format property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/exportoptions/format.md

#### format property

The target document format.

If not set, the format is inferred from the output file extension. Default is `FileFormat.unknown` (infer from file extension).

##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### FileFormat class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat.md

#### FileFormat class

Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document).

Pass a value from this enum to the `LoadOptions` constructor to explicitly specify the source document format, or use `FileFormat.unknown` to let the library detect it automatically. Use `MarkdownConverter.get_supported_formats` to retrieve all formats supported for conversion.

The FileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| Unknown | The file format is not specified. |
| Doc | Microsoft Word 97-2003 Document (.doc). |
| Docx | Microsoft Word Document (.docx). |
| Docm | Microsoft Word Macro-Enabled Document (.docm). |
| Dot | Microsoft Word 97-2003 Template (.dot). |
| Dotx | Microsoft Word Template (.dotx). |
| Dotm | Microsoft Word Macro-Enabled Template (.dotm). |
| Rtf | Rich Text Format (.rtf). |
| Odt | OpenDocument Text (.odt). |
| Ott | OpenDocument Text Template (.ott). |
| Xlsx | Microsoft Excel Spreadsheet (.xlsx). |
| Xls | Microsoft Excel 97-2003 Spreadsheet (.xls). |
| Xlsb | Microsoft Excel Binary Spreadsheet (.xlsb). |
| Xlsm | Microsoft Excel Macro-Enabled Spreadsheet (.xlsm). |
| Csv | Comma-Separated Values (.csv). |
| Tsv | Tab-Separated Values (.tsv). |
| Ods | OpenDocument Spreadsheet (.ods). |
| Ots | OpenDocument Spreadsheet Template (.ots). |
| Pdf | Portable Document Format (.pdf). |
| Epub | Electronic Publication (.epub). |
| Mobi | Mobipocket E-Book (.mobi). |
| Txt | Plain Text (.txt). |
| Md | Markdown (.md). Used as input format for reverse conversion (Markdown to document). |
| Chm | Compiled HTML Help (.chm). |

### Chm field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/chm.md

#### Chm field

Compiled HTML Help (.chm).

##### Value
`23`

### Csv field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/csv.md

#### Csv field

Comma-Separated Values (.csv).

##### Value
`14`

### Doc field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/doc.md

#### Doc field

Microsoft Word 97-2003 Document (.doc).

##### Value
`1`

### Docm field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/docm.md

#### Docm field

Microsoft Word Macro-Enabled Document (.docm).

##### Value
`3`

### Docx field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/docx.md

#### Docx field

Microsoft Word Document (.docx).

##### Value
`2`

### Dot field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/dot.md

#### Dot field

Microsoft Word 97-2003 Template (.dot).

##### Value
`4`

### Dotm field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/dotm.md

#### Dotm field

Microsoft Word Macro-Enabled Template (.dotm).

##### Value
`6`

### Dotx field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/dotx.md

#### Dotx field

Microsoft Word Template (.dotx).

##### Value
`5`

### Epub field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/epub.md

#### Epub field

Electronic Publication (.epub).

##### Value
`19`

### Md field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/md.md

#### Md field

Markdown (.md). Used as input format for reverse conversion (Markdown to document).

##### Value
`22`

### Mobi field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/mobi.md

#### Mobi field

Mobipocket E-Book (.mobi).

##### Value
`20`

### Ods field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/ods.md

#### Ods field

OpenDocument Spreadsheet (.ods).

##### Value
`16`

### Odt field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/odt.md

#### Odt field

OpenDocument Text (.odt).

##### Value
`8`

### Ots field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/ots.md

#### Ots field

OpenDocument Spreadsheet Template (.ots).

##### Value
`17`

### Ott field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/ott.md

#### Ott field

OpenDocument Text Template (.ott).

##### Value
`9`

### Pdf field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/pdf.md

#### Pdf field

Portable Document Format (.pdf).

##### Value
`18`

### Rtf field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/rtf.md

#### Rtf field

Rich Text Format (.rtf).

##### Value
`7`

### Tsv field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/tsv.md

#### Tsv field

Tab-Separated Values (.tsv).

##### Value
`15`

### Txt field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/txt.md

#### Txt field

Plain Text (.txt).

##### Value
`21`

### Unknown field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/unknown.md

#### Unknown field

The file format is not specified.

The library will attempt to detect the format automatically.

##### Value
`0`

### Xls field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/xls.md

#### Xls field

Microsoft Excel 97-2003 Spreadsheet (.xls).

##### Value
`11`

### Xlsb field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/xlsb.md

#### Xlsb field

Microsoft Excel Binary Spreadsheet (.xlsb).

##### Value
`12`

### Xlsm field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/xlsm.md

#### Xlsm field

Microsoft Excel Macro-Enabled Spreadsheet (.xlsm).

##### Value
`13`

### Xlsx field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/fileformat/xlsx.md

#### Xlsx field

Microsoft Excel Spreadsheet (.xlsx).

##### Value
`10`

### GroupDocsMarkdownException class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/groupdocsmarkdownexception.md

#### GroupDocsMarkdownException class

Represents a product-specific exception that is thrown during file processing.

The GroupDocsMarkdownException type exposes the following members:

### IImageExportStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iimageexportstrategy.md

#### IImageExportStrategy class

Defines a strategy for handling image export during document-to-Markdown conversion.

The library ships with several built-in strategies:
- `ExportImagesAsBase64Strategy` -- embeds images inline as Base64 (the default).
- `ExportImagesToFileSystemStrategy` -- writes images to a folder on disk.
- `SkipImagesStrategy` -- omits images entirely.
- `CustomImagesStrategy` -- delegates to a callback you supply.

Implement this interface directly when none of the built-in strategies meet your needs.

The IImageExportStrategy type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Returns a writable stream for the image described by `context`. |

##### Properties
| Property | Description |
| :- | :- |
| images_folder | The folder path where exported images will be stored. |

### get_image_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iimageexportstrategy/get_image_stream.md

#### get_image_stream

Returns a writable stream for the image described by `context`.

The library writes the image bytes to this stream during conversion.

```python
def get_image_stream(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `ImageExportContext` | The image export context containing the default image file name and other metadata. You may modify `ImageExportContext.image_file_name` before returning the stream to change the file name that appears in the Markdown output. |

**Returns:** io.RawIOBase: A writable stream where the image data will be written, or `None` to use the default behavior.

### images_folder property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iimageexportstrategy/images_folder.md

#### images_folder property

The folder path where exported images will be stored.

A relative or absolute folder path. This value is used to construct image URIs in the Markdown output.

##### Definition:
```python
@property
def images_folder(self):
    ...
```

### IImageSavingHandler class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iimagesavinghandler.md

#### IImageSavingHandler class

Callback interface invoked for each image encountered during conversion when using `CustomImagesStrategy`.

Implement this interface to rename images, redirect output to a custom stream, or apply other custom logic.

The IImageSavingHandler type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| handle | Called once for each image found in the source document during conversion. |

### handle method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iimagesavinghandler/handle.md

#### handle

Called once for each image found in the source document during conversion.

```python
def handle(self, args):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| args | `CustomImageSavingArgs` | Provides the default image file name and allows you to override the file name via `CustomImageSavingArgs.set_output_image_file_name` or redirect the output via `CustomImageSavingArgs.set_output_stream`. |

### ImageExportContext class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/imageexportcontext.md

#### ImageExportContext class

Contains read-only information about a single image encountered during conversion, and is passed to `IImageExportStrategy.get_image_stream(ImageExportContext)`.

The ImageExportContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| image_file_name | The image file name (without directory path). |

### image_file_name property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/imageexportcontext/image_file_name.md

#### image_file_name property

The image file name (without directory path).

The default value is generated by the library in the format `img-001.png`.

##### Definition:
```python
@property
def image_file_name(self):
    ...
```

### InvalidFormatException class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/invalidformatexception.md

#### InvalidFormatException class

The exception that is thrown when a file has an invalid format.

The InvalidFormatException type exposes the following members:

### IUriExportStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iuriexportstrategy.md

#### IUriExportStrategy class

Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion.

Implement this interface to rewrite or transform the URIs that reference images or other external resources in the generated Markdown. For example, you can prepend a CDN base URL or change relative paths to absolute URLs.

The IUriExportStrategy type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| update_resource_uri | Called for each resource URI that will be written to the Markdown output, allowing modification of properties on `context` to customize the resulting URI. |

### update_resource_uri method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iuriexportstrategy/update_resource_uri.md

#### update_resource_uri

Called for each resource URI that will be written to the Markdown output, allowing modification of properties on `context` to customize the resulting URI.

```python
def update_resource_uri(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `UriExportContext` | The URI export context. Set `UriExportContext.resource_file_uri` to override the URI that appears in the Markdown output, or modify `UriExportContext.resource_file_name` to change the resource file name. |

### IUriSavingHandler class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iurisavinghandler.md

#### IUriSavingHandler class

Callback interface invoked for each resource URI during conversion when using `CustomUriExportStrategy`; implement it to rewrite resource URIs in the Markdown output.

The IUriSavingHandler type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| handle | Called once for each resource URI that will be written to the Markdown output. |

### handle method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/iurisavinghandler/handle.md

#### handle

Called once for each resource URI that will be written to the Markdown output.

```python
def handle(self, args):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| args | `UriSavingArgs` | Provides the default resource file name and URI, and allows you to override the URI via `UriSavingArgs.set_resource_file_uri`. |

### License class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/license.md

#### License class

Manages GroupDocs.Markdown 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_ | Apply a license without instantiating ``License``. |
| set_license | Apply a license to the current process. |

### set_ method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/license/set_.md

#### set_

Apply a license without instantiating ``License``.

Convenience wrapper around ``License().set_license(...)`` that
mirrors the static ``License.Set`` method on the .NET side.

```python
def set_(license_source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_source |  | A file path (``str``) or a readable file-like object containing license data. |

### set_license method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/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. |

### LoadOptions class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/loadoptions.md

#### LoadOptions class

Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files.

By default, the library detects the file format automatically from the file extension or content. Use this class when you need to override automatic detection (for example, when loading from a stream without a file name) or when the document is password‑protected.

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `LoadOptions` class with automatic format detection. |
| __init__ | Initializes a new instance of the `LoadOptions` class with an explicit file format. |

##### Properties
| Property | Description |
| :- | :- |
| file_format | The file format of the document to load. |
| password | The password used to open an encrypted document. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/loadoptions/__init__.md

#### __init__

Initializes a new instance of the `LoadOptions` class with automatic format detection.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `LoadOptions` class with an explicit file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | `FileFormat` | The file format of the document to load. This bypasses automatic format detection, which is especially useful when loading documents from streams that lack a file extension. |

### file_format property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/loadoptions/file_format.md

#### file_format property

The file format of the document to load.

The file format specified via the constructor, or `FileFormat.unknown` (the default) which means the format will be detected automatically.

##### Definition:
```python
@property
def file_format(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/loadoptions/password.md

#### password property

The password used to open an encrypted document.

Can be `None` or an empty string. The default value is `None`. If the document is not encrypted, set this to `None` or the empty string.

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### MarkdownConverter class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter.md

#### MarkdownConverter class

Converts documents from Word, Excel, PDF, and other formats to Markdown, offering static one-liner methods and an instance-based API with full control over conversion options.

Supported input formats include Word (DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT), Excel (XLS, XLSX, XLSB, XLSM, CSV, TSV, ODS, OTS), PDF, e‑books (EPUB, MOBI), plain text (TXT), and CHM help files. Call `MarkdownConverter.get_supported_formats` for the full list.

For quick, one‑shot conversions use the static methods `MarkdownConverter.to_markdown`, `MarkdownConverter.to_file`, and `MarkdownConverter.get_info`. When you need to customize the conversion (image handling, heading offsets, page selection) or retrieve document metadata alongside conversion, create an instance and call `MarkdownConverter.convert` or `MarkdownConverter.get_document_info`.

The instance implements `System.IDisposable`. Always dispose it when you are done, preferably with a `using` statement.

The MarkdownConverter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new converter for the document at the specified file path. |
| __init__ | Initializes a new converter that reads the document from the supplied stream. The file format is detected automatically from the stream content. If automatic detection is not possible, use the `MarkdownConverter.__init__(io.RawIOBase, LoadOptions)` overload and specify the format via `LoadOptions`. |
| __init__ | Initializes a new converter for the document at the specified file path, using the given load options. |
| __init__ | Initializes a new converter that reads the document from the supplied stream, using the given load options. |

##### Methods
| Method | Description |
| :- | :- |
| convert | Converts the loaded document to Markdown using default options and returns the result with the Markdown content in `ConvertResult.content`. |
| convert | Converts the loaded document to Markdown and writes the output to the specified stream. |
| convert | Converts the loaded document to Markdown and saves the result to a file at the specified output_file_path. |
| convert | Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in `ConvertResult.content`. |
| convert | Converts the loaded document to Markdown with the specified options, writing the output to a stream. |
| convert | Converts the loaded document to Markdown with the specified options and saves the result to a file. |
| convert_async | Asynchronously converts the loaded document to Markdown and returns the result as a string. |
| convert_async | Asynchronously converts the loaded document to Markdown with the specified options. |
| convert_async | Asynchronously converts the loaded document and saves the result to a file. |
| from_markdown | Converts a Markdown file to a document format, inferring the output format from the file extension of `output_path` (e.g., `.docx`, `.pdf`). |
| from_markdown | Converts a Markdown file to a document format with the specified export options. |
| from_markdown_string | Converts a Markdown string to a document and saves it to a file. |
| from_markdown_string | Converts a Markdown string to a document and writes it to a stream. |
| get_document_info | Retrieves metadata about the loaded document without performing a full conversion. |
| get_document_info_async | Asynchronously retrieves metadata about the loaded document. |
| get_info | Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion. |
| get_info | Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document. |
| get_info_async | Asynchronously retrieves metadata about the document at the specified path. |
| get_supported_formats | Returns the complete list of FileFormat values that can be converted to Markdown. |
| to_file | Converts a document to Markdown and saves the result directly to a file. |
| to_file | Converts a document to Markdown with the specified conversion options and saves the result to a file. |
| to_file | Converts a document to Markdown with the specified load and conversion options, saving the result to a file. |
| to_file_async | Asynchronously converts the document and saves the result to a file. |
| to_markdown | Converts a document to Markdown in a single call and returns the Markdown string. |
| to_markdown | Converts a document to Markdown using the specified load options and returns the Markdown string. |
| to_markdown | Converts a document to Markdown using the specified conversion options and returns the Markdown string. |
| to_markdown | Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string. |
| to_markdown_async | Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously. |
| to_markdown_async | Asynchronously converts the document at the specified path to Markdown. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/__init__.md

#### __init__

Initializes a new converter for the document at the specified file path.

The file format is detected automatically from the file extension and content.

```python
def __init__(self, source_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | Absolute or relative path to the source document (e.g. `"report.docx"`). |

| Raises | Description |
| :- | :- |
| `ValueError` | When `source_path` is None or empty. |
| `FileNotFoundError` | When the file at `source_path` does not exist. |
| `NotImplementedError` | When the file format is not supported. Call `MarkdownConverter.get_supported_formats` to see which formats are accepted. |

#### __init__

Initializes a new converter that reads the document from the supplied stream. The file format is detected automatically from the stream content. If automatic detection is not possible, use the `MarkdownConverter.__init__(io.RawIOBase, LoadOptions)` overload and specify the format via `LoadOptions`.

```python
def __init__(self, source_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream | `io.RawIOBase` | A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction. |

| Raises | Description |
| :- | :- |
| `ValueError` | When `source_stream` is None. |
| `NotImplementedError` | When the file format cannot be detected or is not supported. |

#### __init__

Initializes a new converter for the document at the specified file path, using the given load options.

```python
def __init__(self, source_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | Absolute or relative path to the source document. |
| load_options | `LoadOptions` | Options that control how the document is loaded. Pass a `LoadOptions` with `LoadOptions.password` set to open encrypted files, or with a specific `FileFormat` to override automatic format detection. May be None. |

| Raises | Description |
| :- | :- |
| `ValueError` | When `source_path` is None or empty. |
| `FileNotFoundError` | When the file at `source_path` does not exist. |
| `NotImplementedError` | When the file format is not supported. |

#### __init__

Initializes a new converter that reads the document from the supplied stream, using the given load options.

Use this overload when reading from a `io.BytesIO`, network stream, or any non‑file stream where format detection from a file name is not available.

```python
def __init__(self, source_stream, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_stream | `io.RawIOBase` | A readable stream containing the document data. The stream is copied internally, so the caller may close it after construction. |
| load_options | `LoadOptions` | Options that control how the document is loaded. Specify `LoadOptions.password` for encrypted files or a `FileFormat` to override automatic detection. May be `None`. |

| Raises | Description |
| :- | :- |
| `ValueError` | If `source_stream` is `None`. |
| `NotImplementedError` | If the file format cannot be detected or is not supported. |

### convert method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/convert.md

#### convert

Converts the loaded document to Markdown using default options and returns the result with the Markdown content in `ConvertResult.content`.

```python
def convert(self):
    ...
```

**Returns:** A `ConvertResult` whose `ConvertResult.is_success` indicates whether the conversion succeeded. On success, `ConvertResult.content` contains the Markdown string.

#### convert

Converts the loaded document to Markdown and writes the output to the specified stream.

The `ConvertResult.content` property will be None; the Markdown bytes are written directly to `output_stream`.

```python
def convert(self, output_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_stream | `io.RawIOBase` | A writable stream that will receive the UTF-8 encoded Markdown output. |

**Returns:** ConvertResult: A `ConvertResult` indicating success or failure. On success, `ConvertResult.content` is None because the output was written to the stream.

#### convert

Converts the loaded document to Markdown and saves the result to a file at the specified output_file_path.

```python
def convert(self, output_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_file_path | `str` | The path where the Markdown file will be written. |

**Returns:** ConvertResult: A ConvertResult indicating success or failure. On success, ConvertResult.Content is None because the output was written to the file.

#### convert

Converts the loaded document to Markdown with the specified options and returns the result with the Markdown content in `ConvertResult.content`.

```python
def convert(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` | Options that control the conversion, such as `ConvertOptions.heading_level_offset`, `ConvertOptions.image_export_strategy`, and `ConvertOptions.page_numbers`. Pass `None` to use defaults. |

**Returns:** A `ConvertResult` whose `ConvertResult.content` contains the Markdown string on success.

#### convert

Converts the loaded document to Markdown with the specified options, writing the output to a stream.

```python
def convert(self, output_stream, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_stream | `io.RawIOBase` | A writable stream that will receive the UTF-8 encoded Markdown output. |
| convert_options | `ConvertOptions` | Options that control the conversion. Pass `None` to use defaults. |

**Returns:** A `ConvertResult` indicating success or failure. `ConvertResult.content` is `None` because the output was written to the stream.

#### convert

Converts the loaded document to Markdown with the specified options and saves the result to a file.

```python
def convert(self, output_file_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_file_path | `str` | The path where the Markdown file will be written. |
| convert_options | `ConvertOptions` | Options that control the conversion. Pass `None` to use defaults. |

**Returns:** ConvertResult: A `ConvertResult` indicating success or failure. `ConvertResult.content` is `None` because the output was written to the file.

### convert_async method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/convert_async.md

#### convert_async

Asynchronously converts the loaded document to Markdown and returns the result as a string.

```python
def convert_async(self):
    ...
```

**Returns:** str: The converted Markdown content.

#### convert_async

Asynchronously converts the loaded document to Markdown with the specified options.

```python
def convert_async(self, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| convert_options | `ConvertOptions` | Options that control the conversion. |

#### convert_async

Asynchronously converts the loaded document and saves the result to a file.

```python
def convert_async(self, output_file_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_file_path | `str` | The path where the Markdown file will be written. |
| convert_options | `ConvertOptions` | Options that control the conversion. Pass `None` for defaults. |

### from_markdown method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/from_markdown.md

#### from_markdown

Converts a Markdown file to a document format, inferring the output format from the file extension of `output_path` (e.g., `.docx`, `.pdf`).

```python
def from_markdown(cls, markdown_path, output_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| markdown_path | `str` | Path to the source Markdown file. |
| output_path | `str` | Path where the output document will be saved. The extension determines the format. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |
| `NotImplementedError` | Thrown when the output format is not supported. |

#### from_markdown

Converts a Markdown file to a document format with the specified export options.

```python
def from_markdown(cls, markdown_path, output_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| markdown_path | `str` | Path to the source Markdown file. |
| output_path | `str` | Path where the output document will be saved. |
| options | `ExportOptions` | Export options. Use `ExportOptions.format` to override format detection, or pass `None` to infer from the output file extension. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |
| `NotImplementedError` | Thrown when the output format is not supported. |

### from_markdown_string method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/from_markdown_string.md

#### from_markdown_string

Converts a Markdown string to a document and saves it to a file.

```python
def from_markdown_string(cls, markdown_content, output_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| markdown_content | `str` | The Markdown content as a string. |
| output_path | `str` | Path where the output document will be saved. |
| options | `ExportOptions` | Export options, or `None` to infer format from the file extension. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |
| `NotImplementedError` | Thrown when the output format is not supported. |

#### from_markdown_string

Converts a Markdown string to a document and writes it to a stream.

```python
def from_markdown_string(cls, markdown_content, output_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| markdown_content | `str` | The Markdown content as a string. |
| output_stream | `io.RawIOBase` | A writable stream that will receive the document bytes. |
| options | `ExportOptions` | Export options. `ExportOptions.format` must be set since there is no file extension to infer from. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |
| `ValueError` | Thrown when `options` is None or `ExportOptions.format` is `FileFormat.unknown`. |

### get_document_info method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/get_document_info.md

#### get_document_info

Retrieves metadata about the loaded document without performing a full conversion.

```python
def get_document_info(self):
    ...
```

**Returns:** DocumentInfo: A DocumentInfo containing the detected `FileFormat`, `PageCount`, `Title`, `Author`, and `IsEncrypted` flag.

### get_document_info_async method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/get_document_info_async.md

#### get_document_info_async

Asynchronously retrieves metadata about the loaded document.

```python
def get_document_info_async(self):
    ...
```

### get_info method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/get_info.md

#### get_info

Returns metadata about a document (format, page count, title, author, encryption status) without performing a full conversion.

```python
def get_info(cls, source_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |

**Returns:** DocumentInfo: A `DocumentInfo` with the detected format, page count, and other metadata.

| Raises | Description |
| :- | :- |
| `ValueError` | When `source_path` is None or empty. |
| `NotImplementedError` | When the file format is not supported. |

#### get_info

Returns metadata about a document using the specified load options. Use this overload to supply a password when inspecting an encrypted document.

```python
def get_info(cls, source_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| load_options | `LoadOptions` | Options for loading the document (password, format hint). May be None. |

**Returns:** DocumentInfo: The detected format, page count, and other metadata.

| Raises | Description |
| :- | :- |
| `ValueError` | When `source_path` is None or empty. |
| `NotImplementedError` | When the file format is not supported. |

### get_info_async method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/get_info_async.md

#### get_info_async

Asynchronously retrieves metadata about the document at the specified path.

```python
def get_info_async(cls, source_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| load_options | `LoadOptions` | Options for loading the document. May be None. |

### get_supported_formats method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/get_supported_formats.md

#### get_supported_formats

Returns the complete list of FileFormat values that can be converted to Markdown.

Use this to check at runtime whether a particular format is supported before attempting conversion.

```python
def get_supported_formats(cls):
    ...
```

**Returns:** list[FileFormat]: A read-only list of all supported FileFormat values.

### to_file method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/to_file.md

#### to_file

Converts a document to Markdown and saves the result directly to a file.

```python
def to_file(cls, source_path, output_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document (e.g. `"report.pdf"`). |
| output_path | `str` | The path where the Markdown file will be created or overwritten. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `ValueError` | Thrown when `source_path` is None or empty. |
| `NotImplementedError` | Thrown when the file format is not supported. |

#### to_file

Converts a document to Markdown with the specified conversion options and saves the result to a file.

```python
def to_file(cls, source_path, output_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| output_path | `str` | The path where the Markdown file will be created or overwritten. |
| convert_options | `ConvertOptions` | Options that customize the conversion (image strategy, heading offset, page numbers). May be `None`. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `NotImplementedError` | Thrown when the file format is not supported. |

#### to_file

Converts a document to Markdown with the specified load and conversion options, saving the result to a file.

```python
def to_file(cls, source_path, output_path, load_options, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| output_path | `str` | The path where the Markdown file will be created or overwritten. |
| load_options | `LoadOptions` | Options for loading the document (password, format hint). May be None. |
| convert_options | `ConvertOptions` | Options that customize the conversion. May be None. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `NotImplementedError` | Thrown when the file format is not supported. |

### to_file_async method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/to_file_async.md

#### to_file_async

Asynchronously converts the document and saves the result to a file.

Both source reading and output writing are performed asynchronously.

```python
def to_file_async(cls, source_path, output_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| output_path | `str` | The path where the Markdown file will be saved. |
| convert_options | `ConvertOptions` | Options for the conversion. May be None. |

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |

### to_markdown method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/to_markdown.md

#### to_markdown

Converts a document to Markdown in a single call and returns the Markdown string.

```python
def to_markdown(cls, source_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document (e.g. `"report.docx"`). |

**Returns:** str: The converted Markdown content as a UTF-8 string.

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `ValueError` | Thrown when `source_path` is None or empty. |
| `NotImplementedError` | Thrown when the file format is not supported. |

#### to_markdown

Converts a document to Markdown using the specified load options and returns the Markdown string.

Use this overload to supply a password for encrypted documents or to specify the file format explicitly.

```python
def to_markdown(cls, source_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| load_options | `LoadOptions` | Options for loading the document (password, format hint). May be None. |

**Returns:** str: The converted Markdown content as a UTF-8 string.

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `NotImplementedError` | Thrown when the file format is not supported. |

#### to_markdown

Converts a document to Markdown using the specified conversion options and returns the Markdown string.

Use this overload to control image handling, heading offsets, or page selection.

```python
def to_markdown(cls, source_path, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| convert_options | `ConvertOptions` | Options that customize the conversion (image strategy, heading offset, page numbers). May be None. |

**Returns:** str: The converted Markdown content as a UTF-8 string.

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when the conversion fails. |
| `NotImplementedError` | Thrown when the file format is not supported. |

#### to_markdown

Converts a document to Markdown using the specified load and conversion options, and returns the Markdown string.

```python
def to_markdown(cls, source_path, load_options, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| load_options | `LoadOptions` | Options for loading the document (password, format hint). May be None. |
| convert_options | `ConvertOptions` | Options that customize the conversion. May be None. |

**Returns:** str: The converted Markdown content as a UTF-8 string.

| Raises | Description |
| :- | :- |
| `NotImplementedError` | Thrown when the file format is not supported. |

### to_markdown_async method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownconverter/to_markdown_async.md

#### to_markdown_async

Asynchronously converts the document at the specified path to Markdown. File reading is performed asynchronously.

```python
def to_markdown_async(cls, source_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |

**Returns:** str: The converted Markdown content.

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |

#### to_markdown_async

Asynchronously converts the document at the specified path to Markdown.

```python
def to_markdown_async(cls, source_path, load_options, convert_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_path | `str` | The path to the source document. |
| load_options | `LoadOptions` | Options for loading the document. May be None. |
| convert_options | `ConvertOptions` | Options for the conversion. May be None. |

**Returns:** str: The converted Markdown content.

| Raises | Description |
| :- | :- |
| `GroupDocsMarkdownException` | Thrown when conversion fails. |

### MarkdownFlavor class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownflavor.md

#### MarkdownFlavor class

Specifies the target Markdown dialect for the conversion output.

The MarkdownFlavor type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GitHub | GitHub Flavored Markdown—supports tables, strikethrough, and task lists. |
| CommonMark | Strict CommonMark output. |

### CommonMark field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownflavor/commonmark.md

#### CommonMark field

Strict CommonMark output.

Tables are rendered as code blocks since CommonMark does not have native table syntax.

##### Value
`1`

### GitHub field
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/markdownflavor/github.md

#### GitHub field

GitHub Flavored Markdown—supports tables, strikethrough, and task lists.

This is the default.

##### Value
`0`

### Metered class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/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. |

### get_consumption_credit method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/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/markdown/python-net/groupdocs.markdown/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/markdown/python-net/groupdocs.markdown/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. |

### SkipImagesStrategy class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/skipimagesstrategy.md

#### SkipImagesStrategy class

Implements an image export strategy that skips saving images during document conversion.

This strategy is useful when you want to convert a document to Markdown without saving the actual image files.
When this strategy is used, the output Markdown will still contain image references (e.g., !), but the actual image files will not be saved to disk.

The SkipImagesStrategy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Returns None to indicate that the image should be skipped. |

##### Properties
| Property | Description |
| :- | :- |
| images_folder | The images folder is an empty string because this strategy does not use an images folder. |

### __init__ constructor
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/skipimagesstrategy/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### get_image_stream method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/skipimagesstrategy/get_image_stream.md

#### get_image_stream

Returns None to indicate that the image should be skipped.

```python
def get_image_stream(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `ImageExportContext` | The image export context (not used in this implementation). |

**Returns:** Always returns None to skip the image.

### images_folder property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/skipimagesstrategy/images_folder.md

#### images_folder property

The images folder is an empty string because this strategy does not use an images folder.

An empty string since no images are exported.

##### Definition:
```python
@property
def images_folder(self):
    ...
```

### UriExportContext class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext.md

#### UriExportContext class

Contains information about a resource URI being written during conversion and is passed to `IUriExportStrategy.update_resource_uri`.

Read the default values from `UriExportContext.resource_file_name` and `UriExportContext.resource_file_uri`, then call `UriExportContext.set_resource_file_name` or `UriExportContext.set_resource_file_uri` to override them.

The UriExportContext type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_resource_file_name | Overrides the resource file name in the Markdown output. |
| set_resource_file_uri | Overrides the URI that will appear in the Markdown output. |

##### Properties
| Property | Description |
| :- | :- |
| resource_file_name | The default resource file name generated by the library. |
| resource_file_name_output | The overridden file name, or None if no override was set. |
| resource_file_uri | The default URI that the library would write into the Markdown output. |
| resource_file_uri_output | The overridden URI, or None if no override was set. |

### resource_file_name property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/resource_file_name.md

#### resource_file_name property

The default resource file name generated by the library.

##### Definition:
```python
@property
def resource_file_name(self):
    ...
```

### resource_file_name_output property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/resource_file_name_output.md

#### resource_file_name_output property

The overridden file name, or None if no override was set.

##### Definition:
```python
@property
def resource_file_name_output(self):
    ...
```

### resource_file_uri property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/resource_file_uri.md

#### resource_file_uri property

The default URI that the library would write into the Markdown output.

##### Definition:
```python
@property
def resource_file_uri(self):
    ...
```

### resource_file_uri_output property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/resource_file_uri_output.md

#### resource_file_uri_output property

The overridden URI, or None if no override was set.

##### Definition:
```python
@property
def resource_file_uri_output(self):
    ...
```

### set_resource_file_name method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/set_resource_file_name.md

#### set_resource_file_name

Overrides the resource file name in the Markdown output.

```python
def set_resource_file_name(self, resource_file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| resource_file_name | `str` | The new file name. |

### set_resource_file_uri method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/uriexportcontext/set_resource_file_uri.md

#### set_resource_file_uri

Overrides the URI that will appear in the Markdown output.

```python
def set_resource_file_uri(self, resource_file_uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| resource_file_uri | `str` | The new URI (for example, a CDN URL). |

### UriSavingArgs class
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs.md

#### UriSavingArgs class

Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion.

Call `UriSavingArgs.set_resource_file_uri` to change the URI that appears in the Markdown output.
If no override is set, the library uses the default `UriSavingArgs.resource_file_uri`.

The UriSavingArgs type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| set_resource_file_uri | Overrides the URI that will be written to the Markdown output for this resource. |

##### Properties
| Property | Description |
| :- | :- |
| resource_file_name | The default file name (without path) generated by the library for this resource. |
| resource_file_name_output | The overridden file name set by the caller, or None if no override was specified. |
| resource_file_uri | The default resource URI that the library would write into the Markdown output. |
| resource_file_uri_output | The overridden URI set by `UriSavingArgs.set_resource_file_uri`, or `None` if no override was specified. |

### resource_file_name property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs/resource_file_name.md

#### resource_file_name property

The default file name (without path) generated by the library for this resource.

##### Definition:
```python
@property
def resource_file_name(self):
    ...
```

### resource_file_name_output property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs/resource_file_name_output.md

#### resource_file_name_output property

The overridden file name set by the caller, or None if no override was specified.

##### Definition:
```python
@property
def resource_file_name_output(self):
    ...
```

### resource_file_uri property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs/resource_file_uri.md

#### resource_file_uri property

The default resource URI that the library would write into the Markdown output.

##### Definition:
```python
@property
def resource_file_uri(self):
    ...
```

### resource_file_uri_output property
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs/resource_file_uri_output.md

#### resource_file_uri_output property

The overridden URI set by `UriSavingArgs.set_resource_file_uri`, or `None` if no override was specified.

##### Definition:
```python
@property
def resource_file_uri_output(self):
    ...
```

### set_resource_file_uri method
Path: https://reference.groupdocs.com/markdown/python-net/groupdocs.markdown/urisavingargs/set_resource_file_uri.md

#### set_resource_file_uri

Overrides the URI that will be written to the Markdown output for this resource.

```python
def set_resource_file_uri(self, resource_file_uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| resource_file_uri | `str` | The new URI to use (for example, a CDN URL or an absolute path). |


# GroupDocs.Merger

> Merge, split, reorder, rotate, and manage pages across document formats.

## Java

### GroupDocs.Merger for Java
Path: https://reference.groupdocs.com/merger/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.merger | The **com.groupdocs.merger** namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others.. |
| com.groupdocs.merger.domain | The **com.groupdocs.merger.domain** namespace provides classes for working with document structure. |
| com.groupdocs.merger.domain.builders | The **com.groupdocs.merger.domain.builders** namespace provides builders. |
| com.groupdocs.merger.domain.common | The **com.groupdocs.merger.domain.common** namespace provides common delegates. |
| com.groupdocs.merger.domain.options | The **com.groupdocs.merger.domain.options** namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents. |
| com.groupdocs.merger.domain.options.interfaces | The **com.groupdocs.merger.domain.options.interfaces** namespace provides classes for working with Interfaces. |
| com.groupdocs.merger.domain.result | The **com.groupdocs.merger.domain.result** namespace provides classes which represent document results. |
| com.groupdocs.merger.exceptions | The **com.groupdocs.merger.exceptions** namespace provides classes for exceptions which can occur while working with a document. |
| com.groupdocs.merger.licensing | The **com.groupdocs.merger.licensing** namespace provides methods to license the component. |
| com.groupdocs.merger.licensing.metered | The **com.groupdocs.merger.licensing.metered** namespace provides methods to set metered key. |
| com.groupdocs.merger.logging | The **com.groupdocs.merger.logging** namespace provides classes for customizing logging behaviour. |

### com.groupdocs.merger.domain.builders
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.builders.md

The **com.groupdocs.merger.domain.builders** namespace provides builders.

#### Classes

| Class | Description |
| --- | --- |
| PageBuilder | PageInfo builder for getting the page collection from the documents. |

### PageBuilder
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.builders/pagebuilder.md

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

PageInfo builder for getting the page collection from the documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageBuilder() | Initializes a new instance of the PageBuilder class. |
| PageBuilder(PageBuilderOptions options) | Initializes a new instance of the PageBuilder class. |
#### Methods

| Method | Description |
| --- | --- |
| getOptions() | The page builder options. |
| getPages() | The page collection. |
| getDocuments() | The document collection. |
| addDocument(int index, InputStream stream, FileType fileType, String password) | Add document to the document collection. |
| addDocument(DocumentInfo document) | Add document to the document collection. |
| addPage(int documentIndex, int pageNumber) | Add page to the page collection. |
| addPage(IPageInfo page) | Add page to the page collection. |
| addPageRange(IPageInfo[] pages) | Add pages to the page collection. |
| clear() | Clear the internal collections. |
##### PageBuilder()
```
public PageBuilder()
```

Initializes a new instance of the PageBuilder class.

##### PageBuilder(PageBuilderOptions options)
```
public PageBuilder(PageBuilderOptions options)
```

Initializes a new instance of the PageBuilder class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageBuilderOptions | The page builder options. |

##### getOptions()
```
public final PageBuilderOptions getOptions()
```

The page builder options.

**Returns:**
PageBuilderOptions
##### getPages()
```
public final List<PageInfo> getPages()
```

The page collection.

**Returns:**
java.util.List<com.groupdocs.merger.domain.result.PageInfo>
##### getDocuments()
```
public final Map<Integer,DocumentInfo> getDocuments()
```

The document collection.

**Returns:**
java.util.Map<java.lang.Integer,com.groupdocs.merger.domain.result.DocumentInfo>
##### addDocument(int index, InputStream stream, FileType fileType, String password)
```
public final void addDocument(int index, InputStream stream, FileType fileType, String password)
```

Add document to the document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | DocumentInfo index. |
| stream | java.io.InputStream | DocumentInfo stream. |
| fileType | FileType | DocumentInfo type. |
| password | java.lang.String | DocumentInfo password. |

##### addDocument(DocumentInfo document)
```
public final void addDocument(DocumentInfo document)
```

Add document to the document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | DocumentInfo | DocumentInfo instance. |

##### addPage(int documentIndex, int pageNumber)
```
public final void addPage(int documentIndex, int pageNumber)
```

Add page to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentIndex | int | DocumentInfo index. |
| pageNumber | int | PageInfo number. |

##### addPage(IPageInfo page)
```
public final void addPage(IPageInfo page)
```

Add page to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | IPageInfo | PageInfo instance. |

##### addPageRange(IPageInfo[] pages)
```
public final void addPageRange(IPageInfo[] pages)
```

Add pages to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pages | IPageInfo\[\] | Pages array. |

##### clear()
```
public final void clear()
```

Clear the internal collections.

### com.groupdocs.merger.domain.common
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.common.md

The **com.groupdocs.merger.domain.common** namespace provides common delegates.

#### Interfaces

| Interface | Description |
| --- | --- |
| PageStreamFactory | Interface that defines method to create output page preview stream. |
| SplitStreamFactory | Interface that defines method to create output split stream. |

### PageStreamFactory
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.common/pagestreamfactory.md

### SplitStreamFactory
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.common/splitstreamfactory.md

### com.groupdocs.merger.domain.options.interfaces
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces.md

The **com.groupdocs.merger.domain.options.interfaces** namespace provides classes for working with Interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAddPasswordOptions | Interface for the password adding options. |
| IExtractOptions | Interface for options to extract the document pages. |
| IImageJoinOptions | Interface for the image joining options. |
| IImportDocumentOptions | Interface for import of the embedded document. |
| IJoinOptions | Interface for the document joining options. |
| ILoadOptions | Interface for the document loading options. |
| IMoveOptions | Interface for the moving page options. |
| IOleDiagramOptions | Interface for import options of the embedded document to Diagram via OLE. |
| IOlePresentationOptions | Interface for import options of the embedded document to Presentation via OLE. |
| IOleSpreadsheetOptions | Interface for import options of the embedded document to Spreadsheet via OLE. |
| IOleWordProcessingOptions | Interface for import options of the embedded document to Word processing via OLE. |
| IOptions | Interface for the base options. |
| IOrientationOptions | Interface for the page orientation options. |
| IPageBuilderOptions | Interface for the page builder options |
| IPageJoinOptions | Interface for the document page joining options. |
| IPageOptions | Interface for the page options |
| IPager | Interface for apply option (pages, range and etc.) |
| IPdfAttachmentOptions | Interface for options of the embedded document to PDF as attachment. |
| IPreviewOptions | Interface for the preview options. |
| IRemoveOptions | Interface for the page removing options. |
| IRotateOptions | Interface for the page rotating options. |
| ISaveOptions | Interface for the document saving options. |
| ISizeOptions | Interface for adding embedded object. |
| ISplitOptions | Interface for the splitting options. |
| ISwapOptions | Interface for the page swapping options. |
| ITextSplitOptions | Interface for the text splitting options. |
| IUpdatePasswordOptions | Interface for the password updating options. |

### IAddPasswordOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iaddpasswordoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IAddPasswordOptions extends IOptions
```

Interface for the password adding options.
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | The password for document protection. |
##### getPassword()
```
public abstract String getPassword()
```

The password for document protection.

**Returns:**
java.lang.String

### IExtractOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iextractoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IExtractOptions extends IPageOptions
```

Interface for options to extract the document pages.

### IImageJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iimagejoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public interface IImageJoinOptions extends IJoinOptions
```

Interface for the image joining options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | The image join mode. |
##### getMode()
```
public abstract int getMode()
```

The image join mode.

**Returns:**
int

### IImportDocumentOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iimportdocumentoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IImportDocumentOptions extends IOptions
```

Interface for import of the embedded document.
#### Methods

| Method | Description |
| --- | --- |
| getObjectData() | The data of the embedded object. |
| getExtension() | The extension of the embedded object. |
| getPageNumber() | The page number for inserting of the embedded object. |
##### getObjectData()
```
public abstract byte[] getObjectData()
```

The data of the embedded object.

**Returns:**
byte[]
##### getExtension()
```
public abstract String getExtension()
```

The extension of the embedded object.

**Returns:**
java.lang.String
##### getPageNumber()
```
public abstract int getPageNumber()
```

The page number for inserting of the embedded object.

**Returns:**
int

### IJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ijoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IJoinOptions extends IOptions
```

Interface for the document joining options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### getType()
```
public abstract FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### ILoadOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iloadoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ILoadOptions extends IOptions
```

Interface for the document loading options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to open. |
| getPassword() | The password for opening password-protected file. |
| getExtension() | The extension of the file to open. |
| getEncoding() | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
##### getType()
```
public abstract FileType getType()
```

The type of the file to open.

**Returns:**
FileType
##### getPassword()
```
public abstract String getPassword()
```

The password for opening password-protected file.

**Returns:**
java.lang.String
##### getExtension()
```
public abstract String getExtension()
```

The extension of the file to open.

**Returns:**
java.lang.String
##### getEncoding()
```
public abstract Charset getEncoding()
```

The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is [DefaultCharset][].

[DefaultCharset]: https://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html#defaultCharset%28%29

**Returns:**
java.nio.charset.Charset

### IMoveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/imoveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IMoveOptions extends IOptions
```

Interface for the moving page options.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumberToMove() | Gets or sets the page number to move. |
| getNewPageNumber() | Gets or sets the new page number. |
##### getPageNumberToMove()
```
public abstract int getPageNumberToMove()
```

Gets or sets the page number to move.

Value: The page number to move.

**Returns:**
int
##### getNewPageNumber()
```
public abstract int getNewPageNumber()
```

Gets or sets the new page number.

Value: The new page number.

**Returns:**
int

### IOleDiagramOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iolediagramoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleDiagramOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Diagram via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setX(int value) | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getY() | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setY(int value) | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getImageData() | The image data of the embedded object. |
##### getX()
```
public abstract int getX()
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

**Returns:**
int
##### setX(int value)
```
public abstract void setX(int value)
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getY()
```
public abstract int getY()
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

**Returns:**
int
##### setY(int value)
```
public abstract void setY(int value)
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The image data of the embedded object.

**Returns:**
byte[]

### IOlePresentationOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iolepresentationoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOlePresentationOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Presentation via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object frame. |
| setX(int value) | The X coordinate of the embedded object frame. |
| getY() | The Y coordinate of the embedded object frame. |
| setY(int value) | The Y coordinate of the embedded object frame. |
##### getX()
```
public abstract int getX()
```

The X coordinate of the embedded object frame.

**Returns:**
int
##### setX(int value)
```
public abstract void setX(int value)
```

The X coordinate of the embedded object frame.

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

##### getY()
```
public abstract int getY()
```

The Y coordinate of the embedded object frame.

**Returns:**
int
##### setY(int value)
```
public abstract void setY(int value)
```

The Y coordinate of the embedded object frame.

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

### IOleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iolespreadsheetoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleSpreadsheetOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Spreadsheet via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getRowIndex() | The upper left row index. |
| setRowIndex(int value) | The upper left row index. |
| getColumnIndex() | The upper left column index. |
| setColumnIndex(int value) | The upper left column index. |
| getImageData() | The data of the Ole object image. |
##### getRowIndex()
```
public abstract int getRowIndex()
```

The upper left row index.

**Returns:**
int
##### setRowIndex(int value)
```
public abstract void setRowIndex(int value)
```

The upper left row index.

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

##### getColumnIndex()
```
public abstract int getColumnIndex()
```

The upper left column index.

**Returns:**
int
##### setColumnIndex(int value)
```
public abstract void setColumnIndex(int value)
```

The upper left column index.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### IOleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iolewordprocessingoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleWordProcessingOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Word processing via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | The left coordinate of the Ole object image. |
| setLeft(int value) | The left coordinate of the Ole object image. |
| getTop() | The top coordinate of the Ole object image. |
| setTop(int value) | The top coordinate of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### getLeft()
```
public abstract int getLeft()
```

The left coordinate of the Ole object image.

**Returns:**
int
##### setLeft(int value)
```
public abstract void setLeft(int value)
```

The left coordinate of the Ole object image.

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

##### getTop()
```
public abstract int getTop()
```

The top coordinate of the Ole object image.

**Returns:**
int
##### setTop(int value)
```
public abstract void setTop(int value)
```

The top coordinate of the Ole object image.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### IOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ioptions.md

### IOrientationOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iorientationoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IOrientationOptions extends IPageOptions
```

Interface for the page orientation options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for the page orientation. |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for the page orientation.

**Returns:**
int

### IPageBuilderOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipagebuilderoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IPageBuilderOptions extends IOptions
```

Interface for the page builder options
#### Methods

| Method | Description |
| --- | --- |
| getLoadDocumentInfo() | Specifies if each document info should load all its pages info. |
| setLoadDocumentInfo(boolean value) | Specifies if each document info should load all its pages info. |
##### getLoadDocumentInfo()
```
public abstract boolean getLoadDocumentInfo()
```

Specifies if each document info should load all its pages info.

**Returns:**
boolean
##### setLoadDocumentInfo(boolean value)
```
public abstract void setLoadDocumentInfo(boolean value)
```

Specifies if each document info should load all its pages info.

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

### IPageJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipagejoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions, com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public interface IPageJoinOptions extends IPageOptions, IJoinOptions
```

Interface for the document page joining options.

### IPageOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipageoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IPageOptions extends IOptions
```

Interface for the page options
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Page numbers for the page options. |
##### getPages()
```
public abstract int[] getPages()
```

Page numbers for the page options.

**Returns:**
int[]

### IPager
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipager.md

### IPdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipdfattachmentoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions
```
public interface IPdfAttachmentOptions extends IImportDocumentOptions
```

Interface for options of the embedded document to PDF as attachment.

### IPreviewOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/ipreviewoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IPreviewOptions extends IPageOptions
```

Interface for the preview options.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Preview width. |
| setWidth(int value) | Preview width. |
| getHeight() | Preview height. |
| setHeight(int value) | Preview height. |
| getResolution() | Image resolution. |
| setResolution(int value) | Image resolution. |
| getMode() | Gets the mode for preview. |
| validate(FileType fileType) | Validates the split options. |
| getPathByPageNumber(int pageNumber, String extension) | Gets the full file path of previewed document by page number with defined extension. |
| getPageStreamFactory() | Delegate that defines method to create output page preview stream. |
##### getWidth()
```
public abstract int getWidth()
```

Preview width.

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

Preview width.

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

##### getHeight()
```
public abstract int getHeight()
```

Preview height.

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

Preview height.

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

##### getResolution()
```
public abstract int getResolution()
```

Image resolution.

**Returns:**
int
##### setResolution(int value)
```
public abstract void setResolution(int value)
```

Image resolution.

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

##### getMode()
```
public abstract int getMode()
```

Gets the mode for preview.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByPageNumber(int pageNumber, String extension)
```
public abstract String getPathByPageNumber(int pageNumber, String extension)
```

Gets the full file path of previewed document by page number with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | Page number of preview. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getPageStreamFactory()
```
public abstract PageStreamFactory getPageStreamFactory()
```

Delegate that defines method to create output page preview stream.

**Returns:**
PageStreamFactory

### IRemoveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iremoveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IRemoveOptions extends IPageOptions
```

Interface for the page removing options.

### IRotateOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/irotateoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IRotateOptions extends IPageOptions
```

Interface for the page rotating options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for rotating (90, 180 or 270 degrees). |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for rotating (90, 180 or 270 degrees).

**Returns:**
int

### ISaveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/isaveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ISaveOptions extends IOptions
```

Interface for the document saving options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | File type. |
##### getType()
```
public abstract FileType getType()
```

File type.

**Returns:**
FileType

### ISizeOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/isizeoptions.md

### ISplitOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/isplitoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface ISplitOptions extends IPageOptions
```

Interface for the splitting options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for page splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | Delegate that defines method to create output split stream. |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for page splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public abstract String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public abstract SplitStreamFactory getSplitStreamFactory()
```

Delegate that defines method to create output split stream.

**Returns:**
SplitStreamFactory

### ISwapOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iswapoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ISwapOptions extends IOptions
```

Interface for the page swapping options.
#### Methods

| Method | Description |
| --- | --- |
| getFirstPageNumber() | First page number to exchange. |
| getSecondPageNumber() | Second page number to exchange. |
##### getFirstPageNumber()
```
public abstract int getFirstPageNumber()
```

First page number to exchange.

**Returns:**
int
##### getSecondPageNumber()
```
public abstract int getSecondPageNumber()
```

Second page number to exchange.

**Returns:**
int

### ITextSplitOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/itextsplitoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ITextSplitOptions extends IOptions
```

Interface for the text splitting options.
#### Methods

| Method | Description |
| --- | --- |
| getLineNumbers() | Line numbers for text splitting. |
| getMode() | Mode for text splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | Delegate that defines method to create output split stream. |
##### getLineNumbers()
```
public abstract int[] getLineNumbers()
```

Line numbers for text splitting.

**Returns:**
int[]
##### getMode()
```
public abstract int getMode()
```

Mode for text splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public abstract String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public abstract SplitStreamFactory getSplitStreamFactory()
```

Delegate that defines method to create output split stream.

**Returns:**
SplitStreamFactory

### IUpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.interfaces/iupdatepasswordoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IUpdatePasswordOptions extends IOptions
```

Interface for the password updating options.
#### Methods

| Method | Description |
| --- | --- |
| getNewPassword() | The new password for document protection. |
##### getNewPassword()
```
public abstract String getNewPassword()
```

The new password for document protection.

**Returns:**
java.lang.String

### com.groupdocs.merger.domain.options
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options.md

The **com.groupdocs.merger.domain.options** namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| AddPasswordOptions | Provides options for adding document password. |
| ExtractOptions | Provides options to extract the document pages. |
| ImageJoinMode | Possible modes for the image joining. |
| ImageJoinOptions | The image join options. |
| ImportDocumentOptions | Provides options for the embedded document import. |
| JoinOptions | Provides options for the document joining. |
| LoadOptions | Provides options for the document loading. |
| MoveOptions | Provides options for moving document page. |
| OleDiagramOptions | Provides options for import of the embedded document to Diagram via OLE. |
| OlePresentationOptions | Provides options for import of the embedded document to Presentation via OLE. |
| OleSpreadsheetOptions | Provides options for import of the embedded document to Spreadsheet via OLE. |
| OleWordProcessingOptions | Provides options for import of the embedded document to Word processing via OLE. |
| OrientationMode | Defines page orientation. |
| OrientationOptions | Provides options for the page orientation. |
| PageBuilderOptions | Provides options for specifying the page builder. |
| PageJoinOptions | Provides options for the document joining. |
| PageOptions | Provides options for specifying page or pages range. |
| PdfAccessibilitySettings | Provides Pdf Accessibility settings for the document saving. |
| PdfAttachmentOptions | Provides options to attach the embedded object to Pdf. |
| PdfSaveOptions | Provides additional Pdf options for the document saving. |
| PreviewMode | Provides modes for the page previewing. |
| PreviewOptions | Represents document preview options. |
| RangeMode | Possible modes for the page ranging. |
| RemoveOptions | Provides options for the page removing. |
| RotateMode | Possible modes for the page rotation. |
| RotateOptions | Provides options for the page rotation. |
| SaveOptions | Provides options for the document saving. |
| SplitMode | Defines page splitting modes. |
| SplitOptions | Provides options for the document page splitting. |
| SwapOptions | Provides options for swapping document pages. |
| TextSplitMode | Possible text splitting modes. |
| TextSplitOptions | Provides options for the document text splitting. |
| UpdatePasswordOptions | Provides options for updating document password. |
| WordJoinCompliance | Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc. |
| WordJoinMode | Possible modes for the Word joining. |
| WordJoinOptions | The Word join options. |

### AddPasswordOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/addpasswordoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IAddPasswordOptions
```
public class AddPasswordOptions implements IAddPasswordOptions
```

Provides options for adding document password.
#### Constructors

| Constructor | Description |
| --- | --- |
| AddPasswordOptions(String password) | Initializes a new instance of the AddPasswordOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | The password for document protection. |
##### AddPasswordOptions(String password)
```
public AddPasswordOptions(String password)
```

Initializes a new instance of the AddPasswordOptions class.

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

##### getPassword()
```
public final String getPassword()
```

The password for document protection.

**Returns:**
java.lang.String

### ExtractOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/extractoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IExtractOptions
```
public class ExtractOptions extends PageOptions implements IExtractOptions
```

Provides options to extract the document pages.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExtractOptions() | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int[] pageNumbers) | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int startNumber, int endNumber) | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the ExtractOptions class. |
##### ExtractOptions()
```
public ExtractOptions()
```

Initializes a new instance of the ExtractOptions class.

##### ExtractOptions(int[] pageNumbers)
```
public ExtractOptions(int[] pageNumbers)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### ExtractOptions(int startNumber, int endNumber)
```
public ExtractOptions(int startNumber, int endNumber)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### ExtractOptions(int startNumber, int endNumber, int mode)
```
public ExtractOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

### ImageJoinMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/imagejoinmode.md

**Inheritance:**
java.lang.Object
```
public final class ImageJoinMode
```

Possible modes for the image joining.
#### Fields

| Field | Description |
| --- | --- |
| Horizontal | Specifies Horizontal image joining. |
| Vertical | Specifies Vertical image joining. |
##### Horizontal
```
public static final int Horizontal
```

Specifies Horizontal image joining.

##### Vertical
```
public static final int Vertical
```

Specifies Vertical image joining.

### ImageJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/imagejoinoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImageJoinOptions
```
public class ImageJoinOptions implements IImageJoinOptions
```

The image join options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageJoinOptions() | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(FileType fileType) | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(int imageJoinMode) | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(FileType fileType, int imageJoinMode) | Initializes new instance of ImageJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The image file type. |
| getMode() | The image join mode. |
##### ImageJoinOptions()
```
public ImageJoinOptions()
```

Initializes new instance of ImageJoinOptions class.

##### ImageJoinOptions(FileType fileType)
```
public ImageJoinOptions(FileType fileType)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |

##### ImageJoinOptions(int imageJoinMode)
```
public ImageJoinOptions(int imageJoinMode)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageJoinMode | int | The image join mode. |

##### ImageJoinOptions(FileType fileType, int imageJoinMode)
```
public ImageJoinOptions(FileType fileType, int imageJoinMode)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |
| imageJoinMode | int | The image join mode. |

##### getType()
```
public final FileType getType()
```

The image file type.

**Returns:**
FileType
##### getMode()
```
public final int getMode()
```

The image join mode.

**Returns:**
int

### ImportDocumentOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/importdocumentoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions
```
public abstract class ImportDocumentOptions implements IImportDocumentOptions
```

Provides options for the embedded document import.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportDocumentOptions(byte[] objectData, String extension, int pageNumber) | Initializes a new instance of the ImportDocumentOptions class. |
| ImportDocumentOptions(String filePath, int pageNumber) | Initializes a new instance of the ImportDocumentOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getObjectData() | The data of the embedded object. |
| getExtension() | The extension of the embedded object. |
| getPageNumber() | The page number for inserting of the embedded object. |
| getImageData(String filePath) | Gets image data of the embedded object. |
##### ImportDocumentOptions(byte[] objectData, String extension, int pageNumber)
```
public ImportDocumentOptions(byte[] objectData, String extension, int pageNumber)
```

Initializes a new instance of the ImportDocumentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### ImportDocumentOptions(String filePath, int pageNumber)
```
public ImportDocumentOptions(String filePath, int pageNumber)
```

Initializes a new instance of the ImportDocumentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getObjectData()
```
public final byte[] getObjectData()
```

The data of the embedded object.

**Returns:**
byte[]
##### getExtension()
```
public final String getExtension()
```

The extension of the embedded object.

**Returns:**
java.lang.String
##### getPageNumber()
```
public final int getPageNumber()
```

The page number for inserting of the embedded object.

**Returns:**
int
##### getImageData(String filePath)
```
public final byte[] getImageData(String filePath)
```

Gets image data of the embedded object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |

**Returns:**
byte[]

### JoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/joinoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public class JoinOptions implements IJoinOptions
```

Provides options for the document joining.
#### Constructors

| Constructor | Description |
| --- | --- |
| JoinOptions() | Initializes a new instance of the JoinOptions class. |
| JoinOptions(FileType fileType) | Initializes a new instance of the JoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### JoinOptions()
```
public JoinOptions()
```

Initializes a new instance of the JoinOptions class.

##### JoinOptions(FileType fileType)
```
public JoinOptions(FileType fileType)
```

Initializes a new instance of the JoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### getType()
```
public final FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### LoadOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/loadoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ILoadOptions
```
public class LoadOptions implements ILoadOptions
```

Provides options for the document loading.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions(FileType fileType) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(String extension, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType) | Initializes new instance of LoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to load. |
| getExtension() | The extension of the file to init. |
| getPassword() | The password for opening password-protected file. |
| getEncoding() | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(String password, Charset encoding)
```
public LoadOptions(String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType fileType, String password)
```
public LoadOptions(FileType fileType, String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(FileType fileType, String password, Charset encoding)
```
public LoadOptions(FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(String extension, FileType fileType, String password, Charset encoding)
```
public LoadOptions(String extension, FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The extension of the file to load. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding)
```
public LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType iniFileType, FileType fileType, String password)
```
public LoadOptions(FileType iniFileType, FileType fileType, String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(FileType iniFileType, FileType fileType)
```
public LoadOptions(FileType iniFileType, FileType fileType)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |

##### getType()
```
public final FileType getType()
```

The type of the file to load.

**Returns:**
FileType
##### getExtension()
```
public final String getExtension()
```

The extension of the file to init.

**Returns:**
java.lang.String
##### getPassword()
```
public final String getPassword()
```

The password for opening password-protected file.

**Returns:**
java.lang.String
##### getEncoding()
```
public final Charset getEncoding()
```

The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is  System.Text.Encoding.Default (java.nio.charset.Charset).

**Returns:**
java.nio.charset.Charset

### MoveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/moveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IMoveOptions
```
public class MoveOptions implements IMoveOptions
```

Provides options for moving document page.
#### Constructors

| Constructor | Description |
| --- | --- |
| MoveOptions(int pageNumberToMove, int newPageNumber) | Initializes a new instance of the MoveOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumberToMove() | Gets or sets the page number to move. |
| getNewPageNumber() | Gets or sets the new page number. |
##### MoveOptions(int pageNumberToMove, int newPageNumber)
```
public MoveOptions(int pageNumberToMove, int newPageNumber)
```

Initializes a new instance of the MoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumberToMove | int | The page number to move. |
| newPageNumber | int | The new page number. |

##### getPageNumberToMove()
```
public final int getPageNumberToMove()
```

Gets or sets the page number to move.

Value: The page number to move.

**Returns:**
int
##### getNewPageNumber()
```
public final int getNewPageNumber()
```

Gets or sets the new page number.

Value: The new page number.

**Returns:**
int

### OleDiagramOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/olediagramoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleDiagramOptions
```
public class OleDiagramOptions extends ImportDocumentOptions implements IOleDiagramOptions
```

Provides options for import of the embedded document to Diagram via OLE.

[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
| OleDiagramOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
| OleDiagramOptions(String filePath, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setX(int value) | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getY() | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setY(int value) | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getWidth() | The width of the embedded object shape in inches. |
| setWidth(int value) | The width of the embedded object shape in inches. |
| getHeight() | The height of the embedded object shape in inches. |
| setHeight(int value) | The height of the embedded object shape in inches. |
| getImageData() | The image data of the embedded object. |
##### OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleDiagramOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleDiagramOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleDiagramOptions(String filePath, int pageNumber)
```
public OleDiagramOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getX()
```
public final int getX()
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getY()
```
public final int getY()
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

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

The width of the embedded object shape in inches.

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

The width of the embedded object shape in inches.

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

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

The height of the embedded object shape in inches.

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

The height of the embedded object shape in inches.

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

##### getImageData()
```
public final byte[] getImageData()
```

The image data of the embedded object.

**Returns:**
byte[]

### OlePresentationOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/olepresentationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOlePresentationOptions
```
public class OlePresentationOptions extends ImportDocumentOptions implements IOlePresentationOptions
```

Provides options for import of the embedded document to Presentation via OLE.

[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OlePresentationOptions(byte[] objectData, String extension, int pageNumber) | Initializes a new instance of the OlePresentationOptions class. |
| OlePresentationOptions(String filePath, int pageNumber) | Initializes a new instance of the OlePresentationOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object frame. |
| setX(int value) | The X coordinate of the embedded object frame. |
| getY() | The Y coordinate of the embedded object frame. |
| setY(int value) | The Y coordinate of the embedded object frame. |
| getWidth() | The width of the embedded object frame. |
| setWidth(int value) | The width of the embedded object frame. |
| getHeight() | The height of the embedded object frame. |
| setHeight(int value) | The height of the embedded object frame. |
##### OlePresentationOptions(byte[] objectData, String extension, int pageNumber)
```
public OlePresentationOptions(byte[] objectData, String extension, int pageNumber)
```

Initializes a new instance of the OlePresentationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OlePresentationOptions(String filePath, int pageNumber)
```
public OlePresentationOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OlePresentationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getX()
```
public final int getX()
```

The X coordinate of the embedded object frame.

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

The X coordinate of the embedded object frame.

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

##### getY()
```
public final int getY()
```

The Y coordinate of the embedded object frame.

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

The Y coordinate of the embedded object frame.

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

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

The width of the embedded object frame.

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

The width of the embedded object frame.

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

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

The height of the embedded object frame.

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

The height of the embedded object frame.

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

### OleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/olespreadsheetoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleSpreadsheetOptions
```
public class OleSpreadsheetOptions extends ImportDocumentOptions implements IOleSpreadsheetOptions
```

Provides options for import of the embedded document to Spreadsheet via OLE.

[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
| OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
| OleSpreadsheetOptions(String filePath, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getRowIndex() | The upper left row index. |
| setRowIndex(int value) | The upper left row index. |
| getColumnIndex() | The upper left column index. |
| setColumnIndex(int value) | The upper left column index. |
| getWidth() | The width of the Ole object image. |
| setWidth(int value) | The width of the Ole object image. |
| getHeight() | The height of the Ole object image. |
| setHeight(int value) | The height of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleSpreadsheetOptions(String filePath, int pageNumber)
```
public OleSpreadsheetOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getRowIndex()
```
public final int getRowIndex()
```

The upper left row index.

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

The upper left row index.

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

##### getColumnIndex()
```
public final int getColumnIndex()
```

The upper left column index.

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

The upper left column index.

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

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

The width of the Ole object image.

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

The width of the Ole object image.

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

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

The height of the Ole object image.

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

The height of the Ole object image.

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

##### getImageData()
```
public final byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### OleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/olewordprocessingoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleWordProcessingOptions
```
public class OleWordProcessingOptions extends ImportDocumentOptions implements IOleWordProcessingOptions
```

Provides options for import of the embedded document to Word processing via OLE.

[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
| OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
| OleWordProcessingOptions(String filePath, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | The left coordinate of the Ole object image. |
| setLeft(int value) | The left coordinate of the Ole object image. |
| getTop() | The top coordinate of the Ole object image. |
| setTop(int value) | The top coordinate of the Ole object image. |
| getWidth() | The width of the Ole object image. |
| setWidth(int value) | The width of the Ole object image. |
| getHeight() | The height of the Ole object image. |
| setHeight(int value) | The height of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleWordProcessingOptions(String filePath, int pageNumber)
```
public OleWordProcessingOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getLeft()
```
public final int getLeft()
```

The left coordinate of the Ole object image.

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

The left coordinate of the Ole object image.

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

##### getTop()
```
public final int getTop()
```

The top coordinate of the Ole object image.

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

The top coordinate of the Ole object image.

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

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

The width of the Ole object image.

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

The width of the Ole object image.

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

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

The height of the Ole object image.

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

The height of the Ole object image.

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

##### getImageData()
```
public final byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### OrientationMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/orientationmode.md

**Inheritance:**
java.lang.Object
```
public final class OrientationMode
```

Defines page orientation.
#### Fields

| Field | Description |
| --- | --- |
| Portrait | Portrait page mode. |
| Landscape | Landscape page mode. |
##### Portrait
```
public static final int Portrait
```

Portrait page mode.

##### Landscape
```
public static final int Landscape
```

Landscape page mode.

### OrientationOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/orientationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOrientationOptions
```
public class OrientationOptions extends PageOptions implements IOrientationOptions
```

Provides options for the page orientation.
#### Constructors

| Constructor | Description |
| --- | --- |
| OrientationOptions(int orientationMode) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int[] pageNumbers) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int startNumber, int endNumber) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the OrientationOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for the page orientation. |
##### OrientationOptions(int orientationMode)
```
public OrientationOptions(int orientationMode)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |

##### OrientationOptions(int orientationMode, int[] pageNumbers)
```
public OrientationOptions(int orientationMode, int[] pageNumbers)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| pageNumbers | int[] | Page numbers. |

##### OrientationOptions(int orientationMode, int startNumber, int endNumber)
```
public OrientationOptions(int orientationMode, int startNumber, int endNumber)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode)
```
public OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for the page orientation.

**Returns:**
int

### PageBuilderOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pagebuilderoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageBuilderOptions
```
public class PageBuilderOptions implements IPageBuilderOptions
```

Provides options for specifying the page builder.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageBuilderOptions() | Initializes a new instance of the PageBuilderOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadDocumentInfo() | Specifies if each document info should load all its pages info. |
| setLoadDocumentInfo(boolean value) | Specifies if each document info should load all its pages info. |
##### PageBuilderOptions()
```
public PageBuilderOptions()
```

Initializes a new instance of the PageBuilderOptions class.

##### getLoadDocumentInfo()
```
public final boolean getLoadDocumentInfo()
```

Specifies if each document info should load all its pages info.

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

Specifies if each document info should load all its pages info.

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

### PageJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pagejoinoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions
```
public class PageJoinOptions extends PageOptions implements IPageJoinOptions
```

Provides options for the document joining.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageJoinOptions() | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int[] pageNumbers) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int startNumber, int endNumber) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int[] pageNumbers) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int startNumber, int endNumber) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode) | Initializes a new instance of the PageJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### PageJoinOptions()
```
public PageJoinOptions()
```

Initializes a new instance of the PageJoinOptions class.

##### PageJoinOptions(int[] pageNumbers)
```
public PageJoinOptions(int[] pageNumbers)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### PageJoinOptions(int startNumber, int endNumber)
```
public PageJoinOptions(int startNumber, int endNumber)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PageJoinOptions(int startNumber, int endNumber, int mode)
```
public PageJoinOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### PageJoinOptions(FileType fileType)
```
public PageJoinOptions(FileType fileType)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### PageJoinOptions(FileType fileType, int[] pageNumbers)
```
public PageJoinOptions(FileType fileType, int[] pageNumbers)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | int[] | Page numbers. |

##### PageJoinOptions(FileType fileType, int startNumber, int endNumber)
```
public PageJoinOptions(FileType fileType, int startNumber, int endNumber)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```
public PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getType()
```
public final FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### PageOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pageoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public abstract class PageOptions implements IPageOptions
```

Provides options for specifying page or pages range.
#### Methods

| Method | Description |
| --- | --- |
| pages() | Get page numbers collection. |
##### pages()
```
public final int[] pages()
```

Get page numbers collection.

**Returns:**
int[]

### PdfAccessibilitySettings
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pdfaccessibilitysettings.md

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

Provides Pdf Accessibility settings for the document saving.
#### Constructors

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

| Method | Description |
| --- | --- |
| isEnableAutoTagging() |  |
| setEnableAutoTagging(boolean enableAutoTagging) |  |
##### PdfAccessibilitySettings()
```
public PdfAccessibilitySettings()
```

##### isEnableAutoTagging()
```
public boolean isEnableAutoTagging()
```

**Returns:**
boolean
##### setEnableAutoTagging(boolean enableAutoTagging)
```
public void setEnableAutoTagging(boolean enableAutoTagging)
```

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

### PdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pdfattachmentoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPdfAttachmentOptions
```
public class PdfAttachmentOptions extends ImportDocumentOptions implements IPdfAttachmentOptions
```

Provides options to attach the embedded object to Pdf.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfAttachmentOptions(byte[] objectData, String extension) | Initializes a new instance of the PdfAttachmentOptions class. |
| PdfAttachmentOptions(String filePath) | Initializes a new instance of the PdfAttachmentOptions class. |
##### PdfAttachmentOptions(byte[] objectData, String extension)
```
public PdfAttachmentOptions(byte[] objectData, String extension)
```

Initializes a new instance of the PdfAttachmentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |

##### PdfAttachmentOptions(String filePath)
```
public PdfAttachmentOptions(String filePath)
```

Initializes a new instance of the PdfAttachmentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |

### PdfSaveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/pdfsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.SaveOptions
```
public class PdfSaveOptions extends SaveOptions
```

Provides additional Pdf options for the document saving.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of the PdfSaveOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getAccessibilitySettings() |  |
| setAccessibilitySettings(PdfAccessibilitySettings accessibilitySettings) |  |
##### PdfSaveOptions()
```
public PdfSaveOptions()
```

Initializes a new instance of the PdfSaveOptions class.

##### getAccessibilitySettings()
```
public PdfAccessibilitySettings getAccessibilitySettings()
```

**Returns:**
PdfAccessibilitySettings
##### setAccessibilitySettings(PdfAccessibilitySettings accessibilitySettings)
```
public void setAccessibilitySettings(PdfAccessibilitySettings accessibilitySettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| accessibilitySettings | PdfAccessibilitySettings |  |

### PreviewMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/previewmode.md

**Inheritance:**
java.lang.Object
```
public final class PreviewMode
```

Provides modes for the page previewing.
#### Fields

| Field | Description |
| --- | --- |
| PNG | Preview mode as .png |
| JPEG | Preview mode as .jpeg |
| BMP | Preview mode as .bmp |
#### Methods

| Method | Description |
| --- | --- |
| extensions() |  |
##### PNG
```
public static final int PNG
```

Preview mode as .png

##### JPEG
```
public static final int JPEG
```

Preview mode as .jpeg

##### BMP
```
public static final int BMP
```

Preview mode as .bmp

##### extensions()
```
public static String[] extensions()
```

**Returns:**
java.lang.String[]

### PreviewOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/previewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPreviewOptions
```
public class PreviewOptions extends PageOptions implements IPreviewOptions
```

Represents document preview options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the PreviewOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Preview width. |
| setWidth(int value) | Preview width. |
| getHeight() | Preview height. |
| setHeight(int value) | Preview height. |
| getResolution() | Image resolution. |
| setResolution(int value) | Image resolution. |
| getMode() | Mode for preview. |
| validate(FileType fileType) | Validates the preview options. |
| getPathByPageNumber(int pageNumber, String extension) | Gets the full file path of previewed document by page number with defined extension. |
| getPageStreamFactory() | PageStreamFactory for create or release output page preview stream. |
##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| pageNumbers | int[] | Page numbers. |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

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

Preview width.

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

Preview width.

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

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

Preview height.

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

Preview height.

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

##### getResolution()
```
public final int getResolution()
```

Image resolution.

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

Image resolution.

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

##### getMode()
```
public final int getMode()
```

Mode for preview.

**Returns:**
int
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the preview options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

##### getPathByPageNumber(int pageNumber, String extension)
```
public final String getPathByPageNumber(int pageNumber, String extension)
```

Gets the full file path of previewed document by page number with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | Page number of preview. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getPageStreamFactory()
```
public PageStreamFactory getPageStreamFactory()
```

PageStreamFactory for create or release output page preview stream.

**Returns:**
PageStreamFactory

### RangeMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/rangemode.md

**Inheritance:**
java.lang.Object
```
public final class RangeMode
```

Possible modes for the page ranging.
#### Fields

| Field | Description |
| --- | --- |
| AllPages | Range have all numbers from begin to end. |
| OddPages | Range have only odd numbers from begin to end. |
| EvenPages | Range have only even numbers from begin to end. |
##### AllPages
```
public static final int AllPages
```

Range have all numbers from begin to end.

##### OddPages
```
public static final int OddPages
```

Range have only odd numbers from begin to end.

##### EvenPages
```
public static final int EvenPages
```

Range have only even numbers from begin to end.

### RemoveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/removeoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IRemoveOptions
```
public class RemoveOptions extends PageOptions implements IRemoveOptions
```

Provides options for the page removing.
#### Constructors

| Constructor | Description |
| --- | --- |
| RemoveOptions() | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int[] pageNumbers) | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int startNumber, int endNumber) | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the RemoveOptions class. |
##### RemoveOptions()
```
public RemoveOptions()
```

Initializes a new instance of the RemoveOptions class.

##### RemoveOptions(int[] pageNumbers)
```
public RemoveOptions(int[] pageNumbers)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### RemoveOptions(int startNumber, int endNumber)
```
public RemoveOptions(int startNumber, int endNumber)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### RemoveOptions(int startNumber, int endNumber, int mode)
```
public RemoveOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

### RotateMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/rotatemode.md

**Inheritance:**
java.lang.Object
```
public final class RotateMode
```

Possible modes for the page rotation.
#### Fields

| Field | Description |
| --- | --- |
| Rotate90 | Rotate to the right with 90 degrees. |
| Rotate180 | Rotate to the right with 180 degrees. |
| Rotate270 | Rotate to the right with 270 degrees. |
##### Rotate90
```
public static final int Rotate90
```

Rotate to the right with 90 degrees.

##### Rotate180
```
public static final int Rotate180
```

Rotate to the right with 180 degrees.

##### Rotate270
```
public static final int Rotate270
```

Rotate to the right with 270 degrees.

### RotateOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/rotateoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IRotateOptions
```
public class RotateOptions extends PageOptions implements IRotateOptions
```

Provides options for the page rotation.
#### Constructors

| Constructor | Description |
| --- | --- |
| RotateOptions(int rotateMode) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int[] pageNumbers) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int startNumber, int endNumber) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the RotateOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for rotating (90, 180 or 270 degrees). |
##### RotateOptions(int rotateMode)
```
public RotateOptions(int rotateMode)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |

##### RotateOptions(int rotateMode, int[] pageNumbers)
```
public RotateOptions(int rotateMode, int[] pageNumbers)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| pageNumbers | int[] | Page numbers. |

##### RotateOptions(int rotateMode, int startNumber, int endNumber)
```
public RotateOptions(int rotateMode, int startNumber, int endNumber)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### RotateOptions(int rotateMode, int startNumber, int endNumber, int mode)
```
public RotateOptions(int rotateMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for rotating (90, 180 or 270 degrees).

**Returns:**
int

### SaveOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/saveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISaveOptions
```
public class SaveOptions implements ISaveOptions
```

Provides options for the document saving.
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions(FileType fileType) | Initializes new instance of SaveOptions class. |
| SaveOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getType() | File type. |
| setType(FileType value) | File type. |
##### SaveOptions(FileType fileType)
```
public SaveOptions(FileType fileType)
```

Initializes new instance of SaveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |

##### SaveOptions()
```
public SaveOptions()
```

##### getType()
```
public final FileType getType()
```

File type.

**Returns:**
FileType
##### setType(FileType value)
```
public void setType(FileType value)
```

File type.

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

### SplitMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/splitmode.md

**Inheritance:**
java.lang.Object
```
public final class SplitMode
```

Defines page splitting modes.
#### Fields

| Field | Description |
| --- | --- |
| Pages | Split pages |
| Interval | Split Intervals |
##### Pages
```
public static final int Pages
```

Split pages

##### Interval
```
public static final int Interval
```

Split Intervals

### SplitOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/splitoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISplitOptions
```
public class SplitOptions extends PageOptions implements ISplitOptions
```

Provides options for the document page splitting.
#### Constructors

| Constructor | Description |
| --- | --- |
| SplitOptions(int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int[] pageNumbers) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for page splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with pre-defined extension. |
| getSplitStreamFactory() | SplitStreamFactory for create or release output page preview stream. |
##### SplitOptions(int[] pageNumbers, int splitMode)
```
public SplitOptions(int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(int splitMode, int startNumber, int endNumber)
```
public SplitOptions(int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### SplitOptions(String filePathFormat, int[] pageNumbers)
```
public SplitOptions(String filePathFormat, int[] pageNumbers)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| pageNumbers | int[] | Page numbers. |

##### SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)
```
public SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(String filePathFormat, int startNumber, int endNumber)
```
public SplitOptions(String filePathFormat, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)
```
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)
```
public SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | java.lang.Integer | The range mode. |

##### SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### SplitOptions(SplitStreamFactory splitStreamFactory)
```
public SplitOptions(SplitStreamFactory splitStreamFactory)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| pageNumbers | int[] | Page numbers. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | java.lang.Integer | The range mode. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for page splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public final String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with pre-defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public SplitStreamFactory getSplitStreamFactory()
```

SplitStreamFactory for create or release output page preview stream.

**Returns:**
SplitStreamFactory

### SwapOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/swapoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISwapOptions
```
public class SwapOptions implements ISwapOptions
```

Provides options for swapping document pages.
#### Constructors

| Constructor | Description |
| --- | --- |
| SwapOptions(int firstPageNumber, int secondPageNumber) | Initializes a new instance of the SwapOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFirstPageNumber() | First page number to exchange. |
| getSecondPageNumber() | Second page number to exchange. |
##### SwapOptions(int firstPageNumber, int secondPageNumber)
```
public SwapOptions(int firstPageNumber, int secondPageNumber)
```

Initializes a new instance of the SwapOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| firstPageNumber | int | The first page number. |
| secondPageNumber | int | The second page number. |

##### getFirstPageNumber()
```
public final int getFirstPageNumber()
```

First page number to exchange.

**Returns:**
int
##### getSecondPageNumber()
```
public final int getSecondPageNumber()
```

Second page number to exchange.

**Returns:**
int

### TextSplitMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/textsplitmode.md

**Inheritance:**
java.lang.Object
```
public final class TextSplitMode
```

Possible text splitting modes.
#### Fields

| Field | Description |
| --- | --- |
| Lines | Split lines |
| Interval | Split Intervals |
##### Lines
```
public static final int Lines
```

Split lines

##### Interval
```
public static final int Interval
```

Split Intervals

### TextSplitOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/textsplitoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ITextSplitOptions
```
public class TextSplitOptions implements ITextSplitOptions
```

Provides options for the document text splitting.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSplitOptions(int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(String filePathFormat, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Mode for text splitting. |
| getLineNumbers() | Line numbers for text splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | SplitStreamFactory for create or release output page preview stream. |
##### TextSplitOptions(int[] lineNumbers)
```
public TextSplitOptions(int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(int mode, int[] lineNumbers)
```
public TextSplitOptions(int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(String filePathFormat, int[] lineNumbers)
```
public TextSplitOptions(String filePathFormat, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already defined extension. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers)
```
public TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already defined extension. |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers)
```
public TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers)
```
public TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### getMode()
```
public final int getMode()
```

Mode for text splitting.

**Returns:**
int
##### getLineNumbers()
```
public final int[] getLineNumbers()
```

Line numbers for text splitting.

**Returns:**
int[]
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public final String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public SplitStreamFactory getSplitStreamFactory()
```

SplitStreamFactory for create or release output page preview stream.

**Returns:**
SplitStreamFactory

### UpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/updatepasswordoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IUpdatePasswordOptions
```
public class UpdatePasswordOptions implements IUpdatePasswordOptions
```

Provides options for updating document password.
#### Constructors

| Constructor | Description |
| --- | --- |
| UpdatePasswordOptions(String newPassword) | Initializes a new instance of the UpdatePasswordOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getNewPassword() | A new password for the document protection. |
##### UpdatePasswordOptions(String newPassword)
```
public UpdatePasswordOptions(String newPassword)
```

Initializes a new instance of the UpdatePasswordOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newPassword | java.lang.String | The new password. |

##### getNewPassword()
```
public final String getNewPassword()
```

A new password for the document protection.

**Returns:**
java.lang.String

### WordJoinCompliance
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/wordjoincompliance.md

**Inheritance:**
java.lang.Object
```
public final class WordJoinCompliance
```

Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc.
#### Fields

| Field | Description |
| --- | --- |
| Auto | Auto |
| Ecma376_2006 | ECMA-376 1st Edition, 2006. |
| Iso29500_2008_Transitional | ISO/IEC 29500:2008 Transitional compliance level. |
| Iso29500_2008_Strict | ISO/IEC 29500:2008 Strict compliance level. |
##### Auto
```
public static final int Auto
```

Auto

##### Ecma376_2006
```
public static final int Ecma376_2006
```

ECMA-376 1st Edition, 2006.

##### Iso29500_2008_Transitional
```
public static final int Iso29500_2008_Transitional
```

ISO/IEC 29500:2008 Transitional compliance level.

##### Iso29500_2008_Strict
```
public static final int Iso29500_2008_Strict
```

ISO/IEC 29500:2008 Strict compliance level.

### WordJoinMode
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/wordjoinmode.md

**Inheritance:**
java.lang.Object
```
public final class WordJoinMode
```

Possible modes for the Word joining.
#### Fields

| Field | Description |
| --- | --- |
| Default | Specifies Default Word joining. |
| Continuous | Specifies Word joining without starting from new page. |
##### Default
```
public static final int Default
```

Specifies Default Word joining.

##### Continuous
```
public static final int Continuous
```

Specifies Word joining without starting from new page.

### WordJoinOptions
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.options/wordjoinoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions, com.groupdocs.merger.domain.options.PageJoinOptions
```
public class WordJoinOptions extends PageJoinOptions
```

The Word join options.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordJoinOptions() | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int[] pageNumbers) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int startNumber, int endNumber) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int[] pageNumbers) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int startNumber, int endNumber) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode) | Initializes a new instance of the WordJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | The Word join mode. |
| setMode(int value) | The Word join mode. |
| getCompliance() | Compliance mode for the Word Ooxml format |
| setCompliance(int value) | Compliance mode for the Word Ooxml format |
##### WordJoinOptions()
```
public WordJoinOptions()
```

Initializes a new instance of the WordJoinOptions class.

##### WordJoinOptions(int[] pageNumbers)
```
public WordJoinOptions(int[] pageNumbers)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### WordJoinOptions(int startNumber, int endNumber)
```
public WordJoinOptions(int startNumber, int endNumber)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### WordJoinOptions(int startNumber, int endNumber, int mode)
```
public WordJoinOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### WordJoinOptions(FileType fileType)
```
public WordJoinOptions(FileType fileType)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### WordJoinOptions(FileType fileType, int[] pageNumbers)
```
public WordJoinOptions(FileType fileType, int[] pageNumbers)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | int[] | Page numbers. |

##### WordJoinOptions(FileType fileType, int startNumber, int endNumber)
```
public WordJoinOptions(FileType fileType, int startNumber, int endNumber)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```
public WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

The Word join mode.

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

The Word join mode.

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

##### getCompliance()
```
public final int getCompliance()
```

Compliance mode for the Word Ooxml format

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

Compliance mode for the Word Ooxml format

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

### com.groupdocs.merger.domain.result
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.result.md

The **com.groupdocs.merger.domain.result** namespace provides classes which represent document results.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Defines document description properties. |
| PageInfo | Defines page description properties. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Interface for the document description properties. |
| IPageInfo | Interface for the page description properties. |

### DocumentInfo
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.result/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.result.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Defines document description properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo(int index, InputStream stream, FileType fileType, String password) | Initializes new instance of DocumentInfo class. |
| DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size) | Initializes new instance of DocumentInfo class. |
| DocumentInfo(FileType fileType, IPageInfo[] pages, long size) | Initializes new instance of DocumentInfo class. |
#### Methods

| Method | Description |
| --- | --- |
| getIndex() | The document index. |
| getStream() | The document stream. |
| getPassword() | The document password. |
| getType() | Gets the file type. |
| getPages() | Defines document pages collection. |
| getPageCount() | The document pages count. |
| getSize() | Document size in bytes |
| toString() | Returns a string that represents the current object. |
##### DocumentInfo(int index, InputStream stream, FileType fileType, String password)
```
public DocumentInfo(int index, InputStream stream, FileType fileType, String password)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| stream | java.io.InputStream |  |
| fileType | FileType | The type of the file. |
| password | java.lang.String |  |

##### DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)
```
public DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| stream | java.io.InputStream |  |
| fileType | FileType | The type of the file. |
| password | java.lang.String |  |
| pages | IPageInfo\[\] | The list of pages to view. |
| size | long | The size of the file. |

##### DocumentInfo(FileType fileType, IPageInfo[] pages, long size)
```
public DocumentInfo(FileType fileType, IPageInfo[] pages, long size)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | IPageInfo\[\] | The list of pages to view. |
| size | long | The size of the file. |

##### getIndex()
```
public final int getIndex()
```

The document index.

**Returns:**
int
##### getStream()
```
public final InputStream getStream()
```

The document stream.

**Returns:**
java.io.InputStream
##### getPassword()
```
public final String getPassword()
```

The document password.

**Returns:**
java.lang.String
##### getType()
```
public final FileType getType()
```

Gets the file type.

**Returns:**
FileType
##### getPages()
```
public final IPageInfo[] getPages()
```

Defines document pages collection.

**Returns:**
com.groupdocs.merger.domain.result.IPageInfo[]
##### getPageCount()
```
public final int getPageCount()
```

The document pages count.

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Document size in bytes

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

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### IDocumentInfo
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.result/idocumentinfo.md

### IPageInfo
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.result/ipageinfo.md

### PageInfo
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.result/pageinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.result.IPageInfo
```
public class PageInfo implements IPageInfo
```

Defines page description properties.
#### Constructors

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

| Method | Description |
| --- | --- |
| getDocument() | Gets the document info. |
| setDocument(DocumentInfo value) | Gets the document info. |
| getNumber() | Gets the page number. |
| getVisible() | Indicates whether page is visibile or not. |
| getWidth() | Gets page width in pixels when converted to image. |
| getHeight() | Gets page height in pixels when converted to image. |
##### PageInfo(int number, boolean visible)
```
public PageInfo(int number, boolean visible)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The page visibility indicator. |

##### PageInfo(int number, boolean visible, int width, int height)
```
public PageInfo(int number, boolean visible, int width, int height)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The page visibility indicator. |
| width | int | The width of the page in pixels when viewing as JPG or PNG. |
| height | int | The height of the page in pixels when viewing as JPG or PNG. |

##### getDocument()
```
public final DocumentInfo getDocument()
```

Gets the document info.

**Returns:**
DocumentInfo
##### setDocument(DocumentInfo value)
```
public final void setDocument(DocumentInfo value)
```

Gets the document info.

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

##### getNumber()
```
public final int getNumber()
```

Gets the page number.

**Returns:**
int
##### getVisible()
```
public final boolean getVisible()
```

Indicates whether page is visibile or not.

**Returns:**
boolean
##### getWidth()
```
public final int getWidth()
```

Gets page width in pixels when converted to image.

**Returns:**
int
##### getHeight()
```
public final int getHeight()
```

Gets page height in pixels when converted to image.

**Returns:**
int

### com.groupdocs.merger.domain
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain.md

The **com.groupdocs.merger.domain** namespace provides classes for working with document structure.

#### Classes

| Class | Description |
| --- | --- |
| FileType | Represents file type. |

### FileType
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.domain/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Merger**, detect file type by extension etc.

[Full list of supported document formats]: https://docs.groupdocs.com/display/mergernet/Supported+Document+Types
[How to get supported file formats in code]: https://docs.groupdocs.com/display/mergernet/Get+supported+file+types
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| ZIP | Zipped File (.zip) |
| SevenZ | 7-Zip Compressed File (.7z) |
| TAR | Consolidated Unix File Archive (.tar) |
| RAR | Roshal ARchive Compressed File (.rar) |
| VSSX | Visio Stencil File (.vssx) are drawing stencils created with Microsoft Visio 2013 and above. |
| VSDX | Visio Drawing (.vsdx) represents Microsoft Visio file format introduced from Microsoft Office 2013 onwards. |
| VSDM | Visio Macro-Enabled Drawing (.vsdm) are drawing files created with Microsoft Visio application that supports macros. |
| VSTX | Visio Drawing Template (.vstx) are drawing template files created with Microsoft Visio 2013 and above. |
| VSTM | Visio Macro-Enabled Drawing Template (.vstm) are template files created with Microsoft Visio that support macros. |
| VSSM | Visio Macro-Enabled Stencil File (.vssm) are Microsoft Visio Stencil files that support provide support for macros. |
| VSX | Visio Stencil XML File (.vsx) refers to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. |
| VTX | Visio Template XML File (.vtx) is a Microsoft Visio drawing template that is saved to disc in XML file format. |
| VDX | Visio Drawing XML File (.vdx)is a drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. |
| EPUB | Open eBook File (.epub) are an e-book file format that provide a standard digital publication format for publishers and consumers. |
| BMP | Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. |
| JPG | JPEG Image (.jpg) |
| JPEG | JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. |
| PNG | Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. |
| PS | PostScript File (.ps) |
| TIF | Tagged Image File (.tif) |
| TIFF | Tagged Image File Format (.tiff) |
| GIF | Graphical Interchange Format File (.gif) |
| SVG | Scalable Vector Graphics File (.svg) |
| SVGZ | Scalable Vector Graphics Compressed File (.svgz) |
| EMF | Windows Enhanced Metafile (.emf) |
| EMZ | Windows Compressed Enhanced Metafile (.emz) |
| HTML | Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. |
| MHT | MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. |
| MHTML | MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. |
| ONE | OneNote Document (.one) files are created by Microsoft OneNote application. |
| PDF | Portable Document Format File (.pdf) isa file format that was to introduced as 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. |
| XPS | XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. |
| TEX | LaTeX Source Document (.tex) is a language that comprises of programming as well as mark-up features, used to typeset documents. |
| PPT | PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | PowerPoint Open XML Presentation (.pptx) is a presentation file created with popular Microsoft PowerPoint application. |
| PPS | PowerPoint Slide Show (.pps) is a file created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. |
| OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. |
| PPTM | PowerPoint Open XML Macro-Enabled Presentation |
| XLS | Excel Spreadsheet (.xls) is a file that can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. |
| XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. |
| XLSB | Excel Binary Spreadsheet (.xlsb) file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. |
| TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. |
| ODS | OpenDocument Spreadsheet (.ods). |
| XLTM | Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| XLTX | Excel Open XML Spreadsheet Template (.xltx) files are based on the Office OpenXML file format specifications. |
| XLT | Excel Template File (.xlt) are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. |
| XLAM | Excel Macro-Enabled Add-In (.xlam). |
| DOC | Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. |
| DOCM | Word Open XML Macro-Enabled Document (.docm) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| DOT | Word Document Template (.dot) files are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. |
| DOTX | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. |
| RTF | Rich Text Format File (.rtf) introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. |
| TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines. |
| ERR | Error Log File (.err) is a text file that contains error messages generated by a program. |
| ODT | OpenDocument Text Document (.odt) files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| OTT | OpenDocument Document Template (.ott) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. |
| 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 |
| --- | --- |
| getFileFormat() | File type name e.g. |
| getExtension() | Filename suffix (including the period ".") e.g. |
| fromExtension(String extension) | Maps file extension to file type. |
| getSupportedFileTypes() | Retrieves supported file types |
| equals(FileType other) | Determines whether the current FileType is the same as specified FileType object. |
| equals(Object obj) | Determines whether the current FileType is the same as specified object. |
| hashCode() | Returns the hash code for the current FileType object. |
| op_Equality(FileType left, FileType right) | Determines whether two FileType objects are the same. |
| op_Inequality(FileType left, FileType right) | Determines whether two FileType objects are not the same. |
| toString() | Returns a string that represents the current object. |
| isText(FileType fileType) | Determines whether input FileType is primitive text format. |
| isArchive(FileType fileType) | Determines whether input FileType is archive format. |
| isImage(FileType fileType) | Determines whether input FileType is primitive text format. |
| isAudio(FileType fileType) | Determines whether input FileType is audio format. |
| getBase(FileType fileType) |  |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### ZIP
```
public static FileType ZIP
```

Zipped File (.zip)

##### SevenZ
```
public static final FileType SevenZ
```

7-Zip Compressed File (.7z)

##### TAR
```
public static final FileType TAR
```

Consolidated Unix File Archive (.tar)

##### RAR
```
public static final FileType RAR
```

Roshal ARchive Compressed File (.rar)

##### VSSX
```
public static final FileType VSSX
```

Visio Stencil File (.vssx) 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://docs.fileformat.com/image/vssx

##### VSDX
```
public static final FileType VSDX
```

Visio Drawing (.vsdx) represents 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://docs.fileformat.com/image/vsdx

##### VSDM
```
public static final FileType VSDM
```

Visio Macro-Enabled Drawing (.vsdm) 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://docs.fileformat.com/image/vsdm

##### VSTX
```
public static final FileType VSTX
```

Visio Drawing Template (.vstx) 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://docs.fileformat.com/image/vstx

##### VSTM
```
public static final FileType VSTM
```

Visio Macro-Enabled Drawing Template (.vstm) 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://docs.fileformat.com/image/vstm

##### VSSM
```
public static final FileType VSSM
```

Visio Macro-Enabled Stencil File (.vssm) 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://docs.fileformat.com/image/vssm

##### VSX
```
public static final FileType VSX
```

Visio Stencil XML File (.vsx) refers 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://docs.fileformat.com/image/vsx

##### VTX
```
public static final FileType VTX
```

Visio Template XML File (.vtx) 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://docs.fileformat.com/image/vtx

##### VDX
```
public static final FileType VDX
```

Visio Drawing XML File (.vdx)is a 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://docs.fileformat.com/image/vdx

##### EPUB
```
public static final FileType EPUB
```

Open eBook File (.epub) 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://docs.fileformat.com/ebook/epub

##### BMP
```
public static final FileType BMP
```

Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/bmp

##### JPG
```
public static final FileType JPG
```

JPEG Image (.jpg)

##### JPEG
```
public static final FileType JPEG
```

JPEG Image (.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://docs.fileformat.com/image/jpeg

##### PNG
```
public static final FileType PNG
```

Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/png

##### PS
```
public static final FileType PS
```

PostScript File (.ps)

##### TIF
```
public static FileType TIF
```

Tagged Image File (.tif)

##### TIFF
```
public static FileType TIFF
```

Tagged Image File Format (.tiff)

##### GIF
```
public static FileType GIF
```

Graphical Interchange Format File (.gif)

##### SVG
```
public static FileType SVG
```

Scalable Vector Graphics File (.svg)

##### SVGZ
```
public static FileType SVGZ
```

Scalable Vector Graphics Compressed File (.svgz)

##### EMF
```
public static final FileType EMF
```

Windows Enhanced Metafile (.emf)

##### EMZ
```
public static final FileType EMZ
```

Windows Compressed Enhanced Metafile (.emz)

##### HTML
```
public static final FileType HTML
```

Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/html

##### MHT
```
public static final FileType MHT
```

MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/mhtml

##### MHTML
```
public static final FileType MHTML
```

MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/mhtml

##### ONE
```
public static final FileType ONE
```

OneNote Document (.one) files 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://docs.fileformat.com/note-taking/one

##### PDF
```
public static final FileType PDF
```

Portable Document Format File (.pdf) isa file format that was to introduced as 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/view/pdf

##### XPS
```
public static final FileType XPS
```

XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/page-description-language/xps

##### TEX
```
public static final FileType TEX
```

LaTeX Source Document (.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://docs.fileformat.com/page-description-language/tex

##### PPT
```
public static final FileType PPT
```

PowerPoint Presentation (.ppt) 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://docs.fileformat.com/presentation/ppt

##### PPTX
```
public static final FileType PPTX
```

PowerPoint Open XML Presentation (.pptx) is a presentation file 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://docs.fileformat.com/presentation/pptx

##### PPS
```
public static final FileType PPS
```

PowerPoint Slide Show (.pps) is a file 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://docs.fileformat.com/presentation/pps

##### PPSX
```
public static final FileType PPSX
```

PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/ppsx

##### ODP
```
public static final FileType ODP
```

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/odp

##### OTP
```
public static final FileType OTP
```

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/otp

##### PPTM
```
public static FileType PPTM
```

PowerPoint Open XML Macro-Enabled Presentation

##### XLS
```
public static final FileType XLS
```

Excel Spreadsheet (.xls) is a file that 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://docs.fileformat.com/spreadsheet/xls

##### XLSX
```
public static final FileType XLSX
```

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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://docs.fileformat.com/spreadsheet/xlsx

##### XLSM
```
public static final FileType XLSM
```

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/xlsm

##### XLSB
```
public static final FileType XLSB
```

Excel Binary Spreadsheet (.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://docs.fileformat.com/spreadsheet/xlsb

##### CSV
```
public static final FileType CSV
```

Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/csv

##### TSV
```
public static final FileType TSV
```

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/tsv

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet (.ods).

##### XLTM
```
public static final FileType XLTM
```

Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) 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://docs.fileformat.com/spreadsheet/xltm

##### XLTX
```
public static final FileType XLTX
```

Excel Open XML Spreadsheet Template (.xltx) files 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://docs.fileformat.com/spreadsheet/xltx

##### XLT
```
public static final FileType XLT
```

Excel Template File (.xlt) 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://docs.fileformat.com/spreadsheet/xlt

##### XLAM
```
public static final FileType XLAM
```

Excel Macro-Enabled Add-In (.xlam).

##### DOC
```
public static final FileType DOC
```

Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/doc

##### DOCX
```
public static final FileType DOCX
```

Microsoft Word Open XML Document (.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://docs.fileformat.com/word-processing/docx

##### DOCM
```
public static final FileType DOCM
```

Word Open XML 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://docs.fileformat.com/word-processing/docm

##### DOT
```
public static final FileType DOT
```

Word Document Template (.dot) files 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://docs.fileformat.com/word-processing/dot

##### DOTX
```
public static final FileType DOTX
```

Word Open XML Document 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://docs.fileformat.com/word-processing/dotx

##### DOTM
```
public static final FileType DOTM
```

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/dotm

##### RTF
```
public static final FileType RTF
```

Rich Text Format File (.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://docs.fileformat.com/word-processing/rtf

##### TXT
```
public static final FileType TXT
```

Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/txt

##### ERR
```
public static final FileType ERR
```

Error Log File (.err) is a text file that contains error messages generated by a program. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/err

##### ODT
```
public static final FileType ODT
```

OpenDocument 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://docs.fileformat.com/word-processing/odt

##### OTT
```
public static final FileType OTT
```

OpenDocument 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://docs.fileformat.com/word-processing/ott

##### WAV
```
public static FileType 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. The format doesn\\u2019t apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. It has been and is one of the standard format for audio CDs. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/audio/wav

##### getFileFormat()
```
public final String getFileFormat()
```

File type name e.g. "Microsoft Word Document".

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

Filename suffix (including the period ".") e.g. ".doc".

**Returns:**
java.lang.String
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period "."). |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default \#Unknown.Unknown file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.util.List<com.groupdocs.merger.domain.FileType> - Returns sequence of supported file types
##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current FileType is the same as specified FileType object.

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

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.merger.domain/filetype) objects are the same; otherwise,

```
false
```
### equals(Object obj) {#equals-java.lang.Object-}
```
public boolean equals(Object obj)
```


Determines whether the current [FileType](../../com.groupdocs.merger.domain/filetype) is the same as specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if

```
obj
```

parameter is FileType and is the same as current FileType object; otherwise,

```
false
```
##### hashCode()
```
public int hashCode()
```

Returns the hash code for the current FileType object.

**Returns:**
int - A hash code for the current FileType object.
##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two FileType objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object. |
| right | FileType | Right FileType object. |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.merger.domain/filetype) objects are the same; otherwise,

```
false
```
### op_Inequality(FileType left, FileType right) {#op-Inequality-com.groupdocs.merger.domain.FileType-com.groupdocs.merger.domain.FileType-}
```
public static boolean op_Inequality(FileType left, FileType right)
```


Determines whether two [FileType](../../com.groupdocs.merger.domain/filetype) objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | [FileType](../../com.groupdocs.merger.domain/filetype) | Left [FileType](../../com.groupdocs.merger.domain/filetype) object. |
| right | [FileType](../../com.groupdocs.merger.domain/filetype) | Right [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if both FileType objects are not the same; otherwise,

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

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.
##### isText(FileType fileType)
```
public static boolean isText(FileType fileType)
```

Determines whether input FileType is primitive text format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The FileType object. |

**Returns:**
boolean - ```
true
```

if input [FileType](../../com.groupdocs.merger.domain/filetype) is primitive text format; otherwise,

```
false
```
### isArchive(FileType fileType) {#isArchive-com.groupdocs.merger.domain.FileType-}
```
public static boolean isArchive(FileType fileType)
```


Determines whether input [FileType](../../com.groupdocs.merger.domain/filetype) is archive format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | [FileType](../../com.groupdocs.merger.domain/filetype) | The [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if input FileType is archive format; otherwise,

```
false
```
##### isImage(FileType fileType)
```
public static boolean isImage(FileType fileType)
```

Determines whether input FileType is primitive text format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The FileType object. |

**Returns:**
boolean - ```
true
```

if input [FileType](../../com.groupdocs.merger.domain/filetype) is primitive image format; otherwise,

```
false
```
### isAudio(FileType fileType) {#isAudio-com.groupdocs.merger.domain.FileType-}
```
public static boolean isAudio(FileType fileType)
```


Determines whether input [FileType](../../com.groupdocs.merger.domain/filetype) is audio format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | [FileType](../../com.groupdocs.merger.domain/filetype) | The [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if input FileType is audio format; otherwise,

```
false
```
##### getBase(FileType fileType)
```
public static FileType getBase(FileType fileType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType |  |

**Returns:**
FileType

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

The **com.groupdocs.merger.exceptions** namespace provides classes for exceptions which can occur while working with a document.

#### Classes

| Class | Description |
| --- | --- |
| FileCorruptedException | The exception that is thrown when specified file could not be loaded because it appears to be corrupted. |
| FileTypeNotSupportedException | The exception that is thrown when specified file type is not supported. |
| GroupDocsMergerException | Represents errors that occur during document processing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

### FileCorruptedException
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.exceptions/filecorruptedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class FileCorruptedException extends GroupDocsMergerException
```

The exception that is thrown when specified file could not be loaded because it appears to be corrupted.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCorruptedException(String guid) | Initializes a new instance of the FileCorruptedException class. |
##### FileCorruptedException(String guid)
```
public FileCorruptedException(String guid)
```

Initializes a new instance of the FileCorruptedException class.

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

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

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class FileTypeNotSupportedException extends Exception
```

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

| Constructor | Description |
| --- | --- |
| FileTypeNotSupportedException(String message) | 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. |

### GroupDocsMergerException
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.exceptions/groupdocsmergerexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class GroupDocsMergerException extends Exception
```

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

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

| Method | Description |
| --- | --- |
| getException(Exception exception) | Get the GroupDocs Merger exception from input exception. |
##### GroupDocsMergerException(String message)
```
public GroupDocsMergerException(String message)
```

Initializes a new instance of the GroupDocsMergerException class.

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

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

Initializes a new instance of the GroupDocsMergerException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| innerException | java.lang.Exception | The inner exception of the error.    |

##### getException(Exception exception)
```
public static Exception getException(Exception exception)
```

Get the GroupDocs Merger exception from input exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| exception | java.lang.Exception | The input exception. |

**Returns:**
java.lang.Exception -

### IncorrectPasswordException
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.exceptions/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class IncorrectPasswordException extends GroupDocsMergerException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException(String guid) | Initializes a new instance of the IncorrectPasswordException class. |
##### IncorrectPasswordException(String guid)
```
public IncorrectPasswordException(String guid)
```

Initializes a new instance of the IncorrectPasswordException class.

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

### PasswordRequiredException
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.exceptions/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class PasswordRequiredException extends GroupDocsMergerException
```

The exception that is thrown when password is required to load the document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException(String guid) | Initializes a new instance of the PasswordRequiredException class. |
##### PasswordRequiredException(String guid)
```
public PasswordRequiredException(String guid)
```

Initializes a new instance of the PasswordRequiredException class.

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

### com.groupdocs.merger.licensing.metered
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.licensing.metered.md

The **com.groupdocs.merger.licensing.metered** namespace provides methods to set metered key.

#### Classes

| Class | Description |
| --- | --- |
| Metered | Provides methods for applying [Metered][] license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered |

### Metered
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.licensing.metered/metered.md

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

Provides methods for applying [Metered][] license.

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
#### 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 amount of used credits |
##### 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 amount of used credits

> ```
> 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 usedCredits = Metered.GetConsumptionCredit();
> ```

**Returns:**
java.math.BigDecimal

### com.groupdocs.merger.licensing
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.licensing.md

The **com.groupdocs.merger.licensing** namespace provides methods to license the component.

#### Classes

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

### License
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.licensing/license.md

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

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

[here]: https://purchase.groupdocs.com/faqs/licensing
#### 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 (FileStream licenseStream = new FileStream("LicenseFile.lic", FileMode.Open))
>  {
>      GroupDocs.Merger.License lic = new GroupDocs.Merger.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.Merger.lic";
>  GroupDocs.Merger.License lic = new GroupDocs.Merger.License();
>  lic.SetLicense(licensePath);
> ```

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

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

The **com.groupdocs.merger.logging** namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the console. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

### ConsoleLogger
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.logging.ILogger
```
public class ConsoleLogger implements ILogger
```

Writes log messages to the console.
#### Constructors

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

| Method | Description |
| --- | --- |
| trace(String message) | Writes trace message to the console. |
| warning(String message) | Writes warning message to the console. |
| error(String message, Exception exception) | Writes error message to the console. |
##### ConsoleLogger()
```
public ConsoleLogger()
```

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console. 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 final void warning(String message)
```

Writes warning message to the console. 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 final void error(String message, Exception exception)
```

Writes error message to the console. 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/merger/java/com.groupdocs.merger.logging/ilogger.md

### com.groupdocs.merger
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger.md

The **com.groupdocs.merger** namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others..

#### Classes

| Class | Description |
| --- | --- |
| Merger | Represents the main class that controls the document merging process. |
| MergerSettings | Defines settings for customizing Merger behaviour. |

### Merger
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger/merger.md

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

Represents the main class that controls the document merging process.
#### Constructors

| Constructor | Description |
| --- | --- |
| Merger(InputStream document) | Initializes new instance of Merger class. |
| Merger(InputStream document, ILoadOptions loadOptions) | Initializes new instance of Merger class. |
| Merger(InputStream document, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(String filePath) | Initializes new instance of Merger class. |
| Merger(String filePath, ILoadOptions loadOptions) | Initializes new instance of Merger class. |
| Merger(String filePath, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings) | Initializes new instance of Merger class. |
#### Methods

| Method | Description |
| --- | --- |
| dispose() | Disposes resources. |
| importDocument(IImportDocumentOptions importDocumentOptions) | Imports the document as attachment or embedded via Ole. |
| join(InputStream document) | Joins the documents into one single document. |
| join(InputStream document, IJoinOptions joinOptions) | Joins the documents into one single document. |
| join(InputStream document, IPageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(InputStream document, IImageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath) | Joins the documents into one single document. |
| join(String filePath, IJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath, IPageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath, IImageJoinOptions joinOptions) | Joins the documents into one single document. |
| createPageBuilder() | Creates a new Page builder with predefined document collection. |
| createPageBuilder(PageBuilderOptions pageBuilderOptions) | Creates a new Page builder with predefined document collection. |
| applyPageBuilder(PageBuilder pageBuilder) | Applies page builder changes. |
| split(ISplitOptions splitOptions) | Splits the single document to the multiple documents. |
| split(ITextSplitOptions splitOptions) | Splits the single document to the multiple documents. |
| extractPages(IExtractOptions extractOptions) | Makes a new document with some pages from the source document. |
| addPassword(IAddPasswordOptions addPasswordOptions) | Protects document with password. |
| isPasswordSet() | Checks whether document is password protected. |
| removePassword() | Removes password from document. |
| updatePassword(IUpdatePasswordOptions updatePasswordOptions) | Updates existing password for document. |
| changeOrientation(IOrientationOptions orientationOptions) | Applies a new orientation mode for the specified pages. |
| movePage(IMoveOptions moveOptions) | Moves page to a new position within document of known format. |
| removePages(IRemoveOptions removeOptions) | Removes pages from document of known format. |
| swapPages(ISwapOptions swapOptions) | Swaps two pages within document of known format. |
| rotatePages(IRotateOptions rotateOptions) | Rotate pages of the document. |
| getDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| generatePreview(IPreviewOptions previewOptions) | Generates document pages preview. |
| save(OutputStream document) | Saves the result document to the stream  document . |
| save(OutputStream document, ISaveOptions saveOptions) | Saves the result document to the stream  document . |
| save(String filePath) | Saves the result document file to  filePath . |
| save(String filePath, boolean useDefaultDirectory) | Saves the result document file to  filePath . |
| save(String filePath, ISaveOptions saveOptions) | Saves the result document file to  filePath . |
| save(String filePath, OutputStream inputStream) | Saves the result document file to  filePath . |
##### Merger(InputStream document)
```
public Merger(InputStream document)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |

##### Merger(InputStream document, ILoadOptions loadOptions)
```
public Merger(InputStream document, ILoadOptions loadOptions)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |

##### Merger(InputStream document, MergerSettings settings)
```
public Merger(InputStream document, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| settings | MergerSettings | The Merger settings. |

##### Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings)
```
public Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### Merger(String filePath)
```
public Merger(String filePath)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |

##### Merger(String filePath, ILoadOptions loadOptions)
```
public Merger(String filePath, ILoadOptions loadOptions)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| loadOptions | ILoadOptions | The document load options. |

##### Merger(String filePath, MergerSettings settings)
```
public Merger(String filePath, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| settings | MergerSettings | The Merger settings. |

##### Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings)
```
public Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### dispose()
```
public final void dispose()
```

Disposes resources.

##### importDocument(IImportDocumentOptions importDocumentOptions)
```
public final void importDocument(IImportDocumentOptions importDocumentOptions)
```

Imports the document as attachment or embedded via Ole.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| importDocumentOptions | IImportDocumentOptions | The embedded document import options.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/ |

##### join(InputStream document)
```
public final void join(InputStream document)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(InputStream document, IJoinOptions joinOptions)
```
public final void join(InputStream document, IJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | IJoinOptions | The join options.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(InputStream document, IPageJoinOptions joinOptions)
```
public final void join(InputStream document, IPageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | IPageJoinOptions | The join options.

##### join(InputStream document, IImageJoinOptions joinOptions)
```
public final void join(InputStream document, IImageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | IImageJoinOptions | The image join options.

##### join(String filePath)
```
public final void join(String filePath)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(String filePath, IJoinOptions joinOptions)
```
public final void join(String filePath, IJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | IJoinOptions | The join options.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(String filePath, IPageJoinOptions joinOptions)
```
public final void join(String filePath, IPageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | IPageJoinOptions | The join options.

##### join(String filePath, IImageJoinOptions joinOptions)
```
public final void join(String filePath, IImageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | IImageJoinOptions | The image join options.

##### createPageBuilder()
```
public final PageBuilder createPageBuilder()
```

Creates a new Page builder with predefined document collection.

**Returns:**
PageBuilder - The created page builder.
##### createPageBuilder(PageBuilderOptions pageBuilderOptions)
```
public final PageBuilder createPageBuilder(PageBuilderOptions pageBuilderOptions)
```

Creates a new Page builder with predefined document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageBuilderOptions | PageBuilderOptions |  |

**Returns:**
PageBuilder - The created page builder.
##### applyPageBuilder(PageBuilder pageBuilder)
```
public final void applyPageBuilder(PageBuilder pageBuilder)
```

Applies page builder changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageBuilder | PageBuilder | The page builder. |

##### split(ISplitOptions splitOptions)
```
public final void split(ISplitOptions splitOptions)
```

Splits the single document to the multiple documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ISplitOptions | The page split options.

[How to split PDF_ Word_ Excel and PowerPoint documents in 3 lines of code]: https://docs.groupdocs.com/merger/java/split-document/
[Split text files guide]: https://docs.groupdocs.com/merger/java/split-text-file/ |

##### split(ITextSplitOptions splitOptions)
```
public final void split(ITextSplitOptions splitOptions)
```

Splits the single document to the multiple documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ITextSplitOptions | The text split options.

[How to split PDF_ Word_ Excel and PowerPoint documents in 3 lines of code]: https://docs.groupdocs.com/merger/java/split-document/
[Split text files guide]: https://docs.groupdocs.com/merger/java/split-text-file/ |

##### extractPages(IExtractOptions extractOptions)
```
public final void extractPages(IExtractOptions extractOptions)
```

Makes a new document with some pages from the source document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractOptions | IExtractOptions | The page options.

[How to extract pages from PDF_ Word_ Excel and PowerPoint documents]: https://docs.groupdocs.com/merger/java/extract-pages/ |

##### addPassword(IAddPasswordOptions addPasswordOptions)
```
public final void addPassword(IAddPasswordOptions addPasswordOptions)
```

Protects document with password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| addPasswordOptions | IAddPasswordOptions | The options for specifying the password.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/ |

##### isPasswordSet()
```
public final boolean isPasswordSet()
```

Checks whether document is password protected.

**Returns:**
boolean - Returns a value indicating whether document is protected or not.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/
##### removePassword()
```
public final void removePassword()
```

Removes password from document.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/

##### updatePassword(IUpdatePasswordOptions updatePasswordOptions)
```
public final void updatePassword(IUpdatePasswordOptions updatePasswordOptions)
```

Updates existing password for document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updatePasswordOptions | IUpdatePasswordOptions | The options for specifying the current/new passwords.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/ |

##### changeOrientation(IOrientationOptions orientationOptions)
```
public final void changeOrientation(IOrientationOptions orientationOptions)
```

Applies a new orientation mode for the specified pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationOptions | IOrientationOptions | The change orientation options.

[How to change Microsoft Word document pages orientation]: https://docs.groupdocs.com/merger/java/change-page-orientation/ |

##### movePage(IMoveOptions moveOptions)
```
public final void movePage(IMoveOptions moveOptions)
```

Moves page to a new position within document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| moveOptions | IMoveOptions | The move options.

[How to move PDF_ Word_ Excel and PowerPoint document pages]: https://docs.groupdocs.com/merger/java/move-page/ |

##### removePages(IRemoveOptions removeOptions)
```
public final void removePages(IRemoveOptions removeOptions)
```

Removes pages from document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeOptions | IRemoveOptions | The options for the numbers of pages to be removed.

[How to remove page from PDF_ Word_ Excel or PowerPoint document]: https://docs.groupdocs.com/merger/java/remove-pages/ |

##### swapPages(ISwapOptions swapOptions)
```
public final void swapPages(ISwapOptions swapOptions)
```

Swaps two pages within document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| swapOptions | ISwapOptions | The swap options.

[How to swap pages inside PDF_ Word_ Excel or PowerPoint document]: https://docs.groupdocs.com/merger/java/swap-pages/ |

##### rotatePages(IRotateOptions rotateOptions)
```
public final void rotatePages(IRotateOptions rotateOptions)
```

Rotate pages of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateOptions | IRotateOptions | The options for the page rotating.

[How to rotate PDF document pages]: https://docs.groupdocs.com/merger/java/rotate-pages/ |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

**Returns:**
IDocumentInfo - Information about document properties.

[How to get document info using GroupDocs.Merger]: https://docs.groupdocs.com/merger/java/get-document-information/
##### generatePreview(IPreviewOptions previewOptions)
```
public final void generatePreview(IPreviewOptions previewOptions)
```

Generates document pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | IPreviewOptions | The preview options.

[How to generate document pages preview using GroupDocs.Merger]: https://docs.groupdocs.com/merger/java/generate-document-pages-preview/ |

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves the result document to the stream  document .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The document stream. |

##### save(OutputStream document, ISaveOptions saveOptions)
```
public void save(OutputStream document, ISaveOptions saveOptions)
```

Saves the result document to the stream  document .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The document stream. |
| saveOptions | ISaveOptions | The options for saving. |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or full file path. |

##### save(String filePath, boolean useDefaultDirectory)
```
public final void save(String filePath, boolean useDefaultDirectory)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path or name in case of default directory usage. |
| useDefaultDirectory | boolean | Use the default directory from settings. |

##### save(String filePath, ISaveOptions saveOptions)
```
public void save(String filePath, ISaveOptions saveOptions)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path or name in case of default directory usage. |
| saveOptions | ISaveOptions | The options for saving. |

##### save(String filePath, OutputStream inputStream)
```
public void save(String filePath, OutputStream inputStream)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path or name in case of default directory usage. |
| inputStream | java.io.OutputStream | The document stream. |

### MergerSettings
Path: https://reference.groupdocs.com/merger/java/com.groupdocs.merger/mergersettings.md

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

Defines settings for customizing Merger behaviour.
#### Constructors

| Constructor | Description |
| --- | --- |
| MergerSettings() | Initializes new instance of MergerSettings class. |
| MergerSettings(ILogger logger) | Initializes new instance of MergerSettings class. |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | The logger implementation used for tracking document processing workflow. |
| setLogger(ILogger value) | The logger implementation used for tracking document processing workflow. |
##### MergerSettings()
```
public MergerSettings()
```

Initializes new instance of MergerSettings class.

##### MergerSettings(ILogger logger)
```
public MergerSettings(ILogger logger)
```

Initializes new instance of MergerSettings class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | The logger implementation. |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for tracking document processing workflow.

**Returns:**
ILogger
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

The logger implementation used for tracking document processing workflow.

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

## .NET

### GroupDocs.Merger for .NET
Path: https://reference.groupdocs.com/merger/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Merger | The namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others. |
| GroupDocs.Merger.Domain | The namespace provides classes for working with document structure. |
| GroupDocs.Merger.Domain.Builders | The namespace provides builders. |
| GroupDocs.Merger.Domain.Common | The namespace provides common delegates. |
| GroupDocs.Merger.Domain.Options | The namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents. |
| GroupDocs.Merger.Domain.Result | The namespace provides classes which represent document results. |
| GroupDocs.Merger.Exceptions | The namespace provides different classes for exceptions. |
| GroupDocs.Merger.Logging | The namespace provides classes for customizing logging behaviour. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### GroupDocs.Merger.Domain.Builders
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders.md

The namespace provides builders.

#### Classes

| Class | Description |
| --- | --- |
| PageBuilder | PageInfo builder for getting the page collection from the documents. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### PageBuilder
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder.md

#### PageBuilder class

PageInfo builder for getting the page collection from the documents.

```csharp
public class PageBuilder
```

#### Constructors

| Name | Description |
| --- | --- |
| PageBuilder() | Initializes a new instance of the `PageBuilder` class. |
| PageBuilder(PageBuilderOptions) | Initializes a new instance of the `PageBuilder` class. |

#### Properties

| Name | Description |
| --- | --- |
| Documents { get; } | The document collection. |
| Options { get; } | The page builder options. |
| Pages { get; } | The page collection. |

#### Methods

| Name | Description |
| --- | --- |
| AddPage(IPageInfo) | Add page to the page collection. |
| AddPage(int, int) | Add page to the page collection. |
| AddPageRange(IPageInfo[]) | Add pages to the page collection. |
| Clear() | Clear the internal collections. |

### AddPage
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/addpage.md

#### AddPage(int, int)

Add page to the page collection.

```csharp
public void AddPage(int documentIndex, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentIndex | Int32 | DocumentInfo index. |
| pageNumber | Int32 | PageInfo number. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMergerException |  |

#### AddPage(IPageInfo)

Add page to the page collection.

```csharp
public void AddPage(IPageInfo page)
```

| Parameter | Type | Description |
| --- | --- | --- |
| page | IPageInfo | PageInfo instance. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMergerException |  |

### AddPageRange
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/addpagerange.md

#### PageBuilder.AddPageRange method

Add pages to the page collection.

```csharp
public void AddPageRange(IPageInfo[] pages)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pages | IPageInfo[] | Pages array. |

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsMergerException |  |

### Clear
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/clear.md

#### PageBuilder.Clear method

Clear the internal collections.

```csharp
public void Clear()
```

### Documents
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/documents.md

#### PageBuilder.Documents property

The document collection.

```csharp
public ReadOnlyDictionary<int, DocumentInfo> Documents { get; }
```

### Options
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/options.md

#### PageBuilder.Options property

The page builder options.

```csharp
public PageBuilderOptions Options { get; }
```

### PageBuilder
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/pagebuilder.md

#### PageBuilder()

Initializes a new instance of the `PageBuilder` class.

```csharp
public PageBuilder()
```

#### PageBuilder(PageBuilderOptions)

Initializes a new instance of the `PageBuilder` class.

```csharp
public PageBuilder(PageBuilderOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PageBuilderOptions | The page builder options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.builders/pagebuilder/pages.md

#### PageBuilder.Pages property

The page collection.

```csharp
public ReadOnlyCollection<PageInfo> Pages { get; }
```

### GroupDocs.Merger.Domain.Common
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common.md

The namespace provides common delegates.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Delegate that defines method to create output page preview stream. |
| CreateSplitStream | Delegate that defines method to create output split stream. |
| Func&lt;TResult&gt; | Encapsulates a method that has no parameters and returns a value of the type specified by the *TResult* parameter. |
| Func&lt;T,TResult&gt; | Encapsulates a method that has one parameter and returns a value of the type specified by the *TResult* parameter. |
| Func&lt;T1,T2,TResult&gt; | Encapsulates a method that has two parameters and returns a value of the type specified by the *TResult* parameter. |
| Func&lt;T1,T2,T3,TResult&gt; | Encapsulates a method that has three parameters and returns a value of the type specified by the *TResult* parameter. |
| Func&lt;T1,T2,T3,T4,TResult&gt; | Encapsulates a method that has four parameters and returns a value of the type specified by the *TResult* parameter. |
| ReleasePageStream | Delegate that defines method to release output page preview stream. |
| ReleaseSplitStream | Delegate that defines method to release output split stream. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### CreatePageStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/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. |

### CreateSplitStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/createsplitstream.md

#### CreateSplitStream delegate

Delegate that defines method to create output split stream.

```csharp
public delegate Stream CreateSplitStream(int number);
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page or line number that is used for the document splitting. |

### FuncTResult
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/func-1.md

#### Func&lt;TResult&gt; delegate

Encapsulates a method that has no parameters and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<out TResult>();
```

| Parameter | Description |
| --- | --- |
| TResult | The type of the return value of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### FuncTTResult
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/func-2.md

#### Func&lt;T,TResult&gt; delegate

Encapsulates a method that has one parameter and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<in T, out TResult>(T arg);
```

| Parameter | Description |
| --- | --- |
| T | The type of the parameter of the method that this delegate encapsulates. |
| TResult | The type of the return value of the method that this delegate encapsulates. |
| arg | The parameter of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### FuncT1T2TResult
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/func-3.md

#### Func&lt;T1,T2,TResult&gt; delegate

Encapsulates a method that has two parameters and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<in T1, in T2, out TResult>(T1 arg1, T2 arg2);
```

| Parameter | Description |
| --- | --- |
| T1 | The type of first parameters of the method that this delegate encapsulates. |
| T2 | The type of the second parameter of the method that this delegate encapsulates. |
| TResult | The type of the return value of the method that this delegate encapsulates. |
| arg1 | The first parameter of the method that this delegate encapsulates. |
| arg2 | The second parameter of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### FuncT1T2T3TResult
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/func-4.md

#### Func&lt;T1,T2,T3,TResult&gt; delegate

Encapsulates a method that has three parameters and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<in T1, in T2, in T3, out TResult>(T1 arg1, T2 arg2, T3 arg3);
```

| Parameter | Description |
| --- | --- |
| T1 | The type of the first parameter of the method that this delegate encapsulates. |
| T2 | The type of the second parameter of the method that this delegate encapsulates. |
| T3 | The type of the third parameter of the method that this delegate encapsulates. |
| TResult | The type of the return value of the method that this delegate encapsulates. |
| arg1 | The first parameter of the method that this delegate encapsulates. |
| arg2 | The second parameter of the method that this delegate encapsulates. |
| arg3 | The third parameter of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### FuncT1T2T3T4TResult
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/func-5.md

#### Func&lt;T1,T2,T3,T4,TResult&gt; delegate

Encapsulates a method that has four parameters and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<in T1, in T2, in T3, in T4, out TResult>(T1 arg1, T2 arg2, T3 arg3, 
    T4 arg4);
```

| Parameter | Description |
| --- | --- |
| T1 | The type of the first parameter of the method that this delegate encapsulates. |
| T2 | The type of the second parameter of the method that this delegate encapsulates. |
| T3 | The type of the third parameter of the method that this delegate encapsulates. |
| T4 | The type of the fourth parameter of the method that this delegate encapsulates. |
| TResult | The type of the return value of the method that this delegate encapsulates. |
| arg1 | The first parameter of the method that this delegate encapsulates. |
| arg2 | The second parameter of the method that this delegate encapsulates. |
| arg3 | The third parameter of the method that this delegate encapsulates. |
| arg4 | The fourth parameter of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### ReleasePageStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/releasepagestream.md

#### ReleasePageStream delegate

Delegate that defines method to release output page preview stream.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream createPageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number. |
| createPageStream | Stream | The stream created by *createPageStream* method. |

### ReleaseSplitStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.common/releasesplitstream.md

#### ReleaseSplitStream delegate

Delegate that defines method to release output split stream.

```csharp
public delegate void ReleaseSplitStream(int number, Stream createSplitStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page or line number that is used for the document splitting. |
| createSplitStream | Stream | The stream created by *createSplitStream* method. |

### GroupDocs.Merger.Domain.Options
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options.md

The namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| AddPasswordOptions | Provides options for adding document password. |
| ExtractOptions | Provides options to extract the document pages. |
| ImageJoinOptions | The image join options. |
| ImportDocumentOptions | Provides options for the embedded document import. |
| JoinOptions | Provides options for the document joining. |
| LoadOptions | Provides options for the document loading. |
| MoveOptions | Provides options for moving document page. |
| OleDiagramOptions | Provides options for import of the embedded document to Diagram via OLE. |
| OlePresentationOptions | Provides options for import of the embedded document to Presentation via OLE. |
| OleSpreadsheetOptions | Provides options for import of the embedded document to Spreadsheet via OLE. |
| OleWordProcessingOptions | Provides options for import of the embedded document to Word processing via OLE. |
| OrientationOptions | Provides options for the page orientation. |
| PageBuilderOptions | Provides options for specifying the page builder. |
| PageJoinOptions | Provides options for the document joining. |
| PageOptions | Provides options for specifying page or pages range. |
| PdfAccesibilitySettings | Provides Pdf Accesibility settings for the document saving. |
| PdfAttachmentOptions | Provides options to attach the embedded object to Pdf. |
| PdfJoinOptions | The Pdf join options. |
| PdfSaveOptions | Provides additional Pdf options for the document saving. |
| PdfSecurityOptions | Contains the PDF document security options. |
| PreviewOptions | Represents document preview options. |
| RemoveOptions | Provides options for the page removing. |
| RotateOptions | Provides options for the page rotation. |
| SaveOptions | Provides options for the document saving. |
| SplitOptions | Provides options for the document page splitting. |
| SwapOptions | Provides options for swapping document pages. |
| TextSplitOptions | Provides options for the document text splitting. |
| UpdatePasswordOptions | Provides options for updating document password. |
| WordJoinOptions | The Word join options. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IAddPasswordOptions | Interface for the password adding options. |
| IExtractOptions | Interface for options to extract the document pages. |
| IImageJoinOptions | Interface for the image joining options. |
| IImportDocumentOptions | Interface for import of the embedded document. |
| IJoinOptions | Interface for the document joining options. |
| ILoadOptions | Interface for the document loading options. |
| IMoveOptions | Interface for the moving page options. |
| IOleDiagramOptions | Interface for import options of the embedded document to Diagram via OLE. |
| IOlePresentationOptions | Interface for import options of the embedded document to Presentation via OLE. |
| IOleSpreadsheetOptions | Interface for import options of the embedded document to Spreadsheet via OLE. |
| IOleWordProcessingOptions | Interface for import options of the embedded document to Word processing via OLE. |
| IOptions | Interface for the base options. |
| IOrientationOptions | Interface for the page orientation options. |
| IPageBuilderOptions | Interface for the page builder options |
| IPageJoinOptions | Interface for the document page joining options. |
| IPageOptions | Interface for the page options |
| IPager | Interface for apply option (pages, range and etc.) |
| IPdfAttachmentOptions | Interface for options of the embedded document to PDF as attachment. |
| IPreviewOptions | Interface for the preview options. |
| IRemoveOptions | Interface for the page removing options. |
| IRotateOptions | Interface for the page rotating options. |
| ISaveOptions | Interface for the document saving options. |
| ISizeOptions | Interface for adding embedded object. |
| ISplitOptions | Interface for the page splitting options. |
| ISwapOptions | Interface for the page swapping options. |
| ITextSplitOptions | Interface for the text splitting options. |
| IUpdatePasswordOptions | Interface for the password updating options. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ImageJoinMode | Possible modes for the image joining. |
| OrientationMode | Defines page orientation. |
| PdfSecurityPermissions | Defines PDF document permissions. |
| PreviewMode | Provides modes for the page previewing. |
| RangeMode | Possible modes for the page ranging. |
| RotateMode | Possible modes for the page rotation. |
| SplitMode | Defines page splitting modes. |
| TextSplitMode | Possible text splitting modes. |
| WordJoinCompliance | Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc. |
| WordJoinMode | Possible modes for the Word joining. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### AddPasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/addpasswordoptions.md

#### AddPasswordOptions class

Provides options for adding document password.

```csharp
public class AddPasswordOptions : IAddPasswordOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| AddPasswordOptions(string) | Initializes a new instance of the `AddPasswordOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; } | The password for document protection. |

### AddPasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/addpasswordoptions/addpasswordoptions.md

#### AddPasswordOptions constructor

Initializes a new instance of the `AddPasswordOptions` class.

```csharp
public AddPasswordOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password. |

### Password
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/addpasswordoptions/password.md

#### AddPasswordOptions.Password property

The password for document protection.

```csharp
public string Password { get; }
```

### ExtractOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/extractoptions.md

#### ExtractOptions class

Provides options to extract the document pages.

```csharp
public class ExtractOptions : PageOptions, IExtractOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExtractOptions() | Initializes a new instance of the `ExtractOptions` class. |
| ExtractOptions(int[]) | Initializes a new instance of the `ExtractOptions` class. |
| ExtractOptions(int, int) | Initializes a new instance of the `ExtractOptions` class. |
| ExtractOptions(int, int, RangeMode) | Initializes a new instance of the `ExtractOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Get page numbers collection. |

### ExtractOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/extractoptions/extractoptions.md

#### ExtractOptions()

Initializes a new instance of the `ExtractOptions` class.

```csharp
public ExtractOptions()
```

#### ExtractOptions(int[])

Initializes a new instance of the `ExtractOptions` class.

```csharp
public ExtractOptions(int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | Int32[] | Page numbers. |

#### ExtractOptions(int, int)

Initializes a new instance of the `ExtractOptions` class.

```csharp
public ExtractOptions(int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### ExtractOptions(int, int, RangeMode)

Initializes a new instance of the `ExtractOptions` class.

```csharp
public ExtractOptions(int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### IAddPasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iaddpasswordoptions.md

#### IAddPasswordOptions interface

Interface for the password adding options.

```csharp
public interface IAddPasswordOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Password { get; } | The password for document protection. |

### Password
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iaddpasswordoptions/password.md

#### IAddPasswordOptions.Password property

The password for document protection.

```csharp
public string Password { get; }
```

### IExtractOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iextractoptions.md

#### IExtractOptions interface

Interface for options to extract the document pages.

```csharp
public interface IExtractOptions : IPageOptions
```

### IImageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimagejoinoptions.md

#### IImageJoinOptions interface

Interface for the image joining options.

```csharp
public interface IImageJoinOptions : IJoinOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | The image join mode. |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimagejoinoptions/mode.md

#### IImageJoinOptions.Mode property

The image join mode.

```csharp
public ImageJoinMode Mode { get; }
```

### IImportDocumentOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimportdocumentoptions.md

#### IImportDocumentOptions interface

Interface for import of the embedded document.

```csharp
public interface IImportDocumentOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |

### Extension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimportdocumentoptions/extension.md

#### IImportDocumentOptions.Extension property

The extension of the embedded object.

```csharp
public string Extension { get; }
```

### ObjectData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimportdocumentoptions/objectdata.md

#### IImportDocumentOptions.ObjectData property

The data of the embedded object.

```csharp
public byte[] ObjectData { get; }
```

### PageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iimportdocumentoptions/pagenumber.md

#### IImportDocumentOptions.PageNumber property

The page number for inserting of the embedded object.

```csharp
public int PageNumber { get; }
```

### IJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ijoinoptions.md

#### IJoinOptions interface

Interface for the document joining options.

```csharp
public interface IJoinOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Type { get; } | The type of the file to join. |

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ijoinoptions/type.md

#### IJoinOptions.Type property

The type of the file to join.

```csharp
public FileType Type { get; }
```

### ILoadOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iloadoptions.md

#### ILoadOptions interface

Interface for the document loading options.

```csharp
public interface ILoadOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; } | The encoding used when opening text-based files such as `CSV` or `TXT`. Default value is Default. |
| Extension { get; } | The extension of the file to open. |
| Password { get; } | The password for opening password-protected file. |
| Type { get; } | The type of the file to open. |

### Encoding
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iloadoptions/encoding.md

#### ILoadOptions.Encoding property

The encoding used when opening text-based files such as `CSV` or `TXT`. Default value is Default.

```csharp
public Encoding Encoding { get; }
```

### Extension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iloadoptions/extension.md

#### ILoadOptions.Extension property

The extension of the file to open.

```csharp
public string Extension { get; }
```

### Password
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iloadoptions/password.md

#### ILoadOptions.Password property

The password for opening password-protected file.

```csharp
public string Password { get; }
```

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iloadoptions/type.md

#### ILoadOptions.Type property

The type of the file to open.

```csharp
public FileType Type { get; }
```

### ImageJoinMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imagejoinmode.md

#### ImageJoinMode enumeration

Possible modes for the image joining.

```csharp
public enum ImageJoinMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Horizontal | `0` | Specifies Horizontal image joining. |
| Vertical | `1` | Specifies Vertical image joining. |

### ImageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imagejoinoptions.md

#### ImageJoinOptions class

The image join options.

```csharp
public class ImageJoinOptions : IImageJoinOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageJoinOptions() | Initializes new instance of `ImageJoinOptions` class. |
| ImageJoinOptions(FileType) | Initializes new instance of `ImageJoinOptions` class. |
| ImageJoinOptions(ImageJoinMode) | Initializes new instance of `ImageJoinOptions` class. |
| ImageJoinOptions(FileType, ImageJoinMode) | Initializes new instance of `ImageJoinOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | The image join mode. |
| Type { get; } | The image file type. |

### ImageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imagejoinoptions/imagejoinoptions.md

#### ImageJoinOptions()

Initializes new instance of `ImageJoinOptions` class.

```csharp
public ImageJoinOptions()
```

#### ImageJoinOptions(FileType)

Initializes new instance of `ImageJoinOptions` class.

```csharp
public ImageJoinOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |

#### ImageJoinOptions(ImageJoinMode)

Initializes new instance of `ImageJoinOptions` class.

```csharp
public ImageJoinOptions(ImageJoinMode imageJoinMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageJoinMode | ImageJoinMode | The image join mode. |

#### ImageJoinOptions(FileType, ImageJoinMode)

Initializes new instance of `ImageJoinOptions` class.

```csharp
public ImageJoinOptions(FileType fileType, ImageJoinMode imageJoinMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |
| imageJoinMode | ImageJoinMode | The image join mode. |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imagejoinoptions/mode.md

#### ImageJoinOptions.Mode property

The image join mode.

```csharp
public ImageJoinMode Mode { get; }
```

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imagejoinoptions/type.md

#### ImageJoinOptions.Type property

The image file type.

```csharp
public FileType Type { get; }
```

### IMoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imoveoptions.md

#### IMoveOptions interface

Interface for the moving page options.

```csharp
public interface IMoveOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| NewPageNumber { get; } | Gets or sets the new page number. |
| PageNumberToMove { get; } | Gets or sets the page number to move. |

### NewPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imoveoptions/newpagenumber.md

#### IMoveOptions.NewPageNumber property

Gets or sets the new page number.

```csharp
public int NewPageNumber { get; }
```

##### Property Value

The new page number.

### PageNumberToMove
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/imoveoptions/pagenumbertomove.md

#### IMoveOptions.PageNumberToMove property

Gets or sets the page number to move.

```csharp
public int PageNumberToMove { get; }
```

##### Property Value

The page number to move.

### ImportDocumentOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/importdocumentoptions.md

#### ImportDocumentOptions class

Provides options for the embedded document import.

```csharp
public abstract class ImportDocumentOptions : IImportDocumentOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |

### Extension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/importdocumentoptions/extension.md

#### ImportDocumentOptions.Extension property

The extension of the embedded object.

```csharp
public string Extension { get; }
```

### ObjectData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/importdocumentoptions/objectdata.md

#### ImportDocumentOptions.ObjectData property

The data of the embedded object.

```csharp
public byte[] ObjectData { get; }
```

### PageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/importdocumentoptions/pagenumber.md

#### ImportDocumentOptions.PageNumber property

The page number for inserting of the embedded object.

```csharp
public int PageNumber { get; }
```

### IOleDiagramOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolediagramoptions.md

#### IOleDiagramOptions interface

Interface for import options of the embedded document to Diagram via OLE.

```csharp
public interface IOleDiagramOptions : IImportDocumentOptions, ISizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ImageData { get; } | The image data of the embedded object. |
| X { get; set; } | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| Y { get; set; } | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolediagramoptions/imagedata.md

#### IOleDiagramOptions.ImageData property

The image data of the embedded object.

```csharp
public byte[] ImageData { get; }
```

### X
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolediagramoptions/x.md

#### IOleDiagramOptions.X property

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

```csharp
public int X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolediagramoptions/y.md

#### IOleDiagramOptions.Y property

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

```csharp
public int Y { get; set; }
```

### IOlePresentationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolepresentationoptions.md

#### IOlePresentationOptions interface

Interface for import options of the embedded document to Presentation via OLE.

```csharp
public interface IOlePresentationOptions : IImportDocumentOptions, ISizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| X { get; set; } | The X coordinate of the embedded object frame. |
| Y { get; set; } | The Y coordinate of the embedded object frame. |

### X
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolepresentationoptions/x.md

#### IOlePresentationOptions.X property

The X coordinate of the embedded object frame.

```csharp
public int X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolepresentationoptions/y.md

#### IOlePresentationOptions.Y property

The Y coordinate of the embedded object frame.

```csharp
public int Y { get; set; }
```

### IOleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolespreadsheetoptions.md

#### IOleSpreadsheetOptions interface

Interface for import options of the embedded document to Spreadsheet via OLE.

```csharp
public interface IOleSpreadsheetOptions : IImportDocumentOptions, ISizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ColumnIndex { get; set; } | The upper left column index. |
| ImageData { get; } | The data of the Ole object image. |
| RowIndex { get; set; } | The upper left row index. |

### ColumnIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolespreadsheetoptions/columnindex.md

#### IOleSpreadsheetOptions.ColumnIndex property

The upper left column index.

```csharp
public int ColumnIndex { get; set; }
```

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolespreadsheetoptions/imagedata.md

#### IOleSpreadsheetOptions.ImageData property

The data of the Ole object image.

```csharp
public byte[] ImageData { get; }
```

### RowIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolespreadsheetoptions/rowindex.md

#### IOleSpreadsheetOptions.RowIndex property

The upper left row index.

```csharp
public int RowIndex { get; set; }
```

### IOleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolewordprocessingoptions.md

#### IOleWordProcessingOptions interface

Interface for import options of the embedded document to Word processing via OLE.

```csharp
public interface IOleWordProcessingOptions : IImportDocumentOptions, ISizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ImageData { get; } | The data of the Ole object image. |
| Left { get; set; } | The left coordinate of the Ole object image. |
| Top { get; set; } | The top coordinate of the Ole object image. |

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolewordprocessingoptions/imagedata.md

#### IOleWordProcessingOptions.ImageData property

The data of the Ole object image.

```csharp
public byte[] ImageData { get; }
```

### Left
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolewordprocessingoptions/left.md

#### IOleWordProcessingOptions.Left property

The left coordinate of the Ole object image.

```csharp
public int Left { get; set; }
```

### Top
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iolewordprocessingoptions/top.md

#### IOleWordProcessingOptions.Top property

The top coordinate of the Ole object image.

```csharp
public int Top { get; set; }
```

### IOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ioptions.md

#### IOptions interface

Interface for the base options.

```csharp
public interface IOptions
```

### IOrientationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iorientationoptions.md

#### IOrientationOptions interface

Interface for the page orientation options.

```csharp
public interface IOrientationOptions : IPageOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | Gets the mode for the page orientation. |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iorientationoptions/mode.md

#### IOrientationOptions.Mode property

Gets the mode for the page orientation.

```csharp
public OrientationMode Mode { get; }
```

### IPageBuilderOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipagebuilderoptions.md

#### IPageBuilderOptions interface

Interface for the page builder options

```csharp
public interface IPageBuilderOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| LoadDocumentInfo { get; set; } | Specifies if each document info should load all its pages info. |

### LoadDocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipagebuilderoptions/loaddocumentinfo.md

#### IPageBuilderOptions.LoadDocumentInfo property

Specifies if each document info should load all its pages info.

```csharp
public bool LoadDocumentInfo { get; set; }
```

### IPageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipagejoinoptions.md

#### IPageJoinOptions interface

Interface for the document page joining options.

```csharp
public interface IPageJoinOptions : IJoinOptions, IPageOptions
```

### IPageOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipageoptions.md

#### IPageOptions interface

Interface for the page options

```csharp
public interface IPageOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Page numbers for the page options. |

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipageoptions/pages.md

#### IPageOptions.Pages property

Page numbers for the page options.

```csharp
public int[] Pages { get; }
```

### IPager
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipager.md

#### IPager interface

Interface for apply option (pages, range and etc.)

```csharp
public interface IPager
```

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | List of page number on which operation will be applied. Note: first page have number 1. |

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipager/pages.md

#### IPager.Pages property

List of page number on which operation will be applied. Note: first page have number 1.

```csharp
public int[] Pages { get; }
```

### IPdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipdfattachmentoptions.md

#### IPdfAttachmentOptions interface

Interface for options of the embedded document to PDF as attachment.

```csharp
public interface IPdfAttachmentOptions : IImportDocumentOptions
```

### IPreviewOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions.md

#### IPreviewOptions interface

Interface for the preview options.

```csharp
public interface IPreviewOptions : IPageOptions
```

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output page preview stream. |
| Height { get; set; } | Preview height. |
| Mode { get; } | Gets the mode for preview. |
| ReleaseStream { get; } | Delegate that defines method to release output page preview stream. |
| Resolution { get; set; } | Image resolution. |
| Width { get; set; } | Preview width. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByPageNumber(int, string) | Gets the full file path of previewed document by page number with defined extension. |
| Validate(FileType) | Validates the split options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/createstream.md

#### IPreviewOptions.CreateStream property

Delegate that defines method to create output page preview stream.

```csharp
public CreatePageStream CreateStream { get; }
```

### GetPathByPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/getpathbypagenumber.md

#### IPreviewOptions.GetPathByPageNumber method

Gets the full file path of previewed document by page number with defined extension.

```csharp
public string GetPathByPageNumber(int pageNumber, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Page number of preview. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/height.md

#### IPreviewOptions.Height property

Preview height.

```csharp
public int Height { get; set; }
```

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/mode.md

#### IPreviewOptions.Mode property

Gets the mode for preview.

```csharp
public PreviewMode Mode { get; }
```

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/releasestream.md

#### IPreviewOptions.ReleaseStream property

Delegate that defines method to release output page preview stream.

```csharp
public ReleasePageStream ReleaseStream { get; }
```

### Resolution
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/resolution.md

#### IPreviewOptions.Resolution property

Image resolution.

```csharp
public int Resolution { get; set; }
```

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/validate.md

#### IPreviewOptions.Validate method

Validates the split options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of `FileType` class. |

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/ipreviewoptions/width.md

#### IPreviewOptions.Width property

Preview width.

```csharp
public int Width { get; set; }
```

### IRemoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iremoveoptions.md

#### IRemoveOptions interface

Interface for the page removing options.

```csharp
public interface IRemoveOptions : IPageOptions
```

### IRotateOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/irotateoptions.md

#### IRotateOptions interface

Interface for the page rotating options.

```csharp
public interface IRotateOptions : IPageOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | Gets the mode for rotating (90, 180 or 270 degrees). |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/irotateoptions/mode.md

#### IRotateOptions.Mode property

Gets the mode for rotating (90, 180 or 270 degrees).

```csharp
public RotateMode Mode { get; }
```

### ISaveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isaveoptions.md

#### ISaveOptions interface

Interface for the document saving options.

```csharp
public interface ISaveOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Type { get; } | File type. |

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isaveoptions/type.md

#### ISaveOptions.Type property

File type.

```csharp
public FileType Type { get; }
```

### ISizeOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isizeoptions.md

#### ISizeOptions interface

Interface for adding embedded object.

```csharp
public interface ISizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the embedded object size. |
| Width { get; set; } | The width of the embedded object size. |

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isizeoptions/height.md

#### ISizeOptions.Height property

The height of the embedded object size.

```csharp
public int Height { get; set; }
```

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isizeoptions/width.md

#### ISizeOptions.Width property

The width of the embedded object size.

```csharp
public int Width { get; set; }
```

### ISplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions.md

#### ISplitOptions interface

Interface for the page splitting options.

```csharp
public interface ISplitOptions : IPageOptions
```

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output split stream. |
| Mode { get; } | Gets the mode for page splitting. |
| ReleaseStream { get; } | Delegate that defines method to release output split stream. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByIndex(int, string) | Gets the full file path of splitted document by index with defined extension. |
| Validate(FileType) | Validates the split options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions/createstream.md

#### ISplitOptions.CreateStream property

Delegate that defines method to create output split stream.

```csharp
public CreateSplitStream CreateStream { get; }
```

### GetPathByIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions/getpathbyindex.md

#### ISplitOptions.GetPathByIndex method

Gets the full file path of splitted document by index with defined extension.

```csharp
public string GetPathByIndex(int index, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | Index of splitted document. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions/mode.md

#### ISplitOptions.Mode property

Gets the mode for page splitting.

```csharp
public SplitMode Mode { get; }
```

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions/releasestream.md

#### ISplitOptions.ReleaseStream property

Delegate that defines method to release output split stream.

```csharp
public ReleaseSplitStream ReleaseStream { get; }
```

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/isplitoptions/validate.md

#### ISplitOptions.Validate method

Validates the split options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of `FileType` class. |

### ISwapOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iswapoptions.md

#### ISwapOptions interface

Interface for the page swapping options.

```csharp
public interface ISwapOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| FirstPageNumber { get; } | First page number to exchange. |
| SecondPageNumber { get; } | Second page number to exchange. |

### FirstPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iswapoptions/firstpagenumber.md

#### ISwapOptions.FirstPageNumber property

First page number to exchange.

```csharp
public int FirstPageNumber { get; }
```

### SecondPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iswapoptions/secondpagenumber.md

#### ISwapOptions.SecondPageNumber property

Second page number to exchange.

```csharp
public int SecondPageNumber { get; }
```

### ITextSplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions.md

#### ITextSplitOptions interface

Interface for the text splitting options.

```csharp
public interface ITextSplitOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output split stream. |
| LineNumbers { get; } | Line numbers for text splitting. |
| Mode { get; } | Mode for text splitting. |
| ReleaseStream { get; } | Delegate that defines method to release output split stream. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByIndex(int, string) | Gets the full file path of splitted document by index with defined extension. |
| Validate(FileType) | Validates the split options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/createstream.md

#### ITextSplitOptions.CreateStream property

Delegate that defines method to create output split stream.

```csharp
public CreateSplitStream CreateStream { get; }
```

### GetPathByIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/getpathbyindex.md

#### ITextSplitOptions.GetPathByIndex method

Gets the full file path of splitted document by index with defined extension.

```csharp
public string GetPathByIndex(int index, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | Index of splitted document. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### LineNumbers
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/linenumbers.md

#### ITextSplitOptions.LineNumbers property

Line numbers for text splitting.

```csharp
public int[] LineNumbers { get; }
```

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/mode.md

#### ITextSplitOptions.Mode property

Mode for text splitting.

```csharp
public TextSplitMode Mode { get; }
```

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/releasestream.md

#### ITextSplitOptions.ReleaseStream property

Delegate that defines method to release output split stream.

```csharp
public ReleaseSplitStream ReleaseStream { get; }
```

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/itextsplitoptions/validate.md

#### ITextSplitOptions.Validate method

Validates the split options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of `FileType` class. |

### IUpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iupdatepasswordoptions.md

#### IUpdatePasswordOptions interface

Interface for the password updating options.

```csharp
public interface IUpdatePasswordOptions : IOptions
```

#### Properties

| Name | Description |
| --- | --- |
| NewPassword { get; } | The new password for document protection. |

### NewPassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/iupdatepasswordoptions/newpassword.md

#### IUpdatePasswordOptions.NewPassword property

The new password for document protection.

```csharp
public string NewPassword { get; }
```

### JoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/joinoptions.md

#### JoinOptions class

Provides options for the document joining.

```csharp
public class JoinOptions : IJoinOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JoinOptions() | Initializes a new instance of the `JoinOptions` class. |
| JoinOptions(FileType) | Initializes a new instance of the `JoinOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Type { get; } | The type of the file to join. |

### JoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/joinoptions/joinoptions.md

#### JoinOptions()

Initializes a new instance of the `JoinOptions` class.

```csharp
public JoinOptions()
```

#### JoinOptions(FileType)

Initializes a new instance of the `JoinOptions` class.

```csharp
public JoinOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/joinoptions/type.md

#### JoinOptions.Type property

The type of the file to join.

```csharp
public FileType Type { get; }
```

### LoadOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions.md

#### LoadOptions class

Provides options for the document loading.

```csharp
public class LoadOptions : ILoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions(FileType) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(string) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(FileType, FileType) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(FileType, string) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(string, Encoding) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(FileType, FileType, string) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(FileType, string, Encoding) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(FileType, FileType, string, Encoding) | Initializes new instance of `LoadOptions` class. |
| LoadOptions(string, FileType, string, Encoding) | Initializes new instance of `LoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; } | The encoding used when opening text-based files such as `CSV` or `TXT`. Default value is Default. |
| Extension { get; } | The extension of the file to init. |
| Password { get; } | The password for opening password-protected file. |
| Type { get; } | The type of the file to load. |

### Encoding
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions/encoding.md

#### LoadOptions.Encoding property

The encoding used when opening text-based files such as `CSV` or `TXT`. Default value is Default.

```csharp
public Encoding Encoding { get; }
```

### Extension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions/extension.md

#### LoadOptions.Extension property

The extension of the file to init.

```csharp
public string Extension { get; }
```

### LoadOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions/loadoptions.md

#### LoadOptions(FileType)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |

#### LoadOptions(string)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening password-protected file. |

#### LoadOptions(string, Encoding)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(string password, Encoding encoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening password-protected file. |
| encoding | Encoding | The encoding used when opening text-based files such as `CSV` or `TXT`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *encoding* is null. |

#### LoadOptions(FileType, string)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType fileType, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | String | The password for opening password-protected file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |

#### LoadOptions(FileType, string, Encoding)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType fileType, string password, Encoding encoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | String | The password for opening password-protected file. |
| encoding | Encoding | The encoding used when opening text-based files such as `CSV` or `TXT`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *encoding* is null. |

#### LoadOptions(string, FileType, string, Encoding)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(string extension, FileType fileType, string password, Encoding encoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The extension of the file to load. |
| fileType | FileType | The type of the file to load. |
| password | String | The password for opening password-protected file. |
| encoding | Encoding | The encoding used when opening text-based files such as `CSV` or `TXT`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *encoding* is null. |

#### LoadOptions(FileType, FileType, string, Encoding)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType iniFileType, FileType fileType, string password, Encoding encoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | String | The password for opening password-protected file. |
| encoding | Encoding | The encoding used when opening text-based files such as `CSV` or `TXT`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *iniFileType* is null. |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *encoding* is null. |

#### LoadOptions(FileType, FileType, string)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType iniFileType, FileType fileType, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | String | The password for opening password-protected file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *iniFileType* is null. |
| ArgumentNullException | Thrown when *fileType* is null. |

#### LoadOptions(FileType, FileType)

Initializes new instance of `LoadOptions` class.

```csharp
public LoadOptions(FileType iniFileType, FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *iniFileType* is null. |
| ArgumentNullException | Thrown when *fileType* is null. |

### Password
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions/password.md

#### LoadOptions.Password property

The password for opening password-protected file.

```csharp
public string Password { get; }
```

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/loadoptions/type.md

#### LoadOptions.Type property

The type of the file to load.

```csharp
public FileType Type { get; }
```

### MoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/moveoptions.md

#### MoveOptions class

Provides options for moving document page.

```csharp
public class MoveOptions : IMoveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MoveOptions(int, int) | Initializes a new instance of the `MoveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| NewPageNumber { get; } | Gets or sets the new page number. |
| PageNumberToMove { get; } | Gets or sets the page number to move. |

### MoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/moveoptions/moveoptions.md

#### MoveOptions constructor

Initializes a new instance of the `MoveOptions` class.

```csharp
public MoveOptions(int pageNumberToMove, int newPageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumberToMove | Int32 | The page number to move. |
| newPageNumber | Int32 | The new page number. |

### NewPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/moveoptions/newpagenumber.md

#### MoveOptions.NewPageNumber property

Gets or sets the new page number.

```csharp
public int NewPageNumber { get; }
```

##### Property Value

The new page number.

### PageNumberToMove
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/moveoptions/pagenumbertomove.md

#### MoveOptions.PageNumberToMove property

Gets or sets the page number to move.

```csharp
public int PageNumberToMove { get; }
```

##### Property Value

The page number to move.

### OleDiagramOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions.md

#### OleDiagramOptions class

Provides options for import of the embedded document to Diagram via OLE.

```csharp
public class OleDiagramOptions : ImportDocumentOptions, IOleDiagramOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OleDiagramOptions(string, int) | Initializes a new instance of the `OleDiagramOptions` class. |
| OleDiagramOptions(string, byte[], int) | Initializes a new instance of the `OleDiagramOptions` class. |
| OleDiagramOptions(byte[], byte[], string, int) | Initializes a new instance of the `OleDiagramOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| Height { get; set; } | The height of the embedded object shape in inches. |
| ImageData { get; } | The image data of the embedded object. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |
| Width { get; set; } | The width of the embedded object shape in inches. |
| X { get; set; } | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| Y { get; set; } | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/height.md

#### OleDiagramOptions.Height property

The height of the embedded object shape in inches.

```csharp
public int Height { get; set; }
```

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/imagedata.md

#### OleDiagramOptions.ImageData property

The image data of the embedded object.

```csharp
public byte[] ImageData { get; }
```

### OleDiagramOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/olediagramoptions.md

#### OleDiagramOptions(byte[], byte[], string, int)

Initializes a new instance of the `OleDiagramOptions` class.

```csharp
public OleDiagramOptions(byte[] objectData, byte[] imageData, string extension, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| objectData | Byte[] | The data of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| extension | String | The extension of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleDiagramOptions(string, byte[], int)

Initializes a new instance of the `OleDiagramOptions` class.

```csharp
public OleDiagramOptions(string filePath, byte[] imageData, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleDiagramOptions(string, int)

Initializes a new instance of the `OleDiagramOptions` class.

```csharp
public OleDiagramOptions(string filePath, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/width.md

#### OleDiagramOptions.Width property

The width of the embedded object shape in inches.

```csharp
public int Width { get; set; }
```

### X
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/x.md

#### OleDiagramOptions.X property

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

```csharp
public int X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olediagramoptions/y.md

#### OleDiagramOptions.Y property

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

```csharp
public int Y { get; set; }
```

### OlePresentationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions.md

#### OlePresentationOptions class

Provides options for import of the embedded document to Presentation via OLE.

```csharp
public class OlePresentationOptions : ImportDocumentOptions, IOlePresentationOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OlePresentationOptions(string, int) | Initializes a new instance of the `OlePresentationOptions` class. |
| OlePresentationOptions(byte[], string, int) | Initializes a new instance of the `OlePresentationOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| Height { get; set; } | The height of the embedded object frame. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |
| Width { get; set; } | The width of the embedded object frame. |
| X { get; set; } | The X coordinate of the embedded object frame. |
| Y { get; set; } | The Y coordinate of the embedded object frame. |

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions/height.md

#### OlePresentationOptions.Height property

The height of the embedded object frame.

```csharp
public int Height { get; set; }
```

### OlePresentationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions/olepresentationoptions.md

#### OlePresentationOptions(byte[], string, int)

Initializes a new instance of the `OlePresentationOptions` class.

```csharp
public OlePresentationOptions(byte[] objectData, string extension, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| objectData | Byte[] | The data of the embedded object. |
| extension | String | The extension of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OlePresentationOptions(string, int)

Initializes a new instance of the `OlePresentationOptions` class.

```csharp
public OlePresentationOptions(string filePath, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions/width.md

#### OlePresentationOptions.Width property

The width of the embedded object frame.

```csharp
public int Width { get; set; }
```

### X
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions/x.md

#### OlePresentationOptions.X property

The X coordinate of the embedded object frame.

```csharp
public int X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olepresentationoptions/y.md

#### OlePresentationOptions.Y property

The Y coordinate of the embedded object frame.

```csharp
public int Y { get; set; }
```

### OleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions.md

#### OleSpreadsheetOptions class

Provides options for import of the embedded document to Spreadsheet via OLE.

```csharp
public class OleSpreadsheetOptions : ImportDocumentOptions, IOleSpreadsheetOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OleSpreadsheetOptions(string, int) | Initializes a new instance of the `OleSpreadsheetOptions` class. |
| OleSpreadsheetOptions(string, byte[], int) | Initializes a new instance of the `OleSpreadsheetOptions` class. |
| OleSpreadsheetOptions(byte[], byte[], string, int) | Initializes a new instance of the `OleSpreadsheetOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColumnIndex { get; set; } | The upper left column index. |
| Extension { get; } | The extension of the embedded object. |
| Height { get; set; } | The height of the Ole object image. |
| ImageData { get; } | The data of the Ole object image. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |
| RowIndex { get; set; } | The upper left row index. |
| Width { get; set; } | The width of the Ole object image. |

### ColumnIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/columnindex.md

#### OleSpreadsheetOptions.ColumnIndex property

The upper left column index.

```csharp
public int ColumnIndex { get; set; }
```

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/height.md

#### OleSpreadsheetOptions.Height property

The height of the Ole object image.

```csharp
public int Height { get; set; }
```

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/imagedata.md

#### OleSpreadsheetOptions.ImageData property

The data of the Ole object image.

```csharp
public byte[] ImageData { get; }
```

### OleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/olespreadsheetoptions.md

#### OleSpreadsheetOptions(byte[], byte[], string, int)

Initializes a new instance of the `OleSpreadsheetOptions` class.

```csharp
public OleSpreadsheetOptions(byte[] objectData, byte[] imageData, string extension, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| objectData | Byte[] | The data of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| extension | String | The extension of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleSpreadsheetOptions(string, byte[], int)

Initializes a new instance of the `OleSpreadsheetOptions` class.

```csharp
public OleSpreadsheetOptions(string filePath, byte[] imageData, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleSpreadsheetOptions(string, int)

Initializes a new instance of the `OleSpreadsheetOptions` class.

```csharp
public OleSpreadsheetOptions(string filePath, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

### RowIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/rowindex.md

#### OleSpreadsheetOptions.RowIndex property

The upper left row index.

```csharp
public int RowIndex { get; set; }
```

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olespreadsheetoptions/width.md

#### OleSpreadsheetOptions.Width property

The width of the Ole object image.

```csharp
public int Width { get; set; }
```

### OleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions.md

#### OleWordProcessingOptions class

Provides options for import of the embedded document to Word processing via OLE.

```csharp
public class OleWordProcessingOptions : ImportDocumentOptions, IOleWordProcessingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OleWordProcessingOptions(string, int) | Initializes a new instance of the `OleWordProcessingOptions` class. |
| OleWordProcessingOptions(string, byte[], int) | Initializes a new instance of the `OleWordProcessingOptions` class. |
| OleWordProcessingOptions(byte[], byte[], string, int) | Initializes a new instance of the `OleWordProcessingOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| Height { get; set; } | The height of the Ole object image. |
| ImageData { get; } | The data of the Ole object image. |
| Left { get; set; } | The left coordinate of the Ole object image. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |
| Top { get; set; } | The top coordinate of the Ole object image. |
| Width { get; set; } | The width of the Ole object image. |

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/height.md

#### OleWordProcessingOptions.Height property

The height of the Ole object image.

```csharp
public int Height { get; set; }
```

### ImageData
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/imagedata.md

#### OleWordProcessingOptions.ImageData property

The data of the Ole object image.

```csharp
public byte[] ImageData { get; }
```

### Left
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/left.md

#### OleWordProcessingOptions.Left property

The left coordinate of the Ole object image.

```csharp
public int Left { get; set; }
```

### OleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/olewordprocessingoptions.md

#### OleWordProcessingOptions(byte[], byte[], string, int)

Initializes a new instance of the `OleWordProcessingOptions` class.

```csharp
public OleWordProcessingOptions(byte[] objectData, byte[] imageData, string extension, 
    int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| objectData | Byte[] | The data of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| extension | String | The extension of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleWordProcessingOptions(string, byte[], int)

Initializes a new instance of the `OleWordProcessingOptions` class.

```csharp
public OleWordProcessingOptions(string filePath, byte[] imageData, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| imageData | Byte[] | The image data of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

#### OleWordProcessingOptions(string, int)

Initializes a new instance of the `OleWordProcessingOptions` class.

```csharp
public OleWordProcessingOptions(string filePath, int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |
| pageNumber | Int32 | The page number for adding embedded object. |

### Top
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/top.md

#### OleWordProcessingOptions.Top property

The top coordinate of the Ole object image.

```csharp
public int Top { get; set; }
```

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/olewordprocessingoptions/width.md

#### OleWordProcessingOptions.Width property

The width of the Ole object image.

```csharp
public int Width { get; set; }
```

### OrientationMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/orientationmode.md

#### OrientationMode enumeration

Defines page orientation.

```csharp
public enum OrientationMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Portrait | `0` | Portrait page mode. |
| Landscape | `1` | Landscape page mode. |

### OrientationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/orientationoptions.md

#### OrientationOptions class

Provides options for the page orientation.

```csharp
public class OrientationOptions : PageOptions, IOrientationOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OrientationOptions(OrientationMode) | Initializes a new instance of the `OrientationOptions` class. |
| OrientationOptions(OrientationMode, int[]) | Initializes a new instance of the `OrientationOptions` class. |
| OrientationOptions(OrientationMode, int, int) | Initializes a new instance of the `OrientationOptions` class. |
| OrientationOptions(OrientationMode, int, int, RangeMode) | Initializes a new instance of the `OrientationOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | Gets the mode for the page orientation. |
| Pages { get; } | Get page numbers collection. |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/orientationoptions/mode.md

#### OrientationOptions.Mode property

Gets the mode for the page orientation.

```csharp
public OrientationMode Mode { get; }
```

### OrientationOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/orientationoptions/orientationoptions.md

#### OrientationOptions(OrientationMode)

Initializes a new instance of the `OrientationOptions` class.

```csharp
public OrientationOptions(OrientationMode orientationMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | OrientationMode | The orientation mode of `OrientationMode` |

#### OrientationOptions(OrientationMode, int[])

Initializes a new instance of the `OrientationOptions` class.

```csharp
public OrientationOptions(OrientationMode orientationMode, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | OrientationMode | The orientation mode of `OrientationMode` |
| pageNumbers | Int32[] | Page numbers. |

#### OrientationOptions(OrientationMode, int, int)

Initializes a new instance of the `OrientationOptions` class.

```csharp
public OrientationOptions(OrientationMode orientationMode, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | OrientationMode | The orientation mode of `OrientationMode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### OrientationOptions(OrientationMode, int, int, RangeMode)

Initializes a new instance of the `OrientationOptions` class.

```csharp
public OrientationOptions(OrientationMode orientationMode, int startNumber, int endNumber, 
    RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | OrientationMode | The orientation mode of `OrientationMode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### PageBuilderOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagebuilderoptions.md

#### PageBuilderOptions class

Provides options for specifying the page builder.

```csharp
public class PageBuilderOptions : IPageBuilderOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageBuilderOptions() | Initializes a new instance of the `PageBuilderOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| LoadDocumentInfo { get; set; } | Specifies if each document info should load all its pages info. |

### LoadDocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagebuilderoptions/loaddocumentinfo.md

#### PageBuilderOptions.LoadDocumentInfo property

Specifies if each document info should load all its pages info.

```csharp
public bool LoadDocumentInfo { get; set; }
```

### PageBuilderOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagebuilderoptions/pagebuilderoptions.md

#### PageBuilderOptions constructor

Initializes a new instance of the `PageBuilderOptions` class.

```csharp
public PageBuilderOptions()
```

### PageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagejoinoptions.md

#### PageJoinOptions class

Provides options for the document joining.

```csharp
public class PageJoinOptions : PageOptions, IPageJoinOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageJoinOptions() | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(FileType) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(int[]) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(FileType, int[]) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(int, int) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(FileType, int, int) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(int, int, RangeMode) | Initializes a new instance of the `PageJoinOptions` class. |
| PageJoinOptions(FileType, int, int, RangeMode) | Initializes a new instance of the `PageJoinOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Get page numbers collection. |
| Type { get; } | The type of the file to join. |

### PageJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagejoinoptions/pagejoinoptions.md

#### PageJoinOptions()

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions()
```

#### PageJoinOptions(int[])

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | Int32[] | Page numbers. |

#### PageJoinOptions(int, int)

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PageJoinOptions(int, int, RangeMode)

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### PageJoinOptions(FileType)

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

#### PageJoinOptions(FileType, int[])

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(FileType fileType, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | Int32[] | Page numbers. |

#### PageJoinOptions(FileType, int, int)

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(FileType fileType, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PageJoinOptions(FileType, int, int, RangeMode)

Initializes a new instance of the `PageJoinOptions` class.

```csharp
public PageJoinOptions(FileType fileType, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pagejoinoptions/type.md

#### PageJoinOptions.Type property

The type of the file to join.

```csharp
public FileType Type { get; }
```

### PageOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pageoptions.md

#### PageOptions class

Provides options for specifying page or pages range.

```csharp
public abstract class PageOptions : IPageOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Get page numbers collection. |

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pageoptions/pages.md

#### PageOptions.Pages property

Get page numbers collection.

```csharp
public int[] Pages { get; }
```

### PdfAccesibilitySettings
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfaccesibilitysettings.md

#### PdfAccesibilitySettings class

Provides Pdf Accesibility settings for the document saving.

```csharp
public class PdfAccesibilitySettings
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfAccesibilitySettings() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| EnableAutoTagging { get; set; } | Enable auto tagging |

### EnableAutoTagging
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfaccesibilitysettings/enableautotagging.md

#### PdfAccesibilitySettings.EnableAutoTagging property

Enable auto tagging

```csharp
public bool EnableAutoTagging { get; set; }
```

### PdfAccesibilitySettings
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfaccesibilitysettings/pdfaccesibilitysettings.md

#### PdfAccesibilitySettings constructor

The default constructor.

```csharp
public PdfAccesibilitySettings()
```

### PdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfattachmentoptions.md

#### PdfAttachmentOptions class

Provides options to attach the embedded object to Pdf.

```csharp
public class PdfAttachmentOptions : ImportDocumentOptions, IPdfAttachmentOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfAttachmentOptions(string) | Initializes a new instance of the `PdfAttachmentOptions` class. |
| PdfAttachmentOptions(byte[], string) | Initializes a new instance of the `PdfAttachmentOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | The extension of the embedded object. |
| ObjectData { get; } | The data of the embedded object. |
| PageNumber { get; } | The page number for inserting of the embedded object. |

### PdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfattachmentoptions/pdfattachmentoptions.md

#### PdfAttachmentOptions(byte[], string)

Initializes a new instance of the `PdfAttachmentOptions` class.

```csharp
public PdfAttachmentOptions(byte[] objectData, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| objectData | Byte[] | The data of the embedded object. |
| extension | String | The extension of the embedded object. |

#### PdfAttachmentOptions(string)

Initializes a new instance of the `PdfAttachmentOptions` class.

```csharp
public PdfAttachmentOptions(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path of the embedded object. |

### PdfJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfjoinoptions.md

#### PdfJoinOptions class

The Pdf join options.

```csharp
public class PdfJoinOptions : PageJoinOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfJoinOptions() | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(FileType) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(int[]) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(FileType, int[]) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(int, int) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(FileType, int, int) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(int, int, RangeMode) | Initializes a new instance of the `PdfJoinOptions` class. |
| PdfJoinOptions(FileType, int, int, RangeMode) | Initializes a new instance of the `PdfJoinOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Get page numbers collection. |
| PreserveAccessibility { get; set; } | Indicates if PDF accessibility (tagged PDF structure) should be preserved during merge. When true, the merged document will have auto-generated accessibility tags for PDF/UA compliance. Default is false. |
| Type { get; } | The type of the file to join. |
| UseBookmarks { get; set; } | Indicates if all the bookmarks will be copied by default. |

### PdfJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfjoinoptions/pdfjoinoptions.md

#### PdfJoinOptions()

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions()
```

#### PdfJoinOptions(int[])

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | Int32[] | Page numbers. |

#### PdfJoinOptions(int, int)

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PdfJoinOptions(int, int, RangeMode)

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### PdfJoinOptions(FileType)

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

#### PdfJoinOptions(FileType, int[])

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(FileType fileType, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | Int32[] | Page numbers. |

#### PdfJoinOptions(FileType, int, int)

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(FileType fileType, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PdfJoinOptions(FileType, int, int, RangeMode)

Initializes a new instance of the `PdfJoinOptions` class.

```csharp
public PdfJoinOptions(FileType fileType, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### PreserveAccessibility
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfjoinoptions/preserveaccessibility.md

#### PdfJoinOptions.PreserveAccessibility property

Indicates if PDF accessibility (tagged PDF structure) should be preserved during merge. When true, the merged document will have auto-generated accessibility tags for PDF/UA compliance. Default is false.

```csharp
public bool PreserveAccessibility { get; set; }
```

### UseBookmarks
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfjoinoptions/usebookmarks.md

#### PdfJoinOptions.UseBookmarks property

Indicates if all the bookmarks will be copied by default.

```csharp
public bool UseBookmarks { get; set; }
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsaveoptions.md

#### PdfSaveOptions class

Provides additional Pdf options for the document saving.

```csharp
public class PdfSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of the `PdfSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AccesibilitySettings { get; set; } | Accesibility settings |
| Type { get; } | File type. |

### AccesibilitySettings
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsaveoptions/accesibilitysettings.md

#### PdfSaveOptions.AccesibilitySettings property

Accesibility settings

```csharp
public PdfAccesibilitySettings AccesibilitySettings { get; set; }
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsaveoptions/pdfsaveoptions.md

#### PdfSaveOptions constructor

Initializes a new instance of the `PdfSaveOptions` class.

```csharp
public PdfSaveOptions()
```

### PdfSecurityOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsecurityoptions.md

#### PdfSecurityOptions class

Contains the PDF document security options.

```csharp
public class PdfSecurityOptions : AddPasswordOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfSecurityOptions(string) | Initializes a new instance of the `PdfSecurityOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| OwnerPassword { get; set; } | The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction. |
| Password { get; } | The password for document protection. |
| Permissions { get; set; } | The PDF document permissions such as printing, modification and data extraction. |

### OwnerPassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsecurityoptions/ownerpassword.md

#### PdfSecurityOptions.OwnerPassword property

The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction.

```csharp
public string OwnerPassword { get; set; }
```

### PdfSecurityOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsecurityoptions/pdfsecurityoptions.md

#### PdfSecurityOptions constructor

Initializes a new instance of the `PdfSecurityOptions` class.

```csharp
public PdfSecurityOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password. |

### Permissions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsecurityoptions/permissions.md

#### PdfSecurityOptions.Permissions property

The PDF document permissions such as printing, modification and data extraction.

```csharp
public PdfSecurityPermissions Permissions { get; set; }
```

### PdfSecurityPermissions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/pdfsecuritypermissions.md

#### PdfSecurityPermissions enumeration

Defines PDF document permissions.

```csharp
[Flags]
public enum PdfSecurityPermissions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllowAll | `0` | Allow printing, modification and data extraction. |
| DenyPrinting | `1` | Deny printing. |
| DenyModification | `2` | Deny content modification, filling in forms, adding or modifying annotations. |
| DenyDataExtraction | `4` | Deny text and graphics extraction. |
| DenyAll | `7` | Deny printing, content modification and data extraction. |

### PreviewMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewmode.md

#### PreviewMode enumeration

Provides modes for the page previewing.

```csharp
public enum PreviewMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | Preview mode as .png |
| JPEG | `1` | Preview mode as .jpeg |
| BMP | `2` | Preview mode as .bmp |

### PreviewOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions.md

#### PreviewOptions class

Represents document preview options.

```csharp
public class PreviewOptions : PageOptions, IPreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream, PreviewMode) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, PreviewMode, int[]) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, PreviewMode, int, int) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int[]) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, PreviewMode, int, int, RangeMode) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int, int) | Initializes a new instance of the `PreviewOptions` class. |
| PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int, int, RangeMode) | Initializes a new instance of the `PreviewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output page preview stream. |
| Height { get; set; } | Preview height. |
| Mode { get; } | Mode for preview. |
| Pages { get; } | Get page numbers collection. |
| ReleaseStream { get; } | Delegate that defines method to release output page preview stream. |
| Resolution { get; set; } | Image resolution. |
| Width { get; set; } | Preview width. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByPageNumber(int, string) | Gets the full file path of previewed document by page number with defined extension. |
| Validate(FileType) | Validates the preview options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/createstream.md

#### PreviewOptions.CreateStream property

Delegate that defines method to create output page preview stream.

```csharp
public CreatePageStream CreateStream { get; }
```

### GetPathByPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/getpathbypagenumber.md

#### PreviewOptions.GetPathByPageNumber method

Gets the full file path of previewed document by page number with defined extension.

```csharp
public string GetPathByPageNumber(int pageNumber, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Page number of preview. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/height.md

#### PreviewOptions.Height property

Preview height.

```csharp
public int Height { get; set; }
```

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/mode.md

#### PreviewOptions.Mode property

Mode for preview.

```csharp
public PreviewMode Mode { get; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream, PreviewMode)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, PreviewMode previewMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| previewMode | PreviewMode | The preview mode of `Mode` |

#### PreviewOptions(CreatePageStream, PreviewMode, int[])

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, PreviewMode previewMode, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| pageNumbers | Int32[] | Page numbers. |

#### PreviewOptions(CreatePageStream, PreviewMode, int, int)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, PreviewMode previewMode, int startNumber, 
    int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PreviewOptions(CreatePageStream, PreviewMode, int, int, RangeMode)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, PreviewMode previewMode, int startNumber, 
    int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream, 
    PreviewMode previewMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases stream created by createPageStream method. |
| previewMode | PreviewMode | The preview mode of `Mode` |

#### PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int[])

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream, 
    PreviewMode previewMode, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases stream created by createPageStream method. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| pageNumbers | Int32[] | Page numbers. |

#### PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int, int)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream, 
    PreviewMode previewMode, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases stream created by createPageStream method. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### PreviewOptions(CreatePageStream, ReleasePageStream, PreviewMode, int, int, RangeMode)

Initializes a new instance of the `PreviewOptions` class.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream, 
    PreviewMode previewMode, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases stream created by createPageStream method. |
| previewMode | PreviewMode | The preview mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/releasestream.md

#### PreviewOptions.ReleaseStream property

Delegate that defines method to release output page preview stream.

```csharp
public ReleasePageStream ReleaseStream { get; }
```

### Resolution
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/resolution.md

#### PreviewOptions.Resolution property

Image resolution.

```csharp
public int Resolution { get; set; }
```

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/validate.md

#### PreviewOptions.Validate method

Validates the preview options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/previewoptions/width.md

#### PreviewOptions.Width property

Preview width.

```csharp
public int Width { get; set; }
```

### RangeMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/rangemode.md

#### RangeMode enumeration

Possible modes for the page ranging.

```csharp
public enum RangeMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllPages | `0` | Range have all numbers from begin to end. |
| OddPages | `1` | Range have only odd numbers from begin to end. |
| EvenPages | `2` | Range have only even numbers from begin to end. |

### RemoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/removeoptions.md

#### RemoveOptions class

Provides options for the page removing.

```csharp
public class RemoveOptions : PageOptions, IRemoveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| RemoveOptions() | Initializes a new instance of the `RemoveOptions` class. |
| RemoveOptions(int[]) | Initializes a new instance of the `RemoveOptions` class. |
| RemoveOptions(int, int) | Initializes a new instance of the `RemoveOptions` class. |
| RemoveOptions(int, int, RangeMode) | Initializes a new instance of the `RemoveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; } | Get page numbers collection. |

### RemoveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/removeoptions/removeoptions.md

#### RemoveOptions()

Initializes a new instance of the `RemoveOptions` class.

```csharp
public RemoveOptions()
```

#### RemoveOptions(int[])

Initializes a new instance of the `RemoveOptions` class.

```csharp
public RemoveOptions(int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | Int32[] | Page numbers. |

#### RemoveOptions(int, int)

Initializes a new instance of the `RemoveOptions` class.

```csharp
public RemoveOptions(int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### RemoveOptions(int, int, RangeMode)

Initializes a new instance of the `RemoveOptions` class.

```csharp
public RemoveOptions(int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### RotateMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/rotatemode.md

#### RotateMode enumeration

Possible modes for the page rotation.

```csharp
public enum RotateMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Rotate90 | `90` | Rotate to the right with 90 degrees. |
| Rotate180 | `180` | Rotate to the right with 180 degrees. |
| Rotate270 | `270` | Rotate to the right with 270 degrees. |

### RotateOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/rotateoptions.md

#### RotateOptions class

Provides options for the page rotation.

```csharp
public class RotateOptions : PageOptions, IRotateOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| RotateOptions(RotateMode) | Initializes a new instance of the `RotateOptions` class. |
| RotateOptions(RotateMode, int[]) | Initializes a new instance of the `RotateOptions` class. |
| RotateOptions(RotateMode, int, int) | Initializes a new instance of the `RotateOptions` class. |
| RotateOptions(RotateMode, int, int, RangeMode) | Initializes a new instance of the `RotateOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; } | Gets the mode for rotating (90, 180 or 270 degrees). |
| Pages { get; } | Get page numbers collection. |

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/rotateoptions/mode.md

#### RotateOptions.Mode property

Gets the mode for rotating (90, 180 or 270 degrees).

```csharp
public RotateMode Mode { get; }
```

### RotateOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/rotateoptions/rotateoptions.md

#### RotateOptions(RotateMode)

Initializes a new instance of the `RotateOptions` class.

```csharp
public RotateOptions(RotateMode rotateMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | RotateMode | The rotating mode of `Mode` |

#### RotateOptions(RotateMode, int[])

Initializes a new instance of the `RotateOptions` class.

```csharp
public RotateOptions(RotateMode rotateMode, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | RotateMode | The rotating mode of `Mode` |
| pageNumbers | Int32[] | Page numbers. |

#### RotateOptions(RotateMode, int, int)

Initializes a new instance of the `RotateOptions` class.

```csharp
public RotateOptions(RotateMode rotateMode, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | RotateMode | The rotating mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### RotateOptions(RotateMode, int, int, RangeMode)

Initializes a new instance of the `RotateOptions` class.

```csharp
public RotateOptions(RotateMode rotateMode, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | RotateMode | The rotating mode of `Mode` |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### SaveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/saveoptions.md

#### SaveOptions class

Provides options for the document saving.

```csharp
public class SaveOptions : ISaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Type { get; } | File type. |

### SaveOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/saveoptions/saveoptions.md

#### SaveOptions constructor

The default constructor.

```csharp
public SaveOptions()
```

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/saveoptions/type.md

#### SaveOptions.Type property

File type.

```csharp
public FileType Type { get; }
```

### SplitMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitmode.md

#### SplitMode enumeration

Defines page splitting modes.

```csharp
public enum SplitMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pages | `0` | Split pages |
| Interval | `1` | Split Intervals |

### SplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions.md

#### SplitOptions class

Provides options for the document page splitting.

```csharp
public class SplitOptions : PageOptions, ISplitOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SplitOptions(CreateSplitStream) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, int[]) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, ReleaseSplitStream) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(string, int[]) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, int, int) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, int[], SplitMode) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, ReleaseSplitStream, int[]) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(string, int, int) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(string, int[], SplitMode) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, int, int, RangeMode) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, ReleaseSplitStream, int, int) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, ReleaseSplitStream, int[], SplitMode) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(string, int, int, RangeMode) | Initializes a new instance of the `SplitOptions` class. |
| SplitOptions(CreateSplitStream, ReleaseSplitStream, int, int, RangeMode) | Initializes a new instance of the `SplitOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output split stream. |
| Mode { get; } | Gets the mode for page splitting. |
| Pages { get; } | Get page numbers collection. |
| ReleaseStream { get; } | Delegate that defines method to release output split stream. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByIndex(int, string) | Gets the full file path of splitted document by index with pre-defined extension. |
| Validate(FileType) | Validates the split options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/createstream.md

#### SplitOptions.CreateStream property

Delegate that defines method to create output split stream.

```csharp
public CreateSplitStream CreateStream { get; }
```

### GetPathByIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/getpathbyindex.md

#### SplitOptions.GetPathByIndex method

Gets the full file path of splitted document by index with pre-defined extension.

```csharp
public string GetPathByIndex(int index, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | Index of splitted document. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/mode.md

#### SplitOptions.Mode property

Gets the mode for page splitting.

```csharp
public SplitMode Mode { get; }
```

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/releasestream.md

#### SplitOptions.ReleaseStream property

Delegate that defines method to release output split stream.

```csharp
public ReleaseSplitStream ReleaseStream { get; }
```

### SplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/splitoptions.md

#### SplitOptions(string, int[])

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(string filePathFormat, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension. |
| pageNumbers | Int32[] | Page numbers. |

#### SplitOptions(string, int[], SplitMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(string filePathFormat, int[] pageNumbers, SplitMode splitMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension. |
| pageNumbers | Int32[] | Page numbers. |
| splitMode | SplitMode | The splitting mode of `Mode`. |

#### SplitOptions(string, int, int)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(string filePathFormat, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### SplitOptions(string, int, int, RangeMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(string filePathFormat, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### SplitOptions(CreateSplitStream)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |

#### SplitOptions(CreateSplitStream, int[])

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| pageNumbers | Int32[] | Page numbers. |

#### SplitOptions(CreateSplitStream, int[], SplitMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, int[] pageNumbers, SplitMode splitMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| pageNumbers | Int32[] | Page numbers. |
| splitMode | SplitMode | The splitting mode of `Mode`. |

#### SplitOptions(CreateSplitStream, int, int)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### SplitOptions(CreateSplitStream, int, int, RangeMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, int startNumber, int endNumber, 
    RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### SplitOptions(CreateSplitStream, ReleaseSplitStream)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |

#### SplitOptions(CreateSplitStream, ReleaseSplitStream, int[])

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| pageNumbers | Int32[] | Page numbers. |

#### SplitOptions(CreateSplitStream, ReleaseSplitStream, int[], SplitMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    int[] pageNumbers, SplitMode splitMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| pageNumbers | Int32[] | Page numbers. |
| splitMode | SplitMode | The splitting mode of `Mode`. |

#### SplitOptions(CreateSplitStream, ReleaseSplitStream, int, int)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### SplitOptions(CreateSplitStream, ReleaseSplitStream, int, int, RangeMode)

Initializes a new instance of the `SplitOptions` class.

```csharp
public SplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/splitoptions/validate.md

#### SplitOptions.Validate method

Validates the split options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of `FileType` class. |

### SwapOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/swapoptions.md

#### SwapOptions class

Provides options for swapping document pages.

```csharp
public class SwapOptions : ISwapOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SwapOptions(int, int) | Initializes a new instance of the `SwapOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FirstPageNumber { get; } | First page number to exchange. |
| SecondPageNumber { get; } | Second page number to exchange. |

### FirstPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/swapoptions/firstpagenumber.md

#### SwapOptions.FirstPageNumber property

First page number to exchange.

```csharp
public int FirstPageNumber { get; }
```

### SecondPageNumber
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/swapoptions/secondpagenumber.md

#### SwapOptions.SecondPageNumber property

Second page number to exchange.

```csharp
public int SecondPageNumber { get; }
```

### SwapOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/swapoptions/swapoptions.md

#### SwapOptions constructor

Initializes a new instance of the `SwapOptions` class.

```csharp
public SwapOptions(int firstPageNumber, int secondPageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| firstPageNumber | Int32 | The first page number. |
| secondPageNumber | Int32 | The second page number. |

### TextSplitMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitmode.md

#### TextSplitMode enumeration

Possible text splitting modes.

```csharp
public enum TextSplitMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Lines | `0` | Split lines |
| Interval | `1` | Split Intervals |

### TextSplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions.md

#### TextSplitOptions class

Provides options for the document text splitting.

```csharp
public class TextSplitOptions : ITextSplitOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSplitOptions(CreateSplitStream, int[]) | Initializes a new instance of the `TextSplitOptions` class. |
| TextSplitOptions(string, int[]) | Initializes a new instance of the `TextSplitOptions` class. |
| TextSplitOptions(CreateSplitStream, ReleaseSplitStream, int[]) | Initializes a new instance of the `TextSplitOptions` class. |
| TextSplitOptions(CreateSplitStream, TextSplitMode, int[]) | Initializes a new instance of the `TextSplitOptions` class. |
| TextSplitOptions(string, TextSplitMode, int[]) | Initializes a new instance of the `TextSplitOptions` class. |
| TextSplitOptions(CreateSplitStream, ReleaseSplitStream, TextSplitMode, int[]) | Initializes a new instance of the `TextSplitOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| CreateStream { get; } | Delegate that defines method to create output split stream. |
| LineNumbers { get; } | Line numbers for text splitting. |
| Mode { get; } | Mode for text splitting. |
| ReleaseStream { get; } | Delegate that defines method to release output split stream. |

#### Methods

| Name | Description |
| --- | --- |
| GetPathByIndex(int, string) | Gets the full file path of splitted document by index with defined extension. |
| Validate(FileType) | Validates the split options. |

### CreateStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/createstream.md

#### TextSplitOptions.CreateStream property

Delegate that defines method to create output split stream.

```csharp
public CreateSplitStream CreateStream { get; }
```

### GetPathByIndex
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/getpathbyindex.md

#### TextSplitOptions.GetPathByIndex method

Gets the full file path of splitted document by index with defined extension.

```csharp
public string GetPathByIndex(int index, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | Index of splitted document. |
| extension | String | Extension of file. |

##### Return Value

The full file path.

### LineNumbers
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/linenumbers.md

#### TextSplitOptions.LineNumbers property

Line numbers for text splitting.

```csharp
public int[] LineNumbers { get; }
```

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/mode.md

#### TextSplitOptions.Mode property

Mode for text splitting.

```csharp
public TextSplitMode Mode { get; }
```

### ReleaseStream
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/releasestream.md

#### TextSplitOptions.ReleaseStream property

Delegate that defines method to release output split stream.

```csharp
public ReleaseSplitStream ReleaseStream { get; }
```

### TextSplitOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/textsplitoptions.md

#### TextSplitOptions(string, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(string filePathFormat, int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already defined extension. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

#### TextSplitOptions(string, TextSplitMode, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(string filePathFormat, TextSplitMode mode, int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already defined extension. |
| mode | TextSplitMode | Mode for text splitting. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

#### TextSplitOptions(CreateSplitStream, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(CreateSplitStream createSplitStream, int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

#### TextSplitOptions(CreateSplitStream, TextSplitMode, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(CreateSplitStream createSplitStream, TextSplitMode mode, int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| mode | TextSplitMode | Mode for text splitting. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

#### TextSplitOptions(CreateSplitStream, ReleaseSplitStream, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

#### TextSplitOptions(CreateSplitStream, ReleaseSplitStream, TextSplitMode, int[])

Initializes a new instance of the `TextSplitOptions` class.

```csharp
public TextSplitOptions(CreateSplitStream createSplitStream, ReleaseSplitStream releaseSplitStream, 
    TextSplitMode mode, int[] lineNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createSplitStream | CreateSplitStream | The method that instantiates stream used to write output split data. |
| releaseSplitStream | ReleaseSplitStream | The method that releases stream created by createPageStream method. |
| mode | TextSplitMode | Mode for text splitting. |
| lineNumbers | Int32[] | Line numbers for text splitting. |

### Validate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/textsplitoptions/validate.md

#### TextSplitOptions.Validate method

Validates the split options.

```csharp
public void Validate(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of `FileType` class. |

### UpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/updatepasswordoptions.md

#### UpdatePasswordOptions class

Provides options for updating document password.

```csharp
public class UpdatePasswordOptions : IUpdatePasswordOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| UpdatePasswordOptions(string) | Initializes a new instance of the `UpdatePasswordOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| NewPassword { get; } | A new password for the document protection. |

### NewPassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/updatepasswordoptions/newpassword.md

#### UpdatePasswordOptions.NewPassword property

A new password for the document protection.

```csharp
public string NewPassword { get; }
```

### UpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/updatepasswordoptions/updatepasswordoptions.md

#### UpdatePasswordOptions constructor

Initializes a new instance of the `UpdatePasswordOptions` class.

```csharp
public UpdatePasswordOptions(string newPassword)
```

| Parameter | Type | Description |
| --- | --- | --- |
| newPassword | String | The new password. |

### WordJoinCompliance
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoincompliance.md

#### WordJoinCompliance enumeration

Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc.

```csharp
public enum WordJoinCompliance
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `100` | Auto |
| Ecma376_2006 | `0` | ECMA-376 1st Edition, 2006. |
| Iso29500_2008_Transitional | `1` | ISO/IEC 29500:2008 Transitional compliance level. |
| Iso29500_2008_Strict | `2` | ISO/IEC 29500:2008 Strict compliance level. |

### WordJoinMode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoinmode.md

#### WordJoinMode enumeration

Possible modes for the Word joining.

```csharp
public enum WordJoinMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Specifies Default Word joining. |
| Continuous | `1` | Specifies Word joining without starting from new page. |
| DisableSectionBreaks | `2` | Specifies Word joining without section breaks. |

### WordJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoinoptions.md

#### WordJoinOptions class

The Word join options.

```csharp
public class WordJoinOptions : PageJoinOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordJoinOptions() | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(FileType) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(int[]) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(FileType, int[]) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(int, int) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(FileType, int, int) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(int, int, RangeMode) | Initializes a new instance of the `WordJoinOptions` class. |
| WordJoinOptions(FileType, int, int, RangeMode) | Initializes a new instance of the `WordJoinOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Compliance { get; set; } | Compliance mode for the Word Ooxml format |
| Mode { get; set; } | The Word join mode. |
| Pages { get; } | Get page numbers collection. |
| Type { get; } | The type of the file to join. |

### Compliance
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoinoptions/compliance.md

#### WordJoinOptions.Compliance property

Compliance mode for the Word Ooxml format

```csharp
public WordJoinCompliance Compliance { get; set; }
```

### Mode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoinoptions/mode.md

#### WordJoinOptions.Mode property

The Word join mode.

```csharp
public WordJoinMode Mode { get; set; }
```

### WordJoinOptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.options/wordjoinoptions/wordjoinoptions.md

#### WordJoinOptions()

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions()
```

#### WordJoinOptions(int[])

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | Int32[] | Page numbers. |

#### WordJoinOptions(int, int)

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### WordJoinOptions(int, int, RangeMode)

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

#### WordJoinOptions(FileType)

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

#### WordJoinOptions(FileType, int[])

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(FileType fileType, int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | Int32[] | Page numbers. |

#### WordJoinOptions(FileType, int, int)

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(FileType fileType, int startNumber, int endNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |

#### WordJoinOptions(FileType, int, int, RangeMode)

Initializes a new instance of the `WordJoinOptions` class.

```csharp
public WordJoinOptions(FileType fileType, int startNumber, int endNumber, RangeMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | Int32 | The start page number. |
| endNumber | Int32 | The end page number. |
| mode | RangeMode | The range mode. |

### GroupDocs.Merger.Domain.Result
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result.md

The namespace provides classes which represent document results.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Defines document description properties. |
| PageInfo | Defines page description properties. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Interface for the document description properties. |
| IPageInfo | Interface for the page description properties. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### DocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo.md

#### DocumentInfo class

Defines document description properties.

```csharp
public class DocumentInfo : IDocumentInfo, ISerializable
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentInfo(FileType, IPageInfo[], long) | Initializes new instance of `DocumentInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| PageCount { get; } | The document pages count. |
| Pages { get; } | Defines document pages collection. |
| Size { get; } | Document size in bytes |
| Type { get; } | Gets the file type. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### DocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/documentinfo.md

#### DocumentInfo constructor

Initializes new instance of `DocumentInfo` class.

```csharp
public DocumentInfo(FileType fileType, IPageInfo[] pages, long size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | IPageInfo[] | The list of pages to view. |
| size | Int64 | The size of the file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |

### PageCount
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

The document pages count.

```csharp
public int PageCount { get; }
```

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/pages.md

#### DocumentInfo.Pages property

Defines document pages collection.

```csharp
public IPageInfo[] Pages { get; }
```

### Size
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/size.md

#### DocumentInfo.Size property

Document size in bytes

```csharp
public long Size { get; }
```

### ToString
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/tostring.md

#### DocumentInfo.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/documentinfo/type.md

#### DocumentInfo.Type property

Gets the file type.

```csharp
public FileType Type { get; }
```

### IDocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/idocumentinfo.md

#### IDocumentInfo interface

Interface for the document description properties.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| PageCount { get; } | The document pages count. |
| Pages { get; } | Defines document pages collection. |
| Size { get; } | Document size in bytes. |
| Type { get; } | Gets the file type. |

### PageCount
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

The document pages count.

```csharp
public int PageCount { get; }
```

### Pages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Defines document pages collection.

```csharp
public IPageInfo[] Pages { get; }
```

### Size
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/idocumentinfo/size.md

#### IDocumentInfo.Size property

Document size in bytes.

```csharp
public long Size { get; }
```

### Type
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/idocumentinfo/type.md

#### IDocumentInfo.Type property

Gets the file type.

```csharp
public FileType Type { get; }
```

### IPageInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo.md

#### IPageInfo interface

Interface for the page description properties.

```csharp
public interface IPageInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Document { get; set; } | Gets the document info. |
| Height { get; } | Gets page height in pixels when converted to image. |
| Number { get; } | Gets the page number. |
| Visible { get; } | Indicates whether page is visibile or not. |
| Width { get; } | Gets page width in pixels when converted to image. |

### Document
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo/document.md

#### IPageInfo.Document property

Gets the document info.

```csharp
public DocumentInfo Document { get; set; }
```

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo/height.md

#### IPageInfo.Height property

Gets page height in pixels when converted to image.

```csharp
public int Height { get; }
```

### Number
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo/number.md

#### IPageInfo.Number property

Gets the page number.

```csharp
public int Number { get; }
```

### Visible
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo/visible.md

#### IPageInfo.Visible property

Indicates whether page is visibile or not.

```csharp
public bool Visible { get; }
```

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/ipageinfo/width.md

#### IPageInfo.Width property

Gets page width in pixels when converted to image.

```csharp
public int Width { get; }
```

### PageInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo.md

#### PageInfo class

Defines page description properties.

```csharp
public class PageInfo : IPageInfo, ISerializable
```

#### Constructors

| Name | Description |
| --- | --- |
| PageInfo(int, bool) | Initializes new instance of `PageInfo` class. |
| PageInfo(int, bool, int, int) | Initializes new instance of `PageInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| Document { get; set; } | Gets the document info. |
| Height { get; } | Gets page height in pixels when converted to image. |
| Number { get; } | Gets the page number. |
| Visible { get; } | Indicates whether page is visibile or not. |
| Width { get; } | Gets page width in pixels when converted to image. |

### Document
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/document.md

#### PageInfo.Document property

Gets the document info.

```csharp
public DocumentInfo Document { get; set; }
```

### Height
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/height.md

#### PageInfo.Height property

Gets page height in pixels when converted to image.

```csharp
public int Height { get; }
```

### Number
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/number.md

#### PageInfo.Number property

Gets the page number.

```csharp
public int Number { get; }
```

### PageInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/pageinfo.md

#### PageInfo(int, bool)

Initializes new instance of `PageInfo` class.

```csharp
public PageInfo(int number, bool visible)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| visible | Boolean | The page visibility indicator. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |

#### PageInfo(int, bool, int, int)

Initializes new instance of `PageInfo` class.

```csharp
public PageInfo(int number, bool visible, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| visible | Boolean | The page visibility indicator. |
| width | Int32 | The width of the page in pixels when viewing as JPG or PNG. |
| height | Int32 | The height of the page in pixels when viewing as JPG or PNG. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |

### Visible
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/visible.md

#### PageInfo.Visible property

Indicates whether page is visibile or not.

```csharp
public bool Visible { get; }
```

### Width
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.result/pageinfo/width.md

#### PageInfo.Width property

Gets page width in pixels when converted to image.

```csharp
public int Width { get; }
```

### GroupDocs.Merger.Domain
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain.md

The namespace provides classes for working with document structure.

#### Classes

| Class | Description |
| --- | --- |
| FileType | Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Merger**, detect file type by extension etc. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### FileType
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype.md

#### FileType class

Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Merger**, detect file type by extension etc.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Filename suffix (including the period ".") e.g. ".doc". |
| FileFormat { get; } | File type name e.g. "Microsoft Word Document". |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps file extension to file type. |
| Equals(FileType) | Determines whether the current `FileType` is the same as specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static GetSupportedFileTypes() | Retrieves supported file types |
| static IsArchive(FileType) | Determines whether input `FileType` is archive format. |
| static IsAudio(FileType) | Determines whether input `FileType` is audio format. |
| static IsImage(FileType) | Determines whether input `FileType` is image format. |
| static IsText(FileType) | Determines whether input `FileType` is primitive text format. |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly BMP | Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. Learn more about this file format [here](https://docs.fileformat.com/image/bmp). |
| static readonly BZ2 | Bzip2 Compressed File (.bz2) |
| static readonly CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/csv). |
| static readonly DOC | Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here](https://docs.fileformat.com/word-processing/doc). |
| static readonly DOCM | Word Open XML 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](https://docs.fileformat.com/word-processing/docm). |
| static readonly DOCX | Microsoft Word Open XML Document (.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://docs.fileformat.com/word-processing/docx). |
| static readonly DOT | Word Document Template (.dot) files 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://docs.fileformat.com/word-processing/dot). |
| static readonly DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here](https://docs.fileformat.com/word-processing/dotm). |
| static readonly DOTX | Word Open XML Document 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](https://docs.fileformat.com/word-processing/dotx). |
| static readonly EMF | Windows Enhanced Metafile (.emf) |
| static readonly EMZ | Windows Compressed Enhanced Metafile (.emz) |
| static readonly EPUB | Open eBook File (.epub) 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://docs.fileformat.com/ebook/epub). |
| static readonly ERR | Error Log File (.err) is a text file that contains error messages generated by a program. Learn more about this file format [here](https://fileinfo.com/extension/err). |
| static readonly GIF | Graphical Interchange Format File (.gif) |
| static readonly GZ | G-Zip Compressed File (.gz) |
| static readonly HTML | Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://docs.fileformat.com/web/html). |
| static readonly JPEG | JPEG Image (.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://docs.fileformat.com/image/jpeg). |
| static readonly JPG | JPEG Image (.jpg) |
| static readonly MHT | MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://docs.fileformat.com/web/mhtml). |
| static readonly MHTML | MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://docs.fileformat.com/web/mhtml). |
| 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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Compression achieved by MP3 file format is 1/10th the size of .WAV or .AIF files. Learn more about this file format [here](https://docs.fileformat.com/audio/mp3). |
| static readonly ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here](https://docs.fileformat.com/presentation/odp). |
| static readonly ODS | OpenDocument Spreadsheet (.ods) Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/ods). |
| static readonly ODT | OpenDocument 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](https://docs.fileformat.com/word-processing/odt). |
| static readonly ONE | OneNote Document (.one) files 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://docs.fileformat.com/note-taking/one). |
| static readonly OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here](https://docs.fileformat.com/presentation/otp). |
| static readonly OTT | OpenDocument Document Template (.ott) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here](https://docs.fileformat.com/word-processing/ott). |
| static readonly PDF | Portable Document Format File (.pdf) isa file format that was to introduced as 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://docs.fileformat.com/view/pdf). |
| static readonly PNG | Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. Learn more about this file format [here](https://docs.fileformat.com/image/png). |
| static readonly POTM | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) |
| static readonly POTX | PowerPoint Open XML Presentation Template (.potx) |
| static readonly PPS | PowerPoint Slide Show (.pps) is a file 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://docs.fileformat.com/presentation/pps). |
| static readonly PPSM | PowerPoint Open XML Macro-Enabled Slide (.ppsm) |
| static readonly PPSX | PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here](https://docs.fileformat.com/presentation/ppsx). |
| static readonly PPT | PowerPoint Presentation (.ppt) 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://docs.fileformat.com/presentation/ppt). |
| static readonly PPTM | PowerPoint Open XML Macro-Enabled Presentation |
| static readonly PPTX | PowerPoint Open XML Presentation (.pptx) is a presentation file 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://docs.fileformat.com/presentation/pptx). |
| static readonly PS | PostScript File (.ps) |
| static readonly RAR | Roshal ARchive Compressed File (.rar) |
| static readonly RTF | Rich Text Format File (.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://docs.fileformat.com/word-processing/rtf). |
| static readonly SevenZ | 7-Zip Compressed File (.7z) |
| static readonly SVG | Scalable Vector Graphics File (.svg) |
| static readonly SVGZ | Scalable Vector Graphics Compressed File (.svgz) |
| static readonly TAR | Consolidated Unix File Archive (.tar) |
| static readonly TEX | LaTeX Source Document (.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://docs.fileformat.com/page-description-language/tex). |
| static readonly TIF | Tagged Image File (.tif) |
| static readonly TIFF | Tagged Image File Format (.tiff) |
| static readonly TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/tsv). |
| static readonly TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format [here](https://docs.fileformat.com/word-processing/txt). |
| static readonly Unknown | Represents unknown file type. |
| static readonly VDX | Visio Drawing XML File (.vdx)is a 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://docs.fileformat.com/image/vdx). |
| static readonly VSD | Visio Drawing File (.vsd) |
| static readonly VSDM | Visio Macro-Enabled Drawing (.vsdm) 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://docs.fileformat.com/image/vsdm). |
| static readonly VSDX | Visio Drawing (.vsdx) represents 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://docs.fileformat.com/image/vsdx). |
| static readonly VSS | Visio Stencil File(.vss) |
| static readonly VSSM | Visio Macro-Enabled Stencil File (.vssm) 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://docs.fileformat.com/image/vssm). |
| static readonly VSSX | Visio Stencil File (.vssx) 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://docs.fileformat.com/image/vssx). |
| static readonly VST | Visio Drawing Template (.vst) |
| static readonly VSTM | Visio Macro-Enabled Drawing Template (.vstm) 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://docs.fileformat.com/image/vstm). |
| static readonly VSTX | Visio Drawing Template (.vstx) 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://docs.fileformat.com/image/vstx). |
| static readonly VSX | Visio Stencil XML File (.vsx) refers 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://docs.fileformat.com/image/vsx). |
| static readonly VTX | Visio Template XML File (.vtx) 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://docs.fileformat.com/image/vtx). |
| 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. The format doesn’t apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. It has been and is one of the standard format for audio CDs. Learn more about this file format [here](https://docs.fileformat.com/audio/wav). |
| static readonly XLAM | Excel Macro-Enabled Add-In (.xlam) |
| static readonly XLS | Excel Spreadsheet (.xls) is a file that 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://docs.fileformat.com/spreadsheet/xls). |
| static readonly XLSB | Excel Binary Spreadsheet (.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://docs.fileformat.com/spreadsheet/xlsb). |
| static readonly XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/xlsm). |
| static readonly XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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://docs.fileformat.com/spreadsheet/xlsx). |
| static readonly XLT | Excel Template File (.xlt) 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://docs.fileformat.com/spreadsheet/xlt). |
| static readonly XLTM | Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) 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://docs.fileformat.com/spreadsheet/xltm). |
| static readonly XLTX | Excel Open XML Spreadsheet Template (.xltx) files 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://docs.fileformat.com/spreadsheet/xltx). |
| static readonly XPS | XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. Learn more about this file format [here](https://docs.fileformat.com/page-description-language/xps). |
| static readonly ZIP | Zipped File (.zip) |

### BMP
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/bmp.md

#### FileType.BMP field

Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. Learn more about this file format [here](https://docs.fileformat.com/image/bmp).

```csharp
public static readonly FileType BMP;
```

### BZ2
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/bz2.md

#### FileType.BZ2 field

Bzip2 Compressed File (.bz2)

```csharp
public static readonly FileType BZ2;
```

### CSV
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/csv.md

#### FileType.CSV field

Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/csv).

```csharp
public static readonly FileType CSV;
```

### DOC
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/doc.md

#### FileType.DOC field

Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here](https://docs.fileformat.com/word-processing/doc).

```csharp
public static readonly FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/docm.md

#### FileType.DOCM field

Word Open XML 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](https://docs.fileformat.com/word-processing/docm).

```csharp
public static readonly FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/docx.md

#### FileType.DOCX field

Microsoft Word Open XML Document (.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://docs.fileformat.com/word-processing/docx).

```csharp
public static readonly FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/dot.md

#### FileType.DOT field

Word Document Template (.dot) files 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://docs.fileformat.com/word-processing/dot).

```csharp
public static readonly FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/dotm.md

#### FileType.DOTM field

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here](https://docs.fileformat.com/word-processing/dotm).

```csharp
public static readonly FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/dotx.md

#### FileType.DOTX field

Word Open XML Document 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](https://docs.fileformat.com/word-processing/dotx).

```csharp
public static readonly FileType DOTX;
```

### EMF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/emf.md

#### FileType.EMF field

Windows Enhanced Metafile (.emf)

```csharp
public static readonly FileType EMF;
```

### EMZ
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/emz.md

#### FileType.EMZ field

Windows Compressed Enhanced Metafile (.emz)

```csharp
public static readonly FileType EMZ;
```

### EPUB
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/epub.md

#### FileType.EPUB field

Open eBook File (.epub) 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://docs.fileformat.com/ebook/epub).

```csharp
public static readonly FileType EPUB;
```

### Equals
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FileType` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

### ERR
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/err.md

#### FileType.ERR field

Error Log File (.err) is a text file that contains error messages generated by a program. Learn more about this file format [here](https://fileinfo.com/extension/err).

```csharp
public static readonly FileType ERR;
```

### Extension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/extension.md

#### FileType.Extension property

Filename suffix (including the period ".") e.g. ".doc".

```csharp
public string Extension { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/fileformat.md

#### FileType.FileFormat property

File type name e.g. "Microsoft Word Document".

```csharp
public string FileFormat { get; }
```

### FromExtension
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/fromextension.md

#### FileType.FromExtension method

Maps file extension to file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension (including the period "."). |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty string. |

### GetHashCode
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns the hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns sequence of supported file types

### GIF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/gif.md

#### FileType.GIF field

Graphical Interchange Format File (.gif)

```csharp
public static readonly FileType GIF;
```

### GZ
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/gz.md

#### FileType.GZ field

G-Zip Compressed File (.gz)

```csharp
public static readonly FileType GZ;
```

### HTML
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/html.md

#### FileType.HTML field

Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. Learn more about this file format [here](https://docs.fileformat.com/web/html).

```csharp
public static readonly FileType HTML;
```

### IsArchive
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/isarchive.md

#### FileType.IsArchive method

Determines whether input `FileType` is archive format.

```csharp
public static bool IsArchive(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The `FileType` object. |

##### Return Value

```csharp
true
```

if input `FileType` is archive format; otherwise,

```csharp
false
```

### IsAudio
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/isaudio.md

#### FileType.IsAudio method

Determines whether input `FileType` is audio format.

```csharp
public static bool IsAudio(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The `FileType` object. |

##### Return Value

```csharp
true
```

if input `FileType` is audio format; otherwise,

```csharp
false
```

### IsImage
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/isimage.md

#### FileType.IsImage method

Determines whether input `FileType` is image format.

```csharp
public static bool IsImage(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The `FileType` object. |

##### Return Value

```csharp
true
```

if input `FileType` is image format; otherwise,

```csharp
false
```

### IsText
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/istext.md

#### FileType.IsText method

Determines whether input `FileType` is primitive text format.

```csharp
public static bool IsText(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The `FileType` object. |

##### Return Value

```csharp
true
```

if input `FileType` is primitive text format; otherwise,

```csharp
false
```

### JPEG
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/jpeg.md

#### FileType.JPEG field

JPEG Image (.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://docs.fileformat.com/image/jpeg).

```csharp
public static readonly FileType JPEG;
```

### JPG
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/jpg.md

#### FileType.JPG field

JPEG Image (.jpg)

```csharp
public static readonly FileType JPG;
```

### MHT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/mht.md

#### FileType.MHT field

MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://docs.fileformat.com/web/mhtml).

```csharp
public static readonly FileType MHT;
```

### MHTML
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/mhtml.md

#### FileType.MHTML field

MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://docs.fileformat.com/web/mhtml).

```csharp
public static readonly FileType MHTML;
```

### MP3
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/mp3.md

#### FileType.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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Compression achieved by MP3 file format is 1/10th the size of .WAV or .AIF files. Learn more about this file format [here](https://docs.fileformat.com/audio/mp3).

```csharp
public static readonly FileType MP3;
```

### ODP
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/odp.md

#### FileType.ODP field

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here](https://docs.fileformat.com/presentation/odp).

```csharp
public static readonly FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ods.md

#### FileType.ODS field

OpenDocument Spreadsheet (.ods) Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/ods).

```csharp
public static readonly FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/odt.md

#### FileType.ODT field

OpenDocument 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](https://docs.fileformat.com/word-processing/odt).

```csharp
public static readonly FileType ODT;
```

### ONE
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/one.md

#### FileType.ONE field

OneNote Document (.one) files 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://docs.fileformat.com/note-taking/one).

```csharp
public static readonly FileType ONE;
```

### op_Equality
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

### OTP
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/otp.md

#### FileType.OTP field

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here](https://docs.fileformat.com/presentation/otp).

```csharp
public static readonly FileType OTP;
```

### OTT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ott.md

#### FileType.OTT field

OpenDocument Document Template (.ott) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here](https://docs.fileformat.com/word-processing/ott).

```csharp
public static readonly FileType OTT;
```

### PDF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/pdf.md

#### FileType.PDF field

Portable Document Format File (.pdf) isa file format that was to introduced as 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://docs.fileformat.com/view/pdf).

```csharp
public static readonly FileType PDF;
```

### PNG
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/png.md

#### FileType.PNG field

Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. Learn more about this file format [here](https://docs.fileformat.com/image/png).

```csharp
public static readonly FileType PNG;
```

### POTM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/potm.md

#### FileType.POTM field

PowerPoint Open XML Macro-Enabled Presentation Template (.potm)

```csharp
public static readonly FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/potx.md

#### FileType.POTX field

PowerPoint Open XML Presentation Template (.potx)

```csharp
public static readonly FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/pps.md

#### FileType.PPS field

PowerPoint Slide Show (.pps) is a file 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://docs.fileformat.com/presentation/pps).

```csharp
public static readonly FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ppsm.md

#### FileType.PPSM field

PowerPoint Open XML Macro-Enabled Slide (.ppsm)

```csharp
public static readonly FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ppsx.md

#### FileType.PPSX field

PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here](https://docs.fileformat.com/presentation/ppsx).

```csharp
public static readonly FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ppt.md

#### FileType.PPT field

PowerPoint Presentation (.ppt) 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://docs.fileformat.com/presentation/ppt).

```csharp
public static readonly FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/pptm.md

#### FileType.PPTM field

PowerPoint Open XML Macro-Enabled Presentation

```csharp
public static readonly FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/pptx.md

#### FileType.PPTX field

PowerPoint Open XML Presentation (.pptx) is a presentation file 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://docs.fileformat.com/presentation/pptx).

```csharp
public static readonly FileType PPTX;
```

### PS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/ps.md

#### FileType.PS field

PostScript File (.ps)

```csharp
public static readonly FileType PS;
```

### RAR
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/rar.md

#### FileType.RAR field

Roshal ARchive Compressed File (.rar)

```csharp
public static readonly FileType RAR;
```

### RTF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/rtf.md

#### FileType.RTF field

Rich Text Format File (.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://docs.fileformat.com/word-processing/rtf).

```csharp
public static readonly FileType RTF;
```

### SevenZ
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/sevenz.md

#### FileType.SevenZ field

7-Zip Compressed File (.7z)

```csharp
public static readonly FileType SevenZ;
```

### SVG
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/svg.md

#### FileType.SVG field

Scalable Vector Graphics File (.svg)

```csharp
public static readonly FileType SVG;
```

### SVGZ
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/svgz.md

#### FileType.SVGZ field

Scalable Vector Graphics Compressed File (.svgz)

```csharp
public static readonly FileType SVGZ;
```

### TAR
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tar.md

#### FileType.TAR field

Consolidated Unix File Archive (.tar)

```csharp
public static readonly FileType TAR;
```

### TEX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tex.md

#### FileType.TEX field

LaTeX Source Document (.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://docs.fileformat.com/page-description-language/tex).

```csharp
public static readonly FileType TEX;
```

### TIF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tif.md

#### FileType.TIF field

Tagged Image File (.tif)

```csharp
public static readonly FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tiff.md

#### FileType.TIFF field

Tagged Image File Format (.tiff)

```csharp
public static readonly FileType TIFF;
```

### ToString
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TSV
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/tsv.md

#### FileType.TSV field

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/tsv).

```csharp
public static readonly FileType TSV;
```

### TXT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/txt.md

#### FileType.TXT field

Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format [here](https://docs.fileformat.com/word-processing/txt).

```csharp
public static readonly FileType TXT;
```

### Unknown
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VDX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vdx.md

#### FileType.VDX field

Visio Drawing XML File (.vdx)is a 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://docs.fileformat.com/image/vdx).

```csharp
public static readonly FileType VDX;
```

### VSD
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vsd.md

#### FileType.VSD field

Visio Drawing File (.vsd)

```csharp
public static readonly FileType VSD;
```

### VSDM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vsdm.md

#### FileType.VSDM field

Visio Macro-Enabled Drawing (.vsdm) 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://docs.fileformat.com/image/vsdm).

```csharp
public static readonly FileType VSDM;
```

### VSDX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vsdx.md

#### FileType.VSDX field

Visio Drawing (.vsdx) represents 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://docs.fileformat.com/image/vsdx).

```csharp
public static readonly FileType VSDX;
```

### VSS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vss.md

#### FileType.VSS field

Visio Stencil File(.vss)

```csharp
public static readonly FileType VSS;
```

### VSSM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vssm.md

#### FileType.VSSM field

Visio Macro-Enabled Stencil File (.vssm) 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://docs.fileformat.com/image/vssm).

```csharp
public static readonly FileType VSSM;
```

### VSSX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vssx.md

#### FileType.VSSX field

Visio Stencil File (.vssx) 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://docs.fileformat.com/image/vssx).

```csharp
public static readonly FileType VSSX;
```

### VST
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vst.md

#### FileType.VST field

Visio Drawing Template (.vst)

```csharp
public static readonly FileType VST;
```

### VSTM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vstm.md

#### FileType.VSTM field

Visio Macro-Enabled Drawing Template (.vstm) 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://docs.fileformat.com/image/vstm).

```csharp
public static readonly FileType VSTM;
```

### VSTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vstx.md

#### FileType.VSTX field

Visio Drawing Template (.vstx) 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://docs.fileformat.com/image/vstx).

```csharp
public static readonly FileType VSTX;
```

### VSX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vsx.md

#### FileType.VSX field

Visio Stencil XML File (.vsx) refers 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://docs.fileformat.com/image/vsx).

```csharp
public static readonly FileType VSX;
```

### VTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/vtx.md

#### FileType.VTX field

Visio Template XML File (.vtx) 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://docs.fileformat.com/image/vtx).

```csharp
public static readonly FileType VTX;
```

### WAV
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/wav.md

#### FileType.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. The format doesn’t apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. It has been and is one of the standard format for audio CDs. Learn more about this file format [here](https://docs.fileformat.com/audio/wav).

```csharp
public static readonly FileType WAV;
```

### XLAM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xlam.md

#### FileType.XLAM field

Excel Macro-Enabled Add-In (.xlam)

```csharp
public static readonly FileType XLAM;
```

### XLS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xls.md

#### FileType.XLS field

Excel Spreadsheet (.xls) is a file that 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://docs.fileformat.com/spreadsheet/xls).

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xlsb.md

#### FileType.XLSB field

Excel Binary Spreadsheet (.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://docs.fileformat.com/spreadsheet/xlsb).

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xlsm.md

#### FileType.XLSM field

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/xlsm).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xlsx.md

#### FileType.XLSX field

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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://docs.fileformat.com/spreadsheet/xlsx).

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xlt.md

#### FileType.XLT field

Excel Template File (.xlt) 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://docs.fileformat.com/spreadsheet/xlt).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xltm.md

#### FileType.XLTM field

Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) 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://docs.fileformat.com/spreadsheet/xltm).

```csharp
public static readonly FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xltx.md

#### FileType.XLTX field

Excel Open XML Spreadsheet Template (.xltx) files 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://docs.fileformat.com/spreadsheet/xltx).

```csharp
public static readonly FileType XLTX;
```

### XPS
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/xps.md

#### FileType.XPS field

XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. Learn more about this file format [here](https://docs.fileformat.com/page-description-language/xps).

```csharp
public static readonly FileType XPS;
```

### ZIP
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.domain/filetype/zip.md

#### FileType.ZIP field

Zipped File (.zip)

```csharp
public static readonly FileType ZIP;
```

### GroupDocs.Merger.Exceptions
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions.md

The namespace provides different classes for exceptions.

#### Classes

| Class | Description |
| --- | --- |
| FileCorruptedException | The exception that is thrown when specified file could not be loaded because it appears to be corrupted. |
| FileTypeNotSupportedException | The exception that is thrown when specified file type is not supported. |
| GroupDocsMergerException | Represents errors that occur during document processing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### FileCorruptedException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/filecorruptedexception.md

#### FileCorruptedException class

The exception that is thrown when specified file could not be loaded because it appears to be corrupted.

```csharp
public class FileCorruptedException : GroupDocsMergerException
```

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The exception that is thrown when specified file type is not supported.

```csharp
public class FileTypeNotSupportedException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| FileTypeNotSupportedException(string) | Initializes a new instance of the `FileTypeNotSupportedException` class. |

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/filetypenotsupportedexception/filetypenotsupportedexception.md

#### FileTypeNotSupportedException constructor

Initializes a new instance of the `FileTypeNotSupportedException` class.

```csharp
public FileTypeNotSupportedException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### GroupDocsMergerException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/groupdocsmergerexception.md

#### GroupDocsMergerException class

Represents errors that occur during document processing.

```csharp
public class GroupDocsMergerException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsMergerException(string) | Initializes a new instance of the `GroupDocsMergerException` class. |
| GroupDocsMergerException(string, Exception) | Initializes a new instance of the `GroupDocsMergerException` class. |

#### Methods

| Name | Description |
| --- | --- |
| static GetException(Exception) | Gets the GroupDocs Merger exception from the input exception. |

### GetException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/groupdocsmergerexception/getexception.md

#### GroupDocsMergerException.GetException method

Gets the GroupDocs Merger exception from the input exception.

```csharp
public static Exception GetException(Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| exception | Exception | The input exception. |

### GroupDocsMergerException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/groupdocsmergerexception/groupdocsmergerexception.md

#### GroupDocsMergerException(string)

Initializes a new instance of the `GroupDocsMergerException` class.

```csharp
public GroupDocsMergerException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### GroupDocsMergerException(string, Exception)

Initializes a new instance of the `GroupDocsMergerException` class.

```csharp
public GroupDocsMergerException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |
| innerException | Exception | The inner exception of the error. |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public class IncorrectPasswordException : GroupDocsMergerException
```

### PasswordRequiredException
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

```csharp
public class PasswordRequiredException : GroupDocsMergerException
```

### GroupDocs.Merger.Logging
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging.md

The namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the console. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging/consolelogger.md

#### ConsoleLogger class

Writes log messages to the console.

```csharp
public class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes error message to the console. Error log messages provides information about unrecoverable events in application flow. |
| Trace(string) | Writes trace message to the console. Trace log messages provides generally useful information about application flow. |
| Warning(string) | Writes warning message to the console. Warning log messages provides information about unexpected and recoverable event in application flow. |

### ConsoleLogger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Writes error message to the console. 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *exception* is null. |

### Trace
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Writes trace message to the console. Trace log messages provides generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Writes warning message to the console. 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### ILogger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.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/merger/net/groupdocs.merger.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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *exception* is null. |

### Trace
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### GroupDocs.Merger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger.md

The namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others.

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing). |
| Merger | Represents the main class that controls the document merging process. |
| MergerSettings | Defines settings for customizing `Merger` behaviour. |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IMerger | Interface for the main class that controls the document merging process. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.merger.dll -->

### IMerger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger.md

#### IMerger interface

Interface for the main class that controls the document merging process.

```csharp
public interface IMerger
```

#### Methods

| Name | Description |
| --- | --- |
| AddPassword(IAddPasswordOptions) | Protects document with password. |
| ChangeOrientation(IOrientationOptions) | Applies a new orientation mode for the specified pages. |
| ExtractPages(IExtractOptions) | Makes a new document with some pages from the source document. |
| ImportDocument(IImportDocumentOptions) | Imports the document as attachment or embedded via Ole. |
| Join(Stream) | Joins the documents into one single document. |
| Join(string) | Joins the documents into one single document. |
| Join(Stream, IImageJoinOptions) | Joins the documents into one single document. |
| Join(Stream, IJoinOptions) | Joins the documents into one single document. |
| Join(Stream, IPageJoinOptions) | Joins the documents into one single document. |
| Join(string, IImageJoinOptions) | Joins the documents into one single document. |
| Join(string, IJoinOptions) | Joins the documents into one single document. |
| Join(string, IPageJoinOptions) | Joins the documents into one single document. |
| MovePage(IMoveOptions) | Moves page to a new position within document of known format. |
| RemovePages(IRemoveOptions) | Removes pages from document of known format. |
| RemovePassword() | Removes password from document. |
| Rotate(IRotateOptions) | Rotate pages of the document. |
| Save(Stream, ISaveOptions) | Saves the result document to the stream *document*. |
| Save(string, ISaveOptions) | Saves the result document file to *filePath*. |
| Save(string, bool, ISaveOptions) | Saves the result document file to *filePath*. |
| Split(ISplitOptions) | Splits the single document to the multiple documents. |
| Split(ITextSplitOptions) | Splits the single document to the multiple documents. |
| SwapPages(ISwapOptions) | Swaps two pages within document of known format. |
| UpdatePassword(IUpdatePasswordOptions) | Updates existing password for document. |

### AddPassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/addpassword.md

#### IMerger.AddPassword method

Protects document with password.

```csharp
public IMerger AddPassword(IAddPasswordOptions addPasswordOptions)
```

### ChangeOrientation
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/changeorientation.md

#### IMerger.ChangeOrientation method

Applies a new orientation mode for the specified pages.

```csharp
public IMerger ChangeOrientation(IOrientationOptions orientationOptions)
```

### ExtractPages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/extractpages.md

#### IMerger.ExtractPages method

Makes a new document with some pages from the source document.

```csharp
public IMerger ExtractPages(IExtractOptions extractOptions)
```

### ImportDocument
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/importdocument.md

#### IMerger.ImportDocument method

Imports the document as attachment or embedded via Ole.

```csharp
public IMerger ImportDocument(IImportDocumentOptions importDocumentOptions)
```

### Join
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/join.md

#### Join(Stream)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document)
```

#### Join(Stream, IJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IJoinOptions joinOptions)
```

#### Join(Stream, IPageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IPageJoinOptions joinOptions)
```

#### Join(Stream, IImageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IImageJoinOptions joinOptions)
```

#### Join(string)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath)
```

#### Join(string, IImageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IImageJoinOptions joinOptions)
```

#### Join(string, IJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IJoinOptions joinOptions)
```

#### Join(string, IPageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IPageJoinOptions joinOptions)
```

### MovePage
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/movepage.md

#### IMerger.MovePage method

Moves page to a new position within document of known format.

```csharp
public IMerger MovePage(IMoveOptions moveOptions)
```

### RemovePages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/removepages.md

#### IMerger.RemovePages method

Removes pages from document of known format.

```csharp
public IMerger RemovePages(IRemoveOptions removeOptions)
```

### RemovePassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/removepassword.md

#### IMerger.RemovePassword method

Removes password from document.

```csharp
public IMerger RemovePassword()
```

### Rotate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/rotate.md

#### IMerger.Rotate method

Rotate pages of the document.

```csharp
public IMerger Rotate(IRotateOptions rotateOptions)
```

### Save
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/save.md

#### Save(Stream, ISaveOptions)

Saves the result document to the stream *document*.

```csharp
public IMerger Save(Stream document, ISaveOptions saveOptions = null)
```

#### Save(string, ISaveOptions)

Saves the result document file to *filePath*.

```csharp
public IMerger Save(string filePath, ISaveOptions saveOptions = null)
```

#### Save(string, bool, ISaveOptions)

Saves the result document file to *filePath*.

```csharp
public IMerger Save(string filePath, bool useDefaultDirectory, ISaveOptions saveOptions = null)
```

### Split
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/split.md

#### Split(ISplitOptions)

Splits the single document to the multiple documents.

```csharp
public IMerger Split(ISplitOptions splitOptions)
```

#### Split(ITextSplitOptions)

Splits the single document to the multiple documents.

```csharp
public IMerger Split(ITextSplitOptions splitOptions)
```

### SwapPages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/swappages.md

#### IMerger.SwapPages method

Swaps two pages within document of known format.

```csharp
public IMerger SwapPages(ISwapOptions swapOptions)
```

### UpdatePassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/imerger/updatepassword.md

#### IMerger.UpdatePassword method

Updates existing password for document.

```csharp
public IMerger UpdatePassword(IUpdatePasswordOptions updatePasswordOptions)
```

### License
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/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. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### License
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/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.Merger.License lic = new GroupDocs.Merger.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.Merger.lic";
GroupDocs.Merger.License lic = new GroupDocs.Merger.License();
lic.SetLicense(licensePath);
```

### Merger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger.md

#### Merger class

Represents the main class that controls the document merging process.

```csharp
public class Merger : IDisposable, IMerger
```

#### Constructors

| Name | Description |
| --- | --- |
| Merger(Func&lt;Stream&gt;) | Initializes new instance of `Merger` class. |
| Merger(Stream) | Initializes new instance of `Merger` class. |
| Merger(string) | Initializes new instance of `Merger` class. |
| Merger(Func&lt;Stream&gt;, ILoadOptions) | Initializes new instance of `Merger` class. |
| Merger(Func&lt;Stream&gt;, MergerSettings) | Initializes new instance of `Merger` class. |
| Merger(Stream, ILoadOptions) | Initializes new instance of `Merger` class. |
| Merger(Stream, MergerSettings) | Initializes new instance of `Merger` class. |
| Merger(string, ILoadOptions) | Initializes new instance of `Merger` class. |
| Merger(string, MergerSettings) | Initializes new instance of `Merger` class. |
| Merger(Func&lt;Stream&gt;, ILoadOptions, MergerSettings) | Initializes new instance of `Merger` class. |
| Merger(Stream, ILoadOptions, MergerSettings) | Initializes new instance of `Merger` class. |
| Merger(string, ILoadOptions, MergerSettings) | Initializes new instance of `Merger` class. |

#### Methods

| Name | Description |
| --- | --- |
| AddPassword(IAddPasswordOptions) | Protects document with password. |
| ApplyPageBuilder(PageBuilder) | Applies page builder changes. |
| ChangeOrientation(IOrientationOptions) | Applies a new orientation mode for the specified pages. |
| CreatePageBuilder(PageBuilderOptions) | Creates a new Page builder with predefined document collection. |
| Dispose() | Disposes resources. |
| ExtractPages(IExtractOptions) | Makes a new document with some pages from the source document. |
| GeneratePreview(IPreviewOptions) | Generates document pages preview. |
| GetDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| ImportDocument(IImportDocumentOptions) | Imports the document as attachment or embedded via Ole. |
| IsPasswordSet() | Checks whether document is password protected. |
| Join(Stream) | Joins the documents into one single document. |
| Join(string) | Joins the documents into one single document. |
| Join(Stream, IImageJoinOptions) | Joins the documents into one single document. |
| Join(Stream, IJoinOptions) | Joins the documents into one single document. |
| Join(Stream, IPageJoinOptions) | Joins the documents into one single document. |
| Join(string, IImageJoinOptions) | Joins the documents into one single document. |
| Join(string, IJoinOptions) | Joins the documents into one single document. |
| Join(string, IPageJoinOptions) | Joins the documents into one single document. |
| MovePage(IMoveOptions) | Moves page to a new position within document of known format. |
| RemovePages(IRemoveOptions) | Removes pages from document of known format. |
| RemovePassword() | Removes password from document. |
| Rotate(IRotateOptions) | Rotate image or pages of the document. |
| Save(Stream, ISaveOptions) | Saves the result document to the stream *document*. |
| Save(string, ISaveOptions) | Saves the result document file to *filePath*. |
| Save(string, bool, ISaveOptions) | Saves the result document file to *filePath*. |
| Split(ISplitOptions) | Splits the single document to the multiple documents. |
| Split(ITextSplitOptions) | Splits the single document to the multiple documents. |
| SwapPages(ISwapOptions) | Swaps two pages within document of known format. |
| UpdatePassword(IUpdatePasswordOptions) | Updates existing password for document. |

### AddPassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/addpassword.md

#### Merger.AddPassword method

Protects document with password.

```csharp
public IMerger AddPassword(IAddPasswordOptions addPasswordOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| addPasswordOptions | IAddPasswordOptions | The options for specifying the password. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *addPasswordOptions* is null. |

### ApplyPageBuilder
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/applypagebuilder.md

#### Merger.ApplyPageBuilder method

Applies page builder changes.

```csharp
public void ApplyPageBuilder(PageBuilder pageBuilder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageBuilder | PageBuilder | The page builder. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pageBuilder* is null. |

### ChangeOrientation
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/changeorientation.md

#### Merger.ChangeOrientation method

Applies a new orientation mode for the specified pages.

```csharp
public IMerger ChangeOrientation(IOrientationOptions orientationOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| orientationOptions | IOrientationOptions | The change orientation options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *orientationOptions* is null. |

### CreatePageBuilder
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/createpagebuilder.md

#### Merger.CreatePageBuilder method

Creates a new Page builder with predefined document collection.

```csharp
public PageBuilder CreatePageBuilder(PageBuilderOptions pageBuilderOptions = null)
```

##### Return Value

The created page builder.

### Dispose
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/dispose.md

#### Merger.Dispose method

Disposes resources.

```csharp
public void Dispose()
```

### ExtractPages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/extractpages.md

#### Merger.ExtractPages method

Makes a new document with some pages from the source document.

```csharp
public IMerger ExtractPages(IExtractOptions extractOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extractOptions | IExtractOptions | The page options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *extractOptions* is null. |

### GeneratePreview
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/generatepreview.md

#### Merger.GeneratePreview method

Generates document pages preview.

```csharp
public void GeneratePreview(IPreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | IPreviewOptions | The preview options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *previewOptions* is null. |

### GetDocumentInfo
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/getdocumentinfo.md

#### Merger.GetDocumentInfo method

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

Information about document properties.

### ImportDocument
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/importdocument.md

#### Merger.ImportDocument method

Imports the document as attachment or embedded via Ole.

```csharp
public IMerger ImportDocument(IImportDocumentOptions importDocumentOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| importDocumentOptions | IImportDocumentOptions | The embedded document import options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *importDocumentOptions* is null. |

### IsPasswordSet
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/ispasswordset.md

#### Merger.IsPasswordSet method

Checks whether document is password protected.

```csharp
public bool IsPasswordSet()
```

##### Return Value

Returns a value indicating whether document is protected or not.

### Join
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/join.md

#### Join(Stream)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Joined document. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |

#### Join(Stream, IJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Joined document. |
| joinOptions | IJoinOptions | The join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

#### Join(Stream, IPageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IPageJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Joined document. |
| joinOptions | IPageJoinOptions | The join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

#### Join(Stream, IImageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(Stream document, IImageJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Joined document. |
| joinOptions | IImageJoinOptions | The image join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

#### Join(string)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path of the joined document. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |

#### Join(string, IJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path of the joined document. |
| joinOptions | IJoinOptions | The join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

#### Join(string, IPageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IPageJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path of the joined document. |
| joinOptions | IPageJoinOptions | The join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

#### Join(string, IImageJoinOptions)

Joins the documents into one single document.

```csharp
public IMerger Join(string filePath, IImageJoinOptions joinOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | File path of the joined document. |
| joinOptions | IImageJoinOptions | The image join options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *joinOptions* is null. |

### Merger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/merger.md

#### Merger(Stream)

Initializes new instance of `Merger` class.

```csharp
public Merger(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The readable stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |

#### Merger(Stream, ILoadOptions)

Initializes new instance of `Merger` class.

```csharp
public Merger(Stream document, ILoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Merger(Stream, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(Stream document, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The readable stream. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Merger(Stream, ILoadOptions, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(Stream document, ILoadOptions loadOptions, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Merger(Func&lt;Stream&gt;)

Initializes new instance of `Merger` class.

```csharp
public Merger(Func<Stream> getFileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |

#### Merger(Func&lt;Stream&gt;, ILoadOptions)

Initializes new instance of `Merger` class.

```csharp
public Merger(Func<Stream> getFileStream, ILoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| loadOptions | ILoadOptions | The document load options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Merger(Func&lt;Stream&gt;, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(Func<Stream> getFileStream, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Merger(Func&lt;Stream&gt;, ILoadOptions, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(Func<Stream> getFileStream, ILoadOptions loadOptions, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Merger(string)

Initializes new instance of `Merger` class.

```csharp
public Merger(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |

#### Merger(string, ILoadOptions)

Initializes new instance of `Merger` class.

```csharp
public Merger(string filePath, ILoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path. |
| loadOptions | ILoadOptions | The document load options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Merger(string, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(string filePath, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Merger(string, ILoadOptions, MergerSettings)

Initializes new instance of `Merger` class.

```csharp
public Merger(string filePath, ILoadOptions loadOptions, MergerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

### MovePage
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/movepage.md

#### Merger.MovePage method

Moves page to a new position within document of known format.

```csharp
public IMerger MovePage(IMoveOptions moveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| moveOptions | IMoveOptions | The move options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *moveOptions* is null. |

### RemovePages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/removepages.md

#### Merger.RemovePages method

Removes pages from document of known format.

```csharp
public IMerger RemovePages(IRemoveOptions removeOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| removeOptions | IRemoveOptions | The options for the numbers of pages to be removed. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *removeOptions* is null. |

### RemovePassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/removepassword.md

#### Merger.RemovePassword method

Removes password from document.

```csharp
public IMerger RemovePassword()
```

### Rotate
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/rotate.md

#### Merger.Rotate method

Rotate image or pages of the document.

```csharp
public IMerger Rotate(IRotateOptions rotateOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rotateOptions | IRotateOptions | The options for the page rotating. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *rotateOptions* is null. |

### Save
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/save.md

#### Save(Stream, ISaveOptions)

Saves the result document to the stream *document*.

```csharp
public IMerger Save(Stream document, ISaveOptions saveOptions = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The document stream. |
| saveOptions | ISaveOptions | The options for saving. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *document* is null. |

#### Save(string, ISaveOptions)

Saves the result document file to *filePath*.

```csharp
public IMerger Save(string filePath, ISaveOptions saveOptions = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file name or full file path. |
| saveOptions | ISaveOptions | The options for saving. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |

#### Save(string, bool, ISaveOptions)

Saves the result document file to *filePath*.

```csharp
public IMerger Save(string filePath, bool useDefaultDirectory, ISaveOptions saveOptions = null)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path or name in case of default directory usage. |
| useDefaultDirectory | Boolean | Use the default directory from settings. |
| saveOptions | ISaveOptions | The options for saving. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *filePath* is null or empty. |

### Split
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/split.md

#### Split(ISplitOptions)

Splits the single document to the multiple documents.

```csharp
public IMerger Split(ISplitOptions splitOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ISplitOptions | The page split options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *splitOptions* is null. |

#### Split(ITextSplitOptions)

Splits the single document to the multiple documents.

```csharp
public IMerger Split(ITextSplitOptions splitOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ITextSplitOptions | The text split options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *splitOptions* is null. |

### SwapPages
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/swappages.md

#### Merger.SwapPages method

Swaps two pages within document of known format.

```csharp
public IMerger SwapPages(ISwapOptions swapOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| swapOptions | ISwapOptions | The swap options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *swapOptions* is null. |

### UpdatePassword
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/merger/updatepassword.md

#### Merger.UpdatePassword method

Updates existing password for document.

```csharp
public IMerger UpdatePassword(IUpdatePasswordOptions updatePasswordOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| updatePasswordOptions | IUpdatePasswordOptions | The options for specifying the current/new passwords. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *updatePasswordOptions* is null. |

### MergerSettings
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/mergersettings.md

#### MergerSettings class

Defines settings for customizing `Merger` behaviour.

```csharp
public class MergerSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| MergerSettings() | Initializes new instance of `MergerSettings` class. |
| MergerSettings(ILogger) | Initializes new instance of `MergerSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| Logger { get; set; } | The logger implementation that is used for tracking document processing workflow. |

### Logger
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/mergersettings/logger.md

#### MergerSettings.Logger property

The logger implementation that is used for tracking document processing workflow.

```csharp
public ILogger Logger { get; set; }
```

### MergerSettings
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/mergersettings/mergersettings.md

#### MergerSettings()

Initializes new instance of `MergerSettings` class.

```csharp
public MergerSettings()
```

#### MergerSettings(ILogger)

Initializes new instance of `MergerSettings` class.

```csharp
public MergerSettings(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | The logger implementation. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *logger* is null. |

### Metered
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/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 amount of used credits |
| static GetConsumptionQuantity() | Retrieves amount of MBs processed. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves amount of used credits

```csharp
public static decimal GetConsumptionCredit()
```

##### 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 usedCredits = Metered.GetConsumptionCredit();
```

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/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/merger/net/groupdocs.merger/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/merger/net/groupdocs.merger/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);
```

## Node.js

### GroupDocs.Merger for Node.js via Java
Path: https://reference.groupdocs.com/merger/nodejs-java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.merger | The **com.groupdocs.merger** namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others.. |
| com.groupdocs.merger.domain | The **com.groupdocs.merger.domain** namespace provides classes for working with document structure. |
| com.groupdocs.merger.domain.builders | The **com.groupdocs.merger.domain.builders** namespace provides builders. |
| com.groupdocs.merger.domain.common | The **com.groupdocs.merger.domain.common** namespace provides common delegates. |
| com.groupdocs.merger.domain.options | The **com.groupdocs.merger.domain.options** namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents. |
| com.groupdocs.merger.domain.options.interfaces | The **com.groupdocs.merger.domain.options.interfaces** namespace provides classes for working with Interfaces. |
| com.groupdocs.merger.domain.result | The **com.groupdocs.merger.domain.result** namespace provides classes which represent document results. |
| com.groupdocs.merger.exceptions | The **com.groupdocs.merger.exceptions** namespace provides classes for exceptions which can occur while working with a document. |
| com.groupdocs.merger.licensing | The **com.groupdocs.merger.licensing** namespace provides methods to license the component. |
| com.groupdocs.merger.licensing.metered | The **com.groupdocs.merger.licensing.metered** namespace provides methods to set metered key. |
| com.groupdocs.merger.logging | The **com.groupdocs.merger.logging** namespace provides classes for customizing logging behaviour. |

### com.groupdocs.merger.domain.builders
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.builders.md

The **com.groupdocs.merger.domain.builders** namespace provides builders.

#### Classes

| Class | Description |
| --- | --- |
| PageBuilder | PageInfo builder for getting the page collection from the documents. |

### PageBuilder
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.builders/pagebuilder.md

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

PageInfo builder for getting the page collection from the documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageBuilder() | Initializes a new instance of the PageBuilder class. |
| PageBuilder(PageBuilderOptions options) | Initializes a new instance of the PageBuilder class. |
#### Methods

| Method | Description |
| --- | --- |
| getOptions() | The page builder options. |
| getPages() | The page collection. |
| getDocuments() | The document collection. |
| addDocument(int index, InputStream stream, FileType fileType, String password) | Add document to the document collection. |
| addDocument(DocumentInfo document) | Add document to the document collection. |
| addPage(int documentIndex, int pageNumber) | Add page to the page collection. |
| addPage(IPageInfo page) | Add page to the page collection. |
| addPageRange(IPageInfo[] pages) | Add pages to the page collection. |
| clear() | Clear the internal collections. |
##### PageBuilder()
```
public PageBuilder()
```

Initializes a new instance of the PageBuilder class.

##### PageBuilder(PageBuilderOptions options)
```
public PageBuilder(PageBuilderOptions options)
```

Initializes a new instance of the PageBuilder class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageBuilderOptions | The page builder options. |

##### getOptions()
```
public final PageBuilderOptions getOptions()
```

The page builder options.

**Returns:**
PageBuilderOptions
##### getPages()
```
public final List<PageInfo> getPages()
```

The page collection.

**Returns:**
java.util.List<com.groupdocs.merger.domain.result.PageInfo>
##### getDocuments()
```
public final Map<Integer,DocumentInfo> getDocuments()
```

The document collection.

**Returns:**
java.util.Map<java.lang.Integer,com.groupdocs.merger.domain.result.DocumentInfo>
##### addDocument(int index, InputStream stream, FileType fileType, String password)
```
public final void addDocument(int index, InputStream stream, FileType fileType, String password)
```

Add document to the document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | DocumentInfo index. |
| stream | java.io.InputStream | DocumentInfo stream. |
| fileType | FileType | DocumentInfo type. |
| password | java.lang.String | DocumentInfo password. |

##### addDocument(DocumentInfo document)
```
public final void addDocument(DocumentInfo document)
```

Add document to the document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | DocumentInfo | DocumentInfo instance. |

##### addPage(int documentIndex, int pageNumber)
```
public final void addPage(int documentIndex, int pageNumber)
```

Add page to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentIndex | int | DocumentInfo index. |
| pageNumber | int | PageInfo number. |

##### addPage(IPageInfo page)
```
public final void addPage(IPageInfo page)
```

Add page to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| page | IPageInfo | PageInfo instance. |

##### addPageRange(IPageInfo[] pages)
```
public final void addPageRange(IPageInfo[] pages)
```

Add pages to the page collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pages | IPageInfo\[\] | Pages array. |

##### clear()
```
public final void clear()
```

Clear the internal collections.

### com.groupdocs.merger.domain.common
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.common.md

The **com.groupdocs.merger.domain.common** namespace provides common delegates.

#### Interfaces

| Interface | Description |
| --- | --- |
| PageStreamFactory | Interface that defines method to create output page preview stream. |
| SplitStreamFactory | Interface that defines method to create output split stream. |

### PageStreamFactory
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.common/pagestreamfactory.md

### SplitStreamFactory
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.common/splitstreamfactory.md

### com.groupdocs.merger.domain.options.interfaces
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces.md

The **com.groupdocs.merger.domain.options.interfaces** namespace provides classes for working with Interfaces.

#### Interfaces

| Interface | Description |
| --- | --- |
| IAddPasswordOptions | Interface for the password adding options. |
| IExtractOptions | Interface for options to extract the document pages. |
| IImageJoinOptions | Interface for the image joining options. |
| IImportDocumentOptions | Interface for import of the embedded document. |
| IJoinOptions | Interface for the document joining options. |
| ILoadOptions | Interface for the document loading options. |
| IMoveOptions | Interface for the moving page options. |
| IOleDiagramOptions | Interface for import options of the embedded document to Diagram via OLE. |
| IOlePresentationOptions | Interface for import options of the embedded document to Presentation via OLE. |
| IOleSpreadsheetOptions | Interface for import options of the embedded document to Spreadsheet via OLE. |
| IOleWordProcessingOptions | Interface for import options of the embedded document to Word processing via OLE. |
| IOptions | Interface for the base options. |
| IOrientationOptions | Interface for the page orientation options. |
| IPageBuilderOptions | Interface for the page builder options |
| IPageJoinOptions | Interface for the document page joining options. |
| IPageOptions | Interface for the page options |
| IPager | Interface for apply option (pages, range and etc.) |
| IPdfAttachmentOptions | Interface for options of the embedded document to PDF as attachment. |
| IPreviewOptions | Interface for the preview options. |
| IRemoveOptions | Interface for the page removing options. |
| IRotateOptions | Interface for the page rotating options. |
| ISaveOptions | Interface for the document saving options. |
| ISizeOptions | Interface for adding embedded object. |
| ISplitOptions | Interface for the splitting options. |
| ISwapOptions | Interface for the page swapping options. |
| ITextSplitOptions | Interface for the text splitting options. |
| IUpdatePasswordOptions | Interface for the password updating options. |

### IAddPasswordOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iaddpasswordoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IAddPasswordOptions extends IOptions
```

Interface for the password adding options.
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | The password for document protection. |
##### getPassword()
```
public abstract String getPassword()
```

The password for document protection.

**Returns:**
java.lang.String

### IExtractOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iextractoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IExtractOptions extends IPageOptions
```

Interface for options to extract the document pages.

### IImageJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iimagejoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public interface IImageJoinOptions extends IJoinOptions
```

Interface for the image joining options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | The image join mode. |
##### getMode()
```
public abstract int getMode()
```

The image join mode.

**Returns:**
int

### IImportDocumentOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iimportdocumentoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IImportDocumentOptions extends IOptions
```

Interface for import of the embedded document.
#### Methods

| Method | Description |
| --- | --- |
| getObjectData() | The data of the embedded object. |
| getExtension() | The extension of the embedded object. |
| getPageNumber() | The page number for inserting of the embedded object. |
##### getObjectData()
```
public abstract byte[] getObjectData()
```

The data of the embedded object.

**Returns:**
byte[]
##### getExtension()
```
public abstract String getExtension()
```

The extension of the embedded object.

**Returns:**
java.lang.String
##### getPageNumber()
```
public abstract int getPageNumber()
```

The page number for inserting of the embedded object.

**Returns:**
int

### IJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ijoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IJoinOptions extends IOptions
```

Interface for the document joining options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### getType()
```
public abstract FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### ILoadOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iloadoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ILoadOptions extends IOptions
```

Interface for the document loading options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to open. |
| getPassword() | The password for opening password-protected file. |
| getExtension() | The extension of the file to open. |
| getEncoding() | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
##### getType()
```
public abstract FileType getType()
```

The type of the file to open.

**Returns:**
FileType
##### getPassword()
```
public abstract String getPassword()
```

The password for opening password-protected file.

**Returns:**
java.lang.String
##### getExtension()
```
public abstract String getExtension()
```

The extension of the file to open.

**Returns:**
java.lang.String
##### getEncoding()
```
public abstract Charset getEncoding()
```

The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is [DefaultCharset][].

[DefaultCharset]: https://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html#defaultCharset%28%29

**Returns:**
java.nio.charset.Charset

### IMoveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/imoveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IMoveOptions extends IOptions
```

Interface for the moving page options.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumberToMove() | Gets or sets the page number to move. |
| getNewPageNumber() | Gets or sets the new page number. |
##### getPageNumberToMove()
```
public abstract int getPageNumberToMove()
```

Gets or sets the page number to move.

Value: The page number to move.

**Returns:**
int
##### getNewPageNumber()
```
public abstract int getNewPageNumber()
```

Gets or sets the new page number.

Value: The new page number.

**Returns:**
int

### IOleDiagramOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iolediagramoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleDiagramOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Diagram via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setX(int value) | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getY() | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setY(int value) | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getImageData() | The image data of the embedded object. |
##### getX()
```
public abstract int getX()
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

**Returns:**
int
##### setX(int value)
```
public abstract void setX(int value)
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getY()
```
public abstract int getY()
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

**Returns:**
int
##### setY(int value)
```
public abstract void setY(int value)
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The image data of the embedded object.

**Returns:**
byte[]

### IOlePresentationOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iolepresentationoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOlePresentationOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Presentation via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object frame. |
| setX(int value) | The X coordinate of the embedded object frame. |
| getY() | The Y coordinate of the embedded object frame. |
| setY(int value) | The Y coordinate of the embedded object frame. |
##### getX()
```
public abstract int getX()
```

The X coordinate of the embedded object frame.

**Returns:**
int
##### setX(int value)
```
public abstract void setX(int value)
```

The X coordinate of the embedded object frame.

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

##### getY()
```
public abstract int getY()
```

The Y coordinate of the embedded object frame.

**Returns:**
int
##### setY(int value)
```
public abstract void setY(int value)
```

The Y coordinate of the embedded object frame.

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

### IOleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iolespreadsheetoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleSpreadsheetOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Spreadsheet via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getRowIndex() | The upper left row index. |
| setRowIndex(int value) | The upper left row index. |
| getColumnIndex() | The upper left column index. |
| setColumnIndex(int value) | The upper left column index. |
| getImageData() | The data of the Ole object image. |
##### getRowIndex()
```
public abstract int getRowIndex()
```

The upper left row index.

**Returns:**
int
##### setRowIndex(int value)
```
public abstract void setRowIndex(int value)
```

The upper left row index.

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

##### getColumnIndex()
```
public abstract int getColumnIndex()
```

The upper left column index.

**Returns:**
int
##### setColumnIndex(int value)
```
public abstract void setColumnIndex(int value)
```

The upper left column index.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### IOleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iolewordprocessingoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions, com.groupdocs.merger.domain.options.interfaces.ISizeOptions
```
public interface IOleWordProcessingOptions extends IImportDocumentOptions, ISizeOptions
```

Interface for import options of the embedded document to Word processing via OLE.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | The left coordinate of the Ole object image. |
| setLeft(int value) | The left coordinate of the Ole object image. |
| getTop() | The top coordinate of the Ole object image. |
| setTop(int value) | The top coordinate of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### getLeft()
```
public abstract int getLeft()
```

The left coordinate of the Ole object image.

**Returns:**
int
##### setLeft(int value)
```
public abstract void setLeft(int value)
```

The left coordinate of the Ole object image.

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

##### getTop()
```
public abstract int getTop()
```

The top coordinate of the Ole object image.

**Returns:**
int
##### setTop(int value)
```
public abstract void setTop(int value)
```

The top coordinate of the Ole object image.

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

##### getImageData()
```
public abstract byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### IOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ioptions.md

### IOrientationOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iorientationoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IOrientationOptions extends IPageOptions
```

Interface for the page orientation options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for the page orientation. |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for the page orientation.

**Returns:**
int

### IPageBuilderOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipagebuilderoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IPageBuilderOptions extends IOptions
```

Interface for the page builder options
#### Methods

| Method | Description |
| --- | --- |
| getLoadDocumentInfo() | Specifies if each document info should load all its pages info. |
| setLoadDocumentInfo(boolean value) | Specifies if each document info should load all its pages info. |
##### getLoadDocumentInfo()
```
public abstract boolean getLoadDocumentInfo()
```

Specifies if each document info should load all its pages info.

**Returns:**
boolean
##### setLoadDocumentInfo(boolean value)
```
public abstract void setLoadDocumentInfo(boolean value)
```

Specifies if each document info should load all its pages info.

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

### IPageJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipagejoinoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions, com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public interface IPageJoinOptions extends IPageOptions, IJoinOptions
```

Interface for the document page joining options.

### IPageOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipageoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IPageOptions extends IOptions
```

Interface for the page options
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Page numbers for the page options. |
##### getPages()
```
public abstract int[] getPages()
```

Page numbers for the page options.

**Returns:**
int[]

### IPager
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipager.md

### IPdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipdfattachmentoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions
```
public interface IPdfAttachmentOptions extends IImportDocumentOptions
```

Interface for options of the embedded document to PDF as attachment.

### IPreviewOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/ipreviewoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IPreviewOptions extends IPageOptions
```

Interface for the preview options.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Preview width. |
| setWidth(int value) | Preview width. |
| getHeight() | Preview height. |
| setHeight(int value) | Preview height. |
| getResolution() | Image resolution. |
| setResolution(int value) | Image resolution. |
| getMode() | Gets the mode for preview. |
| validate(FileType fileType) | Validates the split options. |
| getPathByPageNumber(int pageNumber, String extension) | Gets the full file path of previewed document by page number with defined extension. |
| getPageStreamFactory() | Delegate that defines method to create output page preview stream. |
##### getWidth()
```
public abstract int getWidth()
```

Preview width.

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

Preview width.

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

##### getHeight()
```
public abstract int getHeight()
```

Preview height.

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

Preview height.

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

##### getResolution()
```
public abstract int getResolution()
```

Image resolution.

**Returns:**
int
##### setResolution(int value)
```
public abstract void setResolution(int value)
```

Image resolution.

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

##### getMode()
```
public abstract int getMode()
```

Gets the mode for preview.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByPageNumber(int pageNumber, String extension)
```
public abstract String getPathByPageNumber(int pageNumber, String extension)
```

Gets the full file path of previewed document by page number with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | Page number of preview. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getPageStreamFactory()
```
public abstract PageStreamFactory getPageStreamFactory()
```

Delegate that defines method to create output page preview stream.

**Returns:**
PageStreamFactory

### IRemoveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iremoveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IRemoveOptions extends IPageOptions
```

Interface for the page removing options.

### IRotateOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/irotateoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface IRotateOptions extends IPageOptions
```

Interface for the page rotating options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for rotating (90, 180 or 270 degrees). |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for rotating (90, 180 or 270 degrees).

**Returns:**
int

### ISaveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/isaveoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ISaveOptions extends IOptions
```

Interface for the document saving options.
#### Methods

| Method | Description |
| --- | --- |
| getType() | File type. |
##### getType()
```
public abstract FileType getType()
```

File type.

**Returns:**
FileType

### ISizeOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/isizeoptions.md

### ISplitOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/isplitoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public interface ISplitOptions extends IPageOptions
```

Interface for the splitting options.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for page splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | Delegate that defines method to create output split stream. |
##### getMode()
```
public abstract int getMode()
```

Gets the mode for page splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public abstract String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public abstract SplitStreamFactory getSplitStreamFactory()
```

Delegate that defines method to create output split stream.

**Returns:**
SplitStreamFactory

### ISwapOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iswapoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ISwapOptions extends IOptions
```

Interface for the page swapping options.
#### Methods

| Method | Description |
| --- | --- |
| getFirstPageNumber() | First page number to exchange. |
| getSecondPageNumber() | Second page number to exchange. |
##### getFirstPageNumber()
```
public abstract int getFirstPageNumber()
```

First page number to exchange.

**Returns:**
int
##### getSecondPageNumber()
```
public abstract int getSecondPageNumber()
```

Second page number to exchange.

**Returns:**
int

### ITextSplitOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/itextsplitoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface ITextSplitOptions extends IOptions
```

Interface for the text splitting options.
#### Methods

| Method | Description |
| --- | --- |
| getLineNumbers() | Line numbers for text splitting. |
| getMode() | Mode for text splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | Delegate that defines method to create output split stream. |
##### getLineNumbers()
```
public abstract int[] getLineNumbers()
```

Line numbers for text splitting.

**Returns:**
int[]
##### getMode()
```
public abstract int getMode()
```

Mode for text splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public abstract void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public abstract String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public abstract SplitStreamFactory getSplitStreamFactory()
```

Delegate that defines method to create output split stream.

**Returns:**
SplitStreamFactory

### IUpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.interfaces/iupdatepasswordoptions.md

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOptions
```
public interface IUpdatePasswordOptions extends IOptions
```

Interface for the password updating options.
#### Methods

| Method | Description |
| --- | --- |
| getNewPassword() | The new password for document protection. |
##### getNewPassword()
```
public abstract String getNewPassword()
```

The new password for document protection.

**Returns:**
java.lang.String

### com.groupdocs.merger.domain.options
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options.md

The **com.groupdocs.merger.domain.options** namespace provides classes to specify additional options when loading, joining, splitting, previewing and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| AddPasswordOptions | Provides options for adding document password. |
| ExtractOptions | Provides options to extract the document pages. |
| ImageJoinMode | Possible modes for the image joining. |
| ImageJoinOptions | The image join options. |
| ImportDocumentOptions | Provides options for the embedded document import. |
| JoinOptions | Provides options for the document joining. |
| LoadOptions | Provides options for the document loading. |
| MoveOptions | Provides options for moving document page. |
| OleDiagramOptions | Provides options for import of the embedded document to Diagram via OLE. |
| OlePresentationOptions | Provides options for import of the embedded document to Presentation via OLE. |
| OleSpreadsheetOptions | Provides options for import of the embedded document to Spreadsheet via OLE. |
| OleWordProcessingOptions | Provides options for import of the embedded document to Word processing via OLE. |
| OrientationMode | Defines page orientation. |
| OrientationOptions | Provides options for the page orientation. |
| PageBuilderOptions | Provides options for specifying the page builder. |
| PageJoinOptions | Provides options for the document joining. |
| PageOptions | Provides options for specifying page or pages range. |
| PdfAttachmentOptions | Provides options to attach the embedded object to Pdf. |
| PreviewMode | Provides modes for the page previewing. |
| PreviewOptions | Represents document preview options. |
| RangeMode | Possible modes for the page ranging. |
| RemoveOptions | Provides options for the page removing. |
| RotateMode | Possible modes for the page rotation. |
| RotateOptions | Provides options for the page rotation. |
| SaveOptions | Provides options for the document saving. |
| SplitMode | Defines page splitting modes. |
| SplitOptions | Provides options for the document page splitting. |
| SwapOptions | Provides options for swapping document pages. |
| TextSplitMode | Possible text splitting modes. |
| TextSplitOptions | Provides options for the document text splitting. |
| UpdatePasswordOptions | Provides options for updating document password. |
| WordJoinCompliance | Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc. |
| WordJoinMode | Possible modes for the Word joining. |
| WordJoinOptions | The Word join options. |

### AddPasswordOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/addpasswordoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IAddPasswordOptions
```
public class AddPasswordOptions implements IAddPasswordOptions
```

Provides options for adding document password.
#### Constructors

| Constructor | Description |
| --- | --- |
| AddPasswordOptions(String password) | Initializes a new instance of the AddPasswordOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | The password for document protection. |
##### AddPasswordOptions(String password)
```
public AddPasswordOptions(String password)
```

Initializes a new instance of the AddPasswordOptions class.

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

##### getPassword()
```
public final String getPassword()
```

The password for document protection.

**Returns:**
java.lang.String

### ExtractOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/extractoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IExtractOptions
```
public class ExtractOptions extends PageOptions implements IExtractOptions
```

Provides options to extract the document pages.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExtractOptions() | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int[] pageNumbers) | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int startNumber, int endNumber) | Initializes a new instance of the ExtractOptions class. |
| ExtractOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the ExtractOptions class. |
##### ExtractOptions()
```
public ExtractOptions()
```

Initializes a new instance of the ExtractOptions class.

##### ExtractOptions(int[] pageNumbers)
```
public ExtractOptions(int[] pageNumbers)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### ExtractOptions(int startNumber, int endNumber)
```
public ExtractOptions(int startNumber, int endNumber)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### ExtractOptions(int startNumber, int endNumber, int mode)
```
public ExtractOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the ExtractOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

### ImageJoinMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/imagejoinmode.md

**Inheritance:**
java.lang.Object
```
public final class ImageJoinMode
```

Possible modes for the image joining.
#### Fields

| Field | Description |
| --- | --- |
| Horizontal | Specifies Horizontal image joining. |
| Vertical | Specifies Vertical image joining. |
##### Horizontal
```
public static final int Horizontal
```

Specifies Horizontal image joining.

##### Vertical
```
public static final int Vertical
```

Specifies Vertical image joining.

### ImageJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/imagejoinoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImageJoinOptions
```
public class ImageJoinOptions implements IImageJoinOptions
```

The image join options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageJoinOptions() | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(FileType fileType) | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(int imageJoinMode) | Initializes new instance of ImageJoinOptions class. |
| ImageJoinOptions(FileType fileType, int imageJoinMode) | Initializes new instance of ImageJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The image file type. |
| getMode() | The image join mode. |
##### ImageJoinOptions()
```
public ImageJoinOptions()
```

Initializes new instance of ImageJoinOptions class.

##### ImageJoinOptions(FileType fileType)
```
public ImageJoinOptions(FileType fileType)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |

##### ImageJoinOptions(int imageJoinMode)
```
public ImageJoinOptions(int imageJoinMode)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageJoinMode | int | The image join mode. |

##### ImageJoinOptions(FileType fileType, int imageJoinMode)
```
public ImageJoinOptions(FileType fileType, int imageJoinMode)
```

Initializes new instance of ImageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The image file type. |
| imageJoinMode | int | The image join mode. |

##### getType()
```
public final FileType getType()
```

The image file type.

**Returns:**
FileType
##### getMode()
```
public final int getMode()
```

The image join mode.

**Returns:**
int

### ImportDocumentOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/importdocumentoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IImportDocumentOptions
```
public abstract class ImportDocumentOptions implements IImportDocumentOptions
```

Provides options for the embedded document import.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportDocumentOptions(byte[] objectData, String extension, int pageNumber) | Initializes a new instance of the ImportDocumentOptions class. |
| ImportDocumentOptions(String filePath, int pageNumber) | Initializes a new instance of the ImportDocumentOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getObjectData() | The data of the embedded object. |
| getExtension() | The extension of the embedded object. |
| getPageNumber() | The page number for inserting of the embedded object. |
| getImageData(String filePath) | Gets image data of the embedded object. |
##### ImportDocumentOptions(byte[] objectData, String extension, int pageNumber)
```
public ImportDocumentOptions(byte[] objectData, String extension, int pageNumber)
```

Initializes a new instance of the ImportDocumentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### ImportDocumentOptions(String filePath, int pageNumber)
```
public ImportDocumentOptions(String filePath, int pageNumber)
```

Initializes a new instance of the ImportDocumentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getObjectData()
```
public final byte[] getObjectData()
```

The data of the embedded object.

**Returns:**
byte[]
##### getExtension()
```
public final String getExtension()
```

The extension of the embedded object.

**Returns:**
java.lang.String
##### getPageNumber()
```
public final int getPageNumber()
```

The page number for inserting of the embedded object.

**Returns:**
int
##### getImageData(String filePath)
```
public final byte[] getImageData(String filePath)
```

Gets image data of the embedded object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |

**Returns:**
byte[]

### JoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/joinoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IJoinOptions
```
public class JoinOptions implements IJoinOptions
```

Provides options for the document joining.
#### Constructors

| Constructor | Description |
| --- | --- |
| JoinOptions() | Initializes a new instance of the JoinOptions class. |
| JoinOptions(FileType fileType) | Initializes a new instance of the JoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### JoinOptions()
```
public JoinOptions()
```

Initializes a new instance of the JoinOptions class.

##### JoinOptions(FileType fileType)
```
public JoinOptions(FileType fileType)
```

Initializes a new instance of the JoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### getType()
```
public final FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### LoadOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/loadoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ILoadOptions
```
public class LoadOptions implements ILoadOptions
```

Provides options for the document loading.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions(FileType fileType) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(String extension, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType, String password) | Initializes new instance of LoadOptions class. |
| LoadOptions(FileType iniFileType, FileType fileType) | Initializes new instance of LoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to load. |
| getExtension() | The extension of the file to init. |
| getPassword() | The password for opening password-protected file. |
| getEncoding() | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |
##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(String password, Charset encoding)
```
public LoadOptions(String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType fileType, String password)
```
public LoadOptions(FileType fileType, String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(FileType fileType, String password, Charset encoding)
```
public LoadOptions(FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(String extension, FileType fileType, String password, Charset encoding)
```
public LoadOptions(String extension, FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The extension of the file to load. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding)
```
public LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |
| encoding | java.nio.charset.Charset | The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. |

##### LoadOptions(FileType iniFileType, FileType fileType, String password)
```
public LoadOptions(FileType iniFileType, FileType fileType, String password)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |
| password | java.lang.String | The password for opening password-protected file. |

##### LoadOptions(FileType iniFileType, FileType fileType)
```
public LoadOptions(FileType iniFileType, FileType fileType)
```

Initializes new instance of LoadOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| iniFileType | FileType | The type of the file to init. |
| fileType | FileType | The type of the file to load. |

##### getType()
```
public final FileType getType()
```

The type of the file to load.

**Returns:**
FileType
##### getExtension()
```
public final String getExtension()
```

The extension of the file to init.

**Returns:**
java.lang.String
##### getPassword()
```
public final String getPassword()
```

The password for opening password-protected file.

**Returns:**
java.lang.String
##### getEncoding()
```
public final Charset getEncoding()
```

The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is  System.Text.Encoding.Default (java.nio.charset.Charset).

**Returns:**
java.nio.charset.Charset

### MoveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/moveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IMoveOptions
```
public class MoveOptions implements IMoveOptions
```

Provides options for moving document page.
#### Constructors

| Constructor | Description |
| --- | --- |
| MoveOptions(int pageNumberToMove, int newPageNumber) | Initializes a new instance of the MoveOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumberToMove() | Gets or sets the page number to move. |
| getNewPageNumber() | Gets or sets the new page number. |
##### MoveOptions(int pageNumberToMove, int newPageNumber)
```
public MoveOptions(int pageNumberToMove, int newPageNumber)
```

Initializes a new instance of the MoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumberToMove | int | The page number to move. |
| newPageNumber | int | The new page number. |

##### getPageNumberToMove()
```
public final int getPageNumberToMove()
```

Gets or sets the page number to move.

Value: The page number to move.

**Returns:**
int
##### getNewPageNumber()
```
public final int getNewPageNumber()
```

Gets or sets the new page number.

Value: The new page number.

**Returns:**
int

### OleDiagramOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/olediagramoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleDiagramOptions
```
public class OleDiagramOptions extends ImportDocumentOptions implements IOleDiagramOptions
```

Provides options for import of the embedded document to Diagram via OLE.

[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
| OleDiagramOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
| OleDiagramOptions(String filePath, int pageNumber) | Initializes a new instance of the OleDiagramOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setX(int value) | The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getY() | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| setY(int value) | The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page. |
| getWidth() | The width of the embedded object shape in inches. |
| setWidth(int value) | The width of the embedded object shape in inches. |
| getHeight() | The height of the embedded object shape in inches. |
| setHeight(int value) | The height of the embedded object shape in inches. |
| getImageData() | The image data of the embedded object. |
##### OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleDiagramOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleDiagramOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleDiagramOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleDiagramOptions(String filePath, int pageNumber)
```
public OleDiagramOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleDiagramOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getX()
```
public final int getX()
```

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

The X coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

##### getY()
```
public final int getY()
```

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

The Y coordinate of the embedded object shape's pin (center of rotation) in relation to the page.

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

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

The width of the embedded object shape in inches.

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

The width of the embedded object shape in inches.

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

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

The height of the embedded object shape in inches.

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

The height of the embedded object shape in inches.

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

##### getImageData()
```
public final byte[] getImageData()
```

The image data of the embedded object.

**Returns:**
byte[]

### OlePresentationOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/olepresentationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOlePresentationOptions
```
public class OlePresentationOptions extends ImportDocumentOptions implements IOlePresentationOptions
```

Provides options for import of the embedded document to Presentation via OLE.

[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OlePresentationOptions(byte[] objectData, String extension, int pageNumber) | Initializes a new instance of the OlePresentationOptions class. |
| OlePresentationOptions(String filePath, int pageNumber) | Initializes a new instance of the OlePresentationOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getX() | The X coordinate of the embedded object frame. |
| setX(int value) | The X coordinate of the embedded object frame. |
| getY() | The Y coordinate of the embedded object frame. |
| setY(int value) | The Y coordinate of the embedded object frame. |
| getWidth() | The width of the embedded object frame. |
| setWidth(int value) | The width of the embedded object frame. |
| getHeight() | The height of the embedded object frame. |
| setHeight(int value) | The height of the embedded object frame. |
##### OlePresentationOptions(byte[] objectData, String extension, int pageNumber)
```
public OlePresentationOptions(byte[] objectData, String extension, int pageNumber)
```

Initializes a new instance of the OlePresentationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OlePresentationOptions(String filePath, int pageNumber)
```
public OlePresentationOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OlePresentationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getX()
```
public final int getX()
```

The X coordinate of the embedded object frame.

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

The X coordinate of the embedded object frame.

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

##### getY()
```
public final int getY()
```

The Y coordinate of the embedded object frame.

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

The Y coordinate of the embedded object frame.

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

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

The width of the embedded object frame.

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

The width of the embedded object frame.

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

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

The height of the embedded object frame.

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

The height of the embedded object frame.

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

### OleSpreadsheetOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/olespreadsheetoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleSpreadsheetOptions
```
public class OleSpreadsheetOptions extends ImportDocumentOptions implements IOleSpreadsheetOptions
```

Provides options for import of the embedded document to Spreadsheet via OLE.

[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
| OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
| OleSpreadsheetOptions(String filePath, int pageNumber) | Initializes a new instance of the OleSpreadsheetOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getRowIndex() | The upper left row index. |
| setRowIndex(int value) | The upper left row index. |
| getColumnIndex() | The upper left column index. |
| setColumnIndex(int value) | The upper left column index. |
| getWidth() | The width of the Ole object image. |
| setWidth(int value) | The width of the Ole object image. |
| getHeight() | The height of the Ole object image. |
| setHeight(int value) | The height of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleSpreadsheetOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleSpreadsheetOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleSpreadsheetOptions(String filePath, int pageNumber)
```
public OleSpreadsheetOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleSpreadsheetOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getRowIndex()
```
public final int getRowIndex()
```

The upper left row index.

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

The upper left row index.

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

##### getColumnIndex()
```
public final int getColumnIndex()
```

The upper left column index.

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

The upper left column index.

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

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

The width of the Ole object image.

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

The width of the Ole object image.

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

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

The height of the Ole object image.

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

The height of the Ole object image.

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

##### getImageData()
```
public final byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### OleWordProcessingOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/olewordprocessingoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOleWordProcessingOptions
```
public class OleWordProcessingOptions extends ImportDocumentOptions implements IOleWordProcessingOptions
```

Provides options for import of the embedded document to Word processing via OLE.

[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
#### Constructors

| Constructor | Description |
| --- | --- |
| OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
| OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
| OleWordProcessingOptions(String filePath, int pageNumber) | Initializes a new instance of the OleWordProcessingOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | The left coordinate of the Ole object image. |
| setLeft(int value) | The left coordinate of the Ole object image. |
| getTop() | The top coordinate of the Ole object image. |
| setTop(int value) | The top coordinate of the Ole object image. |
| getWidth() | The width of the Ole object image. |
| setWidth(int value) | The width of the Ole object image. |
| getHeight() | The height of the Ole object image. |
| setHeight(int value) | The height of the Ole object image. |
| getImageData() | The data of the Ole object image. |
##### OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```
public OleWordProcessingOptions(byte[] objectData, byte[] imageData, String extension, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber)
```
public OleWordProcessingOptions(String filePath, byte[] imageData, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| imageData | byte[] | The image data of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### OleWordProcessingOptions(String filePath, int pageNumber)
```
public OleWordProcessingOptions(String filePath, int pageNumber)
```

Initializes a new instance of the OleWordProcessingOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |
| pageNumber | int | The page number for adding embedded object. |

##### getLeft()
```
public final int getLeft()
```

The left coordinate of the Ole object image.

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

The left coordinate of the Ole object image.

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

##### getTop()
```
public final int getTop()
```

The top coordinate of the Ole object image.

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

The top coordinate of the Ole object image.

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

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

The width of the Ole object image.

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

The width of the Ole object image.

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

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

The height of the Ole object image.

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

The height of the Ole object image.

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

##### getImageData()
```
public final byte[] getImageData()
```

The data of the Ole object image.

**Returns:**
byte[]

### OrientationMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/orientationmode.md

**Inheritance:**
java.lang.Object
```
public final class OrientationMode
```

Defines page orientation.
#### Fields

| Field | Description |
| --- | --- |
| Portrait | Portrait page mode. |
| Landscape | Landscape page mode. |
##### Portrait
```
public static final int Portrait
```

Portrait page mode.

##### Landscape
```
public static final int Landscape
```

Landscape page mode.

### OrientationOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/orientationoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IOrientationOptions
```
public class OrientationOptions extends PageOptions implements IOrientationOptions
```

Provides options for the page orientation.
#### Constructors

| Constructor | Description |
| --- | --- |
| OrientationOptions(int orientationMode) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int[] pageNumbers) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int startNumber, int endNumber) | Initializes a new instance of the OrientationOptions class. |
| OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the OrientationOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for the page orientation. |
##### OrientationOptions(int orientationMode)
```
public OrientationOptions(int orientationMode)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |

##### OrientationOptions(int orientationMode, int[] pageNumbers)
```
public OrientationOptions(int orientationMode, int[] pageNumbers)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| pageNumbers | int[] | Page numbers. |

##### OrientationOptions(int orientationMode, int startNumber, int endNumber)
```
public OrientationOptions(int orientationMode, int startNumber, int endNumber)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode)
```
public OrientationOptions(int orientationMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the OrientationOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationMode | int | The orientation mode of OrientationMode |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for the page orientation.

**Returns:**
int

### PageBuilderOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/pagebuilderoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageBuilderOptions
```
public class PageBuilderOptions implements IPageBuilderOptions
```

Provides options for specifying the page builder.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageBuilderOptions() | Initializes a new instance of the PageBuilderOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getLoadDocumentInfo() | Specifies if each document info should load all its pages info. |
| setLoadDocumentInfo(boolean value) | Specifies if each document info should load all its pages info. |
##### PageBuilderOptions()
```
public PageBuilderOptions()
```

Initializes a new instance of the PageBuilderOptions class.

##### getLoadDocumentInfo()
```
public final boolean getLoadDocumentInfo()
```

Specifies if each document info should load all its pages info.

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

Specifies if each document info should load all its pages info.

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

### PageJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/pagejoinoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageJoinOptions
```
public class PageJoinOptions extends PageOptions implements IPageJoinOptions
```

Provides options for the document joining.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageJoinOptions() | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int[] pageNumbers) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int startNumber, int endNumber) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int[] pageNumbers) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int startNumber, int endNumber) | Initializes a new instance of the PageJoinOptions class. |
| PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode) | Initializes a new instance of the PageJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | The type of the file to join. |
##### PageJoinOptions()
```
public PageJoinOptions()
```

Initializes a new instance of the PageJoinOptions class.

##### PageJoinOptions(int[] pageNumbers)
```
public PageJoinOptions(int[] pageNumbers)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### PageJoinOptions(int startNumber, int endNumber)
```
public PageJoinOptions(int startNumber, int endNumber)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PageJoinOptions(int startNumber, int endNumber, int mode)
```
public PageJoinOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### PageJoinOptions(FileType fileType)
```
public PageJoinOptions(FileType fileType)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### PageJoinOptions(FileType fileType, int[] pageNumbers)
```
public PageJoinOptions(FileType fileType, int[] pageNumbers)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | int[] | Page numbers. |

##### PageJoinOptions(FileType fileType, int startNumber, int endNumber)
```
public PageJoinOptions(FileType fileType, int startNumber, int endNumber)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```
public PageJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PageJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getType()
```
public final FileType getType()
```

The type of the file to join.

**Returns:**
FileType

### PageOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/pageoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPageOptions
```
public abstract class PageOptions implements IPageOptions
```

Provides options for specifying page or pages range.
#### Methods

| Method | Description |
| --- | --- |
| pages() | Get page numbers collection. |
##### pages()
```
public final int[] pages()
```

Get page numbers collection.

**Returns:**
int[]

### PdfAttachmentOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/pdfattachmentoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.ImportDocumentOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPdfAttachmentOptions
```
public class PdfAttachmentOptions extends ImportDocumentOptions implements IPdfAttachmentOptions
```

Provides options to attach the embedded object to Pdf.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfAttachmentOptions(byte[] objectData, String extension) | Initializes a new instance of the PdfAttachmentOptions class. |
| PdfAttachmentOptions(String filePath) | Initializes a new instance of the PdfAttachmentOptions class. |
##### PdfAttachmentOptions(byte[] objectData, String extension)
```
public PdfAttachmentOptions(byte[] objectData, String extension)
```

Initializes a new instance of the PdfAttachmentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| objectData | byte[] | The data of the embedded object. |
| extension | java.lang.String | The extension of the embedded object. |

##### PdfAttachmentOptions(String filePath)
```
public PdfAttachmentOptions(String filePath)
```

Initializes a new instance of the PdfAttachmentOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path of the embedded object. |

### PreviewMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/previewmode.md

**Inheritance:**
java.lang.Object
```
public final class PreviewMode
```

Provides modes for the page previewing.
#### Fields

| Field | Description |
| --- | --- |
| PNG | Preview mode as .png |
| JPEG | Preview mode as .jpeg |
| BMP | Preview mode as .bmp |
#### Methods

| Method | Description |
| --- | --- |
| extensions() |  |
##### PNG
```
public static final int PNG
```

Preview mode as .png

##### JPEG
```
public static final int JPEG
```

Preview mode as .jpeg

##### BMP
```
public static final int BMP
```

Preview mode as .bmp

##### extensions()
```
public static String[] extensions()
```

**Returns:**
java.lang.String[]

### PreviewOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/previewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IPreviewOptions
```
public class PreviewOptions extends PageOptions implements IPreviewOptions
```

Represents document preview options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber) | Initializes a new instance of the PreviewOptions class. |
| PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the PreviewOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Preview width. |
| setWidth(int value) | Preview width. |
| getHeight() | Preview height. |
| setHeight(int value) | Preview height. |
| getResolution() | Image resolution. |
| setResolution(int value) | Image resolution. |
| getMode() | Mode for preview. |
| validate(FileType fileType) | Validates the preview options. |
| getPathByPageNumber(int pageNumber, String extension) | Gets the full file path of previewed document by page number with defined extension. |
| getPageStreamFactory() | PageStreamFactory for create or release output page preview stream. |
##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| pageNumbers | int[] | Page numbers. |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the PreviewOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The method that instantiates stream used to write output page data. |
| previewMode | int | The preview mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

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

Preview width.

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

Preview width.

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

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

Preview height.

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

Preview height.

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

##### getResolution()
```
public final int getResolution()
```

Image resolution.

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

Image resolution.

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

##### getMode()
```
public final int getMode()
```

Mode for preview.

**Returns:**
int
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the preview options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

##### getPathByPageNumber(int pageNumber, String extension)
```
public final String getPathByPageNumber(int pageNumber, String extension)
```

Gets the full file path of previewed document by page number with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | Page number of preview. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getPageStreamFactory()
```
public PageStreamFactory getPageStreamFactory()
```

PageStreamFactory for create or release output page preview stream.

**Returns:**
PageStreamFactory

### RangeMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/rangemode.md

**Inheritance:**
java.lang.Object
```
public final class RangeMode
```

Possible modes for the page ranging.
#### Fields

| Field | Description |
| --- | --- |
| AllPages | Range have all numbers from begin to end. |
| OddPages | Range have only odd numbers from begin to end. |
| EvenPages | Range have only even numbers from begin to end. |
##### AllPages
```
public static final int AllPages
```

Range have all numbers from begin to end.

##### OddPages
```
public static final int OddPages
```

Range have only odd numbers from begin to end.

##### EvenPages
```
public static final int EvenPages
```

Range have only even numbers from begin to end.

### RemoveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/removeoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IRemoveOptions
```
public class RemoveOptions extends PageOptions implements IRemoveOptions
```

Provides options for the page removing.
#### Constructors

| Constructor | Description |
| --- | --- |
| RemoveOptions() | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int[] pageNumbers) | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int startNumber, int endNumber) | Initializes a new instance of the RemoveOptions class. |
| RemoveOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the RemoveOptions class. |
##### RemoveOptions()
```
public RemoveOptions()
```

Initializes a new instance of the RemoveOptions class.

##### RemoveOptions(int[] pageNumbers)
```
public RemoveOptions(int[] pageNumbers)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### RemoveOptions(int startNumber, int endNumber)
```
public RemoveOptions(int startNumber, int endNumber)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### RemoveOptions(int startNumber, int endNumber, int mode)
```
public RemoveOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the RemoveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

### RotateMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/rotatemode.md

**Inheritance:**
java.lang.Object
```
public final class RotateMode
```

Possible modes for the page rotation.
#### Fields

| Field | Description |
| --- | --- |
| Rotate90 | Rotate to the right with 90 degrees. |
| Rotate180 | Rotate to the right with 180 degrees. |
| Rotate270 | Rotate to the right with 270 degrees. |
##### Rotate90
```
public static final int Rotate90
```

Rotate to the right with 90 degrees.

##### Rotate180
```
public static final int Rotate180
```

Rotate to the right with 180 degrees.

##### Rotate270
```
public static final int Rotate270
```

Rotate to the right with 270 degrees.

### RotateOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/rotateoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IRotateOptions
```
public class RotateOptions extends PageOptions implements IRotateOptions
```

Provides options for the page rotation.
#### Constructors

| Constructor | Description |
| --- | --- |
| RotateOptions(int rotateMode) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int[] pageNumbers) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int startNumber, int endNumber) | Initializes a new instance of the RotateOptions class. |
| RotateOptions(int rotateMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the RotateOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for rotating (90, 180 or 270 degrees). |
##### RotateOptions(int rotateMode)
```
public RotateOptions(int rotateMode)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |

##### RotateOptions(int rotateMode, int[] pageNumbers)
```
public RotateOptions(int rotateMode, int[] pageNumbers)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| pageNumbers | int[] | Page numbers. |

##### RotateOptions(int rotateMode, int startNumber, int endNumber)
```
public RotateOptions(int rotateMode, int startNumber, int endNumber)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### RotateOptions(int rotateMode, int startNumber, int endNumber, int mode)
```
public RotateOptions(int rotateMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the RotateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateMode | int | The rotating mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)) |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for rotating (90, 180 or 270 degrees).

**Returns:**
int

### SaveOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/saveoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISaveOptions
```
public class SaveOptions implements ISaveOptions
```

Provides options for the document saving.
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions(FileType fileType) | Initializes new instance of SaveOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | File type. |
##### SaveOptions(FileType fileType)
```
public SaveOptions(FileType fileType)
```

Initializes new instance of SaveOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |

##### getType()
```
public final FileType getType()
```

File type.

**Returns:**
FileType

### SplitMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/splitmode.md

**Inheritance:**
java.lang.Object
```
public final class SplitMode
```

Defines page splitting modes.
#### Fields

| Field | Description |
| --- | --- |
| Pages | Split pages |
| Interval | Split Intervals |
##### Pages
```
public static final int Pages
```

Split pages

##### Interval
```
public static final int Interval
```

Split Intervals

### SplitOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/splitoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISplitOptions
```
public class SplitOptions extends PageOptions implements ISplitOptions
```

Provides options for the document page splitting.
#### Constructors

| Constructor | Description |
| --- | --- |
| SplitOptions(int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int[] pageNumbers) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode) | Initializes a new instance of the SplitOptions class. |
| SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode) | Initializes a new instance of the SplitOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the mode for page splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with pre-defined extension. |
| getSplitStreamFactory() | SplitStreamFactory for create or release output page preview stream. |
##### SplitOptions(int[] pageNumbers, int splitMode)
```
public SplitOptions(int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(int splitMode, int startNumber, int endNumber)
```
public SplitOptions(int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### SplitOptions(String filePathFormat, int[] pageNumbers)
```
public SplitOptions(String filePathFormat, int[] pageNumbers)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| pageNumbers | int[] | Page numbers. |

##### SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)
```
public SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(String filePathFormat, int startNumber, int endNumber)
```
public SplitOptions(String filePathFormat, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)
```
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)
```
public SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | java.lang.Integer | The range mode. |

##### SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already pre-defined extension. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### SplitOptions(SplitStreamFactory splitStreamFactory)
```
public SplitOptions(SplitStreamFactory splitStreamFactory)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| pageNumbers | int[] | Page numbers. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| pageNumbers | int[] | Page numbers. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | java.lang.Integer | The range mode. |

##### SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)
```
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the SplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| splitMode | int | The splitting mode of  Mode (\#getMode.getMode/\#setMode(int).setMode(int)). |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

Gets the mode for page splitting.

**Returns:**
int
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public final String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with pre-defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public SplitStreamFactory getSplitStreamFactory()
```

SplitStreamFactory for create or release output page preview stream.

**Returns:**
SplitStreamFactory

### SwapOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/swapoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ISwapOptions
```
public class SwapOptions implements ISwapOptions
```

Provides options for swapping document pages.
#### Constructors

| Constructor | Description |
| --- | --- |
| SwapOptions(int firstPageNumber, int secondPageNumber) | Initializes a new instance of the SwapOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getFirstPageNumber() | First page number to exchange. |
| getSecondPageNumber() | Second page number to exchange. |
##### SwapOptions(int firstPageNumber, int secondPageNumber)
```
public SwapOptions(int firstPageNumber, int secondPageNumber)
```

Initializes a new instance of the SwapOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| firstPageNumber | int | The first page number. |
| secondPageNumber | int | The second page number. |

##### getFirstPageNumber()
```
public final int getFirstPageNumber()
```

First page number to exchange.

**Returns:**
int
##### getSecondPageNumber()
```
public final int getSecondPageNumber()
```

Second page number to exchange.

**Returns:**
int

### TextSplitMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/textsplitmode.md

**Inheritance:**
java.lang.Object
```
public final class TextSplitMode
```

Possible text splitting modes.
#### Fields

| Field | Description |
| --- | --- |
| Lines | Split lines |
| Interval | Split Intervals |
##### Lines
```
public static final int Lines
```

Split lines

##### Interval
```
public static final int Interval
```

Split Intervals

### TextSplitOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/textsplitoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.ITextSplitOptions
```
public class TextSplitOptions implements ITextSplitOptions
```

Provides options for the document text splitting.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSplitOptions(int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(String filePathFormat, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
| TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers) | Initializes a new instance of the TextSplitOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Mode for text splitting. |
| getLineNumbers() | Line numbers for text splitting. |
| validate(FileType fileType) | Validates the split options. |
| getPathByIndex(int index, String extension) | Gets the full file path of splitted document by index with defined extension. |
| getSplitStreamFactory() | SplitStreamFactory for create or release output page preview stream. |
##### TextSplitOptions(int[] lineNumbers)
```
public TextSplitOptions(int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(int mode, int[] lineNumbers)
```
public TextSplitOptions(int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(String filePathFormat, int[] lineNumbers)
```
public TextSplitOptions(String filePathFormat, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already defined extension. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers)
```
public TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format e.g. 'c:/split\{0\}.doc' or 'c:/split\{0\}.\{1\}' with already defined extension. |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers)
```
public TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers)
```
public TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers)
```

Initializes a new instance of the TextSplitOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitStreamFactory | SplitStreamFactory | The method that instantiates stream used to write output split data. |
| mode | int | Mode for text splitting. |
| lineNumbers | int[] | Line numbers for text splitting. |

##### getMode()
```
public final int getMode()
```

Mode for text splitting.

**Returns:**
int
##### getLineNumbers()
```
public final int[] getLineNumbers()
```

Line numbers for text splitting.

**Returns:**
int[]
##### validate(FileType fileType)
```
public final void validate(FileType fileType)
```

Validates the split options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type of FileType class. |

##### getPathByIndex(int index, String extension)
```
public final String getPathByIndex(int index, String extension)
```

Gets the full file path of splitted document by index with defined extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of splitted document. |
| extension | java.lang.String | Extension of file. |

**Returns:**
java.lang.String - The full file path.
##### getSplitStreamFactory()
```
public SplitStreamFactory getSplitStreamFactory()
```

SplitStreamFactory for create or release output page preview stream.

**Returns:**
SplitStreamFactory

### UpdatePasswordOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/updatepasswordoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.options.interfaces.IUpdatePasswordOptions
```
public class UpdatePasswordOptions implements IUpdatePasswordOptions
```

Provides options for updating document password.
#### Constructors

| Constructor | Description |
| --- | --- |
| UpdatePasswordOptions(String newPassword) | Initializes a new instance of the UpdatePasswordOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getNewPassword() | A new password for the document protection. |
##### UpdatePasswordOptions(String newPassword)
```
public UpdatePasswordOptions(String newPassword)
```

Initializes a new instance of the UpdatePasswordOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newPassword | java.lang.String | The new password. |

##### getNewPassword()
```
public final String getNewPassword()
```

A new password for the document protection.

**Returns:**
java.lang.String

### WordJoinCompliance
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/wordjoincompliance.md

**Inheritance:**
java.lang.Object
```
public final class WordJoinCompliance
```

Possible Compliance modes for the Word Ooxml formats such as .docx, .docm, .dotx, .dotm etc.
#### Fields

| Field | Description |
| --- | --- |
| Auto | Auto |
| Ecma376_2006 | ECMA-376 1st Edition, 2006. |
| Iso29500_2008_Transitional | ISO/IEC 29500:2008 Transitional compliance level. |
| Iso29500_2008_Strict | ISO/IEC 29500:2008 Strict compliance level. |
##### Auto
```
public static final int Auto
```

Auto

##### Ecma376_2006
```
public static final int Ecma376_2006
```

ECMA-376 1st Edition, 2006.

##### Iso29500_2008_Transitional
```
public static final int Iso29500_2008_Transitional
```

ISO/IEC 29500:2008 Transitional compliance level.

##### Iso29500_2008_Strict
```
public static final int Iso29500_2008_Strict
```

ISO/IEC 29500:2008 Strict compliance level.

### WordJoinMode
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/wordjoinmode.md

**Inheritance:**
java.lang.Object
```
public final class WordJoinMode
```

Possible modes for the Word joining.
#### Fields

| Field | Description |
| --- | --- |
| Default | Specifies Default Word joining. |
| Continuous | Specifies Word joining without starting from new page. |
##### Default
```
public static final int Default
```

Specifies Default Word joining.

##### Continuous
```
public static final int Continuous
```

Specifies Word joining without starting from new page.

### WordJoinOptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.options/wordjoinoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.merger.domain.options.PageOptions, com.groupdocs.merger.domain.options.PageJoinOptions
```
public class WordJoinOptions extends PageJoinOptions
```

The Word join options.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordJoinOptions() | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int[] pageNumbers) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int startNumber, int endNumber) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(int startNumber, int endNumber, int mode) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int[] pageNumbers) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int startNumber, int endNumber) | Initializes a new instance of the WordJoinOptions class. |
| WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode) | Initializes a new instance of the WordJoinOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | The Word join mode. |
| setMode(int value) | The Word join mode. |
| getCompliance() | Compliance mode for the Word Ooxml format |
| setCompliance(int value) | Compliance mode for the Word Ooxml format |
##### WordJoinOptions()
```
public WordJoinOptions()
```

Initializes a new instance of the WordJoinOptions class.

##### WordJoinOptions(int[] pageNumbers)
```
public WordJoinOptions(int[] pageNumbers)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | Page numbers. |

##### WordJoinOptions(int startNumber, int endNumber)
```
public WordJoinOptions(int startNumber, int endNumber)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### WordJoinOptions(int startNumber, int endNumber, int mode)
```
public WordJoinOptions(int startNumber, int endNumber, int mode)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### WordJoinOptions(FileType fileType)
```
public WordJoinOptions(FileType fileType)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |

##### WordJoinOptions(FileType fileType, int[] pageNumbers)
```
public WordJoinOptions(FileType fileType, int[] pageNumbers)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| pageNumbers | int[] | Page numbers. |

##### WordJoinOptions(FileType fileType, int startNumber, int endNumber)
```
public WordJoinOptions(FileType fileType, int startNumber, int endNumber)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |

##### WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```
public WordJoinOptions(FileType fileType, int startNumber, int endNumber, int mode)
```

Initializes a new instance of the WordJoinOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to join. |
| startNumber | int | The start page number. |
| endNumber | int | The end page number. |
| mode | int | The range mode. |

##### getMode()
```
public final int getMode()
```

The Word join mode.

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

The Word join mode.

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

##### getCompliance()
```
public final int getCompliance()
```

Compliance mode for the Word Ooxml format

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

Compliance mode for the Word Ooxml format

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

### com.groupdocs.merger.domain.result
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.result.md

The **com.groupdocs.merger.domain.result** namespace provides classes which represent document results.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Defines document description properties. |
| PageInfo | Defines page description properties. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Interface for the document description properties. |
| IPageInfo | Interface for the page description properties. |

### DocumentInfo
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.result/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.result.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Defines document description properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo(int index, InputStream stream, FileType fileType, String password) | Initializes new instance of DocumentInfo class. |
| DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size) | Initializes new instance of DocumentInfo class. |
| DocumentInfo(FileType fileType, IPageInfo[] pages, long size) | Initializes new instance of DocumentInfo class. |
#### Methods

| Method | Description |
| --- | --- |
| getIndex() | The document index. |
| getStream() | The document stream. |
| getPassword() | The document password. |
| getType() | Gets the file type. |
| getPages() | Defines document pages collection. |
| getPageCount() | The document pages count. |
| getSize() | Document size in bytes |
| toString() | Returns a string that represents the current object. |
##### DocumentInfo(int index, InputStream stream, FileType fileType, String password)
```
public DocumentInfo(int index, InputStream stream, FileType fileType, String password)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| stream | java.io.InputStream |  |
| fileType | FileType | The type of the file. |
| password | java.lang.String |  |

##### DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)
```
public DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| stream | java.io.InputStream |  |
| fileType | FileType | The type of the file. |
| password | java.lang.String |  |
| pages | IPageInfo\[\] | The list of pages to view. |
| size | long | The size of the file. |

##### DocumentInfo(FileType fileType, IPageInfo[] pages, long size)
```
public DocumentInfo(FileType fileType, IPageInfo[] pages, long size)
```

Initializes new instance of DocumentInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | IPageInfo\[\] | The list of pages to view. |
| size | long | The size of the file. |

##### getIndex()
```
public final int getIndex()
```

The document index.

**Returns:**
int
##### getStream()
```
public final InputStream getStream()
```

The document stream.

**Returns:**
java.io.InputStream
##### getPassword()
```
public final String getPassword()
```

The document password.

**Returns:**
java.lang.String
##### getType()
```
public final FileType getType()
```

Gets the file type.

**Returns:**
FileType
##### getPages()
```
public final IPageInfo[] getPages()
```

Defines document pages collection.

**Returns:**
com.groupdocs.merger.domain.result.IPageInfo[]
##### getPageCount()
```
public final int getPageCount()
```

The document pages count.

**Returns:**
int
##### getSize()
```
public final long getSize()
```

Document size in bytes

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

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### IDocumentInfo
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.result/idocumentinfo.md

### IPageInfo
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.result/ipageinfo.md

### PageInfo
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.result/pageinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.domain.result.IPageInfo
```
public class PageInfo implements IPageInfo
```

Defines page description properties.
#### Constructors

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

| Method | Description |
| --- | --- |
| getDocument() | Gets the document info. |
| setDocument(DocumentInfo value) | Gets the document info. |
| getNumber() | Gets the page number. |
| getVisible() | Indicates whether page is visibile or not. |
| getWidth() | Gets page width in pixels when converted to image. |
| getHeight() | Gets page height in pixels when converted to image. |
##### PageInfo(int number, boolean visible)
```
public PageInfo(int number, boolean visible)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The page visibility indicator. |

##### PageInfo(int number, boolean visible, int width, int height)
```
public PageInfo(int number, boolean visible, int width, int height)
```

Initializes new instance of PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The page visibility indicator. |
| width | int | The width of the page in pixels when viewing as JPG or PNG. |
| height | int | The height of the page in pixels when viewing as JPG or PNG. |

##### getDocument()
```
public final DocumentInfo getDocument()
```

Gets the document info.

**Returns:**
DocumentInfo
##### setDocument(DocumentInfo value)
```
public final void setDocument(DocumentInfo value)
```

Gets the document info.

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

##### getNumber()
```
public final int getNumber()
```

Gets the page number.

**Returns:**
int
##### getVisible()
```
public final boolean getVisible()
```

Indicates whether page is visibile or not.

**Returns:**
boolean
##### getWidth()
```
public final int getWidth()
```

Gets page width in pixels when converted to image.

**Returns:**
int
##### getHeight()
```
public final int getHeight()
```

Gets page height in pixels when converted to image.

**Returns:**
int

### com.groupdocs.merger.domain
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain.md

The **com.groupdocs.merger.domain** namespace provides classes for working with document structure.

#### Classes

| Class | Description |
| --- | --- |
| FileType | Represents file type. |

### FileType
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.domain/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Merger**, detect file type by extension etc.

[Full list of supported document formats]: https://docs.groupdocs.com/display/mergernet/Supported+Document+Types
[How to get supported file formats in code]: https://docs.groupdocs.com/display/mergernet/Get+supported+file+types
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| ZIP | Zipped File (.zip) |
| SevenZ | 7-Zip Compressed File (.7z) |
| TAR | Consolidated Unix File Archive (.tar) |
| RAR | Roshal ARchive Compressed File (.rar) |
| VSSX | Visio Stencil File (.vssx) are drawing stencils created with Microsoft Visio 2013 and above. |
| VSDX | Visio Drawing (.vsdx) represents Microsoft Visio file format introduced from Microsoft Office 2013 onwards. |
| VSDM | Visio Macro-Enabled Drawing (.vsdm) are drawing files created with Microsoft Visio application that supports macros. |
| VSTX | Visio Drawing Template (.vstx) are drawing template files created with Microsoft Visio 2013 and above. |
| VSTM | Visio Macro-Enabled Drawing Template (.vstm) are template files created with Microsoft Visio that support macros. |
| VSSM | Visio Macro-Enabled Stencil File (.vssm) are Microsoft Visio Stencil files that support provide support for macros. |
| VSX | Visio Stencil XML File (.vsx) refers to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. |
| VTX | Visio Template XML File (.vtx) is a Microsoft Visio drawing template that is saved to disc in XML file format. |
| VDX | Visio Drawing XML File (.vdx)is a drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. |
| EPUB | Open eBook File (.epub) are an e-book file format that provide a standard digital publication format for publishers and consumers. |
| BMP | Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. |
| JPG | JPEG Image (.jpg) |
| JPEG | JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. |
| PNG | Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. |
| PS | PostScript File (.ps) |
| TIF | Tagged Image File (.tif) |
| TIFF | Tagged Image File Format (.tiff) |
| GIF | Graphical Interchange Format File (.gif) |
| SVG | Scalable Vector Graphics File (.svg) |
| SVGZ | Scalable Vector Graphics Compressed File (.svgz) |
| EMF | Windows Enhanced Metafile (.emf) |
| EMZ | Windows Compressed Enhanced Metafile (.emz) |
| HTML | Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. |
| MHT | MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. |
| MHTML | MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. |
| ONE | OneNote Document (.one) files are created by Microsoft OneNote application. |
| PDF | Portable Document Format File (.pdf) isa file format that was to introduced as 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. |
| XPS | XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. |
| TEX | LaTeX Source Document (.tex) is a language that comprises of programming as well as mark-up features, used to typeset documents. |
| PPT | PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | PowerPoint Open XML Presentation (.pptx) is a presentation file created with popular Microsoft PowerPoint application. |
| PPS | PowerPoint Slide Show (.pps) is a file created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. |
| OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. |
| XLS | Excel Spreadsheet (.xls) is a file that can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. |
| XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. |
| XLSB | Excel Binary Spreadsheet (.xlsb) file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. |
| TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. |
| ODS | OpenDocument Spreadsheet (.ods). |
| XLTM | Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| XLTX | Excel Open XML Spreadsheet Template (.xltx) files are based on the Office OpenXML file format specifications. |
| XLT | Excel Template File (.xlt) are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. |
| XLAM | Excel Macro-Enabled Add-In (.xlam). |
| DOC | Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. |
| DOCM | Word Open XML Macro-Enabled Document (.docm) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| DOT | Word Document Template (.dot) files are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. |
| DOTX | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. |
| RTF | Rich Text Format File (.rtf) introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. |
| TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines. |
| ERR | Error Log File (.err) is a text file that contains error messages generated by a program. |
| ODT | OpenDocument Text Document (.odt) files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| OTT | OpenDocument Document Template (.ott) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. |
| 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 |
| --- | --- |
| getFileFormat() | File type name e.g. |
| getExtension() | Filename suffix (including the period ".") e.g. |
| fromExtension(String extension) | Maps file extension to file type. |
| getSupportedFileTypes() | Retrieves supported file types |
| equals(FileType other) | Determines whether the current FileType is the same as specified FileType object. |
| equals(Object obj) | Determines whether the current FileType is the same as specified object. |
| hashCode() | Returns the hash code for the current FileType object. |
| op_Equality(FileType left, FileType right) | Determines whether two FileType objects are the same. |
| op_Inequality(FileType left, FileType right) | Determines whether two FileType objects are not the same. |
| toString() | Returns a string that represents the current object. |
| isText(FileType fileType) | Determines whether input FileType is primitive text format. |
| isArchive(FileType fileType) | Determines whether input FileType is archive format. |
| isImage(FileType fileType) | Determines whether input FileType is primitive text format. |
| isAudio(FileType fileType) | Determines whether input FileType is audio format. |
| getBase(FileType fileType) |  |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### ZIP
```
public static FileType ZIP
```

Zipped File (.zip)

##### SevenZ
```
public static final FileType SevenZ
```

7-Zip Compressed File (.7z)

##### TAR
```
public static final FileType TAR
```

Consolidated Unix File Archive (.tar)

##### RAR
```
public static final FileType RAR
```

Roshal ARchive Compressed File (.rar)

##### VSSX
```
public static final FileType VSSX
```

Visio Stencil File (.vssx) 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://docs.fileformat.com/image/vssx

##### VSDX
```
public static final FileType VSDX
```

Visio Drawing (.vsdx) represents 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://docs.fileformat.com/image/vsdx

##### VSDM
```
public static final FileType VSDM
```

Visio Macro-Enabled Drawing (.vsdm) 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://docs.fileformat.com/image/vsdm

##### VSTX
```
public static final FileType VSTX
```

Visio Drawing Template (.vstx) 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://docs.fileformat.com/image/vstx

##### VSTM
```
public static final FileType VSTM
```

Visio Macro-Enabled Drawing Template (.vstm) 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://docs.fileformat.com/image/vstm

##### VSSM
```
public static final FileType VSSM
```

Visio Macro-Enabled Stencil File (.vssm) 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://docs.fileformat.com/image/vssm

##### VSX
```
public static final FileType VSX
```

Visio Stencil XML File (.vsx) refers 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://docs.fileformat.com/image/vsx

##### VTX
```
public static final FileType VTX
```

Visio Template XML File (.vtx) 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://docs.fileformat.com/image/vtx

##### VDX
```
public static final FileType VDX
```

Visio Drawing XML File (.vdx)is a 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://docs.fileformat.com/image/vdx

##### EPUB
```
public static final FileType EPUB
```

Open eBook File (.epub) 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://docs.fileformat.com/ebook/epub

##### BMP
```
public static final FileType BMP
```

Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/bmp

##### JPG
```
public static final FileType JPG
```

JPEG Image (.jpg)

##### JPEG
```
public static final FileType JPEG
```

JPEG Image (.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://docs.fileformat.com/image/jpeg

##### PNG
```
public static final FileType PNG
```

Portable Network Graphic (.png) is a type of raster image file format that use loseless compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/png

##### PS
```
public static final FileType PS
```

PostScript File (.ps)

##### TIF
```
public static FileType TIF
```

Tagged Image File (.tif)

##### TIFF
```
public static FileType TIFF
```

Tagged Image File Format (.tiff)

##### GIF
```
public static FileType GIF
```

Graphical Interchange Format File (.gif)

##### SVG
```
public static FileType SVG
```

Scalable Vector Graphics File (.svg)

##### SVGZ
```
public static FileType SVGZ
```

Scalable Vector Graphics Compressed File (.svgz)

##### EMF
```
public static final FileType EMF
```

Windows Enhanced Metafile (.emf)

##### EMZ
```
public static final FileType EMZ
```

Windows Compressed Enhanced Metafile (.emz)

##### HTML
```
public static final FileType HTML
```

Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/html

##### MHT
```
public static final FileType MHT
```

MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/mhtml

##### MHTML
```
public static final FileType MHTML
```

MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/mhtml

##### ONE
```
public static final FileType ONE
```

OneNote Document (.one) files 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://docs.fileformat.com/note-taking/one

##### PDF
```
public static final FileType PDF
```

Portable Document Format File (.pdf) isa file format that was to introduced as 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/view/pdf

##### XPS
```
public static final FileType XPS
```

XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/page-description-language/xps

##### TEX
```
public static final FileType TEX
```

LaTeX Source Document (.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://docs.fileformat.com/page-description-language/tex

##### PPT
```
public static final FileType PPT
```

PowerPoint Presentation (.ppt) 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://docs.fileformat.com/presentation/ppt

##### PPTX
```
public static final FileType PPTX
```

PowerPoint Open XML Presentation (.pptx) is a presentation file 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://docs.fileformat.com/presentation/pptx

##### PPS
```
public static final FileType PPS
```

PowerPoint Slide Show (.pps) is a file 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://docs.fileformat.com/presentation/pps

##### PPSX
```
public static final FileType PPSX
```

PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/ppsx

##### ODP
```
public static final FileType ODP
```

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/odp

##### OTP
```
public static final FileType OTP
```

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/presentation/otp

##### XLS
```
public static final FileType XLS
```

Excel Spreadsheet (.xls) is a file that 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://docs.fileformat.com/spreadsheet/xls

##### XLSX
```
public static final FileType XLSX
```

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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://docs.fileformat.com/spreadsheet/xlsx

##### XLSM
```
public static final FileType XLSM
```

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/xlsm

##### XLSB
```
public static final FileType XLSB
```

Excel Binary Spreadsheet (.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://docs.fileformat.com/spreadsheet/xlsb

##### CSV
```
public static final FileType CSV
```

Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/csv

##### TSV
```
public static final FileType TSV
```

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/spreadsheet/tsv

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet (.ods).

##### XLTM
```
public static final FileType XLTM
```

Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) 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://docs.fileformat.com/spreadsheet/xltm

##### XLTX
```
public static final FileType XLTX
```

Excel Open XML Spreadsheet Template (.xltx) files 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://docs.fileformat.com/spreadsheet/xltx

##### XLT
```
public static final FileType XLT
```

Excel Template File (.xlt) 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://docs.fileformat.com/spreadsheet/xlt

##### XLAM
```
public static final FileType XLAM
```

Excel Macro-Enabled Add-In (.xlam).

##### DOC
```
public static final FileType DOC
```

Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/doc

##### DOCX
```
public static final FileType DOCX
```

Microsoft Word Open XML Document (.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://docs.fileformat.com/word-processing/docx

##### DOCM
```
public static final FileType DOCM
```

Word Open XML 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://docs.fileformat.com/word-processing/docm

##### DOT
```
public static final FileType DOT
```

Word Document Template (.dot) files 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://docs.fileformat.com/word-processing/dot

##### DOTX
```
public static final FileType DOTX
```

Word Open XML Document 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://docs.fileformat.com/word-processing/dotx

##### DOTM
```
public static final FileType DOTM
```

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/dotm

##### RTF
```
public static final FileType RTF
```

Rich Text Format File (.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://docs.fileformat.com/word-processing/rtf

##### TXT
```
public static final FileType TXT
```

Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/txt

##### ERR
```
public static final FileType ERR
```

Error Log File (.err) is a text file that contains error messages generated by a program. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/err

##### ODT
```
public static final FileType ODT
```

OpenDocument 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://docs.fileformat.com/word-processing/odt

##### OTT
```
public static final FileType OTT
```

OpenDocument 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://docs.fileformat.com/word-processing/ott

##### WAV
```
public static FileType 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. The format doesn\\u2019t apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. It has been and is one of the standard format for audio CDs. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/audio/wav

##### getFileFormat()
```
public final String getFileFormat()
```

File type name e.g. "Microsoft Word Document".

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

Filename suffix (including the period ".") e.g. ".doc".

**Returns:**
java.lang.String
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period "."). |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default \#Unknown.Unknown file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.util.List<com.groupdocs.merger.domain.FileType> - Returns sequence of supported file types
##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current FileType is the same as specified FileType object.

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

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.merger.domain/filetype) objects are the same; otherwise,

```
false
```
### equals(Object obj) {#equals-java.lang.Object-}
```
public boolean equals(Object obj)
```


Determines whether the current [FileType](../../com.groupdocs.merger.domain/filetype) is the same as specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if

```
obj
```

parameter is FileType and is the same as current FileType object; otherwise,

```
false
```
##### hashCode()
```
public int hashCode()
```

Returns the hash code for the current FileType object.

**Returns:**
int - A hash code for the current FileType object.
##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two FileType objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object. |
| right | FileType | Right FileType object. |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.merger.domain/filetype) objects are the same; otherwise,

```
false
```
### op_Inequality(FileType left, FileType right) {#op-Inequality-com.groupdocs.merger.domain.FileType-com.groupdocs.merger.domain.FileType-}
```
public static boolean op_Inequality(FileType left, FileType right)
```


Determines whether two [FileType](../../com.groupdocs.merger.domain/filetype) objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | [FileType](../../com.groupdocs.merger.domain/filetype) | Left [FileType](../../com.groupdocs.merger.domain/filetype) object. |
| right | [FileType](../../com.groupdocs.merger.domain/filetype) | Right [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if both FileType objects are not the same; otherwise,

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

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.
##### isText(FileType fileType)
```
public static boolean isText(FileType fileType)
```

Determines whether input FileType is primitive text format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The FileType object. |

**Returns:**
boolean - ```
true
```

if input [FileType](../../com.groupdocs.merger.domain/filetype) is primitive text format; otherwise,

```
false
```
### isArchive(FileType fileType) {#isArchive-com.groupdocs.merger.domain.FileType-}
```
public static boolean isArchive(FileType fileType)
```


Determines whether input [FileType](../../com.groupdocs.merger.domain/filetype) is archive format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | [FileType](../../com.groupdocs.merger.domain/filetype) | The [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if input FileType is archive format; otherwise,

```
false
```
##### isImage(FileType fileType)
```
public static boolean isImage(FileType fileType)
```

Determines whether input FileType is primitive text format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The FileType object. |

**Returns:**
boolean - ```
true
```

if input [FileType](../../com.groupdocs.merger.domain/filetype) is primitive image format; otherwise,

```
false
```
### isAudio(FileType fileType) {#isAudio-com.groupdocs.merger.domain.FileType-}
```
public static boolean isAudio(FileType fileType)
```


Determines whether input [FileType](../../com.groupdocs.merger.domain/filetype) is audio format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | [FileType](../../com.groupdocs.merger.domain/filetype) | The [FileType](../../com.groupdocs.merger.domain/filetype) object. |

**Returns:**
boolean - ```
true
```

if input FileType is audio format; otherwise,

```
false
```
##### getBase(FileType fileType)
```
public static FileType getBase(FileType fileType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType |  |

**Returns:**
FileType

### com.groupdocs.merger.exceptions
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions.md

The **com.groupdocs.merger.exceptions** namespace provides classes for exceptions which can occur while working with a document.

#### Classes

| Class | Description |
| --- | --- |
| FileCorruptedException | The exception that is thrown when specified file could not be loaded because it appears to be corrupted. |
| FileTypeNotSupportedException | The exception that is thrown when specified file type is not supported. |
| GroupDocsMergerException | Represents errors that occur during document processing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

### FileCorruptedException
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions/filecorruptedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class FileCorruptedException extends GroupDocsMergerException
```

The exception that is thrown when specified file could not be loaded because it appears to be corrupted.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCorruptedException(String guid) | Initializes a new instance of the FileCorruptedException class. |
##### FileCorruptedException(String guid)
```
public FileCorruptedException(String guid)
```

Initializes a new instance of the FileCorruptedException class.

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

### FileTypeNotSupportedException
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions/filetypenotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class FileTypeNotSupportedException extends Exception
```

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

| Constructor | Description |
| --- | --- |
| FileTypeNotSupportedException(String message) | 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. |

### GroupDocsMergerException
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions/groupdocsmergerexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class GroupDocsMergerException extends Exception
```

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

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

| Method | Description |
| --- | --- |
| getException(Exception exception) | Get the GroupDocs Merger exception from input exception. |
##### GroupDocsMergerException(String message)
```
public GroupDocsMergerException(String message)
```

Initializes a new instance of the GroupDocsMergerException class.

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

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

Initializes a new instance of the GroupDocsMergerException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| innerException | java.lang.Exception | The inner exception of the error.    |

##### getException(Exception exception)
```
public static Exception getException(Exception exception)
```

Get the GroupDocs Merger exception from input exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| exception | java.lang.Exception | The input exception. |

**Returns:**
java.lang.Exception -

### IncorrectPasswordException
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class IncorrectPasswordException extends GroupDocsMergerException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException(String guid) | Initializes a new instance of the IncorrectPasswordException class. |
##### IncorrectPasswordException(String guid)
```
public IncorrectPasswordException(String guid)
```

Initializes a new instance of the IncorrectPasswordException class.

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

### PasswordRequiredException
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.exceptions/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.merger.exceptions.GroupDocsMergerException
```
public class PasswordRequiredException extends GroupDocsMergerException
```

The exception that is thrown when password is required to load the document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException(String guid) | Initializes a new instance of the PasswordRequiredException class. |
##### PasswordRequiredException(String guid)
```
public PasswordRequiredException(String guid)
```

Initializes a new instance of the PasswordRequiredException class.

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

### com.groupdocs.merger.licensing.metered
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.licensing.metered.md

The **com.groupdocs.merger.licensing.metered** namespace provides methods to set metered key.

#### Classes

| Class | Description |
| --- | --- |
| Metered | Provides methods for applying [Metered][] license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered |

### Metered
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.licensing.metered/metered.md

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

Provides methods for applying [Metered][] license.

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
#### 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 amount of used credits |
##### 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 double 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:**
double
##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Retrieves amount of used credits

> ```
> 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 usedCredits = Metered.GetConsumptionCredit();
> ```

**Returns:**
double

### com.groupdocs.merger.licensing
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.licensing.md

The **com.groupdocs.merger.licensing** namespace provides methods to license the component.

#### Classes

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

### License
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.licensing/license.md

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

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

[here]: https://purchase.groupdocs.com/faqs/licensing
#### 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 (FileStream licenseStream = new FileStream("LicenseFile.lic", FileMode.Open))
>  {
>      GroupDocs.Merger.License lic = new GroupDocs.Merger.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.Merger.lic";
>  GroupDocs.Merger.License lic = new GroupDocs.Merger.License();
>  lic.SetLicense(licensePath);
> ```

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

### com.groupdocs.merger.logging
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.logging.md

The **com.groupdocs.merger.logging** namespace provides classes for customizing logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the console. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

### ConsoleLogger
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.merger.logging.ILogger
```
public class ConsoleLogger implements ILogger
```

Writes log messages to the console.
#### Constructors

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

| Method | Description |
| --- | --- |
| trace(String message) | Writes trace message to the console. |
| warning(String message) | Writes warning message to the console. |
| error(String message, Exception exception) | Writes error message to the console. |
##### ConsoleLogger()
```
public ConsoleLogger()
```

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console. 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 final void warning(String message)
```

Writes warning message to the console. 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 final void error(String message, Exception exception)
```

Writes error message to the console. 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/merger/nodejs-java/com.groupdocs.merger.logging/ilogger.md

### com.groupdocs.merger
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger.md

The **com.groupdocs.merger** namespace provides classes which allow you to merge documents and manipulate document structure (split single document to multiple documents, reorder or replace document pages, change page orientation, manage document password and perform other manipulations) across wide range of supported document types - PDF, DOCX/DOC, PPTX/PPT, XLSX/XLS, VSDX/VSD, ODT, ODS, ODP, HTML, EPUB and many others..

#### Classes

| Class | Description |
| --- | --- |
| Merger | Represents the main class that controls the document merging process. |
| MergerSettings | Defines settings for customizing Merger behaviour. |

### Merger
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger/merger.md

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

Represents the main class that controls the document merging process.
#### Constructors

| Constructor | Description |
| --- | --- |
| Merger(InputStream document) | Initializes new instance of Merger class. |
| Merger(InputStream document, ILoadOptions loadOptions) | Initializes new instance of Merger class. |
| Merger(InputStream document, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(String filePath) | Initializes new instance of Merger class. |
| Merger(String filePath, ILoadOptions loadOptions) | Initializes new instance of Merger class. |
| Merger(String filePath, MergerSettings settings) | Initializes new instance of Merger class. |
| Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings) | Initializes new instance of Merger class. |
#### Methods

| Method | Description |
| --- | --- |
| dispose() | Disposes resources. |
| importDocument(IImportDocumentOptions importDocumentOptions) | Imports the document as attachment or embedded via Ole. |
| join(InputStream document) | Joins the documents into one single document. |
| join(InputStream document, IJoinOptions joinOptions) | Joins the documents into one single document. |
| join(InputStream document, IPageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(InputStream document, ImageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath) | Joins the documents into one single document. |
| join(String filePath, IJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath, IPageJoinOptions joinOptions) | Joins the documents into one single document. |
| join(String filePath, ImageJoinOptions joinOptions) | Joins the documents into one single document. |
| createPageBuilder() | Creates a new Page builder with predefined document collection. |
| createPageBuilder(PageBuilderOptions pageBuilderOptions) | Creates a new Page builder with predefined document collection. |
| applyPageBuilder(PageBuilder pageBuilder) | Applies page builder changes. |
| split(ISplitOptions splitOptions) | Splits the single document to the multiple documents. |
| split(ITextSplitOptions splitOptions) | Splits the single document to the multiple documents. |
| extractPages(IExtractOptions extractOptions) | Makes a new document with some pages from the source document. |
| addPassword(IAddPasswordOptions addPasswordOptions) | Protects document with password. |
| isPasswordSet() | Checks whether document is password protected. |
| removePassword() | Removes password from document. |
| updatePassword(IUpdatePasswordOptions updatePasswordOptions) | Updates existing password for document. |
| changeOrientation(IOrientationOptions orientationOptions) | Applies a new orientation mode for the specified pages. |
| movePage(IMoveOptions moveOptions) | Moves page to a new position within document of known format. |
| removePages(IRemoveOptions removeOptions) | Removes pages from document of known format. |
| swapPages(ISwapOptions swapOptions) | Swaps two pages within document of known format. |
| rotatePages(IRotateOptions rotateOptions) | Rotate pages of the document. |
| getDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| generatePreview(IPreviewOptions previewOptions) | Generates document pages preview. |
| save(OutputStream document) | Saves the result document to the stream  document . |
| save(String filePath) | Saves the result document file to  filePath . |
| save(String filePath, boolean useDefaultDirectory) | Saves the result document file to  filePath . |
##### Merger(InputStream document)
```
public Merger(InputStream document)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |

##### Merger(InputStream document, ILoadOptions loadOptions)
```
public Merger(InputStream document, ILoadOptions loadOptions)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |

##### Merger(InputStream document, MergerSettings settings)
```
public Merger(InputStream document, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| settings | MergerSettings | The Merger settings. |

##### Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings)
```
public Merger(InputStream document, ILoadOptions loadOptions, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The readable stream. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### Merger(String filePath)
```
public Merger(String filePath)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |

##### Merger(String filePath, ILoadOptions loadOptions)
```
public Merger(String filePath, ILoadOptions loadOptions)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| loadOptions | ILoadOptions | The document load options. |

##### Merger(String filePath, MergerSettings settings)
```
public Merger(String filePath, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| settings | MergerSettings | The Merger settings. |

##### Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings)
```
public Merger(String filePath, ILoadOptions loadOptions, MergerSettings settings)
```

Initializes new instance of Merger class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path. |
| loadOptions | ILoadOptions | The document load options. |
| settings | MergerSettings | The Merger settings. |

##### dispose()
```
public final void dispose()
```

Disposes resources.

##### importDocument(IImportDocumentOptions importDocumentOptions)
```
public final void importDocument(IImportDocumentOptions importDocumentOptions)
```

Imports the document as attachment or embedded via Ole.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| importDocumentOptions | IImportDocumentOptions | The embedded document import options.

[How to add attachment to PDF document.]: https://docs.groupdocs.com/merger/java/how-to-add-attachment-to-pdf-document/
[Add document to Word processing via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-word-processing-via-ole/
[Add document to Presentation via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-presentation-via-ole/
[Add document to Spreadsheet via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-spreadsheet-via-ole/
[Add document to Diagram via OLE.]: https://docs.groupdocs.com/merger/java/add-document-to-diagram-via-ole/ |

##### join(InputStream document)
```
public final void join(InputStream document)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(InputStream document, IJoinOptions joinOptions)
```
public final void join(InputStream document, IJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | IJoinOptions | The join options.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(InputStream document, IPageJoinOptions joinOptions)
```
public final void join(InputStream document, IPageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | IPageJoinOptions | The join options.

##### join(InputStream document, ImageJoinOptions joinOptions)
```
public final void join(InputStream document, ImageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Joined document. |
| joinOptions | ImageJoinOptions | The image join options.

##### join(String filePath)
```
public final void join(String filePath)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(String filePath, IJoinOptions joinOptions)
```
public final void join(String filePath, IJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | IJoinOptions | The join options.

[How to merge PDF_ Word_ Excel and PowerPoint documents in 3 steps]: https://docs.groupdocs.com/merger/java/merge-files/ |

##### join(String filePath, IPageJoinOptions joinOptions)
```
public final void join(String filePath, IPageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | IPageJoinOptions | The join options.

##### join(String filePath, ImageJoinOptions joinOptions)
```
public final void join(String filePath, ImageJoinOptions joinOptions)
```

Joins the documents into one single document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | File path of the joined document. |
| joinOptions | ImageJoinOptions | The image join options.

##### createPageBuilder()
```
public final PageBuilder createPageBuilder()
```

Creates a new Page builder with predefined document collection.

**Returns:**
PageBuilder - The created page builder.
##### createPageBuilder(PageBuilderOptions pageBuilderOptions)
```
public final PageBuilder createPageBuilder(PageBuilderOptions pageBuilderOptions)
```

Creates a new Page builder with predefined document collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageBuilderOptions | PageBuilderOptions |  |

**Returns:**
PageBuilder - The created page builder.
##### applyPageBuilder(PageBuilder pageBuilder)
```
public final void applyPageBuilder(PageBuilder pageBuilder)
```

Applies page builder changes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageBuilder | PageBuilder | The page builder. |

##### split(ISplitOptions splitOptions)
```
public final void split(ISplitOptions splitOptions)
```

Splits the single document to the multiple documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ISplitOptions | The page split options.

[How to split PDF_ Word_ Excel and PowerPoint documents in 3 lines of code]: https://docs.groupdocs.com/merger/java/split-document/
[Split text files guide]: https://docs.groupdocs.com/merger/java/split-text-file/ |

##### split(ITextSplitOptions splitOptions)
```
public final void split(ITextSplitOptions splitOptions)
```

Splits the single document to the multiple documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| splitOptions | ITextSplitOptions | The text split options.

[How to split PDF_ Word_ Excel and PowerPoint documents in 3 lines of code]: https://docs.groupdocs.com/merger/java/split-document/
[Split text files guide]: https://docs.groupdocs.com/merger/java/split-text-file/ |

##### extractPages(IExtractOptions extractOptions)
```
public final void extractPages(IExtractOptions extractOptions)
```

Makes a new document with some pages from the source document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractOptions | IExtractOptions | The page options.

[How to extract pages from PDF_ Word_ Excel and PowerPoint documents]: https://docs.groupdocs.com/merger/java/extract-pages/ |

##### addPassword(IAddPasswordOptions addPasswordOptions)
```
public final void addPassword(IAddPasswordOptions addPasswordOptions)
```

Protects document with password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| addPasswordOptions | IAddPasswordOptions | The options for specifying the password.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/ |

##### isPasswordSet()
```
public final boolean isPasswordSet()
```

Checks whether document is password protected.

**Returns:**
boolean - Returns a value indicating whether document is protected or not.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/
##### removePassword()
```
public final void removePassword()
```

Removes password from document.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/

##### updatePassword(IUpdatePasswordOptions updatePasswordOptions)
```
public final void updatePassword(IUpdatePasswordOptions updatePasswordOptions)
```

Updates existing password for document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updatePasswordOptions | IUpdatePasswordOptions | The options for specifying the current/new passwords.

[How to protect PDF_ Word_ Excel and PowerPoint documents with password]: https://docs.groupdocs.com/merger/java/add-document-password/
[How to change document password]: https://docs.groupdocs.com/merger/java/update-document-password/
[How to check document password protection]: https://docs.groupdocs.com/merger/java/check-document-password-protection/
[How to remove PDF_ Word_ Excel and PowerPoint documents password]: https://docs.groupdocs.com/merger/java/remove-document-password/ |

##### changeOrientation(IOrientationOptions orientationOptions)
```
public final void changeOrientation(IOrientationOptions orientationOptions)
```

Applies a new orientation mode for the specified pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| orientationOptions | IOrientationOptions | The change orientation options.

[How to change Microsoft Word document pages orientation]: https://docs.groupdocs.com/merger/java/change-page-orientation/ |

##### movePage(IMoveOptions moveOptions)
```
public final void movePage(IMoveOptions moveOptions)
```

Moves page to a new position within document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| moveOptions | IMoveOptions | The move options.

[How to move PDF_ Word_ Excel and PowerPoint document pages]: https://docs.groupdocs.com/merger/java/move-page/ |

##### removePages(IRemoveOptions removeOptions)
```
public final void removePages(IRemoveOptions removeOptions)
```

Removes pages from document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeOptions | IRemoveOptions | The options for the numbers of pages to be removed.

[How to remove page from PDF_ Word_ Excel or PowerPoint document]: https://docs.groupdocs.com/merger/java/remove-pages/ |

##### swapPages(ISwapOptions swapOptions)
```
public final void swapPages(ISwapOptions swapOptions)
```

Swaps two pages within document of known format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| swapOptions | ISwapOptions | The swap options.

[How to swap pages inside PDF_ Word_ Excel or PowerPoint document]: https://docs.groupdocs.com/merger/java/swap-pages/ |

##### rotatePages(IRotateOptions rotateOptions)
```
public final void rotatePages(IRotateOptions rotateOptions)
```

Rotate pages of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rotateOptions | IRotateOptions | The options for the page rotating.

[How to rotate PDF document pages]: https://docs.groupdocs.com/merger/java/rotate-pages/ |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

**Returns:**
IDocumentInfo - Information about document properties.

[How to get document info using GroupDocs.Merger]: https://docs.groupdocs.com/merger/java/get-document-information/
##### generatePreview(IPreviewOptions previewOptions)
```
public final void generatePreview(IPreviewOptions previewOptions)
```

Generates document pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | IPreviewOptions | The preview options.

[How to generate document pages preview using GroupDocs.Merger]: https://docs.groupdocs.com/merger/java/generate-document-pages-preview/ |

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves the result document to the stream  document .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The document stream. |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or full file path. |

##### save(String filePath, boolean useDefaultDirectory)
```
public final void save(String filePath, boolean useDefaultDirectory)
```

Saves the result document file to  filePath .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path or name in case of default directory usage. |
| useDefaultDirectory | boolean | Use the default directory from settings. |

### MergerSettings
Path: https://reference.groupdocs.com/merger/nodejs-java/com.groupdocs.merger/mergersettings.md

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

Defines settings for customizing Merger behaviour.
#### Constructors

| Constructor | Description |
| --- | --- |
| MergerSettings() | Initializes new instance of MergerSettings class. |
| MergerSettings(ILogger logger) | Initializes new instance of MergerSettings class. |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | The logger implementation used for tracking document processing workflow. |
| setLogger(ILogger value) | The logger implementation used for tracking document processing workflow. |
##### MergerSettings()
```
public MergerSettings()
```

Initializes new instance of MergerSettings class.

##### MergerSettings(ILogger logger)
```
public MergerSettings(ILogger logger)
```

Initializes new instance of MergerSettings class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | The logger implementation. |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for tracking document processing workflow.

**Returns:**
ILogger
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

The logger implementation used for tracking document processing workflow.

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

## Python

### GroupDocs.Merger for Python via .NET
Path: https://reference.groupdocs.com/merger/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.merger` | Main GroupDocs.Merger namespace with top-level API classes. |
| `groupdocs.merger.domain` | Types under `groupdocs.merger.domain`. |
| `groupdocs.merger.domain.builders` | Types under `groupdocs.merger.domain.builders`. |
| `groupdocs.merger.domain.common` | Types under `groupdocs.merger.domain.common`. |
| `groupdocs.merger.domain.options` | Option classes for configuring conversions and operations. |
| `groupdocs.merger.domain.result` | Types under `groupdocs.merger.domain.result`. |
| `groupdocs.merger.logging` | Logging hooks and listener interfaces. |

### groupdocs.merger.domain.builders
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders.md

Types under `groupdocs.merger.domain.builders`.

##### Classes
| Class | Description |
| :- | :- |
| `PageBuilder` |  |

### PageBuilder class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder.md

#### PageBuilder class

The PageBuilder type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_page_int32_int32 |  |
| _add_page_ipage_info |  |
| _add_page_range_ipage_info_array |  |
| _clear_noargs |  |
| _init_noargs |  |
| _init_page_builder_options |  |
| add_page |  |
| add_page_int32 |  |
| add_page_ipage_info |  |
| add_page_range |  |
| add_page_range_ipage_info |  |
| clear |  |

##### Properties
| Property | Description |
| :- | :- |
| documents |  |
| options |  |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_page_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_add_page_int32_int32.md

#### _add_page_int32_int32

```python
def _add_page_int32_int32(self, document_index, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_index | `int` |  |
| page_number | `int` |  |

### _add_page_ipage_info method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_add_page_ipage_info.md

#### _add_page_ipage_info

```python
def _add_page_ipage_info(self, page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page | `IPageInfo` |  |

### _add_page_range_ipage_info_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_add_page_range_ipage_info_array.md

#### _add_page_range_ipage_info_array

```python
def _add_page_range_ipage_info_array(self, pages):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pages | `List[IPageInfo]` |  |

### _clear_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_clear_noargs.md

#### _clear_noargs

```python
def _clear_noargs(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_page_builder_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/_init_page_builder_options.md

#### _init_page_builder_options

```python
def _init_page_builder_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `PageBuilderOptions` |  |

### add_page method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/add_page.md

#### add_page

```python
def add_page(self):
    ...
```

### add_page_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/add_page_int32.md

#### add_page_int32

```python
def add_page_int32(self):
    ...
```

### add_page_ipage_info method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/add_page_ipage_info.md

#### add_page_ipage_info

```python
def add_page_ipage_info(self):
    ...
```

### add_page_range method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/add_page_range.md

#### add_page_range

```python
def add_page_range(self):
    ...
```

### add_page_range_ipage_info method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/add_page_range_ipage_info.md

#### add_page_range_ipage_info

```python
def add_page_range_ipage_info(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/clear.md

#### clear

```python
def clear(self):
    ...
```

### documents property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/documents.md

##### Definition:
```python
@property
def documents(self):
    ...
```

### options property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/options.md

##### Definition:
```python
@property
def options(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.builders/pagebuilder/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### groupdocs.merger.domain.common
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common.md

Types under `groupdocs.merger.domain.common`.

##### Classes
| Class | Description |
| :- | :- |
| `CreatePageStream` |  |
| `CreateSplitStream` |  |
| `Func` |  |
| `ReleasePageStream` |  |
| `ReleaseSplitStream` |  |

### CreatePageStream class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream.md

#### CreatePageStream class

The CreatePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32 |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_async_callback_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/_begin_invoke_int32_async_callback_object.md

#### _begin_invoke_int32_async_callback_object

```python
def _begin_invoke_int32_async_callback_object(self, page_number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/_invoke_int32.md

#### _invoke_int32

```python
def _invoke_int32(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### CreateSplitStream class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream.md

#### CreateSplitStream class

The CreateSplitStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32 |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_async_callback_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/_begin_invoke_int32_async_callback_object.md

#### _begin_invoke_int32_async_callback_object

```python
def _begin_invoke_int32_async_callback_object(self, number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/_invoke_int32.md

#### _invoke_int32

```python
def _invoke_int32(self, number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/createsplitstream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### Func class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func.md

#### Func class

The Func type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_arg_arg_arg_arg_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_arg_arg_arg_arg |  |
| begin_invoke |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_arg_arg_arg_arg_async_callback_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/_begin_invoke_arg_arg_arg_arg_async_callback_object.md

#### _begin_invoke_arg_arg_arg_arg_async_callback_object

```python
def _begin_invoke_arg_arg_arg_arg_async_callback_object(self, arg1, arg2, arg3, arg4, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| arg1 | `Any` |  |
| arg2 | `Any` |  |
| arg3 | `Any` |  |
| arg4 | `Any` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Any

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_arg_arg_arg_arg method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/_invoke_arg_arg_arg_arg.md

#### _invoke_arg_arg_arg_arg

```python
def _invoke_arg_arg_arg_arg(self, arg1, arg2, arg3, arg4):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| arg1 | `Any` |  |
| arg2 | `Any` |  |
| arg3 | `Any` |  |
| arg4 | `Any` |  |

**Returns:** Any

### begin_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/func/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream.md

#### ReleasePageStream class

The ReleasePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_stream |  |
| 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/merger/python-net/groupdocs.merger.domain.common/releasepagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_stream_async_callback_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/_begin_invoke_int32_stream_async_callback_object.md

#### _begin_invoke_int32_stream_async_callback_object

```python
def _begin_invoke_int32_stream_async_callback_object(self, page_number, create_page_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| create_page_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/_invoke_int32_stream.md

#### _invoke_int32_stream

```python
def _invoke_int32_stream(self, page_number, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| create_page_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### ReleaseSplitStream class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream.md

#### ReleaseSplitStream class

The ReleaseSplitStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_stream |  |
| 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/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_stream_async_callback_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/_begin_invoke_int32_stream_async_callback_object.md

#### _begin_invoke_int32_stream_async_callback_object

```python
def _begin_invoke_int32_stream_async_callback_object(self, number, create_split_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| create_split_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/_invoke_int32_stream.md

#### _invoke_int32_stream

```python
def _invoke_int32_stream(self, number, create_split_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| create_split_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.common/releasesplitstream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### groupdocs.merger.domain.options
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `AddPasswordOptions` |  |
| `ExtractOptions` |  |
| `IAddPasswordOptions` |  |
| `IExtractOptions` |  |
| `IImageJoinOptions` |  |
| `IImportDocumentOptions` |  |
| `IJoinOptions` |  |
| `ILoadOptions` |  |
| `IMoveOptions` |  |
| `IOleDiagramOptions` |  |
| `IOlePresentationOptions` |  |
| `IOleSpreadsheetOptions` |  |
| `IOleWordProcessingOptions` |  |
| `IOrientationOptions` |  |
| `IPageBuilderOptions` |  |
| `IPageJoinOptions` |  |
| `IPageOptions` |  |
| `IPager` |  |
| `IPdfAttachmentOptions` |  |
| `IPreviewOptions` |  |
| `IRemoveOptions` |  |
| `IRotateOptions` |  |
| `ISaveOptions` |  |
| `ISizeOptions` |  |
| `ISplitOptions` |  |
| `ISwapOptions` |  |
| `ITextSplitOptions` |  |
| `IUpdatePasswordOptions` |  |
| `ImageJoinOptions` |  |
| `ImportDocumentOptions` |  |
| `JoinOptions` |  |
| `LoadOptions` |  |
| `MoveOptions` |  |
| `OleDiagramOptions` |  |
| `OlePresentationOptions` |  |
| `OleSpreadsheetOptions` |  |
| `OleWordProcessingOptions` |  |
| `OrientationOptions` |  |
| `PageBuilderOptions` |  |
| `PageJoinOptions` |  |
| `PageOptions` |  |
| `PdfAccesibilitySettings` |  |
| `PdfAttachmentOptions` |  |
| `PdfJoinOptions` |  |
| `PdfSaveOptions` |  |
| `PdfSecurityOptions` |  |
| `PreviewOptions` |  |
| `RemoveOptions` |  |
| `RotateOptions` |  |
| `SaveOptions` |  |
| `SplitOptions` |  |
| `SwapOptions` |  |
| `TextSplitOptions` |  |
| `UpdatePasswordOptions` |  |
| `WordJoinOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `IOptions` |  |
| `ImageJoinMode` |  |
| `OrientationMode` |  |
| `PdfSecurityPermissions` |  |
| `PreviewMode` |  |
| `RangeMode` |  |
| `RotateMode` |  |
| `SplitMode` |  |
| `TextSplitMode` |  |
| `WordJoinCompliance` |  |
| `WordJoinMode` |  |

### AddPasswordOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/addpasswordoptions.md

#### AddPasswordOptions class

The AddPasswordOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/addpasswordoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/addpasswordoptions/_init_string.md

#### _init_string

```python
def _init_string(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |

### password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/addpasswordoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### ExtractOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions.md

#### ExtractOptions class

The ExtractOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_array |  |
| _init_int32_int32 |  |
| _init_int32_int32_range_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_numbers | `List[int]` |  |

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/_init_int32_int32_range_mode.md

#### _init_int32_int32_range_mode

```python
def _init_int32_int32_range_mode(self, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/extractoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IAddPasswordOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iaddpasswordoptions.md

#### IAddPasswordOptions class

The IAddPasswordOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iaddpasswordoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### IExtractOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iextractoptions.md

#### IExtractOptions class

The IExtractOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iextractoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IImageJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimagejoinoptions.md

#### IImageJoinOptions class

The IImageJoinOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| type |  |

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimagejoinoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimagejoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### IImportDocumentOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimportdocumentoptions.md

#### IImportDocumentOptions class

The IImportDocumentOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| object_data |  |
| page_number |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimportdocumentoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimportdocumentoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iimportdocumentoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### IJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ijoinoptions.md

#### IJoinOptions class

The IJoinOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type |  |

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ijoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### ILoadOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iloadoptions.md

#### ILoadOptions class

The ILoadOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| extension |  |
| password |  |
| type |  |

### encoding property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iloadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iloadoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iloadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iloadoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### ImageJoinMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinmode.md

#### ImageJoinMode class

The ImageJoinMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HORIZONTAL |  |
| VERTICAL |  |

### HORIZONTAL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinmode/horizontal.md

##### Value
`0`

### VERTICAL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinmode/vertical.md

##### Value
`1`

### ImageJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions.md

#### ImageJoinOptions class

The ImageJoinOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_file_type_image_join_mode |  |
| _init_image_join_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_file_type_image_join_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/_init_file_type_image_join_mode.md

#### _init_file_type_image_join_mode

```python
def _init_file_type_image_join_mode(self, file_type, image_join_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| image_join_mode | `ImageJoinMode` |  |

### _init_image_join_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/_init_image_join_mode.md

#### _init_image_join_mode

```python
def _init_image_join_mode(self, image_join_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_join_mode | `ImageJoinMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imagejoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### IMoveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imoveoptions.md

#### IMoveOptions class

The IMoveOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| new_page_number |  |
| page_number_to_move |  |

### new_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imoveoptions/new_page_number.md

##### Definition:
```python
@property
def new_page_number(self):
    ...
```

### page_number_to_move property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/imoveoptions/page_number_to_move.md

##### Definition:
```python
@property
def page_number_to_move(self):
    ...
```

### ImportDocumentOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/importdocumentoptions.md

#### ImportDocumentOptions class

The ImportDocumentOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| object_data |  |
| page_number |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/importdocumentoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/importdocumentoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/importdocumentoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### IOleDiagramOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions.md

#### IOleDiagramOptions class

The IOleDiagramOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| image_data |  |
| object_data |  |
| page_number |  |
| width |  |
| x |  |
| y |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolediagramoptions/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### IOlePresentationOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions.md

#### IOlePresentationOptions class

The IOlePresentationOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| object_data |  |
| page_number |  |
| width |  |
| x |  |
| y |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolepresentationoptions/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### IOleSpreadsheetOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions.md

#### IOleSpreadsheetOptions class

The IOleSpreadsheetOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| column_index |  |
| extension |  |
| height |  |
| image_data |  |
| object_data |  |
| page_number |  |
| row_index |  |
| width |  |

### column_index property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/column_index.md

##### Definition:
```python
@property
def column_index(self):
    ...
@column_index.setter
def column_index(self, value):
    ...
```

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### row_index property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/row_index.md

##### Definition:
```python
@property
def row_index(self):
    ...
@row_index.setter
def row_index(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolespreadsheetoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### IOleWordProcessingOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions.md

#### IOleWordProcessingOptions class

The IOleWordProcessingOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| image_data |  |
| left |  |
| object_data |  |
| page_number |  |
| top |  |
| width |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/left.md

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/top.md

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iolewordprocessingoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### IOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ioptions.md

#### IOptions class

The IOptions type exposes the following members:

### IOrientationOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iorientationoptions.md

#### IOrientationOptions class

The IOrientationOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| pages |  |

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iorientationoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iorientationoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IPageBuilderOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipagebuilderoptions.md

#### IPageBuilderOptions class

The IPageBuilderOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| load_document_info |  |

### load_document_info property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipagebuilderoptions/load_document_info.md

##### Definition:
```python
@property
def load_document_info(self):
    ...
@load_document_info.setter
def load_document_info(self, value):
    ...
```

### IPageJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipagejoinoptions.md

#### IPageJoinOptions class

The IPageJoinOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |
| type |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipagejoinoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipagejoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### IPageOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipageoptions.md

#### IPageOptions class

The IPageOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipageoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IPager class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipager.md

#### IPager class

The IPager type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipager/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IPdfAttachmentOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipdfattachmentoptions.md

#### IPdfAttachmentOptions class

The IPdfAttachmentOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| object_data |  |
| page_number |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipdfattachmentoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipdfattachmentoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipdfattachmentoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### IPreviewOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions.md

#### IPreviewOptions class

The IPreviewOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_page_number_int32_string |  |
| _validate_file_type |  |
| get_path_by_page_number |  |
| get_path_by_page_number_file |  |
| get_path_by_page_number_int32 |  |
| get_path_by_page_number_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| height |  |
| mode |  |
| pages |  |
| release_stream |  |
| resolution |  |
| width |  |

### _get_path_by_page_number_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/_get_path_by_page_number_int32_string.md

#### _get_path_by_page_number_int32_string

```python
def _get_path_by_page_number_int32_string(self, page_number, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| extension | `str` |  |

**Returns:** str

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_page_number method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/get_path_by_page_number.md

#### get_path_by_page_number

```python
def get_path_by_page_number(self):
    ...
```

### get_path_by_page_number_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/get_path_by_page_number_file.md

#### get_path_by_page_number_file

```python
def get_path_by_page_number_file(self):
    ...
```

### get_path_by_page_number_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/get_path_by_page_number_int32.md

#### get_path_by_page_number_int32

```python
def get_path_by_page_number_int32(self):
    ...
```

### get_path_by_page_number_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/get_path_by_page_number_string.md

#### get_path_by_page_number_string

```python
def get_path_by_page_number_string(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/resolution.md

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/ipreviewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### IRemoveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iremoveoptions.md

#### IRemoveOptions class

The IRemoveOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iremoveoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### IRotateOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/irotateoptions.md

#### IRotateOptions class

The IRotateOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| pages |  |

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/irotateoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/irotateoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### ISaveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isaveoptions.md

#### ISaveOptions class

The ISaveOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type |  |

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isaveoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### ISizeOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isizeoptions.md

#### ISizeOptions class

The ISizeOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| width |  |

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isizeoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isizeoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ISplitOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions.md

#### ISplitOptions class

The ISplitOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_index_int32_string |  |
| _validate_file_type |  |
| get_path_by_index |  |
| get_path_by_index_file |  |
| get_path_by_index_int32 |  |
| get_path_by_index_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| mode |  |
| pages |  |
| release_stream |  |

### _get_path_by_index_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/_get_path_by_index_int32_string.md

#### _get_path_by_index_int32_string

```python
def _get_path_by_index_int32_string(self, index, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |
| extension | `str` |  |

**Returns:** str

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_index method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/get_path_by_index.md

#### get_path_by_index

```python
def get_path_by_index(self):
    ...
```

### get_path_by_index_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/get_path_by_index_file.md

#### get_path_by_index_file

```python
def get_path_by_index_file(self):
    ...
```

### get_path_by_index_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/get_path_by_index_int32.md

#### get_path_by_index_int32

```python
def get_path_by_index_int32(self):
    ...
```

### get_path_by_index_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/get_path_by_index_string.md

#### get_path_by_index_string

```python
def get_path_by_index_string(self):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/isplitoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### ISwapOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iswapoptions.md

#### ISwapOptions class

The ISwapOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| first_page_number |  |
| second_page_number |  |

### first_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iswapoptions/first_page_number.md

##### Definition:
```python
@property
def first_page_number(self):
    ...
```

### second_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iswapoptions/second_page_number.md

##### Definition:
```python
@property
def second_page_number(self):
    ...
```

### ITextSplitOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions.md

#### ITextSplitOptions class

The ITextSplitOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_index_int32_string |  |
| _validate_file_type |  |
| get_path_by_index |  |
| get_path_by_index_file |  |
| get_path_by_index_int32 |  |
| get_path_by_index_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| line_numbers |  |
| mode |  |
| release_stream |  |

### _get_path_by_index_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/_get_path_by_index_int32_string.md

#### _get_path_by_index_int32_string

```python
def _get_path_by_index_int32_string(self, index, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |
| extension | `str` |  |

**Returns:** str

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_index method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/get_path_by_index.md

#### get_path_by_index

```python
def get_path_by_index(self):
    ...
```

### get_path_by_index_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/get_path_by_index_file.md

#### get_path_by_index_file

```python
def get_path_by_index_file(self):
    ...
```

### get_path_by_index_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/get_path_by_index_int32.md

#### get_path_by_index_int32

```python
def get_path_by_index_int32(self):
    ...
```

### get_path_by_index_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/get_path_by_index_string.md

#### get_path_by_index_string

```python
def get_path_by_index_string(self):
    ...
```

### line_numbers property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/line_numbers.md

##### Definition:
```python
@property
def line_numbers(self):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/itextsplitoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### IUpdatePasswordOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iupdatepasswordoptions.md

#### IUpdatePasswordOptions class

The IUpdatePasswordOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| new_password |  |

### new_password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/iupdatepasswordoptions/new_password.md

##### Definition:
```python
@property
def new_password(self):
    ...
```

### JoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/joinoptions.md

#### JoinOptions class

The JoinOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/joinoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/joinoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/joinoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/joinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_file_type_file_type |  |
| _init_file_type_file_type_string |  |
| _init_file_type_file_type_string_encoding |  |
| _init_file_type_string |  |
| _init_file_type_string_encoding |  |
| _init_string |  |
| _init_string_encoding |  |
| _init_string_file_type_string_encoding |  |

##### Properties
| Property | Description |
| :- | :- |
| encoding |  |
| extension |  |
| password |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_file_type_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type_file_type.md

#### _init_file_type_file_type

```python
def _init_file_type_file_type(self, ini_file_type, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ini_file_type | `FileType` |  |
| file_type | `FileType` |  |

### _init_file_type_file_type_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type_file_type_string.md

#### _init_file_type_file_type_string

```python
def _init_file_type_file_type_string(self, ini_file_type, file_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ini_file_type | `FileType` |  |
| file_type | `FileType` |  |
| password | `str` |  |

### _init_file_type_file_type_string_encoding method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type_file_type_string_encoding.md

#### _init_file_type_file_type_string_encoding

```python
def _init_file_type_file_type_string_encoding(self, ini_file_type, file_type, password, encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ini_file_type | `FileType` |  |
| file_type | `FileType` |  |
| password | `str` |  |
| encoding | `Encoding` |  |

### _init_file_type_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type_string.md

#### _init_file_type_string

```python
def _init_file_type_string(self, file_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| password | `str` |  |

### _init_file_type_string_encoding method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_file_type_string_encoding.md

#### _init_file_type_string_encoding

```python
def _init_file_type_string_encoding(self, file_type, password, encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| password | `str` |  |
| encoding | `Encoding` |  |

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_string.md

#### _init_string

```python
def _init_string(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |

### _init_string_encoding method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_string_encoding.md

#### _init_string_encoding

```python
def _init_string_encoding(self, password, encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |
| encoding | `Encoding` |  |

### _init_string_file_type_string_encoding method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/_init_string_file_type_string_encoding.md

#### _init_string_file_type_string_encoding

```python
def _init_string_file_type_string_encoding(self, extension, file_type, password, encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |
| file_type | `FileType` |  |
| password | `str` |  |
| encoding | `Encoding` |  |

### encoding property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/loadoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### MoveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/moveoptions.md

#### MoveOptions class

The MoveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| new_page_number |  |
| page_number_to_move |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/moveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/moveoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, page_number_to_move, new_page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number_to_move | `int` |  |
| new_page_number | `int` |  |

### new_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/moveoptions/new_page_number.md

##### Definition:
```python
@property
def new_page_number(self):
    ...
```

### page_number_to_move property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/moveoptions/page_number_to_move.md

##### Definition:
```python
@property
def page_number_to_move(self):
    ...
```

### OleDiagramOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions.md

#### OleDiagramOptions class

The OleDiagramOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array_byte_array_string_int32 |  |
| _init_string_byte_array_int32 |  |
| _init_string_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| image_data |  |
| object_data |  |
| page_number |  |
| width |  |
| x |  |
| y |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array_byte_array_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/_init_byte_array_byte_array_string_int32.md

#### _init_byte_array_byte_array_string_int32

```python
def _init_byte_array_byte_array_string_int32(self, object_data, image_data, extension, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object_data | `bytes` |  |
| image_data | `bytes` |  |
| extension | `str` |  |
| page_number | `int` |  |

### _init_string_byte_array_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/_init_string_byte_array_int32.md

#### _init_string_byte_array_int32

```python
def _init_string_byte_array_int32(self, file_path, image_data, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| image_data | `bytes` |  |
| page_number | `int` |  |

### _init_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/_init_string_int32.md

#### _init_string_int32

```python
def _init_string_int32(self, file_path, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| page_number | `int` |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olediagramoptions/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### OlePresentationOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions.md

#### OlePresentationOptions class

The OlePresentationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array_string_int32 |  |
| _init_string_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| object_data |  |
| page_number |  |
| width |  |
| x |  |
| y |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/_init_byte_array_string_int32.md

#### _init_byte_array_string_int32

```python
def _init_byte_array_string_int32(self, object_data, extension, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object_data | `bytes` |  |
| extension | `str` |  |
| page_number | `int` |  |

### _init_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/_init_string_int32.md

#### _init_string_int32

```python
def _init_string_int32(self, file_path, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| page_number | `int` |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olepresentationoptions/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### OleSpreadsheetOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions.md

#### OleSpreadsheetOptions class

The OleSpreadsheetOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array_byte_array_string_int32 |  |
| _init_string_byte_array_int32 |  |
| _init_string_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| column_index |  |
| extension |  |
| height |  |
| image_data |  |
| object_data |  |
| page_number |  |
| row_index |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array_byte_array_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/_init_byte_array_byte_array_string_int32.md

#### _init_byte_array_byte_array_string_int32

```python
def _init_byte_array_byte_array_string_int32(self, object_data, image_data, extension, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object_data | `bytes` |  |
| image_data | `bytes` |  |
| extension | `str` |  |
| page_number | `int` |  |

### _init_string_byte_array_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/_init_string_byte_array_int32.md

#### _init_string_byte_array_int32

```python
def _init_string_byte_array_int32(self, file_path, image_data, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| image_data | `bytes` |  |
| page_number | `int` |  |

### _init_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/_init_string_int32.md

#### _init_string_int32

```python
def _init_string_int32(self, file_path, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| page_number | `int` |  |

### column_index property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/column_index.md

##### Definition:
```python
@property
def column_index(self):
    ...
@column_index.setter
def column_index(self, value):
    ...
```

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### row_index property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/row_index.md

##### Definition:
```python
@property
def row_index(self):
    ...
@row_index.setter
def row_index(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olespreadsheetoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### OleWordProcessingOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions.md

#### OleWordProcessingOptions class

The OleWordProcessingOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array_byte_array_string_int32 |  |
| _init_string_byte_array_int32 |  |
| _init_string_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| height |  |
| image_data |  |
| left |  |
| object_data |  |
| page_number |  |
| top |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array_byte_array_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/_init_byte_array_byte_array_string_int32.md

#### _init_byte_array_byte_array_string_int32

```python
def _init_byte_array_byte_array_string_int32(self, object_data, image_data, extension, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object_data | `bytes` |  |
| image_data | `bytes` |  |
| extension | `str` |  |
| page_number | `int` |  |

### _init_string_byte_array_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/_init_string_byte_array_int32.md

#### _init_string_byte_array_int32

```python
def _init_string_byte_array_int32(self, file_path, image_data, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| image_data | `bytes` |  |
| page_number | `int` |  |

### _init_string_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/_init_string_int32.md

#### _init_string_int32

```python
def _init_string_int32(self, file_path, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| page_number | `int` |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/image_data.md

##### Definition:
```python
@property
def image_data(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/left.md

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/top.md

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/olewordprocessingoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### OrientationMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationmode.md

#### OrientationMode class

The OrientationMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PORTRAIT |  |
| LANDSCAPE |  |

### LANDSCAPE field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationmode/landscape.md

##### Value
`1`

### PORTRAIT field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationmode/portrait.md

##### Value
`0`

### OrientationOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions.md

#### OrientationOptions class

The OrientationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_orientation_mode |  |
| _init_orientation_mode_int32_array |  |
| _init_orientation_mode_int32_int32 |  |
| _init_orientation_mode_int32_int32_range_mode |  |

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_orientation_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/_init_orientation_mode.md

#### _init_orientation_mode

```python
def _init_orientation_mode(self, orientation_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_mode | `OrientationMode` |  |

### _init_orientation_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/_init_orientation_mode_int32_array.md

#### _init_orientation_mode_int32_array

```python
def _init_orientation_mode_int32_array(self, orientation_mode, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_mode | `OrientationMode` |  |
| page_numbers | `List[int]` |  |

### _init_orientation_mode_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/_init_orientation_mode_int32_int32.md

#### _init_orientation_mode_int32_int32

```python
def _init_orientation_mode_int32_int32(self, orientation_mode, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_mode | `OrientationMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_orientation_mode_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/_init_orientation_mode_int32_int32_range_mode.md

#### _init_orientation_mode_int32_int32_range_mode

```python
def _init_orientation_mode_int32_int32_range_mode(self, orientation_mode, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_mode | `OrientationMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/orientationoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### PageBuilderOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagebuilderoptions.md

#### PageBuilderOptions class

The PageBuilderOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| load_document_info |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagebuilderoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagebuilderoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### load_document_info property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagebuilderoptions/load_document_info.md

##### Definition:
```python
@property
def load_document_info(self):
    ...
@load_document_info.setter
def load_document_info(self, value):
    ...
```

### PageJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions.md

#### PageJoinOptions class

The PageJoinOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_file_type_int32_array |  |
| _init_file_type_int32_int32 |  |
| _init_file_type_int32_int32_range_mode |  |
| _init_int32_array |  |
| _init_int32_int32 |  |
| _init_int32_int32_range_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| pages |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_file_type_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_file_type_int32_array.md

#### _init_file_type_int32_array

```python
def _init_file_type_int32_array(self, file_type, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| page_numbers | `List[int]` |  |

### _init_file_type_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_file_type_int32_int32.md

#### _init_file_type_int32_int32

```python
def _init_file_type_int32_int32(self, file_type, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_file_type_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_file_type_int32_int32_range_mode.md

#### _init_file_type_int32_int32_range_mode

```python
def _init_file_type_int32_int32_range_mode(self, file_type, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_numbers | `List[int]` |  |

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_int32_int32_range_mode.md

#### _init_int32_int32_range_mode

```python
def _init_int32_int32_range_mode(self, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pagejoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### PageOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pageoptions.md

#### PageOptions class

The PageOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pageoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### PdfAccesibilitySettings class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfaccesibilitysettings.md

#### PdfAccesibilitySettings class

The PdfAccesibilitySettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| enable_auto_tagging |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfaccesibilitysettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfaccesibilitysettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### enable_auto_tagging property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfaccesibilitysettings/enable_auto_tagging.md

##### Definition:
```python
@property
def enable_auto_tagging(self):
    ...
@enable_auto_tagging.setter
def enable_auto_tagging(self, value):
    ...
```

### PdfAttachmentOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions.md

#### PdfAttachmentOptions class

The PdfAttachmentOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte_array_string |  |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| object_data |  |
| page_number |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte_array_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/_init_byte_array_string.md

#### _init_byte_array_string

```python
def _init_byte_array_string(self, object_data, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object_data | `bytes` |  |
| extension | `str` |  |

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### object_data property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/object_data.md

##### Definition:
```python
@property
def object_data(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfattachmentoptions/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### PdfJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions.md

#### PdfJoinOptions class

The PdfJoinOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_file_type_int32_array |  |
| _init_file_type_int32_int32 |  |
| _init_file_type_int32_int32_range_mode |  |
| _init_int32_array |  |
| _init_int32_int32 |  |
| _init_int32_int32_range_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| pages |  |
| preserve_accessibility |  |
| type |  |
| use_bookmarks |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_file_type_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_file_type_int32_array.md

#### _init_file_type_int32_array

```python
def _init_file_type_int32_array(self, file_type, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| page_numbers | `List[int]` |  |

### _init_file_type_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_file_type_int32_int32.md

#### _init_file_type_int32_int32

```python
def _init_file_type_int32_int32(self, file_type, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_file_type_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_file_type_int32_int32_range_mode.md

#### _init_file_type_int32_int32_range_mode

```python
def _init_file_type_int32_int32_range_mode(self, file_type, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_numbers | `List[int]` |  |

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_int32_int32_range_mode.md

#### _init_int32_int32_range_mode

```python
def _init_int32_int32_range_mode(self, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### preserve_accessibility property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/preserve_accessibility.md

##### Definition:
```python
@property
def preserve_accessibility(self):
    ...
@preserve_accessibility.setter
def preserve_accessibility(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### use_bookmarks property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfjoinoptions/use_bookmarks.md

##### Definition:
```python
@property
def use_bookmarks(self):
    ...
@use_bookmarks.setter
def use_bookmarks(self, value):
    ...
```

### PdfSaveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsaveoptions.md

#### PdfSaveOptions class

The PdfSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| accesibility_settings |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsaveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsaveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### accesibility_settings property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsaveoptions/accesibility_settings.md

##### Definition:
```python
@property
def accesibility_settings(self):
    ...
@accesibility_settings.setter
def accesibility_settings(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsaveoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### PdfSecurityOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions.md

#### PdfSecurityOptions class

The PdfSecurityOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| owner_password |  |
| password |  |
| permissions |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions/_init_string.md

#### _init_string

```python
def _init_string(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |

### owner_password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions/owner_password.md

##### Definition:
```python
@property
def owner_password(self):
    ...
@owner_password.setter
def owner_password(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
```

### permissions property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecurityoptions/permissions.md

##### Definition:
```python
@property
def permissions(self):
    ...
@permissions.setter
def permissions(self, value):
    ...
```

### PdfSecurityPermissions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions.md

#### PdfSecurityPermissions class

The PdfSecurityPermissions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ALL |  |
| DENY_PRINTING |  |
| DENY_MODIFICATION |  |
| DENY_DATA_EXTRACTION |  |
| DENY_ALL |  |

### ALLOW_ALL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions/allow_all.md

##### Value
`0`

### DENY_ALL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions/deny_all.md

##### Value
`7`

### DENY_DATA_EXTRACTION field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions/deny_data_extraction.md

##### Value
`4`

### DENY_MODIFICATION field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions/deny_modification.md

##### Value
`2`

### DENY_PRINTING field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/pdfsecuritypermissions/deny_printing.md

##### Value
`1`

### PreviewMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewmode.md

#### PreviewMode class

The PreviewMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PNG |  |
| JPEG |  |
| BMP |  |

### BMP field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewmode/bmp.md

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewmode/jpeg.md

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewmode/png.md

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions.md

#### PreviewOptions class

The PreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_page_number_int32_string |  |
| _init_create_page_stream_preview_mode |  |
| _init_create_page_stream_preview_mode_int32_array |  |
| _init_create_page_stream_preview_mode_int32_int32 |  |
| _init_create_page_stream_preview_mode_int32_int32_range_mode |  |
| _init_create_page_stream_release_page_stream_preview_mode |  |
| _init_create_page_stream_release_page_stream_preview_mode_int32_array |  |
| _init_create_page_stream_release_page_stream_preview_mode_int32_int32 |  |
| _init_create_page_stream_release_page_stream_preview_mode_int32_int32_range_mode |  |
| _validate_file_type |  |
| get_path_by_page_number |  |
| get_path_by_page_number_file |  |
| get_path_by_page_number_int32 |  |
| get_path_by_page_number_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| height |  |
| mode |  |
| pages |  |
| release_stream |  |
| resolution |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_path_by_page_number_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_get_path_by_page_number_int32_string.md

#### _get_path_by_page_number_int32_string

```python
def _get_path_by_page_number_int32_string(self, page_number, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| extension | `str` |  |

**Returns:** str

### _init_create_page_stream_preview_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_preview_mode.md

#### _init_create_page_stream_preview_mode

```python
def _init_create_page_stream_preview_mode(self, create_page_stream, preview_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| preview_mode | `PreviewMode` |  |

### _init_create_page_stream_preview_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_preview_mode_int32_array.md

#### _init_create_page_stream_preview_mode_int32_array

```python
def _init_create_page_stream_preview_mode_int32_array(self, create_page_stream, preview_mode, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| preview_mode | `PreviewMode` |  |
| page_numbers | `List[int]` |  |

### _init_create_page_stream_preview_mode_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_preview_mode_int32_int32.md

#### _init_create_page_stream_preview_mode_int32_int32

```python
def _init_create_page_stream_preview_mode_int32_int32(self, create_page_stream, preview_mode, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| preview_mode | `PreviewMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_create_page_stream_preview_mode_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_preview_mode_int32_int32_range_mode.md

#### _init_create_page_stream_preview_mode_int32_int32_range_mode

```python
def _init_create_page_stream_preview_mode_int32_int32_range_mode(self, create_page_stream, preview_mode, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| preview_mode | `PreviewMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_create_page_stream_release_page_stream_preview_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_release_page_stream_preview_mode.md

#### _init_create_page_stream_release_page_stream_preview_mode

```python
def _init_create_page_stream_release_page_stream_preview_mode(self, create_page_stream, release_page_stream, preview_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |
| preview_mode | `PreviewMode` |  |

### _init_create_page_stream_release_page_stream_preview_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_release_page_stream_preview_mode_int32_array.md

#### _init_create_page_stream_release_page_stream_preview_mode_int32_array

```python
def _init_create_page_stream_release_page_stream_preview_mode_int32_array(self, create_page_stream, release_page_stream, preview_mode, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |
| preview_mode | `PreviewMode` |  |
| page_numbers | `List[int]` |  |

### _init_create_page_stream_release_page_stream_preview_mode_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_release_page_stream_preview_mode_int32_int32.md

#### _init_create_page_stream_release_page_stream_preview_mode_int32_int32

```python
def _init_create_page_stream_release_page_stream_preview_mode_int32_int32(self, create_page_stream, release_page_stream, preview_mode, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |
| preview_mode | `PreviewMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_create_page_stream_release_page_stream_preview_mode_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_init_create_page_stream_release_page_stream_preview_mode_int32_int32_range_mode.md

#### _init_create_page_stream_release_page_stream_preview_mode_int32_int32_range_mode

```python
def _init_create_page_stream_release_page_stream_preview_mode_int32_int32_range_mode(self, create_page_stream, release_page_stream, preview_mode, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |
| preview_mode | `PreviewMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_page_number method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/get_path_by_page_number.md

#### get_path_by_page_number

```python
def get_path_by_page_number(self):
    ...
```

### get_path_by_page_number_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/get_path_by_page_number_file.md

#### get_path_by_page_number_file

```python
def get_path_by_page_number_file(self):
    ...
```

### get_path_by_page_number_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/get_path_by_page_number_int32.md

#### get_path_by_page_number_int32

```python
def get_path_by_page_number_int32(self):
    ...
```

### get_path_by_page_number_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/get_path_by_page_number_string.md

#### get_path_by_page_number_string

```python
def get_path_by_page_number_string(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/resolution.md

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/previewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### RangeMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rangemode.md

#### RangeMode class

The RangeMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALL_PAGES |  |
| ODD_PAGES |  |
| EVEN_PAGES |  |

### ALL_PAGES field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rangemode/all_pages.md

##### Value
`0`

### EVEN_PAGES field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rangemode/even_pages.md

##### Value
`2`

### ODD_PAGES field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rangemode/odd_pages.md

##### Value
`1`

### RemoveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions.md

#### RemoveOptions class

The RemoveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_array |  |
| _init_int32_int32 |  |
| _init_int32_int32_range_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_numbers | `List[int]` |  |

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/_init_int32_int32_range_mode.md

#### _init_int32_int32_range_mode

```python
def _init_int32_int32_range_mode(self, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/removeoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### RotateMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotatemode.md

#### RotateMode class

The RotateMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ROTATE90 |  |
| ROTATE180 |  |
| ROTATE270 |  |

### ROTATE180 field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotatemode/rotate180.md

##### Value
`180`

### ROTATE270 field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotatemode/rotate270.md

##### Value
`270`

### ROTATE90 field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotatemode/rotate90.md

##### Value
`90`

### RotateOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions.md

#### RotateOptions class

The RotateOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_rotate_mode |  |
| _init_rotate_mode_int32_array |  |
| _init_rotate_mode_int32_int32 |  |
| _init_rotate_mode_int32_int32_range_mode |  |

##### Properties
| Property | Description |
| :- | :- |
| mode |  |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_rotate_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/_init_rotate_mode.md

#### _init_rotate_mode

```python
def _init_rotate_mode(self, rotate_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_mode | `RotateMode` |  |

### _init_rotate_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/_init_rotate_mode_int32_array.md

#### _init_rotate_mode_int32_array

```python
def _init_rotate_mode_int32_array(self, rotate_mode, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_mode | `RotateMode` |  |
| page_numbers | `List[int]` |  |

### _init_rotate_mode_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/_init_rotate_mode_int32_int32.md

#### _init_rotate_mode_int32_int32

```python
def _init_rotate_mode_int32_int32(self, rotate_mode, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_mode | `RotateMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_rotate_mode_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/_init_rotate_mode_int32_int32_range_mode.md

#### _init_rotate_mode_int32_int32_range_mode

```python
def _init_rotate_mode_int32_int32_range_mode(self, rotate_mode, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_mode | `RotateMode` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/rotateoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### SaveOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/saveoptions.md

#### SaveOptions class

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/saveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/saveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/saveoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### SplitMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitmode.md

#### SplitMode class

The SplitMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PAGES |  |
| INTERVAL |  |

### INTERVAL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitmode/interval.md

##### Value
`1`

### PAGES field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitmode/pages.md

##### Value
`0`

### SplitOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions.md

#### SplitOptions class

The SplitOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_index_int32_string |  |
| _init_create_split_stream |  |
| _init_create_split_stream_int32_array |  |
| _init_create_split_stream_int32_array_split_mode |  |
| _init_create_split_stream_int32_int32 |  |
| _init_create_split_stream_int32_int32_range_mode |  |
| _init_create_split_stream_release_split_stream |  |
| _init_create_split_stream_release_split_stream_int32_array |  |
| _init_create_split_stream_release_split_stream_int32_array_split_mode |  |
| _init_create_split_stream_release_split_stream_int32_int32 |  |
| _init_create_split_stream_release_split_stream_int32_int32_range_mode |  |
| _init_string_int32_array |  |
| _init_string_int32_array_split_mode |  |
| _init_string_int32_int32 |  |
| _init_string_int32_int32_range_mode |  |
| _validate_file_type |  |
| get_path_by_index |  |
| get_path_by_index_file |  |
| get_path_by_index_int32 |  |
| get_path_by_index_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| mode |  |
| pages |  |
| release_stream |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_path_by_index_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_get_path_by_index_int32_string.md

#### _get_path_by_index_int32_string

```python
def _get_path_by_index_int32_string(self, index, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |
| extension | `str` |  |

**Returns:** str

### _init_create_split_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream.md

#### _init_create_split_stream

```python
def _init_create_split_stream(self, create_split_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |

### _init_create_split_stream_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_int32_array.md

#### _init_create_split_stream_int32_array

```python
def _init_create_split_stream_int32_array(self, create_split_stream, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| page_numbers | `List[int]` |  |

### _init_create_split_stream_int32_array_split_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_int32_array_split_mode.md

#### _init_create_split_stream_int32_array_split_mode

```python
def _init_create_split_stream_int32_array_split_mode(self, create_split_stream, page_numbers, split_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| page_numbers | `List[int]` |  |
| split_mode | `SplitMode` |  |

### _init_create_split_stream_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_int32_int32.md

#### _init_create_split_stream_int32_int32

```python
def _init_create_split_stream_int32_int32(self, create_split_stream, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_create_split_stream_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_int32_int32_range_mode.md

#### _init_create_split_stream_int32_int32_range_mode

```python
def _init_create_split_stream_int32_int32_range_mode(self, create_split_stream, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_create_split_stream_release_split_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_release_split_stream.md

#### _init_create_split_stream_release_split_stream

```python
def _init_create_split_stream_release_split_stream(self, create_split_stream, release_split_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |

### _init_create_split_stream_release_split_stream_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_release_split_stream_int32_array.md

#### _init_create_split_stream_release_split_stream_int32_array

```python
def _init_create_split_stream_release_split_stream_int32_array(self, create_split_stream, release_split_stream, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| page_numbers | `List[int]` |  |

### _init_create_split_stream_release_split_stream_int32_array_split_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_release_split_stream_int32_array_split_mode.md

#### _init_create_split_stream_release_split_stream_int32_array_split_mode

```python
def _init_create_split_stream_release_split_stream_int32_array_split_mode(self, create_split_stream, release_split_stream, page_numbers, split_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| page_numbers | `List[int]` |  |
| split_mode | `SplitMode` |  |

### _init_create_split_stream_release_split_stream_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_release_split_stream_int32_int32.md

#### _init_create_split_stream_release_split_stream_int32_int32

```python
def _init_create_split_stream_release_split_stream_int32_int32(self, create_split_stream, release_split_stream, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_create_split_stream_release_split_stream_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_create_split_stream_release_split_stream_int32_int32_range_mode.md

#### _init_create_split_stream_release_split_stream_int32_int32_range_mode

```python
def _init_create_split_stream_release_split_stream_int32_int32_range_mode(self, create_split_stream, release_split_stream, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_string_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_string_int32_array.md

#### _init_string_int32_array

```python
def _init_string_int32_array(self, file_path_format, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| page_numbers | `List[int]` |  |

### _init_string_int32_array_split_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_string_int32_array_split_mode.md

#### _init_string_int32_array_split_mode

```python
def _init_string_int32_array_split_mode(self, file_path_format, page_numbers, split_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| page_numbers | `List[int]` |  |
| split_mode | `SplitMode` |  |

### _init_string_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_string_int32_int32.md

#### _init_string_int32_int32

```python
def _init_string_int32_int32(self, file_path_format, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_string_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_init_string_int32_int32_range_mode.md

#### _init_string_int32_int32_range_mode

```python
def _init_string_int32_int32_range_mode(self, file_path_format, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_index method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/get_path_by_index.md

#### get_path_by_index

```python
def get_path_by_index(self):
    ...
```

### get_path_by_index_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/get_path_by_index_file.md

#### get_path_by_index_file

```python
def get_path_by_index_file(self):
    ...
```

### get_path_by_index_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/get_path_by_index_int32.md

#### get_path_by_index_int32

```python
def get_path_by_index_int32(self):
    ...
```

### get_path_by_index_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/get_path_by_index_string.md

#### get_path_by_index_string

```python
def get_path_by_index_string(self):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/splitoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### SwapOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/swapoptions.md

#### SwapOptions class

The SwapOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| first_page_number |  |
| second_page_number |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/swapoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/swapoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, first_page_number, second_page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| first_page_number | `int` |  |
| second_page_number | `int` |  |

### first_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/swapoptions/first_page_number.md

##### Definition:
```python
@property
def first_page_number(self):
    ...
```

### second_page_number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/swapoptions/second_page_number.md

##### Definition:
```python
@property
def second_page_number(self):
    ...
```

### TextSplitMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitmode.md

#### TextSplitMode class

The TextSplitMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LINES |  |
| INTERVAL |  |

### INTERVAL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitmode/interval.md

##### Value
`1`

### LINES field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitmode/lines.md

##### Value
`0`

### TextSplitOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions.md

#### TextSplitOptions class

The TextSplitOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_path_by_index_int32_string |  |
| _init_create_split_stream_int32_array |  |
| _init_create_split_stream_release_split_stream_int32_array |  |
| _init_create_split_stream_release_split_stream_text_split_mode_int32_array |  |
| _init_create_split_stream_text_split_mode_int32_array |  |
| _init_string_int32_array |  |
| _init_string_text_split_mode_int32_array |  |
| _validate_file_type |  |
| get_path_by_index |  |
| get_path_by_index_file |  |
| get_path_by_index_int32 |  |
| get_path_by_index_string |  |
| validate |  |
| validate_file_type |  |

##### Properties
| Property | Description |
| :- | :- |
| create_stream |  |
| line_numbers |  |
| mode |  |
| release_stream |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_path_by_index_int32_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_get_path_by_index_int32_string.md

#### _get_path_by_index_int32_string

```python
def _get_path_by_index_int32_string(self, index, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |
| extension | `str` |  |

**Returns:** str

### _init_create_split_stream_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_create_split_stream_int32_array.md

#### _init_create_split_stream_int32_array

```python
def _init_create_split_stream_int32_array(self, create_split_stream, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| line_numbers | `List[int]` |  |

### _init_create_split_stream_release_split_stream_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_create_split_stream_release_split_stream_int32_array.md

#### _init_create_split_stream_release_split_stream_int32_array

```python
def _init_create_split_stream_release_split_stream_int32_array(self, create_split_stream, release_split_stream, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| line_numbers | `List[int]` |  |

### _init_create_split_stream_release_split_stream_text_split_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_create_split_stream_release_split_stream_text_split_mode_int32_array.md

#### _init_create_split_stream_release_split_stream_text_split_mode_int32_array

```python
def _init_create_split_stream_release_split_stream_text_split_mode_int32_array(self, create_split_stream, release_split_stream, mode, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| release_split_stream | `ReleaseSplitStream` |  |
| mode | `TextSplitMode` |  |
| line_numbers | `List[int]` |  |

### _init_create_split_stream_text_split_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_create_split_stream_text_split_mode_int32_array.md

#### _init_create_split_stream_text_split_mode_int32_array

```python
def _init_create_split_stream_text_split_mode_int32_array(self, create_split_stream, mode, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_split_stream | `CreateSplitStream` |  |
| mode | `TextSplitMode` |  |
| line_numbers | `List[int]` |  |

### _init_string_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_string_int32_array.md

#### _init_string_int32_array

```python
def _init_string_int32_array(self, file_path_format, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| line_numbers | `List[int]` |  |

### _init_string_text_split_mode_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_init_string_text_split_mode_int32_array.md

#### _init_string_text_split_mode_int32_array

```python
def _init_string_text_split_mode_int32_array(self, file_path_format, mode, line_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| mode | `TextSplitMode` |  |
| line_numbers | `List[int]` |  |

### _validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/_validate_file_type.md

#### _validate_file_type

```python
def _validate_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### create_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/create_stream.md

##### Definition:
```python
@property
def create_stream(self):
    ...
```

### get_path_by_index method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/get_path_by_index.md

#### get_path_by_index

```python
def get_path_by_index(self):
    ...
```

### get_path_by_index_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/get_path_by_index_file.md

#### get_path_by_index_file

```python
def get_path_by_index_file(self):
    ...
```

### get_path_by_index_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/get_path_by_index_int32.md

#### get_path_by_index_int32

```python
def get_path_by_index_int32(self):
    ...
```

### get_path_by_index_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/get_path_by_index_string.md

#### get_path_by_index_string

```python
def get_path_by_index_string(self):
    ...
```

### line_numbers property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/line_numbers.md

##### Definition:
```python
@property
def line_numbers(self):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
```

### release_stream property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/release_stream.md

##### Definition:
```python
@property
def release_stream(self):
    ...
```

### validate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/validate.md

#### validate

```python
def validate(self):
    ...
```

### validate_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/textsplitoptions/validate_file_type.md

#### validate_file_type

```python
def validate_file_type(self):
    ...
```

### UpdatePasswordOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/updatepasswordoptions.md

#### UpdatePasswordOptions class

The UpdatePasswordOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| new_password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/updatepasswordoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/updatepasswordoptions/_init_string.md

#### _init_string

```python
def _init_string(self, new_password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| new_password | `str` |  |

### new_password property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/updatepasswordoptions/new_password.md

##### Definition:
```python
@property
def new_password(self):
    ...
```

### WordJoinCompliance class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoincompliance.md

#### WordJoinCompliance class

The WordJoinCompliance type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ECMA376_2006 |  |
| ISO29500_2008_TRANSITIONAL |  |
| ISO29500_2008_STRICT |  |
| AUTO |  |

### AUTO field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoincompliance/auto.md

##### Value
`100`

### ECMA376_2006 field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoincompliance/ecma376_2006.md

##### Value
`0`

### ISO29500_2008_STRICT field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoincompliance/iso29500_2008_strict.md

##### Value
`2`

### ISO29500_2008_TRANSITIONAL field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoincompliance/iso29500_2008_transitional.md

##### Value
`1`

### WordJoinMode class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinmode.md

#### WordJoinMode class

The WordJoinMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT |  |
| CONTINUOUS |  |
| DISABLE_SECTION_BREAKS |  |

### CONTINUOUS field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinmode/continuous.md

##### Value
`1`

### DEFAULT field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinmode/default.md

##### Value
`0`

### DISABLE_SECTION_BREAKS field
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinmode/disable_section_breaks.md

##### Value
`2`

### WordJoinOptions class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions.md

#### WordJoinOptions class

The WordJoinOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_file_type_int32_array |  |
| _init_file_type_int32_int32 |  |
| _init_file_type_int32_int32_range_mode |  |
| _init_int32_array |  |
| _init_int32_int32 |  |
| _init_int32_int32_range_mode |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| compliance |  |
| mode |  |
| pages |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_file_type_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_file_type_int32_array.md

#### _init_file_type_int32_array

```python
def _init_file_type_int32_array(self, file_type, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| page_numbers | `List[int]` |  |

### _init_file_type_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_file_type_int32_int32.md

#### _init_file_type_int32_int32

```python
def _init_file_type_int32_int32(self, file_type, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_file_type_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_file_type_int32_int32_range_mode.md

#### _init_file_type_int32_int32_range_mode

```python
def _init_file_type_int32_int32_range_mode(self, file_type, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_int32_array method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_numbers | `List[int]` |  |

### _init_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_int32_int32.md

#### _init_int32_int32

```python
def _init_int32_int32(self, start_number, end_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |

### _init_int32_int32_range_mode method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_int32_int32_range_mode.md

#### _init_int32_int32_range_mode

```python
def _init_int32_int32_range_mode(self, start_number, end_number, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_number | `int` |  |
| end_number | `int` |  |
| mode | `RangeMode` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compliance property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/compliance.md

##### Definition:
```python
@property
def compliance(self):
    ...
@compliance.setter
def compliance(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/mode.md

##### Definition:
```python
@property
def mode(self):
    ...
@mode.setter
def mode(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.options/wordjoinoptions/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### groupdocs.merger.domain.result
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result.md

Types under `groupdocs.merger.domain.result`.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentInfo` |  |
| `IDocumentInfo` |  |
| `IPageInfo` |  |
| `PageInfo` |  |

### DocumentInfo class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo.md

#### DocumentInfo class

The DocumentInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_ipage_info_array_int64 |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| page_count |  |
| pages |  |
| size |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_ipage_info_array_int64 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/_init_file_type_ipage_info_array_int64.md

#### _init_file_type_ipage_info_array_int64

```python
def _init_file_type_ipage_info_array_int64(self, file_type, pages, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[IPageInfo]` |  |
| size | `int` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### page_count property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/documentinfo/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### IDocumentInfo class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_count |  |
| pages |  |
| size |  |
| type |  |

### page_count property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/idocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/idocumentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/idocumentinfo/type.md

##### Definition:
```python
@property
def type(self):
    ...
```

### IPageInfo class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo.md

#### IPageInfo class

The IPageInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| document |  |
| height |  |
| number |  |
| visible |  |
| width |  |

### document property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo/document.md

##### Definition:
```python
@property
def document(self):
    ...
@document.setter
def document(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo/number.md

##### Definition:
```python
@property
def number(self):
    ...
```

### visible property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo/visible.md

##### Definition:
```python
@property
def visible(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/ipageinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### PageInfo class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo.md

#### PageInfo class

The PageInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_boolean |  |
| _init_int32_boolean_int32_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| document |  |
| height |  |
| number |  |
| visible |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_boolean method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/_init_int32_boolean.md

#### _init_int32_boolean

```python
def _init_int32_boolean(self, number, visible):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| visible | `bool` |  |

### _init_int32_boolean_int32_int32 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/_init_int32_boolean_int32_int32.md

#### _init_int32_boolean_int32_int32

```python
def _init_int32_boolean_int32_int32(self, number, visible, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| visible | `bool` |  |
| width | `int` |  |
| height | `int` |  |

### document property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/document.md

##### Definition:
```python
@property
def document(self):
    ...
@document.setter
def document(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### number property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/number.md

##### Definition:
```python
@property
def number(self):
    ...
```

### visible property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/visible.md

##### Definition:
```python
@property
def visible(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.result/pageinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### groupdocs.merger.domain
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain.md

Types under `groupdocs.merger.domain`.

##### Classes
| Class | Description |
| :- | :- |
| `FileType` |  |

### FileType class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/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_extension |  |
| get_hash_code |  |
| get_supported_file_types |  |
| is_archive |  |
| is_audio |  |
| is_image |  |
| is_text |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| file_format |  |

### _equals_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/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/merger/python-net/groupdocs.merger.domain/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/merger/python-net/groupdocs.merger.domain/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/merger/python-net/groupdocs.merger.domain/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### BMP property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/bmp.md

#### BMP property

Bitmap Image File (.bmp) represent files that are used to store bitmap digital images. Learn more about this file format [here](https://docs.fileformat.com/image/bmp).

### BZ2 property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/bz2.md

#### BZ2 property

Bzip2 Compressed File (.bz2)

### CSV property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/csv.md

#### CSV property

Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values.
Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/csv).

### DOC property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/doc.md

#### DOC property

Microsoft Word Document (.doc) represent documents generated by Microsoft Word or other word processing documents in binary file format.
Learn more about this file format [here](https://docs.fileformat.com/word-processing/doc).

### DOCM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/docm.md

#### DOCM property

Word Open XML 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](https://docs.fileformat.com/word-processing/docm).

### DOCX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/docx.md

#### DOCX property

Microsoft Word Open XML Document (.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://docs.fileformat.com/word-processing/docx).

### DOT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/dot.md

#### DOT property

Word Document Template (.dot) files 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://docs.fileformat.com/word-processing/dot).

### DOTM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/dotm.md

#### DOTM property

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher.
Learn more about this file format [here](https://docs.fileformat.com/word-processing/dotm).

### DOTX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/dotx.md

#### DOTX property

Word Open XML Document 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](https://docs.fileformat.com/word-processing/dotx).

### EMF property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/emf.md

#### EMF property

Windows Enhanced Metafile (.emf)

### EMZ property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/emz.md

#### EMZ property

Windows Compressed Enhanced Metafile (.emz)

### EPUB property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/epub.md

#### EPUB property

Open eBook File (.epub) 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://docs.fileformat.com/ebook/epub).

### equals method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_file_type method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### ERR property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/err.md

#### ERR property

Error Log File (.err) is a text file that contains error messages generated by a program.
Learn more about this file format [here](https://fileinfo.com/extension/err).

### extension property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** FileType

### get_hash_code method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_supported_file_types method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/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/merger/python-net/groupdocs.merger.domain/filetype/gif.md

#### GIF property

Graphical Interchange Format File (.gif)

### GZ property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/gz.md

#### GZ property

G-Zip Compressed File (.gz)

### HTML property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/html.md

#### HTML property

Hypertext Markup Language File (.html) is the extension for web pages created for display in browsers.
Learn more about this file format [here](https://docs.fileformat.com/web/html).

### is_archive method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/is_archive.md

#### is_archive

```python
def is_archive(cls, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

**Returns:** bool

### is_audio method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/is_audio.md

#### is_audio

```python
def is_audio(cls, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

**Returns:** bool

### is_image method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/is_image.md

#### is_image

```python
def is_image(cls, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

**Returns:** bool

### is_text method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/is_text.md

#### is_text

```python
def is_text(cls, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

**Returns:** bool

### JPEG property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/jpeg.md

#### JPEG property

JPEG Image (.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://docs.fileformat.com/image/jpeg).

### JPG property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/jpg.md

#### JPG property

JPEG Image (.jpg)

### MHT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/mht.md

#### MHT property

MHTML Web Archive (.mht) is a web page archive format that can be created by a number of different applications.
Learn more about this file format [here](https://docs.fileformat.com/web/mhtml).

### MHTML property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/mhtml.md

#### MHTML property

MIME HTML File (.mhtml) is a web page archive format that can be created by a number of different applications.
Learn more about this file format [here](https://docs.fileformat.com/web/mhtml).

### MP3 property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/mp3.md

#### MP3 property

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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Compression achieved by MP3 file format is 1/10th the size of .WAV or .AIF files.
Learn more about this file format [here](https://docs.fileformat.com/audio/mp3).

### ODP property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/odp.md

#### ODP property

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard.
Learn more about this file format [here](https://docs.fileformat.com/presentation/odp).

### ODS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ods.md

#### ODS property

OpenDocument Spreadsheet (.ods)
Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/ods).

### ODT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/odt.md

#### ODT property

OpenDocument 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](https://docs.fileformat.com/word-processing/odt).

### ONE property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/one.md

#### ONE property

OneNote Document (.one) files 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://docs.fileformat.com/note-taking/one).

### OTP property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/otp.md

#### OTP property

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format.
Learn more about this file format [here](https://docs.fileformat.com/presentation/otp).

### OTT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ott.md

#### OTT property

OpenDocument Document Template (.ott) represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
Learn more about this file format [here](https://docs.fileformat.com/word-processing/ott).

### PDF property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/pdf.md

#### PDF property

Portable Document Format File (.pdf) isa file format that was to introduced as 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://docs.fileformat.com/view/pdf).

### PNG property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/png.md

#### PNG property

Portable Network Graphic (.png) is a type of raster image file format that use loseless compression.
Learn more about this file format [here](https://docs.fileformat.com/image/png).

### PPS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/pps.md

#### PPS property

PowerPoint Slide Show (.pps) is a file 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://docs.fileformat.com/presentation/pps).

### PPSM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ppsm.md

#### PPSM property

PowerPoint Open XML Macro-Enabled Slide (.ppsm)

### PPSX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ppsx.md

#### PPSX property

PowerPoint Open XML Slide Show (.ppsx) is a file created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
Learn more about this file format [here](https://docs.fileformat.com/presentation/ppsx).

### PPT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ppt.md

#### PPT property

PowerPoint Presentation (.ppt) 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://docs.fileformat.com/presentation/ppt).

### PPTM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/pptm.md

#### PPTM property

PowerPoint Open XML Macro-Enabled Presentation

### PPTX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/pptx.md

#### PPTX property

PowerPoint Open XML Presentation (.pptx) is a presentation file 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://docs.fileformat.com/presentation/pptx).

### PS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/ps.md

#### PS property

PostScript File (.ps)

### RAR property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/rar.md

#### RAR property

Roshal ARchive Compressed File (.rar)

### RTF property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/rtf.md

#### RTF property

Rich Text Format File (.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://docs.fileformat.com/word-processing/rtf).

### SEVEN_Z property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/seven_z.md

#### SEVEN_Z property

7-Zip Compressed File (.7z)

### SVG property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/svg.md

#### SVG property

Scalable Vector Graphics File (.svg)

### SVGZ property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/svgz.md

#### SVGZ property

Scalable Vector Graphics Compressed File (.svgz)

### TAR property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/tar.md

#### TAR property

Consolidated Unix File Archive (.tar)

### TEX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/tex.md

#### TEX property

LaTeX Source Document (.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://docs.fileformat.com/page-description-language/tex).

### TIF property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/tif.md

#### TIF property

Tagged Image File (.tif)

### TIFF property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/tiff.md

#### TIFF property

Tagged Image File Format (.tiff)

### to_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TSV property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/tsv.md

#### TSV property

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format.
Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/tsv).

### TXT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/txt.md

#### TXT property

Plain Text File (.txt) represents a text document that contains plain text in the form of lines.
Learn more about this file format [here](https://docs.fileformat.com/word-processing/txt).

### UNKNOWN property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/unknown.md

#### UNKNOWN property

Represents unknown file type.

### VDX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vdx.md

#### VDX property

Visio Drawing XML File (.vdx)is a 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://docs.fileformat.com/image/vdx).

### VSD property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vsd.md

#### VSD property

Visio Drawing File (.vsd)

### VSDM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vsdm.md

#### VSDM property

Visio Macro-Enabled Drawing (.vsdm) 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://docs.fileformat.com/image/vsdm).

### VSDX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vsdx.md

#### VSDX property

Visio Drawing (.vsdx) represents 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://docs.fileformat.com/image/vsdx).

### VSS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vss.md

#### VSS property

Visio Stencil File(.vss)

### VSSM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vssm.md

#### VSSM property

Visio Macro-Enabled Stencil File (.vssm) 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://docs.fileformat.com/image/vssm).

### VSSX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vssx.md

#### VSSX property

Visio Stencil File (.vssx) 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://docs.fileformat.com/image/vssx).

### VST property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vst.md

#### VST property

Visio Drawing Template (.vst)

### VSTM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vstm.md

#### VSTM property

Visio Macro-Enabled Drawing Template (.vstm) 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://docs.fileformat.com/image/vstm).

### VSTX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vstx.md

#### VSTX property

Visio Drawing Template (.vstx) 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://docs.fileformat.com/image/vstx).

### VSX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vsx.md

#### VSX property

Visio Stencil XML File (.vsx) refers 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://docs.fileformat.com/image/vsx).

### VTX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/vtx.md

#### VTX property

Visio Template XML File (.vtx) 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://docs.fileformat.com/image/vtx).

### WAV property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/wav.md

#### WAV property

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. The format doesn’t apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. It has been and is one of the standard format for audio CDs.
Learn more about this file format [here](https://docs.fileformat.com/audio/wav).

### XLAM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xlam.md

#### XLAM property

Excel Macro-Enabled Add-In (.xlam)

### XLS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xls.md

#### XLS property

Excel Spreadsheet (.xls) is a file that 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://docs.fileformat.com/spreadsheet/xls).

### XLSB property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xlsb.md

#### XLSB property

Excel Binary Spreadsheet (.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://docs.fileformat.com/spreadsheet/xlsb).

### XLSM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xlsm.md

#### XLSM property

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros.
Learn more about this file format [here](https://docs.fileformat.com/spreadsheet/xlsm).

### XLSX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xlsx.md

#### XLSX property

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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://docs.fileformat.com/spreadsheet/xlsx).

### XLT property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xlt.md

#### XLT property

Excel Template File (.xlt) 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://docs.fileformat.com/spreadsheet/xlt).

### XLTM property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xltm.md

#### XLTM property

Excel Open XML Macro-Enabled Spreadsheet Template (.xltm) 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://docs.fileformat.com/spreadsheet/xltm).

### XLTX property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xltx.md

#### XLTX property

Excel Open XML Spreadsheet Template (.xltx) files 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://docs.fileformat.com/spreadsheet/xltx).

### XPS property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/xps.md

#### XPS property

XML Paper Specification File (.xps) represents page layout files that are based on XML Paper Specifications created by Microsoft.
Learn more about this file format [here](https://docs.fileformat.com/page-description-language/xps).

### ZIP property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.domain/filetype/zip.md

#### ZIP property

Zipped File (.zip)

### groupdocs.merger.exceptions
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions.md

The namespace provides different classes for exceptions.

##### Classes
| Class | Description |
| :- | :- |
| `FileCorruptedException` | The exception that is thrown when specified file could not be loaded because it appears to be corrupted. |
| `FileTypeNotSupportedException` | The exception that is thrown when specified file type is not supported. |
| `GroupDocsMergerException` | Represents errors that occur during document processing. |
| `IncorrectPasswordException` | The exception that is thrown when specified password is incorrect. |
| `PasswordRequiredException` | The exception that is thrown when password is required to load the document. |

### FileCorruptedException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/filecorruptedexception.md

#### FileCorruptedException class

The exception that is thrown when specified file could not be loaded because it appears to be corrupted.

**Inheritance:** `FileCorruptedException` →
`GroupDocsMergerException`

The FileCorruptedException type exposes the following members:

### FileTypeNotSupportedException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The exception that is thrown when specified file type is not supported.

The FileTypeNotSupportedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `FileTypeNotSupportedException` class. |

### FileTypeNotSupportedException constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/filetypenotsupportedexception/__init__.md

#### __init__

Initializes a new instance of the `FileTypeNotSupportedException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | str | The message that describes the error. |

### GroupDocsMergerException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/groupdocsmergerexception.md

#### GroupDocsMergerException class

Represents errors that occur during document processing.

The GroupDocsMergerException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `GroupDocsMergerException` class. |

### GroupDocsMergerException constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/groupdocsmergerexception/__init__.md

#### __init__

Initializes a new instance of the `GroupDocsMergerException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | str | The message that describes the error. |

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

**Inheritance:** `IncorrectPasswordException` →
`GroupDocsMergerException`

The IncorrectPasswordException type exposes the following members:

### PasswordRequiredException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

**Inheritance:** `PasswordRequiredException` →
`GroupDocsMergerException`

The PasswordRequiredException type exposes the following members:

### groupdocs.merger.logging
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` |  |
| `ILogger` |  |

### ConsoleLogger class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.logging/consolelogger/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _trace_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.logging/consolelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.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/merger/python-net/groupdocs.merger.logging/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### groupdocs.merger
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger.md

Main GroupDocs.Merger namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `IMerger` |  |
| `License` | Manages GroupDocs.Merger licensing. |
| `Merger` |  |
| `MergerSettings` |  |
| `Metered` | Manages metered (pay-per-use) licensing. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `FileCorruptedException` |  |
| `FileTypeNotSupportedException` |  |
| `GroupDocsMergerException` |  |
| `IncorrectPasswordException` |  |
| `PasswordRequiredException` |  |

### FileCorruptedException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/filecorruptedexception.md

#### FileCorruptedException class

The FileCorruptedException type exposes the following members:

### FileTypeNotSupportedException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/filetypenotsupportedexception.md

#### FileTypeNotSupportedException class

The FileTypeNotSupportedException type exposes the following members:

### GroupDocsMergerException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/groupdocsmergerexception.md

#### GroupDocsMergerException class

The GroupDocsMergerException type exposes the following members:

### IMerger class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger.md

#### IMerger class

The IMerger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _add_password_iadd_password_options |  |
| _change_orientation_iorientation_options |  |
| _extract_pages_iextract_options |  |
| _import_document_iimport_document_options |  |
| _join_stream |  |
| _join_stream_iimage_join_options |  |
| _join_stream_ijoin_options |  |
| _join_stream_ipage_join_options |  |
| _join_string |  |
| _join_string_iimage_join_options |  |
| _join_string_ijoin_options |  |
| _join_string_ipage_join_options |  |
| _move_page_imove_options |  |
| _remove_pages_iremove_options |  |
| _remove_password_noargs |  |
| _rotate_irotate_options |  |
| _save_stream_isave_options |  |
| _save_string_boolean_isave_options |  |
| _save_string_isave_options |  |
| _split_isplit_options |  |
| _split_itext_split_options |  |
| _swap_pages_iswap_options |  |
| _update_password_iupdate_password_options |  |
| add_password |  |
| add_password_iadd_password_options |  |
| change_orientation |  |
| change_orientation_iorientation_options |  |
| extract_pages |  |
| extract_pages_iextract_options |  |
| import_document |  |
| import_document_iimport_document_options |  |
| join |  |
| join_file |  |
| join_stream |  |
| join_streams |  |
| join_string |  |
| move_page |  |
| move_page_imove_options |  |
| remove_pages |  |
| remove_pages_iremove_options |  |
| remove_password |  |
| rotate |  |
| rotate_irotate_options |  |
| save |  |
| save_file |  |
| save_stream |  |
| save_streams |  |
| save_string |  |
| split |  |
| split_isplit_options |  |
| split_itext_split_options |  |
| swap_pages |  |
| swap_pages_iswap_options |  |
| update_password |  |
| update_password_iupdate_password_options |  |

### _add_password_iadd_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_add_password_iadd_password_options.md

#### _add_password_iadd_password_options

```python
def _add_password_iadd_password_options(self, add_password_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| add_password_options | `IAddPasswordOptions` |  |

**Returns:** IMerger

### _change_orientation_iorientation_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_change_orientation_iorientation_options.md

#### _change_orientation_iorientation_options

```python
def _change_orientation_iorientation_options(self, orientation_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_options | `IOrientationOptions` |  |

**Returns:** IMerger

### _extract_pages_iextract_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_extract_pages_iextract_options.md

#### _extract_pages_iextract_options

```python
def _extract_pages_iextract_options(self, extract_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extract_options | `IExtractOptions` |  |

**Returns:** IMerger

### _import_document_iimport_document_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_import_document_iimport_document_options.md

#### _import_document_iimport_document_options

```python
def _import_document_iimport_document_options(self, import_document_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| import_document_options | `IImportDocumentOptions` |  |

**Returns:** IMerger

### _join_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_stream.md

#### _join_stream

```python
def _join_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

**Returns:** IMerger

### _join_stream_iimage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_stream_iimage_join_options.md

#### _join_stream_iimage_join_options

```python
def _join_stream_iimage_join_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IImageJoinOptions` |  |

**Returns:** IMerger

### _join_stream_ijoin_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_stream_ijoin_options.md

#### _join_stream_ijoin_options

```python
def _join_stream_ijoin_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IJoinOptions` |  |

**Returns:** IMerger

### _join_stream_ipage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_stream_ipage_join_options.md

#### _join_stream_ipage_join_options

```python
def _join_stream_ipage_join_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IPageJoinOptions` |  |

**Returns:** IMerger

### _join_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_string.md

#### _join_string

```python
def _join_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** IMerger

### _join_string_iimage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_string_iimage_join_options.md

#### _join_string_iimage_join_options

```python
def _join_string_iimage_join_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IImageJoinOptions` |  |

**Returns:** IMerger

### _join_string_ijoin_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_string_ijoin_options.md

#### _join_string_ijoin_options

```python
def _join_string_ijoin_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IJoinOptions` |  |

**Returns:** IMerger

### _join_string_ipage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_join_string_ipage_join_options.md

#### _join_string_ipage_join_options

```python
def _join_string_ipage_join_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IPageJoinOptions` |  |

**Returns:** IMerger

### _move_page_imove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_move_page_imove_options.md

#### _move_page_imove_options

```python
def _move_page_imove_options(self, move_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| move_options | `IMoveOptions` |  |

**Returns:** IMerger

### _remove_pages_iremove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_remove_pages_iremove_options.md

#### _remove_pages_iremove_options

```python
def _remove_pages_iremove_options(self, remove_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| remove_options | `IRemoveOptions` |  |

**Returns:** IMerger

### _remove_password_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_remove_password_noargs.md

#### _remove_password_noargs

```python
def _remove_password_noargs(self):
    ...
```

**Returns:** IMerger

### _rotate_irotate_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_rotate_irotate_options.md

#### _rotate_irotate_options

```python
def _rotate_irotate_options(self, rotate_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_options | `IRotateOptions` |  |

**Returns:** IMerger

### _save_stream_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_save_stream_isave_options.md

#### _save_stream_isave_options

```python
def _save_stream_isave_options(self, document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _save_string_boolean_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_save_string_boolean_isave_options.md

#### _save_string_boolean_isave_options

```python
def _save_string_boolean_isave_options(self, file_path, use_default_directory, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| use_default_directory | `bool` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _save_string_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_save_string_isave_options.md

#### _save_string_isave_options

```python
def _save_string_isave_options(self, file_path, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _split_isplit_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_split_isplit_options.md

#### _split_isplit_options

```python
def _split_isplit_options(self, split_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| split_options | `ISplitOptions` |  |

**Returns:** IMerger

### _split_itext_split_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_split_itext_split_options.md

#### _split_itext_split_options

```python
def _split_itext_split_options(self, split_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| split_options | `ITextSplitOptions` |  |

**Returns:** IMerger

### _swap_pages_iswap_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_swap_pages_iswap_options.md

#### _swap_pages_iswap_options

```python
def _swap_pages_iswap_options(self, swap_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| swap_options | `ISwapOptions` |  |

**Returns:** IMerger

### _update_password_iupdate_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/_update_password_iupdate_password_options.md

#### _update_password_iupdate_password_options

```python
def _update_password_iupdate_password_options(self, update_password_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| update_password_options | `IUpdatePasswordOptions` |  |

**Returns:** IMerger

### add_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/add_password.md

#### add_password

```python
def add_password(self):
    ...
```

### add_password_iadd_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/add_password_iadd_password_options.md

#### add_password_iadd_password_options

```python
def add_password_iadd_password_options(self):
    ...
```

### change_orientation method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/change_orientation.md

#### change_orientation

```python
def change_orientation(self):
    ...
```

### change_orientation_iorientation_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/change_orientation_iorientation_options.md

#### change_orientation_iorientation_options

```python
def change_orientation_iorientation_options(self):
    ...
```

### extract_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/extract_pages.md

#### extract_pages

```python
def extract_pages(self):
    ...
```

### extract_pages_iextract_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/extract_pages_iextract_options.md

#### extract_pages_iextract_options

```python
def extract_pages_iextract_options(self):
    ...
```

### import_document method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/import_document.md

#### import_document

```python
def import_document(self):
    ...
```

### import_document_iimport_document_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/import_document_iimport_document_options.md

#### import_document_iimport_document_options

```python
def import_document_iimport_document_options(self):
    ...
```

### join method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/join.md

#### join

```python
def join(self):
    ...
```

### join_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/join_file.md

#### join_file

```python
def join_file(self):
    ...
```

### join_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/join_stream.md

#### join_stream

```python
def join_stream(self):
    ...
```

### join_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/join_streams.md

#### join_streams

```python
def join_streams(self):
    ...
```

### join_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/join_string.md

#### join_string

```python
def join_string(self):
    ...
```

### move_page method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/move_page.md

#### move_page

```python
def move_page(self):
    ...
```

### move_page_imove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/move_page_imove_options.md

#### move_page_imove_options

```python
def move_page_imove_options(self):
    ...
```

### remove_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/remove_pages.md

#### remove_pages

```python
def remove_pages(self):
    ...
```

### remove_pages_iremove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/remove_pages_iremove_options.md

#### remove_pages_iremove_options

```python
def remove_pages_iremove_options(self):
    ...
```

### remove_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/remove_password.md

#### remove_password

```python
def remove_password(self):
    ...
```

### rotate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/rotate.md

#### rotate

```python
def rotate(self):
    ...
```

### rotate_irotate_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/rotate_irotate_options.md

#### rotate_irotate_options

```python
def rotate_irotate_options(self):
    ...
```

### rotate_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/rotate_pages.md

#### rotate_pages

Rotate pages of the document.

```python
def rotate_pages(self, rotate_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_options | groupdocs.merger.domain.options.IRotateOptions |  |

### save method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/save.md

#### save

```python
def save(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### split method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/split.md

#### split

```python
def split(self):
    ...
```

### split_isplit_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/split_isplit_options.md

#### split_isplit_options

```python
def split_isplit_options(self):
    ...
```

### split_itext_split_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/split_itext_split_options.md

#### split_itext_split_options

```python
def split_itext_split_options(self):
    ...
```

### swap_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/swap_pages.md

#### swap_pages

```python
def swap_pages(self):
    ...
```

### swap_pages_iswap_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/swap_pages_iswap_options.md

#### swap_pages_iswap_options

```python
def swap_pages_iswap_options(self):
    ...
```

### update_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/update_password.md

#### update_password

```python
def update_password(self):
    ...
```

### update_password_iupdate_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/imerger/update_password_iupdate_password_options.md

#### update_password_iupdate_password_options

```python
def update_password_iupdate_password_options(self):
    ...
```

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/incorrectpasswordexception.md

#### IncorrectPasswordException class

The IncorrectPasswordException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/license.md

#### License class

Manages GroupDocs.Merger 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/merger/python-net/groupdocs.merger/license/__init__.md

#### __init__

Constructs a new instance of License

```python
def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/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. |

### Merger class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger.md

#### Merger class

The Merger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_password_iadd_password_options |  |
| _apply_page_builder_page_builder |  |
| _change_orientation_iorientation_options |  |
| _create_page_builder_page_builder_options |  |
| _dispose_noargs |  |
| _extract_pages_iextract_options |  |
| _generate_preview_ipreview_options |  |
| _get_document_info_noargs |  |
| _import_document_iimport_document_options |  |
| _init_func_1_e_2e2 |  |
| _init_func_1_e_2e2_iload_options |  |
| _init_func_1_e_2e2_iload_options_merger_settings |  |
| _init_func_1_e_2e2_merger_settings |  |
| _init_stream |  |
| _init_stream_iload_options |  |
| _init_stream_iload_options_merger_settings |  |
| _init_stream_merger_settings |  |
| _init_string |  |
| _init_string_iload_options |  |
| _init_string_iload_options_merger_settings |  |
| _init_string_merger_settings |  |
| _is_password_set_noargs |  |
| _join_stream |  |
| _join_stream_iimage_join_options |  |
| _join_stream_ijoin_options |  |
| _join_stream_ipage_join_options |  |
| _join_string |  |
| _join_string_iimage_join_options |  |
| _join_string_ijoin_options |  |
| _join_string_ipage_join_options |  |
| _move_page_imove_options |  |
| _remove_pages_iremove_options |  |
| _remove_password_noargs |  |
| _rotate_irotate_options |  |
| _save_stream_isave_options |  |
| _save_string_boolean_isave_options |  |
| _save_string_isave_options |  |
| _split_isplit_options |  |
| _split_itext_split_options |  |
| _swap_pages_iswap_options |  |
| _update_password_iupdate_password_options |  |
| add_password |  |
| add_password_iadd_password_options |  |
| apply_page_builder |  |
| apply_page_builder_page_builder |  |
| change_orientation |  |
| change_orientation_iorientation_options |  |
| create_page_builder |  |
| create_page_builder_page_builder_options |  |
| dispose |  |
| extract_pages |  |
| extract_pages_iextract_options |  |
| generate_preview |  |
| generate_preview_ipreview_options |  |
| get_document_info |  |
| import_document |  |
| import_document_iimport_document_options |  |
| is_password_set |  |
| join |  |
| join_file |  |
| join_stream |  |
| join_streams |  |
| join_string |  |
| move_page |  |
| move_page_imove_options |  |
| remove_pages |  |
| remove_pages_iremove_options |  |
| remove_password |  |
| rotate |  |
| rotate_irotate_options |  |
| save |  |
| save_file |  |
| save_stream |  |
| save_streams |  |
| save_string |  |
| split |  |
| split_isplit_options |  |
| split_itext_split_options |  |
| swap_pages |  |
| swap_pages_iswap_options |  |
| update_password |  |
| update_password_iupdate_password_options |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_password_iadd_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_add_password_iadd_password_options.md

#### _add_password_iadd_password_options

```python
def _add_password_iadd_password_options(self, add_password_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| add_password_options | `IAddPasswordOptions` |  |

**Returns:** IMerger

### _apply_page_builder_page_builder method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_apply_page_builder_page_builder.md

#### _apply_page_builder_page_builder

```python
def _apply_page_builder_page_builder(self, page_builder):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_builder | `PageBuilder` |  |

### _change_orientation_iorientation_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_change_orientation_iorientation_options.md

#### _change_orientation_iorientation_options

```python
def _change_orientation_iorientation_options(self, orientation_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| orientation_options | `IOrientationOptions` |  |

**Returns:** IMerger

### _create_page_builder_page_builder_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_create_page_builder_page_builder_options.md

#### _create_page_builder_page_builder_options

```python
def _create_page_builder_page_builder_options(self, page_builder_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_builder_options | `Optional[PageBuilderOptions]` |  |

**Returns:** PageBuilder

### _dispose_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _extract_pages_iextract_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_extract_pages_iextract_options.md

#### _extract_pages_iextract_options

```python
def _extract_pages_iextract_options(self, extract_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extract_options | `IExtractOptions` |  |

**Returns:** IMerger

### _generate_preview_ipreview_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_generate_preview_ipreview_options.md

#### _generate_preview_ipreview_options

```python
def _generate_preview_ipreview_options(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | `IPreviewOptions` |  |

### _get_document_info_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### _import_document_iimport_document_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_import_document_iimport_document_options.md

#### _import_document_iimport_document_options

```python
def _import_document_iimport_document_options(self, import_document_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| import_document_options | `IImportDocumentOptions` |  |

**Returns:** IMerger

### _init_func_1_e_2e2 method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_func_1_e_2e2.md

#### _init_func_1_e_2e2

```python
def _init_func_1_e_2e2(self, get_file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |

### _init_func_1_e_2e2_iload_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_func_1_e_2e2_iload_options.md

#### _init_func_1_e_2e2_iload_options

```python
def _init_func_1_e_2e2_iload_options(self, get_file_stream, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| load_options | `ILoadOptions` |  |

### _init_func_1_e_2e2_iload_options_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_func_1_e_2e2_iload_options_merger_settings.md

#### _init_func_1_e_2e2_iload_options_merger_settings

```python
def _init_func_1_e_2e2_iload_options_merger_settings(self, get_file_stream, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| load_options | `ILoadOptions` |  |
| settings | `MergerSettings` |  |

### _init_func_1_e_2e2_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_func_1_e_2e2_merger_settings.md

#### _init_func_1_e_2e2_merger_settings

```python
def _init_func_1_e_2e2_merger_settings(self, get_file_stream, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| settings | `MergerSettings` |  |

### _init_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_stream.md

#### _init_stream

```python
def _init_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _init_stream_iload_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_stream_iload_options.md

#### _init_stream_iload_options

```python
def _init_stream_iload_options(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `ILoadOptions` |  |

### _init_stream_iload_options_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_stream_iload_options_merger_settings.md

#### _init_stream_iload_options_merger_settings

```python
def _init_stream_iload_options_merger_settings(self, document, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `ILoadOptions` |  |
| settings | `MergerSettings` |  |

### _init_stream_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_stream_merger_settings.md

#### _init_stream_merger_settings

```python
def _init_stream_merger_settings(self, document, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| settings | `MergerSettings` |  |

### _init_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_iload_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_string_iload_options.md

#### _init_string_iload_options

```python
def _init_string_iload_options(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `ILoadOptions` |  |

### _init_string_iload_options_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_string_iload_options_merger_settings.md

#### _init_string_iload_options_merger_settings

```python
def _init_string_iload_options_merger_settings(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `ILoadOptions` |  |
| settings | `MergerSettings` |  |

### _init_string_merger_settings method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_init_string_merger_settings.md

#### _init_string_merger_settings

```python
def _init_string_merger_settings(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| settings | `MergerSettings` |  |

### _is_password_set_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_is_password_set_noargs.md

#### _is_password_set_noargs

```python
def _is_password_set_noargs(self):
    ...
```

**Returns:** bool

### _join_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_stream.md

#### _join_stream

```python
def _join_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

**Returns:** IMerger

### _join_stream_iimage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_stream_iimage_join_options.md

#### _join_stream_iimage_join_options

```python
def _join_stream_iimage_join_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IImageJoinOptions` |  |

**Returns:** IMerger

### _join_stream_ijoin_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_stream_ijoin_options.md

#### _join_stream_ijoin_options

```python
def _join_stream_ijoin_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IJoinOptions` |  |

**Returns:** IMerger

### _join_stream_ipage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_stream_ipage_join_options.md

#### _join_stream_ipage_join_options

```python
def _join_stream_ipage_join_options(self, document, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| join_options | `IPageJoinOptions` |  |

**Returns:** IMerger

### _join_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_string.md

#### _join_string

```python
def _join_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** IMerger

### _join_string_iimage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_string_iimage_join_options.md

#### _join_string_iimage_join_options

```python
def _join_string_iimage_join_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IImageJoinOptions` |  |

**Returns:** IMerger

### _join_string_ijoin_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_string_ijoin_options.md

#### _join_string_ijoin_options

```python
def _join_string_ijoin_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IJoinOptions` |  |

**Returns:** IMerger

### _join_string_ipage_join_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_join_string_ipage_join_options.md

#### _join_string_ipage_join_options

```python
def _join_string_ipage_join_options(self, file_path, join_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| join_options | `IPageJoinOptions` |  |

**Returns:** IMerger

### _move_page_imove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_move_page_imove_options.md

#### _move_page_imove_options

```python
def _move_page_imove_options(self, move_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| move_options | `IMoveOptions` |  |

**Returns:** IMerger

### _remove_pages_iremove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_remove_pages_iremove_options.md

#### _remove_pages_iremove_options

```python
def _remove_pages_iremove_options(self, remove_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| remove_options | `IRemoveOptions` |  |

**Returns:** IMerger

### _remove_password_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_remove_password_noargs.md

#### _remove_password_noargs

```python
def _remove_password_noargs(self):
    ...
```

**Returns:** IMerger

### _rotate_irotate_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_rotate_irotate_options.md

#### _rotate_irotate_options

```python
def _rotate_irotate_options(self, rotate_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_options | `IRotateOptions` |  |

**Returns:** IMerger

### _save_stream_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_save_stream_isave_options.md

#### _save_stream_isave_options

```python
def _save_stream_isave_options(self, document, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _save_string_boolean_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_save_string_boolean_isave_options.md

#### _save_string_boolean_isave_options

```python
def _save_string_boolean_isave_options(self, file_path, use_default_directory, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| use_default_directory | `bool` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _save_string_isave_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_save_string_isave_options.md

#### _save_string_isave_options

```python
def _save_string_isave_options(self, file_path, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| save_options | `Optional[ISaveOptions]` |  |

**Returns:** IMerger

### _split_isplit_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_split_isplit_options.md

#### _split_isplit_options

```python
def _split_isplit_options(self, split_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| split_options | `ISplitOptions` |  |

**Returns:** IMerger

### _split_itext_split_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_split_itext_split_options.md

#### _split_itext_split_options

```python
def _split_itext_split_options(self, split_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| split_options | `ITextSplitOptions` |  |

**Returns:** IMerger

### _swap_pages_iswap_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_swap_pages_iswap_options.md

#### _swap_pages_iswap_options

```python
def _swap_pages_iswap_options(self, swap_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| swap_options | `ISwapOptions` |  |

**Returns:** IMerger

### _update_password_iupdate_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/_update_password_iupdate_password_options.md

#### _update_password_iupdate_password_options

```python
def _update_password_iupdate_password_options(self, update_password_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| update_password_options | `IUpdatePasswordOptions` |  |

**Returns:** IMerger

### add_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/add_password.md

#### add_password

```python
def add_password(self):
    ...
```

### add_password_iadd_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/add_password_iadd_password_options.md

#### add_password_iadd_password_options

```python
def add_password_iadd_password_options(self):
    ...
```

### apply_page_builder method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/apply_page_builder.md

#### apply_page_builder

```python
def apply_page_builder(self):
    ...
```

### apply_page_builder_page_builder method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/apply_page_builder_page_builder.md

#### apply_page_builder_page_builder

```python
def apply_page_builder_page_builder(self):
    ...
```

### change_orientation method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/change_orientation.md

#### change_orientation

```python
def change_orientation(self):
    ...
```

### change_orientation_iorientation_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/change_orientation_iorientation_options.md

#### change_orientation_iorientation_options

```python
def change_orientation_iorientation_options(self):
    ...
```

### create_page_builder method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/create_page_builder.md

#### create_page_builder

```python
def create_page_builder(self):
    ...
```

### create_page_builder_page_builder_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/create_page_builder_page_builder_options.md

#### create_page_builder_page_builder_options

```python
def create_page_builder_page_builder_options(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### extract_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/extract_pages.md

#### extract_pages

```python
def extract_pages(self):
    ...
```

### extract_pages_iextract_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/extract_pages_iextract_options.md

#### extract_pages_iextract_options

```python
def extract_pages_iextract_options(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_ipreview_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/generate_preview_ipreview_options.md

#### generate_preview_ipreview_options

```python
def generate_preview_ipreview_options(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### import_document method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/import_document.md

#### import_document

```python
def import_document(self):
    ...
```

### import_document_iimport_document_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/import_document_iimport_document_options.md

#### import_document_iimport_document_options

```python
def import_document_iimport_document_options(self):
    ...
```

### is_password_set method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/is_password_set.md

#### is_password_set

```python
def is_password_set(self):
    ...
```

### join method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/join.md

#### join

```python
def join(self):
    ...
```

### join_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/join_file.md

#### join_file

```python
def join_file(self):
    ...
```

### join_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/join_stream.md

#### join_stream

```python
def join_stream(self):
    ...
```

### join_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/join_streams.md

#### join_streams

```python
def join_streams(self):
    ...
```

### join_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/join_string.md

#### join_string

```python
def join_string(self):
    ...
```

### move_page method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/move_page.md

#### move_page

```python
def move_page(self):
    ...
```

### move_page_imove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/move_page_imove_options.md

#### move_page_imove_options

```python
def move_page_imove_options(self):
    ...
```

### remove_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/remove_pages.md

#### remove_pages

```python
def remove_pages(self):
    ...
```

### remove_pages_iremove_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/remove_pages_iremove_options.md

#### remove_pages_iremove_options

```python
def remove_pages_iremove_options(self):
    ...
```

### remove_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/remove_password.md

#### remove_password

```python
def remove_password(self):
    ...
```

### rotate method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/rotate.md

#### rotate

```python
def rotate(self):
    ...
```

### rotate_irotate_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/rotate_irotate_options.md

#### rotate_irotate_options

```python
def rotate_irotate_options(self):
    ...
```

### rotate_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/rotate_pages.md

#### rotate_pages

Rotate pages of the document.

```python
def rotate_pages(self, rotate_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rotate_options | groupdocs.merger.domain.options.IRotateOptions | The options for the page rotating. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Thrown when `rotate_options` is null. |

### save method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/save.md

#### save

```python
def save(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### split method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/split.md

#### split

```python
def split(self):
    ...
```

### split_isplit_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/split_isplit_options.md

#### split_isplit_options

```python
def split_isplit_options(self):
    ...
```

### split_itext_split_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/split_itext_split_options.md

#### split_itext_split_options

```python
def split_itext_split_options(self):
    ...
```

### swap_pages method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/swap_pages.md

#### swap_pages

```python
def swap_pages(self):
    ...
```

### swap_pages_iswap_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/swap_pages_iswap_options.md

#### swap_pages_iswap_options

```python
def swap_pages_iswap_options(self):
    ...
```

### update_password method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/update_password.md

#### update_password

```python
def update_password(self):
    ...
```

### update_password_iupdate_password_options method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/merger/update_password_iupdate_password_options.md

#### update_password_iupdate_password_options

```python
def update_password_iupdate_password_options(self):
    ...
```

### MergerSettings class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/mergersettings.md

#### MergerSettings class

The MergerSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_ilogger |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| logger |  |

### __init__ constructor
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/mergersettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_ilogger method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/mergersettings/_init_ilogger.md

#### _init_ilogger

```python
def _init_ilogger(self, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/mergersettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### logger property
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/mergersettings/logger.md

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### Metered class
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/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/merger/python-net/groupdocs.merger/metered/__init__.md

#### __init__

Constructs a new instance of Metered

```python
def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/merger/python-net/groupdocs.merger/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/merger/python-net/groupdocs.merger/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/merger/python-net/groupdocs.merger/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/merger/python-net/groupdocs.merger/passwordrequiredexception.md

#### PasswordRequiredException class

The PasswordRequiredException type exposes the following members:


# GroupDocs.Metadata

> Read, edit, and remove metadata in documents, images, audio, and video.

## Java

### GroupDocs.Metadata for Java
Path: https://reference.groupdocs.com/metadata/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.metadata | The **com.groupdocs.metadata** namespace is the entry point to all features of the library. |
| com.groupdocs.metadata.core | The **com.groupdocs.metadata.core** namespace provides main classes allowing working with metadata in all supported formats. |
| com.groupdocs.metadata.export | The **com.groupdocs.metadata.export** namespace contains classes that allow users to export metadata properties to different representations. |
| com.groupdocs.metadata.imports | The **com.groupdocs.metadata.imports** namespace contains classes that allow users to import metadata properties to different representations. |
| com.groupdocs.metadata.licensing | The **com.groupdocs.metadata.licensing** namespace provides classes for licensing the Metadata library. |
| com.groupdocs.metadata.options | The **com.groupdocs.metadata.options** namespace contains all classes representing settings that allow users to control file and metadata processing. |
| com.groupdocs.metadata.search | The **com.groupdocs.metadata.search** namespace contains base classes, utility classes and interfaces used across all formats and metadata standards. |
| com.groupdocs.metadata.tagging | The **com.groupdocs.metadata.tagging** namespace contains various sets of tags with which most important metadata properties are marked.The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format. |

### com.groupdocs.metadata.core
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core.md

The **com.groupdocs.metadata.core** namespace provides main classes allowing working with metadata in all supported formats.

#### Classes

| Class | Description |
| --- | --- |
| ApePackage | Represents an APE v2 metadata package. |
| AsfAudioStreamProperty | Represents Audio stream property metadata in the ASF media container. |
| AsfBaseDescriptor | Represents an ASF base metadata descriptor object. |
| AsfBaseStreamProperty | Represents base stream property metadata in the ASF media container. |
| AsfCodec | Represents ASF codec metadata. |
| AsfContentDescriptor | Represents an ASF content descriptor object. |
| AsfDescriptorType | Defines ASF descriptor types. |
| AsfExtendedStreamPropertyFlags | Defines ASF extended stream property flags. |
| AsfFilePropertyFlags | Defines ASF file property flags. |
| AsfMetadataDescriptor | Represents an ASF metadata descriptor. |
| AsfMetadataDescriptorCollection | Represents a collection of metadata descriptors. |
| AsfPackage | Represents native metadata of the ASF media container. |
| AsfRootPackage | Represents the root package allowing working with metadata in an ASF video. |
| AsfVideoStreamProperty | Represents Video stream property metadata in the ASF media container. |
| AviHeader | Represents the AVIMAINHEADER structure in an AVI video. |
| AviHeaderFlags | Represents AVI Header flags. |
| AviRootPackage | Represents the root package allowing working with metadata in an AVI video. |
| BmpHeaderPackage | Represents BMP header info. |
| BmpRootPackage | Represents the root package intended to work with metadata in a BMP image. |
| CadCustomPropertyPackage | Represents a collection of custom CAD metadata properties. |
| CadPackage | Represents CAD (Computer-aided design) metadata. |
| CadRootPackage | Represents the root package allowing working with metadata in a CAD drawing. |
| CanonCameraSettingsPackage | Represents CANON camera settings. |
| CanonMakerNotePackage | Represents CANON MakerNote metadata. |
| Cms | Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. |
| CmsAttribute | Represents a CMS signer info attribute. |
| CmsCertificate | Represents a CMS certificate. |
| CmsEncapsulatedContent | Represents a signed content container, consisting of a content type identifier and the content itself. |
| CmsPackage | Represents a CMS digital signature metadata package. |
| CmsSigner | Represents CMS per-signer information. |
| Cr2AFConfigPackage | Represents Canon MakerNotes tags. |
| Cr2AFInfo2Package | Represents Canon MakerNotes tags. |
| Cr2AFInfoPackage | Represents Canon MakerNotes tags. |
| Cr2AFMicroAdjPackage | Represents Canon MakerNotes tags. |
| Cr2AspectInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CameraSettingsPackage | Represents Canon MakerNotes tags. |
| Cr2ColorBalancePackage | Represents Canon MakerNotes tags. |
| Cr2ColorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CropInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FileInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FocalLengthPackage | Represents Canon MakerNotes tags. |
| Cr2Functions1DPackage | Represents Canon MakerNotes tags. |
| Cr2LightingOptPackage | Represents Canon MakerNotes tags. |
| Cr2LogInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MakerNotePackage | Represents Canon MakerNotes tags. |
| Cr2ModifiedInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MovieInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MultiExpPackage | Represents Canon MakerNotes tags. |
| Cr2Package | Represents native CR2 metadata. |
| Cr2PanoramaPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncValuesPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncsPackage | Represents Canon MakerNotes tags. |
| Cr2ProcessingPackage | Represents Canon MakerNotes tags. |
| Cr2RootPackage | Represents an entry point to all metadata packages presented in a particular file CR2. |
| Cr2SensorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2ShotInfoPackage | Represents Canon MakerNotes tags. |
| Cr2TimeInfoPackage | Represents Canon MakerNotes tags. |
| Cr2VignettingCorr2Package | Represents Canon MakerNotes tags. |
| Cr2WBInfoPackage | Represents Canon MakerNotes tags. |
| CustomPackage | Provides a container for metadata properties. |
| DiagramPackage | Represents a native metadata package in a diagram format. |
| DiagramRootPackage | Represents the root package intended to work with metadata in a diagram. |
| DiagramTypePackage | Represents a metadata package containing diagram-specific file format information. |
| DicomPackage | Represents native DICOM metadata. |
| DicomRootPackage | Represents the root package intended to work with metadata in a DICOM image. |
| DigitalSignature | Represents a digital signature used to sign a document. |
| DisposableWrapper<T> |  |
| DjVuRootPackage | Represents the root package intended to work with metadata in an DjVu image. |
| DngPackage | Represents native DNG metadata. |
| DngRootPackage | Represents the root package intended to work with metadata in a DNG image. |
| DocumentInfo | Provides common information about a loaded document. |
| DocumentPackage | Represents native metadata in an office document. |
| DocumentProtectedException | The exception that is thrown when document is protected by password. |
| DocumentRootPackage<TPackage> | Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc. |
| DocumentStatistics | Represents a set of document statistics. |
| DublinCorePackage | Represents a Dublin Core metadata package. |
| DwgRootPackage | Represents the root package allowing working with metadata in a DWG drawing. |
| DxfRootPackage | Represents the root package allowing working with metadata in a DXF drawing. |
| EmailHeaderPackage | Represents a metadata package containing email message headers. |
| EmailPackage | Represents email message metadata. |
| EmailRootPackage | Represents the root package allowing working with metadata in an email message. |
| EmfRootPackage | Represents the root package intended to work with metadata in an EMF image. |
| EmlPackage | Represents EML message metadata. |
| EmlRootPackage | Represents the root package allowing working with metadata in an EML email message. |
| EpubPackage | Represents metadata in a EPUB e-book. |
| EpubRootPackage | Represents the root package allowing working with metadata in an EPUB e-book. |
| ExifDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| ExifGpsPackage | Represents GPS metadata in an EXIF metadata package. |
| ExifIfdPackage | Represents the Exif Image File Directory. |
| ExifPackage | Represents an EXIF metadata package (Exchangeable Image File Format). |
| FileType | Represents the file type. |
| FileTypePackage | Represents a metadata package containing file format information. |
| FlvHeader | Represents a FLV video header. |
| FlvRootPackage | Represents the root package allowing working with metadata in an FLV video. |
| GifImageTypePackage | Represents a metadata package containing GIF-specific file format information. |
| GifRootPackage | Represents the root package intended to work with metadata in a GIF image. |
| GpsIfdPackage | Represents GPS IFD. |
| GroupDocsMetadataException | Represents a product-specific exception that is thrown during file processing. |
| HeifRootPackage | Represents the root package intended to work with metadata in a HEIF image. |
| ID3Tag | Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags. |
| ID3V1Genre | Specifies genres used in an Id3v1 tag. |
| ID3V1Tag | Represents an ID3v1 tag. |
| ID3V2AttachedPictureFrame | Represents an APIC frame in an  ID3V2Tag . |
| ID3V2AttachedPictureType | Represents the type of an attached picture. |
| ID3V2CommentFrame | Represents a COMM frame in an  ID3V2Tag . |
| ID3V2MlltFrame | Represents an MLLT frame in an  ID3V2Tag . |
| ID3V2PlayCounterFrame | Represents a PCNT frame in an  ID3V2Tag . |
| ID3V2PrivateFrame | Represents a PRIV frame in an  ID3V2Tag . |
| ID3V2Tag | Represents an ID3v2 tag. |
| ID3V2TagFrame | Represents a generic frame in an  ID3V2Tag . |
| ID3V2TagFrameFlags | Represents flags used in a ID3v2 tag frame. |
| ID3V2TextFrame | Represents a text frame in an  ID3V2Tag . |
| ID3V2UrlLinkFrame | Represents a URL link frame in an  ID3V2Tag . |
| ID3V2UserDefinedFrame | Represents a TXXX frame in an  ID3V2Tag . |
| ID3V2UserDefinedUrlLinkFrame | Represents a WXXX frame in an  ID3V2Tag . |
| ImageResourceBlock |  |
| ImageResourceID | Image resources standard ID numbers. |
| ImageResourcePackage | Represents a metadata package containing Photoshop Image Resources. |
| ImageRootPackage | Provides a base abstract class for all image root packages. |
| ImageTypePackage | Represents a metadata package containing image-specific file format information. |
| InteroperabilityIFDPointerPackage | Represents Interoperability IFD. |
| InvalidFormatException | The exception that is thrown when a file has an invalid format. |
| IptcApplicationRecord | Represents an IPTC Application Record. |
| IptcDataSet | Represents an IPTC DataSet (metadata property). |
| IptcEnvelopeRecord | Represents an IPTC Envelope Record. |
| IptcEnvelopeRecordDataSet | Defines IPTC Envelope Record dataSet numbers. |
| IptcRecord | Represents an IPTC record. |
| IptcRecordSet | Represents a collection of IPTC records. |
| IptcRecordType | Defines IPTC record types. |
| Jpeg2000Package | Represents native JPEG2000 metadata. |
| Jpeg2000RootPackage | Represents the root package intended to work with metadata in a JPEG2000 image. |
| JpegRootPackage | Represents the root package allowing working with metadata in a JPEG image. |
| LyricsField | Represents a  LyricsTag  field. |
| LyricsTag | Represents Lyrics3 v2.00 metadata. |
| MP3RootPackage | Represents the root package allowing working with metadata in an MP3 audio. |
| MakerNotePackage | Provides an abstract base class for MakerNote metadata packages. |
| MatroskaAudioTrack | Represents audio metadata in a Matroska video. |
| MatroskaBasePackage | Provides a base metadata class for all packages extracted from a Matroska video. |
| MatroskaEbmlHeader | Represents EBML header metadata in a Matroska video. |
| MatroskaPackage | Represents a metadata container in a Matroska video. |
| MatroskaRootPackage | Represents the root package allowing working with metadata in a Matroska video. |
| MatroskaSegment | Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video. |
| MatroskaSimpleTag | Represents general information about the target in a Matroska video. |
| MatroskaSubtitle | Represents subtitle metadata in a Matroska video. |
| MatroskaSubtitleTrack | Represents subtitle metadata in a Matroska video. |
| MatroskaTag | Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video. |
| MatroskaTrack | Represents track metadata in a Matroska video. |
| MatroskaVideoTrack | Represents video metadata in a Matroska video. |
| MetadataPackage | Represents base abstraction for a metadata package. |
| MetadataProperty | Represents a metadata property. |
| MetadataValidationException | The exception that is thrown when validation errors encountered during metadata saving. |
| MovAtom | Represents a QuickTime atom. |
| MovPackage | Represents QuickTime metadata. |
| MovRootPackage | Represents the root package allowing working with metadata in a QuickTime video. |
| MpegAudioPackage | Represents MPEG audio metadata. |
| MsgPackage | Represents MSG message metadata. |
| MsgRootPackage | Represents the root package allowing working with metadata in an MSG email message. |
| NikonMakerNotePackage | Represents NIKON MakerNote metadata. |
| NoteInspectionPackage | Represents a metadata package exposing the internal structure of a note section. |
| NotePage | Represents a page in a OneNote section. |
| NoteRootPackage | Represents the root package intended to work with metadata in an electronic note file. |
| Oid | Represents an object identifier (OID). |
| OpenTypeBaseNameRecord | Represents the base OpenType Name table record class. |
| OpenTypeFlags | Represents OpenType font header flags. |
| OpenTypeFont | Represents a single font extracted from a file. |
| OpenTypeLicensingRights | Indicates font embedding licensing rights for the font. |
| OpenTypeMacintoshNameRecord | Represents the Name record table value for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypePackage | Represents an OpenType font metadata package. |
| OpenTypeRootPackage | Represents the root package allowing working with metadata in an OpenType font file. |
| OpenTypeStyles | Represents the OpenType font style. |
| OpenTypeUnicodeNameRecord | Represents the Name record table value for the  OpenTypePlatform.Unicode  platform. |
| OpenTypeWindowsNameRecord | Represents the Name record table value for  OpenTypePlatform.Windows  platform. |
| PageInfo | Provides common information about a document page (slide, worksheet, etc). |
| PanasonicMakerNotePackage | Represents PANASONIC MakerNote metadata. |
| PdfAnnotation | Represents an annotation in a PDF document. |
| PdfAttachment | Represents an attachment in a PDF document. |
| PdfBookmark | Represents a bookmark in a PDF document. |
| PdfFormField | Represents a form field in a PDF document. |
| PdfInspectionPackage | Contains information about PDF document parts that can be considered as metadata in some cases. |
| PdfPackage | Represents native metadata in a PDF document. |
| PdfRootPackage | Represents the root package allowing working with metadata in a PDF document. |
| PdfTypePackage | Represents a metadata package containing PDF-specific file format information. |
| PngCompressedTextChunk | Represents compressed textual data extracted from a PNG image. |
| PngInternationalTextChunk | Represents international textual data extracted from a PNG image. |
| PngPackage | Represents native PNG metadata. |
| PngRootPackage | Represents the root package intended to work with metadata in a PNG image. |
| PngTextChunk | Represents textual data extracted from a PNG image. |
| PresentationComment | Represents a user comment in a presentation. |
| PresentationInspectionPackage | Contains information about presentation parts that can be considered as metadata in some cases. |
| PresentationPackage | Represents a native metadata package in a presentation. |
| PresentationRootPackage | Represents the root package intended to work with metadata in a presentation. |
| PresentationSlide | Represents a slide in a presentation. |
| PresentationTypePackage | Represents a metadata package containing presentation-specific file format information. |
| ProjectManagementPackage | Represents a native metadata package in a project management file. |
| ProjectManagementRootPackage | Represents the root package intended to work with metadata in a project management format. |
| PropertyAccessLevels | Defines access levels for metadata properties. |
| PropertyDescriptor | Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine. |
| PropertyValue | Represents a property value. |
| PsdLayer | Represents a layer in a PSD file. |
| PsdLayerFlags | The Photoshop layer flags. |
| PsdPackage | Represents native Photoshop metadata. |
| PsdRootPackage | Represents the root package allowing working with metadata in a Photoshop Document. |
| RarFile | Represents metadata associated with an archived file or directory. |
| RarPackage | Represents ZIP archive metadata. |
| RarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| RawDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| RawExifTagPackage | Represents Exif tags. |
| RawIFD1Package | Represents IFD1 tags. |
| RawIFD2Package | Represents IFD1 tags. |
| RawIFD3Package | Represents IFD1 tags. |
| RawMakerNotePackage | Represents Raw MakerNotes tags. |
| RawTiffTagPackage | Represents Tiff tags. |
| RawTypePackage | Represents a metadata package containing image-specific file format information. |
| ReadOnlyList<T> | Provides an abstract base class for a strongly typed read-only list. |
| Rectangle | A set of four integers that represent the location and size of a rectangle. |
| RiffInfoPackage | Represents the metadata package containing properties extracted from the RIFF INFO chunk. |
| RootMetadataPackage | Represents an entry point to all metadata packages presented in a particular file. |
| SevenZipFile | Represents metadata associated with an archived file or directory. |
| SevenZipPackage | Represents ZIP archive metadata. |
| SevenZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| SonyMakerNotePackage | Represents SONY MakerNote metadata. |
| SpreadsheetComment | Represents a user comment in a spreadsheet. |
| SpreadsheetContentTypePackage | Represents a metadata package containing spreadsheet content type properties. |
| SpreadsheetContentTypeProperty | Represents a content type property in a spreadsheet. |
| SpreadsheetInspectionPackage | Contains information about spreadsheet parts that can be considered as metadata in some cases. |
| SpreadsheetPackage | Represents a native metadata package in a spreadsheet. |
| SpreadsheetRootPackage | Represents the root package allowing working with metadata in a spreadsheet. |
| SpreadsheetSheet | Represents a sheet in a spreadsheet document. |
| SpreadsheetTypePackage | Represents a metadata package containing spreadsheet-specific file format information. |
| TarFile | Represents metadata associated with an archived file or directory. |
| TarPackage | Represents ZIP archive metadata. |
| TarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| TiffArrayTag<T> | Represents an array-based TIFF tag. |
| TiffAsciiTag | Represents a TIFF ASCII tag. |
| TiffByteTag | Represents a Byte tag. |
| TiffDoubleTag | Represents a TIFF Double tag. |
| TiffFloatTag | Represents a TIFF float tag. |
| TiffLongTag | Represents a TIFF Long tag. |
| TiffRational | Represents a rational number. |
| TiffRationalTag | Represents a TIFF Rational tag. |
| TiffRootPackage | Represents the root package allowing working with metadata in a TIFF image. |
| TiffSByteTag | Represents a TIFF SByte tag. |
| TiffSLongTag | Represents a TIFF SLong tag. |
| TiffSRational | Represents signed rational number. |
| TiffSRationalTag | Represents a TIFF SRational tag. |
| TiffSShortTag | Represents a TIFF SShort tag. |
| TiffShortTag | Represents a TIFF Short tag. |
| TiffTag | Represents a TIFF tag. |
| TiffTagID | Defines ids of TIFF tags. |
| TiffUndefinedTag | Represents a TIFF tag with the Undefined type. |
| TorrentPackage | Represents torrent descriptor file metadata. |
| TorrentRootPackage | Represents the root package intended to work with metadata of a TORRENT file. |
| TorrentSharedFilePackage | Represents shared file information. |
| VCardAgentRecord | Represents vCard Agent record metadata class. |
| VCardBasePackage | Represents the base VCard metadata class. |
| VCardBinaryRecord | Represents vCard binary record metadata class. |
| VCardCalendarRecordset | Represents a set of Calendar vCard records. |
| VCardCard | Represents a single card extracted from a VCard file. |
| VCardCommunicationRecordset | Represents a set of Communication vCard records. |
| VCardCustomRecord | Represents vCard custom record metadata class. |
| VCardDateTimeRecord | Represents vCard date time record metadata class. |
| VCardDeliveryAddressingRecordset | Represents a set of Delivery Addressing vCard records. |
| VCardExplanatoryRecordset | Represents a set of Explanatory vCard records. |
| VCardGeneralRecordset | Represents a set of General vCard records. |
| VCardGeographicalRecordset | Represents a set of Geographical vCard records. |
| VCardIdentificationRecordset | Represents a set of Identification vCard records. |
| VCardOrganizationalRecordset | Represents a set of Organizational vCard records. |
| VCardPackage | Represents VCF (Virtual Contact File) electronic business card format metadata. |
| VCardRecord | Represents abstract vCard record metadata class. |
| VCardRecordset | Provides a base vCard record union class. |
| VCardRootPackage | Represents the root package allowing working with metadata in a VCard file. |
| VCardSecurityRecordset | Represents a set of Security vCard records. |
| VCardTextRecord | Represents vCard text record metadata class. |
| ValueAcceptor | Provides a base abstract class that allows extracting all supported types of values from a  PropertyValue  instance. |
| ValueInterpreter | Defines operations required to interpret metadata property values. |
| WavPackage | Represents a native metadata package in a WAV audio file. |
| WavRootPackage | Represents the root package allowing working with metadata in a WAV audio. |
| WebPRootPackage | Represents the root package allowing working with metadata in a WEBP image. |
| WmfRootPackage | Represents the root package intended to work with metadata in a WMF image. |
| WordProcessingComment | Represents a comment in a word processing document. |
| WordProcessingField | Represents a field in a word processing document. |
| WordProcessingInspectionPackage | Contains information about document parts that can be considered as metadata in some cases. |
| WordProcessingPackage | Represents a native metadata package in a word processing document. |
| WordProcessingRevision | Represents a revision (tracked change) in a document. |
| WordProcessingRootPackage | Represents the root package allowing working with metadata in a word processing document. |
| WordProcessingTypePackage | Represents a metadata package containing document-specific file format information. |
| XmpArray | Represents base abstraction for XMP array. |
| XmpAudioChannelType | Represents audio channel type. |
| XmpAudioSampleType | Represents Audio sample type in  XmpDynamicMediaPackage . |
| XmpBasicJobTicketPackage | Represents Basic Job-Ticket namespace. |
| XmpBasicPackage | Represents the XMP basic namespace. |
| XmpBoolean | Represents XMP Boolean basic type. |
| XmpCameraRawPackage | Represents Camera Raw schema. |
| XmpClosedChoice<T> | Represents XMP Closed Choice. |
| XmpColorantBase | A structure containing the characteristics of a colorant (swatch) used in a document. |
| XmpColorantCmyk | Represents the CMYK Colorant. |
| XmpColorantLab | Represents the LAB Colorant. |
| XmpColorantRgb | Represents the RGB Colorant. |
| XmpComplexType | Represents base abstraction for XMP Complex value type. |
| XmpComplexTypeValue | Represents an XMP value containing a complex type instance. |
| XmpDate | Represents Date in XMP packet. |
| XmpDimensions | Containing dimensions for a drawn object. |
| XmpDublinCorePackage | Represents the Dublin Core scheme. |
| XmpDynamicMediaPackage | Represents XMP Dynamic Media namespace. |
| XmpElementBase | Represents base XMP element that contains attributes. |
| XmpException | The exception that is thrown when XMP has invalid structure. |
| XmpFont | A structure containing the characteristics of a font used in a document. |
| XmpGuid | Represents XMP global unique identifier. |
| XmpHeaderPI | Represents XMP header processing instruction. |
| XmpInteger | Represents XMP Integer basic type. |
| XmpIptcCorePackage | Represents the IPTC Core XMP package. |
| XmpIptcExtensionPackage | Represents the IPTC Extension XMP package. |
| XmpIptcIimPackage | Represents the IPTC-IIM XMP package. |
| XmpJob | Represents Job. |
| XmpLangAlt |  |
| XmpMediaManagementPackage | Represents the XMP Media Management namespace. |
| XmpMeta | Represents xmpmeta. |
| XmpMetadataContainer | Represents a container for XMP metadata properties. |
| XmpNamespaces | Contains namespaces used in  XmpPackage  and  XmpComplexType . |
| XmpPackage | Represents base abstraction for XMP package. |
| XmpPacketWrapper | Contains serialized XMP package including header and trailer. |
| XmpPagedTextPackage | Represents the XMP Paged-Text package. |
| XmpPdfPackage | Specifies properties used with Adobe PDF documents. |
| XmpPhotoshopPackage | Represents Adobe Photoshop namespace. |
| XmpRational | Represents XMP XmpRational. |
| XmpReal | Represents XMP Real. |
| XmpRenditionClass | Represents XMP RenditionClass. |
| XmpResourceEvent | Represents a high-level event that occurred in the processing of a resource. |
| XmpResourceRef |  |
| XmpRightsManagementPackage | Represents XMP Rights Management namespace. |
| XmpSchemes | Provides access to known XMP schemes. |
| XmpText | Represents XMP Text basic type. |
| XmpThumbnail | Represents a thumbnail image for a file. |
| XmpTime | Representation of a time value in seconds. |
| XmpTimeFormat | Represents time format in  XmpTimecode . |
| XmpTimecode | Represents a timecode value in a video. |
| XmpTrailerPI | Represents XMP trailer processing instruction. |
| XmpValueBase | Represents base XMP value. |
| XmpVersion | Represents a version of a document. |
| XmpWhiteBalance | Represents the White Balance setting in  XmpCameraRawPackage . |
| ZipFile | Represents metadata associated with an archived file or directory. |
| ZipPackage | Represents ZIP archive metadata. |
| ZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Provides common information about a loaded document. |
| IDublinCore | Defines base operations allowing working with Dublin Core metadata. |
| IEnumValue | Defines a value of an enumeration. |
| IEnumValueInterpreter | Represents an interpreter intended to convert various numeric values to descriptive string values. |
| IExif | Defines base operations intended to work with EXIF metadata. |
| IIptc | Represents base operations intended to work with IPTC metadata. |
| IReadOnlyList<T> | Represents a read-only collection of elements that can be accessed by index. |
| IXmp | Defines base operations intended to work with XMP metadata. |
| IXmpType | Base interface for XMP type. |

#### Enumerations

| Enum | Description |
| --- | --- |
| AsfCodecType | Defines ASF codec types. |
| AsfStreamType | Defines ASF stream types. |
| ByteOrder | Defines various byte orders. |
| CadAcadVersion | Defines AutoCAD drawing database version numbers. |
| DiagramFormat | Defines various diagram subformats. |
| ExifGpsAltitudeRef | Represents a GPS altitude reference. |
| FileFormat | Represents the recognized format of a loaded file. |
| ID3V2EncodingType | Defines different types of text encoding used in ID3v2. |
| IptcApplicationRecordDataSet | Defines IPTC Application Record dataSet numbers. |
| MatroskaContentType | Represents a Matroska content type. |
| MatroskaTargetTypeValue | Represents a number to indicate the logical level of the Matroska tag target. |
| MatroskaTrackType | Represents Matroska track types coded in 8 bits. |
| MatroskaVideoDisplayUnit | Defines how Matroska DisplayWidth and DisplayHeight are interpreted. |
| MatroskaVideoFieldOrder | Represents the field ordering of the Matroska video. |
| MatroskaVideoFlagInterlaced | Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| MatroskaVideoStereoMode | Represents Matroska Stereo-3D video modes. |
| MetadataPropertyType | Defines metadata property types. |
| MetadataType | Specifies the type of a metadata package. |
| MpegAudioVersion | Represents a particular MPEG standard. |
| MpegChannelMode | Defines MPEG audio channel modes. |
| MpegEmphasis | Defines MPEG emphasis types. |
| OpenTypeDigitalSignatureFlags | Represents OpenType font digital signature flags. |
| OpenTypeDirectionHint | Represents the OpenType font direction. |
| OpenTypeIsoEncoding | Represents encoding for the  OpenTypePlatform.Iso  platform. |
| OpenTypeMacintoshEncoding | Represents encoding for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypeMacintoshLanguage | Represents language enum for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypeName | Defines pre-defined IDs, they apply to all platforms unless indicated otherwise. |
| OpenTypePlatform | Represents OpenType platform for Name table. |
| OpenTypeUnicodeEncoding | Represents encoding for  OpenTypePlatform.Unicode  platform. |
| OpenTypeVersion | Represents the OpenType version. |
| OpenTypeWeight | Represents the OpenType font weight. |
| OpenTypeWidth | Represents the OpenType font width. |
| OpenTypeWindowsEncoding | Represents encoding for the  OpenTypePlatform.Windows  platform. |
| OpenTypeWindowsLanguage | Represents language for  OpenTypePlatform.Windows  platform. |
| PngCompressionMethod | Defines compression methods used in the PNG format. |
| PresentationFormat | Defines various presentation subformats. |
| PsdColorMode | Represents the psd file format color mode. |
| PsdCompressionMethod | Defines the compression method used for image data. |
| RawIntegerType | Defines raw integer types for enumerations. |
| SpreadsheetFormat | Defines various spreadsheet subformats. |
| TiffTagType | Represents the IFD data type. |
| VCardContentType | Defines vCard record content types. |
| WordProcessingFormat | Defines various word processing document subformats. |
| WordProcessingRevisionType | Specifies the type of the change being tracked by a revision. |
| XmpArrayType | Represents array type in  XmpArray . |
| XmpColorType | Type of color in  XmpColorantBase . |
| XmpColorantColorMode | Represents color mode in  XmpColorantBase . |
| XmpCropUnit | Represent a unit for CropWidth and CropHeight in  XmpCameraRawPackage . |
| XmpPhotoshopColorMode | Represents a color mode in  XmpPhotoshopPackage . |
| ZipCompressionMethod | Defines ZIP compression methods. |

### ApePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/apepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ApePackage extends CustomPackage
```

Represents an APE v2 metadata package. Please find more information at  [http://wiki.hydrogenaud.io/index.php?title=APE\_key][http_wiki.hydrogenaud.io_index.php_title_APE_key] .

This example demonstrates how to read the APEv2 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithApe)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getApeV2() != null) {
>          System.out.println(root.getApeV2().getAlbum());
>          System.out.println(root.getApeV2().getTitle());
>          System.out.println(root.getApeV2().getArtist());
>          System.out.println(root.getApeV2().getComposer());
>          System.out.println(root.getApeV2().getCopyright());
>          System.out.println(root.getApeV2().getGenre());
>          System.out.println(root.getApeV2().getLanguage());
>          // ...
>      }
>  }
>
> ```
> ```

[http_wiki.hydrogenaud.io_index.php_title_APE_key]: http://wiki.hydrogenaud.io/index.php?title=APE_key
[Handling the APEv2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+APEv2+tag
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets the title. |
| getSubtitle() | Gets the subtitle. |
| getArtist() | Gets the artist. |
| getAlbum() | Gets the album. |
| getDebutAlbum() | Gets the debut album. |
| getPublisher() | Gets the publisher. |
| getConductor() | Gets the conductor. |
| getTrack() | Gets the track number. |
| getComposer() | Gets the composer. |
| getComment() | Gets the comment. |
| getCopyright() | Gets the copyright. |
| getPublicationRight() | Gets the publication right. |
| getFile() | Gets the file. |
| getIsbn() | Gets the ISBN number with check digit. |
| getRecordLocation() | Gets the record location. |
| getGenre() | Gets the genre. |
| getIsrc() | Gets the International Standard Recording Number. |
| getAbstract() | Gets the abstract link. |
| getLanguage() | Gets the language. |
| getBibliography() | Gets the bibliography. |
##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### getSubtitle()
```
public final String getSubtitle()
```

Gets the subtitle.

**Returns:**
java.lang.String - The subtitle.
##### getArtist()
```
public final String getArtist()
```

Gets the artist.

**Returns:**
java.lang.String - The artist.
##### getAlbum()
```
public final String getAlbum()
```

Gets the album.

**Returns:**
java.lang.String - The album.
##### getDebutAlbum()
```
public final String getDebutAlbum()
```

Gets the debut album.

**Returns:**
java.lang.String - The debut album.
##### getPublisher()
```
public final String getPublisher()
```

Gets the publisher.

**Returns:**
java.lang.String - The publisher.
##### getConductor()
```
public final String getConductor()
```

Gets the conductor.

**Returns:**
java.lang.String - The conductor.
##### getTrack()
```
public final Integer getTrack()
```

Gets the track number.

**Returns:**
java.lang.Integer - The track number.
##### getComposer()
```
public final String getComposer()
```

Gets the composer.

**Returns:**
java.lang.String - The composer.
##### getComment()
```
public final String getComment()
```

Gets the comment.

**Returns:**
java.lang.String - The comment.
##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright.

**Returns:**
java.lang.String - The copyright.
##### getPublicationRight()
```
public final String getPublicationRight()
```

Gets the publication right.

**Returns:**
java.lang.String - The publication right.
##### getFile()
```
public final String getFile()
```

Gets the file.

**Returns:**
java.lang.String - The file.
##### getIsbn()
```
public final String getIsbn()
```

Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International\_Standard\_Book\_Number.

**Returns:**
java.lang.String - The ISBN number.
##### getRecordLocation()
```
public final String getRecordLocation()
```

Gets the record location.

**Returns:**
java.lang.String - The record location.
##### getGenre()
```
public final String getGenre()
```

Gets the genre.

**Returns:**
java.lang.String - The genre.
##### getIsrc()
```
public final String getIsrc()
```

Gets the International Standard Recording Number.

**Returns:**
java.lang.String - The International Standard Recording Number.
##### getAbstract()
```
public final String getAbstract()
```

Gets the abstract link.

**Returns:**
java.lang.String - The abstract link.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language.

**Returns:**
java.lang.String - The language.
##### getBibliography()
```
public final String getBibliography()
```

Gets the bibliography.

**Returns:**
java.lang.String - The bibliography.

### AsfAudioStreamProperty
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfaudiostreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.AsfBaseStreamProperty
```
public class AsfAudioStreamProperty extends AsfBaseStreamProperty
```

Represents Audio stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getFormatTag() | Gets the unique ID of the codec used to encode the audio data. |
| getChannels() | Gets the number of audio channels. |
| getSamplesPerSecond() | Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream. |
| getBitsPerSample() | Gets the number of bits per sample of monaural data. |
##### getFormatTag()
```
public final int getFormatTag()
```

Gets the unique ID of the codec used to encode the audio data.

**Returns:**
int - The unique ID of the codec used to encode the audio data.
##### getChannels()
```
public final int getChannels()
```

Gets the number of audio channels.

**Returns:**
int - The number of audio channels.
##### getSamplesPerSecond()
```
public final long getSamplesPerSecond()
```

Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.

**Returns:**
long - The a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.
##### getBitsPerSample()
```
public final int getBitsPerSample()
```

Gets the number of bits per sample of monaural data.

**Returns:**
int - The number of bits per sample of monaural data.

### AsfBaseDescriptor
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfbasedescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public abstract class AsfBaseDescriptor extends MetadataProperty
```

Represents an ASF base metadata descriptor object.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getAsfContentType() | Gets the type of the content. |
##### getAsfContentType()
```
public final AsfDescriptorType getAsfContentType()
```

Gets the type of the content.

**Returns:**
AsfDescriptorType - The type of the content.

### AsfBaseStreamProperty
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfbasestreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class AsfBaseStreamProperty extends CustomPackage
```

Represents base stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getStreamType() | Gets the type of this stream. |
| getStreamNumber() | Gets the number of this stream. |
| getStartTime() | Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole. |
| getEndTime() | Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| getBitrate() | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| getAlternateBitrate() | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| getFlags() | Gets the flags. |
| getLanguage() | Gets the stream language. |
| getAverageTimePerFrame() | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| getAverageBitrate() | Gets the average bitrate. |
##### getStreamType()
```
public final AsfStreamType getStreamType()
```

Gets the type of this stream.

**Returns:**
AsfStreamType - The type of this stream.
##### getStreamNumber()
```
public final byte getStreamNumber()
```

Gets the number of this stream.

**Returns:**
byte - The number of this stream.
##### getStartTime()
```
public final Long getStartTime()
```

Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole.

**Returns:**
java.lang.Long - The presentation time of the first object.
##### getEndTime()
```
public final Long getEndTime()
```

Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole.

**Returns:**
java.lang.Long - The presentation time of the last object plus the duration of play.
##### getBitrate()
```
public final Long getBitrate()
```

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

**Returns:**
java.lang.Long - The bleak rate R, in bits per second.
##### getAlternateBitrate()
```
public final Long getAlternateBitrate()
```

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

**Returns:**
java.lang.Long - The leak rate RAlt, in bits per second.
##### getFlags()
```
public final AsfExtendedStreamPropertyFlags getFlags()
```

Gets the flags.

**Returns:**
AsfExtendedStreamPropertyFlags - The flags.
##### getLanguage()
```
public final String getLanguage()
```

Gets the stream language.

**Returns:**
java.lang.String - The stream language.
##### getAverageTimePerFrame()
```
public final Long getAverageTimePerFrame()
```

Gets the average time duration, measured in 100-nanosecond units, of each frame.

**Returns:**
java.lang.Long - The average time duration, measured in 100-nanosecond units, of each frame.
##### getAverageBitrate()
```
public final Long getAverageBitrate()
```

Gets the average bitrate.

**Returns:**
java.lang.Long - The average bitrate.

### AsfCodec
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfcodec.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfCodec extends CustomPackage
```

Represents ASF codec metadata.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getCodecType() | Gets the type of the codec. |
| getDescription() | Gets the description. |
| getInformation() | Gets the information string. |
##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getCodecType()
```
public final AsfCodecType getCodecType()
```

Gets the type of the codec.

**Returns:**
AsfCodecType - The type of the codec.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getInformation()
```
public final String getInformation()
```

Gets the information string.

**Returns:**
java.lang.String - The information string.

### AsfCodecType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfcodectype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum AsfCodecType extends Enum<AsfCodecType> implements IEnumValue
```

Defines ASF codec types.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined codec. |
| Video | Video codec. |
| Audio | Audio codec. |
| Unknown | Unknown codec. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final AsfCodecType Undefined
```

Undefined codec.

##### Video
```
public static final AsfCodecType Video
```

Video codec.

##### Audio
```
public static final AsfCodecType Audio
```

Audio codec.

##### Unknown
```
public static final AsfCodecType Unknown
```

Unknown codec.

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

**Returns:**
com.groupdocs.metadata.core.AsfCodecType[]
##### valueOf(String name)
```
public static AsfCodecType valueOf(String name)
```

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

**Returns:**
AsfCodecType
##### getByRawValue(int rawValue)
```
public static AsfCodecType getByRawValue(int rawValue)
```

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

**Returns:**
AsfCodecType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### AsfContentDescriptor
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfcontentdescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.AsfBaseDescriptor
```
public final class AsfContentDescriptor extends AsfBaseDescriptor
```

Represents an ASF content descriptor object.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files

### AsfDescriptorType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfdescriptortype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfDescriptorType implements IEnumValue
```

Defines ASF descriptor types.
#### Fields

| Field | Description |
| --- | --- |
| Unicode | The unicode string type. |
| ByteArray | The byte array type. |
| Bool | The 32-bit bool type. |
| DWord | The 32-bit unsigned integer type. |
| QWord | The 64-bit unsigned integer type. |
| Word | The 16-bit unsigned integer type. |
| Guid | The 128-bit (16 byte) GUID type. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Unicode
```
public static final AsfDescriptorType Unicode
```

The unicode string type.

##### ByteArray
```
public static final AsfDescriptorType ByteArray
```

The byte array type.

##### Bool
```
public static final AsfDescriptorType Bool
```

The 32-bit bool type.

##### DWord
```
public static final AsfDescriptorType DWord
```

The 32-bit unsigned integer type.

##### QWord
```
public static final AsfDescriptorType QWord
```

The 64-bit unsigned integer type.

##### Word
```
public static final AsfDescriptorType Word
```

The 16-bit unsigned integer type.

##### Guid
```
public static final AsfDescriptorType Guid
```

The 128-bit (16 byte) GUID type.

##### getByRawValue(int rawValue)
```
public static AsfDescriptorType getByRawValue(int rawValue)
```

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

**Returns:**
AsfDescriptorType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### AsfExtendedStreamPropertyFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfextendedstreampropertyflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfExtendedStreamPropertyFlags implements IEnumValue
```

Defines ASF extended stream property flags.
#### Fields

| Field | Description |
| --- | --- |
| Reliable | This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism. |
| Seekable | This flag should be set only if the stream is seekable. |
| NoCleanpoints | The stream does not contain any cleanpoints. |
| ResendLiveCleanpoints | A stream is joined in mid-transmission, all information from the most recent cleanpoint up to the current time should be sent before normal streaming begins at the current time. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Reliable
```
public static final AsfExtendedStreamPropertyFlags Reliable
```

This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism.

##### Seekable
```
public static final AsfExtendedStreamPropertyFlags Seekable
```

This flag should be set only if the stream is seekable.

##### NoCleanpoints
```
public static final AsfExtendedStreamPropertyFlags NoCleanpoints
```

The stream does not contain any cleanpoints.

##### ResendLiveCleanpoints
```
public static final AsfExtendedStreamPropertyFlags ResendLiveCleanpoints
```

A stream is joined in mid-transmission, all information from the most recent cleanpoint up to the current time should be sent before normal streaming begins at the current time.

##### getByRawValue(int rawValue)
```
public static AsfExtendedStreamPropertyFlags getByRawValue(int rawValue)
```

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

**Returns:**
AsfExtendedStreamPropertyFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### AsfFilePropertyFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asffilepropertyflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfFilePropertyFlags implements IEnumValue
```

Defines ASF file property flags.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined flag. |
| Broadcast | Specifies, that a file is in the process of being created, and thus that various values stored in the header objects are invalid. |
| Seekable | Specifies, that a file is seekable. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Undefined
```
public static final AsfFilePropertyFlags Undefined
```

The undefined flag.

##### Broadcast
```
public static final AsfFilePropertyFlags Broadcast
```

Specifies, that a file is in the process of being created, and thus that various values stored in the header objects are invalid.

##### Seekable
```
public static final AsfFilePropertyFlags Seekable
```

Specifies, that a file is seekable.

##### getByRawValue(int rawValue)
```
public static AsfFilePropertyFlags getByRawValue(int rawValue)
```

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

**Returns:**
AsfFilePropertyFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### AsfMetadataDescriptor
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfmetadatadescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.AsfBaseDescriptor
```
public final class AsfMetadataDescriptor extends AsfBaseDescriptor
```

Represents an ASF metadata descriptor.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getLanguage() | Gets the language. |
| getStreamNumber() | Gets the stream number. |
| getOriginalName() | Gets the original name of the descriptor. |
##### getLanguage()
```
public final String getLanguage()
```

Gets the language.

**Returns:**
java.lang.String - The language.
##### getStreamNumber()
```
public final int getStreamNumber()
```

Gets the stream number.

**Returns:**
int - The stream number.
##### getOriginalName()
```
public final String getOriginalName()
```

Gets the original name of the descriptor.

**Returns:**
java.lang.String - The original name of the descriptor.

### AsfMetadataDescriptorCollection
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfmetadatadescriptorcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfMetadataDescriptorCollection extends CustomPackage
```

Represents a collection of metadata descriptors.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files

### AsfPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfPackage extends CustomPackage
```

Represents native metadata of the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getFileID() | Gets the unique identifier for this file. |
| getCreationDate() | Gets the date and time of the initial creation of the file. |
| getFlags() | Gets the header flags. |
| getStreamProperties() | Gets the digital media stream properties. |
| getMetadataDescriptors() | Gets the metadata descriptors. |
| getCodecInformation() | Gets the codec info entries. |
##### getFileID()
```
public final UUID getFileID()
```

Gets the unique identifier for this file.

**Returns:**
java.util.UUID - The unique identifier for this file.
##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the date and time of the initial creation of the file.

**Returns:**
java.util.Date - The date and time of the initial creation of the file.
##### getFlags()
```
public final AsfFilePropertyFlags getFlags()
```

Gets the header flags.

**Returns:**
AsfFilePropertyFlags - The header flags.
##### getStreamProperties()
```
public final AsfBaseStreamProperty[] getStreamProperties()
```

Gets the digital media stream properties.

**Returns:**
com.groupdocs.metadata.core.AsfBaseStreamProperty[] - The digital media stream properties.
##### getMetadataDescriptors()
```
public final AsfBaseDescriptor[] getMetadataDescriptors()
```

Gets the metadata descriptors.

**Returns:**
com.groupdocs.metadata.core.AsfBaseDescriptor[] - The metadata descriptors.
##### getCodecInformation()
```
public final AsfCodec[] getCodecInformation()
```

Gets the codec info entries.

**Returns:**
com.groupdocs.metadata.core.AsfCodec[] - The codec info entries.

### AsfRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class AsfRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an ASF video.

This code sample demonstrates how to read native ASF metadata.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputAsf)) {
>      AsfRootPackage root = metadata.getRootPackageGeneric();
>      AsfPackage asfPackage = root.getAsfPackage();
>      // Display basic properties
>      System.out.println(String.format("Creation date: %s", asfPackage.getCreationDate()));
>      System.out.println(String.format("File id: %s", asfPackage.getFileID()));
>      System.out.println(String.format("Flags: %s", asfPackage.getFlags()));
>      // Display Asf Codec Information
>      for (AsfCodec codecInfo : asfPackage.getCodecInformation()) {
>          System.out.println(String.format("Codec type: %s", codecInfo.getCodecType()));
>          System.out.println(String.format("Description: %s", codecInfo.getDescription()));
>          System.out.println(String.format("Codec information: %s", codecInfo.getInformation()));
>          System.out.println(codecInfo.getName());
>      }
>      // Display metadata descriptors
>      for (AsfBaseDescriptor descriptor : asfPackage.getMetadataDescriptors()) {
>          System.out.println(String.format("Name: %s", descriptor.getName()));
>          System.out.println(String.format("Value: %s", descriptor.getValue()));
>          System.out.println(String.format("Content type: %s", descriptor.getAsfContentType()));
>          if (descriptor instanceof AsfMetadataDescriptor) {
>              AsfMetadataDescriptor metadataDescriptor = (AsfMetadataDescriptor) descriptor;
>              System.out.println(String.format("Language: %s", metadataDescriptor.getLanguage()));
>              System.out.println(String.format("Stream number: %s", metadataDescriptor.getStreamNumber()));
>              System.out.println(String.format("Original name: %s", metadataDescriptor.getOriginalName()));
>          }
>      }
>      //Display the base stream properties
>      for (AsfBaseStreamProperty property : asfPackage.getStreamProperties()) {
>          System.out.println(String.format("Alternate bitrate: %s", property.getAlternateBitrate()));
>          System.out.println(String.format("Average bitrate: %s", property.getAverageBitrate()));
>          System.out.println(String.format("Average time per frame: %s", property.getAverageTimePerFrame()));
>          System.out.println(String.format("Bitrate: %s", property.getBitrate()));
>          System.out.println(String.format("Stream end time: %s", property.getEndTime()));
>          System.out.println(String.format("Stream flags: %s", property.getFlags()));
>          System.out.println(String.format("Stream language: %s", property.getLanguage()));
>          System.out.println(String.format("Stream start time: %s", property.getStartTime()));
>          System.out.println(String.format("Stream number: %s", property.getStreamNumber()));
>          System.out.println(String.format("Stream type: %s", property.getStreamType()));
>          //Display the audio stream properties
>          if (property instanceof AsfAudioStreamProperty) {
>              AsfAudioStreamProperty audioStreamProperty = (AsfAudioStreamProperty) property;
>              System.out.println(String.format("Audio bits per sample: %s", audioStreamProperty.getBitsPerSample()));
>              System.out.println(String.format("Audio channels: %s", audioStreamProperty.getChannels()));
>              System.out.println(String.format("Audio format tag: %s", audioStreamProperty.getFormatTag()));
>              System.out.println(String.format("Audio samples per second: %s", audioStreamProperty.getSamplesPerSecond()));
>          }
>          //Display the video stream properties
>          if (property instanceof AsfVideoStreamProperty) {
>              AsfVideoStreamProperty videoStreamProperty = (AsfVideoStreamProperty) property;
>              System.out.println(String.format("Video bits per pixels: %s", videoStreamProperty.getBitsPerPixels()));
>              System.out.println(String.format("Compression: %s", videoStreamProperty.getCompression()));
>              System.out.println(String.format("Image height: %s", videoStreamProperty.getImageHeight()));
>              System.out.println(String.format("Image width: %s", videoStreamProperty.getImageWidth()));
>          }
>      }
>  }
>
> ```
> ```

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAsfPackage() | Gets the ASF metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| copyTo(MetadataPackage metadata) |  |
##### getAsfPackage()
```
public final AsfPackage getAsfPackage()
```

Gets the ASF metadata package.

**Returns:**
AsfPackage - The ASF metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### AsfStreamType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfstreamtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum AsfStreamType extends Enum<AsfStreamType> implements IEnumValue
```

Defines ASF stream types.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined stream type. |
| Audio | ASF Audio Media. |
| Video | ASF Video Media. |
| Command | ASF Command Media. |
| Jfif | ASF JFIF Media. |
| DegradableJpeg | ASF Degradable JPEG Media. |
| FileTransfer | ASF File Transfer Media. |
| Binary | ASF Binary Media. |
| WebStreamSubtype | ASF Web Stream Media Subtype. |
| WebStreamFormat | ASF Web Stream Format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final AsfStreamType Undefined
```

Undefined stream type.

##### Audio
```
public static final AsfStreamType Audio
```

ASF Audio Media.

##### Video
```
public static final AsfStreamType Video
```

ASF Video Media.

##### Command
```
public static final AsfStreamType Command
```

ASF Command Media.

##### Jfif
```
public static final AsfStreamType Jfif
```

ASF JFIF Media.

##### DegradableJpeg
```
public static final AsfStreamType DegradableJpeg
```

ASF Degradable JPEG Media.

##### FileTransfer
```
public static final AsfStreamType FileTransfer
```

ASF File Transfer Media.

##### Binary
```
public static final AsfStreamType Binary
```

ASF Binary Media.

##### WebStreamSubtype
```
public static final AsfStreamType WebStreamSubtype
```

ASF Web Stream Media Subtype.

##### WebStreamFormat
```
public static final AsfStreamType WebStreamFormat
```

ASF Web Stream Format.

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

**Returns:**
com.groupdocs.metadata.core.AsfStreamType[]
##### valueOf(String name)
```
public static AsfStreamType valueOf(String name)
```

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

**Returns:**
AsfStreamType
##### getByRawValue(int rawValue)
```
public static AsfStreamType getByRawValue(int rawValue)
```

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

**Returns:**
AsfStreamType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### AsfVideoStreamProperty
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/asfvideostreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.AsfBaseStreamProperty
```
public class AsfVideoStreamProperty extends AsfBaseStreamProperty
```

Represents Video stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the width of the encoded image in pixels. |
| getImageHeight() | Gets the height of the encoded image in pixels. |
| getCompression() | Gets the video compression Id. |
| getBitsPerPixels() | Gets the bits per pixels. |
##### getImageWidth()
```
public final long getImageWidth()
```

Gets the width of the encoded image in pixels.

**Returns:**
long - The width of the encoded image in pixels.
##### getImageHeight()
```
public final long getImageHeight()
```

Gets the height of the encoded image in pixels.

**Returns:**
long - The height of the encoded image in pixels.
##### getCompression()
```
public final long getCompression()
```

Gets the video compression Id.

**Returns:**
long - The video compression Id.
##### getBitsPerPixels()
```
public final long getBitsPerPixels()
```

Gets the bits per pixels.

**Returns:**
long - The bits per pixels.

### AviHeader
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/aviheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class AviHeader extends CustomPackage
```

Represents the AVIMAINHEADER structure in an AVI video.

[Working with metadata in AVI files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+AVI+files
#### Constructors

| Constructor | Description |
| --- | --- |
| AviHeader() | Initializes a new instance of the  AviHeader  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMicroSecPerFrame() | Gets the the number of microseconds between frames. |
| getMaxBytesPerSec() |  |
| getPaddingGranularity() | Gets the alignment for data, in bytes. |
| getAviHeaderFlags() | Gets a bitwise combination of zero or more of the AVI flags. |
| getTotalFrames() | Gets the the total number of frames of data in the file. |
| getInitialFrames() |  |
| getStreams() | Gets the number of streams in the file. |
| getSuggestedBufferSize() |  |
| getWidth() | Gets the width of the AVI file in pixels. |
| getHeight() | Gets the height of the AVI file in pixels. |
##### AviHeader()
```
public AviHeader()
```

Initializes a new instance of the  AviHeader  class.

##### getMicroSecPerFrame()
```
public final int getMicroSecPerFrame()
```

Gets the the number of microseconds between frames. This value indicates the overall timing for the file.

**Returns:**
int - The number of microseconds between frames.
##### getMaxBytesPerSec()
```
public final int getMaxBytesPerSec()
```

Gets the approximate maximum data rate of the file.

 This value indicates the number of bytes per second the system must handle to present an AVI sequence as specified by the other parameters contained in the main header and stream header chunks.

**Returns:**
int - The the approximate maximum data rate of the file.
##### getPaddingGranularity()
```
public final int getPaddingGranularity()
```

Gets the alignment for data, in bytes. Pad the data to multiples of this value.

**Returns:**
int - The the alignment for data.
##### getAviHeaderFlags()
```
public final AviHeaderFlags getAviHeaderFlags()
```

Gets a bitwise combination of zero or more of the AVI flags.

**Returns:**
AviHeaderFlags - The AVI flags.
##### getTotalFrames()
```
public final int getTotalFrames()
```

Gets the the total number of frames of data in the file.

**Returns:**
int - The total number of frames.
##### getInitialFrames()
```
public final int getInitialFrames()
```

Gets the initial frame for interleaved files.

 Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames in the file prior to the initial frame of the AVI sequence in this member.

**Returns:**
int - The initial frames.
##### getStreams()
```
public final int getStreams()
```

Gets the number of streams in the file. For example, a file with audio and video has two streams.

**Returns:**
int - The number of streams.
##### getSuggestedBufferSize()
```
public final int getSuggestedBufferSize()
```

Gets the suggested buffer size for reading the file.

 Generally, this size should be large enough to contain the largest chunk in the file. If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file, the buffer size should be large enough to read an entire record, and not just a chunk.

**Returns:**
int - The suggested buffer size for reading the file.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the AVI file in pixels.

**Returns:**
int - The width in pixels.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the AVI file in pixels.

**Returns:**
int - The height in pixels.

### AviHeaderFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/aviheaderflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AviHeaderFlags implements IEnumValue
```

Represents AVI Header flags.
#### Fields

| Field | Description |
| --- | --- |
| HasIndex | Indicates the AVI file has an index. |
| MustUseIndex | Indicates that application should use the index, rather than the physical ordering of the chunks in the file, to determine the order of presentation of the data. |
| IsInterleaved | Indicates the AVI file is interleaved. |
| TrustCkType | Use CKType to find key frames. |
| WasCaptureFile | Indicates the AVI file is a specially allocated file used for capturing real-time video. |
| Copyrighted | Indicates the AVI file contains copyrighted data and software. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### HasIndex
```
public static final AviHeaderFlags HasIndex
```

Indicates the AVI file has an index.

##### MustUseIndex
```
public static final AviHeaderFlags MustUseIndex
```

Indicates that application should use the index, rather than the physical ordering of the chunks in the file, to determine the order of presentation of the data. For example, this flag could be used to create a list of frames for editing.

##### IsInterleaved
```
public static final AviHeaderFlags IsInterleaved
```

Indicates the AVI file is interleaved.

##### TrustCkType
```
public static final AviHeaderFlags TrustCkType
```

Use CKType to find key frames.

##### WasCaptureFile
```
public static final AviHeaderFlags WasCaptureFile
```

Indicates the AVI file is a specially allocated file used for capturing real-time video. Applications should warn the user before writing over a file with this flag set because the user probably defragmented this file.

##### Copyrighted
```
public static final AviHeaderFlags Copyrighted
```

Indicates the AVI file contains copyrighted data and software. When this flag is used, software should not permit the data to be duplicated.

##### getByRawValue(int rawValue)
```
public static AviHeaderFlags getByRawValue(int rawValue)
```

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

**Returns:**
AviHeaderFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### AviRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/avirootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class AviRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an AVI video.

This code snippet shows how to read AVI header properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputAvi)) {
>      AviRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getHeader().getAviHeaderFlags());
>      System.out.println(root.getHeader().getHeight());
>      System.out.println(root.getHeader().getWidth());
>      System.out.println(root.getHeader().getTotalFrames());
>      System.out.println(root.getHeader().getInitialFrames());
>      System.out.println(root.getHeader().getMaxBytesPerSec());
>      System.out.println(root.getHeader().getPaddingGranularity());
>      System.out.println(root.getHeader().getStreams());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in AVI files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+AVI+files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getHeader() | Gets the AVI header package. |
| getRiffInfoPackage() | Gets the package containing RIFF Info tags. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getHeader()
```
public final AviHeader getHeader()
```

Gets the AVI header package.

**Returns:**
AviHeader - The AVI header package.
##### getRiffInfoPackage()
```
public final RiffInfoPackage getRiffInfoPackage()
```

Gets the package containing RIFF Info tags.

**Returns:**
RiffInfoPackage - The package containing RIFF Info tags.

### BmpHeaderPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/bmpheaderpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class BmpHeaderPackage extends CustomPackage
```

Represents BMP header info.

[Working with BMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+BMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getHeaderSize() | Gets the size of the header in bytes. |
| getBitsPerPixel() | Gets the bits per pixel value. |
| getImageSize() | Gets the bitmap raw data size in bytes. |
| getPlanes() | Gets the number of planes. |
| getColorsImportant() | Gets the number of important palette colors. |
##### getHeaderSize()
```
public final long getHeaderSize()
```

Gets the size of the header in bytes.

**Returns:**
long - The size of the header in bytes.
##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets the bits per pixel value.

**Returns:**
int - The bits per pixel value.
##### getImageSize()
```
public final long getImageSize()
```

Gets the bitmap raw data size in bytes.

**Returns:**
long - The bitmap raw data size in bytes.
##### getPlanes()
```
public final int getPlanes()
```

Gets the number of planes.

**Returns:**
int - The number of planes.
##### getColorsImportant()
```
public final long getColorsImportant()
```

Gets the number of important palette colors.

**Returns:**
long - The number of important palette colors.

### BmpRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/bmprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class BmpRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a BMP image.

This code sample shows how to read the header of a BMP file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputBmp)) {
>      BmpRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getBmpHeader().getBitsPerPixel());
>      System.out.println(root.getBmpHeader().getColorsImportant());
>      System.out.println(root.getBmpHeader().getHeaderSize());
>      System.out.println(root.getBmpHeader().getImageSize());
>      System.out.println(root.getBmpHeader().getPlanes());
>  }
>
> ```
> ```

[Working with BMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+BMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getBmpHeader() | Gets the BMP header metadata package. |
##### getBmpHeader()
```
public final BmpHeaderPackage getBmpHeader()
```

Gets the BMP header metadata package.

**Returns:**
BmpHeaderPackage - The BMP header metadata package.

### ByteOrder
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/byteorder.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ByteOrder extends Enum<ByteOrder> implements IEnumValue
```

Defines various byte orders.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The byte order is unknown. |
| BigEndian | Big endian. |
| LittleEndian | Little endian. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final ByteOrder Unknown
```

The byte order is unknown.

##### BigEndian
```
public static final ByteOrder BigEndian
```

Big endian.

##### LittleEndian
```
public static final ByteOrder LittleEndian
```

Little endian.

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

**Returns:**
com.groupdocs.metadata.core.ByteOrder[]
##### valueOf(String name)
```
public static ByteOrder valueOf(String name)
```

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

**Returns:**
ByteOrder
##### getByRawValue(int rawValue)
```
public static ByteOrder getByRawValue(int rawValue)
```

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

**Returns:**
ByteOrder
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### CadAcadVersion
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cadacadversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum CadAcadVersion extends Enum<CadAcadVersion> implements IEnumValue
```

Defines AutoCAD drawing database version numbers.
#### Fields

| Field | Description |
| --- | --- |
| None | Non-versioned. |
| Ac1006 | AutoCAD drawing database R10. |
| Ac1009 | AutoCAD drawing database R11 and R12. |
| Ac1012 | AutoCAD drawing database R13. |
| Ac1014 | AutoCAD drawing database R14. |
| Ac1015 | AutoCAD drawing database AutoCAD 2000. |
| Ac1018 | AutoCAD drawing database AutoCAD 2004. |
| Ac1021 | AutoCAD drawing database AutoCAD 2007. |
| Ac1024 | AutoCAD drawing database AutoCAD 2010. |
| Ac1027 | AutoCAD drawing database AutoCAD 2013. |
| Ac1032 | AutoCAD drawing database AutoCAD 2018. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final CadAcadVersion None
```

Non-versioned.

##### Ac1006
```
public static final CadAcadVersion Ac1006
```

AutoCAD drawing database R10.

##### Ac1009
```
public static final CadAcadVersion Ac1009
```

AutoCAD drawing database R11 and R12.

##### Ac1012
```
public static final CadAcadVersion Ac1012
```

AutoCAD drawing database R13.

##### Ac1014
```
public static final CadAcadVersion Ac1014
```

AutoCAD drawing database R14.

##### Ac1015
```
public static final CadAcadVersion Ac1015
```

AutoCAD drawing database AutoCAD 2000.

##### Ac1018
```
public static final CadAcadVersion Ac1018
```

AutoCAD drawing database AutoCAD 2004.

##### Ac1021
```
public static final CadAcadVersion Ac1021
```

AutoCAD drawing database AutoCAD 2007.

##### Ac1024
```
public static final CadAcadVersion Ac1024
```

AutoCAD drawing database AutoCAD 2010.

##### Ac1027
```
public static final CadAcadVersion Ac1027
```

AutoCAD drawing database AutoCAD 2013.

##### Ac1032
```
public static final CadAcadVersion Ac1032
```

AutoCAD drawing database AutoCAD 2018.

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

**Returns:**
com.groupdocs.metadata.core.CadAcadVersion[]
##### valueOf(String name)
```
public static CadAcadVersion valueOf(String name)
```

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

**Returns:**
CadAcadVersion
##### getByRawValue(int rawValue)
```
public static CadAcadVersion getByRawValue(int rawValue)
```

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

**Returns:**
CadAcadVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### CadCustomPropertyPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cadcustompropertypackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CadCustomPropertyPackage extends CustomPackage
```

Represents a collection of custom CAD metadata properties.

### CadPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cadpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CadPackage extends CustomPackage
```

Represents CAD (Computer-aided design) metadata.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAcadVersion() | Gets the AutoCAD drawing database version number. |
| getHeight() | Gets the drawing height. |
| getWidth() | Gets the drawing width. |
| getAuthor() | Gets the drawing author. |
| getComments() | Gets the user comments. |
| getHyperlinkBase() | Gets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| getLastSavedBy() | Gets the name of the last editor. |
| getRevisionNumber() | Gets the revision number. |
| getSubject() | Gets the subject. |
| getTitle() | Gets the title. |
| getCreatedDateTime() | Gets the date and time when the drawing was created. |
| getModifiedDateTime() | Gets the date and time when the drawing was modified. |
| getCustomProperties() | Gets the package containing custom metadata properties. |
##### getAcadVersion()
```
public final CadAcadVersion getAcadVersion()
```

Gets the AutoCAD drawing database version number.

**Returns:**
CadAcadVersion - The AutoCAD drawing database version number.
##### getHeight()
```
public final int getHeight()
```

Gets the drawing height.

**Returns:**
int - The drawing height.
##### getWidth()
```
public final int getWidth()
```

Gets the drawing width.

**Returns:**
int - The drawing width.
##### getAuthor()
```
public final String getAuthor()
```

Gets the drawing author.

**Returns:**
java.lang.String - The drawing author.
##### getComments()
```
public final String getComments()
```

Gets the user comments.

**Returns:**
java.lang.String - The user comments.
##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last editor.

**Returns:**
java.lang.String - The name of the last editor.
##### getRevisionNumber()
```
public final String getRevisionNumber()
```

Gets the revision number.

**Returns:**
java.lang.String - The revision number.
##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### getCreatedDateTime()
```
public final Date getCreatedDateTime()
```

Gets the date and time when the drawing was created.

**Returns:**
java.util.Date - The date and time when the drawing was created.
##### getModifiedDateTime()
```
public final Date getModifiedDateTime()
```

Gets the date and time when the drawing was modified.

**Returns:**
java.util.Date - The date and time when the drawing was modified.
##### getCustomProperties()
```
public final CadCustomPropertyPackage getCustomProperties()
```

Gets the package containing custom metadata properties.

**Returns:**
CadCustomPropertyPackage - The package containing custom metadata properties.

### CadRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cadrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class CadRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a CAD drawing.

This code sample shows how to read metadata of a CAD drawing.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDxf)) {
>      CadRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getCadPackage().getAcadVersion());
>      System.out.println(root.getCadPackage().getAuthor());
>      System.out.println(root.getCadPackage().getComments());
>      System.out.println(root.getCadPackage().getCreatedDateTime());
>      System.out.println(root.getCadPackage().getHyperlinkBase());
>      System.out.println(root.getCadPackage().getKeywords());
>      System.out.println(root.getCadPackage().getLastSavedBy());
>      System.out.println(root.getCadPackage().getTitle());
>      // ...
>  }
>
> ```
> ```

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCadPackage() | Gets the CAD metadata package. |
##### getCadPackage()
```
public final CadPackage getCadPackage()
```

Gets the CAD metadata package.

**Returns:**
CadPackage - The CAD metadata package.

### CanonCameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/canoncamerasettingspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CanonCameraSettingsPackage extends CustomPackage
```

Represents CANON camera settings.
#### Methods

| Method | Description |
| --- | --- |
| getMacroMode() | Gets the macro mode. |
| getSelfTimer() | Gets the self timer. |
| getQuality() | Gets the quality. |
| getCanonFlashMode() | Gets the canon flash mode. |
| getContinuousDrive() | Gets the continuous drive. |
| getFocusMode() | Gets the focus mode. |
| getRecordMode() | Gets the record mode. |
| getCanonImageSize() | Gets the size of the canon image. |
| getEasyMode() | Gets the easy mode. |
| getDigitalZoom() | Gets the digital zoom. |
| getContrast() | Gets the contrast. |
| getSaturation() | Gets the saturation. |
| getSharpness() | Gets the sharpness. |
| getCameraIso() | Gets the camera iso. |
| getMeteringMode() | Gets the metering mode. |
| getFocusRange() | Gets the focus range. |
| getAFPoint() | Gets the AFPoint. |
| getCanonExposureMode() | Gets the canon exposure mode. |
| getLensType() | Gets the type of the lens. |
| getMaxFocalLength() | Gets the maximum length of the focal. |
| getMinFocalLength() | Gets the minimum length of the focal. |
| getImageStabilization() | Gets the image stabilization. |
##### getMacroMode()
```
public final short getMacroMode()
```

Gets the macro mode.

**Returns:**
short - The macro mode.
##### getSelfTimer()
```
public final short getSelfTimer()
```

Gets the self timer.

**Returns:**
short - The self timer.
##### getQuality()
```
public final short getQuality()
```

Gets the quality.

**Returns:**
short - The quality.
##### getCanonFlashMode()
```
public final short getCanonFlashMode()
```

Gets the canon flash mode.

**Returns:**
short - The canon flash mode.
##### getContinuousDrive()
```
public final short getContinuousDrive()
```

Gets the continuous drive.

**Returns:**
short - The continuous drive.
##### getFocusMode()
```
public final short getFocusMode()
```

Gets the focus mode.

**Returns:**
short - The focus mode.
##### getRecordMode()
```
public final short getRecordMode()
```

Gets the record mode.

**Returns:**
short - The record mode.
##### getCanonImageSize()
```
public final short getCanonImageSize()
```

Gets the size of the canon image.

**Returns:**
short - The size of the canon image.
##### getEasyMode()
```
public final short getEasyMode()
```

Gets the easy mode.

**Returns:**
short - The easy mode.
##### getDigitalZoom()
```
public final short getDigitalZoom()
```

Gets the digital zoom.

**Returns:**
short - The digital zoom.
##### getContrast()
```
public final short getContrast()
```

Gets the contrast.

**Returns:**
short - The contrast.
##### getSaturation()
```
public final short getSaturation()
```

Gets the saturation.

**Returns:**
short - The saturation.
##### getSharpness()
```
public final short getSharpness()
```

Gets the sharpness.

**Returns:**
short - The sharpness.
##### getCameraIso()
```
public final short getCameraIso()
```

Gets the camera iso.

**Returns:**
short - The camera iso.
##### getMeteringMode()
```
public final short getMeteringMode()
```

Gets the metering mode.

**Returns:**
short - The metering mode.
##### getFocusRange()
```
public final short getFocusRange()
```

Gets the focus range.

**Returns:**
short - The focus range.
##### getAFPoint()
```
public final short getAFPoint()
```

Gets the AFPoint.

**Returns:**
short - The AFPoint.
##### getCanonExposureMode()
```
public final short getCanonExposureMode()
```

Gets the canon exposure mode.

**Returns:**
short - The canon exposure mode.
##### getLensType()
```
public final int getLensType()
```

Gets the type of the lens.

**Returns:**
int - The type of the lens.
##### getMaxFocalLength()
```
public final int getMaxFocalLength()
```

Gets the maximum length of the focal.

**Returns:**
int - The maximum length of the focal.
##### getMinFocalLength()
```
public final int getMinFocalLength()
```

Gets the minimum length of the focal.

**Returns:**
int - The minimum length of the focal.
##### getImageStabilization()
```
public final short getImageStabilization()
```

Gets the image stabilization.

**Returns:**
short - The image stabilization.

### CanonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/canonmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class CanonMakerNotePackage extends MakerNotePackage
```

Represents CANON MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getCameraSettings() | Gets the camera settings. |
| getCanonImageType() | Gets the Canon image type. |
| getCanonFirmwareVersion() | Gets the canon firmware version. |
| getFileNumber() | Gets the file number. |
| getOwnerName() | Gets the name of the owner. |
| getSerialNumber() | Gets the serial number. |
| getCanonFileLength() | Gets the length of the canon file. |
| getCanonModelID() | Gets the canon model identifier. |
##### getCameraSettings()
```
public final CanonCameraSettingsPackage getCameraSettings()
```

Gets the camera settings.

**Returns:**
CanonCameraSettingsPackage - The camera settings.
##### getCanonImageType()
```
public final String getCanonImageType()
```

Gets the Canon image type.

**Returns:**
java.lang.String - The Canon type of the image.
##### getCanonFirmwareVersion()
```
public final String getCanonFirmwareVersion()
```

Gets the canon firmware version.

**Returns:**
java.lang.String - The canon firmware version.
##### getFileNumber()
```
public final Long getFileNumber()
```

Gets the file number.

**Returns:**
java.lang.Long - The file number.
##### getOwnerName()
```
public final String getOwnerName()
```

Gets the name of the owner.

**Returns:**
java.lang.String - The name of the owner.
##### getSerialNumber()
```
public final Long getSerialNumber()
```

Gets the serial number.

**Returns:**
java.lang.Long - The serial number.
##### getCanonFileLength()
```
public final Long getCanonFileLength()
```

Gets the length of the canon file.

**Returns:**
java.lang.Long - The length of the canon file.
##### getCanonModelID()
```
public final Long getCanonModelID()
```

Gets the canon model identifier.

**Returns:**
java.lang.Long - The canon model identifier.

### Cms
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cms.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DigitalSignature
```
public class Cms extends DigitalSignature
```

Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. CMS is based on the syntax of PKCS \#7, specified in RFC 5652. Please see  https://tools.ietf.org/html/rfc5652  for more information.
#### Methods

| Method | Description |
| --- | --- |
| getDigestAlgorithms() | Gets the array of message-digest algorithm identifiers. |
| getEncapsulatedContent() | Gets the signed content, consisting of a content type identifier and the content itself. |
| getCertificates() | Gets the collection of certificates. |
| getSigners() | Gets the collection of per-signer information packages. |
| getSignTime() | Gets the time at which the signer (purportedly) performed the signing process. |
##### getDigestAlgorithms()
```
public final Oid[] getDigestAlgorithms()
```

Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero.

**Returns:**
com.groupdocs.metadata.core.Oid[] - The array of message-digest algorithm identifiers.
##### getEncapsulatedContent()
```
public final CmsEncapsulatedContent getEncapsulatedContent()
```

Gets the signed content, consisting of a content type identifier and the content itself.

**Returns:**
CmsEncapsulatedContent - The signed content, consisting of a content type identifier and the content itself.
##### getCertificates()
```
public final CmsCertificate[] getCertificates()
```

Gets the collection of certificates.

**Returns:**
com.groupdocs.metadata.core.CmsCertificate[] - The collection of certificates.

It is intended that the set of certificates be sufficient to contain certification paths from a recognized "root" or "top-level certification authority" to all of the signers in the SignerInfo field.
##### getSigners()
```
public final CmsSigner[] getSigners()
```

Gets the collection of per-signer information packages.

**Returns:**
com.groupdocs.metadata.core.CmsSigner[] - The collection of per-signer information packages.

There may be any number of elements in the collection, including zero.
##### getSignTime()
```
public Date getSignTime()
```

Gets the time at which the signer (purportedly) performed the signing process.

**Returns:**
java.util.Date - The time at which the signer (purportedly) performed the signing process.

### CmsAttribute
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cmsattribute.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsAttribute extends CustomPackage
```

Represents a CMS signer info attribute.
#### Methods

| Method | Description |
| --- | --- |
| getOid() | Gets the attribute OID. |
| getValue() | Gets the attribute value represented as a string. |
##### getOid()
```
public final Oid getOid()
```

Gets the attribute OID.

**Returns:**
Oid - The attribute OID.
##### getValue()
```
public final String getValue()
```

Gets the attribute value represented as a string.

**Returns:**
java.lang.String - The attribute value represented as a string.

### CmsCertificate
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cmscertificate.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsCertificate extends CustomPackage
```

Represents a CMS certificate.
#### Methods

| Method | Description |
| --- | --- |
| getNotAfter() | Gets the date in local time after which a certificate is no longer valid. |
| getNotBefore() | Gets the date in local time on which a certificate becomes valid. |
| getRawData() | Gets the raw data of this certificate. |
##### getNotAfter()
```
public final Date getNotAfter()
```

Gets the date in local time after which a certificate is no longer valid.

**Returns:**
java.util.Date - The date in local time after which a certificate is no longer valid.
##### getNotBefore()
```
public final Date getNotBefore()
```

Gets the date in local time on which a certificate becomes valid.

**Returns:**
java.util.Date - The date in local time on which a certificate becomes valid.
##### getRawData()
```
public final byte[] getRawData()
```

Gets the raw data of this certificate.

**Returns:**
byte[] - The raw data of this certificate.

### CmsEncapsulatedContent
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cmsencapsulatedcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsEncapsulatedContent extends CustomPackage
```

Represents a signed content container, consisting of a content type identifier and the content itself.
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the object identifier uniquely specifies the content type. |
| getContentRawData() | Gets the raw data of content info. |
##### getContentType()
```
public final Oid getContentType()
```

Gets the object identifier uniquely specifies the content type.

**Returns:**
Oid - The object identifier uniquely specifies the content type.
##### getContentRawData()
```
public final byte[] getContentRawData()
```

Gets the raw data of content info.

**Returns:**
byte[] - The raw data of content info.

### CmsPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cmspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CmsPackage extends CustomPackage
```

Represents a CMS digital signature metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getSignatures() | Gets an array of the signatures extracted from the file. |
| getFlags() | Gets the digital signature flags. |
##### getSignatures()
```
public final Cms[] getSignatures()
```

Gets an array of the signatures extracted from the file.

**Returns:**
com.groupdocs.metadata.core.Cms[] - An array of the signatures extracted from the file.
##### getFlags()
```
public final Integer getFlags()
```

Gets the digital signature flags.

**Returns:**
java.lang.Integer - The digital signature flags.

### CmsSigner
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cmssigner.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsSigner extends CustomPackage
```

Represents CMS per-signer information.
#### Methods

| Method | Description |
| --- | --- |
| getSignerIdentifier() | Gets the signer's certificate (and thereby the signer's public key) raw data. |
| getDigestAlgorithm() | Gets the message digest algorithm, and any associated parameters, used by the signer. |
| getSignedAttributes() | Gets the collection of attributes that are signed. |
| getSignatureAlgorithm() | Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature. |
| getSignatureValue() | Gets the result of digital signature generation, using the message digest and the signer's private key. |
| getUnsignedAttributes() | Gets the collection of attributes that are not signed. |
| getSigningTime() | Gets the time at which the signer (purportedly) performed the signing process. |
##### getSignerIdentifier()
```
public final byte[] getSignerIdentifier()
```

Gets the signer's certificate (and thereby the signer's public key) raw data.

**Returns:**
byte[] - The signer's certificate (and thereby the signer's public key) raw data.
##### getDigestAlgorithm()
```
public final Oid getDigestAlgorithm()
```

Gets the message digest algorithm, and any associated parameters, used by the signer.

**Returns:**
Oid - The message digest algorithm, and any associated parameters, used by the signer.
##### getSignedAttributes()
```
public final CmsAttribute[] getSignedAttributes()
```

Gets the collection of attributes that are signed.

**Returns:**
com.groupdocs.metadata.core.CmsAttribute[] - The collection of attributes that are signed.
##### getSignatureAlgorithm()
```
public final Oid getSignatureAlgorithm()
```

Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature.

**Returns:**
Oid - The signature algorithm, and any associated parameters, used by the signer to generate the digital signature.
##### getSignatureValue()
```
public final String getSignatureValue()
```

Gets the result of digital signature generation, using the message digest and the signer's private key.

**Returns:**
java.lang.String - The result of digital signature generation, using the message digest and the signer's private key.
##### getUnsignedAttributes()
```
public final CmsAttribute[] getUnsignedAttributes()
```

Gets the collection of attributes that are not signed.

**Returns:**
com.groupdocs.metadata.core.CmsAttribute[] - The collection of attributes that are not signed.
##### getSigningTime()
```
public final Date getSigningTime()
```

Gets the time at which the signer (purportedly) performed the signing process.

**Returns:**
java.util.Date - The time at which the signer (purportedly) performed the signing process.

### Cr2AFConfigPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2afconfigpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFConfigPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFConfigPackage() | Initializes a new instance of the  Cr2AFConfigPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFConfigTool() | Gets the AFConfigTool. |
| getAFTrackingSensitivity() | Gets the AFTrackingSensitivity. |
| getAFAccelDecelTracking() | Gets the AFAccelDecelTracking. |
| getAFPointSwitching() | Gets the AFPointSwitching. |
| getAIServoFirstImage() | Gets the AIServoFirstImage. |
| getAIServoSecondImage() | Gets the AIServoSecondImage. |
| getUSMLensElectronicMF() | Gets the USMLensElectronicMF. |
| getAFAssistBeam() | Gets the AFAssistBeam. |
| getOneShotAFRelease() | Gets the OneShotAFRelease. |
| getAutoAFPointSelEOSiTRAF() | Gets the AutoAFPointSelEOSiTRAF. |
| getLensDriveWhenAFImpossible() | Gets the LensDriveWhenAFImpossible. |
| getSelectAFAreaSelectionMode() | Gets the SelectAFAreaSelectionMode. |
| getAFAreaSelectionMethod() | Gets the AFAreaSelectionMethod. |
| getOrientationLinkedAF() | Gets the OrientationLinkedAF. |
| getManualAFPointSelPattern() | Gets the ManualAFPointSelPattern. |
| getAFPointDisplayDuringFocus() | Gets the AFPointDisplayDuringFocus. |
| getVFDisplayIllumination() | Gets the VFDisplayIllumination. |
| getAFStatusViewfinder() | Gets the AFStatusViewfinder. |
| getInitialAFPointInServo() | Gets the InitialAFPointInServo. |
##### Cr2AFConfigPackage()
```
public Cr2AFConfigPackage()
```

Initializes a new instance of the  Cr2AFConfigPackage  class.

##### getAFConfigTool()
```
public final int getAFConfigTool()
```

Gets the AFConfigTool.

**Returns:**
int - The AFConfigTool.
##### getAFTrackingSensitivity()
```
public final int getAFTrackingSensitivity()
```

Gets the AFTrackingSensitivity.

**Returns:**
int - The AFTrackingSensitivity.
##### getAFAccelDecelTracking()
```
public final int getAFAccelDecelTracking()
```

Gets the AFAccelDecelTracking.

**Returns:**
int - The AFAccelDecelTracking.
##### getAFPointSwitching()
```
public final int getAFPointSwitching()
```

Gets the AFPointSwitching.

**Returns:**
int - The AFPointSwitching.
##### getAIServoFirstImage()
```
public final int getAIServoFirstImage()
```

Gets the AIServoFirstImage.

**Returns:**
int - The AIServoFirstImage.
##### getAIServoSecondImage()
```
public final int getAIServoSecondImage()
```

Gets the AIServoSecondImage.

**Returns:**
int - The AIServoSecondImage.
##### getUSMLensElectronicMF()
```
public final int getUSMLensElectronicMF()
```

Gets the USMLensElectronicMF.

**Returns:**
int - The USMLensElectronicMF.
##### getAFAssistBeam()
```
public final int getAFAssistBeam()
```

Gets the AFAssistBeam.

**Returns:**
int - The AFAssistBeam.
##### getOneShotAFRelease()
```
public final int getOneShotAFRelease()
```

Gets the OneShotAFRelease.

**Returns:**
int - The OneShotAFRelease.
##### getAutoAFPointSelEOSiTRAF()
```
public final int getAutoAFPointSelEOSiTRAF()
```

Gets the AutoAFPointSelEOSiTRAF.

**Returns:**
int - The AutoAFPointSelEOSiTRAF.
##### getLensDriveWhenAFImpossible()
```
public final int getLensDriveWhenAFImpossible()
```

Gets the LensDriveWhenAFImpossible.

**Returns:**
int - The LensDriveWhenAFImpossible.
##### getSelectAFAreaSelectionMode()
```
public final int getSelectAFAreaSelectionMode()
```

Gets the SelectAFAreaSelectionMode.

**Returns:**
int - The SelectAFAreaSelectionMode.
##### getAFAreaSelectionMethod()
```
public final int getAFAreaSelectionMethod()
```

Gets the AFAreaSelectionMethod.

**Returns:**
int - The AFAreaSelectionMethod.
##### getOrientationLinkedAF()
```
public final int getOrientationLinkedAF()
```

Gets the OrientationLinkedAF.

**Returns:**
int - The OrientationLinkedAF.
##### getManualAFPointSelPattern()
```
public final int getManualAFPointSelPattern()
```

Gets the ManualAFPointSelPattern.

**Returns:**
int - The ManualAFPointSelPattern.
##### getAFPointDisplayDuringFocus()
```
public final int getAFPointDisplayDuringFocus()
```

Gets the AFPointDisplayDuringFocus.

**Returns:**
int - The AFPointDisplayDuringFocus.
##### getVFDisplayIllumination()
```
public final int getVFDisplayIllumination()
```

Gets the VFDisplayIllumination.

**Returns:**
int - The VFDisplayIllumination.
##### getAFStatusViewfinder()
```
public final int getAFStatusViewfinder()
```

Gets the AFStatusViewfinder.

**Returns:**
int - The AFStatusViewfinder.
##### getInitialAFPointInServo()
```
public final int getInitialAFPointInServo()
```

Gets the InitialAFPointInServo.

**Returns:**
int - The InitialAFPointInServo.

### Cr2AFInfo2Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2afinfo2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFInfo2Package extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFInfo2Package() | Initializes a new instance of the  Cr2AFInfo2Package  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFInfoSize() | Gets the AFInfoSize. |
| getAFAreaMode() | Gets the AFAreaMode. |
| getNumAFPoints() | Gets the NumAFPoints. |
| getValidAFPoints() | Gets the ValidAFPoints. |
| getCanonImageWidth() | Gets the CanonImageWidth. |
| getCanonImageHeight() | Gets the CanonImageHeight. |
| getAFImageWidth() | Gets the AFImageWidth. |
| getAFImageHeight() | Gets the AFImageHeight. |
| getAFAreaWidths() | Gets the AFAreaWidths. |
| getAFAreaHeights() | Gets the AFAreaHeights. |
| getAFAreaXPositions() | Gets the AFAreaXPositions. |
| getAFAreaYPositions() | Gets the AFAreaYPositions. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getAFPointsSelected() | Gets the AFPointsSelected. |
| getPrimaryAFPoint() | Gets the PrimaryAFPoint. |
##### Cr2AFInfo2Package()
```
public Cr2AFInfo2Package()
```

Initializes a new instance of the  Cr2AFInfo2Package  class.

##### getAFInfoSize()
```
public final int getAFInfoSize()
```

Gets the AFInfoSize.

**Returns:**
int - The AFInfoSize.
##### getAFAreaMode()
```
public final int getAFAreaMode()
```

Gets the AFAreaMode.

**Returns:**
int - The AFAreaMode.
##### getNumAFPoints()
```
public final int getNumAFPoints()
```

Gets the NumAFPoints.

**Returns:**
int - The NumAFPoints.
##### getValidAFPoints()
```
public final int getValidAFPoints()
```

Gets the ValidAFPoints.

**Returns:**
int - The ValidAFPoints.
##### getCanonImageWidth()
```
public final int getCanonImageWidth()
```

Gets the CanonImageWidth.

**Returns:**
int - The CanonImageWidth.
##### getCanonImageHeight()
```
public final int getCanonImageHeight()
```

Gets the CanonImageHeight.

**Returns:**
int - The CanonImageHeight.
##### getAFImageWidth()
```
public final int getAFImageWidth()
```

Gets the AFImageWidth.

**Returns:**
int - The AFImageWidth.
##### getAFImageHeight()
```
public final int getAFImageHeight()
```

Gets the AFImageHeight.

**Returns:**
int - The AFImageHeight.
##### getAFAreaWidths()
```
public final int getAFAreaWidths()
```

Gets the AFAreaWidths.

**Returns:**
int - The AFAreaWidths.
##### getAFAreaHeights()
```
public final int getAFAreaHeights()
```

Gets the AFAreaHeights.

**Returns:**
int - The AFAreaHeights.
##### getAFAreaXPositions()
```
public final int getAFAreaXPositions()
```

Gets the AFAreaXPositions.

**Returns:**
int - The AFAreaXPositions.
##### getAFAreaYPositions()
```
public final int getAFAreaYPositions()
```

Gets the AFAreaYPositions.

**Returns:**
int - The AFAreaYPositions.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getAFPointsSelected()
```
public final int getAFPointsSelected()
```

Gets the AFPointsSelected.

**Returns:**
int - The AFPointsSelected.
##### getPrimaryAFPoint()
```
public final int getPrimaryAFPoint()
```

Gets the PrimaryAFPoint.

**Returns:**
int - The PrimaryAFPoint.

### Cr2AFInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2afinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFInfoPackage() | Initializes a new instance of the  Cr2AFInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumAFPoints() | Gets the NumAFPoints. |
| getValidAFPoints() | Gets the ValidAFPoints. |
| getCanonImageWidth() | Gets the CanonImageWidth. |
| getCanonImageHeight() | Gets the CanonImageHeight. |
| getAFImageWidth() | Gets the AFImageWidth. |
| getAFImageHeight() | Gets the AFImageHeight. |
| getAFAreaWidth() | Gets the AFAreaWidth. |
| getAFAreaHeight() | Gets the AFAreaHeight. |
| getAFAreaXPositions() | Gets the AFAreaXPositions. |
| getAFAreaYPositions() | Gets the AFAreaYPositions. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getPrimaryAFPointAFInfo() | Gets the PrimaryAFPointAFInfo. |
| getPrimaryAFPoint() | Gets the PrimaryAFPoint. |
##### Cr2AFInfoPackage()
```
public Cr2AFInfoPackage()
```

Initializes a new instance of the  Cr2AFInfoPackage  class.

##### getNumAFPoints()
```
public final int getNumAFPoints()
```

Gets the NumAFPoints.

**Returns:**
int - The NumAFPoints.
##### getValidAFPoints()
```
public final int getValidAFPoints()
```

Gets the ValidAFPoints.

**Returns:**
int - The ValidAFPoints.
##### getCanonImageWidth()
```
public final int getCanonImageWidth()
```

Gets the CanonImageWidth.

**Returns:**
int - The CanonImageWidth.
##### getCanonImageHeight()
```
public final int getCanonImageHeight()
```

Gets the CanonImageHeight.

**Returns:**
int - The CanonImageHeight.
##### getAFImageWidth()
```
public final int getAFImageWidth()
```

Gets the AFImageWidth.

**Returns:**
int - The AFImageWidth.
##### getAFImageHeight()
```
public final int getAFImageHeight()
```

Gets the AFImageHeight.

**Returns:**
int - The AFImageHeight.
##### getAFAreaWidth()
```
public final int getAFAreaWidth()
```

Gets the AFAreaWidth.

**Returns:**
int - The AFAreaWidth.
##### getAFAreaHeight()
```
public final int getAFAreaHeight()
```

Gets the AFAreaHeight.

**Returns:**
int - The AFAreaHeight.
##### getAFAreaXPositions()
```
public final int getAFAreaXPositions()
```

Gets the AFAreaXPositions.

**Returns:**
int - The AFAreaXPositions.
##### getAFAreaYPositions()
```
public final int getAFAreaYPositions()
```

Gets the AFAreaYPositions.

**Returns:**
int - The AFAreaYPositions.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getPrimaryAFPointAFInfo()
```
public final int getPrimaryAFPointAFInfo()
```

Gets the PrimaryAFPointAFInfo.

**Returns:**
int - The PrimaryAFPointAFInfo.
##### getPrimaryAFPoint()
```
public final int getPrimaryAFPoint()
```

Gets the PrimaryAFPoint.

**Returns:**
int - The PrimaryAFPoint.

### Cr2AFMicroAdjPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2afmicroadjpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFMicroAdjPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFMicroAdjPackage() | Initializes a new instance of the  Cr2AFMicroAdjPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFMicroAdjMode() | Gets the AFMicroAdjMode. |
| getAFMicroAdjValue() | Gets the AFMicroAdjValue. |
##### Cr2AFMicroAdjPackage()
```
public Cr2AFMicroAdjPackage()
```

Initializes a new instance of the  Cr2AFMicroAdjPackage  class.

##### getAFMicroAdjMode()
```
public final int getAFMicroAdjMode()
```

Gets the AFMicroAdjMode.

**Returns:**
int - The AFMicroAdjMode.
##### getAFMicroAdjValue()
```
public final float getAFMicroAdjValue()
```

Gets the AFMicroAdjValue.

**Returns:**
float - The AFMicroAdjValue.

### Cr2AspectInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2aspectinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AspectInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AspectInfoPackage() | Initializes a new instance of the  Cr2AspectInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAspectRatio() | Gets the AspectRatio. |
| getCroppedImageWidth() | Gets the CroppedImageWidth. |
| getCroppedImageHeight() | Gets the CroppedImageHeight. |
| getCroppedImageLeft() | Gets the CroppedImageLeft. |
| getCroppedImageTop() | Gets the CroppedImageTop. |
##### Cr2AspectInfoPackage()
```
public Cr2AspectInfoPackage()
```

Initializes a new instance of the  Cr2AspectInfoPackage  class.

##### getAspectRatio()
```
public final int getAspectRatio()
```

Gets the AspectRatio.

**Returns:**
int - The AspectRatio.
##### getCroppedImageWidth()
```
public final int getCroppedImageWidth()
```

Gets the CroppedImageWidth.

**Returns:**
int - The CroppedImageWidth.
##### getCroppedImageHeight()
```
public final int getCroppedImageHeight()
```

Gets the CroppedImageHeight.

**Returns:**
int - The CroppedImageHeight.
##### getCroppedImageLeft()
```
public final int getCroppedImageLeft()
```

Gets the CroppedImageLeft.

**Returns:**
int - The CroppedImageLeft.
##### getCroppedImageTop()
```
public final int getCroppedImageTop()
```

Gets the CroppedImageTop.

**Returns:**
int - The CroppedImageTop.

### Cr2CameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2camerasettingspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2CameraSettingsPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2CameraSettingsPackage() | Initializes a new instance of the  Cr2CameraSettingsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMacroMode() | Gets the MacroMode. |
| getSelfTimer() | Gets the SelfTimer. |
| getQuality() | Gets the Quality. |
| getCanonFlashMode() | Gets the CanonFlashMode. |
| getContinuousDrive() | Gets the ContinuousDrive. |
| getFocusMode() | Gets the FocusMode. |
| getRecordMode() | Gets the RecordMode. |
| getCanonImageSize() | Gets the CanonImageSize. |
| getEasyMode() | Gets the EasyMode. |
| getDigitalZoom() | Gets the DigitalZoom. |
| getContrast() | Gets the Contrast. |
| getSaturation() | Gets the Saturation. |
| getSharpness() | Gets the Sharpness. |
| getCameraIso() | Gets the CameraIso. |
| getMeteringMode() | Gets the MeteringMode. |
| getFocusRange() | Gets the FocusRange. |
| getAFPoint() | Gets the AFPoint. |
| getCanonExposureMode() | Gets the CanonExposureMode. |
| getLensType() | Gets the LensType. |
| getMaxFocalLength() | Gets the MaxFocalLength. |
| getMinFocalLength() | Gets the MinFocalLength. |
| getFocalUnits() | Gets the FocalUnits. |
| getMaxAperture() | Gets the MaxAperture. |
| getMinAperture() | Gets the MinAperture. |
| getFlashActivity() | Gets the FlashActivity. |
| getFlashBits() | Gets the FlashBits. |
| getFocusContinuous() | Gets the FocusContinuous. |
| getAESetting() | Gets the AESetting. |
| getImageStabilization() | Gets the ImageStabilization. |
| getDisplayAperture() | Gets the DisplayAperture. |
| getZoomSourceWidth() | Gets the ZoomSourceWidth. |
| getZoomTargetWidth() | Gets the ZoomTargetWidth. |
| getSpotMeteringMode() | Gets the SpotMeteringMode. |
| getPhotoEffect() | Gets the PhotoEffect. |
| getManualFlashOutput() | Gets the ManualFlashOutput. |
| getColorTone() | Gets the ColorTone. |
| getSRAWQuality() | Gets the SRAWQuality. |
##### Cr2CameraSettingsPackage()
```
public Cr2CameraSettingsPackage()
```

Initializes a new instance of the  Cr2CameraSettingsPackage  class.

##### getMacroMode()
```
public final int getMacroMode()
```

Gets the MacroMode.

**Returns:**
int - The MacroMode.
##### getSelfTimer()
```
public final int getSelfTimer()
```

Gets the SelfTimer.

**Returns:**
int - The SelfTimer.
##### getQuality()
```
public final int getQuality()
```

Gets the Quality.

**Returns:**
int - The Quality.
##### getCanonFlashMode()
```
public final int getCanonFlashMode()
```

Gets the CanonFlashMode.

**Returns:**
int - The CanonFlashMode.
##### getContinuousDrive()
```
public final int getContinuousDrive()
```

Gets the ContinuousDrive.

**Returns:**
int - The ContinuousDrive.
##### getFocusMode()
```
public final int getFocusMode()
```

Gets the FocusMode.

**Returns:**
int - The FocusMode.
##### getRecordMode()
```
public final int getRecordMode()
```

Gets the RecordMode.

**Returns:**
int - The RecordMode.
##### getCanonImageSize()
```
public final int getCanonImageSize()
```

Gets the CanonImageSize.

**Returns:**
int - The CanonImageSize.
##### getEasyMode()
```
public final int getEasyMode()
```

Gets the EasyMode.

**Returns:**
int - The EasyMode.
##### getDigitalZoom()
```
public final int getDigitalZoom()
```

Gets the DigitalZoom.

**Returns:**
int - The DigitalZoom.
##### getContrast()
```
public final int getContrast()
```

Gets the Contrast.

**Returns:**
int - The Contrast.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getCameraIso()
```
public final int getCameraIso()
```

Gets the CameraIso.

**Returns:**
int - The CameraIso.
##### getMeteringMode()
```
public final int getMeteringMode()
```

Gets the MeteringMode.

**Returns:**
int - The MeteringMode.
##### getFocusRange()
```
public final int getFocusRange()
```

Gets the FocusRange.

**Returns:**
int - The FocusRange.
##### getAFPoint()
```
public final int getAFPoint()
```

Gets the AFPoint.

**Returns:**
int - The AFPoint.
##### getCanonExposureMode()
```
public final int getCanonExposureMode()
```

Gets the CanonExposureMode.

**Returns:**
int - The CanonExposureMode.
##### getLensType()
```
public final int getLensType()
```

Gets the LensType.

**Returns:**
int - The LensType.
##### getMaxFocalLength()
```
public final int getMaxFocalLength()
```

Gets the MaxFocalLength.

**Returns:**
int - The MaxFocalLength.
##### getMinFocalLength()
```
public final int getMinFocalLength()
```

Gets the MinFocalLength.

**Returns:**
int - The MinFocalLength.
##### getFocalUnits()
```
public final int getFocalUnits()
```

Gets the FocalUnits.

**Returns:**
int - The FocalUnits.
##### getMaxAperture()
```
public final int getMaxAperture()
```

Gets the MaxAperture.

**Returns:**
int - The MaxAperture.
##### getMinAperture()
```
public final int getMinAperture()
```

Gets the MinAperture.

**Returns:**
int - The MinAperture.
##### getFlashActivity()
```
public final int getFlashActivity()
```

Gets the FlashActivity.

**Returns:**
int - The FlashActivity.
##### getFlashBits()
```
public final int getFlashBits()
```

Gets the FlashBits.

**Returns:**
int - The FlashBits.
##### getFocusContinuous()
```
public final int getFocusContinuous()
```

Gets the FocusContinuous.

**Returns:**
int - The FocusContinuous.
##### getAESetting()
```
public final int getAESetting()
```

Gets the AESetting.

**Returns:**
int - The AESetting.
##### getImageStabilization()
```
public final int getImageStabilization()
```

Gets the ImageStabilization.

**Returns:**
int - The ImageStabilization.
##### getDisplayAperture()
```
public final int getDisplayAperture()
```

Gets the DisplayAperture.

**Returns:**
int - The DisplayAperture.
##### getZoomSourceWidth()
```
public final int getZoomSourceWidth()
```

Gets the ZoomSourceWidth.

**Returns:**
int - The ZoomSourceWidth.
##### getZoomTargetWidth()
```
public final int getZoomTargetWidth()
```

Gets the ZoomTargetWidth.

**Returns:**
int - The ZoomTargetWidth.
##### getSpotMeteringMode()
```
public final int getSpotMeteringMode()
```

Gets the SpotMeteringMode.

**Returns:**
int - The SpotMeteringMode.
##### getPhotoEffect()
```
public final int getPhotoEffect()
```

Gets the PhotoEffect.

**Returns:**
int - The PhotoEffect.
##### getManualFlashOutput()
```
public final int getManualFlashOutput()
```

Gets the ManualFlashOutput.

**Returns:**
int - The ManualFlashOutput.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getSRAWQuality()
```
public final int getSRAWQuality()
```

Gets the SRAWQuality.

**Returns:**
int - The SRAWQuality.

### Cr2ColorBalancePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2colorbalancepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ColorBalancePackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ColorBalancePackage() | Initializes a new instance of the  Cr2ColorBalancePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWB_RGGBLevelsAuto() | Gets the WB\_RGGBLevelsAuto. |
| getWB_RGGBLevelsDaylight() | Gets the WB\_RGGBLevelsDaylight. |
| getWB_RGGBLevelsShade() | Gets the WB\_RGGBLevelsShade. |
| getWB_RGGBLevelsCloudy() | Gets the WB\_RGGBLevelsCloudy. |
| getWB_RGGBLevelsTungsten() | Gets the WB\_RGGBLevelsTungsten. |
| getWB_RGGBLevelsFluorescent() | Gets the WB\_RGGBLevelsFluorescent. |
| getWB_RGGBLevelsFlash() | Gets the WB\_RGGBLevelsFlash. |
| getWB_RGGBLevelsKelvin() | Gets the WB\_RGGBLevelsKelvin. |
| getWB_RGGBBlackLevels() | Gets the WB\_RGGBBlackLevels. |
##### Cr2ColorBalancePackage()
```
public Cr2ColorBalancePackage()
```

Initializes a new instance of the  Cr2ColorBalancePackage  class.

##### getWB_RGGBLevelsAuto()
```
public final int getWB_RGGBLevelsAuto()
```

Gets the WB\_RGGBLevelsAuto.

**Returns:**
int - The WB\_RGGBLevelsAuto.
##### getWB_RGGBLevelsDaylight()
```
public final int getWB_RGGBLevelsDaylight()
```

Gets the WB\_RGGBLevelsDaylight.

**Returns:**
int - The WB\_RGGBLevelsDaylight.
##### getWB_RGGBLevelsShade()
```
public final int getWB_RGGBLevelsShade()
```

Gets the WB\_RGGBLevelsShade.

**Returns:**
int - The WB\_RGGBLevelsShade.
##### getWB_RGGBLevelsCloudy()
```
public final int getWB_RGGBLevelsCloudy()
```

Gets the WB\_RGGBLevelsCloudy.

**Returns:**
int - The WB\_RGGBLevelsCloudy.
##### getWB_RGGBLevelsTungsten()
```
public final int getWB_RGGBLevelsTungsten()
```

Gets the WB\_RGGBLevelsTungsten.

**Returns:**
int - The WB\_RGGBLevelsTungsten.
##### getWB_RGGBLevelsFluorescent()
```
public final int getWB_RGGBLevelsFluorescent()
```

Gets the WB\_RGGBLevelsFluorescent.

**Returns:**
int - The WB\_RGGBLevelsFluorescent.
##### getWB_RGGBLevelsFlash()
```
public final int getWB_RGGBLevelsFlash()
```

Gets the WB\_RGGBLevelsFlash.

**Returns:**
int - The WB\_RGGBLevelsFlash.
##### getWB_RGGBLevelsKelvin()
```
public final int getWB_RGGBLevelsKelvin()
```

Gets the WB\_RGGBLevelsKelvin.

**Returns:**
int - The WB\_RGGBLevelsKelvin.
##### getWB_RGGBBlackLevels()
```
public final int getWB_RGGBBlackLevels()
```

Gets the WB\_RGGBBlackLevels.

**Returns:**
int - The WB\_RGGBBlackLevels.

### Cr2ColorInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2colorinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ColorInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ColorInfoPackage() | Initializes a new instance of the  Cr2ColorInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSaturation() | Gets the Saturation. |
| getColorTone() | Gets the ColorTone. |
| getColorSpace() | Gets the ColorSpace. |
##### Cr2ColorInfoPackage()
```
public Cr2ColorInfoPackage()
```

Initializes a new instance of the  Cr2ColorInfoPackage  class.

##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getColorSpace()
```
public final int getColorSpace()
```

Gets the ColorSpace.

**Returns:**
int - The ColorSpace.

### Cr2CropInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2cropinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2CropInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2CropInfoPackage() | Initializes a new instance of the  Cr2CropInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCropLeftMargin() | Gets the CropLeftMargin. |
| getCropRightMargin() | Gets the CropRightMargin. |
| getCropTopMargin() | Gets the CropTopMargin. |
| getCropBottomMargin() | Gets the CropBottomMargin. |
##### Cr2CropInfoPackage()
```
public Cr2CropInfoPackage()
```

Initializes a new instance of the  Cr2CropInfoPackage  class.

##### getCropLeftMargin()
```
public final int getCropLeftMargin()
```

Gets the CropLeftMargin.

**Returns:**
int - The CropLeftMargin.
##### getCropRightMargin()
```
public final int getCropRightMargin()
```

Gets the CropRightMargin.

**Returns:**
int - The CropRightMargin.
##### getCropTopMargin()
```
public final int getCropTopMargin()
```

Gets the CropTopMargin.

**Returns:**
int - The CropTopMargin.
##### getCropBottomMargin()
```
public final int getCropBottomMargin()
```

Gets the CropBottomMargin.

**Returns:**
int - The CropBottomMargin.

### Cr2FileInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2fileinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2FileInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2FileInfoPackage() | Initializes a new instance of the  Cr2FileInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the Size. |
| setSize(long value) | Sets the Size. |
| getFileNumberOrShutterCount() | Gets the FileNumberOrShutterCount. |
| getBracketMode() | Gets the BracketMode. |
| getBracketValue() | Gets the BracketValue. |
| getBracketShotNumber() | Gets the BracketShotNumber. |
| getRawJpgQuality() | Gets the RawJpgQuality. |
| getRawJpgSize() | Gets the RawJpgSize. |
| getLongExposureNoiseReduction2() | Gets the LongExposureNoiseReduction2. |
| getWBBracketMode() | Gets the WBBracketMode. |
| getWBBracketValueAB() | Gets the WBBracketValueAB. |
| getWBBracketValueGM() | Gets the WBBracketValueGM. |
| getFilterEffect() | Gets the FilterEffect. |
| getToningEffect() | Gets the ToningEffect. |
| getMacroMagnification() | Gets the MacroMagnification. |
| getLiveViewShooting() | Gets the LiveViewShooting. |
| getFocusDistanceUpper() | Gets the FocusDistanceUpper. |
| getFocusDistanceLower() | Gets the FocusDistanceLower. |
| getShutterMode() | Gets the ShutterMode. |
| getFlashExposureLock() | Gets the FlashExposureLock. |
| getRFLensType() | Gets the RFLensType. |
##### Cr2FileInfoPackage()
```
public Cr2FileInfoPackage()
```

Initializes a new instance of the  Cr2FileInfoPackage  class.

##### getSize()
```
public final long getSize()
```

Gets the Size.

**Returns:**
long - The Size.
##### setSize(long value)
```
public final void setSize(long value)
```

Sets the Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The Size. |

##### getFileNumberOrShutterCount()
```
public final int getFileNumberOrShutterCount()
```

Gets the FileNumberOrShutterCount.

**Returns:**
int - The FileNumber.
##### getBracketMode()
```
public final int getBracketMode()
```

Gets the BracketMode.

**Returns:**
int - The BracketMode.
##### getBracketValue()
```
public final int getBracketValue()
```

Gets the BracketValue.

**Returns:**
int - The BracketValue.
##### getBracketShotNumber()
```
public final int getBracketShotNumber()
```

Gets the BracketShotNumber.

**Returns:**
int - The BracketShotNumber.
##### getRawJpgQuality()
```
public final int getRawJpgQuality()
```

Gets the RawJpgQuality.

**Returns:**
int - The RawJpgQuality.
##### getRawJpgSize()
```
public final int getRawJpgSize()
```

Gets the RawJpgSize.

**Returns:**
int - The RawJpgSize.
##### getLongExposureNoiseReduction2()
```
public final int getLongExposureNoiseReduction2()
```

Gets the LongExposureNoiseReduction2.

**Returns:**
int - The LongExposureNoiseReduction2.
##### getWBBracketMode()
```
public final int getWBBracketMode()
```

Gets the WBBracketMode.

**Returns:**
int - The WBBracketMode.
##### getWBBracketValueAB()
```
public final int getWBBracketValueAB()
```

Gets the WBBracketValueAB.

**Returns:**
int - The WBBracketValueAB.
##### getWBBracketValueGM()
```
public final int getWBBracketValueGM()
```

Gets the WBBracketValueGM.

**Returns:**
int - The WBBracketValueGM.
##### getFilterEffect()
```
public final int getFilterEffect()
```

Gets the FilterEffect.

**Returns:**
int - The FilterEffect.
##### getToningEffect()
```
public final int getToningEffect()
```

Gets the ToningEffect.

**Returns:**
int - The ToningEffect.
##### getMacroMagnification()
```
public final int getMacroMagnification()
```

Gets the MacroMagnification.

**Returns:**
int - The MacroMagnification.
##### getLiveViewShooting()
```
public final int getLiveViewShooting()
```

Gets the LiveViewShooting.

**Returns:**
int - The LiveViewShooting.
##### getFocusDistanceUpper()
```
public final int getFocusDistanceUpper()
```

Gets the FocusDistanceUpper.

**Returns:**
int - The FocusDistanceUpper.
##### getFocusDistanceLower()
```
public final int getFocusDistanceLower()
```

Gets the FocusDistanceLower.

**Returns:**
int - The FocusDistanceLower.
##### getShutterMode()
```
public final int getShutterMode()
```

Gets the ShutterMode.

**Returns:**
int - The ShutterMode.
##### getFlashExposureLock()
```
public final int getFlashExposureLock()
```

Gets the FlashExposureLock.

**Returns:**
int - The FlashExposureLock.
##### getRFLensType()
```
public final int getRFLensType()
```

Gets the RFLensType.

**Returns:**
int - The RFLensType.

### Cr2FocalLengthPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2focallengthpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2FocalLengthPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2FocalLengthPackage() | Initializes a new instance of the  Cr2FocalLengthPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFocalType() | Gets the FocalType. |
| getFocalLength() | Gets the FocalLength. |
| getFocalPlaneXSize() | Gets the FocalPlaneXSize. |
| getFocalPlaneYSize() | Gets the FocalPlaneYSize. |
##### Cr2FocalLengthPackage()
```
public Cr2FocalLengthPackage()
```

Initializes a new instance of the  Cr2FocalLengthPackage  class.

##### getFocalType()
```
public final int getFocalType()
```

Gets the FocalType.

**Returns:**
int - The FocalType.
##### getFocalLength()
```
public final int getFocalLength()
```

Gets the FocalLength.

**Returns:**
int - The FocalLength.
##### getFocalPlaneXSize()
```
public final int getFocalPlaneXSize()
```

Gets the FocalPlaneXSize.

**Returns:**
int - The FocalPlaneXSize.
##### getFocalPlaneYSize()
```
public final int getFocalPlaneYSize()
```

Gets the FocalPlaneYSize.

**Returns:**
int - The FocalPlaneYSize.

### Cr2Functions1DPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2functions1dpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2Functions1DPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2Functions1DPackage() | Initializes a new instance of the  Cr2Functions1DPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFocusingScreen() | Gets the FocusingScreen. |
| getFinderDisplayDuringExposure() | Gets the FinderDisplayDuringExposure. |
| getShutterReleaseNoCFCard() | Gets the ShutterReleaseNoCFCard. |
| getISOSpeedExpansion() | Gets the ISOSpeedExpansion. |
| getShutterAELButton() | Gets the ShutterAELButton. |
| getManualTv() | Gets the ManualTv. |
| getExposureLevelIncrements() | Gets the ExposureLevelIncrements. |
| getUSMLensElectronicMF() | Gets the USMLensElectronicMF. |
| getLCDPanels() | Gets the LCDPanels. |
| getAEBSequenceAutoCancel() | Gets the AEBSequenceAutoCancel. |
| getAFPointIllumination() | Gets the AFPointIllumination. |
| getAFPointSelection() | Gets the AFPointSelection. |
| getMirrorLockup() | Gets the MirrorLockup. |
| getAFPointSpotMetering() | Gets the AFPointSpotMetering. |
| getFillFlashAutoReduction() | Gets the FillFlashAutoReduction. |
| getShutterCurtainSync() | Gets the ShutterCurtainSync. |
| getSafetyShiftInAvOrTv() | Gets the SafetyShiftInAvOrTv. |
| getAFPointActivationArea() | Gets the AFPointActivationArea. |
| getSwitchToRegisteredAFPoint() | Gets the SwitchToRegisteredAFPoint. |
| getLensAFStopButton() | Gets the LensAFStopButton. |
| getAIServoTrackingSensitivity() | Gets the AIServoTrackingSensitivity. |
| getAIServoContinuousShooting() | Gets the AIServoContinuousShooting. |
##### Cr2Functions1DPackage()
```
public Cr2Functions1DPackage()
```

Initializes a new instance of the  Cr2Functions1DPackage  class.

##### getFocusingScreen()
```
public final int getFocusingScreen()
```

Gets the FocusingScreen.

**Returns:**
int - The FocusingScreen.
##### getFinderDisplayDuringExposure()
```
public final int getFinderDisplayDuringExposure()
```

Gets the FinderDisplayDuringExposure.

**Returns:**
int - The FinderDisplayDuringExposure.
##### getShutterReleaseNoCFCard()
```
public final int getShutterReleaseNoCFCard()
```

Gets the ShutterReleaseNoCFCard.

**Returns:**
int - The ShutterReleaseNoCFCard.
##### getISOSpeedExpansion()
```
public final int getISOSpeedExpansion()
```

Gets the ISOSpeedExpansion.

**Returns:**
int - The ISOSpeedExpansion.
##### getShutterAELButton()
```
public final int getShutterAELButton()
```

Gets the ShutterAELButton.

**Returns:**
int - The ShutterAELButton.
##### getManualTv()
```
public final int getManualTv()
```

Gets the ManualTv.

**Returns:**
int - The ManualTv.
##### getExposureLevelIncrements()
```
public final int getExposureLevelIncrements()
```

Gets the ExposureLevelIncrements.

**Returns:**
int - The ExposureLevelIncrements.
##### getUSMLensElectronicMF()
```
public final int getUSMLensElectronicMF()
```

Gets the USMLensElectronicMF.

**Returns:**
int - The USMLensElectronicMF.
##### getLCDPanels()
```
public final int getLCDPanels()
```

Gets the LCDPanels.

**Returns:**
int - The LCDPanels.
##### getAEBSequenceAutoCancel()
```
public final int getAEBSequenceAutoCancel()
```

Gets the AEBSequenceAutoCancel.

**Returns:**
int - The AEBSequenceAutoCancel.
##### getAFPointIllumination()
```
public final int getAFPointIllumination()
```

Gets the AFPointIllumination.

**Returns:**
int - The AFPointIllumination.
##### getAFPointSelection()
```
public final int getAFPointSelection()
```

Gets the AFPointSelection.

**Returns:**
int - The AFPointSelection.
##### getMirrorLockup()
```
public final int getMirrorLockup()
```

Gets the MirrorLockup.

**Returns:**
int - The MirrorLockup.
##### getAFPointSpotMetering()
```
public final int getAFPointSpotMetering()
```

Gets the AFPointSpotMetering.

**Returns:**
int - The AFPointSpotMetering.
##### getFillFlashAutoReduction()
```
public final int getFillFlashAutoReduction()
```

Gets the FillFlashAutoReduction.

**Returns:**
int - The FillFlashAutoReduction.
##### getShutterCurtainSync()
```
public final int getShutterCurtainSync()
```

Gets the ShutterCurtainSync.

**Returns:**
int - The ShutterCurtainSync.
##### getSafetyShiftInAvOrTv()
```
public final int getSafetyShiftInAvOrTv()
```

Gets the SafetyShiftInAvOrTv.

**Returns:**
int - The SafetyShiftInAvOrTv.
##### getAFPointActivationArea()
```
public final int getAFPointActivationArea()
```

Gets the AFPointActivationArea.

**Returns:**
int - The AFPointActivationArea.
##### getSwitchToRegisteredAFPoint()
```
public final int getSwitchToRegisteredAFPoint()
```

Gets the SwitchToRegisteredAFPoint.

**Returns:**
int - The SwitchToRegisteredAFPoint.
##### getLensAFStopButton()
```
public final int getLensAFStopButton()
```

Gets the LensAFStopButton.

**Returns:**
int - The LensAFStopButton.
##### getAIServoTrackingSensitivity()
```
public final int getAIServoTrackingSensitivity()
```

Gets the AIServoTrackingSensitivity.

**Returns:**
int - The AIServoTrackingSensitivity.
##### getAIServoContinuousShooting()
```
public final int getAIServoContinuousShooting()
```

Gets the AIServoContinuousShooting.

**Returns:**
int - The AIServoContinuousShooting.

### Cr2LightingOptPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2lightingoptpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2LightingOptPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2LightingOptPackage() | Initializes a new instance of the  Cr2LightingOptPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the Size. |
| setSize(long value) | Sets the Size. |
| getPeripheralIlluminationCorr() | Gets the PeripheralIlluminationCorr. |
| getAutoLightingOptimizer() | Gets the AutoLightingOptimizer. |
| getHighlightTonePriority() | Gets the HighlightTonePriority. |
| getLongExposureNoiseReduction() | Gets the LongExposureNoiseReduction. |
| getHighISONoiseReduction() | Gets the HighISONoiseReduction. |
| getDigitalLensOptimizer() | Gets the DigitalLensOptimizer. |
##### Cr2LightingOptPackage()
```
public Cr2LightingOptPackage()
```

Initializes a new instance of the  Cr2LightingOptPackage  class.

##### getSize()
```
public final long getSize()
```

Gets the Size.

**Returns:**
long - The Size.
##### setSize(long value)
```
public final void setSize(long value)
```

Sets the Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The Size. |

##### getPeripheralIlluminationCorr()
```
public final int getPeripheralIlluminationCorr()
```

Gets the PeripheralIlluminationCorr.

**Returns:**
int - The PeripheralIlluminationCorr.
##### getAutoLightingOptimizer()
```
public final int getAutoLightingOptimizer()
```

Gets the AutoLightingOptimizer.

**Returns:**
int - The AutoLightingOptimizer.
##### getHighlightTonePriority()
```
public final int getHighlightTonePriority()
```

Gets the HighlightTonePriority.

**Returns:**
int - The HighlightTonePriority.
##### getLongExposureNoiseReduction()
```
public final int getLongExposureNoiseReduction()
```

Gets the LongExposureNoiseReduction.

**Returns:**
int - The LongExposureNoiseReduction.
##### getHighISONoiseReduction()
```
public final int getHighISONoiseReduction()
```

Gets the HighISONoiseReduction.

**Returns:**
int - The HighISONoiseReduction.
##### getDigitalLensOptimizer()
```
public final int getDigitalLensOptimizer()
```

Gets the DigitalLensOptimizer.

**Returns:**
int - The DigitalLensOptimizer.

### Cr2LogInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2loginfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2LogInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2LogInfoPackage() | Initializes a new instance of the  Cr2LogInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCompressionFormat() | Gets the CompressionFormat. |
| getSharpness() | Gets the Sharpness. |
| getSaturation() | Gets the Saturation. |
| getColorTone() | Gets the ColorTone. |
| getColorSpace2() | Gets the ColorSpace2. |
| getColorMatrix() | Gets the ColorMatrix. |
| getCanonLogVersion() | Gets the CanonLogVersion. |
##### Cr2LogInfoPackage()
```
public Cr2LogInfoPackage()
```

Initializes a new instance of the  Cr2LogInfoPackage  class.

##### getCompressionFormat()
```
public final int getCompressionFormat()
```

Gets the CompressionFormat.

**Returns:**
int - The CompressionFormat.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getColorSpace2()
```
public final int getColorSpace2()
```

Gets the ColorSpace2.

**Returns:**
int - The ColorSpace2.
##### getColorMatrix()
```
public final int getColorMatrix()
```

Gets the ColorMatrix.

**Returns:**
int - The ColorMatrix.
##### getCanonLogVersion()
```
public final int getCanonLogVersion()
```

Gets the CanonLogVersion.

**Returns:**
int - The CanonLogVersion.

### Cr2MakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2makernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage, com.groupdocs.metadata.core.RawMakerNotePackage
```
public final class Cr2MakerNotePackage extends RawMakerNotePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MakerNotePackage() | Initializes a new instance of the  Cr2MakerNotePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCr2CameraSettingsPackage() | Gets the CanonCameraSettings. |
| setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value) | Sets the CanonCameraSettings. |
| getCameraSettings() | Gets the CanonCameraSettings Offset. |
| setCameraSettings(long value) | Sets the CanonCameraSettings Offset. |
| getCr2FocalLengthPackage() | Gets the CanonFocalLength. |
| setCr2FocalLengthPackage(Cr2FocalLengthPackage value) | Sets the CanonFocalLength. |
| getCr2FocalLength() | Gets the CanonCameraSettings Offset. |
| setCr2FocalLength(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ShotInfoPackage() | Gets the CanonShotInfo. |
| setCr2ShotInfoPackage(Cr2ShotInfoPackage value) | Sets the CanonShotInfo. |
| getCr2ShotInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ShotInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PanoramaPackage() | Gets the CanonPanorama. |
| setCr2PanoramaPackage(Cr2PanoramaPackage value) | Sets the CanonPanorama. |
| getCr2Panorama() | Gets the CanonCameraSettings Offset. |
| setCr2Panorama(long value) | Sets the CanonCameraSettings Offset. |
| getCr2MovieInfoPackage() | Gets the MovieInfo (Tags written by some Canon cameras when recording video). |
| setCr2MovieInfoPackage(Cr2MovieInfoPackage value) | Sets the MovieInfo (Tags written by some Canon cameras when recording video). |
| getCr2MovieInfo() | Gets the CanonCameraSettings Offset. |
| setCr2MovieInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFInfo2Package() | Gets the AFInfo3 (Newer version of the AFInfo record). |
| setCr2AFInfo2Package(Cr2AFInfo2Package value) | Sets the AFInfo3 (Newer version of the AFInfo record). |
| getCr2AFInfo2() | Gets the CanonCameraSettings Offset. |
| setCr2AFInfo2(long value) | Sets the CanonCameraSettings Offset. |
| getCr2WBInfoPackage() | Gets the WBInfo (WB tags for the Canon G9). |
| setCr2WBInfoPackage(Cr2WBInfoPackage value) | Sets the WBInfo (WB tags for the Canon G9). |
| getCr2WBInfo() | Gets the CanonCameraSettings Offset. |
| setCr2WBInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2TimeInfoPackage() | Gets the TimeInfo. |
| setCr2TimeInfoPackage(Cr2TimeInfoPackage value) | Sets the TimeInfo. |
| getCr2TimeInfo() | Gets the CanonCameraSettings Offset. |
| setCr2TimeInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFInfo3Package() | Gets the AFInfo3. |
| setCr2AFInfo3Package(Cr2AFInfo2Package value) | Sets the AFInfo3. |
| getCr2AFInfo3() | Gets the CanonCameraSettings Offset. |
| setCr2AFInfo3(long value) | Sets the CanonCameraSettings Offset. |
| getCr2Functions1DPackage() | Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| setCr2Functions1DPackage(Cr2Functions1DPackage value) | Sets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| getCr2Functions1D() | Gets the CanonCameraSettings Offset. |
| setCr2Functions1D(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PersonalFuncsPackage() | Gets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value) | Sets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| getCr2PersonalFuncs() | Gets the CanonCameraSettings Offset. |
| setCr2PersonalFuncs(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PersonalFuncValuesPackage() | Gets the PersonalFunctionValues. |
| setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value) | Sets the PersonalFunctionValues. |
| getCr2PersonalFuncValues() | Gets the CanonCameraSettings Offset. |
| setCr2PersonalFuncValues(long value) | Sets the CanonCameraSettings Offset. |
| getCr2FileInfoPackage() | Not used in this version. |
| setCr2FileInfoPackage(Cr2FileInfoPackage value) | Not used in this version. |
| getCr2FileInfo() | Gets the CanonCameraSettings Offset. |
| setCr2FileInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2CropInfoPackage() | Gets the CropInfo. |
| setCr2CropInfoPackage(Cr2CropInfoPackage value) | Sets the CropInfo. |
| getCr2CropInfo() | Gets the CanonCameraSettings Offset. |
| setCr2CropInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AspectInfoPackage() | Gets the AspectInfo. |
| setCr2AspectInfoPackage(Cr2AspectInfoPackage value) | Sets the AspectInfo. |
| getCr2AspectInfo() | Gets the CanonCameraSettings Offset. |
| setCr2AspectInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ProcessingPackage() | Gets the ProcessingInfo. |
| setCr2ProcessingPackage(Cr2ProcessingPackage value) | Sets the ProcessingInfo. |
| getCr2Processing() | Gets the CanonCameraSettings Offset. |
| setCr2Processing(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ColorBalancePackage() | Gets the ColorBalance (These tags are used by the 10D and 300D.). |
| setCr2ColorBalancePackage(Cr2ColorBalancePackage value) | Sets the ColorBalance (These tags are used by the 10D and 300D.). |
| getCr2ColorBalance() | Gets the CanonCameraSettings Offset. |
| setCr2ColorBalance(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ModifiedInfoPackage() | Gets the MeasuredColor. |
| setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value) | Sets the MeasuredColor. |
| getCr2ModifiedInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ModifiedInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2SensorInfoPackage() | Gets the SensorInfo. |
| setCr2SensorInfoPackage(Cr2SensorInfoPackage value) | Sets the SensorInfo. |
| getCr2SensorInfo() | Gets the CanonCameraSettings Offset. |
| setCr2SensorInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ColorInfoPackage() | Gets the ColorInfo. |
| setCr2ColorInfoPackage(Cr2ColorInfoPackage value) | Sets the ColorInfo. |
| getCr2ColorInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ColorInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFMicroAdjPackage() | Gets the AFMicroAdj. |
| setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value) | Sets the AFMicroAdj. |
| getCr2AFMicroAdj() | Gets the CanonCameraSettings Offset. |
| setCr2AFMicroAdj(long value) | Sets the CanonCameraSettings Offset. |
| getCr2LightingOptPackage() | Gets the LightingOpt (This information is new in images from the EOS 7D.). |
| setCr2LightingOptPackage(Cr2LightingOptPackage value) | Sets the LightingOpt (This information is new in images from the EOS 7D.). |
| getCr2LightingOpt() | Gets the CanonCameraSettings Offset. |
| setCr2LightingOpt(long value) | Sets the CanonCameraSettings Offset. |
| getCr2MultiExpPackage() | Gets the MultiExp. |
| setCr2MultiExpPackage(Cr2MultiExpPackage value) | Sets the MultiExp. |
| getCr2MultiExp() | Gets the CanonCameraSettings Offset. |
| setCr2MultiExp(long value) | Sets the CanonCameraSettings Offset. |
| getCr2LogInfoPackage() | Gets the LogInfo. |
| setCr2LogInfoPackage(Cr2LogInfoPackage value) | Sets the LogInfo. |
| getCr2LogInfo() | Gets the CanonCameraSettings Offset. |
| setCr2LogInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFConfigPackage() | Gets the AFConfig. |
| setCr2AFConfigPackage(Cr2AFConfigPackage value) | Sets the AFConfig. |
| getCr2AFConfig() | Gets the CanonCameraSettings Offset. |
| setCr2AFConfig(long value) | Sets the CanonCameraSettings Offset. |
| getImageType() | Gets the ImageType. |
| setImageType(String value) | Sets the ImageType. |
| getFirmwareVersion() | Gets the FirmwareVersion. |
| setFirmwareVersion(String value) | Sets the FirmwareVersion. |
| getFileNumber() | Gets the FileNumber. |
| setFileNumber(long value) | Sets the FileNumber. |
| getOwnerName() | Gets the OwnerName. |
| setOwnerName(String value) | Sets the OwnerName. |
| getSerialNumber() | Gets the SerialNumber. |
| setSerialNumber(long value) | Sets the SerialNumber. |
| getFileLength() | Gets the FileLength. |
| setFileLength(long value) | Sets the FileLength. |
| getModelID() | Gets the ModelID. |
| setModelID(long value) | Sets the ModelID. |
| getThumbnailImageValidArea() | Gets the ThumbnailImageValidArea. |
| setThumbnailImageValidArea(int[] value) | Sets the ThumbnailImageValidArea. |
| getSerialNumberFormat() | Gets the SerialNumberFormat. |
| setSerialNumberFormat(long value) | Sets the SerialNumberFormat. |
| getSuperMacro() | Gets the SuperMacro. |
| setSuperMacro(int value) | Sets the SuperMacro. |
| getDateStampMode() | Gets the DateStampMode. |
| setDateStampMode(int value) | Sets the DateStampMode. |
| getMyColors() | Gets the MyColors. |
| setMyColors(int[] value) | Sets the MyColors. |
| getContrastInfo() | Gets the Categories. |
| setContrastInfo(int[] value) | Sets the Categories. |
| getCategories() | Gets the Categories. |
| setCategories(long[] value) | Sets the Categories. |
| getImageUniqueID() | Gets the ImageUniqueID. |
| setImageUniqueID(byte[] value) | Sets the ImageUniqueID. |
| getOriginalDecisionDataOffset() | Gets the OriginalDecisionDataOffset. |
| setOriginalDecisionDataOffset(long value) | Sets the OriginalDecisionDataOffset. |
| getLensModel() | Gets the LensModel. |
| setLensModel(String value) | Sets the LensModel. |
| getInternalSerialNumber() | Gets the InternalSerialNumber. |
| setInternalSerialNumber(String value) | Sets the InternalSerialNumber. |
| getColorTemperature() | Gets the ColorTemperature. |
| setColorTemperature(int value) | Sets the ColorTemperature. |
| getMeasuredColor() | Gets the MeasuredColor. |
| setMeasuredColor(int[] value) | Sets the MeasuredColor. |
| getColorSpace() | Gets the ColorSpace. |
| setColorSpace(int value) | Sets the ColorSpace. |
| getCanonFlags() | Gets the CanonFlags. |
| setCanonFlags(int value) | Sets the CanonFlags. |
| getVRDOffset() | Gets the VRDOffset. |
| setVRDOffset(long value) | Sets the VRDOffset. |
| getPictureStyleUserDef() | Gets the PictureStyleUserDef. |
| setPictureStyleUserDef(int[] value) | Sets the PictureStyleUserDef. |
| getPictureStylePC() | Gets the PictureStylePC. |
| setPictureStylePC(int[] value) | Sets the PictureStylePC. |
| getCustomPictureStyleFileName() | Gets the CustomPictureStyleFileName. |
| setCustomPictureStyleFileName(String value) | Sets the CustomPictureStyleFileName. |
| getLensInfo() | Gets the LensInfo. |
| setLensInfo(byte[] value) | Sets the LensInfo. |
| getAmbienceInfo() | Gets the LensInfo. |
| setAmbienceInfo(long[] value) | Sets the LensInfo. |
| getCameraInfo() | Gets the CameraInfo. |
| setCameraInfo(long value) | Sets the CameraInfo. |
| getCustomFunctions() | Gets the CustomFunctions. |
| setCustomFunctions(long value) | Sets the CustomFunctions. |
| getFaceDetect1() | Gets the FaceDetect1. |
| setFaceDetect1(long value) | Sets the FaceDetect1. |
| getFaceDetect2() | Gets the FaceDetect2. |
| setFaceDetect2(long value) | Sets the FaceDetect2. |
| getFaceDetect3() | Gets the FaceDetect3. |
| setFaceDetect3(long value) | Sets the FaceDetect3. |
| getPreviewImageInfo() | Gets the PreviewImageInfo. |
| setPreviewImageInfo(long value) | Sets the PreviewImageInfo. |
| getColorData1() | Gets the ColorData1. |
| setColorData1(long value) | Sets the ColorData1. |
| getVignettingCorr() | Gets the VignettingCorr. |
| setVignettingCorr(long value) | Sets the VignettingCorr. |
| getHDRInfo() | Gets the HDRInfo. |
| setHDRInfo(long value) | Sets the HDRInfo. |
| getRawBurstModeRoll() | Gets the RawBurstModeRoll. |
| setRawBurstModeRoll(long value) | Sets the RawBurstModeRoll. |
##### Cr2MakerNotePackage()
```
public Cr2MakerNotePackage()
```

Initializes a new instance of the  Cr2MakerNotePackage  class.

##### getCr2CameraSettingsPackage()
```
public final Cr2CameraSettingsPackage getCr2CameraSettingsPackage()
```

Gets the CanonCameraSettings.

**Returns:**
Cr2CameraSettingsPackage - The CanonCameraSettings.
##### setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value)
```
public final void setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value)
```

Sets the CanonCameraSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2CameraSettingsPackage | The CanonCameraSettings. |

##### getCameraSettings()
```
public final long getCameraSettings()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCameraSettings(long value)
```
public final void setCameraSettings(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2FocalLengthPackage()
```
public final Cr2FocalLengthPackage getCr2FocalLengthPackage()
```

Gets the CanonFocalLength.

**Returns:**
Cr2FocalLengthPackage - The CanonFocalLength.
##### setCr2FocalLengthPackage(Cr2FocalLengthPackage value)
```
public final void setCr2FocalLengthPackage(Cr2FocalLengthPackage value)
```

Sets the CanonFocalLength.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2FocalLengthPackage | The CanonFocalLength. |

##### getCr2FocalLength()
```
public final long getCr2FocalLength()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2FocalLength(long value)
```
public final void setCr2FocalLength(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ShotInfoPackage()
```
public final Cr2ShotInfoPackage getCr2ShotInfoPackage()
```

Gets the CanonShotInfo.

**Returns:**
Cr2ShotInfoPackage - The CanonShotInfo.
##### setCr2ShotInfoPackage(Cr2ShotInfoPackage value)
```
public final void setCr2ShotInfoPackage(Cr2ShotInfoPackage value)
```

Sets the CanonShotInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ShotInfoPackage | The CanonShotInfo. |

##### getCr2ShotInfo()
```
public final long getCr2ShotInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ShotInfo(long value)
```
public final void setCr2ShotInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PanoramaPackage()
```
public final Cr2PanoramaPackage getCr2PanoramaPackage()
```

Gets the CanonPanorama.

**Returns:**
Cr2PanoramaPackage - The CanonPanorama.
##### setCr2PanoramaPackage(Cr2PanoramaPackage value)
```
public final void setCr2PanoramaPackage(Cr2PanoramaPackage value)
```

Sets the CanonPanorama.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PanoramaPackage | The CanonPanorama. |

##### getCr2Panorama()
```
public final long getCr2Panorama()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Panorama(long value)
```
public final void setCr2Panorama(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2MovieInfoPackage()
```
public final Cr2MovieInfoPackage getCr2MovieInfoPackage()
```

Gets the MovieInfo (Tags written by some Canon cameras when recording video).

**Returns:**
Cr2MovieInfoPackage - The MovieInfo.
##### setCr2MovieInfoPackage(Cr2MovieInfoPackage value)
```
public final void setCr2MovieInfoPackage(Cr2MovieInfoPackage value)
```

Sets the MovieInfo (Tags written by some Canon cameras when recording video).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2MovieInfoPackage | The MovieInfo. |

##### getCr2MovieInfo()
```
public final long getCr2MovieInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2MovieInfo(long value)
```
public final void setCr2MovieInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFInfo2Package()
```
public final Cr2AFInfo2Package getCr2AFInfo2Package()
```

Gets the AFInfo3 (Newer version of the AFInfo record).

**Returns:**
Cr2AFInfo2Package - The AFInfo3.
##### setCr2AFInfo2Package(Cr2AFInfo2Package value)
```
public final void setCr2AFInfo2Package(Cr2AFInfo2Package value)
```

Sets the AFInfo3 (Newer version of the AFInfo record).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFInfo2Package | The AFInfo3. |

##### getCr2AFInfo2()
```
public final long getCr2AFInfo2()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFInfo2(long value)
```
public final void setCr2AFInfo2(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2WBInfoPackage()
```
public final Cr2WBInfoPackage getCr2WBInfoPackage()
```

Gets the WBInfo (WB tags for the Canon G9).

**Returns:**
Cr2WBInfoPackage - The WBInfo.
##### setCr2WBInfoPackage(Cr2WBInfoPackage value)
```
public final void setCr2WBInfoPackage(Cr2WBInfoPackage value)
```

Sets the WBInfo (WB tags for the Canon G9).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2WBInfoPackage | The WBInfo. |

##### getCr2WBInfo()
```
public final long getCr2WBInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2WBInfo(long value)
```
public final void setCr2WBInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2TimeInfoPackage()
```
public final Cr2TimeInfoPackage getCr2TimeInfoPackage()
```

Gets the TimeInfo.

**Returns:**
Cr2TimeInfoPackage - The TimeInfo.
##### setCr2TimeInfoPackage(Cr2TimeInfoPackage value)
```
public final void setCr2TimeInfoPackage(Cr2TimeInfoPackage value)
```

Sets the TimeInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2TimeInfoPackage | The TimeInfo. |

##### getCr2TimeInfo()
```
public final long getCr2TimeInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2TimeInfo(long value)
```
public final void setCr2TimeInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFInfo3Package()
```
public final Cr2AFInfo2Package getCr2AFInfo3Package()
```

Gets the AFInfo3.

**Returns:**
Cr2AFInfo2Package - The AFInfo3.
##### setCr2AFInfo3Package(Cr2AFInfo2Package value)
```
public final void setCr2AFInfo3Package(Cr2AFInfo2Package value)
```

Sets the AFInfo3.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFInfo2Package | The AFInfo3. |

##### getCr2AFInfo3()
```
public final long getCr2AFInfo3()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFInfo3(long value)
```
public final void setCr2AFInfo3(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2Functions1DPackage()
```
public final Cr2Functions1DPackage getCr2Functions1DPackage()
```

Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).

**Returns:**
Cr2Functions1DPackage - The CustomFunctions1D.
##### setCr2Functions1DPackage(Cr2Functions1DPackage value)
```
public final void setCr2Functions1DPackage(Cr2Functions1DPackage value)
```

Sets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2Functions1DPackage | The CustomFunctions1D. |

##### getCr2Functions1D()
```
public final long getCr2Functions1D()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Functions1D(long value)
```
public final void setCr2Functions1D(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PersonalFuncsPackage()
```
public final Cr2PersonalFuncsPackage getCr2PersonalFuncsPackage()
```

Gets the PersonalFunctions (Personal function settings for the EOS-1D.).

**Returns:**
Cr2PersonalFuncsPackage - The PersonalFunctions.
##### setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value)
```
public final void setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value)
```

Sets the PersonalFunctions (Personal function settings for the EOS-1D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PersonalFuncsPackage | The PersonalFunctions. |

##### getCr2PersonalFuncs()
```
public final long getCr2PersonalFuncs()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2PersonalFuncs(long value)
```
public final void setCr2PersonalFuncs(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PersonalFuncValuesPackage()
```
public final Cr2PersonalFuncValuesPackage getCr2PersonalFuncValuesPackage()
```

Gets the PersonalFunctionValues.

**Returns:**
Cr2PersonalFuncValuesPackage - The PersonalFunctionValues.
##### setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value)
```
public final void setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value)
```

Sets the PersonalFunctionValues.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PersonalFuncValuesPackage | The PersonalFunctionValues. |

##### getCr2PersonalFuncValues()
```
public final long getCr2PersonalFuncValues()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2PersonalFuncValues(long value)
```
public final void setCr2PersonalFuncValues(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2FileInfoPackage()
```
public final Cr2FileInfoPackage getCr2FileInfoPackage()
```

Not used in this version. Gets the CanonFileInfo.

**Returns:**
Cr2FileInfoPackage - The CanonFileInfo.
##### setCr2FileInfoPackage(Cr2FileInfoPackage value)
```
public final void setCr2FileInfoPackage(Cr2FileInfoPackage value)
```

Not used in this version. Gets the CanonFileInfo.

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

##### getCr2FileInfo()
```
public final long getCr2FileInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2FileInfo(long value)
```
public final void setCr2FileInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2CropInfoPackage()
```
public final Cr2CropInfoPackage getCr2CropInfoPackage()
```

Gets the CropInfo.

**Returns:**
Cr2CropInfoPackage - The CropInfo.
##### setCr2CropInfoPackage(Cr2CropInfoPackage value)
```
public final void setCr2CropInfoPackage(Cr2CropInfoPackage value)
```

Sets the CropInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2CropInfoPackage | The CropInfo. |

##### getCr2CropInfo()
```
public final long getCr2CropInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2CropInfo(long value)
```
public final void setCr2CropInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AspectInfoPackage()
```
public final Cr2AspectInfoPackage getCr2AspectInfoPackage()
```

Gets the AspectInfo.

**Returns:**
Cr2AspectInfoPackage - The AspectInfo.
##### setCr2AspectInfoPackage(Cr2AspectInfoPackage value)
```
public final void setCr2AspectInfoPackage(Cr2AspectInfoPackage value)
```

Sets the AspectInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AspectInfoPackage | The AspectInfo. |

##### getCr2AspectInfo()
```
public final long getCr2AspectInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AspectInfo(long value)
```
public final void setCr2AspectInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ProcessingPackage()
```
public final Cr2ProcessingPackage getCr2ProcessingPackage()
```

Gets the ProcessingInfo.

**Returns:**
Cr2ProcessingPackage - The ProcessingInfo.
##### setCr2ProcessingPackage(Cr2ProcessingPackage value)
```
public final void setCr2ProcessingPackage(Cr2ProcessingPackage value)
```

Sets the ProcessingInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ProcessingPackage | The ProcessingInfo. |

##### getCr2Processing()
```
public final long getCr2Processing()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Processing(long value)
```
public final void setCr2Processing(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ColorBalancePackage()
```
public final Cr2ColorBalancePackage getCr2ColorBalancePackage()
```

Gets the ColorBalance (These tags are used by the 10D and 300D.).

**Returns:**
Cr2ColorBalancePackage - The ColorBalance.
##### setCr2ColorBalancePackage(Cr2ColorBalancePackage value)
```
public final void setCr2ColorBalancePackage(Cr2ColorBalancePackage value)
```

Sets the ColorBalance (These tags are used by the 10D and 300D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ColorBalancePackage | The ColorBalance. |

##### getCr2ColorBalance()
```
public final long getCr2ColorBalance()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ColorBalance(long value)
```
public final void setCr2ColorBalance(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ModifiedInfoPackage()
```
public final Cr2ModifiedInfoPackage getCr2ModifiedInfoPackage()
```

Gets the MeasuredColor.

**Returns:**
Cr2ModifiedInfoPackage - The MeasuredColor.
##### setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value)
```
public final void setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value)
```

Sets the MeasuredColor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ModifiedInfoPackage | The MeasuredColor. |

##### getCr2ModifiedInfo()
```
public final long getCr2ModifiedInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ModifiedInfo(long value)
```
public final void setCr2ModifiedInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2SensorInfoPackage()
```
public final Cr2SensorInfoPackage getCr2SensorInfoPackage()
```

Gets the SensorInfo.

**Returns:**
Cr2SensorInfoPackage - The SensorInfo.
##### setCr2SensorInfoPackage(Cr2SensorInfoPackage value)
```
public final void setCr2SensorInfoPackage(Cr2SensorInfoPackage value)
```

Sets the SensorInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2SensorInfoPackage | The SensorInfo. |

##### getCr2SensorInfo()
```
public final long getCr2SensorInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2SensorInfo(long value)
```
public final void setCr2SensorInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ColorInfoPackage()
```
public final Cr2ColorInfoPackage getCr2ColorInfoPackage()
```

Gets the ColorInfo.

**Returns:**
Cr2ColorInfoPackage - The ColorInfo.
##### setCr2ColorInfoPackage(Cr2ColorInfoPackage value)
```
public final void setCr2ColorInfoPackage(Cr2ColorInfoPackage value)
```

Sets the ColorInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ColorInfoPackage | The ColorInfo. |

##### getCr2ColorInfo()
```
public final long getCr2ColorInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ColorInfo(long value)
```
public final void setCr2ColorInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFMicroAdjPackage()
```
public final Cr2AFMicroAdjPackage getCr2AFMicroAdjPackage()
```

Gets the AFMicroAdj.

**Returns:**
Cr2AFMicroAdjPackage - The AFMicroAdj.
##### setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value)
```
public final void setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value)
```

Sets the AFMicroAdj.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFMicroAdjPackage | The AFMicroAdj. |

##### getCr2AFMicroAdj()
```
public final long getCr2AFMicroAdj()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFMicroAdj(long value)
```
public final void setCr2AFMicroAdj(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2LightingOptPackage()
```
public final Cr2LightingOptPackage getCr2LightingOptPackage()
```

Gets the LightingOpt (This information is new in images from the EOS 7D.).

**Returns:**
Cr2LightingOptPackage - The LightingOpt.
##### setCr2LightingOptPackage(Cr2LightingOptPackage value)
```
public final void setCr2LightingOptPackage(Cr2LightingOptPackage value)
```

Sets the LightingOpt (This information is new in images from the EOS 7D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2LightingOptPackage | The LightingOpt. |

##### getCr2LightingOpt()
```
public final long getCr2LightingOpt()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2LightingOpt(long value)
```
public final void setCr2LightingOpt(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2MultiExpPackage()
```
public final Cr2MultiExpPackage getCr2MultiExpPackage()
```

Gets the MultiExp.

**Returns:**
Cr2MultiExpPackage - The MultiExp.
##### setCr2MultiExpPackage(Cr2MultiExpPackage value)
```
public final void setCr2MultiExpPackage(Cr2MultiExpPackage value)
```

Sets the MultiExp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2MultiExpPackage | The MultiExp. |

##### getCr2MultiExp()
```
public final long getCr2MultiExp()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2MultiExp(long value)
```
public final void setCr2MultiExp(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2LogInfoPackage()
```
public final Cr2LogInfoPackage getCr2LogInfoPackage()
```

Gets the LogInfo.

**Returns:**
Cr2LogInfoPackage - The LogInfo.
##### setCr2LogInfoPackage(Cr2LogInfoPackage value)
```
public final void setCr2LogInfoPackage(Cr2LogInfoPackage value)
```

Sets the LogInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2LogInfoPackage | The LogInfo. |

##### getCr2LogInfo()
```
public final long getCr2LogInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2LogInfo(long value)
```
public final void setCr2LogInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFConfigPackage()
```
public final Cr2AFConfigPackage getCr2AFConfigPackage()
```

Gets the AFConfig.

**Returns:**
Cr2AFConfigPackage - The AFConfig.
##### setCr2AFConfigPackage(Cr2AFConfigPackage value)
```
public final void setCr2AFConfigPackage(Cr2AFConfigPackage value)
```

Sets the AFConfig.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFConfigPackage | The AFConfig. |

##### getCr2AFConfig()
```
public final long getCr2AFConfig()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFConfig(long value)
```
public final void setCr2AFConfig(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getImageType()
```
public final String getImageType()
```

Gets the ImageType.

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

Sets the ImageType.

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

##### getFirmwareVersion()
```
public final String getFirmwareVersion()
```

Gets the FirmwareVersion.

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

Sets the FirmwareVersion.

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

##### getFileNumber()
```
public final long getFileNumber()
```

Gets the FileNumber.

**Returns:**
long - The FileNumber.
##### setFileNumber(long value)
```
public final void setFileNumber(long value)
```

Sets the FileNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FileNumber. |

##### getOwnerName()
```
public final String getOwnerName()
```

Gets the OwnerName.

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

Sets the OwnerName.

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

##### getSerialNumber()
```
public final long getSerialNumber()
```

Gets the SerialNumber.

**Returns:**
long - The SerialNumber.
##### setSerialNumber(long value)
```
public final void setSerialNumber(long value)
```

Sets the SerialNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The SerialNumber. |

##### getFileLength()
```
public final long getFileLength()
```

Gets the FileLength.

**Returns:**
long - The FileLength.
##### setFileLength(long value)
```
public final void setFileLength(long value)
```

Sets the FileLength.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FileLength. |

##### getModelID()
```
public final long getModelID()
```

Gets the ModelID.

**Returns:**
long - The ModelID.
##### setModelID(long value)
```
public final void setModelID(long value)
```

Sets the ModelID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The ModelID. |

##### getThumbnailImageValidArea()
```
public final int[] getThumbnailImageValidArea()
```

Gets the ThumbnailImageValidArea.

**Returns:**
int[] - The ThumbnailImageValidArea.
##### setThumbnailImageValidArea(int[] value)
```
public final void setThumbnailImageValidArea(int[] value)
```

Sets the ThumbnailImageValidArea.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The ThumbnailImageValidArea. |

##### getSerialNumberFormat()
```
public final long getSerialNumberFormat()
```

Gets the SerialNumberFormat.

**Returns:**
long - The SerialNumberFormat.
##### setSerialNumberFormat(long value)
```
public final void setSerialNumberFormat(long value)
```

Sets the SerialNumberFormat.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The SerialNumberFormat. |

##### getSuperMacro()
```
public final int getSuperMacro()
```

Gets the SuperMacro.

**Returns:**
int - The SuperMacro.
##### setSuperMacro(int value)
```
public final void setSuperMacro(int value)
```

Sets the SuperMacro.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The SuperMacro. |

##### getDateStampMode()
```
public final int getDateStampMode()
```

Gets the DateStampMode.

**Returns:**
int - The DateStampMode.
##### setDateStampMode(int value)
```
public final void setDateStampMode(int value)
```

Sets the DateStampMode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The DateStampMode. |

##### getMyColors()
```
public final int[] getMyColors()
```

Gets the MyColors.

**Returns:**
int[] - The MyColors.
##### setMyColors(int[] value)
```
public final void setMyColors(int[] value)
```

Sets the MyColors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The MyColors. |

##### getContrastInfo()
```
public final int[] getContrastInfo()
```

Gets the Categories.

**Returns:**
int[] - The Categories.
##### setContrastInfo(int[] value)
```
public final void setContrastInfo(int[] value)
```

Sets the Categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The Categories. |

##### getCategories()
```
public final long[] getCategories()
```

Gets the Categories.

**Returns:**
long[] - The Categories.
##### setCategories(long[] value)
```
public final void setCategories(long[] value)
```

Sets the Categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long[] | The Categories. |

##### getImageUniqueID()
```
public final byte[] getImageUniqueID()
```

Gets the ImageUniqueID.

**Returns:**
byte[] - The ImageUniqueID.
##### setImageUniqueID(byte[] value)
```
public final void setImageUniqueID(byte[] value)
```

Sets the ImageUniqueID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The ImageUniqueID. |

##### getOriginalDecisionDataOffset()
```
public final long getOriginalDecisionDataOffset()
```

Gets the OriginalDecisionDataOffset.

**Returns:**
long - The OriginalDecisionDataOffset.
##### setOriginalDecisionDataOffset(long value)
```
public final void setOriginalDecisionDataOffset(long value)
```

Sets the OriginalDecisionDataOffset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The OriginalDecisionDataOffset. |

##### getLensModel()
```
public final String getLensModel()
```

Gets the LensModel.

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

Sets the LensModel.

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

##### getInternalSerialNumber()
```
public final String getInternalSerialNumber()
```

Gets the InternalSerialNumber.

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

Sets the InternalSerialNumber.

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

##### getColorTemperature()
```
public final int getColorTemperature()
```

Gets the ColorTemperature.

**Returns:**
int - The ColorTemperature.
##### setColorTemperature(int value)
```
public final void setColorTemperature(int value)
```

Sets the ColorTemperature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The ColorTemperature. |

##### getMeasuredColor()
```
public final int[] getMeasuredColor()
```

Gets the MeasuredColor.

**Returns:**
int[] - The MeasuredColor.
##### setMeasuredColor(int[] value)
```
public final void setMeasuredColor(int[] value)
```

Sets the MeasuredColor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The MeasuredColor. |

##### getColorSpace()
```
public final int getColorSpace()
```

Gets the ColorSpace.

**Returns:**
int - The ColorSpace.
##### setColorSpace(int value)
```
public final void setColorSpace(int value)
```

Sets the ColorSpace.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The ColorSpace. |

##### getCanonFlags()
```
public final int getCanonFlags()
```

Gets the CanonFlags.

**Returns:**
int - The CanonFlags.
##### setCanonFlags(int value)
```
public final void setCanonFlags(int value)
```

Sets the CanonFlags.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The CanonFlags. |

##### getVRDOffset()
```
public final long getVRDOffset()
```

Gets the VRDOffset.

**Returns:**
long - The VRDOffset.
##### setVRDOffset(long value)
```
public final void setVRDOffset(long value)
```

Sets the VRDOffset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The VRDOffset. |

##### getPictureStyleUserDef()
```
public final int[] getPictureStyleUserDef()
```

Gets the PictureStyleUserDef.

**Returns:**
int[] - The PictureStyleUserDef.
##### setPictureStyleUserDef(int[] value)
```
public final void setPictureStyleUserDef(int[] value)
```

Sets the PictureStyleUserDef.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The PictureStyleUserDef. |

##### getPictureStylePC()
```
public final int[] getPictureStylePC()
```

Gets the PictureStylePC.

**Returns:**
int[] - The PictureStylePC.
##### setPictureStylePC(int[] value)
```
public final void setPictureStylePC(int[] value)
```

Sets the PictureStylePC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The PictureStylePC. |

##### getCustomPictureStyleFileName()
```
public final String getCustomPictureStyleFileName()
```

Gets the CustomPictureStyleFileName.

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

Sets the CustomPictureStyleFileName.

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

##### getLensInfo()
```
public final byte[] getLensInfo()
```

Gets the LensInfo.

**Returns:**
byte[] - The LensInfo.
##### setLensInfo(byte[] value)
```
public final void setLensInfo(byte[] value)
```

Sets the LensInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The LensInfo. |

##### getAmbienceInfo()
```
public final long[] getAmbienceInfo()
```

Gets the LensInfo.

**Returns:**
long[] - The LensInfo.
##### setAmbienceInfo(long[] value)
```
public final void setAmbienceInfo(long[] value)
```

Sets the LensInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long[] | The LensInfo. |

##### getCameraInfo()
```
public final long getCameraInfo()
```

Gets the CameraInfo.

**Returns:**
long - The CameraInfo.
##### setCameraInfo(long value)
```
public final void setCameraInfo(long value)
```

Sets the CameraInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CameraInfo. |

##### getCustomFunctions()
```
public final long getCustomFunctions()
```

Gets the CustomFunctions.

**Returns:**
long - The CustomFunctions.
##### setCustomFunctions(long value)
```
public final void setCustomFunctions(long value)
```

Sets the CustomFunctions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CustomFunctions. |

##### getFaceDetect1()
```
public final long getFaceDetect1()
```

Gets the FaceDetect1.

**Returns:**
long - The FaceDetect1.
##### setFaceDetect1(long value)
```
public final void setFaceDetect1(long value)
```

Sets the FaceDetect1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect1. |

##### getFaceDetect2()
```
public final long getFaceDetect2()
```

Gets the FaceDetect2.

**Returns:**
long - The FaceDetect2.
##### setFaceDetect2(long value)
```
public final void setFaceDetect2(long value)
```

Sets the FaceDetect2.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect2. |

##### getFaceDetect3()
```
public final long getFaceDetect3()
```

Gets the FaceDetect3.

**Returns:**
long - The FaceDetect3.
##### setFaceDetect3(long value)
```
public final void setFaceDetect3(long value)
```

Sets the FaceDetect3.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect3. |

##### getPreviewImageInfo()
```
public final long getPreviewImageInfo()
```

Gets the PreviewImageInfo.

**Returns:**
long - The PreviewImageInfo.
##### setPreviewImageInfo(long value)
```
public final void setPreviewImageInfo(long value)
```

Sets the PreviewImageInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The PreviewImageInfo. |

##### getColorData1()
```
public final long getColorData1()
```

Gets the ColorData1.

**Returns:**
long - The ColorData1.
##### setColorData1(long value)
```
public final void setColorData1(long value)
```

Sets the ColorData1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The ColorData1. |

##### getVignettingCorr()
```
public final long getVignettingCorr()
```

Gets the VignettingCorr.

**Returns:**
long - The VignettingCorr.
##### setVignettingCorr(long value)
```
public final void setVignettingCorr(long value)
```

Sets the VignettingCorr.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The VignettingCorr. |

##### getHDRInfo()
```
public final long getHDRInfo()
```

Gets the HDRInfo.

**Returns:**
long - The HDRInfo.
##### setHDRInfo(long value)
```
public final void setHDRInfo(long value)
```

Sets the HDRInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The HDRInfo. |

##### getRawBurstModeRoll()
```
public final long getRawBurstModeRoll()
```

Gets the RawBurstModeRoll.

**Returns:**
long - The RawBurstModeRoll.
##### setRawBurstModeRoll(long value)
```
public final void setRawBurstModeRoll(long value)
```

Sets the RawBurstModeRoll.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The RawBurstModeRoll. |

### Cr2ModifiedInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2modifiedinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ModifiedInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ModifiedInfoPackage() | Initializes a new instance of the  Cr2ModifiedInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModifiedToneCurve() | Gets the ModifiedToneCurve. |
| getModifiedSharpness() | Gets the ModifiedSharpness. |
| getModifiedSharpnessFreq() | Gets the ModifiedSharpnessFreq. |
| getModifiedSensorRedLevel() | Gets the ModifiedSensorRedLevel. |
| getModifiedSensorBlueLevel() | Gets the ModifiedSensorBlueLevel. |
| getModifiedWhiteBalanceRed() | Gets the ModifiedWhiteBalanceRed. |
| getModifiedWhiteBalanceBlue() | Gets the ModifiedWhiteBalanceBlue. |
| getModifiedWhiteBalance() | Gets the ModifiedWhiteBalance. |
| getModifiedColorTemp() | Gets the ModifiedColorTemp. |
| getModifiedPictureStyle() | Gets the ModifiedPictureStyle. |
| getModifiedDigitalGain() | Gets the ModifiedDigitalGain. |
##### Cr2ModifiedInfoPackage()
```
public Cr2ModifiedInfoPackage()
```

Initializes a new instance of the  Cr2ModifiedInfoPackage  class.

##### getModifiedToneCurve()
```
public final int getModifiedToneCurve()
```

Gets the ModifiedToneCurve.

**Returns:**
int - The ModifiedToneCurve.
##### getModifiedSharpness()
```
public final int getModifiedSharpness()
```

Gets the ModifiedSharpness.

**Returns:**
int - The ModifiedSharpness.
##### getModifiedSharpnessFreq()
```
public final int getModifiedSharpnessFreq()
```

Gets the ModifiedSharpnessFreq.

**Returns:**
int - The ModifiedSharpnessFreq.
##### getModifiedSensorRedLevel()
```
public final int getModifiedSensorRedLevel()
```

Gets the ModifiedSensorRedLevel.

**Returns:**
int - The ModifiedSensorRedLevel.
##### getModifiedSensorBlueLevel()
```
public final int getModifiedSensorBlueLevel()
```

Gets the ModifiedSensorBlueLevel.

**Returns:**
int - The ModifiedSensorBlueLevel.
##### getModifiedWhiteBalanceRed()
```
public final int getModifiedWhiteBalanceRed()
```

Gets the ModifiedWhiteBalanceRed.

**Returns:**
int - The ModifiedWhiteBalanceRed.
##### getModifiedWhiteBalanceBlue()
```
public final int getModifiedWhiteBalanceBlue()
```

Gets the ModifiedWhiteBalanceBlue.

**Returns:**
int - The ModifiedWhiteBalanceBlue.
##### getModifiedWhiteBalance()
```
public final int getModifiedWhiteBalance()
```

Gets the ModifiedWhiteBalance.

**Returns:**
int - The ModifiedWhiteBalance.
##### getModifiedColorTemp()
```
public final int getModifiedColorTemp()
```

Gets the ModifiedColorTemp.

**Returns:**
int - The ModifiedColorTemp.
##### getModifiedPictureStyle()
```
public final int getModifiedPictureStyle()
```

Gets the ModifiedPictureStyle.

**Returns:**
int - The ModifiedPictureStyle.
##### getModifiedDigitalGain()
```
public final int getModifiedDigitalGain()
```

Gets the ModifiedDigitalGain.

**Returns:**
int - The ModifiedDigitalGain.

### Cr2MovieInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2movieinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2MovieInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MovieInfoPackage() | Initializes a new instance of the  Cr2MovieInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFrameRate() | Gets the FrameRate. |
| getFrameCount() | Gets the FrameCount. |
| getFrameCount2() | Gets the FrameCount2. |
| getFrameRate2() | Gets the FrameRate. |
| getDuration() | Gets the Duration. |
| getAudioBitrate() | Gets the AudioBitrate. |
| getAudioSampleRate() | Gets the AudioSampleRate. |
| getAudioChannels() | Gets the AudioChannels. |
| getVideoCodec() | Gets the VideoCodec. |
##### Cr2MovieInfoPackage()
```
public Cr2MovieInfoPackage()
```

Initializes a new instance of the  Cr2MovieInfoPackage  class.

##### getFrameRate()
```
public final int getFrameRate()
```

Gets the FrameRate.

**Returns:**
int - The FrameRate.
##### getFrameCount()
```
public final int getFrameCount()
```

Gets the FrameCount.

**Returns:**
int - The FrameCount.
##### getFrameCount2()
```
public final int getFrameCount2()
```

Gets the FrameCount2.

**Returns:**
int - The FrameCount2.
##### getFrameRate2()
```
public final float getFrameRate2()
```

Gets the FrameRate.

**Returns:**
float - The FrameRate.
##### getDuration()
```
public final int getDuration()
```

Gets the Duration.

**Returns:**
int - The Duration.
##### getAudioBitrate()
```
public final int getAudioBitrate()
```

Gets the AudioBitrate.

**Returns:**
int - The AudioBitrate.
##### getAudioSampleRate()
```
public final int getAudioSampleRate()
```

Gets the AudioSampleRate.

**Returns:**
int - The AudioSampleRate.
##### getAudioChannels()
```
public final int getAudioChannels()
```

Gets the AudioChannels.

**Returns:**
int - The AudioChannels.
##### getVideoCodec()
```
public final byte[] getVideoCodec()
```

Gets the VideoCodec.

**Returns:**
byte[] - The VideoCodec.

### Cr2MultiExpPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2multiexppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2MultiExpPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MultiExpPackage() | Initializes a new instance of the  Cr2MultiExpPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMultiExposure() | Gets the MultiExposure. |
| getMultiExposureControl() | Gets the MultiExposureControl. |
| getMultiExposureShots() | Gets the MultiExposureShots. |
##### Cr2MultiExpPackage()
```
public Cr2MultiExpPackage()
```

Initializes a new instance of the  Cr2MultiExpPackage  class.

##### getMultiExposure()
```
public final int getMultiExposure()
```

Gets the MultiExposure.

**Returns:**
int - The MultiExposure.
##### getMultiExposureControl()
```
public final int getMultiExposureControl()
```

Gets the MultiExposureControl.

**Returns:**
int - The MultiExposureControl.
##### getMultiExposureShots()
```
public final int getMultiExposureShots()
```

Gets the MultiExposureShots.

**Returns:**
int - The MultiExposureShots.

### Cr2Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawPackage
```
public final class Cr2Package extends RawPackage
```

Represents native CR2 metadata.

[Working with DNG metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CR2+metadata
#### Methods

| Method | Description |
| --- | --- |
| getRawTiffTagPackage() | Gets the Tag Support Levels. |
##### getRawTiffTagPackage()
```
public final RawTiffTagPackage getRawTiffTagPackage()
```

Gets the Tag Support Levels.

**Returns:**
RawTiffTagPackage - The Tag Support Levels.

### Cr2PanoramaPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2panoramapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PanoramaPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PanoramaPackage() | Initializes a new instance of the  Cr2PanoramaPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPanoramaFrameNumber() | Gets the PanoramaFrameNumber. |
| getPanoramaDirection() | Gets the PanoramaDirection. |
##### Cr2PanoramaPackage()
```
public Cr2PanoramaPackage()
```

Initializes a new instance of the  Cr2PanoramaPackage  class.

##### getPanoramaFrameNumber()
```
public final int getPanoramaFrameNumber()
```

Gets the PanoramaFrameNumber.

**Returns:**
int - The PanoramaFrameNumber.
##### getPanoramaDirection()
```
public final int getPanoramaDirection()
```

Gets the PanoramaDirection.

**Returns:**
int - The PanoramaDirection.

### Cr2PersonalFuncsPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2personalfuncspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PersonalFuncsPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PersonalFuncsPackage() | Initializes a new instance of the  Cr2PersonalFuncsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPF0CustomFuncRegistration() | Gets the PF0CustomFuncRegistration. |
| getPF1DisableShootingModes() | Gets the PF1DisableShootingModes. |
| getPF2DisableMeteringModes() | Gets the PF2DisableMeteringModes. |
| getPF3ManualExposureMetering() | Gets the PF3ManualExposureMetering. |
| getPF4ExposureTimeLimits() | Gets the PF4ExposureTimeLimits. |
| getPF5ApertureLimits() | Gets the PF5ApertureLimits. |
| getPF6PresetShootingModes() | Gets the PF6PresetShootingModes. |
| getPF7BracketContinuousShoot() | Gets the PF7BracketContinuousShoot. |
| getPF8SetBracketShots() | Gets the PF8SetBracketShots. |
| getPF9ChangeBracketSequence() | Gets the PF9ChangeBracketSequence. |
| getPF10RetainProgramShift() | Gets the PF10RetainProgramShift. |
| getPF13DrivePriority() | Gets the PF13DrivePriority. |
| getPF14DisableFocusSearch() | Gets the PF14DisableFocusSearch. |
| getPF15DisableAFAssistBeam() | Gets the PF15DisableAFAssistBeam. |
| getPF16AutoFocusPointShoot() | Gets the PF16AutoFocusPointShoot. |
| getPF17DisableAFPointSel() | Gets the PF17DisableAFPointSel. |
| getPF18EnableAutoAFPointSel() | Gets the PF18EnableAutoAFPointSel. |
| getPF19ContinuousShootSpeed() | Gets the PF19ContinuousShootSpeed. |
| getPF20LimitContinousShots() | Gets the PF20LimitContinousShots. |
| getPF21EnableQuietOperation() | Gets the PF21EnableQuietOperation. |
| getPF23SetTimerLengths() | Gets the PF23SetTimerLengths. |
| getPF24LightLCDDuringBulb() | Gets the PF24LightLCDDuringBulb. |
| getPF25DefaultClearSettings() | Gets the PF25DefaultClearSettings. |
| getPF26ShortenReleaseLag() | Gets the PF26ShortenReleaseLag. |
| getPF27ReverseDialRotation() | Gets the PF27ReverseDialRotation. |
| getPF28NoQuickDialExpComp() | Gets the PF28NoQuickDialExpComp. |
| getPF29QuickDialSwitchOff() | Gets the PF29QuickDialSwitchOff. |
| getPF30EnlargementMode() | Gets the PF30EnlargementMode. |
| getPF31OriginalDecisionData() | Gets the PF31OriginalDecisionData. |
##### Cr2PersonalFuncsPackage()
```
public Cr2PersonalFuncsPackage()
```

Initializes a new instance of the  Cr2PersonalFuncsPackage  class.

##### getPF0CustomFuncRegistration()
```
public final int getPF0CustomFuncRegistration()
```

Gets the PF0CustomFuncRegistration.

**Returns:**
int - The PF0CustomFuncRegistration.
##### getPF1DisableShootingModes()
```
public final int getPF1DisableShootingModes()
```

Gets the PF1DisableShootingModes.

**Returns:**
int - The PF1DisableShootingModes.
##### getPF2DisableMeteringModes()
```
public final int getPF2DisableMeteringModes()
```

Gets the PF2DisableMeteringModes.

**Returns:**
int - The PF2DisableMeteringModes.
##### getPF3ManualExposureMetering()
```
public final int getPF3ManualExposureMetering()
```

Gets the PF3ManualExposureMetering.

**Returns:**
int - The PF3ManualExposureMetering.
##### getPF4ExposureTimeLimits()
```
public final int getPF4ExposureTimeLimits()
```

Gets the PF4ExposureTimeLimits.

**Returns:**
int - The PF4ExposureTimeLimits.
##### getPF5ApertureLimits()
```
public final int getPF5ApertureLimits()
```

Gets the PF5ApertureLimits.

**Returns:**
int - The PF5ApertureLimits.
##### getPF6PresetShootingModes()
```
public final int getPF6PresetShootingModes()
```

Gets the PF6PresetShootingModes.

**Returns:**
int - The PF6PresetShootingModes.
##### getPF7BracketContinuousShoot()
```
public final int getPF7BracketContinuousShoot()
```

Gets the PF7BracketContinuousShoot.

**Returns:**
int - The PF7BracketContinuousShoot.
##### getPF8SetBracketShots()
```
public final int getPF8SetBracketShots()
```

Gets the PF8SetBracketShots.

**Returns:**
int - The PF8SetBracketShots.
##### getPF9ChangeBracketSequence()
```
public final int getPF9ChangeBracketSequence()
```

Gets the PF9ChangeBracketSequence.

**Returns:**
int - The PF9ChangeBracketSequence.
##### getPF10RetainProgramShift()
```
public final int getPF10RetainProgramShift()
```

Gets the PF10RetainProgramShift.

**Returns:**
int - The PF10RetainProgramShift.
##### getPF13DrivePriority()
```
public final int getPF13DrivePriority()
```

Gets the PF13DrivePriority.

**Returns:**
int - The PF13DrivePriority.
##### getPF14DisableFocusSearch()
```
public final int getPF14DisableFocusSearch()
```

Gets the PF14DisableFocusSearch.

**Returns:**
int - The PF14DisableFocusSearch.
##### getPF15DisableAFAssistBeam()
```
public final int getPF15DisableAFAssistBeam()
```

Gets the PF15DisableAFAssistBeam.

**Returns:**
int - The PF15DisableAFAssistBeam.
##### getPF16AutoFocusPointShoot()
```
public final int getPF16AutoFocusPointShoot()
```

Gets the PF16AutoFocusPointShoot.

**Returns:**
int - The PF16AutoFocusPointShoot.
##### getPF17DisableAFPointSel()
```
public final int getPF17DisableAFPointSel()
```

Gets the PF17DisableAFPointSel.

**Returns:**
int - The PF17DisableAFPointSel.
##### getPF18EnableAutoAFPointSel()
```
public final int getPF18EnableAutoAFPointSel()
```

Gets the PF18EnableAutoAFPointSel.

**Returns:**
int - The PF18EnableAutoAFPointSel.
##### getPF19ContinuousShootSpeed()
```
public final int getPF19ContinuousShootSpeed()
```

Gets the PF19ContinuousShootSpeed.

**Returns:**
int - The PF19ContinuousShootSpeed.
##### getPF20LimitContinousShots()
```
public final int getPF20LimitContinousShots()
```

Gets the PF20LimitContinousShots.

**Returns:**
int - The PF20LimitContinousShots.
##### getPF21EnableQuietOperation()
```
public final int getPF21EnableQuietOperation()
```

Gets the PF21EnableQuietOperation.

**Returns:**
int - The PF21EnableQuietOperation.
##### getPF23SetTimerLengths()
```
public final int getPF23SetTimerLengths()
```

Gets the PF23SetTimerLengths.

**Returns:**
int - The PF23SetTimerLengths.
##### getPF24LightLCDDuringBulb()
```
public final int getPF24LightLCDDuringBulb()
```

Gets the PF24LightLCDDuringBulb.

**Returns:**
int - The PF24LightLCDDuringBulb.
##### getPF25DefaultClearSettings()
```
public final int getPF25DefaultClearSettings()
```

Gets the PF25DefaultClearSettings.

**Returns:**
int - The PF25DefaultClearSettings.
##### getPF26ShortenReleaseLag()
```
public final int getPF26ShortenReleaseLag()
```

Gets the PF26ShortenReleaseLag.

**Returns:**
int - The PF26ShortenReleaseLag.
##### getPF27ReverseDialRotation()
```
public final int getPF27ReverseDialRotation()
```

Gets the PF27ReverseDialRotation.

**Returns:**
int - The PF27ReverseDialRotation.
##### getPF28NoQuickDialExpComp()
```
public final int getPF28NoQuickDialExpComp()
```

Gets the PF28NoQuickDialExpComp.

**Returns:**
int - The PF28NoQuickDialExpComp.
##### getPF29QuickDialSwitchOff()
```
public final int getPF29QuickDialSwitchOff()
```

Gets the PF29QuickDialSwitchOff.

**Returns:**
int - The PF29QuickDialSwitchOff.
##### getPF30EnlargementMode()
```
public final int getPF30EnlargementMode()
```

Gets the PF30EnlargementMode.

**Returns:**
int - The PF30EnlargementMode.
##### getPF31OriginalDecisionData()
```
public final int getPF31OriginalDecisionData()
```

Gets the PF31OriginalDecisionData.

**Returns:**
int - The PF31OriginalDecisionData.

### Cr2PersonalFuncValuesPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2personalfuncvaluespackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PersonalFuncValuesPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PersonalFuncValuesPackage() | Initializes a new instance of the  Cr2PersonalFuncValuesPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPF1Value() | Gets the PF1Value. |
| getPF2Value() | Gets the PF2Value. |
| getPF3Value() | Gets the PF3Value. |
| getPF4ExposureTimeMin() | Gets the PF4ExposureTimeMin. |
| getPF4ExposureTimeMax() | Gets the PF4ExposureTimeMax. |
| getPF5ApertureMin() | Gets the PF5ApertureMin. |
| getPF5ApertureMax() | Gets the PF5ApertureMax. |
| getPF8BracketShots() | Gets the PF8BracketShots. |
| getPF19ShootingSpeedLow() | Gets the PF19ShootingSpeedLow. |
| getPF19ShootingSpeedHigh() | Gets the PF19ShootingSpeedHigh. |
| getPF20MaxContinousShots() | Gets the PF20MaxContinousShots. |
| getPF23ShutterButtonTime() | Gets the PF23ShutterButtonTime. |
| getPF23FELockTime() | Gets the PF23FELockTime. |
| getPF23PostReleaseTime() | Gets the PF23PostReleaseTime. |
| getPF25AEMode() | Gets the PF25AEMode. |
| getPF25MeteringMode() | Gets the PF25MeteringMode. |
| getPF25DriveMode() | Gets the PF25DriveMode. |
| getPF25AFMode() | Gets the PF25AFMode. |
| getPF25AFPointSel() | Gets the PF25AFPointSel. |
| getPF25ImageSize() | Gets the PF25ImageSize. |
| getPF25WBMode() | Gets the PF25WBMode. |
| getPF25Parameters() | Gets the PF25Parameters. |
| getPF25ColorMatrix() | Gets the PF25ColorMatrix. |
| getPF27Value() | Gets the PF27Value. |
##### Cr2PersonalFuncValuesPackage()
```
public Cr2PersonalFuncValuesPackage()
```

Initializes a new instance of the  Cr2PersonalFuncValuesPackage  class.

##### getPF1Value()
```
public final int getPF1Value()
```

Gets the PF1Value.

**Returns:**
int - The PF1Value.
##### getPF2Value()
```
public final int getPF2Value()
```

Gets the PF2Value.

**Returns:**
int - The PF2Value.
##### getPF3Value()
```
public final int getPF3Value()
```

Gets the PF3Value.

**Returns:**
int - The PF3Value.
##### getPF4ExposureTimeMin()
```
public final int getPF4ExposureTimeMin()
```

Gets the PF4ExposureTimeMin.

**Returns:**
int - The PF4ExposureTimeMin.
##### getPF4ExposureTimeMax()
```
public final int getPF4ExposureTimeMax()
```

Gets the PF4ExposureTimeMax.

**Returns:**
int - The PF4ExposureTimeMax.
##### getPF5ApertureMin()
```
public final int getPF5ApertureMin()
```

Gets the PF5ApertureMin.

**Returns:**
int - The PF5ApertureMin.
##### getPF5ApertureMax()
```
public final int getPF5ApertureMax()
```

Gets the PF5ApertureMax.

**Returns:**
int - The PF5ApertureMax.
##### getPF8BracketShots()
```
public final int getPF8BracketShots()
```

Gets the PF8BracketShots.

**Returns:**
int - The PF8BracketShots.
##### getPF19ShootingSpeedLow()
```
public final int getPF19ShootingSpeedLow()
```

Gets the PF19ShootingSpeedLow.

**Returns:**
int - The PF19ShootingSpeedLow.
##### getPF19ShootingSpeedHigh()
```
public final int getPF19ShootingSpeedHigh()
```

Gets the PF19ShootingSpeedHigh.

**Returns:**
int - The PF19ShootingSpeedHigh.
##### getPF20MaxContinousShots()
```
public final int getPF20MaxContinousShots()
```

Gets the PF20MaxContinousShots.

**Returns:**
int - The PF20MaxContinousShots.
##### getPF23ShutterButtonTime()
```
public final int getPF23ShutterButtonTime()
```

Gets the PF23ShutterButtonTime.

**Returns:**
int - The PF23ShutterButtonTime.
##### getPF23FELockTime()
```
public final int getPF23FELockTime()
```

Gets the PF23FELockTime.

**Returns:**
int - The PF23FELockTime.
##### getPF23PostReleaseTime()
```
public final int getPF23PostReleaseTime()
```

Gets the PF23PostReleaseTime.

**Returns:**
int - The PF23PostReleaseTime.
##### getPF25AEMode()
```
public final int getPF25AEMode()
```

Gets the PF25AEMode.

**Returns:**
int - The PF25AEMode.
##### getPF25MeteringMode()
```
public final int getPF25MeteringMode()
```

Gets the PF25MeteringMode.

**Returns:**
int - The PF25MeteringMode.
##### getPF25DriveMode()
```
public final int getPF25DriveMode()
```

Gets the PF25DriveMode.

**Returns:**
int - The PF25DriveMode.
##### getPF25AFMode()
```
public final int getPF25AFMode()
```

Gets the PF25AFMode.

**Returns:**
int - The PF25AFMode.
##### getPF25AFPointSel()
```
public final int getPF25AFPointSel()
```

Gets the PF25AFPointSel.

**Returns:**
int - The PF25AFPointSel.
##### getPF25ImageSize()
```
public final int getPF25ImageSize()
```

Gets the PF25ImageSize.

**Returns:**
int - The PF25ImageSize.
##### getPF25WBMode()
```
public final int getPF25WBMode()
```

Gets the PF25WBMode.

**Returns:**
int - The PF25WBMode.
##### getPF25Parameters()
```
public final int getPF25Parameters()
```

Gets the PF25Parameters.

**Returns:**
int - The PF25Parameters.
##### getPF25ColorMatrix()
```
public final int getPF25ColorMatrix()
```

Gets the PF25ColorMatrix.

**Returns:**
int - The PF25ColorMatrix.
##### getPF27Value()
```
public final int getPF27Value()
```

Gets the PF27Value.

**Returns:**
int - The PF27Value.

### Cr2ProcessingPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2processingpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ProcessingPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ProcessingPackage() | Initializes a new instance of the  Cr2ProcessingPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getToneCurve() | Gets the ToneCurve. |
| getSharpness() | Gets the Sharpness. |
| getSharpnessFrequency() | Gets the SharpnessFrequency. |
| getSensorRedLevel() | Gets the SensorRedLevel. |
| getSensorBlueLevel() | Gets the SensorBlueLevel. |
| getWhiteBalanceRed() | Gets the WhiteBalanceRed. |
| getWhiteBalanceBlue() | Gets the WhiteBalanceBlue. |
| getWhiteBalance() | Gets the WhiteBalance. |
| getColorTemperature() | Gets the ColorTemperature. |
| getPictureStyle() | Gets the PictureStyle. |
| getDigitalGain() | Gets the DigitalGain. |
| getWBShiftAB() | Gets the WBShiftAB. |
| getWBShiftGM() | Gets the WBShiftGM. |
##### Cr2ProcessingPackage()
```
public Cr2ProcessingPackage()
```

Initializes a new instance of the  Cr2ProcessingPackage  class.

##### getToneCurve()
```
public final int getToneCurve()
```

Gets the ToneCurve.

**Returns:**
int - The ToneCurve.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getSharpnessFrequency()
```
public final int getSharpnessFrequency()
```

Gets the SharpnessFrequency.

**Returns:**
int - The SharpnessFrequency.
##### getSensorRedLevel()
```
public final int getSensorRedLevel()
```

Gets the SensorRedLevel.

**Returns:**
int - The SensorRedLevel.
##### getSensorBlueLevel()
```
public final int getSensorBlueLevel()
```

Gets the SensorBlueLevel.

**Returns:**
int - The SensorBlueLevel.
##### getWhiteBalanceRed()
```
public final int getWhiteBalanceRed()
```

Gets the WhiteBalanceRed.

**Returns:**
int - The WhiteBalanceRed.
##### getWhiteBalanceBlue()
```
public final int getWhiteBalanceBlue()
```

Gets the WhiteBalanceBlue.

**Returns:**
int - The WhiteBalanceBlue.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the WhiteBalance.

**Returns:**
int - The WhiteBalance.
##### getColorTemperature()
```
public final int getColorTemperature()
```

Gets the ColorTemperature.

**Returns:**
int - The ColorTemperature.
##### getPictureStyle()
```
public final int getPictureStyle()
```

Gets the PictureStyle.

**Returns:**
int - The PictureStyle.
##### getDigitalGain()
```
public final int getDigitalGain()
```

Gets the DigitalGain.

**Returns:**
int - The DigitalGain.
##### getWBShiftAB()
```
public final int getWBShiftAB()
```

Gets the WBShiftAB.

**Returns:**
int - The WBShiftAB.
##### getWBShiftGM()
```
public final int getWBShiftGM()
```

Gets the WBShiftGM.

**Returns:**
int - The WBShiftGM.

### Cr2RootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class Cr2RootPackage extends RootMetadataPackage
```

Represents an entry point to all metadata packages presented in a particular file CR2.
#### Methods

| Method | Description |
| --- | --- |
| getCr2Package() | Gets the CR2 header metadata package. |
##### getCr2Package()
```
public final Cr2Package getCr2Package()
```

Gets the CR2 header metadata package.

**Returns:**
Cr2Package - The CR2 header metadata package.

### Cr2SensorInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2sensorinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2SensorInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2SensorInfoPackage() | Initializes a new instance of the  Cr2SensorInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSensorWidth() | Gets the SensorWidth. |
| getSensorHeight() | Gets the SensorHeight. |
| getSensorLeftBorder() | Gets the SensorLeftBorder. |
| getSensorTopBorder() | Gets the SensorTopBorder. |
| getSensorRightBorder() | Gets the SensorRightBorder. |
| getSensorBottomBorder() | Gets the SensorBottomBorder. |
| getBlackMaskLeftBorder() | Gets the BlackMaskLeftBorder. |
| getBlackMaskTopBorder() | Gets the BlackMaskTopBorder. |
| getBlackMaskRightBorder() | Gets the BlackMaskRightBorder. |
| getBlackMaskBottomBorder() | Gets the BlackMaskBottomBorder. |
##### Cr2SensorInfoPackage()
```
public Cr2SensorInfoPackage()
```

Initializes a new instance of the  Cr2SensorInfoPackage  class.

##### getSensorWidth()
```
public final int getSensorWidth()
```

Gets the SensorWidth.

**Returns:**
int - The SensorWidth.
##### getSensorHeight()
```
public final int getSensorHeight()
```

Gets the SensorHeight.

**Returns:**
int - The SensorHeight.
##### getSensorLeftBorder()
```
public final int getSensorLeftBorder()
```

Gets the SensorLeftBorder.

**Returns:**
int - The SensorLeftBorder.
##### getSensorTopBorder()
```
public final int getSensorTopBorder()
```

Gets the SensorTopBorder.

**Returns:**
int - The SensorTopBorder.
##### getSensorRightBorder()
```
public final int getSensorRightBorder()
```

Gets the SensorRightBorder.

**Returns:**
int - The SensorRightBorder.
##### getSensorBottomBorder()
```
public final int getSensorBottomBorder()
```

Gets the SensorBottomBorder.

**Returns:**
int - The SensorBottomBorder.
##### getBlackMaskLeftBorder()
```
public final int getBlackMaskLeftBorder()
```

Gets the BlackMaskLeftBorder.

**Returns:**
int - The BlackMaskLeftBorder.
##### getBlackMaskTopBorder()
```
public final int getBlackMaskTopBorder()
```

Gets the BlackMaskTopBorder.

**Returns:**
int - The BlackMaskTopBorder.
##### getBlackMaskRightBorder()
```
public final int getBlackMaskRightBorder()
```

Gets the BlackMaskRightBorder.

**Returns:**
int - The BlackMaskRightBorder.
##### getBlackMaskBottomBorder()
```
public final int getBlackMaskBottomBorder()
```

Gets the BlackMaskBottomBorder.

**Returns:**
int - The BlackMaskBottomBorder.

### Cr2ShotInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2shotinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ShotInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ShotInfoPackage() | Initializes a new instance of the  Cr2ShotInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAutoISO() | Gets the AutoISO. |
| getBaseISO() | Gets the BaseISO. |
| getMeasuredEV() | Gets the MeasuredEV. |
| getTargetAperture() | Gets the TargetAperture. |
| getTargetExposureTime() | Gets the TargetExposureTime. |
| getExposureCompensation() | Gets the ExposureCompensation. |
| getWhiteBalance() | Gets the WhiteBalance. |
| getSlowShutter() | Gets the SlowShutter. |
| getSequenceNumber() | Gets the SequenceNumber. |
| getOpticalZoomCode() | Gets the OpticalZoomCode. |
| getCameraTemperature() | Gets the CameraTemperature. |
| getFlashGuideNumber() | Gets the FlashGuideNumber. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getFlashExposureComp() | Gets the FlashExposureComp. |
| getAutoExposureBracketing() | Gets the AutoExposureBracketing. |
| getAEBBracketValue() | Gets the AEBBracketValue. |
| getControlMode() | Gets the ControlMode. |
| getFocusDistanceUpper() | Gets the FocusDistanceUpper. |
| getFocusDistanceLower() | Gets the FocusDistanceLower. |
| getFNumber() | Gets the FNumber. |
| getExposureTime() | Gets the ExposureTime. |
| getMeasuredEV2() | Gets the MeasuredEV2. |
| getBulbDuration() | Gets the BulbDuration. |
| getCameraType() | Gets the CameraType. |
| getAutoRotate() | Gets the AutoRotate. |
| getNDFilter() | Gets the NDFilter. |
| getSelfTimer2() | Gets the SelfTimer2. |
| getFlashOutput() | Gets the FlashOutput. |
##### Cr2ShotInfoPackage()
```
public Cr2ShotInfoPackage()
```

Initializes a new instance of the  Cr2ShotInfoPackage  class.

##### getAutoISO()
```
public final int getAutoISO()
```

Gets the AutoISO.

**Returns:**
int - The AutoISO.
##### getBaseISO()
```
public final int getBaseISO()
```

Gets the BaseISO.

**Returns:**
int - The BaseISO.
##### getMeasuredEV()
```
public final int getMeasuredEV()
```

Gets the MeasuredEV.

**Returns:**
int - The MeasuredEV.
##### getTargetAperture()
```
public final int getTargetAperture()
```

Gets the TargetAperture.

**Returns:**
int - The TargetAperture.
##### getTargetExposureTime()
```
public final int getTargetExposureTime()
```

Gets the TargetExposureTime.

**Returns:**
int - The TargetExposureTime.
##### getExposureCompensation()
```
public final int getExposureCompensation()
```

Gets the ExposureCompensation.

**Returns:**
int - The ExposureCompensation.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the WhiteBalance.

**Returns:**
int - The WhiteBalance.
##### getSlowShutter()
```
public final int getSlowShutter()
```

Gets the SlowShutter.

**Returns:**
int - The SlowShutter.
##### getSequenceNumber()
```
public final int getSequenceNumber()
```

Gets the SequenceNumber.

**Returns:**
int - The SequenceNumber.
##### getOpticalZoomCode()
```
public final int getOpticalZoomCode()
```

Gets the OpticalZoomCode.

**Returns:**
int - The OpticalZoomCode.
##### getCameraTemperature()
```
public final int getCameraTemperature()
```

Gets the CameraTemperature.

**Returns:**
int - The CameraTemperature.
##### getFlashGuideNumber()
```
public final int getFlashGuideNumber()
```

Gets the FlashGuideNumber.

**Returns:**
int - The FlashGuideNumber.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getFlashExposureComp()
```
public final int getFlashExposureComp()
```

Gets the FlashExposureComp.

**Returns:**
int - The FlashExposureComp.
##### getAutoExposureBracketing()
```
public final int getAutoExposureBracketing()
```

Gets the AutoExposureBracketing.

**Returns:**
int - The AutoExposureBracketing.
##### getAEBBracketValue()
```
public final int getAEBBracketValue()
```

Gets the AEBBracketValue.

**Returns:**
int - The AEBBracketValue.
##### getControlMode()
```
public final int getControlMode()
```

Gets the ControlMode.

**Returns:**
int - The ControlMode.
##### getFocusDistanceUpper()
```
public final int getFocusDistanceUpper()
```

Gets the FocusDistanceUpper.

**Returns:**
int - The FocusDistanceUpper.
##### getFocusDistanceLower()
```
public final int getFocusDistanceLower()
```

Gets the FocusDistanceLower.

**Returns:**
int - The FocusDistanceLower.
##### getFNumber()
```
public final int getFNumber()
```

Gets the FNumber.

**Returns:**
int - The FNumber.
##### getExposureTime()
```
public final int getExposureTime()
```

Gets the ExposureTime.

**Returns:**
int - The ExposureTime.
##### getMeasuredEV2()
```
public final int getMeasuredEV2()
```

Gets the MeasuredEV2.

**Returns:**
int - The MeasuredEV2.
##### getBulbDuration()
```
public final int getBulbDuration()
```

Gets the BulbDuration.

**Returns:**
int - The BulbDuration.
##### getCameraType()
```
public final int getCameraType()
```

Gets the CameraType.

**Returns:**
int - The CameraType.
##### getAutoRotate()
```
public final int getAutoRotate()
```

Gets the AutoRotate.

**Returns:**
int - The AutoRotate.
##### getNDFilter()
```
public final int getNDFilter()
```

Gets the NDFilter.

**Returns:**
int - The NDFilter.
##### getSelfTimer2()
```
public final int getSelfTimer2()
```

Gets the SelfTimer2.

**Returns:**
int - The SelfTimer2.
##### getFlashOutput()
```
public final int getFlashOutput()
```

Gets the FlashOutput.

**Returns:**
int - The FlashOutput.

### Cr2TimeInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2timeinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2TimeInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2TimeInfoPackage() | Initializes a new instance of the  Cr2TimeInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTimeZone() | Gets the TimeZone. |
| getTimeZoneCity() | Gets the TimeZoneCity. |
| getDaylightSavings() | Gets the DaylightSavings. |
##### Cr2TimeInfoPackage()
```
public Cr2TimeInfoPackage()
```

Initializes a new instance of the  Cr2TimeInfoPackage  class.

##### getTimeZone()
```
public final int getTimeZone()
```

Gets the TimeZone.

**Returns:**
int - The TimeZone.
##### getTimeZoneCity()
```
public final int getTimeZoneCity()
```

Gets the TimeZoneCity.

**Returns:**
int - The TimeZoneCity.
##### getDaylightSavings()
```
public final int getDaylightSavings()
```

Gets the DaylightSavings.

**Returns:**
int - The DaylightSavings.

### Cr2VignettingCorr2Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2vignettingcorr2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2VignettingCorr2Package extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2VignettingCorr2Package() | Initializes a new instance of the  Cr2VignettingCorr2Package  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPeripheralLightingSetting() | Gets the PeripheralLightingSetting. |
| getChromaticAberrationSetting() | Gets the ChromaticAberrationSetting. |
| getDistortionCorrectionSetting() | Gets the DistortionCorrectionSetting. |
| getDigitalLensOptimizerSetting() | Gets the DigitalLensOptimizerSetting. |
##### Cr2VignettingCorr2Package()
```
public Cr2VignettingCorr2Package()
```

Initializes a new instance of the  Cr2VignettingCorr2Package  class.

##### getPeripheralLightingSetting()
```
public final int getPeripheralLightingSetting()
```

Gets the PeripheralLightingSetting.

**Returns:**
int - The PeripheralLightingSetting.
##### getChromaticAberrationSetting()
```
public final int getChromaticAberrationSetting()
```

Gets the ChromaticAberrationSetting.

**Returns:**
int - The ChromaticAberrationSetting.
##### getDistortionCorrectionSetting()
```
public final int getDistortionCorrectionSetting()
```

Gets the DistortionCorrectionSetting.

**Returns:**
int - The DistortionCorrectionSetting.
##### getDigitalLensOptimizerSetting()
```
public final int getDigitalLensOptimizerSetting()
```

Gets the DigitalLensOptimizerSetting.

**Returns:**
int - The DigitalLensOptimizerSetting.

### Cr2WBInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/cr2wbinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2WBInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2WBInfoPackage() | Initializes a new instance of the  Cr2WBInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWB_GRBGLevelsAuto() | Gets the WB\_GRBGLevelsAuto. |
| getWB_GRBGLevelsDaylight() | Gets the WB\_GRBGLevelsDaylight. |
| getWB_GRBGLevelsCloudy() | Gets the WB\_GRBGLevelsCloudy. |
| getWB_GRBGLevelsTungsten() | Gets the WB\_GRBGLevelsTungsten. |
| getWB_GRBGLevelsFluorescent() | Gets the WB\_GRBGLevelsFluorescent. |
| getWB_GRBGLevelsFluorHigh() | Gets the WB\_GRBGLevelsFluorHigh. |
| getWB_GRBGLevelsFlash() | Gets the WB\_GRBGLevelsFlash. |
| getWB_GRBGLevelsUnderwater() | Gets the WB\_GRBGLevelsUnderwater. |
| getWB_GRBGLevelsCustom1() | Gets the WB\_GRBGLevelsCustom1. |
| getWB_GRBGLevelsCustom2() | Gets the WB\_GRBGLevelsCustom2. |
##### Cr2WBInfoPackage()
```
public Cr2WBInfoPackage()
```

Initializes a new instance of the  Cr2WBInfoPackage  class.

##### getWB_GRBGLevelsAuto()
```
public final int[] getWB_GRBGLevelsAuto()
```

Gets the WB\_GRBGLevelsAuto.

**Returns:**
int[] - The WB\_GRBGLevelsAuto.
##### getWB_GRBGLevelsDaylight()
```
public final int[] getWB_GRBGLevelsDaylight()
```

Gets the WB\_GRBGLevelsDaylight.

**Returns:**
int[] - The WB\_GRBGLevelsDaylight.
##### getWB_GRBGLevelsCloudy()
```
public final int[] getWB_GRBGLevelsCloudy()
```

Gets the WB\_GRBGLevelsCloudy.

**Returns:**
int[] - The WB\_GRBGLevelsCloudy.
##### getWB_GRBGLevelsTungsten()
```
public final int[] getWB_GRBGLevelsTungsten()
```

Gets the WB\_GRBGLevelsTungsten.

**Returns:**
int[] - The WB\_GRBGLevelsTungsten.
##### getWB_GRBGLevelsFluorescent()
```
public final int[] getWB_GRBGLevelsFluorescent()
```

Gets the WB\_GRBGLevelsFluorescent.

**Returns:**
int[] - The WB\_GRBGLevelsFluorescent.
##### getWB_GRBGLevelsFluorHigh()
```
public final int[] getWB_GRBGLevelsFluorHigh()
```

Gets the WB\_GRBGLevelsFluorHigh.

**Returns:**
int[] - The WB\_GRBGLevelsFluorHigh.
##### getWB_GRBGLevelsFlash()
```
public final int[] getWB_GRBGLevelsFlash()
```

Gets the WB\_GRBGLevelsFlash.

**Returns:**
int[] - The WB\_GRBGLevelsFlash.
##### getWB_GRBGLevelsUnderwater()
```
public final int[] getWB_GRBGLevelsUnderwater()
```

Gets the WB\_GRBGLevelsUnderwater.

**Returns:**
int[] - The WB\_GRBGLevelsUnderwater.
##### getWB_GRBGLevelsCustom1()
```
public final int[] getWB_GRBGLevelsCustom1()
```

Gets the WB\_GRBGLevelsCustom1.

**Returns:**
int[] - The WB\_GRBGLevelsCustom1.
##### getWB_GRBGLevelsCustom2()
```
public final int[] getWB_GRBGLevelsCustom2()
```

Gets the WB\_GRBGLevelsCustom2.

**Returns:**
int[] - The WB\_GRBGLevelsCustom2.

### CustomPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/custompackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage
```
public abstract class CustomPackage extends MetadataPackage
```

Provides a container for metadata properties.

### DiagramFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/diagramformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum DiagramFormat extends Enum<DiagramFormat> implements IEnumValue
```

Defines various diagram subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Vdx | Represents the .VDX Visio format. |
| Vsd | Represents the .VSD Visio format. |
| Vsdx | Represents the .VSDX Visio format. |
| Vss | Represents the .VSS Visio format. |
| Vsx | Represents the .VSX Visio format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final DiagramFormat Unknown
```

The format is not recognized.

##### Vdx
```
public static final DiagramFormat Vdx
```

Represents the .VDX Visio format. 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/

##### Vsd
```
public static final DiagramFormat Vsd
```

Represents the .VSD Visio format. VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Such drawings can contain visual objects such as visual objects, flow charts, UML diagram, information flow, organizational charts, software diagrams, network layout, database models, objects mapping and other similar information. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/vsd/

##### Vsdx
```
public static final DiagramFormat Vsdx
```

Represents the .VSDX Visio format. 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 DiagramFormat Vss
```

Represents the .VSS Visio format. VSS are stencil files created with Microsoft Visio 2007 and earlier. A relatively new file format is .VSSX that was introduced with Microsoft Visio 2013. 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/

##### Vsx
```
public static final DiagramFormat Vsx
```

Represents the .VSX Visio format. 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/

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

**Returns:**
com.groupdocs.metadata.core.DiagramFormat[]
##### valueOf(String name)
```
public static DiagramFormat valueOf(String name)
```

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

**Returns:**
DiagramFormat
##### getByRawValue(int rawValue)
```
public static DiagramFormat getByRawValue(int rawValue)
```

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

**Returns:**
DiagramFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### DiagramPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/diagrampackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class DiagramPackage extends DocumentPackage
```

Represents a native metadata package in a diagram format.

The following code sample demonstrates how to update built-in metadata properties in a diagram document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputVdx)) {
>      DiagramRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setCreator("test author");
>      root.getDocumentProperties().setTimeCreated(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputVdx);
>  }
>
> ```
> ```

[Working with metadata in Diagrams]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Diagrams
#### Methods

| Method | Description |
| --- | --- |
| getAlternateNames() | Gets the alternate names for the document. |
| setAlternateNames(String value) | Sets the alternate names for the document. |
| getBuildNumberCreated() | Gets the full build number of the instance used to create the document. |
| getBuildNumberEdited() | Gets the build number of the instance last used to edit the document. |
| getCategory() | Gets the descriptive text for the type of drawing, such as flowchart or office layout. |
| setCategory(String value) | Sets the descriptive text for the type of drawing, such as flowchart or office layout. |
| getCompany() | Gets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. |
| setCompany(String value) | Sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. |
| getCreator() | Gets the person who created or last updated the file. |
| setCreator(String value) | Sets the person who created or last updated the file. |
| getDescription() | Gets a descriptive text string for the document. |
| setDescription(String value) | Sets a descriptive text string for the document. |
| getHyperlinkBase() | Gets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). |
| setHyperlinkBase(String value) | Sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). |
| getKeywords() | Gets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. |
| setKeywords(String value) | Sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. |
| getLanguage() | Gets the language of the document. |
| setLanguage(String value) | Sets the language of the document. |
| getManager() | Gets a user-entered text string identifying the person in charge of the project or department. |
| setManager(String value) | Sets a user-entered text string identifying the person in charge of the project or department. |
| getPreviewPicture() | Gets the preview picture. |
| setPreviewPicture(byte[] value) | Sets the preview picture. |
| getSubject() | Gets a user-defined text string that describes the contents of the document. |
| setSubject(String value) | Sets a user-defined text string that describes the contents of the document. |
| getTemplate() | Gets a string value specifying the file name of the template from which the document was created. |
| setTemplate(String value) | Sets a string value specifying the file name of the template from which the document was created. |
| getTimeCreated() | Gets a date and time value indicating when the document was created. |
| setTimeCreated(Date value) | Sets a date and time value indicating when the document was created. |
| getTimeEdited() | Gets a date and time value indicating when the document was last edited. |
| getTimePrinted() | Gets a date and time value indicating when the document was last printed. |
| getTimeSaved() | Gets a date and time value indicating when the document was last saved. |
| getTitle() | Gets a user-defined text string that serves as a descriptive title for the document. |
| setTitle(String value) | Sets a user-defined text string that serves as a descriptive title for the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
##### getAlternateNames()
```
public final String getAlternateNames()
```

Gets the alternate names for the document. Can be updated in VDX and VSX formats only.

**Returns:**
java.lang.String - The alternate names for the document.
##### setAlternateNames(String value)
```
public final void setAlternateNames(String value)
```

Sets the alternate names for the document. Can be updated in VDX and VSX formats only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The alternate names for the document. |

##### getBuildNumberCreated()
```
public final String getBuildNumberCreated()
```

Gets the full build number of the instance used to create the document.

**Returns:**
java.lang.String - The full build number of the instance used to create the document.
##### getBuildNumberEdited()
```
public final String getBuildNumberEdited()
```

Gets the build number of the instance last used to edit the document.

**Returns:**
java.lang.String - The build number of the instance last used to edit the document.
##### getCategory()
```
public final String getCategory()
```

Gets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.

**Returns:**
java.lang.String - The descriptive text for the type of drawing, such as flowchart or office layout.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive text for the type of drawing, such as flowchart or office layout. |

##### getCompany()
```
public final String getCompany()
```

Gets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

**Returns:**
java.lang.String - The user-entered information identifying the company creating the drawing or the company the drawing is being created for.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user-entered information identifying the company creating the drawing or the company the drawing is being created for. |

##### getCreator()
```
public final String getCreator()
```

Gets the person who created or last updated the file. The maximum length is 63 characters..

**Returns:**
java.lang.String - The person who created or last updated the file.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Sets the person who created or last updated the file. The maximum length is 63 characters..

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The person who created or last updated the file. |

##### getDescription()
```
public final String getDescription()
```

Gets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.

**Returns:**
java.lang.String - A descriptive text string for the document.
##### setDescription(String value)
```
public final void setDescription(String value)
```

Sets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A descriptive text string for the document. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.

**Returns:**
java.lang.String - The path to be used for relative hyperlinks.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The path to be used for relative hyperlinks. |

##### getKeywords()
```
public final String getKeywords()
```

Gets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.

**Returns:**
java.lang.String - A text string that identifies topics or other important information about the file, such as project name, client name, or version number.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A text string that identifies topics or other important information about the file, such as project name, client name, or version number. |

##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the document. Can be updated in VSD and VSDX formats only.

**Returns:**
java.lang.String - The language of the document.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the language of the document. Can be updated in VSD and VSDX formats only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language of the document. |

##### getManager()
```
public final String getManager()
```

Gets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

**Returns:**
java.lang.String - A user-entered text string identifying the person in charge of the project or department.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-entered text string identifying the person in charge of the project or department. |

##### getPreviewPicture()
```
public final byte[] getPreviewPicture()
```

Gets the preview picture.

**Returns:**
byte[] - The preview picture.
##### setPreviewPicture(byte[] value)
```
public final void setPreviewPicture(byte[] value)
```

Sets the preview picture.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The preview picture. |

##### getSubject()
```
public final String getSubject()
```

Gets a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

**Returns:**
java.lang.String - A user-defined text string that describes the contents of the document.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-defined text string that describes the contents of the document. |

##### getTemplate()
```
public final String getTemplate()
```

Gets a string value specifying the file name of the template from which the document was created.

**Returns:**
java.lang.String - A string value specifying the file name of the template from which the document was created.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets a string value specifying the file name of the template from which the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A string value specifying the file name of the template from which the document was created. |

##### getTimeCreated()
```
public final Date getTimeCreated()
```

Gets a date and time value indicating when the document was created.

**Returns:**
java.util.Date - A date and time value indicating when the document was created.
##### setTimeCreated(Date value)
```
public final void setTimeCreated(Date value)
```

Sets a date and time value indicating when the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | A date and time value indicating when the document was created. |

##### getTimeEdited()
```
public final Date getTimeEdited()
```

Gets a date and time value indicating when the document was last edited.

**Returns:**
java.util.Date - A date and time value indicating when the document was last edited.
##### getTimePrinted()
```
public final Date getTimePrinted()
```

Gets a date and time value indicating when the document was last printed.

**Returns:**
java.util.Date - A date and time value indicating when the document was last printed.
##### getTimeSaved()
```
public final Date getTimeSaved()
```

Gets a date and time value indicating when the document was last saved.

**Returns:**
java.util.Date - A date and time value indicating when the document was last saved.
##### getTitle()
```
public final String getTitle()
```

Gets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

**Returns:**
java.lang.String - A user-defined text string that serves as a descriptive title for the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-defined text string that serves as a descriptive title for the document. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

### DiagramRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/diagramrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class DiagramRootPackage extends DocumentRootPackage<DiagramPackage>
```

Represents the root package intended to work with metadata in a diagram.

This code sample demonstrates how to extract built-in metadata properties from a diagram.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      DiagramRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getCreator());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLanguage());
>      System.out.println(root.getDocumentProperties().getTimeCreated());
>      System.out.println(root.getDocumentProperties().getCategory());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Diagrams]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Diagrams
#### Methods

| Method | Description |
| --- | --- |
| getDiagramType() | Gets the file type metadata package. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getDiagramType()
```
public final DiagramTypePackage getDiagramType()
```

Gets the file type metadata package.

**Returns:**
DiagramTypePackage - The file type metadata package.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### DiagramTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/diagramtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class DiagramTypePackage extends FileTypePackage
```

Represents a metadata package containing diagram-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getDiagramFormat() | Gets the exact diagram format. |
##### getDiagramFormat()
```
public final DiagramFormat getDiagramFormat()
```

Gets the exact diagram format.

**Returns:**
DiagramFormat - The exact diagram format.

### DicomPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dicompackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DicomPackage extends CustomPackage
```

Represents native DICOM metadata.

[Working with DICOM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DICOM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DicomPackage() | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getHeaderOffset() | Gets the header offset. |
| getHeaderBytes() | Gets the header information by bytes. |
| getBitsAllocated() | Gets the bits allocated value. |
| getDicomInfo() | Gets the header information of the DICOM file. |
| getBlues() | Gets the array colors of the blue. |
| getGreens() | Gets the array colors of the green. |
| getReds() | Gets the array colors of the red. |
| getNumberOfFrames() | Gets the number of frames. |
##### DicomPackage()
```
public DicomPackage()
```

Initializes a new instance of the  Metadata  class.

##### getHeaderOffset()
```
public final int getHeaderOffset()
```

Gets the header offset.

Value: The header offset.

**Returns:**
int
##### getHeaderBytes()
```
public final Byte[] getHeaderBytes()
```

Gets the header information by bytes.

Value: The header bytes.

**Returns:**
java.lang.Byte[]
##### getBitsAllocated()
```
public final int getBitsAllocated()
```

Gets the bits allocated value.

**Returns:**
int - The bits allocated.
##### getDicomInfo()
```
public final String[] getDicomInfo()
```

Gets the header information of the DICOM file.

**Returns:**
java.lang.String[] - The dicom header information.
##### getBlues()
```
public final byte[] getBlues()
```

Gets the array colors of the blue.

**Returns:**
byte[] - The blue colors.
##### getGreens()
```
public final byte[] getGreens()
```

Gets the array colors of the green.

**Returns:**
byte[] - The green colors.
##### getReds()
```
public final byte[] getReds()
```

Gets the array colors of the red.

**Returns:**
byte[] - The red colors.
##### getNumberOfFrames()
```
public final int getNumberOfFrames()
```

Gets the number of frames.

**Returns:**
int - The number of frames.

### DicomRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dicomrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DicomRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a DICOM image.

This example demonstrates how to read DICOM format-specific metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDicom)) {
>      DicomRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getDicomPackage() != null) {
>          System.out.println(root.getDicomPackage().getBitsAllocated());
>          System.out.println(root.getDicomPackage().getReds());
>          System.out.println(root.getDicomPackage().getGreens());
>          System.out.println(root.getDicomPackage().getBlues());
>          System.out.println(root.getDicomPackage().getNumberOfFrames());
>          // ...
>      }
>  }
>
> ```
> ```

[Working with DICOM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DICOM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getDicomPackage() | Gets the DICOM native metadata package. |
##### getDicomPackage()
```
public final DicomPackage getDicomPackage()
```

Gets the DICOM native metadata package.

**Returns:**
DicomPackage - The DICOM native metadata package.

### DigitalSignature
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/digitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class DigitalSignature extends CustomPackage
```

Represents a digital signature used to sign a document.
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the signing purpose comment. |
| isValid() | Gets a value indicating whether the signature is valid. |
| getSignTime() | Gets the time the document was signed. |
| getCertificateSubject() | Gets the subject distinguished name from a certificate. |
| getCertificateRawData() | Gets the certificate raw data. |
##### getComments()
```
public final String getComments()
```

Gets the signing purpose comment.

**Returns:**
java.lang.String - The signing purpose comment.
##### isValid()
```
public Boolean isValid()
```

Gets a value indicating whether the signature is valid.

**Returns:**
java.lang.Boolean - True if the the signature is valid; otherwise, false. Null indicates that validation is unavailable for the signature.
##### getSignTime()
```
public Date getSignTime()
```

Gets the time the document was signed.

**Returns:**
java.util.Date - The time the document was signed.
##### getCertificateSubject()
```
public final String getCertificateSubject()
```

Gets the subject distinguished name from a certificate.

**Returns:**
java.lang.String - The subject distinguished name from a certificate.
##### getCertificateRawData()
```
public final byte[] getCertificateRawData()
```

Gets the certificate raw data.

**Returns:**
byte[] - The certificate raw data.

### DisposableWrapper
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/disposablewrapper.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IDisposable
```
public abstract class DisposableWrapper<T> implements System.IDisposable
```
#### Methods

| Method | Description |
| --- | --- |
| dispose() |  |
##### dispose()
```
public void dispose()
```

### DjVuRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/djvurootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DjVuRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in an DjVu image.

### DngPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dngpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DngPackage extends CustomPackage
```

Represents native DNG metadata.

[Working with DNG metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DNG+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DngPackage() | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCameraManufacturer() | Gets the camera manufacturer. |
| getColorsCount() | Gets the colors. |
| getDescription() | Gets the description of colors (RGBG,RGBE,GMCY, or GBTG). |
| getDngVersion() | Gets the DNG version. |
| getFilters() | Gets the Bit mask describing the order of color pixels in the matrix. |
| isFoveon() | Gets the is foveon matrix. |
| getModel() | Gets the camera model. |
| getRawCount() | Gets the number of RAW images in file (0 means that the file has not been recognized). |
| getSoftware() | Gets the software. |
| getTranslationCfaDng() | Gets the translation array for CFA mosaic DNG format. |
| getAperture() | Gets the aperture. |
| getArtist() | Gets the author of image. |
| getFocalLength() | Gets the length of the focal. |
| getGpsData() | Gets the GPS data. |
| getIsoSpeed() | Gets the ISO sensitivity. |
| getShotOrder() | Gets serial number of image. |
| getShutterSpeed() | Gets the shutter speed. |
| getTimestamp() | Gets the date of shooting. |
##### DngPackage()
```
public DngPackage()
```

Initializes a new instance of the  Metadata  class.

##### getCameraManufacturer()
```
public final String getCameraManufacturer()
```

Gets the camera manufacturer.

**Returns:**
java.lang.String - The make.
##### getColorsCount()
```
public final int getColorsCount()
```

Gets the colors.

**Returns:**
int - The colors.
##### getDescription()
```
public final String getDescription()
```

Gets the description of colors (RGBG,RGBE,GMCY, or GBTG).

**Returns:**
java.lang.String - The cdesc.
##### getDngVersion()
```
public final long getDngVersion()
```

Gets the DNG version.

**Returns:**
long - The DNG version.
##### getFilters()
```
public final long getFilters()
```

Gets the Bit mask describing the order of color pixels in the matrix.

**Returns:**
long - The filters.
##### isFoveon()
```
public final long isFoveon()
```

Gets the is foveon matrix.

**Returns:**
long - The is foveon.
##### getModel()
```
public final String getModel()
```

Gets the camera model.

**Returns:**
java.lang.String - The model.
##### getRawCount()
```
public final long getRawCount()
```

Gets the number of RAW images in file (0 means that the file has not been recognized).

**Returns:**
long - The raw count.
##### getSoftware()
```
public final String getSoftware()
```

Gets the software.

**Returns:**
java.lang.String - The software.
##### getTranslationCfaDng()
```
public final String[] getTranslationCfaDng()
```

Gets the translation array for CFA mosaic DNG format.

**Returns:**
java.lang.String[] - The xtrans.
##### getAperture()
```
public final float getAperture()
```

Gets the aperture.

**Returns:**
float - The aperture.
##### getArtist()
```
public final String getArtist()
```

Gets the author of image.

**Returns:**
java.lang.String - The artist.
##### getFocalLength()
```
public final float getFocalLength()
```

Gets the length of the focal.

**Returns:**
float - The length of the focal.
##### getGpsData()
```
public final long[] getGpsData()
```

Gets the GPS data.

**Returns:**
long[] - The GPS data.
##### getIsoSpeed()
```
public final float getIsoSpeed()
```

Gets the ISO sensitivity.

**Returns:**
float - The ISO speed.
##### getShotOrder()
```
public final long getShotOrder()
```

Gets serial number of image.

**Returns:**
long - The shot order.
##### getShutterSpeed()
```
public final float getShutterSpeed()
```

Gets the shutter speed.

**Returns:**
float - The shutter.
##### getTimestamp()
```
public final long getTimestamp()
```

Gets the date of shooting.

**Returns:**
long - The timestamp.

### DngRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dngrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DngRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a DNG image.

[Working with metadata in DNG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+DNG+images
#### Methods

| Method | Description |
| --- | --- |
| getDngPackage() | Gets the DNG header metadata package. |
##### getDngPackage()
```
public final DngPackage getDngPackage()
```

Gets the DNG header metadata package.

**Returns:**
DngPackage - The DNG header metadata package.

### DocumentInfo
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Provides common information about a loaded document.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the file type of the loaded document. |
| getSize() | Gets the size of the loaded document in bytes. |
| getPageCount() | Gets the number of pages (slides, worksheets, etc) in the loaded document. |
| getPages() | Gets a collection of objects representing common information about the document pages (slides, worksheets, etc). |
| isEncrypted() | Gets a value indicating whether the document is encrypted and requires a password to open. |
##### getFileType()
```
public final FileTypePackage getFileType()
```

Gets the file type of the loaded document.

**Returns:**
FileTypePackage - The file type of the loaded document.
##### getSize()
```
public final long getSize()
```

Gets the size of the loaded document in bytes.

**Returns:**
long - The size of the loaded document in bytes.
##### getPageCount()
```
public final int getPageCount()
```

Gets the number of pages (slides, worksheets, etc) in the loaded document.

**Returns:**
int - The number of pages (slides, worksheets, etc) in the loaded document.
##### getPages()
```
public final IReadOnlyList<PageInfo> getPages()
```

Gets a collection of objects representing common information about the document pages (slides, worksheets, etc).

**Returns:**
IReadOnlyList - A collection of objects representing common information about the document pages (slides, worksheets, etc).
##### isEncrypted()
```
public final boolean isEncrypted()
```

Gets a value indicating whether the document is encrypted and requires a password to open.

**Returns:**
boolean - A value indicating whether the document is encrypted and requires a password to open.

### DocumentPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/documentpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class DocumentPackage extends CustomPackage
```

Represents native metadata in an office document.
#### Methods

| Method | Description |
| --- | --- |
| remove(String propertyName) | Removes a writable metadata property by the specified name. |
| clear() | Removes all writable metadata properties from the package. |
| clearBuiltInProperties() | Removes all built-in metadata properties. |
| clearCustomProperties() | Removes all custom metadata properties. |
##### remove(String propertyName)
```
public final boolean remove(String propertyName)
```

Removes a writable metadata property by the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | A metadata property name. |

**Returns:**
boolean -  true  if the property is found and deleted; otherwise  false .
##### clear()
```
public final void clear()
```

Removes all writable metadata properties from the package.

##### clearBuiltInProperties()
```
public final void clearBuiltInProperties()
```

Removes all built-in metadata properties.

##### clearCustomProperties()
```
public final void clearCustomProperties()
```

Removes all custom metadata properties.

### DocumentProtectedException
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/documentprotectedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class DocumentProtectedException extends GroupDocsMetadataException
```

The exception that is thrown when document is protected by password.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentProtectedException() | Initializes a new instance of the  DocumentProtectedException  class. |
##### DocumentProtectedException()
```
public DocumentProtectedException()
```

Initializes a new instance of the  DocumentProtectedException  class.

### DocumentRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/documentrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class DocumentRootPackage<TPackage> extends RootMetadataPackage
```

Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc.

 TPackage : The type of the native metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getDocumentProperties() | Gets the native metadata properties presented in the document. |
##### getDocumentProperties()
```
public TPackage getDocumentProperties()
```

Gets the native metadata properties presented in the document.

**Returns:**
TPackage - The document properties.

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/documentstatistics.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class DocumentStatistics extends CustomPackage
```

Represents a set of document statistics.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentStatistics() | Initializes a new instance of the  DocumentStatistics  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCharacterCount() | Gets an estimated number of characters in the document. |
| getWordCount() | Gets an estimated number of words in the document. |
| getPageCount() | Gets an estimated number of pages in the document. |
##### DocumentStatistics()
```
public DocumentStatistics()
```

Initializes a new instance of the  DocumentStatistics  class.

##### getCharacterCount()
```
public final int getCharacterCount()
```

Gets an estimated number of characters in the document.

**Returns:**
int - An estimated number of characters in the document.
##### getWordCount()
```
public final int getWordCount()
```

Gets an estimated number of words in the document.

**Returns:**
int - An estimated number of words in the document.
##### getPageCount()
```
public final int getPageCount()
```

Gets an estimated number of pages in the document.

**Returns:**
int - An estimated number of pages in the document.

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dublincorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DublinCorePackage extends CustomPackage
```

Represents a Dublin Core metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getContributor() | Gets the contributor Dublin Core element. |
| getCoverage() | Gets the coverage Dublin Core element. |
| getCreator() | Gets the creator Dublin Core element. |
| getDate() | Gets the date Dublin Core element. |
| getDescription() | Gets the description Dublin Core element. |
| getFormat() | Gets the format Dublin Core element. |
| getLanguage() | Gets the language Dublin Core element. |
| getPublisher() | Gets the publisher Dublin Core element. |
| getRelation() | Gets the relation Dublin Core element. |
| getSource() | Gets the source Dublin Core element. |
| getSubject() | Gets the subject Dublin Core element. |
| getTitle() | Gets the title Dublin Core element. |
| getType() | Gets the type Dublin Core element. |
| getRights() | Gets the rights Dublin Core element. |
| getIdentifier() | Gets the identifier Dublin Core element. |
##### getContributor()
```
public final String getContributor()
```

Gets the contributor Dublin Core element.

**Returns:**
java.lang.String - An entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization or a service.
##### getCoverage()
```
public final String getCoverage()
```

Gets the coverage Dublin Core element.

**Returns:**
java.lang.String - The extent or scope of the content of the resource. Coverage will typically include spatial location (a place name or geographic co-ordinates), temporal period (a period label, date, or date range) or jurisdiction (such as a named administrative entity).
##### getCreator()
```
public final String getCreator()
```

Gets the creator Dublin Core element.

**Returns:**
java.lang.String - An entity primarily responsible for making the content of the resource. Examples of a Creator include a person, an organization, or a service.
##### getDate()
```
public final String getDate()
```

Gets the date Dublin Core element.

**Returns:**
java.lang.String - A date associated with an event in the life cycle of the resource. Typically, Date will be associated with the creation or availability of the resource. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.
##### getDescription()
```
public final String getDescription()
```

Gets the description Dublin Core element.

**Returns:**
java.lang.String - An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.
##### getFormat()
```
public final String getFormat()
```

Gets the format Dublin Core element.

**Returns:**
java.lang.String - The physical or digital manifestation of the resource. Typically, Format may include the media-type or dimensions of the resource. Examples of dimensions include size and duration. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language Dublin Core element.

**Returns:**
java.lang.String - A language of the intellectual content of the resource. Recommended best practice for the values of the Language element is defined by RFC 3066 which, in conjunction with ISO 639), defines two- and three-letter primary language tags with optional subtags.
##### getPublisher()
```
public final String getPublisher()
```

Gets the publisher Dublin Core element.

**Returns:**
java.lang.String - The entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.
##### getRelation()
```
public final String getRelation()
```

Gets the relation Dublin Core element.

**Returns:**
java.lang.String - A reference to a related resource. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.
##### getSource()
```
public final String getSource()
```

Gets the source Dublin Core element.

**Returns:**
java.lang.String - A Reference to a resource from which the present resource is derived. The present resource may be derived from the Source resource in whole or part. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.
##### getSubject()
```
public final String getSubject()
```

Gets the subject Dublin Core element.

**Returns:**
java.lang.String - The topic of the content of the resource. Typically, a Subject will be expressed as keywords or key phrases or classification codes that describe the topic of the resource. Recommended best practice is to select a value from a controlled vocabulary or formal classification scheme.
##### getTitle()
```
public final String getTitle()
```

Gets the title Dublin Core element.

**Returns:**
java.lang.String - The name given to the resource. Typically, a Title will be a name by which the resource is formally known.
##### getType()
```
public final String getType()
```

Gets the type Dublin Core element.

**Returns:**
java.lang.String - The nature or genre of the content of the resource. Type includes terms describing general categories, functions, genres, or aggregation levels for content. Recommended best practice is to select a value from a controlled vocabulary (for example, the DCMIType vocabulary).
##### getRights()
```
public final String getRights()
```

Gets the rights Dublin Core element.

**Returns:**
java.lang.String - Information about rights held in and over the resource. Typically a Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information often encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. If the rights element is absent, no assumptions can be made about the status of these and other rights with respect to the resource.
##### getIdentifier()
```
public final String getIdentifier()
```

Gets the identifier Dublin Core element.

**Returns:**
java.lang.String - An unambiguous reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.

### DwgRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dwgrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.CadRootPackage
```
public class DwgRootPackage extends CadRootPackage
```

Represents the root package allowing working with metadata in a DWG drawing.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata

### DxfRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/dxfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.CadRootPackage
```
public class DxfRootPackage extends CadRootPackage
```

Represents the root package allowing working with metadata in a DXF drawing.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata

### EmailHeaderPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emailheaderpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class EmailHeaderPackage extends CustomPackage
```

Represents a metadata package containing email message headers.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| get(String header) | Gets the value of the specified header. |
##### get(String header)
```
public final String get(String header)
```

Gets the value of the specified header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| header | java.lang.String | An email header. |

**Returns:**
java.lang.String - The value if the package contains the specified header; otherwise, null.

### EmailPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emailpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class EmailPackage extends CustomPackage
```

Represents email message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getAttachedFileNames() | Gets an array of the names of the attached files. |
| getSubject() | Gets the email subject. |
| setSubject(String value) | Sets the email subject. |
| getRecipients() | Gets the array of the email recipients. |
| setRecipients(String[] value) | Sets the array of the email recipients. |
| getCarbonCopyRecipients() | Gets the array of CC (carbon copy) recipients of the email message. |
| setCarbonCopyRecipients(String[] value) | Sets the array of CC (carbon copy) recipients of the email message. |
| getBlindCarbonCopyRecipients() | Gets the array of BCC (blind carbon copy) recipients of the email message. |
| setBlindCarbonCopyRecipients(String[] value) | Sets the array of BCC (blind carbon copy) recipients of the email message. |
| getSender() | Gets the email address of the sender. |
| getHeaders() | Gets a metadata package containing the email headers. |
##### getAttachedFileNames()
```
public final String[] getAttachedFileNames()
```

Gets an array of the names of the attached files.

**Returns:**
java.lang.String[] - An array of the names of the attached files.
##### getSubject()
```
public final String getSubject()
```

Gets the email subject.

**Returns:**
java.lang.String - The email subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the email subject.

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

##### getRecipients()
```
public final String[] getRecipients()
```

Gets the array of the email recipients.

**Returns:**
java.lang.String[] - The array of the email recipients.
##### setRecipients(String[] value)
```
public final void setRecipients(String[] value)
```

Sets the array of the email recipients.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of the email recipients. |

##### getCarbonCopyRecipients()
```
public final String[] getCarbonCopyRecipients()
```

Gets the array of CC (carbon copy) recipients of the email message.

**Returns:**
java.lang.String[] - The array of CC (carbon copy) recipients of the email message.
##### setCarbonCopyRecipients(String[] value)
```
public final void setCarbonCopyRecipients(String[] value)
```

Sets the array of CC (carbon copy) recipients of the email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of CC (carbon copy) recipients of the email message. |

##### getBlindCarbonCopyRecipients()
```
public final String[] getBlindCarbonCopyRecipients()
```

Gets the array of BCC (blind carbon copy) recipients of the email message.

**Returns:**
java.lang.String[] - The array of BCC (blind carbon copy) recipients of the email message.
##### setBlindCarbonCopyRecipients(String[] value)
```
public final void setBlindCarbonCopyRecipients(String[] value)
```

Sets the array of BCC (blind carbon copy) recipients of the email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of BCC (blind carbon copy) recipients of the email message. |

##### getSender()
```
public final String getSender()
```

Gets the email address of the sender.

**Returns:**
java.lang.String - The email address of the sender.
##### getHeaders()
```
public final EmailHeaderPackage getHeaders()
```

Gets a metadata package containing the email headers.

**Returns:**
EmailHeaderPackage - A metadata package containing the email headers.

### EmailRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emailrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class EmailRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in an email message.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getEmailPackage() | Gets the email metadata package. |
| clearAttachments() | Removes all the attachments form the email message. |
##### getEmailPackage()
```
public final EmailPackage getEmailPackage()
```

Gets the email metadata package.

**Returns:**
EmailPackage - The email metadata package.
##### clearAttachments()
```
public final void clearAttachments()
```

Removes all the attachments form the email message.

### EmfRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class EmfRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in an EMF image.

### EmlPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emlpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.EmailPackage
```
public class EmlPackage extends EmailPackage
```

Represents EML message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails

### EmlRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/emlrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.EmailRootPackage
```
public class EmlRootPackage extends EmailRootPackage
```

Represents the root package allowing working with metadata in an EML email message.

This code sample shows how to extract metadata from an EML message.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputEml)) {
>      EmlRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getEmailPackage().getSender());
>      System.out.println(root.getEmailPackage().getSubject());
>      for (String recipient : root.getEmailPackage().getRecipients()) {
>          System.out.println(recipient);
>      }
>      for (String attachedFileName : root.getEmailPackage().getAttachedFileNames()) {
>          System.out.println(attachedFileName);
>      }
>      for (MetadataProperty header : root.getEmailPackage().getHeaders()) {
>          System.out.println(String.format("%s = %s", header.getName(), header.getValue()));
>      }
>      // ...
>  }
>
> ```
> ```

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getEmlPackage() | Gets the EML metadata package. |
##### getEmlPackage()
```
public final EmlPackage getEmlPackage()
```

Gets the EML metadata package.

**Returns:**
EmlPackage - The EML metadata package.

### EpubPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/epubpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class EpubPackage extends CustomPackage
```

Represents metadata in a EPUB e-book.

[Working with metadata in EPUB E-Books]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+EPUB+E-Books
#### Methods

| Method | Description |
| --- | --- |
| getImageCover() | Gets the image cover as an array of bytes. |
| getVersion() | Gets the EPUB version. |
| getUniqueIdentifier() | Gets the package unique identifier. |
| getAbstract() | Gets a summary of the resource. |
| setAbstract(String value) | Sets a summary of the resource. |
| getAccessRights() | Gets the information about who access the resource or an indication of its security status. |
| setAccessRights(String value) | Sets the information about who access the resource or an indication of its security status. |
| getAccrualMethod() | Gets the method by which items are added to a collection. |
| setAccrualMethod(String value) | Sets the method by which items are added to a collection. |
| getAccrualPeriodicity() | Gets the frequency with which items are added to a collection. |
| setAccrualPeriodicity(String value) | Sets the frequency with which items are added to a collection. |
| getAccrualPolicy() | Gets the policy governing the addition of items to a collection. |
| setAccrualPolicy(String value) | Sets the policy governing the addition of items to a collection. |
| getAlternative() | Gets an alternative name for the resource. |
| setAlternative(String value) | Sets an alternative name for the resource. |
| getAudience() | Gets a class of agents for whom the resource is intended or useful. |
| setAudience(String value) | Sets a class of agents for whom the resource is intended or useful. |
| getAvailable() | Gets the date that the resource became or will become available. |
| setAvailable(String value) | Sets the date that the resource became or will become available. |
| getBibliographicCitation() | Gets a bibliographic reference for the resource. |
| setBibliographicCitation(String value) | Sets a bibliographic reference for the resource. |
| getConformsTo() | Gets an established standard to which the described resource conforms. |
| setConformsTo(String value) | Sets an established standard to which the described resource conforms. |
| getContributor() | Gets an entity responsible for making contributions to the resource. |
| setContributor(String value) | Sets an entity responsible for making contributions to the resource. |
| getCoverage() | Gets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| setCoverage(String value) | Sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| getCreated() | Gets the date of creation of the resource. |
| setCreated(String value) | Sets the date of creation of the resource. |
| getCreator() | Gets an entity responsible for making the resource. |
| setCreator(String value) | Sets an entity responsible for making the resource. |
| getDate() | Gets a point or period of time associated with an event in the lifecycle of the resource. |
| setDate(String value) | Sets a point or period of time associated with an event in the lifecycle of the resource. |
| getDateAccepted() | Gets the date of acceptance of the resource. |
| setDateAccepted(String value) | Sets the date of acceptance of the resource. |
| getDateCopyrighted() | Gets the date of copyright of the resource. |
| setDateCopyrighted(String value) | Sets the date of copyright of the resource. |
| getDateSubmitted() | Gets the date of submission of the resource. |
| setDateSubmitted(String value) | Sets the date of submission of the resource. |
| getDescription() | Gets an account of the resource. |
| setDescription(String value) | Sets an account of the resource. |
| getEducationLevel() | Gets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| setEducationLevel(String value) | Sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| getExtent() | Gets the size or duration of the resource. |
| setExtent(String value) | Sets the size or duration of the resource. |
| getFormat() | Gets the file format, physical medium, or dimensions of the resource. |
| setFormat(String value) | Sets the file format, physical medium, or dimensions of the resource. |
| hasFormat() | Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| setHasFormat(String value) | Sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| hasPart() | Gets or sets a related resource that is included either physically or logically in the described resource. |
| setPart(String value) | Sets a related resource that is included either physically or logically in the described resource. |
| hasVersion() | Gets or sets a related resource that is a version, edition, or adaptation of the described resource. |
| setHasVersion(String value) | Sets a related resource that is a version, edition, or adaptation of the described resource. |
| getIdentifier() | Gets an unambiguous reference to the resource within a given context. |
| setIdentifier(String value) | Sets an unambiguous reference to the resource within a given context. |
| getInstructionalMethod() | Gets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| setInstructionalMethod(String value) | Sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| isFormatOf() | Gets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| setFormatOf(String value) | Sets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| isPartOf() | Gets a related resource in which the described resource is physically or logically included. |
| setPartOf(String value) | Sets a related resource in which the described resource is physically or logically included. |
| isReferencedBy() | Gets a related resource that references, cites, or otherwise points to the described resource. |
| setReferencedBy(String value) | Sets a related resource that references, cites, or otherwise points to the described resource. |
| isReplacedBy() | Gets a related resource that supplants, displaces, or supersedes the described resource. |
| setReplacedBy(String value) | Sets a related resource that supplants, displaces, or supersedes the described resource. |
| isRequiredBy() | Gets a related resource that requires the described resource to support its function, delivery, or coherence. |
| setRequiredBy(String value) | Sets a related resource that requires the described resource to support its function, delivery, or coherence. |
| getIssued() | Gets the date of formal issuance of the resource. |
| setIssued(String value) | Sets the date of formal issuance of the resource. |
| isVersionOf() | Gets a related resource of which the described resource is a version, edition, or adaptation. |
| setVersionOf(String value) | Sets a related resource of which the described resource is a version, edition, or adaptation. |
| getLanguage() | Gets the language of the resource. |
| setLanguage(String value) | Sets the language of the resource. |
| getLicense() | Gets a legal document giving official permission to do something with the resource. |
| setLicense(String value) | Sets a legal document giving official permission to do something with the resource. |
| getMediator() | Gets an entity that mediates access to the resource. |
| setMediator(String value) | Sets an entity that mediates access to the resource. |
| getMedium() | Gets the material or physical carrier of the resource. |
| setMedium(String value) | Sets the material or physical carrier of the resource. |
| getModified() | Gets the date on which the resource was changed. |
| setModified(String value) | Sets the date on which the resource was changed. |
| getProvenance() | Gets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| setProvenance(String value) | Sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| getPublisher() | Gets an entity responsible for making the resource available. |
| setPublisher(String value) | Sets an entity responsible for making the resource available. |
| getReferences() | Gets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| setReferences(String value) | Sets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| getRelation() | Gets a related resource. |
| setRelation(String value) | Sets a related resource. |
| getReplaces() | Gets a related resource that is supplanted, displaced, or superseded by the described resource. |
| setReplaces(String value) | Sets a related resource that is supplanted, displaced, or superseded by the described resource. |
| getRequires() | Gets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| setRequires(String value) | Sets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| getRights() | Gets the information about rights held in and over the resource. |
| setRights(String value) | Sets the information about rights held in and over the resource. |
| getRightsHolder() | Gets a person or organization owning or managing rights over the resource. |
| setRightsHolder(String value) | Sets a person or organization owning or managing rights over the resource. |
| getSource() | Gets a related resource from which the described resource is derived. |
| setSource(String value) | Sets a related resource from which the described resource is derived. |
| getSpatial() | Gets the spatial characteristics of the resource. |
| setSpatial(String value) | Sets the spatial characteristics of the resource. |
| getSubject() | Gets a topic of the resource. |
| setSubject(String value) | Sets a topic of the resource. |
| getTableOfContents() | Gets a list of subunits of the resource. |
| setTableOfContents(String value) | Sets a list of subunits of the resource. |
| getTemporal() | Gets the temporal characteristics of the resource. |
| setTemporal(String value) | Sets the temporal characteristics of the resource. |
| getTitle() | Gets a name given to the resource. |
| setTitle(String value) | Sets a name given to the resource. |
| getType() | Gets the nature or genre of the resource. |
| setType(String value) | Sets the nature or genre of the resource. |
| getValid() | Gets the date (often a range) of validity of a resource. |
| setValid(String value) | Sets the date (often a range) of validity of a resource. |
##### getImageCover()
```
public final byte[] getImageCover()
```

Gets the image cover as an array of bytes.

**Returns:**
byte[] - The image cover.
##### getVersion()
```
public final String getVersion()
```

Gets the EPUB version.

**Returns:**
java.lang.String - The EPUB version.
##### getUniqueIdentifier()
```
public final String getUniqueIdentifier()
```

Gets the package unique identifier.

**Returns:**
java.lang.String - The package unique identifier.
##### getAbstract()
```
public final String getAbstract()
```

Gets a summary of the resource.

**Returns:**
java.lang.String - A summary of the resource.
##### setAbstract(String value)
```
public final void setAbstract(String value)
```

Sets a summary of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A summary of the resource. |

##### getAccessRights()
```
public final String getAccessRights()
```

Gets the information about who access the resource or an indication of its security status.

**Returns:**
java.lang.String - The information about who access the resource or an indication of its security status.
##### setAccessRights(String value)
```
public final void setAccessRights(String value)
```

Sets the information about who access the resource or an indication of its security status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about who access the resource or an indication of its security status. |

##### getAccrualMethod()
```
public final String getAccrualMethod()
```

Gets the method by which items are added to a collection.

**Returns:**
java.lang.String - The method by which items are added to a collection.
##### setAccrualMethod(String value)
```
public final void setAccrualMethod(String value)
```

Sets the method by which items are added to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The method by which items are added to a collection. |

##### getAccrualPeriodicity()
```
public final String getAccrualPeriodicity()
```

Gets the frequency with which items are added to a collection.

**Returns:**
java.lang.String - The frequency with which items are added to a collection.
##### setAccrualPeriodicity(String value)
```
public final void setAccrualPeriodicity(String value)
```

Sets the frequency with which items are added to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The frequency with which items are added to a collection. |

##### getAccrualPolicy()
```
public final String getAccrualPolicy()
```

Gets the policy governing the addition of items to a collection.

**Returns:**
java.lang.String - The policy governing the addition of items to a collection.
##### setAccrualPolicy(String value)
```
public final void setAccrualPolicy(String value)
```

Sets the policy governing the addition of items to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The policy governing the addition of items to a collection. |

##### getAlternative()
```
public final String getAlternative()
```

Gets an alternative name for the resource.

**Returns:**
java.lang.String - An alternative name for the resource.
##### setAlternative(String value)
```
public final void setAlternative(String value)
```

Sets an alternative name for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An alternative name for the resource. |

##### getAudience()
```
public final String getAudience()
```

Gets a class of agents for whom the resource is intended or useful.

**Returns:**
java.lang.String - A class of agents for whom the resource is intended or useful.
##### setAudience(String value)
```
public final void setAudience(String value)
```

Sets a class of agents for whom the resource is intended or useful.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A class of agents for whom the resource is intended or useful. |

##### getAvailable()
```
public final String getAvailable()
```

Gets the date that the resource became or will become available.

**Returns:**
java.lang.String - The date that the resource became or will become available.
##### setAvailable(String value)
```
public final void setAvailable(String value)
```

Sets the date that the resource became or will become available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date that the resource became or will become available. |

##### getBibliographicCitation()
```
public final String getBibliographicCitation()
```

Gets a bibliographic reference for the resource.

**Returns:**
java.lang.String - A bibliographic reference for the resource.
##### setBibliographicCitation(String value)
```
public final void setBibliographicCitation(String value)
```

Sets a bibliographic reference for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A bibliographic reference for the resource. |

##### getConformsTo()
```
public final String getConformsTo()
```

Gets an established standard to which the described resource conforms.

**Returns:**
java.lang.String - An established standard to which the described resource conforms.
##### setConformsTo(String value)
```
public final void setConformsTo(String value)
```

Sets an established standard to which the described resource conforms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An established standard to which the described resource conforms. |

##### getContributor()
```
public final String getContributor()
```

Gets an entity responsible for making contributions to the resource.

**Returns:**
java.lang.String - An entity responsible for making contributions to the resource.
##### setContributor(String value)
```
public final void setContributor(String value)
```

Sets an entity responsible for making contributions to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making contributions to the resource. |

##### getCoverage()
```
public final String getCoverage()
```

Gets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.

**Returns:**
java.lang.String - The spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.
##### setCoverage(String value)
```
public final void setCoverage(String value)
```

Sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |

##### getCreated()
```
public final String getCreated()
```

Gets the date of creation of the resource.

**Returns:**
java.lang.String - The date of creation of the resource.
##### setCreated(String value)
```
public final void setCreated(String value)
```

Sets the date of creation of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of creation of the resource. |

##### getCreator()
```
public final String getCreator()
```

Gets an entity responsible for making the resource.

**Returns:**
java.lang.String - An entity responsible for making the resource.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Sets an entity responsible for making the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making the resource. |

##### getDate()
```
public final String getDate()
```

Gets a point or period of time associated with an event in the lifecycle of the resource.

**Returns:**
java.lang.String - A point or period of time associated with an event in the lifecycle of the resource.
##### setDate(String value)
```
public final void setDate(String value)
```

Sets a point or period of time associated with an event in the lifecycle of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A point or period of time associated with an event in the lifecycle of the resource. |

##### getDateAccepted()
```
public final String getDateAccepted()
```

Gets the date of acceptance of the resource.

**Returns:**
java.lang.String - The date of acceptance of the resource.
##### setDateAccepted(String value)
```
public final void setDateAccepted(String value)
```

Sets the date of acceptance of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of acceptance of the resource. |

##### getDateCopyrighted()
```
public final String getDateCopyrighted()
```

Gets the date of copyright of the resource.

**Returns:**
java.lang.String - The date of copyright of the resource.
##### setDateCopyrighted(String value)
```
public final void setDateCopyrighted(String value)
```

Sets the date of copyright of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of copyright of the resource. |

##### getDateSubmitted()
```
public final String getDateSubmitted()
```

Gets the date of submission of the resource.

**Returns:**
java.lang.String - The date of submission of the resource.
##### setDateSubmitted(String value)
```
public final void setDateSubmitted(String value)
```

Sets the date of submission of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of submission of the resource. |

##### getDescription()
```
public final String getDescription()
```

Gets an account of the resource.

**Returns:**
java.lang.String - An account of the resource.
##### setDescription(String value)
```
public final void setDescription(String value)
```

Sets an account of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An account of the resource. |

##### getEducationLevel()
```
public final String getEducationLevel()
```

Gets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

**Returns:**
java.lang.String - A class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.
##### setEducationLevel(String value)
```
public final void setEducationLevel(String value)
```

Sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |

##### getExtent()
```
public final String getExtent()
```

Gets the size or duration of the resource.

**Returns:**
java.lang.String - The size or duration of the resource.
##### setExtent(String value)
```
public final void setExtent(String value)
```

Sets the size or duration of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The size or duration of the resource. |

##### getFormat()
```
public final String getFormat()
```

Gets the file format, physical medium, or dimensions of the resource.

**Returns:**
java.lang.String - The file format, physical medium, or dimensions of the resource.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the file format, physical medium, or dimensions of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The file format, physical medium, or dimensions of the resource. |

##### hasFormat()
```
public final String hasFormat()
```

Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format.

**Returns:**
java.lang.String - A related resource that is substantially the same as the pre-existing described resource, but in another format.
##### setHasFormat(String value)
```
public final void setHasFormat(String value)
```

Sets a related resource that is substantially the same as the pre-existing described resource, but in another format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is substantially the same as the pre-existing described resource, but in another format. |

##### hasPart()
```
public final String hasPart()
```

Gets or sets a related resource that is included either physically or logically in the described resource.

**Returns:**
java.lang.String - A related resource that is included either physically or logically in the described resource.
##### setPart(String value)
```
public final void setPart(String value)
```

Sets a related resource that is included either physically or logically in the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is included either physically or logically in the described resource. |

##### hasVersion()
```
public final String hasVersion()
```

Gets or sets a related resource that is a version, edition, or adaptation of the described resource.

**Returns:**
java.lang.String - A related resource that is a version, edition, or adaptation of the described resource.
##### setHasVersion(String value)
```
public final void setHasVersion(String value)
```

Sets a related resource that is a version, edition, or adaptation of the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is a version, edition, or adaptation of the described resource. |

##### getIdentifier()
```
public final String getIdentifier()
```

Gets an unambiguous reference to the resource within a given context.

**Returns:**
java.lang.String - An unambiguous reference to the resource within a given context.
##### setIdentifier(String value)
```
public final void setIdentifier(String value)
```

Sets an unambiguous reference to the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An unambiguous reference to the resource within a given context. |

##### getInstructionalMethod()
```
public final String getInstructionalMethod()
```

Gets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

**Returns:**
java.lang.String - A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.
##### setInstructionalMethod(String value)
```
public final void setInstructionalMethod(String value)
```

Sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |

##### isFormatOf()
```
public final String isFormatOf()
```

Gets a pre-existing related resource that is substantially the same as the described resource, but in another format.

**Returns:**
java.lang.String - A pre-existing related resource that is substantially the same as the described resource, but in another format.
##### setFormatOf(String value)
```
public final void setFormatOf(String value)
```

Sets a pre-existing related resource that is substantially the same as the described resource, but in another format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A pre-existing related resource that is substantially the same as the described resource, but in another format. |

##### isPartOf()
```
public final String isPartOf()
```

Gets a related resource in which the described resource is physically or logically included.

**Returns:**
java.lang.String - A related resource in which the described resource is physically or logically included.
##### setPartOf(String value)
```
public final void setPartOf(String value)
```

Sets a related resource in which the described resource is physically or logically included.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource in which the described resource is physically or logically included. |

##### isReferencedBy()
```
public final String isReferencedBy()
```

Gets a related resource that references, cites, or otherwise points to the described resource.

**Returns:**
java.lang.String - A related resource that references, cites, or otherwise points to the described resource.
##### setReferencedBy(String value)
```
public final void setReferencedBy(String value)
```

Sets a related resource that references, cites, or otherwise points to the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that references, cites, or otherwise points to the described resource. |

##### isReplacedBy()
```
public final String isReplacedBy()
```

Gets a related resource that supplants, displaces, or supersedes the described resource.

**Returns:**
java.lang.String - A related resource that supplants, displaces, or supersedes the described resource.
##### setReplacedBy(String value)
```
public final void setReplacedBy(String value)
```

Sets a related resource that supplants, displaces, or supersedes the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that supplants, displaces, or supersedes the described resource. |

##### isRequiredBy()
```
public final String isRequiredBy()
```

Gets a related resource that requires the described resource to support its function, delivery, or coherence.

**Returns:**
java.lang.String - A related resource that requires the described resource to support its function, delivery, or coherence.
##### setRequiredBy(String value)
```
public final void setRequiredBy(String value)
```

Sets a related resource that requires the described resource to support its function, delivery, or coherence.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that requires the described resource to support its function, delivery, or coherence. |

##### getIssued()
```
public final String getIssued()
```

Gets the date of formal issuance of the resource.

**Returns:**
java.lang.String - The date of formal issuance of the resource.
##### setIssued(String value)
```
public final void setIssued(String value)
```

Sets the date of formal issuance of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of formal issuance of the resource. |

##### isVersionOf()
```
public final String isVersionOf()
```

Gets a related resource of which the described resource is a version, edition, or adaptation.

**Returns:**
java.lang.String - A related resource of which the described resource is a version, edition, or adaptation.
##### setVersionOf(String value)
```
public final void setVersionOf(String value)
```

Sets a related resource of which the described resource is a version, edition, or adaptation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource of which the described resource is a version, edition, or adaptation. |

##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the resource.

**Returns:**
java.lang.String - The language of the resource.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the language of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language of the resource. |

##### getLicense()
```
public final String getLicense()
```

Gets a legal document giving official permission to do something with the resource.

**Returns:**
java.lang.String - A legal document giving official permission to do something with the resource.
##### setLicense(String value)
```
public final void setLicense(String value)
```

Sets a legal document giving official permission to do something with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A legal document giving official permission to do something with the resource. |

##### getMediator()
```
public final String getMediator()
```

Gets an entity that mediates access to the resource.

**Returns:**
java.lang.String - An entity that mediates access to the resource.
##### setMediator(String value)
```
public final void setMediator(String value)
```

Sets an entity that mediates access to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity that mediates access to the resource. |

##### getMedium()
```
public final String getMedium()
```

Gets the material or physical carrier of the resource.

**Returns:**
java.lang.String - The material or physical carrier of the resource.
##### setMedium(String value)
```
public final void setMedium(String value)
```

Sets the material or physical carrier of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The material or physical carrier of the resource. |

##### getModified()
```
public final String getModified()
```

Gets the date on which the resource was changed.

**Returns:**
java.lang.String - The date on which the resource was changed.
##### setModified(String value)
```
public final void setModified(String value)
```

Sets the date on which the resource was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date on which the resource was changed. |

##### getProvenance()
```
public final String getProvenance()
```

Gets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

**Returns:**
java.lang.String - A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.
##### setProvenance(String value)
```
public final void setProvenance(String value)
```

Sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |

##### getPublisher()
```
public final String getPublisher()
```

Gets an entity responsible for making the resource available.

**Returns:**
java.lang.String - An entity responsible for making the resource available.
##### setPublisher(String value)
```
public final void setPublisher(String value)
```

Sets an entity responsible for making the resource available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making the resource available. |

##### getReferences()
```
public final String getReferences()
```

Gets a related resource that is referenced, cited, or otherwise pointed to by the described resource.

**Returns:**
java.lang.String - A related resource that is referenced, cited, or otherwise pointed to by the described resource.
##### setReferences(String value)
```
public final void setReferences(String value)
```

Sets a related resource that is referenced, cited, or otherwise pointed to by the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is referenced, cited, or otherwise pointed to by the described resource. |

##### getRelation()
```
public final String getRelation()
```

Gets a related resource.

**Returns:**
java.lang.String - A related resource.
##### setRelation(String value)
```
public final void setRelation(String value)
```

Sets a related resource.

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

##### getReplaces()
```
public final String getReplaces()
```

Gets a related resource that is supplanted, displaced, or superseded by the described resource.

**Returns:**
java.lang.String - A related resource that is supplanted, displaced, or superseded by the described resource.
##### setReplaces(String value)
```
public final void setReplaces(String value)
```

Sets a related resource that is supplanted, displaced, or superseded by the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is supplanted, displaced, or superseded by the described resource. |

##### getRequires()
```
public final String getRequires()
```

Gets a related resource that is required by the described resource to support its function, delivery, or coherence.

**Returns:**
java.lang.String - A related resource that is required by the described resource to support its function, delivery, or coherence.
##### setRequires(String value)
```
public final void setRequires(String value)
```

Sets a related resource that is required by the described resource to support its function, delivery, or coherence.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is required by the described resource to support its function, delivery, or coherence. |

##### getRights()
```
public final String getRights()
```

Gets the information about rights held in and over the resource.

**Returns:**
java.lang.String - The information about rights held in and over the resource.
##### setRights(String value)
```
public final void setRights(String value)
```

Sets the information about rights held in and over the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about rights held in and over the resource. |

##### getRightsHolder()
```
public final String getRightsHolder()
```

Gets a person or organization owning or managing rights over the resource.

**Returns:**
java.lang.String - A person or organization owning or managing rights over the resource.
##### setRightsHolder(String value)
```
public final void setRightsHolder(String value)
```

Sets a person or organization owning or managing rights over the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A person or organization owning or managing rights over the resource. |

##### getSource()
```
public final String getSource()
```

Gets a related resource from which the described resource is derived.

**Returns:**
java.lang.String - A related resource from which the described resource is derived.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets a related resource from which the described resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource from which the described resource is derived. |

##### getSpatial()
```
public final String getSpatial()
```

Gets the spatial characteristics of the resource.

**Returns:**
java.lang.String - The spatial characteristics of the resource.
##### setSpatial(String value)
```
public final void setSpatial(String value)
```

Sets the spatial characteristics of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The spatial characteristics of the resource. |

##### getSubject()
```
public final String getSubject()
```

Gets a topic of the resource.

**Returns:**
java.lang.String - A topic of the resource.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets a topic of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A topic of the resource. |

##### getTableOfContents()
```
public final String getTableOfContents()
```

Gets a list of subunits of the resource.

**Returns:**
java.lang.String - A list of subunits of the resource.
##### setTableOfContents(String value)
```
public final void setTableOfContents(String value)
```

Sets a list of subunits of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A list of subunits of the resource. |

##### getTemporal()
```
public final String getTemporal()
```

Gets the temporal characteristics of the resource.

**Returns:**
java.lang.String - The temporal characteristics of the resource.
##### setTemporal(String value)
```
public final void setTemporal(String value)
```

Sets the temporal characteristics of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The temporal characteristics of the resource. |

##### getTitle()
```
public final String getTitle()
```

Gets a name given to the resource.

**Returns:**
java.lang.String - A name given to the resource.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets a name given to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A name given to the resource. |

##### getType()
```
public final String getType()
```

Gets the nature or genre of the resource.

**Returns:**
java.lang.String - The nature or genre of the resource.
##### setType(String value)
```
public final void setType(String value)
```

Sets the nature or genre of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The nature or genre of the resource. |

##### getValid()
```
public final String getValid()
```

Gets the date (often a range) of validity of a resource.

**Returns:**
java.lang.String - The date (often a range) of validity of a resource.
##### setValid(String value)
```
public final void setValid(String value)
```

Sets the date (often a range) of validity of a resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date (often a range) of validity of a resource. |

### EpubRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/epubrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDublinCore
```
public class EpubRootPackage extends RootMetadataPackage implements IDublinCore
```

Represents the root package allowing working with metadata in an EPUB e-book.

This code sample shows how to read EPUB format-specific metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputEpub)) {
>      EpubRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getEpubPackage().getVersion());
>      System.out.println(root.getEpubPackage().getUniqueIdentifier());
>      System.out.println(root.getEpubPackage().getImageCover() != null ? root.getEpubPackage().getImageCover().length : 0);
>  }
>
> ```
> ```

[Working with metadata in EPUB E-Books]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+EPUB+E-Books
#### Methods

| Method | Description |
| --- | --- |
| getEpubPackage() | Gets the EPUB metadata package. |
| getDublinCorePackage() | Gets the Dublin Core metadata package extracted from the e-book. |
##### getEpubPackage()
```
public final EpubPackage getEpubPackage()
```

Gets the EPUB metadata package.

**Returns:**
EpubPackage - The EPUB metadata package.
##### getDublinCorePackage()
```
public final DublinCorePackage getDublinCorePackage()
```

Gets the Dublin Core metadata package extracted from the e-book.

**Returns:**
DublinCorePackage - The Dublin Core metadata package extracted from the e-book.

### ExifDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/exifdictionarybasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class ExifDictionaryBasePackage extends CustomPackage
```

Provides an abstract base class for EXIF metadata dictionaries.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
| getByTiffTagID(TiffTagID tagId) | Gets the TIFF tag with the specified id. |
| remove(TiffTagID tagId) | Removes the property with the specified id. |
| set(TiffTag tag) | Adds or replaces the specified tag. |
| clear() | Removes all TIFF tags stored in the package. |
##### toList()
```
public final IReadOnlyList<TiffTag> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all TIFF tags from the package.
##### getByTiffTagID(TiffTagID tagId)
```
public final TiffTag getByTiffTagID(TiffTagID tagId)
```

Gets the TIFF tag with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | TiffTagID | The id of the tag to retrieve. |

**Returns:**
TiffTag - The  TiffTag  with the specified tag id.
##### remove(TiffTagID tagId)
```
public final boolean remove(TiffTagID tagId)
```

Removes the property with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | TiffTagID | A TIFF tag id. |

**Returns:**
boolean - True if the specified TIFF tag is found and removed; otherwise, false.
##### set(TiffTag tag)
```
public final void set(TiffTag tag)
```

Adds or replaces the specified tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | TiffTag | The tag to set. |

##### clear()
```
public final void clear()
```

Removes all TIFF tags stored in the package.

### ExifGpsAltitudeRef
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/exifgpsaltituderef.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ExifGpsAltitudeRef extends Enum<ExifGpsAltitudeRef> implements IEnumValue
```

Represents a GPS altitude reference.
#### Fields

| Field | Description |
| --- | --- |
| AboveSeaLevel | Above sea level. |
| BelowSeaLevel | Below sea level. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### AboveSeaLevel
```
public static final ExifGpsAltitudeRef AboveSeaLevel
```

Above sea level.

##### BelowSeaLevel
```
public static final ExifGpsAltitudeRef BelowSeaLevel
```

Below sea level.

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

**Returns:**
com.groupdocs.metadata.core.ExifGpsAltitudeRef[]
##### valueOf(String name)
```
public static ExifGpsAltitudeRef valueOf(String name)
```

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

**Returns:**
ExifGpsAltitudeRef
##### getByRawValue(int rawValue)
```
public static ExifGpsAltitudeRef getByRawValue(int rawValue)
```

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

**Returns:**
ExifGpsAltitudeRef
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ExifGpsPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/exifgpspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public final class ExifGpsPackage extends ExifDictionaryBasePackage
```

Represents GPS metadata in an EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ExifGpsPackage() | Initializes a new instance of the  ExifGpsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAltitude() | Gets the altitude based on the reference in  AltitudeRef . |
| setAltitude(TiffRational value) | Sets the altitude based on the reference in  AltitudeRef . |
| getAltitudeRef() | Gets the altitude used as the reference altitude. |
| setAltitudeRef(ExifGpsAltitudeRef value) | Sets the altitude used as the reference altitude. |
| getAreaInformation() | Gets the character string recording the name of the GPS area. |
| setAreaInformation(byte[] value) | Sets the character string recording the name of the GPS area. |
| getDateStamp() | Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| setDateStamp(String value) | Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| getDestBearing() | Gets the GPS bearing to the destination point. |
| setDestBearing(TiffRational value) | Sets the GPS bearing to the destination point. |
| getDestBearingRef() | Gets the GPS reference used for giving the bearing to the destination point. |
| setDestBearingRef(String value) | Sets the GPS reference used for giving the bearing to the destination point. |
| getDestDistance() | Gets the GPS distance to the destination point. |
| setDestDistance(TiffRational value) | Sets the GPS distance to the destination point. |
| getDestDistanceRef() | Gets the GPS unit used to express the distance to the destination point. |
| setDestDistanceRef(String value) | Sets the GPS unit used to express the distance to the destination point. |
| getDestLatitude() | Gets the GPS latitude of the destination point. |
| setDestLatitude(TiffRational[] value) | Sets the GPS latitude of the destination point. |
| getDestLatitudeRef() | Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| setDestLatitudeRef(String value) | Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| getDestLongitude() | Gets the GPS longitude of the destination point. |
| setDestLongitude(TiffRational[] value) | Sets the GPS longitude of the destination point. |
| getDestLongitudeRef() | Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| setDestLongitudeRef(String value) | Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| getDifferential() | Gets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| setDifferential(Integer value) | Sets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| getDataDegreeOfPrecision() | Gets the GPS DOP (data degree of precision). |
| setDataDegreeOfPrecision(TiffRational value) | Sets the GPS DOP (data degree of precision). |
| getImgDirection() | Gets the GPS direction of the image when it was captured. |
| setImgDirection(TiffRational value) | Sets the GPS direction of the image when it was captured. |
| getImgDirectionRef() | Gets the GPS reference for giving the direction of the image when it is captured. |
| setImgDirectionRef(String value) | Sets the GPS reference for giving the direction of the image when it is captured. |
| getLatitude() | Gets the GPS latitude. |
| setLatitude(TiffRational[] value) | Sets the GPS latitude. |
| getLatitudeRef() | Gets a GPS value indicating whether the latitude is north or south latitude. |
| setLatitudeRef(String value) | Sets a GPS value indicating whether the latitude is north or south latitude. |
| getLongitude() | Gets the GPS longitude. |
| setLongitude(TiffRational[] value) | Sets the GPS longitude. |
| getLongitudeRef() | Gets a GPS value indicating whether the longitude is east or west longitude. |
| setLongitudeRef(String value) | Sets a GPS value indicating whether the longitude is east or west longitude. |
| getMapDatum() | Gets the geodetic survey data used by the GPS receiver. |
| setMapDatum(String value) | Sets the geodetic survey data used by the GPS receiver. |
| getMeasureMode() | Gets the GPS measurement mode. |
| setMeasureMode(String value) | Sets the GPS measurement mode. |
| getProcessingMethod() | Gets a character string recording the name of the method used for location finding. |
| setProcessingMethod(byte[] value) | Sets a character string recording the name of the method used for location finding. |
| getSatellites() | Gets the GPS satellites used for measurements. |
| setSatellites(String value) | Sets the GPS satellites used for measurements. |
| getSpeed() | Gets the speed of GPS receiver movement. |
| setSpeed(TiffRational value) | Sets the speed of GPS receiver movement. |
| getSpeedRef() | Gets the unit used to express the GPS receiver speed of movement. |
| setSpeedRef(String value) | Sets the unit used to express the GPS receiver speed of movement. |
| getStatus() | Gets the status of the GPS receiver when the image is recorded. |
| setStatus(String value) | Sets the status of the GPS receiver when the image is recorded. |
| getTimeStamp() | Gets the time as UTC (Coordinated Universal Time). |
| setTimeStamp(TiffRational[] value) | Sets the time as UTC (Coordinated Universal Time). |
| getGpsTrack() | Gets the direction of GPS receiver movement. |
| setGpsTrack(TiffRational value) | Sets the direction of GPS receiver movement. |
| getTrackRef() | Gets the reference for giving the direction of GPS receiver movement. |
| setTrackRef(String value) | Sets the reference for giving the direction of GPS receiver movement. |
| getVersionID() | Gets the version of GPS IFD. |
| setVersionID(byte[] value) | Sets the version of GPS IFD. |
##### ExifGpsPackage()
```
public ExifGpsPackage()
```

Initializes a new instance of the  ExifGpsPackage  class.

##### getAltitude()
```
public final TiffRational getAltitude()
```

Gets the altitude based on the reference in  AltitudeRef . The reference unit is meters.

**Returns:**
TiffRational - The altitude based on the reference in  AltitudeRef .
##### setAltitude(TiffRational value)
```
public final void setAltitude(TiffRational value)
```

Sets the altitude based on the reference in  AltitudeRef . The reference unit is meters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The altitude based on the reference in  AltitudeRef . |

##### getAltitudeRef()
```
public final ExifGpsAltitudeRef getAltitudeRef()
```

Gets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the  Altitude  tag.

**Returns:**
ExifGpsAltitudeRef - The altitude used as the reference altitude
##### setAltitudeRef(ExifGpsAltitudeRef value)
```
public final void setAltitudeRef(ExifGpsAltitudeRef value)
```

Sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the  Altitude  tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifGpsAltitudeRef | The altitude used as the reference altitude |

##### getAreaInformation()
```
public final byte[] getAreaInformation()
```

Gets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.

**Returns:**
byte[] - The character string recording the name of the GPS area.
##### setAreaInformation(byte[] value)
```
public final void setAreaInformation(byte[] value)
```

Sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The character string recording the name of the GPS area. |

##### getDateStamp()
```
public final String getDateStamp()
```

Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

**Returns:**
java.lang.String - The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
##### setDateStamp(String value)
```
public final void setDateStamp(String value)
```

Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD. |

##### getDestBearing()
```
public final TiffRational getDestBearing()
```

Gets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.

**Returns:**
TiffRational - The bearing to the destination point.
##### setDestBearing(TiffRational value)
```
public final void setDestBearing(TiffRational value)
```

Sets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The bearing to the destination point. |

##### getDestBearingRef()
```
public final String getDestBearingRef()
```

Gets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The GPS reference used for giving the bearing to the destination point.
##### setDestBearingRef(String value)
```
public final void setDestBearingRef(String value)
```

Sets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS reference used for giving the bearing to the destination point. |

##### getDestDistance()
```
public final TiffRational getDestDistance()
```

Gets the GPS distance to the destination point.

**Returns:**
TiffRational - The distance to the destination point.
##### setDestDistance(TiffRational value)
```
public final void setDestDistance(TiffRational value)
```

Sets the GPS distance to the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The distance to the destination point. |

##### getDestDistanceRef()
```
public final String getDestDistanceRef()
```

Gets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots.

**Returns:**
java.lang.String - The GPS unit used to express the distance to the destination point.
##### setDestDistanceRef(String value)
```
public final void setDestDistanceRef(String value)
```

Sets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS unit used to express the distance to the destination point. |

##### getDestLatitude()
```
public final TiffRational[] getDestLatitude()
```

Gets the GPS latitude of the destination point.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The latitude of the destination point.
##### setDestLatitude(TiffRational[] value)
```
public final void setDestLatitude(TiffRational[] value)
```

Sets the GPS latitude of the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The latitude of the destination point. |

##### getDestLatitudeRef()
```
public final String getDestLatitudeRef()
```

Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude.

**Returns:**
java.lang.String - The GPS value which indicates whether the latitude of the destination point is north or south latitude.
##### setDestLatitudeRef(String value)
```
public final void setDestLatitudeRef(String value)
```

Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS value which indicates whether the latitude of the destination point is north or south latitude. |

##### getDestLongitude()
```
public final TiffRational[] getDestLongitude()
```

Gets the GPS longitude of the destination point.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The GPS longitude of the destination point.
##### setDestLongitude(TiffRational[] value)
```
public final void setDestLongitude(TiffRational[] value)
```

Sets the GPS longitude of the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The GPS longitude of the destination point. |

##### getDestLongitudeRef()
```
public final String getDestLongitudeRef()
```

Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude.

**Returns:**
java.lang.String - The GPS value which indicates whether the longitude of the destination point is east or west longitude.
##### setDestLongitudeRef(String value)
```
public final void setDestLongitudeRef(String value)
```

Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS value which indicates whether the longitude of the destination point is east or west longitude. |

##### getDifferential()
```
public final Integer getDifferential()
```

Gets a GPS value which indicates whether differential correction is applied to the GPS receiver.

**Returns:**
java.lang.Integer - A GPS value which indicates whether differential correction is applied to the GPS receiver.
##### setDifferential(Integer value)
```
public final void setDifferential(Integer value)
```

Sets a GPS value which indicates whether differential correction is applied to the GPS receiver.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A GPS value which indicates whether differential correction is applied to the GPS receiver. |

##### getDataDegreeOfPrecision()
```
public final TiffRational getDataDegreeOfPrecision()
```

Gets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.

**Returns:**
TiffRational - The data degree of precision.
##### setDataDegreeOfPrecision(TiffRational value)
```
public final void setDataDegreeOfPrecision(TiffRational value)
```

Sets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The data degree of precision. |

##### getImgDirection()
```
public final TiffRational getImgDirection()
```

Gets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.

**Returns:**
TiffRational - The GPS direction of the image when it was captured.
##### setImgDirection(TiffRational value)
```
public final void setImgDirection(TiffRational value)
```

Sets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The GPS direction of the image when it was captured. |

##### getImgDirectionRef()
```
public final String getImgDirectionRef()
```

Gets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The GPS reference for giving the direction of the image when it is captured.
##### setImgDirectionRef(String value)
```
public final void setImgDirectionRef(String value)
```

Sets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS reference for giving the direction of the image when it is captured. |

##### getLatitude()
```
public final TiffRational[] getLatitude()
```

Gets the GPS latitude.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The latitude.
##### setLatitude(TiffRational[] value)
```
public final void setLatitude(TiffRational[] value)
```

Sets the GPS latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The latitude. |

##### getLatitudeRef()
```
public final String getLatitudeRef()
```

Gets a GPS value indicating whether the latitude is north or south latitude.

**Returns:**
java.lang.String - A GPS value indicating whether the latitude is north or south latitude.
##### setLatitudeRef(String value)
```
public final void setLatitudeRef(String value)
```

Sets a GPS value indicating whether the latitude is north or south latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A GPS value indicating whether the latitude is north or south latitude. |

##### getLongitude()
```
public final TiffRational[] getLongitude()
```

Gets the GPS longitude.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The longitude.
##### setLongitude(TiffRational[] value)
```
public final void setLongitude(TiffRational[] value)
```

Sets the GPS longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The longitude. |

##### getLongitudeRef()
```
public final String getLongitudeRef()
```

Gets a GPS value indicating whether the longitude is east or west longitude.

**Returns:**
java.lang.String - A GPS value indicating whether the longitude is east or west longitude.
##### setLongitudeRef(String value)
```
public final void setLongitudeRef(String value)
```

Sets a GPS value indicating whether the longitude is east or west longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A GPS value indicating whether the longitude is east or west longitude. |

##### getMapDatum()
```
public final String getMapDatum()
```

Gets the geodetic survey data used by the GPS receiver.

**Returns:**
java.lang.String - The geodetic survey data used by the GPS receiver.
##### setMapDatum(String value)
```
public final void setMapDatum(String value)
```

Sets the geodetic survey data used by the GPS receiver.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The geodetic survey data used by the GPS receiver. |

##### getMeasureMode()
```
public final String getMeasureMode()
```

Gets the GPS measurement mode.

**Returns:**
java.lang.String - The measure mode.
##### setMeasureMode(String value)
```
public final void setMeasureMode(String value)
```

Sets the GPS measurement mode.

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

##### getProcessingMethod()
```
public final byte[] getProcessingMethod()
```

Gets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.

**Returns:**
byte[] - A character string recording the name of the method used for location finding.
##### setProcessingMethod(byte[] value)
```
public final void setProcessingMethod(byte[] value)
```

Sets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | A character string recording the name of the method used for location finding. |

##### getSatellites()
```
public final String getSatellites()
```

Gets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.

**Returns:**
java.lang.String - The GPS satellites used for measurements.
##### setSatellites(String value)
```
public final void setSatellites(String value)
```

Sets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS satellites used for measurements. |

##### getSpeed()
```
public final TiffRational getSpeed()
```

Gets the speed of GPS receiver movement.

**Returns:**
TiffRational - The speed of GPS receiver movement.
##### setSpeed(TiffRational value)
```
public final void setSpeed(TiffRational value)
```

Sets the speed of GPS receiver movement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The speed of GPS receiver movement. |

##### getSpeedRef()
```
public final String getSpeedRef()
```

Gets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.

**Returns:**
java.lang.String - The unit used to express the GPS receiver speed of movement.
##### setSpeedRef(String value)
```
public final void setSpeedRef(String value)
```

Sets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The unit used to express the GPS receiver speed of movement. |

##### getStatus()
```
public final String getStatus()
```

Gets the status of the GPS receiver when the image is recorded.

**Returns:**
java.lang.String - The status of the GPS receiver when the image is recorded.
##### setStatus(String value)
```
public final void setStatus(String value)
```

Sets the status of the GPS receiver when the image is recorded.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The status of the GPS receiver when the image is recorded. |

##### getTimeStamp()
```
public final TiffRational[] getTimeStamp()
```

Gets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The time as UTC (Coordinated Universal Time).
##### setTimeStamp(TiffRational[] value)
```
public final void setTimeStamp(TiffRational[] value)
```

Sets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The time as UTC (Coordinated Universal Time). |

##### getGpsTrack()
```
public final TiffRational getGpsTrack()
```

Gets the direction of GPS receiver movement.

**Returns:**
TiffRational - The direction of GPS receiver movement.
##### setGpsTrack(TiffRational value)
```
public final void setGpsTrack(TiffRational value)
```

Sets the direction of GPS receiver movement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The direction of GPS receiver movement. |

##### getTrackRef()
```
public final String getTrackRef()
```

Gets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The reference for giving the direction of GPS receiver movement.
##### setTrackRef(String value)
```
public final void setTrackRef(String value)
```

Sets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference for giving the direction of GPS receiver movement. |

##### getVersionID()
```
public final byte[] getVersionID()
```

Gets the version of GPS IFD.

**Returns:**
byte[] - The version of GPS IFD
##### setVersionID(byte[] value)
```
public final void setVersionID(byte[] value)
```

Sets the version of GPS IFD.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The version of GPS IFD |

### ExifIfdPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/exififdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public final class ExifIfdPackage extends ExifDictionaryBasePackage
```

Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCameraOwnerName() | Gets the camera owner's name. |
| setCameraOwnerName(String value) | Sets the camera owner's name. |
| getBodySerialNumber() | Gets the camera body serial number. |
| setBodySerialNumber(String value) | Sets the camera body serial number. |
| getCfaPattern() | Gets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| setCfaPattern(byte[] value) | Sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| getUserComment() | Gets the user comment. |
| setUserComment(String value) | Sets the user comment. |
##### getCameraOwnerName()
```
public final String getCameraOwnerName()
```

Gets the camera owner's name.

**Returns:**
java.lang.String - The name of the camera owner.
##### setCameraOwnerName(String value)
```
public final void setCameraOwnerName(String value)
```

Sets the camera owner's name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the camera owner. |

##### getBodySerialNumber()
```
public final String getBodySerialNumber()
```

Gets the camera body serial number.

**Returns:**
java.lang.String - The camera body serial number.
##### setBodySerialNumber(String value)
```
public final void setBodySerialNumber(String value)
```

Sets the camera body serial number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The camera body serial number. |

##### getCfaPattern()
```
public final byte[] getCfaPattern()
```

Gets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

**Returns:**
byte[] - The color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.
##### setCfaPattern(byte[] value)
```
public final void setCfaPattern(byte[] value)
```

Sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |

##### getUserComment()
```
public final String getUserComment()
```

Gets the user comment.

**Returns:**
java.lang.String - The user comment.
##### setUserComment(String value)
```
public final void setUserComment(String value)
```

Sets the user comment.

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

### ExifPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/exifpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public class ExifPackage extends ExifDictionaryBasePackage
```

Represents an EXIF metadata package (Exchangeable Image File Format).

This code sample demonstrates how to update common EXIF properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IExif root = (IExif) metadata.getRootPackage();
>      // Set the EXIF package if it's missing
>      if (root.getExifPackage() == null) {
>          root.setExifPackage(new ExifPackage());
>      }
>      root.getExifPackage().setCopyright("Copyright (C) 2011-2024 GroupDocs. All Rights Reserved.");
>      root.getExifPackage().setImageDescription("test image");
>      root.getExifPackage().setSoftware("GroupDocs.Metadata");
>      // ...
>      root.getExifPackage().getExifIfdPackage().setBodySerialNumber("test");
>      root.getExifPackage().getExifIfdPackage().setCameraOwnerName("GroupDocs");
>      root.getExifPackage().getExifIfdPackage().setUserComment("test comment");
>      // ...
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ExifPackage() | Initializes a new instance of the  ExifPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getGpsPackage() | Gets the GPS data. |
| getExifIfdPackage() | Gets the EXIF IFD data. |
| getThumbnail() | Gets the image thumbnail represented as an array of bytes. |
| getArtist() | Gets the name of the camera owner, photographer or image creator. |
| setArtist(String value) | Sets the name of the camera owner, photographer or image creator. |
| getCopyright() | Gets the copyright notice. |
| setCopyright(String value) | Sets the copyright notice. |
| getDateTime() | Gets the date and time of image creation. |
| setDateTime(String value) | Sets the date and time of image creation. |
| getImageDescription() | Gets a character string giving the title of the image. |
| setImageDescription(String value) | Sets a character string giving the title of the image. |
| getImageLength() | Gets the number of rows of image data. |
| setImageLength(int value) | Sets the number of rows of image data. |
| getImageWidth() | Gets the number of columns of image data, equal to the number of pixels per row. |
| setImageWidth(int value) | Sets the number of columns of image data, equal to the number of pixels per row. |
| getOrientation() | Gets or sets the orientation. |
| setOrientation(int value) | Gets or sets the orientation. |
| getMake() | Gets the manufacturer of the recording equipment. |
| setMake(String value) | Sets the manufacturer of the recording equipment. |
| getModel() | Gets the model name or model number of the equipment. |
| setModel(String value) | Sets the model name or model number of the equipment. |
| getSoftware() | Gets the name and version of the software or firmware of the camera or image input device used to generate the image. |
| setSoftware(String value) | Sets the name and version of the software or firmware of the camera or image input device used to generate the image. |
##### ExifPackage()
```
public ExifPackage()
```

Initializes a new instance of the  ExifPackage  class.

##### getGpsPackage()
```
public final ExifGpsPackage getGpsPackage()
```

Gets the GPS data.

**Returns:**
ExifGpsPackage - The GPS data.
##### getExifIfdPackage()
```
public final ExifIfdPackage getExifIfdPackage()
```

Gets the EXIF IFD data.

**Returns:**
ExifIfdPackage - The EXIF IFD data.
##### getThumbnail()
```
public final byte[] getThumbnail()
```

Gets the image thumbnail represented as an array of bytes.

**Returns:**
byte[] - The image thumbnail represented as an array of bytes.

This feature is not available in trial mode.
##### getArtist()
```
public final String getArtist()
```

Gets the name of the camera owner, photographer or image creator.

**Returns:**
java.lang.String - The name of the camera owner, photographer or image creator.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the name of the camera owner, photographer or image creator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the camera owner, photographer or image creator. |

##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright notice.

**Returns:**
java.lang.String - The copyright notice.
##### setCopyright(String value)
```
public final void setCopyright(String value)
```

Sets the copyright notice.

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

##### getDateTime()
```
public final String getDateTime()
```

Gets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed.

**Returns:**
java.lang.String - The date and time of image creation.
##### setDateTime(String value)
```
public final void setDateTime(String value)
```

Sets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date and time of image creation. |

##### getImageDescription()
```
public final String getImageDescription()
```

Gets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Returns:**
java.lang.String - The image description.
##### setImageDescription(String value)
```
public final void setImageDescription(String value)
```

Sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

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

##### getImageLength()
```
public final int getImageLength()
```

Gets the number of rows of image data.

**Returns:**
int - The number of rows of image data.
##### setImageLength(int value)
```
public final void setImageLength(int value)
```

Sets the number of rows of image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of rows of image data. |

##### getImageWidth()
```
public final int getImageWidth()
```

Gets the number of columns of image data, equal to the number of pixels per row.

**Returns:**
int - The number of columns of image data, equal to the number of pixels per row.
##### setImageWidth(int value)
```
public final void setImageWidth(int value)
```

Sets the number of columns of image data, equal to the number of pixels per row.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of columns of image data, equal to the number of pixels per row. |

##### getOrientation()
```
public final int getOrientation()
```

Gets or sets the orientation.

Value: The orientation.

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

Gets or sets the orientation.

Value: The orientation.

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

##### getMake()
```
public final String getMake()
```

Gets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.

**Returns:**
java.lang.String - The manufacturer of the recording equipment.
##### setMake(String value)
```
public final void setMake(String value)
```

Sets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manufacturer of the recording equipment. |

##### getModel()
```
public final String getModel()
```

Gets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.

**Returns:**
java.lang.String - The model name or model number of the equipment.
##### setModel(String value)
```
public final void setModel(String value)
```

Sets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The model name or model number of the equipment. |

##### getSoftware()
```
public final String getSoftware()
```

Gets the name and version of the software or firmware of the camera or image input device used to generate the image.

**Returns:**
java.lang.String - The name and version of the software or firmware of the camera or image input device used to generate the image.
##### setSoftware(String value)
```
public final void setSoftware(String value)
```

Sets the name and version of the software or firmware of the camera or image input device used to generate the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name and version of the software or firmware of the camera or image input device used to generate the image. |

### FileFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/fileformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum FileFormat extends Enum<FileFormat> implements IEnumValue
```

Represents the recognized format of a loaded file.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The file type is not recognized. |
| Presentation | A presentation file. |
| Spreadsheet | A spreadsheet file. |
| WordProcessing | A word processing file. |
| Diagram | A diagram file. |
| Note | An electronic note file. |
| ProjectManagement | A project management format. |
| Pdf | A PDF file. |
| Tiff | A TIFF image. |
| Jpeg | A JPEG image. |
| Psd | A PSD image. |
| Jpeg2000 | A Jpeg2000 image. |
| Gif | A GIF image. |
| Png | A PNG image. |
| Bmp | A BMP image. |
| Dicom | A DICOM image. |
| WebP | A WEBP image. |
| Emf | An EMF image. |
| Wmf | A WMF image. |
| DjVu | A DjVu file. |
| Wav | A WAV audio file. |
| Mp3 | An Mp3 audio file. |
| Avi | An AVI video. |
| Flv | An FLV video. |
| Asf | An ASF video. |
| Mov | A QuickTime video. |
| Matroska | A video encoded with the Matroska multimedia container. |
| Zip | A ZIP archive. |
| SevenZip | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. |
| VCard | A VCard file. |
| Epub | An EPUB electronic book. |
| OpenType | An OpenType font. |
| Dxf | A DXF (Drawing Exchange Format) drawing. |
| Dwg | A DWG drawing. |
| Eml | An EML email message. |
| Msg | An MSG email message. |
| Torrent | A torrent file that contains metadata about files and folders to be distributed. |
| Heif | A HEIF/HEIC image. |
| Dng | A dng RAW image. |
| Cr2 | A CR2 image. |
| Gltf | A glTF (GL Transmission Format) 3D file. |
| Svg | An SVG (Scalable Vector Graphics) image. |
| Avif | An AVIF (AV1 Image File Format) image. |
| Rar | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final FileFormat Unknown
```

The file type is not recognized.

##### Presentation
```
public static final FileFormat Presentation
```

A presentation file. You must be familiar with PPTX and PPT extension files while working with Microsoft PowerPoint. These are Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/

##### Spreadsheet
```
public static final FileFormat Spreadsheet
```

A spreadsheet file. A spreadsheet file contains data in the form of rows and columns. You can open, view and edit such files using spreadsheet software applications such as Microsoft Excel that is now available for both Windows and MacOS operating system. Similarly, Google sheets is a free online spreadsheet creating and editing tool that works from any web browser. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/

##### WordProcessing
```
public static final FileFormat WordProcessing
```

A word processing file. A word processing file contains 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/

##### Diagram
```
public static final FileFormat Diagram
```

A diagram file.

##### Note
```
public static final FileFormat Note
```

An electronic note file. Note-taking programs such as Microsoft OneNote lets you create, open and edit notes files that contain sections and pages for storing notes. A note document can be as simple as a text document as well as more detailed consisting of digital images, audio/video clips, and hand sketch drawings. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/note-taking/

##### ProjectManagement
```
public static final FileFormat ProjectManagement
```

A project management format. Have you ever come across and wondered what is an MPP file or how to open it? MPP and other similar files are Project file formats that are created by Project Management software such as Microsoft Project. 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/project-management/

##### Pdf
```
public static final FileFormat Pdf
```

A PDF file. 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/

##### Tiff
```
public static final FileFormat Tiff
```

A TIFF image. TIFF or 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/tiff/

##### Jpeg
```
public static final FileFormat Jpeg
```

A JPEG image. JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/jpeg/

##### Psd
```
public static final FileFormat Psd
```

A PSD image. PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. PSD files may include image layers, adjustment layers, layer masks, annotations, file information, keywords and other Photoshop-specific elements. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/psd/

##### Jpeg2000
```
public static final FileFormat Jpeg2000
```

A Jpeg2000 image. JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/jp2/

##### Gif
```
public static final FileFormat Gif
```

A GIF image. A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/gif/

##### Png
```
public static final FileFormat Png
```

A PNG image. PNG, Portable Network Graphics, refers to a type of raster image file format that use lossless compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/png/

##### Bmp
```
public static final FileFormat Bmp
```

A BMP image. Files having extension .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/

##### Dicom
```
public static final FileFormat Dicom
```

A DICOM image. DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is the combination of file format definition and a network communications protocol. Learn more about this file format  [ here ][here] .

[here]: https://wiki.fileformat.com/image/dicom/

##### WebP
```
public static final FileFormat WebP
```

A WEBP image. 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][] .

[here]: https://wiki.fileformat.com/image/webp/

##### Emf
```
public static final FileFormat Emf
```

An EMF image. 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/

##### Wmf
```
public static final FileFormat Wmf
```

A WMF image. Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. To be more accurate, WMF belongs to the vector file format category of Graphics file formats that is device independent. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/wmf/

##### DjVu
```
public static final FileFormat DjVu
```

A DjVu file. DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. It was developed by AT&T Labs. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/djvu/

##### Wav
```
public static final FileFormat Wav
```

A WAV audio file. 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. The format doesn't apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/audio/wav/

##### Mp3
```
public static final FileFormat Mp3
```

An Mp3 audio file. 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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/audio/mp3/

##### Avi
```
public static final FileFormat Avi
```

An AVI video. 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://wiki.fileformat.com/video/avi/

##### Flv
```
public static final FileFormat Flv
```

An FLV video.

##### Asf
```
public static final FileFormat Asf
```

An ASF video. The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/video/wmv/

##### Mov
```
public static final FileFormat Mov
```

A QuickTime video. Mov or QuickTime File format is 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. Mov format is compatible both in Windows and Macintosh systems. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/video/mov/

##### Matroska
```
public static final FileFormat Matroska
```

A video encoded with the Matroska multimedia container.

##### Zip
```
public static final FileFormat Zip
```

A ZIP archive. ZIP file extension represents archives 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. ZIP file format was made public back in February 1989 by Phil Katz for achieving archiving of files and folders. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/compression/zip/

##### SevenZip
```
public static final FileFormat SevenZip
```

7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License.

##### VCard
```
public static final FileFormat VCard
```

A VCard file. 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/

##### Epub
```
public static final FileFormat Epub
```

An EPUB electronic book. Files with .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/

##### OpenType
```
public static final FileFormat OpenType
```

An OpenType font.

##### Dxf
```
public static final FileFormat Dxf
```

A DXF (Drawing Exchange Format) drawing. DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Each element in the file has a prefix integer number called a group code. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/cad/dxf/

##### Dwg
```
public static final FileFormat Dwg
```

A DWG drawing. 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][] .

[here]: https://wiki.fileformat.com/cad/dwg/

##### Eml
```
public static final FileFormat Eml
```

An EML email message. 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/

##### Msg
```
public static final FileFormat Msg
```

An MSG email message. MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Such messages may contain one or more email fields, with the sender, recipient, subject, date, and message body, or contact information, appointment particulars, and one or more task specifications. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/email/msg/

##### Torrent
```
public static final FileFormat Torrent
```

A torrent file that contains metadata about files and folders to be distributed.

##### Heif
```
public static final FileFormat Heif
```

A HEIF/HEIC image.

##### Dng
```
public static final FileFormat Dng
```

A dng RAW image.

##### Cr2
```
public static final FileFormat Cr2
```

A CR2 image.

##### Gltf
```
public static final FileFormat Gltf
```

A glTF (GL Transmission Format) 3D file.

##### Svg
```
public static final FileFormat Svg
```

An SVG (Scalable Vector Graphics) image.

##### Avif
```
public static final FileFormat Avif
```

An AVIF (AV1 Image File Format) image.

##### Rar
```
public static final FileFormat Rar
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.

##### Tar
```
public static final FileFormat Tar
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.

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

**Returns:**
com.groupdocs.metadata.core.FileFormat[]
##### valueOf(String name)
```
public static FileFormat valueOf(String name)
```

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

**Returns:**
FileFormat
##### getByRawValue(int rawValue)
```
public static FileFormat getByRawValue(int rawValue)
```

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

**Returns:**
FileFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### FileType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/filetype.md

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

Represents the file type.

[Supported Document Formats]: https://docs.groupdocs.com/metadata/java/supported-document-formats/
[Get supported file formats]: https://docs.groupdocs.com/metadata/java/get-supported-file-formats/
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| TORRENT | Represents TORRENT file type. |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. |
| POT | Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. |
| XLS | Files with XLS extension represent 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 | Files with XLSM extension is a type of Spreasheet files that support Macros. |
| 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. |
| ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| 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. |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | DOCX is a well-known format for Microsoft Word documents. |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| XLSB | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. |
| TTF | TTF represents font files based on the TrueType specifications font technology. |
| TTC | TTC (TrueType Collection) is a TrueType font collection format. |
| OTF | A file with .otf extension refers to OpenType font format. |
| OTC | OTC (OpenType Collection) is a OpenType font collection format. |
| ONE | File represented by .ONE extension are created by Microsoft OneNote application. |
| ZIP | ZIP file extension represents archives that can hold one or more files or directories. |
| ZIPX | ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods. |
| JAR | JAR is a Java Archive file that contains many different application related files as a single file. |
| VCF | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| VCR | VCR (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| EML | EML file format represents email messages saved using Outlook and other relevant applications. |
| MSG | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. |
| 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. |
| 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. |
| BMP | Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images. |
| 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. |
| DJV | DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. |
| GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. |
| JPG | A JPEG is a type of image format that is saved using the method of lossy compression. |
| JPE | A JPEG 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. |
| JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. |
| J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. |
| MJ2 | Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression. |
| PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. |
| TIFF | TIFF or 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. |
| TIF | TIFF or 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. |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. |
| EMF | Enhanced metafile format (EMF) stores graphical images device-independently. |
| WMF | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. |
| PSD | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. |
| MPP | MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. |
| MPT | MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. |
| VSD | VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. |
| VDX | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. |
| 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. |
| VSX | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. |
| VTX | Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. |
| DICOM | DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. |
| HEIF | An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. |
| HEIC | An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. |
| DWG | Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. |
| DXF | DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. |
| AVI | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. |
| MOV | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. |
| QT | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. |
| MKA | MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. |
| 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. |
| MK3D | MK3D is actually stereoscopic 3D video created using Matroska 3D format. |
| WEBM | WEBM is a video file based on the open, royalty-free WebM file format. |
| FLV | FLV (Flash Video) is a container file format which is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. |
| ASF | The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. |
| DNG | DNG is a digital camera image format used for the storage of raw files. |
| CR2 | The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. |
| SEVENZIP | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. |
| RAR | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| TAR | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
| GLTF | glTF (GL Transmission Format) is a 3D file format used for 3D scenes and models. |
| SVG | SVG (Scalable Vector Graphics) is an XML-based vector image format. |
| AVIF | AVIF (AV1 Image File Format) is an image format based on the AV1 video codec. |
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Gets the file type description. |
| getExtension() | Gets the file extension. |
| getFileFormat() | Gets the file format. |
| toString() | Returns a String that represents the current  FileType . |
| getSupportedFileTypes() | Retrieves supported file types. |
| fromExtension(String fileExtension) | Gets FileType for provided fileExtension |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### TORRENT
```
public static final FileType TORRENT
```

Represents TORRENT file type.

##### PDF
```
public static final FileType 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/

##### PPT
```
public static final FileType 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/

##### PPTX
```
public static final FileType 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/

##### POTX
```
public static final FileType 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/

##### PPTM
```
public static final FileType 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/

##### POTM
```
public static final FileType 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/

##### PPS
```
public static final FileType 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/

##### PPSX
```
public static final FileType 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/

##### PPSM
```
public static final FileType 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/

##### POT
```
public static final FileType POT
```

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pot/

##### XLS
```
public static final FileType XLS
```

Files with XLS extension represent 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/specification/spreadsheet/xls/

##### XLSX
```
public static final FileType 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/specification/spreadsheet/xlsx/

##### XLSM
```
public static final FileType XLSM
```

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlsm/

##### XLT
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlt/

##### ODT
```
public static final FileType ODT
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt/

##### DOT
```
public static final FileType 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/

##### DOC
```
public static final FileType 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/

##### DOCX
```
public static final FileType 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/

##### XLTX
```
public static final FileType XLTX
```

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltx/

##### DOTX
```
public static final FileType 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/

##### ODS
```
public static final FileType ODS
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ods/

##### XLTM
```
public static final FileType XLTM
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltm/

##### XLSB
```
public static final FileType 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/specification/spreadsheet/xlsb/

##### DOTM
```
public static final FileType 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/

##### DOCM
```
public static final FileType 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/

##### EPUB
```
public static final FileType EPUB
```

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/epub/

##### TTF
```
public static final FileType TTF
```

TTF represents font files based on the TrueType specifications font technology. TrueType fonts provide highest quality display on computer screens and printers without any dependency on resolution. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/ttf/

##### TTC
```
public static final FileType TTC
```

TTC (TrueType Collection) is a TrueType font collection format. A TTC file can combine the multiple font files into it. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/ttc/

##### OTF
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/otf/

##### OTC
```
public static final FileType OTC
```

OTC (OpenType Collection) is a OpenType font collection format. An OTC file can combine the multiple font files into it.

##### ONE
```
public static final FileType ONE
```

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/note-taking/one/

##### ZIP
```
public static final FileType ZIP
```

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/zip/

##### ZIPX
```
public static final FileType ZIPX
```

ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods.

##### JAR
```
public static final FileType JAR
```

JAR is a Java Archive file that contains many different application related files as a single file. This file format was created to reduce the speed of loading a downloaded Java Applet in browser via HTTP transaction, Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/jar/

##### VCF
```
public static final FileType 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://docs.fileformat.com/email/vcf/

##### VCR
```
public static final FileType VCR
```

VCR (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.

##### EML
```
public static final FileType EML
```

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml/

##### MSG
```
public static final FileType 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/

##### MP3
```
public static final FileType 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://wiki.fileformat.com/audio/mp3/

##### WAV
```
public static final FileType 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][].

[here]: https://wiki.fileformat.com/audio/wav/

##### BMP
```
public static final FileType BMP
```

Files having extension .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/

##### DJVU
```
public static final FileType 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/

##### DJV
```
public static final FileType DJV
```

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/

##### GIF
```
public static final FileType GIF
```

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif/

##### JPG
```
public static final FileType JPG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JPE
```
public static final FileType JPE
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JPEG
```
public static final FileType JPEG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JP2
```
public static final FileType JP2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2/

##### J2K
```
public static final FileType J2K
```

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2k/

##### JPF
```
public static final FileType JPF
```

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpf/

##### JPX
```
public static final FileType JPX
```

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpx/

##### JPM
```
public static final FileType JPM
```

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpm/

##### MJ2
```
public static final FileType MJ2
```

Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression.

##### PNG
```
public static final FileType PNG
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/png/

##### TIFF
```
public static final FileType TIFF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### TIF
```
public static final FileType TIF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### WEBP
```
public static final FileType 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][].

[here]: https://wiki.fileformat.com/image/webp/

##### EMF
```
public static final FileType EMF
```

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/emf/

##### WMF
```
public static final FileType 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/

##### PSD
```
public static final FileType 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/

##### MPP
```
public static final FileType MPP
```

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpp/

##### MPT
```
public static final FileType MPT
```

MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpt/

##### VSD
```
public static final FileType 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/visio/vsd/

##### VDX
```
public static final FileType VDX
```

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vdx/

##### VSDX
```
public static final FileType VSDX
```

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vsdx/

##### VSS
```
public static final FileType 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/visio/vss/

##### VSX
```
public static final FileType VSX
```

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vsx/

##### VTX
```
public static final FileType VTX
```

Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/visio/vtx/

##### DICOM
```
public static final FileType DICOM
```

DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is used for the integration of medical imaging devices like printers, servers, scanners etc from various vendors and also contains identification data of each patient for uniqueness. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/dicom/

##### HEIF
```
public static final FileType HEIF
```

An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. HEIF file format compresses the images using the High Efficiency Video Coding (HEVC) standard. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/heif/

##### HEIC
```
public static final FileType HEIC
```

An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. HEIC, like HEIF, are compressed using the High Efficiency Video Coding (HEVC) standard and are smaller in size without compromising the quality. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/heic/

##### DWG
```
public static final FileType DWG
```

Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwg/

##### DXF
```
public static final FileType 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/

##### AVI
```
public static final FileType AVI
```

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/avi/

##### MOV
```
public static final FileType MOV
```

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/

##### QT
```
public static final FileType QT
```

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/

##### MKA
```
public static final FileType MKA
```

MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. The MKA format supports several different kinds of audio compression algorithms such as MP3, AAC and Vobis. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/mka/

##### MKV
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/mkv/

##### MK3D
```
public static final FileType MK3D
```

MK3D is actually stereoscopic 3D video created using Matroska 3D format. The MKV file container uses a StereoMode field\\u2019s value to define the type of stereoscopic 3D video stuff. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/mk3d/

##### WEBM
```
public static final FileType WEBM
```

WEBM 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/

##### FLV
```
public static final FileType FLV
```

FLV (Flash Video) is a container file format which 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/

##### ASF
```
public static final FileType ASF
```

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/wmv/

##### DNG
```
public static final FileType 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. DNG is an extension of TIFF/EP standard format and uses metadata significantly. In order to manipulate raw data from digital cameras with the ease of flexibility and artistic control, photographers opt camera raw files. JPEG and TIFF formats store images that are processed by the camera, therefore, not much room for alteration is available in such formats. [here][].

[here]: https://wiki.fileformat.com/image/dng/

##### CR2
```
public static final FileType CR2
```

The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. [here][].

[here]: https://wiki.fileformat.com/image/cr2/

##### SEVENZIP
```
public static final FileType SEVENZIP
```

7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License.  [here][] .

[here]: https://wiki.fileformat.com/compression/zip/

##### RAR
```
public static final FileType RAR
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.  [here][] .

[here]: https://wiki.fileformat.com/compression/rar/

##### TAR
```
public static final FileType TAR
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.  [here][] .

[here]: https://wiki.fileformat.com/compression/tar/

##### GLTF
```
public static final FileType GLTF
```

glTF (GL Transmission Format) is a 3D file format used for 3D scenes and models.

##### SVG
```
public static final FileType SVG
```

SVG (Scalable Vector Graphics) is an XML-based vector image format.

##### AVIF
```
public static final FileType AVIF
```

AVIF (AV1 Image File Format) is an image format based on the AV1 video codec.

##### getDescription()
```
public final String getDescription()
```

Gets the file type description.

**Returns:**
java.lang.String - The file type description.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension.

**Returns:**
java.lang.String - The file extension.
##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the file format.

**Returns:**
FileFormat - The file format.
##### toString()
```
public String toString()
```

Returns a String that represents the current  FileType .

**Returns:**
java.lang.String - A String that represents the current  FileType .
##### getSupportedFileTypes()
```
public static Iterable<FileType> getSupportedFileTypes()
```

Retrieves supported file types.

**Returns:**
java.lang.Iterable<com.groupdocs.metadata.core.FileType> - A collection of supported file types.
##### 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

### FileTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/filetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class FileTypePackage extends CustomPackage
```

Represents a metadata package containing file format information.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
[Supported file formats]: https://docs.groupdocs.com/display/metadatajava/Supported+File+Formats
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets the file format. |
| getMimeType() | Gets the MIME type. |
| getExtension() | Gets the file extension. |
##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the file format.

**Returns:**
FileFormat - The file format.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type.

**Returns:**
java.lang.String - The MIME type value.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension.

**Returns:**
java.lang.String - The file extension.

### FlvHeader
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/flvheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class FlvHeader extends CustomPackage
```

Represents a FLV video header.

[Working with metadata in FLV files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+FLV+files
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the file version. |
| getTypeFlags() | Gets the FLV type flags. |
| hasAudioTags() | Gets a value indicating whether audio tags are present in the file. |
| hasVideoTags() | Gets a value indicating whether video tags are present in the file. |
##### getVersion()
```
public final byte getVersion()
```

Gets the file version.

**Returns:**
byte - The file version.
##### getTypeFlags()
```
public final byte getTypeFlags()
```

Gets the FLV type flags.

**Returns:**
byte - The FLV type flags.
##### hasAudioTags()
```
public final boolean hasAudioTags()
```

Gets a value indicating whether audio tags are present in the file.

**Returns:**
boolean - True if the FLV file contains audio tags; otherwise, false.
##### hasVideoTags()
```
public final boolean hasVideoTags()
```

Gets a value indicating whether video tags are present in the file.

**Returns:**
boolean - True if the FLV file contains video tags; otherwise, false.

### FlvRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/flvrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class FlvRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an FLV video.

This example shows how to read FLV header properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputFlv)) {
>      FlvRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getHeader().getVersion());
>      System.out.println(root.getHeader().hasAudioTags());
>      System.out.println(root.getHeader().hasVideoTags());
>      System.out.println(root.getHeader().getTypeFlags());
>  }
>
> ```
> ```

[Working with metadata in FLV files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+FLV+files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getHeader() | Gets the FLV header package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getHeader()
```
public final FlvHeader getHeader()
```

Gets the FLV header package.

**Returns:**
FlvHeader - The FLV header package.

### GifImageTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/gifimagetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage, com.groupdocs.metadata.core.ImageTypePackage
```
public class GifImageTypePackage extends ImageTypePackage
```

Represents a metadata package containing GIF-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the format. |
##### getVersion()
```
public final String getVersion()
```

Gets the version of the format.

**Returns:**
java.lang.String - The version of the format.

### GifRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/gifrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class GifRootPackage extends ImageRootPackage implements IXmp
```

Represents the root package intended to work with metadata in a GIF image.

This code snippet shows how to detect the version of a loaded GIF image and extract some additional file format information.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputGif)) {
>      GifRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getGifImageType().getFileFormat());
>      System.out.println(root.getGifImageType().getVersion());
>      System.out.println(root.getGifImageType().getByteOrder());
>      System.out.println(root.getGifImageType().getMimeType());
>      System.out.println(root.getGifImageType().getExtension());
>      System.out.println(root.getGifImageType().getWidth());
>      System.out.println(root.getGifImageType().getHeight());
>  }
>
> ```
> ```

[Working with metadata in GIF images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+GIF+images
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGifImageType() | Gets the file type metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| isXmpSupported() | Gets a value indicating whether the XMP metadata is supported for this image. |
##### getGifImageType()
```
public final GifImageTypePackage getGifImageType()
```

Gets the file type metadata package.

**Returns:**
GifImageTypePackage - The file type metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### isXmpSupported()
```
public final boolean isXmpSupported()
```

Gets a value indicating whether the XMP metadata is supported for this image.

**Returns:**
boolean - True if the XMP metadata is supported for this image; otherwise, false.

### GpsIfdPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/gpsifdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class GpsIfdPackage extends RawDictionaryBasePackage
```

Represents GPS IFD.
#### Methods

| Method | Description |
| --- | --- |
| getGPSVersionID() | Gets the GPSVersionID. |
| getGPSLatitudeRef() | Gets the GPSLatitudeRef. |
| getGPSLatitude() | Gets the GPSLatitude. |
| getGPSLongitudeRef() | Gets the GPSLongitudeRef. |
| getGPSLongitude() | Gets the GPSLongitude. |
| getGPSAltitudeRef() | Gets the GPSAltitudeRef. |
| getGPSAltitude() | Gets the GPSAltitude. |
| getGPSTimeStamp() | Gets the GPSTimeStamp. |
| getGPSSatellites() | Gets the GPSSatellites. |
| getGPSStatus() | Gets the GPSStatus. |
| getGPSMeasureMode() | Gets the GPSMeasureMode. |
| getGPSDOP() | Gets the GPSDOP. |
| getGPSSpeedRef() | Gets the GPSSpeedRef. |
| getGPSSpeed() | Gets the GPSSpeed. |
| getGPSTrackRef() | Gets the GPSTrackRef. |
| getGPSTrack() | Gets the GPSTrack. |
| getGPSImgDirectionRef() | Gets the GPSImgDirectionRef. |
| getGPSImgDirection() | Gets the GPSImgDirection. |
| getGPSMapDatum() | Gets the GPSMapDatum. |
| getGPSDestLatitudeRef() | Gets the GPSDestLatitudeRef. |
| getGPSDestLatitude() | Gets the GPSDestLatitude. |
| getGPSDestLongitudeRef() | Gets the GPSDestLongitudeRef. |
| getGPSDestLongitude() | Gets the GPSDestLongitude. |
| getGPSDestBearingRef() | Gets the GPSDestBearingRef. |
| getGPSDestBearing() | Gets the GPSDestBearing. |
| getGPSDestDistanceRef() | Gets the GPSDestDistanceRef. |
| getGPSDestDistance() | Gets the GPSDestDistance. |
| getGPSProcessingMethod() | Gets the GPSProcessingMethod. |
| getGPSAreaInformation() | Gets the GPSAreaInformation. |
| getGPSDateStamp() | Gets the GPSDateStamp. |
| getGPSDifferential() | Gets the GPSDifferential. |
| getGPSHPositioningError() | Gets the GPSHPositioningError. |
##### getGPSVersionID()
```
public final byte[] getGPSVersionID()
```

Gets the GPSVersionID.

**Returns:**
byte[] - The GPSVersionID.
##### getGPSLatitudeRef()
```
public final String getGPSLatitudeRef()
```

Gets the GPSLatitudeRef.

**Returns:**
java.lang.String - The GPSLatitudeRef.
##### getGPSLatitude()
```
public final double[] getGPSLatitude()
```

Gets the GPSLatitude.

**Returns:**
double[] - The GPSLatitude.
##### getGPSLongitudeRef()
```
public final String getGPSLongitudeRef()
```

Gets the GPSLongitudeRef.

**Returns:**
java.lang.String - The GPSLongitudeRef.
##### getGPSLongitude()
```
public final double[] getGPSLongitude()
```

Gets the GPSLongitude.

**Returns:**
double[] - The GPSLongitude.
##### getGPSAltitudeRef()
```
public final byte getGPSAltitudeRef()
```

Gets the GPSAltitudeRef.

**Returns:**
byte - The GPSAltitudeRef.
##### getGPSAltitude()
```
public final float getGPSAltitude()
```

Gets the GPSAltitude.

**Returns:**
float - The GPSAltitude.
##### getGPSTimeStamp()
```
public final double[] getGPSTimeStamp()
```

Gets the GPSTimeStamp.

**Returns:**
double[] - The GPSTimeStamp.
##### getGPSSatellites()
```
public final String getGPSSatellites()
```

Gets the GPSSatellites.

**Returns:**
java.lang.String - The GPSSatellites.
##### getGPSStatus()
```
public final String getGPSStatus()
```

Gets the GPSStatus.

**Returns:**
java.lang.String - The GPSStatus.
##### getGPSMeasureMode()
```
public final String getGPSMeasureMode()
```

Gets the GPSMeasureMode.

**Returns:**
java.lang.String - The GPSMeasureMode.
##### getGPSDOP()
```
public final float getGPSDOP()
```

Gets the GPSDOP.

**Returns:**
float - The GPSDOP.
##### getGPSSpeedRef()
```
public final String getGPSSpeedRef()
```

Gets the GPSSpeedRef.

**Returns:**
java.lang.String - The GPSSpeedRef.
##### getGPSSpeed()
```
public final float getGPSSpeed()
```

Gets the GPSSpeed.

**Returns:**
float - The GPSSpeed.
##### getGPSTrackRef()
```
public final String getGPSTrackRef()
```

Gets the GPSTrackRef.

**Returns:**
java.lang.String - The GPSTrackRef.
##### getGPSTrack()
```
public final float getGPSTrack()
```

Gets the GPSTrack.

**Returns:**
float - The GPSTrack.
##### getGPSImgDirectionRef()
```
public final String getGPSImgDirectionRef()
```

Gets the GPSImgDirectionRef.

**Returns:**
java.lang.String - The GPSImgDirectionRef.
##### getGPSImgDirection()
```
public final float getGPSImgDirection()
```

Gets the GPSImgDirection.

**Returns:**
float - The GPSImgDirection.
##### getGPSMapDatum()
```
public final String getGPSMapDatum()
```

Gets the GPSMapDatum.

**Returns:**
java.lang.String - The GPSMapDatum.
##### getGPSDestLatitudeRef()
```
public final String getGPSDestLatitudeRef()
```

Gets the GPSDestLatitudeRef.

**Returns:**
java.lang.String - The GPSDestLatitudeRef.
##### getGPSDestLatitude()
```
public final double[] getGPSDestLatitude()
```

Gets the GPSDestLatitude.

**Returns:**
double[] - The GPSDestLatitude.
##### getGPSDestLongitudeRef()
```
public final String getGPSDestLongitudeRef()
```

Gets the GPSDestLongitudeRef.

**Returns:**
java.lang.String - The GPSDestLongitudeRef.
##### getGPSDestLongitude()
```
public final double[] getGPSDestLongitude()
```

Gets the GPSDestLongitude.

**Returns:**
double[] - The GPSDestLongitude.
##### getGPSDestBearingRef()
```
public final String getGPSDestBearingRef()
```

Gets the GPSDestBearingRef.

**Returns:**
java.lang.String - The GPSDestBearingRef.
##### getGPSDestBearing()
```
public final float getGPSDestBearing()
```

Gets the GPSDestBearing.

**Returns:**
float - The GPSDestBearing.
##### getGPSDestDistanceRef()
```
public final String getGPSDestDistanceRef()
```

Gets the GPSDestDistanceRef.

**Returns:**
java.lang.String - The GPSDestDistanceRef.
##### getGPSDestDistance()
```
public final float getGPSDestDistance()
```

Gets the GPSDestDistance.

**Returns:**
float - The GPSDestDistance.
##### getGPSProcessingMethod()
```
public final String getGPSProcessingMethod()
```

Gets the GPSProcessingMethod.

**Returns:**
java.lang.String - The GPSProcessingMethod.
##### getGPSAreaInformation()
```
public final int getGPSAreaInformation()
```

Gets the GPSAreaInformation.

**Returns:**
int - The GPSAreaInformation.
##### getGPSDateStamp()
```
public final String getGPSDateStamp()
```

Gets the GPSDateStamp.

**Returns:**
java.lang.String - The GPSDateStamp.
##### getGPSDifferential()
```
public final int getGPSDifferential()
```

Gets the GPSDifferential.

**Returns:**
int - The GPSDifferential.
##### getGPSHPositioningError()
```
public final float getGPSHPositioningError()
```

Gets the GPSHPositioningError.

**Returns:**
float - The GPSHPositioningError.

### GroupDocsMetadataException
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/groupdocsmetadataexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception
```
public class GroupDocsMetadataException extends System.Exception
```

Represents a product-specific exception that is thrown during file processing.
#### Constructors

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

Initializes a new instance of the  GroupDocsMetadataException  class.

##### GroupDocsMetadataException(String message)
```
public GroupDocsMetadataException(String message)
```

Initializes a new instance of the  GroupDocsMetadataException  class.

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

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

Initializes a new instance of the  GroupDocsMetadataException  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. |

### HeifRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/heifrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class HeifRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a HEIF image.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

### ID3Tag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class ID3Tag extends CustomPackage
```

Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the ID3 tag in string format. |
##### getVersion()
```
public abstract String getVersion()
```

Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'.

**Returns:**
java.lang.String - The ID3 version.

### ID3V1Genre
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v1genre.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ID3V1Genre implements IEnumValue
```

Specifies genres used in an Id3v1 tag.
#### Fields

| Field | Description |
| --- | --- |
| Blues | Represents the Blues genre. |
| ClassicRock | Represents the Classic Rock genre. |
| Country | Represents the Country genre. |
| Dance | Represents the Dance genre. |
| Disco | Represents the Disco genre. |
| Funk | Represents the Funk genre. |
| Grunge | Represents the Grunge genre. |
| HipHop | Represents the Hip-Hop genre. |
| Jazz | Represents the Jazz genre. |
| Metal | Represents the Metal genre. |
| NewAge | Represents the New Age genre. |
| Oldies | Represents the Oldies genre. |
| Other | Represents the Other genre. |
| Pop | Represents the Pop genre. |
| RhythmAndBlues | Represents the Rhythm and Blues genre. |
| Rap | Represents the Rap genre. |
| Reggae | Represents the Reggae genre. |
| Rock | Represents the Rock genre. |
| Techno | Represents the Techno genre. |
| Industrial | Represents the Industrial genre. |
| Alternative | Represents the Alternative genre. |
| Ska | Represents the Ska genre. |
| DeathMetal | Represents the Death Metal genre. |
| Pranks | Represents the Pranks genre. |
| Soundtrack | Represents the Soundtrack genre. |
| EuroTechno | Represents the Euro-Techno genre. |
| Ambient | Represents the Ambient genre. |
| TripHop | Represents the Trip-Hop genre. |
| Vocal | Represents the Vocal genre. |
| JazzAndFunk | Represents the JazzAndFunk genre. |
| Fusion | Represents the Fusion genre. |
| Trance | Represents the Trance genre. |
| Classical | Represents the Classical genre. |
| Instrumental | Represents the Instrumental genre. |
| Acid | Represents the Acid genre. |
| House | Represents the House genre. |
| Game | Represents the Game genre. |
| SoundClip | Represents the Sound Clip genre. |
| Gospel | Represents the Gospel genre. |
| Noise | Represents the Noise genre. |
| AlternativeRock | Represents the Alternative Rock genre. |
| Bass | Represents the Bass genre. |
| Soul | Represents the Soul genre. |
| Punk | Represents the Punk genre. |
| Space | Represents the Space genre. |
| Meditative | Represents the Meditative genre. |
| InstrumentalPop | Represents the Instrumental Pop genre. |
| InstrumentalRock | Represents the Instrumental Rock genre. |
| Ethnic | Represents the Ethnic genre. |
| Gothic | Represents the Gothic genre. |
| Darkwave | Represents the Darkwave genre. |
| TechnoIndustrial | Represents the Techno-Industrial genre. |
| Electronic | Represents the Electronic genre. |
| PopFolk | Represents the Pop-Folk genre. |
| Eurodance | Represents the Eurodance genre. |
| Dream | Represents the Dream genre. |
| SouthernRock | Represents the Southern Rock genre. |
| Comedy | Represents the Comedy genre. |
| Cult | Represents the Cult genre. |
| Gangsta | Represents the Gangsta genre. |
| Top40 | Represents the Top 40 genre. |
| ChristianRap | Represents the Christian Rap genre. |
| PopFunk | Represents the Pop/Funk genre. |
| Jungle | Represents the Jungle genre. |
| NativeAmerican | Represents the Native American genre. |
| Cabaret | Represents the Cabaret genre. |
| NewWave | Represents the New Wave genre. |
| Psychedelic | Represents the Psychedelic genre. |
| Rave | Represents the Rave genre. |
| Showtunes | Represents the Showtunes genre. |
| Trailer | Represents the Trailer genre. |
| LoFi | Represents the Lo-Fi genre. |
| Tribal | Represents the Tribal genre. |
| AcidPunk | Represents the Acid Punk genre. |
| AcidJazz | Represents the Acid Jazz genre. |
| Polka | Represents the Polka genre. |
| Retro | Represents the Retro genre. |
| Musical | Represents the Musical genre. |
| RockNRoll | Represents the Rock 'n' Roll genre. |
| HardRock | Represents the Hard Rock genre. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Blues
```
public static final ID3V1Genre Blues
```

Represents the Blues genre.

##### ClassicRock
```
public static final ID3V1Genre ClassicRock
```

Represents the Classic Rock genre.

##### Country
```
public static final ID3V1Genre Country
```

Represents the Country genre.

##### Dance
```
public static final ID3V1Genre Dance
```

Represents the Dance genre.

##### Disco
```
public static final ID3V1Genre Disco
```

Represents the Disco genre.

##### Funk
```
public static final ID3V1Genre Funk
```

Represents the Funk genre.

##### Grunge
```
public static final ID3V1Genre Grunge
```

Represents the Grunge genre.

##### HipHop
```
public static final ID3V1Genre HipHop
```

Represents the Hip-Hop genre.

##### Jazz
```
public static final ID3V1Genre Jazz
```

Represents the Jazz genre.

##### Metal
```
public static final ID3V1Genre Metal
```

Represents the Metal genre.

##### NewAge
```
public static final ID3V1Genre NewAge
```

Represents the New Age genre.

##### Oldies
```
public static final ID3V1Genre Oldies
```

Represents the Oldies genre.

##### Other
```
public static final ID3V1Genre Other
```

Represents the Other genre.

##### Pop
```
public static final ID3V1Genre Pop
```

Represents the Pop genre.

##### RhythmAndBlues
```
public static final ID3V1Genre RhythmAndBlues
```

Represents the Rhythm and Blues genre.

##### Rap
```
public static final ID3V1Genre Rap
```

Represents the Rap genre.

##### Reggae
```
public static final ID3V1Genre Reggae
```

Represents the Reggae genre.

##### Rock
```
public static final ID3V1Genre Rock
```

Represents the Rock genre.

##### Techno
```
public static final ID3V1Genre Techno
```

Represents the Techno genre.

##### Industrial
```
public static final ID3V1Genre Industrial
```

Represents the Industrial genre.

##### Alternative
```
public static final ID3V1Genre Alternative
```

Represents the Alternative genre.

##### Ska
```
public static final ID3V1Genre Ska
```

Represents the Ska genre.

##### DeathMetal
```
public static final ID3V1Genre DeathMetal
```

Represents the Death Metal genre.

##### Pranks
```
public static final ID3V1Genre Pranks
```

Represents the Pranks genre.

##### Soundtrack
```
public static final ID3V1Genre Soundtrack
```

Represents the Soundtrack genre.

##### EuroTechno
```
public static final ID3V1Genre EuroTechno
```

Represents the Euro-Techno genre.

##### Ambient
```
public static final ID3V1Genre Ambient
```

Represents the Ambient genre.

##### TripHop
```
public static final ID3V1Genre TripHop
```

Represents the Trip-Hop genre.

##### Vocal
```
public static final ID3V1Genre Vocal
```

Represents the Vocal genre.

##### JazzAndFunk
```
public static final ID3V1Genre JazzAndFunk
```

Represents the JazzAndFunk genre.

##### Fusion
```
public static final ID3V1Genre Fusion
```

Represents the Fusion genre.

##### Trance
```
public static final ID3V1Genre Trance
```

Represents the Trance genre.

##### Classical
```
public static final ID3V1Genre Classical
```

Represents the Classical genre.

##### Instrumental
```
public static final ID3V1Genre Instrumental
```

Represents the Instrumental genre.

##### Acid
```
public static final ID3V1Genre Acid
```

Represents the Acid genre.

##### House
```
public static final ID3V1Genre House
```

Represents the House genre.

##### Game
```
public static final ID3V1Genre Game
```

Represents the Game genre.

##### SoundClip
```
public static final ID3V1Genre SoundClip
```

Represents the Sound Clip genre.

##### Gospel
```
public static final ID3V1Genre Gospel
```

Represents the Gospel genre.

##### Noise
```
public static final ID3V1Genre Noise
```

Represents the Noise genre.

##### AlternativeRock
```
public static final ID3V1Genre AlternativeRock
```

Represents the Alternative Rock genre.

##### Bass
```
public static final ID3V1Genre Bass
```

Represents the Bass genre.

##### Soul
```
public static final ID3V1Genre Soul
```

Represents the Soul genre.

##### Punk
```
public static final ID3V1Genre Punk
```

Represents the Punk genre.

##### Space
```
public static final ID3V1Genre Space
```

Represents the Space genre.

##### Meditative
```
public static final ID3V1Genre Meditative
```

Represents the Meditative genre.

##### InstrumentalPop
```
public static final ID3V1Genre InstrumentalPop
```

Represents the Instrumental Pop genre.

##### InstrumentalRock
```
public static final ID3V1Genre InstrumentalRock
```

Represents the Instrumental Rock genre.

##### Ethnic
```
public static final ID3V1Genre Ethnic
```

Represents the Ethnic genre.

##### Gothic
```
public static final ID3V1Genre Gothic
```

Represents the Gothic genre.

##### Darkwave
```
public static final ID3V1Genre Darkwave
```

Represents the Darkwave genre.

##### TechnoIndustrial
```
public static final ID3V1Genre TechnoIndustrial
```

Represents the Techno-Industrial genre.

##### Electronic
```
public static final ID3V1Genre Electronic
```

Represents the Electronic genre.

##### PopFolk
```
public static final ID3V1Genre PopFolk
```

Represents the Pop-Folk genre.

##### Eurodance
```
public static final ID3V1Genre Eurodance
```

Represents the Eurodance genre.

##### Dream
```
public static final ID3V1Genre Dream
```

Represents the Dream genre.

##### SouthernRock
```
public static final ID3V1Genre SouthernRock
```

Represents the Southern Rock genre.

##### Comedy
```
public static final ID3V1Genre Comedy
```

Represents the Comedy genre.

##### Cult
```
public static final ID3V1Genre Cult
```

Represents the Cult genre.

##### Gangsta
```
public static final ID3V1Genre Gangsta
```

Represents the Gangsta genre.

##### Top40
```
public static final ID3V1Genre Top40
```

Represents the Top 40 genre.

##### ChristianRap
```
public static final ID3V1Genre ChristianRap
```

Represents the Christian Rap genre.

##### PopFunk
```
public static final ID3V1Genre PopFunk
```

Represents the Pop/Funk genre.

##### Jungle
```
public static final ID3V1Genre Jungle
```

Represents the Jungle genre.

##### NativeAmerican
```
public static final ID3V1Genre NativeAmerican
```

Represents the Native American genre.

##### Cabaret
```
public static final ID3V1Genre Cabaret
```

Represents the Cabaret genre.

##### NewWave
```
public static final ID3V1Genre NewWave
```

Represents the New Wave genre.

##### Psychedelic
```
public static final ID3V1Genre Psychedelic
```

Represents the Psychedelic genre.

##### Rave
```
public static final ID3V1Genre Rave
```

Represents the Rave genre.

##### Showtunes
```
public static final ID3V1Genre Showtunes
```

Represents the Showtunes genre.

##### Trailer
```
public static final ID3V1Genre Trailer
```

Represents the Trailer genre.

##### LoFi
```
public static final ID3V1Genre LoFi
```

Represents the Lo-Fi genre.

##### Tribal
```
public static final ID3V1Genre Tribal
```

Represents the Tribal genre.

##### AcidPunk
```
public static final ID3V1Genre AcidPunk
```

Represents the Acid Punk genre.

##### AcidJazz
```
public static final ID3V1Genre AcidJazz
```

Represents the Acid Jazz genre.

##### Polka
```
public static final ID3V1Genre Polka
```

Represents the Polka genre.

##### Retro
```
public static final ID3V1Genre Retro
```

Represents the Retro genre.

##### Musical
```
public static final ID3V1Genre Musical
```

Represents the Musical genre.

##### RockNRoll
```
public static final ID3V1Genre RockNRoll
```

Represents the Rock 'n' Roll genre.

##### HardRock
```
public static final ID3V1Genre HardRock
```

Represents the Hard Rock genre.

##### getByRawValue(int rawValue)
```
public static ID3V1Genre getByRawValue(int rawValue)
```

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

**Returns:**
ID3V1Genre
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### ID3V1Tag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v1tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3Tag
```
public final class ID3V1Tag extends ID3Tag
```

Represents an ID3v1 tag. Please find more information at  [https://en.wikipedia.org/wiki/ID3\#ID3v1][https_en.wikipedia.org_wiki_ID3_ID3v1] .

ID3(v1) tag is a small chunk of extra data at the end of MP3. Please find more information at  http://id3.org/ID3v1 .

This code sample shows how to read the ID3v1 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V1)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getID3V1() != null) {
>          System.out.println(root.getID3V1().getAlbum());
>          System.out.println(root.getID3V1().getArtist());
>          System.out.println(root.getID3V1().getTitle());
>          System.out.println(root.getID3V1().getVersion());
>          System.out.println(root.getID3V1().getComment());
>          // ...
>      }
>  }
>
> ```
> ```

[https_en.wikipedia.org_wiki_ID3_ID3v1]: https://en.wikipedia.org/wiki/ID3#ID3v1
[Handling the ID3v1 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v1+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V1Tag() | Initializes a new instance of the  ID3V1Tag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the ID3 version. |
| getArtist() | Gets the artist. |
| setArtist(String value) | Sets the artist. |
| getAlbum() | Gets the album. |
| setAlbum(String value) | Sets the album. |
| getGenreValue() | Gets the genre identifier. |
| getComment() | Gets the comment. |
| setComment(String value) | Sets the comment. |
| getTitle() | Gets the title. |
| setTitle(String value) | Sets the title. |
| getYear() | Gets the year. |
| setYear(String value) | Sets the year. |
| getTrackNumber() | Gets the track number. |
| setTrackNumber(Integer value) | Sets the track number. |
##### ID3V1Tag()
```
public ID3V1Tag()
```

Initializes a new instance of the  ID3V1Tag  class.

##### getVersion()
```
public String getVersion()
```

Gets the ID3 version. It can be ID3 or ID3v1.1

**Returns:**
java.lang.String - The ID3 version.
##### getArtist()
```
public final String getArtist()
```

Gets the artist. Maximum length is 30 characters.

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

Sets the artist. Maximum length is 30 characters.

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

##### getAlbum()
```
public final String getAlbum()
```

Gets the album. Maximum length is 30 characters.

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

Sets the album. Maximum length is 30 characters.

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

##### getGenreValue()
```
public final ID3V1Genre getGenreValue()
```

Gets the genre identifier.

**Returns:**
ID3V1Genre - The genre identifier.
##### getComment()
```
public final String getComment()
```

Gets the comment. Maximum length is 30 characters.

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

Sets the comment. Maximum length is 30 characters.

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

##### getTitle()
```
public final String getTitle()
```

Gets the title.

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

Sets the title.

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

##### getYear()
```
public final String getYear()
```

Gets the year. Maximum length is 4 characters.

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

Sets the year. Maximum length is 4 characters.

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

##### getTrackNumber()
```
public final Integer getTrackNumber()
```

Gets the track number. Presented in a ID3v1.1 tag only.

**Returns:**
java.lang.Integer - The track number.

If the value of  TrackNumber  is a positive integer then ID3 changes version to 'ID3v1.1' automatically.
##### setTrackNumber(Integer value)
```
public final void setTrackNumber(Integer value)
```

Sets the track number. Presented in a ID3v1.1 tag only.

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

If the value of  TrackNumber  is a positive integer then ID3 changes version to 'ID3v1.1' automatically. |

### ID3V2AttachedPictureFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2attachedpictureframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2AttachedPictureFrame extends ID3V2TagFrame
```

Represents an APIC frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
| ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
| ID3V2AttachedPictureFrame(byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDescriptionEncoding() | Gets the encoding used to encode the picture description. |
| getMimeType() | Gets the MIME type of the picture. |
| getAttachedPictureType() | Gets the type of the picture. |
| getDescription() | Gets the picture description. |
| getPictureData() | Gets the picture data. |
##### ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```
public ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The frame encoding. |
| mimeType | java.lang.String | The MIME-type of the image. |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | java.lang.String | The description of the picture. |
| pictureData | byte[] | The picture data. |

##### ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```
public ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | java.lang.String | The description of the picture. |
| pictureData | byte[] | The picture data. |

##### ID3V2AttachedPictureFrame(byte[] pictureData)
```
public ID3V2AttachedPictureFrame(byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pictureData | byte[] | The picture data. |

##### getDescriptionEncoding()
```
public final ID3V2EncodingType getDescriptionEncoding()
```

Gets the encoding used to encode the picture description.

**Returns:**
ID3V2EncodingType - The encoding used to encode the picture description.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type of the picture.

**Returns:**
java.lang.String - The MIME type of the picture.
##### getAttachedPictureType()
```
public final ID3V2AttachedPictureType getAttachedPictureType()
```

Gets the type of the picture.

**Returns:**
ID3V2AttachedPictureType - The type of the picture.
##### getDescription()
```
public final String getDescription()
```

Gets the picture description. The description has a maximum length of 64 characters, but may be empty.

**Returns:**
java.lang.String - The picture description.
##### getPictureData()
```
public final byte[] getPictureData()
```

Gets the picture data.

**Returns:**
byte[] - The picture data.

### ID3V2AttachedPictureType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2attachedpicturetype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ID3V2AttachedPictureType implements IEnumValue
```

Represents the type of an attached picture.
#### Fields

| Field | Description |
| --- | --- |
| Other | Attached picture of any other type. |
| FileIcon32X32 | 32x32 pixels file icon (PNG only). |
| OtherFileIcon | Other file icon. |
| CoverFront | Cover (front). |
| CoverBack | Cover (back). |
| LeafletPage | Leaflet page. |
| Media | Media (e.g. |
| LeadArtist | Lead artist/lead performer/soloist. |
| Artist | Artist/performer. |
| Conductor | Conductor. |
| Band | Band/Orchestra. |
| Composer | Composer/music author. |
| Lyricist | Lyricist/text writer. |
| RecordingLocation | Recording Location. |
| DuringRecording | During recording. |
| DuringPerformance | During performance. |
| VideoScreenCapture | Movie/video screen capture. |
| BrightColouredFish | A bright coloured fish. |
| Illustration | Illustration. |
| ArtistLogo | Band/artist logotype. |
| StudioLogo | Publisher/Studio logotype. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Other
```
public static final ID3V2AttachedPictureType Other
```

Attached picture of any other type.

##### FileIcon32X32
```
public static final ID3V2AttachedPictureType FileIcon32X32
```

32x32 pixels file icon (PNG only).

##### OtherFileIcon
```
public static final ID3V2AttachedPictureType OtherFileIcon
```

Other file icon.

##### CoverFront
```
public static final ID3V2AttachedPictureType CoverFront
```

Cover (front).

##### CoverBack
```
public static final ID3V2AttachedPictureType CoverBack
```

Cover (back).

##### LeafletPage
```
public static final ID3V2AttachedPictureType LeafletPage
```

Leaflet page.

##### Media
```
public static final ID3V2AttachedPictureType Media
```

Media (e.g. label side of CD).

##### LeadArtist
```
public static final ID3V2AttachedPictureType LeadArtist
```

Lead artist/lead performer/soloist.

##### Artist
```
public static final ID3V2AttachedPictureType Artist
```

Artist/performer.

##### Conductor
```
public static final ID3V2AttachedPictureType Conductor
```

Conductor.

##### Band
```
public static final ID3V2AttachedPictureType Band
```

Band/Orchestra.

##### Composer
```
public static final ID3V2AttachedPictureType Composer
```

Composer/music author.

##### Lyricist
```
public static final ID3V2AttachedPictureType Lyricist
```

Lyricist/text writer.

##### RecordingLocation
```
public static final ID3V2AttachedPictureType RecordingLocation
```

Recording Location.

##### DuringRecording
```
public static final ID3V2AttachedPictureType DuringRecording
```

During recording.

##### DuringPerformance
```
public static final ID3V2AttachedPictureType DuringPerformance
```

During performance.

##### VideoScreenCapture
```
public static final ID3V2AttachedPictureType VideoScreenCapture
```

Movie/video screen capture.

##### BrightColouredFish
```
public static final ID3V2AttachedPictureType BrightColouredFish
```

A bright coloured fish.

##### Illustration
```
public static final ID3V2AttachedPictureType Illustration
```

Illustration.

##### ArtistLogo
```
public static final ID3V2AttachedPictureType ArtistLogo
```

Band/artist logotype.

##### StudioLogo
```
public static final ID3V2AttachedPictureType StudioLogo
```

Publisher/Studio logotype.

##### getByRawValue(int rawValue)
```
public static ID3V2AttachedPictureType getByRawValue(int rawValue)
```

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

**Returns:**
ID3V2AttachedPictureType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### ID3V2CommentFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2commentframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2CommentFrame extends ID3V2TagFrame
```

Represents a COMM frame in an  ID3V2Tag .

This frame is intended for any kind of full text information that does not fit in any other frame.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text) | Initializes a new instance of the  ID3V2CommentFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCommentEncoding() | Gets the encoding of the comment. |
| getLanguage() | Gets the language of the comment (3 characters). |
| getShortContentDescription() | Gets the short content description. |
| getText() | Gets the text of the comment. |
##### ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text)
```
public ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text)
```

Initializes a new instance of the  ID3V2CommentFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the comment. |
| language | java.lang.String | The language of the comment. |
| description | java.lang.String | A short content description. |
| text | java.lang.String | The text of the comment. |

##### getCommentEncoding()
```
public final ID3V2EncodingType getCommentEncoding()
```

Gets the encoding of the comment.

**Returns:**
ID3V2EncodingType - The encoding of the comment.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the comment (3 characters).

**Returns:**
java.lang.String - The language of the comment.
##### getShortContentDescription()
```
public final String getShortContentDescription()
```

Gets the short content description.

**Returns:**
java.lang.String - The short content description.
##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The text of the comment.

### ID3V2EncodingType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2encodingtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ID3V2EncodingType extends Enum<ID3V2EncodingType> implements IEnumValue
```

Defines different types of text encoding used in ID3v2.
#### Fields

| Field | Description |
| --- | --- |
| Iso88591 | The ISO-8859-1 encoding. |
| Utf16 | The UTF-16 encoding with BOM. |
| Utf16Be | The UTF-16 encoding without BOM. |
| Utf8 | The UTF-8 encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Iso88591
```
public static final ID3V2EncodingType Iso88591
```

The ISO-8859-1 encoding.

##### Utf16
```
public static final ID3V2EncodingType Utf16
```

The UTF-16 encoding with BOM.

##### Utf16Be
```
public static final ID3V2EncodingType Utf16Be
```

The UTF-16 encoding without BOM.

##### Utf8
```
public static final ID3V2EncodingType Utf8
```

The UTF-8 encoding.

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

**Returns:**
com.groupdocs.metadata.core.ID3V2EncodingType[]
##### valueOf(String name)
```
public static ID3V2EncodingType valueOf(String name)
```

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

**Returns:**
ID3V2EncodingType
##### getByRawValue(int rawValue)
```
public static ID3V2EncodingType getByRawValue(int rawValue)
```

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

**Returns:**
ID3V2EncodingType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ID3V2MlltFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2mlltframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2MlltFrame extends ID3V2TagFrame
```

Represents an MLLT frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag

### ID3V2PlayCounterFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2playcounterframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2PlayCounterFrame extends ID3V2TagFrame
```

Represents a PCNT frame in an  ID3V2Tag . This is simply a counter of the number of times a file has been played.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the number of times the file has been played. |
##### getValue()
```
public final long getValue()
```

Gets the number of times the file has been played.

**Returns:**
long - The number of times the file has been played.

### ID3V2PrivateFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2privateframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2PrivateFrame extends ID3V2TagFrame
```

Represents a PRIV frame in an  ID3V2Tag . The frame is used to contain information from a software producer that its program uses and does not fit into the other frames.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2PrivateFrame(String ownerIdentifier, byte[] data) | Initializes a new instance of the  ID3V2PrivateFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getOwnerIdentifier() | Gets the owner identifier. |
| getBinaryData() | Gets the binary data. |
##### ID3V2PrivateFrame(String ownerIdentifier, byte[] data)
```
public ID3V2PrivateFrame(String ownerIdentifier, byte[] data)
```

Initializes a new instance of the  ID3V2PrivateFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ownerIdentifier | java.lang.String | The owner identifier. |
| data | byte[] | Frame binary data. |

##### getOwnerIdentifier()
```
public final String getOwnerIdentifier()
```

Gets the owner identifier.

**Returns:**
java.lang.String - The owner identifier.
##### getBinaryData()
```
public final byte[] getBinaryData()
```

Gets the binary data.

**Returns:**
byte[] - The binary data.

### ID3V2Tag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3Tag
```
public final class ID3V2Tag extends ID3Tag
```

Represents an ID3v2 tag. Please find more information at  [https://en.wikipedia.org/wiki/ID3\#ID3v2][https_en.wikipedia.org_wiki_ID3_ID3v2] .

This example shows how to read the ID3v2 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V2)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getID3V2() != null) {
>          System.out.println(root.getID3V2().getAlbum());
>          System.out.println(root.getID3V2().getArtist());
>          System.out.println(root.getID3V2().getBand());
>          System.out.println(root.getID3V2().getTitle());
>          System.out.println(root.getID3V2().getComposers());
>          System.out.println(root.getID3V2().getCopyright());
>          System.out.println(root.getID3V2().getPublisher());
>          System.out.println(root.getID3V2().getOriginalAlbum());
>          System.out.println(root.getID3V2().getMusicalKey());
>          if (root.getID3V2().getAttachedPictures() != null) {
>              for (ID3V2AttachedPictureFrame attachedPicture : root.getID3V2().getAttachedPictures()) {
>                  System.out.println(attachedPicture.getAttachedPictureType());
>                  System.out.println(attachedPicture.getMimeType());
>                  System.out.println(attachedPicture.getDescription());
>                  // ...
>              }
>          }
>          // ...
>      }
>  }
>
> ```
> ```

[https_en.wikipedia.org_wiki_ID3_ID3v2]: https://en.wikipedia.org/wiki/ID3#ID3v2
[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2Tag() | Initializes a new instance of the  ID3V2Tag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the ID3 version. |
| getTagSize() | Gets the size of the tag. |
| getAlbum() | Gets the Album/Movie/Show title. |
| setAlbum(String value) | Sets the Album/Movie/Show title. |
| getArtist() | Gets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |
| setArtist(String value) | Sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |
| getBand() | Gets the Band/Orchestra/Accompaniment. |
| setBand(String value) | Sets the Band/Orchestra/Accompaniment. |
| getBitsPerMinute() | Gets the number of beats per minute in the main part of the audio. |
| setBitsPerMinute(String value) | Sets the number of beats per minute in the main part of the audio. |
| getComposers() | Gets the composers. |
| setComposers(String value) | Sets the composers. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCopyright() | Gets the copyright message. |
| setCopyright(String value) | Sets the copyright message. |
| getDate() | Gets a numeric string in the DDMM format containing the date for the recording. |
| setDate(String value) | Sets a numeric string in the DDMM format containing the date for the recording. |
| getEncodedBy() | Gets the name of the person or organization that encoded the audio file. |
| setEncodedBy(String value) | Sets the name of the person or organization that encoded the audio file. |
| getPublisher() | Gets the name of the label or publisher. |
| setPublisher(String value) | Sets the name of the label or publisher. |
| getTime() | Gets a numeric string in the HHMM format containing the time for the recording. |
| setTime(String value) | Sets a numeric string in the HHMM format containing the time for the recording. |
| getTitle() | Gets the Title/Song name/Content description. |
| setTitle(String value) | Sets the Title/Song name/Content description. |
| getSubtitle() | Gets the Subtitle/Description refinement. |
| setSubtitle(String value) | Sets the Subtitle/Description refinement. |
| getMusicalKey() | Gets the musical key in which the sound starts. |
| setMusicalKey(String value) | Sets the musical key in which the sound starts. |
| getLengthInMilliseconds() | Gets the length of the audio file in milliseconds, represented as a numeric string. |
| setLengthInMilliseconds(String value) | Sets the length of the audio file in milliseconds, represented as a numeric string. |
| getOriginalAlbum() | Gets the original album/movie/show title. |
| setOriginalAlbum(String value) | Sets the original album/movie/show title. |
| getTrackNumber() | Gets a numeric string containing the order number of the audio-file on its original recording. |
| setTrackNumber(String value) | Sets a numeric string containing the order number of the audio-file on its original recording. |
| getSizeInBytes() | Gets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |
| setSizeInBytes(String value) | Sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |
| getIsrc() | Gets the International Standard Recording Code (ISRC) (12 characters). |
| setIsrc(String value) | Sets the International Standard Recording Code (ISRC) (12 characters). |
| getSoftwareHardware() | Gets the used audio encoder and its settings when the file was encoded. |
| setSoftwareHardware(String value) | Sets the used audio encoder and its settings when the file was encoded. |
| getYear() | Gets a numeric string with a year of the recording. |
| setYear(String value) | Sets a numeric string with a year of the recording. |
| getComments() | Gets the user comments. |
| setComments(ID3V2CommentFrame[] value) | Sets the user comments. |
| getAttachedPictures() | Gets the attached pictures directly related to the audio file. |
| setAttachedPictures(ID3V2AttachedPictureFrame[] value) | Sets the attached pictures directly related to the audio file. |
| getTrackPlayCounter() | Gets the number of times the file has been played. |
| toList() | Creates a list from the package. |
| removeAttachedPictures() | Removes all attached pictures stored in APIC frames. |
| get(String frameId) | Gets an array of frames with the specified id. |
| set(ID3V2TagFrame frame) | Removes all frames having the same id as the specified one and adds the new frame to the tag. |
| clear(String frameId) | Removes all frames with the specified id. |
| add(ID3V2TagFrame frame) | Adds a frame to the tag. |
| remove(ID3V2TagFrame frame) | Removes the specified frame from the tag. |
##### ID3V2Tag()
```
public ID3V2Tag()
```

Initializes a new instance of the  ID3V2Tag  class.

##### getVersion()
```
public String getVersion()
```

Gets the ID3 version.

**Returns:**
java.lang.String - The ID3 version.
##### getTagSize()
```
public final int getTagSize()
```

Gets the size of the tag.

**Returns:**
int - The size of the tag.
##### getAlbum()
```
public final String getAlbum()
```

Gets the Album/Movie/Show title. This value is represented by the TALB frame.

**Returns:**
java.lang.String - The Album/Movie/Show title.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the Album/Movie/Show title. This value is represented by the TALB frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Album/Movie/Show title. |

##### getArtist()
```
public final String getArtist()
```

Gets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame.

**Returns:**
java.lang.String - The Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |

##### getBand()
```
public final String getBand()
```

Gets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame.

**Returns:**
java.lang.String - The Band/Orchestra/Accompaniment.
##### setBand(String value)
```
public final void setBand(String value)
```

Sets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Band/Orchestra/Accompaniment. |

##### getBitsPerMinute()
```
public final String getBitsPerMinute()
```

Gets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame.

**Returns:**
java.lang.String - The number of beats per minute in the main part of the audio.
##### setBitsPerMinute(String value)
```
public final void setBitsPerMinute(String value)
```

Sets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The number of beats per minute in the main part of the audio. |

##### getComposers()
```
public final String getComposers()
```

Gets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame.

**Returns:**
java.lang.String - The composers. The names are separated with the "/" character.
##### setComposers(String value)
```
public final void setComposers(String value)
```

Sets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The composers. The names are separated with the "/" character. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type. This value is represented by the TCON frame.

**Returns:**
java.lang.String - The content type.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type. This value is represented by the TCON frame.

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

##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright message. This value is represented by the TCOP frame.

**Returns:**
java.lang.String - The copyright message.

Every time this field is displayed the field must be preceded with "Copyright ?? ".
##### setCopyright(String value)
```
public final void setCopyright(String value)
```

Sets the copyright message. This value is represented by the TCOP frame.

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

Every time this field is displayed the field must be preceded with "Copyright ?? ". |

##### getDate()
```
public final String getDate()
```

Gets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame.

**Returns:**
java.lang.String - A numeric string in the DDMM format containing the date for the recording.
##### setDate(String value)
```
public final void setDate(String value)
```

Sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string in the DDMM format containing the date for the recording. |

##### getEncodedBy()
```
public final String getEncodedBy()
```

Gets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame.

**Returns:**
java.lang.String - The name of the person or organization that encoded the audio file.
##### setEncodedBy(String value)
```
public final void setEncodedBy(String value)
```

Sets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the person or organization that encoded the audio file. |

##### getPublisher()
```
public final String getPublisher()
```

Gets the name of the label or publisher. This value is represented by the TPUB frame.

**Returns:**
java.lang.String - The name of the label or publisher.
##### setPublisher(String value)
```
public final void setPublisher(String value)
```

Sets the name of the label or publisher. This value is represented by the TPUB frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the label or publisher. |

##### getTime()
```
public final String getTime()
```

Gets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame.

**Returns:**
java.lang.String - A numeric string in the HHMM format containing the time for the recording.
##### setTime(String value)
```
public final void setTime(String value)
```

Sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string in the HHMM format containing the time for the recording. |

##### getTitle()
```
public final String getTitle()
```

Gets the Title/Song name/Content description. This value is represented by the TIT2 frame.

**Returns:**
java.lang.String - The Title/Song name/Content description.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the Title/Song name/Content description. This value is represented by the TIT2 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Title/Song name/Content description. |

##### getSubtitle()
```
public final String getSubtitle()
```

Gets the Subtitle/Description refinement. This value is represented by the TIT3 frame.

**Returns:**
java.lang.String - The Subtitle/Description refinement.
##### setSubtitle(String value)
```
public final void setSubtitle(String value)
```

Sets the Subtitle/Description refinement. This value is represented by the TIT3 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Subtitle/Description refinement. |

##### getMusicalKey()
```
public final String getMusicalKey()
```

Gets the musical key in which the sound starts. This value is represented by the TKEY frame.

**Returns:**
java.lang.String - The musical key in which the sound starts.
##### setMusicalKey(String value)
```
public final void setMusicalKey(String value)
```

Sets the musical key in which the sound starts. This value is represented by the TKEY frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The musical key in which the sound starts. |

##### getLengthInMilliseconds()
```
public final String getLengthInMilliseconds()
```

Gets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame.

**Returns:**
java.lang.String - The length of the audio file in milliseconds, represented as a numeric string.
##### setLengthInMilliseconds(String value)
```
public final void setLengthInMilliseconds(String value)
```

Sets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The length of the audio file in milliseconds, represented as a numeric string. |

##### getOriginalAlbum()
```
public final String getOriginalAlbum()
```

Gets the original album/movie/show title. This value is represented by the TOAL frame.

**Returns:**
java.lang.String - The original album/movie/show title.
##### setOriginalAlbum(String value)
```
public final void setOriginalAlbum(String value)
```

Sets the original album/movie/show title. This value is represented by the TOAL frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The original album/movie/show title. |

##### getTrackNumber()
```
public final String getTrackNumber()
```

Gets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame.

**Returns:**
java.lang.String - A numeric string containing the order number of the audio-file on its original recording
##### setTrackNumber(String value)
```
public final void setTrackNumber(String value)
```

Sets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string containing the order number of the audio-file on its original recording |

##### getSizeInBytes()
```
public final String getSizeInBytes()
```

Gets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame.

**Returns:**
java.lang.String - The size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.
##### setSizeInBytes(String value)
```
public final void setSizeInBytes(String value)
```

Sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |

##### getIsrc()
```
public final String getIsrc()
```

Gets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame.

**Returns:**
java.lang.String - The International Standard Recording Code (ISRC) (12 characters).
##### setIsrc(String value)
```
public final void setIsrc(String value)
```

Sets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The International Standard Recording Code (ISRC) (12 characters). |

##### getSoftwareHardware()
```
public final String getSoftwareHardware()
```

Gets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame.

**Returns:**
java.lang.String - The used audio encoder and its settings when the file was encoded.
##### setSoftwareHardware(String value)
```
public final void setSoftwareHardware(String value)
```

Sets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The used audio encoder and its settings when the file was encoded. |

##### getYear()
```
public final String getYear()
```

Gets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame.

**Returns:**
java.lang.String - A numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
##### setYear(String value)
```
public final void setYear(String value)
```

Sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string with a year of the recording. This frames is always four characters long (until the year 10000). |

##### getComments()
```
public final ID3V2CommentFrame[] getComments()
```

Gets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame.

**Returns:**
com.groupdocs.metadata.core.ID3V2CommentFrame[] - The user comments.
##### setComments(ID3V2CommentFrame[] value)
```
public final void setComments(ID3V2CommentFrame[] value)
```

Sets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2CommentFrame\[\] | The user comments. |

##### getAttachedPictures()
```
public final ID3V2AttachedPictureFrame[] getAttachedPictures()
```

Gets the attached pictures directly related to the audio file. This value is represented by the APIC frame.

**Returns:**
com.groupdocs.metadata.core.ID3V2AttachedPictureFrame[] - The attached pictures directly related to the audio file.
##### setAttachedPictures(ID3V2AttachedPictureFrame[] value)
```
public final void setAttachedPictures(ID3V2AttachedPictureFrame[] value)
```

Sets the attached pictures directly related to the audio file. This value is represented by the APIC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2AttachedPictureFrame\[\] | The attached pictures directly related to the audio file. |

##### getTrackPlayCounter()
```
public final Long getTrackPlayCounter()
```

Gets the number of times the file has been played. This value is represented by the PCNT frame.

**Returns:**
java.lang.Long - The number of times a file has been played.
##### toList()
```
public final IReadOnlyList<ID3V2TagFrame> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list of all frames contained in the ID3v2 tag.
##### removeAttachedPictures()
```
public final void removeAttachedPictures()
```

Removes all attached pictures stored in APIC frames.

##### get(String frameId)
```
public final ID3V2TagFrame[] get(String frameId)
```

Gets an array of frames with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frames to get. |

**Returns:**
com.groupdocs.metadata.core.ID3V2TagFrame[] - An array of frames with the specified id.
##### set(ID3V2TagFrame frame)
```
public final void set(ID3V2TagFrame frame)
```

Removes all frames having the same id as the specified one and adds the new frame to the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to replace all frames of its kind with. |

##### clear(String frameId)
```
public final void clear(String frameId)
```

Removes all frames with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frames to remove. |

##### add(ID3V2TagFrame frame)
```
public final void add(ID3V2TagFrame frame)
```

Adds a frame to the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be added to the tag. |

##### remove(ID3V2TagFrame frame)
```
public final void remove(ID3V2TagFrame frame)
```

Removes the specified frame from the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be removed from the tag. |

### ID3V2TagFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2tagframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class ID3V2TagFrame extends CustomPackage
```

Represents a generic frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2TagFrame(String frameId, byte[] data) | Initializes a new instance of the  ID3V2TagFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getId() | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| getFlags() | Gets the frame flags. |
| getData() | Gets the frame data. |
##### ID3V2TagFrame(String frameId, byte[] data)
```
public ID3V2TagFrame(String frameId, byte[] data)
```

Initializes a new instance of the  ID3V2TagFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frame (four characters matching the pattern [A-Z0-9]). |
| data | byte[] | The content of the frame. |

##### getId()
```
public final String getId()
```

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).

**Returns:**
java.lang.String - The id of the frame (four characters matching the pattern [A-Z0-9]).
##### getFlags()
```
public final ID3V2TagFrameFlags getFlags()
```

Gets the frame flags.

**Returns:**
ID3V2TagFrameFlags - The frame flags.
##### getData()
```
public final byte[] getData()
```

Gets the frame data.

**Returns:**
byte[] - The frame data.

### ID3V2TagFrameFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2tagframeflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class ID3V2TagFrameFlags implements System.IEquatable<ID3V2TagFrameFlags>
```

Represents flags used in a ID3v2 tag frame.
#### Methods

| Method | Description |
| --- | --- |
| getTagAlterPreservation() | Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. |
| getFileAlterPreservation() | Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. |
| getReadOnly() | Gets the tag that tells the software that the contents of this frame is intended to be read-only. |
| getCompression() | Gets a value indicating whether the frame is compressed. |
| getEncryption() | Gets a value indicating whether the frame is encrypted. |
| getGroupingIdentity() | Gets a value indicating whether the frame belongs to a group of frames. |
| getUnsynchronisation() | Gets a value indicating whether unsynchronisation was applied to this frame. |
| getDataLengthIndicator() | Gets a value indicating whether a data length indicator has been added to the frame. |
| equals(ID3V2TagFrameFlags other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Determines whether the specified object is equal to this instance. |
| hashCode() | Returns a hash code for this instance. |
##### getTagAlterPreservation()
```
public final boolean getTagAlterPreservation()
```

Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames.

**Returns:**
boolean - The flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way.
##### getFileAlterPreservation()
```
public final boolean getFileAlterPreservation()
```

Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data.

**Returns:**
boolean - Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered.
##### getReadOnly()
```
public final boolean getReadOnly()
```

Gets the tag that tells the software that the contents of this frame is intended to be read-only.

**Returns:**
boolean - The tag that tells the software that the contents of this frame is intended to be read-only.
##### getCompression()
```
public final boolean getCompression()
```

Gets a value indicating whether the frame is compressed.

**Returns:**
boolean -  true , if the frame is compressed; otherwise, false.
##### getEncryption()
```
public final boolean getEncryption()
```

Gets a value indicating whether the frame is encrypted. If set one byte indicating with which method it was encrypted will be appended to the frame header.

**Returns:**
boolean -  true , if the frame is encrypted; otherwise, false.
##### getGroupingIdentity()
```
public final boolean getGroupingIdentity()
```

Gets a value indicating whether the frame belongs to a group of frames. If set a group identifier byte is added to the frame header. Every frame with the same group identifier belongs to the same group.

**Returns:**
boolean -  true , if the frame belongs to a group of frames; otherwise, false.
##### getUnsynchronisation()
```
public final boolean getUnsynchronisation()
```

Gets a value indicating whether unsynchronisation was applied to this frame.

**Returns:**
boolean -  true , if unsynchronisation was applied to this frame; otherwise, false.
##### getDataLengthIndicator()
```
public final boolean getDataLengthIndicator()
```

Gets a value indicating whether a data length indicator has been added to the frame. The data length indicator is the value one would write as the 'Frame length' if all of the frame format flags were zeroed, represented as a 32 bit synchsafe integer.

**Returns:**
boolean -  true , if a data length indicator has been added to the frame; otherwise, false.
##### equals(ID3V2TagFrameFlags other)
```
public final boolean equals(ID3V2TagFrameFlags other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ID3V2TagFrameFlags | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  other  parameter; otherwise, false.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified object is equal to this instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The  System.Object  to compare with this instance. |

**Returns:**
boolean -  true  if the specified  System.Object  is equal to this instance; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### ID3V2TextFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2textframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public class ID3V2TextFrame extends ID3V2TagFrame
```

Represents a text frame in an  ID3V2Tag . Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the  ID3V2UserDefinedFrame  class.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value) | Initializes a new instance of the  ID3V2TextFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTextEncoding() | Gets the text encoding. |
| getText() | Gets the text value. |
##### ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value)
```
public ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value)
```

Initializes a new instance of the  ID3V2TextFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The frame id. |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| value | java.lang.String | The frame value. |

##### getTextEncoding()
```
public final ID3V2EncodingType getTextEncoding()
```

Gets the text encoding.

**Returns:**
ID3V2EncodingType - The text encoding.
##### getText()
```
public final String getText()
```

Gets the text value.

**Returns:**
java.lang.String - The text value.

### ID3V2UrlLinkFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2urllinkframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UrlLinkFrame extends ID3V2TagFrame
```

Represents a URL link frame in an  ID3V2Tag . Name of the frame always starts with the W character.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UrlLinkFrame(String id, String url) | Initializes a new instance of the  ID3V2UrlLinkFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getUrl() | Gets the URL value. |
##### ID3V2UrlLinkFrame(String id, String url)
```
public ID3V2UrlLinkFrame(String id, String url)
```

Initializes a new instance of the  ID3V2UrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The frame id. |
| url | java.lang.String | The URL which is the value of the frame. |

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

Gets the URL value.

**Returns:**
java.lang.String - The URL value.

### ID3V2UserDefinedFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2userdefinedframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UserDefinedFrame extends ID3V2TagFrame
```

Represents a TXXX frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UserDefinedFrame(String description, String value) | Initializes a new instance of the  ID3V2UserDefinedFrame  class. |
| ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value) | Initializes a new instance of the  ID3V2UserDefinedFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding of the frame. |
| getDescription() | Gets the description. |
| getValue() | Gets the value. |
##### ID3V2UserDefinedFrame(String description, String value)
```
public ID3V2UserDefinedFrame(String description, String value)
```

Initializes a new instance of the  ID3V2UserDefinedFrame  class.

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

##### ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value)
```
public ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value)
```

Initializes a new instance of the  ID3V2UserDefinedFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | java.lang.String | The description. |
| value | java.lang.String | The text value. |

##### getEncoding()
```
public final ID3V2EncodingType getEncoding()
```

Gets the encoding of the frame.

**Returns:**
ID3V2EncodingType - The encoding of the frame.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getValue()
```
public final String getValue()
```

Gets the value.

**Returns:**
java.lang.String - The value.

### ID3V2UserDefinedUrlLinkFrame
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/id3v2userdefinedurllinkframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UserDefinedUrlLinkFrame extends ID3V2TagFrame
```

Represents a WXXX frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UserDefinedUrlLinkFrame(String description, String url) | Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class. |
| ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url) | Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding of the frame. |
| getDescription() | Gets the description. |
| getUrl() | Gets the URL. |
##### ID3V2UserDefinedUrlLinkFrame(String description, String url)
```
public ID3V2UserDefinedUrlLinkFrame(String description, String url)
```

Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | The description. |
| url | java.lang.String | The actual value of the frame. |

##### ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url)
```
public ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url)
```

Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | java.lang.String | The description. |
| url | java.lang.String | The actual value of the frame. |

##### getEncoding()
```
public final ID3V2EncodingType getEncoding()
```

Gets the encoding of the frame.

**Returns:**
ID3V2EncodingType - The encoding of the frame.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getUrl()
```
public final String getUrl()
```

Gets the URL.

**Returns:**
java.lang.String - The URL.

### IDocumentInfo
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/idocumentinfo.md

### IDublinCore
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/idublincore.md

### IEnumValue
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ienumvalue.md

### IEnumValueInterpreter
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ienumvalueinterpreter.md

### IExif
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iexif.md

### IIptc
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iiptc.md

### ImageResourceBlock
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/imageresourceblock.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ImageResourceBlock extends CustomPackage
```

Represents a Photoshop Image Resource block.

 Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF. Image resources are used to store non-pixel data associated with images, such as pen tool paths.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getSignature() | Gets the image resource block signature. |
| getID() | Gets the unique identifier for the resource. |
| getName() | Gets the image resource block name. |
| getData() | Gets the resource data. |
##### getSignature()
```
public final String getSignature()
```

Gets the image resource block signature.

**Returns:**
java.lang.String - The image resource block signature
##### getID()
```
public final ImageResourceID getID()
```

Gets the unique identifier for the resource.

**Returns:**
ImageResourceID - The identifier.
##### getName()
```
public final String getName()
```

Gets the image resource block name.

**Returns:**
java.lang.String - The image resource block name.
##### getData()
```
public final byte[] getData()
```

Gets the resource data.

**Returns:**
byte[] - The resource data.

### ImageResourceID
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/imageresourceid.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ImageResourceID implements IEnumValue
```

Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file.
#### Fields

| Field | Description |
| --- | --- |
| ResolutionInfo | ResolutionInfo structure. |
| NamesOfAlphaChannels | Names of the alpha channels as a series of Pascal strings. |
| Caption | The caption as a Pascal string. |
| BorderInformation | Border information. |
| BackgroundColor | Background color. |
| PrintFlags | Print flags. |
| Grayscale | Grayscale and multichannel halftoning information. |
| ColorHalftoning | Color halftoning information. |
| DuotoneHalftoning | Duotone halftoning information. |
| GrayscaleFunction | Grayscale and multichannel transfer function. |
| ColorTransferFunctions | Color transfer functions. |
| DuotoneTransferFunctions | Duotone transfer functions. |
| DuotoneImageInformation | Duotone image information. |
| EPSOptions | EPS options. |
| QuickMaskInformation | Quick Mask information. |
| LayerStateInformation | Layer state information. |
| WorkingPath | Working path (not saved). |
| LayersGroupInformation | Layers group information. |
| Iptc | IPTC-NAA record. |
| ImageModeForRawFormat | Image mode for raw format files. |
| JpegQuality | JPEG quality. |
| GridAndGuidesInfoPhotoshop4 | Grid and guides information. |
| ThumbnailResourcePhotoshop4 | Thumbnail resource for Photoshop 4.0 only. |
| CopyrightFlagPhotoshop4 | Copyright flag. |
| UrlPhotoshop4 | URL. |
| ThumbnailResourcePhotoshop5 | Thumbnail resource (supersedes resource 1033). |
| GlobalAnglePhotoshop5 | Global Angle. |
| IccProfilePhotoshop5 | (Photoshop 5.0) ICC Profile. |
| WatermarkPhotoshop5 | Watermark. |
| IccUntaggedProfilePhotoshop5 | ICC Untagged Profile. |
| TransparencyIndexPhotoshop6 | Transparency Index. |
| GlobalAltitudePhotoshop6 | Global Altitude. |
| SlicesPhotoshop6 | Slices (Photoshop 6). |
| WorkflowUrlPhotoshop6 | Workflow URL. |
| AlphaIdentifiersPhotoshop6 | Alpha Identifiers. |
| UrlListPhotoshop6 | URL InternalList. |
| VersionInfoPhotoshop6 | Version Info. |
| ExifData1Photoshop7 | EXIF data 1,  see more . |
| ExifData3Photoshop7 |  EXIF data 3.  |
| XmpPhotoshop7 | XMP metadata. |
| CaptionDigestPhotoshop7 | Caption digest. |
| PrintScalePhotoshop7 | Print scale. |
| PixelAspectRatio | Pixel Aspect Ratio. |
| LayerComps | Layer Comps. |
| LayerSelectionIds | Layer Selection ID(s). |
| PrintInfoCS2 | Print info (Photoshop CS2). |
| LayerGroupEnabledIdCS2 | Layer Group(s) Enabled ID. |
| ColorSamplersResourceCS3 | Color samplers resource. |
| MeasurementScaleCS3 | Measurement Scale. |
| TimelineInformationCS3 | Timeline Information. |
| SheetDisclosureCS3 | Sheet Disclosure. |
| PrintInformationCS5 | Print Information (Photoshop CS5). |
| PrintStyleCS5 | Print Style (Photoshop CS5). |
| MacintoshNSPrintInfoCS5 | Macintosh NSPrintInfo. |
| WindowsDevmodeCS5 | Windows DEVMODE. |
| AutoSaveFilePathCS6 | Auto Save File Path. |
| AutoSaveFormatCS6 | Auto Save Format. |
| PathSelectionStateCC | Path Selection State. |
| ImageReadyVariables | Image Ready variables. |
| ImageReadyDatasets | Image Ready data sets. |
| PrintFlagsInformation | Print flags information. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### ResolutionInfo
```
public static final ImageResourceID ResolutionInfo
```

ResolutionInfo structure. See Appendix A in Photoshop API Guide PDF document.

##### NamesOfAlphaChannels
```
public static final ImageResourceID NamesOfAlphaChannels
```

Names of the alpha channels as a series of Pascal strings.

##### Caption
```
public static final ImageResourceID Caption
```

The caption as a Pascal string.

##### BorderInformation
```
public static final ImageResourceID BorderInformation
```

Border information. Contains a fixed number (2 bytes real, 2 bytes fraction) for the border width, and 2 bytes for border units (1 = inches, 2 = cm, 3 = points, 4 = picas, 5 = columns).

##### BackgroundColor
```
public static final ImageResourceID BackgroundColor
```

Background color.  See more.

##### PrintFlags
```
public static final ImageResourceID PrintFlags
```

Print flags. A series of one-byte boolean values (see Page Setup dialog): labels, crop marks, color bars, registration marks, negative, flip, interpolate, caption, print flags.

##### Grayscale
```
public static final ImageResourceID Grayscale
```

Grayscale and multichannel halftoning information.

##### ColorHalftoning
```
public static final ImageResourceID ColorHalftoning
```

Color halftoning information.

##### DuotoneHalftoning
```
public static final ImageResourceID DuotoneHalftoning
```

Duotone halftoning information.

##### GrayscaleFunction
```
public static final ImageResourceID GrayscaleFunction
```

Grayscale and multichannel transfer function.

##### ColorTransferFunctions
```
public static final ImageResourceID ColorTransferFunctions
```

Color transfer functions.

##### DuotoneTransferFunctions
```
public static final ImageResourceID DuotoneTransferFunctions
```

Duotone transfer functions.

##### DuotoneImageInformation
```
public static final ImageResourceID DuotoneImageInformation
```

Duotone image information.

##### EPSOptions
```
public static final ImageResourceID EPSOptions
```

EPS options.

##### QuickMaskInformation
```
public static final ImageResourceID QuickMaskInformation
```

Quick Mask information. 2 bytes containing Quick Mask channel ID; 1- byte boolean indicating whether the mask was initially empty.

##### LayerStateInformation
```
public static final ImageResourceID LayerStateInformation
```

Layer state information. 2 bytes containing the index of target layer (0 = bottom layer).

##### WorkingPath
```
public static final ImageResourceID WorkingPath
```

Working path (not saved). See See Path resource format.

##### LayersGroupInformation
```
public static final ImageResourceID LayersGroupInformation
```

Layers group information. 2 bytes per layer containing a group ID for the dragging groups. Layers in a group have the same group ID.

##### Iptc
```
public static final ImageResourceID Iptc
```

IPTC-NAA record. Contains the File Info... information. See the documentation in the IPTC folder of the Documentation folder.

##### ImageModeForRawFormat
```
public static final ImageResourceID ImageModeForRawFormat
```

Image mode for raw format files.

##### JpegQuality
```
public static final ImageResourceID JpegQuality
```

JPEG quality. Private.

##### GridAndGuidesInfoPhotoshop4
```
public static final ImageResourceID GridAndGuidesInfoPhotoshop4
```

Grid and guides information.

##### ThumbnailResourcePhotoshop4
```
public static final ImageResourceID ThumbnailResourcePhotoshop4
```

Thumbnail resource for Photoshop 4.0 only.

##### CopyrightFlagPhotoshop4
```
public static final ImageResourceID CopyrightFlagPhotoshop4
```

Copyright flag. Boolean indicating whether image is copyrighted. Can be set via Property suite or by user in File Info...

##### UrlPhotoshop4
```
public static final ImageResourceID UrlPhotoshop4
```

URL. Handle of a text string with uniform resource locator. Can be set via Property suite or by user in File Info...

##### ThumbnailResourcePhotoshop5
```
public static final ImageResourceID ThumbnailResourcePhotoshop5
```

Thumbnail resource (supersedes resource 1033). See See Thumbnail resource format.

##### GlobalAnglePhotoshop5
```
public static final ImageResourceID GlobalAnglePhotoshop5
```

Global Angle. 4 bytes that contain an integer between 0 and 359, which is the global lighting angle for effects layer. If not present, assumed to be 30.

##### IccProfilePhotoshop5
```
public static final ImageResourceID IccProfilePhotoshop5
```

(Photoshop 5.0) ICC Profile. The raw bytes of an ICC (International Color Consortium) format profile. See ICC1v42\_2006-05.pdf in the Documentation folder and icProfileHeader.h in Sample Code\\Common\\Includes.

##### WatermarkPhotoshop5
```
public static final ImageResourceID WatermarkPhotoshop5
```

Watermark. One byte.

##### IccUntaggedProfilePhotoshop5
```
public static final ImageResourceID IccUntaggedProfilePhotoshop5
```

ICC Untagged Profile. 1 byte that disables any assumed profile handling when opening the file. 1 = intentionally untagged.

##### TransparencyIndexPhotoshop6
```
public static final ImageResourceID TransparencyIndexPhotoshop6
```

Transparency Index. 2 bytes for the index of transparent color, if any.

##### GlobalAltitudePhotoshop6
```
public static final ImageResourceID GlobalAltitudePhotoshop6
```

Global Altitude. 4 byte entry for altitude.

##### SlicesPhotoshop6
```
public static final ImageResourceID SlicesPhotoshop6
```

Slices (Photoshop 6).

##### WorkflowUrlPhotoshop6
```
public static final ImageResourceID WorkflowUrlPhotoshop6
```

Workflow URL. Unicode string. Photoshop 6.

##### AlphaIdentifiersPhotoshop6
```
public static final ImageResourceID AlphaIdentifiersPhotoshop6
```

Alpha Identifiers. 4 bytes of length, followed by 4 bytes each for every alpha identifier.

##### UrlListPhotoshop6
```
public static final ImageResourceID UrlListPhotoshop6
```

URL InternalList. 4 byte count of URLs, followed by 4 byte long, 4 byte ID, and Unicode string for each count.

##### VersionInfoPhotoshop6
```
public static final ImageResourceID VersionInfoPhotoshop6
```

Version Info. 4 bytes version, 1 byte hasRealMergedData , Unicode string: writer name, Unicode string: reader name, 4 bytes file version.

##### ExifData1Photoshop7
```
public static final ImageResourceID ExifData1Photoshop7
```

EXIF data 1,  see more .

##### ExifData3Photoshop7
```
public static final ImageResourceID ExifData3Photoshop7
```

 EXIF data 3.

##### XmpPhotoshop7
```
public static final ImageResourceID XmpPhotoshop7
```

XMP metadata. File info as XML description,  see more .

##### CaptionDigestPhotoshop7
```
public static final ImageResourceID CaptionDigestPhotoshop7
```

Caption digest. 16 bytes: RSA Data Security, MD5 message-digest algorithm.

##### PrintScalePhotoshop7
```
public static final ImageResourceID PrintScalePhotoshop7
```

Print scale. 2 bytes style (0 = centered, 1 = size to fit, 2 = user defined). 4 bytes x location (floating point). 4 bytes y location (floating point). 4 bytes scale (floating point).

##### PixelAspectRatio
```
public static final ImageResourceID PixelAspectRatio
```

Pixel Aspect Ratio. 4 bytes (version = 1 or 2), 8 bytes double, x / y of a pixel. Version 2, attempting to correct values for NTSC and PAL, previously off by a factor of approx. 5%.

##### LayerComps
```
public static final ImageResourceID LayerComps
```

Layer Comps. 4 bytes (descriptor version = 16), Descriptor.

##### LayerSelectionIds
```
public static final ImageResourceID LayerSelectionIds
```

Layer Selection ID(s). 2 bytes count, following is repeated for each count: 4 bytes layer ID.

##### PrintInfoCS2
```
public static final ImageResourceID PrintInfoCS2
```

Print info (Photoshop CS2).

##### LayerGroupEnabledIdCS2
```
public static final ImageResourceID LayerGroupEnabledIdCS2
```

Layer Group(s) Enabled ID. 1 byte for each layer in the document, repeated by length of the resource. NOTE: Layer groups have start and end markers (Photoshop CS2).

##### ColorSamplersResourceCS3
```
public static final ImageResourceID ColorSamplersResourceCS3
```

Color samplers resource. Also see ID 1038 for old format.

##### MeasurementScaleCS3
```
public static final ImageResourceID MeasurementScaleCS3
```

Measurement Scale. 4 bytes (descriptor version = 16), Descriptor.

##### TimelineInformationCS3
```
public static final ImageResourceID TimelineInformationCS3
```

Timeline Information. 4 bytes (descriptor version = 16), Descriptor.

##### SheetDisclosureCS3
```
public static final ImageResourceID SheetDisclosureCS3
```

Sheet Disclosure. 4 bytes (descriptor version = 16), Descriptor.

##### PrintInformationCS5
```
public static final ImageResourceID PrintInformationCS5
```

Print Information (Photoshop CS5).

##### PrintStyleCS5
```
public static final ImageResourceID PrintStyleCS5
```

Print Style (Photoshop CS5).

##### MacintoshNSPrintInfoCS5
```
public static final ImageResourceID MacintoshNSPrintInfoCS5
```

Macintosh NSPrintInfo. Variable OS specific info for Macintosh. NSPrintInfo. It is recommended that you do not interpret or use this data. (Photoshop CS5).

##### WindowsDevmodeCS5
```
public static final ImageResourceID WindowsDevmodeCS5
```

Windows DEVMODE. Variable OS specific info for Windows. DEVMODE. It is recommended that you do not interpret or use this data. (Photoshop CS5).

##### AutoSaveFilePathCS6
```
public static final ImageResourceID AutoSaveFilePathCS6
```

Auto Save File Path. Unicode string. (Photoshop CS6).

##### AutoSaveFormatCS6
```
public static final ImageResourceID AutoSaveFormatCS6
```

Auto Save Format. Unicode string. (Photoshop CS6).

##### PathSelectionStateCC
```
public static final ImageResourceID PathSelectionStateCC
```

Path Selection State. (Photoshop CC).

##### ImageReadyVariables
```
public static final ImageResourceID ImageReadyVariables
```

Image Ready variables. XML representation of variables definition.

##### ImageReadyDatasets
```
public static final ImageResourceID ImageReadyDatasets
```

Image Ready data sets.

##### PrintFlagsInformation
```
public static final ImageResourceID PrintFlagsInformation
```

Print flags information. 2 bytes version ( = 1), 1 byte center crop marks, 1 byte ( = 0), 4 bytes bleed width value, 2 bytes bleed width scale.

##### getByRawValue(int rawValue)
```
public static ImageResourceID getByRawValue(int rawValue)
```

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

**Returns:**
ImageResourceID
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### ImageResourcePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/imageresourcepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ImageResourcePackage extends CustomPackage
```

Represents a metadata package containing Photoshop Image Resources.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
##### toList()
```
public final IReadOnlyList<ImageResourceBlock> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all Image Resource Blocks from the package.

### ImageRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/imagerootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class ImageRootPackage extends RootMetadataPackage
```

Provides a base abstract class for all image root packages.

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPng)) {
>      ImageRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getImageType().getFileFormat());
>      System.out.println(root.getImageType().getByteOrder());
>      System.out.println(root.getImageType().getMimeType());
>      System.out.println(root.getImageType().getExtension());
>      System.out.println(root.getImageType().getWidth());
>      System.out.println(root.getImageType().getHeight());
>  }
>
> ```
> ```
#### Methods

| Method | Description |
| --- | --- |
| getImageType() | Gets the file type metadata package. |
##### getImageType()
```
public final ImageTypePackage getImageType()
```

Gets the file type metadata package.

**Returns:**
ImageTypePackage - The file type metadata package.

### ImageTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/imagetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class ImageTypePackage extends FileTypePackage
```

Represents a metadata package containing image-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the image width. |
| getHeight() | Gets the image height. |
| getByteOrder() | Gets the byte-order of the image. |
##### getWidth()
```
public final int getWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getHeight()
```
public final int getHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getByteOrder()
```
public final ByteOrder getByteOrder()
```

Gets the byte-order of the image. Please see  https://en.wikipedia.org/wiki/Endianness  for more information.

**Returns:**
ByteOrder - The byte-order value.

### InteroperabilityIFDPointerPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/interoperabilityifdpointerpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class InteroperabilityIFDPointerPackage extends CustomPackage
```

Represents Interoperability IFD.
#### Methods

| Method | Description |
| --- | --- |
| getTagInteropIndex() | Gets the TagInteropIndex. |
| getTagInteropVersion() | Gets the TagInteropVersion. |
##### getTagInteropIndex()
```
public final String getTagInteropIndex()
```

Gets the TagInteropIndex.

**Returns:**
java.lang.String - The TagInteropIndex.
##### getTagInteropVersion()
```
public final byte[] getTagInteropVersion()
```

Gets the TagInteropVersion.

**Returns:**
byte[] - The TagInteropVersion.

### InvalidFormatException
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/invalidformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class InvalidFormatException extends GroupDocsMetadataException
```

The exception that is thrown when a file has an invalid format.
#### Constructors

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

Initializes a new instance of the  InvalidFormatException  class.

##### InvalidFormatException(String message)
```
public InvalidFormatException(String message)
```

Initializes a new instance of the  InvalidFormatException  class.

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

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

Initializes a new instance of the  InvalidFormatException  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. |

### IptcApplicationRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcapplicationrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.IptcRecord
```
public final class IptcApplicationRecord extends IptcRecord
```

Represents an IPTC Application Record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcApplicationRecord() | Initializes a new instance of the  IptcApplicationRecord  class. |
#### Methods

| Method | Description |
| --- | --- |
| getByLine() | Gets the name of the creator of the object, e.g. |
| setByLine(String value) | Sets the name of the creator of the object, e.g. |
| getByLines() | Gets the names of the creators of the object, e.g. |
| setByLines(String[] value) | Sets the names of the creators of the object, e.g. |
| getByLineTitle() | Gets the title of the creator or creators of the object. |
| setByLineTitle(String value) | Sets the title of the creator or creators of the object. |
| getByLineTitles() | Gets the titles of the creator or creators of the object. |
| setByLineTitles(String[] value) | Sets the titles of the creator or creators of the object. |
| getContentLocationCode() | Gets the content location code. |
| setContentLocationCode(String value) | Sets the content location code. |
| getContentLocationCodes() | Gets the content location codes. |
| setContentLocationCodes(String[] value) | Sets the content location codes. |
| getContentLocationName() | Gets the content location name. |
| setContentLocationName(String value) | Sets the content location name. |
| getContentLocationNames() | Gets the content location names. |
| setContentLocationNames(String[] value) | Sets the content location names. |
| getDateCreated() | Gets the date the intellectual content of the object was created. |
| setDateCreated(Date value) | Sets the date the intellectual content of the object was created. |
| getReferenceDate() | Gets the date of a prior envelope to which the current object refers. |
| setReferenceDate(Date value) | Sets the date of a prior envelope to which the current object refers. |
| getReferenceDates() | Gets the dates of a prior envelope to which the current object refers. |
| getReleaseDate() | Gets the release date. |
| setReleaseDate(Date value) | Sets the release date. |
| getCredit() | Gets information about the provider of the object, not necessarily the owner/creator. |
| setCredit(String value) | Sets information about the provider of the object, not necessarily the owner/creator. |
| getHeadline() | Gets a publishable entry providing a synopsis of the contents of the object. |
| setHeadline(String value) | Sets a publishable entry providing a synopsis of the contents of the object. |
| getCopyrightNotice() | Gets the copyright notice. |
| setCopyrightNotice(String value) | Sets the copyright notice. |
| getContact() | Gets information about the person or organisation which can provide further background information on the object. |
| setContact(String value) | Sets information about the person or organisation which can provide further background information on the object. |
| getContacts() | Gets information about the person or organisation which can provide further background information on the object. |
| setContacts(String[] value) | Sets information about the person or organisation which can provide further background information on the object. |
| getCity() | Gets the city. |
| setCity(String value) | Sets the city. |
| getCaptionAbstract() | Gets a textual description of the object, particularly used where the object is not text. |
| setCaptionAbstract(String value) | Sets a textual description of the object, particularly used where the object is not text. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getAllKeywords() | Gets the keywords. |
| setAllKeywords(String[] value) | Sets the keywords. |
| getProgramVersion() | Gets the program version. |
| setProgramVersion(String value) | Sets the program version. |
| getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber) | Gets the  IptcDataSet  with the specified number. |
##### IptcApplicationRecord()
```
public IptcApplicationRecord()
```

Initializes a new instance of the  IptcApplicationRecord  class.

##### getByLine()
```
public final String getByLine()
```

Gets the name of the creator of the object, e.g. writer, photographer or graphic artist.

**Returns:**
java.lang.String - The name of the creator of the object, e.g. writer, photographer or graphic artist.
##### setByLine(String value)
```
public final void setByLine(String value)
```

Sets the name of the creator of the object, e.g. writer, photographer or graphic artist.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the creator of the object, e.g. writer, photographer or graphic artist. |

##### getByLines()
```
public final String[] getByLines()
```

Gets the names of the creators of the object, e.g. writer, photographer or graphic artist.

**Returns:**
java.lang.String[] - The names of the creators of the object, e.g. writer, photographer or graphic artist.
##### setByLines(String[] value)
```
public final void setByLines(String[] value)
```

Sets the names of the creators of the object, e.g. writer, photographer or graphic artist.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The names of the creators of the object, e.g. writer, photographer or graphic artist. |

##### getByLineTitle()
```
public final String getByLineTitle()
```

Gets the title of the creator or creators of the object.

**Returns:**
java.lang.String - The title of the creator or creators of the object.
##### setByLineTitle(String value)
```
public final void setByLineTitle(String value)
```

Sets the title of the creator or creators of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the creator or creators of the object. |

##### getByLineTitles()
```
public final String[] getByLineTitles()
```

Gets the titles of the creator or creators of the object.

**Returns:**
java.lang.String[] - The titles of the creator or creators of the object.
##### setByLineTitles(String[] value)
```
public final void setByLineTitles(String[] value)
```

Sets the titles of the creator or creators of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The titles of the creator or creators of the object. |

##### getContentLocationCode()
```
public final String getContentLocationCode()
```

Gets the content location code.

**Returns:**
java.lang.String - The content location code.
##### setContentLocationCode(String value)
```
public final void setContentLocationCode(String value)
```

Sets the content location code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content location code. |

##### getContentLocationCodes()
```
public final String[] getContentLocationCodes()
```

Gets the content location codes.

**Returns:**
java.lang.String[] - The content location codes.
##### setContentLocationCodes(String[] value)
```
public final void setContentLocationCodes(String[] value)
```

Sets the content location codes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location codes. |

##### getContentLocationName()
```
public final String getContentLocationName()
```

Gets the content location name.

**Returns:**
java.lang.String - The name of the content location.
##### setContentLocationName(String value)
```
public final void setContentLocationName(String value)
```

Sets the content location name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the content location. |

##### getContentLocationNames()
```
public final String[] getContentLocationNames()
```

Gets the content location names.

**Returns:**
java.lang.String[] - The name of the content locations.
##### setContentLocationNames(String[] value)
```
public final void setContentLocationNames(String[] value)
```

Sets the content location names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The name of the content locations. |

##### getDateCreated()
```
public final Date getDateCreated()
```

Gets the date the intellectual content of the object was created.

**Returns:**
java.util.Date - The date the intellectual content of the object was created.
##### setDateCreated(Date value)
```
public final void setDateCreated(Date value)
```

Sets the date the intellectual content of the object was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the intellectual content of the object was created. |

##### getReferenceDate()
```
public final Date getReferenceDate()
```

Gets the date of a prior envelope to which the current object refers.

**Returns:**
java.util.Date - The date of a prior envelope to which the current object refers.
##### setReferenceDate(Date value)
```
public final void setReferenceDate(Date value)
```

Sets the date of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of a prior envelope to which the current object refers. |

##### getReferenceDates()
```
public final Date[] getReferenceDates()
```

Gets the dates of a prior envelope to which the current object refers.

**Returns:**
java.util.Date[] - The dates of a prior envelope to which the current object refers.
##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the release date.

**Returns:**
java.util.Date - The release date.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the release date.

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

##### getCredit()
```
public final String getCredit()
```

Gets information about the provider of the object, not necessarily the owner/creator.

**Returns:**
java.lang.String - The information about the provider of the object, not necessarily the owner/creator.
##### setCredit(String value)
```
public final void setCredit(String value)
```

Sets information about the provider of the object, not necessarily the owner/creator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about the provider of the object, not necessarily the owner/creator. |

##### getHeadline()
```
public final String getHeadline()
```

Gets a publishable entry providing a synopsis of the contents of the object.

**Returns:**
java.lang.String - A publishable entry providing a synopsis of the contents of the object.
##### setHeadline(String value)
```
public final void setHeadline(String value)
```

Sets a publishable entry providing a synopsis of the contents of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A publishable entry providing a synopsis of the contents of the object. |

##### getCopyrightNotice()
```
public final String getCopyrightNotice()
```

Gets the copyright notice.

**Returns:**
java.lang.String - The copyright notice.
##### setCopyrightNotice(String value)
```
public final void setCopyrightNotice(String value)
```

Sets the copyright notice.

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

##### getContact()
```
public final String getContact()
```

Gets information about the person or organisation which can provide further background information on the object.

**Returns:**
java.lang.String - The information about the person or organisation which can provide further background information on the object.
##### setContact(String value)
```
public final void setContact(String value)
```

Sets information about the person or organisation which can provide further background information on the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about the person or organisation which can provide further background information on the object. |

##### getContacts()
```
public final String[] getContacts()
```

Gets information about the person or organisation which can provide further background information on the object.

**Returns:**
java.lang.String[] - The information about the person or organisation which can provide further background information on the object.
##### setContacts(String[] value)
```
public final void setContacts(String[] value)
```

Sets information about the person or organisation which can provide further background information on the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The information about the person or organisation which can provide further background information on the object. |

##### getCity()
```
public final String getCity()
```

Gets the city.

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

Sets the city.

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

##### getCaptionAbstract()
```
public final String getCaptionAbstract()
```

Gets a textual description of the object, particularly used where the object is not text.

**Returns:**
java.lang.String - TheA textual description of the object, particularly used where the object is not text.
##### setCaptionAbstract(String value)
```
public final void setCaptionAbstract(String value)
```

Sets a textual description of the object, particularly used where the object is not text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | TheA textual description of the object, particularly used where the object is not text. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

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

Sets the keywords.

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

##### getAllKeywords()
```
public final String[] getAllKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String[] - The keywords.
##### setAllKeywords(String[] value)
```
public final void setAllKeywords(String[] value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The keywords. |

##### getProgramVersion()
```
public final String getProgramVersion()
```

Gets the program version.

**Returns:**
java.lang.String - The program version.
##### setProgramVersion(String value)
```
public final void setProgramVersion(String value)
```

Sets the program version.

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

##### getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber)
```
public final IptcDataSet getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber)
```

Gets the  IptcDataSet  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | IptcApplicationRecordDataSet | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified number.

### IptcApplicationRecordDataSet
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcapplicationrecorddataset.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum IptcApplicationRecordDataSet extends Enum<IptcApplicationRecordDataSet> implements IEnumValue
```

Defines IPTC Application Record dataSet numbers.
#### Fields

| Field | Description |
| --- | --- |
| RecordVersion | Represents the record version. |
| ObjectTypeReference | Object type reference. |
| ObjectAttributeReference | The object attribute reference. |
| ObjectName | Used as a shorthand reference for the object. |
| EditStatus | Status of the objectdata, according to the practice of the provider. |
| EditorialUpdate | Indicates the type of update that this object provides to a previous object. |
| Urgency | Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority). |
| SubjectReference | The subject reference. |
| Category | Identifies the subject of the objectdata in the opinion of the provider. |
| SupplementalCategory |  |
| FixtureIdentifier | The fixture identifier. |
| Keywords | Used to indicate specific information retrieval words. |
| ContentLocationCode | Indicates the code of a country/geographical location referenced by the content of the object. |
| ContentLocationName |  |
| ReleaseDate | Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. |
| ReleaseTime | Designates in the form HHMMSS??HHMM the earliest time the provider intends the object to be used. |
| ExpirationDate | Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. |
| SpecialInstructions | Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. |
| ActionAdvised | Indicates the type of action that this object provides to a previous object. |
| ReferenceService | Identifies the Service Identifier of a prior envelope to which the current object refers. |
| ReferenceDate | Identifies the date of a prior envelope to which the current object refers. |
| ReferenceNumber | Identifies the Envelope Number of a prior envelope to which the current object refers. |
| DateCreated | Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. |
| TimeCreated | Represented in the form HHMMSS??HHMM to designate the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation. |
| DigitalCreationDate | Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. |
| DigitalCreationTime | Represented in the form HHMMSS??HHMM to designate the time the digital representation of the objectdata was created. |
| OriginatingProgram | Identifies the type of program used to originate the objectdata. |
| ProgramVersion | Used to identify the version of the program mentioned in 2:65. |
| ObjectCycle | Consisting of an alphabetic character. |
| Byline | Contains name of the creator of the objectdata, e.g. |
| BylineTitle | A by-line title is the title of the creator or creators of an object data. |
| City | Identifies city of objectdata origin according to guidelines established by the provider. |
| SubLocation | Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. |
| ProvinceState | Identifies Province/State of origin according to guidelines established by the provider. |
| PrimaryLocationCode | Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. |
| PrimaryLocationName | Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider. |
| OriginalTransmissionReference | A code representing the location of original transmission according to practices of the provider. |
| Headline | A publishable entry providing a synopsis of the contents of the objectdata. |
| Credit | Identifies the provider of the objectdata, not necessarily the owner/creator. |
| Source | The name of a person or party who has a role in the content supply chain. |
| CopyrightNotice | Contains any necessary copyright notice. |
| Contact | Identifies the person or organization which can provide further background information on the object data. |
| CaptionAbstract | A textual description of the objectdata, particularly used where the object is not text. |
| WriterEditor | Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract. |
| RasterizedCaption | Image width 460 pixels and image height 128 pixels. |
| ImageType | The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes. |
| ImageOrientation | Indicates the layout of the image area. |
| LanguageIdentifier | Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. |
| AudioType | The audio type. |
| AudioSamplingRate | Sampling rate numeric characters, representing the sampling rate in hertz (Hz). |
| AudioSamplingResolution | The number of bits in each audio sample. |
| AudioDuration | Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. |
| AudioOutcue | Identifies the content of the end of an audio objectdata, according to guidelines established by the provider. |
| ObjDataPreviewFileFormat | A binary number representing the file format of the ObjectData Preview. |
| ObjDataPreviewFileFormatVer | A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200. |
| ObjDataPreviewData | The object data preview. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### RecordVersion
```
public static final IptcApplicationRecordDataSet RecordVersion
```

Represents the record version. Binary. Always 2 in JPEGs.

##### ObjectTypeReference
```
public static final IptcApplicationRecordDataSet ObjectTypeReference
```

Object type reference. Used pattern: "/\\d\{2\}:[\\w\\s]\{0,64\}?/".

##### ObjectAttributeReference
```
public static final IptcApplicationRecordDataSet ObjectAttributeReference
```

The object attribute reference.

##### ObjectName
```
public static final IptcApplicationRecordDataSet ObjectName
```

Used as a shorthand reference for the object.

Changes to existing data, such as updated stories or new crops on photos, should be identified in  EditStatus .

##### EditStatus
```
public static final IptcApplicationRecordDataSet EditStatus
```

Status of the objectdata, according to the practice of the provider.

##### EditorialUpdate
```
public static final IptcApplicationRecordDataSet EditorialUpdate
```

Indicates the type of update that this object provides to a previous object.

##### Urgency
```
public static final IptcApplicationRecordDataSet Urgency
```

Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority).

##### SubjectReference
```
public static final IptcApplicationRecordDataSet SubjectReference
```

The subject reference.

##### Category
```
public static final IptcApplicationRecordDataSet Category
```

Identifies the subject of the objectdata in the opinion of the provider.

##### SupplementalCategory
```
public static final IptcApplicationRecordDataSet SupplementalCategory
```

Supplemental categories further refine the subject of an objectdata.

 Only a single supplemental category may be contained in each DataSet. A supplemental category may include any of the recognised categories as used in 2:15.

##### FixtureIdentifier
```
public static final IptcApplicationRecordDataSet FixtureIdentifier
```

The fixture identifier.

##### Keywords
```
public static final IptcApplicationRecordDataSet Keywords
```

Used to indicate specific information retrieval words. Each keyword uses a single Keywords DataSet. Multiple keywords use multiple Keywords DataSets.

##### ContentLocationCode
```
public static final IptcApplicationRecordDataSet ContentLocationCode
```

Indicates the code of a country/geographical location referenced by the content of the object.

##### ContentLocationName
```
public static final IptcApplicationRecordDataSet ContentLocationName
```

Provides a full, publishable name of a country/geographical location referenced by the content of the object,

 according to guidelines of the provider.

##### ReleaseDate
```
public static final IptcApplicationRecordDataSet ReleaseDate
```

Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard.

##### ReleaseTime
```
public static final IptcApplicationRecordDataSet ReleaseTime
```

Designates in the form HHMMSS??HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard.

##### ExpirationDate
```
public static final IptcApplicationRecordDataSet ExpirationDate
```

Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Follows ISO 8601 standard.

##### SpecialInstructions
```
public static final IptcApplicationRecordDataSet SpecialInstructions
```

Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings.

##### ActionAdvised
```
public static final IptcApplicationRecordDataSet ActionAdvised
```

Indicates the type of action that this object provides to a previous object.

##### ReferenceService
```
public static final IptcApplicationRecordDataSet ReferenceService
```

Identifies the Service Identifier of a prior envelope to which the current object refers.

##### ReferenceDate
```
public static final IptcApplicationRecordDataSet ReferenceDate
```

Identifies the date of a prior envelope to which the current object refers.

##### ReferenceNumber
```
public static final IptcApplicationRecordDataSet ReferenceNumber
```

Identifies the Envelope Number of a prior envelope to which the current object refers.

##### DateCreated
```
public static final IptcApplicationRecordDataSet DateCreated
```

Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation.

Follows ISO 8601 standard. Where the month or day cannot be determined, the information will be represented by ???00???. Where the year cannot be determined, the information for century and year will be represented by ???00???.

##### TimeCreated
```
public static final IptcApplicationRecordDataSet TimeCreated
```

Represented in the form HHMMSS??HHMM to designate the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation.

Follows ISO 8601 standard.

##### DigitalCreationDate
```
public static final IptcApplicationRecordDataSet DigitalCreationDate
```

Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created.

##### DigitalCreationTime
```
public static final IptcApplicationRecordDataSet DigitalCreationTime
```

Represented in the form HHMMSS??HHMM to designate the time the digital representation of the objectdata was created.

##### OriginatingProgram
```
public static final IptcApplicationRecordDataSet OriginatingProgram
```

Identifies the type of program used to originate the objectdata.

##### ProgramVersion
```
public static final IptcApplicationRecordDataSet ProgramVersion
```

Used to identify the version of the program mentioned in 2:65. DataSet 2:70 is invalid if 2:65 is not present.

##### ObjectCycle
```
public static final IptcApplicationRecordDataSet ObjectCycle
```

Consisting of an alphabetic character. Where: 'a'(morning, 'p'(evening, 'b'(both.

##### Byline
```
public static final IptcApplicationRecordDataSet Byline
```

Contains name of the creator of the objectdata, e.g. writer, photographer or graphic artist.

##### BylineTitle
```
public static final IptcApplicationRecordDataSet BylineTitle
```

A by-line title is the title of the creator or creators of an object data.

##### City
```
public static final IptcApplicationRecordDataSet City
```

Identifies city of objectdata origin according to guidelines established by the provider.

##### SubLocation
```
public static final IptcApplicationRecordDataSet SubLocation
```

Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider.

##### ProvinceState
```
public static final IptcApplicationRecordDataSet ProvinceState
```

Identifies Province/State of origin according to guidelines established by the provider.

##### PrimaryLocationCode
```
public static final IptcApplicationRecordDataSet PrimaryLocationCode
```

Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. a photo was taken, an event occurred.

##### PrimaryLocationName
```
public static final IptcApplicationRecordDataSet PrimaryLocationName
```

Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider.

##### OriginalTransmissionReference
```
public static final IptcApplicationRecordDataSet OriginalTransmissionReference
```

A code representing the location of original transmission according to practices of the provider.

##### Headline
```
public static final IptcApplicationRecordDataSet Headline
```

A publishable entry providing a synopsis of the contents of the objectdata.

##### Credit
```
public static final IptcApplicationRecordDataSet Credit
```

Identifies the provider of the objectdata, not necessarily the owner/creator.

##### Source
```
public static final IptcApplicationRecordDataSet Source
```

The name of a person or party who has a role in the content supply chain. This could be an agency, a member of an agency, an individual or a combination.

##### CopyrightNotice
```
public static final IptcApplicationRecordDataSet CopyrightNotice
```

Contains any necessary copyright notice.

##### Contact
```
public static final IptcApplicationRecordDataSet Contact
```

Identifies the person or organization which can provide further background information on the object data.

##### CaptionAbstract
```
public static final IptcApplicationRecordDataSet CaptionAbstract
```

A textual description of the objectdata, particularly used where the object is not text.

##### WriterEditor
```
public static final IptcApplicationRecordDataSet WriterEditor
```

Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract.

##### RasterizedCaption
```
public static final IptcApplicationRecordDataSet RasterizedCaption
```

Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right.

##### ImageType
```
public static final IptcApplicationRecordDataSet ImageType
```

The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes.

##### ImageOrientation
```
public static final IptcApplicationRecordDataSet ImageOrientation
```

Indicates the layout of the image area.

##### LanguageIdentifier
```
public static final IptcApplicationRecordDataSet LanguageIdentifier
```

Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988.

##### AudioType
```
public static final IptcApplicationRecordDataSet AudioType
```

The audio type.

##### AudioSamplingRate
```
public static final IptcApplicationRecordDataSet AudioSamplingRate
```

Sampling rate numeric characters, representing the sampling rate in hertz (Hz).

##### AudioSamplingResolution
```
public static final IptcApplicationRecordDataSet AudioSamplingResolution
```

The number of bits in each audio sample.

##### AudioDuration
```
public static final IptcApplicationRecordDataSet AudioDuration
```

Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded.

##### AudioOutcue
```
public static final IptcApplicationRecordDataSet AudioOutcue
```

Identifies the content of the end of an audio objectdata, according to guidelines established by the provider.

##### ObjDataPreviewFileFormat
```
public static final IptcApplicationRecordDataSet ObjDataPreviewFileFormat
```

A binary number representing the file format of the ObjectData Preview.

##### ObjDataPreviewFileFormatVer
```
public static final IptcApplicationRecordDataSet ObjDataPreviewFileFormatVer
```

A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200.

##### ObjDataPreviewData
```
public static final IptcApplicationRecordDataSet ObjDataPreviewData
```

The object data preview.

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

**Returns:**
com.groupdocs.metadata.core.IptcApplicationRecordDataSet[]
##### valueOf(String name)
```
public static IptcApplicationRecordDataSet valueOf(String name)
```

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

**Returns:**
IptcApplicationRecordDataSet
##### getByRawValue(int rawValue)
```
public static IptcApplicationRecordDataSet getByRawValue(int rawValue)
```

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

**Returns:**
IptcApplicationRecordDataSet
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### IptcDataSet
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcdataset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class IptcDataSet extends MetadataProperty
```

Represents an IPTC DataSet (metadata property).

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, String value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, int value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, Date value) | Initializes a new instance of the  IptcDataSet  class. |
#### Methods

| Method | Description |
| --- | --- |
| getRecordNumber() | Gets the record number. |
| getDataSetNumber() | Gets the dataSet number. |
| getAlternativeName() | Gets the alternative name of the dataSet. |
##### IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | byte[] | A byte array value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, String value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, String value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | java.lang.String | A string value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, int value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, int value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | int | An integer value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, Date value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, Date value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | java.util.Date | A date value. |

##### getRecordNumber()
```
public final byte getRecordNumber()
```

Gets the record number.

**Returns:**
byte - The record number.
##### getDataSetNumber()
```
public final byte getDataSetNumber()
```

Gets the dataSet number.

**Returns:**
byte - The dataSet number.
##### getAlternativeName()
```
public final String getAlternativeName()
```

Gets the alternative name of the dataSet.

**Returns:**
java.lang.String - The alternative name of the dataSet.

### IptcEnvelopeRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcenveloperecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.IptcRecord
```
public final class IptcEnvelopeRecord extends IptcRecord
```

Represents an IPTC Envelope Record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcEnvelopeRecord() | Initializes a new instance of the  IptcEnvelopeRecord  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModelVersion() | Gets a number identifying the version of the information. |
| setModelVersion(Integer value) | Sets a number identifying the version of the information. |
| getDestination() | Gets the destination. |
| setDestination(String value) | Sets the destination. |
| getDestinations() | Gets an array of destinations. |
| setDestinations(String[] value) | Sets an array of destinations. |
| getFileFormat() | Gets the file format. |
| setFileFormat(Integer value) | Sets the file format. |
| getFileFormatVersion() | Gets the file format version. |
| setFileFormatVersion(Integer value) | Sets the file format version. |
| getServiceIdentifier() | Gets the service identifier. |
| setServiceIdentifier(String value) | Sets the service identifier. |
| getProductID() | Gets the product identifier. |
| setProductID(String value) | Sets the product identifier. |
| getProductIds() | Gets the product identifiers. |
| setProductIds(String[] value) | Sets the product identifiers. |
| getDateSent() | Gets the date the service sent the material. |
| setDateSent(Date value) | Sets the date the service sent the material. |
| getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber) | Gets the  IptcDataSet  with the specified number. |
##### IptcEnvelopeRecord()
```
public IptcEnvelopeRecord()
```

Initializes a new instance of the  IptcEnvelopeRecord  class.

##### getModelVersion()
```
public final Integer getModelVersion()
```

Gets a number identifying the version of the information.

**Returns:**
java.lang.Integer - The model version.
##### setModelVersion(Integer value)
```
public final void setModelVersion(Integer value)
```

Sets a number identifying the version of the information.

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

##### getDestination()
```
public final String getDestination()
```

Gets the destination.

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

Sets the destination.

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

##### getDestinations()
```
public final String[] getDestinations()
```

Gets an array of destinations.

**Returns:**
java.lang.String[] - The destinations.
##### setDestinations(String[] value)
```
public final void setDestinations(String[] value)
```

Sets an array of destinations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The destinations. |

##### getFileFormat()
```
public final Integer getFileFormat()
```

Gets the file format.

**Returns:**
java.lang.Integer - The file format.
##### setFileFormat(Integer value)
```
public final void setFileFormat(Integer value)
```

Sets the file format.

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

##### getFileFormatVersion()
```
public final Integer getFileFormatVersion()
```

Gets the file format version. A number representing the particular version of the File Format specified in  FileFormat .

**Returns:**
java.lang.Integer - The file format version.
##### setFileFormatVersion(Integer value)
```
public final void setFileFormatVersion(Integer value)
```

Sets the file format version. A number representing the particular version of the File Format specified in  FileFormat .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format version. |

##### getServiceIdentifier()
```
public final String getServiceIdentifier()
```

Gets the service identifier.

**Returns:**
java.lang.String - The service identifier.
##### setServiceIdentifier(String value)
```
public final void setServiceIdentifier(String value)
```

Sets the service identifier.

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

##### getProductID()
```
public final String getProductID()
```

Gets the product identifier.

**Returns:**
java.lang.String - The product identifier.
##### setProductID(String value)
```
public final void setProductID(String value)
```

Sets the product identifier.

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

##### getProductIds()
```
public final String[] getProductIds()
```

Gets the product identifiers.

**Returns:**
java.lang.String[] - The product identifiers.
##### setProductIds(String[] value)
```
public final void setProductIds(String[] value)
```

Sets the product identifiers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The product identifiers. |

##### getDateSent()
```
public final Date getDateSent()
```

Gets the date the service sent the material.

**Returns:**
java.util.Date - The date the service sent the material.
##### setDateSent(Date value)
```
public final void setDateSent(Date value)
```

Sets the date the service sent the material.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the service sent the material. |

##### getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber)
```
public final IptcDataSet getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber)
```

Gets the  IptcDataSet  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | IptcEnvelopeRecordDataSet | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified number.

### IptcEnvelopeRecordDataSet
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcenveloperecorddataset.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class IptcEnvelopeRecordDataSet implements IEnumValue
```

Defines IPTC Envelope Record dataSet numbers.
#### Fields

| Field | Description |
| --- | --- |
| ModelVersion |  |
| Destination |  |
| FileFormat | File format. |
| FileFormatVersion |  |
| ServiceIdentifier |  |
| EnvelopeNumber |  |
| ProductID |  |
| EnvelopePriority |  |
| DateSent |  |
| TimeSent |  |
| CodedCharacterSet |  |
| Uno | Invalid (eternal identifier). |
| ArmIdentifier | The DataSet identifies the Abstract Relationship Method (ARM) which is described in a document registered by the originator of the ARM with the IPTC and NAA. |
| ArmVersion | Binary number representing the particular version of the ARM specified in DataSet 1:120. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### ModelVersion
```
public static final IptcEnvelopeRecordDataSet ModelVersion
```

A binary number identifying the version of the Information

 Interchange Model, Part I, utilised by the provider. Version numbers are assigned by IPTC and NAA.

 The version number of this record is four (4).

##### Destination
```
public static final IptcEnvelopeRecordDataSet Destination
```

Optional, repeatable, maximum 1024 octets, consisting of sequentially contiguous graphic characters.

 This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

##### FileFormat
```
public static final IptcEnvelopeRecordDataSet FileFormat
```

File format.

##### FileFormatVersion
```
public static final IptcEnvelopeRecordDataSet FileFormatVersion
```

Mandatory, not repeatable, two octets.

 A binary number representing the particular version of the File Format specified in 1:20.

 A list of File Formats, including version cross references, is included as Appendix A.

##### ServiceIdentifier
```
public static final IptcEnvelopeRecordDataSet ServiceIdentifier
```

Mandatory, not repeatable. Up to 10 octets, consisting of graphic characters.

 Identifies the provider and product.

##### EnvelopeNumber
```
public static final IptcEnvelopeRecordDataSet EnvelopeNumber
```

Mandatory, not repeatable, eight octets, consisting of numeric characters.

 The characters form a number that will be unique for the date specified in 1:70 and for the Service Identifier specified in 1:30.

 If identical envelope numbers appear with the same date and with the same Service Identifier, records 2-9 must be unchanged from the original.

 This is not intended to be a sequential serial number reception check.

##### ProductID
```
public static final IptcEnvelopeRecordDataSet ProductID
```

Optional, repeatable. Up to 32 octets, consisting of graphic characters.

 Allows a provider to identify subsets of its overall service.

 Used to provide receiving organization data on which to select, route, or otherwise handle data.

##### EnvelopePriority
```
public static final IptcEnvelopeRecordDataSet EnvelopePriority
```

Optional, not repeatable. A single octet, consisting of a numeric character.

 Specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency). '1' indicates the most urgent, '5' the normal urgency, and '8' the least urgent copy. The numeral '9' indicates a User Defined Priority. The numeral '0' is reserved for future use.

##### DateSent
```
public static final IptcEnvelopeRecordDataSet DateSent
```

Mandatory, not repeatable. Eight octets, consisting of numeric characters.

 Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day the service sent the material.

##### TimeSent
```
public static final IptcEnvelopeRecordDataSet TimeSent
```

Uses the format HHMMSS±HHMM where HHMMSS refers to local hour, minute and seconds and HHMM refers to hours and minutes ahead (+) or behind (-) Universal Coordinated Time as described in ISO 8601. This is the time the service sent the material.

##### CodedCharacterSet
```
public static final IptcEnvelopeRecordDataSet CodedCharacterSet
```

Optional, not repeatable, up to 32 octets, consisting of one or more control functions used for the announcement, invocation or designation of coded character sets. The control functions follow the ISO 2022 standard and may consist of the escape control character and one or more graphic characters. For more details see Appendix C, the IPTC-NAA Code Library.

##### Uno
```
public static final IptcEnvelopeRecordDataSet Uno
```

Invalid (eternal identifier).

##### ArmIdentifier
```
public static final IptcEnvelopeRecordDataSet ArmIdentifier
```

The DataSet identifies the Abstract Relationship Method (ARM) which is described in a document registered by the originator of the ARM with the IPTC and NAA.

##### ArmVersion
```
public static final IptcEnvelopeRecordDataSet ArmVersion
```

Binary number representing the particular version of the ARM specified in DataSet 1:120.

##### getByRawValue(int rawValue)
```
public static IptcEnvelopeRecordDataSet getByRawValue(int rawValue)
```

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

**Returns:**
IptcEnvelopeRecordDataSet
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### IptcRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class IptcRecord extends CustomPackage
```

Represents an IPTC record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getRecordNumber() | Gets the record number. |
| toList() | Creates a list from the package. |
| get_Item(byte dataSetNumber) | Gets the  IptcDataSet  with the specified dataSet number. |
##### getRecordNumber()
```
public final byte getRecordNumber()
```

Gets the record number.

**Returns:**
byte - The record number.
##### toList()
```
public final IReadOnlyList<IptcDataSet> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC dataSets from the package.
##### get_Item(byte dataSetNumber)
```
public final IptcDataSet get_Item(byte dataSetNumber)
```

Gets the  IptcDataSet  with the specified dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | byte | The IPTC dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified dataSet number, if found; otherwise null.

### IptcRecordSet
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class IptcRecordSet extends CustomPackage
```

Represents a collection of IPTC records.

This code sample shows hot to update basic IPTC metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IIptc root = (IIptc) metadata.getRootPackage();
>      // Set the IPTC package if it's missing
>      if (root.getIptcPackage() == null) {
>          root.setIptcPackage(new IptcRecordSet());
>      }
>      if (root.getIptcPackage().getEnvelopeRecord() == null) {
>          root.getIptcPackage().setEnvelopeRecord(new IptcEnvelopeRecord());
>      }
>      root.getIptcPackage().getEnvelopeRecord().setDateSent(new Date());
>      root.getIptcPackage().getEnvelopeRecord().setProductID("test project id");
>      // ...
>      if (root.getIptcPackage().getApplicationRecord() == null) {
>          root.getIptcPackage().setApplicationRecord(new IptcApplicationRecord());
>      }
>      root.getIptcPackage().getApplicationRecord().setByLine("GroupDocs");
>      root.getIptcPackage().getApplicationRecord().setHeadline("test");
>      root.getIptcPackage().getApplicationRecord().setByLineTitle("code sample");
>      root.getIptcPackage().getApplicationRecord().setReleaseDate(new Date());
>      // ...
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcRecordSet() | Initializes a new instance of the  IptcRecordSet  class. |
| IptcRecordSet(IptcDataSet[] dataSets) | Initializes a new instance of the  IptcRecordSet  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEnvelopeRecord() | Gets the Envelope Record. |
| setEnvelopeRecord(IptcEnvelopeRecord value) | Sets the Envelope Record. |
| getApplicationRecord() | Gets the Application Record. |
| setApplicationRecord(IptcApplicationRecord value) | Sets the Application Record. |
| get_Item(byte recordNumber) | Gets the  IptcRecord  with the specified number. |
| get_Item(byte recordNumber, byte dataSetNumber) | Gets the  IptcDataSet  with the specified record and dataSet number. |
| set(IptcDataSet dataSet) | Adds or updates the specified dataSet in the appropriate record. |
| add(IptcDataSet dataSet) | Adds the specified dataSet to the appropriate record. |
| remove(byte recordNumber, byte dataSetNumber) | Removes the dataSet with the specified record and dataSet number. |
| clear() | Removes all records from the collection. |
| remove(byte recordNumber) | Removes the record with the specified record number. |
| toDataSetList() | Creates a list of dataSets from the package. |
| toList() | Creates a list from the package. |
##### IptcRecordSet()
```
public IptcRecordSet()
```

Initializes a new instance of the  IptcRecordSet  class.

##### IptcRecordSet(IptcDataSet[] dataSets)
```
public IptcRecordSet(IptcDataSet[] dataSets)
```

Initializes a new instance of the  IptcRecordSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSets | IptcDataSet\[\] | An array of IPTC dataSets. |

##### getEnvelopeRecord()
```
public final IptcEnvelopeRecord getEnvelopeRecord()
```

Gets the Envelope Record.

**Returns:**
IptcEnvelopeRecord - The Envelope Record.
##### setEnvelopeRecord(IptcEnvelopeRecord value)
```
public final void setEnvelopeRecord(IptcEnvelopeRecord value)
```

Sets the Envelope Record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcEnvelopeRecord | The Envelope Record. |

##### getApplicationRecord()
```
public final IptcApplicationRecord getApplicationRecord()
```

Gets the Application Record.

**Returns:**
IptcApplicationRecord - The Application Record.
##### setApplicationRecord(IptcApplicationRecord value)
```
public final void setApplicationRecord(IptcApplicationRecord value)
```

Sets the Application Record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcApplicationRecord | The Application Record. |

##### get_Item(byte recordNumber)
```
public final IptcRecord get_Item(byte recordNumber)
```

Gets the  IptcRecord  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |

**Returns:**
IptcRecord - The  IptcRecord  with the specified number, if found; otherwise null.
##### get_Item(byte recordNumber, byte dataSetNumber)
```
public final IptcDataSet get_Item(byte recordNumber, byte dataSetNumber)
```

Gets the  IptcDataSet  with the specified record and dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified record and dataSet number.
##### set(IptcDataSet dataSet)
```
public final void set(IptcDataSet dataSet)
```

Adds or updates the specified dataSet in the appropriate record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add/update. |

##### add(IptcDataSet dataSet)
```
public final void add(IptcDataSet dataSet)
```

Adds the specified dataSet to the appropriate record. The dataSet is considered as repeatable if a dataSet with the specified number already exists.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add. |

##### remove(byte recordNumber, byte dataSetNumber)
```
public final boolean remove(byte recordNumber, byte dataSetNumber)
```

Removes the dataSet with the specified record and dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |

**Returns:**
boolean - True if the specified IPTC dataSet is found and removed; otherwise, false.
##### clear()
```
public final void clear()
```

Removes all records from the collection.

##### remove(byte recordNumber)
```
public final boolean remove(byte recordNumber)
```

Removes the record with the specified record number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |

**Returns:**
boolean - True if the specified IPTC record is found and removed; otherwise, false.
##### toDataSetList()
```
public final IReadOnlyList<IptcDataSet> toDataSetList()
```

Creates a list of dataSets from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC dataSets from the package.
##### toList()
```
public final IReadOnlyList<IptcRecord> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC records from the package.

### IptcRecordType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/iptcrecordtype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class IptcRecordType implements IEnumValue
```

Defines IPTC record types.
#### Fields

| Field | Description |
| --- | --- |
| EnvelopeRecord | Represents an Envelope Record. |
| ApplicationRecord | Represents an Application Record. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### EnvelopeRecord
```
public static final IptcRecordType EnvelopeRecord
```

Represents an Envelope Record.

##### ApplicationRecord
```
public static final IptcRecordType ApplicationRecord
```

Represents an Application Record.

##### getByRawValue(int rawValue)
```
public static IptcRecordType getByRawValue(int rawValue)
```

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

**Returns:**
IptcRecordType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### IReadOnlyList
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ireadonlylist.md

**All Implemented Interfaces:**
java.lang.Iterable
```
public interface IReadOnlyList<T> extends Iterable<T>
```

Represents a read-only collection of elements that can be accessed by index.

 T : The type of elements in the read-only list.
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the collection. |
| get_Item(int index) | Gets the element at the specified index in the read-only list. |
| indexOf(T item) | Determines the index of a specific item in the collection. |
| contains(T item) | Determines whether the collection contains a specific item. |
| contains(TagCategory item) | Determines whether the collection contains a TagCategory item. |
##### getCount()
```
public abstract int getCount()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.
##### get_Item(int index)
```
public abstract T get_Item(int index)
```

Gets the element at the specified index in the read-only list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the element to get. |

**Returns:**
T - The element at the specified index in the read-only list.
##### indexOf(T item)
```
public abstract int indexOf(T item)
```

Determines the index of a specific item in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
int - The index of  item  if found in the collection; otherwise, -1.
##### contains(T item)
```
public abstract boolean contains(T item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### contains(TagCategory item)
```
public abstract boolean contains(TagCategory item)
```

Determines whether the collection contains a TagCategory item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.

### IXmp
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ixmp.md

### IXmpType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ixmptype.md

### Jpeg2000Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/jpeg2000package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class Jpeg2000Package extends CustomPackage
```

Represents native JPEG2000 metadata.

[Working with metadata in JPEG2000 images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG2000+images
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the JPEG2000 comments. |
##### getComments()
```
public final String[] getComments()
```

Gets the JPEG2000 comments.

**Returns:**
java.lang.String[] - The JPEG2000 comments.

### Jpeg2000RootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/jpeg2000rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class Jpeg2000RootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a JPEG2000 image.

This code snippet demonstrates how to read JPEG2000 image comments.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg2000)) {
>      Jpeg2000RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getJpeg2000Package().getComments() != null) {
>          for (String comment : root.getJpeg2000Package().getComments()) {
>              System.out.println(comment);
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in JPEG2000 images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG2000+images
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getJpeg2000Package() | Gets the JPEG2000 native metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getJpeg2000Package()
```
public final Jpeg2000Package getJpeg2000Package()
```

Gets the JPEG2000 native metadata package.

**Returns:**
Jpeg2000Package - The JPEG2000 native metadata package.

### JpegRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/jpegrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif, com.groupdocs.metadata.core.IIptc
```
public class JpegRootPackage extends ImageRootPackage implements IXmp, IExif, IIptc
```

Represents the root package allowing working with metadata in a JPEG image.

[Working with metadata in JPEG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
| getImageResourcePackage() | Gets the Photoshop Image Resource metadata package. |
| getMakerNotePackage() | Gets the MakerNote metadata package. |
| removeImageResourcePackage() | Removes Photoshop Image Resource metadata package. |
| detectBarcodeTypes() | Extracts the types of the barcodes presented in the image. |
| sanitize() | Removes writable metadata properties from the package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

##### getImageResourcePackage()
```
public final ImageResourcePackage getImageResourcePackage()
```

Gets the Photoshop Image Resource metadata package. Image resource blocks are the basic building unit of Photoshop native file format.

**Returns:**
ImageResourcePackage - The Image Resource metadata package.
##### getMakerNotePackage()
```
public final MakerNotePackage getMakerNotePackage()
```

Gets the MakerNote metadata package.

**Returns:**
MakerNotePackage - The MakerNote metadata package.
##### removeImageResourcePackage()
```
public final void removeImageResourcePackage()
```

Removes Photoshop Image Resource metadata package.

##### detectBarcodeTypes()
```
public final String[] detectBarcodeTypes()
```

Extracts the types of the barcodes presented in the image.

**Returns:**
java.lang.String[] - An array of barcode types.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### LyricsField
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/lyricsfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class LyricsField extends MetadataProperty
```

Represents a  LyricsTag  field.

[Handling the Lyrics tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+Lyrics+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| LyricsField(String id, String data) | Initializes a new instance of the  LyricsField  class. |
#### Methods

| Method | Description |
| --- | --- |
| getID() | Gets the id of the field (it's always three characters long). |
| getSize() | Gets the string representation of the field size. |
| getData() | Gets the field data. |
##### LyricsField(String id, String data)
```
public LyricsField(String id, String data)
```

Initializes a new instance of the  LyricsField  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The three character field id. |
| data | java.lang.String | The field data. |

##### getID()
```
public final String getID()
```

Gets the id of the field (it's always three characters long).

**Returns:**
java.lang.String - The id of the field (it's always three characters long).
##### getSize()
```
public final String getSize()
```

Gets the string representation of the field size.

**Returns:**
java.lang.String - The string representation of the field size.
##### getData()
```
public final String getData()
```

Gets the field data.

**Returns:**
java.lang.String - The field data.

### LyricsTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/lyricstag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class LyricsTag extends CustomPackage
```

Represents Lyrics3 v2.00 metadata. Please find more information at  http://id3.org/Lyrics3v2 .

Lyrics3 v2.00 uses fields to represent information. The data in a field can consist of ASCII characters in the range 01 to 254 according to the standard. As the ASCII character map is only defined from 00 to 128 ISO-8859-1 might be assumed. Numerical fields are 5 or 6 characters long, depending on location, and are padded with zeroes.

This code sample shows how to read the Lyrics tag from an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithLyrics)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getLyrics3V2() != null) {
>          System.out.println(root.getLyrics3V2().getLyrics());
>          System.out.println(root.getLyrics3V2().getAlbum());
>          System.out.println(root.getLyrics3V2().getArtist());
>          System.out.println(root.getLyrics3V2().getTrack());
>          // ...
>          // Alternatively, you can loop through a full list of tag fields
>          for (LyricsField field : root.getLyrics3V2().toList()) {
>              System.out.println(String.format("%s = %s", field.getID(), field.getData()));
>          }
>      }
>  }
>
> ```
> ```

[Handling the Lyrics tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+Lyrics+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| LyricsTag() | Initializes a new instance of the  LyricsTag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getLyrics() | Gets the lyrics. |
| setLyrics(String value) | Sets the lyrics. |
| getAdditionalInfo() | Gets the additional information. |
| setAdditionalInfo(String value) | Sets the additional information. |
| getAuthor() | Gets the author. |
| setAuthor(String value) | Sets the author. |
| getAlbum() | Gets the album name. |
| setAlbum(String value) | Sets the album name. |
| getArtist() | Gets the artist name. |
| setArtist(String value) | Sets the artist name. |
| getTrack() | Gets the track title. |
| setTrack(String value) | Sets the track title. |
| set(LyricsField field) | Adds or replaces the specified Lyrics3 field. |
| remove(String id) | Removes the field with the specified id. |
| get(String id) | Gets the value of the field with the specified id. |
| toList() | Creates a list from the package. |
##### LyricsTag()
```
public LyricsTag()
```

Initializes a new instance of the  LyricsTag  class.

##### getLyrics()
```
public final String getLyrics()
```

Gets the lyrics. This value is represented by the LYR field.

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

Sets the lyrics. This value is represented by the LYR field.

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

##### getAdditionalInfo()
```
public final String getAdditionalInfo()
```

Gets the additional information. This value is represented by the INF field.

**Returns:**
java.lang.String - The additional information.

This is always three (3) characters long in v2.00, but might be longer in a future standard. The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise. The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no. The third character inhibits tracks for random selection - "1" if inhibited and "0" if not.
##### setAdditionalInfo(String value)
```
public final void setAdditionalInfo(String value)
```

Sets the additional information. This value is represented by the INF field.

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

This is always three (3) characters long in v2.00, but might be longer in a future standard. The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise. The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no. The third character inhibits tracks for random selection - "1" if inhibited and "0" if not. |

##### getAuthor()
```
public final String getAuthor()
```

Gets the author. This value is represented by the AUT field.

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

Sets the author. This value is represented by the AUT field.

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

##### getAlbum()
```
public final String getAlbum()
```

Gets the album name. This value is represented by the EAL field.

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

Sets the album name. This value is represented by the EAL field.

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

##### getArtist()
```
public final String getArtist()
```

Gets the artist name. This value is represented by the EAR field.

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

Sets the artist name. This value is represented by the EAR field.

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

##### getTrack()
```
public final String getTrack()
```

Gets the track title. This value is represented by the ETT field.

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

Sets the track title. This value is represented by the ETT field.

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

##### set(LyricsField field)
```
public final void set(LyricsField field)
```

Adds or replaces the specified Lyrics3 field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| field | LyricsField | The field to be set. |

##### remove(String id)
```
public final void remove(String id)
```

Removes the field with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The field identifier. |

##### get(String id)
```
public final String get(String id)
```

Gets the value of the field with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The id of the field. |

**Returns:**
java.lang.String - The value if the tag contains a field with the specified id; otherwise, null.
##### toList()
```
public final IReadOnlyList<LyricsField> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list of all fields contained in the Lyrics3 tag.

### MakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/makernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public abstract class MakerNotePackage extends ExifDictionaryBasePackage
```

Provides an abstract base class for MakerNote metadata packages.

### MatroskaAudioTrack
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskaaudiotrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaAudioTrack extends MatroskaTrack
```

Represents audio metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSamplingFrequency() | Gets the sampling frequency in Hz. |
| getOutputSamplingFrequency() | Gets the real output sampling frequency in Hz (used for SBR techniques). |
| getChannels() | Gets the numbers of channels in the track. |
| getBitDepth() | Gets the bits per sample, mostly used for PCM. |
##### getSamplingFrequency()
```
public final double getSamplingFrequency()
```

Gets the sampling frequency in Hz.

**Returns:**
double - The sampling frequency in Hz.
##### getOutputSamplingFrequency()
```
public final double getOutputSamplingFrequency()
```

Gets the real output sampling frequency in Hz (used for SBR techniques).

**Returns:**
double - The real output sampling frequency in Hz (used for SBR techniques).
##### getChannels()
```
public final long getChannels()
```

Gets the numbers of channels in the track.

**Returns:**
long - The numbers of channels in the track.
##### getBitDepth()
```
public final Long getBitDepth()
```

Gets the bits per sample, mostly used for PCM.

**Returns:**
java.lang.Long - The bits per sample, mostly used for PCM.

### MatroskaBasePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskabasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class MatroskaBasePackage extends CustomPackage
```

Provides a base metadata class for all packages extracted from a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files

### MatroskaContentType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskacontenttype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaContentType extends Enum<MatroskaContentType> implements IEnumValue
```

Represents a Matroska content type.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined content. |
| Audio | Defines the Matroska audio type. |
| Video | Defines the Matroska video type. |
| Video3D | Defines the Matroska 3D video type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaContentType Undefined
```

Undefined content.

##### Audio
```
public static final MatroskaContentType Audio
```

Defines the Matroska audio type.

##### Video
```
public static final MatroskaContentType Video
```

Defines the Matroska video type.

##### Video3D
```
public static final MatroskaContentType Video3D
```

Defines the Matroska 3D video type.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaContentType[]
##### valueOf(String name)
```
public static MatroskaContentType valueOf(String name)
```

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

**Returns:**
MatroskaContentType
##### getByRawValue(int rawValue)
```
public static MatroskaContentType getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaContentType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaEbmlHeader
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskaebmlheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaEbmlHeader extends MatroskaBasePackage
```

Represents EBML header metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the EBML Writer that has been used to create the file. |
| getReadVersion() | Gets the minimum version an EBML parser needs to be compliant with to be able to read the file. |
| getDocType() | Gets the contents of the file. |
| getDocTypeVersion() | Gets the version of the  DocType  writer used to create the file. |
| getDocTypeReadVersion() | Gets the minimum version number a  DocType  parser must be compliant with to read the file. |
##### getVersion()
```
public final byte getVersion()
```

Gets the version of the EBML Writer that has been used to create the file.

**Returns:**
byte - The version of the EBML Writer that has been used to create the file.
##### getReadVersion()
```
public final byte getReadVersion()
```

Gets the minimum version an EBML parser needs to be compliant with to be able to read the file.

**Returns:**
byte - The minimum version an EBML parser needs to be compliant with to be able to read the file.
##### getDocType()
```
public final String getDocType()
```

Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'.

**Returns:**
java.lang.String - The contents of the file.
##### getDocTypeVersion()
```
public final byte getDocTypeVersion()
```

Gets the version of the  DocType  writer used to create the file.

**Returns:**
byte - The version of the  DocType  writer used to create the file.
##### getDocTypeReadVersion()
```
public final byte getDocTypeReadVersion()
```

Gets the minimum version number a  DocType  parser must be compliant with to read the file.

**Returns:**
byte - The minimum version number a  DocType  parser must be compliant with to read the file.

### MatroskaPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaPackage extends MatroskaBasePackage
```

Represents a metadata container in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getEbmlHeader() | Gets the EBML header metadata. |
| getSegments() | Gets the segment information metadata. |
| getTracks() | Gets the track metadata entries. |
| getTags() | Gets the tagging metadata. |
| getContentType() | Gets the Matroska content type. |
| getSubtitleTracks() | Gets the subtitle metadata entries. |
##### getEbmlHeader()
```
public final MatroskaEbmlHeader getEbmlHeader()
```

Gets the EBML header metadata.

**Returns:**
MatroskaEbmlHeader - The EBML header metadata.
##### getSegments()
```
public final MatroskaSegment[] getSegments()
```

Gets the segment information metadata.

**Returns:**
com.groupdocs.metadata.core.MatroskaSegment[] - The segment information metadata.
##### getTracks()
```
public final MatroskaTrack[] getTracks()
```

Gets the track metadata entries.

**Returns:**
com.groupdocs.metadata.core.MatroskaTrack[] - The track metadata entries.
##### getTags()
```
public final MatroskaTag[] getTags()
```

Gets the tagging metadata.

**Returns:**
com.groupdocs.metadata.core.MatroskaTag[] - The tagging metadata.
##### getContentType()
```
public final MatroskaContentType getContentType()
```

Gets the Matroska content type.

**Returns:**
MatroskaContentType - The Matroska content type.
##### getSubtitleTracks()
```
public final MatroskaSubtitleTrack[] getSubtitleTracks()
```

Gets the subtitle metadata entries.

**Returns:**
com.groupdocs.metadata.core.MatroskaSubtitleTrack[] - The subtitle metadata entries.

### MatroskaRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskarootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class MatroskaRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a Matroska video.

This example demonstrates how to extract subtitles from an MKV video.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MkvWithSubtitles)) {
>      MatroskaRootPackage root = metadata.getRootPackageGeneric();
>      for (MatroskaSubtitleTrack subtitleTrack : root.getMatroskaPackage().getSubtitleTracks()) {
>          System.out.println(subtitleTrack.getLanguageIetf() != null ? subtitleTrack.getLanguageIetf() : subtitleTrack.getLanguage());
>          for (MatroskaSubtitle subtitle : subtitleTrack.getSubtitles()) {
>              System.out.println(String.format("Timecode=%s, Duration=%s", subtitle.getTimecode(), subtitle.getDuration()));
>              System.out.println(subtitle.getText());
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getMatroskaPackage() | Gets the Matroska metadata package. |
##### getMatroskaPackage()
```
public final MatroskaPackage getMatroskaPackage()
```

Gets the Matroska metadata package.

**Returns:**
MatroskaPackage - The Matroska metadata package.

### MatroskaSegment
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskasegment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSegment extends MatroskaBasePackage
```

Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSegmentUid() | Gets the unique 128 bit number identifying a SEGMENT. |
| getSegmentFilename() | Gets the filename corresponding to this Segment. |
| getTimecodeScale() | Gets the timecode scale value. |
| getDuration() | Gets the duration of the SEGMENT. |
| getDateUtc() | Gets the date and time that the Segment was created by the muxing application or library. |
| getTitle() | Gets the general name of the Segment. |
| getMuxingApp() | Gets the full name of the application or library followed by the version number. |
| getWritingApp() | Gets the full name of the application followed by the version number. |
| getScaledDuration() | Gets the scaled duration of the SEGMENT in milliseconds. |
##### getSegmentUid()
```
public final byte[] getSegmentUid()
```

Gets the unique 128 bit number identifying a SEGMENT. Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID.

**Returns:**
byte[] - The unique 128 bit number identifying a SEGMENT.
##### getSegmentFilename()
```
public final String getSegmentFilename()
```

Gets the filename corresponding to this Segment.

**Returns:**
java.lang.String - The filename corresponding to this Segment.
##### getTimecodeScale()
```
public final long getTimecodeScale()
```

Gets the timecode scale value. Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled!

**Returns:**
long - The timecode scale value.
##### getDuration()
```
public final Double getDuration()
```

Gets the duration of the SEGMENT. Please see  TimecodeScale  for more information.

**Returns:**
java.lang.Double - The duration of the SEGMENT.
##### getDateUtc()
```
public final Date getDateUtc()
```

Gets the date and time that the Segment was created by the muxing application or library.

**Returns:**
java.util.Date - The date and time that the Segment was created by the muxing application or library.
##### getTitle()
```
public final String getTitle()
```

Gets the general name of the Segment.

**Returns:**
java.lang.String - The general name of the Segment.
##### getMuxingApp()
```
public final String getMuxingApp()
```

Gets the full name of the application or library followed by the version number.

**Returns:**
java.lang.String - The full name of the application or library followed by the version number.
##### getWritingApp()
```
public final String getWritingApp()
```

Gets the full name of the application followed by the version number.

**Returns:**
java.lang.String - The full name of the application followed by the version number.
##### getScaledDuration()
```
public final Double getScaledDuration()
```

Gets the scaled duration of the SEGMENT in milliseconds.

**Returns:**
java.lang.Double - The scaled duration of the SEGMENT in milliseconds.

### MatroskaSimpleTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskasimpletag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSimpleTag extends MatroskaBasePackage
```

Represents general information about the target in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files

### MatroskaSubtitle
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskasubtitle.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSubtitle extends MatroskaBasePackage
```

Represents subtitle metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTimecode() | Gets the time code. |
| getDuration() | Gets the duration. |
| getText() | Gets the subtitle text. |
##### getTimecode()
```
public final double getTimecode()
```

Gets the time code.

**Returns:**
double - The time code.
##### getDuration()
```
public final double getDuration()
```

Gets the duration.

**Returns:**
double - The duration.
##### getText()
```
public final String getText()
```

Gets the subtitle text.

**Returns:**
java.lang.String - The subtitle text.

### MatroskaSubtitleTrack
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskasubtitletrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaSubtitleTrack extends MatroskaTrack
```

Represents subtitle metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSubtitles() | Gets the subtitles. |
##### getSubtitles()
```
public final MatroskaSubtitle[] getSubtitles()
```

Gets the subtitles.

**Returns:**
com.groupdocs.metadata.core.MatroskaSubtitle[] - The subtitles.

### MatroskaTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskatag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaTag extends MatroskaBasePackage
```

Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTargetTypeValue() | Gets the number to indicate the logical level of the target. |
| getTargetType() | Gets an informational string that can be used to display the logical level of the target. |
| getTagTrackUid() | Gets a unique ID to identify the Track(s) the tags belong to. |
| getSimpleTags() | Gets the general information about the target. |
##### getTargetTypeValue()
```
public final MatroskaTargetTypeValue getTargetTypeValue()
```

Gets the number to indicate the logical level of the target.

**Returns:**
MatroskaTargetTypeValue - The number to indicate the logical level of the target.
##### getTargetType()
```
public final String getTargetType()
```

Gets an informational string that can be used to display the logical level of the target. Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc.

**Returns:**
java.lang.String - An informational string that can be used to display the logical level of the target.
##### getTagTrackUid()
```
public final long getTagTrackUid()
```

Gets a unique ID to identify the Track(s) the tags belong to. If the value is 0 at this level, the tags apply to all tracks in the Segment.

**Returns:**
long - A unique ID to identify the Track(s) the tags belong to.
##### getSimpleTags()
```
public final MatroskaSimpleTag getSimpleTags()
```

Gets the general information about the target.

**Returns:**
MatroskaSimpleTag - The general information about the target.

### MatroskaTargetTypeValue
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskatargettypevalue.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaTargetTypeValue extends Enum<MatroskaTargetTypeValue> implements IEnumValue
```

Represents a number to indicate the logical level of the Matroska tag target.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined level. |
| Collection | COLLECTION level. |
| Edition | EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level. |
| Album | ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level. |
| Part | PART / SESSION level. |
| Track | TRACK / SONG / CHAPTER level. |
| Subtrack | SUBTRACK / PART / MOVEMENT / SCENE level. |
| Shot | SHOT level. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaTargetTypeValue Undefined
```

Undefined level.

##### Collection
```
public static final MatroskaTargetTypeValue Collection
```

COLLECTION level.

##### Edition
```
public static final MatroskaTargetTypeValue Edition
```

EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level.

##### Album
```
public static final MatroskaTargetTypeValue Album
```

ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level.

##### Part
```
public static final MatroskaTargetTypeValue Part
```

PART / SESSION level.

##### Track
```
public static final MatroskaTargetTypeValue Track
```

TRACK / SONG / CHAPTER level.

##### Subtrack
```
public static final MatroskaTargetTypeValue Subtrack
```

SUBTRACK / PART / MOVEMENT / SCENE level.

##### Shot
```
public static final MatroskaTargetTypeValue Shot
```

SHOT level.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaTargetTypeValue[]
##### valueOf(String name)
```
public static MatroskaTargetTypeValue valueOf(String name)
```

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

**Returns:**
MatroskaTargetTypeValue
##### getByRawValue(int rawValue)
```
public static MatroskaTargetTypeValue getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaTargetTypeValue
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaTrack
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskatrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaTrack extends MatroskaBasePackage
```

Represents track metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTrackNumber() | Gets the track number as used in the Block Header. |
| getTrackUid() | Gets the unique ID to identify the Track. |
| getTrackType() | Gets the type of the track. |
| getFlagEnabled() | Gets the enabled flag, true if the track is usable. |
| getDefaultDuration() | Gets the number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame. |
| getName() | Gets the human-readable track name. |
| getLanguage() | Gets the language of the track in the Matroska languages form. |
| getLanguageIetf() | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. |
| getCodecID() | Gets an ID corresponding to the codec. |
| getCodecName() | Gets a human-readable string specifying the codec. |
##### getTrackNumber()
```
public final long getTrackNumber()
```

Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number.

**Returns:**
long - The track number as used in the Block Header.
##### getTrackUid()
```
public final long getTrackUid()
```

Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file.

**Returns:**
long - The unique ID to identify the Track.
##### getTrackType()
```
public final MatroskaTrackType getTrackType()
```

Gets the type of the track.

**Returns:**
MatroskaTrackType - The type of the track.
##### getFlagEnabled()
```
public final boolean getFlagEnabled()
```

Gets the enabled flag, true if the track is usable.

**Returns:**
boolean - The enabled flag.
##### getDefaultDuration()
```
public final Long getDefaultDuration()
```

Gets the number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame.

**Returns:**
java.lang.Long - The number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame.

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### getName()
```
public final String getName()
```

Gets the human-readable track name.

**Returns:**
java.lang.String - The human-readable track name.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the  LanguageIetf  Element is used in the same TrackEntry.

**Returns:**
java.lang.String - The language of the track in the Matroska languages form.

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french), or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French). Country codes are the same as used for internet domains.
##### getLanguageIetf()
```
public final String getLanguageIetf()
```

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any  Language  Elements used in the same TrackEntry MUST be ignored.

**Returns:**
java.lang.String - The language of the track according to BCP 47 and using the IANA Language Subtag Registry.
##### getCodecID()
```
public final String getCodecID()
```

Gets an ID corresponding to the codec.

**Returns:**
java.lang.String - An ID corresponding to the codec.

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### getCodecName()
```
public final String getCodecName()
```

Gets a human-readable string specifying the codec.

**Returns:**
java.lang.String - A human-readable string specifying the codec.

### MatroskaTrackType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskatracktype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaTrackType extends Enum<MatroskaTrackType> implements IEnumValue
```

Represents Matroska track types coded in 8 bits.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined track type. |
| Video | Track is a video track. |
| Audio | Track is an audio track. |
| Complex | Track is a complex track, i.e. |
| Logo | Track is a logo track. |
| Subtitle | Track is a subtitle track. |
| Button | Track is a button track. |
| Control | Track is a control track. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaTrackType Undefined
```

The undefined track type.

##### Video
```
public static final MatroskaTrackType Video
```

Track is a video track.

##### Audio
```
public static final MatroskaTrackType Audio
```

Track is an audio track.

##### Complex
```
public static final MatroskaTrackType Complex
```

Track is a complex track, i.e. a combined video and audio track.

##### Logo
```
public static final MatroskaTrackType Logo
```

Track is a logo track.

##### Subtitle
```
public static final MatroskaTrackType Subtitle
```

Track is a subtitle track.

##### Button
```
public static final MatroskaTrackType Button
```

Track is a button track.

##### Control
```
public static final MatroskaTrackType Control
```

Track is a control track.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaTrackType[]
##### valueOf(String name)
```
public static MatroskaTrackType valueOf(String name)
```

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

**Returns:**
MatroskaTrackType
##### getByRawValue(int rawValue)
```
public static MatroskaTrackType getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaTrackType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoDisplayUnit
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskavideodisplayunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoDisplayUnit extends Enum<MatroskaVideoDisplayUnit> implements IEnumValue
```

Defines how Matroska DisplayWidth and DisplayHeight are interpreted.
#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels unit. |
| Centimeters | Centimeters unit. |
| Inches | Inches unit. |
| AspectRatio | Display aspect ratio unit. |
| Unknown | Unknown unit. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Pixels
```
public static final MatroskaVideoDisplayUnit Pixels
```

Pixels unit.

##### Centimeters
```
public static final MatroskaVideoDisplayUnit Centimeters
```

Centimeters unit.

##### Inches
```
public static final MatroskaVideoDisplayUnit Inches
```

Inches unit.

##### AspectRatio
```
public static final MatroskaVideoDisplayUnit AspectRatio
```

Display aspect ratio unit.

##### Unknown
```
public static final MatroskaVideoDisplayUnit Unknown
```

Unknown unit.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoDisplayUnit[]
##### valueOf(String name)
```
public static MatroskaVideoDisplayUnit valueOf(String name)
```

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

**Returns:**
MatroskaVideoDisplayUnit
##### getByRawValue(int rawValue)
```
public static MatroskaVideoDisplayUnit getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaVideoDisplayUnit
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoFieldOrder
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskavideofieldorder.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoFieldOrder extends Enum<MatroskaVideoFieldOrder> implements IEnumValue
```

Represents the field ordering of the Matroska video. If FlagInterlaced is not set to 1, this Element MUST be ignored.
#### Fields

| Field | Description |
| --- | --- |
| Progressive | Progressive ordering. |
| Tff | Tiff ordering. |
| Undetermined | Undetermined ordering. |
| Bff | Biff ordering. |
| BffSwapped | Bff (swapped) ordering. |
| TffSwapped | Tff (swapped) ordering. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Progressive
```
public static final MatroskaVideoFieldOrder Progressive
```

Progressive ordering.

##### Tff
```
public static final MatroskaVideoFieldOrder Tff
```

Tiff ordering.

##### Undetermined
```
public static final MatroskaVideoFieldOrder Undetermined
```

Undetermined ordering.

##### Bff
```
public static final MatroskaVideoFieldOrder Bff
```

Biff ordering.

##### BffSwapped
```
public static final MatroskaVideoFieldOrder BffSwapped
```

Bff (swapped) ordering.

##### TffSwapped
```
public static final MatroskaVideoFieldOrder TffSwapped
```

Tff (swapped) ordering.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoFieldOrder[]
##### valueOf(String name)
```
public static MatroskaVideoFieldOrder valueOf(String name)
```

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

**Returns:**
MatroskaVideoFieldOrder
##### getByRawValue(int rawValue)
```
public static MatroskaVideoFieldOrder getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaVideoFieldOrder
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoFlagInterlaced
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskavideoflaginterlaced.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoFlagInterlaced extends Enum<MatroskaVideoFlagInterlaced> implements IEnumValue
```

Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement.
#### Fields

| Field | Description |
| --- | --- |
| Undetermined | Undetermined flag. |
| Interlaced | Interlaced flag. |
| Progressive | Progressive flag. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undetermined
```
public static final MatroskaVideoFlagInterlaced Undetermined
```

Undetermined flag.

##### Interlaced
```
public static final MatroskaVideoFlagInterlaced Interlaced
```

Interlaced flag.

##### Progressive
```
public static final MatroskaVideoFlagInterlaced Progressive
```

Progressive flag.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoFlagInterlaced[]
##### valueOf(String name)
```
public static MatroskaVideoFlagInterlaced valueOf(String name)
```

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

**Returns:**
MatroskaVideoFlagInterlaced
##### getByRawValue(int rawValue)
```
public static MatroskaVideoFlagInterlaced getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaVideoFlagInterlaced
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoStereoMode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskavideostereomode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoStereoMode extends Enum<MatroskaVideoStereoMode> implements IEnumValue
```

Represents Matroska Stereo-3D video modes.
#### Fields

| Field | Description |
| --- | --- |
| Mono | Mono mode. |
| SideBySideLeft | Side by side (left eye first) video mode. |
| TopBottomRight | Top - bottom (right eye is first) video mode. |
| TopBottomLeft | Top - bottom (left eye is first) video mode. |
| CheckboardRight | Checkboard (right eye is first) video mode. |
| CheckboardLleft | Checkboard (left eye is first) video mode. |
| RowInterleavedRight | Row interleaved (right eye is first) video mode. |
| RowInterleavedLeft | Row interleaved (left eye is first) video mode. |
| ColumnInterleavedRight | Column interleaved (right eye is first) video mode. |
| ColumnInterleavedLeft | Column interleaved (left eye is first) video mode. |
| AnaglyphCyanRed | Anaglyph (cyan/red) video mode. |
| SideBySideRight | Side by side (right eye first) video mode. |
| AnaglyphGreenMagenta | Anaglyph (green/magenta) video mode. |
| BothEyesLacedLeft | Both eyes laced in one Block (left eye is first) video mode. |
| BothEyesLacedRight | Both eyes laced in one Block (right eye is first) video mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Mono
```
public static final MatroskaVideoStereoMode Mono
```

Mono mode.

##### SideBySideLeft
```
public static final MatroskaVideoStereoMode SideBySideLeft
```

Side by side (left eye first) video mode.

##### TopBottomRight
```
public static final MatroskaVideoStereoMode TopBottomRight
```

Top - bottom (right eye is first) video mode.

##### TopBottomLeft
```
public static final MatroskaVideoStereoMode TopBottomLeft
```

Top - bottom (left eye is first) video mode.

##### CheckboardRight
```
public static final MatroskaVideoStereoMode CheckboardRight
```

Checkboard (right eye is first) video mode.

##### CheckboardLleft
```
public static final MatroskaVideoStereoMode CheckboardLleft
```

Checkboard (left eye is first) video mode.

##### RowInterleavedRight
```
public static final MatroskaVideoStereoMode RowInterleavedRight
```

Row interleaved (right eye is first) video mode.

##### RowInterleavedLeft
```
public static final MatroskaVideoStereoMode RowInterleavedLeft
```

Row interleaved (left eye is first) video mode.

##### ColumnInterleavedRight
```
public static final MatroskaVideoStereoMode ColumnInterleavedRight
```

Column interleaved (right eye is first) video mode.

##### ColumnInterleavedLeft
```
public static final MatroskaVideoStereoMode ColumnInterleavedLeft
```

Column interleaved (left eye is first) video mode.

##### AnaglyphCyanRed
```
public static final MatroskaVideoStereoMode AnaglyphCyanRed
```

Anaglyph (cyan/red) video mode.

##### SideBySideRight
```
public static final MatroskaVideoStereoMode SideBySideRight
```

Side by side (right eye first) video mode.

##### AnaglyphGreenMagenta
```
public static final MatroskaVideoStereoMode AnaglyphGreenMagenta
```

Anaglyph (green/magenta) video mode.

##### BothEyesLacedLeft
```
public static final MatroskaVideoStereoMode BothEyesLacedLeft
```

Both eyes laced in one Block (left eye is first) video mode.

##### BothEyesLacedRight
```
public static final MatroskaVideoStereoMode BothEyesLacedRight
```

Both eyes laced in one Block (right eye is first) video mode.

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

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoStereoMode[]
##### valueOf(String name)
```
public static MatroskaVideoStereoMode valueOf(String name)
```

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

**Returns:**
MatroskaVideoStereoMode
##### getByRawValue(int rawValue)
```
public static MatroskaVideoStereoMode getByRawValue(int rawValue)
```

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

**Returns:**
MatroskaVideoStereoMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoTrack
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/matroskavideotrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaVideoTrack extends MatroskaTrack
```

Represents video metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getFlagInterlaced() | Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| getFieldOrder() | Gets declare the field ordering of the video. |
| getStereoMode() | Gets the stereo-3D video mode. |
| getAlphaMode() | Gets the alpha Video Mode. |
| getPixelWidth() | Gets the width of the encoded video frames in pixels. |
| getPixelHeight() | Gets the height of the encoded video frames in pixels. |
| getPixelCropBottom() | Gets the number of video pixels to remove at the bottom of the image. |
| getPixelCropTop() | Gets the number of video pixels to remove at the top of the image. |
| getPixelCropLeft() | Gets the number of video pixels to remove on the left of the image. |
| getPixelCropRight() | Gets the number of video pixels to remove on the right of the image. |
| getDisplayWidth() | Gets the width of the video frames to display. |
| getDisplayHeight() | Gets the height of the video frames to display. |
| getDisplayUnit() | Gets the how  DisplayWidth and  DisplayHeight  are interpreted. |
##### getFlagInterlaced()
```
public final MatroskaVideoFlagInterlaced getFlagInterlaced()
```

Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.

**Returns:**
MatroskaVideoFlagInterlaced - A flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.
##### getFieldOrder()
```
public final MatroskaVideoFieldOrder getFieldOrder()
```

Gets declare the field ordering of the video. If FlagInterlaced is not set to 1, this Element MUST be ignored.

**Returns:**
MatroskaVideoFieldOrder - Declare the field ordering of the video.
##### getStereoMode()
```
public final MatroskaVideoStereoMode getStereoMode()
```

Gets the stereo-3D video mode.

**Returns:**
MatroskaVideoStereoMode - The stereo-3D video mode.
##### getAlphaMode()
```
public final Long getAlphaMode()
```

Gets the alpha Video Mode. Presence of this Element indicates that the BlockAdditional Element could contain Alpha data.

Value: The alpha Video Mode.

**Returns:**
java.lang.Long
##### getPixelWidth()
```
public final long getPixelWidth()
```

Gets the width of the encoded video frames in pixels.

**Returns:**
long - The width of the encoded video frames in pixels.
##### getPixelHeight()
```
public final long getPixelHeight()
```

Gets the height of the encoded video frames in pixels.

**Returns:**
long - The height of the encoded video frames in pixels.
##### getPixelCropBottom()
```
public final long getPixelCropBottom()
```

Gets the number of video pixels to remove at the bottom of the image.

**Returns:**
long - The number of video pixels to remove at the bottom of the image.
##### getPixelCropTop()
```
public final long getPixelCropTop()
```

Gets the number of video pixels to remove at the top of the image.

**Returns:**
long - The number of video pixels to remove at the top of the image.
##### getPixelCropLeft()
```
public final long getPixelCropLeft()
```

Gets the number of video pixels to remove on the left of the image.

**Returns:**
long - The number of video pixels to remove on the left of the image.
##### getPixelCropRight()
```
public final long getPixelCropRight()
```

Gets the number of video pixels to remove on the right of the image.

**Returns:**
long - The number of video pixels to remove on the right of the image.
##### getDisplayWidth()
```
public final Long getDisplayWidth()
```

Gets the width of the video frames to display. Applies to the video frame after cropping (PixelCrop\* Elements).

**Returns:**
java.lang.Long - The width of the video frames to display.
##### getDisplayHeight()
```
public final Long getDisplayHeight()
```

Gets the height of the video frames to display. Applies to the video frame after cropping (PixelCrop\* Elements).

**Returns:**
java.lang.Long - The height of the video frames to display.
##### getDisplayUnit()
```
public final MatroskaVideoDisplayUnit getDisplayUnit()
```

Gets the how  DisplayWidth and  DisplayHeight  are interpreted.

**Returns:**
MatroskaVideoDisplayUnit - The how  DisplayWidth and  DisplayHeight  are interpreted.

### MetadataPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/metadatapackage.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class MetadataPackage implements Iterable<MetadataProperty>
```

Represents base abstraction for a metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getMetadataType() | Gets the metadata type. |
| getKeys() | Gets a collection of the metadata property names. |
| get_Item(String propertyName) | Gets the  MetadataProperty  with the specified name. |
| getPropertyDescriptors() | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| iterator() | Returns an enumerator that iterates through the collection. |
| contains(String propertyName) | Determines whether the package contains a metadata property with the specified name. |
| getCount() | Gets the number of metadata properties. |
| findProperties(Specification specification) | Finds the metadata properties satisfying a specification. |
| updateProperties(Specification specification, PropertyValue value) | Updates known metadata properties satisfying a specification. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| addProperties(Specification specification, PropertyValue value) | Adds known metadata properties satisfying the specification. |
| setProperties(Specification specification, PropertyValue value) | Sets known metadata properties satisfying the specification. |
| sanitize() | Removes writable metadata properties from the package. |
##### getMetadataType()
```
public final MetadataType getMetadataType()
```

Gets the metadata type.

**Returns:**
MetadataType - The type of the metadata package.
##### getKeys()
```
public final IReadOnlyList<String> getKeys()
```

Gets a collection of the metadata property names.

**Returns:**
IReadOnlyList - A collection of the metadata property names.
##### get_Item(String propertyName)
```
public final MetadataProperty get_Item(String propertyName)
```

Gets the  MetadataProperty  with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the metadata property to be found. Value: The appropriate  MetadataProperty . |

**Returns:**
MetadataProperty - The  MetadataProperty  if found; otherwise, null.
##### getPropertyDescriptors()
```
public final IReadOnlyList<PropertyDescriptor> getPropertyDescriptors()
```

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.

**Returns:**
IReadOnlyList - A collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### iterator()
```
public final Iterator<MetadataProperty> iterator()
```

Returns an enumerator that iterates through the collection.

**Returns:**
java.util.Iterator<com.groupdocs.metadata.core.MetadataProperty> - An enumerator that can be used to iterate through the collection.
##### contains(String propertyName)
```
public final boolean contains(String propertyName)
```

Determines whether the package contains a metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the property to locate in the package. |

**Returns:**
boolean - True if the package contains a property with the specified name; otherwise, false.
##### getCount()
```
public final int getCount()
```

Gets the number of metadata properties.

**Returns:**
int - The number or metadata properties.
##### findProperties(Specification specification)
```
public IReadOnlyList<MetadataProperty> findProperties(Specification specification)
```

Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A function to test each metadata property for a condition.

This example demonstrates how to search for specific metadata properties using tags.

> ```
> ```
>
>  // Constants.InputPptx is an absolute or relative path to your document. Ex: @"C:\Docs\source.pptx"
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      // Fetch all the properties satisfying the predicate:
>      // property contains the name of the last document editor OR the date/time the document was last modified
>      IReadOnlyList properties = metadata.findProperties(
>              new ContainsTagSpecification(Tags.getPerson().getEditor()).or(new ContainsTagSpecification(Tags.getTime().getModified())));
>      for (MetadataProperty property : properties) {
>          System.out.println(String.format("Property name: %s, Property value: %s", property.getName(), property.getValue()));
>      }
>  }
>
> ```
> ```

[Extracting metadata]: https://docs.groupdocs.com/display/metadatajava/Extracting+metadata |

**Returns:**
IReadOnlyList - A collection that contains properties from the package that satisfy the condition.
##### updateProperties(Specification specification, PropertyValue value)
```
public int updateProperties(Specification specification, PropertyValue value)
```

Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

This example demonstrates how to update existing metadata properties by various criteria regardless of the file format.

> ```
> ```
>
>  public class UpdatingMetadata {
>      public static void run() {
>          Date threeDaysAgo = new Date(System.currentTimeMillis() - TimeUnit.DAYS.toMillis(3));
>          File folder = new File(Constants.InputPath);
>          for (File file : folder.listFiles()) {
>              try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>                  if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>                      System.out.println();
>                      System.out.println(file.getName());
>                      // Update the file creation date/time if the existing value is older than 3 days
>                      int affected = metadata.updateProperties(new ContainsTagSpecification(Tags.getTime().getCreated()).and(
>                              new OfTypeSpecification(MetadataPropertyType.DateTime)).and(
>                              new UpdatingMetadata().new DateBeforeSpecification(threeDaysAgo)), new PropertyValue(new Date()));
>                      System.out.println(String.format("Affected properties: %s", affected));
>                      metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>                  }
>              }
>          }
>      }
>      // Define your own specifications to filter metadata properties
>      public class DateBeforeSpecification extends Specification {
>          public DateBeforeSpecification(Date date) {
>              setValue(date);
>          }
>
>          public final Date getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Date value) {
>              auto_Value = value;
>          }
>
>          private Date auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              Date date = candidate.getValue().toClass(Date.class);
>              if (date != null) {
>                  return date.before(getValue());
>              }
>              return false;
>          }
>      }
>  }
>
> ```
> ```

[Updating metadata]: https://docs.groupdocs.com/display/metadatajava/Updating+metadata |

**Returns:**
int - The number of affected properties.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition.

This example demonstrates how to remove specific metadata properties using various criteria.

> ```
> ```
>
>  public class RemoveMetadataProperties {
>      public static void run() {
>          // Constants.InputDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>          try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>
>              // Remove all the properties satisfying the predicate:
>              // property contains the name of the document author OR
>              // it refers to the last editor OR
>              // the property value is a string that is equal to the given string "John" (to remove any mentions of John from the detected metadata)
>              int affected = metadata.removeProperties(
>                      new ContainsTagSpecification(Tags.getPerson().getCreator()).or(
>                              new ContainsTagSpecification(Tags.getPerson().getEditor())).or(
>                              new OfTypeSpecification(MetadataPropertyType.String).and(new RemoveMetadataProperties().new WithValueSpecification("John"))));
>
>              System.out.println(String.format("Properties removed: %s", affected));
>
>              metadata.save(Constants.OutputDocx);
>          }
>      }
>
>      // Define your own specifications to filter metadata properties
>      public class WithValueSpecification extends Specification {
>          public WithValueSpecification(Object value) {
>              setValue(value);
>          }
>
>          public final Object getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Object value) {
>              auto_Value = value;
>          }
>
>          private Object auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              return candidate.getValue().getRawValue().equals(getValue());
>          }
>      }
>  }
>
> ```
> ```

[Removing metadata]: https://docs.groupdocs.com/display/metadatajava/Removing+metadata |

**Returns:**
int - The number of affected properties.
##### addProperties(Specification specification, PropertyValue value)
```
public int addProperties(Specification specification, PropertyValue value)
```

Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties.

This example demonstrates how to add some missing metadata properties to a file regardless of its format.

> ```
> ```
>
>  File folder = new File(Constants.InputPath);
>  for (File file : folder.listFiles()) {
>      try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>          if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>              System.out.println();
>              System.out.println(file.getName());
>              // Add a property containing the file last printing date if it's missing
>              // Note that the property will be added to metadata packages that satisfy the following criteria:
>              // 1) Only existing metadata packages will be affected. No new packages are added during this operation
>              // 2) There should be a known metadata property in the package structure that fits the search condition but is actually missing in the package.
>              // All properties supported by a certain package are usually defined in the specification of a particular metadata standard
>              int affected = metadata.addProperties(new ContainsTagSpecification(Tags.getTime().getPrinted()), new PropertyValue(new Date()));
>              System.out.println(String.format("Affected properties: %s", affected));
>              metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>          }
>      }
>  }
>
> ```
> ```

[Adding metadata]: https://docs.groupdocs.com/display/metadatajava/Adding+metadata |

**Returns:**
int - The number of affected properties.
##### setProperties(Specification specification, PropertyValue value)
```
public int setProperties(Specification specification, PropertyValue value)
```

Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of  AddProperties  and  UpdateProperties . If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

This example demonstrates how to set specific metadata properties using different criteria.

> ```
> ```
>
>  // Constants.InputVsdx is an absolute or relative path to your document. Ex: @"C:\Docs\source.vsdx"
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      // Set the value of each property that satisfies the predicate:
>      // property contains the date/time the document was created OR modified
>      int affected = metadata.setProperties(
>              new ContainsTagSpecification(Tags.getTime().getCreated()).or(new ContainsTagSpecification(Tags.getTime().getModified())),
>              new PropertyValue(new Date()));
>      System.out.println(String.format("Properties set: %s", affected));
>      metadata.save(Constants.OutputVsdx);
>  }
>
> ```
> ```

[Set metadata properties]: https://docs.groupdocs.com/display/metadatajava/Set+metadata+properties |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

This example demonstrates how to remove all detected metadata packages/properties from a file.

> ```
> ```
>
>  // Constants.InputPdf is an absolute or relative path to your document. Ex: @"C:\Docs\source.pdf"
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      // Remove detected metadata packages
>      int affected = metadata.sanitize();
>      System.out.println(String.format("Properties removed: %s", affected));
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata

### MetadataProperty
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/metadataproperty.md

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

Represents a metadata property.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataProperty(String name, PropertyValue value) | Initializes a new instance of the  MetadataProperty  class. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getValue() | Gets the property value. |
| getInterpretedValue() | Gets the interpreted property value, if available. |
| getDescriptor() | Gets the descriptor associated with the metadata property. |
| getTags() | Gets a collection of tags associated with the property. |
##### MetadataProperty(String name, PropertyValue value)
```
public MetadataProperty(String name, PropertyValue value)
```

Initializes a new instance of the  MetadataProperty  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the metadata property. |
| value | PropertyValue | The value of the metadata property. |

##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getValue()
```
public final PropertyValue getValue()
```

Gets the property value.

**Returns:**
PropertyValue - The property value.
##### getInterpretedValue()
```
public final PropertyValue getInterpretedValue()
```

Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc.

**Returns:**
PropertyValue - The interpreted property value, if available.
##### getDescriptor()
```
public final PropertyDescriptor getDescriptor()
```

Gets the descriptor associated with the metadata property.

**Returns:**
PropertyDescriptor - The descriptor associated with the metadata property.
##### getTags()
```
public final IReadOnlyList<PropertyTag> getTags()
```

Gets a collection of tags associated with the property.

**Returns:**
IReadOnlyList - A collection of tags associated with the property.

### MetadataPropertyType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/metadatapropertytype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MetadataPropertyType extends Enum<MetadataPropertyType> implements IEnumValue
```

Defines metadata property types.
#### Fields

| Field | Description |
| --- | --- |
| Empty | Represents an empty (null) property. |
| String | Represents a string property. |
| Boolean | Represents a boolean property. |
| DateTime | Represents a date property. |
| TimeSpan | Represents a time property. |
| Integer | Represents an integer property. |
| Long | Represents a long integer property. |
| Double | Represents a property with a double or float value. |
| StringArray | Represents a string array property. |
| ByteArray | Represents a byte array property. |
| DoubleArray | Represents an array of double values. |
| IntegerArray | Represents an array of integer values. |
| LongArray | Represents an array of long values. |
| Metadata | Represents a nested metadata block. |
| MetadataArray | Represents an array of nested metadata blocks. |
| Guid | Represents a global unique identifier value. |
| PropertyValueArray | Represents a metadata property value array. |
| Object | Represents a generic object property. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Empty
```
public static final MetadataPropertyType Empty
```

Represents an empty (null) property.

##### String
```
public static final MetadataPropertyType String
```

Represents a string property.

##### Boolean
```
public static final MetadataPropertyType Boolean
```

Represents a boolean property.

##### DateTime
```
public static final MetadataPropertyType DateTime
```

Represents a date property.

##### TimeSpan
```
public static final MetadataPropertyType TimeSpan
```

Represents a time property.

##### Integer
```
public static final MetadataPropertyType Integer
```

Represents an integer property.

##### Long
```
public static final MetadataPropertyType Long
```

Represents a long integer property.

##### Double
```
public static final MetadataPropertyType Double
```

Represents a property with a double or float value.

##### StringArray
```
public static final MetadataPropertyType StringArray
```

Represents a string array property.

##### ByteArray
```
public static final MetadataPropertyType ByteArray
```

Represents a byte array property.

##### DoubleArray
```
public static final MetadataPropertyType DoubleArray
```

Represents an array of double values.

##### IntegerArray
```
public static final MetadataPropertyType IntegerArray
```

Represents an array of integer values.

##### LongArray
```
public static final MetadataPropertyType LongArray
```

Represents an array of long values.

##### Metadata
```
public static final MetadataPropertyType Metadata
```

Represents a nested metadata block.

##### MetadataArray
```
public static final MetadataPropertyType MetadataArray
```

Represents an array of nested metadata blocks.

##### Guid
```
public static final MetadataPropertyType Guid
```

Represents a global unique identifier value.

##### PropertyValueArray
```
public static final MetadataPropertyType PropertyValueArray
```

Represents a metadata property value array.

##### Object
```
public static final MetadataPropertyType Object
```

Represents a generic object property.

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

**Returns:**
com.groupdocs.metadata.core.MetadataPropertyType[]
##### valueOf(String name)
```
public static MetadataPropertyType valueOf(String name)
```

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

**Returns:**
MetadataPropertyType
##### getByRawValue(int rawValue)
```
public static MetadataPropertyType getByRawValue(int rawValue)
```

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

**Returns:**
MetadataPropertyType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MetadataType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/metadatatype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MetadataType extends Enum<MetadataType> implements IEnumValue
```

Specifies the type of a metadata package.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The type of a metadata package is undefined. |
| Root | A root metadata package containing other format-specific packages. |
| Xmp | An XMP metadata package. |
| Exif | An EXIF metadata package, |
| Iptc | An IPTC metadata package, |
| DublinCore | A Dublin Core metadata package. |
| ImageResourceBlock | A Photoshop's native metadata package. |
| FileFormat | A package containing information about the format of a loaded file. |
| DigitalSignature | A package containing digital signature metadata. |
| Presentation | A presentation metadata package. |
| Spreadsheet | A spreadsheet metadata package. |
| WordProcessing | A word processing metadata package. |
| Diagram | A diagram metadata package. |
| Note | A metadata package containing information about an electronic note file. |
| ProjectManagement | A metadata package containing information about a project management file. |
| Pdf | A PDF metadata package. |
| DocumentStatistics | A package containing document statistics. |
| Psd | A metadata package containing information about a Photoshop document. |
| Jpeg2000 | A JPEG2000 native metadata package. |
| Dicom | A DICOM native metadata package. |
| Bmp | A BMP native metadata package. |
| Wav | A WAV native metadata package. |
| ID3V1 | An ID3V1 tag. |
| ID3V2 | An ID3V2 tag. |
| MpegAudio | An MPEG audio native metadata package. |
| Lyrics3 | A Lyrics3 metadata package. |
| ApeV2 | An APEv2 metadata package. |
| Avi | An AVI video native metadata package. |
| Flv | An FLV video native metadata package. |
| Asf | An ASF video native metadata package. |
| Mov | A QuickTime video. |
| Matroska | A native metadata package extracted from a video encoded with the Matroska multimedia container. |
| Zip | A native metadata package of a ZIP archive. |
| SevenZip | A native metadata package of a SevenZip archive. |
| VCard | A native metadata package of a VCard. |
| Epub | A native metadata package of a EPUB e-book. |
| OpenType | An OpenType font metadata package. |
| Cad | A metadata package extracted from a CAD drawing. |
| Eml | An EML message metadata package. |
| Msg | An MSG message metadata package. |
| Torrent | A torrent file metadata package. |
| Png | A PNG image metadata package. |
| Dng | A DNG image metadata package. |
| Cr2 | A CR2 image metadata package. |
| Rar | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
| ThreeDS | 3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software. |
| Dae | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. |
| Fbx | FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. |
| Stl | STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems\\u2019 founder, reports that the file extension is an abbreviation for stereolithography. |
| Gltf | A glTF (GL Transmission Format) metadata package. |
| Svg | An SVG image metadata package. |
| Gis | Gis format |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MetadataType Undefined
```

The type of a metadata package is undefined.

##### Root
```
public static final MetadataType Root
```

A root metadata package containing other format-specific packages.

##### Xmp
```
public static final MetadataType Xmp
```

An XMP metadata package.

##### Exif
```
public static final MetadataType Exif
```

An EXIF metadata package,

##### Iptc
```
public static final MetadataType Iptc
```

An IPTC metadata package,

##### DublinCore
```
public static final MetadataType DublinCore
```

A Dublin Core metadata package.

##### ImageResourceBlock
```
public static final MetadataType ImageResourceBlock
```

A Photoshop's native metadata package.

##### FileFormat
```
public static final MetadataType FileFormat
```

A package containing information about the format of a loaded file.

##### DigitalSignature
```
public static final MetadataType DigitalSignature
```

A package containing digital signature metadata.

##### Presentation
```
public static final MetadataType Presentation
```

A presentation metadata package.

##### Spreadsheet
```
public static final MetadataType Spreadsheet
```

A spreadsheet metadata package.

##### WordProcessing
```
public static final MetadataType WordProcessing
```

A word processing metadata package.

##### Diagram
```
public static final MetadataType Diagram
```

A diagram metadata package.

##### Note
```
public static final MetadataType Note
```

A metadata package containing information about an electronic note file.

##### ProjectManagement
```
public static final MetadataType ProjectManagement
```

A metadata package containing information about a project management file.

##### Pdf
```
public static final MetadataType Pdf
```

A PDF metadata package.

##### DocumentStatistics
```
public static final MetadataType DocumentStatistics
```

A package containing document statistics.

##### Psd
```
public static final MetadataType Psd
```

A metadata package containing information about a Photoshop document.

##### Jpeg2000
```
public static final MetadataType Jpeg2000
```

A JPEG2000 native metadata package.

##### Dicom
```
public static final MetadataType Dicom
```

A DICOM native metadata package.

##### Bmp
```
public static final MetadataType Bmp
```

A BMP native metadata package.

##### Wav
```
public static final MetadataType Wav
```

A WAV native metadata package.

##### ID3V1
```
public static final MetadataType ID3V1
```

An ID3V1 tag.

##### ID3V2
```
public static final MetadataType ID3V2
```

An ID3V2 tag.

##### MpegAudio
```
public static final MetadataType MpegAudio
```

An MPEG audio native metadata package.

##### Lyrics3
```
public static final MetadataType Lyrics3
```

A Lyrics3 metadata package.

##### ApeV2
```
public static final MetadataType ApeV2
```

An APEv2 metadata package.

##### Avi
```
public static final MetadataType Avi
```

An AVI video native metadata package.

##### Flv
```
public static final MetadataType Flv
```

An FLV video native metadata package.

##### Asf
```
public static final MetadataType Asf
```

An ASF video native metadata package.

##### Mov
```
public static final MetadataType Mov
```

A QuickTime video.

##### Matroska
```
public static final MetadataType Matroska
```

A native metadata package extracted from a video encoded with the Matroska multimedia container.

##### Zip
```
public static final MetadataType Zip
```

A native metadata package of a ZIP archive.

##### SevenZip
```
public static final MetadataType SevenZip
```

A native metadata package of a SevenZip archive.

##### VCard
```
public static final MetadataType VCard
```

A native metadata package of a VCard.

##### Epub
```
public static final MetadataType Epub
```

A native metadata package of a EPUB e-book.

##### OpenType
```
public static final MetadataType OpenType
```

An OpenType font metadata package.

##### Cad
```
public static final MetadataType Cad
```

A metadata package extracted from a CAD drawing.

##### Eml
```
public static final MetadataType Eml
```

An EML message metadata package.

##### Msg
```
public static final MetadataType Msg
```

An MSG message metadata package.

##### Torrent
```
public static final MetadataType Torrent
```

A torrent file metadata package. Please find more information at  [https://en.wikipedia.org/wiki/Torrent\_file/][https_en.wikipedia.org_wiki_Torrent_file] .

[https_en.wikipedia.org_wiki_Torrent_file]: https://en.wikipedia.org/wiki/Torrent_file/

##### Png
```
public static final MetadataType Png
```

A PNG image metadata package.

##### Dng
```
public static final MetadataType Dng
```

A DNG image metadata package.

##### Cr2
```
public static final MetadataType Cr2
```

A CR2 image metadata package.

##### Rar
```
public static final MetadataType Rar
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.

##### Tar
```
public static final MetadataType Tar
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.

##### ThreeDS
```
public static final MetadataType ThreeDS
```

3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software.

##### Dae
```
public static final MetadataType Dae
```

A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications.

##### Fbx
```
public static final MetadataType Fbx
```

FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware.

##### Stl
```
public static final MetadataType Stl
```

STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems\\u2019 founder, reports that the file extension is an abbreviation for stereolithography.

##### Gltf
```
public static final MetadataType Gltf
```

A glTF (GL Transmission Format) metadata package.

##### Svg
```
public static final MetadataType Svg
```

An SVG image metadata package.

##### Gis
```
public static final MetadataType Gis
```

Gis format

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

**Returns:**
com.groupdocs.metadata.core.MetadataType[]
##### valueOf(String name)
```
public static MetadataType valueOf(String name)
```

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

**Returns:**
MetadataType
##### getByRawValue(int rawValue)
```
public static MetadataType getByRawValue(int rawValue)
```

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

**Returns:**
MetadataType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MetadataValidationException
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/metadatavalidationexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class MetadataValidationException extends GroupDocsMetadataException
```

The exception that is thrown when validation errors encountered during metadata saving.
#### Methods

| Method | Description |
| --- | --- |
| getErrors() | Gets an array of the validation errors that were encountered during the last metadata saving. |
##### getErrors()
```
public final String[] getErrors()
```

Gets an array of the validation errors that were encountered during the last metadata saving.

**Returns:**
java.lang.String[] - An array of the validation errors that were encountered during the last metadata saving.

### MovAtom
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/movatom.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IIsoMediaBox
```
public final class MovAtom extends CustomPackage implements IIsoMediaBox
```

Represents a QuickTime atom.

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
#### Methods

| Method | Description |
| --- | --- |
| getOffset() | Gets the atom offset. |
| getSize() | Gets the atom size in bytes. |
| getLongSize() | Gets the atom size in bytes. |
| getType() | Gets the 4-characters type. |
| getDataOffset() | Gets the data offset. |
| getDataSize() | Gets the data size in bytes. |
| hasExtendedSize() | Gets a value indicating whether the extended size field was used to store the atom data. |
| getAtoms() | Gets an array of MovAtom atoms. |
##### getOffset()
```
public final long getOffset()
```

Gets the atom offset.

**Returns:**
long - The atom offset.
##### getSize()
```
public final int getSize()
```

Gets the atom size in bytes.

**Returns:**
int - The atom size.
##### getLongSize()
```
public final long getLongSize()
```

Gets the atom size in bytes.

**Returns:**
long - The atom size.
##### getType()
```
public final String getType()
```

Gets the 4-characters type.

**Returns:**
java.lang.String - The type.
##### getDataOffset()
```
public final long getDataOffset()
```

Gets the data offset.

**Returns:**
long - The data offset.
##### getDataSize()
```
public final int getDataSize()
```

Gets the data size in bytes.

**Returns:**
int - The data size.
##### hasExtendedSize()
```
public final boolean hasExtendedSize()
```

Gets a value indicating whether the extended size field was used to store the atom data.

**Returns:**
boolean - True, if the extended size field was used to store the atom data; otherwise, false.
##### getAtoms()
```
public final MovAtom[] getAtoms()
```

Gets an array of MovAtom atoms.

Value: The QuickTime atoms.

**Returns:**
com.groupdocs.metadata.core.MovAtom[]

### MovPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/movpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class MovPackage extends CustomPackage
```

Represents QuickTime metadata.

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
#### Methods

| Method | Description |
| --- | --- |
| getDirector() | Name of the director of the movie content. |
| getDescription() | Description of the movie file content. |
| getLocationMotion() | An indication of the direction the camera is moving during the shot. |
| getLocationFacing() | An indication of the direction the camera is facing during the shot. |
| getLocationDate() | A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format. |
| getLocationRole() | A single byte, binary value containing a value from the set: 0 indicates \\u201cshooting location\\u201d, 1 indicates \\u201creal location\\u201d, 2 indicates \\u201cfictional location\\u201d. |
| getLocationNote() | Descriptive comment. |
| getLocationBody() | The astronomical body, for compatibility with the 3GPP format |
| getLocationName() | Name of the location. |
| getUserRatings() | A number, assigned by the user, that indicates the rating or relative value of the movie. |
| getUsers() | A name indicating a user-defined collection that includes this movie. |
| getYear() | Year when the movie file or the original content was created or recorded. |
| getSoftware() | Name of software used to create the movie file content. |
| getProducer() | Name of producer of movie file content. |
| getAlbum() | Album or collection name of which the movie content forms a part |
| getKeywords() | Keywords associated with the movie file content. |
| getInformation() | Information about the movie file content. |
| getGenre() | Text describing the genre or genres to which the movie content conforms. |
| getTitle() | The title of the movie file content. |
| getCreationDate() | The date the movie file content was created. |
| getCopyright() | Copyright statement for the movie file content. |
| getComment() | User entered comment regarding the movie file content. |
| getAuthor() | Name of the author of the movie file content. |
| getArtwork() | A single image that can represent the movie file content. |
| getArtist() | Name of the artist who created the movie file content. |
| getPublisher() | Name of publisher of movie file content. |
| getMovieCreationTime() | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| setMovieCreationTime(System.DateTime value) | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| getMovieModificationTime() | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| setMovieModificationTime(System.DateTime value) | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| getMovieDuration() | A time value that indicates the duration of the movie in seconds. |
| getAtoms() | Gets an array of MovAtom atoms. |
##### getDirector()
```
public final String getDirector()
```

Name of the director of the movie content.

Value: The Director.

**Returns:**
java.lang.String
##### getDescription()
```
public final String getDescription()
```

Description of the movie file content.

Value: The Description.

**Returns:**
java.lang.String
##### getLocationMotion()
```
public final String getLocationMotion()
```

An indication of the direction the camera is moving during the shot.

Value: The LocationMotion.

**Returns:**
java.lang.String
##### getLocationFacing()
```
public final String getLocationFacing()
```

An indication of the direction the camera is facing during the shot.

Value: The LocationFacing.

**Returns:**
java.lang.String
##### getLocationDate()
```
public final String getLocationDate()
```

A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format.

Value: The LocationDate.

**Returns:**
java.lang.String
##### getLocationRole()
```
public final String getLocationRole()
```

A single byte, binary value containing a value from the set: 0 indicates \\u201cshooting location\\u201d, 1 indicates \\u201creal location\\u201d, 2 indicates \\u201cfictional location\\u201d. Other values are reserved.

Value: The LocationRole.

**Returns:**
java.lang.String
##### getLocationNote()
```
public final String getLocationNote()
```

Descriptive comment.

Value: The LocationNote.

**Returns:**
java.lang.String
##### getLocationBody()
```
public final String getLocationBody()
```

The astronomical body, for compatibility with the 3GPP format

Value: The LocationBody.

**Returns:**
java.lang.String
##### getLocationName()
```
public final String getLocationName()
```

Name of the location.

Value: The LocationName.

**Returns:**
java.lang.String
##### getUserRatings()
```
public final String getUserRatings()
```

A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.

Value: The UserRatings.

**Returns:**
java.lang.String
##### getUsers()
```
public final String getUsers()
```

A name indicating a user-defined collection that includes this movie.

Value: The Users.

**Returns:**
java.lang.String
##### getYear()
```
public final String getYear()
```

Year when the movie file or the original content was created or recorded.

Value: The Year.

**Returns:**
java.lang.String
##### getSoftware()
```
public final String getSoftware()
```

Name of software used to create the movie file content.

Value: The Software.

**Returns:**
java.lang.String
##### getProducer()
```
public final String getProducer()
```

Name of producer of movie file content.

Value: The Producer.

**Returns:**
java.lang.String
##### getAlbum()
```
public final String getAlbum()
```

Album or collection name of which the movie content forms a part

Value: The Album.

**Returns:**
java.lang.String
##### getKeywords()
```
public final String getKeywords()
```

Keywords associated with the movie file content.

Value: The Keywords.

**Returns:**
java.lang.String
##### getInformation()
```
public final String getInformation()
```

Information about the movie file content.

Value: The Information.

**Returns:**
java.lang.String
##### getGenre()
```
public final String getGenre()
```

Text describing the genre or genres to which the movie content conforms.

Value: The Genre.

**Returns:**
java.lang.String
##### getTitle()
```
public final String getTitle()
```

The title of the movie file content.

Value: The Title.

**Returns:**
java.lang.String
##### getCreationDate()
```
public final String getCreationDate()
```

The date the movie file content was created.

Value: The CreationDate.

**Returns:**
java.lang.String
##### getCopyright()
```
public final String getCopyright()
```

Copyright statement for the movie file content.

Value: The Copyright.

**Returns:**
java.lang.String
##### getComment()
```
public final String getComment()
```

User entered comment regarding the movie file content.

Value: The Comment.

**Returns:**
java.lang.String
##### getAuthor()
```
public final String getAuthor()
```

Name of the author of the movie file content.

Value: The Author.

**Returns:**
java.lang.String
##### getArtwork()
```
public final String getArtwork()
```

A single image that can represent the movie file content.

Value: The Artwork.

**Returns:**
java.lang.String
##### getArtist()
```
public final String getArtist()
```

Name of the artist who created the movie file content.

Value: The Artist.

**Returns:**
java.lang.String
##### getPublisher()
```
public final String getPublisher()
```

Name of publisher of movie file content.

Value: The Publisher.

**Returns:**
java.lang.String
##### getMovieCreationTime()
```
public final System.DateTime getMovieCreationTime()
```

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

Value: A 32-bit integer that specifies the creation calendar date and time for the movie atom.

**Returns:**
com.aspose.ms.System.DateTime
##### setMovieCreationTime(System.DateTime value)
```
public final void setMovieCreationTime(System.DateTime value)
```

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

Value: A 32-bit integer that specifies the creation calendar date and time for the movie atom.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.DateTime |  |

##### getMovieModificationTime()
```
public final System.DateTime getMovieModificationTime()
```

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

Value: A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

**Returns:**
com.aspose.ms.System.DateTime
##### setMovieModificationTime(System.DateTime value)
```
public final void setMovieModificationTime(System.DateTime value)
```

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

Value: A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.DateTime |  |

##### getMovieDuration()
```
public final long getMovieDuration()
```

A time value that indicates the duration of the movie in seconds.

Value: A time value that indicates the duration of the movie in seconds.

**Returns:**
long
##### getAtoms()
```
public final MovAtom[] getAtoms()
```

Gets an array of MovAtom atoms.

Value: The QuickTime atoms.

**Returns:**
com.groupdocs.metadata.core.MovAtom[]

### MovRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/movrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class MovRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in a QuickTime video.

This example shows how to read QuickTime atoms in a MOV video.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMov)) {
>      MovRootPackage root = metadata.getRootPackageGeneric();
>      for (MovAtom atom : root.getMovPackage().getAtoms()) {
>          System.out.println(atom.getType());
>          System.out.println(atom.getOffset());
>          System.out.println(atom.getSize());
>          // ...
>      }
>  }
>
> ```
> ```

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getMovPackage() | Gets the QuickTime metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
##### getMovPackage()
```
public final MovPackage getMovPackage()
```

Gets the QuickTime metadata package.

**Returns:**
MovPackage - The QuickTime metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

### MP3RootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/mp3rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class MP3RootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an MP3 audio.

[Working with MP3 metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+MP3+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getMpegAudioPackage() | Gets the MPEG audio metadata package. |
| getID3V1() | Gets the ID3v1 metadata tag. |
| setID3V1(ID3V1Tag value) | Sets the ID3v1 metadata tag. |
| getID3V2() | Gets the ID3v2 metadata tag. |
| setID3V2(ID3V2Tag value) | Sets the ID3v2 metadata tag. |
| getLyrics3V2() | Gets the Lyrics3v2 metadata tag. |
| setLyrics3V2(LyricsTag value) | Sets the Lyrics3v2 metadata tag. |
| getApeV2() | Gets the APE v2 metadata. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| removeApeV2() | Removes the APEv2 audio tag. |
| sanitize() | Removes writable metadata properties from the package. |
| copyTo(MetadataPackage metadata) |  |
##### getMpegAudioPackage()
```
public final MpegAudioPackage getMpegAudioPackage()
```

Gets the MPEG audio metadata package.

**Returns:**
MpegAudioPackage - The MPEG audio metadata package.
##### getID3V1()
```
public final ID3V1Tag getID3V1()
```

Gets the ID3v1 metadata tag. Please find more information at  http://id3.org/ID3v1 .

**Returns:**
ID3V1Tag - The ID3v1 metadata tag attached to the audio file.

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file.
##### setID3V1(ID3V1Tag value)
```
public final void setID3V1(ID3V1Tag value)
```

Sets the ID3v1 metadata tag. Please find more information at  http://id3.org/ID3v1 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V1Tag | The ID3v1 metadata tag attached to the audio file.

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file. |

##### getID3V2()
```
public final ID3V2Tag getID3V2()
```

Gets the ID3v2 metadata tag.

**Returns:**
ID3V2Tag - The ID3v2 metadata tag attached to the audio file.
##### setID3V2(ID3V2Tag value)
```
public final void setID3V2(ID3V2Tag value)
```

Sets the ID3v2 metadata tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2Tag | The ID3v2 metadata tag attached to the audio file. |

##### getLyrics3V2()
```
public final LyricsTag getLyrics3V2()
```

Gets the Lyrics3v2 metadata tag.

**Returns:**
LyricsTag - The Lyrics3v2 metadata tag.
##### setLyrics3V2(LyricsTag value)
```
public final void setLyrics3V2(LyricsTag value)
```

Sets the Lyrics3v2 metadata tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | LyricsTag | The Lyrics3v2 metadata tag. |

##### getApeV2()
```
public final ApePackage getApeV2()
```

Gets the APE v2 metadata.

**Returns:**
ApePackage - The APE v2 metadata.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### removeApeV2()
```
public final void removeApeV2()
```

Removes the APEv2 audio tag.

This feature is not available in trial mode.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.
##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### MpegAudioPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/mpegaudiopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class MpegAudioPackage extends CustomPackage
```

Represents MPEG audio metadata.

This example demonstrates how to read MPEG audio metadata from an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V2)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getMpegAudioPackage().getBitrate());
>      System.out.println(root.getMpegAudioPackage().getChannelMode());
>      System.out.println(root.getMpegAudioPackage().getEmphasis());
>      System.out.println(root.getMpegAudioPackage().getFrequency());
>      System.out.println(root.getMpegAudioPackage().getHeaderPosition());
>      System.out.println(root.getMpegAudioPackage().getLayer());
>      // ...
>  }
>
> ```
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| MpegAudioPackage() | Initializes a new instance of the  MpegAudioPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMpegAudioVersion() | Gets the MPEG audio version. |
| getLayer() | Gets the layer description. |
| isProtected() | Gets  true  if protected. |
| getHeaderPosition() | Gets the header offset. |
| getBitrate() | Gets the bitrate. |
| getFrequency() | Gets the frequency. |
| getPaddingBit() | Gets the padding bit. |
| getPrivateBit() | Gets a value indicating whether [private bit]. |
| getChannelMode() | Gets the channel mode. |
| getCopyright() | Gets the copyright bit. |
| isOriginal() | Gets the original bit. |
| getEmphasis() | Gets the emphasis. |
| getModeExtensionBits() | Gets the mode extension bits. |
##### MpegAudioPackage()
```
public MpegAudioPackage()
```

Initializes a new instance of the  MpegAudioPackage  class.

##### getMpegAudioVersion()
```
public final MpegAudioVersion getMpegAudioVersion()
```

Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc.

**Returns:**
MpegAudioVersion - The MPEG audio version.
##### getLayer()
```
public final int getLayer()
```

Gets the layer description. For an MP3 audio it is '3'.

**Returns:**
int - The layer description.
##### isProtected()
```
public final boolean isProtected()
```

Gets  true  if protected.

**Returns:**
boolean -  true  if is protected; otherwise,  false .
##### getHeaderPosition()
```
public final long getHeaderPosition()
```

Gets the header offset.

**Returns:**
long - The header offset.
##### getBitrate()
```
public final int getBitrate()
```

Gets the bitrate.

**Returns:**
int - The bitrate.
##### getFrequency()
```
public final int getFrequency()
```

Gets the frequency.

**Returns:**
int - The frequency.
##### getPaddingBit()
```
public final int getPaddingBit()
```

Gets the padding bit.

**Returns:**
int - The padding bit.
##### getPrivateBit()
```
public final boolean getPrivateBit()
```

Gets a value indicating whether [private bit].

**Returns:**
boolean -  true  if [private bit]; otherwise,  false .
##### getChannelMode()
```
public final MpegChannelMode getChannelMode()
```

Gets the channel mode.

**Returns:**
MpegChannelMode - The channel mode.
##### getCopyright()
```
public final boolean getCopyright()
```

Gets the copyright bit.

**Returns:**
boolean -  true  if copyright; otherwise,  false .
##### isOriginal()
```
public final boolean isOriginal()
```

Gets the original bit.

**Returns:**
boolean -  true  if audio is original; otherwise,  false .
##### getEmphasis()
```
public final MpegEmphasis getEmphasis()
```

Gets the emphasis.

**Returns:**
MpegEmphasis - The emphasis.
##### getModeExtensionBits()
```
public final int getModeExtensionBits()
```

Gets the mode extension bits.

**Returns:**
int - The mode extension bits.

### MpegAudioVersion
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/mpegaudioversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegAudioVersion extends Enum<MpegAudioVersion> implements IEnumValue
```

Represents a particular MPEG standard.
#### Fields

| Field | Description |
| --- | --- |
| Mpeg25 | The MPEG 2.5 standard. |
| Mpeg2 | The MPEG 2 standard. |
| Mpeg1 | The MPEG 1 standard. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Mpeg25
```
public static final MpegAudioVersion Mpeg25
```

The MPEG 2.5 standard.

##### Mpeg2
```
public static final MpegAudioVersion Mpeg2
```

The MPEG 2 standard.

##### Mpeg1
```
public static final MpegAudioVersion Mpeg1
```

The MPEG 1 standard.

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

**Returns:**
com.groupdocs.metadata.core.MpegAudioVersion[]
##### valueOf(String name)
```
public static MpegAudioVersion valueOf(String name)
```

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

**Returns:**
MpegAudioVersion
##### getByRawValue(int rawValue)
```
public static MpegAudioVersion getByRawValue(int rawValue)
```

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

**Returns:**
MpegAudioVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MpegChannelMode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/mpegchannelmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegChannelMode extends Enum<MpegChannelMode> implements IEnumValue
```

Defines MPEG audio channel modes.
#### Fields

| Field | Description |
| --- | --- |
| Stereo | Stereo mode. |
| JointStereo | Joint stereo mode. |
| DualChannel | Dual channel mode. |
| Mono | Mono mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Stereo
```
public static final MpegChannelMode Stereo
```

Stereo mode.

##### JointStereo
```
public static final MpegChannelMode JointStereo
```

Joint stereo mode.

##### DualChannel
```
public static final MpegChannelMode DualChannel
```

Dual channel mode.

##### Mono
```
public static final MpegChannelMode Mono
```

Mono mode.

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

**Returns:**
com.groupdocs.metadata.core.MpegChannelMode[]
##### valueOf(String name)
```
public static MpegChannelMode valueOf(String name)
```

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

**Returns:**
MpegChannelMode
##### getByRawValue(int rawValue)
```
public static MpegChannelMode getByRawValue(int rawValue)
```

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

**Returns:**
MpegChannelMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MpegEmphasis
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/mpegemphasis.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegEmphasis extends Enum<MpegEmphasis> implements IEnumValue
```

Defines MPEG emphasis types.
#### Fields

| Field | Description |
| --- | --- |
| None | No emphasis indication. |
| Ms5015 | 50/15 ms. |
| Reserved | Reserved. |
| CcitJ17 | CCIT J.17. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final MpegEmphasis None
```

No emphasis indication.

##### Ms5015
```
public static final MpegEmphasis Ms5015
```

50/15 ms.

##### Reserved
```
public static final MpegEmphasis Reserved
```

Reserved.

##### CcitJ17
```
public static final MpegEmphasis CcitJ17
```

CCIT J.17.

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

**Returns:**
com.groupdocs.metadata.core.MpegEmphasis[]
##### valueOf(String name)
```
public static MpegEmphasis valueOf(String name)
```

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

**Returns:**
MpegEmphasis
##### getByRawValue(int rawValue)
```
public static MpegEmphasis getByRawValue(int rawValue)
```

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

**Returns:**
MpegEmphasis
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MsgPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/msgpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.EmailPackage
```
public class MsgPackage extends EmailPackage
```

Represents MSG message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getBody() | Gets the email message text. |
| getCategories() | Gets the array of categories or keywords. |
| getAttachments() | Gets an array of the attached files. |
| getDeliveryTime() | Gets the date and time the message was delivered. |
##### getBody()
```
public final String getBody()
```

Gets the email message text.

**Returns:**
java.lang.String - The email message text.
##### getCategories()
```
public final String[] getCategories()
```

Gets the array of categories or keywords.

**Returns:**
java.lang.String[] - The array of categories or keywords.
##### getAttachments()
```
public final MsgAttachmentPackage[] getAttachments()
```

Gets an array of the attached files.

**Returns:**
com.groupdocs.metadata.core.MsgAttachmentPackage[] - An array of the attached files.
##### getDeliveryTime()
```
public final Date getDeliveryTime()
```

Gets the date and time the message was delivered.

**Returns:**
java.util.Date - The delivery time.

### MsgRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/msgrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.EmailRootPackage
```
public class MsgRootPackage extends EmailRootPackage
```

Represents the root package allowing working with metadata in an MSG email message.

This code sample shows how to extract metadata from an MSG message.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMsg)) {
>      MsgRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getMsgPackage().getSender());
>      System.out.println(root.getMsgPackage().getSubject());
>      for (String recipient : root.getMsgPackage().getRecipients()) {
>          System.out.println(recipient);
>      }
>      for (String attachedFileName : root.getMsgPackage().getAttachedFileNames()) {
>          System.out.println(attachedFileName);
>      }
>      for (MetadataProperty header : root.getMsgPackage().getHeaders()) {
>          System.out.println(String.format("%s = %s", header.getName(), header.getValue()));
>      }
>      System.out.println(root.getMsgPackage().getBody());
>      System.out.println(root.getMsgPackage().getDeliveryTime());
>      // ...
>  }
>
> ```
> ```

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getMsgPackage() | Gets the MSG metadata package. |
| getString(MsgKnownProperties tag) | Gets the string value of the property specified by tag. |
##### getMsgPackage()
```
public final MsgPackage getMsgPackage()
```

Gets the MSG metadata package.

**Returns:**
MsgPackage - The MSG metadata package.
##### getString(MsgKnownProperties tag)
```
public final String getString(MsgKnownProperties tag)
```

Gets the string value of the property specified by tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | MsgKnownProperties | The value from MsgKnownProperties enum. |

**Returns:**
java.lang.String - The value of the property. If the property does not exist, returns null; otherwise, returns the value.

### NikonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/nikonmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class NikonMakerNotePackage extends MakerNotePackage
```

Represents NIKON MakerNote metadata.
#### Constructors

| Constructor | Description |
| --- | --- |
| NikonMakerNotePackage(TiffTag[] tags) | Initializes a new instance of the  NikonMakerNotePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMakerNoteVersion() | Gets the MakerNote version. |
| getIso() | Gets the iso. |
| getColorMode() | Gets the color mode. |
| getQuality() | Gets the quality string. |
| getWhiteBalance() | Gets the white balance. |
| getSharpness() | Gets the sharpness. |
| getFocusMode() | Gets the focus mode. |
| getFlashSetting() | Gets the flash setting. |
| getFlashType() | Gets the type of the flash. |
##### NikonMakerNotePackage(TiffTag[] tags)
```
public NikonMakerNotePackage(TiffTag[] tags)
```

Initializes a new instance of the  NikonMakerNotePackage  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tags | TiffTag\[\] | Array of TIFF tags. |

##### getMakerNoteVersion()
```
public final byte[] getMakerNoteVersion()
```

Gets the MakerNote version.

**Returns:**
byte[] - The MakerNote version.
##### getIso()
```
public final int[] getIso()
```

Gets the iso.

**Returns:**
int[] - The iso.
##### getColorMode()
```
public final String getColorMode()
```

Gets the color mode.

**Returns:**
java.lang.String - The color mode.
##### getQuality()
```
public final String getQuality()
```

Gets the quality string.

**Returns:**
java.lang.String - The quality.
##### getWhiteBalance()
```
public final String getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.String - The white balance.
##### getSharpness()
```
public final String getSharpness()
```

Gets the sharpness.

**Returns:**
java.lang.String - The sharpness.
##### getFocusMode()
```
public final String getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.String - The focus mode.
##### getFlashSetting()
```
public final String getFlashSetting()
```

Gets the flash setting.

**Returns:**
java.lang.String - The flash setting.
##### getFlashType()
```
public final String getFlashType()
```

Gets the type of the flash.

**Returns:**
java.lang.String - The type of the flash.

### NoteInspectionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/noteinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class NoteInspectionPackage extends CustomPackage
```

Represents a metadata package exposing the internal structure of a note section.

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Gets an array of section pages. |
##### getPages()
```
public final NotePage[] getPages()
```

Gets an array of section pages.

**Returns:**
com.groupdocs.metadata.core.NotePage[] - An array of section pages.

### NotePage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/notepage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class NotePage extends CustomPackage
```

Represents a page in a OneNote section.

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the page author. |
| getTitle() | Gets the page title. |
| getCreationTime() | Gets the creation time. |
| getLastModificationTime() | Gets the last modification time. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the page author.

**Returns:**
java.lang.String - The page author.
##### getTitle()
```
public final String getTitle()
```

Gets the page title.

**Returns:**
java.lang.String - The page title.
##### getCreationTime()
```
public final Date getCreationTime()
```

Gets the creation time.

**Returns:**
java.util.Date - The creation time.
##### getLastModificationTime()
```
public final Date getLastModificationTime()
```

Gets the last modification time.

**Returns:**
java.util.Date - The last modification time.

### NoteRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/noterootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class NoteRootPackage extends RootMetadataPackage
```

Represents the root package intended to work with metadata in an electronic note file.

This code sample demonstrates how to inspect a note document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputOne)) {
>      NoteRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getInspectionPackage().getPages() != null) {
>          for (NotePage page : root.getInspectionPackage().getPages()) {
>              System.out.println(page.getTitle());
>              System.out.println(page.getAuthor());
>              System.out.println(page.getCreationTime());
>              System.out.println(page.getLastModificationTime());
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| copyTo(MetadataPackage metadataPackage) |  |
##### getInspectionPackage()
```
public final NoteInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
NoteInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage |  |

### Oid
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/oid.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class Oid extends CustomPackage
```

Represents an object identifier (OID). An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC for naming any object, concept, or "thing" with a globally unambiguous persistent name.
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the object identifier (OID) value. |
| getFriendlyName() | Gets the friendly name. |
##### getValue()
```
public final String getValue()
```

Gets the object identifier (OID) value.

**Returns:**
java.lang.String - The object identifier (OID) value.
##### getFriendlyName()
```
public final String getFriendlyName()
```

Gets the friendly name.

**Returns:**
java.lang.String - The friendly name.

### OpenTypeBaseNameRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypebasenamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class OpenTypeBaseNameRecord extends CustomPackage
```

Represents the base OpenType Name table record class.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getNameID() | Gets the name identifier. |
| getPlatform() | Gets the platform identifier. |
| getValue() | Gets the string value of record. |
##### getNameID()
```
public final OpenTypeName getNameID()
```

Gets the name identifier.

**Returns:**
OpenTypeName - The name identifier.
##### getPlatform()
```
public final OpenTypePlatform getPlatform()
```

Gets the platform identifier.

**Returns:**
OpenTypePlatform - The platform identifier.
##### getValue()
```
public final String getValue()
```

Gets the string value of record.

**Returns:**
java.lang.String - The string value of record.

### OpenTypeDigitalSignatureFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypedigitalsignatureflags.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeDigitalSignatureFlags extends Enum<OpenTypeDigitalSignatureFlags> implements IEnumValue
```

Represents OpenType font digital signature flags.
#### Fields

| Field | Description |
| --- | --- |
| None | Undefined flag. |
| CannotBeResigned | Cannot be resigned. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final OpenTypeDigitalSignatureFlags None
```

Undefined flag.

##### CannotBeResigned
```
public static final OpenTypeDigitalSignatureFlags CannotBeResigned
```

Cannot be resigned.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeDigitalSignatureFlags[]
##### valueOf(String name)
```
public static OpenTypeDigitalSignatureFlags valueOf(String name)
```

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

**Returns:**
OpenTypeDigitalSignatureFlags
##### getByRawValue(int rawValue)
```
public static OpenTypeDigitalSignatureFlags getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeDigitalSignatureFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeDirectionHint
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypedirectionhint.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeDirectionHint extends Enum<OpenTypeDirectionHint> implements IEnumValue
```

Represents the OpenType font direction.
#### Fields

| Field | Description |
| --- | --- |
| FullyMixed | Fully mixed directional glyphs. |
| OnlyLeftToRight | Only strongly left to right. |
| LeftToRightAndNeutrals | Like  OnlyLeftToRight  but also contains neutrals. |
| OnlyRightToLeft | Only strongly right to left. |
| RightToLeftAndNeutrals | Like  OnlyRightToLeft  but also contains neutrals. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### FullyMixed
```
public static final OpenTypeDirectionHint FullyMixed
```

Fully mixed directional glyphs.

##### OnlyLeftToRight
```
public static final OpenTypeDirectionHint OnlyLeftToRight
```

Only strongly left to right.

##### LeftToRightAndNeutrals
```
public static final OpenTypeDirectionHint LeftToRightAndNeutrals
```

Like  OnlyLeftToRight  but also contains neutrals.

##### OnlyRightToLeft
```
public static final OpenTypeDirectionHint OnlyRightToLeft
```

Only strongly right to left.

##### RightToLeftAndNeutrals
```
public static final OpenTypeDirectionHint RightToLeftAndNeutrals
```

Like  OnlyRightToLeft  but also contains neutrals.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeDirectionHint[]
##### valueOf(String name)
```
public static OpenTypeDirectionHint valueOf(String name)
```

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

**Returns:**
OpenTypeDirectionHint
##### getByRawValue(int rawValue)
```
public static OpenTypeDirectionHint getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeDirectionHint
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeFlags implements IEnumValue
```

Represents OpenType font header flags.
#### Fields

| Field | Description |
| --- | --- |
| None | Undefined, no flags. |
| BaselineAtY0 | Baseline for font at y=0. |
| LeftSidebearingAtX0 | Left sidebearing point at x=0 (relevant only for TrueType rasterizers). |
| DependOnPointSize | Instructions may depend on point size. |
| ForceToInteger | Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear. |
| AlterAdvanceWidth | Instructions may alter advance width (the advance widths might not scale linearly). |
| Lossless | Font data is \\u201clossless\\u201d as a result of having been subjected to optimizing transformation and/or compression. |
| Converted | Font converted (produce compatible metrics). |
| Optimized | Font optimized for ClearType\\u2122. |
| Resort | Last Resort font. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final OpenTypeFlags None
```

Undefined, no flags.

##### BaselineAtY0
```
public static final OpenTypeFlags BaselineAtY0
```

Baseline for font at y=0.

##### LeftSidebearingAtX0
```
public static final OpenTypeFlags LeftSidebearingAtX0
```

Left sidebearing point at x=0 (relevant only for TrueType rasterizers).

##### DependOnPointSize
```
public static final OpenTypeFlags DependOnPointSize
```

Instructions may depend on point size.

##### ForceToInteger
```
public static final OpenTypeFlags ForceToInteger
```

Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear.

##### AlterAdvanceWidth
```
public static final OpenTypeFlags AlterAdvanceWidth
```

Instructions may alter advance width (the advance widths might not scale linearly).

##### Lossless
```
public static final OpenTypeFlags Lossless
```

Font data is \\u201clossless\\u201d as a result of having been subjected to optimizing transformation and/or compression.

##### Converted
```
public static final OpenTypeFlags Converted
```

Font converted (produce compatible metrics).

##### Optimized
```
public static final OpenTypeFlags Optimized
```

Font optimized for ClearType\\u2122.

##### Resort
```
public static final OpenTypeFlags Resort
```

Last Resort font.

##### getByRawValue(int rawValue)
```
public static OpenTypeFlags getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### OpenTypeFont
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypefont.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class OpenTypeFont extends CustomPackage
```

Represents a single font extracted from a file.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getSfntVersion() | Gets the header SFNT version. |
| getMajorVersion() | Gets the header major version. |
| getMinorVersion() | Gets the header minor version. |
| getFontRevision() | Gets the font revision. |
| getFlags() | Gets the header flags. |
| getCreated() | Gets the created date. |
| getModified() | Gets the modified date. |
| getGlyphBounds() | Gets the glyph bounds. |
| getStyle() | Gets the font style. |
| getDirectionHint() | Gets the direction hint. |
| getNames() | Gets the name records. |
| getFontFamilyName() | Gets the name of the font family. |
| getFontSubfamilyName() | Gets the name of the font subfamily. |
| getFullFontName() | Gets the full name of the font. |
| getTypographicFamily() | Gets the typographic family. |
| getTypographicSubfamily() | Gets the typographic subfamily. |
| getWeight() | Gets the font weight. |
| getWidth() | Gets the font width. |
| getEmbeddingLicensingRights() | Gets the embedding licensing rights type. |
##### getSfntVersion()
```
public final OpenTypeVersion getSfntVersion()
```

Gets the header SFNT version.

**Returns:**
OpenTypeVersion - The header SFNT version.
##### getMajorVersion()
```
public final int getMajorVersion()
```

Gets the header major version.

**Returns:**
int - The header major version.
##### getMinorVersion()
```
public final int getMinorVersion()
```

Gets the header minor version.

**Returns:**
int - The header minor version.
##### getFontRevision()
```
public final float getFontRevision()
```

Gets the font revision.

**Returns:**
float - The font revision.
##### getFlags()
```
public final OpenTypeFlags getFlags()
```

Gets the header flags.

**Returns:**
OpenTypeFlags - The header flags.
##### getCreated()
```
public final Date getCreated()
```

Gets the created date.

**Returns:**
java.util.Date - The created date.
##### getModified()
```
public final Date getModified()
```

Gets the modified date.

**Returns:**
java.util.Date - The modified date.
##### getGlyphBounds()
```
public final Rectangle getGlyphBounds()
```

Gets the glyph bounds.

**Returns:**
Rectangle - The glyph bounds.
##### getStyle()
```
public final OpenTypeStyles getStyle()
```

Gets the font style.

**Returns:**
OpenTypeStyles - The font style.
##### getDirectionHint()
```
public final OpenTypeDirectionHint getDirectionHint()
```

Gets the direction hint.

**Returns:**
OpenTypeDirectionHint - The direction hint.
##### getNames()
```
public final OpenTypeBaseNameRecord[] getNames()
```

Gets the name records.

**Returns:**
com.groupdocs.metadata.core.OpenTypeBaseNameRecord[] - The name records.
##### getFontFamilyName()
```
public final String getFontFamilyName()
```

Gets the name of the font family.

**Returns:**
java.lang.String - The name of the font family.
##### getFontSubfamilyName()
```
public final String getFontSubfamilyName()
```

Gets the name of the font subfamily.

**Returns:**
java.lang.String - The name of the font subfamily.
##### getFullFontName()
```
public final String getFullFontName()
```

Gets the full name of the font.

**Returns:**
java.lang.String - The full name of the font.
##### getTypographicFamily()
```
public final String getTypographicFamily()
```

Gets the typographic family.

**Returns:**
java.lang.String - The typographic family.
##### getTypographicSubfamily()
```
public final String getTypographicSubfamily()
```

Gets the typographic subfamily.

**Returns:**
java.lang.String - The typographic subfamily.
##### getWeight()
```
public final OpenTypeWeight getWeight()
```

Gets the font weight.

**Returns:**
OpenTypeWeight - The font weight.
##### getWidth()
```
public final OpenTypeWidth getWidth()
```

Gets the font width.

**Returns:**
OpenTypeWidth - The font width.
##### getEmbeddingLicensingRights()
```
public final OpenTypeLicensingRights getEmbeddingLicensingRights()
```

Gets the embedding licensing rights type.

**Returns:**
OpenTypeLicensingRights - The embedding licensing rights type.

### OpenTypeIsoEncoding
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeisoencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeIsoEncoding extends Enum<OpenTypeIsoEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Iso  platform.
#### Fields

| Field | Description |
| --- | --- |
| Ascii7Bit | The 7-bit ASCII encoding. |
| Iso10646 | The ISO 10646 encoding. |
| Iso8859 | The ISO 8859-1 encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Ascii7Bit
```
public static final OpenTypeIsoEncoding Ascii7Bit
```

The 7-bit ASCII encoding.

##### Iso10646
```
public static final OpenTypeIsoEncoding Iso10646
```

The ISO 10646 encoding.

##### Iso8859
```
public static final OpenTypeIsoEncoding Iso8859
```

The ISO 8859-1 encoding.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeIsoEncoding[]
##### valueOf(String name)
```
public static OpenTypeIsoEncoding valueOf(String name)
```

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

**Returns:**
OpenTypeIsoEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeIsoEncoding getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeIsoEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeLicensingRights
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypelicensingrights.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeLicensingRights implements IEnumValue
```

Indicates font embedding licensing rights for the font.
#### Fields

| Field | Description |
| --- | --- |
| None | The undefined licensing rights. |
| UsagePermissionsMask | Usage permissions mask. |
| InstallableEmbedding | Installable embedding. |
| RestrictedLicenseEmbedding | Restricted License embedding. |
| PreviewAndPrintEmbedding | Preview and Print embedding. |
| EditableEmbedding | Editable embedding. |
| NoSubsetting | No subsetting. |
| BitmapEmbeddingOnly | Bitmap embedding only. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final OpenTypeLicensingRights None
```

The undefined licensing rights.

##### UsagePermissionsMask
```
public static final OpenTypeLicensingRights UsagePermissionsMask
```

Usage permissions mask.

##### InstallableEmbedding
```
public static final OpenTypeLicensingRights InstallableEmbedding
```

Installable embedding. The font may be embedded, and may be permanently installed for use on a remote systems, or for use by other users.

##### RestrictedLicenseEmbedding
```
public static final OpenTypeLicensingRights RestrictedLicenseEmbedding
```

Restricted License embedding. The font must not be modified, embedded or exchanged in any manner without first obtaining explicit permission of the legal owner.

##### PreviewAndPrintEmbedding
```
public static final OpenTypeLicensingRights PreviewAndPrintEmbedding
```

Preview and Print embedding. The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or printing the document. Documents containing Preview & Print fonts must be opened \\u201cread-only\\u201d; no edits can be applied to the document.

##### EditableEmbedding
```
public static final OpenTypeLicensingRights EditableEmbedding
```

Editable embedding. The font may be embedded, and may be temporarily loaded on other systems. As with Preview and Print embedding, documents containing Editable fonts may be opened for reading. In addition, editing is permitted, including ability to format new text using the embedded font, and changes may be saved.

##### NoSubsetting
```
public static final OpenTypeLicensingRights NoSubsetting
```

No subsetting. When this bit is set, the font may not be subsetted prior to embedding. Other embedding restrictions specified in bits 0 to 3 and bit 9 also apply.

##### BitmapEmbeddingOnly
```
public static final OpenTypeLicensingRights BitmapEmbeddingOnly
```

Bitmap embedding only. When this bit is set, only bitmaps contained in the font may be embedded. No outline data may be embedded. If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail. Other embedding restrictions specified in bits 0-3 and 8 also apply.

##### getByRawValue(int rawValue)
```
public static OpenTypeLicensingRights getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeLicensingRights
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### OpenTypeMacintoshEncoding
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypemacintoshencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeMacintoshEncoding extends Enum<OpenTypeMacintoshEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Macintosh  platform.
#### Fields

| Field | Description |
| --- | --- |
| DefaultSemantics | Default semantics. |
| Version11Semantics | Version 1.1 semantics. |
| Iso106461993Semantics | ISO 10646 1993 semantics (deprecated). |
| Unicode20BmpOnly | Unicode 2.0 or later semantics (BMP only). |
| Unicode20NonBmp | Unicode 2.0 or later semantics (non-BMP characters allowed). |
| UnicodeVariationSequences | Unicode Variation Sequences. |
| FullUnicodeCoverage | Full Unicode coverage. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### DefaultSemantics
```
public static final OpenTypeMacintoshEncoding DefaultSemantics
```

Default semantics.

##### Version11Semantics
```
public static final OpenTypeMacintoshEncoding Version11Semantics
```

Version 1.1 semantics.

##### Iso106461993Semantics
```
public static final OpenTypeMacintoshEncoding Iso106461993Semantics
```

ISO 10646 1993 semantics (deprecated).

##### Unicode20BmpOnly
```
public static final OpenTypeMacintoshEncoding Unicode20BmpOnly
```

Unicode 2.0 or later semantics (BMP only).

##### Unicode20NonBmp
```
public static final OpenTypeMacintoshEncoding Unicode20NonBmp
```

Unicode 2.0 or later semantics (non-BMP characters allowed).

##### UnicodeVariationSequences
```
public static final OpenTypeMacintoshEncoding UnicodeVariationSequences
```

Unicode Variation Sequences.

##### FullUnicodeCoverage
```
public static final OpenTypeMacintoshEncoding FullUnicodeCoverage
```

Full Unicode coverage.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeMacintoshEncoding[]
##### valueOf(String name)
```
public static OpenTypeMacintoshEncoding valueOf(String name)
```

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

**Returns:**
OpenTypeMacintoshEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeMacintoshEncoding getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeMacintoshEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeMacintoshLanguage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypemacintoshlanguage.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeMacintoshLanguage extends Enum<OpenTypeMacintoshLanguage> implements IEnumValue
```

Represents language enum for the  OpenTypePlatform.Macintosh  platform.
#### Fields

| Field | Description |
| --- | --- |
| English | The english language. |
| French | The french language. |
| German | The german language. |
| Italian | The italian language. |
| Dutch | The dutch language. |
| Swedish | The swedish language. |
| Spanish | The spanish language. |
| Danish | The danish language. |
| Portuguese | The portuguese language. |
| Norwegian | The norwegian language. |
| Hebrew | The hebrew language. |
| Japanese | The japanese language. |
| Arabic | The arabic language. |
| Finnish | The finnish language. |
| Greek | The greek language. |
| Icelandic | The icelandic language. |
| Maltese | The maltese language. |
| Turkish | The turkish language. |
| Croatian | The croatian language. |
| ChineseTraditional | The chinese traditional language. |
| Urdu | The urdu language. |
| Hindi | The hindi language. |
| Thai | The thai language. |
| Korean | The korean language. |
| Lithuanian | The lithuanian language. |
| Polish | The polish language. |
| Hungarian | The hungarian language. |
| Estonian | The estonian language. |
| Latvian | The latvian language. |
| Sami | The sami language. |
| Faroese | The faroese language. |
| FarsiPersian | The farsi persian language. |
| Russian | The russian language. |
| ChineseSimplified | The chinese simplifie language. |
| Flemish | The flemish language. |
| IrishGaelic | The irish gaelic language. |
| Albanian | The albanian language. |
| Romanian | The romanian language. |
| Czech | The czech language. |
| Slovak | The slovak language. |
| Slovenian | The slovenian language. |
| Yiddish | The yiddish language. |
| Serbian | The serbian language. |
| Macedonian | The macedonian language. |
| Bulgarian | The bulgarian language. |
| Ukrainian | The ukrainian language. |
| Byelorussian | The byelorussian language. |
| Uzbek | The uzbek language. |
| Kazakh | The kazakh language. |
| AzerbaijaniCyrillic | The azerbaijani cyrillic language. |
| AzerbaijaniArabic | The azerbaijani arabic language. |
| Armenian | The armenian language. |
| Georgian | The georgian language. |
| Moldavian | The moldavian language. |
| Kirghiz | The kirghiz language. |
| Tajiki | The tajiki language. |
| Turkmen | The turkmen language. |
| MongolianMongolian | The mongolian mongolian language. |
| MongolianCyrillic | The mongolian cyrillic language. |
| Pashto | The pashto language. |
| Kurdish | The kurdish language. |
| Kashmiri | The kashmiri language. |
| Sindhi | The sindhi language. |
| Tibetan | The tibetan language. |
| Nepali | The nepali language. |
| Sanskrit | The sanskrit language. |
| Marathi | The marathi language. |
| Bengali | The bengali language. |
| Assamese | The assamese language. |
| Gujarati | The gujarati language. |
| Punjabi | The punjabi language. |
| Oriya | The oriya language. |
| Malayalam | The malayalam language. |
| Kannada | The kannada language. |
| Tamil | The tamil language. |
| Telugu | The telugu language. |
| Sinhalese | The sinhalese language. |
| Burmese | The burmese language. |
| Khmer | The khmer language. |
| Lao | The lao language. |
| Vietnamese | The vietnamese language. |
| Indonesian | The indonesian language. |
| Tagalog | The tagalog language. |
| MalayRoman | The malay roman language. |
| MalayArabic | The malay arabic language. |
| Amharic | The amharic language. |
| Tigrinya | The tigrinya language. |
| Galla | The galla language. |
| Somali | The somali language. |
| Swahili | The swahili language. |
| KinyarwandaOrRuanda | The kinyarwanda or ruanda language. |
| Rundi | The rundi language. |
| NyanjaOrChewa | The nyanja or chewa language. |
| Malagasy | The malagasy language. |
| Esperanto | The esperanto language. |
| Welsh | The welsh language. |
| Basque | The basque language. |
| Catalan | The catalan language. |
| Latin | The latin language. |
| Quechua | The quechua language. |
| Guarani | The guarani language. |
| Aymara | The aymara language. |
| Tatar | The tatar language. |
| Uighur | The uighur language. |
| Dzongkha | The dzongkha language. |
| JavaneseRoman | The javanese roman language. |
| SundaneseRoman | The sundanese roman language. |
| Galician | The galician language. |
| Afrikaans | The afrikaans language. |
| Breton | The breton language. |
| Inuktitut | The inuktitut language. |
| ScottishGaelic | The scottish gaelic language. |
| ManxGaelic | The manx gaelic language. |
| IrishGaelicWithDotAbove | The irish gaelic with dot above language. |
| Tongan | The tongan language. |
| GreekPolytonic | The greek polytonic language. |
| Greenlandic | The greenlandic language. |
| AzerbaijaniRoman | The azerbaijani roman language. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### English
```
public static final OpenTypeMacintoshLanguage English
```

The english language.

##### French
```
public static final OpenTypeMacintoshLanguage French
```

The french language.

##### German
```
public static final OpenTypeMacintoshLanguage German
```

The german language.

##### Italian
```
public static final OpenTypeMacintoshLanguage Italian
```

The italian language.

##### Dutch
```
public static final OpenTypeMacintoshLanguage Dutch
```

The dutch language.

##### Swedish
```
public static final OpenTypeMacintoshLanguage Swedish
```

The swedish language.

##### Spanish
```
public static final OpenTypeMacintoshLanguage Spanish
```

The spanish language.

##### Danish
```
public static final OpenTypeMacintoshLanguage Danish
```

The danish language.

##### Portuguese
```
public static final OpenTypeMacintoshLanguage Portuguese
```

The portuguese language.

##### Norwegian
```
public static final OpenTypeMacintoshLanguage Norwegian
```

The norwegian language.

##### Hebrew
```
public static final OpenTypeMacintoshLanguage Hebrew
```

The hebrew language.

##### Japanese
```
public static final OpenTypeMacintoshLanguage Japanese
```

The japanese language.

##### Arabic
```
public static final OpenTypeMacintoshLanguage Arabic
```

The arabic language.

##### Finnish
```
public static final OpenTypeMacintoshLanguage Finnish
```

The finnish language.

##### Greek
```
public static final OpenTypeMacintoshLanguage Greek
```

The greek language.

##### Icelandic
```
public static final OpenTypeMacintoshLanguage Icelandic
```

The icelandic language.

##### Maltese
```
public static final OpenTypeMacintoshLanguage Maltese
```

The maltese language.

##### Turkish
```
public static final OpenTypeMacintoshLanguage Turkish
```

The turkish language.

##### Croatian
```
public static final OpenTypeMacintoshLanguage Croatian
```

The croatian language.

##### ChineseTraditional
```
public static final OpenTypeMacintoshLanguage ChineseTraditional
```

The chinese traditional language.

##### Urdu
```
public static final OpenTypeMacintoshLanguage Urdu
```

The urdu language.

##### Hindi
```
public static final OpenTypeMacintoshLanguage Hindi
```

The hindi language.

##### Thai
```
public static final OpenTypeMacintoshLanguage Thai
```

The thai language.

##### Korean
```
public static final OpenTypeMacintoshLanguage Korean
```

The korean language.

##### Lithuanian
```
public static final OpenTypeMacintoshLanguage Lithuanian
```

The lithuanian language.

##### Polish
```
public static final OpenTypeMacintoshLanguage Polish
```

The polish language.

##### Hungarian
```
public static final OpenTypeMacintoshLanguage Hungarian
```

The hungarian language.

##### Estonian
```
public static final OpenTypeMacintoshLanguage Estonian
```

The estonian language.

##### Latvian
```
public static final OpenTypeMacintoshLanguage Latvian
```

The latvian language.

##### Sami
```
public static final OpenTypeMacintoshLanguage Sami
```

The sami language.

##### Faroese
```
public static final OpenTypeMacintoshLanguage Faroese
```

The faroese language.

##### FarsiPersian
```
public static final OpenTypeMacintoshLanguage FarsiPersian
```

The farsi persian language.

##### Russian
```
public static final OpenTypeMacintoshLanguage Russian
```

The russian language.

##### ChineseSimplified
```
public static final OpenTypeMacintoshLanguage ChineseSimplified
```

The chinese simplifie language.

##### Flemish
```
public static final OpenTypeMacintoshLanguage Flemish
```

The flemish language.

##### IrishGaelic
```
public static final OpenTypeMacintoshLanguage IrishGaelic
```

The irish gaelic language.

##### Albanian
```
public static final OpenTypeMacintoshLanguage Albanian
```

The albanian language.

##### Romanian
```
public static final OpenTypeMacintoshLanguage Romanian
```

The romanian language.

##### Czech
```
public static final OpenTypeMacintoshLanguage Czech
```

The czech language.

##### Slovak
```
public static final OpenTypeMacintoshLanguage Slovak
```

The slovak language.

##### Slovenian
```
public static final OpenTypeMacintoshLanguage Slovenian
```

The slovenian language.

##### Yiddish
```
public static final OpenTypeMacintoshLanguage Yiddish
```

The yiddish language.

##### Serbian
```
public static final OpenTypeMacintoshLanguage Serbian
```

The serbian language.

##### Macedonian
```
public static final OpenTypeMacintoshLanguage Macedonian
```

The macedonian language.

##### Bulgarian
```
public static final OpenTypeMacintoshLanguage Bulgarian
```

The bulgarian language.

##### Ukrainian
```
public static final OpenTypeMacintoshLanguage Ukrainian
```

The ukrainian language.

##### Byelorussian
```
public static final OpenTypeMacintoshLanguage Byelorussian
```

The byelorussian language.

##### Uzbek
```
public static final OpenTypeMacintoshLanguage Uzbek
```

The uzbek language.

##### Kazakh
```
public static final OpenTypeMacintoshLanguage Kazakh
```

The kazakh language.

##### AzerbaijaniCyrillic
```
public static final OpenTypeMacintoshLanguage AzerbaijaniCyrillic
```

The azerbaijani cyrillic language.

##### AzerbaijaniArabic
```
public static final OpenTypeMacintoshLanguage AzerbaijaniArabic
```

The azerbaijani arabic language.

##### Armenian
```
public static final OpenTypeMacintoshLanguage Armenian
```

The armenian language.

##### Georgian
```
public static final OpenTypeMacintoshLanguage Georgian
```

The georgian language.

##### Moldavian
```
public static final OpenTypeMacintoshLanguage Moldavian
```

The moldavian language.

##### Kirghiz
```
public static final OpenTypeMacintoshLanguage Kirghiz
```

The kirghiz language.

##### Tajiki
```
public static final OpenTypeMacintoshLanguage Tajiki
```

The tajiki language.

##### Turkmen
```
public static final OpenTypeMacintoshLanguage Turkmen
```

The turkmen language.

##### MongolianMongolian
```
public static final OpenTypeMacintoshLanguage MongolianMongolian
```

The mongolian mongolian language.

##### MongolianCyrillic
```
public static final OpenTypeMacintoshLanguage MongolianCyrillic
```

The mongolian cyrillic language.

##### Pashto
```
public static final OpenTypeMacintoshLanguage Pashto
```

The pashto language.

##### Kurdish
```
public static final OpenTypeMacintoshLanguage Kurdish
```

The kurdish language.

##### Kashmiri
```
public static final OpenTypeMacintoshLanguage Kashmiri
```

The kashmiri language.

##### Sindhi
```
public static final OpenTypeMacintoshLanguage Sindhi
```

The sindhi language.

##### Tibetan
```
public static final OpenTypeMacintoshLanguage Tibetan
```

The tibetan language.

##### Nepali
```
public static final OpenTypeMacintoshLanguage Nepali
```

The nepali language.

##### Sanskrit
```
public static final OpenTypeMacintoshLanguage Sanskrit
```

The sanskrit language.

##### Marathi
```
public static final OpenTypeMacintoshLanguage Marathi
```

The marathi language.

##### Bengali
```
public static final OpenTypeMacintoshLanguage Bengali
```

The bengali language.

##### Assamese
```
public static final OpenTypeMacintoshLanguage Assamese
```

The assamese language.

##### Gujarati
```
public static final OpenTypeMacintoshLanguage Gujarati
```

The gujarati language.

##### Punjabi
```
public static final OpenTypeMacintoshLanguage Punjabi
```

The punjabi language.

##### Oriya
```
public static final OpenTypeMacintoshLanguage Oriya
```

The oriya language.

##### Malayalam
```
public static final OpenTypeMacintoshLanguage Malayalam
```

The malayalam language.

##### Kannada
```
public static final OpenTypeMacintoshLanguage Kannada
```

The kannada language.

##### Tamil
```
public static final OpenTypeMacintoshLanguage Tamil
```

The tamil language.

##### Telugu
```
public static final OpenTypeMacintoshLanguage Telugu
```

The telugu language.

##### Sinhalese
```
public static final OpenTypeMacintoshLanguage Sinhalese
```

The sinhalese language.

##### Burmese
```
public static final OpenTypeMacintoshLanguage Burmese
```

The burmese language.

##### Khmer
```
public static final OpenTypeMacintoshLanguage Khmer
```

The khmer language.

##### Lao
```
public static final OpenTypeMacintoshLanguage Lao
```

The lao language.

##### Vietnamese
```
public static final OpenTypeMacintoshLanguage Vietnamese
```

The vietnamese language.

##### Indonesian
```
public static final OpenTypeMacintoshLanguage Indonesian
```

The indonesian language.

##### Tagalog
```
public static final OpenTypeMacintoshLanguage Tagalog
```

The tagalog language.

##### MalayRoman
```
public static final OpenTypeMacintoshLanguage MalayRoman
```

The malay roman language.

##### MalayArabic
```
public static final OpenTypeMacintoshLanguage MalayArabic
```

The malay arabic language.

##### Amharic
```
public static final OpenTypeMacintoshLanguage Amharic
```

The amharic language.

##### Tigrinya
```
public static final OpenTypeMacintoshLanguage Tigrinya
```

The tigrinya language.

##### Galla
```
public static final OpenTypeMacintoshLanguage Galla
```

The galla language.

##### Somali
```
public static final OpenTypeMacintoshLanguage Somali
```

The somali language.

##### Swahili
```
public static final OpenTypeMacintoshLanguage Swahili
```

The swahili language.

##### KinyarwandaOrRuanda
```
public static final OpenTypeMacintoshLanguage KinyarwandaOrRuanda
```

The kinyarwanda or ruanda language.

##### Rundi
```
public static final OpenTypeMacintoshLanguage Rundi
```

The rundi language.

##### NyanjaOrChewa
```
public static final OpenTypeMacintoshLanguage NyanjaOrChewa
```

The nyanja or chewa language.

##### Malagasy
```
public static final OpenTypeMacintoshLanguage Malagasy
```

The malagasy language.

##### Esperanto
```
public static final OpenTypeMacintoshLanguage Esperanto
```

The esperanto language.

##### Welsh
```
public static final OpenTypeMacintoshLanguage Welsh
```

The welsh language.

##### Basque
```
public static final OpenTypeMacintoshLanguage Basque
```

The basque language.

##### Catalan
```
public static final OpenTypeMacintoshLanguage Catalan
```

The catalan language.

##### Latin
```
public static final OpenTypeMacintoshLanguage Latin
```

The latin language.

##### Quechua
```
public static final OpenTypeMacintoshLanguage Quechua
```

The quechua language.

##### Guarani
```
public static final OpenTypeMacintoshLanguage Guarani
```

The guarani language.

##### Aymara
```
public static final OpenTypeMacintoshLanguage Aymara
```

The aymara language.

##### Tatar
```
public static final OpenTypeMacintoshLanguage Tatar
```

The tatar language.

##### Uighur
```
public static final OpenTypeMacintoshLanguage Uighur
```

The uighur language.

##### Dzongkha
```
public static final OpenTypeMacintoshLanguage Dzongkha
```

The dzongkha language.

##### JavaneseRoman
```
public static final OpenTypeMacintoshLanguage JavaneseRoman
```

The javanese roman language.

##### SundaneseRoman
```
public static final OpenTypeMacintoshLanguage SundaneseRoman
```

The sundanese roman language.

##### Galician
```
public static final OpenTypeMacintoshLanguage Galician
```

The galician language.

##### Afrikaans
```
public static final OpenTypeMacintoshLanguage Afrikaans
```

The afrikaans language.

##### Breton
```
public static final OpenTypeMacintoshLanguage Breton
```

The breton language.

##### Inuktitut
```
public static final OpenTypeMacintoshLanguage Inuktitut
```

The inuktitut language.

##### ScottishGaelic
```
public static final OpenTypeMacintoshLanguage ScottishGaelic
```

The scottish gaelic language.

##### ManxGaelic
```
public static final OpenTypeMacintoshLanguage ManxGaelic
```

The manx gaelic language.

##### IrishGaelicWithDotAbove
```
public static final OpenTypeMacintoshLanguage IrishGaelicWithDotAbove
```

The irish gaelic with dot above language.

##### Tongan
```
public static final OpenTypeMacintoshLanguage Tongan
```

The tongan language.

##### GreekPolytonic
```
public static final OpenTypeMacintoshLanguage GreekPolytonic
```

The greek polytonic language.

##### Greenlandic
```
public static final OpenTypeMacintoshLanguage Greenlandic
```

The greenlandic language.

##### AzerbaijaniRoman
```
public static final OpenTypeMacintoshLanguage AzerbaijaniRoman
```

The azerbaijani roman language.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeMacintoshLanguage[]
##### valueOf(String name)
```
public static OpenTypeMacintoshLanguage valueOf(String name)
```

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

**Returns:**
OpenTypeMacintoshLanguage
##### getByRawValue(int rawValue)
```
public static OpenTypeMacintoshLanguage getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeMacintoshLanguage
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeMacintoshNameRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypemacintoshnamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeMacintoshNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for the  OpenTypePlatform.Macintosh  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
| getLanguage() | Gets the language identifier. |
##### getEncoding()
```
public final OpenTypeMacintoshEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeMacintoshEncoding - The encoding identifier.
##### getLanguage()
```
public final OpenTypeMacintoshLanguage getLanguage()
```

Gets the language identifier.

**Returns:**
OpenTypeMacintoshLanguage - The language identifier.

### OpenTypeName
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypename.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeName extends Enum<OpenTypeName> implements IEnumValue
```

Defines pre-defined IDs, they apply to all platforms unless indicated otherwise.
#### Fields

| Field | Description |
| --- | --- |
| CopyrightNotice | Copyright notice. |
| FontFamilyName | Font Family name. |
| FontSubfamilyName | Font Subfamily name. |
| UniqueFontIdentifier | Unique font identifier. |
| FullFontName | Full font name that reflects all family and relevant subfamily descriptors. |
| VersionString | Version string. |
| PostScriptName | PostScript name for the font. |
| Trademark | Trademark notice/information for this font. |
| ManufacturerName | Manufacturer Name. |
| Designer | Designer), name of the designer of the typeface. |
| Description | Description of the typeface. |
| UrlVendor | URL of font vendor (with protocol, e.g., http://, ftp://). |
| UrlDesigner | URL of typeface designer (with protocol, e.g., http://, ftp://). |
| LicenseDescription | Description of how the font may be legally used, or different example scenarios for licensed use. |
| LicenseInfoUrl | URL where additional licensing information can be found. |
| TypographicFamily | Typographic Family name. |
| TypographicSubfamily | Typographic Subfamily name. |
| CompatibleFull | Compatible Full (Macintosh only). |
| SampleText | Sample text. |
| PostScriptCidFindfont | PostScript CID findfont name. |
| WwsFamilyName | WWS Family Name. |
| WwsSubfamilyName | WWS Subfamily Name. |
| LightBackgroundPalette | Light Background Palette. |
| DarkBackgroundPalette | Dark Background Palette. |
| VariationsPostScriptNamePrefix | Variations PostScript Name Prefix. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### CopyrightNotice
```
public static final OpenTypeName CopyrightNotice
```

Copyright notice.

##### FontFamilyName
```
public static final OpenTypeName FontFamilyName
```

Font Family name.

##### FontSubfamilyName
```
public static final OpenTypeName FontSubfamilyName
```

Font Subfamily name.

##### UniqueFontIdentifier
```
public static final OpenTypeName UniqueFontIdentifier
```

Unique font identifier.

##### FullFontName
```
public static final OpenTypeName FullFontName
```

Full font name that reflects all family and relevant subfamily descriptors.

##### VersionString
```
public static final OpenTypeName VersionString
```

Version string.

##### PostScriptName
```
public static final OpenTypeName PostScriptName
```

PostScript name for the font.

##### Trademark
```
public static final OpenTypeName Trademark
```

Trademark notice/information for this font.

##### ManufacturerName
```
public static final OpenTypeName ManufacturerName
```

Manufacturer Name.

##### Designer
```
public static final OpenTypeName Designer
```

Designer), name of the designer of the typeface.

##### Description
```
public static final OpenTypeName Description
```

Description of the typeface.

##### UrlVendor
```
public static final OpenTypeName UrlVendor
```

URL of font vendor (with protocol, e.g., http://, ftp://).

##### UrlDesigner
```
public static final OpenTypeName UrlDesigner
```

URL of typeface designer (with protocol, e.g., http://, ftp://).

##### LicenseDescription
```
public static final OpenTypeName LicenseDescription
```

Description of how the font may be legally used, or different example scenarios for licensed use.

##### LicenseInfoUrl
```
public static final OpenTypeName LicenseInfoUrl
```

URL where additional licensing information can be found.

##### TypographicFamily
```
public static final OpenTypeName TypographicFamily
```

Typographic Family name.

##### TypographicSubfamily
```
public static final OpenTypeName TypographicSubfamily
```

Typographic Subfamily name.

##### CompatibleFull
```
public static final OpenTypeName CompatibleFull
```

Compatible Full (Macintosh only). On the Macintosh, the menu name is constructed using the FOND resource.

##### SampleText
```
public static final OpenTypeName SampleText
```

Sample text. This can be the font name, or any other text that the designer thinks is the best sample to display the font in.

##### PostScriptCidFindfont
```
public static final OpenTypeName PostScriptCidFindfont
```

PostScript CID findfont name.

##### WwsFamilyName
```
public static final OpenTypeName WwsFamilyName
```

WWS Family Name.

##### WwsSubfamilyName
```
public static final OpenTypeName WwsSubfamilyName
```

WWS Subfamily Name.

##### LightBackgroundPalette
```
public static final OpenTypeName LightBackgroundPalette
```

Light Background Palette.

##### DarkBackgroundPalette
```
public static final OpenTypeName DarkBackgroundPalette
```

Dark Background Palette.

##### VariationsPostScriptNamePrefix
```
public static final OpenTypeName VariationsPostScriptNamePrefix
```

Variations PostScript Name Prefix.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeName[]
##### valueOf(String name)
```
public static OpenTypeName valueOf(String name)
```

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

**Returns:**
OpenTypeName
##### getByRawValue(int rawValue)
```
public static OpenTypeName getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeName
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class OpenTypePackage extends CustomPackage
```

Represents an OpenType font metadata package.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getFonts() | Gets an array of the fonts extracted from the file. |
##### getFonts()
```
public final OpenTypeFont[] getFonts()
```

Gets an array of the fonts extracted from the file.

**Returns:**
com.groupdocs.metadata.core.OpenTypeFont[] - An array of the fonts extracted from the file.

### OpenTypePlatform
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeplatform.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypePlatform extends Enum<OpenTypePlatform> implements IEnumValue
```

Represents OpenType platform for Name table.
#### Fields

| Field | Description |
| --- | --- |
| Unicode | The Unicode platform. |
| Macintosh | The Macintosh platform. |
| Iso | The ISO [deprecated] platform. |
| Windows | The Windows platform. |
| Custom | The Custom platform. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unicode
```
public static final OpenTypePlatform Unicode
```

The Unicode platform.

##### Macintosh
```
public static final OpenTypePlatform Macintosh
```

The Macintosh platform.

##### Iso
```
public static final OpenTypePlatform Iso
```

The ISO [deprecated] platform.

##### Windows
```
public static final OpenTypePlatform Windows
```

The Windows platform.

##### Custom
```
public static final OpenTypePlatform Custom
```

The Custom platform.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypePlatform[]
##### valueOf(String name)
```
public static OpenTypePlatform valueOf(String name)
```

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

**Returns:**
OpenTypePlatform
##### getByRawValue(int rawValue)
```
public static OpenTypePlatform getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypePlatform
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentyperootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class OpenTypeRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in an OpenType font file.

This example shows how to read OpenType font metadata.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputTtf)) {
>      OpenTypeRootPackage root = metadata.getRootPackageGeneric();
>      // Read the OpenType font metadata
>      for (OpenTypeFont metadataEntry : root.getOpenTypePackage().getFonts()) {
>          // Display the values of some metadata properties
>          System.out.println(metadataEntry.getCreated());
>          System.out.println(metadataEntry.getDirectionHint());
>          System.out.println(metadataEntry.getEmbeddingLicensingRights());
>          System.out.println(metadataEntry.getFlags());
>          System.out.println(metadataEntry.getFontFamilyName());
>          System.out.println(metadataEntry.getFontRevision());
>          System.out.println(metadataEntry.getFontSubfamilyName());
>          System.out.println(metadataEntry.getFullFontName());
>          System.out.println(metadataEntry.getGlyphBounds());
>          System.out.println(metadataEntry.getMajorVersion());
>          System.out.println(metadataEntry.getMinorVersion());
>          System.out.println(metadataEntry.getModified());
>          System.out.println(metadataEntry.getSfntVersion());
>          System.out.println(metadataEntry.getStyle());
>          System.out.println(metadataEntry.getTypographicFamily());
>          System.out.println(metadataEntry.getTypographicSubfamily());
>          System.out.println(metadataEntry.getWeight());
>          System.out.println(metadataEntry.getWidth());
>          for (OpenTypeBaseNameRecord nameRecord : metadataEntry.getNames()) {
>              System.out.println(nameRecord.getNameID());
>              System.out.println(nameRecord.getPlatform());
>              System.out.println(nameRecord.getValue());
>              if (nameRecord instanceof OpenTypeMacintoshNameRecord) {
>                  OpenTypeMacintoshNameRecord macintoshNameRecord = (OpenTypeMacintoshNameRecord) nameRecord;
>                  System.out.println(macintoshNameRecord.getEncoding());
>                  System.out.println(macintoshNameRecord.getLanguage());
>              } else {
>                  if (nameRecord instanceof OpenTypeUnicodeNameRecord) {
>                      OpenTypeUnicodeNameRecord unicodeNameRecord = (OpenTypeUnicodeNameRecord) nameRecord;
>                      System.out.println(unicodeNameRecord.getEncoding());
>                  } else {
>                      if (nameRecord instanceof OpenTypeWindowsNameRecord) {
>                          OpenTypeWindowsNameRecord windowsNameRecord = (OpenTypeWindowsNameRecord) nameRecord;
>                          System.out.println(windowsNameRecord.getEncoding());
>                          System.out.println(windowsNameRecord.getLanguage());
>                      }
>                  }
>              }
>          }
>      }
>  }
>
> ```
> ```

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getOpenTypePackage() | Gets the OpenType metadata package. |
| getDigitalSignaturePackage() | Gets the digital signature metadata package. |
##### getOpenTypePackage()
```
public final OpenTypePackage getOpenTypePackage()
```

Gets the OpenType metadata package.

**Returns:**
OpenTypePackage - The OpenType metadata package.
##### getDigitalSignaturePackage()
```
public final CmsPackage getDigitalSignaturePackage()
```

Gets the digital signature metadata package.

**Returns:**
CmsPackage - The digital signature metadata package.

### OpenTypeStyles
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypestyles.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeStyles implements IEnumValue
```

Represents the OpenType font style.
#### Fields

| Field | Description |
| --- | --- |
| Regular | Normal text. |
| Bold | Bold text. |
| Italic | Italic text. |
| Underline | Underlined text. |
| Outline | Outline text. |
| Shadow | Shadow text. |
| Condensed | Condensed text. |
| Extended | Extended text. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Regular
```
public static final OpenTypeStyles Regular
```

Normal text.

##### Bold
```
public static final OpenTypeStyles Bold
```

Bold text.

##### Italic
```
public static final OpenTypeStyles Italic
```

Italic text.

##### Underline
```
public static final OpenTypeStyles Underline
```

Underlined text.

##### Outline
```
public static final OpenTypeStyles Outline
```

Outline text.

##### Shadow
```
public static final OpenTypeStyles Shadow
```

Shadow text.

##### Condensed
```
public static final OpenTypeStyles Condensed
```

Condensed text.

##### Extended
```
public static final OpenTypeStyles Extended
```

Extended text.

##### getByRawValue(int rawValue)
```
public static OpenTypeStyles getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeStyles
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### OpenTypeUnicodeEncoding
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeunicodeencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeUnicodeEncoding extends Enum<OpenTypeUnicodeEncoding> implements IEnumValue
```

Represents encoding for  OpenTypePlatform.Unicode  platform.
#### Fields

| Field | Description |
| --- | --- |
| Unicode10 | Unicode 1.0 semantics. |
| Unicode11 | Unicode 1.1 semantics. |
| Iso | ISO/IEC 10646 semantics. |
| Unicode20Bmp | Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6). |
| Unicode20Full | Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12). |
| UnicodeVariation | Unicode Variation Sequences ('cmap' subtable format 14). |
| UnicodeFull | Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13). |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unicode10
```
public static final OpenTypeUnicodeEncoding Unicode10
```

Unicode 1.0 semantics.

##### Unicode11
```
public static final OpenTypeUnicodeEncoding Unicode11
```

Unicode 1.1 semantics.

##### Iso
```
public static final OpenTypeUnicodeEncoding Iso
```

ISO/IEC 10646 semantics.

##### Unicode20Bmp
```
public static final OpenTypeUnicodeEncoding Unicode20Bmp
```

Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6).

##### Unicode20Full
```
public static final OpenTypeUnicodeEncoding Unicode20Full
```

Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12).

##### UnicodeVariation
```
public static final OpenTypeUnicodeEncoding UnicodeVariation
```

Unicode Variation Sequences ('cmap' subtable format 14).

##### UnicodeFull
```
public static final OpenTypeUnicodeEncoding UnicodeFull
```

Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13).

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeUnicodeEncoding[]
##### valueOf(String name)
```
public static OpenTypeUnicodeEncoding valueOf(String name)
```

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

**Returns:**
OpenTypeUnicodeEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeUnicodeEncoding getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeUnicodeEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeUnicodeNameRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeunicodenamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeUnicodeNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for the  OpenTypePlatform.Unicode  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
##### getEncoding()
```
public final OpenTypeUnicodeEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeUnicodeEncoding - The encoding identifier.

### OpenTypeVersion
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeVersion extends Enum<OpenTypeVersion> implements IEnumValue
```

Represents the OpenType version.
#### Fields

| Field | Description |
| --- | --- |
| TrueType | The TrueType font. |
| Cff | The OpenType font with PostScript outlines. |
| TrueTypeOsX | The OS X and iOS TrueType font. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### TrueType
```
public static final OpenTypeVersion TrueType
```

The TrueType font.

##### Cff
```
public static final OpenTypeVersion Cff
```

The OpenType font with PostScript outlines.

##### TrueTypeOsX
```
public static final OpenTypeVersion TrueTypeOsX
```

The OS X and iOS TrueType font.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeVersion[]
##### valueOf(String name)
```
public static OpenTypeVersion valueOf(String name)
```

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

**Returns:**
OpenTypeVersion
##### getByRawValue(int rawValue)
```
public static OpenTypeVersion getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWeight
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypeweight.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWeight extends Enum<OpenTypeWeight> implements IEnumValue
```

Represents the OpenType font weight. Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font. Values from 1 to 1000 are valid.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined weight. |
| Thin | The Thin weight. |
| ExtraLight | The Extra-light (Ultra-light) weight. |
| Light | The Light weight. |
| Normal | The Normal (Regular) weight. |
| Medium | The Medium weight. |
| SemiBold | The Semi-bold (Demi-bold) weight. |
| Bold | The Bold weight. |
| ExtraBold | The Extra-bold (Ultra-bold) weight. |
| Heavy | The Black (Heavy) weight. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final OpenTypeWeight Undefined
```

The undefined weight.

##### Thin
```
public static final OpenTypeWeight Thin
```

The Thin weight.

##### ExtraLight
```
public static final OpenTypeWeight ExtraLight
```

The Extra-light (Ultra-light) weight.

##### Light
```
public static final OpenTypeWeight Light
```

The Light weight.

##### Normal
```
public static final OpenTypeWeight Normal
```

The Normal (Regular) weight.

##### Medium
```
public static final OpenTypeWeight Medium
```

The Medium weight.

##### SemiBold
```
public static final OpenTypeWeight SemiBold
```

The Semi-bold (Demi-bold) weight.

##### Bold
```
public static final OpenTypeWeight Bold
```

The Bold weight.

##### ExtraBold
```
public static final OpenTypeWeight ExtraBold
```

The Extra-bold (Ultra-bold) weight.

##### Heavy
```
public static final OpenTypeWeight Heavy
```

The Black (Heavy) weight.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeWeight[]
##### valueOf(String name)
```
public static OpenTypeWeight valueOf(String name)
```

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

**Returns:**
OpenTypeWeight
##### getByRawValue(int rawValue)
```
public static OpenTypeWeight getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeWeight
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWidth
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypewidth.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWidth extends Enum<OpenTypeWidth> implements IEnumValue
```

Represents the OpenType font width. Indicates a relative change from the normal aspect ratio (width to height ratio) as specified by a font designer for the glyphs in a font.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined wifth. |
| UltraCondensed | The Ultra-condensed wifth. |
| ExtraCondensed | The Extra-condensed wifth. |
| Condensed | The Condensed wifth. |
| SemiCondensed | The Semi-condensed wifth. |
| Medium | The Medium (normal) wifth. |
| SemiExpanded | The Semi-expanded wifth. |
| Expanded | The Expanded wifth. |
| ExtraExpanded | The Extra-expanded wifth. |
| UltraExpanded | The Ultra-expanded wifth. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final OpenTypeWidth Undefined
```

The undefined wifth.

##### UltraCondensed
```
public static final OpenTypeWidth UltraCondensed
```

The Ultra-condensed wifth.

##### ExtraCondensed
```
public static final OpenTypeWidth ExtraCondensed
```

The Extra-condensed wifth.

##### Condensed
```
public static final OpenTypeWidth Condensed
```

The Condensed wifth.

##### SemiCondensed
```
public static final OpenTypeWidth SemiCondensed
```

The Semi-condensed wifth.

##### Medium
```
public static final OpenTypeWidth Medium
```

The Medium (normal) wifth.

##### SemiExpanded
```
public static final OpenTypeWidth SemiExpanded
```

The Semi-expanded wifth.

##### Expanded
```
public static final OpenTypeWidth Expanded
```

The Expanded wifth.

##### ExtraExpanded
```
public static final OpenTypeWidth ExtraExpanded
```

The Extra-expanded wifth.

##### UltraExpanded
```
public static final OpenTypeWidth UltraExpanded
```

The Ultra-expanded wifth.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeWidth[]
##### valueOf(String name)
```
public static OpenTypeWidth valueOf(String name)
```

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

**Returns:**
OpenTypeWidth
##### getByRawValue(int rawValue)
```
public static OpenTypeWidth getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeWidth
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsEncoding
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypewindowsencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWindowsEncoding extends Enum<OpenTypeWindowsEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Windows  platform.
#### Fields

| Field | Description |
| --- | --- |
| Symbol | The Symbol encoding. |
| UnicodeBmp | The Unicode BMP encoding. |
| ShiftJis | The ShiftJIS encoding. |
| Prc | The PRC encoding. |
| Big5 | The Big5 encoding. |
| Wansung | The Wansung encoding. |
| Johab | The Johab encoding. |
| UnicodeFull | The Unicode full repertoire encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Symbol
```
public static final OpenTypeWindowsEncoding Symbol
```

The Symbol encoding.

##### UnicodeBmp
```
public static final OpenTypeWindowsEncoding UnicodeBmp
```

The Unicode BMP encoding.

##### ShiftJis
```
public static final OpenTypeWindowsEncoding ShiftJis
```

The ShiftJIS encoding.

##### Prc
```
public static final OpenTypeWindowsEncoding Prc
```

The PRC encoding.

##### Big5
```
public static final OpenTypeWindowsEncoding Big5
```

The Big5 encoding.

##### Wansung
```
public static final OpenTypeWindowsEncoding Wansung
```

The Wansung encoding.

##### Johab
```
public static final OpenTypeWindowsEncoding Johab
```

The Johab encoding.

##### UnicodeFull
```
public static final OpenTypeWindowsEncoding UnicodeFull
```

The Unicode full repertoire encoding.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeWindowsEncoding[]
##### valueOf(String name)
```
public static OpenTypeWindowsEncoding valueOf(String name)
```

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

**Returns:**
OpenTypeWindowsEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeWindowsEncoding getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeWindowsEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsLanguage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypewindowslanguage.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWindowsLanguage extends Enum<OpenTypeWindowsLanguage> implements IEnumValue
```

Represents language for  OpenTypePlatform.Windows  platform.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The unknown language. |
| AfrikaansSouthAfrica | The afrikaans south africa language. |
| AlbanianAlbania | The albanian Albania language. |
| AlsatianFrance | The alsatian France language. |
| AmharicEthiopia | The amharic Rthiopia language. |
| ArabicAlgeria | The arabic Algeria language. |
| ArabicBahrain | The arabic Bahrain language. |
| ArabicEgypt | The arabic Egypt language. |
| ArabicIraq | The arabic Iraq language. |
| ArabicJordan | The arabic Jordan language. |
| ArabicKuwait | The arabic Kuwait language. |
| ArabicLebanon | The arabic Lebanon language. |
| ArabicLibya | The arabic Libya language. |
| ArabicMorocco | The arabic Morocco language. |
| ArabicOman | The arabic Oman language. |
| ArabicQatar | The arabic Qatar language. |
| ArabicSaudiArabia | The arabic Saudi Arabia language. |
| ArabicSyria | The arabic Syria language. |
| ArabicTunisia | The arabic Tunisia language. |
| ArabicUae | The arabic UAE language. |
| ArabicYemen | The arabic Yemen language. |
| ArmenianArmenia | The armenian Armenia language. |
| AssameseIndia | The assamese India language. |
| AzeriCyrillicAzerbaijan | The azeri cyrillic Azerbaijan language. |
| AzeriLatinAzerbaijan | The azeri latin Azerbaijan language. |
| BashkirRussia | The bashkir Russia language. |
| BasqueBasque | The basque Basque language. |
| BelarusianBelarus | The belarusian Belarus language. |
| BengaliBangladesh | The bengali Bangladesh language. |
| BengaliIndia | The bengali India language. |
| BosnianLatinBosniaAndHerzegovina | The bosnian latin Bosnia and Herzegovina language. |
| BretonFrance | The breton France language. |
| BulgarianBulgaria | The bulgarian Bulgaria language. |
| CatalanCatalan | The catalan Catalan language. |
| ChineseHongKongSar | The chinese Hong Kong SAR language. |
| ChineseMacaoSar | The chinese Macao SAR language. |
| ChinesePeoplesRepublicOfChina | The chinese Peoples Republic of China language. |
| ChineseSingapore | The chinese Singapore language. |
| ChineseTaiwan | The chinese Taiwan language. |
| CorsicanFrance | The corsican France language. |
| CroatianCroatia | The croatian Croatia language. |
| CroatianLatinBosniaAndHerzegovina | The croatian latin Bosnia and Herzegovina language. |
| CzechCzechRepublic | The czech Czech Republic language. |
| DanishDenmark | The danish Denmark language. |
| DariAfghanistan | The dari Afghanistan language. |
| DivehiMaldives | The divehi Maldives language. |
| DutchBelgium | The dutch Belgium language. |
| DutchNetherlands | The dutch Netherlands language. |
| EnglishAustralia | The english Australia language. |
| EnglishBelize | The english Belize language. |
| EnglishCanada | The english Canada language. |
| EnglishCaribbean | The english Caribbean language. |
| EnglishIndia | The english India language. |
| EnglishIreland | The english Ireland language. |
| EnglishJamaica | The english Jamaica language. |
| EnglishMalaysia | The english Malaysia language. |
| EnglishNewZealand | The english New Zealand language. |
| EnglishRepublicOfThePhilippines | The english Republic of the Philippines language. |
| EnglishSingapore | The english Singapore language. |
| EnglishSouthAfrica | The english south africa language. |
| EnglishTrinidadAndTobago | The english Trinidad and Tobago language. |
| EnglishUnitedKingdom | The english United Kingdom language. |
| EnglishUnitedStates | The english United States language. |
| EnglishZimbabwe | The english Zimbabwe language. |
| EstonianEstonia | The estonian Estonia language. |
| FaroeseFaroeIslands | The faroese Faroe Islands language. |
| FilipinoPhilippines | The filipino Philippines language. |
| FinnishFinland | The finnish Finland language. |
| FrenchBelgium | The french Belgium language. |
| FrenchCanada | The french Canada language. |
| FrenchFrance | The french France language. |
| FrenchLuxembourg | The french Luxembourg language. |
| FrenchPrincipalityOfMonaco | The french Principality of Monaco language. |
| FrenchSwitzerland | The french Switzerland language. |
| FrisianNetherlands | The frisian Netherlands language. |
| GalicianGalician | The galician Galician language. |
| GeorgianGeorgia | The georgian Georgia language. |
| GermanAustria | The german Austria language. |
| GermanGermany | The german Germany language. |
| GermanLiechtenstein | The german Liechtenstein language. |
| GermanLuxembourg | The german Luxembourg language. |
| GermanSwitzerland | The german Switzerland language. |
| GreekGreece | The greek Greece language. |
| GreenlandicGreenland | The greenlandic Greenland language. |
| GujaratiIndia | The gujarati India language. |
| HausaLatinNigeria | The hausa latin Nigeria language. |
| HebrewIsrael | The hebrew Israel language. |
| HindiIndia | The hindi India language. |
| HungarianHungary | The hungarian Hungary language. |
| IcelandicIceland | The icelandic Iceland language. |
| IgboNigeria | The igbo Nigeria language. |
| IndonesianIndonesia | The indonesian Indonesia language. |
| InuktitutCanada | The inuktitut Canada language. |
| InuktitutLatinCanada | The inuktitut latin Canada language. |
| IrishIreland | The irish Ireland language. |
| IsiXhosaSouthAfrica | The isi xhosa South Africa language. |
| IsiZuluSouthAfrica | The isi zulu South Africa language. |
| ItalianItaly | The italian Italy language. |
| ItalianSwitzerland | The italian Switzerland language. |
| JapaneseJapan | The japanese Japan language. |
| KannadaIndia | The kannada India language. |
| KazakhKazakhstan | The kazakh Kazakhstan language. |
| KhmerCambodia | The khmer Cambodia language. |
| KicheGuatemala | The kiche Guatemala language. |
| KinyarwandaRwanda | The kinyarwanda Rwanda language. |
| KiswahiliKenya | The kiswahili Kenya language. |
| KonkaniIndia | The konkani India language. |
| KoreanKorea | The korean Korea language. |
| KyrgyzKyrgyzstan | The kyrgyz Kyrgyzstan language. |
| LaoLaoPdr | The lao lao PDR language. |
| LatvianLatvia | The latvian Latvia language. |
| LithuanianLithuania | The lithuanian Lithuania language. |
| LowerSorbianGermany | The lower sorbian Germany language. |
| LuxembourgishLuxembourg | The luxembourgish Luxembourg language. |
| MacedonianFyromFormerYugoslavRepublicOfMacedonia | The macedonian fyrom former Yugoslav Republic of Macedonia language. |
| MalayBruneiDarussalam | The malay brunei Darussalam language. |
| MalayMalaysia | The malay Malaysia language. |
| MalayalamIndia | The malayalam India language. |
| MalteseMalta | The maltese Malta language. |
| MaoriNewZealand | The maori New Zealand language. |
| MapudungunChile | The mapudungun Chile language. |
| MarathiIndia | The marathi India language. |
| MohawkMohawk | The mohawk Mohawk language. |
| MongolianCyrillicMongolia | The mongolian cyrillic Mongolia language. |
| MongolianTraditionalPeoplesRepublicOfChina | The mongolian traditional Peoples Republic of China language. |
| NepaliNepal | The nepali Nepal language. |
| NorwegianBokmalNorway | The norwegian bokmal Norway language. |
| NorwegianNynorskNorway | The norwegian nynorsk Norway language. |
| OccitanFrance | The occitan France language. |
| OdiaFormerlyOriyaIndia | The odia formerly oriya India language. |
| PashtoAfghanistan | The pashto Afghanistan language. |
| PolishPoland | The polish Poland language. |
| PortugueseBrazil | The portuguese Brazil language. |
| PortuguesePortugal | The portuguese Portugal language. |
| PunjabiIndia | The punjabi India language. |
| QuechuaBolivia | The quechua Bolivia language. |
| QuechuaEcuador | The quechua Ecuador language. |
| QuechuaPeru | The quechua Peru language. |
| RomanianRomania | The romanian Romania language. |
| RomanshSwitzerland | The romansh Switzerland language. |
| RussianRussia | The russian Russia language. |
| SamiInariFinland | The sami inari Finland language. |
| SamiLuleNorway | The sami lule Norway language. |
| SamiLuleSweden | The sami lule Sweden language. |
| SamiNorthernFinland | The sami northern Finland language. |
| SamiNorthernNorway | The sami northern Norway language. |
| SamiNorthernSweden | The sami northern Sweden language. |
| SamiSkoltFinland | The sami skolt Finland language. |
| SamiSouthernNorway | The sami southern Norway language. |
| SamiSouthernSweden | The sami southern Sweden language. |
| SanskritIndia | The sanskrit India language. |
| SerbianCyrillicBosniaAndHerzegovina | The serbian cyrillic Bosnia and Herzegovina language. |
| SerbianCyrillicSerbia | The serbian cyrillic Serbia language. |
| SerbianLatinBosniaAndHerzegovina | The serbian latin Bosnia and Herzegovina language. |
| SerbianLatinSerbia | The serbian latin Serbia language. |
| SesothoSaLeboaSouthAfrica | The sesotho sa leboa South Africa language. |
| SetswanaSouthAfrica | The setswana South Africa language. |
| SinhalaSriLanka | The sinhala Sri Lanka language. |
| SlovakSlovakia | The slovak Slovakia language. |
| SlovenianSlovenia | The slovenian Slovenia language. |
| SpanishArgentina | The spanish Argentina language. |
| SpanishBolivia | The spanish Bolivia language. |
| SpanishChile | The spanish Chile language. |
| SpanishColombia | The spanish Colombia language. |
| SpanishCostaRica | The spanish Costa Rica language. |
| SpanishDominicanRepublic | The spanish Dominican Republic language. |
| SpanishEcuador | The spanish Ecuador language. |
| SpanishElSalvador | The spanish El Salvador language. |
| SpanishGuatemala | The spanish Guatemala language. |
| SpanishHonduras | The spanish Honduras language. |
| SpanishMexico | The spanish Mexico language. |
| SpanishNicaragua | The spanish Nicaragua language. |
| SpanishPanama | The spanish Panama language. |
| SpanishParaguay | The spanish Paraguay language. |
| SpanishPeru | The spanish Peru language. |
| SpanishPuertoRico | The spanish Puerto Rico language. |
| SpanishModernSortSpain | The spanish modern sort Spain language. |
| SpanishTraditionalSortSpain | The spanish traditional sort Spain language. |
| SpanishUnitedStates | The spanish United States language. |
| SpanishUruguay | The spanish Uruguay language. |
| SpanishVenezuela | The spanish Venezuela language. |
| SwedenFinland | The sweden Finland language. |
| SwedishSweden | The swedish Sweden language. |
| SyriacSyria | The syriac Syria language. |
| TajikCyrillicTajikistan | The tajik cyrillic tajikistan language. |
| TamazightLatinAlgeria | The tamazight latin Algeria language. |
| TamilIndia | The tamil India language. |
| TatarRussia | The tatar Russia language. |
| TeluguIndia | The telugu India language. |
| ThaiThailand | The thai Thailand language. |
| TibetanPrc | The tibetan PRC language. |
| TurkishTurkey | The turkish Turkey language. |
| TurkmenTurkmenistan | The turkmen Turkmenistan language. |
| UighurPrc | The uighur PRC language. |
| UkrainianUkraine | The ukrainian Ukraine language. |
| UpperSorbianGermany | The upper sorbian Germany language. |
| UrduIslamicRepublicOfPakistan | The urdu Islamic Republic of Pakistan language. |
| UzbekCyrillicUzbekistan | The uzbek cyrillic Uzbekistan language. |
| UzbekLatinUzbekistan | The uzbek latin Uzbekistan language. |
| VietnameseVietnam | The vietnamese Vietnam language. |
| WelshUnitedKingdom | The welsh United Kingdom language. |
| WolofSenegal | The wolof Senegal language. |
| YakutRussia | The yakut Russia language. |
| YiPrc | The yi PRC language. |
| YorubaNigeria | The yoruba Nigeria language. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final OpenTypeWindowsLanguage Unknown
```

The unknown language.

##### AfrikaansSouthAfrica
```
public static final OpenTypeWindowsLanguage AfrikaansSouthAfrica
```

The afrikaans south africa language.

##### AlbanianAlbania
```
public static final OpenTypeWindowsLanguage AlbanianAlbania
```

The albanian Albania language.

##### AlsatianFrance
```
public static final OpenTypeWindowsLanguage AlsatianFrance
```

The alsatian France language.

##### AmharicEthiopia
```
public static final OpenTypeWindowsLanguage AmharicEthiopia
```

The amharic Rthiopia language.

##### ArabicAlgeria
```
public static final OpenTypeWindowsLanguage ArabicAlgeria
```

The arabic Algeria language.

##### ArabicBahrain
```
public static final OpenTypeWindowsLanguage ArabicBahrain
```

The arabic Bahrain language.

##### ArabicEgypt
```
public static final OpenTypeWindowsLanguage ArabicEgypt
```

The arabic Egypt language.

##### ArabicIraq
```
public static final OpenTypeWindowsLanguage ArabicIraq
```

The arabic Iraq language.

##### ArabicJordan
```
public static final OpenTypeWindowsLanguage ArabicJordan
```

The arabic Jordan language.

##### ArabicKuwait
```
public static final OpenTypeWindowsLanguage ArabicKuwait
```

The arabic Kuwait language.

##### ArabicLebanon
```
public static final OpenTypeWindowsLanguage ArabicLebanon
```

The arabic Lebanon language.

##### ArabicLibya
```
public static final OpenTypeWindowsLanguage ArabicLibya
```

The arabic Libya language.

##### ArabicMorocco
```
public static final OpenTypeWindowsLanguage ArabicMorocco
```

The arabic Morocco language.

##### ArabicOman
```
public static final OpenTypeWindowsLanguage ArabicOman
```

The arabic Oman language.

##### ArabicQatar
```
public static final OpenTypeWindowsLanguage ArabicQatar
```

The arabic Qatar language.

##### ArabicSaudiArabia
```
public static final OpenTypeWindowsLanguage ArabicSaudiArabia
```

The arabic Saudi Arabia language.

##### ArabicSyria
```
public static final OpenTypeWindowsLanguage ArabicSyria
```

The arabic Syria language.

##### ArabicTunisia
```
public static final OpenTypeWindowsLanguage ArabicTunisia
```

The arabic Tunisia language.

##### ArabicUae
```
public static final OpenTypeWindowsLanguage ArabicUae
```

The arabic UAE language.

##### ArabicYemen
```
public static final OpenTypeWindowsLanguage ArabicYemen
```

The arabic Yemen language.

##### ArmenianArmenia
```
public static final OpenTypeWindowsLanguage ArmenianArmenia
```

The armenian Armenia language.

##### AssameseIndia
```
public static final OpenTypeWindowsLanguage AssameseIndia
```

The assamese India language.

##### AzeriCyrillicAzerbaijan
```
public static final OpenTypeWindowsLanguage AzeriCyrillicAzerbaijan
```

The azeri cyrillic Azerbaijan language.

##### AzeriLatinAzerbaijan
```
public static final OpenTypeWindowsLanguage AzeriLatinAzerbaijan
```

The azeri latin Azerbaijan language.

##### BashkirRussia
```
public static final OpenTypeWindowsLanguage BashkirRussia
```

The bashkir Russia language.

##### BasqueBasque
```
public static final OpenTypeWindowsLanguage BasqueBasque
```

The basque Basque language.

##### BelarusianBelarus
```
public static final OpenTypeWindowsLanguage BelarusianBelarus
```

The belarusian Belarus language.

##### BengaliBangladesh
```
public static final OpenTypeWindowsLanguage BengaliBangladesh
```

The bengali Bangladesh language.

##### BengaliIndia
```
public static final OpenTypeWindowsLanguage BengaliIndia
```

The bengali India language.

##### BosnianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage BosnianLatinBosniaAndHerzegovina
```

The bosnian latin Bosnia and Herzegovina language.

##### BretonFrance
```
public static final OpenTypeWindowsLanguage BretonFrance
```

The breton France language.

##### BulgarianBulgaria
```
public static final OpenTypeWindowsLanguage BulgarianBulgaria
```

The bulgarian Bulgaria language.

##### CatalanCatalan
```
public static final OpenTypeWindowsLanguage CatalanCatalan
```

The catalan Catalan language.

##### ChineseHongKongSar
```
public static final OpenTypeWindowsLanguage ChineseHongKongSar
```

The chinese Hong Kong SAR language.

##### ChineseMacaoSar
```
public static final OpenTypeWindowsLanguage ChineseMacaoSar
```

The chinese Macao SAR language.

##### ChinesePeoplesRepublicOfChina
```
public static final OpenTypeWindowsLanguage ChinesePeoplesRepublicOfChina
```

The chinese Peoples Republic of China language.

##### ChineseSingapore
```
public static final OpenTypeWindowsLanguage ChineseSingapore
```

The chinese Singapore language.

##### ChineseTaiwan
```
public static final OpenTypeWindowsLanguage ChineseTaiwan
```

The chinese Taiwan language.

##### CorsicanFrance
```
public static final OpenTypeWindowsLanguage CorsicanFrance
```

The corsican France language.

##### CroatianCroatia
```
public static final OpenTypeWindowsLanguage CroatianCroatia
```

The croatian Croatia language.

##### CroatianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage CroatianLatinBosniaAndHerzegovina
```

The croatian latin Bosnia and Herzegovina language.

##### CzechCzechRepublic
```
public static final OpenTypeWindowsLanguage CzechCzechRepublic
```

The czech Czech Republic language.

##### DanishDenmark
```
public static final OpenTypeWindowsLanguage DanishDenmark
```

The danish Denmark language.

##### DariAfghanistan
```
public static final OpenTypeWindowsLanguage DariAfghanistan
```

The dari Afghanistan language.

##### DivehiMaldives
```
public static final OpenTypeWindowsLanguage DivehiMaldives
```

The divehi Maldives language.

##### DutchBelgium
```
public static final OpenTypeWindowsLanguage DutchBelgium
```

The dutch Belgium language.

##### DutchNetherlands
```
public static final OpenTypeWindowsLanguage DutchNetherlands
```

The dutch Netherlands language.

##### EnglishAustralia
```
public static final OpenTypeWindowsLanguage EnglishAustralia
```

The english Australia language.

##### EnglishBelize
```
public static final OpenTypeWindowsLanguage EnglishBelize
```

The english Belize language.

##### EnglishCanada
```
public static final OpenTypeWindowsLanguage EnglishCanada
```

The english Canada language.

##### EnglishCaribbean
```
public static final OpenTypeWindowsLanguage EnglishCaribbean
```

The english Caribbean language.

##### EnglishIndia
```
public static final OpenTypeWindowsLanguage EnglishIndia
```

The english India language.

##### EnglishIreland
```
public static final OpenTypeWindowsLanguage EnglishIreland
```

The english Ireland language.

##### EnglishJamaica
```
public static final OpenTypeWindowsLanguage EnglishJamaica
```

The english Jamaica language.

##### EnglishMalaysia
```
public static final OpenTypeWindowsLanguage EnglishMalaysia
```

The english Malaysia language.

##### EnglishNewZealand
```
public static final OpenTypeWindowsLanguage EnglishNewZealand
```

The english New Zealand language.

##### EnglishRepublicOfThePhilippines
```
public static final OpenTypeWindowsLanguage EnglishRepublicOfThePhilippines
```

The english Republic of the Philippines language.

##### EnglishSingapore
```
public static final OpenTypeWindowsLanguage EnglishSingapore
```

The english Singapore language.

##### EnglishSouthAfrica
```
public static final OpenTypeWindowsLanguage EnglishSouthAfrica
```

The english south africa language.

##### EnglishTrinidadAndTobago
```
public static final OpenTypeWindowsLanguage EnglishTrinidadAndTobago
```

The english Trinidad and Tobago language.

##### EnglishUnitedKingdom
```
public static final OpenTypeWindowsLanguage EnglishUnitedKingdom
```

The english United Kingdom language.

##### EnglishUnitedStates
```
public static final OpenTypeWindowsLanguage EnglishUnitedStates
```

The english United States language.

##### EnglishZimbabwe
```
public static final OpenTypeWindowsLanguage EnglishZimbabwe
```

The english Zimbabwe language.

##### EstonianEstonia
```
public static final OpenTypeWindowsLanguage EstonianEstonia
```

The estonian Estonia language.

##### FaroeseFaroeIslands
```
public static final OpenTypeWindowsLanguage FaroeseFaroeIslands
```

The faroese Faroe Islands language.

##### FilipinoPhilippines
```
public static final OpenTypeWindowsLanguage FilipinoPhilippines
```

The filipino Philippines language.

##### FinnishFinland
```
public static final OpenTypeWindowsLanguage FinnishFinland
```

The finnish Finland language.

##### FrenchBelgium
```
public static final OpenTypeWindowsLanguage FrenchBelgium
```

The french Belgium language.

##### FrenchCanada
```
public static final OpenTypeWindowsLanguage FrenchCanada
```

The french Canada language.

##### FrenchFrance
```
public static final OpenTypeWindowsLanguage FrenchFrance
```

The french France language.

##### FrenchLuxembourg
```
public static final OpenTypeWindowsLanguage FrenchLuxembourg
```

The french Luxembourg language.

##### FrenchPrincipalityOfMonaco
```
public static final OpenTypeWindowsLanguage FrenchPrincipalityOfMonaco
```

The french Principality of Monaco language.

##### FrenchSwitzerland
```
public static final OpenTypeWindowsLanguage FrenchSwitzerland
```

The french Switzerland language.

##### FrisianNetherlands
```
public static final OpenTypeWindowsLanguage FrisianNetherlands
```

The frisian Netherlands language.

##### GalicianGalician
```
public static final OpenTypeWindowsLanguage GalicianGalician
```

The galician Galician language.

##### GeorgianGeorgia
```
public static final OpenTypeWindowsLanguage GeorgianGeorgia
```

The georgian Georgia language.

##### GermanAustria
```
public static final OpenTypeWindowsLanguage GermanAustria
```

The german Austria language.

##### GermanGermany
```
public static final OpenTypeWindowsLanguage GermanGermany
```

The german Germany language.

##### GermanLiechtenstein
```
public static final OpenTypeWindowsLanguage GermanLiechtenstein
```

The german Liechtenstein language.

##### GermanLuxembourg
```
public static final OpenTypeWindowsLanguage GermanLuxembourg
```

The german Luxembourg language.

##### GermanSwitzerland
```
public static final OpenTypeWindowsLanguage GermanSwitzerland
```

The german Switzerland language.

##### GreekGreece
```
public static final OpenTypeWindowsLanguage GreekGreece
```

The greek Greece language.

##### GreenlandicGreenland
```
public static final OpenTypeWindowsLanguage GreenlandicGreenland
```

The greenlandic Greenland language.

##### GujaratiIndia
```
public static final OpenTypeWindowsLanguage GujaratiIndia
```

The gujarati India language.

##### HausaLatinNigeria
```
public static final OpenTypeWindowsLanguage HausaLatinNigeria
```

The hausa latin Nigeria language.

##### HebrewIsrael
```
public static final OpenTypeWindowsLanguage HebrewIsrael
```

The hebrew Israel language.

##### HindiIndia
```
public static final OpenTypeWindowsLanguage HindiIndia
```

The hindi India language.

##### HungarianHungary
```
public static final OpenTypeWindowsLanguage HungarianHungary
```

The hungarian Hungary language.

##### IcelandicIceland
```
public static final OpenTypeWindowsLanguage IcelandicIceland
```

The icelandic Iceland language.

##### IgboNigeria
```
public static final OpenTypeWindowsLanguage IgboNigeria
```

The igbo Nigeria language.

##### IndonesianIndonesia
```
public static final OpenTypeWindowsLanguage IndonesianIndonesia
```

The indonesian Indonesia language.

##### InuktitutCanada
```
public static final OpenTypeWindowsLanguage InuktitutCanada
```

The inuktitut Canada language.

##### InuktitutLatinCanada
```
public static final OpenTypeWindowsLanguage InuktitutLatinCanada
```

The inuktitut latin Canada language.

##### IrishIreland
```
public static final OpenTypeWindowsLanguage IrishIreland
```

The irish Ireland language.

##### IsiXhosaSouthAfrica
```
public static final OpenTypeWindowsLanguage IsiXhosaSouthAfrica
```

The isi xhosa South Africa language.

##### IsiZuluSouthAfrica
```
public static final OpenTypeWindowsLanguage IsiZuluSouthAfrica
```

The isi zulu South Africa language.

##### ItalianItaly
```
public static final OpenTypeWindowsLanguage ItalianItaly
```

The italian Italy language.

##### ItalianSwitzerland
```
public static final OpenTypeWindowsLanguage ItalianSwitzerland
```

The italian Switzerland language.

##### JapaneseJapan
```
public static final OpenTypeWindowsLanguage JapaneseJapan
```

The japanese Japan language.

##### KannadaIndia
```
public static final OpenTypeWindowsLanguage KannadaIndia
```

The kannada India language.

##### KazakhKazakhstan
```
public static final OpenTypeWindowsLanguage KazakhKazakhstan
```

The kazakh Kazakhstan language.

##### KhmerCambodia
```
public static final OpenTypeWindowsLanguage KhmerCambodia
```

The khmer Cambodia language.

##### KicheGuatemala
```
public static final OpenTypeWindowsLanguage KicheGuatemala
```

The kiche Guatemala language.

##### KinyarwandaRwanda
```
public static final OpenTypeWindowsLanguage KinyarwandaRwanda
```

The kinyarwanda Rwanda language.

##### KiswahiliKenya
```
public static final OpenTypeWindowsLanguage KiswahiliKenya
```

The kiswahili Kenya language.

##### KonkaniIndia
```
public static final OpenTypeWindowsLanguage KonkaniIndia
```

The konkani India language.

##### KoreanKorea
```
public static final OpenTypeWindowsLanguage KoreanKorea
```

The korean Korea language.

##### KyrgyzKyrgyzstan
```
public static final OpenTypeWindowsLanguage KyrgyzKyrgyzstan
```

The kyrgyz Kyrgyzstan language.

##### LaoLaoPdr
```
public static final OpenTypeWindowsLanguage LaoLaoPdr
```

The lao lao PDR language.

##### LatvianLatvia
```
public static final OpenTypeWindowsLanguage LatvianLatvia
```

The latvian Latvia language.

##### LithuanianLithuania
```
public static final OpenTypeWindowsLanguage LithuanianLithuania
```

The lithuanian Lithuania language.

##### LowerSorbianGermany
```
public static final OpenTypeWindowsLanguage LowerSorbianGermany
```

The lower sorbian Germany language.

##### LuxembourgishLuxembourg
```
public static final OpenTypeWindowsLanguage LuxembourgishLuxembourg
```

The luxembourgish Luxembourg language.

##### MacedonianFyromFormerYugoslavRepublicOfMacedonia
```
public static final OpenTypeWindowsLanguage MacedonianFyromFormerYugoslavRepublicOfMacedonia
```

The macedonian fyrom former Yugoslav Republic of Macedonia language.

##### MalayBruneiDarussalam
```
public static final OpenTypeWindowsLanguage MalayBruneiDarussalam
```

The malay brunei Darussalam language.

##### MalayMalaysia
```
public static final OpenTypeWindowsLanguage MalayMalaysia
```

The malay Malaysia language.

##### MalayalamIndia
```
public static final OpenTypeWindowsLanguage MalayalamIndia
```

The malayalam India language.

##### MalteseMalta
```
public static final OpenTypeWindowsLanguage MalteseMalta
```

The maltese Malta language.

##### MaoriNewZealand
```
public static final OpenTypeWindowsLanguage MaoriNewZealand
```

The maori New Zealand language.

##### MapudungunChile
```
public static final OpenTypeWindowsLanguage MapudungunChile
```

The mapudungun Chile language.

##### MarathiIndia
```
public static final OpenTypeWindowsLanguage MarathiIndia
```

The marathi India language.

##### MohawkMohawk
```
public static final OpenTypeWindowsLanguage MohawkMohawk
```

The mohawk Mohawk language.

##### MongolianCyrillicMongolia
```
public static final OpenTypeWindowsLanguage MongolianCyrillicMongolia
```

The mongolian cyrillic Mongolia language.

##### MongolianTraditionalPeoplesRepublicOfChina
```
public static final OpenTypeWindowsLanguage MongolianTraditionalPeoplesRepublicOfChina
```

The mongolian traditional Peoples Republic of China language.

##### NepaliNepal
```
public static final OpenTypeWindowsLanguage NepaliNepal
```

The nepali Nepal language.

##### NorwegianBokmalNorway
```
public static final OpenTypeWindowsLanguage NorwegianBokmalNorway
```

The norwegian bokmal Norway language.

##### NorwegianNynorskNorway
```
public static final OpenTypeWindowsLanguage NorwegianNynorskNorway
```

The norwegian nynorsk Norway language.

##### OccitanFrance
```
public static final OpenTypeWindowsLanguage OccitanFrance
```

The occitan France language.

##### OdiaFormerlyOriyaIndia
```
public static final OpenTypeWindowsLanguage OdiaFormerlyOriyaIndia
```

The odia formerly oriya India language.

##### PashtoAfghanistan
```
public static final OpenTypeWindowsLanguage PashtoAfghanistan
```

The pashto Afghanistan language.

##### PolishPoland
```
public static final OpenTypeWindowsLanguage PolishPoland
```

The polish Poland language.

##### PortugueseBrazil
```
public static final OpenTypeWindowsLanguage PortugueseBrazil
```

The portuguese Brazil language.

##### PortuguesePortugal
```
public static final OpenTypeWindowsLanguage PortuguesePortugal
```

The portuguese Portugal language.

##### PunjabiIndia
```
public static final OpenTypeWindowsLanguage PunjabiIndia
```

The punjabi India language.

##### QuechuaBolivia
```
public static final OpenTypeWindowsLanguage QuechuaBolivia
```

The quechua Bolivia language.

##### QuechuaEcuador
```
public static final OpenTypeWindowsLanguage QuechuaEcuador
```

The quechua Ecuador language.

##### QuechuaPeru
```
public static final OpenTypeWindowsLanguage QuechuaPeru
```

The quechua Peru language.

##### RomanianRomania
```
public static final OpenTypeWindowsLanguage RomanianRomania
```

The romanian Romania language.

##### RomanshSwitzerland
```
public static final OpenTypeWindowsLanguage RomanshSwitzerland
```

The romansh Switzerland language.

##### RussianRussia
```
public static final OpenTypeWindowsLanguage RussianRussia
```

The russian Russia language.

##### SamiInariFinland
```
public static final OpenTypeWindowsLanguage SamiInariFinland
```

The sami inari Finland language.

##### SamiLuleNorway
```
public static final OpenTypeWindowsLanguage SamiLuleNorway
```

The sami lule Norway language.

##### SamiLuleSweden
```
public static final OpenTypeWindowsLanguage SamiLuleSweden
```

The sami lule Sweden language.

##### SamiNorthernFinland
```
public static final OpenTypeWindowsLanguage SamiNorthernFinland
```

The sami northern Finland language.

##### SamiNorthernNorway
```
public static final OpenTypeWindowsLanguage SamiNorthernNorway
```

The sami northern Norway language.

##### SamiNorthernSweden
```
public static final OpenTypeWindowsLanguage SamiNorthernSweden
```

The sami northern Sweden language.

##### SamiSkoltFinland
```
public static final OpenTypeWindowsLanguage SamiSkoltFinland
```

The sami skolt Finland language.

##### SamiSouthernNorway
```
public static final OpenTypeWindowsLanguage SamiSouthernNorway
```

The sami southern Norway language.

##### SamiSouthernSweden
```
public static final OpenTypeWindowsLanguage SamiSouthernSweden
```

The sami southern Sweden language.

##### SanskritIndia
```
public static final OpenTypeWindowsLanguage SanskritIndia
```

The sanskrit India language.

##### SerbianCyrillicBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage SerbianCyrillicBosniaAndHerzegovina
```

The serbian cyrillic Bosnia and Herzegovina language.

##### SerbianCyrillicSerbia
```
public static final OpenTypeWindowsLanguage SerbianCyrillicSerbia
```

The serbian cyrillic Serbia language.

##### SerbianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage SerbianLatinBosniaAndHerzegovina
```

The serbian latin Bosnia and Herzegovina language.

##### SerbianLatinSerbia
```
public static final OpenTypeWindowsLanguage SerbianLatinSerbia
```

The serbian latin Serbia language.

##### SesothoSaLeboaSouthAfrica
```
public static final OpenTypeWindowsLanguage SesothoSaLeboaSouthAfrica
```

The sesotho sa leboa South Africa language.

##### SetswanaSouthAfrica
```
public static final OpenTypeWindowsLanguage SetswanaSouthAfrica
```

The setswana South Africa language.

##### SinhalaSriLanka
```
public static final OpenTypeWindowsLanguage SinhalaSriLanka
```

The sinhala Sri Lanka language.

##### SlovakSlovakia
```
public static final OpenTypeWindowsLanguage SlovakSlovakia
```

The slovak Slovakia language.

##### SlovenianSlovenia
```
public static final OpenTypeWindowsLanguage SlovenianSlovenia
```

The slovenian Slovenia language.

##### SpanishArgentina
```
public static final OpenTypeWindowsLanguage SpanishArgentina
```

The spanish Argentina language.

##### SpanishBolivia
```
public static final OpenTypeWindowsLanguage SpanishBolivia
```

The spanish Bolivia language.

##### SpanishChile
```
public static final OpenTypeWindowsLanguage SpanishChile
```

The spanish Chile language.

##### SpanishColombia
```
public static final OpenTypeWindowsLanguage SpanishColombia
```

The spanish Colombia language.

##### SpanishCostaRica
```
public static final OpenTypeWindowsLanguage SpanishCostaRica
```

The spanish Costa Rica language.

##### SpanishDominicanRepublic
```
public static final OpenTypeWindowsLanguage SpanishDominicanRepublic
```

The spanish Dominican Republic language.

##### SpanishEcuador
```
public static final OpenTypeWindowsLanguage SpanishEcuador
```

The spanish Ecuador language.

##### SpanishElSalvador
```
public static final OpenTypeWindowsLanguage SpanishElSalvador
```

The spanish El Salvador language.

##### SpanishGuatemala
```
public static final OpenTypeWindowsLanguage SpanishGuatemala
```

The spanish Guatemala language.

##### SpanishHonduras
```
public static final OpenTypeWindowsLanguage SpanishHonduras
```

The spanish Honduras language.

##### SpanishMexico
```
public static final OpenTypeWindowsLanguage SpanishMexico
```

The spanish Mexico language.

##### SpanishNicaragua
```
public static final OpenTypeWindowsLanguage SpanishNicaragua
```

The spanish Nicaragua language.

##### SpanishPanama
```
public static final OpenTypeWindowsLanguage SpanishPanama
```

The spanish Panama language.

##### SpanishParaguay
```
public static final OpenTypeWindowsLanguage SpanishParaguay
```

The spanish Paraguay language.

##### SpanishPeru
```
public static final OpenTypeWindowsLanguage SpanishPeru
```

The spanish Peru language.

##### SpanishPuertoRico
```
public static final OpenTypeWindowsLanguage SpanishPuertoRico
```

The spanish Puerto Rico language.

##### SpanishModernSortSpain
```
public static final OpenTypeWindowsLanguage SpanishModernSortSpain
```

The spanish modern sort Spain language.

##### SpanishTraditionalSortSpain
```
public static final OpenTypeWindowsLanguage SpanishTraditionalSortSpain
```

The spanish traditional sort Spain language.

##### SpanishUnitedStates
```
public static final OpenTypeWindowsLanguage SpanishUnitedStates
```

The spanish United States language.

##### SpanishUruguay
```
public static final OpenTypeWindowsLanguage SpanishUruguay
```

The spanish Uruguay language.

##### SpanishVenezuela
```
public static final OpenTypeWindowsLanguage SpanishVenezuela
```

The spanish Venezuela language.

##### SwedenFinland
```
public static final OpenTypeWindowsLanguage SwedenFinland
```

The sweden Finland language.

##### SwedishSweden
```
public static final OpenTypeWindowsLanguage SwedishSweden
```

The swedish Sweden language.

##### SyriacSyria
```
public static final OpenTypeWindowsLanguage SyriacSyria
```

The syriac Syria language.

##### TajikCyrillicTajikistan
```
public static final OpenTypeWindowsLanguage TajikCyrillicTajikistan
```

The tajik cyrillic tajikistan language.

##### TamazightLatinAlgeria
```
public static final OpenTypeWindowsLanguage TamazightLatinAlgeria
```

The tamazight latin Algeria language.

##### TamilIndia
```
public static final OpenTypeWindowsLanguage TamilIndia
```

The tamil India language.

##### TatarRussia
```
public static final OpenTypeWindowsLanguage TatarRussia
```

The tatar Russia language.

##### TeluguIndia
```
public static final OpenTypeWindowsLanguage TeluguIndia
```

The telugu India language.

##### ThaiThailand
```
public static final OpenTypeWindowsLanguage ThaiThailand
```

The thai Thailand language.

##### TibetanPrc
```
public static final OpenTypeWindowsLanguage TibetanPrc
```

The tibetan PRC language.

##### TurkishTurkey
```
public static final OpenTypeWindowsLanguage TurkishTurkey
```

The turkish Turkey language.

##### TurkmenTurkmenistan
```
public static final OpenTypeWindowsLanguage TurkmenTurkmenistan
```

The turkmen Turkmenistan language.

##### UighurPrc
```
public static final OpenTypeWindowsLanguage UighurPrc
```

The uighur PRC language.

##### UkrainianUkraine
```
public static final OpenTypeWindowsLanguage UkrainianUkraine
```

The ukrainian Ukraine language.

##### UpperSorbianGermany
```
public static final OpenTypeWindowsLanguage UpperSorbianGermany
```

The upper sorbian Germany language.

##### UrduIslamicRepublicOfPakistan
```
public static final OpenTypeWindowsLanguage UrduIslamicRepublicOfPakistan
```

The urdu Islamic Republic of Pakistan language.

##### UzbekCyrillicUzbekistan
```
public static final OpenTypeWindowsLanguage UzbekCyrillicUzbekistan
```

The uzbek cyrillic Uzbekistan language.

##### UzbekLatinUzbekistan
```
public static final OpenTypeWindowsLanguage UzbekLatinUzbekistan
```

The uzbek latin Uzbekistan language.

##### VietnameseVietnam
```
public static final OpenTypeWindowsLanguage VietnameseVietnam
```

The vietnamese Vietnam language.

##### WelshUnitedKingdom
```
public static final OpenTypeWindowsLanguage WelshUnitedKingdom
```

The welsh United Kingdom language.

##### WolofSenegal
```
public static final OpenTypeWindowsLanguage WolofSenegal
```

The wolof Senegal language.

##### YakutRussia
```
public static final OpenTypeWindowsLanguage YakutRussia
```

The yakut Russia language.

##### YiPrc
```
public static final OpenTypeWindowsLanguage YiPrc
```

The yi PRC language.

##### YorubaNigeria
```
public static final OpenTypeWindowsLanguage YorubaNigeria
```

The yoruba Nigeria language.

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

**Returns:**
com.groupdocs.metadata.core.OpenTypeWindowsLanguage[]
##### valueOf(String name)
```
public static OpenTypeWindowsLanguage valueOf(String name)
```

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

**Returns:**
OpenTypeWindowsLanguage
##### getByRawValue(int rawValue)
```
public static OpenTypeWindowsLanguage getByRawValue(int rawValue)
```

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

**Returns:**
OpenTypeWindowsLanguage
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsNameRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/opentypewindowsnamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeWindowsNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for  OpenTypePlatform.Windows  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
| getLanguage() | Gets the language identifier. |
##### getEncoding()
```
public final OpenTypeWindowsEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeWindowsEncoding - The encoding identifier.
##### getLanguage()
```
public final OpenTypeWindowsLanguage getLanguage()
```

Gets the language identifier.

**Returns:**
OpenTypeWindowsLanguage - The language identifier.

### PageInfo
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pageinfo.md

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

Provides common information about a document page (slide, worksheet, etc).

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of the page in document default units. |
| getHeight() | Gets the height of the page in document default units. |
| getPageNumber() | Gets the number of the page. |
##### getWidth()
```
public final int getWidth()
```

Gets the width of the page in document default units.

**Returns:**
int - The width of the page in document default units.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the page in document default units.

**Returns:**
int - The height of the page in document default units.
##### getPageNumber()
```
public final int getPageNumber()
```

Gets the number of the page.

**Returns:**
int - The number of the page.

### PanasonicMakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/panasonicmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public class PanasonicMakerNotePackage extends MakerNotePackage
```

Represents PANASONIC MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getImageQuality() | Gets the image quality. |
| getFirmwareVersion() | Gets the firmware version. |
| getWhiteBalance() | Gets the white balance. |
| getFocusMode() | Gets the focus mode. |
| getAFMode() | Gets the AF mode. |
| getImageStabilization() | Gets the image stabilization mode. |
| getMacroMode() | Gets the macro mode. |
| getShootingMode() | Gets the shooting mode. |
| getAudio() | Gets the audio mode. |
| getLensType() | Gets the type of the lens. |
| getLensSerialNumber() | Gets the lens serial number. |
| getAccessoryType() | Gets the type of the accessory. |
| getAccessorySerialNumber() | Gets the accessory serial number. |
##### getImageQuality()
```
public final Integer getImageQuality()
```

Gets the image quality.

**Returns:**
java.lang.Integer - The image quality.
##### getFirmwareVersion()
```
public final byte[] getFirmwareVersion()
```

Gets the firmware version.

**Returns:**
byte[] - The firmware version.
##### getWhiteBalance()
```
public final Integer getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.Integer - The white balance.
##### getFocusMode()
```
public final Integer getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.Integer - The focus mode.
##### getAFMode()
```
public final byte[] getAFMode()
```

Gets the AF mode.

**Returns:**
byte[] - The AF mode.
##### getImageStabilization()
```
public final Integer getImageStabilization()
```

Gets the image stabilization mode.

**Returns:**
java.lang.Integer - The image stabilization mode.
##### getMacroMode()
```
public final Integer getMacroMode()
```

Gets the macro mode.

**Returns:**
java.lang.Integer - The macro mode.
##### getShootingMode()
```
public final Integer getShootingMode()
```

Gets the shooting mode.

**Returns:**
java.lang.Integer - The shooting mode.
##### getAudio()
```
public final Integer getAudio()
```

Gets the audio mode.

**Returns:**
java.lang.Integer - The audio mode.
##### getLensType()
```
public final String getLensType()
```

Gets the type of the lens.

**Returns:**
java.lang.String - The type of the lens.
##### getLensSerialNumber()
```
public final String getLensSerialNumber()
```

Gets the lens serial number.

**Returns:**
java.lang.String - The lens serial number.
##### getAccessoryType()
```
public final String getAccessoryType()
```

Gets the type of the accessory.

**Returns:**
java.lang.String - The type of the accessory.
##### getAccessorySerialNumber()
```
public final String getAccessorySerialNumber()
```

Gets the accessory serial number.

**Returns:**
java.lang.String - The accessory serial number.

### PdfAnnotation
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfAnnotation extends CustomPackage
```

Represents an annotation in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the annotation text. |
| getName() | Gets the name of the annotation. |
| getPageNumber() | Gets the number of the page containing the annotation. |
##### getText()
```
public final String getText()
```

Gets the annotation text.

**Returns:**
java.lang.String - The annotation text.
##### getName()
```
public final String getName()
```

Gets the name of the annotation.

**Returns:**
java.lang.String - The name of the annotation.
##### getPageNumber()
```
public final int getPageNumber()
```

Gets the number of the page containing the annotation.

**Returns:**
int - The number of the page containing the annotation.

### PdfAttachment
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfattachment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfAttachment extends CustomPackage
```

Represents an attachment in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the attachment name. |
| getDescription() | Gets the attachment description. |
| getMimeType() | Gets the MIME type of the attachment. |
##### getName()
```
public final String getName()
```

Gets the attachment name.

**Returns:**
java.lang.String - The attachment name.
##### getDescription()
```
public final String getDescription()
```

Gets the attachment description.

**Returns:**
java.lang.String - The attachment description.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type of the attachment.

**Returns:**
java.lang.String - The MIME type of the attachment.

### PdfBookmark
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfbookmark.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfBookmark extends CustomPackage
```

Represents a bookmark in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets the title of the bookmark. |
##### getTitle()
```
public final String getTitle()
```

Gets the title of the bookmark.

**Returns:**
java.lang.String - The title of the bookmark.

### PdfFormField
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfformfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfFormField extends CustomPackage
```

Represents a form field in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the field. |
| getValue() | Gets the field value. |
##### getName()
```
public final String getName()
```

Gets the name of the field.

**Returns:**
java.lang.String - The name of the field.
##### getValue()
```
public final String getValue()
```

Gets the field value.

**Returns:**
java.lang.String - The field value.

### PdfInspectionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PdfInspectionPackage extends CustomPackage
```

Contains information about PDF document parts that can be considered as metadata in some cases.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getAnnotations() | Gets an array of the annotations. |
| getAttachments() | Gets an array of the attachments. |
| getBookmarks() | Gets an array of the bookmarks. |
| getFields() | Gets an array of the form fields. |
| getDigitalSignatures() | Gets an array of the digital signatures. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| sanitize() | Removes writable metadata properties from the package. |
| clearAnnotations() | Removes all detected annotations from the document. |
| clearAttachments() | Removes all detected attachments from the document. |
| clearBookmarks() | Removes all detected bookmarks from the document. |
| clearFields() | Removes all detected form fields from the document. |
| clearDigitalSignatures() | Removes all detected digital signatures from the document. |
##### getAnnotations()
```
public final PdfAnnotation[] getAnnotations()
```

Gets an array of the annotations.

**Returns:**
com.groupdocs.metadata.core.PdfAnnotation[] - An array of the annotations.
##### getAttachments()
```
public final PdfAttachment[] getAttachments()
```

Gets an array of the attachments.

**Returns:**
com.groupdocs.metadata.core.PdfAttachment[] - An array of the attachments.
##### getBookmarks()
```
public final PdfBookmark[] getBookmarks()
```

Gets an array of the bookmarks.

**Returns:**
com.groupdocs.metadata.core.PdfBookmark[] - An array of the bookmarks.
##### getFields()
```
public final PdfFormField[] getFields()
```

Gets an array of the form fields.

**Returns:**
com.groupdocs.metadata.core.PdfFormField[] - An array of the form fields.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of the digital signatures.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - An array of the digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.
##### clearAnnotations()
```
public final void clearAnnotations()
```

Removes all detected annotations from the document.

##### clearAttachments()
```
public final void clearAttachments()
```

Removes all detected attachments from the document.

##### clearBookmarks()
```
public final void clearBookmarks()
```

Removes all detected bookmarks from the document.

##### clearFields()
```
public final void clearFields()
```

Removes all detected form fields from the document.

##### clearDigitalSignatures()
```
public final void clearDigitalSignatures()
```

Removes all detected digital signatures from the document.

### PdfPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class PdfPackage extends DocumentPackage
```

Represents native metadata in a PDF document.

This code snippet demonstrates how to update built-in metadata properties in a PDF document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      PdfRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedDate(new Date());
>      root.getDocumentProperties().setTitle("test title");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the document author. |
| setAuthor(String value) | Sets the document author. |
| getCreatedDate() | Gets the date of document creation. |
| setCreatedDate(Date value) | Sets the date of document creation. |
| getCreator() | Gets the creator of the document. |
| setCreator(String value) | Gets the creator of the document. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getModifiedDate() | Gets the date of the last modification. |
| setModifiedDate(Date value) | Sets the date of the last modification. |
| getProducer() | Gets the document producer. |
| setProducer(String value) | Gets the document producer. |
| getSubject() | Gets the subject of the document. |
| setSubject(String value) | Sets the subject of the document. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getTrappedFlag() | Gets the trapped flag. |
| setTrappedFlag(Boolean value) | Sets the trapped flag. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the document author.

**Returns:**
java.lang.String - The document author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document author.

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

##### getCreatedDate()
```
public final Date getCreatedDate()
```

Gets the date of document creation.

**Returns:**
java.util.Date - The date of document creation.
##### setCreatedDate(Date value)
```
public final void setCreatedDate(Date value)
```

Sets the date of document creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of document creation. |

##### getCreator()
```
public final String getCreator()
```

Gets the creator of the document.

**Returns:**
java.lang.String - The creator of the document.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Gets the creator of the document.

Value: The creator of the document.

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

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

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

Sets the keywords.

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

##### getModifiedDate()
```
public final Date getModifiedDate()
```

Gets the date of the last modification.

**Returns:**
java.util.Date - The date of the last modification.
##### setModifiedDate(Date value)
```
public final void setModifiedDate(Date value)
```

Sets the date of the last modification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of the last modification. |

##### getProducer()
```
public final String getProducer()
```

Gets the document producer.

**Returns:**
java.lang.String - The document producer.
##### setProducer(String value)
```
public final void setProducer(String value)
```

Gets the document producer.

Value: The document producer.

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

##### getSubject()
```
public final String getSubject()
```

Gets the subject of the document.

**Returns:**
java.lang.String - The subject of the document.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject of the document. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title of the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the document. |

##### getTrappedFlag()
```
public final Boolean getTrappedFlag()
```

Gets the trapped flag.

**Returns:**
java.lang.Boolean -  true  if the trapped flag is set; otherwise,  false .
##### setTrappedFlag(Boolean value)
```
public final void setTrappedFlag(Boolean value)
```

Sets the trapped flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the trapped flag is set; otherwise,  false . |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

### PdfRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class PdfRootPackage extends DocumentRootPackage<PdfPackage> implements IXmp
```

Represents the root package allowing working with metadata in a PDF document.

This code sample shows how to extract built-in metadata properties from a PDF document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      PdfRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedDate());
>      System.out.println(root.getDocumentProperties().getSubject());
>      System.out.println(root.getDocumentProperties().getProducer());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getPdfType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
##### getPdfType()
```
public final PdfTypePackage getPdfType()
```

Gets the file type metadata package.

**Returns:**
PdfTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final PdfInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
PdfInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

### PdfTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pdftypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class PdfTypePackage extends FileTypePackage
```

Represents a metadata package containing PDF-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the format. |
##### getVersion()
```
public final String getVersion()
```

Gets the version of the format.

**Returns:**
java.lang.String - The version of the format.

### PngCompressedTextChunk
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pngcompressedtextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.PngTextChunk
```
public class PngCompressedTextChunk extends PngTextChunk
```

Represents compressed textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| getCompressionMethod() | Gets the algorithm used to compress the chunk data. |
##### getCompressionMethod()
```
public final PngCompressionMethod getCompressionMethod()
```

Gets the algorithm used to compress the chunk data.

**Returns:**
PngCompressionMethod - The algorithm used to compress the chunk data.

### PngCompressionMethod
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pngcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PngCompressionMethod extends Enum<PngCompressionMethod> implements IEnumValue
```

Defines compression methods used in the PNG format.
#### Fields

| Field | Description |
| --- | --- |
| Deflate | Represents the deflate/inflate compression with a sliding window. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Deflate
```
public static final PngCompressionMethod Deflate
```

Represents the deflate/inflate compression with a sliding window.

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

**Returns:**
com.groupdocs.metadata.core.PngCompressionMethod[]
##### valueOf(String name)
```
public static PngCompressionMethod valueOf(String name)
```

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

**Returns:**
PngCompressionMethod
##### getByRawValue(int rawValue)
```
public static PngCompressionMethod getByRawValue(int rawValue)
```

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

**Returns:**
PngCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PngInternationalTextChunk
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pnginternationaltextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.PngTextChunk, com.groupdocs.metadata.core.PngCompressedTextChunk
```
public class PngInternationalTextChunk extends PngCompressedTextChunk
```

Represents international textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| isCompressed() | Gets a value indicating whether the chunk is compressed. |
| getLanguage() | Gets the human language used by the translated keyword and the text. |
| getTranslatedKeyword() | Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property. |
##### isCompressed()
```
public final boolean isCompressed()
```

Gets a value indicating whether the chunk is compressed.

**Returns:**
boolean - True, if the chunk is compressed; otherwise, false.
##### getLanguage()
```
public final String getLanguage()
```

Gets the human language used by the translated keyword and the text.

**Returns:**
java.lang.String - The human language used by the translated keyword and the text.
##### getTranslatedKeyword()
```
public final String getTranslatedKeyword()
```

Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property.

**Returns:**
java.lang.String - The translated keyword that contains a translation of the keyword into the language indicated by the language property.

### PngPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pngpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PngPackage extends CustomPackage
```

Represents native PNG metadata.
#### Methods

| Method | Description |
| --- | --- |
| getTextChunks() | Gets the collection of text chunks extracted from the image. |
##### getTextChunks()
```
public final PngTextChunk[] getTextChunks()
```

Gets the collection of text chunks extracted from the image.

**Returns:**
com.groupdocs.metadata.core.PngTextChunk[] - The collection of text chunks extracted from the image.

### PngRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pngrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class PngRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a PNG image.

[Working with metadata in PNG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PNG+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getPngPackage() | Gets the PNG native metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getPngPackage()
```
public final PngPackage getPngPackage()
```

Gets the PNG native metadata package.

**Returns:**
PngPackage - The PNG native metadata package.

### PngTextChunk
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/pngtextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PngTextChunk extends CustomPackage
```

Represents textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| getKeyword() | Gets the keyword that indicates the type of information represented by the chunk. |
| getText() | Gets the actual text string represented by the chunk. |
##### getKeyword()
```
public final String getKeyword()
```

Gets the keyword that indicates the type of information represented by the chunk.

**Returns:**
java.lang.String - The keyword that indicates the type of information represented by the chunk.
##### getText()
```
public final String getText()
```

Gets the actual text string represented by the chunk.

**Returns:**
java.lang.String - The actual text string represented by the chunk.

### PresentationComment
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationComment extends CustomPackage
```

Represents a user comment in a presentation.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the comment. |
| getCreatedTime() | Gets the created time of the comment. |
| getSlideNumber() | Gets the slide number the comment belongs to. |
| getText() | Gets the text of the comment. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the comment.

**Returns:**
java.lang.String - The author of the comment.
##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the created time of the comment.

**Returns:**
java.util.Date - The created time of the comment.
##### getSlideNumber()
```
public final int getSlideNumber()
```

Gets the slide number the comment belongs to.

**Returns:**
int - The slide number the comment belongs to.
##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The comment text.

### PresentationFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PresentationFormat extends Enum<PresentationFormat> implements IEnumValue
```

Defines various presentation subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Ppt | Represents the .PPT PowerPoint format. |
| Pptx | Represents the .PPTX PowerPoint format. |
| Potm | Represents the .POTM PowerPoint format. |
| Potx | Represents the .POTX PowerPoint format. |
| Pptm | Represents the .PPTM PowerPoint format. |
| Pps | Represents the .PPS PowerPoint format. |
| Ppsx | Represents the .PPSX PowerPoint format. |
| Ppsm | Represents the .PPSM PowerPoint format. |
| Pot | Represents the .POT PowerPoint format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final PresentationFormat Unknown
```

The format is not recognized.

##### Ppt
```
public static final PresentationFormat Ppt
```

Represents the .PPT PowerPoint format. 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. A PPT file can contain several different types of information such as text, bulleted points, images, multimedia and other embedded OLE objects. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppt/

##### Pptx
```
public static final PresentationFormat Pptx
```

Represents the .PPTX PowerPoint format. 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/

##### Potm
```
public static final PresentationFormat Potm
```

Represents the .POTM PowerPoint format. 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/

##### Potx
```
public static final PresentationFormat Potx
```

Represents the .POTX PowerPoint format. Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. This format was created to replace the POT file format that is based on the binary file format and is supported with PowerPoint 97-2003. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/potx/

##### Pptm
```
public static final PresentationFormat Pptm
```

Represents the .PPTM PowerPoint format. Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. They are similar to PPTX files with the difference that the lateral can't execute macros though they can contain macros. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pptm/

##### Pps
```
public static final PresentationFormat Pps
```

Represents the .PPS PowerPoint format. 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/

##### Ppsx
```
public static final PresentationFormat Ppsx
```

Represents the .PPSX PowerPoint format. PPSX, Power Point Slide Show, files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. It is an update to the PPS file format that was supported by Microsoft PowerPoint 97-2003 versions. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsx/

##### Ppsm
```
public static final PresentationFormat Ppsm
```

Represents the .PPSM PowerPoint format. Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Another similar file format is PPTM which differs in opening with Microsoft PowerPoint in editable format instead of running as Slide Show Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsm/

##### Pot
```
public static final PresentationFormat Pot
```

Represents the .POT PowerPoint format. Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Files created with these versions of Microsoft PowerPoint are in binary format as compared to those created in Office OpenXML file formats using the higher versions of PowerPoint. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pot/

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

**Returns:**
com.groupdocs.metadata.core.PresentationFormat[]
##### valueOf(String name)
```
public static PresentationFormat valueOf(String name)
```

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

**Returns:**
PresentationFormat
##### getByRawValue(int rawValue)
```
public static PresentationFormat getByRawValue(int rawValue)
```

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

**Returns:**
PresentationFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PresentationInspectionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationInspectionPackage extends CustomPackage
```

Contains information about presentation parts that can be considered as metadata in some cases.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getHiddenSlides() | Gets an array of the hidden slides. |
| getComments() | Gets an array of the comments. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the presentation. |
| clearHiddenSlides() | Removes all detected hidden slides from the presentation. |
| sanitize() | Removes writable metadata properties from the package. |
##### getHiddenSlides()
```
public final PresentationSlide[] getHiddenSlides()
```

Gets an array of the hidden slides.

**Returns:**
com.groupdocs.metadata.core.PresentationSlide[] - The hidden slides.
##### getComments()
```
public final PresentationComment[] getComments()
```

Gets an array of the comments.

**Returns:**
com.groupdocs.metadata.core.PresentationComment[] - The comments.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the presentation.

##### clearHiddenSlides()
```
public final void clearHiddenSlides()
```

Removes all detected hidden slides from the presentation.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### PresentationPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class PresentationPackage extends DocumentPackage
```

Represents a native metadata package in a presentation.

This example demonstrates how to update built-in metadata properties in a presentation.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      PresentationRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputPptx);
>  }
>
> ```
> ```

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getApplicationTemplate() | Gets the application template. |
| setApplicationTemplate(String value) | Sets the application template. |
| getAuthor() | Gets the document's author. |
| setAuthor(String value) | Sets the document's author. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastPrintedDate() | Gets the last printed date. |
| setLastPrintedDate(Date value) | Sets the last printed date. |
| getLastSavedTime() | Gets the date and time when the presentation was modified last time. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of the application created the document. |
| getRevisionNumber() | Gets the revision number. |
| setRevisionNumber(int value) | Sets the revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getVersion() | Gets the application version. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getPresentationFormat() | Gets the presentation format. |
| getSharedDoc() | Gets a value indicating whether the presentation is shared between multiple people. |
| setSharedDoc(boolean value) | Sets a value indicating whether the presentation is shared between multiple people. |
| getTotalEditingTime() | Gets the total editing time of the document. |
| setTotalEditingTime(double value) | Sets the total editing time of the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getApplicationTemplate()
```
public final String getApplicationTemplate()
```

Gets the application template.

**Returns:**
java.lang.String - The application template.
##### setApplicationTemplate(String value)
```
public final void setApplicationTemplate(String value)
```

Sets the application template.

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

##### getAuthor()
```
public final String getAuthor()
```

Gets the document's author.

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

Sets the document's author.

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

##### getCategory()
```
public final String getCategory()
```

Gets the category.

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

Sets the category.

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

##### getComments()
```
public final String getComments()
```

Gets the comments.

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

Sets the comments.

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

##### getCompany()
```
public final String getCompany()
```

Gets the company.

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

Sets the company.

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

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status. Can be updated in a PPTX document only.

**Returns:**
java.lang.String - The content status.

Can be updated in a PPTX document only. Read-only for other supported formats.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status. Can be updated in a PPTX document only.

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

Can be updated in a PPTX document only. Read-only for other supported formats. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type. Can be updated in a PPTX document only.

**Returns:**
java.lang.String - The type of the content.

Can be updated in a PPTX document only. Read-only for other supported formats.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type. Can be updated in a PPTX document only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content.

Can be updated in a PPTX document only. Read-only for other supported formats. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The document created date.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The document created date. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

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

Sets the keywords.

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

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the date and time when the presentation was modified last time.

**Returns:**
java.util.Date - The last saved time.
##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The last saved by.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The last saved by. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

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

Sets the manager.

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

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of the application created the document.

**Returns:**
java.lang.String - The name of the application.
##### getRevisionNumber()
```
public final int getRevisionNumber()
```

Gets the revision number.

**Returns:**
int - The revision number.
##### setRevisionNumber(int value)
```
public final void setRevisionNumber(int value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The revision number. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

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

Sets the subject.

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

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

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

Sets the title of the document.

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

##### getVersion()
```
public final String getVersion()
```

Gets the application version.

**Returns:**
java.lang.String - The application version.
##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.

Read-only in old PPT.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

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

Read-only in old PPT. |

##### getPresentationFormat()
```
public final String getPresentationFormat()
```

Gets the presentation format.

**Returns:**
java.lang.String - The presentation format.
##### getSharedDoc()
```
public final boolean getSharedDoc()
```

Gets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

**Returns:**
boolean -  true  if the presentation shared between multiple people; otherwise,  false .

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc.
##### setSharedDoc(boolean value)
```
public final void setSharedDoc(boolean value)
```

Sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if the presentation shared between multiple people; otherwise,  false .

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc. |

##### getTotalEditingTime()
```
public final double getTotalEditingTime()
```

Gets the total editing time of the document.

**Returns:**
double - The total editing time of the document.
##### setTotalEditingTime(double value)
```
public final void setTotalEditingTime(double value)
```

Sets the total editing time of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The total editing time of the document. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### PresentationRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class PresentationRootPackage extends DocumentRootPackage<PresentationPackage>
```

Represents the root package intended to work with metadata in a presentation.

This example shows how to extract built-in metadata properties from a presentation.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPpt)) {
>      PresentationRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLastPrintedDate());
>      System.out.println(root.getDocumentProperties().getNameOfApplication());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getPresentationType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getPresentationType()
```
public final PresentationTypePackage getPresentationType()
```

Gets the file type metadata package.

**Returns:**
PresentationTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final PresentationInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
PresentationInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### PresentationSlide
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationSlide extends CustomPackage
```

Represents a slide in a presentation.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the slide name. |
| getNumber() | Gets the slide number. |
| getSlideId() | Gets the slide id. |
##### getName()
```
public final String getName()
```

Gets the slide name.

**Returns:**
java.lang.String - The slide name.
##### getNumber()
```
public final int getNumber()
```

Gets the slide number.

**Returns:**
int - The slide number.
##### getSlideId()
```
public final long getSlideId()
```

Gets the slide id.

**Returns:**
long - The slide identifier.

### PresentationTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/presentationtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class PresentationTypePackage extends FileTypePackage
```

Represents a metadata package containing presentation-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getPresentationFormat() | Gets the exact presentation format. |
##### getPresentationFormat()
```
public final PresentationFormat getPresentationFormat()
```

Gets the exact presentation format.

**Returns:**
PresentationFormat - The exact presentation format.

### ProjectManagementPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/projectmanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public final class ProjectManagementPackage extends DocumentPackage
```

Represents a native metadata package in a project management file.

This code sample demonstrates how to update built-in properties in a ProjectManagement document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMpp)) {
>      ProjectManagementRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreationDate(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setComments("test comment");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputMpp);
>  }
>
> ```
> ```

[Working with metadata in ProjectManagement formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+ProjectManagement+formats
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the project. |
| setAuthor(String value) | Sets the author of the project. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the user comments. |
| setComments(String value) | Sets the user comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getCreationDate() | Gets the creation date. |
| setCreationDate(Date value) | Sets the creation date. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastAuthor() | Gets the last author. |
| setLastAuthor(String value) | Sets the last author. |
| getRevision() | Gets the revision number. |
| setRevision(int value) | Sets the revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTitle() | Gets the title. |
| setTitle(String value) | Sets the title. |
| getTemplate() | Gets the template. |
| setTemplate(String value) | Sets the template. |
| getManager() | Gets the project manager. |
| setManager(String value) | Sets the project manager. |
| getLastSaved() | Gets the date when the project was saved last time. |
| setLastSaved(Date value) | Sets the date when the project was saved last time. |
| getSaveVersion() | Gets the version of Microsoft Office Project from which a project file was saved. |
| getLastPrinted() | Gets the project's last print time. |
| setLastPrinted(Date value) | Sets the project's last print time. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the project.

**Returns:**
java.lang.String - The author of the project.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author of the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author of the project. |

##### getCategory()
```
public final String getCategory()
```

Gets the category.

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

Sets the category.

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

##### getComments()
```
public final String getComments()
```

Gets the user comments.

**Returns:**
java.lang.String - The user comments.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the user comments.

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

##### getCompany()
```
public final String getCompany()
```

Gets the company.

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

Sets the company.

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

##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the creation date.

**Returns:**
java.util.Date - The creation date.
##### setCreationDate(Date value)
```
public final void setCreationDate(Date value)
```

Sets the creation date.

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

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

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

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

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

Sets the keywords.

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

##### getLastAuthor()
```
public final String getLastAuthor()
```

Gets the last author.

**Returns:**
java.lang.String - The last author.
##### setLastAuthor(String value)
```
public final void setLastAuthor(String value)
```

Sets the last author.

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

##### getRevision()
```
public final int getRevision()
```

Gets the revision number.

**Returns:**
int - The revision number.
##### setRevision(int value)
```
public final void setRevision(int value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The revision number. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

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

Sets the subject.

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

##### getTitle()
```
public final String getTitle()
```

Gets the title.

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

Sets the title.

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

##### getTemplate()
```
public final String getTemplate()
```

Gets the template.

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

Sets the template.

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

##### getManager()
```
public final String getManager()
```

Gets the project manager.

**Returns:**
java.lang.String - The project manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the project manager.

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

##### getLastSaved()
```
public final Date getLastSaved()
```

Gets the date when the project was saved last time.

**Returns:**
java.util.Date - The date when the project was saved last time.
##### setLastSaved(Date value)
```
public final void setLastSaved(Date value)
```

Sets the date when the project was saved last time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date when the project was saved last time. |

##### getSaveVersion()
```
public final int getSaveVersion()
```

Gets the version of Microsoft Office Project from which a project file was saved.

**Returns:**
int - The version of Microsoft Office Project from which a project file was saved.
##### getLastPrinted()
```
public final Date getLastPrinted()
```

Gets the project's last print time.

**Returns:**
java.util.Date - The project's last print time.
##### setLastPrinted(Date value)
```
public final void setLastPrinted(Date value)
```

Sets the project's last print time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The project's last print time. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

### ProjectManagementRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/projectmanagementrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class ProjectManagementRootPackage extends DocumentRootPackage<ProjectManagementPackage>
```

Represents the root package intended to work with metadata in a project management format.

This code sample demonstrates how to extract built-in properties of a ProjectManagement document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMpp)) {
>      ProjectManagementRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreationDate());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getRevision());
>      System.out.println(root.getDocumentProperties().getSubject());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in ProjectManagement formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+ProjectManagement+formats

### PropertyAccessLevels
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/propertyaccesslevels.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class PropertyAccessLevels implements IEnumValue
```

Defines access levels for metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Read | The property is read-only. |
| Update | It is possible to update the property using the  MetadataPackage.UpdateProperties  method. |
| Remove | The property can be removed through the  MetadataPackage.RemoveProperties  method. |
| Add | It is possible to update the property using the  MetadataPackage.AddProperties  method. |
| Full | Grants full access to the property. |
| AddOrUpdate | It is allowed to add and update the property. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Read
```
public static final PropertyAccessLevels Read
```

The property is read-only.

##### Update
```
public static final PropertyAccessLevels Update
```

It is possible to update the property using the  MetadataPackage.UpdateProperties  method.

##### Remove
```
public static final PropertyAccessLevels Remove
```

The property can be removed through the  MetadataPackage.RemoveProperties  method.

##### Add
```
public static final PropertyAccessLevels Add
```

It is possible to update the property using the  MetadataPackage.AddProperties  method.

##### Full
```
public static final PropertyAccessLevels Full
```

Grants full access to the property.

##### AddOrUpdate
```
public static final PropertyAccessLevels AddOrUpdate
```

It is allowed to add and update the property. All other operations are restricted.

##### getByRawValue(int rawValue)
```
public static PropertyAccessLevels getByRawValue(int rawValue)
```

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

**Returns:**
PropertyAccessLevels
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### PropertyDescriptor
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/propertydescriptor.md

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

Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getType() | Gets the property type. |
| getAccessLevel() | Gets the property access level. |
| getTags() | Gets a collection of tags associated with the property. |
| getInterpreter() | Gets the property value interpreter. |
##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getType()
```
public final MetadataPropertyType getType()
```

Gets the property type.

**Returns:**
MetadataPropertyType - The property type.
##### getAccessLevel()
```
public PropertyAccessLevels getAccessLevel()
```

Gets the property access level.

**Returns:**
PropertyAccessLevels - The property access level.
##### getTags()
```
public final IReadOnlyList<PropertyTag> getTags()
```

Gets a collection of tags associated with the property.

**Returns:**
IReadOnlyList - A collection of tags associated with the property.
##### getInterpreter()
```
public final ValueInterpreter getInterpreter()
```

Gets the property value interpreter.

**Returns:**
ValueInterpreter - The property value interpreter.

### PropertyValue
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/propertyvalue.md

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

Represents a property value.
#### Constructors

| Constructor | Description |
| --- | --- |
| PropertyValue(int value) | Initializes a new instance of the  PropertyValue  class with an integer value. |
| PropertyValue(long value) | Initializes a new instance of the  PropertyValue  class with a long value. |
| PropertyValue(boolean value) | Initializes a new instance of the  PropertyValue  class with a boolean value. |
| PropertyValue(double value) | Initializes a new instance of the  PropertyValue  class with a double value. |
| PropertyValue(String value) | Initializes a new instance of the  PropertyValue  class with a string value. |
| PropertyValue(Date value) | Initializes a new instance of the  PropertyValue  class with a  DateTime  value. |
| PropertyValue(String[] values) | Initializes a new instance of the  PropertyValue  class with a string array. |
| PropertyValue(byte[] values) | Initializes a new instance of the  PropertyValue  class with a byte array. |
| PropertyValue(double[] values) | Initializes a new instance of the  PropertyValue  class with an array of double values. |
| PropertyValue(int[] values) | Initializes a new instance of the  PropertyValue  class with an array of integer values. |
| PropertyValue(long[] values) | Initializes a new instance of the  PropertyValue  class with an array of long values. |
| PropertyValue(PropertyValue[] values) | Initializes a new instance of the  PropertyValue  class with an array of metadata property values. |
| PropertyValue(PropertyValue value) |  |
| PropertyValue(UUID value) |  |
| PropertyValue(Object value) | Initializes a new instance of the  PropertyValue  class with a generic object value. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Gets the  MetadataPropertyType . |
| getRawValue() | Gets the raw value. |
| getEmpty() |  |
| <TElement>toArray(Class<TElement> elementType) | Converts the property value to an array of the specified type. |
| <T>toClass(Class<T> type) | Converts the property value to a reference type. |
| toString() | Returns a string that represents the property value. |
| acceptValue(ValueAcceptor valueAcceptor) | Extracts the property value using a custom ValueAcceptor. |
##### PropertyValue(int value)
```
public PropertyValue(int value)
```

Initializes a new instance of the  PropertyValue  class with an integer value.

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

##### PropertyValue(long value)
```
public PropertyValue(long value)
```

Initializes a new instance of the  PropertyValue  class with a long value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | A  long  value. |

##### PropertyValue(boolean value)
```
public PropertyValue(boolean value)
```

Initializes a new instance of the  PropertyValue  class with a boolean value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A  bool  value. |

##### PropertyValue(double value)
```
public PropertyValue(double value)
```

Initializes a new instance of the  PropertyValue  class with a double value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | A  double  value. |

##### PropertyValue(String value)
```
public PropertyValue(String value)
```

Initializes a new instance of the  PropertyValue  class with a string value.

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

##### PropertyValue(Date value)
```
public PropertyValue(Date value)
```

Initializes a new instance of the  PropertyValue  class with a  DateTime  value.

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

##### PropertyValue(String[] values)
```
public PropertyValue(String[] values)
```

Initializes a new instance of the  PropertyValue  class with a string array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | java.lang.String[] | A string array. |

##### PropertyValue(byte[] values)
```
public PropertyValue(byte[] values)
```

Initializes a new instance of the  PropertyValue  class with a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | byte[] | A byte array. |

##### PropertyValue(double[] values)
```
public PropertyValue(double[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of double values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | double[] | An array of double values. |

##### PropertyValue(int[] values)
```
public PropertyValue(int[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of integer values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | int[] | An array of integer values. |

##### PropertyValue(long[] values)
```
public PropertyValue(long[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of long values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | long[] | An array of long values. |

##### PropertyValue(PropertyValue[] values)
```
public PropertyValue(PropertyValue[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of metadata property values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | PropertyValue\[\] | An array of metadata property values. |

##### PropertyValue(PropertyValue value)
```
public PropertyValue(PropertyValue value)
```

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

##### PropertyValue(UUID value)
```
public PropertyValue(UUID value)
```

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

##### PropertyValue(Object value)
```
public PropertyValue(Object value)
```

Initializes a new instance of the  PropertyValue  class with a generic object value.

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

##### getType()
```
public final MetadataPropertyType getType()
```

Gets the  MetadataPropertyType .

**Returns:**
MetadataPropertyType - The type of the property.
##### getRawValue()
```
public final Object getRawValue()
```

Gets the raw value.

**Returns:**
java.lang.Object - The raw value.
##### getEmpty()
```
public static PropertyValue getEmpty()
```

**Returns:**
PropertyValue
##### <TElement>toArray(Class<TElement> elementType)
```
public final TElement[] <TElement>toArray(Class<TElement> elementType)
```

Converts the property value to an array of the specified type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| elementType | java.lang.Class<TElement> |  |

**Returns:**
TElement[] - The value represented as an array of the specified type or null if there is no such conversion.

 TElement : The type of an element.
##### <T>toClass(Class<T> type)
```
public final T <T>toClass(Class<T> type)
```

Converts the property value to a reference type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T - The converted value or null if there is no such conversion.

 T : The exact type to convert to.
##### toString()
```
public String toString()
```

Returns a string that represents the property value.

**Returns:**
java.lang.String - A string that represents the property value.
##### acceptValue(ValueAcceptor valueAcceptor)
```
public void acceptValue(ValueAcceptor valueAcceptor)
```

Extracts the property value using a custom ValueAcceptor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueAcceptor | ValueAcceptor | An acceptor that extracts the value. |

### PsdColorMode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PsdColorMode extends Enum<PsdColorMode> implements IEnumValue
```

Represents the psd file format color mode.
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | The bitmap color mode. |
| Grayscale | The grayscale mode. |
| Indexed | The indexed color mode. |
| Rgb | The RGB color mode. |
| Cmyk | The CMYK color mode. |
| Multichannel | The multichannel color mode. |
| Duotone | The duotone color mode. |
| Lab | The LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Bitmap
```
public static final PsdColorMode Bitmap
```

The bitmap color mode.

##### Grayscale
```
public static final PsdColorMode Grayscale
```

The grayscale mode.

##### Indexed
```
public static final PsdColorMode Indexed
```

The indexed color mode.

##### Rgb
```
public static final PsdColorMode Rgb
```

The RGB color mode.

##### Cmyk
```
public static final PsdColorMode Cmyk
```

The CMYK color mode.

##### Multichannel
```
public static final PsdColorMode Multichannel
```

The multichannel color mode.

##### Duotone
```
public static final PsdColorMode Duotone
```

The duotone color mode.

##### Lab
```
public static final PsdColorMode Lab
```

The LAB color mode.

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

**Returns:**
com.groupdocs.metadata.core.PsdColorMode[]
##### valueOf(String name)
```
public static PsdColorMode valueOf(String name)
```

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

**Returns:**
PsdColorMode
##### getByRawValue(int rawValue)
```
public static PsdColorMode getByRawValue(int rawValue)
```

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

**Returns:**
PsdColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PsdCompressionMethod
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PsdCompressionMethod extends Enum<PsdCompressionMethod> implements IEnumValue
```

Defines the compression method used for image data.
#### Fields

| Field | Description |
| --- | --- |
| Raw | No compression. |
| Rle | RLE compressed. |
| ZipWithoutPrediction | ZIP without prediction. |
| ZipWithPrediction | ZIP with prediction. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Raw
```
public static final PsdCompressionMethod Raw
```

No compression. The image data stored as raw bytes in RGBA planar order. That means that first all R data is written, then all G is written, then all B and finally all A data is written.

##### Rle
```
public static final PsdCompressionMethod Rle
```

RLE compressed. The image data starts with the byte counts for all the scan lines (rows \* channels), with each count stored as a two-byte value. The RLE compressed data follows, with each scan line compressed separately. The RLE compression is the same compression algorithm used by the Macintosh ROM routine PackBits and the TIFF standard.

##### ZipWithoutPrediction
```
public static final PsdCompressionMethod ZipWithoutPrediction
```

ZIP without prediction.

##### ZipWithPrediction
```
public static final PsdCompressionMethod ZipWithPrediction
```

ZIP with prediction.

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

**Returns:**
com.groupdocs.metadata.core.PsdCompressionMethod[]
##### valueOf(String name)
```
public static PsdCompressionMethod valueOf(String name)
```

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

**Returns:**
PsdCompressionMethod
##### getByRawValue(int rawValue)
```
public static PsdCompressionMethod getByRawValue(int rawValue)
```

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

**Returns:**
PsdCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PsdLayer
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdlayer.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PsdLayer extends CustomPackage
```

Represents a layer in a PSD file.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets the bits per pixel value. |
| getChannelCount() | Gets the number of channels. |
| getFlags() | Gets the layer flags. |
| getLength() | Gets the overall layer length in bytes. |
| getOpacity() | Gets the layer opacity. |
| getTop() | Gets the top layer position. |
| getLeft() | Gets the left layer position. |
| getBottom() | Gets the bottom layer position. |
| getRight() | Gets the right layer position. |
| getHeight() | Gets the height. |
| getWidth() | Gets the width. |
| getName() | Gets the layer name. |
##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets the bits per pixel value.

**Returns:**
int - The bits per pixel value.
##### getChannelCount()
```
public final int getChannelCount()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getFlags()
```
public final PsdLayerFlags getFlags()
```

Gets the layer flags.

**Returns:**
PsdLayerFlags - The flags.
##### getLength()
```
public final long getLength()
```

Gets the overall layer length in bytes.

**Returns:**
long - The overall layer length in bytes.
##### getOpacity()
```
public final byte getOpacity()
```

Gets the layer opacity. 0 = transparent, 255 = opaque.

**Returns:**
byte - The opacity.
##### getTop()
```
public final int getTop()
```

Gets the top layer position.

**Returns:**
int - The top layer position.
##### getLeft()
```
public final int getLeft()
```

Gets the left layer position.

**Returns:**
int - The left layer position.
##### getBottom()
```
public final int getBottom()
```

Gets the bottom layer position.

**Returns:**
int - The bottom layer position.
##### getRight()
```
public final int getRight()
```

Gets the right layer position.

**Returns:**
int - The right layer position.
##### getHeight()
```
public final int getHeight()
```

Gets the height.

**Returns:**
int - The height.
##### getWidth()
```
public final int getWidth()
```

Gets the width.

**Returns:**
int - The width.
##### getName()
```
public final String getName()
```

Gets the layer name.

**Returns:**
java.lang.String - The layer name.

### PsdLayerFlags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdlayerflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class PsdLayerFlags implements IEnumValue
```

The Photoshop layer flags.
#### Fields

| Field | Description |
| --- | --- |
| None | No flags are set. |
| TransparencyProtected | The transparency protected flag. |
| Visible | The visibility flag. |
| Obsolete | The obsolete flag. |
| HasUsefulInformation | Defines if bit 4 has useful information. |
| PixelDataIrrelevantToAppearanceInDocument | The pixel data is irrelevant to appearance in a document. |
| Undocumented | An undocumented flag. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final PsdLayerFlags None
```

No flags are set.

##### TransparencyProtected
```
public static final PsdLayerFlags TransparencyProtected
```

The transparency protected flag.

##### Visible
```
public static final PsdLayerFlags Visible
```

The visibility flag.

##### Obsolete
```
public static final PsdLayerFlags Obsolete
```

The obsolete flag.

##### HasUsefulInformation
```
public static final PsdLayerFlags HasUsefulInformation
```

Defines if bit 4 has useful information. 1 for Photoshop 5.0 and later,

##### PixelDataIrrelevantToAppearanceInDocument
```
public static final PsdLayerFlags PixelDataIrrelevantToAppearanceInDocument
```

The pixel data is irrelevant to appearance in a document.

##### Undocumented
```
public static final PsdLayerFlags Undocumented
```

An undocumented flag.

##### getByRawValue(int rawValue)
```
public static PsdLayerFlags getByRawValue(int rawValue)
```

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

**Returns:**
PsdLayerFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### PsdPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PsdPackage extends CustomPackage
```

Represents native Photoshop metadata.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getChannelCount() | Gets the number of channels. |
| getColorMode() | Gets the psd color mode. |
| getCompression() | Gets the compression method used for image data. |
| getPhotoshopVersion() | Gets the Photoshop version. |
| getHeight() | Gets the height of the image. |
| getWidth() | Gets PSD width of the image. |
| getLayers() | Gets the Photoshop layers. |
##### getChannelCount()
```
public final int getChannelCount()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getColorMode()
```
public final PsdColorMode getColorMode()
```

Gets the psd color mode.

**Returns:**
PsdColorMode - The color mode.
##### getCompression()
```
public final PsdCompressionMethod getCompression()
```

Gets the compression method used for image data.

**Returns:**
PsdCompressionMethod - The compression method.
##### getPhotoshopVersion()
```
public final int getPhotoshopVersion()
```

Gets the Photoshop version.

**Returns:**
int - The photoshop version.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the image.

**Returns:**
int - The height of the image.
##### getWidth()
```
public final int getWidth()
```

Gets PSD width of the image.

**Returns:**
int - The width of the image.
##### getLayers()
```
public final PsdLayer[] getLayers()
```

Gets the Photoshop layers.

**Returns:**
com.groupdocs.metadata.core.PsdLayer[] - The Photoshop layers.

### PsdRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/psdrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IIptc, com.groupdocs.metadata.core.IExif
```
public class PsdRootPackage extends ImageRootPackage implements IXmp, IIptc, IExif
```

Represents the root package allowing working with metadata in a Photoshop Document.

This code sample demonstrates how to read the header of a PSD file and extract some information about the PSD layers.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.PsdWithIptc)) {
>      PsdRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getPsdPackage().getChannelCount());
>      System.out.println(root.getPsdPackage().getColorMode());
>      System.out.println(root.getPsdPackage().getCompression());
>      System.out.println(root.getPsdPackage().getPhotoshopVersion());
>      for (PsdLayer layer : root.getPsdPackage().getLayers()) {
>          System.out.println(layer.getName());
>          System.out.println(layer.getBitsPerPixel());
>          System.out.println(layer.getChannelCount());
>          System.out.println(layer.getFlags());
>          System.out.println(layer.getHeight());
>          System.out.println(layer.getWidth());
>          // ...
>      }
>      // ...
>  }
>
> ```
> ```

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
| getImageResourcePackage() | Gets the Photoshop Image Resource metadata package. |
| getPsdPackage() | Gets the metadata package containing information about the PSD file. |
| copyTo(MetadataPackage metadata) |  |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

##### getImageResourcePackage()
```
public final ImageResourcePackage getImageResourcePackage()
```

Gets the Photoshop Image Resource metadata package. Image resource blocks are the basic building unit of Photoshop native file format.

**Returns:**
ImageResourcePackage - The Image Resource metadata package.
##### getPsdPackage()
```
public final PsdPackage getPsdPackage()
```

Gets the metadata package containing information about the PSD file.

**Returns:**
PsdPackage - The metadata package containing information about the PSD file.
##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### RarFile
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rarfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RarFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getName() | Gets the entry name. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

Value: The compressed size in bytes.

**Returns:**
long
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

Value: The uncompressed size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

Value: The last modification date and time.

**Returns:**
java.util.Date

### RarPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rarpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RarPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputRar))
>  {
>      var root = metadata.GetRootPackage<RarRootPackage>();
>      Console.WriteLine(root.RarPackage.TotalEntries);
>      foreach (var file in root.RarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final RarFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.RarFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### RarRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rarrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class RarRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputRar))
>  {
>      var root = metadata.GetRootPackage<RarRootPackage>();
>      Console.WriteLine(root.RarPackage.TotalEntries);
>      foreach (var file in root.RarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getRarPackage() | Gets the ZIP metadata package. |
##### getRarPackage()
```
public final RarPackage getRarPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
RarPackage

### RawDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawdictionarybasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class RawDictionaryBasePackage extends CustomPackage
```

Provides an abstract base class for EXIF metadata dictionaries.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
| get_Item(long tagId) | Gets the Raw tag with the specified id. |
| remove(long tagId) | Removes the property with the specified id. |
| set(RawTag tag) | Adds or replaces the specified tag. |
| clear() | Removes all Raw tags stored in the package. |
##### toList()
```
public final IReadOnlyList<RawTag> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all Raw tags from the package.
##### get_Item(long tagId)
```
public final RawTag get_Item(long tagId)
```

Gets the Raw tag with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | long | The id of the tag to retrieve. |

**Returns:**
RawTag - The  RawTag  with the specified tag id.
##### remove(long tagId)
```
public final boolean remove(long tagId)
```

Removes the property with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | long | A Raw tag id. |

**Returns:**
boolean - True if the specified Raw tag is found and removed; otherwise, false.
##### set(RawTag tag)
```
public final void set(RawTag tag)
```

Adds or replaces the specified tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | RawTag | The tag to set. |

##### clear()
```
public final void clear()
```

Removes all Raw tags stored in the package.

### RawExifTagPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawexiftagpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public abstract class RawExifTagPackage extends RawDictionaryBasePackage
```

Represents Exif tags.
#### Methods

| Method | Description |
| --- | --- |
| getRawMakerNotePackage() | Gets the Manufacturer notes (MakerNote). |
| getInteroperabilityIFDPointerPackage() | Gets the Interoperability tag (Interoperability IFD Pointer). |
| getInteroperabilityIFDPointer() | Gets the Interoperability tag (Interoperability IFD Pointer). |
| getExposureTime() | Gets the Exposure time. |
| getFNumber() | Gets the F number. |
| getExposureProgram() | Gets the Exposure program. |
| getSpectralSensitivity() | Gets the Spectral sensitivity. |
| getPhotographicSensitivity() | Gets the Photographic Sensitivity. |
| getOECF() | Gets the Optoelectric conversion factor. |
| getSensitivityType() | Gets the Sensitivity Type. |
| getStandardOutputSensitivity() | Gets the Standard Output Sensitivity. |
| getRecommendedExposureIndex() | Gets the Recommended ExposureIndexs. |
| getISOSpeed() | Gets the ISO Speed. |
| getISOSpeedLatitudeyyy() | Gets the ISO Speed Latitude yyy. |
| getISOSpeedLatitudezzz() | Gets the ISO Speed Latitude zzz. |
| getExifVersion() | Gets the ExifVersion. |
| getDateTimeOriginal() | Gets the Date and time of original data generation. |
| getDateTimeDigitized() | Gets the Date and time of digital data generation. |
| getOffsetTime() | Gets the Offset data of DateTime. |
| getOffsetTimeOriginal() | Gets the Offset data of DateTimeOriginal. |
| getOffsetTimeDigitized() | Gets the Offset data of DateTimeDigitized. |
| getComponentsConfiguration() | Gets the Meaning of each component. |
| getShutterSpeedValue() | Gets the Shutter speed. |
| getApertureValue() | Gets the Aperture. |
| getBrightnessValue() | Gets the Brightness. |
| getExposureBiasValue() | Gets the Exposure bias. |
| getMaxApertureValue() | Gets the Maximum lens aperture. |
| getSubjectDistance() | Gets the Subject distance. |
| getMeteringMode() | Gets the Metering mode. |
| getLightSource() | Gets the Light source. |
| getFlash() | Gets the Flash. |
| getFocalLength() | Gets the Lens focal length. |
| getSubjectArea() | Gets the Subject area. |
| getUserComment() | Gets the User comments. |
| getSubSecTime() | Gets the DateTime subseconds. |
| getSubSecTimeOriginal() | Gets the DateTimeOriginal subseconds. |
| getSubSecTimeDigitized() | Gets the DateTimeDigitized subseconds. |
| getTemperature() | Gets the Temperature. |
| getHumidity() | Gets the Humidity. |
| getPressure() | Gets the Pressure. |
| getWaterDepth() | Gets the WaterDepth. |
| getAcceleration() | Gets the Acceleration. |
| getCameraElevationAngle() | Gets the Camera elevation angle. |
| getFlashpixVersion() | Gets the Temperature. |
| getColorSpace() | Gets the Color space information . |
| getPixelXDimension() | Gets the Valid image width. |
| getPixelYDimension() | Gets the Valid image height. |
| getRelatedSoundFile() | Gets the Related audio file. |
| getFlashEnergy() | Gets the Flash energy. |
| getSpatialFrequencyResponse() | Gets the Spatial frequency response. |
| getFocalPlaneXResolution() | Gets Focal plane X resolution. |
| getFocalPlaneYResolution() | Gets the Focal plane Y resolution. |
| getFocalPlaneResolutionUnit() | Gets the Focal plane resolution unit. |
| getSubjectLocation() | Gets the Subject location. |
| getExposureIndex() | Gets the Exposure index. |
| getSensingMethod() | Gets the Sensing method. |
| getFileSource() | Gets the File source. |
| getSceneType() | Gets the Scene Type. |
| getCFAPattern() | Gets the CFA pattern. |
| getCustomRendered() | Gets the Custom image processing. |
| getExposureMode() | Gets the Exposure mode. |
| getWhiteBalance() | Gets the White balance. |
| getDigitalZoomRatio() | Gets the Digital zoom ratio. |
| getFocalLengthIn35mmFilm() | Gets the Focal length in 35 mm film. |
| getSceneCaptureType() | Gets the Scene capture type. |
| getGainControl() | Gets the Gain control. |
| getContrast() | Gets the Contrast. |
| getSaturation() | Gets the Saturation. |
| getSharpness() | Gets the Sharpness. |
| getDeviceSettingDescription() | Gets the Device settings description. |
| getSubjectDistanceRange() | Gets the Subject distance range. |
| getImageUniqueID() | Gets the Unique image ID. |
| getCameraOwnerName() | Gets the Camera Owner Name. |
| getBodySerialNumber() | Gets the Body Serial Number. |
| getLensSpecification() | Gets the Lens Specification. |
| getLensModel() | Gets the Lens Model. |
| getLensMake() | Gets the Lens Make. |
| getLensSerialNumber() | Gets the Lens Serial Number. |
| getCompositeImage() | Gets the Composite image. |
| getSourceImageNumberOfCompositeImage() | Gets the Source image number of composite image. |
| getSourceExposureTimesOfCompositeImage() | Gets the Source exposure times of composite image. |
| getGamma() | Gets the Gamma. |
| getMakerNote() | Gets the Standard Output Sensitivity. |
##### getRawMakerNotePackage()
```
public RawMakerNotePackage getRawMakerNotePackage()
```

Gets the Manufacturer notes (MakerNote).

**Returns:**
RawMakerNotePackage - The Manufacturer notes (MakerNote).
##### getInteroperabilityIFDPointerPackage()
```
public final InteroperabilityIFDPointerPackage getInteroperabilityIFDPointerPackage()
```

Gets the Interoperability tag (Interoperability IFD Pointer).

**Returns:**
InteroperabilityIFDPointerPackage - The Interoperability tag (Interoperability IFD Pointer).
##### getInteroperabilityIFDPointer()
```
public final long getInteroperabilityIFDPointer()
```

Gets the Interoperability tag (Interoperability IFD Pointer).

**Returns:**
long - The Interoperability tag (Interoperability IFD Pointer).
##### getExposureTime()
```
public final float getExposureTime()
```

Gets the Exposure time.

**Returns:**
float - The Exposure time.
##### getFNumber()
```
public final float getFNumber()
```

Gets the F number.

**Returns:**
float - The F number.
##### getExposureProgram()
```
public final int getExposureProgram()
```

Gets the Exposure program.

**Returns:**
int - The Exposure program.
##### getSpectralSensitivity()
```
public final String getSpectralSensitivity()
```

Gets the Spectral sensitivity.

**Returns:**
java.lang.String - The Spectral sensitivity.
##### getPhotographicSensitivity()
```
public final int getPhotographicSensitivity()
```

Gets the Photographic Sensitivity.

**Returns:**
int - The Photographic Sensitivity.
##### getOECF()
```
public final byte[] getOECF()
```

Gets the Optoelectric conversion factor.

**Returns:**
byte[] - The Optoelectric conversion factor.
##### getSensitivityType()
```
public final int getSensitivityType()
```

Gets the Sensitivity Type.

**Returns:**
int - The Sensitivity Type.
##### getStandardOutputSensitivity()
```
public final long getStandardOutputSensitivity()
```

Gets the Standard Output Sensitivity.

**Returns:**
long - The Standard Output Sensitivity.
##### getRecommendedExposureIndex()
```
public final long getRecommendedExposureIndex()
```

Gets the Recommended ExposureIndexs.

**Returns:**
long - The Recommended ExposureIndex.
##### getISOSpeed()
```
public final long getISOSpeed()
```

Gets the ISO Speed.

**Returns:**
long - The ISO Speed.
##### getISOSpeedLatitudeyyy()
```
public final long getISOSpeedLatitudeyyy()
```

Gets the ISO Speed Latitude yyy.

**Returns:**
long - The ISO Speed Latitude yyy.
##### getISOSpeedLatitudezzz()
```
public final long getISOSpeedLatitudezzz()
```

Gets the ISO Speed Latitude zzz.

**Returns:**
long - The ISO Speed Latitude zzz.
##### getExifVersion()
```
public final byte[] getExifVersion()
```

Gets the ExifVersion.

**Returns:**
byte[] - The ExifVersion.
##### getDateTimeOriginal()
```
public final String getDateTimeOriginal()
```

Gets the Date and time of original data generation.

**Returns:**
java.lang.String - The Date and time of original data generation.
##### getDateTimeDigitized()
```
public final String getDateTimeDigitized()
```

Gets the Date and time of digital data generation.

**Returns:**
java.lang.String - The Date and time of digital data generation.
##### getOffsetTime()
```
public final String getOffsetTime()
```

Gets the Offset data of DateTime.

**Returns:**
java.lang.String - The Offset data of DateTime.
##### getOffsetTimeOriginal()
```
public final String getOffsetTimeOriginal()
```

Gets the Offset data of DateTimeOriginal.

**Returns:**
java.lang.String - The Offset data of DateTimeOriginal.
##### getOffsetTimeDigitized()
```
public final String getOffsetTimeDigitized()
```

Gets the Offset data of DateTimeDigitized.

**Returns:**
java.lang.String - The Offset data of DateTimeDigitized.
##### getComponentsConfiguration()
```
public final byte[] getComponentsConfiguration()
```

Gets the Meaning of each component.

**Returns:**
byte[] - The Meaning of each component.
##### getShutterSpeedValue()
```
public final float getShutterSpeedValue()
```

Gets the Shutter speed.

**Returns:**
float - The Shutter speed.
##### getApertureValue()
```
public final float getApertureValue()
```

Gets the Aperture.

**Returns:**
float - The Aperture.
##### getBrightnessValue()
```
public final float getBrightnessValue()
```

Gets the Brightness.

**Returns:**
float - The Brightness.
##### getExposureBiasValue()
```
public final float getExposureBiasValue()
```

Gets the Exposure bias.

**Returns:**
float - The Exposure bias.
##### getMaxApertureValue()
```
public final float getMaxApertureValue()
```

Gets the Maximum lens aperture.

**Returns:**
float - The Maximum lens aperture.
##### getSubjectDistance()
```
public final float getSubjectDistance()
```

Gets the Subject distance.

**Returns:**
float - The Subject distance.
##### getMeteringMode()
```
public final int getMeteringMode()
```

Gets the Metering mode.

**Returns:**
int - The Metering mode.
##### getLightSource()
```
public final int getLightSource()
```

Gets the Light source.

**Returns:**
int - The Light source.
##### getFlash()
```
public final int getFlash()
```

Gets the Flash.

**Returns:**
int - The Flash.
##### getFocalLength()
```
public final float getFocalLength()
```

Gets the Lens focal length.

**Returns:**
float - The Lens focal length.
##### getSubjectArea()
```
public final int getSubjectArea()
```

Gets the Subject area.

**Returns:**
int - The Subject area.
##### getUserComment()
```
public final byte[] getUserComment()
```

Gets the User comments.

**Returns:**
byte[] - The User comments.
##### getSubSecTime()
```
public final String getSubSecTime()
```

Gets the DateTime subseconds.

**Returns:**
java.lang.String - The DateTime subseconds.
##### getSubSecTimeOriginal()
```
public final String getSubSecTimeOriginal()
```

Gets the DateTimeOriginal subseconds.

**Returns:**
java.lang.String - The DateTimeOriginal subseconds.
##### getSubSecTimeDigitized()
```
public final String getSubSecTimeDigitized()
```

Gets the DateTimeDigitized subseconds.

**Returns:**
java.lang.String - The DateTimeDigitized subseconds.
##### getTemperature()
```
public final float getTemperature()
```

Gets the Temperature.

**Returns:**
float - The Temperature.
##### getHumidity()
```
public final float getHumidity()
```

Gets the Humidity.

**Returns:**
float - The Humidity.
##### getPressure()
```
public final float getPressure()
```

Gets the Pressure.

**Returns:**
float - The Pressure.
##### getWaterDepth()
```
public final float getWaterDepth()
```

Gets the WaterDepth.

**Returns:**
float - The WaterDepth.
##### getAcceleration()
```
public final float getAcceleration()
```

Gets the Acceleration.

**Returns:**
float - The Acceleration.
##### getCameraElevationAngle()
```
public final float getCameraElevationAngle()
```

Gets the Camera elevation angle.

**Returns:**
float - The Camera elevation angle.
##### getFlashpixVersion()
```
public final byte[] getFlashpixVersion()
```

Gets the Temperature.

**Returns:**
byte[] - The Temperature.
##### getColorSpace()
```
public final int getColorSpace()
```

Gets the Color space information .

**Returns:**
int - The Color space information .
##### getPixelXDimension()
```
public final long getPixelXDimension()
```

Gets the Valid image width.

**Returns:**
long - The Valid image width.
##### getPixelYDimension()
```
public final long getPixelYDimension()
```

Gets the Valid image height.

**Returns:**
long - The Valid image height.
##### getRelatedSoundFile()
```
public final String getRelatedSoundFile()
```

Gets the Related audio file.

**Returns:**
java.lang.String - The Related audio file.
##### getFlashEnergy()
```
public final float getFlashEnergy()
```

Gets the Flash energy.

**Returns:**
float - The Flash energy.
##### getSpatialFrequencyResponse()
```
public final byte[] getSpatialFrequencyResponse()
```

Gets the Spatial frequency response.

**Returns:**
byte[] - The Spatial frequency response.
##### getFocalPlaneXResolution()
```
public final float getFocalPlaneXResolution()
```

Gets Focal plane X resolution.

**Returns:**
float - The Focal plane X resolution.
##### getFocalPlaneYResolution()
```
public final float getFocalPlaneYResolution()
```

Gets the Focal plane Y resolution.

**Returns:**
float - The Focal plane Y resolution.
##### getFocalPlaneResolutionUnit()
```
public final int getFocalPlaneResolutionUnit()
```

Gets the Focal plane resolution unit.

**Returns:**
int - The Focal plane resolution unit.
##### getSubjectLocation()
```
public final int getSubjectLocation()
```

Gets the Subject location.

**Returns:**
int - The Subject location.
##### getExposureIndex()
```
public final float getExposureIndex()
```

Gets the Exposure index.

**Returns:**
float - The Exposure index.
##### getSensingMethod()
```
public final int getSensingMethod()
```

Gets the Sensing method.

**Returns:**
int - The Sensing method.
##### getFileSource()
```
public final byte[] getFileSource()
```

Gets the File source.

**Returns:**
byte[] - The File source.
##### getSceneType()
```
public final byte[] getSceneType()
```

Gets the Scene Type.

**Returns:**
byte[] - The Scene Type.
##### getCFAPattern()
```
public final byte[] getCFAPattern()
```

Gets the CFA pattern.

**Returns:**
byte[] - The CFA pattern.
##### getCustomRendered()
```
public final int getCustomRendered()
```

Gets the Custom image processing.

**Returns:**
int - The Custom image processing.
##### getExposureMode()
```
public final int getExposureMode()
```

Gets the Exposure mode.

**Returns:**
int - The Exposure mode.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the White balance.

**Returns:**
int - The White balance.
##### getDigitalZoomRatio()
```
public final float getDigitalZoomRatio()
```

Gets the Digital zoom ratio.

**Returns:**
float - The Digital zoom ratio.
##### getFocalLengthIn35mmFilm()
```
public final int getFocalLengthIn35mmFilm()
```

Gets the Focal length in 35 mm film.

**Returns:**
int - The Focal length in 35 mm film.
##### getSceneCaptureType()
```
public final int getSceneCaptureType()
```

Gets the Scene capture type.

**Returns:**
int - The Scene capture type.
##### getGainControl()
```
public final float getGainControl()
```

Gets the Gain control.

**Returns:**
float - The Gain control.
##### getContrast()
```
public final int getContrast()
```

Gets the Contrast.

**Returns:**
int - The Contrast.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getDeviceSettingDescription()
```
public final byte[] getDeviceSettingDescription()
```

Gets the Device settings description.

**Returns:**
byte[] - The Device settings description.
##### getSubjectDistanceRange()
```
public final int getSubjectDistanceRange()
```

Gets the Subject distance range.

**Returns:**
int - The Subject distance range.
##### getImageUniqueID()
```
public final String getImageUniqueID()
```

Gets the Unique image ID.

**Returns:**
java.lang.String - The Unique image ID.
##### getCameraOwnerName()
```
public final String getCameraOwnerName()
```

Gets the Camera Owner Name.

**Returns:**
java.lang.String - The Camera Owner Name.
##### getBodySerialNumber()
```
public final String getBodySerialNumber()
```

Gets the Body Serial Number.

**Returns:**
java.lang.String - The Body Serial Number.
##### getLensSpecification()
```
public final double[] getLensSpecification()
```

Gets the Lens Specification.

**Returns:**
double[] - The Lens Specification.
##### getLensModel()
```
public final String getLensModel()
```

Gets the Lens Model.

**Returns:**
java.lang.String - The Lens Model.
##### getLensMake()
```
public final String getLensMake()
```

Gets the Lens Make.

**Returns:**
java.lang.String - The Lens Make.
##### getLensSerialNumber()
```
public final String getLensSerialNumber()
```

Gets the Lens Serial Number.

**Returns:**
java.lang.String - The Lens Serial Number.
##### getCompositeImage()
```
public final int getCompositeImage()
```

Gets the Composite image.

**Returns:**
int - The Composite image.
##### getSourceImageNumberOfCompositeImage()
```
public final int getSourceImageNumberOfCompositeImage()
```

Gets the Source image number of composite image.

**Returns:**
int - The Source image number of composite image.
##### getSourceExposureTimesOfCompositeImage()
```
public final byte[] getSourceExposureTimesOfCompositeImage()
```

Gets the Source exposure times of composite image.

**Returns:**
byte[] - The Source exposure times of composite image.
##### getGamma()
```
public final float getGamma()
```

Gets the Gamma.

**Returns:**
float - The Gamma.
##### getMakerNote()
```
public final long getMakerNote()
```

Gets the Standard Output Sensitivity.

**Returns:**
long - The Standard Output Sensitivity.

### RawIFD1Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawifd1package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD1Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getThumbnailOffset() | Gets the ThumbnailOffset. |
| getThumbnailLenght() | Gets the ThumbnailLenght. |
##### getThumbnailOffset()
```
public final long getThumbnailOffset()
```

Gets the ThumbnailOffset.

**Returns:**
long - The ThumbnailOffset.
##### getThumbnailLenght()
```
public final long getThumbnailLenght()
```

Gets the ThumbnailLenght.

**Returns:**
long - The ThumbnailLenght.

### RawIFD2Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawifd2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD2Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getBitsPerSample() | Gets the image BitsPerSample. |
| getCompression() | Gets the image Compression. |
| getPhotometricInterpretation() | Gets the image PhotometricInterpretation. |
| getStripOffset() | Gets the image StripOffset. |
| getSamplesPerPixel() | Gets the SamplesPerPixel. |
| getRowPerStrip() | Gets the RowPerStrip. |
| getStripByteCounts() | Gets the StripByteCounts. |
| getPlanarConfiguration() | Gets the PlanarConfiguration. |
| getUnknown1() | Gets the Unknown1. |
| getUnknown2() | Gets the Unknown2. |
| getUnknown3() | Gets the Unknown3. |
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getBitsPerSample()
```
public final int[] getBitsPerSample()
```

Gets the image BitsPerSample.

**Returns:**
int[] - The image BitsPerSample.
##### getCompression()
```
public final int getCompression()
```

Gets the image Compression.

**Returns:**
int - The image Compression.
##### getPhotometricInterpretation()
```
public final int getPhotometricInterpretation()
```

Gets the image PhotometricInterpretation.

**Returns:**
int - The image PhotometricInterpretation.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the image StripOffset.

**Returns:**
long - The image StripOffset.
##### getSamplesPerPixel()
```
public final int getSamplesPerPixel()
```

Gets the SamplesPerPixel.

**Returns:**
int - The SamplesPerPixel.
##### getRowPerStrip()
```
public final int getRowPerStrip()
```

Gets the RowPerStrip.

**Returns:**
int - The RowPerStrip.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the StripByteCounts.

**Returns:**
long - The StripByteCounts.
##### getPlanarConfiguration()
```
public final int getPlanarConfiguration()
```

Gets the PlanarConfiguration.

**Returns:**
int - The PlanarConfiguration.
##### getUnknown1()
```
public final long getUnknown1()
```

Gets the Unknown1.

**Returns:**
long - The Unknown1.
##### getUnknown2()
```
public final long getUnknown2()
```

Gets the Unknown2.

**Returns:**
long - The Unknown2.
##### getUnknown3()
```
public final long[] getUnknown3()
```

Gets the Unknown3.

**Returns:**
long[] - The Unknown3.

### RawIFD3Package
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawifd3package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD3Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getCompression() | Gets the image Compression. |
| getStripOffset() | Gets the image StripOffset. |
| getStripByteCounts() | Gets the image StripByteCounts. |
| getUnknown1() | Gets the Unknown1. |
| getUnknown2() | Gets the Unknown2. |
| getUnknown3() | Gets the Unknown3. |
| getUnknown4() | Gets the Unknown4. |
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getCompression()
```
public final int getCompression()
```

Gets the image Compression.

**Returns:**
int - The image Compression.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the image StripOffset.

**Returns:**
long - The image StripOffset.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the image StripByteCounts.

**Returns:**
long - The image StripByteCounts.
##### getUnknown1()
```
public final long getUnknown1()
```

Gets the Unknown1.

**Returns:**
long - The Unknown1.
##### getUnknown2()
```
public final long getUnknown2()
```

Gets the Unknown2.

**Returns:**
long - The Unknown2.
##### getUnknown3()
```
public final int[] getUnknown3()
```

Gets the Unknown3.

**Returns:**
int[] - The Unknown3.
##### getUnknown4()
```
public final long getUnknown4()
```

Gets the Unknown4.

**Returns:**
long - The Unknown4.

### RawIntegerType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawintegertype.md

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

Defines raw integer types for enumerations.
#### Fields

| Field | Description |
| --- | --- |
| SignedByte | The 8-bit signed integer value type. |
| UnsignedByte | The 8-bit unsigned integer value type. |
| SignedShort | The 16-bit signed integer value type. |
| UnsignedShort | The 16-bit unsigned integer value type. |
| SignedInt | The 32-bit signed integer value type. |
| UnsignedInt | The 32-bit unsigned integer value type. |
| SignedLong | The 64-bit signed integer value type. |
| UnsignedLong | The 64-bit unsigned integer value type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### SignedByte
```
public static final RawIntegerType SignedByte
```

The 8-bit signed integer value type.

##### UnsignedByte
```
public static final RawIntegerType UnsignedByte
```

The 8-bit unsigned integer value type.

##### SignedShort
```
public static final RawIntegerType SignedShort
```

The 16-bit signed integer value type.

##### UnsignedShort
```
public static final RawIntegerType UnsignedShort
```

The 16-bit unsigned integer value type.

##### SignedInt
```
public static final RawIntegerType SignedInt
```

The 32-bit signed integer value type.

##### UnsignedInt
```
public static final RawIntegerType UnsignedInt
```

The 32-bit unsigned integer value type.

##### SignedLong
```
public static final RawIntegerType SignedLong
```

The 64-bit signed integer value type.

##### UnsignedLong
```
public static final RawIntegerType UnsignedLong
```

The 64-bit unsigned integer value type.

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

**Returns:**
com.groupdocs.metadata.core.RawIntegerType[]
##### valueOf(String name)
```
public static RawIntegerType valueOf(String name)
```

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

**Returns:**
RawIntegerType

### RawMakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public abstract class RawMakerNotePackage extends RawDictionaryBasePackage
```

Represents Raw MakerNotes tags.

### RawTiffTagPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawtifftagpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawTiffTagPackage extends RawDictionaryBasePackage
```

Represents Tiff tags.
#### Methods

| Method | Description |
| --- | --- |
| getRawIFD1Package() | Gets the IFD1. |
| getRawIFD2Package() | Gets the IFD2. |
| getRawIFD3Package() | Gets the IFD3. |
| getRawExifTagPackage() | Gets the Exif tag (Exif IFD Pointer). |
| getGpsIfdPackage() | Gets the GPS tag (GPSInfo IFD Pointer). |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getBitsPerSample() | Gets the bits per sample. |
| getCompression() | Gets compression. |
| getPhotometricInterpretation() | Gets PhotometricInterpretation. |
| getImageDescription() | Gets a character string giving the title of the image. |
| setImageDescription(String value) | Sets a character string giving the title of the image. |
| getMake() | Gets the macro mode. |
| getModel() | Gets the model. |
| getStripOffset() | Gets the StripOffset. |
| getOrientation() | Gets the orientation. |
| getSamplesPerPixel() | Gets the SamplesPerPixel. |
| getRowsPerStrip() | Gets the RowsPerStrip. |
| getStripByteCounts() | Gets the strip byte counts. |
| getXResolution() | Gets the XResolution. |
| getYResolution() | Gets the YResolution. |
| getPlanarConfiguration() | Gets the PlanarConfiguration. |
| getResolutionUnit() | Gets the Resolution Unit. |
| getTransferFunction() | Gets the TransferFunction. |
| getSoftware() | Gets the Software. |
| getDateTime() | Gets the DateTime. |
| getArtist() | Gets the Artist. |
| getWhitePoint() | Gets the WhitePoint. |
| getPrimaryChromaticities() | Gets the PrimaryChromaticities. |
| getJpegInterchangeFormat() | Gets the JpegInterchangeFormat. |
| getJpegInterchangeFormatLength() | Gets the JpegInterchangeFormatLength. |
| getYCbCrCoefficients() | Gets the YCbCrCoefficients. |
| getYCbCrSubSampling() | Gets the YCbCrSubSampling. |
| getYCbCrPositioning() | Gets the YCbCrPositioning. |
| getReferenceBlackWhite() | Gets the ReferenceBlackWhite. |
| getCopyright() | Gets the Copyright. |
| getEXIF() | Gets the EXIF. |
| getGpsIfd() | Gets the EXIF. |
##### getRawIFD1Package()
```
public final RawIFD1Package getRawIFD1Package()
```

Gets the IFD1.

**Returns:**
RawIFD1Package - The IFD1.
##### getRawIFD2Package()
```
public final RawIFD2Package getRawIFD2Package()
```

Gets the IFD2.

**Returns:**
RawIFD2Package - The IFD2.
##### getRawIFD3Package()
```
public final RawIFD3Package getRawIFD3Package()
```

Gets the IFD3.

**Returns:**
RawIFD3Package - The IFD3.
##### getRawExifTagPackage()
```
public final RawExifTagPackage getRawExifTagPackage()
```

Gets the Exif tag (Exif IFD Pointer).

**Returns:**
RawExifTagPackage - The Exif tag (Exif IFD Pointer).
##### getGpsIfdPackage()
```
public final GpsIfdPackage getGpsIfdPackage()
```

Gets the GPS tag (GPSInfo IFD Pointer).

**Returns:**
GpsIfdPackage - The GPS tag (GPSInfo IFD Pointer).
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getBitsPerSample()
```
public final int[] getBitsPerSample()
```

Gets the bits per sample.

**Returns:**
int[] - The bits per sample.
##### getCompression()
```
public final int getCompression()
```

Gets compression.

**Returns:**
int - The compression.
##### getPhotometricInterpretation()
```
public final int getPhotometricInterpretation()
```

Gets PhotometricInterpretation.

**Returns:**
int - The PhotometricInterpretation.
##### getImageDescription()
```
public final String getImageDescription()
```

Gets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Returns:**
java.lang.String - The image description.
##### setImageDescription(String value)
```
public final void setImageDescription(String value)
```

Sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

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

##### getMake()
```
public final String getMake()
```

Gets the macro mode.

**Returns:**
java.lang.String - The macro mode.
##### getModel()
```
public final String getModel()
```

Gets the model.

**Returns:**
java.lang.String - The model.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the StripOffset.

**Returns:**
long - The StripOffset.
##### getOrientation()
```
public final int getOrientation()
```

Gets the orientation.

**Returns:**
int - The orientation.
##### getSamplesPerPixel()
```
public final int getSamplesPerPixel()
```

Gets the SamplesPerPixel.

**Returns:**
int - The SamplesPerPixel.
##### getRowsPerStrip()
```
public final long getRowsPerStrip()
```

Gets the RowsPerStrip.

**Returns:**
long - The RowsPerStrip.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the strip byte counts.

**Returns:**
long - The strip byte counts.
##### getXResolution()
```
public final float getXResolution()
```

Gets the XResolution.

**Returns:**
float - The XResolution.
##### getYResolution()
```
public final float getYResolution()
```

Gets the YResolution.

**Returns:**
float - The YResolution.
##### getPlanarConfiguration()
```
public final int getPlanarConfiguration()
```

Gets the PlanarConfiguration.

**Returns:**
int - The PlanarConfiguration.
##### getResolutionUnit()
```
public final int getResolutionUnit()
```

Gets the Resolution Unit.

**Returns:**
int - The Resolution Unit.
##### getTransferFunction()
```
public final int[] getTransferFunction()
```

Gets the TransferFunction.

**Returns:**
int[] - The TransferFunction.
##### getSoftware()
```
public final String getSoftware()
```

Gets the Software.

**Returns:**
java.lang.String - The Software.
##### getDateTime()
```
public final String getDateTime()
```

Gets the DateTime.

**Returns:**
java.lang.String - The DateTime.
##### getArtist()
```
public final String getArtist()
```

Gets the Artist.

**Returns:**
java.lang.String - The Artist.
##### getWhitePoint()
```
public final double[] getWhitePoint()
```

Gets the WhitePoint.

**Returns:**
double[] - The WhitePoint.
##### getPrimaryChromaticities()
```
public final double[] getPrimaryChromaticities()
```

Gets the PrimaryChromaticities.

**Returns:**
double[] - The PrimaryChromaticities.
##### getJpegInterchangeFormat()
```
public final long getJpegInterchangeFormat()
```

Gets the JpegInterchangeFormat.

**Returns:**
long - The JpegInterchangeFormat.
##### getJpegInterchangeFormatLength()
```
public final long getJpegInterchangeFormatLength()
```

Gets the JpegInterchangeFormatLength.

**Returns:**
long - The JpegInterchangeFormatLength.
##### getYCbCrCoefficients()
```
public final double[] getYCbCrCoefficients()
```

Gets the YCbCrCoefficients.

**Returns:**
double[] - The YCbCrCoefficients.
##### getYCbCrSubSampling()
```
public final int[] getYCbCrSubSampling()
```

Gets the YCbCrSubSampling.

**Returns:**
int[] - The YCbCrSubSampling.
##### getYCbCrPositioning()
```
public final int getYCbCrPositioning()
```

Gets the YCbCrPositioning.

**Returns:**
int - The YCbCrPositioning.
##### getReferenceBlackWhite()
```
public final double[] getReferenceBlackWhite()
```

Gets the ReferenceBlackWhite.

**Returns:**
double[] - The ReferenceBlackWhite.
##### getCopyright()
```
public final String getCopyright()
```

Gets the Copyright.

**Returns:**
java.lang.String - The Copyright.
##### getEXIF()
```
public final long getEXIF()
```

Gets the EXIF.

**Returns:**
long - The EXIF.
##### getGpsIfd()
```
public final long getGpsIfd()
```

Gets the EXIF.

**Returns:**
long - The EXIF.

### RawTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rawtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class RawTypePackage extends FileTypePackage
```

Represents a metadata package containing image-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getByteOrder() | Gets the byte-order of the image. |
##### getByteOrder()
```
public final ByteOrder getByteOrder()
```

Gets the byte-order of the image. Please see  https://en.wikipedia.org/wiki/Endianness  for more information.

**Returns:**
ByteOrder - The byte-order value.

### ReadOnlyList
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/readonlylist.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IReadOnlyList
```
public class ReadOnlyList<T> implements IReadOnlyList<T>
```

Provides an abstract base class for a strongly typed read-only list.

 T : The type of the element.
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the collection. |
| get_Item(int index) | Gets the element at the specified index in the collection. |
| contains(T item) | Determines whether the collection contains a specific item. |
| contains(TagCategory item) | Determines whether the collection contains a TagCategory item. |
| indexOf(T item) | Determines the index of a specific item in the collection. |
| iterator() | Returns an enumerator that iterates through a collection. |
##### getCount()
```
public final int getCount()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.
##### get_Item(int index)
```
public final T get_Item(int index)
```

Gets the element at the specified index in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the element to get. |

**Returns:**
T - The element at the specified index.
##### contains(T item)
```
public final boolean contains(T item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### contains(TagCategory item)
```
public final boolean contains(TagCategory item)
```

Determines whether the collection contains a TagCategory item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### indexOf(T item)
```
public final int indexOf(T item)
```

Determines the index of a specific item in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
int - The index of  item  if found in the collection; otherwise, -1.
##### iterator()
```
public final Iterator<T> iterator()
```

Returns an enumerator that iterates through a collection.

**Returns:**
java.util.Iterator<T> - An  IEnumerator\{T\}  object that can be used to iterate through the collection.

### Rectangle
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rectangle.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.lang.Struct
```
public class Rectangle extends Struct<Rectangle>
```

A set of four integers that represent the location and size of a rectangle.
#### Constructors

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

| Method | Description |
| --- | --- |
| getEmpty() | Gets the empty rectangle. |
| getX() | Gets the x. |
| getY() | Gets the y. |
| getWidth() | Gets the width. |
| getHeight() | Gets the height. |
| getLeft() | Gets the x-coordinate of the left edge of the rectangle. |
| getTop() | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| getRight() | Gets the x-coordinate that is the sum of X and Width property values of the rectangle. |
| getBottom() | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| isEmpty() | Gets a value indicating whether this instance is empty. |
| toString() | Returns a  System.String  that represents this instance. |
| CloneTo(Rectangle that) |  |
| Clone() |  |
| clone() |  |
| equals(Object obj) |  |
| equals(Rectangle obj1, Rectangle obj2) |  |
##### Rectangle()
```
public Rectangle()
```

##### getEmpty()
```
public static Rectangle getEmpty()
```

Gets the empty rectangle.

**Returns:**
Rectangle - The empty rectangle.
##### getX()
```
public final int getX()
```

Gets the x.

**Returns:**
int - The x.
##### getY()
```
public final int getY()
```

Gets the y.

**Returns:**
int - The y.
##### getWidth()
```
public final int getWidth()
```

Gets the width.

**Returns:**
int - The width.
##### getHeight()
```
public final int getHeight()
```

Gets the height.

**Returns:**
int - The height.
##### getLeft()
```
public final int getLeft()
```

Gets the x-coordinate of the left edge of the rectangle.

**Returns:**
int - The x-coordinate of the left edge of the rectangle.
##### getTop()
```
public final int getTop()
```

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

**Returns:**
int - The y-coordinate that is the sum of the Y and Height property values of the rectangle.
##### getRight()
```
public final int getRight()
```

Gets the x-coordinate that is the sum of X and Width property values of the rectangle.

**Returns:**
int - The x-coordinate that is the sum of X and Width property values of the rectangle.
##### getBottom()
```
public final int getBottom()
```

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

**Returns:**
int - The y-coordinate that is the sum of the Y and Height property values of the rectangle.
##### isEmpty()
```
public final boolean isEmpty()
```

Gets a value indicating whether this instance is empty.

**Returns:**
boolean -  true  if this instance is empty; otherwise,  false .
##### toString()
```
public String toString()
```

Returns a  System.String  that represents this instance.

**Returns:**
java.lang.String - A  System.String  that represents this instance.
##### CloneTo(Rectangle that)
```
public void CloneTo(Rectangle that)
```

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

##### Clone()
```
public Rectangle Clone()
```

**Returns:**
Rectangle
##### clone()
```
public Object clone()
```

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

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

**Returns:**
boolean
##### equals(Rectangle obj1, Rectangle obj2)
```
public static boolean equals(Rectangle obj1, Rectangle obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | Rectangle |  |
| obj2 | Rectangle |  |

**Returns:**
boolean

### RiffInfoPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/riffinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RiffInfoPackage extends CustomPackage
```

Represents the metadata package containing properties extracted from the RIFF INFO chunk.
#### Methods

| Method | Description |
| --- | --- |
| getArtist() | Gets the artist of the original subject of the file. |
| getComment() | Gets the comment about the file or the subject of the file. |
| getCopyright() | Gets the copyright information for the file. |
| getCreationDate() | Gets the date the subject of the file was created. |
| getEngineer() | Gets the name of the engineer who worked on the file. |
| getGenre() | Gets the genre of the original work. |
| getKeywords() | Gets the keywords that refer to the file or subject of the file. |
| getName() | Gets the title of the subject of the file. |
| getSubject() | Gets a description of the file contents, such as "Aerial view of Seattle." |
| getSoftware() | Gets the name of the software package used to create the file. |
| getSource() | Gets the name of the person or organization who supplied the original subject of the file. |
| getTechnician() | Gets the technician who digitized the subject file. |
##### getArtist()
```
public final String getArtist()
```

Gets the artist of the original subject of the file.

**Returns:**
java.lang.String - The artist of the original subject of the file.
##### getComment()
```
public final String getComment()
```

Gets the comment about the file or the subject of the file.

**Returns:**
java.lang.String - The comment about the file or the subject of the file.
##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright information for the file.

**Returns:**
java.lang.String - The copyright information for the file.
##### getCreationDate()
```
public final String getCreationDate()
```

Gets the date the subject of the file was created.

**Returns:**
java.lang.String - The date the subject of the file was created.
##### getEngineer()
```
public final String getEngineer()
```

Gets the name of the engineer who worked on the file.

**Returns:**
java.lang.String - The name of the engineer who worked on the file.
##### getGenre()
```
public final String getGenre()
```

Gets the genre of the original work.

**Returns:**
java.lang.String - The genre of the original work.
##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords that refer to the file or subject of the file.

**Returns:**
java.lang.String - The keywords that refer to the file or subject of the file.
##### getName()
```
public final String getName()
```

Gets the title of the subject of the file.

**Returns:**
java.lang.String - The title of the subject of the file.
##### getSubject()
```
public final String getSubject()
```

Gets a description of the file contents, such as "Aerial view of Seattle."

**Returns:**
java.lang.String - A description of the file contents.
##### getSoftware()
```
public final String getSoftware()
```

Gets the name of the software package used to create the file.

**Returns:**
java.lang.String - The name of the software package used to create the file.
##### getSource()
```
public final String getSource()
```

Gets the name of the person or organization who supplied the original subject of the file.

**Returns:**
java.lang.String - The name of the person or organization who supplied the original subject of the file.
##### getTechnician()
```
public final String getTechnician()
```

Gets the technician who digitized the subject file.

**Returns:**
java.lang.String - The technician who digitized the subject file.

### RootMetadataPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/rootmetadatapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage
```
public abstract class RootMetadataPackage extends MetadataPackage
```

Represents an entry point to all metadata packages presented in a particular file.
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the file type metadata package. |
| isLicensed() |  |
| sanitize() | Removes writable metadata properties from the package. |
| copyTo(MetadataPackage metadataPackage) |  |
##### getFileType()
```
public final FileTypePackage getFileType()
```

Gets the file type metadata package.

**Returns:**
FileTypePackage - The file type metadata package.
##### isLicensed()
```
public final boolean isLicensed()
```

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

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage |  |

### SevenZipFile
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/sevenzipfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SevenZipFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getName() | Gets the entry name. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

Value: The compressed size in bytes.

**Returns:**
long
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

Value: The uncompressed size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

Value: The last modification date and time.

**Returns:**
java.util.Date

### SevenZipPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/sevenzippackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SevenZipPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputSevenZip))
>  {
>      var root = metadata.GetRootPackage<SevenZipRootPackage>();
>      Console.WriteLine(root.SevenZipPackage.TotalEntries);
>      foreach (var file in root.SevenZipPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final SevenZipFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.SevenZipFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### SevenZipRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/sevenziprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class SevenZipRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputSevenZip))
>  {
>      var root = metadata.GetRootPackage<SevenZipRootPackage>();
>      Console.WriteLine(root.SevenZipPackage.TotalEntries);
>      foreach (var file in root.SevenZipPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getSevenZipPackage() | Gets the ZIP metadata package. |
##### getSevenZipPackage()
```
public final SevenZipPackage getSevenZipPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
SevenZipPackage

### SonyMakerNotePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/sonymakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class SonyMakerNotePackage extends MakerNotePackage
```

Represents SONY MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getHeader() | Gets the MakerNote header. |
| getQuality() | Gets the image quality. |
| getWhiteBalance() | Gets the white balance. |
| getTeleconverter() | Gets the teleconverter type. |
| getMultiBurstMode() | Gets a value indicating whether the multi burst mode is on. |
| getMultiBurstImageWidth() | Gets the width of the multi burst image. |
| getMultiBurstImageHeight() | Gets the height of the multi burst image. |
| getRating() | Gets the rating. |
| getContrast() | Gets the contrast. |
| getSaturation() | Gets the saturation. |
| getSharpness() | Gets the sharpness. |
| getBrightness() | Gets the brightness. |
| getPictureEffect() | Gets the picture effect. |
| getSoftSkinEffect() | Gets the soft skin effect. |
| getSonyModelID() | Gets the sony model identifier. |
| getCreativeStyle() | Gets the creative style. |
| getColorTemperature() | Gets the color temperature. |
| getColorMode() | Gets the color mode. |
| getMacro() | Gets the macro. |
| getExposureMode() | Gets the exposure mode. |
| getFocusMode() | Gets the focus mode. |
| getJpegQuality() | Gets the JPEG quality. |
| getAFIlluminator() | Gets the AF illuminator type. |
| getFlashLevel() | Gets the flash level. |
| getReleaseMode() | Gets the release mode. |
##### getHeader()
```
public final String getHeader()
```

Gets the MakerNote header.

**Returns:**
java.lang.String - The MakerNote header.
##### getQuality()
```
public final Long getQuality()
```

Gets the image quality.

**Returns:**
java.lang.Long - The image quality.
##### getWhiteBalance()
```
public final Long getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.Long - The white balance.
##### getTeleconverter()
```
public final Long getTeleconverter()
```

Gets the teleconverter type.

**Returns:**
java.lang.Long - The teleconverter type.
##### getMultiBurstMode()
```
public final boolean getMultiBurstMode()
```

Gets a value indicating whether the multi burst mode is on.

**Returns:**
boolean -  true  if the multi burst mode is on; otherwise,  false .
##### getMultiBurstImageWidth()
```
public final Integer getMultiBurstImageWidth()
```

Gets the width of the multi burst image.

**Returns:**
java.lang.Integer - The width of the multi burst image.
##### getMultiBurstImageHeight()
```
public final Integer getMultiBurstImageHeight()
```

Gets the height of the multi burst image.

**Returns:**
java.lang.Integer - The height of the multi burst image.
##### getRating()
```
public final Long getRating()
```

Gets the rating.

**Returns:**
java.lang.Long - The rating.
##### getContrast()
```
public final Integer getContrast()
```

Gets the contrast.

**Returns:**
java.lang.Integer - The contrast.
##### getSaturation()
```
public final Integer getSaturation()
```

Gets the saturation.

**Returns:**
java.lang.Integer - The saturation.
##### getSharpness()
```
public final Integer getSharpness()
```

Gets the sharpness.

**Returns:**
java.lang.Integer - The sharpness.
##### getBrightness()
```
public final Integer getBrightness()
```

Gets the brightness.

**Returns:**
java.lang.Integer - The brightness.
##### getPictureEffect()
```
public final Integer getPictureEffect()
```

Gets the picture effect.

**Returns:**
java.lang.Integer - The picture effect.
##### getSoftSkinEffect()
```
public final Long getSoftSkinEffect()
```

Gets the soft skin effect.

**Returns:**
java.lang.Long - The soft skin effect.
##### getSonyModelID()
```
public final Integer getSonyModelID()
```

Gets the sony model identifier.

**Returns:**
java.lang.Integer - The sony model identifier.
##### getCreativeStyle()
```
public final String getCreativeStyle()
```

Gets the creative style.

**Returns:**
java.lang.String - The creative style.
##### getColorTemperature()
```
public final Long getColorTemperature()
```

Gets the color temperature.

**Returns:**
java.lang.Long - The color temperature.
##### getColorMode()
```
public final Long getColorMode()
```

Gets the color mode.

**Returns:**
java.lang.Long - The color mode.
##### getMacro()
```
public final Integer getMacro()
```

Gets the macro.

**Returns:**
java.lang.Integer - The macro.
##### getExposureMode()
```
public final Integer getExposureMode()
```

Gets the exposure mode.

**Returns:**
java.lang.Integer - The exposure mode.
##### getFocusMode()
```
public final Integer getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.Integer - The focus mode.
##### getJpegQuality()
```
public final Integer getJpegQuality()
```

Gets the JPEG quality.

**Returns:**
java.lang.Integer - The JPEG quality.
##### getAFIlluminator()
```
public final Integer getAFIlluminator()
```

Gets the AF illuminator type.

**Returns:**
java.lang.Integer - The AF illuminator type.
##### getFlashLevel()
```
public final Short getFlashLevel()
```

Gets the flash level.

**Returns:**
java.lang.Short - The flash level.
##### getReleaseMode()
```
public final Integer getReleaseMode()
```

Gets the release mode.

**Returns:**
java.lang.Integer - The release mode.

### SpreadsheetComment
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class SpreadsheetComment extends CustomPackage
```

Represents a user comment in a spreadsheet.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the comment. |
| getText() | Gets the comment text. |
| getSheetNumber() | Gets the sheet number. |
| getRow() | Gets the one-based row index of the comment. |
| getColumn() | Gets the one-based column index of the comment. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the comment.

**Returns:**
java.lang.String - The author of the comment.
##### getText()
```
public final String getText()
```

Gets the comment text.

**Returns:**
java.lang.String - The comment text.
##### getSheetNumber()
```
public final int getSheetNumber()
```

Gets the sheet number.

**Returns:**
int - The sheet number.
##### getRow()
```
public final int getRow()
```

Gets the one-based row index of the comment.

**Returns:**
int - The row index of the comment.
##### getColumn()
```
public final int getColumn()
```

Gets the one-based column index of the comment.

**Returns:**
int - The column index of the comment.

### SpreadsheetContentTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetcontenttypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class SpreadsheetContentTypePackage extends CustomPackage
```

Represents a metadata package containing spreadsheet content type properties.
#### Methods

| Method | Description |
| --- | --- |
| set(String propertyName, String propertyValue) | Adds or replaces the content type property with the specified name. |
| set(String propertyName, String propertyValue, String propertyType) | Adds or replaces the content type property with the specified name. |
| remove(String propertyName) | Removes the content type property with the specified name. |
| clear() | Removes all writable metadata properties. |
| toList() | Creates a list from the package. |
##### set(String propertyName, String propertyValue)
```
public final void set(String propertyName, String propertyValue)
```

Adds or replaces the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| propertyValue | java.lang.String | The property value. |

##### set(String propertyName, String propertyValue, String propertyType)
```
public final void set(String propertyName, String propertyValue, String propertyType)
```

Adds or replaces the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| propertyValue | java.lang.String | The property value. |
| propertyType | java.lang.String | The property type. |

##### remove(String propertyName)
```
public final boolean remove(String propertyName)
```

Removes the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the content type property to be removed. |

**Returns:**
boolean -  true  if the property is found and deleted; otherwise  false .
##### clear()
```
public final void clear()
```

Removes all writable metadata properties.

##### toList()
```
public final IReadOnlyList<SpreadsheetContentTypeProperty> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains properties from the package.

### SpreadsheetContentTypeProperty
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetcontenttypeproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class SpreadsheetContentTypeProperty extends MetadataProperty
```

Represents a content type property in a spreadsheet.
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetPropertyType() | Gets the type of the property. |
| getSpreadsheetPropertyValue() | Gets the value of the property. |
##### getSpreadsheetPropertyType()
```
public final String getSpreadsheetPropertyType()
```

Gets the type of the property.

**Returns:**
java.lang.String - The type of the property.
##### getSpreadsheetPropertyValue()
```
public final String getSpreadsheetPropertyValue()
```

Gets the value of the property.

**Returns:**
java.lang.String - The value of the property.

### SpreadsheetFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum SpreadsheetFormat extends Enum<SpreadsheetFormat> implements IEnumValue
```

Defines various spreadsheet subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Xls | Represents the .XLS Excel format. |
| Xlsb | Represents the .XLSB Excel format. |
| Xlsx | Represents the .XLSX Excel format. |
| Xlsm | Represents the .XLSM Excel format. |
| Xltx | Represents the .XLTX Excel format. |
| Xltm | Represents the .XLTM Excel format. |
| Ods | Represents the Opendocument Spreadsheet format. |
| Xlt | Represents the .XLT Excel format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final SpreadsheetFormat Unknown
```

The format is not recognized.

##### Xls
```
public static final SpreadsheetFormat Xls
```

Represents the .XLS Excel format. Files with XLS extension represent 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. File saved by Excel is known as Workbook where each workbook can have one or more worksheets. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xls/

##### Xlsb
```
public static final SpreadsheetFormat Xlsb
```

Represents the .XLSB Excel format. XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. The content can include unstructured or semi-structured tables of numbers, text, or both numbers and text, formulas, external data connections, charts and images. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsb/

##### Xlsx
```
public static final SpreadsheetFormat Xlsx
```

Represents the .XLSX Excel format. XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Based on structure organized according to the Open Packaging Conventions as outlined in Part 2 of the OOXML standard ECMA-376, the new format is a zip package that contains a number of XML files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsx/

##### Xlsm
```
public static final SpreadsheetFormat Xlsm
```

Represents the .XLSM Excel format. Files with XLSM extension is a type of Spreasheet files that support Macros. From application point of view, a Macro is set of instructions that are used for automating processes. A macro is used to record the steps that are performed repeatedly and facilitates performing the actions by running the macro again. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsm/

##### Xltx
```
public static final SpreadsheetFormat Xltx
```

Represents the .XLTX Excel format. Files with XLTX extension represent Microsoft Excel Template files 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/

##### Xltm
```
public static final SpreadsheetFormat Xltm
```

Represents the .XLTM Excel format. 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. Such template files are used to generate and set the layout, formatting, and other settings along with the macros to facilitate creating similar XLSX files then. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xltm/

##### Ods
```
public static final SpreadsheetFormat Ods
```

Represents the Opendocument Spreadsheet format. 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. It is XML-based format and is one of the several subtypes in the Open Document Formats (ODF) family. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/ods/

##### Xlt
```
public static final SpreadsheetFormat Xlt
```

Represents the .XLT Excel format. 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. The latest version of Excel is still capable of opening this old format template files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlt/

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

**Returns:**
com.groupdocs.metadata.core.SpreadsheetFormat[]
##### valueOf(String name)
```
public static SpreadsheetFormat valueOf(String name)
```

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

**Returns:**
SpreadsheetFormat
##### getByRawValue(int rawValue)
```
public static SpreadsheetFormat getByRawValue(int rawValue)
```

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

**Returns:**
SpreadsheetFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### SpreadsheetInspectionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SpreadsheetInspectionPackage extends CustomPackage
```

Contains information about spreadsheet parts that can be considered as metadata in some cases.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets an array of the user comments. |
| getHiddenSheets() | Gets an array of the hidden sheets. |
| getDigitalSignatures() | Gets an array of digital signatures presented in the document. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the spreadsheet. |
| clearHiddenSheets() | Removes all detected hidden sheets from the spreadsheet. |
| clearDigitalSignatures() | Removes all detected digital signatures from the spreadsheet. |
| sanitize() | Removes writable metadata properties from the package. |
##### getComments()
```
public final SpreadsheetComment[] getComments()
```

Gets an array of the user comments.

**Returns:**
com.groupdocs.metadata.core.SpreadsheetComment[] - The user comments.
##### getHiddenSheets()
```
public final SpreadsheetSheet[] getHiddenSheets()
```

Gets an array of the hidden sheets.

**Returns:**
com.groupdocs.metadata.core.SpreadsheetSheet[] - The hidden sheets.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - The digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the spreadsheet.

##### clearHiddenSheets()
```
public final void clearHiddenSheets()
```

Removes all detected hidden sheets from the spreadsheet.

##### clearDigitalSignatures()
```
public final void clearDigitalSignatures()
```

Removes all detected digital signatures from the spreadsheet.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### SpreadsheetPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class SpreadsheetPackage extends DocumentPackage
```

Represents a native metadata package in a spreadsheet.

This example shows how to update built-in metadata properties in a spreadsheet.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputXlsx)) {
>      SpreadsheetRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputXlsx);
>  }
>
> ```
> ```

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getLanguage() | Gets the document language. |
| setLanguage(String value) | Sets the document language. |
| getAuthor() | Gets the document author. |
| setAuthor(String value) | Sets the document author. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getTotalEditingTime() | Gets the total editing time in minutes. |
| setTotalEditingTime(Double value) | Sets the total editing time in minutes. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastSavedTime() | Gets the time of the last saving in UTC. |
| setLastSavedTime(Date value) | Sets the time of the last saving in UTC. |
| getLastPrintedDate() | Gets the last printed date in UTC. |
| setLastPrintedDate(Date value) | Sets the last printed date in UTC. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of application. |
| setNameOfApplication(String value) | Sets the name of application. |
| getRevision() | Gets the document revision number. |
| setRevision(String value) | Sets the document revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTemplate() | Gets the document template name. |
| setTemplate(String value) | Sets the document template name. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getVersion() | Gets the version number of the application that created the document. |
| setVersion(String value) | Sets the version number of the application that created the document. |
| getContentTypeProperties() | Gets the metadata package containing the content type properties. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getLanguage()
```
public final String getLanguage()
```

Gets the document language.

**Returns:**
java.lang.String - The document language.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the document language.

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

##### getAuthor()
```
public final String getAuthor()
```

Gets the document author.

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

Sets the document author.

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

##### getCategory()
```
public final String getCategory()
```

Gets the category.

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

Sets the category.

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

##### getComments()
```
public final String getComments()
```

Gets the comments.

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

Sets the comments.

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

##### getCompany()
```
public final String getCompany()
```

Gets the company.

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

Sets the company.

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

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status.

**Returns:**
java.lang.String - The content status.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status.

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

##### getContentType()
```
public final String getContentType()
```

Gets the content type.

**Returns:**
java.lang.String - The type of the content.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The created time.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

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

##### getTotalEditingTime()
```
public final Double getTotalEditingTime()
```

Gets the total editing time in minutes.

**Returns:**
java.lang.Double - The total editing time.
##### setTotalEditingTime(Double value)
```
public final void setTotalEditingTime(Double value)
```

Sets the total editing time in minutes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The total editing time. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

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

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

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

Sets the keywords.

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

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the time of the last saving in UTC.

**Returns:**
java.util.Date - The time of the last saving.
##### setLastSavedTime(Date value)
```
public final void setLastSavedTime(Date value)
```

Sets the time of the last saving in UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The time of the last saving. |

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date in UTC.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date in UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The name of the last author.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the last author. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

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

Sets the manager.

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

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of application.

**Returns:**
java.lang.String - The name of application.
##### setNameOfApplication(String value)
```
public final void setNameOfApplication(String value)
```

Sets the name of application.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of application. |

##### getRevision()
```
public final String getRevision()
```

Gets the document revision number.

**Returns:**
java.lang.String - The revision number.
##### setRevision(String value)
```
public final void setRevision(String value)
```

Sets the document revision number.

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

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

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

Sets the subject.

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

##### getTemplate()
```
public final String getTemplate()
```

Gets the document template name.

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

Sets the document template name.

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

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

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

Sets the title of the document.

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

##### getVersion()
```
public final String getVersion()
```

Gets the version number of the application that created the document.

**Returns:**
java.lang.String - The version.

Its format is "00.0000",for example 12.0000
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the version number of the application that created the document.

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

Its format is "00.0000",for example 12.0000 |

##### getContentTypeProperties()
```
public final SpreadsheetContentTypePackage getContentTypeProperties()
```

Gets the metadata package containing the content type properties.

**Returns:**
SpreadsheetContentTypePackage - The metadata package containing the content type properties.
##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### SpreadsheetRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class SpreadsheetRootPackage extends DocumentRootPackage<SpreadsheetPackage>
```

Represents the root package allowing working with metadata in a spreadsheet.

This code snippet demonstrates how to extract built-in metadata properties from a spreadsheet.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputXlsx)) {
>      SpreadsheetRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLanguage());
>      System.out.println(root.getDocumentProperties().getContentType());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getSpreadsheetType()
```
public final SpreadsheetTypePackage getSpreadsheetType()
```

Gets the file type metadata package.

**Returns:**
SpreadsheetTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final SpreadsheetInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
SpreadsheetInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### SpreadsheetSheet
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheetsheet.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SpreadsheetSheet extends CustomPackage
```

Represents a sheet in a spreadsheet document.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the sheet name. |
| getNumber() | Gets the sheet number. |
##### getName()
```
public final String getName()
```

Gets the sheet name.

**Returns:**
java.lang.String - The sheet name.
##### getNumber()
```
public final int getNumber()
```

Gets the sheet number.

**Returns:**
int - The sheet number.

### SpreadsheetTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/spreadsheettypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class SpreadsheetTypePackage extends FileTypePackage
```

Represents a metadata package containing spreadsheet-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetFormat() | Gets the exact spreadsheet format. |
##### getSpreadsheetFormat()
```
public final SpreadsheetFormat getSpreadsheetFormat()
```

Gets the exact spreadsheet format.

**Returns:**
SpreadsheetFormat - The exact spreadsheet format.

### TarFile
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tarfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TarFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the size in bytes. |
| getName() | Gets the entry name. |
##### getSize()
```
public final long getSize()
```

Gets the size in bytes.

Value: The size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String

### TarPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tarpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TarPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputTar))
>  {
>      var root = metadata.GetRootPackage<TarRootPackage>();
>      Console.WriteLine(root.TarPackage.TotalEntries);
>      foreach (var file in root.TarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.Size);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final TarFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.TarFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### TarRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tarrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class TarRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputTar))
>  {
>      var root = metadata.GetRootPackage<TarRootPackage>();
>      Console.WriteLine(root.TarPackage.TotalEntries);
>      foreach (var file in root.TarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getTarPackage() | Gets the ZIP metadata package. |
##### getTarPackage()
```
public final TarPackage getTarPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
TarPackage

### TiffArrayTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffarraytag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag
```
public abstract class TiffArrayTag<T> extends TiffTag
```

Represents an array-based TIFF tag.

 T : The type of array values.
#### Methods

| Method | Description |
| --- | --- |
| getTagValue() | Gets the tag value. |
##### getTagValue()
```
public final T[] getTagValue()
```

Gets the tag value.

**Returns:**
T[] - The tag value.

### TiffAsciiTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffasciitag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag
```
public final class TiffAsciiTag extends TiffTag
```

Represents a TIFF ASCII tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffAsciiTag(TiffTagID tagID, String value) | Initializes a new instance of the  TiffAsciiTag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTagValue() | Gets the tag value. |
##### TiffAsciiTag(TiffTagID tagID, String value)
```
public TiffAsciiTag(TiffTagID tagID, String value)
```

Initializes a new instance of the  TiffAsciiTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | java.lang.String | The value. |

##### getTagValue()
```
public final String getTagValue()
```

Gets the tag value.

**Returns:**
java.lang.String - The tag value.

### TiffByteTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffbytetag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffByteTag extends TiffArrayTag<Byte>
```

Represents a Byte tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffByteTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffByteTag  class. |
##### TiffByteTag(TiffTagID tagID, byte[] value)
```
public TiffByteTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffByteTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TiffDoubleTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffdoubletag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffDoubleTag extends TiffArrayTag<Double>
```

Represents a TIFF Double tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffDoubleTag(TiffTagID tagID, double[] value) | Initializes a new instance of the  TiffDoubleTag  class. |
##### TiffDoubleTag(TiffTagID tagID, double[] value)
```
public TiffDoubleTag(TiffTagID tagID, double[] value)
```

Initializes a new instance of the  TiffDoubleTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | double[] | The value. |

### TiffFloatTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tifffloattag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffFloatTag extends TiffArrayTag<Float>
```

Represents a TIFF float tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffFloatTag(TiffTagID tagID, float[] value) | Initializes a new instance of the  TiffFloatTag  class. |
##### TiffFloatTag(TiffTagID tagID, float[] value)
```
public TiffFloatTag(TiffTagID tagID, float[] value)
```

Initializes a new instance of the  TiffFloatTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | float[] | The value. |

### TiffLongTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tifflongtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffLongTag extends TiffArrayTag<Long>
```

Represents a TIFF Long tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffLongTag(TiffTagID tagID, long[] value) | Initializes a new instance of the  TiffLongTag  class. |
##### TiffLongTag(TiffTagID tagID, long[] value)
```
public TiffLongTag(TiffTagID tagID, long[] value)
```

Initializes a new instance of the  TiffLongTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | long[] | The value. |

### TiffRational
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffrational.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class TiffRational implements System.IEquatable<TiffRational>
```

Represents a rational number.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffRational(long numerator, long denominator) | Initializes a new instance of the  TiffRational  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets the numerator. |
| getDenominator() | Gets the denominator. |
| getValue() | Gets the rational value. |
| equals(TiffRational rational, TiffRational other) | Compares a pair of  TiffRational  numbers. |
| equals(TiffRational other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| hashCode() | Returns a hash code for this instance. |
| op_Equality(TiffRational left, TiffRational right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(TiffRational left, TiffRational right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a  string  that represents this instance. |
##### TiffRational(long numerator, long denominator)
```
public TiffRational(long numerator, long denominator)
```

Initializes a new instance of the  TiffRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | long | The numerator. |
| denominator | long | The denominator. |

##### getNumerator()
```
public final long getNumerator()
```

Gets the numerator.

**Returns:**
long - The numerator.
##### getDenominator()
```
public final long getDenominator()
```

Gets the denominator.

**Returns:**
long - The denominator.
##### getValue()
```
public final double getValue()
```

Gets the rational value.

**Returns:**
double - The rational value.
##### equals(TiffRational rational, TiffRational other)
```
public static boolean equals(TiffRational rational, TiffRational other)
```

Compares a pair of  TiffRational  numbers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffRational | A rational number. |
| other | TiffRational | Another rational number. |

**Returns:**
boolean -  true  if the objects are equal; otherwise,  false .
##### equals(TiffRational other)
```
public final boolean equals(TiffRational other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffRational | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  other  parameter; otherwise,  false .
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  obj  parameter; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### op_Equality(TiffRational left, TiffRational right)
```
public static boolean op_Equality(TiffRational left, TiffRational right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(TiffRational left, TiffRational right)
```
public static boolean op_Inequality(TiffRational left, TiffRational right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The right object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  string  that represents this instance.

**Returns:**
java.lang.String - A  string  that represents this instance.

### TiffRationalTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffrationaltag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffRationalTag extends TiffArrayTag<TiffRational>
```

Represents a TIFF Rational tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffRationalTag(TiffTagID tagID, TiffRational[] value) | Initializes a new instance of the  TiffRationalTag  class. |
##### TiffRationalTag(TiffTagID tagID, TiffRational[] value)
```
public TiffRationalTag(TiffTagID tagID, TiffRational[] value)
```

Initializes a new instance of the  TiffRationalTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffRational\[\] | The value. |

### TiffRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif, com.groupdocs.metadata.core.IIptc
```
public class TiffRootPackage extends ImageRootPackage implements IXmp, IExif, IIptc
```

Represents the root package allowing working with metadata in a TIFF image.

This example shows how to extract basic IPTC metadata properties from a TIFF image.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.TiffWithIptc)) {
>      TiffRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getIptcPackage() != null) {
>          if (root.getIptcPackage().getEnvelopeRecord() != null) {
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getDateSent());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getDestination());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getFileFormat());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getFileFormatVersion());
>              // ...
>          }
>          if (root.getIptcPackage().getApplicationRecord() != null) {
>              System.out.println(root.getIptcPackage().getApplicationRecord().getHeadline());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getByLine());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getByLineTitle());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getCaptionAbstract());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getCity());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getDateCreated());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getReleaseDate());
>              // ...
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in TIFF images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+TIFF+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

### TiffSByteTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffsbytetag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSByteTag extends TiffArrayTag<Byte>
```

Represents a TIFF SByte tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSByteTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffSByteTag  class. |
##### TiffSByteTag(TiffTagID tagID, byte[] value)
```
public TiffSByteTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffSByteTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TiffShortTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffshorttag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffShortTag extends TiffArrayTag<Integer>
```

Represents a TIFF Short tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffShortTag(TiffTagID tagID, int[] value) | Initializes a new instance of the  TiffShortTag  class. |
##### TiffShortTag(TiffTagID tagID, int[] value)
```
public TiffShortTag(TiffTagID tagID, int[] value)
```

Initializes a new instance of the  TiffShortTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | int[] | The value. |

### TiffSLongTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffslongtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSLongTag extends TiffArrayTag<Integer>
```

Represents a TIFF SLong tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSLongTag(TiffTagID tagID, int[] value) | Initializes a new instance of the  TiffSLongTag  class. |
##### TiffSLongTag(TiffTagID tagID, int[] value)
```
public TiffSLongTag(TiffTagID tagID, int[] value)
```

Initializes a new instance of the  TiffSLongTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | int[] | The value. |

### TiffSRational
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffsrational.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class TiffSRational implements System.IEquatable<TiffSRational>
```

Represents signed rational number.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSRational(int numerator, int denominator) | Initializes a new instance of the  TiffSRational  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets numerator. |
| getDenominator() | Gets denominator. |
| getValue() | Gets actual value represented as double. |
| equals(TiffSRational rational, TiffSRational other) | Compares pair of  TiffSRational . |
| equals(TiffSRational other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| hashCode() | Returns a hash code for this instance. |
| op_Equality(TiffSRational left, TiffSRational right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(TiffSRational left, TiffSRational right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a  System.String  that represents this instance. |
##### TiffSRational(int numerator, int denominator)
```
public TiffSRational(int numerator, int denominator)
```

Initializes a new instance of the  TiffSRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

##### getNumerator()
```
public final int getNumerator()
```

Gets numerator.

**Returns:**
int - The numerator.
##### getDenominator()
```
public final int getDenominator()
```

Gets denominator.

**Returns:**
int - The denominator.
##### getValue()
```
public final double getValue()
```

Gets actual value represented as double.

**Returns:**
double - Double value.
##### equals(TiffSRational rational, TiffSRational other)
```
public static boolean equals(TiffSRational rational, TiffSRational other)
```

Compares pair of  TiffSRational .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffSRational | Comparing item. |
| other | TiffSRational | Other item. |

**Returns:**
boolean -  true  if objects are equal; otherwise  false .
##### equals(TiffSRational other)
```
public final boolean equals(TiffSRational other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffSRational | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  other  parameter; otherwise,  false .
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  obj  parameter; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### op_Equality(TiffSRational left, TiffSRational right)
```
public static boolean op_Equality(TiffSRational left, TiffSRational right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(TiffSRational left, TiffSRational right)
```
public static boolean op_Inequality(TiffSRational left, TiffSRational right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  System.String  that represents this instance.

**Returns:**
java.lang.String - A  System.String  that represents this instance.

### TiffSRationalTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffsrationaltag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSRationalTag extends TiffArrayTag<TiffSRational>
```

Represents a TIFF SRational tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSRationalTag(TiffTagID tagID, TiffSRational[] value) | Initializes a new instance of the  TiffSRationalTag  class. |
##### TiffSRationalTag(TiffTagID tagID, TiffSRational[] value)
```
public TiffSRationalTag(TiffTagID tagID, TiffSRational[] value)
```

Initializes a new instance of the  TiffSRationalTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffSRational\[\] | The value. |

### TiffSShortTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffsshorttag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSShortTag extends TiffArrayTag<Short>
```

Represents a TIFF SShort tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSShortTag(TiffTagID tagID, short[] value) | Initializes a new instance of the  TiffSShortTag  class. |
##### TiffSShortTag(TiffTagID tagID, short[] value)
```
public TiffSShortTag(TiffTagID tagID, short[] value)
```

Initializes a new instance of the  TiffSShortTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | short[] | The value. |

### TiffTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tifftag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public abstract class TiffTag extends MetadataProperty
```

Represents a TIFF tag.
#### Methods

| Method | Description |
| --- | --- |
| getTagType() | Gets the type of the tag. |
| getTagID() | Gets the tag id. |
##### getTagType()
```
public final TiffTagType getTagType()
```

Gets the type of the tag.

**Returns:**
TiffTagType - The tag type.
##### getTagID()
```
public final TiffTagID getTagID()
```

Gets the tag id.

**Returns:**
TiffTagID - The tag id.

### TiffTagID
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tifftagid.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class TiffTagID implements IEnumValue
```

Defines ids of TIFF tags.
#### Fields

| Field | Description |
| --- | --- |
| GpsVersionID | Indicates the version of GPSInfoIFD. |
| GpsLatitudeRef | Indicates whether the latitude is north or south latitude. |
| GpsLatitude | Indicates the latitude. |
| GpsLongitudeRef | Indicates whether the longitude is east or west longitude. |
| GpsLongitude | Indicates the longitude. |
| GpsAltitudeRef | Indicates the altitude used as the reference altitude. |
| GpsAltitude | Indicates the altitude based on the reference in GPSAltitudeRef. |
| GpsTimeStamp | Indicates the time as UTC (Coordinated Universal Time). |
| GpsSatellites | ndicates the GPS satellites used for measurements. |
| GpsStatus | Indicates the status of the GPS receiver when the image is recorded. |
| GpsMeasureMode | Indicates the GPS measurement mode. |
| GpsDop | Indicates the GPS DOP (data degree of precision). |
| GpsSpeedRef | Indicates the unit used to express the GPS receiver speed of movement |
| GpsSpeed | Indicates the speed of GPS receiver movement. |
| GpsTrackRef | Indicates the reference for giving the direction of GPS receiver movement. |
| GpsTrack | Indicates the direction of GPS receiver movement. |
| GpsImgDirectionRef | Indicates the reference for giving the direction of the image when it is captured. |
| GpsImgDirection | Indicates the direction of the image when it was captured. |
| GpsMapDatum | Indicates the geodetic survey data used by the GPS receiver. |
| GpsDestLatitudeRef | Indicates whether the latitude of the destination point is north or south latitude. |
| GpsDestLatitude | Indicates the latitude of the destination point. |
| GpsDestLongitudeRef | Indicates whether the longitude of the destination point is east or west longitude. |
| GpsDestLongitude | Indicates the longitude of the destination point. |
| GpsDestBearingRef | Indicates the reference used for giving the bearing to the destination point. |
| GpsDestBearing | Indicates the bearing to the destination point. |
| GpsDestDistanceRef | Indicates the unit used to express the distance to the destination point. |
| GpsDestDistance | Indicates the distance to the destination point. |
| GpsProcessingMethod | A character string recording the name of the method used for location finding. |
| GpsAreaInformation | A character string recording the name of the GPS area. |
| GpsDateStamp | A character string recording date and time information relative to UTC (Coordinated Universal Time). |
| GpsDifferential | Indicates whether differential correction is applied to the GPS receiver. |
| GpsHPositioningError | This tag indicates horizontal positioning errors in meters. |
| NewSubfileType | A general indication of the kind of data contained in this sub-file. |
| SubfileType | A general indication of the kind of data contained in this subfile. |
| ImageWidth | The number of columns in the image, i.e., the number of pixels per scan line. |
| ImageLength | The number of rows (sometimes described as scan lines) in the image. |
| BitsPerSample | Number of bits per component. |
| Compression | Compression scheme used on the image data. |
| PhotometricInterpretation | The color space of the image data. |
| Threshholding | For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels. |
| CellWidth | The width of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| CellLength | The length of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| FillOrder | The logical order of bits within a byte. |
| DocumentName | The name of the document from which this image was scanned. |
| ImageDescription | A string that describes the subject of the image. |
| Make | The scanner manufacturer. |
| Model | The scanner model name or number. |
| StripOffsets | For each strip, the byte offset of that strip. |
| Orientation | The orientation of the image with respect to the rows and columns. |
| SamplesPerPixel | The number of components per pixel. |
| RowsPerStrip | The number of rows per strip. |
| StripByteCounts | For each strip, the number of bytes in the strip after compression. |
| MinSampleValue | The minimum component value used. |
| MaxSampleValue | The maximum component value used. |
| XResolution | The number of pixels per ResolutionUnit in the ImageWidth direction. |
| YResolution | The number of pixels per ResolutionUnit in the ImageLength direction. |
| PlanarConfiguration | How the components of each pixel are stored. |
| PageName | The name of the page from which this image was scanned. |
| XPosition | X position of the image. |
| YPosition | Y position of the image. |
| FreeOffsets | For each string of contiguous unused bytes in a TIFF file, the byte offset of the string. |
| FreeByteCounts | For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string. |
| GrayResponseUnit | The precision of the information contained in the GrayResponseCurve. |
| GrayResponseCurve | For grayscale data, the optical density of each possible pixel value. |
| T4Options | T4-encoding options. |
| T6Options | T6-encoding options. |
| ResolutionUnit | The unit of measurement for XResolution and YResolution. |
| PageNumber | The page number of the page from which this image was scanned. |
| TransferFunction | Describes a transfer function for the image in tabular style. |
| Software | Name and version number of the software package(s) used to create the image. |
| DateTime | Date and time of image creation. |
| Artist | Person who created the image. |
| HostComputer | The computer and/or operating system in use at the time of image creation. |
| Predictor | This section defines a Predictor that greatly improves compression ratios for some images. |
| WhitePoint | The chromaticity of the white point of the image. |
| PrimaryChromaticities | The chromaticities of the primaries of the image. |
| ColorMap | A color map for palette color images. |
| HalftoneHints | The purpose of the HalftoneHints field is to convey to the halftone function the range of gray levels within a colorimetrically-specified image that should retain tonal detail. |
| TileWidth | The tile width in pixels. |
| TileLength | The tile length (height) in pixels. |
| TileOffsets | For each tile, the byte offset of that tile, as compressed and stored on disk. |
| TileByteCounts | For each tile, the number of (compressed) bytes in that tile. |
| InkSet | The set of inks used in a separated (PhotometricInterpretation=5) image. |
| InkNames | The name of each ink used in a separated (PhotometricInterpretation=5) image, written as a list of concatenated, NUL-terminated ASCII strings. |
| NumberOfInks | The number of inks. |
| DotRange | The component values that correspond to a 0% dot and 100% dot. |
| ExtraSamples | Description of extra components. |
| SampleFormat | This field specifies how to interpret each data sample in a pixel. |
| SMinSampleValue | This field specifies the minimum sample value. |
| SMaxSampleValue | This new field specifies the maximum sample value. |
| TransferRange | Expands the range of the TransferFunction. |
| JpegProc | This Field indicates the JPEG process used to produce the compressed data. |
| JpegInterchangeFormat | This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file. |
| JpegInterchangeFormatLength | This Field indicates the length in bytes of the JPEG interchange format bitstream |
| JpegRestartInterval | This Field indicates the length of the restart interval used in the compressed image data. |
| JpegLosslessPredictors | This Field points to a list of lossless predictor-selection values, one per component. |
| JpegPointTransforms | This Field points to a list of point transform values, one per component. |
| JpegQTables | This Field points to a list of offsets to the quantization tables, one per component. |
| JpegDCTables | This Field points to a list of offsets to the DC Huffman tables or the lossless Huffman tables, one per component. |
| JpegACTables | This Field points to a list of offsets to the Huffman AC tables, one per component. |
| YCbCrCoefficients | The matrix cofficients for transformation from RGB to YCbCr image data. |
| YCbCrSubSampling | The sampling ratio of chrominance components in relation to the luminance component. |
| YCbCrPositioning | Specifies the positioning of subsampled chrominance components relative to luminance samples. |
| ReferenceBlackWhite | Specifies a pair of headroom and footroom image data values (codes) for each pixel component. |
| Copyright | Copyright notice. |
| UserComment | Keywords or comments on the image; complements ImageDescription. |
| Xmp | Pointer to the XMP metadata. |
| ImageID | OPI-related. |
| Iptc | IPTC (International Press Telecommunications Council) metadata. |
| Photoshop | Collection of Photoshop 'Image Resource Blocks'. |
| ImageLayer | Image layer. |
| IccProfile | Color profile data. |
| ExifIfd | Pointer to collection of all EXIF Metadata. |
| GpsIfd | Pointer to GPS data. |
| Makernotes | Pointer to makernotes data. |
| InteroperabilityIfd | Exif-related Interoperability IFD. |
| CameraOwnerName | Camera owner name as ASCII string. |
| BodySerialNumber | Camera body serial number as ASCII string. |
| CfaPattern | ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| ExifVersion | The version of the EXIF standard supported. |
| ComponentsConfiguration | Information specific to the compressed data. |
| FlashpixVersion | The Flashpix format version supported by a FPXR file. |
| ColorSpace | The color space information tag (ColorSpace) is always recorded as the color space specifier. |
| PixelXDimension | Information specific to compressed data. |
| PixelYDimension | Information specific to compressed data. |
| SceneCaptureType | This tag indicates the type of scene that was shot. |
| Gamma | Indicates the value of coefficient gamma. |
| CompressedBitsPerPixel | Information specific to compressed data. |
| RelatedSoundFile | This tag is used to record the name of an audio file related to the image data. |
| DateTimeOriginal | The date and time when the original image data was generated. |
| DateTimeDigitized | The date and time when the image was stored as digital data. |
| OffsetTime | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag. |
| OffsetTimeOriginal | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag. |
| OffsetTimeDigitized | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag. |
| SubsecTime | A tag used to record fractions of seconds for the DateTime tag. |
| SubsecTimeOriginal | A tag used to record fractions of seconds for the DateTimeOriginal tag. |
| SubsecTimeDigitized | A tag used to record fractions of seconds for the DateTimeDigitized tag. |
| ExposureTime | Exposure time, given in seconds (sec). |
| FNumber | The F number. |
| ExposureProgram | The class of the program used by the camera to set exposure when the picture is taken. |
| SpectralSensitivity | Indicates the spectral sensitivity of each channel of the camera used. |
| PhotographicSensitivity | This tag indicates the sensitivity of the camera or input device when the image was shot. |
| Oecf | Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524. |
| SensitivityType | The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag. |
| StandardOutputSensitivity | This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232. |
| RecommendedExposureIndex | This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232. |
| IsoSpeed | This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. |
| ISOSpeedLatitudeYyy | This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232. |
| ISOSpeedLatitudeZzz | This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232. |
| ShutterSpeedValue | Shutter speed. |
| ApertureValue | The lens aperture. |
| BrightnessValue | The value of brightness. |
| ExposureBiasValue | The exposure bias. |
| MaxApertureValue | The smallest F number of the lens. |
| SubjectDistance | The distance to the subject, given in meters. |
| MeteringMode | The metering mode. |
| LightSource | The kind of light source. |
| Flash | This tag indicates the status of flash when the image was shot. |
| SubjectArea | This tag indicates the location and area of the main subject in the overall scene. |
| FocalLength | The actual focal length of the lens, in mm. |
| FlashEnergy | Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS). |
| SpatialFrequencyResponse | This tag records the camera or input device spatial frequency table and SFR values in the direction of image width, image height, and diagonal direction, as specified in ISO 12233. |
| FocalPlaneXResolution | Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneYResolution | Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneResolutionUnit | Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. |
| SubjectLocation | Indicates the location of the main subject in the scene. |
| ExposureIndex | Indicates the exposure index selected on the camera or input device at the time the image is captured. |
| SensingMethod | Indicates the image sensor type on the camera or input device. |
| FileSource | Indicates the image source. |
| SceneType | Indicates the type of scene. |
| CustomRendered | This tag indicates the use of special processing on image data, such as rendering geared to output. |
| ExposureMode | This tag indicates the exposure mode set when the image was shot. |
| WhiteBalance | This tag indicates the white balance mode set when the image was shot. |
| DigitalZoomRatio | This tag indicates the digital zoom ratio when the image was shot. |
| FocalLengthIn35mmFilm | This tag indicates the equivalent focal length assuming a 35mm film camera, in mm. |
| GainControl | This tag indicates the degree of overall image gain adjustment. |
| Contrast | This tag indicates the direction of contrast processing applied by the camera when the image was shot. |
| Saturation | This tag indicates the direction of saturation processing applied by the camera when the image was shot. |
| Sharpness | This tag indicates the direction of sharpness processing applied by the camera when the image was shot. |
| DeviceSettingDescription | This tag indicates information on the picture-taking conditions of a particular camera model. |
| SubjectDistanceRange | This tag indicates the distance to the subject. |
| CompositeImage | This tag indicates whether the recorded image is a composite image\* or not. |
| SourceImageNumberOfCompositeImage | This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image. |
| SourceExposureTimesOfCompositeImage | For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image, such as respective exposure times of captured source images (tentatively recorded images). |
| Temperature | Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. |
| Humidity | Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. |
| Pressure | Pressure as the ambient situation at the shot, for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea. |
| WaterDepth | Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. |
| Acceleration | Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot. |
| CameraElevationAngle | Elevation/depression. |
| ImageUniqueID | This tag indicates an identifier assigned uniquely to each image. |
| LensSpecification | This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length, and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography. |
| LensMake | This tag records the lens manufacturer as an ASCII string. |
| LensModel | This tag records the lens\\u2019s model name and model number as an ASCII string. |
| LensSerialNumber | This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| values() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### GpsVersionID
```
public static final TiffTagID GpsVersionID
```

Indicates the version of GPSInfoIFD.

##### GpsLatitudeRef
```
public static final TiffTagID GpsLatitudeRef
```

Indicates whether the latitude is north or south latitude.

##### GpsLatitude
```
public static final TiffTagID GpsLatitude
```

Indicates the latitude.

##### GpsLongitudeRef
```
public static final TiffTagID GpsLongitudeRef
```

Indicates whether the longitude is east or west longitude.

##### GpsLongitude
```
public static final TiffTagID GpsLongitude
```

Indicates the longitude.

##### GpsAltitudeRef
```
public static final TiffTagID GpsAltitudeRef
```

Indicates the altitude used as the reference altitude.

##### GpsAltitude
```
public static final TiffTagID GpsAltitude
```

Indicates the altitude based on the reference in GPSAltitudeRef.

##### GpsTimeStamp
```
public static final TiffTagID GpsTimeStamp
```

Indicates the time as UTC (Coordinated Universal Time).

##### GpsSatellites
```
public static final TiffTagID GpsSatellites
```

ndicates the GPS satellites used for measurements.

##### GpsStatus
```
public static final TiffTagID GpsStatus
```

Indicates the status of the GPS receiver when the image is recorded.

##### GpsMeasureMode
```
public static final TiffTagID GpsMeasureMode
```

Indicates the GPS measurement mode.

##### GpsDop
```
public static final TiffTagID GpsDop
```

Indicates the GPS DOP (data degree of precision).

##### GpsSpeedRef
```
public static final TiffTagID GpsSpeedRef
```

Indicates the unit used to express the GPS receiver speed of movement

##### GpsSpeed
```
public static final TiffTagID GpsSpeed
```

Indicates the speed of GPS receiver movement.

##### GpsTrackRef
```
public static final TiffTagID GpsTrackRef
```

Indicates the reference for giving the direction of GPS receiver movement.

##### GpsTrack
```
public static final TiffTagID GpsTrack
```

Indicates the direction of GPS receiver movement.

##### GpsImgDirectionRef
```
public static final TiffTagID GpsImgDirectionRef
```

Indicates the reference for giving the direction of the image when it is captured.

##### GpsImgDirection
```
public static final TiffTagID GpsImgDirection
```

Indicates the direction of the image when it was captured.

##### GpsMapDatum
```
public static final TiffTagID GpsMapDatum
```

Indicates the geodetic survey data used by the GPS receiver.

##### GpsDestLatitudeRef
```
public static final TiffTagID GpsDestLatitudeRef
```

Indicates whether the latitude of the destination point is north or south latitude.

##### GpsDestLatitude
```
public static final TiffTagID GpsDestLatitude
```

Indicates the latitude of the destination point.

##### GpsDestLongitudeRef
```
public static final TiffTagID GpsDestLongitudeRef
```

Indicates whether the longitude of the destination point is east or west longitude.

##### GpsDestLongitude
```
public static final TiffTagID GpsDestLongitude
```

Indicates the longitude of the destination point.

##### GpsDestBearingRef
```
public static final TiffTagID GpsDestBearingRef
```

Indicates the reference used for giving the bearing to the destination point.

##### GpsDestBearing
```
public static final TiffTagID GpsDestBearing
```

Indicates the bearing to the destination point.

##### GpsDestDistanceRef
```
public static final TiffTagID GpsDestDistanceRef
```

Indicates the unit used to express the distance to the destination point.

##### GpsDestDistance
```
public static final TiffTagID GpsDestDistance
```

Indicates the distance to the destination point.

##### GpsProcessingMethod
```
public static final TiffTagID GpsProcessingMethod
```

A character string recording the name of the method used for location finding.

##### GpsAreaInformation
```
public static final TiffTagID GpsAreaInformation
```

A character string recording the name of the GPS area.

##### GpsDateStamp
```
public static final TiffTagID GpsDateStamp
```

A character string recording date and time information relative to UTC (Coordinated Universal Time).

##### GpsDifferential
```
public static final TiffTagID GpsDifferential
```

Indicates whether differential correction is applied to the GPS receiver.

##### GpsHPositioningError
```
public static final TiffTagID GpsHPositioningError
```

This tag indicates horizontal positioning errors in meters.

##### NewSubfileType
```
public static final TiffTagID NewSubfileType
```

A general indication of the kind of data contained in this sub-file.

##### SubfileType
```
public static final TiffTagID SubfileType
```

A general indication of the kind of data contained in this subfile. This field is deprecated. The NewSubfileType field should be used instead

##### ImageWidth
```
public static final TiffTagID ImageWidth
```

The number of columns in the image, i.e., the number of pixels per scan line.

##### ImageLength
```
public static final TiffTagID ImageLength
```

The number of rows (sometimes described as scan lines) in the image.

##### BitsPerSample
```
public static final TiffTagID BitsPerSample
```

Number of bits per component.

##### Compression
```
public static final TiffTagID Compression
```

Compression scheme used on the image data.

##### PhotometricInterpretation
```
public static final TiffTagID PhotometricInterpretation
```

The color space of the image data.

##### Threshholding
```
public static final TiffTagID Threshholding
```

For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels.

##### CellWidth
```
public static final TiffTagID CellWidth
```

The width of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file.

##### CellLength
```
public static final TiffTagID CellLength
```

The length of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file.

##### FillOrder
```
public static final TiffTagID FillOrder
```

The logical order of bits within a byte.

##### DocumentName
```
public static final TiffTagID DocumentName
```

The name of the document from which this image was scanned.

##### ImageDescription
```
public static final TiffTagID ImageDescription
```

A string that describes the subject of the image.

##### Make
```
public static final TiffTagID Make
```

The scanner manufacturer.

##### Model
```
public static final TiffTagID Model
```

The scanner model name or number.

##### StripOffsets
```
public static final TiffTagID StripOffsets
```

For each strip, the byte offset of that strip.

##### Orientation
```
public static final TiffTagID Orientation
```

The orientation of the image with respect to the rows and columns.

##### SamplesPerPixel
```
public static final TiffTagID SamplesPerPixel
```

The number of components per pixel.

##### RowsPerStrip
```
public static final TiffTagID RowsPerStrip
```

The number of rows per strip.

##### StripByteCounts
```
public static final TiffTagID StripByteCounts
```

For each strip, the number of bytes in the strip after compression.

##### MinSampleValue
```
public static final TiffTagID MinSampleValue
```

The minimum component value used.

##### MaxSampleValue
```
public static final TiffTagID MaxSampleValue
```

The maximum component value used.

##### XResolution
```
public static final TiffTagID XResolution
```

The number of pixels per ResolutionUnit in the ImageWidth direction.

##### YResolution
```
public static final TiffTagID YResolution
```

The number of pixels per ResolutionUnit in the ImageLength direction.

##### PlanarConfiguration
```
public static final TiffTagID PlanarConfiguration
```

How the components of each pixel are stored.

##### PageName
```
public static final TiffTagID PageName
```

The name of the page from which this image was scanned.

##### XPosition
```
public static final TiffTagID XPosition
```

X position of the image.

##### YPosition
```
public static final TiffTagID YPosition
```

Y position of the image.

##### FreeOffsets
```
public static final TiffTagID FreeOffsets
```

For each string of contiguous unused bytes in a TIFF file, the byte offset of the string.

##### FreeByteCounts
```
public static final TiffTagID FreeByteCounts
```

For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string.

##### GrayResponseUnit
```
public static final TiffTagID GrayResponseUnit
```

The precision of the information contained in the GrayResponseCurve.

##### GrayResponseCurve
```
public static final TiffTagID GrayResponseCurve
```

For grayscale data, the optical density of each possible pixel value.

##### T4Options
```
public static final TiffTagID T4Options
```

T4-encoding options.

##### T6Options
```
public static final TiffTagID T6Options
```

T6-encoding options.

##### ResolutionUnit
```
public static final TiffTagID ResolutionUnit
```

The unit of measurement for XResolution and YResolution.

##### PageNumber
```
public static final TiffTagID PageNumber
```

The page number of the page from which this image was scanned.

##### TransferFunction
```
public static final TiffTagID TransferFunction
```

Describes a transfer function for the image in tabular style. Pixel components can be gamma-compensated, companded, non-uniformly quantized, or coded in some other way. The TransferFunction maps the pixel components from a non-linear BitsPerSample (e.g. 8-bit) form into a 16-bit linear form without a perceptible loss of accuracy.

##### Software
```
public static final TiffTagID Software
```

Name and version number of the software package(s) used to create the image.

##### DateTime
```
public static final TiffTagID DateTime
```

Date and time of image creation.

##### Artist
```
public static final TiffTagID Artist
```

Person who created the image.

##### HostComputer
```
public static final TiffTagID HostComputer
```

The computer and/or operating system in use at the time of image creation.

##### Predictor
```
public static final TiffTagID Predictor
```

This section defines a Predictor that greatly improves compression ratios for some images.

##### WhitePoint
```
public static final TiffTagID WhitePoint
```

The chromaticity of the white point of the image.

##### PrimaryChromaticities
```
public static final TiffTagID PrimaryChromaticities
```

The chromaticities of the primaries of the image.

##### ColorMap
```
public static final TiffTagID ColorMap
```

A color map for palette color images.

##### HalftoneHints
```
public static final TiffTagID HalftoneHints
```

The purpose of the HalftoneHints field is to convey to the halftone function the range of gray levels within a colorimetrically-specified image that should retain tonal detail.

##### TileWidth
```
public static final TiffTagID TileWidth
```

The tile width in pixels. This is the number of columns in each tile.

##### TileLength
```
public static final TiffTagID TileLength
```

The tile length (height) in pixels. This is the number of rows in each tile.

##### TileOffsets
```
public static final TiffTagID TileOffsets
```

For each tile, the byte offset of that tile, as compressed and stored on disk. The offset is specified with respect to the beginning of the TIFF file. Note that this implies that each tile has a location independent of the locations of other tiles.

##### TileByteCounts
```
public static final TiffTagID TileByteCounts
```

For each tile, the number of (compressed) bytes in that tile.

##### InkSet
```
public static final TiffTagID InkSet
```

The set of inks used in a separated (PhotometricInterpretation=5) image.

##### InkNames
```
public static final TiffTagID InkNames
```

The name of each ink used in a separated (PhotometricInterpretation=5) image, written as a list of concatenated, NUL-terminated ASCII strings.

##### NumberOfInks
```
public static final TiffTagID NumberOfInks
```

The number of inks. Usually equal to SamplesPerPixel, unless there are extra samples.

##### DotRange
```
public static final TiffTagID DotRange
```

The component values that correspond to a 0% dot and 100% dot. DotRange[0] corresponds to a 0% dot, and DotRange[1] corresponds to a 100% dot.

##### ExtraSamples
```
public static final TiffTagID ExtraSamples
```

Description of extra components.

##### SampleFormat
```
public static final TiffTagID SampleFormat
```

This field specifies how to interpret each data sample in a pixel.

##### SMinSampleValue
```
public static final TiffTagID SMinSampleValue
```

This field specifies the minimum sample value.

##### SMaxSampleValue
```
public static final TiffTagID SMaxSampleValue
```

This new field specifies the maximum sample value.

##### TransferRange
```
public static final TiffTagID TransferRange
```

Expands the range of the TransferFunction.

##### JpegProc
```
public static final TiffTagID JpegProc
```

This Field indicates the JPEG process used to produce the compressed data.

##### JpegInterchangeFormat
```
public static final TiffTagID JpegInterchangeFormat
```

This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file.

##### JpegInterchangeFormatLength
```
public static final TiffTagID JpegInterchangeFormatLength
```

This Field indicates the length in bytes of the JPEG interchange format bitstream

##### JpegRestartInterval
```
public static final TiffTagID JpegRestartInterval
```

This Field indicates the length of the restart interval used in the compressed image data.

##### JpegLosslessPredictors
```
public static final TiffTagID JpegLosslessPredictors
```

This Field points to a list of lossless predictor-selection values, one per component.

##### JpegPointTransforms
```
public static final TiffTagID JpegPointTransforms
```

This Field points to a list of point transform values, one per component.

##### JpegQTables
```
public static final TiffTagID JpegQTables
```

This Field points to a list of offsets to the quantization tables, one per component.

##### JpegDCTables
```
public static final TiffTagID JpegDCTables
```

This Field points to a list of offsets to the DC Huffman tables or the lossless Huffman tables, one per component.

##### JpegACTables
```
public static final TiffTagID JpegACTables
```

This Field points to a list of offsets to the Huffman AC tables, one per component.

##### YCbCrCoefficients
```
public static final TiffTagID YCbCrCoefficients
```

The matrix cofficients for transformation from RGB to YCbCr image data.

##### YCbCrSubSampling
```
public static final TiffTagID YCbCrSubSampling
```

The sampling ratio of chrominance components in relation to the luminance component.

##### YCbCrPositioning
```
public static final TiffTagID YCbCrPositioning
```

Specifies the positioning of subsampled chrominance components relative to luminance samples.

##### ReferenceBlackWhite
```
public static final TiffTagID ReferenceBlackWhite
```

Specifies a pair of headroom and footroom image data values (codes) for each pixel component.

##### Copyright
```
public static final TiffTagID Copyright
```

Copyright notice.

##### UserComment
```
public static final TiffTagID UserComment
```

Keywords or comments on the image; complements ImageDescription.

##### Xmp
```
public static final TiffTagID Xmp
```

Pointer to the XMP metadata.

##### ImageID
```
public static final TiffTagID ImageID
```

OPI-related.

##### Iptc
```
public static final TiffTagID Iptc
```

IPTC (International Press Telecommunications Council) metadata. Often times, the data type is incorrectly specified as LONG.

##### Photoshop
```
public static final TiffTagID Photoshop
```

Collection of Photoshop 'Image Resource Blocks'.

##### ImageLayer
```
public static final TiffTagID ImageLayer
```

Image layer.

##### IccProfile
```
public static final TiffTagID IccProfile
```

Color profile data.

##### ExifIfd
```
public static final TiffTagID ExifIfd
```

Pointer to collection of all EXIF Metadata. EXIF uses field names rather than tags to indicate the field content.

##### GpsIfd
```
public static final TiffTagID GpsIfd
```

Pointer to GPS data.

##### Makernotes
```
public static final TiffTagID Makernotes
```

Pointer to makernotes data.

##### InteroperabilityIfd
```
public static final TiffTagID InteroperabilityIfd
```

Exif-related Interoperability IFD.

##### CameraOwnerName
```
public static final TiffTagID CameraOwnerName
```

Camera owner name as ASCII string.

##### BodySerialNumber
```
public static final TiffTagID BodySerialNumber
```

Camera body serial number as ASCII string.

##### CfaPattern
```
public static final TiffTagID CfaPattern
```

ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. It does not apply to all sensing methods.

##### ExifVersion
```
public static final TiffTagID ExifVersion
```

The version of the EXIF standard supported.

##### ComponentsConfiguration
```
public static final TiffTagID ComponentsConfiguration
```

Information specific to the compressed data. The channels of each component are arranged in order from the 1st component to the 4th.

##### FlashpixVersion
```
public static final TiffTagID FlashpixVersion
```

The Flashpix format version supported by a FPXR file. If the FPXR function supports Flashpix format Ver. 1.0, this is indicated similarly to ExifVersion by recording "0100" as 4-byte ASCII.

##### ColorSpace
```
public static final TiffTagID ColorSpace
```

The color space information tag (ColorSpace) is always recorded as the color space specifier. Normally sRGB (=1) is used to define the color space based on the PC monitor conditions and environment. If a color space other than sRGB is used, Uncalibrated (=FFFF.H) is set.

##### PixelXDimension
```
public static final TiffTagID PixelXDimension
```

Information specific to compressed data. When a compressed file is recorded, the valid width of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker.

##### PixelYDimension
```
public static final TiffTagID PixelYDimension
```

Information specific to compressed data. When a compressed file is recorded, the valid height of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker.

##### SceneCaptureType
```
public static final TiffTagID SceneCaptureType
```

This tag indicates the type of scene that was shot. It may also be used to record the mode in which the image was shot.

##### Gamma
```
public static final TiffTagID Gamma
```

Indicates the value of coefficient gamma.

##### CompressedBitsPerPixel
```
public static final TiffTagID CompressedBitsPerPixel
```

Information specific to compressed data. The compression mode used for a compressed image is indicated in unit bits per pixel.

##### RelatedSoundFile
```
public static final TiffTagID RelatedSoundFile
```

This tag is used to record the name of an audio file related to the image data. The only relational information recorded here is the Exif audio file name and extension (an ASCII string consisting of 8 characters + '.' + 3 characters).

##### DateTimeOriginal
```
public static final TiffTagID DateTimeOriginal
```

The date and time when the original image data was generated. For a DSC the date and time the picture was taken are recorded. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character.

##### DateTimeDigitized
```
public static final TiffTagID DateTimeDigitized
```

The date and time when the image was stored as digital data. If, for example, an image was captured by DSC and at the same time the file was recorded, then the DateTimeOriginal and DateTimeDigitized will have the same contents. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character.

##### OffsetTime
```
public static final TiffTagID OffsetTime
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### OffsetTimeOriginal
```
public static final TiffTagID OffsetTimeOriginal
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### OffsetTimeDigitized
```
public static final TiffTagID OffsetTimeDigitized
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### SubsecTime
```
public static final TiffTagID SubsecTime
```

A tag used to record fractions of seconds for the DateTime tag.

##### SubsecTimeOriginal
```
public static final TiffTagID SubsecTimeOriginal
```

A tag used to record fractions of seconds for the DateTimeOriginal tag.

##### SubsecTimeDigitized
```
public static final TiffTagID SubsecTimeDigitized
```

A tag used to record fractions of seconds for the DateTimeDigitized tag.

##### ExposureTime
```
public static final TiffTagID ExposureTime
```

Exposure time, given in seconds (sec).

##### FNumber
```
public static final TiffTagID FNumber
```

The F number.

##### ExposureProgram
```
public static final TiffTagID ExposureProgram
```

The class of the program used by the camera to set exposure when the picture is taken.

##### SpectralSensitivity
```
public static final TiffTagID SpectralSensitivity
```

Indicates the spectral sensitivity of each channel of the camera used. The tag value is an ASCII string compatible with the standard developed by the ASTM Technical committee.

##### PhotographicSensitivity
```
public static final TiffTagID PhotographicSensitivity
```

This tag indicates the sensitivity of the camera or input device when the image was shot.

##### Oecf
```
public static final TiffTagID Oecf
```

Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524. OECF is the relationship between the camera optical input and the image values.

##### SensitivityType
```
public static final TiffTagID SensitivityType
```

The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag. Although it is an optional tag, it should be recorded when a PhotographicSensitivity tag is recorded.

##### StandardOutputSensitivity
```
public static final TiffTagID StandardOutputSensitivity
```

This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### RecommendedExposureIndex
```
public static final TiffTagID RecommendedExposureIndex
```

This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### IsoSpeed
```
public static final TiffTagID IsoSpeed
```

This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### ISOSpeedLatitudeYyy
```
public static final TiffTagID ISOSpeedLatitudeYyy
```

This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232.

##### ISOSpeedLatitudeZzz
```
public static final TiffTagID ISOSpeedLatitudeZzz
```

This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232.

##### ShutterSpeedValue
```
public static final TiffTagID ShutterSpeedValue
```

Shutter speed. The unit is the APEX (Additive System of Photographic Exposure) setting.

##### ApertureValue
```
public static final TiffTagID ApertureValue
```

The lens aperture. The unit is the APEX value.

##### BrightnessValue
```
public static final TiffTagID BrightnessValue
```

The value of brightness. The unit is the APEX value.

##### ExposureBiasValue
```
public static final TiffTagID ExposureBiasValue
```

The exposure bias. The unit is the APEX value.

##### MaxApertureValue
```
public static final TiffTagID MaxApertureValue
```

The smallest F number of the lens. The unit is the APEX value.

##### SubjectDistance
```
public static final TiffTagID SubjectDistance
```

The distance to the subject, given in meters.

##### MeteringMode
```
public static final TiffTagID MeteringMode
```

The metering mode.

##### LightSource
```
public static final TiffTagID LightSource
```

The kind of light source.

##### Flash
```
public static final TiffTagID Flash
```

This tag indicates the status of flash when the image was shot. Bit 0 indicates the flash firing status, bits 1 and 2 indicate the flash return status, bits 3 and 4 indicate the flash mode, bit 5 indicates whether the flash function is present, and bit 6 indicates "red eye" mode.

##### SubjectArea
```
public static final TiffTagID SubjectArea
```

This tag indicates the location and area of the main subject in the overall scene.

##### FocalLength
```
public static final TiffTagID FocalLength
```

The actual focal length of the lens, in mm. Conversion is not made to the focal length of a 35 mm film camera.

##### FlashEnergy
```
public static final TiffTagID FlashEnergy
```

Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS).

##### SpatialFrequencyResponse
```
public static final TiffTagID SpatialFrequencyResponse
```

This tag records the camera or input device spatial frequency table and SFR values in the direction of image width, image height, and diagonal direction, as specified in ISO 12233.

##### FocalPlaneXResolution
```
public static final TiffTagID FocalPlaneXResolution
```

Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane.

##### FocalPlaneYResolution
```
public static final TiffTagID FocalPlaneYResolution
```

Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane.

##### FocalPlaneResolutionUnit
```
public static final TiffTagID FocalPlaneResolutionUnit
```

Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. This value is the same as the ResolutionUnit.

##### SubjectLocation
```
public static final TiffTagID SubjectLocation
```

Indicates the location of the main subject in the scene. The value of this tag represents the pixel at the center of the main subject relative to the left edge, prior to rotation processing as per the Rotation tag. The first value indicates the X column number and second indicates the Y row number.

##### ExposureIndex
```
public static final TiffTagID ExposureIndex
```

Indicates the exposure index selected on the camera or input device at the time the image is captured.

##### SensingMethod
```
public static final TiffTagID SensingMethod
```

Indicates the image sensor type on the camera or input device.

##### FileSource
```
public static final TiffTagID FileSource
```

Indicates the image source. If a DSC recorded the image, this tag value always shall be set to 3.

##### SceneType
```
public static final TiffTagID SceneType
```

Indicates the type of scene. If a DSC recorded the image, this tag value shall always be set to 1, indicating that the image was directly photographed.

##### CustomRendered
```
public static final TiffTagID CustomRendered
```

This tag indicates the use of special processing on image data, such as rendering geared to output.

##### ExposureMode
```
public static final TiffTagID ExposureMode
```

This tag indicates the exposure mode set when the image was shot. In auto-bracketing mode, the camera shoots a series of frames of the same scene at different exposure settings.

##### WhiteBalance
```
public static final TiffTagID WhiteBalance
```

This tag indicates the white balance mode set when the image was shot.

##### DigitalZoomRatio
```
public static final TiffTagID DigitalZoomRatio
```

This tag indicates the digital zoom ratio when the image was shot. If the numerator of the recorded value is 0, this indicates that digital zoom was not used.

##### FocalLengthIn35mmFilm
```
public static final TiffTagID FocalLengthIn35mmFilm
```

This tag indicates the equivalent focal length assuming a 35mm film camera, in mm. A value of 0 means the focal length is unknown. Note that this tag differs from the FocalLength tag.

##### GainControl
```
public static final TiffTagID GainControl
```

This tag indicates the degree of overall image gain adjustment.

##### Contrast
```
public static final TiffTagID Contrast
```

This tag indicates the direction of contrast processing applied by the camera when the image was shot.

##### Saturation
```
public static final TiffTagID Saturation
```

This tag indicates the direction of saturation processing applied by the camera when the image was shot.

##### Sharpness
```
public static final TiffTagID Sharpness
```

This tag indicates the direction of sharpness processing applied by the camera when the image was shot.

##### DeviceSettingDescription
```
public static final TiffTagID DeviceSettingDescription
```

This tag indicates information on the picture-taking conditions of a particular camera model.

##### SubjectDistanceRange
```
public static final TiffTagID SubjectDistanceRange
```

This tag indicates the distance to the subject.

##### CompositeImage
```
public static final TiffTagID CompositeImage
```

This tag indicates whether the recorded image is a composite image\* or not.

##### SourceImageNumberOfCompositeImage
```
public static final TiffTagID SourceImageNumberOfCompositeImage
```

This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image.

##### SourceExposureTimesOfCompositeImage
```
public static final TiffTagID SourceExposureTimesOfCompositeImage
```

For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image, such as respective exposure times of captured source images (tentatively recorded images).

##### Temperature
```
public static final TiffTagID Temperature
```

Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. The unit is °C.

##### Humidity
```
public static final TiffTagID Humidity
```

Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. The unit is %.

##### Pressure
```
public static final TiffTagID Pressure
```

Pressure as the ambient situation at the shot, for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea. The unit is hPa.

##### WaterDepth
```
public static final TiffTagID WaterDepth
```

Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. The unit is m.

##### Acceleration
```
public static final TiffTagID Acceleration
```

Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot. The unit is mGal (10-5 m/s2).

##### CameraElevationAngle
```
public static final TiffTagID CameraElevationAngle
```

Elevation/depression. angle of the orientation of the camera(imaging optical axis) as the ambient situation at the shot. The unit is degree(°).

##### ImageUniqueID
```
public static final TiffTagID ImageUniqueID
```

This tag indicates an identifier assigned uniquely to each image.

##### LensSpecification
```
public static final TiffTagID LensSpecification
```

This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length, and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography.

##### LensMake
```
public static final TiffTagID LensMake
```

This tag records the lens manufacturer as an ASCII string.

##### LensModel
```
public static final TiffTagID LensModel
```

This tag records the lens\\u2019s model name and model number as an ASCII string.

##### LensSerialNumber
```
public static final TiffTagID LensSerialNumber
```

This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string.

##### getByRawValue(int rawValue)
```
public static TiffTagID getByRawValue(int rawValue)
```

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

**Returns:**
TiffTagID
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### values()
```
public static Iterable<TiffTagID> values()
```

**Returns:**
java.lang.Iterable<com.groupdocs.metadata.core.TiffTagID>
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

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

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

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

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

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

Returns the name of this enumeration value.

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

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

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

**Returns:**
int

### TiffTagType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tifftagtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum TiffTagType extends Enum<TiffTagType> implements IEnumValue
```

Represents the IFD data type.
#### Fields

| Field | Description |
| --- | --- |
| Byte | An 8-bit unsigned integer. |
| Ascii | An 8-bit byte with a 7-bit ASCII character. |
| Short | A 16-bit unsigned integer. |
| Long | A 32-bit unsigned integer. |
| Rational | A pair of LONGs, numerator then denominator. |
| SByte | An 8-bit signed integer. |
| Undefined | An undefined 8-bit byte. |
| SShort | A 16-bit signed integer. |
| SLong | A 32-bit signed integer. |
| SRational | A pair of SLONGs, numerator then denominator. |
| Float | A 4-byte IEEE floating point value. |
| Double | An 8-byte IEEE floating point value. |
| SubIfd | A 4-byte long offset value |
| value |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| get_Value() |  |
| set_Value(String value1) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getTiffTagType() |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Byte
```
public static final TiffTagType Byte
```

An 8-bit unsigned integer.

##### Ascii
```
public static final TiffTagType Ascii
```

An 8-bit byte with a 7-bit ASCII character.

##### Short
```
public static final TiffTagType Short
```

A 16-bit unsigned integer.

##### Long
```
public static final TiffTagType Long
```

A 32-bit unsigned integer.

##### Rational
```
public static final TiffTagType Rational
```

A pair of LONGs, numerator then denominator.

##### SByte
```
public static final TiffTagType SByte
```

An 8-bit signed integer.

##### Undefined
```
public static final TiffTagType Undefined
```

An undefined 8-bit byte.

##### SShort
```
public static final TiffTagType SShort
```

A 16-bit signed integer.

##### SLong
```
public static final TiffTagType SLong
```

A 32-bit signed integer.

##### SRational
```
public static final TiffTagType SRational
```

A pair of SLONGs, numerator then denominator.

##### Float
```
public static final TiffTagType Float
```

A 4-byte IEEE floating point value.

##### Double
```
public static final TiffTagType Double
```

An 8-byte IEEE floating point value.

##### SubIfd
```
public static final TiffTagType SubIfd
```

A 4-byte long offset value

##### value
```
public String value
```

##### values()
```
public static TiffTagType[] values()
```

**Returns:**
com.groupdocs.metadata.core.TiffTagType[]
##### valueOf(String name)
```
public static TiffTagType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TiffTagType
##### get_Value()
```
public final String get_Value()
```

**Returns:**
java.lang.String
##### set_Value(String value1)
```
public final void set_Value(String value1)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value1 | java.lang.String |  |

##### getByRawValue(int rawValue)
```
public static TiffTagType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
TiffTagType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getTiffTagType()
```
public int getTiffTagType()
```

**Returns:**
int
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### TiffUndefinedTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/tiffundefinedtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffUndefinedTag extends TiffArrayTag<Byte>
```

Represents a TIFF tag with the Undefined type.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffUndefinedTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffUndefinedTag  class. |
##### TiffUndefinedTag(TiffTagID tagID, byte[] value)
```
public TiffUndefinedTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffUndefinedTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TorrentPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/torrentpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TorrentPackage extends CustomPackage
```

Represents torrent descriptor file metadata. Please find more information at  [https://en.wikipedia.org/wiki/Torrent\_file][https_en.wikipedia.org_wiki_Torrent_file] .

[https_en.wikipedia.org_wiki_Torrent_file]: https://en.wikipedia.org/wiki/Torrent_file
[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getAnnounce() | Gets the URL of the tracker. |
| setAnnounce(String value) | Sets the URL of the tracker. |
| getComment() | Gets the author's comment. |
| setComment(String value) | Sets the author's comment. |
| getCreationDate() | Gets the creation date of the torrent. |
| setCreationDate(Date value) | Sets the creation date of the torrent. |
| getCreatedBy() | Gets the name and version of the program used to create the torrent. |
| setCreatedBy(String value) | Sets the name and version of the program used to create the torrent. |
| getSharedFiles() | Gets an array containing shared file information entries. |
| getPieceLength() | Gets the number of bytes in each piece. |
| getPieces() | Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece. |
##### getAnnounce()
```
public final String getAnnounce()
```

Gets the URL of the tracker.

**Returns:**
java.lang.String - The URL of the tracker.
##### setAnnounce(String value)
```
public final void setAnnounce(String value)
```

Sets the URL of the tracker.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URL of the tracker. |

##### getComment()
```
public final String getComment()
```

Gets the author's comment.

**Returns:**
java.lang.String - The author's comment.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the author's comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author's comment. |

##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the creation date of the torrent.

**Returns:**
java.util.Date - The creation date of the torrent.
##### setCreationDate(Date value)
```
public final void setCreationDate(Date value)
```

Sets the creation date of the torrent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The creation date of the torrent. |

##### getCreatedBy()
```
public final String getCreatedBy()
```

Gets the name and version of the program used to create the torrent.

**Returns:**
java.lang.String - The name and version of the program used to create the torrent.
##### setCreatedBy(String value)
```
public final void setCreatedBy(String value)
```

Sets the name and version of the program used to create the torrent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name and version of the program used to create the torrent. |

##### getSharedFiles()
```
public final TorrentSharedFilePackage[] getSharedFiles()
```

Gets an array containing shared file information entries.

**Returns:**
com.groupdocs.metadata.core.TorrentSharedFilePackage[] - An array containing shared file information entries.
##### getPieceLength()
```
public final long getPieceLength()
```

Gets the number of bytes in each piece. For more information please see .

**Returns:**
long - The number of bytes in each piece.
##### getPieces()
```
public final byte[] getPieces()
```

Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

**Returns:**
byte[] - A byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

### TorrentRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/torrentrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class TorrentRootPackage extends RootMetadataPackage
```

Represents the root package intended to work with metadata of a TORRENT file.

This code sample shows how to read metadata of a TORRENT file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputTorrent)) {
>      TorrentRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getTorrentPackage().getAnnounce());
>      System.out.println(root.getTorrentPackage().getComment());
>      System.out.println(root.getTorrentPackage().getCreatedBy());
>      System.out.println(root.getTorrentPackage().getCreationDate());
>      for (TorrentSharedFilePackage file : root.getTorrentPackage().getSharedFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getLength());
>      }
>      // ...
>  }
>
> ```
> ```

[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getTorrentPackage() | Gets the TORRENT file metadata package. |
##### getTorrentPackage()
```
public final TorrentPackage getTorrentPackage()
```

Gets the TORRENT file metadata package.

**Returns:**
TorrentPackage - The TORRENT file metadata package.

### TorrentSharedFilePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/torrentsharedfilepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class TorrentSharedFilePackage extends CustomPackage
```

Represents shared file information. Contains detailed info about each file in a torrent distribution.

[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the full name of the file (relative path to the file from the root torrent folder). |
| getLength() | Gets the length of the file in bytes. |
##### getName()
```
public final String getName()
```

Gets the full name of the file (relative path to the file from the root torrent folder).

**Returns:**
java.lang.String - The full name of the file (relative path to the file from the root torrent folder).
##### getLength()
```
public final long getLength()
```

Gets the length of the file in bytes.

**Returns:**
long - The length of the file in bytes.

### ValueAcceptor
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/valueacceptor.md

**Inheritance:**
java.lang.Object
```
public abstract class ValueAcceptor
```

Provides a base abstract class that allows extracting all supported types of values from a  PropertyValue  instance.
#### Constructors

| Constructor | Description |
| --- | --- |
| ValueAcceptor() |  |
##### ValueAcceptor()
```
public ValueAcceptor()
```

### ValueInterpreter
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/valueinterpreter.md

**Inheritance:**
java.lang.Object
```
public abstract class ValueInterpreter
```

Defines operations required to interpret metadata property values.
#### Constructors

| Constructor | Description |
| --- | --- |
| ValueInterpreter() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInterpretedValueType() | Gets the type of the interpreted value. |
| toInterpretedValue(PropertyValue originalValue) | Interprets the provided property value. |
| toSourceValue(PropertyValue interpretedValue) | Converts an interpreted value back to its original form. |
##### ValueInterpreter()
```
public ValueInterpreter()
```

##### getInterpretedValueType()
```
public abstract MetadataPropertyType getInterpretedValueType()
```

Gets the type of the interpreted value.

**Returns:**
MetadataPropertyType - The type of the interpreted value.
##### toInterpretedValue(PropertyValue originalValue)
```
public final PropertyValue toInterpretedValue(PropertyValue originalValue)
```

Interprets the provided property value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalValue | PropertyValue | The value to interpret. |

**Returns:**
PropertyValue - The interpreted value.
##### toSourceValue(PropertyValue interpretedValue)
```
public final PropertyValue toSourceValue(PropertyValue interpretedValue)
```

Converts an interpreted value back to its original form.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| interpretedValue | PropertyValue | The interpreted value to convert. |

**Returns:**
PropertyValue - The original value.

### VCardAgentRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardagentrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardAgentRecord extends VCardRecord implements IVCardRecord<VCardCard>
```

Represents vCard Agent record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final VCardCard getValue()
```

Gets the record value.

**Returns:**
VCardCard - The record value.

### VCardBasePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardbasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class VCardBasePackage extends CustomPackage
```

Represents the base VCard metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata

### VCardBinaryRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardbinaryrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardBinaryRecord extends VCardRecord implements IVCardRecord<byte[]>
```

Represents vCard binary record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final byte[] getValue()
```

Gets the record value.

**Returns:**
byte[] - The record value.

### VCardCalendarRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardcalendarrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCalendarRecordset extends VCardRecordset
```

Represents a set of Calendar vCard records.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getBusyTimeRecords() | Gets the URIs for the busy time associated with the object. |
| getBusyTimeEntries() | Gets the URIs for the busy time associated with the object. |
| getCalendarAddressRecords() | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| getCalendarAddresses() | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| getCalendarUriRecords() | Gets the URIs for the calendar associated with the object represented by the vCard. |
| getUriCalendarEntries() | Gets the URIs for the calendar associated with the object represented by the vCard. |
##### getBusyTimeRecords()
```
public final VCardTextRecord[] getBusyTimeRecords()
```

Gets the URIs for the busy time associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for the busy time associated with the object.
##### getBusyTimeEntries()
```
public final String[] getBusyTimeEntries()
```

Gets the URIs for the busy time associated with the object.

**Returns:**
java.lang.String[] - The URIs for the busy time associated with the object.

This property is a simplified version of  BusyTimeRecords .
##### getCalendarAddressRecords()
```
public final VCardTextRecord[] getCalendarAddressRecords()
```

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.
##### getCalendarAddresses()
```
public final String[] getCalendarAddresses()
```

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

**Returns:**
java.lang.String[] - The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

This property is a simplified version of  CalendarAddressRecords .
##### getCalendarUriRecords()
```
public final VCardTextRecord[] getCalendarUriRecords()
```

Gets the URIs for the calendar associated with the object represented by the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for the calendar associated with the object represented by the vCard.
##### getUriCalendarEntries()
```
public final String[] getUriCalendarEntries()
```

Gets the URIs for the calendar associated with the object represented by the vCard.

**Returns:**
java.lang.String[] - The URIs for the calendar associated with the object represented by the vCard.

This property is a simplified version of  CalendarUriRecords .

### VCardCard
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardcard.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCard extends VCardRecordset
```

Represents a single card extracted from a VCard file.

This example shows how to use vCard property filters.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.InputVcf)) {
>          VCardRootPackage root = metadata.getRootPackageGeneric();
>          for (VCardCard vCard : root.getVCardPackage().getCards()) {
>              // Print most preferred work phone numbers and work emails
>              VCardCard filtered = vCard.filterWorkTags().filterPreferred();
>              PrintArray(filtered.getCommunicationRecordset().getTelephones());
>              PrintArray(filtered.getCommunicationRecordset().getEmails());
>          }
>      }
>  }
>  private static void PrintArray(String[] values) {
>      if (values != null) {
>          for (String value : values) {
>              System.out.println(value);
>          }
>      }
>  }
>
> ```
> ```

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGeneralRecordset() | Gets the general records. |
| getIdentificationRecordset() | Gets the identification records. |
| getDeliveryAddressingRecordset() | Gets the delivery addressing records. |
| getCommunicationRecordset() | Gets the communication records. |
| getGeographicalRecordset() | Gets the geographical records. |
| getOrganizationalRecordset() | Gets the organizational records. |
| getExplanatoryRecordset() | Gets the explanatory records. |
| getSecurityRecordset() | Gets the security records. |
| getCalendarRecordset() | Gets the calendar records. |
| getExtensionRecords() | Gets the private extension records. |
| getAvailableGroups() | Gets the available group names. |
| filterByGroup(String groupName) | Filters all vCard records by the group name passed as a parameter. |
| filterHomeTags() | Filters all vCard records marked with the HOME tag. |
| filterWorkTags() | Filters all vCard records marked with the WORK tag. |
| filterPreferred() | Filters the preferred records. |
##### getGeneralRecordset()
```
public final VCardGeneralRecordset getGeneralRecordset()
```

Gets the general records.

**Returns:**
VCardGeneralRecordset - The general records.
##### getIdentificationRecordset()
```
public final VCardIdentificationRecordset getIdentificationRecordset()
```

Gets the identification records.

**Returns:**
VCardIdentificationRecordset - The identification records.
##### getDeliveryAddressingRecordset()
```
public final VCardDeliveryAddressingRecordset getDeliveryAddressingRecordset()
```

Gets the delivery addressing records.

**Returns:**
VCardDeliveryAddressingRecordset - The delivery addressing records.
##### getCommunicationRecordset()
```
public final VCardCommunicationRecordset getCommunicationRecordset()
```

Gets the communication records.

**Returns:**
VCardCommunicationRecordset - The communication records.
##### getGeographicalRecordset()
```
public final VCardGeographicalRecordset getGeographicalRecordset()
```

Gets the geographical records.

**Returns:**
VCardGeographicalRecordset - The geographical records.
##### getOrganizationalRecordset()
```
public final VCardOrganizationalRecordset getOrganizationalRecordset()
```

Gets the organizational records.

**Returns:**
VCardOrganizationalRecordset - The organizational records.
##### getExplanatoryRecordset()
```
public final VCardExplanatoryRecordset getExplanatoryRecordset()
```

Gets the explanatory records.

**Returns:**
VCardExplanatoryRecordset - The explanatory records.
##### getSecurityRecordset()
```
public final VCardSecurityRecordset getSecurityRecordset()
```

Gets the security records.

**Returns:**
VCardSecurityRecordset - The security records.
##### getCalendarRecordset()
```
public final VCardCalendarRecordset getCalendarRecordset()
```

Gets the calendar records.

**Returns:**
VCardCalendarRecordset - The calendar records.
##### getExtensionRecords()
```
public final VCardTextRecord[] getExtensionRecords()
```

Gets the private extension records.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The private extension records.
##### getAvailableGroups()
```
public final String[] getAvailableGroups()
```

Gets the available group names.

**Returns:**
java.lang.String[] - The available group names.
##### filterByGroup(String groupName)
```
public final VCardCard filterByGroup(String groupName)
```

Filters all vCard records by the group name passed as a parameter. For more information please see the method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| groupName | java.lang.String | The name of the group. |

**Returns:**
VCardCard - The filtered vCard instance.
##### filterHomeTags()
```
public final VCardCard filterHomeTags()
```

Filters all vCard records marked with the HOME tag.

**Returns:**
VCardCard - The filtered vCard instance.
##### filterWorkTags()
```
public final VCardCard filterWorkTags()
```

Filters all vCard records marked with the WORK tag.

**Returns:**
VCardCard - Filtered vCard instance.
##### filterPreferred()
```
public final VCardCard filterPreferred()
```

Filters the preferred records.

**Returns:**
VCardCard - The filtered vCard instance.

### VCardCommunicationRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardcommunicationrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCommunicationRecordset extends VCardRecordset
```

Represents a set of Communication vCard records. These properties describe information about how to communicate with the object the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTelephoneRecords() | Gets the telephone numbers for telephony communication with the object. |
| getTelephones() | Gets the telephone numbers for telephony communication with the object. |
| getEmailRecords() | Gets the electronic mail addresses for communication with the object. |
| getEmails() | Gets the electronic mail addresses for communication with the object. |
| getMailer() | Gets the type of the electronic mail software that is used by the individual associated with the vCard. |
| getImppRecords() | Gets the URIs for instant messaging and presence protocol communications with the object. |
| getImppEntries() | Gets the URIs for instant messaging and presence protocol communications with the object. |
| getLanguageRecords() | Gets the languages that may be used for contacting the object. |
| getLanguages() | Gets the languages that may be used for contacting the object. |
##### getTelephoneRecords()
```
public final VCardTextRecord[] getTelephoneRecords()
```

Gets the telephone numbers for telephony communication with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The telephone numbers for telephony communication with the object.
##### getTelephones()
```
public final String[] getTelephones()
```

Gets the telephone numbers for telephony communication with the object.

**Returns:**
java.lang.String[] - The telephone numbers for telephony communication with the object.

This property is a simplified version of  TelephoneRecords .
##### getEmailRecords()
```
public final VCardTextRecord[] getEmailRecords()
```

Gets the electronic mail addresses for communication with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The electronic mail addresses array for communication with the object.
##### getEmails()
```
public final String[] getEmails()
```

Gets the electronic mail addresses for communication with the object.

**Returns:**
java.lang.String[] - The electronic mail addresses array for communication with the object.

This property is a simplified version of  EmailRecords .
##### getMailer()
```
public final String getMailer()
```

Gets the type of the electronic mail software that is used by the individual associated with the vCard.

**Returns:**
java.lang.String - The type of the electronic mail software that is used by the individual associated with the vCard
##### getImppRecords()
```
public final VCardTextRecord[] getImppRecords()
```

Gets the URIs for instant messaging and presence protocol communications with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for instant messaging and presence protocol communications with the object.
##### getImppEntries()
```
public final String[] getImppEntries()
```

Gets the URIs for instant messaging and presence protocol communications with the object.

**Returns:**
java.lang.String[] - The URIs for instant messaging and presence protocol communications with the object.

This property is a simplified version of  ImppRecords .
##### getLanguageRecords()
```
public final VCardTextRecord[] getLanguageRecords()
```

Gets the languages that may be used for contacting the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The languages that may be used for contacting the object.
##### getLanguages()
```
public final String[] getLanguages()
```

Gets the languages that may be used for contacting the object.

**Returns:**
java.lang.String[] - The languages that may be used for contacting the object.

This property is a simplified version of  LanguageRecords .

### VCardContentType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardcontenttype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum VCardContentType extends Enum<VCardContentType> implements IEnumValue
```

Defines vCard record content types.
#### Fields

| Field | Description |
| --- | --- |
| Custom | The custom content type. |
| Text | The text content type. |
| Binary | The binary content type. |
| DateTime | The date time content type. |
| Agent | The agent content type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Custom
```
public static final VCardContentType Custom
```

The custom content type.

##### Text
```
public static final VCardContentType Text
```

The text content type.

##### Binary
```
public static final VCardContentType Binary
```

The binary content type.

##### DateTime
```
public static final VCardContentType DateTime
```

The date time content type.

##### Agent
```
public static final VCardContentType Agent
```

The agent content type.

##### values()
```
public static VCardContentType[] values()
```

**Returns:**
com.groupdocs.metadata.core.VCardContentType[]
##### valueOf(String name)
```
public static VCardContentType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
VCardContentType
##### getByRawValue(int rawValue)
```
public static VCardContentType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
VCardContentType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### VCardCustomRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardcustomrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardCustomRecord extends VCardRecord implements IVCardRecord<String>
```

Represents vCard custom record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final String getValue()
```

Gets the record value.

**Returns:**
java.lang.String - The record value.

### VCardDateTimeRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcarddatetimerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardDateTimeRecord extends VCardRecord implements IVCardRecord<Date>
```

Represents vCard date time record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final Date getValue()
```

Gets the record value.

**Returns:**
java.util.Date - The record value.

### VCardDeliveryAddressingRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcarddeliveryaddressingrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardDeliveryAddressingRecordset extends VCardRecordset
```

Represents a set of Delivery Addressing vCard records. These types are concerned with information related to the delivery addressing or label for the vCard object.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAddressRecords() | Gets the components of the delivery address of the object. |
| getAddresses() | Gets the components of the delivery address of the object. |
| getLabelRecords() | Gets an array containing the formatted text corresponding to delivery address of the object. |
| getLabels() | Gets an array containing the formatted text corresponding to delivery address of the object. |
##### getAddressRecords()
```
public final VCardTextRecord[] getAddressRecords()
```

Gets the components of the delivery address of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The components of the delivery address of the object.
##### getAddresses()
```
public final String[] getAddresses()
```

Gets the components of the delivery address of the object.

**Returns:**
java.lang.String[] - The components of the delivery address of the object.

This property is a simplified version of  AddressRecords .
##### getLabelRecords()
```
public final VCardTextRecord[] getLabelRecords()
```

Gets an array containing the formatted text corresponding to delivery address of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the formatted text corresponding to delivery address of the object.
##### getLabels()
```
public final String[] getLabels()
```

Gets an array containing the formatted text corresponding to delivery address of the object.

**Returns:**
java.lang.String[] - An array containing the formatted text corresponding to delivery address of the object.

This property is a simplified version of  LabelRecords .

### VCardExplanatoryRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardexplanatoryrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardExplanatoryRecordset extends VCardRecordset
```

Represents a set of Explanatory vCard records. These properties are concerned with additional explanations, such as that related to informational notes or revisions specific to the vCard.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCategoryRecords() | Gets the application category information about the vCard, also known as "tags". |
| getCategories() | Gets the application category information about the vCard, also known as "tags". |
| getNoteRecords() | Gets the supplemental information or comments that are associated with the vCard. |
| getNotes() | Gets the supplemental information or comments that are associated with the vCard. |
| getProductIdentifierRecord() | Gets the identifier of the product that created the vCard object. |
| getProductIdentifier() | Gets the identifier of the product that created the vCard object. |
| getRevision() | Gets the revision information about the current vCard. |
| getSortString() | Gets the family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types. |
| getSoundRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getSoundBinaryRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getBinarySounds() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getSoundUriRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getUriSounds() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getUidRecord() | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| getUid() | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| getPidIdentifierRecords() | Gets the global meaning of the local PID source identifier. |
| getPidIdentifiers() | Gets the global meaning of the local PID source identifier. |
| getUrlRecords() | Gets an array of URLs pointing to websites that represent the person in some way. |
| getUrls() | Gets an array of URLs pointing to websites that represent the person in some way. |
| getVersion() | Gets the version of the vCard specification. |
##### getCategoryRecords()
```
public final VCardTextRecord[] getCategoryRecords()
```

Gets the application category information about the vCard, also known as "tags".

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The application category information about the vCard, also known as "tags".
##### getCategories()
```
public final String[] getCategories()
```

Gets the application category information about the vCard, also known as "tags".

**Returns:**
java.lang.String[] - The application category information about the vCard, also known as "tags".

This property is a simplified version of  CategoryRecords .
##### getNoteRecords()
```
public final VCardTextRecord[] getNoteRecords()
```

Gets the supplemental information or comments that are associated with the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The supplemental information or comments that are associated with the vCard.
##### getNotes()
```
public final String[] getNotes()
```

Gets the supplemental information or comments that are associated with the vCard.

**Returns:**
java.lang.String[] - The supplemental information or comments that are associated with the vCard.

This property is a simplified version of  NoteRecords .
##### getProductIdentifierRecord()
```
public final VCardTextRecord getProductIdentifierRecord()
```

Gets the identifier of the product that created the vCard object.

**Returns:**
VCardTextRecord - The identifier of the product that created the vCard object
##### getProductIdentifier()
```
public final String getProductIdentifier()
```

Gets the identifier of the product that created the vCard object.

**Returns:**
java.lang.String - The identifier of the product that created the vCard object

This property is a simplified version of  ProductIdentifierRecord .
##### getRevision()
```
public final Date getRevision()
```

Gets the revision information about the current vCard.

**Returns:**
java.util.Date - The revision information about the current vCard.
##### getSortString()
```
public final String getSortString()
```

Gets the family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types.

**Returns:**
java.lang.String - The family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types.
##### getSoundRecords()
```
public final VCardRecord[] getSoundRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The digital sound content information that annotates some aspects of the vCard.
##### getSoundBinaryRecords()
```
public final VCardBinaryRecord[] getSoundBinaryRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundRecords .
##### getBinarySounds()
```
public final byte[][] getBinarySounds()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
byte[][] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundBinaryRecords .
##### getSoundUriRecords()
```
public final VCardTextRecord[] getSoundUriRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundRecords .
##### getUriSounds()
```
public final String[] getUriSounds()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
java.lang.String[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundUriRecords .
##### getUidRecord()
```
public final VCardTextRecord getUidRecord()
```

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

**Returns:**
VCardTextRecord - The value that represents a globally unique identifier corresponding.
##### getUid()
```
public final String getUid()
```

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

**Returns:**
java.lang.String - The value that represents a globally unique identifier corresponding.

This property is a simplified version of  UidRecord .
##### getPidIdentifierRecords()
```
public final VCardTextRecord[] getPidIdentifierRecords()
```

Gets the global meaning of the local PID source identifier.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The global meaning of the local PID source identifier.
##### getPidIdentifiers()
```
public final String[] getPidIdentifiers()
```

Gets the global meaning of the local PID source identifier.

**Returns:**
java.lang.String[] - The global meaning of the local PID source identifier.

This property is a simplified version of  PidIdentifierRecords .
##### getUrlRecords()
```
public final VCardTextRecord[] getUrlRecords()
```

Gets an array of URLs pointing to websites that represent the person in some way.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array of URLs pointing to websites that represent the person in some way.
##### getUrls()
```
public final String[] getUrls()
```

Gets an array of URLs pointing to websites that represent the person in some way.

**Returns:**
java.lang.String[] - An array of URLs pointing to websites that represent the person in some way.

This property is a simplified version of  UrlRecords .
##### getVersion()
```
public final String getVersion()
```

Gets the version of the vCard specification.

**Returns:**
java.lang.String - The version of the vCard specification.

### VCardGeneralRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardgeneralrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardGeneralRecordset extends VCardRecordset
```

Represents a set of General vCard records.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getSourceRecords() | Gets the array of sources of directory information contained in the content type. |
| getSources() | Gets an array containing the sources of the directory information contained in the content type. |
| getNameOfSource() | Gets the textual representation of the SOURCE property. |
| getKind() | Gets the kind of the object. |
| getXmlRecords() | Gets an array containing extended XML-encoded vCard data. |
| getXmlEntries() | Gets an array containing extended XML-encoded vCard data. |
##### getSourceRecords()
```
public final VCardTextRecord[] getSourceRecords()
```

Gets the array of sources of directory information contained in the content type.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The array of sources of directory information contained in the content type.
##### getSources()
```
public final String[] getSources()
```

Gets an array containing the sources of the directory information contained in the content type.

**Returns:**
java.lang.String[] - An array containing the sources of the directory information contained in the content type.

This property is a simplified version of  SourceRecords .
##### getNameOfSource()
```
public final String getNameOfSource()
```

Gets the textual representation of the SOURCE property.

**Returns:**
java.lang.String - The textual representation of the SOURCE property.
##### getKind()
```
public final String getKind()
```

Gets the kind of the object.

**Returns:**
java.lang.String - The kind of object.
##### getXmlRecords()
```
public final VCardTextRecord[] getXmlRecords()
```

Gets an array containing extended XML-encoded vCard data.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing extended XML-encoded vCard data.
##### getXmlEntries()
```
public final String[] getXmlEntries()
```

Gets an array containing extended XML-encoded vCard data.

**Returns:**
java.lang.String[] - An array of extended XML-encoded vCard data.

This property is a simplified version of  XmlRecords .

### VCardGeographicalRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardgeographicalrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardGeographicalRecordset extends VCardRecordset
```

Represents a set of Geographical vCard records. These properties are concerned with information associated with geographical positions or regions associated with the object the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTimeZoneRecords() | Gets the time zones of the object. |
| getTimeZones() | Gets the time zones of the object. |
| getGeographicPositionRecords() | Gets the information related to the global positioning of the object. |
| getGeographicPositions() | Gets the information related to the global positioning of the object. |
##### getTimeZoneRecords()
```
public final VCardTextRecord[] getTimeZoneRecords()
```

Gets the time zones of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The time zones of the object.
##### getTimeZones()
```
public final String[] getTimeZones()
```

Gets the time zones of the object.

**Returns:**
java.lang.String[] - The time zones of the object.

This property is a simplified version of  TimeZoneRecords .
##### getGeographicPositionRecords()
```
public final VCardTextRecord[] getGeographicPositionRecords()
```

Gets the information related to the global positioning of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The information related to the global positioning of the object.
##### getGeographicPositions()
```
public final String[] getGeographicPositions()
```

Gets the information related to the global positioning of the object.

**Returns:**
java.lang.String[] - The information related to the global positioning of the object.

This property is a simplified version of  GeographicPositionRecords .

### VCardIdentificationRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardidentificationrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardIdentificationRecordset extends VCardRecordset
```

Represents a set of Identification vCard records. These types are used to capture information associated with the identification and naming of the entity associated with the vCard.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getFormattedNameRecords() | Gets an array containing the formatted text corresponding to the name of the object. |
| getFormattedNames() | Gets an array containing the formatted text corresponding to the name of the object. |
| getNameRecord() | Gets the components of the name of the object. |
| getName() | Gets the components of the name of the object. |
| getNicknameRecords() | Gets an array containing the text corresponding to the nickname of the object. |
| getNicknames() | Gets an array containing the text corresponding to the nickname of the object. |
| getPhotoRecords() | Gets an array containing the image or photograph information that annotates some aspects of the object. |
| getPhotoBinaryRecords() | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| getBinaryPhotos() | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| getPhotoUriRecords() | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| getUriPhotos() | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| getBirthdateRecords() | Gets an array containing the birth date of the object in different representations. |
| getBirthdateDateTimeRecord() | Gets the birth date of the object. |
| getDateTimeBirthdate() | Gets the birth date of the object. |
| getBirthdateTextRecords() | Gets an array containing the birth date of the object in different text representations. |
| getTextBirthdates() | Gets an array containing the birth date of the object in different text representations. |
| getAnniversaryRecord() | Gets the date of marriage, or equivalent, of the object. |
| getAnniversaryDateTimeRecord() | Gets the date of marriage represented as a single date-and-or-time value. |
| getDateTimeAnniversary() | Gets the date of marriage represented as a single date-and-or-time value. |
| getAnniversaryTextRecord() | Gets the date of marriage represented as a single text value. |
| getTextAnniversary() | Gets the date of marriage represented as a single text value. |
| getGenderRecord() | Gets the components of the sex and gender identity of the object. |
| getGender() | Gets the components of the sex and gender identity of the object. |
##### getFormattedNameRecords()
```
public final VCardTextRecord[] getFormattedNameRecords()
```

Gets an array containing the formatted text corresponding to the name of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the formatted text corresponding to the name of the object.
##### getFormattedNames()
```
public final String[] getFormattedNames()
```

Gets an array containing the formatted text corresponding to the name of the object.

**Returns:**
java.lang.String[] - An array containing the formatted text corresponding to the name of the object.

This property is a simplified version of  FormattedNameRecords .
##### getNameRecord()
```
public final VCardTextRecord getNameRecord()
```

Gets the components of the name of the object.

**Returns:**
VCardTextRecord - The components of the name of the object.
##### getName()
```
public final String getName()
```

Gets the components of the name of the object.

**Returns:**
java.lang.String - The components of the name of the object.

This property is a simplified version of  NameRecord .
##### getNicknameRecords()
```
public final VCardTextRecord[] getNicknameRecords()
```

Gets an array containing the text corresponding to the nickname of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the text corresponding to the nickname of the object.
##### getNicknames()
```
public final String[] getNicknames()
```

Gets an array containing the text corresponding to the nickname of the object.

**Returns:**
java.lang.String[] - An array containing the text corresponding to the nickname of the object.

This property is a simplified version of  NicknameRecords .
##### getPhotoRecords()
```
public final VCardRecord[] getPhotoRecords()
```

Gets an array containing the image or photograph information that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - An array containing the image or photograph information that annotates some aspects of the object.
##### getPhotoBinaryRecords()
```
public final VCardBinaryRecord[] getPhotoBinaryRecords()
```

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

This property is a simplified version of  PhotoRecords .
##### getBinaryPhotos()
```
public final byte[][] getBinaryPhotos()
```

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

**Returns:**
byte[][] - An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

This property is a simplified version of  PhotoBinaryRecords .
##### getPhotoUriRecords()
```
public final VCardTextRecord[] getPhotoUriRecords()
```

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

This property is a simplified version of  PhotoRecords .
##### getUriPhotos()
```
public final String[] getUriPhotos()
```

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

**Returns:**
java.lang.String[] - An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

This property is a simplified version of  PhotoUriRecords .
##### getBirthdateRecords()
```
public final VCardRecord[] getBirthdateRecords()
```

Gets an array containing the birth date of the object in different representations.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - An array containing the birth date of the object in different representations.
##### getBirthdateDateTimeRecord()
```
public final VCardDateTimeRecord getBirthdateDateTimeRecord()
```

Gets the birth date of the object.

**Returns:**
VCardDateTimeRecord - The birth date of the object.

This property is a simplified version of  BirthdateRecords .
##### getDateTimeBirthdate()
```
public final Date getDateTimeBirthdate()
```

Gets the birth date of the object.

**Returns:**
java.util.Date - The birth date of the object.

This property is a simplified version of  BirthdateDateTimeRecord .
##### getBirthdateTextRecords()
```
public final VCardTextRecord[] getBirthdateTextRecords()
```

Gets an array containing the birth date of the object in different text representations.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the birth date of the object in different text representations.

This property is a simplified version of  BirthdateRecords .
##### getTextBirthdates()
```
public final String[] getTextBirthdates()
```

Gets an array containing the birth date of the object in different text representations.

**Returns:**
java.lang.String[] - An array containing the birth date of the object in different text representations.

This property is a simplified version of  BirthdateTextRecords .
##### getAnniversaryRecord()
```
public final VCardRecord getAnniversaryRecord()
```

Gets the date of marriage, or equivalent, of the object.

**Returns:**
VCardRecord - The date of marriage, or equivalent, of the object.
##### getAnniversaryDateTimeRecord()
```
public final VCardDateTimeRecord getAnniversaryDateTimeRecord()
```

Gets the date of marriage represented as a single date-and-or-time value.

**Returns:**
VCardDateTimeRecord - The date of marriage represented as a single date-and-or-time value.

This property is a simplified version of  AnniversaryRecord .
##### getDateTimeAnniversary()
```
public final Date getDateTimeAnniversary()
```

Gets the date of marriage represented as a single date-and-or-time value.

**Returns:**
java.util.Date - The date of marriage represented as a single date-and-or-time value.

This property is a simplified version of  AnniversaryDateTimeRecord .
##### getAnniversaryTextRecord()
```
public final VCardTextRecord getAnniversaryTextRecord()
```

Gets the date of marriage represented as a single text value.

**Returns:**
VCardTextRecord - The date of marriage represented as a single text value.

This property is a simplified version of  AnniversaryRecord .
##### getTextAnniversary()
```
public final String getTextAnniversary()
```

Gets the date of marriage represented as a single text value.

**Returns:**
java.lang.String - The date of marriage represented as a single text value.

This property is a simplified version of  AnniversaryTextRecord .
##### getGenderRecord()
```
public final VCardTextRecord getGenderRecord()
```

Gets the components of the sex and gender identity of the object.

**Returns:**
VCardTextRecord - The components of the sex and gender identity of the object.
##### getGender()
```
public final String getGender()
```

Gets the components of the sex and gender identity of the object.

**Returns:**
java.lang.String - The components of the sex and gender identity of the object.

This property is a simplified version of  GenderRecord .

### VCardOrganizationalRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardorganizationalrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardOrganizationalRecordset extends VCardRecordset
```

Represents a set of Organizational vCard records. These properties are concerned with information associated with characteristics of the organization or organizational units of the object that the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTitleRecords() | Gets the positions or jobs of the object. |
| getTitles() | Gets the positions or jobs of the object. |
| getRoleRecords() | Gets the functions or parts played in a particular situation by the object. |
| getRoles() | Gets the functions or parts played in a particular situation by the object. |
| getLogoRecords() | Gets the graphic images of the logo associated with the object. |
| getLogoBinaryRecords() | Gets the graphic images of the logo associated with the object. |
| getBinaryLogos() | Gets the graphic images of the logo associated with the object. |
| getLogoUriRecords() | Gets the URIs of the graphic images of the logo associated with the object. |
| getUriLogos() | Gets the URIs of the graphic images of the logo associated with the object. |
| getAgentRecords() | Gets the information about another person who will act on behalf of the vCard object. |
| getAgentObjectRecord() | Gets the information about another person who will act on behalf of the vCard object. |
| getObjectAgent() | Gets the information about another person who will act on behalf of the vCard object. |
| getAgentUriRecords() | Gets the information about another person who will act on behalf of the vCard object. |
| getUriAgents() | Gets the information about another person who will act on behalf of the vCard object. |
| getOrganizationNameRecords() | Gets the organizational names and units associated with the object. |
| getOrganizationNames() | Gets the organizational names and units associated with the object. |
| getMemberRecords() | Gets the members in the group this vCard represents. |
| getMembers() | Gets the members in the group this vCard represents. |
| getRelationshipRecords() | Gets the relationships between another entity and the entity represented by this vCard. |
| getRelationships() | Gets the relationships between another entity and the entity represented by this vCard. |
##### getTitleRecords()
```
public final VCardTextRecord[] getTitleRecords()
```

Gets the positions or jobs of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The positions or jobs of the object.
##### getTitles()
```
public final String[] getTitles()
```

Gets the positions or jobs of the object.

**Returns:**
java.lang.String[] - The positions or jobs of the object.

This property is a simplified version of  TitleRecords .
##### getRoleRecords()
```
public final VCardTextRecord[] getRoleRecords()
```

Gets the functions or parts played in a particular situation by the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The functions or parts played in a particular situation by the object.
##### getRoles()
```
public final String[] getRoles()
```

Gets the functions or parts played in a particular situation by the object.

**Returns:**
java.lang.String[] - The functions or parts played in a particular situation by the object.

This property is a simplified version of  TitleRecords .
##### getLogoRecords()
```
public final VCardRecord[] getLogoRecords()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The graphic images of the logo associated with the object.
##### getLogoBinaryRecords()
```
public final VCardBinaryRecord[] getLogoBinaryRecords()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The graphic images of the logo associated with the object.

This property is a simplified version of  LogoRecords .
##### getBinaryLogos()
```
public final byte[][] getBinaryLogos()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
byte[][] - The graphic images of the logo associated with the object.

This property is a simplified version of  LogoBinaryRecords .
##### getLogoUriRecords()
```
public final VCardTextRecord[] getLogoUriRecords()
```

Gets the URIs of the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs of the graphic images of the logo associated with the object.

This property is a simplified version of  LogoRecords .
##### getUriLogos()
```
public final String[] getUriLogos()
```

Gets the URIs of the graphic images of the logo associated with the object.

**Returns:**
java.lang.String[] - The URIs of the graphic images of the logo associated with the object.

This property is a simplified version of  LogoUriRecords .
##### getAgentRecords()
```
public final VCardRecord[] getAgentRecords()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The information about another person who will act on behalf of the vCard object.
##### getAgentObjectRecord()
```
public final VCardAgentRecord getAgentObjectRecord()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
VCardAgentRecord - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentRecords .
##### getObjectAgent()
```
public final VCardCard getObjectAgent()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
VCardCard - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentObjectRecord .
##### getAgentUriRecords()
```
public final VCardTextRecord[] getAgentUriRecords()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentRecords .
##### getUriAgents()
```
public final String[] getUriAgents()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
java.lang.String[] - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentUriRecords .
##### getOrganizationNameRecords()
```
public final VCardTextRecord[] getOrganizationNameRecords()
```

Gets the organizational names and units associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The organizational names and units associated with the object.
##### getOrganizationNames()
```
public final String[] getOrganizationNames()
```

Gets the organizational names and units associated with the object.

**Returns:**
java.lang.String[] - The organizational names and units associated with the object.

This property is a simplified version of  OrganizationNameRecords .
##### getMemberRecords()
```
public final VCardTextRecord[] getMemberRecords()
```

Gets the members in the group this vCard represents.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The members in the group this vCard represents.
##### getMembers()
```
public final String[] getMembers()
```

Gets the members in the group this vCard represents.

**Returns:**
java.lang.String[] - The members in the group this vCard represents.

This property is a simplified version of  MemberRecords .
##### getRelationshipRecords()
```
public final VCardTextRecord[] getRelationshipRecords()
```

Gets the relationships between another entity and the entity represented by this vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The relationships between another entity and the entity represented by this vCard.
##### getRelationships()
```
public final String[] getRelationships()
```

Gets the relationships between another entity and the entity represented by this vCard.

**Returns:**
java.lang.String[] - The relationships between another entity and the entity represented by this vCard.

This property is a simplified version of  RelationshipRecords .

### VCardPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public final class VCardPackage extends VCardBasePackage
```

Represents VCF (Virtual Contact File) electronic business card format metadata.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCards() | Gets an array of the cards extracted from the file. |
##### getCards()
```
public final VCardCard[] getCards()
```

Gets an array of the cards extracted from the file.

**Returns:**
com.groupdocs.metadata.core.VCardCard[] - An array of the cards extracted from the file.

### VCardRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public abstract class VCardRecord extends VCardBasePackage
```

Represents abstract vCard record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGroup() | Gets the grouping value. |
| getValueParameters() | Gets the value parameters. |
| getPrefParameter() | Gets the preferred parameter. |
| getAltIdParameter() | Gets the alternative representations parameter value. |
| getTypeParameters() | Gets the type parameter values. |
| getEncodingParameter() | Gets the encoding parameter value. |
| getLanguageParameter() | Gets the language parameter value. |
| getAnonymParameters() | Gets the anonymous parameters. |
| getContentType() | Gets the content type of record. |
| getTypeName() | Gets the type of the record. |
##### getGroup()
```
public final String getGroup()
```

Gets the grouping value.

**Returns:**
java.lang.String - The grouping value.
##### getValueParameters()
```
public final String[] getValueParameters()
```

Gets the value parameters.

**Returns:**
java.lang.String[] - The value parameters.

Used to identify the value type (data type) and format of the value.
##### getPrefParameter()
```
public final Integer getPrefParameter()
```

Gets the preferred parameter.

**Returns:**
java.lang.Integer - The preferred parameter.

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### getAltIdParameter()
```
public final String getAltIdParameter()
```

Gets the alternative representations parameter value.

**Returns:**
java.lang.String - The alternative representations parameter value.

Used to "tag" property instances as being alternative representations of the same logical property.
##### getTypeParameters()
```
public final String[] getTypeParameters()
```

Gets the type parameter values.

**Returns:**
java.lang.String[] - The type parameter values.

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### getEncodingParameter()
```
public final String getEncodingParameter()
```

Gets the encoding parameter value.

**Returns:**
java.lang.String - The encoding parameter value.
##### getLanguageParameter()
```
public final String getLanguageParameter()
```

Gets the language parameter value.

**Returns:**
java.lang.String - The language parameter value.
##### getAnonymParameters()
```
public final String[] getAnonymParameters()
```

Gets the anonymous parameters.

**Returns:**
java.lang.String[] - The anonymous parameters.
##### getContentType()
```
public abstract VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getTypeName()
```
public final String getTypeName()
```

Gets the type of the record.

**Returns:**
java.lang.String - The type of the record.

### VCardRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public class VCardRecordset extends VCardBasePackage
```

Provides a base vCard record union class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata

### VCardRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class VCardRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a VCard file.

This code sample demonstrates how to read metadata properties of a vCard file.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.InputVcf)) {
>          VCardRootPackage root = metadata.getRootPackageGeneric();
>          for (VCardCard vCard : root.getVCardPackage().getCards()) {
>              System.out.println(vCard.getIdentificationRecordset().getName());
>              PrintArray(vCard.getIdentificationRecordset().getFormattedNames());
>              PrintArray(vCard.getCommunicationRecordset().getEmails());
>              PrintArray(vCard.getCommunicationRecordset().getTelephones());
>              PrintArray(vCard.getDeliveryAddressingRecordset().getAddresses());
>              // ...
>          }
>      }
>  }
>  private static void PrintArray(String[] values) {
>      if (values != null) {
>          for (String value : values) {
>              System.out.println(value);
>          }
>      }
>  }
>
> ```
> ```

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getVCardPackage() | Gets the VCard metadata package. |
##### getVCardPackage()
```
public final VCardPackage getVCardPackage()
```

Gets the VCard metadata package.

**Returns:**
VCardPackage - The VCard metadata package.

### VCardSecurityRecordset
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardsecurityrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardSecurityRecordset extends VCardRecordset
```

Represents a set of Security vCard records. These properties are concerned with the security of communication pathways or access to the vCard.
#### Methods

| Method | Description |
| --- | --- |
| getAccessClassification() | Gets the sensitivity of the information in the vCard. |
| getPublicKeyRecords() | Gets the public keys or authentication certificates associated with the object. |
| getPublicKeyBinaryRecords() | Gets the public keys or authentication certificates associated with the object. |
| getBinaryPublicKeys() | Gets the public keys or authentication certificates associated with the object. |
| getPublicKeyUriRecords() | Gets the public keys or authentication certificates associated with the object. |
| getUriPublicKeys() | Gets the public keys or authentication certificates associated with the object. |
##### getAccessClassification()
```
public final String getAccessClassification()
```

Gets the sensitivity of the information in the vCard.

**Returns:**
java.lang.String - The sensitivity of the information in the vCard.
##### getPublicKeyRecords()
```
public final VCardRecord[] getPublicKeyRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The public keys or authentication certificates associated with the object.
##### getPublicKeyBinaryRecords()
```
public final VCardBinaryRecord[] getPublicKeyBinaryRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyRecords .
##### getBinaryPublicKeys()
```
public final byte[][] getBinaryPublicKeys()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
byte[][] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyBinaryRecords .
##### getPublicKeyUriRecords()
```
public final VCardTextRecord[] getPublicKeyUriRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyRecords .
##### getUriPublicKeys()
```
public final String[] getUriPublicKeys()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
java.lang.String[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyUriRecords .

### VCardTextRecord
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/vcardtextrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardTextRecord extends VCardRecord implements IVCardRecord<String>
```

Represents vCard text record metadata class.
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getMediaTypeParameter() | Gets the media type parameter value. |
| getCharsetParameter() | Gets the charset parameter. |
| getValue() | Gets the record value. |
| isQuotedPrintable() | Gets a value indicating whether this instance is quoted printable string. |
| getReadabilityValue(String codePageName) | Gets the readability value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getMediaTypeParameter()
```
public final String getMediaTypeParameter()
```

Gets the media type parameter value.

**Returns:**
java.lang.String - The media type parameter value.

Used with properties whose value is a URI. It provides a hint to the vCard consumer application about the media type [RFC2046] of the resource identified by the URI.
##### getCharsetParameter()
```
public final String getCharsetParameter()
```

Gets the charset parameter.

**Returns:**
java.lang.String - The charset parameter.
##### getValue()
```
public final String getValue()
```

Gets the record value.

**Returns:**
java.lang.String - The record value.
##### isQuotedPrintable()
```
public final boolean isQuotedPrintable()
```

Gets a value indicating whether this instance is quoted printable string.

**Returns:**
boolean -  true  if this instance is quoted printable; otherwise,  false .
##### getReadabilityValue(String codePageName)
```
public final String getReadabilityValue(String codePageName)
```

Gets the readability value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| codePageName | java.lang.String | The using encoding code page name or null for ASCII encoding. |

**Returns:**
java.lang.String - The readability value.

### WavPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wavpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WavPackage extends CustomPackage
```

Represents a native metadata package in a WAV audio file.

This code sample shows how to extract technical audio information from a WAV file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputWav)) {
>      WavRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getWavPackage() != null) {
>          System.out.println(root.getWavPackage().getAudioFormat());
>          System.out.println(root.getWavPackage().getBitsPerSample());
>          System.out.println(root.getWavPackage().getBlockAlign());
>          System.out.println(root.getWavPackage().getByteRate());
>          System.out.println(root.getWavPackage().getNumberOfChannels());
>          System.out.println(root.getWavPackage().getSampleRate());
>      }
>  }
>
> ```
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| WavPackage() | Initializes a new instance of the  WavPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAudioFormat() | Gets the audio format. |
| getNumberOfChannels() | Gets the number of channels. |
| getSampleRate() | Gets the sample rate. |
| getByteRate() | Gets the byte rate. |
| getBlockAlign() | Gets the block align. |
| getBitsPerSample() | Gets the bits per sample value. |
##### WavPackage()
```
public WavPackage()
```

Initializes a new instance of the  WavPackage  class.

##### getAudioFormat()
```
public final int getAudioFormat()
```

Gets the audio format. PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression.

**Returns:**
int - The audio format.
##### getNumberOfChannels()
```
public final int getNumberOfChannels()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getSampleRate()
```
public final int getSampleRate()
```

Gets the sample rate.

**Returns:**
int - The sample rate.
##### getByteRate()
```
public final int getByteRate()
```

Gets the byte rate.

**Returns:**
int - The byte rate.
##### getBlockAlign()
```
public final int getBlockAlign()
```

Gets the block align.

**Returns:**
int - The block align.
##### getBitsPerSample()
```
public final int getBitsPerSample()
```

Gets the bits per sample value.

**Returns:**
int - The bits per sample value.

### WavRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wavrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class WavRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in a WAV audio.

This code sample shows how to extract technical audio information from a WAV file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputWav)) {
>      WavRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getWavPackage() != null) {
>          System.out.println(root.getWavPackage().getAudioFormat());
>          System.out.println(root.getWavPackage().getBitsPerSample());
>          System.out.println(root.getWavPackage().getBlockAlign());
>          System.out.println(root.getWavPackage().getByteRate());
>          System.out.println(root.getWavPackage().getNumberOfChannels());
>          System.out.println(root.getWavPackage().getSampleRate());
>      }
>  }
>
> ```
> ```
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getWavPackage() | Gets the WAV native metadata package. |
| getRiffInfoPackage() | Gets the package containing RIFF Info tags. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getWavPackage()
```
public final WavPackage getWavPackage()
```

Gets the WAV native metadata package.

**Returns:**
WavPackage - The WAV native metadata package.
##### getRiffInfoPackage()
```
public final RiffInfoPackage getRiffInfoPackage()
```

Gets the package containing RIFF Info tags.

**Returns:**
RiffInfoPackage - The package containing RIFF Info tags.

### WebPRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/webprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class WebPRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package allowing working with metadata in a WEBP image.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

### WmfRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wmfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class WmfRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a WMF image.

### WordProcessingComment
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingComment extends CustomPackage
```

Represents a comment in a word processing document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getId() | Gets the comment id. |
| getAuthor() | Gets the author. |
| setAuthor(String value) | Sets the author. |
| getInitials() | Gets the author's initials. |
| setInitials(String value) | Sets the author's initials. |
| getText() | Gets the text of the comment. |
| setText(String value) | Sets the text of the comment. |
| getCreatedDate() | Gets the date the comment was created. |
| setCreatedDate(Date value) | Sets the date the comment was created. |
##### getId()
```
public final int getId()
```

Gets the comment id.

**Returns:**
int - The comment identifier.
##### getAuthor()
```
public final String getAuthor()
```

Gets the author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getInitials()
```
public final String getInitials()
```

Gets the author's initials.

**Returns:**
java.lang.String - The initials of the author.
##### setInitials(String value)
```
public final void setInitials(String value)
```

Sets the author's initials.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The initials of the author. |

##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The text of the comment.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text of the comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of the comment. |

##### getCreatedDate()
```
public final Date getCreatedDate()
```

Gets the date the comment was created.

**Returns:**
java.util.Date - The date the comment was created.
##### setCreatedDate(Date value)
```
public final void setCreatedDate(Date value)
```

Sets the date the comment was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the comment was created. |

### WordProcessingField
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class WordProcessingField extends CustomPackage
```

Represents a field in a word processing document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getCode() | Gets the field code. |
| getResult() | Gets the field result. |
##### getCode()
```
public final String getCode()
```

Gets the field code.

**Returns:**
java.lang.String - The field code.
##### getResult()
```
public final String getResult()
```

Gets the field result.

**Returns:**
java.lang.String - The field result.

### WordProcessingFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum WordProcessingFormat extends Enum<WordProcessingFormat> implements IEnumValue
```

Defines various word processing document subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Doc | Represents the .DOC Word format. |
| Docm | Represents the .DOCM Word format. |
| Docx | Represents the .DOCX Word format. |
| Dot | Represents the .DOT Word format. |
| Dotx | Represents the .DOTX Word format. |
| Dotm | Represents the .DOTM Word format. |
| Odt | Represents the .ODT format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final WordProcessingFormat Unknown
```

The format is not recognized.

##### Doc
```
public static final WordProcessingFormat Doc
```

Represents the .DOC Word format. Files with .doc extension represent documents generated by Microsoft Word or other word processing applications in binary file format. The extension was initially used for plain text documentation on several different operating systems. It can contain several different types of data such as images, formatted as well as plain text, graphs, charts, embedded objects, links, pages, page formatting, print settings and a lot others. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/doc/

##### Docm
```
public static final WordProcessingFormat Docm
```

Represents the .DOCM Word format. DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. It is similar to DOCX file format but the ability to run macros makes it different from DOCX. Like DOCX, DOCM files can be store text, images, tables, shapes, charts and other contents. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docm/

##### Docx
```
public static final WordProcessingFormat Docx
```

Represents the .DOCX Word format. 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. Docx files can be opened with Word 2007 and lateral versions but not with the earlier versions of MS Word which support DOC file extensions. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docx/

##### Dot
```
public static final WordProcessingFormat Dot
```

Represents the .DOT Word format. Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent files created from these. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dot/

##### Dotx
```
public static final WordProcessingFormat Dotx
```

Represents the .DOTX Word format. Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent flies created from these. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotx/

##### Dotm
```
public static final WordProcessingFormat Dotm
```

Represents the .DOTM Word format. A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. It is similar to the popular DOCX file format other than it retains the user defined settings for reuse in case of creating new documents. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotm/

##### Odt
```
public static final WordProcessingFormat Odt
```

Represents the .ODT format. ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/odt/

##### values()
```
public static WordProcessingFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.WordProcessingFormat[]
##### valueOf(String name)
```
public static WordProcessingFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
WordProcessingFormat
##### getByRawValue(int rawValue)
```
public static WordProcessingFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
WordProcessingFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### WordProcessingInspectionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessinginspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingInspectionPackage extends CustomPackage
```

Contains information about document parts that can be considered as metadata in some cases.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets an array of the user comments. |
| getFields() | Gets an array of document fields. |
| getHiddenText() | Gets an array of hidden text fragments extracted from the document. |
| getDigitalSignatures() | Gets an array of digital signatures presented in the document. |
| getRevisions() | Gets an array of digital signatures presented in the document. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the document. |
| clearFields() | Removes all detected fields from the document. |
| clearHiddenText() | Removes all hidden text fragments from the document. |
| acceptAllRevisions() | Accepts all detected revisions in the document. |
| rejectAllRevisions() | Rejects all detected revisions in the document. |
| sanitize() | Removes writable metadata properties from the package. |
##### getComments()
```
public final WordProcessingComment[] getComments()
```

Gets an array of the user comments.

**Returns:**
com.groupdocs.metadata.core.WordProcessingComment[] - The user comments.
##### getFields()
```
public final WordProcessingField[] getFields()
```

Gets an array of document fields.

**Returns:**
com.groupdocs.metadata.core.WordProcessingField[] - An array of document fields.
##### getHiddenText()
```
public final String[] getHiddenText()
```

Gets an array of hidden text fragments extracted from the document.

**Returns:**
java.lang.String[] - An array of hidden text fragments extracted from the document.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - The digital signatures.
##### getRevisions()
```
public final WordProcessingRevision[] getRevisions()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.WordProcessingRevision[] - The digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the document.

##### clearFields()
```
public final void clearFields()
```

Removes all detected fields from the document.

##### clearHiddenText()
```
public final void clearHiddenText()
```

Removes all hidden text fragments from the document.

##### acceptAllRevisions()
```
public final void acceptAllRevisions()
```

Accepts all detected revisions in the document.

##### rejectAllRevisions()
```
public final void rejectAllRevisions()
```

Rejects all detected revisions in the document.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### WordProcessingPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class WordProcessingPackage extends DocumentPackage
```

Represents a native metadata package in a word processing document.

This code sample shows how to update built-in metadata properties in a WordProcessing document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDoc)) {
>      WordProcessingRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputDoc);
>  }
>
> ```
> ```

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the document's author. |
| setAuthor(String value) | Sets the document's author. |
| getBytesInDocument() | Gets an estimate of the number of bytes in the document. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type of the document. |
| setContentType(String value) | Sets the content type of the document. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTemplate() | Gets the template. |
| setTemplate(String value) | Sets the template. |
| getLastPrintedDate() | Gets the last printed date. |
| setLastPrintedDate(Date value) | Sets the last printed date. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getLastSavedTime() | Gets the time of the last save. |
| setLastSavedTime(Date value) | Sets the time of the last save. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of the application. |
| getRevisionNumber() | Gets the revision number. |
| setRevisionNumber(Integer value) | Sets the revision number. |
| getVersion() | Gets the version number of the application that created the document. |
| getTotalEditingTime() | Gets the total editing time in minutes. |
| setTotalEditingTime(Integer value) | Sets the total editing time in minutes. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getLinksUpToDate() | Gets a value indicating whether the hyperlinks in the document are up-to-date. |
| setLinksUpToDate(Boolean value) | Sets a value indicating whether the hyperlinks in the document are up-to-date. |
| getTitlesOfParts() | Gets the titles of document parts. |
| getWords() | Gets an estimate of the number of words in the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the document's author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document's author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getBytesInDocument()
```
public final Integer getBytesInDocument()
```

Gets an estimate of the number of bytes in the document.

**Returns:**
java.lang.Integer - An estimate of the number of bytes in the document.
##### getCategory()
```
public final String getCategory()
```

Gets the category.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getComments()
```
public final String getComments()
```

Gets the comments.

**Returns:**
java.lang.String - The comments.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comments. |

##### getCompany()
```
public final String getCompany()
```

Gets the company.

**Returns:**
java.lang.String - The company.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The company. |

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status.

**Returns:**
java.lang.String - The content status.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content status. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type of the document.

**Returns:**
java.lang.String - The type of the content.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The created time.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The created time. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink base. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject. |

##### getTemplate()
```
public final String getTemplate()
```

Gets the template.

**Returns:**
java.lang.String - The template.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets the template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The template. |

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The name of the last author.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the last author. |

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the time of the last save.

**Returns:**
java.util.Date - The time of the last save.
##### setLastSavedTime(Date value)
```
public final void setLastSavedTime(Date value)
```

Sets the time of the last save.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The time of the last save. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

**Returns:**
java.lang.String - The manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manager. |

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of the application.

**Returns:**
java.lang.String - The name of the application.
##### getRevisionNumber()
```
public final Integer getRevisionNumber()
```

Gets the revision number.

**Returns:**
java.lang.Integer - The revision number.
##### setRevisionNumber(Integer value)
```
public final void setRevisionNumber(Integer value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The revision number. |

##### getVersion()
```
public final Integer getVersion()
```

Gets the version number of the application that created the document.

**Returns:**
java.lang.Integer - The version number of the application that created the document.

When a document was created by Microsoft Word, then high 16 bit represent the major version and low 16 bit represent the build number.
##### getTotalEditingTime()
```
public final Integer getTotalEditingTime()
```

Gets the total editing time in minutes.

**Returns:**
java.lang.Integer - The total editing time in minutes.
##### setTotalEditingTime(Integer value)
```
public final void setTotalEditingTime(Integer value)
```

Sets the total editing time in minutes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The total editing time in minutes. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title of the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the document. |

##### getLinksUpToDate()
```
public final Boolean getLinksUpToDate()
```

Gets a value indicating whether the hyperlinks in the document are up-to-date.

**Returns:**
java.lang.Boolean - A value indicating whether the hyperlinks in the document are up-to-date.
##### setLinksUpToDate(Boolean value)
```
public final void setLinksUpToDate(Boolean value)
```

Sets a value indicating whether the hyperlinks in the document are up-to-date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the hyperlinks in the document are up-to-date. |

##### getTitlesOfParts()
```
public final String[] getTitlesOfParts()
```

Gets the titles of document parts. Read-only.

**Returns:**
java.lang.String[] - The titles of document parts.
##### getWords()
```
public final Integer getWords()
```

Gets an estimate of the number of words in the document.

**Returns:**
java.lang.Integer - The number of words in the document.
##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### WordProcessingRevision
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingrevision.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingRevision extends CustomPackage
```

Represents a revision (tracked change) in a document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the revision. |
| getDateTime() | Gets the date/time of the revision. |
| getRevisionType() | Gets the type of the revision. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the revision.

**Returns:**
java.lang.String - The author of the revision.
##### getDateTime()
```
public final Date getDateTime()
```

Gets the date/time of the revision.

**Returns:**
java.util.Date - The date/time of the revision.
##### getRevisionType()
```
public final WordProcessingRevisionType getRevisionType()
```

Gets the type of the revision.

**Returns:**
WordProcessingRevisionType - The type of the revision.

### WordProcessingRevisionType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingrevisiontype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum WordProcessingRevisionType extends Enum<WordProcessingRevisionType> implements IEnumValue
```

Specifies the type of the change being tracked by a revision.
#### Fields

| Field | Description |
| --- | --- |
| Insertion | New content was inserted into the document. |
| Deletion | Content was removed from the document. |
| FormatChange | Change of formatting was applied to the parent node. |
| StyleDefinitionChange | Change of formatting was applied to the parent style. |
| Moving | Content was moved in the document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Insertion
```
public static final WordProcessingRevisionType Insertion
```

New content was inserted into the document.

##### Deletion
```
public static final WordProcessingRevisionType Deletion
```

Content was removed from the document.

##### FormatChange
```
public static final WordProcessingRevisionType FormatChange
```

Change of formatting was applied to the parent node.

##### StyleDefinitionChange
```
public static final WordProcessingRevisionType StyleDefinitionChange
```

Change of formatting was applied to the parent style.

##### Moving
```
public static final WordProcessingRevisionType Moving
```

Content was moved in the document.

##### values()
```
public static WordProcessingRevisionType[] values()
```

**Returns:**
com.groupdocs.metadata.core.WordProcessingRevisionType[]
##### valueOf(String name)
```
public static WordProcessingRevisionType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
WordProcessingRevisionType
##### getByRawValue(int rawValue)
```
public static WordProcessingRevisionType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
WordProcessingRevisionType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### WordProcessingRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDublinCore
```
public class WordProcessingRootPackage extends DocumentRootPackage<WordProcessingPackage> implements IDublinCore
```

Represents the root package allowing working with metadata in a word processing document.

This code sample demonstrates how to read built-in metadata properties of a WordProcessing document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>      WordProcessingRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getWordProcessingType() | Gets the file type metadata package. |
| getDublinCorePackage() | Gets the Dublin Core metadata package extracted from the document. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| updateDocumentStatistics() | Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages. |
##### getWordProcessingType()
```
public final WordProcessingTypePackage getWordProcessingType()
```

Gets the file type metadata package.

**Returns:**
WordProcessingTypePackage - The file type metadata package.
##### getDublinCorePackage()
```
public final DublinCorePackage getDublinCorePackage()
```

Gets the Dublin Core metadata package extracted from the document.

**Returns:**
DublinCorePackage - The Dublin Core metadata package extracted from the document.
##### getInspectionPackage()
```
public final WordProcessingInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
WordProcessingInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### updateDocumentStatistics()
```
public final void updateDocumentStatistics()
```

Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages.

### WordProcessingTypePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/wordprocessingtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class WordProcessingTypePackage extends FileTypePackage
```

Represents a metadata package containing document-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getWordProcessingFormat() | Gets the exact word processing format. |
##### getWordProcessingFormat()
```
public final WordProcessingFormat getWordProcessingFormat()
```

Gets the exact word processing format.

**Returns:**
WordProcessingFormat - The exact word processing format.

### XmpArray
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmparray.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpArray extends XmpValueBase
```

Represents base abstraction for XMP array.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpArray(XmpArrayType arrayType, XmpValueBase[] items) | Initializes a new instance of the  XmpArray  class. |
| XmpArray(XmpArrayType arrayType, XmpComplexType[] items) | Initializes a new instance of the  XmpArray  class. |
#### Methods

| Method | Description |
| --- | --- |
| getArrayType() | Gets the type of the XMP array. |
| <T>from(T[] array, XmpArrayType type) | Creates an  XmpArray  instance form an array of  XmpComplexType . |
| from(String[] array, XmpArrayType type) | Creates an  XmpArray  instance form a string array. |
| from(int[] array, XmpArrayType type) | Creates an  XmpArray  instance form an integer array. |
| from(Date[] array, XmpArrayType type) | Creates an  XmpArray  instance form a date array. |
| from(double[] array, XmpArrayType type) | Creates an  XmpArray  instance form a double array. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
| <T>toPlatformArray(Class<T> type) | Converts the  XmpArray  to a platform-specific array. |
##### XmpArray(XmpArrayType arrayType, XmpValueBase[] items)
```
public XmpArray(XmpArrayType arrayType, XmpValueBase[] items)
```

Initializes a new instance of the  XmpArray  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpValueBase\[\] | Array items. |

##### XmpArray(XmpArrayType arrayType, XmpComplexType[] items)
```
public XmpArray(XmpArrayType arrayType, XmpComplexType[] items)
```

Initializes a new instance of the  XmpArray  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpComplexType\[\] | Array items. |

##### getArrayType()
```
public final XmpArrayType getArrayType()
```

Gets the type of the XMP array.

**Returns:**
XmpArrayType - The type of the XMP array.
##### <T>from(T[] array, XmpArrayType type)
```
public static XmpArray <T>from(T[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form an array of  XmpComplexType .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | T[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray .

 T : The element type of the source array. |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(String[] array, XmpArrayType type)
```
public static XmpArray from(String[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a string array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | java.lang.String[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(int[] array, XmpArrayType type)
```
public static XmpArray from(int[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form an integer array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | int[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(Date[] array, XmpArrayType type)
```
public static XmpArray from(Date[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a date array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | java.util.Date[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(double[] array, XmpArrayType type)
```
public static XmpArray from(double[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a double array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | double[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.
##### <T>toPlatformArray(Class<T> type)
```
public final T[] <T>toPlatformArray(Class<T> type)
```

Converts the  XmpArray  to a platform-specific array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T[] - A platform-specific array containing elements of the  XmpArray .

 T : The type of the array element.

### XmpArrayType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmparraytype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpArrayType extends Enum<XmpArrayType> implements IEnumValue
```

Represents array type in  XmpArray .
#### Fields

| Field | Description |
| --- | --- |
| Unordered | An unordered array. |
| Ordered | An ordered array. |
| Alternative | An alternative array. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unordered
```
public static final XmpArrayType Unordered
```

An unordered array.

##### Ordered
```
public static final XmpArrayType Ordered
```

An ordered array.

##### Alternative
```
public static final XmpArrayType Alternative
```

An alternative array.

##### values()
```
public static XmpArrayType[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpArrayType[]
##### valueOf(String name)
```
public static XmpArrayType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpArrayType
##### getByRawValue(int rawValue)
```
public static XmpArrayType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpArrayType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpAudioChannelType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpaudiochanneltype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpAudioChannelType extends XmpClosedChoice<String>
```

Represents audio channel type.
#### Methods

| Method | Description |
| --- | --- |
| getMono() | Gets mono audio channel. |
| getStereo() | Gets stereo audio channel. |
| getAudio51() | Gets 5.1 audio channel. |
| getAudio71() | Gets 7.1 audio channel. |
| getAudio16Channel() | Gets 16 audio channel. |
| getOtherChannel() | Gets other channel. |
##### getMono()
```
public static XmpAudioChannelType getMono()
```

Gets mono audio channel.

**Returns:**
XmpAudioChannelType - The mono.
##### getStereo()
```
public static XmpAudioChannelType getStereo()
```

Gets stereo audio channel.

**Returns:**
XmpAudioChannelType - The stereo.
##### getAudio51()
```
public static XmpAudioChannelType getAudio51()
```

Gets 5.1 audio channel.

**Returns:**
XmpAudioChannelType - The audio 5.1.
##### getAudio71()
```
public static XmpAudioChannelType getAudio71()
```

Gets 7.1 audio channel.

**Returns:**
XmpAudioChannelType - The audio 7.1.
##### getAudio16Channel()
```
public static XmpAudioChannelType getAudio16Channel()
```

Gets 16 audio channel.

**Returns:**
XmpAudioChannelType - 16 channel audio.
##### getOtherChannel()
```
public static XmpAudioChannelType getOtherChannel()
```

Gets other channel.

**Returns:**
XmpAudioChannelType - The other channel.

### XmpAudioSampleType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpaudiosampletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpAudioSampleType extends XmpClosedChoice<String>
```

Represents Audio sample type in  XmpDynamicMediaPackage .
#### Methods

| Method | Description |
| --- | --- |
| getSample8Int() | Gets 8Int audio sample. |
| getSample16Int() | Gets 16Int audio sample. |
| getSample24Int() | Gets 24Int audio sample. |
| getSample32Int() | Gets 32Int audio sample. |
| getSample32Float() | Gets 32Float audio sample. |
| getCompressed() | Gets Compressed audio sample. |
| getPacked() | Gets Packed audio sample. |
| getOther() | Gets Other audio sample. |
##### getSample8Int()
```
public static XmpAudioSampleType getSample8Int()
```

Gets 8Int audio sample.

**Returns:**
XmpAudioSampleType - 8Int.
##### getSample16Int()
```
public static XmpAudioSampleType getSample16Int()
```

Gets 16Int audio sample.

**Returns:**
XmpAudioSampleType - 16Int.
##### getSample24Int()
```
public static XmpAudioSampleType getSample24Int()
```

Gets 24Int audio sample.

**Returns:**
XmpAudioSampleType - 24Int.
##### getSample32Int()
```
public static XmpAudioSampleType getSample32Int()
```

Gets 32Int audio sample.

**Returns:**
XmpAudioSampleType - 32Int.
##### getSample32Float()
```
public static XmpAudioSampleType getSample32Float()
```

Gets 32Float audio sample.

**Returns:**
XmpAudioSampleType - 32Float.
##### getCompressed()
```
public static XmpAudioSampleType getCompressed()
```

Gets Compressed audio sample.

**Returns:**
XmpAudioSampleType - The compressed audio.
##### getPacked()
```
public static XmpAudioSampleType getPacked()
```

Gets Packed audio sample.

**Returns:**
XmpAudioSampleType - The packed audio.
##### getOther()
```
public static XmpAudioSampleType getOther()
```

Gets Other audio sample.

**Returns:**
XmpAudioSampleType - The packed audio.

### XmpBasicJobTicketPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpbasicjobticketpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpBasicJobTicketPackage extends XmpPackage
```

Represents Basic Job-Ticket namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBasicJobTicketPackage() | Initializes a new instance of the  XmpBasicJobTicketPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getJobs() | Gets the jobs. |
| setJobs(XmpJob[] value) | Sets the jobs. |
##### XmpBasicJobTicketPackage()
```
public XmpBasicJobTicketPackage()
```

Initializes a new instance of the  XmpBasicJobTicketPackage  class.

##### getJobs()
```
public final XmpJob[] getJobs()
```

Gets the jobs.

**Returns:**
com.groupdocs.metadata.core.XmpJob[] - The jobs.
##### setJobs(XmpJob[] value)
```
public final void setJobs(XmpJob[] value)
```

Sets the jobs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpJob\[\] | The jobs. |

### XmpBasicPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpbasicpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpBasicPackage extends XmpPackage
```

Represents the XMP basic namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBasicPackage() | Initializes a new instance of the  XmpBasicPackage  class. |
#### Fields

| Field | Description |
| --- | --- |
| RatingRejected | Rating rejected value. |
| RatingMin | Rating min value. |
| RatingMax | Rating max value. |
#### Methods

| Method | Description |
| --- | --- |
| getBaseUrl() | Gets the base URL for relative URLs in the document content. |
| setBaseUrl(String value) | Sets the base URL for relative URLs in the document content. |
| getCreateDate() | Gets the date and time the resource was created. |
| setCreateDate(Date value) | Sets the date and time the resource was created. |
| getCreatorTool() | Gets the name of the tool used to create the resource. |
| setCreatorTool(String value) | Sets the name of the tool used to create the resource. |
| getIdentifiers() | Gets an unordered array of text strings that unambiguously identify the resource within a given context. |
| setIdentifiers(String[] value) | Sets an unordered array of text strings that unambiguously identify the resource within a given context. |
| getLabel() | Gets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| setLabel(String value) | Sets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| getMetadataDate() | Gets the date and time that any metadata for this resource was last changed. |
| setMetadataDate(Date value) | Sets the date and time that any metadata for this resource was last changed. |
| getModifyDate() | Gets the date and time the resource was last modified. |
| setModifyDate(Date value) | Sets the date and time the resource was last modified. |
| getNickname() | Gets a short informal name for the resource. |
| setNickname(String value) | Sets a short informal name for the resource. |
| getRating() | Gets a user-assigned rating for this file. |
| setRating(double value) | Sets a user-assigned rating for this file. |
| getThumbnails() | Gets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| setThumbnails(XmpThumbnail[] value) | Sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| set(String name, String value) | Adds string property. |
##### XmpBasicPackage()
```
public XmpBasicPackage()
```

Initializes a new instance of the  XmpBasicPackage  class.

##### RatingRejected
```
public static final float RatingRejected
```

Rating rejected value.

##### RatingMin
```
public static final float RatingMin
```

Rating min value.

##### RatingMax
```
public static final float RatingMax
```

Rating max value.

##### getBaseUrl()
```
public final String getBaseUrl()
```

Gets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL.

**Returns:**
java.lang.String - The base URL.
##### setBaseUrl(String value)
```
public final void setBaseUrl(String value)
```

Sets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The base URL. |

##### getCreateDate()
```
public final Date getCreateDate()
```

Gets the date and time the resource was created.

**Returns:**
java.util.Date - The resource creation date.
##### setCreateDate(Date value)
```
public final void setCreateDate(Date value)
```

Sets the date and time the resource was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The resource creation date. |

##### getCreatorTool()
```
public final String getCreatorTool()
```

Gets the name of the tool used to create the resource.

**Returns:**
java.lang.String - The name of the tool used to create the resource.
##### setCreatorTool(String value)
```
public final void setCreatorTool(String value)
```

Sets the name of the tool used to create the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the tool used to create the resource. |

##### getIdentifiers()
```
public final String[] getIdentifiers()
```

Gets an unordered array of text strings that unambiguously identify the resource within a given context.

**Returns:**
java.lang.String[] - An array of the identifiers.
##### setIdentifiers(String[] value)
```
public final void setIdentifiers(String[] value)
```

Sets an unordered array of text strings that unambiguously identify the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the identifiers. |

##### getLabel()
```
public final String getLabel()
```

Gets a word or short phrase that identifies the resource as a member of a user-defined collection.

**Returns:**
java.lang.String - The label of the resource.
##### setLabel(String value)
```
public final void setLabel(String value)
```

Sets a word or short phrase that identifies the resource as a member of a user-defined collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The label of the resource. |

##### getMetadataDate()
```
public final Date getMetadataDate()
```

Gets the date and time that any metadata for this resource was last changed.

**Returns:**
java.util.Date - The metadata date.
##### setMetadataDate(Date value)
```
public final void setMetadataDate(Date value)
```

Sets the date and time that any metadata for this resource was last changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The metadata date. |

##### getModifyDate()
```
public final Date getModifyDate()
```

Gets the date and time the resource was last modified.

**Returns:**
java.util.Date - The last modification date.
##### setModifyDate(Date value)
```
public final void setModifyDate(Date value)
```

Sets the date and time the resource was last modified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last modification date. |

##### getNickname()
```
public final String getNickname()
```

Gets a short informal name for the resource.

**Returns:**
java.lang.String - The nickname.
##### setNickname(String value)
```
public final void setNickname(String value)
```

Sets a short informal name for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The nickname. |

##### getRating()
```
public final double getRating()
```

Gets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates \\u201crejected\\u201d and 0 indicates \\u201cunrated\\u201d.

**Returns:**
double - The rating.
##### setRating(double value)
```
public final void setRating(double value)
```

Sets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates \\u201crejected\\u201d and 0 indicates \\u201cunrated\\u201d.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rating. |

##### getThumbnails()
```
public final XmpThumbnail[] getThumbnails()
```

Gets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.

**Returns:**
com.groupdocs.metadata.core.XmpThumbnail[] - The thumbnails.
##### setThumbnails(XmpThumbnail[] value)
```
public final void setThumbnails(XmpThumbnail[] value)
```

Sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpThumbnail\[\] | The thumbnails. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Adds string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XmpBasic key. |
| value | java.lang.String | String value. |

### XmpBoolean
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpboolean.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpBoolean extends XmpValueBase
```

Represents XMP Boolean basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBoolean(boolean value) | Initializes a new instance of the  XmpBoolean  class based on boolean value. |
| XmpBoolean() | Initializes a new instance of the  XmpBoolean  class with default value. |
| XmpBoolean(String value) | Initializes a new instance of the  XmpBoolean  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpBoolean(boolean value)
```
public XmpBoolean(boolean value)
```

Initializes a new instance of the  XmpBoolean  class based on boolean value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  bool  value. |

##### XmpBoolean()
```
public XmpBoolean()
```

Initializes a new instance of the  XmpBoolean  class with default value.

##### XmpBoolean(String value)
```
public XmpBoolean(String value)
```

Initializes a new instance of the  XmpBoolean  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final boolean getValue()
```

Gets the value.

**Returns:**
boolean - Boolean value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  String  contained XMP representation.

### XmpCameraRawPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcamerarawpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpCameraRawPackage extends XmpPackage
```

Represents Camera Raw schema.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpCameraRawPackage() | Initializes a new instance of the  XmpCameraRawPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAutoBrightness() | Gets the AutoBrightness value. |
| setAutoBrightness(Boolean value) | Sets the AutoBrightness value. |
| getAutoContrast() | Gets the AutoContrast value. |
| setAutoContrast(Boolean value) | Sets the AutoContrast value. |
| getAutoExposure() | Gets the AutoExposure value. |
| setAutoExposure(Boolean value) | Sets the AutoExposure value. |
| getAutoShadows() | Gets the AutoShadows value. |
| setAutoShadows(Boolean value) | Sets the AutoShadows value. |
| getBlueHue() | Gets the BlueHue value. |
| setBlueHue(Integer value) | Sets the BlueHue value. |
| getBlueSaturation() | Gets the BlueSaturation. |
| setBlueSaturation(Integer value) | Sets the BlueSaturation. |
| getBrightness() | Gets the Brightness value. |
| setBrightness(Integer value) | Sets the Brightness value. |
| getCameraProfile() | Gets the CameraProfile value. |
| setCameraProfile(String value) | Sets the CameraProfile value. |
| getChromaticAberrationB() | Gets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. |
| setChromaticAberrationB(Integer value) | Sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. |
| getChromaticAberrationR() | Gets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. |
| setChromaticAberrationR(Integer value) | Sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. |
| getColorNoiseReduction() | Gets the Color Noise Reduction setting. |
| setColorNoiseReduction(Integer value) | Sets the Color Noise Reduction setting. |
| getContrast() | Gets the Contrast setting. |
| setContrast(Integer value) | Sets the Contrast setting. |
| getCropTop() | Gets the CropTop setting. |
| setCropTop(Double value) | Sets the CropTop setting. |
| getCropLeft() | Gets the CropLeft setting. |
| setCropLeft(Double value) | Sets the CropLeft setting. |
| getCropBottom() | Gets the CropBottom setting. |
| setCropBottom(Double value) | Sets the CropBottom setting. |
| getCropRight() | Gets the CropRight setting. |
| setCropRight(Double value) | Sets the CropRight setting. |
| getCropAngle() | Gets the CropAngle setting. |
| setCropAngle(Double value) | Sets the CropAngle setting. |
| getCropWidth() | Gets the width of the resulting cropped image in  CropUnits  units. |
| setCropWidth(Double value) | Sets the width of the resulting cropped image in  CropUnits  units. |
| getCropHeight() | Gets the height of the resulting cropped image in  CropUnits  units. |
| setCropHeight(Double value) | Sets the height of the resulting cropped image in  CropUnits  units. |
| getCropUnits() | Gets units for  CropWidth  and  CropHeight . |
| setCropUnits(XmpCropUnit value) | Sets units for  CropWidth  and  CropHeight . |
| getExposure() | Gets the Exposure setting. |
| setExposure(Double value) | Sets the Exposure setting. |
| getGreenHue() | Gets the Green Hue setting. |
| setGreenHue(Integer value) | Sets the Green Hue setting. |
| getGreenSaturation() | Gets the Green Saturation setting. |
| setGreenSaturation(Integer value) | Sets the Green Saturation setting. |
| hasCrop() | Gets or sets the HasCrop value. |
| setCrop(Boolean value) | Sets the HasCrop value. |
| hasSettings() | Gets or sets HasSettings value. |
| setSettings(Boolean value) | Sets HasSettings value. |
| getLuminanceSmoothing() | Gets the LuminanceSmoothing setting. |
| setLuminanceSmoothing(Integer value) | Sets the LuminanceSmoothing setting. |
| getRawFileName() | Gets the file name for a raw file (not a complete path). |
| setRawFileName(String value) | Sets the file name for a raw file (not a complete path). |
| getRedHue() | Gets the Red Hue setting. |
| setRedHue(Integer value) | Sets the Red Hue setting. |
| getRedSaturation() | Gets the Red Saturation setting. |
| setRedSaturation(Integer value) | Sets the Red Saturation setting. |
| getSaturation() | Gets the Saturation setting. |
| setSaturation(Integer value) | Sets the Saturation setting. |
| getShadows() | Gets the Shadows setting. |
| setShadows(Integer value) | Sets the Shadows setting. |
| getShadowTint() | Gets the ShadowTint setting. |
| setShadowTint(Integer value) | Sets the ShadowTint setting. |
| getSharpness() | Gets the Sharpness setting. |
| setSharpness(Integer value) | Sets the Sharpness setting. |
| getTemperature() | Gets the Temperature setting. |
| setTemperature(Integer value) | Sets the Temperature setting. |
| getTint() | Gets the Tint setting. |
| setTint(Integer value) | Sets the Tint setting. |
| getVersion() | Gets the version of the Camera Raw plug-in. |
| setVersion(String value) | Sets the version of the Camera Raw plug-in. |
| getVignetteAmount() | Gets the Vignette Amount setting. |
| setVignetteAmount(Integer value) | Sets the Vignette Amount setting. |
| getVignetteMidpoint() | Gets the Vignetting Midpoint setting. |
| setVignetteMidpoint(Integer value) | Sets the Vignetting Midpoint setting. |
| getWhiteBalance() | Gets White Balance setting. |
| set(String name, String value) | Adds string property. |
| setWhiteBalance(XmpWhiteBalance whiteBalance) | Sets the white balance. |
##### XmpCameraRawPackage()
```
public XmpCameraRawPackage()
```

Initializes a new instance of the  XmpCameraRawPackage  class.

##### getAutoBrightness()
```
public final Boolean getAutoBrightness()
```

Gets the AutoBrightness value. When true,  Brightness  is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic brightness]; otherwise,  false .
##### setAutoBrightness(Boolean value)
```
public final void setAutoBrightness(Boolean value)
```

Sets the AutoBrightness value. When true,  Brightness  is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic brightness]; otherwise,  false . |

##### getAutoContrast()
```
public final Boolean getAutoContrast()
```

Gets the AutoContrast value. When true, "Contrast" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic contrast]; otherwise,  false .
##### setAutoContrast(Boolean value)
```
public final void setAutoContrast(Boolean value)
```

Sets the AutoContrast value. When true, "Contrast" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic contrast]; otherwise,  false . |

##### getAutoExposure()
```
public final Boolean getAutoExposure()
```

Gets the AutoExposure value. When true, "Exposure" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic exposure]; otherwise,  false .
##### setAutoExposure(Boolean value)
```
public final void setAutoExposure(Boolean value)
```

Sets the AutoExposure value. When true, "Exposure" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic exposure]; otherwise,  false . |

##### getAutoShadows()
```
public final Boolean getAutoShadows()
```

Gets the AutoShadows value. When true, "Shadows" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic shadows]; otherwise,  false .
##### setAutoShadows(Boolean value)
```
public final void setAutoShadows(Boolean value)
```

Sets the AutoShadows value. When true, "Shadows" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic shadows]; otherwise,  false . |

##### getBlueHue()
```
public final Integer getBlueHue()
```

Gets the BlueHue value. Null if undefined.

**Returns:**
java.lang.Integer - The blue hue.
##### setBlueHue(Integer value)
```
public final void setBlueHue(Integer value)
```

Sets the BlueHue value. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue hue. |

##### getBlueSaturation()
```
public final Integer getBlueSaturation()
```

Gets the BlueSaturation. Null if undefined.

**Returns:**
java.lang.Integer - The blue saturation.
##### setBlueSaturation(Integer value)
```
public final void setBlueSaturation(Integer value)
```

Sets the BlueSaturation. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue saturation. |

##### getBrightness()
```
public final Integer getBrightness()
```

Gets the Brightness value. Null if undefined.

**Returns:**
java.lang.Integer - The brightness.
##### setBrightness(Integer value)
```
public final void setBrightness(Integer value)
```

Sets the Brightness value. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The brightness. |

##### getCameraProfile()
```
public final String getCameraProfile()
```

Gets the CameraProfile value.

**Returns:**
java.lang.String - The camera profile.
##### setCameraProfile(String value)
```
public final void setCameraProfile(String value)
```

Sets the CameraProfile value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The camera profile. |

##### getChromaticAberrationB()
```
public final Integer getChromaticAberrationB()
```

Gets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.

**Returns:**
java.lang.Integer - The chromatic aberration B.
##### setChromaticAberrationB(Integer value)
```
public final void setChromaticAberrationB(Integer value)
```

Sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The chromatic aberration B. |

##### getChromaticAberrationR()
```
public final Integer getChromaticAberrationR()
```

Gets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.

**Returns:**
java.lang.Integer - The chromatic aberration R.
##### setChromaticAberrationR(Integer value)
```
public final void setChromaticAberrationR(Integer value)
```

Sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The chromatic aberration R. |

##### getColorNoiseReduction()
```
public final Integer getColorNoiseReduction()
```

Gets the Color Noise Reduction setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The color noise reduction.
##### setColorNoiseReduction(Integer value)
```
public final void setColorNoiseReduction(Integer value)
```

Sets the Color Noise Reduction setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The color noise reduction. |

##### getContrast()
```
public final Integer getContrast()
```

Gets the Contrast setting. Range -50 to 100.

**Returns:**
java.lang.Integer - The contrast.
##### setContrast(Integer value)
```
public final void setContrast(Integer value)
```

Sets the Contrast setting. Range -50 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The contrast. |

##### getCropTop()
```
public final Double getCropTop()
```

Gets the CropTop setting. When HasCrop is true, top of the crop rectangle.

**Returns:**
java.lang.Double - The crop top.
##### setCropTop(Double value)
```
public final void setCropTop(Double value)
```

Sets the CropTop setting. When HasCrop is true, top of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop top. |

##### getCropLeft()
```
public final Double getCropLeft()
```

Gets the CropLeft setting. When HasCrop is true, left of the crop rectangle.

**Returns:**
java.lang.Double - The crop left.
##### setCropLeft(Double value)
```
public final void setCropLeft(Double value)
```

Sets the CropLeft setting. When HasCrop is true, left of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop left. |

##### getCropBottom()
```
public final Double getCropBottom()
```

Gets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.

**Returns:**
java.lang.Double - The crop bottom.
##### setCropBottom(Double value)
```
public final void setCropBottom(Double value)
```

Sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop bottom. |

##### getCropRight()
```
public final Double getCropRight()
```

Gets the CropRight setting. When HasCrop is true, right of the crop rectangle.

**Returns:**
java.lang.Double - The crop right.
##### setCropRight(Double value)
```
public final void setCropRight(Double value)
```

Sets the CropRight setting. When HasCrop is true, right of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop right. |

##### getCropAngle()
```
public final Double getCropAngle()
```

Gets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.

**Returns:**
java.lang.Double - The crop angle.
##### setCropAngle(Double value)
```
public final void setCropAngle(Double value)
```

Sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop angle. |

##### getCropWidth()
```
public final Double getCropWidth()
```

Gets the width of the resulting cropped image in  CropUnits  units.

**Returns:**
java.lang.Double - The width of the crop.
##### setCropWidth(Double value)
```
public final void setCropWidth(Double value)
```

Sets the width of the resulting cropped image in  CropUnits  units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The width of the crop. |

##### getCropHeight()
```
public final Double getCropHeight()
```

Gets the height of the resulting cropped image in  CropUnits  units.

**Returns:**
java.lang.Double - The height of the crop.
##### setCropHeight(Double value)
```
public final void setCropHeight(Double value)
```

Sets the height of the resulting cropped image in  CropUnits  units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The height of the crop. |

##### getCropUnits()
```
public final XmpCropUnit getCropUnits()
```

Gets units for  CropWidth  and  CropHeight .

**Returns:**
XmpCropUnit - The crop units.
##### setCropUnits(XmpCropUnit value)
```
public final void setCropUnits(XmpCropUnit value)
```

Sets units for  CropWidth  and  CropHeight .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpCropUnit | The crop units. |

##### getExposure()
```
public final Double getExposure()
```

Gets the Exposure setting.

**Returns:**
java.lang.Double - The exposure.
##### setExposure(Double value)
```
public final void setExposure(Double value)
```

Sets the Exposure setting.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The exposure. |

##### getGreenHue()
```
public final Integer getGreenHue()
```

Gets the Green Hue setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The green hue.
##### setGreenHue(Integer value)
```
public final void setGreenHue(Integer value)
```

Sets the Green Hue setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green hue. |

##### getGreenSaturation()
```
public final Integer getGreenSaturation()
```

Gets the Green Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The green saturation.
##### setGreenSaturation(Integer value)
```
public final void setGreenSaturation(Integer value)
```

Sets the Green Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green saturation. |

##### hasCrop()
```
public final Boolean hasCrop()
```

Gets or sets the HasCrop value. When true, the image has a cropping rectangle.

**Returns:**
java.lang.Boolean -  true  if the image has a cropping rectangle; otherwise,  false .
##### setCrop(Boolean value)
```
public final void setCrop(Boolean value)
```

Sets the HasCrop value. When true, the image has a cropping rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the image has a cropping rectangle; otherwise,  false . |

##### hasSettings()
```
public final Boolean hasSettings()
```

Gets or sets HasSettings value. When true, non-default camera raw settings.

**Returns:**
java.lang.Boolean -  true  if image has non-default camera raw settings; otherwise,  false .
##### setSettings(Boolean value)
```
public final void setSettings(Boolean value)
```

Sets HasSettings value. When true, non-default camera raw settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if image has non-default camera raw settings; otherwise,  false . |

##### getLuminanceSmoothing()
```
public final Integer getLuminanceSmoothing()
```

Gets the LuminanceSmoothing setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The luminance smoothing.
##### setLuminanceSmoothing(Integer value)
```
public final void setLuminanceSmoothing(Integer value)
```

Sets the LuminanceSmoothing setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The luminance smoothing. |

##### getRawFileName()
```
public final String getRawFileName()
```

Gets the file name for a raw file (not a complete path).

**Returns:**
java.lang.String - The name of the raw file.
##### setRawFileName(String value)
```
public final void setRawFileName(String value)
```

Sets the file name for a raw file (not a complete path).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the raw file. |

##### getRedHue()
```
public final Integer getRedHue()
```

Gets the Red Hue setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The red hue.
##### setRedHue(Integer value)
```
public final void setRedHue(Integer value)
```

Sets the Red Hue setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red hue. |

##### getRedSaturation()
```
public final Integer getRedSaturation()
```

Gets the Red Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The red saturation.
##### setRedSaturation(Integer value)
```
public final void setRedSaturation(Integer value)
```

Sets the Red Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red saturation. |

##### getSaturation()
```
public final Integer getSaturation()
```

Gets the Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The saturation.
##### setSaturation(Integer value)
```
public final void setSaturation(Integer value)
```

Sets the Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The saturation. |

##### getShadows()
```
public final Integer getShadows()
```

Gets the Shadows setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The shadows.
##### setShadows(Integer value)
```
public final void setShadows(Integer value)
```

Sets the Shadows setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The shadows. |

##### getShadowTint()
```
public final Integer getShadowTint()
```

Gets the ShadowTint setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The shadow tint.
##### setShadowTint(Integer value)
```
public final void setShadowTint(Integer value)
```

Sets the ShadowTint setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The shadow tint. |

##### getSharpness()
```
public final Integer getSharpness()
```

Gets the Sharpness setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The sharpness.
##### setSharpness(Integer value)
```
public final void setSharpness(Integer value)
```

Sets the Sharpness setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The sharpness. |

##### getTemperature()
```
public final Integer getTemperature()
```

Gets the Temperature setting. Range 2000 to 50000.

**Returns:**
java.lang.Integer - The temperature.
##### setTemperature(Integer value)
```
public final void setTemperature(Integer value)
```

Sets the Temperature setting. Range 2000 to 50000.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The temperature. |

##### getTint()
```
public final Integer getTint()
```

Gets the Tint setting. Range -150 to 150.

**Returns:**
java.lang.Integer - The tint.
##### setTint(Integer value)
```
public final void setTint(Integer value)
```

Sets the Tint setting. Range -150 to 150.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The tint. |

##### getVersion()
```
public final String getVersion()
```

Gets the version of the Camera Raw plug-in.

**Returns:**
java.lang.String - The version.
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the version of the Camera Raw plug-in.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The version. |

##### getVignetteAmount()
```
public final Integer getVignetteAmount()
```

Gets the Vignette Amount setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The vignette amount.
##### setVignetteAmount(Integer value)
```
public final void setVignetteAmount(Integer value)
```

Sets the Vignette Amount setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The vignette amount. |

##### getVignetteMidpoint()
```
public final Integer getVignetteMidpoint()
```

Gets the Vignetting Midpoint setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The Vignette Midpoint.
##### setVignetteMidpoint(Integer value)
```
public final void setVignetteMidpoint(Integer value)
```

Sets the Vignetting Midpoint setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The Vignette Midpoint. |

##### getWhiteBalance()
```
public final String getWhiteBalance()
```

Gets White Balance setting. Use  SetWhiteBalance  to set white balance value.

**Returns:**
java.lang.String - The white balance.
##### set(String name, String value)
```
public void set(String name, String value)
```

Adds string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata key. |
| value | java.lang.String | XMP metadata value. |

##### setWhiteBalance(XmpWhiteBalance whiteBalance)
```
public final void setWhiteBalance(XmpWhiteBalance whiteBalance)
```

Sets the white balance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteBalance | XmpWhiteBalance | The white balance. |

### XmpClosedChoice
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpclosedchoice.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public abstract class XmpClosedChoice<T> implements System.IEquatable<XmpClosedChoice<T>>
```

Represents XMP Closed Choice.

 T : Type of closed choice.
#### Methods

| Method | Description |
| --- | --- |
| hashCode() | Returns a hash code for this instance. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| equals(XmpClosedChoice<T> other) | Indicates whether the current object is equal to another object of the same type. |
| toString() | Returns a  String  that represents this instance. |
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  obj  parameter; otherwise, false.
##### equals(XmpClosedChoice<T> other)
```
public final boolean equals(XmpClosedChoice<T> other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | XmpClosedChoice | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  other  parameter; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  String  that represents this instance.

**Returns:**
java.lang.String - A  String  that represents this instance.

### XmpColorantBase
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolorantbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public class XmpColorantBase extends XmpComplexType
```

A structure containing the characteristics of a colorant (swatch) used in a document.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the colour space in which the colour is defined. |
| getSwatchName() | Gets the name of the swatch. |
| setSwatchName(String value) | Sets the name of the swatch. |
| getColorType() | Gets the type of color. |
| setColorType(XmpColorType value) | Sets the type of color. |
##### getMode()
```
public final XmpColorantColorMode getMode()
```

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.

**Returns:**
XmpColorantColorMode - The color mode.
##### getSwatchName()
```
public final String getSwatchName()
```

Gets the name of the swatch.

**Returns:**
java.lang.String - The name of the swatch.
##### setSwatchName(String value)
```
public final void setSwatchName(String value)
```

Sets the name of the swatch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the swatch. |

##### getColorType()
```
public final XmpColorType getColorType()
```

Gets the type of color.

**Returns:**
XmpColorType - The color type.
##### setColorType(XmpColorType value)
```
public final void setColorType(XmpColorType value)
```

Sets the type of color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorType | The color type. |

### XmpColorantCmyk
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolorantcmyk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantCmyk extends XmpColorantBase
```

Represents the CMYK Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantCmyk() | Initializes a new instance of the  XmpColorantCmyk  class. |
| XmpColorantCmyk(double cyan, double magenta, double yellow, double black) | Initializes a new instance of the  XmpColorantCmyk  class. |
#### Fields

| Field | Description |
| --- | --- |
| ColorValueMax | Color max value in CMYK colorant. |
| ColorValueMin | Color min value in CMYK colorant. |
#### Methods

| Method | Description |
| --- | --- |
| getBlack() | Gets the black component. |
| setBlack(Double value) | Sets the black component. |
| getCyan() | Gets the cyan component. |
| setCyan(Double value) | Sets the cyan component. |
| getMagenta() | Gets the magenta component. |
| setMagenta(Double value) | Sets the magenta component. |
| getYellow() | Gets the yellow component. |
| setYellow(Double value) | Sets the yellow component. |
##### XmpColorantCmyk()
```
public XmpColorantCmyk()
```

Initializes a new instance of the  XmpColorantCmyk  class.

##### XmpColorantCmyk(double cyan, double magenta, double yellow, double black)
```
public XmpColorantCmyk(double cyan, double magenta, double yellow, double black)
```

Initializes a new instance of the  XmpColorantCmyk  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cyan | double | Cyan component. |
| magenta | double | Magenta component. |
| yellow | double | Yellow component. |
| black | double | Black component. |

##### ColorValueMax
```
public static final double ColorValueMax
```

Color max value in CMYK colorant.

##### ColorValueMin
```
public static final double ColorValueMin
```

Color min value in CMYK colorant.

##### getBlack()
```
public final Double getBlack()
```

Gets the black component.

**Returns:**
java.lang.Double - The black value.
##### setBlack(Double value)
```
public final void setBlack(Double value)
```

Sets the black component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The black value. |

##### getCyan()
```
public final Double getCyan()
```

Gets the cyan component.

**Returns:**
java.lang.Double - The cyan value.
##### setCyan(Double value)
```
public final void setCyan(Double value)
```

Sets the cyan component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The cyan value. |

##### getMagenta()
```
public final Double getMagenta()
```

Gets the magenta component.

**Returns:**
java.lang.Double - The magenta value.
##### setMagenta(Double value)
```
public final void setMagenta(Double value)
```

Sets the magenta component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The magenta value. |

##### getYellow()
```
public final Double getYellow()
```

Gets the yellow component.

**Returns:**
java.lang.Double - The yellow value.
##### setYellow(Double value)
```
public final void setYellow(Double value)
```

Sets the yellow component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The yellow value. |

### XmpColorantColorMode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolorantcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpColorantColorMode extends Enum<XmpColorantColorMode> implements IEnumValue
```

Represents color mode in  XmpColorantBase .
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The color mode is undefined. |
| Cmyk | CMYK color mode. |
| Rgb | RGB color mode. |
| Lab | LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final XmpColorantColorMode Undefined
```

The color mode is undefined.

##### Cmyk
```
public static final XmpColorantColorMode Cmyk
```

CMYK color mode.

##### Rgb
```
public static final XmpColorantColorMode Rgb
```

RGB color mode.

##### Lab
```
public static final XmpColorantColorMode Lab
```

LAB color mode.

##### values()
```
public static XmpColorantColorMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpColorantColorMode[]
##### valueOf(String name)
```
public static XmpColorantColorMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpColorantColorMode
##### getByRawValue(int rawValue)
```
public static XmpColorantColorMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpColorantColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpColorantLab
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolorantlab.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantLab extends XmpColorantBase
```

Represents the LAB Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantLab() | Initializes a new instance of the  XmpColorantLab  class. |
| XmpColorantLab(byte a, byte b, double l) | Initializes a new instance of the  XmpColorantLab  class. |
#### Fields

| Field | Description |
| --- | --- |
| MinL | Component L min value. |
| MaxL | Component L max value. |
#### Methods

| Method | Description |
| --- | --- |
| getA() | Gets the A component. |
| setA(Byte value) | Sets the A component. |
| getB() | Gets the B component. |
| setB(Byte value) | Sets the B component. |
| getL() | Gets the L component. |
| setL(Double value) | Sets the L component. |
##### XmpColorantLab()
```
public XmpColorantLab()
```

Initializes a new instance of the  XmpColorantLab  class.

##### XmpColorantLab(byte a, byte b, double l)
```
public XmpColorantLab(byte a, byte b, double l)
```

Initializes a new instance of the  XmpColorantLab  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | byte | A component. |
| b | byte | B component. |
| l | double | L component. |

##### MinL
```
public static final double MinL
```

Component L min value.

##### MaxL
```
public static final double MaxL
```

Component L max value.

##### getA()
```
public final Byte getA()
```

Gets the A component.

**Returns:**
java.lang.Byte - The A component.
##### setA(Byte value)
```
public final void setA(Byte value)
```

Sets the A component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte | The A component. |

##### getB()
```
public final Byte getB()
```

Gets the B component.

**Returns:**
java.lang.Byte - The B component.
##### setB(Byte value)
```
public final void setB(Byte value)
```

Sets the B component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte | The B component. |

##### getL()
```
public final Double getL()
```

Gets the L component.

**Returns:**
java.lang.Double - The L component.
##### setL(Double value)
```
public final void setL(Double value)
```

Sets the L component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The L component. |

### XmpColorantRgb
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolorantrgb.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantRgb extends XmpColorantBase
```

Represents the RGB Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantRgb() | Initializes a new instance of the  XmpColorantRgb  class. |
| XmpColorantRgb(int red, int green, int blue) | Initializes a new instance of the  XmpColorantRgb  class. |
#### Methods

| Method | Description |
| --- | --- |
| getRed() | Gets the red component. |
| setRed(Integer value) | Sets the red component. |
| getGreen() | Gets the green value. |
| setGreen(Integer value) | Sets the green value. |
| getBlue() | Gets the blue component. |
| setBlue(Integer value) | Sets the blue component. |
##### XmpColorantRgb()
```
public XmpColorantRgb()
```

Initializes a new instance of the  XmpColorantRgb  class.

##### XmpColorantRgb(int red, int green, int blue)
```
public XmpColorantRgb(int red, int green, int blue)
```

Initializes a new instance of the  XmpColorantRgb  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | Red component. |
| green | int | Green component. |
| blue | int | Blue component. |

##### getRed()
```
public final Integer getRed()
```

Gets the red component.

**Returns:**
java.lang.Integer - The red component.
##### setRed(Integer value)
```
public final void setRed(Integer value)
```

Sets the red component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red component. |

##### getGreen()
```
public final Integer getGreen()
```

Gets the green value.

**Returns:**
java.lang.Integer - The green component.
##### setGreen(Integer value)
```
public final void setGreen(Integer value)
```

Sets the green value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green component. |

##### getBlue()
```
public final Integer getBlue()
```

Gets the blue component.

**Returns:**
java.lang.Integer - The blue component.
##### setBlue(Integer value)
```
public final void setBlue(Integer value)
```

Sets the blue component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue component. |

### XmpColorType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcolortype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpColorType extends Enum<XmpColorType> implements IEnumValue
```

Type of color in  XmpColorantBase .
#### Fields

| Field | Description |
| --- | --- |
| Process | The Process color type. |
| Spot | The Spot color type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Process
```
public static final XmpColorType Process
```

The Process color type.

##### Spot
```
public static final XmpColorType Spot
```

The Spot color type.

##### values()
```
public static XmpColorType[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpColorType[]
##### valueOf(String name)
```
public static XmpColorType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpColorType
##### getByRawValue(int rawValue)
```
public static XmpColorType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpColorType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpComplexType
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcomplextype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer
```
public class XmpComplexType extends XmpMetadataContainer
```

Represents base abstraction for XMP Complex value type.

See more: XMP Specification Part 2, Chapter 1.2.2
#### Methods

| Method | Description |
| --- | --- |
| getPrefixes() | Gets the namespace prefixes that are used in the  XmpComplexType  instance. |
| getNamespaceUris() | Gets the namespace URIs that are used in the  XmpComplexType  instance. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
| toString() | Returns a  String  that represents this instance. |
| getNamespaceUri(String prefix) | Gets the namespace URI associated with the specified prefix. |
##### getPrefixes()
```
public final String[] getPrefixes()
```

Gets the namespace prefixes that are used in the  XmpComplexType  instance.

**Returns:**
java.lang.String[] - The namespace prefixes.
##### getNamespaceUris()
```
public final String[] getNamespaceUris()
```

Gets the namespace URIs that are used in the  XmpComplexType  instance.

**Returns:**
java.lang.String[] - The namespace URIs.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.
##### toString()
```
public String toString()
```

Returns a  String  that represents this instance.

**Returns:**
java.lang.String - A  String  that represents this instance.
##### getNamespaceUri(String prefix)
```
public final String getNamespaceUri(String prefix)
```

Gets the namespace URI associated with the specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| prefix | java.lang.String | The prefix of the namespace to get. |

**Returns:**
java.lang.String - The associated namespace URI if the prefix is registered; otherwise, null.

### XmpComplexTypeValue
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcomplextypevalue.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpComplexTypeValue extends XmpValueBase
```

Represents an XMP value containing a complex type instance.
#### Methods

| Method | Description |
| --- | --- |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpCropUnit
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpcropunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpCropUnit extends Enum<XmpCropUnit> implements IEnumValue
```

Represent a unit for CropWidth and CropHeight in  XmpCameraRawPackage .
#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels units. |
| Inches | Inches units. |
| Cm | Centimeters units. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Pixels
```
public static final XmpCropUnit Pixels
```

Pixels units.

##### Inches
```
public static final XmpCropUnit Inches
```

Inches units.

##### Cm
```
public static final XmpCropUnit Cm
```

Centimeters units.

##### values()
```
public static XmpCropUnit[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpCropUnit[]
##### valueOf(String name)
```
public static XmpCropUnit valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpCropUnit
##### getByRawValue(int rawValue)
```
public static XmpCropUnit getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpCropUnit
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpDate
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpdate.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpDate extends XmpValueBase
```

Represents Date in XMP packet.

A date-time value is represented using a subset of the formats as defined in Date and Time Formats: YYYY YYYY-MM YYYY-MM-DD YYYY-MM-DDThh:mmTZD YYYY-MM-DDThh:mm:ssTZD YYYY-MM-DDThh:mm:ss.sTZD
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDate(Date dateTime) | Initializes a new instance of the  XmpDate  class. |
| XmpDate(String dateString) | Initializes a new instance of the  XmpDate  class. |
#### Fields

| Field | Description |
| --- | --- |
| Iso8601Format | The ISO 8601 (roundtrip) format string. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getFormat() | Gets format string for current value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpDate(Date dateTime)
```
public XmpDate(Date dateTime)
```

Initializes a new instance of the  XmpDate  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateTime | java.util.Date |  DateTime  value. |

##### XmpDate(String dateString)
```
public XmpDate(String dateString)
```

Initializes a new instance of the  XmpDate  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateString | java.lang.String | Date in string representation. |

##### Iso8601Format
```
public static final String Iso8601Format
```

The ISO 8601 (roundtrip) format string.

See more: https://en.wikipedia.org/wiki/ISO\_8601.

##### getValue()
```
public final Date getValue()
```

Gets the value.

**Returns:**
java.util.Date - DateTime value.
##### getFormat()
```
public final String getFormat()
```

Gets format string for current value.

**Returns:**
java.lang.String - XMP date format string.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpDimensions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpdimensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpDimensions extends XmpComplexType
```

Containing dimensions for a drawn object.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDimensions() | Initializes a new instance of the  XmpDimensions  class. |
| XmpDimensions(double width, double height) | Initializes a new instance of the  XmpDimensions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width. |
| setWidth(Double value) | Sets the width. |
| getHeight() | Gets the height. |
| setHeight(Double value) | Sets the height. |
| getUnits() | Gets the units. |
| setUnits(String value) | Sets the units. |
##### XmpDimensions()
```
public XmpDimensions()
```

Initializes a new instance of the  XmpDimensions  class.

##### XmpDimensions(double width, double height)
```
public XmpDimensions(double width, double height)
```

Initializes a new instance of the  XmpDimensions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | double | The width. |
| height | double | The height. |

##### getWidth()
```
public final Double getWidth()
```

Gets the width.

**Returns:**
java.lang.Double - The width.
##### setWidth(Double value)
```
public final void setWidth(Double value)
```

Sets the width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The width. |

##### getHeight()
```
public final Double getHeight()
```

Gets the height.

**Returns:**
java.lang.Double - The height.
##### setHeight(Double value)
```
public final void setHeight(Double value)
```

Sets the height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The height. |

##### getUnits()
```
public final String getUnits()
```

Gets the units.

**Returns:**
java.lang.String - The units.
##### setUnits(String value)
```
public final void setUnits(String value)
```

Sets the units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The units. |

### XmpDublinCorePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpdublincorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpDublinCorePackage extends XmpPackage
```

Represents the Dublin Core scheme.

For more information see: http://dublincore.org/documents/usageguide/elements.shtml.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDublinCorePackage() | Initializes a new instance of the  XmpDublinCorePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getContributors() | Gets an array of the contributors. |
| setContributors(String[] value) | Sets an array of the contributors. |
| getCoverage() | Gets the extent or scope of the resource. |
| setCoverage(String value) | Sets the extent or scope of the resource. |
| getCreators() | Gets an array of the creators. |
| setCreators(String[] value) | Sets an array of the creators. |
| getDates() | Gets an array of dates associated with an event in the life cycle of the resource. |
| setDates(Date[] value) | Sets an array of dates associated with an event in the life cycle of the resource. |
| getDescriptions() | Gets an array of textual descriptions of the content of the resource, given in various languages. |
| setDescriptions(XmpLangAlt value) | Sets an array of textual descriptions of the content of the resource, given in various languages. |
| getFormat() | Gets the MIME type of the resource. |
| setFormat(String value) | Sets the MIME type of the resource. |
| getIdentifier() | Gets a string value representing an unambiguous reference to the resource within a given context. |
| setIdentifier(String value) | Sets a string value representing an unambiguous reference to the resource within a given context. |
| getLanguages() | Gets an array of languages used in the content of the resource. |
| setLanguages(String[] value) | Sets an array of languages used in the content of the resource. |
| getPublishers() | Gets an array of publishers made the resource available. |
| setPublishers(String[] value) | Sets an array of publishers made the resource available. |
| getRelations() | Gets an array of the related resources. |
| setRelations(String[] value) | Sets an array of the related resources. |
| getRights() | Gets an array of the informal rights statements, given in various languages. |
| setRights(XmpLangAlt value) | Sets an array of the informal rights statements, given in various languages. |
| getSource() | Gets the related resource from which the described resource is derived. |
| setSource(String value) | Sets the related resource from which the described resource is derived. |
| getSubjects() | Gets an array of descriptive phrases or keywords that specify the content of the resource. |
| setSubjects(String[] value) | Sets an array of descriptive phrases or keywords that specify the content of the resource. |
| getTitles() | Gets the title or name of the resource, given in various languages. |
| setTitles(XmpLangAlt value) | Sets the title or name of the resource, given in various languages. |
| getTypes() | Gets an array of string values representing the nature or genre of the resource. |
| setTypes(String[] value) | Sets an array of string values representing the nature or genre of the resource. |
| setContributor(String contributor) | Sets a single contributor of the resource. |
| setCreator(String creator) | Sets a single creator of the resource. |
| setDate(Date date) | Sets a single date associated with the resource. |
| setDescription(String description) | Sets the resource description, given in a single laguage. |
| setLanguage(String language) | Sets a single language associated with the resource. |
| setPublisher(String publisher) | Sets a single publisher of the resource. |
| setRelation(String relation) | Sets a single related resource. |
| setRights(String rights) | Sets the resource rights, given in a single laguage. |
| setSubject(String subject) | Sets a single subject of the resource. |
| setTitle(String title) | Sets the resource title, given in a single laguage. |
| setType(String type) | Sets a single type of the resource. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpDublinCorePackage()
```
public XmpDublinCorePackage()
```

Initializes a new instance of the  XmpDublinCorePackage  class.

##### getContributors()
```
public final String[] getContributors()
```

Gets an array of the contributors.

**Returns:**
java.lang.String[] - An array of the contributors.

These contributors should not include those listed in dc:creator.
##### setContributors(String[] value)
```
public final void setContributors(String[] value)
```

Sets an array of the contributors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the contributors.

These contributors should not include those listed in dc:creator. |

##### getCoverage()
```
public final String getCoverage()
```

Gets the extent or scope of the resource.

**Returns:**
java.lang.String - The extent or scope of the resource.
##### setCoverage(String value)
```
public final void setCoverage(String value)
```

Sets the extent or scope of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The extent or scope of the resource. |

##### getCreators()
```
public final String[] getCreators()
```

Gets an array of the creators.

**Returns:**
java.lang.String[] - An array of the creators.

Entities should be listed in order of decreasing precedence, if such order is significant. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity.
##### setCreators(String[] value)
```
public final void setCreators(String[] value)
```

Sets an array of the creators.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the creators.

Entities should be listed in order of decreasing precedence, if such order is significant. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity. |

##### getDates()
```
public final Date[] getDates()
```

Gets an array of dates associated with an event in the life cycle of the resource.

**Returns:**
java.util.Date[] - A point or period of time associated with an event in the life cycle of the resource.
##### setDates(Date[] value)
```
public final void setDates(Date[] value)
```

Sets an array of dates associated with an event in the life cycle of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date[] | A point or period of time associated with an event in the life cycle of the resource. |

##### getDescriptions()
```
public final XmpLangAlt getDescriptions()
```

Gets an array of textual descriptions of the content of the resource, given in various languages.

**Returns:**
XmpLangAlt - An array of textual descriptions of the content of the resource, given in various languages.
##### setDescriptions(XmpLangAlt value)
```
public final void setDescriptions(XmpLangAlt value)
```

Sets an array of textual descriptions of the content of the resource, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | An array of textual descriptions of the content of the resource, given in various languages. |

##### getFormat()
```
public final String getFormat()
```

Gets the MIME type of the resource.

**Returns:**
java.lang.String - The MIME type of the resource.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the MIME type of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The MIME type of the resource. |

##### getIdentifier()
```
public final String getIdentifier()
```

Gets a string value representing an unambiguous reference to the resource within a given context.

**Returns:**
java.lang.String - A string value representing an unambiguous reference to the resource within a given context.

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
##### setIdentifier(String value)
```
public final void setIdentifier(String value)
```

Sets a string value representing an unambiguous reference to the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A string value representing an unambiguous reference to the resource within a given context.

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system. |

##### getLanguages()
```
public final String[] getLanguages()
```

Gets an array of languages used in the content of the resource.

**Returns:**
java.lang.String[] - An array of languages used in the content of the resource.
##### setLanguages(String[] value)
```
public final void setLanguages(String[] value)
```

Sets an array of languages used in the content of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of languages used in the content of the resource. |

##### getPublishers()
```
public final String[] getPublishers()
```

Gets an array of publishers made the resource available.

**Returns:**
java.lang.String[] - An array of publishers made the resource available.

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity.
##### setPublishers(String[] value)
```
public final void setPublishers(String[] value)
```

Sets an array of publishers made the resource available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of publishers made the resource available.

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity. |

##### getRelations()
```
public final String[] getRelations()
```

Gets an array of the related resources.

**Returns:**
java.lang.String[] - An array of the related resources.

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### setRelations(String[] value)
```
public final void setRelations(String[] value)
```

Sets an array of the related resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the related resources.

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. |

##### getRights()
```
public final XmpLangAlt getRights()
```

Gets an array of the informal rights statements, given in various languages.

**Returns:**
XmpLangAlt - An array of the informal rights statements, given in various languages.

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.
##### setRights(XmpLangAlt value)
```
public final void setRights(XmpLangAlt value)
```

Sets an array of the informal rights statements, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | An array of the informal rights statements, given in various languages.

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights. |

##### getSource()
```
public final String getSource()
```

Gets the related resource from which the described resource is derived.

**Returns:**
java.lang.String - The related resource from which the described resource is derived.

The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets the related resource from which the described resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The related resource from which the described resource is derived.

The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. |

##### getSubjects()
```
public final String[] getSubjects()
```

Gets an array of descriptive phrases or keywords that specify the content of the resource.

**Returns:**
java.lang.String[] - An array of descriptive phrases or keywords that specify the content of the resource.
##### setSubjects(String[] value)
```
public final void setSubjects(String[] value)
```

Sets an array of descriptive phrases or keywords that specify the content of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of descriptive phrases or keywords that specify the content of the resource. |

##### getTitles()
```
public final XmpLangAlt getTitles()
```

Gets the title or name of the resource, given in various languages.

**Returns:**
XmpLangAlt - The title or name of the resource, given in various languages.
##### setTitles(XmpLangAlt value)
```
public final void setTitles(XmpLangAlt value)
```

Sets the title or name of the resource, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The title or name of the resource, given in various languages. |

##### getTypes()
```
public final String[] getTypes()
```

Gets an array of string values representing the nature or genre of the resource.

**Returns:**
java.lang.String[] - An array of string values representing the nature or genre of the resource.
##### setTypes(String[] value)
```
public final void setTypes(String[] value)
```

Sets an array of string values representing the nature or genre of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of string values representing the nature or genre of the resource. |

##### setContributor(String contributor)
```
public final void setContributor(String contributor)
```

Sets a single contributor of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contributor | java.lang.String | The contributor to set. |

##### setCreator(String creator)
```
public final void setCreator(String creator)
```

Sets a single creator of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| creator | java.lang.String | The creator to set. |

##### setDate(Date date)
```
public final void setDate(Date date)
```

Sets a single date associated with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| date | java.util.Date | The date to set. |

##### setDescription(String description)
```
public final void setDescription(String description)
```

Sets the resource description, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | The description to set. |

##### setLanguage(String language)
```
public final void setLanguage(String language)
```

Sets a single language associated with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language to set. |

##### setPublisher(String publisher)
```
public final void setPublisher(String publisher)
```

Sets a single publisher of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publisher | java.lang.String | The publisher to set. |

##### setRelation(String relation)
```
public final void setRelation(String relation)
```

Sets a single related resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | java.lang.String | The relation to set. |

##### setRights(String rights)
```
public final void setRights(String rights)
```

Sets the resource rights, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rights | java.lang.String | The rights statements to set. |

##### setSubject(String subject)
```
public final void setSubject(String subject)
```

Sets a single subject of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subject | java.lang.String | The subject to set. |

##### setTitle(String title)
```
public final void setTitle(String title)
```

Sets the resource title, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | The title to set. |

##### setType(String type)
```
public final void setType(String type)
```

Sets a single type of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.String | The type to set. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpDynamicMediaPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpdynamicmediapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpDynamicMediaPackage extends XmpPackage
```

Represents XMP Dynamic Media namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDynamicMediaPackage() | Initializes a new instance of the  XmpDynamicMediaPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAbsPeakAudioFilePath() | Gets the absolute path to the file\\u2019s peak audio file. |
| setAbsPeakAudioFilePath(String value) | Sets the absolute path to the file\\u2019s peak audio file. |
| getAlbum() | Gets the name of the album. |
| setAlbum(String value) | Sets the name of the album. |
| getAltTapeName() | Gets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| setAltTapeName(String value) | Sets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| getAltTimecode() | Gets the timecode set by the user. |
| setAltTimecode(XmpTimecode value) | Sets the timecode set by the user. |
| getArtist() | Gets the name of the artist or artists. |
| setArtist(String value) | Sets the name of the artist or artists. |
| getAudioChannelType() | Gets the audio channel type. |
| setAudioChannelType(String value) | Sets the audio channel type. |
| getAudioCompressor() | Gets the audio compression used. |
| setAudioCompressor(String value) | Sets the audio compression used. |
| getAudioSampleRate() | Gets the audio sample rate. |
| setAudioSampleRate(Integer value) | Sets the audio sample rate. |
| getAudioSampleType() | Gets the audio sample type. |
| setAudioSampleType(String value) | Sets the audio sample type. |
| getCameraAngle() | Gets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| setCameraAngle(String value) | Sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| getCameraLabel() | Gets the description of the camera used for a shoot. |
| setCameraLabel(String value) | Sets the description of the camera used for a shoot. |
| getCameraModel() | Gets the make and model of the camera used for a shoot. |
| setCameraModel(String value) | Sets the make and model of the camera used for a shoot. |
| getCameraMove() | Gets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| setCameraMove(String value) | Sets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| getClient() | Gets the client for the job of which this shot or take is a part. |
| setClient(String value) | Sets the client for the job of which this shot or take is a part. |
| getComment() | Gets the user\\u2019s comments. |
| setComment(String value) | Sets the user\\u2019s comments. |
| getComposer() | Gets the composer\\u2019s names. |
| setComposer(String value) | Sets the composer\\u2019s names. |
| getDirector() | Gets the director of the scene. |
| setDirector(String value) | Sets the director of the scene. |
| getDirectorPhotography() | Gets the director of photography for the scene. |
| setDirectorPhotography(String value) | Sets the director of photography for the scene. |
| getDuration() | Gets the duration of the media file. |
| setDuration(XmpTime value) | Sets the duration of the media file. |
| getEngineer() | Gets the engineer's names. |
| setEngineer(String value) | Sets the engineer's names. |
| getFileDataRate() | Gets the file data rate in megabytes per second. |
| setFileDataRate(XmpRational value) | Sets the file data rate in megabytes per second. |
| getGenre() | Gets the name of the genres. |
| setGenre(String value) | Sets the name of the genres. |
| getGood() | Gets a value indicating whether the shot is a keeper. |
| setGood(Boolean value) | Sets a value indicating whether the shot is a keeper. |
| getInstrument() | Gets the musical instruments. |
| setInstrument(String value) | Sets the musical instruments. |
| getIntroTime() | Gets the duration of lead time for queuing music. |
| setIntroTime(XmpTime value) | Sets the duration of lead time for queuing music. |
| getKey() | Gets the audio\\u2019s musical key. |
| setKey(String value) | Sets the audio\\u2019s musical key. |
| getLogComment() | Gets the user\\u2019s log comments. |
| setLogComment(String value) | Sets the user\\u2019s log comments. |
| getLoop() | Gets a value indicating whether the clip can be looped seamlessly. |
| setLoop(Boolean value) | Sets a value indicating whether the clip can be looped seamlessly. |
| getNumberOfBeats() | Gets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| setNumberOfBeats(Double value) | Sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| getOutCue() | Gets the time at which to fade out. |
| setOutCue(XmpTime value) | Sets the time at which to fade out. |
| getProjectName() | Gets the name of the project of which this file is a part. |
| setProjectName(String value) | Sets the name of the project of which this file is a part. |
| getRelativeTimestamp() | Gets the start time of the media inside the audio project. |
| setRelativeTimestamp(XmpTime value) | Sets the start time of the media inside the audio project. |
| getReleaseDate() | Gets the date the title was released. |
| setReleaseDate(Date value) | Sets the date the title was released. |
| getShotDate() | Gets the date and time when the video was shot. |
| setShotDate(Date value) | Sets the date and time when the video was shot. |
| getStartTimecode() | Gets the timecode of the first frame of video in the file, as obtained from the device control. |
| setStartTimecode(XmpTimecode value) | Sets the timecode of the first frame of video in the file, as obtained from the device control. |
| getTakeNumber() | Gets a numeric value indicating the absolute number of a take. |
| setTakeNumber(Integer value) | Sets a numeric value indicating the absolute number of a take. |
| getTempo() | Gets the audio\\u2019s tempo. |
| setTempo(Double value) | Sets the audio\\u2019s tempo. |
| getTrackNumber() | Gets a numeric value indicating the order of the audio file within its original recording. |
| setTrackNumber(Integer value) | Sets a numeric value indicating the order of the audio file within its original recording. |
| getVideoAlphaPremultipleColor() | Gets the timecode of the first frame of video in the file, as obtained from the device control. |
| setVideoAlphaPremultipleColor(XmpColorantBase value) | Sets the timecode of the first frame of video in the file, as obtained from the device control. |
| getVideoAlphaUnityIsTransparent() | Gets a value indicating whether the unity is clear. |
| setVideoAlphaUnityIsTransparent(Boolean value) | Sets a value indicating whether the unity is clear. |
| getVideoFrameRate() | Gets the video frame rate. |
| setVideoFrameRate(Double value) | Sets the video frame rate. |
| getVideoFrameSize() | Gets the frame size. |
| setVideoFrameSize(XmpDimensions value) | Sets the frame size. |
| getVideoPixelAspectRatio() | Gets the aspect ratio, expressed as wd/ht. |
| setVideoPixelAspectRatio(XmpRational value) | Sets the aspect ratio, expressed as wd/ht. |
| getPartOfCompilation() | Gets a value indicating whether the resource is a part of compilation. |
| setPartOfCompilation(Boolean value) | Sets a value indicating whether the resource is a part of compilation. |
| set(String name, String value) | Sets string property. |
| set(String name, XmpComplexType value) | Sets the value inherited from  XmpComplexType  . |
| setAudioChannelType(XmpAudioChannelType audioChannelType) | Sets the audio channel type. |
| setAudioSampleType(XmpAudioSampleType audioSampleType) | Sets the audio sample type. |
##### XmpDynamicMediaPackage()
```
public XmpDynamicMediaPackage()
```

Initializes a new instance of the  XmpDynamicMediaPackage  class.

##### getAbsPeakAudioFilePath()
```
public final String getAbsPeakAudioFilePath()
```

Gets the absolute path to the file\\u2019s peak audio file.

**Returns:**
java.lang.String - The absolute path to the file\\u2019s peak audio file. If empty, no peak file exists.
##### setAbsPeakAudioFilePath(String value)
```
public final void setAbsPeakAudioFilePath(String value)
```

Sets the absolute path to the file\\u2019s peak audio file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The absolute path to the file\\u2019s peak audio file. If empty, no peak file exists. |

##### getAlbum()
```
public final String getAlbum()
```

Gets the name of the album.

**Returns:**
java.lang.String - The name of the album.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the name of the album.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the album. |

##### getAltTapeName()
```
public final String getAltTapeName()
```

Gets the alternative tape name, set via the project window or timecode dialog in Premiere.

**Returns:**
java.lang.String - The alternative tape name, set via the project window or timecode dialog in Premiere.
##### setAltTapeName(String value)
```
public final void setAltTapeName(String value)
```

Sets the alternative tape name, set via the project window or timecode dialog in Premiere.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The alternative tape name, set via the project window or timecode dialog in Premiere. |

##### getAltTimecode()
```
public final XmpTimecode getAltTimecode()
```

Gets the timecode set by the user.

**Returns:**
XmpTimecode - The timecode set by the user. When specified, it is used instead of the startTimecode.
##### setAltTimecode(XmpTimecode value)
```
public final void setAltTimecode(XmpTimecode value)
```

Sets the timecode set by the user.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTimecode | The timecode set by the user. When specified, it is used instead of the startTimecode. |

##### getArtist()
```
public final String getArtist()
```

Gets the name of the artist or artists.

**Returns:**
java.lang.String - The name of the artist or artists.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the name of the artist or artists.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the artist or artists. |

##### getAudioChannelType()
```
public final String getAudioChannelType()
```

Gets the audio channel type.

**Returns:**
java.lang.String - The audio channel type. One of: Mono, Stereo, 5.1, 7.1, 16 Channel, Other
##### setAudioChannelType(String value)
```
public final void setAudioChannelType(String value)
```

Sets the audio channel type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio channel type. One of: Mono, Stereo, 5.1, 7.1, 16 Channel, Other |

##### getAudioCompressor()
```
public final String getAudioCompressor()
```

Gets the audio compression used.

**Returns:**
java.lang.String - The audio compression used. For example, MP3.
##### setAudioCompressor(String value)
```
public final void setAudioCompressor(String value)
```

Sets the audio compression used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio compression used. For example, MP3. |

##### getAudioSampleRate()
```
public final Integer getAudioSampleRate()
```

Gets the audio sample rate.

**Returns:**
java.lang.Integer - The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000.
##### setAudioSampleRate(Integer value)
```
public final void setAudioSampleRate(Integer value)
```

Sets the audio sample rate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000. |

##### getAudioSampleType()
```
public final String getAudioSampleType()
```

Gets the audio sample type.

**Returns:**
java.lang.String - The audio sample type. One of: 8Int, 16Int, 24Int, 32Int, 32Float, Compressed, Packed, Other.
##### setAudioSampleType(String value)
```
public final void setAudioSampleType(String value)
```

Sets the audio sample type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio sample type. One of: 8Int, 16Int, 24Int, 32Int, 32Float, Compressed, Packed, Other. |

##### getCameraAngle()
```
public final String getCameraAngle()
```

Gets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.

**Returns:**
java.lang.String - The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. Predefined values include: Low Angle, Eye Level, High Angle, Overhead Shot, Birds Eye Shot, Dutch Angle, POV, Over the Shoulder, Reaction Shot.
##### setCameraAngle(String value)
```
public final void setCameraAngle(String value)
```

Sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. Predefined values include: Low Angle, Eye Level, High Angle, Overhead Shot, Birds Eye Shot, Dutch Angle, POV, Over the Shoulder, Reaction Shot. |

##### getCameraLabel()
```
public final String getCameraLabel()
```

Gets the description of the camera used for a shoot.

**Returns:**
java.lang.String - The description of the camera used for a shoot. Can be any string, but is usually simply a number, for example "1", "2", or more explicitly "Camera 1".
##### setCameraLabel(String value)
```
public final void setCameraLabel(String value)
```

Sets the description of the camera used for a shoot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The description of the camera used for a shoot. Can be any string, but is usually simply a number, for example "1", "2", or more explicitly "Camera 1". |

##### getCameraModel()
```
public final String getCameraModel()
```

Gets the make and model of the camera used for a shoot.

**Returns:**
java.lang.String - The make and model of the camera used for a shoot.
##### setCameraModel(String value)
```
public final void setCameraModel(String value)
```

Sets the make and model of the camera used for a shoot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The make and model of the camera used for a shoot. |

##### getCameraMove()
```
public final String getCameraMove()
```

Gets the movement of the camera during the shot, from a fixed set of industry standard terminology.

**Returns:**
java.lang.String - The movement of the camera during the shot, from a fixed set of industry standard terminology. Predefined values include: Aerial, Boom Up, Boom Down, Crane Up, Crane Down, Dolly In, Dolly Out, Pan Left, Pan Right, Pedestal Up, Pedestal Down, Tilt Up, Tilt Down, Tracking, Truck Left, Truck Right, Zoom In, Zoom Out.
##### setCameraMove(String value)
```
public final void setCameraMove(String value)
```

Sets the movement of the camera during the shot, from a fixed set of industry standard terminology.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The movement of the camera during the shot, from a fixed set of industry standard terminology. Predefined values include: Aerial, Boom Up, Boom Down, Crane Up, Crane Down, Dolly In, Dolly Out, Pan Left, Pan Right, Pedestal Up, Pedestal Down, Tilt Up, Tilt Down, Tracking, Truck Left, Truck Right, Zoom In, Zoom Out. |

##### getClient()
```
public final String getClient()
```

Gets the client for the job of which this shot or take is a part.

**Returns:**
java.lang.String - The client for the job of which this shot or take is a part.
##### setClient(String value)
```
public final void setClient(String value)
```

Sets the client for the job of which this shot or take is a part.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The client for the job of which this shot or take is a part. |

##### getComment()
```
public final String getComment()
```

Gets the user\\u2019s comments.

**Returns:**
java.lang.String - The user\\u2019s comments.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the user\\u2019s comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user\\u2019s comments. |

##### getComposer()
```
public final String getComposer()
```

Gets the composer\\u2019s names.

**Returns:**
java.lang.String - The composer\\u2019s names.
##### setComposer(String value)
```
public final void setComposer(String value)
```

Sets the composer\\u2019s names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The composer\\u2019s names. |

##### getDirector()
```
public final String getDirector()
```

Gets the director of the scene.

**Returns:**
java.lang.String - The director of the scene.
##### setDirector(String value)
```
public final void setDirector(String value)
```

Sets the director of the scene.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The director of the scene. |

##### getDirectorPhotography()
```
public final String getDirectorPhotography()
```

Gets the director of photography for the scene.

**Returns:**
java.lang.String - The director of photography for the scene.
##### setDirectorPhotography(String value)
```
public final void setDirectorPhotography(String value)
```

Sets the director of photography for the scene.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The director of photography for the scene. |

##### getDuration()
```
public final XmpTime getDuration()
```

Gets the duration of the media file.

**Returns:**
XmpTime - The duration of the media file.
##### setDuration(XmpTime value)
```
public final void setDuration(XmpTime value)
```

Sets the duration of the media file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The duration of the media file. |

##### getEngineer()
```
public final String getEngineer()
```

Gets the engineer's names.

**Returns:**
java.lang.String - The engineer's names.
##### setEngineer(String value)
```
public final void setEngineer(String value)
```

Sets the engineer's names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The engineer's names. |

##### getFileDataRate()
```
public final XmpRational getFileDataRate()
```

Gets the file data rate in megabytes per second.

**Returns:**
XmpRational - The file data rate in megabytes per second. For example: "36/10" = 3.6 MB/sec.
##### setFileDataRate(XmpRational value)
```
public final void setFileDataRate(XmpRational value)
```

Sets the file data rate in megabytes per second.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The file data rate in megabytes per second. For example: "36/10" = 3.6 MB/sec. |

##### getGenre()
```
public final String getGenre()
```

Gets the name of the genres.

**Returns:**
java.lang.String - The name of the genres.
##### setGenre(String value)
```
public final void setGenre(String value)
```

Sets the name of the genres.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the genres. |

##### getGood()
```
public final Boolean getGood()
```

Gets a value indicating whether the shot is a keeper.

**Returns:**
java.lang.Boolean - A value indicating whether the shot is a keeper.
##### setGood(Boolean value)
```
public final void setGood(Boolean value)
```

Sets a value indicating whether the shot is a keeper.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the shot is a keeper. |

##### getInstrument()
```
public final String getInstrument()
```

Gets the musical instruments.

**Returns:**
java.lang.String - The musical instruments.
##### setInstrument(String value)
```
public final void setInstrument(String value)
```

Sets the musical instruments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The musical instruments. |

##### getIntroTime()
```
public final XmpTime getIntroTime()
```

Gets the duration of lead time for queuing music.

**Returns:**
XmpTime - The duration of lead time for queuing music.
##### setIntroTime(XmpTime value)
```
public final void setIntroTime(XmpTime value)
```

Sets the duration of lead time for queuing music.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The duration of lead time for queuing music. |

##### getKey()
```
public final String getKey()
```

Gets the audio\\u2019s musical key.

**Returns:**
java.lang.String - The audio\\u2019s musical key. One of: C, C\#, D, D\#, E, F, F\#, G, G\#, A, A\#, B.
##### setKey(String value)
```
public final void setKey(String value)
```

Sets the audio\\u2019s musical key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio\\u2019s musical key. One of: C, C\#, D, D\#, E, F, F\#, G, G\#, A, A\#, B. |

##### getLogComment()
```
public final String getLogComment()
```

Gets the user\\u2019s log comments.

**Returns:**
java.lang.String - The user\\u2019s log comments.
##### setLogComment(String value)
```
public final void setLogComment(String value)
```

Sets the user\\u2019s log comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user\\u2019s log comments. |

##### getLoop()
```
public final Boolean getLoop()
```

Gets a value indicating whether the clip can be looped seamlessly.

**Returns:**
java.lang.Boolean - A value indicating whether the clip can be looped seamlessly.
##### setLoop(Boolean value)
```
public final void setLoop(Boolean value)
```

Sets a value indicating whether the clip can be looped seamlessly.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the clip can be looped seamlessly. |

##### getNumberOfBeats()
```
public final Double getNumberOfBeats()
```

Gets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

**Returns:**
java.lang.Double - The total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.
##### setNumberOfBeats(Double value)
```
public final void setNumberOfBeats(Double value)
```

Sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |

##### getOutCue()
```
public final XmpTime getOutCue()
```

Gets the time at which to fade out.

**Returns:**
XmpTime - The time at which to fade out.
##### setOutCue(XmpTime value)
```
public final void setOutCue(XmpTime value)
```

Sets the time at which to fade out.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The time at which to fade out. |

##### getProjectName()
```
public final String getProjectName()
```

Gets the name of the project of which this file is a part.

**Returns:**
java.lang.String - The name of the project of which this file is a part.
##### setProjectName(String value)
```
public final void setProjectName(String value)
```

Sets the name of the project of which this file is a part.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the project of which this file is a part. |

##### getRelativeTimestamp()
```
public final XmpTime getRelativeTimestamp()
```

Gets the start time of the media inside the audio project.

**Returns:**
XmpTime - The start time of the media inside the audio project.
##### setRelativeTimestamp(XmpTime value)
```
public final void setRelativeTimestamp(XmpTime value)
```

Sets the start time of the media inside the audio project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The start time of the media inside the audio project. |

##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the date the title was released.

**Returns:**
java.util.Date - The date the title was released.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the date the title was released.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the title was released. |

##### getShotDate()
```
public final Date getShotDate()
```

Gets the date and time when the video was shot.

**Returns:**
java.util.Date - The date and time when the video was shot.
##### setShotDate(Date value)
```
public final void setShotDate(Date value)
```

Sets the date and time when the video was shot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date and time when the video was shot. |

##### getStartTimecode()
```
public final XmpTimecode getStartTimecode()
```

Gets the timecode of the first frame of video in the file, as obtained from the device control.

**Returns:**
XmpTimecode - The timecode of the first frame of video in the file, as obtained from the device control.
##### setStartTimecode(XmpTimecode value)
```
public final void setStartTimecode(XmpTimecode value)
```

Sets the timecode of the first frame of video in the file, as obtained from the device control.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTimecode | The timecode of the first frame of video in the file, as obtained from the device control. |

##### getTakeNumber()
```
public final Integer getTakeNumber()
```

Gets a numeric value indicating the absolute number of a take.

**Returns:**
java.lang.Integer - A numeric value indicating the absolute number of a take.
##### setTakeNumber(Integer value)
```
public final void setTakeNumber(Integer value)
```

Sets a numeric value indicating the absolute number of a take.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A numeric value indicating the absolute number of a take. |

##### getTempo()
```
public final Double getTempo()
```

Gets the audio\\u2019s tempo.

**Returns:**
java.lang.Double - The audio\\u2019s tempo.
##### setTempo(Double value)
```
public final void setTempo(Double value)
```

Sets the audio\\u2019s tempo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The audio\\u2019s tempo. |

##### getTrackNumber()
```
public final Integer getTrackNumber()
```

Gets a numeric value indicating the order of the audio file within its original recording.

**Returns:**
java.lang.Integer - A numeric value indicating the order of the audio file within its original recording.
##### setTrackNumber(Integer value)
```
public final void setTrackNumber(Integer value)
```

Sets a numeric value indicating the order of the audio file within its original recording.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A numeric value indicating the order of the audio file within its original recording. |

##### getVideoAlphaPremultipleColor()
```
public final XmpColorantBase getVideoAlphaPremultipleColor()
```

Gets the timecode of the first frame of video in the file, as obtained from the device control.

**Returns:**
XmpColorantBase - The timecode of the first frame of video in the file, as obtained from the device control.
##### setVideoAlphaPremultipleColor(XmpColorantBase value)
```
public final void setVideoAlphaPremultipleColor(XmpColorantBase value)
```

Sets the timecode of the first frame of video in the file, as obtained from the device control.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorantBase | The timecode of the first frame of video in the file, as obtained from the device control. |

##### getVideoAlphaUnityIsTransparent()
```
public final Boolean getVideoAlphaUnityIsTransparent()
```

Gets a value indicating whether the unity is clear.

**Returns:**
java.lang.Boolean -  true , if unity is clear; otherwise, it is opaque.
##### setVideoAlphaUnityIsTransparent(Boolean value)
```
public final void setVideoAlphaUnityIsTransparent(Boolean value)
```

Sets a value indicating whether the unity is clear.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true , if unity is clear; otherwise, it is opaque. |

##### getVideoFrameRate()
```
public final Double getVideoFrameRate()
```

Gets the video frame rate.

**Returns:**
java.lang.Double - The video frame rate.
##### setVideoFrameRate(Double value)
```
public final void setVideoFrameRate(Double value)
```

Sets the video frame rate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The video frame rate. |

##### getVideoFrameSize()
```
public final XmpDimensions getVideoFrameSize()
```

Gets the frame size.

**Returns:**
XmpDimensions - The frame size.
##### setVideoFrameSize(XmpDimensions value)
```
public final void setVideoFrameSize(XmpDimensions value)
```

Sets the frame size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDimensions | The frame size. |

##### getVideoPixelAspectRatio()
```
public final XmpRational getVideoPixelAspectRatio()
```

Gets the aspect ratio, expressed as wd/ht.

**Returns:**
XmpRational - The aspect ratio, expressed as wd/ht.
##### setVideoPixelAspectRatio(XmpRational value)
```
public final void setVideoPixelAspectRatio(XmpRational value)
```

Sets the aspect ratio, expressed as wd/ht.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The aspect ratio, expressed as wd/ht. |

##### getPartOfCompilation()
```
public final Boolean getPartOfCompilation()
```

Gets a value indicating whether the resource is a part of compilation.

**Returns:**
java.lang.Boolean - A value indicating whether the resource is a part of compilation.
##### setPartOfCompilation(Boolean value)
```
public final void setPartOfCompilation(Boolean value)
```

Sets a value indicating whether the resource is a part of compilation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the resource is a part of compilation. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpComplexType value)
```
public void set(String name, XmpComplexType value)
```

Sets the value inherited from  XmpComplexType  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

##### setAudioChannelType(XmpAudioChannelType audioChannelType)
```
public final void setAudioChannelType(XmpAudioChannelType audioChannelType)
```

Sets the audio channel type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioChannelType | XmpAudioChannelType | The audio channel type. |

##### setAudioSampleType(XmpAudioSampleType audioSampleType)
```
public final void setAudioSampleType(XmpAudioSampleType audioSampleType)
```

Sets the audio sample type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioSampleType | XmpAudioSampleType | The audio sample type. |

### XmpElementBase
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpelementbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class XmpElementBase extends CustomPackage
```

Represents base XMP element that contains attributes.
#### Methods

| Method | Description |
| --- | --- |
| setAttribute(String attribute, String value) | Adds the attribute. |
| clearAttributes() | Removes all attributes. |
| containsAttribute(String attribute) | Determines whether the element contains a specific attribute. |
| getAttribute(String attribute) | Gets the attribute. |
##### setAttribute(String attribute, String value)
```
public void setAttribute(String attribute, String value)
```

Adds the attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | Attribute key. |
| value | java.lang.String | Attribute value. |

##### clearAttributes()
```
public final void clearAttributes()
```

Removes all attributes.

##### containsAttribute(String attribute)
```
public final boolean containsAttribute(String attribute)
```

Determines whether the element contains a specific attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | Attribute name. |

**Returns:**
boolean - true if attribute is exist; otherwise false.
##### getAttribute(String attribute)
```
public final String getAttribute(String attribute)
```

Gets the attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | The attribute. |

**Returns:**
java.lang.String - The attribute value.

### XmpException
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class XmpException extends GroupDocsMetadataException
```

The exception that is thrown when XMP has invalid structure.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpException() | Initializes a new instance of the  XmpException  class. |
| XmpException(String message) | Initializes a new instance of the  XmpException  class. |
| XmpException(String message, RuntimeException innerException) | Initializes a new instance of the  XmpException  class. |
##### XmpException()
```
public XmpException()
```

Initializes a new instance of the  XmpException  class.

##### XmpException(String message)
```
public XmpException(String message)
```

Initializes a new instance of the  XmpException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

##### XmpException(String message, RuntimeException innerException)
```
public XmpException(String message, RuntimeException innerException)
```

Initializes a new instance of the  XmpException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| innerException | java.lang.RuntimeException | The inner exception. |

### XmpFont
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpfont.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpFont extends XmpComplexType
```

A structure containing the characteristics of a font used in a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpFont() | Initializes a new instance of the  XmpFont  class. |
| XmpFont(String fontFamily) | Initializes a new instance of the  XmpFont  class. |
#### Methods

| Method | Description |
| --- | --- |
| getChildFontFiles() | Gets the list of file names for the fonts that make up a composite font. |
| setChildFontFiles(String[] value) | Sets the list of file names for the fonts that make up a composite font. |
| isComposite() | Gets a value indicating whether whether the font is composite. |
| setComposite(Boolean value) | Sets a value indicating whether whether the font is composite. |
| getFontFace() | Gets the font face name. |
| setFontFace(String value) | Sets the font face name. |
| getFontFamily() | Gets the font family name. |
| setFontFamily(String value) | Sets the font family name. |
| getFontFileName() | Gets the font file name (not a complete path). |
| setFontFileName(String value) | Sets the font file name (not a complete path). |
| getFontName() | Gets the PostScript name of the font. |
| setFontName(String value) | Sets the PostScript name of the font. |
| getFontType() | Gets the font type. |
| setFontType(String value) | Sets the font type. |
| getVersion() | Gets the font version. |
| setVersion(String value) | Sets the font version. |
##### XmpFont()
```
public XmpFont()
```

Initializes a new instance of the  XmpFont  class.

##### XmpFont(String fontFamily)
```
public XmpFont(String fontFamily)
```

Initializes a new instance of the  XmpFont  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamily | java.lang.String | Font family. |

##### getChildFontFiles()
```
public final String[] getChildFontFiles()
```

Gets the list of file names for the fonts that make up a composite font.

**Returns:**
java.lang.String[] - The list of file names for the fonts that make up a composite font.
##### setChildFontFiles(String[] value)
```
public final void setChildFontFiles(String[] value)
```

Sets the list of file names for the fonts that make up a composite font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The list of file names for the fonts that make up a composite font. |

##### isComposite()
```
public final Boolean isComposite()
```

Gets a value indicating whether whether the font is composite.

**Returns:**
java.lang.Boolean -  true  if the font is composite; otherwise,  false .
##### setComposite(Boolean value)
```
public final void setComposite(Boolean value)
```

Sets a value indicating whether whether the font is composite.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the font is composite; otherwise,  false . |

##### getFontFace()
```
public final String getFontFace()
```

Gets the font face name.

**Returns:**
java.lang.String - The font face name.
##### setFontFace(String value)
```
public final void setFontFace(String value)
```

Sets the font face name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font face name. |

##### getFontFamily()
```
public final String getFontFamily()
```

Gets the font family name.

**Returns:**
java.lang.String - The font family name.
##### setFontFamily(String value)
```
public final void setFontFamily(String value)
```

Sets the font family name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font family name. |

##### getFontFileName()
```
public final String getFontFileName()
```

Gets the font file name (not a complete path).

**Returns:**
java.lang.String - The name of the font file.
##### setFontFileName(String value)
```
public final void setFontFileName(String value)
```

Sets the font file name (not a complete path).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the font file. |

##### getFontName()
```
public final String getFontName()
```

Gets the PostScript name of the font.

**Returns:**
java.lang.String - The PostScript name of the font.
##### setFontName(String value)
```
public final void setFontName(String value)
```

Sets the PostScript name of the font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The PostScript name of the font. |

##### getFontType()
```
public final String getFontType()
```

Gets the font type.

**Returns:**
java.lang.String - The font type.

TrueType, Type 1, Open Type, and so on.
##### setFontType(String value)
```
public final void setFontType(String value)
```

Sets the font type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font type.

TrueType, Type 1, Open Type, and so on. |

##### getVersion()
```
public final String getVersion()
```

Gets the font version.

**Returns:**
java.lang.String - The version.

/version for Type1 fonts nameId 5 for Apple True Type and OpenType /CIDFontVersion for CID fonts The empty string for bitmap fonts
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the font version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The version.

/version for Type1 fonts nameId 5 for Apple True Type and OpenType /CIDFontVersion for CID fonts The empty string for bitmap fonts |

### XmpGuid
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpguid.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpGuid extends XmpValueBase
```

Represents XMP global unique identifier.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpGuid(String value) | Initializes a new instance of the  XmpGuid  class. |
| XmpGuid(UUID value) | Initializes a new instance of the  XmpGuid  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpGuid(String value)
```
public XmpGuid(String value)
```

Initializes a new instance of the  XmpGuid  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### XmpGuid(UUID value)
```
public XmpGuid(UUID value)
```

Initializes a new instance of the  XmpGuid  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.UUID | The unique identifier. |

##### getValue()
```
public final UUID getValue()
```

Gets the value.

**Returns:**
java.util.UUID - The value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpHeaderPI
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpheaderpi.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpHeaderPI implements IXmpType
```

Represents XMP header processing instruction.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpHeaderPI() | Initializes a new instance of the  XmpHeaderPI  class. |
#### Methods

| Method | Description |
| --- | --- |
| getGuid() | Represents Header GUID. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpHeaderPI()
```
public XmpHeaderPI()
```

Initializes a new instance of the  XmpHeaderPI  class.

##### getGuid()
```
public final String getGuid()
```

Represents Header GUID.

**Returns:**
java.lang.String - The unique identifier.

The text of the header PI contains a GUID, making it unlikely to appear by accident in the data stream.
##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpInteger
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpinteger.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpInteger extends XmpValueBase
```

Represents XMP Integer basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpInteger(long value) | Initializes a new instance of the  XmpInteger  class. |
| XmpInteger(int value) | Initializes a new instance of the  XmpInteger  class. |
| XmpInteger(String value) | Initializes a new instance of the  XmpInteger  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpInteger(long value)
```
public XmpInteger(long value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The value. |

##### XmpInteger(int value)
```
public XmpInteger(int value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value. |

##### XmpInteger(String value)
```
public XmpInteger(String value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | String value contained integer. |

##### getValue()
```
public final long getValue()
```

Gets the value.

**Returns:**
long - Integer value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpIptcCorePackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpiptccorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcCorePackage extends XmpPackage
```

Represents the IPTC Core XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcCorePackage() | Initializes a new instance of the  XmpIptcCorePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCountryCode() | Gets the code of the country the content is focusing on. |
| setCountryCode(String value) | Sets the code of the country the content is focusing on. |
| getIntellectualGenre() | Gets the intellectual genre. |
| setIntellectualGenre(String value) | Sets the intellectual genre. |
| getLocation() | Gets the location the content is focusing on. |
| setLocation(String value) | Sets the location the content is focusing on. |
| getScenes() | Gets the scene of the photo content. |
| setScenes(String[] value) | Sets the scene of the photo content. |
| getSubjectCodes() | Gets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |
| setSubjectCodes(String[] value) | Sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |
##### XmpIptcCorePackage()
```
public XmpIptcCorePackage()
```

Initializes a new instance of the  XmpIptcCorePackage  class.

##### getCountryCode()
```
public final String getCountryCode()
```

Gets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.

**Returns:**
java.lang.String - The country code.
##### setCountryCode(String value)
```
public final void setCountryCode(String value)
```

Sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The country code. |

##### getIntellectualGenre()
```
public final String getIntellectualGenre()
```

Gets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.

**Returns:**
java.lang.String - The intellectual genre.
##### setIntellectualGenre(String value)
```
public final void setIntellectualGenre(String value)
```

Sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The intellectual genre. |

##### getLocation()
```
public final String getLocation()
```

Gets the location the content is focusing on.

**Returns:**
java.lang.String - The location.

This location name could either be the name of a sublocation to a city or the name of a well known location or (natural) monument outside a city. In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy.
##### setLocation(String value)
```
public final void setLocation(String value)
```

Sets the location the content is focusing on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The location.

This location name could either be the name of a sublocation to a city or the name of a well known location or (natural) monument outside a city. In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy. |

##### getScenes()
```
public final String[] getScenes()
```

Gets the scene of the photo content.

**Returns:**
java.lang.String[] - The scene codes.

Specifies one or more terms from the IPTC "Scene-NewsCodes". Each Scene is represented as a string of 6 digits in an unordered list
##### setScenes(String[] value)
```
public final void setScenes(String[] value)
```

Sets the scene of the photo content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The scene codes.

Specifies one or more terms from the IPTC "Scene-NewsCodes". Each Scene is represented as a string of 6 digits in an unordered list |

##### getSubjectCodes()
```
public final String[] getSubjectCodes()
```

Gets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

**Returns:**
java.lang.String[] - The subject codes.

More about IPTC Subject-NewsCodes at http://www.newscodes.org.
##### setSubjectCodes(String[] value)
```
public final void setSubjectCodes(String[] value)
```

Sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The subject codes.

More about IPTC Subject-NewsCodes at http://www.newscodes.org. |

### XmpIptcExtensionPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpiptcextensionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcExtensionPackage extends XmpPackage
```

Represents the IPTC Extension XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcExtensionPackage() | Initializes a new instance of the  XmpIptcExtensionPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAdditionalModelInformation() | Gets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| setAdditionalModelInformation(String value) | Sets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| getOrganisationInImageCodes() | Gets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| setOrganisationInImageCodes(String[] value) | Sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| getOrganisationInImageNames() | Gets names of the organisations or companies which are featured in the image. |
| setOrganisationInImageNames(String[] value) | Sets names of the organisations or companies which are featured in the image. |
| getAgesOfModels() | Gets ages of the human models at the time this image was taken in a model released image. |
| setAgesOfModels(int[] value) | Sets ages of the human models at the time this image was taken in a model released image. |
| getPersonsInImage() | Gets names of the persons the content of the item is about. |
| setPersonsInImage(String[] value) | Sets names of the persons the content of the item is about. |
| getDigitalImageGuid() | Gets the globally unique identifier for this digital image. |
| setDigitalImageGuid(String value) | Sets the globally unique identifier for this digital image. |
| getDigitalSourceType() | Gets the type of the source of this digital image. |
| setDigitalSourceType(String value) | Sets the type of the source of this digital image. |
| getEvent() | Gets the description of the specific event at which the photo was taken. |
| setEvent(XmpLangAlt value) | Sets the description of the specific event at which the photo was taken. |
| getIptcLastEdited() | Gets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| setIptcLastEdited(Date value) | Sets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| getMaxAvailableHeight() | Gets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| setMaxAvailableHeight(Integer value) | Sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| getMaxAvailableWidth() | Gets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |
| setMaxAvailableWidth(Integer value) | Sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |
| set(String name, String value) | Sets string property. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpIptcExtensionPackage()
```
public XmpIptcExtensionPackage()
```

Initializes a new instance of the  XmpIptcExtensionPackage  class.

##### getAdditionalModelInformation()
```
public final String getAdditionalModelInformation()
```

Gets the information about the ethnicity and other facets of the model(s) in a model-released image.

**Returns:**
java.lang.String - The additional model information.
##### setAdditionalModelInformation(String value)
```
public final void setAdditionalModelInformation(String value)
```

Sets the information about the ethnicity and other facets of the model(s) in a model-released image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The additional model information. |

##### getOrganisationInImageCodes()
```
public final String[] getOrganisationInImageCodes()
```

Gets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.

**Returns:**
java.lang.String[] - The codes of the organisations.
##### setOrganisationInImageCodes(String[] value)
```
public final void setOrganisationInImageCodes(String[] value)
```

Sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The codes of the organisations. |

##### getOrganisationInImageNames()
```
public final String[] getOrganisationInImageNames()
```

Gets names of the organisations or companies which are featured in the image.

**Returns:**
java.lang.String[] - Names of the organisations.
##### setOrganisationInImageNames(String[] value)
```
public final void setOrganisationInImageNames(String[] value)
```

Sets names of the organisations or companies which are featured in the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | Names of the organisations. |

##### getAgesOfModels()
```
public final int[] getAgesOfModels()
```

Gets ages of the human models at the time this image was taken in a model released image.

**Returns:**
int[] - Ages of the models.
##### setAgesOfModels(int[] value)
```
public final void setAgesOfModels(int[] value)
```

Sets ages of the human models at the time this image was taken in a model released image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | Ages of the models. |

##### getPersonsInImage()
```
public final String[] getPersonsInImage()
```

Gets names of the persons the content of the item is about.

**Returns:**
java.lang.String[] - Names of the persons that are shown in the image.
##### setPersonsInImage(String[] value)
```
public final void setPersonsInImage(String[] value)
```

Sets names of the persons the content of the item is about.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | Names of the persons that are shown in the image. |

##### getDigitalImageGuid()
```
public final String getDigitalImageGuid()
```

Gets the globally unique identifier for this digital image.

**Returns:**
java.lang.String - The image GUID.

It is created and applied by the creator of the digital image at the time of its creation. This value shall not be changed after that time.
##### setDigitalImageGuid(String value)
```
public final void setDigitalImageGuid(String value)
```

Sets the globally unique identifier for this digital image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image GUID.

It is created and applied by the creator of the digital image at the time of its creation. This value shall not be changed after that time. |

##### getDigitalSourceType()
```
public final String getDigitalSourceType()
```

Gets the type of the source of this digital image.

**Returns:**
java.lang.String - The type of the source digital file.
##### setDigitalSourceType(String value)
```
public final void setDigitalSourceType(String value)
```

Sets the type of the source of this digital image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the source digital file. |

##### getEvent()
```
public final XmpLangAlt getEvent()
```

Gets the description of the specific event at which the photo was taken.

**Returns:**
XmpLangAlt - The specific event at which the photo was taken.
##### setEvent(XmpLangAlt value)
```
public final void setEvent(XmpLangAlt value)
```

Sets the description of the specific event at which the photo was taken.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The specific event at which the photo was taken. |

##### getIptcLastEdited()
```
public final Date getIptcLastEdited()
```

Gets the date and optionally time when any of the IPTC photo metadata fields has been last edited.

**Returns:**
java.util.Date - The last edited date.
##### setIptcLastEdited(Date value)
```
public final void setIptcLastEdited(Date value)
```

Sets the date and optionally time when any of the IPTC photo metadata fields has been last edited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last edited date. |

##### getMaxAvailableHeight()
```
public final Integer getMaxAvailableHeight()
```

Gets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.

**Returns:**
java.lang.Integer - The maximum available height.
##### setMaxAvailableHeight(Integer value)
```
public final void setMaxAvailableHeight(Integer value)
```

Sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The maximum available height. |

##### getMaxAvailableWidth()
```
public final Integer getMaxAvailableWidth()
```

Gets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.

**Returns:**
java.lang.Integer - The maximum available width.
##### setMaxAvailableWidth(Integer value)
```
public final void setMaxAvailableWidth(Integer value)
```

Sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The maximum available width. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpIptcIimPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpiptciimpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcIimPackage extends XmpPackage
```

Represents the IPTC-IIM XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcIimPackage() | Initializes a new instance of the  XmpIptcIimPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModelVersion() | Gets the binary number identifying the version of the Information |
| setModelVersion(Integer value) | Sets the binary number identifying the version of the Information |
| getDestination() | Gets the destination. |
| setDestination(String[] value) | Sets the destination. |
| getFileFormat() | Gets the binary number identifying the version of the Information |
| setFileFormat(Integer value) | Sets the binary number identifying the version of the Information |
| getFileFormatVersion() | Gets the file format version. |
| setFileFormatVersion(Integer value) | Sets the file format version. |
| getServiceIdentifier() | Gets the service identifier. |
| setServiceIdentifier(String value) | Sets the service identifier. |
| getEnvelopeNumber() | Gets the envelope number. |
| setEnvelopeNumber(String value) | Sets the envelope number. |
| getProductIDs() | Gets the product identifiers. |
| setProductIDs(String[] value) | Sets the product identifiers. |
| getEnvelopePriority() | Gets the envelope handling priority. |
| setEnvelopePriority(Integer value) | Sets the envelope handling priority. |
| getDateSent() | Gets the date the service sent the material. |
| setDateSent(Date value) | Sets the date the service sent the material. |
| getUniqueNameOfObject() | Gets the unique name of the object. |
| setUniqueNameOfObject(String value) | Sets the unique name of the object. |
| getObjectTypeReference() | Gets the object type reference. |
| setObjectTypeReference(String value) | Sets the object type reference. |
| getEditStatus() | Gets the status of the object data, according to the practice of the provider. |
| setEditStatus(String value) | Sets the status of the object data, according to the practice of the provider. |
| getUrgency() | Gets the editorial urgency of the content. |
| setUrgency(Integer value) | Sets the editorial urgency of the content. |
| getCategory() | Gets the subject of the object data in the opinion of the provider. |
| setCategory(String value) | Sets the subject of the object data in the opinion of the provider. |
| getSupplementalCategories() | Gets the supplemental categories. |
| setSupplementalCategories(String[] value) | Sets the supplemental categories. |
| getFixtureIdentifier() | Gets the object data that recurs often and predictably. |
| setFixtureIdentifier(String value) | Sets the object data that recurs often and predictably. |
| getContentLocationCodes() | Gets the content location codes. |
| setContentLocationCodes(String[] value) | Sets the content location codes. |
| getContentLocationNames() | Gets the content location names. |
| setContentLocationNames(String[] value) | Sets the content location names. |
| getReleaseDate() | Gets the earliest date the provider intends the object to be used. |
| setReleaseDate(Date value) | Sets the earliest date the provider intends the object to be used. |
| getExpirationDate() | Gets the latest date the provider or owner intends the object data to be used. |
| setExpirationDate(Date value) | Sets the latest date the provider or owner intends the object data to be used. |
| getActionAdvised() | Gets the type of action that this object provides to a previous object. |
| setActionAdvised(String value) | Sets the type of action that this object provides to a previous object. |
| getReferenceService() | Gets the Service Identifier of a prior envelope to which the current object refers. |
| setReferenceService(String value) | Sets the Service Identifier of a prior envelope to which the current object refers. |
| getReferenceDate() | Gets the date of a prior envelope to which the current object refers. |
| setReferenceDate(Date value) | Sets the date of a prior envelope to which the current object refers. |
| getReferenceNumber() | Gets the Envelope Number of a prior envelope to which the current object refers. |
| setReferenceNumber(String value) | Sets the Envelope Number of a prior envelope to which the current object refers. |
| getDigitalCreationDate() | Gets the date the digital representation of the object data was created. |
| setDigitalCreationDate(Date value) | Sets the date the digital representation of the object data was created. |
| getOriginatingProgram() | Gets the type of program used to originate the object data. |
| setOriginatingProgram(String value) | Sets the type of program used to originate the object data. |
| getProgramVersion() | Gets the program version. |
| setProgramVersion(String value) | Sets the program version. |
| getImageType() | Gets the type of the image. |
| setImageType(String value) | Sets the type of the image. |
| getImageOrientation() | Gets the image orientation. |
| setImageOrientation(String value) | Sets the image orientation. |
| getLanguageIdentifier() | Gets the language identifier according to the 2-letter codes of ISO 639:1988. |
| setLanguageIdentifier(String value) | Sets the language identifier according to the 2-letter codes of ISO 639:1988. |
| set(String name, String value) | Sets string property. |
##### XmpIptcIimPackage()
```
public XmpIptcIimPackage()
```

Initializes a new instance of the  XmpIptcIimPackage  class.

##### getModelVersion()
```
public final Integer getModelVersion()
```

Gets the binary number identifying the version of the Information

**Returns:**
java.lang.Integer - The model version.
##### setModelVersion(Integer value)
```
public final void setModelVersion(Integer value)
```

Sets the binary number identifying the version of the Information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The model version. |

##### getDestination()
```
public final String[] getDestination()
```

Gets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

**Returns:**
java.lang.String[] - The destination.
##### setDestination(String[] value)
```
public final void setDestination(String[] value)
```

Sets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The destination. |

##### getFileFormat()
```
public final Integer getFileFormat()
```

Gets the binary number identifying the version of the Information

**Returns:**
java.lang.Integer - The file format.
##### setFileFormat(Integer value)
```
public final void setFileFormat(Integer value)
```

Sets the binary number identifying the version of the Information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format. |

##### getFileFormatVersion()
```
public final Integer getFileFormatVersion()
```

Gets the file format version.

**Returns:**
java.lang.Integer - The file format version.
##### setFileFormatVersion(Integer value)
```
public final void setFileFormatVersion(Integer value)
```

Sets the file format version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format version. |

##### getServiceIdentifier()
```
public final String getServiceIdentifier()
```

Gets the service identifier. Identifies the provider and product.

**Returns:**
java.lang.String - The service identifier.
##### setServiceIdentifier(String value)
```
public final void setServiceIdentifier(String value)
```

Sets the service identifier. Identifies the provider and product.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The service identifier. |

##### getEnvelopeNumber()
```
public final String getEnvelopeNumber()
```

Gets the envelope number.

**Returns:**
java.lang.String - The envelope number.
##### setEnvelopeNumber(String value)
```
public final void setEnvelopeNumber(String value)
```

Sets the envelope number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The envelope number. |

##### getProductIDs()
```
public final String[] getProductIDs()
```

Gets the product identifiers.

**Returns:**
java.lang.String[] - The product identifier.

Used to provide receiving organization data on which to select, route, or otherwise handle data.
##### setProductIDs(String[] value)
```
public final void setProductIDs(String[] value)
```

Sets the product identifiers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The product identifier.

Used to provide receiving organization data on which to select, route, or otherwise handle data. |

##### getEnvelopePriority()
```
public final Integer getEnvelopePriority()
```

Gets the envelope handling priority.

**Returns:**
java.lang.Integer - The envelope priority.
##### setEnvelopePriority(Integer value)
```
public final void setEnvelopePriority(Integer value)
```

Sets the envelope handling priority.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The envelope priority. |

##### getDateSent()
```
public final Date getDateSent()
```

Gets the date the service sent the material.

**Returns:**
java.util.Date - The date sent.
##### setDateSent(Date value)
```
public final void setDateSent(Date value)
```

Sets the date the service sent the material.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date sent. |

##### getUniqueNameOfObject()
```
public final String getUniqueNameOfObject()
```

Gets the unique name of the object.

**Returns:**
java.lang.String - The unique name of the object.
##### setUniqueNameOfObject(String value)
```
public final void setUniqueNameOfObject(String value)
```

Sets the unique name of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The unique name of the object. |

##### getObjectTypeReference()
```
public final String getObjectTypeReference()
```

Gets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.

**Returns:**
java.lang.String - The object type reference.
##### setObjectTypeReference(String value)
```
public final void setObjectTypeReference(String value)
```

Sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The object type reference. |

##### getEditStatus()
```
public final String getEditStatus()
```

Gets the status of the object data, according to the practice of the provider.

**Returns:**
java.lang.String - The edit status.
##### setEditStatus(String value)
```
public final void setEditStatus(String value)
```

Sets the status of the object data, according to the practice of the provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The edit status. |

##### getUrgency()
```
public final Integer getUrgency()
```

Gets the editorial urgency of the content.

**Returns:**
java.lang.Integer - The urgency.
##### setUrgency(Integer value)
```
public final void setUrgency(Integer value)
```

Sets the editorial urgency of the content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The urgency. |

##### getCategory()
```
public final String getCategory()
```

Gets the subject of the object data in the opinion of the provider.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the subject of the object data in the opinion of the provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getSupplementalCategories()
```
public final String[] getSupplementalCategories()
```

Gets the supplemental categories.

**Returns:**
java.lang.String[] - The supplemental categories.
##### setSupplementalCategories(String[] value)
```
public final void setSupplementalCategories(String[] value)
```

Sets the supplemental categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The supplemental categories. |

##### getFixtureIdentifier()
```
public final String getFixtureIdentifier()
```

Gets the object data that recurs often and predictably.

**Returns:**
java.lang.String - The fixture identifier.
##### setFixtureIdentifier(String value)
```
public final void setFixtureIdentifier(String value)
```

Sets the object data that recurs often and predictably.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The fixture identifier. |

##### getContentLocationCodes()
```
public final String[] getContentLocationCodes()
```

Gets the content location codes.

**Returns:**
java.lang.String[] - The content location codes.

Indicates the code of a country/geographical location referenced by the content of the object.
##### setContentLocationCodes(String[] value)
```
public final void setContentLocationCodes(String[] value)
```

Sets the content location codes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location codes.

Indicates the code of a country/geographical location referenced by the content of the object. |

##### getContentLocationNames()
```
public final String[] getContentLocationNames()
```

Gets the content location names.

**Returns:**
java.lang.String[] - The content location names.

Provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider.
##### setContentLocationNames(String[] value)
```
public final void setContentLocationNames(String[] value)
```

Sets the content location names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location names.

Provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider. |

##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the earliest date the provider intends the object to be used.

**Returns:**
java.util.Date - The release date.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the earliest date the provider intends the object to be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The release date. |

##### getExpirationDate()
```
public final Date getExpirationDate()
```

Gets the latest date the provider or owner intends the object data to be used.

**Returns:**
java.util.Date - The expiration date.
##### setExpirationDate(Date value)
```
public final void setExpirationDate(Date value)
```

Sets the latest date the provider or owner intends the object data to be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The expiration date. |

##### getActionAdvised()
```
public final String getActionAdvised()
```

Gets the type of action that this object provides to a previous object.

**Returns:**
java.lang.String - The type of action.
##### setActionAdvised(String value)
```
public final void setActionAdvised(String value)
```

Sets the type of action that this object provides to a previous object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of action. |

##### getReferenceService()
```
public final String getReferenceService()
```

Gets the Service Identifier of a prior envelope to which the current object refers.

**Returns:**
java.lang.String - The reference service.
##### setReferenceService(String value)
```
public final void setReferenceService(String value)
```

Sets the Service Identifier of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference service. |

##### getReferenceDate()
```
public final Date getReferenceDate()
```

Gets the date of a prior envelope to which the current object refers.

**Returns:**
java.util.Date - The reference date.
##### setReferenceDate(Date value)
```
public final void setReferenceDate(Date value)
```

Sets the date of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The reference date. |

##### getReferenceNumber()
```
public final String getReferenceNumber()
```

Gets the Envelope Number of a prior envelope to which the current object refers.

**Returns:**
java.lang.String - The reference number.
##### setReferenceNumber(String value)
```
public final void setReferenceNumber(String value)
```

Sets the Envelope Number of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference number. |

##### getDigitalCreationDate()
```
public final Date getDigitalCreationDate()
```

Gets the date the digital representation of the object data was created.

**Returns:**
java.util.Date - The digital creation date.
##### setDigitalCreationDate(Date value)
```
public final void setDigitalCreationDate(Date value)
```

Sets the date the digital representation of the object data was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The digital creation date. |

##### getOriginatingProgram()
```
public final String getOriginatingProgram()
```

Gets the type of program used to originate the object data.

**Returns:**
java.lang.String - The originating program.
##### setOriginatingProgram(String value)
```
public final void setOriginatingProgram(String value)
```

Sets the type of program used to originate the object data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The originating program. |

##### getProgramVersion()
```
public final String getProgramVersion()
```

Gets the program version.

**Returns:**
java.lang.String - The program version.
##### setProgramVersion(String value)
```
public final void setProgramVersion(String value)
```

Sets the program version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The program version. |

##### getImageType()
```
public final String getImageType()
```

Gets the type of the image.

**Returns:**
java.lang.String - The type of the image.

The first is a numeric character and the second is an alphabetic character.
##### setImageType(String value)
```
public final void setImageType(String value)
```

Sets the type of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the image.

The first is a numeric character and the second is an alphabetic character. |

##### getImageOrientation()
```
public final String getImageOrientation()
```

Gets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).

**Returns:**
java.lang.String - The image orientation.
##### setImageOrientation(String value)
```
public final void setImageOrientation(String value)
```

Sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image orientation. |

##### getLanguageIdentifier()
```
public final String getLanguageIdentifier()
```

Gets the language identifier according to the 2-letter codes of ISO 639:1988.

**Returns:**
java.lang.String - The language identifier.
##### setLanguageIdentifier(String value)
```
public final void setLanguageIdentifier(String value)
```

Sets the language identifier according to the 2-letter codes of ISO 639:1988.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language identifier. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpJob
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpjob.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpJob extends XmpComplexType
```

Represents Job.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpJob() | Initializes a new instance of the  XmpJob  class. |
#### Methods

| Method | Description |
| --- | --- |
| getID() | Gets unique id for the job. |
| setID(String value) | Sets unique id for the job. |
| getName() | Gets informal name of the job. |
| setName(String value) | Sets informal name of the job. |
| getUrl() | Gets a file URL referencing an external job management file. |
| setUrl(String value) | Sets a file URL referencing an external job management file. |
##### XmpJob()
```
public XmpJob()
```

Initializes a new instance of the  XmpJob  class.

##### getID()
```
public final String getID()
```

Gets unique id for the job. This field is a reference into some external job management system.

**Returns:**
java.lang.String - The identifier.
##### setID(String value)
```
public final void setID(String value)
```

Sets unique id for the job. This field is a reference into some external job management system.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The identifier. |

##### getName()
```
public final String getName()
```

Gets informal name of the job. This name is for user display and informal systems.

**Returns:**
java.lang.String - The name.
##### setName(String value)
```
public final void setName(String value)
```

Sets informal name of the job. This name is for user display and informal systems.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name. |

##### getUrl()
```
public final String getUrl()
```

Gets a file URL referencing an external job management file.

**Returns:**
java.lang.String - The URL.
##### setUrl(String value)
```
public final void setUrl(String value)
```

Sets a file URL referencing an external job management file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URL. |

### XmpLangAlt
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmplangalt.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase, com.groupdocs.metadata.core.XmpArray
```
public final class XmpLangAlt extends XmpArray
```

Represents XMP Language Alternative.

An alternative array of simple text items. Language alternatives facilitate the selection of a simple text item based on a desired language. Each array item shall have an xml:lang qualifier. Each xml:lang value shall be unique among the items.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpLangAlt(String defaultValue) | Initializes a new instance of the  XmpLangAlt  class. |
| XmpLangAlt(Hashtable<String,String> dictionary) | Initializes a new instance of the  XmpLangAlt  class. |
#### Methods

| Method | Description |
| --- | --- |
| get_Item(String language) | Gets the value associated with the specified language. |
| getLanguages() | Gets an array of all languages registered in the instance of  XmpLangAlt . |
| contains(String language) | Determines whether the  XmpLangAlt  contains the specified language. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpLangAlt(String defaultValue)
```
public XmpLangAlt(String defaultValue)
```

Initializes a new instance of the  XmpLangAlt  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| defaultValue | java.lang.String | The default value. |

##### XmpLangAlt(Hashtable<String,String> dictionary)
```
public XmpLangAlt(Hashtable<String,String> dictionary)
```

Initializes a new instance of the  XmpLangAlt  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | java.util.Hashtable<java.lang.String,java.lang.String> | A dictionary containing values by languages. |

##### get_Item(String language)
```
public final String get_Item(String language)
```

Gets the value associated with the specified language.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language. Value: String value. |

**Returns:**
java.lang.String - Value for the specified language.
##### getLanguages()
```
public final String[] getLanguages()
```

Gets an array of all languages registered in the instance of  XmpLangAlt .

**Returns:**
java.lang.String[] - An array of all languages registered in the instance of  XmpLangAlt .
##### contains(String language)
```
public final boolean contains(String language)
```

Determines whether the  XmpLangAlt  contains the specified language.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language to locate in the  XmpLangAlt . |

**Returns:**
boolean - True if the  XmpLangAlt  contains an element with the specified language; otherwise, false.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpMediaManagementPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpmediamanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpMediaManagementPackage extends XmpPackage
```

Represents the XMP Media Management namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpMediaManagementPackage() | Initializes a new instance of the  XmpMediaManagementPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDerivedFrom() | Gets the reference to the resource from which this one is derived. |
| setDerivedFrom(XmpResourceRef value) | Sets the reference to the resource from which this one is derived. |
| getDocumentID() | Gets the common identifier for all versions and renditions of the resource. |
| setDocumentID(String value) | Sets the common identifier for all versions and renditions of the resource. |
| getHistory() | Gets an array of high-level actions that resulted in this resource. |
| setHistory(XmpResourceEvent[] value) | Sets an array of high-level actions that resulted in this resource. |
| getIngredients() | Gets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| setIngredients(XmpResourceRef[] value) | Sets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| getInstanceID() | Gets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| setInstanceID(String value) | Sets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| getManagedFrom() | Gets the reference to the document as it was prior to becoming managed. |
| setManagedFrom(XmpResourceRef value) | Sets the reference to the document as it was prior to becoming managed. |
| getManager() | Gets the name of the asset management system that manages this resource. |
| setManager(String value) | Sets the name of the asset management system that manages this resource. |
| getManageTo() | Gets the URI identifying the managed resource to the asset management system |
| setManageTo(String value) | Sets the URI identifying the managed resource to the asset management system |
| getManageUI() | Gets the URI that can be used to access information about the managed resource through a web browser. |
| setManageUI(String value) | Sets the URI that can be used to access information about the managed resource through a web browser. |
| getManagerVariant() | Gets the particular variant of the asset management system. |
| setManagerVariant(String value) | Sets the particular variant of the asset management system. |
| getOriginalDocumentID() | Gets the common identifier for the original resource from which the current resource is derived. |
| setOriginalDocumentID(String value) | Sets the common identifier for the original resource from which the current resource is derived. |
| getRenditionClass() | Gets the rendition class name for this resource. |
| setRenditionClass(String value) | Sets the rendition class name for this resource. |
| getRenditionParams() | Gets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass. |
| setRenditionParams(String value) | Sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass. |
| getVersionID() | Gets the document version identifier for this resource. |
| setVersionID(String value) | Sets the document version identifier for this resource. |
| getVersions() | Gets the version history associated with this resource. |
| setVersions(XmpVersion[] value) | Sets the version history associated with this resource. |
##### XmpMediaManagementPackage()
```
public XmpMediaManagementPackage()
```

Initializes a new instance of the  XmpMediaManagementPackage  class.

##### getDerivedFrom()
```
public final XmpResourceRef getDerivedFrom()
```

Gets the reference to the resource from which this one is derived.

**Returns:**
XmpResourceRef - The the reference to the resource from which this one is derived.
##### setDerivedFrom(XmpResourceRef value)
```
public final void setDerivedFrom(XmpResourceRef value)
```

Sets the reference to the resource from which this one is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef | The the reference to the resource from which this one is derived. |

##### getDocumentID()
```
public final String getDocumentID()
```

Gets the common identifier for all versions and renditions of the resource.

**Returns:**
java.lang.String - The common identifier for all versions and renditions of the resource.
##### setDocumentID(String value)
```
public final void setDocumentID(String value)
```

Sets the common identifier for all versions and renditions of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The common identifier for all versions and renditions of the resource. |

##### getHistory()
```
public final XmpResourceEvent[] getHistory()
```

Gets an array of high-level actions that resulted in this resource.

**Returns:**
com.groupdocs.metadata.core.XmpResourceEvent[] - An array of high-level actions that resulted in this resource.
##### setHistory(XmpResourceEvent[] value)
```
public final void setHistory(XmpResourceEvent[] value)
```

Sets an array of high-level actions that resulted in this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceEvent\[\] | An array of high-level actions that resulted in this resource. |

##### getIngredients()
```
public final XmpResourceRef[] getIngredients()
```

Gets the references to resources that were incorporated, by inclusion or reference, into this resource.

**Returns:**
com.groupdocs.metadata.core.XmpResourceRef[] - The references to resources that were incorporated, by inclusion or reference, into this resource.
##### setIngredients(XmpResourceRef[] value)
```
public final void setIngredients(XmpResourceRef[] value)
```

Sets the references to resources that were incorporated, by inclusion or reference, into this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef\[\] | The references to resources that were incorporated, by inclusion or reference, into this resource. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the identifier for a specific incarnation of a resource, updated each time the file is saved.

**Returns:**
java.lang.String - The identifier for a specific incarnation of a resource, updated each time a file is saved.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the identifier for a specific incarnation of a resource, updated each time the file is saved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The identifier for a specific incarnation of a resource, updated each time a file is saved. |

##### getManagedFrom()
```
public final XmpResourceRef getManagedFrom()
```

Gets the reference to the document as it was prior to becoming managed.

**Returns:**
XmpResourceRef - The reference to the document as it was prior to becoming managed.
##### setManagedFrom(XmpResourceRef value)
```
public final void setManagedFrom(XmpResourceRef value)
```

Sets the reference to the document as it was prior to becoming managed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef | The reference to the document as it was prior to becoming managed. |

##### getManager()
```
public final String getManager()
```

Gets the name of the asset management system that manages this resource.

**Returns:**
java.lang.String - The name of the asset management system that manages this resource.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the name of the asset management system that manages this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the asset management system that manages this resource. |

##### getManageTo()
```
public final String getManageTo()
```

Gets the URI identifying the managed resource to the asset management system

**Returns:**
java.lang.String - The URI identifying the managed resource to the asset management system.
##### setManageTo(String value)
```
public final void setManageTo(String value)
```

Sets the URI identifying the managed resource to the asset management system

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URI identifying the managed resource to the asset management system. |

##### getManageUI()
```
public final String getManageUI()
```

Gets the URI that can be used to access information about the managed resource through a web browser.

**Returns:**
java.lang.String - The URI that can be used to access information about the managed resource through a web browser.
##### setManageUI(String value)
```
public final void setManageUI(String value)
```

Sets the URI that can be used to access information about the managed resource through a web browser.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URI that can be used to access information about the managed resource through a web browser. |

##### getManagerVariant()
```
public final String getManagerVariant()
```

Gets the particular variant of the asset management system.

**Returns:**
java.lang.String - The particular variant of the asset management system. The format of this property is private to the specific asset management system.
##### setManagerVariant(String value)
```
public final void setManagerVariant(String value)
```

Sets the particular variant of the asset management system.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The particular variant of the asset management system. The format of this property is private to the specific asset management system. |

##### getOriginalDocumentID()
```
public final String getOriginalDocumentID()
```

Gets the common identifier for the original resource from which the current resource is derived.

**Returns:**
java.lang.String - The common identifier for the original resource from which the current resource is derived
##### setOriginalDocumentID(String value)
```
public final void setOriginalDocumentID(String value)
```

Sets the common identifier for the original resource from which the current resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The common identifier for the original resource from which the current resource is derived |

##### getRenditionClass()
```
public final String getRenditionClass()
```

Gets the rendition class name for this resource.

**Returns:**
java.lang.String - The rendition class name for this resource. This property should be absent or set to default for a resource that is not a derived rendition.
##### setRenditionClass(String value)
```
public final void setRenditionClass(String value)
```

Sets the rendition class name for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The rendition class name for this resource. This property should be absent or set to default for a resource that is not a derived rendition. |

##### getRenditionParams()
```
public final String getRenditionParams()
```

Gets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass.

**Returns:**
java.lang.String - The value that is used to provide additional rendition parameters.
##### setRenditionParams(String value)
```
public final void setRenditionParams(String value)
```

Sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value that is used to provide additional rendition parameters. |

##### getVersionID()
```
public final String getVersionID()
```

Gets the document version identifier for this resource.

**Returns:**
java.lang.String - The document version identifier for this resource.
##### setVersionID(String value)
```
public final void setVersionID(String value)
```

Sets the document version identifier for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document version identifier for this resource. |

##### getVersions()
```
public final XmpVersion[] getVersions()
```

Gets the version history associated with this resource.

**Returns:**
com.groupdocs.metadata.core.XmpVersion[] - The version history associated with this resource. Entry [0] is the oldest known version for this document, entry [Versions.Length - 1] is the most recent version.
##### setVersions(XmpVersion[] value)
```
public final void setVersions(XmpVersion[] value)
```

Sets the version history associated with this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpVersion\[\] | The version history associated with this resource. Entry [0] is the oldest known version for this document, entry [Versions.Length - 1] is the most recent version. |

### XmpMeta
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpmeta.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpElementBase

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpMeta extends XmpElementBase implements IXmpType
```

Represents xmpmeta. Optional. The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpMeta() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAdobeXmpToolkit() | Gets Adobe XMP toolkit version. |
| setAttribute(String attribute, String value) | Adds an attribute. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpMeta()
```
public XmpMeta()
```

##### getAdobeXmpToolkit()
```
public final String getAdobeXmpToolkit()
```

Gets Adobe XMP toolkit version.

**Returns:**
java.lang.String - The toolkit version.
##### setAttribute(String attribute, String value)
```
public void setAttribute(String attribute, String value)
```

Adds an attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | The attribute. |
| value | java.lang.String | The value. |

##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpMetadataContainer
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpmetadatacontainer.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public abstract class XmpMetadataContainer extends CustomPackage implements IXmpType
```

Represents a container for XMP metadata properties.
#### Methods

| Method | Description |
| --- | --- |
| getXmpRepresentation() | Converts the XMP value to the XML representation. |
##### getXmpRepresentation()
```
public abstract String getXmpRepresentation()
```

Converts the XMP value to the XML representation.

**Returns:**
java.lang.String - A  string  representation of the XMP value.

### XmpNamespaces
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpnamespaces.md

**Inheritance:**
java.lang.Object
```
public class XmpNamespaces
```

Contains namespaces used in  XmpPackage  and  XmpComplexType .
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpNamespaces() |  |
#### Fields

| Field | Description |
| --- | --- |
| Xml | Xml namespace. |
| Rdf | Resource definition framework namespace. |
| BasicJob | Basic Job Ticket namespace. |
| CameraRaw | Camera Raw namespace. |
| DublinCore | Dublin Core namespace. |
| Iptc4XmpIim | IPTC IIM namespace. |
| Iptc4XmpCore | IPTC Core namespace. |
| Iptc4XmpExt | IPTC Extension namespace. |
| XmpBasic | XMP Basic namespace. |
| XmpRights | XMP Rights Management namespace. |
| XmpMM | XMP digital asset management namespace. |
| XmpDM | XMP Dynamic Media namespace. |
| Pdf | Adobe PDF namespace. |
| Photoshop | Adobe Photoshop namespace. |
| PagedText | XMP Paged-Text namespace. |
| XmpGraphics | XMP graphics namespace. |
| XmpGraphicsThumbnail | XMP graphics namespace. |
| XmpTypeFont | XMP Font type. |
| XmpTypeDimensions | XMP Dimensions type. |
| XmpTypeResourceRef | XMP ResourceRef URI. |
| XmpTypeResourceEvent | XMP ResourceEvent URI. |
| XmpTypeVersion | XMP Version. |
| XmpTypeJob | XMP Job Ticket. |
##### XmpNamespaces()
```
public XmpNamespaces()
```

##### Xml
```
public static final String Xml
```

Xml namespace.

##### Rdf
```
public static final String Rdf
```

Resource definition framework namespace.

##### BasicJob
```
public static final String BasicJob
```

Basic Job Ticket namespace.

##### CameraRaw
```
public static final String CameraRaw
```

Camera Raw namespace.

##### DublinCore
```
public static final String DublinCore
```

Dublin Core namespace.

##### Iptc4XmpIim
```
public static final String Iptc4XmpIim
```

IPTC IIM namespace.

##### Iptc4XmpCore
```
public static final String Iptc4XmpCore
```

IPTC Core namespace.

##### Iptc4XmpExt
```
public static final String Iptc4XmpExt
```

IPTC Extension namespace.

##### XmpBasic
```
public static final String XmpBasic
```

XMP Basic namespace.

##### XmpRights
```
public static final String XmpRights
```

XMP Rights Management namespace.

##### XmpMM
```
public static final String XmpMM
```

XMP digital asset management namespace.

##### XmpDM
```
public static final String XmpDM
```

XMP Dynamic Media namespace.

##### Pdf
```
public static final String Pdf
```

Adobe PDF namespace.

##### Photoshop
```
public static final String Photoshop
```

Adobe Photoshop namespace.

##### PagedText
```
public static final String PagedText
```

XMP Paged-Text namespace.

##### XmpGraphics
```
public static final String XmpGraphics
```

XMP graphics namespace.

##### XmpGraphicsThumbnail
```
public static final String XmpGraphicsThumbnail
```

XMP graphics namespace.

##### XmpTypeFont
```
public static final String XmpTypeFont
```

XMP Font type.

##### XmpTypeDimensions
```
public static final String XmpTypeDimensions
```

XMP Dimensions type.

##### XmpTypeResourceRef
```
public static final String XmpTypeResourceRef
```

XMP ResourceRef URI.

##### XmpTypeResourceEvent
```
public static final String XmpTypeResourceEvent
```

XMP ResourceEvent URI.

##### XmpTypeVersion
```
public static final String XmpTypeVersion
```

XMP Version.

##### XmpTypeJob
```
public static final String XmpTypeJob
```

XMP Job Ticket.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer
```
public class XmpPackage extends XmpMetadataContainer
```

Represents base abstraction for XMP package.

This example demonstrates how to add a custom XMP package to a file of any supported format.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IXmp root = (IXmp) metadata.getRootPackage();
>      XmpPacketWrapper packet = new XmpPacketWrapper();
>      XmpPackage custom = new XmpPackage("gd", "https://groupdocs.com");
>      custom.set("gd:Copyright", "Copyright (C) 2011-2024 GroupDocs. All Rights Reserved.");
>      custom.set("gd:CreationDate", new Date());
>      custom.set("gd:Company", XmpArray.from(new String[]{"Aspose", "GroupDocs"}, XmpArrayType.Ordered));
>      packet.addPackage(custom);
>      root.setXmpPackage(packet);
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPackage(String prefix, String namespaceUri) | Initializes a new instance of the  XmpPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPrefix() | Gets the xmlns prefix. |
| getNamespaceUri() | Gets the namespace URI. |
| getXmlNamespace() | Gets the XML namespace. |
| set(String name, String value) | Sets string property. |
| set(String name, int value) | Sets integer property. |
| set(String name, boolean value) | Sets boolean property. |
| set(String name, Date value) | Sets  DateTime  property. |
| set(String name, double value) | Sets double property. |
| remove(String name) | Removes the property with the specified name. |
| clear() | Removes all XMP properties. |
| set(String name, XmpValueBase value) | Sets the value inherited from  XmpValueBase  . |
| set(String name, XmpComplexType value) | Sets the value inherited from  XmpComplexType  . |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
| getXmpRepresentation() | Converts the XMP value to the XML representation. |
##### XmpPackage(String prefix, String namespaceUri)
```
public XmpPackage(String prefix, String namespaceUri)
```

Initializes a new instance of the  XmpPackage  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| prefix | java.lang.String | XMP prefix, for example dc:title. |
| namespaceUri | java.lang.String | Namespace uri. |

##### getPrefix()
```
public final String getPrefix()
```

Gets the xmlns prefix.

**Returns:**
java.lang.String - The prefix.
##### getNamespaceUri()
```
public final String getNamespaceUri()
```

Gets the namespace URI.

**Returns:**
java.lang.String - The namespace URI.
##### getXmlNamespace()
```
public final String getXmlNamespace()
```

Gets the XML namespace.

**Returns:**
java.lang.String - The XML namespace.
##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, int value)
```
public final void set(String name, int value)
```

Sets integer property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

##### set(String name, boolean value)
```
public final void set(String name, boolean value)
```

Sets boolean property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | boolean | XMP metadata property value. |

##### set(String name, Date value)
```
public final void set(String name, Date value)
```

Sets  DateTime  property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.util.Date | XMP metadata property value. |

##### set(String name, double value)
```
public final void set(String name, double value)
```

Sets double property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | double | XMP metadata property value. |

##### remove(String name)
```
public final boolean remove(String name)
```

Removes the property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |

**Returns:**
boolean - True if the specified metadata property is found and removed; otherwise, false.
##### clear()
```
public final void clear()
```

Removes all XMP properties.

##### set(String name, XmpValueBase value)
```
public final void set(String name, XmpValueBase value)
```

Sets the value inherited from  XmpValueBase  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpValueBase | XMP metadata property value. |

##### set(String name, XmpComplexType value)
```
public void set(String name, XmpComplexType value)
```

Sets the value inherited from  XmpComplexType  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts the XMP value to the XML representation.

**Returns:**
java.lang.String - A  string  representation of the XMP value.

### XmpPacketWrapper
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmppacketwrapper.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public class XmpPacketWrapper extends MetadataPackage implements IXmpType
```

Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta) | Initializes a new instance of the  XmpPacketWrapper  class. |
| XmpPacketWrapper() | Initializes a new instance of the  XmpPacketWrapper  class. |
#### Methods

| Method | Description |
| --- | --- |
| getHeaderPI() | Gets the header processing instruction. |
| setHeaderPI(XmpHeaderPI value) | Sets the header processing instruction. |
| getMeta() | Gets the XMP meta. |
| setMeta(XmpMeta value) | Sets the XMP meta. |
| getTrailerPI() | Gets the trailer processing instruction. |
| setTrailerPI(XmpTrailerPI value) | Sets the trailer processing instruction. |
| getPackages() | Gets array of  XmpPackage  inside XMP. |
| getPackageCount() | Gets the number of packages inside the XMP structure. |
| getSchemes() | Provides access to known XMP schemas. |
| addPackage(XmpPackage package_) | Adds the package. |
| getPackage(String namespaceUri) | Gets package by namespace uri. |
| containsPackage(String namespaceUri) | Determines whether package is exist in XMP wrapper. |
| removePackage(XmpPackage package_) | Removes the specified package. |
| clearPackages() | Removes all  XmpPackage  inside XMP. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)
```
public XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)
```

Initializes a new instance of the  XmpPacketWrapper  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| header | XmpHeaderPI | XMP header processing instruction. |
| trailer | XmpTrailerPI | XMP trailer processing instruction. |
| xmpMeta | XmpMeta | Instance of  XmpMeta . |

##### XmpPacketWrapper()
```
public XmpPacketWrapper()
```

Initializes a new instance of the  XmpPacketWrapper  class.

##### getHeaderPI()
```
public final XmpHeaderPI getHeaderPI()
```

Gets the header processing instruction.

**Returns:**
XmpHeaderPI - The header processing instruction.
##### setHeaderPI(XmpHeaderPI value)
```
public final void setHeaderPI(XmpHeaderPI value)
```

Sets the header processing instruction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpHeaderPI | The header processing instruction. |

##### getMeta()
```
public final XmpMeta getMeta()
```

Gets the XMP meta.

**Returns:**
XmpMeta - The XMP meta.
##### setMeta(XmpMeta value)
```
public final void setMeta(XmpMeta value)
```

Sets the XMP meta.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpMeta | The XMP meta. |

##### getTrailerPI()
```
public final XmpTrailerPI getTrailerPI()
```

Gets the trailer processing instruction.

**Returns:**
XmpTrailerPI - The trailer processing instruction.
##### setTrailerPI(XmpTrailerPI value)
```
public final void setTrailerPI(XmpTrailerPI value)
```

Sets the trailer processing instruction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTrailerPI | The trailer processing instruction. |

##### getPackages()
```
public final XmpPackage[] getPackages()
```

Gets array of  XmpPackage  inside XMP.

**Returns:**
com.groupdocs.metadata.core.XmpPackage[] - XMP packages.
##### getPackageCount()
```
public final int getPackageCount()
```

Gets the number of packages inside the XMP structure.

**Returns:**
int - The package count.
##### getSchemes()
```
public final XmpSchemes getSchemes()
```

Provides access to known XMP schemas.

**Returns:**
XmpSchemes - XMP schemes.
##### addPackage(XmpPackage package_)
```
public final void addPackage(XmpPackage package_)
```

Adds the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| package_ | XmpPackage |  |

##### getPackage(String namespaceUri)
```
public final XmpPackage getPackage(String namespaceUri)
```

Gets package by namespace uri.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | java.lang.String | Package schema uri. |

**Returns:**
XmpPackage - Appropriate  XmpPackage  if package found by  namespaceUri ; otherwise null.
##### containsPackage(String namespaceUri)
```
public final boolean containsPackage(String namespaceUri)
```

Determines whether package is exist in XMP wrapper.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | java.lang.String | Package namespace URI. |

**Returns:**
boolean -  true  if package found by  namespaceUri ; otherwise  false .
##### removePackage(XmpPackage package_)
```
public final void removePackage(XmpPackage package_)
```

Removes the specified package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| package_ | XmpPackage |  |

##### clearPackages()
```
public final void clearPackages()
```

Removes all  XmpPackage  inside XMP.

##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpPagedTextPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmppagedtextpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPagedTextPackage extends XmpPackage
```

Represents the XMP Paged-Text package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPagedTextPackage() | Initializes a new instance of the  XmpPagedTextPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getColorants() | Gets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| setColorants(XmpColorantBase[] value) | Sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| getFonts() | Gets an unordered array of fonts that are used in the document (including any in contained documents). |
| setFonts(XmpFont[] value) | Sets an unordered array of fonts that are used in the document (including any in contained documents). |
| getMaxPageSize() | Gets the size of the largest page in the document (including any in contained documents). |
| setMaxPageSize(XmpDimensions value) | Sets the size of the largest page in the document (including any in contained documents). |
| getNumberOfPages() | Gets the number of pages in the document. |
| setNumberOfPages(Integer value) | Sets the number of pages in the document. |
| getPlateNames() | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |
| setPlateNames(String[] value) | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |
| set(String name, String value) | Sets string property. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpPagedTextPackage()
```
public XmpPagedTextPackage()
```

Initializes a new instance of the  XmpPagedTextPackage  class.

##### getColorants()
```
public final XmpColorantBase[] getColorants()
```

Gets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).

**Returns:**
com.groupdocs.metadata.core.XmpColorantBase[] - An array of the colorants.
##### setColorants(XmpColorantBase[] value)
```
public final void setColorants(XmpColorantBase[] value)
```

Sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorantBase\[\] | An array of the colorants. |

##### getFonts()
```
public final XmpFont[] getFonts()
```

Gets an unordered array of fonts that are used in the document (including any in contained documents).

**Returns:**
com.groupdocs.metadata.core.XmpFont[] - An array of the fonts.
##### setFonts(XmpFont[] value)
```
public final void setFonts(XmpFont[] value)
```

Sets an unordered array of fonts that are used in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpFont\[\] | An array of the fonts. |

##### getMaxPageSize()
```
public final XmpDimensions getMaxPageSize()
```

Gets the size of the largest page in the document (including any in contained documents).

**Returns:**
XmpDimensions - The size of the largest page.
##### setMaxPageSize(XmpDimensions value)
```
public final void setMaxPageSize(XmpDimensions value)
```

Sets the size of the largest page in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDimensions | The size of the largest page. |

##### getNumberOfPages()
```
public final Integer getNumberOfPages()
```

Gets the number of pages in the document.

**Returns:**
java.lang.Integer - The number of pages.
##### setNumberOfPages(Integer value)
```
public final void setNumberOfPages(Integer value)
```

Sets the number of pages in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The number of pages. |

##### getPlateNames()
```
public final String[] getPlateNames()
```

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).

**Returns:**
java.lang.String[] - The plate names.
##### setPlateNames(String[] value)
```
public final void setPlateNames(String[] value)
```

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] |  |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpPdfPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmppdfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPdfPackage extends XmpPackage
```

Specifies properties used with Adobe PDF documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPdfPackage() | Initializes a new instance of the  XmpPdfPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getPdfVersion() | Gets the PDF file version. |
| setPdfVersion(String value) | Sets the PDF file version. |
| getProducer() | Gets the name of the tool that created the PDF document. |
| setProducer(String value) | Sets the name of the tool that created the PDF document. |
| isTrapped() | Gets a value indicating whether the document has been trapped. |
| setTrapped(Boolean value) | Sets a value indicating whether the document has been trapped. |
| set(String name, String value) | Sets string property. |
##### XmpPdfPackage()
```
public XmpPdfPackage()
```

Initializes a new instance of the  XmpPdfPackage  class.

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getPdfVersion()
```
public final String getPdfVersion()
```

Gets the PDF file version. For example, 1.0, 1.3 and so on.

**Returns:**
java.lang.String - The PDF version.
##### setPdfVersion(String value)
```
public final void setPdfVersion(String value)
```

Sets the PDF file version. For example, 1.0, 1.3 and so on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The PDF version. |

##### getProducer()
```
public final String getProducer()
```

Gets the name of the tool that created the PDF document.

**Returns:**
java.lang.String - The producer.
##### setProducer(String value)
```
public final void setProducer(String value)
```

Sets the name of the tool that created the PDF document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The producer. |

##### isTrapped()
```
public final Boolean isTrapped()
```

Gets a value indicating whether the document has been trapped.

**Returns:**
java.lang.Boolean -  true  if the document has been trapped; otherwise,  false .
##### setTrapped(Boolean value)
```
public final void setTrapped(Boolean value)
```

Sets a value indicating whether the document has been trapped.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the document has been trapped; otherwise,  false . |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpPhotoshopColorMode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpphotoshopcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpPhotoshopColorMode extends Enum<XmpPhotoshopColorMode> implements IEnumValue
```

Represents a color mode in  XmpPhotoshopPackage .
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | The bitmap color mode. |
| GrayScale | The gray scale color mode. |
| IndexedColor | The indexed color. |
| Rgb | The RGB color mode. |
| Cmyk | The CMYK color mode. |
| MultiChannel | The multi-channel color mode. |
| Duotone | The duo-tone color mode. |
| LabColor | The LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Bitmap
```
public static final XmpPhotoshopColorMode Bitmap
```

The bitmap color mode.

##### GrayScale
```
public static final XmpPhotoshopColorMode GrayScale
```

The gray scale color mode.

##### IndexedColor
```
public static final XmpPhotoshopColorMode IndexedColor
```

The indexed color.

##### Rgb
```
public static final XmpPhotoshopColorMode Rgb
```

The RGB color mode.

##### Cmyk
```
public static final XmpPhotoshopColorMode Cmyk
```

The CMYK color mode.

##### MultiChannel
```
public static final XmpPhotoshopColorMode MultiChannel
```

The multi-channel color mode.

##### Duotone
```
public static final XmpPhotoshopColorMode Duotone
```

The duo-tone color mode.

##### LabColor
```
public static final XmpPhotoshopColorMode LabColor
```

The LAB color mode.

##### values()
```
public static XmpPhotoshopColorMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpPhotoshopColorMode[]
##### valueOf(String name)
```
public static XmpPhotoshopColorMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpPhotoshopColorMode
##### getByRawValue(int rawValue)
```
public static XmpPhotoshopColorMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpPhotoshopColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpPhotoshopPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpphotoshoppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPhotoshopPackage extends XmpPackage
```

Represents Adobe Photoshop namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPhotoshopPackage() | Initializes a new instance of the  XmpPhotoshopPackage  class. |
#### Fields

| Field | Description |
| --- | --- |
| UrgencyMax | Urgency max value. |
| UrgencyMin | Urgency min value. |
#### Methods

| Method | Description |
| --- | --- |
| getAuthorsPosition() | Gets the by-line title. |
| setAuthorsPosition(String value) | Sets the by-line title. |
| getCaptionWriter() | Gets the writer/editor. |
| setCaptionWriter(String value) | Sets the writer/editor. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getCity() | Gets the city. |
| setCity(String value) | Sets the city. |
| getColorMode() | Gets the color mode. |
| setColorMode(XmpPhotoshopColorMode value) | Sets the color mode. |
| getCountry() | Gets the country. |
| setCountry(String value) | Sets the country. |
| getCredit() | Gets the credit. |
| setCredit(String value) | Sets the credit. |
| getDateCreated() | Gets the date the intellectual content of the document was created. |
| setDateCreated(Date value) | Sets the date the intellectual content of the document was created. |
| getHeadline() | Gets the headline. |
| setHeadline(String value) | Sets the headline. |
| getHistory() | Gets the history that appears in the FileInfo panel, if activated in the application preferences. |
| setHistory(String value) | Sets the history that appears in the FileInfo panel, if activated in the application preferences. |
| getIccProfile() | Gets the color profile, such as AppleRGB, AdobeRGB1998. |
| setIccProfile(String value) | Sets the color profile, such as AppleRGB, AdobeRGB1998. |
| getInstructions() | Gets the special instructions. |
| setInstructions(String value) | Sets the special instructions. |
| getSource() | Gets the source. |
| setSource(String value) | Sets the source. |
| getState() | Gets the province/state. |
| setState(String value) | Sets the province/state. |
| getSupplementalCategories() | Gets the supplemental categories. |
| setSupplementalCategories(String[] value) | Sets the supplemental categories. |
| getTransmissionReference() | Gets the original transmission reference. |
| setTransmissionReference(String value) | Sets the original transmission reference. |
| getUrgency() | Gets the urgency. |
| setUrgency(Integer value) | Sets the urgency. |
| set(String name, String value) | Sets string property. |
##### XmpPhotoshopPackage()
```
public XmpPhotoshopPackage()
```

Initializes a new instance of the  XmpPhotoshopPackage  class.

##### UrgencyMax
```
public static final int UrgencyMax
```

Urgency max value.

##### UrgencyMin
```
public static final int UrgencyMin
```

Urgency min value.

##### getAuthorsPosition()
```
public final String getAuthorsPosition()
```

Gets the by-line title.

**Returns:**
java.lang.String - The authors position.
##### setAuthorsPosition(String value)
```
public final void setAuthorsPosition(String value)
```

Sets the by-line title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The authors position. |

##### getCaptionWriter()
```
public final String getCaptionWriter()
```

Gets the writer/editor.

**Returns:**
java.lang.String - The caption writer.
##### setCaptionWriter(String value)
```
public final void setCaptionWriter(String value)
```

Sets the writer/editor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The caption writer. |

##### getCategory()
```
public final String getCategory()
```

Gets the category. Limited to 3 7-bit ASCII characters.

**Returns:**
java.lang.String - The category. Limited to 3 ASCII characters.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category. Limited to 3 7-bit ASCII characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. Limited to 3 ASCII characters. |

##### getCity()
```
public final String getCity()
```

Gets the city.

**Returns:**
java.lang.String - The city.
##### setCity(String value)
```
public final void setCity(String value)
```

Sets the city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The city. |

##### getColorMode()
```
public final XmpPhotoshopColorMode getColorMode()
```

Gets the color mode.

**Returns:**
XmpPhotoshopColorMode - The color mode.
##### setColorMode(XmpPhotoshopColorMode value)
```
public final void setColorMode(XmpPhotoshopColorMode value)
```

Sets the color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPhotoshopColorMode | The color mode. |

##### getCountry()
```
public final String getCountry()
```

Gets the country.

**Returns:**
java.lang.String - The country.
##### setCountry(String value)
```
public final void setCountry(String value)
```

Sets the country.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The country. |

##### getCredit()
```
public final String getCredit()
```

Gets the credit.

**Returns:**
java.lang.String - The credit.
##### setCredit(String value)
```
public final void setCredit(String value)
```

Sets the credit.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The credit. |

##### getDateCreated()
```
public final Date getDateCreated()
```

Gets the date the intellectual content of the document was created.

**Returns:**
java.util.Date - The created date of the document.
##### setDateCreated(Date value)
```
public final void setDateCreated(Date value)
```

Sets the date the intellectual content of the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The created date of the document. |

##### getHeadline()
```
public final String getHeadline()
```

Gets the headline.

**Returns:**
java.lang.String - The headline.
##### setHeadline(String value)
```
public final void setHeadline(String value)
```

Sets the headline.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The headline. |

##### getHistory()
```
public final String getHistory()
```

Gets the history that appears in the FileInfo panel, if activated in the application preferences.

**Returns:**
java.lang.String - The history.
##### setHistory(String value)
```
public final void setHistory(String value)
```

Sets the history that appears in the FileInfo panel, if activated in the application preferences.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The history. |

##### getIccProfile()
```
public final String getIccProfile()
```

Gets the color profile, such as AppleRGB, AdobeRGB1998.

**Returns:**
java.lang.String - The ICC profile.
##### setIccProfile(String value)
```
public final void setIccProfile(String value)
```

Sets the color profile, such as AppleRGB, AdobeRGB1998.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The ICC profile. |

##### getInstructions()
```
public final String getInstructions()
```

Gets the special instructions.

**Returns:**
java.lang.String - The special instructions.
##### setInstructions(String value)
```
public final void setInstructions(String value)
```

Sets the special instructions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The special instructions. |

##### getSource()
```
public final String getSource()
```

Gets the source.

**Returns:**
java.lang.String - The source.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets the source.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The source. |

##### getState()
```
public final String getState()
```

Gets the province/state.

**Returns:**
java.lang.String - The province/state.
##### setState(String value)
```
public final void setState(String value)
```

Sets the province/state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The province/state. |

##### getSupplementalCategories()
```
public final String[] getSupplementalCategories()
```

Gets the supplemental categories.

**Returns:**
java.lang.String[] - The supplemental categories.
##### setSupplementalCategories(String[] value)
```
public final void setSupplementalCategories(String[] value)
```

Sets the supplemental categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The supplemental categories. |

##### getTransmissionReference()
```
public final String getTransmissionReference()
```

Gets the original transmission reference.

**Returns:**
java.lang.String - The transmission reference.
##### setTransmissionReference(String value)
```
public final void setTransmissionReference(String value)
```

Sets the original transmission reference.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The transmission reference. |

##### getUrgency()
```
public final Integer getUrgency()
```

Gets the urgency.

**Returns:**
java.lang.Integer - The urgency.

Valid range is 1-8.
##### setUrgency(Integer value)
```
public final void setUrgency(Integer value)
```

Sets the urgency.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The urgency.

Valid range is 1-8. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpRational
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmprational.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpRational extends XmpValueBase
```

Represents XMP XmpRational.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRational(long numerator, long denominator) | Initializes a new instance of the  XmpRational  class. |
| XmpRational(String value) | Initializes a new instance of the  XmpBoolean  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets numerator. |
| getDenominator() | Gets denominator |
| getDoubleValue() | Gets value of rational type presented in double format. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpRational(long numerator, long denominator)
```
public XmpRational(long numerator, long denominator)
```

Initializes a new instance of the  XmpRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | long | The numerator. |
| denominator | long | The denominator. |

##### XmpRational(String value)
```
public XmpRational(String value)
```

Initializes a new instance of the  XmpBoolean  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getNumerator()
```
public final long getNumerator()
```

Gets numerator.

**Returns:**
long - The numerator.
##### getDenominator()
```
public final long getDenominator()
```

Gets denominator

**Returns:**
long - The denominator.
##### getDoubleValue()
```
public final double getDoubleValue()
```

Gets value of rational type presented in double format.

**Returns:**
double - Double value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpReal
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpreal.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpReal extends XmpValueBase
```

Represents XMP Real.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpReal(double value) | Initializes a new instance of the  XmpReal  class. |
| XmpReal(String value) | Initializes a new instance of the  XmpReal  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpReal(double value)
```
public XmpReal(double value)
```

Initializes a new instance of the  XmpReal  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Double value. |

##### XmpReal(String value)
```
public XmpReal(String value)
```

Initializes a new instance of the  XmpReal  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final double getValue()
```

Gets the value.

**Returns:**
double - Double value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpRenditionClass
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmprenditionclass.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase, com.groupdocs.metadata.core.XmpText
```
public final class XmpRenditionClass extends XmpText
```

Represents XMP RenditionClass.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRenditionClass(String[] tokens) | Initializes a new instance of the  XmpRenditionClass  class. |
#### Fields

| Field | Description |
| --- | --- |
| Default | The master resource; no additional tokens allowed. |
| Draft | A review rendition. |
| LowRes | A low-resolution, full-size stand-in. |
| Proof | A review proof. |
| Screen | Screen resolution or Web rendition. |
| Thumbnail | A simplified or reduced preview. |
##### XmpRenditionClass(String[] tokens)
```
public XmpRenditionClass(String[] tokens)
```

Initializes a new instance of the  XmpRenditionClass  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tokens | java.lang.String[] | The token. |

##### Default
```
public static final String Default
```

The master resource; no additional tokens allowed.

##### Draft
```
public static final String Draft
```

A review rendition.

##### LowRes
```
public static final String LowRes
```

A low-resolution, full-size stand-in.

##### Proof
```
public static final String Proof
```

A review proof.

##### Screen
```
public static final String Screen
```

Screen resolution or Web rendition.

##### Thumbnail
```
public static final String Thumbnail
```

A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace.

### XmpResourceEvent
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpresourceevent.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpResourceEvent extends XmpComplexType
```

Represents a high-level event that occurred in the processing of a resource.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpResourceEvent() | Initializes a new instance of the  XmpResourceEvent  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAction() | Gets the action that occurred. |
| setAction(String value) | Sets the action that occurred. |
| getChanged() | Gets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| setChanged(String value) | Sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| getInstanceID() | Gets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| setInstanceID(String value) | Sets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| getParameters() | Gets the additional description of the action. |
| setParameters(String value) | Sets the additional description of the action. |
| getSoftwareAgent() | Gets the software agent that performed the action. |
| setSoftwareAgent(String value) | Sets the software agent that performed the action. |
| getWhen() | Gets the timestamp of when the action occurred. |
| setWhen(Date value) | Sets the timestamp of when the action occurred. |
##### XmpResourceEvent()
```
public XmpResourceEvent()
```

Initializes a new instance of the  XmpResourceEvent  class.

##### getAction()
```
public final String getAction()
```

Gets the action that occurred.

**Returns:**
java.lang.String - The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version\_updated, printed, published, managed, produced, resized, saved. New values should be verbs in the past tense.
##### setAction(String value)
```
public final void setAction(String value)
```

Sets the action that occurred.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version\_updated, printed, published, managed, produced, resized, saved. New values should be verbs in the past tense. |

##### getChanged()
```
public final String getChanged()
```

Gets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.

**Returns:**
java.lang.String - A semicolon-delimited list of the parts of the resource that were changed since the previous event history.
##### setChanged(String value)
```
public final void setChanged(String value)
```

Sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A semicolon-delimited list of the parts of the resource that were changed since the previous event history. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the value of the xmpMM:InstanceID property for the modified (output) resource.

**Returns:**
java.lang.String - The value of the xmpMM:InstanceID property for the modified (output) resource.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the value of the xmpMM:InstanceID property for the modified (output) resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:InstanceID property for the modified (output) resource. |

##### getParameters()
```
public final String getParameters()
```

Gets the additional description of the action.

**Returns:**
java.lang.String - The Additional description of the action.
##### setParameters(String value)
```
public final void setParameters(String value)
```

Sets the additional description of the action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Additional description of the action. |

##### getSoftwareAgent()
```
public final String getSoftwareAgent()
```

Gets the software agent that performed the action.

**Returns:**
java.lang.String - The software agent that performed the action.
##### setSoftwareAgent(String value)
```
public final void setSoftwareAgent(String value)
```

Sets the software agent that performed the action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The software agent that performed the action. |

##### getWhen()
```
public final Date getWhen()
```

Gets the timestamp of when the action occurred.

**Returns:**
java.util.Date - The timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file.
##### setWhen(Date value)
```
public final void setWhen(Date value)
```

Sets the timestamp of when the action occurred.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file. |

### XmpResourceRef
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpresourceref.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpResourceRef extends XmpComplexType
```

Represents a multiple part reference to a resource.

 Used to indicate prior versions, originals of renditions, originals for derived documents, and so on.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpResourceRef() | Initializes a new instance of the  XmpResourceRef  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAlternatePaths() | Gets the referenced resource\\u2019s fallback file paths or URLs. |
| setAlternatePaths(String[] value) | Sets the referenced resource\\u2019s fallback file paths or URLs. |
| getDocumentID() | Gets the value of the xmpMM:DocumentID property from the referenced resource. |
| setDocumentID(String value) | Sets the value of the xmpMM:DocumentID property from the referenced resource. |
| getFilePath() | Gets the referenced resource\\u2019s file path or URL. |
| setFilePath(String value) | Sets the referenced resource\\u2019s file path or URL. |
| getInstanceID() | Gets the value of the xmpMM:InstanceID property from the referenced resource. |
| setInstanceID(String value) | Sets the value of the xmpMM:InstanceID property from the referenced resource. |
| getLastModifyDate() | Gets the value of stEvt:when for the last time the file was written. |
| setLastModifyDate(Date value) | Sets the value of stEvt:when for the last time the file was written. |
| getManager() | Gets the referenced resource\\u2019s xmpMM:Manager. |
| setManager(String value) | Sets the referenced resource\\u2019s xmpMM:Manager. |
| getManagerVariant() | Gets the referenced resource\\u2019s xmpMM:Manager. |
| setManagerVariant(String value) | Sets the referenced resource\\u2019s xmpMM:Manager. |
| getManageTo() | Gets the referenced resource\\u2019s xmpMM:ManageTo. |
| setManageTo(String value) | Sets the referenced resource\\u2019s xmpMM:ManageTo. |
| getManageUI() | Gets the referenced resource\\u2019s xmpMM:ManageUI. |
| setManageUI(String value) | Sets the referenced resource\\u2019s xmpMM:ManageUI. |
| getPartMapping() | Gets the name or URI of a mapping function used to map the fromPart to the toPart. |
| setPartMapping(String value) | Sets the name or URI of a mapping function used to map the fromPart to the toPart. |
| getRenditionClass() | Gets the value of the xmpMM:RenditionClass property from the referenced resource. |
| setRenditionClass(String value) | Sets the value of the xmpMM:RenditionClass property from the referenced resource. |
| getRenditionParams() | Gets the value of the xmpMM:RenditionParams property from the referenced resource. |
| setRenditionParams(String value) | Sets the value of the xmpMM:RenditionParams property from the referenced resource. |
| getVersionID() | Gets the value of the xmpMM:RenditionParams property from the referenced resource. |
| setVersionID(String value) | Sets the value of the xmpMM:RenditionParams property from the referenced resource. |
##### XmpResourceRef()
```
public XmpResourceRef()
```

Initializes a new instance of the  XmpResourceRef  class.

##### getAlternatePaths()
```
public final String[] getAlternatePaths()
```

Gets the referenced resource\\u2019s fallback file paths or URLs.

**Returns:**
java.lang.String[] - The referenced resource\\u2019s fallback file paths or URLs. The sequence order is the recommended order in attempting to locate the resource.
##### setAlternatePaths(String[] value)
```
public final void setAlternatePaths(String[] value)
```

Sets the referenced resource\\u2019s fallback file paths or URLs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The referenced resource\\u2019s fallback file paths or URLs. The sequence order is the recommended order in attempting to locate the resource. |

##### getDocumentID()
```
public final String getDocumentID()
```

Gets the value of the xmpMM:DocumentID property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:DocumentID property from the referenced resource.
##### setDocumentID(String value)
```
public final void setDocumentID(String value)
```

Sets the value of the xmpMM:DocumentID property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:DocumentID property from the referenced resource. |

##### getFilePath()
```
public final String getFilePath()
```

Gets the referenced resource\\u2019s file path or URL.

**Returns:**
java.lang.String - The referenced resource\\u2019s file path or URL.
##### setFilePath(String value)
```
public final void setFilePath(String value)
```

Sets the referenced resource\\u2019s file path or URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s file path or URL. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the value of the xmpMM:InstanceID property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:InstanceID property from the referenced resource.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the value of the xmpMM:InstanceID property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:InstanceID property from the referenced resource. |

##### getLastModifyDate()
```
public final Date getLastModifyDate()
```

Gets the value of stEvt:when for the last time the file was written.

**Returns:**
java.util.Date - The value of stEvt:when for the last time the file was written.
##### setLastModifyDate(Date value)
```
public final void setLastModifyDate(Date value)
```

Sets the value of stEvt:when for the last time the file was written.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The value of stEvt:when for the last time the file was written. |

##### getManager()
```
public final String getManager()
```

Gets the referenced resource\\u2019s xmpMM:Manager.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:Manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the referenced resource\\u2019s xmpMM:Manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:Manager. |

##### getManagerVariant()
```
public final String getManagerVariant()
```

Gets the referenced resource\\u2019s xmpMM:Manager.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:Manager.
##### setManagerVariant(String value)
```
public final void setManagerVariant(String value)
```

Sets the referenced resource\\u2019s xmpMM:Manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:Manager. |

##### getManageTo()
```
public final String getManageTo()
```

Gets the referenced resource\\u2019s xmpMM:ManageTo.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:ManageTo.
##### setManageTo(String value)
```
public final void setManageTo(String value)
```

Sets the referenced resource\\u2019s xmpMM:ManageTo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:ManageTo. |

##### getManageUI()
```
public final String getManageUI()
```

Gets the referenced resource\\u2019s xmpMM:ManageUI.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:ManageUI.
##### setManageUI(String value)
```
public final void setManageUI(String value)
```

Sets the referenced resource\\u2019s xmpMM:ManageUI.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:ManageUI. |

##### getPartMapping()
```
public final String getPartMapping()
```

Gets the name or URI of a mapping function used to map the fromPart to the toPart.

**Returns:**
java.lang.String - The name or URI of a mapping function used to map the fromPart to the toPart. The default for time mappings is "linear".
##### setPartMapping(String value)
```
public final void setPartMapping(String value)
```

Sets the name or URI of a mapping function used to map the fromPart to the toPart.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name or URI of a mapping function used to map the fromPart to the toPart. The default for time mappings is "linear". |

##### getRenditionClass()
```
public final String getRenditionClass()
```

Gets the value of the xmpMM:RenditionClass property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionClass property from the referenced resource.
##### setRenditionClass(String value)
```
public final void setRenditionClass(String value)
```

Sets the value of the xmpMM:RenditionClass property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionClass property from the referenced resource. |

##### getRenditionParams()
```
public final String getRenditionParams()
```

Gets the value of the xmpMM:RenditionParams property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionParams property from the referenced resource.
##### setRenditionParams(String value)
```
public final void setRenditionParams(String value)
```

Sets the value of the xmpMM:RenditionParams property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionParams property from the referenced resource. |

##### getVersionID()
```
public final String getVersionID()
```

Gets the value of the xmpMM:RenditionParams property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionParams property from the referenced resource.
##### setVersionID(String value)
```
public final void setVersionID(String value)
```

Sets the value of the xmpMM:RenditionParams property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionParams property from the referenced resource. |

### XmpRightsManagementPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmprightsmanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpRightsManagementPackage extends XmpPackage
```

Represents XMP Rights Management namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRightsManagementPackage() | Initializes a new instance of the  XmpRightsManagementPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Gets the Web URL for a rights management certificate. |
| setCertificate(String value) | Sets the Web URL for a rights management certificate. |
| getMarked() | Gets a value indicating whether this is a rights-managed resource. |
| setMarked(Boolean value) | Sets a value indicating whether this is a rights-managed resource. |
| getOwners() | Gets the legal owners. |
| setOwners(String[] value) | Sets the legal owners. |
| getUsageTerms() | Gets the instructions on how the resource can be legally used, given in a variety of languages. |
| setUsageTerms(XmpLangAlt value) | Sets the instructions on how the resource can be legally used, given in a variety of languages. |
| getWebStatement() | Gets the Web URL for a statement of the ownership and usage rights for this resource. |
| setWebStatement(String value) | Sets the Web URL for a statement of the ownership and usage rights for this resource. |
| set(String name, String value) | Sets string property. |
##### XmpRightsManagementPackage()
```
public XmpRightsManagementPackage()
```

Initializes a new instance of the  XmpRightsManagementPackage  class.

##### getCertificate()
```
public final String getCertificate()
```

Gets the Web URL for a rights management certificate.

**Returns:**
java.lang.String - The Web URL for a rights management certificate.
##### setCertificate(String value)
```
public final void setCertificate(String value)
```

Sets the Web URL for a rights management certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Web URL for a rights management certificate. |

##### getMarked()
```
public final Boolean getMarked()
```

Gets a value indicating whether this is a rights-managed resource.

**Returns:**
java.lang.Boolean -  true  if the resource is rights-managed; otherwise  false . When false, indicates that this is a public-domain resource. Omit if the state is unknown.
##### setMarked(Boolean value)
```
public final void setMarked(Boolean value)
```

Sets a value indicating whether this is a rights-managed resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the resource is rights-managed; otherwise  false . When false, indicates that this is a public-domain resource. Omit if the state is unknown. |

##### getOwners()
```
public final String[] getOwners()
```

Gets the legal owners.

**Returns:**
java.lang.String[] - The legal owners.
##### setOwners(String[] value)
```
public final void setOwners(String[] value)
```

Sets the legal owners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The legal owners. |

##### getUsageTerms()
```
public final XmpLangAlt getUsageTerms()
```

Gets the instructions on how the resource can be legally used, given in a variety of languages.

**Returns:**
XmpLangAlt - The instructions on how the resource can be legally used, given in a variety of languages.
##### setUsageTerms(XmpLangAlt value)
```
public final void setUsageTerms(XmpLangAlt value)
```

Sets the instructions on how the resource can be legally used, given in a variety of languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The instructions on how the resource can be legally used, given in a variety of languages. |

##### getWebStatement()
```
public final String getWebStatement()
```

Gets the Web URL for a statement of the ownership and usage rights for this resource.

**Returns:**
java.lang.String - The Web URL for a statement of the ownership and usage rights for this resource.
##### setWebStatement(String value)
```
public final void setWebStatement(String value)
```

Sets the Web URL for a statement of the ownership and usage rights for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Web URL for a statement of the ownership and usage rights for this resource. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpSchemes
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpschemes.md

**Inheritance:**
java.lang.Object
```
public final class XmpSchemes
```

Provides access to known XMP schemes.
#### Methods

| Method | Description |
| --- | --- |
| getCameraRaw() | Gets the Camera Raw scheme. |
| setCameraRaw(XmpCameraRawPackage value) | Sets the Camera Raw scheme. |
| getDublinCore() | Gets the Dublin Core scheme. |
| setDublinCore(XmpDublinCorePackage value) | Sets the Dublin Core scheme. |
| getPagedText() | Gets the PagedText scheme. |
| setPagedText(XmpPagedTextPackage value) | Sets the PagedText scheme. |
| getPdf() | Gets the PDF scheme. |
| setPdf(XmpPdfPackage value) | Sets the PDF scheme. |
| getPhotoshop() | Gets the Photoshop scheme. |
| setPhotoshop(XmpPhotoshopPackage value) | Sets the Photoshop scheme. |
| getXmpBasic() | Gets the XmpBasic scheme. |
| setXmpBasic(XmpBasicPackage value) | Sets the XmpBasic scheme. |
| getXmpDynamicMedia() | Gets the XmpDynamicMedia scheme. |
| setXmpDynamicMedia(XmpDynamicMediaPackage value) | Sets the XmpDynamicMedia scheme. |
| getXmpMediaManagement() | Gets the XmpMediaManagement schema. |
| setXmpMediaManagement(XmpMediaManagementPackage value) | Sets the XmpMediaManagement schema. |
| getXmpRightsManagement() | Gets the XmpRightsManagement schema. |
| setXmpRightsManagement(XmpRightsManagementPackage value) | Sets the XmpRightsManagement schema. |
| getBasicJobTicket() | Gets the BasicJobTicket scheme. |
| setBasicJobTicket(XmpBasicJobTicketPackage value) | Sets the BasicJobTicket scheme. |
##### getCameraRaw()
```
public final XmpCameraRawPackage getCameraRaw()
```

Gets the Camera Raw scheme.

**Returns:**
XmpCameraRawPackage - The camera raw namespace.
##### setCameraRaw(XmpCameraRawPackage value)
```
public final void setCameraRaw(XmpCameraRawPackage value)
```

Sets the Camera Raw scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpCameraRawPackage | The camera raw namespace. |

##### getDublinCore()
```
public final XmpDublinCorePackage getDublinCore()
```

Gets the Dublin Core scheme.

**Returns:**
XmpDublinCorePackage - The dublin core namespace.
##### setDublinCore(XmpDublinCorePackage value)
```
public final void setDublinCore(XmpDublinCorePackage value)
```

Sets the Dublin Core scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDublinCorePackage | The dublin core namespace. |

##### getPagedText()
```
public final XmpPagedTextPackage getPagedText()
```

Gets the PagedText scheme.

**Returns:**
XmpPagedTextPackage - The paged text namespace.
##### setPagedText(XmpPagedTextPackage value)
```
public final void setPagedText(XmpPagedTextPackage value)
```

Sets the PagedText scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPagedTextPackage | The paged text namespace. |

##### getPdf()
```
public final XmpPdfPackage getPdf()
```

Gets the PDF scheme.

**Returns:**
XmpPdfPackage - The PDF namespace.
##### setPdf(XmpPdfPackage value)
```
public final void setPdf(XmpPdfPackage value)
```

Sets the PDF scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPdfPackage | The PDF namespace. |

##### getPhotoshop()
```
public final XmpPhotoshopPackage getPhotoshop()
```

Gets the Photoshop scheme.

**Returns:**
XmpPhotoshopPackage - The photoshop namespace.
##### setPhotoshop(XmpPhotoshopPackage value)
```
public final void setPhotoshop(XmpPhotoshopPackage value)
```

Sets the Photoshop scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPhotoshopPackage | The photoshop namespace. |

##### getXmpBasic()
```
public final XmpBasicPackage getXmpBasic()
```

Gets the XmpBasic scheme.

**Returns:**
XmpBasicPackage - The XMP basic namespace.
##### setXmpBasic(XmpBasicPackage value)
```
public final void setXmpBasic(XmpBasicPackage value)
```

Sets the XmpBasic scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpBasicPackage | The XMP basic namespace. |

##### getXmpDynamicMedia()
```
public final XmpDynamicMediaPackage getXmpDynamicMedia()
```

Gets the XmpDynamicMedia scheme.

**Returns:**
XmpDynamicMediaPackage - The XMP dynamic media namespace.
##### setXmpDynamicMedia(XmpDynamicMediaPackage value)
```
public final void setXmpDynamicMedia(XmpDynamicMediaPackage value)
```

Sets the XmpDynamicMedia scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDynamicMediaPackage | The XMP dynamic media namespace. |

##### getXmpMediaManagement()
```
public final XmpMediaManagementPackage getXmpMediaManagement()
```

Gets the XmpMediaManagement schema.

**Returns:**
XmpMediaManagementPackage - The XMP media management namespace.
##### setXmpMediaManagement(XmpMediaManagementPackage value)
```
public final void setXmpMediaManagement(XmpMediaManagementPackage value)
```

Sets the XmpMediaManagement schema.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpMediaManagementPackage | The XMP media management namespace. |

##### getXmpRightsManagement()
```
public final XmpRightsManagementPackage getXmpRightsManagement()
```

Gets the XmpRightsManagement schema.

**Returns:**
XmpRightsManagementPackage - The XMP rights management namespace.
##### setXmpRightsManagement(XmpRightsManagementPackage value)
```
public final void setXmpRightsManagement(XmpRightsManagementPackage value)
```

Sets the XmpRightsManagement schema.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRightsManagementPackage | The XMP rights management namespace. |

##### getBasicJobTicket()
```
public final XmpBasicJobTicketPackage getBasicJobTicket()
```

Gets the BasicJobTicket scheme.

**Returns:**
XmpBasicJobTicketPackage - The XMP job ticket namespace.
##### setBasicJobTicket(XmpBasicJobTicketPackage value)
```
public final void setBasicJobTicket(XmpBasicJobTicketPackage value)
```

Sets the BasicJobTicket scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpBasicJobTicketPackage | The XMP job ticket namespace. |

### XmpText
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmptext.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpText extends XmpValueBase
```

Represents XMP Text basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpText(String value) | Initializes a new instance of the  XmpText  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpText(String value)
```
public XmpText(String value)
```

Initializes a new instance of the  XmpText  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final String getValue()
```

Gets the value.

**Returns:**
java.lang.String - Text value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpThumbnail
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpthumbnail.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpThumbnail extends XmpComplexType
```

Represents a thumbnail image for a file.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpThumbnail() | Initializes a new instance of the  XmpThumbnail  class. |
| XmpThumbnail(int width, int height) | Initializes a new instance of the  XmpThumbnail  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the image width in pixels. |
| setWidth(Integer value) | Sets the image width in pixels. |
| getHeight() | Gets the image height in pixels. |
| setHeight(Integer value) | Sets the image height in pixels. |
| getImageBase64() | Gets the full thumbnail image data, converted to base 64 notation. |
| setImageBase64(String value) | Sets the full thumbnail image data, converted to base 64 notation. |
| getImageData() | Gets the image data. |
| getFormat() | Gets the image format. |
| setFormat(String value) | Sets the image format. |
##### XmpThumbnail()
```
public XmpThumbnail()
```

Initializes a new instance of the  XmpThumbnail  class.

##### XmpThumbnail(int width, int height)
```
public XmpThumbnail(int width, int height)
```

Initializes a new instance of the  XmpThumbnail  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width. |
| height | int | The height. |

##### getWidth()
```
public final Integer getWidth()
```

Gets the image width in pixels.

**Returns:**
java.lang.Integer - The thumbnail width.
##### setWidth(Integer value)
```
public final void setWidth(Integer value)
```

Sets the image width in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The thumbnail width. |

##### getHeight()
```
public final Integer getHeight()
```

Gets the image height in pixels.

**Returns:**
java.lang.Integer - The thumbnail height.
##### setHeight(Integer value)
```
public final void setHeight(Integer value)
```

Sets the image height in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The thumbnail height. |

##### getImageBase64()
```
public final String getImageBase64()
```

Gets the full thumbnail image data, converted to base 64 notation.

**Returns:**
java.lang.String - The full thumbnail image data, converted to base 64 notation.
##### setImageBase64(String value)
```
public final void setImageBase64(String value)
```

Sets the full thumbnail image data, converted to base 64 notation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The full thumbnail image data, converted to base 64 notation. |

##### getImageData()
```
public final byte[] getImageData()
```

Gets the image data.

**Returns:**
byte[] - The image data.
##### getFormat()
```
public final String getFormat()
```

Gets the image format. Defined value: JPEG.

**Returns:**
java.lang.String - The thumbnail format.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the image format. Defined value: JPEG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The thumbnail format. |

### XmpTime
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmptime.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpTime extends XmpComplexType
```

Representation of a time value in seconds.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTime() | Initializes a new instance of the  XmpTime  class. |
| XmpTime(XmpRational scale, int value) | Initializes a new instance of the  XmpTime  class. |
#### Methods

| Method | Description |
| --- | --- |
| getScale() | Gets the scale for the time value. |
| setScale(XmpRational value) | Sets the scale for the time value. |
| getValue() | Gets the time value in the specified scale. |
| setValue(Integer value) | Sets the time value in the specified scale. |
##### XmpTime()
```
public XmpTime()
```

Initializes a new instance of the  XmpTime  class.

##### XmpTime(XmpRational scale, int value)
```
public XmpTime(XmpRational scale, int value)
```

Initializes a new instance of the  XmpTime  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| scale | XmpRational | The scale. |
| value | int | The value. |

##### getScale()
```
public final XmpRational getScale()
```

Gets the scale for the time value.

**Returns:**
XmpRational - The scale for the time value. For NTSC, use 1001/30000, or the less accurate 100/2997.

 For PAL, use 1/25.
##### setScale(XmpRational value)
```
public final void setScale(XmpRational value)
```

Sets the scale for the time value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The scale for the time value. For NTSC, use 1001/30000, or the less accurate 100/2997.

 For PAL, use 1/25. |

##### getValue()
```
public final Integer getValue()
```

Gets the time value in the specified scale.

**Returns:**
java.lang.Integer - The time value in the specified scale.
##### setValue(Integer value)
```
public final void setValue(Integer value)
```

Sets the time value in the specified scale.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The time value in the specified scale. |

### XmpTimecode
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmptimecode.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpTimecode extends XmpComplexType
```

Represents a timecode value in a video.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTimecode() | Initializes a new instance of the  XmpTimecode  class. |
| XmpTimecode(XmpTimeFormat format, String timeValue) | Initializes a new instance of the  XmpTimecode  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTimeFormat() | Gets the format used in the time value. |
| setTimeFormat(String value) | Sets the format used in the time value. |
| getTimeValue() | Gets the time value in the specified format. |
| setTimeValue(String value) | Sets the time value in the specified format. |
| setTimeFormat(XmpTimeFormat timeFormat) | Sets the time format. |
##### XmpTimecode()
```
public XmpTimecode()
```

Initializes a new instance of the  XmpTimecode  class.

##### XmpTimecode(XmpTimeFormat format, String timeValue)
```
public XmpTimecode(XmpTimeFormat format, String timeValue)
```

Initializes a new instance of the  XmpTimecode  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | XmpTimeFormat | Time format. |
| timeValue | java.lang.String | Time value. |

##### getTimeFormat()
```
public final String getTimeFormat()
```

Gets the format used in the time value.

**Returns:**
java.lang.String - The format used in the timeValue. One of: 24Timecode, 25Timecode, 2997DropTimecode (semicolon delimiter), 2997NonDropTimecode, 30Timecode, 50Timecode, 5994DropTimecode (semicolon delimiter), 5994NonDropTimecode, 60Timecode, 23976Timecode.
##### setTimeFormat(String value)
```
public final void setTimeFormat(String value)
```

Sets the format used in the time value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The format used in the timeValue. One of: 24Timecode, 25Timecode, 2997DropTimecode (semicolon delimiter), 2997NonDropTimecode, 30Timecode, 50Timecode, 5994DropTimecode (semicolon delimiter), 5994NonDropTimecode, 60Timecode, 23976Timecode. |

##### getTimeValue()
```
public final String getTimeValue()
```

Gets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

**Returns:**
java.lang.String - The time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff
##### setTimeValue(String value)
```
public final void setTimeValue(String value)
```

Sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff |

##### setTimeFormat(XmpTimeFormat timeFormat)
```
public final void setTimeFormat(XmpTimeFormat timeFormat)
```

Sets the time format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| timeFormat | XmpTimeFormat | The time format. |

### XmpTimeFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmptimeformat.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpTimeFormat extends XmpClosedChoice<String>
```

Represents time format in  XmpTimecode .
#### Methods

| Method | Description |
| --- | --- |
| getTimecode24() | Gets 24Timecode. |
| getTimecode25() | Gets 25Timecode. |
| getDropTimecode2997() | Gets 2997DropTimecode. |
| getNonDropTimecode2997() | Gets 2997NonDropTimecode. |
| getTimecode30() | Gets 30Timecode. |
| getTimecode50() | Gets 50Timecode. |
| getDropTimecode5994() | Gets 5994DropTimecode. |
| getNonDropTimecode5994() | Gets 5994NonDropTimecode. |
| getTimecode60() | Gets 60Timecode. |
| getTimecode23976() | Gets 23976Timecode. |
##### getTimecode24()
```
public static XmpTimeFormat getTimecode24()
```

Gets 24Timecode.

**Returns:**
XmpTimeFormat - The 24Timecode.
##### getTimecode25()
```
public static XmpTimeFormat getTimecode25()
```

Gets 25Timecode.

**Returns:**
XmpTimeFormat - The 25Timecode.
##### getDropTimecode2997()
```
public static XmpTimeFormat getDropTimecode2997()
```

Gets 2997DropTimecode.

**Returns:**
XmpTimeFormat - The drop timecode2997.
##### getNonDropTimecode2997()
```
public static XmpTimeFormat getNonDropTimecode2997()
```

Gets 2997NonDropTimecode.

**Returns:**
XmpTimeFormat
##### getTimecode30()
```
public static XmpTimeFormat getTimecode30()
```

Gets 30Timecode.

**Returns:**
XmpTimeFormat - The 30Timecode.
##### getTimecode50()
```
public static XmpTimeFormat getTimecode50()
```

Gets 50Timecode.

**Returns:**
XmpTimeFormat - The 50Timecode.
##### getDropTimecode5994()
```
public static XmpTimeFormat getDropTimecode5994()
```

Gets 5994DropTimecode.

**Returns:**
XmpTimeFormat - The 5994DropTimecode.
##### getNonDropTimecode5994()
```
public static XmpTimeFormat getNonDropTimecode5994()
```

Gets 5994NonDropTimecode.

**Returns:**
XmpTimeFormat - The 5994NonDropTimecode.
##### getTimecode60()
```
public static XmpTimeFormat getTimecode60()
```

Gets 60Timecode.

**Returns:**
XmpTimeFormat - The 60Timecode.
##### getTimecode23976()
```
public static XmpTimeFormat getTimecode23976()
```

Gets 23976Timecode.

**Returns:**
XmpTimeFormat - The 23976Timecode.

### XmpTrailerPI
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmptrailerpi.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpTrailerPI implements IXmpType
```

Represents XMP trailer processing instruction.

The end="w" or end="r" portion shall be used by packet scanning processors to determine whether the XMP may be modified in-place.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTrailerPI(boolean isWritable) | Initializes a new instance of the  XmpTrailerPI  class. |
| XmpTrailerPI() | Initializes a new instance of the  XmpTrailerPI  class. |
#### Methods

| Method | Description |
| --- | --- |
| isWritable() | Indicates whether form may be modified in-place. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpTrailerPI(boolean isWritable)
```
public XmpTrailerPI(boolean isWritable)
```

Initializes a new instance of the  XmpTrailerPI  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isWritable | boolean | Indicates whether trailer is writable. |

##### XmpTrailerPI()
```
public XmpTrailerPI()
```

Initializes a new instance of the  XmpTrailerPI  class.

##### isWritable()
```
public final boolean isWritable()
```

Indicates whether form may be modified in-place.

**Returns:**
boolean -  true  if XMP packet is writable; otherwise,  false .
##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpValueBase
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpvaluebase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public abstract class XmpValueBase extends PropertyValue implements IXmpType
```

Represents base XMP value.
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the property value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### toString()
```
public String toString()
```

Returns a string that represents the property value.

**Returns:**
java.lang.String - A string that represents the property value.
##### getXmpRepresentation()
```
public abstract String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpVersion
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpversion.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpVersion extends XmpComplexType
```

Represents a version of a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpVersion() | Initializes a new instance of the  XmpVersion  class. |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the comments concerning what was changed. |
| setComments(String value) | Sets the comments concerning what was changed. |
| getEvent() | Gets the high-level, formal description of what operation the user performed. |
| setEvent(XmpResourceEvent value) | Sets the high-level, formal description of what operation the user performed. |
| getModifier() | Gets the person who modified this version. |
| setModifier(String value) | Sets the person who modified this version. |
| getModifyDate() | Gets the date on which this version was checked in. |
| setModifyDate(Date value) | Sets the date on which this version was checked in. |
| getVersionNumber() | Gets the new version number. |
| setVersionNumber(String value) | Sets the new version number. |
##### XmpVersion()
```
public XmpVersion()
```

Initializes a new instance of the  XmpVersion  class.

##### getComments()
```
public final String getComments()
```

Gets the comments concerning what was changed.

**Returns:**
java.lang.String - The comments concerning what was changed.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments concerning what was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comments concerning what was changed. |

##### getEvent()
```
public final XmpResourceEvent getEvent()
```

Gets the high-level, formal description of what operation the user performed.

**Returns:**
XmpResourceEvent - The high-level, formal description of what operation the user performed.
##### setEvent(XmpResourceEvent value)
```
public final void setEvent(XmpResourceEvent value)
```

Sets the high-level, formal description of what operation the user performed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceEvent | The high-level, formal description of what operation the user performed. |

##### getModifier()
```
public final String getModifier()
```

Gets the person who modified this version.

**Returns:**
java.lang.String - The person who modified this version.
##### setModifier(String value)
```
public final void setModifier(String value)
```

Sets the person who modified this version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The person who modified this version. |

##### getModifyDate()
```
public final Date getModifyDate()
```

Gets the date on which this version was checked in.

**Returns:**
java.util.Date - The date on which this version was checked in.
##### setModifyDate(Date value)
```
public final void setModifyDate(Date value)
```

Sets the date on which this version was checked in.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date on which this version was checked in. |

##### getVersionNumber()
```
public final String getVersionNumber()
```

Gets the new version number.

**Returns:**
java.lang.String - The new version number.
##### setVersionNumber(String value)
```
public final void setVersionNumber(String value)
```

Sets the new version number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The new version number. |

### XmpWhiteBalance
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/xmpwhitebalance.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpWhiteBalance extends XmpClosedChoice<String>
```

Represents the White Balance setting in  XmpCameraRawPackage .
#### Methods

| Method | Description |
| --- | --- |
| getAsShot() | White balance: As Shot. |
| getAuto() | White balance: Auto. |
| getCloudy() | White balance: Cloudy. |
| getCustom() | White balance: Custom. |
| getDaylight() | White balance: Daylight. |
| getFlash() | White balance: Flash. |
| getFluorescent() | White balance: Fluorescent. |
| getShade() | White balance: Shade. |
| getTungsten() | White balance: Tungsten. |
##### getAsShot()
```
public static XmpWhiteBalance getAsShot()
```

White balance: As Shot.

**Returns:**
XmpWhiteBalance - As shot.
##### getAuto()
```
public static XmpWhiteBalance getAuto()
```

White balance: Auto.

**Returns:**
XmpWhiteBalance - The automatic.
##### getCloudy()
```
public static XmpWhiteBalance getCloudy()
```

White balance: Cloudy.

**Returns:**
XmpWhiteBalance - Cloudy.
##### getCustom()
```
public static XmpWhiteBalance getCustom()
```

White balance: Custom.

**Returns:**
XmpWhiteBalance - Custom.
##### getDaylight()
```
public static XmpWhiteBalance getDaylight()
```

White balance: Daylight.

**Returns:**
XmpWhiteBalance - Daylight.
##### getFlash()
```
public static XmpWhiteBalance getFlash()
```

White balance: Flash.

**Returns:**
XmpWhiteBalance - Flash.
##### getFluorescent()
```
public static XmpWhiteBalance getFluorescent()
```

White balance: Fluorescent.

**Returns:**
XmpWhiteBalance - Fluorescent.
##### getShade()
```
public static XmpWhiteBalance getShade()
```

White balance: Shade.

**Returns:**
XmpWhiteBalance - Shade.
##### getTungsten()
```
public static XmpWhiteBalance getTungsten()
```

White balance: Tungsten.

**Returns:**
XmpWhiteBalance - Tungsten.

### ZipCompressionMethod
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/zipcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ZipCompressionMethod extends Enum<ZipCompressionMethod> implements IEnumValue
```

Defines ZIP compression methods.
#### Fields

| Field | Description |
| --- | --- |
| NoCompression | The file is stored (no compression). |
| Shrunk | The file is Shrunk. |
| Imploded | The file is Imploded. |
| Reserved | A reserved compression method. |
| Deflated | The file is Deflated. |
| BZip2 | The file is compressed with the BZip2 algorithm. |
| Lzma | The Lempel-Ziv-Markov chain-Algorithm. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### NoCompression
```
public static final ZipCompressionMethod NoCompression
```

The file is stored (no compression).

##### Shrunk
```
public static final ZipCompressionMethod Shrunk
```

The file is Shrunk.

##### Imploded
```
public static final ZipCompressionMethod Imploded
```

The file is Imploded.

##### Reserved
```
public static final ZipCompressionMethod Reserved
```

A reserved compression method.

##### Deflated
```
public static final ZipCompressionMethod Deflated
```

The file is Deflated.

##### BZip2
```
public static final ZipCompressionMethod BZip2
```

The file is compressed with the BZip2 algorithm.

##### Lzma
```
public static final ZipCompressionMethod Lzma
```

The Lempel-Ziv-Markov chain-Algorithm.

##### values()
```
public static ZipCompressionMethod[] values()
```

**Returns:**
com.groupdocs.metadata.core.ZipCompressionMethod[]
##### valueOf(String name)
```
public static ZipCompressionMethod valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ZipCompressionMethod
##### getByRawValue(int rawValue)
```
public static ZipCompressionMethod getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ZipCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ZipFile
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/zipfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ZipFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getCompressionMethod() | Gets the compression method. |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getFlags() | Gets the ZIP entry flags. |
| getName() | Gets the entry name. |
| getRawName() | Gets an array of bytes representing the name of the entry. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressionMethod()
```
public final ZipCompressionMethod getCompressionMethod()
```

Gets the compression method.

**Returns:**
ZipCompressionMethod - The compression method.
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

**Returns:**
long - The compressed size in bytes.
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

**Returns:**
long - The uncompressed size in bytes.
##### getFlags()
```
public final int getFlags()
```

Gets the ZIP entry flags.

**Returns:**
int - The ZIP entry flags.

Bit 00: encrypted file.

 Bit 01: compression option.

 Bit 02: compression option.

 Bit 03: data descriptor.

 Bit 04: enhanced deflation.

 Bit 05: compressed patched data.

 Bit 06: strong encryption.

 Bit 07-10: unused.

 Bit 11: language encoding.

 Bit 12: reserved.

 Bit 13: mask header values.

 Bit 14-15: reserved.

##### getName()
```
public final String getName()
```

Gets the entry name.

**Returns:**
java.lang.String - The entry name. It can be a file or directory name.
##### getRawName()
```
public final byte[] getRawName()
```

Gets an array of bytes representing the name of the entry.

**Returns:**
byte[] - An array of bytes representing the name of the entry.
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

**Returns:**
java.util.Date - The last modification date and time.

### ZipPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/zippackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ZipPackage extends CustomPackage
```

Represents ZIP archive metadata.

The following code snippet shows how to get metadata from a ZIP archive.

> ```
> ```
>
>  Charset charset = Charset.forName("cp866");
>  try (Metadata metadata = new Metadata(Constants.InputZip)) {
>      ZipRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getZipPackage().getComment());
>      System.out.println(root.getZipPackage().getTotalEntries());
>      for (ZipFile file : root.getZipPackage().getFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getCompressedSize());
>          System.out.println(file.getCompressionMethod());
>          System.out.println(file.getFlags());
>          System.out.println(file.getModificationDateTime());
>          System.out.println(file.getUncompressedSize());
>          // Use a specific encoding for the file names
>          System.out.println(new String(file.getRawName(), charset));
>      }
>  }
>
> ```
> ```

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getComment() | Gets the ZIP archive comment created by a user. |
| setComment(String value) | Sets the ZIP archive comment created by a user. |
| getFiles() | Gets an array of  ZipFile  entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getComment()
```
public final String getComment()
```

Gets the ZIP archive comment created by a user.

**Returns:**
java.lang.String - The user's comment.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the ZIP archive comment created by a user.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user's comment. |

##### getFiles()
```
public final ZipFile[] getFiles()
```

Gets an array of  ZipFile  entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.ZipFile[] - An array of  ZipFile  entries inside the ZIP archive.
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

**Returns:**
long - The total number of entries inside the ZIP archive.

### ZipRootPackage
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.core/ziprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class ZipRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

The following code snippet shows how to get metadata from a ZIP archive.

> ```
> ```
>
>  Charset charset = Charset.forName("cp866");
>  try (Metadata metadata = new Metadata(Constants.InputZip)) {
>      ZipRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getZipPackage().getComment());
>      System.out.println(root.getZipPackage().getTotalEntries());
>      for (ZipFile file : root.getZipPackage().getFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getCompressedSize());
>          System.out.println(file.getCompressionMethod());
>          System.out.println(file.getFlags());
>          System.out.println(file.getModificationDateTime());
>          System.out.println(file.getUncompressedSize());
>          // Use a specific encoding for the file names
>          System.out.println(new String(file.getRawName(), charset));
>      }
>  }
>
> ```
> ```

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getZipPackage() | Gets the ZIP metadata package. |
##### getZipPackage()
```
public final ZipPackage getZipPackage()
```

Gets the ZIP metadata package.

**Returns:**
ZipPackage - The ZIP metadata package.

### com.groupdocs.metadata.export
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export.md

The **com.groupdocs.metadata.export** namespace contains classes that allow users to export metadata properties to different representations.

#### Classes

| Class | Description |
| --- | --- |
| CsvExportOptions | Creates an export options of xml file. |
| ExcelExportOptions | Creates an export options of excel file. |
| ExportManager | Provides a row of methods allowing the user to export metadata properties to various formats. |
| ExportOptions | Abstract class export options. |
| JsonExportOptions | Creates an export options of xml file. |
| XmlExportOptions | Creates an export options of xml file. |

#### Enumerations

| Enum | Description |
| --- | --- |
| ExportFormat | Defines file formats to which you can export metadata properties. |

### CsvExportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/csvexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class CsvExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvExportOptions() | Initializes a new instance of the CsvExportOptions class. |
##### CsvExportOptions()
```
public CsvExportOptions()
```

Initializes a new instance of the CsvExportOptions class.

### ExcelExportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/excelexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class ExcelExportOptions extends ExportOptions
```

Creates an export options of excel file.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExcelExportOptions() | Initializes a new instance of the ExcelExportOptions class. |
| ExcelExportOptions(boolean groupCells) | Initializes a new instance of the ExcelExportOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getGroupCells() | This flag determines whether it is necessary to group rows when exporting to Excel format |
| setGroupCells(boolean value) | This flag determines whether it is necessary to group rows when exporting to Excel format |
##### ExcelExportOptions()
```
public ExcelExportOptions()
```

Initializes a new instance of the ExcelExportOptions class.

##### ExcelExportOptions(boolean groupCells)
```
public ExcelExportOptions(boolean groupCells)
```

Initializes a new instance of the ExcelExportOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| groupCells | boolean | Group flag. |

##### getGroupCells()
```
public final boolean getGroupCells()
```

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

**Returns:**
boolean
##### setGroupCells(boolean value)
```
public final void setGroupCells(boolean value)
```

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### ExportFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/exportformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ExportFormat extends Enum<ExportFormat> implements IEnumValue
```

Defines file formats to which you can export metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Xls | Represents the .XLS Excel format. |
| Xlsx | Represents the .XLSX Excel format. |
| Xml | Represents the .XML format. |
| Csv | Represents the .CSV format. |
| Json | Represents the .JSON format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Xls
```
public static final ExportFormat Xls
```

Represents the .XLS Excel format.

##### Xlsx
```
public static final ExportFormat Xlsx
```

Represents the .XLSX Excel format.

##### Xml
```
public static final ExportFormat Xml
```

Represents the .XML format.

##### Csv
```
public static final ExportFormat Csv
```

Represents the .CSV format.

##### Json
```
public static final ExportFormat Json
```

Represents the .JSON format.

##### values()
```
public static ExportFormat[] values()
```

**Returns:**
com.groupdocs.metadata.export.ExportFormat[]
##### valueOf(String name)
```
public static ExportFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ExportFormat
##### getByRawValue(int rawValue)
```
public static ExportFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ExportFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ExportManager
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/exportmanager.md

**Inheritance:**
java.lang.Object
```
public class ExportManager
```

Provides a row of methods allowing the user to export metadata properties to various formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExportManager(Iterable<MetadataProperty> properties) | Initializes a new instance of the  ExportManager  class. |
#### Methods

| Method | Description |
| --- | --- |
| export(String filePath, ExportFormat format, ExportOptions exportOptions) | Exports the metadata properties to a file. |
| export(OutputStream document, ExportFormat format, ExportOptions exportOptions) | Exports the metadata properties to a stream. |
| export(String filePath, ExportFormat format) | Exports the metadata properties to a file. |
| export(OutputStream document, ExportFormat format) | Exports the metadata properties to a stream. |
##### ExportManager(Iterable<MetadataProperty> properties)
```
public ExportManager(Iterable<MetadataProperty> properties)
```

Initializes a new instance of the  ExportManager  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| properties | java.lang.Iterable<com.groupdocs.metadata.core.MetadataProperty> | A collection of metadata properties to be exported. |

##### export(String filePath, ExportFormat format, ExportOptions exportOptions)
```
public final void export(String filePath, ExportFormat format, ExportOptions exportOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions |  |

##### export(OutputStream document, ExportFormat format, ExportOptions exportOptions)
```
public final void export(OutputStream document, ExportFormat format, ExportOptions exportOptions)
```

Exports the metadata properties to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions |  |

##### export(String filePath, ExportFormat format)
```
public final void export(String filePath, ExportFormat format)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |

##### export(OutputStream document, ExportFormat format)
```
public final void export(OutputStream document, ExportFormat format)
```

Exports the metadata properties to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output file stream. |
| format | ExportFormat | The format of the output file. |

### ExportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/exportoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class ExportOptions
```

Abstract class export options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExportOptions() | Initializes a new instance of the ExportOptions class. |
##### ExportOptions()
```
public ExportOptions()
```

Initializes a new instance of the ExportOptions class.

### JsonExportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/jsonexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class JsonExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonExportOptions() | Initializes a new instance of the JsonExportOptions class. |
##### JsonExportOptions()
```
public JsonExportOptions()
```

Initializes a new instance of the JsonExportOptions class.

### XmlExportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.export/xmlexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class XmlExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlExportOptions() | Initializes a new instance of the XmlExportOptions class. |
##### XmlExportOptions()
```
public XmlExportOptions()
```

Initializes a new instance of the XmlExportOptions class.

### com.groupdocs.metadata.imports
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.imports.md

The **com.groupdocs.metadata.imports** namespace contains classes that allow users to import metadata properties to different representations.

#### Classes

| Class | Description |
| --- | --- |
| ImportFormat | Defines file formats to which you can import metadata properties. |
| ImportManager | Provides a row of methods allowing the user to export metadata properties to various formats. |
| ImportOptions | Abstract class import options. |
| JsonImportOptions | Creates an import options from json file. |

### ImportFormat
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.imports/importformat.md

**Inheritance:**
java.lang.Object
```
public final class ImportFormat
```

Defines file formats to which you can import metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Json | Represents the .JSON format. |
##### Json
```
public static final int Json
```

Represents the .JSON format.

### ImportManager
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.imports/importmanager.md

**Inheritance:**
java.lang.Object
```
public class ImportManager
```

Provides a row of methods allowing the user to export metadata properties to various formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportManager(RootMetadataPackage rootMetadataPackage) | Initializes a new instance of the ImportManager class. |
#### Methods

| Method | Description |
| --- | --- |
| import_(String filePath, int format, ImportOptions importOptions) | Exports the metadata properties to a file. |
| import_(InputStream stream, int format, ImportOptions importOptions) | Exports the metadata properties to a file. |
##### ImportManager(RootMetadataPackage rootMetadataPackage)
```
public ImportManager(RootMetadataPackage rootMetadataPackage)
```

Initializes a new instance of the ImportManager class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rootMetadataPackage | RootMetadataPackage | A collection of metadata properties where the import will be performed.. |

##### import_(String filePath, int format, ImportOptions importOptions)
```
public final void import_(String filePath, int format, ImportOptions importOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the input file. |
| format | int | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

##### import_(InputStream stream, int format, ImportOptions importOptions)
```
public final void import_(InputStream stream, int format, ImportOptions importOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The filestream of the input file. |
| format | int | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

### ImportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.imports/importoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class ImportOptions
```

Abstract class import options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportOptions() | Initializes a new instance of the ImportOptions class. |
##### ImportOptions()
```
public ImportOptions()
```

Initializes a new instance of the ImportOptions class.

### JsonImportOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.imports/jsonimportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.imports.ImportOptions
```
public class JsonImportOptions extends ImportOptions
```

Creates an import options from json file.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonImportOptions() | Initializes a new instance of the JsonImportOptions class. |
##### JsonImportOptions()
```
public JsonImportOptions()
```

Initializes a new instance of the JsonImportOptions class.

### com.groupdocs.metadata.licensing
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.licensing.md

The **com.groupdocs.metadata.licensing** namespace provides classes for licensing the Metadata library.

#### Classes

| Class | Description |
| --- | --- |
| License | Represents GroupDocs.Metadata license. |
| Metered | Provides methods to set metered key. |

### License
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Represents GroupDocs.Metadata license. License class should be applied once per AppDomain.

> ```
> This example demonstrates how to setup a license.
>
>  // initialize License class
>  License license = new License();
>  // set path to .lic file
>  license.SetLicense(@"C:\\GroupDocs.Metadata.lic");
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(InputStream licenseStream) | Licenses the component. |
##### License()
```
public License()
```

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

Licenses the component.

> ```
> This example demonstrates how to setup license.
>
>  // initialize License class
>  License license = new License();
>  // set path to .lic file
>  license.SetLicense(@"C:\\GroupDocs.Metadata.lic");
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The absolute path to a license file. |

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | License stream. |

### Metered
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods to set metered key.
#### 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 amount of used credits |
##### 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 amount of used credits

> ```
> 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 usedCredits = Metered.GetConsumptionCredit();
> ```

**Returns:**
java.math.BigDecimal

### com.groupdocs.metadata.options
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options.md

The **com.groupdocs.metadata.options** namespace contains all classes representing settings that allow users to control file and metadata processing.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows a developer to specify additional options (such as a password) when loading a file. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICreatePageStream | Defines a method that returns a stream to write page preview data. |
| IReleasePageStream | Defines a method which releases the stream created by the passed  ICreatePageStream  implementation. |

#### Enumerations

| Enum | Description |
| --- | --- |
| PreviewFormats | Represents supported preview formats. |

### ICreatePageStream
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options/icreatepagestream.md

### IReleasePageStream
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options/ireleasepagestream.md

### LoadOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows a developer to specify additional options (such as a password) when loading a file.

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the  LoadOptions  class. |
| LoadOptions(FileFormat fileFormat) | Initializes a new instance of the  LoadOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets the password for opening an encrypted document. |
| setPassword(String value) | Sets the password for opening an encrypted document. |
| getFileFormat() | Gets the exact type of the file that is to be loaded. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the  LoadOptions  class.

##### LoadOptions(FileFormat fileFormat)
```
public LoadOptions(FileFormat fileFormat)
```

Initializes a new instance of the  LoadOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The exact type of the file. |

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening an encrypted document.

**Returns:**
java.lang.String - Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening an encrypted document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string. |

##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the exact type of the file that is to be loaded. The default value is  FileFormat.Unknown  which means that the type should be detected automatically.

**Returns:**
FileFormat - The exact type of the file that is to be loaded.

### PreviewFormats
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options/previewformats.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PreviewFormats extends Enum<PreviewFormats>
```

Represents supported preview formats.
#### Fields

| Field | Description |
| --- | --- |
| PNG | Portable Network Graphics Format. |
| JPEG | Joint Photographic Experts Group Format. |
| BMP | Bitmap Picture Format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### PNG
```
public static final PreviewFormats PNG
```

Portable Network Graphics Format.

##### JPEG
```
public static final PreviewFormats JPEG
```

Joint Photographic Experts Group Format.

##### BMP
```
public static final PreviewFormats BMP
```

Bitmap Picture Format.

##### values()
```
public static PreviewFormats[] values()
```

**Returns:**
com.groupdocs.metadata.options.PreviewFormats[]
##### valueOf(String name)
```
public static PreviewFormats valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PreviewFormats

### PreviewOptions
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the  PreviewOptions  class causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of  PreviewOptions  class causing the output stream to be returned to the client for further use. |
#### Methods

| Method | Description |
| --- | --- |
| getCacheFolder() | Gets the cache folder. |
| setCacheFolder(String value) | Sets the cache folder. |
| getMaxDiskSpaceForCache() | Gets the maximum available disk space for cache in bytes. |
| setMaxDiskSpaceForCache(int value) | Sets the maximum available disk space for cache in bytes. |
| getMaxMemoryForCache() | Gets the maximum available memory for cache in memory in bytes. |
| setMaxMemoryForCache(int value) | Sets the maximum available memory for cache in memory in bytes. |
| getWidth() | Gets the page preview width. |
| setWidth(int value) | Sets the page preview width. |
| getHeight() | Gets the page preview height. |
| setHeight(int value) | Sets the page preview height. |
| getPageNumbers() | Gets an array of page numbers to generate previews. |
| setPageNumbers(int[] value) | Sets an array of page numbers to generate previews. |
| getPreviewFormat() | Gets the preview image format. |
| setPreviewFormat(PreviewFormats value) | Sets the preview image format. |
| getCreatePageStream() | Gets an instance of the page stream creation delegate. |
| setCreatePageStream(ICreatePageStream value) | Sets an instance of the page stream creation delegate. |
| getReleasePageStream() | Gets an instance of the page preview completion delegate. |
| setReleasePageStream(IReleasePageStream value) | Sets an instance of the page preview completion delegate. |
| getResolution() | Gets or sets the page preview resolution. |
| setResolution(int value) | Gets or sets the page preview resolution. |
##### PreviewOptions(ICreatePageStream createPageStream)
```
public PreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the  PreviewOptions  class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of  PreviewOptions  class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### getCacheFolder()
```
public final String getCacheFolder()
```

Gets the cache folder. By default the cache folder is set to user's local temp directory.

**Returns:**
java.lang.String - The cache folder.
##### setCacheFolder(String value)
```
public final void setCacheFolder(String value)
```

Sets the cache folder. By default the cache folder is set to user's local temp directory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The cache folder. |

##### getMaxDiskSpaceForCache()
```
public final int getMaxDiskSpaceForCache()
```

Gets the maximum available disk space for cache in bytes. The default value is 1073741824.

**Returns:**
int - The maximum available disk space for cache in bytes.
##### setMaxDiskSpaceForCache(int value)
```
public final void setMaxDiskSpaceForCache(int value)
```

Sets the maximum available disk space for cache in bytes. The default value is 1073741824.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum available disk space for cache in bytes. |

##### getMaxMemoryForCache()
```
public final int getMaxMemoryForCache()
```

Gets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

**Returns:**
int - The maximum available memory for cache in memory in bytes.
##### setMaxMemoryForCache(int value)
```
public final void setMaxMemoryForCache(int value)
```

Sets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum available memory for cache in memory in bytes. |

##### getWidth()
```
public final int getWidth()
```

Gets the page preview width.

**Returns:**
int - The page preview width.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview width. |

##### getHeight()
```
public final int getHeight()
```

Gets the page preview height.

**Returns:**
int - The page preview height.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview height. |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets an array of page numbers to generate previews.

**Returns:**
int[] - An array of page numbers to generate previews.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets an array of page numbers to generate previews.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | An array of page numbers to generate previews. |

##### getPreviewFormat()
```
public final PreviewFormats getPreviewFormat()
```

Gets the preview image format.

**Returns:**
PreviewFormats - The preview image format.
##### setPreviewFormat(PreviewFormats value)
```
public final void setPreviewFormat(PreviewFormats value)
```

Sets the preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PreviewFormats | The preview image format. |

##### getCreatePageStream()
```
public final ICreatePageStream getCreatePageStream()
```

Gets an instance of the page stream creation delegate.

**Returns:**
ICreatePageStream - An instance of the page stream creation delegate.
##### setCreatePageStream(ICreatePageStream value)
```
public final void setCreatePageStream(ICreatePageStream value)
```

Sets an instance of the page stream creation delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICreatePageStream | An instance of the page stream creation delegate. |

##### getReleasePageStream()
```
public final IReleasePageStream getReleasePageStream()
```

Gets an instance of the page preview completion delegate.

**Returns:**
IReleasePageStream - An instance of the page preview completion delegate.
##### setReleasePageStream(IReleasePageStream value)
```
public final void setReleasePageStream(IReleasePageStream value)
```

Sets an instance of the page preview completion delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IReleasePageStream | An instance of the page preview completion delegate. |

##### getResolution()
```
public final int getResolution()
```

Gets or sets the page preview resolution.

**Returns:**
int
##### setResolution(int value)
```
public final void setResolution(int value)
```

Gets or sets the page preview resolution.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.metadata.search
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search.md

The **com.groupdocs.metadata.search** namespace contains base classes, utility classes and interfaces used across all formats and metadata standards.

#### Classes

| Class | Description |
| --- | --- |
| AndSpecification | Represents a composite specification that uses the logical AND operator to combine two given search specifications. |
| AnySpecification | Represents a specification that applies no filters to a property. |
| ContainsTagSpecification | Represents a specification that checks whether the passed property contains the specified tag. |
| FallsIntoCategorySpecification | Represents a specification that verifies whether the passed property falls into a particular category (i.e. |
| NotSpecification | Represents a composite specification that negates any other specification. |
| OfTypeSpecification | Represents a specification that filters properties of a particular type. |
| OrSpecification | Represents a composite specification that uses the logical OR operator to combine two given search specifications. |
| Specification | Provides a base abstract class for search specifications that can be combined using logical operators. |
| WithNameSpecification | Represents a specification that filters properties with a particular name. |

### AndSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/andspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class AndSpecification extends Specification
```

Represents a composite specification that uses the logical AND operator to combine two given search specifications.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the left specification. |
| getRight() | Gets the right specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getLeft()
```
public final Specification getLeft()
```

Gets the left specification.

**Returns:**
Specification - The left specification.
##### getRight()
```
public final Specification getRight()
```

Gets the right specification.

**Returns:**
Specification - The right specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### AnySpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/anyspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class AnySpecification extends Specification
```

Represents a specification that applies no filters to a property.
#### Constructors

| Constructor | Description |
| --- | --- |
| AnySpecification() |  |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### AnySpecification()
```
public AnySpecification()
```

##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### ContainsTagSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/containstagspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class ContainsTagSpecification extends Specification
```

Represents a specification that checks whether the passed property contains the specified tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| ContainsTagSpecification(PropertyTag tag) | Initializes a new instance of the  ContainsTagSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTag() | Gets the tag a property must contain to satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### ContainsTagSpecification(PropertyTag tag)
```
public ContainsTagSpecification(PropertyTag tag)
```

Initializes a new instance of the  ContainsTagSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | PropertyTag | The tag a property must contain to satisfy the specification. |

##### getTag()
```
public final PropertyTag getTag()
```

Gets the tag a property must contain to satisfy the specification.

**Returns:**
PropertyTag - The tag a property must contain to satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### FallsIntoCategorySpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/fallsintocategoryspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class FallsIntoCategorySpecification extends Specification
```

Represents a specification that verifies whether the passed property falls into a particular category (i.e. contains tags from the specified category).
#### Constructors

| Constructor | Description |
| --- | --- |
| FallsIntoCategorySpecification(TagCategory category) | Initializes a new instance of the  FallsIntoCategorySpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCategory() | Gets the category into which a property must fall to satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### FallsIntoCategorySpecification(TagCategory category)
```
public FallsIntoCategorySpecification(TagCategory category)
```

Initializes a new instance of the  FallsIntoCategorySpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| category | TagCategory | The category into which a property must fall to satisfy the specification. |

##### getCategory()
```
public final TagCategory getCategory()
```

Gets the category into which a property must fall to satisfy the specification.

**Returns:**
TagCategory - The category into which a property must fall to satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### NotSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/notspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class NotSpecification extends Specification
```

Represents a composite specification that negates any other specification.
#### Methods

| Method | Description |
| --- | --- |
| getWrapped() | Gets the base specification to be negated. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getWrapped()
```
public final Specification getWrapped()
```

Gets the base specification to be negated.

**Returns:**
Specification - The base specification to be negated.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### OfTypeSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/oftypespecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class OfTypeSpecification extends Specification
```

Represents a specification that filters properties of a particular type.
#### Constructors

| Constructor | Description |
| --- | --- |
| OfTypeSpecification(MetadataPropertyType propertyType) | Initializes a new instance of the  OfTypeSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPropertyType() | Gets the type of properties that satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### OfTypeSpecification(MetadataPropertyType propertyType)
```
public OfTypeSpecification(MetadataPropertyType propertyType)
```

Initializes a new instance of the  OfTypeSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyType | MetadataPropertyType | The type of properties that satisfy the specification. |

##### getPropertyType()
```
public final MetadataPropertyType getPropertyType()
```

Gets the type of properties that satisfy the specification.

**Returns:**
MetadataPropertyType - The type of properties that satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### OrSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/orspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class OrSpecification extends Specification
```

Represents a composite specification that uses the logical OR operator to combine two given search specifications.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the left specification. |
| getRight() | Gets the right specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getLeft()
```
public final Specification getLeft()
```

Gets the left specification.

**Returns:**
Specification - The left specification.
##### getRight()
```
public final Specification getRight()
```

Gets the right specification.

**Returns:**
Specification - The right specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### Specification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/specification.md

**Inheritance:**
java.lang.Object
```
public abstract class Specification
```

Provides a base abstract class for search specifications that can be combined using logical operators.
#### Constructors

| Constructor | Description |
| --- | --- |
| Specification() |  |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
| and(Specification other) | Combines two search specifications using the logical AND operator. |
| or(Specification other) | Combines two search specifications using the logical OR operator. |
| not() | Negates the specification. |
##### Specification()
```
public Specification()
```

##### isSatisfiedBy(MetadataProperty candidate)
```
public abstract boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.
##### and(Specification other)
```
public final Specification and(Specification other)
```

Combines two search specifications using the logical AND operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Specification | A specification to combine with. |

**Returns:**
Specification - A composite specification.
##### or(Specification other)
```
public final Specification or(Specification other)
```

Combines two search specifications using the logical OR operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Specification | A specification to combine with. |

**Returns:**
Specification - A composite specification.
##### not()
```
public final Specification not()
```

Negates the specification.

**Returns:**
Specification - A composite specification.

### WithNameSpecification
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.search/withnamespecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class WithNameSpecification extends Specification
```

Represents a specification that filters properties with a particular name.
#### Constructors

| Constructor | Description |
| --- | --- |
| WithNameSpecification(String propertyName) | Initializes a new instance of the  WithNameSpecification  class. |
| WithNameSpecification(String propertyName, boolean ignoreCase) | Initializes a new instance of the  WithNameSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPropertyName() | Gets the name of properties that satisfy the specification. |
| getIgnoreCase() | Gets a value indicating whether the case of the strings being compared should be ignored. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### WithNameSpecification(String propertyName)
```
public WithNameSpecification(String propertyName)
```

Initializes a new instance of the  WithNameSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The type of properties that satisfy the specification. |

##### WithNameSpecification(String propertyName, boolean ignoreCase)
```
public WithNameSpecification(String propertyName, boolean ignoreCase)
```

Initializes a new instance of the  WithNameSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The type of properties that satisfy the specification. |
| ignoreCase | boolean | A value indicating whether the case of the strings being compared should be ignored. |

##### getPropertyName()
```
public final String getPropertyName()
```

Gets the name of properties that satisfy the specification.

**Returns:**
java.lang.String - The name of properties that satisfy the specification.
##### getIgnoreCase()
```
public final boolean getIgnoreCase()
```

Gets a value indicating whether the case of the strings being compared should be ignored.

**Returns:**
boolean - True if the case should be ignored; otherwise, false.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### com.groupdocs.metadata.tagging
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging.md

The **com.groupdocs.metadata.tagging** namespace contains various sets of tags with which most important metadata properties are marked.The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format.

#### Classes

| Class | Description |
| --- | --- |
| ContentTagCategory | Provides tags that are attached to metadata properties describing the content of a file. |
| CorporateTagCategory | Provides tags intended to mark metadata properties related to a company that participated in file creation. |
| DocumentTagCategory | Provides tags that are applied to document-specific properties only. |
| LegalTagCategory | Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
| OriginTagCategory | Provides tags that help a user to determine the origin of a file (e.g. |
| PersonTagCategory | Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. |
| PropertyTag | Represents a tag used to mark metadata properties. |
| PropertyTypeTagCategory | Provides tags that bear additional information about the type of a property rather than about its purpose. |
| TagCategory | Represents a set of tags having some shared characteristics. |
| Tags | Contains various sets of tags with which most important metadata properties are marked. |
| TimeTagCategory | Provides tags that mark metadata properties used to describe the lifecycle of a file. |
| ToolTagCategory | Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |

### ContentTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/contenttagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class ContentTagCategory extends TagCategory
```

Provides tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Gets the tag that labels properties containing a description of a file. |
| getComment() | Gets the tag that denotes a comment left by a person who contributed in file creation. |
| getTitle() | Gets the tag that labels the name given to a file. |
| getThumbnail() | Gets the tag that indicates a thumbnail image attached to a file. |
| getLanguage() | Gets the tag indicating the language of the intellectual content of a file. |
| getSubject() | Gets the tag that denotes the subject the intellectual content is focused on. |
| getTableOfContents() | Gets the tag indicating properties containing the table of contents of a file. |
| getType() | Gets the tag that indicates the nature or genre of the content of a file. |
| getRating() | Gets the tag labeling a user assigned rating of a file. |
| getKeywords() | Gets the tag that denotes a metadata property containing keywords that describe the content. |
| getFileFormat() | Gets the tag that indicates a metadata property containing information about the format of a file. |
| getStatus() | Gets the tag that denotes the status of a file. |
| getVersion() | Gets the tag labeling the version or revision of a file. |
| getSharedDoc() | Gets the tag that denotes which is a common document for several manufacturers. |
| getHyperlinksChanged() | Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer. |
| getBody() | Gets the tag that denotes the body of a email file. |
| getAlbum() | Gets the tag that denotes the album name of a audio file. |
##### getDescription()
```
public final PropertyTag getDescription()
```

Gets the tag that labels properties containing a description of a file.

**Returns:**
PropertyTag - The tag that labels properties containing a description of a file.
##### getComment()
```
public final PropertyTag getComment()
```

Gets the tag that denotes a comment left by a person who contributed in file creation.

**Returns:**
PropertyTag - The tag that denotes a comment left by a person who contributed in file creation.
##### getTitle()
```
public final PropertyTag getTitle()
```

Gets the tag that labels the name given to a file.

**Returns:**
PropertyTag - The tag that labels the name given to a file.
##### getThumbnail()
```
public final PropertyTag getThumbnail()
```

Gets the tag that indicates a thumbnail image attached to a file.

**Returns:**
PropertyTag - The tag that indicates a thumbnail image attached to a file.
##### getLanguage()
```
public final PropertyTag getLanguage()
```

Gets the tag indicating the language of the intellectual content of a file.

**Returns:**
PropertyTag
##### getSubject()
```
public final PropertyTag getSubject()
```

Gets the tag that denotes the subject the intellectual content is focused on.

**Returns:**
PropertyTag - The tag that denotes the subject the intellectual content is focused on.
##### getTableOfContents()
```
public final PropertyTag getTableOfContents()
```

Gets the tag indicating properties containing the table of contents of a file.

**Returns:**
PropertyTag
##### getType()
```
public final PropertyTag getType()
```

Gets the tag that indicates the nature or genre of the content of a file. It also includes terms describing general categories, functions, aggregation levels for the content.

**Returns:**
PropertyTag
##### getRating()
```
public final PropertyTag getRating()
```

Gets the tag labeling a user assigned rating of a file.

**Returns:**
PropertyTag - The tag labeling a user assigned rating of a file.
##### getKeywords()
```
public final PropertyTag getKeywords()
```

Gets the tag that denotes a metadata property containing keywords that describe the content.

**Returns:**
PropertyTag - The tag that denotes a metadata property containing keywords that describe the content.
##### getFileFormat()
```
public final PropertyTag getFileFormat()
```

Gets the tag that indicates a metadata property containing information about the format of a file.

**Returns:**
PropertyTag - The tag that indicates a metadata property containing information about the format of a file.
##### getStatus()
```
public final PropertyTag getStatus()
```

Gets the tag that denotes the status of a file.

**Returns:**
PropertyTag - The tag that denotes the status of a file.
##### getVersion()
```
public final PropertyTag getVersion()
```

Gets the tag labeling the version or revision of a file.

**Returns:**
PropertyTag - The tag labeling the version or revision of a file.
##### getSharedDoc()
```
public final PropertyTag getSharedDoc()
```

Gets the tag that denotes which is a common document for several manufacturers.

**Returns:**
PropertyTag - The tag that denotes which is a common document for several manufacturers.
##### getHyperlinksChanged()
```
public final PropertyTag getHyperlinksChanged()
```

Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.

**Returns:**
PropertyTag - The tag that denotes indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.
##### getBody()
```
public final PropertyTag getBody()
```

Gets the tag that denotes the body of a email file.

**Returns:**
PropertyTag - The tag that denotes the body of a email file.
##### getAlbum()
```
public final PropertyTag getAlbum()
```

Gets the tag that denotes the album name of a audio file.

Value: The tag that denotes the album name of a audio file.

**Returns:**
PropertyTag

### CorporateTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/corporatetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class CorporateTagCategory extends TagCategory
```

Provides tags intended to mark metadata properties related to a company that participated in file creation.
#### Methods

| Method | Description |
| --- | --- |
| getCompany() | Gets the tag that labels a property containing information about a company contributed to file creation. |
| getManager() | Gets the tag that labels information about a person who managed the making process of a file. |
##### getCompany()
```
public final PropertyTag getCompany()
```

Gets the tag that labels a property containing information about a company contributed to file creation. Alternatively, the tag can refer to a company the file content is about.

**Returns:**
PropertyTag
##### getManager()
```
public final PropertyTag getManager()
```

Gets the tag that labels information about a person who managed the making process of a file.

**Returns:**
PropertyTag - The tag that labels information about a person who managed the making process of a file.

### DocumentTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/documenttagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class DocumentTagCategory extends TagCategory
```

Provides tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.
#### Methods

| Method | Description |
| --- | --- |
| getBuiltIn() | Gets the tag that indicates that the property it labels is built-in. |
| getReadOnly() | Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata. |
| getHiddenData() | Gets the tag indicating a document part that is not visible for regular users. |
| getUserComment() | Gets the tag that labels user comments shown in the document content. |
| getPage() | Gets the tag that denotes a property holding information about a document page. |
| getStatistic() | Gets the tag indicating a property containing document statistics (word count, character count, etc). |
| getField() | Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document. |
| getRevision() | Get the tag labeling a property containing information about a document revision (tracked change). |
##### getBuiltIn()
```
public final PropertyTag getBuiltIn()
```

Gets the tag that indicates that the property it labels is built-in.

**Returns:**
PropertyTag - The tag that indicates that the property it labels is built-in.
##### getReadOnly()
```
public final PropertyTag getReadOnly()
```

Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.

**Returns:**
PropertyTag - The tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.
##### getHiddenData()
```
public final PropertyTag getHiddenData()
```

Gets the tag indicating a document part that is not visible for regular users.

**Returns:**
PropertyTag - The tag indicating a document part that is not visible for regular users.
##### getUserComment()
```
public final PropertyTag getUserComment()
```

Gets the tag that labels user comments shown in the document content.

**Returns:**
PropertyTag - The tag that labels user comments shown in the document content.
##### getPage()
```
public final PropertyTag getPage()
```

Gets the tag that denotes a property holding information about a document page.

**Returns:**
PropertyTag - The tag that denotes a property holding information about a document page.
##### getStatistic()
```
public final PropertyTag getStatistic()
```

Gets the tag indicating a property containing document statistics (word count, character count, etc).

**Returns:**
PropertyTag - The tag indicating a property containing document statistics (word count, character count, etc).
##### getField()
```
public final PropertyTag getField()
```

Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document.

**Returns:**
PropertyTag - The tag that denotes a property holding information about a form field or calculated field extracted from a document.
##### getRevision()
```
public final PropertyTag getRevision()
```

Get the tag labeling a property containing information about a document revision (tracked change).

**Returns:**
PropertyTag - The tag labeling a property containing information about a document revision (tracked change).

### LegalTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/legaltagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class LegalTagCategory extends TagCategory
```

Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.
#### Methods

| Method | Description |
| --- | --- |
| getCopyright() | Gets the tag that labels a copyright notice provided by the owner. |
| getOwner() | Gets the tag that denotes information about the owners of a file. |
| getUsageTerms() | Gets the tag that labels instructions on how the file can be used. |
##### getCopyright()
```
public final PropertyTag getCopyright()
```

Gets the tag that labels a copyright notice provided by the owner.

**Returns:**
PropertyTag - The tag that labels a copyright notice provided by the owner.
##### getOwner()
```
public final PropertyTag getOwner()
```

Gets the tag that denotes information about the owners of a file.

**Returns:**
PropertyTag - The tag that denotes information about the owners of a file.
##### getUsageTerms()
```
public final PropertyTag getUsageTerms()
```

Gets the tag that labels instructions on how the file can be used.

**Returns:**
PropertyTag - The tag that labels instructions on how the file can be used.

### OriginTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/origintagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class OriginTagCategory extends TagCategory
```

Provides tags that help a user to determine the origin of a file (e.g. template or another source).
#### Methods

| Method | Description |
| --- | --- |
| getTemplate() | Gets the tag that denotes the template from which the file was created. |
| getSource() | Gets the tag that labels a reference to a resource from which the file content is derived. |
##### getTemplate()
```
public final PropertyTag getTemplate()
```

Gets the tag that denotes the template from which the file was created.

**Returns:**
PropertyTag - The tag that denotes the template from which the file was created.
##### getSource()
```
public final PropertyTag getSource()
```

Gets the tag that labels a reference to a resource from which the file content is derived.

**Returns:**
PropertyTag - The tag that labels a reference to a resource from which the file content is derived.

### PersonTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/persontagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class PersonTagCategory extends TagCategory
```

Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.
#### Methods

| Method | Description |
| --- | --- |
| getCreator() | Gets the tag that denotes the original author of a file/document. |
| getContributor() | Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. |
| getEditor() | Gets the tag that labels a person who edited a file. |
| getModel() | Gets the tag that denotes information about a person the content of the file is about. |
| getClient() | Gets the tag that labels information about the client for whom the file/intellectual content was created. |
| getManager() | Gets the tag that labels information about a person who managed the making process of a file. |
| getPublisher() | Gets the tag marking a person responsible for making the file available. |
| getArtist() | Gets the tag that denotes the original performer of a file. |
| getRecipient() | Gets the tag that denotes the original recipients of a mail. |
##### getCreator()
```
public final PropertyTag getCreator()
```

Gets the tag that denotes the original author of a file/document.

**Returns:**
PropertyTag - The tag that denotes the original author of a file/document.
##### getContributor()
```
public final PropertyTag getContributor()
```

Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. Please note that the tag is not applied towards metadata properties marked with more specific tags from this category. E.g. if a property labeled with the Creator tag.

**Returns:**
PropertyTag - The tag that labels a property containing the name of a person who somehow contributed to file creation.
##### getEditor()
```
public final PropertyTag getEditor()
```

Gets the tag that labels a person who edited a file. The tag is usually used to mark a property containing information about the last editor.

**Returns:**
PropertyTag - The tag that labels a person who edited a file.
##### getModel()
```
public final PropertyTag getModel()
```

Gets the tag that denotes information about a person the content of the file is about. For photos that is a person shown in the image.

**Returns:**
PropertyTag - The tag that denotes information about a person the content of the file is about.
##### getClient()
```
public final PropertyTag getClient()
```

Gets the tag that labels information about the client for whom the file/intellectual content was created.

**Returns:**
PropertyTag - The tag that labels information about the client for whom the file/intellectual content was created.
##### getManager()
```
public final PropertyTag getManager()
```

Gets the tag that labels information about a person who managed the making process of a file.

**Returns:**
PropertyTag - The tag that labels information about a person who managed the making process of a file.
##### getPublisher()
```
public final PropertyTag getPublisher()
```

Gets the tag marking a person responsible for making the file available.

**Returns:**
PropertyTag - The tag marking a person responsible for making the file available.
##### getArtist()
```
public final PropertyTag getArtist()
```

Gets the tag that denotes the original performer of a file.

**Returns:**
PropertyTag - The tag that denotes the original performer of a file.
##### getRecipient()
```
public final PropertyTag getRecipient()
```

Gets the tag that denotes the original recipients of a mail.

**Returns:**
PropertyTag - The tag that denotes the original recipients of a mail.

### PropertyTag
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/propertytag.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class PropertyTag implements System.IEquatable<PropertyTag>
```

Represents a tag used to mark metadata properties.
#### Methods

| Method | Description |
| --- | --- |
| getCategory() | Gets the tag category. |
| equals(PropertyTag other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Determines whether the specified object is equal to the current object. |
| hashCode() | Serves as the default hash function. |
| op_Equality(PropertyTag left, PropertyTag right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(PropertyTag left, PropertyTag right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a string that represents the current object. |
##### getCategory()
```
public final TagCategory getCategory()
```

Gets the tag category.

**Returns:**
TagCategory - The tag category.
##### equals(PropertyTag other)
```
public final boolean equals(PropertyTag other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | PropertyTag | An object to compare with this object. |

**Returns:**
boolean - True if the current object is equal to the  other  parameter; otherwise, false.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified object is equal to the current object.

**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.
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.
##### op_Equality(PropertyTag left, PropertyTag right)
```
public static boolean op_Equality(PropertyTag left, PropertyTag right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(PropertyTag left, PropertyTag right)
```
public static boolean op_Inequality(PropertyTag left, PropertyTag right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### PropertyTypeTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/propertytypetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class PropertyTypeTagCategory extends TagCategory
```

Provides tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.
#### Methods

| Method | Description |
| --- | --- |
| getLink() | Gets the tag that denotes a property being a link to an external resource. |
| getHash() | Gets the tag that labels a property holding a hash of the file content. |
| getMeasure() | Gets the tag that indicates a property being a measured characteristic of the content. |
| getDigitalSignature() | Gets the tag that labels a digital signature. |
| getIdentifier() | Gets the tag that labels a property containing an identifier of the content. |
| getLocation() | Gets the tag that indicates a property being a reference to a geographical location. |
| getFont() | Gets the tag that denotes a property describing font characteristics. |
| getColor() | Gets the tag that labels a property describing a color. |
| getBitrate() | Gets the tag that labels a property describing a bitrate. |
##### getLink()
```
public final PropertyTag getLink()
```

Gets the tag that denotes a property being a link to an external resource.

**Returns:**
PropertyTag - The tag that denotes a property being a link to an external resource.
##### getHash()
```
public final PropertyTag getHash()
```

Gets the tag that labels a property holding a hash of the file content.

**Returns:**
PropertyTag - The tag that labels a property holding a hash of the file content.
##### getMeasure()
```
public final PropertyTag getMeasure()
```

Gets the tag that indicates a property being a measured characteristic of the content. It can be the file size, number of pages, page size, etc.

**Returns:**
PropertyTag - The tag that indicates a property being a measured characteristic of the content.
##### getDigitalSignature()
```
public final PropertyTag getDigitalSignature()
```

Gets the tag that labels a digital signature.

**Returns:**
PropertyTag - The tag that labels a digital signature.
##### getIdentifier()
```
public final PropertyTag getIdentifier()
```

Gets the tag that labels a property containing an identifier of the content.

**Returns:**
PropertyTag - The tag that labels a property containing an identifier of the content.
##### getLocation()
```
public final PropertyTag getLocation()
```

Gets the tag that indicates a property being a reference to a geographical location. The property can contain the name of a city, full address, GPS coordinates, etc.

**Returns:**
PropertyTag - The tag that indicates a property being a reference to a geographical location.
##### getFont()
```
public final PropertyTag getFont()
```

Gets the tag that denotes a property describing font characteristics.

**Returns:**
PropertyTag - The tag that denotes a property describing font characteristics.
##### getColor()
```
public final PropertyTag getColor()
```

Gets the tag that labels a property describing a color.

**Returns:**
PropertyTag - The tag that labels a property describing a color.
##### getBitrate()
```
public final PropertyTag getBitrate()
```

Gets the tag that labels a property describing a bitrate.

**Returns:**
PropertyTag - The tag that labels a property describing a bitrate.

### TagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/tagcategory.md

**Inheritance:**
java.lang.Object
```
public class TagCategory
```

Represents a set of tags having some shared characteristics.
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the current object. |
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### Tags
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/tags.md

**Inheritance:**
java.lang.Object
```
public class Tags
```

Contains various sets of tags with which most important metadata properties are marked. The tags allow you to find and update metadata properties in different packages regardless of the metadata standard and file format.
#### Constructors

| Constructor | Description |
| --- | --- |
| Tags() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPerson() | Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. |
| getTool() | Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |
| getTime() | Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. |
| getContent() | Gets the tags that are attached to metadata properties describing the content of a file. |
| getPropertyType() | Gets a set of tags that bear additional information about the type of a property rather than about its purpose. |
| getDocument() | Gets a set of tags that are applied to document-specific properties only. |
| getOrigin() | Gets the tags that help a user to determine the origin of a file (e.g. |
| getCorporate() | Gets a set of tags intended to mark metadata properties related to a company that participated in file creation. |
| getLegal() | Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
##### Tags()
```
public Tags()
```

##### getPerson()
```
public static PersonTagCategory getPerson()
```

Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.

**Returns:**
PersonTagCategory - A set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation.
##### getTool()
```
public static ToolTagCategory getTool()
```

Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.

**Returns:**
ToolTagCategory - The tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.
##### getTime()
```
public static TimeTagCategory getTime()
```

Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.

**Returns:**
TimeTagCategory - A set of tags that mark metadata properties used to describe the lifecycle of a file.
##### getContent()
```
public static ContentTagCategory getContent()
```

Gets the tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.

**Returns:**
ContentTagCategory - The tags that are attached to metadata properties describing the content of a file.
##### getPropertyType()
```
public static PropertyTypeTagCategory getPropertyType()
```

Gets a set of tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.

**Returns:**
PropertyTypeTagCategory
##### getDocument()
```
public static DocumentTagCategory getDocument()
```

Gets a set of tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.

**Returns:**
DocumentTagCategory - A set of tags that are applied to document-specific properties only.
##### getOrigin()
```
public static OriginTagCategory getOrigin()
```

Gets the tags that help a user to determine the origin of a file (e.g. template or another source).

**Returns:**
OriginTagCategory - The tags that help a user to determine the origin of a file (e.g. template or another source).
##### getCorporate()
```
public static CorporateTagCategory getCorporate()
```

Gets a set of tags intended to mark metadata properties related to a company that participated in file creation.

**Returns:**
CorporateTagCategory - A set of tags intended to mark metadata properties related to a company that participated in file creation.
##### getLegal()
```
public static LegalTagCategory getLegal()
```

Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

**Returns:**
LegalTagCategory - A set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

### TimeTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/timetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class TimeTagCategory extends TagCategory
```

Provides tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.
#### Methods

| Method | Description |
| --- | --- |
| getIntellectualContentCreated() | Gets the tag that denotes the date the intellectual content of a file was created. |
| getCreated() | Gets the tag that indicates the date a file was created. |
| getModified() | Gets the tag that indicates the date a file was edited. |
| getPublished() | Gets the tag that indicates the date a file became available. |
| getPrinted() | Gets the tag that denotes the date a file was printed. |
| getExpired() | Gets the tag that labels the latest date the owner intends the file data to be used. |
| getTotalEditingTime() | Gets the tag that denotes the total editing time of a file. |
| getDuration() | Gets the tag that denotes the duration of a media file. |
| getZoneCity() | Gets the tag that denotes the time zone. |
##### getIntellectualContentCreated()
```
public final PropertyTag getIntellectualContentCreated()
```

Gets the tag that denotes the date the intellectual content of a file was created.

**Returns:**
PropertyTag - The tag that denotes the date the intellectual content of a file was created.
##### getCreated()
```
public final PropertyTag getCreated()
```

Gets the tag that indicates the date a file was created.

**Returns:**
PropertyTag - The tag that indicates the date a file was created.
##### getModified()
```
public final PropertyTag getModified()
```

Gets the tag that indicates the date a file was edited.

**Returns:**
PropertyTag - The tag that indicates the date a file was edited.
##### getPublished()
```
public final PropertyTag getPublished()
```

Gets the tag that indicates the date a file became available.

**Returns:**
PropertyTag - The tag that indicates the date a file became available.
##### getPrinted()
```
public final PropertyTag getPrinted()
```

Gets the tag that denotes the date a file was printed.

**Returns:**
PropertyTag - The tag that denotes the date a file was printed.
##### getExpired()
```
public final PropertyTag getExpired()
```

Gets the tag that labels the latest date the owner intends the file data to be used.

**Returns:**
PropertyTag - The tag that labels the latest date the owner intends the file data to be used.
##### getTotalEditingTime()
```
public final PropertyTag getTotalEditingTime()
```

Gets the tag that denotes the total editing time of a file.

**Returns:**
PropertyTag - The tag that denotes the total editing time of a file.
##### getDuration()
```
public final PropertyTag getDuration()
```

Gets the tag that denotes the duration of a media file.

**Returns:**
PropertyTag - The tag that denotes the duration of a media file.
##### getZoneCity()
```
public final PropertyTag getZoneCity()
```

Gets the tag that denotes the time zone.

**Returns:**
PropertyTag - The tag that denotes the time zone.

### ToolTagCategory
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.tagging/tooltagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class ToolTagCategory extends TagCategory
```

Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.
#### Methods

| Method | Description |
| --- | --- |
| getSoftware() | Gets the tag that labels any kind of software used to create a file. |
| getHardware() | Gets the tag that denotes any kind of hardware used to create a file. |
| getSoftwareVersion() | Gets the tag that labels properties containing the version of the software used to create a file. |
| getHardwareVersion() | Gets the tag that labels properties containing the version of the hardware used to create a file. |
| getSoftwareManufacturer() | Gets the tag that marks a software manufacturer. |
| getHardwareManufacturer() | Gets the tag that marks a hardware manufacturer. |
| getModelId() | Gets the tag that marks a model id. |
##### getSoftware()
```
public final PropertyTag getSoftware()
```

Gets the tag that labels any kind of software used to create a file.

**Returns:**
PropertyTag - The tag that labels any kind of software used to create a file.
##### getHardware()
```
public final PropertyTag getHardware()
```

Gets the tag that denotes any kind of hardware used to create a file.

**Returns:**
PropertyTag - The tag that denotes any kind of hardware used to create a file.
##### getSoftwareVersion()
```
public final PropertyTag getSoftwareVersion()
```

Gets the tag that labels properties containing the version of the software used to create a file.

**Returns:**
PropertyTag - The tag that labels properties containing the version of the software used to create a file.
##### getHardwareVersion()
```
public final PropertyTag getHardwareVersion()
```

Gets the tag that labels properties containing the version of the hardware used to create a file.

**Returns:**
PropertyTag - The tag that labels properties containing the version of the hardware used to create a file.
##### getSoftwareManufacturer()
```
public final PropertyTag getSoftwareManufacturer()
```

Gets the tag that marks a software manufacturer.

**Returns:**
PropertyTag - The tag that marks a software manufacturer.
##### getHardwareManufacturer()
```
public final PropertyTag getHardwareManufacturer()
```

Gets the tag that marks a hardware manufacturer.

**Returns:**
PropertyTag - The tag that marks a hardware manufacturer.
##### getModelId()
```
public final PropertyTag getModelId()
```

Gets the tag that marks a model id.

**Returns:**
PropertyTag - The tag that marks a model id.

### com.groupdocs.metadata
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata.md

The **com.groupdocs.metadata** namespace is the entry point to all features of the library.

#### Classes

| Class | Description |
| --- | --- |
| Metadata | Provides the main class to access metadata in all supported formats. |

### Metadata
Path: https://reference.groupdocs.com/metadata/java/com.groupdocs.metadata/metadata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public final class Metadata implements Closeable
```

Provides the main class to access metadata in all supported formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| Metadata(String filePath) | Initializes a new instance of the  Metadata  class. |
| Metadata(InputStream document) | Initializes a new instance of the  Metadata  class. |
| Metadata(String filePath, LoadOptions loadOptions) | Initializes a new instance of the  Metadata  class. |
| Metadata(InputStream document, LoadOptions loadOptions) | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets the type of the loaded file (if recognized). |
| getRootPackage() | Gets the root package providing access to all metadata properties extracted from the file. |
| <TRoot>getRootPackageGeneric() | Gets the root package providing access to all metadata properties extracted from the file. |
| findProperties(Specification specification) | Finds the metadata properties satisfying a specification. |
| updateProperties(Specification specification, PropertyValue value) | Updates known metadata properties satisfying a specification. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| addProperties(Specification specification, PropertyValue value) | Adds known metadata properties satisfying the specification. |
| setProperties(Specification specification, PropertyValue value) | Sets known metadata properties satisfying the specification. |
| sanitize() | Removes writable metadata properties from all detected packages or whole packages if possible. |
| save() | Saves all changes made in the loaded document. |
| save(OutputStream document) | Saves the document content into a stream. |
| save(String filePath) | Saves the document content to the specified file. |
| generatePreview(PreviewOptions previewOptions) | Creates preview images for specified pages. |
| getDocumentInfo() | Gets common information about the loaded document. |
| copyTo(MetadataPackage metadataPackage) | Copy known metadata properties from source package to destination package. |
| copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags) | Copy known metadata properties from source package to destination package. |
| close() | Closes the loaded document and releases any system resources associated with it. |
##### Metadata(String filePath)
```
public Metadata(String filePath)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | A string that contains the full name of the file from which to create a  Metadata  instance.

This example demonstrates how to load a file from a local disk.

> ```
> ```
>
>  // Constants.InputOne is an absolute or relative path to your document. Ex: @"C:\Docs\source.one"
>  try (Metadata metadata = new Metadata(Constants.InputOne)) {
>      // Extract, edit or remove metadata here
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(InputStream document)
```
public Metadata(InputStream document)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | A stream that contains the document to load.

This example demonstrates how to load a file from a stream.

> ```
> ```
>
>  // Constants.InputDoc is an absolute or relative path to your document. Ex: @"C:\Docs\source.doc"
>  try (InputStream stream = new FileInputStream(Constants.InputDoc)) {
>      try (Metadata metadata = new Metadata(stream)) {
>          // Extract, edit or remove metadata here
>      }
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(String filePath, LoadOptions loadOptions)
```
public Metadata(String filePath, LoadOptions loadOptions)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | A string that contains the full name of the file from which to create a  Metadata  instance. |
| loadOptions | LoadOptions | Additional options to use when loading a document.

This example demonstrates how to load a password-protected document.

> ```
> ```
>
>  // Specify the password
>  LoadOptions loadOptions = new LoadOptions();
>  loadOptions.setPassword("123");
>  // Constants.ProtectedDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>  try (Metadata metadata = new Metadata(Constants.ProtectedDocx, loadOptions)) {
>      // Extract, edit or remove metadata here
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(InputStream document, LoadOptions loadOptions)
```
public Metadata(InputStream document, LoadOptions loadOptions)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | A stream that contains the document to load. |
| loadOptions | LoadOptions | Additional options to use when loading a document.

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the type of the loaded file (if recognized).

**Returns:**
FileFormat - The type of the loaded file if recognized; otherwise,  F:GroupDocs.Metadata.FileFormat.Unknown .
##### getRootPackage()
```
public final RootMetadataPackage getRootPackage()
```

Gets the root package providing access to all metadata properties extracted from the file.

**Returns:**
RootMetadataPackage - The root package providing access to all metadata properties extracted from the file.

This example demonstrates how to traverse the whole metadata tree for a specific file regardless of the format.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.JpegWithXmp)) {
>          displayMetadataTree(metadata.getRootPackage(), 0);
>      }
>  }
>  private static void displayMetadataTree(MetadataPackage metadata, int indent) {
>      if (metadata != null) {
>          String stringMetadataType = String.valueOf(metadata.getMetadataType());
>          System.out.printf("%" + (stringMetadataType.length() + indent) + "s%n", stringMetadataType);
>          for (MetadataProperty property : metadata) {
>              String stringPropertyRepresentation = "Name: " + property.getName() + ", Value: " + property.getValue();
>              System.out.printf("%" + (stringPropertyRepresentation.length() + indent + 1) + "s%n", stringPropertyRepresentation);
>              if (property.getValue() != null) {
>                  switch (property.getValue().getType()) {
>                      case MetadataPropertyType.Metadata:
>                          displayMetadataTree(property.getValue().toClass(MetadataPackage.class), indent + 2);
>                      break;
>                      case MetadataPropertyType.MetadataArray:
>                          displayMetadataTree(property.getValue().toArray(MetadataPackage.class), indent + 2);
>                      break;
>                  }
>              }
>          }
>      }
>  }
>  private static void displayMetadataTree(MetadataPackage[] metadataArray, int indent) {
>      if (metadataArray != null) {
>          for (MetadataPackage metadata : metadataArray) {
>              displayMetadataTree(metadata, indent);
>          }
>      }
>  }
>
> ```
> ```

[Traverse a whole metadata tree]: https://docs.groupdocs.com/display/metadatajava/Traverse+a+whole+metadata+tree
##### <TRoot>getRootPackageGeneric()
```
public final TRoot <TRoot>getRootPackageGeneric()
```

Gets the root package providing access to all metadata properties extracted from the file.

[Traverse a whole metadata tree]: https://docs.groupdocs.com/display/metadatajava/Traverse+a+whole+metadata+tree

**Returns:**
TRoot - The root package providing access to all metadata properties extracted from the file.

 TRoot : The exact type of the root package.
##### findProperties(Specification specification)
```
public final IReadOnlyList<MetadataProperty> findProperties(Specification specification)
```

Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A function to test each metadata property for a condition.

This example demonstrates how to search for specific metadata properties using tags.

> ```
> ```
>
>  // Constants.InputPptx is an absolute or relative path to your document. Ex: @"C:\Docs\source.pptx"
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      // Fetch all the properties satisfying the predicate:
>      // property contains the name of the last document editor OR the date/time the document was last modified
>      IReadOnlyList properties = metadata.findProperties(
>              new ContainsTagSpecification(Tags.getPerson().getEditor()).or(new ContainsTagSpecification(Tags.getTime().getModified())));
>      for (MetadataProperty property : properties) {
>          System.out.println(String.format("Property name: %s, Property value: %s", property.getName(), property.getValue()));
>      }
>  }
>
> ```
> ```

[Extracting metadata]: https://docs.groupdocs.com/display/metadatajava/Extracting+metadata |

**Returns:**
IReadOnlyList - A collection that contains properties from the package that satisfy the condition.
##### updateProperties(Specification specification, PropertyValue value)
```
public final int updateProperties(Specification specification, PropertyValue value)
```

Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

This example demonstrates how to update existing metadata properties by various criteria regardless of the file format.

> ```
> ```
>
>  public class UpdatingMetadata {
>      public static void run() {
>          Date threeDaysAgo = new Date(System.currentTimeMillis() - TimeUnit.DAYS.toMillis(3));
>          File folder = new File(Constants.InputPath);
>          for (File file : folder.listFiles()) {
>              try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>                  if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>                      System.out.println();
>                      System.out.println(file.getName());
>                      // Update the file creation date/time if the existing value is older than 3 days
>                      int affected = metadata.updateProperties(new ContainsTagSpecification(Tags.getTime().getCreated()).and(
>                              new OfTypeSpecification(MetadataPropertyType.DateTime)).and(
>                              new UpdatingMetadata().new DateBeforeSpecification(threeDaysAgo)), new PropertyValue(new Date()));
>                      System.out.println(String.format("Affected properties: %s", affected));
>                      metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>                  }
>              }
>          }
>      }
>      // Define your own specifications to filter metadata properties
>      public class DateBeforeSpecification extends Specification {
>          public DateBeforeSpecification(Date date) {
>              setValue(date);
>          }
>
>          public final Date getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Date value) {
>              auto_Value = value;
>          }
>
>          private Date auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              Date date = candidate.getValue().toClass(Date.class);
>              if (date != null) {
>                  return date.before(getValue());
>              }
>              return false;
>          }
>      }
>  }
>
> ```
> ```

[Updating metadata]: https://docs.groupdocs.com/display/metadatajava/Updating+metadata |

**Returns:**
int - The number of affected properties.
##### removeProperties(Specification specification)
```
public final int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition.

This example demonstrates how to remove specific metadata properties using various criteria.

> ```
> ```
>
>  public class RemoveMetadataProperties {
>      public static void run() {
>          // Constants.InputDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>          try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>
>              // Remove all the properties satisfying the predicate:
>              // property contains the name of the document author OR
>              // it refers to the last editor OR
>              // the property value is a string that is equal to the given string "John" (to remove any mentions of John from the detected metadata)
>              int affected = metadata.removeProperties(
>                      new ContainsTagSpecification(Tags.getPerson().getCreator()).or(
>                              new ContainsTagSpecification(Tags.getPerson().getEditor())).or(
>                              new OfTypeSpecification(MetadataPropertyType.String).and(new RemoveMetadataProperties().new WithValueSpecification("John"))));
>
>              System.out.println(String.format("Properties removed: %s", affected));
>
>              metadata.save(Constants.OutputDocx);
>          }
>      }
>
>      // Define your own specifications to filter metadata properties
>      public class WithValueSpecification extends Specification {
>          public WithValueSpecification(Object value) {
>              setValue(value);
>          }
>
>          public final Object getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Object value) {
>              auto_Value = value;
>          }
>
>          private Object auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              return candidate.getValue().getRawValue().equals(getValue());
>          }
>      }
>  }
>
> ```
> ```

[Removing metadata]: https://docs.groupdocs.com/display/metadatajava/Removing+metadata |

**Returns:**
int - The number of affected properties.
##### addProperties(Specification specification, PropertyValue value)
```
public final int addProperties(Specification specification, PropertyValue value)
```

Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties.

This example demonstrates how to add some missing metadata properties to a file regardless of its format.

> ```
> ```
>
>  File folder = new File(Constants.InputPath);
>  for (File file : folder.listFiles()) {
>      try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>          if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>              System.out.println();
>              System.out.println(file.getName());
>              // Add a property containing the file last printing date if it's missing
>              // Note that the property will be added to metadata packages that satisfy the following criteria:
>              // 1) Only existing metadata packages will be affected. No new packages are added during this operation
>              // 2) There should be a known metadata property in the package structure that fits the search condition but is actually missing in the package.
>              // All properties supported by a certain package are usually defined in the specification of a particular metadata standard
>              int affected = metadata.addProperties(new ContainsTagSpecification(Tags.getTime().getPrinted()), new PropertyValue(new Date()));
>              System.out.println(String.format("Affected properties: %s", affected));
>              metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>          }
>      }
>  }
>
> ```
> ```

[Adding metadata]: https://docs.groupdocs.com/display/metadatajava/Adding+metadata |

**Returns:**
int - The number of affected properties.
##### setProperties(Specification specification, PropertyValue value)
```
public final int setProperties(Specification specification, PropertyValue value)
```

Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of  AddProperties  and  UpdateProperties . If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

This example demonstrates how to set specific metadata properties using different criteria.

> ```
> ```
>
>  // Constants.InputVsdx is an absolute or relative path to your document. Ex: @"C:\Docs\source.vsdx"
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      // Set the value of each property that satisfies the predicate:
>      // property contains the date/time the document was created OR modified
>      int affected = metadata.setProperties(
>              new ContainsTagSpecification(Tags.getTime().getCreated()).or(new ContainsTagSpecification(Tags.getTime().getModified())),
>              new PropertyValue(new Date()));
>      System.out.println(String.format("Properties set: %s", affected));
>      metadata.save(Constants.OutputVsdx);
>  }
>
> ```
> ```

[Set metadata properties]: https://docs.groupdocs.com/display/metadatajava/Set+metadata+properties |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public final int sanitize()
```

Removes writable metadata properties from all detected packages or whole packages if possible. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

This example demonstrates how to remove all detected metadata packages/properties from a file.

> ```
> ```
>
>  // Constants.InputPdf is an absolute or relative path to your document. Ex: @"C:\Docs\source.pdf"
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      // Remove detected metadata packages
>      int affected = metadata.sanitize();
>      System.out.println(String.format("Properties removed: %s", affected));
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata
##### save()
```
public final void save()
```

Saves all changes made in the loaded document.

This example shows how to save the modified content to the underlying file.

> ```
> ```
>
>  // Constants.InputPpt is an absolute or relative path to your document. Ex: @"C:\Docs\test.ppt"
>  File outputFile = new File(Constants.OutputPpt);
>  outputFile.delete();
>  Files.copy(new File(Constants.InputPpt).toPath(), outputFile.toPath());
>  try (Metadata metadata = new Metadata(Constants.OutputPpt)) {
>      // Edit or remove metadata here
>      // Saves the document to the underlying file
>      metadata.save();
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves the document content into a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | An output stream for the document.

This example shows how to save a document to the specified stream.

> ```
> ```
>
>  try (OutputStream stream = new FileOutputStream(Constants.OutputPng)) {
>      // Constants.InputPng is an absolute or relative path to your document. Ex: @"C:\Docs\test.png"
>      try (Metadata metadata = new Metadata(Constants.InputPng)) {
>          // Edit or remove metadata here
>          metadata.save(stream);
>      }
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves the document content to the specified file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file.

This example shows how to save a document to the specified location.

> ```
> ```
>
>  // Constants.InputJpeg is an absolute or relative path to your document. Ex: @"C:\Docs\test.jpg"
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      // Edit or remove metadata here
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream |

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Creates preview images for specified pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | A set of options for preview generation.

[Generate document preview]: https://docs.groupdocs.com/display/metadatajava/Generate+document+preview |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets common information about the loaded document.

**Returns:**
IDocumentInfo - An object representing common document information.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

> ```
> This example demonstrates how to copy metadata properties from source package to destination package.
>
>  Metadata source_metadata = new Metadata(Constants.InputPdf);
>  Metadata destination_metadata = new Metadata(Constants.DestinationPdf);
>  {
>      source_metadata.copyTo(destination_metadata);
>      source_metadata.save();
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage | A destination metadata package.

If the package types do not match, an error will be returned. |

##### copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags)
```
public int copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags)
```

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

> ```
> This example demonstrates how to copy metadata properties from source package to destination package.
>
>  Metadata source_metadata = new Metadata(Constants.InputPdf);
>  Metadata destination_metadata = new Metadata(Constants.DestinationPdf);
>  {
>      List<PropertyTag> tags = new ArrayList<PropertyTag>();
>      tags.add(Tags.getPerson().getCreator());
>      source_metadata.copyTo(destination_metadata, tags);
>      source_metadata.save();
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage | A destination metadata package. |
| tags | java.util.List<com.groupdocs.metadata.tagging.PropertyTag> | A list of the tags.

If the package types do not match, an error will be returned. |

**Returns:**
int - The number of affected properties.
##### close()
```
public void close()
```

Closes the loaded document and releases any system resources associated with it.

## .NET

### GroupDocs.Metadata for .NET
Path: https://reference.groupdocs.com/metadata/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Metadata | The namespace provides main classes allowing working with metadata in all supported formats. The `Metadata` class is the entry point to all features of the library. |
| GroupDocs.Metadata.Common | The namespace contains base classes, utility classes and interfaces used across all formats and metadata standards. |
| GroupDocs.Metadata.Exceptions | The namespace contains some specific exceptions that are thrown by the library during file reading and updating. |
| GroupDocs.Metadata.Export | The namespace contains classes that allow users to export metadata properties to different representations. |
| GroupDocs.Metadata.Formats.Archive | The namespace contains classes for working with archive formats. |
| GroupDocs.Metadata.Formats.Audio | The namespace provides classes intended to work with different audio formats. |
| GroupDocs.Metadata.Formats.Audio.Ogg |  |
| GroupDocs.Metadata.Formats.BusinessCard | The namespace contains classes intended to work with electronic business card formats. |
| GroupDocs.Metadata.Formats.Cad | The namespace contains classes for working with CAD (computer-aided design) formats. |
| GroupDocs.Metadata.Formats.Document | The namespace provides functionality intended to work with a variety of document formats such as spreadsheets, presentations, text processing formats, etc. |
| GroupDocs.Metadata.Formats.Ebook | The namespace provides functionality for working with electronic book formats. |
| GroupDocs.Metadata.Formats.Ebook.Fb2 |  |
| GroupDocs.Metadata.Formats.Ebook.Mobi |  |
| GroupDocs.Metadata.Formats.Email | The namespace contains classes representing saved email messages and their parts. |
| GroupDocs.Metadata.Formats.Email.Msg |  |
| GroupDocs.Metadata.Formats.Fb2 |  |
| GroupDocs.Metadata.Formats.Font | The namespace contains classes allowing users to work with formats representing scalable computer fonts. |
| GroupDocs.Metadata.Formats.Gis |  |
| GroupDocs.Metadata.Formats.Image | The namespace provides functionality allowing users to read and update metadata stored in different image formats. |
| GroupDocs.Metadata.Formats.Image.Dng |  |
| GroupDocs.Metadata.Formats.Image.Svg |  |
| GroupDocs.Metadata.Formats.Mpeg | The namespace provides functionality allowing users to work with metadata of various MPEG standards. |
| GroupDocs.Metadata.Formats.Peer2Peer | The namespace contains classes intended to work with different formats based on the peer2peer protocol. |
| GroupDocs.Metadata.Formats.Raw |  |
| GroupDocs.Metadata.Formats.Raw.Cr2 |  |
| GroupDocs.Metadata.Formats.Raw.Tag |  |
| GroupDocs.Metadata.Formats.Riff | The namespace provides functionality allowing users to work with metadata of various formats derived from the RIFF container. |
| GroupDocs.Metadata.Formats.ThreeD.Dae |  |
| GroupDocs.Metadata.Formats.ThreeD.Fbx |  |
| GroupDocs.Metadata.Formats.ThreeD.Gltf |  |
| GroupDocs.Metadata.Formats.ThreeD.Stl |  |
| GroupDocs.Metadata.Formats.ThreeD.ThreeDS |  |
| GroupDocs.Metadata.Formats.Video | The namespace contains classes for working with the most popular video formats. |
| GroupDocs.Metadata.Import |  |
| GroupDocs.Metadata.Logging |  |
| GroupDocs.Metadata.Options | The namespace contains all classes representing settings that allow users to control file and metadata processing. |
| GroupDocs.Metadata.Standards.DublinCore | The namespace contains functionality intended to read DublinCore metadata from files of different formats. |
| GroupDocs.Metadata.Standards.Exif | The namespace contains functionality intended to read and write EXIF (exchangeable image file format) metadata. |
| GroupDocs.Metadata.Standards.Exif.MakerNote | The namespace contains classes intended to work with MakerNote metadata written by various camera manufacturers. |
| GroupDocs.Metadata.Standards.Iptc | The namespace contains classes allowing users to work with IPTC metadata. |
| GroupDocs.Metadata.Standards.Pkcs | The namespace provides functionality intended to work with digital signatures based on the syntax of PKCS #7, specified in RFC 5652. |
| GroupDocs.Metadata.Standards.Signing | The namespace provides base functionality intended to work with digital signatures. |
| GroupDocs.Metadata.Standards.Xmp | The namespace provides functionality for XMP (Extensible Metadata Platform) metadata reading and writing. |
| GroupDocs.Metadata.Standards.Xmp.Schemes | Contains the implementation of different XMP Schemes. |
| GroupDocs.Metadata.Tagging | The namespace contains various sets of tags with which most important metadata properties are marked. The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### GroupDocs.Metadata.Common
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common.md

The namespace contains base classes, utility classes and interfaces used across all formats and metadata standards.

#### Classes

| Class | Description |
| --- | --- |
| CustomPackage | Provides a container for metadata properties. |
| DocumentInfo | Provides common information about a loaded document. |
| FeatureSupport | Represents support information for a specific product feature. |
| FileType | Represents the file type. |
| FileTypeFeatureSupport | Represents product feature support information for a specific file extension. |
| FileTypePackage | Represents a metadata package containing file format information. |
| Func&lt;TResult&gt; | Encapsulates a method that has no parameters and returns a value of the type specified by the *TResult* parameter. |
| Func&lt;T,TResult&gt; | Encapsulates a method that has one parameter and returns a value of the type specified by the *TResult* parameter. |
| MetadataPackage | Represents base abstraction for a metadata package. |
| MetadataProperty | Represents a metadata property. |
| MetadataPropertyEqualityComparer | Defines methods to support the comparison of metadata properties for equality. |
| PageInfo | Provides common information about a document page (slide, worksheet, etc). |
| PropertyDescriptor | Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine. |
| PropertyValue | Represents a property value. |
| PropertyValueEqualityComparer | Defines methods to support the comparison of property values for equality. |
| ReadOnlyList&lt;T&gt; | Provides an abstract base class for a strongly typed read-only list. |
| RootMetadataPackage | Represents an entry point to all metadata packages presented in a particular file. |
| ValueAcceptor | Provides a base abstract class that allows extracting all supported types of values from a `PropertyValue` instance. |
| ValueInterpreter | Defines operations required to interpret metadata property values. |
#### Structures

| Structure | Description |
| --- | --- |
| Rectangle | A set of four integers that represent the location and size of a rectangle. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Provides common information about a loaded document. |
| IEnumValueInterpreter | Represents an interpreter intended to convert various numeric values to descriptive string values. |
| IReadOnlyList&lt;T&gt; | Represents a read-only collection of elements that can be accessed by index. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ByteOrder | Defines various byte orders. |
| FileFormat | Represents the recognized format of a loaded file. |
| FormatFamily | Groups file types into families for documentation and feature matrices. |
| MetadataPropertyType | Defines metadata property types. |
| MetadataType | Specifies the type of a metadata package. |
| ProductFeature | Specifies product features that can be supported by a file type. |
| PropertyAccessLevels | Defines access levels for metadata properties. |
| SupportLevel | Specifies the feature support level. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ByteOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/byteorder.md

#### ByteOrder enumeration

Defines various byte orders.

```csharp
public enum ByteOrder
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The byte order is unknown. |
| BigEndian | `1` | Big endian. |
| LittleEndian | `2` | Little endian. |

### CustomPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/custompackage.md

#### CustomPackage class

Provides a container for metadata properties.

```csharp
public abstract class CustomPackage : MetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DocumentInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo.md

#### DocumentInfo class

Provides common information about a loaded document.

```csharp
public class DocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the file type of the loaded document. |
| IsEncrypted { get; } | Gets a value indicating whether the document is encrypted and requires a password to open. |
| PageCount { get; } | Gets the number of pages (slides, worksheets, etc) in the loaded document. |
| Pages { get; } | Gets a collection of objects representing common information about the document pages (slides, worksheets, etc). |
| Size { get; } | Gets the size of the loaded document in bytes. |

##### Examples

This example demonstrates how to extract basic format information from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    if (metadata.FileFormat != FileFormat.Unknown)
    {
        IDocumentInfo info = metadata.GetDocumentInfo();

        Console.WriteLine("File format: {0}", info.FileType.FileFormat);
        Console.WriteLine("File extension: {0}", info.FileType.Extension);
        Console.WriteLine("MIME Type: {0}", info.FileType.MimeType);
        Console.WriteLine("Number of pages: {0}", info.PageCount);
        Console.WriteLine("Document size: {0} bytes", info.Size);
        Console.WriteLine("Is document encrypted: {0}", info.IsEncrypted);
    }
}
```

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo/filetype.md

#### DocumentInfo.FileType property

Gets the file type of the loaded document.

```csharp
public FileTypePackage FileType { get; }
```

##### Property Value

The file type of the loaded document.

### IsEncrypted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo/isencrypted.md

#### DocumentInfo.IsEncrypted property

Gets a value indicating whether the document is encrypted and requires a password to open.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

A value indicating whether the document is encrypted and requires a password to open.

### PageCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

Gets the number of pages (slides, worksheets, etc) in the loaded document.

```csharp
public int PageCount { get; }
```

##### Property Value

The number of pages (slides, worksheets, etc) in the loaded document.

### Pages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo/pages.md

#### DocumentInfo.Pages property

Gets a collection of objects representing common information about the document pages (slides, worksheets, etc).

```csharp
public IReadOnlyList<PageInfo> Pages { get; }
```

##### Property Value

A collection of objects representing common information about the document pages (slides, worksheets, etc).

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/documentinfo/size.md

#### DocumentInfo.Size property

Gets the size of the loaded document in bytes.

```csharp
public long Size { get; }
```

##### Property Value

The size of the loaded document in bytes.

### FeatureSupport
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/featuresupport.md

#### FeatureSupport class

Represents support information for a specific product feature.

```csharp
public sealed class FeatureSupport
```

#### Properties

| Name | Description |
| --- | --- |
| Feature { get; } | Gets the product feature this entry describes. |
| Level { get; } | Gets the support level for this feature. |

### Feature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/featuresupport/feature.md

#### FeatureSupport.Feature property

Gets the product feature this entry describes.

```csharp
public ProductFeature Feature { get; }
```

### Level
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/featuresupport/level.md

#### FeatureSupport.Level property

Gets the support level for this feature.

```csharp
public SupportLevel Level { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/fileformat.md

#### FileFormat enumeration

Represents the recognized format of a loaded file.

```csharp
public enum FileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The file type is not recognized. |
| Presentation | `1` | A presentation file. You must be familiar with PPTX and PPT extension files while working with Microsoft PowerPoint. These are Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Learn more about this file format [here](https://wiki.fileformat.com/presentation/). |
| Spreadsheet | `2` | A spreadsheet file. A spreadsheet file contains data in the form of rows and columns. You can open, view and edit such files using spreadsheet software applications such as Microsoft Excel that is now available for both Windows and MacOS operating system. Similarly, Google sheets is a free online spreadsheet creating and editing tool that works from any web browser. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/). |
| WordProcessing | `3` | A word processing file. A word processing file contains 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. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/). |
| Diagram | `4` | A diagram file. |
| Note | `5` | An electronic note file. Note-taking programs such as Microsoft OneNote lets you create, open and edit notes files that contain sections and pages for storing notes. A note document can be as simple as a text document as well as more detailed consisting of digital images, audio/video clips, and hand sketch drawings. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/). |
| ProjectManagement | `6` | A project management format. Have you ever come across and wondered what is an MPP file or how to open it? MPP and other similar files are Project file formats that are created by Project Management software such as Microsoft Project. 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. Learn more about this file format [here](https://wiki.fileformat.com/project-management/). |
| Pdf | `7` | A PDF file. 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/). |
| Tiff | `8` | A TIFF image. TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| Jpeg | `9` | A JPEG image. JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| Psd | `10` | A PSD image. PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. PSD files may include image layers, adjustment layers, layer masks, annotations, file information, keywords and other Photoshop-specific elements. Learn more about this file format [here](https://wiki.fileformat.com/image/psd/). |
| Jpeg2000 | `11` | A Jpeg2000 image. JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| Gif | `12` | A GIF image. A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| Png | `13` | A PNG image. PNG, Portable Network Graphics, refers to a type of raster image file format that use lossless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| Bmp | `14` | A BMP image. Files having extension .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/). |
| Dicom | `15` | A DICOM image. DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is the combination of file format definition and a network communications protocol. Learn more about this file format [ here ](https://wiki.fileformat.com/image/dicom/). |
| WebP | `16` | A WEBP image. 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/). |
| Emf | `17` | An EMF image. 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/). |
| Wmf | `18` | A WMF image. Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. To be more accurate, WMF belongs to the vector file format category of Graphics file formats that is device independent. Learn more about this file format [here](https://wiki.fileformat.com/image/wmf/). |
| DjVu | `19` | A DjVu file. DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. It was developed by AT&amp;T Labs. Learn more about this file format [here](https://wiki.fileformat.com/image/djvu/). |
| Wav | `20` | A WAV audio file. 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. The format doesn't apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. Learn more about this file format [here](https://wiki.fileformat.com/audio/wav/). |
| Mp3 | `21` | An Mp3 audio file. 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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Learn more about this file format [here](https://wiki.fileformat.com/audio/mp3/). |
| Avi | `22` | An AVI video. 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://wiki.fileformat.com/video/avi/). |
| Flv | `23` | An FLV video. |
| Asf | `24` | An ASF video. The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/wmv/). |
| Mov | `25` | A QuickTime video. Mov or QuickTime File format is 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. Mov format is compatible both in Windows and Macintosh systems. Learn more about this file format [here](https://wiki.fileformat.com/video/mov/). |
| Matroska | `26` | A video encoded with the Matroska multimedia container. |
| Zip | `27` | A ZIP archive. ZIP file extension represents archives 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. ZIP file format was made public back in February 1989 by Phil Katz for achieving archiving of files and folders. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/). |
| SevenZip | `28` | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License. |
| VCard | `29` | A VCard file. 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/). |
| Epub | `30` | An EPUB electronic book. Files with .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/). |
| OpenType | `31` | An OpenType font. |
| Dxf | `32` | A DXF (Drawing Exchange Format) drawing. DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Each element in the file has a prefix integer number called a group code. Learn more about this file format [here](https://wiki.fileformat.com/cad/dxf/). |
| Dwg | `33` | A DWG drawing. 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/). |
| Eml | `34` | An EML email message. 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/). |
| Msg | `35` | An MSG email message. MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Such messages may contain one or more email fields, with the sender, recipient, subject, date, and message body, or contact information, appointment particulars, and one or more task specifications. Learn more about this file format [here](https://wiki.fileformat.com/email/msg/). |
| Torrent | `36` | A torrent file that contains metadata about files and folders to be distributed. |
| Heif | `37` | A HEIF/HEIC image. |
| Dng | `38` | A dng RAW image. |
| Cr2 | `39` | A CR2 image. |
| Rar | `40` | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | `41` | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
| ThreeDS | `42` | 3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software. |
| Dae | `43` | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. |
| Fbx | `44` | FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware. |
| Stl | `45` | STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems’ founder, reports that the file extension is an abbreviation for stereolithography. |
| Gis | `46` | Gis file. |
| Fb2 | `47` | Files with .fb2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. It is based on XML format and contains special tags for describing each element of the book. It was developed primarily for fictional writings and literature, but is not limited to these only. The format accommodates all the metadata as well as content in itself and allows flexibility for a number of operations such as automatic processing, indexing, and conversion to other formats. In short, it focuses on describing the structure of the file instead of specifying its appearance. Several applications as well as APIs are available to convert FB2 to several other formats on Windows, MacOS, and Linux. Learn more about this file format [here](https://docs.fileformat.com/ebook/fb2/). |
| Mobi | `48` | The MOBI file format is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as the proprietary format for Mobipocket Reader. |
| Ogg | `49` | 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. OGG is a free and open container format that is maintained by Xiph.Org Foundation. |
| Svg | `50` | Scalable Vector Graphics (SVG) is an XML-based vector graphics format for defining two-dimensional graphics, having support for interactivity and animation. The SVG specification is an open standard developed by the World Wide Web Consortium since 1999. |
| Gltf | `51` | glTF (Graphics Library Transmission Format or GL Transmission Format and formerly known as WebGL Transmissions Format or WebGL TF) is a standard file format for three-dimensional scenes and models. A glTF file uses one of two possible file extensions: .gltf (JSON/ASCII) or .glb (binary). |
| Avif | `52` | AV1 Image File Format (AVIF) is an open, royalty-free image file format specification for storing images or image sequences compressed with AV1 in the HEIF container format. |

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype.md

#### FileType class

Represents the file type.

```csharp
public class FileType
```

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | Gets the file type description. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Gets FileType for provided fileExtension |
| override ToString() | Returns a String that represents the current `FileType`. |
| static GetSupportedFileTypes() | Retrieves supported file types. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly ASF | The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/wmv/). |
| static readonly AVI | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/avi/). |
| static readonly AVIF | AV1 Image File Format (AVIF) is an open, royalty-free image file format specification for storing images or image sequences compressed with AV1 in the HEIF container format. Learn more about this file format [here](https://docs.fileformat.com/image/avif/). |
| static readonly BMP | Files having extension .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 CBRAR | A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/). |
| static readonly CBSEVEN | A CB7 file refers to Comic Book 7-Zip Archive. It is compressed file format commonly used for storing and distributing comic book collections digitally. CB7 files are created using 7-Zip compression software, which is known for its high compression ratio. [here](https://wiki.fileformat.com/compression/cb7/). |
| static readonly CBTAR | A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/). |
| static readonly CBZIP | A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/). |
| static readonly CR2 | The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. [here](https://wiki.fileformat.com/image/cr2/). |
| static readonly CRW | The .CRW file format is a digital photography RAW format created by Canon. [here](https://wiki.fileformat.com/image/crw/). |
| static readonly DAE | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. [here](https://wiki.fileformat.com/3d/dae/). |
| static readonly DICOM | DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is used for the integration of medical imaging devices like printers, servers, scanners etc from various vendors and also contains identification data of each patient for uniqueness. Learn more about this file format [here](https://docs.fileformat.com/image/dicom/). |
| static readonly DJV | 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 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. DNG is an extension of TIFF/EP standard format and uses metadata significantly. In order to manipulate raw data from digital cameras with the ease of flexibility and artistic control, photographers opt camera raw files. JPEG and TIFF formats store images that are processed by the camera, therefore, not much room for alteration is available in such formats. [here](https://wiki.fileformat.com/image/dng/). |
| 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 DWG | Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwg/). |
| 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 EMF | Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/). |
| static readonly EML | EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://wiki.fileformat.com/email/eml/). |
| static readonly EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/). |
| static readonly FB2 | Files with .fb2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. It is based on XML format and contains special tags for describing each element of the book. It was developed primarily for fictional writings and literature, but is not limited to these only. The format accommodates all the metadata as well as content in itself and allows flexibility for a number of operations such as automatic processing, indexing, and conversion to other formats. In short, it focuses on describing the structure of the file instead of specifying its appearance. Several applications as well as APIs are available to convert FB2 to several other formats on Windows, MacOS, and Linux. Learn more about this file format [here](https://docs.fileformat.com/ebook/fb2/). |
| static readonly FBX | FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware. [here](https://wiki.fileformat.com/3d/fbx/). |
| static readonly FLV | FLV (Flash Video) is a container file format which 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 GEOJSON | GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes. [here](https://docs.fileformat.com/gis/geojson/). |
| static readonly GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| 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. It was adopted for the efficient transmission and loading of 3D scenes and models by applications. glTF was developed by the Khronos Group 3D Formats Working Group and is also described as JPEG of 3D by its creators. [here](https://wiki.fileformat.com/3d/gltf/). |
| static readonly GML | GML stands for Geography Markup Language that is based on XML specifications developed by the Open Geospatial Consortium (OGC). [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. [here](https://docs.fileformat.com/gis/gpx/). |
| 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. HEIC, like HEIF, are compressed using the High Efficiency Video Coding (HEVC) standard and are smaller in size without compromising the quality. Learn more about this file format [here](https://docs.fileformat.com/image/heic/). |
| static readonly HEIF | An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. HEIF file format compresses the images using the High Efficiency Video Coding (HEVC) standard. Learn more about this file format [here](https://docs.fileformat.com/image/heif/). |
| static readonly J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/j2k/). |
| static readonly JAR | JAR is a Java Archive file that contains many different application related files as a single file. This file format was created to reduce the speed of loading a downloaded Java Applet in browser via HTTP transaction, Learn more about this file format [here](https://docs.fileformat.com/programming/jar/). |
| static readonly JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPE | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPEG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpf/). |
| static readonly JPG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpm/). |
| static readonly JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpx/). |
| 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. [here](https://docs.fileformat.com/gis/kml/). |
| static readonly MJ2 | Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression. |
| static readonly MK3D | MK3D is actually stereoscopic 3D video created using Matroska 3D format. The MKV file container uses a StereoMode field’s value to define the type of stereoscopic 3D video stuff. Learn more about this file format [here](https://docs.fileformat.com/video/mk3d/). |
| static readonly MKA | MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. The MKA format supports several different kinds of audio compression algorithms such as MP3, AAC and Vobis. Learn more about this file format [here](https://docs.fileformat.com/audio/mka/). |
| 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. Learn more about this file format [here](https://wiki.fileformat.com/video/mkv/). |
| static readonly MOBI | The MOBI file format is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as the proprietary format for Mobipocket Reader. Like EPUB, it is supported by almost all modern e-readers specifically by mobile devices with low bandwidth. The format can be converted to several other formats such as PDF, EPUB, and several other formats using publicly available software applications such as the Kindle app. There are several companies that offer free MOBI books such as Project Gutenberg, Feedbooks, and Open Library. Learn more about this file format [here](https://docs.fileformat.com/ebook/mobi/). |
| static readonly MOV | MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/). |
| 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://wiki.fileformat.com/audio/mp3/). |
| static readonly MPP | MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp/). |
| static readonly MPT | MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpt/). |
| 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 ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/). |
| static readonly ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |
| 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. OGG is a free and open container format that is maintained by Xiph.Org Foundation. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/). |
| static readonly ONE | File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/). |
| static readonly OSM | OpenStreetMap (OSM) is a huge collection of volunteered geographic information stores in different types of files, using different encoding schemes to convert this data into bits and bytes. [here](https://docs.fileformat.com/gis/osm/). |
| static readonly OTC | OTC (OpenType Collection) is a OpenType font collection format. An OTC file can combine the multiple font files into it. |
| 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. Learn more about this file format [here](https://docs.fileformat.com/font/otf/). |
| 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://docs.fileformat.com/pdf/). |
| static readonly PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| static readonly POT | Files with .POT extension represent Microsoft PowerPoint template files in binary format 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/). |
| 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 QT | MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/). |
| static readonly RAR | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. [here](https://wiki.fileformat.com/compression/rar/). |
| static readonly SEVENZIP | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License. [here](https://wiki.fileformat.com/compression/zip/). |
| static readonly SHP | The shapefile format is a geospatial vector data format for geographic information system (GIS) software. [here](https://docs.fileformat.com/gis/shp/). |
| static readonly STL | STL is a file format native to the stereolithography CAD software created by 3D Systems. Chuck Hull, the inventor of stereolithography and 3D Systems’ founder, reports that the file extension is an abbreviation for stereolithography. [here](https://wiki.fileformat.com/3d/stl/). |
| 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. The word Scalable refers to the fact that the SVG can be scaled to different sizes without losing any quality. Text-based description of such files makes them independent of resolution. It is one of the most used formats for building a website and print graphics in order to achieve scalability. The format can only be used for two-dimensional graphics though. SVG files can be viewed/opened in almost all modern browsers including Chrome, Internet Explorer, Firefox, and Safari. Learn more about this file format [here](https://docs.fileformat.com/image/svg/). |
| static readonly TAR | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. [here](https://wiki.fileformat.com/compression/tar/). |
| 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. [here](https://wiki.fileformat.com/3d/3ds/). |
| static readonly TIF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly TIFF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly TOPOJSON | TopoJSON is an extension of GeoJSON that encodes topology. [here](https://docs.fileformat.com/gis/geojson/). |
| static readonly TORRENT | Represents TORRENT file type. |
| static readonly TTC | TTC (TrueType Collection) is a TrueType font collection format. A TTC file can combine the multiple font files into it. Learn more about this file format [here](https://docs.fileformat.com/font/ttc/). |
| static readonly TTF | TTF represents font files based on the TrueType specifications font technology. TrueType fonts provide highest quality display on computer screens and printers without any dependency on resolution. Learn more about this file format [here](https://docs.fileformat.com/font/ttf/). |
| static readonly Unknown | Represents unknown file type. |
| 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://docs.fileformat.com/email/vcf/). |
| static readonly VCR | VCR (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. |
| static readonly VDX | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here](https://wiki.fileformat.com/visio/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/visio/vsd/). |
| static readonly VSDX | Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here](https://wiki.fileformat.com/visio/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/visio/vss/). |
| 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. Learn more about this file format [here](https://wiki.fileformat.com/visio/vsx/). |
| static readonly VTX | Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here](https://docs.fileformat.com/visio/vtx/). |
| 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://wiki.fileformat.com/audio/wav/). |
| static readonly WEBM | WEBM 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 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 XLS | Files with XLS extension represent 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/specification/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/specification/spreadsheet/xlsb/). |
| static readonly XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/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/specification/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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/). |
| static readonly XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/). |
| static readonly XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/). |
| static readonly ZIP | ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/). |
| static readonly ZIPX | ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods. |

### ASF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/asf.md

#### FileType.ASF field

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/wmv/).

```csharp
public static readonly FileType ASF;
```

### AVI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/avi.md

#### FileType.AVI field

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/avi/).

```csharp
public static readonly FileType AVI;
```

### AVIF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/avif.md

#### FileType.AVIF field

AV1 Image File Format (AVIF) is an open, royalty-free image file format specification for storing images or image sequences compressed with AV1 in the HEIF container format. Learn more about this file format [here](https://docs.fileformat.com/image/avif/).

```csharp
public static readonly FileType AVIF;
```

### BMP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/bmp.md

#### FileType.BMP field

Files having extension .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 FileType BMP;
```

### CBRAR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/cbrar.md

#### FileType.CBRAR field

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/).

```csharp
public static readonly FileType CBRAR;
```

### CBSEVEN
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/cbseven.md

#### FileType.CBSEVEN field

A CB7 file refers to Comic Book 7-Zip Archive. It is compressed file format commonly used for storing and distributing comic book collections digitally. CB7 files are created using 7-Zip compression software, which is known for its high compression ratio. [here](https://wiki.fileformat.com/compression/cb7/).

```csharp
public static readonly FileType CBSEVEN;
```

### CBTAR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/cbtar.md

#### FileType.CBTAR field

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/).

```csharp
public static readonly FileType CBTAR;
```

### CBZIP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/cbzip.md

#### FileType.CBZIP field

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file, is a popular format used to store and distribute digital comic books. It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading. [here](https://wiki.fileformat.com/compression/cba/).

```csharp
public static readonly FileType CBZIP;
```

### CR2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/cr2.md

#### FileType.CR2 field

The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. [here](https://wiki.fileformat.com/image/cr2/).

```csharp
public static readonly FileType CR2;
```

### CRW
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/crw.md

#### FileType.CRW field

The .CRW file format is a digital photography RAW format created by Canon. [here](https://wiki.fileformat.com/image/crw/).

```csharp
public static readonly FileType CRW;
```

### DAE
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dae.md

#### FileType.DAE field

A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. [here](https://wiki.fileformat.com/3d/dae/).

```csharp
public static readonly FileType DAE;
```

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/description.md

#### FileType.Description property

Gets the file type description.

```csharp
public string Description { get; }
```

##### Property Value

The file type description.

### DICOM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dicom.md

#### FileType.DICOM field

DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is used for the integration of medical imaging devices like printers, servers, scanners etc from various vendors and also contains identification data of each patient for uniqueness. Learn more about this file format [here](https://docs.fileformat.com/image/dicom/).

```csharp
public static readonly FileType DICOM;
```

### DJV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/djv.md

#### FileType.DJV 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 FileType DJV;
```

### DJVU
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/djvu.md

#### FileType.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 FileType DJVU;
```

### DNG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dng.md

#### FileType.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. DNG is an extension of TIFF/EP standard format and uses metadata significantly. In order to manipulate raw data from digital cameras with the ease of flexibility and artistic control, photographers opt camera raw files. JPEG and TIFF formats store images that are processed by the camera, therefore, not much room for alteration is available in such formats. [here](https://wiki.fileformat.com/image/dng/).

```csharp
public static readonly FileType DNG;
```

### DOC
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/doc.md

#### FileType.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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/docm.md

#### FileType.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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/docx.md

#### FileType.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dot.md

#### FileType.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 FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dotm.md

#### FileType.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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dotx.md

#### FileType.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 FileType DOTX;
```

### DWG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dwg.md

#### FileType.DWG field

Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here](https://wiki.fileformat.com/cad/dwg/).

```csharp
public static readonly FileType DWG;
```

### DXF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/dxf.md

#### FileType.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 FileType DXF;
```

### EMF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/emf.md

#### FileType.EMF field

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/).

```csharp
public static readonly FileType EMF;
```

### EML
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/eml.md

#### FileType.EML field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).

```csharp
public static readonly FileType EML;
```

### EPUB
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/epub.md

#### FileType.EPUB field

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/).

```csharp
public static readonly FileType EPUB;
```

### Extension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/extension.md

#### FileType.Extension property

Gets the file extension.

```csharp
public string Extension { get; }
```

##### Property Value

The file extension.

### FB2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/fb2.md

#### FileType.FB2 field

Files with .fb2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. It is based on XML format and contains special tags for describing each element of the book. It was developed primarily for fictional writings and literature, but is not limited to these only. The format accommodates all the metadata as well as content in itself and allows flexibility for a number of operations such as automatic processing, indexing, and conversion to other formats. In short, it focuses on describing the structure of the file instead of specifying its appearance. Several applications as well as APIs are available to convert FB2 to several other formats on Windows, MacOS, and Linux. Learn more about this file format [here](https://docs.fileformat.com/ebook/fb2/).

```csharp
public static readonly FileType FB2;
```

### FBX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/fbx.md

#### FileType.FBX field

FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware. [here](https://wiki.fileformat.com/3d/fbx/).

```csharp
public static readonly FileType FBX;
```

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/fileformat.md

#### FileType.FileFormat property

Gets the file format.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

The file format.

### FLV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/flv.md

#### FileType.FLV field

FLV (Flash Video) is a container file format which 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 FileType FLV;
```

### FromExtension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/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

### GEOJSON
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/geojson.md

#### FileType.GEOJSON field

GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes. [here](https://docs.fileformat.com/gis/geojson/).

```csharp
public static readonly FileType GEOJSON;
```

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types.

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

A collection of supported file types.

### GIF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/gif.md

#### FileType.GIF field

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).

```csharp
public static readonly FileType GIF;
```

### GLTF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/gltf.md

#### FileType.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. It was adopted for the efficient transmission and loading of 3D scenes and models by applications. glTF was developed by the Khronos Group 3D Formats Working Group and is also described as JPEG of 3D by its creators. [here](https://wiki.fileformat.com/3d/gltf/).

```csharp
public static readonly FileType GLTF;
```

### GML
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/gml.md

#### FileType.GML field

GML stands for Geography Markup Language that is based on XML specifications developed by the Open Geospatial Consortium (OGC). [here](https://docs.fileformat.com/gis/gml/).

```csharp
public static readonly FileType GML;
```

### GPX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/gpx.md

#### FileType.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. [here](https://docs.fileformat.com/gis/gpx/).

```csharp
public static readonly FileType GPX;
```

### HEIC
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/heic.md

#### FileType.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. HEIC, like HEIF, are compressed using the High Efficiency Video Coding (HEVC) standard and are smaller in size without compromising the quality. Learn more about this file format [here](https://docs.fileformat.com/image/heic/).

```csharp
public static readonly FileType HEIC;
```

### HEIF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/heif.md

#### FileType.HEIF field

An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. HEIF file format compresses the images using the High Efficiency Video Coding (HEVC) standard. Learn more about this file format [here](https://docs.fileformat.com/image/heif/).

```csharp
public static readonly FileType HEIF;
```

### J2K
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/j2k.md

#### FileType.J2K field

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/j2k/).

```csharp
public static readonly FileType J2K;
```

### JAR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jar.md

#### FileType.JAR field

JAR is a Java Archive file that contains many different application related files as a single file. This file format was created to reduce the speed of loading a downloaded Java Applet in browser via HTTP transaction, Learn more about this file format [here](https://docs.fileformat.com/programming/jar/).

```csharp
public static readonly FileType JAR;
```

### JP2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jp2.md

#### FileType.JP2 field

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JP2;
```

### JPE
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpe.md

#### FileType.JPE field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPE;
```

### JPEG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpeg.md

#### FileType.JPEG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPEG;
```

### JPF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpf.md

#### FileType.JPF field

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpf/).

```csharp
public static readonly FileType JPF;
```

### JPG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpg.md

#### FileType.JPG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPG;
```

### JPM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpm.md

#### FileType.JPM field

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpm/).

```csharp
public static readonly FileType JPM;
```

### JPX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/jpx.md

#### FileType.JPX field

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jpx/).

```csharp
public static readonly FileType JPX;
```

### KML
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/kml.md

#### FileType.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. [here](https://docs.fileformat.com/gis/kml/).

```csharp
public static readonly FileType KML;
```

### MJ2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mj2.md

#### FileType.MJ2 field

Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression.

```csharp
public static readonly FileType MJ2;
```

### MK3D
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mk3d.md

#### FileType.MK3D field

MK3D is actually stereoscopic 3D video created using Matroska 3D format. The MKV file container uses a StereoMode field’s value to define the type of stereoscopic 3D video stuff. Learn more about this file format [here](https://docs.fileformat.com/video/mk3d/).

```csharp
public static readonly FileType MK3D;
```

### MKA
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mka.md

#### FileType.MKA field

MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. The MKA format supports several different kinds of audio compression algorithms such as MP3, AAC and Vobis. Learn more about this file format [here](https://docs.fileformat.com/audio/mka/).

```csharp
public static readonly FileType MKA;
```

### MKV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mkv.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/video/mkv/).

```csharp
public static readonly FileType MKV;
```

### MOBI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mobi.md

#### FileType.MOBI field

The MOBI file format is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as the proprietary format for Mobipocket Reader. Like EPUB, it is supported by almost all modern e-readers specifically by mobile devices with low bandwidth. The format can be converted to several other formats such as PDF, EPUB, and several other formats using publicly available software applications such as the Kindle app. There are several companies that offer free MOBI books such as Project Gutenberg, Feedbooks, and Open Library. Learn more about this file format [here](https://docs.fileformat.com/ebook/mobi/).

```csharp
public static readonly FileType MOBI;
```

### MOV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mov.md

#### FileType.MOV field

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).

```csharp
public static readonly FileType MOV;
```

### MP3
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mp3.md

#### FileType.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://wiki.fileformat.com/audio/mp3/).

```csharp
public static readonly FileType MP3;
```

### MPP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mpp.md

#### FileType.MPP field

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp/).

```csharp
public static readonly FileType MPP;
```

### MPT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/mpt.md

#### FileType.MPT field

MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpt/).

```csharp
public static readonly FileType MPT;
```

### MSG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/msg.md

#### FileType.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 FileType MSG;
```

### ODS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ods.md

#### FileType.ODS field

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/).

```csharp
public static readonly FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/odt.md

#### FileType.ODT field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/).

```csharp
public static readonly FileType ODT;
```

### OGG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ogg.md

#### FileType.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. OGG is a free and open container format that is maintained by Xiph.Org Foundation. Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/).

```csharp
public static readonly FileType OGG;
```

### ONE
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/one.md

#### FileType.ONE field

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/).

```csharp
public static readonly FileType ONE;
```

### OSM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/osm.md

#### FileType.OSM field

OpenStreetMap (OSM) is a huge collection of volunteered geographic information stores in different types of files, using different encoding schemes to convert this data into bits and bytes. [here](https://docs.fileformat.com/gis/osm/).

```csharp
public static readonly FileType OSM;
```

### OTC
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/otc.md

#### FileType.OTC field

OTC (OpenType Collection) is a OpenType font collection format. An OTC file can combine the multiple font files into it.

```csharp
public static readonly FileType OTC;
```

### OTF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/otf.md

#### FileType.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. Learn more about this file format [here](https://docs.fileformat.com/font/otf/).

```csharp
public static readonly FileType OTF;
```

### PDF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/pdf.md

#### FileType.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://docs.fileformat.com/pdf/).

```csharp
public static readonly FileType PDF;
```

### PNG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/png.md

#### FileType.PNG field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/).

```csharp
public static readonly FileType PNG;
```

### POT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/pot.md

#### FileType.POT field

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot/).

```csharp
public static readonly FileType POT;
```

### POTM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/potm.md

#### FileType.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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/potx.md

#### FileType.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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/pps.md

#### FileType.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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ppsm.md

#### FileType.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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ppsx.md

#### FileType.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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ppt.md

#### FileType.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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/pptm.md

#### FileType.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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/pptx.md

#### FileType.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 FileType PPTX;
```

### PSD
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/psd.md

#### FileType.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 FileType PSD;
```

### QT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/qt.md

#### FileType.QT field

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).

```csharp
public static readonly FileType QT;
```

### RAR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/rar.md

#### FileType.RAR field

RAR is a proprietary archive file format that supports data compression, error correction and file spanning. [here](https://wiki.fileformat.com/compression/rar/).

```csharp
public static readonly FileType RAR;
```

### SEVENZIP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/sevenzip.md

#### FileType.SEVENZIP field

7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License. [here](https://wiki.fileformat.com/compression/zip/).

```csharp
public static readonly FileType SEVENZIP;
```

### SHP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/shp.md

#### FileType.SHP field

The shapefile format is a geospatial vector data format for geographic information system (GIS) software. [here](https://docs.fileformat.com/gis/shp/).

```csharp
public static readonly FileType SHP;
```

### STL
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/stl.md

#### FileType.STL field

STL is a file format native to the stereolithography CAD software created by 3D Systems. Chuck Hull, the inventor of stereolithography and 3D Systems’ founder, reports that the file extension is an abbreviation for stereolithography. [here](https://wiki.fileformat.com/3d/stl/).

```csharp
public static readonly FileType STL;
```

### SVG
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/svg.md

#### FileType.SVG field

An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. The word Scalable refers to the fact that the SVG can be scaled to different sizes without losing any quality. Text-based description of such files makes them independent of resolution. It is one of the most used formats for building a website and print graphics in order to achieve scalability. The format can only be used for two-dimensional graphics though. SVG files can be viewed/opened in almost all modern browsers including Chrome, Internet Explorer, Firefox, and Safari. Learn more about this file format [here](https://docs.fileformat.com/image/svg/).

```csharp
public static readonly FileType SVG;
```

### TAR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/tar.md

#### FileType.TAR field

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. [here](https://wiki.fileformat.com/compression/tar/).

```csharp
public static readonly FileType TAR;
```

### THREEDS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/threeds.md

#### FileType.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. [here](https://wiki.fileformat.com/3d/3ds/).

```csharp
public static readonly FileType THREEDS;
```

### TIF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/tif.md

#### FileType.TIF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/tiff.md

#### FileType.TIFF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIFF;
```

### TOPOJSON
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/topojson.md

#### FileType.TOPOJSON field

TopoJSON is an extension of GeoJSON that encodes topology. [here](https://docs.fileformat.com/gis/geojson/).

```csharp
public static readonly FileType TOPOJSON;
```

### TORRENT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/torrent.md

#### FileType.TORRENT field

Represents TORRENT file type.

```csharp
public static readonly FileType TORRENT;
```

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/tostring.md

#### FileType.ToString method

Returns a String that represents the current `FileType`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `FileType`.

### TTC
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ttc.md

#### FileType.TTC field

TTC (TrueType Collection) is a TrueType font collection format. A TTC file can combine the multiple font files into it. Learn more about this file format [here](https://docs.fileformat.com/font/ttc/).

```csharp
public static readonly FileType TTC;
```

### TTF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/ttf.md

#### FileType.TTF field

TTF represents font files based on the TrueType specifications font technology. TrueType fonts provide highest quality display on computer screens and printers without any dependency on resolution. Learn more about this file format [here](https://docs.fileformat.com/font/ttf/).

```csharp
public static readonly FileType TTF;
```

### Unknown
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VCF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vcf.md

#### FileType.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://docs.fileformat.com/email/vcf/).

```csharp
public static readonly FileType VCF;
```

### VCR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vcr.md

#### FileType.VCR field

VCR (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.

```csharp
public static readonly FileType VCR;
```

### VDX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vdx.md

#### FileType.VDX field

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here](https://wiki.fileformat.com/visio/vdx/).

```csharp
public static readonly FileType VDX;
```

### VSD
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vsd.md

#### FileType.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/visio/vsd/).

```csharp
public static readonly FileType VSD;
```

### VSDX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vsdx.md

#### FileType.VSDX field

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here](https://wiki.fileformat.com/visio/vsdx/).

```csharp
public static readonly FileType VSDX;
```

### VSS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vss.md

#### FileType.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/visio/vss/).

```csharp
public static readonly FileType VSS;
```

### VSX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vsx.md

#### FileType.VSX field

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format [here](https://wiki.fileformat.com/visio/vsx/).

```csharp
public static readonly FileType VSX;
```

### VTX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/vtx.md

#### FileType.VTX field

Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here](https://docs.fileformat.com/visio/vtx/).

```csharp
public static readonly FileType VTX;
```

### WAV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/wav.md

#### FileType.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://wiki.fileformat.com/audio/wav/).

```csharp
public static readonly FileType WAV;
```

### WEBM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/webm.md

#### FileType.WEBM field

WEBM 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 FileType WEBM;
```

### WEBP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/webp.md

#### FileType.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 FileType WEBP;
```

### WMF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/wmf.md

#### FileType.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 FileType WMF;
```

### XLS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xls.md

#### FileType.XLS field

Files with XLS extension represent 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/specification/spreadsheet/xls/).

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xlsb.md

#### FileType.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/specification/spreadsheet/xlsb/).

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xlsm.md

#### FileType.XLSM field

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xlsx.md

#### FileType.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/specification/spreadsheet/xlsx/).

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xlt.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xltm.md

#### FileType.XLTM field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).

```csharp
public static readonly FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/xltx.md

#### FileType.XLTX field

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).

```csharp
public static readonly FileType XLTX;
```

### ZIP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/zip.md

#### FileType.ZIP field

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/).

```csharp
public static readonly FileType ZIP;
```

### ZIPX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetype/zipx.md

#### FileType.ZIPX field

ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods.

```csharp
public static readonly FileType ZIPX;
```

### FileTypeFeatureSupport
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport.md

#### FileTypeFeatureSupport class

Represents product feature support information for a specific file extension.

```csharp
public sealed class FileTypeFeatureSupport
```

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | Gets the file type description. |
| Extension { get; } | Gets the file extension for this entry (e.g. `.pdf`). |
| Features { get; } | Gets feature support details for this file type. |
| FormatFamily { get; } | Gets the documentation family this file type belongs to. |
| Note { get; } | Gets optional remarks about support for this file type. |

#### Methods

| Name | Description |
| --- | --- |
| static GetSupportedFileTypeFeatures(FileType) | Gets feature support for the specified file type. |
| static GetSupportedFileTypeFeatures(string) | Gets feature support for the specified file extension. |
| static GetSupportedFileTypeFeatures() | Gets all registered file type feature support entries keyed by `FileType`. |

##### Remarks

Use `GetSupportedFileTypeFeatures` to enumerate all registered entries and `GetSupportedFileTypeFeatures` or `GetSupportedFileTypeFeatures` to resolve a single entry.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/description.md

#### FileTypeFeatureSupport.Description property

Gets the file type description.

```csharp
public string Description { get; }
```

### Extension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/extension.md

#### FileTypeFeatureSupport.Extension property

Gets the file extension for this entry (e.g. `.pdf`).

```csharp
public string Extension { get; }
```

### Features
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/features.md

#### FileTypeFeatureSupport.Features property

Gets feature support details for this file type.

```csharp
public IEnumerable<FeatureSupport> Features { get; }
```

### FormatFamily
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/formatfamily.md

#### FileTypeFeatureSupport.FormatFamily property

Gets the documentation family this file type belongs to.

```csharp
public FormatFamily FormatFamily { get; }
```

### GetSupportedFileTypeFeatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/getsupportedfiletypefeatures.md

#### GetSupportedFileTypeFeatures()

Gets all registered file type feature support entries keyed by `FileType`.

```csharp
public static IReadOnlyDictionary<FileType, FileTypeFeatureSupport> GetSupportedFileTypeFeatures()
```

##### Return Value

A read-only map of supported file types.

#### GetSupportedFileTypeFeatures(FileType)

Gets feature support for the specified file type.

```csharp
public static FileTypeFeatureSupport GetSupportedFileTypeFeatures(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

##### Return Value

The support information.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | *fileType* is `null`. |
| ArgumentException | *fileType* is `Unknown`. |
| KeyNotFoundException | No support information is registered for this file type. |

#### GetSupportedFileTypeFeatures(string)

Gets feature support for the specified file extension.

```csharp
public static FileTypeFeatureSupport GetSupportedFileTypeFeatures(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension, with or without a leading dot (e.g. `.pdf` or `pdf`). |

##### Return Value

The support information.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | *extension* is null or whitespace. |
| KeyNotFoundException | No support information is registered for this extension. |

### Note
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypefeaturesupport/note.md

#### FileTypeFeatureSupport.Note property

Gets optional remarks about support for this file type.

```csharp
public string Note { get; }
```

### FileTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypepackage.md

#### FileTypePackage class

Represents a metadata package containing file format information.

```csharp
public class FileTypePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Extension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypepackage/extension.md

#### FileTypePackage.Extension property

Gets the file extension.

```csharp
public string Extension { get; }
```

##### Property Value

The file extension.

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypepackage/fileformat.md

#### FileTypePackage.FileFormat property

Gets the file format.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

The file format.

### MimeType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/filetypepackage/mimetype.md

#### FileTypePackage.MimeType property

Gets the MIME type.

```csharp
public string MimeType { get; }
```

##### Property Value

The MIME type value.

### FormatFamily
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/formatfamily.md

#### FormatFamily enumeration

Groups file types into families for documentation and feature matrices.

```csharp
public enum FormatFamily
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format family is not specified. |
| Word | `1` | Microsoft Word and compatible word-processing formats (.doc, .docx, .odt, …). |
| Excel | `2` | Microsoft Excel and compatible spreadsheet formats (.xls, .xlsx, .ods, …). |
| PowerPoint | `3` | Microsoft PowerPoint and compatible presentation formats (.ppt, .pptx, …). |
| Pdf | `4` | PDF documents (.pdf). |
| Email | `5` | Email message formats (.eml, .msg, …). |
| Image | `6` | Raster and common image formats (.png, .jpg, .avif, …). |
| Visio | `7` | Microsoft Visio diagram formats (.vsd, .vsdx, …). |
| Other | `8` | Miscellaneous formats (e.g. .mpp, .vcf, .torrent) not grouped in a dedicated family below. |
| OneNote | `10` | Microsoft OneNote formats (.one). |
| Ebook | `11` | Electronic book formats (.epub, .fb2, .mobi, …). |
| Cad | `12` | CAD drawing formats (.dwg, .dxf, …). |
| Font | `13` | Font formats (.ttf, .otf, …). |
| Audio | `15` | Audio formats (.mp3, .wav, .ogg, …). |
| Video | `16` | Video formats (.avi, .mkv, .mov, …). |
| Gis | `17` | GIS formats (.shp, .kml, .geojson, …). |
| ThreeD | `18` | 3D model formats (.fbx, .gltf, .stl, …). |
| Archive | `19` | Archive formats (.zip, .7z, .rar, …). |

### FuncTResult
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/func-1.md

#### Func&lt;TResult&gt; delegate

Encapsulates a method that has no parameters and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<out TResult>();
```

| Parameter | Description |
| --- | --- |
| TResult | The type of the return value of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### FuncTTResult
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/func-2.md

#### Func&lt;T,TResult&gt; delegate

Encapsulates a method that has one parameter and returns a value of the type specified by the *TResult* parameter.

```csharp
public delegate TResult Func<in T, out TResult>(T arg);
```

| Parameter | Description |
| --- | --- |
| T | The type of the parameter of the method that this delegate encapsulates. |
| TResult | The type of the return value of the method that this delegate encapsulates. |
| arg | The parameter of the method that this delegate encapsulates. |

##### Return Value

The return value of the method that this delegate encapsulates.

### IDocumentInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo.md

#### IDocumentInfo interface

Provides common information about a loaded document.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the file type of the loaded document. |
| IsEncrypted { get; } | Gets a value indicating whether the document is encrypted and requires a password to open. |
| PageCount { get; } | Gets the number of pages (slides, worksheets, etc) in the loaded document. |
| Pages { get; } | Gets a collection of objects representing common information about the document pages (slides, worksheets, etc). |
| Size { get; } | Gets the size of the loaded document in bytes. |

##### Examples

This example demonstrates how to extract basic format information from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    if (metadata.FileFormat != FileFormat.Unknown)
    {
        IDocumentInfo info = metadata.GetDocumentInfo();

        Console.WriteLine("File format: {0}", info.FileType.FileFormat);
        Console.WriteLine("File extension: {0}", info.FileType.Extension);
        Console.WriteLine("MIME Type: {0}", info.FileType.MimeType);
        Console.WriteLine("Number of pages: {0}", info.PageCount);
        Console.WriteLine("Document size: {0} bytes", info.Size);
        Console.WriteLine("Is document encrypted: {0}", info.IsEncrypted);
    }
}
```

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Gets the file type of the loaded document.

```csharp
public FileTypePackage FileType { get; }
```

##### Property Value

The file type of the loaded document.

### IsEncrypted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo/isencrypted.md

#### IDocumentInfo.IsEncrypted property

Gets a value indicating whether the document is encrypted and requires a password to open.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

A value indicating whether the document is encrypted and requires a password to open.

### PageCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Gets the number of pages (slides, worksheets, etc) in the loaded document.

```csharp
public int PageCount { get; }
```

##### Property Value

The number of pages (slides, worksheets, etc) in the loaded document.

### Pages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Gets a collection of objects representing common information about the document pages (slides, worksheets, etc).

```csharp
public IReadOnlyList<PageInfo> Pages { get; }
```

##### Property Value

A collection of objects representing common information about the document pages (slides, worksheets, etc).

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/idocumentinfo/size.md

#### IDocumentInfo.Size property

Gets the size of the loaded document in bytes.

```csharp
public long Size { get; }
```

##### Property Value

The size of the loaded document in bytes.

### IEnumValueInterpreter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ienumvalueinterpreter.md

#### IEnumValueInterpreter interface

Represents an interpreter intended to convert various numeric values to descriptive string values.

```csharp
public interface IEnumValueInterpreter
```

#### Properties

| Name | Description |
| --- | --- |
| OutputValueRange { get; } | Gets the range of all possible output (interpreted) values. |

### OutputValueRange
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ienumvalueinterpreter/outputvaluerange.md

#### IEnumValueInterpreter.OutputValueRange property

Gets the range of all possible output (interpreted) values.

```csharp
public IReadOnlyList<string> OutputValueRange { get; }
```

##### Property Value

The range of all possible output (interpreted) values.

### IReadOnlyListT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ireadonlylist-1.md

#### IReadOnlyList&lt;T&gt; interface

Represents a read-only collection of elements that can be accessed by index.

```csharp
public interface IReadOnlyList<T> : IEnumerable<T>
```

| Parameter | Description |
| --- | --- |
| T | The type of elements in the read-only list. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of elements contained in the collection. |
| Item { get; } | Gets the element at the specified index in the read-only list. |

#### Methods

| Name | Description |
| --- | --- |
| Contains(T) | Determines whether the collection contains a specific item. |
| Contains(TagCategory) | Determines whether the collection contains a TagCategory item. |
| IndexOf(T) | Determines the index of a specific item in the collection. |

### Contains
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ireadonlylist-1/contains.md

#### Contains(T)

Determines whether the collection contains a specific item.

```csharp
public bool Contains(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

True if the item is found in the collection; otherwise, false.

#### Contains(TagCategory)

Determines whether the collection contains a TagCategory item.

```csharp
public bool Contains(TagCategory item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

##### Return Value

True if the item is found in the collection; otherwise, false.

### Count
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ireadonlylist-1/count.md

#### IReadOnlyList&lt;T&gt;.Count property

Gets the number of elements contained in the collection.

```csharp
public int Count { get; }
```

##### Property Value

The number of elements contained in the collection.

### IndexOf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ireadonlylist-1/indexof.md

#### IReadOnlyList&lt;T&gt;.IndexOf method

Determines the index of a specific item in the collection.

```csharp
public int IndexOf(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

The index of *item* if found in the collection; otherwise, -1.

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/ireadonlylist-1/item.md

#### IReadOnlyList&lt;T&gt; indexer

Gets the element at the specified index in the read-only list.

```csharp
public T this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the element to get. |

##### Return Value

The element at the specified index in the read-only list.

### MetadataPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage.md

#### MetadataPackage class

Represents base abstraction for a metadata package.

```csharp
public abstract class MetadataPackage : IEnumerable<MetadataProperty>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AddProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/addproperties.md

#### MetadataPackage.AddProperties method

Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

```csharp
public virtual int AddProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties. |

##### Return Value

The number of affected properties.

### Contains
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/contains.md

#### MetadataPackage.Contains method

Determines whether the package contains a metadata property with the specified name.

```csharp
public bool Contains(string propertyName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The name of the property to locate in the package. |

##### Return Value

True if the package contains a property with the specified name; otherwise, false.

### Count
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/count.md

#### MetadataPackage.Count property

Gets the number of metadata properties.

```csharp
public int Count { get; }
```

##### Property Value

The number or metadata properties.

### FindProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/findproperties.md

#### MetadataPackage.FindProperties method

Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well.

```csharp
public virtual IEnumerable<MetadataProperty> FindProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

An IEnumerable that contains properties from the package that satisfy the condition.

### GetEnumerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/getenumerator.md

#### MetadataPackage.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<MetadataProperty> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/item.md

#### MetadataPackage indexer

Gets the `MetadataProperty` with the specified name.

```csharp
public MetadataProperty this[string propertyName] { get; }
```

| Parameter | Description |
| --- | --- |
| propertyName | The name of the metadata property to be found. |

##### Return Value

The `MetadataProperty` if found; otherwise, null.

##### Property Value

The appropriate `MetadataProperty`.

### Keys
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/keys.md

#### MetadataPackage.Keys property

Gets a collection of the metadata property names.

```csharp
public IReadOnlyList<string> Keys { get; }
```

##### Property Value

A collection of the metadata property names.

### MetadataType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/metadatatype.md

#### MetadataPackage.MetadataType property

Gets the metadata type.

```csharp
public MetadataType MetadataType { get; }
```

##### Property Value

The type of the metadata package.

### PropertyDescriptors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/propertydescriptors.md

#### MetadataPackage.PropertyDescriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.

```csharp
public IReadOnlyList<PropertyDescriptor> PropertyDescriptors { get; }
```

##### Property Value

A collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/removeproperties.md

#### MetadataPackage.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public virtual int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/sanitize.md

#### MetadataPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public virtual int Sanitize()
```

##### Return Value

The number of affected properties.

### SetProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/setproperties.md

#### MetadataPackage.SetProperties method

Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package.

```csharp
public virtual int SetProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties. |

##### Return Value

The number of affected properties.

##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

### UpdateProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapackage/updateproperties.md

#### MetadataPackage.UpdateProperties method

Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

```csharp
public virtual int UpdateProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties. |

##### Return Value

The number of affected properties.

##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

### MetadataProperty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty.md

#### MetadataProperty class

Represents a metadata property.

```csharp
public class MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### Descriptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty/descriptor.md

#### MetadataProperty.Descriptor property

Gets the descriptor associated with the metadata property.

```csharp
public PropertyDescriptor Descriptor { get; }
```

##### Property Value

The descriptor associated with the metadata property.

### InterpretedValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty/interpretedvalue.md

#### MetadataProperty.InterpretedValue property

Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc.

```csharp
public PropertyValue InterpretedValue { get; }
```

##### Property Value

The interpreted property value, if available.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty/name.md

#### MetadataProperty.Name property

Gets the property name.

```csharp
public string Name { get; }
```

##### Property Value

The property name.

### Tags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty/tags.md

#### MetadataProperty.Tags property

Gets a collection of tags associated with the property.

```csharp
public IReadOnlyList<PropertyTag> Tags { get; }
```

##### Property Value

A collection of tags associated with the property.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadataproperty/value.md

#### MetadataProperty.Value property

Gets the property value.

```csharp
public PropertyValue Value { get; }
```

##### Property Value

The property value.

### MetadataPropertyEqualityComparer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapropertyequalitycomparer.md

#### MetadataPropertyEqualityComparer class

Defines methods to support the comparison of metadata properties for equality.

```csharp
public class MetadataPropertyEqualityComparer : IEqualityComparer<MetadataProperty>
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataPropertyEqualityComparer() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(MetadataProperty, MetadataProperty) | Determines whether the specified objects are equal. |
| GetHashCode(MetadataProperty) | Returns a hash code for the specified object. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapropertyequalitycomparer/equals.md

#### MetadataPropertyEqualityComparer.Equals method

Determines whether the specified objects are equal.

```csharp
public bool Equals(MetadataProperty x, MetadataProperty y)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | MetadataProperty | The first object of type `MetadataProperty` to compare. |
| y | MetadataProperty | The second object of type `MetadataProperty` to compare. |

##### Return Value

`true` if the specified objects are equal; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapropertyequalitycomparer/gethashcode.md

#### MetadataPropertyEqualityComparer.GetHashCode method

Returns a hash code for the specified object.

```csharp
public int GetHashCode(MetadataProperty obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | MetadataProperty | The `MetadataProperty` for which a hash code is to be returned. |

##### Return Value

A hash code for the specified object.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | The type of *obj* is a reference type and *obj* is `null`. |

### MetadataPropertyEqualityComparer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapropertyequalitycomparer/metadatapropertyequalitycomparer.md

#### MetadataPropertyEqualityComparer constructor

The default constructor.

```csharp
public MetadataPropertyEqualityComparer()
```

### MetadataPropertyType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatapropertytype.md

#### MetadataPropertyType enumeration

Defines metadata property types.

```csharp
public enum MetadataPropertyType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Empty | `0` | Represents an empty (null) property. |
| String | `1` | Represents a string property. |
| Boolean | `2` | Represents a boolean property. |
| DateTime | `3` | Represents a date property. |
| TimeSpan | `4` | Represents a time property. |
| Integer | `5` | Represents an integer property. |
| Long | `6` | Represents a long integer property. |
| Double | `7` | Represents a property with a double or float value. |
| StringArray | `8` | Represents a string array property. |
| ByteArray | `9` | Represents a byte array property. |
| DoubleArray | `10` | Represents an array of double values. |
| IntegerArray | `11` | Represents an array of integer values. |
| LongArray | `12` | Represents an array of long values. |
| Metadata | `13` | Represents a nested metadata block. |
| MetadataArray | `14` | Represents an array of nested metadata blocks. |
| Guid | `15` | Represents a global unique identifier value. |
| PropertyValueArray | `16` | Represents a metadata property value array. |
| Object | `17` | Represents a metadata property value object. |

### MetadataType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/metadatatype.md

#### MetadataType enumeration

Specifies the type of a metadata package.

```csharp
public enum MetadataType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The type of a metadata package is undefined. |
| Root | `1` | A root metadata package containing other format-specific packages. |
| Xmp | `2` | An XMP metadata package. |
| Exif | `3` | An EXIF metadata package, |
| Iptc | `4` | An IPTC metadata package, |
| DublinCore | `5` | A Dublin Core metadata package. |
| ImageResourceBlock | `6` | A Photoshop's native metadata package. |
| FileFormat | `7` | A package containing information about the format of a loaded file. |
| DigitalSignature | `8` | A package containing digital signature metadata. |
| Presentation | `9` | A presentation metadata package. |
| Spreadsheet | `10` | A spreadsheet metadata package. |
| WordProcessing | `11` | A word processing metadata package. |
| Diagram | `12` | A diagram metadata package. |
| Note | `13` | A metadata package containing information about an electronic note file. |
| ProjectManagement | `14` | A metadata package containing information about a project management file. |
| Pdf | `15` | A PDF metadata package. |
| DocumentStatistics | `16` | A package containing document statistics. |
| Psd | `17` | A metadata package containing information about a Photoshop document. |
| Jpeg2000 | `18` | A JPEG2000 native metadata package. |
| Dicom | `19` | A DICOM native metadata package. |
| Bmp | `20` | A BMP native metadata package. |
| Wav | `21` | A WAV native metadata package. |
| ID3V1 | `22` | An ID3V1 tag. |
| ID3V2 | `23` | An ID3V2 tag. |
| MpegAudio | `24` | An MPEG audio native metadata package. |
| Lyrics3 | `25` | A Lyrics3 metadata package. |
| ApeV2 | `26` | An APEv2 metadata package. |
| Avi | `27` | An AVI video native metadata package. |
| Flv | `28` | An FLV video native metadata package. |
| Asf | `29` | An ASF video native metadata package. |
| Mov | `30` | A QuickTime video. |
| Matroska | `31` | A native metadata package extracted from a video encoded with the Matroska multimedia container. |
| Zip | `32` | A native metadata package of a ZIP archive. |
| SevenZip | `33` | A native metadata package of a SevenZip archive. |
| VCard | `34` | A native metadata package of a VCard. |
| Epub | `35` | A native metadata package of a EPUB e-book. |
| OpenType | `36` | An OpenType font metadata package. |
| Cad | `37` | A metadata package extracted from a CAD drawing. |
| Eml | `38` | An EML message metadata package. |
| Msg | `39` | An MSG message metadata package. |
| Torrent | `40` | A torrent file metadata package. Please find more information at [https://en.wikipedia.org/wiki/Torrent_file/](https://en.wikipedia.org/wiki/Torrent_file/). |
| Png | `41` | A PNG image metadata package. |
| Dng | `42` | A DNG image metadata package. |
| Cr2 | `43` | A CR2 image metadata package. |
| Rar | `44` | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | `45` | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
| ThreeDS | `46` | 3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software. |
| Dae | `47` | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. |
| Fbx | `48` | FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware. |
| Stl | `49` | STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems’ founder, reports that the file extension is an abbreviation for stereolithography. |
| Gis | `50` | Gis format |
| Fb2 | `51` | Files with .fb2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. |
| Mobi | `52` | The MOBI file format is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as the proprietary format for Mobipocket Reader. |
| Ogg | `53` | Ogg format |
| Svg | `54` | Svg format |
| Gltf | `55` | glTF (Graphics Library Transmission Format or GL Transmission Format and formerly known as WebGL Transmissions Format or WebGL TF) |
| Avif | `56` | Avif format |

### PageInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/pageinfo.md

#### PageInfo class

Provides common information about a document page (slide, worksheet, etc).

```csharp
public class PageInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of the page in document default units. |
| PageNumber { get; } | Gets the number of the page. |
| Width { get; } | Gets the width of the page in document default units. |

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/pageinfo/height.md

#### PageInfo.Height property

Gets the height of the page in document default units.

```csharp
public int Height { get; }
```

##### Property Value

The height of the page in document default units.

### PageNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Gets the number of the page.

```csharp
public int PageNumber { get; }
```

##### Property Value

The number of the page.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/pageinfo/width.md

#### PageInfo.Width property

Gets the width of the page in document default units.

```csharp
public int Width { get; }
```

##### Property Value

The width of the page in document default units.

### ProductFeature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/productfeature.md

#### ProductFeature enumeration

Specifies product features that can be supported by a file type.

```csharp
public enum ProductFeature
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AutoDetection | `0` | Automatic file format detection. |
| Read | `1` | Reading metadata from files of this type. |
| Edit | `2` | Adding or updating metadata in files of this type. |
| Remove | `3` | Removing metadata from files of this type. |

### PropertyAccessLevels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyaccesslevels.md

#### PropertyAccessLevels enumeration

Defines access levels for metadata properties.

```csharp
[Flags]
public enum PropertyAccessLevels
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Read | `0` | The property is read-only. |
| Update | `1` | It is possible to update the property using the `UpdateProperties` method. |
| Remove | `2` | The property can be removed through the `RemoveProperties` method. |
| Add | `4` | It is possible to update the property using the `AddProperties` method. |
| Full | `7` | Grants full access to the property. |
| AddOrUpdate | `5` | It is allowed to add and update the property. All other operations are restricted. |

### PropertyDescriptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor.md

#### PropertyDescriptor class

Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine.

```csharp
public class PropertyDescriptor
```

#### Properties

| Name | Description |
| --- | --- |
| virtual AccessLevel { get; } | Gets the property access level. |
| Interpreter { get; } | Gets the property value interpreter. |
| Name { get; } | Gets the property name. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Type { get; } | Gets the property type. |

### AccessLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor/accesslevel.md

#### PropertyDescriptor.AccessLevel property

Gets the property access level.

```csharp
public virtual PropertyAccessLevels AccessLevel { get; }
```

##### Property Value

The property access level.

### Interpreter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor/interpreter.md

#### PropertyDescriptor.Interpreter property

Gets the property value interpreter.

```csharp
public ValueInterpreter Interpreter { get; }
```

##### Property Value

The property value interpreter.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor/name.md

#### PropertyDescriptor.Name property

Gets the property name.

```csharp
public string Name { get; }
```

##### Property Value

The property name.

### Tags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor/tags.md

#### PropertyDescriptor.Tags property

Gets a collection of tags associated with the property.

```csharp
public IReadOnlyList<PropertyTag> Tags { get; }
```

##### Property Value

A collection of tags associated with the property.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertydescriptor/type.md

#### PropertyDescriptor.Type property

Gets the property type.

```csharp
public MetadataPropertyType Type { get; }
```

##### Property Value

The property type.

### PropertyValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue.md

#### PropertyValue class

Represents a property value.

```csharp
public class PropertyValue
```

#### Constructors

| Name | Description |
| --- | --- |
| PropertyValue(bool) | Initializes a new instance of the `PropertyValue` class with a boolean value. |
| PropertyValue(byte[]) | Initializes a new instance of the `PropertyValue` class with a byte array. |
| PropertyValue(DateTime) | Initializes a new instance of the `PropertyValue` class with a DateTime value. |
| PropertyValue(double) | Initializes a new instance of the `PropertyValue` class with a double value. |
| PropertyValue(double[]) | Initializes a new instance of the `PropertyValue` class with an array of double values. |
| PropertyValue(int) | Initializes a new instance of the `PropertyValue` class with an integer value. |
| PropertyValue(int[]) | Initializes a new instance of the `PropertyValue` class with an array of integer values. |
| PropertyValue(long) | Initializes a new instance of the `PropertyValue` class with a long value. |
| PropertyValue(long[]) | Initializes a new instance of the `PropertyValue` class with an array of long values. |
| PropertyValue(object) | Initializes a new instance of the `PropertyValue` class with a object value. |
| PropertyValue(string) | Initializes a new instance of the `PropertyValue` class with a string value. |
| PropertyValue(string[]) | Initializes a new instance of the `PropertyValue` class with a string array. |
| PropertyValue(TimeSpan) | Initializes a new instance of the `PropertyValue` class with a TimeSpan value. |
| PropertyValue(ushort[]) | Initializes a new instance of the `PropertyValue` class with an array of ushort values. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### AcceptValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/acceptvalue.md

#### PropertyValue.AcceptValue method

Extracts the property value using a custom `ValueAcceptor`.

```csharp
public void AcceptValue(ValueAcceptor valueAcceptor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| valueAcceptor | ValueAcceptor | An acceptor that extracts the value. |

### PropertyValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/propertyvalue.md

#### PropertyValue(int)

Initializes a new instance of the `PropertyValue` class with an integer value.

```csharp
public PropertyValue(int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int32 | An Int32 value. |

#### PropertyValue(long)

Initializes a new instance of the `PropertyValue` class with a long value.

```csharp
public PropertyValue(long value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int64 | A Int64 value. |

#### PropertyValue(bool)

Initializes a new instance of the `PropertyValue` class with a boolean value.

```csharp
public PropertyValue(bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Boolean | A Boolean value. |

#### PropertyValue(double)

Initializes a new instance of the `PropertyValue` class with a double value.

```csharp
public PropertyValue(double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Double | A Double value. |

#### PropertyValue(string)

Initializes a new instance of the `PropertyValue` class with a string value.

```csharp
public PropertyValue(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | A String value. |

#### PropertyValue(object)

Initializes a new instance of the `PropertyValue` class with a object value.

```csharp
public PropertyValue(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | A Object value. |

#### PropertyValue(DateTime)

Initializes a new instance of the `PropertyValue` class with a DateTime value.

```csharp
public PropertyValue(DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | DateTime | A DateTime value. |

#### PropertyValue(TimeSpan)

Initializes a new instance of the `PropertyValue` class with a TimeSpan value.

```csharp
public PropertyValue(TimeSpan value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | TimeSpan | A TimeSpan value. |

#### PropertyValue(string[])

Initializes a new instance of the `PropertyValue` class with a string array.

```csharp
public PropertyValue(string[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | String[] | A string array. |

#### PropertyValue(byte[])

Initializes a new instance of the `PropertyValue` class with a byte array.

```csharp
public PropertyValue(byte[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | Byte[] | A byte array. |

#### PropertyValue(double[])

Initializes a new instance of the `PropertyValue` class with an array of double values.

```csharp
public PropertyValue(double[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | Double[] | An array of double values. |

#### PropertyValue(int[])

Initializes a new instance of the `PropertyValue` class with an array of integer values.

```csharp
public PropertyValue(int[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | Int32[] | An array of integer values. |

#### PropertyValue(long[])

Initializes a new instance of the `PropertyValue` class with an array of long values.

```csharp
public PropertyValue(long[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | Int64[] | An array of long values. |

#### PropertyValue(ushort[])

Initializes a new instance of the `PropertyValue` class with an array of ushort values.

```csharp
public PropertyValue(ushort[] values)
```

| Parameter | Type | Description |
| --- | --- | --- |
| values | UInt16[] | An array of ushort values. |

### RawValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/rawvalue.md

#### PropertyValue.RawValue property

Gets the raw value.

```csharp
public object RawValue { get; }
```

##### Property Value

The raw value.

### ToArray
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/toarray.md

#### PropertyValue.ToArray&lt;TElement&gt; method

Converts the property value to an array of the specified type.

```csharp
public TElement[] ToArray<TElement>()
```

| Parameter | Description |
| --- | --- |
| TElement | The type of an element. |

##### Return Value

The value represented as an array of the specified type or null if there is no such conversion.

### ToClass
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/toclass.md

#### PropertyValue.ToClass&lt;T&gt; method

Converts the property value to a reference type.

```csharp
public T ToClass<T>()
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | The exact type to convert to. |

##### Return Value

The converted value or null if there is no such conversion.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/tostring.md

#### PropertyValue.ToString method

Returns a string that represents the property value.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the property value.

### ToStruct
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/tostruct.md

#### ToStruct&lt;T&gt;()

Converts the property value to a value type.

```csharp
public T? ToStruct<T>()
    where T : struct
```

| Parameter | Description |
| --- | --- |
| T | The exact type to convert to. |

##### Return Value

The converted value or null if there is no such conversion.

#### ToStruct&lt;T&gt;(T)

Converts the property value to a value type.

```csharp
public T ToStruct<T>(T @default)
    where T : struct
```

| Parameter | Description |
| --- | --- |
| T | The exact type to convert to. |
| default | A value that should be used by default if conversion fails. |

##### Return Value

The converted value or the specified default value if there is no such conversion.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalue/type.md

#### PropertyValue.Type property

Gets the `MetadataPropertyType`.

```csharp
public MetadataPropertyType Type { get; }
```

##### Property Value

The type of the property.

### PropertyValueEqualityComparer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalueequalitycomparer.md

#### PropertyValueEqualityComparer class

Defines methods to support the comparison of property values for equality.

```csharp
public class PropertyValueEqualityComparer : IEqualityComparer<PropertyValue>
```

#### Constructors

| Name | Description |
| --- | --- |
| PropertyValueEqualityComparer() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(PropertyValue, PropertyValue) | Determines whether the specified objects are equal. |
| GetHashCode(PropertyValue) | Returns a hash code for the specified object. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalueequalitycomparer/equals.md

#### PropertyValueEqualityComparer.Equals method

Determines whether the specified objects are equal.

```csharp
public bool Equals(PropertyValue x, PropertyValue y)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | PropertyValue | The first object of type `PropertyValue` to compare. |
| y | PropertyValue | The second object of type `PropertyValue` to compare. |

##### Return Value

`true` if the specified objects are equal; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalueequalitycomparer/gethashcode.md

#### PropertyValueEqualityComparer.GetHashCode method

Returns a hash code for the specified object.

```csharp
public int GetHashCode(PropertyValue obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | PropertyValue | The `PropertyValue` for which a hash code is to be returned. |

##### Return Value

A hash code for the specified object.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | The type of *obj* is a reference type and *obj* is `null`. |

### PropertyValueEqualityComparer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/propertyvalueequalitycomparer/propertyvalueequalitycomparer.md

#### PropertyValueEqualityComparer constructor

The default constructor.

```csharp
public PropertyValueEqualityComparer()
```

### ReadOnlyListT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1.md

#### ReadOnlyList&lt;T&gt; class

Provides an abstract base class for a strongly typed read-only list.

```csharp
public class ReadOnlyList<T> : IList, IList<T>, IReadOnlyList<T>
```

| Parameter | Description |
| --- | --- |
| T | The type of the element. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of elements contained in the collection. |
| IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Contains(T) | Determines whether the collection contains a specific item. |
| Contains(TagCategory) | Determines whether the collection contains a TagCategory item. |
| GetEnumerator() | Returns an enumerator that iterates through a collection. |
| IndexOf(T) | Determines the index of a specific item in the collection. |

### Contains
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/contains.md

#### Contains(T)

Determines whether the collection contains a specific item.

```csharp
public bool Contains(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

True if the item is found in the collection; otherwise, false.

#### Contains(TagCategory)

Determines whether the collection contains a TagCategory item.

```csharp
public bool Contains(TagCategory item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

##### Return Value

True if the item is found in the collection; otherwise, false.

### Count
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/count.md

#### ReadOnlyList&lt;T&gt;.Count property

Gets the number of elements contained in the collection.

```csharp
public int Count { get; }
```

##### Property Value

The number of elements contained in the collection.

### GetEnumerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/getenumerator.md

#### ReadOnlyList&lt;T&gt;.GetEnumerator method

Returns an enumerator that iterates through a collection.

```csharp
public IEnumerator<T> GetEnumerator()
```

##### Return Value

An IEnumerator object that can be used to iterate through the collection.

### IndexOf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/indexof.md

#### ReadOnlyList&lt;T&gt;.IndexOf method

Determines the index of a specific item in the collection.

```csharp
public int IndexOf(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

The index of *item* if found in the collection; otherwise, -1.

### IsReadOnly
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/isreadonly.md

#### ReadOnlyList&lt;T&gt;.IsReadOnly property

Gets a value indicating whether the collection is read-only.

```csharp
public bool IsReadOnly { get; }
```

##### Property Value

True if the collection is read-only; otherwise, false.

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/readonlylist-1/item.md

#### ReadOnlyList&lt;T&gt; indexer

Gets the element at the specified index in the collection.

```csharp
public T this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the element to get. |

##### Return Value

The element at the specified index.

### Rectangle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle.md

#### Rectangle structure

A set of four integers that represent the location and size of a rectangle.

```csharp
public struct Rectangle
```

#### Properties

| Name | Description |
| --- | --- |
| static Empty { get; } | Gets the empty rectangle. |
| Bottom { get; } | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| Height { get; } | Gets the height. |
| IsEmpty { get; } | Gets a value indicating whether this instance is empty. |
| Left { get; } | Gets the x-coordinate of the left edge of the rectangle. |
| Right { get; } | Gets the x-coordinate that is the sum of X and Width property values of the rectangle. |
| Top { get; } | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| Width { get; } | Gets the width. |
| X { get; } | Gets the x. |
| Y { get; } | Gets the y. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents this instance. |

### Bottom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/bottom.md

#### Rectangle.Bottom property

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

```csharp
public int Bottom { get; }
```

##### Property Value

The y-coordinate that is the sum of the Y and Height property values of the rectangle.

### Empty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/empty.md

#### Rectangle.Empty property

Gets the empty rectangle.

```csharp
public static Rectangle Empty { get; }
```

##### Property Value

The empty rectangle.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/height.md

#### Rectangle.Height property

Gets the height.

```csharp
public int Height { get; }
```

##### Property Value

The height.

### IsEmpty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/isempty.md

#### Rectangle.IsEmpty property

Gets a value indicating whether this instance is empty.

```csharp
public bool IsEmpty { get; }
```

##### Property Value

`true` if this instance is empty; otherwise, `false`.

### Left
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/left.md

#### Rectangle.Left property

Gets the x-coordinate of the left edge of the rectangle.

```csharp
public int Left { get; }
```

##### Property Value

The x-coordinate of the left edge of the rectangle.

### Right
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/right.md

#### Rectangle.Right property

Gets the x-coordinate that is the sum of X and Width property values of the rectangle.

```csharp
public int Right { get; }
```

##### Property Value

The x-coordinate that is the sum of X and Width property values of the rectangle.

### Top
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/top.md

#### Rectangle.Top property

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

```csharp
public int Top { get; }
```

##### Property Value

The y-coordinate that is the sum of the Y and Height property values of the rectangle.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/tostring.md

#### Rectangle.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/width.md

#### Rectangle.Width property

Gets the width.

```csharp
public int Width { get; }
```

##### Property Value

The width.

### X
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/x.md

#### Rectangle.X property

Gets the x.

```csharp
public int X { get; }
```

##### Property Value

The x.

### Y
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rectangle/y.md

#### Rectangle.Y property

Gets the y.

```csharp
public int Y { get; }
```

##### Property Value

The y.

### RootMetadataPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rootmetadatapackage.md

#### RootMetadataPackage class

Represents an entry point to all metadata packages presented in a particular file.

```csharp
public abstract class RootMetadataPackage : MetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rootmetadatapackage/filetype.md

#### RootMetadataPackage.FileType property

Gets the file type metadata package.

```csharp
public FileTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/rootmetadatapackage/sanitize.md

#### RootMetadataPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### SupportLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/supportlevel.md

#### SupportLevel enumeration

Specifies the feature support level.

```csharp
public enum SupportLevel
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NotSupported | `0` | The feature is not supported. |
| Supported | `1` | The feature is supported. |
| PartiallySupported | `2` | The feature is partially supported or supported with limitations. |

### ValueAcceptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/valueacceptor.md

#### ValueAcceptor class

Provides a base abstract class that allows extracting all supported types of values from a `PropertyValue` instance.

```csharp
public abstract class ValueAcceptor
```

### ValueInterpreter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/valueinterpreter.md

#### ValueInterpreter class

Defines operations required to interpret metadata property values.

```csharp
public abstract class ValueInterpreter
```

#### Properties

| Name | Description |
| --- | --- |
| abstract InterpretedValueType { get; } | Gets the type of the interpreted value. |

#### Methods

| Name | Description |
| --- | --- |
| ToInterpretedValue(PropertyValue) | Interprets the provided property value. |
| ToSourceValue(PropertyValue) | Converts an interpreted value back to its original form. |

### InterpretedValueType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/valueinterpreter/interpretedvaluetype.md

#### ValueInterpreter.InterpretedValueType property

Gets the type of the interpreted value.

```csharp
public abstract MetadataPropertyType InterpretedValueType { get; }
```

##### Property Value

The type of the interpreted value.

### ToInterpretedValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/valueinterpreter/tointerpretedvalue.md

#### ValueInterpreter.ToInterpretedValue method

Interprets the provided property value.

```csharp
public PropertyValue ToInterpretedValue(PropertyValue originalValue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| originalValue | PropertyValue | The value to interpret. |

##### Return Value

The interpreted value.

### ToSourceValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.common/valueinterpreter/tosourcevalue.md

#### ValueInterpreter.ToSourceValue method

Converts an interpreted value back to its original form.

```csharp
public PropertyValue ToSourceValue(PropertyValue interpretedValue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| interpretedValue | PropertyValue | The interpreted value to convert. |

##### Return Value

The original value.

### GroupDocs.Metadata.Exceptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions.md

The namespace contains some specific exceptions that are thrown by the library during file reading and updating.

#### Classes

| Class | Description |
| --- | --- |
| DocumentProtectedException | The exception that is thrown when document is protected by password. |
| GroupDocsMetadataException | Represents a product-specific exception that is thrown during file processing. |
| InvalidFormatException | The exception that is thrown when a file has an invalid format. |
| MetadataValidationException | The exception that is thrown when validation errors encountered during metadata saving. |
| XmpException | The exception that is thrown when XMP has invalid structure. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DocumentProtectedException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/documentprotectedexception.md

#### DocumentProtectedException class

The exception that is thrown when document is protected by password.

```csharp
public sealed class DocumentProtectedException : GroupDocsMetadataException
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentProtectedException() | Initializes a new instance of the `DocumentProtectedException` class. |

### DocumentProtectedException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/documentprotectedexception/documentprotectedexception.md

#### DocumentProtectedException constructor

Initializes a new instance of the `DocumentProtectedException` class.

```csharp
public DocumentProtectedException()
```

### GroupDocsMetadataException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/groupdocsmetadataexception.md

#### GroupDocsMetadataException class

Represents a product-specific exception that is thrown during file processing.

```csharp
public class GroupDocsMetadataException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsMetadataException() | Initializes a new instance of the `GroupDocsMetadataException` class. |
| GroupDocsMetadataException(string) | Initializes a new instance of the `GroupDocsMetadataException` class. |
| GroupDocsMetadataException(string, Exception) | Initializes a new instance of the `GroupDocsMetadataException` class. |

### GroupDocsMetadataException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/groupdocsmetadataexception/groupdocsmetadataexception.md

#### GroupDocsMetadataException()

Initializes a new instance of the `GroupDocsMetadataException` class.

```csharp
public GroupDocsMetadataException()
```

#### GroupDocsMetadataException(string)

Initializes a new instance of the `GroupDocsMetadataException` class.

```csharp
public GroupDocsMetadataException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### GroupDocsMetadataException(string, Exception)

Initializes a new instance of the `GroupDocsMetadataException` class.

```csharp
public GroupDocsMetadataException(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. |

### InvalidFormatException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/invalidformatexception.md

#### InvalidFormatException class

The exception that is thrown when a file has an invalid format.

```csharp
public sealed class InvalidFormatException : GroupDocsMetadataException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidFormatException() | Initializes a new instance of the `InvalidFormatException` class. |
| InvalidFormatException(string) | Initializes a new instance of the `InvalidFormatException` class. |
| InvalidFormatException(string, Exception) | Initializes a new instance of the `InvalidFormatException` class. |

### InvalidFormatException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/invalidformatexception/invalidformatexception.md

#### InvalidFormatException()

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException()
```

#### InvalidFormatException(string)

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### InvalidFormatException(string, Exception)

Initializes a new instance of the `InvalidFormatException` class.

```csharp
public InvalidFormatException(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. |

### MetadataValidationException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/metadatavalidationexception.md

#### MetadataValidationException class

The exception that is thrown when validation errors encountered during metadata saving.

```csharp
public sealed class MetadataValidationException : GroupDocsMetadataException
```

#### Properties

| Name | Description |
| --- | --- |
| Errors { get; } | Gets an array of the validation errors that were encountered during the last metadata saving. |

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | When overridden in a derived class, sets the SerializationInfo with information about the exception. |

### Errors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/metadatavalidationexception/errors.md

#### MetadataValidationException.Errors property

Gets an array of the validation errors that were encountered during the last metadata saving.

```csharp
public string[] Errors { get; }
```

##### Property Value

An array of the validation errors that were encountered during the last metadata saving.

### GetObjectData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/metadatavalidationexception/getobjectdata.md

#### MetadataValidationException.GetObjectData method

When overridden in a derived class, sets the SerializationInfo with information about the exception.

```csharp
public override void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The SerializationInfo that holds the serialized object data about the exception being thrown. |
| context | StreamingContext | The StreamingContext that contains contextual information about the source or destination. |

### XmpException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/xmpexception.md

#### XmpException class

The exception that is thrown when XMP has invalid structure.

```csharp
public sealed class XmpException : GroupDocsMetadataException
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpException() | Initializes a new instance of the `XmpException` class. |
| XmpException(string) | Initializes a new instance of the `XmpException` class. |
| XmpException(string, Exception) | Initializes a new instance of the `XmpException` class. |

### XmpException
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.exceptions/xmpexception/xmpexception.md

#### XmpException()

Initializes a new instance of the `XmpException` class.

```csharp
public XmpException()
```

#### XmpException(string)

Initializes a new instance of the `XmpException` class.

```csharp
public XmpException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message. |

#### XmpException(string, Exception)

Initializes a new instance of the `XmpException` class.

```csharp
public XmpException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message. |
| innerException | Exception | The inner exception. |

### GroupDocs.Metadata.Export
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export.md

The namespace contains classes that allow users to export metadata properties to different representations.

#### Classes

| Class | Description |
| --- | --- |
| CsvExportOptions | Creates an export options of xml file. |
| ExcelExportOptions | Creates an export options of excel file. |
| ExportManager | Provides a row of methods allowing the user to export metadata properties to various formats. |
| ExportOptions | Abstract class export options. |
| JsonExportOptions | Creates an export options of xml file. |
| XmlExportOptions | Creates an export options of xml file. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ExportFormat | Defines file formats to which you can export metadata properties. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### CsvExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/csvexportoptions.md

#### CsvExportOptions class

Creates an export options of xml file.

```csharp
public class CsvExportOptions : ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CsvExportOptions() | Initializes a new instance of the `CsvExportOptions` class. |

### CsvExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/csvexportoptions/csvexportoptions.md

#### CsvExportOptions constructor

Initializes a new instance of the `CsvExportOptions` class.

```csharp
public CsvExportOptions()
```

### ExcelExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/excelexportoptions.md

#### ExcelExportOptions class

Creates an export options of excel file.

```csharp
public class ExcelExportOptions : ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExcelExportOptions() | Initializes a new instance of the `ExcelExportOptions` class. |
| ExcelExportOptions(bool) | Initializes a new instance of the `ExcelExportOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| GroupCells { get; set; } | This flag determines whether it is necessary to group rows when exporting to Excel format |

### ExcelExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/excelexportoptions/excelexportoptions.md

#### ExcelExportOptions()

Initializes a new instance of the `ExcelExportOptions` class.

```csharp
public ExcelExportOptions()
```

#### ExcelExportOptions(bool)

Initializes a new instance of the `ExcelExportOptions` class.

```csharp
public ExcelExportOptions(bool groupCells)
```

| Parameter | Type | Description |
| --- | --- | --- |
| groupCells | Boolean | Group flag. |

### GroupCells
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/excelexportoptions/groupcells.md

#### ExcelExportOptions.GroupCells property

This flag determines whether it is necessary to group rows when exporting to Excel format

```csharp
public bool GroupCells { get; set; }
```

##### Property Value

If the flag is true, the lines will be grouped, otherwise not

### ExportFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportformat.md

#### ExportFormat enumeration

Defines file formats to which you can export metadata properties.

```csharp
public enum ExportFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Xls | `0` | Represents the .XLS Excel format. |
| Xlsx | `1` | Represents the .XLSX Excel format. |
| Xml | `2` | Represents the .XML format. |
| Csv | `3` | Represents the .CSV format. |
| Json | `4` | Represents the .JSON format. |

### ExportManager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportmanager.md

#### ExportManager class

Provides a row of methods allowing the user to export metadata properties to various formats.

```csharp
public class ExportManager
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportManager(IEnumerable&lt;MetadataProperty&gt;) | Initializes a new instance of the `ExportManager` class. |

#### Methods

| Name | Description |
| --- | --- |
| Export(Stream, ExportFormat) | Exports the metadata properties to a stream. |
| Export(string, ExportFormat) | Exports the metadata properties to a file. |
| Export(Stream, ExportFormat, ExportOptions) | Exports the metadata properties to a stream. |
| Export(string, ExportFormat, ExportOptions) | Exports the metadata properties to a file. |

### Export
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportmanager/export.md

#### Export(string, ExportFormat, ExportOptions)

Exports the metadata properties to a file.

```csharp
public void Export(string filePath, ExportFormat format, ExportOptions exportOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions | Additional options to use when exporting a document. |

#### Export(Stream, ExportFormat, ExportOptions)

Exports the metadata properties to a stream.

```csharp
public void Export(Stream document, ExportFormat format, ExportOptions exportOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions | Additional options to use when exporting a document. |

#### Export(string, ExportFormat)

Exports the metadata properties to a file.

```csharp
public void Export(string filePath, ExportFormat format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |

#### Export(Stream, ExportFormat)

Exports the metadata properties to a stream.

```csharp
public void Export(Stream document, ExportFormat format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The full name of the output file. |
| format | ExportFormat | The format of the output file. |

### ExportManager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportmanager/exportmanager.md

#### ExportManager constructor

Initializes a new instance of the `ExportManager` class.

```csharp
public ExportManager(IEnumerable<MetadataProperty> properties)
```

| Parameter | Type | Description |
| --- | --- | --- |
| properties | IEnumerable`1 | A collection of metadata properties to be exported. |

### ExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportoptions.md

#### ExportOptions class

Abstract class export options.

```csharp
public abstract class ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportOptions() | Initializes a new instance of the `ExportOptions` class. |

### ExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/exportoptions/exportoptions.md

#### ExportOptions constructor

Initializes a new instance of the `ExportOptions` class.

```csharp
public ExportOptions()
```

### JsonExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/jsonexportoptions.md

#### JsonExportOptions class

Creates an export options of xml file.

```csharp
public class JsonExportOptions : ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JsonExportOptions() | Initializes a new instance of the `JsonExportOptions` class. |

### JsonExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/jsonexportoptions/jsonexportoptions.md

#### JsonExportOptions constructor

Initializes a new instance of the `JsonExportOptions` class.

```csharp
public JsonExportOptions()
```

### XmlExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/xmlexportoptions.md

#### XmlExportOptions class

Creates an export options of xml file.

```csharp
public class XmlExportOptions : ExportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlExportOptions() | Initializes a new instance of the `XmlExportOptions` class. |

### XmlExportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.export/xmlexportoptions/xmlexportoptions.md

#### XmlExportOptions constructor

Initializes a new instance of the `XmlExportOptions` class.

```csharp
public XmlExportOptions()
```

### GroupDocs.Metadata.Formats.Archive
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive.md

The namespace contains classes for working with archive formats.

#### Classes

| Class | Description |
| --- | --- |
| RarFile | Represents metadata associated with an archived file or directory. |
| RarPackage | Represents ZIP archive metadata. |
| RarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| SevenZipFile | Represents metadata associated with an archived file or directory. |
| SevenZipPackage | Represents ZIP archive metadata. |
| SevenZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| TarFile | Represents metadata associated with an archived file or directory. |
| TarPackage | Represents ZIP archive metadata. |
| TarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| ZipFile | Represents metadata associated with an archived file or directory. |
| ZipPackage | Represents ZIP archive metadata. |
| ZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ZipCompressionMethod | Defines ZIP compression methods. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### RarFile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarfile.md

#### RarFile class

Represents metadata associated with an archived file or directory.

```csharp
public sealed class RarFile : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CompressedSize { get; } | Gets the compressed size in bytes. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModificationDateTime { get; } | Gets the last modification date and time. |
| Name { get; } | Gets the entry name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| UncompressedSize { get; } | Gets the uncompressed size in bytes. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarfile/compressedsize.md

#### RarFile.CompressedSize property

Gets the compressed size in bytes.

```csharp
public ulong CompressedSize { get; }
```

##### Property Value

The compressed size in bytes.

### ModificationDateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarfile/modificationdatetime.md

#### RarFile.ModificationDateTime property

Gets the last modification date and time.

```csharp
public DateTime ModificationDateTime { get; }
```

##### Property Value

The last modification date and time.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarfile/name.md

#### RarFile.Name property

Gets the entry name.

```csharp
public string Name { get; }
```

##### Property Value

The entry name. It can be a file or directory name.

### UncompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarfile/uncompressedsize.md

#### RarFile.UncompressedSize property

Gets the uncompressed size in bytes.

```csharp
public ulong UncompressedSize { get; }
```

##### Property Value

The uncompressed size in bytes.

### RarPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarpackage.md

#### RarPackage class

Represents ZIP archive metadata.

```csharp
public sealed class RarPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Files { get; } | Gets an array of `ZipFile` entries inside the ZIP archive. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TotalEntries { get; } | Gets the total number of entries inside the ZIP archive. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputRar))
{
    var root = metadata.GetRootPackage<RarRootPackage>();

    Console.WriteLine(root.RarPackage.TotalEntries);

    foreach (var file in root.RarPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### Files
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarpackage/files.md

#### RarPackage.Files property

Gets an array of `ZipFile` entries inside the ZIP archive.

```csharp
public RarFile[] Files { get; }
```

##### Property Value

An array of `ZipFile` entries inside the ZIP archive.

### TotalEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarpackage/totalentries.md

#### RarPackage.TotalEntries property

Gets the total number of entries inside the ZIP archive.

```csharp
public ulong TotalEntries { get; }
```

##### Property Value

The total number of entries inside the ZIP archive.

### RarRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarrootpackage.md

#### RarRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

```csharp
public class RarRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RarPackage { get; } | Gets the ZIP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputRar))
{
    var root = metadata.GetRootPackage<RarRootPackage>();

    Console.WriteLine(root.RarPackage.TotalEntries);

    foreach (var file in root.RarPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### RarPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/rarrootpackage/rarpackage.md

#### RarRootPackage.RarPackage property

Gets the ZIP metadata package.

```csharp
public RarPackage RarPackage { get; }
```

##### Property Value

The ZIP metadata package.

### SevenZipFile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzipfile.md

#### SevenZipFile class

Represents metadata associated with an archived file or directory.

```csharp
public sealed class SevenZipFile : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CompressedSize { get; } | Gets the compressed size in bytes. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModificationDateTime { get; } | Gets the last modification date and time. |
| Name { get; } | Gets the entry name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| UncompressedSize { get; } | Gets the uncompressed size in bytes. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzipfile/compressedsize.md

#### SevenZipFile.CompressedSize property

Gets the compressed size in bytes.

```csharp
public ulong CompressedSize { get; }
```

##### Property Value

The compressed size in bytes.

### ModificationDateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzipfile/modificationdatetime.md

#### SevenZipFile.ModificationDateTime property

Gets the last modification date and time.

```csharp
public DateTime ModificationDateTime { get; }
```

##### Property Value

The last modification date and time.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzipfile/name.md

#### SevenZipFile.Name property

Gets the entry name.

```csharp
public string Name { get; }
```

##### Property Value

The entry name. It can be a file or directory name.

### UncompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzipfile/uncompressedsize.md

#### SevenZipFile.UncompressedSize property

Gets the uncompressed size in bytes.

```csharp
public ulong UncompressedSize { get; }
```

##### Property Value

The uncompressed size in bytes.

### SevenZipPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzippackage.md

#### SevenZipPackage class

Represents ZIP archive metadata.

```csharp
public sealed class SevenZipPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Files { get; } | Gets an array of `ZipFile` entries inside the ZIP archive. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TotalEntries { get; } | Gets the total number of entries inside the ZIP archive. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputSevenZip))
{
    var root = metadata.GetRootPackage<SevenZipRootPackage>();

    Console.WriteLine(root.SevenZipPackage.TotalEntries);

    foreach (var file in root.SevenZipPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### Files
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzippackage/files.md

#### SevenZipPackage.Files property

Gets an array of `ZipFile` entries inside the ZIP archive.

```csharp
public SevenZipFile[] Files { get; }
```

##### Property Value

An array of `ZipFile` entries inside the ZIP archive.

### TotalEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenzippackage/totalentries.md

#### SevenZipPackage.TotalEntries property

Gets the total number of entries inside the ZIP archive.

```csharp
public ulong TotalEntries { get; }
```

##### Property Value

The total number of entries inside the ZIP archive.

### SevenZipRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenziprootpackage.md

#### SevenZipRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

```csharp
public class SevenZipRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SevenZipPackage { get; } | Gets the ZIP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputSevenZip))
{
    var root = metadata.GetRootPackage<SevenZipRootPackage>();

    Console.WriteLine(root.SevenZipPackage.TotalEntries);

    foreach (var file in root.SevenZipPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### SevenZipPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/sevenziprootpackage/sevenzippackage.md

#### SevenZipRootPackage.SevenZipPackage property

Gets the ZIP metadata package.

```csharp
public SevenZipPackage SevenZipPackage { get; }
```

##### Property Value

The ZIP metadata package.

### TarFile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarfile.md

#### TarFile class

Represents metadata associated with an archived file or directory.

```csharp
public sealed class TarFile : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the entry name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Size { get; } | Gets the size in bytes. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarfile/name.md

#### TarFile.Name property

Gets the entry name.

```csharp
public string Name { get; }
```

##### Property Value

The entry name. It can be a file or directory name.

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarfile/size.md

#### TarFile.Size property

Gets the size in bytes.

```csharp
public ulong Size { get; }
```

##### Property Value

The size in bytes.

### TarPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarpackage.md

#### TarPackage class

Represents ZIP archive metadata.

```csharp
public sealed class TarPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Files { get; } | Gets an array of `ZipFile` entries inside the ZIP archive. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TotalEntries { get; } | Gets the total number of entries inside the ZIP archive. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputTar))
{
    var root = metadata.GetRootPackage<TarRootPackage>();

    Console.WriteLine(root.TarPackage.TotalEntries);

    foreach (var file in root.TarPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.Size);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### Files
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarpackage/files.md

#### TarPackage.Files property

Gets an array of `ZipFile` entries inside the ZIP archive.

```csharp
public TarFile[] Files { get; }
```

##### Property Value

An array of `ZipFile` entries inside the ZIP archive.

### TotalEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarpackage/totalentries.md

#### TarPackage.TotalEntries property

Gets the total number of entries inside the ZIP archive.

```csharp
public ulong TotalEntries { get; }
```

##### Property Value

The total number of entries inside the ZIP archive.

### TarRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarrootpackage.md

#### TarRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

```csharp
public class TarRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TarPackage { get; } | Gets the ZIP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputTar))
{
    var root = metadata.GetRootPackage<TarRootPackage>();

    Console.WriteLine(root.TarPackage.TotalEntries);

    foreach (var file in root.TarPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### TarPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/tarrootpackage/tarpackage.md

#### TarRootPackage.TarPackage property

Gets the ZIP metadata package.

```csharp
public TarPackage TarPackage { get; }
```

##### Property Value

The ZIP metadata package.

### ZipCompressionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipcompressionmethod.md

#### ZipCompressionMethod enumeration

Defines ZIP compression methods.

```csharp
public enum ZipCompressionMethod : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NoCompression | `0` | The file is stored (no compression). |
| Shrunk | `1` | The file is Shrunk. |
| Imploded | `6` | The file is Imploded. |
| Reserved | `7` | A reserved compression method. |
| Deflated | `8` | The file is Deflated. |
| BZip2 | `12` | The file is compressed with the BZip2 algorithm. |
| Lzma | `14` | The Lempel-Ziv-Markov chain-Algorithm. |

### ZipFile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile.md

#### ZipFile class

Represents metadata associated with an archived file or directory.

```csharp
public sealed class ZipFile : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CompressedSize { get; } | Gets the compressed size in bytes. |
| CompressionMethod { get; } | Gets the compression method. |
| Count { get; } | Gets the number of metadata properties. |
| Flags { get; } | Gets the ZIP entry flags. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModificationDateTime { get; } | Gets the last modification date and time. |
| Name { get; } | Gets the entry name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawName { get; } | Gets an array of bytes representing the name of the entry. |
| UncompressedSize { get; } | Gets the uncompressed size in bytes. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/compressedsize.md

#### ZipFile.CompressedSize property

Gets the compressed size in bytes.

```csharp
public ulong CompressedSize { get; }
```

##### Property Value

The compressed size in bytes.

### CompressionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/compressionmethod.md

#### ZipFile.CompressionMethod property

Gets the compression method.

```csharp
public ZipCompressionMethod CompressionMethod { get; }
```

##### Property Value

The compression method.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/flags.md

#### ZipFile.Flags property

Gets the ZIP entry flags.

```csharp
public int Flags { get; }
```

##### Property Value

The ZIP entry flags.

##### Remarks

Bit 00: encrypted file.  Bit 01: compression option.  Bit 02: compression option.  Bit 03: data descriptor.  Bit 04: enhanced deflation.  Bit 05: compressed patched data.  Bit 06: strong encryption.  Bit 07-10: unused.  Bit 11: language encoding.  Bit 12: reserved.  Bit 13: mask header values.  Bit 14-15: reserved.

### ModificationDateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/modificationdatetime.md

#### ZipFile.ModificationDateTime property

Gets the last modification date and time.

```csharp
public DateTime ModificationDateTime { get; }
```

##### Property Value

The last modification date and time.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/name.md

#### ZipFile.Name property

Gets the entry name.

```csharp
public string Name { get; }
```

##### Property Value

The entry name. It can be a file or directory name.

### RawName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/rawname.md

#### ZipFile.RawName property

Gets an array of bytes representing the name of the entry.

```csharp
public byte[] RawName { get; }
```

##### Property Value

An array of bytes representing the name of the entry.

### UncompressedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zipfile/uncompressedsize.md

#### ZipFile.UncompressedSize property

Gets the uncompressed size in bytes.

```csharp
public ulong UncompressedSize { get; }
```

##### Property Value

The uncompressed size in bytes.

### ZipPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zippackage.md

#### ZipPackage class

Represents ZIP archive metadata.

```csharp
public sealed class ZipPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Comment { get; set; } | Gets or sets the ZIP archive comment created by a user. |
| Count { get; } | Gets the number of metadata properties. |
| Files { get; } | Gets an array of `ZipFile` entries inside the ZIP archive. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TotalEntries { get; } | Gets the total number of entries inside the ZIP archive. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputZip))
{
    var root = metadata.GetRootPackage<ZipRootPackage>();

    Console.WriteLine(root.ZipPackage.Comment);
    Console.WriteLine(root.ZipPackage.TotalEntries);

    foreach (var file in root.ZipPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.CompressionMethod);
        Console.WriteLine(file.Flags);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zippackage/comment.md

#### ZipPackage.Comment property

Gets or sets the ZIP archive comment created by a user.

```csharp
public string Comment { get; set; }
```

##### Property Value

The user's comment.

##### Examples

The following code snippet shows how to remove the user comment from a ZIP archive.

```csharp
using (Metadata metadata = new Metadata(Constants.InputZip))
{
    var root = metadata.GetRootPackage<ZipRootPackage>();

    root.ZipPackage.Comment = null;

    metadata.Save(Constants.OutputZip);
}
```

### Files
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zippackage/files.md

#### ZipPackage.Files property

Gets an array of `ZipFile` entries inside the ZIP archive.

```csharp
public ZipFile[] Files { get; }
```

##### Property Value

An array of `ZipFile` entries inside the ZIP archive.

### TotalEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/zippackage/totalentries.md

#### ZipPackage.TotalEntries property

Gets the total number of entries inside the ZIP archive.

```csharp
public ulong TotalEntries { get; }
```

##### Property Value

The total number of entries inside the ZIP archive.

### ZipRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/ziprootpackage.md

#### ZipRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

```csharp
public class ZipRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ZipPackage { get; } | Gets the ZIP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a ZIP archive.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputZip))
{
    var root = metadata.GetRootPackage<ZipRootPackage>();

    Console.WriteLine(root.ZipPackage.Comment);
    Console.WriteLine(root.ZipPackage.TotalEntries);

    foreach (var file in root.ZipPackage.Files)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.CompressedSize);
        Console.WriteLine(file.CompressionMethod);
        Console.WriteLine(file.Flags);
        Console.WriteLine(file.ModificationDateTime);
        Console.WriteLine(file.UncompressedSize);

        // Use a specific encoding for the file names
        Console.WriteLine(encoding.GetString(file.RawName));
    }
}
```

### ZipPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.archive/ziprootpackage/zippackage.md

#### ZipRootPackage.ZipPackage property

Gets the ZIP metadata package.

```csharp
public ZipPackage ZipPackage { get; }
```

##### Property Value

The ZIP metadata package.

### GroupDocs.Metadata.Formats.Audio.Ogg
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg.md

#### Classes

| Class | Description |
| --- | --- |
| OggPackage | Represents a native metadata package in a OGG audio file. |
| OggRootPackage | Represents a native metadata package in a OGG audio file. |
| OggUserComment | Represents Ogg User Comment metadata class. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### OggPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage.md

#### OggPackage class

Represents a native metadata package in a OGG audio file.

```csharp
public sealed class OggPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| OggPackage() | Initializes a new instance of the `OggPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Album { get; } | The collection name to which this track belongs |
| Artist { get; } | The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text. |
| Contact { get; } | Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label. |
| Copyright { get; } | Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt' |
| Count { get; } | Gets the number of metadata properties. |
| Date { get; } | Date the track was recorded |
| Description { get; } | A short text description of the contents |
| Genre { get; } | A short text indication of music genre |
| Isrc { get; } | ISRC number for the track |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| License { get; } | License information, for example, 'All Rights Reserved', 'Any Use Permitted', a URL to a license such as a Creative Commons license (e.g. "creativecommons.org/licenses/by/4.0/"), or similar. |
| Location { get; } | Location where track was recorded |
| MetadataType { get; } | Gets the metadata type. |
| OggUserComments { get; } | Gets an array of `OggUserComment` entries inside the metadata. |
| Organization { get; } | Name of the organization producing the track (i.e. the 'record label') |
| Performer { get; } | The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Title { get; } | Track/Work name |
| Tracknumber { get; } | The track number of this piece if part of a specific larger collection or album |
| Vendor { get; } | Vendor |
| Version { get; } | The version field may be used to differentiate multiple versions of the same track title in a single collection. (e.g. remix info) |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract technical audio information from a OGG file.

```csharp
using (Metadata metadata = new Metadata("input.ogg"))
{
    var root = metadata.GetRootPackage<OggRootPackage>();
    if (root.OggPackage != null)
    {
        Console.WriteLine(root.OggPackage.Title);
        Console.WriteLine(root.OggPackage.Version);
        Console.WriteLine(root.OggPackage.Album);
    }
}
```

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/album.md

#### OggPackage.Album property

The collection name to which this track belongs

```csharp
public string Album { get; }
```

##### Property Value

Album value

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/artist.md

#### OggPackage.Artist property

The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.

```csharp
public string Artist { get; }
```

##### Property Value

Artist value

### Contact
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/contact.md

#### OggPackage.Contact property

Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.

```csharp
public string Contact { get; }
```

##### Property Value

Contact value

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/copyright.md

#### OggPackage.Copyright property

Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'

```csharp
public string Copyright { get; }
```

##### Property Value

Copyright value

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/date.md

#### OggPackage.Date property

Date the track was recorded

```csharp
public string Date { get; }
```

##### Property Value

Date value

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/description.md

#### OggPackage.Description property

A short text description of the contents

```csharp
public string Description { get; }
```

##### Property Value

Description value

### Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/genre.md

#### OggPackage.Genre property

A short text indication of music genre

```csharp
public string Genre { get; }
```

##### Property Value

Genre value

### Isrc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/isrc.md

#### OggPackage.Isrc property

ISRC number for the track

```csharp
public string Isrc { get; }
```

##### Property Value

Isrc value

### License
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/license.md

#### OggPackage.License property

License information, for example, 'All Rights Reserved', 'Any Use Permitted', a URL to a license such as a Creative Commons license (e.g. "creativecommons.org/licenses/by/4.0/"), or similar.

```csharp
public string License { get; }
```

##### Property Value

License value

### Location
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/location.md

#### OggPackage.Location property

Location where track was recorded

```csharp
public string Location { get; }
```

##### Property Value

Location value

### OggPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/oggpackage.md

#### OggPackage constructor

Initializes a new instance of the `OggPackage` class.

```csharp
public OggPackage()
```

### OggUserComments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/oggusercomments.md

#### OggPackage.OggUserComments property

Gets an array of `OggUserComment` entries inside the metadata.

```csharp
public OggUserComment[] OggUserComments { get; }
```

##### Property Value

An array of `OggUserComment` entries inside the metadata.

### Organization
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/organization.md

#### OggPackage.Organization property

Name of the organization producing the track (i.e. the 'record label')

```csharp
public string Organization { get; }
```

##### Property Value

Organization value

### Performer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/performer.md

#### OggPackage.Performer property

The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.

```csharp
public string Performer { get; }
```

##### Property Value

Performer value

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/title.md

#### OggPackage.Title property

Track/Work name

```csharp
public string Title { get; }
```

##### Property Value

Title value

### Tracknumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/tracknumber.md

#### OggPackage.Tracknumber property

The track number of this piece if part of a specific larger collection or album

```csharp
public string Tracknumber { get; }
```

##### Property Value

Tracknumber value

### Vendor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/vendor.md

#### OggPackage.Vendor property

Vendor

```csharp
public string Vendor { get; }
```

##### Property Value

Vendor value

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggpackage/version.md

#### OggPackage.Version property

The version field may be used to differentiate multiple versions of the same track title in a single collection. (e.g. remix info)

```csharp
public string Version { get; }
```

##### Property Value

Version value

### OggRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggrootpackage.md

#### OggRootPackage class

Represents a native metadata package in a OGG audio file.

```csharp
public class OggRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| OggPackage { get; } | Gets the Ogg native metadata package. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract technical audio information from a OGG file.

```csharp
using (Metadata metadata = new Metadata("input.ogg"))
{
    var root = metadata.GetRootPackage<OggRootPackage>();
    if (root.OggPackage != null)
    {
        Console.WriteLine(root.OggPackage.Title);
        Console.WriteLine(root.OggPackage.Version);
        Console.WriteLine(root.OggPackage.Album);
    }
}
```

### OggPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/oggpackage.md

#### OggRootPackage.OggPackage property

Gets the Ogg native metadata package.

```csharp
public OggPackage OggPackage { get; }
```

##### Property Value

The Ogg native metadata package.

### OggUserComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggusercomment.md

#### OggUserComment class

Represents Ogg User Comment metadata class.

```csharp
public sealed class OggUserComment : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Header { get; } | Gets the user comments header |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the user comments value |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Header
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggusercomment/header.md

#### OggUserComment.Header property

Gets the user comments header

```csharp
public string Header { get; }
```

##### Property Value

The header value.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.ogg/oggusercomment/value.md

#### OggUserComment.Value property

Gets the user comments value

```csharp
public string Value { get; }
```

##### Property Value

The value.

### GroupDocs.Metadata.Formats.Audio
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio.md

The namespace provides classes intended to work with different audio formats.

#### Classes

| Class | Description |
| --- | --- |
| ApePackage | Represents an APE v2 metadata package. Please find more information at [http://wiki.hydrogenaud.io/index.php?title=APE_key](http://wiki.hydrogenaud.io/index.php?title=APE_key). |
| ID3Tag | Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags. |
| ID3V1Tag | Represents an ID3v1 tag. Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v1](https://en.wikipedia.org/wiki/ID3#ID3v1). |
| ID3V2AttachedPictureFrame | Represents an APIC frame in an `ID3V2Tag`. |
| ID3V2CommentFrame | Represents a COMM frame in an `ID3V2Tag`. |
| ID3V2MlltFrame | Represents an MLLT frame in an `ID3V2Tag`. |
| ID3V2PlayCounterFrame | Represents a PCNT frame in an `ID3V2Tag`. This is simply a counter of the number of times a file has been played. |
| ID3V2PrivateFrame | Represents a PRIV frame in an `ID3V2Tag`. The frame is used to contain information from a software producer that its program uses and does not fit into the other frames. |
| ID3V2Tag | Represents an ID3v2 tag. Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v2](https://en.wikipedia.org/wiki/ID3#ID3v2). |
| ID3V2TagFrame | Represents a generic frame in an `ID3V2Tag`. |
| ID3V2TagFrameFlags | Represents flags used in a ID3v2 tag frame. |
| ID3V2TextFrame | Represents a text frame in an `ID3V2Tag`. Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the `ID3V2UserDefinedFrame` class. |
| ID3V2UrlLinkFrame | Represents a URL link frame in an `ID3V2Tag`. Name of the frame always starts with the W character. |
| ID3V2UserDefinedFrame | Represents a TXXX frame in an `ID3V2Tag`. |
| ID3V2UserDefinedUrlLinkFrame | Represents a WXXX frame in an `ID3V2Tag`. |
| LyricsField | Represents a `LyricsTag` field. |
| LyricsTag | Represents Lyrics3 v2.00 metadata. Please find more information at http://id3.org/Lyrics3v2. |
| MP3RootPackage | Represents the root package allowing working with metadata in an MP3 audio. |
| WavPackage | Represents a native metadata package in a WAV audio file. |
| WavRootPackage | Represents the root package allowing working with metadata in a WAV audio. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ID3V1Genre | Specifies genres used in an Id3v1 tag. |
| ID3V2AttachedPictureType | Represents the type of an attached picture. |
| ID3V2EncodingType | Defines different types of text encoding used in ID3v2. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ApePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage.md

#### ApePackage class

Represents an APE v2 metadata package. Please find more information at [http://wiki.hydrogenaud.io/index.php?title=APE_key](http://wiki.hydrogenaud.io/index.php?title=APE_key).

```csharp
public sealed class ApePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Abstract { get; } | Gets the abstract link. |
| Album { get; } | Gets the album. |
| Artist { get; } | Gets the artist. |
| Bibliography { get; } | Gets the bibliography. |
| Comment { get; } | Gets the comment. |
| Composer { get; } | Gets the composer. |
| Conductor { get; } | Gets the conductor. |
| Copyright { get; } | Gets the copyright. |
| Count { get; } | Gets the number of metadata properties. |
| DebutAlbum { get; } | Gets the debut album. |
| File { get; } | Gets the file. |
| Genre { get; } | Gets the genre. |
| Isbn { get; } | Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International_Standard_Book_Number. |
| Isrc { get; } | Gets the International Standard Recording Number. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PublicationRight { get; } | Gets the publication right. |
| Publisher { get; } | Gets the publisher. |
| RecordLocation { get; } | Gets the record location. |
| Subtitle { get; } | Gets the subtitle. |
| Title { get; } | Gets the title. |
| Track { get; } | Gets the track number. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to read the APEv2 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithApe))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ApeV2 != null)
    {
        Console.WriteLine(root.ApeV2.Album);
        Console.WriteLine(root.ApeV2.Title);
        Console.WriteLine(root.ApeV2.Artist);
        Console.WriteLine(root.ApeV2.Composer);
        Console.WriteLine(root.ApeV2.Copyright);
        Console.WriteLine(root.ApeV2.Genre);
        Console.WriteLine(root.ApeV2.Language);

        // ...
    }
}
```

### Abstract
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/abstract.md

#### ApePackage.Abstract property

Gets the abstract link.

```csharp
public string Abstract { get; }
```

##### Property Value

The abstract link.

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/album.md

#### ApePackage.Album property

Gets the album.

```csharp
public string Album { get; }
```

##### Property Value

The album.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/artist.md

#### ApePackage.Artist property

Gets the artist.

```csharp
public string Artist { get; }
```

##### Property Value

The artist.

### Bibliography
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/bibliography.md

#### ApePackage.Bibliography property

Gets the bibliography.

```csharp
public string Bibliography { get; }
```

##### Property Value

The bibliography.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/comment.md

#### ApePackage.Comment property

Gets the comment.

```csharp
public string Comment { get; }
```

##### Property Value

The comment.

### Composer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/composer.md

#### ApePackage.Composer property

Gets the composer.

```csharp
public string Composer { get; }
```

##### Property Value

The composer.

### Conductor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/conductor.md

#### ApePackage.Conductor property

Gets the conductor.

```csharp
public string Conductor { get; }
```

##### Property Value

The conductor.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/copyright.md

#### ApePackage.Copyright property

Gets the copyright.

```csharp
public string Copyright { get; }
```

##### Property Value

The copyright.

### DebutAlbum
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/debutalbum.md

#### ApePackage.DebutAlbum property

Gets the debut album.

```csharp
public string DebutAlbum { get; }
```

##### Property Value

The debut album.

### File
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/file.md

#### ApePackage.File property

Gets the file.

```csharp
public string File { get; }
```

##### Property Value

The file.

### Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/genre.md

#### ApePackage.Genre property

Gets the genre.

```csharp
public string Genre { get; }
```

##### Property Value

The genre.

### Isbn
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/isbn.md

#### ApePackage.Isbn property

Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International_Standard_Book_Number.

```csharp
public string Isbn { get; }
```

##### Property Value

The ISBN number.

### Isrc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/isrc.md

#### ApePackage.Isrc property

Gets the International Standard Recording Number.

```csharp
public string Isrc { get; }
```

##### Property Value

The International Standard Recording Number.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/language.md

#### ApePackage.Language property

Gets the language.

```csharp
public string Language { get; }
```

##### Property Value

The language.

### PublicationRight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/publicationright.md

#### ApePackage.PublicationRight property

Gets the publication right.

```csharp
public string PublicationRight { get; }
```

##### Property Value

The publication right.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/publisher.md

#### ApePackage.Publisher property

Gets the publisher.

```csharp
public string Publisher { get; }
```

##### Property Value

The publisher.

### RecordLocation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/recordlocation.md

#### ApePackage.RecordLocation property

Gets the record location.

```csharp
public string RecordLocation { get; }
```

##### Property Value

The record location.

### Subtitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/subtitle.md

#### ApePackage.Subtitle property

Gets the subtitle.

```csharp
public string Subtitle { get; }
```

##### Property Value

The subtitle.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/title.md

#### ApePackage.Title property

Gets the title.

```csharp
public string Title { get; }
```

##### Property Value

The title.

### Track
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/apepackage/track.md

#### ApePackage.Track property

Gets the track number.

```csharp
public int? Track { get; }
```

##### Property Value

The track number.

### ID3Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3tag.md

#### ID3Tag class

Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags.

```csharp
public abstract class ID3Tag : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| abstract Version { get; } | Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3tag/version.md

#### ID3Tag.Version property

Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'.

```csharp
public abstract string Version { get; }
```

##### Property Value

The ID3 version.

### ID3V1Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1genre.md

#### ID3V1Genre enumeration

Specifies genres used in an Id3v1 tag.

```csharp
public enum ID3V1Genre : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Blues | `0` | Represents the Blues genre. |
| ClassicRock | `1` | Represents the Classic Rock genre. |
| Country | `2` | Represents the Country genre. |
| Dance | `3` | Represents the Dance genre. |
| Disco | `4` | Represents the Disco genre. |
| Funk | `5` | Represents the Funk genre. |
| Grunge | `6` | Represents the Grunge genre. |
| HipHop | `7` | Represents the Hip-Hop genre. |
| Jazz | `8` | Represents the Jazz genre. |
| Metal | `9` | Represents the Metal genre. |
| NewAge | `10` | Represents the New Age genre. |
| Oldies | `11` | Represents the Oldies genre. |
| Other | `12` | Represents the Other genre. |
| Pop | `13` | Represents the Pop genre. |
| RhythmAndBlues | `14` | Represents the Rhythm and Blues genre. |
| Rap | `15` | Represents the Rap genre. |
| Reggae | `16` | Represents the Reggae genre. |
| Rock | `17` | Represents the Rock genre. |
| Techno | `18` | Represents the Techno genre. |
| Industrial | `19` | Represents the Industrial genre. |
| Alternative | `20` | Represents the Alternative genre. |
| Ska | `21` | Represents the Ska genre. |
| DeathMetal | `22` | Represents the Death Metal genre. |
| Pranks | `23` | Represents the Pranks genre. |
| Soundtrack | `24` | Represents the Soundtrack genre. |
| EuroTechno | `25` | Represents the Euro-Techno genre. |
| Ambient | `26` | Represents the Ambient genre. |
| TripHop | `27` | Represents the Trip-Hop genre. |
| Vocal | `28` | Represents the Vocal genre. |
| JazzAndFunk | `29` | Represents the JazzAndFunk genre. |
| Fusion | `30` | Represents the Fusion genre. |
| Trance | `31` | Represents the Trance genre. |
| Classical | `32` | Represents the Classical genre. |
| Instrumental | `33` | Represents the Instrumental genre. |
| Acid | `34` | Represents the Acid genre. |
| House | `35` | Represents the House genre. |
| Game | `36` | Represents the Game genre. |
| SoundClip | `37` | Represents the Sound Clip genre. |
| Gospel | `38` | Represents the Gospel genre. |
| Noise | `39` | Represents the Noise genre. |
| AlternativeRock | `40` | Represents the Alternative Rock genre. |
| Bass | `41` | Represents the Bass genre. |
| Soul | `42` | Represents the Soul genre. |
| Punk | `43` | Represents the Punk genre. |
| Space | `44` | Represents the Space genre. |
| Meditative | `45` | Represents the Meditative genre. |
| InstrumentalPop | `46` | Represents the Instrumental Pop genre. |
| InstrumentalRock | `47` | Represents the Instrumental Rock genre. |
| Ethnic | `48` | Represents the Ethnic genre. |
| Gothic | `49` | Represents the Gothic genre. |
| Darkwave | `50` | Represents the Darkwave genre. |
| TechnoIndustrial | `51` | Represents the Techno-Industrial genre. |
| Electronic | `52` | Represents the Electronic genre. |
| PopFolk | `53` | Represents the Pop-Folk genre. |
| Eurodance | `54` | Represents the Eurodance genre. |
| Dream | `55` | Represents the Dream genre. |
| SouthernRock | `56` | Represents the Southern Rock genre. |
| Comedy | `57` | Represents the Comedy genre. |
| Cult | `58` | Represents the Cult genre. |
| Gangsta | `59` | Represents the Gangsta genre. |
| Top40 | `60` | Represents the Top 40 genre. |
| ChristianRap | `61` | Represents the Christian Rap genre. |
| PopFunk | `62` | Represents the Pop/Funk genre. |
| Jungle | `63` | Represents the Jungle genre. |
| NativeAmerican | `64` | Represents the Native American genre. |
| Cabaret | `65` | Represents the Cabaret genre. |
| NewWave | `66` | Represents the New Wave genre. |
| Psychedelic | `67` | Represents the Psychedelic genre. |
| Rave | `68` | Represents the Rave genre. |
| Showtunes | `69` | Represents the Showtunes genre. |
| Trailer | `70` | Represents the Trailer genre. |
| LoFi | `71` | Represents the Lo-Fi genre. |
| Tribal | `72` | Represents the Tribal genre. |
| AcidPunk | `73` | Represents the Acid Punk genre. |
| AcidJazz | `74` | Represents the Acid Jazz genre. |
| Polka | `75` | Represents the Polka genre. |
| Retro | `76` | Represents the Retro genre. |
| Musical | `77` | Represents the Musical genre. |
| RockNRoll | `78` | Represents the Rock 'n' Roll genre. |
| HardRock | `79` | Represents the Hard Rock genre. |

### ID3V1Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag.md

#### ID3V1Tag class

Represents an ID3v1 tag. Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v1](https://en.wikipedia.org/wiki/ID3#ID3v1).

```csharp
public sealed class ID3V1Tag : ID3Tag
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V1Tag() | Initializes a new instance of the `ID3V1Tag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Album { get; set; } | Gets or sets the album. Maximum length is 30 characters. |
| Artist { get; set; } | Gets or sets the artist. Maximum length is 30 characters. |
| Comment { get; set; } | Gets or sets the comment. Maximum length is 30 characters. |
| Count { get; } | Gets the number of metadata properties. |
| GenreValue { get; } | Gets or sets the genre identifier. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Title { get; set; } | Gets or sets the title. |
| TrackNumber { get; set; } | Gets or sets the track number. Presented in a ID3v1.1 tag only. |
| override Version { get; } | Gets the ID3 version. It can be ID3 or ID3v1.1 |
| Year { get; set; } | Gets or sets the year. Maximum length is 4 characters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Remarks

ID3(v1) tag is a small chunk of extra data at the end of MP3. Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1).

##### Examples

This code sample shows how to read the ID3v1 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V1))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ID3V1 != null)
    {
        Console.WriteLine(root.ID3V1.Album);
        Console.WriteLine(root.ID3V1.Artist);
        Console.WriteLine(root.ID3V1.Title);
        Console.WriteLine(root.ID3V1.Version);
        Console.WriteLine(root.ID3V1.Comment);

        // ...
    }
}
```

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/album.md

#### ID3V1Tag.Album property

Gets or sets the album. Maximum length is 30 characters.

```csharp
public string Album { get; set; }
```

##### Property Value

The album.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/artist.md

#### ID3V1Tag.Artist property

Gets or sets the artist. Maximum length is 30 characters.

```csharp
public string Artist { get; set; }
```

##### Property Value

The artist.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/comment.md

#### ID3V1Tag.Comment property

Gets or sets the comment. Maximum length is 30 characters.

```csharp
public string Comment { get; set; }
```

##### Property Value

The comment.

### GenreValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/genrevalue.md

#### ID3V1Tag.GenreValue property

Gets or sets the genre identifier.

```csharp
public ID3V1Genre GenreValue { get; }
```

##### Property Value

The genre identifier.

### ID3V1Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/id3v1tag.md

#### ID3V1Tag constructor

Initializes a new instance of the `ID3V1Tag` class.

```csharp
public ID3V1Tag()
```

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/title.md

#### ID3V1Tag.Title property

Gets or sets the title.

```csharp
public string Title { get; set; }
```

##### Property Value

The title.

### TrackNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/tracknumber.md

#### ID3V1Tag.TrackNumber property

Gets or sets the track number. Presented in a ID3v1.1 tag only.

```csharp
public int? TrackNumber { get; set; }
```

##### Property Value

The track number.

##### Remarks

If the value of `TrackNumber` is a positive integer then ID3 changes version to 'ID3v1.1' automatically.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/version.md

#### ID3V1Tag.Version property

Gets the ID3 version. It can be ID3 or ID3v1.1

```csharp
public override string Version { get; }
```

##### Property Value

The ID3 version.

### Year
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v1tag/year.md

#### ID3V1Tag.Year property

Gets or sets the year. Maximum length is 4 characters.

```csharp
public string Year { get; set; }
```

##### Property Value

The year.

### ID3V2AttachedPictureFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe.md

#### ID3V2AttachedPictureFrame class

Represents an APIC frame in an `ID3V2Tag`.

```csharp
public sealed class ID3V2AttachedPictureFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2AttachedPictureFrame(byte[]) | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |
| ID3V2AttachedPictureFrame(ID3V2AttachedPictureType, string, byte[]) | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |
| ID3V2AttachedPictureFrame(ID3V2EncodingType, string, ID3V2AttachedPictureType, string, byte[]) | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| AttachedPictureType { get; } | Gets the type of the picture. |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Description { get; } | Gets the picture description. The description has a maximum length of 64 characters, but may be empty. |
| DescriptionEncoding { get; } | Gets the encoding used to encode the picture description. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type of the picture. |
| PictureData { get; } | Gets the picture data. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AttachedPictureType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/attachedpicturetype.md

#### ID3V2AttachedPictureFrame.AttachedPictureType property

Gets the type of the picture.

```csharp
public ID3V2AttachedPictureType AttachedPictureType { get; }
```

##### Property Value

The type of the picture.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/description.md

#### ID3V2AttachedPictureFrame.Description property

Gets the picture description. The description has a maximum length of 64 characters, but may be empty.

```csharp
public string Description { get; }
```

##### Property Value

The picture description.

### DescriptionEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/descriptionencoding.md

#### ID3V2AttachedPictureFrame.DescriptionEncoding property

Gets the encoding used to encode the picture description.

```csharp
public ID3V2EncodingType DescriptionEncoding { get; }
```

##### Property Value

The encoding used to encode the picture description.

### ID3V2AttachedPictureFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/id3v2attachedpictureframe.md

#### ID3V2AttachedPictureFrame(ID3V2EncodingType, string, ID3V2AttachedPictureType, string, byte[])

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```csharp
public ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, string mimeType, 
    ID3V2AttachedPictureType pictureType, string description, byte[] pictureData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The frame encoding. |
| mimeType | String | The MIME-type of the image. |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | String | The description of the picture. |
| pictureData | Byte[] | The picture data. |

#### ID3V2AttachedPictureFrame(ID3V2AttachedPictureType, string, byte[])

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```csharp
public ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, string description, 
    byte[] pictureData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | String | The description of the picture. |
| pictureData | Byte[] | The picture data. |

#### ID3V2AttachedPictureFrame(byte[])

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```csharp
public ID3V2AttachedPictureFrame(byte[] pictureData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pictureData | Byte[] | The picture data. |

### MimeType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/mimetype.md

#### ID3V2AttachedPictureFrame.MimeType property

Gets the MIME type of the picture.

```csharp
public string MimeType { get; }
```

##### Property Value

The MIME type of the picture.

### PictureData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/picturedata.md

#### ID3V2AttachedPictureFrame.PictureData property

Gets the picture data.

```csharp
public byte[] PictureData { get; }
```

##### Property Value

The picture data.

### ID3V2AttachedPictureType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2attachedpicturetype.md

#### ID3V2AttachedPictureType enumeration

Represents the type of an attached picture.

```csharp
public enum ID3V2AttachedPictureType : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Other | `0` | Attached picture of any other type. |
| FileIcon32X32 | `1` | 32x32 pixels file icon (PNG only). |
| OtherFileIcon | `2` | Other file icon. |
| CoverFront | `3` | Cover (front). |
| CoverBack | `4` | Cover (back). |
| LeafletPage | `5` | Leaflet page. |
| Media | `6` | Media (e.g. label side of CD). |
| LeadArtist | `7` | Lead artist/lead performer/soloist. |
| Artist | `8` | Artist/performer. |
| Conductor | `9` | Conductor. |
| Band | `10` | Band/Orchestra. |
| Composer | `11` | Composer/music author. |
| Lyricist | `12` | Lyricist/text writer. |
| RecordingLocation | `13` | Recording Location. |
| DuringRecording | `14` | During recording. |
| DuringPerformance | `15` | During performance. |
| VideoScreenCapture | `16` | Movie/video screen capture. |
| BrightColouredFish | `17` | A bright coloured fish. |
| Illustration | `18` | Illustration. |
| ArtistLogo | `19` | Band/artist logotype. |
| StudioLogo | `20` | Publisher/Studio logotype. |

### ID3V2CommentFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe.md

#### ID3V2CommentFrame class

Represents a COMM frame in an `ID3V2Tag`.

```csharp
public sealed class ID3V2CommentFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2CommentFrame(ID3V2EncodingType, string, string, string) | Initializes a new instance of the `ID3V2CommentFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| CommentEncoding { get; } | Gets the encoding of the comment. |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language of the comment (3 characters). |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ShortContentDescription { get; } | Gets the short content description. |
| Text { get; } | Gets the text of the comment. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Remarks

This frame is intended for any kind of full text information that does not fit in any other frame.

### CommentEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe/commentencoding.md

#### ID3V2CommentFrame.CommentEncoding property

Gets the encoding of the comment.

```csharp
public ID3V2EncodingType CommentEncoding { get; }
```

##### Property Value

The encoding of the comment.

### ID3V2CommentFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe/id3v2commentframe.md

#### ID3V2CommentFrame constructor

Initializes a new instance of the `ID3V2CommentFrame` class.

```csharp
public ID3V2CommentFrame(ID3V2EncodingType encoding, string language, string description, 
    string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the comment. |
| language | String | The language of the comment. |
| description | String | A short content description. |
| text | String | The text of the comment. |

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe/language.md

#### ID3V2CommentFrame.Language property

Gets the language of the comment (3 characters).

```csharp
public string Language { get; }
```

##### Property Value

The language of the comment.

### ShortContentDescription
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe/shortcontentdescription.md

#### ID3V2CommentFrame.ShortContentDescription property

Gets the short content description.

```csharp
public string ShortContentDescription { get; }
```

##### Property Value

The short content description.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2commentframe/text.md

#### ID3V2CommentFrame.Text property

Gets the text of the comment.

```csharp
public string Text { get; }
```

##### Property Value

The text of the comment.

### ID3V2EncodingType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2encodingtype.md

#### ID3V2EncodingType enumeration

Defines different types of text encoding used in ID3v2.

```csharp
public enum ID3V2EncodingType : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Iso88591 | `0` | The ISO-8859-1 encoding. |
| Utf16 | `1` | The UTF-16 encoding with BOM. |
| Utf16Be | `2` | The UTF-16 encoding without BOM. |
| Utf8 | `3` | The UTF-8 encoding. |

### ID3V2MlltFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2mlltframe.md

#### ID3V2MlltFrame class

Represents an MLLT frame in an `ID3V2Tag`.

```csharp
public sealed class ID3V2MlltFrame : ID3V2TagFrame
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ID3V2PlayCounterFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2playcounterframe.md

#### ID3V2PlayCounterFrame class

Represents a PCNT frame in an `ID3V2Tag`. This is simply a counter of the number of times a file has been played.

```csharp
public sealed class ID3V2PlayCounterFrame : ID3V2TagFrame
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the number of times the file has been played. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2playcounterframe/value.md

#### ID3V2PlayCounterFrame.Value property

Gets the number of times the file has been played.

```csharp
public ulong Value { get; }
```

##### Property Value

The number of times the file has been played.

### ID3V2PrivateFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2privateframe.md

#### ID3V2PrivateFrame class

Represents a PRIV frame in an `ID3V2Tag`. The frame is used to contain information from a software producer that its program uses and does not fit into the other frames.

```csharp
public sealed class ID3V2PrivateFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2PrivateFrame(string, byte[]) | Initializes a new instance of the `ID3V2PrivateFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| BinaryData { get; } | Gets the binary data. |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| OwnerIdentifier { get; } | Gets the owner identifier. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BinaryData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2privateframe/binarydata.md

#### ID3V2PrivateFrame.BinaryData property

Gets the binary data.

```csharp
public byte[] BinaryData { get; }
```

##### Property Value

The binary data.

### ID3V2PrivateFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2privateframe/id3v2privateframe.md

#### ID3V2PrivateFrame constructor

Initializes a new instance of the `ID3V2PrivateFrame` class.

```csharp
public ID3V2PrivateFrame(string ownerIdentifier, byte[] data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ownerIdentifier | String | The owner identifier. |
| data | Byte[] | Frame binary data. |

### OwnerIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2privateframe/owneridentifier.md

#### ID3V2PrivateFrame.OwnerIdentifier property

Gets the owner identifier.

```csharp
public string OwnerIdentifier { get; }
```

##### Property Value

The owner identifier.

### ID3V2Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag.md

#### ID3V2Tag class

Represents an ID3v2 tag. Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v2](https://en.wikipedia.org/wiki/ID3#ID3v2).

```csharp
public sealed class ID3V2Tag : ID3Tag
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2Tag() | Initializes a new instance of the `ID3V2Tag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Album { get; set; } | Gets or sets the Album/Movie/Show title. This value is represented by the TALB frame. |
| Artist { get; set; } | Gets or sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame. |
| AttachedPictures { get; set; } | Gets or sets the attached pictures directly related to the audio file. This value is represented by the APIC frame. |
| Band { get; set; } | Gets or sets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame. |
| BitsPerMinute { get; set; } | Gets or sets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame. |
| Comments { get; set; } | Gets or sets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame. |
| Composers { get; set; } | Gets or sets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame. |
| ContentType { get; set; } | Gets or sets the content type. This value is represented by the TCON frame. |
| Copyright { get; set; } | Gets or sets the copyright message. This value is represented by the TCOP frame. |
| Count { get; } | Gets the number of metadata properties. |
| Date { get; set; } | Gets or sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame. |
| EncodedBy { get; set; } | Gets or sets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame. |
| Isrc { get; set; } | Gets or sets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LengthInMilliseconds { get; set; } | Gets or sets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame. |
| MetadataType { get; } | Gets the metadata type. |
| MusicalKey { get; set; } | Gets or sets the musical key in which the sound starts. This value is represented by the TKEY frame. |
| OriginalAlbum { get; set; } | Gets or sets the original album/movie/show title. This value is represented by the TOAL frame. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publisher { get; set; } | Gets or sets the name of the label or publisher. This value is represented by the TPUB frame. |
| SizeInBytes { get; set; } | Gets or sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame. |
| SoftwareHardware { get; set; } | Gets or sets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame. |
| Subtitle { get; set; } | Gets or sets the Subtitle/Description refinement. This value is represented by the TIT3 frame. |
| TagSize { get; } | Gets the size of the tag. |
| Time { get; set; } | Gets or sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame. |
| Title { get; set; } | Gets or sets the Title/Song name/Content description. This value is represented by the TIT2 frame. |
| TrackNumber { get; set; } | Gets or sets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame. |
| TrackPlayCounter { get; } | Gets the number of times the file has been played. This value is represented by the PCNT frame. |
| override Version { get; } | Gets the ID3 version. |
| Year { get; set; } | Gets or sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame. |

#### Methods

| Name | Description |
| --- | --- |
| Add(ID3V2TagFrame) | Adds a frame to the tag. |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear(string) | Removes all frames with the specified id. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| Get(string) | Gets an array of frames with the specified id. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(ID3V2TagFrame) | Removes the specified frame from the tag. |
| RemoveAttachedPictures() | Removes all attached pictures stored in APIC frames. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(ID3V2TagFrame) | Removes all frames having the same id as the specified one and adds the new frame to the tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to read the ID3v2 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V2))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ID3V2 != null)
    {
        Console.WriteLine(root.ID3V2.Album);
        Console.WriteLine(root.ID3V2.Artist);
        Console.WriteLine(root.ID3V2.Band);
        Console.WriteLine(root.ID3V2.Title);
        Console.WriteLine(root.ID3V2.Composers);
        Console.WriteLine(root.ID3V2.Copyright);
        Console.WriteLine(root.ID3V2.Publisher);
        Console.WriteLine(root.ID3V2.OriginalAlbum);
        Console.WriteLine(root.ID3V2.MusicalKey);

        if (root.ID3V2.AttachedPictures != null)
        {
            foreach (var attachedPicture in root.ID3V2.AttachedPictures)
            {
                Console.WriteLine(attachedPicture.AttachedPictureType);
                Console.WriteLine(attachedPicture.MimeType);
                Console.WriteLine(attachedPicture.Description);

                // ...
            }
        }

        // ...
    }
}
```

### Add
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/add.md

#### ID3V2Tag.Add method

Adds a frame to the tag.

```csharp
public void Add(ID3V2TagFrame frame)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be added to the tag. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | The provided frame is incompatible with the existing frames of the same kind. |

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/album.md

#### ID3V2Tag.Album property

Gets or sets the Album/Movie/Show title. This value is represented by the TALB frame.

```csharp
public string Album { get; set; }
```

##### Property Value

The Album/Movie/Show title.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/artist.md

#### ID3V2Tag.Artist property

Gets or sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame.

```csharp
public string Artist { get; set; }
```

##### Property Value

The Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.

### AttachedPictures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/attachedpictures.md

#### ID3V2Tag.AttachedPictures property

Gets or sets the attached pictures directly related to the audio file. This value is represented by the APIC frame.

```csharp
public ID3V2AttachedPictureFrame[] AttachedPictures { get; set; }
```

##### Property Value

The attached pictures directly related to the audio file.

### Band
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/band.md

#### ID3V2Tag.Band property

Gets or sets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame.

```csharp
public string Band { get; set; }
```

##### Property Value

The Band/Orchestra/Accompaniment.

### BitsPerMinute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/bitsperminute.md

#### ID3V2Tag.BitsPerMinute property

Gets or sets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame.

```csharp
public string BitsPerMinute { get; set; }
```

##### Property Value

The number of beats per minute in the main part of the audio.

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/clear.md

#### ID3V2Tag.Clear method

Removes all frames with the specified id.

```csharp
public void Clear(string frameId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameId | String | The id of the frames to remove. |

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/comments.md

#### ID3V2Tag.Comments property

Gets or sets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame.

```csharp
public ID3V2CommentFrame[] Comments { get; set; }
```

##### Property Value

The user comments.

### Composers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/composers.md

#### ID3V2Tag.Composers property

Gets or sets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame.

```csharp
public string Composers { get; set; }
```

##### Property Value

The composers. The names are separated with the "/" character.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/contenttype.md

#### ID3V2Tag.ContentType property

Gets or sets the content type. This value is represented by the TCON frame.

```csharp
public string ContentType { get; set; }
```

##### Property Value

The content type.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/copyright.md

#### ID3V2Tag.Copyright property

Gets or sets the copyright message. This value is represented by the TCOP frame.

```csharp
public string Copyright { get; set; }
```

##### Property Value

The copyright message.

##### Remarks

Every time this field is displayed the field must be preceded with "Copyright © ".

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/date.md

#### ID3V2Tag.Date property

Gets or sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame.

```csharp
public string Date { get; set; }
```

##### Property Value

A numeric string in the DDMM format containing the date for the recording.

### EncodedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/encodedby.md

#### ID3V2Tag.EncodedBy property

Gets or sets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame.

```csharp
public string EncodedBy { get; set; }
```

##### Property Value

The name of the person or organization that encoded the audio file.

### Get
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/get.md

#### ID3V2Tag.Get method

Gets an array of frames with the specified id.

```csharp
public ID3V2TagFrame[] Get(string frameId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameId | String | The id of the frames to get. |

##### Return Value

An array of frames with the specified id.

### ID3V2Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/id3v2tag.md

#### ID3V2Tag constructor

Initializes a new instance of the `ID3V2Tag` class.

```csharp
public ID3V2Tag()
```

### Isrc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/isrc.md

#### ID3V2Tag.Isrc property

Gets or sets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame.

```csharp
public string Isrc { get; set; }
```

##### Property Value

The International Standard Recording Code (ISRC) (12 characters).

### LengthInMilliseconds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/lengthinmilliseconds.md

#### ID3V2Tag.LengthInMilliseconds property

Gets or sets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame.

```csharp
public string LengthInMilliseconds { get; set; }
```

##### Property Value

The length of the audio file in milliseconds, represented as a numeric string.

### MusicalKey
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/musicalkey.md

#### ID3V2Tag.MusicalKey property

Gets or sets the musical key in which the sound starts. This value is represented by the TKEY frame.

```csharp
public string MusicalKey { get; set; }
```

##### Property Value

The musical key in which the sound starts.

### OriginalAlbum
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/originalalbum.md

#### ID3V2Tag.OriginalAlbum property

Gets or sets the original album/movie/show title. This value is represented by the TOAL frame.

```csharp
public string OriginalAlbum { get; set; }
```

##### Property Value

The original album/movie/show title.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/publisher.md

#### ID3V2Tag.Publisher property

Gets or sets the name of the label or publisher. This value is represented by the TPUB frame.

```csharp
public string Publisher { get; set; }
```

##### Property Value

The name of the label or publisher.

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/remove.md

#### ID3V2Tag.Remove method

Removes the specified frame from the tag.

```csharp
public void Remove(ID3V2TagFrame frame)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be removed from the tag. |

### RemoveAttachedPictures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/removeattachedpictures.md

#### ID3V2Tag.RemoveAttachedPictures method

Removes all attached pictures stored in APIC frames.

```csharp
public void RemoveAttachedPictures()
```

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/set.md

#### ID3V2Tag.Set method

Removes all frames having the same id as the specified one and adds the new frame to the tag.

```csharp
public void Set(ID3V2TagFrame frame)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to replace all frames of its kind with. |

### SizeInBytes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/sizeinbytes.md

#### ID3V2Tag.SizeInBytes property

Gets or sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame.

```csharp
public string SizeInBytes { get; set; }
```

##### Property Value

The size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.

### SoftwareHardware
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/softwarehardware.md

#### ID3V2Tag.SoftwareHardware property

Gets or sets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame.

```csharp
public string SoftwareHardware { get; set; }
```

##### Property Value

The used audio encoder and its settings when the file was encoded.

### Subtitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/subtitle.md

#### ID3V2Tag.Subtitle property

Gets or sets the Subtitle/Description refinement. This value is represented by the TIT3 frame.

```csharp
public string Subtitle { get; set; }
```

##### Property Value

The Subtitle/Description refinement.

### TagSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/tagsize.md

#### ID3V2Tag.TagSize property

Gets the size of the tag.

```csharp
public int TagSize { get; }
```

##### Property Value

The size of the tag.

### Time
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/time.md

#### ID3V2Tag.Time property

Gets or sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame.

```csharp
public string Time { get; set; }
```

##### Property Value

A numeric string in the HHMM format containing the time for the recording.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/title.md

#### ID3V2Tag.Title property

Gets or sets the Title/Song name/Content description. This value is represented by the TIT2 frame.

```csharp
public string Title { get; set; }
```

##### Property Value

The Title/Song name/Content description.

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/tolist.md

#### ID3V2Tag.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<ID3V2TagFrame> ToList()
```

##### Return Value

A list of all frames contained in the ID3v2 tag.

### TrackNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/tracknumber.md

#### ID3V2Tag.TrackNumber property

Gets or sets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame.

```csharp
public string TrackNumber { get; set; }
```

##### Property Value

A numeric string containing the order number of the audio-file on its original recording

### TrackPlayCounter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/trackplaycounter.md

#### ID3V2Tag.TrackPlayCounter property

Gets the number of times the file has been played. This value is represented by the PCNT frame.

```csharp
public ulong? TrackPlayCounter { get; }
```

##### Property Value

The number of times a file has been played.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/version.md

#### ID3V2Tag.Version property

Gets the ID3 version.

```csharp
public override string Version { get; }
```

##### Property Value

The ID3 version.

### Year
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tag/year.md

#### ID3V2Tag.Year property

Gets or sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame.

```csharp
public string Year { get; set; }
```

##### Property Value

A numeric string with a year of the recording. This frames is always four characters long (until the year 10000).

### ID3V2TagFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframe.md

#### ID3V2TagFrame class

Represents a generic frame in an `ID3V2Tag`.

```csharp
public class ID3V2TagFrame : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2TagFrame(string, byte[]) | Initializes a new instance of the `ID3V2TagFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Data
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframe/data.md

#### ID3V2TagFrame.Data property

Gets the frame data.

```csharp
public byte[] Data { get; }
```

##### Property Value

The frame data.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframe/flags.md

#### ID3V2TagFrame.Flags property

Gets the frame flags.

```csharp
public ID3V2TagFrameFlags Flags { get; }
```

##### Property Value

The frame flags.

### Id
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframe/id.md

#### ID3V2TagFrame.Id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).

```csharp
public string Id { get; }
```

##### Property Value

The id of the frame (four characters matching the pattern [A-Z0-9]).

### ID3V2TagFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframe/id3v2tagframe.md

#### ID3V2TagFrame constructor

Initializes a new instance of the `ID3V2TagFrame` class.

```csharp
public ID3V2TagFrame(string frameId, byte[] data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameId | String | The id of the frame (four characters matching the pattern [A-Z0-9]). |
| data | Byte[] | The content of the frame. |

### ID3V2TagFrameFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags.md

#### ID3V2TagFrameFlags class

Represents flags used in a ID3v2 tag frame.

```csharp
public sealed class ID3V2TagFrameFlags : IEquatable<ID3V2TagFrameFlags>
```

#### Properties

| Name | Description |
| --- | --- |
| Compression { get; } | Gets a value indicating whether the frame is compressed. |
| DataLengthIndicator { get; } | Gets a value indicating whether a data length indicator has been added to the frame. The data length indicator is the value one would write as the 'Frame length' if all of the frame format flags were zeroed, represented as a 32 bit synchsafe integer. |
| Encryption { get; } | Gets a value indicating whether the frame is encrypted. If set one byte indicating with which method it was encrypted will be appended to the frame header. |
| FileAlterPreservation { get; } | Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data. |
| GroupingIdentity { get; } | Gets a value indicating whether the frame belongs to a group of frames. If set a group identifier byte is added to the frame header. Every frame with the same group identifier belongs to the same group. |
| ReadOnly { get; } | Gets the tag that tells the software that the contents of this frame is intended to be read-only. |
| TagAlterPreservation { get; } | Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames. |
| Unsynchronisation { get; } | Gets a value indicating whether unsynchronisation was applied to this frame. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(ID3V2TagFrameFlags) | Indicates whether the current object is equal to another object of the same type. |
| override Equals(object) | Determines whether the specified object is equal to this instance. |
| override GetHashCode() | Returns a hash code for this instance. |

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/compression.md

#### ID3V2TagFrameFlags.Compression property

Gets a value indicating whether the frame is compressed.

```csharp
public bool Compression { get; }
```

##### Property Value

`true`, if the frame is compressed; otherwise, false.

### DataLengthIndicator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/datalengthindicator.md

#### ID3V2TagFrameFlags.DataLengthIndicator property

Gets a value indicating whether a data length indicator has been added to the frame. The data length indicator is the value one would write as the 'Frame length' if all of the frame format flags were zeroed, represented as a 32 bit synchsafe integer.

```csharp
public bool DataLengthIndicator { get; }
```

##### Property Value

`true`, if a data length indicator has been added to the frame; otherwise, false.

### Encryption
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/encryption.md

#### ID3V2TagFrameFlags.Encryption property

Gets a value indicating whether the frame is encrypted. If set one byte indicating with which method it was encrypted will be appended to the frame header.

```csharp
public bool Encryption { get; }
```

##### Property Value

`true`, if the frame is encrypted; otherwise, false.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/equals.md

#### Equals(ID3V2TagFrameFlags)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(ID3V2TagFrameFlags other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | ID3V2TagFrameFlags | An object to compare with this object. |

##### Return Value

true if the current object is equal to the *other* parameter; otherwise, false.

#### Equals(object)

Determines whether the specified object is equal to this instance.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The Object to compare with this instance. |

##### Return Value

`true` if the specified Object is equal to this instance; otherwise, `false`.

### FileAlterPreservation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/filealterpreservation.md

#### ID3V2TagFrameFlags.FileAlterPreservation property

Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data.

```csharp
public bool FileAlterPreservation { get; }
```

##### Property Value

Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/gethashcode.md

#### ID3V2TagFrameFlags.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### GroupingIdentity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/groupingidentity.md

#### ID3V2TagFrameFlags.GroupingIdentity property

Gets a value indicating whether the frame belongs to a group of frames. If set a group identifier byte is added to the frame header. Every frame with the same group identifier belongs to the same group.

```csharp
public bool GroupingIdentity { get; }
```

##### Property Value

`true`, if the frame belongs to a group of frames; otherwise, false.

### ReadOnly
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/readonly.md

#### ID3V2TagFrameFlags.ReadOnly property

Gets the tag that tells the software that the contents of this frame is intended to be read-only.

```csharp
public bool ReadOnly { get; }
```

##### Property Value

The tag that tells the software that the contents of this frame is intended to be read-only.

### TagAlterPreservation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/tagalterpreservation.md

#### ID3V2TagFrameFlags.TagAlterPreservation property

Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames.

```csharp
public bool TagAlterPreservation { get; }
```

##### Property Value

The flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way.

### Unsynchronisation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2tagframeflags/unsynchronisation.md

#### ID3V2TagFrameFlags.Unsynchronisation property

Gets a value indicating whether unsynchronisation was applied to this frame.

```csharp
public bool Unsynchronisation { get; }
```

##### Property Value

`true`, if unsynchronisation was applied to this frame; otherwise, false.

### ID3V2TextFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2textframe.md

#### ID3V2TextFrame class

Represents a text frame in an `ID3V2Tag`. Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the `ID3V2UserDefinedFrame` class.

```csharp
public class ID3V2TextFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2TextFrame(string, ID3V2EncodingType, string) | Initializes a new instance of the `ID3V2TextFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the text value. |
| TextEncoding { get; } | Gets the text encoding. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ID3V2TextFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2textframe/id3v2textframe.md

#### ID3V2TextFrame constructor

Initializes a new instance of the `ID3V2TextFrame` class.

```csharp
public ID3V2TextFrame(string id, ID3V2EncodingType encoding, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | The frame id. |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| value | String | The frame value. |

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2textframe/text.md

#### ID3V2TextFrame.Text property

Gets the text value.

```csharp
public string Text { get; }
```

##### Property Value

The text value.

### TextEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2textframe/textencoding.md

#### ID3V2TextFrame.TextEncoding property

Gets the text encoding.

```csharp
public ID3V2EncodingType TextEncoding { get; }
```

##### Property Value

The text encoding.

### ID3V2UrlLinkFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2urllinkframe.md

#### ID3V2UrlLinkFrame class

Represents a URL link frame in an `ID3V2Tag`. Name of the frame always starts with the W character.

```csharp
public sealed class ID3V2UrlLinkFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2UrlLinkFrame(string, string) | Initializes a new instance of the `ID3V2UrlLinkFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Url { get; } | Gets the URL value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ID3V2UrlLinkFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2urllinkframe/id3v2urllinkframe.md

#### ID3V2UrlLinkFrame constructor

Initializes a new instance of the `ID3V2UrlLinkFrame` class.

```csharp
public ID3V2UrlLinkFrame(string id, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | The frame id. |
| url | String | The URL which is the value of the frame. |

### Url
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2urllinkframe/url.md

#### ID3V2UrlLinkFrame.Url property

Gets the URL value.

```csharp
public string Url { get; }
```

##### Property Value

The URL value.

### ID3V2UserDefinedFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedframe.md

#### ID3V2UserDefinedFrame class

Represents a TXXX frame in an `ID3V2Tag`.

```csharp
public sealed class ID3V2UserDefinedFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2UserDefinedFrame(string, string) | Initializes a new instance of the `ID3V2UserDefinedFrame` class. |
| ID3V2UserDefinedFrame(ID3V2EncodingType, string, string) | Initializes a new instance of the `ID3V2UserDefinedFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Description { get; } | Gets the description. |
| Encoding { get; } | Gets the encoding of the frame. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/description.md

#### ID3V2UserDefinedFrame.Description property

Gets the description.

```csharp
public string Description { get; }
```

##### Property Value

The description.

### Encoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/encoding.md

#### ID3V2UserDefinedFrame.Encoding property

Gets the encoding of the frame.

```csharp
public ID3V2EncodingType Encoding { get; }
```

##### Property Value

The encoding of the frame.

### ID3V2UserDefinedFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/id3v2userdefinedframe.md

#### ID3V2UserDefinedFrame(string, string)

Initializes a new instance of the `ID3V2UserDefinedFrame` class.

```csharp
public ID3V2UserDefinedFrame(string description, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | The description. |
| value | String | The value. |

#### ID3V2UserDefinedFrame(ID3V2EncodingType, string, string)

Initializes a new instance of the `ID3V2UserDefinedFrame` class.

```csharp
public ID3V2UserDefinedFrame(ID3V2EncodingType encoding, string description, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | String | The description. |
| value | String | The text value. |

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/value.md

#### ID3V2UserDefinedFrame.Value property

Gets the value.

```csharp
public string Value { get; }
```

##### Property Value

The value.

### ID3V2UserDefinedUrlLinkFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe.md

#### ID3V2UserDefinedUrlLinkFrame class

Represents a WXXX frame in an `ID3V2Tag`.

```csharp
public sealed class ID3V2UserDefinedUrlLinkFrame : ID3V2TagFrame
```

#### Constructors

| Name | Description |
| --- | --- |
| ID3V2UserDefinedUrlLinkFrame(string, string) | Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class. |
| ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType, string, string) | Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the frame data. |
| Description { get; } | Gets the description. |
| Encoding { get; } | Gets the encoding of the frame. |
| Flags { get; } | Gets the frame flags. |
| Id { get; } | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Url { get; } | Gets the URL. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/description.md

#### ID3V2UserDefinedUrlLinkFrame.Description property

Gets the description.

```csharp
public string Description { get; }
```

##### Property Value

The description.

### Encoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/encoding.md

#### ID3V2UserDefinedUrlLinkFrame.Encoding property

Gets the encoding of the frame.

```csharp
public ID3V2EncodingType Encoding { get; }
```

##### Property Value

The encoding of the frame.

### ID3V2UserDefinedUrlLinkFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/id3v2userdefinedurllinkframe.md

#### ID3V2UserDefinedUrlLinkFrame(string, string)

Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class.

```csharp
public ID3V2UserDefinedUrlLinkFrame(string description, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | The description. |
| url | String | The actual value of the frame. |

#### ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType, string, string)

Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class.

```csharp
public ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, string description, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | String | The description. |
| url | String | The actual value of the frame. |

### Url
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/url.md

#### ID3V2UserDefinedUrlLinkFrame.Url property

Gets the URL.

```csharp
public string Url { get; }
```

##### Property Value

The URL.

### LyricsField
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricsfield.md

#### LyricsField class

Represents a `LyricsTag` field.

```csharp
public sealed class LyricsField : MetadataProperty
```

#### Constructors

| Name | Description |
| --- | --- |
| LyricsField(string, string) | Initializes a new instance of the `LyricsField` class. |

#### Properties

| Name | Description |
| --- | --- |
| Data { get; } | Gets the field data. |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| ID { get; } | Gets the id of the field (it's always three characters long). |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| Size { get; } | Gets the string representation of the field size. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### Data
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricsfield/data.md

#### LyricsField.Data property

Gets the field data.

```csharp
public string Data { get; }
```

##### Property Value

The field data.

### ID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricsfield/id.md

#### LyricsField.ID property

Gets the id of the field (it's always three characters long).

```csharp
public string ID { get; }
```

##### Property Value

The id of the field (it's always three characters long).

### LyricsField
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricsfield/lyricsfield.md

#### LyricsField constructor

Initializes a new instance of the `LyricsField` class.

```csharp
public LyricsField(string id, string data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | The three character field id. |
| data | String | The field data. |

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricsfield/size.md

#### LyricsField.Size property

Gets the string representation of the field size.

```csharp
public string Size { get; }
```

##### Property Value

The string representation of the field size.

### LyricsTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag.md

#### LyricsTag class

Represents Lyrics3 v2.00 metadata. Please find more information at http://id3.org/Lyrics3v2.

```csharp
public sealed class LyricsTag : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| LyricsTag() | Initializes a new instance of the `LyricsTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| AdditionalInfo { get; set; } | Gets or sets the additional information. This value is represented by the INF field. |
| Album { get; set; } | Gets or sets the album name. This value is represented by the EAL field. |
| Artist { get; set; } | Gets or sets the artist name. This value is represented by the EAR field. |
| Author { get; set; } | Gets or sets the author. This value is represented by the AUT field. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Lyrics { get; set; } | Gets or sets the lyrics. This value is represented by the LYR field. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Track { get; set; } | Gets or sets the track title. This value is represented by the ETT field. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| Get(string) | Gets the value of the field with the specified id. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes the field with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(LyricsField) | Adds or replaces the specified Lyrics3 field. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Remarks

Lyrics3 v2.00 uses fields to represent information. The data in a field can consist of ASCII characters in the range 01 to 254 according to the standard. As the ASCII character map is only defined from 00 to 128 ISO-8859-1 might be assumed. Numerical fields are 5 or 6 characters long, depending on location, and are padded with zeroes.

##### Examples

This code sample shows how to read the Lyrics tag from an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithLyrics))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.Lyrics3V2 != null)
    {
        Console.WriteLine(root.Lyrics3V2.Lyrics);
        Console.WriteLine(root.Lyrics3V2.Album);
        Console.WriteLine(root.Lyrics3V2.Artist);
        Console.WriteLine(root.Lyrics3V2.Track);

        // ...

        // Alternatively, you can loop through a full list of tag fields
        foreach (var field in root.Lyrics3V2.ToList())
        {
            Console.WriteLine("{0} = {1}", field.ID, field.Data);
        }
    }
}
```

### AdditionalInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/additionalinfo.md

#### LyricsTag.AdditionalInfo property

Gets or sets the additional information. This value is represented by the INF field.

```csharp
public string AdditionalInfo { get; set; }
```

##### Property Value

The additional information.

##### Remarks

This is always three (3) characters long in v2.00, but might be longer in a future standard. The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise. The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no. The third character inhibits tracks for random selection - "1" if inhibited and "0" if not.

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/album.md

#### LyricsTag.Album property

Gets or sets the album name. This value is represented by the EAL field.

```csharp
public string Album { get; set; }
```

##### Property Value

The album.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/artist.md

#### LyricsTag.Artist property

Gets or sets the artist name. This value is represented by the EAR field.

```csharp
public string Artist { get; set; }
```

##### Property Value

The artist.

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/author.md

#### LyricsTag.Author property

Gets or sets the author. This value is represented by the AUT field.

```csharp
public string Author { get; set; }
```

##### Property Value

The author.

### Get
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/get.md

#### LyricsTag.Get method

Gets the value of the field with the specified id.

```csharp
public string Get(string id)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | The id of the field. |

##### Return Value

The value if the tag contains a field with the specified id; otherwise, null.

### Lyrics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/lyrics.md

#### LyricsTag.Lyrics property

Gets or sets the lyrics. This value is represented by the LYR field.

```csharp
public string Lyrics { get; set; }
```

##### Property Value

The lyrics.

### LyricsTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/lyricstag.md

#### LyricsTag constructor

Initializes a new instance of the `LyricsTag` class.

```csharp
public LyricsTag()
```

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/remove.md

#### LyricsTag.Remove method

Removes the field with the specified id.

```csharp
public void Remove(string id)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | The field identifier. |

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/set.md

#### LyricsTag.Set method

Adds or replaces the specified Lyrics3 field.

```csharp
public void Set(LyricsField field)
```

| Parameter | Type | Description |
| --- | --- | --- |
| field | LyricsField | The field to be set. |

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/tolist.md

#### LyricsTag.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<LyricsField> ToList()
```

##### Return Value

A list of all fields contained in the Lyrics3 tag.

### Track
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/lyricstag/track.md

#### LyricsTag.Track property

Gets or sets the track title. This value is represented by the ETT field.

```csharp
public string Track { get; set; }
```

##### Property Value

The track.

### MP3RootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage.md

#### MP3RootPackage class

Represents the root package allowing working with metadata in an MP3 audio.

```csharp
public class MP3RootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| ApeV2 { get; } | Gets the APE v2 metadata. |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| ID3V1 { get; set; } | Gets or sets the ID3v1 metadata tag. Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1). |
| ID3V2 { get; set; } | Gets or sets the ID3v2 metadata tag. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Lyrics3V2 { get; set; } | Gets or sets the Lyrics3v2 metadata tag. |
| MetadataType { get; } | Gets the metadata type. |
| MpegAudioPackage { get; } | Gets the MPEG audio metadata package. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| RemoveApeV2() | Removes the APEv2 audio tag. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ApeV2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/apev2.md

#### MP3RootPackage.ApeV2 property

Gets the APE v2 metadata.

```csharp
public ApePackage ApeV2 { get; }
```

##### Property Value

The APE v2 metadata.

##### Examples

This example demonstrates how to read the APEv2 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithApe))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ApeV2 != null)
    {
        Console.WriteLine(root.ApeV2.Album);
        Console.WriteLine(root.ApeV2.Title);
        Console.WriteLine(root.ApeV2.Artist);
        Console.WriteLine(root.ApeV2.Composer);
        Console.WriteLine(root.ApeV2.Copyright);
        Console.WriteLine(root.ApeV2.Genre);
        Console.WriteLine(root.ApeV2.Language);

        // ...
    }
}
```

### ID3V1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/id3v1.md

#### MP3RootPackage.ID3V1 property

Gets or sets the ID3v1 metadata tag. Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1).

```csharp
public ID3V1Tag ID3V1 { get; set; }
```

##### Property Value

The ID3v1 metadata tag attached to the audio file.

##### Remarks

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file.

##### Examples

This code sample shows how to update the ID3v1 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V1))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ID3V1 == null)
    {
        root.ID3V1 = new ID3V1Tag();
    }

    root.ID3V1.Album = "test album";
    root.ID3V1.Artist = "test artist";
    root.ID3V1.Title = "test title";
    root.ID3V1.Comment = "test comment";
    root.ID3V1.Year = "2019";

    // ...

    metadata.Save(Constants.OutputMp3);
}
```

### ID3V2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/id3v2.md

#### MP3RootPackage.ID3V2 property

Gets or sets the ID3v2 metadata tag.

```csharp
public ID3V2Tag ID3V2 { get; set; }
```

##### Property Value

The ID3v2 metadata tag attached to the audio file.

##### Examples

The code sample shows how to update the ID3v2 tag in an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V2))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.ID3V2 == null)
    {
        root.ID3V2 = new ID3V2Tag();
    }

    root.ID3V2.Album = "test album";
    root.ID3V2.Artist = "test artist";
    root.ID3V2.Band = "test band";
    root.ID3V2.TrackNumber = "1";
    root.ID3V2.MusicalKey = "C#";
    root.ID3V2.Title = "code sample";
    root.ID3V2.Date = "2019";

    // ...

    metadata.Save(Constants.OutputMp3);
}
```

### Lyrics3V2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/lyrics3v2.md

#### MP3RootPackage.Lyrics3V2 property

Gets or sets the Lyrics3v2 metadata tag.

```csharp
public LyricsTag Lyrics3V2 { get; set; }
```

##### Property Value

The Lyrics3v2 metadata tag.

##### Examples

This example shows how to update the Lyrics tag in an MP3 file

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithLyrics))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    if (root.Lyrics3V2 == null)
    {
        root.Lyrics3V2 = new LyricsTag();
    }

    root.Lyrics3V2.Lyrics = "[00:01]Test lyrics";
    root.Lyrics3V2.Artist = "test artist";
    root.Lyrics3V2.Album = "test album";
    root.Lyrics3V2.Track = "test track";

    // You can add a fully custom field to the tag
    root.Lyrics3V2.Set(new LyricsField("ABC", "custom value"));

    // ...

    metadata.Save(Constants.OutputMp3);
}
```

### MpegAudioPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/mpegaudiopackage.md

#### MP3RootPackage.MpegAudioPackage property

Gets the MPEG audio metadata package.

```csharp
public MpegAudioPackage MpegAudioPackage { get; }
```

##### Property Value

The MPEG audio metadata package.

##### Examples

This example demonstrates how to read MPEG audio metadata from an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V2))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    Console.WriteLine(root.MpegAudioPackage.Bitrate);
    Console.WriteLine(root.MpegAudioPackage.ChannelMode);
    Console.WriteLine(root.MpegAudioPackage.Emphasis);
    Console.WriteLine(root.MpegAudioPackage.Frequency);
    Console.WriteLine(root.MpegAudioPackage.HeaderPosition);
    Console.WriteLine(root.MpegAudioPackage.Layer);

    // ...
}
```

### RemoveApeV2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/removeapev2.md

#### MP3RootPackage.RemoveApeV2 method

Removes the APEv2 audio tag.

```csharp
public void RemoveApeV2()
```

##### Remarks

This feature is not available in trial mode.

##### Examples

This example shows how to remove the APEv2 tag from an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithApe))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    root.RemoveApeV2();

    metadata.Save(Constants.OutputMp3);
}
```

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/sanitize.md

#### MP3RootPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/mp3rootpackage/xmppackage.md

#### MP3RootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

### WavPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage.md

#### WavPackage class

Represents a native metadata package in a WAV audio file.

```csharp
public sealed class WavPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| WavPackage() | Initializes a new instance of the `WavPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AudioFormat { get; } | Gets the audio format. PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression. |
| BitsPerSample { get; } | Gets the bits per sample value. |
| BlockAlign { get; } | Gets the block align. |
| ByteRate { get; } | Gets the byte rate. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NumberOfChannels { get; } | Gets the number of channels. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SampleRate { get; } | Gets the sample rate. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract technical audio information from a WAV file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputWav))
{
    var root = metadata.GetRootPackage<WavRootPackage>();
    if (root.WavPackage != null)
    {
        Console.WriteLine(root.WavPackage.AudioFormat);
        Console.WriteLine(root.WavPackage.BitsPerSample);
        Console.WriteLine(root.WavPackage.BlockAlign);
        Console.WriteLine(root.WavPackage.ByteRate);
        Console.WriteLine(root.WavPackage.NumberOfChannels);
        Console.WriteLine(root.WavPackage.SampleRate);
    }
}
```

### AudioFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/audioformat.md

#### WavPackage.AudioFormat property

Gets the audio format. PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression.

```csharp
public int AudioFormat { get; }
```

##### Property Value

The audio format.

### BitsPerSample
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/bitspersample.md

#### WavPackage.BitsPerSample property

Gets the bits per sample value.

```csharp
public int BitsPerSample { get; }
```

##### Property Value

The bits per sample value.

### BlockAlign
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/blockalign.md

#### WavPackage.BlockAlign property

Gets the block align.

```csharp
public int BlockAlign { get; }
```

##### Property Value

The block align.

### ByteRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/byterate.md

#### WavPackage.ByteRate property

Gets the byte rate.

```csharp
public int ByteRate { get; }
```

##### Property Value

The byte rate.

### NumberOfChannels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/numberofchannels.md

#### WavPackage.NumberOfChannels property

Gets the number of channels.

```csharp
public int NumberOfChannels { get; }
```

##### Property Value

The number of channels.

### SampleRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/samplerate.md

#### WavPackage.SampleRate property

Gets the sample rate.

```csharp
public int SampleRate { get; }
```

##### Property Value

The sample rate.

### WavPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavpackage/wavpackage.md

#### WavPackage constructor

Initializes a new instance of the `WavPackage` class.

```csharp
public WavPackage()
```

### WavRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavrootpackage.md

#### WavRootPackage class

Represents the root package allowing working with metadata in a WAV audio.

```csharp
public class WavRootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RiffInfoPackage { get; } | Gets the package containing RIFF Info tags. |
| WavPackage { get; } | Gets the WAV native metadata package. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract technical audio information from a WAV file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputWav))
{
    var root = metadata.GetRootPackage<WavRootPackage>();
    if (root.WavPackage != null)
    {
        Console.WriteLine(root.WavPackage.AudioFormat);
        Console.WriteLine(root.WavPackage.BitsPerSample);
        Console.WriteLine(root.WavPackage.BlockAlign);
        Console.WriteLine(root.WavPackage.ByteRate);
        Console.WriteLine(root.WavPackage.NumberOfChannels);
        Console.WriteLine(root.WavPackage.SampleRate);
    }
}
```

### RiffInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavrootpackage/riffinfopackage.md

#### WavRootPackage.RiffInfoPackage property

Gets the package containing RIFF Info tags.

```csharp
public RiffInfoPackage RiffInfoPackage { get; }
```

##### Property Value

The package containing RIFF Info tags.

### WavPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavrootpackage/wavpackage.md

#### WavRootPackage.WavPackage property

Gets the WAV native metadata package.

```csharp
public WavPackage WavPackage { get; }
```

##### Property Value

The WAV native metadata package.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.audio/wavrootpackage/xmppackage.md

#### WavRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.WavWithXmp))
{
    var root = metadata.GetRootPackage<WavRootPackage>();
    if (root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### GroupDocs.Metadata.Formats.BusinessCard
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard.md

The namespace contains classes intended to work with electronic business card formats.

#### Classes

| Class | Description |
| --- | --- |
| VCardAgentRecord | Represents vCard Agent record metadata class. |
| VCardBasePackage | Represents the base VCard metadata class. |
| VCardBinaryRecord | Represents vCard binary record metadata class. |
| VCardCalendarRecordset | Represents a set of Calendar vCard records. |
| VCardCard | Represents a single card extracted from a VCard file. |
| VCardCommunicationRecordset | Represents a set of Communication vCard records. These properties describe information about how to communicate with the object the vCard represents. |
| VCardCustomRecord | Represents vCard custom record metadata class. |
| VCardDateTimeRecord | Represents vCard date time record metadata class. |
| VCardDeliveryAddressingRecordset | Represents a set of Delivery Addressing vCard records. These types are concerned with information related to the delivery addressing or label for the vCard object. |
| VCardExplanatoryRecordset | Represents a set of Explanatory vCard records. These properties are concerned with additional explanations, such as that related to informational notes or revisions specific to the vCard. |
| VCardGeneralRecordset | Represents a set of General vCard records. |
| VCardGeographicalRecordset | Represents a set of Geographical vCard records. These properties are concerned with information associated with geographical positions or regions associated with the object the vCard represents. |
| VCardIdentificationRecordset | Represents a set of Identification vCard records. These types are used to capture information associated with the identification and naming of the entity associated with the vCard. |
| VCardOrganizationalRecordset | Represents a set of Organizational vCard records. These properties are concerned with information associated with characteristics of the organization or organizational units of the object that the vCard represents. |
| VCardPackage | Represents VCF (Virtual Contact File) electronic business card format metadata. |
| VCardRecord | Represents abstract vCard record metadata class. |
| VCardRecordset | Provides a base vCard record union class. |
| VCardRootPackage | Represents the root package allowing working with metadata in a VCard file. |
| VCardSecurityRecordset | Represents a set of Security vCard records. These properties are concerned with the security of communication pathways or access to the vCard. |
| VCardTextRecord | Represents vCard text record metadata class. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| VCardContentType | Defines vCard record content types. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### VCardAgentRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardagentrecord.md

#### VCardAgentRecord class

Represents vCard Agent record metadata class.

```csharp
public class VCardAgentRecord : VCardRecord
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| override ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| Value { get; } | Gets the record value. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardagentrecord/contenttype.md

#### VCardAgentRecord.ContentType property

Gets the content type of record.

```csharp
public override VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardagentrecord/value.md

#### VCardAgentRecord.Value property

Gets the record value.

```csharp
public VCardCard Value { get; }
```

##### Property Value

The record value.

### VCardBasePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardbasepackage.md

#### VCardBasePackage class

Represents the base VCard metadata class.

```csharp
public abstract class VCardBasePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### VCardBinaryRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord.md

#### VCardBinaryRecord class

Represents vCard binary record metadata class.

```csharp
public class VCardBinaryRecord : VCardRecord
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| override ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| Value { get; } | Gets the record value. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/contenttype.md

#### VCardBinaryRecord.ContentType property

Gets the content type of record.

```csharp
public override VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/value.md

#### VCardBinaryRecord.Value property

Gets the record value.

```csharp
public byte[] Value { get; }
```

##### Property Value

The record value.

### VCardCalendarRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset.md

#### VCardCalendarRecordset class

Represents a set of Calendar vCard records.

```csharp
public class VCardCalendarRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| BusyTimeEntries { get; } | Gets the URIs for the busy time associated with the object. |
| BusyTimeRecords { get; } | Gets the URIs for the busy time associated with the object. |
| CalendarAddresses { get; } | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| CalendarAddressRecords { get; } | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| CalendarUriRecords { get; } | Gets the URIs for the calendar associated with the object represented by the vCard. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| UriCalendarEntries { get; } | Gets the URIs for the calendar associated with the object represented by the vCard. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BusyTimeEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/busytimeentries.md

#### VCardCalendarRecordset.BusyTimeEntries property

Gets the URIs for the busy time associated with the object.

```csharp
public string[] BusyTimeEntries { get; }
```

##### Property Value

The URIs for the busy time associated with the object.

##### Remarks

This property is a simplified version of `BusyTimeRecords`.

### BusyTimeRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/busytimerecords.md

#### VCardCalendarRecordset.BusyTimeRecords property

Gets the URIs for the busy time associated with the object.

```csharp
public VCardTextRecord[] BusyTimeRecords { get; }
```

##### Property Value

The URIs for the busy time associated with the object.

### CalendarAddresses
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendaraddresses.md

#### VCardCalendarRecordset.CalendarAddresses property

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

```csharp
public string[] CalendarAddresses { get; }
```

##### Property Value

The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

##### Remarks

This property is a simplified version of `CalendarAddressRecords`.

### CalendarAddressRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendaraddressrecords.md

#### VCardCalendarRecordset.CalendarAddressRecords property

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

```csharp
public VCardTextRecord[] CalendarAddressRecords { get; }
```

##### Property Value

The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

### CalendarUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendarurirecords.md

#### VCardCalendarRecordset.CalendarUriRecords property

Gets the URIs for the calendar associated with the object represented by the vCard.

```csharp
public VCardTextRecord[] CalendarUriRecords { get; }
```

##### Property Value

The URIs for the calendar associated with the object represented by the vCard.

### UriCalendarEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/uricalendarentries.md

#### VCardCalendarRecordset.UriCalendarEntries property

Gets the URIs for the calendar associated with the object represented by the vCard.

```csharp
public string[] UriCalendarEntries { get; }
```

##### Property Value

The URIs for the calendar associated with the object represented by the vCard.

##### Remarks

This property is a simplified version of `CalendarUriRecords`.

### VCardCard
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard.md

#### VCardCard class

Represents a single card extracted from a VCard file.

```csharp
public class VCardCard : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| CalendarRecordset { get; } | Gets the calendar records. |
| CommunicationRecordset { get; } | Gets the communication records. |
| Count { get; } | Gets the number of metadata properties. |
| DeliveryAddressingRecordset { get; } | Gets the delivery addressing records. |
| ExplanatoryRecordset { get; } | Gets the explanatory records. |
| ExtensionRecords { get; } | Gets the private extension records. |
| GeneralRecordset { get; } | Gets the general records. |
| GeographicalRecordset { get; } | Gets the geographical records. |
| IdentificationRecordset { get; } | Gets the identification records. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| OrganizationalRecordset { get; } | Gets the organizational records. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SecurityRecordset { get; } | Gets the security records. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| FilterByGroup(string) | Filters all vCard records by the group name passed as a parameter. For more information please see the  method. |
| FilterHomeTags() | Filters all vCard records marked with the HOME tag. |
| FilterPreferred() | Filters the preferred records. |
| FilterWorkTags() | Filters all vCard records marked with the WORK tag. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetAvailableGroups() | Gets the available group names. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to use vCard property filters.

```csharp
public static void Run()
{
    using (Metadata metadata = new Metadata(Constants.InputVcf))
    {
        var root = metadata.GetRootPackage<VCardRootPackage>();

        foreach (var vCard in root.VCardPackage.Cards)
        {
            // Print most preferred work phone numbers and work emails
            var filtered = vCard.FilterWorkTags().FilterPreferred();
            PrintArray(filtered.CommunicationRecordset.Telephones);
            PrintArray(filtered.CommunicationRecordset.Emails);
        }
    }
}

private static void PrintArray(string[] values)
{
    if (values != null)
    {
        foreach (string value in values)
        {
            Console.WriteLine(value);
        }
    }
}
```

### CalendarRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/calendarrecordset.md

#### VCardCard.CalendarRecordset property

Gets the calendar records.

```csharp
public VCardCalendarRecordset CalendarRecordset { get; }
```

##### Property Value

The calendar records.

### CommunicationRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/communicationrecordset.md

#### VCardCard.CommunicationRecordset property

Gets the communication records.

```csharp
public VCardCommunicationRecordset CommunicationRecordset { get; }
```

##### Property Value

The communication records.

### DeliveryAddressingRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/deliveryaddressingrecordset.md

#### VCardCard.DeliveryAddressingRecordset property

Gets the delivery addressing records.

```csharp
public VCardDeliveryAddressingRecordset DeliveryAddressingRecordset { get; }
```

##### Property Value

The delivery addressing records.

### ExplanatoryRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/explanatoryrecordset.md

#### VCardCard.ExplanatoryRecordset property

Gets the explanatory records.

```csharp
public VCardExplanatoryRecordset ExplanatoryRecordset { get; }
```

##### Property Value

The explanatory records.

### ExtensionRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/extensionrecords.md

#### VCardCard.ExtensionRecords property

Gets the private extension records.

```csharp
public VCardTextRecord[] ExtensionRecords { get; }
```

##### Property Value

The private extension records.

### FilterByGroup
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/filterbygroup.md

#### VCardCard.FilterByGroup method

Filters all vCard records by the group name passed as a parameter. For more information please see the  method.

```csharp
public VCardCard FilterByGroup(string groupName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| groupName | String | The name of the group. |

##### Return Value

The filtered vCard instance.

### FilterHomeTags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/filterhometags.md

#### VCardCard.FilterHomeTags method

Filters all vCard records marked with the HOME tag.

```csharp
public VCardCard FilterHomeTags()
```

##### Return Value

The filtered vCard instance.

### FilterPreferred
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/filterpreferred.md

#### VCardCard.FilterPreferred method

Filters the preferred records.

```csharp
public VCardCard FilterPreferred()
```

##### Return Value

The filtered vCard instance.

### FilterWorkTags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/filterworktags.md

#### VCardCard.FilterWorkTags method

Filters all vCard records marked with the WORK tag.

```csharp
public VCardCard FilterWorkTags()
```

##### Return Value

Filtered vCard instance.

### GeneralRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/generalrecordset.md

#### VCardCard.GeneralRecordset property

Gets the general records.

```csharp
public VCardGeneralRecordset GeneralRecordset { get; }
```

##### Property Value

The general records.

### GeographicalRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/geographicalrecordset.md

#### VCardCard.GeographicalRecordset property

Gets the geographical records.

```csharp
public VCardGeographicalRecordset GeographicalRecordset { get; }
```

##### Property Value

The geographical records.

### GetAvailableGroups
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/getavailablegroups.md

#### VCardCard.GetAvailableGroups method

Gets the available group names.

```csharp
public string[] GetAvailableGroups()
```

##### Return Value

The available group names.

### IdentificationRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/identificationrecordset.md

#### VCardCard.IdentificationRecordset property

Gets the identification records.

```csharp
public VCardIdentificationRecordset IdentificationRecordset { get; }
```

##### Property Value

The identification records.

### OrganizationalRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/organizationalrecordset.md

#### VCardCard.OrganizationalRecordset property

Gets the organizational records.

```csharp
public VCardOrganizationalRecordset OrganizationalRecordset { get; }
```

##### Property Value

The organizational records.

### SecurityRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcard/securityrecordset.md

#### VCardCard.SecurityRecordset property

Gets the security records.

```csharp
public VCardSecurityRecordset SecurityRecordset { get; }
```

##### Property Value

The security records.

### VCardCommunicationRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset.md

#### VCardCommunicationRecordset class

Represents a set of Communication vCard records. These properties describe information about how to communicate with the object the vCard represents.

```csharp
public class VCardCommunicationRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| EmailRecords { get; } | Gets the electronic mail addresses for communication with the object. |
| Emails { get; } | Gets the electronic mail addresses for communication with the object. |
| ImppEntries { get; } | Gets the URIs for instant messaging and presence protocol communications with the object. |
| ImppRecords { get; } | Gets the URIs for instant messaging and presence protocol communications with the object. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageRecords { get; } | Gets the languages that may be used for contacting the object. |
| Languages { get; } | Gets the languages that may be used for contacting the object. |
| Mailer { get; } | Gets the type of the electronic mail software that is used by the individual associated with the vCard. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TelephoneRecords { get; } | Gets the telephone numbers for telephony communication with the object. |
| Telephones { get; } | Gets the telephone numbers for telephony communication with the object. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### EmailRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/emailrecords.md

#### VCardCommunicationRecordset.EmailRecords property

Gets the electronic mail addresses for communication with the object.

```csharp
public VCardTextRecord[] EmailRecords { get; }
```

##### Property Value

The electronic mail addresses array for communication with the object.

### Emails
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/emails.md

#### VCardCommunicationRecordset.Emails property

Gets the electronic mail addresses for communication with the object.

```csharp
public string[] Emails { get; }
```

##### Property Value

The electronic mail addresses array for communication with the object.

##### Remarks

This property is a simplified version of `EmailRecords`.

### ImppEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/imppentries.md

#### VCardCommunicationRecordset.ImppEntries property

Gets the URIs for instant messaging and presence protocol communications with the object.

```csharp
public string[] ImppEntries { get; }
```

##### Property Value

The URIs for instant messaging and presence protocol communications with the object.

##### Remarks

This property is a simplified version of `ImppRecords`.

### ImppRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/impprecords.md

#### VCardCommunicationRecordset.ImppRecords property

Gets the URIs for instant messaging and presence protocol communications with the object.

```csharp
public VCardTextRecord[] ImppRecords { get; }
```

##### Property Value

The URIs for instant messaging and presence protocol communications with the object.

### LanguageRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/languagerecords.md

#### VCardCommunicationRecordset.LanguageRecords property

Gets the languages that may be used for contacting the object.

```csharp
public VCardTextRecord[] LanguageRecords { get; }
```

##### Property Value

The languages that may be used for contacting the object.

### Languages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/languages.md

#### VCardCommunicationRecordset.Languages property

Gets the languages that may be used for contacting the object.

```csharp
public string[] Languages { get; }
```

##### Property Value

The languages that may be used for contacting the object.

##### Remarks

This property is a simplified version of `LanguageRecords`.

### Mailer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/mailer.md

#### VCardCommunicationRecordset.Mailer property

Gets the type of the electronic mail software that is used by the individual associated with the vCard.

```csharp
public string Mailer { get; }
```

##### Property Value

The type of the electronic mail software that is used by the individual associated with the vCard

### TelephoneRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/telephonerecords.md

#### VCardCommunicationRecordset.TelephoneRecords property

Gets the telephone numbers for telephony communication with the object.

```csharp
public VCardTextRecord[] TelephoneRecords { get; }
```

##### Property Value

The telephone numbers for telephony communication with the object.

### Telephones
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/telephones.md

#### VCardCommunicationRecordset.Telephones property

Gets the telephone numbers for telephony communication with the object.

```csharp
public string[] Telephones { get; }
```

##### Property Value

The telephone numbers for telephony communication with the object.

##### Remarks

This property is a simplified version of `TelephoneRecords`.

### VCardContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcontenttype.md

#### VCardContentType enumeration

Defines vCard record content types.

```csharp
public enum VCardContentType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Custom | `0` | The custom content type. |
| Text | `1` | The text content type. |
| Binary | `2` | The binary content type. |
| DateTime | `3` | The date time content type. |
| Agent | `4` | The agent content type. |

### VCardCustomRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcustomrecord.md

#### VCardCustomRecord class

Represents vCard custom record metadata class.

```csharp
public class VCardCustomRecord : VCardRecord
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| override ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| Value { get; } | Gets the record value. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/contenttype.md

#### VCardCustomRecord.ContentType property

Gets the content type of record.

```csharp
public override VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/value.md

#### VCardCustomRecord.Value property

Gets the record value.

```csharp
public string Value { get; }
```

##### Property Value

The record value.

### VCardDateTimeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord.md

#### VCardDateTimeRecord class

Represents vCard date time record metadata class.

```csharp
public class VCardDateTimeRecord : VCardRecord
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| override ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| Value { get; } | Gets the record value. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/contenttype.md

#### VCardDateTimeRecord.ContentType property

Gets the content type of record.

```csharp
public override VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/value.md

#### VCardDateTimeRecord.Value property

Gets the record value.

```csharp
public DateTime Value { get; }
```

##### Property Value

The record value.

### VCardDeliveryAddressingRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset.md

#### VCardDeliveryAddressingRecordset class

Represents a set of Delivery Addressing vCard records. These types are concerned with information related to the delivery addressing or label for the vCard object.

```csharp
public class VCardDeliveryAddressingRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| Addresses { get; } | Gets the components of the delivery address of the object. |
| AddressRecords { get; } | Gets the components of the delivery address of the object. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LabelRecords { get; } | Gets an array containing the formatted text corresponding to delivery address of the object. |
| Labels { get; } | Gets an array containing the formatted text corresponding to delivery address of the object. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Addresses
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/addresses.md

#### VCardDeliveryAddressingRecordset.Addresses property

Gets the components of the delivery address of the object.

```csharp
public string[] Addresses { get; }
```

##### Property Value

The components of the delivery address of the object.

##### Remarks

This property is a simplified version of `AddressRecords`.

### AddressRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/addressrecords.md

#### VCardDeliveryAddressingRecordset.AddressRecords property

Gets the components of the delivery address of the object.

```csharp
public VCardTextRecord[] AddressRecords { get; }
```

##### Property Value

The components of the delivery address of the object.

### LabelRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/labelrecords.md

#### VCardDeliveryAddressingRecordset.LabelRecords property

Gets an array containing the formatted text corresponding to delivery address of the object.

```csharp
public VCardTextRecord[] LabelRecords { get; }
```

##### Property Value

An array containing the formatted text corresponding to delivery address of the object.

### Labels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/labels.md

#### VCardDeliveryAddressingRecordset.Labels property

Gets an array containing the formatted text corresponding to delivery address of the object.

```csharp
public string[] Labels { get; }
```

##### Property Value

An array containing the formatted text corresponding to delivery address of the object.

##### Remarks

This property is a simplified version of `LabelRecords`.

### VCardExplanatoryRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset.md

#### VCardExplanatoryRecordset class

Represents a set of Explanatory vCard records. These properties are concerned with additional explanations, such as that related to informational notes or revisions specific to the vCard.

```csharp
public class VCardExplanatoryRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| BinarySounds { get; } | Gets the digital sound content information that annotates some aspects of the vCard. |
| Categories { get; } | Gets the application category information about the vCard, also known as "tags". |
| CategoryRecords { get; } | Gets the application category information about the vCard, also known as "tags". |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NoteRecords { get; } | Gets the supplemental information or comments that are associated with the vCard. |
| Notes { get; } | Gets the supplemental information or comments that are associated with the vCard. |
| PidIdentifierRecords { get; } | Gets the global meaning of the local PID source identifier. |
| PidIdentifiers { get; } | Gets the global meaning of the local PID source identifier. |
| ProductIdentifier { get; } | Gets the identifier of the product that created the vCard object. |
| ProductIdentifierRecord { get; } | Gets the identifier of the product that created the vCard object. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Revision { get; } | Gets the revision information about the current vCard. |
| SortString { get; } | Gets the family name or given name text to be used for national-language-specific sorting of the `FormattedNames` and `Name` types. |
| SoundBinaryRecords { get; } | Gets the digital sound content information that annotates some aspects of the vCard. |
| SoundRecords { get; } | Gets the digital sound content information that annotates some aspects of the vCard. |
| SoundUriRecords { get; } | Gets the digital sound content information that annotates some aspects of the vCard. |
| Uid { get; } | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| UidRecord { get; } | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| UriSounds { get; } | Gets the digital sound content information that annotates some aspects of the vCard. |
| UrlRecords { get; } | Gets an array of URLs pointing to websites that represent the person in some way. |
| Urls { get; } | Gets an array of URLs pointing to websites that represent the person in some way. |
| Version { get; } | Gets the version of the vCard specification. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BinarySounds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/binarysounds.md

#### VCardExplanatoryRecordset.BinarySounds property

Gets the digital sound content information that annotates some aspects of the vCard.

```csharp
public byte[][] BinarySounds { get; }
```

##### Property Value

The digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `SoundBinaryRecords`.

### Categories
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/categories.md

#### VCardExplanatoryRecordset.Categories property

Gets the application category information about the vCard, also known as "tags".

```csharp
public string[] Categories { get; }
```

##### Property Value

The application category information about the vCard, also known as "tags".

##### Remarks

This property is a simplified version of `CategoryRecords`.

### CategoryRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/categoryrecords.md

#### VCardExplanatoryRecordset.CategoryRecords property

Gets the application category information about the vCard, also known as "tags".

```csharp
public VCardTextRecord[] CategoryRecords { get; }
```

##### Property Value

The application category information about the vCard, also known as "tags".

### NoteRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/noterecords.md

#### VCardExplanatoryRecordset.NoteRecords property

Gets the supplemental information or comments that are associated with the vCard.

```csharp
public VCardTextRecord[] NoteRecords { get; }
```

##### Property Value

The supplemental information or comments that are associated with the vCard.

### Notes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/notes.md

#### VCardExplanatoryRecordset.Notes property

Gets the supplemental information or comments that are associated with the vCard.

```csharp
public string[] Notes { get; }
```

##### Property Value

The supplemental information or comments that are associated with the vCard.

##### Remarks

This property is a simplified version of `NoteRecords`.

### PidIdentifierRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/pididentifierrecords.md

#### VCardExplanatoryRecordset.PidIdentifierRecords property

Gets the global meaning of the local PID source identifier.

```csharp
public VCardTextRecord[] PidIdentifierRecords { get; }
```

##### Property Value

The global meaning of the local PID source identifier.

### PidIdentifiers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/pididentifiers.md

#### VCardExplanatoryRecordset.PidIdentifiers property

Gets the global meaning of the local PID source identifier.

```csharp
public string[] PidIdentifiers { get; }
```

##### Property Value

The global meaning of the local PID source identifier.

##### Remarks

This property is a simplified version of `PidIdentifierRecords`.

### ProductIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/productidentifier.md

#### VCardExplanatoryRecordset.ProductIdentifier property

Gets the identifier of the product that created the vCard object.

```csharp
public string ProductIdentifier { get; }
```

##### Property Value

The identifier of the product that created the vCard object

##### Remarks

This property is a simplified version of `ProductIdentifierRecord`.

### ProductIdentifierRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/productidentifierrecord.md

#### VCardExplanatoryRecordset.ProductIdentifierRecord property

Gets the identifier of the product that created the vCard object.

```csharp
public VCardTextRecord ProductIdentifierRecord { get; }
```

##### Property Value

The identifier of the product that created the vCard object

### Revision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/revision.md

#### VCardExplanatoryRecordset.Revision property

Gets the revision information about the current vCard.

```csharp
public DateTime? Revision { get; }
```

##### Property Value

The revision information about the current vCard.

### SortString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sortstring.md

#### VCardExplanatoryRecordset.SortString property

Gets the family name or given name text to be used for national-language-specific sorting of the `FormattedNames` and `Name` types.

```csharp
public string SortString { get; }
```

##### Property Value

The family name or given name text to be used for national-language-specific sorting of the `FormattedNames` and `Name` types.

### SoundBinaryRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/soundbinaryrecords.md

#### VCardExplanatoryRecordset.SoundBinaryRecords property

Gets the digital sound content information that annotates some aspects of the vCard.

```csharp
public VCardBinaryRecord[] SoundBinaryRecords { get; }
```

##### Property Value

The digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `SoundRecords`.

### SoundRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/soundrecords.md

#### VCardExplanatoryRecordset.SoundRecords property

Gets the digital sound content information that annotates some aspects of the vCard.

```csharp
public VCardRecord[] SoundRecords { get; }
```

##### Property Value

The digital sound content information that annotates some aspects of the vCard.

### SoundUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/soundurirecords.md

#### VCardExplanatoryRecordset.SoundUriRecords property

Gets the digital sound content information that annotates some aspects of the vCard.

```csharp
public VCardTextRecord[] SoundUriRecords { get; }
```

##### Property Value

The digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `SoundRecords`.

### Uid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/uid.md

#### VCardExplanatoryRecordset.Uid property

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

```csharp
public string Uid { get; }
```

##### Property Value

The value that represents a globally unique identifier corresponding.

##### Remarks

This property is a simplified version of `UidRecord`.

### UidRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/uidrecord.md

#### VCardExplanatoryRecordset.UidRecord property

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

```csharp
public VCardTextRecord UidRecord { get; }
```

##### Property Value

The value that represents a globally unique identifier corresponding.

### UriSounds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/urisounds.md

#### VCardExplanatoryRecordset.UriSounds property

Gets the digital sound content information that annotates some aspects of the vCard.

```csharp
public string[] UriSounds { get; }
```

##### Property Value

The digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `SoundUriRecords`.

### UrlRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/urlrecords.md

#### VCardExplanatoryRecordset.UrlRecords property

Gets an array of URLs pointing to websites that represent the person in some way.

```csharp
public VCardTextRecord[] UrlRecords { get; }
```

##### Property Value

An array of URLs pointing to websites that represent the person in some way.

### Urls
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/urls.md

#### VCardExplanatoryRecordset.Urls property

Gets an array of URLs pointing to websites that represent the person in some way.

```csharp
public string[] Urls { get; }
```

##### Property Value

An array of URLs pointing to websites that represent the person in some way.

##### Remarks

This property is a simplified version of `UrlRecords`.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/version.md

#### VCardExplanatoryRecordset.Version property

Gets the version of the vCard specification.

```csharp
public string Version { get; }
```

##### Property Value

The version of the vCard specification.

### VCardGeneralRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset.md

#### VCardGeneralRecordset class

Represents a set of General vCard records.

```csharp
public class VCardGeneralRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Kind { get; } | Gets the kind of the object. |
| MetadataType { get; } | Gets the metadata type. |
| NameOfSource { get; } | Gets the textual representation of the SOURCE property. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SourceRecords { get; } | Gets the array of sources of directory information contained in the content type. |
| Sources { get; } | Gets an array containing the sources of the directory information contained in the content type. |
| XmlEntries { get; } | Gets an array containing extended XML-encoded vCard data. |
| XmlRecords { get; } | Gets an array containing extended XML-encoded vCard data. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Kind
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/kind.md

#### VCardGeneralRecordset.Kind property

Gets the kind of the object.

```csharp
public string Kind { get; }
```

##### Property Value

The kind of object.

### NameOfSource
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/nameofsource.md

#### VCardGeneralRecordset.NameOfSource property

Gets the textual representation of the SOURCE property.

```csharp
public string NameOfSource { get; }
```

##### Property Value

The textual representation of the SOURCE property.

### SourceRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/sourcerecords.md

#### VCardGeneralRecordset.SourceRecords property

Gets the array of sources of directory information contained in the content type.

```csharp
public VCardTextRecord[] SourceRecords { get; }
```

##### Property Value

The array of sources of directory information contained in the content type.

### Sources
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/sources.md

#### VCardGeneralRecordset.Sources property

Gets an array containing the sources of the directory information contained in the content type.

```csharp
public string[] Sources { get; }
```

##### Property Value

An array containing the sources of the directory information contained in the content type.

##### Remarks

This property is a simplified version of `SourceRecords`.

### XmlEntries
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/xmlentries.md

#### VCardGeneralRecordset.XmlEntries property

Gets an array containing extended XML-encoded vCard data.

```csharp
public string[] XmlEntries { get; }
```

##### Property Value

An array of extended XML-encoded vCard data.

##### Remarks

This property is a simplified version of `XmlRecords`.

### XmlRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/xmlrecords.md

#### VCardGeneralRecordset.XmlRecords property

Gets an array containing extended XML-encoded vCard data.

```csharp
public VCardTextRecord[] XmlRecords { get; }
```

##### Property Value

An array containing extended XML-encoded vCard data.

### VCardGeographicalRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset.md

#### VCardGeographicalRecordset class

Represents a set of Geographical vCard records. These properties are concerned with information associated with geographical positions or regions associated with the object the vCard represents.

```csharp
public class VCardGeographicalRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| GeographicPositionRecords { get; } | Gets the information related to the global positioning of the object. |
| GeographicPositions { get; } | Gets the information related to the global positioning of the object. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TimeZoneRecords { get; } | Gets the time zones of the object. |
| TimeZones { get; } | Gets the time zones of the object. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### GeographicPositionRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/geographicpositionrecords.md

#### VCardGeographicalRecordset.GeographicPositionRecords property

Gets the information related to the global positioning of the object.

```csharp
public VCardTextRecord[] GeographicPositionRecords { get; }
```

##### Property Value

The information related to the global positioning of the object.

### GeographicPositions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/geographicpositions.md

#### VCardGeographicalRecordset.GeographicPositions property

Gets the information related to the global positioning of the object.

```csharp
public string[] GeographicPositions { get; }
```

##### Property Value

The information related to the global positioning of the object.

##### Remarks

This property is a simplified version of `GeographicPositionRecords`.

### TimeZoneRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/timezonerecords.md

#### VCardGeographicalRecordset.TimeZoneRecords property

Gets the time zones of the object.

```csharp
public VCardTextRecord[] TimeZoneRecords { get; }
```

##### Property Value

The time zones of the object.

### TimeZones
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/timezones.md

#### VCardGeographicalRecordset.TimeZones property

Gets the time zones of the object.

```csharp
public string[] TimeZones { get; }
```

##### Property Value

The time zones of the object.

##### Remarks

This property is a simplified version of `TimeZoneRecords`.

### VCardIdentificationRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset.md

#### VCardIdentificationRecordset class

Represents a set of Identification vCard records. These types are used to capture information associated with the identification and naming of the entity associated with the vCard.

```csharp
public class VCardIdentificationRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| AnniversaryDateTimeRecord { get; } | Gets the date of marriage represented as a single date-and-or-time value. |
| AnniversaryRecord { get; } | Gets the date of marriage, or equivalent, of the object. |
| AnniversaryTextRecord { get; } | Gets the date of marriage represented as a single text value. |
| BinaryPhotos { get; } | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| BirthdateDateTimeRecord { get; } | Gets the birth date of the object. |
| BirthdateRecords { get; } | Gets an array containing the birth date of the object in different representations. |
| BirthdateTextRecords { get; } | Gets an array containing the birth date of the object in different text representations. |
| Count { get; } | Gets the number of metadata properties. |
| DateTimeAnniversary { get; } | Gets the date of marriage represented as a single date-and-or-time value. |
| DateTimeBirthdate { get; } | Gets the birth date of the object. |
| FormattedNameRecords { get; } | Gets an array containing the formatted text corresponding to the name of the object. |
| FormattedNames { get; } | Gets an array containing the formatted text corresponding to the name of the object. |
| Gender { get; } | Gets the components of the sex and gender identity of the object. |
| GenderRecord { get; } | Gets the components of the sex and gender identity of the object. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the components of the name of the object. |
| NameRecord { get; } | Gets the components of the name of the object. |
| NicknameRecords { get; } | Gets an array containing the text corresponding to the nickname of the object. |
| Nicknames { get; } | Gets an array containing the text corresponding to the nickname of the object. |
| PhotoBinaryRecords { get; } | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| PhotoRecords { get; } | Gets an array containing the image or photograph information that annotates some aspects of the object. |
| PhotoUriRecords { get; } | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TextAnniversary { get; } | Gets the date of marriage represented as a single text value. |
| TextBirthdates { get; } | Gets an array containing the birth date of the object in different text representations. |
| UriPhotos { get; } | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AnniversaryDateTimeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversarydatetimerecord.md

#### VCardIdentificationRecordset.AnniversaryDateTimeRecord property

Gets the date of marriage represented as a single date-and-or-time value.

```csharp
public VCardDateTimeRecord AnniversaryDateTimeRecord { get; }
```

##### Property Value

The date of marriage represented as a single date-and-or-time value.

##### Remarks

This property is a simplified version of `AnniversaryRecord`.

### AnniversaryRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversaryrecord.md

#### VCardIdentificationRecordset.AnniversaryRecord property

Gets the date of marriage, or equivalent, of the object.

```csharp
public VCardRecord AnniversaryRecord { get; }
```

##### Property Value

The date of marriage, or equivalent, of the object.

### AnniversaryTextRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversarytextrecord.md

#### VCardIdentificationRecordset.AnniversaryTextRecord property

Gets the date of marriage represented as a single text value.

```csharp
public VCardTextRecord AnniversaryTextRecord { get; }
```

##### Property Value

The date of marriage represented as a single text value.

##### Remarks

This property is a simplified version of `AnniversaryRecord`.

### BinaryPhotos
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/binaryphotos.md

#### VCardIdentificationRecordset.BinaryPhotos property

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

```csharp
public byte[][] BinaryPhotos { get; }
```

##### Property Value

An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `PhotoBinaryRecords`.

### BirthdateDateTimeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdatedatetimerecord.md

#### VCardIdentificationRecordset.BirthdateDateTimeRecord property

Gets the birth date of the object.

```csharp
public VCardDateTimeRecord BirthdateDateTimeRecord { get; }
```

##### Property Value

The birth date of the object.

##### Remarks

This property is a simplified version of `BirthdateRecords`.

### BirthdateRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdaterecords.md

#### VCardIdentificationRecordset.BirthdateRecords property

Gets an array containing the birth date of the object in different representations.

```csharp
public VCardRecord[] BirthdateRecords { get; }
```

##### Property Value

An array containing the birth date of the object in different representations.

### BirthdateTextRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdatetextrecords.md

#### VCardIdentificationRecordset.BirthdateTextRecords property

Gets an array containing the birth date of the object in different text representations.

```csharp
public VCardTextRecord[] BirthdateTextRecords { get; }
```

##### Property Value

An array containing the birth date of the object in different text representations.

##### Remarks

This property is a simplified version of `BirthdateRecords`.

### DateTimeAnniversary
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/datetimeanniversary.md

#### VCardIdentificationRecordset.DateTimeAnniversary property

Gets the date of marriage represented as a single date-and-or-time value.

```csharp
public DateTime? DateTimeAnniversary { get; }
```

##### Property Value

The date of marriage represented as a single date-and-or-time value.

##### Remarks

This property is a simplified version of `AnniversaryDateTimeRecord`.

### DateTimeBirthdate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/datetimebirthdate.md

#### VCardIdentificationRecordset.DateTimeBirthdate property

Gets the birth date of the object.

```csharp
public DateTime? DateTimeBirthdate { get; }
```

##### Property Value

The birth date of the object.

##### Remarks

This property is a simplified version of `BirthdateDateTimeRecord`.

### FormattedNameRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/formattednamerecords.md

#### VCardIdentificationRecordset.FormattedNameRecords property

Gets an array containing the formatted text corresponding to the name of the object.

```csharp
public VCardTextRecord[] FormattedNameRecords { get; }
```

##### Property Value

An array containing the formatted text corresponding to the name of the object.

### FormattedNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/formattednames.md

#### VCardIdentificationRecordset.FormattedNames property

Gets an array containing the formatted text corresponding to the name of the object.

```csharp
public string[] FormattedNames { get; }
```

##### Property Value

An array containing the formatted text corresponding to the name of the object.

##### Remarks

This property is a simplified version of `FormattedNameRecords`.

### Gender
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/gender.md

#### VCardIdentificationRecordset.Gender property

Gets the components of the sex and gender identity of the object.

```csharp
public string Gender { get; }
```

##### Property Value

The components of the sex and gender identity of the object.

##### Remarks

This property is a simplified version of `GenderRecord`.

### GenderRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/genderrecord.md

#### VCardIdentificationRecordset.GenderRecord property

Gets the components of the sex and gender identity of the object.

```csharp
public VCardTextRecord GenderRecord { get; }
```

##### Property Value

The components of the sex and gender identity of the object.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/name.md

#### VCardIdentificationRecordset.Name property

Gets the components of the name of the object.

```csharp
public string Name { get; }
```

##### Property Value

The components of the name of the object.

##### Remarks

This property is a simplified version of `NameRecord`.

### NameRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/namerecord.md

#### VCardIdentificationRecordset.NameRecord property

Gets the components of the name of the object.

```csharp
public VCardTextRecord NameRecord { get; }
```

##### Property Value

The components of the name of the object.

### NicknameRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/nicknamerecords.md

#### VCardIdentificationRecordset.NicknameRecords property

Gets an array containing the text corresponding to the nickname of the object.

```csharp
public VCardTextRecord[] NicknameRecords { get; }
```

##### Property Value

An array containing the text corresponding to the nickname of the object.

### Nicknames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/nicknames.md

#### VCardIdentificationRecordset.Nicknames property

Gets an array containing the text corresponding to the nickname of the object.

```csharp
public string[] Nicknames { get; }
```

##### Property Value

An array containing the text corresponding to the nickname of the object.

##### Remarks

This property is a simplified version of `NicknameRecords`.

### PhotoBinaryRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photobinaryrecords.md

#### VCardIdentificationRecordset.PhotoBinaryRecords property

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

```csharp
public VCardBinaryRecord[] PhotoBinaryRecords { get; }
```

##### Property Value

An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `PhotoRecords`.

### PhotoRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photorecords.md

#### VCardIdentificationRecordset.PhotoRecords property

Gets an array containing the image or photograph information that annotates some aspects of the object.

```csharp
public VCardRecord[] PhotoRecords { get; }
```

##### Property Value

An array containing the image or photograph information that annotates some aspects of the object.

### PhotoUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photourirecords.md

#### VCardIdentificationRecordset.PhotoUriRecords property

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

```csharp
public VCardTextRecord[] PhotoUriRecords { get; }
```

##### Property Value

An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `PhotoRecords`.

### TextAnniversary
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/textanniversary.md

#### VCardIdentificationRecordset.TextAnniversary property

Gets the date of marriage represented as a single text value.

```csharp
public string TextAnniversary { get; }
```

##### Property Value

The date of marriage represented as a single text value.

##### Remarks

This property is a simplified version of `AnniversaryTextRecord`.

### TextBirthdates
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/textbirthdates.md

#### VCardIdentificationRecordset.TextBirthdates property

Gets an array containing the birth date of the object in different text representations.

```csharp
public string[] TextBirthdates { get; }
```

##### Property Value

An array containing the birth date of the object in different text representations.

##### Remarks

This property is a simplified version of `BirthdateTextRecords`.

### UriPhotos
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/uriphotos.md

#### VCardIdentificationRecordset.UriPhotos property

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

```csharp
public string[] UriPhotos { get; }
```

##### Property Value

An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `PhotoUriRecords`.

### VCardOrganizationalRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset.md

#### VCardOrganizationalRecordset class

Represents a set of Organizational vCard records. These properties are concerned with information associated with characteristics of the organization or organizational units of the object that the vCard represents.

```csharp
public class VCardOrganizationalRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| AgentObjectRecord { get; } | Gets the information about another person who will act on behalf of the vCard object. |
| AgentRecords { get; } | Gets the information about another person who will act on behalf of the vCard object. |
| AgentUriRecords { get; } | Gets the information about another person who will act on behalf of the vCard object. |
| BinaryLogos { get; } | Gets the graphic images of the logo associated with the object. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LogoBinaryRecords { get; } | Gets the graphic images of the logo associated with the object. |
| LogoRecords { get; } | Gets the graphic images of the logo associated with the object. |
| LogoUriRecords { get; } | Gets the URIs of the graphic images of the logo associated with the object. |
| MemberRecords { get; } | Gets the members in the group this vCard represents. |
| Members { get; } | Gets the members in the group this vCard represents. |
| MetadataType { get; } | Gets the metadata type. |
| ObjectAgent { get; } | Gets the information about another person who will act on behalf of the vCard object. |
| OrganizationNameRecords { get; } | Gets the organizational names and units associated with the object. |
| OrganizationNames { get; } | Gets the organizational names and units associated with the object. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RelationshipRecords { get; } | Gets the relationships between another entity and the entity represented by this vCard. |
| Relationships { get; } | Gets the relationships between another entity and the entity represented by this vCard. |
| RoleRecords { get; } | Gets the functions or parts played in a particular situation by the object. |
| Roles { get; } | Gets the functions or parts played in a particular situation by the object. |
| TitleRecords { get; } | Gets the positions or jobs of the object. |
| Titles { get; } | Gets the positions or jobs of the object. |
| UriAgents { get; } | Gets the information about another person who will act on behalf of the vCard object. |
| UriLogos { get; } | Gets the URIs of the graphic images of the logo associated with the object. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AgentObjectRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agentobjectrecord.md

#### VCardOrganizationalRecordset.AgentObjectRecord property

Gets the information about another person who will act on behalf of the vCard object.

```csharp
public VCardAgentRecord AgentObjectRecord { get; }
```

##### Property Value

The information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `AgentRecords`.

### AgentRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agentrecords.md

#### VCardOrganizationalRecordset.AgentRecords property

Gets the information about another person who will act on behalf of the vCard object.

```csharp
public VCardRecord[] AgentRecords { get; }
```

##### Property Value

The information about another person who will act on behalf of the vCard object.

### AgentUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agenturirecords.md

#### VCardOrganizationalRecordset.AgentUriRecords property

Gets the information about another person who will act on behalf of the vCard object.

```csharp
public VCardTextRecord[] AgentUriRecords { get; }
```

##### Property Value

The information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `AgentRecords`.

### BinaryLogos
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/binarylogos.md

#### VCardOrganizationalRecordset.BinaryLogos property

Gets the graphic images of the logo associated with the object.

```csharp
public byte[][] BinaryLogos { get; }
```

##### Property Value

The graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `LogoBinaryRecords`.

### LogoBinaryRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logobinaryrecords.md

#### VCardOrganizationalRecordset.LogoBinaryRecords property

Gets the graphic images of the logo associated with the object.

```csharp
public VCardBinaryRecord[] LogoBinaryRecords { get; }
```

##### Property Value

The graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `LogoRecords`.

### LogoRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logorecords.md

#### VCardOrganizationalRecordset.LogoRecords property

Gets the graphic images of the logo associated with the object.

```csharp
public VCardRecord[] LogoRecords { get; }
```

##### Property Value

The graphic images of the logo associated with the object.

### LogoUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logourirecords.md

#### VCardOrganizationalRecordset.LogoUriRecords property

Gets the URIs of the graphic images of the logo associated with the object.

```csharp
public VCardTextRecord[] LogoUriRecords { get; }
```

##### Property Value

The URIs of the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `LogoRecords`.

### MemberRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/memberrecords.md

#### VCardOrganizationalRecordset.MemberRecords property

Gets the members in the group this vCard represents.

```csharp
public VCardTextRecord[] MemberRecords { get; }
```

##### Property Value

The members in the group this vCard represents.

### Members
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/members.md

#### VCardOrganizationalRecordset.Members property

Gets the members in the group this vCard represents.

```csharp
public string[] Members { get; }
```

##### Property Value

The members in the group this vCard represents.

##### Remarks

This property is a simplified version of `MemberRecords`.

### ObjectAgent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/objectagent.md

#### VCardOrganizationalRecordset.ObjectAgent property

Gets the information about another person who will act on behalf of the vCard object.

```csharp
public VCardCard ObjectAgent { get; }
```

##### Property Value

The information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `AgentObjectRecord`.

### OrganizationNameRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/organizationnamerecords.md

#### VCardOrganizationalRecordset.OrganizationNameRecords property

Gets the organizational names and units associated with the object.

```csharp
public VCardTextRecord[] OrganizationNameRecords { get; }
```

##### Property Value

The organizational names and units associated with the object.

### OrganizationNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/organizationnames.md

#### VCardOrganizationalRecordset.OrganizationNames property

Gets the organizational names and units associated with the object.

```csharp
public string[] OrganizationNames { get; }
```

##### Property Value

The organizational names and units associated with the object.

##### Remarks

This property is a simplified version of `OrganizationNameRecords`.

### RelationshipRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/relationshiprecords.md

#### VCardOrganizationalRecordset.RelationshipRecords property

Gets the relationships between another entity and the entity represented by this vCard.

```csharp
public VCardTextRecord[] RelationshipRecords { get; }
```

##### Property Value

The relationships between another entity and the entity represented by this vCard.

### Relationships
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/relationships.md

#### VCardOrganizationalRecordset.Relationships property

Gets the relationships between another entity and the entity represented by this vCard.

```csharp
public string[] Relationships { get; }
```

##### Property Value

The relationships between another entity and the entity represented by this vCard.

##### Remarks

This property is a simplified version of `RelationshipRecords`.

### RoleRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/rolerecords.md

#### VCardOrganizationalRecordset.RoleRecords property

Gets the functions or parts played in a particular situation by the object.

```csharp
public VCardTextRecord[] RoleRecords { get; }
```

##### Property Value

The functions or parts played in a particular situation by the object.

### Roles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/roles.md

#### VCardOrganizationalRecordset.Roles property

Gets the functions or parts played in a particular situation by the object.

```csharp
public string[] Roles { get; }
```

##### Property Value

The functions or parts played in a particular situation by the object.

##### Remarks

This property is a simplified version of `TitleRecords`.

### TitleRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/titlerecords.md

#### VCardOrganizationalRecordset.TitleRecords property

Gets the positions or jobs of the object.

```csharp
public VCardTextRecord[] TitleRecords { get; }
```

##### Property Value

The positions or jobs of the object.

### Titles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/titles.md

#### VCardOrganizationalRecordset.Titles property

Gets the positions or jobs of the object.

```csharp
public string[] Titles { get; }
```

##### Property Value

The positions or jobs of the object.

##### Remarks

This property is a simplified version of `TitleRecords`.

### UriAgents
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/uriagents.md

#### VCardOrganizationalRecordset.UriAgents property

Gets the information about another person who will act on behalf of the vCard object.

```csharp
public string[] UriAgents { get; }
```

##### Property Value

The information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `AgentUriRecords`.

### UriLogos
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/urilogos.md

#### VCardOrganizationalRecordset.UriLogos property

Gets the URIs of the graphic images of the logo associated with the object.

```csharp
public string[] UriLogos { get; }
```

##### Property Value

The URIs of the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `LogoUriRecords`.

### VCardPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardpackage.md

#### VCardPackage class

Represents VCF (Virtual Contact File) electronic business card format metadata.

```csharp
public sealed class VCardPackage : VCardBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Cards { get; } | Gets an array of the cards extracted from the file. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cards
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardpackage/cards.md

#### VCardPackage.Cards property

Gets an array of the cards extracted from the file.

```csharp
public VCardCard[] Cards { get; }
```

##### Property Value

An array of the cards extracted from the file.

### VCardRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord.md

#### VCardRecord class

Represents abstract vCard record metadata class.

```csharp
public abstract class VCardRecord : VCardBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| abstract ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AltIdParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/altidparameter.md

#### VCardRecord.AltIdParameter property

Gets the alternative representations parameter value.

```csharp
public string AltIdParameter { get; }
```

##### Property Value

The alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.

### AnonymParameters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/anonymparameters.md

#### VCardRecord.AnonymParameters property

Gets the anonymous parameters.

```csharp
public string[] AnonymParameters { get; }
```

##### Property Value

The anonymous parameters.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/contenttype.md

#### VCardRecord.ContentType property

Gets the content type of record.

```csharp
public abstract VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### EncodingParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/encodingparameter.md

#### VCardRecord.EncodingParameter property

Gets the encoding parameter value.

```csharp
public string EncodingParameter { get; }
```

##### Property Value

The encoding parameter value.

### Group
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/group.md

#### VCardRecord.Group property

Gets the grouping value.

```csharp
public string Group { get; }
```

##### Property Value

The grouping value.

### LanguageParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/languageparameter.md

#### VCardRecord.LanguageParameter property

Gets the language parameter value.

```csharp
public string LanguageParameter { get; }
```

##### Property Value

The language parameter value.

### PrefParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/prefparameter.md

#### VCardRecord.PrefParameter property

Gets the preferred parameter.

```csharp
public int? PrefParameter { get; }
```

##### Property Value

The preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.

### TypeName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/typename.md

#### VCardRecord.TypeName property

Gets the type of the record.

```csharp
public string TypeName { get; }
```

##### Property Value

The type of the record.

### TypeParameters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/typeparameters.md

#### VCardRecord.TypeParameters property

Gets the type parameter values.

```csharp
public string[] TypeParameters { get; }
```

##### Property Value

The type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.

### ValueParameters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecord/valueparameters.md

#### VCardRecord.ValueParameters property

Gets the value parameters.

```csharp
public string[] ValueParameters { get; }
```

##### Property Value

The value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.

### VCardRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrecordset.md

#### VCardRecordset class

Provides a base vCard record union class.

```csharp
public class VCardRecordset : VCardBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### VCardRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrootpackage.md

#### VCardRootPackage class

Represents the root package allowing working with metadata in a VCard file.

```csharp
public class VCardRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| VCardPackage { get; } | Gets the VCard metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to read metadata properties of a vCard file.

```csharp
public static void Run()
{
    using (Metadata metadata = new Metadata(Constants.InputVcf))
    {
        var root = metadata.GetRootPackage<VCardRootPackage>();

        foreach (var vCard in root.VCardPackage.Cards)
        {
            Console.WriteLine(vCard.IdentificationRecordset.Name);
            PrintArray(vCard.IdentificationRecordset.FormattedNames);
            PrintArray(vCard.CommunicationRecordset.Emails);
            PrintArray(vCard.CommunicationRecordset.Telephones);
            PrintArray(vCard.DeliveryAddressingRecordset.Addresses);

            // ...
        }
    }
}

private static void PrintArray(string[] values)
{
    if (values != null)
    {
        foreach (string value in values)
        {
            Console.WriteLine(value);
        }
    }
}
```

### VCardPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardrootpackage/vcardpackage.md

#### VCardRootPackage.VCardPackage property

Gets the VCard metadata package.

```csharp
public VCardPackage VCardPackage { get; }
```

##### Property Value

The VCard metadata package.

##### Examples

This code sample demonstrates how to extract vCard fields along with descriptive parameters.

```csharp
using (Metadata metadata = new Metadata(Constants.InputVcf))
{
    var root = metadata.GetRootPackage<VCardRootPackage>();

    foreach (var vCard in root.VCardPackage.Cards)
    {
        if (vCard.IdentificationRecordset.PhotoUriRecords != null)
        {
            // Iterate all photos represented by URIs
            foreach (var photoUriRecord in vCard.IdentificationRecordset.PhotoUriRecords)
            {
                // Print the property value
                Console.WriteLine(photoUriRecord.Value);

                // Print some additional parameters of the property
                Console.WriteLine(photoUriRecord.ContentType);
                Console.WriteLine(photoUriRecord.MediaTypeParameter);
                if (photoUriRecord.TypeParameters != null)
                {
                    foreach (string parameter in photoUriRecord.TypeParameters)
                    {
                        Console.WriteLine(parameter);
                    }
                }
                Console.WriteLine(photoUriRecord.PrefParameter);
            }
        }
    }
}
```

### VCardSecurityRecordset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset.md

#### VCardSecurityRecordset class

Represents a set of Security vCard records. These properties are concerned with the security of communication pathways or access to the vCard.

```csharp
public class VCardSecurityRecordset : VCardRecordset
```

#### Properties

| Name | Description |
| --- | --- |
| AccessClassification { get; } | Gets the sensitivity of the information in the vCard. |
| BinaryPublicKeys { get; } | Gets the public keys or authentication certificates associated with the object. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PublicKeyBinaryRecords { get; } | Gets the public keys or authentication certificates associated with the object. |
| PublicKeyRecords { get; } | Gets the public keys or authentication certificates associated with the object. |
| PublicKeyUriRecords { get; } | Gets the public keys or authentication certificates associated with the object. |
| UriPublicKeys { get; } | Gets the public keys or authentication certificates associated with the object. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AccessClassification
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/accessclassification.md

#### VCardSecurityRecordset.AccessClassification property

Gets the sensitivity of the information in the vCard.

```csharp
public string AccessClassification { get; }
```

##### Property Value

The sensitivity of the information in the vCard.

### BinaryPublicKeys
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/binarypublickeys.md

#### VCardSecurityRecordset.BinaryPublicKeys property

Gets the public keys or authentication certificates associated with the object.

```csharp
public byte[][] BinaryPublicKeys { get; }
```

##### Property Value

The public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `PublicKeyBinaryRecords`.

### PublicKeyBinaryRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/publickeybinaryrecords.md

#### VCardSecurityRecordset.PublicKeyBinaryRecords property

Gets the public keys or authentication certificates associated with the object.

```csharp
public VCardBinaryRecord[] PublicKeyBinaryRecords { get; }
```

##### Property Value

The public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `PublicKeyRecords`.

### PublicKeyRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/publickeyrecords.md

#### VCardSecurityRecordset.PublicKeyRecords property

Gets the public keys or authentication certificates associated with the object.

```csharp
public VCardRecord[] PublicKeyRecords { get; }
```

##### Property Value

The public keys or authentication certificates associated with the object.

### PublicKeyUriRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/publickeyurirecords.md

#### VCardSecurityRecordset.PublicKeyUriRecords property

Gets the public keys or authentication certificates associated with the object.

```csharp
public VCardTextRecord[] PublicKeyUriRecords { get; }
```

##### Property Value

The public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `PublicKeyRecords`.

### UriPublicKeys
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/uripublickeys.md

#### VCardSecurityRecordset.UriPublicKeys property

Gets the public keys or authentication certificates associated with the object.

```csharp
public string[] UriPublicKeys { get; }
```

##### Property Value

The public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `PublicKeyUriRecords`.

### VCardTextRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord.md

#### VCardTextRecord class

Represents vCard text record metadata class.

```csharp
public class VCardTextRecord : VCardRecord
```

#### Properties

| Name | Description |
| --- | --- |
| AltIdParameter { get; } | Gets the alternative representations parameter value. |
| AnonymParameters { get; } | Gets the anonymous parameters. |
| CharsetParameter { get; } | Gets the charset parameter. |
| override ContentType { get; } | Gets the content type of record. |
| Count { get; } | Gets the number of metadata properties. |
| EncodingParameter { get; } | Gets the encoding parameter value. |
| Group { get; } | Gets the grouping value. |
| IsQuotedPrintable { get; } | Gets a value indicating whether this instance is quoted printable string. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageParameter { get; } | Gets the language parameter value. |
| MediaTypeParameter { get; } | Gets the media type parameter value. |
| MetadataType { get; } | Gets the metadata type. |
| PrefParameter { get; } | Gets the preferred parameter. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeName { get; } | Gets the type of the record. |
| TypeParameters { get; } | Gets the type parameter values. |
| Value { get; } | Gets the record value. |
| ValueParameters { get; } | Gets the value parameters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetReadabilityValue(string) | Gets the readability value. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CharsetParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/charsetparameter.md

#### VCardTextRecord.CharsetParameter property

Gets the charset parameter.

```csharp
public string CharsetParameter { get; }
```

##### Property Value

The charset parameter.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/contenttype.md

#### VCardTextRecord.ContentType property

Gets the content type of record.

```csharp
public override VCardContentType ContentType { get; }
```

##### Property Value

The content type of record.

### GetReadabilityValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/getreadabilityvalue.md

#### VCardTextRecord.GetReadabilityValue method

Gets the readability value.

```csharp
public string GetReadabilityValue(string codePageName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePageName | String | The using encoding code page name or null for ASCII encoding. |

##### Return Value

The readability value.

### IsQuotedPrintable
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/isquotedprintable.md

#### VCardTextRecord.IsQuotedPrintable property

Gets a value indicating whether this instance is quoted printable string.

```csharp
public bool IsQuotedPrintable { get; }
```

##### Property Value

`true` if this instance is quoted printable; otherwise, `false`.

### MediaTypeParameter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/mediatypeparameter.md

#### VCardTextRecord.MediaTypeParameter property

Gets the media type parameter value.

```csharp
public string MediaTypeParameter { get; }
```

##### Property Value

The media type parameter value.

##### Remarks

Used with properties whose value is a URI. It provides a hint to the vCard consumer application about the media type [RFC2046] of the resource identified by the URI.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.businesscard/vcardtextrecord/value.md

#### VCardTextRecord.Value property

Gets the record value.

```csharp
public string Value { get; }
```

##### Property Value

The record value.

### GroupDocs.Metadata.Formats.Cad
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad.md

The namespace contains classes for working with CAD (computer-aided design) formats.

#### Classes

| Class | Description |
| --- | --- |
| CadCustomPropertyPackage | Represents a collection of custom CAD metadata properties. |
| CadPackage | Represents CAD (Computer-aided design) metadata. |
| CadRootPackage | Represents the root package allowing working with metadata in a CAD drawing. |
| DwgRootPackage | Represents the root package allowing working with metadata in a DWG drawing. |
| DxfRootPackage | Represents the root package allowing working with metadata in a DXF drawing. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| CadAcadVersion | Defines AutoCAD drawing database version numbers. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### CadAcadVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadacadversion.md

#### CadAcadVersion enumeration

Defines AutoCAD drawing database version numbers.

```csharp
public enum CadAcadVersion
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Non-versioned. |
| Ac1006 | `1` | AutoCAD drawing database R10. |
| Ac1009 | `2` | AutoCAD drawing database R11 and R12. |
| Ac1012 | `3` | AutoCAD drawing database R13. |
| Ac1014 | `4` | AutoCAD drawing database R14. |
| Ac1015 | `5` | AutoCAD drawing database AutoCAD 2000. |
| Ac1018 | `6` | AutoCAD drawing database AutoCAD 2004. |
| Ac1021 | `7` | AutoCAD drawing database AutoCAD 2007. |
| Ac1024 | `8` | AutoCAD drawing database AutoCAD 2010. |
| Ac1027 | `9` | AutoCAD drawing database AutoCAD 2013. |
| Ac1032 | `10` | AutoCAD drawing database AutoCAD 2018. |

### CadCustomPropertyPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadcustompropertypackage.md

#### CadCustomPropertyPackage class

Represents a collection of custom CAD metadata properties.

```csharp
public class CadCustomPropertyPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CadPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage.md

#### CadPackage class

Represents CAD (Computer-aided design) metadata.

```csharp
public sealed class CadPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| AcadVersion { get; } | Gets the AutoCAD drawing database version number. |
| Author { get; } | Gets the drawing author. |
| Comments { get; } | Gets the user comments. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedDateTime { get; } | Gets the date and time when the drawing was created. |
| CustomProperties { get; } | Gets the package containing custom metadata properties. |
| Height { get; } | Gets the drawing height. |
| HyperlinkBase { get; } | Gets the hyperlink base. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; } | Gets the keywords. |
| LastSavedBy { get; } | Gets the name of the last editor. |
| MetadataType { get; } | Gets the metadata type. |
| ModifiedDateTime { get; } | Gets the date and time when the drawing was modified. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RevisionNumber { get; } | Gets the revision number. |
| Subject { get; } | Gets the subject. |
| Title { get; } | Gets the title. |
| Width { get; } | Gets the drawing width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AcadVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/acadversion.md

#### CadPackage.AcadVersion property

Gets the AutoCAD drawing database version number.

```csharp
public CadAcadVersion AcadVersion { get; }
```

##### Property Value

The AutoCAD drawing database version number.

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/author.md

#### CadPackage.Author property

Gets the drawing author.

```csharp
public string Author { get; }
```

##### Property Value

The drawing author.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/comments.md

#### CadPackage.Comments property

Gets the user comments.

```csharp
public string Comments { get; }
```

##### Property Value

The user comments.

### CreatedDateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/createddatetime.md

#### CadPackage.CreatedDateTime property

Gets the date and time when the drawing was created.

```csharp
public DateTime? CreatedDateTime { get; }
```

##### Property Value

The date and time when the drawing was created.

### CustomProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/customproperties.md

#### CadPackage.CustomProperties property

Gets the package containing custom metadata properties.

```csharp
public CadCustomPropertyPackage CustomProperties { get; }
```

##### Property Value

The package containing custom metadata properties.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/height.md

#### CadPackage.Height property

Gets the drawing height.

```csharp
public int Height { get; }
```

##### Property Value

The drawing height.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/hyperlinkbase.md

#### CadPackage.HyperlinkBase property

Gets the hyperlink base.

```csharp
public string HyperlinkBase { get; }
```

##### Property Value

The hyperlink base.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/keywords.md

#### CadPackage.Keywords property

Gets the keywords.

```csharp
public string Keywords { get; }
```

##### Property Value

The keywords.

### LastSavedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/lastsavedby.md

#### CadPackage.LastSavedBy property

Gets the name of the last editor.

```csharp
public string LastSavedBy { get; }
```

##### Property Value

The name of the last editor.

### ModifiedDateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/modifieddatetime.md

#### CadPackage.ModifiedDateTime property

Gets the date and time when the drawing was modified.

```csharp
public DateTime? ModifiedDateTime { get; }
```

##### Property Value

The date and time when the drawing was modified.

### RevisionNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/revisionnumber.md

#### CadPackage.RevisionNumber property

Gets the revision number.

```csharp
public string RevisionNumber { get; }
```

##### Property Value

The revision number.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/subject.md

#### CadPackage.Subject property

Gets the subject.

```csharp
public string Subject { get; }
```

##### Property Value

The subject.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/title.md

#### CadPackage.Title property

Gets the title.

```csharp
public string Title { get; }
```

##### Property Value

The title.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadpackage/width.md

#### CadPackage.Width property

Gets the drawing width.

```csharp
public int Width { get; }
```

##### Property Value

The drawing width.

### CadRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadrootpackage.md

#### CadRootPackage class

Represents the root package allowing working with metadata in a CAD drawing.

```csharp
public abstract class CadRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CadPackage { get; } | Gets the CAD metadata package. |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to read metadata of a CAD drawing.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDxf))
{
    var root = metadata.GetRootPackage<CadRootPackage>();

    Console.WriteLine(root.CadPackage.AcadVersion);
    Console.WriteLine(root.CadPackage.Author);
    Console.WriteLine(root.CadPackage.Comments);
    Console.WriteLine(root.CadPackage.CreatedDateTime);
    Console.WriteLine(root.CadPackage.HyperlinkBase);
    Console.WriteLine(root.CadPackage.Keywords);
    Console.WriteLine(root.CadPackage.LastSavedBy);
    Console.WriteLine(root.CadPackage.Title);

    // ...
}
```

### CadPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/cadrootpackage/cadpackage.md

#### CadRootPackage.CadPackage property

Gets the CAD metadata package.

```csharp
public CadPackage CadPackage { get; }
```

##### Property Value

The CAD metadata package.

### DwgRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/dwgrootpackage.md

#### DwgRootPackage class

Represents the root package allowing working with metadata in a DWG drawing.

```csharp
public class DwgRootPackage : CadRootPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CadPackage { get; } | Gets the CAD metadata package. |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DxfRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.cad/dxfrootpackage.md

#### DxfRootPackage class

Represents the root package allowing working with metadata in a DXF drawing.

```csharp
public class DxfRootPackage : CadRootPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CadPackage { get; } | Gets the CAD metadata package. |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### GroupDocs.Metadata.Formats.Document
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document.md

The namespace provides functionality intended to work with a variety of document formats such as spreadsheets, presentations, text processing formats, etc.

#### Classes

| Class | Description |
| --- | --- |
| DiagramPackage | Represents a native metadata package in a diagram format. |
| DiagramRootPackage | Represents the root package intended to work with metadata in a diagram. |
| DiagramTypePackage | Represents a metadata package containing diagram-specific file format information. |
| DocumentPackage | Represents native metadata in an office document. |
| DocumentRootPackage&lt;TPackage&gt; | Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc. |
| DocumentStatistics | Represents a set of document statistics. |
| NoteInspectionPackage | Represents a metadata package exposing the internal structure of a note section. |
| NotePage | Represents a page in a OneNote section. |
| NoteRootPackage | Represents the root package intended to work with metadata in an electronic note file. |
| PdfAnnotation | Represents an annotation in a PDF document. |
| PdfAttachment | Represents an attachment in a PDF document. |
| PdfBookmark | Represents a bookmark in a PDF document. |
| PdfFormField | Represents a form field in a PDF document. |
| PdfInspectionPackage | Contains information about PDF document parts that can be considered as metadata in some cases. |
| PdfPackage | Represents native metadata in a PDF document. |
| PdfRootPackage | Represents the root package allowing working with metadata in a PDF document. |
| PdfTypePackage | Represents a metadata package containing PDF-specific file format information. |
| PresentationComment | Represents a user comment in a presentation. |
| PresentationInspectionPackage | Contains information about presentation parts that can be considered as metadata in some cases. |
| PresentationPackage | Represents a native metadata package in a presentation. |
| PresentationRootPackage | Represents the root package intended to work with metadata in a presentation. |
| PresentationSlide | Represents a slide in a presentation. |
| PresentationTypePackage | Represents a metadata package containing presentation-specific file format information. |
| ProjectManagementPackage | Represents a native metadata package in a project management file. |
| ProjectManagementRootPackage | Represents the root package intended to work with metadata in a project management format. |
| SpreadsheetComment | Represents a user comment in a spreadsheet. |
| SpreadsheetContentTypePackage | Represents a metadata package containing spreadsheet content type properties. |
| SpreadsheetContentTypeProperty | Represents a content type property in a spreadsheet. |
| SpreadsheetInspectionPackage | Contains information about spreadsheet parts that can be considered as metadata in some cases. |
| SpreadsheetPackage | Represents a native metadata package in a spreadsheet. |
| SpreadsheetRootPackage | Represents the root package allowing working with metadata in a spreadsheet. |
| SpreadsheetSheet | Represents a sheet in a spreadsheet document. |
| SpreadsheetTypePackage | Represents a metadata package containing spreadsheet-specific file format information. |
| WordProcessingComment | Represents a comment in a word processing document. |
| WordProcessingField | Represents a field in a word processing document. |
| WordProcessingInspectionPackage | Contains information about document parts that can be considered as metadata in some cases. |
| WordProcessingPackage | Represents a native metadata package in a word processing document. |
| WordProcessingRevision | Represents a revision (tracked change) in a document. |
| WordProcessingRootPackage | Represents the root package allowing working with metadata in a word processing document. |
| WordProcessingTypePackage | Represents a metadata package containing document-specific file format information. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| DiagramFormat | Defines various diagram subformats. |
| PdfFormat | Represents supported PDF format standards and versions. |
| PresentationFormat | Defines various presentation subformats. |
| SpreadsheetFormat | Defines various spreadsheet subformats. |
| WordProcessingFormat | Defines various word processing document subformats. |
| WordProcessingRevisionType | Specifies the type of the change being tracked by a revision. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DiagramFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramformat.md

#### DiagramFormat enumeration

Defines various diagram subformats.

```csharp
public enum DiagramFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format is not recognized. |
| Vdx | `1` | Represents the .VDX Visio format. 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/). |
| Vsd | `2` | Represents the .VSD Visio format. VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Such drawings can contain visual objects such as visual objects, flow charts, UML diagram, information flow, organizational charts, software diagrams, network layout, database models, objects mapping and other similar information. Learn more about this file format [here](https://wiki.fileformat.com/image/vsd/). |
| Vsdx | `3` | Represents the .VSDX Visio format. 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/). |
| Vss | `4` | Represents the .VSS Visio format. VSS are stencil files created with Microsoft Visio 2007 and earlier. A relatively new file format is .VSSX that was introduced with Microsoft Visio 2013. 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/). |
| Vsx | `5` | Represents the .VSX Visio format. 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/). |

### DiagramPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage.md

#### DiagramPackage class

Represents a native metadata package in a diagram format.

```csharp
public class DiagramPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| AlternateNames { get; set; } | Gets or sets the alternate names for the document. Can be updated in VDX and VSX formats only. |
| BuildNumberCreated { get; } | Gets the full build number of the instance used to create the document. |
| BuildNumberEdited { get; } | Gets the build number of the instance last used to edit the document. |
| Category { get; set; } | Gets or sets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box. |
| Company { get; set; } | Gets or sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters. |
| Count { get; } | Gets the number of metadata properties. |
| Creator { get; set; } | Gets or sets the person who created or last updated the file. The maximum length is 63 characters.. |
| Description { get; set; } | Gets or sets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters. |
| HyperlinkBase { get; set; } | Gets or sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters. |
| Language { get; set; } | Gets or sets the language of the document. Can be updated in VSD and VSDX formats only. |
| Manager { get; set; } | Gets or sets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters. |
| MetadataType { get; } | Gets the metadata type. |
| PreviewPicture { get; set; } | Gets or sets the preview picture. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Subject { get; set; } | Gets or sets a user-defined text string that describes the contents of the document. Maximum length is 63 characters. |
| Template { get; set; } | Gets or sets a string value specifying the file name of the template from which the document was created. |
| TimeCreated { get; set; } | Gets or sets a date and time value indicating when the document was created. |
| TimeEdited { get; } | Gets a date and time value indicating when the document was last edited. |
| TimePrinted { get; } | Gets a date and time value indicating when the document was last printed. |
| TimeSaved { get; } | Gets a date and time value indicating when the document was last saved. |
| Title { get; set; } | Gets or sets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Adds or replaces the metadata property with the specified name. |
| Set(string, DateTime) | Adds or replaces the metadata property with the specified name. |
| Set(string, double) | Adds or replaces the metadata property with the specified name. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to extract built-in metadata properties from a diagram.

```csharp
using (Metadata metadata = new Metadata(Constants.InputVsdx))
{
    var root = metadata.GetRootPackage<DiagramRootPackage>();

    Console.WriteLine(root.DocumentProperties.Creator);
    Console.WriteLine(root.DocumentProperties.Company);
    Console.WriteLine(root.DocumentProperties.Keywords);
    Console.WriteLine(root.DocumentProperties.Language);
    Console.WriteLine(root.DocumentProperties.TimeCreated);
    Console.WriteLine(root.DocumentProperties.Category);

    // ... 
}
```

### AlternateNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/alternatenames.md

#### DiagramPackage.AlternateNames property

Gets or sets the alternate names for the document. Can be updated in VDX and VSX formats only.

```csharp
public string AlternateNames { get; set; }
```

##### Property Value

The alternate names for the document.

### BuildNumberCreated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/buildnumbercreated.md

#### DiagramPackage.BuildNumberCreated property

Gets the full build number of the instance used to create the document.

```csharp
public string BuildNumberCreated { get; }
```

##### Property Value

The full build number of the instance used to create the document.

### BuildNumberEdited
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/buildnumberedited.md

#### DiagramPackage.BuildNumberEdited property

Gets the build number of the instance last used to edit the document.

```csharp
public string BuildNumberEdited { get; }
```

##### Property Value

The build number of the instance last used to edit the document.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/category.md

#### DiagramPackage.Category property

Gets or sets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.

```csharp
public string Category { get; set; }
```

##### Property Value

The descriptive text for the type of drawing, such as flowchart or office layout.

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/company.md

#### DiagramPackage.Company property

Gets or sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

```csharp
public string Company { get; set; }
```

##### Property Value

The user-entered information identifying the company creating the drawing or the company the drawing is being created for.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/creator.md

#### DiagramPackage.Creator property

Gets or sets the person who created or last updated the file. The maximum length is 63 characters..

```csharp
public string Creator { get; set; }
```

##### Property Value

The person who created or last updated the file.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/description.md

#### DiagramPackage.Description property

Gets or sets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.

```csharp
public string Description { get; set; }
```

##### Property Value

A descriptive text string for the document.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/hyperlinkbase.md

#### DiagramPackage.HyperlinkBase property

Gets or sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.

```csharp
public string HyperlinkBase { get; set; }
```

##### Property Value

The path to be used for relative hyperlinks.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/keywords.md

#### DiagramPackage.Keywords property

Gets or sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.

```csharp
public string Keywords { get; set; }
```

##### Property Value

A text string that identifies topics or other important information about the file, such as project name, client name, or version number.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/language.md

#### DiagramPackage.Language property

Gets or sets the language of the document. Can be updated in VSD and VSDX formats only.

```csharp
public string Language { get; set; }
```

##### Property Value

The language of the document.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/manager.md

#### DiagramPackage.Manager property

Gets or sets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

```csharp
public string Manager { get; set; }
```

##### Property Value

A user-entered text string identifying the person in charge of the project or department.

### PreviewPicture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/previewpicture.md

#### DiagramPackage.PreviewPicture property

Gets or sets the preview picture.

```csharp
public byte[] PreviewPicture { get; set; }
```

##### Property Value

The preview picture.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/set.md

#### Set(string, string)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

#### Set(string, bool)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Boolean | The property value. |

#### Set(string, double)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Double | The property value. |

#### Set(string, DateTime)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | DateTime | The property value. |

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/subject.md

#### DiagramPackage.Subject property

Gets or sets a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

```csharp
public string Subject { get; set; }
```

##### Property Value

A user-defined text string that describes the contents of the document.

### Template
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/template.md

#### DiagramPackage.Template property

Gets or sets a string value specifying the file name of the template from which the document was created.

```csharp
public string Template { get; set; }
```

##### Property Value

A string value specifying the file name of the template from which the document was created.

### TimeCreated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/timecreated.md

#### DiagramPackage.TimeCreated property

Gets or sets a date and time value indicating when the document was created.

```csharp
public DateTime TimeCreated { get; set; }
```

##### Property Value

A date and time value indicating when the document was created.

### TimeEdited
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/timeedited.md

#### DiagramPackage.TimeEdited property

Gets a date and time value indicating when the document was last edited.

```csharp
public DateTime TimeEdited { get; }
```

##### Property Value

A date and time value indicating when the document was last edited.

### TimePrinted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/timeprinted.md

#### DiagramPackage.TimePrinted property

Gets a date and time value indicating when the document was last printed.

```csharp
public DateTime TimePrinted { get; }
```

##### Property Value

A date and time value indicating when the document was last printed.

### TimeSaved
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/timesaved.md

#### DiagramPackage.TimeSaved property

Gets a date and time value indicating when the document was last saved.

```csharp
public DateTime TimeSaved { get; }
```

##### Property Value

A date and time value indicating when the document was last saved.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagrampackage/title.md

#### DiagramPackage.Title property

Gets or sets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

```csharp
public string Title { get; set; }
```

##### Property Value

A user-defined text string that serves as a descriptive title for the document.

### DiagramRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramrootpackage.md

#### DiagramRootPackage class

Represents the root package intended to work with metadata in a diagram.

```csharp
public class DiagramRootPackage : DocumentRootPackage<DiagramPackage>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| FileType { get; } | Gets the file type metadata package. (2 properties) |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code sample demonstrates how to update built-in metadata properties in a diagram document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputVdx))
{
    var root = metadata.GetRootPackage<DiagramRootPackage>();

    root.DocumentProperties.Creator = "test author";
    root.DocumentProperties.TimeCreated = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Category = "test category";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputVdx);
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramrootpackage/documentstatistics.md

#### DiagramRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramrootpackage/filetype.md

#### DiagramRootPackage.FileType property

Gets the file type metadata package.

```csharp
public DiagramTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

##### Examples

This code sample shows how to detect the exact type of a loaded diagram and extract some additional file format information.

```csharp
using (Metadata metadata = new Metadata(Constants.InputVdx))
{
    var root = metadata.GetRootPackage<DiagramRootPackage>();

    Console.WriteLine(root.FileType.FileFormat);
    Console.WriteLine(root.FileType.DiagramFormat);
    Console.WriteLine(root.FileType.MimeType);
    Console.WriteLine(root.FileType.Extension);
}
```

### DiagramTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramtypepackage.md

#### DiagramTypePackage class

Represents a metadata package containing diagram-specific file format information.

```csharp
public class DiagramTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DiagramFormat { get; } | Gets the exact diagram format. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DiagramFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/diagramtypepackage/diagramformat.md

#### DiagramTypePackage.DiagramFormat property

Gets the exact diagram format.

```csharp
public DiagramFormat DiagramFormat { get; }
```

##### Property Value

The exact diagram format.

### DocumentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentpackage.md

#### DocumentPackage class

Represents native metadata in an office document.

```csharp
public abstract class DocumentPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentpackage/clear.md

#### DocumentPackage.Clear method

Removes all writable metadata properties from the package.

```csharp
public void Clear()
```

### ClearBuiltInProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentpackage/clearbuiltinproperties.md

#### DocumentPackage.ClearBuiltInProperties method

Removes all built-in metadata properties.

```csharp
public void ClearBuiltInProperties()
```

### ClearCustomProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentpackage/clearcustomproperties.md

#### DocumentPackage.ClearCustomProperties method

Removes all custom metadata properties.

```csharp
public void ClearCustomProperties()
```

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentpackage/remove.md

#### DocumentPackage.Remove method

Removes a writable metadata property by the specified name.

```csharp
public bool Remove(string propertyName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | A metadata property name. |

##### Return Value

`true` if the property is found and deleted; otherwise `false`.

### DocumentRootPackageTPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentrootpackage-1.md

#### DocumentRootPackage&lt;TPackage&gt; class

Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc.

```csharp
public abstract class DocumentRootPackage<TPackage> : RootMetadataPackage
    where TPackage : DocumentPackage
```

| Parameter | Description |
| --- | --- |
| TPackage | The type of the native metadata package. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DocumentProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentrootpackage-1/documentproperties.md

#### DocumentRootPackage&lt;TPackage&gt;.DocumentProperties property

Gets the native metadata properties presented in the document.

```csharp
public virtual TPackage DocumentProperties { get; }
```

##### Property Value

The document properties.

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentstatistics.md

#### DocumentStatistics class

Represents a set of document statistics.

```csharp
public class DocumentStatistics : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentStatistics() | Initializes a new instance of the `DocumentStatistics` class. |

#### Properties

| Name | Description |
| --- | --- |
| CharacterCount { get; } | Gets an estimated number of characters in the document. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PageCount { get; } | Gets an estimated number of pages in the document. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| WordCount { get; } | Gets an estimated number of words in the document. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CharacterCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentstatistics/charactercount.md

#### DocumentStatistics.CharacterCount property

Gets an estimated number of characters in the document.

```csharp
public int CharacterCount { get; }
```

##### Property Value

An estimated number of characters in the document.

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentstatistics/documentstatistics.md

#### DocumentStatistics constructor

Initializes a new instance of the `DocumentStatistics` class.

```csharp
public DocumentStatistics()
```

### PageCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentstatistics/pagecount.md

#### DocumentStatistics.PageCount property

Gets an estimated number of pages in the document.

```csharp
public int PageCount { get; }
```

##### Property Value

An estimated number of pages in the document.

### WordCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/documentstatistics/wordcount.md

#### DocumentStatistics.WordCount property

Gets an estimated number of words in the document.

```csharp
public int WordCount { get; }
```

##### Property Value

An estimated number of words in the document.

### NoteInspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/noteinspectionpackage.md

#### NoteInspectionPackage class

Represents a metadata package exposing the internal structure of a note section.

```csharp
public sealed class NoteInspectionPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Pages { get; } | Gets an array of section pages. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Pages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/noteinspectionpackage/pages.md

#### NoteInspectionPackage.Pages property

Gets an array of section pages.

```csharp
public NotePage[] Pages { get; }
```

##### Property Value

An array of section pages.

### NotePage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/notepage.md

#### NotePage class

Represents a page in a OneNote section.

```csharp
public class NotePage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets the page author. |
| Count { get; } | Gets the number of metadata properties. |
| CreationTime { get; } | Gets the creation time. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LastModificationTime { get; } | Gets the last modification time. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Title { get; } | Gets the page title. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/notepage/author.md

#### NotePage.Author property

Gets the page author.

```csharp
public string Author { get; }
```

##### Property Value

The page author.

### CreationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/notepage/creationtime.md

#### NotePage.CreationTime property

Gets the creation time.

```csharp
public DateTime CreationTime { get; }
```

##### Property Value

The creation time.

### LastModificationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/notepage/lastmodificationtime.md

#### NotePage.LastModificationTime property

Gets the last modification time.

```csharp
public DateTime LastModificationTime { get; }
```

##### Property Value

The last modification time.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/notepage/title.md

#### NotePage.Title property

Gets the page title.

```csharp
public string Title { get; }
```

##### Property Value

The page title.

### NoteRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/noterootpackage.md

#### NoteRootPackage class

Represents the root package intended to work with metadata in an electronic note file.

```csharp
public class NoteRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| FileType { get; } | Gets the file type metadata package. |
| InspectionPackage { get; } | Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to inspect a note document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputOne))
{
    var root = metadata.GetRootPackage<NoteRootPackage>();

    if (root.InspectionPackage.Pages != null)
    {
        foreach (var page in root.InspectionPackage.Pages)
        {
            Console.WriteLine(page.Title);
            Console.WriteLine(page.Author);
            Console.WriteLine(page.CreationTime);
            Console.WriteLine(page.LastModificationTime);
        }
    }
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/noterootpackage/documentstatistics.md

#### NoteRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

### InspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/noterootpackage/inspectionpackage.md

#### NoteRootPackage.InspectionPackage property

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

```csharp
public NoteInspectionPackage InspectionPackage { get; }
```

##### Property Value

A metadata package containing inspection results for the document.

### PdfAnnotation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfannotation.md

#### PdfAnnotation class

Represents an annotation in a PDF document.

```csharp
public class PdfAnnotation : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the name of the annotation. |
| PageNumber { get; } | Gets the number of the page containing the annotation. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the annotation text. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfannotation/name.md

#### PdfAnnotation.Name property

Gets the name of the annotation.

```csharp
public string Name { get; }
```

##### Property Value

The name of the annotation.

### PageNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfannotation/pagenumber.md

#### PdfAnnotation.PageNumber property

Gets the number of the page containing the annotation.

```csharp
public int PageNumber { get; }
```

##### Property Value

The number of the page containing the annotation.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfannotation/text.md

#### PdfAnnotation.Text property

Gets the annotation text.

```csharp
public string Text { get; }
```

##### Property Value

The annotation text.

### PdfAttachment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfattachment.md

#### PdfAttachment class

Represents an attachment in a PDF document.

```csharp
public class PdfAttachment : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Description { get; } | Gets the attachment description. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type of the attachment. |
| Name { get; } | Gets the attachment name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfattachment/description.md

#### PdfAttachment.Description property

Gets the attachment description.

```csharp
public string Description { get; }
```

##### Property Value

The attachment description.

### MimeType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfattachment/mimetype.md

#### PdfAttachment.MimeType property

Gets the MIME type of the attachment.

```csharp
public string MimeType { get; }
```

##### Property Value

The MIME type of the attachment.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfattachment/name.md

#### PdfAttachment.Name property

Gets the attachment name.

```csharp
public string Name { get; }
```

##### Property Value

The attachment name.

### PdfBookmark
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfbookmark.md

#### PdfBookmark class

Represents a bookmark in a PDF document.

```csharp
public class PdfBookmark : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Title { get; } | Gets the title of the bookmark. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfbookmark/title.md

#### PdfBookmark.Title property

Gets the title of the bookmark.

```csharp
public string Title { get; }
```

##### Property Value

The title of the bookmark.

### PdfFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfformat.md

#### PdfFormat enumeration

Represents supported PDF format standards and versions.

```csharp
public enum PdfFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PdfA1A | `0` | Represents the PDF/A-1a format. |
| PdfA1B | `1` | Represents the PDF/A-1b format. |
| PdfA2A | `2` | Represents the PDF/A-2a format. |
| PdfA3A | `3` | Represents the PDF/A-3a format. |
| PdfA2B | `4` | Represents the PDF/A-2b format. |
| PdfA2U | `5` | Represents the PDF/A-2u format. |
| PdfA3B | `6` | Represents the PDF/A-3b format. |
| PdfA3U | `7` | Represents the PDF/A-3u format. |
| Pdf10 | `8` | Represents the PDF 1.0 format. |
| Pdf11 | `9` | Represents the PDF 1.1 format. |
| Pdf12 | `10` | Represents the PDF 1.2 format. |
| Pdf13 | `11` | Represents the PDF 1.3 format. |
| Pdf14 | `12` | Represents the PDF 1.4 format. |
| Pdf15 | `13` | Represents the PDF 1.5 format. |
| Pdf16 | `14` | Represents the PDF 1.6 format. |
| Pdf17 | `15` | Represents the PDF 1.7 format. |
| Pdf20 | `16` | Represents the PDF 2.0 format. |
| PdfUa1 | `17` | Represents the PDF/UA-1 (Universal Accessibility) format. |
| PdfX1A2001 | `18` | Represents the PDF/X-1a:2001 format. |
| PdfX1A | `19` | Represents the PDF/X-1a format. |
| PdfX3 | `20` | Represents the PDF/X-3 format. |
| ZugFeRD | `21` | Represents the ZUGFeRD format (electronic invoice standard based on PDF). |
| PdfA4 | `22` | Represents the PDF/A-4 format. |
| PdfA4E | `23` | Represents the PDF/A-4e format (engineering). |
| PdfA4F | `24` | Represents the PDF/A-4f format (file attachments). |
| PdfX4 | `25` | Represents the PDF/X-4 format. |
| Unknown | `26` | Represents an unknown or unsupported PDF format. |

### PdfFormField
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfformfield.md

#### PdfFormField class

Represents a form field in a PDF document.

```csharp
public class PdfFormField : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the name of the field. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the field value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfformfield/name.md

#### PdfFormField.Name property

Gets the name of the field.

```csharp
public string Name { get; }
```

##### Property Value

The name of the field.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfformfield/value.md

#### PdfFormField.Value property

Gets the field value.

```csharp
public string Value { get; }
```

##### Property Value

The field value.

### PdfInspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage.md

#### PdfInspectionPackage class

Contains information about PDF document parts that can be considered as metadata in some cases.

```csharp
public sealed class PdfInspectionPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Annotations { get; } | Gets an array of the annotations. |
| Attachments { get; } | Gets an array of the attachments. |
| Bookmarks { get; } | Gets an array of the bookmarks. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalSignatures { get; } | Gets an array of the digital signatures. |
| Fields { get; } | Gets an array of the form fields. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAnnotations() | Removes all detected annotations from the document. |
| ClearAttachments() | Removes all detected attachments from the document. |
| ClearBookmarks() | Removes all detected bookmarks from the document. |
| ClearDigitalSignatures() | Removes all detected digital signatures from the document. |
| ClearFields() | Removes all detected form fields from the document. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to remove the inspection properties in a PDF document.

```csharp
using (Metadata metadata = new Metadata(Constants.SignedPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    root.InspectionPackage.ClearAnnotations();
    root.InspectionPackage.ClearAttachments();
    root.InspectionPackage.ClearFields();
    root.InspectionPackage.ClearBookmarks();
    root.InspectionPackage.ClearDigitalSignatures();

    metadata.Save(Constants.OutputPdf);
}
```

### Annotations
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/annotations.md

#### PdfInspectionPackage.Annotations property

Gets an array of the annotations.

```csharp
public PdfAnnotation[] Annotations { get; }
```

##### Property Value

An array of the annotations.

### Attachments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/attachments.md

#### PdfInspectionPackage.Attachments property

Gets an array of the attachments.

```csharp
public PdfAttachment[] Attachments { get; }
```

##### Property Value

An array of the attachments.

### Bookmarks
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/bookmarks.md

#### PdfInspectionPackage.Bookmarks property

Gets an array of the bookmarks.

```csharp
public PdfBookmark[] Bookmarks { get; }
```

##### Property Value

An array of the bookmarks.

### ClearAnnotations
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/clearannotations.md

#### PdfInspectionPackage.ClearAnnotations method

Removes all detected annotations from the document.

```csharp
public void ClearAnnotations()
```

### ClearAttachments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/clearattachments.md

#### PdfInspectionPackage.ClearAttachments method

Removes all detected attachments from the document.

```csharp
public void ClearAttachments()
```

### ClearBookmarks
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/clearbookmarks.md

#### PdfInspectionPackage.ClearBookmarks method

Removes all detected bookmarks from the document.

```csharp
public void ClearBookmarks()
```

### ClearDigitalSignatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/cleardigitalsignatures.md

#### PdfInspectionPackage.ClearDigitalSignatures method

Removes all detected digital signatures from the document.

```csharp
public void ClearDigitalSignatures()
```

### ClearFields
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/clearfields.md

#### PdfInspectionPackage.ClearFields method

Removes all detected form fields from the document.

```csharp
public void ClearFields()
```

### DigitalSignatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/digitalsignatures.md

#### PdfInspectionPackage.DigitalSignatures property

Gets an array of the digital signatures.

```csharp
public DigitalSignature[] DigitalSignatures { get; }
```

##### Property Value

An array of the digital signatures.

### Fields
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/fields.md

#### PdfInspectionPackage.Fields property

Gets an array of the form fields.

```csharp
public PdfFormField[] Fields { get; }
```

##### Property Value

An array of the form fields.

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/removeproperties.md

#### PdfInspectionPackage.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public override int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfinspectionpackage/sanitize.md

#### PdfInspectionPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### PdfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage.md

#### PdfPackage class

Represents native metadata in a PDF document.

```csharp
public class PdfPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the document author. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedDate { get; set; } | Gets or sets the date of document creation. |
| Creator { get; set; } | Gets the creator of the document. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| MetadataType { get; } | Gets the metadata type. |
| ModifiedDate { get; set; } | Gets or sets the date of the last modification. |
| Producer { get; set; } | Gets the document producer. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Subject { get; set; } | Gets or sets the subject of the document. |
| Title { get; set; } | Gets or sets the title of the document. |
| TrappedFlag { get; set; } | Gets or sets the trapped flag. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code snippet demonstrates how to update built-in metadata properties in a PDF document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedDate = DateTime.Now;
    root.DocumentProperties.Title = "test title";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputPdf);
}
```

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/author.md

#### PdfPackage.Author property

Gets or sets the document author.

```csharp
public string Author { get; set; }
```

##### Property Value

The document author.

### CreatedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/createddate.md

#### PdfPackage.CreatedDate property

Gets or sets the date of document creation.

```csharp
public DateTime? CreatedDate { get; set; }
```

##### Property Value

The date of document creation.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/creator.md

#### PdfPackage.Creator property

Gets the creator of the document.

```csharp
public string Creator { get; set; }
```

##### Property Value

The creator of the document.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/keywords.md

#### PdfPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### ModifiedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/modifieddate.md

#### PdfPackage.ModifiedDate property

Gets or sets the date of the last modification.

```csharp
public DateTime? ModifiedDate { get; set; }
```

##### Property Value

The date of the last modification.

### Producer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/producer.md

#### PdfPackage.Producer property

Gets the document producer.

```csharp
public string Producer { get; set; }
```

##### Property Value

The document producer.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/set.md

#### PdfPackage.Set method

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/subject.md

#### PdfPackage.Subject property

Gets or sets the subject of the document.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject of the document.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/title.md

#### PdfPackage.Title property

Gets or sets the title of the document.

```csharp
public string Title { get; set; }
```

##### Property Value

The title of the document.

### TrappedFlag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfpackage/trappedflag.md

#### PdfPackage.TrappedFlag property

Gets or sets the trapped flag.

```csharp
public bool? TrappedFlag { get; set; }
```

##### Property Value

`true` if the trapped flag is set; otherwise, `false`.

### PdfRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfrootpackage.md

#### PdfRootPackage class

Represents the root package allowing working with metadata in a PDF document.

```csharp
public class PdfRootPackage : DocumentRootPackage<PdfPackage>, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| FileType { get; } | Gets the file type metadata package. (2 properties) |
| InspectionPackage { get; } | Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract built-in metadata properties from a PDF document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    Console.WriteLine(root.DocumentProperties.Author);
    Console.WriteLine(root.DocumentProperties.CreatedDate);
    Console.WriteLine(root.DocumentProperties.Subject);
    Console.WriteLine(root.DocumentProperties.Producer);
    Console.WriteLine(root.DocumentProperties.Keywords);

    // ... 
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfrootpackage/documentstatistics.md

#### PdfRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

##### Examples

This code sample demonstrates how to obtain the text statistics for a PDF document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

        Console.WriteLine(root.DocumentStatistics.CharacterCount);
        Console.WriteLine(root.DocumentStatistics.PageCount);
        Console.WriteLine(root.DocumentStatistics.WordCount);
}
```

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfrootpackage/filetype.md

#### PdfRootPackage.FileType property

Gets the file type metadata package.

```csharp
public PdfTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

##### Examples

This code snippet shows how to detect the PDF version a loaded document and extract some additional file format information.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    Console.WriteLine(root.FileType.FileFormat);
    Console.WriteLine(root.FileType.Version);
    Console.WriteLine(root.FileType.MimeType);
    Console.WriteLine(root.FileType.Extension);
}
```

### InspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfrootpackage/inspectionpackage.md

#### PdfRootPackage.InspectionPackage property

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

```csharp
public PdfInspectionPackage InspectionPackage { get; }
```

##### Property Value

A metadata package containing inspection results for the document.

##### Examples

This example demonstrates how to inspect a PDF document.

```csharp
using (Metadata metadata = new Metadata(Constants.SignedPdf))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();

    if (root.InspectionPackage.Annotations != null)
    {
        foreach (var annotation in root.InspectionPackage.Annotations)
        {
            Console.WriteLine(annotation.Name);
            Console.WriteLine(annotation.Text);
            Console.WriteLine(annotation.PageNumber);
        }
    }

    if (root.InspectionPackage.Attachments != null)
    {
        foreach (var attachment in root.InspectionPackage.Attachments)
        {
            Console.WriteLine(attachment.Name);
            Console.WriteLine(attachment.MimeType);
            Console.WriteLine(attachment.Description);
        }
    }

    if (root.InspectionPackage.Bookmarks != null)
    {
        foreach (var bookmark in root.InspectionPackage.Bookmarks)
        {
            Console.WriteLine(bookmark.Title);
        }
    }

    if (root.InspectionPackage.DigitalSignatures != null)
    {
        foreach (var signature in root.InspectionPackage.DigitalSignatures)
        {
            Console.WriteLine(signature.CertificateSubject);
            Console.WriteLine(signature.Comments);
            Console.WriteLine(signature.SignTime);

            // ...
        }
    }

    if (root.InspectionPackage.Fields != null)
    {
        foreach (var field in root.InspectionPackage.Fields)
        {
            Console.WriteLine(field.Name);
            Console.WriteLine(field.Value);

            // ...
        }
    }
}
```

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdfrootpackage/xmppackage.md

#### PdfRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.PdfWithXmp))
{
    var root = metadata.GetRootPackage<PdfRootPackage>();
    if (root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### PdfTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdftypepackage.md

#### PdfTypePackage class

Represents a metadata package containing PDF-specific file format information.

```csharp
public class PdfTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| IsPdfA { get; } | Gets a value indicating whether the document conforms to any PDF/A standard. |
| IsPdfX { get; } | Gets a value indicating whether the document conforms to any PDF/X standard. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PdfFormat { get; } | Gets the detected PDF format. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Version { get; } | Gets the version of the format. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### IsPdfA
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdftypepackage/ispdfa.md

#### PdfTypePackage.IsPdfA property

Gets a value indicating whether the document conforms to any PDF/A standard.

```csharp
public bool IsPdfA { get; }
```

##### Property Value

`true` if the document is identified as PDF/A; otherwise, `false`.

### IsPdfX
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdftypepackage/ispdfx.md

#### PdfTypePackage.IsPdfX property

Gets a value indicating whether the document conforms to any PDF/X standard.

```csharp
public bool IsPdfX { get; }
```

##### Property Value

`true` if the document is identified as PDF/X; otherwise, `false`.

### PdfFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdftypepackage/pdfformat.md

#### PdfTypePackage.PdfFormat property

Gets the detected PDF format.

```csharp
public PdfFormat PdfFormat { get; }
```

##### Property Value

The detected PDF format.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/pdftypepackage/version.md

#### PdfTypePackage.Version property

Gets the version of the format.

```csharp
public string Version { get; }
```

##### Property Value

The version of the format.

### PresentationComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationcomment.md

#### PresentationComment class

Represents a user comment in a presentation.

```csharp
public sealed class PresentationComment : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets the author of the comment. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedTime { get; } | Gets the created time of the comment. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SlideNumber { get; } | Gets the slide number the comment belongs to. |
| Text { get; } | Gets the text of the comment. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationcomment/author.md

#### PresentationComment.Author property

Gets the author of the comment.

```csharp
public string Author { get; }
```

##### Property Value

The author of the comment.

### CreatedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationcomment/createdtime.md

#### PresentationComment.CreatedTime property

Gets the created time of the comment.

```csharp
public DateTime CreatedTime { get; }
```

##### Property Value

The created time of the comment.

### SlideNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationcomment/slidenumber.md

#### PresentationComment.SlideNumber property

Gets the slide number the comment belongs to.

```csharp
public int SlideNumber { get; }
```

##### Property Value

The slide number the comment belongs to.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationcomment/text.md

#### PresentationComment.Text property

Gets the text of the comment.

```csharp
public string Text { get; }
```

##### Property Value

The comment text.

### PresentationFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationformat.md

#### PresentationFormat enumeration

Defines various presentation subformats.

```csharp
public enum PresentationFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format is not recognized. |
| Ppt | `1` | Represents the .PPT PowerPoint format. 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. A PPT file can contain several different types of information such as text, bulleted points, images, multimedia and other embedded OLE objects. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt/). |
| Pptx | `2` | Represents the .PPTX PowerPoint format. 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/). |
| Potm | `3` | Represents the .POTM PowerPoint format. 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/). |
| Potx | `4` | Represents the .POTX PowerPoint format. Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. This format was created to replace the POT file format that is based on the binary file format and is supported with PowerPoint 97-2003. Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx/). |
| Pptm | `5` | Represents the .PPTM PowerPoint format. Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. They are similar to PPTX files with the difference that the lateral can't execute macros though they can contain macros. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm/). |
| Pps | `6` | Represents the .PPS PowerPoint format. 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/). |
| Ppsx | `7` | Represents the .PPSX PowerPoint format. PPSX, Power Point Slide Show, files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. It is an update to the PPS file format that was supported by Microsoft PowerPoint 97-2003 versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx/). |
| Ppsm | `8` | Represents the .PPSM PowerPoint format. Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Another similar file format is PPTM which differs in opening with Microsoft PowerPoint in editable format instead of running as Slide Show Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm/). |
| Pot | `9` | Represents the .POT PowerPoint format. Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Files created with these versions of Microsoft PowerPoint are in binary format as compared to those created in Office OpenXML file formats using the higher versions of PowerPoint. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot/). |

### PresentationInspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage.md

#### PresentationInspectionPackage class

Contains information about presentation parts that can be considered as metadata in some cases.

```csharp
public sealed class PresentationInspectionPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Comments { get; } | Gets an array of the comments. |
| Count { get; } | Gets the number of metadata properties. |
| HiddenSlides { get; } | Gets an array of the hidden slides. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearComments() | Removes all detected user comments from the presentation. |
| ClearHiddenSlides() | Removes all detected hidden slides from the presentation. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to clean inspection properties in a presentation.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPpt))
{
    var root = metadata.GetRootPackage<PresentationRootPackage>();

    root.InspectionPackage.ClearComments();
    root.InspectionPackage.ClearHiddenSlides();

    metadata.Save(Constants.OutputPpt);
}
```

### ClearComments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/clearcomments.md

#### PresentationInspectionPackage.ClearComments method

Removes all detected user comments from the presentation.

```csharp
public void ClearComments()
```

### ClearHiddenSlides
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/clearhiddenslides.md

#### PresentationInspectionPackage.ClearHiddenSlides method

Removes all detected hidden slides from the presentation.

```csharp
public void ClearHiddenSlides()
```

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/comments.md

#### PresentationInspectionPackage.Comments property

Gets an array of the comments.

```csharp
public PresentationComment[] Comments { get; }
```

##### Property Value

The comments.

### HiddenSlides
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/hiddenslides.md

#### PresentationInspectionPackage.HiddenSlides property

Gets an array of the hidden slides.

```csharp
public PresentationSlide[] HiddenSlides { get; }
```

##### Property Value

The hidden slides.

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/removeproperties.md

#### PresentationInspectionPackage.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public override int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationinspectionpackage/sanitize.md

#### PresentationInspectionPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### PresentationPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage.md

#### PresentationPackage class

Represents a native metadata package in a presentation.

```csharp
public class PresentationPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| ApplicationTemplate { get; set; } | Gets or sets the application template. |
| Author { get; set; } | Gets or sets the document's author. |
| Category { get; set; } | Gets or sets the category. |
| Comments { get; set; } | Gets or sets the comments. |
| Company { get; set; } | Gets or sets the company. |
| ContentStatus { get; set; } | Gets or sets the content status. Can be updated in a PPTX document only. |
| ContentType { get; set; } | Gets or sets the content type. Can be updated in a PPTX document only. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedTime { get; set; } | Gets or sets the document created date. |
| HyperlinkBase { get; set; } | Gets or sets the hyperlink base. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| LastPrintedDate { get; set; } | Gets or sets the last printed date. |
| LastSavedBy { get; set; } | Gets or sets the name of the last author. |
| LastSavedTime { get; } | Gets the date and time when the presentation was modified last time. |
| Manager { get; set; } | Gets or sets the manager. |
| MetadataType { get; } | Gets the metadata type. |
| NameOfApplication { get; } | Gets the name of the application created the document. |
| PresentationFormat { get; } | Gets the presentation format. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RevisionNumber { get; set; } | Gets or sets the revision number. |
| SharedDoc { get; set; } | Gets or sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only. |
| Subject { get; set; } | Gets or sets the subject. |
| Title { get; set; } | Gets or sets the title of the document. |
| TotalEditingTime { get; set; } | Gets or sets the total editing time of the document. |
| Version { get; } | Gets the application version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Adds or replaces the metadata property with the specified name. |
| Set(string, DateTime) | Adds or replaces the metadata property with the specified name. |
| Set(string, double) | Adds or replaces the metadata property with the specified name. |
| Set(string, int) | Adds or replaces the metadata property with the specified name. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to update built-in metadata properties in a presentation.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPptx))
{
    var root = metadata.GetRootPackage<PresentationRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedTime = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Category = "test category";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputPptx);
}
```

### ApplicationTemplate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/applicationtemplate.md

#### PresentationPackage.ApplicationTemplate property

Gets or sets the application template.

```csharp
public string ApplicationTemplate { get; set; }
```

##### Property Value

The application template.

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/author.md

#### PresentationPackage.Author property

Gets or sets the document's author.

```csharp
public string Author { get; set; }
```

##### Property Value

The author.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/category.md

#### PresentationPackage.Category property

Gets or sets the category.

```csharp
public string Category { get; set; }
```

##### Property Value

The category.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/comments.md

#### PresentationPackage.Comments property

Gets or sets the comments.

```csharp
public string Comments { get; set; }
```

##### Property Value

The comments.

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/company.md

#### PresentationPackage.Company property

Gets or sets the company.

```csharp
public string Company { get; set; }
```

##### Property Value

The company.

### ContentStatus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/contentstatus.md

#### PresentationPackage.ContentStatus property

Gets or sets the content status. Can be updated in a PPTX document only.

```csharp
public string ContentStatus { get; set; }
```

##### Property Value

The content status.

##### Remarks

Can be updated in a PPTX document only. Read-only for other supported formats.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/contenttype.md

#### PresentationPackage.ContentType property

Gets or sets the content type. Can be updated in a PPTX document only.

```csharp
public string ContentType { get; set; }
```

##### Property Value

The type of the content.

##### Remarks

Can be updated in a PPTX document only. Read-only for other supported formats.

### CreatedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/createdtime.md

#### PresentationPackage.CreatedTime property

Gets or sets the document created date.

```csharp
public DateTime CreatedTime { get; set; }
```

##### Property Value

The document created date.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/hyperlinkbase.md

#### PresentationPackage.HyperlinkBase property

Gets or sets the hyperlink base.

```csharp
public string HyperlinkBase { get; set; }
```

##### Property Value

The hyperlink base.

##### Remarks

Read-only in old PPT.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/keywords.md

#### PresentationPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### LastPrintedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/lastprinteddate.md

#### PresentationPackage.LastPrintedDate property

Gets or sets the last printed date.

```csharp
public DateTime LastPrintedDate { get; set; }
```

##### Property Value

The last printed date.

### LastSavedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/lastsavedby.md

#### PresentationPackage.LastSavedBy property

Gets or sets the name of the last author.

```csharp
public string LastSavedBy { get; set; }
```

##### Property Value

The last saved by.

### LastSavedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/lastsavedtime.md

#### PresentationPackage.LastSavedTime property

Gets the date and time when the presentation was modified last time.

```csharp
public DateTime LastSavedTime { get; }
```

##### Property Value

The last saved time.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/manager.md

#### PresentationPackage.Manager property

Gets or sets the manager.

```csharp
public string Manager { get; set; }
```

##### Property Value

The manager.

### NameOfApplication
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/nameofapplication.md

#### PresentationPackage.NameOfApplication property

Gets the name of the application created the document.

```csharp
public string NameOfApplication { get; }
```

##### Property Value

The name of the application.

### PresentationFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/presentationformat.md

#### PresentationPackage.PresentationFormat property

Gets the presentation format.

```csharp
public string PresentationFormat { get; }
```

##### Property Value

The presentation format.

### RevisionNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/revisionnumber.md

#### PresentationPackage.RevisionNumber property

Gets or sets the revision number.

```csharp
public int RevisionNumber { get; set; }
```

##### Property Value

The revision number.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/set.md

#### Set(string, string)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

#### Set(string, bool)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Boolean | The property value. |

#### Set(string, DateTime)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | DateTime | The property value. |

#### Set(string, int)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Int32 | The property value. |

#### Set(string, double)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Double | The property value. |

### SharedDoc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/shareddoc.md

#### PresentationPackage.SharedDoc property

Gets or sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

```csharp
public bool SharedDoc { get; set; }
```

##### Property Value

`true` if the presentation shared between multiple people; otherwise, `false`.

##### Remarks

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/subject.md

#### PresentationPackage.Subject property

Gets or sets the subject.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/title.md

#### PresentationPackage.Title property

Gets or sets the title of the document.

```csharp
public string Title { get; set; }
```

##### Property Value

The title.

### TotalEditingTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/totaleditingtime.md

#### PresentationPackage.TotalEditingTime property

Gets or sets the total editing time of the document.

```csharp
public TimeSpan TotalEditingTime { get; set; }
```

##### Property Value

The total editing time of the document.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationpackage/version.md

#### PresentationPackage.Version property

Gets the application version.

```csharp
public string Version { get; }
```

##### Property Value

The application version.

### PresentationRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationrootpackage.md

#### PresentationRootPackage class

Represents the root package intended to work with metadata in a presentation.

```csharp
public class PresentationRootPackage : DocumentRootPackage<PresentationPackage>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| FileType { get; } | Gets the file type metadata package. (2 properties) |
| InspectionPackage { get; } | Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to extract built-in metadata properties from a presentation.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPpt))
{
    var root = metadata.GetRootPackage<PresentationRootPackage>();

    Console.WriteLine(root.DocumentProperties.Author);
    Console.WriteLine(root.DocumentProperties.CreatedTime);
    Console.WriteLine(root.DocumentProperties.Company);
    Console.WriteLine(root.DocumentProperties.Category);
    Console.WriteLine(root.DocumentProperties.Keywords);
    Console.WriteLine(root.DocumentProperties.LastPrintedDate);
    Console.WriteLine(root.DocumentProperties.NameOfApplication);

    // ... 
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationrootpackage/documentstatistics.md

#### PresentationRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

##### Examples

This code sample demonstrates how to obtain simple text statistics for a presentation.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPpt))
{
    var root = metadata.GetRootPackage<PresentationRootPackage>();

    Console.WriteLine(root.DocumentStatistics.CharacterCount);
    Console.WriteLine(root.DocumentStatistics.PageCount);
    Console.WriteLine(root.DocumentStatistics.WordCount);
}
```

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationrootpackage/filetype.md

#### PresentationRootPackage.FileType property

Gets the file type metadata package.

```csharp
public PresentationTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

##### Examples

This example demonstrates how to detect the exact type of a presentation and extract some additional file format information.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPptx))
{
    var root = metadata.GetRootPackage<PresentationRootPackage>();

    Console.WriteLine(root.FileType.FileFormat);
    Console.WriteLine(root.FileType.PresentationFormat);
    Console.WriteLine(root.FileType.MimeType);
    Console.WriteLine(root.FileType.Extension);
}
```

### InspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationrootpackage/inspectionpackage.md

#### PresentationRootPackage.InspectionPackage property

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

```csharp
public PresentationInspectionPackage InspectionPackage { get; }
```

##### Property Value

A metadata package containing inspection results for the document.

##### Examples

This code sample demonstrates how to inspect a presentation.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPpt))
{
     var root = metadata.GetRootPackage<PresentationRootPackage>();

     if (root.InspectionPackage.Comments != null)
     {
         foreach (var comment in root.InspectionPackage.Comments)
         {
             Console.WriteLine(comment.Author);
             Console.WriteLine(comment.Text);
             Console.WriteLine(comment.CreatedTime);
             Console.WriteLine(comment.SlideNumber);
         }
     }

     if (root.InspectionPackage.HiddenSlides != null)
     {
         foreach (var slide in root.InspectionPackage.HiddenSlides)
         {
             Console.WriteLine(slide.Name);
             Console.WriteLine(slide.Number);
             Console.WriteLine(slide.SlideId);
         }
     }
}
```

### PresentationSlide
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationslide.md

#### PresentationSlide class

Represents a slide in a presentation.

```csharp
public sealed class PresentationSlide : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the slide name. |
| Number { get; } | Gets the slide number. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SlideId { get; } | Gets the slide id. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationslide/name.md

#### PresentationSlide.Name property

Gets the slide name.

```csharp
public string Name { get; }
```

##### Property Value

The slide name.

### Number
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationslide/number.md

#### PresentationSlide.Number property

Gets the slide number.

```csharp
public int Number { get; }
```

##### Property Value

The slide number.

### SlideId
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationslide/slideid.md

#### PresentationSlide.SlideId property

Gets the slide id.

```csharp
public uint SlideId { get; }
```

##### Property Value

The slide identifier.

### PresentationTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationtypepackage.md

#### PresentationTypePackage class

Represents a metadata package containing presentation-specific file format information.

```csharp
public class PresentationTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PresentationFormat { get; } | Gets the exact presentation format. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### PresentationFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/presentationtypepackage/presentationformat.md

#### PresentationTypePackage.PresentationFormat property

Gets the exact presentation format.

```csharp
public PresentationFormat PresentationFormat { get; }
```

##### Property Value

The exact presentation format.

### ProjectManagementPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage.md

#### ProjectManagementPackage class

Represents a native metadata package in a project management file.

```csharp
public sealed class ProjectManagementPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the author of the project. |
| Category { get; set; } | Gets or sets the category. |
| Comments { get; set; } | Gets or sets the user comments. |
| Company { get; set; } | Gets or sets the company. |
| Count { get; } | Gets the number of metadata properties. |
| CreationDate { get; set; } | Gets or sets the creation date. |
| Guid { get; set; } | Gets or sets the id of the project. |
| HyperlinkBase { get; set; } | Gets or sets the hyperlink base. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| LastAuthor { get; set; } | Gets or sets the last author. |
| LastPrinted { get; set; } | Gets or sets the project's last print time. |
| LastSaved { get; set; } | Gets or sets the date when the project was saved last time. |
| Manager { get; set; } | Gets or sets the project manager. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Revision { get; set; } | Gets or sets the revision number. |
| SaveVersion { get; } | Gets the version of Microsoft Office Project from which a project file was saved. |
| Subject { get; set; } | Gets or sets the subject. |
| Template { get; set; } | Gets or sets the template. |
| Title { get; set; } | Gets or sets the title. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Adds or replaces the metadata property with the specified name. |
| Set(string, DateTime) | Adds or replaces the metadata property with the specified name. |
| Set(string, double) | Adds or replaces the metadata property with the specified name. |
| Set(string, int) | Adds or replaces the metadata property with the specified name. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to update built-in properties in a ProjectManagement document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMpp))
{
    var root = metadata.GetRootPackage<ProjectManagementRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreationDate = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Comments = "test comment";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputMpp);
}
```

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/author.md

#### ProjectManagementPackage.Author property

Gets or sets the author of the project.

```csharp
public string Author { get; set; }
```

##### Property Value

The author of the project.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/category.md

#### ProjectManagementPackage.Category property

Gets or sets the category.

```csharp
public string Category { get; set; }
```

##### Property Value

The category.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/comments.md

#### ProjectManagementPackage.Comments property

Gets or sets the user comments.

```csharp
public string Comments { get; set; }
```

##### Property Value

The user comments.

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/company.md

#### ProjectManagementPackage.Company property

Gets or sets the company.

```csharp
public string Company { get; set; }
```

##### Property Value

The company.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/creationdate.md

#### ProjectManagementPackage.CreationDate property

Gets or sets the creation date.

```csharp
public DateTime CreationDate { get; set; }
```

##### Property Value

The creation date.

### Guid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/guid.md

#### ProjectManagementPackage.Guid property

Gets or sets the id of the project.

```csharp
public Guid Guid { get; set; }
```

##### Property Value

The id of the project.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/hyperlinkbase.md

#### ProjectManagementPackage.HyperlinkBase property

Gets or sets the hyperlink base.

```csharp
public string HyperlinkBase { get; set; }
```

##### Property Value

The hyperlink base.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/keywords.md

#### ProjectManagementPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### LastAuthor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/lastauthor.md

#### ProjectManagementPackage.LastAuthor property

Gets or sets the last author.

```csharp
public string LastAuthor { get; set; }
```

##### Property Value

The last author.

### LastPrinted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/lastprinted.md

#### ProjectManagementPackage.LastPrinted property

Gets or sets the project's last print time.

```csharp
public DateTime LastPrinted { get; set; }
```

##### Property Value

The project's last print time.

### LastSaved
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/lastsaved.md

#### ProjectManagementPackage.LastSaved property

Gets or sets the date when the project was saved last time.

```csharp
public DateTime LastSaved { get; set; }
```

##### Property Value

The date when the project was saved last time.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/manager.md

#### ProjectManagementPackage.Manager property

Gets or sets the project manager.

```csharp
public string Manager { get; set; }
```

##### Property Value

The project manager.

### Revision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/revision.md

#### ProjectManagementPackage.Revision property

Gets or sets the revision number.

```csharp
public int Revision { get; set; }
```

##### Property Value

The revision number.

### SaveVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/saveversion.md

#### ProjectManagementPackage.SaveVersion property

Gets the version of Microsoft Office Project from which a project file was saved.

```csharp
public int SaveVersion { get; }
```

##### Property Value

The version of Microsoft Office Project from which a project file was saved.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/set.md

#### Set(string, string)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

#### Set(string, double)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Double | The property value. |

#### Set(string, bool)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Boolean | The property value. |

#### Set(string, DateTime)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | DateTime | The property value. |

#### Set(string, int)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Int32 | The property value. |

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/subject.md

#### ProjectManagementPackage.Subject property

Gets or sets the subject.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject.

### Template
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/template.md

#### ProjectManagementPackage.Template property

Gets or sets the template.

```csharp
public string Template { get; set; }
```

##### Property Value

The template.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementpackage/title.md

#### ProjectManagementPackage.Title property

Gets or sets the title.

```csharp
public string Title { get; set; }
```

##### Property Value

The title.

### ProjectManagementRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/projectmanagementrootpackage.md

#### ProjectManagementRootPackage class

Represents the root package intended to work with metadata in a project management format.

```csharp
public class ProjectManagementRootPackage : DocumentRootPackage<ProjectManagementPackage>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to extract built-in properties of a ProjectManagement document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMpp))
{
    var root = metadata.GetRootPackage<ProjectManagementRootPackage>();

    Console.WriteLine(root.DocumentProperties.Author);
    Console.WriteLine(root.DocumentProperties.CreationDate);
    Console.WriteLine(root.DocumentProperties.Company);
    Console.WriteLine(root.DocumentProperties.Category);
    Console.WriteLine(root.DocumentProperties.Keywords);
    Console.WriteLine(root.DocumentProperties.Revision);
    Console.WriteLine(root.DocumentProperties.Subject);

    // ... 
}
```

### SpreadsheetComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment.md

#### SpreadsheetComment class

Represents a user comment in a spreadsheet.

```csharp
public class SpreadsheetComment : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets the author of the comment. |
| Column { get; } | Gets the one-based column index of the comment. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Row { get; } | Gets the one-based row index of the comment. |
| SheetNumber { get; } | Gets the sheet number. |
| Text { get; } | Gets the comment text. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment/author.md

#### SpreadsheetComment.Author property

Gets the author of the comment.

```csharp
public string Author { get; }
```

##### Property Value

The author of the comment.

### Column
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment/column.md

#### SpreadsheetComment.Column property

Gets the one-based column index of the comment.

```csharp
public int Column { get; }
```

##### Property Value

The column index of the comment.

### Row
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment/row.md

#### SpreadsheetComment.Row property

Gets the one-based row index of the comment.

```csharp
public int Row { get; }
```

##### Property Value

The row index of the comment.

### SheetNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment/sheetnumber.md

#### SpreadsheetComment.SheetNumber property

Gets the sheet number.

```csharp
public int SheetNumber { get; }
```

##### Property Value

The sheet number.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcomment/text.md

#### SpreadsheetComment.Text property

Gets the comment text.

```csharp
public string Text { get; }
```

##### Property Value

The comment text.

### SpreadsheetContentTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage.md

#### SpreadsheetContentTypePackage class

Represents a metadata package containing spreadsheet content type properties.

```csharp
public class SpreadsheetContentTypePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes the content type property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, string) | Adds or replaces the content type property with the specified name. |
| Set(string, string, string) | Adds or replaces the content type property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/clear.md

#### SpreadsheetContentTypePackage.Clear method

Removes all writable metadata properties.

```csharp
public void Clear()
```

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/remove.md

#### SpreadsheetContentTypePackage.Remove method

Removes the content type property with the specified name.

```csharp
public bool Remove(string propertyName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The name of the content type property to be removed. |

##### Return Value

`true` if the property is found and deleted; otherwise `false`.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/set.md

#### Set(string, string)

Adds or replaces the content type property with the specified name.

```csharp
public void Set(string propertyName, string propertyValue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| propertyValue | String | The property value. |

#### Set(string, string, string)

Adds or replaces the content type property with the specified name.

```csharp
public void Set(string propertyName, string propertyValue, string propertyType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| propertyValue | String | The property value. |
| propertyType | String | The property type. |

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/tolist.md

#### SpreadsheetContentTypePackage.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<SpreadsheetContentTypeProperty> ToList()
```

##### Return Value

A list that contains properties from the package.

### SpreadsheetContentTypeProperty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty.md

#### SpreadsheetContentTypeProperty class

Represents a content type property in a spreadsheet.

```csharp
public sealed class SpreadsheetContentTypeProperty : MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| SpreadsheetPropertyType { get; } | Gets the type of the property. |
| SpreadsheetPropertyValue { get; } | Gets the value of the property. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### SpreadsheetPropertyType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/spreadsheetpropertytype.md

#### SpreadsheetContentTypeProperty.SpreadsheetPropertyType property

Gets the type of the property.

```csharp
public string SpreadsheetPropertyType { get; }
```

##### Property Value

The type of the property.

### SpreadsheetPropertyValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/spreadsheetpropertyvalue.md

#### SpreadsheetContentTypeProperty.SpreadsheetPropertyValue property

Gets the value of the property.

```csharp
public string SpreadsheetPropertyValue { get; }
```

##### Property Value

The value of the property.

### SpreadsheetFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetformat.md

#### SpreadsheetFormat enumeration

Defines various spreadsheet subformats.

```csharp
public enum SpreadsheetFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format is not recognized. |
| Xls | `1` | Represents the .XLS Excel format. Files with XLS extension represent 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. File saved by Excel is known as Workbook where each workbook can have one or more worksheets. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls/). |
| Xlsb | `2` | Represents the .XLSB Excel format. XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. The content can include unstructured or semi-structured tables of numbers, text, or both numbers and text, formulas, external data connections, charts and images. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb/). |
| Xlsx | `3` | Represents the .XLSX Excel format. XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Based on structure organized according to the Open Packaging Conventions as outlined in Part 2 of the OOXML standard ECMA-376, the new format is a zip package that contains a number of XML files. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx/). |
| Xlsm | `4` | Represents the .XLSM Excel format. Files with XLSM extension is a type of Spreasheet files that support Macros. From application point of view, a Macro is set of instructions that are used for automating processes. A macro is used to record the steps that are performed repeatedly and facilitates performing the actions by running the macro again. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm/). |
| Xltx | `5` | Represents the .XLTX Excel format. Files with XLTX extension represent Microsoft Excel Template files 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/). |
| Xltm | `6` | Represents the .XLTM Excel format. 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. Such template files are used to generate and set the layout, formatting, and other settings along with the macros to facilitate creating similar XLSX files then. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm/). |
| Ods | `7` | Represents the Opendocument Spreadsheet format. 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. It is XML-based format and is one of the several subtypes in the Open Document Formats (ODF) family. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/). |
| Xlt | `8` | Represents the .XLT Excel format. 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. The latest version of Excel is still capable of opening this old format template files. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt/). |

### SpreadsheetInspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage.md

#### SpreadsheetInspectionPackage class

Contains information about spreadsheet parts that can be considered as metadata in some cases.

```csharp
public sealed class SpreadsheetInspectionPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Comments { get; } | Gets an array of the user comments. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalSignatures { get; } | Gets an array of digital signatures presented in the document. |
| HiddenSheets { get; } | Gets an array of the hidden sheets. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearComments() | Removes all detected user comments from the spreadsheet. |
| ClearDigitalSignatures() | Removes all detected digital signatures from the spreadsheet. |
| ClearHiddenSheets() | Removes all detected hidden sheets from the spreadsheet. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows hot to remove inspection properties from a spreadsheet.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    var root = metadata.GetRootPackage<SpreadsheetRootPackage>();

    root.InspectionPackage.ClearComments();
    root.InspectionPackage.ClearDigitalSignatures();
    root.InspectionPackage.ClearHiddenSheets();

    metadata.Save(Constants.OutputXlsx);
}
```

### ClearComments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/clearcomments.md

#### SpreadsheetInspectionPackage.ClearComments method

Removes all detected user comments from the spreadsheet.

```csharp
public void ClearComments()
```

### ClearDigitalSignatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/cleardigitalsignatures.md

#### SpreadsheetInspectionPackage.ClearDigitalSignatures method

Removes all detected digital signatures from the spreadsheet.

```csharp
public void ClearDigitalSignatures()
```

### ClearHiddenSheets
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/clearhiddensheets.md

#### SpreadsheetInspectionPackage.ClearHiddenSheets method

Removes all detected hidden sheets from the spreadsheet.

```csharp
public void ClearHiddenSheets()
```

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/comments.md

#### SpreadsheetInspectionPackage.Comments property

Gets an array of the user comments.

```csharp
public SpreadsheetComment[] Comments { get; }
```

##### Property Value

The user comments.

### DigitalSignatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/digitalsignatures.md

#### SpreadsheetInspectionPackage.DigitalSignatures property

Gets an array of digital signatures presented in the document.

```csharp
public DigitalSignature[] DigitalSignatures { get; }
```

##### Property Value

The digital signatures.

### HiddenSheets
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/hiddensheets.md

#### SpreadsheetInspectionPackage.HiddenSheets property

Gets an array of the hidden sheets.

```csharp
public SpreadsheetSheet[] HiddenSheets { get; }
```

##### Property Value

The hidden sheets.

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/removeproperties.md

#### SpreadsheetInspectionPackage.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public override int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/sanitize.md

#### SpreadsheetInspectionPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### SpreadsheetPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage.md

#### SpreadsheetPackage class

Represents a native metadata package in a spreadsheet.

```csharp
public class SpreadsheetPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the document author. |
| Category { get; set; } | Gets or sets the category. |
| Comments { get; set; } | Gets or sets the comments. |
| Company { get; set; } | Gets or sets the company. |
| ContentStatus { get; set; } | Gets or sets the content status. |
| ContentType { get; set; } | Gets or sets the content type. |
| ContentTypeProperties { get; } | Gets the metadata package containing the content type properties. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedTime { get; set; } | Gets or sets the document created date. |
| HyperlinkBase { get; set; } | Gets or sets the hyperlink base. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| Language { get; set; } | Gets or sets the document language. |
| LastPrintedDate { get; set; } | Gets or sets the last printed date in UTC. |
| LastSavedBy { get; set; } | Gets or sets the name of the last author. |
| LastSavedTime { get; set; } | Gets or sets the time of the last saving in UTC. |
| Manager { get; set; } | Gets or sets the manager. |
| MetadataType { get; } | Gets the metadata type. |
| NameOfApplication { get; set; } | Gets or sets the name of application. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Revision { get; set; } | Gets or sets the document revision number. |
| Subject { get; set; } | Gets or sets the subject. |
| Template { get; set; } | Gets or sets the document template name. |
| Title { get; set; } | Gets or sets the title of the document. |
| TotalEditingTime { get; set; } | Gets or sets the total editing time in minutes. |
| Version { get; set; } | Gets or sets the version number of the application that created the document. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Adds or replaces the metadata property with the specified name. |
| Set(string, DateTime) | Adds or replaces the metadata property with the specified name. |
| Set(string, double) | Adds or replaces the metadata property with the specified name. |
| Set(string, int) | Adds or replaces the metadata property with the specified name. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to update built-in metadata properties in a spreadsheet.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    var root = metadata.GetRootPackage<SpreadsheetRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedTime = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Category = "test category";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputXlsx);
}
```

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/author.md

#### SpreadsheetPackage.Author property

Gets or sets the document author.

```csharp
public string Author { get; set; }
```

##### Property Value

The author.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/category.md

#### SpreadsheetPackage.Category property

Gets or sets the category.

```csharp
public string Category { get; set; }
```

##### Property Value

The category.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/comments.md

#### SpreadsheetPackage.Comments property

Gets or sets the comments.

```csharp
public string Comments { get; set; }
```

##### Property Value

Comments value.

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/company.md

#### SpreadsheetPackage.Company property

Gets or sets the company.

```csharp
public string Company { get; set; }
```

##### Property Value

The company.

### ContentStatus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/contentstatus.md

#### SpreadsheetPackage.ContentStatus property

Gets or sets the content status.

```csharp
public string ContentStatus { get; set; }
```

##### Property Value

The content status.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/contenttype.md

#### SpreadsheetPackage.ContentType property

Gets or sets the content type.

```csharp
public string ContentType { get; set; }
```

##### Property Value

The type of the content.

### ContentTypeProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/contenttypeproperties.md

#### SpreadsheetPackage.ContentTypeProperties property

Gets the metadata package containing the content type properties.

```csharp
public SpreadsheetContentTypePackage ContentTypeProperties { get; }
```

##### Property Value

The metadata package containing the content type properties.

### CreatedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/createdtime.md

#### SpreadsheetPackage.CreatedTime property

Gets or sets the document created date.

```csharp
public DateTime? CreatedTime { get; set; }
```

##### Property Value

The created time.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/hyperlinkbase.md

#### SpreadsheetPackage.HyperlinkBase property

Gets or sets the hyperlink base.

```csharp
public string HyperlinkBase { get; set; }
```

##### Property Value

The hyperlink base.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/keywords.md

#### SpreadsheetPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

Keywords.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/language.md

#### SpreadsheetPackage.Language property

Gets or sets the document language.

```csharp
public string Language { get; set; }
```

##### Property Value

The document language.

### LastPrintedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/lastprinteddate.md

#### SpreadsheetPackage.LastPrintedDate property

Gets or sets the last printed date in UTC.

```csharp
public DateTime? LastPrintedDate { get; set; }
```

##### Property Value

The last printed date.

### LastSavedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/lastsavedby.md

#### SpreadsheetPackage.LastSavedBy property

Gets or sets the name of the last author.

```csharp
public string LastSavedBy { get; set; }
```

##### Property Value

The name of the last author.

### LastSavedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/lastsavedtime.md

#### SpreadsheetPackage.LastSavedTime property

Gets or sets the time of the last saving in UTC.

```csharp
public DateTime? LastSavedTime { get; set; }
```

##### Property Value

The time of the last saving.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/manager.md

#### SpreadsheetPackage.Manager property

Gets or sets the manager.

```csharp
public string Manager { get; set; }
```

##### Property Value

The manager.

### NameOfApplication
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/nameofapplication.md

#### SpreadsheetPackage.NameOfApplication property

Gets or sets the name of application.

```csharp
public string NameOfApplication { get; set; }
```

##### Property Value

The name of application.

### Revision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/revision.md

#### SpreadsheetPackage.Revision property

Gets or sets the document revision number.

```csharp
public string Revision { get; set; }
```

##### Property Value

The revision number.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/set.md

#### Set(string, string)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

#### Set(string, bool)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Boolean | The property value. |

#### Set(string, DateTime)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | DateTime | The property value. |

#### Set(string, int)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Int32 | The property value. |

#### Set(string, double)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Double | The property value. |

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/subject.md

#### SpreadsheetPackage.Subject property

Gets or sets the subject.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject.

### Template
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/template.md

#### SpreadsheetPackage.Template property

Gets or sets the document template name.

```csharp
public string Template { get; set; }
```

##### Property Value

The template.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/title.md

#### SpreadsheetPackage.Title property

Gets or sets the title of the document.

```csharp
public string Title { get; set; }
```

##### Property Value

The title.

### TotalEditingTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/totaleditingtime.md

#### SpreadsheetPackage.TotalEditingTime property

Gets or sets the total editing time in minutes.

```csharp
public double? TotalEditingTime { get; set; }
```

##### Property Value

The total editing time.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetpackage/version.md

#### SpreadsheetPackage.Version property

Gets or sets the version number of the application that created the document.

```csharp
public string Version { get; set; }
```

##### Property Value

The version.

##### Remarks

Its format is "00.0000",for example 12.0000

### SpreadsheetRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetrootpackage.md

#### SpreadsheetRootPackage class

Represents the root package allowing working with metadata in a spreadsheet.

```csharp
public class SpreadsheetRootPackage : DocumentRootPackage<SpreadsheetPackage>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| FileType { get; } | Gets the file type metadata package. (2 properties) |
| InspectionPackage { get; } | Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code snippet demonstrates how to extract built-in metadata properties from a spreadsheet.

```csharp
/// using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    var root = metadata.GetRootPackage<SpreadsheetRootPackage>();

    Console.WriteLine(root.DocumentProperties.Author);
    Console.WriteLine(root.DocumentProperties.CreatedTime);
    Console.WriteLine(root.DocumentProperties.Company);
    Console.WriteLine(root.DocumentProperties.Category);
    Console.WriteLine(root.DocumentProperties.Keywords);
    Console.WriteLine(root.DocumentProperties.Language);
    Console.WriteLine(root.DocumentProperties.ContentType);

    // ... 
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetrootpackage/documentstatistics.md

#### SpreadsheetRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetrootpackage/filetype.md

#### SpreadsheetRootPackage.FileType property

Gets the file type metadata package.

```csharp
public SpreadsheetTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

##### Examples

This example shows how to detect the exact type of a loaded spreadsheet and extract some additional file format information.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    var root = metadata.GetRootPackage<SpreadsheetRootPackage>();

    Console.WriteLine(root.FileType.FileFormat);
    Console.WriteLine(root.FileType.SpreadsheetFormat);
    Console.WriteLine(root.FileType.MimeType);
    Console.WriteLine(root.FileType.Extension);
}
```

### InspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetrootpackage/inspectionpackage.md

#### SpreadsheetRootPackage.InspectionPackage property

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

```csharp
public SpreadsheetInspectionPackage InspectionPackage { get; }
```

##### Property Value

A metadata package containing inspection results for the document.

##### Examples

This code snippet shows how to inspect a spreadsheet document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXls))
{
    var root = metadata.GetRootPackage<SpreadsheetRootPackage>();

    if (root.InspectionPackage.Comments != null)
    {
        foreach (var comment in root.InspectionPackage.Comments)
        {
            Console.WriteLine(comment.Author);
            Console.WriteLine(comment.Text);
            Console.WriteLine(comment.SheetNumber);
            Console.WriteLine(comment.Row);
            Console.WriteLine(comment.Column);
        }
    }

    if (root.InspectionPackage.DigitalSignatures != null)
    {
        foreach (var signature in root.InspectionPackage.DigitalSignatures)
        {
            Console.WriteLine(signature.CertificateSubject);
            Console.WriteLine(signature.Comments);
            Console.WriteLine(signature.SignTime);

            // ...
        }
    }

    if (root.InspectionPackage.HiddenSheets != null)
    {
        foreach (var sheet in root.InspectionPackage.HiddenSheets)
        {
            Console.WriteLine(sheet.Name);
            Console.WriteLine(sheet.Number);
        }
    }
}
```

### SpreadsheetSheet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetsheet.md

#### SpreadsheetSheet class

Represents a sheet in a spreadsheet document.

```csharp
public sealed class SpreadsheetSheet : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the sheet name. |
| Number { get; } | Gets the sheet number. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetsheet/name.md

#### SpreadsheetSheet.Name property

Gets the sheet name.

```csharp
public string Name { get; }
```

##### Property Value

The sheet name.

### Number
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheetsheet/number.md

#### SpreadsheetSheet.Number property

Gets the sheet number.

```csharp
public int Number { get; }
```

##### Property Value

The sheet number.

### SpreadsheetTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheettypepackage.md

#### SpreadsheetTypePackage class

Represents a metadata package containing spreadsheet-specific file format information.

```csharp
public class SpreadsheetTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SpreadsheetFormat { get; } | Gets the exact spreadsheet format. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### SpreadsheetFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/spreadsheettypepackage/spreadsheetformat.md

#### SpreadsheetTypePackage.SpreadsheetFormat property

Gets the exact spreadsheet format.

```csharp
public SpreadsheetFormat SpreadsheetFormat { get; }
```

##### Property Value

The exact spreadsheet format.

### WordProcessingComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment.md

#### WordProcessingComment class

Represents a comment in a word processing document.

```csharp
public sealed class WordProcessingComment : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the author. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedDate { get; set; } | Gets or sets the date the comment was created. |
| Id { get; } | Gets the comment id. |
| Initials { get; set; } | Gets or sets the author's initials. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; set; } | Gets or sets the text of the comment. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment/author.md

#### WordProcessingComment.Author property

Gets or sets the author.

```csharp
public string Author { get; set; }
```

##### Property Value

The author.

### CreatedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment/createddate.md

#### WordProcessingComment.CreatedDate property

Gets or sets the date the comment was created.

```csharp
public DateTime CreatedDate { get; set; }
```

##### Property Value

The date the comment was created.

### Id
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment/id.md

#### WordProcessingComment.Id property

Gets the comment id.

```csharp
public int Id { get; }
```

##### Property Value

The comment identifier.

### Initials
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment/initials.md

#### WordProcessingComment.Initials property

Gets or sets the author's initials.

```csharp
public string Initials { get; set; }
```

##### Property Value

The initials of the author.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingcomment/text.md

#### WordProcessingComment.Text property

Gets or sets the text of the comment.

```csharp
public string Text { get; set; }
```

##### Property Value

The text of the comment.

### WordProcessingField
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingfield.md

#### WordProcessingField class

Represents a field in a word processing document.

```csharp
public class WordProcessingField : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Code { get; } | Gets the field code. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Result { get; } | Gets the field result. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Code
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingfield/code.md

#### WordProcessingField.Code property

Gets the field code.

```csharp
public string Code { get; }
```

##### Property Value

The field code.

### Result
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingfield/result.md

#### WordProcessingField.Result property

Gets the field result.

```csharp
public string Result { get; }
```

##### Property Value

The field result.

### WordProcessingFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingformat.md

#### WordProcessingFormat enumeration

Defines various word processing document subformats.

```csharp
public enum WordProcessingFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format is not recognized. |
| Doc | `1` | Represents the .DOC Word format. Files with .doc extension represent documents generated by Microsoft Word or other word processing applications in binary file format. The extension was initially used for plain text documentation on several different operating systems. It can contain several different types of data such as images, formatted as well as plain text, graphs, charts, embedded objects, links, pages, page formatting, print settings and a lot others. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/doc/). |
| Docm | `2` | Represents the .DOCM Word format. DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. It is similar to DOCX file format but the ability to run macros makes it different from DOCX. Like DOCX, DOCM files can be store text, images, tables, shapes, charts and other contents. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm/). |
| Docx | `3` | Represents the .DOCX Word format. 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. Docx files can be opened with Word 2007 and lateral versions but not with the earlier versions of MS Word which support DOC file extensions. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx/). |
| Dot | `4` | Represents the .DOT Word format. Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent files created from these. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot/). |
| Dotx | `5` | Represents the .DOTX Word format. Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent flies created from these. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx/). |
| Dotm | `6` | Represents the .DOTM Word format. A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. It is similar to the popular DOCX file format other than it retains the user defined settings for reuse in case of creating new documents. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm/). |
| Odt | `7` | Represents the .ODT format. ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |

### WordProcessingInspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage.md

#### WordProcessingInspectionPackage class

Contains information about document parts that can be considered as metadata in some cases.

```csharp
public sealed class WordProcessingInspectionPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Comments { get; } | Gets an array of the user comments. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalSignatures { get; } | Gets an array of digital signatures presented in the document. |
| Fields { get; } | Gets an array of document fields. |
| HiddenText { get; } | Gets an array of hidden text fragments extracted from the document. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Revisions { get; } | Gets an array of digital signatures presented in the document. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptAllRevisions() | Accepts all detected revisions in the document. |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearComments() | Removes all detected user comments from the document. |
| ClearFields() | Removes all detected fields from the document. |
| ClearHiddenText() | Removes all hidden text fragments from the document. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| RejectAllRevisions() | Rejects all detected revisions in the document. |
| override RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to update inspection properties in a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDoc))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    root.InspectionPackage.ClearComments();
    root.InspectionPackage.AcceptAllRevisions();
    root.InspectionPackage.ClearFields();
    root.InspectionPackage.ClearHiddenText();

    metadata.Save(Constants.OutputDoc);
}
```

### AcceptAllRevisions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/acceptallrevisions.md

#### WordProcessingInspectionPackage.AcceptAllRevisions method

Accepts all detected revisions in the document.

```csharp
public void AcceptAllRevisions()
```

### ClearComments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clearcomments.md

#### WordProcessingInspectionPackage.ClearComments method

Removes all detected user comments from the document.

```csharp
public void ClearComments()
```

### ClearFields
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clearfields.md

#### WordProcessingInspectionPackage.ClearFields method

Removes all detected fields from the document.

```csharp
public void ClearFields()
```

### ClearHiddenText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clearhiddentext.md

#### WordProcessingInspectionPackage.ClearHiddenText method

Removes all hidden text fragments from the document.

```csharp
public void ClearHiddenText()
```

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/comments.md

#### WordProcessingInspectionPackage.Comments property

Gets an array of the user comments.

```csharp
public WordProcessingComment[] Comments { get; }
```

##### Property Value

The user comments.

### DigitalSignatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/digitalsignatures.md

#### WordProcessingInspectionPackage.DigitalSignatures property

Gets an array of digital signatures presented in the document.

```csharp
public DigitalSignature[] DigitalSignatures { get; }
```

##### Property Value

The digital signatures.

### Fields
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/fields.md

#### WordProcessingInspectionPackage.Fields property

Gets an array of document fields.

```csharp
public WordProcessingField[] Fields { get; }
```

##### Property Value

An array of document fields.

### HiddenText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/hiddentext.md

#### WordProcessingInspectionPackage.HiddenText property

Gets an array of hidden text fragments extracted from the document.

```csharp
public string[] HiddenText { get; }
```

##### Property Value

An array of hidden text fragments extracted from the document.

### RejectAllRevisions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/rejectallrevisions.md

#### WordProcessingInspectionPackage.RejectAllRevisions method

Rejects all detected revisions in the document.

```csharp
public void RejectAllRevisions()
```

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/removeproperties.md

#### WordProcessingInspectionPackage.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public override int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

### Revisions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/revisions.md

#### WordProcessingInspectionPackage.Revisions property

Gets an array of digital signatures presented in the document.

```csharp
public WordProcessingRevision[] Revisions { get; }
```

##### Property Value

The digital signatures.

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/sanitize.md

#### WordProcessingInspectionPackage.Sanitize method

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

```csharp
public override int Sanitize()
```

##### Return Value

The number of affected properties.

### WordProcessingPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage.md

#### WordProcessingPackage class

Represents a native metadata package in a word processing document.

```csharp
public class WordProcessingPackage : DocumentPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the document's author. |
| BytesInDocument { get; } | Gets an estimate of the number of bytes in the document. |
| Category { get; set; } | Gets or sets the category. |
| Comments { get; set; } | Gets or sets the comments. |
| Company { get; set; } | Gets or sets the company. |
| ContentStatus { get; set; } | Gets or sets the content status. |
| ContentType { get; set; } | Gets or sets the content type of the document. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedTime { get; set; } | Gets or sets the document created date. |
| HyperlinkBase { get; set; } | Gets or sets the hyperlink base. |
| HyperlinksChanged { get; set; } | Gets or sets the Hyperlinks Changed of the document. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| LastPrintedDate { get; set; } | Gets or sets the last printed date. |
| LastSavedBy { get; set; } | Gets or sets the name of the last author. |
| LastSavedTime { get; set; } | Gets or sets the time of the last save. |
| LinksUpToDate { get; set; } | Gets or sets a value indicating whether the hyperlinks in the document are up-to-date. |
| Manager { get; set; } | Gets or sets the manager. |
| MetadataType { get; } | Gets the metadata type. |
| NameOfApplication { get; } | Gets the name of the application. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RevisionNumber { get; set; } | Gets or sets the revision number. |
| ScaleCrop { get; set; } | Gets or sets the ScaleCrop of the document. |
| SharedDoc { get; set; } | Gets or sets the SharedDoc of the document. |
| Subject { get; set; } | Gets or sets the subject. |
| Template { get; set; } | Gets or sets the template. |
| Title { get; set; } | Gets or sets the title of the document. |
| TitlesOfParts { get; } | Gets the titles of document parts. Read-only. |
| TotalEditingTime { get; set; } | Gets or sets the total editing time in minutes. |
| Version { get; } | Gets the version number of the application that created the document. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all writable metadata properties from the package. |
| ClearBuiltInProperties() | Removes all built-in metadata properties. |
| ClearCustomProperties() | Removes all custom metadata properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(string) | Removes a writable metadata property by the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Adds or replaces the metadata property with the specified name. |
| Set(string, DateTime) | Adds or replaces the metadata property with the specified name. |
| Set(string, double) | Adds or replaces the metadata property with the specified name. |
| Set(string, int) | Adds or replaces the metadata property with the specified name. |
| Set(string, string) | Adds or replaces the metadata property with the specified name. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to update built-in metadata properties in a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDoc))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    root.DocumentProperties.Author = "test author";
    root.DocumentProperties.CreatedTime = DateTime.Now;
    root.DocumentProperties.Company = "GroupDocs";
    root.DocumentProperties.Category = "test category";
    root.DocumentProperties.Keywords = "metadata, built-in, update";

    // ... 

    metadata.Save(Constants.OutputDoc);
}
```

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/author.md

#### WordProcessingPackage.Author property

Gets or sets the document's author.

```csharp
public string Author { get; set; }
```

##### Property Value

The author.

### BytesInDocument
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/bytesindocument.md

#### WordProcessingPackage.BytesInDocument property

Gets an estimate of the number of bytes in the document.

```csharp
public int? BytesInDocument { get; }
```

##### Property Value

An estimate of the number of bytes in the document.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/category.md

#### WordProcessingPackage.Category property

Gets or sets the category.

```csharp
public string Category { get; set; }
```

##### Property Value

The category.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/comments.md

#### WordProcessingPackage.Comments property

Gets or sets the comments.

```csharp
public string Comments { get; set; }
```

##### Property Value

The comments.

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/company.md

#### WordProcessingPackage.Company property

Gets or sets the company.

```csharp
public string Company { get; set; }
```

##### Property Value

The company.

### ContentStatus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/contentstatus.md

#### WordProcessingPackage.ContentStatus property

Gets or sets the content status.

```csharp
public string ContentStatus { get; set; }
```

##### Property Value

The content status.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/contenttype.md

#### WordProcessingPackage.ContentType property

Gets or sets the content type of the document.

```csharp
public string ContentType { get; set; }
```

##### Property Value

The type of the content.

### CreatedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/createdtime.md

#### WordProcessingPackage.CreatedTime property

Gets or sets the document created date.

```csharp
public DateTime? CreatedTime { get; set; }
```

##### Property Value

The created time.

### HyperlinkBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/hyperlinkbase.md

#### WordProcessingPackage.HyperlinkBase property

Gets or sets the hyperlink base.

```csharp
public string HyperlinkBase { get; set; }
```

##### Property Value

The hyperlink base.

### HyperlinksChanged
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/hyperlinkschanged.md

#### WordProcessingPackage.HyperlinksChanged property

Gets or sets the Hyperlinks Changed of the document.

```csharp
public bool? HyperlinksChanged { get; set; }
```

##### Property Value

The Hyperlinks Changed of the document.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/keywords.md

#### WordProcessingPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### LastPrintedDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/lastprinteddate.md

#### WordProcessingPackage.LastPrintedDate property

Gets or sets the last printed date.

```csharp
public DateTime? LastPrintedDate { get; set; }
```

##### Property Value

The last printed date.

### LastSavedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/lastsavedby.md

#### WordProcessingPackage.LastSavedBy property

Gets or sets the name of the last author.

```csharp
public string LastSavedBy { get; set; }
```

##### Property Value

The name of the last author.

### LastSavedTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/lastsavedtime.md

#### WordProcessingPackage.LastSavedTime property

Gets or sets the time of the last save.

```csharp
public DateTime? LastSavedTime { get; set; }
```

##### Property Value

The time of the last save.

### LinksUpToDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/linksuptodate.md

#### WordProcessingPackage.LinksUpToDate property

Gets or sets a value indicating whether the hyperlinks in the document are up-to-date.

```csharp
public bool? LinksUpToDate { get; set; }
```

##### Property Value

A value indicating whether the hyperlinks in the document are up-to-date.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/manager.md

#### WordProcessingPackage.Manager property

Gets or sets the manager.

```csharp
public string Manager { get; set; }
```

##### Property Value

The manager.

### NameOfApplication
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/nameofapplication.md

#### WordProcessingPackage.NameOfApplication property

Gets the name of the application.

```csharp
public string NameOfApplication { get; }
```

##### Property Value

The name of the application.

### RevisionNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/revisionnumber.md

#### WordProcessingPackage.RevisionNumber property

Gets or sets the revision number.

```csharp
public int? RevisionNumber { get; set; }
```

##### Property Value

The revision number.

### ScaleCrop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/scalecrop.md

#### WordProcessingPackage.ScaleCrop property

Gets or sets the ScaleCrop of the document.

```csharp
public bool? ScaleCrop { get; set; }
```

##### Property Value

The ScaleCrop of the document.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/set.md

#### Set(string, string)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | String | The property value. |

#### Set(string, bool)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Boolean | The property value. |

#### Set(string, DateTime)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | DateTime | The property value. |

#### Set(string, int)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Int32 | The property value. |

#### Set(string, double)

Adds or replaces the metadata property with the specified name.

```csharp
public void Set(string propertyName, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The property name. |
| value | Double | The property value. |

### SharedDoc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/shareddoc.md

#### WordProcessingPackage.SharedDoc property

Gets or sets the SharedDoc of the document.

```csharp
public bool? SharedDoc { get; set; }
```

##### Property Value

The SharedDoc of the document.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/subject.md

#### WordProcessingPackage.Subject property

Gets or sets the subject.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject.

### Template
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/template.md

#### WordProcessingPackage.Template property

Gets or sets the template.

```csharp
public string Template { get; set; }
```

##### Property Value

The template.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/title.md

#### WordProcessingPackage.Title property

Gets or sets the title of the document.

```csharp
public string Title { get; set; }
```

##### Property Value

The title of the document.

### TitlesOfParts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/titlesofparts.md

#### WordProcessingPackage.TitlesOfParts property

Gets the titles of document parts. Read-only.

```csharp
public string[] TitlesOfParts { get; }
```

##### Property Value

The titles of document parts.

### TotalEditingTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/totaleditingtime.md

#### WordProcessingPackage.TotalEditingTime property

Gets or sets the total editing time in minutes.

```csharp
public int? TotalEditingTime { get; set; }
```

##### Property Value

The total editing time in minutes.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingpackage/version.md

#### WordProcessingPackage.Version property

Gets the version number of the application that created the document.

```csharp
public int? Version { get; }
```

##### Property Value

The version number of the application that created the document.

##### Remarks

When a document was created by Microsoft Word, then high 16 bit represent the major version and low 16 bit represent the build number.

### WordProcessingRevision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrevision.md

#### WordProcessingRevision class

Represents a revision (tracked change) in a document.

```csharp
public sealed class WordProcessingRevision : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; } | Gets the author of the revision. |
| Count { get; } | Gets the number of metadata properties. |
| DateTime { get; } | Gets the date/time of the revision. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RevisionType { get; } | Gets the type of the revision. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrevision/author.md

#### WordProcessingRevision.Author property

Gets the author of the revision.

```csharp
public string Author { get; }
```

##### Property Value

The author of the revision.

### DateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrevision/datetime.md

#### WordProcessingRevision.DateTime property

Gets the date/time of the revision.

```csharp
public DateTime DateTime { get; }
```

##### Property Value

The date/time of the revision.

### RevisionType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrevision/revisiontype.md

#### WordProcessingRevision.RevisionType property

Gets the type of the revision.

```csharp
public WordProcessingRevisionType RevisionType { get; }
```

##### Property Value

The type of the revision.

### WordProcessingRevisionType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrevisiontype.md

#### WordProcessingRevisionType enumeration

Specifies the type of the change being tracked by a revision.

```csharp
public enum WordProcessingRevisionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Insertion | `0` | New content was inserted into 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. |

### WordProcessingRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage.md

#### WordProcessingRootPackage class

Represents the root package allowing working with metadata in a word processing document.

```csharp
public class WordProcessingRootPackage : DocumentRootPackage<WordProcessingPackage>, IDublinCore
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| virtual DocumentProperties { get; } | Gets the native metadata properties presented in the document. |
| DocumentStatistics { get; } | Gets the document statistics package. |
| DublinCorePackage { get; } | Gets the Dublin Core metadata package extracted from the document. |
| FileType { get; } | Gets the file type metadata package. (2 properties) |
| InspectionPackage { get; } | Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| UpdateDocumentStatistics() | Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to read built-in metadata properties of a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    Console.WriteLine(root.DocumentProperties.Author);
    Console.WriteLine(root.DocumentProperties.CreatedTime);
    Console.WriteLine(root.DocumentProperties.Company);
    Console.WriteLine(root.DocumentProperties.Category);
    Console.WriteLine(root.DocumentProperties.Keywords);

    // ... 
}
```

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage/documentstatistics.md

#### WordProcessingRootPackage.DocumentStatistics property

Gets the document statistics package.

```csharp
public DocumentStatistics DocumentStatistics { get; }
```

##### Property Value

The document statistics package.

##### Examples

This code sample shows how to obtain simple text statistics for a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    Console.WriteLine(root.DocumentStatistics.CharacterCount);
    Console.WriteLine(root.DocumentStatistics.PageCount);
    Console.WriteLine(root.DocumentStatistics.WordCount);
}
```

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage/dublincorepackage.md

#### WordProcessingRootPackage.DublinCorePackage property

Gets the Dublin Core metadata package extracted from the document.

```csharp
public DublinCorePackage DublinCorePackage { get; }
```

##### Property Value

The Dublin Core metadata package extracted from the document.

##### Examples

This example demonstrates how to extract Dublin Core metadata from a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    if (root.DublinCorePackage != null)
    {
        Console.WriteLine(root.DublinCorePackage.Format);
        Console.WriteLine(root.DublinCorePackage.Contributor);
        Console.WriteLine(root.DublinCorePackage.Coverage);
        Console.WriteLine(root.DublinCorePackage.Creator);
        Console.WriteLine(root.DublinCorePackage.Source);
        Console.WriteLine(root.DublinCorePackage.Description);

        // ...
    }
}
```

### FileType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage/filetype.md

#### WordProcessingRootPackage.FileType property

Gets the file type metadata package.

```csharp
public WordProcessingTypePackage FileType { get; }
```

##### Property Value

The file type metadata package.

##### Examples

This example shows how to detect the exact type of a loaded document and extract some additional file format information.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDoc))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    Console.WriteLine(root.FileType.FileFormat);
    Console.WriteLine(root.FileType.WordProcessingFormat);
    Console.WriteLine(root.FileType.MimeType);
    Console.WriteLine(root.FileType.Extension);
}
```

### InspectionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage/inspectionpackage.md

#### WordProcessingRootPackage.InspectionPackage property

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

```csharp
public WordProcessingInspectionPackage InspectionPackage { get; }
```

##### Property Value

A metadata package containing inspection results for the document.

##### Examples

This code sample shows how to inspect a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    var root = metadata.GetRootPackage<WordProcessingRootPackage>();

    if (root.InspectionPackage.Comments != null)
    {
        foreach (var comment in root.InspectionPackage.Comments)
        {
            Console.WriteLine(comment.Author);
            Console.WriteLine(comment.CreatedDate);
            Console.WriteLine(comment.Text);

            // ... 

        }
    }

    if (root.InspectionPackage.DigitalSignatures != null)
    {
        foreach (var signature in root.InspectionPackage.DigitalSignatures)
        {
            Console.WriteLine(signature.CertificateSubject);
            Console.WriteLine(signature.Comments);
            Console.WriteLine(signature.SignTime);

            // ...
        }
    }

    if (root.InspectionPackage.Fields != null)
    {
        foreach (var field in root.InspectionPackage.Fields)
        {
            Console.WriteLine(field.Code);
            Console.WriteLine(field.Result);
        }
    }

    if (root.InspectionPackage.HiddenText != null)
    {
        foreach (var textFragment in root.InspectionPackage.HiddenText)
        {
            Console.WriteLine(textFragment);
        }
    }

    if (root.InspectionPackage.Revisions != null)
    {
         foreach (var revision in root.InspectionPackage.Revisions)
         {
             Console.WriteLine(revision.Author);
             Console.WriteLine(revision.DateTime);
             Console.WriteLine(revision.RevisionType);
          }
     }
}
```

### UpdateDocumentStatistics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingrootpackage/updatedocumentstatistics.md

#### WordProcessingRootPackage.UpdateDocumentStatistics method

Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages.

```csharp
public void UpdateDocumentStatistics()
```

##### Examples

This code sample demonstrates how to update document statistics for a WordProcessing document.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDoc))
{
   var root = metadata.GetRootPackage<WordProcessingRootPackage>();

   root.UpdateDocumentStatistics();

   metadata.Save(Constants.OutputDoc);
}
```

### WordProcessingTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingtypepackage.md

#### WordProcessingTypePackage class

Represents a metadata package containing document-specific file format information.

```csharp
public class WordProcessingTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| WordProcessingFormat { get; } | Gets the exact word processing format. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### WordProcessingFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.document/wordprocessingtypepackage/wordprocessingformat.md

#### WordProcessingTypePackage.WordProcessingFormat property

Gets the exact word processing format.

```csharp
public WordProcessingFormat WordProcessingFormat { get; }
```

##### Property Value

The exact word processing format.

### GroupDocs.Metadata.Formats.Ebook.Fb2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2.md

#### Classes

| Class | Description |
| --- | --- |
| Fb2Author | Represents an information about the author of the book. |
| Fb2DocumentInfo | Description of information about the work (including translation, but excluding publication). |
| Fb2PublishInfo | Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether. |
| Fb2Sequence | Represents an information about the sequence of the book. |
| Fb2TitleInfo | Description of information about the work (including translation, but excluding publication). |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| Fb2Genre | Defines Fb2 genres |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### Fb2Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author.md

#### Fb2Author class

Represents an information about the author of the book.

```csharp
public class Fb2Author : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Fb2Author(string, string, string, string, string, string, string) |  |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Email { get; } | Gets the Email. |
| FirstName { get; } | Gets the First Name. |
| HomePage { get; } | Gets the HomePage. |
| Id { get; } | Gets the Id. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LastName { get; } | Gets the Last Name. |
| MetadataType { get; } | Gets the metadata type. |
| MiddleName { get; } | Gets the Middle Name. |
| NickName { get; } | Gets the NickName. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Email
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/email.md

#### Fb2Author.Email property

Gets the Email.

```csharp
public string Email { get; }
```

##### Property Value

The Email.

### Fb2Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/fb2author.md

#### Fb2Author constructor

```csharp
public Fb2Author(string firstName, string middleName, string lastName, string nickName, 
    string homePage, string email, string id)
```

### FirstName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/firstname.md

#### Fb2Author.FirstName property

Gets the First Name.

```csharp
public string FirstName { get; }
```

##### Property Value

The First Name.

### HomePage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/homepage.md

#### Fb2Author.HomePage property

Gets the HomePage.

```csharp
public string HomePage { get; }
```

##### Property Value

The HomePage.

### Id
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/id.md

#### Fb2Author.Id property

Gets the Id.

```csharp
public string Id { get; }
```

##### Property Value

The Id.

### LastName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/lastname.md

#### Fb2Author.LastName property

Gets the Last Name.

```csharp
public string LastName { get; }
```

##### Property Value

The Last Name.

### MiddleName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/middlename.md

#### Fb2Author.MiddleName property

Gets the Middle Name.

```csharp
public string MiddleName { get; }
```

##### Property Value

The Middle Name.

### NickName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2author/nickname.md

#### Fb2Author.NickName property

Gets the NickName.

```csharp
public string NickName { get; }
```

##### Property Value

The NickName.

### Fb2DocumentInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo.md

#### Fb2DocumentInfo class

Description of information about the work (including translation, but excluding publication).

```csharp
public class Fb2DocumentInfo : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Authors { get; } | Information about the author of the document |
| Count { get; } | Gets the number of metadata properties. |
| Date { get; } | Date |
| Id { get; } | Gets the Id. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ProgramUsed { get; } | The programs that were used in preparing the document are listed. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publishers { get; } | Information about the author of the document |
| SrcOcr { get; } | The author of the OCR or original document posted online. |
| SrcUrl { get; } | Where did the original document available online come from |
| Version { get; } | FB2 document version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Authors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/authors.md

#### Fb2DocumentInfo.Authors property

Information about the author of the document

```csharp
public Fb2Author[] Authors { get; }
```

##### Property Value

The document author.

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/date.md

#### Fb2DocumentInfo.Date property

Date

```csharp
public string Date { get; }
```

##### Property Value

The book date.

### Id
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/id.md

#### Fb2DocumentInfo.Id property

Gets the Id.

```csharp
public string Id { get; }
```

##### Property Value

The Id.

### ProgramUsed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/programused.md

#### Fb2DocumentInfo.ProgramUsed property

The programs that were used in preparing the document are listed.

```csharp
public string ProgramUsed { get; }
```

##### Property Value

The programs.

### Publishers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/publishers.md

#### Fb2DocumentInfo.Publishers property

Information about the author of the document

```csharp
public Fb2Author[] Publishers { get; }
```

##### Property Value

The document author.

### SrcOcr
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/srcocr.md

#### Fb2DocumentInfo.SrcOcr property

The author of the OCR or original document posted online.

```csharp
public string SrcOcr { get; }
```

##### Property Value

The author.

### SrcUrl
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/srcurl.md

#### Fb2DocumentInfo.SrcUrl property

Where did the original document available online come from

```csharp
public string SrcUrl { get; }
```

##### Property Value

The url.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/version.md

#### Fb2DocumentInfo.Version property

FB2 document version.

```csharp
public string Version { get; }
```

##### Property Value

The version.

### Fb2Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2genre.md

#### Fb2Genre enumeration

Defines Fb2 genres

```csharp
public enum Fb2Genre
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| sf_history | `0` |  |
| sf_action | `1` |  |
| sf_epic | `2` |  |
| sf_heroic | `3` |  |
| sf_detective | `4` |  |
| sf_cyberpunk | `5` |  |
| sf_space | `6` |  |
| sf_social | `7` |  |
| sf_horror | `8` |  |
| sf_humor | `9` |  |
| sf_fantasy | `10` |  |
| sf | `11` |  |
| det_classic | `12` |  |
| det_police | `13` |  |
| det_action | `14` |  |
| det_irony | `15` |  |
| det_history | `16` |  |
| det_espionage | `17` |  |
| det_crime | `18` |  |
| det_political | `19` |  |
| det_maniac | `20` |  |
| det_hard | `21` |  |
| thriller | `22` |  |
| detective | `23` |  |
| prose_classic | `24` |  |
| prose_history | `25` |  |
| prose_contemporary | `26` |  |
| prose_counter | `27` |  |
| prose_rus_classic | `28` |  |
| prose_su_classics | `29` |  |
| love_contemporary | `30` |  |
| love_history | `31` |  |
| love_detective | `32` |  |
| love_short | `33` |  |
| love_erotica | `34` |  |
| adv_western | `35` |  |
| adv_history | `36` |  |
| adv_indian | `37` |  |
| adv_maritime | `38` |  |
| adv_geo | `39` |  |
| adv_animal | `40` |  |
| adventure | `41` |  |
| child_tale | `42` |  |
| child_verse | `43` |  |
| child_prose | `44` |  |
| child_sf | `45` |  |
| child_det | `46` |  |
| child_adv | `47` |  |
| child_education | `48` |  |
| children | `49` |  |
| poetry | `50` |  |
| dramaturgy | `51` |  |
| antique_ant | `52` |  |
| antique_european | `53` |  |
| antique_russian | `54` |  |
| antique_east | `55` |  |
| antique_myths | `56` |  |
| antique | `57` |  |
| sci_history | `58` |  |
| sci_psychology | `59` |  |
| sci_culture | `60` |  |
| sci_religion | `61` |  |
| sci_philosophy | `62` |  |
| sci_politics | `63` |  |
| sci_business | `64` |  |
| sci_juris | `65` |  |
| sci_linguistic | `66` |  |
| sci_medicine | `67` |  |
| sci_phys | `68` |  |
| sci_math | `69` |  |
| sci_chem | `70` |  |
| sci_biology | `71` |  |
| sci_tech | `72` |  |
| science | `73` |  |
| comp_www | `74` |  |
| comp_programming | `75` |  |
| comp_hard | `76` |  |
| comp_soft | `77` |  |
| comp_db | `78` |  |
| comp_osnet | `79` |  |
| computers | `80` |  |
| ref_encyc | `81` |  |
| ref_dict | `82` |  |
| ref_ref | `83` |  |
| ref_guide | `84` |  |
| reference | `85` |  |
| nonf_biography | `86` |  |
| nonf_publicism | `87` |  |
| nonf_criticism | `88` |  |
| design | `89` |  |
| nonfiction | `90` |  |
| religion_rel | `91` |  |
| religion_esoterics | `92` |  |
| religion_self | `93` |  |
| religion | `94` |  |
| humor_anecdote | `95` |  |
| humor_prose | `96` |  |
| humor_verse | `97` |  |
| humor | `98` |  |
| home_cooking | `99` |  |
| home_pets | `100` |  |
| home_crafts | `101` |  |
| home_entertain | `102` |  |
| home_health | `103` |  |
| home_garden | `104` |  |
| home_diy | `105` |  |
| home_sport | `106` |  |
| home_sex | `107` |  |
| home | `108` |  |

### Fb2PublishInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo.md

#### Fb2PublishInfo class

Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether.

```csharp
public class Fb2PublishInfo : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| BookName { get; } | The title of the original (paper) book. |
| City { get; } | City, place of publication of the original (paper) book. |
| Count { get; } | Gets the number of metadata properties. |
| Isbn { get; } | ISBN of the original (paper) book. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publisher { get; } | The title of the original (paper) book. |
| Sequence { get; } | The series of publications that the book belongs to and the number in the series. |
| Year { get; } | Year of publication of the original (paper) book. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BookName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/bookname.md

#### Fb2PublishInfo.BookName property

The title of the original (paper) book.

```csharp
public string BookName { get; }
```

##### Property Value

The title.

### City
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/city.md

#### Fb2PublishInfo.City property

City, place of publication of the original (paper) book.

```csharp
public string City { get; }
```

##### Property Value

The city.

### Isbn
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/isbn.md

#### Fb2PublishInfo.Isbn property

ISBN of the original (paper) book.

```csharp
public string Isbn { get; }
```

##### Property Value

The isbn.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/publisher.md

#### Fb2PublishInfo.Publisher property

The title of the original (paper) book.

```csharp
public string Publisher { get; }
```

##### Property Value

The title.

### Sequence
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/sequence.md

#### Fb2PublishInfo.Sequence property

The series of publications that the book belongs to and the number in the series.

```csharp
public Fb2Sequence Sequence { get; }
```

##### Property Value

The book series.

### Year
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/year.md

#### Fb2PublishInfo.Year property

Year of publication of the original (paper) book.

```csharp
public string Year { get; }
```

##### Property Value

The year.

### Fb2Sequence
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2sequence.md

#### Fb2Sequence class

Represents an information about the sequence of the book.

```csharp
public class Fb2Sequence : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Fb2Sequence(string, int, string) |  |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Lang { get; } | Gets the language. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Series title |
| Number { get; } | Book number in the series. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Fb2Sequence
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/fb2sequence.md

#### Fb2Sequence constructor

```csharp
public Fb2Sequence(string name, int number, string lang)
```

### Lang
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/lang.md

#### Fb2Sequence.Lang property

Gets the language.

```csharp
public string Lang { get; }
```

##### Property Value

The language.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/name.md

#### Fb2Sequence.Name property

Series title

```csharp
public string Name { get; }
```

##### Property Value

The series title.

### Number
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/number.md

#### Fb2Sequence.Number property

Book number in the series.

```csharp
public int? Number { get; }
```

##### Property Value

The book number in the series.

### Fb2TitleInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo.md

#### Fb2TitleInfo class

Description of information about the work (including translation, but excluding publication).

```csharp
public class Fb2TitleInfo : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Authors { get; } | Information about the author of the book |
| BookTitle { get; } | The title of the book. It can either match the book title (book-name) or differ (for example, when there are several works under one cover). |
| Count { get; } | Gets the number of metadata properties. |
| Coverpage { get; } | Contains a link to a graphic image of the book cover. |
| Date { get; } | Date |
| Genres { get; } | Describes the genre of the book. It is used to place the book in the library rubricator, for this reason the list of possible genres is strictly defined. It is allowed to specify several genres. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; } | List of keywords for the book. Intended for use by search engines. |
| Lang { get; } | Language of the book (work) |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Sequence { get; } | The series of publications that the book belongs to and the number in the series. |
| SrcLang { get; } | Original language (for translations). |
| Translators { get; } | Information about the author of the book |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Authors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/authors.md

#### Fb2TitleInfo.Authors property

Information about the author of the book

```csharp
public Fb2Author[] Authors { get; }
```

##### Property Value

The book author.

### BookTitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/booktitle.md

#### Fb2TitleInfo.BookTitle property

The title of the book. It can either match the book title (book-name) or differ (for example, when there are several works under one cover).

```csharp
public string BookTitle { get; }
```

##### Property Value

The book title.

### Coverpage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/coverpage.md

#### Fb2TitleInfo.Coverpage property

Contains a link to a graphic image of the book cover.

```csharp
public string[] Coverpage { get; }
```

##### Property Value

The book coverage.

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/date.md

#### Fb2TitleInfo.Date property

Date

```csharp
public string Date { get; }
```

##### Property Value

The book date.

### Genres
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/genres.md

#### Fb2TitleInfo.Genres property

Describes the genre of the book. It is used to place the book in the library rubricator, for this reason the list of possible genres is strictly defined. It is allowed to specify several genres.

```csharp
public Fb2Genre[] Genres { get; }
```

##### Property Value

The book genres.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/keywords.md

#### Fb2TitleInfo.Keywords property

List of keywords for the book. Intended for use by search engines.

```csharp
public string Keywords { get; }
```

##### Property Value

The book keywords.

### Lang
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/lang.md

#### Fb2TitleInfo.Lang property

Language of the book (work)

```csharp
public string Lang { get; }
```

##### Property Value

The book language.

### Sequence
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/sequence.md

#### Fb2TitleInfo.Sequence property

The series of publications that the book belongs to and the number in the series.

```csharp
public Fb2Sequence Sequence { get; }
```

##### Property Value

The book series.

### SrcLang
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/srclang.md

#### Fb2TitleInfo.SrcLang property

Original language (for translations).

```csharp
public string SrcLang { get; }
```

##### Property Value

The book original language.

### Translators
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/translators.md

#### Fb2TitleInfo.Translators property

Information about the author of the book

```csharp
public Fb2Author[] Translators { get; }
```

##### Property Value

The book author.

### GroupDocs.Metadata.Formats.Ebook.Mobi
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi.md

#### Classes

| Class | Description |
| --- | --- |
| MobiHeader | Represents metadata in a Mobi e-book. |
| MobiPackage | Represents metadata in a Mobi e-book. |
| MobiRootPackage | Represents the root package allowing working with metadata in an Mobi e-book. |
| PDBHeader | Represents metadata in a Mobi e-book. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### MobiHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobiheader.md

#### MobiHeader class

Represents metadata in a Mobi e-book.

```csharp
public sealed class MobiHeader : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FullName { get; set; } | Gets the Mobi e-book full name. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MobiType { get; } | Gets the mobi type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TextEncoding { get; } | Gets the Mobi Text Encoding. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### FullName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobiheader/fullname.md

#### MobiHeader.FullName property

Gets the Mobi e-book full name.

```csharp
public string FullName { get; set; }
```

##### Property Value

The Mobi e-book full name.

### MobiType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobiheader/mobitype.md

#### MobiHeader.MobiType property

Gets the mobi type.

```csharp
public uint MobiType { get; }
```

##### Property Value

The mobi type.

### TextEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobiheader/textencoding.md

#### MobiHeader.TextEncoding property

Gets the Mobi Text Encoding.

```csharp
public uint TextEncoding { get; }
```

##### Property Value

The Mobi Text Encoding.

### MobiPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobipackage.md

#### MobiPackage class

Represents metadata in a Mobi e-book.

```csharp
public sealed class MobiPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MobiHeader { get; } |  |
| PDBHeader { get; } |  |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### MobiHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobipackage/mobiheader.md

#### MobiPackage.MobiHeader property

```csharp
public MobiHeader MobiHeader { get; }
```

### PDBHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobipackage/pdbheader.md

#### MobiPackage.PDBHeader property

```csharp
public PDBHeader PDBHeader { get; }
```

### MobiRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage.md

#### MobiRootPackage class

Represents the root package allowing working with metadata in an Mobi e-book.

```csharp
public class MobiRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MobiPackage { get; } | Gets the Mobi metadata package. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### MobiPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/mobipackage.md

#### MobiRootPackage.MobiPackage property

Gets the Mobi metadata package.

```csharp
public MobiPackage MobiPackage { get; }
```

##### Property Value

The Mobi metadata package.

##### Examples

This code sample shows how to read Mobi format-specific metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMobi))
{
    var root = metadata.GetRootPackage<MobiRootPackage>();

    Console.WriteLine(root.MobiPackage.Name);
}
```

### PDBHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader.md

#### PDBHeader class

Represents metadata in a Mobi e-book.

```csharp
public sealed class PDBHeader : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| AppInfoID { get; set; } | Gets the app info ID. |
| Attributes { get; set; } | Gets the mobi attributes. |
| Count { get; } | Gets the number of metadata properties. |
| CreationDate { get; set; } | Gets the creation date. |
| Creator { get; set; } | Gets the creator. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LastBackupDate { get; set; } | Gets the last backup date. |
| MetadataType { get; } | Gets the metadata type. |
| ModificationDate { get; set; } | Gets the modification date. |
| ModificationNumber { get; set; } | Gets the modification number. |
| Name { get; set; } | Gets the Mobi e-book name. |
| NextRecordList { get; } |  |
| NumRecords { get; } | Gets the num records. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SortInfoID { get; set; } | Gets the sort info ID. |
| Type { get; set; } | Gets the type. |
| UniqueIDSeed { get; set; } | Gets the unique ID seed. |
| Version { get; set; } | Gets the Mobi version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AppInfoID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/appinfoid.md

#### PDBHeader.AppInfoID property

Gets the app info ID.

```csharp
public uint AppInfoID { get; set; }
```

##### Property Value

The app info ID.

### Attributes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/attributes.md

#### PDBHeader.Attributes property

Gets the mobi attributes.

```csharp
public ushort Attributes { get; set; }
```

##### Property Value

The mobi attributes.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/creationdate.md

#### PDBHeader.CreationDate property

Gets the creation date.

```csharp
public DateTime CreationDate { get; set; }
```

##### Property Value

The creation date.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/creator.md

#### PDBHeader.Creator property

Gets the creator.

```csharp
public string Creator { get; set; }
```

##### Property Value

The creator.

### LastBackupDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/lastbackupdate.md

#### PDBHeader.LastBackupDate property

Gets the last backup date.

```csharp
public DateTime LastBackupDate { get; set; }
```

##### Property Value

The last backup date.

### ModificationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/modificationdate.md

#### PDBHeader.ModificationDate property

Gets the modification date.

```csharp
public DateTime ModificationDate { get; set; }
```

##### Property Value

The modification date.

### ModificationNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/modificationnumber.md

#### PDBHeader.ModificationNumber property

Gets the modification number.

```csharp
public uint ModificationNumber { get; set; }
```

##### Property Value

The modification number.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/name.md

#### PDBHeader.Name property

Gets the Mobi e-book name.

```csharp
public string Name { get; set; }
```

##### Property Value

The Mobi e-book name.

### NextRecordList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/nextrecordlist.md

#### PDBHeader.NextRecordList property

```csharp
public uint NextRecordList { get; }
```

### NumRecords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/numrecords.md

#### PDBHeader.NumRecords property

Gets the num records.

```csharp
public ushort NumRecords { get; }
```

##### Property Value

The num records.

### SortInfoID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/sortinfoid.md

#### PDBHeader.SortInfoID property

Gets the sort info ID.

```csharp
public uint SortInfoID { get; set; }
```

##### Property Value

The sort info ID.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/type.md

#### PDBHeader.Type property

Gets the type.

```csharp
public string Type { get; set; }
```

##### Property Value

The type.

### UniqueIDSeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/uniqueidseed.md

#### PDBHeader.UniqueIDSeed property

Gets the unique ID seed.

```csharp
public uint UniqueIDSeed { get; set; }
```

##### Property Value

The unique ID seed.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.mobi/pdbheader/version.md

#### PDBHeader.Version property

Gets the Mobi version.

```csharp
public ushort Version { get; set; }
```

##### Property Value

The Mobi version.

### GroupDocs.Metadata.Formats.Ebook
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook.md

The namespace provides functionality for working with electronic book formats.

#### Classes

| Class | Description |
| --- | --- |
| EpubPackage | Represents metadata in a EPUB e-book. |
| EpubRootPackage | Represents the root package allowing working with metadata in an EPUB e-book. |
| Fb2RootPackage | Represents the root package allowing working with metadata in an Fb2 e-book. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### EpubPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage.md

#### EpubPackage class

Represents metadata in a EPUB e-book.

```csharp
public sealed class EpubPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Abstract { get; set; } | Gets or sets a summary of the resource. |
| AccessRights { get; set; } | Gets or sets the information about who access the resource or an indication of its security status. |
| AccrualMethod { get; set; } | Gets or sets the method by which items are added to a collection. |
| AccrualPeriodicity { get; set; } | Gets or sets the frequency with which items are added to a collection. |
| AccrualPolicy { get; set; } | Gets or sets the policy governing the addition of items to a collection. |
| Alternative { get; set; } | Gets or sets an alternative name for the resource. |
| Audience { get; set; } | Gets or sets a class of agents for whom the resource is intended or useful. |
| Available { get; set; } | Gets or sets the date that the resource became or will become available. |
| BibliographicCitation { get; set; } | Gets or sets a bibliographic reference for the resource. |
| ConformsTo { get; set; } | Gets or sets an established standard to which the described resource conforms. |
| Contributor { get; set; } | Gets or sets an entity responsible for making contributions to the resource. |
| Count { get; } | Gets the number of metadata properties. |
| Coverage { get; set; } | Gets or sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| Created { get; set; } | Gets or sets the date of creation of the resource. |
| Creator { get; set; } | Gets or sets an entity responsible for making the resource. |
| Date { get; set; } | Gets or sets a point or period of time associated with an event in the lifecycle of the resource. |
| DateAccepted { get; set; } | Gets or sets the date of acceptance of the resource. |
| DateCopyrighted { get; set; } | Gets or sets the date of copyright of the resource. |
| DateSubmitted { get; set; } | Gets or sets the date of submission of the resource. |
| Description { get; set; } | Gets or sets an account of the resource. |
| EducationLevel { get; set; } | Gets or sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| Extent { get; set; } | Gets or sets the size or duration of the resource. |
| Format { get; set; } | Gets or sets the file format, physical medium, or dimensions of the resource. |
| HasFormat { get; set; } | Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| HasPart { get; set; } | Gets or sets a related resource that is included either physically or logically in the described resource. |
| HasVersion { get; set; } | Gets or sets a related resource that is a version, edition, or adaptation of the described resource. |
| Identifier { get; set; } | Gets or sets an unambiguous reference to the resource within a given context. |
| ImageCover { get; } | Gets the image cover as an array of bytes. |
| InstructionalMethod { get; set; } | Gets or sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| IsFormatOf { get; set; } | Gets or sets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| IsPartOf { get; set; } | Gets or sets a related resource in which the described resource is physically or logically included. |
| IsReferencedBy { get; set; } | Gets or sets a related resource that references, cites, or otherwise points to the described resource. |
| IsReplacedBy { get; set; } | Gets or sets a related resource that supplants, displaces, or supersedes the described resource. |
| IsRequiredBy { get; set; } | Gets or sets a related resource that requires the described resource to support its function, delivery, or coherence. |
| Issued { get; set; } | Gets or sets the date of formal issuance of the resource. |
| IsVersionOf { get; set; } | Gets or sets a related resource of which the described resource is a version, edition, or adaptation. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; set; } | Gets or sets the language of the resource. |
| License { get; set; } | Gets or sets a legal document giving official permission to do something with the resource. |
| Mediator { get; set; } | Gets or sets an entity that mediates access to the resource. |
| Medium { get; set; } | Gets or sets the material or physical carrier of the resource. |
| MetadataType { get; } | Gets the metadata type. |
| Modified { get; set; } | Gets or sets the date on which the resource was changed. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Provenance { get; set; } | Gets or sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| Publisher { get; set; } | Gets or sets an entity responsible for making the resource available. |
| References { get; set; } | Gets or sets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| Relation { get; set; } | Gets or sets a related resource. |
| Replaces { get; set; } | Gets or sets a related resource that is supplanted, displaced, or superseded by the described resource. |
| Requires { get; set; } | Gets or sets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| Rights { get; set; } | Gets or sets the information about rights held in and over the resource. |
| RightsHolder { get; set; } | Gets or sets a person or organization owning or managing rights over the resource. |
| Source { get; set; } | Gets or sets a related resource from which the described resource is derived. |
| Spatial { get; set; } | Gets or sets the spatial characteristics of the resource. |
| Subject { get; set; } | Gets or sets a topic of the resource. |
| TableOfContents { get; set; } | Gets or sets a list of subunits of the resource. |
| Temporal { get; set; } | Gets or sets the temporal characteristics of the resource. |
| Title { get; set; } | Gets or sets a name given to the resource. |
| Type { get; set; } | Gets or sets the nature or genre of the resource. |
| UniqueIdentifier { get; } | Gets the package unique identifier. |
| Valid { get; set; } | Gets or sets the date (often a range) of validity of a resource. |
| Version { get; } | Gets the EPUB version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Abstract
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/abstract.md

#### EpubPackage.Abstract property

Gets or sets a summary of the resource.

```csharp
public string Abstract { get; set; }
```

##### Property Value

A summary of the resource.

### AccessRights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/accessrights.md

#### EpubPackage.AccessRights property

Gets or sets the information about who access the resource or an indication of its security status.

```csharp
public string AccessRights { get; set; }
```

##### Property Value

The information about who access the resource or an indication of its security status.

### AccrualMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/accrualmethod.md

#### EpubPackage.AccrualMethod property

Gets or sets the method by which items are added to a collection.

```csharp
public string AccrualMethod { get; set; }
```

##### Property Value

The method by which items are added to a collection.

### AccrualPeriodicity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/accrualperiodicity.md

#### EpubPackage.AccrualPeriodicity property

Gets or sets the frequency with which items are added to a collection.

```csharp
public string AccrualPeriodicity { get; set; }
```

##### Property Value

The frequency with which items are added to a collection.

### AccrualPolicy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/accrualpolicy.md

#### EpubPackage.AccrualPolicy property

Gets or sets the policy governing the addition of items to a collection.

```csharp
public string AccrualPolicy { get; set; }
```

##### Property Value

The policy governing the addition of items to a collection.

### Alternative
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/alternative.md

#### EpubPackage.Alternative property

Gets or sets an alternative name for the resource.

```csharp
public string Alternative { get; set; }
```

##### Property Value

An alternative name for the resource.

### Audience
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/audience.md

#### EpubPackage.Audience property

Gets or sets a class of agents for whom the resource is intended or useful.

```csharp
public string Audience { get; set; }
```

##### Property Value

A class of agents for whom the resource is intended or useful.

### Available
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/available.md

#### EpubPackage.Available property

Gets or sets the date that the resource became or will become available.

```csharp
public string Available { get; set; }
```

##### Property Value

The date that the resource became or will become available.

### BibliographicCitation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/bibliographiccitation.md

#### EpubPackage.BibliographicCitation property

Gets or sets a bibliographic reference for the resource.

```csharp
public string BibliographicCitation { get; set; }
```

##### Property Value

A bibliographic reference for the resource.

### ConformsTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/conformsto.md

#### EpubPackage.ConformsTo property

Gets or sets an established standard to which the described resource conforms.

```csharp
public string ConformsTo { get; set; }
```

##### Property Value

An established standard to which the described resource conforms.

### Contributor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/contributor.md

#### EpubPackage.Contributor property

Gets or sets an entity responsible for making contributions to the resource.

```csharp
public string Contributor { get; set; }
```

##### Property Value

An entity responsible for making contributions to the resource.

### Created
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/created.md

#### EpubPackage.Created property

Gets or sets the date of creation of the resource.

```csharp
public string Created { get; set; }
```

##### Property Value

The date of creation of the resource.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/creator.md

#### EpubPackage.Creator property

Gets or sets an entity responsible for making the resource.

```csharp
public string Creator { get; set; }
```

##### Property Value

An entity responsible for making the resource.

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/date.md

#### EpubPackage.Date property

Gets or sets a point or period of time associated with an event in the lifecycle of the resource.

```csharp
public string Date { get; set; }
```

##### Property Value

A point or period of time associated with an event in the lifecycle of the resource.

### DateAccepted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/dateaccepted.md

#### EpubPackage.DateAccepted property

Gets or sets the date of acceptance of the resource.

```csharp
public string DateAccepted { get; set; }
```

##### Property Value

The date of acceptance of the resource.

### DateCopyrighted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/datecopyrighted.md

#### EpubPackage.DateCopyrighted property

Gets or sets the date of copyright of the resource.

```csharp
public string DateCopyrighted { get; set; }
```

##### Property Value

The date of copyright of the resource.

### DateSubmitted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/datesubmitted.md

#### EpubPackage.DateSubmitted property

Gets or sets the date of submission of the resource.

```csharp
public string DateSubmitted { get; set; }
```

##### Property Value

The date of submission of the resource.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/description.md

#### EpubPackage.Description property

Gets or sets an account of the resource.

```csharp
public string Description { get; set; }
```

##### Property Value

An account of the resource.

### EducationLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/educationlevel.md

#### EpubPackage.EducationLevel property

Gets or sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

```csharp
public string EducationLevel { get; set; }
```

##### Property Value

A class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

### Extent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/extent.md

#### EpubPackage.Extent property

Gets or sets the size or duration of the resource.

```csharp
public string Extent { get; set; }
```

##### Property Value

The size or duration of the resource.

### Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/format.md

#### EpubPackage.Format property

Gets or sets the file format, physical medium, or dimensions of the resource.

```csharp
public string Format { get; set; }
```

##### Property Value

The file format, physical medium, or dimensions of the resource.

### HasFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/hasformat.md

#### EpubPackage.HasFormat property

Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format.

```csharp
public string HasFormat { get; set; }
```

##### Property Value

A related resource that is substantially the same as the pre-existing described resource, but in another format.

### HasPart
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/haspart.md

#### EpubPackage.HasPart property

Gets or sets a related resource that is included either physically or logically in the described resource.

```csharp
public string HasPart { get; set; }
```

##### Property Value

A related resource that is included either physically or logically in the described resource.

### HasVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/hasversion.md

#### EpubPackage.HasVersion property

Gets or sets a related resource that is a version, edition, or adaptation of the described resource.

```csharp
public string HasVersion { get; set; }
```

##### Property Value

A related resource that is a version, edition, or adaptation of the described resource.

### Identifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/identifier.md

#### EpubPackage.Identifier property

Gets or sets an unambiguous reference to the resource within a given context.

```csharp
public string Identifier { get; set; }
```

##### Property Value

An unambiguous reference to the resource within a given context.

### ImageCover
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/imagecover.md

#### EpubPackage.ImageCover property

Gets the image cover as an array of bytes.

```csharp
public byte[] ImageCover { get; }
```

##### Property Value

The image cover.

### InstructionalMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/instructionalmethod.md

#### EpubPackage.InstructionalMethod property

Gets or sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

```csharp
public string InstructionalMethod { get; set; }
```

##### Property Value

A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

### IsFormatOf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/isformatof.md

#### EpubPackage.IsFormatOf property

Gets or sets a pre-existing related resource that is substantially the same as the described resource, but in another format.

```csharp
public string IsFormatOf { get; set; }
```

##### Property Value

A pre-existing related resource that is substantially the same as the described resource, but in another format.

### IsPartOf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/ispartof.md

#### EpubPackage.IsPartOf property

Gets or sets a related resource in which the described resource is physically or logically included.

```csharp
public string IsPartOf { get; set; }
```

##### Property Value

A related resource in which the described resource is physically or logically included.

### IsReferencedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/isreferencedby.md

#### EpubPackage.IsReferencedBy property

Gets or sets a related resource that references, cites, or otherwise points to the described resource.

```csharp
public string IsReferencedBy { get; set; }
```

##### Property Value

A related resource that references, cites, or otherwise points to the described resource.

### IsReplacedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/isreplacedby.md

#### EpubPackage.IsReplacedBy property

Gets or sets a related resource that supplants, displaces, or supersedes the described resource.

```csharp
public string IsReplacedBy { get; set; }
```

##### Property Value

A related resource that supplants, displaces, or supersedes the described resource.

### IsRequiredBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/isrequiredby.md

#### EpubPackage.IsRequiredBy property

Gets or sets a related resource that requires the described resource to support its function, delivery, or coherence.

```csharp
public string IsRequiredBy { get; set; }
```

##### Property Value

A related resource that requires the described resource to support its function, delivery, or coherence.

### Issued
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/issued.md

#### EpubPackage.Issued property

Gets or sets the date of formal issuance of the resource.

```csharp
public string Issued { get; set; }
```

##### Property Value

The date of formal issuance of the resource.

### IsVersionOf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/isversionof.md

#### EpubPackage.IsVersionOf property

Gets or sets a related resource of which the described resource is a version, edition, or adaptation.

```csharp
public string IsVersionOf { get; set; }
```

##### Property Value

A related resource of which the described resource is a version, edition, or adaptation.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/language.md

#### EpubPackage.Language property

Gets or sets the language of the resource.

```csharp
public string Language { get; set; }
```

##### Property Value

The language of the resource.

### License
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/license.md

#### EpubPackage.License property

Gets or sets a legal document giving official permission to do something with the resource.

```csharp
public string License { get; set; }
```

##### Property Value

A legal document giving official permission to do something with the resource.

### Mediator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/mediator.md

#### EpubPackage.Mediator property

Gets or sets an entity that mediates access to the resource.

```csharp
public string Mediator { get; set; }
```

##### Property Value

An entity that mediates access to the resource.

### Medium
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/medium.md

#### EpubPackage.Medium property

Gets or sets the material or physical carrier of the resource.

```csharp
public string Medium { get; set; }
```

##### Property Value

The material or physical carrier of the resource.

### Modified
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/modified.md

#### EpubPackage.Modified property

Gets or sets the date on which the resource was changed.

```csharp
public string Modified { get; set; }
```

##### Property Value

The date on which the resource was changed.

### Provenance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/provenance.md

#### EpubPackage.Provenance property

Gets or sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

```csharp
public string Provenance { get; set; }
```

##### Property Value

A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/publisher.md

#### EpubPackage.Publisher property

Gets or sets an entity responsible for making the resource available.

```csharp
public string Publisher { get; set; }
```

##### Property Value

An entity responsible for making the resource available.

### References
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/references.md

#### EpubPackage.References property

Gets or sets a related resource that is referenced, cited, or otherwise pointed to by the described resource.

```csharp
public string References { get; set; }
```

##### Property Value

A related resource that is referenced, cited, or otherwise pointed to by the described resource.

### Relation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/relation.md

#### EpubPackage.Relation property

Gets or sets a related resource.

```csharp
public string Relation { get; set; }
```

##### Property Value

A related resource.

### Replaces
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/replaces.md

#### EpubPackage.Replaces property

Gets or sets a related resource that is supplanted, displaced, or superseded by the described resource.

```csharp
public string Replaces { get; set; }
```

##### Property Value

A related resource that is supplanted, displaced, or superseded by the described resource.

### Requires
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/requires.md

#### EpubPackage.Requires property

Gets or sets a related resource that is required by the described resource to support its function, delivery, or coherence.

```csharp
public string Requires { get; set; }
```

##### Property Value

A related resource that is required by the described resource to support its function, delivery, or coherence.

### Rights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/rights.md

#### EpubPackage.Rights property

Gets or sets the information about rights held in and over the resource.

```csharp
public string Rights { get; set; }
```

##### Property Value

The information about rights held in and over the resource.

### RightsHolder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/rightsholder.md

#### EpubPackage.RightsHolder property

Gets or sets a person or organization owning or managing rights over the resource.

```csharp
public string RightsHolder { get; set; }
```

##### Property Value

A person or organization owning or managing rights over the resource.

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/source.md

#### EpubPackage.Source property

Gets or sets a related resource from which the described resource is derived.

```csharp
public string Source { get; set; }
```

##### Property Value

A related resource from which the described resource is derived.

### Spatial
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/spatial.md

#### EpubPackage.Spatial property

Gets or sets the spatial characteristics of the resource.

```csharp
public string Spatial { get; set; }
```

##### Property Value

The spatial characteristics of the resource.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/subject.md

#### EpubPackage.Subject property

Gets or sets a topic of the resource.

```csharp
public string Subject { get; set; }
```

##### Property Value

A topic of the resource.

### TableOfContents
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/tableofcontents.md

#### EpubPackage.TableOfContents property

Gets or sets a list of subunits of the resource.

```csharp
public string TableOfContents { get; set; }
```

##### Property Value

A list of subunits of the resource.

### Temporal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/temporal.md

#### EpubPackage.Temporal property

Gets or sets the temporal characteristics of the resource.

```csharp
public string Temporal { get; set; }
```

##### Property Value

The temporal characteristics of the resource.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/title.md

#### EpubPackage.Title property

Gets or sets a name given to the resource.

```csharp
public string Title { get; set; }
```

##### Property Value

A name given to the resource.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/type.md

#### EpubPackage.Type property

Gets or sets the nature or genre of the resource.

```csharp
public string Type { get; set; }
```

##### Property Value

The nature or genre of the resource.

### UniqueIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/uniqueidentifier.md

#### EpubPackage.UniqueIdentifier property

Gets the package unique identifier.

```csharp
public string UniqueIdentifier { get; }
```

##### Property Value

The package unique identifier.

### Valid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/valid.md

#### EpubPackage.Valid property

Gets or sets the date (often a range) of validity of a resource.

```csharp
public string Valid { get; set; }
```

##### Property Value

The date (often a range) of validity of a resource.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubpackage/version.md

#### EpubPackage.Version property

Gets the EPUB version.

```csharp
public string Version { get; }
```

##### Property Value

The EPUB version.

### EpubRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubrootpackage.md

#### EpubRootPackage class

Represents the root package allowing working with metadata in an EPUB e-book.

```csharp
public class EpubRootPackage : RootMetadataPackage, IDublinCore
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DublinCorePackage { get; } | Gets the Dublin Core metadata package extracted from the e-book. |
| EpubPackage { get; } | Gets the EPUB metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubrootpackage/dublincorepackage.md

#### EpubRootPackage.DublinCorePackage property

Gets the Dublin Core metadata package extracted from the e-book.

```csharp
public DublinCorePackage DublinCorePackage { get; }
```

##### Property Value

The Dublin Core metadata package extracted from the e-book.

##### Examples

This example shows how to extract Dublin Core metadata from an EPUB file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputEpub))
{
    var root = metadata.GetRootPackage<EpubRootPackage>();

    if (root.DublinCorePackage != null)
    {
        Console.WriteLine(root.DublinCorePackage.Rights);
        Console.WriteLine(root.DublinCorePackage.Publisher);
        Console.WriteLine(root.DublinCorePackage.Title);
        Console.WriteLine(root.DublinCorePackage.Creator);
        Console.WriteLine(root.DublinCorePackage.Language);
        Console.WriteLine(root.DublinCorePackage.Date);

        // ...
    }
}
```

### EpubPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/epubrootpackage/epubpackage.md

#### EpubRootPackage.EpubPackage property

Gets the EPUB metadata package.

```csharp
public EpubPackage EpubPackage { get; }
```

##### Property Value

The EPUB metadata package.

##### Examples

This code sample shows how to read EPUB format-specific metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputEpub))
{
    var root = metadata.GetRootPackage<EpubRootPackage>();

    Console.WriteLine(root.EpubPackage.Version);
    Console.WriteLine(root.EpubPackage.UniqueIdentifier);
    Console.WriteLine(root.EpubPackage.ImageCover != null ? root.EpubPackage.ImageCover.Length : 0);
}
```

### Fb2RootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/fb2rootpackage.md

#### Fb2RootPackage class

Represents the root package allowing working with metadata in an Fb2 e-book.

```csharp
public class Fb2RootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Fb2Package { get; } | Gets the Fb2 metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Fb2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.ebook/fb2rootpackage/fb2package.md

#### Fb2RootPackage.Fb2Package property

Gets the Fb2 metadata package.

```csharp
public Fb2Package Fb2Package { get; }
```

##### Property Value

The Fb2 metadata package.

##### Examples

This code sample shows how to read Fb2 format-specific metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputFb2))
{
    var root = metadata.GetRootPackage<Fb2RootPackage>();

    Console.WriteLine(root.Fb2Package.TitleInfo.BookTitle);
}
```

### GroupDocs.Metadata.Formats.Email.Msg
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email.msg.md

#### Enumeration

| Enumeration | Description |
| --- | --- |
| MsgKnownProperties | Defines known msg properties. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### MsgKnownProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email.msg/msgknownproperties.md

#### MsgKnownProperties enumeration

Defines known msg properties.

```csharp
public enum MsgKnownProperties : long
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ObjectUri | `1627455519` |  |
| contactEtag | `1627521055` |  |
| photoEtag | `1627586591` |  |
| PR_ACCESS | `267649027` |  |
| PR_ACL_DATA | `1071644930` |  |
| PR_ACCESS_LEVEL | `267845635` |  |
| PR_ACCOUNT | `973078559` |  |
| PR_ADDITIONAL_REN_ENTRYIDS | `920129794` |  |
| PR_ADDITIONAL_REN_ENTRYIDS_EX | `920191234` |  |
| PR_EMS_AB_AUTH_ORIG | `2362966029` |  |
| PR_EMS_AB_CONTAINERID | `4294770691` |  |
| PR_EMS_AB_DELIV_CONT_LENGTH | `2154430467` |  |
| PR_EMS_AB_DISPLAY_NAME_PRINTABLE | `973013023` |  |
| PR_EMS_AB_DISPLAY_TYPE_EX | `2358444035` |  |
| PR_EMS_AB_DL_EXTERNAL_MEMBER_COUNT | `2363686915` |  |
| PR_EMS_AB_DL_TOTAL_MEMBER_COUNT | `2363621379` |  |
| PR_EMS_AB_DL_MEM_SUBMIT_PERMS_BL_O | `2155020301` |  |
| PR_EMS_AB_DL_MEM_SUBMIT_PERMS | `2363097101` |  |
| PR_EMS_AB_DL_MEM_REJECT_PERMS | `2363162637` |  |
| PR_ADDRESS_BOOK_ENTRYID | `1715142914` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_1 | `2150432799` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_10 | `2151022623` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_11 | `2354511903` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_12 | `2354577439` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_13 | `2354642975` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_14 | `2355101727` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_15 | `2355167263` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_2 | `2150498335` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_3 | `2150563871` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_4 | `2150629407` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_5 | `2150694943` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_6 | `2150760479` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_7 | `2150826015` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_8 | `2150891551` |  |
| PR_EMS_AB_EXTENSION_ATTRIBUTE_9 | `2150957087` |  |
| PR_EMS_AB_FOLDER_PATHNAME | `2147745823` |  |
| PR_EMS_AB_HAB_CHILD_DEPARTMENTS | `2358902797` |  |
| PR_EMS_AB_HAB_DEPARTMENT_MEMBERS | `2358706189` |  |
| PR_EMS_AB_HAB_IS_HIERARCHICAL_GROUP | `2363293707` |  |
| PR_EMS_AB_HAB_PARENT_DEPARTMENT | `2358837261` |  |
| PR_EMS_AB_HAB_ROOT_DEPARTMENT | `2358771743` |  |
| PR_EMS_AB_HAB_SHOW_IN_DEPARTMENTS | `2358509581` |  |
| PR_EMS_AB_HOME_MDB | `2147876895` |  |
| PR_EMS_AB_IS_MASTER | `4294639627` |  |
| PR_EMS_AB_IS_MEMBER_OF_DL | `2148007967` |  |
| PR_EMS_AB_MANAGE_DL | `1728315405` |  |
| PR_EMS_AB_MANAGER | `2147811341` |  |
| PR_EMS_AB_MANAGER_T | `2147811359` |  |
| PR_EMS_AB_MEMBER | `2148073485` |  |
| PR_EMS_AB_ENABLE_MODERATION | `2360672267` |  |
| PR_EMS_AB_NETWORK_ADDRESS | `2171605023` |  |
| PR_EMS_AB_OBJ_DIST_NAME | `2151415839` |  |
| PR_EMS_AB_OBJECT_GUID | `2355953922` |  |
| PR_EMS_AB_ORG_UNIT_ROOT_DN | `2359820319` |  |
| PR_EMS_AB_OWNER_O | `2148270093` |  |
| PR_EMS_AB_OWNER_BL_O | `2149842957` |  |
| PR_EMS_AB_PARENT_ENTRYID | `4294705410` |  |
| PR_EMS_AB_PHONETIC_COMPANY_NAME | `2358312991` |  |
| PR_EMS_AB_PHONETIC_DEPARTMENT_NAME | `2358247455` |  |
| PR_EMS_AB_PHONETIC_DISPLAY_NAME | `2358378527` |  |
| PR_EMS_AB_PHONETIC_GIVEN_NAME | `2358116383` |  |
| PR_EMS_AB_PHONETIC_SURNAME | `2358181919` |  |
| PR_EMS_AB_PROXY_ADDRESSES | `2148470815` |  |
| PR_EMS_AB_PUBLIC_DELEGATES | `2148859917` |  |
| PR_EMS_AB_REPORTS | `2148401165` |  |
| PR_EMS_AB_ROOM_CAPACITY | `134676483` |  |
| PR_EMS_AB_ROOM_CONTAINERS | `2358644767` |  |
| PR_EMS_AB_ROOM_DESCRIPTION | `134807583` |  |
| PR_EMS_AB_DL_SENDER_HINT_TRANSLATIONS_W | `2360086559` |  |
| PR_EMS_AB_TARGET_ADDRESS | `2148597791` |  |
| PR_EMS_AB_UNAUTH_ORIG | `2363031565` |  |
| PR_EMS_AB_X509_CERT | `2355761410` |  |
| PR_ADDRTYPE | `805437471` |  |
| PR_ALTERNATE_RECIPIENT_ALLOWED | `131083` |  |
| PR_ANR | `906756127` |  |
| PR_ARCHIVE_DATE | `807338048` |  |
| PR_ARCHIVE_PERIOD | `807272451` |  |
| PR_ARCHIVE_TAG | `806879490` |  |
| PR_ASSISTANT | `976224287` |  |
| PR_ASSISTANT_TELEPHONE_NUMBER | `976093215` |  |
| PR_ATTACH_ADDITIONAL_INFO | `923730178` |  |
| PR_ATTACH_CONTENT_ID | `923926559` |  |
| PR_ATTACH_CONTENT_LOCATION | `923992095` |  |
| PR_ATTACH_DATA_BIN | `922812674` |  |
| PR_ATTACH_DATA_OBJ | `922812429` |  |
| PR_ATTACH_ENCODING | `922878210` |  |
| PR_ATTACH_EXTENSION | `922943519` |  |
| PR_ATTACH_FILENAME | `923009055` |  |
| PR_ATTACH_FLAGS | `924057603` |  |
| PR_ATTACH_LONG_FILENAME | `923205663` |  |
| PR_ATTACH_LONG_PATHNAME | `923598879` |  |
| PR_ATTACHMENT_CONTACTPHOTO | `2147418123` |  |
| PR_ATTACHMENT_FLAGS | `2147287043` |  |
| PR_ATTACHMENT_HIDDEN | `2147352587` |  |
| PR_ATTACHMENT_LINKID | `2147090435` |  |
| PR_ATTACH_METHOD | `923074563` |  |
| PR_ATTACH_MIME_TAG | `923664415` |  |
| PR_ATTACH_NUM | `237043715` |  |
| PR_ATTACH_PATHNAME | `923271199` |  |
| PR_ATTACH_PAYLOAD_CLASS | `924450847` |  |
| PR_ATTACH_PAYLOAD_PROV_GUID_STR | `924385311` |  |
| PR_ATTACH_RENDERING | `923336962` |  |
| PR_ATTACH_SIZE | `236978179` |  |
| PR_ATTACH_TAG | `923402498` |  |
| PR_ATTACH_TRANSPORT_NAME | `923533343` |  |
| PR_ATTR_HIDDEN | `284426251` |  |
| PR_ATTR_READONLY | `284557323` |  |
| PR_AUTO_FORWARD_COMMENT | `262175` |  |
| PR_AUTO_FORWARDED | `327691` |  |
| PR_AUTO_RESPONSE_SUPPRESS | `1071579139` |  |
| PR_BIRTHDAY | `977403968` |  |
| PR_BLOCK_STATUS | `278265859` |  |
| PR_BODY | `268435487` |  |
| PR_BODY_CONTENT_ID | `269811743` |  |
| PR_BODY_CONTENT_LOCATION | `269746207` |  |
| PR_BODY_HTML | `269680671` |  |
| PR_BUSINESS2_TELEPHONE_NUMBER_A | `974848031` |  |
| PR_BUSINESS2_TELEPHONE_NUMBER_A_MV | `974852127` |  |
| PR_BUSINESS_FAX_NUMBER | `975437855` |  |
| PR_BUSINESS_HOME_PAGE | `978386975` |  |
| PR_BUSINESS_TELEPHONE_NUMBER | `973602847` |  |
| PR_CALLBACK_TELEPHONE_NUMBER | `973209631` |  |
| PR_CAR_TELEPHONE_NUMBER | `975044639` |  |
| PR_CDO_RECURRENCEID | `281346112` |  |
| PR_CHANGE_KEY | `1709310210` |  |
| PR_CHILDRENS_NAMES | `978849823` |  |
| PR_CLIENT_ACTIONS | `1715798274` |  |
| PR_CLIENT_SUBMIT_TIME | `3735616` |  |
| PR_CODE_PAGE_ID | `1724055555` |  |
| PR_COMMENT | `805568543` |  |
| PR_COMPANY_MAIN_PHONE_NUMBER | `978780191` |  |
| PR_COMPANY_NAME | `974520351` |  |
| PR_COMPUTER_NETWORK_NAME | `977862687` |  |
| PR_CONFLICT_ENTRYID | `1072693506` |  |
| PR_CONTAINER_CLASS | `907214879` |  |
| PR_CONTAINER_CONTENTS | `906952717` |  |
| PR_CONTAINER_FLAGS | `905969667` |  |
| PR_CONTAINER_HIERARCHY | `906887181` |  |
| PR_CONTENT_COUNT | `906100739` |  |
| PR_CONTENT_FILTER_SCL | `1081475075` |  |
| PR_CONTENT_UNREAD | `906166275` |  |
| PR_CONVERSATION_ID | `806551810` |  |
| PR_CONVERSATION_INDEX | `7405826` |  |
| PR_CONVERSATION_INDEX_TRACKING | `806748171` |  |
| PR_CONVERSATION_TOPIC | `7340063` |  |
| PR_COUNTRY | `975568927` |  |
| PR_CREATION_TIME | `805765184` |  |
| PR_CREATOR_ENTRYID | `1073283330` |  |
| PR_CREATOR_NAME | `1073217567` |  |
| PR_CUSTOMER_ID | `977928223` |  |
| PR_DAM_BACK_PATCHED | `1715929099` |  |
| PR_DAM_ORIGINAL_ENTRYID | `1715863810` |  |
| PR_DEF_POST_MSGCLASS | `920977439` |  |
| PR_DAM_ORIG_MSG_SVREID | `1732313339` |  |
| PR_DEFERRED_DELIVERY_TIME | `983104` |  |
| PR_DEFERRED_SEND_NUMBER | `1072365571` |  |
| PR_DEFERRED_SEND_TIME | `1072627776` |  |
| PR_DEFERRED_SEND_UNITS | `1072431107` |  |
| PR_DELEGATED_BY_RULE | `1071841291` |  |
| PR_DELEGATE_FLAGS | `1751846915` |  |
| PR_DELETE_AFTER_SUBMIT | `234946571` |  |
| PR_DELETED_COUNT_TOTAL | `1728774147` |  |
| PR_DELETED_ON | `1720647744` |  |
| PR_DELIVER_TIME | `1048640` |  |
| PR_DEPARTMENT_NAME | `974651423` |  |
| PR_DEPTH | `805634051` |  |
| PR_DISPLAY_BCC | `235012127` |  |
| PR_DISPLAY_CC | `235077663` |  |
| PR_DISPLAY_NAME | `805371935` |  |
| PR_DISPLAY_NAME_PREFIX | `977600543` |  |
| PR_DISPLAY_TO | `235143199` |  |
| PR_DISPLAY_TYPE | `956301315` |  |
| PR_DISPLAY_TYPE_EX | `956628995` |  |
| PR_EMAIL_ADDRESS | `805503007` |  |
| PR_END_DATE | `6357056` |  |
| PR_ENTRYID | `268370178` |  |
| PR_EXCEPTION_ENDTIME | `2147221568` |  |
| PR_EXCEPTION_REPLACETIME | `2147024960` |  |
| PR_EXCEPTION_STARTTIME | `2147156032` |  |
| PR_EXPIRY_NUMBER | `1072496643` |  |
| PR_EXPIRY_TIME | `1376320` |  |
| PR_EXPIRY_UNITS | `1072562179` |  |
| PR_EXTENDED_FOLDER_FLAGS | `920256770` |  |
| PR_EXTENDED_RULE_MSG_ACTIONS | `244908290` |  |
| PR_EXTENDED_RULE_MSG_CONDITION | `244973826` |  |
| PR_EXTENDED_RULE_SIZE_LIMIT | `245039107` |  |
| PR_FLAG_COMPLETE_TIME | `277938240` |  |
| PR_FLAG_STATUS | `277872643` |  |
| PR_FLAT_URL_NAME | `1728970783` |  |
| PR_FOLDER_ASSOCIATED_CONTENTS | `907018253` |  |
| PR_FOLDER_FLAGS | `1722286083` |  |
| PR_FOLDER_TYPE | `906035203` |  |
| PR_FOLLOWUP_ICON | `278200323` |  |
| PR_FREEBUSY_COUNT_MONTHS | `1751711747` |  |
| PR_FREEBUSY_ENTRYIDS | `920916226` |  |
| PR_FREEBUSY_EMA | `1749614623` |  |
| PR_FREEBUSY_PUBLISH_END | `1749549059` |  |
| PR_FREEBUSY_PUBLISH_START | `1749483523` |  |
| PR_FREEBUSY_RANGE_TIMESTAMP | `1751646272` |  |
| PR_FTP_SITE | `978059295` |  |
| PR_GATEWAY_NEEDS_TO_REFRESH | `1749417995` |  |
| PR_GENDER | `978124802` |  |
| PR_GENERATION | `973406239` |  |
| PR_GIVEN_NAME | `973471775` |  |
| PR_GOVERNMENT_ID_NUMBER | `973537311` |  |
| PR_HASATTACH | `236650507` |  |
| PR_HAS_DAMS | `1072300043` |  |
| PR_HAS_NAMED_PROPERTIES | `1716125707` |  |
| PR_HAS_RULES | `1715077131` |  |
| PR_HIERARCHY_CHANGE_NUM | `1715339267` |  |
| PR_HIER_REV | `1082261568` |  |
| PR_HOBBIES | `977469471` |  |
| PR_HOME2_TELEPHONE_NUMBER | `976158751` |  |
| PR_HOME2_TELEPHONE_NUMBER_A_MV | `976162847` |  |
| PR_HOME_ADDRESS_CITY | `978911263` |  |
| PR_HOME_ADDRESS_COUNTRY | `978976799` |  |
| PR_HOME_ADDRESS_POSTAL_CODE | `979042335` |  |
| PR_HOME_ADDRESS_POST_OFFICE_BOX | `979238943` |  |
| PR_HOME_ADDRESS_STATE_OR_PROVINCE | `979107871` |  |
| PR_HOME_ADDRESS_STREET | `979173407` |  |
| PR_HOME_FAX_NUMBER | `975503391` |  |
| PR_HOME_TELEPHONE_NUMBER | `973668383` |  |
| PR_HTML | `269680898` |  |
| PR_ICON_INDEX | `276824067` |  |
| PR_IMPORTANCE | `1507331` |  |
| PR_IN_CONFLICT | `1718353931` |  |
| PR_INITIAL_DETAILS_PANE | `1057488899` |  |
| PR_INITIALS | `973733919` |  |
| PR_IN_REPLY_TO_ID | `272760863` |  |
| PR_INSTANCE_KEY | `267780354` |  |
| PR_INTERNET_CPID | `1071513603` |  |
| PR_INETMAIL_OVERRIDE_FORMAT | `1493303299` |  |
| PR_INTERNET_MESSAGE_ID | `271908895` |  |
| PR_INTERNET_REFERENCES | `272171039` |  |
| PR_IPM_APPOINTMENT_ENTRYID | `919601410` |  |
| PR_IPM_CONTACT_ENTRYID | `919666946` |  |
| PR_IPM_DRAFTS_ENTRYID | `920060162` |  |
| PR_IPM_JOURNAL_ENTRYID | `919732482` |  |
| PR_IPM_NOTE_ENTRYID | `919798018` |  |
| PR_IPM_TASK_ENTRYID | `919863554` |  |
| PR_ISDN_NUMBER | `976027679` |  |
| PR_JUNK_ADD_RECIPS_TO_SSL | `1627586563` |  |
| PR_JUNK_INCLUDE_CONTACTS | `1627389955` |  |
| PR_JUNK_PERMANENTLY_DELETE | `1627521027` |  |
| PR_JUNK_PHISHING_ENABLE_LINKS | `1627848715` |  |
| PR_JUNK_THRESHOLD | `1627455491` |  |
| PR_KEYWORD | `973799455` |  |
| PR_LANGUAGE | `973864991` |  |
| PR_LAST_MODIFICATION_TIME | `805830720` |  |
| PR_LAST_MODIFIER_ENTRYID | `1073414402` |  |
| PR_LAST_MODIFIER_NAME | `1073348639` |  |
| PR_LAST_VERB_EXECUTED | `276889603` |  |
| PR_LAST_VERB_EXECUTION_TIME | `276955200` |  |
| PR_LIST_HELP | `272826399` |  |
| PR_LIST_SUBSCRIBE | `272891935` |  |
| PR_LIST_UNSUBSCRIBE | `272957471` |  |
| PR_LOCAL_COMMIT_TIME | `1728643136` |  |
| PR_LOCAL_COMMIT_TIME_MAX | `1728708672` |  |
| PR_LOCALE_ID | `1721827331` |  |
| PR_LOCALITY | `975634463` |  |
| PR_LOCATION | `973930527` |  |
| PR_MAILBOX_OWNER_ENTRYID | `1713045762` |  |
| PR_MAILBOX_OWNER_NAME | `1713111071` |  |
| PR_MANAGER_NAME | `978190367` |  |
| PR_MAPPING_SIGNATURE | `267911426` |  |
| PR_MAX_SUBMIT_MESSAGE_SIZE | `1718419459` |  |
| PR_MEMBER_ID | `1718681620` |  |
| PR_MEMBER_NAME | `1718747167` |  |
| PR_MEMBER_RIGHTS | `1718812675` |  |
| PR_MESSAGE_ATTACHMENTS | `236126221` |  |
| PR_MESSAGE_CC_ME | `5767179` |  |
| PR_MESSAGE_CLASS | `1703967` |  |
| PR_MESSAGE_CODEPAGE | `1073545219` |  |
| PR_MESSAGE_DELIVERY_TIME | `235274304` |  |
| PR_MSG_EDITOR_FORMAT | `1493762051` |  |
| PR_MESSAGE_FLAGS | `235339779` |  |
| PR_MHS_COMMON_NAME | `974061599` |  |
| PR_MESSAGE_LOCALE_ID | `1072758787` |  |
| PR_MESSAGE_RECIP_ME | `5832715` |  |
| PR_MESSAGE_RECIPIENTS | `236060685` |  |
| PR_MESSAGE_SIZE | `235405315` |  |
| PR_MESSAGE_SIZE_EXTENDED | `235405332` |  |
| PR_MSG_STATUS | `236388355` |  |
| PR_MESSAGE_SUBMISSION_ID | `4653314` |  |
| PR_MESSAGE_TO_ME | `5701643` |  |
| PR_MIDDLE_NAME | `977535007` |  |
| PR_MOBILE_TELEPHONE_NUMBER | `974913567` |  |
| PR_NATIVE_BODY_INFO | `269877251` |  |
| PR_NEXT_SEND_ACCT | `237568031` |  |
| PR_NICKNAME | `978255903` |  |
| PR_NDR_DIAG_CODE | `201654275` |  |
| PR_NDR_REASON_CODE | `201588739` |  |
| PR_NDR_STATUS_CODE | `203423747` |  |
| PR_NON_RECEIPT_NOTIFICATION_REQUESTED | `201719819` |  |
| PR_NORMALIZED_SUBJECT | `236781599` |  |
| PR_OBJECT_TYPE | `268304387` |  |
| PR_OFFICE_LOCATION | `974716959` |  |
| PR_OAB_CONTAINER_GUID | `1744961567` |  |
| PR_OAB_DN | `1745092639` |  |
| PR_OAB_MESSAGE_CLASS | `1745027075` |  |
| PR_OAB_NAME | `1744830495` |  |
| PR_OAB_SEQUENCE | `1744896003` |  |
| PR_OAB_TRUNCATED_PROPS | `1745162243` |  |
| PR_ORDINAL_MOST | `920780803` |  |
| PR_ORGANIZATIONAL_ID_NUMBER | `974127135` |  |
| PR_ORIGINAL_AUTHOR_ENTRYID | `4980994` |  |
| PR_ORIGINAL_AUTHOR_NAME_W | `5046303` |  |
| PR_ORIGINAL_DELIVERY_TIME | `5570624` |  |
| PR_ORIGINAL_DISPLAY_BCC | `7471135` |  |
| PR_ORIGINAL_DISPLAY_CC | `7536671` |  |
| PR_ORIGINAL_DISPLAY_TO | `7602207` |  |
| PR_ORIGINAL_ENTRYID | `974258434` |  |
| PR_ORIG_MESSAGE_CLASS | `4915231` |  |
| PR_ORIGINAL_SENDER_ADDRTYPE | `6684703` |  |
| PR_ORIGINAL_SENDER_EMAIL_ADDRESS | `6750239` |  |
| PR_ORIGINAL_SENDER_ENTRYID | `5964034` |  |
| PR_ORIGINAL_SENDER_NAME | `5898271` |  |
| PR_ORIGINAL_SENDER_SEARCH_KEY | `6029570` |  |
| PR_ORIGINAL_SENSITIVITY | `3014659` |  |
| PR_ORIGINAL_SENT_REPRESENTING_ADDRTYPE | `6815775` |  |
| PR_ORIGINAL_SENT_REPRESENTING_EMAIL_ADDRESS | `6881311` |  |
| PR_ORIGINAL_SENT_REPRESENTING_ENTRYID | `6160642` |  |
| PR_ORIGINAL_SENT_REPRESENTING_NAME | `6094879` |  |
| PR_ORIGINAL_SENT_REPRESENTING_SEARCH_KEY | `6226178` |  |
| PR_ORIGINAL_SUBJECT | `4784159` |  |
| PR_ORIGINAL_SUBMIT_TIME | `5111872` |  |
| PR_ORIGINATOR_DELIVERY_REPORT_REQUESTED | `2293771` |  |
| PR_ORIGINATOR_NON_DELIVERY_REPORT_REQUESTED | `201850891` |  |
| PR_OSC_SYNC_ENABLEDONSERVER | `2082734091` |  |
| PR_OTHER_ADDRESS_CITY | `979304479` |  |
| PR_OTHER_ADDRESS_COUNTRY | `979370015` |  |
| PR_OTHER_ADDRESS_POSTAL_CODE | `979435551` |  |
| PR_OTHER_ADDRESS_POST_OFFICE_BOX | `979632159` |  |
| PR_OTHER_ADDRESS_STATE_OR_PROVINCE | `979501087` |  |
| PR_OTHER_ADDRESS_STREET | `979566623` |  |
| PR_OTHER_TELEPHONE_NUMBER | `975110175` |  |
| PR_OOF_STATE | `1713176587` |  |
| PR_OWNER_APPT_ID | `6422531` |  |
| PR_PAGER_TELEPHONE_NUMBER | `975241247` |  |
| PR_PARENT_ENTRYID | `235471106` |  |
| PR_PARENT_KEY | `2425090` |  |
| PR_PARENT_SOURCE_KEY | `1709244674` |  |
| PR_PERSONAL_HOME_PAGE | `978321439` |  |
| PR_POLICY_TAG | `806945026` |  |
| PR_POSTAL_ADDRESS | `974454815` |  |
| PR_POSTAL_CODE | `975831071` |  |
| PR_POST_OFFICE_BOX | `975896607` |  |
| PR_PREDECESSOR_CHANGE_LIST | `1709375746` |  |
| PR_PRIMARY_FAX_NUMBER | `975372319` |  |
| PR_PRIMARY_SEND_ACCT | `237502495` |  |
| PR_PRIMARY_TELEPHONE_NUMBER | `974782495` |  |
| PR_PRIORITY | `2490371` |  |
| PR_PROCESSED | `2097217547` |  |
| PR_PROFESSION | `977666079` |  |
| PR_PROHIBIT_RECEIVE_QUOTA | `1718222851` |  |
| PR_PROHIBIT_SEND_QUOTA | `1718484995` |  |
| PR_PURPORTED_SENDER_DOMAIN | `1082327071` |  |
| PR_RADIO_TELEPHONE_NUMBER | `974979103` |  |
| PR_READ | `241762315` |  |
| PR_READ_RECEIPT_ENTRYID | `4587778` |  |
| PR_READ_RECEIPT_REQUESTED | `2686987` |  |
| PR_READ_RECEIPT_SEARCH_KEY | `5439746` |  |
| PR_RECEIPT_TIME | `2752576` |  |
| PR_RECEIVED_BY_ADDRTYPE | `7667743` |  |
| PR_RECEIVED_BY_EMAIL_ADDRESS | `7733279` |  |
| PR_RECEIVED_BY_ENTRYID | `4129026` |  |
| PR_RECEIVED_BY_NAME | `4194335` |  |
| PR_RECEIVED_BY_SEARCH_KEY | `5308674` |  |
| PR_RCVD_REPRESENTING_ADDRTYPE | `7798815` |  |
| PR_RCVD_REPRESENTING_EMAIL_ADDRESS | `7864351` |  |
| PR_RCVD_REPRESENTING_ENTRYID | `4391170` |  |
| PR_RCVD_REPRESENTING_NAME | `4456479` |  |
| PR_RCVD_REPRESENTING_SEARCH_KEY | `5374210` |  |
| PR_RECIPIENT_DISPLAY_NAME | `1609957407` |  |
| PR_RECIPIENT_ENTRYID | `1610023170` |  |
| PR_RECIPIENT_FLAGS | `1610416131` |  |
| PR_RECIPIENT_ORDER | `1608450051` |  |
| PR_RECIPIENT_PROPOSED | `1608581131` |  |
| PR_RECIPIENT_PROPOSEDENDTIME | `1608777792` |  |
| PR_RECIPIENT_PROPOSEDSTARTTIME | `1608712256` |  |
| PR_RECIPIENT_REASSIGNMENT_PROHIBITED | `2818059` |  |
| PR_RECIPIENT_TRACKSTATUS | `1610547203` |  |
| PR_RECIPIENT_TRACKSTATUS_TIME | `1610285120` |  |
| PR_RECIPIENT_TYPE | `202702851` |  |
| PR_RECORD_KEY | `267976962` |  |
| PR_REFERRED_BY_NAME | `977731615` |  |
| PR_REM_ONLINE_ENTRYID | `919929090` |  |
| PR_DSN_REMOTE_MTA | `203489311` |  |
| PR_RENDERING_POSITION | `923467779` |  |
| PR_REPLY_RECIPIENT_ENTRIES | `5177602` |  |
| PR_REPLY_RECIPIENT_NAMES | `5242911` |  |
| PR_REPLY_REQUESTED | `202833931` |  |
| PR_REPLY_TEMPLATE_ID | `1707213058` |  |
| PR_REPLY_TIME | `3145792` |  |
| PR_REPORT_DISPOSITION_W | `8388639` |  |
| PR_REPORT_DISPOSITION_MODE_W | `8454175` |  |
| PR_REPORT_ENTRYID | `4522242` |  |
| PR_REPORT_NAME | `3801119` |  |
| PR_REPORT_SEARCH_KEY | `5505282` |  |
| PR_REPORT_TAG | `3211522` |  |
| PR_REPORT_TEXT | `268501023` |  |
| PR_REPORT_TIME | `3276864` |  |
| PR_RESOLVE_METHOD | `1072103427` |  |
| PR_RESPONSE_REQUESTED | `6488075` |  |
| PR_RESPONSIBILITY | `235864075` |  |
| PR_RETENTION_DATE | `807141440` |  |
| PR_RETENTION_FLAGS | `807206915` |  |
| PR_RETENTION_PERIOD | `807010307` |  |
| PR_RIGHTS | `1715011587` |  |
| PR_ROAMING_DATATYPES | `2080768003` |  |
| PR_ROAMING_DICTIONARY | `2080833794` |  |
| PR_ROAMING_XMLSTREAM | `2080899330` |  |
| PR_ROWID | `805306371` |  |
| PR_ROW_TYPE | `267714563` |  |
| PR_RTF_COMPRESSED | `269025538` |  |
| PR_RTF_IN_SYNC | `236912651` |  |
| PR_RULE_ACTION_NUMBER | `1716518915` |  |
| PR_RULE_ACTIONS | `1719664894` |  |
| PR_RULE_ACTION_TYPE | `1716060163` |  |
| PR_RULE_CONDITION | `1719206141` |  |
| PR_RULE_ERROR | `1715994627` |  |
| PR_RULE_FOLDER_ENTRYID | `1716584706` |  |
| PR_RULE_ID | `1718878228` |  |
| PR_RULE_IDS | `1718944002` |  |
| PR_RULE_LEVEL | `1719861251` |  |
| PR_RULE_MSG_LEVEL | `1710030851` |  |
| PR_RULE_MSG_PROVIDER_DATA | `1710096642` |  |
| PR_RULE_MSG_SEQUENCE | `1710424067` |  |
| PR_RULE_MSG_STATE | `1709768707` |  |
| PR_RULE_MSG_USER_FLAGS | `1709834243` |  |
| PR_RULE_NAME | `1719795743` |  |
| PR_RULE_PROVIDER | `1719730207` |  |
| PR_RULE_PROVIDER_DATA | `1719927042` |  |
| PR_RULE_SEQUENCE | `1719009283` |  |
| PR_RULE_STATE | `1719074819` |  |
| PR_RULE_USER_FLAGS | `1719140355` |  |
| PR_RW_RULES_STREAM | `1744961794` |  |
| PR_SCHDINFO_APPT_TOMBSTONE | `1751777538` |  |
| PR_SCHDINFO_AUTO_ACCEPT_APPTS | `1751973899` |  |
| PR_SCHDINFO_DELEGATE_ENTRYIDS | `1749356802` |  |
| PR_SCHDINFO_DELEGATE_NAMES | `1749291039` |  |
| PR_SCHDINFO_DELEGATE_NAMES_W | `1749684255` |  |
| PR_SCHDINFO_BOSS_WANTS_COPY | `1749155851` |  |
| PR_SCHDINFO_BOSS_WANTS_INFO | `1749745675` |  |
| PR_SCHDINFO_DISALLOW_OVERLAPPING_APPTS | `1752104971` |  |
| PR_SCHDINFO_DISALLOW_RECURRING_APPTS | `1752039435` |  |
| PR_SCHDINFO_DONT_MAIL_DELEGATES | `1749221387` |  |
| PR_SCHDINFO_FREEBUSY | `1751908610` |  |
| PR_SCHDINFO_FREEBUSY_OOF | `1750470914` |  |
| PR_SCHDINFO_FREEBUSY_BUSY | `1750339842` |  |
| PR_SCHDINFO_FREEBUSY_MERGED | `1750077698` |  |
| PR_SCHDINFO_FREEBUSY_TENTATIVE | `1750208770` |  |
| PR_SCHDINFO_MONTHS_OOF | `1750405123` |  |
| PR_SCHDINFO_MONTHS_BUSY | `1750274051` |  |
| PR_SCHDINFO_MONTHS_MERGED | `1750011907` |  |
| PR_SCHDINFO_MONTHS_TENTATIVE | `1750142979` |  |
| PR_SCHDINFO_RESOURCE_TYPE | `1749090307` |  |
| PR_SPLUS_FREE_BUSY_ENTRYID | `1713504514` |  |
| PR_EMS_SCRIPT_BLOB | `262402` |  |
| PR_WB_SF_DEFINITION | `1749352706` |  |
| PR_WB_SF_EFP_FLAGS | `1749549059` |  |
| PR_WB_SF_EXPIRATION | `1748631555` |  |
| PR_WB_SF_ID | `1749156098` |  |
| PR_WB_SF_LAST_USED | `1748238339` |  |
| PR_WB_SF_RECREATE_INFO | `1749287170` |  |
| PR_WB_SF_STORAGE_TYPE | `1749417987` |  |
| PR_WB_SF_TAG | `1749483523` |  |
| PR_WB_SF_TEMPLATE_ID | `1749090307` |  |
| PR_SEARCH_KEY | `806027522` |  |
| PR_NT_SECURITY_DESCRIPTOR_AS_XML | `241827871` |  |
| PR_SELECTABLE | `906559499` |  |
| PR_SENDER_ADDRTYPE | `203292703` |  |
| PR_SENDER_EMAIL_ADDRESS | `203358239` |  |
| PR_SENDER_ENTRYID | `202965250` |  |
| PR_SENDER_ID_STATUS | `1081671683` |  |
| PR_SENDER_NAME | `203030559` |  |
| PR_SENDER_SEARCH_KEY | `203227394` |  |
| PR_SEND_INTERNET_ENCODING | `980484099` |  |
| PR_SEND_RICH_INFO | `977272843` |  |
| PR_SENSITIVITY | `3538947` |  |
| PR_SENT_REPRESENTING_ADDRTYPE | `6553631` |  |
| PR_SENT_REPRESENTING_EMAIL_ADDRESS | `6619167` |  |
| PR_SENT_REPRESENTING_ENTRYID | `4260098` |  |
| PR_SENT_REPRESENTING_NAME | `4325407` |  |
| PR_SENT_REPRESENTING_SEARCH_KEY | `3866882` |  |
| PR_SENT_REPRESENTING_SMTP_ADDRESS | `1560412191` |  |
| PR_SMTP_ADDRESS | `972947487` |  |
| PR_SORT_LOCALE_ID | `1728380931` |  |
| PR_SOURCE_KEY | `1709179138` |  |
| PR_EMS_AB_UM_SPOKEN_NAME | `2361524482` |  |
| PR_SPOUSE_NAME | `977797151` |  |
| PR_START_DATE | `6291520` |  |
| PR_START_DATE_ETC | `807076098` |  |
| PR_STATE_OR_PROVINCE | `975699999` |  |
| PR_STORE_ENTRYID | `268108034` |  |
| PR_STORE_STATE | `873332739` |  |
| PR_STORE_SUPPORT_MASK | `873267203` |  |
| PR_STREET_ADDRESS | `975765535` |  |
| PR_SUBFOLDERS | `906625035` |  |
| PR_SUBJECT | `3604511` |  |
| PR_SUBJECT_PREFIX | `3997727` |  |
| PR_SUPPLEMENTARY_INFO | `203096095` |  |
| PR_SURNAME | `974192671` |  |
| PR_SWAPPED_TODO_DATA | `237830402` |  |
| PR_SWAPPED_TODO_STORE | `237764866` |  |
| PR_TARGET_ENTRYID | `806355202` |  |
| PR_TTYTDD_PHONE_NUMBER | `977993759` |  |
| PR_TELEX_NUMBER | `975962143` |  |
| PR_EMS_TEMPLATE_BLOB | `65794` |  |
| PR_TEMPLATEID | `956432642` |  |
| PR_EMS_AB_THUMBNAIL_PHOTO | `2359165186` |  |
| PR_TITLE | `974585887` |  |
| PR_TNEF_CORRELATION_KEY | `8323330` |  |
| PR_TODO_ITEM_FLAGS | `237699075` |  |
| PR_TRANSMITABLE_DISPLAY_NAME | `975175711` |  |
| PR_TRANSPORT_MESSAGE_HEADERS | `8192031` |  |
| PR_TRUST_SENDER | `242810883` |  |
| PR_USER_CERTIFICATE | `975307010` |  |
| PR_USER_ENTRYID | `1712914690` |  |
| PR_USER_X509_CERTIFICATE | `980422914` |  |
| PR_VD_BINARY | `1879113986` |  |
| PR_VD_NAME | `1879441439` |  |
| PR_VD_STRINGS | `1879179295` |  |
| PR_VD_VERSION | `1879506947` |  |
| PR_WEDDING_ANNIVERSARY | `977338432` |  |
| PR_WLINK_ABEID | `1750335746` |  |
| PR_WLINK_AB_EXSTOREEID | `1754333442` |  |
| PR_WLINK_CALENDAR_COLOR | `1750269955` |  |
| PR_WLINK_CLIENTID | `1754267906` |  |
| PR_WLINK_ENTRYID | `1749811458` |  |
| PR_WLINK_FLAGS | `1749680131` |  |
| PR_WLINK_FOLDER_TYPE | `1750008066` |  |
| PR_WLINK_GROUP_CLSID | `1750073602` |  |
| PR_WLINK_GROUP_NAME | `1750138911` |  |
| PR_WLINK_ORDINAL | `1749745922` |  |
| PR_WLINK_RECKEY | `1749876994` |  |
| PR_WLINK_RO_GROUP_TYPE | `1754398723` |  |
| PR_WLINK_SECTION | `1750204419` |  |
| PR_WLINK_STORE_ENTRYID | `1749942530` |  |
| PR_WLINK_TYPE | `1749614595` |  |
| PR_ABSTRACT | `1071251486` |  |
| PR_ACTIVE_USER_ENTRYID | `1716650242` |  |
| PR_ADDRBOOK_FOR_LOCAL_SITE_ENTRYID | `1713766658` |  |
| PR_ADDRESS_BOOK_DISPLAY_NAME | `1072168990` |  |
| PR_ARRIVAL_TIME | `1717502016` |  |
| PR_ASSOC_MESSAGE_SIZE | `1723072515` |  |
| PR_ASSOC_MESSAGE_SIZE_EXTENDED | `1723072532` |  |
| PR_ASSOC_MSG_W_ATTACH_COUNT | `1722679299` |  |
| PR_ATTACH_ON_ASSOC_MSG_COUNT | `1722941443` |  |
| PR_ATTACH_ON_NORMAL_MSG_COUNT | `1722875907` |  |
| PR_AUTO_ADD_NEW_SUBS | `1709506571` |  |
| PR_BILATERAL_INFO | `1071382786` |  |
| PR_CACHED_COLUMN_COUNT | `1722548227` |  |
| PR_CATEG_COUNT | `1722482691` |  |
| PR_CHANGE_ADVISOR | `1714683917` |  |
| PR_CHANGE_NOTIFICATION_GUID | `1714880584` |  |
| PR_COLLECTOR | `1714290701` |  |
| PR_CONTACT_COUNT | `1723269123` |  |
| PR_CONTENT_SEARCH_KEY | `1717960962` |  |
| PR_CONTENTS_SYNCHRONIZER | `1714225165` |  |
| PR_DELETED_ASSOC_MESSAGE_SIZE_EXTENDED | `1721565204` |  |
| PR_DELETED_ASSOC_MSG_COUNT | `1715666947` |  |
| PR_DELETED_FOLDER_COUNT | `1715535875` |  |
| PR_DELETED_MESSAGE_SIZE_EXTENDED | `1721434132` |  |
| PR_DELETED_MSG_COUNT | `1715470339` |  |
| PR_DELETED_NORMAL_MESSAGE_SIZE_EXTENDED | `1721499668` |  |
| PR_DESIGN_IN_PROGRESS | `1071906827` |  |
| PR_DISABLE_FULL_FIDELITY | `284295179` |  |
| PR_DISABLE_WINSOCK | `1712848899` |  |
| PR_DL_REPORT_FLAGS | `1071316995` |  |
| PR_EFORMS_FOR_LOCALE_ENTRYID | `1713635586` |  |
| PR_EFORMS_LOCALE_ID | `1072234499` |  |
| PR_EFORMS_REGISTRY_ENTRYID | `1713438978` |  |
| PR_EMS_AB_ACCESS_CATEGORY | `2151940099` |  |
| PR_EMS_AB_ACTIVATION_SCHEDULE | `2152005890` |  |
| PR_EMS_AB_ACTIVATION_STYLE | `2152071171` |  |
| PR_EMS_AB_ADDRESS_ENTRY_DISPLAY_TABLE | `2148991234` |  |
| PR_EMS_AB_ADDRESS_ENTRY_DISPLAY_TABLE_MSDOS | `2152136962` |  |
| PR_EMS_AB_ADDRESS_SYNTAX | `2149056770` |  |
| PR_EMS_AB_ADDRESS_TYPE | `2152202270` |  |
| PR_EMS_AB_ADMD | `2152267806` |  |
| PR_EMS_AB_ADMIN_DESCRIPTION | `2152333342` |  |
| PR_EMS_AB_ADMIN_DISPLAY_NAME | `2152398878` |  |
| PR_EMS_AB_ADMIN_EXTENSION_DLL | `2152464414` |  |
| PR_EMS_AB_ALIASED_OBJECT_NAME | `2152529950` |  |
| PR_EMS_AB_ALIASED_OBJECT_NAME_O | `2152529933` |  |
| PR_EMS_AB_ALT_RECIPIENT | `2152595486` |  |
| PR_EMS_AB_ALT_RECIPIENT_BL | `2152665118` |  |
| PR_EMS_AB_ALT_RECIPIENT_BL_O | `2152661005` |  |
| PR_EMS_AB_ALT_RECIPIENT_O | `2152595469` |  |
| PR_EMS_AB_ANCESTOR_ID | `2152726786` |  |
| PR_EMS_AB_ANONYMOUS_ACCESS | `2173108235` |  |
| PR_EMS_AB_ANONYMOUS_ACCOUNT | `2351300638` |  |
| PR_EMS_AB_ASSOC_NT_ACCOUNT | `2150039810` |  |
| PR_EMS_AB_ASSOC_PROTOCOL_CFG_NNTP | `2175074334` |  |
| PR_EMS_AB_ASSOC_PROTOCOL_CFG_NNTP_O | `2175074317` |  |
| PR_EMS_AB_ASSOC_REMOTE_DXA | `2152796190` |  |
| PR_EMS_AB_ASSOC_REMOTE_DXA_O | `2152792077` |  |
| PR_EMS_AB_ASSOCIATION_LIFETIME | `2152857603` |  |
| PR_EMS_AB_ATTRIBUTE_CERTIFICATE | `2353336578` |  |
| PR_EMS_AB_AUTH_ORIG_BL | `2152927262` |  |
| PR_EMS_AB_AUTH_ORIG_BL_O | `2152923149` |  |
| PR_EMS_AB_AUTHENTICATION_TO_USE | `2174353438` |  |
| PR_EMS_AB_AUTHORITY_REVOCATION_LIST | `2149978370` |  |
| PR_EMS_AB_AUTHORIZED_DOMAIN | `2152988702` |  |
| PR_EMS_AB_AUTHORIZED_PASSWORD | `2153054466` |  |
| PR_EMS_AB_AUTHORIZED_PASSWORD_CONFIRM | `2173829378` |  |
| PR_EMS_AB_AUTHORIZED_USER | `2153119774` |  |
| PR_EMS_AB_AUTOREPLY | `2148204555` |  |
| PR_EMS_AB_AUTOREPLY_MESSAGE | `2148139038` |  |
| PR_EMS_AB_AUTOREPLY_SUBJECT | `2151546910` |  |
| PR_EMS_AB_AVAILABLE_AUTHORIZATION_PACKAGES | `2172719134` |  |
| PR_EMS_AB_AVAILABLE_DISTRIBUTIONS | `2173370398` |  |
| PR_EMS_AB_BRIDGEHEAD_SERVERS | `2171867166` |  |
| PR_EMS_AB_BRIDGEHEAD_SERVERS_O | `2171863053` |  |
| PR_EMS_AB_BUSINESS_CATEGORY | `2153189406` |  |
| PR_EMS_AB_BUSINESS_ROLES | `2149777666` |  |
| PR_EMS_AB_CA_CERTIFICATE | `2147684610` |  |
| PR_EMS_AB_CAN_CREATE_PF | `2153254942` |  |
| PR_EMS_AB_CAN_CREATE_PF_BL | `2153320478` |  |
| PR_EMS_AB_CAN_CREATE_PF_BL_O | `2153316365` |  |
| PR_EMS_AB_CAN_CREATE_PF_DL | `2153386014` |  |
| PR_EMS_AB_CAN_CREATE_PF_DL_BL | `2153451550` |  |
| PR_EMS_AB_CAN_CREATE_PF_DL_BL_O | `2153447437` |  |
| PR_EMS_AB_CAN_CREATE_PF_DL_O | `2153381901` |  |
| PR_EMS_AB_CAN_CREATE_PF_O | `2153250829` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF | `2153517086` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_BL | `2153582622` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_BL_O | `2153578509` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_DL | `2153648158` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_DL_BL | `2153713694` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_DL_BL_O | `2153709581` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_DL_O | `2153644045` |  |
| PR_EMS_AB_CAN_NOT_CREATE_PF_O | `2153512973` |  |
| PR_EMS_AB_CAN_PRESERVE_DNS | `2153775115` |  |
| PR_EMS_AB_CERTIFICATE_CHAIN_V3 | `2351366402` |  |
| PR_EMS_AB_CERTIFICATE_REVOCATION_LIST | `2148925698` |  |
| PR_EMS_AB_CERTIFICATE_REVOCATION_LIST_V1 | `2351497474` |  |
| PR_EMS_AB_CERTIFICATE_REVOCATION_LIST_V3 | `2351431938` |  |
| PR_EMS_AB_CHARACTER_SET | `2172977182` |  |
| PR_EMS_AB_CHARACTER_SET_LIST | `2172784670` |  |
| PR_EMS_AB_CHILD_RDNS | `4294447134` |  |
| PR_EMS_AB_CLIENT_ACCESS_ENABLED | `2351169547` |  |
| PR_EMS_AB_CLOCK_ALERT_OFFSET | `2153840643` |  |
| PR_EMS_AB_CLOCK_ALERT_REPAIR | `2153906187` |  |
| PR_EMS_AB_CLOCK_WARNING_OFFSET | `2153971715` |  |
| PR_EMS_AB_CLOCK_WARNING_REPAIR | `2154037259` |  |
| PR_EMS_AB_COMPROMISED_KEY_LIST | `2177106178` |  |
| PR_EMS_AB_COMPUTER_NAME | `2154102814` |  |
| PR_EMS_AB_CONNECTED_DOMAINS | `2154172446` |  |
| PR_EMS_AB_CONNECTION_LIST_FILTER | `2172649730` |  |
| PR_EMS_AB_CONNECTION_LIST_FILTER_TYPE | `2176057347` |  |
| PR_EMS_AB_CONNECTION_TYPE | `2175991819` |  |
| PR_EMS_AB_CONTAINER_INFO | `2154233859` |  |
| PR_EMS_AB_CONTENT_TYPE | `2173042691` |  |
| PR_EMS_AB_CONTROL_MSG_FOLDER_ID | `2173174018` |  |
| PR_EMS_AB_CONTROL_MSG_RULES | `2173305090` |  |
| PR_EMS_AB_COST | `2154299395` |  |
| PR_EMS_AB_COUNTRY_NAME | `2154364958` |  |
| PR_EMS_AB_CROSS_CERTIFICATE_CRL | `2351960322` |  |
| PR_EMS_AB_CROSS_CERTIFICATE_PAIR | `2149912834` |  |
| PR_EMS_AB_DEFAULT_MESSAGE_FORMAT | `2352414731` |  |
| PR_EMS_AB_DELEGATE_USER | `2353594379` |  |
| PR_EMS_AB_DELIV_EITS | `2154500354` |  |
| PR_EMS_AB_DELIV_EXT_CONT_TYPES | `2154565890` |  |
| PR_EMS_AB_DELIVER_AND_REDIRECT | `2154627083` |  |
| PR_EMS_AB_DELIVERY_MECHANISM | `2154692611` |  |
| PR_EMS_AB_DELTA_REVOCATION_LIST | `2353402114` |  |
| PR_EMS_AB_DESCRIPTION | `2154762270` |  |
| PR_EMS_AB_DESTINATION_INDICATOR | `2154827806` |  |
| PR_EMS_AB_DIAGNOSTIC_REG_KEY | `2154889246` |  |
| PR_EMS_AB_DISABLE_DEFERRED_COMMIT | `2351104011` |  |
| PR_EMS_AB_DISABLED_GATEWAY_PROXY | `2177044510` |  |
| PR_EMS_AB_DISPLAY_NAME_OVERRIDE | `2147549195` |  |
| PR_EMS_AB_DISPLAY_NAME_SUFFIX | `2353266718` |  |
| PR_EMS_AB_DL_MEM_REJECT_PERMS_BL | `2154958878` |  |
| PR_EMS_AB_DL_MEM_REJECT_PERMS_BL_O | `2154954765` |  |
| PR_EMS_AB_DL_MEMBER_RULE | `2155090178` |  |
| PR_EMS_AB_DMD_NAME | `2354446366` |  |
| PR_EMS_AB_DO_OAB_VERSION | `2352611331` |  |
| PR_EMS_AB_DOMAIN_DEF_ALT_RECIP | `2155151390` |  |
| PR_EMS_AB_DOMAIN_DEF_ALT_RECIP_O | `2155151373` |  |
| PR_EMS_AB_DOMAIN_NAME | `2155216926` |  |
| PR_EMS_AB_DSA_SIGNATURE | `2155282690` |  |
| PR_EMS_AB_DXA_ADMIN_COPY | `2155347979` |  |
| PR_EMS_AB_DXA_ADMIN_FORWARD | `2155413515` |  |
| PR_EMS_AB_DXA_ADMIN_UPDATE | `2155479043` |  |
| PR_EMS_AB_DXA_APPEND_REQCN | `2155544587` |  |
| PR_EMS_AB_DXA_CONF_CONTAINER_LIST | `2155614238` |  |
| PR_EMS_AB_DXA_CONF_CONTAINER_LIST_O | `2155610125` |  |
| PR_EMS_AB_DXA_CONF_REQ_TIME | `2155675712` |  |
| PR_EMS_AB_DXA_CONF_SEQ | `2155741214` |  |
| PR_EMS_AB_DXA_CONF_SEQ_USN | `2155806723` |  |
| PR_EMS_AB_DXA_EXCHANGE_OPTIONS | `2155872259` |  |
| PR_EMS_AB_DXA_EXPORT_NOW | `2155937803` |  |
| PR_EMS_AB_DXA_FLAGS | `2156003331` |  |
| PR_EMS_AB_DXA_IMP_SEQ | `2156068894` |  |
| PR_EMS_AB_DXA_IMP_SEQ_TIME | `2156134464` |  |
| PR_EMS_AB_DXA_IMP_SEQ_USN | `2156199939` |  |
| PR_EMS_AB_DXA_IMPORT_NOW | `2156265483` |  |
| PR_EMS_AB_DXA_IN_TEMPLATE_MAP | `2156335134` |  |
| PR_EMS_AB_DXA_LOCAL_ADMIN | `2156396574` |  |
| PR_EMS_AB_DXA_LOCAL_ADMIN_O | `2156396557` |  |
| PR_EMS_AB_DXA_LOGGING_LEVEL | `2156462083` |  |
| PR_EMS_AB_DXA_NATIVE_ADDRESS_TYPE | `2156527646` |  |
| PR_EMS_AB_DXA_OUT_TEMPLATE_MAP | `2156597278` |  |
| PR_EMS_AB_DXA_PASSWORD | `2156658718` |  |
| PR_EMS_AB_DXA_PREV_EXCHANGE_OPTIONS | `2156724227` |  |
| PR_EMS_AB_DXA_PREV_EXPORT_NATIVE_ONLY | `2156789771` |  |
| PR_EMS_AB_DXA_PREV_IN_EXCHANGE_SENSITIVITY | `2156855299` |  |
| PR_EMS_AB_DXA_PREV_REMOTE_ENTRIES | `2156920862` |  |
| PR_EMS_AB_DXA_PREV_REMOTE_ENTRIES_O | `2156920845` |  |
| PR_EMS_AB_DXA_PREV_REPLICATION_SENSITIVITY | `2156986371` |  |
| PR_EMS_AB_DXA_PREV_TEMPLATE_OPTIONS | `2157051907` |  |
| PR_EMS_AB_DXA_PREV_TYPES | `2157117443` |  |
| PR_EMS_AB_DXA_RECIPIENT_CP | `2157183006` |  |
| PR_EMS_AB_DXA_REMOTE_CLIENT | `2157248542` |  |
| PR_EMS_AB_DXA_REMOTE_CLIENT_O | `2157248525` |  |
| PR_EMS_AB_DXA_REQ_SEQ | `2157314078` |  |
| PR_EMS_AB_DXA_REQ_SEQ_TIME | `2157379648` |  |
| PR_EMS_AB_DXA_REQ_SEQ_USN | `2157445123` |  |
| PR_EMS_AB_DXA_REQNAME | `2157510686` |  |
| PR_EMS_AB_DXA_SVR_SEQ | `2157576222` |  |
| PR_EMS_AB_DXA_SVR_SEQ_TIME | `2157641792` |  |
| PR_EMS_AB_DXA_SVR_SEQ_USN | `2157707267` |  |
| PR_EMS_AB_DXA_TASK | `2157772803` |  |
| PR_EMS_AB_DXA_TEMPLATE_OPTIONS | `2157838339` |  |
| PR_EMS_AB_DXA_TEMPLATE_TIMESTAMP | `2157903936` |  |
| PR_EMS_AB_DXA_TYPES | `2157969411` |  |
| PR_EMS_AB_DXA_UNCONF_CONTAINER_LIST | `2158039070` |  |
| PR_EMS_AB_DXA_UNCONF_CONTAINER_LIST_O | `2158034957` |  |
| PR_EMS_AB_EMPLOYEE_NUMBER | `2355560478` |  |
| PR_EMS_AB_EMPLOYEE_TYPE | `2355691550` |  |
| PR_EMS_AB_ENABLE_COMPATIBILITY | `2352087051` |  |
| PR_EMS_AB_ENABLED | `2350972939` |  |
| PR_EMS_AB_ENABLED_AUTHORIZATION_PACKAGES | `2172915742` |  |
| PR_EMS_AB_ENABLED_PROTOCOL_CFG | `2175270923` |  |
| PR_EMS_AB_ENABLED_PROTOCOLS | `2172583939` |  |
| PR_EMS_AB_ENCAPSULATION_METHOD | `2158100483` |  |
| PR_EMS_AB_ENCRYPT | `2158166027` |  |
| PR_EMS_AB_ENCRYPT_ALG_LIST_NA | `2151682078` |  |
| PR_EMS_AB_ENCRYPT_ALG_LIST_OTHER | `2151747614` |  |
| PR_EMS_AB_ENCRYPT_ALG_SELECTED_NA | `2151874590` |  |
| PR_EMS_AB_ENCRYPT_ALG_SELECTED_OTHER | `2151481374` |  |
| PR_EMS_AB_EXPAND_DLS_LOCALLY | `2158231563` |  |
| PR_EMS_AB_EXPIRATION_TIME | `2150105152` |  |
| PR_EMS_AB_EXPORT_CONTAINERS | `2158301214` |  |
| PR_EMS_AB_EXPORT_CONTAINERS_O | `2158297101` |  |
| PR_EMS_AB_EXPORT_CUSTOM_RECIPIENTS | `2158362635` |  |
| PR_EMS_AB_EXTENDED_CHARS_ALLOWED | `2158428171` |  |
| PR_EMS_AB_EXTENSION_DATA | `2158498050` |  |
| PR_EMS_AB_EXTENSION_NAME | `2158563358` |  |
| PR_EMS_AB_EXTENSION_NAME_INHERITED | `2158628894` |  |
| PR_EMS_AB_FACSIMILE_TELEPHONE_NUMBER | `2158694658` |  |
| PR_EMS_AB_FILE_VERSION | `2158756098` |  |
| PR_EMS_AB_FILTER_LOCAL_ADDRESSES | `2158821387` |  |
| PR_EMS_AB_FOLDERS_CONTAINER | `2158886942` |  |
| PR_EMS_AB_FOLDERS_CONTAINER_O | `2158886925` |  |
| PR_EMS_AB_FORM_DATA | `2355429634` |  |
| PR_EMS_AB_FORWARDING_ADDRESS | `2355363870` |  |
| PR_EMS_AB_GARBAGE_COLL_PERIOD | `2158952451` |  |
| PR_EMS_AB_GATEWAY_LOCAL_CRED | `2159018014` |  |
| PR_EMS_AB_GATEWAY_LOCAL_DESIG | `2159083550` |  |
| PR_EMS_AB_GATEWAY_PROXY | `2159153182` |  |
| PR_EMS_AB_GATEWAY_ROUTING_TREE | `2159214850` |  |
| PR_EMS_AB_GENERATION_QUALIFIER | `2354249758` |  |
| PR_EMS_AB_GROUP_BY_ATTR_1 | `2176253982` |  |
| PR_EMS_AB_GROUP_BY_ATTR_2 | `2176319518` |  |
| PR_EMS_AB_GROUP_BY_ATTR_3 | `2176385054` |  |
| PR_EMS_AB_GROUP_BY_ATTR_4 | `2176450590` |  |
| PR_EMS_AB_GROUP_BY_ATTR_VALUE_DN | `2350514206` |  |
| PR_EMS_AB_GROUP_BY_ATTR_VALUE_DN_O | `2350514189` |  |
| PR_EMS_AB_GROUP_BY_ATTR_VALUE_STR | `2350448670` |  |
| PR_EMS_AB_GWART_LAST_MODIFIED | `2159280192` |  |
| PR_EMS_AB_HAS_FULL_REPLICA_NCS | `2159349790` |  |
| PR_EMS_AB_HAS_FULL_REPLICA_NCS_O | `2159345677` |  |
| PR_EMS_AB_HAS_MASTER_NCS | `2159415326` |  |
| PR_EMS_AB_HAS_MASTER_NCS_O | `2159411213` |  |
| PR_EMS_AB_HELP_DATA16 | `2151284994` |  |
| PR_EMS_AB_HELP_DATA32 | `2148532482` |  |
| PR_EMS_AB_HELP_FILE_NAME | `2151350302` |  |
| PR_EMS_AB_HEURISTICS | `2159476739` |  |
| PR_EMS_AB_HIDE_DL_MEMBERSHIP | `2159542283` |  |
| PR_EMS_AB_HIDE_FROM_ADDRESS_BOOK | `2159607819` |  |
| PR_EMS_AB_HIERARCHY_PATH | `4294508574` |  |
| PR_EMS_AB_HOME_MDB_BL | `2148798494` |  |
| PR_EMS_AB_HOME_MDB_BL_O | `2148794381` |  |
| PR_EMS_AB_HOME_MTA | `2147942430` |  |
| PR_EMS_AB_HOME_MTA_O | `2147942413` |  |
| PR_EMS_AB_HOME_PUBLIC_SERVER | `2151612446` |  |
| PR_EMS_AB_HOME_PUBLIC_SERVER_O | `2151612429` |  |
| PR_EMS_AB_HOUSE_IDENTIFIER | `2354315294` |  |
| PR_EMS_AB_HTTP_PUB_AB_ATTRIBUTES | `2175340574` |  |
| PR_EMS_AB_HTTP_PUB_GAL | `2174418955` |  |
| PR_EMS_AB_HTTP_PUB_GAL_LIMIT | `2174484483` |  |
| PR_EMS_AB_HTTP_PUB_PF | `2174619906` |  |
| PR_EMS_AB_HTTP_SERVERS | `2175471646` |  |
| PR_EMS_AB_IMPORT_CONTAINER | `2159673374` |  |
| PR_EMS_AB_IMPORT_CONTAINER_O | `2159673357` |  |
| PR_EMS_AB_IMPORT_SENSITIVITY | `2159738883` |  |
| PR_EMS_AB_IMPORTED_FROM | `2151809054` |  |
| PR_EMS_AB_INBOUND_ACCEPT_ALL | `2350907403` |  |
| PR_EMS_AB_INBOUND_DN | `2350776350` |  |
| PR_EMS_AB_INBOUND_DN_O | `2350776333` |  |
| PR_EMS_AB_INBOUND_HOST | `2173571102` |  |
| PR_EMS_AB_INBOUND_NEWSFEED | `2173894686` |  |
| PR_EMS_AB_INBOUND_NEWSFEED_TYPE | `2350841867` |  |
| PR_EMS_AB_INBOUND_SITES | `2159808542` |  |
| PR_EMS_AB_INBOUND_SITES_O | `2159804429` |  |
| PR_EMS_AB_INCOMING_MSG_SIZE_LIMIT | `2173698051` |  |
| PR_EMS_AB_INCOMING_PASSWORD | `2175729922` |  |
| PR_EMS_AB_INSADMIN | `2177171486` |  |
| PR_EMS_AB_INSADMIN_O | `2177171469` |  |
| PR_EMS_AB_INSTANCE_TYPE | `2159869955` |  |
| PR_EMS_AB_INTERNATIONAL_ISDN_NUMBER | `2159939614` |  |
| PR_EMS_AB_INVOCATION_ID | `2160001282` |  |
| PR_EMS_AB_IS_DELETED | `2160066571` |  |
| PR_EMS_AB_IS_SINGLE_VALUED | `2160132107` |  |
| PR_EMS_AB_KCC_STATUS | `2160201986` |  |
| PR_EMS_AB_KM_SERVER | `2148335646` |  |
| PR_EMS_AB_KM_SERVER_O | `2148335629` |  |
| PR_EMS_AB_KNOWLEDGE_INFORMATION | `2160267294` |  |
| PR_EMS_AB_LABELEDURI | `2354118686` |  |
| PR_EMS_AB_LANGUAGE | `2172125187` |  |
| PR_EMS_AB_LANGUAGE_ISO639 | `2355888158` |  |
| PR_EMS_AB_LDAP_DISPLAY_NAME | `2171670558` |  |
| PR_EMS_AB_LDAP_SEARCH_CFG | `2350710787` |  |
| PR_EMS_AB_LINE_WRAP | `2160328707` |  |
| PR_EMS_AB_LINK_ID | `2160394243` |  |
| PR_EMS_AB_LIST_PUBLIC_FOLDERS | `2354053131` |  |
| PR_EMS_AB_LOCAL_BRIDGE_HEAD | `2160459806` |  |
| PR_EMS_AB_LOCAL_BRIDGE_HEAD_ADDRESS | `2160525342` |  |
| PR_EMS_AB_LOCAL_INITIAL_TURN | `2160590859` |  |
| PR_EMS_AB_LOCAL_SCOPE | `2160660510` |  |
| PR_EMS_AB_LOCAL_SCOPE_O | `2160656397` |  |
| PR_EMS_AB_LOG_FILENAME | `2160721950` |  |
| PR_EMS_AB_LOG_ROLLOVER_INTERVAL | `2160787459` |  |
| PR_EMS_AB_MAIL_DROP | `2355298334` |  |
| PR_EMS_AB_MAINTAIN_AUTOREPLY_HISTORY | `2160853003` |  |
| PR_EMS_AB_MAPI_DISPLAY_TYPE | `2160918531` |  |
| PR_EMS_AB_MAPI_ID | `2160984067` |  |
| PR_EMS_AB_MAXIMUM_OBJECT_ID | `2171142402` |  |
| PR_EMS_AB_MDB_BACKOFF_INTERVAL | `2161049603` |  |
| PR_EMS_AB_MDB_MSG_TIME_OUT_PERIOD | `2161115139` |  |
| PR_EMS_AB_MDB_OVER_QUOTA_LIMIT | `2161180675` |  |
| PR_EMS_AB_MDB_STORAGE_QUOTA | `2161246211` |  |
| PR_EMS_AB_MDB_UNREAD_LIMIT | `2161311747` |  |
| PR_EMS_AB_MDB_USE_DEFAULTS | `2161377291` |  |
| PR_EMS_AB_MESSAGE_TRACKING_ENABLED | `2161442827` |  |
| PR_EMS_AB_MIME_TYPES | `2350645506` |  |
| PR_EMS_AB_MODERATED | `2175533067` |  |
| PR_EMS_AB_MODERATOR | `2174287902` |  |
| PR_EMS_AB_MONITOR_CLOCK | `2161508363` |  |
| PR_EMS_AB_MONITOR_SERVERS | `2161573899` |  |
| PR_EMS_AB_MONITOR_SERVICES | `2161639435` |  |
| PR_EMS_AB_MONITORED_CONFIGURATIONS | `2161709086` |  |
| PR_EMS_AB_MONITORED_CONFIGURATIONS_O | `2161704973` |  |
| PR_EMS_AB_MONITORED_SERVERS | `2161774622` |  |
| PR_EMS_AB_MONITORED_SERVERS_O | `2161770509` |  |
| PR_EMS_AB_MONITORED_SERVICES | `2161840158` |  |
| PR_EMS_AB_MONITORING_ALERT_DELAY | `2161901571` |  |
| PR_EMS_AB_MONITORING_ALERT_UNITS | `2161967107` |  |
| PR_EMS_AB_MONITORING_AVAILABILITY_STYLE | `2162032643` |  |
| PR_EMS_AB_MONITORING_AVAILABILITY_WINDOW | `2162098434` |  |
| PR_EMS_AB_MONITORING_CACHED_VIA_MAIL | `2162167838` |  |
| PR_EMS_AB_MONITORING_CACHED_VIA_MAIL_O | `2162163725` |  |
| PR_EMS_AB_MONITORING_CACHED_VIA_RPC | `2162233374` |  |
| PR_EMS_AB_MONITORING_CACHED_VIA_RPC_O | `2162229261` |  |
| PR_EMS_AB_MONITORING_ESCALATION_PROCEDURE | `2162299138` |  |
| PR_EMS_AB_MONITORING_HOTSITE_POLL_INTERVAL | `2162360323` |  |
| PR_EMS_AB_MONITORING_HOTSITE_POLL_UNITS | `2162425859` |  |
| PR_EMS_AB_MONITORING_MAIL_UPDATE_INTERVAL | `2162491395` |  |
| PR_EMS_AB_MONITORING_MAIL_UPDATE_UNITS | `2162556931` |  |
| PR_EMS_AB_MONITORING_NORMAL_POLL_INTERVAL | `2162622467` |  |
| PR_EMS_AB_MONITORING_NORMAL_POLL_UNITS | `2162688003` |  |
| PR_EMS_AB_MONITORING_RECIPIENTS | `2162757662` |  |
| PR_EMS_AB_MONITORING_RECIPIENTS_NDR | `2162823198` |  |
| PR_EMS_AB_MONITORING_RECIPIENTS_NDR_O | `2162819085` |  |
| PR_EMS_AB_MONITORING_RECIPIENTS_O | `2162753549` |  |
| PR_EMS_AB_MONITORING_RPC_UPDATE_INTERVAL | `2162884611` |  |
| PR_EMS_AB_MONITORING_RPC_UPDATE_UNITS | `2162950147` |  |
| PR_EMS_AB_MONITORING_WARNING_DELAY | `2163015683` |  |
| PR_EMS_AB_MONITORING_WARNING_UNITS | `2163081219` |  |
| PR_EMS_AB_MTA_LOCAL_CRED | `2163146782` |  |
| PR_EMS_AB_MTA_LOCAL_DESIG | `2163212318` |  |
| PR_EMS_AB_N_ADDRESS | `2163278082` |  |
| PR_EMS_AB_N_ADDRESS_TYPE | `2163343363` |  |
| PR_EMS_AB_NEWSFEED_TYPE | `2173960195` |  |
| PR_EMS_AB_NEWSGROUP | `2174222366` |  |
| PR_EMS_AB_NEWSGROUP_LIST | `2174091522` |  |
| PR_EMS_AB_NNTP_CHARACTER_SET | `2172452894` |  |
| PR_EMS_AB_NNTP_CONTENT_FORMAT | `2171994142` |  |
| PR_EMS_AB_NNTP_DISTRIBUTIONS | `2174160926` |  |
| PR_EMS_AB_NNTP_DISTRIBUTIONS_FLAG | `2175008779` |  |
| PR_EMS_AB_NNTP_NEWSFEEDS | `2175143966` |  |
| PR_EMS_AB_NNTP_NEWSFEEDS_O | `2175139853` |  |
| PR_EMS_AB_NT_MACHINE_NAME | `2163408926` |  |
| PR_EMS_AB_NT_SECURITY_DESCRIPTOR | `2148729090` |  |
| PR_EMS_AB_NUM_OF_OPEN_RETRIES | `2163474435` |  |
| PR_EMS_AB_NUM_OF_TRANSFER_RETRIES | `2163539971` |  |
| PR_EMS_AB_OBJ_VIEW_CONTAINERS | `2177306654` |  |
| PR_EMS_AB_OBJ_VIEW_CONTAINERS_O | `2177302541` |  |
| PR_EMS_AB_OBJECT_CLASS_CATEGORY | `2163605507` |  |
| PR_EMS_AB_OBJECT_OID | `4294574338` |  |
| PR_EMS_AB_OBJECT_VERSION | `2163671043` |  |
| PR_EMS_AB_OFF_LINE_AB_CONTAINERS | `2163740702` |  |
| PR_EMS_AB_OFF_LINE_AB_CONTAINERS_O | `2163736589` |  |
| PR_EMS_AB_OFF_LINE_AB_SCHEDULE | `2163802370` |  |
| PR_EMS_AB_OFF_LINE_AB_SERVER | `2163867678` |  |
| PR_EMS_AB_OFF_LINE_AB_SERVER_O | `2163867661` |  |
| PR_EMS_AB_OFF_LINE_AB_STYLE | `2163933187` |  |
| PR_EMS_AB_OID_TYPE | `2163998723` |  |
| PR_EMS_AB_OM_OBJECT_CLASS | `2164064514` |  |
| PR_EMS_AB_OM_SYNTAX | `2164129795` |  |
| PR_EMS_AB_OOF_REPLY_TO_ORIGINATOR | `2164195339` |  |
| PR_EMS_AB_OPEN_RETRY_INTERVAL | `2164260867` |  |
| PR_EMS_AB_ORGANIZATION_NAME | `2164330526` |  |
| PR_EMS_AB_ORGANIZATIONAL_UNIT_NAME | `2164396062` |  |
| PR_EMS_AB_ORIGINAL_DISPLAY_TABLE | `2164457730` |  |
| PR_EMS_AB_ORIGINAL_DISPLAY_TABLE_MSDOS | `2164523266` |  |
| PR_EMS_AB_OTHER_RECIPS | `4026531853` |  |
| PR_EMS_AB_OUTBOUND_HOST | `2173501698` |  |
| PR_EMS_AB_OUTBOUND_HOST_TYPE | `2175795211` |  |
| PR_EMS_AB_OUTBOUND_NEWSFEED | `2174025758` |  |
| PR_EMS_AB_OUTBOUND_SITES | `2164592670` |  |
| PR_EMS_AB_OUTBOUND_SITES_O | `2164588557` |  |
| PR_EMS_AB_OUTGOING_MSG_SIZE_LIMIT | `2173632515` |  |
| PR_EMS_AB_OVERRIDE_NNTP_CONTENT_FORMAT | `2177237003` |  |
| PR_EMS_AB_OWA_SERVER | `2355494942` |  |
| PR_EMS_AB_P_SELECTOR | `2164654338` |  |
| PR_EMS_AB_P_SELECTOR_INBOUND | `2164719874` |  |
| PR_EMS_AB_PER_MSG_DIALOG_DISPLAY_TABLE | `2164785410` |  |
| PR_EMS_AB_PER_RECIP_DIALOG_DISPLAY_TABLE | `2164850946` |  |
| PR_EMS_AB_PERIOD_REP_SYNC_TIMES | `2164916482` |  |
| PR_EMS_AB_PERIOD_REPL_STAGGER | `2164981763` |  |
| PR_EMS_AB_PERSONAL_TITLE | `2355822622` |  |
| PR_EMS_AB_PF_CONTACTS | `2151157790` |  |
| PR_EMS_AB_PF_CONTACTS_O | `2151153677` |  |
| PR_EMS_AB_POP_CHARACTER_SET | `2172190750` |  |
| PR_EMS_AB_POP_CONTENT_FORMAT | `2172059678` |  |
| PR_EMS_AB_PORT_NUMBER | `2176122883` |  |
| PR_EMS_AB_POSTAL_ADDRESS | `2165051650` |  |
| PR_EMS_AB_PREFERRED_DELIVERY_METHOD | `2165116931` |  |
| PR_EMS_AB_PRESERVE_INTERNET_CONTENT | `2351038475` |  |
| PR_EMS_AB_PRMD | `2165178398` |  |
| PR_EMS_AB_PROMO_EXPIRATION | `2176974912` |  |
| PR_EMS_AB_PROTOCOL_SETTINGS | `2176192542` |  |
| PR_EMS_AB_PROXY_GENERATION_ENABLED | `2175860747` |  |
| PR_EMS_AB_PROXY_GENERATOR_DLL | `2165243934` |  |
| PR_EMS_AB_PUBLIC_DELEGATES_BL | `2165313566` |  |
| PR_EMS_AB_PUBLIC_DELEGATES_BL_O | `2165309453` |  |
| PR_EMS_AB_QUOTA_NOTIFICATION_SCHEDULE | `2165375234` |  |
| PR_EMS_AB_QUOTA_NOTIFICATION_STYLE | `2165440515` |  |
| PR_EMS_AB_RANGE_LOWER | `2165506051` |  |
| PR_EMS_AB_RANGE_UPPER | `2165571587` |  |
| PR_EMS_AB_RAS_ACCOUNT | `2175598622` |  |
| PR_EMS_AB_RAS_CALLBACK_NUMBER | `2165637150` |  |
| PR_EMS_AB_RAS_PASSWORD | `2175664386` |  |
| PR_EMS_AB_RAS_PHONE_NUMBER | `2165702686` |  |
| PR_EMS_AB_RAS_PHONEBOOK_ENTRY_NAME | `2165768222` |  |
| PR_EMS_AB_RAS_REMOTE_SRVR_NAME | `2165833758` |  |
| PR_EMS_AB_REFERRAL_LIST | `2174947358` |  |
| PR_EMS_AB_REGISTERED_ADDRESS | `2165903618` |  |
| PR_EMS_AB_REMOTE_BRIDGE_HEAD | `2165964830` |  |
| PR_EMS_AB_REMOTE_BRIDGE_HEAD_ADDRESS | `2166030366` |  |
| PR_EMS_AB_REMOTE_OUT_BH_SERVER | `2166095902` |  |
| PR_EMS_AB_REMOTE_OUT_BH_SERVER_O | `2166095885` |  |
| PR_EMS_AB_REMOTE_SITE | `2166161438` |  |
| PR_EMS_AB_REMOTE_SITE_O | `2166161421` |  |
| PR_EMS_AB_REPLICATED_OBJECT_VERSION | `2355232771` |  |
| PR_EMS_AB_REPLICATION_MAIL_MSG_SIZE | `2171076611` |  |
| PR_EMS_AB_REPLICATION_SENSITIVITY | `2166226947` |  |
| PR_EMS_AB_REPLICATION_STAGGER | `2166292483` |  |
| PR_EMS_AB_REPORT_TO_ORIGINATOR | `2166358027` |  |
| PR_EMS_AB_REPORT_TO_OWNER | `2166423563` |  |
| PR_EMS_AB_REQ_SEQ | `2166489091` |  |
| PR_EMS_AB_REQUIRE_SSL | `2351235083` |  |
| PR_EMS_AB_RESPONSIBLE_LOCAL_DXA | `2166554654` |  |
| PR_EMS_AB_RESPONSIBLE_LOCAL_DXA_O | `2166554637` |  |
| PR_EMS_AB_RETURN_EXACT_MSG_SIZE | `2354184203` |  |
| PR_EMS_AB_RID_SERVER | `2166620190` |  |
| PR_EMS_AB_RID_SERVER_O | `2166620173` |  |
| PR_EMS_AB_ROLE_OCCUPANT | `2166689822` |  |
| PR_EMS_AB_ROLE_OCCUPANT_O | `2166685709` |  |
| PR_EMS_AB_ROOT_NEWSGROUPS_FOLDER_ID | `2175926530` |  |
| PR_EMS_AB_ROUTING_LIST | `2166755358` |  |
| PR_EMS_AB_RTS_CHECKPOINT_SIZE | `2166816771` |  |
| PR_EMS_AB_RTS_RECOVERY_TIMEOUT | `2166882307` |  |
| PR_EMS_AB_RTS_WINDOW_SIZE | `2166947843` |  |
| PR_EMS_AB_RUNS_ON | `2167017502` |  |
| PR_EMS_AB_RUNS_ON_O | `2167013389` |  |
| PR_EMS_AB_S_SELECTOR | `2167079170` |  |
| PR_EMS_AB_S_SELECTOR_INBOUND | `2167144706` |  |
| PR_EMS_AB_SCHEMA_FLAGS | `2171797507` |  |
| PR_EMS_AB_SCHEMA_VERSION | `2172391427` |  |
| PR_EMS_AB_SEARCH_FLAGS | `2167209987` |  |
| PR_EMS_AB_SEARCH_GUIDE | `2167279874` |  |
| PR_EMS_AB_SECURITY_POLICY | `2353467650` |  |
| PR_EMS_AB_SECURITY_PROTOCOL | `2151092482` |  |
| PR_EMS_AB_SEE_ALSO | `2167345182` |  |
| PR_EMS_AB_SEE_ALSO_O | `2167341069` |  |
| PR_EMS_AB_SEND_EMAIL_MESSAGE | `2352021515` |  |
| PR_EMS_AB_SEND_TNEF | `2173763595` |  |
| PR_EMS_AB_SERIAL_NUMBER | `2167410718` |  |
| PR_EMS_AB_SERVER | `4294836254` |  |
| PR_EMS_AB_SERVICE_ACTION_FIRST | `2167472131` |  |
| PR_EMS_AB_SERVICE_ACTION_OTHER | `2167537667` |  |
| PR_EMS_AB_SERVICE_ACTION_SECOND | `2167603203` |  |
| PR_EMS_AB_SERVICE_RESTART_DELAY | `2167668739` |  |
| PR_EMS_AB_SERVICE_RESTART_MESSAGE | `2167734302` |  |
| PR_EMS_AB_SESSION_DISCONNECT_TIMER | `2167799811` |  |
| PR_EMS_AB_SITE_AFFINITY | `2167869470` |  |
| PR_EMS_AB_SITE_FOLDER_GUID | `2170945794` |  |
| PR_EMS_AB_SITE_FOLDER_SERVER | `2171011102` |  |
| PR_EMS_AB_SITE_FOLDER_SERVER_O | `2171011085` |  |
| PR_EMS_AB_SITE_PROXY_SPACE | `2167935006` |  |
| PR_EMS_AB_SMIME_ALG_LIST_NA | `2352156702` |  |
| PR_EMS_AB_SMIME_ALG_LIST_OTHER | `2352222238` |  |
| PR_EMS_AB_SMIME_ALG_SELECTED_NA | `2352283678` |  |
| PR_EMS_AB_SMIME_ALG_SELECTED_OTHER | `2352349214` |  |
| PR_EMS_AB_SPACE_LAST_COMPUTED | `2167996480` |  |
| PR_EMS_AB_STREET_ADDRESS | `2168061982` |  |
| PR_EMS_AB_SUB_REFS | `2168131614` |  |
| PR_EMS_AB_SUB_REFS_O | `2168127501` |  |
| PR_EMS_AB_SUB_SITE | `2172321822` |  |
| PR_EMS_AB_SUBMISSION_CONT_LENGTH | `2168193027` |  |
| PR_EMS_AB_SUPPORT_SMIME_SIGNATURES | `2353528843` |  |
| PR_EMS_AB_SUPPORTED_ALGORITHMS | `2354381058` |  |
| PR_EMS_AB_SUPPORTED_APPLICATION_CONTEXT | `2168262914` |  |
| PR_EMS_AB_SUPPORTING_STACK | `2168328222` |  |
| PR_EMS_AB_SUPPORTING_STACK_BL | `2168393758` |  |
| PR_EMS_AB_SUPPORTING_STACK_BL_O | `2168389645` |  |
| PR_EMS_AB_SUPPORTING_STACK_O | `2168324109` |  |
| PR_EMS_AB_T_SELECTOR | `2168455426` |  |
| PR_EMS_AB_T_SELECTOR_INBOUND | `2168520962` |  |
| PR_EMS_AB_TARGET_MTAS | `2168590366` |  |
| PR_EMS_AB_TELEPHONE_NUMBER | `2148667422` |  |
| PR_EMS_AB_TELEPHONE_PERSONAL_PAGER | `2355626014` |  |
| PR_EMS_AB_TELETEX_TERMINAL_IDENTIFIER | `2168656130` |  |
| PR_EMS_AB_TEMP_ASSOC_THRESHOLD | `2168717315` |  |
| PR_EMS_AB_TOMBSTONE_LIFETIME | `2168782851` |  |
| PR_EMS_AB_TRACKING_LOG_PATH_NAME | `2168848414` |  |
| PR_EMS_AB_TRANS_RETRY_MINS | `2168913923` |  |
| PR_EMS_AB_TRANS_TIMEOUT_MINS | `2168979459` |  |
| PR_EMS_AB_TRANSFER_RETRY_INTERVAL | `2169044995` |  |
| PR_EMS_AB_TRANSFER_TIMEOUT_NON_URGENT | `2169110531` |  |
| PR_EMS_AB_TRANSFER_TIMEOUT_NORMAL | `2169176067` |  |
| PR_EMS_AB_TRANSFER_TIMEOUT_URGENT | `2169241603` |  |
| PR_EMS_AB_TRANSLATION_TABLE_USED | `2169307139` |  |
| PR_EMS_AB_TRANSPORT_EXPEDITED_DATA | `2169372683` |  |
| PR_EMS_AB_TRUST_LEVEL | `2169438211` |  |
| PR_EMS_AB_TURN_REQUEST_THRESHOLD | `2169503747` |  |
| PR_EMS_AB_TWO_WAY_ALTERNATE_FACILITY | `2169569291` |  |
| PR_EMS_AB_TYPE | `2352480286` |  |
| PR_EMS_AB_UNAUTH_ORIG_BL | `2169638942` |  |
| PR_EMS_AB_UNAUTH_ORIG_BL_O | `2169634829` |  |
| PR_EMS_AB_USE_SERVER_VALUES | `2172518411` |  |
| PR_EMS_AB_USE_SITE_VALUES | `2172846091` |  |
| PR_EMS_AB_USENET_SITE_NAME | `2173239326` |  |
| PR_EMS_AB_USER_PASSWORD | `2169704706` |  |
| PR_EMS_AB_USN_CHANGED | `2150170627` |  |
| PR_EMS_AB_USN_CREATED | `2169765891` |  |
| PR_EMS_AB_USN_DSA_LAST_OBJ_REMOVED | `2169831427` |  |
| PR_EMS_AB_USN_INTERSITE | `2172256259` |  |
| PR_EMS_AB_USN_LAST_OBJ_REM | `2169896963` |  |
| PR_EMS_AB_USN_SOURCE | `2169962499` |  |
| PR_EMS_AB_VIEW_CONTAINER_1 | `2176778270` |  |
| PR_EMS_AB_VIEW_CONTAINER_2 | `2176843806` |  |
| PR_EMS_AB_VIEW_CONTAINER_3 | `2176909342` |  |
| PR_EMS_AB_VIEW_DEFINITION | `2350584066` |  |
| PR_EMS_AB_VIEW_FLAGS | `2350383107` |  |
| PR_EMS_AB_VIEW_SITE | `2176712734` |  |
| PR_EMS_AB_VOICE_MAIL_FLAGS | `2353008898` |  |
| PR_EMS_AB_VOICE_MAIL_GREETINGS | `2352943134` |  |
| PR_EMS_AB_VOICE_MAIL_PASSWORD | `2352807966` |  |
| PR_EMS_AB_VOICE_MAIL_RECORDED_NAME | `2352873730` |  |
| PR_EMS_AB_VOICE_MAIL_RECORDING_LENGTH | `2353205251` |  |
| PR_EMS_AB_VOICE_MAIL_SPEED | `2353135619` |  |
| PR_EMS_AB_VOICE_MAIL_SYSTEM_GUID | `2352677122` |  |
| PR_EMS_AB_VOICE_MAIL_USER_ID | `2352742430` |  |
| PR_EMS_AB_VOICE_MAIL_VOLUME | `2353070083` |  |
| PR_EMS_AB_WWW_HOME_PAGE | `2171928606` |  |
| PR_EMS_AB_X121_ADDRESS | `2170032158` |  |
| PR_EMS_AB_X25_CALL_USER_DATA_INCOMING | `2170093826` |  |
| PR_EMS_AB_X25_CALL_USER_DATA_OUTGOING | `2170159362` |  |
| PR_EMS_AB_X25_FACILITIES_DATA_INCOMING | `2170224898` |  |
| PR_EMS_AB_X25_FACILITIES_DATA_OUTGOING | `2170290434` |  |
| PR_EMS_AB_X25_LEASED_LINE_PORT | `2170355970` |  |
| PR_EMS_AB_X25_LEASED_OR_SWITCHED | `2170421259` |  |
| PR_EMS_AB_X25_REMOTE_MTA_PHONE | `2170486814` |  |
| PR_EMS_AB_X400_ATTACHMENT_TYPE | `2170552578` |  |
| PR_EMS_AB_X400_SELECTOR_SYNTAX | `2170617859` |  |
| PR_EMS_AB_X500_ACCESS_CONTROL_LIST | `2170683650` |  |
| PR_EMS_AB_X500_NC | `2174877726` |  |
| PR_EMS_AB_X500_RDN | `2174812190` |  |
| PR_EMS_AB_XMIT_TIMEOUT_NON_URGENT | `2170748931` |  |
| PR_EMS_AB_XMIT_TIMEOUT_NORMAL | `2170814467` |  |
| PR_EMS_AB_XMIT_TIMEOUT_URGENT | `2170880003` |  |
| PR_EVENTS_ROOT_FOLDER_ENTRYID | `1720320258` |  |
| PR_EXCESS_STORAGE_USED | `1073086467` |  |
| PR_EXTENDED_ACL_DATA | `1073611010` |  |
| PR_FAST_TRANSFER | `1714356237` |  |
| PR_FAVORITES_DEFAULT_NAME | `1714749470` |  |
| PR_FOLDER_CHILD_COUNT | `1714946051` |  |
| PR_FOLDER_DESIGN_FLAGS | `1071775747` |  |
| PR_FOLDER_PATHNAME | `1723138078` |  |
| PR_FOREIGN_ID | `1718026498` |  |
| PR_FOREIGN_REPORT_ID | `1718092034` |  |
| PR_FOREIGN_SUBJECT_ID | `1718157570` |  |
| PR_FREE_BUSY_FOR_LOCAL_SITE_ENTRYID | `1713701122` |  |
| PR_GW_ADMIN_OPERATIONS | `1717043203` |  |
| PR_GW_MTSIN_ENTRYID | `1713897730` |  |
| PR_GW_MTSOUT_ENTRYID | `1713963266` |  |
| PR_HAS_MODERATOR_RULES | `1715404811` |  |
| PR_HIERARCHY_SERVER | `1713569822` |  |
| PR_HIERARCHY_SYNCHRONIZER | `1714159629` |  |
| PR_IMAP_INTERNAL_DATE | `1710555200` |  |
| PR_IN_TRANSIT | `1712848907` |  |
| PR_INBOUND_NEWSFEED_DN | `1720516638` |  |
| PR_INTERNET_CHARSET | `1721368606` |  |
| PR_INTERNET_NEWSGROUP_NAME | `1722220574` |  |
| PR_IPM_DAF_ENTRYID | `1713307906` |  |
| PR_IPM_FAVORITES_ENTRYID | `1714422018` |  |
| PR_IPM_PUBLIC_FOLDERS_ENTRYID | `1714487554` |  |
| PR_IS_NEWSGROUP | `1721171979` |  |
| PR_IS_NEWSGROUP_ANCHOR | `1721106443` |  |
| PR_LAST_ACCESS_TIME | `1722351680` |  |
| PR_LAST_FULL_BACKUP | `1719992384` |  |
| PR_LAST_LOGOFF_TIME | `1721958464` |  |
| PR_LAST_LOGON_TIME | `1721892928` |  |
| PR_LONGTERM_ENTRYID_FROM_TABLE | `1718616322` |  |
| PR_MESSAGE_PROCESSED | `1709703179` |  |
| PR_MESSAGE_SITE_NAME | `1709637662` |  |
| PR_MOVE_TO_FOLDER_ENTRYID | `1072955650` |  |
| PR_MOVE_TO_STORE_ENTRYID | `1072890114` |  |
| PR_MSG_BODY_ID | `1071448067` |  |
| PR_MTS_SUBJECT_ID | `1717764354` |  |
| PR_NEW_SUBS_GET_AUTO_ADD | `1709572107` |  |
| PR_NEWSFEED_INFO | `1722155266` |  |
| PR_NEWSGROUP_COMPONENT | `1722089502` |  |
| PR_NEWSGROUP_ROOT_FOLDER_ENTRYID | `1720451330` |  |
| PR_NNTP_ARTICLE_FOLDER_ENTRYID | `1720320258` |  |
| PR_NNTP_CONTROL_FOLDER_ENTRYID | `1720385794` |  |
| PR_NON_IPM_SUBTREE_ENTRYID | `1713373442` |  |
| PR_NORMAL_MESSAGE_SIZE | `1723006979` |  |
| PR_NORMAL_MESSAGE_SIZE_EXTENDED | `1723006996` |  |
| PR_NORMAL_MSG_W_ATTACH_COUNT | `1722613763` |  |
| PR_NT_USER_NAME | `1721761822` |  |
| PR_OFFLINE_ADDRBOOK_ENTRYID | `1713570050` |  |
| PR_OFFLINE_FLAGS | `1715273731` |  |
| PR_OFFLINE_MESSAGE_ENTRYID | `1713832194` |  |
| PR_OLDEST_DELETED_ON | `1715601472` |  |
| PR_ORIGINATOR_ADDR | `1717305374` |  |
| PR_ORIGINATOR_ADDRTYPE | `1717370910` |  |
| PR_ORIGINATOR_ENTRYID | `1717436674` |  |
| PR_ORIGINATOR_NAME | `1717239838` |  |
| PR_OST_ENCRYPTION | `1728184323` |  |
| PR_OUTBOUND_NEWSFEED_DN | `1720582174` |  |
| PR_OVERALL_AGE_LIMIT | `1721303043` |  |
| PR_OVERALL_MSG_AGE_LIMIT | `1720909827` |  |
| PR_OWA_URL | `284229662` |  |
| PR_OWNER_COUNT | `1723203587` |  |
| PR_P1_CONTENT | `285212930` |  |
| PR_P1_CONTENT_TYPE | `285278466` |  |
| PR_PREVENT_MSG_CREATE | `1710489611` |  |
| PR_PREVIEW | `1071185950` |  |
| PR_PREVIEW_UNREAD | `1071120414` |  |
| PR_PROFILE_AB_FILES_PATH | `1712193566` |  |
| PR_PROFILE_ADDR_INFO | `1720123650` |  |
| PR_PROFILE_ALLPUB_COMMENT | `1712783390` |  |
| PR_PROFILE_ALLPUB_DISPLAY_NAME | `1712717854` |  |
| PR_PROFILE_BINDING_ORDER | `1711865886` |  |
| PR_PROFILE_CONFIG_FLAGS | `1711341571` |  |
| PR_PROFILE_CONNECT_FLAGS | `1711538179` |  |
| PR_PROFILE_FAVFLD_COMMENT | `1712652318` |  |
| PR_PROFILE_FAVFLD_DISPLAY_NAME | `1712259102` |  |
| PR_PROFILE_HOME_SERVER | `1711407134` |  |
| PR_PROFILE_HOME_SERVER_ADDRS | `1712525342` |  |
| PR_PROFILE_HOME_SERVER_DN | `1712455710` |  |
| PR_PROFILE_MAILBOX | `1711996958` |  |
| PR_PROFILE_MAX_RESTRICT | `1712128003` |  |
| PR_PROFILE_MOAB | `1719336990` |  |
| PR_PROFILE_MOAB_GUID | `1719402526` |  |
| PR_PROFILE_MOAB_SEQ | `1719468035` |  |
| PR_PROFILE_OFFLINE_INFO | `1712390402` |  |
| PR_PROFILE_OFFLINE_STORE_PATH | `1712324638` |  |
| PR_PROFILE_OPEN_FLAGS | `1711865859` |  |
| PR_PROFILE_OPTIONS_DATA | `1720254722` |  |
| PR_PROFILE_SECURE_MAILBOX | `1743782146` |  |
| PR_PROFILE_SERVER | `1712062494` |  |
| PR_PROFILE_SERVER_DN | `1712586782` |  |
| PR_PROFILE_TRANSPORT_FLAGS | `1711603715` |  |
| PR_PROFILE_TYPE | `1711931395` |  |
| PR_PROFILE_UI_STATE | `1711669251` |  |
| PR_PROFILE_UNRESOLVED_NAME | `1711734814` |  |
| PR_PROFILE_UNRESOLVED_SERVER | `1711800350` |  |
| PR_PROFILE_USER | `1711472670` |  |
| PR_PROFILE_VERSION | `1711276035` |  |
| PR_PST_ENCRYPTION | `1728184323` |  |
| PR_PST_PATH | `1728053278` |  |
| PR_PST_PW_SZ_OLD | `1728249886` |  |
| PR_PST_REMEMBER_PW | `1728118795` |  |
| PR_PUBLIC_FOLDER_ENTRYID | `1715208450` |  |
| PR_PUBLISH_IN_ADDRESS_BOOK | `1072037899` |  |
| PR_RECIPIENT_NUMBER | `1717698563` |  |
| PR_RECIPIENT_ON_ASSOC_MSG_COUNT | `1722810371` |  |
| PR_RECIPIENT_ON_NORMAL_MSG_COUNT | `1722744835` |  |
| PR_REPLICA_LIST | `1721237762` |  |
| PR_REPLICA_SERVER | `1715732510` |  |
| PR_REPLICA_VERSION | `1716191252` |  |
| PR_REPLICATION_ALWAYS_INTERVAL | `1720975363` |  |
| PR_REPLICATION_MESSAGE_PRIORITY | `1720844291` |  |
| PR_REPLICATION_MSG_SIZE | `1721040899` |  |
| PR_REPLICATION_SCHEDULE | `1720779010` |  |
| PR_REPLICATION_STYLE | `1720713219` |  |
| PR_REPLY_RECIPIENT_SMTP_PROXIES | `1073479710` |  |
| PR_REPORT_DESTINATION_ENTRYID | `1717895426` |  |
| PR_REPORT_DESTINATION_NAME | `1717829662` |  |
| PR_RESTRICTION_COUNT | `1722417155` |  |
| PR_RETENTION_AGE_LIMIT | `1724121091` |  |
| PR_RULE_TRIGGER_HISTORY | `1072824578` |  |
| PR_RULES_DATA | `1071710466` |  |
| PR_RULES_TABLE | `1071710221` |  |
| PR_SCHEDULE_FOLDER_ENTRYID | `1713242370` |  |
| PR_SECURE_IN_SITE | `1721630731` |  |
| PR_SECURE_ORIGINATION | `1071972363` |  |
| PR_STORAGE_LIMIT_INFORMATION | `1722023939` |  |
| PR_STORAGE_QUOTA_LIMIT | `1073020931` |  |
| PR_STORE_OFFLINE | `1714552843` |  |
| PR_STORE_SLOWLINK | `2081030155` |  |
| PR_SUBJECT_TRACE_INFO | `1717633282` |  |
| PR_SVR_GENERATING_QUOTA_MSG | `1073152030` |  |
| PR_SYNCHRONIZE_FLAGS | `1709441027` |  |
| PR_SYS_CONFIG_FOLDER_ENTRYID | `1714815234` |  |
| PR_TEST_LINE_SPEED | `1714094338` |  |
| PR_TRACE_INFO | `1717567746` |  |
| PR_TRANSFER_ENABLED | `1714028555` |  |
| PR_USER_NAME | `1712979998` |  |
| PR_X400_ENVELOPE_TYPE | `1716715523` |  |
| PR_AB_DEFAULT_DIR | `1023803650` |  |
| PR_AB_DEFAULT_PAB | `1023869186` |  |
| PR_AB_PROVIDER_ID | `907346178` |  |
| PR_AB_PROVIDERS | `1023475970` |  |
| PR_AB_SEARCH_PATH | `1023742210` |  |
| PR_AB_SEARCH_PATH_UPDATE | `1024524546` |  |
| PR_ALTERNATE_RECIPIENT | `973144322` |  |
| PR_ASSOC_CONTENT_COUNT | `907476995` |  |
| PR_ATTACHMENT_X400_PARAMETERS | `922747138` |  |
| PR_AUTHORIZING_USERS | `196866` |  |
| PR_BODY_CRC | `236716035` |  |
| PR_COMMON_VIEWS_ENTRYID | `904265986` |  |
| PR_CONTACT_ADDRTYPES | `978587678` |  |
| PR_CONTACT_DEFAULT_ADDRESS_INDEX | `978649091` |  |
| PR_CONTACT_EMAIL_ADDRESSES | `978718750` |  |
| PR_CONTACT_ENTRYIDS | `978522370` |  |
| PR_CONTACT_VERSION | `978452552` |  |
| PR_CONTAINER_MODIFY_VERSION | `907280404` |  |
| PR_CONTENT_CONFIDENTIALITY_ALGORITHM_ID | `393474` |  |
| PR_CONTENT_CORRELATOR | `459010` |  |
| PR_CONTENT_IDENTIFIER | `524318` |  |
| PR_CONTENT_INTEGRITY_CHECK | `201326850` |  |
| PR_CONTENT_LENGTH | `589827` |  |
| PR_CONTENT_RETURN_REQUESTED | `655371` |  |
| PR_CONTENTS_SORT_ORDER | `906825731` |  |
| PR_CONTROL_FLAGS | `1056964611` |  |
| PR_CONTROL_ID | `1057423618` |  |
| PR_CONTROL_STRUCTURE | `1057030402` |  |
| PR_CONTROL_TYPE | `1057095683` |  |
| PR_CONVERSATION_KEY | `721154` |  |
| PR_CONVERSION_EITS | `786690` |  |
| PR_CONVERSION_PROHIBITED | `973275147` |  |
| PR_CONVERSION_WITH_LOSS_PROHIBITED | `851979` |  |
| PR_CONVERTED_EITS | `917762` |  |
| PR_CORRELATE | `235667467` |  |
| PR_CORRELATE_MTSID | `235733250` |  |
| PR_CREATE_TEMPLATES | `906231821` |  |
| PR_CREATION_VERSION | `236519444` |  |
| PR_CURRENT_VERSION | `234881044` |  |
| PR_DEF_CREATE_DL | `907084034` |  |
| PR_DEF_CREATE_MAILUSER | `907149570` |  |
| PR_DEFAULT_PROFILE | `1023672331` |  |
| PR_DEFAULT_STORE | `872415243` |  |
| PR_DEFAULT_VIEW_ENTRYID | `907411714` |  |
| PR_DELEGATION | `8257794` |  |
| PR_DELIVERY_POINT | `201785347` |  |
| PR_DELTAX | `1057161219` |  |
| PR_DELTAY | `1057226755` |  |
| PR_DETAILS_TABLE | `906297357` |  |
| PR_DISC_VAL | `4849675` |  |
| PR_DISCARD_REASON | `1114115` |  |
| PR_DISCLOSE_RECIPIENTS | `973340683` |  |
| PR_DISCLOSURE_OF_RECIPIENTS | `1179659` |  |
| PR_DISCRETE_VALUES | `235798539` |  |
| PR_DL_EXPANSION_HISTORY | `1245442` |  |
| PR_DL_EXPANSION_PROHIBITED | `1310731` |  |
| PR_EXPLICIT_CONVERSION | `201392131` |  |
| PR_FILTERING_HOOKS | `1023934722` |  |
| PR_FINDER_ENTRYID | `904331522` |  |
| PR_FORM_CATEGORY | `855900190` |  |
| PR_FORM_CATEGORY_SUB | `855965726` |  |
| PR_FORM_CLSID | `855769160` |  |
| PR_FORM_CONTACT_NAME | `855834654` |  |
| PR_FORM_DESIGNER_GUID | `856227912` |  |
| PR_FORM_DESIGNER_NAME | `856162334` |  |
| PR_FORM_HIDDEN | `856096779` |  |
| PR_FORM_HOST_MAP | `856035331` |  |
| PR_FORM_MESSAGE_BEHAVIOR | `856293379` |  |
| PR_FORM_VERSION | `855703582` |  |
| PR_HEADER_FOLDER_ENTRYID | `1040843010` |  |
| PR_ICON | `268239106` |  |
| PR_IDENTITY_DISPLAY | `1040187422` |  |
| PR_IDENTITY_ENTRYID | `1040253186` |  |
| PR_IDENTITY_SEARCH_KEY | `1040515330` |  |
| PR_IMPLICIT_CONVERSION_PROHIBITED | `1441803` |  |
| PR_INCOMPLETE_COPY | `3473419` |  |
| PR_INTERNET_APPROVED | `271581214` |  |
| PR_INTERNET_ARTICLE_NUMBER | `237174787` |  |
| PR_INTERNET_CONTROL | `271646750` |  |
| PR_INTERNET_DISTRIBUTION | `271712286` |  |
| PR_INTERNET_FOLLOWUP_TO | `271777822` |  |
| PR_INTERNET_LINES | `271843331` |  |
| PR_INTERNET_NEWSGROUPS | `271974430` |  |
| PR_INTERNET_NNTP_PATH | `272105502` |  |
| PR_INTERNET_ORGANIZATION | `272039966` |  |
| PR_INTERNET_PRECEDENCE | `272695326` |  |
| PR_IPM_ID | `1573122` |  |
| PR_IPM_OUTBOX_ENTRYID | `904003842` |  |
| PR_IPM_OUTBOX_SEARCH_KEY | `873529602` |  |
| PR_IPM_RETURN_REQUESTED | `201457675` |  |
| PR_IPM_SENTMAIL_ENTRYID | `904134914` |  |
| PR_IPM_SENTMAIL_SEARCH_KEY | `873660674` |  |
| PR_IPM_SUBTREE_ENTRYID | `903872770` |  |
| PR_IPM_SUBTREE_SEARCH_KEY | `873464066` |  |
| PR_IPM_WASTEBASKET_ENTRYID | `904069378` |  |
| PR_IPM_WASTEBASKET_SEARCH_KEY | `873595138` |  |
| PR_LANGUAGES | `3080222` |  |
| PR_LATEST_DELIVERY_TIME | `1638464` |  |
| PR_MAIL_PERMISSION | `973996043` |  |
| PR_MDB_PROVIDER | `873726210` |  |
| PR_MESSAGE_DELIVERY_ID | `1769730` |  |
| PR_MESSAGE_DOWNLOAD_TIME | `236453891` |  |
| PR_MESSAGE_SECURITY_LABEL | `1966338` |  |
| PR_MESSAGE_TOKEN | `201523458` |  |
| PR_MINI_ICON | `268173570` |  |
| PR_MODIFY_VERSION | `236584980` |  |
| PR_NEWSGROUP_NAME | `237240350` |  |
| PR_NNTP_XREF | `272629790` |  |
| PR_NON_RECEIPT_REASON | `4063235` |  |
| PR_OBSOLETED_IPMS | `2031874` |  |
| PR_ORIGIN_CHECK | `2556162` |  |
| PR_ORIGINAL_AUTHOR_ADDRTYPE | `7929886` |  |
| PR_ORIGINAL_AUTHOR_EMAIL_ADDRESS | `7995422` |  |
| PR_ORIGINAL_AUTHOR_SEARCH_KEY | `5636354` |  |
| PR_ORIGINAL_DISPLAY_NAME | `974323742` |  |
| PR_ORIGINAL_EITS | `2162946` |  |
| PR_ORIGINAL_SEARCH_KEY | `974389506` |  |
| PR_ORIGINALLY_INTENDED_RECIP_ADDRTYPE | `8060958` |  |
| PR_ORIGINALLY_INTENDED_RECIP_EMAIL_ADDRESS | `8126494` |  |
| PR_ORIGINALLY_INTENDED_RECIP_ENTRYID | `269615362` |  |
| PR_ORIGINALLY_INTENDED_RECIPIENT_NAME | `2097410` |  |
| PR_ORIGINATING_MTA_CERTIFICATE | `237306114` |  |
| PR_ORIGINATOR_AND_DL_EXPANSION_HISTORY | `268566786` |  |
| PR_ORIGINATOR_CERTIFICATE | `2228482` |  |
| PR_ORIGINATOR_REQUESTED_ALTERNATE_RECIPIENT | `201916674` |  |
| PR_ORIGINATOR_RETURN_ADDRESS | `2359554` |  |
| PR_OWN_STORE_ENTRYID | `1040580866` |  |
| PR_PARENT_DISPLAY | `235208734` |  |
| PR_PHYSICAL_DELIVERY_BUREAU_FAX_DELIVERY | `201981963` |  |
| PR_PHYSICAL_DELIVERY_MODE | `202047491` |  |
| PR_PHYSICAL_DELIVERY_REPORT_REQUEST | `202113027` |  |
| PR_PHYSICAL_FORWARDING_ADDRESS | `202178818` |  |
| PR_PHYSICAL_FORWARDING_ADDRESS_REQUESTED | `202244107` |  |
| PR_PHYSICAL_FORWARDING_PROHIBITED | `202309643` |  |
| PR_PHYSICAL_RENDITION_ATTRIBUTES | `202375426` |  |
| PR_POST_FOLDER_ENTRIES | `272302338` |  |
| PR_POST_FOLDER_NAMES | `272367646` |  |
| PR_POST_REPLY_DENIED | `272564482` |  |
| PR_POST_REPLY_FOLDER_ENTRIES | `272433410` |  |
| PR_POST_REPLY_FOLDER_NAMES | `272498718` |  |
| PR_PREPROCESS | `237109259` |  |
| PR_PRIMARY_CAPABILITY | `956563714` |  |
| PR_PROFILE_NAME | `1024589854` |  |
| PR_PROOF_OF_DELIVERY | `202440962` |  |
| PR_PROOF_OF_DELIVERY_REQUESTED | `202506251` |  |
| PR_PROOF_OF_SUBMISSION | `237371650` |  |
| PR_PROOF_OF_SUBMISSION_REQUESTED | `2621451` |  |
| PR_PROVIDER_DISPLAY | `805699614` |  |
| PR_PROVIDER_DLL_NAME | `805961758` |  |
| PR_PROVIDER_ORDINAL | `806158339` |  |
| PR_PROVIDER_SUBMIT_TIME | `4718656` |  |
| PR_PROVIDER_UID | `806093058` |  |
| PR_RECEIVE_FOLDER_SETTINGS | `873791501` |  |
| PR_RECIPIENT_CERTIFICATE | `202572034` |  |
| PR_RECIPIENT_NUMBER_FOR_ADVICE | `202637342` |  |
| PR_RECIPIENT_STATUS | `236257283` |  |
| PR_REDIRECTION_HISTORY | `2883842` |  |
| PR_REGISTERED_MAIL_TYPE | `202768387` |  |
| PR_RELATED_IPMS | `2949378` |  |
| PR_REMOTE_PROGRESS | `1040908291` |  |
| PR_REMOTE_PROGRESS_TEXT | `1040973854` |  |
| PR_REMOTE_VALIDATE_OK | `1041039371` |  |
| PR_REPORTING_DL_NAME | `268632322` |  |
| PR_REPORTING_MTA_CERTIFICATE | `268697858` |  |
| PR_REQUESTED_DELIVERY_METHOD | `202899459` |  |
| PR_RESOURCE_FLAGS | `805896195` |  |
| PR_RESOURCE_METHODS | `1040318467` |  |
| PR_RESOURCE_PATH | `1040646174` |  |
| PR_RESOURCE_TYPE | `1040384003` |  |
| PR_RETURNED_IPM | `3342347` |  |
| PR_RTF_SYNC_BODY_COUNT | `268894211` |  |
| PR_RTF_SYNC_BODY_CRC | `268828675` |  |
| PR_RTF_SYNC_BODY_TAG | `268959774` |  |
| PR_RTF_SYNC_PREFIX_COUNT | `269484035` |  |
| PR_RTF_SYNC_TRAILING_COUNT | `269549571` |  |
| PR_SEARCH | `906428429` |  |
| PR_SECURITY | `3407875` |  |
| PR_SENTMAIL_ENTRYID | `235536642` |  |
| PR_SERVICE_DELETE_FILES | `1024462878` |  |
| PR_SERVICE_DLL_NAME | `1024065566` |  |
| PR_SERVICE_ENTRY_NAME | `1024131102` |  |
| PR_SERVICE_EXTRA_UIDS | `1024262402` |  |
| PR_SERVICE_NAME | `1024000030` |  |
| PR_SERVICE_SUPPORT_FILES | `1024397342` |  |
| PR_SERVICE_UID | `1024196866` |  |
| PR_SERVICES | `1024327938` |  |
| PR_SPOOLER_STATUS | `235929603` |  |
| PR_STATUS | `906690563` |  |
| PR_STATUS_CODE | `1040449539` |  |
| PR_STATUS_STRING | `1040711710` |  |
| PR_STORE_PROVIDERS | `1023410434` |  |
| PR_STORE_RECORD_KEY | `268042498` |  |
| PR_SUBJECT_IPM | `3670274` |  |
| PR_SUBMIT_FLAGS | `236191747` |  |
| PR_SUPERSEDES | `272236574` |  |
| PR_TRANSPORT_KEY | `236322819` |  |
| PR_TRANSPORT_PROVIDERS | `1023541506` |  |
| PR_TRANSPORT_STATUS | `235995139` |  |
| PR_TYPE_OF_MTS_USER | `203161603` |  |
| PR_VALID_FOLDER_MASK | `903806979` |  |
| PR_VIEWS_ENTRYID | `904200450` |  |
| PR_X400_CONTENT_TYPE | `3932418` |  |
| PR_X400_DEFERRED_DELIVERY_CANCEL | `1040777227` |  |
| PR_XPOS | `1057292291` |  |
| PR_YPOS | `1057357827` |  |

### GroupDocs.Metadata.Formats.Email
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email.md

The namespace contains classes representing saved email messages and their parts.

#### Classes

| Class | Description |
| --- | --- |
| EmailAttachmentPackage | Represents a metadata package containing email attachment name. |
| EmailHeaderPackage | Represents a metadata package containing email message headers. |
| EmailPackage | Represents email message metadata. |
| EmailRootPackage | Represents the root package allowing working with metadata in an email message. |
| EmlPackage | Represents EML message metadata. |
| EmlRootPackage | Represents the root package allowing working with metadata in an EML email message. |
| MsgAttachmentPackage | Represents a metadata package containing email attachment name and data. |
| MsgPackage | Represents MSG message metadata. |
| MsgRootPackage | Represents the root package allowing working with metadata in an MSG email message. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### EmailAttachmentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailattachmentpackage.md

#### EmailAttachmentPackage class

Represents a metadata package containing email attachment name.

```csharp
public class EmailAttachmentPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; set; } | Gets the attachment name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailattachmentpackage/name.md

#### EmailAttachmentPackage.Name property

Gets the attachment name.

```csharp
public string Name { get; set; }
```

##### Property Value

The attachment name.

### EmailHeaderPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailheaderpackage.md

#### EmailHeaderPackage class

Represents a metadata package containing email message headers.

```csharp
public class EmailHeaderPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| Get(string) | Gets the value of the specified header. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, PropertyValue) | Set the value of the specified header. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Get
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailheaderpackage/get.md

#### EmailHeaderPackage.Get method

Gets the value of the specified header.

```csharp
public string Get(string header)
```

| Parameter | Type | Description |
| --- | --- | --- |
| header | String | An email header. |

##### Return Value

The value if the package contains the specified header; otherwise, null.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailheaderpackage/set.md

#### EmailHeaderPackage.Set method

Set the value of the specified header.

```csharp
public void Set(string header, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| header | String | An email header. |
| value | PropertyValue | An email header value. |

### EmailPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage.md

#### EmailPackage class

Represents email message metadata.

```csharp
public abstract class EmailPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| BlindCarbonCopyRecipients { get; set; } | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| CarbonCopyRecipients { get; set; } | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| Count { get; } | Gets the number of metadata properties. |
| Headers { get; set; } | Gets a metadata package containing the email headers. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Recipients { get; set; } | Gets or sets the array of the email recipients. |
| SenderEmailAddress { get; set; } | Gets the email address of the sender. |
| Subject { get; set; } | Gets or sets the email subject. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to remove all attachments from an email.

```csharp
using (Metadata metadata = new Metadata(Constants.InputEml))
{
    var root = metadata.GetRootPackage<EmailRootPackage>();

    root.ClearAttachments();

    metadata.Save(Constants.OutputEml);
}
```

### BlindCarbonCopyRecipients
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/blindcarboncopyrecipients.md

#### EmailPackage.BlindCarbonCopyRecipients property

Gets or sets the array of BCC (blind carbon copy) recipients of the email message.

```csharp
public string[] BlindCarbonCopyRecipients { get; set; }
```

##### Property Value

The array of BCC (blind carbon copy) recipients of the email message.

### CarbonCopyRecipients
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/carboncopyrecipients.md

#### EmailPackage.CarbonCopyRecipients property

Gets or sets the array of CC (carbon copy) recipients of the email message.

```csharp
public string[] CarbonCopyRecipients { get; set; }
```

##### Property Value

The array of CC (carbon copy) recipients of the email message.

### Headers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/headers.md

#### EmailPackage.Headers property

Gets a metadata package containing the email headers.

```csharp
public EmailHeaderPackage Headers { get; set; }
```

##### Property Value

A metadata package containing the email headers.

### Recipients
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/recipients.md

#### EmailPackage.Recipients property

Gets or sets the array of the email recipients.

```csharp
public string[] Recipients { get; set; }
```

##### Property Value

The array of the email recipients.

### SenderEmailAddress
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/senderemailaddress.md

#### EmailPackage.SenderEmailAddress property

Gets the email address of the sender.

```csharp
public string SenderEmailAddress { get; set; }
```

##### Property Value

The email address of the sender.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailpackage/subject.md

#### EmailPackage.Subject property

Gets or sets the email subject.

```csharp
public string Subject { get; set; }
```

##### Property Value

The email subject.

### EmailRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailrootpackage.md

#### EmailRootPackage class

Represents the root package allowing working with metadata in an email message.

```csharp
public abstract class EmailRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| EmailPackage { get; } | Gets the email metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAttachments() | Removes all the attachments form the email message. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ClearAttachments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailrootpackage/clearattachments.md

#### EmailRootPackage.ClearAttachments method

Removes all the attachments form the email message.

```csharp
public void ClearAttachments()
```

### EmailPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emailrootpackage/emailpackage.md

#### EmailRootPackage.EmailPackage property

Gets the email metadata package.

```csharp
public EmailPackage EmailPackage { get; }
```

##### Property Value

The email metadata package.

### EmlPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emlpackage.md

#### EmlPackage class

Represents EML message metadata.

```csharp
public class EmlPackage : EmailPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Attachments { get; set; } | Gets an array of the attached files. |
| BlindCarbonCopyRecipients { get; set; } | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| CarbonCopyRecipients { get; set; } | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| Count { get; } | Gets the number of metadata properties. |
| Headers { get; set; } | Gets a metadata package containing the email headers. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Recipients { get; set; } | Gets or sets the array of the email recipients. |
| SenderEmailAddress { get; set; } | Gets the email address of the sender. |
| Subject { get; set; } | Gets or sets the email subject. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Attachments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emlpackage/attachments.md

#### EmlPackage.Attachments property

Gets an array of the attached files.

```csharp
public EmailAttachmentPackage[] Attachments { get; set; }
```

##### Property Value

An array of the attached files.

### EmlRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emlrootpackage.md

#### EmlRootPackage class

Represents the root package allowing working with metadata in an EML email message.

```csharp
public class EmlRootPackage : EmailRootPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| EmailPackage { get; } | Gets the EML metadata package. (2 properties) |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAttachments() | Removes all the attachments form the email message. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract metadata from an EML message.

```csharp
using (Metadata metadata = new Metadata(Constants.InputEml))
{
    var root = metadata.GetRootPackage<EmlRootPackage>();

    Console.WriteLine(root.EmailPackage.Sender);
    Console.WriteLine(root.EmailPackage.Subject);
    foreach (string recipient in root.EmailPackage.Recipients)
    {
        Console.WriteLine(recipient);
    }

    foreach (var attachedFileName in root.EmailPackage.AttachedFileNames)
    {
        Console.WriteLine(attachedFileName);
    }

    foreach (var header in root.EmailPackage.Headers)
    {
        Console.WriteLine("{0} = {1}", header.Name, header.Value);
    }

    // ...
}
```

### EmailPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/emlrootpackage/emailpackage.md

#### EmlRootPackage.EmailPackage property

Gets the EML metadata package.

```csharp
public EmlPackage EmailPackage { get; }
```

##### Property Value

The EML metadata package.

### MsgAttachmentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgattachmentpackage.md

#### MsgAttachmentPackage class

Represents a metadata package containing email attachment name and data.

```csharp
public class MsgAttachmentPackage : EmailAttachmentPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| MsgAttachmentPackage(string, byte[]) | MsgAttachmentPackage constructor |

#### Properties

| Name | Description |
| --- | --- |
| Content { get; set; } | Gets the last attachment data on byte array. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; set; } | Gets the attachment name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Content
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgattachmentpackage/content.md

#### MsgAttachmentPackage.Content property

Gets the last attachment data on byte array.

```csharp
public byte[] Content { get; set; }
```

##### Property Value

Attachment data on byte array.

### MsgAttachmentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgattachmentpackage/msgattachmentpackage.md

#### MsgAttachmentPackage constructor

MsgAttachmentPackage constructor

```csharp
public MsgAttachmentPackage(string name, byte[] content)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Attachment name |
| content | Byte[] | Attachment file which byte[] |

### MsgPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage.md

#### MsgPackage class

Represents MSG message metadata.

```csharp
public class MsgPackage : EmailPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Attachments { get; set; } | Gets an array of the attached files. |
| Billing { get; set; } | Contains the billing information associated with an item. |
| BlindCarbonCopyRecipients { get; set; } | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| Body { get; set; } | Gets the email message text. |
| BodyHtml { get; set; } | Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. |
| BodyRtf { get; set; } | Gets the BodyRtf of the message. |
| CarbonCopyRecipients { get; set; } | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| Categories { get; set; } | Gets the array of categories or keywords. |
| ClientSubmitTime { get; set; } | Gets the date and time the message was submit. |
| ConversationTopic { get; } | Gets the Conversation Topic. |
| Count { get; } | Gets the number of metadata properties. |
| DeliveryTime { get; set; } | Gets the date and time the message was delivered. |
| DisplayBcc { get; } | Gets the Display Bcc. |
| DisplayCc { get; } | Gets the Display Cc. |
| DisplayName { get; } | Gets the Display Name. |
| DisplayNamePrefix { get; } | Gets the Display Name Prefix. |
| DisplayTo { get; } | Gets the Display To. |
| Headers { get; set; } | Gets a metadata package containing the email headers. |
| InternetMessageId { get; } | Gets the message id of the message. |
| IsEncrypted { get; } | Gets the Is Encrypted. |
| IsSigned { get; } | Gets the Is Signed. |
| IsTemplate { get; } | Gets the Is Template. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Mileage { get; set; } | Gets the Mileage. |
| NormalizedSubject { get; } | Gets the Normalized Subject. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ReadReceiptRequested { get; set; } | Gets the Read Receipt Requested. |
| Recipients { get; set; } | Gets or sets the array of the email recipients. |
| ReplyTo { get; set; } | Gets the Reply To. |
| SenderAddressType { get; } | Gets the Sender Address Type. |
| SenderEmailAddress { get; set; } | Gets the email address of the sender. |
| SenderName { get; set; } | Gets the name of the sender. |
| SenderSmtpAddress { get; set; } | Gets the Sender Smtp Address. |
| SentRepresentingAddressType { get; } | Gets the Sent Representing Address Type. |
| SentRepresentingEmailAddress { get; set; } | Gets the Sent Representing Email Address. |
| SentRepresentingName { get; set; } | Gets the Sent Representing Name. |
| SentRepresentingSmtpAddress { get; } | Gets the Sent Representing Smtp Address. |
| Subject { get; set; } | Gets or sets the email subject. |
| SubjectPrefix { get; } | Gets the Subject Prefix. |
| TransportMessageHeaders { get; } | Gets the Transport Message Headers. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Attachments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/attachments.md

#### MsgPackage.Attachments property

Gets an array of the attached files.

```csharp
public MsgAttachmentPackage[] Attachments { get; set; }
```

##### Property Value

An array of the attached files.

### Billing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/billing.md

#### MsgPackage.Billing property

Contains the billing information associated with an item.

```csharp
public string Billing { get; set; }
```

##### Property Value

The billing information.

### Body
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/body.md

#### MsgPackage.Body property

Gets the email message text.

```csharp
public string Body { get; set; }
```

##### Property Value

The email message text.

### BodyHtml
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/bodyhtml.md

#### MsgPackage.BodyHtml property

Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.

```csharp
public string BodyHtml { get; set; }
```

##### Property Value

The BodyRtf of the message converted to HTML.

### BodyRtf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/bodyrtf.md

#### MsgPackage.BodyRtf property

Gets the BodyRtf of the message.

```csharp
public string BodyRtf { get; set; }
```

##### Property Value

The BodyRtf of the message.

### Categories
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/categories.md

#### MsgPackage.Categories property

Gets the array of categories or keywords.

```csharp
public string[] Categories { get; set; }
```

##### Property Value

The array of categories or keywords.

### ClientSubmitTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/clientsubmittime.md

#### MsgPackage.ClientSubmitTime property

Gets the date and time the message was submit.

```csharp
public DateTime ClientSubmitTime { get; set; }
```

##### Property Value

The submit time.

### ConversationTopic
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/conversationtopic.md

#### MsgPackage.ConversationTopic property

Gets the Conversation Topic.

```csharp
public string ConversationTopic { get; }
```

##### Property Value

The Conversation Topic.

### DeliveryTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/deliverytime.md

#### MsgPackage.DeliveryTime property

Gets the date and time the message was delivered.

```csharp
public DateTime DeliveryTime { get; set; }
```

##### Property Value

The delivery time.

### DisplayBcc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/displaybcc.md

#### MsgPackage.DisplayBcc property

Gets the Display Bcc.

```csharp
public string DisplayBcc { get; }
```

##### Property Value

The Display Bcc.

### DisplayCc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/displaycc.md

#### MsgPackage.DisplayCc property

Gets the Display Cc.

```csharp
public string DisplayCc { get; }
```

##### Property Value

The Display Cc.

### DisplayName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/displayname.md

#### MsgPackage.DisplayName property

Gets the Display Name.

```csharp
public string DisplayName { get; }
```

##### Property Value

The Display Name.

### DisplayNamePrefix
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/displaynameprefix.md

#### MsgPackage.DisplayNamePrefix property

Gets the Display Name Prefix.

```csharp
public string DisplayNamePrefix { get; }
```

##### Property Value

The Display Name Prefix.

### DisplayTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/displayto.md

#### MsgPackage.DisplayTo property

Gets the Display To.

```csharp
public string DisplayTo { get; }
```

##### Property Value

The Display To.

### InternetMessageId
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/internetmessageid.md

#### MsgPackage.InternetMessageId property

Gets the message id of the message.

```csharp
public string InternetMessageId { get; }
```

##### Property Value

The message id.

### IsEncrypted
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/isencrypted.md

#### MsgPackage.IsEncrypted property

Gets the Is Encrypted.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

The Is Encrypted.

### IsSigned
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/issigned.md

#### MsgPackage.IsSigned property

Gets the Is Signed.

```csharp
public bool IsSigned { get; }
```

##### Property Value

The Is Signed.

### IsTemplate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/istemplate.md

#### MsgPackage.IsTemplate property

Gets the Is Template.

```csharp
public bool IsTemplate { get; }
```

##### Property Value

The Is Template.

### Mileage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/mileage.md

#### MsgPackage.Mileage property

Gets the Mileage.

```csharp
public string Mileage { get; set; }
```

##### Property Value

The Mileage.

### NormalizedSubject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/normalizedsubject.md

#### MsgPackage.NormalizedSubject property

Gets the Normalized Subject.

```csharp
public string NormalizedSubject { get; }
```

##### Property Value

The Normalized Subject.

### ReadReceiptRequested
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/readreceiptrequested.md

#### MsgPackage.ReadReceiptRequested property

Gets the Read Receipt Requested.

```csharp
public bool ReadReceiptRequested { get; set; }
```

##### Property Value

The Read Receipt Requested.

### ReplyTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/replyto.md

#### MsgPackage.ReplyTo property

Gets the Reply To.

```csharp
public string ReplyTo { get; set; }
```

##### Property Value

The Reply To.

### SenderAddressType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/senderaddresstype.md

#### MsgPackage.SenderAddressType property

Gets the Sender Address Type.

```csharp
public string SenderAddressType { get; }
```

##### Property Value

The Sender Address Type.

### SenderName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sendername.md

#### MsgPackage.SenderName property

Gets the name of the sender.

```csharp
public string SenderName { get; set; }
```

##### Property Value

The name of the sender.

### SenderSmtpAddress
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sendersmtpaddress.md

#### MsgPackage.SenderSmtpAddress property

Gets the Sender Smtp Address.

```csharp
public string SenderSmtpAddress { get; set; }
```

##### Property Value

The Sender Smtp Address.

### SentRepresentingAddressType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sentrepresentingaddresstype.md

#### MsgPackage.SentRepresentingAddressType property

Gets the Sent Representing Address Type.

```csharp
public string SentRepresentingAddressType { get; }
```

##### Property Value

The Sent Representing Address Type.

### SentRepresentingEmailAddress
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sentrepresentingemailaddress.md

#### MsgPackage.SentRepresentingEmailAddress property

Gets the Sent Representing Email Address.

```csharp
public string SentRepresentingEmailAddress { get; set; }
```

##### Property Value

The Sent Representing Email Address.

### SentRepresentingName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sentrepresentingname.md

#### MsgPackage.SentRepresentingName property

Gets the Sent Representing Name.

```csharp
public string SentRepresentingName { get; set; }
```

##### Property Value

The Sent Representing Name.

### SentRepresentingSmtpAddress
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/sentrepresentingsmtpaddress.md

#### MsgPackage.SentRepresentingSmtpAddress property

Gets the Sent Representing Smtp Address.

```csharp
public string SentRepresentingSmtpAddress { get; }
```

##### Property Value

The Sent Representing Smtp Address.

### SubjectPrefix
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/subjectprefix.md

#### MsgPackage.SubjectPrefix property

Gets the Subject Prefix.

```csharp
public string SubjectPrefix { get; }
```

##### Property Value

The Subject Prefix.

### TransportMessageHeaders
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgpackage/transportmessageheaders.md

#### MsgPackage.TransportMessageHeaders property

Gets the Transport Message Headers.

```csharp
public string TransportMessageHeaders { get; }
```

##### Property Value

The Transport Message Headers.

### MsgRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgrootpackage.md

#### MsgRootPackage class

Represents the root package allowing working with metadata in an MSG email message.

```csharp
public class MsgRootPackage : EmailRootPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| EmailPackage { get; } | Gets the MSG metadata package. (2 properties) |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAttachments() | Removes all the attachments form the email message. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetString(MsgKnownProperties) | Gets the string value of the property specified by tag. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract metadata from an MSG message.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMsg))
{
    var root = metadata.GetRootPackage<MsgRootPackage>();

    Console.WriteLine(root.EmailPackage.Sender);
    Console.WriteLine(root.EmailPackage.Subject);
    foreach (string recipient in root.EmailPackage.Recipients)
    {
        Console.WriteLine(recipient);
    }

    foreach (var attachedFileName in root.EmailPackage.AttachedFileNames)
    {
        Console.WriteLine(attachedFileName);
    }

    foreach (var header in root.EmailPackage.Headers)
    {
        Console.WriteLine("{0} = {1}", header.Name, header.Value);
    }

    Console.WriteLine(root.EmailPackage.Body);
    Console.WriteLine(root.EmailPackage.DeliveryTime);

    // ...
}
```

### EmailPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgrootpackage/emailpackage.md

#### MsgRootPackage.EmailPackage property

Gets the MSG metadata package.

```csharp
public MsgPackage EmailPackage { get; }
```

##### Property Value

The MSG metadata package.

### GetString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.email/msgrootpackage/getstring.md

#### MsgRootPackage.GetString method

Gets the string value of the property specified by tag.

```csharp
public string GetString(MsgKnownProperties tag)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tag | MsgKnownProperties | The value from MsgKnownProperties enum . |

##### Return Value

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

### GroupDocs.Metadata.Formats.Fb2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2.md

#### Classes

| Class | Description |
| --- | --- |
| Fb2Package | Represents metadata in a Fb2 e-book. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### Fb2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package.md

#### Fb2Package class

Represents metadata in a Fb2 e-book.

```csharp
public sealed class Fb2Package : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| CustomInfo { get; } | Some information about the document that is not provided in the rest of the description. This may be either just some information from the author or some information that may be useful to some FB2 software. |
| DocumentInfo { get; } | Description of information about a specific FB2.x document (creator(s), history, etc.). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PublishInfo { get; } | Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether. |
| SrcTitleInfo { get; } | Description of information about the work in the original language (not available for the original book). |
| TitleInfo { get; } | Description of information about the work (including translation, but excluding publication). |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CustomInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package/custominfo.md

#### Fb2Package.CustomInfo property

Some information about the document that is not provided in the rest of the description. This may be either just some information from the author or some information that may be useful to some FB2 software.

```csharp
public string[] CustomInfo { get; }
```

##### Property Value

The Custom Info.

### DocumentInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package/documentinfo.md

#### Fb2Package.DocumentInfo property

Description of information about a specific FB2.x document (creator(s), history, etc.).

```csharp
public Fb2DocumentInfo DocumentInfo { get; }
```

##### Property Value

The Fb2 Document Info.

### PublishInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package/publishinfo.md

#### Fb2Package.PublishInfo property

Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether.

```csharp
public Fb2PublishInfo PublishInfo { get; }
```

##### Property Value

The Fb2 Publish Info.

### SrcTitleInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package/srctitleinfo.md

#### Fb2Package.SrcTitleInfo property

Description of information about the work in the original language (not available for the original book).

```csharp
public Fb2TitleInfo SrcTitleInfo { get; }
```

##### Property Value

The Fb2 Src Title Info.

### TitleInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.fb2/fb2package/titleinfo.md

#### Fb2Package.TitleInfo property

Description of information about the work (including translation, but excluding publication).

```csharp
public Fb2TitleInfo TitleInfo { get; }
```

##### Property Value

The Fb2 Title Info.

### GroupDocs.Metadata.Formats.Font
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font.md

The namespace contains classes allowing users to work with formats representing scalable computer fonts.

#### Classes

| Class | Description |
| --- | --- |
| OpenTypeBaseNameRecord | Represents the base OpenType Name table record class. |
| OpenTypeFont | Represents a single font extracted from a file. |
| OpenTypeMacintoshNameRecord | Represents the Name record table value for the Macintosh platform. |
| OpenTypePackage | Represents an OpenType font metadata package. |
| OpenTypeRootPackage | Represents the root package allowing working with metadata in an OpenType font file. |
| OpenTypeUnicodeNameRecord | Represents the Name record table value for the Unicode platform. |
| OpenTypeWindowsNameRecord | Represents the Name record table value for Windows platform. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| OpenTypeDigitalSignatureFlags | Represents OpenType font digital signature flags. |
| OpenTypeDirectionHint | Represents the OpenType font direction. |
| OpenTypeFlags | Represents OpenType font header flags. |
| OpenTypeIsoEncoding | Represents encoding for the Iso platform. |
| OpenTypeLicensingRights | Indicates font embedding licensing rights for the font. |
| OpenTypeMacintoshEncoding | Represents encoding for the Macintosh platform. |
| OpenTypeMacintoshLanguage | Represents language enum for the Macintosh platform. |
| OpenTypeName | Defines pre-defined IDs, they apply to all platforms unless indicated otherwise. |
| OpenTypePlatform | Represents OpenType platform for Name table. |
| OpenTypeStyles | Represents the OpenType font style. |
| OpenTypeUnicodeEncoding | Represents encoding for Unicode platform. |
| OpenTypeVersion | Represents the OpenType version. |
| OpenTypeWeight | Represents the OpenType font weight. Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font. Values from 1 to 1000 are valid. |
| OpenTypeWidth | Represents the OpenType font width. Indicates a relative change from the normal aspect ratio (width to height ratio) as specified by a font designer for the glyphs in a font. |
| OpenTypeWindowsEncoding | Represents encoding for the Windows platform. |
| OpenTypeWindowsLanguage | Represents language for Windows platform. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### OpenTypeBaseNameRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypebasenamerecord.md

#### OpenTypeBaseNameRecord class

Represents the base OpenType Name table record class.

```csharp
public abstract class OpenTypeBaseNameRecord : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NameID { get; } | Gets the name identifier. |
| Platform { get; } | Gets the platform identifier. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the string value of record. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### NameID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypebasenamerecord/nameid.md

#### OpenTypeBaseNameRecord.NameID property

Gets the name identifier.

```csharp
public OpenTypeName NameID { get; }
```

##### Property Value

The name identifier.

### Platform
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypebasenamerecord/platform.md

#### OpenTypeBaseNameRecord.Platform property

Gets the platform identifier.

```csharp
public OpenTypePlatform Platform { get; }
```

##### Property Value

The platform identifier.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypebasenamerecord/value.md

#### OpenTypeBaseNameRecord.Value property

Gets the string value of record.

```csharp
public string Value { get; }
```

##### Property Value

The string value of record.

### OpenTypeDigitalSignatureFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypedigitalsignatureflags.md

#### OpenTypeDigitalSignatureFlags enumeration

Represents OpenType font digital signature flags.

```csharp
[Flags]
public enum OpenTypeDigitalSignatureFlags : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Undefined flag. |
| CannotBeResigned | `1` | Cannot be resigned. |

### OpenTypeDirectionHint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypedirectionhint.md

#### OpenTypeDirectionHint enumeration

Represents the OpenType font direction.

```csharp
public enum OpenTypeDirectionHint : short
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| FullyMixed | `0` | Fully mixed directional glyphs. |
| OnlyLeftToRight | `1` | Only strongly left to right. |
| LeftToRightAndNeutrals | `2` | Like OnlyLeftToRight but also contains neutrals. |
| OnlyRightToLeft | `-1` | Only strongly right to left. |
| RightToLeftAndNeutrals | `-2` | Like OnlyRightToLeft but also contains neutrals. |

### OpenTypeFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeflags.md

#### OpenTypeFlags enumeration

Represents OpenType font header flags.

```csharp
[Flags]
public enum OpenTypeFlags : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Undefined, no flags. |
| BaselineAtY0 | `1` | Baseline for font at y=0. |
| LeftSidebearingAtX0 | `2` | Left sidebearing point at x=0 (relevant only for TrueType rasterizers). |
| DependOnPointSize | `4` | Instructions may depend on point size. |
| ForceToInteger | `8` | Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear. |
| AlterAdvanceWidth | `10` | Instructions may alter advance width (the advance widths might not scale linearly). |
| Lossless | `1000` | Font data is “lossless” as a result of having been subjected to optimizing transformation and/or compression. |
| Converted | `2000` | Font converted (produce compatible metrics). |
| Optimized | `4000` | Font optimized for ClearType™. |
| Resort | `8000` | Last Resort font. |

### OpenTypeFont
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont.md

#### OpenTypeFont class

Represents a single font extracted from a file.

```csharp
public class OpenTypeFont : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Created { get; } | Gets the created date. |
| DirectionHint { get; } | Gets the direction hint. |
| EmbeddingLicensingRights { get; } | Gets the embedding licensing rights type. |
| Flags { get; } | Gets the header flags. |
| FontFamilyName { get; } | Gets the name of the font family. |
| FontRevision { get; } | Gets the font revision. |
| FontSubfamilyName { get; } | Gets the name of the font subfamily. |
| FullFontName { get; } | Gets the full name of the font. |
| GlyphBounds { get; } | Gets the glyph bounds. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MajorVersion { get; } | Gets the header major version. |
| MetadataType { get; } | Gets the metadata type. |
| MinorVersion { get; } | Gets the header minor version. |
| Modified { get; } | Gets the modified date. |
| Names { get; } | Gets the name records. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SfntVersion { get; } | Gets the header SFNT version. |
| Style { get; } | Gets the font style. |
| TypographicFamily { get; } | Gets the typographic family. |
| TypographicSubfamily { get; } | Gets the typographic subfamily. |
| Weight { get; } | Gets the font weight. |
| Width { get; } | Gets the font width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Created
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/created.md

#### OpenTypeFont.Created property

Gets the created date.

```csharp
public DateTime Created { get; }
```

##### Property Value

The created date.

### DirectionHint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/directionhint.md

#### OpenTypeFont.DirectionHint property

Gets the direction hint.

```csharp
public OpenTypeDirectionHint DirectionHint { get; }
```

##### Property Value

The direction hint.

### EmbeddingLicensingRights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/embeddinglicensingrights.md

#### OpenTypeFont.EmbeddingLicensingRights property

Gets the embedding licensing rights type.

```csharp
public OpenTypeLicensingRights EmbeddingLicensingRights { get; }
```

##### Property Value

The embedding licensing rights type.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/flags.md

#### OpenTypeFont.Flags property

Gets the header flags.

```csharp
public OpenTypeFlags Flags { get; }
```

##### Property Value

The header flags.

### FontFamilyName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/fontfamilyname.md

#### OpenTypeFont.FontFamilyName property

Gets the name of the font family.

```csharp
public string FontFamilyName { get; }
```

##### Property Value

The name of the font family.

### FontRevision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/fontrevision.md

#### OpenTypeFont.FontRevision property

Gets the font revision.

```csharp
public float FontRevision { get; }
```

##### Property Value

The font revision.

### FontSubfamilyName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/fontsubfamilyname.md

#### OpenTypeFont.FontSubfamilyName property

Gets the name of the font subfamily.

```csharp
public string FontSubfamilyName { get; }
```

##### Property Value

The name of the font subfamily.

### FullFontName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/fullfontname.md

#### OpenTypeFont.FullFontName property

Gets the full name of the font.

```csharp
public string FullFontName { get; }
```

##### Property Value

The full name of the font.

### GlyphBounds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/glyphbounds.md

#### OpenTypeFont.GlyphBounds property

Gets the glyph bounds.

```csharp
public Rectangle GlyphBounds { get; }
```

##### Property Value

The glyph bounds.

### MajorVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/majorversion.md

#### OpenTypeFont.MajorVersion property

Gets the header major version.

```csharp
public ushort MajorVersion { get; }
```

##### Property Value

The header major version.

### MinorVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/minorversion.md

#### OpenTypeFont.MinorVersion property

Gets the header minor version.

```csharp
public ushort MinorVersion { get; }
```

##### Property Value

The header minor version.

### Modified
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/modified.md

#### OpenTypeFont.Modified property

Gets the modified date.

```csharp
public DateTime Modified { get; }
```

##### Property Value

The modified date.

### Names
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/names.md

#### OpenTypeFont.Names property

Gets the name records.

```csharp
public OpenTypeBaseNameRecord[] Names { get; }
```

##### Property Value

The name records.

### SfntVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/sfntversion.md

#### OpenTypeFont.SfntVersion property

Gets the header SFNT version.

```csharp
public OpenTypeVersion SfntVersion { get; }
```

##### Property Value

The header SFNT version.

### Style
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/style.md

#### OpenTypeFont.Style property

Gets the font style.

```csharp
public OpenTypeStyles Style { get; }
```

##### Property Value

The font style.

### TypographicFamily
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/typographicfamily.md

#### OpenTypeFont.TypographicFamily property

Gets the typographic family.

```csharp
public string TypographicFamily { get; }
```

##### Property Value

The typographic family.

### TypographicSubfamily
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/typographicsubfamily.md

#### OpenTypeFont.TypographicSubfamily property

Gets the typographic subfamily.

```csharp
public string TypographicSubfamily { get; }
```

##### Property Value

The typographic subfamily.

### Weight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/weight.md

#### OpenTypeFont.Weight property

Gets the font weight.

```csharp
public OpenTypeWeight Weight { get; }
```

##### Property Value

The font weight.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypefont/width.md

#### OpenTypeFont.Width property

Gets the font width.

```csharp
public OpenTypeWidth Width { get; }
```

##### Property Value

The font width.

### OpenTypeIsoEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeisoencoding.md

#### OpenTypeIsoEncoding enumeration

Represents encoding for the Iso platform.

```csharp
public enum OpenTypeIsoEncoding : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Ascii7Bit | `0` | The 7-bit ASCII encoding. |
| Iso10646 | `1` | The ISO 10646 encoding. |
| Iso8859 | `2` | The ISO 8859-1 encoding. |

### OpenTypeLicensingRights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypelicensingrights.md

#### OpenTypeLicensingRights enumeration

Indicates font embedding licensing rights for the font.

```csharp
[Flags]
public enum OpenTypeLicensingRights : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | The undefined licensing rights. |
| UsagePermissionsMask | `F` | Usage permissions mask. |
| InstallableEmbedding | `1` | Installable embedding. The font may be embedded, and may be permanently installed for use on a remote systems, or for use by other users. |
| RestrictedLicenseEmbedding | `2` | Restricted License embedding. The font must not be modified, embedded or exchanged in any manner without first obtaining explicit permission of the legal owner. |
| PreviewAndPrintEmbedding | `4` | Preview and Print embedding. The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or printing the document. Documents containing Preview &amp; Print fonts must be opened “read-only”; no edits can be applied to the document. |
| EditableEmbedding | `8` | Editable embedding. The font may be embedded, and may be temporarily loaded on other systems. As with Preview and Print embedding, documents containing Editable fonts may be opened for reading. In addition, editing is permitted, including ability to format new text using the embedded font, and changes may be saved. |
| NoSubsetting | `100` | No subsetting. When this bit is set, the font may not be subsetted prior to embedding. Other embedding restrictions specified in bits 0 to 3 and bit 9 also apply. |
| BitmapEmbeddingOnly | `200` | Bitmap embedding only. When this bit is set, only bitmaps contained in the font may be embedded. No outline data may be embedded. If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail. Other embedding restrictions specified in bits 0-3 and 8 also apply. |

### OpenTypeMacintoshEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypemacintoshencoding.md

#### OpenTypeMacintoshEncoding enumeration

Represents encoding for the Macintosh platform.

```csharp
public enum OpenTypeMacintoshEncoding : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| DefaultSemantics | `0` | Default semantics. |
| Version11Semantics | `1` | Version 1.1 semantics. |
| Iso106461993Semantics | `2` | ISO 10646 1993 semantics (deprecated). |
| Unicode20BmpOnly | `3` | Unicode 2.0 or later semantics (BMP only). |
| Unicode20NonBmp | `4` | Unicode 2.0 or later semantics (non-BMP characters allowed). |
| UnicodeVariationSequences | `5` | Unicode Variation Sequences. |
| FullUnicodeCoverage | `6` | Full Unicode coverage. |

### OpenTypeMacintoshLanguage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypemacintoshlanguage.md

#### OpenTypeMacintoshLanguage enumeration

Represents language enum for the Macintosh platform.

```csharp
public enum OpenTypeMacintoshLanguage : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| English | `0` | The english language. |
| French | `1` | The french language. |
| German | `2` | The german language. |
| Italian | `3` | The italian language. |
| Dutch | `4` | The dutch language. |
| Swedish | `5` | The swedish language. |
| Spanish | `6` | The spanish language. |
| Danish | `7` | The danish language. |
| Portuguese | `8` | The portuguese language. |
| Norwegian | `9` | The norwegian language. |
| Hebrew | `10` | The hebrew language. |
| Japanese | `11` | The japanese language. |
| Arabic | `12` | The arabic language. |
| Finnish | `13` | The finnish language. |
| Greek | `14` | The greek language. |
| Icelandic | `15` | The icelandic language. |
| Maltese | `16` | The maltese language. |
| Turkish | `17` | The turkish language. |
| Croatian | `18` | The croatian language. |
| ChineseTraditional | `19` | The chinese traditional language. |
| Urdu | `20` | The urdu language. |
| Hindi | `21` | The hindi language. |
| Thai | `22` | The thai language. |
| Korean | `23` | The korean language. |
| Lithuanian | `24` | The lithuanian language. |
| Polish | `25` | The polish language. |
| Hungarian | `26` | The hungarian language. |
| Estonian | `27` | The estonian language. |
| Latvian | `28` | The latvian language. |
| Sami | `29` | The sami language. |
| Faroese | `30` | The faroese language. |
| FarsiPersian | `31` | The farsi persian language. |
| Russian | `32` | The russian language. |
| ChineseSimplified | `33` | The chinese simplifie language. |
| Flemish | `34` | The flemish language. |
| IrishGaelic | `35` | The irish gaelic language. |
| Albanian | `36` | The albanian language. |
| Romanian | `37` | The romanian language. |
| Czech | `38` | The czech language. |
| Slovak | `39` | The slovak language. |
| Slovenian | `40` | The slovenian language. |
| Yiddish | `41` | The yiddish language. |
| Serbian | `42` | The serbian language. |
| Macedonian | `43` | The macedonian language. |
| Bulgarian | `44` | The bulgarian language. |
| Ukrainian | `45` | The ukrainian language. |
| Byelorussian | `46` | The byelorussian language. |
| Uzbek | `47` | The uzbek language. |
| Kazakh | `48` | The kazakh language. |
| AzerbaijaniCyrillic | `49` | The azerbaijani cyrillic language. |
| AzerbaijaniArabic | `50` | The azerbaijani arabic language. |
| Armenian | `51` | The armenian language. |
| Georgian | `52` | The georgian language. |
| Moldavian | `53` | The moldavian language. |
| Kirghiz | `54` | The kirghiz language. |
| Tajiki | `55` | The tajiki language. |
| Turkmen | `56` | The turkmen language. |
| MongolianMongolian | `57` | The mongolian mongolian language. |
| MongolianCyrillic | `58` | The mongolian cyrillic language. |
| Pashto | `59` | The pashto language. |
| Kurdish | `60` | The kurdish language. |
| Kashmiri | `61` | The kashmiri language. |
| Sindhi | `62` | The sindhi language. |
| Tibetan | `63` | The tibetan language. |
| Nepali | `64` | The nepali language. |
| Sanskrit | `65` | The sanskrit language. |
| Marathi | `66` | The marathi language. |
| Bengali | `67` | The bengali language. |
| Assamese | `68` | The assamese language. |
| Gujarati | `69` | The gujarati language. |
| Punjabi | `70` | The punjabi language. |
| Oriya | `71` | The oriya language. |
| Malayalam | `72` | The malayalam language. |
| Kannada | `73` | The kannada language. |
| Tamil | `74` | The tamil language. |
| Telugu | `75` | The telugu language. |
| Sinhalese | `76` | The sinhalese language. |
| Burmese | `77` | The burmese language. |
| Khmer | `78` | The khmer language. |
| Lao | `79` | The lao language. |
| Vietnamese | `80` | The vietnamese language. |
| Indonesian | `81` | The indonesian language. |
| Tagalog | `82` | The tagalog language. |
| MalayRoman | `83` | The malay roman language. |
| MalayArabic | `84` | The malay arabic language. |
| Amharic | `85` | The amharic language. |
| Tigrinya | `86` | The tigrinya language. |
| Galla | `87` | The galla language. |
| Somali | `88` | The somali language. |
| Swahili | `89` | The swahili language. |
| KinyarwandaOrRuanda | `90` | The kinyarwanda or ruanda language. |
| Rundi | `91` | The rundi language. |
| NyanjaOrChewa | `92` | The nyanja or chewa language. |
| Malagasy | `93` | The malagasy language. |
| Esperanto | `94` | The esperanto language. |
| Welsh | `128` | The welsh language. |
| Basque | `129` | The basque language. |
| Catalan | `130` | The catalan language. |
| Latin | `131` | The latin language. |
| Quechua | `132` | The quechua language. |
| Guarani | `133` | The guarani language. |
| Aymara | `134` | The aymara language. |
| Tatar | `135` | The tatar language. |
| Uighur | `136` | The uighur language. |
| Dzongkha | `137` | The dzongkha language. |
| JavaneseRoman | `138` | The javanese roman language. |
| SundaneseRoman | `139` | The sundanese roman language. |
| Galician | `140` | The galician language. |
| Afrikaans | `141` | The afrikaans language. |
| Breton | `142` | The breton language. |
| Inuktitut | `143` | The inuktitut language. |
| ScottishGaelic | `144` | The scottish gaelic language. |
| ManxGaelic | `145` | The manx gaelic language. |
| IrishGaelicWithDotAbove | `146` | The irish gaelic with dot above language. |
| Tongan | `147` | The tongan language. |
| GreekPolytonic | `148` | The greek polytonic language. |
| Greenlandic | `149` | The greenlandic language. |
| AzerbaijaniRoman | `150` | The azerbaijani roman language. |

### OpenTypeMacintoshNameRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord.md

#### OpenTypeMacintoshNameRecord class

Represents the Name record table value for the Macintosh platform.

```csharp
public class OpenTypeMacintoshNameRecord : OpenTypeBaseNameRecord
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Encoding { get; } | Gets the encoding identifier. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language identifier. |
| MetadataType { get; } | Gets the metadata type. |
| NameID { get; } | Gets the name identifier. |
| Platform { get; } | Gets the platform identifier. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the string value of record. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Encoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/encoding.md

#### OpenTypeMacintoshNameRecord.Encoding property

Gets the encoding identifier.

```csharp
public OpenTypeMacintoshEncoding Encoding { get; }
```

##### Property Value

The encoding identifier.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/language.md

#### OpenTypeMacintoshNameRecord.Language property

Gets the language identifier.

```csharp
public OpenTypeMacintoshLanguage Language { get; }
```

##### Property Value

The language identifier.

### OpenTypeName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypename.md

#### OpenTypeName enumeration

Defines pre-defined IDs, they apply to all platforms unless indicated otherwise.

```csharp
public enum OpenTypeName : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| CopyrightNotice | `0` | Copyright notice. |
| FontFamilyName | `1` | Font Family name. |
| FontSubfamilyName | `2` | Font Subfamily name. |
| UniqueFontIdentifier | `3` | Unique font identifier. |
| FullFontName | `4` | Full font name that reflects all family and relevant subfamily descriptors. |
| VersionString | `5` | Version string. |
| PostScriptName | `6` | PostScript name for the font. |
| Trademark | `7` | Trademark notice/information for this font. |
| ManufacturerName | `8` | Manufacturer Name. |
| Designer | `9` | Designer; name of the designer of the typeface. |
| Description | `10` | Description of the typeface. |
| UrlVendor | `11` | URL of font vendor (with protocol, e.g., http://, ftp://). |
| UrlDesigner | `12` | URL of typeface designer (with protocol, e.g., http://, ftp://). |
| LicenseDescription | `13` | Description of how the font may be legally used, or different example scenarios for licensed use. |
| LicenseInfoUrl | `14` | URL where additional licensing information can be found. |
| TypographicFamily | `16` | Typographic Family name. |
| TypographicSubfamily | `17` | Typographic Subfamily name. |
| CompatibleFull | `18` | Compatible Full (Macintosh only). On the Macintosh, the menu name is constructed using the FOND resource. |
| SampleText | `19` | Sample text. This can be the font name, or any other text that the designer thinks is the best sample to display the font in. |
| PostScriptCidFindfont | `20` | PostScript CID findfont name. |
| WwsFamilyName | `21` | WWS Family Name. |
| WwsSubfamilyName | `22` | WWS Subfamily Name. |
| LightBackgroundPalette | `23` | Light Background Palette. |
| DarkBackgroundPalette | `24` | Dark Background Palette. |
| VariationsPostScriptNamePrefix | `25` | Variations PostScript Name Prefix. |

### OpenTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypepackage.md

#### OpenTypePackage class

Represents an OpenType font metadata package.

```csharp
public sealed class OpenTypePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Fonts { get; } | Gets an array of the fonts extracted from the file. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Fonts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypepackage/fonts.md

#### OpenTypePackage.Fonts property

Gets an array of the fonts extracted from the file.

```csharp
public OpenTypeFont[] Fonts { get; }
```

##### Property Value

An array of the fonts extracted from the file.

### OpenTypePlatform
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeplatform.md

#### OpenTypePlatform enumeration

Represents OpenType platform for Name table.

```csharp
public enum OpenTypePlatform : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unicode | `0` | The Unicode platform. |
| Macintosh | `1` | The Macintosh platform. |
| Iso | `2` | The ISO [deprecated] platform. |
| Windows | `3` | The Windows platform. |
| Custom | `4` | The Custom platform. |

### OpenTypeRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentyperootpackage.md

#### OpenTypeRootPackage class

Represents the root package allowing working with metadata in an OpenType font file.

```csharp
public class OpenTypeRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DigitalSignaturePackage { get; } | Gets the digital signature metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| OpenTypePackage { get; } | Gets the OpenType metadata package. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DigitalSignaturePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentyperootpackage/digitalsignaturepackage.md

#### OpenTypeRootPackage.DigitalSignaturePackage property

Gets the digital signature metadata package.

```csharp
public CmsPackage DigitalSignaturePackage { get; }
```

##### Property Value

The digital signature metadata package.

##### Examples

This code snippet demonstrates how to extract digital signatures associated with an OpenType font.

```csharp
public static void Run()
{
    using (Metadata metadata = new Metadata(Constants.InputTtf))
    {
        var root = metadata.GetRootPackage<OpenTypeRootPackage>();

        if (root.DigitalSignaturePackage != null)
        {
            Console.WriteLine(root.DigitalSignaturePackage.Flags);
            foreach (var signature in root.DigitalSignaturePackage.Signatures)
            {
                Console.WriteLine(signature.SignTime);
                if (signature.DigestAlgorithms != null)
                {
                    foreach (var signatureDigestAlgorithm in signature.DigestAlgorithms)
                    {
                        PrintOid(signatureDigestAlgorithm);
                    }
                }
                if (signature.EncapsulatedContent != null)
                {
                    PrintOid(signature.EncapsulatedContent.ContentType);
                    Console.WriteLine(signature.EncapsulatedContent.ContentRawData.Length);
                }
                if (signature.Certificates != null)
                {
                    foreach (var certificate in signature.Certificates)
                    {
                        Console.WriteLine(certificate.NotAfter);
                        Console.WriteLine(certificate.NotBefore);
                        Console.WriteLine(certificate.RawData.Length);
                    }
                }
                if (signature.Signers != null)
                {
                    foreach (var signerInfoEntry in signature.Signers)
                    {
                        Console.WriteLine(signerInfoEntry.SignatureValue);
                        PrintOid(signerInfoEntry.DigestAlgorithm);
                        PrintOid(signerInfoEntry.SignatureAlgorithm);
                        Console.WriteLine(signerInfoEntry.SigningTime);
                        PrintAttributes(signerInfoEntry.SignedAttributes);
                        PrintAttributes(signerInfoEntry.UnsignedAttributes);
                    }
                }
            }
        }
    }
}

private static void PrintOid(Oid oid)
{
    // Display the property name and value of OID
    if (oid != null)
    {
        Console.WriteLine(oid.FriendlyName);
        Console.WriteLine(oid.Value);
    }
}

private static void PrintAttributes(CmsAttribute[] attributes)
{
    //Display the CmsAttributes of an OID
    if (attributes != null)
    {
        foreach (CmsAttribute attribute in attributes)
        {
            PrintOid(attribute.Oid);
            Console.WriteLine(attribute.Value);
        }
    }
}
```

### OpenTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentyperootpackage/opentypepackage.md

#### OpenTypeRootPackage.OpenTypePackage property

Gets the OpenType metadata package.

```csharp
public OpenTypePackage OpenTypePackage { get; }
```

##### Property Value

The OpenType metadata package.

##### Examples

This example shows how to read OpenType font metadata.

```csharp
using (Metadata metadata = new Metadata(Constants.InputTtf))
{
    var root = metadata.GetRootPackage<OpenTypeRootPackage>();

    // Read the OpenType font metadata
    foreach (var metadataEntry in root.OpenTypePackage.Fonts)
    {
        // Display the values of some metadata properties
        Console.WriteLine(metadataEntry.Created);
        Console.WriteLine(metadataEntry.DirectionHint);
        Console.WriteLine(metadataEntry.EmbeddingLicensingRights);
        Console.WriteLine(metadataEntry.Flags);
        Console.WriteLine(metadataEntry.FontFamilyName);
        Console.WriteLine(metadataEntry.FontRevision);
        Console.WriteLine(metadataEntry.FontSubfamilyName);
        Console.WriteLine(metadataEntry.FullFontName);
        Console.WriteLine(metadataEntry.GlyphBounds);
        Console.WriteLine(metadataEntry.MajorVersion);
        Console.WriteLine(metadataEntry.MinorVersion);
        Console.WriteLine(metadataEntry.Modified);
        Console.WriteLine(metadataEntry.SfntVersion);
        Console.WriteLine(metadataEntry.Style);
        Console.WriteLine(metadataEntry.TypographicFamily);
        Console.WriteLine(metadataEntry.TypographicSubfamily);
        Console.WriteLine(metadataEntry.Weight);
        Console.WriteLine(metadataEntry.Width);
        foreach (OpenTypeBaseNameRecord nameRecord in metadataEntry.Names)
        {
            Console.WriteLine(nameRecord.NameID);
            Console.WriteLine(nameRecord.Platform);
            Console.WriteLine(nameRecord.Value);
            OpenTypeMacintoshNameRecord macintoshNameRecord = nameRecord as OpenTypeMacintoshNameRecord;
            if (macintoshNameRecord != null)
            {
                Console.WriteLine(macintoshNameRecord.Encoding);
                Console.WriteLine(macintoshNameRecord.Language);
            }
            else
            {
                OpenTypeUnicodeNameRecord unicodeNameRecord = nameRecord as OpenTypeUnicodeNameRecord;
                if (unicodeNameRecord != null)
                {
                    Console.WriteLine(unicodeNameRecord.Encoding);
                }
                else
                {
                    OpenTypeWindowsNameRecord windowsNameRecord = nameRecord as OpenTypeWindowsNameRecord;
                    if (windowsNameRecord != null)
                    {
                        Console.WriteLine(windowsNameRecord.Encoding);
                        Console.WriteLine(windowsNameRecord.Language);
                    }
                }
            }
        }
    }
}
```

### OpenTypeStyles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypestyles.md

#### OpenTypeStyles enumeration

Represents the OpenType font style.

```csharp
[Flags]
public enum OpenTypeStyles : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Regular | `0` | Normal text. |
| Bold | `1` | Bold text. |
| Italic | `2` | Italic text. |
| Underline | `4` | Underlined text. |
| Outline | `8` | Outline text. |
| Shadow | `A` | Shadow text. |
| Condensed | `14` | Condensed text. |
| Extended | `28` | Extended text. |

### OpenTypeUnicodeEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeunicodeencoding.md

#### OpenTypeUnicodeEncoding enumeration

Represents encoding for Unicode platform.

```csharp
public enum OpenTypeUnicodeEncoding : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unicode10 | `0` | Unicode 1.0 semantics. |
| Unicode11 | `1` | Unicode 1.1 semantics. |
| Iso | `2` | ISO/IEC 10646 semantics. |
| Unicode20Bmp | `3` | Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6). |
| Unicode20Full | `4` | Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12). |
| UnicodeVariation | `5` | Unicode Variation Sequences ('cmap' subtable format 14). |
| UnicodeFull | `6` | Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13). |

### OpenTypeUnicodeNameRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeunicodenamerecord.md

#### OpenTypeUnicodeNameRecord class

Represents the Name record table value for the Unicode platform.

```csharp
public class OpenTypeUnicodeNameRecord : OpenTypeBaseNameRecord
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Encoding { get; } | Gets the encoding identifier. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NameID { get; } | Gets the name identifier. |
| Platform { get; } | Gets the platform identifier. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the string value of record. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Encoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/encoding.md

#### OpenTypeUnicodeNameRecord.Encoding property

Gets the encoding identifier.

```csharp
public OpenTypeUnicodeEncoding Encoding { get; }
```

##### Property Value

The encoding identifier.

### OpenTypeVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeversion.md

#### OpenTypeVersion enumeration

Represents the OpenType version.

```csharp
public enum OpenTypeVersion : uint
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| TrueType | `65536` | The TrueType font. |
| Cff | `1330926671` | The OpenType font with PostScript outlines. |
| TrueTypeOsX | `1953658213` | The OS X and iOS TrueType font. |

### OpenTypeWeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypeweight.md

#### OpenTypeWeight enumeration

Represents the OpenType font weight. Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font. Values from 1 to 1000 are valid.

```csharp
public enum OpenTypeWeight : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The undefined weight. |
| Thin | `100` | The Thin weight. |
| ExtraLight | `200` | The Extra-light (Ultra-light) weight. |
| Light | `300` | The Light weight. |
| Normal | `400` | The Normal (Regular) weight. |
| Medium | `500` | The Medium weight. |
| SemiBold | `600` | The Semi-bold (Demi-bold) weight. |
| Bold | `700` | The Bold weight. |
| ExtraBold | `800` | The Extra-bold (Ultra-bold) weight. |
| Heavy | `900` | The Black (Heavy) weight. |

### OpenTypeWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewidth.md

#### OpenTypeWidth enumeration

Represents the OpenType font width. Indicates a relative change from the normal aspect ratio (width to height ratio) as specified by a font designer for the glyphs in a font.

```csharp
public enum OpenTypeWidth : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The undefined wifth. |
| UltraCondensed | `1` | The Ultra-condensed wifth. |
| ExtraCondensed | `2` | The Extra-condensed wifth. |
| Condensed | `3` | The Condensed wifth. |
| SemiCondensed | `4` | The Semi-condensed wifth. |
| Medium | `5` | The Medium (normal) wifth. |
| SemiExpanded | `6` | The Semi-expanded wifth. |
| Expanded | `7` | The Expanded wifth. |
| ExtraExpanded | `8` | The Extra-expanded wifth. |
| UltraExpanded | `9` | The Ultra-expanded wifth. |

### OpenTypeWindowsEncoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewindowsencoding.md

#### OpenTypeWindowsEncoding enumeration

Represents encoding for the Windows platform.

```csharp
public enum OpenTypeWindowsEncoding : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Symbol | `0` | The Symbol encoding. |
| UnicodeBmp | `1` | The Unicode BMP encoding. |
| ShiftJis | `2` | The ShiftJIS encoding. |
| Prc | `3` | The PRC encoding. |
| Big5 | `4` | The Big5 encoding. |
| Wansung | `5` | The Wansung encoding. |
| Johab | `6` | The Johab encoding. |
| UnicodeFull | `10` | The Unicode full repertoire encoding. |

### OpenTypeWindowsLanguage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewindowslanguage.md

#### OpenTypeWindowsLanguage enumeration

Represents language for Windows platform.

```csharp
public enum OpenTypeWindowsLanguage : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The unknown language. |
| AfrikaansSouthAfrica | `1078` | The afrikaans south africa language. |
| AlbanianAlbania | `1052` | The albanian Albania language. |
| AlsatianFrance | `1156` | The alsatian France language. |
| AmharicEthiopia | `1118` | The amharic Rthiopia language. |
| ArabicAlgeria | `5121` | The arabic Algeria language. |
| ArabicBahrain | `15361` | The arabic Bahrain language. |
| ArabicEgypt | `3073` | The arabic Egypt language. |
| ArabicIraq | `2049` | The arabic Iraq language. |
| ArabicJordan | `11265` | The arabic Jordan language. |
| ArabicKuwait | `13313` | The arabic Kuwait language. |
| ArabicLebanon | `12289` | The arabic Lebanon language. |
| ArabicLibya | `4097` | The arabic Libya language. |
| ArabicMorocco | `6145` | The arabic Morocco language. |
| ArabicOman | `8193` | The arabic Oman language. |
| ArabicQatar | `16385` | The arabic Qatar language. |
| ArabicSaudiArabia | `1025` | The arabic Saudi Arabia language. |
| ArabicSyria | `10241` | The arabic Syria language. |
| ArabicTunisia | `7169` | The arabic Tunisia language. |
| ArabicUae | `14337` | The arabic UAE language. |
| ArabicYemen | `9217` | The arabic Yemen language. |
| ArmenianArmenia | `1067` | The armenian Armenia language. |
| AssameseIndia | `1101` | The assamese India language. |
| AzeriCyrillicAzerbaijan | `2092` | The azeri cyrillic Azerbaijan language. |
| AzeriLatinAzerbaijan | `1068` | The azeri latin Azerbaijan language. |
| BashkirRussia | `1133` | The bashkir Russia language. |
| BasqueBasque | `1069` | The basque Basque language. |
| BelarusianBelarus | `1059` | The belarusian Belarus language. |
| BengaliBangladesh | `2117` | The bengali Bangladesh language. |
| BengaliIndia | `1093` | The bengali India language. |
| BosnianLatinBosniaAndHerzegovina | `5146` | The bosnian latin Bosnia and Herzegovina language. |
| BretonFrance | `1150` | The breton France language. |
| BulgarianBulgaria | `1026` | The bulgarian Bulgaria language. |
| CatalanCatalan | `1027` | The catalan Catalan language. |
| ChineseHongKongSar | `3076` | The chinese Hong Kong SAR language. |
| ChineseMacaoSar | `5124` | The chinese Macao SAR language. |
| ChinesePeoplesRepublicOfChina | `2052` | The chinese Peoples Republic of China language. |
| ChineseSingapore | `4100` | The chinese Singapore language. |
| ChineseTaiwan | `1028` | The chinese Taiwan language. |
| CorsicanFrance | `1155` | The corsican France language. |
| CroatianCroatia | `1050` | The croatian Croatia language. |
| CroatianLatinBosniaAndHerzegovina | `4122` | The croatian latin Bosnia and Herzegovina language. |
| CzechCzechRepublic | `1029` | The czech Czech Republic language. |
| DanishDenmark | `1030` | The danish Denmark language. |
| DariAfghanistan | `1164` | The dari Afghanistan language. |
| DivehiMaldives | `1125` | The divehi Maldives language. |
| DutchBelgium | `2067` | The dutch Belgium language. |
| DutchNetherlands | `1043` | The dutch Netherlands language. |
| EnglishAustralia | `3081` | The english Australia language. |
| EnglishBelize | `10249` | The english Belize language. |
| EnglishCanada | `4105` | The english Canada language. |
| EnglishCaribbean | `9225` | The english Caribbean language. |
| EnglishIndia | `16393` | The english India language. |
| EnglishIreland | `6153` | The english Ireland language. |
| EnglishJamaica | `8201` | The english Jamaica language. |
| EnglishMalaysia | `17417` | The english Malaysia language. |
| EnglishNewZealand | `5129` | The english New Zealand language. |
| EnglishRepublicOfThePhilippines | `13321` | The english Republic of the Philippines language. |
| EnglishSingapore | `18441` | The english Singapore language. |
| EnglishSouthAfrica | `7177` | The english south africa language. |
| EnglishTrinidadAndTobago | `11273` | The english Trinidad and Tobago language. |
| EnglishUnitedKingdom | `2057` | The english United Kingdom language. |
| EnglishUnitedStates | `1033` | The english United States language. |
| EnglishZimbabwe | `12297` | The english Zimbabwe language. |
| EstonianEstonia | `1061` | The estonian Estonia language. |
| FaroeseFaroeIslands | `1080` | The faroese Faroe Islands language. |
| FilipinoPhilippines | `1124` | The filipino Philippines language. |
| FinnishFinland | `1035` | The finnish Finland language. |
| FrenchBelgium | `2060` | The french Belgium language. |
| FrenchCanada | `3084` | The french Canada language. |
| FrenchFrance | `1036` | The french France language. |
| FrenchLuxembourg | `5132` | The french Luxembourg language. |
| FrenchPrincipalityOfMonaco | `6156` | The french Principality of Monaco language. |
| FrenchSwitzerland | `4108` | The french Switzerland language. |
| FrisianNetherlands | `1122` | The frisian Netherlands language. |
| GalicianGalician | `1110` | The galician Galician language. |
| GeorgianGeorgia | `1079` | The georgian Georgia language. |
| GermanAustria | `3079` | The german Austria language. |
| GermanGermany | `1031` | The german Germany language. |
| GermanLiechtenstein | `5127` | The german Liechtenstein language. |
| GermanLuxembourg | `4103` | The german Luxembourg language. |
| GermanSwitzerland | `2055` | The german Switzerland language. |
| GreekGreece | `1032` | The greek Greece language. |
| GreenlandicGreenland | `1135` | The greenlandic Greenland language. |
| GujaratiIndia | `1095` | The gujarati India language. |
| HausaLatinNigeria | `1128` | The hausa latin Nigeria language. |
| HebrewIsrael | `1037` | The hebrew Israel language. |
| HindiIndia | `1081` | The hindi India language. |
| HungarianHungary | `1038` | The hungarian Hungary language. |
| IcelandicIceland | `1039` | The icelandic Iceland language. |
| IgboNigeria | `1136` | The igbo Nigeria language. |
| IndonesianIndonesia | `1057` | The indonesian Indonesia language. |
| InuktitutCanada | `1117` | The inuktitut Canada language. |
| InuktitutLatinCanada | `2141` | The inuktitut latin Canada language. |
| IrishIreland | `2108` | The irish Ireland language. |
| IsiXhosaSouthAfrica | `1076` | The isi xhosa South Africa language. |
| IsiZuluSouthAfrica | `1077` | The isi zulu South Africa language. |
| ItalianItaly | `1040` | The italian Italy language. |
| ItalianSwitzerland | `2064` | The italian Switzerland language. |
| JapaneseJapan | `1041` | The japanese Japan language. |
| KannadaIndia | `1099` | The kannada India language. |
| KazakhKazakhstan | `1087` | The kazakh Kazakhstan language. |
| KhmerCambodia | `1107` | The khmer Cambodia language. |
| KicheGuatemala | `1158` | The kiche Guatemala language. |
| KinyarwandaRwanda | `1159` | The kinyarwanda Rwanda language. |
| KiswahiliKenya | `1089` | The kiswahili Kenya language. |
| KonkaniIndia | `1111` | The konkani India language. |
| KoreanKorea | `1042` | The korean Korea language. |
| KyrgyzKyrgyzstan | `1088` | The kyrgyz Kyrgyzstan language. |
| LaoLaoPdr | `1108` | The lao lao PDR language. |
| LatvianLatvia | `1062` | The latvian Latvia language. |
| LithuanianLithuania | `1063` | The lithuanian Lithuania language. |
| LowerSorbianGermany | `2094` | The lower sorbian Germany language. |
| LuxembourgishLuxembourg | `1134` | The luxembourgish Luxembourg language. |
| MacedonianFyromFormerYugoslavRepublicOfMacedonia | `1071` | The macedonian fyrom former Yugoslav Republic of Macedonia language. |
| MalayBruneiDarussalam | `2110` | The malay brunei Darussalam language. |
| MalayMalaysia | `1086` | The malay Malaysia language. |
| MalayalamIndia | `1100` | The malayalam India language. |
| MalteseMalta | `1082` | The maltese Malta language. |
| MaoriNewZealand | `1153` | The maori New Zealand language. |
| MapudungunChile | `1146` | The mapudungun Chile language. |
| MarathiIndia | `1102` | The marathi India language. |
| MohawkMohawk | `1148` | The mohawk Mohawk language. |
| MongolianCyrillicMongolia | `1104` | The mongolian cyrillic Mongolia language. |
| MongolianTraditionalPeoplesRepublicOfChina | `2128` | The mongolian traditional Peoples Republic of China language. |
| NepaliNepal | `1121` | The nepali Nepal language. |
| NorwegianBokmalNorway | `1044` | The norwegian bokmal Norway language. |
| NorwegianNynorskNorway | `2068` | The norwegian nynorsk Norway language. |
| OccitanFrance | `1154` | The occitan France language. |
| OdiaFormerlyOriyaIndia | `1096` | The odia formerly oriya India language. |
| PashtoAfghanistan | `1123` | The pashto Afghanistan language. |
| PolishPoland | `1045` | The polish Poland language. |
| PortugueseBrazil | `1046` | The portuguese Brazil language. |
| PortuguesePortugal | `2070` | The portuguese Portugal language. |
| PunjabiIndia | `1094` | The punjabi India language. |
| QuechuaBolivia | `1131` | The quechua Bolivia language. |
| QuechuaEcuador | `2155` | The quechua Ecuador language. |
| QuechuaPeru | `3179` | The quechua Peru language. |
| RomanianRomania | `1048` | The romanian Romania language. |
| RomanshSwitzerland | `1047` | The romansh Switzerland language. |
| RussianRussia | `1049` | The russian Russia language. |
| SamiInariFinland | `9275` | The sami inari Finland language. |
| SamiLuleNorway | `4155` | The sami lule Norway language. |
| SamiLuleSweden | `5179` | The sami lule Sweden language. |
| SamiNorthernFinland | `3131` | The sami northern Finland language. |
| SamiNorthernNorway | `1083` | The sami northern Norway language. |
| SamiNorthernSweden | `2107` | The sami northern Sweden language. |
| SamiSkoltFinland | `8251` | The sami skolt Finland language. |
| SamiSouthernNorway | `6203` | The sami southern Norway language. |
| SamiSouthernSweden | `7227` | The sami southern Sweden language. |
| SanskritIndia | `1103` | The sanskrit India language. |
| SerbianCyrillicBosniaAndHerzegovina | `7194` | The serbian cyrillic Bosnia and Herzegovina language. |
| SerbianCyrillicSerbia | `3098` | The serbian cyrillic Serbia language. |
| SerbianLatinBosniaAndHerzegovina | `6170` | The serbian latin Bosnia and Herzegovina language. |
| SerbianLatinSerbia | `2074` | The serbian latin Serbia language. |
| SesothoSaLeboaSouthAfrica | `1132` | The sesotho sa leboa South Africa language. |
| SetswanaSouthAfrica | `1074` | The setswana South Africa language. |
| SinhalaSriLanka | `1115` | The sinhala Sri Lanka language. |
| SlovakSlovakia | `1051` | The slovak Slovakia language. |
| SlovenianSlovenia | `1060` | The slovenian Slovenia language. |
| SpanishArgentina | `11274` | The spanish Argentina language. |
| SpanishBolivia | `16394` | The spanish Bolivia language. |
| SpanishChile | `13322` | The spanish Chile language. |
| SpanishColombia | `9226` | The spanish Colombia language. |
| SpanishCostaRica | `5130` | The spanish Costa Rica language. |
| SpanishDominicanRepublic | `7178` | The spanish Dominican Republic language. |
| SpanishEcuador | `12298` | The spanish Ecuador language. |
| SpanishElSalvador | `17418` | The spanish El Salvador language. |
| SpanishGuatemala | `4106` | The spanish Guatemala language. |
| SpanishHonduras | `18442` | The spanish Honduras language. |
| SpanishMexico | `2058` | The spanish Mexico language. |
| SpanishNicaragua | `19466` | The spanish Nicaragua language. |
| SpanishPanama | `6154` | The spanish Panama language. |
| SpanishParaguay | `15370` | The spanish Paraguay language. |
| SpanishPeru | `10250` | The spanish Peru language. |
| SpanishPuertoRico | `20490` | The spanish Puerto Rico language. |
| SpanishModernSortSpain | `3082` | The spanish modern sort Spain language. |
| SpanishTraditionalSortSpain | `1034` | The spanish traditional sort Spain language. |
| SpanishUnitedStates | `21514` | The spanish United States language. |
| SpanishUruguay | `14346` | The spanish Uruguay language. |
| SpanishVenezuela | `8202` | The spanish Venezuela language. |
| SwedenFinland | `2077` | The sweden Finland language. |
| SwedishSweden | `1053` | The swedish Sweden language. |
| SyriacSyria | `1114` | The syriac Syria language. |
| TajikCyrillicTajikistan | `1064` | The tajik cyrillic tajikistan language. |
| TamazightLatinAlgeria | `2143` | The tamazight latin Algeria language. |
| TamilIndia | `1097` | The tamil India language. |
| TatarRussia | `1092` | The tatar Russia language. |
| TeluguIndia | `1098` | The telugu India language. |
| ThaiThailand | `1054` | The thai Thailand language. |
| TibetanPrc | `1105` | The tibetan PRC language. |
| TurkishTurkey | `1055` | The turkish Turkey language. |
| TurkmenTurkmenistan | `1090` | The turkmen Turkmenistan language. |
| UighurPrc | `1152` | The uighur PRC language. |
| UkrainianUkraine | `1058` | The ukrainian Ukraine language. |
| UpperSorbianGermany | `1070` | The upper sorbian Germany language. |
| UrduIslamicRepublicOfPakistan | `1056` | The urdu Islamic Republic of Pakistan language. |
| UzbekCyrillicUzbekistan | `2115` | The uzbek cyrillic Uzbekistan language. |
| UzbekLatinUzbekistan | `1091` | The uzbek latin Uzbekistan language. |
| VietnameseVietnam | `1066` | The vietnamese Vietnam language. |
| WelshUnitedKingdom | `1106` | The welsh United Kingdom language. |
| WolofSenegal | `1160` | The wolof Senegal language. |
| YakutRussia | `1157` | The yakut Russia language. |
| YiPrc | `1144` | The yi PRC language. |
| YorubaNigeria | `1130` | The yoruba Nigeria language. |

### OpenTypeWindowsNameRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewindowsnamerecord.md

#### OpenTypeWindowsNameRecord class

Represents the Name record table value for Windows platform.

```csharp
public class OpenTypeWindowsNameRecord : OpenTypeBaseNameRecord
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Encoding { get; } | Gets the encoding identifier. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language identifier. |
| MetadataType { get; } | Gets the metadata type. |
| NameID { get; } | Gets the name identifier. |
| Platform { get; } | Gets the platform identifier. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the string value of record. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Encoding
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/encoding.md

#### OpenTypeWindowsNameRecord.Encoding property

Gets the encoding identifier.

```csharp
public OpenTypeWindowsEncoding Encoding { get; }
```

##### Property Value

The encoding identifier.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/language.md

#### OpenTypeWindowsNameRecord.Language property

Gets the language identifier.

```csharp
public OpenTypeWindowsLanguage Language { get; }
```

##### Property Value

The language identifier.

### GroupDocs.Metadata.Formats.Gis
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis.md

#### Classes

| Class | Description |
| --- | --- |
| GisAttribute | Represents metadata associated with layer. |
| GisFeature | Represents metadata associated with feature. |
| GisPackage | Represents gis metadata. |
| GisRootPackage | Represents gis metadata. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| GisFormat | Defines various gis subformats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### GisAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisattribute.md

#### GisAttribute class

Represents metadata associated with layer.

```csharp
public sealed class GisAttribute : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the attribute name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the attribute value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisattribute/name.md

#### GisAttribute.Name property

Gets the attribute name.

```csharp
public string Name { get; }
```

##### Property Value

The attribute name.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisattribute/value.md

#### GisAttribute.Value property

Gets the attribute value.

```csharp
public string Value { get; }
```

##### Property Value

The attribute value.

### GisFeature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisfeature.md

#### GisFeature class

Represents metadata associated with feature.

```csharp
public sealed class GisFeature : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Attributes { get; } | Gets an array of `GisAttribute`. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Attributes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisfeature/attributes.md

#### GisFeature.Attributes property

Gets an array of `GisAttribute`.

```csharp
public GisAttribute[] Attributes { get; }
```

##### Property Value

An array of `GisAttribute`.

### GisFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisformat.md

#### GisFormat enumeration

Defines various gis subformats.

```csharp
public enum GisFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | The format is not recognized. |
| Shp | `1` | Shp file. |
| GeoJson | `2` | GeoJson file. |
| TopoJson | `3` | TopoJson file. |
| Gml | `4` | Gml file. |
| Osm | `5` | Osm file. |
| Kml | `6` | Kml file. |
| Gpx | `7` | Gpx file. |

### GisPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gispackage.md

#### GisPackage class

Represents gis metadata.

```csharp
public sealed class GisPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Features { get; } | Gets an array of `GisFeature`. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a gis file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputGis))
{
    var root = metadata.GetRootPackage<GisRootPackage>();

    foreach (var feature in root.GisPackage.Features)
    {
        foreach (var attribute in feature.Attributes)
        {
            Console.WriteLine(attribute.Name);
            Console.WriteLine(attribute.Value);
        }
    }
}
```

### Features
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gispackage/features.md

#### GisPackage.Features property

Gets an array of `GisFeature`.

```csharp
public GisFeature[] Features { get; }
```

##### Property Value

An array of `GisFeature`.

### GisRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisrootpackage.md

#### GisRootPackage class

Represents gis metadata.

```csharp
public class GisRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| GisPackage { get; } | Gets the Gis metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a gis file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputGis))
{
    var root = metadata.GetRootPackage<GisRootPackage>();

    foreach (var feature in root.GisPackage.Features)
    {
        foreach (var attribute in feature.Attributes)
        {
            Console.WriteLine(attribute.Name);
            Console.WriteLine(attribute.Value);
        }
    }
}
```

### GisPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.gis/gisrootpackage/gispackage.md

#### GisRootPackage.GisPackage property

Gets the Gis metadata package.

```csharp
public GisPackage GisPackage { get; }
```

##### Property Value

The Gis metadata package.

### GroupDocs.Metadata.Formats.Image.Dng
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng.md

#### Classes

| Class | Description |
| --- | --- |
| DngPackage | Represents native DNG metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DngPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage.md

#### DngPackage class

Represents native DNG metadata.

```csharp
public sealed class DngPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| DngPackage() | Initializes a new instance of the `Metadata` class. |

#### Properties

| Name | Description |
| --- | --- |
| Aperture { get; } | Gets the aperture. |
| Artist { get; } | Gets the author of image. |
| CameraManufacturer { get; } | Gets the camera manufacturer. |
| ColorsCount { get; } | Gets the colors. |
| Count { get; } | Gets the number of metadata properties. |
| Description { get; } | Gets the description of colors (RGBG,RGBE,GMCY, or GBTG). |
| DngVersion { get; } | Gets the DNG version. |
| Filters { get; } | Gets the Bit mask describing the order of color pixels in the matrix. |
| FocalLength { get; } | Gets the length of the focal. |
| GpsData { get; } | Gets the GPS data. |
| IsFoveon { get; } | Gets the is foveon matrix. |
| IsoSpeed { get; } | Gets the ISO sensitivity. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Model { get; } | Gets the camera model. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawCount { get; } | Gets the number of RAW images in file (0 means that the file has not been recognized). |
| ShotOrder { get; } | Gets serial number of image. |
| ShutterSpeed { get; } | Gets the shutter speed. |
| Software { get; } | Gets the software. |
| Timestamp { get; } | Gets the date of shooting. |
| TranslationCfaDng { get; } | Gets the translation array for CFA mosaic DNG format. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Aperture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/aperture.md

#### DngPackage.Aperture property

Gets the aperture.

```csharp
public float Aperture { get; }
```

##### Property Value

The aperture.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/artist.md

#### DngPackage.Artist property

Gets the author of image.

```csharp
public string Artist { get; }
```

##### Property Value

The artist.

### CameraManufacturer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/cameramanufacturer.md

#### DngPackage.CameraManufacturer property

Gets the camera manufacturer.

```csharp
public string CameraManufacturer { get; }
```

##### Property Value

The make.

### ColorsCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/colorscount.md

#### DngPackage.ColorsCount property

Gets the colors.

```csharp
public int ColorsCount { get; }
```

##### Property Value

The colors.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/description.md

#### DngPackage.Description property

Gets the description of colors (RGBG,RGBE,GMCY, or GBTG).

```csharp
public string Description { get; }
```

##### Property Value

The cdesc.

### DngPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/dngpackage.md

#### DngPackage constructor

Initializes a new instance of the `Metadata` class.

```csharp
public DngPackage()
```

### DngVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/dngversion.md

#### DngPackage.DngVersion property

Gets the DNG version.

```csharp
public uint DngVersion { get; }
```

##### Property Value

The DNG version.

### Filters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/filters.md

#### DngPackage.Filters property

Gets the Bit mask describing the order of color pixels in the matrix.

```csharp
public uint Filters { get; }
```

##### Property Value

The filters.

### FocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/focallength.md

#### DngPackage.FocalLength property

Gets the length of the focal.

```csharp
public float FocalLength { get; }
```

##### Property Value

The length of the focal.

### GpsData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/gpsdata.md

#### DngPackage.GpsData property

Gets the GPS data.

```csharp
public uint[] GpsData { get; }
```

##### Property Value

The GPS data.

### IsFoveon
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/isfoveon.md

#### DngPackage.IsFoveon property

Gets the is foveon matrix.

```csharp
public uint IsFoveon { get; }
```

##### Property Value

The is foveon.

### IsoSpeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/isospeed.md

#### DngPackage.IsoSpeed property

Gets the ISO sensitivity.

```csharp
public float IsoSpeed { get; }
```

##### Property Value

The ISO speed.

### Model
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/model.md

#### DngPackage.Model property

Gets the camera model.

```csharp
public string Model { get; }
```

##### Property Value

The model.

### RawCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/rawcount.md

#### DngPackage.RawCount property

Gets the number of RAW images in file (0 means that the file has not been recognized).

```csharp
public uint RawCount { get; }
```

##### Property Value

The raw count.

### ShotOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/shotorder.md

#### DngPackage.ShotOrder property

Gets serial number of image.

```csharp
public uint ShotOrder { get; }
```

##### Property Value

The shot order.

### ShutterSpeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/shutterspeed.md

#### DngPackage.ShutterSpeed property

Gets the shutter speed.

```csharp
public float ShutterSpeed { get; }
```

##### Property Value

The shutter.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/software.md

#### DngPackage.Software property

Gets the software.

```csharp
public string Software { get; }
```

##### Property Value

The software.

### Timestamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/timestamp.md

#### DngPackage.Timestamp property

Gets the date of shooting.

```csharp
public long Timestamp { get; }
```

##### Property Value

The timestamp.

### TranslationCfaDng
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.dng/dngpackage/translationcfadng.md

#### DngPackage.TranslationCfaDng property

Gets the translation array for CFA mosaic DNG format.

```csharp
public string[] TranslationCfaDng { get; }
```

##### Property Value

The xtrans.

### GroupDocs.Metadata.Formats.Image.Svg
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg.md

#### Classes

| Class | Description |
| --- | --- |
| SvgPackage | Represents a native metadata package in a SVG image file. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### SvgPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage.md

#### SvgPackage class

Represents a native metadata package in a SVG image file.

```csharp
public sealed class SvgPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| SvgPackage() | Initializes a new instance of the `SvgPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Height { get; } | Gets the image height. |
| HeightF { get; } | Gets the object height, in inches. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Width { get; } | Gets the image width. |
| WidthF { get; } | Gets the object width, in inches. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to extract technical information from a SVG file.

```csharp
using (Metadata metadata = new Metadata("input.svg"))
{
    var root = metadata.GetRootPackage<SvgRootPackage>();
    if (root.SvgPackage != null)
    {
        Console.WriteLine(root.SvgPackage.Title);
        Console.WriteLine(root.SvgPackage.Version);
        Console.WriteLine(root.SvgPackage.Album);
    }
}
```

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage/height.md

#### SvgPackage.Height property

Gets the image height.

```csharp
public int Height { get; }
```

##### Property Value

Height value

### HeightF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage/heightf.md

#### SvgPackage.HeightF property

Gets the object height, in inches.

```csharp
public float HeightF { get; }
```

##### Property Value

HeightF value

### SvgPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage/svgpackage.md

#### SvgPackage constructor

Initializes a new instance of the `SvgPackage` class.

```csharp
public SvgPackage()
```

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage/width.md

#### SvgPackage.Width property

Gets the image width.

```csharp
public int Width { get; }
```

##### Property Value

Width value

### WidthF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.svg/svgpackage/widthf.md

#### SvgPackage.WidthF property

Gets the object width, in inches.

```csharp
public float WidthF { get; }
```

##### Property Value

WidthF value

### GroupDocs.Metadata.Formats.Image
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image.md

The namespace provides functionality allowing users to read and update metadata stored in different image formats.

#### Classes

| Class | Description |
| --- | --- |
| BmpHeaderPackage | Represents BMP header info. |
| DicomPackage | Represents native DICOM metadata. |
| GifImageTypePackage | Represents a metadata package containing GIF-specific file format information. |
| ImageResourceBlock | Represents a Photoshop Image Resource block.  Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF. Image resources are used to store non-pixel data associated with images, such as pen tool paths. |
| ImageResourcePackage | Represents a metadata package containing Photoshop Image Resources. |
| ImageTypePackage | Represents a metadata package containing image-specific file format information. |
| Jpeg2000Package | Represents native JPEG2000 metadata. |
| PngCompressedTextChunk | Represents compressed textual data extracted from a PNG image. |
| PngInternationalTextChunk | Represents international textual data extracted from a PNG image. |
| PngPackage | Represents native PNG metadata. |
| PngTextChunk | Represents textual data extracted from a PNG image. |
| PsdLayer | Represents a layer in a PSD file. |
| PsdPackage | Represents native Photoshop metadata. |
| RawDoubleTag | Represents a Raw Double tag. |
| RawFloatTag | Represents a Raw float tag. |
| RawRational | Represents a rational number. |
| RawRationalTag | Represents a Raw Rational tag. |
| RawSByteTag | Represents a Raw SByte tag. |
| RawSLongTag | Represents a Raw SLong tag. |
| RawSRational | Represents signed rational number. |
| RawSRationalTag | Represents a Raw SRational tag. |
| RawSShortTag | Represents a Raw SShort tag. |
| RawTypePackage | Represents a metadata package containing image-specific file format information. |
| RawUndefinedTag | Represents a Raw tag with the Undefined type. |
| TiffArrayTag&lt;T&gt; | Represents an array-based TIFF tag. |
| TiffAsciiTag | Represents a TIFF ASCII tag. |
| TiffByteTag | Represents a Byte tag. |
| TiffDoubleTag | Represents a TIFF Double tag. |
| TiffFloatTag | Represents a TIFF float tag. |
| TiffLongTag | Represents a TIFF Long tag. |
| TiffRational | Represents a rational number. |
| TiffRationalTag | Represents a TIFF Rational tag. |
| TiffSByteTag | Represents a TIFF SByte tag. |
| TiffShortTag | Represents a TIFF Short tag. |
| TiffSLongTag | Represents a TIFF SLong tag. |
| TiffSRational | Represents signed rational number. |
| TiffSRationalTag | Represents a TIFF SRational tag. |
| TiffSShortTag | Represents a TIFF SShort tag. |
| TiffTag | Represents a TIFF tag. |
| TiffUndefinedTag | Represents a TIFF tag with the Undefined type. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ImageResourceID | Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file. |
| PngCompressionMethod | Defines compression methods used in the PNG format. |
| PsdColorMode | Represents the psd file format color mode. |
| PsdCompressionMethod | Defines the compression method used for image data. |
| PsdLayerFlags | The Photoshop layer flags. |
| TiffTagID | Defines ids of TIFF tags. |
| TiffTagType | Represents the IFD data type. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### BmpHeaderPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage.md

#### BmpHeaderPackage class

Represents BMP header info.

```csharp
public sealed class BmpHeaderPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets the bits per pixel value. |
| ColorsImportant { get; } | Gets the number of important palette colors. |
| Count { get; } | Gets the number of metadata properties. |
| HeaderSize { get; } | Gets the size of the header in bytes. |
| ImageSize { get; } | Gets the bitmap raw data size in bytes. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Planes { get; } | Gets the number of planes. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsPerPixel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage/bitsperpixel.md

#### BmpHeaderPackage.BitsPerPixel property

Gets the bits per pixel value.

```csharp
public ushort BitsPerPixel { get; }
```

##### Property Value

The bits per pixel value.

### ColorsImportant
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage/colorsimportant.md

#### BmpHeaderPackage.ColorsImportant property

Gets the number of important palette colors.

```csharp
public uint ColorsImportant { get; }
```

##### Property Value

The number of important palette colors.

### HeaderSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage/headersize.md

#### BmpHeaderPackage.HeaderSize property

Gets the size of the header in bytes.

```csharp
public uint HeaderSize { get; }
```

##### Property Value

The size of the header in bytes.

### ImageSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage/imagesize.md

#### BmpHeaderPackage.ImageSize property

Gets the bitmap raw data size in bytes.

```csharp
public uint ImageSize { get; }
```

##### Property Value

The bitmap raw data size in bytes.

### Planes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/bmpheaderpackage/planes.md

#### BmpHeaderPackage.Planes property

Gets the number of planes.

```csharp
public ushort Planes { get; }
```

##### Property Value

The number of planes.

### DicomPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage.md

#### DicomPackage class

Represents native DICOM metadata.

```csharp
public sealed class DicomPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| DicomPackage() | Initializes a new instance of the `Metadata` class. |

#### Properties

| Name | Description |
| --- | --- |
| BitsAllocated { get; } | Gets the bits allocated value. |
| Blues { get; } | Gets the array colors of the blue. |
| Count { get; } | Gets the number of metadata properties. |
| DicomInfo { get; } | Gets the header information of the DICOM file. |
| Greens { get; } | Gets the array colors of the green. |
| HeaderBytes { get; } | Gets the header information by bytes. |
| HeaderOffset { get; } | Gets the header offset. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NumberOfFrames { get; } | Gets the number of frames. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Reds { get; } | Gets the array colors of the red. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsAllocated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/bitsallocated.md

#### DicomPackage.BitsAllocated property

Gets the bits allocated value.

```csharp
public int BitsAllocated { get; }
```

##### Property Value

The bits allocated.

### Blues
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/blues.md

#### DicomPackage.Blues property

Gets the array colors of the blue.

```csharp
public byte[] Blues { get; }
```

##### Property Value

The blue colors.

### DicomInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/dicominfo.md

#### DicomPackage.DicomInfo property

Gets the header information of the DICOM file.

```csharp
public string[] DicomInfo { get; }
```

##### Property Value

The dicom header information.

### DicomPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/dicompackage.md

#### DicomPackage constructor

Initializes a new instance of the `Metadata` class.

```csharp
public DicomPackage()
```

### Greens
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/greens.md

#### DicomPackage.Greens property

Gets the array colors of the green.

```csharp
public byte[] Greens { get; }
```

##### Property Value

The green colors.

### HeaderBytes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/headerbytes.md

#### DicomPackage.HeaderBytes property

Gets the header information by bytes.

```csharp
public byte[] HeaderBytes { get; }
```

##### Property Value

The header bytes.

### HeaderOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/headeroffset.md

#### DicomPackage.HeaderOffset property

Gets the header offset.

```csharp
public int HeaderOffset { get; }
```

##### Property Value

The header offset.

### NumberOfFrames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/numberofframes.md

#### DicomPackage.NumberOfFrames property

Gets the number of frames.

```csharp
public int NumberOfFrames { get; }
```

##### Property Value

The number of frames.

### Reds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/dicompackage/reds.md

#### DicomPackage.Reds property

Gets the array colors of the red.

```csharp
public byte[] Reds { get; }
```

##### Property Value

The red colors.

### GifImageTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/gifimagetypepackage.md

#### GifImageTypePackage class

Represents a metadata package containing GIF-specific file format information.

```csharp
public class GifImageTypePackage : ImageTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| ByteOrder { get; } | Gets the byte-order of the image. Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Height { get; } | Gets the image height. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Version { get; } | Gets the version of the format. |
| Width { get; } | Gets the image width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/gifimagetypepackage/version.md

#### GifImageTypePackage.Version property

Gets the version of the format.

```csharp
public string Version { get; }
```

##### Property Value

The version of the format.

### ImageResourceBlock
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceblock.md

#### ImageResourceBlock class

Represents a Photoshop Image Resource block.  Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF. Image resources are used to store non-pixel data associated with images, such as pen tool paths.

```csharp
public sealed class ImageResourceBlock : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Data { get; } | Gets the resource data. |
| ID { get; } | Gets the unique identifier for the resource. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the image resource block name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Signature { get; } | Gets the image resource block signature. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Data
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceblock/data.md

#### ImageResourceBlock.Data property

Gets the resource data.

```csharp
public byte[] Data { get; }
```

##### Property Value

The resource data.

### ID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceblock/id.md

#### ImageResourceBlock.ID property

Gets the unique identifier for the resource.

```csharp
public ImageResourceID ID { get; }
```

##### Property Value

The identifier.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceblock/name.md

#### ImageResourceBlock.Name property

Gets the image resource block name.

```csharp
public string Name { get; }
```

##### Property Value

The image resource block name.

### Signature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceblock/signature.md

#### ImageResourceBlock.Signature property

Gets the image resource block signature.

```csharp
public string Signature { get; }
```

##### Property Value

The image resource block signature

### ImageResourceID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourceid.md

#### ImageResourceID enumeration

Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file.

```csharp
public enum ImageResourceID
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ResolutionInfo | `1005` | ResolutionInfo structure. See Appendix A in Photoshop API Guide PDF document. |
| NamesOfAlphaChannels | `1006` | Names of the alpha channels as a series of Pascal strings. |
| Caption | `1008` | The caption as a Pascal string. |
| BorderInformation | `1009` | Border information. Contains a fixed number (2 bytes real, 2 bytes fraction) for the border width, and 2 bytes for border units (1 = inches, 2 = cm, 3 = points, 4 = picas, 5 = columns). |
| BackgroundColor | `1010` | Background color. [See more.](http://www.adobe.com/devnet-apps/photoshop/fileformatashtml/#50577411_31265) |
| PrintFlags | `1011` | Print flags. A series of one-byte boolean values (see Page Setup dialog): labels, crop marks, color bars, registration marks, negative, flip, interpolate, caption, print flags. |
| Grayscale | `1012` | Grayscale and multichannel halftoning information. |
| ColorHalftoning | `1013` | Color halftoning information. |
| DuotoneHalftoning | `1014` | Duotone halftoning information. |
| GrayscaleFunction | `1015` | Grayscale and multichannel transfer function. |
| ColorTransferFunctions | `1016` | Color transfer functions. |
| DuotoneTransferFunctions | `1017` | Duotone transfer functions. |
| DuotoneImageInformation | `1018` | Duotone image information. |
| EPSOptions | `1021` | EPS options. |
| QuickMaskInformation | `1022` | Quick Mask information. 2 bytes containing Quick Mask channel ID; 1- byte boolean indicating whether the mask was initially empty. |
| LayerStateInformation | `1024` | Layer state information. 2 bytes containing the index of target layer (0 = bottom layer). |
| WorkingPath | `1025` | Working path (not saved). See See Path resource format. |
| LayersGroupInformation | `1026` | Layers group information. 2 bytes per layer containing a group ID for the dragging groups. Layers in a group have the same group ID. |
| Iptc | `1028` | IPTC-NAA record. Contains the File Info... information. See the documentation in the IPTC folder of the Documentation folder. |
| ImageModeForRawFormat | `1029` | Image mode for raw format files. |
| JpegQuality | `1030` | JPEG quality. Private. |
| GridAndGuidesInfoPhotoshop4 | `1032` | Grid and guides information. |
| ThumbnailResourcePhotoshop4 | `1033` | Thumbnail resource for Photoshop 4.0 only. |
| CopyrightFlagPhotoshop4 | `1034` | Copyright flag. Boolean indicating whether image is copyrighted. Can be set via Property suite or by user in File Info... |
| UrlPhotoshop4 | `1035` | URL. Handle of a text string with uniform resource locator. Can be set via Property suite or by user in File Info... |
| ThumbnailResourcePhotoshop5 | `1036` | Thumbnail resource (supersedes resource 1033). See See Thumbnail resource format. |
| GlobalAnglePhotoshop5 | `1037` | Global Angle. 4 bytes that contain an integer between 0 and 359, which is the global lighting angle for effects layer. If not present, assumed to be 30. |
| IccProfilePhotoshop5 | `1039` | (Photoshop 5.0) ICC Profile. The raw bytes of an ICC (International Color Consortium) format profile. See ICC1v42_2006-05.pdf in the Documentation folder and icProfileHeader.h in Sample Code\Common\Includes. |
| WatermarkPhotoshop5 | `1040` | Watermark. One byte. |
| IccUntaggedProfilePhotoshop5 | `1041` | ICC Untagged Profile. 1 byte that disables any assumed profile handling when opening the file. 1 = intentionally untagged. |
| TransparencyIndexPhotoshop6 | `1047` | Transparency Index. 2 bytes for the index of transparent color, if any. |
| GlobalAltitudePhotoshop6 | `1049` | Global Altitude. 4 byte entry for altitude. |
| SlicesPhotoshop6 | `1050` | Slices (Photoshop 6). |
| WorkflowUrlPhotoshop6 | `1051` | Workflow URL. Unicode string. Photoshop 6. |
| AlphaIdentifiersPhotoshop6 | `1053` | Alpha Identifiers. 4 bytes of length, followed by 4 bytes each for every alpha identifier. |
| UrlListPhotoshop6 | `1054` | URL InternalList. 4 byte count of URLs, followed by 4 byte long, 4 byte ID, and Unicode string for each count. |
| VersionInfoPhotoshop6 | `1057` | Version Info. 4 bytes version, 1 byte hasRealMergedData , Unicode string: writer name, Unicode string: reader name, 4 bytes file version. |
| ExifData1Photoshop7 | `1058` | EXIF data 1, [see more](http://www.kodak.com/global/plugins/acrobat/en/service/digCam/exifStandard2.pdf). |
| ExifData3Photoshop7 | `1059` | [EXIF data 3. ](http://www.kodak.com/global/plugins/acrobat/en/service/digCam/exifStandard2.pdf) |
| XmpPhotoshop7 | `1060` | XMP metadata. File info as XML description, [see more](http://www.adobe.com/devnet/xmp). |
| CaptionDigestPhotoshop7 | `1061` | Caption digest. 16 bytes: RSA Data Security, MD5 message-digest algorithm. |
| PrintScalePhotoshop7 | `1062` | Print scale. 2 bytes style (0 = centered, 1 = size to fit, 2 = user defined). 4 bytes x location (floating point). 4 bytes y location (floating point). 4 bytes scale (floating point). |
| PixelAspectRatio | `1064` | Pixel Aspect Ratio. 4 bytes (version = 1 or 2), 8 bytes double, x / y of a pixel. Version 2, attempting to correct values for NTSC and PAL, previously off by a factor of approx. 5%. |
| LayerComps | `1065` | Layer Comps. 4 bytes (descriptor version = 16), Descriptor. |
| LayerSelectionIds | `1069` | Layer Selection ID(s). 2 bytes count, following is repeated for each count: 4 bytes layer ID. |
| PrintInfoCS2 | `1071` | Print info (Photoshop CS2). |
| LayerGroupEnabledIdCS2 | `1072` | Layer Group(s) Enabled ID. 1 byte for each layer in the document, repeated by length of the resource. NOTE: Layer groups have start and end markers (Photoshop CS2). |
| ColorSamplersResourceCS3 | `1073` | Color samplers resource. Also see ID 1038 for old format. |
| MeasurementScaleCS3 | `1074` | Measurement Scale. 4 bytes (descriptor version = 16), Descriptor. |
| TimelineInformationCS3 | `1075` | Timeline Information. 4 bytes (descriptor version = 16), Descriptor. |
| SheetDisclosureCS3 | `1076` | Sheet Disclosure. 4 bytes (descriptor version = 16), Descriptor. |
| PrintInformationCS5 | `1082` | Print Information (Photoshop CS5). |
| PrintStyleCS5 | `1083` | Print Style (Photoshop CS5). |
| MacintoshNSPrintInfoCS5 | `1084` | Macintosh NSPrintInfo. Variable OS specific info for Macintosh. NSPrintInfo. It is recommended that you do not interpret or use this data. (Photoshop CS5). |
| WindowsDevmodeCS5 | `1085` | Windows DEVMODE. Variable OS specific info for Windows. DEVMODE. It is recommended that you do not interpret or use this data. (Photoshop CS5). |
| AutoSaveFilePathCS6 | `1086` | Auto Save File Path. Unicode string. (Photoshop CS6). |
| AutoSaveFormatCS6 | `1087` | Auto Save Format. Unicode string. (Photoshop CS6). |
| PathSelectionStateCC | `1088` | Path Selection State. (Photoshop CC). |
| ImageReadyVariables | `7000` | Image Ready variables. XML representation of variables definition. |
| ImageReadyDatasets | `7001` | Image Ready data sets. |
| PrintFlagsInformation | `10000` | Print flags information. 2 bytes version ( = 1), 1 byte center crop marks, 1 byte ( = 0), 4 bytes bleed width value, 2 bytes bleed width scale. |

### ImageResourcePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourcepackage.md

#### ImageResourcePackage class

Represents a metadata package containing Photoshop Image Resources.

```csharp
public sealed class ImageResourcePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imageresourcepackage/tolist.md

#### ImageResourcePackage.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<ImageResourceBlock> ToList()
```

##### Return Value

A list that contains all Image Resource Blocks from the package.

### ImageTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imagetypepackage.md

#### ImageTypePackage class

Represents a metadata package containing image-specific file format information.

```csharp
public class ImageTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| ByteOrder { get; } | Gets the byte-order of the image. Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Height { get; } | Gets the image height. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Width { get; } | Gets the image width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ByteOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imagetypepackage/byteorder.md

#### ImageTypePackage.ByteOrder property

Gets the byte-order of the image. Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information.

```csharp
public ByteOrder ByteOrder { get; }
```

##### Property Value

The byte-order value.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imagetypepackage/height.md

#### ImageTypePackage.Height property

Gets the image height.

```csharp
public int Height { get; }
```

##### Property Value

The image height.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/imagetypepackage/width.md

#### ImageTypePackage.Width property

Gets the image width.

```csharp
public int Width { get; }
```

##### Property Value

The image width.

### Jpeg2000Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/jpeg2000package.md

#### Jpeg2000Package class

Represents native JPEG2000 metadata.

```csharp
public class Jpeg2000Package : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Comments { get; } | Gets the JPEG2000 comments. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/jpeg2000package/comments.md

#### Jpeg2000Package.Comments property

Gets the JPEG2000 comments.

```csharp
public string[] Comments { get; }
```

##### Property Value

The JPEG2000 comments.

### PngCompressedTextChunk
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngcompressedtextchunk.md

#### PngCompressedTextChunk class

Represents compressed textual data extracted from a PNG image.

```csharp
public class PngCompressedTextChunk : PngTextChunk
```

#### Properties

| Name | Description |
| --- | --- |
| CompressionMethod { get; } | Gets the algorithm used to compress the chunk data. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keyword { get; } | Gets the keyword that indicates the type of information represented by the chunk. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the actual text string represented by the chunk. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CompressionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngcompressedtextchunk/compressionmethod.md

#### PngCompressedTextChunk.CompressionMethod property

Gets the algorithm used to compress the chunk data.

```csharp
public PngCompressionMethod CompressionMethod { get; }
```

##### Property Value

The algorithm used to compress the chunk data.

### PngCompressionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngcompressionmethod.md

#### PngCompressionMethod enumeration

Defines compression methods used in the PNG format.

```csharp
public enum PngCompressionMethod
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Deflate | `0` | Represents the deflate/inflate compression with a sliding window. |

### PngInternationalTextChunk
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pnginternationaltextchunk.md

#### PngInternationalTextChunk class

Represents international textual data extracted from a PNG image.

```csharp
public class PngInternationalTextChunk : PngCompressedTextChunk
```

#### Properties

| Name | Description |
| --- | --- |
| CompressionMethod { get; } | Gets the algorithm used to compress the chunk data. |
| Count { get; } | Gets the number of metadata properties. |
| IsCompressed { get; } | Gets a value indicating whether the chunk is compressed. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keyword { get; } | Gets the keyword that indicates the type of information represented by the chunk. |
| Language { get; } | Gets the human language used by the translated keyword and the text. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the actual text string represented by the chunk. |
| TranslatedKeyword { get; } | Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### IsCompressed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pnginternationaltextchunk/iscompressed.md

#### PngInternationalTextChunk.IsCompressed property

Gets a value indicating whether the chunk is compressed.

```csharp
public bool IsCompressed { get; }
```

##### Property Value

True, if the chunk is compressed; otherwise, false.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pnginternationaltextchunk/language.md

#### PngInternationalTextChunk.Language property

Gets the human language used by the translated keyword and the text.

```csharp
public string Language { get; }
```

##### Property Value

The human language used by the translated keyword and the text.

### TranslatedKeyword
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pnginternationaltextchunk/translatedkeyword.md

#### PngInternationalTextChunk.TranslatedKeyword property

Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property.

```csharp
public string TranslatedKeyword { get; }
```

##### Property Value

The translated keyword that contains a translation of the keyword into the language indicated by the language property.

### PngPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngpackage.md

#### PngPackage class

Represents native PNG metadata.

```csharp
public class PngPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TextChunks { get; } | Gets the collection of text chunks extracted from the image. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### TextChunks
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngpackage/textchunks.md

#### PngPackage.TextChunks property

Gets the collection of text chunks extracted from the image.

```csharp
public PngTextChunk[] TextChunks { get; }
```

##### Property Value

The collection of text chunks extracted from the image.

### PngTextChunk
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngtextchunk.md

#### PngTextChunk class

Represents textual data extracted from a PNG image.

```csharp
public class PngTextChunk : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keyword { get; } | Gets the keyword that indicates the type of information represented by the chunk. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the actual text string represented by the chunk. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Keyword
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngtextchunk/keyword.md

#### PngTextChunk.Keyword property

Gets the keyword that indicates the type of information represented by the chunk.

```csharp
public string Keyword { get; }
```

##### Property Value

The keyword that indicates the type of information represented by the chunk.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/pngtextchunk/text.md

#### PngTextChunk.Text property

Gets the actual text string represented by the chunk.

```csharp
public string Text { get; }
```

##### Property Value

The actual text string represented by the chunk.

### PsdColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdcolormode.md

#### PsdColorMode enumeration

Represents the psd file format color mode.

```csharp
public enum PsdColorMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Bitmap | `0` | The bitmap color mode. |
| Grayscale | `1` | The grayscale mode. |
| Indexed | `2` | The indexed color mode. |
| Rgb | `3` | The RGB color mode. |
| Cmyk | `4` | The CMYK color mode. |
| Multichannel | `7` | The multichannel color mode. |
| Duotone | `8` | The duotone color mode. |
| Lab | `9` | The LAB color mode. |

### PsdCompressionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdcompressionmethod.md

#### PsdCompressionMethod enumeration

Defines the compression method used for image data.

```csharp
public enum PsdCompressionMethod
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Raw | `0` | No compression. The image data stored as raw bytes in RGBA planar order. That means that first all R data is written, then all G is written, then all B and finally all A data is written. |
| Rle | `1` | RLE compressed. The image data starts with the byte counts for all the scan lines (rows * channels), with each count stored as a two-byte value. The RLE compressed data follows, with each scan line compressed separately. The RLE compression is the same compression algorithm used by the Macintosh ROM routine PackBits and the TIFF standard. |
| ZipWithoutPrediction | `2` | ZIP without prediction. |
| ZipWithPrediction | `3` | ZIP with prediction. |

### PsdLayer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer.md

#### PsdLayer class

Represents a layer in a PSD file.

```csharp
public sealed class PsdLayer : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerPixel { get; } | Gets the bits per pixel value. |
| Bottom { get; } | Gets the bottom layer position. |
| ChannelCount { get; } | Gets the number of channels. |
| Count { get; } | Gets the number of metadata properties. |
| Flags { get; } | Gets the layer flags. |
| Height { get; } | Gets the height. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Left { get; } | Gets the left layer position. |
| Length { get; } | Gets the overall layer length in bytes. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the layer name. |
| Opacity { get; } | Gets the layer opacity. 0 = transparent, 255 = opaque. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Right { get; } | Gets the right layer position. |
| Top { get; } | Gets the top layer position. |
| Width { get; } | Gets the width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsPerPixel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/bitsperpixel.md

#### PsdLayer.BitsPerPixel property

Gets the bits per pixel value.

```csharp
public int BitsPerPixel { get; }
```

##### Property Value

The bits per pixel value.

### Bottom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/bottom.md

#### PsdLayer.Bottom property

Gets the bottom layer position.

```csharp
public int Bottom { get; }
```

##### Property Value

The bottom layer position.

### ChannelCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/channelcount.md

#### PsdLayer.ChannelCount property

Gets the number of channels.

```csharp
public ushort ChannelCount { get; }
```

##### Property Value

The number of channels.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/flags.md

#### PsdLayer.Flags property

Gets the layer flags.

```csharp
public PsdLayerFlags Flags { get; }
```

##### Property Value

The flags.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/height.md

#### PsdLayer.Height property

Gets the height.

```csharp
public int Height { get; }
```

##### Property Value

The height.

### Left
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/left.md

#### PsdLayer.Left property

Gets the left layer position.

```csharp
public int Left { get; }
```

##### Property Value

The left layer position.

### Length
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/length.md

#### PsdLayer.Length property

Gets the overall layer length in bytes.

```csharp
public long Length { get; }
```

##### Property Value

The overall layer length in bytes.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/name.md

#### PsdLayer.Name property

Gets the layer name.

```csharp
public string Name { get; }
```

##### Property Value

The layer name.

### Opacity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/opacity.md

#### PsdLayer.Opacity property

Gets the layer opacity. 0 = transparent, 255 = opaque.

```csharp
public byte Opacity { get; }
```

##### Property Value

The opacity.

### Right
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/right.md

#### PsdLayer.Right property

Gets the right layer position.

```csharp
public int Right { get; }
```

##### Property Value

The right layer position.

### Top
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/top.md

#### PsdLayer.Top property

Gets the top layer position.

```csharp
public int Top { get; }
```

##### Property Value

The top layer position.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayer/width.md

#### PsdLayer.Width property

Gets the width.

```csharp
public int Width { get; }
```

##### Property Value

The width.

### PsdLayerFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdlayerflags.md

#### PsdLayerFlags enumeration

The Photoshop layer flags.

```csharp
[Flags]
public enum PsdLayerFlags : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No flags are set. |
| TransparencyProtected | `1` | The transparency protected flag. |
| Visible | `2` | The visibility flag. |
| Obsolete | `4` | The obsolete flag. |
| HasUsefulInformation | `8` | Defines if bit 4 has useful information. 1 for Photoshop 5.0 and later, |
| PixelDataIrrelevantToAppearanceInDocument | `10` | The pixel data is irrelevant to appearance in a document. |
| Undocumented | `20` | An undocumented flag. |

### PsdPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage.md

#### PsdPackage class

Represents native Photoshop metadata.

```csharp
public sealed class PsdPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| ChannelCount { get; } | Gets the number of channels. |
| ColorMode { get; } | Gets the psd color mode. |
| Compression { get; } | Gets the compression method used for image data. |
| Count { get; } | Gets the number of metadata properties. |
| Height { get; } | Gets the height of the image. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Layers { get; } | Gets the Photoshop layers. |
| MetadataType { get; } | Gets the metadata type. |
| PhotoshopVersion { get; } | Gets the Photoshop version. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Width { get; } | Gets PSD width of the image. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ChannelCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/channelcount.md

#### PsdPackage.ChannelCount property

Gets the number of channels.

```csharp
public int ChannelCount { get; }
```

##### Property Value

The number of channels.

### ColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/colormode.md

#### PsdPackage.ColorMode property

Gets the psd color mode.

```csharp
public PsdColorMode ColorMode { get; }
```

##### Property Value

The color mode.

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/compression.md

#### PsdPackage.Compression property

Gets the compression method used for image data.

```csharp
public PsdCompressionMethod Compression { get; }
```

##### Property Value

The compression method.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/height.md

#### PsdPackage.Height property

Gets the height of the image.

```csharp
public int Height { get; }
```

##### Property Value

The height of the image.

### Layers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/layers.md

#### PsdPackage.Layers property

Gets the Photoshop layers.

```csharp
public PsdLayer[] Layers { get; }
```

##### Property Value

The Photoshop layers.

### PhotoshopVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/photoshopversion.md

#### PsdPackage.PhotoshopVersion property

Gets the Photoshop version.

```csharp
public int PhotoshopVersion { get; }
```

##### Property Value

The photoshop version.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/psdpackage/width.md

#### PsdPackage.Width property

Gets PSD width of the image.

```csharp
public int Width { get; }
```

##### Property Value

The width of the image.

### RawDoubleTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawdoubletag.md

#### RawDoubleTag class

Represents a Raw Double tag.

```csharp
public sealed class RawDoubleTag : RawArrayTag<double>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawDoubleTag(uint, double[]) | Initializes a new instance of the `RawDoubleTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawdoubletag/equals.md

#### RawDoubleTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawdoubletag/gethashcode.md

#### RawDoubleTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawDoubleTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawdoubletag/rawdoubletag.md

#### RawDoubleTag constructor

Initializes a new instance of the `RawDoubleTag` class.

```csharp
public RawDoubleTag(uint tagID, double[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Double[] | The value. |

### RawFloatTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawfloattag.md

#### RawFloatTag class

Represents a Raw float tag.

```csharp
public sealed class RawFloatTag : RawArrayTag<float>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawFloatTag(uint, float[]) | Initializes a new instance of the `RawFloatTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawfloattag/equals.md

#### RawFloatTag.Equals method

Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object |  |

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawfloattag/gethashcode.md

#### RawFloatTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawFloatTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawfloattag/rawfloattag.md

#### RawFloatTag constructor

Initializes a new instance of the `RawFloatTag` class.

```csharp
public RawFloatTag(uint tagID, float[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Single[] | The value. |

### RawRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational.md

#### RawRational class

Represents a rational number.

```csharp
public sealed class RawRational : IEquatable<RawRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawRational(uint, uint) | Initializes a new instance of the `RawRational` class. |

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Gets the denominator. |
| Numerator { get; } | Gets the numerator. |
| Value { get; } | Gets the rational value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether the current object is equal to another object of the same type. |
| Equals(RawRational) | Indicates whether the current object is equal to another object of the same type. |
| override GetHashCode() | Returns a hash code for this instance. |
| override ToString() | Returns a String that represents this instance. |
| static Equals(RawRational, RawRational) | Compares a pair of `RawRational` numbers. |
| operator == | Indicates whether two objects of the same type are equal. |
| operator != | Indicates whether two objects of the same type are not equal. |

### Denominator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/denominator.md

#### RawRational.Denominator property

Gets the denominator.

```csharp
public uint Denominator { get; }
```

##### Property Value

The denominator.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/equals.md

#### Equals(RawRational, RawRational)

Compares a pair of `RawRational` numbers.

```csharp
public static bool Equals(RawRational rational, RawRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rational | RawRational | A rational number. |
| other | RawRational | Another rational number. |

##### Return Value

`true` if the objects are equal; otherwise, `false`.

#### Equals(RawRational)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(RawRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | RawRational | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *other* parameter; otherwise, `false`.

#### Equals(object)

Indicates whether the current object is equal to another object of the same type.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *obj* parameter; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/gethashcode.md

#### RawRational.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### Numerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/numerator.md

#### RawRational.Numerator property

Gets the numerator.

```csharp
public uint Numerator { get; }
```

##### Property Value

The numerator.

### op_Equality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/op_equality.md

#### RawRational Equality operator

Indicates whether two objects of the same type are equal.

```csharp
public static bool operator ==(RawRational left, RawRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | RawRational | The left object. |
| right | RawRational | The rigt object. |

##### Return Value

True if the objects are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/op_inequality.md

#### RawRational Inequality operator

Indicates whether two objects of the same type are not equal.

```csharp
public static bool operator !=(RawRational left, RawRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | RawRational | The left object. |
| right | RawRational | The right object. |

##### Return Value

True if the objects are not equal; otherwise, false.

### RawRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/rawrational.md

#### RawRational constructor

Initializes a new instance of the `RawRational` class.

```csharp
public RawRational(uint numerator, uint denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | UInt32 | The numerator. |
| denominator | UInt32 | The denominator. |

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/tostring.md

#### RawRational.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrational/value.md

#### RawRational.Value property

Gets the rational value.

```csharp
public double Value { get; }
```

##### Property Value

The rational value.

### RawRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrationaltag.md

#### RawRationalTag class

Represents a Raw Rational tag.

```csharp
public sealed class RawRationalTag : RawArrayTag<RawRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawRationalTag(uint, RawRational[]) | Initializes a new instance of the `RawRationalTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrationaltag/equals.md

#### RawRationalTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrationaltag/gethashcode.md

#### RawRationalTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawrationaltag/rawrationaltag.md

#### RawRationalTag constructor

Initializes a new instance of the `RawRationalTag` class.

```csharp
public RawRationalTag(uint tagID, RawRational[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | RawRational[] | The value. |

### RawSByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsbytetag.md

#### RawSByteTag class

Represents a Raw SByte tag.

```csharp
public sealed class RawSByteTag : RawArrayTag<sbyte>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawSByteTag(uint, sbyte[]) | Initializes a new instance of the `RawSByteTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsbytetag/equals.md

#### RawSByteTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsbytetag/gethashcode.md

#### RawSByteTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawSByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsbytetag/rawsbytetag.md

#### RawSByteTag constructor

Initializes a new instance of the `RawSByteTag` class.

```csharp
public RawSByteTag(uint tagID, sbyte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | SByte[] | The value. |

### RawSLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawslongtag.md

#### RawSLongTag class

Represents a Raw SLong tag.

```csharp
public sealed class RawSLongTag : RawArrayTag<int>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawSLongTag(uint, int[]) | Initializes a new instance of the `RawSLongTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawslongtag/equals.md

#### RawSLongTag.Equals method

Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object |  |

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawslongtag/gethashcode.md

#### RawSLongTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawSLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawslongtag/rawslongtag.md

#### RawSLongTag constructor

Initializes a new instance of the `RawSLongTag` class.

```csharp
public RawSLongTag(uint tagID, int[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Int32[] | The value. |

### RawSRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational.md

#### RawSRational class

Represents signed rational number.

```csharp
public sealed class RawSRational : IEquatable<RawSRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawSRational(int, int) | Initializes a new instance of the `RawSRational` class. |

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Gets denominator. |
| Numerator { get; } | Gets numerator. |
| Value { get; } | Gets actual value represented as double. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether the current object is equal to another object of the same type. |
| Equals(RawSRational) | Indicates whether the current object is equal to another object of the same type. |
| override GetHashCode() | Returns a hash code for this instance. |
| override ToString() | Returns a String that represents this instance. |
| static Equals(RawSRational, RawSRational) | Compares pair of `RawSRational`. |
| operator == | Indicates whether two objects of the same type are equal. |
| operator != | Indicates whether two objects of the same type are not equal. |

### Denominator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/denominator.md

#### RawSRational.Denominator property

Gets denominator.

```csharp
public int Denominator { get; }
```

##### Property Value

The denominator.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/equals.md

#### Equals(RawSRational, RawSRational)

Compares pair of `RawSRational`.

```csharp
public static bool Equals(RawSRational rational, RawSRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rational | RawSRational | Comparing item. |
| other | RawSRational | Other item. |

##### Return Value

`true` if objects are equal; otherwise `false`.

#### Equals(RawSRational)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(RawSRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | RawSRational | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *other* parameter; otherwise, `false`.

#### Equals(object)

Indicates whether the current object is equal to another object of the same type.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *obj* parameter; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/gethashcode.md

#### RawSRational.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### Numerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/numerator.md

#### RawSRational.Numerator property

Gets numerator.

```csharp
public int Numerator { get; }
```

##### Property Value

The numerator.

### op_Equality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/op_equality.md

#### RawSRational Equality operator

Indicates whether two objects of the same type are equal.

```csharp
public static bool operator ==(RawSRational left, RawSRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | RawSRational | The left object. |
| right | RawSRational | The rigt object. |

##### Return Value

True if the objects are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/op_inequality.md

#### RawSRational Inequality operator

Indicates whether two objects of the same type are not equal.

```csharp
public static bool operator !=(RawSRational left, RawSRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | RawSRational | The left object. |
| right | RawSRational | The rigt object. |

##### Return Value

True if the objects are not equal; otherwise, false.

### RawSRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/rawsrational.md

#### RawSRational constructor

Initializes a new instance of the `RawSRational` class.

```csharp
public RawSRational(int numerator, int denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | Int32 | The numerator. |
| denominator | Int32 | The denominator. |

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/tostring.md

#### RawSRational.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrational/value.md

#### RawSRational.Value property

Gets actual value represented as double.

```csharp
public double Value { get; }
```

##### Property Value

Double value.

### RawSRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrationaltag.md

#### RawSRationalTag class

Represents a Raw SRational tag.

```csharp
public sealed class RawSRationalTag : RawArrayTag<RawSRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawSRationalTag(uint, RawSRational[]) | Initializes a new instance of the `RawSRationalTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrationaltag/equals.md

#### RawSRationalTag.Equals method

Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object |  |

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrationaltag/gethashcode.md

#### RawSRationalTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawSRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsrationaltag/rawsrationaltag.md

#### RawSRationalTag constructor

Initializes a new instance of the `RawSRationalTag` class.

```csharp
public RawSRationalTag(uint tagID, RawSRational[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | RawSRational[] | The value. |

### RawSShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsshorttag.md

#### RawSShortTag class

Represents a Raw SShort tag.

```csharp
public sealed class RawSShortTag : RawArrayTag<short>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawSShortTag(uint, short[]) | Initializes a new instance of the `RawSShortTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsshorttag/equals.md

#### RawSShortTag.Equals method

Equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object |  |

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsshorttag/gethashcode.md

#### RawSShortTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawSShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawsshorttag/rawsshorttag.md

#### RawSShortTag constructor

Initializes a new instance of the `RawSShortTag` class.

```csharp
public RawSShortTag(uint tagID, short[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Int16[] | The value. |

### RawTypePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawtypepackage.md

#### RawTypePackage class

Represents a metadata package containing image-specific file format information.

```csharp
public class RawTypePackage : FileTypePackage
```

#### Properties

| Name | Description |
| --- | --- |
| ByteOrder { get; } | Gets the byte-order of the image. Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |
| Count { get; } | Gets the number of metadata properties. |
| Extension { get; } | Gets the file extension. |
| FileFormat { get; } | Gets the file format. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MimeType { get; } | Gets the MIME type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ByteOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawtypepackage/byteorder.md

#### RawTypePackage.ByteOrder property

Gets the byte-order of the image. Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information.

```csharp
public ByteOrder ByteOrder { get; }
```

##### Property Value

The byte-order value.

### RawUndefinedTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawundefinedtag.md

#### RawUndefinedTag class

Represents a Raw tag with the Undefined type.

```csharp
public sealed class RawUndefinedTag : RawArrayTag<byte>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawUndefinedTag(uint, byte[]) | Initializes a new instance of the `RawUndefinedTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) |  |
| override GetHashCode() |  |

### RawUndefinedTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/rawundefinedtag/rawundefinedtag.md

#### RawUndefinedTag constructor

Initializes a new instance of the `RawUndefinedTag` class.

```csharp
public RawUndefinedTag(uint tagID, byte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Byte[] | The value. |

### TiffArrayTagT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffarraytag-1.md

#### TiffArrayTag&lt;T&gt; class

Represents an array-based TIFF tag.

```csharp
public abstract class TiffArrayTag<T> : TiffTag
```

| Parameter | Description |
| --- | --- |
| T | The type of array values. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TagValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffarraytag-1/tagvalue.md

#### TiffArrayTag&lt;T&gt;.TagValue property

Gets the tag value.

```csharp
public T[] TagValue { get; }
```

##### Property Value

The tag value.

### TiffAsciiTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffasciitag.md

#### TiffAsciiTag class

Represents a TIFF ASCII tag.

```csharp
public sealed class TiffAsciiTag : TiffTag
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffAsciiTag(TiffTagID, string) | Initializes a new instance of the `TiffAsciiTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TagValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffasciitag/tagvalue.md

#### TiffAsciiTag.TagValue property

Gets the tag value.

```csharp
public string TagValue { get; }
```

##### Property Value

The tag value.

### TiffAsciiTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffasciitag/tiffasciitag.md

#### TiffAsciiTag constructor

Initializes a new instance of the `TiffAsciiTag` class.

```csharp
public TiffAsciiTag(TiffTagID tagID, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | String | The value. |

### TiffByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffbytetag.md

#### TiffByteTag class

Represents a Byte tag.

```csharp
public sealed class TiffByteTag : TiffArrayTag<byte>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffByteTag(TiffTagID, byte[]) | Initializes a new instance of the `TiffByteTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffbytetag/tiffbytetag.md

#### TiffByteTag constructor

Initializes a new instance of the `TiffByteTag` class.

```csharp
public TiffByteTag(TiffTagID tagID, byte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Byte[] | The value. |

### TiffDoubleTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffdoubletag.md

#### TiffDoubleTag class

Represents a TIFF Double tag.

```csharp
public sealed class TiffDoubleTag : TiffArrayTag<double>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffDoubleTag(TiffTagID, double[]) | Initializes a new instance of the `TiffDoubleTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffDoubleTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffdoubletag/tiffdoubletag.md

#### TiffDoubleTag constructor

Initializes a new instance of the `TiffDoubleTag` class.

```csharp
public TiffDoubleTag(TiffTagID tagID, double[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Double[] | The value. |

### TiffFloatTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifffloattag.md

#### TiffFloatTag class

Represents a TIFF float tag.

```csharp
public sealed class TiffFloatTag : TiffArrayTag<float>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffFloatTag(TiffTagID, float[]) | Initializes a new instance of the `TiffFloatTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffFloatTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifffloattag/tifffloattag.md

#### TiffFloatTag constructor

Initializes a new instance of the `TiffFloatTag` class.

```csharp
public TiffFloatTag(TiffTagID tagID, float[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Single[] | The value. |

### TiffLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifflongtag.md

#### TiffLongTag class

Represents a TIFF Long tag.

```csharp
public sealed class TiffLongTag : TiffArrayTag<uint>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffLongTag(TiffTagID, uint[]) | Initializes a new instance of the `TiffLongTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifflongtag/tifflongtag.md

#### TiffLongTag constructor

Initializes a new instance of the `TiffLongTag` class.

```csharp
public TiffLongTag(TiffTagID tagID, uint[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | UInt32[] | The value. |

### TiffRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational.md

#### TiffRational class

Represents a rational number.

```csharp
public sealed class TiffRational : IEquatable<TiffRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffRational(uint, uint) | Initializes a new instance of the `TiffRational` class. |

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Gets the denominator. |
| Numerator { get; } | Gets the numerator. |
| Value { get; } | Gets the rational value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether the current object is equal to another object of the same type. |
| Equals(TiffRational) | Indicates whether the current object is equal to another object of the same type. |
| override GetHashCode() | Returns a hash code for this instance. |
| override ToString() | Returns a String that represents this instance. |
| static Equals(TiffRational, TiffRational) | Compares a pair of `TiffRational` numbers. |
| operator == | Indicates whether two objects of the same type are equal. |
| operator != | Indicates whether two objects of the same type are not equal. |

### Denominator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/denominator.md

#### TiffRational.Denominator property

Gets the denominator.

```csharp
public uint Denominator { get; }
```

##### Property Value

The denominator.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/equals.md

#### Equals(TiffRational, TiffRational)

Compares a pair of `TiffRational` numbers.

```csharp
public static bool Equals(TiffRational rational, TiffRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffRational | A rational number. |
| other | TiffRational | Another rational number. |

##### Return Value

`true` if the objects are equal; otherwise, `false`.

#### Equals(TiffRational)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(TiffRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffRational | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *other* parameter; otherwise, `false`.

#### Equals(object)

Indicates whether the current object is equal to another object of the same type.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *obj* parameter; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/gethashcode.md

#### TiffRational.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### Numerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/numerator.md

#### TiffRational.Numerator property

Gets the numerator.

```csharp
public uint Numerator { get; }
```

##### Property Value

The numerator.

### op_Equality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/op_equality.md

#### TiffRational Equality operator

Indicates whether two objects of the same type are equal.

```csharp
public static bool operator ==(TiffRational left, TiffRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The rigt object. |

##### Return Value

True if the objects are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/op_inequality.md

#### TiffRational Inequality operator

Indicates whether two objects of the same type are not equal.

```csharp
public static bool operator !=(TiffRational left, TiffRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The right object. |

##### Return Value

True if the objects are not equal; otherwise, false.

### TiffRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/tiffrational.md

#### TiffRational constructor

Initializes a new instance of the `TiffRational` class.

```csharp
public TiffRational(uint numerator, uint denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | UInt32 | The numerator. |
| denominator | UInt32 | The denominator. |

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/tostring.md

#### TiffRational.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrational/value.md

#### TiffRational.Value property

Gets the rational value.

```csharp
public double Value { get; }
```

##### Property Value

The rational value.

### TiffRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrationaltag.md

#### TiffRationalTag class

Represents a TIFF Rational tag.

```csharp
public sealed class TiffRationalTag : TiffArrayTag<TiffRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffRationalTag(TiffTagID, TiffRational[]) | Initializes a new instance of the `TiffRationalTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffrationaltag/tiffrationaltag.md

#### TiffRationalTag constructor

Initializes a new instance of the `TiffRationalTag` class.

```csharp
public TiffRationalTag(TiffTagID tagID, TiffRational[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffRational[] | The value. |

### TiffSByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsbytetag.md

#### TiffSByteTag class

Represents a TIFF SByte tag.

```csharp
public sealed class TiffSByteTag : TiffArrayTag<sbyte>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSByteTag(TiffTagID, sbyte[]) | Initializes a new instance of the `TiffSByteTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffSByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsbytetag/tiffsbytetag.md

#### TiffSByteTag constructor

Initializes a new instance of the `TiffSByteTag` class.

```csharp
public TiffSByteTag(TiffTagID tagID, sbyte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | SByte[] | The value. |

### TiffShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffshorttag.md

#### TiffShortTag class

Represents a TIFF Short tag.

```csharp
public sealed class TiffShortTag : TiffArrayTag<ushort>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffShortTag(TiffTagID, ushort[]) | Initializes a new instance of the `TiffShortTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffshorttag/tiffshorttag.md

#### TiffShortTag constructor

Initializes a new instance of the `TiffShortTag` class.

```csharp
public TiffShortTag(TiffTagID tagID, ushort[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | UInt16[] | The value. |

### TiffSLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffslongtag.md

#### TiffSLongTag class

Represents a TIFF SLong tag.

```csharp
public sealed class TiffSLongTag : TiffArrayTag<int>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSLongTag(TiffTagID, int[]) | Initializes a new instance of the `TiffSLongTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffSLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffslongtag/tiffslongtag.md

#### TiffSLongTag constructor

Initializes a new instance of the `TiffSLongTag` class.

```csharp
public TiffSLongTag(TiffTagID tagID, int[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Int32[] | The value. |

### TiffSRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational.md

#### TiffSRational class

Represents signed rational number.

```csharp
public sealed class TiffSRational : IEquatable<TiffSRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSRational(int, int) | Initializes a new instance of the `TiffSRational` class. |

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Gets denominator. |
| Numerator { get; } | Gets numerator. |
| Value { get; } | Gets actual value represented as double. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether the current object is equal to another object of the same type. |
| Equals(TiffSRational) | Indicates whether the current object is equal to another object of the same type. |
| override GetHashCode() | Returns a hash code for this instance. |
| override ToString() | Returns a String that represents this instance. |
| static Equals(TiffSRational, TiffSRational) | Compares pair of `TiffSRational`. |
| operator == | Indicates whether two objects of the same type are equal. |
| operator != | Indicates whether two objects of the same type are not equal. |

### Denominator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/denominator.md

#### TiffSRational.Denominator property

Gets denominator.

```csharp
public int Denominator { get; }
```

##### Property Value

The denominator.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/equals.md

#### Equals(TiffSRational, TiffSRational)

Compares pair of `TiffSRational`.

```csharp
public static bool Equals(TiffSRational rational, TiffSRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffSRational | Comparing item. |
| other | TiffSRational | Other item. |

##### Return Value

`true` if objects are equal; otherwise `false`.

#### Equals(TiffSRational)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(TiffSRational other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffSRational | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *other* parameter; otherwise, `false`.

#### Equals(object)

Indicates whether the current object is equal to another object of the same type.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | An object to compare with this object. |

##### Return Value

`true` if the current object is equal to the *obj* parameter; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/gethashcode.md

#### TiffSRational.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### Numerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/numerator.md

#### TiffSRational.Numerator property

Gets numerator.

```csharp
public int Numerator { get; }
```

##### Property Value

The numerator.

### op_Equality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/op_equality.md

#### TiffSRational Equality operator

Indicates whether two objects of the same type are equal.

```csharp
public static bool operator ==(TiffSRational left, TiffSRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

##### Return Value

True if the objects are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/op_inequality.md

#### TiffSRational Inequality operator

Indicates whether two objects of the same type are not equal.

```csharp
public static bool operator !=(TiffSRational left, TiffSRational right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

##### Return Value

True if the objects are not equal; otherwise, false.

### TiffSRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/tiffsrational.md

#### TiffSRational constructor

Initializes a new instance of the `TiffSRational` class.

```csharp
public TiffSRational(int numerator, int denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | Int32 | The numerator. |
| denominator | Int32 | The denominator. |

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/tostring.md

#### TiffSRational.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrational/value.md

#### TiffSRational.Value property

Gets actual value represented as double.

```csharp
public double Value { get; }
```

##### Property Value

Double value.

### TiffSRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrationaltag.md

#### TiffSRationalTag class

Represents a TIFF SRational tag.

```csharp
public sealed class TiffSRationalTag : TiffArrayTag<TiffSRational>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSRationalTag(TiffTagID, TiffSRational[]) | Initializes a new instance of the `TiffSRationalTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffSRationalTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsrationaltag/tiffsrationaltag.md

#### TiffSRationalTag constructor

Initializes a new instance of the `TiffSRationalTag` class.

```csharp
public TiffSRationalTag(TiffTagID tagID, TiffSRational[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffSRational[] | The value. |

### TiffSShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsshorttag.md

#### TiffSShortTag class

Represents a TIFF SShort tag.

```csharp
public sealed class TiffSShortTag : TiffArrayTag<short>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSShortTag(TiffTagID, short[]) | Initializes a new instance of the `TiffSShortTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffSShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffsshorttag/tiffsshorttag.md

#### TiffSShortTag constructor

Initializes a new instance of the `TiffSShortTag` class.

```csharp
public TiffSShortTag(TiffTagID tagID, short[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Int16[] | The value. |

### TiffTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifftag.md

#### TiffTag class

Represents a TIFF tag.

```csharp
public abstract class TiffTag : MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| Value { get; } | Gets the property value. |

### TagID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifftag/tagid.md

#### TiffTag.TagID property

Gets the tag id.

```csharp
public TiffTagID TagID { get; }
```

##### Property Value

The tag id.

### TagType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifftag/tagtype.md

#### TiffTag.TagType property

Gets the type of the tag.

```csharp
public TiffTagType TagType { get; }
```

##### Property Value

The tag type.

### TiffTagID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifftagid.md

#### TiffTagID enumeration

Defines ids of TIFF tags.

```csharp
public enum TiffTagID : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| GpsVersionID | `0` | Indicates the version of GPSInfoIFD. |
| GpsLatitudeRef | `1` | Indicates whether the latitude is north or south latitude. |
| GpsLatitude | `2` | Indicates the latitude. |
| GpsLongitudeRef | `3` | Indicates whether the longitude is east or west longitude. |
| GpsLongitude | `4` | Indicates the longitude. |
| GpsAltitudeRef | `5` | Indicates the altitude used as the reference altitude. |
| GpsAltitude | `6` | Indicates the altitude based on the reference in GPSAltitudeRef. |
| GpsTimeStamp | `7` | Indicates the time as UTC (Coordinated Universal Time). |
| GpsSatellites | `8` | ndicates the GPS satellites used for measurements. |
| GpsStatus | `9` | Indicates the status of the GPS receiver when the image is recorded. |
| GpsMeasureMode | `10` | Indicates the GPS measurement mode. |
| GpsDop | `11` | Indicates the GPS DOP (data degree of precision). |
| GpsSpeedRef | `12` | Indicates the unit used to express the GPS receiver speed of movement |
| GpsSpeed | `13` | Indicates the speed of GPS receiver movement. |
| GpsTrackRef | `14` | Indicates the reference for giving the direction of GPS receiver movement. |
| GpsTrack | `15` | Indicates the direction of GPS receiver movement. |
| GpsImgDirectionRef | `16` | Indicates the reference for giving the direction of the image when it is captured. |
| GpsImgDirection | `17` | Indicates the direction of the image when it was captured. |
| GpsMapDatum | `18` | Indicates the geodetic survey data used by the GPS receiver. |
| GpsDestLatitudeRef | `19` | Indicates whether the latitude of the destination point is north or south latitude. |
| GpsDestLatitude | `20` | Indicates the latitude of the destination point. |
| GpsDestLongitudeRef | `21` | Indicates whether the longitude of the destination point is east or west longitude. |
| GpsDestLongitude | `22` | Indicates the longitude of the destination point. |
| GpsDestBearingRef | `23` | Indicates the reference used for giving the bearing to the destination point. |
| GpsDestBearing | `24` | Indicates the bearing to the destination point. |
| GpsDestDistanceRef | `25` | Indicates the unit used to express the distance to the destination point. |
| GpsDestDistance | `26` | Indicates the distance to the destination point. |
| GpsProcessingMethod | `27` | A character string recording the name of the method used for location finding. |
| GpsAreaInformation | `28` | A character string recording the name of the GPS area. |
| GpsDateStamp | `29` | A character string recording date and time information relative to UTC (Coordinated Universal Time). |
| GpsDifferential | `30` | Indicates whether differential correction is applied to the GPS receiver. |
| GpsHPositioningError | `31` | This tag indicates horizontal positioning errors in meters. |
| NewSubfileType | `254` | A general indication of the kind of data contained in this sub-file. |
| SubfileType | `255` | A general indication of the kind of data contained in this subfile. This field is deprecated. The NewSubfileType field should be used instead |
| ImageWidth | `256` | The number of columns in the image, i.e., the number of pixels per scan line. |
| ImageLength | `257` | The number of rows (sometimes described as scan lines) in the image. |
| BitsPerSample | `258` | Number of bits per component. |
| Compression | `259` | Compression scheme used on the image data. |
| PhotometricInterpretation | `262` | The color space of the image data. |
| Threshholding | `263` | For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels. |
| CellWidth | `264` | The width of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| CellLength | `265` | The length of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| FillOrder | `266` | The logical order of bits within a byte. |
| DocumentName | `269` | The name of the document from which this image was scanned. |
| ImageDescription | `270` | A string that describes the subject of the image. |
| Make | `271` | The scanner manufacturer. |
| Model | `272` | The scanner model name or number. |
| StripOffsets | `273` | For each strip, the byte offset of that strip. |
| Orientation | `274` | The orientation of the image with respect to the rows and columns. |
| SamplesPerPixel | `277` | The number of components per pixel. |
| RowsPerStrip | `278` | The number of rows per strip. |
| StripByteCounts | `279` | For each strip, the number of bytes in the strip after compression. |
| MinSampleValue | `280` | The minimum component value used. |
| MaxSampleValue | `281` | The maximum component value used. |
| XResolution | `282` | The number of pixels per ResolutionUnit in the ImageWidth direction. |
| YResolution | `283` | The number of pixels per ResolutionUnit in the ImageLength direction. |
| PlanarConfiguration | `284` | How the components of each pixel are stored. |
| PageName | `285` | The name of the page from which this image was scanned. |
| XPosition | `286` | X position of the image. |
| YPosition | `287` | Y position of the image. |
| FreeOffsets | `288` | For each string of contiguous unused bytes in a TIFF file, the byte offset of the string. |
| FreeByteCounts | `289` | For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string. |
| GrayResponseUnit | `290` | The precision of the information contained in the GrayResponseCurve. |
| GrayResponseCurve | `291` | For grayscale data, the optical density of each possible pixel value. |
| T4Options | `292` | T4-encoding options. |
| T6Options | `293` | T6-encoding options. |
| ResolutionUnit | `296` | The unit of measurement for XResolution and YResolution. |
| PageNumber | `297` | The page number of the page from which this image was scanned. |
| TransferFunction | `301` | Describes a transfer function for the image in tabular style. Pixel components can be gamma-compensated, companded, non-uniformly quantized, or coded in some other way. The TransferFunction maps the pixel components from a non-linear BitsPerSample (e.g. 8-bit) form into a 16-bit linear form without a perceptible loss of accuracy. |
| Software | `305` | Name and version number of the software package(s) used to create the image. |
| DateTime | `306` | Date and time of image creation. |
| Artist | `315` | Person who created the image. |
| HostComputer | `316` | The computer and/or operating system in use at the time of image creation. |
| Predictor | `317` | This section defines a Predictor that greatly improves compression ratios for some images. |
| WhitePoint | `318` | The chromaticity of the white point of the image. |
| PrimaryChromaticities | `319` | The chromaticities of the primaries of the image. |
| ColorMap | `320` | A color map for palette color images. |
| HalftoneHints | `321` | The purpose of the HalftoneHints field is to convey to the halftone function the range of gray levels within a colorimetrically-specified image that should retain tonal detail. |
| TileWidth | `322` | The tile width in pixels. This is the number of columns in each tile. |
| TileLength | `323` | The tile length (height) in pixels. This is the number of rows in each tile. |
| TileOffsets | `324` | For each tile, the byte offset of that tile, as compressed and stored on disk. The offset is specified with respect to the beginning of the TIFF file. Note that this implies that each tile has a location independent of the locations of other tiles. |
| TileByteCounts | `325` | For each tile, the number of (compressed) bytes in that tile. |
| InkSet | `332` | The set of inks used in a separated (PhotometricInterpretation=5) image. |
| InkNames | `333` | The name of each ink used in a separated (PhotometricInterpretation=5) image, written as a list of concatenated, NUL-terminated ASCII strings. |
| NumberOfInks | `334` | The number of inks. Usually equal to SamplesPerPixel, unless there are extra samples. |
| DotRange | `336` | The component values that correspond to a 0% dot and 100% dot. DotRange[0] corresponds to a 0% dot, and DotRange[1] corresponds to a 100% dot. |
| ExtraSamples | `338` | Description of extra components. |
| SampleFormat | `339` | This field specifies how to interpret each data sample in a pixel. |
| SMinSampleValue | `340` | This field specifies the minimum sample value. |
| SMaxSampleValue | `341` | This new field specifies the maximum sample value. |
| TransferRange | `342` | Expands the range of the TransferFunction. |
| JpegProc | `512` | This Field indicates the JPEG process used to produce the compressed data. |
| JpegInterchangeFormat | `513` | This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file. |
| JpegInterchangeFormatLength | `514` | This Field indicates the length in bytes of the JPEG interchange format bitstream |
| JpegRestartInterval | `515` | This Field indicates the length of the restart interval used in the compressed image data. |
| JpegLosslessPredictors | `517` | This Field points to a list of lossless predictor-selection values, one per component. |
| JpegPointTransforms | `518` | This Field points to a list of point transform values, one per component. |
| JpegQTables | `519` | This Field points to a list of offsets to the quantization tables, one per component. |
| JpegDCTables | `520` | This Field points to a list of offsets to the DC Huffman tables or the lossless Huffman tables, one per component. |
| JpegACTables | `521` | This Field points to a list of offsets to the Huffman AC tables, one per component. |
| YCbCrCoefficients | `529` | The matrix cofficients for transformation from RGB to YCbCr image data. |
| YCbCrSubSampling | `530` | The sampling ratio of chrominance components in relation to the luminance component. |
| YCbCrPositioning | `531` | Specifies the positioning of subsampled chrominance components relative to luminance samples. |
| ReferenceBlackWhite | `532` | Specifies a pair of headroom and footroom image data values (codes) for each pixel component. |
| Copyright | `33432` | Copyright notice. |
| UserComment | `37510` | Keywords or comments on the image; complements ImageDescription. |
| Xmp | `700` | Pointer to the XMP metadata. |
| ImageID | `32781` | OPI-related. |
| Iptc | `33723` | IPTC (International Press Telecommunications Council) metadata. Often times, the data type is incorrectly specified as LONG. |
| Photoshop | `34377` | Collection of Photoshop 'Image Resource Blocks'. |
| ImageLayer | `34732` | Image layer. |
| IccProfile | `34675` | Color profile data. |
| ExifIfd | `34665` | Pointer to collection of all EXIF Metadata. EXIF uses field names rather than tags to indicate the field content. |
| GpsIfd | `34853` | Pointer to GPS data. |
| Makernotes | `37500` | Pointer to makernotes data. |
| InteroperabilityIfd | `40965` | Exif-related Interoperability IFD. |
| CameraOwnerName | `42032` | Camera owner name as ASCII string. |
| BodySerialNumber | `42033` | Camera body serial number as ASCII string. |
| CfaPattern | `41730` | ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. It does not apply to all sensing methods. |
| ExifVersion | `36864` | The version of the EXIF standard supported. |
| ComponentsConfiguration | `37121` | Information specific to the compressed data. The channels of each component are arranged in order from the 1st component to the 4th. |
| FlashpixVersion | `40960` | The Flashpix format version supported by a FPXR file. If the FPXR function supports Flashpix format Ver. 1.0, this is indicated similarly to ExifVersion by recording "0100" as 4-byte ASCII. |
| ColorSpace | `40961` | The color space information tag (ColorSpace) is always recorded as the color space specifier. Normally sRGB (=1) is used to define the color space based on the PC monitor conditions and environment. If a color space other than sRGB is used, Uncalibrated (=FFFF.H) is set. |
| PixelXDimension | `40962` | Information specific to compressed data. When a compressed file is recorded, the valid width of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker. |
| PixelYDimension | `40963` | Information specific to compressed data. When a compressed file is recorded, the valid height of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker. |
| SceneCaptureType | `41990` | This tag indicates the type of scene that was shot. It may also be used to record the mode in which the image was shot. |
| Gamma | `42240` | Indicates the value of coefficient gamma. |
| CompressedBitsPerPixel | `37122` | Information specific to compressed data. The compression mode used for a compressed image is indicated in unit bits per pixel. |
| RelatedSoundFile | `40964` | This tag is used to record the name of an audio file related to the image data. The only relational information recorded here is the Exif audio file name and extension (an ASCII string consisting of 8 characters + '.' + 3 characters). |
| DateTimeOriginal | `36867` | The date and time when the original image data was generated. For a DSC the date and time the picture was taken are recorded. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character. |
| DateTimeDigitized | `36868` | The date and time when the image was stored as digital data. If, for example, an image was captured by DSC and at the same time the file was recorded, then the DateTimeOriginal and DateTimeDigitized will have the same contents. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character. |
| OffsetTime | `36880` | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-". |
| OffsetTimeOriginal | `36881` | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-". |
| OffsetTimeDigitized | `36882` | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-". |
| SubsecTime | `37520` | A tag used to record fractions of seconds for the DateTime tag. |
| SubsecTimeOriginal | `37521` | A tag used to record fractions of seconds for the DateTimeOriginal tag. |
| SubsecTimeDigitized | `37522` | A tag used to record fractions of seconds for the DateTimeDigitized tag. |
| ExposureTime | `33434` | Exposure time, given in seconds (sec). |
| FNumber | `33437` | The F number. |
| ExposureProgram | `34850` | The class of the program used by the camera to set exposure when the picture is taken. |
| SpectralSensitivity | `34852` | Indicates the spectral sensitivity of each channel of the camera used. The tag value is an ASCII string compatible with the standard developed by the ASTM Technical committee. |
| PhotographicSensitivity | `34855` | This tag indicates the sensitivity of the camera or input device when the image was shot. |
| Oecf | `34856` | Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524. OECF is the relationship between the camera optical input and the image values. |
| SensitivityType | `34864` | The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag. Although it is an optional tag, it should be recorded when a PhotographicSensitivity tag is recorded. |
| StandardOutputSensitivity | `34865` | This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| RecommendedExposureIndex | `34866` | This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| IsoSpeed | `34867` | This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| ISOSpeedLatitudeYyy | `34868` | This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232. |
| ISOSpeedLatitudeZzz | `34869` | This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232. |
| ShutterSpeedValue | `37377` | Shutter speed. The unit is the APEX (Additive System of Photographic Exposure) setting. |
| ApertureValue | `37378` | The lens aperture. The unit is the APEX value. |
| BrightnessValue | `37379` | The value of brightness. The unit is the APEX value. |
| ExposureBiasValue | `37380` | The exposure bias. The unit is the APEX value. |
| MaxApertureValue | `37381` | The smallest F number of the lens. The unit is the APEX value. |
| SubjectDistance | `37382` | The distance to the subject, given in meters. |
| MeteringMode | `37383` | The metering mode. |
| LightSource | `37384` | The kind of light source. |
| Flash | `37385` | This tag indicates the status of flash when the image was shot. Bit 0 indicates the flash firing status, bits 1 and 2 indicate the flash return status, bits 3 and 4 indicate the flash mode, bit 5 indicates whether the flash function is present, and bit 6 indicates "red eye" mode. |
| SubjectArea | `37396` | This tag indicates the location and area of the main subject in the overall scene. |
| FocalLength | `37386` | The actual focal length of the lens, in mm. Conversion is not made to the focal length of a 35 mm film camera. |
| FlashEnergy | `41483` | Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS). |
| SpatialFrequencyResponse | `41484` | This tag records the camera or input device spatial frequency table and SFR values in the direction of image width, image height, and diagonal direction, as specified in ISO 12233. |
| FocalPlaneXResolution | `41486` | Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneYResolution | `41487` | Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneResolutionUnit | `41488` | Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. This value is the same as the ResolutionUnit. |
| SubjectLocation | `41492` | Indicates the location of the main subject in the scene. The value of this tag represents the pixel at the center of the main subject relative to the left edge, prior to rotation processing as per the Rotation tag. The first value indicates the X column number and second indicates the Y row number. |
| ExposureIndex | `41493` | Indicates the exposure index selected on the camera or input device at the time the image is captured. |
| SensingMethod | `41495` | Indicates the image sensor type on the camera or input device. |
| FileSource | `41728` | Indicates the image source. If a DSC recorded the image, this tag value always shall be set to 3. |
| SceneType | `41729` | Indicates the type of scene. If a DSC recorded the image, this tag value shall always be set to 1, indicating that the image was directly photographed. |
| CustomRendered | `41985` | This tag indicates the use of special processing on image data, such as rendering geared to output. |
| ExposureMode | `41986` | This tag indicates the exposure mode set when the image was shot. In auto-bracketing mode, the camera shoots a series of frames of the same scene at different exposure settings. |
| WhiteBalance | `41987` | This tag indicates the white balance mode set when the image was shot. |
| DigitalZoomRatio | `41988` | This tag indicates the digital zoom ratio when the image was shot. If the numerator of the recorded value is 0, this indicates that digital zoom was not used. |
| FocalLengthIn35mmFilm | `41989` | This tag indicates the equivalent focal length assuming a 35mm film camera, in mm. A value of 0 means the focal length is unknown. Note that this tag differs from the FocalLength tag. |
| GainControl | `41991` | This tag indicates the degree of overall image gain adjustment. |
| Contrast | `41992` | This tag indicates the direction of contrast processing applied by the camera when the image was shot. |
| Saturation | `41993` | This tag indicates the direction of saturation processing applied by the camera when the image was shot. |
| Sharpness | `41994` | This tag indicates the direction of sharpness processing applied by the camera when the image was shot. |
| DeviceSettingDescription | `41995` | This tag indicates information on the picture-taking conditions of a particular camera model. |
| SubjectDistanceRange | `41996` | This tag indicates the distance to the subject. |
| CompositeImage | `42080` | This tag indicates whether the recorded image is a composite image* or not. |
| SourceImageNumberOfCompositeImage | `42081` | This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image. |
| SourceExposureTimesOfCompositeImage | `42082` | For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image, such as respective exposure times of captured source images (tentatively recorded images). |
| Temperature | `37888` | Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. The unit is °C. |
| Humidity | `37889` | Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. The unit is %. |
| Pressure | `37890` | Pressure as the ambient situation at the shot, for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea. The unit is hPa. |
| WaterDepth | `37891` | Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. The unit is m. |
| Acceleration | `37892` | Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot. The unit is mGal (10-5 m/s2). |
| CameraElevationAngle | `37893` | Elevation/depression. angle of the orientation of the camera(imaging optical axis) as the ambient situation at the shot. The unit is degree(°). |
| ImageUniqueID | `42016` | This tag indicates an identifier assigned uniquely to each image. |
| LensSpecification | `42034` | This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length, and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography. |
| LensMake | `42035` | This tag records the lens manufacturer as an ASCII string. |
| LensModel | `42036` | This tag records the lens’s model name and model number as an ASCII string. |
| LensSerialNumber | `42037` | This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string. |

### TiffTagType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tifftagtype.md

#### TiffTagType enumeration

Represents the IFD data type.

```csharp
public enum TiffTagType : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Byte | `1` | An 8-bit unsigned integer. |
| Ascii | `2` | An 8-bit byte with a 7-bit ASCII character. |
| Short | `3` | A 16-bit unsigned integer. |
| Long | `4` | A 32-bit unsigned integer. |
| Rational | `5` | A pair of LONGs, numerator then denominator. |
| SByte | `6` | An 8-bit signed integer. |
| Undefined | `7` | An undefined 8-bit byte. |
| SShort | `8` | A 16-bit signed integer. |
| SLong | `9` | A 32-bit signed integer. |
| SRational | `10` | A pair of SLONGs, numerator then denominator. |
| Float | `11` | A 4-byte IEEE floating point value. |
| Double | `12` | An 8-byte IEEE floating point value. |
| SubIfd | `13` | A 4-byte long offset value |

### TiffUndefinedTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffundefinedtag.md

#### TiffUndefinedTag class

Represents a TIFF tag with the Undefined type.

```csharp
public sealed class TiffUndefinedTag : TiffArrayTag<byte>
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffUndefinedTag(TiffTagID, byte[]) | Initializes a new instance of the `TiffUndefinedTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

### TiffUndefinedTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.image/tiffundefinedtag/tiffundefinedtag.md

#### TiffUndefinedTag constructor

Initializes a new instance of the `TiffUndefinedTag` class.

```csharp
public TiffUndefinedTag(TiffTagID tagID, byte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | Byte[] | The value. |

### GroupDocs.Metadata.Formats.Mpeg
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg.md

The namespace provides functionality allowing users to work with metadata of various MPEG standards.

#### Classes

| Class | Description |
| --- | --- |
| MpegAudioPackage | Represents MPEG audio metadata. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| MpegAudioVersion | Represents a particular MPEG standard. |
| MpegChannelMode | Defines MPEG audio channel modes. |
| MpegEmphasis | Defines MPEG emphasis types. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### MpegAudioPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage.md

#### MpegAudioPackage class

Represents MPEG audio metadata.

```csharp
public sealed class MpegAudioPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| MpegAudioPackage() | Initializes a new instance of the `MpegAudioPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Bitrate { get; } | Gets the bitrate. |
| ChannelMode { get; } | Gets the channel mode. |
| Copyright { get; } | Gets the copyright bit. |
| Count { get; } | Gets the number of metadata properties. |
| Emphasis { get; } | Gets the emphasis. |
| Frequency { get; } | Gets the frequency. |
| HeaderPosition { get; } | Gets the header offset. |
| IsOriginal { get; } | Gets the original bit. |
| IsProtected { get; } | Gets `true` if protected. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Layer { get; } | Gets the layer description. For an MP3 audio it is '3'. |
| MetadataType { get; } | Gets the metadata type. |
| ModeExtensionBits { get; } | Gets the mode extension bits. |
| MpegAudioVersion { get; } | Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc. |
| PaddingBit { get; } | Gets the padding bit. |
| PrivateBit { get; } | Gets a value indicating whether [private bit]. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to read MPEG audio metadata from an MP3 file.

```csharp
using (Metadata metadata = new Metadata(Constants.MP3WithID3V2))
{
    var root = metadata.GetRootPackage<MP3RootPackage>();

    Console.WriteLine(root.MpegAudioPackage.Bitrate);
    Console.WriteLine(root.MpegAudioPackage.ChannelMode);
    Console.WriteLine(root.MpegAudioPackage.Emphasis);
    Console.WriteLine(root.MpegAudioPackage.Frequency);
    Console.WriteLine(root.MpegAudioPackage.HeaderPosition);
    Console.WriteLine(root.MpegAudioPackage.Layer);

    // ...
}
```

### Bitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/bitrate.md

#### MpegAudioPackage.Bitrate property

Gets the bitrate.

```csharp
public int Bitrate { get; }
```

##### Property Value

The bitrate.

### ChannelMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/channelmode.md

#### MpegAudioPackage.ChannelMode property

Gets the channel mode.

```csharp
public MpegChannelMode ChannelMode { get; }
```

##### Property Value

The channel mode.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/copyright.md

#### MpegAudioPackage.Copyright property

Gets the copyright bit.

```csharp
public bool Copyright { get; }
```

##### Property Value

`true` if copyright; otherwise, `false`.

### Emphasis
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/emphasis.md

#### MpegAudioPackage.Emphasis property

Gets the emphasis.

```csharp
public MpegEmphasis Emphasis { get; }
```

##### Property Value

The emphasis.

### Frequency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/frequency.md

#### MpegAudioPackage.Frequency property

Gets the frequency.

```csharp
public int Frequency { get; }
```

##### Property Value

The frequency.

### HeaderPosition
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/headerposition.md

#### MpegAudioPackage.HeaderPosition property

Gets the header offset.

```csharp
public long HeaderPosition { get; }
```

##### Property Value

The header offset.

### IsOriginal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/isoriginal.md

#### MpegAudioPackage.IsOriginal property

Gets the original bit.

```csharp
public bool IsOriginal { get; }
```

##### Property Value

`true` if audio is original; otherwise, `false`.

### IsProtected
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/isprotected.md

#### MpegAudioPackage.IsProtected property

Gets `true` if protected.

```csharp
public bool IsProtected { get; }
```

##### Property Value

`true` if is protected; otherwise, `false`.

### Layer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/layer.md

#### MpegAudioPackage.Layer property

Gets the layer description. For an MP3 audio it is '3'.

```csharp
public int Layer { get; }
```

##### Property Value

The layer description.

### ModeExtensionBits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/modeextensionbits.md

#### MpegAudioPackage.ModeExtensionBits property

Gets the mode extension bits.

```csharp
public int ModeExtensionBits { get; }
```

##### Property Value

The mode extension bits.

### MpegAudioPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/mpegaudiopackage.md

#### MpegAudioPackage constructor

Initializes a new instance of the `MpegAudioPackage` class.

```csharp
public MpegAudioPackage()
```

### MpegAudioVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/mpegaudioversion.md

#### MpegAudioPackage.MpegAudioVersion property

Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc.

```csharp
public MpegAudioVersion MpegAudioVersion { get; }
```

##### Property Value

The MPEG audio version.

### PaddingBit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/paddingbit.md

#### MpegAudioPackage.PaddingBit property

Gets the padding bit.

```csharp
public int PaddingBit { get; }
```

##### Property Value

The padding bit.

### PrivateBit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/privatebit.md

#### MpegAudioPackage.PrivateBit property

Gets a value indicating whether [private bit].

```csharp
public bool PrivateBit { get; }
```

##### Property Value

`true` if [private bit]; otherwise, `false`.

### MpegAudioVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegaudioversion.md

#### MpegAudioVersion enumeration

Represents a particular MPEG standard.

```csharp
public enum MpegAudioVersion
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Mpeg25 | `0` | The MPEG 2.5 standard. |
| Mpeg2 | `2` | The MPEG 2 standard. |
| Mpeg1 | `3` | The MPEG 1 standard. |

### MpegChannelMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegchannelmode.md

#### MpegChannelMode enumeration

Defines MPEG audio channel modes.

```csharp
public enum MpegChannelMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Stereo | `0` | Stereo mode. |
| JointStereo | `1` | Joint stereo mode. |
| DualChannel | `2` | Dual channel mode. |
| Mono | `3` | Mono mode. |

### MpegEmphasis
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.mpeg/mpegemphasis.md

#### MpegEmphasis enumeration

Defines MPEG emphasis types.

```csharp
public enum MpegEmphasis
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No emphasis indication. |
| Ms5015 | `1` | 50/15 ms. |
| Reserved | `2` | Reserved. |
| CcitJ17 | `3` | CCIT J.17. |

### GroupDocs.Metadata.Formats.Peer2Peer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer.md

The namespace contains classes intended to work with different formats based on the peer2peer protocol.

#### Classes

| Class | Description |
| --- | --- |
| TorrentPackage | Represents torrent descriptor file metadata. Please find more information at [https://en.wikipedia.org/wiki/Torrent_file](https://en.wikipedia.org/wiki/Torrent_file). |
| TorrentRootPackage | Represents the root package intended to work with metadata of a TORRENT file. |
| TorrentSharedFilePackage | Represents shared file information. Contains detailed info about each file in a torrent distribution. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### TorrentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage.md

#### TorrentPackage class

Represents torrent descriptor file metadata. Please find more information at [https://en.wikipedia.org/wiki/Torrent_file](https://en.wikipedia.org/wiki/Torrent_file).

```csharp
public sealed class TorrentPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Announce { get; set; } | Gets or sets the URL of the tracker. |
| Comment { get; set; } | Gets or sets the author's comment. |
| Count { get; } | Gets the number of metadata properties. |
| CreatedBy { get; set; } | Gets or sets the name and version of the program used to create the torrent. |
| CreationDate { get; set; } | Gets or sets the creation date of the torrent. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PieceLength { get; } | Gets the number of bytes in each piece. For more information please see . |
| Pieces { get; } | Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SharedFiles { get; } | Gets an array containing shared file information entries. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Announce
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/announce.md

#### TorrentPackage.Announce property

Gets or sets the URL of the tracker.

```csharp
public string Announce { get; set; }
```

##### Property Value

The URL of the tracker.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/comment.md

#### TorrentPackage.Comment property

Gets or sets the author's comment.

```csharp
public string Comment { get; set; }
```

##### Property Value

The author's comment.

### CreatedBy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/createdby.md

#### TorrentPackage.CreatedBy property

Gets or sets the name and version of the program used to create the torrent.

```csharp
public string CreatedBy { get; set; }
```

##### Property Value

The name and version of the program used to create the torrent.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/creationdate.md

#### TorrentPackage.CreationDate property

Gets or sets the creation date of the torrent.

```csharp
public DateTime? CreationDate { get; set; }
```

##### Property Value

The creation date of the torrent.

### PieceLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/piecelength.md

#### TorrentPackage.PieceLength property

Gets the number of bytes in each piece. For more information please see .

```csharp
public long PieceLength { get; }
```

##### Property Value

The number of bytes in each piece.

### Pieces
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/pieces.md

#### TorrentPackage.Pieces property

Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

```csharp
public byte[] Pieces { get; }
```

##### Property Value

A byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

### SharedFiles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentpackage/sharedfiles.md

#### TorrentPackage.SharedFiles property

Gets an array containing shared file information entries.

```csharp
public TorrentSharedFilePackage[] SharedFiles { get; }
```

##### Property Value

An array containing shared file information entries.

### TorrentRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentrootpackage.md

#### TorrentRootPackage class

Represents the root package intended to work with metadata of a TORRENT file.

```csharp
public class TorrentRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TorrentPackage { get; } | Gets the TORRENT file metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows how to read metadata of a TORRENT file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputTorrent))
{
    var root = metadata.GetRootPackage<TorrentRootPackage>();

    Console.WriteLine(root.TorrentPackage.Announce);
    Console.WriteLine(root.TorrentPackage.Comment);
    Console.WriteLine(root.TorrentPackage.CreatedBy);
    Console.WriteLine(root.TorrentPackage.CreationDate);
    foreach (var file in root.TorrentPackage.SharedFiles)
    {
        Console.WriteLine(file.Name);
        Console.WriteLine(file.Length);
    }

    // ...
}
```

### TorrentPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/torrentpackage.md

#### TorrentRootPackage.TorrentPackage property

Gets the TORRENT file metadata package.

```csharp
public TorrentPackage TorrentPackage { get; }
```

##### Property Value

The TORRENT file metadata package.

##### Examples

This code sample shows how to update metadata in a TORRENT file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputTorrent))
{
    var root = metadata.GetRootPackage<TorrentRootPackage>();

    root.TorrentPackage.Comment = "test comment";
    root.TorrentPackage.CreatedBy = "GroupDocs.Metadata";
    root.TorrentPackage.CreationDate = DateTime.Today;

    metadata.Save(Constants.OutputTorrent);
}
```

### TorrentSharedFilePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage.md

#### TorrentSharedFilePackage class

Represents shared file information. Contains detailed info about each file in a torrent distribution.

```csharp
public class TorrentSharedFilePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Length { get; } | Gets the length of the file in bytes. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the full name of the file (relative path to the file from the root torrent folder). |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Length
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/length.md

#### TorrentSharedFilePackage.Length property

Gets the length of the file in bytes.

```csharp
public long Length { get; }
```

##### Property Value

The length of the file in bytes.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/name.md

#### TorrentSharedFilePackage.Name property

Gets the full name of the file (relative path to the file from the root torrent folder).

```csharp
public string Name { get; }
```

##### Property Value

The full name of the file (relative path to the file from the root torrent folder).

### GroupDocs.Metadata.Formats.Raw.Cr2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2.md

#### Classes

| Class | Description |
| --- | --- |
| Cr2AFConfigPackage | Represents Canon MakerNotes tags. |
| Cr2AFInfo2Package | Represents Canon MakerNotes tags. |
| Cr2AFInfoPackage | Represents Canon MakerNotes tags. |
| Cr2AFMicroAdjPackage | Represents Canon MakerNotes tags. |
| Cr2AspectInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CameraSettingsPackage | Represents Canon MakerNotes tags. |
| Cr2ColorBalancePackage | Represents Canon MakerNotes tags. |
| Cr2ColorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CropInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FileInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FocalLengthPackage | Represents Canon MakerNotes tags. |
| Cr2Functions1DPackage | Represents Canon MakerNotes tags. |
| Cr2LightingOptPackage | Represents Canon MakerNotes tags. |
| Cr2LogInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MakerNotePackage | Represents Canon MakerNotes tags. |
| Cr2ModifiedInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MovieInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MultiExpPackage | Represents Canon MakerNotes tags. |
| Cr2Package | Represents native CR2 metadata. |
| Cr2PanoramaPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncsPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncValuesPackage | Represents Canon MakerNotes tags. |
| Cr2ProcessingPackage | Represents Canon MakerNotes tags. |
| Cr2RootPackage | Represents an entry point to all metadata packages presented in a particular file CR2. |
| Cr2SensorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2ShotInfoPackage | Represents Canon MakerNotes tags. |
| Cr2TimeInfoPackage | Represents Canon MakerNotes tags. |
| Cr2VignettingCorr2Package | Represents Canon MakerNotes tags. |
| Cr2WBInfoPackage | Represents Canon MakerNotes tags. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| Cr2AFConfigIndex | Defines ids of Cr2AFConfig tags. |
| Cr2AFInfo2Index | Defines ids of Cr2AFInfo2 tags. |
| Cr2AFInfoIndex | Defines ids of Cr2AFInfo tags. |
| Cr2AFMicroAdjIndex | Defines ids of Cr2AFMicroAdj tags. |
| Cr2AspectInfoIndex | Defines ids of Cr2AspectInfo tags. |
| Cr2CameraSettingsIndex | Defines ids of Cr2CameraSettings tags. |
| Cr2ColorBalanceIndex | Defines ids of Cr2ColorBalance tags. |
| Cr2ColorInfoIndex | Defines ids of Cr2ColorInfo tags. |
| Cr2CropInfoIndex | Defines ids of Cr2CropInfo tags. |
| Cr2FileInfoIndex | Defines ids of Cr2FileInfo tags. |
| Cr2FilterInfoIndex | Defines ids of Cr2FilterInfo tags. |
| Cr2FocalLengthIndex | Defines ids of Cr2FocalLength tags. |
| Cr2Functions1DIndex | Defines ids of Cr2Functions1D tags. |
| Cr2Functions2Index | Defines ids of Cr2Functions2 tags. |
| Cr2LightingOptIndex | Defines ids of Cr2LightingOpt tags. |
| Cr2LogInfoIndex | Defines ids of Cr2LogInfo tags. |
| Cr2MakerNoteIndex | Defines ids of Cr2MakerNote tags. |
| Cr2ModifiedInfoIndex | Defines ids of Cr2ModifiedInfo tags. |
| Cr2MovieInfoIndex | Defines ids of Cr2MovieInfo tags. |
| Cr2MultiExpIndex | Defines ids of Cr2MultiExp tags. |
| Cr2PanoramaIndex | Defines ids of Cr2Panorama tags. |
| Cr2PersonalFuncsIndex | Defines ids of Cr2PersonalFuncs tags. |
| Cr2PersonalFuncValuesIndex | Defines ids of Cr2PersonalFuncValues tags. |
| Cr2ProcessingIndex | Defines ids of Cr2Processing tags. |
| Cr2SensorInfoIndex | Defines ids of Cr2SensorInfo tags. |
| Cr2ShotInfoIndex | Defines ids of Cr2ShotInfo tags. |
| Cr2TimeInfoIndex | Defines ids of Cr2TimeInfo tags. |
| Cr2VignettingCorr2Index | Defines ids of Cr2VignettingCorr2 tags. |
| Cr2WBInfoIndex | Defines ids of Cr2WBInfo tags. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### Cr2AFConfigIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigindex.md

#### Cr2AFConfigIndex enumeration

Defines ids of Cr2AFConfig tags.

```csharp
public enum Cr2AFConfigIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| AFConfigTool | `1` | Indicates the AFConfigTool. |
| AFTrackingSensitivity | `2` | Indicates the AFTrackingSensitivity. |
| AFAccelDecelTracking | `3` | Indicates the AFAccelDecelTracking. |
| AFPointSwitching | `4` | Indicates the AFPointSwitching. |
| AIServoFirstImage | `5` | Indicates the AIServoFirstImage. |
| AIServoSecondImage | `6` | Indicates the AIServoSecondImage. |
| USMLensElectronicMF | `7` | Indicates the USMLensElectronicMF. |
| AFAssistBeam | `8` | Indicates the AFAssistBeam. |
| OneShotAFRelease | `9` | Indicates the OneShotAFRelease. |
| AutoAFPointSelEOSiTRAF | `10` | Indicates the AutoAFPointSelEOSiTRAF. |
| LensDriveWhenAFImpossible | `11` | Indicates the LensDriveWhenAFImpossible. |
| SelectAFAreaSelectionMode | `12` | Indicates the SelectAFAreaSelectionMode. |
| AFAreaSelectionMethod | `13` | Indicates the AFAreaSelectionMethod. |
| OrientationLinkedAF | `14` | Indicates the OrientationLinkedAF. |
| ManualAFPointSelPattern | `15` | Indicates the ManualAFPointSelPattern. |
| AFPointDisplayDuringFocus | `16` | Indicates the AFPointDisplayDuringFocus. |
| VFDisplayIllumination | `17` | Indicates the VFDisplayIllumination. |
| AFStatusViewfinder | `18` | Indicates the AFStatusViewfinder. |
| InitialAFPointInServo | `19` | Indicates the InitialAFPointInServo. |

### Cr2AFConfigPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage.md

#### Cr2AFConfigPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2AFConfigPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2AFConfigPackage() | Initializes a new instance of the `Cr2AFConfigPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AFAccelDecelTracking { get; } | Gets the AFAccelDecelTracking. |
| AFAreaSelectionMethod { get; } | Gets the AFAreaSelectionMethod. |
| AFAssistBeam { get; } | Gets the AFAssistBeam. |
| AFConfigTool { get; } | Gets the AFConfigTool. |
| AFPointDisplayDuringFocus { get; } | Gets the AFPointDisplayDuringFocus. |
| AFPointSwitching { get; } | Gets the AFPointSwitching. |
| AFStatusViewfinder { get; } | Gets the AFStatusViewfinder. |
| AFTrackingSensitivity { get; } | Gets the AFTrackingSensitivity. |
| AIServoFirstImage { get; } | Gets the AIServoFirstImage. |
| AIServoSecondImage { get; } | Gets the AIServoSecondImage. |
| AutoAFPointSelEOSiTRAF { get; } | Gets the AutoAFPointSelEOSiTRAF. |
| Count { get; } | Gets the number of metadata properties. |
| InitialAFPointInServo { get; } | Gets the InitialAFPointInServo. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensDriveWhenAFImpossible { get; } | Gets the LensDriveWhenAFImpossible. |
| ManualAFPointSelPattern { get; } | Gets the ManualAFPointSelPattern. |
| MetadataType { get; } | Gets the metadata type. |
| OneShotAFRelease { get; } | Gets the OneShotAFRelease. |
| OrientationLinkedAF { get; } | Gets the OrientationLinkedAF. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SelectAFAreaSelectionMode { get; } | Gets the SelectAFAreaSelectionMode. |
| USMLensElectronicMF { get; } | Gets the USMLensElectronicMF. |
| VFDisplayIllumination { get; } | Gets the VFDisplayIllumination. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFAccelDecelTracking
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afacceldeceltracking.md

#### Cr2AFConfigPackage.AFAccelDecelTracking property

Gets the AFAccelDecelTracking.

```csharp
public int AFAccelDecelTracking { get; }
```

##### Property Value

The AFAccelDecelTracking.

### AFAreaSelectionMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afareaselectionmethod.md

#### Cr2AFConfigPackage.AFAreaSelectionMethod property

Gets the AFAreaSelectionMethod.

```csharp
public int AFAreaSelectionMethod { get; }
```

##### Property Value

The AFAreaSelectionMethod.

### AFAssistBeam
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afassistbeam.md

#### Cr2AFConfigPackage.AFAssistBeam property

Gets the AFAssistBeam.

```csharp
public int AFAssistBeam { get; }
```

##### Property Value

The AFAssistBeam.

### AFConfigTool
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afconfigtool.md

#### Cr2AFConfigPackage.AFConfigTool property

Gets the AFConfigTool.

```csharp
public int AFConfigTool { get; }
```

##### Property Value

The AFConfigTool.

### AFPointDisplayDuringFocus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afpointdisplayduringfocus.md

#### Cr2AFConfigPackage.AFPointDisplayDuringFocus property

Gets the AFPointDisplayDuringFocus.

```csharp
public int AFPointDisplayDuringFocus { get; }
```

##### Property Value

The AFPointDisplayDuringFocus.

### AFPointSwitching
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afpointswitching.md

#### Cr2AFConfigPackage.AFPointSwitching property

Gets the AFPointSwitching.

```csharp
public int AFPointSwitching { get; }
```

##### Property Value

The AFPointSwitching.

### AFStatusViewfinder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/afstatusviewfinder.md

#### Cr2AFConfigPackage.AFStatusViewfinder property

Gets the AFStatusViewfinder.

```csharp
public int AFStatusViewfinder { get; }
```

##### Property Value

The AFStatusViewfinder.

### AFTrackingSensitivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/aftrackingsensitivity.md

#### Cr2AFConfigPackage.AFTrackingSensitivity property

Gets the AFTrackingSensitivity.

```csharp
public int AFTrackingSensitivity { get; }
```

##### Property Value

The AFTrackingSensitivity.

### AIServoFirstImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/aiservofirstimage.md

#### Cr2AFConfigPackage.AIServoFirstImage property

Gets the AIServoFirstImage.

```csharp
public int AIServoFirstImage { get; }
```

##### Property Value

The AIServoFirstImage.

### AIServoSecondImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/aiservosecondimage.md

#### Cr2AFConfigPackage.AIServoSecondImage property

Gets the AIServoSecondImage.

```csharp
public int AIServoSecondImage { get; }
```

##### Property Value

The AIServoSecondImage.

### AutoAFPointSelEOSiTRAF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/autoafpointseleositraf.md

#### Cr2AFConfigPackage.AutoAFPointSelEOSiTRAF property

Gets the AutoAFPointSelEOSiTRAF.

```csharp
public int AutoAFPointSelEOSiTRAF { get; }
```

##### Property Value

The AutoAFPointSelEOSiTRAF.

### Cr2AFConfigPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/cr2afconfigpackage.md

#### Cr2AFConfigPackage constructor

Initializes a new instance of the `Cr2AFConfigPackage` class.

```csharp
public Cr2AFConfigPackage()
```

### InitialAFPointInServo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/initialafpointinservo.md

#### Cr2AFConfigPackage.InitialAFPointInServo property

Gets the InitialAFPointInServo.

```csharp
public int InitialAFPointInServo { get; }
```

##### Property Value

The InitialAFPointInServo.

### LensDriveWhenAFImpossible
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/lensdrivewhenafimpossible.md

#### Cr2AFConfigPackage.LensDriveWhenAFImpossible property

Gets the LensDriveWhenAFImpossible.

```csharp
public int LensDriveWhenAFImpossible { get; }
```

##### Property Value

The LensDriveWhenAFImpossible.

### ManualAFPointSelPattern
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/manualafpointselpattern.md

#### Cr2AFConfigPackage.ManualAFPointSelPattern property

Gets the ManualAFPointSelPattern.

```csharp
public int ManualAFPointSelPattern { get; }
```

##### Property Value

The ManualAFPointSelPattern.

### OneShotAFRelease
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/oneshotafrelease.md

#### Cr2AFConfigPackage.OneShotAFRelease property

Gets the OneShotAFRelease.

```csharp
public int OneShotAFRelease { get; }
```

##### Property Value

The OneShotAFRelease.

### OrientationLinkedAF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/orientationlinkedaf.md

#### Cr2AFConfigPackage.OrientationLinkedAF property

Gets the OrientationLinkedAF.

```csharp
public int OrientationLinkedAF { get; }
```

##### Property Value

The OrientationLinkedAF.

### SelectAFAreaSelectionMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/selectafareaselectionmode.md

#### Cr2AFConfigPackage.SelectAFAreaSelectionMode property

Gets the SelectAFAreaSelectionMode.

```csharp
public int SelectAFAreaSelectionMode { get; }
```

##### Property Value

The SelectAFAreaSelectionMode.

### USMLensElectronicMF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/usmlenselectronicmf.md

#### Cr2AFConfigPackage.USMLensElectronicMF property

Gets the USMLensElectronicMF.

```csharp
public int USMLensElectronicMF { get; }
```

##### Property Value

The USMLensElectronicMF.

### VFDisplayIllumination
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/vfdisplayillumination.md

#### Cr2AFConfigPackage.VFDisplayIllumination property

Gets the VFDisplayIllumination.

```csharp
public int VFDisplayIllumination { get; }
```

##### Property Value

The VFDisplayIllumination.

### Cr2AFInfo2Index
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2index.md

#### Cr2AFInfo2Index enumeration

Defines ids of Cr2AFInfo2 tags.

```csharp
public enum Cr2AFInfo2Index
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AFInfoSize | `0` | Indicates the AFInfoSize. |
| AFAreaMode | `1` | Indicates the AFAreaMode. |
| NumAFPoints | `2` | Indicates the NumAFPoints. |
| ValidAFPoints | `3` | Indicates the ValidAFPoints. |
| CanonImageWidth | `4` | Indicates the CanonImageWidth. |
| CanonImageHeight | `5` | Indicates the CanonImageHeight. |
| AFImageWidth | `6` | Indicates the AFImageWidth. |
| AFImageHeight | `7` | Indicates the AFImageHeight. |
| AFAreaWidths | `8` | Indicates the AFAreaWidths. |
| AFAreaHeights | `9` | Indicates the AFAreaHeights. |
| AFAreaXPositions | `10` | Indicates the AFAreaXPositions. |
| AFAreaYPositions | `11` | Indicates the AFAreaYPositions. |
| AFPointsInFocus | `12` | Indicates the AFPointsInFocus. |
| AFPointsSelected | `13` | Indicates the AFPointsSelected. |
| PrimaryAFPoint | `14` | Indicates the PrimaryAFPoint. |

### Cr2AFInfo2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package.md

#### Cr2AFInfo2Package class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2AFInfo2Package : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2AFInfo2Package() | Initializes a new instance of the `Cr2AFInfo2Package` class. |

#### Properties

| Name | Description |
| --- | --- |
| AFAreaHeights { get; } | Gets the AFAreaHeights. |
| AFAreaMode { get; } | Gets the AFAreaMode. |
| AFAreaWidths { get; } | Gets the AFAreaWidths. |
| AFAreaXPositions { get; } | Gets the AFAreaXPositions. |
| AFAreaYPositions { get; } | Gets the AFAreaYPositions. |
| AFImageHeight { get; } | Gets the AFImageHeight. |
| AFImageWidth { get; } | Gets the AFImageWidth. |
| AFInfoSize { get; } | Gets the AFInfoSize. |
| AFPointsInFocus { get; } | Gets the AFPointsInFocus. |
| AFPointsSelected { get; } | Gets the AFPointsSelected. |
| CanonImageHeight { get; } | Gets the CanonImageHeight. |
| CanonImageWidth { get; } | Gets the CanonImageWidth. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NumAFPoints { get; } | Gets the NumAFPoints. |
| PrimaryAFPoint { get; } | Gets the PrimaryAFPoint. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ValidAFPoints { get; } | Gets the ValidAFPoints. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFAreaHeights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afareaheights.md

#### Cr2AFInfo2Package.AFAreaHeights property

Gets the AFAreaHeights.

```csharp
public ushort AFAreaHeights { get; }
```

##### Property Value

The AFAreaHeights.

### AFAreaMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afareamode.md

#### Cr2AFInfo2Package.AFAreaMode property

Gets the AFAreaMode.

```csharp
public ushort AFAreaMode { get; }
```

##### Property Value

The AFAreaMode.

### AFAreaWidths
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afareawidths.md

#### Cr2AFInfo2Package.AFAreaWidths property

Gets the AFAreaWidths.

```csharp
public ushort AFAreaWidths { get; }
```

##### Property Value

The AFAreaWidths.

### AFAreaXPositions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afareaxpositions.md

#### Cr2AFInfo2Package.AFAreaXPositions property

Gets the AFAreaXPositions.

```csharp
public ushort AFAreaXPositions { get; }
```

##### Property Value

The AFAreaXPositions.

### AFAreaYPositions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afareaypositions.md

#### Cr2AFInfo2Package.AFAreaYPositions property

Gets the AFAreaYPositions.

```csharp
public ushort AFAreaYPositions { get; }
```

##### Property Value

The AFAreaYPositions.

### AFImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afimageheight.md

#### Cr2AFInfo2Package.AFImageHeight property

Gets the AFImageHeight.

```csharp
public ushort AFImageHeight { get; }
```

##### Property Value

The AFImageHeight.

### AFImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afimagewidth.md

#### Cr2AFInfo2Package.AFImageWidth property

Gets the AFImageWidth.

```csharp
public ushort AFImageWidth { get; }
```

##### Property Value

The AFImageWidth.

### AFInfoSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afinfosize.md

#### Cr2AFInfo2Package.AFInfoSize property

Gets the AFInfoSize.

```csharp
public ushort AFInfoSize { get; }
```

##### Property Value

The AFInfoSize.

### AFPointsInFocus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afpointsinfocus.md

#### Cr2AFInfo2Package.AFPointsInFocus property

Gets the AFPointsInFocus.

```csharp
public ushort AFPointsInFocus { get; }
```

##### Property Value

The AFPointsInFocus.

### AFPointsSelected
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/afpointsselected.md

#### Cr2AFInfo2Package.AFPointsSelected property

Gets the AFPointsSelected.

```csharp
public ushort AFPointsSelected { get; }
```

##### Property Value

The AFPointsSelected.

### CanonImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/canonimageheight.md

#### Cr2AFInfo2Package.CanonImageHeight property

Gets the CanonImageHeight.

```csharp
public ushort CanonImageHeight { get; }
```

##### Property Value

The CanonImageHeight.

### CanonImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/canonimagewidth.md

#### Cr2AFInfo2Package.CanonImageWidth property

Gets the CanonImageWidth.

```csharp
public ushort CanonImageWidth { get; }
```

##### Property Value

The CanonImageWidth.

### Cr2AFInfo2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/cr2afinfo2package.md

#### Cr2AFInfo2Package constructor

Initializes a new instance of the `Cr2AFInfo2Package` class.

```csharp
public Cr2AFInfo2Package()
```

### NumAFPoints
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/numafpoints.md

#### Cr2AFInfo2Package.NumAFPoints property

Gets the NumAFPoints.

```csharp
public ushort NumAFPoints { get; }
```

##### Property Value

The NumAFPoints.

### PrimaryAFPoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/primaryafpoint.md

#### Cr2AFInfo2Package.PrimaryAFPoint property

Gets the PrimaryAFPoint.

```csharp
public ushort PrimaryAFPoint { get; }
```

##### Property Value

The PrimaryAFPoint.

### ValidAFPoints
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/validafpoints.md

#### Cr2AFInfo2Package.ValidAFPoints property

Gets the ValidAFPoints.

```csharp
public ushort ValidAFPoints { get; }
```

##### Property Value

The ValidAFPoints.

### Cr2AFInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfoindex.md

#### Cr2AFInfoIndex enumeration

Defines ids of Cr2AFInfo tags.

```csharp
public enum Cr2AFInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NumAFPoints | `0` | Indicates the NumAFPoints. |
| ValidAFPoints | `1` | Indicates the ValidAFPoints. |
| CanonImageWidth | `2` | Indicates the CanonImageWidth. |
| CanonImageHeight | `3` | Indicates the CanonImageHeight. |
| AFImageWidth | `4` | Indicates the AFImageWidth. |
| AFImageHeight | `5` | Indicates the AFImageHeight. |
| AFAreaWidth | `6` | Indicates the AFAreaWidth. |
| AFAreaHeight | `7` | Indicates the AFAreaHeight. |
| AFAreaXPositions | `8` | Indicates the AFAreaXPositions. |
| AFAreaYPositions | `9` | Indicates the AFAreaYPositions. |
| AFPointsInFocus | `10` | Indicates the AFPointsInFocus. |
| PrimaryAFPointAFInfo | `11` | Indicates the PrimaryAFPointAFInfo. |
| PrimaryAFPoint | `12` | Indicates the PrimaryAFPoint. |

### Cr2AFInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage.md

#### Cr2AFInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2AFInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2AFInfoPackage() | Initializes a new instance of the `Cr2AFInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AFAreaHeight { get; } | Gets the AFAreaHeight. |
| AFAreaWidth { get; } | Gets the AFAreaWidth. |
| AFAreaXPositions { get; } | Gets the AFAreaXPositions. |
| AFAreaYPositions { get; } | Gets the AFAreaYPositions. |
| AFImageHeight { get; } | Gets the AFImageHeight. |
| AFImageWidth { get; } | Gets the AFImageWidth. |
| AFPointsInFocus { get; } | Gets the AFPointsInFocus. |
| CanonImageHeight { get; } | Gets the CanonImageHeight. |
| CanonImageWidth { get; } | Gets the CanonImageWidth. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NumAFPoints { get; } | Gets the NumAFPoints. |
| PrimaryAFPoint { get; } | Gets the PrimaryAFPoint. |
| PrimaryAFPointAFInfo { get; } | Gets the PrimaryAFPointAFInfo. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ValidAFPoints { get; } | Gets the ValidAFPoints. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFAreaHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afareaheight.md

#### Cr2AFInfoPackage.AFAreaHeight property

Gets the AFAreaHeight.

```csharp
public ushort AFAreaHeight { get; }
```

##### Property Value

The AFAreaHeight.

### AFAreaWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afareawidth.md

#### Cr2AFInfoPackage.AFAreaWidth property

Gets the AFAreaWidth.

```csharp
public ushort AFAreaWidth { get; }
```

##### Property Value

The AFAreaWidth.

### AFAreaXPositions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afareaxpositions.md

#### Cr2AFInfoPackage.AFAreaXPositions property

Gets the AFAreaXPositions.

```csharp
public ushort AFAreaXPositions { get; }
```

##### Property Value

The AFAreaXPositions.

### AFAreaYPositions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afareaypositions.md

#### Cr2AFInfoPackage.AFAreaYPositions property

Gets the AFAreaYPositions.

```csharp
public ushort AFAreaYPositions { get; }
```

##### Property Value

The AFAreaYPositions.

### AFImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afimageheight.md

#### Cr2AFInfoPackage.AFImageHeight property

Gets the AFImageHeight.

```csharp
public ushort AFImageHeight { get; }
```

##### Property Value

The AFImageHeight.

### AFImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afimagewidth.md

#### Cr2AFInfoPackage.AFImageWidth property

Gets the AFImageWidth.

```csharp
public ushort AFImageWidth { get; }
```

##### Property Value

The AFImageWidth.

### AFPointsInFocus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/afpointsinfocus.md

#### Cr2AFInfoPackage.AFPointsInFocus property

Gets the AFPointsInFocus.

```csharp
public ushort AFPointsInFocus { get; }
```

##### Property Value

The AFPointsInFocus.

### CanonImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/canonimageheight.md

#### Cr2AFInfoPackage.CanonImageHeight property

Gets the CanonImageHeight.

```csharp
public ushort CanonImageHeight { get; }
```

##### Property Value

The CanonImageHeight.

### CanonImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/canonimagewidth.md

#### Cr2AFInfoPackage.CanonImageWidth property

Gets the CanonImageWidth.

```csharp
public ushort CanonImageWidth { get; }
```

##### Property Value

The CanonImageWidth.

### Cr2AFInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/cr2afinfopackage.md

#### Cr2AFInfoPackage constructor

Initializes a new instance of the `Cr2AFInfoPackage` class.

```csharp
public Cr2AFInfoPackage()
```

### NumAFPoints
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/numafpoints.md

#### Cr2AFInfoPackage.NumAFPoints property

Gets the NumAFPoints.

```csharp
public ushort NumAFPoints { get; }
```

##### Property Value

The NumAFPoints.

### PrimaryAFPoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/primaryafpoint.md

#### Cr2AFInfoPackage.PrimaryAFPoint property

Gets the PrimaryAFPoint.

```csharp
public ushort PrimaryAFPoint { get; }
```

##### Property Value

The PrimaryAFPoint.

### PrimaryAFPointAFInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/primaryafpointafinfo.md

#### Cr2AFInfoPackage.PrimaryAFPointAFInfo property

Gets the PrimaryAFPointAFInfo.

```csharp
public ushort PrimaryAFPointAFInfo { get; }
```

##### Property Value

The PrimaryAFPointAFInfo.

### ValidAFPoints
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/validafpoints.md

#### Cr2AFInfoPackage.ValidAFPoints property

Gets the ValidAFPoints.

```csharp
public ushort ValidAFPoints { get; }
```

##### Property Value

The ValidAFPoints.

### Cr2AFMicroAdjIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjindex.md

#### Cr2AFMicroAdjIndex enumeration

Defines ids of Cr2AFMicroAdj tags.

```csharp
public enum Cr2AFMicroAdjIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| AFMicroAdjMode | `1` | Indicates the AFMicroAdjMode. |
| AFMicroAdjValue | `2` | Indicates the AFMicroAdjValue. |

### Cr2AFMicroAdjPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage.md

#### Cr2AFMicroAdjPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2AFMicroAdjPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2AFMicroAdjPackage() | Initializes a new instance of the `Cr2AFMicroAdjPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AFMicroAdjMode { get; } | Gets the AFMicroAdjMode. |
| AFMicroAdjValue { get; } | Gets the AFMicroAdjValue. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFMicroAdjMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/afmicroadjmode.md

#### Cr2AFMicroAdjPackage.AFMicroAdjMode property

Gets the AFMicroAdjMode.

```csharp
public int AFMicroAdjMode { get; }
```

##### Property Value

The AFMicroAdjMode.

### AFMicroAdjValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/afmicroadjvalue.md

#### Cr2AFMicroAdjPackage.AFMicroAdjValue property

Gets the AFMicroAdjValue.

```csharp
public float AFMicroAdjValue { get; }
```

##### Property Value

The AFMicroAdjValue.

### Cr2AFMicroAdjPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/cr2afmicroadjpackage.md

#### Cr2AFMicroAdjPackage constructor

Initializes a new instance of the `Cr2AFMicroAdjPackage` class.

```csharp
public Cr2AFMicroAdjPackage()
```

### Cr2AspectInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfoindex.md

#### Cr2AspectInfoIndex enumeration

Defines ids of Cr2AspectInfo tags.

```csharp
public enum Cr2AspectInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AspectRatio | `0` | Indicates the AspectRatio. |
| CroppedImageWidth | `1` | Indicates the CroppedImageWidth. |
| CroppedImageHeight | `2` | Indicates the CroppedImageHeight. |
| CroppedImageLeft | `3` | Indicates the CroppedImageLeft. |
| CroppedImageTop | `4` | Indicates the CroppedImageTop. |

### Cr2AspectInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage.md

#### Cr2AspectInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2AspectInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2AspectInfoPackage() | Initializes a new instance of the `Cr2AspectInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AspectRatio { get; } | Gets the AspectRatio. |
| Count { get; } | Gets the number of metadata properties. |
| CroppedImageHeight { get; } | Gets the CroppedImageHeight. |
| CroppedImageLeft { get; } | Gets the CroppedImageLeft. |
| CroppedImageTop { get; } | Gets the CroppedImageTop. |
| CroppedImageWidth { get; } | Gets the CroppedImageWidth. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AspectRatio
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/aspectratio.md

#### Cr2AspectInfoPackage.AspectRatio property

Gets the AspectRatio.

```csharp
public int AspectRatio { get; }
```

##### Property Value

The AspectRatio.

### Cr2AspectInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/cr2aspectinfopackage.md

#### Cr2AspectInfoPackage constructor

Initializes a new instance of the `Cr2AspectInfoPackage` class.

```csharp
public Cr2AspectInfoPackage()
```

### CroppedImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/croppedimageheight.md

#### Cr2AspectInfoPackage.CroppedImageHeight property

Gets the CroppedImageHeight.

```csharp
public int CroppedImageHeight { get; }
```

##### Property Value

The CroppedImageHeight.

### CroppedImageLeft
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/croppedimageleft.md

#### Cr2AspectInfoPackage.CroppedImageLeft property

Gets the CroppedImageLeft.

```csharp
public int CroppedImageLeft { get; }
```

##### Property Value

The CroppedImageLeft.

### CroppedImageTop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/croppedimagetop.md

#### Cr2AspectInfoPackage.CroppedImageTop property

Gets the CroppedImageTop.

```csharp
public int CroppedImageTop { get; }
```

##### Property Value

The CroppedImageTop.

### CroppedImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/croppedimagewidth.md

#### Cr2AspectInfoPackage.CroppedImageWidth property

Gets the CroppedImageWidth.

```csharp
public int CroppedImageWidth { get; }
```

##### Property Value

The CroppedImageWidth.

### Cr2CameraSettingsIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingsindex.md

#### Cr2CameraSettingsIndex enumeration

Defines ids of Cr2CameraSettings tags.

```csharp
public enum Cr2CameraSettingsIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| MacroMode | `1` | Indicates the MacroMode. |
| SelfTimer | `2` | Indicates the SelfTimer. |
| Quality | `3` | Indicates the Quality. |
| CanonFlashMode | `4` | Indicates the CanonFlashMode. |
| ContinuousDrive | `5` | Indicates the ContinuousDrive. |
| Unknown2 | `6` | Unknown tag. |
| FocusMode | `7` | Indicates the FocusMode. |
| Unknown3 | `8` | Unknown tag. |
| RecordMode | `9` | Indicates the RecordMode. |
| CanonImageSize | `10` | Indicates the CanonImageSize. |
| EasyMode | `11` | Indicates the EasyMode. |
| DigitalZoom | `12` | Indicates the DigitalZoom. |
| Contrast | `13` | Indicates the Contrast. |
| Saturation | `14` | Indicates the Saturation. |
| Sharpness | `15` | Indicates the Sharpness. |
| CameraIso | `16` | Indicates the CameraIso. |
| MeteringMode | `17` | Indicates the MeteringMode. |
| FocusRange | `18` | Indicates the FocusRange. |
| AFPoint | `19` | Indicates the AFPoint. |
| CanonExposureMode | `20` | Indicates the CanonExposureMode. |
| Unknown4 | `21` | Unknown tag. |
| LensType | `22` | Indicates the LensType. |
| MaxFocalLength | `23` | Indicates the MaxFocalLength. |
| MinFocalLength | `24` | Indicates the MinFocalLength. |
| FocalUnits | `25` | Indicates the FocalUnits. |
| MaxAperture | `26` | Indicates the MaxAperture. |
| MinAperture | `27` | Indicates the MinAperture. |
| FlashActivity | `28` | Indicates the FlashActivity. |
| FlashBits | `29` | Indicates the FlashBits. |
| FocusContinuous | `32` | Indicates the FocusContinuous. |
| AESetting | `33` | Indicates the AESetting. |
| ImageStabilization | `34` | Indicates the ImageStabilization. |
| DisplayAperture | `35` | Indicates the DisplayAperture. |
| ZoomSourceWidth | `36` | Indicates the ZoomSourceWidth. |
| ZoomTargetWidth | `37` | Indicates the ZoomTargetWidth. |
| Unknown5 | `38` | Unknown tag. |
| SpotMeteringMode | `39` | Indicates the SpotMeteringMode. |
| PhotoEffect | `40` | Indicates the PhotoEffect. |
| ManualFlashOutput | `41` | Indicates the ManualFlashOutput. |
| Unknown6 | `42` | Unknown tag. |
| ColorTone | `43` | Indicates the ColorTone. |
| Unknown7 | `44` | Unknown tag. |
| Unknown8 | `45` | Unknown tag. |
| Unknown9 | `46` | Unknown tag. |
| SRAWQuality | `47` | Indicates the SRAWQuality. |
| Unknown10 | `48` | Unknown tag. |
| Unknown11 | `49` | Unknown tag. |
| Unknown12 | `50` | Unknown tag. |

### Cr2CameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage.md

#### Cr2CameraSettingsPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2CameraSettingsPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2CameraSettingsPackage() | Initializes a new instance of the `Cr2CameraSettingsPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AESetting { get; } | Gets the AESetting. |
| AFPoint { get; } | Gets the AFPoint. |
| CameraIso { get; } | Gets the CameraIso. |
| CanonExposureMode { get; } | Gets the CanonExposureMode. |
| CanonFlashMode { get; } | Gets the CanonFlashMode. |
| CanonImageSize { get; } | Gets the CanonImageSize. |
| ColorTone { get; } | Gets the ColorTone. |
| ContinuousDrive { get; } | Gets the ContinuousDrive. |
| Contrast { get; } | Gets the Contrast. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalZoom { get; } | Gets the DigitalZoom. |
| DisplayAperture { get; } | Gets the DisplayAperture. |
| EasyMode { get; } | Gets the EasyMode. |
| FlashActivity { get; } | Gets the FlashActivity. |
| FlashBits { get; } | Gets the FlashBits. |
| FocalUnits { get; } | Gets the FocalUnits. |
| FocusContinuous { get; } | Gets the FocusContinuous. |
| FocusMode { get; } | Gets the FocusMode. |
| FocusRange { get; } | Gets the FocusRange. |
| ImageStabilization { get; } | Gets the ImageStabilization. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensType { get; } | Gets the LensType. |
| MacroMode { get; } | Gets the MacroMode. |
| ManualFlashOutput { get; } | Gets the ManualFlashOutput. |
| MaxAperture { get; } | Gets the MaxAperture. |
| MaxFocalLength { get; } | Gets the MaxFocalLength. |
| MetadataType { get; } | Gets the metadata type. |
| MeteringMode { get; } | Gets the MeteringMode. |
| MinAperture { get; } | Gets the MinAperture. |
| MinFocalLength { get; } | Gets the MinFocalLength. |
| PhotoEffect { get; } | Gets the PhotoEffect. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Quality { get; } | Gets the Quality. |
| RecordMode { get; } | Gets the RecordMode. |
| Saturation { get; } | Gets the Saturation. |
| SelfTimer { get; } | Gets the SelfTimer. |
| Sharpness { get; } | Gets the Sharpness. |
| SpotMeteringMode { get; } | Gets the SpotMeteringMode. |
| SRAWQuality { get; } | Gets the SRAWQuality. |
| ZoomSourceWidth { get; } | Gets the ZoomSourceWidth. |
| ZoomTargetWidth { get; } | Gets the ZoomTargetWidth. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AESetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/aesetting.md

#### Cr2CameraSettingsPackage.AESetting property

Gets the AESetting.

```csharp
public ushort AESetting { get; }
```

##### Property Value

The AESetting.

### AFPoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/afpoint.md

#### Cr2CameraSettingsPackage.AFPoint property

Gets the AFPoint.

```csharp
public ushort AFPoint { get; }
```

##### Property Value

The AFPoint.

### CameraIso
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/cameraiso.md

#### Cr2CameraSettingsPackage.CameraIso property

Gets the CameraIso.

```csharp
public ushort CameraIso { get; }
```

##### Property Value

The CameraIso.

### CanonExposureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canonexposuremode.md

#### Cr2CameraSettingsPackage.CanonExposureMode property

Gets the CanonExposureMode.

```csharp
public ushort CanonExposureMode { get; }
```

##### Property Value

The CanonExposureMode.

### CanonFlashMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canonflashmode.md

#### Cr2CameraSettingsPackage.CanonFlashMode property

Gets the CanonFlashMode.

```csharp
public ushort CanonFlashMode { get; }
```

##### Property Value

The CanonFlashMode.

### CanonImageSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canonimagesize.md

#### Cr2CameraSettingsPackage.CanonImageSize property

Gets the CanonImageSize.

```csharp
public ushort CanonImageSize { get; }
```

##### Property Value

The CanonImageSize.

### ColorTone
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/colortone.md

#### Cr2CameraSettingsPackage.ColorTone property

Gets the ColorTone.

```csharp
public ushort ColorTone { get; }
```

##### Property Value

The ColorTone.

### ContinuousDrive
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/continuousdrive.md

#### Cr2CameraSettingsPackage.ContinuousDrive property

Gets the ContinuousDrive.

```csharp
public ushort ContinuousDrive { get; }
```

##### Property Value

The ContinuousDrive.

### Contrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/contrast.md

#### Cr2CameraSettingsPackage.Contrast property

Gets the Contrast.

```csharp
public ushort Contrast { get; }
```

##### Property Value

The Contrast.

### Cr2CameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/cr2camerasettingspackage.md

#### Cr2CameraSettingsPackage constructor

Initializes a new instance of the `Cr2CameraSettingsPackage` class.

```csharp
public Cr2CameraSettingsPackage()
```

### DigitalZoom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/digitalzoom.md

#### Cr2CameraSettingsPackage.DigitalZoom property

Gets the DigitalZoom.

```csharp
public ushort DigitalZoom { get; }
```

##### Property Value

The DigitalZoom.

### DisplayAperture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/displayaperture.md

#### Cr2CameraSettingsPackage.DisplayAperture property

Gets the DisplayAperture.

```csharp
public ushort DisplayAperture { get; }
```

##### Property Value

The DisplayAperture.

### EasyMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/easymode.md

#### Cr2CameraSettingsPackage.EasyMode property

Gets the EasyMode.

```csharp
public ushort EasyMode { get; }
```

##### Property Value

The EasyMode.

### FlashActivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/flashactivity.md

#### Cr2CameraSettingsPackage.FlashActivity property

Gets the FlashActivity.

```csharp
public ushort FlashActivity { get; }
```

##### Property Value

The FlashActivity.

### FlashBits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/flashbits.md

#### Cr2CameraSettingsPackage.FlashBits property

Gets the FlashBits.

```csharp
public ushort FlashBits { get; }
```

##### Property Value

The FlashBits.

### FocalUnits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focalunits.md

#### Cr2CameraSettingsPackage.FocalUnits property

Gets the FocalUnits.

```csharp
public ushort FocalUnits { get; }
```

##### Property Value

The FocalUnits.

### FocusContinuous
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focuscontinuous.md

#### Cr2CameraSettingsPackage.FocusContinuous property

Gets the FocusContinuous.

```csharp
public ushort FocusContinuous { get; }
```

##### Property Value

The FocusContinuous.

### FocusMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focusmode.md

#### Cr2CameraSettingsPackage.FocusMode property

Gets the FocusMode.

```csharp
public ushort FocusMode { get; }
```

##### Property Value

The FocusMode.

### FocusRange
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focusrange.md

#### Cr2CameraSettingsPackage.FocusRange property

Gets the FocusRange.

```csharp
public ushort FocusRange { get; }
```

##### Property Value

The FocusRange.

### ImageStabilization
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/imagestabilization.md

#### Cr2CameraSettingsPackage.ImageStabilization property

Gets the ImageStabilization.

```csharp
public ushort ImageStabilization { get; }
```

##### Property Value

The ImageStabilization.

### LensType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/lenstype.md

#### Cr2CameraSettingsPackage.LensType property

Gets the LensType.

```csharp
public ushort LensType { get; }
```

##### Property Value

The LensType.

### MacroMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/macromode.md

#### Cr2CameraSettingsPackage.MacroMode property

Gets the MacroMode.

```csharp
public ushort MacroMode { get; }
```

##### Property Value

The MacroMode.

### ManualFlashOutput
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/manualflashoutput.md

#### Cr2CameraSettingsPackage.ManualFlashOutput property

Gets the ManualFlashOutput.

```csharp
public ushort ManualFlashOutput { get; }
```

##### Property Value

The ManualFlashOutput.

### MaxAperture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/maxaperture.md

#### Cr2CameraSettingsPackage.MaxAperture property

Gets the MaxAperture.

```csharp
public ushort MaxAperture { get; }
```

##### Property Value

The MaxAperture.

### MaxFocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/maxfocallength.md

#### Cr2CameraSettingsPackage.MaxFocalLength property

Gets the MaxFocalLength.

```csharp
public ushort MaxFocalLength { get; }
```

##### Property Value

The MaxFocalLength.

### MeteringMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/meteringmode.md

#### Cr2CameraSettingsPackage.MeteringMode property

Gets the MeteringMode.

```csharp
public ushort MeteringMode { get; }
```

##### Property Value

The MeteringMode.

### MinAperture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/minaperture.md

#### Cr2CameraSettingsPackage.MinAperture property

Gets the MinAperture.

```csharp
public ushort MinAperture { get; }
```

##### Property Value

The MinAperture.

### MinFocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/minfocallength.md

#### Cr2CameraSettingsPackage.MinFocalLength property

Gets the MinFocalLength.

```csharp
public ushort MinFocalLength { get; }
```

##### Property Value

The MinFocalLength.

### PhotoEffect
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/photoeffect.md

#### Cr2CameraSettingsPackage.PhotoEffect property

Gets the PhotoEffect.

```csharp
public ushort PhotoEffect { get; }
```

##### Property Value

The PhotoEffect.

### Quality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/quality.md

#### Cr2CameraSettingsPackage.Quality property

Gets the Quality.

```csharp
public ushort Quality { get; }
```

##### Property Value

The Quality.

### RecordMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/recordmode.md

#### Cr2CameraSettingsPackage.RecordMode property

Gets the RecordMode.

```csharp
public ushort RecordMode { get; }
```

##### Property Value

The RecordMode.

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/saturation.md

#### Cr2CameraSettingsPackage.Saturation property

Gets the Saturation.

```csharp
public ushort Saturation { get; }
```

##### Property Value

The Saturation.

### SelfTimer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/selftimer.md

#### Cr2CameraSettingsPackage.SelfTimer property

Gets the SelfTimer.

```csharp
public ushort SelfTimer { get; }
```

##### Property Value

The SelfTimer.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/sharpness.md

#### Cr2CameraSettingsPackage.Sharpness property

Gets the Sharpness.

```csharp
public ushort Sharpness { get; }
```

##### Property Value

The Sharpness.

### SpotMeteringMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/spotmeteringmode.md

#### Cr2CameraSettingsPackage.SpotMeteringMode property

Gets the SpotMeteringMode.

```csharp
public ushort SpotMeteringMode { get; }
```

##### Property Value

The SpotMeteringMode.

### SRAWQuality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/srawquality.md

#### Cr2CameraSettingsPackage.SRAWQuality property

Gets the SRAWQuality.

```csharp
public ushort SRAWQuality { get; }
```

##### Property Value

The SRAWQuality.

### ZoomSourceWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/zoomsourcewidth.md

#### Cr2CameraSettingsPackage.ZoomSourceWidth property

Gets the ZoomSourceWidth.

```csharp
public ushort ZoomSourceWidth { get; }
```

##### Property Value

The ZoomSourceWidth.

### ZoomTargetWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/zoomtargetwidth.md

#### Cr2CameraSettingsPackage.ZoomTargetWidth property

Gets the ZoomTargetWidth.

```csharp
public ushort ZoomTargetWidth { get; }
```

##### Property Value

The ZoomTargetWidth.

### Cr2ColorBalanceIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalanceindex.md

#### Cr2ColorBalanceIndex enumeration

Defines ids of Cr2ColorBalance tags.

```csharp
public enum Cr2ColorBalanceIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| WB_RGGBLevelsAuto | `1` | Indicates the WB_RGGBLevelsAuto. |
| WB_RGGBLevelsDaylight | `5` | Indicates the WB_RGGBLevelsDaylight. |
| WB_RGGBLevelsShade | `9` | Indicates the WB_RGGBLevelsShade. |
| WB_RGGBLevelsCloudy | `13` | Indicates the WB_RGGBLevelsCloudy. |
| WB_RGGBLevelsTungsten | `17` | Indicates the WB_RGGBLevelsTungsten. |
| WB_RGGBLevelsFluorescent | `21` | Indicates the WB_RGGBLevelsFluorescent. |
| WB_RGGBLevelsFlash | `25` | Indicates the WB_RGGBLevelsFlash. |
| WB_RGGBLevelsKelvin | `33` | Indicates the WB_RGGBLevelsKelvin. |
| WB_RGGBBlackLevels | `37` | Indicates the WB_RGGBBlackLevels. |

### Cr2ColorBalancePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage.md

#### Cr2ColorBalancePackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2ColorBalancePackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2ColorBalancePackage() | Initializes a new instance of the `Cr2ColorBalancePackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| WB_RGGBBlackLevels { get; } | Gets the WB_RGGBBlackLevels. |
| WB_RGGBLevelsAuto { get; } | Gets the WB_RGGBLevelsAuto. |
| WB_RGGBLevelsCloudy { get; } | Gets the WB_RGGBLevelsCloudy. |
| WB_RGGBLevelsDaylight { get; } | Gets the WB_RGGBLevelsDaylight. |
| WB_RGGBLevelsFlash { get; } | Gets the WB_RGGBLevelsFlash. |
| WB_RGGBLevelsFluorescent { get; } | Gets the WB_RGGBLevelsFluorescent. |
| WB_RGGBLevelsKelvin { get; } | Gets the WB_RGGBLevelsKelvin. |
| WB_RGGBLevelsShade { get; } | Gets the WB_RGGBLevelsShade. |
| WB_RGGBLevelsTungsten { get; } | Gets the WB_RGGBLevelsTungsten. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2ColorBalancePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/cr2colorbalancepackage.md

#### Cr2ColorBalancePackage constructor

Initializes a new instance of the `Cr2ColorBalancePackage` class.

```csharp
public Cr2ColorBalancePackage()
```

### WB_RGGBBlackLevels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggbblacklevels.md

#### Cr2ColorBalancePackage.WB_RGGBBlackLevels property

Gets the WB_RGGBBlackLevels.

```csharp
public ushort WB_RGGBBlackLevels { get; }
```

##### Property Value

The WB_RGGBBlackLevels.

### WB_RGGBLevelsAuto
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelsauto.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsAuto property

Gets the WB_RGGBLevelsAuto.

```csharp
public ushort WB_RGGBLevelsAuto { get; }
```

##### Property Value

The WB_RGGBLevelsAuto.

### WB_RGGBLevelsCloudy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelscloudy.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsCloudy property

Gets the WB_RGGBLevelsCloudy.

```csharp
public ushort WB_RGGBLevelsCloudy { get; }
```

##### Property Value

The WB_RGGBLevelsCloudy.

### WB_RGGBLevelsDaylight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelsdaylight.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsDaylight property

Gets the WB_RGGBLevelsDaylight.

```csharp
public ushort WB_RGGBLevelsDaylight { get; }
```

##### Property Value

The WB_RGGBLevelsDaylight.

### WB_RGGBLevelsFlash
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelsflash.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsFlash property

Gets the WB_RGGBLevelsFlash.

```csharp
public ushort WB_RGGBLevelsFlash { get; }
```

##### Property Value

The WB_RGGBLevelsFlash.

### WB_RGGBLevelsFluorescent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelsfluorescent.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsFluorescent property

Gets the WB_RGGBLevelsFluorescent.

```csharp
public ushort WB_RGGBLevelsFluorescent { get; }
```

##### Property Value

The WB_RGGBLevelsFluorescent.

### WB_RGGBLevelsKelvin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelskelvin.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsKelvin property

Gets the WB_RGGBLevelsKelvin.

```csharp
public ushort WB_RGGBLevelsKelvin { get; }
```

##### Property Value

The WB_RGGBLevelsKelvin.

### WB_RGGBLevelsShade
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelsshade.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsShade property

Gets the WB_RGGBLevelsShade.

```csharp
public ushort WB_RGGBLevelsShade { get; }
```

##### Property Value

The WB_RGGBLevelsShade.

### WB_RGGBLevelsTungsten
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggblevelstungsten.md

#### Cr2ColorBalancePackage.WB_RGGBLevelsTungsten property

Gets the WB_RGGBLevelsTungsten.

```csharp
public ushort WB_RGGBLevelsTungsten { get; }
```

##### Property Value

The WB_RGGBLevelsTungsten.

### Cr2ColorInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfoindex.md

#### Cr2ColorInfoIndex enumeration

Defines ids of Cr2ColorInfo tags.

```csharp
public enum Cr2ColorInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| Saturation | `1` | Indicates the Saturation. |
| ColorTone | `2` | Indicates the ColorTone. |
| ColorSpace | `3` | Indicates the ColorSpace. |

### Cr2ColorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage.md

#### Cr2ColorInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2ColorInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2ColorInfoPackage() | Initializes a new instance of the `Cr2ColorInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColorSpace { get; } | Gets the ColorSpace. |
| ColorTone { get; } | Gets the ColorTone. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Saturation { get; } | Gets the Saturation. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ColorSpace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/colorspace.md

#### Cr2ColorInfoPackage.ColorSpace property

Gets the ColorSpace.

```csharp
public ushort ColorSpace { get; }
```

##### Property Value

The ColorSpace.

### ColorTone
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/colortone.md

#### Cr2ColorInfoPackage.ColorTone property

Gets the ColorTone.

```csharp
public ushort ColorTone { get; }
```

##### Property Value

The ColorTone.

### Cr2ColorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/cr2colorinfopackage.md

#### Cr2ColorInfoPackage constructor

Initializes a new instance of the `Cr2ColorInfoPackage` class.

```csharp
public Cr2ColorInfoPackage()
```

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/saturation.md

#### Cr2ColorInfoPackage.Saturation property

Gets the Saturation.

```csharp
public ushort Saturation { get; }
```

##### Property Value

The Saturation.

### Cr2CropInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfoindex.md

#### Cr2CropInfoIndex enumeration

Defines ids of Cr2CropInfo tags.

```csharp
public enum Cr2CropInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| CropLeftMargin | `0` | Indicates the CropLeftMargin. |
| CropRightMargin | `1` | Indicates the CropRightMargin. |
| CropTopMargin | `2` | Indicates the CropTopMargin. |
| CropBottomMargin | `3` | Indicates the CropBottomMargin. |

### Cr2CropInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage.md

#### Cr2CropInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2CropInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2CropInfoPackage() | Initializes a new instance of the `Cr2CropInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| CropBottomMargin { get; } | Gets the CropBottomMargin. |
| CropLeftMargin { get; } | Gets the CropLeftMargin. |
| CropRightMargin { get; } | Gets the CropRightMargin. |
| CropTopMargin { get; } | Gets the CropTopMargin. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2CropInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/cr2cropinfopackage.md

#### Cr2CropInfoPackage constructor

Initializes a new instance of the `Cr2CropInfoPackage` class.

```csharp
public Cr2CropInfoPackage()
```

### CropBottomMargin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/cropbottommargin.md

#### Cr2CropInfoPackage.CropBottomMargin property

Gets the CropBottomMargin.

```csharp
public ushort CropBottomMargin { get; }
```

##### Property Value

The CropBottomMargin.

### CropLeftMargin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/cropleftmargin.md

#### Cr2CropInfoPackage.CropLeftMargin property

Gets the CropLeftMargin.

```csharp
public ushort CropLeftMargin { get; }
```

##### Property Value

The CropLeftMargin.

### CropRightMargin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/croprightmargin.md

#### Cr2CropInfoPackage.CropRightMargin property

Gets the CropRightMargin.

```csharp
public ushort CropRightMargin { get; }
```

##### Property Value

The CropRightMargin.

### CropTopMargin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/croptopmargin.md

#### Cr2CropInfoPackage.CropTopMargin property

Gets the CropTopMargin.

```csharp
public ushort CropTopMargin { get; }
```

##### Property Value

The CropTopMargin.

### Cr2FileInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfoindex.md

#### Cr2FileInfoIndex enumeration

Defines ids of Cr2FileInfo tags.

```csharp
public enum Cr2FileInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| FileNumberOrShutterCount | `1` | Indicates the FileNumber or ShutterCount. |
| BracketMode | `3` | Indicates the BracketMode. |
| BracketValue | `4` | Indicates the BracketValue. |
| BracketShotNumber | `5` | Indicates the BracketShotNumber. |
| RawJpgQuality | `6` | Indicates the RawJpgQuality. |
| RawJpgSize | `7` | Indicates the RawJpgSize. |
| LongExposureNoiseReduction2 | `8` | Indicates the LongExposureNoiseReduction2. |
| WBBracketMode | `9` | Indicates the WBBracketMode. |
| Unknown2 | `10` | Unknown tag. |
| Unknown3 | `11` | Unknown tag. |
| WBBracketValueAB | `12` | Indicates the WBBracketValueAB. |
| WBBracketValueGM | `13` | Indicates the WBBracketValueGM. |
| FilterEffect | `14` | Indicates the FilterEffect. |
| ToningEffect | `15` | Indicates the ToningEffect. |
| MacroMagnification | `16` | Indicates the MacroMagnification. |
| Unknown4 | `17` | Unknown tag. |
| Unknown5 | `18` | Unknown tag. |
| LiveViewShooting | `19` | Indicates the LiveViewShooting. |
| FocusDistanceUpper | `20` | Indicates the FocusDistanceUpper. |
| FocusDistanceLower | `21` | Indicates the FocusDistanceLower. |
| ShutterMode | `23` | Indicates the ShutterMode. |
| FlashExposureLock | `25` | Indicates the FlashExposureLock. |
| RFLensType | `61` | Indicates the RFLensType. |

### Cr2FileInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage.md

#### Cr2FileInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2FileInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2FileInfoPackage() | Initializes a new instance of the `Cr2FileInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| BracketMode { get; } | Gets the BracketMode. |
| BracketShotNumber { get; } | Gets the BracketShotNumber. |
| BracketValue { get; } | Gets the BracketValue. |
| Count { get; } | Gets the number of metadata properties. |
| FileNumberOrShutterCount { get; } | Gets the FileNumberOrShutterCount. |
| FilterEffect { get; } | Gets the FilterEffect. |
| FlashExposureLock { get; } | Gets the FlashExposureLock. |
| FocusDistanceLower { get; } | Gets the FocusDistanceLower. |
| FocusDistanceUpper { get; } | Gets the FocusDistanceUpper. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LiveViewShooting { get; } | Gets the LiveViewShooting. |
| LongExposureNoiseReduction2 { get; } | Gets the LongExposureNoiseReduction2. |
| MacroMagnification { get; } | Gets the MacroMagnification. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawJpgQuality { get; } | Gets the RawJpgQuality. |
| RawJpgSize { get; } | Gets the RawJpgSize. |
| RFLensType { get; } | Gets the RFLensType. |
| ShutterMode { get; } | Gets the ShutterMode. |
| Size { get; set; } | Gets the Size. |
| ToningEffect { get; } | Gets the ToningEffect. |
| WBBracketMode { get; } | Gets the WBBracketMode. |
| WBBracketValueAB { get; } | Gets the WBBracketValueAB. |
| WBBracketValueGM { get; } | Gets the WBBracketValueGM. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BracketMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracketmode.md

#### Cr2FileInfoPackage.BracketMode property

Gets the BracketMode.

```csharp
public ushort BracketMode { get; }
```

##### Property Value

The BracketMode.

### BracketShotNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracketshotnumber.md

#### Cr2FileInfoPackage.BracketShotNumber property

Gets the BracketShotNumber.

```csharp
public ushort BracketShotNumber { get; }
```

##### Property Value

The BracketShotNumber.

### BracketValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracketvalue.md

#### Cr2FileInfoPackage.BracketValue property

Gets the BracketValue.

```csharp
public ushort BracketValue { get; }
```

##### Property Value

The BracketValue.

### Cr2FileInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/cr2fileinfopackage.md

#### Cr2FileInfoPackage constructor

Initializes a new instance of the `Cr2FileInfoPackage` class.

```csharp
public Cr2FileInfoPackage()
```

### FileNumberOrShutterCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/filenumberorshuttercount.md

#### Cr2FileInfoPackage.FileNumberOrShutterCount property

Gets the FileNumberOrShutterCount.

```csharp
public int FileNumberOrShutterCount { get; }
```

##### Property Value

The FileNumber.

### FilterEffect
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/filtereffect.md

#### Cr2FileInfoPackage.FilterEffect property

Gets the FilterEffect.

```csharp
public ushort FilterEffect { get; }
```

##### Property Value

The FilterEffect.

### FlashExposureLock
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/flashexposurelock.md

#### Cr2FileInfoPackage.FlashExposureLock property

Gets the FlashExposureLock.

```csharp
public ushort FlashExposureLock { get; }
```

##### Property Value

The FlashExposureLock.

### FocusDistanceLower
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/focusdistancelower.md

#### Cr2FileInfoPackage.FocusDistanceLower property

Gets the FocusDistanceLower.

```csharp
public ushort FocusDistanceLower { get; }
```

##### Property Value

The FocusDistanceLower.

### FocusDistanceUpper
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/focusdistanceupper.md

#### Cr2FileInfoPackage.FocusDistanceUpper property

Gets the FocusDistanceUpper.

```csharp
public ushort FocusDistanceUpper { get; }
```

##### Property Value

The FocusDistanceUpper.

### LiveViewShooting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/liveviewshooting.md

#### Cr2FileInfoPackage.LiveViewShooting property

Gets the LiveViewShooting.

```csharp
public ushort LiveViewShooting { get; }
```

##### Property Value

The LiveViewShooting.

### LongExposureNoiseReduction2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/longexposurenoisereduction2.md

#### Cr2FileInfoPackage.LongExposureNoiseReduction2 property

Gets the LongExposureNoiseReduction2.

```csharp
public ushort LongExposureNoiseReduction2 { get; }
```

##### Property Value

The LongExposureNoiseReduction2.

### MacroMagnification
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/macromagnification.md

#### Cr2FileInfoPackage.MacroMagnification property

Gets the MacroMagnification.

```csharp
public ushort MacroMagnification { get; }
```

##### Property Value

The MacroMagnification.

### RawJpgQuality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/rawjpgquality.md

#### Cr2FileInfoPackage.RawJpgQuality property

Gets the RawJpgQuality.

```csharp
public ushort RawJpgQuality { get; }
```

##### Property Value

The RawJpgQuality.

### RawJpgSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/rawjpgsize.md

#### Cr2FileInfoPackage.RawJpgSize property

Gets the RawJpgSize.

```csharp
public ushort RawJpgSize { get; }
```

##### Property Value

The RawJpgSize.

### RFLensType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/rflenstype.md

#### Cr2FileInfoPackage.RFLensType property

Gets the RFLensType.

```csharp
public ushort RFLensType { get; }
```

##### Property Value

The RFLensType.

### ShutterMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/shuttermode.md

#### Cr2FileInfoPackage.ShutterMode property

Gets the ShutterMode.

```csharp
public ushort ShutterMode { get; }
```

##### Property Value

The ShutterMode.

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/size.md

#### Cr2FileInfoPackage.Size property

Gets the Size.

```csharp
public long Size { get; set; }
```

##### Property Value

The Size.

### ToningEffect
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/toningeffect.md

#### Cr2FileInfoPackage.ToningEffect property

Gets the ToningEffect.

```csharp
public ushort ToningEffect { get; }
```

##### Property Value

The ToningEffect.

### WBBracketMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wbbracketmode.md

#### Cr2FileInfoPackage.WBBracketMode property

Gets the WBBracketMode.

```csharp
public ushort WBBracketMode { get; }
```

##### Property Value

The WBBracketMode.

### WBBracketValueAB
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wbbracketvalueab.md

#### Cr2FileInfoPackage.WBBracketValueAB property

Gets the WBBracketValueAB.

```csharp
public ushort WBBracketValueAB { get; }
```

##### Property Value

The WBBracketValueAB.

### WBBracketValueGM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wbbracketvaluegm.md

#### Cr2FileInfoPackage.WBBracketValueGM property

Gets the WBBracketValueGM.

```csharp
public ushort WBBracketValueGM { get; }
```

##### Property Value

The WBBracketValueGM.

### Cr2FilterInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2filterinfoindex.md

#### Cr2FilterInfoIndex enumeration

Defines ids of Cr2FilterInfo tags.

```csharp
public enum Cr2FilterInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| GrainyBWFilter | `257` | Indicates the GrainyBWFilter. |
| SoftFocusFilter | `513` | Indicates the SoftFocusFilter. |
| ToyCameraFilter | `769` | Indicates the ToyCameraFilter. |
| MiniatureFilter | `1025` | Indicates the MiniatureFilter. |
| MiniatureFilterOrientation | `1026` | Indicates the MiniatureFilterOrientation. |
| MiniatureFilterPosition | `1027` | Indicates the MiniatureFilterPosition. |
| MiniatureFilterParameter | `1028` | Indicates the MiniatureFilterParameter. |
| FisheyeFilter | `1281` | Indicates the FisheyeFilter. |
| PaintingFilter | `1537` | Indicates the PaintingFilter. |
| WatercolorFilter | `1793` | Indicates the WatercolorFilter. |

### Cr2FocalLengthIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthindex.md

#### Cr2FocalLengthIndex enumeration

Defines ids of Cr2FocalLength tags.

```csharp
public enum Cr2FocalLengthIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| FocalType | `0` | Indicates the FocalType. |
| FocalLength | `1` | Indicates the FocalLength. |
| FocalPlaneXSize | `2` | Indicates the FocalPlaneXSize. |
| FocalPlaneYSize | `3` | Indicates the FocalPlaneYSize. |

### Cr2FocalLengthPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage.md

#### Cr2FocalLengthPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2FocalLengthPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2FocalLengthPackage() | Initializes a new instance of the `Cr2FocalLengthPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FocalLength { get; } | Gets the FocalLength. |
| FocalPlaneXSize { get; } | Gets the FocalPlaneXSize. |
| FocalPlaneYSize { get; } | Gets the FocalPlaneYSize. |
| FocalType { get; } | Gets the FocalType. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2FocalLengthPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/cr2focallengthpackage.md

#### Cr2FocalLengthPackage constructor

Initializes a new instance of the `Cr2FocalLengthPackage` class.

```csharp
public Cr2FocalLengthPackage()
```

### FocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focallength.md

#### Cr2FocalLengthPackage.FocalLength property

Gets the FocalLength.

```csharp
public ushort FocalLength { get; }
```

##### Property Value

The FocalLength.

### FocalPlaneXSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focalplanexsize.md

#### Cr2FocalLengthPackage.FocalPlaneXSize property

Gets the FocalPlaneXSize.

```csharp
public ushort FocalPlaneXSize { get; }
```

##### Property Value

The FocalPlaneXSize.

### FocalPlaneYSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focalplaneysize.md

#### Cr2FocalLengthPackage.FocalPlaneYSize property

Gets the FocalPlaneYSize.

```csharp
public ushort FocalPlaneYSize { get; }
```

##### Property Value

The FocalPlaneYSize.

### FocalType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focaltype.md

#### Cr2FocalLengthPackage.FocalType property

Gets the FocalType.

```csharp
public ushort FocalType { get; }
```

##### Property Value

The FocalType.

### Cr2Functions1DIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dindex.md

#### Cr2Functions1DIndex enumeration

Defines ids of Cr2Functions1D tags.

```csharp
public enum Cr2Functions1DIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| FocusingScreen | `0` | Indicates the FocusingScreen. |
| FinderDisplayDuringExposure | `1` | Indicates the FinderDisplayDuringExposure. |
| ShutterReleaseNoCFCard | `2` | Indicates the ShutterReleaseNoCFCard. |
| ISOSpeedExpansion | `3` | Indicates the ISOSpeedExpansion. |
| ShutterAELButton | `4` | Indicates the ShutterAELButton. |
| ManualTv | `5` | Indicates the ManualTv. |
| ExposureLevelIncrements | `6` | Indicates the ExposureLevelIncrements. |
| USMLensElectronicMF | `7` | Indicates the USMLensElectronicMF. |
| LCDPanels | `8` | Indicates the LCDPanels. |
| AEBSequenceAutoCancel | `9` | Indicates the AEBSequenceAutoCancel. |
| AFPointIllumination | `10` | Indicates the AFPointIllumination. |
| AFPointSelection | `11` | Indicates the AFPointSelection. |
| MirrorLockup | `12` | Indicates the MirrorLockup. |
| AFPointSpotMetering | `13` | Indicates the AFPointSpotMetering. |
| FillFlashAutoReduction | `14` | Indicates the FillFlashAutoReduction. |
| ShutterCurtainSync | `15` | Indicates the ShutterCurtainSync. |
| SafetyShiftInAvOrTv | `16` | Indicates the SafetyShiftInAvOrTv. |
| AFPointActivationArea | `17` | Indicates the AFPointActivationArea. |
| SwitchToRegisteredAFPoint | `18` | Indicates the SwitchToRegisteredAFPoint. |
| LensAFStopButton | `19` | Indicates the LensAFStopButton. |
| AIServoTrackingSensitivity | `20` | Indicates the AIServoTrackingSensitivity. |
| AIServoContinuousShooting | `21` | Indicates the AIServoContinuousShooting. |

### Cr2Functions1DPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage.md

#### Cr2Functions1DPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2Functions1DPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2Functions1DPackage() | Initializes a new instance of the `Cr2Functions1DPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AEBSequenceAutoCancel { get; } | Gets the AEBSequenceAutoCancel. |
| AFPointActivationArea { get; } | Gets the AFPointActivationArea. |
| AFPointIllumination { get; } | Gets the AFPointIllumination. |
| AFPointSelection { get; } | Gets the AFPointSelection. |
| AFPointSpotMetering { get; } | Gets the AFPointSpotMetering. |
| AIServoContinuousShooting { get; } | Gets the AIServoContinuousShooting. |
| AIServoTrackingSensitivity { get; } | Gets the AIServoTrackingSensitivity. |
| Count { get; } | Gets the number of metadata properties. |
| ExposureLevelIncrements { get; } | Gets the ExposureLevelIncrements. |
| FillFlashAutoReduction { get; } | Gets the FillFlashAutoReduction. |
| FinderDisplayDuringExposure { get; } | Gets the FinderDisplayDuringExposure. |
| FocusingScreen { get; } | Gets the FocusingScreen. |
| ISOSpeedExpansion { get; } | Gets the ISOSpeedExpansion. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LCDPanels { get; } | Gets the LCDPanels. |
| LensAFStopButton { get; } | Gets the LensAFStopButton. |
| ManualTv { get; } | Gets the ManualTv. |
| MetadataType { get; } | Gets the metadata type. |
| MirrorLockup { get; } | Gets the MirrorLockup. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SafetyShiftInAvOrTv { get; } | Gets the SafetyShiftInAvOrTv. |
| ShutterAELButton { get; } | Gets the ShutterAELButton. |
| ShutterCurtainSync { get; } | Gets the ShutterCurtainSync. |
| ShutterReleaseNoCFCard { get; } | Gets the ShutterReleaseNoCFCard. |
| SwitchToRegisteredAFPoint { get; } | Gets the SwitchToRegisteredAFPoint. |
| USMLensElectronicMF { get; } | Gets the USMLensElectronicMF. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AEBSequenceAutoCancel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/aebsequenceautocancel.md

#### Cr2Functions1DPackage.AEBSequenceAutoCancel property

Gets the AEBSequenceAutoCancel.

```csharp
public ushort AEBSequenceAutoCancel { get; }
```

##### Property Value

The AEBSequenceAutoCancel.

### AFPointActivationArea
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/afpointactivationarea.md

#### Cr2Functions1DPackage.AFPointActivationArea property

Gets the AFPointActivationArea.

```csharp
public ushort AFPointActivationArea { get; }
```

##### Property Value

The AFPointActivationArea.

### AFPointIllumination
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/afpointillumination.md

#### Cr2Functions1DPackage.AFPointIllumination property

Gets the AFPointIllumination.

```csharp
public ushort AFPointIllumination { get; }
```

##### Property Value

The AFPointIllumination.

### AFPointSelection
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/afpointselection.md

#### Cr2Functions1DPackage.AFPointSelection property

Gets the AFPointSelection.

```csharp
public ushort AFPointSelection { get; }
```

##### Property Value

The AFPointSelection.

### AFPointSpotMetering
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/afpointspotmetering.md

#### Cr2Functions1DPackage.AFPointSpotMetering property

Gets the AFPointSpotMetering.

```csharp
public ushort AFPointSpotMetering { get; }
```

##### Property Value

The AFPointSpotMetering.

### AIServoContinuousShooting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/aiservocontinuousshooting.md

#### Cr2Functions1DPackage.AIServoContinuousShooting property

Gets the AIServoContinuousShooting.

```csharp
public ushort AIServoContinuousShooting { get; }
```

##### Property Value

The AIServoContinuousShooting.

### AIServoTrackingSensitivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/aiservotrackingsensitivity.md

#### Cr2Functions1DPackage.AIServoTrackingSensitivity property

Gets the AIServoTrackingSensitivity.

```csharp
public ushort AIServoTrackingSensitivity { get; }
```

##### Property Value

The AIServoTrackingSensitivity.

### Cr2Functions1DPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/cr2functions1dpackage.md

#### Cr2Functions1DPackage constructor

Initializes a new instance of the `Cr2Functions1DPackage` class.

```csharp
public Cr2Functions1DPackage()
```

### ExposureLevelIncrements
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/exposurelevelincrements.md

#### Cr2Functions1DPackage.ExposureLevelIncrements property

Gets the ExposureLevelIncrements.

```csharp
public ushort ExposureLevelIncrements { get; }
```

##### Property Value

The ExposureLevelIncrements.

### FillFlashAutoReduction
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/fillflashautoreduction.md

#### Cr2Functions1DPackage.FillFlashAutoReduction property

Gets the FillFlashAutoReduction.

```csharp
public ushort FillFlashAutoReduction { get; }
```

##### Property Value

The FillFlashAutoReduction.

### FinderDisplayDuringExposure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/finderdisplayduringexposure.md

#### Cr2Functions1DPackage.FinderDisplayDuringExposure property

Gets the FinderDisplayDuringExposure.

```csharp
public ushort FinderDisplayDuringExposure { get; }
```

##### Property Value

The FinderDisplayDuringExposure.

### FocusingScreen
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/focusingscreen.md

#### Cr2Functions1DPackage.FocusingScreen property

Gets the FocusingScreen.

```csharp
public ushort FocusingScreen { get; }
```

##### Property Value

The FocusingScreen.

### ISOSpeedExpansion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/isospeedexpansion.md

#### Cr2Functions1DPackage.ISOSpeedExpansion property

Gets the ISOSpeedExpansion.

```csharp
public ushort ISOSpeedExpansion { get; }
```

##### Property Value

The ISOSpeedExpansion.

### LCDPanels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/lcdpanels.md

#### Cr2Functions1DPackage.LCDPanels property

Gets the LCDPanels.

```csharp
public ushort LCDPanels { get; }
```

##### Property Value

The LCDPanels.

### LensAFStopButton
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/lensafstopbutton.md

#### Cr2Functions1DPackage.LensAFStopButton property

Gets the LensAFStopButton.

```csharp
public ushort LensAFStopButton { get; }
```

##### Property Value

The LensAFStopButton.

### ManualTv
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/manualtv.md

#### Cr2Functions1DPackage.ManualTv property

Gets the ManualTv.

```csharp
public ushort ManualTv { get; }
```

##### Property Value

The ManualTv.

### MirrorLockup
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/mirrorlockup.md

#### Cr2Functions1DPackage.MirrorLockup property

Gets the MirrorLockup.

```csharp
public ushort MirrorLockup { get; }
```

##### Property Value

The MirrorLockup.

### SafetyShiftInAvOrTv
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/safetyshiftinavortv.md

#### Cr2Functions1DPackage.SafetyShiftInAvOrTv property

Gets the SafetyShiftInAvOrTv.

```csharp
public ushort SafetyShiftInAvOrTv { get; }
```

##### Property Value

The SafetyShiftInAvOrTv.

### ShutterAELButton
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shutteraelbutton.md

#### Cr2Functions1DPackage.ShutterAELButton property

Gets the ShutterAELButton.

```csharp
public ushort ShutterAELButton { get; }
```

##### Property Value

The ShutterAELButton.

### ShutterCurtainSync
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shuttercurtainsync.md

#### Cr2Functions1DPackage.ShutterCurtainSync property

Gets the ShutterCurtainSync.

```csharp
public ushort ShutterCurtainSync { get; }
```

##### Property Value

The ShutterCurtainSync.

### ShutterReleaseNoCFCard
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shutterreleasenocfcard.md

#### Cr2Functions1DPackage.ShutterReleaseNoCFCard property

Gets the ShutterReleaseNoCFCard.

```csharp
public ushort ShutterReleaseNoCFCard { get; }
```

##### Property Value

The ShutterReleaseNoCFCard.

### SwitchToRegisteredAFPoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/switchtoregisteredafpoint.md

#### Cr2Functions1DPackage.SwitchToRegisteredAFPoint property

Gets the SwitchToRegisteredAFPoint.

```csharp
public ushort SwitchToRegisteredAFPoint { get; }
```

##### Property Value

The SwitchToRegisteredAFPoint.

### USMLensElectronicMF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/usmlenselectronicmf.md

#### Cr2Functions1DPackage.USMLensElectronicMF property

Gets the USMLensElectronicMF.

```csharp
public ushort USMLensElectronicMF { get; }
```

##### Property Value

The USMLensElectronicMF.

### Cr2Functions2Index
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2functions2index.md

#### Cr2Functions2Index enumeration

Defines ids of Cr2Functions2 tags.

```csharp
public enum Cr2Functions2Index
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| ExposureLevelIncrements | `257` | Indicates the ExposureLevelIncrements. |
| ISOSpeedIncrements | `258` | Indicates the ISOSpeedIncrements. |
| ISOSpeedRange | `259` | Indicates the ISOSpeedRange. |
| AEBAutoCancel | `260` | Indicates the AEBAutoCancel. |
| AEBSequence | `261` | Indicates the AEBSequence. |
| AEBShotCount | `262` | Indicates the AEBShotCount. |
| SpotMeterLinkToAFPoint | `263` | Indicates the SpotMeterLinkToAFPoint. |
| SafetyShift | `264` | Indicates the SafetyShift. |
| UsableShootingModes | `265` | Indicates the UsableShootingModes. |
| UsableMeteringModes | `266` | Indicates the UsableMeteringModes. |
| ExposureModeInManual | `267` | Indicates the ExposureModeInManual. |
| ShutterSpeedRange | `268` | Indicates the ShutterSpeedRange. |
| ApertureRange | `269` | Indicates the ApertureRange. |
| ApplyShootingMeteringMode | `270` | Indicates the ApplyShootingMeteringMode. |
| FlashSyncSpeedAv | `271` | Indicates the FlashSyncSpeedAv. |
| AEMicroadjustment | `272` | Indicates the AEMicroadjustment. |
| FEMicroadjustment | `273` | Indicates the FEMicroadjustment. |
| SameExposureForNewAperture | `274` | Indicates the SameExposureForNewAperture. |
| ExposureCompAutoCancel | `275` | Indicates the ExposureCompAutoCancel. |
| AELockMeterModeAfterFocus | `276` | Indicates the AELockMeterModeAfterFocus. |
| Unknown2 | `277` | Unknown tag. |
| LongExposureNoiseReduction | `513` | Indicates the LongExposureNoiseReduction. |
| HighISONoiseReduction | `514` | Indicates the HighISONoiseReduction. |
| HighlightTonePriority | `515` | Indicates the HighlightTonePriority. |
| AutoLightingOptimizer | `516` | Indicates the AutoLightingOptimizer. |
| ETTLII | `772` | Indicates the ETTLII. |
| ShutterCurtainSync | `773` | Indicates the ShutterCurtainSync. |
| FlashFiring | `774` | Indicates the FlashFiring. |
| ViewInfoDuringExposure | `1031` | Indicates the ViewInfoDuringExposure. |
| LCDIlluminationDuringBulb | `1032` | Indicates the LCDIlluminationDuringBulb. |
| InfoButtonWhenShooting | `1033` | Indicates the InfoButtonWhenShooting. |
| ViewfinderWarnings | `1034` | Indicates the ViewfinderWarnings. |
| LVShootingAreaDisplay | `1035` | Indicates the LVShootingAreaDisplay. |
| LVShootingAreaDisplay2 | `1036` | Indicates the LVShootingAreaDisplay2. |
| Unknown3 | `1280` | Unknown tag. |
| USMLensElectronicMF | `1281` | Indicates the USMLensElectronicMF. |
| AIServoTrackingSensitivity | `1282` | Indicates the AIServoTrackingSensitivity. |
| AIServoImagePriority | `1283` | Indicates the AIServoImagePriority. |
| AIServoTrackingMethod | `1284` | Indicates the AIServoTrackingMethod. |
| LensDriveNoAF | `1285` | Indicates the LensDriveNoAF. |
| LensAFStopButton | `1286` | Indicates the LensAFStopButton. |
| AFMicroadjustment | `1287` | Indicates the AFMicroadjustment. |
| AFPointAreaExpansion | `1288` | Indicates the AFPointAreaExpansion. |
| SelectableAFPoint | `1289` | Indicates the SelectableAFPoint. |
| SwitchToRegisteredAFPoint | `1290` | Indicates the SwitchToRegisteredAFPoint. |
| AFPointAutoSelection | `1291` | Indicates the AFPointAutoSelection. |
| AFPointDisplayDuringFocus | `1292` | Indicates the AFPointDisplayDuringFocus. |
| AFPointBrightness | `1293` | Indicates the AFPointBrightness. |
| AFAssistBeam | `1294` | Indicates the AFAssistBeam. |
| AFPointSelectionMethod | `1295` | Indicates the AFPointSelectionMethod. |
| AFDuringLiveView | `1297` | Indicates the AFDuringLiveView. |
| SelectAFAreaSelectMode | `1298` | Indicates the SelectAFAreaSelectMode. |
| ManualAFPointSelectPattern | `1299` | Indicates the ManualAFPointSelectPattern. |
| DisplayAllAFPoints | `1300` | Indicates the DisplayAllAFPoints. |
| FocusDisplayAIServoAndMF | `1301` | Indicates the FocusDisplayAIServoAndMF. |
| OrientationLinkedAFPoint | `1302` | Indicates the OrientationLinkedAFPoint. |
| MultiControllerWhileMetering | `1303` | Indicates the MultiControllerWhileMetering. |
| AccelerationTracking | `1304` | Indicates the AccelerationTracking. |
| AIServoFirstImagePriority | `1305` | Indicates the AIServoFirstImagePriority. |
| AIServoSecondImagePriority | `1306` | Indicates the AIServoSecondImagePriority. |
| AFAreaSelectMethod | `1307` | Indicates the AFAreaSelectMethod. |
| AutoAFPointColorTracking | `1308` | Indicates the AutoAFPointColorTracking. |
| VFDisplayIllumination | `1309` | Indicates the VFDisplayIllumination. |
| InitialAFPointAIServoAF | `1310` | Indicates the InitialAFPointAIServoAF. |
| MirrorLockup | `1551` | Indicates the MirrorLockup. |
| ContinuousShootingSpeed | `1552` | Indicates the ContinuousShootingSpeed. |
| ContinuousShotLimit | `1553` | Indicates the ContinuousShotLimit. |
| RestrictDriveModes | `1554` | Indicates the RestrictDriveModes. |
| ShutterAELock | `1793` | Indicates the ShutterAELock. |
| AFOnAELockButtonSwitch | `1794` | Indicates the AFOnAELockButtonSwitch. |
| QuickControlDialInMeter | `1795` | Indicates the QuickControlDialInMeter. |
| SetButtonWhenShooting | `1796` | Indicates the SetButtonWhenShooting. |
| ManualTv | `1797` | Indicates the ManualTv. |
| DialDirectionTvAv | `1798` | Indicates the DialDirectionTvAv. |
| AvSettingWithoutLens | `1799` | Indicates the AvSettingWithoutLens. |
| WBMediaImageSizeSetting | `1800` | Indicates the WBMediaImageSizeSetting. |
| LockMicrophoneButton | `1801` | Indicates the LockMicrophoneButton. |
| ButtonFunctionControlOff | `1802` | Indicates the ButtonFunctionControlOff. |
| AssignFuncButton | `1803` | Indicates the AssignFuncButton. |
| CustomControls | `1804` | Indicates the CustomControls. |
| StartMovieShooting | `1805` | Indicates the StartMovieShooting. |
| FlashButtonFunction | `1806` | Indicates the FlashButtonFunction. |
| MultiFunctionLock | `1807` | Indicates the MultiFunctionLock. |
| TrashButtonFunction | `1808` | Indicates the TrashButtonFunction. |
| ShutterReleaseWithoutLens | `1809` | Indicates the ShutterReleaseWithoutLens. |
| ControlRingRotation | `1810` | Indicates the ControlRingRotation. |
| FocusRingRotation | `1811` | Indicates the FocusRingRotation. |
| RFLensMFFocusRingSensitivity | `1812` | Indicates the RFLensMFFocusRingSensitivity. |
| CustomizeDials | `1813` | Indicates the CustomizeDials. |
| FocusingScreen | `2059` | Indicates the FocusingScreen. |
| TimerLength | `2060` | Indicates the TimerLength. |
| ShortReleaseTimeLag | `2061` | Indicates the ShortReleaseTimeLag. |
| AddAspectRatioInfo | `2062` | Indicates the AddAspectRatioInfo. |
| AddOriginalDecisionData | `2063` | Indicates the AddOriginalDecisionData. |
| LiveViewExposureSimulation | `2064` | Indicates the LiveViewExposureSimulation. |
| LCDDisplayAtPowerOn | `2065` | Indicates the LCDDisplayAtPowerOn. |
| MemoAudioQuality | `2066` | Indicates the MemoAudioQuality. |
| DefaultEraseOption | `2067` | Indicates the DefaultEraseOption. |
| RetractLensOnPowerOff | `2068` | Indicates the RetractLensOnPowerOff. |
| AddIPTCInformation | `2069` | Indicates the AddIPTCInformation. |
| AudioCompression | `2070` | Indicates the AudioCompression. |

### Cr2LightingOptIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptindex.md

#### Cr2LightingOptIndex enumeration

Defines ids of Cr2LightingOpt tags.

```csharp
public enum Cr2LightingOptIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| PeripheralIlluminationCorr | `1` | Indicates the PeripheralIlluminationCorr. |
| AutoLightingOptimizer | `2` | Indicates the AutoLightingOptimizer. |
| HighlightTonePriority | `3` | Indicates the HighlightTonePriority. |
| LongExposureNoiseReduction | `4` | Indicates the LongExposureNoiseReduction. |
| HighISONoiseReduction | `5` | Indicates the HighISONoiseReduction. |
| DigitalLensOptimizer | `10` | Indicates the DigitalLensOptimizer. |

### Cr2LightingOptPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage.md

#### Cr2LightingOptPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2LightingOptPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2LightingOptPackage() | Initializes a new instance of the `Cr2LightingOptPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoLightingOptimizer { get; } | Gets the AutoLightingOptimizer. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalLensOptimizer { get; } | Gets the DigitalLensOptimizer. |
| HighISONoiseReduction { get; } | Gets the HighISONoiseReduction. |
| HighlightTonePriority { get; } | Gets the HighlightTonePriority. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LongExposureNoiseReduction { get; } | Gets the LongExposureNoiseReduction. |
| MetadataType { get; } | Gets the metadata type. |
| PeripheralIlluminationCorr { get; } | Gets the PeripheralIlluminationCorr. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Size { get; set; } | Gets the Size. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AutoLightingOptimizer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/autolightingoptimizer.md

#### Cr2LightingOptPackage.AutoLightingOptimizer property

Gets the AutoLightingOptimizer.

```csharp
public int AutoLightingOptimizer { get; }
```

##### Property Value

The AutoLightingOptimizer.

### Cr2LightingOptPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/cr2lightingoptpackage.md

#### Cr2LightingOptPackage constructor

Initializes a new instance of the `Cr2LightingOptPackage` class.

```csharp
public Cr2LightingOptPackage()
```

### DigitalLensOptimizer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/digitallensoptimizer.md

#### Cr2LightingOptPackage.DigitalLensOptimizer property

Gets the DigitalLensOptimizer.

```csharp
public int DigitalLensOptimizer { get; }
```

##### Property Value

The DigitalLensOptimizer.

### HighISONoiseReduction
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/highisonoisereduction.md

#### Cr2LightingOptPackage.HighISONoiseReduction property

Gets the HighISONoiseReduction.

```csharp
public int HighISONoiseReduction { get; }
```

##### Property Value

The HighISONoiseReduction.

### HighlightTonePriority
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/highlighttonepriority.md

#### Cr2LightingOptPackage.HighlightTonePriority property

Gets the HighlightTonePriority.

```csharp
public int HighlightTonePriority { get; }
```

##### Property Value

The HighlightTonePriority.

### LongExposureNoiseReduction
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/longexposurenoisereduction.md

#### Cr2LightingOptPackage.LongExposureNoiseReduction property

Gets the LongExposureNoiseReduction.

```csharp
public int LongExposureNoiseReduction { get; }
```

##### Property Value

The LongExposureNoiseReduction.

### PeripheralIlluminationCorr
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/peripheralilluminationcorr.md

#### Cr2LightingOptPackage.PeripheralIlluminationCorr property

Gets the PeripheralIlluminationCorr.

```csharp
public int PeripheralIlluminationCorr { get; }
```

##### Property Value

The PeripheralIlluminationCorr.

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/size.md

#### Cr2LightingOptPackage.Size property

Gets the Size.

```csharp
public long Size { get; set; }
```

##### Property Value

The Size.

### Cr2LogInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfoindex.md

#### Cr2LogInfoIndex enumeration

Defines ids of Cr2LogInfo tags.

```csharp
public enum Cr2LogInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| CompressionFormat | `4` | Indicates the CompressionFormat. |
| Sharpness | `6` | Indicates the Sharpness. |
| Saturation | `7` | Indicates the Saturation. |
| ColorTone | `8` | Indicates the ColorTone. |
| ColorSpace2 | `9` | Indicates the ColorSpace2. |
| ColorMatrix | `10` | Indicates the ColorMatrix. |
| CanonLogVersion | `11` | Indicates the CanonLogVersion. |

### Cr2LogInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage.md

#### Cr2LogInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2LogInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2LogInfoPackage() | Initializes a new instance of the `Cr2LogInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| CanonLogVersion { get; } | Gets the CanonLogVersion. |
| ColorMatrix { get; } | Gets the ColorMatrix. |
| ColorSpace2 { get; } | Gets the ColorSpace2. |
| ColorTone { get; } | Gets the ColorTone. |
| CompressionFormat { get; } | Gets the CompressionFormat. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Saturation { get; } | Gets the Saturation. |
| Sharpness { get; } | Gets the Sharpness. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CanonLogVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/canonlogversion.md

#### Cr2LogInfoPackage.CanonLogVersion property

Gets the CanonLogVersion.

```csharp
public int CanonLogVersion { get; }
```

##### Property Value

The CanonLogVersion.

### ColorMatrix
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/colormatrix.md

#### Cr2LogInfoPackage.ColorMatrix property

Gets the ColorMatrix.

```csharp
public int ColorMatrix { get; }
```

##### Property Value

The ColorMatrix.

### ColorSpace2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/colorspace2.md

#### Cr2LogInfoPackage.ColorSpace2 property

Gets the ColorSpace2.

```csharp
public int ColorSpace2 { get; }
```

##### Property Value

The ColorSpace2.

### ColorTone
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/colortone.md

#### Cr2LogInfoPackage.ColorTone property

Gets the ColorTone.

```csharp
public int ColorTone { get; }
```

##### Property Value

The ColorTone.

### CompressionFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/compressionformat.md

#### Cr2LogInfoPackage.CompressionFormat property

Gets the CompressionFormat.

```csharp
public int CompressionFormat { get; }
```

##### Property Value

The CompressionFormat.

### Cr2LogInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/cr2loginfopackage.md

#### Cr2LogInfoPackage constructor

Initializes a new instance of the `Cr2LogInfoPackage` class.

```csharp
public Cr2LogInfoPackage()
```

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/saturation.md

#### Cr2LogInfoPackage.Saturation property

Gets the Saturation.

```csharp
public int Saturation { get; }
```

##### Property Value

The Saturation.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/sharpness.md

#### Cr2LogInfoPackage.Sharpness property

Gets the Sharpness.

```csharp
public int Sharpness { get; }
```

##### Property Value

The Sharpness.

### Cr2MakerNoteIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernoteindex.md

#### Cr2MakerNoteIndex enumeration

Defines ids of Cr2MakerNote tags.

```csharp
public enum Cr2MakerNoteIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| CameraSettings | `1` | Indicates the CameraSettings. |
| FocalLength | `2` | Indicates the FocalLength. |
| ShotInfo | `4` | Indicates the ShotInfo. |
| Panorama | `5` | Indicates the Panorama. |
| ImageType | `6` | Indicates the ImageType. |
| FirmwareVersion | `7` | Indicates the FirmwareVersion. |
| FileNumber | `8` | Indicates the FileNumber. |
| OwnerName | `9` | Indicates the OwnerName. |
| SerialNumber | `12` | Indicates the SerialNumber. |
| CameraInfo | `13` | Indicates the CameraInfo. |
| FileLength | `14` | Indicates the FileLength. |
| CustomFunctions | `15` | Indicates the CustomFunctions. |
| ModelID | `16` | Indicates the ModelID. |
| MovieInfo | `17` | Indicates the MovieInfo. |
| CanonAFInfo | `18` | Indicates the CanonAFInfo. |
| ThumbnailImageValidArea | `19` | Indicates the ThumbnailImageValidArea. |
| SerialNumberFormat | `21` | Indicates the SerialNumberFormat. |
| SuperMacro | `26` | Indicates the SuperMacro. |
| DateStampMode | `28` | Indicates the DateStampMode. |
| MyColors | `29` | Indicates the MyColors. |
| Categories | `35` | Indicates the Categories. |
| FaceDetect1 | `36` | Indicates the FaceDetect1. |
| FaceDetect2 | `37` | Indicates the FaceDetect2. |
| CanonAFInfo2 | `38` | Indicates the CanonAFInfo2. |
| ContrastInfo | `39` | Indicates the ContrastInfo. |
| ImageUniqueID | `40` | Indicates the ImageUniqueID. |
| WBInfo | `41` | Indicates the WBInfo. |
| FaceDetect3 | `47` | Indicates the FaceDetect3. |
| TimeInfo | `53` | Indicates the TimeInfo. |
| BatteryType | `56` | Indicates the BatteryType. |
| AFInfo3 | `60` | Indicates the AFInfo3. |
| RawDataOffset | `129` | Indicates the RawDataOffset. |
| OriginalDecisionDataOffset | `131` | Indicates the OriginalDecisionDataOffset. |
| CustomFunctions1D | `144` | Indicates the CustomFunctions1D. |
| PersonalFunctions | `145` | Indicates the PersonalFunctions. |
| PersonalFunctionValues | `146` | Indicates the PersonalFunctionValues. |
| CanonFileInfo | `147` | Indicates the CanonFileInfo. |
| AFPointsInFocus1D | `148` | Indicates the AFPointsInFocus1D. |
| LensModel | `149` | Indicates the LensModel. |
| SerialInfo | `150` | Indicates the SerialInfo. |
| DustRemovalData | `151` | Indicates the DustRemovalData. |
| CropInfo | `152` | Indicates the CropInfo. |
| CustomFunctions2 | `153` | Indicates the CustomFunctions2. |
| AspectInfo | `154` | Indicates the AspectInfo. |
| ProcessingInfo | `160` | Indicates the ProcessingInfo. |
| ToneCurveTable | `161` | Indicates the ToneCurveTable. |
| SharpnessTable | `162` | Indicates the SharpnessTable. |
| SharpnessFreqTable | `163` | Indicates the SharpnessFreqTable. |
| WhiteBalanceTable | `164` | Indicates the WhiteBalanceTable. |
| ColorBalance | `169` | Indicates the ColorBalance. |
| MeasuredColor | `170` | Indicates the MeasuredColor. |
| ColorTemperature | `174` | Indicates the ColorTemperature. |
| CanonFlags | `176` | Indicates the CanonFlags. |
| ModifiedInfo | `177` | Indicates the ModifiedInfo. |
| ToneCurveMatching | `178` | Indicates the ToneCurveMatching. |
| WhiteBalanceMatching | `179` | Indicates the WhiteBalanceMatching. |
| ColorSpace | `180` | Indicates the ColorSpace. |
| PreviewImageInfo | `182` | Indicates the PreviewImageInfo. |
| VRDOffset | `208` | Indicates the VRDOffset. |
| SensorInfo | `224` | Indicates the SensorInfo. |
| ColorData1 | `16385` | Indicates the ColorData1. |
| CRWParam | `16386` | Indicates the CRWParam. |
| ColorInfo | `16387` | Indicates the ColorInfo. |
| Flavor | `16389` | Indicates the Flavor. |
| PictureStyleUserDef | `16392` | Indicates the PictureStyleUserDef. |
| PictureStylePC | `16393` | Indicates the PictureStylePC. |
| CustomPictureStyleFileName | `16400` | Indicates the CustomPictureStyleFileName. |
| AFMicroAdj | `16403` | Indicates the AFMicroAdj. |
| VignettingCorr | `16405` | Indicates the VignettingCorr. |
| VignettingCorr2 | `16406` | Indicates the VignettingCorr2. |
| LightingOpt | `16408` | Indicates the LightingOpt. |
| LensInfo | `16409` | Indicates the LensInfo. |
| AmbienceInfo | `16416` | Indicates the AmbienceInfo. |
| MultiExp | `16417` | Indicates the MultiExp. |
| FilterInfo | `16420` | Indicates the FilterInfo. |
| HDRInfo | `16421` | Indicates the HDRInfo. |
| LogInfo | `16422` | Indicates the LogInfo. |
| AFConfig | `16424` | Indicates the AFConfig. |
| RawBurstModeRoll | `16447` | Indicates the RawBurstModeRoll. |

### Cr2MakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage.md

#### Cr2MakerNotePackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2MakerNotePackage : RawMakerNotePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2MakerNotePackage() | Initializes a new instance of the `Cr2MakerNotePackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AmbienceInfo { get; set; } | Gets the LensInfo. |
| CameraInfo { get; set; } | Gets the CameraInfo. |
| CameraSettings { get; set; } | Gets the CanonCameraSettings Offset. |
| CanonFlags { get; set; } | Gets the CanonFlags. |
| Categories { get; set; } | Gets the Categories. |
| ColorData1 { get; set; } | Gets the ColorData1. |
| ColorSpace { get; set; } | Gets the ColorSpace. |
| ColorTemperature { get; set; } | Gets the ColorTemperature. |
| ContrastInfo { get; set; } | Gets the ContrastInfo. |
| Count { get; } | Gets the number of metadata properties. |
| Cr2AFConfig { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2AFConfigPackage { get; set; } | Gets the AFConfig. |
| Cr2AFInfo2 { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2AFInfo2Package { get; set; } | Gets the AFInfo3 (Newer version of the AFInfo record). |
| Cr2AFInfo3 { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2AFInfo3Package { get; set; } | Gets the AFInfo3. |
| Cr2AFMicroAdj { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2AFMicroAdjPackage { get; set; } | Gets the AFMicroAdj. |
| Cr2AspectInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2AspectInfoPackage { get; set; } | Gets the AspectInfo. |
| Cr2CameraSettingsPackage { get; set; } | Gets the CanonCameraSettings. |
| Cr2ColorBalance { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2ColorBalancePackage { get; set; } | Gets the ColorBalance (These tags are used by the 10D and 300D.). |
| Cr2ColorInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2ColorInfoPackage { get; set; } | Gets the ColorInfo. |
| Cr2CropInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2CropInfoPackage { get; set; } | Gets the CropInfo. |
| Cr2FileInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2FileInfoPackage { get; set; } | Not used in this version. Gets the CanonFileInfo. |
| Cr2FocalLength { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2FocalLengthPackage { get; set; } | Gets the CanonFocalLength. |
| Cr2Functions1D { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2Functions1DPackage { get; set; } | Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| Cr2LightingOpt { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2LightingOptPackage { get; set; } | Gets the LightingOpt (This information is new in images from the EOS 7D.). |
| Cr2LogInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2LogInfoPackage { get; set; } | Gets the LogInfo. |
| Cr2ModifiedInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2ModifiedInfoPackage { get; set; } | Gets the MeasuredColor. |
| Cr2MovieInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2MovieInfoPackage { get; set; } | Gets the MovieInfo (Tags written by some Canon cameras when recording video). |
| Cr2MultiExp { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2MultiExpPackage { get; set; } | Gets the MultiExp. |
| Cr2Panorama { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2PanoramaPackage { get; set; } | Gets the CanonPanorama. |
| Cr2PersonalFuncs { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2PersonalFuncsPackage { get; set; } | Gets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| Cr2PersonalFuncValues { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2PersonalFuncValuesPackage { get; set; } | Gets the PersonalFunctionValues. |
| Cr2Processing { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2ProcessingPackage { get; set; } | Gets the ProcessingInfo. |
| Cr2SensorInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2SensorInfoPackage { get; set; } | Gets the SensorInfo. |
| Cr2ShotInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2ShotInfoPackage { get; set; } | Gets the CanonShotInfo. |
| Cr2TimeInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2TimeInfoPackage { get; set; } | Gets the TimeInfo. |
| Cr2WBInfo { get; set; } | Gets the CanonCameraSettings Offset. |
| Cr2WBInfoPackage { get; set; } | Gets the WBInfo (WB tags for the Canon G9). |
| CustomFunctions { get; set; } | Gets the CustomFunctions. |
| CustomPictureStyleFileName { get; set; } | Gets the CustomPictureStyleFileName. |
| DateStampMode { get; set; } | Gets the DateStampMode. |
| FaceDetect1 { get; set; } | Gets the FaceDetect1. |
| FaceDetect2 { get; set; } | Gets the FaceDetect2. |
| FaceDetect3 { get; set; } | Gets the FaceDetect3. |
| FileLength { get; set; } | Gets the FileLength. |
| FileNumber { get; set; } | Gets the FileNumber. |
| FirmwareVersion { get; set; } | Gets the FirmwareVersion. |
| HDRInfo { get; set; } | Gets the HDRInfo. |
| ImageType { get; set; } | Gets the ImageType. |
| ImageUniqueID { get; set; } | Gets the ImageUniqueID. |
| InternalSerialNumber { get; set; } | Gets the InternalSerialNumber. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensInfo { get; set; } | Gets the LensInfo. |
| LensModel { get; set; } | Gets the LensModel. |
| MeasuredColor { get; set; } | Gets the MeasuredColor. |
| MetadataType { get; } | Gets the metadata type. |
| ModelID { get; set; } | Gets the ModelID. |
| MyColors { get; set; } | Gets the MyColors. |
| OriginalDecisionDataOffset { get; set; } | Gets the OriginalDecisionDataOffset. |
| OwnerName { get; set; } | Gets the OwnerName. |
| PictureStylePC { get; set; } | Gets the PictureStylePC. |
| PictureStyleUserDef { get; set; } | Gets the PictureStyleUserDef. |
| PreviewImageInfo { get; set; } | Gets the PreviewImageInfo. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawBurstModeRoll { get; set; } | Gets the RawBurstModeRoll. |
| SerialNumber { get; set; } | Gets the SerialNumber. |
| SerialNumberFormat { get; set; } | Gets the SerialNumberFormat. |
| SuperMacro { get; set; } | Gets the SuperMacro. |
| ThumbnailImageValidArea { get; set; } | Gets the ThumbnailImageValidArea. |
| VignettingCorr { get; set; } | Gets the VignettingCorr. |
| VRDOffset { get; set; } | Gets the VRDOffset. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AmbienceInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/ambienceinfo.md

#### Cr2MakerNotePackage.AmbienceInfo property

Gets the LensInfo.

```csharp
public long[] AmbienceInfo { get; set; }
```

##### Property Value

The LensInfo.

### CameraInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/camerainfo.md

#### Cr2MakerNotePackage.CameraInfo property

Gets the CameraInfo.

```csharp
public long CameraInfo { get; set; }
```

##### Property Value

The CameraInfo.

### CameraSettings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/camerasettings.md

#### Cr2MakerNotePackage.CameraSettings property

Gets the CanonCameraSettings Offset.

```csharp
public long CameraSettings { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### CanonFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/canonflags.md

#### Cr2MakerNotePackage.CanonFlags property

Gets the CanonFlags.

```csharp
public ushort CanonFlags { get; set; }
```

##### Property Value

The CanonFlags.

### Categories
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/categories.md

#### Cr2MakerNotePackage.Categories property

Gets the Categories.

```csharp
public long[] Categories { get; set; }
```

##### Property Value

The Categories.

### ColorData1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/colordata1.md

#### Cr2MakerNotePackage.ColorData1 property

Gets the ColorData1.

```csharp
public long ColorData1 { get; set; }
```

##### Property Value

The ColorData1.

### ColorSpace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/colorspace.md

#### Cr2MakerNotePackage.ColorSpace property

Gets the ColorSpace.

```csharp
public ushort ColorSpace { get; set; }
```

##### Property Value

The ColorSpace.

### ColorTemperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/colortemperature.md

#### Cr2MakerNotePackage.ColorTemperature property

Gets the ColorTemperature.

```csharp
public ushort ColorTemperature { get; set; }
```

##### Property Value

The ColorTemperature.

### ContrastInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/contrastinfo.md

#### Cr2MakerNotePackage.ContrastInfo property

Gets the ContrastInfo.

```csharp
public ushort[] ContrastInfo { get; set; }
```

##### Property Value

The ContrastInfo.

### Cr2AFConfig
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afconfig.md

#### Cr2MakerNotePackage.Cr2AFConfig property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2AFConfig { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2AFConfigPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afconfigpackage.md

#### Cr2MakerNotePackage.Cr2AFConfigPackage property

Gets the AFConfig.

```csharp
public Cr2AFConfigPackage Cr2AFConfigPackage { get; set; }
```

##### Property Value

The AFConfig.

### Cr2AFInfo2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afinfo2.md

#### Cr2MakerNotePackage.Cr2AFInfo2 property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2AFInfo2 { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2AFInfo2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afinfo2package.md

#### Cr2MakerNotePackage.Cr2AFInfo2Package property

Gets the AFInfo3 (Newer version of the AFInfo record).

```csharp
public Cr2AFInfo2Package Cr2AFInfo2Package { get; set; }
```

##### Property Value

The AFInfo3.

### Cr2AFInfo3
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afinfo3.md

#### Cr2MakerNotePackage.Cr2AFInfo3 property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2AFInfo3 { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2AFInfo3Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afinfo3package.md

#### Cr2MakerNotePackage.Cr2AFInfo3Package property

Gets the AFInfo3.

```csharp
public Cr2AFInfo2Package Cr2AFInfo3Package { get; set; }
```

##### Property Value

The AFInfo3.

### Cr2AFMicroAdj
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afmicroadj.md

#### Cr2MakerNotePackage.Cr2AFMicroAdj property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2AFMicroAdj { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2AFMicroAdjPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2afmicroadjpackage.md

#### Cr2MakerNotePackage.Cr2AFMicroAdjPackage property

Gets the AFMicroAdj.

```csharp
public Cr2AFMicroAdjPackage Cr2AFMicroAdjPackage { get; set; }
```

##### Property Value

The AFMicroAdj.

### Cr2AspectInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2aspectinfo.md

#### Cr2MakerNotePackage.Cr2AspectInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2AspectInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2AspectInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2aspectinfopackage.md

#### Cr2MakerNotePackage.Cr2AspectInfoPackage property

Gets the AspectInfo.

```csharp
public Cr2AspectInfoPackage Cr2AspectInfoPackage { get; set; }
```

##### Property Value

The AspectInfo.

### Cr2CameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2camerasettingspackage.md

#### Cr2MakerNotePackage.Cr2CameraSettingsPackage property

Gets the CanonCameraSettings.

```csharp
public Cr2CameraSettingsPackage Cr2CameraSettingsPackage { get; set; }
```

##### Property Value

The CanonCameraSettings.

### Cr2ColorBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2colorbalance.md

#### Cr2MakerNotePackage.Cr2ColorBalance property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2ColorBalance { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2ColorBalancePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2colorbalancepackage.md

#### Cr2MakerNotePackage.Cr2ColorBalancePackage property

Gets the ColorBalance (These tags are used by the 10D and 300D.).

```csharp
public Cr2ColorBalancePackage Cr2ColorBalancePackage { get; set; }
```

##### Property Value

The ColorBalance.

### Cr2ColorInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2colorinfo.md

#### Cr2MakerNotePackage.Cr2ColorInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2ColorInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2ColorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2colorinfopackage.md

#### Cr2MakerNotePackage.Cr2ColorInfoPackage property

Gets the ColorInfo.

```csharp
public Cr2ColorInfoPackage Cr2ColorInfoPackage { get; set; }
```

##### Property Value

The ColorInfo.

### Cr2CropInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2cropinfo.md

#### Cr2MakerNotePackage.Cr2CropInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2CropInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2CropInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2cropinfopackage.md

#### Cr2MakerNotePackage.Cr2CropInfoPackage property

Gets the CropInfo.

```csharp
public Cr2CropInfoPackage Cr2CropInfoPackage { get; set; }
```

##### Property Value

The CropInfo.

### Cr2FileInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2fileinfo.md

#### Cr2MakerNotePackage.Cr2FileInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2FileInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2FileInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2fileinfopackage.md

#### Cr2MakerNotePackage.Cr2FileInfoPackage property

Not used in this version. Gets the CanonFileInfo.

```csharp
public Cr2FileInfoPackage Cr2FileInfoPackage { get; set; }
```

##### Property Value

The CanonFileInfo.

### Cr2FocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2focallength.md

#### Cr2MakerNotePackage.Cr2FocalLength property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2FocalLength { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2FocalLengthPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2focallengthpackage.md

#### Cr2MakerNotePackage.Cr2FocalLengthPackage property

Gets the CanonFocalLength.

```csharp
public Cr2FocalLengthPackage Cr2FocalLengthPackage { get; set; }
```

##### Property Value

The CanonFocalLength.

### Cr2Functions1D
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2functions1d.md

#### Cr2MakerNotePackage.Cr2Functions1D property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2Functions1D { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2Functions1DPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2functions1dpackage.md

#### Cr2MakerNotePackage.Cr2Functions1DPackage property

Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).

```csharp
public Cr2Functions1DPackage Cr2Functions1DPackage { get; set; }
```

##### Property Value

The CustomFunctions1D.

### Cr2LightingOpt
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2lightingopt.md

#### Cr2MakerNotePackage.Cr2LightingOpt property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2LightingOpt { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2LightingOptPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2lightingoptpackage.md

#### Cr2MakerNotePackage.Cr2LightingOptPackage property

Gets the LightingOpt (This information is new in images from the EOS 7D.).

```csharp
public Cr2LightingOptPackage Cr2LightingOptPackage { get; set; }
```

##### Property Value

The LightingOpt.

### Cr2LogInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2loginfo.md

#### Cr2MakerNotePackage.Cr2LogInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2LogInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2LogInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2loginfopackage.md

#### Cr2MakerNotePackage.Cr2LogInfoPackage property

Gets the LogInfo.

```csharp
public Cr2LogInfoPackage Cr2LogInfoPackage { get; set; }
```

##### Property Value

The LogInfo.

### Cr2MakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2makernotepackage.md

#### Cr2MakerNotePackage constructor

Initializes a new instance of the `Cr2MakerNotePackage` class.

```csharp
public Cr2MakerNotePackage()
```

### Cr2ModifiedInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2modifiedinfo.md

#### Cr2MakerNotePackage.Cr2ModifiedInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2ModifiedInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2ModifiedInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2modifiedinfopackage.md

#### Cr2MakerNotePackage.Cr2ModifiedInfoPackage property

Gets the MeasuredColor.

```csharp
public Cr2ModifiedInfoPackage Cr2ModifiedInfoPackage { get; set; }
```

##### Property Value

The MeasuredColor.

### Cr2MovieInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2movieinfo.md

#### Cr2MakerNotePackage.Cr2MovieInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2MovieInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2MovieInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2movieinfopackage.md

#### Cr2MakerNotePackage.Cr2MovieInfoPackage property

Gets the MovieInfo (Tags written by some Canon cameras when recording video).

```csharp
public Cr2MovieInfoPackage Cr2MovieInfoPackage { get; set; }
```

##### Property Value

The MovieInfo.

### Cr2MultiExp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2multiexp.md

#### Cr2MakerNotePackage.Cr2MultiExp property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2MultiExp { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2MultiExpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2multiexppackage.md

#### Cr2MakerNotePackage.Cr2MultiExpPackage property

Gets the MultiExp.

```csharp
public Cr2MultiExpPackage Cr2MultiExpPackage { get; set; }
```

##### Property Value

The MultiExp.

### Cr2Panorama
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2panorama.md

#### Cr2MakerNotePackage.Cr2Panorama property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2Panorama { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2PanoramaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2panoramapackage.md

#### Cr2MakerNotePackage.Cr2PanoramaPackage property

Gets the CanonPanorama.

```csharp
public Cr2PanoramaPackage Cr2PanoramaPackage { get; set; }
```

##### Property Value

The CanonPanorama.

### Cr2PersonalFuncs
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2personalfuncs.md

#### Cr2MakerNotePackage.Cr2PersonalFuncs property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2PersonalFuncs { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2PersonalFuncsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2personalfuncspackage.md

#### Cr2MakerNotePackage.Cr2PersonalFuncsPackage property

Gets the PersonalFunctions (Personal function settings for the EOS-1D.).

```csharp
public Cr2PersonalFuncsPackage Cr2PersonalFuncsPackage { get; set; }
```

##### Property Value

The PersonalFunctions.

### Cr2PersonalFuncValues
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2personalfuncvalues.md

#### Cr2MakerNotePackage.Cr2PersonalFuncValues property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2PersonalFuncValues { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2PersonalFuncValuesPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2personalfuncvaluespackage.md

#### Cr2MakerNotePackage.Cr2PersonalFuncValuesPackage property

Gets the PersonalFunctionValues.

```csharp
public Cr2PersonalFuncValuesPackage Cr2PersonalFuncValuesPackage { get; set; }
```

##### Property Value

The PersonalFunctionValues.

### Cr2Processing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2processing.md

#### Cr2MakerNotePackage.Cr2Processing property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2Processing { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2ProcessingPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2processingpackage.md

#### Cr2MakerNotePackage.Cr2ProcessingPackage property

Gets the ProcessingInfo.

```csharp
public Cr2ProcessingPackage Cr2ProcessingPackage { get; set; }
```

##### Property Value

The ProcessingInfo.

### Cr2SensorInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2sensorinfo.md

#### Cr2MakerNotePackage.Cr2SensorInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2SensorInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2SensorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2sensorinfopackage.md

#### Cr2MakerNotePackage.Cr2SensorInfoPackage property

Gets the SensorInfo.

```csharp
public Cr2SensorInfoPackage Cr2SensorInfoPackage { get; set; }
```

##### Property Value

The SensorInfo.

### Cr2ShotInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2shotinfo.md

#### Cr2MakerNotePackage.Cr2ShotInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2ShotInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2ShotInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2shotinfopackage.md

#### Cr2MakerNotePackage.Cr2ShotInfoPackage property

Gets the CanonShotInfo.

```csharp
public Cr2ShotInfoPackage Cr2ShotInfoPackage { get; set; }
```

##### Property Value

The CanonShotInfo.

### Cr2TimeInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2timeinfo.md

#### Cr2MakerNotePackage.Cr2TimeInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2TimeInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2TimeInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2timeinfopackage.md

#### Cr2MakerNotePackage.Cr2TimeInfoPackage property

Gets the TimeInfo.

```csharp
public Cr2TimeInfoPackage Cr2TimeInfoPackage { get; set; }
```

##### Property Value

The TimeInfo.

### Cr2WBInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2wbinfo.md

#### Cr2MakerNotePackage.Cr2WBInfo property

Gets the CanonCameraSettings Offset.

```csharp
public long Cr2WBInfo { get; set; }
```

##### Property Value

The CanonCameraSettings Offset.

### Cr2WBInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr2wbinfopackage.md

#### Cr2MakerNotePackage.Cr2WBInfoPackage property

Gets the WBInfo (WB tags for the Canon G9).

```csharp
public Cr2WBInfoPackage Cr2WBInfoPackage { get; set; }
```

##### Property Value

The WBInfo.

### CustomFunctions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/customfunctions.md

#### Cr2MakerNotePackage.CustomFunctions property

Gets the CustomFunctions.

```csharp
public long CustomFunctions { get; set; }
```

##### Property Value

The CustomFunctions.

### CustomPictureStyleFileName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/custompicturestylefilename.md

#### Cr2MakerNotePackage.CustomPictureStyleFileName property

Gets the CustomPictureStyleFileName.

```csharp
public string CustomPictureStyleFileName { get; set; }
```

##### Property Value

The CustomPictureStyleFileName.

### DateStampMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/datestampmode.md

#### Cr2MakerNotePackage.DateStampMode property

Gets the DateStampMode.

```csharp
public ushort DateStampMode { get; set; }
```

##### Property Value

The DateStampMode.

### FaceDetect1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/facedetect1.md

#### Cr2MakerNotePackage.FaceDetect1 property

Gets the FaceDetect1.

```csharp
public long FaceDetect1 { get; set; }
```

##### Property Value

The FaceDetect1.

### FaceDetect2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/facedetect2.md

#### Cr2MakerNotePackage.FaceDetect2 property

Gets the FaceDetect2.

```csharp
public long FaceDetect2 { get; set; }
```

##### Property Value

The FaceDetect2.

### FaceDetect3
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/facedetect3.md

#### Cr2MakerNotePackage.FaceDetect3 property

Gets the FaceDetect3.

```csharp
public long FaceDetect3 { get; set; }
```

##### Property Value

The FaceDetect3.

### FileLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/filelength.md

#### Cr2MakerNotePackage.FileLength property

Gets the FileLength.

```csharp
public long FileLength { get; set; }
```

##### Property Value

The FileLength.

### FileNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/filenumber.md

#### Cr2MakerNotePackage.FileNumber property

Gets the FileNumber.

```csharp
public long FileNumber { get; set; }
```

##### Property Value

The FileNumber.

### FirmwareVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/firmwareversion.md

#### Cr2MakerNotePackage.FirmwareVersion property

Gets the FirmwareVersion.

```csharp
public string FirmwareVersion { get; set; }
```

##### Property Value

The FirmwareVersion.

### HDRInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/hdrinfo.md

#### Cr2MakerNotePackage.HDRInfo property

Gets the HDRInfo.

```csharp
public long HDRInfo { get; set; }
```

##### Property Value

The HDRInfo.

### ImageType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/imagetype.md

#### Cr2MakerNotePackage.ImageType property

Gets the ImageType.

```csharp
public string ImageType { get; set; }
```

##### Property Value

The ImageType.

### ImageUniqueID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/imageuniqueid.md

#### Cr2MakerNotePackage.ImageUniqueID property

Gets the ImageUniqueID.

```csharp
public byte[] ImageUniqueID { get; set; }
```

##### Property Value

The ImageUniqueID.

### InternalSerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/internalserialnumber.md

#### Cr2MakerNotePackage.InternalSerialNumber property

Gets the InternalSerialNumber.

```csharp
public string InternalSerialNumber { get; set; }
```

##### Property Value

The InternalSerialNumber.

### LensInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/lensinfo.md

#### Cr2MakerNotePackage.LensInfo property

Gets the LensInfo.

```csharp
public byte[] LensInfo { get; set; }
```

##### Property Value

The LensInfo.

### LensModel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/lensmodel.md

#### Cr2MakerNotePackage.LensModel property

Gets the LensModel.

```csharp
public string LensModel { get; set; }
```

##### Property Value

The LensModel.

### MeasuredColor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/measuredcolor.md

#### Cr2MakerNotePackage.MeasuredColor property

Gets the MeasuredColor.

```csharp
public ushort[] MeasuredColor { get; set; }
```

##### Property Value

The MeasuredColor.

### ModelID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/modelid.md

#### Cr2MakerNotePackage.ModelID property

Gets the ModelID.

```csharp
public long ModelID { get; set; }
```

##### Property Value

The ModelID.

### MyColors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/mycolors.md

#### Cr2MakerNotePackage.MyColors property

Gets the MyColors.

```csharp
public ushort[] MyColors { get; set; }
```

##### Property Value

The MyColors.

### OriginalDecisionDataOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/originaldecisiondataoffset.md

#### Cr2MakerNotePackage.OriginalDecisionDataOffset property

Gets the OriginalDecisionDataOffset.

```csharp
public long OriginalDecisionDataOffset { get; set; }
```

##### Property Value

The OriginalDecisionDataOffset.

### OwnerName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/ownername.md

#### Cr2MakerNotePackage.OwnerName property

Gets the OwnerName.

```csharp
public string OwnerName { get; set; }
```

##### Property Value

The OwnerName.

### PictureStylePC
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/picturestylepc.md

#### Cr2MakerNotePackage.PictureStylePC property

Gets the PictureStylePC.

```csharp
public ushort[] PictureStylePC { get; set; }
```

##### Property Value

The PictureStylePC.

### PictureStyleUserDef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/picturestyleuserdef.md

#### Cr2MakerNotePackage.PictureStyleUserDef property

Gets the PictureStyleUserDef.

```csharp
public ushort[] PictureStyleUserDef { get; set; }
```

##### Property Value

The PictureStyleUserDef.

### PreviewImageInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/previewimageinfo.md

#### Cr2MakerNotePackage.PreviewImageInfo property

Gets the PreviewImageInfo.

```csharp
public long PreviewImageInfo { get; set; }
```

##### Property Value

The PreviewImageInfo.

### RawBurstModeRoll
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/rawburstmoderoll.md

#### Cr2MakerNotePackage.RawBurstModeRoll property

Gets the RawBurstModeRoll.

```csharp
public long RawBurstModeRoll { get; set; }
```

##### Property Value

The RawBurstModeRoll.

### SerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/serialnumber.md

#### Cr2MakerNotePackage.SerialNumber property

Gets the SerialNumber.

```csharp
public long SerialNumber { get; set; }
```

##### Property Value

The SerialNumber.

### SerialNumberFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/serialnumberformat.md

#### Cr2MakerNotePackage.SerialNumberFormat property

Gets the SerialNumberFormat.

```csharp
public long SerialNumberFormat { get; set; }
```

##### Property Value

The SerialNumberFormat.

### SuperMacro
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/supermacro.md

#### Cr2MakerNotePackage.SuperMacro property

Gets the SuperMacro.

```csharp
public ushort SuperMacro { get; set; }
```

##### Property Value

The SuperMacro.

### ThumbnailImageValidArea
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/thumbnailimagevalidarea.md

#### Cr2MakerNotePackage.ThumbnailImageValidArea property

Gets the ThumbnailImageValidArea.

```csharp
public ushort[] ThumbnailImageValidArea { get; set; }
```

##### Property Value

The ThumbnailImageValidArea.

### VignettingCorr
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/vignettingcorr.md

#### Cr2MakerNotePackage.VignettingCorr property

Gets the VignettingCorr.

```csharp
public long VignettingCorr { get; set; }
```

##### Property Value

The VignettingCorr.

### VRDOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/vrdoffset.md

#### Cr2MakerNotePackage.VRDOffset property

Gets the VRDOffset.

```csharp
public long VRDOffset { get; set; }
```

##### Property Value

The VRDOffset.

### Cr2ModifiedInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfoindex.md

#### Cr2ModifiedInfoIndex enumeration

Defines ids of Cr2ModifiedInfo tags.

```csharp
public enum Cr2ModifiedInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ModifiedToneCurve | `1` | Indicates the ModifiedToneCurve. |
| ModifiedSharpness | `2` | Indicates the ModifiedSharpness. |
| ModifiedSharpnessFreq | `3` | Indicates the ModifiedSharpnessFreq. |
| ModifiedSensorRedLevel | `4` | Indicates the ModifiedSensorRedLevel. |
| ModifiedSensorBlueLevel | `5` | Indicates the ModifiedSensorBlueLevel. |
| ModifiedWhiteBalanceRed | `6` | Indicates the ModifiedWhiteBalanceRed. |
| ModifiedWhiteBalanceBlue | `7` | Indicates the ModifiedWhiteBalanceBlue. |
| ModifiedWhiteBalance | `8` | Indicates the ModifiedWhiteBalance. |
| ModifiedColorTemp | `9` | Indicates the ModifiedColorTemp. |
| ModifiedPictureStyle | `10` | Indicates the ModifiedPictureStyle. |
| ModifiedDigitalGain | `11` | Indicates the ModifiedDigitalGain. |

### Cr2ModifiedInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage.md

#### Cr2ModifiedInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2ModifiedInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2ModifiedInfoPackage() | Initializes a new instance of the `Cr2ModifiedInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModifiedColorTemp { get; } | Gets the ModifiedColorTemp. |
| ModifiedDigitalGain { get; } | Gets the ModifiedDigitalGain. |
| ModifiedPictureStyle { get; } | Gets the ModifiedPictureStyle. |
| ModifiedSensorBlueLevel { get; } | Gets the ModifiedSensorBlueLevel. |
| ModifiedSensorRedLevel { get; } | Gets the ModifiedSensorRedLevel. |
| ModifiedSharpness { get; } | Gets the ModifiedSharpness. |
| ModifiedSharpnessFreq { get; } | Gets the ModifiedSharpnessFreq. |
| ModifiedToneCurve { get; } | Gets the ModifiedToneCurve. |
| ModifiedWhiteBalance { get; } | Gets the ModifiedWhiteBalance. |
| ModifiedWhiteBalanceBlue { get; } | Gets the ModifiedWhiteBalanceBlue. |
| ModifiedWhiteBalanceRed { get; } | Gets the ModifiedWhiteBalanceRed. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2ModifiedInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/cr2modifiedinfopackage.md

#### Cr2ModifiedInfoPackage constructor

Initializes a new instance of the `Cr2ModifiedInfoPackage` class.

```csharp
public Cr2ModifiedInfoPackage()
```

### ModifiedColorTemp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedcolortemp.md

#### Cr2ModifiedInfoPackage.ModifiedColorTemp property

Gets the ModifiedColorTemp.

```csharp
public ushort ModifiedColorTemp { get; }
```

##### Property Value

The ModifiedColorTemp.

### ModifiedDigitalGain
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifieddigitalgain.md

#### Cr2ModifiedInfoPackage.ModifiedDigitalGain property

Gets the ModifiedDigitalGain.

```csharp
public ushort ModifiedDigitalGain { get; }
```

##### Property Value

The ModifiedDigitalGain.

### ModifiedPictureStyle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedpicturestyle.md

#### Cr2ModifiedInfoPackage.ModifiedPictureStyle property

Gets the ModifiedPictureStyle.

```csharp
public ushort ModifiedPictureStyle { get; }
```

##### Property Value

The ModifiedPictureStyle.

### ModifiedSensorBlueLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedsensorbluelevel.md

#### Cr2ModifiedInfoPackage.ModifiedSensorBlueLevel property

Gets the ModifiedSensorBlueLevel.

```csharp
public ushort ModifiedSensorBlueLevel { get; }
```

##### Property Value

The ModifiedSensorBlueLevel.

### ModifiedSensorRedLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedsensorredlevel.md

#### Cr2ModifiedInfoPackage.ModifiedSensorRedLevel property

Gets the ModifiedSensorRedLevel.

```csharp
public ushort ModifiedSensorRedLevel { get; }
```

##### Property Value

The ModifiedSensorRedLevel.

### ModifiedSharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedsharpness.md

#### Cr2ModifiedInfoPackage.ModifiedSharpness property

Gets the ModifiedSharpness.

```csharp
public ushort ModifiedSharpness { get; }
```

##### Property Value

The ModifiedSharpness.

### ModifiedSharpnessFreq
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedsharpnessfreq.md

#### Cr2ModifiedInfoPackage.ModifiedSharpnessFreq property

Gets the ModifiedSharpnessFreq.

```csharp
public ushort ModifiedSharpnessFreq { get; }
```

##### Property Value

The ModifiedSharpnessFreq.

### ModifiedToneCurve
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedtonecurve.md

#### Cr2ModifiedInfoPackage.ModifiedToneCurve property

Gets the ModifiedToneCurve.

```csharp
public ushort ModifiedToneCurve { get; }
```

##### Property Value

The ModifiedToneCurve.

### ModifiedWhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedwhitebalance.md

#### Cr2ModifiedInfoPackage.ModifiedWhiteBalance property

Gets the ModifiedWhiteBalance.

```csharp
public ushort ModifiedWhiteBalance { get; }
```

##### Property Value

The ModifiedWhiteBalance.

### ModifiedWhiteBalanceBlue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedwhitebalanceblue.md

#### Cr2ModifiedInfoPackage.ModifiedWhiteBalanceBlue property

Gets the ModifiedWhiteBalanceBlue.

```csharp
public ushort ModifiedWhiteBalanceBlue { get; }
```

##### Property Value

The ModifiedWhiteBalanceBlue.

### ModifiedWhiteBalanceRed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modifiedwhitebalancered.md

#### Cr2ModifiedInfoPackage.ModifiedWhiteBalanceRed property

Gets the ModifiedWhiteBalanceRed.

```csharp
public ushort ModifiedWhiteBalanceRed { get; }
```

##### Property Value

The ModifiedWhiteBalanceRed.

### Cr2MovieInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfoindex.md

#### Cr2MovieInfoIndex enumeration

Defines ids of Cr2MovieInfo tags.

```csharp
public enum Cr2MovieInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| FrameRate | `1` | Indicates the FrameRate. |
| FrameCount | `2` | Indicates the FrameCount. |
| FrameCount2 | `4` | Indicates the FrameCount2. |
| FrameRate2 | `6` | Indicates the FrameRate2. |
| Duration | `106` | Indicates the Duration. |
| AudioBitrate | `108` | Indicates the AudioBitrate. |
| AudioSampleRate | `110` | Indicates the AudioSampleRate. |
| AudioChannels | `112` | Indicates the AudioChannels. |
| VideoCodec | `116` | Indicates the VideoCodec. |

### Cr2MovieInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage.md

#### Cr2MovieInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2MovieInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2MovieInfoPackage() | Initializes a new instance of the `Cr2MovieInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AudioBitrate { get; } | Gets the AudioBitrate. |
| AudioChannels { get; } | Gets the AudioChannels. |
| AudioSampleRate { get; } | Gets the AudioSampleRate. |
| Count { get; } | Gets the number of metadata properties. |
| Duration { get; } | Gets the Duration. |
| FrameCount { get; } | Gets the FrameCount. |
| FrameCount2 { get; } | Gets the FrameCount2. |
| FrameRate { get; } | Gets the FrameRate. |
| FrameRate2 { get; } | Gets the FrameRate2. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| VideoCodec { get; } | Gets the VideoCodec. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AudioBitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audiobitrate.md

#### Cr2MovieInfoPackage.AudioBitrate property

Gets the AudioBitrate.

```csharp
public ushort AudioBitrate { get; }
```

##### Property Value

The AudioBitrate.

### AudioChannels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audiochannels.md

#### Cr2MovieInfoPackage.AudioChannels property

Gets the AudioChannels.

```csharp
public ushort AudioChannels { get; }
```

##### Property Value

The AudioChannels.

### AudioSampleRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audiosamplerate.md

#### Cr2MovieInfoPackage.AudioSampleRate property

Gets the AudioSampleRate.

```csharp
public ushort AudioSampleRate { get; }
```

##### Property Value

The AudioSampleRate.

### Cr2MovieInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/cr2movieinfopackage.md

#### Cr2MovieInfoPackage constructor

Initializes a new instance of the `Cr2MovieInfoPackage` class.

```csharp
public Cr2MovieInfoPackage()
```

### Duration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/duration.md

#### Cr2MovieInfoPackage.Duration property

Gets the Duration.

```csharp
public ushort Duration { get; }
```

##### Property Value

The Duration.

### FrameCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/framecount.md

#### Cr2MovieInfoPackage.FrameCount property

Gets the FrameCount.

```csharp
public ushort FrameCount { get; }
```

##### Property Value

The FrameCount.

### FrameCount2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/framecount2.md

#### Cr2MovieInfoPackage.FrameCount2 property

Gets the FrameCount2.

```csharp
public int FrameCount2 { get; }
```

##### Property Value

The FrameCount2.

### FrameRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/framerate.md

#### Cr2MovieInfoPackage.FrameRate property

Gets the FrameRate.

```csharp
public ushort FrameRate { get; }
```

##### Property Value

The FrameRate.

### FrameRate2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/framerate2.md

#### Cr2MovieInfoPackage.FrameRate2 property

Gets the FrameRate2.

```csharp
public float FrameRate2 { get; }
```

##### Property Value

The FrameRate2.

### VideoCodec
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/videocodec.md

#### Cr2MovieInfoPackage.VideoCodec property

Gets the VideoCodec.

```csharp
public byte[] VideoCodec { get; }
```

##### Property Value

The VideoCodec.

### Cr2MultiExpIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexpindex.md

#### Cr2MultiExpIndex enumeration

Defines ids of Cr2MultiExp tags.

```csharp
public enum Cr2MultiExpIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| MultiExposure | `1` | Indicates the MultiExposure. |
| MultiExposureControl | `2` | Indicates the MultiExposureControl. |
| MultiExposureShots | `3` | Indicates the MultiExposureShots. |
| Unknown2 | `5` | Unknown tag. |

### Cr2MultiExpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage.md

#### Cr2MultiExpPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2MultiExpPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2MultiExpPackage() | Initializes a new instance of the `Cr2MultiExpPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MultiExposure { get; } | Gets the MultiExposure. |
| MultiExposureControl { get; } | Gets the MultiExposureControl. |
| MultiExposureShots { get; } | Gets the MultiExposureShots. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2MultiExpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/cr2multiexppackage.md

#### Cr2MultiExpPackage constructor

Initializes a new instance of the `Cr2MultiExpPackage` class.

```csharp
public Cr2MultiExpPackage()
```

### MultiExposure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multiexposure.md

#### Cr2MultiExpPackage.MultiExposure property

Gets the MultiExposure.

```csharp
public int MultiExposure { get; }
```

##### Property Value

The MultiExposure.

### MultiExposureControl
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multiexposurecontrol.md

#### Cr2MultiExpPackage.MultiExposureControl property

Gets the MultiExposureControl.

```csharp
public int MultiExposureControl { get; }
```

##### Property Value

The MultiExposureControl.

### MultiExposureShots
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multiexposureshots.md

#### Cr2MultiExpPackage.MultiExposureShots property

Gets the MultiExposureShots.

```csharp
public int MultiExposureShots { get; }
```

##### Property Value

The MultiExposureShots.

### Cr2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2package.md

#### Cr2Package class

Represents native CR2 metadata.

```csharp
public sealed class Cr2Package : RawPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawTiffTagPackage { get; } | Gets the Tag Support Levels. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### RawTiffTagPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2package/rawtifftagpackage.md

#### Cr2Package.RawTiffTagPackage property

Gets the Tag Support Levels.

```csharp
public RawTiffTagPackage RawTiffTagPackage { get; }
```

##### Property Value

The Tag Support Levels.

### Cr2PanoramaIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2panoramaindex.md

#### Cr2PanoramaIndex enumeration

Defines ids of Cr2Panorama tags.

```csharp
public enum Cr2PanoramaIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PanoramaFrameNumber | `2` | Indicates the PanoramaFrameNumber. |
| PanoramaDirection | `5` | Indicates the PanoramaDirection. |

### Cr2PanoramaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage.md

#### Cr2PanoramaPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2PanoramaPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2PanoramaPackage() | Initializes a new instance of the `Cr2PanoramaPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PanoramaDirection { get; } | Gets the PanoramaDirection. |
| PanoramaFrameNumber { get; } | Gets the PanoramaFrameNumber. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2PanoramaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/cr2panoramapackage.md

#### Cr2PanoramaPackage constructor

Initializes a new instance of the `Cr2PanoramaPackage` class.

```csharp
public Cr2PanoramaPackage()
```

### PanoramaDirection
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/panoramadirection.md

#### Cr2PanoramaPackage.PanoramaDirection property

Gets the PanoramaDirection.

```csharp
public ushort PanoramaDirection { get; }
```

##### Property Value

The PanoramaDirection.

### PanoramaFrameNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/panoramaframenumber.md

#### Cr2PanoramaPackage.PanoramaFrameNumber property

Gets the PanoramaFrameNumber.

```csharp
public ushort PanoramaFrameNumber { get; }
```

##### Property Value

The PanoramaFrameNumber.

### Cr2PersonalFuncsIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncsindex.md

#### Cr2PersonalFuncsIndex enumeration

Defines ids of Cr2PersonalFuncs tags.

```csharp
public enum Cr2PersonalFuncsIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| PF0CustomFuncRegistration | `1` | Indicates the PF0CustomFuncRegistration. |
| PF1DisableShootingModes | `2` | Indicates the PF1DisableShootingModes. |
| PF2DisableMeteringModes | `3` | Indicates the PF2DisableMeteringModes. |
| PF3ManualExposureMetering | `4` | Indicates the PF3ManualExposureMetering. |
| PF4ExposureTimeLimits | `5` | Indicates the PF4ExposureTimeLimits. |
| PF5ApertureLimits | `6` | Indicates the PF5ApertureLimits. |
| PF6PresetShootingModes | `7` | Indicates the PF6PresetShootingModes. |
| PF7BracketContinuousShoot | `8` | Indicates the PF7BracketContinuousShoot. |
| PF8SetBracketShots | `9` | Indicates the PF8SetBracketShots. |
| PF9ChangeBracketSequence | `10` | Indicates the PF9ChangeBracketSequence. |
| PF10RetainProgramShift | `11` | Indicates the PF10RetainProgramShift. |
| PF13DrivePriority | `14` | Indicates the PF13DrivePriority. |
| PF14DisableFocusSearch | `15` | Indicates the PF14DisableFocusSearch. |
| PF15DisableAFAssistBeam | `16` | Indicates the PF15DisableAFAssistBeam. |
| PF16AutoFocusPointShoot | `17` | Indicates the PF16AutoFocusPointShoot. |
| PF17DisableAFPointSel | `18` | Indicates the PF17DisableAFPointSel. |
| PF18EnableAutoAFPointSel | `19` | Indicates the PF18EnableAutoAFPointSel. |
| PF19ContinuousShootSpeed | `20` | Indicates the PF19ContinuousShootSpeed. |
| PF20LimitContinousShots | `21` | Indicates the PF20LimitContinousShots. |
| PF21EnableQuietOperation | `22` | Indicates the PF21EnableQuietOperation. |
| PF23SetTimerLengths | `24` | Indicates the PF23SetTimerLengths. |
| PF24LightLCDDuringBulb | `25` | Indicates the PF24LightLCDDuringBulb. |
| PF25DefaultClearSettings | `26` | Indicates the PF25DefaultClearSettings. |
| PF26ShortenReleaseLag | `27` | Indicates the PF26ShortenReleaseLag. |
| PF27ReverseDialRotation | `28` | Indicates the PF27ReverseDialRotation. |
| PF28NoQuickDialExpComp | `29` | Indicates the PF28NoQuickDialExpComp. |
| PF29QuickDialSwitchOff | `30` | Indicates the PF29QuickDialSwitchOff. |
| PF30EnlargementMode | `31` | Indicates the PF30EnlargementMode. |
| PF31OriginalDecisionData | `32` | Indicates the PF31OriginalDecisionData. |

### Cr2PersonalFuncsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage.md

#### Cr2PersonalFuncsPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2PersonalFuncsPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2PersonalFuncsPackage() | Initializes a new instance of the `Cr2PersonalFuncsPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PF0CustomFuncRegistration { get; } | Gets the PF0CustomFuncRegistration. |
| PF10RetainProgramShift { get; } | Gets the PF10RetainProgramShift. |
| PF13DrivePriority { get; } | Gets the PF13DrivePriority. |
| PF14DisableFocusSearch { get; } | Gets the PF14DisableFocusSearch. |
| PF15DisableAFAssistBeam { get; } | Gets the PF15DisableAFAssistBeam. |
| PF16AutoFocusPointShoot { get; } | Gets the PF16AutoFocusPointShoot. |
| PF17DisableAFPointSel { get; } | Gets the PF17DisableAFPointSel. |
| PF18EnableAutoAFPointSel { get; } | Gets the PF18EnableAutoAFPointSel. |
| PF19ContinuousShootSpeed { get; } | Gets the PF19ContinuousShootSpeed. |
| PF1DisableShootingModes { get; } | Gets the PF1DisableShootingModes. |
| PF20LimitContinousShots { get; } | Gets the PF20LimitContinousShots. |
| PF21EnableQuietOperation { get; } | Gets the PF21EnableQuietOperation. |
| PF23SetTimerLengths { get; } | Gets the PF23SetTimerLengths. |
| PF24LightLCDDuringBulb { get; } | Gets the PF24LightLCDDuringBulb. |
| PF25DefaultClearSettings { get; } | Gets the PF25DefaultClearSettings. |
| PF26ShortenReleaseLag { get; } | Gets the PF26ShortenReleaseLag. |
| PF27ReverseDialRotation { get; } | Gets the PF27ReverseDialRotation. |
| PF28NoQuickDialExpComp { get; } | Gets the PF28NoQuickDialExpComp. |
| PF29QuickDialSwitchOff { get; } | Gets the PF29QuickDialSwitchOff. |
| PF2DisableMeteringModes { get; } | Gets the PF2DisableMeteringModes. |
| PF30EnlargementMode { get; } | Gets the PF30EnlargementMode. |
| PF31OriginalDecisionData { get; } | Gets the PF31OriginalDecisionData. |
| PF3ManualExposureMetering { get; } | Gets the PF3ManualExposureMetering. |
| PF4ExposureTimeLimits { get; } | Gets the PF4ExposureTimeLimits. |
| PF5ApertureLimits { get; } | Gets the PF5ApertureLimits. |
| PF6PresetShootingModes { get; } | Gets the PF6PresetShootingModes. |
| PF7BracketContinuousShoot { get; } | Gets the PF7BracketContinuousShoot. |
| PF8SetBracketShots { get; } | Gets the PF8SetBracketShots. |
| PF9ChangeBracketSequence { get; } | Gets the PF9ChangeBracketSequence. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2PersonalFuncsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/cr2personalfuncspackage.md

#### Cr2PersonalFuncsPackage constructor

Initializes a new instance of the `Cr2PersonalFuncsPackage` class.

```csharp
public Cr2PersonalFuncsPackage()
```

### PF0CustomFuncRegistration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf0customfuncregistration.md

#### Cr2PersonalFuncsPackage.PF0CustomFuncRegistration property

Gets the PF0CustomFuncRegistration.

```csharp
public ushort PF0CustomFuncRegistration { get; }
```

##### Property Value

The PF0CustomFuncRegistration.

### PF10RetainProgramShift
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf10retainprogramshift.md

#### Cr2PersonalFuncsPackage.PF10RetainProgramShift property

Gets the PF10RetainProgramShift.

```csharp
public ushort PF10RetainProgramShift { get; }
```

##### Property Value

The PF10RetainProgramShift.

### PF13DrivePriority
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf13drivepriority.md

#### Cr2PersonalFuncsPackage.PF13DrivePriority property

Gets the PF13DrivePriority.

```csharp
public ushort PF13DrivePriority { get; }
```

##### Property Value

The PF13DrivePriority.

### PF14DisableFocusSearch
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf14disablefocussearch.md

#### Cr2PersonalFuncsPackage.PF14DisableFocusSearch property

Gets the PF14DisableFocusSearch.

```csharp
public ushort PF14DisableFocusSearch { get; }
```

##### Property Value

The PF14DisableFocusSearch.

### PF15DisableAFAssistBeam
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf15disableafassistbeam.md

#### Cr2PersonalFuncsPackage.PF15DisableAFAssistBeam property

Gets the PF15DisableAFAssistBeam.

```csharp
public ushort PF15DisableAFAssistBeam { get; }
```

##### Property Value

The PF15DisableAFAssistBeam.

### PF16AutoFocusPointShoot
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf16autofocuspointshoot.md

#### Cr2PersonalFuncsPackage.PF16AutoFocusPointShoot property

Gets the PF16AutoFocusPointShoot.

```csharp
public ushort PF16AutoFocusPointShoot { get; }
```

##### Property Value

The PF16AutoFocusPointShoot.

### PF17DisableAFPointSel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf17disableafpointsel.md

#### Cr2PersonalFuncsPackage.PF17DisableAFPointSel property

Gets the PF17DisableAFPointSel.

```csharp
public ushort PF17DisableAFPointSel { get; }
```

##### Property Value

The PF17DisableAFPointSel.

### PF18EnableAutoAFPointSel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf18enableautoafpointsel.md

#### Cr2PersonalFuncsPackage.PF18EnableAutoAFPointSel property

Gets the PF18EnableAutoAFPointSel.

```csharp
public ushort PF18EnableAutoAFPointSel { get; }
```

##### Property Value

The PF18EnableAutoAFPointSel.

### PF19ContinuousShootSpeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf19continuousshootspeed.md

#### Cr2PersonalFuncsPackage.PF19ContinuousShootSpeed property

Gets the PF19ContinuousShootSpeed.

```csharp
public ushort PF19ContinuousShootSpeed { get; }
```

##### Property Value

The PF19ContinuousShootSpeed.

### PF1DisableShootingModes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf1disableshootingmodes.md

#### Cr2PersonalFuncsPackage.PF1DisableShootingModes property

Gets the PF1DisableShootingModes.

```csharp
public ushort PF1DisableShootingModes { get; }
```

##### Property Value

The PF1DisableShootingModes.

### PF20LimitContinousShots
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf20limitcontinousshots.md

#### Cr2PersonalFuncsPackage.PF20LimitContinousShots property

Gets the PF20LimitContinousShots.

```csharp
public ushort PF20LimitContinousShots { get; }
```

##### Property Value

The PF20LimitContinousShots.

### PF21EnableQuietOperation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf21enablequietoperation.md

#### Cr2PersonalFuncsPackage.PF21EnableQuietOperation property

Gets the PF21EnableQuietOperation.

```csharp
public ushort PF21EnableQuietOperation { get; }
```

##### Property Value

The PF21EnableQuietOperation.

### PF23SetTimerLengths
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf23settimerlengths.md

#### Cr2PersonalFuncsPackage.PF23SetTimerLengths property

Gets the PF23SetTimerLengths.

```csharp
public ushort PF23SetTimerLengths { get; }
```

##### Property Value

The PF23SetTimerLengths.

### PF24LightLCDDuringBulb
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf24lightlcdduringbulb.md

#### Cr2PersonalFuncsPackage.PF24LightLCDDuringBulb property

Gets the PF24LightLCDDuringBulb.

```csharp
public ushort PF24LightLCDDuringBulb { get; }
```

##### Property Value

The PF24LightLCDDuringBulb.

### PF25DefaultClearSettings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf25defaultclearsettings.md

#### Cr2PersonalFuncsPackage.PF25DefaultClearSettings property

Gets the PF25DefaultClearSettings.

```csharp
public ushort PF25DefaultClearSettings { get; }
```

##### Property Value

The PF25DefaultClearSettings.

### PF26ShortenReleaseLag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf26shortenreleaselag.md

#### Cr2PersonalFuncsPackage.PF26ShortenReleaseLag property

Gets the PF26ShortenReleaseLag.

```csharp
public ushort PF26ShortenReleaseLag { get; }
```

##### Property Value

The PF26ShortenReleaseLag.

### PF27ReverseDialRotation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf27reversedialrotation.md

#### Cr2PersonalFuncsPackage.PF27ReverseDialRotation property

Gets the PF27ReverseDialRotation.

```csharp
public ushort PF27ReverseDialRotation { get; }
```

##### Property Value

The PF27ReverseDialRotation.

### PF28NoQuickDialExpComp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf28noquickdialexpcomp.md

#### Cr2PersonalFuncsPackage.PF28NoQuickDialExpComp property

Gets the PF28NoQuickDialExpComp.

```csharp
public ushort PF28NoQuickDialExpComp { get; }
```

##### Property Value

The PF28NoQuickDialExpComp.

### PF29QuickDialSwitchOff
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf29quickdialswitchoff.md

#### Cr2PersonalFuncsPackage.PF29QuickDialSwitchOff property

Gets the PF29QuickDialSwitchOff.

```csharp
public ushort PF29QuickDialSwitchOff { get; }
```

##### Property Value

The PF29QuickDialSwitchOff.

### PF2DisableMeteringModes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf2disablemeteringmodes.md

#### Cr2PersonalFuncsPackage.PF2DisableMeteringModes property

Gets the PF2DisableMeteringModes.

```csharp
public ushort PF2DisableMeteringModes { get; }
```

##### Property Value

The PF2DisableMeteringModes.

### PF30EnlargementMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf30enlargementmode.md

#### Cr2PersonalFuncsPackage.PF30EnlargementMode property

Gets the PF30EnlargementMode.

```csharp
public ushort PF30EnlargementMode { get; }
```

##### Property Value

The PF30EnlargementMode.

### PF31OriginalDecisionData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf31originaldecisiondata.md

#### Cr2PersonalFuncsPackage.PF31OriginalDecisionData property

Gets the PF31OriginalDecisionData.

```csharp
public ushort PF31OriginalDecisionData { get; }
```

##### Property Value

The PF31OriginalDecisionData.

### PF3ManualExposureMetering
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf3manualexposuremetering.md

#### Cr2PersonalFuncsPackage.PF3ManualExposureMetering property

Gets the PF3ManualExposureMetering.

```csharp
public ushort PF3ManualExposureMetering { get; }
```

##### Property Value

The PF3ManualExposureMetering.

### PF4ExposureTimeLimits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf4exposuretimelimits.md

#### Cr2PersonalFuncsPackage.PF4ExposureTimeLimits property

Gets the PF4ExposureTimeLimits.

```csharp
public ushort PF4ExposureTimeLimits { get; }
```

##### Property Value

The PF4ExposureTimeLimits.

### PF5ApertureLimits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf5aperturelimits.md

#### Cr2PersonalFuncsPackage.PF5ApertureLimits property

Gets the PF5ApertureLimits.

```csharp
public ushort PF5ApertureLimits { get; }
```

##### Property Value

The PF5ApertureLimits.

### PF6PresetShootingModes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf6presetshootingmodes.md

#### Cr2PersonalFuncsPackage.PF6PresetShootingModes property

Gets the PF6PresetShootingModes.

```csharp
public ushort PF6PresetShootingModes { get; }
```

##### Property Value

The PF6PresetShootingModes.

### PF7BracketContinuousShoot
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf7bracketcontinuousshoot.md

#### Cr2PersonalFuncsPackage.PF7BracketContinuousShoot property

Gets the PF7BracketContinuousShoot.

```csharp
public ushort PF7BracketContinuousShoot { get; }
```

##### Property Value

The PF7BracketContinuousShoot.

### PF8SetBracketShots
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf8setbracketshots.md

#### Cr2PersonalFuncsPackage.PF8SetBracketShots property

Gets the PF8SetBracketShots.

```csharp
public ushort PF8SetBracketShots { get; }
```

##### Property Value

The PF8SetBracketShots.

### PF9ChangeBracketSequence
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf9changebracketsequence.md

#### Cr2PersonalFuncsPackage.PF9ChangeBracketSequence property

Gets the PF9ChangeBracketSequence.

```csharp
public ushort PF9ChangeBracketSequence { get; }
```

##### Property Value

The PF9ChangeBracketSequence.

### Cr2PersonalFuncValuesIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluesindex.md

#### Cr2PersonalFuncValuesIndex enumeration

Defines ids of Cr2PersonalFuncValues tags.

```csharp
public enum Cr2PersonalFuncValuesIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| PF1Value | `1` | Indicates the PF1Value. |
| PF2Value | `2` | Indicates the PF2Value. |
| PF3Value | `3` | Indicates the PF3Value. |
| PF4ExposureTimeMin | `4` | Indicates the PF4ExposureTimeMin. |
| PF4ExposureTimeMax | `5` | Indicates the PF4ExposureTimeMax. |
| PF5ApertureMin | `6` | Indicates the PF5ApertureMin. |
| PF5ApertureMax | `7` | Indicates the PF5ApertureMax. |
| PF8BracketShots | `8` | Indicates the PF8BracketShots. |
| PF19ShootingSpeedLow | `9` | Indicates the PF19ShootingSpeedLow. |
| PF19ShootingSpeedHigh | `10` | Indicates the PF19ShootingSpeedHigh. |
| PF20MaxContinousShots | `11` | Indicates the PF20MaxContinousShots. |
| PF23ShutterButtonTime | `12` | Indicates the PF23ShutterButtonTime. |
| PF23FELockTime | `13` | Indicates the PF23FELockTime. |
| PF23PostReleaseTime | `14` | Indicates the PF23PostReleaseTime. |
| PF25AEMode | `15` | Indicates the PF25AEMode. |
| PF25MeteringMode | `16` | Indicates the PF25MeteringMode. |
| PF25DriveMode | `17` | Indicates the PF25DriveMode. |
| PF25AFMode | `18` | Indicates the PF25AFMode. |
| PF25AFPointSel | `19` | Indicates the PF25AFPointSel. |
| PF25ImageSize | `20` | Indicates the PF25ImageSize. |
| PF25WBMode | `21` | Indicates the PF25WBMode. |
| PF25Parameters | `22` | Indicates the PF25Parameters. |
| PF25ColorMatrix | `23` | Indicates the PF25ColorMatrix. |
| PF27Value | `24` | Indicates the PF27Value. |

### Cr2PersonalFuncValuesPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage.md

#### Cr2PersonalFuncValuesPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2PersonalFuncValuesPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2PersonalFuncValuesPackage() | Initializes a new instance of the `Cr2PersonalFuncValuesPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PF19ShootingSpeedHigh { get; } | Gets the PF19ShootingSpeedHigh. |
| PF19ShootingSpeedLow { get; } | Gets the PF19ShootingSpeedLow. |
| PF1Value { get; } | Gets the PF1Value. |
| PF20MaxContinousShots { get; } | Gets the PF20MaxContinousShots. |
| PF23FELockTime { get; } | Gets the PF23FELockTime. |
| PF23PostReleaseTime { get; } | Gets the PF23PostReleaseTime. |
| PF23ShutterButtonTime { get; } | Gets the PF23ShutterButtonTime. |
| PF25AEMode { get; } | Gets the PF25AEMode. |
| PF25AFMode { get; } | Gets the PF25AFMode. |
| PF25AFPointSel { get; } | Gets the PF25AFPointSel. |
| PF25ColorMatrix { get; } | Gets the PF25ColorMatrix. |
| PF25DriveMode { get; } | Gets the PF25DriveMode. |
| PF25ImageSize { get; } | Gets the PF25ImageSize. |
| PF25MeteringMode { get; } | Gets the PF25MeteringMode. |
| PF25Parameters { get; } | Gets the PF25Parameters. |
| PF25WBMode { get; } | Gets the PF25WBMode. |
| PF27Value { get; } | Gets the PF27Value. |
| PF2Value { get; } | Gets the PF2Value. |
| PF3Value { get; } | Gets the PF3Value. |
| PF4ExposureTimeMax { get; } | Gets the PF4ExposureTimeMax. |
| PF4ExposureTimeMin { get; } | Gets the PF4ExposureTimeMin. |
| PF5ApertureMax { get; } | Gets the PF5ApertureMax. |
| PF5ApertureMin { get; } | Gets the PF5ApertureMin. |
| PF8BracketShots { get; } | Gets the PF8BracketShots. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2PersonalFuncValuesPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/cr2personalfuncvaluespackage.md

#### Cr2PersonalFuncValuesPackage constructor

Initializes a new instance of the `Cr2PersonalFuncValuesPackage` class.

```csharp
public Cr2PersonalFuncValuesPackage()
```

### PF19ShootingSpeedHigh
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf19shootingspeedhigh.md

#### Cr2PersonalFuncValuesPackage.PF19ShootingSpeedHigh property

Gets the PF19ShootingSpeedHigh.

```csharp
public ushort PF19ShootingSpeedHigh { get; }
```

##### Property Value

The PF19ShootingSpeedHigh.

### PF19ShootingSpeedLow
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf19shootingspeedlow.md

#### Cr2PersonalFuncValuesPackage.PF19ShootingSpeedLow property

Gets the PF19ShootingSpeedLow.

```csharp
public ushort PF19ShootingSpeedLow { get; }
```

##### Property Value

The PF19ShootingSpeedLow.

### PF1Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf1value.md

#### Cr2PersonalFuncValuesPackage.PF1Value property

Gets the PF1Value.

```csharp
public ushort PF1Value { get; }
```

##### Property Value

The PF1Value.

### PF20MaxContinousShots
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf20maxcontinousshots.md

#### Cr2PersonalFuncValuesPackage.PF20MaxContinousShots property

Gets the PF20MaxContinousShots.

```csharp
public ushort PF20MaxContinousShots { get; }
```

##### Property Value

The PF20MaxContinousShots.

### PF23FELockTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23felocktime.md

#### Cr2PersonalFuncValuesPackage.PF23FELockTime property

Gets the PF23FELockTime.

```csharp
public ushort PF23FELockTime { get; }
```

##### Property Value

The PF23FELockTime.

### PF23PostReleaseTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23postreleasetime.md

#### Cr2PersonalFuncValuesPackage.PF23PostReleaseTime property

Gets the PF23PostReleaseTime.

```csharp
public ushort PF23PostReleaseTime { get; }
```

##### Property Value

The PF23PostReleaseTime.

### PF23ShutterButtonTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23shutterbuttontime.md

#### Cr2PersonalFuncValuesPackage.PF23ShutterButtonTime property

Gets the PF23ShutterButtonTime.

```csharp
public ushort PF23ShutterButtonTime { get; }
```

##### Property Value

The PF23ShutterButtonTime.

### PF25AEMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25aemode.md

#### Cr2PersonalFuncValuesPackage.PF25AEMode property

Gets the PF25AEMode.

```csharp
public ushort PF25AEMode { get; }
```

##### Property Value

The PF25AEMode.

### PF25AFMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25afmode.md

#### Cr2PersonalFuncValuesPackage.PF25AFMode property

Gets the PF25AFMode.

```csharp
public ushort PF25AFMode { get; }
```

##### Property Value

The PF25AFMode.

### PF25AFPointSel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25afpointsel.md

#### Cr2PersonalFuncValuesPackage.PF25AFPointSel property

Gets the PF25AFPointSel.

```csharp
public ushort PF25AFPointSel { get; }
```

##### Property Value

The PF25AFPointSel.

### PF25ColorMatrix
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25colormatrix.md

#### Cr2PersonalFuncValuesPackage.PF25ColorMatrix property

Gets the PF25ColorMatrix.

```csharp
public ushort PF25ColorMatrix { get; }
```

##### Property Value

The PF25ColorMatrix.

### PF25DriveMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25drivemode.md

#### Cr2PersonalFuncValuesPackage.PF25DriveMode property

Gets the PF25DriveMode.

```csharp
public ushort PF25DriveMode { get; }
```

##### Property Value

The PF25DriveMode.

### PF25ImageSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25imagesize.md

#### Cr2PersonalFuncValuesPackage.PF25ImageSize property

Gets the PF25ImageSize.

```csharp
public ushort PF25ImageSize { get; }
```

##### Property Value

The PF25ImageSize.

### PF25MeteringMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25meteringmode.md

#### Cr2PersonalFuncValuesPackage.PF25MeteringMode property

Gets the PF25MeteringMode.

```csharp
public ushort PF25MeteringMode { get; }
```

##### Property Value

The PF25MeteringMode.

### PF25Parameters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25parameters.md

#### Cr2PersonalFuncValuesPackage.PF25Parameters property

Gets the PF25Parameters.

```csharp
public ushort PF25Parameters { get; }
```

##### Property Value

The PF25Parameters.

### PF25WBMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25wbmode.md

#### Cr2PersonalFuncValuesPackage.PF25WBMode property

Gets the PF25WBMode.

```csharp
public ushort PF25WBMode { get; }
```

##### Property Value

The PF25WBMode.

### PF27Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf27value.md

#### Cr2PersonalFuncValuesPackage.PF27Value property

Gets the PF27Value.

```csharp
public ushort PF27Value { get; }
```

##### Property Value

The PF27Value.

### PF2Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf2value.md

#### Cr2PersonalFuncValuesPackage.PF2Value property

Gets the PF2Value.

```csharp
public ushort PF2Value { get; }
```

##### Property Value

The PF2Value.

### PF3Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf3value.md

#### Cr2PersonalFuncValuesPackage.PF3Value property

Gets the PF3Value.

```csharp
public ushort PF3Value { get; }
```

##### Property Value

The PF3Value.

### PF4ExposureTimeMax
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf4exposuretimemax.md

#### Cr2PersonalFuncValuesPackage.PF4ExposureTimeMax property

Gets the PF4ExposureTimeMax.

```csharp
public ushort PF4ExposureTimeMax { get; }
```

##### Property Value

The PF4ExposureTimeMax.

### PF4ExposureTimeMin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf4exposuretimemin.md

#### Cr2PersonalFuncValuesPackage.PF4ExposureTimeMin property

Gets the PF4ExposureTimeMin.

```csharp
public ushort PF4ExposureTimeMin { get; }
```

##### Property Value

The PF4ExposureTimeMin.

### PF5ApertureMax
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf5aperturemax.md

#### Cr2PersonalFuncValuesPackage.PF5ApertureMax property

Gets the PF5ApertureMax.

```csharp
public ushort PF5ApertureMax { get; }
```

##### Property Value

The PF5ApertureMax.

### PF5ApertureMin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf5aperturemin.md

#### Cr2PersonalFuncValuesPackage.PF5ApertureMin property

Gets the PF5ApertureMin.

```csharp
public ushort PF5ApertureMin { get; }
```

##### Property Value

The PF5ApertureMin.

### PF8BracketShots
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf8bracketshots.md

#### Cr2PersonalFuncValuesPackage.PF8BracketShots property

Gets the PF8BracketShots.

```csharp
public ushort PF8BracketShots { get; }
```

##### Property Value

The PF8BracketShots.

### Cr2ProcessingIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingindex.md

#### Cr2ProcessingIndex enumeration

Defines ids of Cr2Processing tags.

```csharp
public enum Cr2ProcessingIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| ToneCurve | `1` | Indicates the ToneCurve. |
| Sharpness | `2` | Indicates the Sharpness. |
| SharpnessFrequency | `3` | Indicates the SharpnessFrequency. |
| SensorRedLevel | `4` | Indicates the SensorRedLevel. |
| SensorBlueLevel | `5` | Indicates the SensorBlueLevel. |
| WhiteBalanceRed | `6` | Indicates the WhiteBalanceRed. |
| WhiteBalanceBlue | `7` | Indicates the WhiteBalanceBlue. |
| WhiteBalance | `8` | Indicates the WhiteBalance. |
| ColorTemperature | `9` | Indicates the ColorTemperature. |
| PictureStyle | `10` | Indicates the PictureStyle. |
| DigitalGain | `11` | Indicates the DigitalGain. |
| WBShiftAB | `12` | Indicates the WBShiftAB. |
| WBShiftGM | `13` | Indicates the WBShiftGM. |

### Cr2ProcessingPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage.md

#### Cr2ProcessingPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2ProcessingPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2ProcessingPackage() | Initializes a new instance of the `Cr2ProcessingPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColorTemperature { get; } | Gets the ColorTemperature. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalGain { get; } | Gets the DigitalGain. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PictureStyle { get; } | Gets the PictureStyle. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SensorBlueLevel { get; } | Gets the SensorBlueLevel. |
| SensorRedLevel { get; } | Gets the SensorRedLevel. |
| Sharpness { get; } | Gets the Sharpness. |
| SharpnessFrequency { get; } | Gets the SharpnessFrequency. |
| ToneCurve { get; } | Gets the ToneCurve. |
| WBShiftAB { get; } | Gets the WBShiftAB. |
| WBShiftGM { get; } | Gets the WBShiftGM. |
| WhiteBalance { get; } | Gets the WhiteBalance. |
| WhiteBalanceBlue { get; } | Gets the WhiteBalanceBlue. |
| WhiteBalanceRed { get; } | Gets the WhiteBalanceRed. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ColorTemperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/colortemperature.md

#### Cr2ProcessingPackage.ColorTemperature property

Gets the ColorTemperature.

```csharp
public ushort ColorTemperature { get; }
```

##### Property Value

The ColorTemperature.

### Cr2ProcessingPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/cr2processingpackage.md

#### Cr2ProcessingPackage constructor

Initializes a new instance of the `Cr2ProcessingPackage` class.

```csharp
public Cr2ProcessingPackage()
```

### DigitalGain
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/digitalgain.md

#### Cr2ProcessingPackage.DigitalGain property

Gets the DigitalGain.

```csharp
public ushort DigitalGain { get; }
```

##### Property Value

The DigitalGain.

### PictureStyle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/picturestyle.md

#### Cr2ProcessingPackage.PictureStyle property

Gets the PictureStyle.

```csharp
public ushort PictureStyle { get; }
```

##### Property Value

The PictureStyle.

### SensorBlueLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sensorbluelevel.md

#### Cr2ProcessingPackage.SensorBlueLevel property

Gets the SensorBlueLevel.

```csharp
public ushort SensorBlueLevel { get; }
```

##### Property Value

The SensorBlueLevel.

### SensorRedLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sensorredlevel.md

#### Cr2ProcessingPackage.SensorRedLevel property

Gets the SensorRedLevel.

```csharp
public ushort SensorRedLevel { get; }
```

##### Property Value

The SensorRedLevel.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sharpness.md

#### Cr2ProcessingPackage.Sharpness property

Gets the Sharpness.

```csharp
public ushort Sharpness { get; }
```

##### Property Value

The Sharpness.

### SharpnessFrequency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sharpnessfrequency.md

#### Cr2ProcessingPackage.SharpnessFrequency property

Gets the SharpnessFrequency.

```csharp
public ushort SharpnessFrequency { get; }
```

##### Property Value

The SharpnessFrequency.

### ToneCurve
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/tonecurve.md

#### Cr2ProcessingPackage.ToneCurve property

Gets the ToneCurve.

```csharp
public ushort ToneCurve { get; }
```

##### Property Value

The ToneCurve.

### WBShiftAB
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/wbshiftab.md

#### Cr2ProcessingPackage.WBShiftAB property

Gets the WBShiftAB.

```csharp
public ushort WBShiftAB { get; }
```

##### Property Value

The WBShiftAB.

### WBShiftGM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/wbshiftgm.md

#### Cr2ProcessingPackage.WBShiftGM property

Gets the WBShiftGM.

```csharp
public ushort WBShiftGM { get; }
```

##### Property Value

The WBShiftGM.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/whitebalance.md

#### Cr2ProcessingPackage.WhiteBalance property

Gets the WhiteBalance.

```csharp
public ushort WhiteBalance { get; }
```

##### Property Value

The WhiteBalance.

### WhiteBalanceBlue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/whitebalanceblue.md

#### Cr2ProcessingPackage.WhiteBalanceBlue property

Gets the WhiteBalanceBlue.

```csharp
public ushort WhiteBalanceBlue { get; }
```

##### Property Value

The WhiteBalanceBlue.

### WhiteBalanceRed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/whitebalancered.md

#### Cr2ProcessingPackage.WhiteBalanceRed property

Gets the WhiteBalanceRed.

```csharp
public ushort WhiteBalanceRed { get; }
```

##### Property Value

The WhiteBalanceRed.

### Cr2RootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage.md

#### Cr2RootPackage class

Represents an entry point to all metadata packages presented in a particular file CR2.

```csharp
public class Cr2RootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Cr2Package { get; } | Gets the CR2 header metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/cr2package.md

#### Cr2RootPackage.Cr2Package property

Gets the CR2 header metadata package.

```csharp
public Cr2Package Cr2Package { get; }
```

##### Property Value

The CR2 header metadata package.

### Cr2SensorInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfoindex.md

#### Cr2SensorInfoIndex enumeration

Defines ids of Cr2SensorInfo tags.

```csharp
public enum Cr2SensorInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| SensorWidth | `1` | Indicates the SensorWidth. |
| SensorHeight | `2` | Indicates the SensorHeight. |
| Unknown2 | `3` | Unknown tag. |
| Unknown3 | `4` | Unknown tag. |
| SensorLeftBorder | `5` | Indicates the SensorLeftBorder. |
| SensorTopBorder | `6` | Indicates the SensorTopBorder. |
| SensorRightBorder | `7` | Indicates the SensorRightBorder. |
| SensorBottomBorder | `8` | Indicates the SensorBottomBorder. |
| BlackMaskLeftBorder | `9` | Indicates the BlackMaskLeftBorder. |
| BlackMaskTopBorder | `10` | Indicates the BlackMaskTopBorder. |
| BlackMaskRightBorder | `11` | Indicates the BlackMaskRightBorder. |
| BlackMaskBottomBorder | `12` | Indicates the BlackMaskBottomBorder. |

### Cr2SensorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage.md

#### Cr2SensorInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2SensorInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2SensorInfoPackage() | Initializes a new instance of the `Cr2SensorInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| BlackMaskBottomBorder { get; } | Gets the BlackMaskBottomBorder. |
| BlackMaskLeftBorder { get; } | Gets the BlackMaskLeftBorder. |
| BlackMaskRightBorder { get; } | Gets the BlackMaskRightBorder. |
| BlackMaskTopBorder { get; } | Gets the BlackMaskTopBorder. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SensorBottomBorder { get; } | Gets the SensorBottomBorder. |
| SensorHeight { get; } | Gets the SensorHeight. |
| SensorLeftBorder { get; } | Gets the SensorLeftBorder. |
| SensorRightBorder { get; } | Gets the SensorRightBorder. |
| SensorTopBorder { get; } | Gets the SensorTopBorder. |
| SensorWidth { get; } | Gets the SensorWidth. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BlackMaskBottomBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/blackmaskbottomborder.md

#### Cr2SensorInfoPackage.BlackMaskBottomBorder property

Gets the BlackMaskBottomBorder.

```csharp
public ushort BlackMaskBottomBorder { get; }
```

##### Property Value

The BlackMaskBottomBorder.

### BlackMaskLeftBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/blackmaskleftborder.md

#### Cr2SensorInfoPackage.BlackMaskLeftBorder property

Gets the BlackMaskLeftBorder.

```csharp
public ushort BlackMaskLeftBorder { get; }
```

##### Property Value

The BlackMaskLeftBorder.

### BlackMaskRightBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/blackmaskrightborder.md

#### Cr2SensorInfoPackage.BlackMaskRightBorder property

Gets the BlackMaskRightBorder.

```csharp
public ushort BlackMaskRightBorder { get; }
```

##### Property Value

The BlackMaskRightBorder.

### BlackMaskTopBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/blackmasktopborder.md

#### Cr2SensorInfoPackage.BlackMaskTopBorder property

Gets the BlackMaskTopBorder.

```csharp
public ushort BlackMaskTopBorder { get; }
```

##### Property Value

The BlackMaskTopBorder.

### Cr2SensorInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/cr2sensorinfopackage.md

#### Cr2SensorInfoPackage constructor

Initializes a new instance of the `Cr2SensorInfoPackage` class.

```csharp
public Cr2SensorInfoPackage()
```

### SensorBottomBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensorbottomborder.md

#### Cr2SensorInfoPackage.SensorBottomBorder property

Gets the SensorBottomBorder.

```csharp
public ushort SensorBottomBorder { get; }
```

##### Property Value

The SensorBottomBorder.

### SensorHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensorheight.md

#### Cr2SensorInfoPackage.SensorHeight property

Gets the SensorHeight.

```csharp
public ushort SensorHeight { get; }
```

##### Property Value

The SensorHeight.

### SensorLeftBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensorleftborder.md

#### Cr2SensorInfoPackage.SensorLeftBorder property

Gets the SensorLeftBorder.

```csharp
public ushort SensorLeftBorder { get; }
```

##### Property Value

The SensorLeftBorder.

### SensorRightBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensorrightborder.md

#### Cr2SensorInfoPackage.SensorRightBorder property

Gets the SensorRightBorder.

```csharp
public ushort SensorRightBorder { get; }
```

##### Property Value

The SensorRightBorder.

### SensorTopBorder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensortopborder.md

#### Cr2SensorInfoPackage.SensorTopBorder property

Gets the SensorTopBorder.

```csharp
public ushort SensorTopBorder { get; }
```

##### Property Value

The SensorTopBorder.

### SensorWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensorwidth.md

#### Cr2SensorInfoPackage.SensorWidth property

Gets the SensorWidth.

```csharp
public ushort SensorWidth { get; }
```

##### Property Value

The SensorWidth.

### Cr2ShotInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfoindex.md

#### Cr2ShotInfoIndex enumeration

Defines ids of Cr2ShotInfo tags.

```csharp
public enum Cr2ShotInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| AutoISO | `1` | Indicates the AutoISO. |
| BaseISO | `2` | Indicates the BaseISO. |
| MeasuredEV | `3` | Indicates the MeasuredEV. |
| TargetAperture | `4` | Indicates the TargetAperture. |
| TargetExposureTime | `5` | Indicates the TargetExposureTime. |
| ExposureCompensation | `6` | Indicates the ExposureCompensation. |
| WhiteBalance | `7` | Indicates the WhiteBalance. |
| SlowShutter | `8` | Indicates the SlowShutter. |
| SequenceNumber | `9` | Indicates the SequenceNumber. |
| OpticalZoomCode | `10` | Indicates the OpticalZoomCode. |
| Unknown2 | `11` | Unknown tag. |
| CameraTemperature | `12` | Indicates the CameraTemperature. |
| FlashGuideNumber | `13` | Indicates the FlashGuideNumber. |
| AFPointsInFocus | `14` | Indicates the AFPointsInFocus. |
| FlashExposureComp | `15` | Indicates the FlashExposureComp. |
| AutoExposureBracketing | `16` | Indicates the AutoExposureBracketing. |
| AEBBracketValue | `17` | Indicates the AEBBracketValue. |
| ControlMode | `18` | Indicates the ControlMode. |
| FocusDistanceUpper | `19` | Indicates the FocusDistanceUpper. |
| FocusDistanceLower | `20` | Indicates the FocusDistanceLower. |
| FNumber | `21` | Indicates the FNumber. |
| ExposureTime | `22` | Indicates the ExposureTime. |
| MeasuredEV2 | `23` | Indicates the MeasuredEV2. |
| BulbDuration | `24` | Indicates the BulbDuration. |
| Unknown3 | `25` | Unknown tag. |
| CameraType | `26` | Indicates the CameraType. |
| AutoRotate | `27` | Indicates the AutoRotate. |
| NDFilter | `28` | Indicates the NDFilter. |
| SelfTimer2 | `29` | Indicates the SelfTimer2. |
| Unknown4 | `30` | Unknown tag. |
| Unknown5 | `31` | Unknown tag. |
| Unknown6 | `32` | Unknown tag. |
| FlashOutput | `33` | Indicates the FlashOutput. |

### Cr2ShotInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage.md

#### Cr2ShotInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2ShotInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2ShotInfoPackage() | Initializes a new instance of the `Cr2ShotInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AEBBracketValue { get; } | Gets the AEBBracketValue. |
| AFPointsInFocus { get; } | Gets the AFPointsInFocus. |
| AutoExposureBracketing { get; } | Gets the AutoExposureBracketing. |
| AutoISO { get; } | Gets the AutoISO. |
| AutoRotate { get; } | Gets the AutoRotate. |
| BaseISO { get; } | Gets the BaseISO. |
| BulbDuration { get; } | Gets the BulbDuration. |
| CameraTemperature { get; } | Gets the CameraTemperature. |
| CameraType { get; } | Gets the CameraType. |
| ControlMode { get; } | Gets the ControlMode. |
| Count { get; } | Gets the number of metadata properties. |
| ExposureCompensation { get; } | Gets the ExposureCompensation. |
| ExposureTime { get; } | Gets the ExposureTime. |
| FlashExposureComp { get; } | Gets the FlashExposureComp. |
| FlashGuideNumber { get; } | Gets the FlashGuideNumber. |
| FlashOutput { get; } | Gets the FlashOutput. |
| FNumber { get; } | Gets the FNumber. |
| FocusDistanceLower { get; } | Gets the FocusDistanceLower. |
| FocusDistanceUpper { get; } | Gets the FocusDistanceUpper. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MeasuredEV { get; } | Gets the MeasuredEV. |
| MeasuredEV2 { get; } | Gets the MeasuredEV2. |
| MetadataType { get; } | Gets the metadata type. |
| NDFilter { get; } | Gets the NDFilter. |
| OpticalZoomCode { get; } | Gets the OpticalZoomCode. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SelfTimer2 { get; } | Gets the SelfTimer2. |
| SequenceNumber { get; } | Gets the SequenceNumber. |
| SlowShutter { get; } | Gets the SlowShutter. |
| TargetAperture { get; } | Gets the TargetAperture. |
| TargetExposureTime { get; } | Gets the TargetExposureTime. |
| WhiteBalance { get; } | Gets the WhiteBalance. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AEBBracketValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/aebbracketvalue.md

#### Cr2ShotInfoPackage.AEBBracketValue property

Gets the AEBBracketValue.

```csharp
public ushort AEBBracketValue { get; }
```

##### Property Value

The AEBBracketValue.

### AFPointsInFocus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/afpointsinfocus.md

#### Cr2ShotInfoPackage.AFPointsInFocus property

Gets the AFPointsInFocus.

```csharp
public ushort AFPointsInFocus { get; }
```

##### Property Value

The AFPointsInFocus.

### AutoExposureBracketing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/autoexposurebracketing.md

#### Cr2ShotInfoPackage.AutoExposureBracketing property

Gets the AutoExposureBracketing.

```csharp
public ushort AutoExposureBracketing { get; }
```

##### Property Value

The AutoExposureBracketing.

### AutoISO
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/autoiso.md

#### Cr2ShotInfoPackage.AutoISO property

Gets the AutoISO.

```csharp
public ushort AutoISO { get; }
```

##### Property Value

The AutoISO.

### AutoRotate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/autorotate.md

#### Cr2ShotInfoPackage.AutoRotate property

Gets the AutoRotate.

```csharp
public ushort AutoRotate { get; }
```

##### Property Value

The AutoRotate.

### BaseISO
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/baseiso.md

#### Cr2ShotInfoPackage.BaseISO property

Gets the BaseISO.

```csharp
public ushort BaseISO { get; }
```

##### Property Value

The BaseISO.

### BulbDuration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/bulbduration.md

#### Cr2ShotInfoPackage.BulbDuration property

Gets the BulbDuration.

```csharp
public ushort BulbDuration { get; }
```

##### Property Value

The BulbDuration.

### CameraTemperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/cameratemperature.md

#### Cr2ShotInfoPackage.CameraTemperature property

Gets the CameraTemperature.

```csharp
public ushort CameraTemperature { get; }
```

##### Property Value

The CameraTemperature.

### CameraType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/cameratype.md

#### Cr2ShotInfoPackage.CameraType property

Gets the CameraType.

```csharp
public ushort CameraType { get; }
```

##### Property Value

The CameraType.

### ControlMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/controlmode.md

#### Cr2ShotInfoPackage.ControlMode property

Gets the ControlMode.

```csharp
public ushort ControlMode { get; }
```

##### Property Value

The ControlMode.

### Cr2ShotInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/cr2shotinfopackage.md

#### Cr2ShotInfoPackage constructor

Initializes a new instance of the `Cr2ShotInfoPackage` class.

```csharp
public Cr2ShotInfoPackage()
```

### ExposureCompensation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/exposurecompensation.md

#### Cr2ShotInfoPackage.ExposureCompensation property

Gets the ExposureCompensation.

```csharp
public ushort ExposureCompensation { get; }
```

##### Property Value

The ExposureCompensation.

### ExposureTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/exposuretime.md

#### Cr2ShotInfoPackage.ExposureTime property

Gets the ExposureTime.

```csharp
public ushort ExposureTime { get; }
```

##### Property Value

The ExposureTime.

### FlashExposureComp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flashexposurecomp.md

#### Cr2ShotInfoPackage.FlashExposureComp property

Gets the FlashExposureComp.

```csharp
public ushort FlashExposureComp { get; }
```

##### Property Value

The FlashExposureComp.

### FlashGuideNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flashguidenumber.md

#### Cr2ShotInfoPackage.FlashGuideNumber property

Gets the FlashGuideNumber.

```csharp
public ushort FlashGuideNumber { get; }
```

##### Property Value

The FlashGuideNumber.

### FlashOutput
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flashoutput.md

#### Cr2ShotInfoPackage.FlashOutput property

Gets the FlashOutput.

```csharp
public ushort FlashOutput { get; }
```

##### Property Value

The FlashOutput.

### FNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/fnumber.md

#### Cr2ShotInfoPackage.FNumber property

Gets the FNumber.

```csharp
public ushort FNumber { get; }
```

##### Property Value

The FNumber.

### FocusDistanceLower
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/focusdistancelower.md

#### Cr2ShotInfoPackage.FocusDistanceLower property

Gets the FocusDistanceLower.

```csharp
public ushort FocusDistanceLower { get; }
```

##### Property Value

The FocusDistanceLower.

### FocusDistanceUpper
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/focusdistanceupper.md

#### Cr2ShotInfoPackage.FocusDistanceUpper property

Gets the FocusDistanceUpper.

```csharp
public ushort FocusDistanceUpper { get; }
```

##### Property Value

The FocusDistanceUpper.

### MeasuredEV
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/measuredev.md

#### Cr2ShotInfoPackage.MeasuredEV property

Gets the MeasuredEV.

```csharp
public ushort MeasuredEV { get; }
```

##### Property Value

The MeasuredEV.

### MeasuredEV2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/measuredev2.md

#### Cr2ShotInfoPackage.MeasuredEV2 property

Gets the MeasuredEV2.

```csharp
public ushort MeasuredEV2 { get; }
```

##### Property Value

The MeasuredEV2.

### NDFilter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/ndfilter.md

#### Cr2ShotInfoPackage.NDFilter property

Gets the NDFilter.

```csharp
public ushort NDFilter { get; }
```

##### Property Value

The NDFilter.

### OpticalZoomCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/opticalzoomcode.md

#### Cr2ShotInfoPackage.OpticalZoomCode property

Gets the OpticalZoomCode.

```csharp
public ushort OpticalZoomCode { get; }
```

##### Property Value

The OpticalZoomCode.

### SelfTimer2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/selftimer2.md

#### Cr2ShotInfoPackage.SelfTimer2 property

Gets the SelfTimer2.

```csharp
public ushort SelfTimer2 { get; }
```

##### Property Value

The SelfTimer2.

### SequenceNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/sequencenumber.md

#### Cr2ShotInfoPackage.SequenceNumber property

Gets the SequenceNumber.

```csharp
public ushort SequenceNumber { get; }
```

##### Property Value

The SequenceNumber.

### SlowShutter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/slowshutter.md

#### Cr2ShotInfoPackage.SlowShutter property

Gets the SlowShutter.

```csharp
public ushort SlowShutter { get; }
```

##### Property Value

The SlowShutter.

### TargetAperture
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/targetaperture.md

#### Cr2ShotInfoPackage.TargetAperture property

Gets the TargetAperture.

```csharp
public ushort TargetAperture { get; }
```

##### Property Value

The TargetAperture.

### TargetExposureTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/targetexposuretime.md

#### Cr2ShotInfoPackage.TargetExposureTime property

Gets the TargetExposureTime.

```csharp
public ushort TargetExposureTime { get; }
```

##### Property Value

The TargetExposureTime.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/whitebalance.md

#### Cr2ShotInfoPackage.WhiteBalance property

Gets the WhiteBalance.

```csharp
public ushort WhiteBalance { get; }
```

##### Property Value

The WhiteBalance.

### Cr2TimeInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfoindex.md

#### Cr2TimeInfoIndex enumeration

Defines ids of Cr2TimeInfo tags.

```csharp
public enum Cr2TimeInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown1 | `0` | Unknown tag. |
| TimeZone | `1` | Indicates the TimeZone. |
| TimeZoneCity | `2` | Indicates the TimeZoneCity. |
| DaylightSavings | `3` | Indicates the DaylightSavings. |

### Cr2TimeInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage.md

#### Cr2TimeInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2TimeInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2TimeInfoPackage() | Initializes a new instance of the `Cr2TimeInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DaylightSavings { get; } | Gets the DaylightSavings. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TimeZone { get; } | Gets the TimeZone. |
| TimeZoneCity { get; } | Gets the TimeZoneCity. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2TimeInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/cr2timeinfopackage.md

#### Cr2TimeInfoPackage constructor

Initializes a new instance of the `Cr2TimeInfoPackage` class.

```csharp
public Cr2TimeInfoPackage()
```

### DaylightSavings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/daylightsavings.md

#### Cr2TimeInfoPackage.DaylightSavings property

Gets the DaylightSavings.

```csharp
public int DaylightSavings { get; }
```

##### Property Value

The DaylightSavings.

### TimeZone
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/timezone.md

#### Cr2TimeInfoPackage.TimeZone property

Gets the TimeZone.

```csharp
public int TimeZone { get; }
```

##### Property Value

The TimeZone.

### TimeZoneCity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/timezonecity.md

#### Cr2TimeInfoPackage.TimeZoneCity property

Gets the TimeZoneCity.

```csharp
public int TimeZoneCity { get; }
```

##### Property Value

The TimeZoneCity.

### Cr2VignettingCorr2Index
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2index.md

#### Cr2VignettingCorr2Index enumeration

Defines ids of Cr2VignettingCorr2 tags.

```csharp
public enum Cr2VignettingCorr2Index
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PeripheralLightingSetting | `5` | Indicates the PeripheralLightingSetting. |
| ChromaticAberrationSetting | `6` | Indicates the ChromaticAberrationSetting. |
| DistortionCorrectionSetting | `7` | Indicates the DistortionCorrectionSetting. |
| DigitalLensOptimizerSetting | `9` | Indicates the DigitalLensOptimizerSetting. |

### Cr2VignettingCorr2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package.md

#### Cr2VignettingCorr2Package class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2VignettingCorr2Package : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2VignettingCorr2Package() | Initializes a new instance of the `Cr2VignettingCorr2Package` class. |

#### Properties

| Name | Description |
| --- | --- |
| ChromaticAberrationSetting { get; } | Gets the ChromaticAberrationSetting. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalLensOptimizerSetting { get; } | Gets the DigitalLensOptimizerSetting. |
| DistortionCorrectionSetting { get; } | Gets the DistortionCorrectionSetting. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PeripheralLightingSetting { get; } | Gets the PeripheralLightingSetting. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ChromaticAberrationSetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/chromaticaberrationsetting.md

#### Cr2VignettingCorr2Package.ChromaticAberrationSetting property

Gets the ChromaticAberrationSetting.

```csharp
public int ChromaticAberrationSetting { get; }
```

##### Property Value

The ChromaticAberrationSetting.

### Cr2VignettingCorr2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/cr2vignettingcorr2package.md

#### Cr2VignettingCorr2Package constructor

Initializes a new instance of the `Cr2VignettingCorr2Package` class.

```csharp
public Cr2VignettingCorr2Package()
```

### DigitalLensOptimizerSetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/digitallensoptimizersetting.md

#### Cr2VignettingCorr2Package.DigitalLensOptimizerSetting property

Gets the DigitalLensOptimizerSetting.

```csharp
public int DigitalLensOptimizerSetting { get; }
```

##### Property Value

The DigitalLensOptimizerSetting.

### DistortionCorrectionSetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/distortioncorrectionsetting.md

#### Cr2VignettingCorr2Package.DistortionCorrectionSetting property

Gets the DistortionCorrectionSetting.

```csharp
public int DistortionCorrectionSetting { get; }
```

##### Property Value

The DistortionCorrectionSetting.

### PeripheralLightingSetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/peripherallightingsetting.md

#### Cr2VignettingCorr2Package.PeripheralLightingSetting property

Gets the PeripheralLightingSetting.

```csharp
public int PeripheralLightingSetting { get; }
```

##### Property Value

The PeripheralLightingSetting.

### Cr2WBInfoIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfoindex.md

#### Cr2WBInfoIndex enumeration

Defines ids of Cr2WBInfo tags.

```csharp
public enum Cr2WBInfoIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| WB_GRBGLevelsAuto | `2` | Indicates the WB_GRBGLevelsAuto. |
| Unknown1 | `3` | Unknown tag. |
| WB_GRBGLevelsDaylight | `10` | Indicates the WB_GRBGLevelsDaylight. |
| Unknown2 | `11` | Unknown tag. |
| WB_GRBGLevelsCloudy | `18` | Indicates the WB_GRBGLevelsCloudy. |
| Unknown3 | `19` | Unknown tag. |
| WB_GRBGLevelsTungsten | `26` | Indicates the WB_GRBGLevelsTungsten. |
| Unknown4 | `27` | Unknown tag. |
| WB_GRBGLevelsFluorescent | `34` | Indicates the WB_GRBGLevelsFluorescent. |
| Unknown5 | `35` | Unknown tag. |
| WB_GRBGLevelsFluorHigh | `42` | Indicates the WB_GRBGLevelsFluorHigh. |
| Unknown6 | `43` | Unknown tag. |
| WB_GRBGLevelsFlash | `50` | Indicates the WB_GRBGLevelsFlash. |
| Unknown7 | `51` | Unknown tag. |
| WB_GRBGLevelsUnderwater | `58` | Indicates the WB_GRBGLevelsUnderwater. |
| Unknown8 | `59` | Unknown tag. |
| WB_GRBGLevelsCustom1 | `66` | Indicates the WB_GRBGLevelsCustom1. |
| Unknown9 | `67` | Unknown tag. |
| WB_GRBGLevelsCustom2 | `74` | Indicates the WB_GRBGLevelsCustom2. |

### Cr2WBInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage.md

#### Cr2WBInfoPackage class

Represents Canon MakerNotes tags.

```csharp
public sealed class Cr2WBInfoPackage : RawDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| Cr2WBInfoPackage() | Initializes a new instance of the `Cr2WBInfoPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| WB_GRBGLevelsAuto { get; } | Gets the WB_GRBGLevelsAuto. |
| WB_GRBGLevelsCloudy { get; } | Gets the WB_GRBGLevelsCloudy. |
| WB_GRBGLevelsCustom1 { get; } | Gets the WB_GRBGLevelsCustom1. |
| WB_GRBGLevelsCustom2 { get; } | Gets the WB_GRBGLevelsCustom2. |
| WB_GRBGLevelsDaylight { get; } | Gets the WB_GRBGLevelsDaylight. |
| WB_GRBGLevelsFlash { get; } | Gets the WB_GRBGLevelsFlash. |
| WB_GRBGLevelsFluorescent { get; } | Gets the WB_GRBGLevelsFluorescent. |
| WB_GRBGLevelsFluorHigh { get; } | Gets the WB_GRBGLevelsFluorHigh. |
| WB_GRBGLevelsTungsten { get; } | Gets the WB_GRBGLevelsTungsten. |
| WB_GRBGLevelsUnderwater { get; } | Gets the WB_GRBGLevelsUnderwater. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Cr2WBInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/cr2wbinfopackage.md

#### Cr2WBInfoPackage constructor

Initializes a new instance of the `Cr2WBInfoPackage` class.

```csharp
public Cr2WBInfoPackage()
```

### WB_GRBGLevelsAuto
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsauto.md

#### Cr2WBInfoPackage.WB_GRBGLevelsAuto property

Gets the WB_GRBGLevelsAuto.

```csharp
public int[] WB_GRBGLevelsAuto { get; }
```

##### Property Value

The WB_GRBGLevelsAuto.

### WB_GRBGLevelsCloudy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelscloudy.md

#### Cr2WBInfoPackage.WB_GRBGLevelsCloudy property

Gets the WB_GRBGLevelsCloudy.

```csharp
public int[] WB_GRBGLevelsCloudy { get; }
```

##### Property Value

The WB_GRBGLevelsCloudy.

### WB_GRBGLevelsCustom1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelscustom1.md

#### Cr2WBInfoPackage.WB_GRBGLevelsCustom1 property

Gets the WB_GRBGLevelsCustom1.

```csharp
public int[] WB_GRBGLevelsCustom1 { get; }
```

##### Property Value

The WB_GRBGLevelsCustom1.

### WB_GRBGLevelsCustom2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelscustom2.md

#### Cr2WBInfoPackage.WB_GRBGLevelsCustom2 property

Gets the WB_GRBGLevelsCustom2.

```csharp
public int[] WB_GRBGLevelsCustom2 { get; }
```

##### Property Value

The WB_GRBGLevelsCustom2.

### WB_GRBGLevelsDaylight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsdaylight.md

#### Cr2WBInfoPackage.WB_GRBGLevelsDaylight property

Gets the WB_GRBGLevelsDaylight.

```csharp
public int[] WB_GRBGLevelsDaylight { get; }
```

##### Property Value

The WB_GRBGLevelsDaylight.

### WB_GRBGLevelsFlash
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsflash.md

#### Cr2WBInfoPackage.WB_GRBGLevelsFlash property

Gets the WB_GRBGLevelsFlash.

```csharp
public int[] WB_GRBGLevelsFlash { get; }
```

##### Property Value

The WB_GRBGLevelsFlash.

### WB_GRBGLevelsFluorescent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsfluorescent.md

#### Cr2WBInfoPackage.WB_GRBGLevelsFluorescent property

Gets the WB_GRBGLevelsFluorescent.

```csharp
public int[] WB_GRBGLevelsFluorescent { get; }
```

##### Property Value

The WB_GRBGLevelsFluorescent.

### WB_GRBGLevelsFluorHigh
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsfluorhigh.md

#### Cr2WBInfoPackage.WB_GRBGLevelsFluorHigh property

Gets the WB_GRBGLevelsFluorHigh.

```csharp
public int[] WB_GRBGLevelsFluorHigh { get; }
```

##### Property Value

The WB_GRBGLevelsFluorHigh.

### WB_GRBGLevelsTungsten
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelstungsten.md

#### Cr2WBInfoPackage.WB_GRBGLevelsTungsten property

Gets the WB_GRBGLevelsTungsten.

```csharp
public int[] WB_GRBGLevelsTungsten { get; }
```

##### Property Value

The WB_GRBGLevelsTungsten.

### WB_GRBGLevelsUnderwater
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbglevelsunderwater.md

#### Cr2WBInfoPackage.WB_GRBGLevelsUnderwater property

Gets the WB_GRBGLevelsUnderwater.

```csharp
public int[] WB_GRBGLevelsUnderwater { get; }
```

##### Property Value

The WB_GRBGLevelsUnderwater.

### GroupDocs.Metadata.Formats.Raw.Tag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag.md

#### Classes

| Class | Description |
| --- | --- |
| RawArrayTag&lt;T&gt; | Represents an array-based TIFF tag. |
| RawAsciiTag | Represents a Raw ASCII tag. |
| RawByteTag | Represents an byte-based TIFF tag. |
| RawLongTag | Represents a Raw Long tag. |
| RawShortTag | Represents a Raw Short tag. |
| RawTag | Represents a RawTag property. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### RawArrayTagT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawarraytag-1.md

#### RawArrayTag&lt;T&gt; class

Represents an array-based TIFF tag.

```csharp
public abstract class RawArrayTag<T> : RawTag
```

| Parameter | Description |
| --- | --- |
| T | The type of array values. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawarraytag-1/equals.md

#### RawArrayTag&lt;T&gt;.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawarraytag-1/gethashcode.md

#### RawArrayTag&lt;T&gt;.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### TagValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawarraytag-1/tagvalue.md

#### RawArrayTag&lt;T&gt;.TagValue property

Gets the tag value.

```csharp
public T[] TagValue { get; }
```

##### Property Value

The tag value.

### RawAsciiTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawasciitag.md

#### RawAsciiTag class

Represents a Raw ASCII tag.

```csharp
public sealed class RawAsciiTag : RawTag
```

#### Constructors

| Name | Description |
| --- | --- |
| RawAsciiTag(uint, string) | Initializes a new instance of the `RawAsciiTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawasciitag/equals.md

#### RawAsciiTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawasciitag/gethashcode.md

#### RawAsciiTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawAsciiTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawasciitag/rawasciitag.md

#### RawAsciiTag constructor

Initializes a new instance of the `RawAsciiTag` class.

```csharp
public RawAsciiTag(uint tagID, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | String | The value. |

### TagValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawasciitag/tagvalue.md

#### RawAsciiTag.TagValue property

Gets the tag value.

```csharp
public string TagValue { get; }
```

##### Property Value

The tag value.

### RawByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawbytetag.md

#### RawByteTag class

Represents an byte-based TIFF tag.

```csharp
public sealed class RawByteTag : RawArrayTag<byte>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawByteTag(uint, byte[]) | Initializes a new instance of the `TiffByteTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawbytetag/equals.md

#### RawByteTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawbytetag/gethashcode.md

#### RawByteTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawByteTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawbytetag/rawbytetag.md

#### RawByteTag constructor

Initializes a new instance of the `TiffByteTag` class.

```csharp
public RawByteTag(uint tagID, byte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | Byte[] | The value. |

### RawLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawlongtag.md

#### RawLongTag class

Represents a Raw Long tag.

```csharp
public sealed class RawLongTag : RawArrayTag<uint>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawLongTag(uint, uint[]) | Initializes a new instance of the `RawLongTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawlongtag/equals.md

#### RawLongTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawlongtag/gethashcode.md

#### RawLongTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawLongTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawlongtag/rawlongtag.md

#### RawLongTag constructor

Initializes a new instance of the `RawLongTag` class.

```csharp
public RawLongTag(uint tagID, uint[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | UInt32[] | The value. |

### RawShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawshorttag.md

#### RawShortTag class

Represents a Raw Short tag.

```csharp
public sealed class RawShortTag : RawArrayTag<ushort>
```

#### Constructors

| Name | Description |
| --- | --- |
| RawShortTag(uint, ushort[]) | Initializes a new instance of the `RawShortTag` class. |

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| TagValue { get; } | Gets the tag value. |
| Value { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Equals method. |
| override GetHashCode() | GetHashCode method. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawshorttag/equals.md

#### RawShortTag.Equals method

Equals method.

```csharp
public override bool Equals(object obj)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawshorttag/gethashcode.md

#### RawShortTag.GetHashCode method

GetHashCode method.

```csharp
public override int GetHashCode()
```

### RawShortTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawshorttag/rawshorttag.md

#### RawShortTag constructor

Initializes a new instance of the `RawShortTag` class.

```csharp
public RawShortTag(uint tagID, ushort[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagID | UInt32 | The tag identifier. |
| value | UInt16[] | The value. |

### RawTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawtag.md

#### RawTag class

Represents a RawTag property.

```csharp
public abstract class RawTag : MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| Value { get; } | Gets the property value. |

### TagID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawtag/tagid.md

#### RawTag.TagID property

Gets the tag id.

```csharp
public uint TagID { get; }
```

##### Property Value

The tag id.

### TagType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.tag/rawtag/tagtype.md

#### RawTag.TagType property

Gets the type of the tag.

```csharp
public RawTagType TagType { get; }
```

##### Property Value

The tag type.

### GroupDocs.Metadata.Formats.Raw
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw.md

#### Classes

| Class | Description |
| --- | --- |
| ExifTag | Represents a ExifTag property. |
| GpsIfdPackage | Represents GPS IFD. |
| InteroperabilityIFDPointerPackage | Represents Interoperability IFD. |
| RawDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| RawExifTagPackage | Represents Exif tags. |
| RawIFD1Package | Represents IFD1 tags. |
| RawIFD2Package | Represents IFD1 tags. |
| RawIFD3Package | Represents IFD1 tags. |
| RawMakerNotePackage | Represents Raw MakerNotes tags. |
| RawPackage | Represents Raw Package. |
| RawTiffTagPackage | Represents Tiff tags. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ExifTagID | Defines ids of Exif tags. |
| GpsIfdIndex | Defines ids of GpsIfd tags. |
| InteroperabilityIFDPointerIndex | Defines ids of InteroperabilityIFDPointer tags. |
| RawExifIndex | Defines ids of RawExif tags. |
| RawTagType | Represents the IFD data type. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ExifTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/exiftag.md

#### ExifTag class

Represents a ExifTag property.

```csharp
public abstract class ExifTag : MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| TagID { get; } | Gets the tag id. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| TagType { get; } | Gets the type of the tag. |
| Value { get; } | Gets the property value. |

### TagID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/exiftag/tagid.md

#### ExifTag.TagID property

Gets the tag id.

```csharp
public ExifTagID TagID { get; }
```

##### Property Value

The tag id.

### TagType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/exiftag/tagtype.md

#### ExifTag.TagType property

Gets the type of the tag.

```csharp
public TiffTagType TagType { get; }
```

##### Property Value

The tag type.

### ExifTagID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/exiftagid.md

#### ExifTagID enumeration

Defines ids of Exif tags.

```csharp
public enum ExifTagID : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ExposureTime | `33434` | Exposure Time |
| FNumber | `33437` | F-Number |
| ExposureProgram | `34850` | ExposureProgram |
| SpectralSensitivity | `34852` | SpectralSensitivity |
| GPSInfo | `34853` | GPSInfo |
| ISOSpeedRatings | `34855` | ISO Speed Ratings |
| MakerNoteCanon | `37500` | ISO Speed Ratings |

### GpsIfdIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdindex.md

#### GpsIfdIndex enumeration

Defines ids of GpsIfd tags.

```csharp
public enum GpsIfdIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| GPSVersionID | `0` | Indicates the GPSVersionID. |
| GPSLatitudeRef | `1` | Indicates the GPSLatitudeRef. |
| GPSLatitude | `2` | Indicates the GPSLatitude. |
| GPSLongitudeRef | `3` | Indicates the GPSLongitudeRef. |
| GPSLongitude | `4` | Indicates the GPSLongitude. |
| GPSAltitudeRef | `5` | Indicates the GPSAltitudeRef. |
| GPSAltitude | `6` | Indicates the GPSAltitude. |
| GPSTimeStamp | `7` | Indicates the GPSTimeStamp. |
| GPSSatellites | `8` | Indicates the GPSSatellites. |
| GPSStatus | `9` | Indicates the GPSStatus. |
| GPSMeasureMode | `10` | Indicates the GPSMeasureMode. |
| GPSDOP | `11` | Indicates the GPSDOP. |
| GPSSpeedRef | `12` | Indicates the GPSSpeedRef. |
| GPSSpeed | `13` | Indicates the GPSSpeed. |
| GPSTrackRef | `14` | Indicates the GPSTrackRef. |
| GPSTrack | `15` | Indicates the GPSTrack. |
| GPSImgDirectionRef | `16` | Indicates the GPSImgDirectionRef. |
| GPSImgDirection | `17` | Indicates the GPSImgDirection. |
| GPSMapDatum | `18` | Indicates the GPSMapDatum. |
| GPSDestLatitudeRef | `19` | Indicates the GPSDestLatitudeRef. |
| GPSDestLatitude | `20` | Indicates the GPSDestLatitude. |
| GPSDestLongitudeRef | `21` | Indicates the GPSDestLongitudeRef. |
| GPSDestLongitude | `22` | Indicates the GPSDestLongitude. |
| GPSDestBearingRef | `23` | Indicates the GPSDestBearingRef. |
| GPSDestBearing | `24` | Indicates the GPSDestBearing. |
| GPSDestDistanceRef | `25` | Indicates the GPSDestDistanceRef. |
| GPSDestDistance | `26` | Indicates the GPSDestDistance. |
| GPSProcessingMethod | `27` | Indicates the GPSProcessingMethod. |
| GPSAreaInformation | `28` | Indicates the GPSAreaInformation. |
| GPSDateStamp | `29` | Indicates the GPSDateStamp. |
| GPSDifferential | `30` | Indicates the GPSDifferential. |
| GPSHPositioningError | `31` | Indicates the GPSHPositioningError. |

### GpsIfdPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage.md

#### GpsIfdPackage class

Represents GPS IFD.

```csharp
public sealed class GpsIfdPackage : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| GPSAltitude { get; } | Gets the GPSAltitude. |
| GPSAltitudeRef { get; } | Gets the GPSAltitudeRef. |
| GPSAreaInformation { get; } | Gets the GPSAreaInformation. |
| GPSDateStamp { get; } | Gets the GPSDateStamp. |
| GPSDestBearing { get; } | Gets the GPSDestBearing. |
| GPSDestBearingRef { get; } | Gets the GPSDestBearingRef. |
| GPSDestDistance { get; } | Gets the GPSDestDistance. |
| GPSDestDistanceRef { get; } | Gets the GPSDestDistanceRef. |
| GPSDestLatitude { get; } | Gets the GPSDestLatitude. |
| GPSDestLatitudeRef { get; } | Gets the GPSDestLatitudeRef. |
| GPSDestLongitude { get; } | Gets the GPSDestLongitude. |
| GPSDestLongitudeRef { get; } | Gets the GPSDestLongitudeRef. |
| GPSDifferential { get; } | Gets the GPSDifferential. |
| GPSDOP { get; } | Gets the GPSDOP. |
| GPSHPositioningError { get; } | Gets the GPSHPositioningError. |
| GPSImgDirection { get; } | Gets the GPSImgDirection. |
| GPSImgDirectionRef { get; } | Gets the GPSImgDirectionRef. |
| GPSLatitude { get; } | Gets the GPSLatitude. |
| GPSLatitudeRef { get; } | Gets the GPSLatitudeRef. |
| GPSLongitude { get; } | Gets the GPSLongitude. |
| GPSLongitudeRef { get; } | Gets the GPSLongitudeRef. |
| GPSMapDatum { get; } | Gets the GPSMapDatum. |
| GPSMeasureMode { get; } | Gets the GPSMeasureMode. |
| GPSProcessingMethod { get; } | Gets the GPSProcessingMethod. |
| GPSSatellites { get; } | Gets the GPSSatellites. |
| GPSSpeed { get; } | Gets the GPSSpeed. |
| GPSSpeedRef { get; } | Gets the GPSSpeedRef. |
| GPSStatus { get; } | Gets the GPSStatus. |
| GPSTimeStamp { get; } | Gets the GPSTimeStamp. |
| GPSTrack { get; } | Gets the GPSTrack. |
| GPSTrackRef { get; } | Gets the GPSTrackRef. |
| GPSVersionID { get; } | Gets the GPSVersionID. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### GPSAltitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsaltitude.md

#### GpsIfdPackage.GPSAltitude property

Gets the GPSAltitude.

```csharp
public float GPSAltitude { get; }
```

##### Property Value

The GPSAltitude.

### GPSAltitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsaltituderef.md

#### GpsIfdPackage.GPSAltitudeRef property

Gets the GPSAltitudeRef.

```csharp
public byte GPSAltitudeRef { get; }
```

##### Property Value

The GPSAltitudeRef.

### GPSAreaInformation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsareainformation.md

#### GpsIfdPackage.GPSAreaInformation property

Gets the GPSAreaInformation.

```csharp
public ushort GPSAreaInformation { get; }
```

##### Property Value

The GPSAreaInformation.

### GPSDateStamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdatestamp.md

#### GpsIfdPackage.GPSDateStamp property

Gets the GPSDateStamp.

```csharp
public string GPSDateStamp { get; }
```

##### Property Value

The GPSDateStamp.

### GPSDestBearing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestbearing.md

#### GpsIfdPackage.GPSDestBearing property

Gets the GPSDestBearing.

```csharp
public float GPSDestBearing { get; }
```

##### Property Value

The GPSDestBearing.

### GPSDestBearingRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestbearingref.md

#### GpsIfdPackage.GPSDestBearingRef property

Gets the GPSDestBearingRef.

```csharp
public string GPSDestBearingRef { get; }
```

##### Property Value

The GPSDestBearingRef.

### GPSDestDistance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestdistance.md

#### GpsIfdPackage.GPSDestDistance property

Gets the GPSDestDistance.

```csharp
public float GPSDestDistance { get; }
```

##### Property Value

The GPSDestDistance.

### GPSDestDistanceRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestdistanceref.md

#### GpsIfdPackage.GPSDestDistanceRef property

Gets the GPSDestDistanceRef.

```csharp
public string GPSDestDistanceRef { get; }
```

##### Property Value

The GPSDestDistanceRef.

### GPSDestLatitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestlatitude.md

#### GpsIfdPackage.GPSDestLatitude property

Gets the GPSDestLatitude.

```csharp
public double[] GPSDestLatitude { get; }
```

##### Property Value

The GPSDestLatitude.

### GPSDestLatitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestlatituderef.md

#### GpsIfdPackage.GPSDestLatitudeRef property

Gets the GPSDestLatitudeRef.

```csharp
public string GPSDestLatitudeRef { get; }
```

##### Property Value

The GPSDestLatitudeRef.

### GPSDestLongitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestlongitude.md

#### GpsIfdPackage.GPSDestLongitude property

Gets the GPSDestLongitude.

```csharp
public double[] GPSDestLongitude { get; }
```

##### Property Value

The GPSDestLongitude.

### GPSDestLongitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdestlongituderef.md

#### GpsIfdPackage.GPSDestLongitudeRef property

Gets the GPSDestLongitudeRef.

```csharp
public string GPSDestLongitudeRef { get; }
```

##### Property Value

The GPSDestLongitudeRef.

### GPSDifferential
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdifferential.md

#### GpsIfdPackage.GPSDifferential property

Gets the GPSDifferential.

```csharp
public ushort GPSDifferential { get; }
```

##### Property Value

The GPSDifferential.

### GPSDOP
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdop.md

#### GpsIfdPackage.GPSDOP property

Gets the GPSDOP.

```csharp
public float GPSDOP { get; }
```

##### Property Value

The GPSDOP.

### GPSHPositioningError
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpshpositioningerror.md

#### GpsIfdPackage.GPSHPositioningError property

Gets the GPSHPositioningError.

```csharp
public float GPSHPositioningError { get; }
```

##### Property Value

The GPSHPositioningError.

### GPSImgDirection
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsimgdirection.md

#### GpsIfdPackage.GPSImgDirection property

Gets the GPSImgDirection.

```csharp
public float GPSImgDirection { get; }
```

##### Property Value

The GPSImgDirection.

### GPSImgDirectionRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsimgdirectionref.md

#### GpsIfdPackage.GPSImgDirectionRef property

Gets the GPSImgDirectionRef.

```csharp
public string GPSImgDirectionRef { get; }
```

##### Property Value

The GPSImgDirectionRef.

### GPSLatitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpslatitude.md

#### GpsIfdPackage.GPSLatitude property

Gets the GPSLatitude.

```csharp
public double[] GPSLatitude { get; }
```

##### Property Value

The GPSLatitude.

### GPSLatitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpslatituderef.md

#### GpsIfdPackage.GPSLatitudeRef property

Gets the GPSLatitudeRef.

```csharp
public string GPSLatitudeRef { get; }
```

##### Property Value

The GPSLatitudeRef.

### GPSLongitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpslongitude.md

#### GpsIfdPackage.GPSLongitude property

Gets the GPSLongitude.

```csharp
public double[] GPSLongitude { get; }
```

##### Property Value

The GPSLongitude.

### GPSLongitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpslongituderef.md

#### GpsIfdPackage.GPSLongitudeRef property

Gets the GPSLongitudeRef.

```csharp
public string GPSLongitudeRef { get; }
```

##### Property Value

The GPSLongitudeRef.

### GPSMapDatum
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsmapdatum.md

#### GpsIfdPackage.GPSMapDatum property

Gets the GPSMapDatum.

```csharp
public string GPSMapDatum { get; }
```

##### Property Value

The GPSMapDatum.

### GPSMeasureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsmeasuremode.md

#### GpsIfdPackage.GPSMeasureMode property

Gets the GPSMeasureMode.

```csharp
public string GPSMeasureMode { get; }
```

##### Property Value

The GPSMeasureMode.

### GPSProcessingMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsprocessingmethod.md

#### GpsIfdPackage.GPSProcessingMethod property

Gets the GPSProcessingMethod.

```csharp
public string GPSProcessingMethod { get; }
```

##### Property Value

The GPSProcessingMethod.

### GPSSatellites
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpssatellites.md

#### GpsIfdPackage.GPSSatellites property

Gets the GPSSatellites.

```csharp
public string GPSSatellites { get; }
```

##### Property Value

The GPSSatellites.

### GPSSpeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsspeed.md

#### GpsIfdPackage.GPSSpeed property

Gets the GPSSpeed.

```csharp
public float GPSSpeed { get; }
```

##### Property Value

The GPSSpeed.

### GPSSpeedRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsspeedref.md

#### GpsIfdPackage.GPSSpeedRef property

Gets the GPSSpeedRef.

```csharp
public string GPSSpeedRef { get; }
```

##### Property Value

The GPSSpeedRef.

### GPSStatus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsstatus.md

#### GpsIfdPackage.GPSStatus property

Gets the GPSStatus.

```csharp
public string GPSStatus { get; }
```

##### Property Value

The GPSStatus.

### GPSTimeStamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpstimestamp.md

#### GpsIfdPackage.GPSTimeStamp property

Gets the GPSTimeStamp.

```csharp
public double[] GPSTimeStamp { get; }
```

##### Property Value

The GPSTimeStamp.

### GPSTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpstrack.md

#### GpsIfdPackage.GPSTrack property

Gets the GPSTrack.

```csharp
public float GPSTrack { get; }
```

##### Property Value

The GPSTrack.

### GPSTrackRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpstrackref.md

#### GpsIfdPackage.GPSTrackRef property

Gets the GPSTrackRef.

```csharp
public string GPSTrackRef { get; }
```

##### Property Value

The GPSTrackRef.

### GPSVersionID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsversionid.md

#### GpsIfdPackage.GPSVersionID property

Gets the GPSVersionID.

```csharp
public byte[] GPSVersionID { get; }
```

##### Property Value

The GPSVersionID.

### InteroperabilityIFDPointerIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/interoperabilityifdpointerindex.md

#### InteroperabilityIFDPointerIndex enumeration

Defines ids of InteroperabilityIFDPointer tags.

```csharp
public enum InteroperabilityIFDPointerIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| TagInteropIndex | `1` | Indicates the TagInteropIndex. |
| TagInteropVersion | `2` | Indicates the TagInteropVersion. |

### InteroperabilityIFDPointerPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage.md

#### InteroperabilityIFDPointerPackage class

Represents Interoperability IFD.

```csharp
public sealed class InteroperabilityIFDPointerPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TagInteropIndex { get; } | Gets the TagInteropIndex. |
| TagInteropVersion { get; } | Gets the TagInteropVersion. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### TagInteropIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/taginteropindex.md

#### InteroperabilityIFDPointerPackage.TagInteropIndex property

Gets the TagInteropIndex.

```csharp
public string TagInteropIndex { get; }
```

##### Property Value

The TagInteropIndex.

### TagInteropVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/taginteropversion.md

#### InteroperabilityIFDPointerPackage.TagInteropVersion property

Gets the TagInteropVersion.

```csharp
public byte[] TagInteropVersion { get; }
```

##### Property Value

The TagInteropVersion.

### RawDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage.md

#### RawDictionaryBasePackage class

Provides an abstract base class for EXIF metadata dictionaries.

```csharp
public abstract class RawDictionaryBasePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/clear.md

#### RawDictionaryBasePackage.Clear method

Removes all Raw tags stored in the package.

```csharp
public void Clear()
```

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/item.md

#### RawDictionaryBasePackage indexer

Gets the Raw tag with the specified id.

```csharp
public RawTag this[uint tagId] { get; }
```

| Parameter | Description |
| --- | --- |
| tagId | The id of the tag to retrieve. |

##### Return Value

The `RawTag` with the specified tag id.

##### Examples

This example demonstrates how to read a specific Raw/EXIF tag by its identifier.

```csharp
using (Metadata metadata = new Metadata(Constants.RawWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null && root.ExifPackage != null)
    {
        RawAsciiTag software = (RawAsciiTag)root.ExifPackage[uint.Software];
        if (software != null)
        {
            Console.WriteLine("Software: {0}", software.Value);
        }
    }
}
```

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/remove.md

#### RawDictionaryBasePackage.Remove method

Removes the property with the specified id.

```csharp
public bool Remove(uint tagId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagId | UInt32 | A Raw tag id. |

##### Return Value

True if the specified Raw tag is found and removed; otherwise, false.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/set.md

#### RawDictionaryBasePackage.Set method

Adds or replaces the specified tag.

```csharp
public void Set(RawTag tag)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tag | RawTag | The tag to set. |

##### Examples

This code sample demonstrates how to add a custom tag to an EXIF package.

```csharp
using (Metadata metadata = new Metadata(Constants.RawWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null)
    {
        // Set the EXIF package if it's missing
        if (root.ExifPackage == null)
        {
            root.ExifPackage = new ExifPackage();
        }

        // Add a known property
        root.ExifPackage.Set(new RawAsciiTag(uint.Artist, "test artist"));

        // Add a fully custom property (which is not described in the EXIF specification).
        // Please note that the chosen ID may intersect with the IDs used by some third party tools.
        root.ExifPackage.Set(new RawAsciiTag((uint)65523, "custom"));

        metadata.Save(Constants.OutputRaw);
    }
}
```

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/tolist.md

#### RawDictionaryBasePackage.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<RawTag> ToList()
```

##### Return Value

A list that contains all Raw tags from the package.

##### Examples

This example demonstrates how to read all EXIF tags extracted from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null && root.ExifPackage != null)
    {
        const string pattern = "{0} = {1}";

        foreach (RawTag tag in root.ExifPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }

        foreach (RawTag tag in root.ExifPackage.ExifIfdPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }

        foreach (RawTag tag in root.ExifPackage.GpsPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }
    }
}
```

### RawExifIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexifindex.md

#### RawExifIndex enumeration

Defines ids of RawExif tags.

```csharp
public enum RawExifIndex
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ExposureTime | `33434` | Indicates the ExposureTime. |
| FNumber | `33437` | Indicates the FNumber. |
| ExposureProgram | `34850` | Indicates the ExposureProgram. |
| SpectralSensitivity | `34852` | Indicates the SpectralSensitivity. |
| PhotographicSensitivity | `34855` | Indicates the PhotographicSensitivity. |
| OECF | `34856` | Indicates the OECF. |
| SensitivityType | `34864` | Indicates the SensitivityType. |
| StandardOutputSensitivity | `34865` | Indicates the StandardOutputSensitivity. |
| RecommendedExposureIndex | `34866` | Indicates the RecommendedExposureIndex. |
| ISOSpeed | `34867` | Indicates the ISOSpeed. |
| ISOSpeedLatitudeyyy | `34868` | Indicates the ISOSpeedLatitudeyyy. |
| ISOSpeedLatitudezzz | `34869` | Indicates the ISOSpeedLatitudezzz. |
| ExifVersion | `36864` | Indicates the ExifVersion. |
| DateTimeOriginal | `36867` | Indicates the DateTimeOriginal. |
| DateTimeDigitized | `36868` | Indicates the DateTimeDigitized. |
| OffsetTime | `36880` | Indicates the OffsetTime. |
| OffsetTimeOriginal | `36881` | Indicates the OffsetTimeOriginal. |
| OffsetTimeDigitized | `36882` | Indicates the OffsetTimeDigitized. |
| ComponentsConfiguration | `37121` | Indicates the ComponentsConfiguration. |
| ShutterSpeedValue | `37377` | Indicates the ShutterSpeedValue. |
| ApertureValue | `37378` | Indicates the ApertureValue. |
| BrightnessValue | `37379` | Indicates the BrightnessValue. |
| ExposureBiasValue | `37380` | Indicates the ExposureBiasValue. |
| MaxApertureValue | `37381` | Indicates the MaxApertureValue. |
| SubjectDistance | `37382` | Indicates the SubjectDistance. |
| MeteringMode | `37383` | Indicates the MeteringMode. |
| LightSource | `37384` | Indicates the LightSource. |
| Flash | `37385` | Indicates the Flash. |
| FocalLength | `37386` | Indicates the FocalLength. |
| SubjectArea | `37396` | Indicates the SubjectArea. |
| MakerNote | `37500` | Indicates the MakerNote. |
| UserComment | `37510` | Indicates the UserComment. |
| SubSecTime | `37520` | Indicates the SubSecTime. |
| SubSecTimeOriginal | `37521` | Indicates the SubSecTimeOriginal. |
| SubSecTimeDigitized | `37522` | Indicates the SubSecTimeDigitized. |
| Temperature | `37888` | Indicates the Temperature. |
| Humidity | `37889` | Indicates the Humidity. |
| Pressure | `37890` | Indicates the Pressure. |
| WaterDepth | `37891` | Indicates the WaterDepth. |
| Acceleration | `37892` | Indicates the Acceleration. |
| CameraElevationAngle | `37893` | Indicates the CameraElevationAngle. |
| FlashpixVersion | `40960` | Indicates the FlashpixVersion. |
| ColorSpace | `40961` | Indicates the ColorSpace. |
| PixelXDimension | `40962` | Indicates the PixelXDimension. |
| PixelYDimension | `40963` | Indicates the PixelYDimension. |
| RelatedSoundFile | `40964` | Indicates the RelatedSoundFile. |
| InteroperabilityIFDPointer | `40965` | Indicates the InteroperabilityIFDPointer. |
| FlashEnergy | `41483` | Indicates the FlashEnergy. |
| SpatialFrequencyResponse | `41484` | Indicates the SpatialFrequencyResponse. |
| FocalPlaneXResolution | `41486` | Indicates the FocalPlaneXResolution. |
| FocalPlaneYResolution | `41487` | Indicates the FocalPlaneYResolution. |
| FocalPlaneResolutionUnit | `41488` | Indicates the FocalPlaneResolutionUnit. |
| SubjectLocation | `41492` | Indicates the SubjectLocation. |
| ExposureIndex | `41493` | Indicates the ExposureIndex. |
| SensingMethod | `41495` | Indicates the SensingMethod. |
| FileSource | `41728` | Indicates the FileSource. |
| SceneType | `41729` | Indicates the SceneType. |
| CFAPattern | `41730` | Indicates the CFAPattern. |
| CustomRendered | `41985` | Indicates the CustomRendered. |
| ExposureMode | `41986` | Indicates the ExposureMode. |
| WhiteBalance | `41987` | Indicates the WhiteBalance. |
| DigitalZoomRatio | `41988` | Indicates the DigitalZoomRatio. |
| FocalLengthIn35mmFilm | `41989` | Indicates the FocalLengthIn35mmFilm. |
| SceneCaptureType | `41990` | Indicates the SceneCaptureType. |
| GainControl | `41991` | Indicates the GainControl. |
| Contrast | `41992` | Indicates the Contrast. |
| Saturation | `41993` | Indicates the Saturation. |
| Sharpness | `41994` | Indicates the Sharpness. |
| DeviceSettingDescription | `41995` | Indicates the DeviceSettingDescription. |
| SubjectDistanceRange | `41996` | Indicates the SubjectDistanceRange. |
| ImageUniqueID | `42016` | Indicates the ImageUniqueID. |
| CameraOwnerName | `42032` | Indicates the CameraOwnerName. |
| BodySerialNumber | `42033` | Indicates the BodySerialNumber. |
| LensSpecification | `42034` | Indicates the LensSpecification. |
| LensMake | `42035` | Indicates the LensMake. |
| LensModel | `42036` | Indicates the LensModel. |
| LensSerialNumber | `42037` | Indicates the LensSerialNumber. |
| CompositeImage | `42080` | Indicates the CompositeImage. |
| SourceImageNumberOfCompositeImage | `42081` | Indicates the SourceImageNumberOfCompositeImage. |
| SourceExposureTimesOfCompositeImage | `42082` | Indicates the SourceExposureTimesOfCompositeImage. |
| Gamma | `42240` | Indicates the Gamma. |

### RawExifTagPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage.md

#### RawExifTagPackage class

Represents Exif tags.

```csharp
public abstract class RawExifTagPackage : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Acceleration { get; } | Gets the Acceleration. |
| ApertureValue { get; } | Gets the Aperture. |
| BodySerialNumber { get; } | Gets the Body Serial Number. |
| BrightnessValue { get; } | Gets the Brightness. |
| CameraElevationAngle { get; } | Gets the Camera elevation angle. |
| CameraOwnerName { get; } | Gets the Camera Owner Name. |
| CFAPattern { get; } | Gets the CFA pattern. |
| ColorSpace { get; } | Gets the Color space information . |
| ComponentsConfiguration { get; } | Gets the Meaning of each component. |
| CompositeImage { get; } | Gets the Composite image. |
| Contrast { get; } | Gets the Contrast. |
| Count { get; } | Gets the number of metadata properties. |
| CustomRendered { get; } | Gets the Custom image processing. |
| DateTimeDigitized { get; } | Gets the Date and time of digital data generation. |
| DateTimeOriginal { get; } | Gets the Date and time of original data generation. |
| DeviceSettingDescription { get; } | Gets the Device settings description. |
| DigitalZoomRatio { get; } | Gets the Digital zoom ratio. |
| ExifVersion { get; } | Gets the ExifVersion. |
| ExposureBiasValue { get; } | Gets the Exposure bias. |
| ExposureIndex { get; } | Gets the Exposure index. |
| ExposureMode { get; } | Gets the Exposure mode. |
| ExposureProgram { get; } | Gets the Exposure program. |
| ExposureTime { get; } | Gets the Exposure time. |
| FileSource { get; } | Gets the File source. |
| Flash { get; } | Gets the Flash. |
| FlashEnergy { get; } | Gets the Flash energy. |
| FlashpixVersion { get; } | Gets the Temperature. |
| FNumber { get; } | Gets the F number. |
| FocalLength { get; } | Gets the Lens focal length. |
| FocalLengthIn35mmFilm { get; } | Gets the Focal length in 35 mm film. |
| FocalPlaneResolutionUnit { get; } | Gets the Focal plane resolution unit. |
| FocalPlaneXResolution { get; } | Gets Focal plane X resolution. |
| FocalPlaneYResolution { get; } | Gets the Focal plane Y resolution. |
| GainControl { get; } | Gets the Gain control. |
| Gamma { get; } | Gets the Gamma. |
| Humidity { get; } | Gets the Humidity. |
| ImageUniqueID { get; } | Gets the Unique image ID. |
| InteroperabilityIFDPointer { get; } | Gets the Interoperability tag (Interoperability IFD Pointer). |
| InteroperabilityIFDPointerPackage { get; } | Gets the Interoperability tag (Interoperability IFD Pointer). |
| ISOSpeed { get; } | Gets the ISO Speed. |
| ISOSpeedLatitudeyyy { get; } | Gets the ISO Speed Latitude yyy. |
| ISOSpeedLatitudezzz { get; } | Gets the ISO Speed Latitude zzz. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensMake { get; } | Gets the Lens Make. |
| LensModel { get; } | Gets the Lens Model. |
| LensSerialNumber { get; } | Gets the Lens Serial Number. |
| LensSpecification { get; } | Gets the Lens Specification. |
| LightSource { get; } | Gets the Light source. |
| MakerNote { get; } | Gets the Standard Output Sensitivity. |
| MaxApertureValue { get; } | Gets the Maximum lens aperture. |
| MetadataType { get; } | Gets the metadata type. |
| MeteringMode { get; } | Gets the Metering mode. |
| OECF { get; } | Gets the Optoelectric conversion factor. |
| OffsetTime { get; } | Gets the Offset data of DateTime. |
| OffsetTimeDigitized { get; } | Gets the Offset data of DateTimeDigitized. |
| OffsetTimeOriginal { get; } | Gets the Offset data of DateTimeOriginal. |
| PhotographicSensitivity { get; } | Gets the Photographic Sensitivity. |
| PixelXDimension { get; } | Gets the Valid image width. |
| PixelYDimension { get; } | Gets the Valid image height. |
| Pressure { get; } | Gets the Pressure. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| virtual RawMakerNotePackage { get; } | Gets the Manufacturer notes (MakerNote). |
| RecommendedExposureIndex { get; } | Gets the Recommended ExposureIndexs. |
| RelatedSoundFile { get; } | Gets the Related audio file. |
| Saturation { get; } | Gets the Saturation. |
| SceneCaptureType { get; } | Gets the Scene capture type. |
| SceneType { get; } | Gets the Scene Type. |
| SensingMethod { get; } | Gets the Sensing method. |
| SensitivityType { get; } | Gets the Sensitivity Type. |
| Sharpness { get; } | Gets the Sharpness. |
| ShutterSpeedValue { get; } | Gets the Shutter speed. |
| SourceExposureTimesOfCompositeImage { get; } | Gets the Source exposure times of composite image. |
| SourceImageNumberOfCompositeImage { get; } | Gets the Source image number of composite image. |
| SpatialFrequencyResponse { get; } | Gets the Spatial frequency response. |
| SpectralSensitivity { get; } | Gets the Spectral sensitivity. |
| StandardOutputSensitivity { get; } | Gets the Standard Output Sensitivity. |
| SubjectArea { get; } | Gets the Subject area. |
| SubjectDistance { get; } | Gets the Subject distance. |
| SubjectDistanceRange { get; } | Gets the Subject distance range. |
| SubjectLocation { get; } | Gets the Subject location. |
| SubSecTime { get; } | Gets the DateTime subseconds. |
| SubSecTimeDigitized { get; } | Gets the DateTimeDigitized subseconds. |
| SubSecTimeOriginal { get; } | Gets the DateTimeOriginal subseconds. |
| Temperature { get; } | Gets the Temperature. |
| UserComment { get; } | Gets the User comments. |
| WaterDepth { get; } | Gets the WaterDepth. |
| WhiteBalance { get; } | Gets the White balance. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Acceleration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/acceleration.md

#### RawExifTagPackage.Acceleration property

Gets the Acceleration.

```csharp
public float Acceleration { get; }
```

##### Property Value

The Acceleration.

### ApertureValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/aperturevalue.md

#### RawExifTagPackage.ApertureValue property

Gets the Aperture.

```csharp
public float ApertureValue { get; }
```

##### Property Value

The Aperture.

### BodySerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/bodyserialnumber.md

#### RawExifTagPackage.BodySerialNumber property

Gets the Body Serial Number.

```csharp
public string BodySerialNumber { get; }
```

##### Property Value

The Body Serial Number.

### BrightnessValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/brightnessvalue.md

#### RawExifTagPackage.BrightnessValue property

Gets the Brightness.

```csharp
public float BrightnessValue { get; }
```

##### Property Value

The Brightness.

### CameraElevationAngle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/cameraelevationangle.md

#### RawExifTagPackage.CameraElevationAngle property

Gets the Camera elevation angle.

```csharp
public float CameraElevationAngle { get; }
```

##### Property Value

The Camera elevation angle.

### CameraOwnerName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/cameraownername.md

#### RawExifTagPackage.CameraOwnerName property

Gets the Camera Owner Name.

```csharp
public string CameraOwnerName { get; }
```

##### Property Value

The Camera Owner Name.

### CFAPattern
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/cfapattern.md

#### RawExifTagPackage.CFAPattern property

Gets the CFA pattern.

```csharp
public byte[] CFAPattern { get; }
```

##### Property Value

The CFA pattern.

### ColorSpace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/colorspace.md

#### RawExifTagPackage.ColorSpace property

Gets the Color space information .

```csharp
public ushort ColorSpace { get; }
```

##### Property Value

The Color space information .

### ComponentsConfiguration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/componentsconfiguration.md

#### RawExifTagPackage.ComponentsConfiguration property

Gets the Meaning of each component.

```csharp
public byte[] ComponentsConfiguration { get; }
```

##### Property Value

The Meaning of each component.

### CompositeImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/compositeimage.md

#### RawExifTagPackage.CompositeImage property

Gets the Composite image.

```csharp
public ushort CompositeImage { get; }
```

##### Property Value

The Composite image.

### Contrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/contrast.md

#### RawExifTagPackage.Contrast property

Gets the Contrast.

```csharp
public ushort Contrast { get; }
```

##### Property Value

The Contrast.

### CustomRendered
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/customrendered.md

#### RawExifTagPackage.CustomRendered property

Gets the Custom image processing.

```csharp
public ushort CustomRendered { get; }
```

##### Property Value

The Custom image processing.

### DateTimeDigitized
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/datetimedigitized.md

#### RawExifTagPackage.DateTimeDigitized property

Gets the Date and time of digital data generation.

```csharp
public string DateTimeDigitized { get; }
```

##### Property Value

The Date and time of digital data generation.

### DateTimeOriginal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/datetimeoriginal.md

#### RawExifTagPackage.DateTimeOriginal property

Gets the Date and time of original data generation.

```csharp
public string DateTimeOriginal { get; }
```

##### Property Value

The Date and time of original data generation.

### DeviceSettingDescription
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/devicesettingdescription.md

#### RawExifTagPackage.DeviceSettingDescription property

Gets the Device settings description.

```csharp
public byte[] DeviceSettingDescription { get; }
```

##### Property Value

The Device settings description.

### DigitalZoomRatio
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/digitalzoomratio.md

#### RawExifTagPackage.DigitalZoomRatio property

Gets the Digital zoom ratio.

```csharp
public float DigitalZoomRatio { get; }
```

##### Property Value

The Digital zoom ratio.

### ExifVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exifversion.md

#### RawExifTagPackage.ExifVersion property

Gets the ExifVersion.

```csharp
public byte[] ExifVersion { get; }
```

##### Property Value

The ExifVersion.

### ExposureBiasValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposurebiasvalue.md

#### RawExifTagPackage.ExposureBiasValue property

Gets the Exposure bias.

```csharp
public float ExposureBiasValue { get; }
```

##### Property Value

The Exposure bias.

### ExposureIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposureindex.md

#### RawExifTagPackage.ExposureIndex property

Gets the Exposure index.

```csharp
public float ExposureIndex { get; }
```

##### Property Value

The Exposure index.

### ExposureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposuremode.md

#### RawExifTagPackage.ExposureMode property

Gets the Exposure mode.

```csharp
public ushort ExposureMode { get; }
```

##### Property Value

The Exposure mode.

### ExposureProgram
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposureprogram.md

#### RawExifTagPackage.ExposureProgram property

Gets the Exposure program.

```csharp
public ushort ExposureProgram { get; }
```

##### Property Value

The Exposure program.

### ExposureTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposuretime.md

#### RawExifTagPackage.ExposureTime property

Gets the Exposure time.

```csharp
public float ExposureTime { get; }
```

##### Property Value

The Exposure time.

### FileSource
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/filesource.md

#### RawExifTagPackage.FileSource property

Gets the File source.

```csharp
public byte[] FileSource { get; }
```

##### Property Value

The File source.

### Flash
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/flash.md

#### RawExifTagPackage.Flash property

Gets the Flash.

```csharp
public ushort Flash { get; }
```

##### Property Value

The Flash.

### FlashEnergy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/flashenergy.md

#### RawExifTagPackage.FlashEnergy property

Gets the Flash energy.

```csharp
public float FlashEnergy { get; }
```

##### Property Value

The Flash energy.

### FlashpixVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/flashpixversion.md

#### RawExifTagPackage.FlashpixVersion property

Gets the Temperature.

```csharp
public byte[] FlashpixVersion { get; }
```

##### Property Value

The Temperature.

### FNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/fnumber.md

#### RawExifTagPackage.FNumber property

Gets the F number.

```csharp
public float FNumber { get; }
```

##### Property Value

The F number.

### FocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/focallength.md

#### RawExifTagPackage.FocalLength property

Gets the Lens focal length.

```csharp
public float FocalLength { get; }
```

##### Property Value

The Lens focal length.

### FocalLengthIn35mmFilm
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/focallengthin35mmfilm.md

#### RawExifTagPackage.FocalLengthIn35mmFilm property

Gets the Focal length in 35 mm film.

```csharp
public ushort FocalLengthIn35mmFilm { get; }
```

##### Property Value

The Focal length in 35 mm film.

### FocalPlaneResolutionUnit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/focalplaneresolutionunit.md

#### RawExifTagPackage.FocalPlaneResolutionUnit property

Gets the Focal plane resolution unit.

```csharp
public ushort FocalPlaneResolutionUnit { get; }
```

##### Property Value

The Focal plane resolution unit.

### FocalPlaneXResolution
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/focalplanexresolution.md

#### RawExifTagPackage.FocalPlaneXResolution property

Gets Focal plane X resolution.

```csharp
public float FocalPlaneXResolution { get; }
```

##### Property Value

The Focal plane X resolution.

### FocalPlaneYResolution
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/focalplaneyresolution.md

#### RawExifTagPackage.FocalPlaneYResolution property

Gets the Focal plane Y resolution.

```csharp
public float FocalPlaneYResolution { get; }
```

##### Property Value

The Focal plane Y resolution.

### GainControl
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/gaincontrol.md

#### RawExifTagPackage.GainControl property

Gets the Gain control.

```csharp
public float GainControl { get; }
```

##### Property Value

The Gain control.

### Gamma
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/gamma.md

#### RawExifTagPackage.Gamma property

Gets the Gamma.

```csharp
public float Gamma { get; }
```

##### Property Value

The Gamma.

### Humidity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/humidity.md

#### RawExifTagPackage.Humidity property

Gets the Humidity.

```csharp
public float Humidity { get; }
```

##### Property Value

The Humidity.

### ImageUniqueID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/imageuniqueid.md

#### RawExifTagPackage.ImageUniqueID property

Gets the Unique image ID.

```csharp
public string ImageUniqueID { get; }
```

##### Property Value

The Unique image ID.

### InteroperabilityIFDPointer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/interoperabilityifdpointer.md

#### RawExifTagPackage.InteroperabilityIFDPointer property

Gets the Interoperability tag (Interoperability IFD Pointer).

```csharp
public long InteroperabilityIFDPointer { get; }
```

##### Property Value

The Interoperability tag (Interoperability IFD Pointer).

### InteroperabilityIFDPointerPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/interoperabilityifdpointerpackage.md

#### RawExifTagPackage.InteroperabilityIFDPointerPackage property

Gets the Interoperability tag (Interoperability IFD Pointer).

```csharp
public InteroperabilityIFDPointerPackage InteroperabilityIFDPointerPackage { get; }
```

##### Property Value

The Interoperability tag (Interoperability IFD Pointer).

### ISOSpeed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/isospeed.md

#### RawExifTagPackage.ISOSpeed property

Gets the ISO Speed.

```csharp
public long ISOSpeed { get; }
```

##### Property Value

The ISO Speed.

### ISOSpeedLatitudeyyy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/isospeedlatitudeyyy.md

#### RawExifTagPackage.ISOSpeedLatitudeyyy property

Gets the ISO Speed Latitude yyy.

```csharp
public long ISOSpeedLatitudeyyy { get; }
```

##### Property Value

The ISO Speed Latitude yyy.

### ISOSpeedLatitudezzz
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/isospeedlatitudezzz.md

#### RawExifTagPackage.ISOSpeedLatitudezzz property

Gets the ISO Speed Latitude zzz.

```csharp
public long ISOSpeedLatitudezzz { get; }
```

##### Property Value

The ISO Speed Latitude zzz.

### LensMake
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/lensmake.md

#### RawExifTagPackage.LensMake property

Gets the Lens Make.

```csharp
public string LensMake { get; }
```

##### Property Value

The Lens Make.

### LensModel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/lensmodel.md

#### RawExifTagPackage.LensModel property

Gets the Lens Model.

```csharp
public string LensModel { get; }
```

##### Property Value

The Lens Model.

### LensSerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/lensserialnumber.md

#### RawExifTagPackage.LensSerialNumber property

Gets the Lens Serial Number.

```csharp
public string LensSerialNumber { get; }
```

##### Property Value

The Lens Serial Number.

### LensSpecification
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/lensspecification.md

#### RawExifTagPackage.LensSpecification property

Gets the Lens Specification.

```csharp
public double[] LensSpecification { get; }
```

##### Property Value

The Lens Specification.

### LightSource
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/lightsource.md

#### RawExifTagPackage.LightSource property

Gets the Light source.

```csharp
public ushort LightSource { get; }
```

##### Property Value

The Light source.

### MakerNote
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/makernote.md

#### RawExifTagPackage.MakerNote property

Gets the Standard Output Sensitivity.

```csharp
public long MakerNote { get; }
```

##### Property Value

The Standard Output Sensitivity.

### MaxApertureValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/maxaperturevalue.md

#### RawExifTagPackage.MaxApertureValue property

Gets the Maximum lens aperture.

```csharp
public float MaxApertureValue { get; }
```

##### Property Value

The Maximum lens aperture.

### MeteringMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/meteringmode.md

#### RawExifTagPackage.MeteringMode property

Gets the Metering mode.

```csharp
public ushort MeteringMode { get; }
```

##### Property Value

The Metering mode.

### OECF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/oecf.md

#### RawExifTagPackage.OECF property

Gets the Optoelectric conversion factor.

```csharp
public byte[] OECF { get; }
```

##### Property Value

The Optoelectric conversion factor.

### OffsetTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/offsettime.md

#### RawExifTagPackage.OffsetTime property

Gets the Offset data of DateTime.

```csharp
public string OffsetTime { get; }
```

##### Property Value

The Offset data of DateTime.

### OffsetTimeDigitized
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/offsettimedigitized.md

#### RawExifTagPackage.OffsetTimeDigitized property

Gets the Offset data of DateTimeDigitized.

```csharp
public string OffsetTimeDigitized { get; }
```

##### Property Value

The Offset data of DateTimeDigitized.

### OffsetTimeOriginal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/offsettimeoriginal.md

#### RawExifTagPackage.OffsetTimeOriginal property

Gets the Offset data of DateTimeOriginal.

```csharp
public string OffsetTimeOriginal { get; }
```

##### Property Value

The Offset data of DateTimeOriginal.

### PhotographicSensitivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/photographicsensitivity.md

#### RawExifTagPackage.PhotographicSensitivity property

Gets the Photographic Sensitivity.

```csharp
public ushort PhotographicSensitivity { get; }
```

##### Property Value

The Photographic Sensitivity.

### PixelXDimension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/pixelxdimension.md

#### RawExifTagPackage.PixelXDimension property

Gets the Valid image width.

```csharp
public long PixelXDimension { get; }
```

##### Property Value

The Valid image width.

### PixelYDimension
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/pixelydimension.md

#### RawExifTagPackage.PixelYDimension property

Gets the Valid image height.

```csharp
public long PixelYDimension { get; }
```

##### Property Value

The Valid image height.

### Pressure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/pressure.md

#### RawExifTagPackage.Pressure property

Gets the Pressure.

```csharp
public float Pressure { get; }
```

##### Property Value

The Pressure.

### RawMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/rawmakernotepackage.md

#### RawExifTagPackage.RawMakerNotePackage property

Gets the Manufacturer notes (MakerNote).

```csharp
public virtual RawMakerNotePackage RawMakerNotePackage { get; }
```

##### Property Value

The Manufacturer notes (MakerNote).

### RecommendedExposureIndex
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/recommendedexposureindex.md

#### RawExifTagPackage.RecommendedExposureIndex property

Gets the Recommended ExposureIndexs.

```csharp
public long RecommendedExposureIndex { get; }
```

##### Property Value

The Recommended ExposureIndex.

### RelatedSoundFile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/relatedsoundfile.md

#### RawExifTagPackage.RelatedSoundFile property

Gets the Related audio file.

```csharp
public string RelatedSoundFile { get; }
```

##### Property Value

The Related audio file.

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/saturation.md

#### RawExifTagPackage.Saturation property

Gets the Saturation.

```csharp
public ushort Saturation { get; }
```

##### Property Value

The Saturation.

### SceneCaptureType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/scenecapturetype.md

#### RawExifTagPackage.SceneCaptureType property

Gets the Scene capture type.

```csharp
public ushort SceneCaptureType { get; }
```

##### Property Value

The Scene capture type.

### SceneType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/scenetype.md

#### RawExifTagPackage.SceneType property

Gets the Scene Type.

```csharp
public byte[] SceneType { get; }
```

##### Property Value

The Scene Type.

### SensingMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/sensingmethod.md

#### RawExifTagPackage.SensingMethod property

Gets the Sensing method.

```csharp
public ushort SensingMethod { get; }
```

##### Property Value

The Sensing method.

### SensitivityType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/sensitivitytype.md

#### RawExifTagPackage.SensitivityType property

Gets the Sensitivity Type.

```csharp
public ushort SensitivityType { get; }
```

##### Property Value

The Sensitivity Type.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/sharpness.md

#### RawExifTagPackage.Sharpness property

Gets the Sharpness.

```csharp
public ushort Sharpness { get; }
```

##### Property Value

The Sharpness.

### ShutterSpeedValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/shutterspeedvalue.md

#### RawExifTagPackage.ShutterSpeedValue property

Gets the Shutter speed.

```csharp
public float ShutterSpeedValue { get; }
```

##### Property Value

The Shutter speed.

### SourceExposureTimesOfCompositeImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/sourceexposuretimesofcompositeimage.md

#### RawExifTagPackage.SourceExposureTimesOfCompositeImage property

Gets the Source exposure times of composite image.

```csharp
public byte[] SourceExposureTimesOfCompositeImage { get; }
```

##### Property Value

The Source exposure times of composite image.

### SourceImageNumberOfCompositeImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/sourceimagenumberofcompositeimage.md

#### RawExifTagPackage.SourceImageNumberOfCompositeImage property

Gets the Source image number of composite image.

```csharp
public ushort SourceImageNumberOfCompositeImage { get; }
```

##### Property Value

The Source image number of composite image.

### SpatialFrequencyResponse
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/spatialfrequencyresponse.md

#### RawExifTagPackage.SpatialFrequencyResponse property

Gets the Spatial frequency response.

```csharp
public byte[] SpatialFrequencyResponse { get; }
```

##### Property Value

The Spatial frequency response.

### SpectralSensitivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/spectralsensitivity.md

#### RawExifTagPackage.SpectralSensitivity property

Gets the Spectral sensitivity.

```csharp
public string SpectralSensitivity { get; }
```

##### Property Value

The Spectral sensitivity.

### StandardOutputSensitivity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/standardoutputsensitivity.md

#### RawExifTagPackage.StandardOutputSensitivity property

Gets the Standard Output Sensitivity.

```csharp
public long StandardOutputSensitivity { get; }
```

##### Property Value

The Standard Output Sensitivity.

### SubjectArea
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subjectarea.md

#### RawExifTagPackage.SubjectArea property

Gets the Subject area.

```csharp
public ushort SubjectArea { get; }
```

##### Property Value

The Subject area.

### SubjectDistance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subjectdistance.md

#### RawExifTagPackage.SubjectDistance property

Gets the Subject distance.

```csharp
public float SubjectDistance { get; }
```

##### Property Value

The Subject distance.

### SubjectDistanceRange
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subjectdistancerange.md

#### RawExifTagPackage.SubjectDistanceRange property

Gets the Subject distance range.

```csharp
public ushort SubjectDistanceRange { get; }
```

##### Property Value

The Subject distance range.

### SubjectLocation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subjectlocation.md

#### RawExifTagPackage.SubjectLocation property

Gets the Subject location.

```csharp
public ushort SubjectLocation { get; }
```

##### Property Value

The Subject location.

### SubSecTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subsectime.md

#### RawExifTagPackage.SubSecTime property

Gets the DateTime subseconds.

```csharp
public string SubSecTime { get; }
```

##### Property Value

The DateTime subseconds.

### SubSecTimeDigitized
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subsectimedigitized.md

#### RawExifTagPackage.SubSecTimeDigitized property

Gets the DateTimeDigitized subseconds.

```csharp
public string SubSecTimeDigitized { get; }
```

##### Property Value

The DateTimeDigitized subseconds.

### SubSecTimeOriginal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/subsectimeoriginal.md

#### RawExifTagPackage.SubSecTimeOriginal property

Gets the DateTimeOriginal subseconds.

```csharp
public string SubSecTimeOriginal { get; }
```

##### Property Value

The DateTimeOriginal subseconds.

### Temperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/temperature.md

#### RawExifTagPackage.Temperature property

Gets the Temperature.

```csharp
public float Temperature { get; }
```

##### Property Value

The Temperature.

### UserComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/usercomment.md

#### RawExifTagPackage.UserComment property

Gets the User comments.

```csharp
public byte[] UserComment { get; }
```

##### Property Value

The User comments.

### WaterDepth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/waterdepth.md

#### RawExifTagPackage.WaterDepth property

Gets the WaterDepth.

```csharp
public float WaterDepth { get; }
```

##### Property Value

The WaterDepth.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawexiftagpackage/whitebalance.md

#### RawExifTagPackage.WhiteBalance property

Gets the White balance.

```csharp
public ushort WhiteBalance { get; }
```

##### Property Value

The White balance.

### RawIFD1Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd1package.md

#### RawIFD1Package class

Represents IFD1 tags.

```csharp
public sealed class RawIFD1Package : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ThumbnailLenght { get; } | Gets the ThumbnailLenght. |
| ThumbnailOffset { get; } | Gets the ThumbnailOffset. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ThumbnailLenght
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd1package/thumbnaillenght.md

#### RawIFD1Package.ThumbnailLenght property

Gets the ThumbnailLenght.

```csharp
public long ThumbnailLenght { get; }
```

##### Property Value

The ThumbnailLenght.

### ThumbnailOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd1package/thumbnailoffset.md

#### RawIFD1Package.ThumbnailOffset property

Gets the ThumbnailOffset.

```csharp
public long ThumbnailOffset { get; }
```

##### Property Value

The ThumbnailOffset.

### RawIFD2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package.md

#### RawIFD2Package class

Represents IFD1 tags.

```csharp
public sealed class RawIFD2Package : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| BitsPerSample { get; } | Gets the image BitsPerSample. |
| Compression { get; } | Gets the image Compression. |
| Count { get; } | Gets the number of metadata properties. |
| ImageHeight { get; } | Gets the image height. |
| ImageWidth { get; } | Gets the image width. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PhotometricInterpretation { get; } | Gets the image PhotometricInterpretation. |
| PlanarConfiguration { get; } | Gets the PlanarConfiguration. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RowPerStrip { get; } | Gets the RowPerStrip. |
| SamplesPerPixel { get; } | Gets the SamplesPerPixel. |
| StripByteCounts { get; } | Gets the StripByteCounts. |
| StripOffset { get; } | Gets the image StripOffset. |
| Unknown1 { get; } | Gets the Unknown1. |
| Unknown2 { get; } | Gets the Unknown2. |
| Unknown3 { get; } | Gets the Unknown3. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsPerSample
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/bitspersample.md

#### RawIFD2Package.BitsPerSample property

Gets the image BitsPerSample.

```csharp
public ushort[] BitsPerSample { get; }
```

##### Property Value

The image BitsPerSample.

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/compression.md

#### RawIFD2Package.Compression property

Gets the image Compression.

```csharp
public ushort Compression { get; }
```

##### Property Value

The image Compression.

### ImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/imageheight.md

#### RawIFD2Package.ImageHeight property

Gets the image height.

```csharp
public ushort ImageHeight { get; }
```

##### Property Value

The image height.

### ImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/imagewidth.md

#### RawIFD2Package.ImageWidth property

Gets the image width.

```csharp
public ushort ImageWidth { get; }
```

##### Property Value

The image width.

### PhotometricInterpretation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/photometricinterpretation.md

#### RawIFD2Package.PhotometricInterpretation property

Gets the image PhotometricInterpretation.

```csharp
public ushort PhotometricInterpretation { get; }
```

##### Property Value

The image PhotometricInterpretation.

### PlanarConfiguration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/planarconfiguration.md

#### RawIFD2Package.PlanarConfiguration property

Gets the PlanarConfiguration.

```csharp
public ushort PlanarConfiguration { get; }
```

##### Property Value

The PlanarConfiguration.

### RowPerStrip
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/rowperstrip.md

#### RawIFD2Package.RowPerStrip property

Gets the RowPerStrip.

```csharp
public ushort RowPerStrip { get; }
```

##### Property Value

The RowPerStrip.

### SamplesPerPixel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/samplesperpixel.md

#### RawIFD2Package.SamplesPerPixel property

Gets the SamplesPerPixel.

```csharp
public ushort SamplesPerPixel { get; }
```

##### Property Value

The SamplesPerPixel.

### StripByteCounts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/stripbytecounts.md

#### RawIFD2Package.StripByteCounts property

Gets the StripByteCounts.

```csharp
public long StripByteCounts { get; }
```

##### Property Value

The StripByteCounts.

### StripOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/stripoffset.md

#### RawIFD2Package.StripOffset property

Gets the image StripOffset.

```csharp
public long StripOffset { get; }
```

##### Property Value

The image StripOffset.

### Unknown1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/unknown1.md

#### RawIFD2Package.Unknown1 property

Gets the Unknown1.

```csharp
public long Unknown1 { get; }
```

##### Property Value

The Unknown1.

### Unknown2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/unknown2.md

#### RawIFD2Package.Unknown2 property

Gets the Unknown2.

```csharp
public long Unknown2 { get; }
```

##### Property Value

The Unknown2.

### Unknown3
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd2package/unknown3.md

#### RawIFD2Package.Unknown3 property

Gets the Unknown3.

```csharp
public long[] Unknown3 { get; }
```

##### Property Value

The Unknown3.

### RawIFD3Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package.md

#### RawIFD3Package class

Represents IFD1 tags.

```csharp
public sealed class RawIFD3Package : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Compression { get; } | Gets the image Compression. |
| Count { get; } | Gets the number of metadata properties. |
| ImageHeight { get; } | Gets the image height. |
| ImageWidth { get; } | Gets the image width. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StripByteCounts { get; } | Gets the image StripByteCounts. |
| StripOffset { get; } | Gets the image StripOffset. |
| Unknown1 { get; } | Gets the Unknown1. |
| Unknown2 { get; } | Gets the Unknown2. |
| Unknown3 { get; } | Gets the Unknown3. |
| Unknown4 { get; } | Gets the Unknown4. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/compression.md

#### RawIFD3Package.Compression property

Gets the image Compression.

```csharp
public ushort Compression { get; }
```

##### Property Value

The image Compression.

### ImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/imageheight.md

#### RawIFD3Package.ImageHeight property

Gets the image height.

```csharp
public ushort ImageHeight { get; }
```

##### Property Value

The image height.

### ImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/imagewidth.md

#### RawIFD3Package.ImageWidth property

Gets the image width.

```csharp
public ushort ImageWidth { get; }
```

##### Property Value

The image width.

### StripByteCounts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/stripbytecounts.md

#### RawIFD3Package.StripByteCounts property

Gets the image StripByteCounts.

```csharp
public long StripByteCounts { get; }
```

##### Property Value

The image StripByteCounts.

### StripOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/stripoffset.md

#### RawIFD3Package.StripOffset property

Gets the image StripOffset.

```csharp
public long StripOffset { get; }
```

##### Property Value

The image StripOffset.

### Unknown1
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/unknown1.md

#### RawIFD3Package.Unknown1 property

Gets the Unknown1.

```csharp
public long Unknown1 { get; }
```

##### Property Value

The Unknown1.

### Unknown2
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/unknown2.md

#### RawIFD3Package.Unknown2 property

Gets the Unknown2.

```csharp
public long Unknown2 { get; }
```

##### Property Value

The Unknown2.

### Unknown3
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/unknown3.md

#### RawIFD3Package.Unknown3 property

Gets the Unknown3.

```csharp
public ushort[] Unknown3 { get; }
```

##### Property Value

The Unknown3.

### Unknown4
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawifd3package/unknown4.md

#### RawIFD3Package.Unknown4 property

Gets the Unknown4.

```csharp
public long Unknown4 { get; }
```

##### Property Value

The Unknown4.

### RawMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawmakernotepackage.md

#### RawMakerNotePackage class

Represents Raw MakerNotes tags.

```csharp
public abstract class RawMakerNotePackage : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### RawPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawpackage.md

#### RawPackage class

Represents Raw Package.

```csharp
public abstract class RawPackage : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| RawPackage() | Initializes a new instance of the `RawPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### RawPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawpackage/rawpackage.md

#### RawPackage constructor

Initializes a new instance of the `RawPackage` class.

```csharp
public RawPackage()
```

### RawTagType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtagtype.md

#### RawTagType enumeration

Represents the IFD data type.

```csharp
public enum RawTagType : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Byte | `1` | An 8-bit unsigned integer. |
| Ascii | `2` | An 8-bit byte with a 7-bit ASCII character. |
| Short | `3` | A 16-bit unsigned integer. |
| Long | `4` | A 32-bit unsigned integer. |
| Rational | `5` | A pair of LONGs, numerator then denominator. |
| SByte | `6` | An 8-bit signed integer. |
| Undefined | `7` | An undefined 8-bit byte. |
| SShort | `8` | A 16-bit signed integer. |
| SLong | `9` | A 32-bit signed integer. |
| SRational | `10` | A pair of SLONGs, numerator then denominator. |
| Float | `11` | A 4-byte IEEE floating point value. |
| Double | `12` | An 8-byte IEEE floating point value. |
| SubIfd | `13` | A 4-byte long offset value |

### RawTiffTagPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage.md

#### RawTiffTagPackage class

Represents Tiff tags.

```csharp
public sealed class RawTiffTagPackage : RawDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Artist { get; } | Gets the Artist. |
| BitsPerSample { get; } | Gets the bits per sample. |
| Compression { get; } | Gets compression. |
| Copyright { get; } | Gets the Copyright. |
| Count { get; } | Gets the number of metadata properties. |
| DateTime { get; } | Gets the DateTime. |
| EXIF { get; } | Gets the EXIF. |
| GpsIfd { get; } | Gets the EXIF. |
| GpsIfdPackage { get; } | Gets the GPS tag (GPSInfo IFD Pointer). |
| ImageDescription { get; set; } | Gets or sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like. |
| ImageHeight { get; } | Gets the image height. |
| ImageWidth { get; } | Gets the image width. |
| Item { get; } | Gets the Raw tag with the specified id. (2 indexers) |
| JpegInterchangeFormat { get; } | Gets the JpegInterchangeFormat. |
| JpegInterchangeFormatLength { get; } | Gets the JpegInterchangeFormatLength. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Make { get; } | Gets the macro mode. |
| MetadataType { get; } | Gets the metadata type. |
| Model { get; } | Gets the model. |
| Orientation { get; } | Gets the orientation. |
| PhotometricInterpretation { get; } | Gets PhotometricInterpretation. |
| PlanarConfiguration { get; } | Gets the PlanarConfiguration. |
| PrimaryChromaticities { get; } | Gets the PrimaryChromaticities. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawExifTagPackage { get; } | Gets the Exif tag (Exif IFD Pointer). |
| RawIFD1Package { get; } | Gets the IFD1. |
| RawIFD2Package { get; } | Gets the IFD2. |
| RawIFD3Package { get; } | Gets the IFD3. |
| ReferenceBlackWhite { get; } | Gets the ReferenceBlackWhite. |
| ResolutionUnit { get; } | Gets the Resolution Unit. |
| RowsPerStrip { get; } | Gets the RowsPerStrip. |
| SamplesPerPixel { get; } | Gets the SamplesPerPixel. |
| Software { get; } | Gets the Software. |
| StripByteCounts { get; } | Gets the strip byte counts. |
| StripOffset { get; } | Gets the StripOffset. |
| TransferFunction { get; } | Gets the TransferFunction. |
| WhitePoint { get; } | Gets the WhitePoint. |
| XResolution { get; } | Gets the XResolution. |
| YCbCrCoefficients { get; } | Gets the YCbCrCoefficients. |
| YCbCrPositioning { get; } | Gets the YCbCrPositioning. |
| YCbCrSubSampling { get; } | Gets the YCbCrSubSampling. |
| YResolution { get; } | Gets the YResolution. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all Raw tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(uint) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(RawTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/artist.md

#### RawTiffTagPackage.Artist property

Gets the Artist.

```csharp
public string Artist { get; }
```

##### Property Value

The Artist.

### BitsPerSample
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/bitspersample.md

#### RawTiffTagPackage.BitsPerSample property

Gets the bits per sample.

```csharp
public ushort[] BitsPerSample { get; }
```

##### Property Value

The bits per sample.

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/compression.md

#### RawTiffTagPackage.Compression property

Gets compression.

```csharp
public ushort Compression { get; }
```

##### Property Value

The compression.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/copyright.md

#### RawTiffTagPackage.Copyright property

Gets the Copyright.

```csharp
public string Copyright { get; }
```

##### Property Value

The Copyright.

### DateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/datetime.md

#### RawTiffTagPackage.DateTime property

Gets the DateTime.

```csharp
public string DateTime { get; }
```

##### Property Value

The DateTime.

### EXIF
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/exif.md

#### RawTiffTagPackage.EXIF property

Gets the EXIF.

```csharp
public long EXIF { get; }
```

##### Property Value

The EXIF.

### GpsIfd
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/gpsifd.md

#### RawTiffTagPackage.GpsIfd property

Gets the EXIF.

```csharp
public long GpsIfd { get; }
```

##### Property Value

The EXIF.

### GpsIfdPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/gpsifdpackage.md

#### RawTiffTagPackage.GpsIfdPackage property

Gets the GPS tag (GPSInfo IFD Pointer).

```csharp
public GpsIfdPackage GpsIfdPackage { get; }
```

##### Property Value

The GPS tag (GPSInfo IFD Pointer).

### ImageDescription
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/imagedescription.md

#### RawTiffTagPackage.ImageDescription property

Gets or sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

```csharp
public string ImageDescription { get; set; }
```

##### Property Value

The image description.

### ImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/imageheight.md

#### RawTiffTagPackage.ImageHeight property

Gets the image height.

```csharp
public ushort ImageHeight { get; }
```

##### Property Value

The image height.

### ImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/imagewidth.md

#### RawTiffTagPackage.ImageWidth property

Gets the image width.

```csharp
public ushort ImageWidth { get; }
```

##### Property Value

The image width.

### JpegInterchangeFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/jpeginterchangeformat.md

#### RawTiffTagPackage.JpegInterchangeFormat property

Gets the JpegInterchangeFormat.

```csharp
public long JpegInterchangeFormat { get; }
```

##### Property Value

The JpegInterchangeFormat.

### JpegInterchangeFormatLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/jpeginterchangeformatlength.md

#### RawTiffTagPackage.JpegInterchangeFormatLength property

Gets the JpegInterchangeFormatLength.

```csharp
public long JpegInterchangeFormatLength { get; }
```

##### Property Value

The JpegInterchangeFormatLength.

### Make
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/make.md

#### RawTiffTagPackage.Make property

Gets the macro mode.

```csharp
public string Make { get; }
```

##### Property Value

The macro mode.

### Model
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/model.md

#### RawTiffTagPackage.Model property

Gets the model.

```csharp
public string Model { get; }
```

##### Property Value

The model.

### Orientation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/orientation.md

#### RawTiffTagPackage.Orientation property

Gets the orientation.

```csharp
public ushort Orientation { get; }
```

##### Property Value

The orientation.

### PhotometricInterpretation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/photometricinterpretation.md

#### RawTiffTagPackage.PhotometricInterpretation property

Gets PhotometricInterpretation.

```csharp
public ushort PhotometricInterpretation { get; }
```

##### Property Value

The PhotometricInterpretation.

### PlanarConfiguration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/planarconfiguration.md

#### RawTiffTagPackage.PlanarConfiguration property

Gets the PlanarConfiguration.

```csharp
public ushort PlanarConfiguration { get; }
```

##### Property Value

The PlanarConfiguration.

### PrimaryChromaticities
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/primarychromaticities.md

#### RawTiffTagPackage.PrimaryChromaticities property

Gets the PrimaryChromaticities.

```csharp
public double[] PrimaryChromaticities { get; }
```

##### Property Value

The PrimaryChromaticities.

### RawExifTagPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/rawexiftagpackage.md

#### RawTiffTagPackage.RawExifTagPackage property

Gets the Exif tag (Exif IFD Pointer).

```csharp
public RawExifTagPackage RawExifTagPackage { get; }
```

##### Property Value

The Exif tag (Exif IFD Pointer).

### RawIFD1Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/rawifd1package.md

#### RawTiffTagPackage.RawIFD1Package property

Gets the IFD1.

```csharp
public RawIFD1Package RawIFD1Package { get; }
```

##### Property Value

The IFD1.

### RawIFD2Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/rawifd2package.md

#### RawTiffTagPackage.RawIFD2Package property

Gets the IFD2.

```csharp
public RawIFD2Package RawIFD2Package { get; }
```

##### Property Value

The IFD2.

### RawIFD3Package
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/rawifd3package.md

#### RawTiffTagPackage.RawIFD3Package property

Gets the IFD3.

```csharp
public RawIFD3Package RawIFD3Package { get; }
```

##### Property Value

The IFD3.

### ReferenceBlackWhite
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/referenceblackwhite.md

#### RawTiffTagPackage.ReferenceBlackWhite property

Gets the ReferenceBlackWhite.

```csharp
public double[] ReferenceBlackWhite { get; }
```

##### Property Value

The ReferenceBlackWhite.

### ResolutionUnit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/resolutionunit.md

#### RawTiffTagPackage.ResolutionUnit property

Gets the Resolution Unit.

```csharp
public ushort ResolutionUnit { get; }
```

##### Property Value

The Resolution Unit.

### RowsPerStrip
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/rowsperstrip.md

#### RawTiffTagPackage.RowsPerStrip property

Gets the RowsPerStrip.

```csharp
public long RowsPerStrip { get; }
```

##### Property Value

The RowsPerStrip.

### SamplesPerPixel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/samplesperpixel.md

#### RawTiffTagPackage.SamplesPerPixel property

Gets the SamplesPerPixel.

```csharp
public ushort SamplesPerPixel { get; }
```

##### Property Value

The SamplesPerPixel.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/software.md

#### RawTiffTagPackage.Software property

Gets the Software.

```csharp
public string Software { get; }
```

##### Property Value

The Software.

### StripByteCounts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/stripbytecounts.md

#### RawTiffTagPackage.StripByteCounts property

Gets the strip byte counts.

```csharp
public long StripByteCounts { get; }
```

##### Property Value

The strip byte counts.

### StripOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/stripoffset.md

#### RawTiffTagPackage.StripOffset property

Gets the StripOffset.

```csharp
public long StripOffset { get; }
```

##### Property Value

The StripOffset.

### TransferFunction
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/transferfunction.md

#### RawTiffTagPackage.TransferFunction property

Gets the TransferFunction.

```csharp
public ushort[] TransferFunction { get; }
```

##### Property Value

The TransferFunction.

### WhitePoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/whitepoint.md

#### RawTiffTagPackage.WhitePoint property

Gets the WhitePoint.

```csharp
public double[] WhitePoint { get; }
```

##### Property Value

The WhitePoint.

### XResolution
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/xresolution.md

#### RawTiffTagPackage.XResolution property

Gets the XResolution.

```csharp
public float XResolution { get; }
```

##### Property Value

The XResolution.

### YCbCrCoefficients
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/ycbcrcoefficients.md

#### RawTiffTagPackage.YCbCrCoefficients property

Gets the YCbCrCoefficients.

```csharp
public double[] YCbCrCoefficients { get; }
```

##### Property Value

The YCbCrCoefficients.

### YCbCrPositioning
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/ycbcrpositioning.md

#### RawTiffTagPackage.YCbCrPositioning property

Gets the YCbCrPositioning.

```csharp
public ushort YCbCrPositioning { get; }
```

##### Property Value

The YCbCrPositioning.

### YCbCrSubSampling
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/ycbcrsubsampling.md

#### RawTiffTagPackage.YCbCrSubSampling property

Gets the YCbCrSubSampling.

```csharp
public ushort[] YCbCrSubSampling { get; }
```

##### Property Value

The YCbCrSubSampling.

### YResolution
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.raw/rawtifftagpackage/yresolution.md

#### RawTiffTagPackage.YResolution property

Gets the YResolution.

```csharp
public float YResolution { get; }
```

##### Property Value

The YResolution.

### GroupDocs.Metadata.Formats.Riff
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff.md

The namespace provides functionality allowing users to work with metadata of various formats derived from the RIFF container.

#### Classes

| Class | Description |
| --- | --- |
| RiffInfoPackage | Represents the metadata package containing properties extracted from the RIFF INFO chunk. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### RiffInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage.md

#### RiffInfoPackage class

Represents the metadata package containing properties extracted from the RIFF INFO chunk.

```csharp
public sealed class RiffInfoPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Artist { get; } | Gets the artist of the original subject of the file. |
| Comment { get; } | Gets the comment about the file or the subject of the file. |
| Copyright { get; } | Gets the copyright information for the file. |
| Count { get; } | Gets the number of metadata properties. |
| CreationDate { get; } | Gets the date the subject of the file was created. |
| Engineer { get; } | Gets the name of the engineer who worked on the file. |
| Genre { get; } | Gets the genre of the original work. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; } | Gets the keywords that refer to the file or subject of the file. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the title of the subject of the file. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Software { get; } | Gets the name of the software package used to create the file. |
| Source { get; } | Gets the name of the person or organization who supplied the original subject of the file. |
| Subject { get; } | Gets a description of the file contents, such as "Aerial view of Seattle." |
| Technician { get; } | Gets the technician who digitized the subject file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/artist.md

#### RiffInfoPackage.Artist property

Gets the artist of the original subject of the file.

```csharp
public string Artist { get; }
```

##### Property Value

The artist of the original subject of the file.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/comment.md

#### RiffInfoPackage.Comment property

Gets the comment about the file or the subject of the file.

```csharp
public string Comment { get; }
```

##### Property Value

The comment about the file or the subject of the file.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/copyright.md

#### RiffInfoPackage.Copyright property

Gets the copyright information for the file.

```csharp
public string Copyright { get; }
```

##### Property Value

The copyright information for the file.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/creationdate.md

#### RiffInfoPackage.CreationDate property

Gets the date the subject of the file was created.

```csharp
public string CreationDate { get; }
```

##### Property Value

The date the subject of the file was created.

### Engineer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/engineer.md

#### RiffInfoPackage.Engineer property

Gets the name of the engineer who worked on the file.

```csharp
public string Engineer { get; }
```

##### Property Value

The name of the engineer who worked on the file.

### Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/genre.md

#### RiffInfoPackage.Genre property

Gets the genre of the original work.

```csharp
public string Genre { get; }
```

##### Property Value

The genre of the original work.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/keywords.md

#### RiffInfoPackage.Keywords property

Gets the keywords that refer to the file or subject of the file.

```csharp
public string Keywords { get; }
```

##### Property Value

The keywords that refer to the file or subject of the file.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/name.md

#### RiffInfoPackage.Name property

Gets the title of the subject of the file.

```csharp
public string Name { get; }
```

##### Property Value

The title of the subject of the file.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/software.md

#### RiffInfoPackage.Software property

Gets the name of the software package used to create the file.

```csharp
public string Software { get; }
```

##### Property Value

The name of the software package used to create the file.

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/source.md

#### RiffInfoPackage.Source property

Gets the name of the person or organization who supplied the original subject of the file.

```csharp
public string Source { get; }
```

##### Property Value

The name of the person or organization who supplied the original subject of the file.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/subject.md

#### RiffInfoPackage.Subject property

Gets a description of the file contents, such as "Aerial view of Seattle."

```csharp
public string Subject { get; }
```

##### Property Value

A description of the file contents.

### Technician
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.riff/riffinfopackage/technician.md

#### RiffInfoPackage.Technician property

Gets the technician who digitized the subject file.

```csharp
public string Technician { get; }
```

##### Property Value

The technician who digitized the subject file.

### GroupDocs.Metadata.Formats.ThreeD.Dae
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae.md

#### Classes

| Class | Description |
| --- | --- |
| DaeNode | Represents metadata associated with an .dae file. |
| DaePackage | Represents .dae file metadata. |
| DaeRootPackage | Represents .dae file metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DaeNode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daenode.md

#### DaeNode class

Represents metadata associated with an .dae file.

```csharp
public sealed class DaeNode : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daenode/name.md

#### DaeNode.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### DaePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage.md

#### DaePackage class

Represents .dae file metadata.

```csharp
public sealed class DaePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Author { get; set; } | Gets or sets the author of this asset |
| Comment { get; set; } | Gets or sets the comment of this asset. |
| Count { get; } | Gets the number of metadata properties. |
| CreationTime { get; set; } | Gets or Sets the creation time of this asset. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModificationTime { get; set; } | Gets or Sets the modification time of this asset. |
| Name { get; } | Gets the node name. |
| Nodes { get; } | Gets an array of `DaeNode` entries inside the dae file. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Title { get; set; } | Gets or sets the title of this asset |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputDae))
{
    var root = metadata.GetRootPackage<DaePackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.DaePackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/author.md

#### DaePackage.Author property

Gets or sets the author of this asset

```csharp
public string Author { get; set; }
```

##### Property Value

Author of this asset

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/comment.md

#### DaePackage.Comment property

Gets or sets the comment of this asset.

```csharp
public string Comment { get; set; }
```

##### Property Value

Comment of this asset.

### CreationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/creationtime.md

#### DaePackage.CreationTime property

Gets or Sets the creation time of this asset.

```csharp
public DateTime CreationTime { get; set; }
```

##### Property Value

Creation time.

### ModificationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/modificationtime.md

#### DaePackage.ModificationTime property

Gets or Sets the modification time of this asset.

```csharp
public DateTime ModificationTime { get; set; }
```

##### Property Value

Modification time.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/name.md

#### DaePackage.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### Nodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/nodes.md

#### DaePackage.Nodes property

Gets an array of `DaeNode` entries inside the dae file.

```csharp
public DaeNode[] Nodes { get; }
```

##### Property Value

An array of `DaeNode` entries inside the dae file.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daepackage/title.md

#### DaePackage.Title property

Gets or sets the title of this asset

```csharp
public string Title { get; set; }
```

##### Property Value

Title of this asset

### DaeRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daerootpackage.md

#### DaeRootPackage class

Represents .dae file metadata.

```csharp
public class DaeRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DaePackage { get; } | Gets the Dae metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputDae))
{
    var root = metadata.GetRootPackage<DaePackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.DaePackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### DaePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.dae/daerootpackage/daepackage.md

#### DaeRootPackage.DaePackage property

Gets the Dae metadata package.

```csharp
public DaePackage DaePackage { get; }
```

##### Property Value

The Dae metadata package.

### GroupDocs.Metadata.Formats.ThreeD.Fbx
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx.md

#### Classes

| Class | Description |
| --- | --- |
| FbxNode | Represents metadata associated with an .fbx file. |
| FbxPackage | Represents .fbx file metadata. |
| FbxRootPackage | Represents .fbx file metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### FbxNode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxnode.md

#### FbxNode class

Represents metadata associated with an .fbx file.

```csharp
public sealed class FbxNode : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxnode/name.md

#### FbxNode.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### FbxPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage.md

#### FbxPackage class

Represents .fbx file metadata.

```csharp
public sealed class FbxPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| ApplicationName { get; set; } | Gets or sets the application name of this asset |
| ApplicationVendor { get; set; } | Gets or sets the a application vendor of this asset |
| ApplicationVersion { get; set; } | Gets or sets the application version of this asset |
| Author { get; set; } | Gets or sets the author of this asset |
| Comment { get; set; } | Gets or sets the comment of this asset. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| Nodes { get; } | Gets an array of `FbxNode` entries inside the Fbx file. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Url { get; set; } | Gets or sets the url of this asset |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputFbx))
{
    var root = metadata.GetRootPackage<FbxPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.FbxPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### ApplicationName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/applicationname.md

#### FbxPackage.ApplicationName property

Gets or sets the application name of this asset

```csharp
public string ApplicationName { get; set; }
```

##### Property Value

Application name of this asset

### ApplicationVendor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/applicationvendor.md

#### FbxPackage.ApplicationVendor property

Gets or sets the a application vendor of this asset

```csharp
public string ApplicationVendor { get; set; }
```

##### Property Value

Application vendor of this asset

### ApplicationVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/applicationversion.md

#### FbxPackage.ApplicationVersion property

Gets or sets the application version of this asset

```csharp
public string ApplicationVersion { get; set; }
```

##### Property Value

Application version of this asset

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/author.md

#### FbxPackage.Author property

Gets or sets the author of this asset

```csharp
public string Author { get; set; }
```

##### Property Value

Author of this asset

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/comment.md

#### FbxPackage.Comment property

Gets or sets the comment of this asset.

```csharp
public string Comment { get; set; }
```

##### Property Value

Comment of this asset.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/name.md

#### FbxPackage.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### Nodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/nodes.md

#### FbxPackage.Nodes property

Gets an array of `FbxNode` entries inside the Fbx file.

```csharp
public FbxNode[] Nodes { get; }
```

##### Property Value

An array of `FbxNode` entries inside the Fbx file.

### Url
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxpackage/url.md

#### FbxPackage.Url property

Gets or sets the url of this asset

```csharp
public string Url { get; set; }
```

##### Property Value

Url of this asset

### FbxRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage.md

#### FbxRootPackage class

Represents .fbx file metadata.

```csharp
public class FbxRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FbxPackage { get; } | Gets the Fbx metadata package. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputFbx))
{
    var root = metadata.GetRootPackage<FbxPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.FbxPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### FbxPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/fbxpackage.md

#### FbxRootPackage.FbxPackage property

Gets the Fbx metadata package.

```csharp
public FbxPackage FbxPackage { get; }
```

##### Property Value

The Fbx metadata package.

### GroupDocs.Metadata.Formats.ThreeD.Gltf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf.md

#### Classes

| Class | Description |
| --- | --- |
| GltfPackage | Represents .glTF file metadata. |
| GltfPropertyDefinition | Represents metadata associated with an .glTF file. |
| GltfPropertyTable | Represents metadata associated with an .glTF file. |
| GltfRootPackage | Represents .glTF file metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### GltfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpackage.md

#### GltfPackage class

Represents .glTF file metadata.

```csharp
public sealed class GltfPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PropertyTables { get; } |  |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputGltf))
{
    var root = metadata.GetRootPackage<GltfPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.GltfPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### PropertyTables
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpackage/propertytables.md

#### GltfPackage.PropertyTables property

```csharp
public GltfPropertyTable[] PropertyTables { get; }
```

### GltfPropertyDefinition
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition.md

#### GltfPropertyDefinition class

Represents metadata associated with an .glTF file.

```csharp
public sealed class GltfPropertyDefinition : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PropertyName { get; } | Gets the property name. |
| PropertyType { get; } | Gets the property type. |
| PropertyValue { get; } | Gets the property value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### PropertyName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/propertyname.md

#### GltfPropertyDefinition.PropertyName property

Gets the property name.

```csharp
public string PropertyName { get; }
```

##### Property Value

The property name.

### PropertyType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/propertytype.md

#### GltfPropertyDefinition.PropertyType property

Gets the property type.

```csharp
public string PropertyType { get; }
```

##### Property Value

The property type.

### PropertyValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/propertyvalue.md

#### GltfPropertyDefinition.PropertyValue property

Gets the property value.

```csharp
public object PropertyValue { get; }
```

##### Property Value

The property value.

### GltfPropertyTable
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable.md

#### GltfPropertyTable class

Represents metadata associated with an .glTF file.

```csharp
public sealed class GltfPropertyTable : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetaClassName { get; } | Gets the Meta Class name. |
| MetadataType { get; } | Gets the metadata type. |
| Properties { get; } | Gets the Properties. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| PropertyTableName { get; } | Gets the Property Table name. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### MetaClassName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/metaclassname.md

#### GltfPropertyTable.MetaClassName property

Gets the Meta Class name.

```csharp
public string MetaClassName { get; }
```

##### Property Value

The Meta Class name.

### Properties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/properties.md

#### GltfPropertyTable.Properties property

Gets the Properties.

```csharp
public GltfPropertyDefinition[] Properties { get; }
```

##### Property Value

The Properties.

### PropertyTableName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/propertytablename.md

#### GltfPropertyTable.PropertyTableName property

Gets the Property Table name.

```csharp
public string PropertyTableName { get; }
```

##### Property Value

The Property Table name.

### GltfRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage.md

#### GltfRootPackage class

Represents .glTF file metadata.

```csharp
public class GltfRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| GltfPackage { get; } | Gets the Gltf metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputGltf))
{
    var root = metadata.GetRootPackage<GltfPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.GltfPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### GltfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/gltfpackage.md

#### GltfRootPackage.GltfPackage property

Gets the Gltf metadata package.

```csharp
public GltfPackage GltfPackage { get; }
```

##### Property Value

The Gltf metadata package.

### GroupDocs.Metadata.Formats.ThreeD.Stl
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl.md

#### Classes

| Class | Description |
| --- | --- |
| StlNode | Represents metadata associated with an .stl file. |
| StlPackage | Represents .stl file metadata. |
| StlRootPackage | Represents .stl file metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### StlNode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlnode.md

#### StlNode class

Represents metadata associated with an .stl file.

```csharp
public sealed class StlNode : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlnode/name.md

#### StlNode.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### StlPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlpackage.md

#### StlPackage class

Represents .stl file metadata.

```csharp
public sealed class StlPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| Nodes { get; } | Gets an array of `StlNode` entries inside the 3ds file. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputStl))
{
    var root = metadata.GetRootPackage<StlPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.StlPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlpackage/name.md

#### StlPackage.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### Nodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlpackage/nodes.md

#### StlPackage.Nodes property

Gets an array of `StlNode` entries inside the 3ds file.

```csharp
public StlNode[] Nodes { get; }
```

##### Property Value

An array of `StlNode` entries inside the 3ds file.

### StlRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlrootpackage.md

#### StlRootPackage class

Represents .stl file metadata.

```csharp
public class StlRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StlPackage { get; } | Gets the Stl package package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputStl))
{
    var root = metadata.GetRootPackage<StlPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.StlPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### StlPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.stl/stlrootpackage/stlpackage.md

#### StlRootPackage.StlPackage property

Gets the Stl package package.

```csharp
public StlPackage StlPackage { get; }
```

##### Property Value

The Stl metadata package.

### GroupDocs.Metadata.Formats.ThreeD.ThreeDS
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds.md

#### Classes

| Class | Description |
| --- | --- |
| ThreeDSNode | Represents metadata associated with an .3ds file. |
| ThreeDSPackage | Represents .3ds file metadata. |
| ThreeDSRootPackage | Represents .3ds file metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ThreeDSNode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedsnode.md

#### ThreeDSNode class

Represents metadata associated with an .3ds file.

```csharp
public sealed class ThreeDSNode : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Materials { get; } | Gets the array of materials. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Materials
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedsnode/materials.md

#### ThreeDSNode.Materials property

Gets the array of materials.

```csharp
public string[] Materials { get; }
```

##### Property Value

The array of categories.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedsnode/name.md

#### ThreeDSNode.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### ThreeDSPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedspackage.md

#### ThreeDSPackage class

Represents .3ds file metadata.

```csharp
public sealed class ThreeDSPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Materials { get; } | Gets the array of materials. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the node name. |
| Nodes { get; } | Gets an array of `ThreeDSNode` entries inside the 3ds file. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputThreeDS))
{
    var root = metadata.GetRootPackage<ThreeDSPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.ThreeDSPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### Materials
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedspackage/materials.md

#### ThreeDSPackage.Materials property

Gets the array of materials.

```csharp
public string[] Materials { get; }
```

##### Property Value

The array of materials.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedspackage/name.md

#### ThreeDSPackage.Name property

Gets the node name.

```csharp
public string Name { get; }
```

##### Property Value

The node name.

### Nodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedspackage/nodes.md

#### ThreeDSPackage.Nodes property

Gets an array of `ThreeDSNode` entries inside the 3ds file.

```csharp
public ThreeDSNode[] Nodes { get; }
```

##### Property Value

An array of `ThreeDSNode` entries inside the 3ds file.

### ThreeDSRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage.md

#### ThreeDSRootPackage class

Represents .3ds file metadata.

```csharp
public class ThreeDSRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ThreeDSPackage { get; } | Gets the 3ds metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

The following code snippet shows how to get metadata from a 3D file.

```csharp
Encoding encoding = Encoding.GetEncoding(866);

using (Metadata metadata = new Metadata(Constants.InputThreeDS))
{
    var root = metadata.GetRootPackage<ThreeDSPackage>();

    Console.WriteLine(root.Name);

    foreach (var node in root.ThreeDSPackage.Nodes)
    {
        Console.WriteLine(node.Name);
    }
}
```

### ThreeDSPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/threedspackage.md

#### ThreeDSRootPackage.ThreeDSPackage property

Gets the 3ds metadata package.

```csharp
public ThreeDSPackage ThreeDSPackage { get; }
```

##### Property Value

The 3ds metadata package.

### GroupDocs.Metadata.Formats.Video
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video.md

The namespace contains classes for working with the most popular video formats.

#### Classes

| Class | Description |
| --- | --- |
| AsfAudioStreamProperty | Represents Audio stream property metadata in the ASF media container. |
| AsfBaseDescriptor | Represents an ASF base metadata descriptor object. |
| AsfBaseStreamProperty | Represents base stream property metadata in the ASF media container. |
| AsfCodec | Represents ASF codec metadata. |
| AsfContentDescriptor | Represents an ASF content descriptor object. |
| AsfMetadataDescriptor | Represents an ASF metadata descriptor. |
| AsfMetadataDescriptorCollection | Represents a collection of metadata descriptors. |
| AsfPackage | Represents native metadata of the ASF media container. |
| AsfRootPackage | Represents the root package allowing working with metadata in an ASF video. |
| AsfVideoStreamProperty | Represents Video stream property metadata in the ASF media container. |
| AviHeader | Represents the AVIMAINHEADER structure in an AVI video. |
| AviRootPackage | Represents the root package allowing working with metadata in an AVI video. |
| FlvHeader | Represents a FLV video header. |
| FlvRootPackage | Represents the root package allowing working with metadata in an FLV video. |
| MatroskaAudioTrack | Represents audio metadata in a Matroska video. |
| MatroskaBasePackage | Provides a base metadata class for all packages extracted from a Matroska video. |
| MatroskaEbmlHeader | Represents EBML header metadata in a Matroska video. |
| MatroskaPackage | Represents a metadata container in a Matroska video. |
| MatroskaRootPackage | Represents the root package allowing working with metadata in a Matroska video. |
| MatroskaSegment | Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video. |
| MatroskaSimpleTag | Represents general information about the target in a Matroska video. |
| MatroskaSubtitle | Represents subtitle metadata in a Matroska video. |
| MatroskaSubtitleTrack | Represents subtitle metadata in a Matroska video. |
| MatroskaTag | Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video. |
| MatroskaTrack | Represents track metadata in a Matroska video. |
| MatroskaVideoTrack | Represents video metadata in a Matroska video. |
| MovAtom | Represents a QuickTime atom. |
| MovPackage | Represents QuickTime metadata. |
| MovRootPackage | Represents the root package allowing working with metadata in a QuickTime video. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| AsfCodecType | Defines ASF codec types. |
| AsfDescriptorType | Defines ASF descriptor types. |
| AsfExtendedStreamPropertyFlags | Defines ASF extended stream property flags. |
| AsfFilePropertyFlags | Defines ASF file property flags. |
| AsfStreamType | Defines ASF stream types. |
| AviHeaderFlags | Represents AVI Header flags. |
| MatroskaContentType | Represents a Matroska content type. |
| MatroskaTargetTypeValue | Represents a number to indicate the logical level of the Matroska tag target. |
| MatroskaTrackType | Represents Matroska track types coded in 8 bits. |
| MatroskaVideoDisplayUnit | Defines how Matroska DisplayWidth and DisplayHeight are interpreted. |
| MatroskaVideoFieldOrder | Represents the field ordering of the Matroska video. If FlagInterlaced is not set to 1, this Element MUST be ignored. |
| MatroskaVideoFlagInterlaced | Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| MatroskaVideoStereoMode | Represents Matroska Stereo-3D video modes. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### AsfAudioStreamProperty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfaudiostreamproperty.md

#### AsfAudioStreamProperty class

Represents Audio stream property metadata in the ASF media container.

```csharp
public class AsfAudioStreamProperty : AsfBaseStreamProperty
```

#### Properties

| Name | Description |
| --- | --- |
| AlternateBitrate { get; } | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| AverageBitrate { get; } | Gets the average bitrate. |
| AverageTimePerFrame { get; } | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| Bitrate { get; } | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| BitsPerSample { get; } | Gets the number of bits per sample of monaural data. |
| Channels { get; } | Gets the number of audio channels. |
| Count { get; } | Gets the number of metadata properties. |
| EndTime { get; } | Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| Flags { get; } | Gets the flags. |
| FormatTag { get; } | Gets the unique ID of the codec used to encode the audio data. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the stream language. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SamplesPerSecond { get; } | Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream. |
| StartTime { get; } | Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole. |
| StreamNumber { get; } | Gets the number of this stream. |
| StreamType { get; } | Gets the type of this stream. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsPerSample
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfaudiostreamproperty/bitspersample.md

#### AsfAudioStreamProperty.BitsPerSample property

Gets the number of bits per sample of monaural data.

```csharp
public ushort BitsPerSample { get; }
```

##### Property Value

The number of bits per sample of monaural data.

### Channels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfaudiostreamproperty/channels.md

#### AsfAudioStreamProperty.Channels property

Gets the number of audio channels.

```csharp
public ushort Channels { get; }
```

##### Property Value

The number of audio channels.

### FormatTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfaudiostreamproperty/formattag.md

#### AsfAudioStreamProperty.FormatTag property

Gets the unique ID of the codec used to encode the audio data.

```csharp
public ushort FormatTag { get; }
```

##### Property Value

The unique ID of the codec used to encode the audio data.

### SamplesPerSecond
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfaudiostreamproperty/samplespersecond.md

#### AsfAudioStreamProperty.SamplesPerSecond property

Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.

```csharp
public uint SamplesPerSecond { get; }
```

##### Property Value

The a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.

### AsfBaseDescriptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasedescriptor.md

#### AsfBaseDescriptor class

Represents an ASF base metadata descriptor object.

```csharp
public abstract class AsfBaseDescriptor : MetadataProperty
```

#### Properties

| Name | Description |
| --- | --- |
| AsfContentType { get; } | Gets the type of the content. |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### AsfContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasedescriptor/asfcontenttype.md

#### AsfBaseDescriptor.AsfContentType property

Gets the type of the content.

```csharp
public AsfDescriptorType AsfContentType { get; }
```

##### Property Value

The type of the content.

### AsfBaseStreamProperty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty.md

#### AsfBaseStreamProperty class

Represents base stream property metadata in the ASF media container.

```csharp
public abstract class AsfBaseStreamProperty : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| AlternateBitrate { get; } | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| AverageBitrate { get; } | Gets the average bitrate. |
| AverageTimePerFrame { get; } | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| Bitrate { get; } | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| Count { get; } | Gets the number of metadata properties. |
| EndTime { get; } | Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| Flags { get; } | Gets the flags. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the stream language. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StartTime { get; } | Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole. |
| StreamNumber { get; } | Gets the number of this stream. |
| StreamType { get; } | Gets the type of this stream. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AlternateBitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/alternatebitrate.md

#### AsfBaseStreamProperty.AlternateBitrate property

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

```csharp
public uint? AlternateBitrate { get; }
```

##### Property Value

The leak rate RAlt, in bits per second.

### AverageBitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/averagebitrate.md

#### AsfBaseStreamProperty.AverageBitrate property

Gets the average bitrate.

```csharp
public uint? AverageBitrate { get; }
```

##### Property Value

The average bitrate.

### AverageTimePerFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/averagetimeperframe.md

#### AsfBaseStreamProperty.AverageTimePerFrame property

Gets the average time duration, measured in 100-nanosecond units, of each frame.

```csharp
public ulong? AverageTimePerFrame { get; }
```

##### Property Value

The average time duration, measured in 100-nanosecond units, of each frame.

### Bitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/bitrate.md

#### AsfBaseStreamProperty.Bitrate property

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

```csharp
public uint? Bitrate { get; }
```

##### Property Value

The bleak rate R, in bits per second.

### EndTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/endtime.md

#### AsfBaseStreamProperty.EndTime property

Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole.

```csharp
public ulong? EndTime { get; }
```

##### Property Value

The presentation time of the last object plus the duration of play.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/flags.md

#### AsfBaseStreamProperty.Flags property

Gets the flags.

```csharp
public AsfExtendedStreamPropertyFlags? Flags { get; }
```

##### Property Value

The flags.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/language.md

#### AsfBaseStreamProperty.Language property

Gets the stream language.

```csharp
public string Language { get; }
```

##### Property Value

The stream language.

### StartTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/starttime.md

#### AsfBaseStreamProperty.StartTime property

Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole.

```csharp
public ulong? StartTime { get; }
```

##### Property Value

The presentation time of the first object.

### StreamNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/streamnumber.md

#### AsfBaseStreamProperty.StreamNumber property

Gets the number of this stream.

```csharp
public byte StreamNumber { get; }
```

##### Property Value

The number of this stream.

### StreamType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfbasestreamproperty/streamtype.md

#### AsfBaseStreamProperty.StreamType property

Gets the type of this stream.

```csharp
public AsfStreamType StreamType { get; }
```

##### Property Value

The type of this stream.

### AsfCodec
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodec.md

#### AsfCodec class

Represents ASF codec metadata.

```csharp
public class AsfCodec : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CodecType { get; } | Gets the type of the codec. |
| Count { get; } | Gets the number of metadata properties. |
| Description { get; } | Gets the description. |
| Information { get; } | Gets the information string. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the property name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CodecType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodec/codectype.md

#### AsfCodec.CodecType property

Gets the type of the codec.

```csharp
public AsfCodecType CodecType { get; }
```

##### Property Value

The type of the codec.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodec/description.md

#### AsfCodec.Description property

Gets the description.

```csharp
public string Description { get; }
```

##### Property Value

The description.

### Information
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodec/information.md

#### AsfCodec.Information property

Gets the information string.

```csharp
public string Information { get; }
```

##### Property Value

The information string.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodec/name.md

#### AsfCodec.Name property

Gets the property name.

```csharp
public string Name { get; }
```

##### Property Value

The property name.

### AsfCodecType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcodectype.md

#### AsfCodecType enumeration

Defines ASF codec types.

```csharp
public enum AsfCodecType : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Undefined codec. |
| Video | `1` | Video codec. |
| Audio | `2` | Audio codec. |
| Unknown | `65535` | Unknown codec. |

### AsfContentDescriptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfcontentdescriptor.md

#### AsfContentDescriptor class

Represents an ASF content descriptor object.

```csharp
public sealed class AsfContentDescriptor : AsfBaseDescriptor
```

#### Properties

| Name | Description |
| --- | --- |
| AsfContentType { get; } | Gets the type of the content. |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### AsfDescriptorType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfdescriptortype.md

#### AsfDescriptorType enumeration

Defines ASF descriptor types.

```csharp
public enum AsfDescriptorType : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unicode | `0` | The unicode string type. |
| ByteArray | `1` | The byte array type. |
| Bool | `2` | The 32-bit bool type. |
| DWord | `3` | The 32-bit unsigned integer type. |
| QWord | `4` | The 64-bit unsigned integer type. |
| Word | `5` | The 16-bit unsigned integer type. |
| Guid | `6` | The 128-bit (16 byte) GUID type. |

### AsfExtendedStreamPropertyFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfextendedstreampropertyflags.md

#### AsfExtendedStreamPropertyFlags enumeration

Defines ASF extended stream property flags.

```csharp
[Flags]
public enum AsfExtendedStreamPropertyFlags : uint
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Reliable | `1` | This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism. |
| Seekable | `2` | This flag should be set only if the stream is seekable. |
| NoCleanpoints | `2` | The stream does not contain any cleanpoints. |
| ResendLiveCleanpoints | `2` | A stream is joined in mid-transmission, all information from the most recent cleanpoint up to the current time should be sent before normal streaming begins at the current time. |

### AsfFilePropertyFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asffilepropertyflags.md

#### AsfFilePropertyFlags enumeration

Defines ASF file property flags.

```csharp
[Flags]
public enum AsfFilePropertyFlags : uint
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The undefined flag. |
| Broadcast | `1` | Specifies, that a file is in the process of being created, and thus that various values stored in the header objects are invalid. |
| Seekable | `2` | Specifies, that a file is seekable. |

### AsfMetadataDescriptor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfmetadatadescriptor.md

#### AsfMetadataDescriptor class

Represents an ASF metadata descriptor.

```csharp
public sealed class AsfMetadataDescriptor : AsfBaseDescriptor
```

#### Properties

| Name | Description |
| --- | --- |
| AsfContentType { get; } | Gets the type of the content. |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Language { get; } | Gets the language. |
| Name { get; } | Gets the property name. |
| OriginalName { get; } | Gets the original name of the descriptor. |
| StreamNumber { get; } | Gets the stream number. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfmetadatadescriptor/language.md

#### AsfMetadataDescriptor.Language property

Gets the language.

```csharp
public string Language { get; }
```

##### Property Value

The language.

### OriginalName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfmetadatadescriptor/originalname.md

#### AsfMetadataDescriptor.OriginalName property

Gets the original name of the descriptor.

```csharp
public string OriginalName { get; }
```

##### Property Value

The original name of the descriptor.

### StreamNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfmetadatadescriptor/streamnumber.md

#### AsfMetadataDescriptor.StreamNumber property

Gets the stream number.

```csharp
public ushort StreamNumber { get; }
```

##### Property Value

The stream number.

### AsfMetadataDescriptorCollection
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection.md

#### AsfMetadataDescriptorCollection class

Represents a collection of metadata descriptors.

```csharp
public class AsfMetadataDescriptorCollection : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AsfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage.md

#### AsfPackage class

Represents native metadata of the ASF media container.

```csharp
public class AsfPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CodecInformation { get; } | Gets the codec info entries. |
| Count { get; } | Gets the number of metadata properties. |
| CreationDate { get; } | Gets the date and time of the initial creation of the file. |
| FileID { get; } | Gets the unique identifier for this file. |
| Flags { get; } | Gets the header flags. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataDescriptors { get; } | Gets the metadata descriptors. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StreamProperties { get; } | Gets the digital media stream properties. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CodecInformation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/codecinformation.md

#### AsfPackage.CodecInformation property

Gets the codec info entries.

```csharp
public AsfCodec[] CodecInformation { get; }
```

##### Property Value

The codec info entries.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/creationdate.md

#### AsfPackage.CreationDate property

Gets the date and time of the initial creation of the file.

```csharp
public DateTime CreationDate { get; }
```

##### Property Value

The date and time of the initial creation of the file.

### FileID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/fileid.md

#### AsfPackage.FileID property

Gets the unique identifier for this file.

```csharp
public Guid FileID { get; }
```

##### Property Value

The unique identifier for this file.

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/flags.md

#### AsfPackage.Flags property

Gets the header flags.

```csharp
public AsfFilePropertyFlags Flags { get; }
```

##### Property Value

The header flags.

### MetadataDescriptors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/metadatadescriptors.md

#### AsfPackage.MetadataDescriptors property

Gets the metadata descriptors.

```csharp
public AsfBaseDescriptor[] MetadataDescriptors { get; }
```

##### Property Value

The metadata descriptors.

### StreamProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfpackage/streamproperties.md

#### AsfPackage.StreamProperties property

Gets the digital media stream properties.

```csharp
public AsfBaseStreamProperty[] StreamProperties { get; }
```

##### Property Value

The digital media stream properties.

### AsfRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfrootpackage.md

#### AsfRootPackage class

Represents the root package allowing working with metadata in an ASF video.

```csharp
public class AsfRootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| AsfPackage { get; } | Gets the ASF metadata package. |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AsfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfrootpackage/asfpackage.md

#### AsfRootPackage.AsfPackage property

Gets the ASF metadata package.

```csharp
public AsfPackage AsfPackage { get; }
```

##### Property Value

The ASF metadata package.

##### Examples

This code sample demonstrates how to read native ASF metadata.

```csharp
using (Metadata metadata = new Metadata(Constants.InputAsf))
{
    var root = metadata.GetRootPackage<AsfRootPackage>();

    var package = root.AsfPackage;

    // Display basic properties
    Console.WriteLine("Creation date: {0}", package.CreationDate);
    Console.WriteLine("File id: {0}", package.FileID);
    Console.WriteLine("Flags: {0}", package.Flags);

    // Display Asf Codec Information
    foreach (var codecInfo in package.CodecInformation)
    {
        Console.WriteLine("Codec type: {0}", codecInfo.CodecType);
        Console.WriteLine("Description: {0}", codecInfo.Description);
        Console.WriteLine("Codec information: {0}", codecInfo.Information);
        Console.WriteLine(codecInfo.Name);
    }

    // Display metadata descriptors
    foreach (AsfBaseDescriptor descriptor in package.MetadataDescriptors)
    {
        Console.WriteLine("Name: {0}", descriptor.Name);
        Console.WriteLine("Value: {0}", descriptor.Value);
        Console.WriteLine("Content type: {0}", descriptor.AsfContentType);
        AsfMetadataDescriptor metadataDescriptor = descriptor as AsfMetadataDescriptor;
        if (metadataDescriptor != null)
        {
            Console.WriteLine("Language: {0}", metadataDescriptor.Language);
            Console.WriteLine("Stream number: {0}", metadataDescriptor.StreamNumber);
            Console.WriteLine("Original name: {0}", metadataDescriptor.OriginalName);
        }
    }

    //Display the base stream properties
    foreach (AsfBaseStreamProperty property in package.StreamProperties)
    {
        Console.WriteLine("Alternate bitrate: {0}", property.AlternateBitrate);
        Console.WriteLine("Average bitrate: {0}", property.AverageBitrate);
        Console.WriteLine("Average time per frame: {0}", property.AverageTimePerFrame);
        Console.WriteLine("Bitrate: {0}", property.Bitrate);
        Console.WriteLine("Stream end time: {0}", property.EndTime);
        Console.WriteLine("Stream flags: {0}", property.Flags);
        Console.WriteLine("Stream language: {0}", property.Language);
        Console.WriteLine("Stream start time: {0}", property.StartTime);
        Console.WriteLine("Stream number: {0}", property.StreamNumber);
        Console.WriteLine("Stream type: {0}", property.StreamType);

        //Display the audio stream properties
        AsfAudioStreamProperty audioStreamProperty = property as AsfAudioStreamProperty;
        if (audioStreamProperty != null)
        {
            Console.WriteLine("Audio bits per sample: {0}", audioStreamProperty.BitsPerSample);
            Console.WriteLine("Audio channels: {0}", audioStreamProperty.Channels);
            Console.WriteLine("Audio format tag: {0}", audioStreamProperty.FormatTag);
            Console.WriteLine("Audio samples per second: {0}", audioStreamProperty.SamplesPerSecond);
        }

        //Display the video stream properties
        AsfVideoStreamProperty videoStreamProperty = property as AsfVideoStreamProperty;
        if (videoStreamProperty != null)
        {
            Console.WriteLine("Video bits per pixels: {0}", videoStreamProperty.BitsPerPixels);
            Console.WriteLine("Compression: {0}", videoStreamProperty.Compression);
            Console.WriteLine("Image height: {0}", videoStreamProperty.ImageHeight);
            Console.WriteLine("Image width: {0}", videoStreamProperty.ImageWidth);
        }
    }
}
```

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfrootpackage/xmppackage.md

#### AsfRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.AsfWithXmp))
{
    var root = metadata.GetRootPackage<AsfRootPackage>();
    if (root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### AsfStreamType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfstreamtype.md

#### AsfStreamType enumeration

Defines ASF stream types.

```csharp
public enum AsfStreamType : ushort
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Undefined stream type. |
| Audio | `1` | ASF Audio Media. |
| Video | `2` | ASF Video Media. |
| Command | `3` | ASF Command Media. |
| Jfif | `4` | ASF JFIF Media. |
| DegradableJpeg | `5` | ASF Degradable JPEG Media. |
| FileTransfer | `6` | ASF File Transfer Media. |
| Binary | `7` | ASF Binary Media. |
| WebStreamSubtype | `8` | ASF Web Stream Media Subtype. |
| WebStreamFormat | `9` | ASF Web Stream Format. |

### AsfVideoStreamProperty
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfvideostreamproperty.md

#### AsfVideoStreamProperty class

Represents Video stream property metadata in the ASF media container.

```csharp
public class AsfVideoStreamProperty : AsfBaseStreamProperty
```

#### Properties

| Name | Description |
| --- | --- |
| AlternateBitrate { get; } | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| AverageBitrate { get; } | Gets the average bitrate. |
| AverageTimePerFrame { get; } | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| Bitrate { get; } | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| BitsPerPixels { get; } | Gets the bits per pixels. |
| Compression { get; } | Gets the video compression Id. |
| Count { get; } | Gets the number of metadata properties. |
| EndTime { get; } | Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| Flags { get; } | Gets the flags. |
| ImageHeight { get; } | Gets the height of the encoded image in pixels. |
| ImageWidth { get; } | Gets the width of the encoded image in pixels. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the stream language. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StartTime { get; } | Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole. |
| StreamNumber { get; } | Gets the number of this stream. |
| StreamType { get; } | Gets the type of this stream. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitsPerPixels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfvideostreamproperty/bitsperpixels.md

#### AsfVideoStreamProperty.BitsPerPixels property

Gets the bits per pixels.

```csharp
public uint BitsPerPixels { get; }
```

##### Property Value

The bits per pixels.

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfvideostreamproperty/compression.md

#### AsfVideoStreamProperty.Compression property

Gets the video compression Id.

```csharp
public uint Compression { get; }
```

##### Property Value

The video compression Id.

### ImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfvideostreamproperty/imageheight.md

#### AsfVideoStreamProperty.ImageHeight property

Gets the height of the encoded image in pixels.

```csharp
public uint ImageHeight { get; }
```

##### Property Value

The height of the encoded image in pixels.

### ImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/asfvideostreamproperty/imagewidth.md

#### AsfVideoStreamProperty.ImageWidth property

Gets the width of the encoded image in pixels.

```csharp
public uint ImageWidth { get; }
```

##### Property Value

The width of the encoded image in pixels.

### AviHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader.md

#### AviHeader class

Represents the AVIMAINHEADER structure in an AVI video.

```csharp
public sealed class AviHeader : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| AviHeader() | Initializes a new instance of the `AviHeader` class. |

#### Properties

| Name | Description |
| --- | --- |
| AviHeaderFlags { get; } | Gets a bitwise combination of zero or more of the AVI flags. |
| Count { get; } | Gets the number of metadata properties. |
| Height { get; } | Gets the height of the AVI file in pixels. |
| InitialFrames { get; } | Gets the initial frame for interleaved files.  Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames in the file prior to the initial frame of the AVI sequence in this member. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MaxBytesPerSec { get; } | Gets the approximate maximum data rate of the file.  This value indicates the number of bytes per second the system must handle to present an AVI sequence as specified by the other parameters contained in the main header and stream header chunks. |
| MetadataType { get; } | Gets the metadata type. |
| MicroSecPerFrame { get; } | Gets the the number of microseconds between frames. This value indicates the overall timing for the file. |
| PaddingGranularity { get; } | Gets the alignment for data, in bytes. Pad the data to multiples of this value. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Streams { get; } | Gets the number of streams in the file. For example, a file with audio and video has two streams. |
| SuggestedBufferSize { get; } | Gets the suggested buffer size for reading the file.  Generally, this size should be large enough to contain the largest chunk in the file. If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file, the buffer size should be large enough to read an entire record, and not just a chunk. |
| TotalFrames { get; } | Gets the the total number of frames of data in the file. |
| Width { get; } | Gets the width of the AVI file in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AviHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/aviheader.md

#### AviHeader constructor

Initializes a new instance of the `AviHeader` class.

```csharp
public AviHeader()
```

### AviHeaderFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/aviheaderflags.md

#### AviHeader.AviHeaderFlags property

Gets a bitwise combination of zero or more of the AVI flags.

```csharp
public AviHeaderFlags AviHeaderFlags { get; }
```

##### Property Value

The AVI flags.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/height.md

#### AviHeader.Height property

Gets the height of the AVI file in pixels.

```csharp
public int Height { get; }
```

##### Property Value

The height in pixels.

### InitialFrames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/initialframes.md

#### AviHeader.InitialFrames property

Gets the initial frame for interleaved files.  Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames in the file prior to the initial frame of the AVI sequence in this member.

```csharp
public int InitialFrames { get; }
```

##### Property Value

The initial frames.

### MaxBytesPerSec
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/maxbytespersec.md

#### AviHeader.MaxBytesPerSec property

Gets the approximate maximum data rate of the file.  This value indicates the number of bytes per second the system must handle to present an AVI sequence as specified by the other parameters contained in the main header and stream header chunks.

```csharp
public int MaxBytesPerSec { get; }
```

##### Property Value

The the approximate maximum data rate of the file.

### MicroSecPerFrame
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/microsecperframe.md

#### AviHeader.MicroSecPerFrame property

Gets the the number of microseconds between frames. This value indicates the overall timing for the file.

```csharp
public int MicroSecPerFrame { get; }
```

##### Property Value

The number of microseconds between frames.

### PaddingGranularity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/paddinggranularity.md

#### AviHeader.PaddingGranularity property

Gets the alignment for data, in bytes. Pad the data to multiples of this value.

```csharp
public int PaddingGranularity { get; }
```

##### Property Value

The the alignment for data.

### Streams
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/streams.md

#### AviHeader.Streams property

Gets the number of streams in the file. For example, a file with audio and video has two streams.

```csharp
public int Streams { get; }
```

##### Property Value

The number of streams.

### SuggestedBufferSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/suggestedbuffersize.md

#### AviHeader.SuggestedBufferSize property

Gets the suggested buffer size for reading the file.  Generally, this size should be large enough to contain the largest chunk in the file. If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file, the buffer size should be large enough to read an entire record, and not just a chunk.

```csharp
public int SuggestedBufferSize { get; }
```

##### Property Value

The suggested buffer size for reading the file.

### TotalFrames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/totalframes.md

#### AviHeader.TotalFrames property

Gets the the total number of frames of data in the file.

```csharp
public int TotalFrames { get; }
```

##### Property Value

The total number of frames.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheader/width.md

#### AviHeader.Width property

Gets the width of the AVI file in pixels.

```csharp
public int Width { get; }
```

##### Property Value

The width in pixels.

### AviHeaderFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/aviheaderflags.md

#### AviHeaderFlags enumeration

Represents AVI Header flags.

```csharp
[Flags]
public enum AviHeaderFlags
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| HasIndex | `10` | Indicates the AVI file has an index. |
| MustUseIndex | `20` | Indicates that application should use the index, rather than the physical ordering of the chunks in the file, to determine the order of presentation of the data. For example, this flag could be used to create a list of frames for editing. |
| IsInterleaved | `100` | Indicates the AVI file is interleaved. |
| TrustCkType | `800` | Use CKType to find key frames. |
| WasCaptureFile | `10000` | Indicates the AVI file is a specially allocated file used for capturing real-time video. Applications should warn the user before writing over a file with this flag set because the user probably defragmented this file. |
| Copyrighted | `20000` | Indicates the AVI file contains copyrighted data and software. When this flag is used, software should not permit the data to be duplicated. |

### AviRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/avirootpackage.md

#### AviRootPackage class

Represents the root package allowing working with metadata in an AVI video.

```csharp
public class AviRootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Header { get; } | Gets the AVI header package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RiffInfoPackage { get; } | Gets the package containing RIFF Info tags. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Header
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/avirootpackage/header.md

#### AviRootPackage.Header property

Gets the AVI header package.

```csharp
public AviHeader Header { get; }
```

##### Property Value

The AVI header package.

##### Examples

This code snippet shows how to read AVI header properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputAvi))
{
    var root = metadata.GetRootPackage<AviRootPackage>();

    Console.WriteLine(root.Header.AviHeaderFlags);
    Console.WriteLine(root.Header.Height);
    Console.WriteLine(root.Header.Width);
    Console.WriteLine(root.Header.TotalFrames);
    Console.WriteLine(root.Header.InitialFrames);
    Console.WriteLine(root.Header.MaxBytesPerSec);
    Console.WriteLine(root.Header.PaddingGranularity);
    Console.WriteLine(root.Header.Streams);

    // ...
}
```

### RiffInfoPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/avirootpackage/riffinfopackage.md

#### AviRootPackage.RiffInfoPackage property

Gets the package containing RIFF Info tags.

```csharp
public RiffInfoPackage RiffInfoPackage { get; }
```

##### Property Value

The package containing RIFF Info tags.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/avirootpackage/xmppackage.md

#### AviRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
<example> 
This example demonstrates how to extract XMP metadata from a file.
<code lang="C#"><![CDATA[
using (Metadata metadata = new Metadata(Constants.AviWithXmp))
{
    var root = metadata.GetRootPackage<AviRootPackage>();
    if (root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### FlvHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvheader.md

#### FlvHeader class

Represents a FLV video header.

```csharp
public class FlvHeader : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| HasAudioTags { get; } | Gets a value indicating whether audio tags are present in the file. |
| HasVideoTags { get; } | Gets a value indicating whether video tags are present in the file. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TypeFlags { get; } | Gets the FLV type flags. |
| Version { get; } | Gets the file version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### HasAudioTags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvheader/hasaudiotags.md

#### FlvHeader.HasAudioTags property

Gets a value indicating whether audio tags are present in the file.

```csharp
public bool HasAudioTags { get; }
```

##### Property Value

True if the FLV file contains audio tags; otherwise, false.

### HasVideoTags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvheader/hasvideotags.md

#### FlvHeader.HasVideoTags property

Gets a value indicating whether video tags are present in the file.

```csharp
public bool HasVideoTags { get; }
```

##### Property Value

True if the FLV file contains video tags; otherwise, false.

### TypeFlags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvheader/typeflags.md

#### FlvHeader.TypeFlags property

Gets the FLV type flags.

```csharp
public byte TypeFlags { get; }
```

##### Property Value

The FLV type flags.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvheader/version.md

#### FlvHeader.Version property

Gets the file version.

```csharp
public byte Version { get; }
```

##### Property Value

The file version.

### FlvRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvrootpackage.md

#### FlvRootPackage class

Represents the root package allowing working with metadata in an FLV video.

```csharp
public class FlvRootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Header { get; } | Gets the FLV header package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Header
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvrootpackage/header.md

#### FlvRootPackage.Header property

Gets the FLV header package.

```csharp
public FlvHeader Header { get; }
```

##### Property Value

The FLV header package.

##### Examples

This example shows how to read FLV header properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputFlv))
{
    var root = metadata.GetRootPackage<FlvRootPackage>();

    Console.WriteLine(root.Header.Version);
    Console.WriteLine(root.Header.HasAudioTags);
    Console.WriteLine(root.Header.HasVideoTags);
    Console.WriteLine(root.Header.TypeFlags);
}
```

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/flvrootpackage/xmppackage.md

#### FlvRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.FlvWithXmp))
{
    var root = metadata.GetRootPackage<FlvRootPackage>();
    if (root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### MatroskaAudioTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaaudiotrack.md

#### MatroskaAudioTrack class

Represents audio metadata in a Matroska video.

```csharp
public class MatroskaAudioTrack : MatroskaTrack
```

#### Properties

| Name | Description |
| --- | --- |
| BitDepth { get; } | Gets the bits per sample, mostly used for PCM. |
| Channels { get; } | Gets the numbers of channels in the track. |
| CodecID { get; } | Gets an ID corresponding to the codec. |
| CodecName { get; } | Gets a human-readable string specifying the codec. |
| Count { get; } | Gets the number of metadata properties. |
| DefaultDuration { get; } | Gets the number of nanoseconds (not scaled via `TimecodeScale`) per frame. |
| FlagEnabled { get; } | Gets the enabled flag, true if the track is usable. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the `LanguageIetf` Element is used in the same TrackEntry. |
| LanguageIetf { get; } | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any `Language` Elements used in the same TrackEntry MUST be ignored. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the human-readable track name. |
| OutputSamplingFrequency { get; } | Gets the real output sampling frequency in Hz (used for SBR techniques). |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SamplingFrequency { get; } | Gets the sampling frequency in Hz. |
| TrackNumber { get; } | Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| TrackType { get; } | Gets the type of the track. |
| TrackUid { get; } | Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BitDepth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaaudiotrack/bitdepth.md

#### MatroskaAudioTrack.BitDepth property

Gets the bits per sample, mostly used for PCM.

```csharp
public ulong? BitDepth { get; }
```

##### Property Value

The bits per sample, mostly used for PCM.

### Channels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaaudiotrack/channels.md

#### MatroskaAudioTrack.Channels property

Gets the numbers of channels in the track.

```csharp
public ulong Channels { get; }
```

##### Property Value

The numbers of channels in the track.

### OutputSamplingFrequency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaaudiotrack/outputsamplingfrequency.md

#### MatroskaAudioTrack.OutputSamplingFrequency property

Gets the real output sampling frequency in Hz (used for SBR techniques).

```csharp
public double OutputSamplingFrequency { get; }
```

##### Property Value

The real output sampling frequency in Hz (used for SBR techniques).

### SamplingFrequency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaaudiotrack/samplingfrequency.md

#### MatroskaAudioTrack.SamplingFrequency property

Gets the sampling frequency in Hz.

```csharp
public double SamplingFrequency { get; }
```

##### Property Value

The sampling frequency in Hz.

### MatroskaBasePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskabasepackage.md

#### MatroskaBasePackage class

Provides a base metadata class for all packages extracted from a Matroska video.

```csharp
public abstract class MatroskaBasePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### MatroskaContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskacontenttype.md

#### MatroskaContentType enumeration

Represents a Matroska content type.

```csharp
public enum MatroskaContentType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Undefined content. |
| Audio | `1` | Defines the Matroska audio type. |
| Video | `2` | Defines the Matroska video type. |
| Video3D | `3` | Defines the Matroska 3D video type. |

### MatroskaEbmlHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader.md

#### MatroskaEbmlHeader class

Represents EBML header metadata in a Matroska video.

```csharp
public class MatroskaEbmlHeader : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DocType { get; } | Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'. |
| DocTypeReadVersion { get; } | Gets the minimum version number a `DocType` parser must be compliant with to read the file. |
| DocTypeVersion { get; } | Gets the version of the `DocType` writer used to create the file. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ReadVersion { get; } | Gets the minimum version an EBML parser needs to be compliant with to be able to read the file. |
| Version { get; } | Gets the version of the EBML Writer that has been used to create the file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DocType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader/doctype.md

#### MatroskaEbmlHeader.DocType property

Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'.

```csharp
public string DocType { get; }
```

##### Property Value

The contents of the file.

### DocTypeReadVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader/doctypereadversion.md

#### MatroskaEbmlHeader.DocTypeReadVersion property

Gets the minimum version number a `DocType` parser must be compliant with to read the file.

```csharp
public byte DocTypeReadVersion { get; }
```

##### Property Value

The minimum version number a `DocType` parser must be compliant with to read the file.

### DocTypeVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader/doctypeversion.md

#### MatroskaEbmlHeader.DocTypeVersion property

Gets the version of the `DocType` writer used to create the file.

```csharp
public byte DocTypeVersion { get; }
```

##### Property Value

The version of the `DocType` writer used to create the file.

### ReadVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader/readversion.md

#### MatroskaEbmlHeader.ReadVersion property

Gets the minimum version an EBML parser needs to be compliant with to be able to read the file.

```csharp
public byte ReadVersion { get; }
```

##### Property Value

The minimum version an EBML parser needs to be compliant with to be able to read the file.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskaebmlheader/version.md

#### MatroskaEbmlHeader.Version property

Gets the version of the EBML Writer that has been used to create the file.

```csharp
public byte Version { get; }
```

##### Property Value

The version of the EBML Writer that has been used to create the file.

### MatroskaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage.md

#### MatroskaPackage class

Represents a metadata container in a Matroska video.

```csharp
public class MatroskaPackage : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| ContentType { get; } | Gets the Matroska content type. |
| Count { get; } | Gets the number of metadata properties. |
| EbmlHeader { get; } | Gets the EBML header metadata. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Segments { get; } | Gets the segment information metadata. |
| SubtitleTracks { get; } | Gets the subtitle metadata entries. |
| Tags { get; } | Gets the tagging metadata. |
| Tracks { get; } | Gets the track metadata entries. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/contenttype.md

#### MatroskaPackage.ContentType property

Gets the Matroska content type.

```csharp
public MatroskaContentType ContentType { get; }
```

##### Property Value

The Matroska content type.

### EbmlHeader
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/ebmlheader.md

#### MatroskaPackage.EbmlHeader property

Gets the EBML header metadata.

```csharp
public MatroskaEbmlHeader EbmlHeader { get; }
```

##### Property Value

The EBML header metadata.

### Segments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/segments.md

#### MatroskaPackage.Segments property

Gets the segment information metadata.

```csharp
public MatroskaSegment[] Segments { get; }
```

##### Property Value

The segment information metadata.

### SubtitleTracks
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/subtitletracks.md

#### MatroskaPackage.SubtitleTracks property

Gets the subtitle metadata entries.

```csharp
public MatroskaSubtitleTrack[] SubtitleTracks { get; }
```

##### Return Value

The subtitle metadata entries.

### Tags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/tags.md

#### MatroskaPackage.Tags property

Gets the tagging metadata.

```csharp
public MatroskaTag[] Tags { get; }
```

##### Property Value

The tagging metadata.

### Tracks
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskapackage/tracks.md

#### MatroskaPackage.Tracks property

Gets the track metadata entries.

```csharp
public MatroskaTrack[] Tracks { get; }
```

##### Property Value

The track metadata entries.

### MatroskaRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskarootpackage.md

#### MatroskaRootPackage class

Represents the root package allowing working with metadata in a Matroska video.

```csharp
public class MatroskaRootPackage : RootMetadataPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MatroskaPackage { get; } | Gets the Matroska metadata package. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to extract subtitles from an MKV video.

```csharp
using (Metadata metadata = new Metadata(Constants.MkvWithSubtitles))
{
    var root = metadata.GetRootPackage<MatroskaRootPackage>();

    foreach (var subtitleTrack in root.MatroskaPackage.SubtitleTracks)
    {
        Console.WriteLine(subtitleTrack.LanguageIetf ?? subtitleTrack.Language);
        foreach (MatroskaSubtitle subtitle in subtitleTrack.Subtitles)
        {
            Console.WriteLine("Timecode={0}, Duration={1}", subtitle.Timecode, subtitle.Duration);
            Console.WriteLine(subtitle.Text);
        }
    }
}
```

### MatroskaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskarootpackage/matroskapackage.md

#### MatroskaRootPackage.MatroskaPackage property

Gets the Matroska metadata package.

```csharp
public MatroskaPackage MatroskaPackage { get; }
```

##### Property Value

The Matroska metadata package.

##### Examples

This example demonstrates how to read Matroska format-specific metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMkv))
{
    var root = metadata.GetRootPackage<MatroskaRootPackage>();

    // Read the EBML header
    Console.WriteLine("DocType: {0}", root.MatroskaPackage.EbmlHeader.DocType);
    Console.WriteLine("DocTypeReadVersion: {0}", root.MatroskaPackage.EbmlHeader.DocTypeReadVersion);
    Console.WriteLine("DocTypeVersion: {0}", root.MatroskaPackage.EbmlHeader.DocTypeVersion);
    Console.WriteLine("ReadVersion: {0}", root.MatroskaPackage.EbmlHeader.ReadVersion);
    Console.WriteLine("Version: {0}", root.MatroskaPackage.EbmlHeader.Version);

    // Read Matroska segment information
    foreach (var segment in root.MatroskaPackage.Segments)
    {
        Console.WriteLine("DateUtc: {0}", segment.DateUtc);
        Console.WriteLine("Duration: {0}", segment.Duration);
        Console.WriteLine("MuxingApp: {0}", segment.MuxingApp);
        Console.WriteLine("SegmentFilename: {0}", segment.SegmentFilename);
        Console.WriteLine("SegmentUid: {0}", segment.SegmentUid);
        Console.WriteLine("TimecodeScale: {0}", segment.TimecodeScale);
        Console.WriteLine("Title: {0}", segment.Title);
        Console.WriteLine("WritingApp: {0}", segment.WritingApp);
    }

    // Read Matroska tag metadata
    foreach (var tag in root.MatroskaPackage.Tags)
    {
        Console.WriteLine("TargetType: {0}", tag.TargetType);
        Console.WriteLine("TargetTypeValue: {0}", tag.TargetTypeValue);
        Console.WriteLine("TagTrackUid: {0}", tag.TagTrackUid);
        foreach (var simpleTag in tag.SimpleTags)
        {
            Console.WriteLine("Name: {0}", simpleTag.Name);
            Console.WriteLine("Value: {0}", simpleTag.Value);
        }
    }

    // Read Matroska track metadata
    foreach (var track in root.MatroskaPackage.Tracks)
    {
        Console.WriteLine("CodecId: {0}", track.CodecID);
        Console.WriteLine("CodecName: {0}", track.CodecName);
        Console.WriteLine("DefaultDuration: {0}", track.DefaultDuration);
        Console.WriteLine("FlagEnabled: {0}", track.FlagEnabled);
        Console.WriteLine("Language: {0}", track.Language);
        Console.WriteLine("LanguageIetf: {0}", track.LanguageIetf);
        Console.WriteLine("Name: {0}", track.Name);
        Console.WriteLine("TrackNumber: {0}", track.TrackNumber);
        Console.WriteLine("TrackType: {0}", track.TrackType);
        Console.WriteLine("TrackUid: {0}", track.TrackUid);

        var audioTrack = track as MatroskaAudioTrack;
        if (audioTrack != null)
        {
            Console.WriteLine("SamplingFrequency: {0}", audioTrack.SamplingFrequency);
            Console.WriteLine("OutputSamplingFrequency: {0}", audioTrack.OutputSamplingFrequency);
            Console.WriteLine("Channels: {0}", audioTrack.Channels);
            Console.WriteLine("BitDepth: {0}", audioTrack.BitDepth);
        }

        var videoTrack = track as MatroskaVideoTrack;
        if (videoTrack != null)
        {
            Console.WriteLine("FlagInterlaced: {0}", videoTrack.FlagInterlaced);
            Console.WriteLine("FieldOrder: {0}", videoTrack.FieldOrder);
            Console.WriteLine("StereoMode: {0}", videoTrack.StereoMode);
            Console.WriteLine("AlphaMode: {0}", videoTrack.AlphaMode);
            Console.WriteLine("PixelWidth: {0}", videoTrack.PixelWidth);
            Console.WriteLine("PixelHeight: {0}", videoTrack.PixelHeight);
            Console.WriteLine("PixelCropBottom: {0}", videoTrack.PixelCropBottom);
            Console.WriteLine("PixelCropTop: {0}", videoTrack.PixelCropTop);
            Console.WriteLine("PixelCropLeft: {0}", videoTrack.PixelCropLeft);
            Console.WriteLine("PixelCropRight: {0}", videoTrack.PixelCropRight);
            Console.WriteLine("DisplayWidth: {0}", videoTrack.DisplayWidth);
            Console.WriteLine("DisplayHeight: {0}", videoTrack.DisplayHeight);
            Console.WriteLine("DisplayUnit: {0}", videoTrack.DisplayUnit);
        }
    }
}
```

### MatroskaSegment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment.md

#### MatroskaSegment class

Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video.

```csharp
public class MatroskaSegment : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DateUtc { get; } | Gets the date and time that the Segment was created by the muxing application or library. |
| Duration { get; } | Gets the duration of the SEGMENT. Please see `TimecodeScale` for more information. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MuxingApp { get; } | Gets the full name of the application or library followed by the version number. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ScaledDuration { get; } | Gets the scaled duration of the SEGMENT. |
| SegmentFilename { get; } | Gets the filename corresponding to this Segment. |
| SegmentUid { get; } | Gets the unique 128 bit number identifying a SEGMENT. Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID. |
| TimecodeScale { get; } | Gets the timecode scale value. Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled! |
| Title { get; } | Gets the general name of the Segment. |
| WritingApp { get; } | Gets the full name of the application followed by the version number. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DateUtc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/dateutc.md

#### MatroskaSegment.DateUtc property

Gets the date and time that the Segment was created by the muxing application or library.

```csharp
public DateTime? DateUtc { get; }
```

##### Property Value

The date and time that the Segment was created by the muxing application or library.

### Duration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/duration.md

#### MatroskaSegment.Duration property

Gets the duration of the SEGMENT. Please see `TimecodeScale` for more information.

```csharp
public double? Duration { get; }
```

##### Property Value

The duration of the SEGMENT.

### MuxingApp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/muxingapp.md

#### MatroskaSegment.MuxingApp property

Gets the full name of the application or library followed by the version number.

```csharp
public string MuxingApp { get; }
```

##### Property Value

The full name of the application or library followed by the version number.

### ScaledDuration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/scaledduration.md

#### MatroskaSegment.ScaledDuration property

Gets the scaled duration of the SEGMENT.

```csharp
public TimeSpan? ScaledDuration { get; }
```

##### Property Value

The scaled duration of the SEGMENT.

### SegmentFilename
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/segmentfilename.md

#### MatroskaSegment.SegmentFilename property

Gets the filename corresponding to this Segment.

```csharp
public string SegmentFilename { get; }
```

##### Property Value

The filename corresponding to this Segment.

### SegmentUid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/segmentuid.md

#### MatroskaSegment.SegmentUid property

Gets the unique 128 bit number identifying a SEGMENT. Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID.

```csharp
public byte[] SegmentUid { get; }
```

##### Property Value

The unique 128 bit number identifying a SEGMENT.

### TimecodeScale
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/timecodescale.md

#### MatroskaSegment.TimecodeScale property

Gets the timecode scale value. Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled!

```csharp
public ulong TimecodeScale { get; }
```

##### Property Value

The timecode scale value.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/title.md

#### MatroskaSegment.Title property

Gets the general name of the Segment.

```csharp
public string Title { get; }
```

##### Property Value

The general name of the Segment.

### WritingApp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasegment/writingapp.md

#### MatroskaSegment.WritingApp property

Gets the full name of the application followed by the version number.

```csharp
public string WritingApp { get; }
```

##### Property Value

The full name of the application followed by the version number.

### MatroskaSimpleTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasimpletag.md

#### MatroskaSimpleTag class

Represents general information about the target in a Matroska video.

```csharp
public class MatroskaSimpleTag : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### MatroskaSubtitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitle.md

#### MatroskaSubtitle class

Represents subtitle metadata in a Matroska video.

```csharp
public class MatroskaSubtitle : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Duration { get; } | Gets the duration. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Text { get; } | Gets the subtitle text. |
| Timecode { get; } | Gets the time code. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Duration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitle/duration.md

#### MatroskaSubtitle.Duration property

Gets the duration.

```csharp
public TimeSpan Duration { get; }
```

##### Property Value

The duration.

### Text
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitle/text.md

#### MatroskaSubtitle.Text property

Gets the subtitle text.

```csharp
public string Text { get; }
```

##### Property Value

The subtitle text.

### Timecode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitle/timecode.md

#### MatroskaSubtitle.Timecode property

Gets the time code.

```csharp
public TimeSpan Timecode { get; }
```

##### Property Value

The time code.

### MatroskaSubtitleTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitletrack.md

#### MatroskaSubtitleTrack class

Represents subtitle metadata in a Matroska video.

```csharp
public class MatroskaSubtitleTrack : MatroskaTrack
```

#### Properties

| Name | Description |
| --- | --- |
| CodecID { get; } | Gets an ID corresponding to the codec. |
| CodecName { get; } | Gets a human-readable string specifying the codec. |
| Count { get; } | Gets the number of metadata properties. |
| DefaultDuration { get; } | Gets the number of nanoseconds (not scaled via `TimecodeScale`) per frame. |
| FlagEnabled { get; } | Gets the enabled flag, true if the track is usable. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the `LanguageIetf` Element is used in the same TrackEntry. |
| LanguageIetf { get; } | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any `Language` Elements used in the same TrackEntry MUST be ignored. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the human-readable track name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Subtitles { get; } | Gets the subtitles. |
| TrackNumber { get; } | Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| TrackType { get; } | Gets the type of the track. |
| TrackUid { get; } | Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Subtitles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskasubtitletrack/subtitles.md

#### MatroskaSubtitleTrack.Subtitles property

Gets the subtitles.

```csharp
public MatroskaSubtitle[] Subtitles { get; }
```

##### Property Value

The subtitles.

### MatroskaTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatag.md

#### MatroskaTag class

Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video.

```csharp
public class MatroskaTag : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SimpleTags { get; } | Gets the general information about the target. |
| TagTrackUid { get; } | Gets a unique ID to identify the Track(s) the tags belong to. If the value is 0 at this level, the tags apply to all tracks in the Segment. |
| TargetType { get; } | Gets an informational string that can be used to display the logical level of the target. Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc. |
| TargetTypeValue { get; } | Gets the number to indicate the logical level of the target. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### SimpleTags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatag/simpletags.md

#### MatroskaTag.SimpleTags property

Gets the general information about the target.

```csharp
public MatroskaSimpleTag SimpleTags { get; }
```

##### Property Value

The general information about the target.

### TagTrackUid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatag/tagtrackuid.md

#### MatroskaTag.TagTrackUid property

Gets a unique ID to identify the Track(s) the tags belong to. If the value is 0 at this level, the tags apply to all tracks in the Segment.

```csharp
public ulong TagTrackUid { get; }
```

##### Property Value

A unique ID to identify the Track(s) the tags belong to.

### TargetType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatag/targettype.md

#### MatroskaTag.TargetType property

Gets an informational string that can be used to display the logical level of the target. Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc.

```csharp
public string TargetType { get; }
```

##### Property Value

An informational string that can be used to display the logical level of the target.

### TargetTypeValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatag/targettypevalue.md

#### MatroskaTag.TargetTypeValue property

Gets the number to indicate the logical level of the target.

```csharp
public MatroskaTargetTypeValue TargetTypeValue { get; }
```

##### Property Value

The number to indicate the logical level of the target.

### MatroskaTargetTypeValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatargettypevalue.md

#### MatroskaTargetTypeValue enumeration

Represents a number to indicate the logical level of the Matroska tag target.

```csharp
public enum MatroskaTargetTypeValue : uint
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Undefined level. |
| Collection | `70` | COLLECTION level. |
| Edition | `60` | EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level. |
| Album | `50` | ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level. |
| Part | `40` | PART / SESSION level. |
| Track | `30` | TRACK / SONG / CHAPTER level. |
| Subtrack | `20` | SUBTRACK / PART / MOVEMENT / SCENE level. |
| Shot | `10` | SHOT level. |

### MatroskaTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack.md

#### MatroskaTrack class

Represents track metadata in a Matroska video.

```csharp
public class MatroskaTrack : MatroskaBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| CodecID { get; } | Gets an ID corresponding to the codec. |
| CodecName { get; } | Gets a human-readable string specifying the codec. |
| Count { get; } | Gets the number of metadata properties. |
| DefaultDuration { get; } | Gets the number of nanoseconds (not scaled via `TimecodeScale`) per frame. |
| FlagEnabled { get; } | Gets the enabled flag, true if the track is usable. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the `LanguageIetf` Element is used in the same TrackEntry. |
| LanguageIetf { get; } | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any `Language` Elements used in the same TrackEntry MUST be ignored. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the human-readable track name. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TrackNumber { get; } | Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| TrackType { get; } | Gets the type of the track. |
| TrackUid { get; } | Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CodecID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/codecid.md

#### MatroskaTrack.CodecID property

Gets an ID corresponding to the codec.

```csharp
public string CodecID { get; }
```

##### Property Value

An ID corresponding to the codec.

##### Remarks

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.

### CodecName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/codecname.md

#### MatroskaTrack.CodecName property

Gets a human-readable string specifying the codec.

```csharp
public string CodecName { get; }
```

##### Property Value

A human-readable string specifying the codec.

### DefaultDuration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/defaultduration.md

#### MatroskaTrack.DefaultDuration property

Gets the number of nanoseconds (not scaled via `TimecodeScale`) per frame.

```csharp
public ulong? DefaultDuration { get; }
```

##### Property Value

The number of nanoseconds (not scaled via `TimecodeScale`) per frame.

##### Remarks

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.

### FlagEnabled
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/flagenabled.md

#### MatroskaTrack.FlagEnabled property

Gets the enabled flag, true if the track is usable.

```csharp
public bool FlagEnabled { get; }
```

##### Property Value

The enabled flag.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/language.md

#### MatroskaTrack.Language property

Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the `LanguageIetf` Element is used in the same TrackEntry.

```csharp
public string Language { get; }
```

##### Property Value

The language of the track in the Matroska languages form.

##### Remarks

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french), or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French). Country codes are the same as used for internet domains.

### LanguageIetf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/languageietf.md

#### MatroskaTrack.LanguageIetf property

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any `Language` Elements used in the same TrackEntry MUST be ignored.

```csharp
public string LanguageIetf { get; }
```

##### Property Value

The language of the track according to BCP 47 and using the IANA Language Subtag Registry.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/name.md

#### MatroskaTrack.Name property

Gets the human-readable track name.

```csharp
public string Name { get; }
```

##### Property Value

The human-readable track name.

### TrackNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/tracknumber.md

#### MatroskaTrack.TrackNumber property

Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number.

```csharp
public ulong TrackNumber { get; }
```

##### Property Value

The track number as used in the Block Header.

### TrackType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/tracktype.md

#### MatroskaTrack.TrackType property

Gets the type of the track.

```csharp
public MatroskaTrackType TrackType { get; }
```

##### Property Value

The type of the track.

### TrackUid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatrack/trackuid.md

#### MatroskaTrack.TrackUid property

Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file.

```csharp
public ulong TrackUid { get; }
```

##### Property Value

The unique ID to identify the Track.

### MatroskaTrackType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskatracktype.md

#### MatroskaTrackType enumeration

Represents Matroska track types coded in 8 bits.

```csharp
public enum MatroskaTrackType : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The undefined track type. |
| Video | `1` | Track is a video track. |
| Audio | `2` | Track is an audio track. |
| Complex | `3` | Track is a complex track, i.e. a combined video and audio track. |
| Logo | `16` | Track is a logo track. |
| Subtitle | `17` | Track is a subtitle track. |
| Button | `18` | Track is a button track. |
| Control | `32` | Track is a control track. |

### MatroskaVideoDisplayUnit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideodisplayunit.md

#### MatroskaVideoDisplayUnit enumeration

Defines how Matroska DisplayWidth and DisplayHeight are interpreted.

```csharp
public enum MatroskaVideoDisplayUnit : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pixels | `0` | Pixels unit. |
| Centimeters | `1` | Centimeters unit. |
| Inches | `2` | Inches unit. |
| AspectRatio | `3` | Display aspect ratio unit. |
| Unknown | `4` | Unknown unit. |

### MatroskaVideoFieldOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideofieldorder.md

#### MatroskaVideoFieldOrder enumeration

Represents the field ordering of the Matroska video. If FlagInterlaced is not set to 1, this Element MUST be ignored.

```csharp
public enum MatroskaVideoFieldOrder : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Progressive | `0` | Progressive ordering. |
| Tff | `1` | Tiff ordering. |
| Undetermined | `2` | Undetermined ordering. |
| Bff | `6` | Biff ordering. |
| BffSwapped | `9` | Bff (swapped) ordering. |
| TffSwapped | `14` | Tff (swapped) ordering. |

### MatroskaVideoFlagInterlaced
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideoflaginterlaced.md

#### MatroskaVideoFlagInterlaced enumeration

Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement.

```csharp
public enum MatroskaVideoFlagInterlaced : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undetermined | `0` | Undetermined flag. |
| Interlaced | `1` | Interlaced flag. |
| Progressive | `2` | Progressive flag. |

### MatroskaVideoStereoMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideostereomode.md

#### MatroskaVideoStereoMode enumeration

Represents Matroska Stereo-3D video modes.

```csharp
public enum MatroskaVideoStereoMode : uint
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Mono | `0` | Mono mode. |
| SideBySideLeft | `1` | Side by side (left eye first) video mode. |
| TopBottomRight | `2` | Top - bottom (right eye is first) video mode. |
| TopBottomLeft | `3` | Top - bottom (left eye is first) video mode. |
| CheckboardRight | `4` | Checkboard (right eye is first) video mode. |
| CheckboardLleft | `5` | Checkboard (left eye is first) video mode. |
| RowInterleavedRight | `6` | Row interleaved (right eye is first) video mode. |
| RowInterleavedLeft | `7` | Row interleaved (left eye is first) video mode. |
| ColumnInterleavedRight | `8` | Column interleaved (right eye is first) video mode. |
| ColumnInterleavedLeft | `9` | Column interleaved (left eye is first) video mode. |
| AnaglyphCyanRed | `10` | Anaglyph (cyan/red) video mode. |
| SideBySideRight | `11` | Side by side (right eye first) video mode. |
| AnaglyphGreenMagenta | `12` | Anaglyph (green/magenta) video mode. |
| BothEyesLacedLeft | `13` | Both eyes laced in one Block (left eye is first) video mode. |
| BothEyesLacedRight | `14` | Both eyes laced in one Block (right eye is first) video mode. |

### MatroskaVideoTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack.md

#### MatroskaVideoTrack class

Represents video metadata in a Matroska video.

```csharp
public class MatroskaVideoTrack : MatroskaTrack
```

#### Properties

| Name | Description |
| --- | --- |
| AlphaMode { get; } | Gets the alpha Video Mode. Presence of this Element indicates that the BlockAdditional Element could contain Alpha data. |
| CodecID { get; } | Gets an ID corresponding to the codec. |
| CodecName { get; } | Gets a human-readable string specifying the codec. |
| Count { get; } | Gets the number of metadata properties. |
| DefaultDuration { get; } | Gets the number of nanoseconds (not scaled via `TimecodeScale`) per frame. |
| DisplayHeight { get; } | Gets the height of the video frames to display. Applies to the video frame after cropping (PixelCrop* Elements). |
| DisplayUnit { get; } | Gets the how `DisplayWidth`and `DisplayHeight` are interpreted. |
| DisplayWidth { get; } | Gets the width of the video frames to display. Applies to the video frame after cropping (PixelCrop* Elements). |
| FieldOrder { get; } | Gets declare the field ordering of the video. If FlagInterlaced is not set to 1, this Element MUST be ignored. |
| FlagEnabled { get; } | Gets the enabled flag, true if the track is usable. |
| FlagInterlaced { get; } | Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the `LanguageIetf` Element is used in the same TrackEntry. |
| LanguageIetf { get; } | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any `Language` Elements used in the same TrackEntry MUST be ignored. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; } | Gets the human-readable track name. |
| PixelCropBottom { get; } | Gets the number of video pixels to remove at the bottom of the image. |
| PixelCropLeft { get; } | Gets the number of video pixels to remove on the left of the image. |
| PixelCropRight { get; } | Gets the number of video pixels to remove on the right of the image. |
| PixelCropTop { get; } | Gets the number of video pixels to remove at the top of the image. |
| PixelHeight { get; } | Gets the height of the encoded video frames in pixels. |
| PixelWidth { get; } | Gets the width of the encoded video frames in pixels. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| StereoMode { get; } | Gets the stereo-3D video mode. |
| TrackNumber { get; } | Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| TrackType { get; } | Gets the type of the track. |
| TrackUid { get; } | Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AlphaMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/alphamode.md

#### MatroskaVideoTrack.AlphaMode property

Gets the alpha Video Mode. Presence of this Element indicates that the BlockAdditional Element could contain Alpha data.

```csharp
public ulong? AlphaMode { get; }
```

##### Property Value

The alpha Video Mode.

### DisplayHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/displayheight.md

#### MatroskaVideoTrack.DisplayHeight property

Gets the height of the video frames to display. Applies to the video frame after cropping (PixelCrop* Elements).

```csharp
public ulong? DisplayHeight { get; }
```

##### Property Value

The height of the video frames to display.

### DisplayUnit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/displayunit.md

#### MatroskaVideoTrack.DisplayUnit property

Gets the how `DisplayWidth`and `DisplayHeight` are interpreted.

```csharp
public MatroskaVideoDisplayUnit DisplayUnit { get; }
```

##### Property Value

The how `DisplayWidth`and `DisplayHeight` are interpreted.

### DisplayWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/displaywidth.md

#### MatroskaVideoTrack.DisplayWidth property

Gets the width of the video frames to display. Applies to the video frame after cropping (PixelCrop* Elements).

```csharp
public ulong? DisplayWidth { get; }
```

##### Property Value

The width of the video frames to display.

### FieldOrder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/fieldorder.md

#### MatroskaVideoTrack.FieldOrder property

Gets declare the field ordering of the video. If FlagInterlaced is not set to 1, this Element MUST be ignored.

```csharp
public MatroskaVideoFieldOrder FieldOrder { get; }
```

##### Property Value

Declare the field ordering of the video.

### FlagInterlaced
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/flaginterlaced.md

#### MatroskaVideoTrack.FlagInterlaced property

Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.

```csharp
public MatroskaVideoFlagInterlaced FlagInterlaced { get; }
```

##### Property Value

A flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.

### PixelCropBottom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelcropbottom.md

#### MatroskaVideoTrack.PixelCropBottom property

Gets the number of video pixels to remove at the bottom of the image.

```csharp
public ulong PixelCropBottom { get; }
```

##### Property Value

The number of video pixels to remove at the bottom of the image.

### PixelCropLeft
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelcropleft.md

#### MatroskaVideoTrack.PixelCropLeft property

Gets the number of video pixels to remove on the left of the image.

```csharp
public ulong PixelCropLeft { get; }
```

##### Property Value

The number of video pixels to remove on the left of the image.

### PixelCropRight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelcropright.md

#### MatroskaVideoTrack.PixelCropRight property

Gets the number of video pixels to remove on the right of the image.

```csharp
public ulong PixelCropRight { get; }
```

##### Property Value

The number of video pixels to remove on the right of the image.

### PixelCropTop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelcroptop.md

#### MatroskaVideoTrack.PixelCropTop property

Gets the number of video pixels to remove at the top of the image.

```csharp
public ulong PixelCropTop { get; }
```

##### Property Value

The number of video pixels to remove at the top of the image.

### PixelHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelheight.md

#### MatroskaVideoTrack.PixelHeight property

Gets the height of the encoded video frames in pixels.

```csharp
public ulong PixelHeight { get; }
```

##### Property Value

The height of the encoded video frames in pixels.

### PixelWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/pixelwidth.md

#### MatroskaVideoTrack.PixelWidth property

Gets the width of the encoded video frames in pixels.

```csharp
public ulong PixelWidth { get; }
```

##### Property Value

The width of the encoded video frames in pixels.

### StereoMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/matroskavideotrack/stereomode.md

#### MatroskaVideoTrack.StereoMode property

Gets the stereo-3D video mode.

```csharp
public MatroskaVideoStereoMode? StereoMode { get; }
```

##### Property Value

The stereo-3D video mode.

### MovAtom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom.md

#### MovAtom class

Represents a QuickTime atom.

```csharp
public sealed class MovAtom : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Atoms { get; } | Gets an array of `MovAtom` atoms. |
| Count { get; } | Gets the number of metadata properties. |
| DataOffset { get; } | Gets the data offset. |
| DataSize { get; } | Gets the data size in bytes. |
| HasExtendedSize { get; } | Gets a value indicating whether the extended size field was used to store the atom data. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LongSize { get; } | Gets the atom size in bytes. |
| MetadataType { get; } | Gets the metadata type. |
| Offset { get; } | Gets the atom offset. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Size { get; } | Gets the atom size in bytes. |
| Type { get; } | Gets the 4-characters type. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Atoms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/atoms.md

#### MovAtom.Atoms property

Gets an array of `MovAtom` atoms.

```csharp
public MovAtom[] Atoms { get; }
```

##### Property Value

The QuickTime atoms.

### DataOffset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/dataoffset.md

#### MovAtom.DataOffset property

Gets the data offset.

```csharp
public long DataOffset { get; }
```

##### Property Value

The data offset.

### DataSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/datasize.md

#### MovAtom.DataSize property

Gets the data size in bytes.

```csharp
public int DataSize { get; }
```

##### Property Value

The data size.

### HasExtendedSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/hasextendedsize.md

#### MovAtom.HasExtendedSize property

Gets a value indicating whether the extended size field was used to store the atom data.

```csharp
public bool HasExtendedSize { get; }
```

##### Property Value

True, if the extended size field was used to store the atom data; otherwise, false.

### LongSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/longsize.md

#### MovAtom.LongSize property

Gets the atom size in bytes.

```csharp
public long LongSize { get; }
```

##### Property Value

The atom size.

### Offset
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/offset.md

#### MovAtom.Offset property

Gets the atom offset.

```csharp
public long Offset { get; }
```

##### Property Value

The atom offset.

### Size
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/size.md

#### MovAtom.Size property

Gets the atom size in bytes.

```csharp
public int Size { get; }
```

##### Property Value

The atom size.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movatom/type.md

#### MovAtom.Type property

Gets the 4-characters type.

```csharp
public string Type { get; }
```

##### Property Value

The type.

### MovPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage.md

#### MovPackage class

Represents QuickTime metadata.

```csharp
public sealed class MovPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Album { get; } | Album or collection name of which the movie content forms a part |
| Artist { get; } | Name of the artist who created the movie file content. |
| Artwork { get; } | A single image that can represent the movie file content. |
| Atoms { get; } | Gets an array of `MovAtom` atoms. |
| Author { get; } | Name of the author of the movie file content. |
| Comment { get; } | User entered comment regarding the movie file content. |
| Copyright { get; } | Copyright statement for the movie file content. |
| Count { get; } | Gets the number of metadata properties. |
| CreationDate { get; } | The date the movie file content was created. |
| Description { get; } | Description of the movie file content. |
| Director { get; } | Name of the director of the movie content. |
| Genre { get; } | Text describing the genre or genres to which the movie content conforms. |
| Information { get; } | Information about the movie file content. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; } | Keywords associated with the movie file content. |
| LocationBody { get; } | The astronomical body, for compatibility with the 3GPP format |
| LocationDate { get; } | A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format. |
| LocationFacing { get; } | An indication of the direction the camera is facing during the shot. |
| LocationMotion { get; } | An indication of the direction the camera is moving during the shot. |
| LocationName { get; } | Name of the location. |
| LocationNote { get; } | Descriptive comment. |
| LocationRole { get; } | A single byte, binary value containing a value from the set: 0 indicates “shooting location”, 1 indicates “real location”, 2 indicates “fictional location”. Other values are reserved. |
| MetadataType { get; } | Gets the metadata type. |
| MovieCreationTime { get; set; } | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| MovieDuration { get; } | A time value that indicates the duration of the movie in seconds. |
| MovieModificationTime { get; set; } | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| Producer { get; } | Name of producer of movie file content. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publisher { get; } | Name of publisher of movie file content. |
| Software { get; } | Name of software used to create the movie file content. |
| Title { get; } | The title of the movie file content. |
| UserRatings { get; } | A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie. |
| Users { get; } | A name indicating a user-defined collection that includes this movie. |
| Year { get; } | Year when the movie file or the original content was created or recorded. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/album.md

#### MovPackage.Album property

Album or collection name of which the movie content forms a part

```csharp
public string Album { get; }
```

##### Property Value

The Album.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/artist.md

#### MovPackage.Artist property

Name of the artist who created the movie file content.

```csharp
public string Artist { get; }
```

##### Property Value

The Artist.

### Artwork
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/artwork.md

#### MovPackage.Artwork property

A single image that can represent the movie file content.

```csharp
public string Artwork { get; }
```

##### Property Value

The Artwork.

### Atoms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/atoms.md

#### MovPackage.Atoms property

Gets an array of `MovAtom` atoms.

```csharp
public MovAtom[] Atoms { get; }
```

##### Property Value

The QuickTime atoms.

### Author
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/author.md

#### MovPackage.Author property

Name of the author of the movie file content.

```csharp
public string Author { get; }
```

##### Property Value

The Author.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/comment.md

#### MovPackage.Comment property

User entered comment regarding the movie file content.

```csharp
public string Comment { get; }
```

##### Property Value

The Comment.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/copyright.md

#### MovPackage.Copyright property

Copyright statement for the movie file content.

```csharp
public string Copyright { get; }
```

##### Property Value

The Copyright.

### CreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/creationdate.md

#### MovPackage.CreationDate property

The date the movie file content was created.

```csharp
public string CreationDate { get; }
```

##### Property Value

The CreationDate.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/description.md

#### MovPackage.Description property

Description of the movie file content.

```csharp
public string Description { get; }
```

##### Property Value

The Description.

### Director
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/director.md

#### MovPackage.Director property

Name of the director of the movie content.

```csharp
public string Director { get; }
```

##### Property Value

The Director.

### Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/genre.md

#### MovPackage.Genre property

Text describing the genre or genres to which the movie content conforms.

```csharp
public string Genre { get; }
```

##### Property Value

The Genre.

### Information
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/information.md

#### MovPackage.Information property

Information about the movie file content.

```csharp
public string Information { get; }
```

##### Property Value

The Information.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/keywords.md

#### MovPackage.Keywords property

Keywords associated with the movie file content.

```csharp
public string Keywords { get; }
```

##### Property Value

The Keywords.

### LocationBody
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationbody.md

#### MovPackage.LocationBody property

The astronomical body, for compatibility with the 3GPP format

```csharp
public string LocationBody { get; }
```

##### Property Value

The LocationBody.

### LocationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationdate.md

#### MovPackage.LocationDate property

A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format.

```csharp
public string LocationDate { get; }
```

##### Property Value

The LocationDate.

### LocationFacing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationfacing.md

#### MovPackage.LocationFacing property

An indication of the direction the camera is facing during the shot.

```csharp
public string LocationFacing { get; }
```

##### Property Value

The LocationFacing.

### LocationMotion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationmotion.md

#### MovPackage.LocationMotion property

An indication of the direction the camera is moving during the shot.

```csharp
public string LocationMotion { get; }
```

##### Property Value

The LocationMotion.

### LocationName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationname.md

#### MovPackage.LocationName property

Name of the location.

```csharp
public string LocationName { get; }
```

##### Property Value

The LocationName.

### LocationNote
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationnote.md

#### MovPackage.LocationNote property

Descriptive comment.

```csharp
public string LocationNote { get; }
```

##### Property Value

The LocationNote.

### LocationRole
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/locationrole.md

#### MovPackage.LocationRole property

A single byte, binary value containing a value from the set: 0 indicates “shooting location”, 1 indicates “real location”, 2 indicates “fictional location”. Other values are reserved.

```csharp
public string LocationRole { get; }
```

##### Property Value

The LocationRole.

### MovieCreationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/moviecreationtime.md

#### MovPackage.MovieCreationTime property

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

```csharp
public DateTime? MovieCreationTime { get; set; }
```

##### Property Value

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

### MovieDuration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/movieduration.md

#### MovPackage.MovieDuration property

A time value that indicates the duration of the movie in seconds.

```csharp
public uint MovieDuration { get; }
```

##### Property Value

A time value that indicates the duration of the movie in seconds.

### MovieModificationTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/moviemodificationtime.md

#### MovPackage.MovieModificationTime property

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

```csharp
public DateTime? MovieModificationTime { get; set; }
```

##### Property Value

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

### Producer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/producer.md

#### MovPackage.Producer property

Name of producer of movie file content.

```csharp
public string Producer { get; }
```

##### Property Value

The Producer.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/publisher.md

#### MovPackage.Publisher property

Name of publisher of movie file content.

```csharp
public string Publisher { get; }
```

##### Property Value

The Publisher.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/software.md

#### MovPackage.Software property

Name of software used to create the movie file content.

```csharp
public string Software { get; }
```

##### Property Value

The Software.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/title.md

#### MovPackage.Title property

The title of the movie file content.

```csharp
public string Title { get; }
```

##### Property Value

The Title.

### UserRatings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/userratings.md

#### MovPackage.UserRatings property

A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.

```csharp
public string UserRatings { get; }
```

##### Property Value

The UserRatings.

### Users
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/users.md

#### MovPackage.Users property

A name indicating a user-defined collection that includes this movie.

```csharp
public string Users { get; }
```

##### Property Value

The Users.

### Year
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movpackage/year.md

#### MovPackage.Year property

Year when the movie file or the original content was created or recorded.

```csharp
public string Year { get; }
```

##### Property Value

The Year.

### MovRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movrootpackage.md

#### MovRootPackage class

Represents the root package allowing working with metadata in a QuickTime video.

```csharp
public class MovRootPackage : RootMetadataPackage, IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FileType { get; } | Gets the file type metadata package. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| MovPackage { get; } | Gets the QuickTime metadata package. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| override Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to read QuickTime atoms in a MOV video.

```csharp
using (Metadata metadata = new Metadata(Constants.InputMov))
{
    var root = metadata.GetRootPackage<MovRootPackage>();

    foreach (var atom in root.MovPackage.Atoms)
    {
        Console.WriteLine(atom.Type);
        Console.WriteLine(atom.Offset);
        Console.WriteLine(atom.Size);

        // ...
    }
}
```

### MovPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movrootpackage/movpackage.md

#### MovRootPackage.MovPackage property

Gets the QuickTime metadata package.

```csharp
public MovPackage MovPackage { get; }
```

##### Property Value

The QuickTime metadata package.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.formats.video/movrootpackage/xmppackage.md

#### MovRootPackage.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

### GroupDocs.Metadata.Import
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import.md

#### Classes

| Class | Description |
| --- | --- |
| ImportManager | Provides a row of methods allowing the user to import metadata properties to various formats. |
| ImportOptions | Abstract class import options. |
| JsonImportOptions | Creates an import options from json file. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ImportFormat | Defines file formats to which you can import metadata properties. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ImportFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importformat.md

#### ImportFormat enumeration

Defines file formats to which you can import metadata properties.

```csharp
public enum ImportFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Json | `0` | Represents the .JSON format. |

### ImportManager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importmanager.md

#### ImportManager class

Provides a row of methods allowing the user to import metadata properties to various formats.

```csharp
public class ImportManager
```

#### Constructors

| Name | Description |
| --- | --- |
| ImportManager(RootMetadataPackage) | Initializes a new instance of the `ImportManager` class. |

#### Methods

| Name | Description |
| --- | --- |
| Import(Stream, ImportFormat, ImportOptions) | Imports the metadata properties to a file. |
| Import(string, ImportFormat, ImportOptions) | Imports the metadata properties to a file. |

### Import
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importmanager/import.md

#### Import(string, ImportFormat, ImportOptions)

Imports the metadata properties to a file.

```csharp
public void Import(string filePath, ImportFormat format, ImportOptions importOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The full name of the input file. |
| format | ImportFormat | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

#### Import(Stream, ImportFormat, ImportOptions)

Imports the metadata properties to a file.

```csharp
public void Import(Stream stream, ImportFormat format, ImportOptions importOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The filestream of the input file. |
| format | ImportFormat | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

### ImportManager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importmanager/importmanager.md

#### ImportManager constructor

Initializes a new instance of the `ImportManager` class.

```csharp
public ImportManager(RootMetadataPackage rootMetadataPackage)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rootMetadataPackage | RootMetadataPackage | A collection of metadata properties where the import will be performed. |

### ImportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importoptions.md

#### ImportOptions class

Abstract class import options.

```csharp
public abstract class ImportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImportOptions() | Initializes a new instance of the `ImportOptions` class. |

### ImportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/importoptions/importoptions.md

#### ImportOptions constructor

Initializes a new instance of the `ImportOptions` class.

```csharp
public ImportOptions()
```

### JsonImportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/jsonimportoptions.md

#### JsonImportOptions class

Creates an import options from json file.

```csharp
public class JsonImportOptions : ImportOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JsonImportOptions() | Initializes a new instance of the `JsonImportOptions` class. |

### JsonImportOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.import/jsonimportoptions/jsonimportoptions.md

#### JsonImportOptions constructor

Initializes a new instance of the `JsonImportOptions` class.

```csharp
public JsonImportOptions()
```

### GroupDocs.Metadata.Logging
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging.md

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the console. |
| FileLogger | Writes log messages to the file. |
| Logging | The class provides work with logger. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/consolelogger.md

#### ConsoleLogger class

Writes log messages to the console.

```csharp
public 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/metadata/net/groupdocs.metadata.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.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/metadata/net/groupdocs.metadata.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 error message. |

### Warning
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.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 error message. |

### FileLogger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/filelogger.md

#### FileLogger class

Writes log messages to the file.

```csharp
public class FileLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| FileLogger(string) | Create logger to file. |

#### 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/metadata/net/groupdocs.metadata.logging/filelogger/error.md

#### FileLogger.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. |

### FileLogger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/filelogger/filelogger.md

#### FileLogger constructor

Create logger to file.

```csharp
public FileLogger(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Full file name with path. |

### Trace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/filelogger/trace.md

#### FileLogger.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 error message. |

### Warning
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/filelogger/warning.md

#### FileLogger.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 error message. |

### ILogger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.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/metadata/net/groupdocs.metadata.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/metadata/net/groupdocs.metadata.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 error message. |

### Warning
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.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 error message. |

### Logging
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/logging.md

#### Logging class

The class provides work with logger.

```csharp
public static class Logging
```

#### Methods

| Name | Description |
| --- | --- |
| static Start(ILogger) | Start logging. |
| static Stop() | Stop logging. |

### Start
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/logging/start.md

#### Logging.Start method

Start logging.

```csharp
public static void Start(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | The error message. |

### Stop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.logging/logging/stop.md

#### Logging.Stop method

Stop logging.

```csharp
public static void Stop()
```

### GroupDocs.Metadata.Options
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options.md

The namespace contains all classes representing settings that allow users to control file and metadata processing.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Represents a method that returns a stream to write page preview data. |
| LoadOptions | Allows a developer to specify additional options (such as a password) when loading a file. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| ReleasePageStream | Represents a method which releases the stream created by the `CreatePageStream` delegate. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| PreviewOptions.PreviewFormats | Represents supported preview formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### CreatePageStream
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/createpagestream.md

#### CreatePageStream delegate

Represents a method that returns a stream to write page preview data.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a page to generate a thumbnail. |

##### Return Value

The stream to write the page preview.

### LoadOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/loadoptions.md

#### LoadOptions class

Allows a developer to specify additional options (such as a password) when loading a file.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the `LoadOptions` class. |
| LoadOptions(FileFormat) | Initializes a new instance of the `LoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileFormat { get; } | Gets the exact type of the file that is to be loaded. The default value is Unknown which means that the type should be detected automatically. |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/loadoptions/fileformat.md

#### LoadOptions.FileFormat property

Gets the exact type of the file that is to be loaded. The default value is Unknown which means that the type should be detected automatically.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

The exact type of the file that is to be loaded.

### LoadOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of the `LoadOptions` class.

```csharp
public LoadOptions()
```

#### LoadOptions(FileFormat)

Initializes a new instance of the `LoadOptions` class.

```csharp
public LoadOptions(FileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The exact type of the file. |

### Password
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/loadoptions/password.md

#### LoadOptions.Password property

Gets or sets the password for opening an encrypted document.

```csharp
public string Password { get; set; }
```

##### Property Value

Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string.

### PreviewOptions.PreviewFormats
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions.previewformats.md

#### PreviewOptions.PreviewFormats enumeration

Represents supported preview formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | Portable Network Graphics Format. |
| JPEG | `1` | Joint Photographic Experts Group Format. |
| BMP | `2` | Bitmap Picture Format. |

### PreviewOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions.md

#### PreviewOptions class

Provides options to sets requirements and stream delegates for preview generation.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CacheFolder { get; set; } | Gets or sets the cache folder. By default the cache folder is set to user's local temp directory. |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| MaxDiskSpaceForCache { get; set; } | Gets or sets the maximum available disk space for cache in bytes. The default value is 1073741824. |
| MaxMemoryForCache { get; set; } | Gets or sets the maximum available memory for cache in memory in bytes. The default value is 1073741824. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the page preview resolution. |
| Width { get; set; } | Gets or sets the page preview width. |

### CacheFolder
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/cachefolder.md

#### PreviewOptions.CacheFolder property

Gets or sets the cache folder. By default the cache folder is set to user's local temp directory.

```csharp
public string CacheFolder { get; set; }
```

### CreatePageStream
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Gets or sets an instance of the page stream creation delegate.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/height.md

#### PreviewOptions.Height property

Gets or sets the page preview height.

```csharp
public int Height { get; set; }
```

### MaxDiskSpaceForCache
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/maxdiskspaceforcache.md

#### PreviewOptions.MaxDiskSpaceForCache property

Gets or sets the maximum available disk space for cache in bytes. The default value is 1073741824.

```csharp
public int MaxDiskSpaceForCache { get; set; }
```

### MaxMemoryForCache
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/maxmemoryforcache.md

#### PreviewOptions.MaxMemoryForCache property

Gets or sets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

```csharp
public int MaxMemoryForCache { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Gets or sets an array of page numbers to generate previews.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Gets or sets the preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### ReleasePageStream
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Gets or sets an instance of the page preview completion delegate.

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

### Resolution
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/resolution.md

#### PreviewOptions.Resolution property

Gets or sets the page preview resolution.

```csharp
public int Resolution { get; set; }
```

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/previewoptions/width.md

#### PreviewOptions.Width property

Gets or sets the page preview width.

```csharp
public int Width { get; set; }
```

### ReleasePageStream
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.options/releasepagestream.md

#### ReleasePageStream delegate

Represents a method which releases the stream created by the `CreatePageStream` delegate.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a generated page preview. |
| pageStream | Stream | The stream containing the generated page preview. |

### GroupDocs.Metadata.Standards.DublinCore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore.md

The namespace contains functionality intended to read DublinCore metadata from files of different formats.

#### Classes

| Class | Description |
| --- | --- |
| DublinCorePackage | Represents a Dublin Core metadata package. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDublinCore | Defines base operations allowing working with Dublin Core metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage.md

#### DublinCorePackage class

Represents a Dublin Core metadata package.

```csharp
public sealed class DublinCorePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Contributor { get; } | Gets the contributor Dublin Core element. |
| Count { get; } | Gets the number of metadata properties. |
| Coverage { get; } | Gets the coverage Dublin Core element. |
| Creator { get; } | Gets the creator Dublin Core element. |
| Date { get; } | Gets the date Dublin Core element. |
| Description { get; } | Gets the description Dublin Core element. |
| Format { get; } | Gets the format Dublin Core element. |
| Identifier { get; } | Gets the identifier Dublin Core element. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Language { get; } | Gets the language Dublin Core element. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publisher { get; } | Gets the publisher Dublin Core element. |
| Relation { get; } | Gets the relation Dublin Core element. |
| Rights { get; } | Gets the rights Dublin Core element. |
| Source { get; } | Gets the source Dublin Core element. |
| Subject { get; } | Gets the subject Dublin Core element. |
| Title { get; } | Gets the title Dublin Core element. |
| Type { get; } | Gets the type Dublin Core element. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Contributor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/contributor.md

#### DublinCorePackage.Contributor property

Gets the contributor Dublin Core element.

```csharp
public string Contributor { get; }
```

##### Property Value

An entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization or a service.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/creator.md

#### DublinCorePackage.Creator property

Gets the creator Dublin Core element.

```csharp
public string Creator { get; }
```

##### Property Value

An entity primarily responsible for making the content of the resource. Examples of a Creator include a person, an organization, or a service.

### Date
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/date.md

#### DublinCorePackage.Date property

Gets the date Dublin Core element.

```csharp
public string Date { get; }
```

##### Property Value

A date associated with an event in the life cycle of the resource. Typically, Date will be associated with the creation or availability of the resource. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/description.md

#### DublinCorePackage.Description property

Gets the description Dublin Core element.

```csharp
public string Description { get; }
```

##### Property Value

An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.

### Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/format.md

#### DublinCorePackage.Format property

Gets the format Dublin Core element.

```csharp
public string Format { get; }
```

##### Property Value

The physical or digital manifestation of the resource. Typically, Format may include the media-type or dimensions of the resource. Examples of dimensions include size and duration. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource.

### Identifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/identifier.md

#### DublinCorePackage.Identifier property

Gets the identifier Dublin Core element.

```csharp
public string Identifier { get; }
```

##### Property Value

An unambiguous reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/language.md

#### DublinCorePackage.Language property

Gets the language Dublin Core element.

```csharp
public string Language { get; }
```

##### Property Value

A language of the intellectual content of the resource. Recommended best practice for the values of the Language element is defined by RFC 3066 which, in conjunction with ISO 639), defines two- and three-letter primary language tags with optional subtags.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/publisher.md

#### DublinCorePackage.Publisher property

Gets the publisher Dublin Core element.

```csharp
public string Publisher { get; }
```

##### Property Value

The entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.

### Relation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/relation.md

#### DublinCorePackage.Relation property

Gets the relation Dublin Core element.

```csharp
public string Relation { get; }
```

##### Property Value

A reference to a related resource. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.

### Rights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/rights.md

#### DublinCorePackage.Rights property

Gets the rights Dublin Core element.

```csharp
public string Rights { get; }
```

##### Property Value

Information about rights held in and over the resource. Typically a Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information often encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. If the rights element is absent, no assumptions can be made about the status of these and other rights with respect to the resource.

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/source.md

#### DublinCorePackage.Source property

Gets the source Dublin Core element.

```csharp
public string Source { get; }
```

##### Property Value

A Reference to a resource from which the present resource is derived. The present resource may be derived from the Source resource in whole or part. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/subject.md

#### DublinCorePackage.Subject property

Gets the subject Dublin Core element.

```csharp
public string Subject { get; }
```

##### Property Value

The topic of the content of the resource. Typically, a Subject will be expressed as keywords or key phrases or classification codes that describe the topic of the resource. Recommended best practice is to select a value from a controlled vocabulary or formal classification scheme.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/title.md

#### DublinCorePackage.Title property

Gets the title Dublin Core element.

```csharp
public string Title { get; }
```

##### Property Value

The name given to the resource. Typically, a Title will be a name by which the resource is formally known.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/dublincorepackage/type.md

#### DublinCorePackage.Type property

Gets the type Dublin Core element.

```csharp
public string Type { get; }
```

##### Property Value

The nature or genre of the content of the resource. Type includes terms describing general categories, functions, genres, or aggregation levels for content. Recommended best practice is to select a value from a controlled vocabulary (for example, the DCMIType vocabulary).

### IDublinCore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/idublincore.md

#### IDublinCore interface

Defines base operations allowing working with Dublin Core metadata.

```csharp
public interface IDublinCore
```

#### Properties

| Name | Description |
| --- | --- |
| DublinCorePackage { get; } | Gets the Dublin Core metadata package extracted from the document. |

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.dublincore/idublincore/dublincorepackage.md

#### IDublinCore.DublinCorePackage property

Gets the Dublin Core metadata package extracted from the document.

```csharp
public DublinCorePackage DublinCorePackage { get; }
```

##### Property Value

The Dublin Core metadata package extracted from the document.

### GroupDocs.Metadata.Standards.Exif.MakerNote
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote.md

The namespace contains classes intended to work with MakerNote metadata written by various camera manufacturers.

#### Classes

| Class | Description |
| --- | --- |
| CanonCameraSettingsPackage | Represents CANON camera settings. |
| CanonMakerNotePackage | Represents CANON MakerNote metadata. |
| MakerNotePackage | Provides an abstract base class for MakerNote metadata packages. |
| NikonMakerNotePackage | Represents NIKON MakerNote metadata. |
| PanasonicMakerNotePackage | Represents PANASONIC MakerNote metadata. |
| SonyMakerNotePackage | Represents SONY MakerNote metadata. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### CanonCameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage.md

#### CanonCameraSettingsPackage class

Represents CANON camera settings.

```csharp
public sealed class CanonCameraSettingsPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| AFPoint { get; } | Gets the AFPoint. |
| CameraIso { get; } | Gets the camera iso. |
| CanonExposureMode { get; } | Gets the canon exposure mode. |
| CanonFlashMode { get; } | Gets the canon flash mode. |
| CanonImageSize { get; } | Gets the size of the canon image. |
| ContinuousDrive { get; } | Gets the continuous drive. |
| Contrast { get; } | Gets the contrast. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalZoom { get; } | Gets the digital zoom. |
| EasyMode { get; } | Gets the easy mode. |
| FocusMode { get; } | Gets the focus mode. |
| FocusRange { get; } | Gets the focus range. |
| ImageStabilization { get; } | Gets the image stabilization. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensType { get; } | Gets the type of the lens. |
| MacroMode { get; } | Gets the macro mode. |
| MaxFocalLength { get; } | Gets the maximum length of the focal. |
| MetadataType { get; } | Gets the metadata type. |
| MeteringMode { get; } | Gets the metering mode. |
| MinFocalLength { get; } | Gets the minimum length of the focal. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Quality { get; } | Gets the quality. |
| RecordMode { get; } | Gets the record mode. |
| Saturation { get; } | Gets the saturation. |
| SelfTimer { get; } | Gets the self timer. |
| Sharpness { get; } | Gets the sharpness. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFPoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/afpoint.md

#### CanonCameraSettingsPackage.AFPoint property

Gets the AFPoint.

```csharp
public short AFPoint { get; }
```

##### Property Value

The AFPoint.

### CameraIso
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/cameraiso.md

#### CanonCameraSettingsPackage.CameraIso property

Gets the camera iso.

```csharp
public short CameraIso { get; }
```

##### Property Value

The camera iso.

### CanonExposureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canonexposuremode.md

#### CanonCameraSettingsPackage.CanonExposureMode property

Gets the canon exposure mode.

```csharp
public short CanonExposureMode { get; }
```

##### Property Value

The canon exposure mode.

### CanonFlashMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canonflashmode.md

#### CanonCameraSettingsPackage.CanonFlashMode property

Gets the canon flash mode.

```csharp
public short CanonFlashMode { get; }
```

##### Property Value

The canon flash mode.

### CanonImageSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canonimagesize.md

#### CanonCameraSettingsPackage.CanonImageSize property

Gets the size of the canon image.

```csharp
public short CanonImageSize { get; }
```

##### Property Value

The size of the canon image.

### ContinuousDrive
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/continuousdrive.md

#### CanonCameraSettingsPackage.ContinuousDrive property

Gets the continuous drive.

```csharp
public short ContinuousDrive { get; }
```

##### Property Value

The continuous drive.

### Contrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/contrast.md

#### CanonCameraSettingsPackage.Contrast property

Gets the contrast.

```csharp
public short Contrast { get; }
```

##### Property Value

The contrast.

### DigitalZoom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/digitalzoom.md

#### CanonCameraSettingsPackage.DigitalZoom property

Gets the digital zoom.

```csharp
public short DigitalZoom { get; }
```

##### Property Value

The digital zoom.

### EasyMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/easymode.md

#### CanonCameraSettingsPackage.EasyMode property

Gets the easy mode.

```csharp
public short EasyMode { get; }
```

##### Property Value

The easy mode.

### FocusMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/focusmode.md

#### CanonCameraSettingsPackage.FocusMode property

Gets the focus mode.

```csharp
public short FocusMode { get; }
```

##### Property Value

The focus mode.

### FocusRange
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/focusrange.md

#### CanonCameraSettingsPackage.FocusRange property

Gets the focus range.

```csharp
public short FocusRange { get; }
```

##### Property Value

The focus range.

### ImageStabilization
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/imagestabilization.md

#### CanonCameraSettingsPackage.ImageStabilization property

Gets the image stabilization.

```csharp
public short ImageStabilization { get; }
```

##### Property Value

The image stabilization.

### LensType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/lenstype.md

#### CanonCameraSettingsPackage.LensType property

Gets the type of the lens.

```csharp
public ushort LensType { get; }
```

##### Property Value

The type of the lens.

### MacroMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/macromode.md

#### CanonCameraSettingsPackage.MacroMode property

Gets the macro mode.

```csharp
public short MacroMode { get; }
```

##### Property Value

The macro mode.

### MaxFocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/maxfocallength.md

#### CanonCameraSettingsPackage.MaxFocalLength property

Gets the maximum length of the focal.

```csharp
public ushort MaxFocalLength { get; }
```

##### Property Value

The maximum length of the focal.

### MeteringMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/meteringmode.md

#### CanonCameraSettingsPackage.MeteringMode property

Gets the metering mode.

```csharp
public short MeteringMode { get; }
```

##### Property Value

The metering mode.

### MinFocalLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/minfocallength.md

#### CanonCameraSettingsPackage.MinFocalLength property

Gets the minimum length of the focal.

```csharp
public ushort MinFocalLength { get; }
```

##### Property Value

The minimum length of the focal.

### Quality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/quality.md

#### CanonCameraSettingsPackage.Quality property

Gets the quality.

```csharp
public short Quality { get; }
```

##### Property Value

The quality.

### RecordMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/recordmode.md

#### CanonCameraSettingsPackage.RecordMode property

Gets the record mode.

```csharp
public short RecordMode { get; }
```

##### Property Value

The record mode.

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/saturation.md

#### CanonCameraSettingsPackage.Saturation property

Gets the saturation.

```csharp
public short Saturation { get; }
```

##### Property Value

The saturation.

### SelfTimer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/selftimer.md

#### CanonCameraSettingsPackage.SelfTimer property

Gets the self timer.

```csharp
public short SelfTimer { get; }
```

##### Property Value

The self timer.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/sharpness.md

#### CanonCameraSettingsPackage.Sharpness property

Gets the sharpness.

```csharp
public short Sharpness { get; }
```

##### Property Value

The sharpness.

### CanonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage.md

#### CanonMakerNotePackage class

Represents CANON MakerNote metadata.

```csharp
public sealed class CanonMakerNotePackage : MakerNotePackage
```

#### Properties

| Name | Description |
| --- | --- |
| CameraSettings { get; } | Gets the camera settings. |
| CanonFileLength { get; } | Gets the length of the canon file. |
| CanonFirmwareVersion { get; } | Gets the canon firmware version. |
| CanonImageType { get; } | Gets the Canon image type. |
| CanonModelID { get; } | Gets the canon model identifier. |
| Count { get; } | Gets the number of metadata properties. |
| FileNumber { get; } | Gets the file number. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| OwnerName { get; } | Gets the name of the owner. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SerialNumber { get; } | Gets the serial number. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CameraSettings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/camerasettings.md

#### CanonMakerNotePackage.CameraSettings property

Gets the camera settings.

```csharp
public CanonCameraSettingsPackage CameraSettings { get; }
```

##### Property Value

The camera settings.

### CanonFileLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canonfilelength.md

#### CanonMakerNotePackage.CanonFileLength property

Gets the length of the canon file.

```csharp
public uint? CanonFileLength { get; }
```

##### Property Value

The length of the canon file.

### CanonFirmwareVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canonfirmwareversion.md

#### CanonMakerNotePackage.CanonFirmwareVersion property

Gets the canon firmware version.

```csharp
public string CanonFirmwareVersion { get; }
```

##### Property Value

The canon firmware version.

### CanonImageType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canonimagetype.md

#### CanonMakerNotePackage.CanonImageType property

Gets the Canon image type.

```csharp
public string CanonImageType { get; }
```

##### Property Value

The Canon type of the image.

### CanonModelID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canonmodelid.md

#### CanonMakerNotePackage.CanonModelID property

Gets the canon model identifier.

```csharp
public uint? CanonModelID { get; }
```

##### Property Value

The canon model identifier.

### FileNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/filenumber.md

#### CanonMakerNotePackage.FileNumber property

Gets the file number.

```csharp
public uint? FileNumber { get; }
```

##### Property Value

The file number.

### OwnerName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/ownername.md

#### CanonMakerNotePackage.OwnerName property

Gets the name of the owner.

```csharp
public string OwnerName { get; }
```

##### Property Value

The name of the owner.

### SerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/serialnumber.md

#### CanonMakerNotePackage.SerialNumber property

Gets the serial number.

```csharp
public uint? SerialNumber { get; }
```

##### Property Value

The serial number.

### MakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/makernotepackage.md

#### MakerNotePackage class

Provides an abstract base class for MakerNote metadata packages.

```csharp
public abstract class MakerNotePackage : ExifDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### NikonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage.md

#### NikonMakerNotePackage class

Represents NIKON MakerNote metadata.

```csharp
public sealed class NikonMakerNotePackage : MakerNotePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| NikonMakerNotePackage(TiffTag[]) | Initializes a new instance of the `NikonMakerNotePackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColorMode { get; } | Gets the color mode. |
| Count { get; } | Gets the number of metadata properties. |
| FlashSetting { get; } | Gets the flash setting. |
| FlashType { get; } | Gets the type of the flash. |
| FocusMode { get; } | Gets the focus mode. |
| Iso { get; } | Gets the iso. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MakerNoteVersion { get; } | Gets the MakerNote version. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Quality { get; } | Gets the quality string. |
| Sharpness { get; } | Gets the sharpness. |
| WhiteBalance { get; } | Gets the white balance. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/colormode.md

#### NikonMakerNotePackage.ColorMode property

Gets the color mode.

```csharp
public string ColorMode { get; }
```

##### Property Value

The color mode.

### FlashSetting
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/flashsetting.md

#### NikonMakerNotePackage.FlashSetting property

Gets the flash setting.

```csharp
public string FlashSetting { get; }
```

##### Property Value

The flash setting.

### FlashType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/flashtype.md

#### NikonMakerNotePackage.FlashType property

Gets the type of the flash.

```csharp
public string FlashType { get; }
```

##### Property Value

The type of the flash.

### FocusMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/focusmode.md

#### NikonMakerNotePackage.FocusMode property

Gets the focus mode.

```csharp
public string FocusMode { get; }
```

##### Property Value

The focus mode.

### Iso
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/iso.md

#### NikonMakerNotePackage.Iso property

Gets the iso.

```csharp
public ushort[] Iso { get; }
```

##### Property Value

The iso.

### MakerNoteVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/makernoteversion.md

#### NikonMakerNotePackage.MakerNoteVersion property

Gets the MakerNote version.

```csharp
public byte[] MakerNoteVersion { get; }
```

##### Property Value

The MakerNote version.

### NikonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/nikonmakernotepackage.md

#### NikonMakerNotePackage constructor

Initializes a new instance of the `NikonMakerNotePackage` class.

```csharp
public NikonMakerNotePackage(TiffTag[] tags)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tags | TiffTag[] | Array of TIFF tags. |

### Quality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/quality.md

#### NikonMakerNotePackage.Quality property

Gets the quality string.

```csharp
public string Quality { get; }
```

##### Property Value

The quality.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/sharpness.md

#### NikonMakerNotePackage.Sharpness property

Gets the sharpness.

```csharp
public string Sharpness { get; }
```

##### Property Value

The sharpness.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/whitebalance.md

#### NikonMakerNotePackage.WhiteBalance property

Gets the white balance.

```csharp
public string WhiteBalance { get; }
```

##### Property Value

The white balance.

### PanasonicMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage.md

#### PanasonicMakerNotePackage class

Represents PANASONIC MakerNote metadata.

```csharp
public class PanasonicMakerNotePackage : MakerNotePackage
```

#### Properties

| Name | Description |
| --- | --- |
| AccessorySerialNumber { get; } | Gets the accessory serial number. |
| AccessoryType { get; } | Gets the type of the accessory. |
| AFMode { get; } | Gets the AF mode. |
| Audio { get; } | Gets the audio mode. |
| Count { get; } | Gets the number of metadata properties. |
| FirmwareVersion { get; } | Gets the firmware version. |
| FocusMode { get; } | Gets the focus mode. |
| ImageQuality { get; } | Gets the image quality. |
| ImageStabilization { get; } | Gets the image stabilization mode. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| LensSerialNumber { get; } | Gets the lens serial number. |
| LensType { get; } | Gets the type of the lens. |
| MacroMode { get; } | Gets the macro mode. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ShootingMode { get; } | Gets the shooting mode. |
| WhiteBalance { get; } | Gets the white balance. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AccessorySerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/accessoryserialnumber.md

#### PanasonicMakerNotePackage.AccessorySerialNumber property

Gets the accessory serial number.

```csharp
public string AccessorySerialNumber { get; }
```

##### Property Value

The accessory serial number.

### AccessoryType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/accessorytype.md

#### PanasonicMakerNotePackage.AccessoryType property

Gets the type of the accessory.

```csharp
public string AccessoryType { get; }
```

##### Property Value

The type of the accessory.

### AFMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/afmode.md

#### PanasonicMakerNotePackage.AFMode property

Gets the AF mode.

```csharp
public byte[] AFMode { get; }
```

##### Property Value

The AF mode.

### Audio
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/audio.md

#### PanasonicMakerNotePackage.Audio property

Gets the audio mode.

```csharp
public ushort? Audio { get; }
```

##### Property Value

The audio mode.

### FirmwareVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/firmwareversion.md

#### PanasonicMakerNotePackage.FirmwareVersion property

Gets the firmware version.

```csharp
public byte[] FirmwareVersion { get; }
```

##### Property Value

The firmware version.

### FocusMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/focusmode.md

#### PanasonicMakerNotePackage.FocusMode property

Gets the focus mode.

```csharp
public ushort? FocusMode { get; }
```

##### Property Value

The focus mode.

### ImageQuality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/imagequality.md

#### PanasonicMakerNotePackage.ImageQuality property

Gets the image quality.

```csharp
public ushort? ImageQuality { get; }
```

##### Property Value

The image quality.

### ImageStabilization
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/imagestabilization.md

#### PanasonicMakerNotePackage.ImageStabilization property

Gets the image stabilization mode.

```csharp
public ushort? ImageStabilization { get; }
```

##### Property Value

The image stabilization mode.

### LensSerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/lensserialnumber.md

#### PanasonicMakerNotePackage.LensSerialNumber property

Gets the lens serial number.

```csharp
public string LensSerialNumber { get; }
```

##### Property Value

The lens serial number.

### LensType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/lenstype.md

#### PanasonicMakerNotePackage.LensType property

Gets the type of the lens.

```csharp
public string LensType { get; }
```

##### Property Value

The type of the lens.

### MacroMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/macromode.md

#### PanasonicMakerNotePackage.MacroMode property

Gets the macro mode.

```csharp
public ushort? MacroMode { get; }
```

##### Property Value

The macro mode.

### ShootingMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/shootingmode.md

#### PanasonicMakerNotePackage.ShootingMode property

Gets the shooting mode.

```csharp
public ushort? ShootingMode { get; }
```

##### Property Value

The shooting mode.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/whitebalance.md

#### PanasonicMakerNotePackage.WhiteBalance property

Gets the white balance.

```csharp
public ushort? WhiteBalance { get; }
```

##### Property Value

The white balance.

### SonyMakerNotePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage.md

#### SonyMakerNotePackage class

Represents SONY MakerNote metadata.

```csharp
public sealed class SonyMakerNotePackage : MakerNotePackage
```

#### Properties

| Name | Description |
| --- | --- |
| AFIlluminator { get; } | Gets the AF illuminator type. |
| Brightness { get; } | Gets the brightness. |
| ColorMode { get; } | Gets the color mode. |
| ColorTemperature { get; } | Gets the color temperature. |
| Contrast { get; } | Gets the contrast. |
| Count { get; } | Gets the number of metadata properties. |
| CreativeStyle { get; } | Gets the creative style. |
| ExposureMode { get; } | Gets the exposure mode. |
| FlashLevel { get; } | Gets the flash level. |
| FocusMode { get; } | Gets the focus mode. |
| Header { get; } | Gets the MakerNote header. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| JpegQuality { get; } | Gets the JPEG quality. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Macro { get; } | Gets the macro. |
| MetadataType { get; } | Gets the metadata type. |
| MultiBurstImageHeight { get; } | Gets the height of the multi burst image. |
| MultiBurstImageWidth { get; } | Gets the width of the multi burst image. |
| MultiBurstMode { get; } | Gets a value indicating whether the multi burst mode is on. |
| PictureEffect { get; } | Gets the picture effect. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Quality { get; } | Gets the image quality. |
| Rating { get; } | Gets the rating. |
| ReleaseMode { get; } | Gets the release mode. |
| Saturation { get; } | Gets the saturation. |
| Sharpness { get; } | Gets the sharpness. |
| SoftSkinEffect { get; } | Gets the soft skin effect. |
| SonyModelID { get; } | Gets the sony model identifier. |
| Teleconverter { get; } | Gets the teleconverter type. |
| WhiteBalance { get; } | Gets the white balance. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AFIlluminator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/afilluminator.md

#### SonyMakerNotePackage.AFIlluminator property

Gets the AF illuminator type.

```csharp
public ushort? AFIlluminator { get; }
```

##### Property Value

The AF illuminator type.

### Brightness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/brightness.md

#### SonyMakerNotePackage.Brightness property

Gets the brightness.

```csharp
public int? Brightness { get; }
```

##### Property Value

The brightness.

### ColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/colormode.md

#### SonyMakerNotePackage.ColorMode property

Gets the color mode.

```csharp
public uint? ColorMode { get; }
```

##### Property Value

The color mode.

### ColorTemperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/colortemperature.md

#### SonyMakerNotePackage.ColorTemperature property

Gets the color temperature.

```csharp
public uint? ColorTemperature { get; }
```

##### Property Value

The color temperature.

### Contrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/contrast.md

#### SonyMakerNotePackage.Contrast property

Gets the contrast.

```csharp
public int? Contrast { get; }
```

##### Property Value

The contrast.

### CreativeStyle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/creativestyle.md

#### SonyMakerNotePackage.CreativeStyle property

Gets the creative style.

```csharp
public string CreativeStyle { get; }
```

##### Property Value

The creative style.

### ExposureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/exposuremode.md

#### SonyMakerNotePackage.ExposureMode property

Gets the exposure mode.

```csharp
public ushort? ExposureMode { get; }
```

##### Property Value

The exposure mode.

### FlashLevel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/flashlevel.md

#### SonyMakerNotePackage.FlashLevel property

Gets the flash level.

```csharp
public short? FlashLevel { get; }
```

##### Property Value

The flash level.

### FocusMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/focusmode.md

#### SonyMakerNotePackage.FocusMode property

Gets the focus mode.

```csharp
public ushort? FocusMode { get; }
```

##### Property Value

The focus mode.

### Header
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/header.md

#### SonyMakerNotePackage.Header property

Gets the MakerNote header.

```csharp
public string Header { get; }
```

##### Property Value

The MakerNote header.

### JpegQuality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/jpegquality.md

#### SonyMakerNotePackage.JpegQuality property

Gets the JPEG quality.

```csharp
public ushort? JpegQuality { get; }
```

##### Property Value

The JPEG quality.

### Macro
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/macro.md

#### SonyMakerNotePackage.Macro property

Gets the macro.

```csharp
public ushort? Macro { get; }
```

##### Property Value

The macro.

### MultiBurstImageHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multiburstimageheight.md

#### SonyMakerNotePackage.MultiBurstImageHeight property

Gets the height of the multi burst image.

```csharp
public ushort? MultiBurstImageHeight { get; }
```

##### Property Value

The height of the multi burst image.

### MultiBurstImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multiburstimagewidth.md

#### SonyMakerNotePackage.MultiBurstImageWidth property

Gets the width of the multi burst image.

```csharp
public ushort? MultiBurstImageWidth { get; }
```

##### Property Value

The width of the multi burst image.

### MultiBurstMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multiburstmode.md

#### SonyMakerNotePackage.MultiBurstMode property

Gets a value indicating whether the multi burst mode is on.

```csharp
public bool MultiBurstMode { get; }
```

##### Property Value

`true` if the multi burst mode is on; otherwise, `false`.

### PictureEffect
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/pictureeffect.md

#### SonyMakerNotePackage.PictureEffect property

Gets the picture effect.

```csharp
public ushort? PictureEffect { get; }
```

##### Property Value

The picture effect.

### Quality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/quality.md

#### SonyMakerNotePackage.Quality property

Gets the image quality.

```csharp
public uint? Quality { get; }
```

##### Property Value

The image quality.

### Rating
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/rating.md

#### SonyMakerNotePackage.Rating property

Gets the rating.

```csharp
public uint? Rating { get; }
```

##### Property Value

The rating.

### ReleaseMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/releasemode.md

#### SonyMakerNotePackage.ReleaseMode property

Gets the release mode.

```csharp
public ushort? ReleaseMode { get; }
```

##### Property Value

The release mode.

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/saturation.md

#### SonyMakerNotePackage.Saturation property

Gets the saturation.

```csharp
public int? Saturation { get; }
```

##### Property Value

The saturation.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/sharpness.md

#### SonyMakerNotePackage.Sharpness property

Gets the sharpness.

```csharp
public int? Sharpness { get; }
```

##### Property Value

The sharpness.

### SoftSkinEffect
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/softskineffect.md

#### SonyMakerNotePackage.SoftSkinEffect property

Gets the soft skin effect.

```csharp
public uint? SoftSkinEffect { get; }
```

##### Property Value

The soft skin effect.

### SonyModelID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/sonymodelid.md

#### SonyMakerNotePackage.SonyModelID property

Gets the sony model identifier.

```csharp
public ushort? SonyModelID { get; }
```

##### Property Value

The sony model identifier.

### Teleconverter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/teleconverter.md

#### SonyMakerNotePackage.Teleconverter property

Gets the teleconverter type.

```csharp
public uint? Teleconverter { get; }
```

##### Property Value

The teleconverter type.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/whitebalance.md

#### SonyMakerNotePackage.WhiteBalance property

Gets the white balance.

```csharp
public uint? WhiteBalance { get; }
```

##### Property Value

The white balance.

### GroupDocs.Metadata.Standards.Exif
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif.md

The namespace contains functionality intended to read and write EXIF (exchangeable image file format) metadata.

#### Classes

| Class | Description |
| --- | --- |
| ExifDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| ExifGpsPackage | Represents GPS metadata in an EXIF metadata package. |
| ExifIfdPackage | Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information. |
| ExifPackage | Represents an EXIF metadata package (Exchangeable Image File Format). |
#### Interfaces

| Interface | Description |
| --- | --- |
| IExif | Defines base operations intended to work with EXIF metadata. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ExifGpsAltitudeRef | Represents a GPS altitude reference. |
| ExifOrientation | Exif image orientation. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ExifDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage.md

#### ExifDictionaryBasePackage class

Provides an abstract base class for EXIF metadata dictionaries.

```csharp
public abstract class ExifDictionaryBasePackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/clear.md

#### ExifDictionaryBasePackage.Clear method

Removes all TIFF tags stored in the package.

```csharp
public void Clear()
```

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/item.md

#### ExifDictionaryBasePackage indexer

Gets the TIFF tag with the specified id.

```csharp
public TiffTag this[TiffTagID tagId] { get; }
```

| Parameter | Description |
| --- | --- |
| tagId | The id of the tag to retrieve. |

##### Return Value

The `TiffTag` with the specified tag id.

##### Examples

This example demonstrates how to read a specific TIFF/EXIF tag by its identifier.

```csharp
using (Metadata metadata = new Metadata(Constants.TiffWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null && root.ExifPackage != null)
    {
        TiffAsciiTag software = (TiffAsciiTag)root.ExifPackage[TiffTagID.Software];
        if (software != null)
        {
            Console.WriteLine("Software: {0}", software.Value);
        }
    }
}
```

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/remove.md

#### ExifDictionaryBasePackage.Remove method

Removes the property with the specified id.

```csharp
public bool Remove(TiffTagID tagId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tagId | TiffTagID | A TIFF tag id. |

##### Return Value

True if the specified TIFF tag is found and removed; otherwise, false.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/set.md

#### ExifDictionaryBasePackage.Set method

Adds or replaces the specified tag.

```csharp
public void Set(TiffTag tag)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tag | TiffTag | The tag to set. |

##### Examples

This code sample demonstrates how to add a custom tag to an EXIF package.

```csharp
using (Metadata metadata = new Metadata(Constants.TiffWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null)
    {
        // Set the EXIF package if it's missing
        if (root.ExifPackage == null)
        {
            root.ExifPackage = new ExifPackage();
        }

        // Add a known property
        root.ExifPackage.Set(new TiffAsciiTag(TiffTagID.Artist, "test artist"));

        // Add a fully custom property (which is not described in the EXIF specification).
        // Please note that the chosen ID may intersect with the IDs used by some third party tools.
        root.ExifPackage.Set(new TiffAsciiTag((TiffTagID)65523, "custom"));

        metadata.Save(Constants.OutputTiff);
    }
}
```

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/tolist.md

#### ExifDictionaryBasePackage.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<TiffTag> ToList()
```

##### Return Value

A list that contains all TIFF tags from the package.

##### Examples

This example demonstrates how to read all EXIF tags extracted from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null && root.ExifPackage != null)
    {
        const string pattern = "{0} = {1}";

        foreach (TiffTag tag in root.ExifPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }

        foreach (TiffTag tag in root.ExifPackage.ExifIfdPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }

        foreach (TiffTag tag in root.ExifPackage.GpsPackage.ToList())
        {
            Console.WriteLine(pattern, tag.TagID, tag.Value);
        }
    }
}
```

### ExifGpsAltitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpsaltituderef.md

#### ExifGpsAltitudeRef enumeration

Represents a GPS altitude reference.

```csharp
public enum ExifGpsAltitudeRef
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AboveSeaLevel | `0` | Above sea level. |
| BelowSeaLevel | `1` | Below sea level. |

### ExifGpsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage.md

#### ExifGpsPackage class

Represents GPS metadata in an EXIF metadata package.

```csharp
public sealed class ExifGpsPackage : ExifDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| ExifGpsPackage() | Initializes a new instance of the `ExifGpsPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Altitude { get; set; } | Gets or sets the altitude based on the reference in `AltitudeRef`. The reference unit is meters. |
| AltitudeRef { get; set; } | Gets or sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the `Altitude` tag. |
| AreaInformation { get; set; } | Gets or sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area. |
| Count { get; } | Gets the number of metadata properties. |
| DataDegreeOfPrecision { get; set; } | Gets or sets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement. |
| DateStamp { get; set; } | Gets or sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD. |
| DestBearing { get; set; } | Gets or sets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99. |
| DestBearingRef { get; set; } | Gets or sets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction. |
| DestDistance { get; set; } | Gets or sets the GPS distance to the destination point. |
| DestDistanceRef { get; set; } | Gets or sets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots. |
| DestLatitude { get; set; } | Gets or sets the GPS latitude of the destination point. |
| DestLatitudeRef { get; set; } | Gets or sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude. |
| DestLongitude { get; set; } | Gets or sets the GPS longitude of the destination point. |
| DestLongitudeRef { get; set; } | Gets or sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude. |
| Differential { get; set; } | Gets or sets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| GpsTrack { get; set; } | Gets or sets the direction of GPS receiver movement. |
| ImgDirection { get; set; } | Gets or sets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99. |
| ImgDirectionRef { get; set; } | Gets or sets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| Latitude { get; set; } | Gets or sets the GPS latitude. |
| LatitudeRef { get; set; } | Gets or sets a GPS value indicating whether the latitude is north or south latitude. |
| Longitude { get; set; } | Gets or sets the GPS longitude. |
| LongitudeRef { get; set; } | Gets or sets a GPS value indicating whether the longitude is east or west longitude. |
| MapDatum { get; set; } | Gets or sets the geodetic survey data used by the GPS receiver. |
| MeasureMode { get; set; } | Gets or sets the GPS measurement mode. |
| MetadataType { get; } | Gets the metadata type. |
| ProcessingMethod { get; set; } | Gets or sets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Satellites { get; set; } | Gets or sets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL. |
| Speed { get; set; } | Gets or sets the speed of GPS receiver movement. |
| SpeedRef { get; set; } | Gets or sets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots. |
| Status { get; set; } | Gets or sets the status of the GPS receiver when the image is recorded. |
| TimeStamp { get; set; } | Gets or sets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second. |
| TrackRef { get; set; } | Gets or sets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction. |
| VersionID { get; set; } | Gets or sets the version of GPS IFD. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Altitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/altitude.md

#### ExifGpsPackage.Altitude property

Gets or sets the altitude based on the reference in `AltitudeRef`. The reference unit is meters.

```csharp
public TiffRational Altitude { get; set; }
```

##### Property Value

The altitude based on the reference in `AltitudeRef`.

### AltitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/altituderef.md

#### ExifGpsPackage.AltitudeRef property

Gets or sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the `Altitude` tag.

```csharp
public ExifGpsAltitudeRef? AltitudeRef { get; set; }
```

##### Property Value

The altitude used as the reference altitude

### AreaInformation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/areainformation.md

#### ExifGpsPackage.AreaInformation property

Gets or sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.

```csharp
public byte[] AreaInformation { get; set; }
```

##### Property Value

The character string recording the name of the GPS area.

### DataDegreeOfPrecision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/datadegreeofprecision.md

#### ExifGpsPackage.DataDegreeOfPrecision property

Gets or sets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.

```csharp
public TiffRational DataDegreeOfPrecision { get; set; }
```

##### Property Value

The data degree of precision.

### DateStamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/datestamp.md

#### ExifGpsPackage.DateStamp property

Gets or sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

```csharp
public string DateStamp { get; set; }
```

##### Property Value

The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

### DestBearing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destbearing.md

#### ExifGpsPackage.DestBearing property

Gets or sets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.

```csharp
public TiffRational DestBearing { get; set; }
```

##### Property Value

The bearing to the destination point.

### DestBearingRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destbearingref.md

#### ExifGpsPackage.DestBearingRef property

Gets or sets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction.

```csharp
public string DestBearingRef { get; set; }
```

##### Property Value

The GPS reference used for giving the bearing to the destination point.

### DestDistance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destdistance.md

#### ExifGpsPackage.DestDistance property

Gets or sets the GPS distance to the destination point.

```csharp
public TiffRational DestDistance { get; set; }
```

##### Property Value

The distance to the destination point.

### DestDistanceRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destdistanceref.md

#### ExifGpsPackage.DestDistanceRef property

Gets or sets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots.

```csharp
public string DestDistanceRef { get; set; }
```

##### Property Value

The GPS unit used to express the distance to the destination point.

### DestLatitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destlatitude.md

#### ExifGpsPackage.DestLatitude property

Gets or sets the GPS latitude of the destination point.

```csharp
public TiffRational[] DestLatitude { get; set; }
```

##### Property Value

The latitude of the destination point.

### DestLatitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destlatituderef.md

#### ExifGpsPackage.DestLatitudeRef property

Gets or sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude.

```csharp
public string DestLatitudeRef { get; set; }
```

##### Property Value

The GPS value which indicates whether the latitude of the destination point is north or south latitude.

### DestLongitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destlongitude.md

#### ExifGpsPackage.DestLongitude property

Gets or sets the GPS longitude of the destination point.

```csharp
public TiffRational[] DestLongitude { get; set; }
```

##### Property Value

The GPS longitude of the destination point.

### DestLongitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/destlongituderef.md

#### ExifGpsPackage.DestLongitudeRef property

Gets or sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude.

```csharp
public string DestLongitudeRef { get; set; }
```

##### Property Value

The GPS value which indicates whether the longitude of the destination point is east or west longitude.

### Differential
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/differential.md

#### ExifGpsPackage.Differential property

Gets or sets a GPS value which indicates whether differential correction is applied to the GPS receiver.

```csharp
public int? Differential { get; set; }
```

##### Property Value

A GPS value which indicates whether differential correction is applied to the GPS receiver.

### ExifGpsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/exifgpspackage.md

#### ExifGpsPackage constructor

Initializes a new instance of the `ExifGpsPackage` class.

```csharp
public ExifGpsPackage()
```

### GpsTrack
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/gpstrack.md

#### ExifGpsPackage.GpsTrack property

Gets or sets the direction of GPS receiver movement.

```csharp
public TiffRational GpsTrack { get; set; }
```

##### Property Value

The direction of GPS receiver movement.

### ImgDirection
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/imgdirection.md

#### ExifGpsPackage.ImgDirection property

Gets or sets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.

```csharp
public TiffRational ImgDirection { get; set; }
```

##### Property Value

The GPS direction of the image when it was captured.

### ImgDirectionRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/imgdirectionref.md

#### ExifGpsPackage.ImgDirectionRef property

Gets or sets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction.

```csharp
public string ImgDirectionRef { get; set; }
```

##### Property Value

The GPS reference for giving the direction of the image when it is captured.

### Latitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/latitude.md

#### ExifGpsPackage.Latitude property

Gets or sets the GPS latitude.

```csharp
public TiffRational[] Latitude { get; set; }
```

##### Property Value

The latitude.

### LatitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/latituderef.md

#### ExifGpsPackage.LatitudeRef property

Gets or sets a GPS value indicating whether the latitude is north or south latitude.

```csharp
public string LatitudeRef { get; set; }
```

##### Property Value

A GPS value indicating whether the latitude is north or south latitude.

### Longitude
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/longitude.md

#### ExifGpsPackage.Longitude property

Gets or sets the GPS longitude.

```csharp
public TiffRational[] Longitude { get; set; }
```

##### Property Value

The longitude.

### LongitudeRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/longituderef.md

#### ExifGpsPackage.LongitudeRef property

Gets or sets a GPS value indicating whether the longitude is east or west longitude.

```csharp
public string LongitudeRef { get; set; }
```

##### Property Value

A GPS value indicating whether the longitude is east or west longitude.

### MapDatum
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/mapdatum.md

#### ExifGpsPackage.MapDatum property

Gets or sets the geodetic survey data used by the GPS receiver.

```csharp
public string MapDatum { get; set; }
```

##### Property Value

The geodetic survey data used by the GPS receiver.

### MeasureMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/measuremode.md

#### ExifGpsPackage.MeasureMode property

Gets or sets the GPS measurement mode.

```csharp
public string MeasureMode { get; set; }
```

##### Property Value

The measure mode.

### ProcessingMethod
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/processingmethod.md

#### ExifGpsPackage.ProcessingMethod property

Gets or sets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.

```csharp
public byte[] ProcessingMethod { get; set; }
```

##### Property Value

A character string recording the name of the method used for location finding.

### Satellites
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/satellites.md

#### ExifGpsPackage.Satellites property

Gets or sets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.

```csharp
public string Satellites { get; set; }
```

##### Property Value

The GPS satellites used for measurements.

### Speed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/speed.md

#### ExifGpsPackage.Speed property

Gets or sets the speed of GPS receiver movement.

```csharp
public TiffRational Speed { get; set; }
```

##### Property Value

The speed of GPS receiver movement.

### SpeedRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/speedref.md

#### ExifGpsPackage.SpeedRef property

Gets or sets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.

```csharp
public string SpeedRef { get; set; }
```

##### Property Value

The unit used to express the GPS receiver speed of movement.

### Status
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/status.md

#### ExifGpsPackage.Status property

Gets or sets the status of the GPS receiver when the image is recorded.

```csharp
public string Status { get; set; }
```

##### Property Value

The status of the GPS receiver when the image is recorded.

### TimeStamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/timestamp.md

#### ExifGpsPackage.TimeStamp property

Gets or sets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.

```csharp
public TiffRational[] TimeStamp { get; set; }
```

##### Property Value

The time as UTC (Coordinated Universal Time).

### TrackRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/trackref.md

#### ExifGpsPackage.TrackRef property

Gets or sets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction.

```csharp
public string TrackRef { get; set; }
```

##### Property Value

The reference for giving the direction of GPS receiver movement.

### VersionID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifgpspackage/versionid.md

#### ExifGpsPackage.VersionID property

Gets or sets the version of GPS IFD.

```csharp
public byte[] VersionID { get; set; }
```

##### Property Value

The version of GPS IFD

### ExifIfdPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exififdpackage.md

#### ExifIfdPackage class

Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information.

```csharp
public sealed class ExifIfdPackage : ExifDictionaryBasePackage
```

#### Properties

| Name | Description |
| --- | --- |
| BodySerialNumber { get; set; } | Gets or sets the camera body serial number. |
| CameraOwnerName { get; set; } | Gets or sets the camera owner's name. |
| CfaPattern { get; set; } | Gets or sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| UserComment { get; set; } | Gets or sets the user comment. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### BodySerialNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exififdpackage/bodyserialnumber.md

#### ExifIfdPackage.BodySerialNumber property

Gets or sets the camera body serial number.

```csharp
public string BodySerialNumber { get; set; }
```

##### Property Value

The camera body serial number.

### CameraOwnerName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exififdpackage/cameraownername.md

#### ExifIfdPackage.CameraOwnerName property

Gets or sets the camera owner's name.

```csharp
public string CameraOwnerName { get; set; }
```

##### Property Value

The name of the camera owner.

### CfaPattern
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exififdpackage/cfapattern.md

#### ExifIfdPackage.CfaPattern property

Gets or sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

```csharp
public byte[] CfaPattern { get; set; }
```

##### Property Value

The color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

### UserComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exififdpackage/usercomment.md

#### ExifIfdPackage.UserComment property

Gets or sets the user comment.

```csharp
public string UserComment { get; set; }
```

##### Property Value

The user comment.

### ExifOrientation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exiforientation.md

#### ExifOrientation enumeration

Exif image orientation.

```csharp
public enum ExifOrientation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| TopLeft | `1` | Top left. Default orientation. |
| TopRight | `2` | Top right. Horizontally reversed. |
| BottomRight | `3` | Bottom right. Rotated by 180 degrees. |
| BottomLeft | `4` | Bottom left. Rotated by 180 degrees and then horizontally reversed. |
| LeftTop | `5` | Left top. Rotated by 90 degrees counterclockwise and then horizontally reversed. |
| RightTop | `6` | Right top. Rotated by 90 degrees clockwise. |
| RightBottom | `7` | Right bottom. Rotated by 90 degrees clockwise and then horizontally reversed. |
| LeftBottom | `8` | Left bottom. Rotated by 90 degrees counterclockwise. |

### ExifPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage.md

#### ExifPackage class

Represents an EXIF metadata package (Exchangeable Image File Format).

```csharp
public class ExifPackage : ExifDictionaryBasePackage
```

#### Constructors

| Name | Description |
| --- | --- |
| ExifPackage() | Initializes a new instance of the `ExifPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Artist { get; set; } | Gets or sets the name of the camera owner, photographer or image creator. |
| Copyright { get; set; } | Gets or sets the copyright notice. |
| Count { get; } | Gets the number of metadata properties. |
| DateTime { get; set; } | Gets or sets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed. |
| ExifIfdPackage { get; } | Gets the EXIF IFD data. |
| GpsPackage { get; } | Gets the GPS data. |
| ImageDescription { get; set; } | Gets or sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like. |
| ImageLength { get; set; } | Gets or sets the number of rows of image data. |
| ImageWidth { get; set; } | Gets or sets the number of columns of image data, equal to the number of pixels per row. |
| Item { get; } | Gets the TIFF tag with the specified id. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| Make { get; set; } | Gets or sets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image. |
| MetadataType { get; } | Gets the metadata type. |
| Model { get; set; } | Gets or sets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image. |
| Orientation { get; set; } | Gets or sets the orientation. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Software { get; set; } | Gets or sets the name and version of the software or firmware of the camera or image input device used to generate the image. |
| Thumbnail { get; } | Gets the image thumbnail represented as an array of bytes. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all TIFF tags stored in the package. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(TiffTagID) | Removes the property with the specified id. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(TiffTag) | Adds or replaces the specified tag. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample demonstrates how to update common EXIF properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputJpeg))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null)
    {
        // Set the EXIF package if it's missing
        if (root.ExifPackage == null)
        {
            root.ExifPackage = new ExifPackage();
        }

        root.ExifPackage.Copyright = "Copyright (C) 2011-2026 GroupDocs. All Rights Reserved.";
        root.ExifPackage.ImageDescription = "test image";
        root.ExifPackage.Software = "GroupDocs.Metadata";

        // ...

        root.ExifPackage.ExifIfdPackage.BodySerialNumber = "test";
        root.ExifPackage.ExifIfdPackage.CameraOwnerName = "GroupDocs";
        root.ExifPackage.ExifIfdPackage.UserComment = "test comment";

        // ...

        metadata.Save(Constants.OutputJpeg);
    }
}
```

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/artist.md

#### ExifPackage.Artist property

Gets or sets the name of the camera owner, photographer or image creator.

```csharp
public string Artist { get; set; }
```

##### Property Value

The name of the camera owner, photographer or image creator.

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/copyright.md

#### ExifPackage.Copyright property

Gets or sets the copyright notice.

```csharp
public string Copyright { get; set; }
```

##### Property Value

The copyright notice.

### DateTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/datetime.md

#### ExifPackage.DateTime property

Gets or sets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed.

```csharp
public string DateTime { get; set; }
```

##### Property Value

The date and time of image creation.

### ExifIfdPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/exififdpackage.md

#### ExifPackage.ExifIfdPackage property

Gets the EXIF IFD data.

```csharp
public ExifIfdPackage ExifIfdPackage { get; }
```

##### Property Value

The EXIF IFD data.

### ExifPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/exifpackage.md

#### ExifPackage constructor

Initializes a new instance of the `ExifPackage` class.

```csharp
public ExifPackage()
```

### GpsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/gpspackage.md

#### ExifPackage.GpsPackage property

Gets the GPS data.

```csharp
public ExifGpsPackage GpsPackage { get; }
```

##### Property Value

The GPS data.

### ImageDescription
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/imagedescription.md

#### ExifPackage.ImageDescription property

Gets or sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

```csharp
public string ImageDescription { get; set; }
```

##### Property Value

The image description.

### ImageLength
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/imagelength.md

#### ExifPackage.ImageLength property

Gets or sets the number of rows of image data.

```csharp
public int ImageLength { get; set; }
```

##### Property Value

The number of rows of image data.

### ImageWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/imagewidth.md

#### ExifPackage.ImageWidth property

Gets or sets the number of columns of image data, equal to the number of pixels per row.

```csharp
public int ImageWidth { get; set; }
```

##### Property Value

The number of columns of image data, equal to the number of pixels per row.

### Make
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/make.md

#### ExifPackage.Make property

Gets or sets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.

```csharp
public string Make { get; set; }
```

##### Property Value

The manufacturer of the recording equipment.

### Model
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/model.md

#### ExifPackage.Model property

Gets or sets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.

```csharp
public string Model { get; set; }
```

##### Property Value

The model name or model number of the equipment.

### Orientation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/orientation.md

#### ExifPackage.Orientation property

Gets or sets the orientation.

```csharp
public ExifOrientation Orientation { get; set; }
```

##### Property Value

The orientation.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/software.md

#### ExifPackage.Software property

Gets or sets the name and version of the software or firmware of the camera or image input device used to generate the image.

```csharp
public string Software { get; set; }
```

##### Property Value

The name and version of the software or firmware of the camera or image input device used to generate the image.

### Thumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/exifpackage/thumbnail.md

#### ExifPackage.Thumbnail property

Gets the image thumbnail represented as an array of bytes.

```csharp
public byte[] Thumbnail { get; }
```

##### Property Value

The image thumbnail represented as an array of bytes.

##### Remarks

This feature is not available in trial mode.

### IExif
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/iexif.md

#### IExif interface

Defines base operations intended to work with EXIF metadata.

```csharp
public interface IExif
```

#### Properties

| Name | Description |
| --- | --- |
| ExifPackage { get; set; } | Gets or sets the EXIF metadata package associated with the file. |

##### Examples

This code sample demonstrates how to extract basic EXIF metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.TiffWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null && root.ExifPackage != null)
    {
        Console.WriteLine(root.ExifPackage.Artist);
        Console.WriteLine(root.ExifPackage.Copyright);
        Console.WriteLine(root.ExifPackage.ImageDescription);
        Console.WriteLine(root.ExifPackage.Make);
        Console.WriteLine(root.ExifPackage.Model);
        Console.WriteLine(root.ExifPackage.Software);
        Console.WriteLine(root.ExifPackage.ImageWidth);
        Console.WriteLine(root.ExifPackage.ImageLength);

        // ...

        Console.WriteLine(root.ExifPackage.ExifIfdPackage.BodySerialNumber);
        Console.WriteLine(root.ExifPackage.ExifIfdPackage.CameraOwnerName);
        Console.WriteLine(root.ExifPackage.ExifIfdPackage.UserComment);

        // ...

        Console.WriteLine(root.ExifPackage.GpsPackage.Altitude);
        Console.WriteLine(root.ExifPackage.GpsPackage.LatitudeRef);
        Console.WriteLine(root.ExifPackage.GpsPackage.LongitudeRef);

        // ...
    }
}
```

### ExifPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.exif/iexif/exifpackage.md

#### IExif.ExifPackage property

Gets or sets the EXIF metadata package associated with the file.

```csharp
public ExifPackage ExifPackage { get; set; }
```

##### Property Value

The EXIF metadata package associated with the file.

##### Examples

This code sample shows how to remove EXIF metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithExif))
{
    IExif root = metadata.GetRootPackage() as IExif;
    if (root != null)
    {
        root.ExifPackage = null;

        metadata.Save(Constants.OutputJpeg);
     }
}
```

### GroupDocs.Metadata.Standards.Iptc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc.md

The namespace contains classes allowing users to work with IPTC metadata.

#### Classes

| Class | Description |
| --- | --- |
| IptcApplicationRecord | Represents an IPTC Application Record. |
| IptcDataSet | Represents an IPTC DataSet (metadata property). |
| IptcEnvelopeRecord | Represents an IPTC Envelope Record. |
| IptcRecord | Represents an IPTC record. |
| IptcRecordSet | Represents a collection of IPTC records. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IIptc | Represents base operations intended to work with IPTC metadata. Please find more information at [http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council](http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council). |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| IptcApplicationRecordDataSet | Defines IPTC Application Record dataSet numbers. |
| IptcEnvelopeRecordDataSet | Defines IPTC Envelope Record dataSet numbers. |
| IptcRecordType | Defines IPTC record types. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### IIptc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iiptc.md

#### IIptc interface

Represents base operations intended to work with IPTC metadata. Please find more information at [http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council](http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council).

```csharp
public interface IIptc
```

#### Properties

| Name | Description |
| --- | --- |
| IptcPackage { get; set; } | Gets or sets the IPTC metadata package associated with the file. |

##### Examples

This example shows how to read basic IPTC metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithIptc))
{
    IIptc root = metadata.GetRootPackage() as IIptc;
    if (root != null && root.IptcPackage != null)
    {
        if (root.IptcPackage.EnvelopeRecord != null)
        {
            Console.WriteLine(root.IptcPackage.EnvelopeRecord.DateSent);
            Console.WriteLine(root.IptcPackage.EnvelopeRecord.Destination);
            Console.WriteLine(root.IptcPackage.EnvelopeRecord.FileFormat);
            Console.WriteLine(root.IptcPackage.EnvelopeRecord.FileFormatVersion);

            // ...
        }

        if (root.IptcPackage.ApplicationRecord != null)
        {
            Console.WriteLine(root.IptcPackage.ApplicationRecord.Headline);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.ByLine);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.ByLineTitle);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.CaptionAbstract);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.City);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.DateCreated);
            Console.WriteLine(root.IptcPackage.ApplicationRecord.ReleaseDate);

            // ...
        }
    }
}
```

### IptcPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iiptc/iptcpackage.md

#### IIptc.IptcPackage property

Gets or sets the IPTC metadata package associated with the file.

```csharp
public IptcRecordSet IptcPackage { get; set; }
```

##### Property Value

The IPTC metadata package associated with the file.

##### Examples

This code sample shows how to remove IPTC metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithIptc))
{
    IIptc root = metadata.GetRootPackage() as IIptc;
    if (root != null)
    {
        root.IptcPackage = null;

        metadata.Save(Constants.OutputJpeg);
    }
}
```

### IptcApplicationRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord.md

#### IptcApplicationRecord class

Represents an IPTC Application Record.

```csharp
public sealed class IptcApplicationRecord : IptcRecord
```

#### Constructors

| Name | Description |
| --- | --- |
| IptcApplicationRecord() | Initializes a new instance of the `IptcApplicationRecord` class. |

#### Properties

| Name | Description |
| --- | --- |
| AllKeywords { get; set; } | Gets or sets the keywords. |
| ByLine { get; set; } | Gets or sets the name of the creator of the object, e.g. writer, photographer or graphic artist. |
| ByLines { get; set; } | Gets or sets the names of the creators of the object, e.g. writer, photographer or graphic artist. |
| ByLineTitle { get; set; } | Gets or sets the title of the creator or creators of the object. |
| ByLineTitles { get; set; } | Gets or sets the titles of the creator or creators of the object. |
| CaptionAbstract { get; set; } | Gets or sets a textual description of the object, particularly used where the object is not text. |
| City { get; set; } | Gets or sets the city. |
| Contact { get; set; } | Gets or sets information about the person or organisation which can provide further background information on the object. |
| Contacts { get; set; } | Gets or sets information about the person or organisation which can provide further background information on the object. |
| ContentLocationCode { get; set; } | Gets or sets the content location code. |
| ContentLocationCodes { get; set; } | Gets or sets the content location codes. |
| ContentLocationName { get; set; } | Gets or sets the content location name. |
| ContentLocationNames { get; set; } | Gets or sets the content location names. |
| CopyrightNotice { get; set; } | Gets or sets the copyright notice. |
| Count { get; } | Gets the number of metadata properties. |
| Credit { get; set; } | Gets or sets information about the provider of the object, not necessarily the owner/creator. |
| DateCreated { get; set; } | Gets or sets the date the intellectual content of the object was created. |
| Headline { get; set; } | Gets or sets a publishable entry providing a synopsis of the contents of the object. |
| Item { get; } | Gets the `IptcDataSet` with the specified number. (3 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| MetadataType { get; } | Gets the metadata type. |
| ProgramVersion { get; set; } | Gets or sets the program version. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RecordNumber { get; } | Gets the record number. |
| ReferenceDate { get; set; } | Gets or sets the date of a prior envelope to which the current object refers. |
| ReferenceDates { get; } | Gets the dates of a prior envelope to which the current object refers. |
| ReleaseDate { get; set; } | Gets or sets the release date. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AllKeywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/allkeywords.md

#### IptcApplicationRecord.AllKeywords property

Gets or sets the keywords.

```csharp
public string[] AllKeywords { get; set; }
```

##### Property Value

The keywords.

### ByLine
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/byline.md

#### IptcApplicationRecord.ByLine property

Gets or sets the name of the creator of the object, e.g. writer, photographer or graphic artist.

```csharp
public string ByLine { get; set; }
```

##### Property Value

The name of the creator of the object, e.g. writer, photographer or graphic artist.

### ByLines
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/bylines.md

#### IptcApplicationRecord.ByLines property

Gets or sets the names of the creators of the object, e.g. writer, photographer or graphic artist.

```csharp
public string[] ByLines { get; set; }
```

##### Property Value

The names of the creators of the object, e.g. writer, photographer or graphic artist.

### ByLineTitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/bylinetitle.md

#### IptcApplicationRecord.ByLineTitle property

Gets or sets the title of the creator or creators of the object.

```csharp
public string ByLineTitle { get; set; }
```

##### Property Value

The title of the creator or creators of the object.

### ByLineTitles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/bylinetitles.md

#### IptcApplicationRecord.ByLineTitles property

Gets or sets the titles of the creator or creators of the object.

```csharp
public string[] ByLineTitles { get; set; }
```

##### Property Value

The titles of the creator or creators of the object.

### CaptionAbstract
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/captionabstract.md

#### IptcApplicationRecord.CaptionAbstract property

Gets or sets a textual description of the object, particularly used where the object is not text.

```csharp
public string CaptionAbstract { get; set; }
```

##### Property Value

TheA textual description of the object, particularly used where the object is not text.

### City
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/city.md

#### IptcApplicationRecord.City property

Gets or sets the city.

```csharp
public string City { get; set; }
```

##### Property Value

The city.

### Contact
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contact.md

#### IptcApplicationRecord.Contact property

Gets or sets information about the person or organisation which can provide further background information on the object.

```csharp
public string Contact { get; set; }
```

##### Property Value

The information about the person or organisation which can provide further background information on the object.

### Contacts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contacts.md

#### IptcApplicationRecord.Contacts property

Gets or sets information about the person or organisation which can provide further background information on the object.

```csharp
public string[] Contacts { get; set; }
```

##### Property Value

The information about the person or organisation which can provide further background information on the object.

### ContentLocationCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contentlocationcode.md

#### IptcApplicationRecord.ContentLocationCode property

Gets or sets the content location code.

```csharp
public string ContentLocationCode { get; set; }
```

##### Property Value

The content location code.

### ContentLocationCodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contentlocationcodes.md

#### IptcApplicationRecord.ContentLocationCodes property

Gets or sets the content location codes.

```csharp
public string[] ContentLocationCodes { get; set; }
```

##### Property Value

The content location codes.

### ContentLocationName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contentlocationname.md

#### IptcApplicationRecord.ContentLocationName property

Gets or sets the content location name.

```csharp
public string ContentLocationName { get; set; }
```

##### Property Value

The name of the content location.

### ContentLocationNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contentlocationnames.md

#### IptcApplicationRecord.ContentLocationNames property

Gets or sets the content location names.

```csharp
public string[] ContentLocationNames { get; set; }
```

##### Property Value

The name of the content locations.

### CopyrightNotice
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/copyrightnotice.md

#### IptcApplicationRecord.CopyrightNotice property

Gets or sets the copyright notice.

```csharp
public string CopyrightNotice { get; set; }
```

##### Property Value

The copyright notice.

### Credit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/credit.md

#### IptcApplicationRecord.Credit property

Gets or sets information about the provider of the object, not necessarily the owner/creator.

```csharp
public string Credit { get; set; }
```

##### Property Value

The information about the provider of the object, not necessarily the owner/creator.

### DateCreated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/datecreated.md

#### IptcApplicationRecord.DateCreated property

Gets or sets the date the intellectual content of the object was created.

```csharp
public DateTime? DateCreated { get; set; }
```

##### Property Value

The date the intellectual content of the object was created.

### Headline
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/headline.md

#### IptcApplicationRecord.Headline property

Gets or sets a publishable entry providing a synopsis of the contents of the object.

```csharp
public string Headline { get; set; }
```

##### Property Value

A publishable entry providing a synopsis of the contents of the object.

### IptcApplicationRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/iptcapplicationrecord.md

#### IptcApplicationRecord constructor

Initializes a new instance of the `IptcApplicationRecord` class.

```csharp
public IptcApplicationRecord()
```

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/item.md

#### IptcApplicationRecord indexer

Gets the `IptcDataSet` with the specified number.

```csharp
public IptcDataSet this[IptcApplicationRecordDataSet dataSetNumber] { get; }
```

| Parameter | Description |
| --- | --- |
| dataSetNumber | The dataSet number. |

##### Return Value

The `IptcDataSet` with the specified number.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/keywords.md

#### IptcApplicationRecord.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### ProgramVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/programversion.md

#### IptcApplicationRecord.ProgramVersion property

Gets or sets the program version.

```csharp
public string ProgramVersion { get; set; }
```

##### Property Value

The program version.

### ReferenceDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/referencedate.md

#### IptcApplicationRecord.ReferenceDate property

Gets or sets the date of a prior envelope to which the current object refers.

```csharp
public DateTime? ReferenceDate { get; set; }
```

##### Property Value

The date of a prior envelope to which the current object refers.

### ReferenceDates
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/referencedates.md

#### IptcApplicationRecord.ReferenceDates property

Gets the dates of a prior envelope to which the current object refers.

```csharp
public DateTime[] ReferenceDates { get; }
```

##### Property Value

The dates of a prior envelope to which the current object refers.

### ReleaseDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/releasedate.md

#### IptcApplicationRecord.ReleaseDate property

Gets or sets the release date.

```csharp
public DateTime? ReleaseDate { get; set; }
```

##### Property Value

The release date.

### IptcApplicationRecordDataSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcapplicationrecorddataset.md

#### IptcApplicationRecordDataSet enumeration

Defines IPTC Application Record dataSet numbers.

```csharp
public enum IptcApplicationRecordDataSet
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| RecordVersion | `0` | Represents the record version. Binary. Always 2 in JPEGs. |
| ObjectTypeReference | `3` | Object type reference. Used pattern: "/\d{2}:[\w\s]{0,64}?/". |
| ObjectAttributeReference | `4` | The object attribute reference. |
| ObjectName | `5` | Used as a shorthand reference for the object. |
| EditStatus | `7` | Status of the objectdata, according to the practice of the provider. |
| EditorialUpdate | `8` | Indicates the type of update that this object provides to a previous object. |
| Urgency | `10` | Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority). |
| SubjectReference | `12` | The subject reference. |
| Category | `15` | Identifies the subject of the objectdata in the opinion of the provider. |
| SupplementalCategory | `20` | Supplemental categories further refine the subject of an objectdata.  Only a single supplemental category may be contained in each DataSet. A supplemental category may include any of the recognised categories as used in 2:15. |
| FixtureIdentifier | `22` | The fixture identifier. |
| Keywords | `25` | Used to indicate specific information retrieval words. Each keyword uses a single Keywords DataSet. Multiple keywords use multiple Keywords DataSets. |
| ContentLocationCode | `26` | Indicates the code of a country/geographical location referenced by the content of the object. |
| ContentLocationName | `27` | Provides a full, publishable name of a country/geographical location referenced by the content of the object,  according to guidelines of the provider. |
| ReleaseDate | `30` | Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard. |
| ReleaseTime | `35` | Designates in the form HHMMSS±HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard. |
| ExpirationDate | `37` | Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Follows ISO 8601 standard. |
| SpecialInstructions | `40` | Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. |
| ActionAdvised | `42` | Indicates the type of action that this object provides to a previous object. |
| ReferenceService | `45` | Identifies the Service Identifier of a prior envelope to which the current object refers. |
| ReferenceDate | `47` | Identifies the date of a prior envelope to which the current object refers. |
| ReferenceNumber | `50` | Identifies the Envelope Number of a prior envelope to which the current object refers. |
| DateCreated | `55` | Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. |
| TimeCreated | `60` | Represented in the form HHMMSS±HHMM to designate the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation. |
| DigitalCreationDate | `62` | Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. |
| DigitalCreationTime | `63` | Represented in the form HHMMSS±HHMM to designate the time the digital representation of the objectdata was created. |
| OriginatingProgram | `65` | Identifies the type of program used to originate the objectdata. |
| ProgramVersion | `70` | Used to identify the version of the program mentioned in 2:65. DataSet 2:70 is invalid if 2:65 is not present. |
| ObjectCycle | `75` | Consisting of an alphabetic character. Where: 'a' = morning, 'p' = evening, 'b' = both. |
| Byline | `80` | Contains name of the creator of the objectdata, e.g. writer, photographer or graphic artist. |
| BylineTitle | `85` | A by-line title is the title of the creator or creators of an object data. |
| City | `90` | Identifies city of objectdata origin according to guidelines established by the provider. |
| SubLocation | `92` | Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. |
| ProvinceState | `95` | Identifies Province/State of origin according to guidelines established by the provider. |
| PrimaryLocationCode | `100` | Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. a photo was taken, an event occurred. |
| PrimaryLocationName | `101` | Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider. |
| OriginalTransmissionReference | `103` | A code representing the location of original transmission according to practices of the provider. |
| Headline | `105` | A publishable entry providing a synopsis of the contents of the objectdata. |
| Credit | `110` | Identifies the provider of the objectdata, not necessarily the owner/creator. |
| Source | `115` | The name of a person or party who has a role in the content supply chain. This could be an agency, a member of an agency, an individual or a combination. |
| CopyrightNotice | `116` | Contains any necessary copyright notice. |
| Contact | `118` | Identifies the person or organization which can provide further background information on the object data. |
| CaptionAbstract | `120` | A textual description of the objectdata, particularly used where the object is not text. |
| WriterEditor | `122` | Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract. |
| RasterizedCaption | `125` | Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right. |
| ImageType | `130` | The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes. |
| ImageOrientation | `131` | Indicates the layout of the image area. |
| LanguageIdentifier | `135` | Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. |
| AudioType | `150` | The audio type. |
| AudioSamplingRate | `151` | Sampling rate numeric characters, representing the sampling rate in hertz (Hz). |
| AudioSamplingResolution | `152` | The number of bits in each audio sample. |
| AudioDuration | `153` | Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. |
| AudioOutcue | `154` | Identifies the content of the end of an audio objectdata, according to guidelines established by the provider. |
| ObjDataPreviewFileFormat | `200` | A binary number representing the file format of the ObjectData Preview. |
| ObjDataPreviewFileFormatVer | `201` | A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200. |
| ObjDataPreviewData | `202` | The object data preview. |

### IptcDataSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcdataset.md

#### IptcDataSet class

Represents an IPTC DataSet (metadata property).

```csharp
public sealed class IptcDataSet : MetadataProperty
```

#### Constructors

| Name | Description |
| --- | --- |
| IptcDataSet(byte, byte, byte[]) | Initializes a new instance of the `IptcDataSet` class. |
| IptcDataSet(byte, byte, DateTime) | Initializes a new instance of the `IptcDataSet` class. |
| IptcDataSet(byte, byte, int) | Initializes a new instance of the `IptcDataSet` class. |
| IptcDataSet(byte, byte, string) | Initializes a new instance of the `IptcDataSet` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeName { get; } | Gets the alternative name of the dataSet. |
| DataSetNumber { get; } | Gets the dataSet number. |
| Descriptor { get; } | Gets the descriptor associated with the metadata property. |
| InterpretedValue { get; } | Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc. |
| Name { get; } | Gets the property name. |
| RecordNumber { get; } | Gets the record number. |
| Tags { get; } | Gets a collection of tags associated with the property. |
| Value { get; } | Gets the property value. |

### AlternativeName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcdataset/alternativename.md

#### IptcDataSet.AlternativeName property

Gets the alternative name of the dataSet.

```csharp
public string AlternativeName { get; }
```

##### Property Value

The alternative name of the dataSet.

### DataSetNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcdataset/datasetnumber.md

#### IptcDataSet.DataSetNumber property

Gets the dataSet number.

```csharp
public byte DataSetNumber { get; }
```

##### Property Value

The dataSet number.

### IptcDataSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcdataset/iptcdataset.md

#### IptcDataSet(byte, byte, byte[])

Initializes a new instance of the `IptcDataSet` class.

```csharp
public IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |
| dataSetNumber | Byte | The dataSet number. |
| value | Byte[] | A byte array value. |

#### IptcDataSet(byte, byte, string)

Initializes a new instance of the `IptcDataSet` class.

```csharp
public IptcDataSet(byte recordNumber, byte dataSetNumber, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |
| dataSetNumber | Byte | The dataSet number. |
| value | String | A string value. |

#### IptcDataSet(byte, byte, int)

Initializes a new instance of the `IptcDataSet` class.

```csharp
public IptcDataSet(byte recordNumber, byte dataSetNumber, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |
| dataSetNumber | Byte | The dataSet number. |
| value | Int32 | An integer value. |

#### IptcDataSet(byte, byte, DateTime)

Initializes a new instance of the `IptcDataSet` class.

```csharp
public IptcDataSet(byte recordNumber, byte dataSetNumber, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |
| dataSetNumber | Byte | The dataSet number. |
| value | DateTime | A date value. |

### RecordNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcdataset/recordnumber.md

#### IptcDataSet.RecordNumber property

Gets the record number.

```csharp
public byte RecordNumber { get; }
```

##### Property Value

The record number.

### IptcEnvelopeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord.md

#### IptcEnvelopeRecord class

Represents an IPTC Envelope Record.

```csharp
public sealed class IptcEnvelopeRecord : IptcRecord
```

#### Constructors

| Name | Description |
| --- | --- |
| IptcEnvelopeRecord() | Initializes a new instance of the `IptcEnvelopeRecord` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DateSent { get; set; } | Gets or sets the date the service sent the material. |
| Destination { get; set; } | Gets or sets the destination. |
| Destinations { get; set; } | Gets or sets an array of destinations. |
| FileFormat { get; set; } | Gets or sets the file format. |
| FileFormatVersion { get; set; } | Gets or sets the file format version. A number representing the particular version of the File Format specified in `FileFormat`. |
| Item { get; } | Gets the `IptcDataSet` with the specified number. (3 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| ModelVersion { get; set; } | Gets or sets a number identifying the version of the information. |
| ProductID { get; set; } | Gets or sets the product identifier. |
| ProductIds { get; set; } | Gets or sets the product identifiers. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RecordNumber { get; } | Gets the record number. |
| ServiceIdentifier { get; set; } | Gets or sets the service identifier. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DateSent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/datesent.md

#### IptcEnvelopeRecord.DateSent property

Gets or sets the date the service sent the material.

```csharp
public DateTime? DateSent { get; set; }
```

##### Property Value

The date the service sent the material.

### Destination
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/destination.md

#### IptcEnvelopeRecord.Destination property

Gets or sets the destination.

```csharp
public string Destination { get; set; }
```

##### Property Value

The destination.

### Destinations
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/destinations.md

#### IptcEnvelopeRecord.Destinations property

Gets or sets an array of destinations.

```csharp
public string[] Destinations { get; set; }
```

##### Property Value

The destinations.

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/fileformat.md

#### IptcEnvelopeRecord.FileFormat property

Gets or sets the file format.

```csharp
public ushort? FileFormat { get; set; }
```

##### Property Value

The file format.

### FileFormatVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/fileformatversion.md

#### IptcEnvelopeRecord.FileFormatVersion property

Gets or sets the file format version. A number representing the particular version of the File Format specified in `FileFormat`.

```csharp
public ushort? FileFormatVersion { get; set; }
```

##### Property Value

The file format version.

### IptcEnvelopeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/iptcenveloperecord.md

#### IptcEnvelopeRecord constructor

Initializes a new instance of the `IptcEnvelopeRecord` class.

```csharp
public IptcEnvelopeRecord()
```

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/item.md

#### IptcEnvelopeRecord indexer

Gets the `IptcDataSet` with the specified number.

```csharp
public IptcDataSet this[IptcEnvelopeRecordDataSet dataSetNumber] { get; }
```

| Parameter | Description |
| --- | --- |
| dataSetNumber | The dataSet number. |

##### Return Value

The `IptcDataSet` with the specified number.

### ModelVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/modelversion.md

#### IptcEnvelopeRecord.ModelVersion property

Gets or sets a number identifying the version of the information.

```csharp
public ushort? ModelVersion { get; set; }
```

##### Property Value

The model version.

### ProductID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/productid.md

#### IptcEnvelopeRecord.ProductID property

Gets or sets the product identifier.

```csharp
public string ProductID { get; set; }
```

##### Property Value

The product identifier.

### ProductIds
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/productids.md

#### IptcEnvelopeRecord.ProductIds property

Gets or sets the product identifiers.

```csharp
public string[] ProductIds { get; set; }
```

##### Property Value

The product identifiers.

### ServiceIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecord/serviceidentifier.md

#### IptcEnvelopeRecord.ServiceIdentifier property

Gets or sets the service identifier.

```csharp
public string ServiceIdentifier { get; set; }
```

##### Property Value

The service identifier.

### IptcEnvelopeRecordDataSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcenveloperecorddataset.md

#### IptcEnvelopeRecordDataSet enumeration

Defines IPTC Envelope Record dataSet numbers.

```csharp
public enum IptcEnvelopeRecordDataSet
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ModelVersion | `0` | A binary number identifying the version of the Information  Interchange Model, Part I, utilised by the provider. Version numbers are assigned by IPTC and NAA.  The version number of this record is four (4). |
| Destination | `5` | Optional, repeatable, maximum 1024 octets, consisting of sequentially contiguous graphic characters.  This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers. |
| FileFormat | `20` | File format. |
| FileFormatVersion | `22` | Mandatory, not repeatable, two octets.  A binary number representing the particular version of the File Format specified in 1:20.  A list of File Formats, including version cross references, is included as Appendix A. |
| ServiceIdentifier | `30` | Mandatory, not repeatable. Up to 10 octets, consisting of graphic characters.  Identifies the provider and product. |
| EnvelopeNumber | `40` | Mandatory, not repeatable, eight octets, consisting of numeric characters.  The characters form a number that will be unique for the date specified in 1:70 and for the Service Identifier specified in 1:30.  If identical envelope numbers appear with the same date and with the same Service Identifier, records 2-9 must be unchanged from the original.  This is not intended to be a sequential serial number reception check. |
| ProductID | `50` | Optional, repeatable. Up to 32 octets, consisting of graphic characters.  Allows a provider to identify subsets of its overall service.  Used to provide receiving organization data on which to select, route, or otherwise handle data. |
| EnvelopePriority | `60` | Optional, not repeatable. A single octet, consisting of a numeric character.  Specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency). '1' indicates the most urgent, '5' the normal urgency, and '8' the least urgent copy. The numeral '9' indicates a User Defined Priority. The numeral '0' is reserved for future use. |
| DateSent | `70` | Mandatory, not repeatable. Eight octets, consisting of numeric characters.  Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day the service sent the material. |
| TimeSent | `80` | Uses the format HHMMSS±HHMM where HHMMSS refers to local hour, minute and seconds and HHMM refers to hours and minutes ahead (+) or behind (-) Universal Coordinated Time as described in ISO 8601. This is the time the service sent the material. |
| CodedCharacterSet | `90` | Optional, not repeatable, up to 32 octets, consisting of one or more control functions used for the announcement, invocation or designation of coded character sets. The control functions follow the ISO 2022 standard and may consist of the escape control character and one or more graphic characters. For more details see Appendix C, the IPTC-NAA Code Library. |
| Uno | `100` | Invalid (eternal identifier). |
| ArmIdentifier | `120` | The DataSet identifies the Abstract Relationship Method (ARM) which is described in a document registered by the originator of the ARM with the IPTC and NAA. |
| ArmVersion | `122` | Binary number representing the particular version of the ARM specified in DataSet 1:120. |

### IptcRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecord.md

#### IptcRecord class

Represents an IPTC record.

```csharp
public class IptcRecord : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `IptcDataSet` with the specified dataSet number. (2 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RecordNumber { get; } | Gets the record number. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecord/item.md

#### IptcRecord indexer

Gets the `IptcDataSet` with the specified dataSet number.

```csharp
public IptcDataSet this[byte dataSetNumber] { get; }
```

| Parameter | Description |
| --- | --- |
| dataSetNumber | The IPTC dataSet number. |

##### Return Value

The `IptcDataSet` with the specified dataSet number, if found; otherwise null.

### RecordNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecord/recordnumber.md

#### IptcRecord.RecordNumber property

Gets the record number.

```csharp
public byte RecordNumber { get; }
```

##### Property Value

The record number.

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecord/tolist.md

#### IptcRecord.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<IptcDataSet> ToList()
```

##### Return Value

A list that contains all IPTC dataSets from the package.

### IptcRecordSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset.md

#### IptcRecordSet class

Represents a collection of IPTC records.

```csharp
public sealed class IptcRecordSet : CustomPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| IptcRecordSet() | Initializes a new instance of the `IptcRecordSet` class. |
| IptcRecordSet(IptcDataSet[]) | Initializes a new instance of the `IptcRecordSet` class. |

#### Properties

| Name | Description |
| --- | --- |
| ApplicationRecord { get; set; } | Gets or sets the Application Record. |
| Count { get; } | Gets the number of metadata properties. |
| EnvelopeRecord { get; set; } | Gets or sets the Envelope Record. |
| Item { get; } | Gets the `IptcRecord` with the specified number. (3 indexers) |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| Add(IptcDataSet) | Adds the specified dataSet to the appropriate record. The dataSet is considered as repeatable if a dataSet with the specified number already exists. |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all records from the collection. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(byte) | Removes the record with the specified record number. |
| Remove(byte, byte) | Removes the dataSet with the specified record and dataSet number. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(IptcDataSet) | Adds or updates the specified dataSet in the appropriate record. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| ToDataSetList() | Creates a list of dataSets from the package. |
| ToList() | Creates a list from the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This code sample shows hot to update basic IPTC metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.InputJpeg))
{
    IIptc root = metadata.GetRootPackage() as IIptc;
    if (root != null)
    {
        // Set the IPTC package if it's missing
        if (root.IptcPackage == null)
        {
            root.IptcPackage = new IptcRecordSet();
        }

        if (root.IptcPackage.EnvelopeRecord == null)
        {
            root.IptcPackage.EnvelopeRecord = new IptcEnvelopeRecord();
        }

        root.IptcPackage.EnvelopeRecord.DateSent = DateTime.Now;
        root.IptcPackage.EnvelopeRecord.ProductID = Guid.NewGuid().ToString();

        // ...

        if (root.IptcPackage.ApplicationRecord == null)
        {
            root.IptcPackage.ApplicationRecord = new IptcApplicationRecord();
        }

        root.IptcPackage.ApplicationRecord.ByLine = "GroupDocs";
        root.IptcPackage.ApplicationRecord.Headline = "test";
        root.IptcPackage.ApplicationRecord.ByLineTitle = "code sample";
        root.IptcPackage.ApplicationRecord.ReleaseDate = DateTime.Today;

        // ...

        metadata.Save(Constants.OutputJpeg);
    }
}
```

### Add
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/add.md

#### IptcRecordSet.Add method

Adds the specified dataSet to the appropriate record. The dataSet is considered as repeatable if a dataSet with the specified number already exists.

```csharp
public void Add(IptcDataSet dataSet)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add. |

### ApplicationRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/applicationrecord.md

#### IptcRecordSet.ApplicationRecord property

Gets or sets the Application Record.

```csharp
public IptcApplicationRecord ApplicationRecord { get; set; }
```

##### Property Value

The Application Record.

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/clear.md

#### IptcRecordSet.Clear method

Removes all records from the collection.

```csharp
public void Clear()
```

### EnvelopeRecord
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/enveloperecord.md

#### IptcRecordSet.EnvelopeRecord property

Gets or sets the Envelope Record.

```csharp
public IptcEnvelopeRecord EnvelopeRecord { get; set; }
```

##### Property Value

The Envelope Record.

### IptcRecordSet
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/iptcrecordset.md

#### IptcRecordSet()

Initializes a new instance of the `IptcRecordSet` class.

```csharp
public IptcRecordSet()
```

#### IptcRecordSet(IptcDataSet[])

Initializes a new instance of the `IptcRecordSet` class.

```csharp
public IptcRecordSet(IptcDataSet[] dataSets)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataSets | IptcDataSet[] | An array of IPTC dataSets. |

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/item.md

#### IptcRecordSet indexer (1 of 2)

Gets the `IptcRecord` with the specified number.

```csharp
public IptcRecord this[byte recordNumber] { get; }
```

| Parameter | Description |
| --- | --- |
| recordNumber | The record number. |

##### Return Value

The `IptcRecord` with the specified number, if found; otherwise null.

#### IptcRecordSet indexer (2 of 2)

Gets the `IptcDataSet` with the specified record and dataSet number.

```csharp
public IptcDataSet this[byte recordNumber, byte dataSetNumber] { get; }
```

| Parameter | Description |
| --- | --- |
| recordNumber | The record number. |
| dataSetNumber | The dataSet number. |

##### Return Value

The `IptcDataSet` with the specified record and dataSet number.

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/remove.md

#### Remove(byte, byte)

Removes the dataSet with the specified record and dataSet number.

```csharp
public bool Remove(byte recordNumber, byte dataSetNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |
| dataSetNumber | Byte | The dataSet number. |

##### Return Value

True if the specified IPTC dataSet is found and removed; otherwise, false.

#### Remove(byte)

Removes the record with the specified record number.

```csharp
public bool Remove(byte recordNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | Byte | The record number. |

##### Return Value

True if the specified IPTC record is found and removed; otherwise, false.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/set.md

#### IptcRecordSet.Set method

Adds or updates the specified dataSet in the appropriate record.

```csharp
public void Set(IptcDataSet dataSet)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add/update. |

##### Examples

This example shows how to add or update custom IPTC datasets in a file.

```csharp
using (Metadata metadata = new Metadata(Constants.PsdWithIptc))
{
    IIptc root = metadata.GetRootPackage() as IIptc;
    if (root != null)
    {
        // Set the IPTC package if it's missing
        if (root.IptcPackage == null)
        {
            root.IptcPackage = new IptcRecordSet();
        }

        // Add a know property using the DataSet API
        root.IptcPackage.Set(new IptcDataSet((byte) IptcRecordType.ApplicationRecord, (byte) IptcApplicationRecordDataSet.BylineTitle, "test code sample"));

        // Add a custom IPTC DataSet
        root.IptcPackage.Set(new IptcDataSet(255, 255, new byte[] { 1, 2, 3 }));

        metadata.Save(Constants.OutputPsd);
    }
}
```

### ToDataSetList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/todatasetlist.md

#### IptcRecordSet.ToDataSetList method

Creates a list of dataSets from the package.

```csharp
public IReadOnlyList<IptcDataSet> ToDataSetList()
```

##### Return Value

A list that contains all IPTC dataSets from the package.

##### Examples

This example demonstrates how to read all IPTC IIM datasets from an IPTC metadata package.

```csharp
using (Metadata metadata = new Metadata(Constants.PsdWithIptc))
{
    IIptc root = metadata.GetRootPackage() as IIptc;
    if (root != null && root.IptcPackage != null)
    {
        foreach (var dataSet in root.IptcPackage.ToDataSetList())
        {
            Console.WriteLine(dataSet.RecordNumber);
            Console.WriteLine(dataSet.DataSetNumber);
            Console.WriteLine(dataSet.AlternativeName);
            Console.WriteLine(dataSet.Value);
        }
    }
}
```

### ToList
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordset/tolist.md

#### IptcRecordSet.ToList method

Creates a list from the package.

```csharp
public IReadOnlyList<IptcRecord> ToList()
```

##### Return Value

A list that contains all IPTC records from the package.

### IptcRecordType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.iptc/iptcrecordtype.md

#### IptcRecordType enumeration

Defines IPTC record types.

```csharp
public enum IptcRecordType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| EnvelopeRecord | `1` | Represents an Envelope Record. |
| ApplicationRecord | `2` | Represents an Application Record. |

### GroupDocs.Metadata.Standards.Pkcs
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs.md

The namespace provides functionality intended to work with digital signatures based on the syntax of PKCS #7, specified in RFC 5652.

#### Classes

| Class | Description |
| --- | --- |
| Cms | Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. CMS is based on the syntax of PKCS #7, specified in RFC 5652. Please see [https://tools.ietf.org/html/rfc5652](https://tools.ietf.org/html/rfc5652) for more information. |
| CmsAttribute | Represents a CMS signer info attribute. |
| CmsCertificate | Represents a CMS certificate. |
| CmsEncapsulatedContent | Represents a signed content container, consisting of a content type identifier and the content itself. |
| CmsPackage | Represents a CMS digital signature metadata package. |
| CmsSigner | Represents CMS per-signer information. |
| Oid | Represents an object identifier (OID). An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC for naming any object, concept, or "thing" with a globally unambiguous persistent name. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### Cms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms.md

#### Cms class

Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. CMS is based on the syntax of PKCS #7, specified in RFC 5652. Please see [https://tools.ietf.org/html/rfc5652](https://tools.ietf.org/html/rfc5652) for more information.

```csharp
public class Cms : DigitalSignature
```

#### Properties

| Name | Description |
| --- | --- |
| CertificateRawData { get; } | Gets the certificate raw data. |
| Certificates { get; } | Gets the collection of certificates. |
| CertificateSubject { get; } | Gets the subject distinguished name from a certificate. |
| Comments { get; } | Gets the signing purpose comment. |
| Count { get; } | Gets the number of metadata properties. |
| DigestAlgorithms { get; } | Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero. |
| EncapsulatedContent { get; } | Gets the signed content, consisting of a content type identifier and the content itself. |
| virtual IsValid { get; } | Gets a value indicating whether the signature is valid. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Signers { get; } | Gets the collection of per-signer information packages. |
| override SignTime { get; } | Gets the time at which the signer (purportedly) performed the signing process. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Certificates
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms/certificates.md

#### Cms.Certificates property

Gets the collection of certificates.

```csharp
public CmsCertificate[] Certificates { get; }
```

##### Property Value

The collection of certificates.

##### Remarks

It is intended that the set of certificates be sufficient to contain certification paths from a recognized "root" or "top-level certification authority" to all of the signers in the SignerInfo field.

### DigestAlgorithms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms/digestalgorithms.md

#### Cms.DigestAlgorithms property

Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero.

```csharp
public Oid[] DigestAlgorithms { get; }
```

##### Property Value

The array of message-digest algorithm identifiers.

### EncapsulatedContent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms/encapsulatedcontent.md

#### Cms.EncapsulatedContent property

Gets the signed content, consisting of a content type identifier and the content itself.

```csharp
public CmsEncapsulatedContent EncapsulatedContent { get; }
```

##### Property Value

The signed content, consisting of a content type identifier and the content itself.

### Signers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms/signers.md

#### Cms.Signers property

Gets the collection of per-signer information packages.

```csharp
public CmsSigner[] Signers { get; }
```

##### Property Value

The collection of per-signer information packages.

##### Remarks

There may be any number of elements in the collection, including zero.

### SignTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cms/signtime.md

#### Cms.SignTime property

Gets the time at which the signer (purportedly) performed the signing process.

```csharp
public override DateTime SignTime { get; }
```

##### Property Value

The time at which the signer (purportedly) performed the signing process.

### CmsAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsattribute.md

#### CmsAttribute class

Represents a CMS signer info attribute.

```csharp
public class CmsAttribute : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Oid { get; } | Gets the attribute OID. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the attribute value represented as a string. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Oid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsattribute/oid.md

#### CmsAttribute.Oid property

Gets the attribute OID.

```csharp
public Oid Oid { get; }
```

##### Property Value

The attribute OID.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsattribute/value.md

#### CmsAttribute.Value property

Gets the attribute value represented as a string.

```csharp
public string Value { get; }
```

##### Property Value

The attribute value represented as a string.

### CmsCertificate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmscertificate.md

#### CmsCertificate class

Represents a CMS certificate.

```csharp
public class CmsCertificate : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NotAfter { get; } | Gets the date in local time after which a certificate is no longer valid. |
| NotBefore { get; } | Gets the date in local time on which a certificate becomes valid. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawData { get; } | Gets the raw data of this certificate. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### NotAfter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmscertificate/notafter.md

#### CmsCertificate.NotAfter property

Gets the date in local time after which a certificate is no longer valid.

```csharp
public DateTime NotAfter { get; }
```

##### Property Value

The date in local time after which a certificate is no longer valid.

### NotBefore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmscertificate/notbefore.md

#### CmsCertificate.NotBefore property

Gets the date in local time on which a certificate becomes valid.

```csharp
public DateTime NotBefore { get; }
```

##### Property Value

The date in local time on which a certificate becomes valid.

### RawData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmscertificate/rawdata.md

#### CmsCertificate.RawData property

Gets the raw data of this certificate.

```csharp
public byte[] RawData { get; }
```

##### Property Value

The raw data of this certificate.

### CmsEncapsulatedContent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent.md

#### CmsEncapsulatedContent class

Represents a signed content container, consisting of a content type identifier and the content itself.

```csharp
public class CmsEncapsulatedContent : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| ContentRawData { get; } | Gets the raw data of content info. |
| ContentType { get; } | Gets the object identifier uniquely specifies the content type. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ContentRawData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/contentrawdata.md

#### CmsEncapsulatedContent.ContentRawData property

Gets the raw data of content info.

```csharp
public byte[] ContentRawData { get; }
```

##### Property Value

The raw data of content info.

### ContentType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/contenttype.md

#### CmsEncapsulatedContent.ContentType property

Gets the object identifier uniquely specifies the content type.

```csharp
public Oid ContentType { get; }
```

##### Property Value

The object identifier uniquely specifies the content type.

### CmsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmspackage.md

#### CmsPackage class

Represents a CMS digital signature metadata package.

```csharp
public sealed class CmsPackage : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Flags { get; } | Gets the digital signature flags. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Signatures { get; } | Gets an array of the signatures extracted from the file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Flags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmspackage/flags.md

#### CmsPackage.Flags property

Gets the digital signature flags.

```csharp
public OpenTypeDigitalSignatureFlags? Flags { get; }
```

##### Property Value

The digital signature flags.

### Signatures
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmspackage/signatures.md

#### CmsPackage.Signatures property

Gets an array of the signatures extracted from the file.

```csharp
public Cms[] Signatures { get; }
```

##### Property Value

An array of the signatures extracted from the file.

### CmsSigner
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner.md

#### CmsSigner class

Represents CMS per-signer information.

```csharp
public class CmsSigner : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DigestAlgorithm { get; } | Gets the message digest algorithm, and any associated parameters, used by the signer. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SignatureAlgorithm { get; } | Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature. |
| SignatureValue { get; } | Gets the result of digital signature generation, using the message digest and the signer's private key. |
| SignedAttributes { get; } | Gets the collection of attributes that are signed. |
| SignerIdentifier { get; } | Gets the signer's certificate (and thereby the signer's public key) raw data. |
| SigningTime { get; } | Gets the time at which the signer (purportedly) performed the signing process. |
| UnsignedAttributes { get; } | Gets the collection of attributes that are not signed. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DigestAlgorithm
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/digestalgorithm.md

#### CmsSigner.DigestAlgorithm property

Gets the message digest algorithm, and any associated parameters, used by the signer.

```csharp
public Oid DigestAlgorithm { get; }
```

##### Property Value

The message digest algorithm, and any associated parameters, used by the signer.

### SignatureAlgorithm
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/signaturealgorithm.md

#### CmsSigner.SignatureAlgorithm property

Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature.

```csharp
public Oid SignatureAlgorithm { get; }
```

##### Property Value

The signature algorithm, and any associated parameters, used by the signer to generate the digital signature.

### SignatureValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/signaturevalue.md

#### CmsSigner.SignatureValue property

Gets the result of digital signature generation, using the message digest and the signer's private key.

```csharp
public string SignatureValue { get; }
```

##### Property Value

The result of digital signature generation, using the message digest and the signer's private key.

### SignedAttributes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/signedattributes.md

#### CmsSigner.SignedAttributes property

Gets the collection of attributes that are signed.

```csharp
public CmsAttribute[] SignedAttributes { get; }
```

##### Property Value

The collection of attributes that are signed.

### SignerIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/signeridentifier.md

#### CmsSigner.SignerIdentifier property

Gets the signer's certificate (and thereby the signer's public key) raw data.

```csharp
public byte[] SignerIdentifier { get; }
```

##### Property Value

The signer's certificate (and thereby the signer's public key) raw data.

### SigningTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/signingtime.md

#### CmsSigner.SigningTime property

Gets the time at which the signer (purportedly) performed the signing process.

```csharp
public DateTime? SigningTime { get; }
```

##### Property Value

The time at which the signer (purportedly) performed the signing process.

### UnsignedAttributes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/cmssigner/unsignedattributes.md

#### CmsSigner.UnsignedAttributes property

Gets the collection of attributes that are not signed.

```csharp
public CmsAttribute[] UnsignedAttributes { get; }
```

##### Property Value

The collection of attributes that are not signed.

### Oid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/oid.md

#### Oid class

Represents an object identifier (OID). An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC for naming any object, concept, or "thing" with a globally unambiguous persistent name.

```csharp
public sealed class Oid : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| FriendlyName { get; } | Gets the friendly name. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Value { get; } | Gets the object identifier (OID) value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### FriendlyName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/oid/friendlyname.md

#### Oid.FriendlyName property

Gets the friendly name.

```csharp
public string FriendlyName { get; }
```

##### Property Value

The friendly name.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.pkcs/oid/value.md

#### Oid.Value property

Gets the object identifier (OID) value.

```csharp
public string Value { get; }
```

##### Property Value

The object identifier (OID) value.

### GroupDocs.Metadata.Standards.Signing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing.md

The namespace provides base functionality intended to work with digital signatures.

#### Classes

| Class | Description |
| --- | --- |
| DigitalSignature | Represents a digital signature used to sign a document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### DigitalSignature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature.md

#### DigitalSignature class

Represents a digital signature used to sign a document.

```csharp
public class DigitalSignature : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| CertificateRawData { get; } | Gets the certificate raw data. |
| CertificateSubject { get; } | Gets the subject distinguished name from a certificate. |
| Comments { get; } | Gets the signing purpose comment. |
| Count { get; } | Gets the number of metadata properties. |
| virtual IsValid { get; } | Gets a value indicating whether the signature is valid. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| virtual SignTime { get; } | Gets the time the document was signed. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CertificateRawData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature/certificaterawdata.md

#### DigitalSignature.CertificateRawData property

Gets the certificate raw data.

```csharp
public byte[] CertificateRawData { get; }
```

##### Property Value

The certificate raw data.

### CertificateSubject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature/certificatesubject.md

#### DigitalSignature.CertificateSubject property

Gets the subject distinguished name from a certificate.

```csharp
public string CertificateSubject { get; }
```

##### Property Value

The subject distinguished name from a certificate.

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature/comments.md

#### DigitalSignature.Comments property

Gets the signing purpose comment.

```csharp
public string Comments { get; }
```

##### Property Value

The signing purpose comment.

### IsValid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature/isvalid.md

#### DigitalSignature.IsValid property

Gets a value indicating whether the signature is valid.

```csharp
public virtual bool? IsValid { get; }
```

##### Property Value

True if the the signature is valid; otherwise, false. Null indicates that validation is unavailable for the signature.

### SignTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.signing/digitalsignature/signtime.md

#### DigitalSignature.SignTime property

Gets the time the document was signed.

```csharp
public virtual DateTime SignTime { get; }
```

##### Property Value

The time the document was signed.

### GroupDocs.Metadata.Standards.Xmp.Schemes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes.md

Contains the implementation of different XMP Schemes.

#### Classes

| Class | Description |
| --- | --- |
| XmpAudioChannelType | Represents audio channel type. |
| XmpAudioSampleType | Represents Audio sample type in `XmpDynamicMediaPackage`. |
| XmpBasicJobTicketPackage | Represents Basic Job-Ticket namespace. |
| XmpBasicPackage | Represents the XMP basic namespace. |
| XmpCameraRawPackage | Represents Camera Raw schema. |
| XmpDublinCorePackage | Represents the Dublin Core scheme. |
| XmpDynamicMediaPackage | Represents XMP Dynamic Media namespace. |
| XmpIptcCorePackage | Represents the IPTC Core XMP package. |
| XmpIptcExtensionPackage | Represents the IPTC Extension XMP package. |
| XmpIptcIimPackage | Represents the IPTC-IIM XMP package. |
| XmpMediaManagementPackage | Represents the XMP Media Management namespace. |
| XmpPagedTextPackage | Represents the XMP Paged-Text package. |
| XmpPdfPackage | Specifies properties used with Adobe PDF documents. |
| XmpPhotoshopPackage | Represents Adobe Photoshop namespace. |
| XmpRightsManagementPackage | Represents XMP Rights Management namespace. |
| XmpTimeFormat | Represents time format in `XmpTimecode`. |
| XmpWhiteBalance | Represents the White Balance setting in `XmpCameraRawPackage`. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| XmpCropUnit | Represent a unit for CropWidth and CropHeight in `XmpCameraRawPackage`. |
| XmpPhotoshopColorMode | Represents a color mode in `XmpPhotoshopPackage`. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### XmpAudioChannelType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype.md

#### XmpAudioChannelType class

Represents audio channel type.

```csharp
public sealed class XmpAudioChannelType : XmpClosedChoice<string>
```

#### Properties

| Name | Description |
| --- | --- |
| static Audio16Channel { get; } | Gets 16 audio channel. |
| static Audio51 { get; } | Gets 5.1 audio channel. |
| static Audio71 { get; } | Gets 7.1 audio channel. |
| static Mono { get; } | Gets mono audio channel. |
| static OtherChannel { get; } | Gets other channel. |
| static Stereo { get; } | Gets stereo audio channel. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) |  |
| Equals(XmpClosedChoice&lt;string&gt;) |  |
| override GetHashCode() |  |
| override ToString() |  |

### Audio16Channel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio16channel.md

#### XmpAudioChannelType.Audio16Channel property

Gets 16 audio channel.

```csharp
public static XmpAudioChannelType Audio16Channel { get; }
```

##### Property Value

16 channel audio.

### Audio51
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio51.md

#### XmpAudioChannelType.Audio51 property

Gets 5.1 audio channel.

```csharp
public static XmpAudioChannelType Audio51 { get; }
```

##### Property Value

The audio 5.1.

### Audio71
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio71.md

#### XmpAudioChannelType.Audio71 property

Gets 7.1 audio channel.

```csharp
public static XmpAudioChannelType Audio71 { get; }
```

##### Property Value

The audio 7.1.

### Mono
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/mono.md

#### XmpAudioChannelType.Mono property

Gets mono audio channel.

```csharp
public static XmpAudioChannelType Mono { get; }
```

##### Property Value

The mono.

### OtherChannel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/otherchannel.md

#### XmpAudioChannelType.OtherChannel property

Gets other channel.

```csharp
public static XmpAudioChannelType OtherChannel { get; }
```

##### Property Value

The other channel.

### Stereo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/stereo.md

#### XmpAudioChannelType.Stereo property

Gets stereo audio channel.

```csharp
public static XmpAudioChannelType Stereo { get; }
```

##### Property Value

The stereo.

### XmpAudioSampleType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype.md

#### XmpAudioSampleType class

Represents Audio sample type in `XmpDynamicMediaPackage`.

```csharp
public sealed class XmpAudioSampleType : XmpClosedChoice<string>
```

#### Properties

| Name | Description |
| --- | --- |
| static Compressed { get; } | Gets Compressed audio sample. |
| static Other { get; } | Gets Other audio sample. |
| static Packed { get; } | Gets Packed audio sample. |
| static Sample16Int { get; } | Gets 16Int audio sample. |
| static Sample24Int { get; } | Gets 24Int audio sample. |
| static Sample32Float { get; } | Gets 32Float audio sample. |
| static Sample32Int { get; } | Gets 32Int audio sample. |
| static Sample8Int { get; } | Gets 8Int audio sample. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) |  |
| Equals(XmpClosedChoice&lt;string&gt;) |  |
| override GetHashCode() |  |
| override ToString() |  |

### Compressed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/compressed.md

#### XmpAudioSampleType.Compressed property

Gets Compressed audio sample.

```csharp
public static XmpAudioSampleType Compressed { get; }
```

##### Property Value

The compressed audio.

### Other
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/other.md

#### XmpAudioSampleType.Other property

Gets Other audio sample.

```csharp
public static XmpAudioSampleType Other { get; }
```

##### Property Value

The packed audio.

### Packed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/packed.md

#### XmpAudioSampleType.Packed property

Gets Packed audio sample.

```csharp
public static XmpAudioSampleType Packed { get; }
```

##### Property Value

The packed audio.

### Sample16Int
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample16int.md

#### XmpAudioSampleType.Sample16Int property

Gets 16Int audio sample.

```csharp
public static XmpAudioSampleType Sample16Int { get; }
```

##### Property Value

16Int.

### Sample24Int
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample24int.md

#### XmpAudioSampleType.Sample24Int property

Gets 24Int audio sample.

```csharp
public static XmpAudioSampleType Sample24Int { get; }
```

##### Property Value

24Int.

### Sample32Float
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample32float.md

#### XmpAudioSampleType.Sample32Float property

Gets 32Float audio sample.

```csharp
public static XmpAudioSampleType Sample32Float { get; }
```

##### Property Value

32Float.

### Sample32Int
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample32int.md

#### XmpAudioSampleType.Sample32Int property

Gets 32Int audio sample.

```csharp
public static XmpAudioSampleType Sample32Int { get; }
```

##### Property Value

32Int.

### Sample8Int
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample8int.md

#### XmpAudioSampleType.Sample8Int property

Gets 8Int audio sample.

```csharp
public static XmpAudioSampleType Sample8Int { get; }
```

##### Property Value

8Int.

### XmpBasicJobTicketPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage.md

#### XmpBasicJobTicketPackage class

Represents Basic Job-Ticket namespace.

```csharp
public sealed class XmpBasicJobTicketPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpBasicJobTicketPackage() | Initializes a new instance of the `XmpBasicJobTicketPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Jobs { get; set; } | Gets or sets the jobs. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| virtual Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Jobs
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/jobs.md

#### XmpBasicJobTicketPackage.Jobs property

Gets or sets the jobs.

```csharp
public XmpJob[] Jobs { get; set; }
```

##### Property Value

The jobs.

### XmpBasicJobTicketPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/xmpbasicjobticketpackage.md

#### XmpBasicJobTicketPackage constructor

Initializes a new instance of the `XmpBasicJobTicketPackage` class.

```csharp
public XmpBasicJobTicketPackage()
```

### XmpBasicPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage.md

#### XmpBasicPackage class

Represents the XMP basic namespace.

```csharp
public sealed class XmpBasicPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpBasicPackage() | Initializes a new instance of the `XmpBasicPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| BaseUrl { get; set; } | Gets or sets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL. |
| Count { get; } | Gets the number of metadata properties. |
| CreateDate { get; set; } | Gets or sets the date and time the resource was created. |
| CreatorTool { get; set; } | Gets or sets the name of the tool used to create the resource. |
| Identifiers { get; set; } | Gets or sets an unordered array of text strings that unambiguously identify the resource within a given context. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Label { get; set; } | Gets or sets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| MetadataDate { get; set; } | Gets or sets the date and time that any metadata for this resource was last changed. |
| MetadataType { get; } | Gets the metadata type. |
| ModifyDate { get; set; } | Gets or sets the date and time the resource was last modified. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Nickname { get; set; } | Gets or sets a short informal name for the resource. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Rating { get; set; } | Gets or sets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates “rejected” and 0 indicates “unrated”. |
| Thumbnails { get; set; } | Gets or sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Adds string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

#### Fields

| Name | Description |
| --- | --- |
| const RatingMax | Rating max value. |
| const RatingMin | Rating min value. |
| const RatingRejected | Rating rejected value. |

### BaseUrl
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/baseurl.md

#### XmpBasicPackage.BaseUrl property

Gets or sets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL.

```csharp
public string BaseUrl { get; set; }
```

##### Property Value

The base URL.

### CreateDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/createdate.md

#### XmpBasicPackage.CreateDate property

Gets or sets the date and time the resource was created.

```csharp
public DateTime? CreateDate { get; set; }
```

##### Property Value

The resource creation date.

### CreatorTool
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/creatortool.md

#### XmpBasicPackage.CreatorTool property

Gets or sets the name of the tool used to create the resource.

```csharp
public string CreatorTool { get; set; }
```

##### Property Value

The name of the tool used to create the resource.

### Identifiers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/identifiers.md

#### XmpBasicPackage.Identifiers property

Gets or sets an unordered array of text strings that unambiguously identify the resource within a given context.

```csharp
public string[] Identifiers { get; set; }
```

##### Property Value

An array of the identifiers.

### Label
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/label.md

#### XmpBasicPackage.Label property

Gets or sets a word or short phrase that identifies the resource as a member of a user-defined collection.

```csharp
public string Label { get; set; }
```

##### Property Value

The label of the resource.

### MetadataDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/metadatadate.md

#### XmpBasicPackage.MetadataDate property

Gets or sets the date and time that any metadata for this resource was last changed.

```csharp
public DateTime? MetadataDate { get; set; }
```

##### Property Value

The metadata date.

### ModifyDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/modifydate.md

#### XmpBasicPackage.ModifyDate property

Gets or sets the date and time the resource was last modified.

```csharp
public DateTime? ModifyDate { get; set; }
```

##### Property Value

The last modification date.

### Nickname
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/nickname.md

#### XmpBasicPackage.Nickname property

Gets or sets a short informal name for the resource.

```csharp
public string Nickname { get; set; }
```

##### Property Value

The nickname.

### Rating
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/rating.md

#### XmpBasicPackage.Rating property

Gets or sets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates “rejected” and 0 indicates “unrated”.

```csharp
public double Rating { get; set; }
```

##### Property Value

The rating.

### RatingMax
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/ratingmax.md

#### XmpBasicPackage.RatingMax field

Rating max value.

```csharp
public const float RatingMax;
```

### RatingMin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/ratingmin.md

#### XmpBasicPackage.RatingMin field

Rating min value.

```csharp
public const float RatingMin;
```

### RatingRejected
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/ratingrejected.md

#### XmpBasicPackage.RatingRejected field

Rating rejected value.

```csharp
public const float RatingRejected;
```

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/set.md

#### XmpBasicPackage.Set method

Adds string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XmpBasic key. |
| value | String | String value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Metadata key is not provided. |

### Thumbnails
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/thumbnails.md

#### XmpBasicPackage.Thumbnails property

Gets or sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.

```csharp
public XmpThumbnail[] Thumbnails { get; set; }
```

##### Property Value

The thumbnails.

### XmpBasicPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/xmpbasicpackage.md

#### XmpBasicPackage constructor

Initializes a new instance of the `XmpBasicPackage` class.

```csharp
public XmpBasicPackage()
```

### XmpCameraRawPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage.md

#### XmpCameraRawPackage class

Represents Camera Raw schema.

```csharp
public sealed class XmpCameraRawPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpCameraRawPackage() | Initializes a new instance of the `XmpCameraRawPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoBrightness { get; set; } | Gets or sets the AutoBrightness value. When true, `Brightness` is automatically adjusted. |
| AutoContrast { get; set; } | Gets or sets the AutoContrast value. When true, "Contrast" is automatically adjusted. |
| AutoExposure { get; set; } | Gets or sets the AutoExposure value. When true, "Exposure" is automatically adjusted. |
| AutoShadows { get; set; } | Gets or sets the AutoShadows value. When true, "Shadows" is automatically adjusted. |
| BlueHue { get; set; } | Gets or sets the BlueHue value. Null if undefined. |
| BlueSaturation { get; set; } | Gets or sets the BlueSaturation. Null if undefined. |
| Brightness { get; set; } | Gets or sets the Brightness value. Null if undefined. |
| CameraProfile { get; set; } | Gets or sets the CameraProfile value. |
| ChromaticAberrationB { get; set; } | Gets or sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined. |
| ChromaticAberrationR { get; set; } | Gets or sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined. |
| ColorNoiseReduction { get; set; } | Gets or sets the Color Noise Reduction setting. Range 0 to 100. |
| Contrast { get; set; } | Gets or sets the Contrast setting. Range -50 to 100. |
| Count { get; } | Gets the number of metadata properties. |
| CropAngle { get; set; } | Gets or sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle. |
| CropBottom { get; set; } | Gets or sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle. |
| CropHeight { get; set; } | Gets or sets the height of the resulting cropped image in `CropUnits` units. |
| CropLeft { get; set; } | Gets or sets the CropLeft setting. When HasCrop is true, left of the crop rectangle. |
| CropRight { get; set; } | Gets or sets the CropRight setting. When HasCrop is true, right of the crop rectangle. |
| CropTop { get; set; } | Gets or sets the CropTop setting. When HasCrop is true, top of the crop rectangle. |
| CropUnits { get; set; } | Gets or sets units for `CropWidth` and `CropHeight`. |
| CropWidth { get; set; } | Gets or sets the width of the resulting cropped image in `CropUnits` units. |
| Exposure { get; set; } | Gets or sets the Exposure setting. |
| GreenHue { get; set; } | Gets or sets the Green Hue setting. Range -100 to 100. |
| GreenSaturation { get; set; } | Gets or sets the Green Saturation setting. Range -100 to 100. |
| HasCrop { get; set; } | Gets or sets the HasCrop value. When true, the image has a cropping rectangle. |
| HasSettings { get; set; } | Gets or sets HasSettings value. When true, non-default camera raw settings. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LuminanceSmoothing { get; set; } | Gets or sets the LuminanceSmoothing setting. Range 0 to 100. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RawFileName { get; set; } | Gets or sets the file name for a raw file (not a complete path). |
| RedHue { get; set; } | Gets or sets the Red Hue setting. Range -100 to 100. |
| RedSaturation { get; set; } | Gets or sets the Red Saturation setting. Range -100 to 100. |
| Saturation { get; set; } | Gets or sets the Saturation setting. Range -100 to 100. |
| Shadows { get; set; } | Gets or sets the Shadows setting. Range 0 to 100. |
| ShadowTint { get; set; } | Gets or sets the ShadowTint setting. Range -100 to 100. |
| Sharpness { get; set; } | Gets or sets the Sharpness setting. Range 0 to 100. |
| Temperature { get; set; } | Gets or sets the Temperature setting. Range 2000 to 50000. |
| Tint { get; set; } | Gets or sets the Tint setting. Range -150 to 150. |
| Version { get; set; } | Gets or sets the version of the Camera Raw plug-in. |
| VignetteAmount { get; set; } | Gets or sets the Vignette Amount setting. Range -100 to 100. |
| VignetteMidpoint { get; set; } | Gets or sets the Vignetting Midpoint setting. Range 0 to 100. |
| WhiteBalance { get; } | Gets White Balance setting. Use `SetWhiteBalance` to set white balance value. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Adds string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| SetWhiteBalance(XmpWhiteBalance) | Sets the white balance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AutoBrightness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/autobrightness.md

#### XmpCameraRawPackage.AutoBrightness property

Gets or sets the AutoBrightness value. When true, `Brightness` is automatically adjusted.

```csharp
public bool? AutoBrightness { get; set; }
```

##### Property Value

`true` if [automatic brightness]; otherwise, `false`.

### AutoContrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/autocontrast.md

#### XmpCameraRawPackage.AutoContrast property

Gets or sets the AutoContrast value. When true, "Contrast" is automatically adjusted.

```csharp
public bool? AutoContrast { get; set; }
```

##### Property Value

`true` if [automatic contrast]; otherwise, `false`.

### AutoExposure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/autoexposure.md

#### XmpCameraRawPackage.AutoExposure property

Gets or sets the AutoExposure value. When true, "Exposure" is automatically adjusted.

```csharp
public bool? AutoExposure { get; set; }
```

##### Property Value

`true` if [automatic exposure]; otherwise, `false`.

### AutoShadows
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/autoshadows.md

#### XmpCameraRawPackage.AutoShadows property

Gets or sets the AutoShadows value. When true, "Shadows" is automatically adjusted.

```csharp
public bool? AutoShadows { get; set; }
```

##### Property Value

`true` if [automatic shadows]; otherwise, `false`.

### BlueHue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/bluehue.md

#### XmpCameraRawPackage.BlueHue property

Gets or sets the BlueHue value. Null if undefined.

```csharp
public int? BlueHue { get; set; }
```

##### Property Value

The blue hue.

### BlueSaturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/bluesaturation.md

#### XmpCameraRawPackage.BlueSaturation property

Gets or sets the BlueSaturation. Null if undefined.

```csharp
public int? BlueSaturation { get; set; }
```

##### Property Value

The blue saturation.

### Brightness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/brightness.md

#### XmpCameraRawPackage.Brightness property

Gets or sets the Brightness value. Null if undefined.

```csharp
public int? Brightness { get; set; }
```

##### Property Value

The brightness.

### CameraProfile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cameraprofile.md

#### XmpCameraRawPackage.CameraProfile property

Gets or sets the CameraProfile value.

```csharp
public string CameraProfile { get; set; }
```

##### Property Value

The camera profile.

### ChromaticAberrationB
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/chromaticaberrationb.md

#### XmpCameraRawPackage.ChromaticAberrationB property

Gets or sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.

```csharp
public int? ChromaticAberrationB { get; set; }
```

##### Property Value

The chromatic aberration B.

### ChromaticAberrationR
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/chromaticaberrationr.md

#### XmpCameraRawPackage.ChromaticAberrationR property

Gets or sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.

```csharp
public int? ChromaticAberrationR { get; set; }
```

##### Property Value

The chromatic aberration R.

### ColorNoiseReduction
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/colornoisereduction.md

#### XmpCameraRawPackage.ColorNoiseReduction property

Gets or sets the Color Noise Reduction setting. Range 0 to 100.

```csharp
public int? ColorNoiseReduction { get; set; }
```

##### Property Value

The color noise reduction.

### Contrast
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/contrast.md

#### XmpCameraRawPackage.Contrast property

Gets or sets the Contrast setting. Range -50 to 100.

```csharp
public int? Contrast { get; set; }
```

##### Property Value

The contrast.

### CropAngle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropangle.md

#### XmpCameraRawPackage.CropAngle property

Gets or sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.

```csharp
public double? CropAngle { get; set; }
```

##### Property Value

The crop angle.

### CropBottom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropbottom.md

#### XmpCameraRawPackage.CropBottom property

Gets or sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.

```csharp
public double? CropBottom { get; set; }
```

##### Property Value

The crop bottom.

### CropHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropheight.md

#### XmpCameraRawPackage.CropHeight property

Gets or sets the height of the resulting cropped image in `CropUnits` units.

```csharp
public double? CropHeight { get; set; }
```

##### Property Value

The height of the crop.

### CropLeft
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropleft.md

#### XmpCameraRawPackage.CropLeft property

Gets or sets the CropLeft setting. When HasCrop is true, left of the crop rectangle.

```csharp
public double? CropLeft { get; set; }
```

##### Property Value

The crop left.

### CropRight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropright.md

#### XmpCameraRawPackage.CropRight property

Gets or sets the CropRight setting. When HasCrop is true, right of the crop rectangle.

```csharp
public double? CropRight { get; set; }
```

##### Property Value

The crop right.

### CropTop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/croptop.md

#### XmpCameraRawPackage.CropTop property

Gets or sets the CropTop setting. When HasCrop is true, top of the crop rectangle.

```csharp
public double? CropTop { get; set; }
```

##### Property Value

The crop top.

### CropUnits
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropunits.md

#### XmpCameraRawPackage.CropUnits property

Gets or sets units for `CropWidth` and `CropHeight`.

```csharp
public XmpCropUnit CropUnits { get; set; }
```

##### Property Value

The crop units.

### CropWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/cropwidth.md

#### XmpCameraRawPackage.CropWidth property

Gets or sets the width of the resulting cropped image in `CropUnits` units.

```csharp
public double? CropWidth { get; set; }
```

##### Property Value

The width of the crop.

### Exposure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/exposure.md

#### XmpCameraRawPackage.Exposure property

Gets or sets the Exposure setting.

```csharp
public double? Exposure { get; set; }
```

##### Property Value

The exposure.

### GreenHue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/greenhue.md

#### XmpCameraRawPackage.GreenHue property

Gets or sets the Green Hue setting. Range -100 to 100.

```csharp
public int? GreenHue { get; set; }
```

##### Property Value

The green hue.

### GreenSaturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/greensaturation.md

#### XmpCameraRawPackage.GreenSaturation property

Gets or sets the Green Saturation setting. Range -100 to 100.

```csharp
public int? GreenSaturation { get; set; }
```

##### Property Value

The green saturation.

### HasCrop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/hascrop.md

#### XmpCameraRawPackage.HasCrop property

Gets or sets the HasCrop value. When true, the image has a cropping rectangle.

```csharp
public bool? HasCrop { get; set; }
```

##### Property Value

`true` if the image has a cropping rectangle; otherwise, `false`.

### HasSettings
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/hassettings.md

#### XmpCameraRawPackage.HasSettings property

Gets or sets HasSettings value. When true, non-default camera raw settings.

```csharp
public bool? HasSettings { get; set; }
```

##### Property Value

`true` if image has non-default camera raw settings; otherwise, `false`.

### LuminanceSmoothing
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/luminancesmoothing.md

#### XmpCameraRawPackage.LuminanceSmoothing property

Gets or sets the LuminanceSmoothing setting. Range 0 to 100.

```csharp
public int? LuminanceSmoothing { get; set; }
```

##### Property Value

The luminance smoothing.

### RawFileName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/rawfilename.md

#### XmpCameraRawPackage.RawFileName property

Gets or sets the file name for a raw file (not a complete path).

```csharp
public string RawFileName { get; set; }
```

##### Property Value

The name of the raw file.

### RedHue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/redhue.md

#### XmpCameraRawPackage.RedHue property

Gets or sets the Red Hue setting. Range -100 to 100.

```csharp
public int? RedHue { get; set; }
```

##### Property Value

The red hue.

### RedSaturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/redsaturation.md

#### XmpCameraRawPackage.RedSaturation property

Gets or sets the Red Saturation setting. Range -100 to 100.

```csharp
public int? RedSaturation { get; set; }
```

##### Property Value

The red saturation.

### Saturation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/saturation.md

#### XmpCameraRawPackage.Saturation property

Gets or sets the Saturation setting. Range -100 to 100.

```csharp
public int? Saturation { get; set; }
```

##### Property Value

The saturation.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/set.md

#### XmpCameraRawPackage.Set method

Adds string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata key. |
| value | String | XMP metadata value. |

### SetWhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/setwhitebalance.md

#### XmpCameraRawPackage.SetWhiteBalance method

Sets the white balance.

```csharp
public void SetWhiteBalance(XmpWhiteBalance whiteBalance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| whiteBalance | XmpWhiteBalance | The white balance. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | WhiteBalance could not be null. |

### Shadows
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/shadows.md

#### XmpCameraRawPackage.Shadows property

Gets or sets the Shadows setting. Range 0 to 100.

```csharp
public int? Shadows { get; set; }
```

##### Property Value

The shadows.

### ShadowTint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/shadowtint.md

#### XmpCameraRawPackage.ShadowTint property

Gets or sets the ShadowTint setting. Range -100 to 100.

```csharp
public int? ShadowTint { get; set; }
```

##### Property Value

The shadow tint.

### Sharpness
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/sharpness.md

#### XmpCameraRawPackage.Sharpness property

Gets or sets the Sharpness setting. Range 0 to 100.

```csharp
public int? Sharpness { get; set; }
```

##### Property Value

The sharpness.

### Temperature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/temperature.md

#### XmpCameraRawPackage.Temperature property

Gets or sets the Temperature setting. Range 2000 to 50000.

```csharp
public int? Temperature { get; set; }
```

##### Property Value

The temperature.

### Tint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/tint.md

#### XmpCameraRawPackage.Tint property

Gets or sets the Tint setting. Range -150 to 150.

```csharp
public int? Tint { get; set; }
```

##### Property Value

The tint.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/version.md

#### XmpCameraRawPackage.Version property

Gets or sets the version of the Camera Raw plug-in.

```csharp
public string Version { get; set; }
```

##### Property Value

The version.

### VignetteAmount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/vignetteamount.md

#### XmpCameraRawPackage.VignetteAmount property

Gets or sets the Vignette Amount setting. Range -100 to 100.

```csharp
public int? VignetteAmount { get; set; }
```

##### Property Value

The vignette amount.

### VignetteMidpoint
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/vignettemidpoint.md

#### XmpCameraRawPackage.VignetteMidpoint property

Gets or sets the Vignetting Midpoint setting. Range 0 to 100.

```csharp
public int? VignetteMidpoint { get; set; }
```

##### Property Value

The Vignette Midpoint.

### WhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/whitebalance.md

#### XmpCameraRawPackage.WhiteBalance property

Gets White Balance setting. Use `SetWhiteBalance` to set white balance value.

```csharp
public string WhiteBalance { get; }
```

##### Property Value

The white balance.

### XmpCameraRawPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/xmpcamerarawpackage.md

#### XmpCameraRawPackage constructor

Initializes a new instance of the `XmpCameraRawPackage` class.

```csharp
public XmpCameraRawPackage()
```

### XmpCropUnit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpcropunit.md

#### XmpCropUnit enumeration

Represent a unit for CropWidth and CropHeight in `XmpCameraRawPackage`.

```csharp
public enum XmpCropUnit
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pixels | `0` | Pixels units. |
| Inches | `1` | Inches units. |
| Cm | `2` | Centimeters units. |

### XmpDublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage.md

#### XmpDublinCorePackage class

Represents the Dublin Core scheme.

```csharp
public sealed class XmpDublinCorePackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpDublinCorePackage() | Initializes a new instance of the `XmpDublinCorePackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Contributors { get; set; } | Gets or sets an array of the contributors. |
| Count { get; } | Gets the number of metadata properties. |
| Coverage { get; set; } | Gets or sets the extent or scope of the resource. |
| Creators { get; set; } | Gets or sets an array of the creators. |
| Dates { get; set; } | Gets or sets an array of dates associated with an event in the life cycle of the resource. |
| Descriptions { get; set; } | Gets or sets an array of textual descriptions of the content of the resource, given in various languages. |
| Format { get; set; } | Gets or sets the MIME type of the resource. |
| Identifier { get; set; } | Gets or sets a string value representing an unambiguous reference to the resource within a given context. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Languages { get; set; } | Gets or sets an array of languages used in the content of the resource. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Publishers { get; set; } | Gets or sets an array of publishers made the resource available. |
| Relations { get; set; } | Gets or sets an array of the related resources. |
| Rights { get; set; } | Gets or sets an array of the informal rights statements, given in various languages. |
| Source { get; set; } | Gets or sets the related resource from which the described resource is derived. |
| Subjects { get; set; } | Gets or sets an array of descriptive phrases or keywords that specify the content of the resource. |
| Titles { get; set; } | Gets or sets the title or name of the resource, given in various languages. |
| Types { get; set; } | Gets or sets an array of string values representing the nature or genre of the resource. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| virtual Set(string, string) | Sets string property. |
| override Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| SetContributor(string) | Sets a single contributor of the resource. |
| SetCreator(string) | Sets a single creator of the resource. |
| SetDate(DateTime) | Sets a single date associated with the resource. |
| SetDescription(string) | Sets the resource description, given in a single laguage. |
| SetLanguage(string) | Sets a single language associated with the resource. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| SetPublisher(string) | Sets a single publisher of the resource. |
| SetRelation(string) | Sets a single related resource. |
| SetRights(string) | Sets the resource rights, given in a single laguage. |
| SetSubject(string) | Sets a single subject of the resource. |
| SetTitle(string) | Sets the resource title, given in a single laguage. |
| SetType(string) | Sets a single type of the resource. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Remarks

For more information see: http://dublincore.org/documents/usageguide/elements.shtml.

### Contributors
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/contributors.md

#### XmpDublinCorePackage.Contributors property

Gets or sets an array of the contributors.

```csharp
public string[] Contributors { get; set; }
```

##### Property Value

An array of the contributors.

##### Remarks

These contributors should not include those listed in dc:creator.

### Creators
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/creators.md

#### XmpDublinCorePackage.Creators property

Gets or sets an array of the creators.

```csharp
public string[] Creators { get; set; }
```

##### Property Value

An array of the creators.

##### Remarks

Entities should be listed in order of decreasing precedence, if such order is significant. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity.

### Dates
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/dates.md

#### XmpDublinCorePackage.Dates property

Gets or sets an array of dates associated with an event in the life cycle of the resource.

```csharp
public DateTime[] Dates { get; set; }
```

##### Property Value

A point or period of time associated with an event in the life cycle of the resource.

### Descriptions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/descriptions.md

#### XmpDublinCorePackage.Descriptions property

Gets or sets an array of textual descriptions of the content of the resource, given in various languages.

```csharp
public XmpLangAlt Descriptions { get; set; }
```

##### Property Value

An array of textual descriptions of the content of the resource, given in various languages.

### Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/format.md

#### XmpDublinCorePackage.Format property

Gets or sets the MIME type of the resource.

```csharp
public string Format { get; set; }
```

##### Property Value

The MIME type of the resource.

### Identifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/identifier.md

#### XmpDublinCorePackage.Identifier property

Gets or sets a string value representing an unambiguous reference to the resource within a given context.

```csharp
public string Identifier { get; set; }
```

##### Property Value

A string value representing an unambiguous reference to the resource within a given context.

##### Remarks

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.

### Languages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/languages.md

#### XmpDublinCorePackage.Languages property

Gets or sets an array of languages used in the content of the resource.

```csharp
public string[] Languages { get; set; }
```

##### Property Value

An array of languages used in the content of the resource.

### Publishers
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/publishers.md

#### XmpDublinCorePackage.Publishers property

Gets or sets an array of publishers made the resource available.

```csharp
public string[] Publishers { get; set; }
```

##### Property Value

An array of publishers made the resource available.

##### Remarks

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity.

### Relations
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/relations.md

#### XmpDublinCorePackage.Relations property

Gets or sets an array of the related resources.

```csharp
public string[] Relations { get; set; }
```

##### Property Value

An array of the related resources.

##### Remarks

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.

### Rights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/rights.md

#### XmpDublinCorePackage.Rights property

Gets or sets an array of the informal rights statements, given in various languages.

```csharp
public XmpLangAlt Rights { get; set; }
```

##### Property Value

An array of the informal rights statements, given in various languages.

##### Remarks

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set.md

#### XmpDublinCorePackage.Set method

Sets the value inherited from `XmpArray` .

```csharp
public override void Set(string name, XmpArray value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### SetContributor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setcontributor.md

#### XmpDublinCorePackage.SetContributor method

Sets a single contributor of the resource.

```csharp
public void SetContributor(string contributor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| contributor | String | The contributor to set. |

### SetCreator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setcreator.md

#### XmpDublinCorePackage.SetCreator method

Sets a single creator of the resource.

```csharp
public void SetCreator(string creator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| creator | String | The creator to set. |

### SetDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setdate.md

#### XmpDublinCorePackage.SetDate method

Sets a single date associated with the resource.

```csharp
public void SetDate(DateTime date)
```

| Parameter | Type | Description |
| --- | --- | --- |
| date | DateTime | The date to set. |

### SetDescription
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setdescription.md

#### XmpDublinCorePackage.SetDescription method

Sets the resource description, given in a single laguage.

```csharp
public void SetDescription(string description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | The description to set. |

### SetLanguage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setlanguage.md

#### XmpDublinCorePackage.SetLanguage method

Sets a single language associated with the resource.

```csharp
public void SetLanguage(string language)
```

| Parameter | Type | Description |
| --- | --- | --- |
| language | String | The language to set. |

### SetPublisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setpublisher.md

#### XmpDublinCorePackage.SetPublisher method

Sets a single publisher of the resource.

```csharp
public void SetPublisher(string publisher)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publisher | String | The publisher to set. |

### SetRelation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setrelation.md

#### XmpDublinCorePackage.SetRelation method

Sets a single related resource.

```csharp
public void SetRelation(string relation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| relation | String | The relation to set. |

### SetRights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setrights.md

#### XmpDublinCorePackage.SetRights method

Sets the resource rights, given in a single laguage.

```csharp
public void SetRights(string rights)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rights | String | The rights statements to set. |

### SetSubject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/setsubject.md

#### XmpDublinCorePackage.SetSubject method

Sets a single subject of the resource.

```csharp
public void SetSubject(string subject)
```

| Parameter | Type | Description |
| --- | --- | --- |
| subject | String | The subject to set. |

### SetTitle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/settitle.md

#### XmpDublinCorePackage.SetTitle method

Sets the resource title, given in a single laguage.

```csharp
public void SetTitle(string title)
```

| Parameter | Type | Description |
| --- | --- | --- |
| title | String | The title to set. |

### SetType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/settype.md

#### XmpDublinCorePackage.SetType method

Sets a single type of the resource.

```csharp
public void SetType(string type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | String | The type to set. |

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/source.md

#### XmpDublinCorePackage.Source property

Gets or sets the related resource from which the described resource is derived.

```csharp
public string Source { get; set; }
```

##### Property Value

The related resource from which the described resource is derived.

##### Remarks

The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.

### Subjects
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/subjects.md

#### XmpDublinCorePackage.Subjects property

Gets or sets an array of descriptive phrases or keywords that specify the content of the resource.

```csharp
public string[] Subjects { get; set; }
```

##### Property Value

An array of descriptive phrases or keywords that specify the content of the resource.

### Titles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/titles.md

#### XmpDublinCorePackage.Titles property

Gets or sets the title or name of the resource, given in various languages.

```csharp
public XmpLangAlt Titles { get; set; }
```

##### Property Value

The title or name of the resource, given in various languages.

### Types
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/types.md

#### XmpDublinCorePackage.Types property

Gets or sets an array of string values representing the nature or genre of the resource.

```csharp
public string[] Types { get; set; }
```

##### Property Value

An array of string values representing the nature or genre of the resource.

### XmpDublinCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/xmpdublincorepackage.md

#### XmpDublinCorePackage constructor

Initializes a new instance of the `XmpDublinCorePackage` class.

```csharp
public XmpDublinCorePackage()
```

### XmpDynamicMediaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage.md

#### XmpDynamicMediaPackage class

Represents XMP Dynamic Media namespace.

```csharp
public sealed class XmpDynamicMediaPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpDynamicMediaPackage() | Initializes a new instance of the `XmpDynamicMediaPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AbsPeakAudioFilePath { get; set; } | Gets or sets the absolute path to the file’s peak audio file. |
| Album { get; set; } | Gets or sets the name of the album. |
| AltTapeName { get; set; } | Gets or sets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| AltTimecode { get; set; } | Gets or sets the timecode set by the user. |
| Artist { get; set; } | Gets or sets the name of the artist or artists. |
| AudioChannelType { get; set; } | Gets or sets the audio channel type. |
| AudioCompressor { get; set; } | Gets or sets the audio compression used. |
| AudioSampleRate { get; set; } | Gets or sets the audio sample rate. |
| AudioSampleType { get; set; } | Gets or sets the audio sample type. |
| CameraAngle { get; set; } | Gets or sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| CameraLabel { get; set; } | Gets or sets the description of the camera used for a shoot. |
| CameraModel { get; set; } | Gets or sets the make and model of the camera used for a shoot. |
| CameraMove { get; set; } | Gets or sets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| Client { get; set; } | Gets or sets the client for the job of which this shot or take is a part. |
| Comment { get; set; } | Gets or sets the user’s comments. |
| Composer { get; set; } | Gets or sets the composer’s names. |
| Count { get; } | Gets the number of metadata properties. |
| Director { get; set; } | Gets or sets the director of the scene. |
| DirectorPhotography { get; set; } | Gets or sets the director of photography for the scene. |
| Duration { get; set; } | Gets or sets the duration of the media file. |
| Engineer { get; set; } | Gets or sets the engineer's names. |
| FileDataRate { get; set; } | Gets or sets the file data rate in megabytes per second. |
| Genre { get; set; } | Gets or sets the name of the genres. |
| Good { get; set; } | Gets or sets a value indicating whether the shot is a keeper. |
| Instrument { get; set; } | Gets or sets the musical instruments. |
| IntroTime { get; set; } | Gets or sets the duration of lead time for queuing music. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Key { get; set; } | Gets or sets the audio’s musical key. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LogComment { get; set; } | Gets or sets the user’s log comments. |
| Loop { get; set; } | Gets or sets a value indicating whether the clip can be looped seamlessly. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| NumberOfBeats { get; set; } | Gets or sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| OutCue { get; set; } | Gets or sets the time at which to fade out. |
| PartOfCompilation { get; set; } | Gets or sets a value indicating whether the resource is a part of compilation. |
| Prefix { get; } | Gets the xmlns prefix. |
| ProjectName { get; set; } | Gets or sets the name of the project of which this file is a part. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RelativeTimestamp { get; set; } | Gets or sets the start time of the media inside the audio project. |
| ReleaseDate { get; set; } | Gets or sets the date the title was released. |
| ShotDate { get; set; } | Gets or sets the date and time when the video was shot. |
| StartTimecode { get; set; } | Gets or sets the timecode of the first frame of video in the file, as obtained from the device control. |
| TakeNumber { get; set; } | Gets or sets a numeric value indicating the absolute number of a take. |
| Tempo { get; set; } | Gets or sets the audio’s tempo. |
| TrackNumber { get; set; } | Gets or sets a numeric value indicating the order of the audio file within its original recording. |
| VideoAlphaPremultipleColor { get; set; } | Gets or sets the timecode of the first frame of video in the file, as obtained from the device control. |
| VideoAlphaUnityIsTransparent { get; set; } | Gets or sets a value indicating whether the unity is clear. |
| VideoFrameRate { get; set; } | Gets or sets the video frame rate. |
| VideoFrameSize { get; set; } | Gets or sets the frame size. |
| VideoPixelAspectRatio { get; set; } | Gets or sets the aspect ratio, expressed as wd/ht. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| override Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| SetAudioChannelType(XmpAudioChannelType) | Sets the audio channel type. |
| SetAudioSampleType(XmpAudioSampleType) | Sets the audio sample type. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AbsPeakAudioFilePath
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/abspeakaudiofilepath.md

#### XmpDynamicMediaPackage.AbsPeakAudioFilePath property

Gets or sets the absolute path to the file’s peak audio file.

```csharp
public string AbsPeakAudioFilePath { get; set; }
```

##### Property Value

The absolute path to the file’s peak audio file. If empty, no peak file exists.

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/album.md

#### XmpDynamicMediaPackage.Album property

Gets or sets the name of the album.

```csharp
public string Album { get; set; }
```

##### Property Value

The name of the album.

### AltTapeName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/alttapename.md

#### XmpDynamicMediaPackage.AltTapeName property

Gets or sets the alternative tape name, set via the project window or timecode dialog in Premiere.

```csharp
public string AltTapeName { get; set; }
```

##### Property Value

The alternative tape name, set via the project window or timecode dialog in Premiere.

### AltTimecode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/alttimecode.md

#### XmpDynamicMediaPackage.AltTimecode property

Gets or sets the timecode set by the user.

```csharp
public XmpTimecode AltTimecode { get; set; }
```

##### Property Value

The timecode set by the user. When specified, it is used instead of the startTimecode.

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/artist.md

#### XmpDynamicMediaPackage.Artist property

Gets or sets the name of the artist or artists.

```csharp
public string Artist { get; set; }
```

##### Property Value

The name of the artist or artists.

### AudioChannelType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audiochanneltype.md

#### XmpDynamicMediaPackage.AudioChannelType property

Gets or sets the audio channel type.

```csharp
public string AudioChannelType { get; set; }
```

##### Property Value

The audio channel type. One of: Mono, Stereo, 5.1, 7.1, 16 Channel, Other

### AudioCompressor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audiocompressor.md

#### XmpDynamicMediaPackage.AudioCompressor property

Gets or sets the audio compression used.

```csharp
public string AudioCompressor { get; set; }
```

##### Property Value

The audio compression used. For example, MP3.

### AudioSampleRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audiosamplerate.md

#### XmpDynamicMediaPackage.AudioSampleRate property

Gets or sets the audio sample rate.

```csharp
public int? AudioSampleRate { get; set; }
```

##### Property Value

The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000.

### AudioSampleType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audiosampletype.md

#### XmpDynamicMediaPackage.AudioSampleType property

Gets or sets the audio sample type.

```csharp
public string AudioSampleType { get; set; }
```

##### Property Value

The audio sample type. One of: 8Int, 16Int, 24Int, 32Int, 32Float, Compressed, Packed, Other.

### CameraAngle
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/cameraangle.md

#### XmpDynamicMediaPackage.CameraAngle property

Gets or sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.

```csharp
public string CameraAngle { get; set; }
```

##### Property Value

The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. Predefined values include: Low Angle, Eye Level, High Angle, Overhead Shot, Birds Eye Shot, Dutch Angle, POV, Over the Shoulder, Reaction Shot.

### CameraLabel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/cameralabel.md

#### XmpDynamicMediaPackage.CameraLabel property

Gets or sets the description of the camera used for a shoot.

```csharp
public string CameraLabel { get; set; }
```

##### Property Value

The description of the camera used for a shoot. Can be any string, but is usually simply a number, for example "1", "2", or more explicitly "Camera 1".

### CameraModel
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/cameramodel.md

#### XmpDynamicMediaPackage.CameraModel property

Gets or sets the make and model of the camera used for a shoot.

```csharp
public string CameraModel { get; set; }
```

##### Property Value

The make and model of the camera used for a shoot.

### CameraMove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/cameramove.md

#### XmpDynamicMediaPackage.CameraMove property

Gets or sets the movement of the camera during the shot, from a fixed set of industry standard terminology.

```csharp
public string CameraMove { get; set; }
```

##### Property Value

The movement of the camera during the shot, from a fixed set of industry standard terminology. Predefined values include: Aerial, Boom Up, Boom Down, Crane Up, Crane Down, Dolly In, Dolly Out, Pan Left, Pan Right, Pedestal Up, Pedestal Down, Tilt Up, Tilt Down, Tracking, Truck Left, Truck Right, Zoom In, Zoom Out.

### Client
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/client.md

#### XmpDynamicMediaPackage.Client property

Gets or sets the client for the job of which this shot or take is a part.

```csharp
public string Client { get; set; }
```

##### Property Value

The client for the job of which this shot or take is a part.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/comment.md

#### XmpDynamicMediaPackage.Comment property

Gets or sets the user’s comments.

```csharp
public string Comment { get; set; }
```

##### Property Value

The user’s comments.

### Composer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/composer.md

#### XmpDynamicMediaPackage.Composer property

Gets or sets the composer’s names.

```csharp
public string Composer { get; set; }
```

##### Property Value

The composer’s names.

### Director
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/director.md

#### XmpDynamicMediaPackage.Director property

Gets or sets the director of the scene.

```csharp
public string Director { get; set; }
```

##### Property Value

The director of the scene.

### DirectorPhotography
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/directorphotography.md

#### XmpDynamicMediaPackage.DirectorPhotography property

Gets or sets the director of photography for the scene.

```csharp
public string DirectorPhotography { get; set; }
```

##### Property Value

The director of photography for the scene.

### Duration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/duration.md

#### XmpDynamicMediaPackage.Duration property

Gets or sets the duration of the media file.

```csharp
public XmpTime Duration { get; set; }
```

##### Property Value

The duration of the media file.

### Engineer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/engineer.md

#### XmpDynamicMediaPackage.Engineer property

Gets or sets the engineer's names.

```csharp
public string Engineer { get; set; }
```

##### Property Value

The engineer's names.

### FileDataRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/filedatarate.md

#### XmpDynamicMediaPackage.FileDataRate property

Gets or sets the file data rate in megabytes per second.

```csharp
public XmpRational FileDataRate { get; set; }
```

##### Property Value

The file data rate in megabytes per second. For example: "36/10" = 3.6 MB/sec.

### Genre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/genre.md

#### XmpDynamicMediaPackage.Genre property

Gets or sets the name of the genres.

```csharp
public string Genre { get; set; }
```

##### Property Value

The name of the genres.

### Good
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/good.md

#### XmpDynamicMediaPackage.Good property

Gets or sets a value indicating whether the shot is a keeper.

```csharp
public bool? Good { get; set; }
```

##### Property Value

A value indicating whether the shot is a keeper.

### Instrument
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/instrument.md

#### XmpDynamicMediaPackage.Instrument property

Gets or sets the musical instruments.

```csharp
public string Instrument { get; set; }
```

##### Property Value

The musical instruments.

### IntroTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/introtime.md

#### XmpDynamicMediaPackage.IntroTime property

Gets or sets the duration of lead time for queuing music.

```csharp
public XmpTime IntroTime { get; set; }
```

##### Property Value

The duration of lead time for queuing music.

### Key
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/key.md

#### XmpDynamicMediaPackage.Key property

Gets or sets the audio’s musical key.

```csharp
public string Key { get; set; }
```

##### Property Value

The audio’s musical key. One of: C, C#, D, D#, E, F, F#, G, G#, A, A#, B.

### LogComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/logcomment.md

#### XmpDynamicMediaPackage.LogComment property

Gets or sets the user’s log comments.

```csharp
public string LogComment { get; set; }
```

##### Property Value

The user’s log comments.

### Loop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/loop.md

#### XmpDynamicMediaPackage.Loop property

Gets or sets a value indicating whether the clip can be looped seamlessly.

```csharp
public bool? Loop { get; set; }
```

##### Property Value

A value indicating whether the clip can be looped seamlessly.

### NumberOfBeats
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/numberofbeats.md

#### XmpDynamicMediaPackage.NumberOfBeats property

Gets or sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

```csharp
public double? NumberOfBeats { get; set; }
```

##### Property Value

The total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

### OutCue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/outcue.md

#### XmpDynamicMediaPackage.OutCue property

Gets or sets the time at which to fade out.

```csharp
public XmpTime OutCue { get; set; }
```

##### Property Value

The time at which to fade out.

### PartOfCompilation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/partofcompilation.md

#### XmpDynamicMediaPackage.PartOfCompilation property

Gets or sets a value indicating whether the resource is a part of compilation.

```csharp
public bool? PartOfCompilation { get; set; }
```

##### Property Value

A value indicating whether the resource is a part of compilation.

### ProjectName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/projectname.md

#### XmpDynamicMediaPackage.ProjectName property

Gets or sets the name of the project of which this file is a part.

```csharp
public string ProjectName { get; set; }
```

##### Property Value

The name of the project of which this file is a part.

### RelativeTimestamp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/relativetimestamp.md

#### XmpDynamicMediaPackage.RelativeTimestamp property

Gets or sets the start time of the media inside the audio project.

```csharp
public XmpTime RelativeTimestamp { get; set; }
```

##### Property Value

The start time of the media inside the audio project.

### ReleaseDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/releasedate.md

#### XmpDynamicMediaPackage.ReleaseDate property

Gets or sets the date the title was released.

```csharp
public DateTime? ReleaseDate { get; set; }
```

##### Property Value

The date the title was released.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/set.md

#### Set(string, string)

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

#### Set(string, XmpComplexType)

Sets the value inherited from `XmpComplexType` .

```csharp
public override void Set(string name, XmpComplexType value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

### SetAudioChannelType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/setaudiochanneltype.md

#### XmpDynamicMediaPackage.SetAudioChannelType method

Sets the audio channel type.

```csharp
public void SetAudioChannelType(XmpAudioChannelType audioChannelType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| audioChannelType | XmpAudioChannelType | The audio channel type. |

### SetAudioSampleType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/setaudiosampletype.md

#### XmpDynamicMediaPackage.SetAudioSampleType method

Sets the audio sample type.

```csharp
public void SetAudioSampleType(XmpAudioSampleType audioSampleType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| audioSampleType | XmpAudioSampleType | The audio sample type. |

### ShotDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/shotdate.md

#### XmpDynamicMediaPackage.ShotDate property

Gets or sets the date and time when the video was shot.

```csharp
public DateTime? ShotDate { get; set; }
```

##### Property Value

The date and time when the video was shot.

### StartTimecode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/starttimecode.md

#### XmpDynamicMediaPackage.StartTimecode property

Gets or sets the timecode of the first frame of video in the file, as obtained from the device control.

```csharp
public XmpTimecode StartTimecode { get; set; }
```

##### Property Value

The timecode of the first frame of video in the file, as obtained from the device control.

### TakeNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/takenumber.md

#### XmpDynamicMediaPackage.TakeNumber property

Gets or sets a numeric value indicating the absolute number of a take.

```csharp
public int? TakeNumber { get; set; }
```

##### Property Value

A numeric value indicating the absolute number of a take.

### Tempo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/tempo.md

#### XmpDynamicMediaPackage.Tempo property

Gets or sets the audio’s tempo.

```csharp
public double? Tempo { get; set; }
```

##### Property Value

The audio’s tempo.

### TrackNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/tracknumber.md

#### XmpDynamicMediaPackage.TrackNumber property

Gets or sets a numeric value indicating the order of the audio file within its original recording.

```csharp
public int? TrackNumber { get; set; }
```

##### Property Value

A numeric value indicating the order of the audio file within its original recording.

### VideoAlphaPremultipleColor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/videoalphapremultiplecolor.md

#### XmpDynamicMediaPackage.VideoAlphaPremultipleColor property

Gets or sets the timecode of the first frame of video in the file, as obtained from the device control.

```csharp
public XmpColorantBase VideoAlphaPremultipleColor { get; set; }
```

##### Property Value

The timecode of the first frame of video in the file, as obtained from the device control.

### VideoAlphaUnityIsTransparent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/videoalphaunityistransparent.md

#### XmpDynamicMediaPackage.VideoAlphaUnityIsTransparent property

Gets or sets a value indicating whether the unity is clear.

```csharp
public bool? VideoAlphaUnityIsTransparent { get; set; }
```

##### Property Value

`true`, if unity is clear; otherwise, it is opaque.

### VideoFrameRate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/videoframerate.md

#### XmpDynamicMediaPackage.VideoFrameRate property

Gets or sets the video frame rate.

```csharp
public double? VideoFrameRate { get; set; }
```

##### Property Value

The video frame rate.

### VideoFrameSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/videoframesize.md

#### XmpDynamicMediaPackage.VideoFrameSize property

Gets or sets the frame size.

```csharp
public XmpDimensions VideoFrameSize { get; set; }
```

##### Property Value

The frame size.

### VideoPixelAspectRatio
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/videopixelaspectratio.md

#### XmpDynamicMediaPackage.VideoPixelAspectRatio property

Gets or sets the aspect ratio, expressed as wd/ht.

```csharp
public XmpRational VideoPixelAspectRatio { get; set; }
```

##### Property Value

The aspect ratio, expressed as wd/ht.

### XmpDynamicMediaPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/xmpdynamicmediapackage.md

#### XmpDynamicMediaPackage constructor

Initializes a new instance of the `XmpDynamicMediaPackage` class.

```csharp
public XmpDynamicMediaPackage()
```

### XmpIptcCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage.md

#### XmpIptcCorePackage class

Represents the IPTC Core XMP package.

```csharp
public sealed class XmpIptcCorePackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpIptcCorePackage() | Initializes a new instance of the `XmpIptcCorePackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| CountryCode { get; set; } | Gets or sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code. |
| IntellectualGenre { get; set; } | Gets or sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Location { get; set; } | Gets or sets the location the content is focusing on. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Scenes { get; set; } | Gets or sets the scene of the photo content. |
| SubjectCodes { get; set; } | Gets or sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| virtual Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### CountryCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/countrycode.md

#### XmpIptcCorePackage.CountryCode property

Gets or sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.

```csharp
public string CountryCode { get; set; }
```

##### Property Value

The country code.

### IntellectualGenre
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/intellectualgenre.md

#### XmpIptcCorePackage.IntellectualGenre property

Gets or sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.

```csharp
public string IntellectualGenre { get; set; }
```

##### Property Value

The intellectual genre.

### Location
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/location.md

#### XmpIptcCorePackage.Location property

Gets or sets the location the content is focusing on.

```csharp
public string Location { get; set; }
```

##### Property Value

The location.

##### Remarks

This location name could either be the name of a sublocation to a city or the name of a well known location or (natural) monument outside a city. In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy.

### Scenes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/scenes.md

#### XmpIptcCorePackage.Scenes property

Gets or sets the scene of the photo content.

```csharp
public string[] Scenes { get; set; }
```

##### Property Value

The scene codes.

##### Remarks

Specifies one or more terms from the IPTC "Scene-NewsCodes". Each Scene is represented as a string of 6 digits in an unordered list

### SubjectCodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/subjectcodes.md

#### XmpIptcCorePackage.SubjectCodes property

Gets or sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

```csharp
public string[] SubjectCodes { get; set; }
```

##### Property Value

The subject codes.

##### Remarks

More about IPTC Subject-NewsCodes at http://www.newscodes.org.

### XmpIptcCorePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/xmpiptccorepackage.md

#### XmpIptcCorePackage constructor

Initializes a new instance of the `XmpIptcCorePackage` class.

```csharp
public XmpIptcCorePackage()
```

### XmpIptcExtensionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage.md

#### XmpIptcExtensionPackage class

Represents the IPTC Extension XMP package.

```csharp
public sealed class XmpIptcExtensionPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpIptcExtensionPackage() | Initializes a new instance of the `XmpIptcExtensionPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AdditionalModelInformation { get; set; } | Gets or sets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| AgesOfModels { get; set; } | Gets or sets ages of the human models at the time this image was taken in a model released image. |
| Count { get; } | Gets the number of metadata properties. |
| DigitalImageGuid { get; set; } | Gets or sets the globally unique identifier for this digital image. |
| DigitalSourceType { get; set; } | Gets or sets the type of the source of this digital image. |
| Event { get; set; } | Gets or sets the description of the specific event at which the photo was taken. |
| IptcLastEdited { get; set; } | Gets or sets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MaxAvailableHeight { get; set; } | Gets or sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| MaxAvailableWidth { get; set; } | Gets or sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| OrganisationInImageCodes { get; set; } | Gets or sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| OrganisationInImageNames { get; set; } | Gets or sets names of the organisations or companies which are featured in the image. |
| PersonsInImage { get; set; } | Gets or sets names of the persons the content of the item is about. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| override Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AdditionalModelInformation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/additionalmodelinformation.md

#### XmpIptcExtensionPackage.AdditionalModelInformation property

Gets or sets the information about the ethnicity and other facets of the model(s) in a model-released image.

```csharp
public string AdditionalModelInformation { get; set; }
```

##### Property Value

The additional model information.

### AgesOfModels
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/agesofmodels.md

#### XmpIptcExtensionPackage.AgesOfModels property

Gets or sets ages of the human models at the time this image was taken in a model released image.

```csharp
public int[] AgesOfModels { get; set; }
```

##### Property Value

Ages of the models.

### DigitalImageGuid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/digitalimageguid.md

#### XmpIptcExtensionPackage.DigitalImageGuid property

Gets or sets the globally unique identifier for this digital image.

```csharp
public string DigitalImageGuid { get; set; }
```

##### Property Value

The image GUID.

##### Remarks

It is created and applied by the creator of the digital image at the time of its creation. This value shall not be changed after that time.

### DigitalSourceType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/digitalsourcetype.md

#### XmpIptcExtensionPackage.DigitalSourceType property

Gets or sets the type of the source of this digital image.

```csharp
public string DigitalSourceType { get; set; }
```

##### Property Value

The type of the source digital file.

### Event
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/event.md

#### XmpIptcExtensionPackage.Event property

Gets or sets the description of the specific event at which the photo was taken.

```csharp
public XmpLangAlt Event { get; set; }
```

##### Property Value

The specific event at which the photo was taken.

### IptcLastEdited
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/iptclastedited.md

#### XmpIptcExtensionPackage.IptcLastEdited property

Gets or sets the date and optionally time when any of the IPTC photo metadata fields has been last edited.

```csharp
public DateTime? IptcLastEdited { get; set; }
```

##### Property Value

The last edited date.

### MaxAvailableHeight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/maxavailableheight.md

#### XmpIptcExtensionPackage.MaxAvailableHeight property

Gets or sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.

```csharp
public int? MaxAvailableHeight { get; set; }
```

##### Property Value

The maximum available height.

### MaxAvailableWidth
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/maxavailablewidth.md

#### XmpIptcExtensionPackage.MaxAvailableWidth property

Gets or sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.

```csharp
public int? MaxAvailableWidth { get; set; }
```

##### Property Value

The maximum available width.

### OrganisationInImageCodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/organisationinimagecodes.md

#### XmpIptcExtensionPackage.OrganisationInImageCodes property

Gets or sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.

```csharp
public string[] OrganisationInImageCodes { get; set; }
```

##### Property Value

The codes of the organisations.

### OrganisationInImageNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/organisationinimagenames.md

#### XmpIptcExtensionPackage.OrganisationInImageNames property

Gets or sets names of the organisations or companies which are featured in the image.

```csharp
public string[] OrganisationInImageNames { get; set; }
```

##### Property Value

Names of the organisations.

### PersonsInImage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/personsinimage.md

#### XmpIptcExtensionPackage.PersonsInImage property

Gets or sets names of the persons the content of the item is about.

```csharp
public string[] PersonsInImage { get; set; }
```

##### Property Value

Names of the persons that are shown in the image.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/set.md

#### Set(string, string)

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

#### Set(string, XmpArray)

Sets the value inherited from `XmpArray` .

```csharp
public override void Set(string name, XmpArray value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpIptcExtensionPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/xmpiptcextensionpackage.md

#### XmpIptcExtensionPackage constructor

Initializes a new instance of the `XmpIptcExtensionPackage` class.

```csharp
public XmpIptcExtensionPackage()
```

### XmpIptcIimPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage.md

#### XmpIptcIimPackage class

Represents the IPTC-IIM XMP package.

```csharp
public sealed class XmpIptcIimPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpIptcIimPackage() | Initializes a new instance of the `XmpIptcIimPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| ActionAdvised { get; set; } | Gets or sets the type of action that this object provides to a previous object. |
| Category { get; set; } | Gets or sets the subject of the object data in the opinion of the provider. |
| ContentLocationCodes { get; set; } | Gets or sets the content location codes. |
| ContentLocationNames { get; set; } | Gets or sets the content location names. |
| Count { get; } | Gets the number of metadata properties. |
| DateSent { get; set; } | Gets or sets the date the service sent the material. |
| Destination { get; set; } | Gets or sets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers. |
| DigitalCreationDate { get; set; } | Gets or sets the date the digital representation of the object data was created. |
| EditStatus { get; set; } | Gets or sets the status of the object data, according to the practice of the provider. |
| EnvelopeNumber { get; set; } | Gets or sets the envelope number. |
| EnvelopePriority { get; set; } | Gets or sets the envelope handling priority. |
| ExpirationDate { get; set; } | Gets or sets the latest date the provider or owner intends the object data to be used. |
| FileFormat { get; set; } | Gets or sets the binary number identifying the version of the Information |
| FileFormatVersion { get; set; } | Gets or sets the file format version. |
| FixtureIdentifier { get; set; } | Gets or sets the object data that recurs often and predictably. |
| ImageOrientation { get; set; } | Gets or sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square). |
| ImageType { get; set; } | Gets or sets the type of the image. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LanguageIdentifier { get; set; } | Gets or sets the language identifier according to the 2-letter codes of ISO 639:1988. |
| MetadataType { get; } | Gets the metadata type. |
| ModelVersion { get; set; } | Gets or sets the binary number identifying the version of the Information |
| NamespaceUri { get; } | Gets the namespace URI. |
| ObjectTypeReference { get; set; } | Gets or sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM. |
| OriginatingProgram { get; set; } | Gets or sets the type of program used to originate the object data. |
| Prefix { get; } | Gets the xmlns prefix. |
| ProductIDs { get; set; } | Gets or sets the product identifiers. |
| ProgramVersion { get; set; } | Gets or sets the program version. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| ReferenceDate { get; set; } | Gets or sets the date of a prior envelope to which the current object refers. |
| ReferenceNumber { get; set; } | Gets or sets the Envelope Number of a prior envelope to which the current object refers. |
| ReferenceService { get; set; } | Gets or sets the Service Identifier of a prior envelope to which the current object refers. |
| ReleaseDate { get; set; } | Gets or sets the earliest date the provider intends the object to be used. |
| ServiceIdentifier { get; set; } | Gets or sets the service identifier. Identifies the provider and product. |
| SupplementalCategories { get; set; } | Gets or sets the supplemental categories. |
| UniqueNameOfObject { get; set; } | Gets or sets the unique name of the object. |
| Urgency { get; set; } | Gets or sets the editorial urgency of the content. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ActionAdvised
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/actionadvised.md

#### XmpIptcIimPackage.ActionAdvised property

Gets or sets the type of action that this object provides to a previous object.

```csharp
public string ActionAdvised { get; set; }
```

##### Property Value

The type of action.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/category.md

#### XmpIptcIimPackage.Category property

Gets or sets the subject of the object data in the opinion of the provider.

```csharp
public string Category { get; set; }
```

##### Property Value

The category.

### ContentLocationCodes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/contentlocationcodes.md

#### XmpIptcIimPackage.ContentLocationCodes property

Gets or sets the content location codes.

```csharp
public string[] ContentLocationCodes { get; set; }
```

##### Property Value

The content location codes.

##### Remarks

Indicates the code of a country/geographical location referenced by the content of the object.

### ContentLocationNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/contentlocationnames.md

#### XmpIptcIimPackage.ContentLocationNames property

Gets or sets the content location names.

```csharp
public string[] ContentLocationNames { get; set; }
```

##### Property Value

The content location names.

##### Remarks

Provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider.

### DateSent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/datesent.md

#### XmpIptcIimPackage.DateSent property

Gets or sets the date the service sent the material.

```csharp
public DateTime? DateSent { get; set; }
```

##### Property Value

The date sent.

### Destination
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/destination.md

#### XmpIptcIimPackage.Destination property

Gets or sets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

```csharp
public string[] Destination { get; set; }
```

##### Property Value

The destination.

### DigitalCreationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/digitalcreationdate.md

#### XmpIptcIimPackage.DigitalCreationDate property

Gets or sets the date the digital representation of the object data was created.

```csharp
public DateTime? DigitalCreationDate { get; set; }
```

##### Property Value

The digital creation date.

### EditStatus
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/editstatus.md

#### XmpIptcIimPackage.EditStatus property

Gets or sets the status of the object data, according to the practice of the provider.

```csharp
public string EditStatus { get; set; }
```

##### Property Value

The edit status.

### EnvelopeNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/envelopenumber.md

#### XmpIptcIimPackage.EnvelopeNumber property

Gets or sets the envelope number.

```csharp
public string EnvelopeNumber { get; set; }
```

##### Property Value

The envelope number.

### EnvelopePriority
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/envelopepriority.md

#### XmpIptcIimPackage.EnvelopePriority property

Gets or sets the envelope handling priority.

```csharp
public int? EnvelopePriority { get; set; }
```

##### Property Value

The envelope priority.

### ExpirationDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/expirationdate.md

#### XmpIptcIimPackage.ExpirationDate property

Gets or sets the latest date the provider or owner intends the object data to be used.

```csharp
public DateTime? ExpirationDate { get; set; }
```

##### Property Value

The expiration date.

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/fileformat.md

#### XmpIptcIimPackage.FileFormat property

Gets or sets the binary number identifying the version of the Information

```csharp
public int? FileFormat { get; set; }
```

##### Property Value

The file format.

### FileFormatVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/fileformatversion.md

#### XmpIptcIimPackage.FileFormatVersion property

Gets or sets the file format version.

```csharp
public int? FileFormatVersion { get; set; }
```

##### Property Value

The file format version.

### FixtureIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/fixtureidentifier.md

#### XmpIptcIimPackage.FixtureIdentifier property

Gets or sets the object data that recurs often and predictably.

```csharp
public string FixtureIdentifier { get; set; }
```

##### Property Value

The fixture identifier.

### ImageOrientation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/imageorientation.md

#### XmpIptcIimPackage.ImageOrientation property

Gets or sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).

```csharp
public string ImageOrientation { get; set; }
```

##### Property Value

The image orientation.

### ImageType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/imagetype.md

#### XmpIptcIimPackage.ImageType property

Gets or sets the type of the image.

```csharp
public string ImageType { get; set; }
```

##### Property Value

The type of the image.

##### Remarks

The first is a numeric character and the second is an alphabetic character.

### LanguageIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/languageidentifier.md

#### XmpIptcIimPackage.LanguageIdentifier property

Gets or sets the language identifier according to the 2-letter codes of ISO 639:1988.

```csharp
public string LanguageIdentifier { get; set; }
```

##### Property Value

The language identifier.

### ModelVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/modelversion.md

#### XmpIptcIimPackage.ModelVersion property

Gets or sets the binary number identifying the version of the Information

```csharp
public int? ModelVersion { get; set; }
```

##### Property Value

The model version.

### ObjectTypeReference
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/objecttypereference.md

#### XmpIptcIimPackage.ObjectTypeReference property

Gets or sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.

```csharp
public string ObjectTypeReference { get; set; }
```

##### Property Value

The object type reference.

### OriginatingProgram
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/originatingprogram.md

#### XmpIptcIimPackage.OriginatingProgram property

Gets or sets the type of program used to originate the object data.

```csharp
public string OriginatingProgram { get; set; }
```

##### Property Value

The originating program.

### ProductIDs
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/productids.md

#### XmpIptcIimPackage.ProductIDs property

Gets or sets the product identifiers.

```csharp
public string[] ProductIDs { get; set; }
```

##### Property Value

The product identifier.

##### Remarks

Used to provide receiving organization data on which to select, route, or otherwise handle data.

### ProgramVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/programversion.md

#### XmpIptcIimPackage.ProgramVersion property

Gets or sets the program version.

```csharp
public string ProgramVersion { get; set; }
```

##### Property Value

The program version.

### ReferenceDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/referencedate.md

#### XmpIptcIimPackage.ReferenceDate property

Gets or sets the date of a prior envelope to which the current object refers.

```csharp
public DateTime? ReferenceDate { get; set; }
```

##### Property Value

The reference date.

### ReferenceNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/referencenumber.md

#### XmpIptcIimPackage.ReferenceNumber property

Gets or sets the Envelope Number of a prior envelope to which the current object refers.

```csharp
public string ReferenceNumber { get; set; }
```

##### Property Value

The reference number.

### ReferenceService
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/referenceservice.md

#### XmpIptcIimPackage.ReferenceService property

Gets or sets the Service Identifier of a prior envelope to which the current object refers.

```csharp
public string ReferenceService { get; set; }
```

##### Property Value

The reference service.

### ReleaseDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/releasedate.md

#### XmpIptcIimPackage.ReleaseDate property

Gets or sets the earliest date the provider intends the object to be used.

```csharp
public DateTime? ReleaseDate { get; set; }
```

##### Property Value

The release date.

### ServiceIdentifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/serviceidentifier.md

#### XmpIptcIimPackage.ServiceIdentifier property

Gets or sets the service identifier. Identifies the provider and product.

```csharp
public string ServiceIdentifier { get; set; }
```

##### Property Value

The service identifier.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/set.md

#### XmpIptcIimPackage.Set method

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

### SupplementalCategories
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/supplementalcategories.md

#### XmpIptcIimPackage.SupplementalCategories property

Gets or sets the supplemental categories.

```csharp
public string[] SupplementalCategories { get; set; }
```

##### Property Value

The supplemental categories.

### UniqueNameOfObject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/uniquenameofobject.md

#### XmpIptcIimPackage.UniqueNameOfObject property

Gets or sets the unique name of the object.

```csharp
public string UniqueNameOfObject { get; set; }
```

##### Property Value

The unique name of the object.

### Urgency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/urgency.md

#### XmpIptcIimPackage.Urgency property

Gets or sets the editorial urgency of the content.

```csharp
public int? Urgency { get; set; }
```

##### Property Value

The urgency.

### XmpIptcIimPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/xmpiptciimpackage.md

#### XmpIptcIimPackage constructor

Initializes a new instance of the `XmpIptcIimPackage` class.

```csharp
public XmpIptcIimPackage()
```

### XmpMediaManagementPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage.md

#### XmpMediaManagementPackage class

Represents the XMP Media Management namespace.

```csharp
public sealed class XmpMediaManagementPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpMediaManagementPackage() | Initializes a new instance of the `XmpMediaManagementPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| DerivedFrom { get; set; } | Gets or sets the reference to the resource from which this one is derived. |
| DocumentID { get; set; } | Gets or sets the common identifier for all versions and renditions of the resource. |
| History { get; set; } | Gets or sets an array of high-level actions that resulted in this resource. |
| Ingredients { get; set; } | Gets or sets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| InstanceID { get; set; } | Gets or sets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| ManagedFrom { get; set; } | Gets or sets the reference to the document as it was prior to becoming managed. |
| Manager { get; set; } | Gets or sets the name of the asset management system that manages this resource. |
| ManagerVariant { get; set; } | Gets or sets the particular variant of the asset management system. |
| ManageTo { get; set; } | Gets or sets the URI identifying the managed resource to the asset management system |
| ManageUI { get; set; } | Gets or sets the URI that can be used to access information about the managed resource through a web browser. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| OriginalDocumentID { get; set; } | Gets or sets the common identifier for the original resource from which the current resource is derived. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RenditionClass { get; set; } | Gets or sets the rendition class name for this resource. |
| RenditionParams { get; set; } | Gets or sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass. |
| VersionID { get; set; } | Gets or sets the document version identifier for this resource. |
| Versions { get; set; } | Gets or sets the version history associated with this resource. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| virtual Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### DerivedFrom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/derivedfrom.md

#### XmpMediaManagementPackage.DerivedFrom property

Gets or sets the reference to the resource from which this one is derived.

```csharp
public XmpResourceRef DerivedFrom { get; set; }
```

##### Property Value

The the reference to the resource from which this one is derived.

### DocumentID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/documentid.md

#### XmpMediaManagementPackage.DocumentID property

Gets or sets the common identifier for all versions and renditions of the resource.

```csharp
public string DocumentID { get; set; }
```

##### Property Value

The common identifier for all versions and renditions of the resource.

### History
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/history.md

#### XmpMediaManagementPackage.History property

Gets or sets an array of high-level actions that resulted in this resource.

```csharp
public XmpResourceEvent[] History { get; set; }
```

##### Property Value

An array of high-level actions that resulted in this resource.

### Ingredients
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/ingredients.md

#### XmpMediaManagementPackage.Ingredients property

Gets or sets the references to resources that were incorporated, by inclusion or reference, into this resource.

```csharp
public XmpResourceRef[] Ingredients { get; set; }
```

##### Property Value

The references to resources that were incorporated, by inclusion or reference, into this resource.

### InstanceID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/instanceid.md

#### XmpMediaManagementPackage.InstanceID property

Gets or sets the identifier for a specific incarnation of a resource, updated each time the file is saved.

```csharp
public string InstanceID { get; set; }
```

##### Property Value

The identifier for a specific incarnation of a resource, updated each time a file is saved.

### ManagedFrom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/managedfrom.md

#### XmpMediaManagementPackage.ManagedFrom property

Gets or sets the reference to the document as it was prior to becoming managed.

```csharp
public XmpResourceRef ManagedFrom { get; set; }
```

##### Property Value

The reference to the document as it was prior to becoming managed.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manager.md

#### XmpMediaManagementPackage.Manager property

Gets or sets the name of the asset management system that manages this resource.

```csharp
public string Manager { get; set; }
```

##### Property Value

The name of the asset management system that manages this resource.

### ManagerVariant
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/managervariant.md

#### XmpMediaManagementPackage.ManagerVariant property

Gets or sets the particular variant of the asset management system.

```csharp
public string ManagerVariant { get; set; }
```

##### Property Value

The particular variant of the asset management system. The format of this property is private to the specific asset management system.

### ManageTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manageto.md

#### XmpMediaManagementPackage.ManageTo property

Gets or sets the URI identifying the managed resource to the asset management system

```csharp
public string ManageTo { get; set; }
```

##### Property Value

The URI identifying the managed resource to the asset management system.

### ManageUI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manageui.md

#### XmpMediaManagementPackage.ManageUI property

Gets or sets the URI that can be used to access information about the managed resource through a web browser.

```csharp
public string ManageUI { get; set; }
```

##### Property Value

The URI that can be used to access information about the managed resource through a web browser.

### OriginalDocumentID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/originaldocumentid.md

#### XmpMediaManagementPackage.OriginalDocumentID property

Gets or sets the common identifier for the original resource from which the current resource is derived.

```csharp
public string OriginalDocumentID { get; set; }
```

##### Property Value

The common identifier for the original resource from which the current resource is derived

### RenditionClass
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/renditionclass.md

#### XmpMediaManagementPackage.RenditionClass property

Gets or sets the rendition class name for this resource.

```csharp
public string RenditionClass { get; set; }
```

##### Property Value

The rendition class name for this resource. This property should be absent or set to default for a resource that is not a derived rendition.

### RenditionParams
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/renditionparams.md

#### XmpMediaManagementPackage.RenditionParams property

Gets or sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass.

```csharp
public string RenditionParams { get; set; }
```

##### Property Value

The value that is used to provide additional rendition parameters.

### VersionID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/versionid.md

#### XmpMediaManagementPackage.VersionID property

Gets or sets the document version identifier for this resource.

```csharp
public string VersionID { get; set; }
```

##### Property Value

The document version identifier for this resource.

### Versions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/versions.md

#### XmpMediaManagementPackage.Versions property

Gets or sets the version history associated with this resource.

```csharp
public XmpVersion[] Versions { get; set; }
```

##### Property Value

The version history associated with this resource. Entry [0] is the oldest known version for this document, entry [Versions.Length - 1] is the most recent version.

### XmpMediaManagementPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/xmpmediamanagementpackage.md

#### XmpMediaManagementPackage constructor

Initializes a new instance of the `XmpMediaManagementPackage` class.

```csharp
public XmpMediaManagementPackage()
```

### XmpPagedTextPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage.md

#### XmpPagedTextPackage class

Represents the XMP Paged-Text package.

```csharp
public sealed class XmpPagedTextPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpPagedTextPackage() | Initializes a new instance of the `XmpPagedTextPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Colorants { get; set; } | Gets or sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| Count { get; } | Gets the number of metadata properties. |
| Fonts { get; set; } | Gets or sets an unordered array of fonts that are used in the document (including any in contained documents). |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MaxPageSize { get; set; } | Gets or sets the size of the largest page in the document (including any in contained documents). |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| NumberOfPages { get; set; } | Gets or sets the number of pages in the document. |
| PlateNames { get; set; } | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| override Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Colorants
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/colorants.md

#### XmpPagedTextPackage.Colorants property

Gets or sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).

```csharp
public XmpColorantBase[] Colorants { get; set; }
```

##### Property Value

An array of the colorants.

### Fonts
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/fonts.md

#### XmpPagedTextPackage.Fonts property

Gets or sets an unordered array of fonts that are used in the document (including any in contained documents).

```csharp
public XmpFont[] Fonts { get; set; }
```

##### Property Value

An array of the fonts.

### MaxPageSize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/maxpagesize.md

#### XmpPagedTextPackage.MaxPageSize property

Gets or sets the size of the largest page in the document (including any in contained documents).

```csharp
public XmpDimensions MaxPageSize { get; set; }
```

##### Property Value

The size of the largest page.

### NumberOfPages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/numberofpages.md

#### XmpPagedTextPackage.NumberOfPages property

Gets or sets the number of pages in the document.

```csharp
public int? NumberOfPages { get; set; }
```

##### Property Value

The number of pages.

### PlateNames
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/platenames.md

#### XmpPagedTextPackage.PlateNames property

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).

```csharp
public string[] PlateNames { get; set; }
```

##### Property Value

The plate names.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/set.md

#### Set(string, string)

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

#### Set(string, XmpArray)

Sets the value inherited from `XmpArray` .

```csharp
public override void Set(string name, XmpArray value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpPagedTextPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/xmppagedtextpackage.md

#### XmpPagedTextPackage constructor

Initializes a new instance of the `XmpPagedTextPackage` class.

```csharp
public XmpPagedTextPackage()
```

### XmpPdfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage.md

#### XmpPdfPackage class

Specifies properties used with Adobe PDF documents.

```csharp
public sealed class XmpPdfPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpPdfPackage() | Initializes a new instance of the `XmpPdfPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| IsTrapped { get; set; } | Gets or sets a value indicating whether the document has been trapped. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Keywords { get; set; } | Gets or sets the keywords. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| PdfVersion { get; set; } | Gets or sets the PDF file version. For example, 1.0, 1.3 and so on. |
| Prefix { get; } | Gets the xmlns prefix. |
| Producer { get; set; } | Gets or sets the name of the tool that created the PDF document. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### IsTrapped
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/istrapped.md

#### XmpPdfPackage.IsTrapped property

Gets or sets a value indicating whether the document has been trapped.

```csharp
public bool? IsTrapped { get; set; }
```

##### Property Value

`true` if the document has been trapped; otherwise, `false`.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/keywords.md

#### XmpPdfPackage.Keywords property

Gets or sets the keywords.

```csharp
public string Keywords { get; set; }
```

##### Property Value

The keywords.

### PdfVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/pdfversion.md

#### XmpPdfPackage.PdfVersion property

Gets or sets the PDF file version. For example, 1.0, 1.3 and so on.

```csharp
public string PdfVersion { get; set; }
```

##### Property Value

The PDF version.

### Producer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/producer.md

#### XmpPdfPackage.Producer property

Gets or sets the name of the tool that created the PDF document.

```csharp
public string Producer { get; set; }
```

##### Property Value

The producer.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/set.md

#### XmpPdfPackage.Set method

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

### XmpPdfPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/xmppdfpackage.md

#### XmpPdfPackage constructor

Initializes a new instance of the `XmpPdfPackage` class.

```csharp
public XmpPdfPackage()
```

### XmpPhotoshopColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshopcolormode.md

#### XmpPhotoshopColorMode enumeration

Represents a color mode in `XmpPhotoshopPackage`.

```csharp
public enum XmpPhotoshopColorMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Bitmap | `0` | The bitmap color mode. |
| GrayScale | `1` | The gray scale color mode. |
| IndexedColor | `2` | The indexed color. |
| Rgb | `3` | The RGB color mode. |
| Cmyk | `4` | The CMYK color mode. |
| MultiChannel | `7` | The multi-channel color mode. |
| Duotone | `8` | The duo-tone color mode. |
| LabColor | `9` | The LAB color mode. |

### XmpPhotoshopPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage.md

#### XmpPhotoshopPackage class

Represents Adobe Photoshop namespace.

```csharp
public sealed class XmpPhotoshopPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpPhotoshopPackage() | Initializes a new instance of the `XmpPhotoshopPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| AuthorsPosition { get; set; } | Gets or sets the by-line title. |
| CaptionWriter { get; set; } | Gets or sets the writer/editor. |
| Category { get; set; } | Gets or sets the category. Limited to 3 7-bit ASCII characters. |
| City { get; set; } | Gets or sets the city. |
| ColorMode { get; set; } | Gets or sets the color mode. |
| Count { get; } | Gets the number of metadata properties. |
| Country { get; set; } | Gets or sets the country. |
| Credit { get; set; } | Gets or sets the credit. |
| DateCreated { get; set; } | Gets or sets the date the intellectual content of the document was created. |
| Headline { get; set; } | Gets or sets the headline. |
| History { get; set; } | Gets or sets the history that appears in the FileInfo panel, if activated in the application preferences. |
| IccProfile { get; set; } | Gets or sets the color profile, such as AppleRGB, AdobeRGB1998. |
| Instructions { get; set; } | Gets or sets the special instructions. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Source { get; set; } | Gets or sets the source. |
| State { get; set; } | Gets or sets the province/state. |
| SupplementalCategories { get; set; } | Gets or sets the supplemental categories. |
| TransmissionReference { get; set; } | Gets or sets the original transmission reference. |
| Urgency { get; set; } | Gets or sets the urgency. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

#### Fields

| Name | Description |
| --- | --- |
| const UrgencyMax | Urgency max value. |
| const UrgencyMin | Urgency min value. |

### AuthorsPosition
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/authorsposition.md

#### XmpPhotoshopPackage.AuthorsPosition property

Gets or sets the by-line title.

```csharp
public string AuthorsPosition { get; set; }
```

##### Property Value

The authors position.

### CaptionWriter
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/captionwriter.md

#### XmpPhotoshopPackage.CaptionWriter property

Gets or sets the writer/editor.

```csharp
public string CaptionWriter { get; set; }
```

##### Property Value

The caption writer.

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/category.md

#### XmpPhotoshopPackage.Category property

Gets or sets the category. Limited to 3 7-bit ASCII characters.

```csharp
public string Category { get; set; }
```

##### Property Value

The category. Limited to 3 ASCII characters.

### City
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/city.md

#### XmpPhotoshopPackage.City property

Gets or sets the city.

```csharp
public string City { get; set; }
```

##### Property Value

The city.

### ColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/colormode.md

#### XmpPhotoshopPackage.ColorMode property

Gets or sets the color mode.

```csharp
public XmpPhotoshopColorMode? ColorMode { get; set; }
```

##### Property Value

The color mode.

### Country
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/country.md

#### XmpPhotoshopPackage.Country property

Gets or sets the country.

```csharp
public string Country { get; set; }
```

##### Property Value

The country.

### Credit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/credit.md

#### XmpPhotoshopPackage.Credit property

Gets or sets the credit.

```csharp
public string Credit { get; set; }
```

##### Property Value

The credit.

### DateCreated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/datecreated.md

#### XmpPhotoshopPackage.DateCreated property

Gets or sets the date the intellectual content of the document was created.

```csharp
public DateTime? DateCreated { get; set; }
```

##### Property Value

The created date of the document.

### Headline
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/headline.md

#### XmpPhotoshopPackage.Headline property

Gets or sets the headline.

```csharp
public string Headline { get; set; }
```

##### Property Value

The headline.

### History
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/history.md

#### XmpPhotoshopPackage.History property

Gets or sets the history that appears in the FileInfo panel, if activated in the application preferences.

```csharp
public string History { get; set; }
```

##### Property Value

The history.

### IccProfile
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/iccprofile.md

#### XmpPhotoshopPackage.IccProfile property

Gets or sets the color profile, such as AppleRGB, AdobeRGB1998.

```csharp
public string IccProfile { get; set; }
```

##### Property Value

The ICC profile.

### Instructions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/instructions.md

#### XmpPhotoshopPackage.Instructions property

Gets or sets the special instructions.

```csharp
public string Instructions { get; set; }
```

##### Property Value

The special instructions.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/set.md

#### XmpPhotoshopPackage.Set method

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/source.md

#### XmpPhotoshopPackage.Source property

Gets or sets the source.

```csharp
public string Source { get; set; }
```

##### Property Value

The source.

### State
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/state.md

#### XmpPhotoshopPackage.State property

Gets or sets the province/state.

```csharp
public string State { get; set; }
```

##### Property Value

The province/state.

### SupplementalCategories
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/supplementalcategories.md

#### XmpPhotoshopPackage.SupplementalCategories property

Gets or sets the supplemental categories.

```csharp
public string[] SupplementalCategories { get; set; }
```

##### Property Value

The supplemental categories.

### TransmissionReference
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/transmissionreference.md

#### XmpPhotoshopPackage.TransmissionReference property

Gets or sets the original transmission reference.

```csharp
public string TransmissionReference { get; set; }
```

##### Property Value

The transmission reference.

### Urgency
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgency.md

#### XmpPhotoshopPackage.Urgency property

Gets or sets the urgency.

```csharp
public int? Urgency { get; set; }
```

##### Property Value

The urgency.

##### Remarks

Valid range is 1-8.

### UrgencyMax
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgencymax.md

#### XmpPhotoshopPackage.UrgencyMax field

Urgency max value.

```csharp
public const int UrgencyMax;
```

### UrgencyMin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgencymin.md

#### XmpPhotoshopPackage.UrgencyMin field

Urgency min value.

```csharp
public const int UrgencyMin;
```

### XmpPhotoshopPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/xmpphotoshoppackage.md

#### XmpPhotoshopPackage constructor

Initializes a new instance of the `XmpPhotoshopPackage` class.

```csharp
public XmpPhotoshopPackage()
```

### XmpRightsManagementPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage.md

#### XmpRightsManagementPackage class

Represents XMP Rights Management namespace.

```csharp
public sealed class XmpRightsManagementPackage : XmpPackage
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpRightsManagementPackage() | Initializes a new instance of the `XmpRightsManagementPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Certificate { get; set; } | Gets or sets the Web URL for a rights management certificate. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Marked { get; set; } | Gets or sets a value indicating whether this is a rights-managed resource. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Owners { get; set; } | Gets or sets the legal owners. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| UsageTerms { get; set; } | Gets or sets the instructions on how the resource can be legally used, given in a variety of languages. |
| WebStatement { get; set; } | Gets or sets the Web URL for a statement of the ownership and usage rights for this resource. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| override Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Certificate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/certificate.md

#### XmpRightsManagementPackage.Certificate property

Gets or sets the Web URL for a rights management certificate.

```csharp
public string Certificate { get; set; }
```

##### Property Value

The Web URL for a rights management certificate.

### Marked
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/marked.md

#### XmpRightsManagementPackage.Marked property

Gets or sets a value indicating whether this is a rights-managed resource.

```csharp
public bool? Marked { get; set; }
```

##### Property Value

`true` if the resource is rights-managed; otherwise `false`. When false, indicates that this is a public-domain resource. Omit if the state is unknown.

### Owners
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/owners.md

#### XmpRightsManagementPackage.Owners property

Gets or sets the legal owners.

```csharp
public string[] Owners { get; set; }
```

##### Property Value

The legal owners.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/set.md

#### XmpRightsManagementPackage.Set method

Sets string property.

```csharp
public override void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

### UsageTerms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/usageterms.md

#### XmpRightsManagementPackage.UsageTerms property

Gets or sets the instructions on how the resource can be legally used, given in a variety of languages.

```csharp
public XmpLangAlt UsageTerms { get; set; }
```

##### Property Value

The instructions on how the resource can be legally used, given in a variety of languages.

### WebStatement
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/webstatement.md

#### XmpRightsManagementPackage.WebStatement property

Gets or sets the Web URL for a statement of the ownership and usage rights for this resource.

```csharp
public string WebStatement { get; set; }
```

##### Property Value

The Web URL for a statement of the ownership and usage rights for this resource.

### XmpRightsManagementPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/xmprightsmanagementpackage.md

#### XmpRightsManagementPackage constructor

Initializes a new instance of the `XmpRightsManagementPackage` class.

```csharp
public XmpRightsManagementPackage()
```

### XmpTimeFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat.md

#### XmpTimeFormat class

Represents time format in `XmpTimecode`.

```csharp
public sealed class XmpTimeFormat : XmpClosedChoice<string>
```

#### Properties

| Name | Description |
| --- | --- |
| static DropTimecode2997 { get; } | Gets 2997DropTimecode. |
| static DropTimecode5994 { get; } | Gets 5994DropTimecode. |
| static NonDropTimecode2997 { get; } | Gets 2997NonDropTimecode. |
| static NonDropTimecode5994 { get; } | Gets 5994NonDropTimecode. |
| static Timecode23976 { get; } | Gets 23976Timecode. |
| static Timecode24 { get; } | Gets 24Timecode. |
| static Timecode25 { get; } | Gets 25Timecode. |
| static Timecode30 { get; } | Gets 30Timecode. |
| static Timecode50 { get; } | Gets 50Timecode. |
| static Timecode60 { get; } | Gets 60Timecode. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) |  |
| Equals(XmpClosedChoice&lt;string&gt;) |  |
| override GetHashCode() |  |
| override ToString() |  |

### DropTimecode2997
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/droptimecode2997.md

#### XmpTimeFormat.DropTimecode2997 property

Gets 2997DropTimecode.

```csharp
public static XmpTimeFormat DropTimecode2997 { get; }
```

##### Property Value

The drop timecode2997.

### DropTimecode5994
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/droptimecode5994.md

#### XmpTimeFormat.DropTimecode5994 property

Gets 5994DropTimecode.

```csharp
public static XmpTimeFormat DropTimecode5994 { get; }
```

##### Property Value

The 5994DropTimecode.

### NonDropTimecode2997
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/nondroptimecode2997.md

#### XmpTimeFormat.NonDropTimecode2997 property

Gets 2997NonDropTimecode.

```csharp
public static XmpTimeFormat NonDropTimecode2997 { get; }
```

### NonDropTimecode5994
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/nondroptimecode5994.md

#### XmpTimeFormat.NonDropTimecode5994 property

Gets 5994NonDropTimecode.

```csharp
public static XmpTimeFormat NonDropTimecode5994 { get; }
```

##### Property Value

The 5994NonDropTimecode.

### Timecode23976
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode23976.md

#### XmpTimeFormat.Timecode23976 property

Gets 23976Timecode.

```csharp
public static XmpTimeFormat Timecode23976 { get; }
```

##### Property Value

The 23976Timecode.

### Timecode24
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode24.md

#### XmpTimeFormat.Timecode24 property

Gets 24Timecode.

```csharp
public static XmpTimeFormat Timecode24 { get; }
```

##### Property Value

The 24Timecode.

### Timecode25
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode25.md

#### XmpTimeFormat.Timecode25 property

Gets 25Timecode.

```csharp
public static XmpTimeFormat Timecode25 { get; }
```

##### Property Value

The 25Timecode.

### Timecode30
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode30.md

#### XmpTimeFormat.Timecode30 property

Gets 30Timecode.

```csharp
public static XmpTimeFormat Timecode30 { get; }
```

##### Property Value

The 30Timecode.

### Timecode50
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode50.md

#### XmpTimeFormat.Timecode50 property

Gets 50Timecode.

```csharp
public static XmpTimeFormat Timecode50 { get; }
```

##### Property Value

The 50Timecode.

### Timecode60
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode60.md

#### XmpTimeFormat.Timecode60 property

Gets 60Timecode.

```csharp
public static XmpTimeFormat Timecode60 { get; }
```

##### Property Value

The 60Timecode.

### XmpWhiteBalance
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance.md

#### XmpWhiteBalance class

Represents the White Balance setting in `XmpCameraRawPackage`.

```csharp
public sealed class XmpWhiteBalance : XmpClosedChoice<string>
```

#### Properties

| Name | Description |
| --- | --- |
| static AsShot { get; } | White balance: As Shot. |
| static Auto { get; } | White balance: Auto. |
| static Cloudy { get; } | White balance: Cloudy. |
| static Custom { get; } | White balance: Custom. |
| static Daylight { get; } | White balance: Daylight. |
| static Flash { get; } | White balance: Flash. |
| static Fluorescent { get; } | White balance: Fluorescent. |
| static Shade { get; } | White balance: Shade. |
| static Tungsten { get; } | White balance: Tungsten. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) |  |
| Equals(XmpClosedChoice&lt;string&gt;) |  |
| override GetHashCode() |  |
| override ToString() |  |

### AsShot
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/asshot.md

#### XmpWhiteBalance.AsShot property

White balance: As Shot.

```csharp
public static XmpWhiteBalance AsShot { get; }
```

##### Property Value

As shot.

### Auto
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/auto.md

#### XmpWhiteBalance.Auto property

White balance: Auto.

```csharp
public static XmpWhiteBalance Auto { get; }
```

##### Property Value

The automatic.

### Cloudy
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/cloudy.md

#### XmpWhiteBalance.Cloudy property

White balance: Cloudy.

```csharp
public static XmpWhiteBalance Cloudy { get; }
```

##### Property Value

Cloudy.

### Custom
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/custom.md

#### XmpWhiteBalance.Custom property

White balance: Custom.

```csharp
public static XmpWhiteBalance Custom { get; }
```

##### Property Value

Custom.

### Daylight
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/daylight.md

#### XmpWhiteBalance.Daylight property

White balance: Daylight.

```csharp
public static XmpWhiteBalance Daylight { get; }
```

##### Property Value

Daylight.

### Flash
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/flash.md

#### XmpWhiteBalance.Flash property

White balance: Flash.

```csharp
public static XmpWhiteBalance Flash { get; }
```

##### Property Value

Flash.

### Fluorescent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/fluorescent.md

#### XmpWhiteBalance.Fluorescent property

White balance: Fluorescent.

```csharp
public static XmpWhiteBalance Fluorescent { get; }
```

##### Property Value

Fluorescent.

### Shade
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/shade.md

#### XmpWhiteBalance.Shade property

White balance: Shade.

```csharp
public static XmpWhiteBalance Shade { get; }
```

##### Property Value

Shade.

### Tungsten
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/tungsten.md

#### XmpWhiteBalance.Tungsten property

White balance: Tungsten.

```csharp
public static XmpWhiteBalance Tungsten { get; }
```

##### Property Value

Tungsten.

### GroupDocs.Metadata.Standards.Xmp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp.md

The namespace provides functionality for XMP (Extensible Metadata Platform) metadata reading and writing.

#### Classes

| Class | Description |
| --- | --- |
| XmpArray | Represents base abstraction for XMP array. |
| XmpBoolean | Represents XMP Boolean basic type. |
| XmpClosedChoice&lt;T&gt; | Represents XMP Closed Choice. |
| XmpColorantBase | A structure containing the characteristics of a colorant (swatch) used in a document. |
| XmpColorantCmyk | Represents the CMYK Colorant. |
| XmpColorantLab | Represents the LAB Colorant. |
| XmpColorantRgb | Represents the RGB Colorant. |
| XmpComplexType | Represents base abstraction for XMP Complex value type. |
| XmpComplexTypeValue | Represents an XMP value containing a complex type instance. |
| XmpDate | Represents Date in XMP packet. |
| XmpDimensions | Containing dimensions for a drawn object. |
| XmpElementBase | Represents base XMP element that contains attributes. |
| XmpFont | A structure containing the characteristics of a font used in a document. |
| XmpGuid | Represents XMP global unique identifier. |
| XmpHeaderPI | Represents XMP header processing instruction. |
| XmpInteger | Represents XMP Integer basic type. |
| XmpJob | Represents Job. |
| XmpLangAlt | Represents XMP Language Alternative. |
| XmpMeta | Represents xmpmeta. Optional. The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF. |
| XmpMetadataContainer | Represents a container for XMP metadata properties. |
| XmpNamespaces | Contains namespaces used in `XmpPackage` and `XmpComplexType`. |
| XmpPackage | Represents base abstraction for XMP package. |
| XmpPacketWrapper | Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element. |
| XmpRational | Represents XMP XmpRational. |
| XmpReal | Represents XMP Real. |
| XmpRenditionClass | Represents XMP RenditionClass. |
| XmpResourceEvent | Represents a high-level event that occurred in the processing of a resource. |
| XmpResourceRef | Represents a multiple part reference to a resource.  Used to indicate prior versions, originals of renditions, originals for derived documents, and so on. |
| XmpSchemes | Provides access to known XMP schemes. |
| XmpText | Represents XMP Text basic type. |
| XmpThumbnail | Represents a thumbnail image for a file. |
| XmpTime | Representation of a time value in seconds. |
| XmpTimecode | Represents a timecode value in a video. |
| XmpTrailerPI | Represents XMP trailer processing instruction. |
| XmpValueBase | Represents base XMP value. |
| XmpVersion | Represents a version of a document. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IXmp | Defines base operations intended to work with XMP metadata. |
| IXmpType | Base interface for XMP type. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| XmpArrayType | Represents array type in `XmpArray`. |
| XmpColorantColorMode | Represents color mode in `XmpColorantBase`. |
| XmpColorType | Type of color in `XmpColorantBase`. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### IXmp
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/ixmp.md

#### IXmp interface

Defines base operations intended to work with XMP metadata.

```csharp
public interface IXmp
```

#### Properties

| Name | Description |
| --- | --- |
| XmpPackage { get; set; } | Gets or sets the XMP metadata package. |

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.PngWithXmp))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null && root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/ixmp/xmppackage.md

#### IXmp.XmpPackage property

Gets or sets the XMP metadata package.

```csharp
public XmpPacketWrapper XmpPackage { get; set; }
```

##### Property Value

The XMP metadata package.

##### Examples

This code sample shows how to remove XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.JpegWithXmp))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null)
    {
        root.XmpPackage = null;
        metadata.Save(Constants.OutputJpeg);
    }
}
```

### IXmpType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/ixmptype.md

#### IXmpType interface

Base interface for XMP type.

```csharp
public interface IXmpType
```

#### Methods

| Name | Description |
| --- | --- |
| GetXmpRepresentation() | Converts the XMP value to the XML representation. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/ixmptype/getxmprepresentation.md

#### IXmpType.GetXmpRepresentation method

Converts the XMP value to the XML representation.

```csharp
public string GetXmpRepresentation()
```

##### Return Value

A String representation of the XMP value.

### XmpArray
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray.md

#### XmpArray class

Represents base abstraction for XMP array.

```csharp
public class XmpArray : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpArray(XmpArrayType, XmpComplexType[]) | Initializes a new instance of the `XmpArray` class. |
| XmpArray(XmpArrayType, XmpValueBase[]) | Initializes a new instance of the `XmpArray` class. |

#### Properties

| Name | Description |
| --- | --- |
| ArrayType { get; } | Gets the type of the XMP array. |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| static From(DateTime[], XmpArrayType) | Creates an `XmpArray` instance form a date array. |
| static From(double[], XmpArrayType) | Creates an `XmpArray` instance form a double array. |
| static From(int[], XmpArrayType) | Creates an `XmpArray` instance form an integer array. |
| static From(string[], XmpArrayType) | Creates an `XmpArray` instance form a string array. |
| static From&lt;T&gt;(T[], XmpArrayType) | Creates an `XmpArray` instance form an array of `XmpComplexType`. |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Converts XMP value to the xml representation. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| ToPlatformArray&lt;T&gt;() | Converts the `XmpArray` to a platform-specific array. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### ArrayType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray/arraytype.md

#### XmpArray.ArrayType property

Gets the type of the XMP array.

```csharp
public XmpArrayType ArrayType { get; }
```

##### Property Value

The type of the XMP array.

### From
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray/from.md

#### From&lt;T&gt;(T[], XmpArrayType)

Creates an `XmpArray` instance form an array of `XmpComplexType`.

```csharp
public static XmpArray From<T>(T[] array, XmpArrayType type)
    where T : XmpComplexType
```

| Parameter | Description |
| --- | --- |
| T | The element type of the source array. |
| array | The array to create an `XmpArray` from. |
| type | The type of the `XmpArray`. |

##### Return Value

An `XmpArray` containing all the elements from the original array.

#### From(string[], XmpArrayType)

Creates an `XmpArray` instance form a string array.

```csharp
public static XmpArray From(string[] array, XmpArrayType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | String[] | The array to create an `XmpArray` from. |
| type | XmpArrayType | The type of the `XmpArray`. |

##### Return Value

An `XmpArray` containing all the elements from the original array.

#### From(int[], XmpArrayType)

Creates an `XmpArray` instance form an integer array.

```csharp
public static XmpArray From(int[] array, XmpArrayType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Int32[] | The array to create an `XmpArray` from. |
| type | XmpArrayType | The type of the `XmpArray`. |

##### Return Value

An `XmpArray` containing all the elements from the original array.

#### From(DateTime[], XmpArrayType)

Creates an `XmpArray` instance form a date array.

```csharp
public static XmpArray From(DateTime[] array, XmpArrayType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | DateTime[] | The array to create an `XmpArray` from. |
| type | XmpArrayType | The type of the `XmpArray`. |

##### Return Value

An `XmpArray` containing all the elements from the original array.

#### From(double[], XmpArrayType)

Creates an `XmpArray` instance form a double array.

```csharp
public static XmpArray From(double[] array, XmpArrayType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Double[] | The array to create an `XmpArray` from. |
| type | XmpArrayType | The type of the `XmpArray`. |

##### Return Value

An `XmpArray` containing all the elements from the original array.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray/getxmprepresentation.md

#### XmpArray.GetXmpRepresentation method

Converts XMP value to the xml representation.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

Returns String representation of XMP value.

### ToPlatformArray
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray/toplatformarray.md

#### XmpArray.ToPlatformArray&lt;T&gt; method

Converts the `XmpArray` to a platform-specific array.

```csharp
public T[] ToPlatformArray<T>()
```

| Parameter | Description |
| --- | --- |
| T | The type of the array element. |

##### Return Value

A platform-specific array containing elements of the `XmpArray`.

### XmpArray
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparray/xmparray.md

#### XmpArray(XmpArrayType, XmpValueBase[])

Initializes a new instance of the `XmpArray` class.

```csharp
public XmpArray(XmpArrayType arrayType, XmpValueBase[] items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpValueBase[] | Array items. |

#### XmpArray(XmpArrayType, XmpComplexType[])

Initializes a new instance of the `XmpArray` class.

```csharp
public XmpArray(XmpArrayType arrayType, XmpComplexType[] items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpComplexType[] | Array items. |

### XmpArrayType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmparraytype.md

#### XmpArrayType enumeration

Represents array type in `XmpArray`.

```csharp
public enum XmpArrayType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unordered | `0` | An unordered array. |
| Ordered | `1` | An ordered array. |
| Alternative | `2` | An alternative array. |

### XmpBoolean
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpboolean.md

#### XmpBoolean class

Represents XMP Boolean basic type.

```csharp
public sealed class XmpBoolean : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpBoolean() | Initializes a new instance of the `XmpBoolean` class with default value. |
| XmpBoolean(bool) | Initializes a new instance of the `XmpBoolean` class based on boolean value. |
| XmpBoolean(string) | Initializes a new instance of the `XmpBoolean` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpboolean/getxmprepresentation.md

#### XmpBoolean.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpboolean/value.md

#### XmpBoolean.Value property

Gets the value.

```csharp
public bool Value { get; }
```

##### Property Value

Boolean value.

### XmpBoolean
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpboolean/xmpboolean.md

#### XmpBoolean(bool)

Initializes a new instance of the `XmpBoolean` class based on boolean value.

```csharp
public XmpBoolean(bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Boolean | Boolean value. |

#### XmpBoolean()

Initializes a new instance of the `XmpBoolean` class with default value.

```csharp
public XmpBoolean()
```

#### XmpBoolean(string)

Initializes a new instance of the `XmpBoolean` class.

```csharp
public XmpBoolean(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

### XmpClosedChoiceT
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpclosedchoice-1.md

#### XmpClosedChoice&lt;T&gt; class

Represents XMP Closed Choice.

```csharp
public abstract class XmpClosedChoice<T> : IEquatable<XmpClosedChoice>
```

| Parameter | Description |
| --- | --- |
| T | Type of closed choice. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Indicates whether the current object is equal to another object of the same type. |
| Equals(XmpClosedChoice) |  |
| override GetHashCode() | Returns a hash code for this instance. |
| override ToString() | Returns a String that represents this instance. |

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpclosedchoice-1/equals.md

#### Equals(object)

Indicates whether the current object is equal to another object of the same type.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | An object to compare with this object. |

##### Return Value

true if the current object is equal to the *obj* parameter; otherwise, false.

#### Equals(XmpClosedChoice)

```csharp
public bool Equals(XmpClosedChoice other)
```

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpclosedchoice-1/gethashcode.md

#### XmpClosedChoice&lt;T&gt;.GetHashCode method

Returns a hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpclosedchoice-1/tostring.md

#### XmpClosedChoice&lt;T&gt;.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### XmpColorantBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantbase.md

#### XmpColorantBase class

A structure containing the characteristics of a colorant (swatch) used in a document.

```csharp
public class XmpColorantBase : XmpComplexType
```

#### Properties

| Name | Description |
| --- | --- |
| ColorType { get; set; } | Gets or sets the type of color. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Mode { get; } | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SwatchName { get; set; } | Gets or sets the name of the swatch. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ColorType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantbase/colortype.md

#### XmpColorantBase.ColorType property

Gets or sets the type of color.

```csharp
public XmpColorType? ColorType { get; set; }
```

##### Property Value

The color type.

### Mode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantbase/mode.md

#### XmpColorantBase.Mode property

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.

```csharp
public XmpColorantColorMode Mode { get; }
```

##### Property Value

The color mode.

### SwatchName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantbase/swatchname.md

#### XmpColorantBase.SwatchName property

Gets or sets the name of the swatch.

```csharp
public string SwatchName { get; set; }
```

##### Property Value

The name of the swatch.

### XmpColorantCmyk
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk.md

#### XmpColorantCmyk class

Represents the CMYK Colorant.

```csharp
public sealed class XmpColorantCmyk : XmpColorantBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpColorantCmyk() | Initializes a new instance of the `XmpColorantCmyk` class. |
| XmpColorantCmyk(double, double, double, double) | Initializes a new instance of the `XmpColorantCmyk` class. |

#### Properties

| Name | Description |
| --- | --- |
| Black { get; set; } | Gets or sets the black component. |
| ColorType { get; set; } | Gets or sets the type of color. |
| Count { get; } | Gets the number of metadata properties. |
| Cyan { get; set; } | Gets or sets the cyan component. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Magenta { get; set; } | Gets or sets the magenta component. |
| MetadataType { get; } | Gets the metadata type. |
| Mode { get; } | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SwatchName { get; set; } | Gets or sets the name of the swatch. |
| Yellow { get; set; } | Gets or sets the yellow component. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

#### Fields

| Name | Description |
| --- | --- |
| const ColorValueMax | Color max value in CMYK colorant. |
| const ColorValueMin | Color min value in CMYK colorant. |

### Black
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/black.md

#### XmpColorantCmyk.Black property

Gets or sets the black component.

```csharp
public double? Black { get; set; }
```

##### Property Value

The black value.

### ColorValueMax
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/colorvaluemax.md

#### XmpColorantCmyk.ColorValueMax field

Color max value in CMYK colorant.

```csharp
public const double ColorValueMax;
```

### ColorValueMin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/colorvaluemin.md

#### XmpColorantCmyk.ColorValueMin field

Color min value in CMYK colorant.

```csharp
public const double ColorValueMin;
```

### Cyan
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/cyan.md

#### XmpColorantCmyk.Cyan property

Gets or sets the cyan component.

```csharp
public double? Cyan { get; set; }
```

##### Property Value

The cyan value.

### Magenta
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/magenta.md

#### XmpColorantCmyk.Magenta property

Gets or sets the magenta component.

```csharp
public double? Magenta { get; set; }
```

##### Property Value

The magenta value.

### XmpColorantCmyk
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/xmpcolorantcmyk.md

#### XmpColorantCmyk()

Initializes a new instance of the `XmpColorantCmyk` class.

```csharp
public XmpColorantCmyk()
```

#### XmpColorantCmyk(double, double, double, double)

Initializes a new instance of the `XmpColorantCmyk` class.

```csharp
public XmpColorantCmyk(double cyan, double magenta, double yellow, double black)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cyan | Double | Cyan component. |
| magenta | Double | Magenta component. |
| yellow | Double | Yellow component. |
| black | Double | Black component. |

### Yellow
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/yellow.md

#### XmpColorantCmyk.Yellow property

Gets or sets the yellow component.

```csharp
public double? Yellow { get; set; }
```

##### Property Value

The yellow value.

### XmpColorantColorMode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantcolormode.md

#### XmpColorantColorMode enumeration

Represents color mode in `XmpColorantBase`.

```csharp
public enum XmpColorantColorMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | The color mode is undefined. |
| Cmyk | `1` | CMYK color mode. |
| Rgb | `2` | RGB color mode. |
| Lab | `3` | LAB color mode. |

### XmpColorantLab
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab.md

#### XmpColorantLab class

Represents the LAB Colorant.

```csharp
public sealed class XmpColorantLab : XmpColorantBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpColorantLab() | Initializes a new instance of the `XmpColorantLab` class. |
| XmpColorantLab(sbyte, sbyte, double) | Initializes a new instance of the `XmpColorantLab` class. |

#### Properties

| Name | Description |
| --- | --- |
| A { get; set; } | Gets or sets the A component. |
| B { get; set; } | Gets or sets the B component. |
| ColorType { get; set; } | Gets or sets the type of color. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| L { get; set; } | Gets or sets the L component. |
| MetadataType { get; } | Gets the metadata type. |
| Mode { get; } | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SwatchName { get; set; } | Gets or sets the name of the swatch. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

#### Fields

| Name | Description |
| --- | --- |
| const MaxL | Component L max value. |
| const MinL | Component L min value. |

### A
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/a.md

#### XmpColorantLab.A property

Gets or sets the A component.

```csharp
public sbyte? A { get; set; }
```

##### Property Value

The A component.

### B
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/b.md

#### XmpColorantLab.B property

Gets or sets the B component.

```csharp
public sbyte? B { get; set; }
```

##### Property Value

The B component.

### L
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/l.md

#### XmpColorantLab.L property

Gets or sets the L component.

```csharp
public double? L { get; set; }
```

##### Property Value

The L component.

### MaxL
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/maxl.md

#### XmpColorantLab.MaxL field

Component L max value.

```csharp
public const double MaxL;
```

### MinL
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/minl.md

#### XmpColorantLab.MinL field

Component L min value.

```csharp
public const double MinL;
```

### XmpColorantLab
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantlab/xmpcolorantlab.md

#### XmpColorantLab()

Initializes a new instance of the `XmpColorantLab` class.

```csharp
public XmpColorantLab()
```

#### XmpColorantLab(sbyte, sbyte, double)

Initializes a new instance of the `XmpColorantLab` class.

```csharp
public XmpColorantLab(sbyte a, sbyte b, double l)
```

| Parameter | Type | Description |
| --- | --- | --- |
| a | SByte | A component. |
| b | SByte | B component. |
| l | Double | L component. |

### XmpColorantRgb
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantrgb.md

#### XmpColorantRgb class

Represents the RGB Colorant.

```csharp
public sealed class XmpColorantRgb : XmpColorantBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpColorantRgb() | Initializes a new instance of the `XmpColorantRgb` class. |
| XmpColorantRgb(byte, byte, byte) | Initializes a new instance of the `XmpColorantRgb` class. |

#### Properties

| Name | Description |
| --- | --- |
| Blue { get; set; } | Gets or sets the blue component. |
| ColorType { get; set; } | Gets or sets the type of color. |
| Count { get; } | Gets the number of metadata properties. |
| Green { get; set; } | Gets or sets the green value. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Mode { get; } | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Red { get; set; } | Gets or sets the red component. |
| SwatchName { get; set; } | Gets or sets the name of the swatch. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Blue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/blue.md

#### XmpColorantRgb.Blue property

Gets or sets the blue component.

```csharp
public byte? Blue { get; set; }
```

##### Property Value

The blue component.

### Green
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/green.md

#### XmpColorantRgb.Green property

Gets or sets the green value.

```csharp
public byte? Green { get; set; }
```

##### Property Value

The green component.

### Red
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/red.md

#### XmpColorantRgb.Red property

Gets or sets the red component.

```csharp
public byte? Red { get; set; }
```

##### Property Value

The red component.

### XmpColorantRgb
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/xmpcolorantrgb.md

#### XmpColorantRgb()

Initializes a new instance of the `XmpColorantRgb` class.

```csharp
public XmpColorantRgb()
```

#### XmpColorantRgb(byte, byte, byte)

Initializes a new instance of the `XmpColorantRgb` class.

```csharp
public XmpColorantRgb(byte red, byte green, byte blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red component. |
| green | Byte | Green component. |
| blue | Byte | Blue component. |

### XmpColorType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcolortype.md

#### XmpColorType enumeration

Type of color in `XmpColorantBase`.

```csharp
public enum XmpColorType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Process | `1` | The Process color type. |
| Spot | `2` | The Spot color type. |

### XmpComplexType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype.md

#### XmpComplexType class

Represents base abstraction for XMP Complex value type.

```csharp
public class XmpComplexType : XmpMetadataContainer
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Remarks

See more: XMP Specification Part 2, Chapter 1.2.2

### GetNamespaceUri
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype/getnamespaceuri.md

#### XmpComplexType.GetNamespaceUri method

Gets the namespace URI associated with the specified prefix.

```csharp
public string GetNamespaceUri(string prefix)
```

| Parameter | Type | Description |
| --- | --- | --- |
| prefix | String | The prefix of the namespace to get. |

##### Return Value

The associated namespace URI if the prefix is registered; otherwise, null.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype/getxmprepresentation.md

#### XmpComplexType.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### NamespaceUris
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype/namespaceuris.md

#### XmpComplexType.NamespaceUris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.

```csharp
public string[] NamespaceUris { get; }
```

##### Property Value

The namespace URIs.

### Prefixes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype/prefixes.md

#### XmpComplexType.Prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.

```csharp
public string[] Prefixes { get; }
```

##### Property Value

The namespace prefixes.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextype/tostring.md

#### XmpComplexType.ToString method

Returns a String that represents this instance.

```csharp
public override string ToString()
```

##### Return Value

A String that represents this instance.

### XmpComplexTypeValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue.md

#### XmpComplexTypeValue class

Represents an XMP value containing a complex type instance.

```csharp
public class XmpComplexTypeValue : XmpValueBase
```

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue/getxmprepresentation.md

#### XmpComplexTypeValue.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### XmpDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate.md

#### XmpDate class

Represents Date in XMP packet.

```csharp
public sealed class XmpDate : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpDate(DateTime) | Initializes a new instance of the `XmpDate` class. |
| XmpDate(string) | Initializes a new instance of the `XmpDate` class. |

#### Properties

| Name | Description |
| --- | --- |
| Format { get; } | Gets format string for current value. |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

#### Fields

| Name | Description |
| --- | --- |
| const Iso8601Format | The ISO 8601 (roundtrip) format string. |

##### Remarks

A date-time value is represented using a subset of the formats as defined in Date and Time Formats: YYYY YYYY-MM YYYY-MM-DD YYYY-MM-DDThh:mmTZD YYYY-MM-DDThh:mm:ssTZD YYYY-MM-DDThh:mm:ss.sTZD

### Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate/format.md

#### XmpDate.Format property

Gets format string for current value.

```csharp
public string Format { get; }
```

##### Property Value

XMP date format string.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate/getxmprepresentation.md

#### XmpDate.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Iso8601Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate/iso8601format.md

#### XmpDate.Iso8601Format field

The ISO 8601 (roundtrip) format string.

```csharp
public const string Iso8601Format;
```

##### Remarks

See more: https://en.wikipedia.org/wiki/ISO_8601.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate/value.md

#### XmpDate.Value property

Gets the value.

```csharp
public DateTime Value { get; }
```

##### Property Value

DateTime value.

### XmpDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdate/xmpdate.md

#### XmpDate(DateTime)

Initializes a new instance of the `XmpDate` class.

```csharp
public XmpDate(DateTime dateTime)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dateTime | DateTime | DateTime value. |

#### XmpDate(string)

Initializes a new instance of the `XmpDate` class.

```csharp
public XmpDate(string dateString)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dateString | String | Date in string representation. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Invalid date format. |

### XmpDimensions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdimensions.md

#### XmpDimensions class

Containing dimensions for a drawn object.

```csharp
public sealed class XmpDimensions : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpDimensions() | Initializes a new instance of the `XmpDimensions` class. |
| XmpDimensions(double, double) | Initializes a new instance of the `XmpDimensions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Height { get; set; } | Gets or sets the height. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Units { get; set; } | Gets or sets the units. |
| Width { get; set; } | Gets or sets the width. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdimensions/height.md

#### XmpDimensions.Height property

Gets or sets the height.

```csharp
public double? Height { get; set; }
```

##### Property Value

The height.

### Units
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdimensions/units.md

#### XmpDimensions.Units property

Gets or sets the units.

```csharp
public string Units { get; set; }
```

##### Property Value

The units.

##### Examples

For example: inch, mm, pixel, pica, point etc.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdimensions/width.md

#### XmpDimensions.Width property

Gets or sets the width.

```csharp
public double? Width { get; set; }
```

##### Property Value

The width.

### XmpDimensions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpdimensions/xmpdimensions.md

#### XmpDimensions()

Initializes a new instance of the `XmpDimensions` class.

```csharp
public XmpDimensions()
```

#### XmpDimensions(double, double)

Initializes a new instance of the `XmpDimensions` class.

```csharp
public XmpDimensions(double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Double | The width. |
| height | Double | The height. |

### XmpElementBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpelementbase.md

#### XmpElementBase class

Represents base XMP element that contains attributes.

```csharp
public abstract class XmpElementBase : CustomPackage
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAttributes() | Removes all attributes. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| ContainsAttribute(string) | Determines whether the element contains a specific attribute. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetAttribute(string) | Gets the attribute. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetAttribute(string, string) | Adds the attribute. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ClearAttributes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpelementbase/clearattributes.md

#### XmpElementBase.ClearAttributes method

Removes all attributes.

```csharp
public void ClearAttributes()
```

### ContainsAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpelementbase/containsattribute.md

#### XmpElementBase.ContainsAttribute method

Determines whether the element contains a specific attribute.

```csharp
public bool ContainsAttribute(string attribute)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attribute | String | Attribute name. |

##### Return Value

true if attribute is exist; otherwise false.

### GetAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpelementbase/getattribute.md

#### XmpElementBase.GetAttribute method

Gets the attribute.

```csharp
public string GetAttribute(string attribute)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attribute | String | The attribute. |

##### Return Value

The attribute value.

### SetAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpelementbase/setattribute.md

#### XmpElementBase.SetAttribute method

Adds the attribute.

```csharp
public virtual void SetAttribute(string attribute, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attribute | String | Attribute key. |
| value | String | Attribute value. |

### XmpFont
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont.md

#### XmpFont class

A structure containing the characteristics of a font used in a document.

```csharp
public sealed class XmpFont : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpFont() | Initializes a new instance of the `XmpFont` class. |
| XmpFont(string) | Initializes a new instance of the `XmpFont` class. |

#### Properties

| Name | Description |
| --- | --- |
| ChildFontFiles { get; set; } | Gets or sets the list of file names for the fonts that make up a composite font. |
| Count { get; } | Gets the number of metadata properties. |
| FontFace { get; set; } | Gets or sets the font face name. |
| FontFamily { get; set; } | Gets or sets the font family name. |
| FontFileName { get; set; } | Gets or sets the font file name (not a complete path). |
| FontName { get; set; } | Gets or sets the PostScript name of the font. |
| FontType { get; set; } | Gets or sets the font type. |
| IsComposite { get; set; } | Gets or sets a value indicating whether whether the font is composite. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Version { get; set; } | Gets or sets the font version. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ChildFontFiles
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/childfontfiles.md

#### XmpFont.ChildFontFiles property

Gets or sets the list of file names for the fonts that make up a composite font.

```csharp
public string[] ChildFontFiles { get; set; }
```

##### Property Value

The list of file names for the fonts that make up a composite font.

### FontFace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/fontface.md

#### XmpFont.FontFace property

Gets or sets the font face name.

```csharp
public string FontFace { get; set; }
```

##### Property Value

The font face name.

### FontFamily
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/fontfamily.md

#### XmpFont.FontFamily property

Gets or sets the font family name.

```csharp
public string FontFamily { get; set; }
```

##### Property Value

The font family name.

### FontFileName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/fontfilename.md

#### XmpFont.FontFileName property

Gets or sets the font file name (not a complete path).

```csharp
public string FontFileName { get; set; }
```

##### Property Value

The name of the font file.

### FontName
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/fontname.md

#### XmpFont.FontName property

Gets or sets the PostScript name of the font.

```csharp
public string FontName { get; set; }
```

##### Property Value

The PostScript name of the font.

### FontType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/fonttype.md

#### XmpFont.FontType property

Gets or sets the font type.

```csharp
public string FontType { get; set; }
```

##### Property Value

The font type.

##### Remarks

TrueType, Type 1, Open Type, and so on.

### IsComposite
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/iscomposite.md

#### XmpFont.IsComposite property

Gets or sets a value indicating whether whether the font is composite.

```csharp
public bool? IsComposite { get; set; }
```

##### Property Value

`true` if the font is composite; otherwise, `false`.

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/version.md

#### XmpFont.Version property

Gets or sets the font version.

```csharp
public string Version { get; set; }
```

##### Property Value

The version.

##### Remarks

/version for Type1 fonts nameId 5 for Apple True Type and OpenType /CIDFontVersion for CID fonts The empty string for bitmap fonts

### XmpFont
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpfont/xmpfont.md

#### XmpFont()

Initializes a new instance of the `XmpFont` class.

```csharp
public XmpFont()
```

#### XmpFont(string)

Initializes a new instance of the `XmpFont` class.

```csharp
public XmpFont(string fontFamily)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontFamily | String | Font family. |

### XmpGuid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpguid.md

#### XmpGuid class

Represents XMP global unique identifier.

```csharp
public sealed class XmpGuid : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpGuid(Guid) | Initializes a new instance of the `XmpGuid` class. |
| XmpGuid(string) | Initializes a new instance of the `XmpGuid` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpguid/getxmprepresentation.md

#### XmpGuid.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpguid/value.md

#### XmpGuid.Value property

Gets the value.

```csharp
public Guid Value { get; }
```

##### Property Value

The value.

### XmpGuid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpguid/xmpguid.md

#### XmpGuid(string)

Initializes a new instance of the `XmpGuid` class.

```csharp
public XmpGuid(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid GUID value. |

#### XmpGuid(Guid)

Initializes a new instance of the `XmpGuid` class.

```csharp
public XmpGuid(Guid value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Guid | The unique identifier. |

### XmpHeaderPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpheaderpi.md

#### XmpHeaderPI class

Represents XMP header processing instruction.

```csharp
public sealed class XmpHeaderPI : IXmpType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpHeaderPI() | Initializes a new instance of the `XmpHeaderPI` class. |

#### Properties

| Name | Description |
| --- | --- |
| Guid { get; } | Represents Header GUID. |

#### Methods

| Name | Description |
| --- | --- |
| GetXmpRepresentation() | Converts XMP value to the xml representation. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpheaderpi/getxmprepresentation.md

#### XmpHeaderPI.GetXmpRepresentation method

Converts XMP value to the xml representation.

```csharp
public string GetXmpRepresentation()
```

##### Return Value

Returns String representation of XMP value.

### Guid
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpheaderpi/guid.md

#### XmpHeaderPI.Guid property

Represents Header GUID.

```csharp
public string Guid { get; }
```

##### Property Value

The unique identifier.

##### Remarks

The text of the header PI contains a GUID, making it unlikely to appear by accident in the data stream.

### XmpHeaderPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpheaderpi/xmpheaderpi.md

#### XmpHeaderPI constructor

Initializes a new instance of the `XmpHeaderPI` class.

```csharp
public XmpHeaderPI()
```

### XmpInteger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpinteger.md

#### XmpInteger class

Represents XMP Integer basic type.

```csharp
public sealed class XmpInteger : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpInteger(int) | Initializes a new instance of the `XmpInteger` class. |
| XmpInteger(long) | Initializes a new instance of the `XmpInteger` class. |
| XmpInteger(string) | Initializes a new instance of the `XmpInteger` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpinteger/getxmprepresentation.md

#### XmpInteger.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpinteger/value.md

#### XmpInteger.Value property

Gets the value.

```csharp
public long Value { get; }
```

##### Property Value

Integer value.

### XmpInteger
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpinteger/xmpinteger.md

#### XmpInteger(long)

Initializes a new instance of the `XmpInteger` class.

```csharp
public XmpInteger(long value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int64 | The value. |

#### XmpInteger(int)

Initializes a new instance of the `XmpInteger` class.

```csharp
public XmpInteger(int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int32 | The value. |

#### XmpInteger(string)

Initializes a new instance of the `XmpInteger` class.

```csharp
public XmpInteger(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | String value contained integer. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

### XmpJob
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpjob.md

#### XmpJob class

Represents Job.

```csharp
public sealed class XmpJob : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpJob() | Initializes a new instance of the `XmpJob` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| ID { get; set; } | Gets or sets unique id for the job. This field is a reference into some external job management system. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Name { get; set; } | Gets or sets informal name of the job. This name is for user display and informal systems. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Url { get; set; } | Gets or sets a file URL referencing an external job management file. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### ID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpjob/id.md

#### XmpJob.ID property

Gets or sets unique id for the job. This field is a reference into some external job management system.

```csharp
public string ID { get; set; }
```

##### Property Value

The identifier.

### Name
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpjob/name.md

#### XmpJob.Name property

Gets or sets informal name of the job. This name is for user display and informal systems.

```csharp
public string Name { get; set; }
```

##### Property Value

The name.

### Url
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpjob/url.md

#### XmpJob.Url property

Gets or sets a file URL referencing an external job management file.

```csharp
public string Url { get; set; }
```

##### Property Value

The URL.

### XmpJob
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpjob/xmpjob.md

#### XmpJob constructor

Initializes a new instance of the `XmpJob` class.

```csharp
public XmpJob()
```

### XmpLangAlt
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt.md

#### XmpLangAlt class

Represents XMP Language Alternative.

An alternative array of simple text items. Language alternatives facilitate the selection of a simple text item based on a desired language. Each array item shall have an xml:lang qualifier. Each xml:lang value shall be unique among the items.

```csharp
public sealed class XmpLangAlt : XmpArray
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpLangAlt(IDictionary&lt;string, string&gt;) | Initializes a new instance of the `XmpLangAlt` class. |
| XmpLangAlt(string) | Initializes a new instance of the `XmpLangAlt` class. |

#### Properties

| Name | Description |
| --- | --- |
| ArrayType { get; } | Gets the type of the XMP array. |
| Item { get; } | Gets the value associated with the specified language. |
| Languages { get; } | Gets an array of all languages registered in the instance of `XmpLangAlt`. |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| Contains(string) | Determines whether the `XmpLangAlt` contains the specified language. |
| override GetXmpRepresentation() | Converts XMP value to the xml representation. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| ToPlatformArray&lt;T&gt;() | Converts the `XmpArray` to a platform-specific array. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### Contains
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt/contains.md

#### XmpLangAlt.Contains method

Determines whether the `XmpLangAlt` contains the specified language.

```csharp
public bool Contains(string language)
```

| Parameter | Type | Description |
| --- | --- | --- |
| language | String | The language to locate in the `XmpLangAlt`. |

##### Return Value

True if the `XmpLangAlt` contains an element with the specified language; otherwise, false.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt/getxmprepresentation.md

#### XmpLangAlt.GetXmpRepresentation method

Converts XMP value to the xml representation.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

Returns String representation of XMP value.

### Item
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt/item.md

#### XmpLangAlt indexer

Gets the value associated with the specified language.

```csharp
public string this[string language] { get; }
```

| Parameter | Description |
| --- | --- |
| language | The language. |

##### Return Value

Value for the specified language.

##### Property Value

String value.

### Languages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt/languages.md

#### XmpLangAlt.Languages property

Gets an array of all languages registered in the instance of `XmpLangAlt`.

```csharp
public string[] Languages { get; }
```

##### Property Value

An array of all languages registered in the instance of `XmpLangAlt`.

### XmpLangAlt
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmplangalt/xmplangalt.md

#### XmpLangAlt(string)

Initializes a new instance of the `XmpLangAlt` class.

```csharp
public XmpLangAlt(string defaultValue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| defaultValue | String | The default value. |

#### XmpLangAlt(IDictionary&lt;string, string&gt;)

Initializes a new instance of the `XmpLangAlt` class.

```csharp
public XmpLangAlt(IDictionary<string, string> dictionary)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | IDictionary`2 | A dictionary containing values by languages. |

### XmpMeta
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmeta.md

#### XmpMeta class

Represents xmpmeta. Optional. The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF.

```csharp
public sealed class XmpMeta : XmpElementBase, IXmpType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpMeta() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AdobeXmpToolkit { get; } | Gets Adobe XMP toolkit version. |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearAttributes() | Removes all attributes. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| ContainsAttribute(string) | Determines whether the element contains a specific attribute. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetAttribute(string) | Gets the attribute. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetXmpRepresentation() | Converts XMP value to the xml representation. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| override SetAttribute(string, string) | Adds an attribute. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AdobeXmpToolkit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmeta/adobexmptoolkit.md

#### XmpMeta.AdobeXmpToolkit property

Gets Adobe XMP toolkit version.

```csharp
public string AdobeXmpToolkit { get; }
```

##### Property Value

The toolkit version.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmeta/getxmprepresentation.md

#### XmpMeta.GetXmpRepresentation method

Converts XMP value to the xml representation.

```csharp
public string GetXmpRepresentation()
```

##### Return Value

Returns String representation of XMP value.

### SetAttribute
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmeta/setattribute.md

#### XmpMeta.SetAttribute method

Adds an attribute.

```csharp
public override void SetAttribute(string attribute, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attribute | String | The attribute. |
| value | String | The value. |

### XmpMeta
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmeta/xmpmeta.md

#### XmpMeta constructor

The default constructor.

```csharp
public XmpMeta()
```

### XmpMetadataContainer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer.md

#### XmpMetadataContainer class

Represents a container for XMP metadata properties.

```csharp
public abstract class XmpMetadataContainer : CustomPackage, IXmpType
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| abstract GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/getxmprepresentation.md

#### XmpMetadataContainer.GetXmpRepresentation method

Converts the XMP value to the XML representation.

```csharp
public abstract string GetXmpRepresentation()
```

##### Return Value

A String representation of the XMP value.

### XmpNamespaces
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces.md

#### XmpNamespaces class

Contains namespaces used in `XmpPackage` and `XmpComplexType`.

```csharp
public static class XmpNamespaces
```

#### Fields

| Name | Description |
| --- | --- |
| const BasicJob | Basic Job Ticket namespace. |
| const CameraRaw | Camera Raw namespace. |
| const DublinCore | Dublin Core namespace. |
| const Iptc4XmpCore | IPTC Core namespace. |
| const Iptc4XmpExt | IPTC Extension namespace. |
| const Iptc4XmpIim | IPTC IIM namespace. |
| const PagedText | XMP Paged-Text namespace. |
| const Pdf | Adobe PDF namespace. |
| const Photoshop | Adobe Photoshop namespace. |
| const Rdf | Resource definition framework namespace. |
| const Xml | Xml namespace. |
| const XmpBasic | XMP Basic namespace. |
| const XmpDM | XMP Dynamic Media namespace. |
| const XmpGraphics | XMP graphics namespace. |
| const XmpGraphicsThumbnail | XMP graphics namespace. |
| const XmpMM | XMP digital asset management namespace. |
| const XmpRights | XMP Rights Management namespace. |
| const XmpTypeDimensions | XMP Dimensions type. |
| const XmpTypeFont | XMP Font type. |
| const XmpTypeJob | XMP Job Ticket. |
| const XmpTypeResourceEvent | XMP ResourceEvent URI. |
| const XmpTypeResourceRef | XMP ResourceRef URI. |
| const XmpTypeVersion | XMP Version. |

### BasicJob
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/basicjob.md

#### XmpNamespaces.BasicJob field

Basic Job Ticket namespace.

```csharp
public const string BasicJob;
```

### CameraRaw
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/cameraraw.md

#### XmpNamespaces.CameraRaw field

Camera Raw namespace.

```csharp
public const string CameraRaw;
```

### DublinCore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/dublincore.md

#### XmpNamespaces.DublinCore field

Dublin Core namespace.

```csharp
public const string DublinCore;
```

### Iptc4XmpCore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc4xmpcore.md

#### XmpNamespaces.Iptc4XmpCore field

IPTC Core namespace.

```csharp
public const string Iptc4XmpCore;
```

### Iptc4XmpExt
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc4xmpext.md

#### XmpNamespaces.Iptc4XmpExt field

IPTC Extension namespace.

```csharp
public const string Iptc4XmpExt;
```

### Iptc4XmpIim
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc4xmpiim.md

#### XmpNamespaces.Iptc4XmpIim field

IPTC IIM namespace.

```csharp
public const string Iptc4XmpIim;
```

### PagedText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/pagedtext.md

#### XmpNamespaces.PagedText field

XMP Paged-Text namespace.

```csharp
public const string PagedText;
```

### Pdf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/pdf.md

#### XmpNamespaces.Pdf field

Adobe PDF namespace.

```csharp
public const string Pdf;
```

### Photoshop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/photoshop.md

#### XmpNamespaces.Photoshop field

Adobe Photoshop namespace.

```csharp
public const string Photoshop;
```

### Rdf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/rdf.md

#### XmpNamespaces.Rdf field

Resource definition framework namespace.

```csharp
public const string Rdf;
```

### Xml
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xml.md

#### XmpNamespaces.Xml field

Xml namespace.

```csharp
public const string Xml;
```

### XmpBasic
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmpbasic.md

#### XmpNamespaces.XmpBasic field

XMP Basic namespace.

```csharp
public const string XmpBasic;
```

### XmpDM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmpdm.md

#### XmpNamespaces.XmpDM field

XMP Dynamic Media namespace.

```csharp
public const string XmpDM;
```

### XmpGraphics
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmpgraphics.md

#### XmpNamespaces.XmpGraphics field

XMP graphics namespace.

```csharp
public const string XmpGraphics;
```

### XmpGraphicsThumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmpgraphicsthumbnail.md

#### XmpNamespaces.XmpGraphicsThumbnail field

XMP graphics namespace.

```csharp
public const string XmpGraphicsThumbnail;
```

### XmpMM
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmpmm.md

#### XmpNamespaces.XmpMM field

XMP digital asset management namespace.

```csharp
public const string XmpMM;
```

### XmpRights
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmprights.md

#### XmpNamespaces.XmpRights field

XMP Rights Management namespace.

```csharp
public const string XmpRights;
```

### XmpTypeDimensions
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptypedimensions.md

#### XmpNamespaces.XmpTypeDimensions field

XMP Dimensions type.

```csharp
public const string XmpTypeDimensions;
```

### XmpTypeFont
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptypefont.md

#### XmpNamespaces.XmpTypeFont field

XMP Font type.

```csharp
public const string XmpTypeFont;
```

### XmpTypeJob
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptypejob.md

#### XmpNamespaces.XmpTypeJob field

XMP Job Ticket.

```csharp
public const string XmpTypeJob;
```

### XmpTypeResourceEvent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptyperesourceevent.md

#### XmpNamespaces.XmpTypeResourceEvent field

XMP ResourceEvent URI.

```csharp
public const string XmpTypeResourceEvent;
```

### XmpTypeResourceRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptyperesourceref.md

#### XmpNamespaces.XmpTypeResourceRef field

XMP ResourceRef URI.

```csharp
public const string XmpTypeResourceRef;
```

### XmpTypeVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmptypeversion.md

#### XmpNamespaces.XmpTypeVersion field

XMP Version.

```csharp
public const string XmpTypeVersion;
```

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage.md

#### XmpPackage class

Represents base abstraction for XMP package.

```csharp
public class XmpPackage : XmpMetadataContainer
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpPackage(string, string) | Initializes a new instance of the `XmpPackage` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUri { get; } | Gets the namespace URI. |
| Prefix { get; } | Gets the xmlns prefix. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| XmlNamespace { get; } | Gets the XML namespace. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Clear() | Removes all XMP properties. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| override GetXmpRepresentation() | Converts the XMP value to the XML representation. |
| Remove(string) | Removes the property with the specified name. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| Set(string, bool) | Sets boolean property. |
| Set(string, DateTime) | Sets DateTime property. |
| Set(string, double) | Sets double property. |
| Set(string, int) | Sets integer property. |
| virtual Set(string, string) | Sets string property. |
| virtual Set(string, XmpArray) | Sets the value inherited from `XmpArray` . |
| virtual Set(string, XmpComplexType) | Sets the value inherited from `XmpComplexType` . |
| Set(string, XmpValueBase) | Sets the value inherited from `XmpValueBase` . |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example demonstrates how to add a custom XMP package to a file of any supported format.

```csharp
using (Metadata metadata = new Metadata(Constants.InputJpeg))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null)
    {
        var packet = new XmpPacketWrapper();

        var custom = new XmpPackage("gd", "https://groupdocs.com");
        custom.Set("gd:Copyright", "Copyright (C) 2011-2026 GroupDocs. All Rights Reserved.");
        custom.Set("gd:CreationDate", DateTime.Today);
        custom.Set("gd:Company", XmpArray.From(new [] { "Aspose", "GroupDocs" }, XmpArrayType.Ordered));

        packet.AddPackage(custom);
        root.XmpPackage = packet;

        metadata.Save(Constants.OutputJpeg);
    }
}
```

### Clear
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/clear.md

#### XmpPackage.Clear method

Removes all XMP properties.

```csharp
public void Clear()
```

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/getxmprepresentation.md

#### XmpPackage.GetXmpRepresentation method

Converts the XMP value to the XML representation.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

A String representation of the XMP value.

### NamespaceUri
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/namespaceuri.md

#### XmpPackage.NamespaceUri property

Gets the namespace URI.

```csharp
public string NamespaceUri { get; }
```

##### Property Value

The namespace URI.

### Prefix
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/prefix.md

#### XmpPackage.Prefix property

Gets the xmlns prefix.

```csharp
public string Prefix { get; }
```

##### Property Value

The prefix.

### Remove
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/remove.md

#### XmpPackage.Remove method

Removes the property with the specified name.

```csharp
public bool Remove(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |

##### Return Value

True if the specified metadata property is found and removed; otherwise, false.

### Set
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/set.md

#### Set(string, string)

Sets string property.

```csharp
public virtual void Set(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | String | XMP metadata property value. |

#### Set(string, XmpArray)

Sets the value inherited from `XmpArray` .

```csharp
public virtual void Set(string name, XmpArray value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

#### Set(string, XmpComplexType)

Sets the value inherited from `XmpComplexType` .

```csharp
public virtual void Set(string name, XmpComplexType value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

#### Set(string, int)

Sets integer property.

```csharp
public void Set(string name, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | Int32 | XMP metadata property value. |

#### Set(string, bool)

Sets boolean property.

```csharp
public void Set(string name, bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | Boolean | XMP metadata property value. |

#### Set(string, DateTime)

Sets DateTime property.

```csharp
public void Set(string name, DateTime value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | DateTime | XMP metadata property value. |

#### Set(string, double)

Sets double property.

```csharp
public void Set(string name, double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | Double | XMP metadata property value. |

#### Set(string, XmpValueBase)

Sets the value inherited from `XmpValueBase` .

```csharp
public void Set(string name, XmpValueBase value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | XMP metadata property name. |
| value | XmpValueBase | XMP metadata property value. |

### XmlNamespace
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/xmlnamespace.md

#### XmpPackage.XmlNamespace property

Gets the XML namespace.

```csharp
public string XmlNamespace { get; }
```

##### Property Value

The XML namespace.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppackage/xmppackage.md

#### XmpPackage constructor

Initializes a new instance of the `XmpPackage` class.

```csharp
public XmpPackage(string prefix, string namespaceUri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| prefix | String | XMP prefix, for example dc:title. |
| namespaceUri | String | Namespace uri. |

### XmpPacketWrapper
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper.md

#### XmpPacketWrapper class

Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

```csharp
public class XmpPacketWrapper : MetadataPackage, IXmpType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpPacketWrapper() | Initializes a new instance of the `XmpPacketWrapper` class. |
| XmpPacketWrapper(XmpHeaderPI, XmpTrailerPI, XmpMeta) | Initializes a new instance of the `XmpPacketWrapper` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| HeaderPI { get; set; } | Gets or sets the header processing instruction. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| Meta { get; set; } | Gets or sets the XMP meta. |
| MetadataType { get; } | Gets the metadata type. |
| PackageCount { get; } | Gets the number of packages inside the XMP structure. |
| Packages { get; } | Gets array of `XmpPackage` inside XMP. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Schemes { get; } | Provides access to known XMP schemas. |
| TrailerPI { get; set; } | Gets or sets the trailer processing instruction. |

#### Methods

| Name | Description |
| --- | --- |
| AddPackage(XmpPackage) | Adds the package. |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| ClearPackages() | Removes all `XmpPackage` inside XMP. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| ContainsPackage(string) | Determines whether package is exist in XMP wrapper. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetPackage(string) | Gets package by namespace uri. |
| GetXmpRepresentation() | Returns string contained value in XMP format. |
| RemovePackage(XmpPackage) | Removes the specified package. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

##### Examples

This example shows how to update XMP metadata properties.

```csharp
using (Metadata metadata = new Metadata(Constants.GifWithXmp))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null && root.XmpPackage != null)
    {
        // if there is no such scheme in the XMP package we should create it
        if (root.XmpPackage.Schemes.DublinCore == null)
        {
            root.XmpPackage.Schemes.DublinCore = new XmpDublinCorePackage();
        }
        root.XmpPackage.Schemes.DublinCore.Format = "image/gif";
        root.XmpPackage.Schemes.DublinCore.SetRights("Copyright (C) 2011-2022 GroupDocs. All Rights Reserved");
        root.XmpPackage.Schemes.DublinCore.SetSubject("test");

        if (root.XmpPackage.Schemes.CameraRaw == null)
        {
            root.XmpPackage.Schemes.CameraRaw = new XmpCameraRawPackage();
        }
        root.XmpPackage.Schemes.CameraRaw.Shadows = 50;
        root.XmpPackage.Schemes.CameraRaw.AutoBrightness = true;
        root.XmpPackage.Schemes.CameraRaw.AutoExposure = true;
        root.XmpPackage.Schemes.CameraRaw.CameraProfile = "test";
        root.XmpPackage.Schemes.CameraRaw.Exposure = 0.0001;

        // If you don't want to keep the old values just replace the whole scheme
        root.XmpPackage.Schemes.XmpBasic = new XmpBasicPackage();
        root.XmpPackage.Schemes.XmpBasic.CreateDate = DateTime.Today;
        root.XmpPackage.Schemes.XmpBasic.BaseUrl = "https://groupdocs.com";
        root.XmpPackage.Schemes.XmpBasic.Rating = 5;

        root.XmpPackage.Schemes.BasicJobTicket = new XmpBasicJobTicketPackage();

        // Set a complex type property
        root.XmpPackage.Schemes.BasicJobTicket.Jobs = new[]
        {
            new XmpJob
            {
                ID = "1",
                Name = "test job",
                Url = "https://groupdocs.com"
            },
        };

        // ... 

        metadata.Save(Constants.OutputGif);
    }
}
```

### AddPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/addpackage.md

#### XmpPacketWrapper.AddPackage method

Adds the package.

```csharp
public void AddPackage(XmpPackage package)
```

| Parameter | Type | Description |
| --- | --- | --- |
| package | XmpPackage | The package. |

##### Examples

This example demonstrates how to add a custom XMP package to a file of any supported format.

```csharp
using (Metadata metadata = new Metadata(Constants.InputJpeg))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null)
    {
        var packet = new XmpPacketWrapper();

        var custom = new XmpPackage("gd", "https://groupdocs.com");
        custom.Set("gd:Copyright", "Copyright (C) 2011-2026 GroupDocs. All Rights Reserved.");
        custom.Set("gd:CreationDate", DateTime.Today);
        custom.Set("gd:Company", XmpArray.From(new [] { "Aspose", "GroupDocs" }, XmpArrayType.Ordered));

        packet.AddPackage(custom);
        root.XmpPackage = packet;

        metadata.Save(Constants.OutputJpeg);
    }
}
```

### ClearPackages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/clearpackages.md

#### XmpPacketWrapper.ClearPackages method

Removes all `XmpPackage` inside XMP.

```csharp
public void ClearPackages()
```

### ContainsPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/containspackage.md

#### XmpPacketWrapper.ContainsPackage method

Determines whether package is exist in XMP wrapper.

```csharp
public bool ContainsPackage(string namespaceUri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | String | Package namespace URI. |

##### Return Value

`true` if package found by *namespaceUri*; otherwise `false`.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Namespace URI could not be null. |

### GetPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/getpackage.md

#### XmpPacketWrapper.GetPackage method

Gets package by namespace uri.

```csharp
public XmpPackage GetPackage(string namespaceUri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | String | Package schema uri. |

##### Return Value

Appropriate `XmpPackage` if package found by *namespaceUri*; otherwise null.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Namespace URI could not be null. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/getxmprepresentation.md

#### XmpPacketWrapper.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### HeaderPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/headerpi.md

#### XmpPacketWrapper.HeaderPI property

Gets or sets the header processing instruction.

```csharp
public XmpHeaderPI HeaderPI { get; set; }
```

##### Property Value

The header processing instruction.

### Meta
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/meta.md

#### XmpPacketWrapper.Meta property

Gets or sets the XMP meta.

```csharp
public XmpMeta Meta { get; set; }
```

##### Property Value

The XMP meta.

### PackageCount
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/packagecount.md

#### XmpPacketWrapper.PackageCount property

Gets the number of packages inside the XMP structure.

```csharp
public int PackageCount { get; }
```

##### Property Value

The package count.

### Packages
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/packages.md

#### XmpPacketWrapper.Packages property

Gets array of `XmpPackage` inside XMP.

```csharp
public XmpPackage[] Packages { get; }
```

##### Property Value

XMP packages.

### RemovePackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/removepackage.md

#### XmpPacketWrapper.RemovePackage method

Removes the specified package.

```csharp
public void RemovePackage(XmpPackage package)
```

| Parameter | Type | Description |
| --- | --- | --- |
| package | XmpPackage | The package. |

### Schemes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/schemes.md

#### XmpPacketWrapper.Schemes property

Provides access to known XMP schemas.

```csharp
public XmpSchemes Schemes { get; }
```

##### Property Value

XMP schemes.

### TrailerPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/trailerpi.md

#### XmpPacketWrapper.TrailerPI property

Gets or sets the trailer processing instruction.

```csharp
public XmpTrailerPI TrailerPI { get; set; }
```

##### Property Value

The trailer processing instruction.

### XmpPacketWrapper
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmppacketwrapper/xmppacketwrapper.md

#### XmpPacketWrapper(XmpHeaderPI, XmpTrailerPI, XmpMeta)

Initializes a new instance of the `XmpPacketWrapper` class.

```csharp
public XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)
```

| Parameter | Type | Description |
| --- | --- | --- |
| header | XmpHeaderPI | XMP header processing instruction. |
| trailer | XmpTrailerPI | XMP trailer processing instruction. |
| xmpMeta | XmpMeta | Instance of `XmpMeta`. |

#### XmpPacketWrapper()

Initializes a new instance of the `XmpPacketWrapper` class.

```csharp
public XmpPacketWrapper()
```

### XmpRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational.md

#### XmpRational class

Represents XMP XmpRational.

```csharp
public sealed class XmpRational : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpRational(string) | Initializes a new instance of the `XmpBoolean` class. |
| XmpRational(long, long) | Initializes a new instance of the `XmpRational` class. |

#### Properties

| Name | Description |
| --- | --- |
| Denominator { get; } | Gets denominator |
| DoubleValue { get; } | Gets value of rational type presented in double format. |
| Numerator { get; } | Gets numerator. |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### Denominator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational/denominator.md

#### XmpRational.Denominator property

Gets denominator

```csharp
public long Denominator { get; }
```

##### Property Value

The denominator.

### DoubleValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational/doublevalue.md

#### XmpRational.DoubleValue property

Gets value of rational type presented in double format.

```csharp
public double DoubleValue { get; }
```

##### Property Value

Double value.

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational/getxmprepresentation.md

#### XmpRational.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Numerator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational/numerator.md

#### XmpRational.Numerator property

Gets numerator.

```csharp
public long Numerator { get; }
```

##### Property Value

The numerator.

### XmpRational
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprational/xmprational.md

#### XmpRational(long, long)

Initializes a new instance of the `XmpRational` class.

```csharp
public XmpRational(long numerator, long denominator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numerator | Int64 | The numerator. |
| denominator | Int64 | The denominator. |

#### XmpRational(string)

Initializes a new instance of the `XmpBoolean` class.

```csharp
public XmpRational(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

### XmpReal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpreal.md

#### XmpReal class

Represents XMP Real.

```csharp
public sealed class XmpReal : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpReal(double) | Initializes a new instance of the `XmpReal` class. |
| XmpReal(string) | Initializes a new instance of the `XmpReal` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpreal/getxmprepresentation.md

#### XmpReal.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpreal/value.md

#### XmpReal.Value property

Gets the value.

```csharp
public double Value { get; }
```

##### Property Value

Double value.

### XmpReal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpreal/xmpreal.md

#### XmpReal(double)

Initializes a new instance of the `XmpReal` class.

```csharp
public XmpReal(double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Double | Double value. |

#### XmpReal(string)

Initializes a new instance of the `XmpReal` class.

```csharp
public XmpReal(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid value. Should be double. |

### XmpRenditionClass
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass.md

#### XmpRenditionClass class

Represents XMP RenditionClass.

```csharp
public sealed class XmpRenditionClass : XmpText
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpRenditionClass(params string[]) | Initializes a new instance of the `XmpRenditionClass` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

#### Fields

| Name | Description |
| --- | --- |
| const Default | The master resource; no additional tokens allowed. |
| const Draft | A review rendition. |
| const LowRes | A low-resolution, full-size stand-in. |
| const Proof | A review proof. |
| const Screen | Screen resolution or Web rendition. |
| const Thumbnail | A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace. |

### Default
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/default.md

#### XmpRenditionClass.Default field

The master resource; no additional tokens allowed.

```csharp
public const string Default;
```

### Draft
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/draft.md

#### XmpRenditionClass.Draft field

A review rendition.

```csharp
public const string Draft;
```

### LowRes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/lowres.md

#### XmpRenditionClass.LowRes field

A low-resolution, full-size stand-in.

```csharp
public const string LowRes;
```

### Proof
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/proof.md

#### XmpRenditionClass.Proof field

A review proof.

```csharp
public const string Proof;
```

### Screen
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/screen.md

#### XmpRenditionClass.Screen field

Screen resolution or Web rendition.

```csharp
public const string Screen;
```

### Thumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/thumbnail.md

#### XmpRenditionClass.Thumbnail field

A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace.

```csharp
public const string Thumbnail;
```

### XmpRenditionClass
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmprenditionclass/xmprenditionclass.md

#### XmpRenditionClass constructor

Initializes a new instance of the `XmpRenditionClass` class.

```csharp
public XmpRenditionClass(params string[] tokens)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tokens | String[] | The token. |

### XmpResourceEvent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent.md

#### XmpResourceEvent class

Represents a high-level event that occurred in the processing of a resource.

```csharp
public sealed class XmpResourceEvent : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpResourceEvent() | Initializes a new instance of the `XmpResourceEvent` class. |

#### Properties

| Name | Description |
| --- | --- |
| Action { get; set; } | Gets or sets the action that occurred. |
| Changed { get; set; } | Gets or sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| Count { get; } | Gets the number of metadata properties. |
| InstanceID { get; set; } | Gets or sets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Parameters { get; set; } | Gets or sets the additional description of the action. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| SoftwareAgent { get; set; } | Gets or sets the software agent that performed the action. |
| When { get; set; } | Gets or sets the timestamp of when the action occurred. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Action
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/action.md

#### XmpResourceEvent.Action property

Gets or sets the action that occurred.

```csharp
public string Action { get; set; }
```

##### Property Value

The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version_updated, printed, published, managed, produced, resized, saved. New values should be verbs in the past tense.

### Changed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/changed.md

#### XmpResourceEvent.Changed property

Gets or sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.

```csharp
public string Changed { get; set; }
```

##### Property Value

A semicolon-delimited list of the parts of the resource that were changed since the previous event history.

### InstanceID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/instanceid.md

#### XmpResourceEvent.InstanceID property

Gets or sets the value of the xmpMM:InstanceID property for the modified (output) resource.

```csharp
public string InstanceID { get; set; }
```

##### Property Value

The value of the xmpMM:InstanceID property for the modified (output) resource.

### Parameters
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/parameters.md

#### XmpResourceEvent.Parameters property

Gets or sets the additional description of the action.

```csharp
public string Parameters { get; set; }
```

##### Property Value

The Additional description of the action.

### SoftwareAgent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/softwareagent.md

#### XmpResourceEvent.SoftwareAgent property

Gets or sets the software agent that performed the action.

```csharp
public string SoftwareAgent { get; set; }
```

##### Property Value

The software agent that performed the action.

### When
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/when.md

#### XmpResourceEvent.When property

Gets or sets the timestamp of when the action occurred.

```csharp
public DateTime? When { get; set; }
```

##### Property Value

The timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file.

### XmpResourceEvent
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceevent/xmpresourceevent.md

#### XmpResourceEvent constructor

Initializes a new instance of the `XmpResourceEvent` class.

```csharp
public XmpResourceEvent()
```

### XmpResourceRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref.md

#### XmpResourceRef class

Represents a multiple part reference to a resource.  Used to indicate prior versions, originals of renditions, originals for derived documents, and so on.

```csharp
public sealed class XmpResourceRef : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpResourceRef() | Initializes a new instance of the `XmpResourceRef` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternatePaths { get; set; } | Gets or sets the referenced resource’s fallback file paths or URLs. |
| Count { get; } | Gets the number of metadata properties. |
| DocumentID { get; set; } | Gets or sets the value of the xmpMM:DocumentID property from the referenced resource. |
| FilePath { get; set; } | Gets or sets the referenced resource’s file path or URL. |
| InstanceID { get; set; } | Gets or sets the value of the xmpMM:InstanceID property from the referenced resource. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| LastModifyDate { get; set; } | Gets or sets the value of stEvt:when for the last time the file was written. |
| Manager { get; set; } | Gets or sets the referenced resource’s xmpMM:Manager. |
| ManagerVariant { get; set; } | Gets or sets the referenced resource’s xmpMM:Manager. |
| ManageTo { get; set; } | Gets or sets the referenced resource’s xmpMM:ManageTo. |
| ManageUI { get; set; } | Gets or sets the referenced resource’s xmpMM:ManageUI. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| PartMapping { get; set; } | Gets or sets the name or URI of a mapping function used to map the fromPart to the toPart. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| RenditionClass { get; set; } | Gets or sets the value of the xmpMM:RenditionClass property from the referenced resource. |
| RenditionParams { get; set; } | Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource. |
| VersionID { get; set; } | Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AlternatePaths
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/alternatepaths.md

#### XmpResourceRef.AlternatePaths property

Gets or sets the referenced resource’s fallback file paths or URLs.

```csharp
public string[] AlternatePaths { get; set; }
```

##### Property Value

The referenced resource’s fallback file paths or URLs. The sequence order is the recommended order in attempting to locate the resource.

### DocumentID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/documentid.md

#### XmpResourceRef.DocumentID property

Gets or sets the value of the xmpMM:DocumentID property from the referenced resource.

```csharp
public string DocumentID { get; set; }
```

##### Property Value

The value of the xmpMM:DocumentID property from the referenced resource.

### FilePath
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/filepath.md

#### XmpResourceRef.FilePath property

Gets or sets the referenced resource’s file path or URL.

```csharp
public string FilePath { get; set; }
```

##### Property Value

The referenced resource’s file path or URL.

### InstanceID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/instanceid.md

#### XmpResourceRef.InstanceID property

Gets or sets the value of the xmpMM:InstanceID property from the referenced resource.

```csharp
public string InstanceID { get; set; }
```

##### Property Value

The value of the xmpMM:InstanceID property from the referenced resource.

### LastModifyDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/lastmodifydate.md

#### XmpResourceRef.LastModifyDate property

Gets or sets the value of stEvt:when for the last time the file was written.

```csharp
public DateTime? LastModifyDate { get; set; }
```

##### Property Value

The value of stEvt:when for the last time the file was written.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/manager.md

#### XmpResourceRef.Manager property

Gets or sets the referenced resource’s xmpMM:Manager.

```csharp
public string Manager { get; set; }
```

##### Property Value

The referenced resource’s xmpMM:Manager.

### ManagerVariant
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/managervariant.md

#### XmpResourceRef.ManagerVariant property

Gets or sets the referenced resource’s xmpMM:Manager.

```csharp
public string ManagerVariant { get; set; }
```

##### Property Value

The referenced resource’s xmpMM:Manager.

### ManageTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/manageto.md

#### XmpResourceRef.ManageTo property

Gets or sets the referenced resource’s xmpMM:ManageTo.

```csharp
public string ManageTo { get; set; }
```

##### Property Value

The referenced resource’s xmpMM:ManageTo.

### ManageUI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/manageui.md

#### XmpResourceRef.ManageUI property

Gets or sets the referenced resource’s xmpMM:ManageUI.

```csharp
public string ManageUI { get; set; }
```

##### Property Value

The referenced resource’s xmpMM:ManageUI.

### PartMapping
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/partmapping.md

#### XmpResourceRef.PartMapping property

Gets or sets the name or URI of a mapping function used to map the fromPart to the toPart.

```csharp
public string PartMapping { get; set; }
```

##### Property Value

The name or URI of a mapping function used to map the fromPart to the toPart. The default for time mappings is "linear".

### RenditionClass
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/renditionclass.md

#### XmpResourceRef.RenditionClass property

Gets or sets the value of the xmpMM:RenditionClass property from the referenced resource.

```csharp
public string RenditionClass { get; set; }
```

##### Property Value

The value of the xmpMM:RenditionClass property from the referenced resource.

### RenditionParams
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/renditionparams.md

#### XmpResourceRef.RenditionParams property

Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource.

```csharp
public string RenditionParams { get; set; }
```

##### Property Value

The value of the xmpMM:RenditionParams property from the referenced resource.

### VersionID
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/versionid.md

#### XmpResourceRef.VersionID property

Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource.

```csharp
public string VersionID { get; set; }
```

##### Property Value

The value of the xmpMM:RenditionParams property from the referenced resource.

### XmpResourceRef
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpresourceref/xmpresourceref.md

#### XmpResourceRef constructor

Initializes a new instance of the `XmpResourceRef` class.

```csharp
public XmpResourceRef()
```

### XmpSchemes
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes.md

#### XmpSchemes class

Provides access to known XMP schemes.

```csharp
public sealed class XmpSchemes
```

#### Properties

| Name | Description |
| --- | --- |
| BasicJobTicket { get; set; } | Gets or sets the BasicJobTicket scheme. |
| CameraRaw { get; set; } | Gets or sets the Camera Raw scheme. |
| DublinCore { get; set; } | Gets or sets the Dublin Core scheme. |
| PagedText { get; set; } | Gets or sets the PagedText scheme. |
| Pdf { get; set; } | Gets or sets the PDF scheme. |
| Photoshop { get; set; } | Gets or sets the Photoshop scheme. |
| XmpBasic { get; set; } | Gets or sets the XmpBasic scheme. |
| XmpDynamicMedia { get; set; } | Gets or sets the XmpDynamicMedia scheme. |
| XmpMediaManagement { get; set; } | Gets or sets the XmpMediaManagement schema. |
| XmpRightsManagement { get; set; } | Gets or sets the XmpRightsManagement schema. |

##### Examples

This example demonstrates how to extract XMP metadata from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.PngWithXmp))
{
    IXmp root = metadata.GetRootPackage() as IXmp;
    if (root != null && root.XmpPackage != null)
    {
        if (root.XmpPackage.Schemes.XmpBasic != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreatorTool);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.CreateDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.ModifyDate);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Label);
            Console.WriteLine(root.XmpPackage.Schemes.XmpBasic.Nickname);

            // ...
        }

        if (root.XmpPackage.Schemes.DublinCore != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Format);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Coverage);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Identifier);
            Console.WriteLine(root.XmpPackage.Schemes.DublinCore.Source);

            // ...
        }

        if (root.XmpPackage.Schemes.Photoshop != null)
        {
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.ColorMode);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.IccProfile);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.Country);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.City);
            Console.WriteLine(root.XmpPackage.Schemes.Photoshop.DateCreated);

            // ... 
        }

        // ...
    }
}
```

### BasicJobTicket
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/basicjobticket.md

#### XmpSchemes.BasicJobTicket property

Gets or sets the BasicJobTicket scheme.

```csharp
public XmpBasicJobTicketPackage BasicJobTicket { get; set; }
```

##### Property Value

The XMP job ticket namespace.

### CameraRaw
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/cameraraw.md

#### XmpSchemes.CameraRaw property

Gets or sets the Camera Raw scheme.

```csharp
public XmpCameraRawPackage CameraRaw { get; set; }
```

##### Property Value

The camera raw namespace.

### DublinCore
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/dublincore.md

#### XmpSchemes.DublinCore property

Gets or sets the Dublin Core scheme.

```csharp
public XmpDublinCorePackage DublinCore { get; set; }
```

##### Property Value

The dublin core namespace.

### PagedText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/pagedtext.md

#### XmpSchemes.PagedText property

Gets or sets the PagedText scheme.

```csharp
public XmpPagedTextPackage PagedText { get; set; }
```

##### Property Value

The paged text namespace.

### Pdf
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/pdf.md

#### XmpSchemes.Pdf property

Gets or sets the PDF scheme.

```csharp
public XmpPdfPackage Pdf { get; set; }
```

##### Property Value

The PDF namespace.

### Photoshop
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/photoshop.md

#### XmpSchemes.Photoshop property

Gets or sets the Photoshop scheme.

```csharp
public XmpPhotoshopPackage Photoshop { get; set; }
```

##### Property Value

The photoshop namespace.

### XmpBasic
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/xmpbasic.md

#### XmpSchemes.XmpBasic property

Gets or sets the XmpBasic scheme.

```csharp
public XmpBasicPackage XmpBasic { get; set; }
```

##### Property Value

The XMP basic namespace.

### XmpDynamicMedia
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/xmpdynamicmedia.md

#### XmpSchemes.XmpDynamicMedia property

Gets or sets the XmpDynamicMedia scheme.

```csharp
public XmpDynamicMediaPackage XmpDynamicMedia { get; set; }
```

##### Property Value

The XMP dynamic media namespace.

### XmpMediaManagement
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/xmpmediamanagement.md

#### XmpSchemes.XmpMediaManagement property

Gets or sets the XmpMediaManagement schema.

```csharp
public XmpMediaManagementPackage XmpMediaManagement { get; set; }
```

##### Property Value

The XMP media management namespace.

### XmpRightsManagement
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpschemes/xmprightsmanagement.md

#### XmpSchemes.XmpRightsManagement property

Gets or sets the XmpRightsManagement schema.

```csharp
public XmpRightsManagementPackage XmpRightsManagement { get; set; }
```

##### Property Value

The XMP rights management namespace.

### XmpText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptext.md

#### XmpText class

Represents XMP Text basic type.

```csharp
public class XmpText : XmpValueBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpText(string) | Initializes a new instance of the `XmpText` class. |

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |
| Value { get; } | Gets the value. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptext/getxmprepresentation.md

#### XmpText.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public override string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptext/value.md

#### XmpText.Value property

Gets the value.

```csharp
public string Value { get; }
```

##### Property Value

Text value.

### XmpText
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptext/xmptext.md

#### XmpText constructor

Initializes a new instance of the `XmpText` class.

```csharp
public XmpText(string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value. |

### XmpThumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail.md

#### XmpThumbnail class

Represents a thumbnail image for a file.

```csharp
public sealed class XmpThumbnail : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpThumbnail() | Initializes a new instance of the `XmpThumbnail` class. |
| XmpThumbnail(int, int) | Initializes a new instance of the `XmpThumbnail` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Format { get; set; } | Gets or sets the image format. Defined value: JPEG. |
| Height { get; set; } | Gets or sets the image height in pixels. |
| ImageBase64 { get; set; } | Gets or sets the full thumbnail image data, converted to base 64 notation. |
| ImageData { get; } | Gets the image data. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Width { get; set; } | Gets or sets the image width in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Format
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/format.md

#### XmpThumbnail.Format property

Gets or sets the image format. Defined value: JPEG.

```csharp
public string Format { get; set; }
```

##### Property Value

The thumbnail format.

### Height
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/height.md

#### XmpThumbnail.Height property

Gets or sets the image height in pixels.

```csharp
public int? Height { get; set; }
```

##### Property Value

The thumbnail height.

### ImageBase64
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/imagebase64.md

#### XmpThumbnail.ImageBase64 property

Gets or sets the full thumbnail image data, converted to base 64 notation.

```csharp
public string ImageBase64 { get; set; }
```

##### Property Value

The full thumbnail image data, converted to base 64 notation.

### ImageData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/imagedata.md

#### XmpThumbnail.ImageData property

Gets the image data.

```csharp
public byte[] ImageData { get; }
```

##### Property Value

The image data.

### Width
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/width.md

#### XmpThumbnail.Width property

Gets or sets the image width in pixels.

```csharp
public int? Width { get; set; }
```

##### Property Value

The thumbnail width.

### XmpThumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpthumbnail/xmpthumbnail.md

#### XmpThumbnail()

Initializes a new instance of the `XmpThumbnail` class.

```csharp
public XmpThumbnail()
```

#### XmpThumbnail(int, int)

Initializes a new instance of the `XmpThumbnail` class.

```csharp
public XmpThumbnail(int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Int32 | The width. |
| height | Int32 | The height. |

### XmpTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptime.md

#### XmpTime class

Representation of a time value in seconds.

```csharp
public sealed class XmpTime : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpTime() | Initializes a new instance of the `XmpTime` class. |
| XmpTime(XmpRational, int) | Initializes a new instance of the `XmpTime` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| Scale { get; set; } | Gets or sets the scale for the time value. |
| Value { get; set; } | Gets or sets the time value in the specified scale. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Scale
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptime/scale.md

#### XmpTime.Scale property

Gets or sets the scale for the time value.

```csharp
public XmpRational Scale { get; set; }
```

##### Property Value

The scale for the time value. For NTSC, use 1001/30000, or the less accurate 100/2997.  For PAL, use 1/25.

### Value
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptime/value.md

#### XmpTime.Value property

Gets or sets the time value in the specified scale.

```csharp
public int? Value { get; set; }
```

##### Property Value

The time value in the specified scale.

### XmpTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptime/xmptime.md

#### XmpTime()

Initializes a new instance of the `XmpTime` class.

```csharp
public XmpTime()
```

#### XmpTime(XmpRational, int)

Initializes a new instance of the `XmpTime` class.

```csharp
public XmpTime(XmpRational scale, int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| scale | XmpRational | The scale. |
| value | Int32 | The value. |

### XmpTimecode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptimecode.md

#### XmpTimecode class

Represents a timecode value in a video.

```csharp
public sealed class XmpTimecode : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpTimecode() | Initializes a new instance of the `XmpTimecode` class. |
| XmpTimecode(XmpTimeFormat, string) | Initializes a new instance of the `XmpTimecode` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of metadata properties. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| TimeFormat { get; set; } | Gets or sets the format used in the time value. |
| TimeValue { get; set; } | Gets or sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| SetTimeFormat(XmpTimeFormat) | Sets the time format. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### SetTimeFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptimecode/settimeformat.md

#### XmpTimecode.SetTimeFormat method

Sets the time format.

```csharp
public void SetTimeFormat(XmpTimeFormat timeFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| timeFormat | XmpTimeFormat | The time format. |

### TimeFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptimecode/timeformat.md

#### XmpTimecode.TimeFormat property

Gets or sets the format used in the time value.

```csharp
public string TimeFormat { get; set; }
```

##### Property Value

The format used in the timeValue. One of: 24Timecode, 25Timecode, 2997DropTimecode (semicolon delimiter), 2997NonDropTimecode, 30Timecode, 50Timecode, 5994DropTimecode (semicolon delimiter), 5994NonDropTimecode, 60Timecode, 23976Timecode.

### TimeValue
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptimecode/timevalue.md

#### XmpTimecode.TimeValue property

Gets or sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

```csharp
public string TimeValue { get; set; }
```

##### Property Value

The time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

### XmpTimecode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptimecode/xmptimecode.md

#### XmpTimecode()

Initializes a new instance of the `XmpTimecode` class.

```csharp
public XmpTimecode()
```

#### XmpTimecode(XmpTimeFormat, string)

Initializes a new instance of the `XmpTimecode` class.

```csharp
public XmpTimecode(XmpTimeFormat format, string timeValue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | XmpTimeFormat | Time format. |
| timeValue | String | Time value. |

### XmpTrailerPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptrailerpi.md

#### XmpTrailerPI class

Represents XMP trailer processing instruction.

```csharp
public sealed class XmpTrailerPI : IXmpType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpTrailerPI() | Initializes a new instance of the `XmpTrailerPI` class. |
| XmpTrailerPI(bool) | Initializes a new instance of the `XmpTrailerPI` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsWritable { get; } | Indicates whether form may be modified in-place. |

#### Methods

| Name | Description |
| --- | --- |
| GetXmpRepresentation() | Converts XMP value to the xml representation. |

##### Remarks

The end="w" or end="r" portion shall be used by packet scanning processors to determine whether the XMP may be modified in-place.

##### Examples

Allowed forms of the trailer PI:

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptrailerpi/getxmprepresentation.md

#### XmpTrailerPI.GetXmpRepresentation method

Converts XMP value to the xml representation.

```csharp
public string GetXmpRepresentation()
```

##### Return Value

Returns String representation of XMP value.

### IsWritable
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptrailerpi/iswritable.md

#### XmpTrailerPI.IsWritable property

Indicates whether form may be modified in-place.

```csharp
public bool IsWritable { get; }
```

##### Property Value

`true` if XMP packet is writable; otherwise, `false`.

### XmpTrailerPI
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmptrailerpi/xmptrailerpi.md

#### XmpTrailerPI(bool)

Initializes a new instance of the `XmpTrailerPI` class.

```csharp
public XmpTrailerPI(bool isWritable)
```

| Parameter | Type | Description |
| --- | --- | --- |
| isWritable | Boolean | Indicates whether trailer is writable. |

#### XmpTrailerPI()

Initializes a new instance of the `XmpTrailerPI` class.

```csharp
public XmpTrailerPI()
```

### XmpValueBase
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpvaluebase.md

#### XmpValueBase class

Represents base XMP value.

```csharp
public abstract class XmpValueBase : PropertyValue, IXmpType
```

#### Properties

| Name | Description |
| --- | --- |
| RawValue { get; } | Gets the raw value. |
| Type { get; } | Gets the `MetadataPropertyType`. |

#### Methods

| Name | Description |
| --- | --- |
| AcceptValue(ValueAcceptor) | Extracts the property value using a custom `ValueAcceptor`. |
| abstract GetXmpRepresentation() | Returns string contained value in XMP format. |
| ToArray&lt;TElement&gt;() | Converts the property value to an array of the specified type. |
| ToClass&lt;T&gt;() | Converts the property value to a reference type. |
| override ToString() | Returns a string that represents the property value. |
| ToStruct&lt;T&gt;() | Converts the property value to a value type. |
| ToStruct&lt;T&gt;(T) | Converts the property value to a value type. |

### GetXmpRepresentation
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpvaluebase/getxmprepresentation.md

#### XmpValueBase.GetXmpRepresentation method

Returns string contained value in XMP format.

```csharp
public abstract string GetXmpRepresentation()
```

##### Return Value

String contained XMP representation.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpvaluebase/tostring.md

#### XmpValueBase.ToString method

Returns a string that represents the property value.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the property value.

### XmpVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion.md

#### XmpVersion class

Represents a version of a document.

```csharp
public sealed class XmpVersion : XmpComplexType
```

#### Constructors

| Name | Description |
| --- | --- |
| XmpVersion() | Initializes a new instance of the `XmpVersion` class. |

#### Properties

| Name | Description |
| --- | --- |
| Comments { get; set; } | Gets or sets the comments concerning what was changed. |
| Count { get; } | Gets the number of metadata properties. |
| Event { get; set; } | Gets or sets the high-level, formal description of what operation the user performed. |
| Item { get; } | Gets the `MetadataProperty` with the specified name. |
| Keys { get; } | Gets a collection of the metadata property names. |
| MetadataType { get; } | Gets the metadata type. |
| Modifier { get; set; } | Gets or sets the person who modified this version. |
| ModifyDate { get; set; } | Gets or sets the date on which this version was checked in. |
| NamespaceUris { get; } | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| Prefixes { get; } | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| PropertyDescriptors { get; } | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| VersionNumber { get; set; } | Gets or sets the new version number. |

#### Methods

| Name | Description |
| --- | --- |
| virtual AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| Contains(string) | Determines whether the package contains a metadata property with the specified name. |
| virtual FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetNamespaceUri(string) | Gets the namespace URI associated with the specified prefix. |
| override GetXmpRepresentation() | Returns string contained value in XMP format. |
| virtual RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| virtual Sanitize() | Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well. |
| virtual SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in the package that satisfies the predicate it is added to the package. |
| override ToString() | Returns a String that represents this instance. |
| virtual UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### Comments
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/comments.md

#### XmpVersion.Comments property

Gets or sets the comments concerning what was changed.

```csharp
public string Comments { get; set; }
```

##### Property Value

The comments concerning what was changed.

### Event
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/event.md

#### XmpVersion.Event property

Gets or sets the high-level, formal description of what operation the user performed.

```csharp
public XmpResourceEvent Event { get; set; }
```

##### Property Value

The high-level, formal description of what operation the user performed.

### Modifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/modifier.md

#### XmpVersion.Modifier property

Gets or sets the person who modified this version.

```csharp
public string Modifier { get; set; }
```

##### Property Value

The person who modified this version.

### ModifyDate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/modifydate.md

#### XmpVersion.ModifyDate property

Gets or sets the date on which this version was checked in.

```csharp
public DateTime? ModifyDate { get; set; }
```

##### Property Value

The date on which this version was checked in.

### VersionNumber
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/versionnumber.md

#### XmpVersion.VersionNumber property

Gets or sets the new version number.

```csharp
public string VersionNumber { get; set; }
```

##### Property Value

The new version number.

### XmpVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.standards.xmp/xmpversion/xmpversion.md

#### XmpVersion constructor

Initializes a new instance of the `XmpVersion` class.

```csharp
public XmpVersion()
```

### GroupDocs.Metadata.Tagging
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging.md

The namespace contains various sets of tags with which most important metadata properties are marked. The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format.

#### Classes

| Class | Description |
| --- | --- |
| ContentTagCategory | Provides tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc. |
| CorporateTagCategory | Provides tags intended to mark metadata properties related to a company that participated in file creation. |
| DocumentTagCategory | Provides tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted. |
| LegalTagCategory | Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
| OriginTagCategory | Provides tags that help a user to determine the origin of a file (e.g. template or another source). |
| PersonTagCategory | Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name. |
| PropertyTag | Represents a tag used to mark metadata properties. |
| PropertyTypeTagCategory | Provides tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on. |
| TagCategory | Represents a set of tags having some shared characteristics. |
| Tags | Contains various sets of tags with which most important metadata properties are marked. The tags allow you to find and update metadata properties in different packages regardless of the metadata standard and file format. |
| TimeTagCategory | Provides tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc. |
| ToolTagCategory | Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### ContentTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory.md

#### ContentTagCategory class

Provides tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.

```csharp
public class ContentTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Album { get; } | Gets the tag that denotes the album name of a audio file. |
| Body { get; } | Gets the tag that denotes the body of a email file. |
| Comment { get; } | Gets the tag that denotes a comment left by a person who contributed in file creation. |
| Description { get; } | Gets the tag that labels properties containing a description of a file. |
| FileFormat { get; } | Gets the tag that indicates a metadata property containing information about the format of a file. |
| HyperlinksChanged { get; } | Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer. |
| Keywords { get; } | Gets the tag that denotes a metadata property containing keywords that describe the content. |
| Language { get; } | Gets the tag indicating the language of the intellectual content of a file. |
| Rating { get; } | Gets the tag labeling a user assigned rating of a file. |
| SharedDoc { get; } | Gets the tag that denotes which is a common document for several manufacturers. |
| Status { get; } | Gets the tag that denotes the status of a file. |
| Subject { get; } | Gets the tag that denotes the subject the intellectual content is focused on. |
| TableOfContents { get; } | Gets the tag indicating properties containing the table of contents of a file. |
| Thumbnail { get; } | Gets the tag that indicates a thumbnail image attached to a file. |
| Title { get; } | Gets the tag that labels the name given to a file. |
| Type { get; } | Gets the tag that indicates the nature or genre of the content of a file. It also includes terms describing general categories, functions, aggregation levels for the content. |
| Version { get; } | Gets the tag labeling the version or revision of a file. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Album
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/album.md

#### ContentTagCategory.Album property

Gets the tag that denotes the album name of a audio file.

```csharp
public PropertyTag Album { get; }
```

##### Property Value

The tag that denotes the album name of a audio file.

### Body
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/body.md

#### ContentTagCategory.Body property

Gets the tag that denotes the body of a email file.

```csharp
public PropertyTag Body { get; }
```

##### Property Value

The tag that denotes the body of a email file.

### Comment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/comment.md

#### ContentTagCategory.Comment property

Gets the tag that denotes a comment left by a person who contributed in file creation.

```csharp
public PropertyTag Comment { get; }
```

##### Property Value

The tag that denotes a comment left by a person who contributed in file creation.

### Description
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/description.md

#### ContentTagCategory.Description property

Gets the tag that labels properties containing a description of a file.

```csharp
public PropertyTag Description { get; }
```

##### Property Value

The tag that labels properties containing a description of a file.

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/fileformat.md

#### ContentTagCategory.FileFormat property

Gets the tag that indicates a metadata property containing information about the format of a file.

```csharp
public PropertyTag FileFormat { get; }
```

##### Property Value

The tag that indicates a metadata property containing information about the format of a file.

### HyperlinksChanged
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/hyperlinkschanged.md

#### ContentTagCategory.HyperlinksChanged property

Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.

```csharp
public PropertyTag HyperlinksChanged { get; }
```

##### Property Value

The tag that denotes indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.

### Keywords
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/keywords.md

#### ContentTagCategory.Keywords property

Gets the tag that denotes a metadata property containing keywords that describe the content.

```csharp
public PropertyTag Keywords { get; }
```

##### Property Value

The tag that denotes a metadata property containing keywords that describe the content.

### Language
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/language.md

#### ContentTagCategory.Language property

Gets the tag indicating the language of the intellectual content of a file.

```csharp
public PropertyTag Language { get; }
```

### Rating
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/rating.md

#### ContentTagCategory.Rating property

Gets the tag labeling a user assigned rating of a file.

```csharp
public PropertyTag Rating { get; }
```

##### Property Value

The tag labeling a user assigned rating of a file.

### SharedDoc
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/shareddoc.md

#### ContentTagCategory.SharedDoc property

Gets the tag that denotes which is a common document for several manufacturers.

```csharp
public PropertyTag SharedDoc { get; }
```

##### Property Value

The tag that denotes which is a common document for several manufacturers.

### Status
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/status.md

#### ContentTagCategory.Status property

Gets the tag that denotes the status of a file.

```csharp
public PropertyTag Status { get; }
```

##### Property Value

The tag that denotes the status of a file.

### Subject
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/subject.md

#### ContentTagCategory.Subject property

Gets the tag that denotes the subject the intellectual content is focused on.

```csharp
public PropertyTag Subject { get; }
```

##### Property Value

The tag that denotes the subject the intellectual content is focused on.

### TableOfContents
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/tableofcontents.md

#### ContentTagCategory.TableOfContents property

Gets the tag indicating properties containing the table of contents of a file.

```csharp
public PropertyTag TableOfContents { get; }
```

### Thumbnail
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/thumbnail.md

#### ContentTagCategory.Thumbnail property

Gets the tag that indicates a thumbnail image attached to a file.

```csharp
public PropertyTag Thumbnail { get; }
```

##### Property Value

The tag that indicates a thumbnail image attached to a file.

### Title
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/title.md

#### ContentTagCategory.Title property

Gets the tag that labels the name given to a file.

```csharp
public PropertyTag Title { get; }
```

##### Property Value

The tag that labels the name given to a file.

### Type
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/type.md

#### ContentTagCategory.Type property

Gets the tag that indicates the nature or genre of the content of a file. It also includes terms describing general categories, functions, aggregation levels for the content.

```csharp
public PropertyTag Type { get; }
```

### Version
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/contenttagcategory/version.md

#### ContentTagCategory.Version property

Gets the tag labeling the version or revision of a file.

```csharp
public PropertyTag Version { get; }
```

##### Property Value

The tag labeling the version or revision of a file.

### CorporateTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/corporatetagcategory.md

#### CorporateTagCategory class

Provides tags intended to mark metadata properties related to a company that participated in file creation.

```csharp
public class CorporateTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Company { get; } | Gets the tag that labels a property containing information about a company contributed to file creation. Alternatively, the tag can refer to a company the file content is about. |
| Manager { get; } | Gets the tag that labels information about a person who managed the making process of a file. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Company
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/corporatetagcategory/company.md

#### CorporateTagCategory.Company property

Gets the tag that labels a property containing information about a company contributed to file creation. Alternatively, the tag can refer to a company the file content is about.

```csharp
public PropertyTag Company { get; }
```

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/corporatetagcategory/manager.md

#### CorporateTagCategory.Manager property

Gets the tag that labels information about a person who managed the making process of a file.

```csharp
public PropertyTag Manager { get; }
```

##### Property Value

The tag that labels information about a person who managed the making process of a file.

### DocumentTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory.md

#### DocumentTagCategory class

Provides tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.

```csharp
public class DocumentTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| BuiltIn { get; } | Gets the tag that indicates that the property it labels is built-in. |
| Field { get; } | Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document. |
| HiddenData { get; } | Gets the tag indicating a document part that is not visible for regular users. |
| OnlyUpdate { get; } | Gets the tag that indicates that the property it not full removal from document. |
| Page { get; } | Gets the tag that denotes a property holding information about a document page. |
| ReadOnly { get; } | Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata. |
| Revision { get; } | Get the tag labeling a property containing information about a document revision (tracked change). |
| Statistic { get; } | Gets the tag indicating a property containing document statistics (word count, character count, etc). |
| UserComment { get; } | Gets the tag that labels user comments shown in the document content. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### BuiltIn
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/builtin.md

#### DocumentTagCategory.BuiltIn property

Gets the tag that indicates that the property it labels is built-in.

```csharp
public PropertyTag BuiltIn { get; }
```

##### Property Value

The tag that indicates that the property it labels is built-in.

### Field
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/field.md

#### DocumentTagCategory.Field property

Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document.

```csharp
public PropertyTag Field { get; }
```

##### Property Value

The tag that denotes a property holding information about a form field or calculated field extracted from a document.

### HiddenData
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/hiddendata.md

#### DocumentTagCategory.HiddenData property

Gets the tag indicating a document part that is not visible for regular users.

```csharp
public PropertyTag HiddenData { get; }
```

##### Property Value

The tag indicating a document part that is not visible for regular users.

### OnlyUpdate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/onlyupdate.md

#### DocumentTagCategory.OnlyUpdate property

Gets the tag that indicates that the property it not full removal from document.

```csharp
public PropertyTag OnlyUpdate { get; }
```

##### Property Value

The tag that indicates that the property it not full removal from document.

### Page
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/page.md

#### DocumentTagCategory.Page property

Gets the tag that denotes a property holding information about a document page.

```csharp
public PropertyTag Page { get; }
```

##### Property Value

The tag that denotes a property holding information about a document page.

### ReadOnly
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/readonly.md

#### DocumentTagCategory.ReadOnly property

Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.

```csharp
public PropertyTag ReadOnly { get; }
```

##### Property Value

The tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.

### Revision
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/revision.md

#### DocumentTagCategory.Revision property

Get the tag labeling a property containing information about a document revision (tracked change).

```csharp
public PropertyTag Revision { get; }
```

##### Property Value

The tag labeling a property containing information about a document revision (tracked change).

### Statistic
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/statistic.md

#### DocumentTagCategory.Statistic property

Gets the tag indicating a property containing document statistics (word count, character count, etc).

```csharp
public PropertyTag Statistic { get; }
```

##### Property Value

The tag indicating a property containing document statistics (word count, character count, etc).

### UserComment
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/documenttagcategory/usercomment.md

#### DocumentTagCategory.UserComment property

Gets the tag that labels user comments shown in the document content.

```csharp
public PropertyTag UserComment { get; }
```

##### Property Value

The tag that labels user comments shown in the document content.

### LegalTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/legaltagcategory.md

#### LegalTagCategory class

Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

```csharp
public class LegalTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Copyright { get; } | Gets the tag that labels a copyright notice provided by the owner. |
| Owner { get; } | Gets the tag that denotes information about the owners of a file. |
| UsageTerms { get; } | Gets the tag that labels instructions on how the file can be used. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Copyright
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/legaltagcategory/copyright.md

#### LegalTagCategory.Copyright property

Gets the tag that labels a copyright notice provided by the owner.

```csharp
public PropertyTag Copyright { get; }
```

##### Property Value

The tag that labels a copyright notice provided by the owner.

### Owner
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/legaltagcategory/owner.md

#### LegalTagCategory.Owner property

Gets the tag that denotes information about the owners of a file.

```csharp
public PropertyTag Owner { get; }
```

##### Property Value

The tag that denotes information about the owners of a file.

### UsageTerms
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/legaltagcategory/usageterms.md

#### LegalTagCategory.UsageTerms property

Gets the tag that labels instructions on how the file can be used.

```csharp
public PropertyTag UsageTerms { get; }
```

##### Property Value

The tag that labels instructions on how the file can be used.

### OriginTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/origintagcategory.md

#### OriginTagCategory class

Provides tags that help a user to determine the origin of a file (e.g. template or another source).

```csharp
public class OriginTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Source { get; } | Gets the tag that labels a reference to a resource from which the file content is derived. |
| Template { get; } | Gets the tag that denotes the template from which the file was created. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Source
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/origintagcategory/source.md

#### OriginTagCategory.Source property

Gets the tag that labels a reference to a resource from which the file content is derived.

```csharp
public PropertyTag Source { get; }
```

##### Property Value

The tag that labels a reference to a resource from which the file content is derived.

### Template
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/origintagcategory/template.md

#### OriginTagCategory.Template property

Gets the tag that denotes the template from which the file was created.

```csharp
public PropertyTag Template { get; }
```

##### Property Value

The tag that denotes the template from which the file was created.

### PersonTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory.md

#### PersonTagCategory class

Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.

```csharp
public class PersonTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Artist { get; } | Gets the tag that denotes the original performer of a file. |
| Client { get; } | Gets the tag that labels information about the client for whom the file/intellectual content was created. |
| Contributor { get; } | Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. Please note that the tag is not applied towards metadata properties marked with more specific tags from this category. E.g. if a property labeled with the Creator tag. |
| Creator { get; } | Gets the tag that denotes the original author of a file/document. |
| Editor { get; } | Gets the tag that labels a person who edited a file. The tag is usually used to mark a property containing information about the last editor. |
| Manager { get; } | Gets the tag that labels information about a person who managed the making process of a file. |
| Model { get; } | Gets the tag that denotes information about a person the content of the file is about. For photos that is a person shown in the image. |
| Publisher { get; } | Gets the tag marking a person responsible for making the file available. |
| Recipient { get; } | Gets the tag that denotes the original recipients of a mail. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Artist
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/artist.md

#### PersonTagCategory.Artist property

Gets the tag that denotes the original performer of a file.

```csharp
public PropertyTag Artist { get; }
```

##### Property Value

The tag that denotes the original performer of a file.

### Client
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/client.md

#### PersonTagCategory.Client property

Gets the tag that labels information about the client for whom the file/intellectual content was created.

```csharp
public PropertyTag Client { get; }
```

##### Property Value

The tag that labels information about the client for whom the file/intellectual content was created.

### Contributor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/contributor.md

#### PersonTagCategory.Contributor property

Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. Please note that the tag is not applied towards metadata properties marked with more specific tags from this category. E.g. if a property labeled with the Creator tag.

```csharp
public PropertyTag Contributor { get; }
```

##### Property Value

The tag that labels a property containing the name of a person who somehow contributed to file creation.

### Creator
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/creator.md

#### PersonTagCategory.Creator property

Gets the tag that denotes the original author of a file/document.

```csharp
public PropertyTag Creator { get; }
```

##### Property Value

The tag that denotes the original author of a file/document.

### Editor
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/editor.md

#### PersonTagCategory.Editor property

Gets the tag that labels a person who edited a file. The tag is usually used to mark a property containing information about the last editor.

```csharp
public PropertyTag Editor { get; }
```

##### Property Value

The tag that labels a person who edited a file.

### Manager
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/manager.md

#### PersonTagCategory.Manager property

Gets the tag that labels information about a person who managed the making process of a file.

```csharp
public PropertyTag Manager { get; }
```

##### Property Value

The tag that labels information about a person who managed the making process of a file.

### Model
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/model.md

#### PersonTagCategory.Model property

Gets the tag that denotes information about a person the content of the file is about. For photos that is a person shown in the image.

```csharp
public PropertyTag Model { get; }
```

##### Property Value

The tag that denotes information about a person the content of the file is about.

### Publisher
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/publisher.md

#### PersonTagCategory.Publisher property

Gets the tag marking a person responsible for making the file available.

```csharp
public PropertyTag Publisher { get; }
```

##### Property Value

The tag marking a person responsible for making the file available.

### Recipient
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/persontagcategory/recipient.md

#### PersonTagCategory.Recipient property

Gets the tag that denotes the original recipients of a mail.

```csharp
public PropertyTag Recipient { get; }
```

##### Property Value

The tag that denotes the original recipients of a mail.

### PropertyTag
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag.md

#### PropertyTag class

Represents a tag used to mark metadata properties.

```csharp
public sealed class PropertyTag : IEquatable<PropertyTag>
```

#### Properties

| Name | Description |
| --- | --- |
| Category { get; } | Gets the tag category. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether the specified object is equal to the current object. |
| Equals(PropertyTag) | Indicates whether the current object is equal to another object of the same type. |
| override GetHashCode() | Serves as the default hash function. |
| override ToString() | Returns a string that represents the current object. |
| operator == | Indicates whether two objects of the same type are equal. |
| operator != | Indicates whether two objects of the same type are not equal. |

### Category
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag/category.md

#### PropertyTag.Category property

Gets the tag category.

```csharp
public TagCategory Category { get; }
```

##### Property Value

The tag category.

### Equals
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag/equals.md

#### Equals(PropertyTag)

Indicates whether the current object is equal to another object of the same type.

```csharp
public bool Equals(PropertyTag other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | PropertyTag | An object to compare with this object. |

##### Return Value

True if the current object is equal to the *other* parameter; otherwise, false.

#### Equals(object)

Determines whether the specified object is equal to the current object.

```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.

### GetHashCode
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag/gethashcode.md

#### PropertyTag.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/metadata/net/groupdocs.metadata.tagging/propertytag/op_equality.md

#### PropertyTag Equality operator

Indicates whether two objects of the same type are equal.

```csharp
public static bool operator ==(PropertyTag left, PropertyTag right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

##### Return Value

True if the objects are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag/op_inequality.md

#### PropertyTag Inequality operator

Indicates whether two objects of the same type are not equal.

```csharp
public static bool operator !=(PropertyTag left, PropertyTag right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

##### Return Value

True if the objects are not equal; otherwise, false.

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytag/tostring.md

#### PropertyTag.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### PropertyTypeTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory.md

#### PropertyTypeTagCategory class

Provides tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.

```csharp
public class PropertyTypeTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Bitrate { get; } | Gets the tag that labels a property describing a bitrate. |
| Color { get; } | Gets the tag that labels a property describing a color. |
| DigitalSignature { get; } | Gets the tag that labels a digital signature. |
| Font { get; } | Gets the tag that denotes a property describing font characteristics. |
| Hash { get; } | Gets the tag that labels a property holding a hash of the file content. |
| Identifier { get; } | Gets the tag that labels a property containing an identifier of the content. |
| Link { get; } | Gets the tag that denotes a property being a link to an external resource. |
| Location { get; } | Gets the tag that indicates a property being a reference to a geographical location. The property can contain the name of a city, full address, GPS coordinates, etc. |
| Measure { get; } | Gets the tag that indicates a property being a measured characteristic of the content. It can be the file size, number of pages, page size, etc. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Bitrate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/bitrate.md

#### PropertyTypeTagCategory.Bitrate property

Gets the tag that labels a property describing a bitrate.

```csharp
public PropertyTag Bitrate { get; }
```

##### Property Value

The tag that labels a property describing a bitrate.

### Color
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/color.md

#### PropertyTypeTagCategory.Color property

Gets the tag that labels a property describing a color.

```csharp
public PropertyTag Color { get; }
```

##### Property Value

The tag that labels a property describing a color.

### DigitalSignature
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/digitalsignature.md

#### PropertyTypeTagCategory.DigitalSignature property

Gets the tag that labels a digital signature.

```csharp
public PropertyTag DigitalSignature { get; }
```

##### Property Value

The tag that labels a digital signature.

### Font
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/font.md

#### PropertyTypeTagCategory.Font property

Gets the tag that denotes a property describing font characteristics.

```csharp
public PropertyTag Font { get; }
```

##### Property Value

The tag that denotes a property describing font characteristics.

### Hash
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/hash.md

#### PropertyTypeTagCategory.Hash property

Gets the tag that labels a property holding a hash of the file content.

```csharp
public PropertyTag Hash { get; }
```

##### Property Value

The tag that labels a property holding a hash of the file content.

### Identifier
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/identifier.md

#### PropertyTypeTagCategory.Identifier property

Gets the tag that labels a property containing an identifier of the content.

```csharp
public PropertyTag Identifier { get; }
```

##### Property Value

The tag that labels a property containing an identifier of the content.

### Link
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/link.md

#### PropertyTypeTagCategory.Link property

Gets the tag that denotes a property being a link to an external resource.

```csharp
public PropertyTag Link { get; }
```

##### Property Value

The tag that denotes a property being a link to an external resource.

### Location
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/location.md

#### PropertyTypeTagCategory.Location property

Gets the tag that indicates a property being a reference to a geographical location. The property can contain the name of a city, full address, GPS coordinates, etc.

```csharp
public PropertyTag Location { get; }
```

##### Property Value

The tag that indicates a property being a reference to a geographical location.

### Measure
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/propertytypetagcategory/measure.md

#### PropertyTypeTagCategory.Measure property

Gets the tag that indicates a property being a measured characteristic of the content. It can be the file size, number of pages, page size, etc.

```csharp
public PropertyTag Measure { get; }
```

##### Property Value

The tag that indicates a property being a measured characteristic of the content.

### TagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tagcategory.md

#### TagCategory class

Represents a set of tags having some shared characteristics.

```csharp
public class TagCategory
```

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### ToString
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tagcategory/tostring.md

#### TagCategory.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Tags
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags.md

#### Tags class

Contains various sets of tags with which most important metadata properties are marked. The tags allow you to find and update metadata properties in different packages regardless of the metadata standard and file format.

```csharp
public static class Tags
```

#### Properties

| Name | Description |
| --- | --- |
| static Content { get; } | Gets the tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc. |
| static Corporate { get; } | Gets a set of tags intended to mark metadata properties related to a company that participated in file creation. |
| static Document { get; } | Gets a set of tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted. |
| static Legal { get; } | Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
| static Origin { get; } | Gets the tags that help a user to determine the origin of a file (e.g. template or another source). |
| static Person { get; } | Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name. |
| static PropertyType { get; } | Gets a set of tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on. |
| static Time { get; } | Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc. |
| static Tool { get; } | Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |

### Content
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/content.md

#### Tags.Content property

Gets the tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.

```csharp
public static ContentTagCategory Content { get; }
```

##### Property Value

The tags that are attached to metadata properties describing the content of a file.

### Corporate
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/corporate.md

#### Tags.Corporate property

Gets a set of tags intended to mark metadata properties related to a company that participated in file creation.

```csharp
public static CorporateTagCategory Corporate { get; }
```

##### Property Value

A set of tags intended to mark metadata properties related to a company that participated in file creation.

### Document
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/document.md

#### Tags.Document property

Gets a set of tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.

```csharp
public static DocumentTagCategory Document { get; }
```

##### Property Value

A set of tags that are applied to document-specific properties only.

### Legal
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/legal.md

#### Tags.Legal property

Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

```csharp
public static LegalTagCategory Legal { get; }
```

##### Property Value

A set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

### Origin
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/origin.md

#### Tags.Origin property

Gets the tags that help a user to determine the origin of a file (e.g. template or another source).

```csharp
public static OriginTagCategory Origin { get; }
```

##### Property Value

The tags that help a user to determine the origin of a file (e.g. template or another source).

### Person
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/person.md

#### Tags.Person property

Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.

```csharp
public static PersonTagCategory Person { get; }
```

##### Property Value

A set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation.

### PropertyType
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/propertytype.md

#### Tags.PropertyType property

Gets a set of tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.

```csharp
public static PropertyTypeTagCategory PropertyType { get; }
```

### Time
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/time.md

#### Tags.Time property

Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.

```csharp
public static TimeTagCategory Time { get; }
```

##### Property Value

A set of tags that mark metadata properties used to describe the lifecycle of a file.

### Tool
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tags/tool.md

#### Tags.Tool property

Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.

```csharp
public static ToolTagCategory Tool { get; }
```

##### Property Value

The tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.

### TimeTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory.md

#### TimeTagCategory class

Provides tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.

```csharp
public class TimeTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Created { get; } | Gets the tag that indicates the date a file was created. |
| Delivery { get; } | Gets the tag that indicates the date a file was delivered. |
| Duration { get; } | Gets the tag that denotes the duration of a media file. |
| Expired { get; } | Gets the tag that labels the latest date the owner intends the file data to be used. |
| IntellectualContentCreated { get; } | Gets the tag that denotes the date the intellectual content of a file was created. |
| Modified { get; } | Gets the tag that indicates the date a file was edited. |
| Printed { get; } | Gets the tag that denotes the date a file was printed. |
| Published { get; } | Gets the tag that indicates the date a file became available. |
| TotalEditingTime { get; } | Gets the tag that denotes the total editing time of a file. |
| ZoneCity { get; } | Gets the tag that denotes the time zone. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Created
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/created.md

#### TimeTagCategory.Created property

Gets the tag that indicates the date a file was created.

```csharp
public PropertyTag Created { get; }
```

##### Property Value

The tag that indicates the date a file was created.

### Delivery
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/delivery.md

#### TimeTagCategory.Delivery property

Gets the tag that indicates the date a file was delivered.

```csharp
public PropertyTag Delivery { get; }
```

##### Property Value

The tag that indicates the date a file was delivered.

### Duration
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/duration.md

#### TimeTagCategory.Duration property

Gets the tag that denotes the duration of a media file.

```csharp
public PropertyTag Duration { get; }
```

##### Property Value

The tag that denotes the duration of a media file.

### Expired
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/expired.md

#### TimeTagCategory.Expired property

Gets the tag that labels the latest date the owner intends the file data to be used.

```csharp
public PropertyTag Expired { get; }
```

##### Property Value

The tag that labels the latest date the owner intends the file data to be used.

### IntellectualContentCreated
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/intellectualcontentcreated.md

#### TimeTagCategory.IntellectualContentCreated property

Gets the tag that denotes the date the intellectual content of a file was created.

```csharp
public PropertyTag IntellectualContentCreated { get; }
```

##### Property Value

The tag that denotes the date the intellectual content of a file was created.

### Modified
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/modified.md

#### TimeTagCategory.Modified property

Gets the tag that indicates the date a file was edited.

```csharp
public PropertyTag Modified { get; }
```

##### Property Value

The tag that indicates the date a file was edited.

### Printed
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/printed.md

#### TimeTagCategory.Printed property

Gets the tag that denotes the date a file was printed.

```csharp
public PropertyTag Printed { get; }
```

##### Property Value

The tag that denotes the date a file was printed.

### Published
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/published.md

#### TimeTagCategory.Published property

Gets the tag that indicates the date a file became available.

```csharp
public PropertyTag Published { get; }
```

##### Property Value

The tag that indicates the date a file became available.

### TotalEditingTime
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/totaleditingtime.md

#### TimeTagCategory.TotalEditingTime property

Gets the tag that denotes the total editing time of a file.

```csharp
public PropertyTag TotalEditingTime { get; }
```

##### Property Value

The tag that denotes the total editing time of a file.

### ZoneCity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/timetagcategory/zonecity.md

#### TimeTagCategory.ZoneCity property

Gets the tag that denotes the time zone.

```csharp
public PropertyTag ZoneCity { get; }
```

##### Property Value

The tag that denotes the time zone.

### ToolTagCategory
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory.md

#### ToolTagCategory class

Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.

```csharp
public class ToolTagCategory : TagCategory
```

#### Properties

| Name | Description |
| --- | --- |
| Compression { get; } | Gets the tag that marks a compression. |
| Hardware { get; } | Gets the tag that denotes any kind of hardware used to create a file. |
| HardwareManufacturer { get; } | Gets the tag that marks a hardware manufacturer. |
| HardwareVersion { get; } | Gets the tag that labels properties containing the version of the hardware used to create a file. |
| ModelId { get; } | Gets the tag that marks a model id. |
| Software { get; } | Gets the tag that labels any kind of software used to create a file. |
| SoftwareManufacturer { get; } | Gets the tag that marks a software manufacturer. |
| SoftwareVersion { get; } | Gets the tag that labels properties containing the version of the software used to create a file. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Compression
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/compression.md

#### ToolTagCategory.Compression property

Gets the tag that marks a compression.

```csharp
public PropertyTag Compression { get; }
```

##### Property Value

The tag that marks a compression.

### Hardware
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/hardware.md

#### ToolTagCategory.Hardware property

Gets the tag that denotes any kind of hardware used to create a file.

```csharp
public PropertyTag Hardware { get; }
```

##### Property Value

The tag that denotes any kind of hardware used to create a file.

### HardwareManufacturer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/hardwaremanufacturer.md

#### ToolTagCategory.HardwareManufacturer property

Gets the tag that marks a hardware manufacturer.

```csharp
public PropertyTag HardwareManufacturer { get; }
```

##### Property Value

The tag that marks a hardware manufacturer.

### HardwareVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/hardwareversion.md

#### ToolTagCategory.HardwareVersion property

Gets the tag that labels properties containing the version of the hardware used to create a file.

```csharp
public PropertyTag HardwareVersion { get; }
```

##### Property Value

The tag that labels properties containing the version of the hardware used to create a file.

### ModelId
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/modelid.md

#### ToolTagCategory.ModelId property

Gets the tag that marks a model id.

```csharp
public PropertyTag ModelId { get; }
```

##### Property Value

The tag that marks a model id.

### Software
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/software.md

#### ToolTagCategory.Software property

Gets the tag that labels any kind of software used to create a file.

```csharp
public PropertyTag Software { get; }
```

##### Property Value

The tag that labels any kind of software used to create a file.

### SoftwareManufacturer
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/softwaremanufacturer.md

#### ToolTagCategory.SoftwareManufacturer property

Gets the tag that marks a software manufacturer.

```csharp
public PropertyTag SoftwareManufacturer { get; }
```

##### Property Value

The tag that marks a software manufacturer.

### SoftwareVersion
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.tagging/tooltagcategory/softwareversion.md

#### ToolTagCategory.SoftwareVersion property

Gets the tag that labels properties containing the version of the software used to create a file.

```csharp
public PropertyTag SoftwareVersion { get; }
```

##### Property Value

The tag that labels properties containing the version of the software used to create a file.

### GroupDocs.Metadata
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata.md

The namespace provides main classes allowing working with metadata in all supported formats. The `Metadata` class is the entry point to all features of the library.

#### Classes

| Class | Description |
| --- | --- |
| License | Represents GroupDocs.Metadata license. License class should be applied once per AppDomain. |
| Metadata | Provides the main class to access metadata in all supported formats. |
| Metered | Provides methods to set a metered key. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.metadata.dll -->

### License
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/license.md

#### License class

Represents GroupDocs.Metadata license. License class should be applied once per AppDomain.

```csharp
public sealed class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initializes a new instance of the `License` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

##### Examples

This example demonstrates how to setup a license.

```csharp
// initialize License class
License license = new License();

// set path to .lic file
license.SetLicense(@"C:\\GroupDocs.Metadata.lic");
```

### License
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/license/license.md

#### License constructor

Initializes a new instance of the `License` class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The absolute path to a license file. |

##### Examples

This example demonstrates how to setup license.

```csharp
// initialize License class
License license = new License();

// set path to .lic file
license.SetLicense(@"C:\\GroupDocs.Metadata.lic");    
```

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | License stream. |

### Metadata
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata.md

#### Metadata class

Provides the main class to access metadata in all supported formats.

```csharp
public sealed class Metadata : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Metadata(Stream) | Initializes a new instance of the `Metadata` class. |
| Metadata(string) | Initializes a new instance of the `Metadata` class. |
| Metadata(Uri) | Initializes a new instance of the `Metadata` class. |
| Metadata(Stream, LoadOptions) | Initializes a new instance of the `Metadata` class. |
| Metadata(string, LoadOptions) | Initializes a new instance of the `Metadata` class. |
| Metadata(Uri, LoadOptions) | Initializes a new instance of the `Metadata` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileFormat { get; } | Gets the type of the loaded file (if recognized). |

#### Methods

| Name | Description |
| --- | --- |
| AddProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |
| CopyTo(MetadataPackage) | Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before. |
| CopyTo(MetadataPackage, List&lt;PropertyTag&gt;) | Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before. |
| Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| FindProperties(Func&lt;MetadataProperty, bool&gt;) | Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well. |
| GeneratePreview(PreviewOptions) | Creates preview images for specified pages. |
| GetDocumentInfo() | Gets common information about the loaded document. |
| GetRootPackage() | Gets the root package providing access to all metadata properties extracted from the file. |
| GetRootPackage&lt;TRoot&gt;() | Gets the root package providing access to all metadata properties extracted from the file. |
| RemoveProperties(Func&lt;MetadataProperty, bool&gt;) | Removes metadata properties satisfying the specified predicate. |
| Sanitize() | Removes writable metadata properties from all detected packages or whole packages if possible. The operation is recursive so it affects all nested packages as well. |
| Save() | Saves all changes made in the loaded document. |
| Save(Stream) | Saves the document content into a stream. |
| Save(string) | Saves the document content to the specified file. |
| SetProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in a package that satisfies the predicate it is added to the package. |
| UpdateProperties(Func&lt;MetadataProperty, bool&gt;, PropertyValue) | Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. |

### AddProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/addproperties.md

#### Metadata.AddProperties method

Adds known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

```csharp
public int AddProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties. |

##### Return Value

The number of affected properties.

##### Examples

This example demonstrates how to add some missing metadata properties to a file regardless of its format.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    // Add a property containing the file last printing date if it's missing
    // Note that the property will be added to metadata packages that satisfy the following criteria:
    // 1) Only existing metadata packages will be affected. No new packages are added during this operation
    // 2) There should be a known metadata property in the package structure that fits the search condition but is actually missing in the package.
    // All properties supported by a certain package are usually defined in the specification of a particular metadata standard
    var affected = metadata.AddProperties(p => p.Tags.Contains(Tags.Time.Printed), new PropertyValue(DateTime.Now));

    Console.WriteLine("Affected properties: {0}", affected);

    metadata.Save(Constants.OutputDocx);
}
```

### CopyTo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/copyto.md

#### CopyTo(MetadataPackage)

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

```csharp
public void CopyTo(MetadataPackage metadata)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage | A destination metadata package. |

##### Remarks

If the package types do not match, an error will be returned.

##### Examples

This example demonstrates how to copy metadata properties from source package to destination package.

```csharp
using (Metadata source_metadata = new Metadata(Constants.InputPdf))
using (Metadata destination_metadata = new Metadata(Constants.DestinationPdf))
{
    source_metadata.CopyTo(destination_metadata);

    source_metadata.Save();
}
```

#### CopyTo(MetadataPackage, List&lt;PropertyTag&gt;)

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

```csharp
public int CopyTo(MetadataPackage metadata, List<PropertyTag> tags)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage | A destination metadata package. |
| tags | List`1 | A list of the tags. |

##### Return Value

The number of affected properties.

##### Remarks

If the package types do not match, an error will be returned.

##### Examples

This example demonstrates how to copy metadata properties from source package to destination package.

```csharp
using (Metadata source_metadata = new Metadata(Constants.InputPdf))
using (Metadata destination_metadata = new Metadata(Constants.DestinationPdf))
{
    var tags = new List<PropertyTag>();
    tags.Add(Tags.Content.Album);
    source_metadata.CopyTo(destination_metadata, tags);

    source_metadata.Save();
}
```

### Dispose
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/dispose.md

#### Metadata.Dispose method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

```csharp
public void Dispose()
```

### FileFormat
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/fileformat.md

#### Metadata.FileFormat property

Gets the type of the loaded file (if recognized).

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

The type of the loaded file if recognized; otherwise, Unknown.

### FindProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/findproperties.md

#### Metadata.FindProperties method

Finds the metadata properties satisfying the specified predicate. The search is recursive so it affects all nested packages as well.

```csharp
public IEnumerable<MetadataProperty> FindProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

An IEnumerable that contains properties from the package that satisfy the condition.

##### Examples

This example demonstrates how to search for specific metadata properties using tags.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPptx))
{
    // Fetch all the properties satisfying the predicate:
    // property contains the name of the last document editor OR the date/time the document was last modified
    var properties = metadata.FindProperties(p => p.Tags.Contains(Tags.Person.Editor) || p.Tags.Contains(Tags.Time.Modified));
    foreach (var property in properties)
    {
        Console.WriteLine("Property name: {0}, Property value: {1}", property.Name, property.Value);
    }
}
```

### GeneratePreview
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/generatepreview.md

#### Metadata.GeneratePreview method

Creates preview images for specified pages.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | A set of options for preview generation. |

##### Examples

This code snippet demonstrates how to create image previews for document pages.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    PreviewOptions previewOptions = new PreviewOptions(pageNumber => File.Create($"{Constants.OutputPath}\\result_{pageNumber}.png"));
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.PageNumbers = new int[] { 1 };

    metadata.GeneratePreview(previewOptions);
}
```

### GetDocumentInfo
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/getdocumentinfo.md

#### Metadata.GetDocumentInfo method

Gets common information about the loaded document.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

An object representing common document information.

##### Examples

This example demonstrates how to extract basic format information from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    if (metadata.FileFormat != FileFormat.Unknown)
    {
        IDocumentInfo info = metadata.GetDocumentInfo();
        Console.WriteLine("File format: {0}", info.FileType.FileFormat);
        Console.WriteLine("File extension: {0}", info.FileType.Extension);
        Console.WriteLine("MIME Type: {0}", info.FileType.MimeType);
        Console.WriteLine("Number of pages: {0}", info.PageCount);
        Console.WriteLine("Document size: {0} bytes", info.Size);
        Console.WriteLine("Is document encrypted: {0}", info.IsEncrypted);
    }
}
```

### GetRootPackage
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/getrootpackage.md

#### GetRootPackage()

Gets the root package providing access to all metadata properties extracted from the file.

```csharp
public RootMetadataPackage GetRootPackage()
```

##### Return Value

The root package providing access to all metadata properties extracted from the file.

##### Examples

This example demonstrates how to traverse the whole metadata tree for a specific file regardless of the format.

```csharp
public static void Run()
{
    using (Metadata metadata = new Metadata(Constants.JpegWithXmp))
    {
        DisplayMetadataTree(metadata.GetRootPackage(), 0);
    }
}

private static void DisplayMetadataTree(MetadataPackage package, int indent)
{
    if (package != null)
    {
        var stringMetadataType = package.MetadataType.ToString();
        Console.WriteLine(stringMetadataType.PadLeft(stringMetadataType.Length + indent));
        foreach (MetadataProperty property in package)
        {
            string stringPropertyRepresentation = string.Format("Name: {0}, Value: {1}", property.Name, property.Value);
            Console.WriteLine(stringPropertyRepresentation.PadLeft(stringPropertyRepresentation.Length + indent + 1));
            if (property.Value != null)
            {
                switch (property.Value.Type)
                {
                    case MetadataPropertyType.Metadata:
                        DisplayMetadataTree(property.Value.ToClass<MetadataPackage>(), indent + 2);
                    break;
                    case MetadataPropertyType.MetadataArray:
                        DisplayMetadataTree(property.Value.ToArray<MetadataPackage>(), indent + 2);
                    break;
                }
            }
        }
    }
}

private static void DisplayMetadataTree(MetadataPackage[] packages, int indent)
{
    if (packages != null)
    {
        foreach (var package in packages)
        {
            DisplayMetadataTree(package, indent);
        }
    }
}
```

#### GetRootPackage&lt;TRoot&gt;()

Gets the root package providing access to all metadata properties extracted from the file.

```csharp
public TRoot GetRootPackage<TRoot>()
    where TRoot : RootMetadataPackage
```

| Parameter | Description |
| --- | --- |
| TRoot | The exact type of the root package. |

##### Return Value

The root package providing access to all metadata properties extracted from the file.

### Metadata
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/metadata.md

#### Metadata(string)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | A string that contains the full name of the file from which to create a `Metadata` instance. |

##### Examples

This example demonstrates how to load a file from a local disk.

```csharp
using (Metadata metadata = new Metadata(Constants.InputOne))
{
    // Extract, edit or remove metadata here
}
```

#### Metadata(Stream)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | A stream that contains the document to load. |

##### Examples

This example demonstrates how to load a file from a stream.

```csharp
using (Stream stream = File.Open(Constants.InputDoc, FileMode.Open, FileAccess.ReadWrite))
using (Metadata metadata = new Metadata(stream))
{
   // Extract, edit or remove metadata here
}
```

#### Metadata(string, LoadOptions)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | A string that contains the full name of the file from which to create a `Metadata` instance. |
| loadOptions | LoadOptions | Additional options to use when loading a document. |

##### Examples

This example demonstrates how to load a password-protected document.

```csharp
// Specify the password
var loadOptions = new LoadOptions
{
    Password = "123"
};

using (var metadata = new Metadata(Constants.ProtectedDocx, loadOptions))
{
    // Extract, edit or remove metadata here
}
```

#### Metadata(Stream, LoadOptions)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | A stream that contains the document to load. |
| loadOptions | LoadOptions | Additional options to use when loading a document. |

#### Metadata(Uri)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(Uri uri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | A uri that contains the document to load. |

##### Examples

This example demonstrates how to load a file from a uri.

```csharp
using (Metadata metadata = new Metadata(uri))
{
   // Extract, edit or remove metadata here
}
```

#### Metadata(Uri, LoadOptions)

Initializes a new instance of the `Metadata` class.

```csharp
public Metadata(Uri uri, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | A uri that contains the document to load. |
| loadOptions | LoadOptions | Additional options to use when loading a document. |

### RemoveProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/removeproperties.md

#### Metadata.RemoveProperties method

Removes metadata properties satisfying the specified predicate.

```csharp
public int RemoveProperties(Func<MetadataProperty, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |

##### Return Value

The number of affected properties.

##### Examples

This example demonstrates how to remove specific metadata properties using various criteria.

```csharp
using (Metadata metadata = new Metadata(Constants.InputDocx))
{
    // Remove all the properties satisfying the predicate:
    // property contains the name of the document author OR
    // it refers to the last editor OR
    // the property value is a string that contains the substring "John" (to remove any mentions of John from the detected metadata)
    var affected = metadata.RemoveProperties(
            p => p.Tags.Contains(Tags.Person.Creator) ||
            p.Tags.Contains(Tags.Person.Editor) ||
            p.Value.Type == MetadataPropertyType.String && p.Value.ToString().Contains("John"));

    Console.WriteLine("Properties removed: {0}", affected);

    metadata.Save(Constants.OutputDocx);
}
```

### Sanitize
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/sanitize.md

#### Metadata.Sanitize method

Removes writable metadata properties from all detected packages or whole packages if possible. The operation is recursive so it affects all nested packages as well.

```csharp
public int Sanitize()
```

##### Return Value

The number of affected properties.

##### Examples

This example demonstrates how to remove all detected metadata packages/properties from a file.

```csharp
using (Metadata metadata = new Metadata(Constants.InputPdf))
{
    // Remove detected metadata packages
    var affected = metadata.Sanitize();
    Console.WriteLine("Properties removed: {0}", affected);

    metadata.Save(Constants.OutputPdf);
}
```

### Save
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/save.md

#### Save()

Saves all changes made in the loaded document.

```csharp
public void Save()
```

##### Examples

This example shows how to save the modified content to the underlying source.

```csharp
using (Metadata metadata = new Metadata(Constants.OutputPpt))
{
    // Edit or remove metadata here

    // Saves the document to the underlying source (stream or file)
    metadata.Save();
}
```

#### Save(Stream)

Saves the document content into a stream.

```csharp
public void Save(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | An output stream for the document. |

##### Examples

This example shows how to save a document to the specified stream.

```csharp
using (MemoryStream stream = new MemoryStream())
{
    using (Metadata metadata = new Metadata(Constants.InputPng))
    {
        // Edit or remove metadata here

        metadata.Save(stream);
    }
}
```

#### Save(string)

Saves the document content to the specified file.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The full name of the output file. |

##### Examples

This example shows how to save a document to the specified location.

```csharp
using (Metadata metadata = new Metadata(Constants.InputJpeg))
{
    // Edit or remove metadata here

    metadata.Save(Constants.OutputJpeg);
}
```

### SetProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/setproperties.md

#### Metadata.SetProperties method

Sets known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well. This method is a combination of `AddProperties` and `UpdateProperties`. If an existing property satisfies the predicate its value is updated. If there is a known property missing in a package that satisfies the predicate it is added to the package.

```csharp
public int SetProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties. |

##### Return Value

The number of affected properties.

##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

##### Examples

This example demonstrates how to set specific metadata properties using different criteria.

```csharp
using (Metadata metadata = new Metadata(Constants.InputVsdx))
{
    // Set the value of each property that satisfies the predicate:
    // property contains the date/time the document was created OR modified
    var affected = metadata.SetProperties(
    p => p.Tags.Contains(Tags.Time.Created) || p.Tags.Contains(Tags.Time.Modified),
    new PropertyValue(DateTime.Now));

    Console.WriteLine("Properties set: {0}", affected);

    metadata.Save(Constants.OutputVsdx);
}
```

### UpdateProperties
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metadata/updateproperties.md

#### Metadata.UpdateProperties method

Updates known metadata properties satisfying the specified predicate. The operation is recursive so it affects all nested packages as well.

```csharp
public int UpdateProperties(Func<MetadataProperty, bool> predicate, PropertyValue value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | A function to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties. |

##### Return Value

The number of affected properties.

##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

##### Examples

```csharp
using (Metadata metadata = new Metadata(Constants.InputXlsx))
{
    if (metadata.FileFormat != FileFormat.Unknown && !metadata.GetDocumentInfo().IsEncrypted)
    {
        // Update the file creation date/time if the existing value is older than 3 days
        var affected = metadata.UpdateProperties(p => p.Tags.Contains(Tags.Time.Created) &&
                p.Value.Type == MetadataPropertyType.DateTime &&
                p.Value.ToStruct<DateTime>() < threeDaysAgo, new PropertyValue(today));

        Console.WriteLine("Affected properties: {0}", affected);

        metadata.Save(Constants.OutputXlsx);
    }
}
```

### Metered
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metered.md

#### Metered class

Provides methods to set a metered key.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Sets metered public and private key |
| static GetConsumptionCredit() | Gets the consumption credit. |
| static GetConsumptionQuantity() | Gets the consumption file size. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Gets the consumption credit.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

The consumption credit.

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Gets the consumption file size.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

The consumption file size.

### Metered
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/metadata/net/groupdocs.metadata/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 |

## Node.js

### GroupDocs.Signature for Node.js via Java
Path: https://reference.groupdocs.com/metadata/nodejs-java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.metadata | The **com.groupdocs.metadata** namespace is the entry point to all features of the library. |
| com.groupdocs.metadata.core | The **com.groupdocs.metadata.core** namespace provides main classes allowing working with metadata in all supported formats. |
| com.groupdocs.metadata.export | The **com.groupdocs.metadata.export** namespace contains classes that allow users to export metadata properties to different representations. |
| com.groupdocs.metadata.imports | The **com.groupdocs.metadata.imports** namespace contains classes that allow users to import metadata properties to different representations. |
| com.groupdocs.metadata.licensing | The **com.groupdocs.metadata.licensing** namespace provides classes for licensing the Metadata library. |
| com.groupdocs.metadata.options | The **com.groupdocs.metadata.options** namespace contains all classes representing settings that allow users to control file and metadata processing. |
| com.groupdocs.metadata.search | The **com.groupdocs.metadata.search** namespace contains base classes, utility classes and interfaces used across all formats and metadata standards. |
| com.groupdocs.metadata.tagging | The **com.groupdocs.metadata.tagging** namespace contains various sets of tags with which most important metadata properties are marked.The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format. |

### com.groupdocs.metadata.core
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core.md

The **com.groupdocs.metadata.core** namespace provides main classes allowing working with metadata in all supported formats.

#### Classes

| Class | Description |
| --- | --- |
| ApePackage | Represents an APE v2 metadata package. |
| AsfAudioStreamProperty | Represents Audio stream property metadata in the ASF media container. |
| AsfBaseDescriptor | Represents an ASF base metadata descriptor object. |
| AsfBaseStreamProperty | Represents base stream property metadata in the ASF media container. |
| AsfCodec | Represents ASF codec metadata. |
| AsfContentDescriptor | Represents an ASF content descriptor object. |
| AsfDescriptorType | Defines ASF descriptor types. |
| AsfExtendedStreamPropertyFlags | Defines ASF extended stream property flags. |
| AsfFilePropertyFlags | Defines ASF file property flags. |
| AsfMetadataDescriptor | Represents an ASF metadata descriptor. |
| AsfMetadataDescriptorCollection | Represents a collection of metadata descriptors. |
| AsfPackage | Represents native metadata of the ASF media container. |
| AsfRootPackage | Represents the root package allowing working with metadata in an ASF video. |
| AsfVideoStreamProperty | Represents Video stream property metadata in the ASF media container. |
| AviHeader | Represents the AVIMAINHEADER structure in an AVI video. |
| AviHeaderFlags | Represents AVI Header flags. |
| AviRootPackage | Represents the root package allowing working with metadata in an AVI video. |
| BmpHeaderPackage | Represents BMP header info. |
| BmpRootPackage | Represents the root package intended to work with metadata in a BMP image. |
| CadCustomPropertyPackage | Represents a collection of custom CAD metadata properties. |
| CadPackage | Represents CAD (Computer-aided design) metadata. |
| CadRootPackage | Represents the root package allowing working with metadata in a CAD drawing. |
| CanonCameraSettingsPackage | Represents CANON camera settings. |
| CanonMakerNotePackage | Represents CANON MakerNote metadata. |
| Cms | Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. |
| CmsAttribute | Represents a CMS signer info attribute. |
| CmsCertificate | Represents a CMS certificate. |
| CmsEncapsulatedContent | Represents a signed content container, consisting of a content type identifier and the content itself. |
| CmsPackage | Represents a CMS digital signature metadata package. |
| CmsSigner | Represents CMS per-signer information. |
| Cr2AFConfigPackage | Represents Canon MakerNotes tags. |
| Cr2AFInfo2Package | Represents Canon MakerNotes tags. |
| Cr2AFInfoPackage | Represents Canon MakerNotes tags. |
| Cr2AFMicroAdjPackage | Represents Canon MakerNotes tags. |
| Cr2AspectInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CameraSettingsPackage | Represents Canon MakerNotes tags. |
| Cr2ColorBalancePackage | Represents Canon MakerNotes tags. |
| Cr2ColorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2CropInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FileInfoPackage | Represents Canon MakerNotes tags. |
| Cr2FocalLengthPackage | Represents Canon MakerNotes tags. |
| Cr2Functions1DPackage | Represents Canon MakerNotes tags. |
| Cr2LightingOptPackage | Represents Canon MakerNotes tags. |
| Cr2LogInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MakerNotePackage | Represents Canon MakerNotes tags. |
| Cr2ModifiedInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MovieInfoPackage | Represents Canon MakerNotes tags. |
| Cr2MultiExpPackage | Represents Canon MakerNotes tags. |
| Cr2Package | Represents native CR2 metadata. |
| Cr2PanoramaPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncValuesPackage | Represents Canon MakerNotes tags. |
| Cr2PersonalFuncsPackage | Represents Canon MakerNotes tags. |
| Cr2ProcessingPackage | Represents Canon MakerNotes tags. |
| Cr2RootPackage | Represents an entry point to all metadata packages presented in a particular file CR2. |
| Cr2SensorInfoPackage | Represents Canon MakerNotes tags. |
| Cr2ShotInfoPackage | Represents Canon MakerNotes tags. |
| Cr2TimeInfoPackage | Represents Canon MakerNotes tags. |
| Cr2VignettingCorr2Package | Represents Canon MakerNotes tags. |
| Cr2WBInfoPackage | Represents Canon MakerNotes tags. |
| CustomPackage | Provides a container for metadata properties. |
| DiagramPackage | Represents a native metadata package in a diagram format. |
| DiagramRootPackage | Represents the root package intended to work with metadata in a diagram. |
| DiagramTypePackage | Represents a metadata package containing diagram-specific file format information. |
| DicomPackage | Represents native DICOM metadata. |
| DicomRootPackage | Represents the root package intended to work with metadata in a DICOM image. |
| DigitalSignature | Represents a digital signature used to sign a document. |
| DisposableWrapper<T> |  |
| DjVuRootPackage | Represents the root package intended to work with metadata in an DjVu image. |
| DngPackage | Represents native DNG metadata. |
| DngRootPackage | Represents the root package intended to work with metadata in a DNG image. |
| DocumentInfo | Provides common information about a loaded document. |
| DocumentPackage | Represents native metadata in an office document. |
| DocumentProtectedException | The exception that is thrown when document is protected by password. |
| DocumentRootPackage<TPackage> | Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc. |
| DocumentStatistics | Represents a set of document statistics. |
| DublinCorePackage | Represents a Dublin Core metadata package. |
| DwgRootPackage | Represents the root package allowing working with metadata in a DWG drawing. |
| DxfRootPackage | Represents the root package allowing working with metadata in a DXF drawing. |
| EmailHeaderPackage | Represents a metadata package containing email message headers. |
| EmailPackage | Represents email message metadata. |
| EmailRootPackage | Represents the root package allowing working with metadata in an email message. |
| EmfRootPackage | Represents the root package intended to work with metadata in an EMF image. |
| EmlPackage | Represents EML message metadata. |
| EmlRootPackage | Represents the root package allowing working with metadata in an EML email message. |
| EpubPackage | Represents metadata in a EPUB e-book. |
| EpubRootPackage | Represents the root package allowing working with metadata in an EPUB e-book. |
| ExifDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| ExifGpsPackage | Represents GPS metadata in an EXIF metadata package. |
| ExifIfdPackage | Represents the Exif Image File Directory. |
| ExifPackage | Represents an EXIF metadata package (Exchangeable Image File Format). |
| FileType | Represents the file type. |
| FileTypePackage | Represents a metadata package containing file format information. |
| FlvHeader | Represents a FLV video header. |
| FlvRootPackage | Represents the root package allowing working with metadata in an FLV video. |
| GifImageTypePackage | Represents a metadata package containing GIF-specific file format information. |
| GifRootPackage | Represents the root package intended to work with metadata in a GIF image. |
| GpsIfdPackage | Represents GPS IFD. |
| GroupDocsMetadataException | Represents a product-specific exception that is thrown during file processing. |
| HeifRootPackage | Represents the root package intended to work with metadata in a HEIF image. |
| ID3Tag | Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags. |
| ID3V1Genre | Specifies genres used in an Id3v1 tag. |
| ID3V1Tag | Represents an ID3v1 tag. |
| ID3V2AttachedPictureFrame | Represents an APIC frame in an  ID3V2Tag . |
| ID3V2AttachedPictureType | Represents the type of an attached picture. |
| ID3V2CommentFrame | Represents a COMM frame in an  ID3V2Tag . |
| ID3V2MlltFrame | Represents an MLLT frame in an  ID3V2Tag . |
| ID3V2PlayCounterFrame | Represents a PCNT frame in an  ID3V2Tag . |
| ID3V2PrivateFrame | Represents a PRIV frame in an  ID3V2Tag . |
| ID3V2Tag | Represents an ID3v2 tag. |
| ID3V2TagFrame | Represents a generic frame in an  ID3V2Tag . |
| ID3V2TagFrameFlags | Represents flags used in a ID3v2 tag frame. |
| ID3V2TextFrame | Represents a text frame in an  ID3V2Tag . |
| ID3V2UrlLinkFrame | Represents a URL link frame in an  ID3V2Tag . |
| ID3V2UserDefinedFrame | Represents a TXXX frame in an  ID3V2Tag . |
| ID3V2UserDefinedUrlLinkFrame | Represents a WXXX frame in an  ID3V2Tag . |
| ImageResourceBlock |  |
| ImageResourceID | Image resources standard ID numbers. |
| ImageResourcePackage | Represents a metadata package containing Photoshop Image Resources. |
| ImageRootPackage | Provides a base abstract class for all image root packages. |
| ImageTypePackage | Represents a metadata package containing image-specific file format information. |
| InteroperabilityIFDPointerPackage | Represents Interoperability IFD. |
| InvalidFormatException | The exception that is thrown when a file has an invalid format. |
| IptcApplicationRecord | Represents an IPTC Application Record. |
| IptcDataSet | Represents an IPTC DataSet (metadata property). |
| IptcEnvelopeRecord | Represents an IPTC Envelope Record. |
| IptcEnvelopeRecordDataSet | Defines IPTC Envelope Record dataSet numbers. |
| IptcRecord | Represents an IPTC record. |
| IptcRecordSet | Represents a collection of IPTC records. |
| IptcRecordType | Defines IPTC record types. |
| Jpeg2000Package | Represents native JPEG2000 metadata. |
| Jpeg2000RootPackage | Represents the root package intended to work with metadata in a JPEG2000 image. |
| JpegRootPackage | Represents the root package allowing working with metadata in a JPEG image. |
| LyricsField | Represents a  LyricsTag  field. |
| LyricsTag | Represents Lyrics3 v2.00 metadata. |
| MP3RootPackage | Represents the root package allowing working with metadata in an MP3 audio. |
| MakerNotePackage | Provides an abstract base class for MakerNote metadata packages. |
| MatroskaAudioTrack | Represents audio metadata in a Matroska video. |
| MatroskaBasePackage | Provides a base metadata class for all packages extracted from a Matroska video. |
| MatroskaEbmlHeader | Represents EBML header metadata in a Matroska video. |
| MatroskaPackage | Represents a metadata container in a Matroska video. |
| MatroskaRootPackage | Represents the root package allowing working with metadata in a Matroska video. |
| MatroskaSegment | Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video. |
| MatroskaSimpleTag | Represents general information about the target in a Matroska video. |
| MatroskaSubtitle | Represents subtitle metadata in a Matroska video. |
| MatroskaSubtitleTrack | Represents subtitle metadata in a Matroska video. |
| MatroskaTag | Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video. |
| MatroskaTrack | Represents track metadata in a Matroska video. |
| MatroskaVideoTrack | Represents video metadata in a Matroska video. |
| MetadataPackage | Represents base abstraction for a metadata package. |
| MetadataProperty | Represents a metadata property. |
| MetadataValidationException | The exception that is thrown when validation errors encountered during metadata saving. |
| MovAtom | Represents a QuickTime atom. |
| MovPackage | Represents QuickTime metadata. |
| MovRootPackage | Represents the root package allowing working with metadata in a QuickTime video. |
| MpegAudioPackage | Represents MPEG audio metadata. |
| MsgPackage | Represents MSG message metadata. |
| MsgRootPackage | Represents the root package allowing working with metadata in an MSG email message. |
| NikonMakerNotePackage | Represents NIKON MakerNote metadata. |
| NoteInspectionPackage | Represents a metadata package exposing the internal structure of a note section. |
| NotePage | Represents a page in a OneNote section. |
| NoteRootPackage | Represents the root package intended to work with metadata in an electronic note file. |
| Oid | Represents an object identifier (OID). |
| OpenTypeBaseNameRecord | Represents the base OpenType Name table record class. |
| OpenTypeFlags | Represents OpenType font header flags. |
| OpenTypeFont | Represents a single font extracted from a file. |
| OpenTypeLicensingRights | Indicates font embedding licensing rights for the font. |
| OpenTypeMacintoshNameRecord | Represents the Name record table value for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypePackage | Represents an OpenType font metadata package. |
| OpenTypeRootPackage | Represents the root package allowing working with metadata in an OpenType font file. |
| OpenTypeStyles | Represents the OpenType font style. |
| OpenTypeUnicodeNameRecord | Represents the Name record table value for the  OpenTypePlatform.Unicode  platform. |
| OpenTypeWindowsNameRecord | Represents the Name record table value for  OpenTypePlatform.Windows  platform. |
| PageInfo | Provides common information about a document page (slide, worksheet, etc). |
| PanasonicMakerNotePackage | Represents PANASONIC MakerNote metadata. |
| PdfAnnotation | Represents an annotation in a PDF document. |
| PdfAttachment | Represents an attachment in a PDF document. |
| PdfBookmark | Represents a bookmark in a PDF document. |
| PdfFormField | Represents a form field in a PDF document. |
| PdfInspectionPackage | Contains information about PDF document parts that can be considered as metadata in some cases. |
| PdfPackage | Represents native metadata in a PDF document. |
| PdfRootPackage | Represents the root package allowing working with metadata in a PDF document. |
| PdfTypePackage | Represents a metadata package containing PDF-specific file format information. |
| PngCompressedTextChunk | Represents compressed textual data extracted from a PNG image. |
| PngInternationalTextChunk | Represents international textual data extracted from a PNG image. |
| PngPackage | Represents native PNG metadata. |
| PngRootPackage | Represents the root package intended to work with metadata in a PNG image. |
| PngTextChunk | Represents textual data extracted from a PNG image. |
| PresentationComment | Represents a user comment in a presentation. |
| PresentationInspectionPackage | Contains information about presentation parts that can be considered as metadata in some cases. |
| PresentationPackage | Represents a native metadata package in a presentation. |
| PresentationRootPackage | Represents the root package intended to work with metadata in a presentation. |
| PresentationSlide | Represents a slide in a presentation. |
| PresentationTypePackage | Represents a metadata package containing presentation-specific file format information. |
| ProjectManagementPackage | Represents a native metadata package in a project management file. |
| ProjectManagementRootPackage | Represents the root package intended to work with metadata in a project management format. |
| PropertyAccessLevels | Defines access levels for metadata properties. |
| PropertyDescriptor | Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine. |
| PropertyValue | Represents a property value. |
| PsdLayer | Represents a layer in a PSD file. |
| PsdLayerFlags | The Photoshop layer flags. |
| PsdPackage | Represents native Photoshop metadata. |
| PsdRootPackage | Represents the root package allowing working with metadata in a Photoshop Document. |
| RarFile | Represents metadata associated with an archived file or directory. |
| RarPackage | Represents ZIP archive metadata. |
| RarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| RawDictionaryBasePackage | Provides an abstract base class for EXIF metadata dictionaries. |
| RawExifTagPackage | Represents Exif tags. |
| RawIFD1Package | Represents IFD1 tags. |
| RawIFD2Package | Represents IFD1 tags. |
| RawIFD3Package | Represents IFD1 tags. |
| RawMakerNotePackage | Represents Raw MakerNotes tags. |
| RawTiffTagPackage | Represents Tiff tags. |
| RawTypePackage | Represents a metadata package containing image-specific file format information. |
| ReadOnlyList<T> | Provides an abstract base class for a strongly typed read-only list. |
| Rectangle | A set of four integers that represent the location and size of a rectangle. |
| RiffInfoPackage | Represents the metadata package containing properties extracted from the RIFF INFO chunk. |
| RootMetadataPackage | Represents an entry point to all metadata packages presented in a particular file. |
| SevenZipFile | Represents metadata associated with an archived file or directory. |
| SevenZipPackage | Represents ZIP archive metadata. |
| SevenZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| SonyMakerNotePackage | Represents SONY MakerNote metadata. |
| SpreadsheetComment | Represents a user comment in a spreadsheet. |
| SpreadsheetContentTypePackage | Represents a metadata package containing spreadsheet content type properties. |
| SpreadsheetContentTypeProperty | Represents a content type property in a spreadsheet. |
| SpreadsheetInspectionPackage | Contains information about spreadsheet parts that can be considered as metadata in some cases. |
| SpreadsheetPackage | Represents a native metadata package in a spreadsheet. |
| SpreadsheetRootPackage | Represents the root package allowing working with metadata in a spreadsheet. |
| SpreadsheetSheet | Represents a sheet in a spreadsheet document. |
| SpreadsheetTypePackage | Represents a metadata package containing spreadsheet-specific file format information. |
| TarFile | Represents metadata associated with an archived file or directory. |
| TarPackage | Represents ZIP archive metadata. |
| TarRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |
| TiffArrayTag<T> | Represents an array-based TIFF tag. |
| TiffAsciiTag | Represents a TIFF ASCII tag. |
| TiffByteTag | Represents a Byte tag. |
| TiffDoubleTag | Represents a TIFF Double tag. |
| TiffFloatTag | Represents a TIFF float tag. |
| TiffLongTag | Represents a TIFF Long tag. |
| TiffRational | Represents a rational number. |
| TiffRationalTag | Represents a TIFF Rational tag. |
| TiffRootPackage | Represents the root package allowing working with metadata in a TIFF image. |
| TiffSByteTag | Represents a TIFF SByte tag. |
| TiffSLongTag | Represents a TIFF SLong tag. |
| TiffSRational | Represents signed rational number. |
| TiffSRationalTag | Represents a TIFF SRational tag. |
| TiffSShortTag | Represents a TIFF SShort tag. |
| TiffShortTag | Represents a TIFF Short tag. |
| TiffTag | Represents a TIFF tag. |
| TiffTagID | Defines ids of TIFF tags. |
| TiffUndefinedTag | Represents a TIFF tag with the Undefined type. |
| TorrentPackage | Represents torrent descriptor file metadata. |
| TorrentRootPackage | Represents the root package intended to work with metadata of a TORRENT file. |
| TorrentSharedFilePackage | Represents shared file information. |
| VCardAgentRecord | Represents vCard Agent record metadata class. |
| VCardBasePackage | Represents the base VCard metadata class. |
| VCardBinaryRecord | Represents vCard binary record metadata class. |
| VCardCalendarRecordset | Represents a set of Calendar vCard records. |
| VCardCard | Represents a single card extracted from a VCard file. |
| VCardCommunicationRecordset | Represents a set of Communication vCard records. |
| VCardCustomRecord | Represents vCard custom record metadata class. |
| VCardDateTimeRecord | Represents vCard date time record metadata class. |
| VCardDeliveryAddressingRecordset | Represents a set of Delivery Addressing vCard records. |
| VCardExplanatoryRecordset | Represents a set of Explanatory vCard records. |
| VCardGeneralRecordset | Represents a set of General vCard records. |
| VCardGeographicalRecordset | Represents a set of Geographical vCard records. |
| VCardIdentificationRecordset | Represents a set of Identification vCard records. |
| VCardOrganizationalRecordset | Represents a set of Organizational vCard records. |
| VCardPackage | Represents VCF (Virtual Contact File) electronic business card format metadata. |
| VCardRecord | Represents abstract vCard record metadata class. |
| VCardRecordset | Provides a base vCard record union class. |
| VCardRootPackage | Represents the root package allowing working with metadata in a VCard file. |
| VCardSecurityRecordset | Represents a set of Security vCard records. |
| VCardTextRecord | Represents vCard text record metadata class. |
| ValueAcceptor | Provides a base abstract class that allows extracting all supported types of values from a  PropertyValue  instance. |
| ValueInterpreter | Defines operations required to interpret metadata property values. |
| WavPackage | Represents a native metadata package in a WAV audio file. |
| WavRootPackage | Represents the root package allowing working with metadata in a WAV audio. |
| WebPRootPackage | Represents the root package allowing working with metadata in a WEBP image. |
| WmfRootPackage | Represents the root package intended to work with metadata in a WMF image. |
| WordProcessingComment | Represents a comment in a word processing document. |
| WordProcessingField | Represents a field in a word processing document. |
| WordProcessingInspectionPackage | Contains information about document parts that can be considered as metadata in some cases. |
| WordProcessingPackage | Represents a native metadata package in a word processing document. |
| WordProcessingRevision | Represents a revision (tracked change) in a document. |
| WordProcessingRootPackage | Represents the root package allowing working with metadata in a word processing document. |
| WordProcessingTypePackage | Represents a metadata package containing document-specific file format information. |
| XmpArray | Represents base abstraction for XMP array. |
| XmpAudioChannelType | Represents audio channel type. |
| XmpAudioSampleType | Represents Audio sample type in  XmpDynamicMediaPackage . |
| XmpBasicJobTicketPackage | Represents Basic Job-Ticket namespace. |
| XmpBasicPackage | Represents the XMP basic namespace. |
| XmpBoolean | Represents XMP Boolean basic type. |
| XmpCameraRawPackage | Represents Camera Raw schema. |
| XmpClosedChoice<T> | Represents XMP Closed Choice. |
| XmpColorantBase | A structure containing the characteristics of a colorant (swatch) used in a document. |
| XmpColorantCmyk | Represents the CMYK Colorant. |
| XmpColorantLab | Represents the LAB Colorant. |
| XmpColorantRgb | Represents the RGB Colorant. |
| XmpComplexType | Represents base abstraction for XMP Complex value type. |
| XmpComplexTypeValue | Represents an XMP value containing a complex type instance. |
| XmpDate | Represents Date in XMP packet. |
| XmpDimensions | Containing dimensions for a drawn object. |
| XmpDublinCorePackage | Represents the Dublin Core scheme. |
| XmpDynamicMediaPackage | Represents XMP Dynamic Media namespace. |
| XmpElementBase | Represents base XMP element that contains attributes. |
| XmpException | The exception that is thrown when XMP has invalid structure. |
| XmpFont | A structure containing the characteristics of a font used in a document. |
| XmpGuid | Represents XMP global unique identifier. |
| XmpHeaderPI | Represents XMP header processing instruction. |
| XmpInteger | Represents XMP Integer basic type. |
| XmpIptcCorePackage | Represents the IPTC Core XMP package. |
| XmpIptcExtensionPackage | Represents the IPTC Extension XMP package. |
| XmpIptcIimPackage | Represents the IPTC-IIM XMP package. |
| XmpJob | Represents Job. |
| XmpLangAlt |  |
| XmpMediaManagementPackage | Represents the XMP Media Management namespace. |
| XmpMeta | Represents xmpmeta. |
| XmpMetadataContainer | Represents a container for XMP metadata properties. |
| XmpNamespaces | Contains namespaces used in  XmpPackage  and  XmpComplexType . |
| XmpPackage | Represents base abstraction for XMP package. |
| XmpPacketWrapper | Contains serialized XMP package including header and trailer. |
| XmpPagedTextPackage | Represents the XMP Paged-Text package. |
| XmpPdfPackage | Specifies properties used with Adobe PDF documents. |
| XmpPhotoshopPackage | Represents Adobe Photoshop namespace. |
| XmpRational | Represents XMP XmpRational. |
| XmpReal | Represents XMP Real. |
| XmpRenditionClass | Represents XMP RenditionClass. |
| XmpResourceEvent | Represents a high-level event that occurred in the processing of a resource. |
| XmpResourceRef |  |
| XmpRightsManagementPackage | Represents XMP Rights Management namespace. |
| XmpSchemes | Provides access to known XMP schemes. |
| XmpText | Represents XMP Text basic type. |
| XmpThumbnail | Represents a thumbnail image for a file. |
| XmpTime | Representation of a time value in seconds. |
| XmpTimeFormat | Represents time format in  XmpTimecode . |
| XmpTimecode | Represents a timecode value in a video. |
| XmpTrailerPI | Represents XMP trailer processing instruction. |
| XmpValueBase | Represents base XMP value. |
| XmpVersion | Represents a version of a document. |
| XmpWhiteBalance | Represents the White Balance setting in  XmpCameraRawPackage . |
| ZipFile | Represents metadata associated with an archived file or directory. |
| ZipPackage | Represents ZIP archive metadata. |
| ZipRootPackage | Represents the root package allowing working with metadata in a ZIP archive. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Provides common information about a loaded document. |
| IDublinCore | Defines base operations allowing working with Dublin Core metadata. |
| IEnumValue | Defines a value of an enumeration. |
| IEnumValueInterpreter | Represents an interpreter intended to convert various numeric values to descriptive string values. |
| IExif | Defines base operations intended to work with EXIF metadata. |
| IIptc | Represents base operations intended to work with IPTC metadata. |
| IReadOnlyList<T> | Represents a read-only collection of elements that can be accessed by index. |
| IXmp | Defines base operations intended to work with XMP metadata. |
| IXmpType | Base interface for XMP type. |

#### Enumerations

| Enum | Description |
| --- | --- |
| AsfCodecType | Defines ASF codec types. |
| AsfStreamType | Defines ASF stream types. |
| ByteOrder | Defines various byte orders. |
| CadAcadVersion | Defines AutoCAD drawing database version numbers. |
| DiagramFormat | Defines various diagram subformats. |
| ExifGpsAltitudeRef | Represents a GPS altitude reference. |
| FileFormat | Represents the recognized format of a loaded file. |
| ID3V2EncodingType | Defines different types of text encoding used in ID3v2. |
| IptcApplicationRecordDataSet | Defines IPTC Application Record dataSet numbers. |
| MatroskaContentType | Represents a Matroska content type. |
| MatroskaTargetTypeValue | Represents a number to indicate the logical level of the Matroska tag target. |
| MatroskaTrackType | Represents Matroska track types coded in 8 bits. |
| MatroskaVideoDisplayUnit | Defines how Matroska DisplayWidth and DisplayHeight are interpreted. |
| MatroskaVideoFieldOrder | Represents the field ordering of the Matroska video. |
| MatroskaVideoFlagInterlaced | Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| MatroskaVideoStereoMode | Represents Matroska Stereo-3D video modes. |
| MetadataPropertyType | Defines metadata property types. |
| MetadataType | Specifies the type of a metadata package. |
| MpegAudioVersion | Represents a particular MPEG standard. |
| MpegChannelMode | Defines MPEG audio channel modes. |
| MpegEmphasis | Defines MPEG emphasis types. |
| OpenTypeDigitalSignatureFlags | Represents OpenType font digital signature flags. |
| OpenTypeDirectionHint | Represents the OpenType font direction. |
| OpenTypeIsoEncoding | Represents encoding for the  OpenTypePlatform.Iso  platform. |
| OpenTypeMacintoshEncoding | Represents encoding for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypeMacintoshLanguage | Represents language enum for the  OpenTypePlatform.Macintosh  platform. |
| OpenTypeName | Defines pre-defined IDs, they apply to all platforms unless indicated otherwise. |
| OpenTypePlatform | Represents OpenType platform for Name table. |
| OpenTypeUnicodeEncoding | Represents encoding for  OpenTypePlatform.Unicode  platform. |
| OpenTypeVersion | Represents the OpenType version. |
| OpenTypeWeight | Represents the OpenType font weight. |
| OpenTypeWidth | Represents the OpenType font width. |
| OpenTypeWindowsEncoding | Represents encoding for the  OpenTypePlatform.Windows  platform. |
| OpenTypeWindowsLanguage | Represents language for  OpenTypePlatform.Windows  platform. |
| PngCompressionMethod | Defines compression methods used in the PNG format. |
| PresentationFormat | Defines various presentation subformats. |
| PsdColorMode | Represents the psd file format color mode. |
| PsdCompressionMethod | Defines the compression method used for image data. |
| RawIntegerType | Defines raw integer types for enumerations. |
| SpreadsheetFormat | Defines various spreadsheet subformats. |
| TiffTagType | Represents the IFD data type. |
| VCardContentType | Defines vCard record content types. |
| WordProcessingFormat | Defines various word processing document subformats. |
| WordProcessingRevisionType | Specifies the type of the change being tracked by a revision. |
| XmpArrayType | Represents array type in  XmpArray . |
| XmpColorType | Type of color in  XmpColorantBase . |
| XmpColorantColorMode | Represents color mode in  XmpColorantBase . |
| XmpCropUnit | Represent a unit for CropWidth and CropHeight in  XmpCameraRawPackage . |
| XmpPhotoshopColorMode | Represents a color mode in  XmpPhotoshopPackage . |
| ZipCompressionMethod | Defines ZIP compression methods. |

### ApePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/apepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ApePackage extends CustomPackage
```

Represents an APE v2 metadata package. Please find more information at  [http://wiki.hydrogenaud.io/index.php?title=APE\_key][http_wiki.hydrogenaud.io_index.php_title_APE_key] .

This example demonstrates how to read the APEv2 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithApe)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getApeV2() != null) {
>          System.out.println(root.getApeV2().getAlbum());
>          System.out.println(root.getApeV2().getTitle());
>          System.out.println(root.getApeV2().getArtist());
>          System.out.println(root.getApeV2().getComposer());
>          System.out.println(root.getApeV2().getCopyright());
>          System.out.println(root.getApeV2().getGenre());
>          System.out.println(root.getApeV2().getLanguage());
>          // ...
>      }
>  }
>
> ```
> ```

[http_wiki.hydrogenaud.io_index.php_title_APE_key]: http://wiki.hydrogenaud.io/index.php?title=APE_key
[Handling the APEv2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+APEv2+tag
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets the title. |
| getSubtitle() | Gets the subtitle. |
| getArtist() | Gets the artist. |
| getAlbum() | Gets the album. |
| getDebutAlbum() | Gets the debut album. |
| getPublisher() | Gets the publisher. |
| getConductor() | Gets the conductor. |
| getTrack() | Gets the track number. |
| getComposer() | Gets the composer. |
| getComment() | Gets the comment. |
| getCopyright() | Gets the copyright. |
| getPublicationRight() | Gets the publication right. |
| getFile() | Gets the file. |
| getIsbn() | Gets the ISBN number with check digit. |
| getRecordLocation() | Gets the record location. |
| getGenre() | Gets the genre. |
| getIsrc() | Gets the International Standard Recording Number. |
| getAbstract() | Gets the abstract link. |
| getLanguage() | Gets the language. |
| getBibliography() | Gets the bibliography. |
##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### getSubtitle()
```
public final String getSubtitle()
```

Gets the subtitle.

**Returns:**
java.lang.String - The subtitle.
##### getArtist()
```
public final String getArtist()
```

Gets the artist.

**Returns:**
java.lang.String - The artist.
##### getAlbum()
```
public final String getAlbum()
```

Gets the album.

**Returns:**
java.lang.String - The album.
##### getDebutAlbum()
```
public final String getDebutAlbum()
```

Gets the debut album.

**Returns:**
java.lang.String - The debut album.
##### getPublisher()
```
public final String getPublisher()
```

Gets the publisher.

**Returns:**
java.lang.String - The publisher.
##### getConductor()
```
public final String getConductor()
```

Gets the conductor.

**Returns:**
java.lang.String - The conductor.
##### getTrack()
```
public final Integer getTrack()
```

Gets the track number.

**Returns:**
java.lang.Integer - The track number.
##### getComposer()
```
public final String getComposer()
```

Gets the composer.

**Returns:**
java.lang.String - The composer.
##### getComment()
```
public final String getComment()
```

Gets the comment.

**Returns:**
java.lang.String - The comment.
##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright.

**Returns:**
java.lang.String - The copyright.
##### getPublicationRight()
```
public final String getPublicationRight()
```

Gets the publication right.

**Returns:**
java.lang.String - The publication right.
##### getFile()
```
public final String getFile()
```

Gets the file.

**Returns:**
java.lang.String - The file.
##### getIsbn()
```
public final String getIsbn()
```

Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International\_Standard\_Book\_Number.

**Returns:**
java.lang.String - The ISBN number.
##### getRecordLocation()
```
public final String getRecordLocation()
```

Gets the record location.

**Returns:**
java.lang.String - The record location.
##### getGenre()
```
public final String getGenre()
```

Gets the genre.

**Returns:**
java.lang.String - The genre.
##### getIsrc()
```
public final String getIsrc()
```

Gets the International Standard Recording Number.

**Returns:**
java.lang.String - The International Standard Recording Number.
##### getAbstract()
```
public final String getAbstract()
```

Gets the abstract link.

**Returns:**
java.lang.String - The abstract link.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language.

**Returns:**
java.lang.String - The language.
##### getBibliography()
```
public final String getBibliography()
```

Gets the bibliography.

**Returns:**
java.lang.String - The bibliography.

### AsfAudioStreamProperty
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfaudiostreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.AsfBaseStreamProperty
```
public class AsfAudioStreamProperty extends AsfBaseStreamProperty
```

Represents Audio stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getFormatTag() | Gets the unique ID of the codec used to encode the audio data. |
| getChannels() | Gets the number of audio channels. |
| getSamplesPerSecond() | Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream. |
| getBitsPerSample() | Gets the number of bits per sample of monaural data. |
##### getFormatTag()
```
public final int getFormatTag()
```

Gets the unique ID of the codec used to encode the audio data.

**Returns:**
int - The unique ID of the codec used to encode the audio data.
##### getChannels()
```
public final int getChannels()
```

Gets the number of audio channels.

**Returns:**
int - The number of audio channels.
##### getSamplesPerSecond()
```
public final long getSamplesPerSecond()
```

Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.

**Returns:**
long - The a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.
##### getBitsPerSample()
```
public final int getBitsPerSample()
```

Gets the number of bits per sample of monaural data.

**Returns:**
int - The number of bits per sample of monaural data.

### AsfBaseDescriptor
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfbasedescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public abstract class AsfBaseDescriptor extends MetadataProperty
```

Represents an ASF base metadata descriptor object.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getAsfContentType() | Gets the type of the content. |
##### getAsfContentType()
```
public final AsfDescriptorType getAsfContentType()
```

Gets the type of the content.

**Returns:**
AsfDescriptorType - The type of the content.

### AsfBaseStreamProperty
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfbasestreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class AsfBaseStreamProperty extends CustomPackage
```

Represents base stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getStreamType() | Gets the type of this stream. |
| getStreamNumber() | Gets the number of this stream. |
| getStartTime() | Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole. |
| getEndTime() | Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| getBitrate() | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| getAlternateBitrate() | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead. |
| getFlags() | Gets the flags. |
| getLanguage() | Gets the stream language. |
| getAverageTimePerFrame() | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| getAverageBitrate() | Gets the average bitrate. |
##### getStreamType()
```
public final AsfStreamType getStreamType()
```

Gets the type of this stream.

**Returns:**
AsfStreamType - The type of this stream.
##### getStreamNumber()
```
public final byte getStreamNumber()
```

Gets the number of this stream.

**Returns:**
byte - The number of this stream.
##### getStartTime()
```
public final Long getStartTime()
```

Gets the presentation time of the first object, indicating where this digital media stream starts within the context of the timeline of the ASF file as a whole.

**Returns:**
java.lang.Long - The presentation time of the first object.
##### getEndTime()
```
public final Long getEndTime()
```

Gets the presentation time of the last object plus the duration of play, indicating where this digital media stream ends within the context of the timeline of the ASF file as a whole.

**Returns:**
java.lang.Long - The presentation time of the last object plus the duration of play.
##### getBitrate()
```
public final Long getBitrate()
```

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

**Returns:**
java.lang.Long - The bleak rate R, in bits per second.
##### getAlternateBitrate()
```
public final Long getAlternateBitrate()
```

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion of the stream without overflowing, excluding all ASF Data Packet overhead.

**Returns:**
java.lang.Long - The leak rate RAlt, in bits per second.
##### getFlags()
```
public final AsfExtendedStreamPropertyFlags getFlags()
```

Gets the flags.

**Returns:**
AsfExtendedStreamPropertyFlags - The flags.
##### getLanguage()
```
public final String getLanguage()
```

Gets the stream language.

**Returns:**
java.lang.String - The stream language.
##### getAverageTimePerFrame()
```
public final Long getAverageTimePerFrame()
```

Gets the average time duration, measured in 100-nanosecond units, of each frame.

**Returns:**
java.lang.Long - The average time duration, measured in 100-nanosecond units, of each frame.
##### getAverageBitrate()
```
public final Long getAverageBitrate()
```

Gets the average bitrate.

**Returns:**
java.lang.Long - The average bitrate.

### AsfCodec
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfcodec.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfCodec extends CustomPackage
```

Represents ASF codec metadata.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getCodecType() | Gets the type of the codec. |
| getDescription() | Gets the description. |
| getInformation() | Gets the information string. |
##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getCodecType()
```
public final AsfCodecType getCodecType()
```

Gets the type of the codec.

**Returns:**
AsfCodecType - The type of the codec.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getInformation()
```
public final String getInformation()
```

Gets the information string.

**Returns:**
java.lang.String - The information string.

### AsfCodecType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfcodectype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum AsfCodecType extends Enum<AsfCodecType> implements IEnumValue
```

Defines ASF codec types.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined codec. |
| Video | Video codec. |
| Audio | Audio codec. |
| Unknown | Unknown codec. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final AsfCodecType Undefined
```

Undefined codec.

##### Video
```
public static final AsfCodecType Video
```

Video codec.

##### Audio
```
public static final AsfCodecType Audio
```

Audio codec.

##### Unknown
```
public static final AsfCodecType Unknown
```

Unknown codec.

##### values()
```
public static AsfCodecType[] values()
```

**Returns:**
com.groupdocs.metadata.core.AsfCodecType[]
##### valueOf(String name)
```
public static AsfCodecType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
AsfCodecType
##### getByRawValue(int rawValue)
```
public static AsfCodecType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AsfCodecType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### AsfContentDescriptor
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfcontentdescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.AsfBaseDescriptor
```
public final class AsfContentDescriptor extends AsfBaseDescriptor
```

Represents an ASF content descriptor object.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files

### AsfDescriptorType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfdescriptortype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfDescriptorType implements IEnumValue
```

Defines ASF descriptor types.
#### Fields

| Field | Description |
| --- | --- |
| Unicode | The unicode string type. |
| ByteArray | The byte array type. |
| Bool | The 32-bit bool type. |
| DWord | The 32-bit unsigned integer type. |
| QWord | The 64-bit unsigned integer type. |
| Word | The 16-bit unsigned integer type. |
| Guid | The 128-bit (16 byte) GUID type. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Unicode
```
public static final AsfDescriptorType Unicode
```

The unicode string type.

##### ByteArray
```
public static final AsfDescriptorType ByteArray
```

The byte array type.

##### Bool
```
public static final AsfDescriptorType Bool
```

The 32-bit bool type.

##### DWord
```
public static final AsfDescriptorType DWord
```

The 32-bit unsigned integer type.

##### QWord
```
public static final AsfDescriptorType QWord
```

The 64-bit unsigned integer type.

##### Word
```
public static final AsfDescriptorType Word
```

The 16-bit unsigned integer type.

##### Guid
```
public static final AsfDescriptorType Guid
```

The 128-bit (16 byte) GUID type.

##### getByRawValue(int rawValue)
```
public static AsfDescriptorType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AsfDescriptorType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### AsfExtendedStreamPropertyFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfextendedstreampropertyflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfExtendedStreamPropertyFlags implements IEnumValue
```

Defines ASF extended stream property flags.
#### Fields

| Field | Description |
| --- | --- |
| Reliable | This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism. |
| Seekable | This flag should be set only if the stream is seekable. |
| NoCleanpoints | The stream does not contain any cleanpoints. |
| ResendLiveCleanpoints | A stream is joined in mid-transmission, all information from the most recent cleanpoint up to the current time should be sent before normal streaming begins at the current time. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Reliable
```
public static final AsfExtendedStreamPropertyFlags Reliable
```

This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism.

##### Seekable
```
public static final AsfExtendedStreamPropertyFlags Seekable
```

This flag should be set only if the stream is seekable.

##### NoCleanpoints
```
public static final AsfExtendedStreamPropertyFlags NoCleanpoints
```

The stream does not contain any cleanpoints.

##### ResendLiveCleanpoints
```
public static final AsfExtendedStreamPropertyFlags ResendLiveCleanpoints
```

A stream is joined in mid-transmission, all information from the most recent cleanpoint up to the current time should be sent before normal streaming begins at the current time.

##### getByRawValue(int rawValue)
```
public static AsfExtendedStreamPropertyFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AsfExtendedStreamPropertyFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### AsfFilePropertyFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asffilepropertyflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AsfFilePropertyFlags implements IEnumValue
```

Defines ASF file property flags.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined flag. |
| Broadcast | Specifies, that a file is in the process of being created, and thus that various values stored in the header objects are invalid. |
| Seekable | Specifies, that a file is seekable. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Undefined
```
public static final AsfFilePropertyFlags Undefined
```

The undefined flag.

##### Broadcast
```
public static final AsfFilePropertyFlags Broadcast
```

Specifies, that a file is in the process of being created, and thus that various values stored in the header objects are invalid.

##### Seekable
```
public static final AsfFilePropertyFlags Seekable
```

Specifies, that a file is seekable.

##### getByRawValue(int rawValue)
```
public static AsfFilePropertyFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AsfFilePropertyFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### AsfMetadataDescriptor
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfmetadatadescriptor.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.AsfBaseDescriptor
```
public final class AsfMetadataDescriptor extends AsfBaseDescriptor
```

Represents an ASF metadata descriptor.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getLanguage() | Gets the language. |
| getStreamNumber() | Gets the stream number. |
| getOriginalName() | Gets the original name of the descriptor. |
##### getLanguage()
```
public final String getLanguage()
```

Gets the language.

**Returns:**
java.lang.String - The language.
##### getStreamNumber()
```
public final int getStreamNumber()
```

Gets the stream number.

**Returns:**
int - The stream number.
##### getOriginalName()
```
public final String getOriginalName()
```

Gets the original name of the descriptor.

**Returns:**
java.lang.String - The original name of the descriptor.

### AsfMetadataDescriptorCollection
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfmetadatadescriptorcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfMetadataDescriptorCollection extends CustomPackage
```

Represents a collection of metadata descriptors.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files

### AsfPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class AsfPackage extends CustomPackage
```

Represents native metadata of the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getFileID() | Gets the unique identifier for this file. |
| getCreationDate() | Gets the date and time of the initial creation of the file. |
| getFlags() | Gets the header flags. |
| getStreamProperties() | Gets the digital media stream properties. |
| getMetadataDescriptors() | Gets the metadata descriptors. |
| getCodecInformation() | Gets the codec info entries. |
##### getFileID()
```
public final UUID getFileID()
```

Gets the unique identifier for this file.

**Returns:**
java.util.UUID - The unique identifier for this file.
##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the date and time of the initial creation of the file.

**Returns:**
java.util.Date - The date and time of the initial creation of the file.
##### getFlags()
```
public final AsfFilePropertyFlags getFlags()
```

Gets the header flags.

**Returns:**
AsfFilePropertyFlags - The header flags.
##### getStreamProperties()
```
public final AsfBaseStreamProperty[] getStreamProperties()
```

Gets the digital media stream properties.

**Returns:**
com.groupdocs.metadata.core.AsfBaseStreamProperty[] - The digital media stream properties.
##### getMetadataDescriptors()
```
public final AsfBaseDescriptor[] getMetadataDescriptors()
```

Gets the metadata descriptors.

**Returns:**
com.groupdocs.metadata.core.AsfBaseDescriptor[] - The metadata descriptors.
##### getCodecInformation()
```
public final AsfCodec[] getCodecInformation()
```

Gets the codec info entries.

**Returns:**
com.groupdocs.metadata.core.AsfCodec[] - The codec info entries.

### AsfRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class AsfRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an ASF video.

This code sample demonstrates how to read native ASF metadata.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputAsf)) {
>      AsfRootPackage root = metadata.getRootPackageGeneric();
>      AsfPackage asfPackage = root.getAsfPackage();
>      // Display basic properties
>      System.out.println(String.format("Creation date: %s", asfPackage.getCreationDate()));
>      System.out.println(String.format("File id: %s", asfPackage.getFileID()));
>      System.out.println(String.format("Flags: %s", asfPackage.getFlags()));
>      // Display Asf Codec Information
>      for (AsfCodec codecInfo : asfPackage.getCodecInformation()) {
>          System.out.println(String.format("Codec type: %s", codecInfo.getCodecType()));
>          System.out.println(String.format("Description: %s", codecInfo.getDescription()));
>          System.out.println(String.format("Codec information: %s", codecInfo.getInformation()));
>          System.out.println(codecInfo.getName());
>      }
>      // Display metadata descriptors
>      for (AsfBaseDescriptor descriptor : asfPackage.getMetadataDescriptors()) {
>          System.out.println(String.format("Name: %s", descriptor.getName()));
>          System.out.println(String.format("Value: %s", descriptor.getValue()));
>          System.out.println(String.format("Content type: %s", descriptor.getAsfContentType()));
>          if (descriptor instanceof AsfMetadataDescriptor) {
>              AsfMetadataDescriptor metadataDescriptor = (AsfMetadataDescriptor) descriptor;
>              System.out.println(String.format("Language: %s", metadataDescriptor.getLanguage()));
>              System.out.println(String.format("Stream number: %s", metadataDescriptor.getStreamNumber()));
>              System.out.println(String.format("Original name: %s", metadataDescriptor.getOriginalName()));
>          }
>      }
>      //Display the base stream properties
>      for (AsfBaseStreamProperty property : asfPackage.getStreamProperties()) {
>          System.out.println(String.format("Alternate bitrate: %s", property.getAlternateBitrate()));
>          System.out.println(String.format("Average bitrate: %s", property.getAverageBitrate()));
>          System.out.println(String.format("Average time per frame: %s", property.getAverageTimePerFrame()));
>          System.out.println(String.format("Bitrate: %s", property.getBitrate()));
>          System.out.println(String.format("Stream end time: %s", property.getEndTime()));
>          System.out.println(String.format("Stream flags: %s", property.getFlags()));
>          System.out.println(String.format("Stream language: %s", property.getLanguage()));
>          System.out.println(String.format("Stream start time: %s", property.getStartTime()));
>          System.out.println(String.format("Stream number: %s", property.getStreamNumber()));
>          System.out.println(String.format("Stream type: %s", property.getStreamType()));
>          //Display the audio stream properties
>          if (property instanceof AsfAudioStreamProperty) {
>              AsfAudioStreamProperty audioStreamProperty = (AsfAudioStreamProperty) property;
>              System.out.println(String.format("Audio bits per sample: %s", audioStreamProperty.getBitsPerSample()));
>              System.out.println(String.format("Audio channels: %s", audioStreamProperty.getChannels()));
>              System.out.println(String.format("Audio format tag: %s", audioStreamProperty.getFormatTag()));
>              System.out.println(String.format("Audio samples per second: %s", audioStreamProperty.getSamplesPerSecond()));
>          }
>          //Display the video stream properties
>          if (property instanceof AsfVideoStreamProperty) {
>              AsfVideoStreamProperty videoStreamProperty = (AsfVideoStreamProperty) property;
>              System.out.println(String.format("Video bits per pixels: %s", videoStreamProperty.getBitsPerPixels()));
>              System.out.println(String.format("Compression: %s", videoStreamProperty.getCompression()));
>              System.out.println(String.format("Image height: %s", videoStreamProperty.getImageHeight()));
>              System.out.println(String.format("Image width: %s", videoStreamProperty.getImageWidth()));
>          }
>      }
>  }
>
> ```
> ```

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAsfPackage() | Gets the ASF metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| copyTo(MetadataPackage metadata) |  |
##### getAsfPackage()
```
public final AsfPackage getAsfPackage()
```

Gets the ASF metadata package.

**Returns:**
AsfPackage - The ASF metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### AsfStreamType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfstreamtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum AsfStreamType extends Enum<AsfStreamType> implements IEnumValue
```

Defines ASF stream types.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined stream type. |
| Audio | ASF Audio Media. |
| Video | ASF Video Media. |
| Command | ASF Command Media. |
| Jfif | ASF JFIF Media. |
| DegradableJpeg | ASF Degradable JPEG Media. |
| FileTransfer | ASF File Transfer Media. |
| Binary | ASF Binary Media. |
| WebStreamSubtype | ASF Web Stream Media Subtype. |
| WebStreamFormat | ASF Web Stream Format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final AsfStreamType Undefined
```

Undefined stream type.

##### Audio
```
public static final AsfStreamType Audio
```

ASF Audio Media.

##### Video
```
public static final AsfStreamType Video
```

ASF Video Media.

##### Command
```
public static final AsfStreamType Command
```

ASF Command Media.

##### Jfif
```
public static final AsfStreamType Jfif
```

ASF JFIF Media.

##### DegradableJpeg
```
public static final AsfStreamType DegradableJpeg
```

ASF Degradable JPEG Media.

##### FileTransfer
```
public static final AsfStreamType FileTransfer
```

ASF File Transfer Media.

##### Binary
```
public static final AsfStreamType Binary
```

ASF Binary Media.

##### WebStreamSubtype
```
public static final AsfStreamType WebStreamSubtype
```

ASF Web Stream Media Subtype.

##### WebStreamFormat
```
public static final AsfStreamType WebStreamFormat
```

ASF Web Stream Format.

##### values()
```
public static AsfStreamType[] values()
```

**Returns:**
com.groupdocs.metadata.core.AsfStreamType[]
##### valueOf(String name)
```
public static AsfStreamType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
AsfStreamType
##### getByRawValue(int rawValue)
```
public static AsfStreamType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AsfStreamType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### AsfVideoStreamProperty
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/asfvideostreamproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.AsfBaseStreamProperty
```
public class AsfVideoStreamProperty extends AsfBaseStreamProperty
```

Represents Video stream property metadata in the ASF media container.

[Working with Metadata in ASF Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+Metadata+in+ASF+Files
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the width of the encoded image in pixels. |
| getImageHeight() | Gets the height of the encoded image in pixels. |
| getCompression() | Gets the video compression Id. |
| getBitsPerPixels() | Gets the bits per pixels. |
##### getImageWidth()
```
public final long getImageWidth()
```

Gets the width of the encoded image in pixels.

**Returns:**
long - The width of the encoded image in pixels.
##### getImageHeight()
```
public final long getImageHeight()
```

Gets the height of the encoded image in pixels.

**Returns:**
long - The height of the encoded image in pixels.
##### getCompression()
```
public final long getCompression()
```

Gets the video compression Id.

**Returns:**
long - The video compression Id.
##### getBitsPerPixels()
```
public final long getBitsPerPixels()
```

Gets the bits per pixels.

**Returns:**
long - The bits per pixels.

### AviHeader
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/aviheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class AviHeader extends CustomPackage
```

Represents the AVIMAINHEADER structure in an AVI video.

[Working with metadata in AVI files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+AVI+files
#### Constructors

| Constructor | Description |
| --- | --- |
| AviHeader() | Initializes a new instance of the  AviHeader  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMicroSecPerFrame() | Gets the the number of microseconds between frames. |
| getMaxBytesPerSec() |  |
| getPaddingGranularity() | Gets the alignment for data, in bytes. |
| getAviHeaderFlags() | Gets a bitwise combination of zero or more of the AVI flags. |
| getTotalFrames() | Gets the the total number of frames of data in the file. |
| getInitialFrames() |  |
| getStreams() | Gets the number of streams in the file. |
| getSuggestedBufferSize() |  |
| getWidth() | Gets the width of the AVI file in pixels. |
| getHeight() | Gets the height of the AVI file in pixels. |
##### AviHeader()
```
public AviHeader()
```

Initializes a new instance of the  AviHeader  class.

##### getMicroSecPerFrame()
```
public final int getMicroSecPerFrame()
```

Gets the the number of microseconds between frames. This value indicates the overall timing for the file.

**Returns:**
int - The number of microseconds between frames.
##### getMaxBytesPerSec()
```
public final int getMaxBytesPerSec()
```

Gets the approximate maximum data rate of the file.

 This value indicates the number of bytes per second the system must handle to present an AVI sequence as specified by the other parameters contained in the main header and stream header chunks.

**Returns:**
int - The the approximate maximum data rate of the file.
##### getPaddingGranularity()
```
public final int getPaddingGranularity()
```

Gets the alignment for data, in bytes. Pad the data to multiples of this value.

**Returns:**
int - The the alignment for data.
##### getAviHeaderFlags()
```
public final AviHeaderFlags getAviHeaderFlags()
```

Gets a bitwise combination of zero or more of the AVI flags.

**Returns:**
AviHeaderFlags - The AVI flags.
##### getTotalFrames()
```
public final int getTotalFrames()
```

Gets the the total number of frames of data in the file.

**Returns:**
int - The total number of frames.
##### getInitialFrames()
```
public final int getInitialFrames()
```

Gets the initial frame for interleaved files.

 Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames in the file prior to the initial frame of the AVI sequence in this member.

**Returns:**
int - The initial frames.
##### getStreams()
```
public final int getStreams()
```

Gets the number of streams in the file. For example, a file with audio and video has two streams.

**Returns:**
int - The number of streams.
##### getSuggestedBufferSize()
```
public final int getSuggestedBufferSize()
```

Gets the suggested buffer size for reading the file.

 Generally, this size should be large enough to contain the largest chunk in the file. If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file, the buffer size should be large enough to read an entire record, and not just a chunk.

**Returns:**
int - The suggested buffer size for reading the file.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the AVI file in pixels.

**Returns:**
int - The width in pixels.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the AVI file in pixels.

**Returns:**
int - The height in pixels.

### AviHeaderFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/aviheaderflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class AviHeaderFlags implements IEnumValue
```

Represents AVI Header flags.
#### Fields

| Field | Description |
| --- | --- |
| HasIndex | Indicates the AVI file has an index. |
| MustUseIndex | Indicates that application should use the index, rather than the physical ordering of the chunks in the file, to determine the order of presentation of the data. |
| IsInterleaved | Indicates the AVI file is interleaved. |
| TrustCkType | Use CKType to find key frames. |
| WasCaptureFile | Indicates the AVI file is a specially allocated file used for capturing real-time video. |
| Copyrighted | Indicates the AVI file contains copyrighted data and software. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### HasIndex
```
public static final AviHeaderFlags HasIndex
```

Indicates the AVI file has an index.

##### MustUseIndex
```
public static final AviHeaderFlags MustUseIndex
```

Indicates that application should use the index, rather than the physical ordering of the chunks in the file, to determine the order of presentation of the data. For example, this flag could be used to create a list of frames for editing.

##### IsInterleaved
```
public static final AviHeaderFlags IsInterleaved
```

Indicates the AVI file is interleaved.

##### TrustCkType
```
public static final AviHeaderFlags TrustCkType
```

Use CKType to find key frames.

##### WasCaptureFile
```
public static final AviHeaderFlags WasCaptureFile
```

Indicates the AVI file is a specially allocated file used for capturing real-time video. Applications should warn the user before writing over a file with this flag set because the user probably defragmented this file.

##### Copyrighted
```
public static final AviHeaderFlags Copyrighted
```

Indicates the AVI file contains copyrighted data and software. When this flag is used, software should not permit the data to be duplicated.

##### getByRawValue(int rawValue)
```
public static AviHeaderFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
AviHeaderFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### AviRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/avirootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class AviRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an AVI video.

This code snippet shows how to read AVI header properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputAvi)) {
>      AviRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getHeader().getAviHeaderFlags());
>      System.out.println(root.getHeader().getHeight());
>      System.out.println(root.getHeader().getWidth());
>      System.out.println(root.getHeader().getTotalFrames());
>      System.out.println(root.getHeader().getInitialFrames());
>      System.out.println(root.getHeader().getMaxBytesPerSec());
>      System.out.println(root.getHeader().getPaddingGranularity());
>      System.out.println(root.getHeader().getStreams());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in AVI files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+AVI+files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getHeader() | Gets the AVI header package. |
| getRiffInfoPackage() | Gets the package containing RIFF Info tags. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getHeader()
```
public final AviHeader getHeader()
```

Gets the AVI header package.

**Returns:**
AviHeader - The AVI header package.
##### getRiffInfoPackage()
```
public final RiffInfoPackage getRiffInfoPackage()
```

Gets the package containing RIFF Info tags.

**Returns:**
RiffInfoPackage - The package containing RIFF Info tags.

### BmpHeaderPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/bmpheaderpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class BmpHeaderPackage extends CustomPackage
```

Represents BMP header info.

[Working with BMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+BMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getHeaderSize() | Gets the size of the header in bytes. |
| getBitsPerPixel() | Gets the bits per pixel value. |
| getImageSize() | Gets the bitmap raw data size in bytes. |
| getPlanes() | Gets the number of planes. |
| getColorsImportant() | Gets the number of important palette colors. |
##### getHeaderSize()
```
public final long getHeaderSize()
```

Gets the size of the header in bytes.

**Returns:**
long - The size of the header in bytes.
##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets the bits per pixel value.

**Returns:**
int - The bits per pixel value.
##### getImageSize()
```
public final long getImageSize()
```

Gets the bitmap raw data size in bytes.

**Returns:**
long - The bitmap raw data size in bytes.
##### getPlanes()
```
public final int getPlanes()
```

Gets the number of planes.

**Returns:**
int - The number of planes.
##### getColorsImportant()
```
public final long getColorsImportant()
```

Gets the number of important palette colors.

**Returns:**
long - The number of important palette colors.

### BmpRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/bmprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class BmpRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a BMP image.

This code sample shows how to read the header of a BMP file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputBmp)) {
>      BmpRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getBmpHeader().getBitsPerPixel());
>      System.out.println(root.getBmpHeader().getColorsImportant());
>      System.out.println(root.getBmpHeader().getHeaderSize());
>      System.out.println(root.getBmpHeader().getImageSize());
>      System.out.println(root.getBmpHeader().getPlanes());
>  }
>
> ```
> ```

[Working with BMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+BMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getBmpHeader() | Gets the BMP header metadata package. |
##### getBmpHeader()
```
public final BmpHeaderPackage getBmpHeader()
```

Gets the BMP header metadata package.

**Returns:**
BmpHeaderPackage - The BMP header metadata package.

### ByteOrder
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/byteorder.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ByteOrder extends Enum<ByteOrder> implements IEnumValue
```

Defines various byte orders.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The byte order is unknown. |
| BigEndian | Big endian. |
| LittleEndian | Little endian. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final ByteOrder Unknown
```

The byte order is unknown.

##### BigEndian
```
public static final ByteOrder BigEndian
```

Big endian.

##### LittleEndian
```
public static final ByteOrder LittleEndian
```

Little endian.

##### values()
```
public static ByteOrder[] values()
```

**Returns:**
com.groupdocs.metadata.core.ByteOrder[]
##### valueOf(String name)
```
public static ByteOrder valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ByteOrder
##### getByRawValue(int rawValue)
```
public static ByteOrder getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ByteOrder
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### CadAcadVersion
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cadacadversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum CadAcadVersion extends Enum<CadAcadVersion> implements IEnumValue
```

Defines AutoCAD drawing database version numbers.
#### Fields

| Field | Description |
| --- | --- |
| None | Non-versioned. |
| Ac1006 | AutoCAD drawing database R10. |
| Ac1009 | AutoCAD drawing database R11 and R12. |
| Ac1012 | AutoCAD drawing database R13. |
| Ac1014 | AutoCAD drawing database R14. |
| Ac1015 | AutoCAD drawing database AutoCAD 2000. |
| Ac1018 | AutoCAD drawing database AutoCAD 2004. |
| Ac1021 | AutoCAD drawing database AutoCAD 2007. |
| Ac1024 | AutoCAD drawing database AutoCAD 2010. |
| Ac1027 | AutoCAD drawing database AutoCAD 2013. |
| Ac1032 | AutoCAD drawing database AutoCAD 2018. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final CadAcadVersion None
```

Non-versioned.

##### Ac1006
```
public static final CadAcadVersion Ac1006
```

AutoCAD drawing database R10.

##### Ac1009
```
public static final CadAcadVersion Ac1009
```

AutoCAD drawing database R11 and R12.

##### Ac1012
```
public static final CadAcadVersion Ac1012
```

AutoCAD drawing database R13.

##### Ac1014
```
public static final CadAcadVersion Ac1014
```

AutoCAD drawing database R14.

##### Ac1015
```
public static final CadAcadVersion Ac1015
```

AutoCAD drawing database AutoCAD 2000.

##### Ac1018
```
public static final CadAcadVersion Ac1018
```

AutoCAD drawing database AutoCAD 2004.

##### Ac1021
```
public static final CadAcadVersion Ac1021
```

AutoCAD drawing database AutoCAD 2007.

##### Ac1024
```
public static final CadAcadVersion Ac1024
```

AutoCAD drawing database AutoCAD 2010.

##### Ac1027
```
public static final CadAcadVersion Ac1027
```

AutoCAD drawing database AutoCAD 2013.

##### Ac1032
```
public static final CadAcadVersion Ac1032
```

AutoCAD drawing database AutoCAD 2018.

##### values()
```
public static CadAcadVersion[] values()
```

**Returns:**
com.groupdocs.metadata.core.CadAcadVersion[]
##### valueOf(String name)
```
public static CadAcadVersion valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
CadAcadVersion
##### getByRawValue(int rawValue)
```
public static CadAcadVersion getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
CadAcadVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### CadCustomPropertyPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cadcustompropertypackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CadCustomPropertyPackage extends CustomPackage
```

Represents a collection of custom CAD metadata properties.

### CadPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cadpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CadPackage extends CustomPackage
```

Represents CAD (Computer-aided design) metadata.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAcadVersion() | Gets the AutoCAD drawing database version number. |
| getHeight() | Gets the drawing height. |
| getWidth() | Gets the drawing width. |
| getAuthor() | Gets the drawing author. |
| getComments() | Gets the user comments. |
| getHyperlinkBase() | Gets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| getLastSavedBy() | Gets the name of the last editor. |
| getRevisionNumber() | Gets the revision number. |
| getSubject() | Gets the subject. |
| getTitle() | Gets the title. |
| getCreatedDateTime() | Gets the date and time when the drawing was created. |
| getModifiedDateTime() | Gets the date and time when the drawing was modified. |
| getCustomProperties() | Gets the package containing custom metadata properties. |
##### getAcadVersion()
```
public final CadAcadVersion getAcadVersion()
```

Gets the AutoCAD drawing database version number.

**Returns:**
CadAcadVersion - The AutoCAD drawing database version number.
##### getHeight()
```
public final int getHeight()
```

Gets the drawing height.

**Returns:**
int - The drawing height.
##### getWidth()
```
public final int getWidth()
```

Gets the drawing width.

**Returns:**
int - The drawing width.
##### getAuthor()
```
public final String getAuthor()
```

Gets the drawing author.

**Returns:**
java.lang.String - The drawing author.
##### getComments()
```
public final String getComments()
```

Gets the user comments.

**Returns:**
java.lang.String - The user comments.
##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last editor.

**Returns:**
java.lang.String - The name of the last editor.
##### getRevisionNumber()
```
public final String getRevisionNumber()
```

Gets the revision number.

**Returns:**
java.lang.String - The revision number.
##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### getCreatedDateTime()
```
public final Date getCreatedDateTime()
```

Gets the date and time when the drawing was created.

**Returns:**
java.util.Date - The date and time when the drawing was created.
##### getModifiedDateTime()
```
public final Date getModifiedDateTime()
```

Gets the date and time when the drawing was modified.

**Returns:**
java.util.Date - The date and time when the drawing was modified.
##### getCustomProperties()
```
public final CadCustomPropertyPackage getCustomProperties()
```

Gets the package containing custom metadata properties.

**Returns:**
CadCustomPropertyPackage - The package containing custom metadata properties.

### CadRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cadrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class CadRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a CAD drawing.

This code sample shows how to read metadata of a CAD drawing.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDxf)) {
>      CadRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getCadPackage().getAcadVersion());
>      System.out.println(root.getCadPackage().getAuthor());
>      System.out.println(root.getCadPackage().getComments());
>      System.out.println(root.getCadPackage().getCreatedDateTime());
>      System.out.println(root.getCadPackage().getHyperlinkBase());
>      System.out.println(root.getCadPackage().getKeywords());
>      System.out.println(root.getCadPackage().getLastSavedBy());
>      System.out.println(root.getCadPackage().getTitle());
>      // ...
>  }
>
> ```
> ```

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCadPackage() | Gets the CAD metadata package. |
##### getCadPackage()
```
public final CadPackage getCadPackage()
```

Gets the CAD metadata package.

**Returns:**
CadPackage - The CAD metadata package.

### CanonCameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/canoncamerasettingspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CanonCameraSettingsPackage extends CustomPackage
```

Represents CANON camera settings.
#### Methods

| Method | Description |
| --- | --- |
| getMacroMode() | Gets the macro mode. |
| getSelfTimer() | Gets the self timer. |
| getQuality() | Gets the quality. |
| getCanonFlashMode() | Gets the canon flash mode. |
| getContinuousDrive() | Gets the continuous drive. |
| getFocusMode() | Gets the focus mode. |
| getRecordMode() | Gets the record mode. |
| getCanonImageSize() | Gets the size of the canon image. |
| getEasyMode() | Gets the easy mode. |
| getDigitalZoom() | Gets the digital zoom. |
| getContrast() | Gets the contrast. |
| getSaturation() | Gets the saturation. |
| getSharpness() | Gets the sharpness. |
| getCameraIso() | Gets the camera iso. |
| getMeteringMode() | Gets the metering mode. |
| getFocusRange() | Gets the focus range. |
| getAFPoint() | Gets the AFPoint. |
| getCanonExposureMode() | Gets the canon exposure mode. |
| getLensType() | Gets the type of the lens. |
| getMaxFocalLength() | Gets the maximum length of the focal. |
| getMinFocalLength() | Gets the minimum length of the focal. |
| getImageStabilization() | Gets the image stabilization. |
##### getMacroMode()
```
public final short getMacroMode()
```

Gets the macro mode.

**Returns:**
short - The macro mode.
##### getSelfTimer()
```
public final short getSelfTimer()
```

Gets the self timer.

**Returns:**
short - The self timer.
##### getQuality()
```
public final short getQuality()
```

Gets the quality.

**Returns:**
short - The quality.
##### getCanonFlashMode()
```
public final short getCanonFlashMode()
```

Gets the canon flash mode.

**Returns:**
short - The canon flash mode.
##### getContinuousDrive()
```
public final short getContinuousDrive()
```

Gets the continuous drive.

**Returns:**
short - The continuous drive.
##### getFocusMode()
```
public final short getFocusMode()
```

Gets the focus mode.

**Returns:**
short - The focus mode.
##### getRecordMode()
```
public final short getRecordMode()
```

Gets the record mode.

**Returns:**
short - The record mode.
##### getCanonImageSize()
```
public final short getCanonImageSize()
```

Gets the size of the canon image.

**Returns:**
short - The size of the canon image.
##### getEasyMode()
```
public final short getEasyMode()
```

Gets the easy mode.

**Returns:**
short - The easy mode.
##### getDigitalZoom()
```
public final short getDigitalZoom()
```

Gets the digital zoom.

**Returns:**
short - The digital zoom.
##### getContrast()
```
public final short getContrast()
```

Gets the contrast.

**Returns:**
short - The contrast.
##### getSaturation()
```
public final short getSaturation()
```

Gets the saturation.

**Returns:**
short - The saturation.
##### getSharpness()
```
public final short getSharpness()
```

Gets the sharpness.

**Returns:**
short - The sharpness.
##### getCameraIso()
```
public final short getCameraIso()
```

Gets the camera iso.

**Returns:**
short - The camera iso.
##### getMeteringMode()
```
public final short getMeteringMode()
```

Gets the metering mode.

**Returns:**
short - The metering mode.
##### getFocusRange()
```
public final short getFocusRange()
```

Gets the focus range.

**Returns:**
short - The focus range.
##### getAFPoint()
```
public final short getAFPoint()
```

Gets the AFPoint.

**Returns:**
short - The AFPoint.
##### getCanonExposureMode()
```
public final short getCanonExposureMode()
```

Gets the canon exposure mode.

**Returns:**
short - The canon exposure mode.
##### getLensType()
```
public final int getLensType()
```

Gets the type of the lens.

**Returns:**
int - The type of the lens.
##### getMaxFocalLength()
```
public final int getMaxFocalLength()
```

Gets the maximum length of the focal.

**Returns:**
int - The maximum length of the focal.
##### getMinFocalLength()
```
public final int getMinFocalLength()
```

Gets the minimum length of the focal.

**Returns:**
int - The minimum length of the focal.
##### getImageStabilization()
```
public final short getImageStabilization()
```

Gets the image stabilization.

**Returns:**
short - The image stabilization.

### CanonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/canonmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class CanonMakerNotePackage extends MakerNotePackage
```

Represents CANON MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getCameraSettings() | Gets the camera settings. |
| getCanonImageType() | Gets the Canon image type. |
| getCanonFirmwareVersion() | Gets the canon firmware version. |
| getFileNumber() | Gets the file number. |
| getOwnerName() | Gets the name of the owner. |
| getSerialNumber() | Gets the serial number. |
| getCanonFileLength() | Gets the length of the canon file. |
| getCanonModelID() | Gets the canon model identifier. |
##### getCameraSettings()
```
public final CanonCameraSettingsPackage getCameraSettings()
```

Gets the camera settings.

**Returns:**
CanonCameraSettingsPackage - The camera settings.
##### getCanonImageType()
```
public final String getCanonImageType()
```

Gets the Canon image type.

**Returns:**
java.lang.String - The Canon type of the image.
##### getCanonFirmwareVersion()
```
public final String getCanonFirmwareVersion()
```

Gets the canon firmware version.

**Returns:**
java.lang.String - The canon firmware version.
##### getFileNumber()
```
public final Long getFileNumber()
```

Gets the file number.

**Returns:**
java.lang.Long - The file number.
##### getOwnerName()
```
public final String getOwnerName()
```

Gets the name of the owner.

**Returns:**
java.lang.String - The name of the owner.
##### getSerialNumber()
```
public final Long getSerialNumber()
```

Gets the serial number.

**Returns:**
java.lang.Long - The serial number.
##### getCanonFileLength()
```
public final Long getCanonFileLength()
```

Gets the length of the canon file.

**Returns:**
java.lang.Long - The length of the canon file.
##### getCanonModelID()
```
public final Long getCanonModelID()
```

Gets the canon model identifier.

**Returns:**
java.lang.Long - The canon model identifier.

### Cms
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cms.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DigitalSignature
```
public class Cms extends DigitalSignature
```

Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages. CMS is based on the syntax of PKCS \#7, specified in RFC 5652. Please see  https://tools.ietf.org/html/rfc5652  for more information.
#### Methods

| Method | Description |
| --- | --- |
| getDigestAlgorithms() | Gets the array of message-digest algorithm identifiers. |
| getEncapsulatedContent() | Gets the signed content, consisting of a content type identifier and the content itself. |
| getCertificates() | Gets the collection of certificates. |
| getSigners() | Gets the collection of per-signer information packages. |
| getSignTime() | Gets the time at which the signer (purportedly) performed the signing process. |
##### getDigestAlgorithms()
```
public final Oid[] getDigestAlgorithms()
```

Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero.

**Returns:**
com.groupdocs.metadata.core.Oid[] - The array of message-digest algorithm identifiers.
##### getEncapsulatedContent()
```
public final CmsEncapsulatedContent getEncapsulatedContent()
```

Gets the signed content, consisting of a content type identifier and the content itself.

**Returns:**
CmsEncapsulatedContent - The signed content, consisting of a content type identifier and the content itself.
##### getCertificates()
```
public final CmsCertificate[] getCertificates()
```

Gets the collection of certificates.

**Returns:**
com.groupdocs.metadata.core.CmsCertificate[] - The collection of certificates.

It is intended that the set of certificates be sufficient to contain certification paths from a recognized "root" or "top-level certification authority" to all of the signers in the SignerInfo field.
##### getSigners()
```
public final CmsSigner[] getSigners()
```

Gets the collection of per-signer information packages.

**Returns:**
com.groupdocs.metadata.core.CmsSigner[] - The collection of per-signer information packages.

There may be any number of elements in the collection, including zero.
##### getSignTime()
```
public Date getSignTime()
```

Gets the time at which the signer (purportedly) performed the signing process.

**Returns:**
java.util.Date - The time at which the signer (purportedly) performed the signing process.

### CmsAttribute
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cmsattribute.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsAttribute extends CustomPackage
```

Represents a CMS signer info attribute.
#### Methods

| Method | Description |
| --- | --- |
| getOid() | Gets the attribute OID. |
| getValue() | Gets the attribute value represented as a string. |
##### getOid()
```
public final Oid getOid()
```

Gets the attribute OID.

**Returns:**
Oid - The attribute OID.
##### getValue()
```
public final String getValue()
```

Gets the attribute value represented as a string.

**Returns:**
java.lang.String - The attribute value represented as a string.

### CmsCertificate
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cmscertificate.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsCertificate extends CustomPackage
```

Represents a CMS certificate.
#### Methods

| Method | Description |
| --- | --- |
| getNotAfter() | Gets the date in local time after which a certificate is no longer valid. |
| getNotBefore() | Gets the date in local time on which a certificate becomes valid. |
| getRawData() | Gets the raw data of this certificate. |
##### getNotAfter()
```
public final Date getNotAfter()
```

Gets the date in local time after which a certificate is no longer valid.

**Returns:**
java.util.Date - The date in local time after which a certificate is no longer valid.
##### getNotBefore()
```
public final Date getNotBefore()
```

Gets the date in local time on which a certificate becomes valid.

**Returns:**
java.util.Date - The date in local time on which a certificate becomes valid.
##### getRawData()
```
public final byte[] getRawData()
```

Gets the raw data of this certificate.

**Returns:**
byte[] - The raw data of this certificate.

### CmsEncapsulatedContent
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cmsencapsulatedcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsEncapsulatedContent extends CustomPackage
```

Represents a signed content container, consisting of a content type identifier and the content itself.
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the object identifier uniquely specifies the content type. |
| getContentRawData() | Gets the raw data of content info. |
##### getContentType()
```
public final Oid getContentType()
```

Gets the object identifier uniquely specifies the content type.

**Returns:**
Oid - The object identifier uniquely specifies the content type.
##### getContentRawData()
```
public final byte[] getContentRawData()
```

Gets the raw data of content info.

**Returns:**
byte[] - The raw data of content info.

### CmsPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cmspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class CmsPackage extends CustomPackage
```

Represents a CMS digital signature metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getSignatures() | Gets an array of the signatures extracted from the file. |
| getFlags() | Gets the digital signature flags. |
##### getSignatures()
```
public final Cms[] getSignatures()
```

Gets an array of the signatures extracted from the file.

**Returns:**
com.groupdocs.metadata.core.Cms[] - An array of the signatures extracted from the file.
##### getFlags()
```
public final Integer getFlags()
```

Gets the digital signature flags.

**Returns:**
java.lang.Integer - The digital signature flags.

### CmsSigner
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cmssigner.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class CmsSigner extends CustomPackage
```

Represents CMS per-signer information.
#### Methods

| Method | Description |
| --- | --- |
| getSignerIdentifier() | Gets the signer's certificate (and thereby the signer's public key) raw data. |
| getDigestAlgorithm() | Gets the message digest algorithm, and any associated parameters, used by the signer. |
| getSignedAttributes() | Gets the collection of attributes that are signed. |
| getSignatureAlgorithm() | Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature. |
| getSignatureValue() | Gets the result of digital signature generation, using the message digest and the signer's private key. |
| getUnsignedAttributes() | Gets the collection of attributes that are not signed. |
| getSigningTime() | Gets the time at which the signer (purportedly) performed the signing process. |
##### getSignerIdentifier()
```
public final byte[] getSignerIdentifier()
```

Gets the signer's certificate (and thereby the signer's public key) raw data.

**Returns:**
byte[] - The signer's certificate (and thereby the signer's public key) raw data.
##### getDigestAlgorithm()
```
public final Oid getDigestAlgorithm()
```

Gets the message digest algorithm, and any associated parameters, used by the signer.

**Returns:**
Oid - The message digest algorithm, and any associated parameters, used by the signer.
##### getSignedAttributes()
```
public final CmsAttribute[] getSignedAttributes()
```

Gets the collection of attributes that are signed.

**Returns:**
com.groupdocs.metadata.core.CmsAttribute[] - The collection of attributes that are signed.
##### getSignatureAlgorithm()
```
public final Oid getSignatureAlgorithm()
```

Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature.

**Returns:**
Oid - The signature algorithm, and any associated parameters, used by the signer to generate the digital signature.
##### getSignatureValue()
```
public final String getSignatureValue()
```

Gets the result of digital signature generation, using the message digest and the signer's private key.

**Returns:**
java.lang.String - The result of digital signature generation, using the message digest and the signer's private key.
##### getUnsignedAttributes()
```
public final CmsAttribute[] getUnsignedAttributes()
```

Gets the collection of attributes that are not signed.

**Returns:**
com.groupdocs.metadata.core.CmsAttribute[] - The collection of attributes that are not signed.
##### getSigningTime()
```
public final Date getSigningTime()
```

Gets the time at which the signer (purportedly) performed the signing process.

**Returns:**
java.util.Date - The time at which the signer (purportedly) performed the signing process.

### Cr2AFConfigPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2afconfigpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFConfigPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFConfigPackage() | Initializes a new instance of the  Cr2AFConfigPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFConfigTool() | Gets the AFConfigTool. |
| getAFTrackingSensitivity() | Gets the AFTrackingSensitivity. |
| getAFAccelDecelTracking() | Gets the AFAccelDecelTracking. |
| getAFPointSwitching() | Gets the AFPointSwitching. |
| getAIServoFirstImage() | Gets the AIServoFirstImage. |
| getAIServoSecondImage() | Gets the AIServoSecondImage. |
| getUSMLensElectronicMF() | Gets the USMLensElectronicMF. |
| getAFAssistBeam() | Gets the AFAssistBeam. |
| getOneShotAFRelease() | Gets the OneShotAFRelease. |
| getAutoAFPointSelEOSiTRAF() | Gets the AutoAFPointSelEOSiTRAF. |
| getLensDriveWhenAFImpossible() | Gets the LensDriveWhenAFImpossible. |
| getSelectAFAreaSelectionMode() | Gets the SelectAFAreaSelectionMode. |
| getAFAreaSelectionMethod() | Gets the AFAreaSelectionMethod. |
| getOrientationLinkedAF() | Gets the OrientationLinkedAF. |
| getManualAFPointSelPattern() | Gets the ManualAFPointSelPattern. |
| getAFPointDisplayDuringFocus() | Gets the AFPointDisplayDuringFocus. |
| getVFDisplayIllumination() | Gets the VFDisplayIllumination. |
| getAFStatusViewfinder() | Gets the AFStatusViewfinder. |
| getInitialAFPointInServo() | Gets the InitialAFPointInServo. |
##### Cr2AFConfigPackage()
```
public Cr2AFConfigPackage()
```

Initializes a new instance of the  Cr2AFConfigPackage  class.

##### getAFConfigTool()
```
public final int getAFConfigTool()
```

Gets the AFConfigTool.

**Returns:**
int - The AFConfigTool.
##### getAFTrackingSensitivity()
```
public final int getAFTrackingSensitivity()
```

Gets the AFTrackingSensitivity.

**Returns:**
int - The AFTrackingSensitivity.
##### getAFAccelDecelTracking()
```
public final int getAFAccelDecelTracking()
```

Gets the AFAccelDecelTracking.

**Returns:**
int - The AFAccelDecelTracking.
##### getAFPointSwitching()
```
public final int getAFPointSwitching()
```

Gets the AFPointSwitching.

**Returns:**
int - The AFPointSwitching.
##### getAIServoFirstImage()
```
public final int getAIServoFirstImage()
```

Gets the AIServoFirstImage.

**Returns:**
int - The AIServoFirstImage.
##### getAIServoSecondImage()
```
public final int getAIServoSecondImage()
```

Gets the AIServoSecondImage.

**Returns:**
int - The AIServoSecondImage.
##### getUSMLensElectronicMF()
```
public final int getUSMLensElectronicMF()
```

Gets the USMLensElectronicMF.

**Returns:**
int - The USMLensElectronicMF.
##### getAFAssistBeam()
```
public final int getAFAssistBeam()
```

Gets the AFAssistBeam.

**Returns:**
int - The AFAssistBeam.
##### getOneShotAFRelease()
```
public final int getOneShotAFRelease()
```

Gets the OneShotAFRelease.

**Returns:**
int - The OneShotAFRelease.
##### getAutoAFPointSelEOSiTRAF()
```
public final int getAutoAFPointSelEOSiTRAF()
```

Gets the AutoAFPointSelEOSiTRAF.

**Returns:**
int - The AutoAFPointSelEOSiTRAF.
##### getLensDriveWhenAFImpossible()
```
public final int getLensDriveWhenAFImpossible()
```

Gets the LensDriveWhenAFImpossible.

**Returns:**
int - The LensDriveWhenAFImpossible.
##### getSelectAFAreaSelectionMode()
```
public final int getSelectAFAreaSelectionMode()
```

Gets the SelectAFAreaSelectionMode.

**Returns:**
int - The SelectAFAreaSelectionMode.
##### getAFAreaSelectionMethod()
```
public final int getAFAreaSelectionMethod()
```

Gets the AFAreaSelectionMethod.

**Returns:**
int - The AFAreaSelectionMethod.
##### getOrientationLinkedAF()
```
public final int getOrientationLinkedAF()
```

Gets the OrientationLinkedAF.

**Returns:**
int - The OrientationLinkedAF.
##### getManualAFPointSelPattern()
```
public final int getManualAFPointSelPattern()
```

Gets the ManualAFPointSelPattern.

**Returns:**
int - The ManualAFPointSelPattern.
##### getAFPointDisplayDuringFocus()
```
public final int getAFPointDisplayDuringFocus()
```

Gets the AFPointDisplayDuringFocus.

**Returns:**
int - The AFPointDisplayDuringFocus.
##### getVFDisplayIllumination()
```
public final int getVFDisplayIllumination()
```

Gets the VFDisplayIllumination.

**Returns:**
int - The VFDisplayIllumination.
##### getAFStatusViewfinder()
```
public final int getAFStatusViewfinder()
```

Gets the AFStatusViewfinder.

**Returns:**
int - The AFStatusViewfinder.
##### getInitialAFPointInServo()
```
public final int getInitialAFPointInServo()
```

Gets the InitialAFPointInServo.

**Returns:**
int - The InitialAFPointInServo.

### Cr2AFInfo2Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2afinfo2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFInfo2Package extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFInfo2Package() | Initializes a new instance of the  Cr2AFInfo2Package  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFInfoSize() | Gets the AFInfoSize. |
| getAFAreaMode() | Gets the AFAreaMode. |
| getNumAFPoints() | Gets the NumAFPoints. |
| getValidAFPoints() | Gets the ValidAFPoints. |
| getCanonImageWidth() | Gets the CanonImageWidth. |
| getCanonImageHeight() | Gets the CanonImageHeight. |
| getAFImageWidth() | Gets the AFImageWidth. |
| getAFImageHeight() | Gets the AFImageHeight. |
| getAFAreaWidths() | Gets the AFAreaWidths. |
| getAFAreaHeights() | Gets the AFAreaHeights. |
| getAFAreaXPositions() | Gets the AFAreaXPositions. |
| getAFAreaYPositions() | Gets the AFAreaYPositions. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getAFPointsSelected() | Gets the AFPointsSelected. |
| getPrimaryAFPoint() | Gets the PrimaryAFPoint. |
##### Cr2AFInfo2Package()
```
public Cr2AFInfo2Package()
```

Initializes a new instance of the  Cr2AFInfo2Package  class.

##### getAFInfoSize()
```
public final int getAFInfoSize()
```

Gets the AFInfoSize.

**Returns:**
int - The AFInfoSize.
##### getAFAreaMode()
```
public final int getAFAreaMode()
```

Gets the AFAreaMode.

**Returns:**
int - The AFAreaMode.
##### getNumAFPoints()
```
public final int getNumAFPoints()
```

Gets the NumAFPoints.

**Returns:**
int - The NumAFPoints.
##### getValidAFPoints()
```
public final int getValidAFPoints()
```

Gets the ValidAFPoints.

**Returns:**
int - The ValidAFPoints.
##### getCanonImageWidth()
```
public final int getCanonImageWidth()
```

Gets the CanonImageWidth.

**Returns:**
int - The CanonImageWidth.
##### getCanonImageHeight()
```
public final int getCanonImageHeight()
```

Gets the CanonImageHeight.

**Returns:**
int - The CanonImageHeight.
##### getAFImageWidth()
```
public final int getAFImageWidth()
```

Gets the AFImageWidth.

**Returns:**
int - The AFImageWidth.
##### getAFImageHeight()
```
public final int getAFImageHeight()
```

Gets the AFImageHeight.

**Returns:**
int - The AFImageHeight.
##### getAFAreaWidths()
```
public final int getAFAreaWidths()
```

Gets the AFAreaWidths.

**Returns:**
int - The AFAreaWidths.
##### getAFAreaHeights()
```
public final int getAFAreaHeights()
```

Gets the AFAreaHeights.

**Returns:**
int - The AFAreaHeights.
##### getAFAreaXPositions()
```
public final int getAFAreaXPositions()
```

Gets the AFAreaXPositions.

**Returns:**
int - The AFAreaXPositions.
##### getAFAreaYPositions()
```
public final int getAFAreaYPositions()
```

Gets the AFAreaYPositions.

**Returns:**
int - The AFAreaYPositions.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getAFPointsSelected()
```
public final int getAFPointsSelected()
```

Gets the AFPointsSelected.

**Returns:**
int - The AFPointsSelected.
##### getPrimaryAFPoint()
```
public final int getPrimaryAFPoint()
```

Gets the PrimaryAFPoint.

**Returns:**
int - The PrimaryAFPoint.

### Cr2AFInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2afinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFInfoPackage() | Initializes a new instance of the  Cr2AFInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumAFPoints() | Gets the NumAFPoints. |
| getValidAFPoints() | Gets the ValidAFPoints. |
| getCanonImageWidth() | Gets the CanonImageWidth. |
| getCanonImageHeight() | Gets the CanonImageHeight. |
| getAFImageWidth() | Gets the AFImageWidth. |
| getAFImageHeight() | Gets the AFImageHeight. |
| getAFAreaWidth() | Gets the AFAreaWidth. |
| getAFAreaHeight() | Gets the AFAreaHeight. |
| getAFAreaXPositions() | Gets the AFAreaXPositions. |
| getAFAreaYPositions() | Gets the AFAreaYPositions. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getPrimaryAFPointAFInfo() | Gets the PrimaryAFPointAFInfo. |
| getPrimaryAFPoint() | Gets the PrimaryAFPoint. |
##### Cr2AFInfoPackage()
```
public Cr2AFInfoPackage()
```

Initializes a new instance of the  Cr2AFInfoPackage  class.

##### getNumAFPoints()
```
public final int getNumAFPoints()
```

Gets the NumAFPoints.

**Returns:**
int - The NumAFPoints.
##### getValidAFPoints()
```
public final int getValidAFPoints()
```

Gets the ValidAFPoints.

**Returns:**
int - The ValidAFPoints.
##### getCanonImageWidth()
```
public final int getCanonImageWidth()
```

Gets the CanonImageWidth.

**Returns:**
int - The CanonImageWidth.
##### getCanonImageHeight()
```
public final int getCanonImageHeight()
```

Gets the CanonImageHeight.

**Returns:**
int - The CanonImageHeight.
##### getAFImageWidth()
```
public final int getAFImageWidth()
```

Gets the AFImageWidth.

**Returns:**
int - The AFImageWidth.
##### getAFImageHeight()
```
public final int getAFImageHeight()
```

Gets the AFImageHeight.

**Returns:**
int - The AFImageHeight.
##### getAFAreaWidth()
```
public final int getAFAreaWidth()
```

Gets the AFAreaWidth.

**Returns:**
int - The AFAreaWidth.
##### getAFAreaHeight()
```
public final int getAFAreaHeight()
```

Gets the AFAreaHeight.

**Returns:**
int - The AFAreaHeight.
##### getAFAreaXPositions()
```
public final int getAFAreaXPositions()
```

Gets the AFAreaXPositions.

**Returns:**
int - The AFAreaXPositions.
##### getAFAreaYPositions()
```
public final int getAFAreaYPositions()
```

Gets the AFAreaYPositions.

**Returns:**
int - The AFAreaYPositions.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getPrimaryAFPointAFInfo()
```
public final int getPrimaryAFPointAFInfo()
```

Gets the PrimaryAFPointAFInfo.

**Returns:**
int - The PrimaryAFPointAFInfo.
##### getPrimaryAFPoint()
```
public final int getPrimaryAFPoint()
```

Gets the PrimaryAFPoint.

**Returns:**
int - The PrimaryAFPoint.

### Cr2AFMicroAdjPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2afmicroadjpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AFMicroAdjPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AFMicroAdjPackage() | Initializes a new instance of the  Cr2AFMicroAdjPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAFMicroAdjMode() | Gets the AFMicroAdjMode. |
| getAFMicroAdjValue() | Gets the AFMicroAdjValue. |
##### Cr2AFMicroAdjPackage()
```
public Cr2AFMicroAdjPackage()
```

Initializes a new instance of the  Cr2AFMicroAdjPackage  class.

##### getAFMicroAdjMode()
```
public final int getAFMicroAdjMode()
```

Gets the AFMicroAdjMode.

**Returns:**
int - The AFMicroAdjMode.
##### getAFMicroAdjValue()
```
public final float getAFMicroAdjValue()
```

Gets the AFMicroAdjValue.

**Returns:**
float - The AFMicroAdjValue.

### Cr2AspectInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2aspectinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2AspectInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2AspectInfoPackage() | Initializes a new instance of the  Cr2AspectInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAspectRatio() | Gets the AspectRatio. |
| getCroppedImageWidth() | Gets the CroppedImageWidth. |
| getCroppedImageHeight() | Gets the CroppedImageHeight. |
| getCroppedImageLeft() | Gets the CroppedImageLeft. |
| getCroppedImageTop() | Gets the CroppedImageTop. |
##### Cr2AspectInfoPackage()
```
public Cr2AspectInfoPackage()
```

Initializes a new instance of the  Cr2AspectInfoPackage  class.

##### getAspectRatio()
```
public final int getAspectRatio()
```

Gets the AspectRatio.

**Returns:**
int - The AspectRatio.
##### getCroppedImageWidth()
```
public final int getCroppedImageWidth()
```

Gets the CroppedImageWidth.

**Returns:**
int - The CroppedImageWidth.
##### getCroppedImageHeight()
```
public final int getCroppedImageHeight()
```

Gets the CroppedImageHeight.

**Returns:**
int - The CroppedImageHeight.
##### getCroppedImageLeft()
```
public final int getCroppedImageLeft()
```

Gets the CroppedImageLeft.

**Returns:**
int - The CroppedImageLeft.
##### getCroppedImageTop()
```
public final int getCroppedImageTop()
```

Gets the CroppedImageTop.

**Returns:**
int - The CroppedImageTop.

### Cr2CameraSettingsPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2camerasettingspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2CameraSettingsPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2CameraSettingsPackage() | Initializes a new instance of the  Cr2CameraSettingsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMacroMode() | Gets the MacroMode. |
| getSelfTimer() | Gets the SelfTimer. |
| getQuality() | Gets the Quality. |
| getCanonFlashMode() | Gets the CanonFlashMode. |
| getContinuousDrive() | Gets the ContinuousDrive. |
| getFocusMode() | Gets the FocusMode. |
| getRecordMode() | Gets the RecordMode. |
| getCanonImageSize() | Gets the CanonImageSize. |
| getEasyMode() | Gets the EasyMode. |
| getDigitalZoom() | Gets the DigitalZoom. |
| getContrast() | Gets the Contrast. |
| getSaturation() | Gets the Saturation. |
| getSharpness() | Gets the Sharpness. |
| getCameraIso() | Gets the CameraIso. |
| getMeteringMode() | Gets the MeteringMode. |
| getFocusRange() | Gets the FocusRange. |
| getAFPoint() | Gets the AFPoint. |
| getCanonExposureMode() | Gets the CanonExposureMode. |
| getLensType() | Gets the LensType. |
| getMaxFocalLength() | Gets the MaxFocalLength. |
| getMinFocalLength() | Gets the MinFocalLength. |
| getFocalUnits() | Gets the FocalUnits. |
| getMaxAperture() | Gets the MaxAperture. |
| getMinAperture() | Gets the MinAperture. |
| getFlashActivity() | Gets the FlashActivity. |
| getFlashBits() | Gets the FlashBits. |
| getFocusContinuous() | Gets the FocusContinuous. |
| getAESetting() | Gets the AESetting. |
| getImageStabilization() | Gets the ImageStabilization. |
| getDisplayAperture() | Gets the DisplayAperture. |
| getZoomSourceWidth() | Gets the ZoomSourceWidth. |
| getZoomTargetWidth() | Gets the ZoomTargetWidth. |
| getSpotMeteringMode() | Gets the SpotMeteringMode. |
| getPhotoEffect() | Gets the PhotoEffect. |
| getManualFlashOutput() | Gets the ManualFlashOutput. |
| getColorTone() | Gets the ColorTone. |
| getSRAWQuality() | Gets the SRAWQuality. |
##### Cr2CameraSettingsPackage()
```
public Cr2CameraSettingsPackage()
```

Initializes a new instance of the  Cr2CameraSettingsPackage  class.

##### getMacroMode()
```
public final int getMacroMode()
```

Gets the MacroMode.

**Returns:**
int - The MacroMode.
##### getSelfTimer()
```
public final int getSelfTimer()
```

Gets the SelfTimer.

**Returns:**
int - The SelfTimer.
##### getQuality()
```
public final int getQuality()
```

Gets the Quality.

**Returns:**
int - The Quality.
##### getCanonFlashMode()
```
public final int getCanonFlashMode()
```

Gets the CanonFlashMode.

**Returns:**
int - The CanonFlashMode.
##### getContinuousDrive()
```
public final int getContinuousDrive()
```

Gets the ContinuousDrive.

**Returns:**
int - The ContinuousDrive.
##### getFocusMode()
```
public final int getFocusMode()
```

Gets the FocusMode.

**Returns:**
int - The FocusMode.
##### getRecordMode()
```
public final int getRecordMode()
```

Gets the RecordMode.

**Returns:**
int - The RecordMode.
##### getCanonImageSize()
```
public final int getCanonImageSize()
```

Gets the CanonImageSize.

**Returns:**
int - The CanonImageSize.
##### getEasyMode()
```
public final int getEasyMode()
```

Gets the EasyMode.

**Returns:**
int - The EasyMode.
##### getDigitalZoom()
```
public final int getDigitalZoom()
```

Gets the DigitalZoom.

**Returns:**
int - The DigitalZoom.
##### getContrast()
```
public final int getContrast()
```

Gets the Contrast.

**Returns:**
int - The Contrast.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getCameraIso()
```
public final int getCameraIso()
```

Gets the CameraIso.

**Returns:**
int - The CameraIso.
##### getMeteringMode()
```
public final int getMeteringMode()
```

Gets the MeteringMode.

**Returns:**
int - The MeteringMode.
##### getFocusRange()
```
public final int getFocusRange()
```

Gets the FocusRange.

**Returns:**
int - The FocusRange.
##### getAFPoint()
```
public final int getAFPoint()
```

Gets the AFPoint.

**Returns:**
int - The AFPoint.
##### getCanonExposureMode()
```
public final int getCanonExposureMode()
```

Gets the CanonExposureMode.

**Returns:**
int - The CanonExposureMode.
##### getLensType()
```
public final int getLensType()
```

Gets the LensType.

**Returns:**
int - The LensType.
##### getMaxFocalLength()
```
public final int getMaxFocalLength()
```

Gets the MaxFocalLength.

**Returns:**
int - The MaxFocalLength.
##### getMinFocalLength()
```
public final int getMinFocalLength()
```

Gets the MinFocalLength.

**Returns:**
int - The MinFocalLength.
##### getFocalUnits()
```
public final int getFocalUnits()
```

Gets the FocalUnits.

**Returns:**
int - The FocalUnits.
##### getMaxAperture()
```
public final int getMaxAperture()
```

Gets the MaxAperture.

**Returns:**
int - The MaxAperture.
##### getMinAperture()
```
public final int getMinAperture()
```

Gets the MinAperture.

**Returns:**
int - The MinAperture.
##### getFlashActivity()
```
public final int getFlashActivity()
```

Gets the FlashActivity.

**Returns:**
int - The FlashActivity.
##### getFlashBits()
```
public final int getFlashBits()
```

Gets the FlashBits.

**Returns:**
int - The FlashBits.
##### getFocusContinuous()
```
public final int getFocusContinuous()
```

Gets the FocusContinuous.

**Returns:**
int - The FocusContinuous.
##### getAESetting()
```
public final int getAESetting()
```

Gets the AESetting.

**Returns:**
int - The AESetting.
##### getImageStabilization()
```
public final int getImageStabilization()
```

Gets the ImageStabilization.

**Returns:**
int - The ImageStabilization.
##### getDisplayAperture()
```
public final int getDisplayAperture()
```

Gets the DisplayAperture.

**Returns:**
int - The DisplayAperture.
##### getZoomSourceWidth()
```
public final int getZoomSourceWidth()
```

Gets the ZoomSourceWidth.

**Returns:**
int - The ZoomSourceWidth.
##### getZoomTargetWidth()
```
public final int getZoomTargetWidth()
```

Gets the ZoomTargetWidth.

**Returns:**
int - The ZoomTargetWidth.
##### getSpotMeteringMode()
```
public final int getSpotMeteringMode()
```

Gets the SpotMeteringMode.

**Returns:**
int - The SpotMeteringMode.
##### getPhotoEffect()
```
public final int getPhotoEffect()
```

Gets the PhotoEffect.

**Returns:**
int - The PhotoEffect.
##### getManualFlashOutput()
```
public final int getManualFlashOutput()
```

Gets the ManualFlashOutput.

**Returns:**
int - The ManualFlashOutput.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getSRAWQuality()
```
public final int getSRAWQuality()
```

Gets the SRAWQuality.

**Returns:**
int - The SRAWQuality.

### Cr2ColorBalancePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2colorbalancepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ColorBalancePackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ColorBalancePackage() | Initializes a new instance of the  Cr2ColorBalancePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWB_RGGBLevelsAuto() | Gets the WB\_RGGBLevelsAuto. |
| getWB_RGGBLevelsDaylight() | Gets the WB\_RGGBLevelsDaylight. |
| getWB_RGGBLevelsShade() | Gets the WB\_RGGBLevelsShade. |
| getWB_RGGBLevelsCloudy() | Gets the WB\_RGGBLevelsCloudy. |
| getWB_RGGBLevelsTungsten() | Gets the WB\_RGGBLevelsTungsten. |
| getWB_RGGBLevelsFluorescent() | Gets the WB\_RGGBLevelsFluorescent. |
| getWB_RGGBLevelsFlash() | Gets the WB\_RGGBLevelsFlash. |
| getWB_RGGBLevelsKelvin() | Gets the WB\_RGGBLevelsKelvin. |
| getWB_RGGBBlackLevels() | Gets the WB\_RGGBBlackLevels. |
##### Cr2ColorBalancePackage()
```
public Cr2ColorBalancePackage()
```

Initializes a new instance of the  Cr2ColorBalancePackage  class.

##### getWB_RGGBLevelsAuto()
```
public final int getWB_RGGBLevelsAuto()
```

Gets the WB\_RGGBLevelsAuto.

**Returns:**
int - The WB\_RGGBLevelsAuto.
##### getWB_RGGBLevelsDaylight()
```
public final int getWB_RGGBLevelsDaylight()
```

Gets the WB\_RGGBLevelsDaylight.

**Returns:**
int - The WB\_RGGBLevelsDaylight.
##### getWB_RGGBLevelsShade()
```
public final int getWB_RGGBLevelsShade()
```

Gets the WB\_RGGBLevelsShade.

**Returns:**
int - The WB\_RGGBLevelsShade.
##### getWB_RGGBLevelsCloudy()
```
public final int getWB_RGGBLevelsCloudy()
```

Gets the WB\_RGGBLevelsCloudy.

**Returns:**
int - The WB\_RGGBLevelsCloudy.
##### getWB_RGGBLevelsTungsten()
```
public final int getWB_RGGBLevelsTungsten()
```

Gets the WB\_RGGBLevelsTungsten.

**Returns:**
int - The WB\_RGGBLevelsTungsten.
##### getWB_RGGBLevelsFluorescent()
```
public final int getWB_RGGBLevelsFluorescent()
```

Gets the WB\_RGGBLevelsFluorescent.

**Returns:**
int - The WB\_RGGBLevelsFluorescent.
##### getWB_RGGBLevelsFlash()
```
public final int getWB_RGGBLevelsFlash()
```

Gets the WB\_RGGBLevelsFlash.

**Returns:**
int - The WB\_RGGBLevelsFlash.
##### getWB_RGGBLevelsKelvin()
```
public final int getWB_RGGBLevelsKelvin()
```

Gets the WB\_RGGBLevelsKelvin.

**Returns:**
int - The WB\_RGGBLevelsKelvin.
##### getWB_RGGBBlackLevels()
```
public final int getWB_RGGBBlackLevels()
```

Gets the WB\_RGGBBlackLevels.

**Returns:**
int - The WB\_RGGBBlackLevels.

### Cr2ColorInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2colorinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ColorInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ColorInfoPackage() | Initializes a new instance of the  Cr2ColorInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSaturation() | Gets the Saturation. |
| getColorTone() | Gets the ColorTone. |
| getColorSpace() | Gets the ColorSpace. |
##### Cr2ColorInfoPackage()
```
public Cr2ColorInfoPackage()
```

Initializes a new instance of the  Cr2ColorInfoPackage  class.

##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getColorSpace()
```
public final int getColorSpace()
```

Gets the ColorSpace.

**Returns:**
int - The ColorSpace.

### Cr2CropInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2cropinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2CropInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2CropInfoPackage() | Initializes a new instance of the  Cr2CropInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCropLeftMargin() | Gets the CropLeftMargin. |
| getCropRightMargin() | Gets the CropRightMargin. |
| getCropTopMargin() | Gets the CropTopMargin. |
| getCropBottomMargin() | Gets the CropBottomMargin. |
##### Cr2CropInfoPackage()
```
public Cr2CropInfoPackage()
```

Initializes a new instance of the  Cr2CropInfoPackage  class.

##### getCropLeftMargin()
```
public final int getCropLeftMargin()
```

Gets the CropLeftMargin.

**Returns:**
int - The CropLeftMargin.
##### getCropRightMargin()
```
public final int getCropRightMargin()
```

Gets the CropRightMargin.

**Returns:**
int - The CropRightMargin.
##### getCropTopMargin()
```
public final int getCropTopMargin()
```

Gets the CropTopMargin.

**Returns:**
int - The CropTopMargin.
##### getCropBottomMargin()
```
public final int getCropBottomMargin()
```

Gets the CropBottomMargin.

**Returns:**
int - The CropBottomMargin.

### Cr2FileInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2fileinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2FileInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2FileInfoPackage() | Initializes a new instance of the  Cr2FileInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the Size. |
| setSize(long value) | Sets the Size. |
| getFileNumberOrShutterCount() | Gets the FileNumberOrShutterCount. |
| getBracketMode() | Gets the BracketMode. |
| getBracketValue() | Gets the BracketValue. |
| getBracketShotNumber() | Gets the BracketShotNumber. |
| getRawJpgQuality() | Gets the RawJpgQuality. |
| getRawJpgSize() | Gets the RawJpgSize. |
| getLongExposureNoiseReduction2() | Gets the LongExposureNoiseReduction2. |
| getWBBracketMode() | Gets the WBBracketMode. |
| getWBBracketValueAB() | Gets the WBBracketValueAB. |
| getWBBracketValueGM() | Gets the WBBracketValueGM. |
| getFilterEffect() | Gets the FilterEffect. |
| getToningEffect() | Gets the ToningEffect. |
| getMacroMagnification() | Gets the MacroMagnification. |
| getLiveViewShooting() | Gets the LiveViewShooting. |
| getFocusDistanceUpper() | Gets the FocusDistanceUpper. |
| getFocusDistanceLower() | Gets the FocusDistanceLower. |
| getShutterMode() | Gets the ShutterMode. |
| getFlashExposureLock() | Gets the FlashExposureLock. |
| getRFLensType() | Gets the RFLensType. |
##### Cr2FileInfoPackage()
```
public Cr2FileInfoPackage()
```

Initializes a new instance of the  Cr2FileInfoPackage  class.

##### getSize()
```
public final long getSize()
```

Gets the Size.

**Returns:**
long - The Size.
##### setSize(long value)
```
public final void setSize(long value)
```

Sets the Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The Size. |

##### getFileNumberOrShutterCount()
```
public final int getFileNumberOrShutterCount()
```

Gets the FileNumberOrShutterCount.

**Returns:**
int - The FileNumber.
##### getBracketMode()
```
public final int getBracketMode()
```

Gets the BracketMode.

**Returns:**
int - The BracketMode.
##### getBracketValue()
```
public final int getBracketValue()
```

Gets the BracketValue.

**Returns:**
int - The BracketValue.
##### getBracketShotNumber()
```
public final int getBracketShotNumber()
```

Gets the BracketShotNumber.

**Returns:**
int - The BracketShotNumber.
##### getRawJpgQuality()
```
public final int getRawJpgQuality()
```

Gets the RawJpgQuality.

**Returns:**
int - The RawJpgQuality.
##### getRawJpgSize()
```
public final int getRawJpgSize()
```

Gets the RawJpgSize.

**Returns:**
int - The RawJpgSize.
##### getLongExposureNoiseReduction2()
```
public final int getLongExposureNoiseReduction2()
```

Gets the LongExposureNoiseReduction2.

**Returns:**
int - The LongExposureNoiseReduction2.
##### getWBBracketMode()
```
public final int getWBBracketMode()
```

Gets the WBBracketMode.

**Returns:**
int - The WBBracketMode.
##### getWBBracketValueAB()
```
public final int getWBBracketValueAB()
```

Gets the WBBracketValueAB.

**Returns:**
int - The WBBracketValueAB.
##### getWBBracketValueGM()
```
public final int getWBBracketValueGM()
```

Gets the WBBracketValueGM.

**Returns:**
int - The WBBracketValueGM.
##### getFilterEffect()
```
public final int getFilterEffect()
```

Gets the FilterEffect.

**Returns:**
int - The FilterEffect.
##### getToningEffect()
```
public final int getToningEffect()
```

Gets the ToningEffect.

**Returns:**
int - The ToningEffect.
##### getMacroMagnification()
```
public final int getMacroMagnification()
```

Gets the MacroMagnification.

**Returns:**
int - The MacroMagnification.
##### getLiveViewShooting()
```
public final int getLiveViewShooting()
```

Gets the LiveViewShooting.

**Returns:**
int - The LiveViewShooting.
##### getFocusDistanceUpper()
```
public final int getFocusDistanceUpper()
```

Gets the FocusDistanceUpper.

**Returns:**
int - The FocusDistanceUpper.
##### getFocusDistanceLower()
```
public final int getFocusDistanceLower()
```

Gets the FocusDistanceLower.

**Returns:**
int - The FocusDistanceLower.
##### getShutterMode()
```
public final int getShutterMode()
```

Gets the ShutterMode.

**Returns:**
int - The ShutterMode.
##### getFlashExposureLock()
```
public final int getFlashExposureLock()
```

Gets the FlashExposureLock.

**Returns:**
int - The FlashExposureLock.
##### getRFLensType()
```
public final int getRFLensType()
```

Gets the RFLensType.

**Returns:**
int - The RFLensType.

### Cr2FocalLengthPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2focallengthpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2FocalLengthPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2FocalLengthPackage() | Initializes a new instance of the  Cr2FocalLengthPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFocalType() | Gets the FocalType. |
| getFocalLength() | Gets the FocalLength. |
| getFocalPlaneXSize() | Gets the FocalPlaneXSize. |
| getFocalPlaneYSize() | Gets the FocalPlaneYSize. |
##### Cr2FocalLengthPackage()
```
public Cr2FocalLengthPackage()
```

Initializes a new instance of the  Cr2FocalLengthPackage  class.

##### getFocalType()
```
public final int getFocalType()
```

Gets the FocalType.

**Returns:**
int - The FocalType.
##### getFocalLength()
```
public final int getFocalLength()
```

Gets the FocalLength.

**Returns:**
int - The FocalLength.
##### getFocalPlaneXSize()
```
public final int getFocalPlaneXSize()
```

Gets the FocalPlaneXSize.

**Returns:**
int - The FocalPlaneXSize.
##### getFocalPlaneYSize()
```
public final int getFocalPlaneYSize()
```

Gets the FocalPlaneYSize.

**Returns:**
int - The FocalPlaneYSize.

### Cr2Functions1DPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2functions1dpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2Functions1DPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2Functions1DPackage() | Initializes a new instance of the  Cr2Functions1DPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFocusingScreen() | Gets the FocusingScreen. |
| getFinderDisplayDuringExposure() | Gets the FinderDisplayDuringExposure. |
| getShutterReleaseNoCFCard() | Gets the ShutterReleaseNoCFCard. |
| getISOSpeedExpansion() | Gets the ISOSpeedExpansion. |
| getShutterAELButton() | Gets the ShutterAELButton. |
| getManualTv() | Gets the ManualTv. |
| getExposureLevelIncrements() | Gets the ExposureLevelIncrements. |
| getUSMLensElectronicMF() | Gets the USMLensElectronicMF. |
| getLCDPanels() | Gets the LCDPanels. |
| getAEBSequenceAutoCancel() | Gets the AEBSequenceAutoCancel. |
| getAFPointIllumination() | Gets the AFPointIllumination. |
| getAFPointSelection() | Gets the AFPointSelection. |
| getMirrorLockup() | Gets the MirrorLockup. |
| getAFPointSpotMetering() | Gets the AFPointSpotMetering. |
| getFillFlashAutoReduction() | Gets the FillFlashAutoReduction. |
| getShutterCurtainSync() | Gets the ShutterCurtainSync. |
| getSafetyShiftInAvOrTv() | Gets the SafetyShiftInAvOrTv. |
| getAFPointActivationArea() | Gets the AFPointActivationArea. |
| getSwitchToRegisteredAFPoint() | Gets the SwitchToRegisteredAFPoint. |
| getLensAFStopButton() | Gets the LensAFStopButton. |
| getAIServoTrackingSensitivity() | Gets the AIServoTrackingSensitivity. |
| getAIServoContinuousShooting() | Gets the AIServoContinuousShooting. |
##### Cr2Functions1DPackage()
```
public Cr2Functions1DPackage()
```

Initializes a new instance of the  Cr2Functions1DPackage  class.

##### getFocusingScreen()
```
public final int getFocusingScreen()
```

Gets the FocusingScreen.

**Returns:**
int - The FocusingScreen.
##### getFinderDisplayDuringExposure()
```
public final int getFinderDisplayDuringExposure()
```

Gets the FinderDisplayDuringExposure.

**Returns:**
int - The FinderDisplayDuringExposure.
##### getShutterReleaseNoCFCard()
```
public final int getShutterReleaseNoCFCard()
```

Gets the ShutterReleaseNoCFCard.

**Returns:**
int - The ShutterReleaseNoCFCard.
##### getISOSpeedExpansion()
```
public final int getISOSpeedExpansion()
```

Gets the ISOSpeedExpansion.

**Returns:**
int - The ISOSpeedExpansion.
##### getShutterAELButton()
```
public final int getShutterAELButton()
```

Gets the ShutterAELButton.

**Returns:**
int - The ShutterAELButton.
##### getManualTv()
```
public final int getManualTv()
```

Gets the ManualTv.

**Returns:**
int - The ManualTv.
##### getExposureLevelIncrements()
```
public final int getExposureLevelIncrements()
```

Gets the ExposureLevelIncrements.

**Returns:**
int - The ExposureLevelIncrements.
##### getUSMLensElectronicMF()
```
public final int getUSMLensElectronicMF()
```

Gets the USMLensElectronicMF.

**Returns:**
int - The USMLensElectronicMF.
##### getLCDPanels()
```
public final int getLCDPanels()
```

Gets the LCDPanels.

**Returns:**
int - The LCDPanels.
##### getAEBSequenceAutoCancel()
```
public final int getAEBSequenceAutoCancel()
```

Gets the AEBSequenceAutoCancel.

**Returns:**
int - The AEBSequenceAutoCancel.
##### getAFPointIllumination()
```
public final int getAFPointIllumination()
```

Gets the AFPointIllumination.

**Returns:**
int - The AFPointIllumination.
##### getAFPointSelection()
```
public final int getAFPointSelection()
```

Gets the AFPointSelection.

**Returns:**
int - The AFPointSelection.
##### getMirrorLockup()
```
public final int getMirrorLockup()
```

Gets the MirrorLockup.

**Returns:**
int - The MirrorLockup.
##### getAFPointSpotMetering()
```
public final int getAFPointSpotMetering()
```

Gets the AFPointSpotMetering.

**Returns:**
int - The AFPointSpotMetering.
##### getFillFlashAutoReduction()
```
public final int getFillFlashAutoReduction()
```

Gets the FillFlashAutoReduction.

**Returns:**
int - The FillFlashAutoReduction.
##### getShutterCurtainSync()
```
public final int getShutterCurtainSync()
```

Gets the ShutterCurtainSync.

**Returns:**
int - The ShutterCurtainSync.
##### getSafetyShiftInAvOrTv()
```
public final int getSafetyShiftInAvOrTv()
```

Gets the SafetyShiftInAvOrTv.

**Returns:**
int - The SafetyShiftInAvOrTv.
##### getAFPointActivationArea()
```
public final int getAFPointActivationArea()
```

Gets the AFPointActivationArea.

**Returns:**
int - The AFPointActivationArea.
##### getSwitchToRegisteredAFPoint()
```
public final int getSwitchToRegisteredAFPoint()
```

Gets the SwitchToRegisteredAFPoint.

**Returns:**
int - The SwitchToRegisteredAFPoint.
##### getLensAFStopButton()
```
public final int getLensAFStopButton()
```

Gets the LensAFStopButton.

**Returns:**
int - The LensAFStopButton.
##### getAIServoTrackingSensitivity()
```
public final int getAIServoTrackingSensitivity()
```

Gets the AIServoTrackingSensitivity.

**Returns:**
int - The AIServoTrackingSensitivity.
##### getAIServoContinuousShooting()
```
public final int getAIServoContinuousShooting()
```

Gets the AIServoContinuousShooting.

**Returns:**
int - The AIServoContinuousShooting.

### Cr2LightingOptPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2lightingoptpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2LightingOptPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2LightingOptPackage() | Initializes a new instance of the  Cr2LightingOptPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the Size. |
| setSize(long value) | Sets the Size. |
| getPeripheralIlluminationCorr() | Gets the PeripheralIlluminationCorr. |
| getAutoLightingOptimizer() | Gets the AutoLightingOptimizer. |
| getHighlightTonePriority() | Gets the HighlightTonePriority. |
| getLongExposureNoiseReduction() | Gets the LongExposureNoiseReduction. |
| getHighISONoiseReduction() | Gets the HighISONoiseReduction. |
| getDigitalLensOptimizer() | Gets the DigitalLensOptimizer. |
##### Cr2LightingOptPackage()
```
public Cr2LightingOptPackage()
```

Initializes a new instance of the  Cr2LightingOptPackage  class.

##### getSize()
```
public final long getSize()
```

Gets the Size.

**Returns:**
long - The Size.
##### setSize(long value)
```
public final void setSize(long value)
```

Sets the Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The Size. |

##### getPeripheralIlluminationCorr()
```
public final int getPeripheralIlluminationCorr()
```

Gets the PeripheralIlluminationCorr.

**Returns:**
int - The PeripheralIlluminationCorr.
##### getAutoLightingOptimizer()
```
public final int getAutoLightingOptimizer()
```

Gets the AutoLightingOptimizer.

**Returns:**
int - The AutoLightingOptimizer.
##### getHighlightTonePriority()
```
public final int getHighlightTonePriority()
```

Gets the HighlightTonePriority.

**Returns:**
int - The HighlightTonePriority.
##### getLongExposureNoiseReduction()
```
public final int getLongExposureNoiseReduction()
```

Gets the LongExposureNoiseReduction.

**Returns:**
int - The LongExposureNoiseReduction.
##### getHighISONoiseReduction()
```
public final int getHighISONoiseReduction()
```

Gets the HighISONoiseReduction.

**Returns:**
int - The HighISONoiseReduction.
##### getDigitalLensOptimizer()
```
public final int getDigitalLensOptimizer()
```

Gets the DigitalLensOptimizer.

**Returns:**
int - The DigitalLensOptimizer.

### Cr2LogInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2loginfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2LogInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2LogInfoPackage() | Initializes a new instance of the  Cr2LogInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCompressionFormat() | Gets the CompressionFormat. |
| getSharpness() | Gets the Sharpness. |
| getSaturation() | Gets the Saturation. |
| getColorTone() | Gets the ColorTone. |
| getColorSpace2() | Gets the ColorSpace2. |
| getColorMatrix() | Gets the ColorMatrix. |
| getCanonLogVersion() | Gets the CanonLogVersion. |
##### Cr2LogInfoPackage()
```
public Cr2LogInfoPackage()
```

Initializes a new instance of the  Cr2LogInfoPackage  class.

##### getCompressionFormat()
```
public final int getCompressionFormat()
```

Gets the CompressionFormat.

**Returns:**
int - The CompressionFormat.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getColorTone()
```
public final int getColorTone()
```

Gets the ColorTone.

**Returns:**
int - The ColorTone.
##### getColorSpace2()
```
public final int getColorSpace2()
```

Gets the ColorSpace2.

**Returns:**
int - The ColorSpace2.
##### getColorMatrix()
```
public final int getColorMatrix()
```

Gets the ColorMatrix.

**Returns:**
int - The ColorMatrix.
##### getCanonLogVersion()
```
public final int getCanonLogVersion()
```

Gets the CanonLogVersion.

**Returns:**
int - The CanonLogVersion.

### Cr2MakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2makernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage, com.groupdocs.metadata.core.RawMakerNotePackage
```
public final class Cr2MakerNotePackage extends RawMakerNotePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MakerNotePackage() | Initializes a new instance of the  Cr2MakerNotePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCr2CameraSettingsPackage() | Gets the CanonCameraSettings. |
| setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value) | Sets the CanonCameraSettings. |
| getCameraSettings() | Gets the CanonCameraSettings Offset. |
| setCameraSettings(long value) | Sets the CanonCameraSettings Offset. |
| getCr2FocalLengthPackage() | Gets the CanonFocalLength. |
| setCr2FocalLengthPackage(Cr2FocalLengthPackage value) | Sets the CanonFocalLength. |
| getCr2FocalLength() | Gets the CanonCameraSettings Offset. |
| setCr2FocalLength(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ShotInfoPackage() | Gets the CanonShotInfo. |
| setCr2ShotInfoPackage(Cr2ShotInfoPackage value) | Sets the CanonShotInfo. |
| getCr2ShotInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ShotInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PanoramaPackage() | Gets the CanonPanorama. |
| setCr2PanoramaPackage(Cr2PanoramaPackage value) | Sets the CanonPanorama. |
| getCr2Panorama() | Gets the CanonCameraSettings Offset. |
| setCr2Panorama(long value) | Sets the CanonCameraSettings Offset. |
| getCr2MovieInfoPackage() | Gets the MovieInfo (Tags written by some Canon cameras when recording video). |
| setCr2MovieInfoPackage(Cr2MovieInfoPackage value) | Sets the MovieInfo (Tags written by some Canon cameras when recording video). |
| getCr2MovieInfo() | Gets the CanonCameraSettings Offset. |
| setCr2MovieInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFInfo2Package() | Gets the AFInfo3 (Newer version of the AFInfo record). |
| setCr2AFInfo2Package(Cr2AFInfo2Package value) | Sets the AFInfo3 (Newer version of the AFInfo record). |
| getCr2AFInfo2() | Gets the CanonCameraSettings Offset. |
| setCr2AFInfo2(long value) | Sets the CanonCameraSettings Offset. |
| getCr2WBInfoPackage() | Gets the WBInfo (WB tags for the Canon G9). |
| setCr2WBInfoPackage(Cr2WBInfoPackage value) | Sets the WBInfo (WB tags for the Canon G9). |
| getCr2WBInfo() | Gets the CanonCameraSettings Offset. |
| setCr2WBInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2TimeInfoPackage() | Gets the TimeInfo. |
| setCr2TimeInfoPackage(Cr2TimeInfoPackage value) | Sets the TimeInfo. |
| getCr2TimeInfo() | Gets the CanonCameraSettings Offset. |
| setCr2TimeInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFInfo3Package() | Gets the AFInfo3. |
| setCr2AFInfo3Package(Cr2AFInfo2Package value) | Sets the AFInfo3. |
| getCr2AFInfo3() | Gets the CanonCameraSettings Offset. |
| setCr2AFInfo3(long value) | Sets the CanonCameraSettings Offset. |
| getCr2Functions1DPackage() | Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| setCr2Functions1DPackage(Cr2Functions1DPackage value) | Sets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| getCr2Functions1D() | Gets the CanonCameraSettings Offset. |
| setCr2Functions1D(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PersonalFuncsPackage() | Gets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value) | Sets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| getCr2PersonalFuncs() | Gets the CanonCameraSettings Offset. |
| setCr2PersonalFuncs(long value) | Sets the CanonCameraSettings Offset. |
| getCr2PersonalFuncValuesPackage() | Gets the PersonalFunctionValues. |
| setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value) | Sets the PersonalFunctionValues. |
| getCr2PersonalFuncValues() | Gets the CanonCameraSettings Offset. |
| setCr2PersonalFuncValues(long value) | Sets the CanonCameraSettings Offset. |
| getCr2FileInfoPackage() | Not used in this version. |
| setCr2FileInfoPackage(Cr2FileInfoPackage value) | Not used in this version. |
| getCr2FileInfo() | Gets the CanonCameraSettings Offset. |
| setCr2FileInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2CropInfoPackage() | Gets the CropInfo. |
| setCr2CropInfoPackage(Cr2CropInfoPackage value) | Sets the CropInfo. |
| getCr2CropInfo() | Gets the CanonCameraSettings Offset. |
| setCr2CropInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AspectInfoPackage() | Gets the AspectInfo. |
| setCr2AspectInfoPackage(Cr2AspectInfoPackage value) | Sets the AspectInfo. |
| getCr2AspectInfo() | Gets the CanonCameraSettings Offset. |
| setCr2AspectInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ProcessingPackage() | Gets the ProcessingInfo. |
| setCr2ProcessingPackage(Cr2ProcessingPackage value) | Sets the ProcessingInfo. |
| getCr2Processing() | Gets the CanonCameraSettings Offset. |
| setCr2Processing(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ColorBalancePackage() | Gets the ColorBalance (These tags are used by the 10D and 300D.). |
| setCr2ColorBalancePackage(Cr2ColorBalancePackage value) | Sets the ColorBalance (These tags are used by the 10D and 300D.). |
| getCr2ColorBalance() | Gets the CanonCameraSettings Offset. |
| setCr2ColorBalance(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ModifiedInfoPackage() | Gets the MeasuredColor. |
| setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value) | Sets the MeasuredColor. |
| getCr2ModifiedInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ModifiedInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2SensorInfoPackage() | Gets the SensorInfo. |
| setCr2SensorInfoPackage(Cr2SensorInfoPackage value) | Sets the SensorInfo. |
| getCr2SensorInfo() | Gets the CanonCameraSettings Offset. |
| setCr2SensorInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2ColorInfoPackage() | Gets the ColorInfo. |
| setCr2ColorInfoPackage(Cr2ColorInfoPackage value) | Sets the ColorInfo. |
| getCr2ColorInfo() | Gets the CanonCameraSettings Offset. |
| setCr2ColorInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFMicroAdjPackage() | Gets the AFMicroAdj. |
| setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value) | Sets the AFMicroAdj. |
| getCr2AFMicroAdj() | Gets the CanonCameraSettings Offset. |
| setCr2AFMicroAdj(long value) | Sets the CanonCameraSettings Offset. |
| getCr2LightingOptPackage() | Gets the LightingOpt (This information is new in images from the EOS 7D.). |
| setCr2LightingOptPackage(Cr2LightingOptPackage value) | Sets the LightingOpt (This information is new in images from the EOS 7D.). |
| getCr2LightingOpt() | Gets the CanonCameraSettings Offset. |
| setCr2LightingOpt(long value) | Sets the CanonCameraSettings Offset. |
| getCr2MultiExpPackage() | Gets the MultiExp. |
| setCr2MultiExpPackage(Cr2MultiExpPackage value) | Sets the MultiExp. |
| getCr2MultiExp() | Gets the CanonCameraSettings Offset. |
| setCr2MultiExp(long value) | Sets the CanonCameraSettings Offset. |
| getCr2LogInfoPackage() | Gets the LogInfo. |
| setCr2LogInfoPackage(Cr2LogInfoPackage value) | Sets the LogInfo. |
| getCr2LogInfo() | Gets the CanonCameraSettings Offset. |
| setCr2LogInfo(long value) | Sets the CanonCameraSettings Offset. |
| getCr2AFConfigPackage() | Gets the AFConfig. |
| setCr2AFConfigPackage(Cr2AFConfigPackage value) | Sets the AFConfig. |
| getCr2AFConfig() | Gets the CanonCameraSettings Offset. |
| setCr2AFConfig(long value) | Sets the CanonCameraSettings Offset. |
| getImageType() | Gets the ImageType. |
| setImageType(String value) | Sets the ImageType. |
| getFirmwareVersion() | Gets the FirmwareVersion. |
| setFirmwareVersion(String value) | Sets the FirmwareVersion. |
| getFileNumber() | Gets the FileNumber. |
| setFileNumber(long value) | Sets the FileNumber. |
| getOwnerName() | Gets the OwnerName. |
| setOwnerName(String value) | Sets the OwnerName. |
| getSerialNumber() | Gets the SerialNumber. |
| setSerialNumber(long value) | Sets the SerialNumber. |
| getFileLength() | Gets the FileLength. |
| setFileLength(long value) | Sets the FileLength. |
| getModelID() | Gets the ModelID. |
| setModelID(long value) | Sets the ModelID. |
| getThumbnailImageValidArea() | Gets the ThumbnailImageValidArea. |
| setThumbnailImageValidArea(int[] value) | Sets the ThumbnailImageValidArea. |
| getSerialNumberFormat() | Gets the SerialNumberFormat. |
| setSerialNumberFormat(long value) | Sets the SerialNumberFormat. |
| getSuperMacro() | Gets the SuperMacro. |
| setSuperMacro(int value) | Sets the SuperMacro. |
| getDateStampMode() | Gets the DateStampMode. |
| setDateStampMode(int value) | Sets the DateStampMode. |
| getMyColors() | Gets the MyColors. |
| setMyColors(int[] value) | Sets the MyColors. |
| getContrastInfo() | Gets the Categories. |
| setContrastInfo(int[] value) | Sets the Categories. |
| getCategories() | Gets the Categories. |
| setCategories(long[] value) | Sets the Categories. |
| getImageUniqueID() | Gets the ImageUniqueID. |
| setImageUniqueID(byte[] value) | Sets the ImageUniqueID. |
| getOriginalDecisionDataOffset() | Gets the OriginalDecisionDataOffset. |
| setOriginalDecisionDataOffset(long value) | Sets the OriginalDecisionDataOffset. |
| getLensModel() | Gets the LensModel. |
| setLensModel(String value) | Sets the LensModel. |
| getInternalSerialNumber() | Gets the InternalSerialNumber. |
| setInternalSerialNumber(String value) | Sets the InternalSerialNumber. |
| getColorTemperature() | Gets the ColorTemperature. |
| setColorTemperature(int value) | Sets the ColorTemperature. |
| getMeasuredColor() | Gets the MeasuredColor. |
| setMeasuredColor(int[] value) | Sets the MeasuredColor. |
| getColorSpace() | Gets the ColorSpace. |
| setColorSpace(int value) | Sets the ColorSpace. |
| getCanonFlags() | Gets the CanonFlags. |
| setCanonFlags(int value) | Sets the CanonFlags. |
| getVRDOffset() | Gets the VRDOffset. |
| setVRDOffset(long value) | Sets the VRDOffset. |
| getPictureStyleUserDef() | Gets the PictureStyleUserDef. |
| setPictureStyleUserDef(int[] value) | Sets the PictureStyleUserDef. |
| getPictureStylePC() | Gets the PictureStylePC. |
| setPictureStylePC(int[] value) | Sets the PictureStylePC. |
| getCustomPictureStyleFileName() | Gets the CustomPictureStyleFileName. |
| setCustomPictureStyleFileName(String value) | Sets the CustomPictureStyleFileName. |
| getLensInfo() | Gets the LensInfo. |
| setLensInfo(byte[] value) | Sets the LensInfo. |
| getAmbienceInfo() | Gets the LensInfo. |
| setAmbienceInfo(long[] value) | Sets the LensInfo. |
| getCameraInfo() | Gets the CameraInfo. |
| setCameraInfo(long value) | Sets the CameraInfo. |
| getCustomFunctions() | Gets the CustomFunctions. |
| setCustomFunctions(long value) | Sets the CustomFunctions. |
| getFaceDetect1() | Gets the FaceDetect1. |
| setFaceDetect1(long value) | Sets the FaceDetect1. |
| getFaceDetect2() | Gets the FaceDetect2. |
| setFaceDetect2(long value) | Sets the FaceDetect2. |
| getFaceDetect3() | Gets the FaceDetect3. |
| setFaceDetect3(long value) | Sets the FaceDetect3. |
| getPreviewImageInfo() | Gets the PreviewImageInfo. |
| setPreviewImageInfo(long value) | Sets the PreviewImageInfo. |
| getColorData1() | Gets the ColorData1. |
| setColorData1(long value) | Sets the ColorData1. |
| getVignettingCorr() | Gets the VignettingCorr. |
| setVignettingCorr(long value) | Sets the VignettingCorr. |
| getHDRInfo() | Gets the HDRInfo. |
| setHDRInfo(long value) | Sets the HDRInfo. |
| getRawBurstModeRoll() | Gets the RawBurstModeRoll. |
| setRawBurstModeRoll(long value) | Sets the RawBurstModeRoll. |
##### Cr2MakerNotePackage()
```
public Cr2MakerNotePackage()
```

Initializes a new instance of the  Cr2MakerNotePackage  class.

##### getCr2CameraSettingsPackage()
```
public final Cr2CameraSettingsPackage getCr2CameraSettingsPackage()
```

Gets the CanonCameraSettings.

**Returns:**
Cr2CameraSettingsPackage - The CanonCameraSettings.
##### setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value)
```
public final void setCr2CameraSettingsPackage(Cr2CameraSettingsPackage value)
```

Sets the CanonCameraSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2CameraSettingsPackage | The CanonCameraSettings. |

##### getCameraSettings()
```
public final long getCameraSettings()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCameraSettings(long value)
```
public final void setCameraSettings(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2FocalLengthPackage()
```
public final Cr2FocalLengthPackage getCr2FocalLengthPackage()
```

Gets the CanonFocalLength.

**Returns:**
Cr2FocalLengthPackage - The CanonFocalLength.
##### setCr2FocalLengthPackage(Cr2FocalLengthPackage value)
```
public final void setCr2FocalLengthPackage(Cr2FocalLengthPackage value)
```

Sets the CanonFocalLength.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2FocalLengthPackage | The CanonFocalLength. |

##### getCr2FocalLength()
```
public final long getCr2FocalLength()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2FocalLength(long value)
```
public final void setCr2FocalLength(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ShotInfoPackage()
```
public final Cr2ShotInfoPackage getCr2ShotInfoPackage()
```

Gets the CanonShotInfo.

**Returns:**
Cr2ShotInfoPackage - The CanonShotInfo.
##### setCr2ShotInfoPackage(Cr2ShotInfoPackage value)
```
public final void setCr2ShotInfoPackage(Cr2ShotInfoPackage value)
```

Sets the CanonShotInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ShotInfoPackage | The CanonShotInfo. |

##### getCr2ShotInfo()
```
public final long getCr2ShotInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ShotInfo(long value)
```
public final void setCr2ShotInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PanoramaPackage()
```
public final Cr2PanoramaPackage getCr2PanoramaPackage()
```

Gets the CanonPanorama.

**Returns:**
Cr2PanoramaPackage - The CanonPanorama.
##### setCr2PanoramaPackage(Cr2PanoramaPackage value)
```
public final void setCr2PanoramaPackage(Cr2PanoramaPackage value)
```

Sets the CanonPanorama.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PanoramaPackage | The CanonPanorama. |

##### getCr2Panorama()
```
public final long getCr2Panorama()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Panorama(long value)
```
public final void setCr2Panorama(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2MovieInfoPackage()
```
public final Cr2MovieInfoPackage getCr2MovieInfoPackage()
```

Gets the MovieInfo (Tags written by some Canon cameras when recording video).

**Returns:**
Cr2MovieInfoPackage - The MovieInfo.
##### setCr2MovieInfoPackage(Cr2MovieInfoPackage value)
```
public final void setCr2MovieInfoPackage(Cr2MovieInfoPackage value)
```

Sets the MovieInfo (Tags written by some Canon cameras when recording video).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2MovieInfoPackage | The MovieInfo. |

##### getCr2MovieInfo()
```
public final long getCr2MovieInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2MovieInfo(long value)
```
public final void setCr2MovieInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFInfo2Package()
```
public final Cr2AFInfo2Package getCr2AFInfo2Package()
```

Gets the AFInfo3 (Newer version of the AFInfo record).

**Returns:**
Cr2AFInfo2Package - The AFInfo3.
##### setCr2AFInfo2Package(Cr2AFInfo2Package value)
```
public final void setCr2AFInfo2Package(Cr2AFInfo2Package value)
```

Sets the AFInfo3 (Newer version of the AFInfo record).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFInfo2Package | The AFInfo3. |

##### getCr2AFInfo2()
```
public final long getCr2AFInfo2()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFInfo2(long value)
```
public final void setCr2AFInfo2(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2WBInfoPackage()
```
public final Cr2WBInfoPackage getCr2WBInfoPackage()
```

Gets the WBInfo (WB tags for the Canon G9).

**Returns:**
Cr2WBInfoPackage - The WBInfo.
##### setCr2WBInfoPackage(Cr2WBInfoPackage value)
```
public final void setCr2WBInfoPackage(Cr2WBInfoPackage value)
```

Sets the WBInfo (WB tags for the Canon G9).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2WBInfoPackage | The WBInfo. |

##### getCr2WBInfo()
```
public final long getCr2WBInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2WBInfo(long value)
```
public final void setCr2WBInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2TimeInfoPackage()
```
public final Cr2TimeInfoPackage getCr2TimeInfoPackage()
```

Gets the TimeInfo.

**Returns:**
Cr2TimeInfoPackage - The TimeInfo.
##### setCr2TimeInfoPackage(Cr2TimeInfoPackage value)
```
public final void setCr2TimeInfoPackage(Cr2TimeInfoPackage value)
```

Sets the TimeInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2TimeInfoPackage | The TimeInfo. |

##### getCr2TimeInfo()
```
public final long getCr2TimeInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2TimeInfo(long value)
```
public final void setCr2TimeInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFInfo3Package()
```
public final Cr2AFInfo2Package getCr2AFInfo3Package()
```

Gets the AFInfo3.

**Returns:**
Cr2AFInfo2Package - The AFInfo3.
##### setCr2AFInfo3Package(Cr2AFInfo2Package value)
```
public final void setCr2AFInfo3Package(Cr2AFInfo2Package value)
```

Sets the AFInfo3.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFInfo2Package | The AFInfo3. |

##### getCr2AFInfo3()
```
public final long getCr2AFInfo3()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFInfo3(long value)
```
public final void setCr2AFInfo3(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2Functions1DPackage()
```
public final Cr2Functions1DPackage getCr2Functions1DPackage()
```

Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).

**Returns:**
Cr2Functions1DPackage - The CustomFunctions1D.
##### setCr2Functions1DPackage(Cr2Functions1DPackage value)
```
public final void setCr2Functions1DPackage(Cr2Functions1DPackage value)
```

Sets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2Functions1DPackage | The CustomFunctions1D. |

##### getCr2Functions1D()
```
public final long getCr2Functions1D()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Functions1D(long value)
```
public final void setCr2Functions1D(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PersonalFuncsPackage()
```
public final Cr2PersonalFuncsPackage getCr2PersonalFuncsPackage()
```

Gets the PersonalFunctions (Personal function settings for the EOS-1D.).

**Returns:**
Cr2PersonalFuncsPackage - The PersonalFunctions.
##### setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value)
```
public final void setCr2PersonalFuncsPackage(Cr2PersonalFuncsPackage value)
```

Sets the PersonalFunctions (Personal function settings for the EOS-1D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PersonalFuncsPackage | The PersonalFunctions. |

##### getCr2PersonalFuncs()
```
public final long getCr2PersonalFuncs()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2PersonalFuncs(long value)
```
public final void setCr2PersonalFuncs(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2PersonalFuncValuesPackage()
```
public final Cr2PersonalFuncValuesPackage getCr2PersonalFuncValuesPackage()
```

Gets the PersonalFunctionValues.

**Returns:**
Cr2PersonalFuncValuesPackage - The PersonalFunctionValues.
##### setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value)
```
public final void setCr2PersonalFuncValuesPackage(Cr2PersonalFuncValuesPackage value)
```

Sets the PersonalFunctionValues.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2PersonalFuncValuesPackage | The PersonalFunctionValues. |

##### getCr2PersonalFuncValues()
```
public final long getCr2PersonalFuncValues()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2PersonalFuncValues(long value)
```
public final void setCr2PersonalFuncValues(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2FileInfoPackage()
```
public final Cr2FileInfoPackage getCr2FileInfoPackage()
```

Not used in this version. Gets the CanonFileInfo.

**Returns:**
Cr2FileInfoPackage - The CanonFileInfo.
##### setCr2FileInfoPackage(Cr2FileInfoPackage value)
```
public final void setCr2FileInfoPackage(Cr2FileInfoPackage value)
```

Not used in this version. Gets the CanonFileInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2FileInfoPackage |  |

##### getCr2FileInfo()
```
public final long getCr2FileInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2FileInfo(long value)
```
public final void setCr2FileInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2CropInfoPackage()
```
public final Cr2CropInfoPackage getCr2CropInfoPackage()
```

Gets the CropInfo.

**Returns:**
Cr2CropInfoPackage - The CropInfo.
##### setCr2CropInfoPackage(Cr2CropInfoPackage value)
```
public final void setCr2CropInfoPackage(Cr2CropInfoPackage value)
```

Sets the CropInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2CropInfoPackage | The CropInfo. |

##### getCr2CropInfo()
```
public final long getCr2CropInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2CropInfo(long value)
```
public final void setCr2CropInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AspectInfoPackage()
```
public final Cr2AspectInfoPackage getCr2AspectInfoPackage()
```

Gets the AspectInfo.

**Returns:**
Cr2AspectInfoPackage - The AspectInfo.
##### setCr2AspectInfoPackage(Cr2AspectInfoPackage value)
```
public final void setCr2AspectInfoPackage(Cr2AspectInfoPackage value)
```

Sets the AspectInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AspectInfoPackage | The AspectInfo. |

##### getCr2AspectInfo()
```
public final long getCr2AspectInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AspectInfo(long value)
```
public final void setCr2AspectInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ProcessingPackage()
```
public final Cr2ProcessingPackage getCr2ProcessingPackage()
```

Gets the ProcessingInfo.

**Returns:**
Cr2ProcessingPackage - The ProcessingInfo.
##### setCr2ProcessingPackage(Cr2ProcessingPackage value)
```
public final void setCr2ProcessingPackage(Cr2ProcessingPackage value)
```

Sets the ProcessingInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ProcessingPackage | The ProcessingInfo. |

##### getCr2Processing()
```
public final long getCr2Processing()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2Processing(long value)
```
public final void setCr2Processing(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ColorBalancePackage()
```
public final Cr2ColorBalancePackage getCr2ColorBalancePackage()
```

Gets the ColorBalance (These tags are used by the 10D and 300D.).

**Returns:**
Cr2ColorBalancePackage - The ColorBalance.
##### setCr2ColorBalancePackage(Cr2ColorBalancePackage value)
```
public final void setCr2ColorBalancePackage(Cr2ColorBalancePackage value)
```

Sets the ColorBalance (These tags are used by the 10D and 300D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ColorBalancePackage | The ColorBalance. |

##### getCr2ColorBalance()
```
public final long getCr2ColorBalance()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ColorBalance(long value)
```
public final void setCr2ColorBalance(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ModifiedInfoPackage()
```
public final Cr2ModifiedInfoPackage getCr2ModifiedInfoPackage()
```

Gets the MeasuredColor.

**Returns:**
Cr2ModifiedInfoPackage - The MeasuredColor.
##### setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value)
```
public final void setCr2ModifiedInfoPackage(Cr2ModifiedInfoPackage value)
```

Sets the MeasuredColor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ModifiedInfoPackage | The MeasuredColor. |

##### getCr2ModifiedInfo()
```
public final long getCr2ModifiedInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ModifiedInfo(long value)
```
public final void setCr2ModifiedInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2SensorInfoPackage()
```
public final Cr2SensorInfoPackage getCr2SensorInfoPackage()
```

Gets the SensorInfo.

**Returns:**
Cr2SensorInfoPackage - The SensorInfo.
##### setCr2SensorInfoPackage(Cr2SensorInfoPackage value)
```
public final void setCr2SensorInfoPackage(Cr2SensorInfoPackage value)
```

Sets the SensorInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2SensorInfoPackage | The SensorInfo. |

##### getCr2SensorInfo()
```
public final long getCr2SensorInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2SensorInfo(long value)
```
public final void setCr2SensorInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2ColorInfoPackage()
```
public final Cr2ColorInfoPackage getCr2ColorInfoPackage()
```

Gets the ColorInfo.

**Returns:**
Cr2ColorInfoPackage - The ColorInfo.
##### setCr2ColorInfoPackage(Cr2ColorInfoPackage value)
```
public final void setCr2ColorInfoPackage(Cr2ColorInfoPackage value)
```

Sets the ColorInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2ColorInfoPackage | The ColorInfo. |

##### getCr2ColorInfo()
```
public final long getCr2ColorInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2ColorInfo(long value)
```
public final void setCr2ColorInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFMicroAdjPackage()
```
public final Cr2AFMicroAdjPackage getCr2AFMicroAdjPackage()
```

Gets the AFMicroAdj.

**Returns:**
Cr2AFMicroAdjPackage - The AFMicroAdj.
##### setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value)
```
public final void setCr2AFMicroAdjPackage(Cr2AFMicroAdjPackage value)
```

Sets the AFMicroAdj.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFMicroAdjPackage | The AFMicroAdj. |

##### getCr2AFMicroAdj()
```
public final long getCr2AFMicroAdj()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFMicroAdj(long value)
```
public final void setCr2AFMicroAdj(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2LightingOptPackage()
```
public final Cr2LightingOptPackage getCr2LightingOptPackage()
```

Gets the LightingOpt (This information is new in images from the EOS 7D.).

**Returns:**
Cr2LightingOptPackage - The LightingOpt.
##### setCr2LightingOptPackage(Cr2LightingOptPackage value)
```
public final void setCr2LightingOptPackage(Cr2LightingOptPackage value)
```

Sets the LightingOpt (This information is new in images from the EOS 7D.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2LightingOptPackage | The LightingOpt. |

##### getCr2LightingOpt()
```
public final long getCr2LightingOpt()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2LightingOpt(long value)
```
public final void setCr2LightingOpt(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2MultiExpPackage()
```
public final Cr2MultiExpPackage getCr2MultiExpPackage()
```

Gets the MultiExp.

**Returns:**
Cr2MultiExpPackage - The MultiExp.
##### setCr2MultiExpPackage(Cr2MultiExpPackage value)
```
public final void setCr2MultiExpPackage(Cr2MultiExpPackage value)
```

Sets the MultiExp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2MultiExpPackage | The MultiExp. |

##### getCr2MultiExp()
```
public final long getCr2MultiExp()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2MultiExp(long value)
```
public final void setCr2MultiExp(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2LogInfoPackage()
```
public final Cr2LogInfoPackage getCr2LogInfoPackage()
```

Gets the LogInfo.

**Returns:**
Cr2LogInfoPackage - The LogInfo.
##### setCr2LogInfoPackage(Cr2LogInfoPackage value)
```
public final void setCr2LogInfoPackage(Cr2LogInfoPackage value)
```

Sets the LogInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2LogInfoPackage | The LogInfo. |

##### getCr2LogInfo()
```
public final long getCr2LogInfo()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2LogInfo(long value)
```
public final void setCr2LogInfo(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getCr2AFConfigPackage()
```
public final Cr2AFConfigPackage getCr2AFConfigPackage()
```

Gets the AFConfig.

**Returns:**
Cr2AFConfigPackage - The AFConfig.
##### setCr2AFConfigPackage(Cr2AFConfigPackage value)
```
public final void setCr2AFConfigPackage(Cr2AFConfigPackage value)
```

Sets the AFConfig.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cr2AFConfigPackage | The AFConfig. |

##### getCr2AFConfig()
```
public final long getCr2AFConfig()
```

Gets the CanonCameraSettings Offset.

**Returns:**
long - The CanonCameraSettings Offset.
##### setCr2AFConfig(long value)
```
public final void setCr2AFConfig(long value)
```

Sets the CanonCameraSettings Offset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CanonCameraSettings Offset. |

##### getImageType()
```
public final String getImageType()
```

Gets the ImageType.

**Returns:**
java.lang.String - The ImageType.
##### setImageType(String value)
```
public final void setImageType(String value)
```

Sets the ImageType.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The ImageType. |

##### getFirmwareVersion()
```
public final String getFirmwareVersion()
```

Gets the FirmwareVersion.

**Returns:**
java.lang.String - The FirmwareVersion.
##### setFirmwareVersion(String value)
```
public final void setFirmwareVersion(String value)
```

Sets the FirmwareVersion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The FirmwareVersion. |

##### getFileNumber()
```
public final long getFileNumber()
```

Gets the FileNumber.

**Returns:**
long - The FileNumber.
##### setFileNumber(long value)
```
public final void setFileNumber(long value)
```

Sets the FileNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FileNumber. |

##### getOwnerName()
```
public final String getOwnerName()
```

Gets the OwnerName.

**Returns:**
java.lang.String - The OwnerName.
##### setOwnerName(String value)
```
public final void setOwnerName(String value)
```

Sets the OwnerName.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The OwnerName. |

##### getSerialNumber()
```
public final long getSerialNumber()
```

Gets the SerialNumber.

**Returns:**
long - The SerialNumber.
##### setSerialNumber(long value)
```
public final void setSerialNumber(long value)
```

Sets the SerialNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The SerialNumber. |

##### getFileLength()
```
public final long getFileLength()
```

Gets the FileLength.

**Returns:**
long - The FileLength.
##### setFileLength(long value)
```
public final void setFileLength(long value)
```

Sets the FileLength.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FileLength. |

##### getModelID()
```
public final long getModelID()
```

Gets the ModelID.

**Returns:**
long - The ModelID.
##### setModelID(long value)
```
public final void setModelID(long value)
```

Sets the ModelID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The ModelID. |

##### getThumbnailImageValidArea()
```
public final int[] getThumbnailImageValidArea()
```

Gets the ThumbnailImageValidArea.

**Returns:**
int[] - The ThumbnailImageValidArea.
##### setThumbnailImageValidArea(int[] value)
```
public final void setThumbnailImageValidArea(int[] value)
```

Sets the ThumbnailImageValidArea.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The ThumbnailImageValidArea. |

##### getSerialNumberFormat()
```
public final long getSerialNumberFormat()
```

Gets the SerialNumberFormat.

**Returns:**
long - The SerialNumberFormat.
##### setSerialNumberFormat(long value)
```
public final void setSerialNumberFormat(long value)
```

Sets the SerialNumberFormat.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The SerialNumberFormat. |

##### getSuperMacro()
```
public final int getSuperMacro()
```

Gets the SuperMacro.

**Returns:**
int - The SuperMacro.
##### setSuperMacro(int value)
```
public final void setSuperMacro(int value)
```

Sets the SuperMacro.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The SuperMacro. |

##### getDateStampMode()
```
public final int getDateStampMode()
```

Gets the DateStampMode.

**Returns:**
int - The DateStampMode.
##### setDateStampMode(int value)
```
public final void setDateStampMode(int value)
```

Sets the DateStampMode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The DateStampMode. |

##### getMyColors()
```
public final int[] getMyColors()
```

Gets the MyColors.

**Returns:**
int[] - The MyColors.
##### setMyColors(int[] value)
```
public final void setMyColors(int[] value)
```

Sets the MyColors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The MyColors. |

##### getContrastInfo()
```
public final int[] getContrastInfo()
```

Gets the Categories.

**Returns:**
int[] - The Categories.
##### setContrastInfo(int[] value)
```
public final void setContrastInfo(int[] value)
```

Sets the Categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The Categories. |

##### getCategories()
```
public final long[] getCategories()
```

Gets the Categories.

**Returns:**
long[] - The Categories.
##### setCategories(long[] value)
```
public final void setCategories(long[] value)
```

Sets the Categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long[] | The Categories. |

##### getImageUniqueID()
```
public final byte[] getImageUniqueID()
```

Gets the ImageUniqueID.

**Returns:**
byte[] - The ImageUniqueID.
##### setImageUniqueID(byte[] value)
```
public final void setImageUniqueID(byte[] value)
```

Sets the ImageUniqueID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The ImageUniqueID. |

##### getOriginalDecisionDataOffset()
```
public final long getOriginalDecisionDataOffset()
```

Gets the OriginalDecisionDataOffset.

**Returns:**
long - The OriginalDecisionDataOffset.
##### setOriginalDecisionDataOffset(long value)
```
public final void setOriginalDecisionDataOffset(long value)
```

Sets the OriginalDecisionDataOffset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The OriginalDecisionDataOffset. |

##### getLensModel()
```
public final String getLensModel()
```

Gets the LensModel.

**Returns:**
java.lang.String - The LensModel.
##### setLensModel(String value)
```
public final void setLensModel(String value)
```

Sets the LensModel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The LensModel. |

##### getInternalSerialNumber()
```
public final String getInternalSerialNumber()
```

Gets the InternalSerialNumber.

**Returns:**
java.lang.String - The InternalSerialNumber.
##### setInternalSerialNumber(String value)
```
public final void setInternalSerialNumber(String value)
```

Sets the InternalSerialNumber.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The InternalSerialNumber. |

##### getColorTemperature()
```
public final int getColorTemperature()
```

Gets the ColorTemperature.

**Returns:**
int - The ColorTemperature.
##### setColorTemperature(int value)
```
public final void setColorTemperature(int value)
```

Sets the ColorTemperature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The ColorTemperature. |

##### getMeasuredColor()
```
public final int[] getMeasuredColor()
```

Gets the MeasuredColor.

**Returns:**
int[] - The MeasuredColor.
##### setMeasuredColor(int[] value)
```
public final void setMeasuredColor(int[] value)
```

Sets the MeasuredColor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The MeasuredColor. |

##### getColorSpace()
```
public final int getColorSpace()
```

Gets the ColorSpace.

**Returns:**
int - The ColorSpace.
##### setColorSpace(int value)
```
public final void setColorSpace(int value)
```

Sets the ColorSpace.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The ColorSpace. |

##### getCanonFlags()
```
public final int getCanonFlags()
```

Gets the CanonFlags.

**Returns:**
int - The CanonFlags.
##### setCanonFlags(int value)
```
public final void setCanonFlags(int value)
```

Sets the CanonFlags.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The CanonFlags. |

##### getVRDOffset()
```
public final long getVRDOffset()
```

Gets the VRDOffset.

**Returns:**
long - The VRDOffset.
##### setVRDOffset(long value)
```
public final void setVRDOffset(long value)
```

Sets the VRDOffset.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The VRDOffset. |

##### getPictureStyleUserDef()
```
public final int[] getPictureStyleUserDef()
```

Gets the PictureStyleUserDef.

**Returns:**
int[] - The PictureStyleUserDef.
##### setPictureStyleUserDef(int[] value)
```
public final void setPictureStyleUserDef(int[] value)
```

Sets the PictureStyleUserDef.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The PictureStyleUserDef. |

##### getPictureStylePC()
```
public final int[] getPictureStylePC()
```

Gets the PictureStylePC.

**Returns:**
int[] - The PictureStylePC.
##### setPictureStylePC(int[] value)
```
public final void setPictureStylePC(int[] value)
```

Sets the PictureStylePC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The PictureStylePC. |

##### getCustomPictureStyleFileName()
```
public final String getCustomPictureStyleFileName()
```

Gets the CustomPictureStyleFileName.

**Returns:**
java.lang.String - The CustomPictureStyleFileName.
##### setCustomPictureStyleFileName(String value)
```
public final void setCustomPictureStyleFileName(String value)
```

Sets the CustomPictureStyleFileName.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The CustomPictureStyleFileName. |

##### getLensInfo()
```
public final byte[] getLensInfo()
```

Gets the LensInfo.

**Returns:**
byte[] - The LensInfo.
##### setLensInfo(byte[] value)
```
public final void setLensInfo(byte[] value)
```

Sets the LensInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The LensInfo. |

##### getAmbienceInfo()
```
public final long[] getAmbienceInfo()
```

Gets the LensInfo.

**Returns:**
long[] - The LensInfo.
##### setAmbienceInfo(long[] value)
```
public final void setAmbienceInfo(long[] value)
```

Sets the LensInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long[] | The LensInfo. |

##### getCameraInfo()
```
public final long getCameraInfo()
```

Gets the CameraInfo.

**Returns:**
long - The CameraInfo.
##### setCameraInfo(long value)
```
public final void setCameraInfo(long value)
```

Sets the CameraInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CameraInfo. |

##### getCustomFunctions()
```
public final long getCustomFunctions()
```

Gets the CustomFunctions.

**Returns:**
long - The CustomFunctions.
##### setCustomFunctions(long value)
```
public final void setCustomFunctions(long value)
```

Sets the CustomFunctions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The CustomFunctions. |

##### getFaceDetect1()
```
public final long getFaceDetect1()
```

Gets the FaceDetect1.

**Returns:**
long - The FaceDetect1.
##### setFaceDetect1(long value)
```
public final void setFaceDetect1(long value)
```

Sets the FaceDetect1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect1. |

##### getFaceDetect2()
```
public final long getFaceDetect2()
```

Gets the FaceDetect2.

**Returns:**
long - The FaceDetect2.
##### setFaceDetect2(long value)
```
public final void setFaceDetect2(long value)
```

Sets the FaceDetect2.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect2. |

##### getFaceDetect3()
```
public final long getFaceDetect3()
```

Gets the FaceDetect3.

**Returns:**
long - The FaceDetect3.
##### setFaceDetect3(long value)
```
public final void setFaceDetect3(long value)
```

Sets the FaceDetect3.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The FaceDetect3. |

##### getPreviewImageInfo()
```
public final long getPreviewImageInfo()
```

Gets the PreviewImageInfo.

**Returns:**
long - The PreviewImageInfo.
##### setPreviewImageInfo(long value)
```
public final void setPreviewImageInfo(long value)
```

Sets the PreviewImageInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The PreviewImageInfo. |

##### getColorData1()
```
public final long getColorData1()
```

Gets the ColorData1.

**Returns:**
long - The ColorData1.
##### setColorData1(long value)
```
public final void setColorData1(long value)
```

Sets the ColorData1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The ColorData1. |

##### getVignettingCorr()
```
public final long getVignettingCorr()
```

Gets the VignettingCorr.

**Returns:**
long - The VignettingCorr.
##### setVignettingCorr(long value)
```
public final void setVignettingCorr(long value)
```

Sets the VignettingCorr.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The VignettingCorr. |

##### getHDRInfo()
```
public final long getHDRInfo()
```

Gets the HDRInfo.

**Returns:**
long - The HDRInfo.
##### setHDRInfo(long value)
```
public final void setHDRInfo(long value)
```

Sets the HDRInfo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The HDRInfo. |

##### getRawBurstModeRoll()
```
public final long getRawBurstModeRoll()
```

Gets the RawBurstModeRoll.

**Returns:**
long - The RawBurstModeRoll.
##### setRawBurstModeRoll(long value)
```
public final void setRawBurstModeRoll(long value)
```

Sets the RawBurstModeRoll.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The RawBurstModeRoll. |

### Cr2ModifiedInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2modifiedinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ModifiedInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ModifiedInfoPackage() | Initializes a new instance of the  Cr2ModifiedInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModifiedToneCurve() | Gets the ModifiedToneCurve. |
| getModifiedSharpness() | Gets the ModifiedSharpness. |
| getModifiedSharpnessFreq() | Gets the ModifiedSharpnessFreq. |
| getModifiedSensorRedLevel() | Gets the ModifiedSensorRedLevel. |
| getModifiedSensorBlueLevel() | Gets the ModifiedSensorBlueLevel. |
| getModifiedWhiteBalanceRed() | Gets the ModifiedWhiteBalanceRed. |
| getModifiedWhiteBalanceBlue() | Gets the ModifiedWhiteBalanceBlue. |
| getModifiedWhiteBalance() | Gets the ModifiedWhiteBalance. |
| getModifiedColorTemp() | Gets the ModifiedColorTemp. |
| getModifiedPictureStyle() | Gets the ModifiedPictureStyle. |
| getModifiedDigitalGain() | Gets the ModifiedDigitalGain. |
##### Cr2ModifiedInfoPackage()
```
public Cr2ModifiedInfoPackage()
```

Initializes a new instance of the  Cr2ModifiedInfoPackage  class.

##### getModifiedToneCurve()
```
public final int getModifiedToneCurve()
```

Gets the ModifiedToneCurve.

**Returns:**
int - The ModifiedToneCurve.
##### getModifiedSharpness()
```
public final int getModifiedSharpness()
```

Gets the ModifiedSharpness.

**Returns:**
int - The ModifiedSharpness.
##### getModifiedSharpnessFreq()
```
public final int getModifiedSharpnessFreq()
```

Gets the ModifiedSharpnessFreq.

**Returns:**
int - The ModifiedSharpnessFreq.
##### getModifiedSensorRedLevel()
```
public final int getModifiedSensorRedLevel()
```

Gets the ModifiedSensorRedLevel.

**Returns:**
int - The ModifiedSensorRedLevel.
##### getModifiedSensorBlueLevel()
```
public final int getModifiedSensorBlueLevel()
```

Gets the ModifiedSensorBlueLevel.

**Returns:**
int - The ModifiedSensorBlueLevel.
##### getModifiedWhiteBalanceRed()
```
public final int getModifiedWhiteBalanceRed()
```

Gets the ModifiedWhiteBalanceRed.

**Returns:**
int - The ModifiedWhiteBalanceRed.
##### getModifiedWhiteBalanceBlue()
```
public final int getModifiedWhiteBalanceBlue()
```

Gets the ModifiedWhiteBalanceBlue.

**Returns:**
int - The ModifiedWhiteBalanceBlue.
##### getModifiedWhiteBalance()
```
public final int getModifiedWhiteBalance()
```

Gets the ModifiedWhiteBalance.

**Returns:**
int - The ModifiedWhiteBalance.
##### getModifiedColorTemp()
```
public final int getModifiedColorTemp()
```

Gets the ModifiedColorTemp.

**Returns:**
int - The ModifiedColorTemp.
##### getModifiedPictureStyle()
```
public final int getModifiedPictureStyle()
```

Gets the ModifiedPictureStyle.

**Returns:**
int - The ModifiedPictureStyle.
##### getModifiedDigitalGain()
```
public final int getModifiedDigitalGain()
```

Gets the ModifiedDigitalGain.

**Returns:**
int - The ModifiedDigitalGain.

### Cr2MovieInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2movieinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2MovieInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MovieInfoPackage() | Initializes a new instance of the  Cr2MovieInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFrameRate() | Gets the FrameRate. |
| getFrameCount() | Gets the FrameCount. |
| getFrameCount2() | Gets the FrameCount2. |
| getFrameRate2() | Gets the FrameRate. |
| getDuration() | Gets the Duration. |
| getAudioBitrate() | Gets the AudioBitrate. |
| getAudioSampleRate() | Gets the AudioSampleRate. |
| getAudioChannels() | Gets the AudioChannels. |
| getVideoCodec() | Gets the VideoCodec. |
##### Cr2MovieInfoPackage()
```
public Cr2MovieInfoPackage()
```

Initializes a new instance of the  Cr2MovieInfoPackage  class.

##### getFrameRate()
```
public final int getFrameRate()
```

Gets the FrameRate.

**Returns:**
int - The FrameRate.
##### getFrameCount()
```
public final int getFrameCount()
```

Gets the FrameCount.

**Returns:**
int - The FrameCount.
##### getFrameCount2()
```
public final int getFrameCount2()
```

Gets the FrameCount2.

**Returns:**
int - The FrameCount2.
##### getFrameRate2()
```
public final float getFrameRate2()
```

Gets the FrameRate.

**Returns:**
float - The FrameRate.
##### getDuration()
```
public final int getDuration()
```

Gets the Duration.

**Returns:**
int - The Duration.
##### getAudioBitrate()
```
public final int getAudioBitrate()
```

Gets the AudioBitrate.

**Returns:**
int - The AudioBitrate.
##### getAudioSampleRate()
```
public final int getAudioSampleRate()
```

Gets the AudioSampleRate.

**Returns:**
int - The AudioSampleRate.
##### getAudioChannels()
```
public final int getAudioChannels()
```

Gets the AudioChannels.

**Returns:**
int - The AudioChannels.
##### getVideoCodec()
```
public final byte[] getVideoCodec()
```

Gets the VideoCodec.

**Returns:**
byte[] - The VideoCodec.

### Cr2MultiExpPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2multiexppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2MultiExpPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2MultiExpPackage() | Initializes a new instance of the  Cr2MultiExpPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMultiExposure() | Gets the MultiExposure. |
| getMultiExposureControl() | Gets the MultiExposureControl. |
| getMultiExposureShots() | Gets the MultiExposureShots. |
##### Cr2MultiExpPackage()
```
public Cr2MultiExpPackage()
```

Initializes a new instance of the  Cr2MultiExpPackage  class.

##### getMultiExposure()
```
public final int getMultiExposure()
```

Gets the MultiExposure.

**Returns:**
int - The MultiExposure.
##### getMultiExposureControl()
```
public final int getMultiExposureControl()
```

Gets the MultiExposureControl.

**Returns:**
int - The MultiExposureControl.
##### getMultiExposureShots()
```
public final int getMultiExposureShots()
```

Gets the MultiExposureShots.

**Returns:**
int - The MultiExposureShots.

### Cr2Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawPackage
```
public final class Cr2Package extends RawPackage
```

Represents native CR2 metadata.

[Working with DNG metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CR2+metadata
#### Methods

| Method | Description |
| --- | --- |
| getRawTiffTagPackage() | Gets the Tag Support Levels. |
##### getRawTiffTagPackage()
```
public final RawTiffTagPackage getRawTiffTagPackage()
```

Gets the Tag Support Levels.

**Returns:**
RawTiffTagPackage - The Tag Support Levels.

### Cr2PanoramaPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2panoramapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PanoramaPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PanoramaPackage() | Initializes a new instance of the  Cr2PanoramaPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPanoramaFrameNumber() | Gets the PanoramaFrameNumber. |
| getPanoramaDirection() | Gets the PanoramaDirection. |
##### Cr2PanoramaPackage()
```
public Cr2PanoramaPackage()
```

Initializes a new instance of the  Cr2PanoramaPackage  class.

##### getPanoramaFrameNumber()
```
public final int getPanoramaFrameNumber()
```

Gets the PanoramaFrameNumber.

**Returns:**
int - The PanoramaFrameNumber.
##### getPanoramaDirection()
```
public final int getPanoramaDirection()
```

Gets the PanoramaDirection.

**Returns:**
int - The PanoramaDirection.

### Cr2PersonalFuncsPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2personalfuncspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PersonalFuncsPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PersonalFuncsPackage() | Initializes a new instance of the  Cr2PersonalFuncsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPF0CustomFuncRegistration() | Gets the PF0CustomFuncRegistration. |
| getPF1DisableShootingModes() | Gets the PF1DisableShootingModes. |
| getPF2DisableMeteringModes() | Gets the PF2DisableMeteringModes. |
| getPF3ManualExposureMetering() | Gets the PF3ManualExposureMetering. |
| getPF4ExposureTimeLimits() | Gets the PF4ExposureTimeLimits. |
| getPF5ApertureLimits() | Gets the PF5ApertureLimits. |
| getPF6PresetShootingModes() | Gets the PF6PresetShootingModes. |
| getPF7BracketContinuousShoot() | Gets the PF7BracketContinuousShoot. |
| getPF8SetBracketShots() | Gets the PF8SetBracketShots. |
| getPF9ChangeBracketSequence() | Gets the PF9ChangeBracketSequence. |
| getPF10RetainProgramShift() | Gets the PF10RetainProgramShift. |
| getPF13DrivePriority() | Gets the PF13DrivePriority. |
| getPF14DisableFocusSearch() | Gets the PF14DisableFocusSearch. |
| getPF15DisableAFAssistBeam() | Gets the PF15DisableAFAssistBeam. |
| getPF16AutoFocusPointShoot() | Gets the PF16AutoFocusPointShoot. |
| getPF17DisableAFPointSel() | Gets the PF17DisableAFPointSel. |
| getPF18EnableAutoAFPointSel() | Gets the PF18EnableAutoAFPointSel. |
| getPF19ContinuousShootSpeed() | Gets the PF19ContinuousShootSpeed. |
| getPF20LimitContinousShots() | Gets the PF20LimitContinousShots. |
| getPF21EnableQuietOperation() | Gets the PF21EnableQuietOperation. |
| getPF23SetTimerLengths() | Gets the PF23SetTimerLengths. |
| getPF24LightLCDDuringBulb() | Gets the PF24LightLCDDuringBulb. |
| getPF25DefaultClearSettings() | Gets the PF25DefaultClearSettings. |
| getPF26ShortenReleaseLag() | Gets the PF26ShortenReleaseLag. |
| getPF27ReverseDialRotation() | Gets the PF27ReverseDialRotation. |
| getPF28NoQuickDialExpComp() | Gets the PF28NoQuickDialExpComp. |
| getPF29QuickDialSwitchOff() | Gets the PF29QuickDialSwitchOff. |
| getPF30EnlargementMode() | Gets the PF30EnlargementMode. |
| getPF31OriginalDecisionData() | Gets the PF31OriginalDecisionData. |
##### Cr2PersonalFuncsPackage()
```
public Cr2PersonalFuncsPackage()
```

Initializes a new instance of the  Cr2PersonalFuncsPackage  class.

##### getPF0CustomFuncRegistration()
```
public final int getPF0CustomFuncRegistration()
```

Gets the PF0CustomFuncRegistration.

**Returns:**
int - The PF0CustomFuncRegistration.
##### getPF1DisableShootingModes()
```
public final int getPF1DisableShootingModes()
```

Gets the PF1DisableShootingModes.

**Returns:**
int - The PF1DisableShootingModes.
##### getPF2DisableMeteringModes()
```
public final int getPF2DisableMeteringModes()
```

Gets the PF2DisableMeteringModes.

**Returns:**
int - The PF2DisableMeteringModes.
##### getPF3ManualExposureMetering()
```
public final int getPF3ManualExposureMetering()
```

Gets the PF3ManualExposureMetering.

**Returns:**
int - The PF3ManualExposureMetering.
##### getPF4ExposureTimeLimits()
```
public final int getPF4ExposureTimeLimits()
```

Gets the PF4ExposureTimeLimits.

**Returns:**
int - The PF4ExposureTimeLimits.
##### getPF5ApertureLimits()
```
public final int getPF5ApertureLimits()
```

Gets the PF5ApertureLimits.

**Returns:**
int - The PF5ApertureLimits.
##### getPF6PresetShootingModes()
```
public final int getPF6PresetShootingModes()
```

Gets the PF6PresetShootingModes.

**Returns:**
int - The PF6PresetShootingModes.
##### getPF7BracketContinuousShoot()
```
public final int getPF7BracketContinuousShoot()
```

Gets the PF7BracketContinuousShoot.

**Returns:**
int - The PF7BracketContinuousShoot.
##### getPF8SetBracketShots()
```
public final int getPF8SetBracketShots()
```

Gets the PF8SetBracketShots.

**Returns:**
int - The PF8SetBracketShots.
##### getPF9ChangeBracketSequence()
```
public final int getPF9ChangeBracketSequence()
```

Gets the PF9ChangeBracketSequence.

**Returns:**
int - The PF9ChangeBracketSequence.
##### getPF10RetainProgramShift()
```
public final int getPF10RetainProgramShift()
```

Gets the PF10RetainProgramShift.

**Returns:**
int - The PF10RetainProgramShift.
##### getPF13DrivePriority()
```
public final int getPF13DrivePriority()
```

Gets the PF13DrivePriority.

**Returns:**
int - The PF13DrivePriority.
##### getPF14DisableFocusSearch()
```
public final int getPF14DisableFocusSearch()
```

Gets the PF14DisableFocusSearch.

**Returns:**
int - The PF14DisableFocusSearch.
##### getPF15DisableAFAssistBeam()
```
public final int getPF15DisableAFAssistBeam()
```

Gets the PF15DisableAFAssistBeam.

**Returns:**
int - The PF15DisableAFAssistBeam.
##### getPF16AutoFocusPointShoot()
```
public final int getPF16AutoFocusPointShoot()
```

Gets the PF16AutoFocusPointShoot.

**Returns:**
int - The PF16AutoFocusPointShoot.
##### getPF17DisableAFPointSel()
```
public final int getPF17DisableAFPointSel()
```

Gets the PF17DisableAFPointSel.

**Returns:**
int - The PF17DisableAFPointSel.
##### getPF18EnableAutoAFPointSel()
```
public final int getPF18EnableAutoAFPointSel()
```

Gets the PF18EnableAutoAFPointSel.

**Returns:**
int - The PF18EnableAutoAFPointSel.
##### getPF19ContinuousShootSpeed()
```
public final int getPF19ContinuousShootSpeed()
```

Gets the PF19ContinuousShootSpeed.

**Returns:**
int - The PF19ContinuousShootSpeed.
##### getPF20LimitContinousShots()
```
public final int getPF20LimitContinousShots()
```

Gets the PF20LimitContinousShots.

**Returns:**
int - The PF20LimitContinousShots.
##### getPF21EnableQuietOperation()
```
public final int getPF21EnableQuietOperation()
```

Gets the PF21EnableQuietOperation.

**Returns:**
int - The PF21EnableQuietOperation.
##### getPF23SetTimerLengths()
```
public final int getPF23SetTimerLengths()
```

Gets the PF23SetTimerLengths.

**Returns:**
int - The PF23SetTimerLengths.
##### getPF24LightLCDDuringBulb()
```
public final int getPF24LightLCDDuringBulb()
```

Gets the PF24LightLCDDuringBulb.

**Returns:**
int - The PF24LightLCDDuringBulb.
##### getPF25DefaultClearSettings()
```
public final int getPF25DefaultClearSettings()
```

Gets the PF25DefaultClearSettings.

**Returns:**
int - The PF25DefaultClearSettings.
##### getPF26ShortenReleaseLag()
```
public final int getPF26ShortenReleaseLag()
```

Gets the PF26ShortenReleaseLag.

**Returns:**
int - The PF26ShortenReleaseLag.
##### getPF27ReverseDialRotation()
```
public final int getPF27ReverseDialRotation()
```

Gets the PF27ReverseDialRotation.

**Returns:**
int - The PF27ReverseDialRotation.
##### getPF28NoQuickDialExpComp()
```
public final int getPF28NoQuickDialExpComp()
```

Gets the PF28NoQuickDialExpComp.

**Returns:**
int - The PF28NoQuickDialExpComp.
##### getPF29QuickDialSwitchOff()
```
public final int getPF29QuickDialSwitchOff()
```

Gets the PF29QuickDialSwitchOff.

**Returns:**
int - The PF29QuickDialSwitchOff.
##### getPF30EnlargementMode()
```
public final int getPF30EnlargementMode()
```

Gets the PF30EnlargementMode.

**Returns:**
int - The PF30EnlargementMode.
##### getPF31OriginalDecisionData()
```
public final int getPF31OriginalDecisionData()
```

Gets the PF31OriginalDecisionData.

**Returns:**
int - The PF31OriginalDecisionData.

### Cr2PersonalFuncValuesPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2personalfuncvaluespackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2PersonalFuncValuesPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2PersonalFuncValuesPackage() | Initializes a new instance of the  Cr2PersonalFuncValuesPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPF1Value() | Gets the PF1Value. |
| getPF2Value() | Gets the PF2Value. |
| getPF3Value() | Gets the PF3Value. |
| getPF4ExposureTimeMin() | Gets the PF4ExposureTimeMin. |
| getPF4ExposureTimeMax() | Gets the PF4ExposureTimeMax. |
| getPF5ApertureMin() | Gets the PF5ApertureMin. |
| getPF5ApertureMax() | Gets the PF5ApertureMax. |
| getPF8BracketShots() | Gets the PF8BracketShots. |
| getPF19ShootingSpeedLow() | Gets the PF19ShootingSpeedLow. |
| getPF19ShootingSpeedHigh() | Gets the PF19ShootingSpeedHigh. |
| getPF20MaxContinousShots() | Gets the PF20MaxContinousShots. |
| getPF23ShutterButtonTime() | Gets the PF23ShutterButtonTime. |
| getPF23FELockTime() | Gets the PF23FELockTime. |
| getPF23PostReleaseTime() | Gets the PF23PostReleaseTime. |
| getPF25AEMode() | Gets the PF25AEMode. |
| getPF25MeteringMode() | Gets the PF25MeteringMode. |
| getPF25DriveMode() | Gets the PF25DriveMode. |
| getPF25AFMode() | Gets the PF25AFMode. |
| getPF25AFPointSel() | Gets the PF25AFPointSel. |
| getPF25ImageSize() | Gets the PF25ImageSize. |
| getPF25WBMode() | Gets the PF25WBMode. |
| getPF25Parameters() | Gets the PF25Parameters. |
| getPF25ColorMatrix() | Gets the PF25ColorMatrix. |
| getPF27Value() | Gets the PF27Value. |
##### Cr2PersonalFuncValuesPackage()
```
public Cr2PersonalFuncValuesPackage()
```

Initializes a new instance of the  Cr2PersonalFuncValuesPackage  class.

##### getPF1Value()
```
public final int getPF1Value()
```

Gets the PF1Value.

**Returns:**
int - The PF1Value.
##### getPF2Value()
```
public final int getPF2Value()
```

Gets the PF2Value.

**Returns:**
int - The PF2Value.
##### getPF3Value()
```
public final int getPF3Value()
```

Gets the PF3Value.

**Returns:**
int - The PF3Value.
##### getPF4ExposureTimeMin()
```
public final int getPF4ExposureTimeMin()
```

Gets the PF4ExposureTimeMin.

**Returns:**
int - The PF4ExposureTimeMin.
##### getPF4ExposureTimeMax()
```
public final int getPF4ExposureTimeMax()
```

Gets the PF4ExposureTimeMax.

**Returns:**
int - The PF4ExposureTimeMax.
##### getPF5ApertureMin()
```
public final int getPF5ApertureMin()
```

Gets the PF5ApertureMin.

**Returns:**
int - The PF5ApertureMin.
##### getPF5ApertureMax()
```
public final int getPF5ApertureMax()
```

Gets the PF5ApertureMax.

**Returns:**
int - The PF5ApertureMax.
##### getPF8BracketShots()
```
public final int getPF8BracketShots()
```

Gets the PF8BracketShots.

**Returns:**
int - The PF8BracketShots.
##### getPF19ShootingSpeedLow()
```
public final int getPF19ShootingSpeedLow()
```

Gets the PF19ShootingSpeedLow.

**Returns:**
int - The PF19ShootingSpeedLow.
##### getPF19ShootingSpeedHigh()
```
public final int getPF19ShootingSpeedHigh()
```

Gets the PF19ShootingSpeedHigh.

**Returns:**
int - The PF19ShootingSpeedHigh.
##### getPF20MaxContinousShots()
```
public final int getPF20MaxContinousShots()
```

Gets the PF20MaxContinousShots.

**Returns:**
int - The PF20MaxContinousShots.
##### getPF23ShutterButtonTime()
```
public final int getPF23ShutterButtonTime()
```

Gets the PF23ShutterButtonTime.

**Returns:**
int - The PF23ShutterButtonTime.
##### getPF23FELockTime()
```
public final int getPF23FELockTime()
```

Gets the PF23FELockTime.

**Returns:**
int - The PF23FELockTime.
##### getPF23PostReleaseTime()
```
public final int getPF23PostReleaseTime()
```

Gets the PF23PostReleaseTime.

**Returns:**
int - The PF23PostReleaseTime.
##### getPF25AEMode()
```
public final int getPF25AEMode()
```

Gets the PF25AEMode.

**Returns:**
int - The PF25AEMode.
##### getPF25MeteringMode()
```
public final int getPF25MeteringMode()
```

Gets the PF25MeteringMode.

**Returns:**
int - The PF25MeteringMode.
##### getPF25DriveMode()
```
public final int getPF25DriveMode()
```

Gets the PF25DriveMode.

**Returns:**
int - The PF25DriveMode.
##### getPF25AFMode()
```
public final int getPF25AFMode()
```

Gets the PF25AFMode.

**Returns:**
int - The PF25AFMode.
##### getPF25AFPointSel()
```
public final int getPF25AFPointSel()
```

Gets the PF25AFPointSel.

**Returns:**
int - The PF25AFPointSel.
##### getPF25ImageSize()
```
public final int getPF25ImageSize()
```

Gets the PF25ImageSize.

**Returns:**
int - The PF25ImageSize.
##### getPF25WBMode()
```
public final int getPF25WBMode()
```

Gets the PF25WBMode.

**Returns:**
int - The PF25WBMode.
##### getPF25Parameters()
```
public final int getPF25Parameters()
```

Gets the PF25Parameters.

**Returns:**
int - The PF25Parameters.
##### getPF25ColorMatrix()
```
public final int getPF25ColorMatrix()
```

Gets the PF25ColorMatrix.

**Returns:**
int - The PF25ColorMatrix.
##### getPF27Value()
```
public final int getPF27Value()
```

Gets the PF27Value.

**Returns:**
int - The PF27Value.

### Cr2ProcessingPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2processingpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ProcessingPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ProcessingPackage() | Initializes a new instance of the  Cr2ProcessingPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getToneCurve() | Gets the ToneCurve. |
| getSharpness() | Gets the Sharpness. |
| getSharpnessFrequency() | Gets the SharpnessFrequency. |
| getSensorRedLevel() | Gets the SensorRedLevel. |
| getSensorBlueLevel() | Gets the SensorBlueLevel. |
| getWhiteBalanceRed() | Gets the WhiteBalanceRed. |
| getWhiteBalanceBlue() | Gets the WhiteBalanceBlue. |
| getWhiteBalance() | Gets the WhiteBalance. |
| getColorTemperature() | Gets the ColorTemperature. |
| getPictureStyle() | Gets the PictureStyle. |
| getDigitalGain() | Gets the DigitalGain. |
| getWBShiftAB() | Gets the WBShiftAB. |
| getWBShiftGM() | Gets the WBShiftGM. |
##### Cr2ProcessingPackage()
```
public Cr2ProcessingPackage()
```

Initializes a new instance of the  Cr2ProcessingPackage  class.

##### getToneCurve()
```
public final int getToneCurve()
```

Gets the ToneCurve.

**Returns:**
int - The ToneCurve.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getSharpnessFrequency()
```
public final int getSharpnessFrequency()
```

Gets the SharpnessFrequency.

**Returns:**
int - The SharpnessFrequency.
##### getSensorRedLevel()
```
public final int getSensorRedLevel()
```

Gets the SensorRedLevel.

**Returns:**
int - The SensorRedLevel.
##### getSensorBlueLevel()
```
public final int getSensorBlueLevel()
```

Gets the SensorBlueLevel.

**Returns:**
int - The SensorBlueLevel.
##### getWhiteBalanceRed()
```
public final int getWhiteBalanceRed()
```

Gets the WhiteBalanceRed.

**Returns:**
int - The WhiteBalanceRed.
##### getWhiteBalanceBlue()
```
public final int getWhiteBalanceBlue()
```

Gets the WhiteBalanceBlue.

**Returns:**
int - The WhiteBalanceBlue.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the WhiteBalance.

**Returns:**
int - The WhiteBalance.
##### getColorTemperature()
```
public final int getColorTemperature()
```

Gets the ColorTemperature.

**Returns:**
int - The ColorTemperature.
##### getPictureStyle()
```
public final int getPictureStyle()
```

Gets the PictureStyle.

**Returns:**
int - The PictureStyle.
##### getDigitalGain()
```
public final int getDigitalGain()
```

Gets the DigitalGain.

**Returns:**
int - The DigitalGain.
##### getWBShiftAB()
```
public final int getWBShiftAB()
```

Gets the WBShiftAB.

**Returns:**
int - The WBShiftAB.
##### getWBShiftGM()
```
public final int getWBShiftGM()
```

Gets the WBShiftGM.

**Returns:**
int - The WBShiftGM.

### Cr2RootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class Cr2RootPackage extends RootMetadataPackage
```

Represents an entry point to all metadata packages presented in a particular file CR2.
#### Methods

| Method | Description |
| --- | --- |
| getCr2Package() | Gets the CR2 header metadata package. |
##### getCr2Package()
```
public final Cr2Package getCr2Package()
```

Gets the CR2 header metadata package.

**Returns:**
Cr2Package - The CR2 header metadata package.

### Cr2SensorInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2sensorinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2SensorInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2SensorInfoPackage() | Initializes a new instance of the  Cr2SensorInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSensorWidth() | Gets the SensorWidth. |
| getSensorHeight() | Gets the SensorHeight. |
| getSensorLeftBorder() | Gets the SensorLeftBorder. |
| getSensorTopBorder() | Gets the SensorTopBorder. |
| getSensorRightBorder() | Gets the SensorRightBorder. |
| getSensorBottomBorder() | Gets the SensorBottomBorder. |
| getBlackMaskLeftBorder() | Gets the BlackMaskLeftBorder. |
| getBlackMaskTopBorder() | Gets the BlackMaskTopBorder. |
| getBlackMaskRightBorder() | Gets the BlackMaskRightBorder. |
| getBlackMaskBottomBorder() | Gets the BlackMaskBottomBorder. |
##### Cr2SensorInfoPackage()
```
public Cr2SensorInfoPackage()
```

Initializes a new instance of the  Cr2SensorInfoPackage  class.

##### getSensorWidth()
```
public final int getSensorWidth()
```

Gets the SensorWidth.

**Returns:**
int - The SensorWidth.
##### getSensorHeight()
```
public final int getSensorHeight()
```

Gets the SensorHeight.

**Returns:**
int - The SensorHeight.
##### getSensorLeftBorder()
```
public final int getSensorLeftBorder()
```

Gets the SensorLeftBorder.

**Returns:**
int - The SensorLeftBorder.
##### getSensorTopBorder()
```
public final int getSensorTopBorder()
```

Gets the SensorTopBorder.

**Returns:**
int - The SensorTopBorder.
##### getSensorRightBorder()
```
public final int getSensorRightBorder()
```

Gets the SensorRightBorder.

**Returns:**
int - The SensorRightBorder.
##### getSensorBottomBorder()
```
public final int getSensorBottomBorder()
```

Gets the SensorBottomBorder.

**Returns:**
int - The SensorBottomBorder.
##### getBlackMaskLeftBorder()
```
public final int getBlackMaskLeftBorder()
```

Gets the BlackMaskLeftBorder.

**Returns:**
int - The BlackMaskLeftBorder.
##### getBlackMaskTopBorder()
```
public final int getBlackMaskTopBorder()
```

Gets the BlackMaskTopBorder.

**Returns:**
int - The BlackMaskTopBorder.
##### getBlackMaskRightBorder()
```
public final int getBlackMaskRightBorder()
```

Gets the BlackMaskRightBorder.

**Returns:**
int - The BlackMaskRightBorder.
##### getBlackMaskBottomBorder()
```
public final int getBlackMaskBottomBorder()
```

Gets the BlackMaskBottomBorder.

**Returns:**
int - The BlackMaskBottomBorder.

### Cr2ShotInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2shotinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2ShotInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2ShotInfoPackage() | Initializes a new instance of the  Cr2ShotInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAutoISO() | Gets the AutoISO. |
| getBaseISO() | Gets the BaseISO. |
| getMeasuredEV() | Gets the MeasuredEV. |
| getTargetAperture() | Gets the TargetAperture. |
| getTargetExposureTime() | Gets the TargetExposureTime. |
| getExposureCompensation() | Gets the ExposureCompensation. |
| getWhiteBalance() | Gets the WhiteBalance. |
| getSlowShutter() | Gets the SlowShutter. |
| getSequenceNumber() | Gets the SequenceNumber. |
| getOpticalZoomCode() | Gets the OpticalZoomCode. |
| getCameraTemperature() | Gets the CameraTemperature. |
| getFlashGuideNumber() | Gets the FlashGuideNumber. |
| getAFPointsInFocus() | Gets the AFPointsInFocus. |
| getFlashExposureComp() | Gets the FlashExposureComp. |
| getAutoExposureBracketing() | Gets the AutoExposureBracketing. |
| getAEBBracketValue() | Gets the AEBBracketValue. |
| getControlMode() | Gets the ControlMode. |
| getFocusDistanceUpper() | Gets the FocusDistanceUpper. |
| getFocusDistanceLower() | Gets the FocusDistanceLower. |
| getFNumber() | Gets the FNumber. |
| getExposureTime() | Gets the ExposureTime. |
| getMeasuredEV2() | Gets the MeasuredEV2. |
| getBulbDuration() | Gets the BulbDuration. |
| getCameraType() | Gets the CameraType. |
| getAutoRotate() | Gets the AutoRotate. |
| getNDFilter() | Gets the NDFilter. |
| getSelfTimer2() | Gets the SelfTimer2. |
| getFlashOutput() | Gets the FlashOutput. |
##### Cr2ShotInfoPackage()
```
public Cr2ShotInfoPackage()
```

Initializes a new instance of the  Cr2ShotInfoPackage  class.

##### getAutoISO()
```
public final int getAutoISO()
```

Gets the AutoISO.

**Returns:**
int - The AutoISO.
##### getBaseISO()
```
public final int getBaseISO()
```

Gets the BaseISO.

**Returns:**
int - The BaseISO.
##### getMeasuredEV()
```
public final int getMeasuredEV()
```

Gets the MeasuredEV.

**Returns:**
int - The MeasuredEV.
##### getTargetAperture()
```
public final int getTargetAperture()
```

Gets the TargetAperture.

**Returns:**
int - The TargetAperture.
##### getTargetExposureTime()
```
public final int getTargetExposureTime()
```

Gets the TargetExposureTime.

**Returns:**
int - The TargetExposureTime.
##### getExposureCompensation()
```
public final int getExposureCompensation()
```

Gets the ExposureCompensation.

**Returns:**
int - The ExposureCompensation.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the WhiteBalance.

**Returns:**
int - The WhiteBalance.
##### getSlowShutter()
```
public final int getSlowShutter()
```

Gets the SlowShutter.

**Returns:**
int - The SlowShutter.
##### getSequenceNumber()
```
public final int getSequenceNumber()
```

Gets the SequenceNumber.

**Returns:**
int - The SequenceNumber.
##### getOpticalZoomCode()
```
public final int getOpticalZoomCode()
```

Gets the OpticalZoomCode.

**Returns:**
int - The OpticalZoomCode.
##### getCameraTemperature()
```
public final int getCameraTemperature()
```

Gets the CameraTemperature.

**Returns:**
int - The CameraTemperature.
##### getFlashGuideNumber()
```
public final int getFlashGuideNumber()
```

Gets the FlashGuideNumber.

**Returns:**
int - The FlashGuideNumber.
##### getAFPointsInFocus()
```
public final int getAFPointsInFocus()
```

Gets the AFPointsInFocus.

**Returns:**
int - The AFPointsInFocus.
##### getFlashExposureComp()
```
public final int getFlashExposureComp()
```

Gets the FlashExposureComp.

**Returns:**
int - The FlashExposureComp.
##### getAutoExposureBracketing()
```
public final int getAutoExposureBracketing()
```

Gets the AutoExposureBracketing.

**Returns:**
int - The AutoExposureBracketing.
##### getAEBBracketValue()
```
public final int getAEBBracketValue()
```

Gets the AEBBracketValue.

**Returns:**
int - The AEBBracketValue.
##### getControlMode()
```
public final int getControlMode()
```

Gets the ControlMode.

**Returns:**
int - The ControlMode.
##### getFocusDistanceUpper()
```
public final int getFocusDistanceUpper()
```

Gets the FocusDistanceUpper.

**Returns:**
int - The FocusDistanceUpper.
##### getFocusDistanceLower()
```
public final int getFocusDistanceLower()
```

Gets the FocusDistanceLower.

**Returns:**
int - The FocusDistanceLower.
##### getFNumber()
```
public final int getFNumber()
```

Gets the FNumber.

**Returns:**
int - The FNumber.
##### getExposureTime()
```
public final int getExposureTime()
```

Gets the ExposureTime.

**Returns:**
int - The ExposureTime.
##### getMeasuredEV2()
```
public final int getMeasuredEV2()
```

Gets the MeasuredEV2.

**Returns:**
int - The MeasuredEV2.
##### getBulbDuration()
```
public final int getBulbDuration()
```

Gets the BulbDuration.

**Returns:**
int - The BulbDuration.
##### getCameraType()
```
public final int getCameraType()
```

Gets the CameraType.

**Returns:**
int - The CameraType.
##### getAutoRotate()
```
public final int getAutoRotate()
```

Gets the AutoRotate.

**Returns:**
int - The AutoRotate.
##### getNDFilter()
```
public final int getNDFilter()
```

Gets the NDFilter.

**Returns:**
int - The NDFilter.
##### getSelfTimer2()
```
public final int getSelfTimer2()
```

Gets the SelfTimer2.

**Returns:**
int - The SelfTimer2.
##### getFlashOutput()
```
public final int getFlashOutput()
```

Gets the FlashOutput.

**Returns:**
int - The FlashOutput.

### Cr2TimeInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2timeinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2TimeInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2TimeInfoPackage() | Initializes a new instance of the  Cr2TimeInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTimeZone() | Gets the TimeZone. |
| getTimeZoneCity() | Gets the TimeZoneCity. |
| getDaylightSavings() | Gets the DaylightSavings. |
##### Cr2TimeInfoPackage()
```
public Cr2TimeInfoPackage()
```

Initializes a new instance of the  Cr2TimeInfoPackage  class.

##### getTimeZone()
```
public final int getTimeZone()
```

Gets the TimeZone.

**Returns:**
int - The TimeZone.
##### getTimeZoneCity()
```
public final int getTimeZoneCity()
```

Gets the TimeZoneCity.

**Returns:**
int - The TimeZoneCity.
##### getDaylightSavings()
```
public final int getDaylightSavings()
```

Gets the DaylightSavings.

**Returns:**
int - The DaylightSavings.

### Cr2VignettingCorr2Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2vignettingcorr2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2VignettingCorr2Package extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2VignettingCorr2Package() | Initializes a new instance of the  Cr2VignettingCorr2Package  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPeripheralLightingSetting() | Gets the PeripheralLightingSetting. |
| getChromaticAberrationSetting() | Gets the ChromaticAberrationSetting. |
| getDistortionCorrectionSetting() | Gets the DistortionCorrectionSetting. |
| getDigitalLensOptimizerSetting() | Gets the DigitalLensOptimizerSetting. |
##### Cr2VignettingCorr2Package()
```
public Cr2VignettingCorr2Package()
```

Initializes a new instance of the  Cr2VignettingCorr2Package  class.

##### getPeripheralLightingSetting()
```
public final int getPeripheralLightingSetting()
```

Gets the PeripheralLightingSetting.

**Returns:**
int - The PeripheralLightingSetting.
##### getChromaticAberrationSetting()
```
public final int getChromaticAberrationSetting()
```

Gets the ChromaticAberrationSetting.

**Returns:**
int - The ChromaticAberrationSetting.
##### getDistortionCorrectionSetting()
```
public final int getDistortionCorrectionSetting()
```

Gets the DistortionCorrectionSetting.

**Returns:**
int - The DistortionCorrectionSetting.
##### getDigitalLensOptimizerSetting()
```
public final int getDigitalLensOptimizerSetting()
```

Gets the DigitalLensOptimizerSetting.

**Returns:**
int - The DigitalLensOptimizerSetting.

### Cr2WBInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/cr2wbinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class Cr2WBInfoPackage extends RawDictionaryBasePackage
```

Represents Canon MakerNotes tags.
#### Constructors

| Constructor | Description |
| --- | --- |
| Cr2WBInfoPackage() | Initializes a new instance of the  Cr2WBInfoPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWB_GRBGLevelsAuto() | Gets the WB\_GRBGLevelsAuto. |
| getWB_GRBGLevelsDaylight() | Gets the WB\_GRBGLevelsDaylight. |
| getWB_GRBGLevelsCloudy() | Gets the WB\_GRBGLevelsCloudy. |
| getWB_GRBGLevelsTungsten() | Gets the WB\_GRBGLevelsTungsten. |
| getWB_GRBGLevelsFluorescent() | Gets the WB\_GRBGLevelsFluorescent. |
| getWB_GRBGLevelsFluorHigh() | Gets the WB\_GRBGLevelsFluorHigh. |
| getWB_GRBGLevelsFlash() | Gets the WB\_GRBGLevelsFlash. |
| getWB_GRBGLevelsUnderwater() | Gets the WB\_GRBGLevelsUnderwater. |
| getWB_GRBGLevelsCustom1() | Gets the WB\_GRBGLevelsCustom1. |
| getWB_GRBGLevelsCustom2() | Gets the WB\_GRBGLevelsCustom2. |
##### Cr2WBInfoPackage()
```
public Cr2WBInfoPackage()
```

Initializes a new instance of the  Cr2WBInfoPackage  class.

##### getWB_GRBGLevelsAuto()
```
public final int[] getWB_GRBGLevelsAuto()
```

Gets the WB\_GRBGLevelsAuto.

**Returns:**
int[] - The WB\_GRBGLevelsAuto.
##### getWB_GRBGLevelsDaylight()
```
public final int[] getWB_GRBGLevelsDaylight()
```

Gets the WB\_GRBGLevelsDaylight.

**Returns:**
int[] - The WB\_GRBGLevelsDaylight.
##### getWB_GRBGLevelsCloudy()
```
public final int[] getWB_GRBGLevelsCloudy()
```

Gets the WB\_GRBGLevelsCloudy.

**Returns:**
int[] - The WB\_GRBGLevelsCloudy.
##### getWB_GRBGLevelsTungsten()
```
public final int[] getWB_GRBGLevelsTungsten()
```

Gets the WB\_GRBGLevelsTungsten.

**Returns:**
int[] - The WB\_GRBGLevelsTungsten.
##### getWB_GRBGLevelsFluorescent()
```
public final int[] getWB_GRBGLevelsFluorescent()
```

Gets the WB\_GRBGLevelsFluorescent.

**Returns:**
int[] - The WB\_GRBGLevelsFluorescent.
##### getWB_GRBGLevelsFluorHigh()
```
public final int[] getWB_GRBGLevelsFluorHigh()
```

Gets the WB\_GRBGLevelsFluorHigh.

**Returns:**
int[] - The WB\_GRBGLevelsFluorHigh.
##### getWB_GRBGLevelsFlash()
```
public final int[] getWB_GRBGLevelsFlash()
```

Gets the WB\_GRBGLevelsFlash.

**Returns:**
int[] - The WB\_GRBGLevelsFlash.
##### getWB_GRBGLevelsUnderwater()
```
public final int[] getWB_GRBGLevelsUnderwater()
```

Gets the WB\_GRBGLevelsUnderwater.

**Returns:**
int[] - The WB\_GRBGLevelsUnderwater.
##### getWB_GRBGLevelsCustom1()
```
public final int[] getWB_GRBGLevelsCustom1()
```

Gets the WB\_GRBGLevelsCustom1.

**Returns:**
int[] - The WB\_GRBGLevelsCustom1.
##### getWB_GRBGLevelsCustom2()
```
public final int[] getWB_GRBGLevelsCustom2()
```

Gets the WB\_GRBGLevelsCustom2.

**Returns:**
int[] - The WB\_GRBGLevelsCustom2.

### CustomPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/custompackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage
```
public abstract class CustomPackage extends MetadataPackage
```

Provides a container for metadata properties.

### DiagramFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/diagramformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum DiagramFormat extends Enum<DiagramFormat> implements IEnumValue
```

Defines various diagram subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Vdx | Represents the .VDX Visio format. |
| Vsd | Represents the .VSD Visio format. |
| Vsdx | Represents the .VSDX Visio format. |
| Vss | Represents the .VSS Visio format. |
| Vsx | Represents the .VSX Visio format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final DiagramFormat Unknown
```

The format is not recognized.

##### Vdx
```
public static final DiagramFormat Vdx
```

Represents the .VDX Visio format. 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/

##### Vsd
```
public static final DiagramFormat Vsd
```

Represents the .VSD Visio format. VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Such drawings can contain visual objects such as visual objects, flow charts, UML diagram, information flow, organizational charts, software diagrams, network layout, database models, objects mapping and other similar information. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/vsd/

##### Vsdx
```
public static final DiagramFormat Vsdx
```

Represents the .VSDX Visio format. 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 DiagramFormat Vss
```

Represents the .VSS Visio format. VSS are stencil files created with Microsoft Visio 2007 and earlier. A relatively new file format is .VSSX that was introduced with Microsoft Visio 2013. 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/

##### Vsx
```
public static final DiagramFormat Vsx
```

Represents the .VSX Visio format. 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/

##### values()
```
public static DiagramFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.DiagramFormat[]
##### valueOf(String name)
```
public static DiagramFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DiagramFormat
##### getByRawValue(int rawValue)
```
public static DiagramFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
DiagramFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### DiagramPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/diagrampackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class DiagramPackage extends DocumentPackage
```

Represents a native metadata package in a diagram format.

The following code sample demonstrates how to update built-in metadata properties in a diagram document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputVdx)) {
>      DiagramRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setCreator("test author");
>      root.getDocumentProperties().setTimeCreated(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputVdx);
>  }
>
> ```
> ```

[Working with metadata in Diagrams]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Diagrams
#### Methods

| Method | Description |
| --- | --- |
| getAlternateNames() | Gets the alternate names for the document. |
| setAlternateNames(String value) | Sets the alternate names for the document. |
| getBuildNumberCreated() | Gets the full build number of the instance used to create the document. |
| getBuildNumberEdited() | Gets the build number of the instance last used to edit the document. |
| getCategory() | Gets the descriptive text for the type of drawing, such as flowchart or office layout. |
| setCategory(String value) | Sets the descriptive text for the type of drawing, such as flowchart or office layout. |
| getCompany() | Gets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. |
| setCompany(String value) | Sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. |
| getCreator() | Gets the person who created or last updated the file. |
| setCreator(String value) | Sets the person who created or last updated the file. |
| getDescription() | Gets a descriptive text string for the document. |
| setDescription(String value) | Sets a descriptive text string for the document. |
| getHyperlinkBase() | Gets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). |
| setHyperlinkBase(String value) | Sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). |
| getKeywords() | Gets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. |
| setKeywords(String value) | Sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. |
| getLanguage() | Gets the language of the document. |
| setLanguage(String value) | Sets the language of the document. |
| getManager() | Gets a user-entered text string identifying the person in charge of the project or department. |
| setManager(String value) | Sets a user-entered text string identifying the person in charge of the project or department. |
| getPreviewPicture() | Gets the preview picture. |
| setPreviewPicture(byte[] value) | Sets the preview picture. |
| getSubject() | Gets a user-defined text string that describes the contents of the document. |
| setSubject(String value) | Sets a user-defined text string that describes the contents of the document. |
| getTemplate() | Gets a string value specifying the file name of the template from which the document was created. |
| setTemplate(String value) | Sets a string value specifying the file name of the template from which the document was created. |
| getTimeCreated() | Gets a date and time value indicating when the document was created. |
| setTimeCreated(Date value) | Sets a date and time value indicating when the document was created. |
| getTimeEdited() | Gets a date and time value indicating when the document was last edited. |
| getTimePrinted() | Gets a date and time value indicating when the document was last printed. |
| getTimeSaved() | Gets a date and time value indicating when the document was last saved. |
| getTitle() | Gets a user-defined text string that serves as a descriptive title for the document. |
| setTitle(String value) | Sets a user-defined text string that serves as a descriptive title for the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
##### getAlternateNames()
```
public final String getAlternateNames()
```

Gets the alternate names for the document. Can be updated in VDX and VSX formats only.

**Returns:**
java.lang.String - The alternate names for the document.
##### setAlternateNames(String value)
```
public final void setAlternateNames(String value)
```

Sets the alternate names for the document. Can be updated in VDX and VSX formats only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The alternate names for the document. |

##### getBuildNumberCreated()
```
public final String getBuildNumberCreated()
```

Gets the full build number of the instance used to create the document.

**Returns:**
java.lang.String - The full build number of the instance used to create the document.
##### getBuildNumberEdited()
```
public final String getBuildNumberEdited()
```

Gets the build number of the instance last used to edit the document.

**Returns:**
java.lang.String - The build number of the instance last used to edit the document.
##### getCategory()
```
public final String getCategory()
```

Gets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.

**Returns:**
java.lang.String - The descriptive text for the type of drawing, such as flowchart or office layout.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive text for the type of drawing, such as flowchart or office layout. |

##### getCompany()
```
public final String getCompany()
```

Gets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

**Returns:**
java.lang.String - The user-entered information identifying the company creating the drawing or the company the drawing is being created for.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user-entered information identifying the company creating the drawing or the company the drawing is being created for. |

##### getCreator()
```
public final String getCreator()
```

Gets the person who created or last updated the file. The maximum length is 63 characters..

**Returns:**
java.lang.String - The person who created or last updated the file.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Sets the person who created or last updated the file. The maximum length is 63 characters..

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The person who created or last updated the file. |

##### getDescription()
```
public final String getDescription()
```

Gets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.

**Returns:**
java.lang.String - A descriptive text string for the document.
##### setDescription(String value)
```
public final void setDescription(String value)
```

Sets a descriptive text string for the document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A descriptive text string for the document. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.

**Returns:**
java.lang.String - The path to be used for relative hyperlinks.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The path to be used for relative hyperlinks. |

##### getKeywords()
```
public final String getKeywords()
```

Gets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.

**Returns:**
java.lang.String - A text string that identifies topics or other important information about the file, such as project name, client name, or version number.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A text string that identifies topics or other important information about the file, such as project name, client name, or version number. |

##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the document. Can be updated in VSD and VSDX formats only.

**Returns:**
java.lang.String - The language of the document.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the language of the document. Can be updated in VSD and VSDX formats only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language of the document. |

##### getManager()
```
public final String getManager()
```

Gets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

**Returns:**
java.lang.String - A user-entered text string identifying the person in charge of the project or department.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-entered text string identifying the person in charge of the project or department. |

##### getPreviewPicture()
```
public final byte[] getPreviewPicture()
```

Gets the preview picture.

**Returns:**
byte[] - The preview picture.
##### setPreviewPicture(byte[] value)
```
public final void setPreviewPicture(byte[] value)
```

Sets the preview picture.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The preview picture. |

##### getSubject()
```
public final String getSubject()
```

Gets a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

**Returns:**
java.lang.String - A user-defined text string that describes the contents of the document.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-defined text string that describes the contents of the document. |

##### getTemplate()
```
public final String getTemplate()
```

Gets a string value specifying the file name of the template from which the document was created.

**Returns:**
java.lang.String - A string value specifying the file name of the template from which the document was created.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets a string value specifying the file name of the template from which the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A string value specifying the file name of the template from which the document was created. |

##### getTimeCreated()
```
public final Date getTimeCreated()
```

Gets a date and time value indicating when the document was created.

**Returns:**
java.util.Date - A date and time value indicating when the document was created.
##### setTimeCreated(Date value)
```
public final void setTimeCreated(Date value)
```

Sets a date and time value indicating when the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | A date and time value indicating when the document was created. |

##### getTimeEdited()
```
public final Date getTimeEdited()
```

Gets a date and time value indicating when the document was last edited.

**Returns:**
java.util.Date - A date and time value indicating when the document was last edited.
##### getTimePrinted()
```
public final Date getTimePrinted()
```

Gets a date and time value indicating when the document was last printed.

**Returns:**
java.util.Date - A date and time value indicating when the document was last printed.
##### getTimeSaved()
```
public final Date getTimeSaved()
```

Gets a date and time value indicating when the document was last saved.

**Returns:**
java.util.Date - A date and time value indicating when the document was last saved.
##### getTitle()
```
public final String getTitle()
```

Gets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

**Returns:**
java.lang.String - A user-defined text string that serves as a descriptive title for the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A user-defined text string that serves as a descriptive title for the document. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

### DiagramRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/diagramrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class DiagramRootPackage extends DocumentRootPackage<DiagramPackage>
```

Represents the root package intended to work with metadata in a diagram.

This code sample demonstrates how to extract built-in metadata properties from a diagram.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      DiagramRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getCreator());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLanguage());
>      System.out.println(root.getDocumentProperties().getTimeCreated());
>      System.out.println(root.getDocumentProperties().getCategory());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Diagrams]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Diagrams
#### Methods

| Method | Description |
| --- | --- |
| getDiagramType() | Gets the file type metadata package. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getDiagramType()
```
public final DiagramTypePackage getDiagramType()
```

Gets the file type metadata package.

**Returns:**
DiagramTypePackage - The file type metadata package.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### DiagramTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/diagramtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class DiagramTypePackage extends FileTypePackage
```

Represents a metadata package containing diagram-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getDiagramFormat() | Gets the exact diagram format. |
##### getDiagramFormat()
```
public final DiagramFormat getDiagramFormat()
```

Gets the exact diagram format.

**Returns:**
DiagramFormat - The exact diagram format.

### DicomPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dicompackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DicomPackage extends CustomPackage
```

Represents native DICOM metadata.

[Working with DICOM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DICOM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DicomPackage() | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getHeaderOffset() | Gets the header offset. |
| getHeaderBytes() | Gets the header information by bytes. |
| getBitsAllocated() | Gets the bits allocated value. |
| getDicomInfo() | Gets the header information of the DICOM file. |
| getBlues() | Gets the array colors of the blue. |
| getGreens() | Gets the array colors of the green. |
| getReds() | Gets the array colors of the red. |
| getNumberOfFrames() | Gets the number of frames. |
##### DicomPackage()
```
public DicomPackage()
```

Initializes a new instance of the  Metadata  class.

##### getHeaderOffset()
```
public final int getHeaderOffset()
```

Gets the header offset.

Value: The header offset.

**Returns:**
int
##### getHeaderBytes()
```
public final Byte[] getHeaderBytes()
```

Gets the header information by bytes.

Value: The header bytes.

**Returns:**
java.lang.Byte[]
##### getBitsAllocated()
```
public final int getBitsAllocated()
```

Gets the bits allocated value.

**Returns:**
int - The bits allocated.
##### getDicomInfo()
```
public final String[] getDicomInfo()
```

Gets the header information of the DICOM file.

**Returns:**
java.lang.String[] - The dicom header information.
##### getBlues()
```
public final byte[] getBlues()
```

Gets the array colors of the blue.

**Returns:**
byte[] - The blue colors.
##### getGreens()
```
public final byte[] getGreens()
```

Gets the array colors of the green.

**Returns:**
byte[] - The green colors.
##### getReds()
```
public final byte[] getReds()
```

Gets the array colors of the red.

**Returns:**
byte[] - The red colors.
##### getNumberOfFrames()
```
public final int getNumberOfFrames()
```

Gets the number of frames.

**Returns:**
int - The number of frames.

### DicomRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dicomrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DicomRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a DICOM image.

This example demonstrates how to read DICOM format-specific metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDicom)) {
>      DicomRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getDicomPackage() != null) {
>          System.out.println(root.getDicomPackage().getBitsAllocated());
>          System.out.println(root.getDicomPackage().getReds());
>          System.out.println(root.getDicomPackage().getGreens());
>          System.out.println(root.getDicomPackage().getBlues());
>          System.out.println(root.getDicomPackage().getNumberOfFrames());
>          // ...
>      }
>  }
>
> ```
> ```

[Working with DICOM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DICOM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getDicomPackage() | Gets the DICOM native metadata package. |
##### getDicomPackage()
```
public final DicomPackage getDicomPackage()
```

Gets the DICOM native metadata package.

**Returns:**
DicomPackage - The DICOM native metadata package.

### DigitalSignature
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/digitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class DigitalSignature extends CustomPackage
```

Represents a digital signature used to sign a document.
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the signing purpose comment. |
| isValid() | Gets a value indicating whether the signature is valid. |
| getSignTime() | Gets the time the document was signed. |
| getCertificateSubject() | Gets the subject distinguished name from a certificate. |
| getCertificateRawData() | Gets the certificate raw data. |
##### getComments()
```
public final String getComments()
```

Gets the signing purpose comment.

**Returns:**
java.lang.String - The signing purpose comment.
##### isValid()
```
public Boolean isValid()
```

Gets a value indicating whether the signature is valid.

**Returns:**
java.lang.Boolean - True if the the signature is valid; otherwise, false. Null indicates that validation is unavailable for the signature.
##### getSignTime()
```
public Date getSignTime()
```

Gets the time the document was signed.

**Returns:**
java.util.Date - The time the document was signed.
##### getCertificateSubject()
```
public final String getCertificateSubject()
```

Gets the subject distinguished name from a certificate.

**Returns:**
java.lang.String - The subject distinguished name from a certificate.
##### getCertificateRawData()
```
public final byte[] getCertificateRawData()
```

Gets the certificate raw data.

**Returns:**
byte[] - The certificate raw data.

### DisposableWrapper
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/disposablewrapper.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IDisposable
```
public abstract class DisposableWrapper<T> implements System.IDisposable
```
#### Methods

| Method | Description |
| --- | --- |
| dispose() |  |
##### dispose()
```
public void dispose()
```

### DjVuRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/djvurootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DjVuRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in an DjVu image.

### DngPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dngpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DngPackage extends CustomPackage
```

Represents native DNG metadata.

[Working with DNG metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+DNG+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| DngPackage() | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCameraManufacturer() | Gets the camera manufacturer. |
| getColorsCount() | Gets the colors. |
| getDescription() | Gets the description of colors (RGBG,RGBE,GMCY, or GBTG). |
| getDngVersion() | Gets the DNG version. |
| getFilters() | Gets the Bit mask describing the order of color pixels in the matrix. |
| isFoveon() | Gets the is foveon matrix. |
| getModel() | Gets the camera model. |
| getRawCount() | Gets the number of RAW images in file (0 means that the file has not been recognized). |
| getSoftware() | Gets the software. |
| getTranslationCfaDng() | Gets the translation array for CFA mosaic DNG format. |
| getAperture() | Gets the aperture. |
| getArtist() | Gets the author of image. |
| getFocalLength() | Gets the length of the focal. |
| getGpsData() | Gets the GPS data. |
| getIsoSpeed() | Gets the ISO sensitivity. |
| getShotOrder() | Gets serial number of image. |
| getShutterSpeed() | Gets the shutter speed. |
| getTimestamp() | Gets the date of shooting. |
##### DngPackage()
```
public DngPackage()
```

Initializes a new instance of the  Metadata  class.

##### getCameraManufacturer()
```
public final String getCameraManufacturer()
```

Gets the camera manufacturer.

**Returns:**
java.lang.String - The make.
##### getColorsCount()
```
public final int getColorsCount()
```

Gets the colors.

**Returns:**
int - The colors.
##### getDescription()
```
public final String getDescription()
```

Gets the description of colors (RGBG,RGBE,GMCY, or GBTG).

**Returns:**
java.lang.String - The cdesc.
##### getDngVersion()
```
public final long getDngVersion()
```

Gets the DNG version.

**Returns:**
long - The DNG version.
##### getFilters()
```
public final long getFilters()
```

Gets the Bit mask describing the order of color pixels in the matrix.

**Returns:**
long - The filters.
##### isFoveon()
```
public final long isFoveon()
```

Gets the is foveon matrix.

**Returns:**
long - The is foveon.
##### getModel()
```
public final String getModel()
```

Gets the camera model.

**Returns:**
java.lang.String - The model.
##### getRawCount()
```
public final long getRawCount()
```

Gets the number of RAW images in file (0 means that the file has not been recognized).

**Returns:**
long - The raw count.
##### getSoftware()
```
public final String getSoftware()
```

Gets the software.

**Returns:**
java.lang.String - The software.
##### getTranslationCfaDng()
```
public final String[] getTranslationCfaDng()
```

Gets the translation array for CFA mosaic DNG format.

**Returns:**
java.lang.String[] - The xtrans.
##### getAperture()
```
public final float getAperture()
```

Gets the aperture.

**Returns:**
float - The aperture.
##### getArtist()
```
public final String getArtist()
```

Gets the author of image.

**Returns:**
java.lang.String - The artist.
##### getFocalLength()
```
public final float getFocalLength()
```

Gets the length of the focal.

**Returns:**
float - The length of the focal.
##### getGpsData()
```
public final long[] getGpsData()
```

Gets the GPS data.

**Returns:**
long[] - The GPS data.
##### getIsoSpeed()
```
public final float getIsoSpeed()
```

Gets the ISO sensitivity.

**Returns:**
float - The ISO speed.
##### getShotOrder()
```
public final long getShotOrder()
```

Gets serial number of image.

**Returns:**
long - The shot order.
##### getShutterSpeed()
```
public final float getShutterSpeed()
```

Gets the shutter speed.

**Returns:**
float - The shutter.
##### getTimestamp()
```
public final long getTimestamp()
```

Gets the date of shooting.

**Returns:**
long - The timestamp.

### DngRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dngrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class DngRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a DNG image.

[Working with metadata in DNG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+DNG+images
#### Methods

| Method | Description |
| --- | --- |
| getDngPackage() | Gets the DNG header metadata package. |
##### getDngPackage()
```
public final DngPackage getDngPackage()
```

Gets the DNG header metadata package.

**Returns:**
DngPackage - The DNG header metadata package.

### DocumentInfo
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Provides common information about a loaded document.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the file type of the loaded document. |
| getSize() | Gets the size of the loaded document in bytes. |
| getPageCount() | Gets the number of pages (slides, worksheets, etc) in the loaded document. |
| getPages() | Gets a collection of objects representing common information about the document pages (slides, worksheets, etc). |
| isEncrypted() | Gets a value indicating whether the document is encrypted and requires a password to open. |
##### getFileType()
```
public final FileTypePackage getFileType()
```

Gets the file type of the loaded document.

**Returns:**
FileTypePackage - The file type of the loaded document.
##### getSize()
```
public final long getSize()
```

Gets the size of the loaded document in bytes.

**Returns:**
long - The size of the loaded document in bytes.
##### getPageCount()
```
public final int getPageCount()
```

Gets the number of pages (slides, worksheets, etc) in the loaded document.

**Returns:**
int - The number of pages (slides, worksheets, etc) in the loaded document.
##### getPages()
```
public final IReadOnlyList<PageInfo> getPages()
```

Gets a collection of objects representing common information about the document pages (slides, worksheets, etc).

**Returns:**
IReadOnlyList - A collection of objects representing common information about the document pages (slides, worksheets, etc).
##### isEncrypted()
```
public final boolean isEncrypted()
```

Gets a value indicating whether the document is encrypted and requires a password to open.

**Returns:**
boolean - A value indicating whether the document is encrypted and requires a password to open.

### DocumentPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/documentpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class DocumentPackage extends CustomPackage
```

Represents native metadata in an office document.
#### Methods

| Method | Description |
| --- | --- |
| remove(String propertyName) | Removes a writable metadata property by the specified name. |
| clear() | Removes all writable metadata properties from the package. |
| clearBuiltInProperties() | Removes all built-in metadata properties. |
| clearCustomProperties() | Removes all custom metadata properties. |
##### remove(String propertyName)
```
public final boolean remove(String propertyName)
```

Removes a writable metadata property by the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | A metadata property name. |

**Returns:**
boolean -  true  if the property is found and deleted; otherwise  false .
##### clear()
```
public final void clear()
```

Removes all writable metadata properties from the package.

##### clearBuiltInProperties()
```
public final void clearBuiltInProperties()
```

Removes all built-in metadata properties.

##### clearCustomProperties()
```
public final void clearCustomProperties()
```

Removes all custom metadata properties.

### DocumentProtectedException
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/documentprotectedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class DocumentProtectedException extends GroupDocsMetadataException
```

The exception that is thrown when document is protected by password.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentProtectedException() | Initializes a new instance of the  DocumentProtectedException  class. |
##### DocumentProtectedException()
```
public DocumentProtectedException()
```

Initializes a new instance of the  DocumentProtectedException  class.

### DocumentRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/documentrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class DocumentRootPackage<TPackage> extends RootMetadataPackage
```

Represents a root package for document formats such as PDF, WordProcessing, Spreadsheet, Presentation, etc.

 TPackage : The type of the native metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getDocumentProperties() | Gets the native metadata properties presented in the document. |
##### getDocumentProperties()
```
public TPackage getDocumentProperties()
```

Gets the native metadata properties presented in the document.

**Returns:**
TPackage - The document properties.

### DocumentStatistics
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/documentstatistics.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class DocumentStatistics extends CustomPackage
```

Represents a set of document statistics.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentStatistics() | Initializes a new instance of the  DocumentStatistics  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCharacterCount() | Gets an estimated number of characters in the document. |
| getWordCount() | Gets an estimated number of words in the document. |
| getPageCount() | Gets an estimated number of pages in the document. |
##### DocumentStatistics()
```
public DocumentStatistics()
```

Initializes a new instance of the  DocumentStatistics  class.

##### getCharacterCount()
```
public final int getCharacterCount()
```

Gets an estimated number of characters in the document.

**Returns:**
int - An estimated number of characters in the document.
##### getWordCount()
```
public final int getWordCount()
```

Gets an estimated number of words in the document.

**Returns:**
int - An estimated number of words in the document.
##### getPageCount()
```
public final int getPageCount()
```

Gets an estimated number of pages in the document.

**Returns:**
int - An estimated number of pages in the document.

### DublinCorePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dublincorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class DublinCorePackage extends CustomPackage
```

Represents a Dublin Core metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getContributor() | Gets the contributor Dublin Core element. |
| getCoverage() | Gets the coverage Dublin Core element. |
| getCreator() | Gets the creator Dublin Core element. |
| getDate() | Gets the date Dublin Core element. |
| getDescription() | Gets the description Dublin Core element. |
| getFormat() | Gets the format Dublin Core element. |
| getLanguage() | Gets the language Dublin Core element. |
| getPublisher() | Gets the publisher Dublin Core element. |
| getRelation() | Gets the relation Dublin Core element. |
| getSource() | Gets the source Dublin Core element. |
| getSubject() | Gets the subject Dublin Core element. |
| getTitle() | Gets the title Dublin Core element. |
| getType() | Gets the type Dublin Core element. |
| getRights() | Gets the rights Dublin Core element. |
| getIdentifier() | Gets the identifier Dublin Core element. |
##### getContributor()
```
public final String getContributor()
```

Gets the contributor Dublin Core element.

**Returns:**
java.lang.String - An entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization or a service.
##### getCoverage()
```
public final String getCoverage()
```

Gets the coverage Dublin Core element.

**Returns:**
java.lang.String - The extent or scope of the content of the resource. Coverage will typically include spatial location (a place name or geographic co-ordinates), temporal period (a period label, date, or date range) or jurisdiction (such as a named administrative entity).
##### getCreator()
```
public final String getCreator()
```

Gets the creator Dublin Core element.

**Returns:**
java.lang.String - An entity primarily responsible for making the content of the resource. Examples of a Creator include a person, an organization, or a service.
##### getDate()
```
public final String getDate()
```

Gets the date Dublin Core element.

**Returns:**
java.lang.String - A date associated with an event in the life cycle of the resource. Typically, Date will be associated with the creation or availability of the resource. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.
##### getDescription()
```
public final String getDescription()
```

Gets the description Dublin Core element.

**Returns:**
java.lang.String - An account of the content of the resource. Description may include but is not limited to: an abstract, table of contents, reference to a graphical representation of content or a free-text account of the content.
##### getFormat()
```
public final String getFormat()
```

Gets the format Dublin Core element.

**Returns:**
java.lang.String - The physical or digital manifestation of the resource. Typically, Format may include the media-type or dimensions of the resource. Examples of dimensions include size and duration. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language Dublin Core element.

**Returns:**
java.lang.String - A language of the intellectual content of the resource. Recommended best practice for the values of the Language element is defined by RFC 3066 which, in conjunction with ISO 639), defines two- and three-letter primary language tags with optional subtags.
##### getPublisher()
```
public final String getPublisher()
```

Gets the publisher Dublin Core element.

**Returns:**
java.lang.String - The entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.
##### getRelation()
```
public final String getRelation()
```

Gets the relation Dublin Core element.

**Returns:**
java.lang.String - A reference to a related resource. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.
##### getSource()
```
public final String getSource()
```

Gets the source Dublin Core element.

**Returns:**
java.lang.String - A Reference to a resource from which the present resource is derived. The present resource may be derived from the Source resource in whole or part. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system.
##### getSubject()
```
public final String getSubject()
```

Gets the subject Dublin Core element.

**Returns:**
java.lang.String - The topic of the content of the resource. Typically, a Subject will be expressed as keywords or key phrases or classification codes that describe the topic of the resource. Recommended best practice is to select a value from a controlled vocabulary or formal classification scheme.
##### getTitle()
```
public final String getTitle()
```

Gets the title Dublin Core element.

**Returns:**
java.lang.String - The name given to the resource. Typically, a Title will be a name by which the resource is formally known.
##### getType()
```
public final String getType()
```

Gets the type Dublin Core element.

**Returns:**
java.lang.String - The nature or genre of the content of the resource. Type includes terms describing general categories, functions, genres, or aggregation levels for content. Recommended best practice is to select a value from a controlled vocabulary (for example, the DCMIType vocabulary).
##### getRights()
```
public final String getRights()
```

Gets the rights Dublin Core element.

**Returns:**
java.lang.String - Information about rights held in and over the resource. Typically a Rights element will contain a rights management statement for the resource, or reference a service providing such information. Rights information often encompasses Intellectual Property Rights (IPR), Copyright, and various Property Rights. If the rights element is absent, no assumptions can be made about the status of these and other rights with respect to the resource.
##### getIdentifier()
```
public final String getIdentifier()
```

Gets the identifier Dublin Core element.

**Returns:**
java.lang.String - An unambiguous reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.

### DwgRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dwgrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.CadRootPackage
```
public class DwgRootPackage extends CadRootPackage
```

Represents the root package allowing working with metadata in a DWG drawing.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata

### DxfRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/dxfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.CadRootPackage
```
public class DxfRootPackage extends CadRootPackage
```

Represents the root package allowing working with metadata in a DXF drawing.

[Working with CAD metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+CAD+metadata

### EmailHeaderPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emailheaderpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class EmailHeaderPackage extends CustomPackage
```

Represents a metadata package containing email message headers.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| get(String header) | Gets the value of the specified header. |
##### get(String header)
```
public final String get(String header)
```

Gets the value of the specified header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| header | java.lang.String | An email header. |

**Returns:**
java.lang.String - The value if the package contains the specified header; otherwise, null.

### EmailPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emailpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class EmailPackage extends CustomPackage
```

Represents email message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getAttachedFileNames() | Gets an array of the names of the attached files. |
| getSubject() | Gets the email subject. |
| setSubject(String value) | Sets the email subject. |
| getRecipients() | Gets the array of the email recipients. |
| setRecipients(String[] value) | Sets the array of the email recipients. |
| getCarbonCopyRecipients() | Gets the array of CC (carbon copy) recipients of the email message. |
| setCarbonCopyRecipients(String[] value) | Sets the array of CC (carbon copy) recipients of the email message. |
| getBlindCarbonCopyRecipients() | Gets the array of BCC (blind carbon copy) recipients of the email message. |
| setBlindCarbonCopyRecipients(String[] value) | Sets the array of BCC (blind carbon copy) recipients of the email message. |
| getSender() | Gets the email address of the sender. |
| getHeaders() | Gets a metadata package containing the email headers. |
##### getAttachedFileNames()
```
public final String[] getAttachedFileNames()
```

Gets an array of the names of the attached files.

**Returns:**
java.lang.String[] - An array of the names of the attached files.
##### getSubject()
```
public final String getSubject()
```

Gets the email subject.

**Returns:**
java.lang.String - The email subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the email subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The email subject. |

##### getRecipients()
```
public final String[] getRecipients()
```

Gets the array of the email recipients.

**Returns:**
java.lang.String[] - The array of the email recipients.
##### setRecipients(String[] value)
```
public final void setRecipients(String[] value)
```

Sets the array of the email recipients.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of the email recipients. |

##### getCarbonCopyRecipients()
```
public final String[] getCarbonCopyRecipients()
```

Gets the array of CC (carbon copy) recipients of the email message.

**Returns:**
java.lang.String[] - The array of CC (carbon copy) recipients of the email message.
##### setCarbonCopyRecipients(String[] value)
```
public final void setCarbonCopyRecipients(String[] value)
```

Sets the array of CC (carbon copy) recipients of the email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of CC (carbon copy) recipients of the email message. |

##### getBlindCarbonCopyRecipients()
```
public final String[] getBlindCarbonCopyRecipients()
```

Gets the array of BCC (blind carbon copy) recipients of the email message.

**Returns:**
java.lang.String[] - The array of BCC (blind carbon copy) recipients of the email message.
##### setBlindCarbonCopyRecipients(String[] value)
```
public final void setBlindCarbonCopyRecipients(String[] value)
```

Sets the array of BCC (blind carbon copy) recipients of the email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The array of BCC (blind carbon copy) recipients of the email message. |

##### getSender()
```
public final String getSender()
```

Gets the email address of the sender.

**Returns:**
java.lang.String - The email address of the sender.
##### getHeaders()
```
public final EmailHeaderPackage getHeaders()
```

Gets a metadata package containing the email headers.

**Returns:**
EmailHeaderPackage - A metadata package containing the email headers.

### EmailRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emailrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class EmailRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in an email message.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getEmailPackage() | Gets the email metadata package. |
| clearAttachments() | Removes all the attachments form the email message. |
##### getEmailPackage()
```
public final EmailPackage getEmailPackage()
```

Gets the email metadata package.

**Returns:**
EmailPackage - The email metadata package.
##### clearAttachments()
```
public final void clearAttachments()
```

Removes all the attachments form the email message.

### EmfRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class EmfRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in an EMF image.

### EmlPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emlpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.EmailPackage
```
public class EmlPackage extends EmailPackage
```

Represents EML message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails

### EmlRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/emlrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.EmailRootPackage
```
public class EmlRootPackage extends EmailRootPackage
```

Represents the root package allowing working with metadata in an EML email message.

This code sample shows how to extract metadata from an EML message.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputEml)) {
>      EmlRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getEmailPackage().getSender());
>      System.out.println(root.getEmailPackage().getSubject());
>      for (String recipient : root.getEmailPackage().getRecipients()) {
>          System.out.println(recipient);
>      }
>      for (String attachedFileName : root.getEmailPackage().getAttachedFileNames()) {
>          System.out.println(attachedFileName);
>      }
>      for (MetadataProperty header : root.getEmailPackage().getHeaders()) {
>          System.out.println(String.format("%s = %s", header.getName(), header.getValue()));
>      }
>      // ...
>  }
>
> ```
> ```

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getEmlPackage() | Gets the EML metadata package. |
##### getEmlPackage()
```
public final EmlPackage getEmlPackage()
```

Gets the EML metadata package.

**Returns:**
EmlPackage - The EML metadata package.

### EpubPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/epubpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class EpubPackage extends CustomPackage
```

Represents metadata in a EPUB e-book.

[Working with metadata in EPUB E-Books]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+EPUB+E-Books
#### Methods

| Method | Description |
| --- | --- |
| getImageCover() | Gets the image cover as an array of bytes. |
| getVersion() | Gets the EPUB version. |
| getUniqueIdentifier() | Gets the package unique identifier. |
| getAbstract() | Gets a summary of the resource. |
| setAbstract(String value) | Sets a summary of the resource. |
| getAccessRights() | Gets the information about who access the resource or an indication of its security status. |
| setAccessRights(String value) | Sets the information about who access the resource or an indication of its security status. |
| getAccrualMethod() | Gets the method by which items are added to a collection. |
| setAccrualMethod(String value) | Sets the method by which items are added to a collection. |
| getAccrualPeriodicity() | Gets the frequency with which items are added to a collection. |
| setAccrualPeriodicity(String value) | Sets the frequency with which items are added to a collection. |
| getAccrualPolicy() | Gets the policy governing the addition of items to a collection. |
| setAccrualPolicy(String value) | Sets the policy governing the addition of items to a collection. |
| getAlternative() | Gets an alternative name for the resource. |
| setAlternative(String value) | Sets an alternative name for the resource. |
| getAudience() | Gets a class of agents for whom the resource is intended or useful. |
| setAudience(String value) | Sets a class of agents for whom the resource is intended or useful. |
| getAvailable() | Gets the date that the resource became or will become available. |
| setAvailable(String value) | Sets the date that the resource became or will become available. |
| getBibliographicCitation() | Gets a bibliographic reference for the resource. |
| setBibliographicCitation(String value) | Sets a bibliographic reference for the resource. |
| getConformsTo() | Gets an established standard to which the described resource conforms. |
| setConformsTo(String value) | Sets an established standard to which the described resource conforms. |
| getContributor() | Gets an entity responsible for making contributions to the resource. |
| setContributor(String value) | Sets an entity responsible for making contributions to the resource. |
| getCoverage() | Gets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| setCoverage(String value) | Sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| getCreated() | Gets the date of creation of the resource. |
| setCreated(String value) | Sets the date of creation of the resource. |
| getCreator() | Gets an entity responsible for making the resource. |
| setCreator(String value) | Sets an entity responsible for making the resource. |
| getDate() | Gets a point or period of time associated with an event in the lifecycle of the resource. |
| setDate(String value) | Sets a point or period of time associated with an event in the lifecycle of the resource. |
| getDateAccepted() | Gets the date of acceptance of the resource. |
| setDateAccepted(String value) | Sets the date of acceptance of the resource. |
| getDateCopyrighted() | Gets the date of copyright of the resource. |
| setDateCopyrighted(String value) | Sets the date of copyright of the resource. |
| getDateSubmitted() | Gets the date of submission of the resource. |
| setDateSubmitted(String value) | Sets the date of submission of the resource. |
| getDescription() | Gets an account of the resource. |
| setDescription(String value) | Sets an account of the resource. |
| getEducationLevel() | Gets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| setEducationLevel(String value) | Sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| getExtent() | Gets the size or duration of the resource. |
| setExtent(String value) | Sets the size or duration of the resource. |
| getFormat() | Gets the file format, physical medium, or dimensions of the resource. |
| setFormat(String value) | Sets the file format, physical medium, or dimensions of the resource. |
| hasFormat() | Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| setHasFormat(String value) | Sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| hasPart() | Gets or sets a related resource that is included either physically or logically in the described resource. |
| setPart(String value) | Sets a related resource that is included either physically or logically in the described resource. |
| hasVersion() | Gets or sets a related resource that is a version, edition, or adaptation of the described resource. |
| setHasVersion(String value) | Sets a related resource that is a version, edition, or adaptation of the described resource. |
| getIdentifier() | Gets an unambiguous reference to the resource within a given context. |
| setIdentifier(String value) | Sets an unambiguous reference to the resource within a given context. |
| getInstructionalMethod() | Gets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| setInstructionalMethod(String value) | Sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| isFormatOf() | Gets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| setFormatOf(String value) | Sets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| isPartOf() | Gets a related resource in which the described resource is physically or logically included. |
| setPartOf(String value) | Sets a related resource in which the described resource is physically or logically included. |
| isReferencedBy() | Gets a related resource that references, cites, or otherwise points to the described resource. |
| setReferencedBy(String value) | Sets a related resource that references, cites, or otherwise points to the described resource. |
| isReplacedBy() | Gets a related resource that supplants, displaces, or supersedes the described resource. |
| setReplacedBy(String value) | Sets a related resource that supplants, displaces, or supersedes the described resource. |
| isRequiredBy() | Gets a related resource that requires the described resource to support its function, delivery, or coherence. |
| setRequiredBy(String value) | Sets a related resource that requires the described resource to support its function, delivery, or coherence. |
| getIssued() | Gets the date of formal issuance of the resource. |
| setIssued(String value) | Sets the date of formal issuance of the resource. |
| isVersionOf() | Gets a related resource of which the described resource is a version, edition, or adaptation. |
| setVersionOf(String value) | Sets a related resource of which the described resource is a version, edition, or adaptation. |
| getLanguage() | Gets the language of the resource. |
| setLanguage(String value) | Sets the language of the resource. |
| getLicense() | Gets a legal document giving official permission to do something with the resource. |
| setLicense(String value) | Sets a legal document giving official permission to do something with the resource. |
| getMediator() | Gets an entity that mediates access to the resource. |
| setMediator(String value) | Sets an entity that mediates access to the resource. |
| getMedium() | Gets the material or physical carrier of the resource. |
| setMedium(String value) | Sets the material or physical carrier of the resource. |
| getModified() | Gets the date on which the resource was changed. |
| setModified(String value) | Sets the date on which the resource was changed. |
| getProvenance() | Gets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| setProvenance(String value) | Sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| getPublisher() | Gets an entity responsible for making the resource available. |
| setPublisher(String value) | Sets an entity responsible for making the resource available. |
| getReferences() | Gets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| setReferences(String value) | Sets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| getRelation() | Gets a related resource. |
| setRelation(String value) | Sets a related resource. |
| getReplaces() | Gets a related resource that is supplanted, displaced, or superseded by the described resource. |
| setReplaces(String value) | Sets a related resource that is supplanted, displaced, or superseded by the described resource. |
| getRequires() | Gets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| setRequires(String value) | Sets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| getRights() | Gets the information about rights held in and over the resource. |
| setRights(String value) | Sets the information about rights held in and over the resource. |
| getRightsHolder() | Gets a person or organization owning or managing rights over the resource. |
| setRightsHolder(String value) | Sets a person or organization owning or managing rights over the resource. |
| getSource() | Gets a related resource from which the described resource is derived. |
| setSource(String value) | Sets a related resource from which the described resource is derived. |
| getSpatial() | Gets the spatial characteristics of the resource. |
| setSpatial(String value) | Sets the spatial characteristics of the resource. |
| getSubject() | Gets a topic of the resource. |
| setSubject(String value) | Sets a topic of the resource. |
| getTableOfContents() | Gets a list of subunits of the resource. |
| setTableOfContents(String value) | Sets a list of subunits of the resource. |
| getTemporal() | Gets the temporal characteristics of the resource. |
| setTemporal(String value) | Sets the temporal characteristics of the resource. |
| getTitle() | Gets a name given to the resource. |
| setTitle(String value) | Sets a name given to the resource. |
| getType() | Gets the nature or genre of the resource. |
| setType(String value) | Sets the nature or genre of the resource. |
| getValid() | Gets the date (often a range) of validity of a resource. |
| setValid(String value) | Sets the date (often a range) of validity of a resource. |
##### getImageCover()
```
public final byte[] getImageCover()
```

Gets the image cover as an array of bytes.

**Returns:**
byte[] - The image cover.
##### getVersion()
```
public final String getVersion()
```

Gets the EPUB version.

**Returns:**
java.lang.String - The EPUB version.
##### getUniqueIdentifier()
```
public final String getUniqueIdentifier()
```

Gets the package unique identifier.

**Returns:**
java.lang.String - The package unique identifier.
##### getAbstract()
```
public final String getAbstract()
```

Gets a summary of the resource.

**Returns:**
java.lang.String - A summary of the resource.
##### setAbstract(String value)
```
public final void setAbstract(String value)
```

Sets a summary of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A summary of the resource. |

##### getAccessRights()
```
public final String getAccessRights()
```

Gets the information about who access the resource or an indication of its security status.

**Returns:**
java.lang.String - The information about who access the resource or an indication of its security status.
##### setAccessRights(String value)
```
public final void setAccessRights(String value)
```

Sets the information about who access the resource or an indication of its security status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about who access the resource or an indication of its security status. |

##### getAccrualMethod()
```
public final String getAccrualMethod()
```

Gets the method by which items are added to a collection.

**Returns:**
java.lang.String - The method by which items are added to a collection.
##### setAccrualMethod(String value)
```
public final void setAccrualMethod(String value)
```

Sets the method by which items are added to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The method by which items are added to a collection. |

##### getAccrualPeriodicity()
```
public final String getAccrualPeriodicity()
```

Gets the frequency with which items are added to a collection.

**Returns:**
java.lang.String - The frequency with which items are added to a collection.
##### setAccrualPeriodicity(String value)
```
public final void setAccrualPeriodicity(String value)
```

Sets the frequency with which items are added to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The frequency with which items are added to a collection. |

##### getAccrualPolicy()
```
public final String getAccrualPolicy()
```

Gets the policy governing the addition of items to a collection.

**Returns:**
java.lang.String - The policy governing the addition of items to a collection.
##### setAccrualPolicy(String value)
```
public final void setAccrualPolicy(String value)
```

Sets the policy governing the addition of items to a collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The policy governing the addition of items to a collection. |

##### getAlternative()
```
public final String getAlternative()
```

Gets an alternative name for the resource.

**Returns:**
java.lang.String - An alternative name for the resource.
##### setAlternative(String value)
```
public final void setAlternative(String value)
```

Sets an alternative name for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An alternative name for the resource. |

##### getAudience()
```
public final String getAudience()
```

Gets a class of agents for whom the resource is intended or useful.

**Returns:**
java.lang.String - A class of agents for whom the resource is intended or useful.
##### setAudience(String value)
```
public final void setAudience(String value)
```

Sets a class of agents for whom the resource is intended or useful.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A class of agents for whom the resource is intended or useful. |

##### getAvailable()
```
public final String getAvailable()
```

Gets the date that the resource became or will become available.

**Returns:**
java.lang.String - The date that the resource became or will become available.
##### setAvailable(String value)
```
public final void setAvailable(String value)
```

Sets the date that the resource became or will become available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date that the resource became or will become available. |

##### getBibliographicCitation()
```
public final String getBibliographicCitation()
```

Gets a bibliographic reference for the resource.

**Returns:**
java.lang.String - A bibliographic reference for the resource.
##### setBibliographicCitation(String value)
```
public final void setBibliographicCitation(String value)
```

Sets a bibliographic reference for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A bibliographic reference for the resource. |

##### getConformsTo()
```
public final String getConformsTo()
```

Gets an established standard to which the described resource conforms.

**Returns:**
java.lang.String - An established standard to which the described resource conforms.
##### setConformsTo(String value)
```
public final void setConformsTo(String value)
```

Sets an established standard to which the described resource conforms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An established standard to which the described resource conforms. |

##### getContributor()
```
public final String getContributor()
```

Gets an entity responsible for making contributions to the resource.

**Returns:**
java.lang.String - An entity responsible for making contributions to the resource.
##### setContributor(String value)
```
public final void setContributor(String value)
```

Sets an entity responsible for making contributions to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making contributions to the resource. |

##### getCoverage()
```
public final String getCoverage()
```

Gets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.

**Returns:**
java.lang.String - The spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.
##### setCoverage(String value)
```
public final void setCoverage(String value)
```

Sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |

##### getCreated()
```
public final String getCreated()
```

Gets the date of creation of the resource.

**Returns:**
java.lang.String - The date of creation of the resource.
##### setCreated(String value)
```
public final void setCreated(String value)
```

Sets the date of creation of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of creation of the resource. |

##### getCreator()
```
public final String getCreator()
```

Gets an entity responsible for making the resource.

**Returns:**
java.lang.String - An entity responsible for making the resource.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Sets an entity responsible for making the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making the resource. |

##### getDate()
```
public final String getDate()
```

Gets a point or period of time associated with an event in the lifecycle of the resource.

**Returns:**
java.lang.String - A point or period of time associated with an event in the lifecycle of the resource.
##### setDate(String value)
```
public final void setDate(String value)
```

Sets a point or period of time associated with an event in the lifecycle of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A point or period of time associated with an event in the lifecycle of the resource. |

##### getDateAccepted()
```
public final String getDateAccepted()
```

Gets the date of acceptance of the resource.

**Returns:**
java.lang.String - The date of acceptance of the resource.
##### setDateAccepted(String value)
```
public final void setDateAccepted(String value)
```

Sets the date of acceptance of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of acceptance of the resource. |

##### getDateCopyrighted()
```
public final String getDateCopyrighted()
```

Gets the date of copyright of the resource.

**Returns:**
java.lang.String - The date of copyright of the resource.
##### setDateCopyrighted(String value)
```
public final void setDateCopyrighted(String value)
```

Sets the date of copyright of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of copyright of the resource. |

##### getDateSubmitted()
```
public final String getDateSubmitted()
```

Gets the date of submission of the resource.

**Returns:**
java.lang.String - The date of submission of the resource.
##### setDateSubmitted(String value)
```
public final void setDateSubmitted(String value)
```

Sets the date of submission of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of submission of the resource. |

##### getDescription()
```
public final String getDescription()
```

Gets an account of the resource.

**Returns:**
java.lang.String - An account of the resource.
##### setDescription(String value)
```
public final void setDescription(String value)
```

Sets an account of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An account of the resource. |

##### getEducationLevel()
```
public final String getEducationLevel()
```

Gets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

**Returns:**
java.lang.String - A class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.
##### setEducationLevel(String value)
```
public final void setEducationLevel(String value)
```

Sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |

##### getExtent()
```
public final String getExtent()
```

Gets the size or duration of the resource.

**Returns:**
java.lang.String - The size or duration of the resource.
##### setExtent(String value)
```
public final void setExtent(String value)
```

Sets the size or duration of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The size or duration of the resource. |

##### getFormat()
```
public final String getFormat()
```

Gets the file format, physical medium, or dimensions of the resource.

**Returns:**
java.lang.String - The file format, physical medium, or dimensions of the resource.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the file format, physical medium, or dimensions of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The file format, physical medium, or dimensions of the resource. |

##### hasFormat()
```
public final String hasFormat()
```

Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format.

**Returns:**
java.lang.String - A related resource that is substantially the same as the pre-existing described resource, but in another format.
##### setHasFormat(String value)
```
public final void setHasFormat(String value)
```

Sets a related resource that is substantially the same as the pre-existing described resource, but in another format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is substantially the same as the pre-existing described resource, but in another format. |

##### hasPart()
```
public final String hasPart()
```

Gets or sets a related resource that is included either physically or logically in the described resource.

**Returns:**
java.lang.String - A related resource that is included either physically or logically in the described resource.
##### setPart(String value)
```
public final void setPart(String value)
```

Sets a related resource that is included either physically or logically in the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is included either physically or logically in the described resource. |

##### hasVersion()
```
public final String hasVersion()
```

Gets or sets a related resource that is a version, edition, or adaptation of the described resource.

**Returns:**
java.lang.String - A related resource that is a version, edition, or adaptation of the described resource.
##### setHasVersion(String value)
```
public final void setHasVersion(String value)
```

Sets a related resource that is a version, edition, or adaptation of the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is a version, edition, or adaptation of the described resource. |

##### getIdentifier()
```
public final String getIdentifier()
```

Gets an unambiguous reference to the resource within a given context.

**Returns:**
java.lang.String - An unambiguous reference to the resource within a given context.
##### setIdentifier(String value)
```
public final void setIdentifier(String value)
```

Sets an unambiguous reference to the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An unambiguous reference to the resource within a given context. |

##### getInstructionalMethod()
```
public final String getInstructionalMethod()
```

Gets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

**Returns:**
java.lang.String - A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.
##### setInstructionalMethod(String value)
```
public final void setInstructionalMethod(String value)
```

Sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |

##### isFormatOf()
```
public final String isFormatOf()
```

Gets a pre-existing related resource that is substantially the same as the described resource, but in another format.

**Returns:**
java.lang.String - A pre-existing related resource that is substantially the same as the described resource, but in another format.
##### setFormatOf(String value)
```
public final void setFormatOf(String value)
```

Sets a pre-existing related resource that is substantially the same as the described resource, but in another format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A pre-existing related resource that is substantially the same as the described resource, but in another format. |

##### isPartOf()
```
public final String isPartOf()
```

Gets a related resource in which the described resource is physically or logically included.

**Returns:**
java.lang.String - A related resource in which the described resource is physically or logically included.
##### setPartOf(String value)
```
public final void setPartOf(String value)
```

Sets a related resource in which the described resource is physically or logically included.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource in which the described resource is physically or logically included. |

##### isReferencedBy()
```
public final String isReferencedBy()
```

Gets a related resource that references, cites, or otherwise points to the described resource.

**Returns:**
java.lang.String - A related resource that references, cites, or otherwise points to the described resource.
##### setReferencedBy(String value)
```
public final void setReferencedBy(String value)
```

Sets a related resource that references, cites, or otherwise points to the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that references, cites, or otherwise points to the described resource. |

##### isReplacedBy()
```
public final String isReplacedBy()
```

Gets a related resource that supplants, displaces, or supersedes the described resource.

**Returns:**
java.lang.String - A related resource that supplants, displaces, or supersedes the described resource.
##### setReplacedBy(String value)
```
public final void setReplacedBy(String value)
```

Sets a related resource that supplants, displaces, or supersedes the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that supplants, displaces, or supersedes the described resource. |

##### isRequiredBy()
```
public final String isRequiredBy()
```

Gets a related resource that requires the described resource to support its function, delivery, or coherence.

**Returns:**
java.lang.String - A related resource that requires the described resource to support its function, delivery, or coherence.
##### setRequiredBy(String value)
```
public final void setRequiredBy(String value)
```

Sets a related resource that requires the described resource to support its function, delivery, or coherence.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that requires the described resource to support its function, delivery, or coherence. |

##### getIssued()
```
public final String getIssued()
```

Gets the date of formal issuance of the resource.

**Returns:**
java.lang.String - The date of formal issuance of the resource.
##### setIssued(String value)
```
public final void setIssued(String value)
```

Sets the date of formal issuance of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date of formal issuance of the resource. |

##### isVersionOf()
```
public final String isVersionOf()
```

Gets a related resource of which the described resource is a version, edition, or adaptation.

**Returns:**
java.lang.String - A related resource of which the described resource is a version, edition, or adaptation.
##### setVersionOf(String value)
```
public final void setVersionOf(String value)
```

Sets a related resource of which the described resource is a version, edition, or adaptation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource of which the described resource is a version, edition, or adaptation. |

##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the resource.

**Returns:**
java.lang.String - The language of the resource.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the language of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language of the resource. |

##### getLicense()
```
public final String getLicense()
```

Gets a legal document giving official permission to do something with the resource.

**Returns:**
java.lang.String - A legal document giving official permission to do something with the resource.
##### setLicense(String value)
```
public final void setLicense(String value)
```

Sets a legal document giving official permission to do something with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A legal document giving official permission to do something with the resource. |

##### getMediator()
```
public final String getMediator()
```

Gets an entity that mediates access to the resource.

**Returns:**
java.lang.String - An entity that mediates access to the resource.
##### setMediator(String value)
```
public final void setMediator(String value)
```

Sets an entity that mediates access to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity that mediates access to the resource. |

##### getMedium()
```
public final String getMedium()
```

Gets the material or physical carrier of the resource.

**Returns:**
java.lang.String - The material or physical carrier of the resource.
##### setMedium(String value)
```
public final void setMedium(String value)
```

Sets the material or physical carrier of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The material or physical carrier of the resource. |

##### getModified()
```
public final String getModified()
```

Gets the date on which the resource was changed.

**Returns:**
java.lang.String - The date on which the resource was changed.
##### setModified(String value)
```
public final void setModified(String value)
```

Sets the date on which the resource was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date on which the resource was changed. |

##### getProvenance()
```
public final String getProvenance()
```

Gets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

**Returns:**
java.lang.String - A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.
##### setProvenance(String value)
```
public final void setProvenance(String value)
```

Sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |

##### getPublisher()
```
public final String getPublisher()
```

Gets an entity responsible for making the resource available.

**Returns:**
java.lang.String - An entity responsible for making the resource available.
##### setPublisher(String value)
```
public final void setPublisher(String value)
```

Sets an entity responsible for making the resource available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An entity responsible for making the resource available. |

##### getReferences()
```
public final String getReferences()
```

Gets a related resource that is referenced, cited, or otherwise pointed to by the described resource.

**Returns:**
java.lang.String - A related resource that is referenced, cited, or otherwise pointed to by the described resource.
##### setReferences(String value)
```
public final void setReferences(String value)
```

Sets a related resource that is referenced, cited, or otherwise pointed to by the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is referenced, cited, or otherwise pointed to by the described resource. |

##### getRelation()
```
public final String getRelation()
```

Gets a related resource.

**Returns:**
java.lang.String - A related resource.
##### setRelation(String value)
```
public final void setRelation(String value)
```

Sets a related resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource. |

##### getReplaces()
```
public final String getReplaces()
```

Gets a related resource that is supplanted, displaced, or superseded by the described resource.

**Returns:**
java.lang.String - A related resource that is supplanted, displaced, or superseded by the described resource.
##### setReplaces(String value)
```
public final void setReplaces(String value)
```

Sets a related resource that is supplanted, displaced, or superseded by the described resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is supplanted, displaced, or superseded by the described resource. |

##### getRequires()
```
public final String getRequires()
```

Gets a related resource that is required by the described resource to support its function, delivery, or coherence.

**Returns:**
java.lang.String - A related resource that is required by the described resource to support its function, delivery, or coherence.
##### setRequires(String value)
```
public final void setRequires(String value)
```

Sets a related resource that is required by the described resource to support its function, delivery, or coherence.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource that is required by the described resource to support its function, delivery, or coherence. |

##### getRights()
```
public final String getRights()
```

Gets the information about rights held in and over the resource.

**Returns:**
java.lang.String - The information about rights held in and over the resource.
##### setRights(String value)
```
public final void setRights(String value)
```

Sets the information about rights held in and over the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about rights held in and over the resource. |

##### getRightsHolder()
```
public final String getRightsHolder()
```

Gets a person or organization owning or managing rights over the resource.

**Returns:**
java.lang.String - A person or organization owning or managing rights over the resource.
##### setRightsHolder(String value)
```
public final void setRightsHolder(String value)
```

Sets a person or organization owning or managing rights over the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A person or organization owning or managing rights over the resource. |

##### getSource()
```
public final String getSource()
```

Gets a related resource from which the described resource is derived.

**Returns:**
java.lang.String - A related resource from which the described resource is derived.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets a related resource from which the described resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A related resource from which the described resource is derived. |

##### getSpatial()
```
public final String getSpatial()
```

Gets the spatial characteristics of the resource.

**Returns:**
java.lang.String - The spatial characteristics of the resource.
##### setSpatial(String value)
```
public final void setSpatial(String value)
```

Sets the spatial characteristics of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The spatial characteristics of the resource. |

##### getSubject()
```
public final String getSubject()
```

Gets a topic of the resource.

**Returns:**
java.lang.String - A topic of the resource.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets a topic of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A topic of the resource. |

##### getTableOfContents()
```
public final String getTableOfContents()
```

Gets a list of subunits of the resource.

**Returns:**
java.lang.String - A list of subunits of the resource.
##### setTableOfContents(String value)
```
public final void setTableOfContents(String value)
```

Sets a list of subunits of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A list of subunits of the resource. |

##### getTemporal()
```
public final String getTemporal()
```

Gets the temporal characteristics of the resource.

**Returns:**
java.lang.String - The temporal characteristics of the resource.
##### setTemporal(String value)
```
public final void setTemporal(String value)
```

Sets the temporal characteristics of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The temporal characteristics of the resource. |

##### getTitle()
```
public final String getTitle()
```

Gets a name given to the resource.

**Returns:**
java.lang.String - A name given to the resource.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets a name given to the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A name given to the resource. |

##### getType()
```
public final String getType()
```

Gets the nature or genre of the resource.

**Returns:**
java.lang.String - The nature or genre of the resource.
##### setType(String value)
```
public final void setType(String value)
```

Sets the nature or genre of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The nature or genre of the resource. |

##### getValid()
```
public final String getValid()
```

Gets the date (often a range) of validity of a resource.

**Returns:**
java.lang.String - The date (often a range) of validity of a resource.
##### setValid(String value)
```
public final void setValid(String value)
```

Sets the date (often a range) of validity of a resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date (often a range) of validity of a resource. |

### EpubRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/epubrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDublinCore
```
public class EpubRootPackage extends RootMetadataPackage implements IDublinCore
```

Represents the root package allowing working with metadata in an EPUB e-book.

This code sample shows how to read EPUB format-specific metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputEpub)) {
>      EpubRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getEpubPackage().getVersion());
>      System.out.println(root.getEpubPackage().getUniqueIdentifier());
>      System.out.println(root.getEpubPackage().getImageCover() != null ? root.getEpubPackage().getImageCover().length : 0);
>  }
>
> ```
> ```

[Working with metadata in EPUB E-Books]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+EPUB+E-Books
#### Methods

| Method | Description |
| --- | --- |
| getEpubPackage() | Gets the EPUB metadata package. |
| getDublinCorePackage() | Gets the Dublin Core metadata package extracted from the e-book. |
##### getEpubPackage()
```
public final EpubPackage getEpubPackage()
```

Gets the EPUB metadata package.

**Returns:**
EpubPackage - The EPUB metadata package.
##### getDublinCorePackage()
```
public final DublinCorePackage getDublinCorePackage()
```

Gets the Dublin Core metadata package extracted from the e-book.

**Returns:**
DublinCorePackage - The Dublin Core metadata package extracted from the e-book.

### ExifDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/exifdictionarybasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class ExifDictionaryBasePackage extends CustomPackage
```

Provides an abstract base class for EXIF metadata dictionaries.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
| getByTiffTagID(TiffTagID tagId) | Gets the TIFF tag with the specified id. |
| remove(TiffTagID tagId) | Removes the property with the specified id. |
| set(TiffTag tag) | Adds or replaces the specified tag. |
| clear() | Removes all TIFF tags stored in the package. |
##### toList()
```
public final IReadOnlyList<TiffTag> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all TIFF tags from the package.
##### getByTiffTagID(TiffTagID tagId)
```
public final TiffTag getByTiffTagID(TiffTagID tagId)
```

Gets the TIFF tag with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | TiffTagID | The id of the tag to retrieve. |

**Returns:**
TiffTag - The  TiffTag  with the specified tag id.
##### remove(TiffTagID tagId)
```
public final boolean remove(TiffTagID tagId)
```

Removes the property with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | TiffTagID | A TIFF tag id. |

**Returns:**
boolean - True if the specified TIFF tag is found and removed; otherwise, false.
##### set(TiffTag tag)
```
public final void set(TiffTag tag)
```

Adds or replaces the specified tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | TiffTag | The tag to set. |

##### clear()
```
public final void clear()
```

Removes all TIFF tags stored in the package.

### ExifGpsAltitudeRef
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/exifgpsaltituderef.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ExifGpsAltitudeRef extends Enum<ExifGpsAltitudeRef> implements IEnumValue
```

Represents a GPS altitude reference.
#### Fields

| Field | Description |
| --- | --- |
| AboveSeaLevel | Above sea level. |
| BelowSeaLevel | Below sea level. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### AboveSeaLevel
```
public static final ExifGpsAltitudeRef AboveSeaLevel
```

Above sea level.

##### BelowSeaLevel
```
public static final ExifGpsAltitudeRef BelowSeaLevel
```

Below sea level.

##### values()
```
public static ExifGpsAltitudeRef[] values()
```

**Returns:**
com.groupdocs.metadata.core.ExifGpsAltitudeRef[]
##### valueOf(String name)
```
public static ExifGpsAltitudeRef valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ExifGpsAltitudeRef
##### getByRawValue(int rawValue)
```
public static ExifGpsAltitudeRef getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ExifGpsAltitudeRef
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ExifGpsPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/exifgpspackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public final class ExifGpsPackage extends ExifDictionaryBasePackage
```

Represents GPS metadata in an EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ExifGpsPackage() | Initializes a new instance of the  ExifGpsPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAltitude() | Gets the altitude based on the reference in  AltitudeRef . |
| setAltitude(TiffRational value) | Sets the altitude based on the reference in  AltitudeRef . |
| getAltitudeRef() | Gets the altitude used as the reference altitude. |
| setAltitudeRef(ExifGpsAltitudeRef value) | Sets the altitude used as the reference altitude. |
| getAreaInformation() | Gets the character string recording the name of the GPS area. |
| setAreaInformation(byte[] value) | Sets the character string recording the name of the GPS area. |
| getDateStamp() | Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| setDateStamp(String value) | Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). |
| getDestBearing() | Gets the GPS bearing to the destination point. |
| setDestBearing(TiffRational value) | Sets the GPS bearing to the destination point. |
| getDestBearingRef() | Gets the GPS reference used for giving the bearing to the destination point. |
| setDestBearingRef(String value) | Sets the GPS reference used for giving the bearing to the destination point. |
| getDestDistance() | Gets the GPS distance to the destination point. |
| setDestDistance(TiffRational value) | Sets the GPS distance to the destination point. |
| getDestDistanceRef() | Gets the GPS unit used to express the distance to the destination point. |
| setDestDistanceRef(String value) | Sets the GPS unit used to express the distance to the destination point. |
| getDestLatitude() | Gets the GPS latitude of the destination point. |
| setDestLatitude(TiffRational[] value) | Sets the GPS latitude of the destination point. |
| getDestLatitudeRef() | Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| setDestLatitudeRef(String value) | Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. |
| getDestLongitude() | Gets the GPS longitude of the destination point. |
| setDestLongitude(TiffRational[] value) | Sets the GPS longitude of the destination point. |
| getDestLongitudeRef() | Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| setDestLongitudeRef(String value) | Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. |
| getDifferential() | Gets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| setDifferential(Integer value) | Sets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| getDataDegreeOfPrecision() | Gets the GPS DOP (data degree of precision). |
| setDataDegreeOfPrecision(TiffRational value) | Sets the GPS DOP (data degree of precision). |
| getImgDirection() | Gets the GPS direction of the image when it was captured. |
| setImgDirection(TiffRational value) | Sets the GPS direction of the image when it was captured. |
| getImgDirectionRef() | Gets the GPS reference for giving the direction of the image when it is captured. |
| setImgDirectionRef(String value) | Sets the GPS reference for giving the direction of the image when it is captured. |
| getLatitude() | Gets the GPS latitude. |
| setLatitude(TiffRational[] value) | Sets the GPS latitude. |
| getLatitudeRef() | Gets a GPS value indicating whether the latitude is north or south latitude. |
| setLatitudeRef(String value) | Sets a GPS value indicating whether the latitude is north or south latitude. |
| getLongitude() | Gets the GPS longitude. |
| setLongitude(TiffRational[] value) | Sets the GPS longitude. |
| getLongitudeRef() | Gets a GPS value indicating whether the longitude is east or west longitude. |
| setLongitudeRef(String value) | Sets a GPS value indicating whether the longitude is east or west longitude. |
| getMapDatum() | Gets the geodetic survey data used by the GPS receiver. |
| setMapDatum(String value) | Sets the geodetic survey data used by the GPS receiver. |
| getMeasureMode() | Gets the GPS measurement mode. |
| setMeasureMode(String value) | Sets the GPS measurement mode. |
| getProcessingMethod() | Gets a character string recording the name of the method used for location finding. |
| setProcessingMethod(byte[] value) | Sets a character string recording the name of the method used for location finding. |
| getSatellites() | Gets the GPS satellites used for measurements. |
| setSatellites(String value) | Sets the GPS satellites used for measurements. |
| getSpeed() | Gets the speed of GPS receiver movement. |
| setSpeed(TiffRational value) | Sets the speed of GPS receiver movement. |
| getSpeedRef() | Gets the unit used to express the GPS receiver speed of movement. |
| setSpeedRef(String value) | Sets the unit used to express the GPS receiver speed of movement. |
| getStatus() | Gets the status of the GPS receiver when the image is recorded. |
| setStatus(String value) | Sets the status of the GPS receiver when the image is recorded. |
| getTimeStamp() | Gets the time as UTC (Coordinated Universal Time). |
| setTimeStamp(TiffRational[] value) | Sets the time as UTC (Coordinated Universal Time). |
| getGpsTrack() | Gets the direction of GPS receiver movement. |
| setGpsTrack(TiffRational value) | Sets the direction of GPS receiver movement. |
| getTrackRef() | Gets the reference for giving the direction of GPS receiver movement. |
| setTrackRef(String value) | Sets the reference for giving the direction of GPS receiver movement. |
| getVersionID() | Gets the version of GPS IFD. |
| setVersionID(byte[] value) | Sets the version of GPS IFD. |
##### ExifGpsPackage()
```
public ExifGpsPackage()
```

Initializes a new instance of the  ExifGpsPackage  class.

##### getAltitude()
```
public final TiffRational getAltitude()
```

Gets the altitude based on the reference in  AltitudeRef . The reference unit is meters.

**Returns:**
TiffRational - The altitude based on the reference in  AltitudeRef .
##### setAltitude(TiffRational value)
```
public final void setAltitude(TiffRational value)
```

Sets the altitude based on the reference in  AltitudeRef . The reference unit is meters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The altitude based on the reference in  AltitudeRef . |

##### getAltitudeRef()
```
public final ExifGpsAltitudeRef getAltitudeRef()
```

Gets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the  Altitude  tag.

**Returns:**
ExifGpsAltitudeRef - The altitude used as the reference altitude
##### setAltitudeRef(ExifGpsAltitudeRef value)
```
public final void setAltitudeRef(ExifGpsAltitudeRef value)
```

Sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given. If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the  Altitude  tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifGpsAltitudeRef | The altitude used as the reference altitude |

##### getAreaInformation()
```
public final byte[] getAreaInformation()
```

Gets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.

**Returns:**
byte[] - The character string recording the name of the GPS area.
##### setAreaInformation(byte[] value)
```
public final void setAreaInformation(byte[] value)
```

Sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The character string recording the name of the GPS area. |

##### getDateStamp()
```
public final String getDateStamp()
```

Gets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

**Returns:**
java.lang.String - The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
##### setDateStamp(String value)
```
public final void setDateStamp(String value)
```

Sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD. |

##### getDestBearing()
```
public final TiffRational getDestBearing()
```

Gets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.

**Returns:**
TiffRational - The bearing to the destination point.
##### setDestBearing(TiffRational value)
```
public final void setDestBearing(TiffRational value)
```

Sets the GPS bearing to the destination point. The range of values is from 0.00 to 359.99.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The bearing to the destination point. |

##### getDestBearingRef()
```
public final String getDestBearingRef()
```

Gets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The GPS reference used for giving the bearing to the destination point.
##### setDestBearingRef(String value)
```
public final void setDestBearingRef(String value)
```

Sets the GPS reference used for giving the bearing to the destination point. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS reference used for giving the bearing to the destination point. |

##### getDestDistance()
```
public final TiffRational getDestDistance()
```

Gets the GPS distance to the destination point.

**Returns:**
TiffRational - The distance to the destination point.
##### setDestDistance(TiffRational value)
```
public final void setDestDistance(TiffRational value)
```

Sets the GPS distance to the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The distance to the destination point. |

##### getDestDistanceRef()
```
public final String getDestDistanceRef()
```

Gets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots.

**Returns:**
java.lang.String - The GPS unit used to express the distance to the destination point.
##### setDestDistanceRef(String value)
```
public final void setDestDistanceRef(String value)
```

Sets the GPS unit used to express the distance to the destination point. 'K', 'M' and 'N' represent kilometers, miles and knots.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS unit used to express the distance to the destination point. |

##### getDestLatitude()
```
public final TiffRational[] getDestLatitude()
```

Gets the GPS latitude of the destination point.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The latitude of the destination point.
##### setDestLatitude(TiffRational[] value)
```
public final void setDestLatitude(TiffRational[] value)
```

Sets the GPS latitude of the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The latitude of the destination point. |

##### getDestLatitudeRef()
```
public final String getDestLatitudeRef()
```

Gets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude.

**Returns:**
java.lang.String - The GPS value which indicates whether the latitude of the destination point is north or south latitude.
##### setDestLatitudeRef(String value)
```
public final void setDestLatitudeRef(String value)
```

Sets the GPS value which indicates whether the latitude of the destination point is north or south latitude. The ASCII value 'N' indicates north latitude, and 'S' is south latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS value which indicates whether the latitude of the destination point is north or south latitude. |

##### getDestLongitude()
```
public final TiffRational[] getDestLongitude()
```

Gets the GPS longitude of the destination point.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The GPS longitude of the destination point.
##### setDestLongitude(TiffRational[] value)
```
public final void setDestLongitude(TiffRational[] value)
```

Sets the GPS longitude of the destination point.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The GPS longitude of the destination point. |

##### getDestLongitudeRef()
```
public final String getDestLongitudeRef()
```

Gets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude.

**Returns:**
java.lang.String - The GPS value which indicates whether the longitude of the destination point is east or west longitude.
##### setDestLongitudeRef(String value)
```
public final void setDestLongitudeRef(String value)
```

Sets the GPS value which indicates whether the longitude of the destination point is east or west longitude. ASCII 'E' indicates east longitude, and 'W' is west longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS value which indicates whether the longitude of the destination point is east or west longitude. |

##### getDifferential()
```
public final Integer getDifferential()
```

Gets a GPS value which indicates whether differential correction is applied to the GPS receiver.

**Returns:**
java.lang.Integer - A GPS value which indicates whether differential correction is applied to the GPS receiver.
##### setDifferential(Integer value)
```
public final void setDifferential(Integer value)
```

Sets a GPS value which indicates whether differential correction is applied to the GPS receiver.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A GPS value which indicates whether differential correction is applied to the GPS receiver. |

##### getDataDegreeOfPrecision()
```
public final TiffRational getDataDegreeOfPrecision()
```

Gets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.

**Returns:**
TiffRational - The data degree of precision.
##### setDataDegreeOfPrecision(TiffRational value)
```
public final void setDataDegreeOfPrecision(TiffRational value)
```

Sets the GPS DOP (data degree of precision). An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The data degree of precision. |

##### getImgDirection()
```
public final TiffRational getImgDirection()
```

Gets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.

**Returns:**
TiffRational - The GPS direction of the image when it was captured.
##### setImgDirection(TiffRational value)
```
public final void setImgDirection(TiffRational value)
```

Sets the GPS direction of the image when it was captured. The range of values is from 0.00 to 359.99.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The GPS direction of the image when it was captured. |

##### getImgDirectionRef()
```
public final String getImgDirectionRef()
```

Gets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The GPS reference for giving the direction of the image when it is captured.
##### setImgDirectionRef(String value)
```
public final void setImgDirectionRef(String value)
```

Sets the GPS reference for giving the direction of the image when it is captured. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS reference for giving the direction of the image when it is captured. |

##### getLatitude()
```
public final TiffRational[] getLatitude()
```

Gets the GPS latitude.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The latitude.
##### setLatitude(TiffRational[] value)
```
public final void setLatitude(TiffRational[] value)
```

Sets the GPS latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The latitude. |

##### getLatitudeRef()
```
public final String getLatitudeRef()
```

Gets a GPS value indicating whether the latitude is north or south latitude.

**Returns:**
java.lang.String - A GPS value indicating whether the latitude is north or south latitude.
##### setLatitudeRef(String value)
```
public final void setLatitudeRef(String value)
```

Sets a GPS value indicating whether the latitude is north or south latitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A GPS value indicating whether the latitude is north or south latitude. |

##### getLongitude()
```
public final TiffRational[] getLongitude()
```

Gets the GPS longitude.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The longitude.
##### setLongitude(TiffRational[] value)
```
public final void setLongitude(TiffRational[] value)
```

Sets the GPS longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The longitude. |

##### getLongitudeRef()
```
public final String getLongitudeRef()
```

Gets a GPS value indicating whether the longitude is east or west longitude.

**Returns:**
java.lang.String - A GPS value indicating whether the longitude is east or west longitude.
##### setLongitudeRef(String value)
```
public final void setLongitudeRef(String value)
```

Sets a GPS value indicating whether the longitude is east or west longitude.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A GPS value indicating whether the longitude is east or west longitude. |

##### getMapDatum()
```
public final String getMapDatum()
```

Gets the geodetic survey data used by the GPS receiver.

**Returns:**
java.lang.String - The geodetic survey data used by the GPS receiver.
##### setMapDatum(String value)
```
public final void setMapDatum(String value)
```

Sets the geodetic survey data used by the GPS receiver.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The geodetic survey data used by the GPS receiver. |

##### getMeasureMode()
```
public final String getMeasureMode()
```

Gets the GPS measurement mode.

**Returns:**
java.lang.String - The measure mode.
##### setMeasureMode(String value)
```
public final void setMeasureMode(String value)
```

Sets the GPS measurement mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The measure mode. |

##### getProcessingMethod()
```
public final byte[] getProcessingMethod()
```

Gets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.

**Returns:**
byte[] - A character string recording the name of the method used for location finding.
##### setProcessingMethod(byte[] value)
```
public final void setProcessingMethod(byte[] value)
```

Sets a character string recording the name of the method used for location finding. The first byte indicates the character code used, and this is followed by the name of the method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | A character string recording the name of the method used for location finding. |

##### getSatellites()
```
public final String getSatellites()
```

Gets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.

**Returns:**
java.lang.String - The GPS satellites used for measurements.
##### setSatellites(String value)
```
public final void setSatellites(String value)
```

Sets the GPS satellites used for measurements. This tag can be used to describe the number of satellites, their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The GPS satellites used for measurements. |

##### getSpeed()
```
public final TiffRational getSpeed()
```

Gets the speed of GPS receiver movement.

**Returns:**
TiffRational - The speed of GPS receiver movement.
##### setSpeed(TiffRational value)
```
public final void setSpeed(TiffRational value)
```

Sets the speed of GPS receiver movement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The speed of GPS receiver movement. |

##### getSpeedRef()
```
public final String getSpeedRef()
```

Gets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.

**Returns:**
java.lang.String - The unit used to express the GPS receiver speed of movement.
##### setSpeedRef(String value)
```
public final void setSpeedRef(String value)
```

Sets the unit used to express the GPS receiver speed of movement. 'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The unit used to express the GPS receiver speed of movement. |

##### getStatus()
```
public final String getStatus()
```

Gets the status of the GPS receiver when the image is recorded.

**Returns:**
java.lang.String - The status of the GPS receiver when the image is recorded.
##### setStatus(String value)
```
public final void setStatus(String value)
```

Sets the status of the GPS receiver when the image is recorded.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The status of the GPS receiver when the image is recorded. |

##### getTimeStamp()
```
public final TiffRational[] getTimeStamp()
```

Gets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.

**Returns:**
com.groupdocs.metadata.core.TiffRational[] - The time as UTC (Coordinated Universal Time).
##### setTimeStamp(TiffRational[] value)
```
public final void setTimeStamp(TiffRational[] value)
```

Sets the time as UTC (Coordinated Universal Time). TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational\[\] | The time as UTC (Coordinated Universal Time). |

##### getGpsTrack()
```
public final TiffRational getGpsTrack()
```

Gets the direction of GPS receiver movement.

**Returns:**
TiffRational - The direction of GPS receiver movement.
##### setGpsTrack(TiffRational value)
```
public final void setGpsTrack(TiffRational value)
```

Sets the direction of GPS receiver movement.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TiffRational | The direction of GPS receiver movement. |

##### getTrackRef()
```
public final String getTrackRef()
```

Gets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction.

**Returns:**
java.lang.String - The reference for giving the direction of GPS receiver movement.
##### setTrackRef(String value)
```
public final void setTrackRef(String value)
```

Sets the reference for giving the direction of GPS receiver movement. 'T' denotes true direction and 'M' is magnetic direction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference for giving the direction of GPS receiver movement. |

##### getVersionID()
```
public final byte[] getVersionID()
```

Gets the version of GPS IFD.

**Returns:**
byte[] - The version of GPS IFD
##### setVersionID(byte[] value)
```
public final void setVersionID(byte[] value)
```

Sets the version of GPS IFD.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The version of GPS IFD |

### ExifIfdPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/exififdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public final class ExifIfdPackage extends ExifDictionaryBasePackage
```

Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCameraOwnerName() | Gets the camera owner's name. |
| setCameraOwnerName(String value) | Sets the camera owner's name. |
| getBodySerialNumber() | Gets the camera body serial number. |
| setBodySerialNumber(String value) | Sets the camera body serial number. |
| getCfaPattern() | Gets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| setCfaPattern(byte[] value) | Sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| getUserComment() | Gets the user comment. |
| setUserComment(String value) | Sets the user comment. |
##### getCameraOwnerName()
```
public final String getCameraOwnerName()
```

Gets the camera owner's name.

**Returns:**
java.lang.String - The name of the camera owner.
##### setCameraOwnerName(String value)
```
public final void setCameraOwnerName(String value)
```

Sets the camera owner's name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the camera owner. |

##### getBodySerialNumber()
```
public final String getBodySerialNumber()
```

Gets the camera body serial number.

**Returns:**
java.lang.String - The camera body serial number.
##### setBodySerialNumber(String value)
```
public final void setBodySerialNumber(String value)
```

Sets the camera body serial number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The camera body serial number. |

##### getCfaPattern()
```
public final byte[] getCfaPattern()
```

Gets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

**Returns:**
byte[] - The color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.
##### setCfaPattern(byte[] value)
```
public final void setCfaPattern(byte[] value)
```

Sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |

##### getUserComment()
```
public final String getUserComment()
```

Gets the user comment.

**Returns:**
java.lang.String - The user comment.
##### setUserComment(String value)
```
public final void setUserComment(String value)
```

Sets the user comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user comment. |

### ExifPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/exifpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public class ExifPackage extends ExifDictionaryBasePackage
```

Represents an EXIF metadata package (Exchangeable Image File Format).

This code sample demonstrates how to update common EXIF properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IExif root = (IExif) metadata.getRootPackage();
>      // Set the EXIF package if it's missing
>      if (root.getExifPackage() == null) {
>          root.setExifPackage(new ExifPackage());
>      }
>      root.getExifPackage().setCopyright("Copyright (C) 2011-2024 GroupDocs. All Rights Reserved.");
>      root.getExifPackage().setImageDescription("test image");
>      root.getExifPackage().setSoftware("GroupDocs.Metadata");
>      // ...
>      root.getExifPackage().getExifIfdPackage().setBodySerialNumber("test");
>      root.getExifPackage().getExifIfdPackage().setCameraOwnerName("GroupDocs");
>      root.getExifPackage().getExifIfdPackage().setUserComment("test comment");
>      // ...
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| ExifPackage() | Initializes a new instance of the  ExifPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getGpsPackage() | Gets the GPS data. |
| getExifIfdPackage() | Gets the EXIF IFD data. |
| getThumbnail() | Gets the image thumbnail represented as an array of bytes. |
| getArtist() | Gets the name of the camera owner, photographer or image creator. |
| setArtist(String value) | Sets the name of the camera owner, photographer or image creator. |
| getCopyright() | Gets the copyright notice. |
| setCopyright(String value) | Sets the copyright notice. |
| getDateTime() | Gets the date and time of image creation. |
| setDateTime(String value) | Sets the date and time of image creation. |
| getImageDescription() | Gets a character string giving the title of the image. |
| setImageDescription(String value) | Sets a character string giving the title of the image. |
| getImageLength() | Gets the number of rows of image data. |
| setImageLength(int value) | Sets the number of rows of image data. |
| getImageWidth() | Gets the number of columns of image data, equal to the number of pixels per row. |
| setImageWidth(int value) | Sets the number of columns of image data, equal to the number of pixels per row. |
| getOrientation() | Gets or sets the orientation. |
| setOrientation(int value) | Gets or sets the orientation. |
| getMake() | Gets the manufacturer of the recording equipment. |
| setMake(String value) | Sets the manufacturer of the recording equipment. |
| getModel() | Gets the model name or model number of the equipment. |
| setModel(String value) | Sets the model name or model number of the equipment. |
| getSoftware() | Gets the name and version of the software or firmware of the camera or image input device used to generate the image. |
| setSoftware(String value) | Sets the name and version of the software or firmware of the camera or image input device used to generate the image. |
##### ExifPackage()
```
public ExifPackage()
```

Initializes a new instance of the  ExifPackage  class.

##### getGpsPackage()
```
public final ExifGpsPackage getGpsPackage()
```

Gets the GPS data.

**Returns:**
ExifGpsPackage - The GPS data.
##### getExifIfdPackage()
```
public final ExifIfdPackage getExifIfdPackage()
```

Gets the EXIF IFD data.

**Returns:**
ExifIfdPackage - The EXIF IFD data.
##### getThumbnail()
```
public final byte[] getThumbnail()
```

Gets the image thumbnail represented as an array of bytes.

**Returns:**
byte[] - The image thumbnail represented as an array of bytes.

This feature is not available in trial mode.
##### getArtist()
```
public final String getArtist()
```

Gets the name of the camera owner, photographer or image creator.

**Returns:**
java.lang.String - The name of the camera owner, photographer or image creator.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the name of the camera owner, photographer or image creator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the camera owner, photographer or image creator. |

##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright notice.

**Returns:**
java.lang.String - The copyright notice.
##### setCopyright(String value)
```
public final void setCopyright(String value)
```

Sets the copyright notice.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The copyright notice. |

##### getDateTime()
```
public final String getDateTime()
```

Gets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed.

**Returns:**
java.lang.String - The date and time of image creation.
##### setDateTime(String value)
```
public final void setDateTime(String value)
```

Sets the date and time of image creation. In the EXIF standard, it is the date and time the file was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The date and time of image creation. |

##### getImageDescription()
```
public final String getImageDescription()
```

Gets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Returns:**
java.lang.String - The image description.
##### setImageDescription(String value)
```
public final void setImageDescription(String value)
```

Sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image description. |

##### getImageLength()
```
public final int getImageLength()
```

Gets the number of rows of image data.

**Returns:**
int - The number of rows of image data.
##### setImageLength(int value)
```
public final void setImageLength(int value)
```

Sets the number of rows of image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of rows of image data. |

##### getImageWidth()
```
public final int getImageWidth()
```

Gets the number of columns of image data, equal to the number of pixels per row.

**Returns:**
int - The number of columns of image data, equal to the number of pixels per row.
##### setImageWidth(int value)
```
public final void setImageWidth(int value)
```

Sets the number of columns of image data, equal to the number of pixels per row.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of columns of image data, equal to the number of pixels per row. |

##### getOrientation()
```
public final int getOrientation()
```

Gets or sets the orientation.

Value: The orientation.

**Returns:**
int
##### setOrientation(int value)
```
public final void setOrientation(int value)
```

Gets or sets the orientation.

Value: The orientation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMake()
```
public final String getMake()
```

Gets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.

**Returns:**
java.lang.String - The manufacturer of the recording equipment.
##### setMake(String value)
```
public final void setMake(String value)
```

Sets the manufacturer of the recording equipment. This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manufacturer of the recording equipment. |

##### getModel()
```
public final String getModel()
```

Gets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.

**Returns:**
java.lang.String - The model name or model number of the equipment.
##### setModel(String value)
```
public final void setModel(String value)
```

Sets the model name or model number of the equipment. This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The model name or model number of the equipment. |

##### getSoftware()
```
public final String getSoftware()
```

Gets the name and version of the software or firmware of the camera or image input device used to generate the image.

**Returns:**
java.lang.String - The name and version of the software or firmware of the camera or image input device used to generate the image.
##### setSoftware(String value)
```
public final void setSoftware(String value)
```

Sets the name and version of the software or firmware of the camera or image input device used to generate the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name and version of the software or firmware of the camera or image input device used to generate the image. |

### FileFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/fileformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum FileFormat extends Enum<FileFormat> implements IEnumValue
```

Represents the recognized format of a loaded file.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The file type is not recognized. |
| Presentation | A presentation file. |
| Spreadsheet | A spreadsheet file. |
| WordProcessing | A word processing file. |
| Diagram | A diagram file. |
| Note | An electronic note file. |
| ProjectManagement | A project management format. |
| Pdf | A PDF file. |
| Tiff | A TIFF image. |
| Jpeg | A JPEG image. |
| Psd | A PSD image. |
| Jpeg2000 | A Jpeg2000 image. |
| Gif | A GIF image. |
| Png | A PNG image. |
| Bmp | A BMP image. |
| Dicom | A DICOM image. |
| WebP | A WEBP image. |
| Emf | An EMF image. |
| Wmf | A WMF image. |
| DjVu | A DjVu file. |
| Wav | A WAV audio file. |
| Mp3 | An Mp3 audio file. |
| Avi | An AVI video. |
| Flv | An FLV video. |
| Asf | An ASF video. |
| Mov | A QuickTime video. |
| Matroska | A video encoded with the Matroska multimedia container. |
| Zip | A ZIP archive. |
| SevenZip | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. |
| VCard | A VCard file. |
| Epub | An EPUB electronic book. |
| OpenType | An OpenType font. |
| Dxf | A DXF (Drawing Exchange Format) drawing. |
| Dwg | A DWG drawing. |
| Eml | An EML email message. |
| Msg | An MSG email message. |
| Torrent | A torrent file that contains metadata about files and folders to be distributed. |
| Heif | A HEIF/HEIC image. |
| Dng | A dng RAW image. |
| Cr2 | A CR2 image. |
| Rar | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final FileFormat Unknown
```

The file type is not recognized.

##### Presentation
```
public static final FileFormat Presentation
```

A presentation file. You must be familiar with PPTX and PPT extension files while working with Microsoft PowerPoint. These are Presentation file formats that store collection of records to accommodate presentation data such as slides, shapes, text, animations, video, audio and embedded objects. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/

##### Spreadsheet
```
public static final FileFormat Spreadsheet
```

A spreadsheet file. A spreadsheet file contains data in the form of rows and columns. You can open, view and edit such files using spreadsheet software applications such as Microsoft Excel that is now available for both Windows and MacOS operating system. Similarly, Google sheets is a free online spreadsheet creating and editing tool that works from any web browser. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/

##### WordProcessing
```
public static final FileFormat WordProcessing
```

A word processing file. A word processing file contains 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/

##### Diagram
```
public static final FileFormat Diagram
```

A diagram file.

##### Note
```
public static final FileFormat Note
```

An electronic note file. Note-taking programs such as Microsoft OneNote lets you create, open and edit notes files that contain sections and pages for storing notes. A note document can be as simple as a text document as well as more detailed consisting of digital images, audio/video clips, and hand sketch drawings. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/note-taking/

##### ProjectManagement
```
public static final FileFormat ProjectManagement
```

A project management format. Have you ever come across and wondered what is an MPP file or how to open it? MPP and other similar files are Project file formats that are created by Project Management software such as Microsoft Project. 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/project-management/

##### Pdf
```
public static final FileFormat Pdf
```

A PDF file. 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/

##### Tiff
```
public static final FileFormat Tiff
```

A TIFF image. TIFF or 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. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/tiff/

##### Jpeg
```
public static final FileFormat Jpeg
```

A JPEG image. JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/jpeg/

##### Psd
```
public static final FileFormat Psd
```

A PSD image. PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. PSD files may include image layers, adjustment layers, layer masks, annotations, file information, keywords and other Photoshop-specific elements. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/psd/

##### Jpeg2000
```
public static final FileFormat Jpeg2000
```

A Jpeg2000 image. JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/jp2/

##### Gif
```
public static final FileFormat Gif
```

A GIF image. A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/gif/

##### Png
```
public static final FileFormat Png
```

A PNG image. PNG, Portable Network Graphics, refers to a type of raster image file format that use lossless compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/png/

##### Bmp
```
public static final FileFormat Bmp
```

A BMP image. Files having extension .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/

##### Dicom
```
public static final FileFormat Dicom
```

A DICOM image. DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is the combination of file format definition and a network communications protocol. Learn more about this file format  [ here ][here] .

[here]: https://wiki.fileformat.com/image/dicom/

##### WebP
```
public static final FileFormat WebP
```

A WEBP image. 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][] .

[here]: https://wiki.fileformat.com/image/webp/

##### Emf
```
public static final FileFormat Emf
```

An EMF image. 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/

##### Wmf
```
public static final FileFormat Wmf
```

A WMF image. Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. To be more accurate, WMF belongs to the vector file format category of Graphics file formats that is device independent. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/wmf/

##### DjVu
```
public static final FileFormat DjVu
```

A DjVu file. DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. It was developed by AT&T Labs. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/image/djvu/

##### Wav
```
public static final FileFormat Wav
```

A WAV audio file. 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. The format doesn't apply any compression to the bitstream and stores the audio recordings with different sampling rates and bitrates. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/audio/wav/

##### Mp3
```
public static final FileFormat Mp3
```

An Mp3 audio file. 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. It was developed by the Moving Picture Experts Group (MPEG) that uses Layer 3 audio compression. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/audio/mp3/

##### Avi
```
public static final FileFormat Avi
```

An AVI video. 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://wiki.fileformat.com/video/avi/

##### Flv
```
public static final FileFormat Flv
```

An FLV video.

##### Asf
```
public static final FileFormat Asf
```

An ASF video. The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/video/wmv/

##### Mov
```
public static final FileFormat Mov
```

A QuickTime video. Mov or QuickTime File format is 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. Mov format is compatible both in Windows and Macintosh systems. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/video/mov/

##### Matroska
```
public static final FileFormat Matroska
```

A video encoded with the Matroska multimedia container.

##### Zip
```
public static final FileFormat Zip
```

A ZIP archive. ZIP file extension represents archives 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. ZIP file format was made public back in February 1989 by Phil Katz for achieving archiving of files and folders. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/compression/zip/

##### SevenZip
```
public static final FileFormat SevenZip
```

7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License.

##### VCard
```
public static final FileFormat VCard
```

A VCard file. 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/

##### Epub
```
public static final FileFormat Epub
```

An EPUB electronic book. Files with .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/

##### OpenType
```
public static final FileFormat OpenType
```

An OpenType font.

##### Dxf
```
public static final FileFormat Dxf
```

A DXF (Drawing Exchange Format) drawing. DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. Each element in the file has a prefix integer number called a group code. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/cad/dxf/

##### Dwg
```
public static final FileFormat Dwg
```

A DWG drawing. 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][] .

[here]: https://wiki.fileformat.com/cad/dwg/

##### Eml
```
public static final FileFormat Eml
```

An EML email message. 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/

##### Msg
```
public static final FileFormat Msg
```

An MSG email message. MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Such messages may contain one or more email fields, with the sender, recipient, subject, date, and message body, or contact information, appointment particulars, and one or more task specifications. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/email/msg/

##### Torrent
```
public static final FileFormat Torrent
```

A torrent file that contains metadata about files and folders to be distributed.

##### Heif
```
public static final FileFormat Heif
```

A HEIF/HEIC image.

##### Dng
```
public static final FileFormat Dng
```

A dng RAW image.

##### Cr2
```
public static final FileFormat Cr2
```

A CR2 image.

##### Rar
```
public static final FileFormat Rar
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.

##### Tar
```
public static final FileFormat Tar
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.

##### values()
```
public static FileFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.FileFormat[]
##### valueOf(String name)
```
public static FileFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileFormat
##### getByRawValue(int rawValue)
```
public static FileFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
FileFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### FileType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/filetype.md

**Inheritance:**
java.lang.Object
```
public class FileType
```

Represents the file type.

[Supported Document Formats]: https://docs.groupdocs.com/metadata/java/supported-document-formats/
[Get supported file formats]: https://docs.groupdocs.com/metadata/java/get-supported-file-formats/
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| TORRENT | Represents TORRENT file type. |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. |
| POT | Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. |
| XLS | Files with XLS extension represent 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 | Files with XLSM extension is a type of Spreasheet files that support Macros. |
| 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. |
| ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| 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. |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | DOCX is a well-known format for Microsoft Word documents. |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| XLSB | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. |
| TTF | TTF represents font files based on the TrueType specifications font technology. |
| TTC | TTC (TrueType Collection) is a TrueType font collection format. |
| OTF | A file with .otf extension refers to OpenType font format. |
| OTC | OTC (OpenType Collection) is a OpenType font collection format. |
| ONE | File represented by .ONE extension are created by Microsoft OneNote application. |
| ZIP | ZIP file extension represents archives that can hold one or more files or directories. |
| ZIPX | ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods. |
| JAR | JAR is a Java Archive file that contains many different application related files as a single file. |
| VCF | VCF (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| VCR | VCR (Virtual Card Format) or vCard is a digital file format for storing contact information. |
| EML | EML file format represents email messages saved using Outlook and other relevant applications. |
| MSG | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. |
| 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. |
| 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. |
| BMP | Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images. |
| 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. |
| DJV | DjVu is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. |
| GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. |
| JPG | A JPEG is a type of image format that is saved using the method of lossy compression. |
| JPE | A JPEG 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. |
| JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. |
| J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. |
| MJ2 | Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression. |
| PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. |
| TIFF | TIFF or 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. |
| TIF | TIFF or 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. |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. |
| EMF | Enhanced metafile format (EMF) stores graphical images device-independently. |
| WMF | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. |
| PSD | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. |
| MPP | MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. |
| MPT | MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. |
| VSD | VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. |
| VDX | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. |
| 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. |
| VSX | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. |
| VTX | Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. |
| DICOM | DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. |
| HEIF | An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. |
| HEIC | An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. |
| DWG | Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. |
| DXF | DXF, Drawing Interchange Format, or Drawing Exchange Format, is a tagged data representation of AutoCAD drawing file. |
| AVI | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. |
| MOV | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. |
| QT | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks, each track holds a particular type of data i.e. |
| MKA | MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. |
| 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. |
| MK3D | MK3D is actually stereoscopic 3D video created using Matroska 3D format. |
| WEBM | WEBM is a video file based on the open, royalty-free WebM file format. |
| FLV | FLV (Flash Video) is a container file format which is used to deliver audio/video content over the internet by using the Adobe Flash Player or Adobe Air. |
| ASF | The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. |
| DNG | DNG is a digital camera image format used for the storage of raw files. |
| CR2 | The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. |
| SEVENZIP | 7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. |
| RAR | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| TAR | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Gets the file type description. |
| getExtension() | Gets the file extension. |
| getFileFormat() | Gets the file format. |
| toString() | Returns a String that represents the current  FileType . |
| getSupportedFileTypes() | Retrieves supported file types. |
| fromExtension(String fileExtension) | Gets FileType for provided fileExtension |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### TORRENT
```
public static final FileType TORRENT
```

Represents TORRENT file type.

##### PDF
```
public static final FileType 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/

##### PPT
```
public static final FileType 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/

##### PPTX
```
public static final FileType 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/

##### POTX
```
public static final FileType 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/

##### PPTM
```
public static final FileType 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/

##### POTM
```
public static final FileType 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/

##### PPS
```
public static final FileType 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/

##### PPSX
```
public static final FileType 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/

##### PPSM
```
public static final FileType 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/

##### POT
```
public static final FileType POT
```

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pot/

##### XLS
```
public static final FileType XLS
```

Files with XLS extension represent 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/specification/spreadsheet/xls/

##### XLSX
```
public static final FileType 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/specification/spreadsheet/xlsx/

##### XLSM
```
public static final FileType XLSM
```

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlsm/

##### XLT
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlt/

##### ODT
```
public static final FileType ODT
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt/

##### DOT
```
public static final FileType 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/

##### DOC
```
public static final FileType 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/

##### DOCX
```
public static final FileType 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/

##### XLTX
```
public static final FileType XLTX
```

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltx/

##### DOTX
```
public static final FileType 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/

##### ODS
```
public static final FileType ODS
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ods/

##### XLTM
```
public static final FileType XLTM
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltm/

##### XLSB
```
public static final FileType 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/specification/spreadsheet/xlsb/

##### DOTM
```
public static final FileType 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/

##### DOCM
```
public static final FileType 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/

##### EPUB
```
public static final FileType EPUB
```

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/epub/

##### TTF
```
public static final FileType TTF
```

TTF represents font files based on the TrueType specifications font technology. TrueType fonts provide highest quality display on computer screens and printers without any dependency on resolution. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/ttf/

##### TTC
```
public static final FileType TTC
```

TTC (TrueType Collection) is a TrueType font collection format. A TTC file can combine the multiple font files into it. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/ttc/

##### OTF
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/font/otf/

##### OTC
```
public static final FileType OTC
```

OTC (OpenType Collection) is a OpenType font collection format. An OTC file can combine the multiple font files into it.

##### ONE
```
public static final FileType ONE
```

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/note-taking/one/

##### ZIP
```
public static final FileType ZIP
```

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/zip/

##### ZIPX
```
public static final FileType ZIPX
```

ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods.

##### JAR
```
public static final FileType JAR
```

JAR is a Java Archive file that contains many different application related files as a single file. This file format was created to reduce the speed of loading a downloaded Java Applet in browser via HTTP transaction, Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/jar/

##### VCF
```
public static final FileType 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://docs.fileformat.com/email/vcf/

##### VCR
```
public static final FileType VCR
```

VCR (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.

##### EML
```
public static final FileType EML
```

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml/

##### MSG
```
public static final FileType 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/

##### MP3
```
public static final FileType 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://wiki.fileformat.com/audio/mp3/

##### WAV
```
public static final FileType 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][].

[here]: https://wiki.fileformat.com/audio/wav/

##### BMP
```
public static final FileType BMP
```

Files having extension .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/

##### DJVU
```
public static final FileType 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/

##### DJV
```
public static final FileType DJV
```

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/

##### GIF
```
public static final FileType GIF
```

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif/

##### JPG
```
public static final FileType JPG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JPE
```
public static final FileType JPE
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JPEG
```
public static final FileType JPEG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JP2
```
public static final FileType JP2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2/

##### J2K
```
public static final FileType J2K
```

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2k/

##### JPF
```
public static final FileType JPF
```

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpf/

##### JPX
```
public static final FileType JPX
```

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpx/

##### JPM
```
public static final FileType JPM
```

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpm/

##### MJ2
```
public static final FileType MJ2
```

Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images; does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression.

##### PNG
```
public static final FileType PNG
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/png/

##### TIFF
```
public static final FileType TIFF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### TIF
```
public static final FileType TIF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### WEBP
```
public static final FileType 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][].

[here]: https://wiki.fileformat.com/image/webp/

##### EMF
```
public static final FileType EMF
```

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/emf/

##### WMF
```
public static final FileType 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/

##### PSD
```
public static final FileType 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/

##### MPP
```
public static final FileType MPP
```

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpp/

##### MPT
```
public static final FileType MPT
```

MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/project-management/mpt/

##### VSD
```
public static final FileType 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/visio/vsd/

##### VDX
```
public static final FileType VDX
```

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vdx/

##### VSDX
```
public static final FileType VSDX
```

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vsdx/

##### VSS
```
public static final FileType 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/visio/vss/

##### VSX
```
public static final FileType VSX
```

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/visio/vsx/

##### VTX
```
public static final FileType VTX
```

Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/visio/vtx/

##### DICOM
```
public static final FileType DICOM
```

DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics. DICOM is used for the integration of medical imaging devices like printers, servers, scanners etc from various vendors and also contains identification data of each patient for uniqueness. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/dicom/

##### HEIF
```
public static final FileType HEIF
```

An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file. HEIF file format compresses the images using the High Efficiency Video Coding (HEVC) standard. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/heif/

##### HEIC
```
public static final FileType HEIC
```

An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file. HEIC, like HEIF, are compressed using the High Efficiency Video Coding (HEVC) standard and are smaller in size without compromising the quality. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/heic/

##### DWG
```
public static final FileType DWG
```

Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwg/

##### DXF
```
public static final FileType 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/

##### AVI
```
public static final FileType AVI
```

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/avi/

##### MOV
```
public static final FileType MOV
```

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/

##### QT
```
public static final FileType QT
```

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/

##### MKA
```
public static final FileType MKA
```

MKA (Matroska Audio) is the Matroska multimedia container format used for Audio. The MKA format supports several different kinds of audio compression algorithms such as MP3, AAC and Vobis. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/audio/mka/

##### MKV
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/mkv/

##### MK3D
```
public static final FileType MK3D
```

MK3D is actually stereoscopic 3D video created using Matroska 3D format. The MKV file container uses a StereoMode field\\u2019s value to define the type of stereoscopic 3D video stuff. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/video/mk3d/

##### WEBM
```
public static final FileType WEBM
```

WEBM 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/

##### FLV
```
public static final FileType FLV
```

FLV (Flash Video) is a container file format which 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/

##### ASF
```
public static final FileType ASF
```

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/video/wmv/

##### DNG
```
public static final FileType 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. DNG is an extension of TIFF/EP standard format and uses metadata significantly. In order to manipulate raw data from digital cameras with the ease of flexibility and artistic control, photographers opt camera raw files. JPEG and TIFF formats store images that are processed by the camera, therefore, not much room for alteration is available in such formats. [here][].

[here]: https://wiki.fileformat.com/image/dng/

##### CR2
```
public static final FileType CR2
```

The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon. [here][].

[here]: https://wiki.fileformat.com/image/cr2/

##### SEVENZIP
```
public static final FileType SEVENZIP
```

7z is a compressed archive file format that supports several different data compression, encryption and pre-processing algorithms. The 7z format initially appeared as implemented by the 7-Zip archiver. The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License.  [here][] .

[here]: https://wiki.fileformat.com/compression/zip/

##### RAR
```
public static final FileType RAR
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.  [here][] .

[here]: https://wiki.fileformat.com/compression/rar/

##### TAR
```
public static final FileType TAR
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.  [here][] .

[here]: https://wiki.fileformat.com/compression/tar/

##### getDescription()
```
public final String getDescription()
```

Gets the file type description.

**Returns:**
java.lang.String - The file type description.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension.

**Returns:**
java.lang.String - The file extension.
##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the file format.

**Returns:**
FileFormat - The file format.
##### toString()
```
public String toString()
```

Returns a String that represents the current  FileType .

**Returns:**
java.lang.String - A String that represents the current  FileType .
##### getSupportedFileTypes()
```
public static Iterable<FileType> getSupportedFileTypes()
```

Retrieves supported file types.

**Returns:**
java.lang.Iterable<com.groupdocs.metadata.core.FileType> - A collection of supported file types.
##### 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

### FileTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/filetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class FileTypePackage extends CustomPackage
```

Represents a metadata package containing file format information.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
[Supported file formats]: https://docs.groupdocs.com/display/metadatajava/Supported+File+Formats
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets the file format. |
| getMimeType() | Gets the MIME type. |
| getExtension() | Gets the file extension. |
##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the file format.

**Returns:**
FileFormat - The file format.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type.

**Returns:**
java.lang.String - The MIME type value.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension.

**Returns:**
java.lang.String - The file extension.

### FlvHeader
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/flvheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class FlvHeader extends CustomPackage
```

Represents a FLV video header.

[Working with metadata in FLV files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+FLV+files
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the file version. |
| getTypeFlags() | Gets the FLV type flags. |
| hasAudioTags() | Gets a value indicating whether audio tags are present in the file. |
| hasVideoTags() | Gets a value indicating whether video tags are present in the file. |
##### getVersion()
```
public final byte getVersion()
```

Gets the file version.

**Returns:**
byte - The file version.
##### getTypeFlags()
```
public final byte getTypeFlags()
```

Gets the FLV type flags.

**Returns:**
byte - The FLV type flags.
##### hasAudioTags()
```
public final boolean hasAudioTags()
```

Gets a value indicating whether audio tags are present in the file.

**Returns:**
boolean - True if the FLV file contains audio tags; otherwise, false.
##### hasVideoTags()
```
public final boolean hasVideoTags()
```

Gets a value indicating whether video tags are present in the file.

**Returns:**
boolean - True if the FLV file contains video tags; otherwise, false.

### FlvRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/flvrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class FlvRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an FLV video.

This example shows how to read FLV header properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputFlv)) {
>      FlvRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getHeader().getVersion());
>      System.out.println(root.getHeader().hasAudioTags());
>      System.out.println(root.getHeader().hasVideoTags());
>      System.out.println(root.getHeader().getTypeFlags());
>  }
>
> ```
> ```

[Working with metadata in FLV files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+FLV+files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getHeader() | Gets the FLV header package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getHeader()
```
public final FlvHeader getHeader()
```

Gets the FLV header package.

**Returns:**
FlvHeader - The FLV header package.

### GifImageTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/gifimagetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage, com.groupdocs.metadata.core.ImageTypePackage
```
public class GifImageTypePackage extends ImageTypePackage
```

Represents a metadata package containing GIF-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the format. |
##### getVersion()
```
public final String getVersion()
```

Gets the version of the format.

**Returns:**
java.lang.String - The version of the format.

### GifRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/gifrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class GifRootPackage extends ImageRootPackage implements IXmp
```

Represents the root package intended to work with metadata in a GIF image.

This code snippet shows how to detect the version of a loaded GIF image and extract some additional file format information.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputGif)) {
>      GifRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getGifImageType().getFileFormat());
>      System.out.println(root.getGifImageType().getVersion());
>      System.out.println(root.getGifImageType().getByteOrder());
>      System.out.println(root.getGifImageType().getMimeType());
>      System.out.println(root.getGifImageType().getExtension());
>      System.out.println(root.getGifImageType().getWidth());
>      System.out.println(root.getGifImageType().getHeight());
>  }
>
> ```
> ```

[Working with metadata in GIF images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+GIF+images
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGifImageType() | Gets the file type metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| isXmpSupported() | Gets a value indicating whether the XMP metadata is supported for this image. |
##### getGifImageType()
```
public final GifImageTypePackage getGifImageType()
```

Gets the file type metadata package.

**Returns:**
GifImageTypePackage - The file type metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### isXmpSupported()
```
public final boolean isXmpSupported()
```

Gets a value indicating whether the XMP metadata is supported for this image.

**Returns:**
boolean - True if the XMP metadata is supported for this image; otherwise, false.

### GpsIfdPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/gpsifdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class GpsIfdPackage extends RawDictionaryBasePackage
```

Represents GPS IFD.
#### Methods

| Method | Description |
| --- | --- |
| getGPSVersionID() | Gets the GPSVersionID. |
| getGPSLatitudeRef() | Gets the GPSLatitudeRef. |
| getGPSLatitude() | Gets the GPSLatitude. |
| getGPSLongitudeRef() | Gets the GPSLongitudeRef. |
| getGPSLongitude() | Gets the GPSLongitude. |
| getGPSAltitudeRef() | Gets the GPSAltitudeRef. |
| getGPSAltitude() | Gets the GPSAltitude. |
| getGPSTimeStamp() | Gets the GPSTimeStamp. |
| getGPSSatellites() | Gets the GPSSatellites. |
| getGPSStatus() | Gets the GPSStatus. |
| getGPSMeasureMode() | Gets the GPSMeasureMode. |
| getGPSDOP() | Gets the GPSDOP. |
| getGPSSpeedRef() | Gets the GPSSpeedRef. |
| getGPSSpeed() | Gets the GPSSpeed. |
| getGPSTrackRef() | Gets the GPSTrackRef. |
| getGPSTrack() | Gets the GPSTrack. |
| getGPSImgDirectionRef() | Gets the GPSImgDirectionRef. |
| getGPSImgDirection() | Gets the GPSImgDirection. |
| getGPSMapDatum() | Gets the GPSMapDatum. |
| getGPSDestLatitudeRef() | Gets the GPSDestLatitudeRef. |
| getGPSDestLatitude() | Gets the GPSDestLatitude. |
| getGPSDestLongitudeRef() | Gets the GPSDestLongitudeRef. |
| getGPSDestLongitude() | Gets the GPSDestLongitude. |
| getGPSDestBearingRef() | Gets the GPSDestBearingRef. |
| getGPSDestBearing() | Gets the GPSDestBearing. |
| getGPSDestDistanceRef() | Gets the GPSDestDistanceRef. |
| getGPSDestDistance() | Gets the GPSDestDistance. |
| getGPSProcessingMethod() | Gets the GPSProcessingMethod. |
| getGPSAreaInformation() | Gets the GPSAreaInformation. |
| getGPSDateStamp() | Gets the GPSDateStamp. |
| getGPSDifferential() | Gets the GPSDifferential. |
| getGPSHPositioningError() | Gets the GPSHPositioningError. |
##### getGPSVersionID()
```
public final byte[] getGPSVersionID()
```

Gets the GPSVersionID.

**Returns:**
byte[] - The GPSVersionID.
##### getGPSLatitudeRef()
```
public final String getGPSLatitudeRef()
```

Gets the GPSLatitudeRef.

**Returns:**
java.lang.String - The GPSLatitudeRef.
##### getGPSLatitude()
```
public final double[] getGPSLatitude()
```

Gets the GPSLatitude.

**Returns:**
double[] - The GPSLatitude.
##### getGPSLongitudeRef()
```
public final String getGPSLongitudeRef()
```

Gets the GPSLongitudeRef.

**Returns:**
java.lang.String - The GPSLongitudeRef.
##### getGPSLongitude()
```
public final double[] getGPSLongitude()
```

Gets the GPSLongitude.

**Returns:**
double[] - The GPSLongitude.
##### getGPSAltitudeRef()
```
public final byte getGPSAltitudeRef()
```

Gets the GPSAltitudeRef.

**Returns:**
byte - The GPSAltitudeRef.
##### getGPSAltitude()
```
public final float getGPSAltitude()
```

Gets the GPSAltitude.

**Returns:**
float - The GPSAltitude.
##### getGPSTimeStamp()
```
public final double[] getGPSTimeStamp()
```

Gets the GPSTimeStamp.

**Returns:**
double[] - The GPSTimeStamp.
##### getGPSSatellites()
```
public final String getGPSSatellites()
```

Gets the GPSSatellites.

**Returns:**
java.lang.String - The GPSSatellites.
##### getGPSStatus()
```
public final String getGPSStatus()
```

Gets the GPSStatus.

**Returns:**
java.lang.String - The GPSStatus.
##### getGPSMeasureMode()
```
public final String getGPSMeasureMode()
```

Gets the GPSMeasureMode.

**Returns:**
java.lang.String - The GPSMeasureMode.
##### getGPSDOP()
```
public final float getGPSDOP()
```

Gets the GPSDOP.

**Returns:**
float - The GPSDOP.
##### getGPSSpeedRef()
```
public final String getGPSSpeedRef()
```

Gets the GPSSpeedRef.

**Returns:**
java.lang.String - The GPSSpeedRef.
##### getGPSSpeed()
```
public final float getGPSSpeed()
```

Gets the GPSSpeed.

**Returns:**
float - The GPSSpeed.
##### getGPSTrackRef()
```
public final String getGPSTrackRef()
```

Gets the GPSTrackRef.

**Returns:**
java.lang.String - The GPSTrackRef.
##### getGPSTrack()
```
public final float getGPSTrack()
```

Gets the GPSTrack.

**Returns:**
float - The GPSTrack.
##### getGPSImgDirectionRef()
```
public final String getGPSImgDirectionRef()
```

Gets the GPSImgDirectionRef.

**Returns:**
java.lang.String - The GPSImgDirectionRef.
##### getGPSImgDirection()
```
public final float getGPSImgDirection()
```

Gets the GPSImgDirection.

**Returns:**
float - The GPSImgDirection.
##### getGPSMapDatum()
```
public final String getGPSMapDatum()
```

Gets the GPSMapDatum.

**Returns:**
java.lang.String - The GPSMapDatum.
##### getGPSDestLatitudeRef()
```
public final String getGPSDestLatitudeRef()
```

Gets the GPSDestLatitudeRef.

**Returns:**
java.lang.String - The GPSDestLatitudeRef.
##### getGPSDestLatitude()
```
public final double[] getGPSDestLatitude()
```

Gets the GPSDestLatitude.

**Returns:**
double[] - The GPSDestLatitude.
##### getGPSDestLongitudeRef()
```
public final String getGPSDestLongitudeRef()
```

Gets the GPSDestLongitudeRef.

**Returns:**
java.lang.String - The GPSDestLongitudeRef.
##### getGPSDestLongitude()
```
public final double[] getGPSDestLongitude()
```

Gets the GPSDestLongitude.

**Returns:**
double[] - The GPSDestLongitude.
##### getGPSDestBearingRef()
```
public final String getGPSDestBearingRef()
```

Gets the GPSDestBearingRef.

**Returns:**
java.lang.String - The GPSDestBearingRef.
##### getGPSDestBearing()
```
public final float getGPSDestBearing()
```

Gets the GPSDestBearing.

**Returns:**
float - The GPSDestBearing.
##### getGPSDestDistanceRef()
```
public final String getGPSDestDistanceRef()
```

Gets the GPSDestDistanceRef.

**Returns:**
java.lang.String - The GPSDestDistanceRef.
##### getGPSDestDistance()
```
public final float getGPSDestDistance()
```

Gets the GPSDestDistance.

**Returns:**
float - The GPSDestDistance.
##### getGPSProcessingMethod()
```
public final String getGPSProcessingMethod()
```

Gets the GPSProcessingMethod.

**Returns:**
java.lang.String - The GPSProcessingMethod.
##### getGPSAreaInformation()
```
public final int getGPSAreaInformation()
```

Gets the GPSAreaInformation.

**Returns:**
int - The GPSAreaInformation.
##### getGPSDateStamp()
```
public final String getGPSDateStamp()
```

Gets the GPSDateStamp.

**Returns:**
java.lang.String - The GPSDateStamp.
##### getGPSDifferential()
```
public final int getGPSDifferential()
```

Gets the GPSDifferential.

**Returns:**
int - The GPSDifferential.
##### getGPSHPositioningError()
```
public final float getGPSHPositioningError()
```

Gets the GPSHPositioningError.

**Returns:**
float - The GPSHPositioningError.

### GroupDocsMetadataException
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/groupdocsmetadataexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception
```
public class GroupDocsMetadataException extends System.Exception
```

Represents a product-specific exception that is thrown during file processing.
#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsMetadataException() | Initializes a new instance of the  GroupDocsMetadataException  class. |
| GroupDocsMetadataException(String message) | Initializes a new instance of the  GroupDocsMetadataException  class. |
| GroupDocsMetadataException(String message, RuntimeException innerException) | Initializes a new instance of the  GroupDocsMetadataException  class. |
##### GroupDocsMetadataException()
```
public GroupDocsMetadataException()
```

Initializes a new instance of the  GroupDocsMetadataException  class.

##### GroupDocsMetadataException(String message)
```
public GroupDocsMetadataException(String message)
```

Initializes a new instance of the  GroupDocsMetadataException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### GroupDocsMetadataException(String message, RuntimeException innerException)
```
public GroupDocsMetadataException(String message, RuntimeException innerException)
```

Initializes a new instance of the  GroupDocsMetadataException  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. |

### HeifRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/heifrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class HeifRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a HEIF image.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

### ID3Tag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class ID3Tag extends CustomPackage
```

Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the ID3 tag in string format. |
##### getVersion()
```
public abstract String getVersion()
```

Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'.

**Returns:**
java.lang.String - The ID3 version.

### ID3V1Genre
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v1genre.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ID3V1Genre implements IEnumValue
```

Specifies genres used in an Id3v1 tag.
#### Fields

| Field | Description |
| --- | --- |
| Blues | Represents the Blues genre. |
| ClassicRock | Represents the Classic Rock genre. |
| Country | Represents the Country genre. |
| Dance | Represents the Dance genre. |
| Disco | Represents the Disco genre. |
| Funk | Represents the Funk genre. |
| Grunge | Represents the Grunge genre. |
| HipHop | Represents the Hip-Hop genre. |
| Jazz | Represents the Jazz genre. |
| Metal | Represents the Metal genre. |
| NewAge | Represents the New Age genre. |
| Oldies | Represents the Oldies genre. |
| Other | Represents the Other genre. |
| Pop | Represents the Pop genre. |
| RhythmAndBlues | Represents the Rhythm and Blues genre. |
| Rap | Represents the Rap genre. |
| Reggae | Represents the Reggae genre. |
| Rock | Represents the Rock genre. |
| Techno | Represents the Techno genre. |
| Industrial | Represents the Industrial genre. |
| Alternative | Represents the Alternative genre. |
| Ska | Represents the Ska genre. |
| DeathMetal | Represents the Death Metal genre. |
| Pranks | Represents the Pranks genre. |
| Soundtrack | Represents the Soundtrack genre. |
| EuroTechno | Represents the Euro-Techno genre. |
| Ambient | Represents the Ambient genre. |
| TripHop | Represents the Trip-Hop genre. |
| Vocal | Represents the Vocal genre. |
| JazzAndFunk | Represents the JazzAndFunk genre. |
| Fusion | Represents the Fusion genre. |
| Trance | Represents the Trance genre. |
| Classical | Represents the Classical genre. |
| Instrumental | Represents the Instrumental genre. |
| Acid | Represents the Acid genre. |
| House | Represents the House genre. |
| Game | Represents the Game genre. |
| SoundClip | Represents the Sound Clip genre. |
| Gospel | Represents the Gospel genre. |
| Noise | Represents the Noise genre. |
| AlternativeRock | Represents the Alternative Rock genre. |
| Bass | Represents the Bass genre. |
| Soul | Represents the Soul genre. |
| Punk | Represents the Punk genre. |
| Space | Represents the Space genre. |
| Meditative | Represents the Meditative genre. |
| InstrumentalPop | Represents the Instrumental Pop genre. |
| InstrumentalRock | Represents the Instrumental Rock genre. |
| Ethnic | Represents the Ethnic genre. |
| Gothic | Represents the Gothic genre. |
| Darkwave | Represents the Darkwave genre. |
| TechnoIndustrial | Represents the Techno-Industrial genre. |
| Electronic | Represents the Electronic genre. |
| PopFolk | Represents the Pop-Folk genre. |
| Eurodance | Represents the Eurodance genre. |
| Dream | Represents the Dream genre. |
| SouthernRock | Represents the Southern Rock genre. |
| Comedy | Represents the Comedy genre. |
| Cult | Represents the Cult genre. |
| Gangsta | Represents the Gangsta genre. |
| Top40 | Represents the Top 40 genre. |
| ChristianRap | Represents the Christian Rap genre. |
| PopFunk | Represents the Pop/Funk genre. |
| Jungle | Represents the Jungle genre. |
| NativeAmerican | Represents the Native American genre. |
| Cabaret | Represents the Cabaret genre. |
| NewWave | Represents the New Wave genre. |
| Psychedelic | Represents the Psychedelic genre. |
| Rave | Represents the Rave genre. |
| Showtunes | Represents the Showtunes genre. |
| Trailer | Represents the Trailer genre. |
| LoFi | Represents the Lo-Fi genre. |
| Tribal | Represents the Tribal genre. |
| AcidPunk | Represents the Acid Punk genre. |
| AcidJazz | Represents the Acid Jazz genre. |
| Polka | Represents the Polka genre. |
| Retro | Represents the Retro genre. |
| Musical | Represents the Musical genre. |
| RockNRoll | Represents the Rock 'n' Roll genre. |
| HardRock | Represents the Hard Rock genre. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Blues
```
public static final ID3V1Genre Blues
```

Represents the Blues genre.

##### ClassicRock
```
public static final ID3V1Genre ClassicRock
```

Represents the Classic Rock genre.

##### Country
```
public static final ID3V1Genre Country
```

Represents the Country genre.

##### Dance
```
public static final ID3V1Genre Dance
```

Represents the Dance genre.

##### Disco
```
public static final ID3V1Genre Disco
```

Represents the Disco genre.

##### Funk
```
public static final ID3V1Genre Funk
```

Represents the Funk genre.

##### Grunge
```
public static final ID3V1Genre Grunge
```

Represents the Grunge genre.

##### HipHop
```
public static final ID3V1Genre HipHop
```

Represents the Hip-Hop genre.

##### Jazz
```
public static final ID3V1Genre Jazz
```

Represents the Jazz genre.

##### Metal
```
public static final ID3V1Genre Metal
```

Represents the Metal genre.

##### NewAge
```
public static final ID3V1Genre NewAge
```

Represents the New Age genre.

##### Oldies
```
public static final ID3V1Genre Oldies
```

Represents the Oldies genre.

##### Other
```
public static final ID3V1Genre Other
```

Represents the Other genre.

##### Pop
```
public static final ID3V1Genre Pop
```

Represents the Pop genre.

##### RhythmAndBlues
```
public static final ID3V1Genre RhythmAndBlues
```

Represents the Rhythm and Blues genre.

##### Rap
```
public static final ID3V1Genre Rap
```

Represents the Rap genre.

##### Reggae
```
public static final ID3V1Genre Reggae
```

Represents the Reggae genre.

##### Rock
```
public static final ID3V1Genre Rock
```

Represents the Rock genre.

##### Techno
```
public static final ID3V1Genre Techno
```

Represents the Techno genre.

##### Industrial
```
public static final ID3V1Genre Industrial
```

Represents the Industrial genre.

##### Alternative
```
public static final ID3V1Genre Alternative
```

Represents the Alternative genre.

##### Ska
```
public static final ID3V1Genre Ska
```

Represents the Ska genre.

##### DeathMetal
```
public static final ID3V1Genre DeathMetal
```

Represents the Death Metal genre.

##### Pranks
```
public static final ID3V1Genre Pranks
```

Represents the Pranks genre.

##### Soundtrack
```
public static final ID3V1Genre Soundtrack
```

Represents the Soundtrack genre.

##### EuroTechno
```
public static final ID3V1Genre EuroTechno
```

Represents the Euro-Techno genre.

##### Ambient
```
public static final ID3V1Genre Ambient
```

Represents the Ambient genre.

##### TripHop
```
public static final ID3V1Genre TripHop
```

Represents the Trip-Hop genre.

##### Vocal
```
public static final ID3V1Genre Vocal
```

Represents the Vocal genre.

##### JazzAndFunk
```
public static final ID3V1Genre JazzAndFunk
```

Represents the JazzAndFunk genre.

##### Fusion
```
public static final ID3V1Genre Fusion
```

Represents the Fusion genre.

##### Trance
```
public static final ID3V1Genre Trance
```

Represents the Trance genre.

##### Classical
```
public static final ID3V1Genre Classical
```

Represents the Classical genre.

##### Instrumental
```
public static final ID3V1Genre Instrumental
```

Represents the Instrumental genre.

##### Acid
```
public static final ID3V1Genre Acid
```

Represents the Acid genre.

##### House
```
public static final ID3V1Genre House
```

Represents the House genre.

##### Game
```
public static final ID3V1Genre Game
```

Represents the Game genre.

##### SoundClip
```
public static final ID3V1Genre SoundClip
```

Represents the Sound Clip genre.

##### Gospel
```
public static final ID3V1Genre Gospel
```

Represents the Gospel genre.

##### Noise
```
public static final ID3V1Genre Noise
```

Represents the Noise genre.

##### AlternativeRock
```
public static final ID3V1Genre AlternativeRock
```

Represents the Alternative Rock genre.

##### Bass
```
public static final ID3V1Genre Bass
```

Represents the Bass genre.

##### Soul
```
public static final ID3V1Genre Soul
```

Represents the Soul genre.

##### Punk
```
public static final ID3V1Genre Punk
```

Represents the Punk genre.

##### Space
```
public static final ID3V1Genre Space
```

Represents the Space genre.

##### Meditative
```
public static final ID3V1Genre Meditative
```

Represents the Meditative genre.

##### InstrumentalPop
```
public static final ID3V1Genre InstrumentalPop
```

Represents the Instrumental Pop genre.

##### InstrumentalRock
```
public static final ID3V1Genre InstrumentalRock
```

Represents the Instrumental Rock genre.

##### Ethnic
```
public static final ID3V1Genre Ethnic
```

Represents the Ethnic genre.

##### Gothic
```
public static final ID3V1Genre Gothic
```

Represents the Gothic genre.

##### Darkwave
```
public static final ID3V1Genre Darkwave
```

Represents the Darkwave genre.

##### TechnoIndustrial
```
public static final ID3V1Genre TechnoIndustrial
```

Represents the Techno-Industrial genre.

##### Electronic
```
public static final ID3V1Genre Electronic
```

Represents the Electronic genre.

##### PopFolk
```
public static final ID3V1Genre PopFolk
```

Represents the Pop-Folk genre.

##### Eurodance
```
public static final ID3V1Genre Eurodance
```

Represents the Eurodance genre.

##### Dream
```
public static final ID3V1Genre Dream
```

Represents the Dream genre.

##### SouthernRock
```
public static final ID3V1Genre SouthernRock
```

Represents the Southern Rock genre.

##### Comedy
```
public static final ID3V1Genre Comedy
```

Represents the Comedy genre.

##### Cult
```
public static final ID3V1Genre Cult
```

Represents the Cult genre.

##### Gangsta
```
public static final ID3V1Genre Gangsta
```

Represents the Gangsta genre.

##### Top40
```
public static final ID3V1Genre Top40
```

Represents the Top 40 genre.

##### ChristianRap
```
public static final ID3V1Genre ChristianRap
```

Represents the Christian Rap genre.

##### PopFunk
```
public static final ID3V1Genre PopFunk
```

Represents the Pop/Funk genre.

##### Jungle
```
public static final ID3V1Genre Jungle
```

Represents the Jungle genre.

##### NativeAmerican
```
public static final ID3V1Genre NativeAmerican
```

Represents the Native American genre.

##### Cabaret
```
public static final ID3V1Genre Cabaret
```

Represents the Cabaret genre.

##### NewWave
```
public static final ID3V1Genre NewWave
```

Represents the New Wave genre.

##### Psychedelic
```
public static final ID3V1Genre Psychedelic
```

Represents the Psychedelic genre.

##### Rave
```
public static final ID3V1Genre Rave
```

Represents the Rave genre.

##### Showtunes
```
public static final ID3V1Genre Showtunes
```

Represents the Showtunes genre.

##### Trailer
```
public static final ID3V1Genre Trailer
```

Represents the Trailer genre.

##### LoFi
```
public static final ID3V1Genre LoFi
```

Represents the Lo-Fi genre.

##### Tribal
```
public static final ID3V1Genre Tribal
```

Represents the Tribal genre.

##### AcidPunk
```
public static final ID3V1Genre AcidPunk
```

Represents the Acid Punk genre.

##### AcidJazz
```
public static final ID3V1Genre AcidJazz
```

Represents the Acid Jazz genre.

##### Polka
```
public static final ID3V1Genre Polka
```

Represents the Polka genre.

##### Retro
```
public static final ID3V1Genre Retro
```

Represents the Retro genre.

##### Musical
```
public static final ID3V1Genre Musical
```

Represents the Musical genre.

##### RockNRoll
```
public static final ID3V1Genre RockNRoll
```

Represents the Rock 'n' Roll genre.

##### HardRock
```
public static final ID3V1Genre HardRock
```

Represents the Hard Rock genre.

##### getByRawValue(int rawValue)
```
public static ID3V1Genre getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ID3V1Genre
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### ID3V1Tag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v1tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3Tag
```
public final class ID3V1Tag extends ID3Tag
```

Represents an ID3v1 tag. Please find more information at  [https://en.wikipedia.org/wiki/ID3\#ID3v1][https_en.wikipedia.org_wiki_ID3_ID3v1] .

ID3(v1) tag is a small chunk of extra data at the end of MP3. Please find more information at  http://id3.org/ID3v1 .

This code sample shows how to read the ID3v1 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V1)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getID3V1() != null) {
>          System.out.println(root.getID3V1().getAlbum());
>          System.out.println(root.getID3V1().getArtist());
>          System.out.println(root.getID3V1().getTitle());
>          System.out.println(root.getID3V1().getVersion());
>          System.out.println(root.getID3V1().getComment());
>          // ...
>      }
>  }
>
> ```
> ```

[https_en.wikipedia.org_wiki_ID3_ID3v1]: https://en.wikipedia.org/wiki/ID3#ID3v1
[Handling the ID3v1 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v1+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V1Tag() | Initializes a new instance of the  ID3V1Tag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the ID3 version. |
| getArtist() | Gets the artist. |
| setArtist(String value) | Sets the artist. |
| getAlbum() | Gets the album. |
| setAlbum(String value) | Sets the album. |
| getGenreValue() | Gets the genre identifier. |
| getComment() | Gets the comment. |
| setComment(String value) | Sets the comment. |
| getTitle() | Gets the title. |
| setTitle(String value) | Sets the title. |
| getYear() | Gets the year. |
| setYear(String value) | Sets the year. |
| getTrackNumber() | Gets the track number. |
| setTrackNumber(Integer value) | Sets the track number. |
##### ID3V1Tag()
```
public ID3V1Tag()
```

Initializes a new instance of the  ID3V1Tag  class.

##### getVersion()
```
public String getVersion()
```

Gets the ID3 version. It can be ID3 or ID3v1.1

**Returns:**
java.lang.String - The ID3 version.
##### getArtist()
```
public final String getArtist()
```

Gets the artist. Maximum length is 30 characters.

**Returns:**
java.lang.String - The artist.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the artist. Maximum length is 30 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The artist. |

##### getAlbum()
```
public final String getAlbum()
```

Gets the album. Maximum length is 30 characters.

**Returns:**
java.lang.String - The album.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the album. Maximum length is 30 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The album. |

##### getGenreValue()
```
public final ID3V1Genre getGenreValue()
```

Gets the genre identifier.

**Returns:**
ID3V1Genre - The genre identifier.
##### getComment()
```
public final String getComment()
```

Gets the comment. Maximum length is 30 characters.

**Returns:**
java.lang.String - The comment.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the comment. Maximum length is 30 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comment. |

##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title. |

##### getYear()
```
public final String getYear()
```

Gets the year. Maximum length is 4 characters.

**Returns:**
java.lang.String - The year.
##### setYear(String value)
```
public final void setYear(String value)
```

Sets the year. Maximum length is 4 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The year. |

##### getTrackNumber()
```
public final Integer getTrackNumber()
```

Gets the track number. Presented in a ID3v1.1 tag only.

**Returns:**
java.lang.Integer - The track number.

If the value of  TrackNumber  is a positive integer then ID3 changes version to 'ID3v1.1' automatically.
##### setTrackNumber(Integer value)
```
public final void setTrackNumber(Integer value)
```

Sets the track number. Presented in a ID3v1.1 tag only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The track number.

If the value of  TrackNumber  is a positive integer then ID3 changes version to 'ID3v1.1' automatically. |

### ID3V2AttachedPictureFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2attachedpictureframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2AttachedPictureFrame extends ID3V2TagFrame
```

Represents an APIC frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
| ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
| ID3V2AttachedPictureFrame(byte[] pictureData) | Initializes a new instance of the  ID3V2AttachedPictureFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDescriptionEncoding() | Gets the encoding used to encode the picture description. |
| getMimeType() | Gets the MIME type of the picture. |
| getAttachedPictureType() | Gets the type of the picture. |
| getDescription() | Gets the picture description. |
| getPictureData() | Gets the picture data. |
##### ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```
public ID3V2AttachedPictureFrame(ID3V2EncodingType encoding, String mimeType, ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The frame encoding. |
| mimeType | java.lang.String | The MIME-type of the image. |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | java.lang.String | The description of the picture. |
| pictureData | byte[] | The picture data. |

##### ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```
public ID3V2AttachedPictureFrame(ID3V2AttachedPictureType pictureType, String description, byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pictureType | ID3V2AttachedPictureType | The type of the picture. |
| description | java.lang.String | The description of the picture. |
| pictureData | byte[] | The picture data. |

##### ID3V2AttachedPictureFrame(byte[] pictureData)
```
public ID3V2AttachedPictureFrame(byte[] pictureData)
```

Initializes a new instance of the  ID3V2AttachedPictureFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pictureData | byte[] | The picture data. |

##### getDescriptionEncoding()
```
public final ID3V2EncodingType getDescriptionEncoding()
```

Gets the encoding used to encode the picture description.

**Returns:**
ID3V2EncodingType - The encoding used to encode the picture description.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type of the picture.

**Returns:**
java.lang.String - The MIME type of the picture.
##### getAttachedPictureType()
```
public final ID3V2AttachedPictureType getAttachedPictureType()
```

Gets the type of the picture.

**Returns:**
ID3V2AttachedPictureType - The type of the picture.
##### getDescription()
```
public final String getDescription()
```

Gets the picture description. The description has a maximum length of 64 characters, but may be empty.

**Returns:**
java.lang.String - The picture description.
##### getPictureData()
```
public final byte[] getPictureData()
```

Gets the picture data.

**Returns:**
byte[] - The picture data.

### ID3V2AttachedPictureType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2attachedpicturetype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ID3V2AttachedPictureType implements IEnumValue
```

Represents the type of an attached picture.
#### Fields

| Field | Description |
| --- | --- |
| Other | Attached picture of any other type. |
| FileIcon32X32 | 32x32 pixels file icon (PNG only). |
| OtherFileIcon | Other file icon. |
| CoverFront | Cover (front). |
| CoverBack | Cover (back). |
| LeafletPage | Leaflet page. |
| Media | Media (e.g. |
| LeadArtist | Lead artist/lead performer/soloist. |
| Artist | Artist/performer. |
| Conductor | Conductor. |
| Band | Band/Orchestra. |
| Composer | Composer/music author. |
| Lyricist | Lyricist/text writer. |
| RecordingLocation | Recording Location. |
| DuringRecording | During recording. |
| DuringPerformance | During performance. |
| VideoScreenCapture | Movie/video screen capture. |
| BrightColouredFish | A bright coloured fish. |
| Illustration | Illustration. |
| ArtistLogo | Band/artist logotype. |
| StudioLogo | Publisher/Studio logotype. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Other
```
public static final ID3V2AttachedPictureType Other
```

Attached picture of any other type.

##### FileIcon32X32
```
public static final ID3V2AttachedPictureType FileIcon32X32
```

32x32 pixels file icon (PNG only).

##### OtherFileIcon
```
public static final ID3V2AttachedPictureType OtherFileIcon
```

Other file icon.

##### CoverFront
```
public static final ID3V2AttachedPictureType CoverFront
```

Cover (front).

##### CoverBack
```
public static final ID3V2AttachedPictureType CoverBack
```

Cover (back).

##### LeafletPage
```
public static final ID3V2AttachedPictureType LeafletPage
```

Leaflet page.

##### Media
```
public static final ID3V2AttachedPictureType Media
```

Media (e.g. label side of CD).

##### LeadArtist
```
public static final ID3V2AttachedPictureType LeadArtist
```

Lead artist/lead performer/soloist.

##### Artist
```
public static final ID3V2AttachedPictureType Artist
```

Artist/performer.

##### Conductor
```
public static final ID3V2AttachedPictureType Conductor
```

Conductor.

##### Band
```
public static final ID3V2AttachedPictureType Band
```

Band/Orchestra.

##### Composer
```
public static final ID3V2AttachedPictureType Composer
```

Composer/music author.

##### Lyricist
```
public static final ID3V2AttachedPictureType Lyricist
```

Lyricist/text writer.

##### RecordingLocation
```
public static final ID3V2AttachedPictureType RecordingLocation
```

Recording Location.

##### DuringRecording
```
public static final ID3V2AttachedPictureType DuringRecording
```

During recording.

##### DuringPerformance
```
public static final ID3V2AttachedPictureType DuringPerformance
```

During performance.

##### VideoScreenCapture
```
public static final ID3V2AttachedPictureType VideoScreenCapture
```

Movie/video screen capture.

##### BrightColouredFish
```
public static final ID3V2AttachedPictureType BrightColouredFish
```

A bright coloured fish.

##### Illustration
```
public static final ID3V2AttachedPictureType Illustration
```

Illustration.

##### ArtistLogo
```
public static final ID3V2AttachedPictureType ArtistLogo
```

Band/artist logotype.

##### StudioLogo
```
public static final ID3V2AttachedPictureType StudioLogo
```

Publisher/Studio logotype.

##### getByRawValue(int rawValue)
```
public static ID3V2AttachedPictureType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ID3V2AttachedPictureType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### ID3V2CommentFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2commentframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2CommentFrame extends ID3V2TagFrame
```

Represents a COMM frame in an  ID3V2Tag .

This frame is intended for any kind of full text information that does not fit in any other frame.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text) | Initializes a new instance of the  ID3V2CommentFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCommentEncoding() | Gets the encoding of the comment. |
| getLanguage() | Gets the language of the comment (3 characters). |
| getShortContentDescription() | Gets the short content description. |
| getText() | Gets the text of the comment. |
##### ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text)
```
public ID3V2CommentFrame(ID3V2EncodingType encoding, String language, String description, String text)
```

Initializes a new instance of the  ID3V2CommentFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the comment. |
| language | java.lang.String | The language of the comment. |
| description | java.lang.String | A short content description. |
| text | java.lang.String | The text of the comment. |

##### getCommentEncoding()
```
public final ID3V2EncodingType getCommentEncoding()
```

Gets the encoding of the comment.

**Returns:**
ID3V2EncodingType - The encoding of the comment.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the comment (3 characters).

**Returns:**
java.lang.String - The language of the comment.
##### getShortContentDescription()
```
public final String getShortContentDescription()
```

Gets the short content description.

**Returns:**
java.lang.String - The short content description.
##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The text of the comment.

### ID3V2EncodingType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2encodingtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ID3V2EncodingType extends Enum<ID3V2EncodingType> implements IEnumValue
```

Defines different types of text encoding used in ID3v2.
#### Fields

| Field | Description |
| --- | --- |
| Iso88591 | The ISO-8859-1 encoding. |
| Utf16 | The UTF-16 encoding with BOM. |
| Utf16Be | The UTF-16 encoding without BOM. |
| Utf8 | The UTF-8 encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Iso88591
```
public static final ID3V2EncodingType Iso88591
```

The ISO-8859-1 encoding.

##### Utf16
```
public static final ID3V2EncodingType Utf16
```

The UTF-16 encoding with BOM.

##### Utf16Be
```
public static final ID3V2EncodingType Utf16Be
```

The UTF-16 encoding without BOM.

##### Utf8
```
public static final ID3V2EncodingType Utf8
```

The UTF-8 encoding.

##### values()
```
public static ID3V2EncodingType[] values()
```

**Returns:**
com.groupdocs.metadata.core.ID3V2EncodingType[]
##### valueOf(String name)
```
public static ID3V2EncodingType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ID3V2EncodingType
##### getByRawValue(int rawValue)
```
public static ID3V2EncodingType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ID3V2EncodingType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ID3V2MlltFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2mlltframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2MlltFrame extends ID3V2TagFrame
```

Represents an MLLT frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag

### ID3V2PlayCounterFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2playcounterframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2PlayCounterFrame extends ID3V2TagFrame
```

Represents a PCNT frame in an  ID3V2Tag . This is simply a counter of the number of times a file has been played.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the number of times the file has been played. |
##### getValue()
```
public final long getValue()
```

Gets the number of times the file has been played.

**Returns:**
long - The number of times the file has been played.

### ID3V2PrivateFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2privateframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2PrivateFrame extends ID3V2TagFrame
```

Represents a PRIV frame in an  ID3V2Tag . The frame is used to contain information from a software producer that its program uses and does not fit into the other frames.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2PrivateFrame(String ownerIdentifier, byte[] data) | Initializes a new instance of the  ID3V2PrivateFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getOwnerIdentifier() | Gets the owner identifier. |
| getBinaryData() | Gets the binary data. |
##### ID3V2PrivateFrame(String ownerIdentifier, byte[] data)
```
public ID3V2PrivateFrame(String ownerIdentifier, byte[] data)
```

Initializes a new instance of the  ID3V2PrivateFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ownerIdentifier | java.lang.String | The owner identifier. |
| data | byte[] | Frame binary data. |

##### getOwnerIdentifier()
```
public final String getOwnerIdentifier()
```

Gets the owner identifier.

**Returns:**
java.lang.String - The owner identifier.
##### getBinaryData()
```
public final byte[] getBinaryData()
```

Gets the binary data.

**Returns:**
byte[] - The binary data.

### ID3V2Tag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2tag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3Tag
```
public final class ID3V2Tag extends ID3Tag
```

Represents an ID3v2 tag. Please find more information at  [https://en.wikipedia.org/wiki/ID3\#ID3v2][https_en.wikipedia.org_wiki_ID3_ID3v2] .

This example shows how to read the ID3v2 tag in an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V2)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getID3V2() != null) {
>          System.out.println(root.getID3V2().getAlbum());
>          System.out.println(root.getID3V2().getArtist());
>          System.out.println(root.getID3V2().getBand());
>          System.out.println(root.getID3V2().getTitle());
>          System.out.println(root.getID3V2().getComposers());
>          System.out.println(root.getID3V2().getCopyright());
>          System.out.println(root.getID3V2().getPublisher());
>          System.out.println(root.getID3V2().getOriginalAlbum());
>          System.out.println(root.getID3V2().getMusicalKey());
>          if (root.getID3V2().getAttachedPictures() != null) {
>              for (ID3V2AttachedPictureFrame attachedPicture : root.getID3V2().getAttachedPictures()) {
>                  System.out.println(attachedPicture.getAttachedPictureType());
>                  System.out.println(attachedPicture.getMimeType());
>                  System.out.println(attachedPicture.getDescription());
>                  // ...
>              }
>          }
>          // ...
>      }
>  }
>
> ```
> ```

[https_en.wikipedia.org_wiki_ID3_ID3v2]: https://en.wikipedia.org/wiki/ID3#ID3v2
[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2Tag() | Initializes a new instance of the  ID3V2Tag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the ID3 version. |
| getTagSize() | Gets the size of the tag. |
| getAlbum() | Gets the Album/Movie/Show title. |
| setAlbum(String value) | Sets the Album/Movie/Show title. |
| getArtist() | Gets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |
| setArtist(String value) | Sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |
| getBand() | Gets the Band/Orchestra/Accompaniment. |
| setBand(String value) | Sets the Band/Orchestra/Accompaniment. |
| getBitsPerMinute() | Gets the number of beats per minute in the main part of the audio. |
| setBitsPerMinute(String value) | Sets the number of beats per minute in the main part of the audio. |
| getComposers() | Gets the composers. |
| setComposers(String value) | Sets the composers. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCopyright() | Gets the copyright message. |
| setCopyright(String value) | Sets the copyright message. |
| getDate() | Gets a numeric string in the DDMM format containing the date for the recording. |
| setDate(String value) | Sets a numeric string in the DDMM format containing the date for the recording. |
| getEncodedBy() | Gets the name of the person or organization that encoded the audio file. |
| setEncodedBy(String value) | Sets the name of the person or organization that encoded the audio file. |
| getPublisher() | Gets the name of the label or publisher. |
| setPublisher(String value) | Sets the name of the label or publisher. |
| getTime() | Gets a numeric string in the HHMM format containing the time for the recording. |
| setTime(String value) | Sets a numeric string in the HHMM format containing the time for the recording. |
| getTitle() | Gets the Title/Song name/Content description. |
| setTitle(String value) | Sets the Title/Song name/Content description. |
| getSubtitle() | Gets the Subtitle/Description refinement. |
| setSubtitle(String value) | Sets the Subtitle/Description refinement. |
| getMusicalKey() | Gets the musical key in which the sound starts. |
| setMusicalKey(String value) | Sets the musical key in which the sound starts. |
| getLengthInMilliseconds() | Gets the length of the audio file in milliseconds, represented as a numeric string. |
| setLengthInMilliseconds(String value) | Sets the length of the audio file in milliseconds, represented as a numeric string. |
| getOriginalAlbum() | Gets the original album/movie/show title. |
| setOriginalAlbum(String value) | Sets the original album/movie/show title. |
| getTrackNumber() | Gets a numeric string containing the order number of the audio-file on its original recording. |
| setTrackNumber(String value) | Sets a numeric string containing the order number of the audio-file on its original recording. |
| getSizeInBytes() | Gets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |
| setSizeInBytes(String value) | Sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |
| getIsrc() | Gets the International Standard Recording Code (ISRC) (12 characters). |
| setIsrc(String value) | Sets the International Standard Recording Code (ISRC) (12 characters). |
| getSoftwareHardware() | Gets the used audio encoder and its settings when the file was encoded. |
| setSoftwareHardware(String value) | Sets the used audio encoder and its settings when the file was encoded. |
| getYear() | Gets a numeric string with a year of the recording. |
| setYear(String value) | Sets a numeric string with a year of the recording. |
| getComments() | Gets the user comments. |
| setComments(ID3V2CommentFrame[] value) | Sets the user comments. |
| getAttachedPictures() | Gets the attached pictures directly related to the audio file. |
| setAttachedPictures(ID3V2AttachedPictureFrame[] value) | Sets the attached pictures directly related to the audio file. |
| getTrackPlayCounter() | Gets the number of times the file has been played. |
| toList() | Creates a list from the package. |
| removeAttachedPictures() | Removes all attached pictures stored in APIC frames. |
| get(String frameId) | Gets an array of frames with the specified id. |
| set(ID3V2TagFrame frame) | Removes all frames having the same id as the specified one and adds the new frame to the tag. |
| clear(String frameId) | Removes all frames with the specified id. |
| add(ID3V2TagFrame frame) | Adds a frame to the tag. |
| remove(ID3V2TagFrame frame) | Removes the specified frame from the tag. |
##### ID3V2Tag()
```
public ID3V2Tag()
```

Initializes a new instance of the  ID3V2Tag  class.

##### getVersion()
```
public String getVersion()
```

Gets the ID3 version.

**Returns:**
java.lang.String - The ID3 version.
##### getTagSize()
```
public final int getTagSize()
```

Gets the size of the tag.

**Returns:**
int - The size of the tag.
##### getAlbum()
```
public final String getAlbum()
```

Gets the Album/Movie/Show title. This value is represented by the TALB frame.

**Returns:**
java.lang.String - The Album/Movie/Show title.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the Album/Movie/Show title. This value is represented by the TALB frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Album/Movie/Show title. |

##### getArtist()
```
public final String getArtist()
```

Gets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame.

**Returns:**
java.lang.String - The Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. This value is represented by the TPE1 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group. |

##### getBand()
```
public final String getBand()
```

Gets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame.

**Returns:**
java.lang.String - The Band/Orchestra/Accompaniment.
##### setBand(String value)
```
public final void setBand(String value)
```

Sets the Band/Orchestra/Accompaniment. This value is represented by the TPE2 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Band/Orchestra/Accompaniment. |

##### getBitsPerMinute()
```
public final String getBitsPerMinute()
```

Gets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame.

**Returns:**
java.lang.String - The number of beats per minute in the main part of the audio.
##### setBitsPerMinute(String value)
```
public final void setBitsPerMinute(String value)
```

Sets the number of beats per minute in the main part of the audio. This value is represented by the TBPM frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The number of beats per minute in the main part of the audio. |

##### getComposers()
```
public final String getComposers()
```

Gets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame.

**Returns:**
java.lang.String - The composers. The names are separated with the "/" character.
##### setComposers(String value)
```
public final void setComposers(String value)
```

Sets the composers. The names are separated with the "/" character. This value is represented by the TCOM frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The composers. The names are separated with the "/" character. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type. This value is represented by the TCON frame.

**Returns:**
java.lang.String - The content type.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type. This value is represented by the TCON frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content type. |

##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright message. This value is represented by the TCOP frame.

**Returns:**
java.lang.String - The copyright message.

Every time this field is displayed the field must be preceded with "Copyright ?? ".
##### setCopyright(String value)
```
public final void setCopyright(String value)
```

Sets the copyright message. This value is represented by the TCOP frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The copyright message.

Every time this field is displayed the field must be preceded with "Copyright ?? ". |

##### getDate()
```
public final String getDate()
```

Gets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame.

**Returns:**
java.lang.String - A numeric string in the DDMM format containing the date for the recording.
##### setDate(String value)
```
public final void setDate(String value)
```

Sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. This value is represented by the TDAT frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string in the DDMM format containing the date for the recording. |

##### getEncodedBy()
```
public final String getEncodedBy()
```

Gets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame.

**Returns:**
java.lang.String - The name of the person or organization that encoded the audio file.
##### setEncodedBy(String value)
```
public final void setEncodedBy(String value)
```

Sets the name of the person or organization that encoded the audio file. This value is represented by the TENC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the person or organization that encoded the audio file. |

##### getPublisher()
```
public final String getPublisher()
```

Gets the name of the label or publisher. This value is represented by the TPUB frame.

**Returns:**
java.lang.String - The name of the label or publisher.
##### setPublisher(String value)
```
public final void setPublisher(String value)
```

Sets the name of the label or publisher. This value is represented by the TPUB frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the label or publisher. |

##### getTime()
```
public final String getTime()
```

Gets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame.

**Returns:**
java.lang.String - A numeric string in the HHMM format containing the time for the recording.
##### setTime(String value)
```
public final void setTime(String value)
```

Sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. This value is represented by the TIME frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string in the HHMM format containing the time for the recording. |

##### getTitle()
```
public final String getTitle()
```

Gets the Title/Song name/Content description. This value is represented by the TIT2 frame.

**Returns:**
java.lang.String - The Title/Song name/Content description.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the Title/Song name/Content description. This value is represented by the TIT2 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Title/Song name/Content description. |

##### getSubtitle()
```
public final String getSubtitle()
```

Gets the Subtitle/Description refinement. This value is represented by the TIT3 frame.

**Returns:**
java.lang.String - The Subtitle/Description refinement.
##### setSubtitle(String value)
```
public final void setSubtitle(String value)
```

Sets the Subtitle/Description refinement. This value is represented by the TIT3 frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Subtitle/Description refinement. |

##### getMusicalKey()
```
public final String getMusicalKey()
```

Gets the musical key in which the sound starts. This value is represented by the TKEY frame.

**Returns:**
java.lang.String - The musical key in which the sound starts.
##### setMusicalKey(String value)
```
public final void setMusicalKey(String value)
```

Sets the musical key in which the sound starts. This value is represented by the TKEY frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The musical key in which the sound starts. |

##### getLengthInMilliseconds()
```
public final String getLengthInMilliseconds()
```

Gets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame.

**Returns:**
java.lang.String - The length of the audio file in milliseconds, represented as a numeric string.
##### setLengthInMilliseconds(String value)
```
public final void setLengthInMilliseconds(String value)
```

Sets the length of the audio file in milliseconds, represented as a numeric string. This value is represented by the TLEN frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The length of the audio file in milliseconds, represented as a numeric string. |

##### getOriginalAlbum()
```
public final String getOriginalAlbum()
```

Gets the original album/movie/show title. This value is represented by the TOAL frame.

**Returns:**
java.lang.String - The original album/movie/show title.
##### setOriginalAlbum(String value)
```
public final void setOriginalAlbum(String value)
```

Sets the original album/movie/show title. This value is represented by the TOAL frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The original album/movie/show title. |

##### getTrackNumber()
```
public final String getTrackNumber()
```

Gets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame.

**Returns:**
java.lang.String - A numeric string containing the order number of the audio-file on its original recording
##### setTrackNumber(String value)
```
public final void setTrackNumber(String value)
```

Sets a numeric string containing the order number of the audio-file on its original recording. This value is represented by the TRCK frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string containing the order number of the audio-file on its original recording |

##### getSizeInBytes()
```
public final String getSizeInBytes()
```

Gets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame.

**Returns:**
java.lang.String - The size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.
##### setSizeInBytes(String value)
```
public final void setSizeInBytes(String value)
```

Sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. This value is represented by the TSIZ frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string. |

##### getIsrc()
```
public final String getIsrc()
```

Gets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame.

**Returns:**
java.lang.String - The International Standard Recording Code (ISRC) (12 characters).
##### setIsrc(String value)
```
public final void setIsrc(String value)
```

Sets the International Standard Recording Code (ISRC) (12 characters). This value is represented by the TSRC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The International Standard Recording Code (ISRC) (12 characters). |

##### getSoftwareHardware()
```
public final String getSoftwareHardware()
```

Gets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame.

**Returns:**
java.lang.String - The used audio encoder and its settings when the file was encoded.
##### setSoftwareHardware(String value)
```
public final void setSoftwareHardware(String value)
```

Sets the used audio encoder and its settings when the file was encoded. This value is represented by the TSSE frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The used audio encoder and its settings when the file was encoded. |

##### getYear()
```
public final String getYear()
```

Gets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame.

**Returns:**
java.lang.String - A numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
##### setYear(String value)
```
public final void setYear(String value)
```

Sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). This value is represented by the TYER frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A numeric string with a year of the recording. This frames is always four characters long (until the year 10000). |

##### getComments()
```
public final ID3V2CommentFrame[] getComments()
```

Gets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame.

**Returns:**
com.groupdocs.metadata.core.ID3V2CommentFrame[] - The user comments.
##### setComments(ID3V2CommentFrame[] value)
```
public final void setComments(ID3V2CommentFrame[] value)
```

Sets the user comments. This value is represented by the COMM frame. The frame is intended for any kind of full text information that does not fit in any other frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2CommentFrame\[\] | The user comments. |

##### getAttachedPictures()
```
public final ID3V2AttachedPictureFrame[] getAttachedPictures()
```

Gets the attached pictures directly related to the audio file. This value is represented by the APIC frame.

**Returns:**
com.groupdocs.metadata.core.ID3V2AttachedPictureFrame[] - The attached pictures directly related to the audio file.
##### setAttachedPictures(ID3V2AttachedPictureFrame[] value)
```
public final void setAttachedPictures(ID3V2AttachedPictureFrame[] value)
```

Sets the attached pictures directly related to the audio file. This value is represented by the APIC frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2AttachedPictureFrame\[\] | The attached pictures directly related to the audio file. |

##### getTrackPlayCounter()
```
public final Long getTrackPlayCounter()
```

Gets the number of times the file has been played. This value is represented by the PCNT frame.

**Returns:**
java.lang.Long - The number of times a file has been played.
##### toList()
```
public final IReadOnlyList<ID3V2TagFrame> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list of all frames contained in the ID3v2 tag.
##### removeAttachedPictures()
```
public final void removeAttachedPictures()
```

Removes all attached pictures stored in APIC frames.

##### get(String frameId)
```
public final ID3V2TagFrame[] get(String frameId)
```

Gets an array of frames with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frames to get. |

**Returns:**
com.groupdocs.metadata.core.ID3V2TagFrame[] - An array of frames with the specified id.
##### set(ID3V2TagFrame frame)
```
public final void set(ID3V2TagFrame frame)
```

Removes all frames having the same id as the specified one and adds the new frame to the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to replace all frames of its kind with. |

##### clear(String frameId)
```
public final void clear(String frameId)
```

Removes all frames with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frames to remove. |

##### add(ID3V2TagFrame frame)
```
public final void add(ID3V2TagFrame frame)
```

Adds a frame to the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be added to the tag. |

##### remove(ID3V2TagFrame frame)
```
public final void remove(ID3V2TagFrame frame)
```

Removes the specified frame from the tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frame | ID3V2TagFrame | The frame to be removed from the tag. |

### ID3V2TagFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2tagframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class ID3V2TagFrame extends CustomPackage
```

Represents a generic frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2TagFrame(String frameId, byte[] data) | Initializes a new instance of the  ID3V2TagFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getId() | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| getFlags() | Gets the frame flags. |
| getData() | Gets the frame data. |
##### ID3V2TagFrame(String frameId, byte[] data)
```
public ID3V2TagFrame(String frameId, byte[] data)
```

Initializes a new instance of the  ID3V2TagFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameId | java.lang.String | The id of the frame (four characters matching the pattern [A-Z0-9]). |
| data | byte[] | The content of the frame. |

##### getId()
```
public final String getId()
```

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).

**Returns:**
java.lang.String - The id of the frame (four characters matching the pattern [A-Z0-9]).
##### getFlags()
```
public final ID3V2TagFrameFlags getFlags()
```

Gets the frame flags.

**Returns:**
ID3V2TagFrameFlags - The frame flags.
##### getData()
```
public final byte[] getData()
```

Gets the frame data.

**Returns:**
byte[] - The frame data.

### ID3V2TagFrameFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2tagframeflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class ID3V2TagFrameFlags implements System.IEquatable<ID3V2TagFrameFlags>
```

Represents flags used in a ID3v2 tag frame.
#### Methods

| Method | Description |
| --- | --- |
| getTagAlterPreservation() | Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. |
| getFileAlterPreservation() | Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. |
| getReadOnly() | Gets the tag that tells the software that the contents of this frame is intended to be read-only. |
| getCompression() | Gets a value indicating whether the frame is compressed. |
| getEncryption() | Gets a value indicating whether the frame is encrypted. |
| getGroupingIdentity() | Gets a value indicating whether the frame belongs to a group of frames. |
| getUnsynchronisation() | Gets a value indicating whether unsynchronisation was applied to this frame. |
| getDataLengthIndicator() | Gets a value indicating whether a data length indicator has been added to the frame. |
| equals(ID3V2TagFrameFlags other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Determines whether the specified object is equal to this instance. |
| hashCode() | Returns a hash code for this instance. |
##### getTagAlterPreservation()
```
public final boolean getTagAlterPreservation()
```

Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way. This applies to all kinds of alterations, including adding more padding and reordering the frames.

**Returns:**
boolean - The flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way.
##### getFileAlterPreservation()
```
public final boolean getFileAlterPreservation()
```

Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered. This does not apply when the audio is completely replaced with other audio data.

**Returns:**
boolean - Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered.
##### getReadOnly()
```
public final boolean getReadOnly()
```

Gets the tag that tells the software that the contents of this frame is intended to be read-only.

**Returns:**
boolean - The tag that tells the software that the contents of this frame is intended to be read-only.
##### getCompression()
```
public final boolean getCompression()
```

Gets a value indicating whether the frame is compressed.

**Returns:**
boolean -  true , if the frame is compressed; otherwise, false.
##### getEncryption()
```
public final boolean getEncryption()
```

Gets a value indicating whether the frame is encrypted. If set one byte indicating with which method it was encrypted will be appended to the frame header.

**Returns:**
boolean -  true , if the frame is encrypted; otherwise, false.
##### getGroupingIdentity()
```
public final boolean getGroupingIdentity()
```

Gets a value indicating whether the frame belongs to a group of frames. If set a group identifier byte is added to the frame header. Every frame with the same group identifier belongs to the same group.

**Returns:**
boolean -  true , if the frame belongs to a group of frames; otherwise, false.
##### getUnsynchronisation()
```
public final boolean getUnsynchronisation()
```

Gets a value indicating whether unsynchronisation was applied to this frame.

**Returns:**
boolean -  true , if unsynchronisation was applied to this frame; otherwise, false.
##### getDataLengthIndicator()
```
public final boolean getDataLengthIndicator()
```

Gets a value indicating whether a data length indicator has been added to the frame. The data length indicator is the value one would write as the 'Frame length' if all of the frame format flags were zeroed, represented as a 32 bit synchsafe integer.

**Returns:**
boolean -  true , if a data length indicator has been added to the frame; otherwise, false.
##### equals(ID3V2TagFrameFlags other)
```
public final boolean equals(ID3V2TagFrameFlags other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | ID3V2TagFrameFlags | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  other  parameter; otherwise, false.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified object is equal to this instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The  System.Object  to compare with this instance. |

**Returns:**
boolean -  true  if the specified  System.Object  is equal to this instance; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

### ID3V2TextFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2textframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public class ID3V2TextFrame extends ID3V2TagFrame
```

Represents a text frame in an  ID3V2Tag . Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the  ID3V2UserDefinedFrame  class.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value) | Initializes a new instance of the  ID3V2TextFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTextEncoding() | Gets the text encoding. |
| getText() | Gets the text value. |
##### ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value)
```
public ID3V2TextFrame(String id, ID3V2EncodingType encoding, String value)
```

Initializes a new instance of the  ID3V2TextFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The frame id. |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| value | java.lang.String | The frame value. |

##### getTextEncoding()
```
public final ID3V2EncodingType getTextEncoding()
```

Gets the text encoding.

**Returns:**
ID3V2EncodingType - The text encoding.
##### getText()
```
public final String getText()
```

Gets the text value.

**Returns:**
java.lang.String - The text value.

### ID3V2UrlLinkFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2urllinkframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UrlLinkFrame extends ID3V2TagFrame
```

Represents a URL link frame in an  ID3V2Tag . Name of the frame always starts with the W character.

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UrlLinkFrame(String id, String url) | Initializes a new instance of the  ID3V2UrlLinkFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getUrl() | Gets the URL value. |
##### ID3V2UrlLinkFrame(String id, String url)
```
public ID3V2UrlLinkFrame(String id, String url)
```

Initializes a new instance of the  ID3V2UrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The frame id. |
| url | java.lang.String | The URL which is the value of the frame. |

##### getUrl()
```
public final String getUrl()
```

Gets the URL value.

**Returns:**
java.lang.String - The URL value.

### ID3V2UserDefinedFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2userdefinedframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UserDefinedFrame extends ID3V2TagFrame
```

Represents a TXXX frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UserDefinedFrame(String description, String value) | Initializes a new instance of the  ID3V2UserDefinedFrame  class. |
| ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value) | Initializes a new instance of the  ID3V2UserDefinedFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding of the frame. |
| getDescription() | Gets the description. |
| getValue() | Gets the value. |
##### ID3V2UserDefinedFrame(String description, String value)
```
public ID3V2UserDefinedFrame(String description, String value)
```

Initializes a new instance of the  ID3V2UserDefinedFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | The description. |
| value | java.lang.String | The value. |

##### ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value)
```
public ID3V2UserDefinedFrame(ID3V2EncodingType encoding, String description, String value)
```

Initializes a new instance of the  ID3V2UserDefinedFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | java.lang.String | The description. |
| value | java.lang.String | The text value. |

##### getEncoding()
```
public final ID3V2EncodingType getEncoding()
```

Gets the encoding of the frame.

**Returns:**
ID3V2EncodingType - The encoding of the frame.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getValue()
```
public final String getValue()
```

Gets the value.

**Returns:**
java.lang.String - The value.

### ID3V2UserDefinedUrlLinkFrame
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/id3v2userdefinedurllinkframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ID3V2TagFrame
```
public final class ID3V2UserDefinedUrlLinkFrame extends ID3V2TagFrame
```

Represents a WXXX frame in an  ID3V2Tag .

[Handling the ID3v2 tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+ID3v2+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| ID3V2UserDefinedUrlLinkFrame(String description, String url) | Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class. |
| ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url) | Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding of the frame. |
| getDescription() | Gets the description. |
| getUrl() | Gets the URL. |
##### ID3V2UserDefinedUrlLinkFrame(String description, String url)
```
public ID3V2UserDefinedUrlLinkFrame(String description, String url)
```

Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | The description. |
| url | java.lang.String | The actual value of the frame. |

##### ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url)
```
public ID3V2UserDefinedUrlLinkFrame(ID3V2EncodingType encoding, String description, String url)
```

Initializes a new instance of the  ID3V2UserDefinedUrlLinkFrame  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encoding | ID3V2EncodingType | The encoding of the frame. |
| description | java.lang.String | The description. |
| url | java.lang.String | The actual value of the frame. |

##### getEncoding()
```
public final ID3V2EncodingType getEncoding()
```

Gets the encoding of the frame.

**Returns:**
ID3V2EncodingType - The encoding of the frame.
##### getDescription()
```
public final String getDescription()
```

Gets the description.

**Returns:**
java.lang.String - The description.
##### getUrl()
```
public final String getUrl()
```

Gets the URL.

**Returns:**
java.lang.String - The URL.

### IDocumentInfo
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/idocumentinfo.md

### IDublinCore
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/idublincore.md

### IEnumValue
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ienumvalue.md

### IEnumValueInterpreter
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ienumvalueinterpreter.md

### IExif
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iexif.md

### IIptc
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iiptc.md

### ImageResourceBlock
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/imageresourceblock.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ImageResourceBlock extends CustomPackage
```

Represents a Photoshop Image Resource block.

 Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF. Image resources are used to store non-pixel data associated with images, such as pen tool paths.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getSignature() | Gets the image resource block signature. |
| getID() | Gets the unique identifier for the resource. |
| getName() | Gets the image resource block name. |
| getData() | Gets the resource data. |
##### getSignature()
```
public final String getSignature()
```

Gets the image resource block signature.

**Returns:**
java.lang.String - The image resource block signature
##### getID()
```
public final ImageResourceID getID()
```

Gets the unique identifier for the resource.

**Returns:**
ImageResourceID - The identifier.
##### getName()
```
public final String getName()
```

Gets the image resource block name.

**Returns:**
java.lang.String - The image resource block name.
##### getData()
```
public final byte[] getData()
```

Gets the resource data.

**Returns:**
byte[] - The resource data.

### ImageResourceID
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/imageresourceid.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class ImageResourceID implements IEnumValue
```

Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file.
#### Fields

| Field | Description |
| --- | --- |
| ResolutionInfo | ResolutionInfo structure. |
| NamesOfAlphaChannels | Names of the alpha channels as a series of Pascal strings. |
| Caption | The caption as a Pascal string. |
| BorderInformation | Border information. |
| BackgroundColor | Background color. |
| PrintFlags | Print flags. |
| Grayscale | Grayscale and multichannel halftoning information. |
| ColorHalftoning | Color halftoning information. |
| DuotoneHalftoning | Duotone halftoning information. |
| GrayscaleFunction | Grayscale and multichannel transfer function. |
| ColorTransferFunctions | Color transfer functions. |
| DuotoneTransferFunctions | Duotone transfer functions. |
| DuotoneImageInformation | Duotone image information. |
| EPSOptions | EPS options. |
| QuickMaskInformation | Quick Mask information. |
| LayerStateInformation | Layer state information. |
| WorkingPath | Working path (not saved). |
| LayersGroupInformation | Layers group information. |
| Iptc | IPTC-NAA record. |
| ImageModeForRawFormat | Image mode for raw format files. |
| JpegQuality | JPEG quality. |
| GridAndGuidesInfoPhotoshop4 | Grid and guides information. |
| ThumbnailResourcePhotoshop4 | Thumbnail resource for Photoshop 4.0 only. |
| CopyrightFlagPhotoshop4 | Copyright flag. |
| UrlPhotoshop4 | URL. |
| ThumbnailResourcePhotoshop5 | Thumbnail resource (supersedes resource 1033). |
| GlobalAnglePhotoshop5 | Global Angle. |
| IccProfilePhotoshop5 | (Photoshop 5.0) ICC Profile. |
| WatermarkPhotoshop5 | Watermark. |
| IccUntaggedProfilePhotoshop5 | ICC Untagged Profile. |
| TransparencyIndexPhotoshop6 | Transparency Index. |
| GlobalAltitudePhotoshop6 | Global Altitude. |
| SlicesPhotoshop6 | Slices (Photoshop 6). |
| WorkflowUrlPhotoshop6 | Workflow URL. |
| AlphaIdentifiersPhotoshop6 | Alpha Identifiers. |
| UrlListPhotoshop6 | URL InternalList. |
| VersionInfoPhotoshop6 | Version Info. |
| ExifData1Photoshop7 | EXIF data 1,  see more . |
| ExifData3Photoshop7 |  EXIF data 3.  |
| XmpPhotoshop7 | XMP metadata. |
| CaptionDigestPhotoshop7 | Caption digest. |
| PrintScalePhotoshop7 | Print scale. |
| PixelAspectRatio | Pixel Aspect Ratio. |
| LayerComps | Layer Comps. |
| LayerSelectionIds | Layer Selection ID(s). |
| PrintInfoCS2 | Print info (Photoshop CS2). |
| LayerGroupEnabledIdCS2 | Layer Group(s) Enabled ID. |
| ColorSamplersResourceCS3 | Color samplers resource. |
| MeasurementScaleCS3 | Measurement Scale. |
| TimelineInformationCS3 | Timeline Information. |
| SheetDisclosureCS3 | Sheet Disclosure. |
| PrintInformationCS5 | Print Information (Photoshop CS5). |
| PrintStyleCS5 | Print Style (Photoshop CS5). |
| MacintoshNSPrintInfoCS5 | Macintosh NSPrintInfo. |
| WindowsDevmodeCS5 | Windows DEVMODE. |
| AutoSaveFilePathCS6 | Auto Save File Path. |
| AutoSaveFormatCS6 | Auto Save Format. |
| PathSelectionStateCC | Path Selection State. |
| ImageReadyVariables | Image Ready variables. |
| ImageReadyDatasets | Image Ready data sets. |
| PrintFlagsInformation | Print flags information. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### ResolutionInfo
```
public static final ImageResourceID ResolutionInfo
```

ResolutionInfo structure. See Appendix A in Photoshop API Guide PDF document.

##### NamesOfAlphaChannels
```
public static final ImageResourceID NamesOfAlphaChannels
```

Names of the alpha channels as a series of Pascal strings.

##### Caption
```
public static final ImageResourceID Caption
```

The caption as a Pascal string.

##### BorderInformation
```
public static final ImageResourceID BorderInformation
```

Border information. Contains a fixed number (2 bytes real, 2 bytes fraction) for the border width, and 2 bytes for border units (1 = inches, 2 = cm, 3 = points, 4 = picas, 5 = columns).

##### BackgroundColor
```
public static final ImageResourceID BackgroundColor
```

Background color.  See more.

##### PrintFlags
```
public static final ImageResourceID PrintFlags
```

Print flags. A series of one-byte boolean values (see Page Setup dialog): labels, crop marks, color bars, registration marks, negative, flip, interpolate, caption, print flags.

##### Grayscale
```
public static final ImageResourceID Grayscale
```

Grayscale and multichannel halftoning information.

##### ColorHalftoning
```
public static final ImageResourceID ColorHalftoning
```

Color halftoning information.

##### DuotoneHalftoning
```
public static final ImageResourceID DuotoneHalftoning
```

Duotone halftoning information.

##### GrayscaleFunction
```
public static final ImageResourceID GrayscaleFunction
```

Grayscale and multichannel transfer function.

##### ColorTransferFunctions
```
public static final ImageResourceID ColorTransferFunctions
```

Color transfer functions.

##### DuotoneTransferFunctions
```
public static final ImageResourceID DuotoneTransferFunctions
```

Duotone transfer functions.

##### DuotoneImageInformation
```
public static final ImageResourceID DuotoneImageInformation
```

Duotone image information.

##### EPSOptions
```
public static final ImageResourceID EPSOptions
```

EPS options.

##### QuickMaskInformation
```
public static final ImageResourceID QuickMaskInformation
```

Quick Mask information. 2 bytes containing Quick Mask channel ID; 1- byte boolean indicating whether the mask was initially empty.

##### LayerStateInformation
```
public static final ImageResourceID LayerStateInformation
```

Layer state information. 2 bytes containing the index of target layer (0 = bottom layer).

##### WorkingPath
```
public static final ImageResourceID WorkingPath
```

Working path (not saved). See See Path resource format.

##### LayersGroupInformation
```
public static final ImageResourceID LayersGroupInformation
```

Layers group information. 2 bytes per layer containing a group ID for the dragging groups. Layers in a group have the same group ID.

##### Iptc
```
public static final ImageResourceID Iptc
```

IPTC-NAA record. Contains the File Info... information. See the documentation in the IPTC folder of the Documentation folder.

##### ImageModeForRawFormat
```
public static final ImageResourceID ImageModeForRawFormat
```

Image mode for raw format files.

##### JpegQuality
```
public static final ImageResourceID JpegQuality
```

JPEG quality. Private.

##### GridAndGuidesInfoPhotoshop4
```
public static final ImageResourceID GridAndGuidesInfoPhotoshop4
```

Grid and guides information.

##### ThumbnailResourcePhotoshop4
```
public static final ImageResourceID ThumbnailResourcePhotoshop4
```

Thumbnail resource for Photoshop 4.0 only.

##### CopyrightFlagPhotoshop4
```
public static final ImageResourceID CopyrightFlagPhotoshop4
```

Copyright flag. Boolean indicating whether image is copyrighted. Can be set via Property suite or by user in File Info...

##### UrlPhotoshop4
```
public static final ImageResourceID UrlPhotoshop4
```

URL. Handle of a text string with uniform resource locator. Can be set via Property suite or by user in File Info...

##### ThumbnailResourcePhotoshop5
```
public static final ImageResourceID ThumbnailResourcePhotoshop5
```

Thumbnail resource (supersedes resource 1033). See See Thumbnail resource format.

##### GlobalAnglePhotoshop5
```
public static final ImageResourceID GlobalAnglePhotoshop5
```

Global Angle. 4 bytes that contain an integer between 0 and 359, which is the global lighting angle for effects layer. If not present, assumed to be 30.

##### IccProfilePhotoshop5
```
public static final ImageResourceID IccProfilePhotoshop5
```

(Photoshop 5.0) ICC Profile. The raw bytes of an ICC (International Color Consortium) format profile. See ICC1v42\_2006-05.pdf in the Documentation folder and icProfileHeader.h in Sample Code\\Common\\Includes.

##### WatermarkPhotoshop5
```
public static final ImageResourceID WatermarkPhotoshop5
```

Watermark. One byte.

##### IccUntaggedProfilePhotoshop5
```
public static final ImageResourceID IccUntaggedProfilePhotoshop5
```

ICC Untagged Profile. 1 byte that disables any assumed profile handling when opening the file. 1 = intentionally untagged.

##### TransparencyIndexPhotoshop6
```
public static final ImageResourceID TransparencyIndexPhotoshop6
```

Transparency Index. 2 bytes for the index of transparent color, if any.

##### GlobalAltitudePhotoshop6
```
public static final ImageResourceID GlobalAltitudePhotoshop6
```

Global Altitude. 4 byte entry for altitude.

##### SlicesPhotoshop6
```
public static final ImageResourceID SlicesPhotoshop6
```

Slices (Photoshop 6).

##### WorkflowUrlPhotoshop6
```
public static final ImageResourceID WorkflowUrlPhotoshop6
```

Workflow URL. Unicode string. Photoshop 6.

##### AlphaIdentifiersPhotoshop6
```
public static final ImageResourceID AlphaIdentifiersPhotoshop6
```

Alpha Identifiers. 4 bytes of length, followed by 4 bytes each for every alpha identifier.

##### UrlListPhotoshop6
```
public static final ImageResourceID UrlListPhotoshop6
```

URL InternalList. 4 byte count of URLs, followed by 4 byte long, 4 byte ID, and Unicode string for each count.

##### VersionInfoPhotoshop6
```
public static final ImageResourceID VersionInfoPhotoshop6
```

Version Info. 4 bytes version, 1 byte hasRealMergedData , Unicode string: writer name, Unicode string: reader name, 4 bytes file version.

##### ExifData1Photoshop7
```
public static final ImageResourceID ExifData1Photoshop7
```

EXIF data 1,  see more .

##### ExifData3Photoshop7
```
public static final ImageResourceID ExifData3Photoshop7
```

 EXIF data 3.

##### XmpPhotoshop7
```
public static final ImageResourceID XmpPhotoshop7
```

XMP metadata. File info as XML description,  see more .

##### CaptionDigestPhotoshop7
```
public static final ImageResourceID CaptionDigestPhotoshop7
```

Caption digest. 16 bytes: RSA Data Security, MD5 message-digest algorithm.

##### PrintScalePhotoshop7
```
public static final ImageResourceID PrintScalePhotoshop7
```

Print scale. 2 bytes style (0 = centered, 1 = size to fit, 2 = user defined). 4 bytes x location (floating point). 4 bytes y location (floating point). 4 bytes scale (floating point).

##### PixelAspectRatio
```
public static final ImageResourceID PixelAspectRatio
```

Pixel Aspect Ratio. 4 bytes (version = 1 or 2), 8 bytes double, x / y of a pixel. Version 2, attempting to correct values for NTSC and PAL, previously off by a factor of approx. 5%.

##### LayerComps
```
public static final ImageResourceID LayerComps
```

Layer Comps. 4 bytes (descriptor version = 16), Descriptor.

##### LayerSelectionIds
```
public static final ImageResourceID LayerSelectionIds
```

Layer Selection ID(s). 2 bytes count, following is repeated for each count: 4 bytes layer ID.

##### PrintInfoCS2
```
public static final ImageResourceID PrintInfoCS2
```

Print info (Photoshop CS2).

##### LayerGroupEnabledIdCS2
```
public static final ImageResourceID LayerGroupEnabledIdCS2
```

Layer Group(s) Enabled ID. 1 byte for each layer in the document, repeated by length of the resource. NOTE: Layer groups have start and end markers (Photoshop CS2).

##### ColorSamplersResourceCS3
```
public static final ImageResourceID ColorSamplersResourceCS3
```

Color samplers resource. Also see ID 1038 for old format.

##### MeasurementScaleCS3
```
public static final ImageResourceID MeasurementScaleCS3
```

Measurement Scale. 4 bytes (descriptor version = 16), Descriptor.

##### TimelineInformationCS3
```
public static final ImageResourceID TimelineInformationCS3
```

Timeline Information. 4 bytes (descriptor version = 16), Descriptor.

##### SheetDisclosureCS3
```
public static final ImageResourceID SheetDisclosureCS3
```

Sheet Disclosure. 4 bytes (descriptor version = 16), Descriptor.

##### PrintInformationCS5
```
public static final ImageResourceID PrintInformationCS5
```

Print Information (Photoshop CS5).

##### PrintStyleCS5
```
public static final ImageResourceID PrintStyleCS5
```

Print Style (Photoshop CS5).

##### MacintoshNSPrintInfoCS5
```
public static final ImageResourceID MacintoshNSPrintInfoCS5
```

Macintosh NSPrintInfo. Variable OS specific info for Macintosh. NSPrintInfo. It is recommended that you do not interpret or use this data. (Photoshop CS5).

##### WindowsDevmodeCS5
```
public static final ImageResourceID WindowsDevmodeCS5
```

Windows DEVMODE. Variable OS specific info for Windows. DEVMODE. It is recommended that you do not interpret or use this data. (Photoshop CS5).

##### AutoSaveFilePathCS6
```
public static final ImageResourceID AutoSaveFilePathCS6
```

Auto Save File Path. Unicode string. (Photoshop CS6).

##### AutoSaveFormatCS6
```
public static final ImageResourceID AutoSaveFormatCS6
```

Auto Save Format. Unicode string. (Photoshop CS6).

##### PathSelectionStateCC
```
public static final ImageResourceID PathSelectionStateCC
```

Path Selection State. (Photoshop CC).

##### ImageReadyVariables
```
public static final ImageResourceID ImageReadyVariables
```

Image Ready variables. XML representation of variables definition.

##### ImageReadyDatasets
```
public static final ImageResourceID ImageReadyDatasets
```

Image Ready data sets.

##### PrintFlagsInformation
```
public static final ImageResourceID PrintFlagsInformation
```

Print flags information. 2 bytes version ( = 1), 1 byte center crop marks, 1 byte ( = 0), 4 bytes bleed width value, 2 bytes bleed width scale.

##### getByRawValue(int rawValue)
```
public static ImageResourceID getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ImageResourceID
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### ImageResourcePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/imageresourcepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ImageResourcePackage extends CustomPackage
```

Represents a metadata package containing Photoshop Image Resources.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
##### toList()
```
public final IReadOnlyList<ImageResourceBlock> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all Image Resource Blocks from the package.

### ImageRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/imagerootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public abstract class ImageRootPackage extends RootMetadataPackage
```

Provides a base abstract class for all image root packages.

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPng)) {
>      ImageRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getImageType().getFileFormat());
>      System.out.println(root.getImageType().getByteOrder());
>      System.out.println(root.getImageType().getMimeType());
>      System.out.println(root.getImageType().getExtension());
>      System.out.println(root.getImageType().getWidth());
>      System.out.println(root.getImageType().getHeight());
>  }
>
> ```
> ```
#### Methods

| Method | Description |
| --- | --- |
| getImageType() | Gets the file type metadata package. |
##### getImageType()
```
public final ImageTypePackage getImageType()
```

Gets the file type metadata package.

**Returns:**
ImageTypePackage - The file type metadata package.

### ImageTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/imagetypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class ImageTypePackage extends FileTypePackage
```

Represents a metadata package containing image-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the image width. |
| getHeight() | Gets the image height. |
| getByteOrder() | Gets the byte-order of the image. |
##### getWidth()
```
public final int getWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getHeight()
```
public final int getHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getByteOrder()
```
public final ByteOrder getByteOrder()
```

Gets the byte-order of the image. Please see  https://en.wikipedia.org/wiki/Endianness  for more information.

**Returns:**
ByteOrder - The byte-order value.

### InteroperabilityIFDPointerPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/interoperabilityifdpointerpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class InteroperabilityIFDPointerPackage extends CustomPackage
```

Represents Interoperability IFD.
#### Methods

| Method | Description |
| --- | --- |
| getTagInteropIndex() | Gets the TagInteropIndex. |
| getTagInteropVersion() | Gets the TagInteropVersion. |
##### getTagInteropIndex()
```
public final String getTagInteropIndex()
```

Gets the TagInteropIndex.

**Returns:**
java.lang.String - The TagInteropIndex.
##### getTagInteropVersion()
```
public final byte[] getTagInteropVersion()
```

Gets the TagInteropVersion.

**Returns:**
byte[] - The TagInteropVersion.

### InvalidFormatException
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/invalidformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class InvalidFormatException extends GroupDocsMetadataException
```

The exception that is thrown when a file has an invalid format.
#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidFormatException() | Initializes a new instance of the  InvalidFormatException  class. |
| InvalidFormatException(String message) | Initializes a new instance of the  InvalidFormatException  class. |
| InvalidFormatException(String message, RuntimeException innerException) | Initializes a new instance of the  InvalidFormatException  class. |
##### InvalidFormatException()
```
public InvalidFormatException()
```

Initializes a new instance of the  InvalidFormatException  class.

##### InvalidFormatException(String message)
```
public InvalidFormatException(String message)
```

Initializes a new instance of the  InvalidFormatException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### InvalidFormatException(String message, RuntimeException innerException)
```
public InvalidFormatException(String message, RuntimeException innerException)
```

Initializes a new instance of the  InvalidFormatException  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. |

### IptcApplicationRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcapplicationrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.IptcRecord
```
public final class IptcApplicationRecord extends IptcRecord
```

Represents an IPTC Application Record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcApplicationRecord() | Initializes a new instance of the  IptcApplicationRecord  class. |
#### Methods

| Method | Description |
| --- | --- |
| getByLine() | Gets the name of the creator of the object, e.g. |
| setByLine(String value) | Sets the name of the creator of the object, e.g. |
| getByLines() | Gets the names of the creators of the object, e.g. |
| setByLines(String[] value) | Sets the names of the creators of the object, e.g. |
| getByLineTitle() | Gets the title of the creator or creators of the object. |
| setByLineTitle(String value) | Sets the title of the creator or creators of the object. |
| getByLineTitles() | Gets the titles of the creator or creators of the object. |
| setByLineTitles(String[] value) | Sets the titles of the creator or creators of the object. |
| getContentLocationCode() | Gets the content location code. |
| setContentLocationCode(String value) | Sets the content location code. |
| getContentLocationCodes() | Gets the content location codes. |
| setContentLocationCodes(String[] value) | Sets the content location codes. |
| getContentLocationName() | Gets the content location name. |
| setContentLocationName(String value) | Sets the content location name. |
| getContentLocationNames() | Gets the content location names. |
| setContentLocationNames(String[] value) | Sets the content location names. |
| getDateCreated() | Gets the date the intellectual content of the object was created. |
| setDateCreated(Date value) | Sets the date the intellectual content of the object was created. |
| getReferenceDate() | Gets the date of a prior envelope to which the current object refers. |
| setReferenceDate(Date value) | Sets the date of a prior envelope to which the current object refers. |
| getReferenceDates() | Gets the dates of a prior envelope to which the current object refers. |
| getReleaseDate() | Gets the release date. |
| setReleaseDate(Date value) | Sets the release date. |
| getCredit() | Gets information about the provider of the object, not necessarily the owner/creator. |
| setCredit(String value) | Sets information about the provider of the object, not necessarily the owner/creator. |
| getHeadline() | Gets a publishable entry providing a synopsis of the contents of the object. |
| setHeadline(String value) | Sets a publishable entry providing a synopsis of the contents of the object. |
| getCopyrightNotice() | Gets the copyright notice. |
| setCopyrightNotice(String value) | Sets the copyright notice. |
| getContact() | Gets information about the person or organisation which can provide further background information on the object. |
| setContact(String value) | Sets information about the person or organisation which can provide further background information on the object. |
| getContacts() | Gets information about the person or organisation which can provide further background information on the object. |
| setContacts(String[] value) | Sets information about the person or organisation which can provide further background information on the object. |
| getCity() | Gets the city. |
| setCity(String value) | Sets the city. |
| getCaptionAbstract() | Gets a textual description of the object, particularly used where the object is not text. |
| setCaptionAbstract(String value) | Sets a textual description of the object, particularly used where the object is not text. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getAllKeywords() | Gets the keywords. |
| setAllKeywords(String[] value) | Sets the keywords. |
| getProgramVersion() | Gets the program version. |
| setProgramVersion(String value) | Sets the program version. |
| getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber) | Gets the  IptcDataSet  with the specified number. |
##### IptcApplicationRecord()
```
public IptcApplicationRecord()
```

Initializes a new instance of the  IptcApplicationRecord  class.

##### getByLine()
```
public final String getByLine()
```

Gets the name of the creator of the object, e.g. writer, photographer or graphic artist.

**Returns:**
java.lang.String - The name of the creator of the object, e.g. writer, photographer or graphic artist.
##### setByLine(String value)
```
public final void setByLine(String value)
```

Sets the name of the creator of the object, e.g. writer, photographer or graphic artist.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the creator of the object, e.g. writer, photographer or graphic artist. |

##### getByLines()
```
public final String[] getByLines()
```

Gets the names of the creators of the object, e.g. writer, photographer or graphic artist.

**Returns:**
java.lang.String[] - The names of the creators of the object, e.g. writer, photographer or graphic artist.
##### setByLines(String[] value)
```
public final void setByLines(String[] value)
```

Sets the names of the creators of the object, e.g. writer, photographer or graphic artist.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The names of the creators of the object, e.g. writer, photographer or graphic artist. |

##### getByLineTitle()
```
public final String getByLineTitle()
```

Gets the title of the creator or creators of the object.

**Returns:**
java.lang.String - The title of the creator or creators of the object.
##### setByLineTitle(String value)
```
public final void setByLineTitle(String value)
```

Sets the title of the creator or creators of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the creator or creators of the object. |

##### getByLineTitles()
```
public final String[] getByLineTitles()
```

Gets the titles of the creator or creators of the object.

**Returns:**
java.lang.String[] - The titles of the creator or creators of the object.
##### setByLineTitles(String[] value)
```
public final void setByLineTitles(String[] value)
```

Sets the titles of the creator or creators of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The titles of the creator or creators of the object. |

##### getContentLocationCode()
```
public final String getContentLocationCode()
```

Gets the content location code.

**Returns:**
java.lang.String - The content location code.
##### setContentLocationCode(String value)
```
public final void setContentLocationCode(String value)
```

Sets the content location code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content location code. |

##### getContentLocationCodes()
```
public final String[] getContentLocationCodes()
```

Gets the content location codes.

**Returns:**
java.lang.String[] - The content location codes.
##### setContentLocationCodes(String[] value)
```
public final void setContentLocationCodes(String[] value)
```

Sets the content location codes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location codes. |

##### getContentLocationName()
```
public final String getContentLocationName()
```

Gets the content location name.

**Returns:**
java.lang.String - The name of the content location.
##### setContentLocationName(String value)
```
public final void setContentLocationName(String value)
```

Sets the content location name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the content location. |

##### getContentLocationNames()
```
public final String[] getContentLocationNames()
```

Gets the content location names.

**Returns:**
java.lang.String[] - The name of the content locations.
##### setContentLocationNames(String[] value)
```
public final void setContentLocationNames(String[] value)
```

Sets the content location names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The name of the content locations. |

##### getDateCreated()
```
public final Date getDateCreated()
```

Gets the date the intellectual content of the object was created.

**Returns:**
java.util.Date - The date the intellectual content of the object was created.
##### setDateCreated(Date value)
```
public final void setDateCreated(Date value)
```

Sets the date the intellectual content of the object was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the intellectual content of the object was created. |

##### getReferenceDate()
```
public final Date getReferenceDate()
```

Gets the date of a prior envelope to which the current object refers.

**Returns:**
java.util.Date - The date of a prior envelope to which the current object refers.
##### setReferenceDate(Date value)
```
public final void setReferenceDate(Date value)
```

Sets the date of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of a prior envelope to which the current object refers. |

##### getReferenceDates()
```
public final Date[] getReferenceDates()
```

Gets the dates of a prior envelope to which the current object refers.

**Returns:**
java.util.Date[] - The dates of a prior envelope to which the current object refers.
##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the release date.

**Returns:**
java.util.Date - The release date.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the release date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The release date. |

##### getCredit()
```
public final String getCredit()
```

Gets information about the provider of the object, not necessarily the owner/creator.

**Returns:**
java.lang.String - The information about the provider of the object, not necessarily the owner/creator.
##### setCredit(String value)
```
public final void setCredit(String value)
```

Sets information about the provider of the object, not necessarily the owner/creator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about the provider of the object, not necessarily the owner/creator. |

##### getHeadline()
```
public final String getHeadline()
```

Gets a publishable entry providing a synopsis of the contents of the object.

**Returns:**
java.lang.String - A publishable entry providing a synopsis of the contents of the object.
##### setHeadline(String value)
```
public final void setHeadline(String value)
```

Sets a publishable entry providing a synopsis of the contents of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A publishable entry providing a synopsis of the contents of the object. |

##### getCopyrightNotice()
```
public final String getCopyrightNotice()
```

Gets the copyright notice.

**Returns:**
java.lang.String - The copyright notice.
##### setCopyrightNotice(String value)
```
public final void setCopyrightNotice(String value)
```

Sets the copyright notice.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The copyright notice. |

##### getContact()
```
public final String getContact()
```

Gets information about the person or organisation which can provide further background information on the object.

**Returns:**
java.lang.String - The information about the person or organisation which can provide further background information on the object.
##### setContact(String value)
```
public final void setContact(String value)
```

Sets information about the person or organisation which can provide further background information on the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The information about the person or organisation which can provide further background information on the object. |

##### getContacts()
```
public final String[] getContacts()
```

Gets information about the person or organisation which can provide further background information on the object.

**Returns:**
java.lang.String[] - The information about the person or organisation which can provide further background information on the object.
##### setContacts(String[] value)
```
public final void setContacts(String[] value)
```

Sets information about the person or organisation which can provide further background information on the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The information about the person or organisation which can provide further background information on the object. |

##### getCity()
```
public final String getCity()
```

Gets the city.

**Returns:**
java.lang.String - The city.
##### setCity(String value)
```
public final void setCity(String value)
```

Sets the city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The city. |

##### getCaptionAbstract()
```
public final String getCaptionAbstract()
```

Gets a textual description of the object, particularly used where the object is not text.

**Returns:**
java.lang.String - TheA textual description of the object, particularly used where the object is not text.
##### setCaptionAbstract(String value)
```
public final void setCaptionAbstract(String value)
```

Sets a textual description of the object, particularly used where the object is not text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | TheA textual description of the object, particularly used where the object is not text. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getAllKeywords()
```
public final String[] getAllKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String[] - The keywords.
##### setAllKeywords(String[] value)
```
public final void setAllKeywords(String[] value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The keywords. |

##### getProgramVersion()
```
public final String getProgramVersion()
```

Gets the program version.

**Returns:**
java.lang.String - The program version.
##### setProgramVersion(String value)
```
public final void setProgramVersion(String value)
```

Sets the program version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The program version. |

##### getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber)
```
public final IptcDataSet getByIptcApplicationRecordDataSet(IptcApplicationRecordDataSet dataSetNumber)
```

Gets the  IptcDataSet  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | IptcApplicationRecordDataSet | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified number.

### IptcApplicationRecordDataSet
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcapplicationrecorddataset.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum IptcApplicationRecordDataSet extends Enum<IptcApplicationRecordDataSet> implements IEnumValue
```

Defines IPTC Application Record dataSet numbers.
#### Fields

| Field | Description |
| --- | --- |
| RecordVersion | Represents the record version. |
| ObjectTypeReference | Object type reference. |
| ObjectAttributeReference | The object attribute reference. |
| ObjectName | Used as a shorthand reference for the object. |
| EditStatus | Status of the objectdata, according to the practice of the provider. |
| EditorialUpdate | Indicates the type of update that this object provides to a previous object. |
| Urgency | Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority). |
| SubjectReference | The subject reference. |
| Category | Identifies the subject of the objectdata in the opinion of the provider. |
| SupplementalCategory |  |
| FixtureIdentifier | The fixture identifier. |
| Keywords | Used to indicate specific information retrieval words. |
| ContentLocationCode | Indicates the code of a country/geographical location referenced by the content of the object. |
| ContentLocationName |  |
| ReleaseDate | Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. |
| ReleaseTime | Designates in the form HHMMSS??HHMM the earliest time the provider intends the object to be used. |
| ExpirationDate | Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. |
| SpecialInstructions | Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. |
| ActionAdvised | Indicates the type of action that this object provides to a previous object. |
| ReferenceService | Identifies the Service Identifier of a prior envelope to which the current object refers. |
| ReferenceDate | Identifies the date of a prior envelope to which the current object refers. |
| ReferenceNumber | Identifies the Envelope Number of a prior envelope to which the current object refers. |
| DateCreated | Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. |
| TimeCreated | Represented in the form HHMMSS??HHMM to designate the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation. |
| DigitalCreationDate | Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. |
| DigitalCreationTime | Represented in the form HHMMSS??HHMM to designate the time the digital representation of the objectdata was created. |
| OriginatingProgram | Identifies the type of program used to originate the objectdata. |
| ProgramVersion | Used to identify the version of the program mentioned in 2:65. |
| ObjectCycle | Consisting of an alphabetic character. |
| Byline | Contains name of the creator of the objectdata, e.g. |
| BylineTitle | A by-line title is the title of the creator or creators of an object data. |
| City | Identifies city of objectdata origin according to guidelines established by the provider. |
| SubLocation | Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. |
| ProvinceState | Identifies Province/State of origin according to guidelines established by the provider. |
| PrimaryLocationCode | Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. |
| PrimaryLocationName | Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider. |
| OriginalTransmissionReference | A code representing the location of original transmission according to practices of the provider. |
| Headline | A publishable entry providing a synopsis of the contents of the objectdata. |
| Credit | Identifies the provider of the objectdata, not necessarily the owner/creator. |
| Source | The name of a person or party who has a role in the content supply chain. |
| CopyrightNotice | Contains any necessary copyright notice. |
| Contact | Identifies the person or organization which can provide further background information on the object data. |
| CaptionAbstract | A textual description of the objectdata, particularly used where the object is not text. |
| WriterEditor | Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract. |
| RasterizedCaption | Image width 460 pixels and image height 128 pixels. |
| ImageType | The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes. |
| ImageOrientation | Indicates the layout of the image area. |
| LanguageIdentifier | Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. |
| AudioType | The audio type. |
| AudioSamplingRate | Sampling rate numeric characters, representing the sampling rate in hertz (Hz). |
| AudioSamplingResolution | The number of bits in each audio sample. |
| AudioDuration | Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. |
| AudioOutcue | Identifies the content of the end of an audio objectdata, according to guidelines established by the provider. |
| ObjDataPreviewFileFormat | A binary number representing the file format of the ObjectData Preview. |
| ObjDataPreviewFileFormatVer | A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200. |
| ObjDataPreviewData | The object data preview. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### RecordVersion
```
public static final IptcApplicationRecordDataSet RecordVersion
```

Represents the record version. Binary. Always 2 in JPEGs.

##### ObjectTypeReference
```
public static final IptcApplicationRecordDataSet ObjectTypeReference
```

Object type reference. Used pattern: "/\\d\{2\}:[\\w\\s]\{0,64\}?/".

##### ObjectAttributeReference
```
public static final IptcApplicationRecordDataSet ObjectAttributeReference
```

The object attribute reference.

##### ObjectName
```
public static final IptcApplicationRecordDataSet ObjectName
```

Used as a shorthand reference for the object.

Changes to existing data, such as updated stories or new crops on photos, should be identified in  EditStatus .

##### EditStatus
```
public static final IptcApplicationRecordDataSet EditStatus
```

Status of the objectdata, according to the practice of the provider.

##### EditorialUpdate
```
public static final IptcApplicationRecordDataSet EditorialUpdate
```

Indicates the type of update that this object provides to a previous object.

##### Urgency
```
public static final IptcApplicationRecordDataSet Urgency
```

Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority).

##### SubjectReference
```
public static final IptcApplicationRecordDataSet SubjectReference
```

The subject reference.

##### Category
```
public static final IptcApplicationRecordDataSet Category
```

Identifies the subject of the objectdata in the opinion of the provider.

##### SupplementalCategory
```
public static final IptcApplicationRecordDataSet SupplementalCategory
```

Supplemental categories further refine the subject of an objectdata.

 Only a single supplemental category may be contained in each DataSet. A supplemental category may include any of the recognised categories as used in 2:15.

##### FixtureIdentifier
```
public static final IptcApplicationRecordDataSet FixtureIdentifier
```

The fixture identifier.

##### Keywords
```
public static final IptcApplicationRecordDataSet Keywords
```

Used to indicate specific information retrieval words. Each keyword uses a single Keywords DataSet. Multiple keywords use multiple Keywords DataSets.

##### ContentLocationCode
```
public static final IptcApplicationRecordDataSet ContentLocationCode
```

Indicates the code of a country/geographical location referenced by the content of the object.

##### ContentLocationName
```
public static final IptcApplicationRecordDataSet ContentLocationName
```

Provides a full, publishable name of a country/geographical location referenced by the content of the object,

 according to guidelines of the provider.

##### ReleaseDate
```
public static final IptcApplicationRecordDataSet ReleaseDate
```

Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard.

##### ReleaseTime
```
public static final IptcApplicationRecordDataSet ReleaseTime
```

Designates in the form HHMMSS??HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard.

##### ExpirationDate
```
public static final IptcApplicationRecordDataSet ExpirationDate
```

Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Follows ISO 8601 standard.

##### SpecialInstructions
```
public static final IptcApplicationRecordDataSet SpecialInstructions
```

Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings.

##### ActionAdvised
```
public static final IptcApplicationRecordDataSet ActionAdvised
```

Indicates the type of action that this object provides to a previous object.

##### ReferenceService
```
public static final IptcApplicationRecordDataSet ReferenceService
```

Identifies the Service Identifier of a prior envelope to which the current object refers.

##### ReferenceDate
```
public static final IptcApplicationRecordDataSet ReferenceDate
```

Identifies the date of a prior envelope to which the current object refers.

##### ReferenceNumber
```
public static final IptcApplicationRecordDataSet ReferenceNumber
```

Identifies the Envelope Number of a prior envelope to which the current object refers.

##### DateCreated
```
public static final IptcApplicationRecordDataSet DateCreated
```

Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation.

Follows ISO 8601 standard. Where the month or day cannot be determined, the information will be represented by ???00???. Where the year cannot be determined, the information for century and year will be represented by ???00???.

##### TimeCreated
```
public static final IptcApplicationRecordDataSet TimeCreated
```

Represented in the form HHMMSS??HHMM to designate the time the intellectual content of the objectdata current source material was created rather than the creation of the physical representation.

Follows ISO 8601 standard.

##### DigitalCreationDate
```
public static final IptcApplicationRecordDataSet DigitalCreationDate
```

Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created.

##### DigitalCreationTime
```
public static final IptcApplicationRecordDataSet DigitalCreationTime
```

Represented in the form HHMMSS??HHMM to designate the time the digital representation of the objectdata was created.

##### OriginatingProgram
```
public static final IptcApplicationRecordDataSet OriginatingProgram
```

Identifies the type of program used to originate the objectdata.

##### ProgramVersion
```
public static final IptcApplicationRecordDataSet ProgramVersion
```

Used to identify the version of the program mentioned in 2:65. DataSet 2:70 is invalid if 2:65 is not present.

##### ObjectCycle
```
public static final IptcApplicationRecordDataSet ObjectCycle
```

Consisting of an alphabetic character. Where: 'a'(morning, 'p'(evening, 'b'(both.

##### Byline
```
public static final IptcApplicationRecordDataSet Byline
```

Contains name of the creator of the objectdata, e.g. writer, photographer or graphic artist.

##### BylineTitle
```
public static final IptcApplicationRecordDataSet BylineTitle
```

A by-line title is the title of the creator or creators of an object data.

##### City
```
public static final IptcApplicationRecordDataSet City
```

Identifies city of objectdata origin according to guidelines established by the provider.

##### SubLocation
```
public static final IptcApplicationRecordDataSet SubLocation
```

Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider.

##### ProvinceState
```
public static final IptcApplicationRecordDataSet ProvinceState
```

Identifies Province/State of origin according to guidelines established by the provider.

##### PrimaryLocationCode
```
public static final IptcApplicationRecordDataSet PrimaryLocationCode
```

Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. a photo was taken, an event occurred.

##### PrimaryLocationName
```
public static final IptcApplicationRecordDataSet PrimaryLocationName
```

Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created, according to guidelines of the provider.

##### OriginalTransmissionReference
```
public static final IptcApplicationRecordDataSet OriginalTransmissionReference
```

A code representing the location of original transmission according to practices of the provider.

##### Headline
```
public static final IptcApplicationRecordDataSet Headline
```

A publishable entry providing a synopsis of the contents of the objectdata.

##### Credit
```
public static final IptcApplicationRecordDataSet Credit
```

Identifies the provider of the objectdata, not necessarily the owner/creator.

##### Source
```
public static final IptcApplicationRecordDataSet Source
```

The name of a person or party who has a role in the content supply chain. This could be an agency, a member of an agency, an individual or a combination.

##### CopyrightNotice
```
public static final IptcApplicationRecordDataSet CopyrightNotice
```

Contains any necessary copyright notice.

##### Contact
```
public static final IptcApplicationRecordDataSet Contact
```

Identifies the person or organization which can provide further background information on the object data.

##### CaptionAbstract
```
public static final IptcApplicationRecordDataSet CaptionAbstract
```

A textual description of the objectdata, particularly used where the object is not text.

##### WriterEditor
```
public static final IptcApplicationRecordDataSet WriterEditor
```

Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract.

##### RasterizedCaption
```
public static final IptcApplicationRecordDataSet RasterizedCaption
```

Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right.

##### ImageType
```
public static final IptcApplicationRecordDataSet ImageType
```

The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes.

##### ImageOrientation
```
public static final IptcApplicationRecordDataSet ImageOrientation
```

Indicates the layout of the image area.

##### LanguageIdentifier
```
public static final IptcApplicationRecordDataSet LanguageIdentifier
```

Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988.

##### AudioType
```
public static final IptcApplicationRecordDataSet AudioType
```

The audio type.

##### AudioSamplingRate
```
public static final IptcApplicationRecordDataSet AudioSamplingRate
```

Sampling rate numeric characters, representing the sampling rate in hertz (Hz).

##### AudioSamplingResolution
```
public static final IptcApplicationRecordDataSet AudioSamplingResolution
```

The number of bits in each audio sample.

##### AudioDuration
```
public static final IptcApplicationRecordDataSet AudioDuration
```

Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded.

##### AudioOutcue
```
public static final IptcApplicationRecordDataSet AudioOutcue
```

Identifies the content of the end of an audio objectdata, according to guidelines established by the provider.

##### ObjDataPreviewFileFormat
```
public static final IptcApplicationRecordDataSet ObjDataPreviewFileFormat
```

A binary number representing the file format of the ObjectData Preview.

##### ObjDataPreviewFileFormatVer
```
public static final IptcApplicationRecordDataSet ObjDataPreviewFileFormatVer
```

A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200.

##### ObjDataPreviewData
```
public static final IptcApplicationRecordDataSet ObjDataPreviewData
```

The object data preview.

##### values()
```
public static IptcApplicationRecordDataSet[] values()
```

**Returns:**
com.groupdocs.metadata.core.IptcApplicationRecordDataSet[]
##### valueOf(String name)
```
public static IptcApplicationRecordDataSet valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IptcApplicationRecordDataSet
##### getByRawValue(int rawValue)
```
public static IptcApplicationRecordDataSet getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IptcApplicationRecordDataSet
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### IptcDataSet
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcdataset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class IptcDataSet extends MetadataProperty
```

Represents an IPTC DataSet (metadata property).

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, String value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, int value) | Initializes a new instance of the  IptcDataSet  class. |
| IptcDataSet(byte recordNumber, byte dataSetNumber, Date value) | Initializes a new instance of the  IptcDataSet  class. |
#### Methods

| Method | Description |
| --- | --- |
| getRecordNumber() | Gets the record number. |
| getDataSetNumber() | Gets the dataSet number. |
| getAlternativeName() | Gets the alternative name of the dataSet. |
##### IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, byte[] value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | byte[] | A byte array value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, String value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, String value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | java.lang.String | A string value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, int value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, int value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | int | An integer value. |

##### IptcDataSet(byte recordNumber, byte dataSetNumber, Date value)
```
public IptcDataSet(byte recordNumber, byte dataSetNumber, Date value)
```

Initializes a new instance of the  IptcDataSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |
| value | java.util.Date | A date value. |

##### getRecordNumber()
```
public final byte getRecordNumber()
```

Gets the record number.

**Returns:**
byte - The record number.
##### getDataSetNumber()
```
public final byte getDataSetNumber()
```

Gets the dataSet number.

**Returns:**
byte - The dataSet number.
##### getAlternativeName()
```
public final String getAlternativeName()
```

Gets the alternative name of the dataSet.

**Returns:**
java.lang.String - The alternative name of the dataSet.

### IptcEnvelopeRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcenveloperecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.IptcRecord
```
public final class IptcEnvelopeRecord extends IptcRecord
```

Represents an IPTC Envelope Record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcEnvelopeRecord() | Initializes a new instance of the  IptcEnvelopeRecord  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModelVersion() | Gets a number identifying the version of the information. |
| setModelVersion(Integer value) | Sets a number identifying the version of the information. |
| getDestination() | Gets the destination. |
| setDestination(String value) | Sets the destination. |
| getDestinations() | Gets an array of destinations. |
| setDestinations(String[] value) | Sets an array of destinations. |
| getFileFormat() | Gets the file format. |
| setFileFormat(Integer value) | Sets the file format. |
| getFileFormatVersion() | Gets the file format version. |
| setFileFormatVersion(Integer value) | Sets the file format version. |
| getServiceIdentifier() | Gets the service identifier. |
| setServiceIdentifier(String value) | Sets the service identifier. |
| getProductID() | Gets the product identifier. |
| setProductID(String value) | Sets the product identifier. |
| getProductIds() | Gets the product identifiers. |
| setProductIds(String[] value) | Sets the product identifiers. |
| getDateSent() | Gets the date the service sent the material. |
| setDateSent(Date value) | Sets the date the service sent the material. |
| getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber) | Gets the  IptcDataSet  with the specified number. |
##### IptcEnvelopeRecord()
```
public IptcEnvelopeRecord()
```

Initializes a new instance of the  IptcEnvelopeRecord  class.

##### getModelVersion()
```
public final Integer getModelVersion()
```

Gets a number identifying the version of the information.

**Returns:**
java.lang.Integer - The model version.
##### setModelVersion(Integer value)
```
public final void setModelVersion(Integer value)
```

Sets a number identifying the version of the information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The model version. |

##### getDestination()
```
public final String getDestination()
```

Gets the destination.

**Returns:**
java.lang.String - The destination.
##### setDestination(String value)
```
public final void setDestination(String value)
```

Sets the destination.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The destination. |

##### getDestinations()
```
public final String[] getDestinations()
```

Gets an array of destinations.

**Returns:**
java.lang.String[] - The destinations.
##### setDestinations(String[] value)
```
public final void setDestinations(String[] value)
```

Sets an array of destinations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The destinations. |

##### getFileFormat()
```
public final Integer getFileFormat()
```

Gets the file format.

**Returns:**
java.lang.Integer - The file format.
##### setFileFormat(Integer value)
```
public final void setFileFormat(Integer value)
```

Sets the file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format. |

##### getFileFormatVersion()
```
public final Integer getFileFormatVersion()
```

Gets the file format version. A number representing the particular version of the File Format specified in  FileFormat .

**Returns:**
java.lang.Integer - The file format version.
##### setFileFormatVersion(Integer value)
```
public final void setFileFormatVersion(Integer value)
```

Sets the file format version. A number representing the particular version of the File Format specified in  FileFormat .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format version. |

##### getServiceIdentifier()
```
public final String getServiceIdentifier()
```

Gets the service identifier.

**Returns:**
java.lang.String - The service identifier.
##### setServiceIdentifier(String value)
```
public final void setServiceIdentifier(String value)
```

Sets the service identifier.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The service identifier. |

##### getProductID()
```
public final String getProductID()
```

Gets the product identifier.

**Returns:**
java.lang.String - The product identifier.
##### setProductID(String value)
```
public final void setProductID(String value)
```

Sets the product identifier.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The product identifier. |

##### getProductIds()
```
public final String[] getProductIds()
```

Gets the product identifiers.

**Returns:**
java.lang.String[] - The product identifiers.
##### setProductIds(String[] value)
```
public final void setProductIds(String[] value)
```

Sets the product identifiers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The product identifiers. |

##### getDateSent()
```
public final Date getDateSent()
```

Gets the date the service sent the material.

**Returns:**
java.util.Date - The date the service sent the material.
##### setDateSent(Date value)
```
public final void setDateSent(Date value)
```

Sets the date the service sent the material.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the service sent the material. |

##### getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber)
```
public final IptcDataSet getByIptcEnvelopeRecordDataSet(IptcEnvelopeRecordDataSet dataSetNumber)
```

Gets the  IptcDataSet  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | IptcEnvelopeRecordDataSet | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified number.

### IptcEnvelopeRecordDataSet
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcenveloperecorddataset.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class IptcEnvelopeRecordDataSet implements IEnumValue
```

Defines IPTC Envelope Record dataSet numbers.
#### Fields

| Field | Description |
| --- | --- |
| ModelVersion |  |
| Destination |  |
| FileFormat | File format. |
| FileFormatVersion |  |
| ServiceIdentifier |  |
| EnvelopeNumber |  |
| ProductID |  |
| EnvelopePriority |  |
| DateSent |  |
| TimeSent |  |
| CodedCharacterSet |  |
| Uno | Invalid (eternal identifier). |
| ArmIdentifier | The DataSet identifies the Abstract Relationship Method (ARM) which is described in a document registered by the originator of the ARM with the IPTC and NAA. |
| ArmVersion | Binary number representing the particular version of the ARM specified in DataSet 1:120. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### ModelVersion
```
public static final IptcEnvelopeRecordDataSet ModelVersion
```

A binary number identifying the version of the Information

 Interchange Model, Part I, utilised by the provider. Version numbers are assigned by IPTC and NAA.

 The version number of this record is four (4).

##### Destination
```
public static final IptcEnvelopeRecordDataSet Destination
```

Optional, repeatable, maximum 1024 octets, consisting of sequentially contiguous graphic characters.

 This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

##### FileFormat
```
public static final IptcEnvelopeRecordDataSet FileFormat
```

File format.

##### FileFormatVersion
```
public static final IptcEnvelopeRecordDataSet FileFormatVersion
```

Mandatory, not repeatable, two octets.

 A binary number representing the particular version of the File Format specified in 1:20.

 A list of File Formats, including version cross references, is included as Appendix A.

##### ServiceIdentifier
```
public static final IptcEnvelopeRecordDataSet ServiceIdentifier
```

Mandatory, not repeatable. Up to 10 octets, consisting of graphic characters.

 Identifies the provider and product.

##### EnvelopeNumber
```
public static final IptcEnvelopeRecordDataSet EnvelopeNumber
```

Mandatory, not repeatable, eight octets, consisting of numeric characters.

 The characters form a number that will be unique for the date specified in 1:70 and for the Service Identifier specified in 1:30.

 If identical envelope numbers appear with the same date and with the same Service Identifier, records 2-9 must be unchanged from the original.

 This is not intended to be a sequential serial number reception check.

##### ProductID
```
public static final IptcEnvelopeRecordDataSet ProductID
```

Optional, repeatable. Up to 32 octets, consisting of graphic characters.

 Allows a provider to identify subsets of its overall service.

 Used to provide receiving organization data on which to select, route, or otherwise handle data.

##### EnvelopePriority
```
public static final IptcEnvelopeRecordDataSet EnvelopePriority
```

Optional, not repeatable. A single octet, consisting of a numeric character.

 Specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency). '1' indicates the most urgent, '5' the normal urgency, and '8' the least urgent copy. The numeral '9' indicates a User Defined Priority. The numeral '0' is reserved for future use.

##### DateSent
```
public static final IptcEnvelopeRecordDataSet DateSent
```

Mandatory, not repeatable. Eight octets, consisting of numeric characters.

 Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day the service sent the material.

##### TimeSent
```
public static final IptcEnvelopeRecordDataSet TimeSent
```

Uses the format HHMMSS±HHMM where HHMMSS refers to local hour, minute and seconds and HHMM refers to hours and minutes ahead (+) or behind (-) Universal Coordinated Time as described in ISO 8601. This is the time the service sent the material.

##### CodedCharacterSet
```
public static final IptcEnvelopeRecordDataSet CodedCharacterSet
```

Optional, not repeatable, up to 32 octets, consisting of one or more control functions used for the announcement, invocation or designation of coded character sets. The control functions follow the ISO 2022 standard and may consist of the escape control character and one or more graphic characters. For more details see Appendix C, the IPTC-NAA Code Library.

##### Uno
```
public static final IptcEnvelopeRecordDataSet Uno
```

Invalid (eternal identifier).

##### ArmIdentifier
```
public static final IptcEnvelopeRecordDataSet ArmIdentifier
```

The DataSet identifies the Abstract Relationship Method (ARM) which is described in a document registered by the originator of the ARM with the IPTC and NAA.

##### ArmVersion
```
public static final IptcEnvelopeRecordDataSet ArmVersion
```

Binary number representing the particular version of the ARM specified in DataSet 1:120.

##### getByRawValue(int rawValue)
```
public static IptcEnvelopeRecordDataSet getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IptcEnvelopeRecordDataSet
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### IptcRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class IptcRecord extends CustomPackage
```

Represents an IPTC record.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getRecordNumber() | Gets the record number. |
| toList() | Creates a list from the package. |
| get_Item(byte dataSetNumber) | Gets the  IptcDataSet  with the specified dataSet number. |
##### getRecordNumber()
```
public final byte getRecordNumber()
```

Gets the record number.

**Returns:**
byte - The record number.
##### toList()
```
public final IReadOnlyList<IptcDataSet> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC dataSets from the package.
##### get_Item(byte dataSetNumber)
```
public final IptcDataSet get_Item(byte dataSetNumber)
```

Gets the  IptcDataSet  with the specified dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSetNumber | byte | The IPTC dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified dataSet number, if found; otherwise null.

### IptcRecordSet
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class IptcRecordSet extends CustomPackage
```

Represents a collection of IPTC records.

This code sample shows hot to update basic IPTC metadata properties.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IIptc root = (IIptc) metadata.getRootPackage();
>      // Set the IPTC package if it's missing
>      if (root.getIptcPackage() == null) {
>          root.setIptcPackage(new IptcRecordSet());
>      }
>      if (root.getIptcPackage().getEnvelopeRecord() == null) {
>          root.getIptcPackage().setEnvelopeRecord(new IptcEnvelopeRecord());
>      }
>      root.getIptcPackage().getEnvelopeRecord().setDateSent(new Date());
>      root.getIptcPackage().getEnvelopeRecord().setProductID("test project id");
>      // ...
>      if (root.getIptcPackage().getApplicationRecord() == null) {
>          root.getIptcPackage().setApplicationRecord(new IptcApplicationRecord());
>      }
>      root.getIptcPackage().getApplicationRecord().setByLine("GroupDocs");
>      root.getIptcPackage().getApplicationRecord().setHeadline("test");
>      root.getIptcPackage().getApplicationRecord().setByLineTitle("code sample");
>      root.getIptcPackage().getApplicationRecord().setReleaseDate(new Date());
>      // ...
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| IptcRecordSet() | Initializes a new instance of the  IptcRecordSet  class. |
| IptcRecordSet(IptcDataSet[] dataSets) | Initializes a new instance of the  IptcRecordSet  class. |
#### Methods

| Method | Description |
| --- | --- |
| getEnvelopeRecord() | Gets the Envelope Record. |
| setEnvelopeRecord(IptcEnvelopeRecord value) | Sets the Envelope Record. |
| getApplicationRecord() | Gets the Application Record. |
| setApplicationRecord(IptcApplicationRecord value) | Sets the Application Record. |
| get_Item(byte recordNumber) | Gets the  IptcRecord  with the specified number. |
| get_Item(byte recordNumber, byte dataSetNumber) | Gets the  IptcDataSet  with the specified record and dataSet number. |
| set(IptcDataSet dataSet) | Adds or updates the specified dataSet in the appropriate record. |
| add(IptcDataSet dataSet) | Adds the specified dataSet to the appropriate record. |
| remove(byte recordNumber, byte dataSetNumber) | Removes the dataSet with the specified record and dataSet number. |
| clear() | Removes all records from the collection. |
| remove(byte recordNumber) | Removes the record with the specified record number. |
| toDataSetList() | Creates a list of dataSets from the package. |
| toList() | Creates a list from the package. |
##### IptcRecordSet()
```
public IptcRecordSet()
```

Initializes a new instance of the  IptcRecordSet  class.

##### IptcRecordSet(IptcDataSet[] dataSets)
```
public IptcRecordSet(IptcDataSet[] dataSets)
```

Initializes a new instance of the  IptcRecordSet  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSets | IptcDataSet\[\] | An array of IPTC dataSets. |

##### getEnvelopeRecord()
```
public final IptcEnvelopeRecord getEnvelopeRecord()
```

Gets the Envelope Record.

**Returns:**
IptcEnvelopeRecord - The Envelope Record.
##### setEnvelopeRecord(IptcEnvelopeRecord value)
```
public final void setEnvelopeRecord(IptcEnvelopeRecord value)
```

Sets the Envelope Record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcEnvelopeRecord | The Envelope Record. |

##### getApplicationRecord()
```
public final IptcApplicationRecord getApplicationRecord()
```

Gets the Application Record.

**Returns:**
IptcApplicationRecord - The Application Record.
##### setApplicationRecord(IptcApplicationRecord value)
```
public final void setApplicationRecord(IptcApplicationRecord value)
```

Sets the Application Record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcApplicationRecord | The Application Record. |

##### get_Item(byte recordNumber)
```
public final IptcRecord get_Item(byte recordNumber)
```

Gets the  IptcRecord  with the specified number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |

**Returns:**
IptcRecord - The  IptcRecord  with the specified number, if found; otherwise null.
##### get_Item(byte recordNumber, byte dataSetNumber)
```
public final IptcDataSet get_Item(byte recordNumber, byte dataSetNumber)
```

Gets the  IptcDataSet  with the specified record and dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |

**Returns:**
IptcDataSet - The  IptcDataSet  with the specified record and dataSet number.
##### set(IptcDataSet dataSet)
```
public final void set(IptcDataSet dataSet)
```

Adds or updates the specified dataSet in the appropriate record.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add/update. |

##### add(IptcDataSet dataSet)
```
public final void add(IptcDataSet dataSet)
```

Adds the specified dataSet to the appropriate record. The dataSet is considered as repeatable if a dataSet with the specified number already exists.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataSet | IptcDataSet | The IPTC dataSet to add. |

##### remove(byte recordNumber, byte dataSetNumber)
```
public final boolean remove(byte recordNumber, byte dataSetNumber)
```

Removes the dataSet with the specified record and dataSet number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |
| dataSetNumber | byte | The dataSet number. |

**Returns:**
boolean - True if the specified IPTC dataSet is found and removed; otherwise, false.
##### clear()
```
public final void clear()
```

Removes all records from the collection.

##### remove(byte recordNumber)
```
public final boolean remove(byte recordNumber)
```

Removes the record with the specified record number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| recordNumber | byte | The record number. |

**Returns:**
boolean - True if the specified IPTC record is found and removed; otherwise, false.
##### toDataSetList()
```
public final IReadOnlyList<IptcDataSet> toDataSetList()
```

Creates a list of dataSets from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC dataSets from the package.
##### toList()
```
public final IReadOnlyList<IptcRecord> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all IPTC records from the package.

### IptcRecordType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/iptcrecordtype.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class IptcRecordType implements IEnumValue
```

Defines IPTC record types.
#### Fields

| Field | Description |
| --- | --- |
| EnvelopeRecord | Represents an Envelope Record. |
| ApplicationRecord | Represents an Application Record. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### EnvelopeRecord
```
public static final IptcRecordType EnvelopeRecord
```

Represents an Envelope Record.

##### ApplicationRecord
```
public static final IptcRecordType ApplicationRecord
```

Represents an Application Record.

##### getByRawValue(int rawValue)
```
public static IptcRecordType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IptcRecordType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### IReadOnlyList
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ireadonlylist.md

**All Implemented Interfaces:**
java.lang.Iterable
```
public interface IReadOnlyList<T> extends Iterable<T>
```

Represents a read-only collection of elements that can be accessed by index.

 T : The type of elements in the read-only list.
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the collection. |
| get_Item(int index) | Gets the element at the specified index in the read-only list. |
| indexOf(T item) | Determines the index of a specific item in the collection. |
| contains(T item) | Determines whether the collection contains a specific item. |
| contains(TagCategory item) | Determines whether the collection contains a TagCategory item. |
##### getCount()
```
public abstract int getCount()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.
##### get_Item(int index)
```
public abstract T get_Item(int index)
```

Gets the element at the specified index in the read-only list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the element to get. |

**Returns:**
T - The element at the specified index in the read-only list.
##### indexOf(T item)
```
public abstract int indexOf(T item)
```

Determines the index of a specific item in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
int - The index of  item  if found in the collection; otherwise, -1.
##### contains(T item)
```
public abstract boolean contains(T item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### contains(TagCategory item)
```
public abstract boolean contains(TagCategory item)
```

Determines whether the collection contains a TagCategory item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.

### IXmp
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ixmp.md

### IXmpType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ixmptype.md

### Jpeg2000Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/jpeg2000package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class Jpeg2000Package extends CustomPackage
```

Represents native JPEG2000 metadata.

[Working with metadata in JPEG2000 images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG2000+images
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the JPEG2000 comments. |
##### getComments()
```
public final String[] getComments()
```

Gets the JPEG2000 comments.

**Returns:**
java.lang.String[] - The JPEG2000 comments.

### Jpeg2000RootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/jpeg2000rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class Jpeg2000RootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a JPEG2000 image.

This code snippet demonstrates how to read JPEG2000 image comments.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg2000)) {
>      Jpeg2000RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getJpeg2000Package().getComments() != null) {
>          for (String comment : root.getJpeg2000Package().getComments()) {
>              System.out.println(comment);
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in JPEG2000 images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG2000+images
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getJpeg2000Package() | Gets the JPEG2000 native metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getJpeg2000Package()
```
public final Jpeg2000Package getJpeg2000Package()
```

Gets the JPEG2000 native metadata package.

**Returns:**
Jpeg2000Package - The JPEG2000 native metadata package.

### JpegRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/jpegrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif, com.groupdocs.metadata.core.IIptc
```
public class JpegRootPackage extends ImageRootPackage implements IXmp, IExif, IIptc
```

Represents the root package allowing working with metadata in a JPEG image.

[Working with metadata in JPEG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+JPEG+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
| getImageResourcePackage() | Gets the Photoshop Image Resource metadata package. |
| getMakerNotePackage() | Gets the MakerNote metadata package. |
| removeImageResourcePackage() | Removes Photoshop Image Resource metadata package. |
| detectBarcodeTypes() | Extracts the types of the barcodes presented in the image. |
| sanitize() | Removes writable metadata properties from the package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

##### getImageResourcePackage()
```
public final ImageResourcePackage getImageResourcePackage()
```

Gets the Photoshop Image Resource metadata package. Image resource blocks are the basic building unit of Photoshop native file format.

**Returns:**
ImageResourcePackage - The Image Resource metadata package.
##### getMakerNotePackage()
```
public final MakerNotePackage getMakerNotePackage()
```

Gets the MakerNote metadata package.

**Returns:**
MakerNotePackage - The MakerNote metadata package.
##### removeImageResourcePackage()
```
public final void removeImageResourcePackage()
```

Removes Photoshop Image Resource metadata package.

##### detectBarcodeTypes()
```
public final String[] detectBarcodeTypes()
```

Extracts the types of the barcodes presented in the image.

**Returns:**
java.lang.String[] - An array of barcode types.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### LyricsField
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/lyricsfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class LyricsField extends MetadataProperty
```

Represents a  LyricsTag  field.

[Handling the Lyrics tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+Lyrics+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| LyricsField(String id, String data) | Initializes a new instance of the  LyricsField  class. |
#### Methods

| Method | Description |
| --- | --- |
| getID() | Gets the id of the field (it's always three characters long). |
| getSize() | Gets the string representation of the field size. |
| getData() | Gets the field data. |
##### LyricsField(String id, String data)
```
public LyricsField(String id, String data)
```

Initializes a new instance of the  LyricsField  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The three character field id. |
| data | java.lang.String | The field data. |

##### getID()
```
public final String getID()
```

Gets the id of the field (it's always three characters long).

**Returns:**
java.lang.String - The id of the field (it's always three characters long).
##### getSize()
```
public final String getSize()
```

Gets the string representation of the field size.

**Returns:**
java.lang.String - The string representation of the field size.
##### getData()
```
public final String getData()
```

Gets the field data.

**Returns:**
java.lang.String - The field data.

### LyricsTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/lyricstag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class LyricsTag extends CustomPackage
```

Represents Lyrics3 v2.00 metadata. Please find more information at  http://id3.org/Lyrics3v2 .

Lyrics3 v2.00 uses fields to represent information. The data in a field can consist of ASCII characters in the range 01 to 254 according to the standard. As the ASCII character map is only defined from 00 to 128 ISO-8859-1 might be assumed. Numerical fields are 5 or 6 characters long, depending on location, and are padded with zeroes.

This code sample shows how to read the Lyrics tag from an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithLyrics)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      if (root.getLyrics3V2() != null) {
>          System.out.println(root.getLyrics3V2().getLyrics());
>          System.out.println(root.getLyrics3V2().getAlbum());
>          System.out.println(root.getLyrics3V2().getArtist());
>          System.out.println(root.getLyrics3V2().getTrack());
>          // ...
>          // Alternatively, you can loop through a full list of tag fields
>          for (LyricsField field : root.getLyrics3V2().toList()) {
>              System.out.println(String.format("%s = %s", field.getID(), field.getData()));
>          }
>      }
>  }
>
> ```
> ```

[Handling the Lyrics tag]: https://docs.groupdocs.com/display/metadatajava/Handling+the+Lyrics+tag
#### Constructors

| Constructor | Description |
| --- | --- |
| LyricsTag() | Initializes a new instance of the  LyricsTag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getLyrics() | Gets the lyrics. |
| setLyrics(String value) | Sets the lyrics. |
| getAdditionalInfo() | Gets the additional information. |
| setAdditionalInfo(String value) | Sets the additional information. |
| getAuthor() | Gets the author. |
| setAuthor(String value) | Sets the author. |
| getAlbum() | Gets the album name. |
| setAlbum(String value) | Sets the album name. |
| getArtist() | Gets the artist name. |
| setArtist(String value) | Sets the artist name. |
| getTrack() | Gets the track title. |
| setTrack(String value) | Sets the track title. |
| set(LyricsField field) | Adds or replaces the specified Lyrics3 field. |
| remove(String id) | Removes the field with the specified id. |
| get(String id) | Gets the value of the field with the specified id. |
| toList() | Creates a list from the package. |
##### LyricsTag()
```
public LyricsTag()
```

Initializes a new instance of the  LyricsTag  class.

##### getLyrics()
```
public final String getLyrics()
```

Gets the lyrics. This value is represented by the LYR field.

**Returns:**
java.lang.String - The lyrics.
##### setLyrics(String value)
```
public final void setLyrics(String value)
```

Sets the lyrics. This value is represented by the LYR field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The lyrics. |

##### getAdditionalInfo()
```
public final String getAdditionalInfo()
```

Gets the additional information. This value is represented by the INF field.

**Returns:**
java.lang.String - The additional information.

This is always three (3) characters long in v2.00, but might be longer in a future standard. The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise. The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no. The third character inhibits tracks for random selection - "1" if inhibited and "0" if not.
##### setAdditionalInfo(String value)
```
public final void setAdditionalInfo(String value)
```

Sets the additional information. This value is represented by the INF field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The additional information.

This is always three (3) characters long in v2.00, but might be longer in a future standard. The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise. The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no. The third character inhibits tracks for random selection - "1" if inhibited and "0" if not. |

##### getAuthor()
```
public final String getAuthor()
```

Gets the author. This value is represented by the AUT field.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author. This value is represented by the AUT field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getAlbum()
```
public final String getAlbum()
```

Gets the album name. This value is represented by the EAL field.

**Returns:**
java.lang.String - The album.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the album name. This value is represented by the EAL field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The album. |

##### getArtist()
```
public final String getArtist()
```

Gets the artist name. This value is represented by the EAR field.

**Returns:**
java.lang.String - The artist.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the artist name. This value is represented by the EAR field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The artist. |

##### getTrack()
```
public final String getTrack()
```

Gets the track title. This value is represented by the ETT field.

**Returns:**
java.lang.String - The track.
##### setTrack(String value)
```
public final void setTrack(String value)
```

Sets the track title. This value is represented by the ETT field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The track. |

##### set(LyricsField field)
```
public final void set(LyricsField field)
```

Adds or replaces the specified Lyrics3 field.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| field | LyricsField | The field to be set. |

##### remove(String id)
```
public final void remove(String id)
```

Removes the field with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The field identifier. |

##### get(String id)
```
public final String get(String id)
```

Gets the value of the field with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The id of the field. |

**Returns:**
java.lang.String - The value if the tag contains a field with the specified id; otherwise, null.
##### toList()
```
public final IReadOnlyList<LyricsField> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list of all fields contained in the Lyrics3 tag.

### MakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/makernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage
```
public abstract class MakerNotePackage extends ExifDictionaryBasePackage
```

Provides an abstract base class for MakerNote metadata packages.

### MatroskaAudioTrack
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskaaudiotrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaAudioTrack extends MatroskaTrack
```

Represents audio metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSamplingFrequency() | Gets the sampling frequency in Hz. |
| getOutputSamplingFrequency() | Gets the real output sampling frequency in Hz (used for SBR techniques). |
| getChannels() | Gets the numbers of channels in the track. |
| getBitDepth() | Gets the bits per sample, mostly used for PCM. |
##### getSamplingFrequency()
```
public final double getSamplingFrequency()
```

Gets the sampling frequency in Hz.

**Returns:**
double - The sampling frequency in Hz.
##### getOutputSamplingFrequency()
```
public final double getOutputSamplingFrequency()
```

Gets the real output sampling frequency in Hz (used for SBR techniques).

**Returns:**
double - The real output sampling frequency in Hz (used for SBR techniques).
##### getChannels()
```
public final long getChannels()
```

Gets the numbers of channels in the track.

**Returns:**
long - The numbers of channels in the track.
##### getBitDepth()
```
public final Long getBitDepth()
```

Gets the bits per sample, mostly used for PCM.

**Returns:**
java.lang.Long - The bits per sample, mostly used for PCM.

### MatroskaBasePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskabasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class MatroskaBasePackage extends CustomPackage
```

Provides a base metadata class for all packages extracted from a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files

### MatroskaContentType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskacontenttype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaContentType extends Enum<MatroskaContentType> implements IEnumValue
```

Represents a Matroska content type.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined content. |
| Audio | Defines the Matroska audio type. |
| Video | Defines the Matroska video type. |
| Video3D | Defines the Matroska 3D video type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaContentType Undefined
```

Undefined content.

##### Audio
```
public static final MatroskaContentType Audio
```

Defines the Matroska audio type.

##### Video
```
public static final MatroskaContentType Video
```

Defines the Matroska video type.

##### Video3D
```
public static final MatroskaContentType Video3D
```

Defines the Matroska 3D video type.

##### values()
```
public static MatroskaContentType[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaContentType[]
##### valueOf(String name)
```
public static MatroskaContentType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaContentType
##### getByRawValue(int rawValue)
```
public static MatroskaContentType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaContentType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaEbmlHeader
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskaebmlheader.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaEbmlHeader extends MatroskaBasePackage
```

Represents EBML header metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the EBML Writer that has been used to create the file. |
| getReadVersion() | Gets the minimum version an EBML parser needs to be compliant with to be able to read the file. |
| getDocType() | Gets the contents of the file. |
| getDocTypeVersion() | Gets the version of the  DocType  writer used to create the file. |
| getDocTypeReadVersion() | Gets the minimum version number a  DocType  parser must be compliant with to read the file. |
##### getVersion()
```
public final byte getVersion()
```

Gets the version of the EBML Writer that has been used to create the file.

**Returns:**
byte - The version of the EBML Writer that has been used to create the file.
##### getReadVersion()
```
public final byte getReadVersion()
```

Gets the minimum version an EBML parser needs to be compliant with to be able to read the file.

**Returns:**
byte - The minimum version an EBML parser needs to be compliant with to be able to read the file.
##### getDocType()
```
public final String getDocType()
```

Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'.

**Returns:**
java.lang.String - The contents of the file.
##### getDocTypeVersion()
```
public final byte getDocTypeVersion()
```

Gets the version of the  DocType  writer used to create the file.

**Returns:**
byte - The version of the  DocType  writer used to create the file.
##### getDocTypeReadVersion()
```
public final byte getDocTypeReadVersion()
```

Gets the minimum version number a  DocType  parser must be compliant with to read the file.

**Returns:**
byte - The minimum version number a  DocType  parser must be compliant with to read the file.

### MatroskaPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaPackage extends MatroskaBasePackage
```

Represents a metadata container in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getEbmlHeader() | Gets the EBML header metadata. |
| getSegments() | Gets the segment information metadata. |
| getTracks() | Gets the track metadata entries. |
| getTags() | Gets the tagging metadata. |
| getContentType() | Gets the Matroska content type. |
| getSubtitleTracks() | Gets the subtitle metadata entries. |
##### getEbmlHeader()
```
public final MatroskaEbmlHeader getEbmlHeader()
```

Gets the EBML header metadata.

**Returns:**
MatroskaEbmlHeader - The EBML header metadata.
##### getSegments()
```
public final MatroskaSegment[] getSegments()
```

Gets the segment information metadata.

**Returns:**
com.groupdocs.metadata.core.MatroskaSegment[] - The segment information metadata.
##### getTracks()
```
public final MatroskaTrack[] getTracks()
```

Gets the track metadata entries.

**Returns:**
com.groupdocs.metadata.core.MatroskaTrack[] - The track metadata entries.
##### getTags()
```
public final MatroskaTag[] getTags()
```

Gets the tagging metadata.

**Returns:**
com.groupdocs.metadata.core.MatroskaTag[] - The tagging metadata.
##### getContentType()
```
public final MatroskaContentType getContentType()
```

Gets the Matroska content type.

**Returns:**
MatroskaContentType - The Matroska content type.
##### getSubtitleTracks()
```
public final MatroskaSubtitleTrack[] getSubtitleTracks()
```

Gets the subtitle metadata entries.

**Returns:**
com.groupdocs.metadata.core.MatroskaSubtitleTrack[] - The subtitle metadata entries.

### MatroskaRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskarootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class MatroskaRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a Matroska video.

This example demonstrates how to extract subtitles from an MKV video.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MkvWithSubtitles)) {
>      MatroskaRootPackage root = metadata.getRootPackageGeneric();
>      for (MatroskaSubtitleTrack subtitleTrack : root.getMatroskaPackage().getSubtitleTracks()) {
>          System.out.println(subtitleTrack.getLanguageIetf() != null ? subtitleTrack.getLanguageIetf() : subtitleTrack.getLanguage());
>          for (MatroskaSubtitle subtitle : subtitleTrack.getSubtitles()) {
>              System.out.println(String.format("Timecode=%s, Duration=%s", subtitle.getTimecode(), subtitle.getDuration()));
>              System.out.println(subtitle.getText());
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getMatroskaPackage() | Gets the Matroska metadata package. |
##### getMatroskaPackage()
```
public final MatroskaPackage getMatroskaPackage()
```

Gets the Matroska metadata package.

**Returns:**
MatroskaPackage - The Matroska metadata package.

### MatroskaSegment
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskasegment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSegment extends MatroskaBasePackage
```

Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSegmentUid() | Gets the unique 128 bit number identifying a SEGMENT. |
| getSegmentFilename() | Gets the filename corresponding to this Segment. |
| getTimecodeScale() | Gets the timecode scale value. |
| getDuration() | Gets the duration of the SEGMENT. |
| getDateUtc() | Gets the date and time that the Segment was created by the muxing application or library. |
| getTitle() | Gets the general name of the Segment. |
| getMuxingApp() | Gets the full name of the application or library followed by the version number. |
| getWritingApp() | Gets the full name of the application followed by the version number. |
| getScaledDuration() | Gets the scaled duration of the SEGMENT in milliseconds. |
##### getSegmentUid()
```
public final byte[] getSegmentUid()
```

Gets the unique 128 bit number identifying a SEGMENT. Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID.

**Returns:**
byte[] - The unique 128 bit number identifying a SEGMENT.
##### getSegmentFilename()
```
public final String getSegmentFilename()
```

Gets the filename corresponding to this Segment.

**Returns:**
java.lang.String - The filename corresponding to this Segment.
##### getTimecodeScale()
```
public final long getTimecodeScale()
```

Gets the timecode scale value. Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled!

**Returns:**
long - The timecode scale value.
##### getDuration()
```
public final Double getDuration()
```

Gets the duration of the SEGMENT. Please see  TimecodeScale  for more information.

**Returns:**
java.lang.Double - The duration of the SEGMENT.
##### getDateUtc()
```
public final Date getDateUtc()
```

Gets the date and time that the Segment was created by the muxing application or library.

**Returns:**
java.util.Date - The date and time that the Segment was created by the muxing application or library.
##### getTitle()
```
public final String getTitle()
```

Gets the general name of the Segment.

**Returns:**
java.lang.String - The general name of the Segment.
##### getMuxingApp()
```
public final String getMuxingApp()
```

Gets the full name of the application or library followed by the version number.

**Returns:**
java.lang.String - The full name of the application or library followed by the version number.
##### getWritingApp()
```
public final String getWritingApp()
```

Gets the full name of the application followed by the version number.

**Returns:**
java.lang.String - The full name of the application followed by the version number.
##### getScaledDuration()
```
public final Double getScaledDuration()
```

Gets the scaled duration of the SEGMENT in milliseconds.

**Returns:**
java.lang.Double - The scaled duration of the SEGMENT in milliseconds.

### MatroskaSimpleTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskasimpletag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSimpleTag extends MatroskaBasePackage
```

Represents general information about the target in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files

### MatroskaSubtitle
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskasubtitle.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaSubtitle extends MatroskaBasePackage
```

Represents subtitle metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTimecode() | Gets the time code. |
| getDuration() | Gets the duration. |
| getText() | Gets the subtitle text. |
##### getTimecode()
```
public final double getTimecode()
```

Gets the time code.

**Returns:**
double - The time code.
##### getDuration()
```
public final double getDuration()
```

Gets the duration.

**Returns:**
double - The duration.
##### getText()
```
public final String getText()
```

Gets the subtitle text.

**Returns:**
java.lang.String - The subtitle text.

### MatroskaSubtitleTrack
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskasubtitletrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaSubtitleTrack extends MatroskaTrack
```

Represents subtitle metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getSubtitles() | Gets the subtitles. |
##### getSubtitles()
```
public final MatroskaSubtitle[] getSubtitles()
```

Gets the subtitles.

**Returns:**
com.groupdocs.metadata.core.MatroskaSubtitle[] - The subtitles.

### MatroskaTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskatag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaTag extends MatroskaBasePackage
```

Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTargetTypeValue() | Gets the number to indicate the logical level of the target. |
| getTargetType() | Gets an informational string that can be used to display the logical level of the target. |
| getTagTrackUid() | Gets a unique ID to identify the Track(s) the tags belong to. |
| getSimpleTags() | Gets the general information about the target. |
##### getTargetTypeValue()
```
public final MatroskaTargetTypeValue getTargetTypeValue()
```

Gets the number to indicate the logical level of the target.

**Returns:**
MatroskaTargetTypeValue - The number to indicate the logical level of the target.
##### getTargetType()
```
public final String getTargetType()
```

Gets an informational string that can be used to display the logical level of the target. Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc.

**Returns:**
java.lang.String - An informational string that can be used to display the logical level of the target.
##### getTagTrackUid()
```
public final long getTagTrackUid()
```

Gets a unique ID to identify the Track(s) the tags belong to. If the value is 0 at this level, the tags apply to all tracks in the Segment.

**Returns:**
long - A unique ID to identify the Track(s) the tags belong to.
##### getSimpleTags()
```
public final MatroskaSimpleTag getSimpleTags()
```

Gets the general information about the target.

**Returns:**
MatroskaSimpleTag - The general information about the target.

### MatroskaTargetTypeValue
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskatargettypevalue.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaTargetTypeValue extends Enum<MatroskaTargetTypeValue> implements IEnumValue
```

Represents a number to indicate the logical level of the Matroska tag target.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined level. |
| Collection | COLLECTION level. |
| Edition | EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level. |
| Album | ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level. |
| Part | PART / SESSION level. |
| Track | TRACK / SONG / CHAPTER level. |
| Subtrack | SUBTRACK / PART / MOVEMENT / SCENE level. |
| Shot | SHOT level. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaTargetTypeValue Undefined
```

Undefined level.

##### Collection
```
public static final MatroskaTargetTypeValue Collection
```

COLLECTION level.

##### Edition
```
public static final MatroskaTargetTypeValue Edition
```

EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level.

##### Album
```
public static final MatroskaTargetTypeValue Album
```

ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level.

##### Part
```
public static final MatroskaTargetTypeValue Part
```

PART / SESSION level.

##### Track
```
public static final MatroskaTargetTypeValue Track
```

TRACK / SONG / CHAPTER level.

##### Subtrack
```
public static final MatroskaTargetTypeValue Subtrack
```

SUBTRACK / PART / MOVEMENT / SCENE level.

##### Shot
```
public static final MatroskaTargetTypeValue Shot
```

SHOT level.

##### values()
```
public static MatroskaTargetTypeValue[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaTargetTypeValue[]
##### valueOf(String name)
```
public static MatroskaTargetTypeValue valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaTargetTypeValue
##### getByRawValue(int rawValue)
```
public static MatroskaTargetTypeValue getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaTargetTypeValue
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaTrack
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskatrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage
```
public class MatroskaTrack extends MatroskaBasePackage
```

Represents track metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getTrackNumber() | Gets the track number as used in the Block Header. |
| getTrackUid() | Gets the unique ID to identify the Track. |
| getTrackType() | Gets the type of the track. |
| getFlagEnabled() | Gets the enabled flag, true if the track is usable. |
| getDefaultDuration() | Gets the number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame. |
| getName() | Gets the human-readable track name. |
| getLanguage() | Gets the language of the track in the Matroska languages form. |
| getLanguageIetf() | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. |
| getCodecID() | Gets an ID corresponding to the codec. |
| getCodecName() | Gets a human-readable string specifying the codec. |
##### getTrackNumber()
```
public final long getTrackNumber()
```

Gets the track number as used in the Block Header. Using more than 127 tracks is not encouraged, though the design allows an unlimited number.

**Returns:**
long - The track number as used in the Block Header.
##### getTrackUid()
```
public final long getTrackUid()
```

Gets the unique ID to identify the Track. This SHOULD be kept the same when making a direct stream copy of the Track to another file.

**Returns:**
long - The unique ID to identify the Track.
##### getTrackType()
```
public final MatroskaTrackType getTrackType()
```

Gets the type of the track.

**Returns:**
MatroskaTrackType - The type of the track.
##### getFlagEnabled()
```
public final boolean getFlagEnabled()
```

Gets the enabled flag, true if the track is usable.

**Returns:**
boolean - The enabled flag.
##### getDefaultDuration()
```
public final Long getDefaultDuration()
```

Gets the number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame.

**Returns:**
java.lang.Long - The number of nanoseconds (not scaled via  MatroskaSegment.TimecodeScale ) per frame.

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### getName()
```
public final String getName()
```

Gets the human-readable track name.

**Returns:**
java.lang.String - The human-readable track name.
##### getLanguage()
```
public final String getLanguage()
```

Gets the language of the track in the Matroska languages form. This Element MUST be ignored if the  LanguageIetf  Element is used in the same TrackEntry.

**Returns:**
java.lang.String - The language of the track in the Matroska languages form.

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french), or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French). Country codes are the same as used for internet domains.
##### getLanguageIetf()
```
public final String getLanguageIetf()
```

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry. If this Element is used, then any  Language  Elements used in the same TrackEntry MUST be ignored.

**Returns:**
java.lang.String - The language of the track according to BCP 47 and using the IANA Language Subtag Registry.
##### getCodecID()
```
public final String getCodecID()
```

Gets an ID corresponding to the codec.

**Returns:**
java.lang.String - An ID corresponding to the codec.

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### getCodecName()
```
public final String getCodecName()
```

Gets a human-readable string specifying the codec.

**Returns:**
java.lang.String - A human-readable string specifying the codec.

### MatroskaTrackType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskatracktype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaTrackType extends Enum<MatroskaTrackType> implements IEnumValue
```

Represents Matroska track types coded in 8 bits.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined track type. |
| Video | Track is a video track. |
| Audio | Track is an audio track. |
| Complex | Track is a complex track, i.e. |
| Logo | Track is a logo track. |
| Subtitle | Track is a subtitle track. |
| Button | Track is a button track. |
| Control | Track is a control track. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MatroskaTrackType Undefined
```

The undefined track type.

##### Video
```
public static final MatroskaTrackType Video
```

Track is a video track.

##### Audio
```
public static final MatroskaTrackType Audio
```

Track is an audio track.

##### Complex
```
public static final MatroskaTrackType Complex
```

Track is a complex track, i.e. a combined video and audio track.

##### Logo
```
public static final MatroskaTrackType Logo
```

Track is a logo track.

##### Subtitle
```
public static final MatroskaTrackType Subtitle
```

Track is a subtitle track.

##### Button
```
public static final MatroskaTrackType Button
```

Track is a button track.

##### Control
```
public static final MatroskaTrackType Control
```

Track is a control track.

##### values()
```
public static MatroskaTrackType[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaTrackType[]
##### valueOf(String name)
```
public static MatroskaTrackType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaTrackType
##### getByRawValue(int rawValue)
```
public static MatroskaTrackType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaTrackType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoDisplayUnit
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskavideodisplayunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoDisplayUnit extends Enum<MatroskaVideoDisplayUnit> implements IEnumValue
```

Defines how Matroska DisplayWidth and DisplayHeight are interpreted.
#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels unit. |
| Centimeters | Centimeters unit. |
| Inches | Inches unit. |
| AspectRatio | Display aspect ratio unit. |
| Unknown | Unknown unit. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Pixels
```
public static final MatroskaVideoDisplayUnit Pixels
```

Pixels unit.

##### Centimeters
```
public static final MatroskaVideoDisplayUnit Centimeters
```

Centimeters unit.

##### Inches
```
public static final MatroskaVideoDisplayUnit Inches
```

Inches unit.

##### AspectRatio
```
public static final MatroskaVideoDisplayUnit AspectRatio
```

Display aspect ratio unit.

##### Unknown
```
public static final MatroskaVideoDisplayUnit Unknown
```

Unknown unit.

##### values()
```
public static MatroskaVideoDisplayUnit[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoDisplayUnit[]
##### valueOf(String name)
```
public static MatroskaVideoDisplayUnit valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaVideoDisplayUnit
##### getByRawValue(int rawValue)
```
public static MatroskaVideoDisplayUnit getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaVideoDisplayUnit
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoFieldOrder
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskavideofieldorder.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoFieldOrder extends Enum<MatroskaVideoFieldOrder> implements IEnumValue
```

Represents the field ordering of the Matroska video. If FlagInterlaced is not set to 1, this Element MUST be ignored.
#### Fields

| Field | Description |
| --- | --- |
| Progressive | Progressive ordering. |
| Tff | Tiff ordering. |
| Undetermined | Undetermined ordering. |
| Bff | Biff ordering. |
| BffSwapped | Bff (swapped) ordering. |
| TffSwapped | Tff (swapped) ordering. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Progressive
```
public static final MatroskaVideoFieldOrder Progressive
```

Progressive ordering.

##### Tff
```
public static final MatroskaVideoFieldOrder Tff
```

Tiff ordering.

##### Undetermined
```
public static final MatroskaVideoFieldOrder Undetermined
```

Undetermined ordering.

##### Bff
```
public static final MatroskaVideoFieldOrder Bff
```

Biff ordering.

##### BffSwapped
```
public static final MatroskaVideoFieldOrder BffSwapped
```

Bff (swapped) ordering.

##### TffSwapped
```
public static final MatroskaVideoFieldOrder TffSwapped
```

Tff (swapped) ordering.

##### values()
```
public static MatroskaVideoFieldOrder[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoFieldOrder[]
##### valueOf(String name)
```
public static MatroskaVideoFieldOrder valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaVideoFieldOrder
##### getByRawValue(int rawValue)
```
public static MatroskaVideoFieldOrder getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaVideoFieldOrder
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoFlagInterlaced
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskavideoflaginterlaced.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoFlagInterlaced extends Enum<MatroskaVideoFlagInterlaced> implements IEnumValue
```

Represents a flag to declare if the Matroska video is known to be progressive or interlaced and if applicable to declare details about the interlacement.
#### Fields

| Field | Description |
| --- | --- |
| Undetermined | Undetermined flag. |
| Interlaced | Interlaced flag. |
| Progressive | Progressive flag. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undetermined
```
public static final MatroskaVideoFlagInterlaced Undetermined
```

Undetermined flag.

##### Interlaced
```
public static final MatroskaVideoFlagInterlaced Interlaced
```

Interlaced flag.

##### Progressive
```
public static final MatroskaVideoFlagInterlaced Progressive
```

Progressive flag.

##### values()
```
public static MatroskaVideoFlagInterlaced[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoFlagInterlaced[]
##### valueOf(String name)
```
public static MatroskaVideoFlagInterlaced valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaVideoFlagInterlaced
##### getByRawValue(int rawValue)
```
public static MatroskaVideoFlagInterlaced getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaVideoFlagInterlaced
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoStereoMode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskavideostereomode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MatroskaVideoStereoMode extends Enum<MatroskaVideoStereoMode> implements IEnumValue
```

Represents Matroska Stereo-3D video modes.
#### Fields

| Field | Description |
| --- | --- |
| Mono | Mono mode. |
| SideBySideLeft | Side by side (left eye first) video mode. |
| TopBottomRight | Top - bottom (right eye is first) video mode. |
| TopBottomLeft | Top - bottom (left eye is first) video mode. |
| CheckboardRight | Checkboard (right eye is first) video mode. |
| CheckboardLleft | Checkboard (left eye is first) video mode. |
| RowInterleavedRight | Row interleaved (right eye is first) video mode. |
| RowInterleavedLeft | Row interleaved (left eye is first) video mode. |
| ColumnInterleavedRight | Column interleaved (right eye is first) video mode. |
| ColumnInterleavedLeft | Column interleaved (left eye is first) video mode. |
| AnaglyphCyanRed | Anaglyph (cyan/red) video mode. |
| SideBySideRight | Side by side (right eye first) video mode. |
| AnaglyphGreenMagenta | Anaglyph (green/magenta) video mode. |
| BothEyesLacedLeft | Both eyes laced in one Block (left eye is first) video mode. |
| BothEyesLacedRight | Both eyes laced in one Block (right eye is first) video mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Mono
```
public static final MatroskaVideoStereoMode Mono
```

Mono mode.

##### SideBySideLeft
```
public static final MatroskaVideoStereoMode SideBySideLeft
```

Side by side (left eye first) video mode.

##### TopBottomRight
```
public static final MatroskaVideoStereoMode TopBottomRight
```

Top - bottom (right eye is first) video mode.

##### TopBottomLeft
```
public static final MatroskaVideoStereoMode TopBottomLeft
```

Top - bottom (left eye is first) video mode.

##### CheckboardRight
```
public static final MatroskaVideoStereoMode CheckboardRight
```

Checkboard (right eye is first) video mode.

##### CheckboardLleft
```
public static final MatroskaVideoStereoMode CheckboardLleft
```

Checkboard (left eye is first) video mode.

##### RowInterleavedRight
```
public static final MatroskaVideoStereoMode RowInterleavedRight
```

Row interleaved (right eye is first) video mode.

##### RowInterleavedLeft
```
public static final MatroskaVideoStereoMode RowInterleavedLeft
```

Row interleaved (left eye is first) video mode.

##### ColumnInterleavedRight
```
public static final MatroskaVideoStereoMode ColumnInterleavedRight
```

Column interleaved (right eye is first) video mode.

##### ColumnInterleavedLeft
```
public static final MatroskaVideoStereoMode ColumnInterleavedLeft
```

Column interleaved (left eye is first) video mode.

##### AnaglyphCyanRed
```
public static final MatroskaVideoStereoMode AnaglyphCyanRed
```

Anaglyph (cyan/red) video mode.

##### SideBySideRight
```
public static final MatroskaVideoStereoMode SideBySideRight
```

Side by side (right eye first) video mode.

##### AnaglyphGreenMagenta
```
public static final MatroskaVideoStereoMode AnaglyphGreenMagenta
```

Anaglyph (green/magenta) video mode.

##### BothEyesLacedLeft
```
public static final MatroskaVideoStereoMode BothEyesLacedLeft
```

Both eyes laced in one Block (left eye is first) video mode.

##### BothEyesLacedRight
```
public static final MatroskaVideoStereoMode BothEyesLacedRight
```

Both eyes laced in one Block (right eye is first) video mode.

##### values()
```
public static MatroskaVideoStereoMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.MatroskaVideoStereoMode[]
##### valueOf(String name)
```
public static MatroskaVideoStereoMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MatroskaVideoStereoMode
##### getByRawValue(int rawValue)
```
public static MatroskaVideoStereoMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MatroskaVideoStereoMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MatroskaVideoTrack
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/matroskavideotrack.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.MatroskaBasePackage, com.groupdocs.metadata.core.MatroskaTrack
```
public class MatroskaVideoTrack extends MatroskaTrack
```

Represents video metadata in a Matroska video.

[Working with metadata in Matroska _MKV_ files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Matroska+%28MKV%29+files
#### Methods

| Method | Description |
| --- | --- |
| getFlagInterlaced() | Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| getFieldOrder() | Gets declare the field ordering of the video. |
| getStereoMode() | Gets the stereo-3D video mode. |
| getAlphaMode() | Gets the alpha Video Mode. |
| getPixelWidth() | Gets the width of the encoded video frames in pixels. |
| getPixelHeight() | Gets the height of the encoded video frames in pixels. |
| getPixelCropBottom() | Gets the number of video pixels to remove at the bottom of the image. |
| getPixelCropTop() | Gets the number of video pixels to remove at the top of the image. |
| getPixelCropLeft() | Gets the number of video pixels to remove on the left of the image. |
| getPixelCropRight() | Gets the number of video pixels to remove on the right of the image. |
| getDisplayWidth() | Gets the width of the video frames to display. |
| getDisplayHeight() | Gets the height of the video frames to display. |
| getDisplayUnit() | Gets the how  DisplayWidth and  DisplayHeight  are interpreted. |
##### getFlagInterlaced()
```
public final MatroskaVideoFlagInterlaced getFlagInterlaced()
```

Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.

**Returns:**
MatroskaVideoFlagInterlaced - A flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.
##### getFieldOrder()
```
public final MatroskaVideoFieldOrder getFieldOrder()
```

Gets declare the field ordering of the video. If FlagInterlaced is not set to 1, this Element MUST be ignored.

**Returns:**
MatroskaVideoFieldOrder - Declare the field ordering of the video.
##### getStereoMode()
```
public final MatroskaVideoStereoMode getStereoMode()
```

Gets the stereo-3D video mode.

**Returns:**
MatroskaVideoStereoMode - The stereo-3D video mode.
##### getAlphaMode()
```
public final Long getAlphaMode()
```

Gets the alpha Video Mode. Presence of this Element indicates that the BlockAdditional Element could contain Alpha data.

Value: The alpha Video Mode.

**Returns:**
java.lang.Long
##### getPixelWidth()
```
public final long getPixelWidth()
```

Gets the width of the encoded video frames in pixels.

**Returns:**
long - The width of the encoded video frames in pixels.
##### getPixelHeight()
```
public final long getPixelHeight()
```

Gets the height of the encoded video frames in pixels.

**Returns:**
long - The height of the encoded video frames in pixels.
##### getPixelCropBottom()
```
public final long getPixelCropBottom()
```

Gets the number of video pixels to remove at the bottom of the image.

**Returns:**
long - The number of video pixels to remove at the bottom of the image.
##### getPixelCropTop()
```
public final long getPixelCropTop()
```

Gets the number of video pixels to remove at the top of the image.

**Returns:**
long - The number of video pixels to remove at the top of the image.
##### getPixelCropLeft()
```
public final long getPixelCropLeft()
```

Gets the number of video pixels to remove on the left of the image.

**Returns:**
long - The number of video pixels to remove on the left of the image.
##### getPixelCropRight()
```
public final long getPixelCropRight()
```

Gets the number of video pixels to remove on the right of the image.

**Returns:**
long - The number of video pixels to remove on the right of the image.
##### getDisplayWidth()
```
public final Long getDisplayWidth()
```

Gets the width of the video frames to display. Applies to the video frame after cropping (PixelCrop\* Elements).

**Returns:**
java.lang.Long - The width of the video frames to display.
##### getDisplayHeight()
```
public final Long getDisplayHeight()
```

Gets the height of the video frames to display. Applies to the video frame after cropping (PixelCrop\* Elements).

**Returns:**
java.lang.Long - The height of the video frames to display.
##### getDisplayUnit()
```
public final MatroskaVideoDisplayUnit getDisplayUnit()
```

Gets the how  DisplayWidth and  DisplayHeight  are interpreted.

**Returns:**
MatroskaVideoDisplayUnit - The how  DisplayWidth and  DisplayHeight  are interpreted.

### MetadataPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/metadatapackage.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class MetadataPackage implements Iterable<MetadataProperty>
```

Represents base abstraction for a metadata package.
#### Methods

| Method | Description |
| --- | --- |
| getMetadataType() | Gets the metadata type. |
| getKeys() | Gets a collection of the metadata property names. |
| get_Item(String propertyName) | Gets the  MetadataProperty  with the specified name. |
| getPropertyDescriptors() | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| iterator() | Returns an enumerator that iterates through the collection. |
| contains(String propertyName) | Determines whether the package contains a metadata property with the specified name. |
| getCount() | Gets the number of metadata properties. |
| findProperties(Specification specification) | Finds the metadata properties satisfying a specification. |
| updateProperties(Specification specification, PropertyValue value) | Updates known metadata properties satisfying a specification. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| addProperties(Specification specification, PropertyValue value) | Adds known metadata properties satisfying the specification. |
| setProperties(Specification specification, PropertyValue value) | Sets known metadata properties satisfying the specification. |
| sanitize() | Removes writable metadata properties from the package. |
##### getMetadataType()
```
public final MetadataType getMetadataType()
```

Gets the metadata type.

**Returns:**
MetadataType - The type of the metadata package.
##### getKeys()
```
public final IReadOnlyList<String> getKeys()
```

Gets a collection of the metadata property names.

**Returns:**
IReadOnlyList - A collection of the metadata property names.
##### get_Item(String propertyName)
```
public final MetadataProperty get_Item(String propertyName)
```

Gets the  MetadataProperty  with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the metadata property to be found. Value: The appropriate  MetadataProperty . |

**Returns:**
MetadataProperty - The  MetadataProperty  if found; otherwise, null.
##### getPropertyDescriptors()
```
public final IReadOnlyList<PropertyDescriptor> getPropertyDescriptors()
```

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.

**Returns:**
IReadOnlyList - A collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### iterator()
```
public final Iterator<MetadataProperty> iterator()
```

Returns an enumerator that iterates through the collection.

**Returns:**
java.util.Iterator<com.groupdocs.metadata.core.MetadataProperty> - An enumerator that can be used to iterate through the collection.
##### contains(String propertyName)
```
public final boolean contains(String propertyName)
```

Determines whether the package contains a metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the property to locate in the package. |

**Returns:**
boolean - True if the package contains a property with the specified name; otherwise, false.
##### getCount()
```
public final int getCount()
```

Gets the number of metadata properties.

**Returns:**
int - The number or metadata properties.
##### findProperties(Specification specification)
```
public IReadOnlyList<MetadataProperty> findProperties(Specification specification)
```

Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A function to test each metadata property for a condition.

This example demonstrates how to search for specific metadata properties using tags.

> ```
> ```
>
>  // Constants.InputPptx is an absolute or relative path to your document. Ex: @"C:\Docs\source.pptx"
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      // Fetch all the properties satisfying the predicate:
>      // property contains the name of the last document editor OR the date/time the document was last modified
>      IReadOnlyList properties = metadata.findProperties(
>              new ContainsTagSpecification(Tags.getPerson().getEditor()).or(new ContainsTagSpecification(Tags.getTime().getModified())));
>      for (MetadataProperty property : properties) {
>          System.out.println(String.format("Property name: %s, Property value: %s", property.getName(), property.getValue()));
>      }
>  }
>
> ```
> ```

[Extracting metadata]: https://docs.groupdocs.com/display/metadatajava/Extracting+metadata |

**Returns:**
IReadOnlyList - A collection that contains properties from the package that satisfy the condition.
##### updateProperties(Specification specification, PropertyValue value)
```
public int updateProperties(Specification specification, PropertyValue value)
```

Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

This example demonstrates how to update existing metadata properties by various criteria regardless of the file format.

> ```
> ```
>
>  public class UpdatingMetadata {
>      public static void run() {
>          Date threeDaysAgo = new Date(System.currentTimeMillis() - TimeUnit.DAYS.toMillis(3));
>          File folder = new File(Constants.InputPath);
>          for (File file : folder.listFiles()) {
>              try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>                  if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>                      System.out.println();
>                      System.out.println(file.getName());
>                      // Update the file creation date/time if the existing value is older than 3 days
>                      int affected = metadata.updateProperties(new ContainsTagSpecification(Tags.getTime().getCreated()).and(
>                              new OfTypeSpecification(MetadataPropertyType.DateTime)).and(
>                              new UpdatingMetadata().new DateBeforeSpecification(threeDaysAgo)), new PropertyValue(new Date()));
>                      System.out.println(String.format("Affected properties: %s", affected));
>                      metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>                  }
>              }
>          }
>      }
>      // Define your own specifications to filter metadata properties
>      public class DateBeforeSpecification extends Specification {
>          public DateBeforeSpecification(Date date) {
>              setValue(date);
>          }
>
>          public final Date getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Date value) {
>              auto_Value = value;
>          }
>
>          private Date auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              Date date = candidate.getValue().toClass(Date.class);
>              if (date != null) {
>                  return date.before(getValue());
>              }
>              return false;
>          }
>      }
>  }
>
> ```
> ```

[Updating metadata]: https://docs.groupdocs.com/display/metadatajava/Updating+metadata |

**Returns:**
int - The number of affected properties.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition.

This example demonstrates how to remove specific metadata properties using various criteria.

> ```
> ```
>
>  public class RemoveMetadataProperties {
>      public static void run() {
>          // Constants.InputDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>          try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>
>              // Remove all the properties satisfying the predicate:
>              // property contains the name of the document author OR
>              // it refers to the last editor OR
>              // the property value is a string that is equal to the given string "John" (to remove any mentions of John from the detected metadata)
>              int affected = metadata.removeProperties(
>                      new ContainsTagSpecification(Tags.getPerson().getCreator()).or(
>                              new ContainsTagSpecification(Tags.getPerson().getEditor())).or(
>                              new OfTypeSpecification(MetadataPropertyType.String).and(new RemoveMetadataProperties().new WithValueSpecification("John"))));
>
>              System.out.println(String.format("Properties removed: %s", affected));
>
>              metadata.save(Constants.OutputDocx);
>          }
>      }
>
>      // Define your own specifications to filter metadata properties
>      public class WithValueSpecification extends Specification {
>          public WithValueSpecification(Object value) {
>              setValue(value);
>          }
>
>          public final Object getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Object value) {
>              auto_Value = value;
>          }
>
>          private Object auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              return candidate.getValue().getRawValue().equals(getValue());
>          }
>      }
>  }
>
> ```
> ```

[Removing metadata]: https://docs.groupdocs.com/display/metadatajava/Removing+metadata |

**Returns:**
int - The number of affected properties.
##### addProperties(Specification specification, PropertyValue value)
```
public int addProperties(Specification specification, PropertyValue value)
```

Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties.

This example demonstrates how to add some missing metadata properties to a file regardless of its format.

> ```
> ```
>
>  File folder = new File(Constants.InputPath);
>  for (File file : folder.listFiles()) {
>      try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>          if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>              System.out.println();
>              System.out.println(file.getName());
>              // Add a property containing the file last printing date if it's missing
>              // Note that the property will be added to metadata packages that satisfy the following criteria:
>              // 1) Only existing metadata packages will be affected. No new packages are added during this operation
>              // 2) There should be a known metadata property in the package structure that fits the search condition but is actually missing in the package.
>              // All properties supported by a certain package are usually defined in the specification of a particular metadata standard
>              int affected = metadata.addProperties(new ContainsTagSpecification(Tags.getTime().getPrinted()), new PropertyValue(new Date()));
>              System.out.println(String.format("Affected properties: %s", affected));
>              metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>          }
>      }
>  }
>
> ```
> ```

[Adding metadata]: https://docs.groupdocs.com/display/metadatajava/Adding+metadata |

**Returns:**
int - The number of affected properties.
##### setProperties(Specification specification, PropertyValue value)
```
public int setProperties(Specification specification, PropertyValue value)
```

Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of  AddProperties  and  UpdateProperties . If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

This example demonstrates how to set specific metadata properties using different criteria.

> ```
> ```
>
>  // Constants.InputVsdx is an absolute or relative path to your document. Ex: @"C:\Docs\source.vsdx"
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      // Set the value of each property that satisfies the predicate:
>      // property contains the date/time the document was created OR modified
>      int affected = metadata.setProperties(
>              new ContainsTagSpecification(Tags.getTime().getCreated()).or(new ContainsTagSpecification(Tags.getTime().getModified())),
>              new PropertyValue(new Date()));
>      System.out.println(String.format("Properties set: %s", affected));
>      metadata.save(Constants.OutputVsdx);
>  }
>
> ```
> ```

[Set metadata properties]: https://docs.groupdocs.com/display/metadatajava/Set+metadata+properties |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

This example demonstrates how to remove all detected metadata packages/properties from a file.

> ```
> ```
>
>  // Constants.InputPdf is an absolute or relative path to your document. Ex: @"C:\Docs\source.pdf"
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      // Remove detected metadata packages
>      int affected = metadata.sanitize();
>      System.out.println(String.format("Properties removed: %s", affected));
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata

### MetadataProperty
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/metadataproperty.md

**Inheritance:**
java.lang.Object
```
public class MetadataProperty
```

Represents a metadata property.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataProperty(String name, PropertyValue value) | Initializes a new instance of the  MetadataProperty  class. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getValue() | Gets the property value. |
| getInterpretedValue() | Gets the interpreted property value, if available. |
| getDescriptor() | Gets the descriptor associated with the metadata property. |
| getTags() | Gets a collection of tags associated with the property. |
##### MetadataProperty(String name, PropertyValue value)
```
public MetadataProperty(String name, PropertyValue value)
```

Initializes a new instance of the  MetadataProperty  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the metadata property. |
| value | PropertyValue | The value of the metadata property. |

##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getValue()
```
public final PropertyValue getValue()
```

Gets the property value.

**Returns:**
PropertyValue - The property value.
##### getInterpretedValue()
```
public final PropertyValue getInterpretedValue()
```

Gets the interpreted property value, if available. The interpreted value is a user-friendly form of the original property value. For example, it returns a human-readable string instead of numeric flags and ids, if necessary, translates byte arrays to text, etc.

**Returns:**
PropertyValue - The interpreted property value, if available.
##### getDescriptor()
```
public final PropertyDescriptor getDescriptor()
```

Gets the descriptor associated with the metadata property.

**Returns:**
PropertyDescriptor - The descriptor associated with the metadata property.
##### getTags()
```
public final IReadOnlyList<PropertyTag> getTags()
```

Gets a collection of tags associated with the property.

**Returns:**
IReadOnlyList - A collection of tags associated with the property.

### MetadataPropertyType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/metadatapropertytype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MetadataPropertyType extends Enum<MetadataPropertyType> implements IEnumValue
```

Defines metadata property types.
#### Fields

| Field | Description |
| --- | --- |
| Empty | Represents an empty (null) property. |
| String | Represents a string property. |
| Boolean | Represents a boolean property. |
| DateTime | Represents a date property. |
| TimeSpan | Represents a time property. |
| Integer | Represents an integer property. |
| Long | Represents a long integer property. |
| Double | Represents a property with a double or float value. |
| StringArray | Represents a string array property. |
| ByteArray | Represents a byte array property. |
| DoubleArray | Represents an array of double values. |
| IntegerArray | Represents an array of integer values. |
| LongArray | Represents an array of long values. |
| Metadata | Represents a nested metadata block. |
| MetadataArray | Represents an array of nested metadata blocks. |
| Guid | Represents a global unique identifier value. |
| PropertyValueArray | Represents a metadata property value array. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Empty
```
public static final MetadataPropertyType Empty
```

Represents an empty (null) property.

##### String
```
public static final MetadataPropertyType String
```

Represents a string property.

##### Boolean
```
public static final MetadataPropertyType Boolean
```

Represents a boolean property.

##### DateTime
```
public static final MetadataPropertyType DateTime
```

Represents a date property.

##### TimeSpan
```
public static final MetadataPropertyType TimeSpan
```

Represents a time property.

##### Integer
```
public static final MetadataPropertyType Integer
```

Represents an integer property.

##### Long
```
public static final MetadataPropertyType Long
```

Represents a long integer property.

##### Double
```
public static final MetadataPropertyType Double
```

Represents a property with a double or float value.

##### StringArray
```
public static final MetadataPropertyType StringArray
```

Represents a string array property.

##### ByteArray
```
public static final MetadataPropertyType ByteArray
```

Represents a byte array property.

##### DoubleArray
```
public static final MetadataPropertyType DoubleArray
```

Represents an array of double values.

##### IntegerArray
```
public static final MetadataPropertyType IntegerArray
```

Represents an array of integer values.

##### LongArray
```
public static final MetadataPropertyType LongArray
```

Represents an array of long values.

##### Metadata
```
public static final MetadataPropertyType Metadata
```

Represents a nested metadata block.

##### MetadataArray
```
public static final MetadataPropertyType MetadataArray
```

Represents an array of nested metadata blocks.

##### Guid
```
public static final MetadataPropertyType Guid
```

Represents a global unique identifier value.

##### PropertyValueArray
```
public static final MetadataPropertyType PropertyValueArray
```

Represents a metadata property value array.

##### values()
```
public static MetadataPropertyType[] values()
```

**Returns:**
com.groupdocs.metadata.core.MetadataPropertyType[]
##### valueOf(String name)
```
public static MetadataPropertyType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MetadataPropertyType
##### getByRawValue(int rawValue)
```
public static MetadataPropertyType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MetadataPropertyType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MetadataType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/metadatatype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MetadataType extends Enum<MetadataType> implements IEnumValue
```

Specifies the type of a metadata package.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The type of a metadata package is undefined. |
| Root | A root metadata package containing other format-specific packages. |
| Xmp | An XMP metadata package. |
| Exif | An EXIF metadata package, |
| Iptc | An IPTC metadata package, |
| DublinCore | A Dublin Core metadata package. |
| ImageResourceBlock | A Photoshop's native metadata package. |
| FileFormat | A package containing information about the format of a loaded file. |
| DigitalSignature | A package containing digital signature metadata. |
| Presentation | A presentation metadata package. |
| Spreadsheet | A spreadsheet metadata package. |
| WordProcessing | A word processing metadata package. |
| Diagram | A diagram metadata package. |
| Note | A metadata package containing information about an electronic note file. |
| ProjectManagement | A metadata package containing information about a project management file. |
| Pdf | A PDF metadata package. |
| DocumentStatistics | A package containing document statistics. |
| Psd | A metadata package containing information about a Photoshop document. |
| Jpeg2000 | A JPEG2000 native metadata package. |
| Dicom | A DICOM native metadata package. |
| Bmp | A BMP native metadata package. |
| Wav | A WAV native metadata package. |
| ID3V1 | An ID3V1 tag. |
| ID3V2 | An ID3V2 tag. |
| MpegAudio | An MPEG audio native metadata package. |
| Lyrics3 | A Lyrics3 metadata package. |
| ApeV2 | An APEv2 metadata package. |
| Avi | An AVI video native metadata package. |
| Flv | An FLV video native metadata package. |
| Asf | An ASF video native metadata package. |
| Mov | A QuickTime video. |
| Matroska | A native metadata package extracted from a video encoded with the Matroska multimedia container. |
| Zip | A native metadata package of a ZIP archive. |
| SevenZip | A native metadata package of a SevenZip archive. |
| VCard | A native metadata package of a VCard. |
| Epub | A native metadata package of a EPUB e-book. |
| OpenType | An OpenType font metadata package. |
| Cad | A metadata package extracted from a CAD drawing. |
| Eml | An EML message metadata package. |
| Msg | An MSG message metadata package. |
| Torrent | A torrent file metadata package. |
| Png | A PNG image metadata package. |
| Dng | A DNG image metadata package. |
| Cr2 | A CR2 image metadata package. |
| Rar | RAR is a proprietary archive file format that supports data compression, error correction and file spanning. |
| Tar | In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes. |
| ThreeDS | 3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software. |
| Dae | A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications. |
| Fbx | FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. |
| Stl | STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems\\u2019 founder, reports that the file extension is an abbreviation for stereolithography. |
| Gis | Gis format |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final MetadataType Undefined
```

The type of a metadata package is undefined.

##### Root
```
public static final MetadataType Root
```

A root metadata package containing other format-specific packages.

##### Xmp
```
public static final MetadataType Xmp
```

An XMP metadata package.

##### Exif
```
public static final MetadataType Exif
```

An EXIF metadata package,

##### Iptc
```
public static final MetadataType Iptc
```

An IPTC metadata package,

##### DublinCore
```
public static final MetadataType DublinCore
```

A Dublin Core metadata package.

##### ImageResourceBlock
```
public static final MetadataType ImageResourceBlock
```

A Photoshop's native metadata package.

##### FileFormat
```
public static final MetadataType FileFormat
```

A package containing information about the format of a loaded file.

##### DigitalSignature
```
public static final MetadataType DigitalSignature
```

A package containing digital signature metadata.

##### Presentation
```
public static final MetadataType Presentation
```

A presentation metadata package.

##### Spreadsheet
```
public static final MetadataType Spreadsheet
```

A spreadsheet metadata package.

##### WordProcessing
```
public static final MetadataType WordProcessing
```

A word processing metadata package.

##### Diagram
```
public static final MetadataType Diagram
```

A diagram metadata package.

##### Note
```
public static final MetadataType Note
```

A metadata package containing information about an electronic note file.

##### ProjectManagement
```
public static final MetadataType ProjectManagement
```

A metadata package containing information about a project management file.

##### Pdf
```
public static final MetadataType Pdf
```

A PDF metadata package.

##### DocumentStatistics
```
public static final MetadataType DocumentStatistics
```

A package containing document statistics.

##### Psd
```
public static final MetadataType Psd
```

A metadata package containing information about a Photoshop document.

##### Jpeg2000
```
public static final MetadataType Jpeg2000
```

A JPEG2000 native metadata package.

##### Dicom
```
public static final MetadataType Dicom
```

A DICOM native metadata package.

##### Bmp
```
public static final MetadataType Bmp
```

A BMP native metadata package.

##### Wav
```
public static final MetadataType Wav
```

A WAV native metadata package.

##### ID3V1
```
public static final MetadataType ID3V1
```

An ID3V1 tag.

##### ID3V2
```
public static final MetadataType ID3V2
```

An ID3V2 tag.

##### MpegAudio
```
public static final MetadataType MpegAudio
```

An MPEG audio native metadata package.

##### Lyrics3
```
public static final MetadataType Lyrics3
```

A Lyrics3 metadata package.

##### ApeV2
```
public static final MetadataType ApeV2
```

An APEv2 metadata package.

##### Avi
```
public static final MetadataType Avi
```

An AVI video native metadata package.

##### Flv
```
public static final MetadataType Flv
```

An FLV video native metadata package.

##### Asf
```
public static final MetadataType Asf
```

An ASF video native metadata package.

##### Mov
```
public static final MetadataType Mov
```

A QuickTime video.

##### Matroska
```
public static final MetadataType Matroska
```

A native metadata package extracted from a video encoded with the Matroska multimedia container.

##### Zip
```
public static final MetadataType Zip
```

A native metadata package of a ZIP archive.

##### SevenZip
```
public static final MetadataType SevenZip
```

A native metadata package of a SevenZip archive.

##### VCard
```
public static final MetadataType VCard
```

A native metadata package of a VCard.

##### Epub
```
public static final MetadataType Epub
```

A native metadata package of a EPUB e-book.

##### OpenType
```
public static final MetadataType OpenType
```

An OpenType font metadata package.

##### Cad
```
public static final MetadataType Cad
```

A metadata package extracted from a CAD drawing.

##### Eml
```
public static final MetadataType Eml
```

An EML message metadata package.

##### Msg
```
public static final MetadataType Msg
```

An MSG message metadata package.

##### Torrent
```
public static final MetadataType Torrent
```

A torrent file metadata package. Please find more information at  [https://en.wikipedia.org/wiki/Torrent\_file/][https_en.wikipedia.org_wiki_Torrent_file] .

[https_en.wikipedia.org_wiki_Torrent_file]: https://en.wikipedia.org/wiki/Torrent_file/

##### Png
```
public static final MetadataType Png
```

A PNG image metadata package.

##### Dng
```
public static final MetadataType Dng
```

A DNG image metadata package.

##### Cr2
```
public static final MetadataType Cr2
```

A CR2 image metadata package.

##### Rar
```
public static final MetadataType Rar
```

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.

##### Tar
```
public static final MetadataType Tar
```

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.

##### ThreeDS
```
public static final MetadataType ThreeDS
```

3DS is one of the file formats used by the Autodesk 3ds Max 3D modeling, animation and rendering software.

##### Dae
```
public static final MetadataType Dae
```

A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications.

##### Fbx
```
public static final MetadataType Fbx
```

FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware.

##### Stl
```
public static final MetadataType Stl
```

STL is a file format native to the stereolithography CAD software created by 3D Systems.[3][4][5] Chuck Hull, the inventor of stereolithography and 3D Systems\\u2019 founder, reports that the file extension is an abbreviation for stereolithography.

##### Gis
```
public static final MetadataType Gis
```

Gis format

##### values()
```
public static MetadataType[] values()
```

**Returns:**
com.groupdocs.metadata.core.MetadataType[]
##### valueOf(String name)
```
public static MetadataType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MetadataType
##### getByRawValue(int rawValue)
```
public static MetadataType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MetadataType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MetadataValidationException
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/metadatavalidationexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class MetadataValidationException extends GroupDocsMetadataException
```

The exception that is thrown when validation errors encountered during metadata saving.
#### Methods

| Method | Description |
| --- | --- |
| getErrors() | Gets an array of the validation errors that were encountered during the last metadata saving. |
##### getErrors()
```
public final String[] getErrors()
```

Gets an array of the validation errors that were encountered during the last metadata saving.

**Returns:**
java.lang.String[] - An array of the validation errors that were encountered during the last metadata saving.

### MovAtom
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/movatom.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IIsoMediaBox
```
public final class MovAtom extends CustomPackage implements IIsoMediaBox
```

Represents a QuickTime atom.

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
#### Methods

| Method | Description |
| --- | --- |
| getOffset() | Gets the atom offset. |
| getSize() | Gets the atom size in bytes. |
| getLongSize() | Gets the atom size in bytes. |
| getType() | Gets the 4-characters type. |
| getDataOffset() | Gets the data offset. |
| getDataSize() | Gets the data size in bytes. |
| hasExtendedSize() | Gets a value indicating whether the extended size field was used to store the atom data. |
| getAtoms() | Gets an array of MovAtom atoms. |
##### getOffset()
```
public final long getOffset()
```

Gets the atom offset.

**Returns:**
long - The atom offset.
##### getSize()
```
public final int getSize()
```

Gets the atom size in bytes.

**Returns:**
int - The atom size.
##### getLongSize()
```
public final long getLongSize()
```

Gets the atom size in bytes.

**Returns:**
long - The atom size.
##### getType()
```
public final String getType()
```

Gets the 4-characters type.

**Returns:**
java.lang.String - The type.
##### getDataOffset()
```
public final long getDataOffset()
```

Gets the data offset.

**Returns:**
long - The data offset.
##### getDataSize()
```
public final int getDataSize()
```

Gets the data size in bytes.

**Returns:**
int - The data size.
##### hasExtendedSize()
```
public final boolean hasExtendedSize()
```

Gets a value indicating whether the extended size field was used to store the atom data.

**Returns:**
boolean - True, if the extended size field was used to store the atom data; otherwise, false.
##### getAtoms()
```
public final MovAtom[] getAtoms()
```

Gets an array of MovAtom atoms.

Value: The QuickTime atoms.

**Returns:**
com.groupdocs.metadata.core.MovAtom[]

### MovPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/movpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class MovPackage extends CustomPackage
```

Represents QuickTime metadata.

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
#### Methods

| Method | Description |
| --- | --- |
| getDirector() | Name of the director of the movie content. |
| getDescription() | Description of the movie file content. |
| getLocationMotion() | An indication of the direction the camera is moving during the shot. |
| getLocationFacing() | An indication of the direction the camera is facing during the shot. |
| getLocationDate() | A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format. |
| getLocationRole() | A single byte, binary value containing a value from the set: 0 indicates \\u201cshooting location\\u201d, 1 indicates \\u201creal location\\u201d, 2 indicates \\u201cfictional location\\u201d. |
| getLocationNote() | Descriptive comment. |
| getLocationBody() | The astronomical body, for compatibility with the 3GPP format |
| getLocationName() | Name of the location. |
| getUserRatings() | A number, assigned by the user, that indicates the rating or relative value of the movie. |
| getUsers() | A name indicating a user-defined collection that includes this movie. |
| getYear() | Year when the movie file or the original content was created or recorded. |
| getSoftware() | Name of software used to create the movie file content. |
| getProducer() | Name of producer of movie file content. |
| getAlbum() | Album or collection name of which the movie content forms a part |
| getKeywords() | Keywords associated with the movie file content. |
| getInformation() | Information about the movie file content. |
| getGenre() | Text describing the genre or genres to which the movie content conforms. |
| getTitle() | The title of the movie file content. |
| getCreationDate() | The date the movie file content was created. |
| getCopyright() | Copyright statement for the movie file content. |
| getComment() | User entered comment regarding the movie file content. |
| getAuthor() | Name of the author of the movie file content. |
| getArtwork() | A single image that can represent the movie file content. |
| getArtist() | Name of the artist who created the movie file content. |
| getPublisher() | Name of publisher of movie file content. |
| getMovieCreationTime() | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| setMovieCreationTime(System.DateTime value) | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| getMovieModificationTime() | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| setMovieModificationTime(System.DateTime value) | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| getMovieDuration() | A time value that indicates the duration of the movie in seconds. |
| getAtoms() | Gets an array of MovAtom atoms. |
##### getDirector()
```
public final String getDirector()
```

Name of the director of the movie content.

Value: The Director.

**Returns:**
java.lang.String
##### getDescription()
```
public final String getDescription()
```

Description of the movie file content.

Value: The Description.

**Returns:**
java.lang.String
##### getLocationMotion()
```
public final String getLocationMotion()
```

An indication of the direction the camera is moving during the shot.

Value: The LocationMotion.

**Returns:**
java.lang.String
##### getLocationFacing()
```
public final String getLocationFacing()
```

An indication of the direction the camera is facing during the shot.

Value: The LocationFacing.

**Returns:**
java.lang.String
##### getLocationDate()
```
public final String getLocationDate()
```

A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format.

Value: The LocationDate.

**Returns:**
java.lang.String
##### getLocationRole()
```
public final String getLocationRole()
```

A single byte, binary value containing a value from the set: 0 indicates \\u201cshooting location\\u201d, 1 indicates \\u201creal location\\u201d, 2 indicates \\u201cfictional location\\u201d. Other values are reserved.

Value: The LocationRole.

**Returns:**
java.lang.String
##### getLocationNote()
```
public final String getLocationNote()
```

Descriptive comment.

Value: The LocationNote.

**Returns:**
java.lang.String
##### getLocationBody()
```
public final String getLocationBody()
```

The astronomical body, for compatibility with the 3GPP format

Value: The LocationBody.

**Returns:**
java.lang.String
##### getLocationName()
```
public final String getLocationName()
```

Name of the location.

Value: The LocationName.

**Returns:**
java.lang.String
##### getUserRatings()
```
public final String getUserRatings()
```

A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.

Value: The UserRatings.

**Returns:**
java.lang.String
##### getUsers()
```
public final String getUsers()
```

A name indicating a user-defined collection that includes this movie.

Value: The Users.

**Returns:**
java.lang.String
##### getYear()
```
public final String getYear()
```

Year when the movie file or the original content was created or recorded.

Value: The Year.

**Returns:**
java.lang.String
##### getSoftware()
```
public final String getSoftware()
```

Name of software used to create the movie file content.

Value: The Software.

**Returns:**
java.lang.String
##### getProducer()
```
public final String getProducer()
```

Name of producer of movie file content.

Value: The Producer.

**Returns:**
java.lang.String
##### getAlbum()
```
public final String getAlbum()
```

Album or collection name of which the movie content forms a part

Value: The Album.

**Returns:**
java.lang.String
##### getKeywords()
```
public final String getKeywords()
```

Keywords associated with the movie file content.

Value: The Keywords.

**Returns:**
java.lang.String
##### getInformation()
```
public final String getInformation()
```

Information about the movie file content.

Value: The Information.

**Returns:**
java.lang.String
##### getGenre()
```
public final String getGenre()
```

Text describing the genre or genres to which the movie content conforms.

Value: The Genre.

**Returns:**
java.lang.String
##### getTitle()
```
public final String getTitle()
```

The title of the movie file content.

Value: The Title.

**Returns:**
java.lang.String
##### getCreationDate()
```
public final String getCreationDate()
```

The date the movie file content was created.

Value: The CreationDate.

**Returns:**
java.lang.String
##### getCopyright()
```
public final String getCopyright()
```

Copyright statement for the movie file content.

Value: The Copyright.

**Returns:**
java.lang.String
##### getComment()
```
public final String getComment()
```

User entered comment regarding the movie file content.

Value: The Comment.

**Returns:**
java.lang.String
##### getAuthor()
```
public final String getAuthor()
```

Name of the author of the movie file content.

Value: The Author.

**Returns:**
java.lang.String
##### getArtwork()
```
public final String getArtwork()
```

A single image that can represent the movie file content.

Value: The Artwork.

**Returns:**
java.lang.String
##### getArtist()
```
public final String getArtist()
```

Name of the artist who created the movie file content.

Value: The Artist.

**Returns:**
java.lang.String
##### getPublisher()
```
public final String getPublisher()
```

Name of publisher of movie file content.

Value: The Publisher.

**Returns:**
java.lang.String
##### getMovieCreationTime()
```
public final System.DateTime getMovieCreationTime()
```

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

Value: A 32-bit integer that specifies the creation calendar date and time for the movie atom.

**Returns:**
com.aspose.ms.System.DateTime
##### setMovieCreationTime(System.DateTime value)
```
public final void setMovieCreationTime(System.DateTime value)
```

A 32-bit integer that specifies the creation calendar date and time for the movie atom.

Value: A 32-bit integer that specifies the creation calendar date and time for the movie atom.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.DateTime |  |

##### getMovieModificationTime()
```
public final System.DateTime getMovieModificationTime()
```

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

Value: A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

**Returns:**
com.aspose.ms.System.DateTime
##### setMovieModificationTime(System.DateTime value)
```
public final void setMovieModificationTime(System.DateTime value)
```

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

Value: A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.DateTime |  |

##### getMovieDuration()
```
public final long getMovieDuration()
```

A time value that indicates the duration of the movie in seconds.

Value: A time value that indicates the duration of the movie in seconds.

**Returns:**
long
##### getAtoms()
```
public final MovAtom[] getAtoms()
```

Gets an array of MovAtom atoms.

Value: The QuickTime atoms.

**Returns:**
com.groupdocs.metadata.core.MovAtom[]

### MovRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/movrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class MovRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in a QuickTime video.

This example shows how to read QuickTime atoms in a MOV video.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMov)) {
>      MovRootPackage root = metadata.getRootPackageGeneric();
>      for (MovAtom atom : root.getMovPackage().getAtoms()) {
>          System.out.println(atom.getType());
>          System.out.println(atom.getOffset());
>          System.out.println(atom.getSize());
>          // ...
>      }
>  }
>
> ```
> ```

[Working with metadata in MOV Files]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+MOV+Files
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getMovPackage() | Gets the QuickTime metadata package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
##### getMovPackage()
```
public final MovPackage getMovPackage()
```

Gets the QuickTime metadata package.

**Returns:**
MovPackage - The QuickTime metadata package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

### MP3RootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/mp3rootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class MP3RootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in an MP3 audio.

[Working with MP3 metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+MP3+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getMpegAudioPackage() | Gets the MPEG audio metadata package. |
| getID3V1() | Gets the ID3v1 metadata tag. |
| setID3V1(ID3V1Tag value) | Sets the ID3v1 metadata tag. |
| getID3V2() | Gets the ID3v2 metadata tag. |
| setID3V2(ID3V2Tag value) | Sets the ID3v2 metadata tag. |
| getLyrics3V2() | Gets the Lyrics3v2 metadata tag. |
| setLyrics3V2(LyricsTag value) | Sets the Lyrics3v2 metadata tag. |
| getApeV2() | Gets the APE v2 metadata. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| removeApeV2() | Removes the APEv2 audio tag. |
| sanitize() | Removes writable metadata properties from the package. |
| copyTo(MetadataPackage metadata) |  |
##### getMpegAudioPackage()
```
public final MpegAudioPackage getMpegAudioPackage()
```

Gets the MPEG audio metadata package.

**Returns:**
MpegAudioPackage - The MPEG audio metadata package.
##### getID3V1()
```
public final ID3V1Tag getID3V1()
```

Gets the ID3v1 metadata tag. Please find more information at  http://id3.org/ID3v1 .

**Returns:**
ID3V1Tag - The ID3v1 metadata tag attached to the audio file.

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file.
##### setID3V1(ID3V1Tag value)
```
public final void setID3V1(ID3V1Tag value)
```

Sets the ID3v1 metadata tag. Please find more information at  http://id3.org/ID3v1 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V1Tag | The ID3v1 metadata tag attached to the audio file.

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file. |

##### getID3V2()
```
public final ID3V2Tag getID3V2()
```

Gets the ID3v2 metadata tag.

**Returns:**
ID3V2Tag - The ID3v2 metadata tag attached to the audio file.
##### setID3V2(ID3V2Tag value)
```
public final void setID3V2(ID3V2Tag value)
```

Sets the ID3v2 metadata tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ID3V2Tag | The ID3v2 metadata tag attached to the audio file. |

##### getLyrics3V2()
```
public final LyricsTag getLyrics3V2()
```

Gets the Lyrics3v2 metadata tag.

**Returns:**
LyricsTag - The Lyrics3v2 metadata tag.
##### setLyrics3V2(LyricsTag value)
```
public final void setLyrics3V2(LyricsTag value)
```

Sets the Lyrics3v2 metadata tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | LyricsTag | The Lyrics3v2 metadata tag. |

##### getApeV2()
```
public final ApePackage getApeV2()
```

Gets the APE v2 metadata.

**Returns:**
ApePackage - The APE v2 metadata.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### removeApeV2()
```
public final void removeApeV2()
```

Removes the APEv2 audio tag.

This feature is not available in trial mode.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.
##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### MpegAudioPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/mpegaudiopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class MpegAudioPackage extends CustomPackage
```

Represents MPEG audio metadata.

This example demonstrates how to read MPEG audio metadata from an MP3 file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.MP3WithID3V2)) {
>      MP3RootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getMpegAudioPackage().getBitrate());
>      System.out.println(root.getMpegAudioPackage().getChannelMode());
>      System.out.println(root.getMpegAudioPackage().getEmphasis());
>      System.out.println(root.getMpegAudioPackage().getFrequency());
>      System.out.println(root.getMpegAudioPackage().getHeaderPosition());
>      System.out.println(root.getMpegAudioPackage().getLayer());
>      // ...
>  }
>
> ```
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| MpegAudioPackage() | Initializes a new instance of the  MpegAudioPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMpegAudioVersion() | Gets the MPEG audio version. |
| getLayer() | Gets the layer description. |
| isProtected() | Gets  true  if protected. |
| getHeaderPosition() | Gets the header offset. |
| getBitrate() | Gets the bitrate. |
| getFrequency() | Gets the frequency. |
| getPaddingBit() | Gets the padding bit. |
| getPrivateBit() | Gets a value indicating whether [private bit]. |
| getChannelMode() | Gets the channel mode. |
| getCopyright() | Gets the copyright bit. |
| isOriginal() | Gets the original bit. |
| getEmphasis() | Gets the emphasis. |
| getModeExtensionBits() | Gets the mode extension bits. |
##### MpegAudioPackage()
```
public MpegAudioPackage()
```

Initializes a new instance of the  MpegAudioPackage  class.

##### getMpegAudioVersion()
```
public final MpegAudioVersion getMpegAudioVersion()
```

Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc.

**Returns:**
MpegAudioVersion - The MPEG audio version.
##### getLayer()
```
public final int getLayer()
```

Gets the layer description. For an MP3 audio it is '3'.

**Returns:**
int - The layer description.
##### isProtected()
```
public final boolean isProtected()
```

Gets  true  if protected.

**Returns:**
boolean -  true  if is protected; otherwise,  false .
##### getHeaderPosition()
```
public final long getHeaderPosition()
```

Gets the header offset.

**Returns:**
long - The header offset.
##### getBitrate()
```
public final int getBitrate()
```

Gets the bitrate.

**Returns:**
int - The bitrate.
##### getFrequency()
```
public final int getFrequency()
```

Gets the frequency.

**Returns:**
int - The frequency.
##### getPaddingBit()
```
public final int getPaddingBit()
```

Gets the padding bit.

**Returns:**
int - The padding bit.
##### getPrivateBit()
```
public final boolean getPrivateBit()
```

Gets a value indicating whether [private bit].

**Returns:**
boolean -  true  if [private bit]; otherwise,  false .
##### getChannelMode()
```
public final MpegChannelMode getChannelMode()
```

Gets the channel mode.

**Returns:**
MpegChannelMode - The channel mode.
##### getCopyright()
```
public final boolean getCopyright()
```

Gets the copyright bit.

**Returns:**
boolean -  true  if copyright; otherwise,  false .
##### isOriginal()
```
public final boolean isOriginal()
```

Gets the original bit.

**Returns:**
boolean -  true  if audio is original; otherwise,  false .
##### getEmphasis()
```
public final MpegEmphasis getEmphasis()
```

Gets the emphasis.

**Returns:**
MpegEmphasis - The emphasis.
##### getModeExtensionBits()
```
public final int getModeExtensionBits()
```

Gets the mode extension bits.

**Returns:**
int - The mode extension bits.

### MpegAudioVersion
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/mpegaudioversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegAudioVersion extends Enum<MpegAudioVersion> implements IEnumValue
```

Represents a particular MPEG standard.
#### Fields

| Field | Description |
| --- | --- |
| Mpeg25 | The MPEG 2.5 standard. |
| Mpeg2 | The MPEG 2 standard. |
| Mpeg1 | The MPEG 1 standard. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Mpeg25
```
public static final MpegAudioVersion Mpeg25
```

The MPEG 2.5 standard.

##### Mpeg2
```
public static final MpegAudioVersion Mpeg2
```

The MPEG 2 standard.

##### Mpeg1
```
public static final MpegAudioVersion Mpeg1
```

The MPEG 1 standard.

##### values()
```
public static MpegAudioVersion[] values()
```

**Returns:**
com.groupdocs.metadata.core.MpegAudioVersion[]
##### valueOf(String name)
```
public static MpegAudioVersion valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MpegAudioVersion
##### getByRawValue(int rawValue)
```
public static MpegAudioVersion getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MpegAudioVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MpegChannelMode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/mpegchannelmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegChannelMode extends Enum<MpegChannelMode> implements IEnumValue
```

Defines MPEG audio channel modes.
#### Fields

| Field | Description |
| --- | --- |
| Stereo | Stereo mode. |
| JointStereo | Joint stereo mode. |
| DualChannel | Dual channel mode. |
| Mono | Mono mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Stereo
```
public static final MpegChannelMode Stereo
```

Stereo mode.

##### JointStereo
```
public static final MpegChannelMode JointStereo
```

Joint stereo mode.

##### DualChannel
```
public static final MpegChannelMode DualChannel
```

Dual channel mode.

##### Mono
```
public static final MpegChannelMode Mono
```

Mono mode.

##### values()
```
public static MpegChannelMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.MpegChannelMode[]
##### valueOf(String name)
```
public static MpegChannelMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MpegChannelMode
##### getByRawValue(int rawValue)
```
public static MpegChannelMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MpegChannelMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MpegEmphasis
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/mpegemphasis.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum MpegEmphasis extends Enum<MpegEmphasis> implements IEnumValue
```

Defines MPEG emphasis types.
#### Fields

| Field | Description |
| --- | --- |
| None | No emphasis indication. |
| Ms5015 | 50/15 ms. |
| Reserved | Reserved. |
| CcitJ17 | CCIT J.17. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final MpegEmphasis None
```

No emphasis indication.

##### Ms5015
```
public static final MpegEmphasis Ms5015
```

50/15 ms.

##### Reserved
```
public static final MpegEmphasis Reserved
```

Reserved.

##### CcitJ17
```
public static final MpegEmphasis CcitJ17
```

CCIT J.17.

##### values()
```
public static MpegEmphasis[] values()
```

**Returns:**
com.groupdocs.metadata.core.MpegEmphasis[]
##### valueOf(String name)
```
public static MpegEmphasis valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
MpegEmphasis
##### getByRawValue(int rawValue)
```
public static MpegEmphasis getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
MpegEmphasis
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### MsgPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/msgpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.EmailPackage
```
public class MsgPackage extends EmailPackage
```

Represents MSG message metadata.

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getBody() | Gets the email message text. |
| getCategories() | Gets the array of categories or keywords. |
| getDeliveryTime() | Gets the date and time the message was delivered. |
##### getBody()
```
public final String getBody()
```

Gets the email message text.

**Returns:**
java.lang.String - The email message text.
##### getCategories()
```
public final String[] getCategories()
```

Gets the array of categories or keywords.

**Returns:**
java.lang.String[] - The array of categories or keywords.
##### getDeliveryTime()
```
public final Date getDeliveryTime()
```

Gets the date and time the message was delivered.

**Returns:**
java.util.Date - The delivery time.

### MsgRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/msgrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.EmailRootPackage
```
public class MsgRootPackage extends EmailRootPackage
```

Represents the root package allowing working with metadata in an MSG email message.

This code sample shows how to extract metadata from an MSG message.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMsg)) {
>      MsgRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getMsgPackage().getSender());
>      System.out.println(root.getMsgPackage().getSubject());
>      for (String recipient : root.getMsgPackage().getRecipients()) {
>          System.out.println(recipient);
>      }
>      for (String attachedFileName : root.getMsgPackage().getAttachedFileNames()) {
>          System.out.println(attachedFileName);
>      }
>      for (MetadataProperty header : root.getMsgPackage().getHeaders()) {
>          System.out.println(String.format("%s = %s", header.getName(), header.getValue()));
>      }
>      System.out.println(root.getMsgPackage().getBody());
>      System.out.println(root.getMsgPackage().getDeliveryTime());
>      // ...
>  }
>
> ```
> ```

[Working with saved Emails]: https://docs.groupdocs.com/display/metadatajava/Working+with+saved+Emails
#### Methods

| Method | Description |
| --- | --- |
| getMsgPackage() | Gets the MSG metadata package. |
##### getMsgPackage()
```
public final MsgPackage getMsgPackage()
```

Gets the MSG metadata package.

**Returns:**
MsgPackage - The MSG metadata package.

### NikonMakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/nikonmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class NikonMakerNotePackage extends MakerNotePackage
```

Represents NIKON MakerNote metadata.
#### Constructors

| Constructor | Description |
| --- | --- |
| NikonMakerNotePackage(TiffTag[] tags) | Initializes a new instance of the  NikonMakerNotePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMakerNoteVersion() | Gets the MakerNote version. |
| getIso() | Gets the iso. |
| getColorMode() | Gets the color mode. |
| getQuality() | Gets the quality string. |
| getWhiteBalance() | Gets the white balance. |
| getSharpness() | Gets the sharpness. |
| getFocusMode() | Gets the focus mode. |
| getFlashSetting() | Gets the flash setting. |
| getFlashType() | Gets the type of the flash. |
##### NikonMakerNotePackage(TiffTag[] tags)
```
public NikonMakerNotePackage(TiffTag[] tags)
```

Initializes a new instance of the  NikonMakerNotePackage  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tags | TiffTag\[\] | Array of TIFF tags. |

##### getMakerNoteVersion()
```
public final byte[] getMakerNoteVersion()
```

Gets the MakerNote version.

**Returns:**
byte[] - The MakerNote version.
##### getIso()
```
public final int[] getIso()
```

Gets the iso.

**Returns:**
int[] - The iso.
##### getColorMode()
```
public final String getColorMode()
```

Gets the color mode.

**Returns:**
java.lang.String - The color mode.
##### getQuality()
```
public final String getQuality()
```

Gets the quality string.

**Returns:**
java.lang.String - The quality.
##### getWhiteBalance()
```
public final String getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.String - The white balance.
##### getSharpness()
```
public final String getSharpness()
```

Gets the sharpness.

**Returns:**
java.lang.String - The sharpness.
##### getFocusMode()
```
public final String getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.String - The focus mode.
##### getFlashSetting()
```
public final String getFlashSetting()
```

Gets the flash setting.

**Returns:**
java.lang.String - The flash setting.
##### getFlashType()
```
public final String getFlashType()
```

Gets the type of the flash.

**Returns:**
java.lang.String - The type of the flash.

### NoteInspectionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/noteinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class NoteInspectionPackage extends CustomPackage
```

Represents a metadata package exposing the internal structure of a note section.

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Gets an array of section pages. |
##### getPages()
```
public final NotePage[] getPages()
```

Gets an array of section pages.

**Returns:**
com.groupdocs.metadata.core.NotePage[] - An array of section pages.

### NotePage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/notepage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class NotePage extends CustomPackage
```

Represents a page in a OneNote section.

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the page author. |
| getTitle() | Gets the page title. |
| getCreationTime() | Gets the creation time. |
| getLastModificationTime() | Gets the last modification time. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the page author.

**Returns:**
java.lang.String - The page author.
##### getTitle()
```
public final String getTitle()
```

Gets the page title.

**Returns:**
java.lang.String - The page title.
##### getCreationTime()
```
public final Date getCreationTime()
```

Gets the creation time.

**Returns:**
java.util.Date - The creation time.
##### getLastModificationTime()
```
public final Date getLastModificationTime()
```

Gets the last modification time.

**Returns:**
java.util.Date - The last modification time.

### NoteRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/noterootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class NoteRootPackage extends RootMetadataPackage
```

Represents the root package intended to work with metadata in an electronic note file.

This code sample demonstrates how to inspect a note document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputOne)) {
>      NoteRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getInspectionPackage().getPages() != null) {
>          for (NotePage page : root.getInspectionPackage().getPages()) {
>              System.out.println(page.getTitle());
>              System.out.println(page.getAuthor());
>              System.out.println(page.getCreationTime());
>              System.out.println(page.getLastModificationTime());
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in Note formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Note+formats
#### Methods

| Method | Description |
| --- | --- |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| copyTo(MetadataPackage metadataPackage) |  |
##### getInspectionPackage()
```
public final NoteInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
NoteInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage |  |

### Oid
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/oid.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class Oid extends CustomPackage
```

Represents an object identifier (OID). An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC for naming any object, concept, or "thing" with a globally unambiguous persistent name.
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the object identifier (OID) value. |
| getFriendlyName() | Gets the friendly name. |
##### getValue()
```
public final String getValue()
```

Gets the object identifier (OID) value.

**Returns:**
java.lang.String - The object identifier (OID) value.
##### getFriendlyName()
```
public final String getFriendlyName()
```

Gets the friendly name.

**Returns:**
java.lang.String - The friendly name.

### OpenTypeBaseNameRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypebasenamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class OpenTypeBaseNameRecord extends CustomPackage
```

Represents the base OpenType Name table record class.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getNameID() | Gets the name identifier. |
| getPlatform() | Gets the platform identifier. |
| getValue() | Gets the string value of record. |
##### getNameID()
```
public final OpenTypeName getNameID()
```

Gets the name identifier.

**Returns:**
OpenTypeName - The name identifier.
##### getPlatform()
```
public final OpenTypePlatform getPlatform()
```

Gets the platform identifier.

**Returns:**
OpenTypePlatform - The platform identifier.
##### getValue()
```
public final String getValue()
```

Gets the string value of record.

**Returns:**
java.lang.String - The string value of record.

### OpenTypeDigitalSignatureFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypedigitalsignatureflags.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeDigitalSignatureFlags extends Enum<OpenTypeDigitalSignatureFlags> implements IEnumValue
```

Represents OpenType font digital signature flags.
#### Fields

| Field | Description |
| --- | --- |
| None | Undefined flag. |
| CannotBeResigned | Cannot be resigned. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### None
```
public static final OpenTypeDigitalSignatureFlags None
```

Undefined flag.

##### CannotBeResigned
```
public static final OpenTypeDigitalSignatureFlags CannotBeResigned
```

Cannot be resigned.

##### values()
```
public static OpenTypeDigitalSignatureFlags[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeDigitalSignatureFlags[]
##### valueOf(String name)
```
public static OpenTypeDigitalSignatureFlags valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeDigitalSignatureFlags
##### getByRawValue(int rawValue)
```
public static OpenTypeDigitalSignatureFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeDigitalSignatureFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeDirectionHint
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypedirectionhint.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeDirectionHint extends Enum<OpenTypeDirectionHint> implements IEnumValue
```

Represents the OpenType font direction.
#### Fields

| Field | Description |
| --- | --- |
| FullyMixed | Fully mixed directional glyphs. |
| OnlyLeftToRight | Only strongly left to right. |
| LeftToRightAndNeutrals | Like  OnlyLeftToRight  but also contains neutrals. |
| OnlyRightToLeft | Only strongly right to left. |
| RightToLeftAndNeutrals | Like  OnlyRightToLeft  but also contains neutrals. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### FullyMixed
```
public static final OpenTypeDirectionHint FullyMixed
```

Fully mixed directional glyphs.

##### OnlyLeftToRight
```
public static final OpenTypeDirectionHint OnlyLeftToRight
```

Only strongly left to right.

##### LeftToRightAndNeutrals
```
public static final OpenTypeDirectionHint LeftToRightAndNeutrals
```

Like  OnlyLeftToRight  but also contains neutrals.

##### OnlyRightToLeft
```
public static final OpenTypeDirectionHint OnlyRightToLeft
```

Only strongly right to left.

##### RightToLeftAndNeutrals
```
public static final OpenTypeDirectionHint RightToLeftAndNeutrals
```

Like  OnlyRightToLeft  but also contains neutrals.

##### values()
```
public static OpenTypeDirectionHint[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeDirectionHint[]
##### valueOf(String name)
```
public static OpenTypeDirectionHint valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeDirectionHint
##### getByRawValue(int rawValue)
```
public static OpenTypeDirectionHint getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeDirectionHint
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeFlags implements IEnumValue
```

Represents OpenType font header flags.
#### Fields

| Field | Description |
| --- | --- |
| None | Undefined, no flags. |
| BaselineAtY0 | Baseline for font at y=0. |
| LeftSidebearingAtX0 | Left sidebearing point at x=0 (relevant only for TrueType rasterizers). |
| DependOnPointSize | Instructions may depend on point size. |
| ForceToInteger | Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear. |
| AlterAdvanceWidth | Instructions may alter advance width (the advance widths might not scale linearly). |
| Lossless | Font data is \\u201clossless\\u201d as a result of having been subjected to optimizing transformation and/or compression. |
| Converted | Font converted (produce compatible metrics). |
| Optimized | Font optimized for ClearType\\u2122. |
| Resort | Last Resort font. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final OpenTypeFlags None
```

Undefined, no flags.

##### BaselineAtY0
```
public static final OpenTypeFlags BaselineAtY0
```

Baseline for font at y=0.

##### LeftSidebearingAtX0
```
public static final OpenTypeFlags LeftSidebearingAtX0
```

Left sidebearing point at x=0 (relevant only for TrueType rasterizers).

##### DependOnPointSize
```
public static final OpenTypeFlags DependOnPointSize
```

Instructions may depend on point size.

##### ForceToInteger
```
public static final OpenTypeFlags ForceToInteger
```

Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear.

##### AlterAdvanceWidth
```
public static final OpenTypeFlags AlterAdvanceWidth
```

Instructions may alter advance width (the advance widths might not scale linearly).

##### Lossless
```
public static final OpenTypeFlags Lossless
```

Font data is \\u201clossless\\u201d as a result of having been subjected to optimizing transformation and/or compression.

##### Converted
```
public static final OpenTypeFlags Converted
```

Font converted (produce compatible metrics).

##### Optimized
```
public static final OpenTypeFlags Optimized
```

Font optimized for ClearType\\u2122.

##### Resort
```
public static final OpenTypeFlags Resort
```

Last Resort font.

##### getByRawValue(int rawValue)
```
public static OpenTypeFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### OpenTypeFont
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypefont.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class OpenTypeFont extends CustomPackage
```

Represents a single font extracted from a file.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getSfntVersion() | Gets the header SFNT version. |
| getMajorVersion() | Gets the header major version. |
| getMinorVersion() | Gets the header minor version. |
| getFontRevision() | Gets the font revision. |
| getFlags() | Gets the header flags. |
| getCreated() | Gets the created date. |
| getModified() | Gets the modified date. |
| getGlyphBounds() | Gets the glyph bounds. |
| getStyle() | Gets the font style. |
| getDirectionHint() | Gets the direction hint. |
| getNames() | Gets the name records. |
| getFontFamilyName() | Gets the name of the font family. |
| getFontSubfamilyName() | Gets the name of the font subfamily. |
| getFullFontName() | Gets the full name of the font. |
| getTypographicFamily() | Gets the typographic family. |
| getTypographicSubfamily() | Gets the typographic subfamily. |
| getWeight() | Gets the font weight. |
| getWidth() | Gets the font width. |
| getEmbeddingLicensingRights() | Gets the embedding licensing rights type. |
##### getSfntVersion()
```
public final OpenTypeVersion getSfntVersion()
```

Gets the header SFNT version.

**Returns:**
OpenTypeVersion - The header SFNT version.
##### getMajorVersion()
```
public final int getMajorVersion()
```

Gets the header major version.

**Returns:**
int - The header major version.
##### getMinorVersion()
```
public final int getMinorVersion()
```

Gets the header minor version.

**Returns:**
int - The header minor version.
##### getFontRevision()
```
public final float getFontRevision()
```

Gets the font revision.

**Returns:**
float - The font revision.
##### getFlags()
```
public final OpenTypeFlags getFlags()
```

Gets the header flags.

**Returns:**
OpenTypeFlags - The header flags.
##### getCreated()
```
public final Date getCreated()
```

Gets the created date.

**Returns:**
java.util.Date - The created date.
##### getModified()
```
public final Date getModified()
```

Gets the modified date.

**Returns:**
java.util.Date - The modified date.
##### getGlyphBounds()
```
public final Rectangle getGlyphBounds()
```

Gets the glyph bounds.

**Returns:**
Rectangle - The glyph bounds.
##### getStyle()
```
public final OpenTypeStyles getStyle()
```

Gets the font style.

**Returns:**
OpenTypeStyles - The font style.
##### getDirectionHint()
```
public final OpenTypeDirectionHint getDirectionHint()
```

Gets the direction hint.

**Returns:**
OpenTypeDirectionHint - The direction hint.
##### getNames()
```
public final OpenTypeBaseNameRecord[] getNames()
```

Gets the name records.

**Returns:**
com.groupdocs.metadata.core.OpenTypeBaseNameRecord[] - The name records.
##### getFontFamilyName()
```
public final String getFontFamilyName()
```

Gets the name of the font family.

**Returns:**
java.lang.String - The name of the font family.
##### getFontSubfamilyName()
```
public final String getFontSubfamilyName()
```

Gets the name of the font subfamily.

**Returns:**
java.lang.String - The name of the font subfamily.
##### getFullFontName()
```
public final String getFullFontName()
```

Gets the full name of the font.

**Returns:**
java.lang.String - The full name of the font.
##### getTypographicFamily()
```
public final String getTypographicFamily()
```

Gets the typographic family.

**Returns:**
java.lang.String - The typographic family.
##### getTypographicSubfamily()
```
public final String getTypographicSubfamily()
```

Gets the typographic subfamily.

**Returns:**
java.lang.String - The typographic subfamily.
##### getWeight()
```
public final OpenTypeWeight getWeight()
```

Gets the font weight.

**Returns:**
OpenTypeWeight - The font weight.
##### getWidth()
```
public final OpenTypeWidth getWidth()
```

Gets the font width.

**Returns:**
OpenTypeWidth - The font width.
##### getEmbeddingLicensingRights()
```
public final OpenTypeLicensingRights getEmbeddingLicensingRights()
```

Gets the embedding licensing rights type.

**Returns:**
OpenTypeLicensingRights - The embedding licensing rights type.

### OpenTypeIsoEncoding
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeisoencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeIsoEncoding extends Enum<OpenTypeIsoEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Iso  platform.
#### Fields

| Field | Description |
| --- | --- |
| Ascii7Bit | The 7-bit ASCII encoding. |
| Iso10646 | The ISO 10646 encoding. |
| Iso8859 | The ISO 8859-1 encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Ascii7Bit
```
public static final OpenTypeIsoEncoding Ascii7Bit
```

The 7-bit ASCII encoding.

##### Iso10646
```
public static final OpenTypeIsoEncoding Iso10646
```

The ISO 10646 encoding.

##### Iso8859
```
public static final OpenTypeIsoEncoding Iso8859
```

The ISO 8859-1 encoding.

##### values()
```
public static OpenTypeIsoEncoding[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeIsoEncoding[]
##### valueOf(String name)
```
public static OpenTypeIsoEncoding valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeIsoEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeIsoEncoding getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeIsoEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeLicensingRights
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypelicensingrights.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeLicensingRights implements IEnumValue
```

Indicates font embedding licensing rights for the font.
#### Fields

| Field | Description |
| --- | --- |
| None | The undefined licensing rights. |
| UsagePermissionsMask | Usage permissions mask. |
| InstallableEmbedding | Installable embedding. |
| RestrictedLicenseEmbedding | Restricted License embedding. |
| PreviewAndPrintEmbedding | Preview and Print embedding. |
| EditableEmbedding | Editable embedding. |
| NoSubsetting | No subsetting. |
| BitmapEmbeddingOnly | Bitmap embedding only. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final OpenTypeLicensingRights None
```

The undefined licensing rights.

##### UsagePermissionsMask
```
public static final OpenTypeLicensingRights UsagePermissionsMask
```

Usage permissions mask.

##### InstallableEmbedding
```
public static final OpenTypeLicensingRights InstallableEmbedding
```

Installable embedding. The font may be embedded, and may be permanently installed for use on a remote systems, or for use by other users.

##### RestrictedLicenseEmbedding
```
public static final OpenTypeLicensingRights RestrictedLicenseEmbedding
```

Restricted License embedding. The font must not be modified, embedded or exchanged in any manner without first obtaining explicit permission of the legal owner.

##### PreviewAndPrintEmbedding
```
public static final OpenTypeLicensingRights PreviewAndPrintEmbedding
```

Preview and Print embedding. The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or printing the document. Documents containing Preview & Print fonts must be opened \\u201cread-only\\u201d; no edits can be applied to the document.

##### EditableEmbedding
```
public static final OpenTypeLicensingRights EditableEmbedding
```

Editable embedding. The font may be embedded, and may be temporarily loaded on other systems. As with Preview and Print embedding, documents containing Editable fonts may be opened for reading. In addition, editing is permitted, including ability to format new text using the embedded font, and changes may be saved.

##### NoSubsetting
```
public static final OpenTypeLicensingRights NoSubsetting
```

No subsetting. When this bit is set, the font may not be subsetted prior to embedding. Other embedding restrictions specified in bits 0 to 3 and bit 9 also apply.

##### BitmapEmbeddingOnly
```
public static final OpenTypeLicensingRights BitmapEmbeddingOnly
```

Bitmap embedding only. When this bit is set, only bitmaps contained in the font may be embedded. No outline data may be embedded. If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail. Other embedding restrictions specified in bits 0-3 and 8 also apply.

##### getByRawValue(int rawValue)
```
public static OpenTypeLicensingRights getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeLicensingRights
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### OpenTypeMacintoshEncoding
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypemacintoshencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeMacintoshEncoding extends Enum<OpenTypeMacintoshEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Macintosh  platform.
#### Fields

| Field | Description |
| --- | --- |
| DefaultSemantics | Default semantics. |
| Version11Semantics | Version 1.1 semantics. |
| Iso106461993Semantics | ISO 10646 1993 semantics (deprecated). |
| Unicode20BmpOnly | Unicode 2.0 or later semantics (BMP only). |
| Unicode20NonBmp | Unicode 2.0 or later semantics (non-BMP characters allowed). |
| UnicodeVariationSequences | Unicode Variation Sequences. |
| FullUnicodeCoverage | Full Unicode coverage. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### DefaultSemantics
```
public static final OpenTypeMacintoshEncoding DefaultSemantics
```

Default semantics.

##### Version11Semantics
```
public static final OpenTypeMacintoshEncoding Version11Semantics
```

Version 1.1 semantics.

##### Iso106461993Semantics
```
public static final OpenTypeMacintoshEncoding Iso106461993Semantics
```

ISO 10646 1993 semantics (deprecated).

##### Unicode20BmpOnly
```
public static final OpenTypeMacintoshEncoding Unicode20BmpOnly
```

Unicode 2.0 or later semantics (BMP only).

##### Unicode20NonBmp
```
public static final OpenTypeMacintoshEncoding Unicode20NonBmp
```

Unicode 2.0 or later semantics (non-BMP characters allowed).

##### UnicodeVariationSequences
```
public static final OpenTypeMacintoshEncoding UnicodeVariationSequences
```

Unicode Variation Sequences.

##### FullUnicodeCoverage
```
public static final OpenTypeMacintoshEncoding FullUnicodeCoverage
```

Full Unicode coverage.

##### values()
```
public static OpenTypeMacintoshEncoding[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeMacintoshEncoding[]
##### valueOf(String name)
```
public static OpenTypeMacintoshEncoding valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeMacintoshEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeMacintoshEncoding getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeMacintoshEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeMacintoshLanguage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypemacintoshlanguage.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeMacintoshLanguage extends Enum<OpenTypeMacintoshLanguage> implements IEnumValue
```

Represents language enum for the  OpenTypePlatform.Macintosh  platform.
#### Fields

| Field | Description |
| --- | --- |
| English | The english language. |
| French | The french language. |
| German | The german language. |
| Italian | The italian language. |
| Dutch | The dutch language. |
| Swedish | The swedish language. |
| Spanish | The spanish language. |
| Danish | The danish language. |
| Portuguese | The portuguese language. |
| Norwegian | The norwegian language. |
| Hebrew | The hebrew language. |
| Japanese | The japanese language. |
| Arabic | The arabic language. |
| Finnish | The finnish language. |
| Greek | The greek language. |
| Icelandic | The icelandic language. |
| Maltese | The maltese language. |
| Turkish | The turkish language. |
| Croatian | The croatian language. |
| ChineseTraditional | The chinese traditional language. |
| Urdu | The urdu language. |
| Hindi | The hindi language. |
| Thai | The thai language. |
| Korean | The korean language. |
| Lithuanian | The lithuanian language. |
| Polish | The polish language. |
| Hungarian | The hungarian language. |
| Estonian | The estonian language. |
| Latvian | The latvian language. |
| Sami | The sami language. |
| Faroese | The faroese language. |
| FarsiPersian | The farsi persian language. |
| Russian | The russian language. |
| ChineseSimplified | The chinese simplifie language. |
| Flemish | The flemish language. |
| IrishGaelic | The irish gaelic language. |
| Albanian | The albanian language. |
| Romanian | The romanian language. |
| Czech | The czech language. |
| Slovak | The slovak language. |
| Slovenian | The slovenian language. |
| Yiddish | The yiddish language. |
| Serbian | The serbian language. |
| Macedonian | The macedonian language. |
| Bulgarian | The bulgarian language. |
| Ukrainian | The ukrainian language. |
| Byelorussian | The byelorussian language. |
| Uzbek | The uzbek language. |
| Kazakh | The kazakh language. |
| AzerbaijaniCyrillic | The azerbaijani cyrillic language. |
| AzerbaijaniArabic | The azerbaijani arabic language. |
| Armenian | The armenian language. |
| Georgian | The georgian language. |
| Moldavian | The moldavian language. |
| Kirghiz | The kirghiz language. |
| Tajiki | The tajiki language. |
| Turkmen | The turkmen language. |
| MongolianMongolian | The mongolian mongolian language. |
| MongolianCyrillic | The mongolian cyrillic language. |
| Pashto | The pashto language. |
| Kurdish | The kurdish language. |
| Kashmiri | The kashmiri language. |
| Sindhi | The sindhi language. |
| Tibetan | The tibetan language. |
| Nepali | The nepali language. |
| Sanskrit | The sanskrit language. |
| Marathi | The marathi language. |
| Bengali | The bengali language. |
| Assamese | The assamese language. |
| Gujarati | The gujarati language. |
| Punjabi | The punjabi language. |
| Oriya | The oriya language. |
| Malayalam | The malayalam language. |
| Kannada | The kannada language. |
| Tamil | The tamil language. |
| Telugu | The telugu language. |
| Sinhalese | The sinhalese language. |
| Burmese | The burmese language. |
| Khmer | The khmer language. |
| Lao | The lao language. |
| Vietnamese | The vietnamese language. |
| Indonesian | The indonesian language. |
| Tagalog | The tagalog language. |
| MalayRoman | The malay roman language. |
| MalayArabic | The malay arabic language. |
| Amharic | The amharic language. |
| Tigrinya | The tigrinya language. |
| Galla | The galla language. |
| Somali | The somali language. |
| Swahili | The swahili language. |
| KinyarwandaOrRuanda | The kinyarwanda or ruanda language. |
| Rundi | The rundi language. |
| NyanjaOrChewa | The nyanja or chewa language. |
| Malagasy | The malagasy language. |
| Esperanto | The esperanto language. |
| Welsh | The welsh language. |
| Basque | The basque language. |
| Catalan | The catalan language. |
| Latin | The latin language. |
| Quechua | The quechua language. |
| Guarani | The guarani language. |
| Aymara | The aymara language. |
| Tatar | The tatar language. |
| Uighur | The uighur language. |
| Dzongkha | The dzongkha language. |
| JavaneseRoman | The javanese roman language. |
| SundaneseRoman | The sundanese roman language. |
| Galician | The galician language. |
| Afrikaans | The afrikaans language. |
| Breton | The breton language. |
| Inuktitut | The inuktitut language. |
| ScottishGaelic | The scottish gaelic language. |
| ManxGaelic | The manx gaelic language. |
| IrishGaelicWithDotAbove | The irish gaelic with dot above language. |
| Tongan | The tongan language. |
| GreekPolytonic | The greek polytonic language. |
| Greenlandic | The greenlandic language. |
| AzerbaijaniRoman | The azerbaijani roman language. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### English
```
public static final OpenTypeMacintoshLanguage English
```

The english language.

##### French
```
public static final OpenTypeMacintoshLanguage French
```

The french language.

##### German
```
public static final OpenTypeMacintoshLanguage German
```

The german language.

##### Italian
```
public static final OpenTypeMacintoshLanguage Italian
```

The italian language.

##### Dutch
```
public static final OpenTypeMacintoshLanguage Dutch
```

The dutch language.

##### Swedish
```
public static final OpenTypeMacintoshLanguage Swedish
```

The swedish language.

##### Spanish
```
public static final OpenTypeMacintoshLanguage Spanish
```

The spanish language.

##### Danish
```
public static final OpenTypeMacintoshLanguage Danish
```

The danish language.

##### Portuguese
```
public static final OpenTypeMacintoshLanguage Portuguese
```

The portuguese language.

##### Norwegian
```
public static final OpenTypeMacintoshLanguage Norwegian
```

The norwegian language.

##### Hebrew
```
public static final OpenTypeMacintoshLanguage Hebrew
```

The hebrew language.

##### Japanese
```
public static final OpenTypeMacintoshLanguage Japanese
```

The japanese language.

##### Arabic
```
public static final OpenTypeMacintoshLanguage Arabic
```

The arabic language.

##### Finnish
```
public static final OpenTypeMacintoshLanguage Finnish
```

The finnish language.

##### Greek
```
public static final OpenTypeMacintoshLanguage Greek
```

The greek language.

##### Icelandic
```
public static final OpenTypeMacintoshLanguage Icelandic
```

The icelandic language.

##### Maltese
```
public static final OpenTypeMacintoshLanguage Maltese
```

The maltese language.

##### Turkish
```
public static final OpenTypeMacintoshLanguage Turkish
```

The turkish language.

##### Croatian
```
public static final OpenTypeMacintoshLanguage Croatian
```

The croatian language.

##### ChineseTraditional
```
public static final OpenTypeMacintoshLanguage ChineseTraditional
```

The chinese traditional language.

##### Urdu
```
public static final OpenTypeMacintoshLanguage Urdu
```

The urdu language.

##### Hindi
```
public static final OpenTypeMacintoshLanguage Hindi
```

The hindi language.

##### Thai
```
public static final OpenTypeMacintoshLanguage Thai
```

The thai language.

##### Korean
```
public static final OpenTypeMacintoshLanguage Korean
```

The korean language.

##### Lithuanian
```
public static final OpenTypeMacintoshLanguage Lithuanian
```

The lithuanian language.

##### Polish
```
public static final OpenTypeMacintoshLanguage Polish
```

The polish language.

##### Hungarian
```
public static final OpenTypeMacintoshLanguage Hungarian
```

The hungarian language.

##### Estonian
```
public static final OpenTypeMacintoshLanguage Estonian
```

The estonian language.

##### Latvian
```
public static final OpenTypeMacintoshLanguage Latvian
```

The latvian language.

##### Sami
```
public static final OpenTypeMacintoshLanguage Sami
```

The sami language.

##### Faroese
```
public static final OpenTypeMacintoshLanguage Faroese
```

The faroese language.

##### FarsiPersian
```
public static final OpenTypeMacintoshLanguage FarsiPersian
```

The farsi persian language.

##### Russian
```
public static final OpenTypeMacintoshLanguage Russian
```

The russian language.

##### ChineseSimplified
```
public static final OpenTypeMacintoshLanguage ChineseSimplified
```

The chinese simplifie language.

##### Flemish
```
public static final OpenTypeMacintoshLanguage Flemish
```

The flemish language.

##### IrishGaelic
```
public static final OpenTypeMacintoshLanguage IrishGaelic
```

The irish gaelic language.

##### Albanian
```
public static final OpenTypeMacintoshLanguage Albanian
```

The albanian language.

##### Romanian
```
public static final OpenTypeMacintoshLanguage Romanian
```

The romanian language.

##### Czech
```
public static final OpenTypeMacintoshLanguage Czech
```

The czech language.

##### Slovak
```
public static final OpenTypeMacintoshLanguage Slovak
```

The slovak language.

##### Slovenian
```
public static final OpenTypeMacintoshLanguage Slovenian
```

The slovenian language.

##### Yiddish
```
public static final OpenTypeMacintoshLanguage Yiddish
```

The yiddish language.

##### Serbian
```
public static final OpenTypeMacintoshLanguage Serbian
```

The serbian language.

##### Macedonian
```
public static final OpenTypeMacintoshLanguage Macedonian
```

The macedonian language.

##### Bulgarian
```
public static final OpenTypeMacintoshLanguage Bulgarian
```

The bulgarian language.

##### Ukrainian
```
public static final OpenTypeMacintoshLanguage Ukrainian
```

The ukrainian language.

##### Byelorussian
```
public static final OpenTypeMacintoshLanguage Byelorussian
```

The byelorussian language.

##### Uzbek
```
public static final OpenTypeMacintoshLanguage Uzbek
```

The uzbek language.

##### Kazakh
```
public static final OpenTypeMacintoshLanguage Kazakh
```

The kazakh language.

##### AzerbaijaniCyrillic
```
public static final OpenTypeMacintoshLanguage AzerbaijaniCyrillic
```

The azerbaijani cyrillic language.

##### AzerbaijaniArabic
```
public static final OpenTypeMacintoshLanguage AzerbaijaniArabic
```

The azerbaijani arabic language.

##### Armenian
```
public static final OpenTypeMacintoshLanguage Armenian
```

The armenian language.

##### Georgian
```
public static final OpenTypeMacintoshLanguage Georgian
```

The georgian language.

##### Moldavian
```
public static final OpenTypeMacintoshLanguage Moldavian
```

The moldavian language.

##### Kirghiz
```
public static final OpenTypeMacintoshLanguage Kirghiz
```

The kirghiz language.

##### Tajiki
```
public static final OpenTypeMacintoshLanguage Tajiki
```

The tajiki language.

##### Turkmen
```
public static final OpenTypeMacintoshLanguage Turkmen
```

The turkmen language.

##### MongolianMongolian
```
public static final OpenTypeMacintoshLanguage MongolianMongolian
```

The mongolian mongolian language.

##### MongolianCyrillic
```
public static final OpenTypeMacintoshLanguage MongolianCyrillic
```

The mongolian cyrillic language.

##### Pashto
```
public static final OpenTypeMacintoshLanguage Pashto
```

The pashto language.

##### Kurdish
```
public static final OpenTypeMacintoshLanguage Kurdish
```

The kurdish language.

##### Kashmiri
```
public static final OpenTypeMacintoshLanguage Kashmiri
```

The kashmiri language.

##### Sindhi
```
public static final OpenTypeMacintoshLanguage Sindhi
```

The sindhi language.

##### Tibetan
```
public static final OpenTypeMacintoshLanguage Tibetan
```

The tibetan language.

##### Nepali
```
public static final OpenTypeMacintoshLanguage Nepali
```

The nepali language.

##### Sanskrit
```
public static final OpenTypeMacintoshLanguage Sanskrit
```

The sanskrit language.

##### Marathi
```
public static final OpenTypeMacintoshLanguage Marathi
```

The marathi language.

##### Bengali
```
public static final OpenTypeMacintoshLanguage Bengali
```

The bengali language.

##### Assamese
```
public static final OpenTypeMacintoshLanguage Assamese
```

The assamese language.

##### Gujarati
```
public static final OpenTypeMacintoshLanguage Gujarati
```

The gujarati language.

##### Punjabi
```
public static final OpenTypeMacintoshLanguage Punjabi
```

The punjabi language.

##### Oriya
```
public static final OpenTypeMacintoshLanguage Oriya
```

The oriya language.

##### Malayalam
```
public static final OpenTypeMacintoshLanguage Malayalam
```

The malayalam language.

##### Kannada
```
public static final OpenTypeMacintoshLanguage Kannada
```

The kannada language.

##### Tamil
```
public static final OpenTypeMacintoshLanguage Tamil
```

The tamil language.

##### Telugu
```
public static final OpenTypeMacintoshLanguage Telugu
```

The telugu language.

##### Sinhalese
```
public static final OpenTypeMacintoshLanguage Sinhalese
```

The sinhalese language.

##### Burmese
```
public static final OpenTypeMacintoshLanguage Burmese
```

The burmese language.

##### Khmer
```
public static final OpenTypeMacintoshLanguage Khmer
```

The khmer language.

##### Lao
```
public static final OpenTypeMacintoshLanguage Lao
```

The lao language.

##### Vietnamese
```
public static final OpenTypeMacintoshLanguage Vietnamese
```

The vietnamese language.

##### Indonesian
```
public static final OpenTypeMacintoshLanguage Indonesian
```

The indonesian language.

##### Tagalog
```
public static final OpenTypeMacintoshLanguage Tagalog
```

The tagalog language.

##### MalayRoman
```
public static final OpenTypeMacintoshLanguage MalayRoman
```

The malay roman language.

##### MalayArabic
```
public static final OpenTypeMacintoshLanguage MalayArabic
```

The malay arabic language.

##### Amharic
```
public static final OpenTypeMacintoshLanguage Amharic
```

The amharic language.

##### Tigrinya
```
public static final OpenTypeMacintoshLanguage Tigrinya
```

The tigrinya language.

##### Galla
```
public static final OpenTypeMacintoshLanguage Galla
```

The galla language.

##### Somali
```
public static final OpenTypeMacintoshLanguage Somali
```

The somali language.

##### Swahili
```
public static final OpenTypeMacintoshLanguage Swahili
```

The swahili language.

##### KinyarwandaOrRuanda
```
public static final OpenTypeMacintoshLanguage KinyarwandaOrRuanda
```

The kinyarwanda or ruanda language.

##### Rundi
```
public static final OpenTypeMacintoshLanguage Rundi
```

The rundi language.

##### NyanjaOrChewa
```
public static final OpenTypeMacintoshLanguage NyanjaOrChewa
```

The nyanja or chewa language.

##### Malagasy
```
public static final OpenTypeMacintoshLanguage Malagasy
```

The malagasy language.

##### Esperanto
```
public static final OpenTypeMacintoshLanguage Esperanto
```

The esperanto language.

##### Welsh
```
public static final OpenTypeMacintoshLanguage Welsh
```

The welsh language.

##### Basque
```
public static final OpenTypeMacintoshLanguage Basque
```

The basque language.

##### Catalan
```
public static final OpenTypeMacintoshLanguage Catalan
```

The catalan language.

##### Latin
```
public static final OpenTypeMacintoshLanguage Latin
```

The latin language.

##### Quechua
```
public static final OpenTypeMacintoshLanguage Quechua
```

The quechua language.

##### Guarani
```
public static final OpenTypeMacintoshLanguage Guarani
```

The guarani language.

##### Aymara
```
public static final OpenTypeMacintoshLanguage Aymara
```

The aymara language.

##### Tatar
```
public static final OpenTypeMacintoshLanguage Tatar
```

The tatar language.

##### Uighur
```
public static final OpenTypeMacintoshLanguage Uighur
```

The uighur language.

##### Dzongkha
```
public static final OpenTypeMacintoshLanguage Dzongkha
```

The dzongkha language.

##### JavaneseRoman
```
public static final OpenTypeMacintoshLanguage JavaneseRoman
```

The javanese roman language.

##### SundaneseRoman
```
public static final OpenTypeMacintoshLanguage SundaneseRoman
```

The sundanese roman language.

##### Galician
```
public static final OpenTypeMacintoshLanguage Galician
```

The galician language.

##### Afrikaans
```
public static final OpenTypeMacintoshLanguage Afrikaans
```

The afrikaans language.

##### Breton
```
public static final OpenTypeMacintoshLanguage Breton
```

The breton language.

##### Inuktitut
```
public static final OpenTypeMacintoshLanguage Inuktitut
```

The inuktitut language.

##### ScottishGaelic
```
public static final OpenTypeMacintoshLanguage ScottishGaelic
```

The scottish gaelic language.

##### ManxGaelic
```
public static final OpenTypeMacintoshLanguage ManxGaelic
```

The manx gaelic language.

##### IrishGaelicWithDotAbove
```
public static final OpenTypeMacintoshLanguage IrishGaelicWithDotAbove
```

The irish gaelic with dot above language.

##### Tongan
```
public static final OpenTypeMacintoshLanguage Tongan
```

The tongan language.

##### GreekPolytonic
```
public static final OpenTypeMacintoshLanguage GreekPolytonic
```

The greek polytonic language.

##### Greenlandic
```
public static final OpenTypeMacintoshLanguage Greenlandic
```

The greenlandic language.

##### AzerbaijaniRoman
```
public static final OpenTypeMacintoshLanguage AzerbaijaniRoman
```

The azerbaijani roman language.

##### values()
```
public static OpenTypeMacintoshLanguage[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeMacintoshLanguage[]
##### valueOf(String name)
```
public static OpenTypeMacintoshLanguage valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeMacintoshLanguage
##### getByRawValue(int rawValue)
```
public static OpenTypeMacintoshLanguage getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeMacintoshLanguage
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeMacintoshNameRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypemacintoshnamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeMacintoshNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for the  OpenTypePlatform.Macintosh  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
| getLanguage() | Gets the language identifier. |
##### getEncoding()
```
public final OpenTypeMacintoshEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeMacintoshEncoding - The encoding identifier.
##### getLanguage()
```
public final OpenTypeMacintoshLanguage getLanguage()
```

Gets the language identifier.

**Returns:**
OpenTypeMacintoshLanguage - The language identifier.

### OpenTypeName
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypename.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeName extends Enum<OpenTypeName> implements IEnumValue
```

Defines pre-defined IDs, they apply to all platforms unless indicated otherwise.
#### Fields

| Field | Description |
| --- | --- |
| CopyrightNotice | Copyright notice. |
| FontFamilyName | Font Family name. |
| FontSubfamilyName | Font Subfamily name. |
| UniqueFontIdentifier | Unique font identifier. |
| FullFontName | Full font name that reflects all family and relevant subfamily descriptors. |
| VersionString | Version string. |
| PostScriptName | PostScript name for the font. |
| Trademark | Trademark notice/information for this font. |
| ManufacturerName | Manufacturer Name. |
| Designer | Designer), name of the designer of the typeface. |
| Description | Description of the typeface. |
| UrlVendor | URL of font vendor (with protocol, e.g., http://, ftp://). |
| UrlDesigner | URL of typeface designer (with protocol, e.g., http://, ftp://). |
| LicenseDescription | Description of how the font may be legally used, or different example scenarios for licensed use. |
| LicenseInfoUrl | URL where additional licensing information can be found. |
| TypographicFamily | Typographic Family name. |
| TypographicSubfamily | Typographic Subfamily name. |
| CompatibleFull | Compatible Full (Macintosh only). |
| SampleText | Sample text. |
| PostScriptCidFindfont | PostScript CID findfont name. |
| WwsFamilyName | WWS Family Name. |
| WwsSubfamilyName | WWS Subfamily Name. |
| LightBackgroundPalette | Light Background Palette. |
| DarkBackgroundPalette | Dark Background Palette. |
| VariationsPostScriptNamePrefix | Variations PostScript Name Prefix. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### CopyrightNotice
```
public static final OpenTypeName CopyrightNotice
```

Copyright notice.

##### FontFamilyName
```
public static final OpenTypeName FontFamilyName
```

Font Family name.

##### FontSubfamilyName
```
public static final OpenTypeName FontSubfamilyName
```

Font Subfamily name.

##### UniqueFontIdentifier
```
public static final OpenTypeName UniqueFontIdentifier
```

Unique font identifier.

##### FullFontName
```
public static final OpenTypeName FullFontName
```

Full font name that reflects all family and relevant subfamily descriptors.

##### VersionString
```
public static final OpenTypeName VersionString
```

Version string.

##### PostScriptName
```
public static final OpenTypeName PostScriptName
```

PostScript name for the font.

##### Trademark
```
public static final OpenTypeName Trademark
```

Trademark notice/information for this font.

##### ManufacturerName
```
public static final OpenTypeName ManufacturerName
```

Manufacturer Name.

##### Designer
```
public static final OpenTypeName Designer
```

Designer), name of the designer of the typeface.

##### Description
```
public static final OpenTypeName Description
```

Description of the typeface.

##### UrlVendor
```
public static final OpenTypeName UrlVendor
```

URL of font vendor (with protocol, e.g., http://, ftp://).

##### UrlDesigner
```
public static final OpenTypeName UrlDesigner
```

URL of typeface designer (with protocol, e.g., http://, ftp://).

##### LicenseDescription
```
public static final OpenTypeName LicenseDescription
```

Description of how the font may be legally used, or different example scenarios for licensed use.

##### LicenseInfoUrl
```
public static final OpenTypeName LicenseInfoUrl
```

URL where additional licensing information can be found.

##### TypographicFamily
```
public static final OpenTypeName TypographicFamily
```

Typographic Family name.

##### TypographicSubfamily
```
public static final OpenTypeName TypographicSubfamily
```

Typographic Subfamily name.

##### CompatibleFull
```
public static final OpenTypeName CompatibleFull
```

Compatible Full (Macintosh only). On the Macintosh, the menu name is constructed using the FOND resource.

##### SampleText
```
public static final OpenTypeName SampleText
```

Sample text. This can be the font name, or any other text that the designer thinks is the best sample to display the font in.

##### PostScriptCidFindfont
```
public static final OpenTypeName PostScriptCidFindfont
```

PostScript CID findfont name.

##### WwsFamilyName
```
public static final OpenTypeName WwsFamilyName
```

WWS Family Name.

##### WwsSubfamilyName
```
public static final OpenTypeName WwsSubfamilyName
```

WWS Subfamily Name.

##### LightBackgroundPalette
```
public static final OpenTypeName LightBackgroundPalette
```

Light Background Palette.

##### DarkBackgroundPalette
```
public static final OpenTypeName DarkBackgroundPalette
```

Dark Background Palette.

##### VariationsPostScriptNamePrefix
```
public static final OpenTypeName VariationsPostScriptNamePrefix
```

Variations PostScript Name Prefix.

##### values()
```
public static OpenTypeName[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeName[]
##### valueOf(String name)
```
public static OpenTypeName valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeName
##### getByRawValue(int rawValue)
```
public static OpenTypeName getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeName
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class OpenTypePackage extends CustomPackage
```

Represents an OpenType font metadata package.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getFonts() | Gets an array of the fonts extracted from the file. |
##### getFonts()
```
public final OpenTypeFont[] getFonts()
```

Gets an array of the fonts extracted from the file.

**Returns:**
com.groupdocs.metadata.core.OpenTypeFont[] - An array of the fonts extracted from the file.

### OpenTypePlatform
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeplatform.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypePlatform extends Enum<OpenTypePlatform> implements IEnumValue
```

Represents OpenType platform for Name table.
#### Fields

| Field | Description |
| --- | --- |
| Unicode | The Unicode platform. |
| Macintosh | The Macintosh platform. |
| Iso | The ISO [deprecated] platform. |
| Windows | The Windows platform. |
| Custom | The Custom platform. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unicode
```
public static final OpenTypePlatform Unicode
```

The Unicode platform.

##### Macintosh
```
public static final OpenTypePlatform Macintosh
```

The Macintosh platform.

##### Iso
```
public static final OpenTypePlatform Iso
```

The ISO [deprecated] platform.

##### Windows
```
public static final OpenTypePlatform Windows
```

The Windows platform.

##### Custom
```
public static final OpenTypePlatform Custom
```

The Custom platform.

##### values()
```
public static OpenTypePlatform[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypePlatform[]
##### valueOf(String name)
```
public static OpenTypePlatform valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypePlatform
##### getByRawValue(int rawValue)
```
public static OpenTypePlatform getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypePlatform
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentyperootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class OpenTypeRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in an OpenType font file.

This example shows how to read OpenType font metadata.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputTtf)) {
>      OpenTypeRootPackage root = metadata.getRootPackageGeneric();
>      // Read the OpenType font metadata
>      for (OpenTypeFont metadataEntry : root.getOpenTypePackage().getFonts()) {
>          // Display the values of some metadata properties
>          System.out.println(metadataEntry.getCreated());
>          System.out.println(metadataEntry.getDirectionHint());
>          System.out.println(metadataEntry.getEmbeddingLicensingRights());
>          System.out.println(metadataEntry.getFlags());
>          System.out.println(metadataEntry.getFontFamilyName());
>          System.out.println(metadataEntry.getFontRevision());
>          System.out.println(metadataEntry.getFontSubfamilyName());
>          System.out.println(metadataEntry.getFullFontName());
>          System.out.println(metadataEntry.getGlyphBounds());
>          System.out.println(metadataEntry.getMajorVersion());
>          System.out.println(metadataEntry.getMinorVersion());
>          System.out.println(metadataEntry.getModified());
>          System.out.println(metadataEntry.getSfntVersion());
>          System.out.println(metadataEntry.getStyle());
>          System.out.println(metadataEntry.getTypographicFamily());
>          System.out.println(metadataEntry.getTypographicSubfamily());
>          System.out.println(metadataEntry.getWeight());
>          System.out.println(metadataEntry.getWidth());
>          for (OpenTypeBaseNameRecord nameRecord : metadataEntry.getNames()) {
>              System.out.println(nameRecord.getNameID());
>              System.out.println(nameRecord.getPlatform());
>              System.out.println(nameRecord.getValue());
>              if (nameRecord instanceof OpenTypeMacintoshNameRecord) {
>                  OpenTypeMacintoshNameRecord macintoshNameRecord = (OpenTypeMacintoshNameRecord) nameRecord;
>                  System.out.println(macintoshNameRecord.getEncoding());
>                  System.out.println(macintoshNameRecord.getLanguage());
>              } else {
>                  if (nameRecord instanceof OpenTypeUnicodeNameRecord) {
>                      OpenTypeUnicodeNameRecord unicodeNameRecord = (OpenTypeUnicodeNameRecord) nameRecord;
>                      System.out.println(unicodeNameRecord.getEncoding());
>                  } else {
>                      if (nameRecord instanceof OpenTypeWindowsNameRecord) {
>                          OpenTypeWindowsNameRecord windowsNameRecord = (OpenTypeWindowsNameRecord) nameRecord;
>                          System.out.println(windowsNameRecord.getEncoding());
>                          System.out.println(windowsNameRecord.getLanguage());
>                      }
>                  }
>              }
>          }
>      }
>  }
>
> ```
> ```

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getOpenTypePackage() | Gets the OpenType metadata package. |
| getDigitalSignaturePackage() | Gets the digital signature metadata package. |
##### getOpenTypePackage()
```
public final OpenTypePackage getOpenTypePackage()
```

Gets the OpenType metadata package.

**Returns:**
OpenTypePackage - The OpenType metadata package.
##### getDigitalSignaturePackage()
```
public final CmsPackage getDigitalSignaturePackage()
```

Gets the digital signature metadata package.

**Returns:**
CmsPackage - The digital signature metadata package.

### OpenTypeStyles
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypestyles.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class OpenTypeStyles implements IEnumValue
```

Represents the OpenType font style.
#### Fields

| Field | Description |
| --- | --- |
| Regular | Normal text. |
| Bold | Bold text. |
| Italic | Italic text. |
| Underline | Underlined text. |
| Outline | Outline text. |
| Shadow | Shadow text. |
| Condensed | Condensed text. |
| Extended | Extended text. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Regular
```
public static final OpenTypeStyles Regular
```

Normal text.

##### Bold
```
public static final OpenTypeStyles Bold
```

Bold text.

##### Italic
```
public static final OpenTypeStyles Italic
```

Italic text.

##### Underline
```
public static final OpenTypeStyles Underline
```

Underlined text.

##### Outline
```
public static final OpenTypeStyles Outline
```

Outline text.

##### Shadow
```
public static final OpenTypeStyles Shadow
```

Shadow text.

##### Condensed
```
public static final OpenTypeStyles Condensed
```

Condensed text.

##### Extended
```
public static final OpenTypeStyles Extended
```

Extended text.

##### getByRawValue(int rawValue)
```
public static OpenTypeStyles getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeStyles
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### OpenTypeUnicodeEncoding
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeunicodeencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeUnicodeEncoding extends Enum<OpenTypeUnicodeEncoding> implements IEnumValue
```

Represents encoding for  OpenTypePlatform.Unicode  platform.
#### Fields

| Field | Description |
| --- | --- |
| Unicode10 | Unicode 1.0 semantics. |
| Unicode11 | Unicode 1.1 semantics. |
| Iso | ISO/IEC 10646 semantics. |
| Unicode20Bmp | Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6). |
| Unicode20Full | Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12). |
| UnicodeVariation | Unicode Variation Sequences ('cmap' subtable format 14). |
| UnicodeFull | Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13). |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unicode10
```
public static final OpenTypeUnicodeEncoding Unicode10
```

Unicode 1.0 semantics.

##### Unicode11
```
public static final OpenTypeUnicodeEncoding Unicode11
```

Unicode 1.1 semantics.

##### Iso
```
public static final OpenTypeUnicodeEncoding Iso
```

ISO/IEC 10646 semantics.

##### Unicode20Bmp
```
public static final OpenTypeUnicodeEncoding Unicode20Bmp
```

Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6).

##### Unicode20Full
```
public static final OpenTypeUnicodeEncoding Unicode20Full
```

Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12).

##### UnicodeVariation
```
public static final OpenTypeUnicodeEncoding UnicodeVariation
```

Unicode Variation Sequences ('cmap' subtable format 14).

##### UnicodeFull
```
public static final OpenTypeUnicodeEncoding UnicodeFull
```

Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13).

##### values()
```
public static OpenTypeUnicodeEncoding[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeUnicodeEncoding[]
##### valueOf(String name)
```
public static OpenTypeUnicodeEncoding valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeUnicodeEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeUnicodeEncoding getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeUnicodeEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeUnicodeNameRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeunicodenamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeUnicodeNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for the  OpenTypePlatform.Unicode  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
##### getEncoding()
```
public final OpenTypeUnicodeEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeUnicodeEncoding - The encoding identifier.

### OpenTypeVersion
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeversion.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeVersion extends Enum<OpenTypeVersion> implements IEnumValue
```

Represents the OpenType version.
#### Fields

| Field | Description |
| --- | --- |
| TrueType | The TrueType font. |
| Cff | The OpenType font with PostScript outlines. |
| TrueTypeOsX | The OS X and iOS TrueType font. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### TrueType
```
public static final OpenTypeVersion TrueType
```

The TrueType font.

##### Cff
```
public static final OpenTypeVersion Cff
```

The OpenType font with PostScript outlines.

##### TrueTypeOsX
```
public static final OpenTypeVersion TrueTypeOsX
```

The OS X and iOS TrueType font.

##### values()
```
public static OpenTypeVersion[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeVersion[]
##### valueOf(String name)
```
public static OpenTypeVersion valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeVersion
##### getByRawValue(int rawValue)
```
public static OpenTypeVersion getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeVersion
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWeight
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypeweight.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWeight extends Enum<OpenTypeWeight> implements IEnumValue
```

Represents the OpenType font weight. Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font. Values from 1 to 1000 are valid.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined weight. |
| Thin | The Thin weight. |
| ExtraLight | The Extra-light (Ultra-light) weight. |
| Light | The Light weight. |
| Normal | The Normal (Regular) weight. |
| Medium | The Medium weight. |
| SemiBold | The Semi-bold (Demi-bold) weight. |
| Bold | The Bold weight. |
| ExtraBold | The Extra-bold (Ultra-bold) weight. |
| Heavy | The Black (Heavy) weight. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final OpenTypeWeight Undefined
```

The undefined weight.

##### Thin
```
public static final OpenTypeWeight Thin
```

The Thin weight.

##### ExtraLight
```
public static final OpenTypeWeight ExtraLight
```

The Extra-light (Ultra-light) weight.

##### Light
```
public static final OpenTypeWeight Light
```

The Light weight.

##### Normal
```
public static final OpenTypeWeight Normal
```

The Normal (Regular) weight.

##### Medium
```
public static final OpenTypeWeight Medium
```

The Medium weight.

##### SemiBold
```
public static final OpenTypeWeight SemiBold
```

The Semi-bold (Demi-bold) weight.

##### Bold
```
public static final OpenTypeWeight Bold
```

The Bold weight.

##### ExtraBold
```
public static final OpenTypeWeight ExtraBold
```

The Extra-bold (Ultra-bold) weight.

##### Heavy
```
public static final OpenTypeWeight Heavy
```

The Black (Heavy) weight.

##### values()
```
public static OpenTypeWeight[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeWeight[]
##### valueOf(String name)
```
public static OpenTypeWeight valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeWeight
##### getByRawValue(int rawValue)
```
public static OpenTypeWeight getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeWeight
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWidth
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypewidth.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWidth extends Enum<OpenTypeWidth> implements IEnumValue
```

Represents the OpenType font width. Indicates a relative change from the normal aspect ratio (width to height ratio) as specified by a font designer for the glyphs in a font.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The undefined wifth. |
| UltraCondensed | The Ultra-condensed wifth. |
| ExtraCondensed | The Extra-condensed wifth. |
| Condensed | The Condensed wifth. |
| SemiCondensed | The Semi-condensed wifth. |
| Medium | The Medium (normal) wifth. |
| SemiExpanded | The Semi-expanded wifth. |
| Expanded | The Expanded wifth. |
| ExtraExpanded | The Extra-expanded wifth. |
| UltraExpanded | The Ultra-expanded wifth. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final OpenTypeWidth Undefined
```

The undefined wifth.

##### UltraCondensed
```
public static final OpenTypeWidth UltraCondensed
```

The Ultra-condensed wifth.

##### ExtraCondensed
```
public static final OpenTypeWidth ExtraCondensed
```

The Extra-condensed wifth.

##### Condensed
```
public static final OpenTypeWidth Condensed
```

The Condensed wifth.

##### SemiCondensed
```
public static final OpenTypeWidth SemiCondensed
```

The Semi-condensed wifth.

##### Medium
```
public static final OpenTypeWidth Medium
```

The Medium (normal) wifth.

##### SemiExpanded
```
public static final OpenTypeWidth SemiExpanded
```

The Semi-expanded wifth.

##### Expanded
```
public static final OpenTypeWidth Expanded
```

The Expanded wifth.

##### ExtraExpanded
```
public static final OpenTypeWidth ExtraExpanded
```

The Extra-expanded wifth.

##### UltraExpanded
```
public static final OpenTypeWidth UltraExpanded
```

The Ultra-expanded wifth.

##### values()
```
public static OpenTypeWidth[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeWidth[]
##### valueOf(String name)
```
public static OpenTypeWidth valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeWidth
##### getByRawValue(int rawValue)
```
public static OpenTypeWidth getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeWidth
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsEncoding
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypewindowsencoding.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWindowsEncoding extends Enum<OpenTypeWindowsEncoding> implements IEnumValue
```

Represents encoding for the  OpenTypePlatform.Windows  platform.
#### Fields

| Field | Description |
| --- | --- |
| Symbol | The Symbol encoding. |
| UnicodeBmp | The Unicode BMP encoding. |
| ShiftJis | The ShiftJIS encoding. |
| Prc | The PRC encoding. |
| Big5 | The Big5 encoding. |
| Wansung | The Wansung encoding. |
| Johab | The Johab encoding. |
| UnicodeFull | The Unicode full repertoire encoding. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Symbol
```
public static final OpenTypeWindowsEncoding Symbol
```

The Symbol encoding.

##### UnicodeBmp
```
public static final OpenTypeWindowsEncoding UnicodeBmp
```

The Unicode BMP encoding.

##### ShiftJis
```
public static final OpenTypeWindowsEncoding ShiftJis
```

The ShiftJIS encoding.

##### Prc
```
public static final OpenTypeWindowsEncoding Prc
```

The PRC encoding.

##### Big5
```
public static final OpenTypeWindowsEncoding Big5
```

The Big5 encoding.

##### Wansung
```
public static final OpenTypeWindowsEncoding Wansung
```

The Wansung encoding.

##### Johab
```
public static final OpenTypeWindowsEncoding Johab
```

The Johab encoding.

##### UnicodeFull
```
public static final OpenTypeWindowsEncoding UnicodeFull
```

The Unicode full repertoire encoding.

##### values()
```
public static OpenTypeWindowsEncoding[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeWindowsEncoding[]
##### valueOf(String name)
```
public static OpenTypeWindowsEncoding valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeWindowsEncoding
##### getByRawValue(int rawValue)
```
public static OpenTypeWindowsEncoding getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeWindowsEncoding
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsLanguage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypewindowslanguage.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum OpenTypeWindowsLanguage extends Enum<OpenTypeWindowsLanguage> implements IEnumValue
```

Represents language for  OpenTypePlatform.Windows  platform.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The unknown language. |
| AfrikaansSouthAfrica | The afrikaans south africa language. |
| AlbanianAlbania | The albanian Albania language. |
| AlsatianFrance | The alsatian France language. |
| AmharicEthiopia | The amharic Rthiopia language. |
| ArabicAlgeria | The arabic Algeria language. |
| ArabicBahrain | The arabic Bahrain language. |
| ArabicEgypt | The arabic Egypt language. |
| ArabicIraq | The arabic Iraq language. |
| ArabicJordan | The arabic Jordan language. |
| ArabicKuwait | The arabic Kuwait language. |
| ArabicLebanon | The arabic Lebanon language. |
| ArabicLibya | The arabic Libya language. |
| ArabicMorocco | The arabic Morocco language. |
| ArabicOman | The arabic Oman language. |
| ArabicQatar | The arabic Qatar language. |
| ArabicSaudiArabia | The arabic Saudi Arabia language. |
| ArabicSyria | The arabic Syria language. |
| ArabicTunisia | The arabic Tunisia language. |
| ArabicUae | The arabic UAE language. |
| ArabicYemen | The arabic Yemen language. |
| ArmenianArmenia | The armenian Armenia language. |
| AssameseIndia | The assamese India language. |
| AzeriCyrillicAzerbaijan | The azeri cyrillic Azerbaijan language. |
| AzeriLatinAzerbaijan | The azeri latin Azerbaijan language. |
| BashkirRussia | The bashkir Russia language. |
| BasqueBasque | The basque Basque language. |
| BelarusianBelarus | The belarusian Belarus language. |
| BengaliBangladesh | The bengali Bangladesh language. |
| BengaliIndia | The bengali India language. |
| BosnianLatinBosniaAndHerzegovina | The bosnian latin Bosnia and Herzegovina language. |
| BretonFrance | The breton France language. |
| BulgarianBulgaria | The bulgarian Bulgaria language. |
| CatalanCatalan | The catalan Catalan language. |
| ChineseHongKongSar | The chinese Hong Kong SAR language. |
| ChineseMacaoSar | The chinese Macao SAR language. |
| ChinesePeoplesRepublicOfChina | The chinese Peoples Republic of China language. |
| ChineseSingapore | The chinese Singapore language. |
| ChineseTaiwan | The chinese Taiwan language. |
| CorsicanFrance | The corsican France language. |
| CroatianCroatia | The croatian Croatia language. |
| CroatianLatinBosniaAndHerzegovina | The croatian latin Bosnia and Herzegovina language. |
| CzechCzechRepublic | The czech Czech Republic language. |
| DanishDenmark | The danish Denmark language. |
| DariAfghanistan | The dari Afghanistan language. |
| DivehiMaldives | The divehi Maldives language. |
| DutchBelgium | The dutch Belgium language. |
| DutchNetherlands | The dutch Netherlands language. |
| EnglishAustralia | The english Australia language. |
| EnglishBelize | The english Belize language. |
| EnglishCanada | The english Canada language. |
| EnglishCaribbean | The english Caribbean language. |
| EnglishIndia | The english India language. |
| EnglishIreland | The english Ireland language. |
| EnglishJamaica | The english Jamaica language. |
| EnglishMalaysia | The english Malaysia language. |
| EnglishNewZealand | The english New Zealand language. |
| EnglishRepublicOfThePhilippines | The english Republic of the Philippines language. |
| EnglishSingapore | The english Singapore language. |
| EnglishSouthAfrica | The english south africa language. |
| EnglishTrinidadAndTobago | The english Trinidad and Tobago language. |
| EnglishUnitedKingdom | The english United Kingdom language. |
| EnglishUnitedStates | The english United States language. |
| EnglishZimbabwe | The english Zimbabwe language. |
| EstonianEstonia | The estonian Estonia language. |
| FaroeseFaroeIslands | The faroese Faroe Islands language. |
| FilipinoPhilippines | The filipino Philippines language. |
| FinnishFinland | The finnish Finland language. |
| FrenchBelgium | The french Belgium language. |
| FrenchCanada | The french Canada language. |
| FrenchFrance | The french France language. |
| FrenchLuxembourg | The french Luxembourg language. |
| FrenchPrincipalityOfMonaco | The french Principality of Monaco language. |
| FrenchSwitzerland | The french Switzerland language. |
| FrisianNetherlands | The frisian Netherlands language. |
| GalicianGalician | The galician Galician language. |
| GeorgianGeorgia | The georgian Georgia language. |
| GermanAustria | The german Austria language. |
| GermanGermany | The german Germany language. |
| GermanLiechtenstein | The german Liechtenstein language. |
| GermanLuxembourg | The german Luxembourg language. |
| GermanSwitzerland | The german Switzerland language. |
| GreekGreece | The greek Greece language. |
| GreenlandicGreenland | The greenlandic Greenland language. |
| GujaratiIndia | The gujarati India language. |
| HausaLatinNigeria | The hausa latin Nigeria language. |
| HebrewIsrael | The hebrew Israel language. |
| HindiIndia | The hindi India language. |
| HungarianHungary | The hungarian Hungary language. |
| IcelandicIceland | The icelandic Iceland language. |
| IgboNigeria | The igbo Nigeria language. |
| IndonesianIndonesia | The indonesian Indonesia language. |
| InuktitutCanada | The inuktitut Canada language. |
| InuktitutLatinCanada | The inuktitut latin Canada language. |
| IrishIreland | The irish Ireland language. |
| IsiXhosaSouthAfrica | The isi xhosa South Africa language. |
| IsiZuluSouthAfrica | The isi zulu South Africa language. |
| ItalianItaly | The italian Italy language. |
| ItalianSwitzerland | The italian Switzerland language. |
| JapaneseJapan | The japanese Japan language. |
| KannadaIndia | The kannada India language. |
| KazakhKazakhstan | The kazakh Kazakhstan language. |
| KhmerCambodia | The khmer Cambodia language. |
| KicheGuatemala | The kiche Guatemala language. |
| KinyarwandaRwanda | The kinyarwanda Rwanda language. |
| KiswahiliKenya | The kiswahili Kenya language. |
| KonkaniIndia | The konkani India language. |
| KoreanKorea | The korean Korea language. |
| KyrgyzKyrgyzstan | The kyrgyz Kyrgyzstan language. |
| LaoLaoPdr | The lao lao PDR language. |
| LatvianLatvia | The latvian Latvia language. |
| LithuanianLithuania | The lithuanian Lithuania language. |
| LowerSorbianGermany | The lower sorbian Germany language. |
| LuxembourgishLuxembourg | The luxembourgish Luxembourg language. |
| MacedonianFyromFormerYugoslavRepublicOfMacedonia | The macedonian fyrom former Yugoslav Republic of Macedonia language. |
| MalayBruneiDarussalam | The malay brunei Darussalam language. |
| MalayMalaysia | The malay Malaysia language. |
| MalayalamIndia | The malayalam India language. |
| MalteseMalta | The maltese Malta language. |
| MaoriNewZealand | The maori New Zealand language. |
| MapudungunChile | The mapudungun Chile language. |
| MarathiIndia | The marathi India language. |
| MohawkMohawk | The mohawk Mohawk language. |
| MongolianCyrillicMongolia | The mongolian cyrillic Mongolia language. |
| MongolianTraditionalPeoplesRepublicOfChina | The mongolian traditional Peoples Republic of China language. |
| NepaliNepal | The nepali Nepal language. |
| NorwegianBokmalNorway | The norwegian bokmal Norway language. |
| NorwegianNynorskNorway | The norwegian nynorsk Norway language. |
| OccitanFrance | The occitan France language. |
| OdiaFormerlyOriyaIndia | The odia formerly oriya India language. |
| PashtoAfghanistan | The pashto Afghanistan language. |
| PolishPoland | The polish Poland language. |
| PortugueseBrazil | The portuguese Brazil language. |
| PortuguesePortugal | The portuguese Portugal language. |
| PunjabiIndia | The punjabi India language. |
| QuechuaBolivia | The quechua Bolivia language. |
| QuechuaEcuador | The quechua Ecuador language. |
| QuechuaPeru | The quechua Peru language. |
| RomanianRomania | The romanian Romania language. |
| RomanshSwitzerland | The romansh Switzerland language. |
| RussianRussia | The russian Russia language. |
| SamiInariFinland | The sami inari Finland language. |
| SamiLuleNorway | The sami lule Norway language. |
| SamiLuleSweden | The sami lule Sweden language. |
| SamiNorthernFinland | The sami northern Finland language. |
| SamiNorthernNorway | The sami northern Norway language. |
| SamiNorthernSweden | The sami northern Sweden language. |
| SamiSkoltFinland | The sami skolt Finland language. |
| SamiSouthernNorway | The sami southern Norway language. |
| SamiSouthernSweden | The sami southern Sweden language. |
| SanskritIndia | The sanskrit India language. |
| SerbianCyrillicBosniaAndHerzegovina | The serbian cyrillic Bosnia and Herzegovina language. |
| SerbianCyrillicSerbia | The serbian cyrillic Serbia language. |
| SerbianLatinBosniaAndHerzegovina | The serbian latin Bosnia and Herzegovina language. |
| SerbianLatinSerbia | The serbian latin Serbia language. |
| SesothoSaLeboaSouthAfrica | The sesotho sa leboa South Africa language. |
| SetswanaSouthAfrica | The setswana South Africa language. |
| SinhalaSriLanka | The sinhala Sri Lanka language. |
| SlovakSlovakia | The slovak Slovakia language. |
| SlovenianSlovenia | The slovenian Slovenia language. |
| SpanishArgentina | The spanish Argentina language. |
| SpanishBolivia | The spanish Bolivia language. |
| SpanishChile | The spanish Chile language. |
| SpanishColombia | The spanish Colombia language. |
| SpanishCostaRica | The spanish Costa Rica language. |
| SpanishDominicanRepublic | The spanish Dominican Republic language. |
| SpanishEcuador | The spanish Ecuador language. |
| SpanishElSalvador | The spanish El Salvador language. |
| SpanishGuatemala | The spanish Guatemala language. |
| SpanishHonduras | The spanish Honduras language. |
| SpanishMexico | The spanish Mexico language. |
| SpanishNicaragua | The spanish Nicaragua language. |
| SpanishPanama | The spanish Panama language. |
| SpanishParaguay | The spanish Paraguay language. |
| SpanishPeru | The spanish Peru language. |
| SpanishPuertoRico | The spanish Puerto Rico language. |
| SpanishModernSortSpain | The spanish modern sort Spain language. |
| SpanishTraditionalSortSpain | The spanish traditional sort Spain language. |
| SpanishUnitedStates | The spanish United States language. |
| SpanishUruguay | The spanish Uruguay language. |
| SpanishVenezuela | The spanish Venezuela language. |
| SwedenFinland | The sweden Finland language. |
| SwedishSweden | The swedish Sweden language. |
| SyriacSyria | The syriac Syria language. |
| TajikCyrillicTajikistan | The tajik cyrillic tajikistan language. |
| TamazightLatinAlgeria | The tamazight latin Algeria language. |
| TamilIndia | The tamil India language. |
| TatarRussia | The tatar Russia language. |
| TeluguIndia | The telugu India language. |
| ThaiThailand | The thai Thailand language. |
| TibetanPrc | The tibetan PRC language. |
| TurkishTurkey | The turkish Turkey language. |
| TurkmenTurkmenistan | The turkmen Turkmenistan language. |
| UighurPrc | The uighur PRC language. |
| UkrainianUkraine | The ukrainian Ukraine language. |
| UpperSorbianGermany | The upper sorbian Germany language. |
| UrduIslamicRepublicOfPakistan | The urdu Islamic Republic of Pakistan language. |
| UzbekCyrillicUzbekistan | The uzbek cyrillic Uzbekistan language. |
| UzbekLatinUzbekistan | The uzbek latin Uzbekistan language. |
| VietnameseVietnam | The vietnamese Vietnam language. |
| WelshUnitedKingdom | The welsh United Kingdom language. |
| WolofSenegal | The wolof Senegal language. |
| YakutRussia | The yakut Russia language. |
| YiPrc | The yi PRC language. |
| YorubaNigeria | The yoruba Nigeria language. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final OpenTypeWindowsLanguage Unknown
```

The unknown language.

##### AfrikaansSouthAfrica
```
public static final OpenTypeWindowsLanguage AfrikaansSouthAfrica
```

The afrikaans south africa language.

##### AlbanianAlbania
```
public static final OpenTypeWindowsLanguage AlbanianAlbania
```

The albanian Albania language.

##### AlsatianFrance
```
public static final OpenTypeWindowsLanguage AlsatianFrance
```

The alsatian France language.

##### AmharicEthiopia
```
public static final OpenTypeWindowsLanguage AmharicEthiopia
```

The amharic Rthiopia language.

##### ArabicAlgeria
```
public static final OpenTypeWindowsLanguage ArabicAlgeria
```

The arabic Algeria language.

##### ArabicBahrain
```
public static final OpenTypeWindowsLanguage ArabicBahrain
```

The arabic Bahrain language.

##### ArabicEgypt
```
public static final OpenTypeWindowsLanguage ArabicEgypt
```

The arabic Egypt language.

##### ArabicIraq
```
public static final OpenTypeWindowsLanguage ArabicIraq
```

The arabic Iraq language.

##### ArabicJordan
```
public static final OpenTypeWindowsLanguage ArabicJordan
```

The arabic Jordan language.

##### ArabicKuwait
```
public static final OpenTypeWindowsLanguage ArabicKuwait
```

The arabic Kuwait language.

##### ArabicLebanon
```
public static final OpenTypeWindowsLanguage ArabicLebanon
```

The arabic Lebanon language.

##### ArabicLibya
```
public static final OpenTypeWindowsLanguage ArabicLibya
```

The arabic Libya language.

##### ArabicMorocco
```
public static final OpenTypeWindowsLanguage ArabicMorocco
```

The arabic Morocco language.

##### ArabicOman
```
public static final OpenTypeWindowsLanguage ArabicOman
```

The arabic Oman language.

##### ArabicQatar
```
public static final OpenTypeWindowsLanguage ArabicQatar
```

The arabic Qatar language.

##### ArabicSaudiArabia
```
public static final OpenTypeWindowsLanguage ArabicSaudiArabia
```

The arabic Saudi Arabia language.

##### ArabicSyria
```
public static final OpenTypeWindowsLanguage ArabicSyria
```

The arabic Syria language.

##### ArabicTunisia
```
public static final OpenTypeWindowsLanguage ArabicTunisia
```

The arabic Tunisia language.

##### ArabicUae
```
public static final OpenTypeWindowsLanguage ArabicUae
```

The arabic UAE language.

##### ArabicYemen
```
public static final OpenTypeWindowsLanguage ArabicYemen
```

The arabic Yemen language.

##### ArmenianArmenia
```
public static final OpenTypeWindowsLanguage ArmenianArmenia
```

The armenian Armenia language.

##### AssameseIndia
```
public static final OpenTypeWindowsLanguage AssameseIndia
```

The assamese India language.

##### AzeriCyrillicAzerbaijan
```
public static final OpenTypeWindowsLanguage AzeriCyrillicAzerbaijan
```

The azeri cyrillic Azerbaijan language.

##### AzeriLatinAzerbaijan
```
public static final OpenTypeWindowsLanguage AzeriLatinAzerbaijan
```

The azeri latin Azerbaijan language.

##### BashkirRussia
```
public static final OpenTypeWindowsLanguage BashkirRussia
```

The bashkir Russia language.

##### BasqueBasque
```
public static final OpenTypeWindowsLanguage BasqueBasque
```

The basque Basque language.

##### BelarusianBelarus
```
public static final OpenTypeWindowsLanguage BelarusianBelarus
```

The belarusian Belarus language.

##### BengaliBangladesh
```
public static final OpenTypeWindowsLanguage BengaliBangladesh
```

The bengali Bangladesh language.

##### BengaliIndia
```
public static final OpenTypeWindowsLanguage BengaliIndia
```

The bengali India language.

##### BosnianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage BosnianLatinBosniaAndHerzegovina
```

The bosnian latin Bosnia and Herzegovina language.

##### BretonFrance
```
public static final OpenTypeWindowsLanguage BretonFrance
```

The breton France language.

##### BulgarianBulgaria
```
public static final OpenTypeWindowsLanguage BulgarianBulgaria
```

The bulgarian Bulgaria language.

##### CatalanCatalan
```
public static final OpenTypeWindowsLanguage CatalanCatalan
```

The catalan Catalan language.

##### ChineseHongKongSar
```
public static final OpenTypeWindowsLanguage ChineseHongKongSar
```

The chinese Hong Kong SAR language.

##### ChineseMacaoSar
```
public static final OpenTypeWindowsLanguage ChineseMacaoSar
```

The chinese Macao SAR language.

##### ChinesePeoplesRepublicOfChina
```
public static final OpenTypeWindowsLanguage ChinesePeoplesRepublicOfChina
```

The chinese Peoples Republic of China language.

##### ChineseSingapore
```
public static final OpenTypeWindowsLanguage ChineseSingapore
```

The chinese Singapore language.

##### ChineseTaiwan
```
public static final OpenTypeWindowsLanguage ChineseTaiwan
```

The chinese Taiwan language.

##### CorsicanFrance
```
public static final OpenTypeWindowsLanguage CorsicanFrance
```

The corsican France language.

##### CroatianCroatia
```
public static final OpenTypeWindowsLanguage CroatianCroatia
```

The croatian Croatia language.

##### CroatianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage CroatianLatinBosniaAndHerzegovina
```

The croatian latin Bosnia and Herzegovina language.

##### CzechCzechRepublic
```
public static final OpenTypeWindowsLanguage CzechCzechRepublic
```

The czech Czech Republic language.

##### DanishDenmark
```
public static final OpenTypeWindowsLanguage DanishDenmark
```

The danish Denmark language.

##### DariAfghanistan
```
public static final OpenTypeWindowsLanguage DariAfghanistan
```

The dari Afghanistan language.

##### DivehiMaldives
```
public static final OpenTypeWindowsLanguage DivehiMaldives
```

The divehi Maldives language.

##### DutchBelgium
```
public static final OpenTypeWindowsLanguage DutchBelgium
```

The dutch Belgium language.

##### DutchNetherlands
```
public static final OpenTypeWindowsLanguage DutchNetherlands
```

The dutch Netherlands language.

##### EnglishAustralia
```
public static final OpenTypeWindowsLanguage EnglishAustralia
```

The english Australia language.

##### EnglishBelize
```
public static final OpenTypeWindowsLanguage EnglishBelize
```

The english Belize language.

##### EnglishCanada
```
public static final OpenTypeWindowsLanguage EnglishCanada
```

The english Canada language.

##### EnglishCaribbean
```
public static final OpenTypeWindowsLanguage EnglishCaribbean
```

The english Caribbean language.

##### EnglishIndia
```
public static final OpenTypeWindowsLanguage EnglishIndia
```

The english India language.

##### EnglishIreland
```
public static final OpenTypeWindowsLanguage EnglishIreland
```

The english Ireland language.

##### EnglishJamaica
```
public static final OpenTypeWindowsLanguage EnglishJamaica
```

The english Jamaica language.

##### EnglishMalaysia
```
public static final OpenTypeWindowsLanguage EnglishMalaysia
```

The english Malaysia language.

##### EnglishNewZealand
```
public static final OpenTypeWindowsLanguage EnglishNewZealand
```

The english New Zealand language.

##### EnglishRepublicOfThePhilippines
```
public static final OpenTypeWindowsLanguage EnglishRepublicOfThePhilippines
```

The english Republic of the Philippines language.

##### EnglishSingapore
```
public static final OpenTypeWindowsLanguage EnglishSingapore
```

The english Singapore language.

##### EnglishSouthAfrica
```
public static final OpenTypeWindowsLanguage EnglishSouthAfrica
```

The english south africa language.

##### EnglishTrinidadAndTobago
```
public static final OpenTypeWindowsLanguage EnglishTrinidadAndTobago
```

The english Trinidad and Tobago language.

##### EnglishUnitedKingdom
```
public static final OpenTypeWindowsLanguage EnglishUnitedKingdom
```

The english United Kingdom language.

##### EnglishUnitedStates
```
public static final OpenTypeWindowsLanguage EnglishUnitedStates
```

The english United States language.

##### EnglishZimbabwe
```
public static final OpenTypeWindowsLanguage EnglishZimbabwe
```

The english Zimbabwe language.

##### EstonianEstonia
```
public static final OpenTypeWindowsLanguage EstonianEstonia
```

The estonian Estonia language.

##### FaroeseFaroeIslands
```
public static final OpenTypeWindowsLanguage FaroeseFaroeIslands
```

The faroese Faroe Islands language.

##### FilipinoPhilippines
```
public static final OpenTypeWindowsLanguage FilipinoPhilippines
```

The filipino Philippines language.

##### FinnishFinland
```
public static final OpenTypeWindowsLanguage FinnishFinland
```

The finnish Finland language.

##### FrenchBelgium
```
public static final OpenTypeWindowsLanguage FrenchBelgium
```

The french Belgium language.

##### FrenchCanada
```
public static final OpenTypeWindowsLanguage FrenchCanada
```

The french Canada language.

##### FrenchFrance
```
public static final OpenTypeWindowsLanguage FrenchFrance
```

The french France language.

##### FrenchLuxembourg
```
public static final OpenTypeWindowsLanguage FrenchLuxembourg
```

The french Luxembourg language.

##### FrenchPrincipalityOfMonaco
```
public static final OpenTypeWindowsLanguage FrenchPrincipalityOfMonaco
```

The french Principality of Monaco language.

##### FrenchSwitzerland
```
public static final OpenTypeWindowsLanguage FrenchSwitzerland
```

The french Switzerland language.

##### FrisianNetherlands
```
public static final OpenTypeWindowsLanguage FrisianNetherlands
```

The frisian Netherlands language.

##### GalicianGalician
```
public static final OpenTypeWindowsLanguage GalicianGalician
```

The galician Galician language.

##### GeorgianGeorgia
```
public static final OpenTypeWindowsLanguage GeorgianGeorgia
```

The georgian Georgia language.

##### GermanAustria
```
public static final OpenTypeWindowsLanguage GermanAustria
```

The german Austria language.

##### GermanGermany
```
public static final OpenTypeWindowsLanguage GermanGermany
```

The german Germany language.

##### GermanLiechtenstein
```
public static final OpenTypeWindowsLanguage GermanLiechtenstein
```

The german Liechtenstein language.

##### GermanLuxembourg
```
public static final OpenTypeWindowsLanguage GermanLuxembourg
```

The german Luxembourg language.

##### GermanSwitzerland
```
public static final OpenTypeWindowsLanguage GermanSwitzerland
```

The german Switzerland language.

##### GreekGreece
```
public static final OpenTypeWindowsLanguage GreekGreece
```

The greek Greece language.

##### GreenlandicGreenland
```
public static final OpenTypeWindowsLanguage GreenlandicGreenland
```

The greenlandic Greenland language.

##### GujaratiIndia
```
public static final OpenTypeWindowsLanguage GujaratiIndia
```

The gujarati India language.

##### HausaLatinNigeria
```
public static final OpenTypeWindowsLanguage HausaLatinNigeria
```

The hausa latin Nigeria language.

##### HebrewIsrael
```
public static final OpenTypeWindowsLanguage HebrewIsrael
```

The hebrew Israel language.

##### HindiIndia
```
public static final OpenTypeWindowsLanguage HindiIndia
```

The hindi India language.

##### HungarianHungary
```
public static final OpenTypeWindowsLanguage HungarianHungary
```

The hungarian Hungary language.

##### IcelandicIceland
```
public static final OpenTypeWindowsLanguage IcelandicIceland
```

The icelandic Iceland language.

##### IgboNigeria
```
public static final OpenTypeWindowsLanguage IgboNigeria
```

The igbo Nigeria language.

##### IndonesianIndonesia
```
public static final OpenTypeWindowsLanguage IndonesianIndonesia
```

The indonesian Indonesia language.

##### InuktitutCanada
```
public static final OpenTypeWindowsLanguage InuktitutCanada
```

The inuktitut Canada language.

##### InuktitutLatinCanada
```
public static final OpenTypeWindowsLanguage InuktitutLatinCanada
```

The inuktitut latin Canada language.

##### IrishIreland
```
public static final OpenTypeWindowsLanguage IrishIreland
```

The irish Ireland language.

##### IsiXhosaSouthAfrica
```
public static final OpenTypeWindowsLanguage IsiXhosaSouthAfrica
```

The isi xhosa South Africa language.

##### IsiZuluSouthAfrica
```
public static final OpenTypeWindowsLanguage IsiZuluSouthAfrica
```

The isi zulu South Africa language.

##### ItalianItaly
```
public static final OpenTypeWindowsLanguage ItalianItaly
```

The italian Italy language.

##### ItalianSwitzerland
```
public static final OpenTypeWindowsLanguage ItalianSwitzerland
```

The italian Switzerland language.

##### JapaneseJapan
```
public static final OpenTypeWindowsLanguage JapaneseJapan
```

The japanese Japan language.

##### KannadaIndia
```
public static final OpenTypeWindowsLanguage KannadaIndia
```

The kannada India language.

##### KazakhKazakhstan
```
public static final OpenTypeWindowsLanguage KazakhKazakhstan
```

The kazakh Kazakhstan language.

##### KhmerCambodia
```
public static final OpenTypeWindowsLanguage KhmerCambodia
```

The khmer Cambodia language.

##### KicheGuatemala
```
public static final OpenTypeWindowsLanguage KicheGuatemala
```

The kiche Guatemala language.

##### KinyarwandaRwanda
```
public static final OpenTypeWindowsLanguage KinyarwandaRwanda
```

The kinyarwanda Rwanda language.

##### KiswahiliKenya
```
public static final OpenTypeWindowsLanguage KiswahiliKenya
```

The kiswahili Kenya language.

##### KonkaniIndia
```
public static final OpenTypeWindowsLanguage KonkaniIndia
```

The konkani India language.

##### KoreanKorea
```
public static final OpenTypeWindowsLanguage KoreanKorea
```

The korean Korea language.

##### KyrgyzKyrgyzstan
```
public static final OpenTypeWindowsLanguage KyrgyzKyrgyzstan
```

The kyrgyz Kyrgyzstan language.

##### LaoLaoPdr
```
public static final OpenTypeWindowsLanguage LaoLaoPdr
```

The lao lao PDR language.

##### LatvianLatvia
```
public static final OpenTypeWindowsLanguage LatvianLatvia
```

The latvian Latvia language.

##### LithuanianLithuania
```
public static final OpenTypeWindowsLanguage LithuanianLithuania
```

The lithuanian Lithuania language.

##### LowerSorbianGermany
```
public static final OpenTypeWindowsLanguage LowerSorbianGermany
```

The lower sorbian Germany language.

##### LuxembourgishLuxembourg
```
public static final OpenTypeWindowsLanguage LuxembourgishLuxembourg
```

The luxembourgish Luxembourg language.

##### MacedonianFyromFormerYugoslavRepublicOfMacedonia
```
public static final OpenTypeWindowsLanguage MacedonianFyromFormerYugoslavRepublicOfMacedonia
```

The macedonian fyrom former Yugoslav Republic of Macedonia language.

##### MalayBruneiDarussalam
```
public static final OpenTypeWindowsLanguage MalayBruneiDarussalam
```

The malay brunei Darussalam language.

##### MalayMalaysia
```
public static final OpenTypeWindowsLanguage MalayMalaysia
```

The malay Malaysia language.

##### MalayalamIndia
```
public static final OpenTypeWindowsLanguage MalayalamIndia
```

The malayalam India language.

##### MalteseMalta
```
public static final OpenTypeWindowsLanguage MalteseMalta
```

The maltese Malta language.

##### MaoriNewZealand
```
public static final OpenTypeWindowsLanguage MaoriNewZealand
```

The maori New Zealand language.

##### MapudungunChile
```
public static final OpenTypeWindowsLanguage MapudungunChile
```

The mapudungun Chile language.

##### MarathiIndia
```
public static final OpenTypeWindowsLanguage MarathiIndia
```

The marathi India language.

##### MohawkMohawk
```
public static final OpenTypeWindowsLanguage MohawkMohawk
```

The mohawk Mohawk language.

##### MongolianCyrillicMongolia
```
public static final OpenTypeWindowsLanguage MongolianCyrillicMongolia
```

The mongolian cyrillic Mongolia language.

##### MongolianTraditionalPeoplesRepublicOfChina
```
public static final OpenTypeWindowsLanguage MongolianTraditionalPeoplesRepublicOfChina
```

The mongolian traditional Peoples Republic of China language.

##### NepaliNepal
```
public static final OpenTypeWindowsLanguage NepaliNepal
```

The nepali Nepal language.

##### NorwegianBokmalNorway
```
public static final OpenTypeWindowsLanguage NorwegianBokmalNorway
```

The norwegian bokmal Norway language.

##### NorwegianNynorskNorway
```
public static final OpenTypeWindowsLanguage NorwegianNynorskNorway
```

The norwegian nynorsk Norway language.

##### OccitanFrance
```
public static final OpenTypeWindowsLanguage OccitanFrance
```

The occitan France language.

##### OdiaFormerlyOriyaIndia
```
public static final OpenTypeWindowsLanguage OdiaFormerlyOriyaIndia
```

The odia formerly oriya India language.

##### PashtoAfghanistan
```
public static final OpenTypeWindowsLanguage PashtoAfghanistan
```

The pashto Afghanistan language.

##### PolishPoland
```
public static final OpenTypeWindowsLanguage PolishPoland
```

The polish Poland language.

##### PortugueseBrazil
```
public static final OpenTypeWindowsLanguage PortugueseBrazil
```

The portuguese Brazil language.

##### PortuguesePortugal
```
public static final OpenTypeWindowsLanguage PortuguesePortugal
```

The portuguese Portugal language.

##### PunjabiIndia
```
public static final OpenTypeWindowsLanguage PunjabiIndia
```

The punjabi India language.

##### QuechuaBolivia
```
public static final OpenTypeWindowsLanguage QuechuaBolivia
```

The quechua Bolivia language.

##### QuechuaEcuador
```
public static final OpenTypeWindowsLanguage QuechuaEcuador
```

The quechua Ecuador language.

##### QuechuaPeru
```
public static final OpenTypeWindowsLanguage QuechuaPeru
```

The quechua Peru language.

##### RomanianRomania
```
public static final OpenTypeWindowsLanguage RomanianRomania
```

The romanian Romania language.

##### RomanshSwitzerland
```
public static final OpenTypeWindowsLanguage RomanshSwitzerland
```

The romansh Switzerland language.

##### RussianRussia
```
public static final OpenTypeWindowsLanguage RussianRussia
```

The russian Russia language.

##### SamiInariFinland
```
public static final OpenTypeWindowsLanguage SamiInariFinland
```

The sami inari Finland language.

##### SamiLuleNorway
```
public static final OpenTypeWindowsLanguage SamiLuleNorway
```

The sami lule Norway language.

##### SamiLuleSweden
```
public static final OpenTypeWindowsLanguage SamiLuleSweden
```

The sami lule Sweden language.

##### SamiNorthernFinland
```
public static final OpenTypeWindowsLanguage SamiNorthernFinland
```

The sami northern Finland language.

##### SamiNorthernNorway
```
public static final OpenTypeWindowsLanguage SamiNorthernNorway
```

The sami northern Norway language.

##### SamiNorthernSweden
```
public static final OpenTypeWindowsLanguage SamiNorthernSweden
```

The sami northern Sweden language.

##### SamiSkoltFinland
```
public static final OpenTypeWindowsLanguage SamiSkoltFinland
```

The sami skolt Finland language.

##### SamiSouthernNorway
```
public static final OpenTypeWindowsLanguage SamiSouthernNorway
```

The sami southern Norway language.

##### SamiSouthernSweden
```
public static final OpenTypeWindowsLanguage SamiSouthernSweden
```

The sami southern Sweden language.

##### SanskritIndia
```
public static final OpenTypeWindowsLanguage SanskritIndia
```

The sanskrit India language.

##### SerbianCyrillicBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage SerbianCyrillicBosniaAndHerzegovina
```

The serbian cyrillic Bosnia and Herzegovina language.

##### SerbianCyrillicSerbia
```
public static final OpenTypeWindowsLanguage SerbianCyrillicSerbia
```

The serbian cyrillic Serbia language.

##### SerbianLatinBosniaAndHerzegovina
```
public static final OpenTypeWindowsLanguage SerbianLatinBosniaAndHerzegovina
```

The serbian latin Bosnia and Herzegovina language.

##### SerbianLatinSerbia
```
public static final OpenTypeWindowsLanguage SerbianLatinSerbia
```

The serbian latin Serbia language.

##### SesothoSaLeboaSouthAfrica
```
public static final OpenTypeWindowsLanguage SesothoSaLeboaSouthAfrica
```

The sesotho sa leboa South Africa language.

##### SetswanaSouthAfrica
```
public static final OpenTypeWindowsLanguage SetswanaSouthAfrica
```

The setswana South Africa language.

##### SinhalaSriLanka
```
public static final OpenTypeWindowsLanguage SinhalaSriLanka
```

The sinhala Sri Lanka language.

##### SlovakSlovakia
```
public static final OpenTypeWindowsLanguage SlovakSlovakia
```

The slovak Slovakia language.

##### SlovenianSlovenia
```
public static final OpenTypeWindowsLanguage SlovenianSlovenia
```

The slovenian Slovenia language.

##### SpanishArgentina
```
public static final OpenTypeWindowsLanguage SpanishArgentina
```

The spanish Argentina language.

##### SpanishBolivia
```
public static final OpenTypeWindowsLanguage SpanishBolivia
```

The spanish Bolivia language.

##### SpanishChile
```
public static final OpenTypeWindowsLanguage SpanishChile
```

The spanish Chile language.

##### SpanishColombia
```
public static final OpenTypeWindowsLanguage SpanishColombia
```

The spanish Colombia language.

##### SpanishCostaRica
```
public static final OpenTypeWindowsLanguage SpanishCostaRica
```

The spanish Costa Rica language.

##### SpanishDominicanRepublic
```
public static final OpenTypeWindowsLanguage SpanishDominicanRepublic
```

The spanish Dominican Republic language.

##### SpanishEcuador
```
public static final OpenTypeWindowsLanguage SpanishEcuador
```

The spanish Ecuador language.

##### SpanishElSalvador
```
public static final OpenTypeWindowsLanguage SpanishElSalvador
```

The spanish El Salvador language.

##### SpanishGuatemala
```
public static final OpenTypeWindowsLanguage SpanishGuatemala
```

The spanish Guatemala language.

##### SpanishHonduras
```
public static final OpenTypeWindowsLanguage SpanishHonduras
```

The spanish Honduras language.

##### SpanishMexico
```
public static final OpenTypeWindowsLanguage SpanishMexico
```

The spanish Mexico language.

##### SpanishNicaragua
```
public static final OpenTypeWindowsLanguage SpanishNicaragua
```

The spanish Nicaragua language.

##### SpanishPanama
```
public static final OpenTypeWindowsLanguage SpanishPanama
```

The spanish Panama language.

##### SpanishParaguay
```
public static final OpenTypeWindowsLanguage SpanishParaguay
```

The spanish Paraguay language.

##### SpanishPeru
```
public static final OpenTypeWindowsLanguage SpanishPeru
```

The spanish Peru language.

##### SpanishPuertoRico
```
public static final OpenTypeWindowsLanguage SpanishPuertoRico
```

The spanish Puerto Rico language.

##### SpanishModernSortSpain
```
public static final OpenTypeWindowsLanguage SpanishModernSortSpain
```

The spanish modern sort Spain language.

##### SpanishTraditionalSortSpain
```
public static final OpenTypeWindowsLanguage SpanishTraditionalSortSpain
```

The spanish traditional sort Spain language.

##### SpanishUnitedStates
```
public static final OpenTypeWindowsLanguage SpanishUnitedStates
```

The spanish United States language.

##### SpanishUruguay
```
public static final OpenTypeWindowsLanguage SpanishUruguay
```

The spanish Uruguay language.

##### SpanishVenezuela
```
public static final OpenTypeWindowsLanguage SpanishVenezuela
```

The spanish Venezuela language.

##### SwedenFinland
```
public static final OpenTypeWindowsLanguage SwedenFinland
```

The sweden Finland language.

##### SwedishSweden
```
public static final OpenTypeWindowsLanguage SwedishSweden
```

The swedish Sweden language.

##### SyriacSyria
```
public static final OpenTypeWindowsLanguage SyriacSyria
```

The syriac Syria language.

##### TajikCyrillicTajikistan
```
public static final OpenTypeWindowsLanguage TajikCyrillicTajikistan
```

The tajik cyrillic tajikistan language.

##### TamazightLatinAlgeria
```
public static final OpenTypeWindowsLanguage TamazightLatinAlgeria
```

The tamazight latin Algeria language.

##### TamilIndia
```
public static final OpenTypeWindowsLanguage TamilIndia
```

The tamil India language.

##### TatarRussia
```
public static final OpenTypeWindowsLanguage TatarRussia
```

The tatar Russia language.

##### TeluguIndia
```
public static final OpenTypeWindowsLanguage TeluguIndia
```

The telugu India language.

##### ThaiThailand
```
public static final OpenTypeWindowsLanguage ThaiThailand
```

The thai Thailand language.

##### TibetanPrc
```
public static final OpenTypeWindowsLanguage TibetanPrc
```

The tibetan PRC language.

##### TurkishTurkey
```
public static final OpenTypeWindowsLanguage TurkishTurkey
```

The turkish Turkey language.

##### TurkmenTurkmenistan
```
public static final OpenTypeWindowsLanguage TurkmenTurkmenistan
```

The turkmen Turkmenistan language.

##### UighurPrc
```
public static final OpenTypeWindowsLanguage UighurPrc
```

The uighur PRC language.

##### UkrainianUkraine
```
public static final OpenTypeWindowsLanguage UkrainianUkraine
```

The ukrainian Ukraine language.

##### UpperSorbianGermany
```
public static final OpenTypeWindowsLanguage UpperSorbianGermany
```

The upper sorbian Germany language.

##### UrduIslamicRepublicOfPakistan
```
public static final OpenTypeWindowsLanguage UrduIslamicRepublicOfPakistan
```

The urdu Islamic Republic of Pakistan language.

##### UzbekCyrillicUzbekistan
```
public static final OpenTypeWindowsLanguage UzbekCyrillicUzbekistan
```

The uzbek cyrillic Uzbekistan language.

##### UzbekLatinUzbekistan
```
public static final OpenTypeWindowsLanguage UzbekLatinUzbekistan
```

The uzbek latin Uzbekistan language.

##### VietnameseVietnam
```
public static final OpenTypeWindowsLanguage VietnameseVietnam
```

The vietnamese Vietnam language.

##### WelshUnitedKingdom
```
public static final OpenTypeWindowsLanguage WelshUnitedKingdom
```

The welsh United Kingdom language.

##### WolofSenegal
```
public static final OpenTypeWindowsLanguage WolofSenegal
```

The wolof Senegal language.

##### YakutRussia
```
public static final OpenTypeWindowsLanguage YakutRussia
```

The yakut Russia language.

##### YiPrc
```
public static final OpenTypeWindowsLanguage YiPrc
```

The yi PRC language.

##### YorubaNigeria
```
public static final OpenTypeWindowsLanguage YorubaNigeria
```

The yoruba Nigeria language.

##### values()
```
public static OpenTypeWindowsLanguage[] values()
```

**Returns:**
com.groupdocs.metadata.core.OpenTypeWindowsLanguage[]
##### valueOf(String name)
```
public static OpenTypeWindowsLanguage valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OpenTypeWindowsLanguage
##### getByRawValue(int rawValue)
```
public static OpenTypeWindowsLanguage getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
OpenTypeWindowsLanguage
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### OpenTypeWindowsNameRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/opentypewindowsnamerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.OpenTypeBaseNameRecord
```
public class OpenTypeWindowsNameRecord extends OpenTypeBaseNameRecord
```

Represents the Name record table value for  OpenTypePlatform.Windows  platform.

[Working with OpenType fonts]: https://docs.groupdocs.com/display/metadatajava/Working+with+OpenType+fonts
#### Methods

| Method | Description |
| --- | --- |
| getEncoding() | Gets the encoding identifier. |
| getLanguage() | Gets the language identifier. |
##### getEncoding()
```
public final OpenTypeWindowsEncoding getEncoding()
```

Gets the encoding identifier.

**Returns:**
OpenTypeWindowsEncoding - The encoding identifier.
##### getLanguage()
```
public final OpenTypeWindowsLanguage getLanguage()
```

Gets the language identifier.

**Returns:**
OpenTypeWindowsLanguage - The language identifier.

### PageInfo
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Provides common information about a document page (slide, worksheet, etc).

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of the page in document default units. |
| getHeight() | Gets the height of the page in document default units. |
| getPageNumber() | Gets the number of the page. |
##### getWidth()
```
public final int getWidth()
```

Gets the width of the page in document default units.

**Returns:**
int - The width of the page in document default units.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the page in document default units.

**Returns:**
int - The height of the page in document default units.
##### getPageNumber()
```
public final int getPageNumber()
```

Gets the number of the page.

**Returns:**
int - The number of the page.

### PanasonicMakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/panasonicmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public class PanasonicMakerNotePackage extends MakerNotePackage
```

Represents PANASONIC MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getImageQuality() | Gets the image quality. |
| getFirmwareVersion() | Gets the firmware version. |
| getWhiteBalance() | Gets the white balance. |
| getFocusMode() | Gets the focus mode. |
| getAFMode() | Gets the AF mode. |
| getImageStabilization() | Gets the image stabilization mode. |
| getMacroMode() | Gets the macro mode. |
| getShootingMode() | Gets the shooting mode. |
| getAudio() | Gets the audio mode. |
| getLensType() | Gets the type of the lens. |
| getLensSerialNumber() | Gets the lens serial number. |
| getAccessoryType() | Gets the type of the accessory. |
| getAccessorySerialNumber() | Gets the accessory serial number. |
##### getImageQuality()
```
public final Integer getImageQuality()
```

Gets the image quality.

**Returns:**
java.lang.Integer - The image quality.
##### getFirmwareVersion()
```
public final byte[] getFirmwareVersion()
```

Gets the firmware version.

**Returns:**
byte[] - The firmware version.
##### getWhiteBalance()
```
public final Integer getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.Integer - The white balance.
##### getFocusMode()
```
public final Integer getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.Integer - The focus mode.
##### getAFMode()
```
public final byte[] getAFMode()
```

Gets the AF mode.

**Returns:**
byte[] - The AF mode.
##### getImageStabilization()
```
public final Integer getImageStabilization()
```

Gets the image stabilization mode.

**Returns:**
java.lang.Integer - The image stabilization mode.
##### getMacroMode()
```
public final Integer getMacroMode()
```

Gets the macro mode.

**Returns:**
java.lang.Integer - The macro mode.
##### getShootingMode()
```
public final Integer getShootingMode()
```

Gets the shooting mode.

**Returns:**
java.lang.Integer - The shooting mode.
##### getAudio()
```
public final Integer getAudio()
```

Gets the audio mode.

**Returns:**
java.lang.Integer - The audio mode.
##### getLensType()
```
public final String getLensType()
```

Gets the type of the lens.

**Returns:**
java.lang.String - The type of the lens.
##### getLensSerialNumber()
```
public final String getLensSerialNumber()
```

Gets the lens serial number.

**Returns:**
java.lang.String - The lens serial number.
##### getAccessoryType()
```
public final String getAccessoryType()
```

Gets the type of the accessory.

**Returns:**
java.lang.String - The type of the accessory.
##### getAccessorySerialNumber()
```
public final String getAccessorySerialNumber()
```

Gets the accessory serial number.

**Returns:**
java.lang.String - The accessory serial number.

### PdfAnnotation
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfAnnotation extends CustomPackage
```

Represents an annotation in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the annotation text. |
| getName() | Gets the name of the annotation. |
| getPageNumber() | Gets the number of the page containing the annotation. |
##### getText()
```
public final String getText()
```

Gets the annotation text.

**Returns:**
java.lang.String - The annotation text.
##### getName()
```
public final String getName()
```

Gets the name of the annotation.

**Returns:**
java.lang.String - The name of the annotation.
##### getPageNumber()
```
public final int getPageNumber()
```

Gets the number of the page containing the annotation.

**Returns:**
int - The number of the page containing the annotation.

### PdfAttachment
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfattachment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfAttachment extends CustomPackage
```

Represents an attachment in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the attachment name. |
| getDescription() | Gets the attachment description. |
| getMimeType() | Gets the MIME type of the attachment. |
##### getName()
```
public final String getName()
```

Gets the attachment name.

**Returns:**
java.lang.String - The attachment name.
##### getDescription()
```
public final String getDescription()
```

Gets the attachment description.

**Returns:**
java.lang.String - The attachment description.
##### getMimeType()
```
public final String getMimeType()
```

Gets the MIME type of the attachment.

**Returns:**
java.lang.String - The MIME type of the attachment.

### PdfBookmark
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfbookmark.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfBookmark extends CustomPackage
```

Represents a bookmark in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets the title of the bookmark. |
##### getTitle()
```
public final String getTitle()
```

Gets the title of the bookmark.

**Returns:**
java.lang.String - The title of the bookmark.

### PdfFormField
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfformfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PdfFormField extends CustomPackage
```

Represents a form field in a PDF document.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the field. |
| getValue() | Gets the field value. |
##### getName()
```
public final String getName()
```

Gets the name of the field.

**Returns:**
java.lang.String - The name of the field.
##### getValue()
```
public final String getValue()
```

Gets the field value.

**Returns:**
java.lang.String - The field value.

### PdfInspectionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PdfInspectionPackage extends CustomPackage
```

Contains information about PDF document parts that can be considered as metadata in some cases.

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getAnnotations() | Gets an array of the annotations. |
| getAttachments() | Gets an array of the attachments. |
| getBookmarks() | Gets an array of the bookmarks. |
| getFields() | Gets an array of the form fields. |
| getDigitalSignatures() | Gets an array of the digital signatures. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| sanitize() | Removes writable metadata properties from the package. |
| clearAnnotations() | Removes all detected annotations from the document. |
| clearAttachments() | Removes all detected attachments from the document. |
| clearBookmarks() | Removes all detected bookmarks from the document. |
| clearFields() | Removes all detected form fields from the document. |
| clearDigitalSignatures() | Removes all detected digital signatures from the document. |
##### getAnnotations()
```
public final PdfAnnotation[] getAnnotations()
```

Gets an array of the annotations.

**Returns:**
com.groupdocs.metadata.core.PdfAnnotation[] - An array of the annotations.
##### getAttachments()
```
public final PdfAttachment[] getAttachments()
```

Gets an array of the attachments.

**Returns:**
com.groupdocs.metadata.core.PdfAttachment[] - An array of the attachments.
##### getBookmarks()
```
public final PdfBookmark[] getBookmarks()
```

Gets an array of the bookmarks.

**Returns:**
com.groupdocs.metadata.core.PdfBookmark[] - An array of the bookmarks.
##### getFields()
```
public final PdfFormField[] getFields()
```

Gets an array of the form fields.

**Returns:**
com.groupdocs.metadata.core.PdfFormField[] - An array of the form fields.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of the digital signatures.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - An array of the digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.
##### clearAnnotations()
```
public final void clearAnnotations()
```

Removes all detected annotations from the document.

##### clearAttachments()
```
public final void clearAttachments()
```

Removes all detected attachments from the document.

##### clearBookmarks()
```
public final void clearBookmarks()
```

Removes all detected bookmarks from the document.

##### clearFields()
```
public final void clearFields()
```

Removes all detected form fields from the document.

##### clearDigitalSignatures()
```
public final void clearDigitalSignatures()
```

Removes all detected digital signatures from the document.

### PdfPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class PdfPackage extends DocumentPackage
```

Represents native metadata in a PDF document.

This code snippet demonstrates how to update built-in metadata properties in a PDF document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      PdfRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedDate(new Date());
>      root.getDocumentProperties().setTitle("test title");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the document author. |
| setAuthor(String value) | Sets the document author. |
| getCreatedDate() | Gets the date of document creation. |
| setCreatedDate(Date value) | Sets the date of document creation. |
| getCreator() | Gets the creator of the document. |
| setCreator(String value) | Gets the creator of the document. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getModifiedDate() | Gets the date of the last modification. |
| setModifiedDate(Date value) | Sets the date of the last modification. |
| getProducer() | Gets the document producer. |
| setProducer(String value) | Gets the document producer. |
| getSubject() | Gets the subject of the document. |
| setSubject(String value) | Sets the subject of the document. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getTrappedFlag() | Gets the trapped flag. |
| setTrappedFlag(Boolean value) | Sets the trapped flag. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the document author.

**Returns:**
java.lang.String - The document author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document author. |

##### getCreatedDate()
```
public final Date getCreatedDate()
```

Gets the date of document creation.

**Returns:**
java.util.Date - The date of document creation.
##### setCreatedDate(Date value)
```
public final void setCreatedDate(Date value)
```

Sets the date of document creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of document creation. |

##### getCreator()
```
public final String getCreator()
```

Gets the creator of the document.

**Returns:**
java.lang.String - The creator of the document.
##### setCreator(String value)
```
public final void setCreator(String value)
```

Gets the creator of the document.

Value: The creator of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getModifiedDate()
```
public final Date getModifiedDate()
```

Gets the date of the last modification.

**Returns:**
java.util.Date - The date of the last modification.
##### setModifiedDate(Date value)
```
public final void setModifiedDate(Date value)
```

Sets the date of the last modification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date of the last modification. |

##### getProducer()
```
public final String getProducer()
```

Gets the document producer.

**Returns:**
java.lang.String - The document producer.
##### setProducer(String value)
```
public final void setProducer(String value)
```

Gets the document producer.

Value: The document producer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Gets the subject of the document.

**Returns:**
java.lang.String - The subject of the document.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject of the document. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title of the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the document. |

##### getTrappedFlag()
```
public final Boolean getTrappedFlag()
```

Gets the trapped flag.

**Returns:**
java.lang.Boolean -  true  if the trapped flag is set; otherwise,  false .
##### setTrappedFlag(Boolean value)
```
public final void setTrappedFlag(Boolean value)
```

Sets the trapped flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the trapped flag is set; otherwise,  false . |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

### PdfRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class PdfRootPackage extends DocumentRootPackage<PdfPackage> implements IXmp
```

Represents the root package allowing working with metadata in a PDF document.

This code sample shows how to extract built-in metadata properties from a PDF document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      PdfRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedDate());
>      System.out.println(root.getDocumentProperties().getSubject());
>      System.out.println(root.getDocumentProperties().getProducer());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in PDF documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PDF+documents
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getPdfType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
##### getPdfType()
```
public final PdfTypePackage getPdfType()
```

Gets the file type metadata package.

**Returns:**
PdfTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final PdfInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
PdfInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

### PdfTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pdftypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class PdfTypePackage extends FileTypePackage
```

Represents a metadata package containing PDF-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getVersion() | Gets the version of the format. |
##### getVersion()
```
public final String getVersion()
```

Gets the version of the format.

**Returns:**
java.lang.String - The version of the format.

### PngCompressedTextChunk
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pngcompressedtextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.PngTextChunk
```
public class PngCompressedTextChunk extends PngTextChunk
```

Represents compressed textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| getCompressionMethod() | Gets the algorithm used to compress the chunk data. |
##### getCompressionMethod()
```
public final PngCompressionMethod getCompressionMethod()
```

Gets the algorithm used to compress the chunk data.

**Returns:**
PngCompressionMethod - The algorithm used to compress the chunk data.

### PngCompressionMethod
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pngcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PngCompressionMethod extends Enum<PngCompressionMethod> implements IEnumValue
```

Defines compression methods used in the PNG format.
#### Fields

| Field | Description |
| --- | --- |
| Deflate | Represents the deflate/inflate compression with a sliding window. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Deflate
```
public static final PngCompressionMethod Deflate
```

Represents the deflate/inflate compression with a sliding window.

##### values()
```
public static PngCompressionMethod[] values()
```

**Returns:**
com.groupdocs.metadata.core.PngCompressionMethod[]
##### valueOf(String name)
```
public static PngCompressionMethod valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PngCompressionMethod
##### getByRawValue(int rawValue)
```
public static PngCompressionMethod getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PngCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PngInternationalTextChunk
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pnginternationaltextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.PngTextChunk, com.groupdocs.metadata.core.PngCompressedTextChunk
```
public class PngInternationalTextChunk extends PngCompressedTextChunk
```

Represents international textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| isCompressed() | Gets a value indicating whether the chunk is compressed. |
| getLanguage() | Gets the human language used by the translated keyword and the text. |
| getTranslatedKeyword() | Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property. |
##### isCompressed()
```
public final boolean isCompressed()
```

Gets a value indicating whether the chunk is compressed.

**Returns:**
boolean - True, if the chunk is compressed; otherwise, false.
##### getLanguage()
```
public final String getLanguage()
```

Gets the human language used by the translated keyword and the text.

**Returns:**
java.lang.String - The human language used by the translated keyword and the text.
##### getTranslatedKeyword()
```
public final String getTranslatedKeyword()
```

Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property.

**Returns:**
java.lang.String - The translated keyword that contains a translation of the keyword into the language indicated by the language property.

### PngPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pngpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PngPackage extends CustomPackage
```

Represents native PNG metadata.
#### Methods

| Method | Description |
| --- | --- |
| getTextChunks() | Gets the collection of text chunks extracted from the image. |
##### getTextChunks()
```
public final PngTextChunk[] getTextChunks()
```

Gets the collection of text chunks extracted from the image.

**Returns:**
com.groupdocs.metadata.core.PngTextChunk[] - The collection of text chunks extracted from the image.

### PngRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pngrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class PngRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package intended to work with metadata in a PNG image.

[Working with metadata in PNG images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PNG+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getPngPackage() | Gets the PNG native metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getPngPackage()
```
public final PngPackage getPngPackage()
```

Gets the PNG native metadata package.

**Returns:**
PngPackage - The PNG native metadata package.

### PngTextChunk
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/pngtextchunk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class PngTextChunk extends CustomPackage
```

Represents textual data extracted from a PNG image.
#### Methods

| Method | Description |
| --- | --- |
| getKeyword() | Gets the keyword that indicates the type of information represented by the chunk. |
| getText() | Gets the actual text string represented by the chunk. |
##### getKeyword()
```
public final String getKeyword()
```

Gets the keyword that indicates the type of information represented by the chunk.

**Returns:**
java.lang.String - The keyword that indicates the type of information represented by the chunk.
##### getText()
```
public final String getText()
```

Gets the actual text string represented by the chunk.

**Returns:**
java.lang.String - The actual text string represented by the chunk.

### PresentationComment
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationComment extends CustomPackage
```

Represents a user comment in a presentation.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the comment. |
| getCreatedTime() | Gets the created time of the comment. |
| getSlideNumber() | Gets the slide number the comment belongs to. |
| getText() | Gets the text of the comment. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the comment.

**Returns:**
java.lang.String - The author of the comment.
##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the created time of the comment.

**Returns:**
java.util.Date - The created time of the comment.
##### getSlideNumber()
```
public final int getSlideNumber()
```

Gets the slide number the comment belongs to.

**Returns:**
int - The slide number the comment belongs to.
##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The comment text.

### PresentationFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PresentationFormat extends Enum<PresentationFormat> implements IEnumValue
```

Defines various presentation subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Ppt | Represents the .PPT PowerPoint format. |
| Pptx | Represents the .PPTX PowerPoint format. |
| Potm | Represents the .POTM PowerPoint format. |
| Potx | Represents the .POTX PowerPoint format. |
| Pptm | Represents the .PPTM PowerPoint format. |
| Pps | Represents the .PPS PowerPoint format. |
| Ppsx | Represents the .PPSX PowerPoint format. |
| Ppsm | Represents the .PPSM PowerPoint format. |
| Pot | Represents the .POT PowerPoint format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final PresentationFormat Unknown
```

The format is not recognized.

##### Ppt
```
public static final PresentationFormat Ppt
```

Represents the .PPT PowerPoint format. 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. A PPT file can contain several different types of information such as text, bulleted points, images, multimedia and other embedded OLE objects. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppt/

##### Pptx
```
public static final PresentationFormat Pptx
```

Represents the .PPTX PowerPoint format. 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/

##### Potm
```
public static final PresentationFormat Potm
```

Represents the .POTM PowerPoint format. 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/

##### Potx
```
public static final PresentationFormat Potx
```

Represents the .POTX PowerPoint format. Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. This format was created to replace the POT file format that is based on the binary file format and is supported with PowerPoint 97-2003. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/potx/

##### Pptm
```
public static final PresentationFormat Pptm
```

Represents the .PPTM PowerPoint format. Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. They are similar to PPTX files with the difference that the lateral can't execute macros though they can contain macros. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pptm/

##### Pps
```
public static final PresentationFormat Pps
```

Represents the .PPS PowerPoint format. 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/

##### Ppsx
```
public static final PresentationFormat Ppsx
```

Represents the .PPSX PowerPoint format. PPSX, Power Point Slide Show, files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. It is an update to the PPS file format that was supported by Microsoft PowerPoint 97-2003 versions. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsx/

##### Ppsm
```
public static final PresentationFormat Ppsm
```

Represents the .PPSM PowerPoint format. Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Another similar file format is PPTM which differs in opening with Microsoft PowerPoint in editable format instead of running as Slide Show Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/ppsm/

##### Pot
```
public static final PresentationFormat Pot
```

Represents the .POT PowerPoint format. Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Files created with these versions of Microsoft PowerPoint are in binary format as compared to those created in Office OpenXML file formats using the higher versions of PowerPoint. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pot/

##### values()
```
public static PresentationFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.PresentationFormat[]
##### valueOf(String name)
```
public static PresentationFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PresentationFormat
##### getByRawValue(int rawValue)
```
public static PresentationFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PresentationFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PresentationInspectionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationInspectionPackage extends CustomPackage
```

Contains information about presentation parts that can be considered as metadata in some cases.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getHiddenSlides() | Gets an array of the hidden slides. |
| getComments() | Gets an array of the comments. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the presentation. |
| clearHiddenSlides() | Removes all detected hidden slides from the presentation. |
| sanitize() | Removes writable metadata properties from the package. |
##### getHiddenSlides()
```
public final PresentationSlide[] getHiddenSlides()
```

Gets an array of the hidden slides.

**Returns:**
com.groupdocs.metadata.core.PresentationSlide[] - The hidden slides.
##### getComments()
```
public final PresentationComment[] getComments()
```

Gets an array of the comments.

**Returns:**
com.groupdocs.metadata.core.PresentationComment[] - The comments.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the presentation.

##### clearHiddenSlides()
```
public final void clearHiddenSlides()
```

Removes all detected hidden slides from the presentation.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### PresentationPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class PresentationPackage extends DocumentPackage
```

Represents a native metadata package in a presentation.

This example demonstrates how to update built-in metadata properties in a presentation.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      PresentationRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputPptx);
>  }
>
> ```
> ```

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getApplicationTemplate() | Gets the application template. |
| setApplicationTemplate(String value) | Sets the application template. |
| getAuthor() | Gets the document's author. |
| setAuthor(String value) | Sets the document's author. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastPrintedDate() | Gets the last printed date. |
| setLastPrintedDate(Date value) | Sets the last printed date. |
| getLastSavedTime() | Gets the date and time when the presentation was modified last time. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of the application created the document. |
| getRevisionNumber() | Gets the revision number. |
| setRevisionNumber(int value) | Sets the revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getVersion() | Gets the application version. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getPresentationFormat() | Gets the presentation format. |
| getSharedDoc() | Gets a value indicating whether the presentation is shared between multiple people. |
| setSharedDoc(boolean value) | Sets a value indicating whether the presentation is shared between multiple people. |
| getTotalEditingTime() | Gets the total editing time of the document. |
| setTotalEditingTime(double value) | Sets the total editing time of the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getApplicationTemplate()
```
public final String getApplicationTemplate()
```

Gets the application template.

**Returns:**
java.lang.String - The application template.
##### setApplicationTemplate(String value)
```
public final void setApplicationTemplate(String value)
```

Sets the application template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The application template. |

##### getAuthor()
```
public final String getAuthor()
```

Gets the document's author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document's author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getCategory()
```
public final String getCategory()
```

Gets the category.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getComments()
```
public final String getComments()
```

Gets the comments.

**Returns:**
java.lang.String - The comments.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comments. |

##### getCompany()
```
public final String getCompany()
```

Gets the company.

**Returns:**
java.lang.String - The company.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The company. |

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status. Can be updated in a PPTX document only.

**Returns:**
java.lang.String - The content status.

Can be updated in a PPTX document only. Read-only for other supported formats.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status. Can be updated in a PPTX document only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content status.

Can be updated in a PPTX document only. Read-only for other supported formats. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type. Can be updated in a PPTX document only.

**Returns:**
java.lang.String - The type of the content.

Can be updated in a PPTX document only. Read-only for other supported formats.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type. Can be updated in a PPTX document only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content.

Can be updated in a PPTX document only. Read-only for other supported formats. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The document created date.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The document created date. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the date and time when the presentation was modified last time.

**Returns:**
java.util.Date - The last saved time.
##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The last saved by.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The last saved by. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

**Returns:**
java.lang.String - The manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manager. |

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of the application created the document.

**Returns:**
java.lang.String - The name of the application.
##### getRevisionNumber()
```
public final int getRevisionNumber()
```

Gets the revision number.

**Returns:**
int - The revision number.
##### setRevisionNumber(int value)
```
public final void setRevisionNumber(int value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The revision number. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title. |

##### getVersion()
```
public final String getVersion()
```

Gets the application version.

**Returns:**
java.lang.String - The application version.
##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.

Read-only in old PPT.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink base.

Read-only in old PPT. |

##### getPresentationFormat()
```
public final String getPresentationFormat()
```

Gets the presentation format.

**Returns:**
java.lang.String - The presentation format.
##### getSharedDoc()
```
public final boolean getSharedDoc()
```

Gets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

**Returns:**
boolean -  true  if the presentation shared between multiple people; otherwise,  false .

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc.
##### setSharedDoc(boolean value)
```
public final void setSharedDoc(boolean value)
```

Sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if the presentation shared between multiple people; otherwise,  false .

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc. |

##### getTotalEditingTime()
```
public final double getTotalEditingTime()
```

Gets the total editing time of the document.

**Returns:**
double - The total editing time of the document.
##### setTotalEditingTime(double value)
```
public final void setTotalEditingTime(double value)
```

Sets the total editing time of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The total editing time of the document. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### PresentationRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class PresentationRootPackage extends DocumentRootPackage<PresentationPackage>
```

Represents the root package intended to work with metadata in a presentation.

This example shows how to extract built-in metadata properties from a presentation.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputPpt)) {
>      PresentationRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLastPrintedDate());
>      System.out.println(root.getDocumentProperties().getNameOfApplication());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getPresentationType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getPresentationType()
```
public final PresentationTypePackage getPresentationType()
```

Gets the file type metadata package.

**Returns:**
PresentationTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final PresentationInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
PresentationInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### PresentationSlide
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PresentationSlide extends CustomPackage
```

Represents a slide in a presentation.

[Working with metadata in Presentations]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Presentations
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the slide name. |
| getNumber() | Gets the slide number. |
| getSlideId() | Gets the slide id. |
##### getName()
```
public final String getName()
```

Gets the slide name.

**Returns:**
java.lang.String - The slide name.
##### getNumber()
```
public final int getNumber()
```

Gets the slide number.

**Returns:**
int - The slide number.
##### getSlideId()
```
public final long getSlideId()
```

Gets the slide id.

**Returns:**
long - The slide identifier.

### PresentationTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/presentationtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class PresentationTypePackage extends FileTypePackage
```

Represents a metadata package containing presentation-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getPresentationFormat() | Gets the exact presentation format. |
##### getPresentationFormat()
```
public final PresentationFormat getPresentationFormat()
```

Gets the exact presentation format.

**Returns:**
PresentationFormat - The exact presentation format.

### ProjectManagementPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/projectmanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public final class ProjectManagementPackage extends DocumentPackage
```

Represents a native metadata package in a project management file.

This code sample demonstrates how to update built-in properties in a ProjectManagement document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMpp)) {
>      ProjectManagementRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreationDate(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setComments("test comment");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputMpp);
>  }
>
> ```
> ```

[Working with metadata in ProjectManagement formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+ProjectManagement+formats
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the project. |
| setAuthor(String value) | Sets the author of the project. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the user comments. |
| setComments(String value) | Sets the user comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getCreationDate() | Gets the creation date. |
| setCreationDate(Date value) | Sets the creation date. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastAuthor() | Gets the last author. |
| setLastAuthor(String value) | Sets the last author. |
| getRevision() | Gets the revision number. |
| setRevision(int value) | Sets the revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTitle() | Gets the title. |
| setTitle(String value) | Sets the title. |
| getTemplate() | Gets the template. |
| setTemplate(String value) | Sets the template. |
| getManager() | Gets the project manager. |
| setManager(String value) | Sets the project manager. |
| getLastSaved() | Gets the date when the project was saved last time. |
| setLastSaved(Date value) | Sets the date when the project was saved last time. |
| getSaveVersion() | Gets the version of Microsoft Office Project from which a project file was saved. |
| getLastPrinted() | Gets the project's last print time. |
| setLastPrinted(Date value) | Sets the project's last print time. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the project.

**Returns:**
java.lang.String - The author of the project.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author of the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author of the project. |

##### getCategory()
```
public final String getCategory()
```

Gets the category.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getComments()
```
public final String getComments()
```

Gets the user comments.

**Returns:**
java.lang.String - The user comments.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the user comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user comments. |

##### getCompany()
```
public final String getCompany()
```

Gets the company.

**Returns:**
java.lang.String - The company.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The company. |

##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the creation date.

**Returns:**
java.util.Date - The creation date.
##### setCreationDate(Date value)
```
public final void setCreationDate(Date value)
```

Sets the creation date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The creation date. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink base. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getLastAuthor()
```
public final String getLastAuthor()
```

Gets the last author.

**Returns:**
java.lang.String - The last author.
##### setLastAuthor(String value)
```
public final void setLastAuthor(String value)
```

Sets the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The last author. |

##### getRevision()
```
public final int getRevision()
```

Gets the revision number.

**Returns:**
int - The revision number.
##### setRevision(int value)
```
public final void setRevision(int value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The revision number. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject. |

##### getTitle()
```
public final String getTitle()
```

Gets the title.

**Returns:**
java.lang.String - The title.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title. |

##### getTemplate()
```
public final String getTemplate()
```

Gets the template.

**Returns:**
java.lang.String - The template.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets the template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The template. |

##### getManager()
```
public final String getManager()
```

Gets the project manager.

**Returns:**
java.lang.String - The project manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the project manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The project manager. |

##### getLastSaved()
```
public final Date getLastSaved()
```

Gets the date when the project was saved last time.

**Returns:**
java.util.Date - The date when the project was saved last time.
##### setLastSaved(Date value)
```
public final void setLastSaved(Date value)
```

Sets the date when the project was saved last time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date when the project was saved last time. |

##### getSaveVersion()
```
public final int getSaveVersion()
```

Gets the version of Microsoft Office Project from which a project file was saved.

**Returns:**
int - The version of Microsoft Office Project from which a project file was saved.
##### getLastPrinted()
```
public final Date getLastPrinted()
```

Gets the project's last print time.

**Returns:**
java.util.Date - The project's last print time.
##### setLastPrinted(Date value)
```
public final void setLastPrinted(Date value)
```

Sets the project's last print time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The project's last print time. |

##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

### ProjectManagementRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/projectmanagementrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class ProjectManagementRootPackage extends DocumentRootPackage<ProjectManagementPackage>
```

Represents the root package intended to work with metadata in a project management format.

This code sample demonstrates how to extract built-in properties of a ProjectManagement document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputMpp)) {
>      ProjectManagementRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreationDate());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getRevision());
>      System.out.println(root.getDocumentProperties().getSubject());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in ProjectManagement formats]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+ProjectManagement+formats

### PropertyAccessLevels
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/propertyaccesslevels.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class PropertyAccessLevels implements IEnumValue
```

Defines access levels for metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Read | The property is read-only. |
| Update | It is possible to update the property using the  MetadataPackage.UpdateProperties  method. |
| Remove | The property can be removed through the  MetadataPackage.RemoveProperties  method. |
| Add | It is possible to update the property using the  MetadataPackage.AddProperties  method. |
| Full | Grants full access to the property. |
| AddOrUpdate | It is allowed to add and update the property. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### Read
```
public static final PropertyAccessLevels Read
```

The property is read-only.

##### Update
```
public static final PropertyAccessLevels Update
```

It is possible to update the property using the  MetadataPackage.UpdateProperties  method.

##### Remove
```
public static final PropertyAccessLevels Remove
```

The property can be removed through the  MetadataPackage.RemoveProperties  method.

##### Add
```
public static final PropertyAccessLevels Add
```

It is possible to update the property using the  MetadataPackage.AddProperties  method.

##### Full
```
public static final PropertyAccessLevels Full
```

Grants full access to the property.

##### AddOrUpdate
```
public static final PropertyAccessLevels AddOrUpdate
```

It is allowed to add and update the property. All other operations are restricted.

##### getByRawValue(int rawValue)
```
public static PropertyAccessLevels getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PropertyAccessLevels
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### PropertyDescriptor
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/propertydescriptor.md

**Inheritance:**
java.lang.Object
```
public class PropertyDescriptor
```

Represents a descriptor of a property that can be accessed through the GroupDocs.Metadata search engine.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the property name. |
| getType() | Gets the property type. |
| getAccessLevel() | Gets the property access level. |
| getTags() | Gets a collection of tags associated with the property. |
| getInterpreter() | Gets the property value interpreter. |
##### getName()
```
public final String getName()
```

Gets the property name.

**Returns:**
java.lang.String - The property name.
##### getType()
```
public final MetadataPropertyType getType()
```

Gets the property type.

**Returns:**
MetadataPropertyType - The property type.
##### getAccessLevel()
```
public PropertyAccessLevels getAccessLevel()
```

Gets the property access level.

**Returns:**
PropertyAccessLevels - The property access level.
##### getTags()
```
public final IReadOnlyList<PropertyTag> getTags()
```

Gets a collection of tags associated with the property.

**Returns:**
IReadOnlyList - A collection of tags associated with the property.
##### getInterpreter()
```
public final ValueInterpreter getInterpreter()
```

Gets the property value interpreter.

**Returns:**
ValueInterpreter - The property value interpreter.

### PropertyValue
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/propertyvalue.md

**Inheritance:**
java.lang.Object
```
public class PropertyValue
```

Represents a property value.
#### Constructors

| Constructor | Description |
| --- | --- |
| PropertyValue(int value) | Initializes a new instance of the  PropertyValue  class with an integer value. |
| PropertyValue(long value) | Initializes a new instance of the  PropertyValue  class with a long value. |
| PropertyValue(boolean value) | Initializes a new instance of the  PropertyValue  class with a boolean value. |
| PropertyValue(double value) | Initializes a new instance of the  PropertyValue  class with a double value. |
| PropertyValue(String value) | Initializes a new instance of the  PropertyValue  class with a string value. |
| PropertyValue(Date value) | Initializes a new instance of the  PropertyValue  class with a  DateTime  value. |
| PropertyValue(String[] values) | Initializes a new instance of the  PropertyValue  class with a string array. |
| PropertyValue(byte[] values) | Initializes a new instance of the  PropertyValue  class with a byte array. |
| PropertyValue(double[] values) | Initializes a new instance of the  PropertyValue  class with an array of double values. |
| PropertyValue(int[] values) | Initializes a new instance of the  PropertyValue  class with an array of integer values. |
| PropertyValue(long[] values) | Initializes a new instance of the  PropertyValue  class with an array of long values. |
| PropertyValue(PropertyValue[] values) | Initializes a new instance of the  PropertyValue  class with an array of metadata property values. |
| PropertyValue(PropertyValue value) |  |
| PropertyValue(UUID value) |  |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Gets the  MetadataPropertyType . |
| getRawValue() | Gets the raw value. |
| getEmpty() |  |
| <TElement>toArray(Class<TElement> elementType) | Converts the property value to an array of the specified type. |
| <T>toClass(Class<T> type) | Converts the property value to a reference type. |
| toString() | Returns a string that represents the property value. |
| acceptValue(ValueAcceptor valueAcceptor) | Extracts the property value using a custom ValueAcceptor. |
##### PropertyValue(int value)
```
public PropertyValue(int value)
```

Initializes a new instance of the  PropertyValue  class with an integer value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | An  int  value. |

##### PropertyValue(long value)
```
public PropertyValue(long value)
```

Initializes a new instance of the  PropertyValue  class with a long value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | A  long  value. |

##### PropertyValue(boolean value)
```
public PropertyValue(boolean value)
```

Initializes a new instance of the  PropertyValue  class with a boolean value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A  bool  value. |

##### PropertyValue(double value)
```
public PropertyValue(double value)
```

Initializes a new instance of the  PropertyValue  class with a double value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | A  double  value. |

##### PropertyValue(String value)
```
public PropertyValue(String value)
```

Initializes a new instance of the  PropertyValue  class with a string value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A  string  value. |

##### PropertyValue(Date value)
```
public PropertyValue(Date value)
```

Initializes a new instance of the  PropertyValue  class with a  DateTime  value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | A  DateTime  value. |

##### PropertyValue(String[] values)
```
public PropertyValue(String[] values)
```

Initializes a new instance of the  PropertyValue  class with a string array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | java.lang.String[] | A string array. |

##### PropertyValue(byte[] values)
```
public PropertyValue(byte[] values)
```

Initializes a new instance of the  PropertyValue  class with a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | byte[] | A byte array. |

##### PropertyValue(double[] values)
```
public PropertyValue(double[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of double values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | double[] | An array of double values. |

##### PropertyValue(int[] values)
```
public PropertyValue(int[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of integer values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | int[] | An array of integer values. |

##### PropertyValue(long[] values)
```
public PropertyValue(long[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of long values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | long[] | An array of long values. |

##### PropertyValue(PropertyValue[] values)
```
public PropertyValue(PropertyValue[] values)
```

Initializes a new instance of the  PropertyValue  class with an array of metadata property values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | PropertyValue\[\] | An array of metadata property values. |

##### PropertyValue(PropertyValue value)
```
public PropertyValue(PropertyValue value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PropertyValue |  |

##### PropertyValue(UUID value)
```
public PropertyValue(UUID value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.UUID |  |

##### getType()
```
public final MetadataPropertyType getType()
```

Gets the  MetadataPropertyType .

**Returns:**
MetadataPropertyType - The type of the property.
##### getRawValue()
```
public final Object getRawValue()
```

Gets the raw value.

**Returns:**
java.lang.Object - The raw value.
##### getEmpty()
```
public static PropertyValue getEmpty()
```

**Returns:**
PropertyValue
##### <TElement>toArray(Class<TElement> elementType)
```
public final TElement[] <TElement>toArray(Class<TElement> elementType)
```

Converts the property value to an array of the specified type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| elementType | java.lang.Class<TElement> |  |

**Returns:**
TElement[] - The value represented as an array of the specified type or null if there is no such conversion.

 TElement : The type of an element.
##### <T>toClass(Class<T> type)
```
public final T <T>toClass(Class<T> type)
```

Converts the property value to a reference type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T - The converted value or null if there is no such conversion.

 T : The exact type to convert to.
##### toString()
```
public String toString()
```

Returns a string that represents the property value.

**Returns:**
java.lang.String - A string that represents the property value.
##### acceptValue(ValueAcceptor valueAcceptor)
```
public void acceptValue(ValueAcceptor valueAcceptor)
```

Extracts the property value using a custom ValueAcceptor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueAcceptor | ValueAcceptor | An acceptor that extracts the value. |

### PsdColorMode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PsdColorMode extends Enum<PsdColorMode> implements IEnumValue
```

Represents the psd file format color mode.
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | The bitmap color mode. |
| Grayscale | The grayscale mode. |
| Indexed | The indexed color mode. |
| Rgb | The RGB color mode. |
| Cmyk | The CMYK color mode. |
| Multichannel | The multichannel color mode. |
| Duotone | The duotone color mode. |
| Lab | The LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Bitmap
```
public static final PsdColorMode Bitmap
```

The bitmap color mode.

##### Grayscale
```
public static final PsdColorMode Grayscale
```

The grayscale mode.

##### Indexed
```
public static final PsdColorMode Indexed
```

The indexed color mode.

##### Rgb
```
public static final PsdColorMode Rgb
```

The RGB color mode.

##### Cmyk
```
public static final PsdColorMode Cmyk
```

The CMYK color mode.

##### Multichannel
```
public static final PsdColorMode Multichannel
```

The multichannel color mode.

##### Duotone
```
public static final PsdColorMode Duotone
```

The duotone color mode.

##### Lab
```
public static final PsdColorMode Lab
```

The LAB color mode.

##### values()
```
public static PsdColorMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.PsdColorMode[]
##### valueOf(String name)
```
public static PsdColorMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PsdColorMode
##### getByRawValue(int rawValue)
```
public static PsdColorMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PsdColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PsdCompressionMethod
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum PsdCompressionMethod extends Enum<PsdCompressionMethod> implements IEnumValue
```

Defines the compression method used for image data.
#### Fields

| Field | Description |
| --- | --- |
| Raw | No compression. |
| Rle | RLE compressed. |
| ZipWithoutPrediction | ZIP without prediction. |
| ZipWithPrediction | ZIP with prediction. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Raw
```
public static final PsdCompressionMethod Raw
```

No compression. The image data stored as raw bytes in RGBA planar order. That means that first all R data is written, then all G is written, then all B and finally all A data is written.

##### Rle
```
public static final PsdCompressionMethod Rle
```

RLE compressed. The image data starts with the byte counts for all the scan lines (rows \* channels), with each count stored as a two-byte value. The RLE compressed data follows, with each scan line compressed separately. The RLE compression is the same compression algorithm used by the Macintosh ROM routine PackBits and the TIFF standard.

##### ZipWithoutPrediction
```
public static final PsdCompressionMethod ZipWithoutPrediction
```

ZIP without prediction.

##### ZipWithPrediction
```
public static final PsdCompressionMethod ZipWithPrediction
```

ZIP with prediction.

##### values()
```
public static PsdCompressionMethod[] values()
```

**Returns:**
com.groupdocs.metadata.core.PsdCompressionMethod[]
##### valueOf(String name)
```
public static PsdCompressionMethod valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PsdCompressionMethod
##### getByRawValue(int rawValue)
```
public static PsdCompressionMethod getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PsdCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### PsdLayer
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdlayer.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PsdLayer extends CustomPackage
```

Represents a layer in a PSD file.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets the bits per pixel value. |
| getChannelCount() | Gets the number of channels. |
| getFlags() | Gets the layer flags. |
| getLength() | Gets the overall layer length in bytes. |
| getOpacity() | Gets the layer opacity. |
| getTop() | Gets the top layer position. |
| getLeft() | Gets the left layer position. |
| getBottom() | Gets the bottom layer position. |
| getRight() | Gets the right layer position. |
| getHeight() | Gets the height. |
| getWidth() | Gets the width. |
| getName() | Gets the layer name. |
##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets the bits per pixel value.

**Returns:**
int - The bits per pixel value.
##### getChannelCount()
```
public final int getChannelCount()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getFlags()
```
public final PsdLayerFlags getFlags()
```

Gets the layer flags.

**Returns:**
PsdLayerFlags - The flags.
##### getLength()
```
public final int getLength()
```

Gets the overall layer length in bytes.

**Returns:**
int - The overall layer length in bytes.
##### getOpacity()
```
public final byte getOpacity()
```

Gets the layer opacity. 0 = transparent, 255 = opaque.

**Returns:**
byte - The opacity.
##### getTop()
```
public final int getTop()
```

Gets the top layer position.

**Returns:**
int - The top layer position.
##### getLeft()
```
public final int getLeft()
```

Gets the left layer position.

**Returns:**
int - The left layer position.
##### getBottom()
```
public final int getBottom()
```

Gets the bottom layer position.

**Returns:**
int - The bottom layer position.
##### getRight()
```
public final int getRight()
```

Gets the right layer position.

**Returns:**
int - The right layer position.
##### getHeight()
```
public final int getHeight()
```

Gets the height.

**Returns:**
int - The height.
##### getWidth()
```
public final int getWidth()
```

Gets the width.

**Returns:**
int - The width.
##### getName()
```
public final String getName()
```

Gets the layer name.

**Returns:**
java.lang.String - The layer name.

### PsdLayerFlags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdlayerflags.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class PsdLayerFlags implements IEnumValue
```

The Photoshop layer flags.
#### Fields

| Field | Description |
| --- | --- |
| None | No flags are set. |
| TransparencyProtected | The transparency protected flag. |
| Visible | The visibility flag. |
| Obsolete | The obsolete flag. |
| HasUsefulInformation | Defines if bit 4 has useful information. |
| PixelDataIrrelevantToAppearanceInDocument | The pixel data is irrelevant to appearance in a document. |
| Undocumented | An undocumented flag. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### None
```
public static final PsdLayerFlags None
```

No flags are set.

##### TransparencyProtected
```
public static final PsdLayerFlags TransparencyProtected
```

The transparency protected flag.

##### Visible
```
public static final PsdLayerFlags Visible
```

The visibility flag.

##### Obsolete
```
public static final PsdLayerFlags Obsolete
```

The obsolete flag.

##### HasUsefulInformation
```
public static final PsdLayerFlags HasUsefulInformation
```

Defines if bit 4 has useful information. 1 for Photoshop 5.0 and later,

##### PixelDataIrrelevantToAppearanceInDocument
```
public static final PsdLayerFlags PixelDataIrrelevantToAppearanceInDocument
```

The pixel data is irrelevant to appearance in a document.

##### Undocumented
```
public static final PsdLayerFlags Undocumented
```

An undocumented flag.

##### getByRawValue(int rawValue)
```
public static PsdLayerFlags getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
PsdLayerFlags
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### PsdPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class PsdPackage extends CustomPackage
```

Represents native Photoshop metadata.

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
#### Methods

| Method | Description |
| --- | --- |
| getChannelCount() | Gets the number of channels. |
| getColorMode() | Gets the psd color mode. |
| getCompression() | Gets the compression method used for image data. |
| getPhotoshopVersion() | Gets the Photoshop version. |
| getHeight() | Gets the height of the image. |
| getWidth() | Gets PSD width of the image. |
| getLayers() | Gets the Photoshop layers. |
##### getChannelCount()
```
public final int getChannelCount()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getColorMode()
```
public final PsdColorMode getColorMode()
```

Gets the psd color mode.

**Returns:**
PsdColorMode - The color mode.
##### getCompression()
```
public final PsdCompressionMethod getCompression()
```

Gets the compression method used for image data.

**Returns:**
PsdCompressionMethod - The compression method.
##### getPhotoshopVersion()
```
public final int getPhotoshopVersion()
```

Gets the Photoshop version.

**Returns:**
int - The photoshop version.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the image.

**Returns:**
int - The height of the image.
##### getWidth()
```
public final int getWidth()
```

Gets PSD width of the image.

**Returns:**
int - The width of the image.
##### getLayers()
```
public final PsdLayer[] getLayers()
```

Gets the Photoshop layers.

**Returns:**
com.groupdocs.metadata.core.PsdLayer[] - The Photoshop layers.

### PsdRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/psdrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IIptc, com.groupdocs.metadata.core.IExif
```
public class PsdRootPackage extends ImageRootPackage implements IXmp, IIptc, IExif
```

Represents the root package allowing working with metadata in a Photoshop Document.

This code sample demonstrates how to read the header of a PSD file and extract some information about the PSD layers.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.PsdWithIptc)) {
>      PsdRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getPsdPackage().getChannelCount());
>      System.out.println(root.getPsdPackage().getColorMode());
>      System.out.println(root.getPsdPackage().getCompression());
>      System.out.println(root.getPsdPackage().getPhotoshopVersion());
>      for (PsdLayer layer : root.getPsdPackage().getLayers()) {
>          System.out.println(layer.getName());
>          System.out.println(layer.getBitsPerPixel());
>          System.out.println(layer.getChannelCount());
>          System.out.println(layer.getFlags());
>          System.out.println(layer.getHeight());
>          System.out.println(layer.getWidth());
>          // ...
>      }
>      // ...
>  }
>
> ```
> ```

[Working with metadata in PSD images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+PSD+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
| getImageResourcePackage() | Gets the Photoshop Image Resource metadata package. |
| getPsdPackage() | Gets the metadata package containing information about the PSD file. |
| copyTo(MetadataPackage metadata) |  |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

##### getImageResourcePackage()
```
public final ImageResourcePackage getImageResourcePackage()
```

Gets the Photoshop Image Resource metadata package. Image resource blocks are the basic building unit of Photoshop native file format.

**Returns:**
ImageResourcePackage - The Image Resource metadata package.
##### getPsdPackage()
```
public final PsdPackage getPsdPackage()
```

Gets the metadata package containing information about the PSD file.

**Returns:**
PsdPackage - The metadata package containing information about the PSD file.
##### copyTo(MetadataPackage metadata)
```
public void copyTo(MetadataPackage metadata)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | MetadataPackage |  |

### RarFile
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rarfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RarFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getName() | Gets the entry name. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

Value: The compressed size in bytes.

**Returns:**
long
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

Value: The uncompressed size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

Value: The last modification date and time.

**Returns:**
java.util.Date

### RarPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rarpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RarPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputRar))
>  {
>      var root = metadata.GetRootPackage<RarRootPackage>();
>      Console.WriteLine(root.RarPackage.TotalEntries);
>      foreach (var file in root.RarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final RarFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.RarFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### RarRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rarrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class RarRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputRar))
>  {
>      var root = metadata.GetRootPackage<RarRootPackage>();
>      Console.WriteLine(root.RarPackage.TotalEntries);
>      foreach (var file in root.RarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getRarPackage() | Gets the ZIP metadata package. |
##### getRarPackage()
```
public final RarPackage getRarPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
RarPackage

### RawDictionaryBasePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawdictionarybasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class RawDictionaryBasePackage extends CustomPackage
```

Provides an abstract base class for EXIF metadata dictionaries.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
#### Methods

| Method | Description |
| --- | --- |
| toList() | Creates a list from the package. |
| get_Item(long tagId) | Gets the Raw tag with the specified id. |
| remove(long tagId) | Removes the property with the specified id. |
| set(RawTag tag) | Adds or replaces the specified tag. |
| clear() | Removes all Raw tags stored in the package. |
##### toList()
```
public final IReadOnlyList<RawTag> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains all Raw tags from the package.
##### get_Item(long tagId)
```
public final RawTag get_Item(long tagId)
```

Gets the Raw tag with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | long | The id of the tag to retrieve. |

**Returns:**
RawTag - The  RawTag  with the specified tag id.
##### remove(long tagId)
```
public final boolean remove(long tagId)
```

Removes the property with the specified id.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagId | long | A Raw tag id. |

**Returns:**
boolean - True if the specified Raw tag is found and removed; otherwise, false.
##### set(RawTag tag)
```
public final void set(RawTag tag)
```

Adds or replaces the specified tag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | RawTag | The tag to set. |

##### clear()
```
public final void clear()
```

Removes all Raw tags stored in the package.

### RawExifTagPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawexiftagpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public abstract class RawExifTagPackage extends RawDictionaryBasePackage
```

Represents Exif tags.
#### Methods

| Method | Description |
| --- | --- |
| getRawMakerNotePackage() | Gets the Manufacturer notes (MakerNote). |
| getInteroperabilityIFDPointerPackage() | Gets the Interoperability tag (Interoperability IFD Pointer). |
| getInteroperabilityIFDPointer() | Gets the Interoperability tag (Interoperability IFD Pointer). |
| getExposureTime() | Gets the Exposure time. |
| getFNumber() | Gets the F number. |
| getExposureProgram() | Gets the Exposure program. |
| getSpectralSensitivity() | Gets the Spectral sensitivity. |
| getPhotographicSensitivity() | Gets the Photographic Sensitivity. |
| getOECF() | Gets the Optoelectric conversion factor. |
| getSensitivityType() | Gets the Sensitivity Type. |
| getStandardOutputSensitivity() | Gets the Standard Output Sensitivity. |
| getRecommendedExposureIndex() | Gets the Recommended ExposureIndexs. |
| getISOSpeed() | Gets the ISO Speed. |
| getISOSpeedLatitudeyyy() | Gets the ISO Speed Latitude yyy. |
| getISOSpeedLatitudezzz() | Gets the ISO Speed Latitude zzz. |
| getExifVersion() | Gets the ExifVersion. |
| getDateTimeOriginal() | Gets the Date and time of original data generation. |
| getDateTimeDigitized() | Gets the Date and time of digital data generation. |
| getOffsetTime() | Gets the Offset data of DateTime. |
| getOffsetTimeOriginal() | Gets the Offset data of DateTimeOriginal. |
| getOffsetTimeDigitized() | Gets the Offset data of DateTimeDigitized. |
| getComponentsConfiguration() | Gets the Meaning of each component. |
| getShutterSpeedValue() | Gets the Shutter speed. |
| getApertureValue() | Gets the Aperture. |
| getBrightnessValue() | Gets the Brightness. |
| getExposureBiasValue() | Gets the Exposure bias. |
| getMaxApertureValue() | Gets the Maximum lens aperture. |
| getSubjectDistance() | Gets the Subject distance. |
| getMeteringMode() | Gets the Metering mode. |
| getLightSource() | Gets the Light source. |
| getFlash() | Gets the Flash. |
| getFocalLength() | Gets the Lens focal length. |
| getSubjectArea() | Gets the Subject area. |
| getUserComment() | Gets the User comments. |
| getSubSecTime() | Gets the DateTime subseconds. |
| getSubSecTimeOriginal() | Gets the DateTimeOriginal subseconds. |
| getSubSecTimeDigitized() | Gets the DateTimeDigitized subseconds. |
| getTemperature() | Gets the Temperature. |
| getHumidity() | Gets the Humidity. |
| getPressure() | Gets the Pressure. |
| getWaterDepth() | Gets the WaterDepth. |
| getAcceleration() | Gets the Acceleration. |
| getCameraElevationAngle() | Gets the Camera elevation angle. |
| getFlashpixVersion() | Gets the Temperature. |
| getColorSpace() | Gets the Color space information . |
| getPixelXDimension() | Gets the Valid image width. |
| getPixelYDimension() | Gets the Valid image height. |
| getRelatedSoundFile() | Gets the Related audio file. |
| getFlashEnergy() | Gets the Flash energy. |
| getSpatialFrequencyResponse() | Gets the Spatial frequency response. |
| getFocalPlaneXResolution() | Gets Focal plane X resolution. |
| getFocalPlaneYResolution() | Gets the Focal plane Y resolution. |
| getFocalPlaneResolutionUnit() | Gets the Focal plane resolution unit. |
| getSubjectLocation() | Gets the Subject location. |
| getExposureIndex() | Gets the Exposure index. |
| getSensingMethod() | Gets the Sensing method. |
| getFileSource() | Gets the File source. |
| getSceneType() | Gets the Scene Type. |
| getCFAPattern() | Gets the CFA pattern. |
| getCustomRendered() | Gets the Custom image processing. |
| getExposureMode() | Gets the Exposure mode. |
| getWhiteBalance() | Gets the White balance. |
| getDigitalZoomRatio() | Gets the Digital zoom ratio. |
| getFocalLengthIn35mmFilm() | Gets the Focal length in 35 mm film. |
| getSceneCaptureType() | Gets the Scene capture type. |
| getGainControl() | Gets the Gain control. |
| getContrast() | Gets the Contrast. |
| getSaturation() | Gets the Saturation. |
| getSharpness() | Gets the Sharpness. |
| getDeviceSettingDescription() | Gets the Device settings description. |
| getSubjectDistanceRange() | Gets the Subject distance range. |
| getImageUniqueID() | Gets the Unique image ID. |
| getCameraOwnerName() | Gets the Camera Owner Name. |
| getBodySerialNumber() | Gets the Body Serial Number. |
| getLensSpecification() | Gets the Lens Specification. |
| getLensModel() | Gets the Lens Model. |
| getLensMake() | Gets the Lens Make. |
| getLensSerialNumber() | Gets the Lens Serial Number. |
| getCompositeImage() | Gets the Composite image. |
| getSourceImageNumberOfCompositeImage() | Gets the Source image number of composite image. |
| getSourceExposureTimesOfCompositeImage() | Gets the Source exposure times of composite image. |
| getGamma() | Gets the Gamma. |
| getMakerNote() | Gets the Standard Output Sensitivity. |
##### getRawMakerNotePackage()
```
public RawMakerNotePackage getRawMakerNotePackage()
```

Gets the Manufacturer notes (MakerNote).

**Returns:**
RawMakerNotePackage - The Manufacturer notes (MakerNote).
##### getInteroperabilityIFDPointerPackage()
```
public final InteroperabilityIFDPointerPackage getInteroperabilityIFDPointerPackage()
```

Gets the Interoperability tag (Interoperability IFD Pointer).

**Returns:**
InteroperabilityIFDPointerPackage - The Interoperability tag (Interoperability IFD Pointer).
##### getInteroperabilityIFDPointer()
```
public final long getInteroperabilityIFDPointer()
```

Gets the Interoperability tag (Interoperability IFD Pointer).

**Returns:**
long - The Interoperability tag (Interoperability IFD Pointer).
##### getExposureTime()
```
public final float getExposureTime()
```

Gets the Exposure time.

**Returns:**
float - The Exposure time.
##### getFNumber()
```
public final float getFNumber()
```

Gets the F number.

**Returns:**
float - The F number.
##### getExposureProgram()
```
public final int getExposureProgram()
```

Gets the Exposure program.

**Returns:**
int - The Exposure program.
##### getSpectralSensitivity()
```
public final String getSpectralSensitivity()
```

Gets the Spectral sensitivity.

**Returns:**
java.lang.String - The Spectral sensitivity.
##### getPhotographicSensitivity()
```
public final int getPhotographicSensitivity()
```

Gets the Photographic Sensitivity.

**Returns:**
int - The Photographic Sensitivity.
##### getOECF()
```
public final byte[] getOECF()
```

Gets the Optoelectric conversion factor.

**Returns:**
byte[] - The Optoelectric conversion factor.
##### getSensitivityType()
```
public final int getSensitivityType()
```

Gets the Sensitivity Type.

**Returns:**
int - The Sensitivity Type.
##### getStandardOutputSensitivity()
```
public final long getStandardOutputSensitivity()
```

Gets the Standard Output Sensitivity.

**Returns:**
long - The Standard Output Sensitivity.
##### getRecommendedExposureIndex()
```
public final long getRecommendedExposureIndex()
```

Gets the Recommended ExposureIndexs.

**Returns:**
long - The Recommended ExposureIndex.
##### getISOSpeed()
```
public final long getISOSpeed()
```

Gets the ISO Speed.

**Returns:**
long - The ISO Speed.
##### getISOSpeedLatitudeyyy()
```
public final long getISOSpeedLatitudeyyy()
```

Gets the ISO Speed Latitude yyy.

**Returns:**
long - The ISO Speed Latitude yyy.
##### getISOSpeedLatitudezzz()
```
public final long getISOSpeedLatitudezzz()
```

Gets the ISO Speed Latitude zzz.

**Returns:**
long - The ISO Speed Latitude zzz.
##### getExifVersion()
```
public final byte[] getExifVersion()
```

Gets the ExifVersion.

**Returns:**
byte[] - The ExifVersion.
##### getDateTimeOriginal()
```
public final String getDateTimeOriginal()
```

Gets the Date and time of original data generation.

**Returns:**
java.lang.String - The Date and time of original data generation.
##### getDateTimeDigitized()
```
public final String getDateTimeDigitized()
```

Gets the Date and time of digital data generation.

**Returns:**
java.lang.String - The Date and time of digital data generation.
##### getOffsetTime()
```
public final String getOffsetTime()
```

Gets the Offset data of DateTime.

**Returns:**
java.lang.String - The Offset data of DateTime.
##### getOffsetTimeOriginal()
```
public final String getOffsetTimeOriginal()
```

Gets the Offset data of DateTimeOriginal.

**Returns:**
java.lang.String - The Offset data of DateTimeOriginal.
##### getOffsetTimeDigitized()
```
public final String getOffsetTimeDigitized()
```

Gets the Offset data of DateTimeDigitized.

**Returns:**
java.lang.String - The Offset data of DateTimeDigitized.
##### getComponentsConfiguration()
```
public final byte[] getComponentsConfiguration()
```

Gets the Meaning of each component.

**Returns:**
byte[] - The Meaning of each component.
##### getShutterSpeedValue()
```
public final float getShutterSpeedValue()
```

Gets the Shutter speed.

**Returns:**
float - The Shutter speed.
##### getApertureValue()
```
public final float getApertureValue()
```

Gets the Aperture.

**Returns:**
float - The Aperture.
##### getBrightnessValue()
```
public final float getBrightnessValue()
```

Gets the Brightness.

**Returns:**
float - The Brightness.
##### getExposureBiasValue()
```
public final float getExposureBiasValue()
```

Gets the Exposure bias.

**Returns:**
float - The Exposure bias.
##### getMaxApertureValue()
```
public final float getMaxApertureValue()
```

Gets the Maximum lens aperture.

**Returns:**
float - The Maximum lens aperture.
##### getSubjectDistance()
```
public final float getSubjectDistance()
```

Gets the Subject distance.

**Returns:**
float - The Subject distance.
##### getMeteringMode()
```
public final int getMeteringMode()
```

Gets the Metering mode.

**Returns:**
int - The Metering mode.
##### getLightSource()
```
public final int getLightSource()
```

Gets the Light source.

**Returns:**
int - The Light source.
##### getFlash()
```
public final int getFlash()
```

Gets the Flash.

**Returns:**
int - The Flash.
##### getFocalLength()
```
public final float getFocalLength()
```

Gets the Lens focal length.

**Returns:**
float - The Lens focal length.
##### getSubjectArea()
```
public final int getSubjectArea()
```

Gets the Subject area.

**Returns:**
int - The Subject area.
##### getUserComment()
```
public final byte[] getUserComment()
```

Gets the User comments.

**Returns:**
byte[] - The User comments.
##### getSubSecTime()
```
public final String getSubSecTime()
```

Gets the DateTime subseconds.

**Returns:**
java.lang.String - The DateTime subseconds.
##### getSubSecTimeOriginal()
```
public final String getSubSecTimeOriginal()
```

Gets the DateTimeOriginal subseconds.

**Returns:**
java.lang.String - The DateTimeOriginal subseconds.
##### getSubSecTimeDigitized()
```
public final String getSubSecTimeDigitized()
```

Gets the DateTimeDigitized subseconds.

**Returns:**
java.lang.String - The DateTimeDigitized subseconds.
##### getTemperature()
```
public final float getTemperature()
```

Gets the Temperature.

**Returns:**
float - The Temperature.
##### getHumidity()
```
public final float getHumidity()
```

Gets the Humidity.

**Returns:**
float - The Humidity.
##### getPressure()
```
public final float getPressure()
```

Gets the Pressure.

**Returns:**
float - The Pressure.
##### getWaterDepth()
```
public final float getWaterDepth()
```

Gets the WaterDepth.

**Returns:**
float - The WaterDepth.
##### getAcceleration()
```
public final float getAcceleration()
```

Gets the Acceleration.

**Returns:**
float - The Acceleration.
##### getCameraElevationAngle()
```
public final float getCameraElevationAngle()
```

Gets the Camera elevation angle.

**Returns:**
float - The Camera elevation angle.
##### getFlashpixVersion()
```
public final byte[] getFlashpixVersion()
```

Gets the Temperature.

**Returns:**
byte[] - The Temperature.
##### getColorSpace()
```
public final int getColorSpace()
```

Gets the Color space information .

**Returns:**
int - The Color space information .
##### getPixelXDimension()
```
public final long getPixelXDimension()
```

Gets the Valid image width.

**Returns:**
long - The Valid image width.
##### getPixelYDimension()
```
public final long getPixelYDimension()
```

Gets the Valid image height.

**Returns:**
long - The Valid image height.
##### getRelatedSoundFile()
```
public final String getRelatedSoundFile()
```

Gets the Related audio file.

**Returns:**
java.lang.String - The Related audio file.
##### getFlashEnergy()
```
public final float getFlashEnergy()
```

Gets the Flash energy.

**Returns:**
float - The Flash energy.
##### getSpatialFrequencyResponse()
```
public final byte[] getSpatialFrequencyResponse()
```

Gets the Spatial frequency response.

**Returns:**
byte[] - The Spatial frequency response.
##### getFocalPlaneXResolution()
```
public final float getFocalPlaneXResolution()
```

Gets Focal plane X resolution.

**Returns:**
float - The Focal plane X resolution.
##### getFocalPlaneYResolution()
```
public final float getFocalPlaneYResolution()
```

Gets the Focal plane Y resolution.

**Returns:**
float - The Focal plane Y resolution.
##### getFocalPlaneResolutionUnit()
```
public final int getFocalPlaneResolutionUnit()
```

Gets the Focal plane resolution unit.

**Returns:**
int - The Focal plane resolution unit.
##### getSubjectLocation()
```
public final int getSubjectLocation()
```

Gets the Subject location.

**Returns:**
int - The Subject location.
##### getExposureIndex()
```
public final float getExposureIndex()
```

Gets the Exposure index.

**Returns:**
float - The Exposure index.
##### getSensingMethod()
```
public final int getSensingMethod()
```

Gets the Sensing method.

**Returns:**
int - The Sensing method.
##### getFileSource()
```
public final byte[] getFileSource()
```

Gets the File source.

**Returns:**
byte[] - The File source.
##### getSceneType()
```
public final byte[] getSceneType()
```

Gets the Scene Type.

**Returns:**
byte[] - The Scene Type.
##### getCFAPattern()
```
public final byte[] getCFAPattern()
```

Gets the CFA pattern.

**Returns:**
byte[] - The CFA pattern.
##### getCustomRendered()
```
public final int getCustomRendered()
```

Gets the Custom image processing.

**Returns:**
int - The Custom image processing.
##### getExposureMode()
```
public final int getExposureMode()
```

Gets the Exposure mode.

**Returns:**
int - The Exposure mode.
##### getWhiteBalance()
```
public final int getWhiteBalance()
```

Gets the White balance.

**Returns:**
int - The White balance.
##### getDigitalZoomRatio()
```
public final float getDigitalZoomRatio()
```

Gets the Digital zoom ratio.

**Returns:**
float - The Digital zoom ratio.
##### getFocalLengthIn35mmFilm()
```
public final int getFocalLengthIn35mmFilm()
```

Gets the Focal length in 35 mm film.

**Returns:**
int - The Focal length in 35 mm film.
##### getSceneCaptureType()
```
public final int getSceneCaptureType()
```

Gets the Scene capture type.

**Returns:**
int - The Scene capture type.
##### getGainControl()
```
public final float getGainControl()
```

Gets the Gain control.

**Returns:**
float - The Gain control.
##### getContrast()
```
public final int getContrast()
```

Gets the Contrast.

**Returns:**
int - The Contrast.
##### getSaturation()
```
public final int getSaturation()
```

Gets the Saturation.

**Returns:**
int - The Saturation.
##### getSharpness()
```
public final int getSharpness()
```

Gets the Sharpness.

**Returns:**
int - The Sharpness.
##### getDeviceSettingDescription()
```
public final byte[] getDeviceSettingDescription()
```

Gets the Device settings description.

**Returns:**
byte[] - The Device settings description.
##### getSubjectDistanceRange()
```
public final int getSubjectDistanceRange()
```

Gets the Subject distance range.

**Returns:**
int - The Subject distance range.
##### getImageUniqueID()
```
public final String getImageUniqueID()
```

Gets the Unique image ID.

**Returns:**
java.lang.String - The Unique image ID.
##### getCameraOwnerName()
```
public final String getCameraOwnerName()
```

Gets the Camera Owner Name.

**Returns:**
java.lang.String - The Camera Owner Name.
##### getBodySerialNumber()
```
public final String getBodySerialNumber()
```

Gets the Body Serial Number.

**Returns:**
java.lang.String - The Body Serial Number.
##### getLensSpecification()
```
public final double[] getLensSpecification()
```

Gets the Lens Specification.

**Returns:**
double[] - The Lens Specification.
##### getLensModel()
```
public final String getLensModel()
```

Gets the Lens Model.

**Returns:**
java.lang.String - The Lens Model.
##### getLensMake()
```
public final String getLensMake()
```

Gets the Lens Make.

**Returns:**
java.lang.String - The Lens Make.
##### getLensSerialNumber()
```
public final String getLensSerialNumber()
```

Gets the Lens Serial Number.

**Returns:**
java.lang.String - The Lens Serial Number.
##### getCompositeImage()
```
public final int getCompositeImage()
```

Gets the Composite image.

**Returns:**
int - The Composite image.
##### getSourceImageNumberOfCompositeImage()
```
public final int getSourceImageNumberOfCompositeImage()
```

Gets the Source image number of composite image.

**Returns:**
int - The Source image number of composite image.
##### getSourceExposureTimesOfCompositeImage()
```
public final byte[] getSourceExposureTimesOfCompositeImage()
```

Gets the Source exposure times of composite image.

**Returns:**
byte[] - The Source exposure times of composite image.
##### getGamma()
```
public final float getGamma()
```

Gets the Gamma.

**Returns:**
float - The Gamma.
##### getMakerNote()
```
public final long getMakerNote()
```

Gets the Standard Output Sensitivity.

**Returns:**
long - The Standard Output Sensitivity.

### RawIFD1Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawifd1package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD1Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getThumbnailOffset() | Gets the ThumbnailOffset. |
| getThumbnailLenght() | Gets the ThumbnailLenght. |
##### getThumbnailOffset()
```
public final long getThumbnailOffset()
```

Gets the ThumbnailOffset.

**Returns:**
long - The ThumbnailOffset.
##### getThumbnailLenght()
```
public final long getThumbnailLenght()
```

Gets the ThumbnailLenght.

**Returns:**
long - The ThumbnailLenght.

### RawIFD2Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawifd2package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD2Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getBitsPerSample() | Gets the image BitsPerSample. |
| getCompression() | Gets the image Compression. |
| getPhotometricInterpretation() | Gets the image PhotometricInterpretation. |
| getStripOffset() | Gets the image StripOffset. |
| getSamplesPerPixel() | Gets the SamplesPerPixel. |
| getRowPerStrip() | Gets the RowPerStrip. |
| getStripByteCounts() | Gets the StripByteCounts. |
| getPlanarConfiguration() | Gets the PlanarConfiguration. |
| getUnknown1() | Gets the Unknown1. |
| getUnknown2() | Gets the Unknown2. |
| getUnknown3() | Gets the Unknown3. |
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getBitsPerSample()
```
public final int[] getBitsPerSample()
```

Gets the image BitsPerSample.

**Returns:**
int[] - The image BitsPerSample.
##### getCompression()
```
public final int getCompression()
```

Gets the image Compression.

**Returns:**
int - The image Compression.
##### getPhotometricInterpretation()
```
public final int getPhotometricInterpretation()
```

Gets the image PhotometricInterpretation.

**Returns:**
int - The image PhotometricInterpretation.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the image StripOffset.

**Returns:**
long - The image StripOffset.
##### getSamplesPerPixel()
```
public final int getSamplesPerPixel()
```

Gets the SamplesPerPixel.

**Returns:**
int - The SamplesPerPixel.
##### getRowPerStrip()
```
public final int getRowPerStrip()
```

Gets the RowPerStrip.

**Returns:**
int - The RowPerStrip.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the StripByteCounts.

**Returns:**
long - The StripByteCounts.
##### getPlanarConfiguration()
```
public final int getPlanarConfiguration()
```

Gets the PlanarConfiguration.

**Returns:**
int - The PlanarConfiguration.
##### getUnknown1()
```
public final long getUnknown1()
```

Gets the Unknown1.

**Returns:**
long - The Unknown1.
##### getUnknown2()
```
public final long getUnknown2()
```

Gets the Unknown2.

**Returns:**
long - The Unknown2.
##### getUnknown3()
```
public final long[] getUnknown3()
```

Gets the Unknown3.

**Returns:**
long[] - The Unknown3.

### RawIFD3Package
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawifd3package.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawIFD3Package extends RawDictionaryBasePackage
```

Represents IFD1 tags.
#### Methods

| Method | Description |
| --- | --- |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getCompression() | Gets the image Compression. |
| getStripOffset() | Gets the image StripOffset. |
| getStripByteCounts() | Gets the image StripByteCounts. |
| getUnknown1() | Gets the Unknown1. |
| getUnknown2() | Gets the Unknown2. |
| getUnknown3() | Gets the Unknown3. |
| getUnknown4() | Gets the Unknown4. |
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getCompression()
```
public final int getCompression()
```

Gets the image Compression.

**Returns:**
int - The image Compression.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the image StripOffset.

**Returns:**
long - The image StripOffset.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the image StripByteCounts.

**Returns:**
long - The image StripByteCounts.
##### getUnknown1()
```
public final long getUnknown1()
```

Gets the Unknown1.

**Returns:**
long - The Unknown1.
##### getUnknown2()
```
public final long getUnknown2()
```

Gets the Unknown2.

**Returns:**
long - The Unknown2.
##### getUnknown3()
```
public final int[] getUnknown3()
```

Gets the Unknown3.

**Returns:**
int[] - The Unknown3.
##### getUnknown4()
```
public final long getUnknown4()
```

Gets the Unknown4.

**Returns:**
long - The Unknown4.

### RawIntegerType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawintegertype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum RawIntegerType extends Enum<RawIntegerType>
```

Defines raw integer types for enumerations.
#### Fields

| Field | Description |
| --- | --- |
| SignedByte | The 8-bit signed integer value type. |
| UnsignedByte | The 8-bit unsigned integer value type. |
| SignedShort | The 16-bit signed integer value type. |
| UnsignedShort | The 16-bit unsigned integer value type. |
| SignedInt | The 32-bit signed integer value type. |
| UnsignedInt | The 32-bit unsigned integer value type. |
| SignedLong | The 64-bit signed integer value type. |
| UnsignedLong | The 64-bit unsigned integer value type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### SignedByte
```
public static final RawIntegerType SignedByte
```

The 8-bit signed integer value type.

##### UnsignedByte
```
public static final RawIntegerType UnsignedByte
```

The 8-bit unsigned integer value type.

##### SignedShort
```
public static final RawIntegerType SignedShort
```

The 16-bit signed integer value type.

##### UnsignedShort
```
public static final RawIntegerType UnsignedShort
```

The 16-bit unsigned integer value type.

##### SignedInt
```
public static final RawIntegerType SignedInt
```

The 32-bit signed integer value type.

##### UnsignedInt
```
public static final RawIntegerType UnsignedInt
```

The 32-bit unsigned integer value type.

##### SignedLong
```
public static final RawIntegerType SignedLong
```

The 64-bit signed integer value type.

##### UnsignedLong
```
public static final RawIntegerType UnsignedLong
```

The 64-bit unsigned integer value type.

##### values()
```
public static RawIntegerType[] values()
```

**Returns:**
com.groupdocs.metadata.core.RawIntegerType[]
##### valueOf(String name)
```
public static RawIntegerType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
RawIntegerType

### RawMakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawmakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public abstract class RawMakerNotePackage extends RawDictionaryBasePackage
```

Represents Raw MakerNotes tags.

### RawTiffTagPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawtifftagpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.RawDictionaryBasePackage
```
public final class RawTiffTagPackage extends RawDictionaryBasePackage
```

Represents Tiff tags.
#### Methods

| Method | Description |
| --- | --- |
| getRawIFD1Package() | Gets the IFD1. |
| getRawIFD2Package() | Gets the IFD2. |
| getRawIFD3Package() | Gets the IFD3. |
| getRawExifTagPackage() | Gets the Exif tag (Exif IFD Pointer). |
| getGpsIfdPackage() | Gets the GPS tag (GPSInfo IFD Pointer). |
| getImageWidth() | Gets the image width. |
| getImageHeight() | Gets the image height. |
| getBitsPerSample() | Gets the bits per sample. |
| getCompression() | Gets compression. |
| getPhotometricInterpretation() | Gets PhotometricInterpretation. |
| getImageDescription() | Gets a character string giving the title of the image. |
| setImageDescription(String value) | Sets a character string giving the title of the image. |
| getMake() | Gets the macro mode. |
| getModel() | Gets the model. |
| getStripOffset() | Gets the StripOffset. |
| getOrientation() | Gets the orientation. |
| getSamplesPerPixel() | Gets the SamplesPerPixel. |
| getRowsPerStrip() | Gets the RowsPerStrip. |
| getStripByteCounts() | Gets the strip byte counts. |
| getXResolution() | Gets the XResolution. |
| getYResolution() | Gets the YResolution. |
| getPlanarConfiguration() | Gets the PlanarConfiguration. |
| getResolutionUnit() | Gets the Resolution Unit. |
| getTransferFunction() | Gets the TransferFunction. |
| getSoftware() | Gets the Software. |
| getDateTime() | Gets the DateTime. |
| getArtist() | Gets the Artist. |
| getWhitePoint() | Gets the WhitePoint. |
| getPrimaryChromaticities() | Gets the PrimaryChromaticities. |
| getJpegInterchangeFormat() | Gets the JpegInterchangeFormat. |
| getJpegInterchangeFormatLength() | Gets the JpegInterchangeFormatLength. |
| getYCbCrCoefficients() | Gets the YCbCrCoefficients. |
| getYCbCrSubSampling() | Gets the YCbCrSubSampling. |
| getYCbCrPositioning() | Gets the YCbCrPositioning. |
| getReferenceBlackWhite() | Gets the ReferenceBlackWhite. |
| getCopyright() | Gets the Copyright. |
| getEXIF() | Gets the EXIF. |
| getGpsIfd() | Gets the EXIF. |
##### getRawIFD1Package()
```
public final RawIFD1Package getRawIFD1Package()
```

Gets the IFD1.

**Returns:**
RawIFD1Package - The IFD1.
##### getRawIFD2Package()
```
public final RawIFD2Package getRawIFD2Package()
```

Gets the IFD2.

**Returns:**
RawIFD2Package - The IFD2.
##### getRawIFD3Package()
```
public final RawIFD3Package getRawIFD3Package()
```

Gets the IFD3.

**Returns:**
RawIFD3Package - The IFD3.
##### getRawExifTagPackage()
```
public final RawExifTagPackage getRawExifTagPackage()
```

Gets the Exif tag (Exif IFD Pointer).

**Returns:**
RawExifTagPackage - The Exif tag (Exif IFD Pointer).
##### getGpsIfdPackage()
```
public final GpsIfdPackage getGpsIfdPackage()
```

Gets the GPS tag (GPSInfo IFD Pointer).

**Returns:**
GpsIfdPackage - The GPS tag (GPSInfo IFD Pointer).
##### getImageWidth()
```
public final int getImageWidth()
```

Gets the image width.

**Returns:**
int - The image width.
##### getImageHeight()
```
public final int getImageHeight()
```

Gets the image height.

**Returns:**
int - The image height.
##### getBitsPerSample()
```
public final int[] getBitsPerSample()
```

Gets the bits per sample.

**Returns:**
int[] - The bits per sample.
##### getCompression()
```
public final int getCompression()
```

Gets compression.

**Returns:**
int - The compression.
##### getPhotometricInterpretation()
```
public final int getPhotometricInterpretation()
```

Gets PhotometricInterpretation.

**Returns:**
int - The PhotometricInterpretation.
##### getImageDescription()
```
public final String getImageDescription()
```

Gets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Returns:**
java.lang.String - The image description.
##### setImageDescription(String value)
```
public final void setImageDescription(String value)
```

Sets a character string giving the title of the image. It may be a comment such as "1988 company picnic" or the like.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image description. |

##### getMake()
```
public final String getMake()
```

Gets the macro mode.

**Returns:**
java.lang.String - The macro mode.
##### getModel()
```
public final String getModel()
```

Gets the model.

**Returns:**
java.lang.String - The model.
##### getStripOffset()
```
public final long getStripOffset()
```

Gets the StripOffset.

**Returns:**
long - The StripOffset.
##### getOrientation()
```
public final int getOrientation()
```

Gets the orientation.

**Returns:**
int - The orientation.
##### getSamplesPerPixel()
```
public final int getSamplesPerPixel()
```

Gets the SamplesPerPixel.

**Returns:**
int - The SamplesPerPixel.
##### getRowsPerStrip()
```
public final long getRowsPerStrip()
```

Gets the RowsPerStrip.

**Returns:**
long - The RowsPerStrip.
##### getStripByteCounts()
```
public final long getStripByteCounts()
```

Gets the strip byte counts.

**Returns:**
long - The strip byte counts.
##### getXResolution()
```
public final float getXResolution()
```

Gets the XResolution.

**Returns:**
float - The XResolution.
##### getYResolution()
```
public final float getYResolution()
```

Gets the YResolution.

**Returns:**
float - The YResolution.
##### getPlanarConfiguration()
```
public final int getPlanarConfiguration()
```

Gets the PlanarConfiguration.

**Returns:**
int - The PlanarConfiguration.
##### getResolutionUnit()
```
public final int getResolutionUnit()
```

Gets the Resolution Unit.

**Returns:**
int - The Resolution Unit.
##### getTransferFunction()
```
public final int[] getTransferFunction()
```

Gets the TransferFunction.

**Returns:**
int[] - The TransferFunction.
##### getSoftware()
```
public final String getSoftware()
```

Gets the Software.

**Returns:**
java.lang.String - The Software.
##### getDateTime()
```
public final String getDateTime()
```

Gets the DateTime.

**Returns:**
java.lang.String - The DateTime.
##### getArtist()
```
public final String getArtist()
```

Gets the Artist.

**Returns:**
java.lang.String - The Artist.
##### getWhitePoint()
```
public final double[] getWhitePoint()
```

Gets the WhitePoint.

**Returns:**
double[] - The WhitePoint.
##### getPrimaryChromaticities()
```
public final double[] getPrimaryChromaticities()
```

Gets the PrimaryChromaticities.

**Returns:**
double[] - The PrimaryChromaticities.
##### getJpegInterchangeFormat()
```
public final long getJpegInterchangeFormat()
```

Gets the JpegInterchangeFormat.

**Returns:**
long - The JpegInterchangeFormat.
##### getJpegInterchangeFormatLength()
```
public final long getJpegInterchangeFormatLength()
```

Gets the JpegInterchangeFormatLength.

**Returns:**
long - The JpegInterchangeFormatLength.
##### getYCbCrCoefficients()
```
public final double[] getYCbCrCoefficients()
```

Gets the YCbCrCoefficients.

**Returns:**
double[] - The YCbCrCoefficients.
##### getYCbCrSubSampling()
```
public final int[] getYCbCrSubSampling()
```

Gets the YCbCrSubSampling.

**Returns:**
int[] - The YCbCrSubSampling.
##### getYCbCrPositioning()
```
public final int getYCbCrPositioning()
```

Gets the YCbCrPositioning.

**Returns:**
int - The YCbCrPositioning.
##### getReferenceBlackWhite()
```
public final double[] getReferenceBlackWhite()
```

Gets the ReferenceBlackWhite.

**Returns:**
double[] - The ReferenceBlackWhite.
##### getCopyright()
```
public final String getCopyright()
```

Gets the Copyright.

**Returns:**
java.lang.String - The Copyright.
##### getEXIF()
```
public final long getEXIF()
```

Gets the EXIF.

**Returns:**
long - The EXIF.
##### getGpsIfd()
```
public final long getGpsIfd()
```

Gets the EXIF.

**Returns:**
long - The EXIF.

### RawTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rawtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class RawTypePackage extends FileTypePackage
```

Represents a metadata package containing image-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getByteOrder() | Gets the byte-order of the image. |
##### getByteOrder()
```
public final ByteOrder getByteOrder()
```

Gets the byte-order of the image. Please see  https://en.wikipedia.org/wiki/Endianness  for more information.

**Returns:**
ByteOrder - The byte-order value.

### ReadOnlyList
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/readonlylist.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IReadOnlyList
```
public class ReadOnlyList<T> implements IReadOnlyList<T>
```

Provides an abstract base class for a strongly typed read-only list.

 T : The type of the element.
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the collection. |
| get_Item(int index) | Gets the element at the specified index in the collection. |
| contains(T item) | Determines whether the collection contains a specific item. |
| contains(TagCategory item) | Determines whether the collection contains a TagCategory item. |
| indexOf(T item) | Determines the index of a specific item in the collection. |
| iterator() | Returns an enumerator that iterates through a collection. |
##### getCount()
```
public final int getCount()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.
##### get_Item(int index)
```
public final T get_Item(int index)
```

Gets the element at the specified index in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the element to get. |

**Returns:**
T - The element at the specified index.
##### contains(T item)
```
public final boolean contains(T item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### contains(TagCategory item)
```
public final boolean contains(TagCategory item)
```

Determines whether the collection contains a TagCategory item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | TagCategory | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### indexOf(T item)
```
public final int indexOf(T item)
```

Determines the index of a specific item in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
int - The index of  item  if found in the collection; otherwise, -1.
##### iterator()
```
public final Iterator<T> iterator()
```

Returns an enumerator that iterates through a collection.

**Returns:**
java.util.Iterator<T> - An  IEnumerator\{T\}  object that can be used to iterate through the collection.

### Rectangle
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rectangle.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.lang.Struct
```
public class Rectangle extends Struct<Rectangle>
```

A set of four integers that represent the location and size of a rectangle.
#### Constructors

| Constructor | Description |
| --- | --- |
| Rectangle() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEmpty() | Gets the empty rectangle. |
| getX() | Gets the x. |
| getY() | Gets the y. |
| getWidth() | Gets the width. |
| getHeight() | Gets the height. |
| getLeft() | Gets the x-coordinate of the left edge of the rectangle. |
| getTop() | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| getRight() | Gets the x-coordinate that is the sum of X and Width property values of the rectangle. |
| getBottom() | Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle. |
| isEmpty() | Gets a value indicating whether this instance is empty. |
| toString() | Returns a  System.String  that represents this instance. |
| CloneTo(Rectangle that) |  |
| Clone() |  |
| clone() |  |
| equals(Object obj) |  |
| equals(Rectangle obj1, Rectangle obj2) |  |
##### Rectangle()
```
public Rectangle()
```

##### getEmpty()
```
public static Rectangle getEmpty()
```

Gets the empty rectangle.

**Returns:**
Rectangle - The empty rectangle.
##### getX()
```
public final int getX()
```

Gets the x.

**Returns:**
int - The x.
##### getY()
```
public final int getY()
```

Gets the y.

**Returns:**
int - The y.
##### getWidth()
```
public final int getWidth()
```

Gets the width.

**Returns:**
int - The width.
##### getHeight()
```
public final int getHeight()
```

Gets the height.

**Returns:**
int - The height.
##### getLeft()
```
public final int getLeft()
```

Gets the x-coordinate of the left edge of the rectangle.

**Returns:**
int - The x-coordinate of the left edge of the rectangle.
##### getTop()
```
public final int getTop()
```

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

**Returns:**
int - The y-coordinate that is the sum of the Y and Height property values of the rectangle.
##### getRight()
```
public final int getRight()
```

Gets the x-coordinate that is the sum of X and Width property values of the rectangle.

**Returns:**
int - The x-coordinate that is the sum of X and Width property values of the rectangle.
##### getBottom()
```
public final int getBottom()
```

Gets the y-coordinate that is the sum of the Y and Height property values of the rectangle.

**Returns:**
int - The y-coordinate that is the sum of the Y and Height property values of the rectangle.
##### isEmpty()
```
public final boolean isEmpty()
```

Gets a value indicating whether this instance is empty.

**Returns:**
boolean -  true  if this instance is empty; otherwise,  false .
##### toString()
```
public String toString()
```

Returns a  System.String  that represents this instance.

**Returns:**
java.lang.String - A  System.String  that represents this instance.
##### CloneTo(Rectangle that)
```
public void CloneTo(Rectangle that)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| that | Rectangle |  |

##### Clone()
```
public Rectangle Clone()
```

**Returns:**
Rectangle
##### clone()
```
public Object clone()
```

**Returns:**
java.lang.Object
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### equals(Rectangle obj1, Rectangle obj2)
```
public static boolean equals(Rectangle obj1, Rectangle obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | Rectangle |  |
| obj2 | Rectangle |  |

**Returns:**
boolean

### RiffInfoPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/riffinfopackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class RiffInfoPackage extends CustomPackage
```

Represents the metadata package containing properties extracted from the RIFF INFO chunk.
#### Methods

| Method | Description |
| --- | --- |
| getArtist() | Gets the artist of the original subject of the file. |
| getComment() | Gets the comment about the file or the subject of the file. |
| getCopyright() | Gets the copyright information for the file. |
| getCreationDate() | Gets the date the subject of the file was created. |
| getEngineer() | Gets the name of the engineer who worked on the file. |
| getGenre() | Gets the genre of the original work. |
| getKeywords() | Gets the keywords that refer to the file or subject of the file. |
| getName() | Gets the title of the subject of the file. |
| getSubject() | Gets a description of the file contents, such as "Aerial view of Seattle." |
| getSoftware() | Gets the name of the software package used to create the file. |
| getSource() | Gets the name of the person or organization who supplied the original subject of the file. |
| getTechnician() | Gets the technician who digitized the subject file. |
##### getArtist()
```
public final String getArtist()
```

Gets the artist of the original subject of the file.

**Returns:**
java.lang.String - The artist of the original subject of the file.
##### getComment()
```
public final String getComment()
```

Gets the comment about the file or the subject of the file.

**Returns:**
java.lang.String - The comment about the file or the subject of the file.
##### getCopyright()
```
public final String getCopyright()
```

Gets the copyright information for the file.

**Returns:**
java.lang.String - The copyright information for the file.
##### getCreationDate()
```
public final String getCreationDate()
```

Gets the date the subject of the file was created.

**Returns:**
java.lang.String - The date the subject of the file was created.
##### getEngineer()
```
public final String getEngineer()
```

Gets the name of the engineer who worked on the file.

**Returns:**
java.lang.String - The name of the engineer who worked on the file.
##### getGenre()
```
public final String getGenre()
```

Gets the genre of the original work.

**Returns:**
java.lang.String - The genre of the original work.
##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords that refer to the file or subject of the file.

**Returns:**
java.lang.String - The keywords that refer to the file or subject of the file.
##### getName()
```
public final String getName()
```

Gets the title of the subject of the file.

**Returns:**
java.lang.String - The title of the subject of the file.
##### getSubject()
```
public final String getSubject()
```

Gets a description of the file contents, such as "Aerial view of Seattle."

**Returns:**
java.lang.String - A description of the file contents.
##### getSoftware()
```
public final String getSoftware()
```

Gets the name of the software package used to create the file.

**Returns:**
java.lang.String - The name of the software package used to create the file.
##### getSource()
```
public final String getSource()
```

Gets the name of the person or organization who supplied the original subject of the file.

**Returns:**
java.lang.String - The name of the person or organization who supplied the original subject of the file.
##### getTechnician()
```
public final String getTechnician()
```

Gets the technician who digitized the subject file.

**Returns:**
java.lang.String - The technician who digitized the subject file.

### RootMetadataPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/rootmetadatapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage
```
public abstract class RootMetadataPackage extends MetadataPackage
```

Represents an entry point to all metadata packages presented in a particular file.
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the file type metadata package. |
| isLicensed() |  |
| sanitize() | Removes writable metadata properties from the package. |
| copyTo(MetadataPackage metadataPackage) |  |
##### getFileType()
```
public final FileTypePackage getFileType()
```

Gets the file type metadata package.

**Returns:**
FileTypePackage - The file type metadata package.
##### isLicensed()
```
public final boolean isLicensed()
```

**Returns:**
boolean
##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage |  |

### SevenZipFile
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/sevenzipfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SevenZipFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getName() | Gets the entry name. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

Value: The compressed size in bytes.

**Returns:**
long
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

Value: The uncompressed size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

Value: The last modification date and time.

**Returns:**
java.util.Date

### SevenZipPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/sevenzippackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SevenZipPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputSevenZip))
>  {
>      var root = metadata.GetRootPackage<SevenZipRootPackage>();
>      Console.WriteLine(root.SevenZipPackage.TotalEntries);
>      foreach (var file in root.SevenZipPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final SevenZipFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.SevenZipFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### SevenZipRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/sevenziprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class SevenZipRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputSevenZip))
>  {
>      var root = metadata.GetRootPackage<SevenZipRootPackage>();
>      Console.WriteLine(root.SevenZipPackage.TotalEntries);
>      foreach (var file in root.SevenZipPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getSevenZipPackage() | Gets the ZIP metadata package. |
##### getSevenZipPackage()
```
public final SevenZipPackage getSevenZipPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
SevenZipPackage

### SonyMakerNotePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/sonymakernotepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.ExifDictionaryBasePackage, com.groupdocs.metadata.core.MakerNotePackage
```
public final class SonyMakerNotePackage extends MakerNotePackage
```

Represents SONY MakerNote metadata.
#### Methods

| Method | Description |
| --- | --- |
| getHeader() | Gets the MakerNote header. |
| getQuality() | Gets the image quality. |
| getWhiteBalance() | Gets the white balance. |
| getTeleconverter() | Gets the teleconverter type. |
| getMultiBurstMode() | Gets a value indicating whether the multi burst mode is on. |
| getMultiBurstImageWidth() | Gets the width of the multi burst image. |
| getMultiBurstImageHeight() | Gets the height of the multi burst image. |
| getRating() | Gets the rating. |
| getContrast() | Gets the contrast. |
| getSaturation() | Gets the saturation. |
| getSharpness() | Gets the sharpness. |
| getBrightness() | Gets the brightness. |
| getPictureEffect() | Gets the picture effect. |
| getSoftSkinEffect() | Gets the soft skin effect. |
| getSonyModelID() | Gets the sony model identifier. |
| getCreativeStyle() | Gets the creative style. |
| getColorTemperature() | Gets the color temperature. |
| getColorMode() | Gets the color mode. |
| getMacro() | Gets the macro. |
| getExposureMode() | Gets the exposure mode. |
| getFocusMode() | Gets the focus mode. |
| getJpegQuality() | Gets the JPEG quality. |
| getAFIlluminator() | Gets the AF illuminator type. |
| getFlashLevel() | Gets the flash level. |
| getReleaseMode() | Gets the release mode. |
##### getHeader()
```
public final String getHeader()
```

Gets the MakerNote header.

**Returns:**
java.lang.String - The MakerNote header.
##### getQuality()
```
public final Long getQuality()
```

Gets the image quality.

**Returns:**
java.lang.Long - The image quality.
##### getWhiteBalance()
```
public final Long getWhiteBalance()
```

Gets the white balance.

**Returns:**
java.lang.Long - The white balance.
##### getTeleconverter()
```
public final Long getTeleconverter()
```

Gets the teleconverter type.

**Returns:**
java.lang.Long - The teleconverter type.
##### getMultiBurstMode()
```
public final boolean getMultiBurstMode()
```

Gets a value indicating whether the multi burst mode is on.

**Returns:**
boolean -  true  if the multi burst mode is on; otherwise,  false .
##### getMultiBurstImageWidth()
```
public final Integer getMultiBurstImageWidth()
```

Gets the width of the multi burst image.

**Returns:**
java.lang.Integer - The width of the multi burst image.
##### getMultiBurstImageHeight()
```
public final Integer getMultiBurstImageHeight()
```

Gets the height of the multi burst image.

**Returns:**
java.lang.Integer - The height of the multi burst image.
##### getRating()
```
public final Long getRating()
```

Gets the rating.

**Returns:**
java.lang.Long - The rating.
##### getContrast()
```
public final Integer getContrast()
```

Gets the contrast.

**Returns:**
java.lang.Integer - The contrast.
##### getSaturation()
```
public final Integer getSaturation()
```

Gets the saturation.

**Returns:**
java.lang.Integer - The saturation.
##### getSharpness()
```
public final Integer getSharpness()
```

Gets the sharpness.

**Returns:**
java.lang.Integer - The sharpness.
##### getBrightness()
```
public final Integer getBrightness()
```

Gets the brightness.

**Returns:**
java.lang.Integer - The brightness.
##### getPictureEffect()
```
public final Integer getPictureEffect()
```

Gets the picture effect.

**Returns:**
java.lang.Integer - The picture effect.
##### getSoftSkinEffect()
```
public final Long getSoftSkinEffect()
```

Gets the soft skin effect.

**Returns:**
java.lang.Long - The soft skin effect.
##### getSonyModelID()
```
public final Integer getSonyModelID()
```

Gets the sony model identifier.

**Returns:**
java.lang.Integer - The sony model identifier.
##### getCreativeStyle()
```
public final String getCreativeStyle()
```

Gets the creative style.

**Returns:**
java.lang.String - The creative style.
##### getColorTemperature()
```
public final Long getColorTemperature()
```

Gets the color temperature.

**Returns:**
java.lang.Long - The color temperature.
##### getColorMode()
```
public final Long getColorMode()
```

Gets the color mode.

**Returns:**
java.lang.Long - The color mode.
##### getMacro()
```
public final Integer getMacro()
```

Gets the macro.

**Returns:**
java.lang.Integer - The macro.
##### getExposureMode()
```
public final Integer getExposureMode()
```

Gets the exposure mode.

**Returns:**
java.lang.Integer - The exposure mode.
##### getFocusMode()
```
public final Integer getFocusMode()
```

Gets the focus mode.

**Returns:**
java.lang.Integer - The focus mode.
##### getJpegQuality()
```
public final Integer getJpegQuality()
```

Gets the JPEG quality.

**Returns:**
java.lang.Integer - The JPEG quality.
##### getAFIlluminator()
```
public final Integer getAFIlluminator()
```

Gets the AF illuminator type.

**Returns:**
java.lang.Integer - The AF illuminator type.
##### getFlashLevel()
```
public final Short getFlashLevel()
```

Gets the flash level.

**Returns:**
java.lang.Short - The flash level.
##### getReleaseMode()
```
public final Integer getReleaseMode()
```

Gets the release mode.

**Returns:**
java.lang.Integer - The release mode.

### SpreadsheetComment
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class SpreadsheetComment extends CustomPackage
```

Represents a user comment in a spreadsheet.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the comment. |
| getText() | Gets the comment text. |
| getSheetNumber() | Gets the sheet number. |
| getRow() | Gets the one-based row index of the comment. |
| getColumn() | Gets the one-based column index of the comment. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the comment.

**Returns:**
java.lang.String - The author of the comment.
##### getText()
```
public final String getText()
```

Gets the comment text.

**Returns:**
java.lang.String - The comment text.
##### getSheetNumber()
```
public final int getSheetNumber()
```

Gets the sheet number.

**Returns:**
int - The sheet number.
##### getRow()
```
public final int getRow()
```

Gets the one-based row index of the comment.

**Returns:**
int - The row index of the comment.
##### getColumn()
```
public final int getColumn()
```

Gets the one-based column index of the comment.

**Returns:**
int - The column index of the comment.

### SpreadsheetContentTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetcontenttypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class SpreadsheetContentTypePackage extends CustomPackage
```

Represents a metadata package containing spreadsheet content type properties.
#### Methods

| Method | Description |
| --- | --- |
| set(String propertyName, String propertyValue) | Adds or replaces the content type property with the specified name. |
| set(String propertyName, String propertyValue, String propertyType) | Adds or replaces the content type property with the specified name. |
| remove(String propertyName) | Removes the content type property with the specified name. |
| clear() | Removes all writable metadata properties. |
| toList() | Creates a list from the package. |
##### set(String propertyName, String propertyValue)
```
public final void set(String propertyName, String propertyValue)
```

Adds or replaces the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| propertyValue | java.lang.String | The property value. |

##### set(String propertyName, String propertyValue, String propertyType)
```
public final void set(String propertyName, String propertyValue, String propertyType)
```

Adds or replaces the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| propertyValue | java.lang.String | The property value. |
| propertyType | java.lang.String | The property type. |

##### remove(String propertyName)
```
public final boolean remove(String propertyName)
```

Removes the content type property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The name of the content type property to be removed. |

**Returns:**
boolean -  true  if the property is found and deleted; otherwise  false .
##### clear()
```
public final void clear()
```

Removes all writable metadata properties.

##### toList()
```
public final IReadOnlyList<SpreadsheetContentTypeProperty> toList()
```

Creates a list from the package.

**Returns:**
IReadOnlyList - A list that contains properties from the package.

### SpreadsheetContentTypeProperty
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetcontenttypeproperty.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public final class SpreadsheetContentTypeProperty extends MetadataProperty
```

Represents a content type property in a spreadsheet.
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetPropertyType() | Gets the type of the property. |
| getSpreadsheetPropertyValue() | Gets the value of the property. |
##### getSpreadsheetPropertyType()
```
public final String getSpreadsheetPropertyType()
```

Gets the type of the property.

**Returns:**
java.lang.String - The type of the property.
##### getSpreadsheetPropertyValue()
```
public final String getSpreadsheetPropertyValue()
```

Gets the value of the property.

**Returns:**
java.lang.String - The value of the property.

### SpreadsheetFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum SpreadsheetFormat extends Enum<SpreadsheetFormat> implements IEnumValue
```

Defines various spreadsheet subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Xls | Represents the .XLS Excel format. |
| Xlsb | Represents the .XLSB Excel format. |
| Xlsx | Represents the .XLSX Excel format. |
| Xlsm | Represents the .XLSM Excel format. |
| Xltx | Represents the .XLTX Excel format. |
| Xltm | Represents the .XLTM Excel format. |
| Ods | Represents the Opendocument Spreadsheet format. |
| Xlt | Represents the .XLT Excel format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final SpreadsheetFormat Unknown
```

The format is not recognized.

##### Xls
```
public static final SpreadsheetFormat Xls
```

Represents the .XLS Excel format. Files with XLS extension represent 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. File saved by Excel is known as Workbook where each workbook can have one or more worksheets. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xls/

##### Xlsb
```
public static final SpreadsheetFormat Xlsb
```

Represents the .XLSB Excel format. XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. The content can include unstructured or semi-structured tables of numbers, text, or both numbers and text, formulas, external data connections, charts and images. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsb/

##### Xlsx
```
public static final SpreadsheetFormat Xlsx
```

Represents the .XLSX Excel format. XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Based on structure organized according to the Open Packaging Conventions as outlined in Part 2 of the OOXML standard ECMA-376, the new format is a zip package that contains a number of XML files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsx/

##### Xlsm
```
public static final SpreadsheetFormat Xlsm
```

Represents the .XLSM Excel format. Files with XLSM extension is a type of Spreasheet files that support Macros. From application point of view, a Macro is set of instructions that are used for automating processes. A macro is used to record the steps that are performed repeatedly and facilitates performing the actions by running the macro again. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsm/

##### Xltx
```
public static final SpreadsheetFormat Xltx
```

Represents the .XLTX Excel format. Files with XLTX extension represent Microsoft Excel Template files 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/

##### Xltm
```
public static final SpreadsheetFormat Xltm
```

Represents the .XLTM Excel format. 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. Such template files are used to generate and set the layout, formatting, and other settings along with the macros to facilitate creating similar XLSX files then. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xltm/

##### Ods
```
public static final SpreadsheetFormat Ods
```

Represents the Opendocument Spreadsheet format. 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. It is XML-based format and is one of the several subtypes in the Open Document Formats (ODF) family. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/ods/

##### Xlt
```
public static final SpreadsheetFormat Xlt
```

Represents the .XLT Excel format. 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. The latest version of Excel is still capable of opening this old format template files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlt/

##### values()
```
public static SpreadsheetFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.SpreadsheetFormat[]
##### valueOf(String name)
```
public static SpreadsheetFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
SpreadsheetFormat
##### getByRawValue(int rawValue)
```
public static SpreadsheetFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
SpreadsheetFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### SpreadsheetInspectionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetinspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SpreadsheetInspectionPackage extends CustomPackage
```

Contains information about spreadsheet parts that can be considered as metadata in some cases.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets an array of the user comments. |
| getHiddenSheets() | Gets an array of the hidden sheets. |
| getDigitalSignatures() | Gets an array of digital signatures presented in the document. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the spreadsheet. |
| clearHiddenSheets() | Removes all detected hidden sheets from the spreadsheet. |
| clearDigitalSignatures() | Removes all detected digital signatures from the spreadsheet. |
| sanitize() | Removes writable metadata properties from the package. |
##### getComments()
```
public final SpreadsheetComment[] getComments()
```

Gets an array of the user comments.

**Returns:**
com.groupdocs.metadata.core.SpreadsheetComment[] - The user comments.
##### getHiddenSheets()
```
public final SpreadsheetSheet[] getHiddenSheets()
```

Gets an array of the hidden sheets.

**Returns:**
com.groupdocs.metadata.core.SpreadsheetSheet[] - The hidden sheets.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - The digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the spreadsheet.

##### clearHiddenSheets()
```
public final void clearHiddenSheets()
```

Removes all detected hidden sheets from the spreadsheet.

##### clearDigitalSignatures()
```
public final void clearDigitalSignatures()
```

Removes all detected digital signatures from the spreadsheet.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### SpreadsheetPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class SpreadsheetPackage extends DocumentPackage
```

Represents a native metadata package in a spreadsheet.

This example shows how to update built-in metadata properties in a spreadsheet.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputXlsx)) {
>      SpreadsheetRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputXlsx);
>  }
>
> ```
> ```

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getLanguage() | Gets the document language. |
| setLanguage(String value) | Sets the document language. |
| getAuthor() | Gets the document author. |
| setAuthor(String value) | Sets the document author. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type. |
| setContentType(String value) | Sets the content type. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getTotalEditingTime() | Gets the total editing time in minutes. |
| setTotalEditingTime(Double value) | Sets the total editing time in minutes. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getLastSavedTime() | Gets the time of the last saving in UTC. |
| setLastSavedTime(Date value) | Sets the time of the last saving in UTC. |
| getLastPrintedDate() | Gets the last printed date in UTC. |
| setLastPrintedDate(Date value) | Sets the last printed date in UTC. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of application. |
| setNameOfApplication(String value) | Sets the name of application. |
| getRevision() | Gets the document revision number. |
| setRevision(String value) | Sets the document revision number. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTemplate() | Gets the document template name. |
| setTemplate(String value) | Sets the document template name. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getVersion() | Gets the version number of the application that created the document. |
| setVersion(String value) | Sets the version number of the application that created the document. |
| getContentTypeProperties() | Gets the metadata package containing the content type properties. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getLanguage()
```
public final String getLanguage()
```

Gets the document language.

**Returns:**
java.lang.String - The document language.
##### setLanguage(String value)
```
public final void setLanguage(String value)
```

Sets the document language.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document language. |

##### getAuthor()
```
public final String getAuthor()
```

Gets the document author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getCategory()
```
public final String getCategory()
```

Gets the category.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getComments()
```
public final String getComments()
```

Gets the comments.

**Returns:**
java.lang.String - Comments value.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Comments value. |

##### getCompany()
```
public final String getCompany()
```

Gets the company.

**Returns:**
java.lang.String - The company.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The company. |

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status.

**Returns:**
java.lang.String - The content status.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content status. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type.

**Returns:**
java.lang.String - The type of the content.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The created time.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The created time. |

##### getTotalEditingTime()
```
public final Double getTotalEditingTime()
```

Gets the total editing time in minutes.

**Returns:**
java.lang.Double - The total editing time.
##### setTotalEditingTime(Double value)
```
public final void setTotalEditingTime(Double value)
```

Sets the total editing time in minutes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The total editing time. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink base. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - Keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Keywords. |

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the time of the last saving in UTC.

**Returns:**
java.util.Date - The time of the last saving.
##### setLastSavedTime(Date value)
```
public final void setLastSavedTime(Date value)
```

Sets the time of the last saving in UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The time of the last saving. |

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date in UTC.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date in UTC.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The name of the last author.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the last author. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

**Returns:**
java.lang.String - The manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manager. |

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of application.

**Returns:**
java.lang.String - The name of application.
##### setNameOfApplication(String value)
```
public final void setNameOfApplication(String value)
```

Sets the name of application.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of application. |

##### getRevision()
```
public final String getRevision()
```

Gets the document revision number.

**Returns:**
java.lang.String - The revision number.
##### setRevision(String value)
```
public final void setRevision(String value)
```

Sets the document revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The revision number. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject. |

##### getTemplate()
```
public final String getTemplate()
```

Gets the document template name.

**Returns:**
java.lang.String - The template.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets the document template name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The template. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title. |

##### getVersion()
```
public final String getVersion()
```

Gets the version number of the application that created the document.

**Returns:**
java.lang.String - The version.

Its format is "00.0000",for example 12.0000
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the version number of the application that created the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The version.

Its format is "00.0000",for example 12.0000 |

##### getContentTypeProperties()
```
public final SpreadsheetContentTypePackage getContentTypeProperties()
```

Gets the metadata package containing the content type properties.

**Returns:**
SpreadsheetContentTypePackage - The metadata package containing the content type properties.
##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### SpreadsheetRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage
```
public class SpreadsheetRootPackage extends DocumentRootPackage<SpreadsheetPackage>
```

Represents the root package allowing working with metadata in a spreadsheet.

This code snippet demonstrates how to extract built-in metadata properties from a spreadsheet.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputXlsx)) {
>      SpreadsheetRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      System.out.println(root.getDocumentProperties().getLanguage());
>      System.out.println(root.getDocumentProperties().getContentType());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetType() | Gets the file type metadata package. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
##### getSpreadsheetType()
```
public final SpreadsheetTypePackage getSpreadsheetType()
```

Gets the file type metadata package.

**Returns:**
SpreadsheetTypePackage - The file type metadata package.
##### getInspectionPackage()
```
public final SpreadsheetInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
SpreadsheetInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.

### SpreadsheetSheet
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheetsheet.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class SpreadsheetSheet extends CustomPackage
```

Represents a sheet in a spreadsheet document.

[Working with metadata in Spreadsheets]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Spreadsheets
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the sheet name. |
| getNumber() | Gets the sheet number. |
##### getName()
```
public final String getName()
```

Gets the sheet name.

**Returns:**
java.lang.String - The sheet name.
##### getNumber()
```
public final int getNumber()
```

Gets the sheet number.

**Returns:**
int - The sheet number.

### SpreadsheetTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/spreadsheettypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class SpreadsheetTypePackage extends FileTypePackage
```

Represents a metadata package containing spreadsheet-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetFormat() | Gets the exact spreadsheet format. |
##### getSpreadsheetFormat()
```
public final SpreadsheetFormat getSpreadsheetFormat()
```

Gets the exact spreadsheet format.

**Returns:**
SpreadsheetFormat - The exact spreadsheet format.

### TarFile
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tarfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TarFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

#### Methods

| Method | Description |
| --- | --- |
| getSize() | Gets the size in bytes. |
| getName() | Gets the entry name. |
##### getSize()
```
public final long getSize()
```

Gets the size in bytes.

Value: The size in bytes.

**Returns:**
long
##### getName()
```
public final String getName()
```

Gets the entry name.

Value: The entry name. It can be a file or directory name.

**Returns:**
java.lang.String

### TarPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tarpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TarPackage extends CustomPackage
```

Represents ZIP archive metadata.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputTar))
>  {
>      var root = metadata.GetRootPackage<TarRootPackage>();
>      Console.WriteLine(root.TarPackage.TotalEntries);
>      foreach (var file in root.TarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.Size);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getFiles() | Gets an array of ZipFile entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getFiles()
```
public final TarFile[] getFiles()
```

Gets an array of ZipFile entries inside the ZIP archive.

Value: An array of ZipFile entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.TarFile[]
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

Value: The total number of entries inside the ZIP archive.

**Returns:**
long

### TarRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tarrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class TarRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

> ```
> The following code snippet shows how to get metadata from a ZIP archive.
>
>  Encoding encoding = Encoding.GetEncoding(866);
>  using (Metadata metadata = new Metadata(Constants.InputTar))
>  {
>      var root = metadata.GetRootPackage<TarRootPackage>();
>      Console.WriteLine(root.TarPackage.TotalEntries);
>      foreach (var file in root.TarPackage.Files)
>      {
>          Console.WriteLine(file.Name);
>          Console.WriteLine(file.CompressedSize);
>          Console.WriteLine(file.ModificationDateTime);
>          Console.WriteLine(file.UncompressedSize);
>          // Use a specific encoding for the file names
>          Console.WriteLine(encoding.GetString(file.RawName));
>      }
>  }
> ```

#### Methods

| Method | Description |
| --- | --- |
| getTarPackage() | Gets the ZIP metadata package. |
##### getTarPackage()
```
public final TarPackage getTarPackage()
```

Gets the ZIP metadata package.

Value: The ZIP metadata package.

**Returns:**
TarPackage

### TiffArrayTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffarraytag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag
```
public abstract class TiffArrayTag<T> extends TiffTag
```

Represents an array-based TIFF tag.

 T : The type of array values.
#### Methods

| Method | Description |
| --- | --- |
| getTagValue() | Gets the tag value. |
##### getTagValue()
```
public final T[] getTagValue()
```

Gets the tag value.

**Returns:**
T[] - The tag value.

### TiffAsciiTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffasciitag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag
```
public final class TiffAsciiTag extends TiffTag
```

Represents a TIFF ASCII tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffAsciiTag(TiffTagID tagID, String value) | Initializes a new instance of the  TiffAsciiTag  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTagValue() | Gets the tag value. |
##### TiffAsciiTag(TiffTagID tagID, String value)
```
public TiffAsciiTag(TiffTagID tagID, String value)
```

Initializes a new instance of the  TiffAsciiTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | java.lang.String | The value. |

##### getTagValue()
```
public final String getTagValue()
```

Gets the tag value.

**Returns:**
java.lang.String - The tag value.

### TiffByteTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffbytetag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffByteTag extends TiffArrayTag<Byte>
```

Represents a Byte tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffByteTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffByteTag  class. |
##### TiffByteTag(TiffTagID tagID, byte[] value)
```
public TiffByteTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffByteTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TiffDoubleTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffdoubletag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffDoubleTag extends TiffArrayTag<Double>
```

Represents a TIFF Double tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffDoubleTag(TiffTagID tagID, double[] value) | Initializes a new instance of the  TiffDoubleTag  class. |
##### TiffDoubleTag(TiffTagID tagID, double[] value)
```
public TiffDoubleTag(TiffTagID tagID, double[] value)
```

Initializes a new instance of the  TiffDoubleTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | double[] | The value. |

### TiffFloatTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tifffloattag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffFloatTag extends TiffArrayTag<Float>
```

Represents a TIFF float tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffFloatTag(TiffTagID tagID, float[] value) | Initializes a new instance of the  TiffFloatTag  class. |
##### TiffFloatTag(TiffTagID tagID, float[] value)
```
public TiffFloatTag(TiffTagID tagID, float[] value)
```

Initializes a new instance of the  TiffFloatTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | float[] | The value. |

### TiffLongTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tifflongtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffLongTag extends TiffArrayTag<Long>
```

Represents a TIFF Long tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffLongTag(TiffTagID tagID, long[] value) | Initializes a new instance of the  TiffLongTag  class. |
##### TiffLongTag(TiffTagID tagID, long[] value)
```
public TiffLongTag(TiffTagID tagID, long[] value)
```

Initializes a new instance of the  TiffLongTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | long[] | The value. |

### TiffRational
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffrational.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class TiffRational implements System.IEquatable<TiffRational>
```

Represents a rational number.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffRational(long numerator, long denominator) | Initializes a new instance of the  TiffRational  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets the numerator. |
| getDenominator() | Gets the denominator. |
| getValue() | Gets the rational value. |
| equals(TiffRational rational, TiffRational other) | Compares a pair of  TiffRational  numbers. |
| equals(TiffRational other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| hashCode() | Returns a hash code for this instance. |
| op_Equality(TiffRational left, TiffRational right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(TiffRational left, TiffRational right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a  string  that represents this instance. |
##### TiffRational(long numerator, long denominator)
```
public TiffRational(long numerator, long denominator)
```

Initializes a new instance of the  TiffRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | long | The numerator. |
| denominator | long | The denominator. |

##### getNumerator()
```
public final long getNumerator()
```

Gets the numerator.

**Returns:**
long - The numerator.
##### getDenominator()
```
public final long getDenominator()
```

Gets the denominator.

**Returns:**
long - The denominator.
##### getValue()
```
public final double getValue()
```

Gets the rational value.

**Returns:**
double - The rational value.
##### equals(TiffRational rational, TiffRational other)
```
public static boolean equals(TiffRational rational, TiffRational other)
```

Compares a pair of  TiffRational  numbers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffRational | A rational number. |
| other | TiffRational | Another rational number. |

**Returns:**
boolean -  true  if the objects are equal; otherwise,  false .
##### equals(TiffRational other)
```
public final boolean equals(TiffRational other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffRational | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  other  parameter; otherwise,  false .
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  obj  parameter; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### op_Equality(TiffRational left, TiffRational right)
```
public static boolean op_Equality(TiffRational left, TiffRational right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(TiffRational left, TiffRational right)
```
public static boolean op_Inequality(TiffRational left, TiffRational right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffRational | The left object. |
| right | TiffRational | The right object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  string  that represents this instance.

**Returns:**
java.lang.String - A  string  that represents this instance.

### TiffRationalTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffrationaltag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffRationalTag extends TiffArrayTag<TiffRational>
```

Represents a TIFF Rational tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffRationalTag(TiffTagID tagID, TiffRational[] value) | Initializes a new instance of the  TiffRationalTag  class. |
##### TiffRationalTag(TiffTagID tagID, TiffRational[] value)
```
public TiffRationalTag(TiffTagID tagID, TiffRational[] value)
```

Initializes a new instance of the  TiffRationalTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffRational\[\] | The value. |

### TiffRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif, com.groupdocs.metadata.core.IIptc
```
public class TiffRootPackage extends ImageRootPackage implements IXmp, IExif, IIptc
```

Represents the root package allowing working with metadata in a TIFF image.

This example shows how to extract basic IPTC metadata properties from a TIFF image.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.TiffWithIptc)) {
>      TiffRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getIptcPackage() != null) {
>          if (root.getIptcPackage().getEnvelopeRecord() != null) {
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getDateSent());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getDestination());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getFileFormat());
>              System.out.println(root.getIptcPackage().getEnvelopeRecord().getFileFormatVersion());
>              // ...
>          }
>          if (root.getIptcPackage().getApplicationRecord() != null) {
>              System.out.println(root.getIptcPackage().getApplicationRecord().getHeadline());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getByLine());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getByLineTitle());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getCaptionAbstract());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getCity());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getDateCreated());
>              System.out.println(root.getIptcPackage().getApplicationRecord().getReleaseDate());
>              // ...
>          }
>      }
>  }
>
> ```
> ```

[Working with metadata in TIFF images]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+TIFF+images
[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
| getIptcPackage() | Gets the IPTC metadata package. |
| setIptcPackage(IptcRecordSet value) | Sets the IPTC metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

##### getIptcPackage()
```
public final IptcRecordSet getIptcPackage()
```

Gets the IPTC metadata package.

**Returns:**
IptcRecordSet - The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata
##### setIptcPackage(IptcRecordSet value)
```
public final void setIptcPackage(IptcRecordSet value)
```

Sets the IPTC metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IptcRecordSet | The IPTC metadata package.

[Working with IPTC IIM metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+IPTC+IIM+metadata |

### TiffSByteTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffsbytetag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSByteTag extends TiffArrayTag<Byte>
```

Represents a TIFF SByte tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSByteTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffSByteTag  class. |
##### TiffSByteTag(TiffTagID tagID, byte[] value)
```
public TiffSByteTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffSByteTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TiffShortTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffshorttag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffShortTag extends TiffArrayTag<Integer>
```

Represents a TIFF Short tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffShortTag(TiffTagID tagID, int[] value) | Initializes a new instance of the  TiffShortTag  class. |
##### TiffShortTag(TiffTagID tagID, int[] value)
```
public TiffShortTag(TiffTagID tagID, int[] value)
```

Initializes a new instance of the  TiffShortTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | int[] | The value. |

### TiffSLongTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffslongtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSLongTag extends TiffArrayTag<Integer>
```

Represents a TIFF SLong tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSLongTag(TiffTagID tagID, int[] value) | Initializes a new instance of the  TiffSLongTag  class. |
##### TiffSLongTag(TiffTagID tagID, int[] value)
```
public TiffSLongTag(TiffTagID tagID, int[] value)
```

Initializes a new instance of the  TiffSLongTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | int[] | The value. |

### TiffSRational
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffsrational.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class TiffSRational implements System.IEquatable<TiffSRational>
```

Represents signed rational number.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSRational(int numerator, int denominator) | Initializes a new instance of the  TiffSRational  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets numerator. |
| getDenominator() | Gets denominator. |
| getValue() | Gets actual value represented as double. |
| equals(TiffSRational rational, TiffSRational other) | Compares pair of  TiffSRational . |
| equals(TiffSRational other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| hashCode() | Returns a hash code for this instance. |
| op_Equality(TiffSRational left, TiffSRational right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(TiffSRational left, TiffSRational right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a  System.String  that represents this instance. |
##### TiffSRational(int numerator, int denominator)
```
public TiffSRational(int numerator, int denominator)
```

Initializes a new instance of the  TiffSRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

##### getNumerator()
```
public final int getNumerator()
```

Gets numerator.

**Returns:**
int - The numerator.
##### getDenominator()
```
public final int getDenominator()
```

Gets denominator.

**Returns:**
int - The denominator.
##### getValue()
```
public final double getValue()
```

Gets actual value represented as double.

**Returns:**
double - Double value.
##### equals(TiffSRational rational, TiffSRational other)
```
public static boolean equals(TiffSRational rational, TiffSRational other)
```

Compares pair of  TiffSRational .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rational | TiffSRational | Comparing item. |
| other | TiffSRational | Other item. |

**Returns:**
boolean -  true  if objects are equal; otherwise  false .
##### equals(TiffSRational other)
```
public final boolean equals(TiffSRational other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | TiffSRational | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  other  parameter; otherwise,  false .
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean -  true  if the current object is equal to the  obj  parameter; otherwise,  false .
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### op_Equality(TiffSRational left, TiffSRational right)
```
public static boolean op_Equality(TiffSRational left, TiffSRational right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(TiffSRational left, TiffSRational right)
```
public static boolean op_Inequality(TiffSRational left, TiffSRational right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | TiffSRational | The left object. |
| right | TiffSRational | The rigt object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  System.String  that represents this instance.

**Returns:**
java.lang.String - A  System.String  that represents this instance.

### TiffSRationalTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffsrationaltag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSRationalTag extends TiffArrayTag<TiffSRational>
```

Represents a TIFF SRational tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSRationalTag(TiffTagID tagID, TiffSRational[] value) | Initializes a new instance of the  TiffSRationalTag  class. |
##### TiffSRationalTag(TiffTagID tagID, TiffSRational[] value)
```
public TiffSRationalTag(TiffTagID tagID, TiffSRational[] value)
```

Initializes a new instance of the  TiffSRationalTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | TiffSRational\[\] | The value. |

### TiffSShortTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffsshorttag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffSShortTag extends TiffArrayTag<Short>
```

Represents a TIFF SShort tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSShortTag(TiffTagID tagID, short[] value) | Initializes a new instance of the  TiffSShortTag  class. |
##### TiffSShortTag(TiffTagID tagID, short[] value)
```
public TiffSShortTag(TiffTagID tagID, short[] value)
```

Initializes a new instance of the  TiffSShortTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | short[] | The value. |

### TiffTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tifftag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty
```
public abstract class TiffTag extends MetadataProperty
```

Represents a TIFF tag.
#### Methods

| Method | Description |
| --- | --- |
| getTagType() | Gets the type of the tag. |
| getTagID() | Gets the tag id. |
##### getTagType()
```
public final TiffTagType getTagType()
```

Gets the type of the tag.

**Returns:**
TiffTagType - The tag type.
##### getTagID()
```
public final TiffTagID getTagID()
```

Gets the tag id.

**Returns:**
TiffTagID - The tag id.

### TiffTagID
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tifftagid.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public final class TiffTagID implements IEnumValue
```

Defines ids of TIFF tags.
#### Fields

| Field | Description |
| --- | --- |
| GpsVersionID | Indicates the version of GPSInfoIFD. |
| GpsLatitudeRef | Indicates whether the latitude is north or south latitude. |
| GpsLatitude | Indicates the latitude. |
| GpsLongitudeRef | Indicates whether the longitude is east or west longitude. |
| GpsLongitude | Indicates the longitude. |
| GpsAltitudeRef | Indicates the altitude used as the reference altitude. |
| GpsAltitude | Indicates the altitude based on the reference in GPSAltitudeRef. |
| GpsTimeStamp | Indicates the time as UTC (Coordinated Universal Time). |
| GpsSatellites | ndicates the GPS satellites used for measurements. |
| GpsStatus | Indicates the status of the GPS receiver when the image is recorded. |
| GpsMeasureMode | Indicates the GPS measurement mode. |
| GpsDop | Indicates the GPS DOP (data degree of precision). |
| GpsSpeedRef | Indicates the unit used to express the GPS receiver speed of movement |
| GpsSpeed | Indicates the speed of GPS receiver movement. |
| GpsTrackRef | Indicates the reference for giving the direction of GPS receiver movement. |
| GpsTrack | Indicates the direction of GPS receiver movement. |
| GpsImgDirectionRef | Indicates the reference for giving the direction of the image when it is captured. |
| GpsImgDirection | Indicates the direction of the image when it was captured. |
| GpsMapDatum | Indicates the geodetic survey data used by the GPS receiver. |
| GpsDestLatitudeRef | Indicates whether the latitude of the destination point is north or south latitude. |
| GpsDestLatitude | Indicates the latitude of the destination point. |
| GpsDestLongitudeRef | Indicates whether the longitude of the destination point is east or west longitude. |
| GpsDestLongitude | Indicates the longitude of the destination point. |
| GpsDestBearingRef | Indicates the reference used for giving the bearing to the destination point. |
| GpsDestBearing | Indicates the bearing to the destination point. |
| GpsDestDistanceRef | Indicates the unit used to express the distance to the destination point. |
| GpsDestDistance | Indicates the distance to the destination point. |
| GpsProcessingMethod | A character string recording the name of the method used for location finding. |
| GpsAreaInformation | A character string recording the name of the GPS area. |
| GpsDateStamp | A character string recording date and time information relative to UTC (Coordinated Universal Time). |
| GpsDifferential | Indicates whether differential correction is applied to the GPS receiver. |
| GpsHPositioningError | This tag indicates horizontal positioning errors in meters. |
| NewSubfileType | A general indication of the kind of data contained in this sub-file. |
| SubfileType | A general indication of the kind of data contained in this subfile. |
| ImageWidth | The number of columns in the image, i.e., the number of pixels per scan line. |
| ImageLength | The number of rows (sometimes described as scan lines) in the image. |
| BitsPerSample | Number of bits per component. |
| Compression | Compression scheme used on the image data. |
| PhotometricInterpretation | The color space of the image data. |
| Threshholding | For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels. |
| CellWidth | The width of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| CellLength | The length of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file. |
| FillOrder | The logical order of bits within a byte. |
| DocumentName | The name of the document from which this image was scanned. |
| ImageDescription | A string that describes the subject of the image. |
| Make | The scanner manufacturer. |
| Model | The scanner model name or number. |
| StripOffsets | For each strip, the byte offset of that strip. |
| Orientation | The orientation of the image with respect to the rows and columns. |
| SamplesPerPixel | The number of components per pixel. |
| RowsPerStrip | The number of rows per strip. |
| StripByteCounts | For each strip, the number of bytes in the strip after compression. |
| MinSampleValue | The minimum component value used. |
| MaxSampleValue | The maximum component value used. |
| XResolution | The number of pixels per ResolutionUnit in the ImageWidth direction. |
| YResolution | The number of pixels per ResolutionUnit in the ImageLength direction. |
| PlanarConfiguration | How the components of each pixel are stored. |
| PageName | The name of the page from which this image was scanned. |
| XPosition | X position of the image. |
| YPosition | Y position of the image. |
| FreeOffsets | For each string of contiguous unused bytes in a TIFF file, the byte offset of the string. |
| FreeByteCounts | For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string. |
| GrayResponseUnit | The precision of the information contained in the GrayResponseCurve. |
| GrayResponseCurve | For grayscale data, the optical density of each possible pixel value. |
| T4Options | T4-encoding options. |
| T6Options | T6-encoding options. |
| ResolutionUnit | The unit of measurement for XResolution and YResolution. |
| PageNumber | The page number of the page from which this image was scanned. |
| TransferFunction | Describes a transfer function for the image in tabular style. |
| Software | Name and version number of the software package(s) used to create the image. |
| DateTime | Date and time of image creation. |
| Artist | Person who created the image. |
| HostComputer | The computer and/or operating system in use at the time of image creation. |
| Predictor | This section defines a Predictor that greatly improves compression ratios for some images. |
| WhitePoint | The chromaticity of the white point of the image. |
| PrimaryChromaticities | The chromaticities of the primaries of the image. |
| ColorMap | A color map for palette color images. |
| HalftoneHints | The purpose of the HalftoneHints field is to convey to the halftone function the range of gray levels within a colorimetrically-specified image that should retain tonal detail. |
| TileWidth | The tile width in pixels. |
| TileLength | The tile length (height) in pixels. |
| TileOffsets | For each tile, the byte offset of that tile, as compressed and stored on disk. |
| TileByteCounts | For each tile, the number of (compressed) bytes in that tile. |
| InkSet | The set of inks used in a separated (PhotometricInterpretation=5) image. |
| InkNames | The name of each ink used in a separated (PhotometricInterpretation=5) image, written as a list of concatenated, NUL-terminated ASCII strings. |
| NumberOfInks | The number of inks. |
| DotRange | The component values that correspond to a 0% dot and 100% dot. |
| ExtraSamples | Description of extra components. |
| SampleFormat | This field specifies how to interpret each data sample in a pixel. |
| SMinSampleValue | This field specifies the minimum sample value. |
| SMaxSampleValue | This new field specifies the maximum sample value. |
| TransferRange | Expands the range of the TransferFunction. |
| JpegProc | This Field indicates the JPEG process used to produce the compressed data. |
| JpegInterchangeFormat | This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file. |
| JpegInterchangeFormatLength | This Field indicates the length in bytes of the JPEG interchange format bitstream |
| JpegRestartInterval | This Field indicates the length of the restart interval used in the compressed image data. |
| JpegLosslessPredictors | This Field points to a list of lossless predictor-selection values, one per component. |
| JpegPointTransforms | This Field points to a list of point transform values, one per component. |
| JpegQTables | This Field points to a list of offsets to the quantization tables, one per component. |
| JpegDCTables | This Field points to a list of offsets to the DC Huffman tables or the lossless Huffman tables, one per component. |
| JpegACTables | This Field points to a list of offsets to the Huffman AC tables, one per component. |
| YCbCrCoefficients | The matrix cofficients for transformation from RGB to YCbCr image data. |
| YCbCrSubSampling | The sampling ratio of chrominance components in relation to the luminance component. |
| YCbCrPositioning | Specifies the positioning of subsampled chrominance components relative to luminance samples. |
| ReferenceBlackWhite | Specifies a pair of headroom and footroom image data values (codes) for each pixel component. |
| Copyright | Copyright notice. |
| UserComment | Keywords or comments on the image; complements ImageDescription. |
| Xmp | Pointer to the XMP metadata. |
| ImageID | OPI-related. |
| Iptc | IPTC (International Press Telecommunications Council) metadata. |
| Photoshop | Collection of Photoshop 'Image Resource Blocks'. |
| ImageLayer | Image layer. |
| IccProfile | Color profile data. |
| ExifIfd | Pointer to collection of all EXIF Metadata. |
| GpsIfd | Pointer to GPS data. |
| Makernotes | Pointer to makernotes data. |
| InteroperabilityIfd | Exif-related Interoperability IFD. |
| CameraOwnerName | Camera owner name as ASCII string. |
| BodySerialNumber | Camera body serial number as ASCII string. |
| CfaPattern | ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| ExifVersion | The version of the EXIF standard supported. |
| ComponentsConfiguration | Information specific to the compressed data. |
| FlashpixVersion | The Flashpix format version supported by a FPXR file. |
| ColorSpace | The color space information tag (ColorSpace) is always recorded as the color space specifier. |
| PixelXDimension | Information specific to compressed data. |
| PixelYDimension | Information specific to compressed data. |
| SceneCaptureType | This tag indicates the type of scene that was shot. |
| Gamma | Indicates the value of coefficient gamma. |
| CompressedBitsPerPixel | Information specific to compressed data. |
| RelatedSoundFile | This tag is used to record the name of an audio file related to the image data. |
| DateTimeOriginal | The date and time when the original image data was generated. |
| DateTimeDigitized | The date and time when the image was stored as digital data. |
| OffsetTime | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag. |
| OffsetTimeOriginal | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag. |
| OffsetTimeDigitized | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag. |
| SubsecTime | A tag used to record fractions of seconds for the DateTime tag. |
| SubsecTimeOriginal | A tag used to record fractions of seconds for the DateTimeOriginal tag. |
| SubsecTimeDigitized | A tag used to record fractions of seconds for the DateTimeDigitized tag. |
| ExposureTime | Exposure time, given in seconds (sec). |
| FNumber | The F number. |
| ExposureProgram | The class of the program used by the camera to set exposure when the picture is taken. |
| SpectralSensitivity | Indicates the spectral sensitivity of each channel of the camera used. |
| PhotographicSensitivity | This tag indicates the sensitivity of the camera or input device when the image was shot. |
| Oecf | Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524. |
| SensitivityType | The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag. |
| StandardOutputSensitivity | This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232. |
| RecommendedExposureIndex | This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232. |
| IsoSpeed | This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. |
| ISOSpeedLatitudeYyy | This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232. |
| ISOSpeedLatitudeZzz | This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232. |
| ShutterSpeedValue | Shutter speed. |
| ApertureValue | The lens aperture. |
| BrightnessValue | The value of brightness. |
| ExposureBiasValue | The exposure bias. |
| MaxApertureValue | The smallest F number of the lens. |
| SubjectDistance | The distance to the subject, given in meters. |
| MeteringMode | The metering mode. |
| LightSource | The kind of light source. |
| Flash | This tag indicates the status of flash when the image was shot. |
| SubjectArea | This tag indicates the location and area of the main subject in the overall scene. |
| FocalLength | The actual focal length of the lens, in mm. |
| FlashEnergy | Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS). |
| SpatialFrequencyResponse | This tag records the camera or input device spatial frequency table and SFR values in the direction of image width, image height, and diagonal direction, as specified in ISO 12233. |
| FocalPlaneXResolution | Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneYResolution | Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FocalPlaneResolutionUnit | Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. |
| SubjectLocation | Indicates the location of the main subject in the scene. |
| ExposureIndex | Indicates the exposure index selected on the camera or input device at the time the image is captured. |
| SensingMethod | Indicates the image sensor type on the camera or input device. |
| FileSource | Indicates the image source. |
| SceneType | Indicates the type of scene. |
| CustomRendered | This tag indicates the use of special processing on image data, such as rendering geared to output. |
| ExposureMode | This tag indicates the exposure mode set when the image was shot. |
| WhiteBalance | This tag indicates the white balance mode set when the image was shot. |
| DigitalZoomRatio | This tag indicates the digital zoom ratio when the image was shot. |
| FocalLengthIn35mmFilm | This tag indicates the equivalent focal length assuming a 35mm film camera, in mm. |
| GainControl | This tag indicates the degree of overall image gain adjustment. |
| Contrast | This tag indicates the direction of contrast processing applied by the camera when the image was shot. |
| Saturation | This tag indicates the direction of saturation processing applied by the camera when the image was shot. |
| Sharpness | This tag indicates the direction of sharpness processing applied by the camera when the image was shot. |
| DeviceSettingDescription | This tag indicates information on the picture-taking conditions of a particular camera model. |
| SubjectDistanceRange | This tag indicates the distance to the subject. |
| CompositeImage | This tag indicates whether the recorded image is a composite image\* or not. |
| SourceImageNumberOfCompositeImage | This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image. |
| SourceExposureTimesOfCompositeImage | For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image, such as respective exposure times of captured source images (tentatively recorded images). |
| Temperature | Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. |
| Humidity | Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. |
| Pressure | Pressure as the ambient situation at the shot, for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea. |
| WaterDepth | Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. |
| Acceleration | Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot. |
| CameraElevationAngle | Elevation/depression. |
| ImageUniqueID | This tag indicates an identifier assigned uniquely to each image. |
| LensSpecification | This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length, and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography. |
| LensMake | This tag records the lens manufacturer as an ASCII string. |
| LensModel | This tag records the lens\\u2019s model name and model number as an ASCII string. |
| LensSerialNumber | This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string. |
#### Methods

| Method | Description |
| --- | --- |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| values() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
| name() |  |
| equals(Object o) |  |
| hashCode() |  |
##### GpsVersionID
```
public static final TiffTagID GpsVersionID
```

Indicates the version of GPSInfoIFD.

##### GpsLatitudeRef
```
public static final TiffTagID GpsLatitudeRef
```

Indicates whether the latitude is north or south latitude.

##### GpsLatitude
```
public static final TiffTagID GpsLatitude
```

Indicates the latitude.

##### GpsLongitudeRef
```
public static final TiffTagID GpsLongitudeRef
```

Indicates whether the longitude is east or west longitude.

##### GpsLongitude
```
public static final TiffTagID GpsLongitude
```

Indicates the longitude.

##### GpsAltitudeRef
```
public static final TiffTagID GpsAltitudeRef
```

Indicates the altitude used as the reference altitude.

##### GpsAltitude
```
public static final TiffTagID GpsAltitude
```

Indicates the altitude based on the reference in GPSAltitudeRef.

##### GpsTimeStamp
```
public static final TiffTagID GpsTimeStamp
```

Indicates the time as UTC (Coordinated Universal Time).

##### GpsSatellites
```
public static final TiffTagID GpsSatellites
```

ndicates the GPS satellites used for measurements.

##### GpsStatus
```
public static final TiffTagID GpsStatus
```

Indicates the status of the GPS receiver when the image is recorded.

##### GpsMeasureMode
```
public static final TiffTagID GpsMeasureMode
```

Indicates the GPS measurement mode.

##### GpsDop
```
public static final TiffTagID GpsDop
```

Indicates the GPS DOP (data degree of precision).

##### GpsSpeedRef
```
public static final TiffTagID GpsSpeedRef
```

Indicates the unit used to express the GPS receiver speed of movement

##### GpsSpeed
```
public static final TiffTagID GpsSpeed
```

Indicates the speed of GPS receiver movement.

##### GpsTrackRef
```
public static final TiffTagID GpsTrackRef
```

Indicates the reference for giving the direction of GPS receiver movement.

##### GpsTrack
```
public static final TiffTagID GpsTrack
```

Indicates the direction of GPS receiver movement.

##### GpsImgDirectionRef
```
public static final TiffTagID GpsImgDirectionRef
```

Indicates the reference for giving the direction of the image when it is captured.

##### GpsImgDirection
```
public static final TiffTagID GpsImgDirection
```

Indicates the direction of the image when it was captured.

##### GpsMapDatum
```
public static final TiffTagID GpsMapDatum
```

Indicates the geodetic survey data used by the GPS receiver.

##### GpsDestLatitudeRef
```
public static final TiffTagID GpsDestLatitudeRef
```

Indicates whether the latitude of the destination point is north or south latitude.

##### GpsDestLatitude
```
public static final TiffTagID GpsDestLatitude
```

Indicates the latitude of the destination point.

##### GpsDestLongitudeRef
```
public static final TiffTagID GpsDestLongitudeRef
```

Indicates whether the longitude of the destination point is east or west longitude.

##### GpsDestLongitude
```
public static final TiffTagID GpsDestLongitude
```

Indicates the longitude of the destination point.

##### GpsDestBearingRef
```
public static final TiffTagID GpsDestBearingRef
```

Indicates the reference used for giving the bearing to the destination point.

##### GpsDestBearing
```
public static final TiffTagID GpsDestBearing
```

Indicates the bearing to the destination point.

##### GpsDestDistanceRef
```
public static final TiffTagID GpsDestDistanceRef
```

Indicates the unit used to express the distance to the destination point.

##### GpsDestDistance
```
public static final TiffTagID GpsDestDistance
```

Indicates the distance to the destination point.

##### GpsProcessingMethod
```
public static final TiffTagID GpsProcessingMethod
```

A character string recording the name of the method used for location finding.

##### GpsAreaInformation
```
public static final TiffTagID GpsAreaInformation
```

A character string recording the name of the GPS area.

##### GpsDateStamp
```
public static final TiffTagID GpsDateStamp
```

A character string recording date and time information relative to UTC (Coordinated Universal Time).

##### GpsDifferential
```
public static final TiffTagID GpsDifferential
```

Indicates whether differential correction is applied to the GPS receiver.

##### GpsHPositioningError
```
public static final TiffTagID GpsHPositioningError
```

This tag indicates horizontal positioning errors in meters.

##### NewSubfileType
```
public static final TiffTagID NewSubfileType
```

A general indication of the kind of data contained in this sub-file.

##### SubfileType
```
public static final TiffTagID SubfileType
```

A general indication of the kind of data contained in this subfile. This field is deprecated. The NewSubfileType field should be used instead

##### ImageWidth
```
public static final TiffTagID ImageWidth
```

The number of columns in the image, i.e., the number of pixels per scan line.

##### ImageLength
```
public static final TiffTagID ImageLength
```

The number of rows (sometimes described as scan lines) in the image.

##### BitsPerSample
```
public static final TiffTagID BitsPerSample
```

Number of bits per component.

##### Compression
```
public static final TiffTagID Compression
```

Compression scheme used on the image data.

##### PhotometricInterpretation
```
public static final TiffTagID PhotometricInterpretation
```

The color space of the image data.

##### Threshholding
```
public static final TiffTagID Threshholding
```

For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels.

##### CellWidth
```
public static final TiffTagID CellWidth
```

The width of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file.

##### CellLength
```
public static final TiffTagID CellLength
```

The length of the dithering or halftoning matrix used to create a dithered or halftoned bi-level file.

##### FillOrder
```
public static final TiffTagID FillOrder
```

The logical order of bits within a byte.

##### DocumentName
```
public static final TiffTagID DocumentName
```

The name of the document from which this image was scanned.

##### ImageDescription
```
public static final TiffTagID ImageDescription
```

A string that describes the subject of the image.

##### Make
```
public static final TiffTagID Make
```

The scanner manufacturer.

##### Model
```
public static final TiffTagID Model
```

The scanner model name or number.

##### StripOffsets
```
public static final TiffTagID StripOffsets
```

For each strip, the byte offset of that strip.

##### Orientation
```
public static final TiffTagID Orientation
```

The orientation of the image with respect to the rows and columns.

##### SamplesPerPixel
```
public static final TiffTagID SamplesPerPixel
```

The number of components per pixel.

##### RowsPerStrip
```
public static final TiffTagID RowsPerStrip
```

The number of rows per strip.

##### StripByteCounts
```
public static final TiffTagID StripByteCounts
```

For each strip, the number of bytes in the strip after compression.

##### MinSampleValue
```
public static final TiffTagID MinSampleValue
```

The minimum component value used.

##### MaxSampleValue
```
public static final TiffTagID MaxSampleValue
```

The maximum component value used.

##### XResolution
```
public static final TiffTagID XResolution
```

The number of pixels per ResolutionUnit in the ImageWidth direction.

##### YResolution
```
public static final TiffTagID YResolution
```

The number of pixels per ResolutionUnit in the ImageLength direction.

##### PlanarConfiguration
```
public static final TiffTagID PlanarConfiguration
```

How the components of each pixel are stored.

##### PageName
```
public static final TiffTagID PageName
```

The name of the page from which this image was scanned.

##### XPosition
```
public static final TiffTagID XPosition
```

X position of the image.

##### YPosition
```
public static final TiffTagID YPosition
```

Y position of the image.

##### FreeOffsets
```
public static final TiffTagID FreeOffsets
```

For each string of contiguous unused bytes in a TIFF file, the byte offset of the string.

##### FreeByteCounts
```
public static final TiffTagID FreeByteCounts
```

For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string.

##### GrayResponseUnit
```
public static final TiffTagID GrayResponseUnit
```

The precision of the information contained in the GrayResponseCurve.

##### GrayResponseCurve
```
public static final TiffTagID GrayResponseCurve
```

For grayscale data, the optical density of each possible pixel value.

##### T4Options
```
public static final TiffTagID T4Options
```

T4-encoding options.

##### T6Options
```
public static final TiffTagID T6Options
```

T6-encoding options.

##### ResolutionUnit
```
public static final TiffTagID ResolutionUnit
```

The unit of measurement for XResolution and YResolution.

##### PageNumber
```
public static final TiffTagID PageNumber
```

The page number of the page from which this image was scanned.

##### TransferFunction
```
public static final TiffTagID TransferFunction
```

Describes a transfer function for the image in tabular style. Pixel components can be gamma-compensated, companded, non-uniformly quantized, or coded in some other way. The TransferFunction maps the pixel components from a non-linear BitsPerSample (e.g. 8-bit) form into a 16-bit linear form without a perceptible loss of accuracy.

##### Software
```
public static final TiffTagID Software
```

Name and version number of the software package(s) used to create the image.

##### DateTime
```
public static final TiffTagID DateTime
```

Date and time of image creation.

##### Artist
```
public static final TiffTagID Artist
```

Person who created the image.

##### HostComputer
```
public static final TiffTagID HostComputer
```

The computer and/or operating system in use at the time of image creation.

##### Predictor
```
public static final TiffTagID Predictor
```

This section defines a Predictor that greatly improves compression ratios for some images.

##### WhitePoint
```
public static final TiffTagID WhitePoint
```

The chromaticity of the white point of the image.

##### PrimaryChromaticities
```
public static final TiffTagID PrimaryChromaticities
```

The chromaticities of the primaries of the image.

##### ColorMap
```
public static final TiffTagID ColorMap
```

A color map for palette color images.

##### HalftoneHints
```
public static final TiffTagID HalftoneHints
```

The purpose of the HalftoneHints field is to convey to the halftone function the range of gray levels within a colorimetrically-specified image that should retain tonal detail.

##### TileWidth
```
public static final TiffTagID TileWidth
```

The tile width in pixels. This is the number of columns in each tile.

##### TileLength
```
public static final TiffTagID TileLength
```

The tile length (height) in pixels. This is the number of rows in each tile.

##### TileOffsets
```
public static final TiffTagID TileOffsets
```

For each tile, the byte offset of that tile, as compressed and stored on disk. The offset is specified with respect to the beginning of the TIFF file. Note that this implies that each tile has a location independent of the locations of other tiles.

##### TileByteCounts
```
public static final TiffTagID TileByteCounts
```

For each tile, the number of (compressed) bytes in that tile.

##### InkSet
```
public static final TiffTagID InkSet
```

The set of inks used in a separated (PhotometricInterpretation=5) image.

##### InkNames
```
public static final TiffTagID InkNames
```

The name of each ink used in a separated (PhotometricInterpretation=5) image, written as a list of concatenated, NUL-terminated ASCII strings.

##### NumberOfInks
```
public static final TiffTagID NumberOfInks
```

The number of inks. Usually equal to SamplesPerPixel, unless there are extra samples.

##### DotRange
```
public static final TiffTagID DotRange
```

The component values that correspond to a 0% dot and 100% dot. DotRange[0] corresponds to a 0% dot, and DotRange[1] corresponds to a 100% dot.

##### ExtraSamples
```
public static final TiffTagID ExtraSamples
```

Description of extra components.

##### SampleFormat
```
public static final TiffTagID SampleFormat
```

This field specifies how to interpret each data sample in a pixel.

##### SMinSampleValue
```
public static final TiffTagID SMinSampleValue
```

This field specifies the minimum sample value.

##### SMaxSampleValue
```
public static final TiffTagID SMaxSampleValue
```

This new field specifies the maximum sample value.

##### TransferRange
```
public static final TiffTagID TransferRange
```

Expands the range of the TransferFunction.

##### JpegProc
```
public static final TiffTagID JpegProc
```

This Field indicates the JPEG process used to produce the compressed data.

##### JpegInterchangeFormat
```
public static final TiffTagID JpegInterchangeFormat
```

This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file.

##### JpegInterchangeFormatLength
```
public static final TiffTagID JpegInterchangeFormatLength
```

This Field indicates the length in bytes of the JPEG interchange format bitstream

##### JpegRestartInterval
```
public static final TiffTagID JpegRestartInterval
```

This Field indicates the length of the restart interval used in the compressed image data.

##### JpegLosslessPredictors
```
public static final TiffTagID JpegLosslessPredictors
```

This Field points to a list of lossless predictor-selection values, one per component.

##### JpegPointTransforms
```
public static final TiffTagID JpegPointTransforms
```

This Field points to a list of point transform values, one per component.

##### JpegQTables
```
public static final TiffTagID JpegQTables
```

This Field points to a list of offsets to the quantization tables, one per component.

##### JpegDCTables
```
public static final TiffTagID JpegDCTables
```

This Field points to a list of offsets to the DC Huffman tables or the lossless Huffman tables, one per component.

##### JpegACTables
```
public static final TiffTagID JpegACTables
```

This Field points to a list of offsets to the Huffman AC tables, one per component.

##### YCbCrCoefficients
```
public static final TiffTagID YCbCrCoefficients
```

The matrix cofficients for transformation from RGB to YCbCr image data.

##### YCbCrSubSampling
```
public static final TiffTagID YCbCrSubSampling
```

The sampling ratio of chrominance components in relation to the luminance component.

##### YCbCrPositioning
```
public static final TiffTagID YCbCrPositioning
```

Specifies the positioning of subsampled chrominance components relative to luminance samples.

##### ReferenceBlackWhite
```
public static final TiffTagID ReferenceBlackWhite
```

Specifies a pair of headroom and footroom image data values (codes) for each pixel component.

##### Copyright
```
public static final TiffTagID Copyright
```

Copyright notice.

##### UserComment
```
public static final TiffTagID UserComment
```

Keywords or comments on the image; complements ImageDescription.

##### Xmp
```
public static final TiffTagID Xmp
```

Pointer to the XMP metadata.

##### ImageID
```
public static final TiffTagID ImageID
```

OPI-related.

##### Iptc
```
public static final TiffTagID Iptc
```

IPTC (International Press Telecommunications Council) metadata. Often times, the data type is incorrectly specified as LONG.

##### Photoshop
```
public static final TiffTagID Photoshop
```

Collection of Photoshop 'Image Resource Blocks'.

##### ImageLayer
```
public static final TiffTagID ImageLayer
```

Image layer.

##### IccProfile
```
public static final TiffTagID IccProfile
```

Color profile data.

##### ExifIfd
```
public static final TiffTagID ExifIfd
```

Pointer to collection of all EXIF Metadata. EXIF uses field names rather than tags to indicate the field content.

##### GpsIfd
```
public static final TiffTagID GpsIfd
```

Pointer to GPS data.

##### Makernotes
```
public static final TiffTagID Makernotes
```

Pointer to makernotes data.

##### InteroperabilityIfd
```
public static final TiffTagID InteroperabilityIfd
```

Exif-related Interoperability IFD.

##### CameraOwnerName
```
public static final TiffTagID CameraOwnerName
```

Camera owner name as ASCII string.

##### BodySerialNumber
```
public static final TiffTagID BodySerialNumber
```

Camera body serial number as ASCII string.

##### CfaPattern
```
public static final TiffTagID CfaPattern
```

ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. It does not apply to all sensing methods.

##### ExifVersion
```
public static final TiffTagID ExifVersion
```

The version of the EXIF standard supported.

##### ComponentsConfiguration
```
public static final TiffTagID ComponentsConfiguration
```

Information specific to the compressed data. The channels of each component are arranged in order from the 1st component to the 4th.

##### FlashpixVersion
```
public static final TiffTagID FlashpixVersion
```

The Flashpix format version supported by a FPXR file. If the FPXR function supports Flashpix format Ver. 1.0, this is indicated similarly to ExifVersion by recording "0100" as 4-byte ASCII.

##### ColorSpace
```
public static final TiffTagID ColorSpace
```

The color space information tag (ColorSpace) is always recorded as the color space specifier. Normally sRGB (=1) is used to define the color space based on the PC monitor conditions and environment. If a color space other than sRGB is used, Uncalibrated (=FFFF.H) is set.

##### PixelXDimension
```
public static final TiffTagID PixelXDimension
```

Information specific to compressed data. When a compressed file is recorded, the valid width of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker.

##### PixelYDimension
```
public static final TiffTagID PixelYDimension
```

Information specific to compressed data. When a compressed file is recorded, the valid height of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker.

##### SceneCaptureType
```
public static final TiffTagID SceneCaptureType
```

This tag indicates the type of scene that was shot. It may also be used to record the mode in which the image was shot.

##### Gamma
```
public static final TiffTagID Gamma
```

Indicates the value of coefficient gamma.

##### CompressedBitsPerPixel
```
public static final TiffTagID CompressedBitsPerPixel
```

Information specific to compressed data. The compression mode used for a compressed image is indicated in unit bits per pixel.

##### RelatedSoundFile
```
public static final TiffTagID RelatedSoundFile
```

This tag is used to record the name of an audio file related to the image data. The only relational information recorded here is the Exif audio file name and extension (an ASCII string consisting of 8 characters + '.' + 3 characters).

##### DateTimeOriginal
```
public static final TiffTagID DateTimeOriginal
```

The date and time when the original image data was generated. For a DSC the date and time the picture was taken are recorded. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character.

##### DateTimeDigitized
```
public static final TiffTagID DateTimeDigitized
```

The date and time when the image was stored as digital data. If, for example, an image was captured by DSC and at the same time the file was recorded, then the DateTimeOriginal and DateTimeDigitized will have the same contents. The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character.

##### OffsetTime
```
public static final TiffTagID OffsetTime
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### OffsetTimeOriginal
```
public static final TiffTagID OffsetTimeOriginal
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### OffsetTimeDigitized
```
public static final TiffTagID OffsetTimeDigitized
```

A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag. The format when recording the offset is "±HH:MM". The part of "±" shall be recorded as "+" or "-".

##### SubsecTime
```
public static final TiffTagID SubsecTime
```

A tag used to record fractions of seconds for the DateTime tag.

##### SubsecTimeOriginal
```
public static final TiffTagID SubsecTimeOriginal
```

A tag used to record fractions of seconds for the DateTimeOriginal tag.

##### SubsecTimeDigitized
```
public static final TiffTagID SubsecTimeDigitized
```

A tag used to record fractions of seconds for the DateTimeDigitized tag.

##### ExposureTime
```
public static final TiffTagID ExposureTime
```

Exposure time, given in seconds (sec).

##### FNumber
```
public static final TiffTagID FNumber
```

The F number.

##### ExposureProgram
```
public static final TiffTagID ExposureProgram
```

The class of the program used by the camera to set exposure when the picture is taken.

##### SpectralSensitivity
```
public static final TiffTagID SpectralSensitivity
```

Indicates the spectral sensitivity of each channel of the camera used. The tag value is an ASCII string compatible with the standard developed by the ASTM Technical committee.

##### PhotographicSensitivity
```
public static final TiffTagID PhotographicSensitivity
```

This tag indicates the sensitivity of the camera or input device when the image was shot.

##### Oecf
```
public static final TiffTagID Oecf
```

Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524. OECF is the relationship between the camera optical input and the image values.

##### SensitivityType
```
public static final TiffTagID SensitivityType
```

The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag. Although it is an optional tag, it should be recorded when a PhotographicSensitivity tag is recorded.

##### StandardOutputSensitivity
```
public static final TiffTagID StandardOutputSensitivity
```

This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### RecommendedExposureIndex
```
public static final TiffTagID RecommendedExposureIndex
```

This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### IsoSpeed
```
public static final TiffTagID IsoSpeed
```

This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.

##### ISOSpeedLatitudeYyy
```
public static final TiffTagID ISOSpeedLatitudeYyy
```

This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232.

##### ISOSpeedLatitudeZzz
```
public static final TiffTagID ISOSpeedLatitudeZzz
```

This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232.

##### ShutterSpeedValue
```
public static final TiffTagID ShutterSpeedValue
```

Shutter speed. The unit is the APEX (Additive System of Photographic Exposure) setting.

##### ApertureValue
```
public static final TiffTagID ApertureValue
```

The lens aperture. The unit is the APEX value.

##### BrightnessValue
```
public static final TiffTagID BrightnessValue
```

The value of brightness. The unit is the APEX value.

##### ExposureBiasValue
```
public static final TiffTagID ExposureBiasValue
```

The exposure bias. The unit is the APEX value.

##### MaxApertureValue
```
public static final TiffTagID MaxApertureValue
```

The smallest F number of the lens. The unit is the APEX value.

##### SubjectDistance
```
public static final TiffTagID SubjectDistance
```

The distance to the subject, given in meters.

##### MeteringMode
```
public static final TiffTagID MeteringMode
```

The metering mode.

##### LightSource
```
public static final TiffTagID LightSource
```

The kind of light source.

##### Flash
```
public static final TiffTagID Flash
```

This tag indicates the status of flash when the image was shot. Bit 0 indicates the flash firing status, bits 1 and 2 indicate the flash return status, bits 3 and 4 indicate the flash mode, bit 5 indicates whether the flash function is present, and bit 6 indicates "red eye" mode.

##### SubjectArea
```
public static final TiffTagID SubjectArea
```

This tag indicates the location and area of the main subject in the overall scene.

##### FocalLength
```
public static final TiffTagID FocalLength
```

The actual focal length of the lens, in mm. Conversion is not made to the focal length of a 35 mm film camera.

##### FlashEnergy
```
public static final TiffTagID FlashEnergy
```

Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS).

##### SpatialFrequencyResponse
```
public static final TiffTagID SpatialFrequencyResponse
```

This tag records the camera or input device spatial frequency table and SFR values in the direction of image width, image height, and diagonal direction, as specified in ISO 12233.

##### FocalPlaneXResolution
```
public static final TiffTagID FocalPlaneXResolution
```

Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane.

##### FocalPlaneYResolution
```
public static final TiffTagID FocalPlaneYResolution
```

Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane.

##### FocalPlaneResolutionUnit
```
public static final TiffTagID FocalPlaneResolutionUnit
```

Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. This value is the same as the ResolutionUnit.

##### SubjectLocation
```
public static final TiffTagID SubjectLocation
```

Indicates the location of the main subject in the scene. The value of this tag represents the pixel at the center of the main subject relative to the left edge, prior to rotation processing as per the Rotation tag. The first value indicates the X column number and second indicates the Y row number.

##### ExposureIndex
```
public static final TiffTagID ExposureIndex
```

Indicates the exposure index selected on the camera or input device at the time the image is captured.

##### SensingMethod
```
public static final TiffTagID SensingMethod
```

Indicates the image sensor type on the camera or input device.

##### FileSource
```
public static final TiffTagID FileSource
```

Indicates the image source. If a DSC recorded the image, this tag value always shall be set to 3.

##### SceneType
```
public static final TiffTagID SceneType
```

Indicates the type of scene. If a DSC recorded the image, this tag value shall always be set to 1, indicating that the image was directly photographed.

##### CustomRendered
```
public static final TiffTagID CustomRendered
```

This tag indicates the use of special processing on image data, such as rendering geared to output.

##### ExposureMode
```
public static final TiffTagID ExposureMode
```

This tag indicates the exposure mode set when the image was shot. In auto-bracketing mode, the camera shoots a series of frames of the same scene at different exposure settings.

##### WhiteBalance
```
public static final TiffTagID WhiteBalance
```

This tag indicates the white balance mode set when the image was shot.

##### DigitalZoomRatio
```
public static final TiffTagID DigitalZoomRatio
```

This tag indicates the digital zoom ratio when the image was shot. If the numerator of the recorded value is 0, this indicates that digital zoom was not used.

##### FocalLengthIn35mmFilm
```
public static final TiffTagID FocalLengthIn35mmFilm
```

This tag indicates the equivalent focal length assuming a 35mm film camera, in mm. A value of 0 means the focal length is unknown. Note that this tag differs from the FocalLength tag.

##### GainControl
```
public static final TiffTagID GainControl
```

This tag indicates the degree of overall image gain adjustment.

##### Contrast
```
public static final TiffTagID Contrast
```

This tag indicates the direction of contrast processing applied by the camera when the image was shot.

##### Saturation
```
public static final TiffTagID Saturation
```

This tag indicates the direction of saturation processing applied by the camera when the image was shot.

##### Sharpness
```
public static final TiffTagID Sharpness
```

This tag indicates the direction of sharpness processing applied by the camera when the image was shot.

##### DeviceSettingDescription
```
public static final TiffTagID DeviceSettingDescription
```

This tag indicates information on the picture-taking conditions of a particular camera model.

##### SubjectDistanceRange
```
public static final TiffTagID SubjectDistanceRange
```

This tag indicates the distance to the subject.

##### CompositeImage
```
public static final TiffTagID CompositeImage
```

This tag indicates whether the recorded image is a composite image\* or not.

##### SourceImageNumberOfCompositeImage
```
public static final TiffTagID SourceImageNumberOfCompositeImage
```

This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image.

##### SourceExposureTimesOfCompositeImage
```
public static final TiffTagID SourceExposureTimesOfCompositeImage
```

For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image, such as respective exposure times of captured source images (tentatively recorded images).

##### Temperature
```
public static final TiffTagID Temperature
```

Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. The unit is °C.

##### Humidity
```
public static final TiffTagID Humidity
```

Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. The unit is %.

##### Pressure
```
public static final TiffTagID Pressure
```

Pressure as the ambient situation at the shot, for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea. The unit is hPa.

##### WaterDepth
```
public static final TiffTagID WaterDepth
```

Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. The unit is m.

##### Acceleration
```
public static final TiffTagID Acceleration
```

Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot. The unit is mGal (10-5 m/s2).

##### CameraElevationAngle
```
public static final TiffTagID CameraElevationAngle
```

Elevation/depression. angle of the orientation of the camera(imaging optical axis) as the ambient situation at the shot. The unit is degree(°).

##### ImageUniqueID
```
public static final TiffTagID ImageUniqueID
```

This tag indicates an identifier assigned uniquely to each image.

##### LensSpecification
```
public static final TiffTagID LensSpecification
```

This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length, and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography.

##### LensMake
```
public static final TiffTagID LensMake
```

This tag records the lens manufacturer as an ASCII string.

##### LensModel
```
public static final TiffTagID LensModel
```

This tag records the lens\\u2019s model name and model number as an ASCII string.

##### LensSerialNumber
```
public static final TiffTagID LensSerialNumber
```

This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string.

##### getByRawValue(int rawValue)
```
public static TiffTagID getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
TiffTagID
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### values()
```
public static Iterable<TiffTagID> values()
```

**Returns:**
java.lang.Iterable<com.groupdocs.metadata.core.TiffTagID>
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int
##### name()
```
public String name()
```

Returns the name of this enumeration value.

**Returns:**
java.lang.String
##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### TiffTagType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tifftagtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum TiffTagType extends Enum<TiffTagType> implements IEnumValue
```

Represents the IFD data type.
#### Fields

| Field | Description |
| --- | --- |
| Byte | An 8-bit unsigned integer. |
| Ascii | An 8-bit byte with a 7-bit ASCII character. |
| Short | A 16-bit unsigned integer. |
| Long | A 32-bit unsigned integer. |
| Rational | A pair of LONGs, numerator then denominator. |
| SByte | An 8-bit signed integer. |
| Undefined | An undefined 8-bit byte. |
| SShort | A 16-bit signed integer. |
| SLong | A 32-bit signed integer. |
| SRational | A pair of SLONGs, numerator then denominator. |
| Float | A 4-byte IEEE floating point value. |
| Double | An 8-byte IEEE floating point value. |
| SubIfd | A 4-byte long offset value |
| value |  |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| get_Value() |  |
| set_Value(String value1) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getTiffTagType() |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Byte
```
public static final TiffTagType Byte
```

An 8-bit unsigned integer.

##### Ascii
```
public static final TiffTagType Ascii
```

An 8-bit byte with a 7-bit ASCII character.

##### Short
```
public static final TiffTagType Short
```

A 16-bit unsigned integer.

##### Long
```
public static final TiffTagType Long
```

A 32-bit unsigned integer.

##### Rational
```
public static final TiffTagType Rational
```

A pair of LONGs, numerator then denominator.

##### SByte
```
public static final TiffTagType SByte
```

An 8-bit signed integer.

##### Undefined
```
public static final TiffTagType Undefined
```

An undefined 8-bit byte.

##### SShort
```
public static final TiffTagType SShort
```

A 16-bit signed integer.

##### SLong
```
public static final TiffTagType SLong
```

A 32-bit signed integer.

##### SRational
```
public static final TiffTagType SRational
```

A pair of SLONGs, numerator then denominator.

##### Float
```
public static final TiffTagType Float
```

A 4-byte IEEE floating point value.

##### Double
```
public static final TiffTagType Double
```

An 8-byte IEEE floating point value.

##### SubIfd
```
public static final TiffTagType SubIfd
```

A 4-byte long offset value

##### value
```
public String value
```

##### values()
```
public static TiffTagType[] values()
```

**Returns:**
com.groupdocs.metadata.core.TiffTagType[]
##### valueOf(String name)
```
public static TiffTagType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TiffTagType
##### get_Value()
```
public final String get_Value()
```

**Returns:**
java.lang.String
##### set_Value(String value1)
```
public final void set_Value(String value1)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value1 | java.lang.String |  |

##### getByRawValue(int rawValue)
```
public static TiffTagType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
TiffTagType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getTiffTagType()
```
public int getTiffTagType()
```

**Returns:**
int
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### TiffUndefinedTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/tiffundefinedtag.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataProperty, com.groupdocs.metadata.core.TiffTag, com.groupdocs.metadata.core.TiffArrayTag
```
public final class TiffUndefinedTag extends TiffArrayTag<Byte>
```

Represents a TIFF tag with the Undefined type.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffUndefinedTag(TiffTagID tagID, byte[] value) | Initializes a new instance of the  TiffUndefinedTag  class. |
##### TiffUndefinedTag(TiffTagID tagID, byte[] value)
```
public TiffUndefinedTag(TiffTagID tagID, byte[] value)
```

Initializes a new instance of the  TiffUndefinedTag  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tagID | TiffTagID | The tag identifier. |
| value | byte[] | The value. |

### TorrentPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/torrentpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class TorrentPackage extends CustomPackage
```

Represents torrent descriptor file metadata. Please find more information at  [https://en.wikipedia.org/wiki/Torrent\_file][https_en.wikipedia.org_wiki_Torrent_file] .

[https_en.wikipedia.org_wiki_Torrent_file]: https://en.wikipedia.org/wiki/Torrent_file
[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getAnnounce() | Gets the URL of the tracker. |
| setAnnounce(String value) | Sets the URL of the tracker. |
| getComment() | Gets the author's comment. |
| setComment(String value) | Sets the author's comment. |
| getCreationDate() | Gets the creation date of the torrent. |
| setCreationDate(Date value) | Sets the creation date of the torrent. |
| getCreatedBy() | Gets the name and version of the program used to create the torrent. |
| setCreatedBy(String value) | Sets the name and version of the program used to create the torrent. |
| getSharedFiles() | Gets an array containing shared file information entries. |
| getPieceLength() | Gets the number of bytes in each piece. |
| getPieces() | Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece. |
##### getAnnounce()
```
public final String getAnnounce()
```

Gets the URL of the tracker.

**Returns:**
java.lang.String - The URL of the tracker.
##### setAnnounce(String value)
```
public final void setAnnounce(String value)
```

Sets the URL of the tracker.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URL of the tracker. |

##### getComment()
```
public final String getComment()
```

Gets the author's comment.

**Returns:**
java.lang.String - The author's comment.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the author's comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author's comment. |

##### getCreationDate()
```
public final Date getCreationDate()
```

Gets the creation date of the torrent.

**Returns:**
java.util.Date - The creation date of the torrent.
##### setCreationDate(Date value)
```
public final void setCreationDate(Date value)
```

Sets the creation date of the torrent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The creation date of the torrent. |

##### getCreatedBy()
```
public final String getCreatedBy()
```

Gets the name and version of the program used to create the torrent.

**Returns:**
java.lang.String - The name and version of the program used to create the torrent.
##### setCreatedBy(String value)
```
public final void setCreatedBy(String value)
```

Sets the name and version of the program used to create the torrent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name and version of the program used to create the torrent. |

##### getSharedFiles()
```
public final TorrentSharedFilePackage[] getSharedFiles()
```

Gets an array containing shared file information entries.

**Returns:**
com.groupdocs.metadata.core.TorrentSharedFilePackage[] - An array containing shared file information entries.
##### getPieceLength()
```
public final long getPieceLength()
```

Gets the number of bytes in each piece. For more information please see .

**Returns:**
long - The number of bytes in each piece.
##### getPieces()
```
public final byte[] getPieces()
```

Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

**Returns:**
byte[] - A byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.

### TorrentRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/torrentrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class TorrentRootPackage extends RootMetadataPackage
```

Represents the root package intended to work with metadata of a TORRENT file.

This code sample shows how to read metadata of a TORRENT file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputTorrent)) {
>      TorrentRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getTorrentPackage().getAnnounce());
>      System.out.println(root.getTorrentPackage().getComment());
>      System.out.println(root.getTorrentPackage().getCreatedBy());
>      System.out.println(root.getTorrentPackage().getCreationDate());
>      for (TorrentSharedFilePackage file : root.getTorrentPackage().getSharedFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getLength());
>      }
>      // ...
>  }
>
> ```
> ```

[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getTorrentPackage() | Gets the TORRENT file metadata package. |
##### getTorrentPackage()
```
public final TorrentPackage getTorrentPackage()
```

Gets the TORRENT file metadata package.

**Returns:**
TorrentPackage - The TORRENT file metadata package.

### TorrentSharedFilePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/torrentsharedfilepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class TorrentSharedFilePackage extends CustomPackage
```

Represents shared file information. Contains detailed info about each file in a torrent distribution.

[Working with TORRENT files]: https://docs.groupdocs.com/display/metadatajava/Working+with+TORRENT+files
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the full name of the file (relative path to the file from the root torrent folder). |
| getLength() | Gets the length of the file in bytes. |
##### getName()
```
public final String getName()
```

Gets the full name of the file (relative path to the file from the root torrent folder).

**Returns:**
java.lang.String - The full name of the file (relative path to the file from the root torrent folder).
##### getLength()
```
public final long getLength()
```

Gets the length of the file in bytes.

**Returns:**
long - The length of the file in bytes.

### ValueAcceptor
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/valueacceptor.md

**Inheritance:**
java.lang.Object
```
public abstract class ValueAcceptor
```

Provides a base abstract class that allows extracting all supported types of values from a  PropertyValue  instance.
#### Constructors

| Constructor | Description |
| --- | --- |
| ValueAcceptor() |  |
##### ValueAcceptor()
```
public ValueAcceptor()
```

### ValueInterpreter
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/valueinterpreter.md

**Inheritance:**
java.lang.Object
```
public abstract class ValueInterpreter
```

Defines operations required to interpret metadata property values.
#### Constructors

| Constructor | Description |
| --- | --- |
| ValueInterpreter() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInterpretedValueType() | Gets the type of the interpreted value. |
| toInterpretedValue(PropertyValue originalValue) | Interprets the provided property value. |
| toSourceValue(PropertyValue interpretedValue) | Converts an interpreted value back to its original form. |
##### ValueInterpreter()
```
public ValueInterpreter()
```

##### getInterpretedValueType()
```
public abstract MetadataPropertyType getInterpretedValueType()
```

Gets the type of the interpreted value.

**Returns:**
MetadataPropertyType - The type of the interpreted value.
##### toInterpretedValue(PropertyValue originalValue)
```
public final PropertyValue toInterpretedValue(PropertyValue originalValue)
```

Interprets the provided property value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalValue | PropertyValue | The value to interpret. |

**Returns:**
PropertyValue - The interpreted value.
##### toSourceValue(PropertyValue interpretedValue)
```
public final PropertyValue toSourceValue(PropertyValue interpretedValue)
```

Converts an interpreted value back to its original form.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| interpretedValue | PropertyValue | The interpreted value to convert. |

**Returns:**
PropertyValue - The original value.

### VCardAgentRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardagentrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardAgentRecord extends VCardRecord implements IVCardRecord<VCardCard>
```

Represents vCard Agent record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final VCardCard getValue()
```

Gets the record value.

**Returns:**
VCardCard - The record value.

### VCardBasePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardbasepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class VCardBasePackage extends CustomPackage
```

Represents the base VCard metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata

### VCardBinaryRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardbinaryrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardBinaryRecord extends VCardRecord implements IVCardRecord<byte[]>
```

Represents vCard binary record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final byte[] getValue()
```

Gets the record value.

**Returns:**
byte[] - The record value.

### VCardCalendarRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardcalendarrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCalendarRecordset extends VCardRecordset
```

Represents a set of Calendar vCard records.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getBusyTimeRecords() | Gets the URIs for the busy time associated with the object. |
| getBusyTimeEntries() | Gets the URIs for the busy time associated with the object. |
| getCalendarAddressRecords() | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| getCalendarAddresses() | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| getCalendarUriRecords() | Gets the URIs for the calendar associated with the object represented by the vCard. |
| getUriCalendarEntries() | Gets the URIs for the calendar associated with the object represented by the vCard. |
##### getBusyTimeRecords()
```
public final VCardTextRecord[] getBusyTimeRecords()
```

Gets the URIs for the busy time associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for the busy time associated with the object.
##### getBusyTimeEntries()
```
public final String[] getBusyTimeEntries()
```

Gets the URIs for the busy time associated with the object.

**Returns:**
java.lang.String[] - The URIs for the busy time associated with the object.

This property is a simplified version of  BusyTimeRecords .
##### getCalendarAddressRecords()
```
public final VCardTextRecord[] getCalendarAddressRecords()
```

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.
##### getCalendarAddresses()
```
public final String[] getCalendarAddresses()
```

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

**Returns:**
java.lang.String[] - The calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

This property is a simplified version of  CalendarAddressRecords .
##### getCalendarUriRecords()
```
public final VCardTextRecord[] getCalendarUriRecords()
```

Gets the URIs for the calendar associated with the object represented by the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for the calendar associated with the object represented by the vCard.
##### getUriCalendarEntries()
```
public final String[] getUriCalendarEntries()
```

Gets the URIs for the calendar associated with the object represented by the vCard.

**Returns:**
java.lang.String[] - The URIs for the calendar associated with the object represented by the vCard.

This property is a simplified version of  CalendarUriRecords .

### VCardCard
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardcard.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCard extends VCardRecordset
```

Represents a single card extracted from a VCard file.

This example shows how to use vCard property filters.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.InputVcf)) {
>          VCardRootPackage root = metadata.getRootPackageGeneric();
>          for (VCardCard vCard : root.getVCardPackage().getCards()) {
>              // Print most preferred work phone numbers and work emails
>              VCardCard filtered = vCard.filterWorkTags().filterPreferred();
>              PrintArray(filtered.getCommunicationRecordset().getTelephones());
>              PrintArray(filtered.getCommunicationRecordset().getEmails());
>          }
>      }
>  }
>  private static void PrintArray(String[] values) {
>      if (values != null) {
>          for (String value : values) {
>              System.out.println(value);
>          }
>      }
>  }
>
> ```
> ```

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGeneralRecordset() | Gets the general records. |
| getIdentificationRecordset() | Gets the identification records. |
| getDeliveryAddressingRecordset() | Gets the delivery addressing records. |
| getCommunicationRecordset() | Gets the communication records. |
| getGeographicalRecordset() | Gets the geographical records. |
| getOrganizationalRecordset() | Gets the organizational records. |
| getExplanatoryRecordset() | Gets the explanatory records. |
| getSecurityRecordset() | Gets the security records. |
| getCalendarRecordset() | Gets the calendar records. |
| getExtensionRecords() | Gets the private extension records. |
| getAvailableGroups() | Gets the available group names. |
| filterByGroup(String groupName) | Filters all vCard records by the group name passed as a parameter. |
| filterHomeTags() | Filters all vCard records marked with the HOME tag. |
| filterWorkTags() | Filters all vCard records marked with the WORK tag. |
| filterPreferred() | Filters the preferred records. |
##### getGeneralRecordset()
```
public final VCardGeneralRecordset getGeneralRecordset()
```

Gets the general records.

**Returns:**
VCardGeneralRecordset - The general records.
##### getIdentificationRecordset()
```
public final VCardIdentificationRecordset getIdentificationRecordset()
```

Gets the identification records.

**Returns:**
VCardIdentificationRecordset - The identification records.
##### getDeliveryAddressingRecordset()
```
public final VCardDeliveryAddressingRecordset getDeliveryAddressingRecordset()
```

Gets the delivery addressing records.

**Returns:**
VCardDeliveryAddressingRecordset - The delivery addressing records.
##### getCommunicationRecordset()
```
public final VCardCommunicationRecordset getCommunicationRecordset()
```

Gets the communication records.

**Returns:**
VCardCommunicationRecordset - The communication records.
##### getGeographicalRecordset()
```
public final VCardGeographicalRecordset getGeographicalRecordset()
```

Gets the geographical records.

**Returns:**
VCardGeographicalRecordset - The geographical records.
##### getOrganizationalRecordset()
```
public final VCardOrganizationalRecordset getOrganizationalRecordset()
```

Gets the organizational records.

**Returns:**
VCardOrganizationalRecordset - The organizational records.
##### getExplanatoryRecordset()
```
public final VCardExplanatoryRecordset getExplanatoryRecordset()
```

Gets the explanatory records.

**Returns:**
VCardExplanatoryRecordset - The explanatory records.
##### getSecurityRecordset()
```
public final VCardSecurityRecordset getSecurityRecordset()
```

Gets the security records.

**Returns:**
VCardSecurityRecordset - The security records.
##### getCalendarRecordset()
```
public final VCardCalendarRecordset getCalendarRecordset()
```

Gets the calendar records.

**Returns:**
VCardCalendarRecordset - The calendar records.
##### getExtensionRecords()
```
public final VCardTextRecord[] getExtensionRecords()
```

Gets the private extension records.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The private extension records.
##### getAvailableGroups()
```
public final String[] getAvailableGroups()
```

Gets the available group names.

**Returns:**
java.lang.String[] - The available group names.
##### filterByGroup(String groupName)
```
public final VCardCard filterByGroup(String groupName)
```

Filters all vCard records by the group name passed as a parameter. For more information please see the method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| groupName | java.lang.String | The name of the group. |

**Returns:**
VCardCard - The filtered vCard instance.
##### filterHomeTags()
```
public final VCardCard filterHomeTags()
```

Filters all vCard records marked with the HOME tag.

**Returns:**
VCardCard - The filtered vCard instance.
##### filterWorkTags()
```
public final VCardCard filterWorkTags()
```

Filters all vCard records marked with the WORK tag.

**Returns:**
VCardCard - Filtered vCard instance.
##### filterPreferred()
```
public final VCardCard filterPreferred()
```

Filters the preferred records.

**Returns:**
VCardCard - The filtered vCard instance.

### VCardCommunicationRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardcommunicationrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardCommunicationRecordset extends VCardRecordset
```

Represents a set of Communication vCard records. These properties describe information about how to communicate with the object the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTelephoneRecords() | Gets the telephone numbers for telephony communication with the object. |
| getTelephones() | Gets the telephone numbers for telephony communication with the object. |
| getEmailRecords() | Gets the electronic mail addresses for communication with the object. |
| getEmails() | Gets the electronic mail addresses for communication with the object. |
| getMailer() | Gets the type of the electronic mail software that is used by the individual associated with the vCard. |
| getImppRecords() | Gets the URIs for instant messaging and presence protocol communications with the object. |
| getImppEntries() | Gets the URIs for instant messaging and presence protocol communications with the object. |
| getLanguageRecords() | Gets the languages that may be used for contacting the object. |
| getLanguages() | Gets the languages that may be used for contacting the object. |
##### getTelephoneRecords()
```
public final VCardTextRecord[] getTelephoneRecords()
```

Gets the telephone numbers for telephony communication with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The telephone numbers for telephony communication with the object.
##### getTelephones()
```
public final String[] getTelephones()
```

Gets the telephone numbers for telephony communication with the object.

**Returns:**
java.lang.String[] - The telephone numbers for telephony communication with the object.

This property is a simplified version of  TelephoneRecords .
##### getEmailRecords()
```
public final VCardTextRecord[] getEmailRecords()
```

Gets the electronic mail addresses for communication with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The electronic mail addresses array for communication with the object.
##### getEmails()
```
public final String[] getEmails()
```

Gets the electronic mail addresses for communication with the object.

**Returns:**
java.lang.String[] - The electronic mail addresses array for communication with the object.

This property is a simplified version of  EmailRecords .
##### getMailer()
```
public final String getMailer()
```

Gets the type of the electronic mail software that is used by the individual associated with the vCard.

**Returns:**
java.lang.String - The type of the electronic mail software that is used by the individual associated with the vCard
##### getImppRecords()
```
public final VCardTextRecord[] getImppRecords()
```

Gets the URIs for instant messaging and presence protocol communications with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs for instant messaging and presence protocol communications with the object.
##### getImppEntries()
```
public final String[] getImppEntries()
```

Gets the URIs for instant messaging and presence protocol communications with the object.

**Returns:**
java.lang.String[] - The URIs for instant messaging and presence protocol communications with the object.

This property is a simplified version of  ImppRecords .
##### getLanguageRecords()
```
public final VCardTextRecord[] getLanguageRecords()
```

Gets the languages that may be used for contacting the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The languages that may be used for contacting the object.
##### getLanguages()
```
public final String[] getLanguages()
```

Gets the languages that may be used for contacting the object.

**Returns:**
java.lang.String[] - The languages that may be used for contacting the object.

This property is a simplified version of  LanguageRecords .

### VCardContentType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardcontenttype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum VCardContentType extends Enum<VCardContentType> implements IEnumValue
```

Defines vCard record content types.
#### Fields

| Field | Description |
| --- | --- |
| Custom | The custom content type. |
| Text | The text content type. |
| Binary | The binary content type. |
| DateTime | The date time content type. |
| Agent | The agent content type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Custom
```
public static final VCardContentType Custom
```

The custom content type.

##### Text
```
public static final VCardContentType Text
```

The text content type.

##### Binary
```
public static final VCardContentType Binary
```

The binary content type.

##### DateTime
```
public static final VCardContentType DateTime
```

The date time content type.

##### Agent
```
public static final VCardContentType Agent
```

The agent content type.

##### values()
```
public static VCardContentType[] values()
```

**Returns:**
com.groupdocs.metadata.core.VCardContentType[]
##### valueOf(String name)
```
public static VCardContentType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
VCardContentType
##### getByRawValue(int rawValue)
```
public static VCardContentType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
VCardContentType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### VCardCustomRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardcustomrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardCustomRecord extends VCardRecord implements IVCardRecord<String>
```

Represents vCard custom record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final String getValue()
```

Gets the record value.

**Returns:**
java.lang.String - The record value.

### VCardDateTimeRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcarddatetimerecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardDateTimeRecord extends VCardRecord implements IVCardRecord<Date>
```

Represents vCard date time record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getValue() | Gets the record value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getValue()
```
public final Date getValue()
```

Gets the record value.

**Returns:**
java.util.Date - The record value.

### VCardDeliveryAddressingRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcarddeliveryaddressingrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardDeliveryAddressingRecordset extends VCardRecordset
```

Represents a set of Delivery Addressing vCard records. These types are concerned with information related to the delivery addressing or label for the vCard object.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getAddressRecords() | Gets the components of the delivery address of the object. |
| getAddresses() | Gets the components of the delivery address of the object. |
| getLabelRecords() | Gets an array containing the formatted text corresponding to delivery address of the object. |
| getLabels() | Gets an array containing the formatted text corresponding to delivery address of the object. |
##### getAddressRecords()
```
public final VCardTextRecord[] getAddressRecords()
```

Gets the components of the delivery address of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The components of the delivery address of the object.
##### getAddresses()
```
public final String[] getAddresses()
```

Gets the components of the delivery address of the object.

**Returns:**
java.lang.String[] - The components of the delivery address of the object.

This property is a simplified version of  AddressRecords .
##### getLabelRecords()
```
public final VCardTextRecord[] getLabelRecords()
```

Gets an array containing the formatted text corresponding to delivery address of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the formatted text corresponding to delivery address of the object.
##### getLabels()
```
public final String[] getLabels()
```

Gets an array containing the formatted text corresponding to delivery address of the object.

**Returns:**
java.lang.String[] - An array containing the formatted text corresponding to delivery address of the object.

This property is a simplified version of  LabelRecords .

### VCardExplanatoryRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardexplanatoryrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardExplanatoryRecordset extends VCardRecordset
```

Represents a set of Explanatory vCard records. These properties are concerned with additional explanations, such as that related to informational notes or revisions specific to the vCard.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCategoryRecords() | Gets the application category information about the vCard, also known as "tags". |
| getCategories() | Gets the application category information about the vCard, also known as "tags". |
| getNoteRecords() | Gets the supplemental information or comments that are associated with the vCard. |
| getNotes() | Gets the supplemental information or comments that are associated with the vCard. |
| getProductIdentifierRecord() | Gets the identifier of the product that created the vCard object. |
| getProductIdentifier() | Gets the identifier of the product that created the vCard object. |
| getRevision() | Gets the revision information about the current vCard. |
| getSortString() | Gets the family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types. |
| getSoundRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getSoundBinaryRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getBinarySounds() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getSoundUriRecords() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getUriSounds() | Gets the digital sound content information that annotates some aspects of the vCard. |
| getUidRecord() | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| getUid() | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| getPidIdentifierRecords() | Gets the global meaning of the local PID source identifier. |
| getPidIdentifiers() | Gets the global meaning of the local PID source identifier. |
| getUrlRecords() | Gets an array of URLs pointing to websites that represent the person in some way. |
| getUrls() | Gets an array of URLs pointing to websites that represent the person in some way. |
| getVersion() | Gets the version of the vCard specification. |
##### getCategoryRecords()
```
public final VCardTextRecord[] getCategoryRecords()
```

Gets the application category information about the vCard, also known as "tags".

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The application category information about the vCard, also known as "tags".
##### getCategories()
```
public final String[] getCategories()
```

Gets the application category information about the vCard, also known as "tags".

**Returns:**
java.lang.String[] - The application category information about the vCard, also known as "tags".

This property is a simplified version of  CategoryRecords .
##### getNoteRecords()
```
public final VCardTextRecord[] getNoteRecords()
```

Gets the supplemental information or comments that are associated with the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The supplemental information or comments that are associated with the vCard.
##### getNotes()
```
public final String[] getNotes()
```

Gets the supplemental information or comments that are associated with the vCard.

**Returns:**
java.lang.String[] - The supplemental information or comments that are associated with the vCard.

This property is a simplified version of  NoteRecords .
##### getProductIdentifierRecord()
```
public final VCardTextRecord getProductIdentifierRecord()
```

Gets the identifier of the product that created the vCard object.

**Returns:**
VCardTextRecord - The identifier of the product that created the vCard object
##### getProductIdentifier()
```
public final String getProductIdentifier()
```

Gets the identifier of the product that created the vCard object.

**Returns:**
java.lang.String - The identifier of the product that created the vCard object

This property is a simplified version of  ProductIdentifierRecord .
##### getRevision()
```
public final Date getRevision()
```

Gets the revision information about the current vCard.

**Returns:**
java.util.Date - The revision information about the current vCard.
##### getSortString()
```
public final String getSortString()
```

Gets the family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types.

**Returns:**
java.lang.String - The family name or given name text to be used for national-language-specific sorting of the  VCardIdentificationRecordset.FormattedNames  and  VCardIdentificationRecordset.Name  types.
##### getSoundRecords()
```
public final VCardRecord[] getSoundRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The digital sound content information that annotates some aspects of the vCard.
##### getSoundBinaryRecords()
```
public final VCardBinaryRecord[] getSoundBinaryRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundRecords .
##### getBinarySounds()
```
public final byte[][] getBinarySounds()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
byte[][] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundBinaryRecords .
##### getSoundUriRecords()
```
public final VCardTextRecord[] getSoundUriRecords()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundRecords .
##### getUriSounds()
```
public final String[] getUriSounds()
```

Gets the digital sound content information that annotates some aspects of the vCard.

**Returns:**
java.lang.String[] - The digital sound content information that annotates some aspects of the vCard.

This property is a simplified version of  SoundUriRecords .
##### getUidRecord()
```
public final VCardTextRecord getUidRecord()
```

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

**Returns:**
VCardTextRecord - The value that represents a globally unique identifier corresponding.
##### getUid()
```
public final String getUid()
```

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

**Returns:**
java.lang.String - The value that represents a globally unique identifier corresponding.

This property is a simplified version of  UidRecord .
##### getPidIdentifierRecords()
```
public final VCardTextRecord[] getPidIdentifierRecords()
```

Gets the global meaning of the local PID source identifier.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The global meaning of the local PID source identifier.
##### getPidIdentifiers()
```
public final String[] getPidIdentifiers()
```

Gets the global meaning of the local PID source identifier.

**Returns:**
java.lang.String[] - The global meaning of the local PID source identifier.

This property is a simplified version of  PidIdentifierRecords .
##### getUrlRecords()
```
public final VCardTextRecord[] getUrlRecords()
```

Gets an array of URLs pointing to websites that represent the person in some way.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array of URLs pointing to websites that represent the person in some way.
##### getUrls()
```
public final String[] getUrls()
```

Gets an array of URLs pointing to websites that represent the person in some way.

**Returns:**
java.lang.String[] - An array of URLs pointing to websites that represent the person in some way.

This property is a simplified version of  UrlRecords .
##### getVersion()
```
public final String getVersion()
```

Gets the version of the vCard specification.

**Returns:**
java.lang.String - The version of the vCard specification.

### VCardGeneralRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardgeneralrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardGeneralRecordset extends VCardRecordset
```

Represents a set of General vCard records.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getSourceRecords() | Gets the array of sources of directory information contained in the content type. |
| getSources() | Gets an array containing the sources of the directory information contained in the content type. |
| getNameOfSource() | Gets the textual representation of the SOURCE property. |
| getKind() | Gets the kind of the object. |
| getXmlRecords() | Gets an array containing extended XML-encoded vCard data. |
| getXmlEntries() | Gets an array containing extended XML-encoded vCard data. |
##### getSourceRecords()
```
public final VCardTextRecord[] getSourceRecords()
```

Gets the array of sources of directory information contained in the content type.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The array of sources of directory information contained in the content type.
##### getSources()
```
public final String[] getSources()
```

Gets an array containing the sources of the directory information contained in the content type.

**Returns:**
java.lang.String[] - An array containing the sources of the directory information contained in the content type.

This property is a simplified version of  SourceRecords .
##### getNameOfSource()
```
public final String getNameOfSource()
```

Gets the textual representation of the SOURCE property.

**Returns:**
java.lang.String - The textual representation of the SOURCE property.
##### getKind()
```
public final String getKind()
```

Gets the kind of the object.

**Returns:**
java.lang.String - The kind of object.
##### getXmlRecords()
```
public final VCardTextRecord[] getXmlRecords()
```

Gets an array containing extended XML-encoded vCard data.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing extended XML-encoded vCard data.
##### getXmlEntries()
```
public final String[] getXmlEntries()
```

Gets an array containing extended XML-encoded vCard data.

**Returns:**
java.lang.String[] - An array of extended XML-encoded vCard data.

This property is a simplified version of  XmlRecords .

### VCardGeographicalRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardgeographicalrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardGeographicalRecordset extends VCardRecordset
```

Represents a set of Geographical vCard records. These properties are concerned with information associated with geographical positions or regions associated with the object the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTimeZoneRecords() | Gets the time zones of the object. |
| getTimeZones() | Gets the time zones of the object. |
| getGeographicPositionRecords() | Gets the information related to the global positioning of the object. |
| getGeographicPositions() | Gets the information related to the global positioning of the object. |
##### getTimeZoneRecords()
```
public final VCardTextRecord[] getTimeZoneRecords()
```

Gets the time zones of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The time zones of the object.
##### getTimeZones()
```
public final String[] getTimeZones()
```

Gets the time zones of the object.

**Returns:**
java.lang.String[] - The time zones of the object.

This property is a simplified version of  TimeZoneRecords .
##### getGeographicPositionRecords()
```
public final VCardTextRecord[] getGeographicPositionRecords()
```

Gets the information related to the global positioning of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The information related to the global positioning of the object.
##### getGeographicPositions()
```
public final String[] getGeographicPositions()
```

Gets the information related to the global positioning of the object.

**Returns:**
java.lang.String[] - The information related to the global positioning of the object.

This property is a simplified version of  GeographicPositionRecords .

### VCardIdentificationRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardidentificationrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardIdentificationRecordset extends VCardRecordset
```

Represents a set of Identification vCard records. These types are used to capture information associated with the identification and naming of the entity associated with the vCard.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getFormattedNameRecords() | Gets an array containing the formatted text corresponding to the name of the object. |
| getFormattedNames() | Gets an array containing the formatted text corresponding to the name of the object. |
| getNameRecord() | Gets the components of the name of the object. |
| getName() | Gets the components of the name of the object. |
| getNicknameRecords() | Gets an array containing the text corresponding to the nickname of the object. |
| getNicknames() | Gets an array containing the text corresponding to the nickname of the object. |
| getPhotoRecords() | Gets an array containing the image or photograph information that annotates some aspects of the object. |
| getPhotoBinaryRecords() | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| getBinaryPhotos() | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| getPhotoUriRecords() | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| getUriPhotos() | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| getBirthdateRecords() | Gets an array containing the birth date of the object in different representations. |
| getBirthdateDateTimeRecord() | Gets the birth date of the object. |
| getDateTimeBirthdate() | Gets the birth date of the object. |
| getBirthdateTextRecords() | Gets an array containing the birth date of the object in different text representations. |
| getTextBirthdates() | Gets an array containing the birth date of the object in different text representations. |
| getAnniversaryRecord() | Gets the date of marriage, or equivalent, of the object. |
| getAnniversaryDateTimeRecord() | Gets the date of marriage represented as a single date-and-or-time value. |
| getDateTimeAnniversary() | Gets the date of marriage represented as a single date-and-or-time value. |
| getAnniversaryTextRecord() | Gets the date of marriage represented as a single text value. |
| getTextAnniversary() | Gets the date of marriage represented as a single text value. |
| getGenderRecord() | Gets the components of the sex and gender identity of the object. |
| getGender() | Gets the components of the sex and gender identity of the object. |
##### getFormattedNameRecords()
```
public final VCardTextRecord[] getFormattedNameRecords()
```

Gets an array containing the formatted text corresponding to the name of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the formatted text corresponding to the name of the object.
##### getFormattedNames()
```
public final String[] getFormattedNames()
```

Gets an array containing the formatted text corresponding to the name of the object.

**Returns:**
java.lang.String[] - An array containing the formatted text corresponding to the name of the object.

This property is a simplified version of  FormattedNameRecords .
##### getNameRecord()
```
public final VCardTextRecord getNameRecord()
```

Gets the components of the name of the object.

**Returns:**
VCardTextRecord - The components of the name of the object.
##### getName()
```
public final String getName()
```

Gets the components of the name of the object.

**Returns:**
java.lang.String - The components of the name of the object.

This property is a simplified version of  NameRecord .
##### getNicknameRecords()
```
public final VCardTextRecord[] getNicknameRecords()
```

Gets an array containing the text corresponding to the nickname of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the text corresponding to the nickname of the object.
##### getNicknames()
```
public final String[] getNicknames()
```

Gets an array containing the text corresponding to the nickname of the object.

**Returns:**
java.lang.String[] - An array containing the text corresponding to the nickname of the object.

This property is a simplified version of  NicknameRecords .
##### getPhotoRecords()
```
public final VCardRecord[] getPhotoRecords()
```

Gets an array containing the image or photograph information that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - An array containing the image or photograph information that annotates some aspects of the object.
##### getPhotoBinaryRecords()
```
public final VCardBinaryRecord[] getPhotoBinaryRecords()
```

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

This property is a simplified version of  PhotoRecords .
##### getBinaryPhotos()
```
public final byte[][] getBinaryPhotos()
```

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

**Returns:**
byte[][] - An array containing the image or photograph information represented as binary data that annotates some aspects of the object.

This property is a simplified version of  PhotoBinaryRecords .
##### getPhotoUriRecords()
```
public final VCardTextRecord[] getPhotoUriRecords()
```

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

This property is a simplified version of  PhotoRecords .
##### getUriPhotos()
```
public final String[] getUriPhotos()
```

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

**Returns:**
java.lang.String[] - An array containing the image or photograph information represented by URIs that annotates some aspects of the object.

This property is a simplified version of  PhotoUriRecords .
##### getBirthdateRecords()
```
public final VCardRecord[] getBirthdateRecords()
```

Gets an array containing the birth date of the object in different representations.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - An array containing the birth date of the object in different representations.
##### getBirthdateDateTimeRecord()
```
public final VCardDateTimeRecord getBirthdateDateTimeRecord()
```

Gets the birth date of the object.

**Returns:**
VCardDateTimeRecord - The birth date of the object.

This property is a simplified version of  BirthdateRecords .
##### getDateTimeBirthdate()
```
public final Date getDateTimeBirthdate()
```

Gets the birth date of the object.

**Returns:**
java.util.Date - The birth date of the object.

This property is a simplified version of  BirthdateDateTimeRecord .
##### getBirthdateTextRecords()
```
public final VCardTextRecord[] getBirthdateTextRecords()
```

Gets an array containing the birth date of the object in different text representations.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - An array containing the birth date of the object in different text representations.

This property is a simplified version of  BirthdateRecords .
##### getTextBirthdates()
```
public final String[] getTextBirthdates()
```

Gets an array containing the birth date of the object in different text representations.

**Returns:**
java.lang.String[] - An array containing the birth date of the object in different text representations.

This property is a simplified version of  BirthdateTextRecords .
##### getAnniversaryRecord()
```
public final VCardRecord getAnniversaryRecord()
```

Gets the date of marriage, or equivalent, of the object.

**Returns:**
VCardRecord - The date of marriage, or equivalent, of the object.
##### getAnniversaryDateTimeRecord()
```
public final VCardDateTimeRecord getAnniversaryDateTimeRecord()
```

Gets the date of marriage represented as a single date-and-or-time value.

**Returns:**
VCardDateTimeRecord - The date of marriage represented as a single date-and-or-time value.

This property is a simplified version of  AnniversaryRecord .
##### getDateTimeAnniversary()
```
public final Date getDateTimeAnniversary()
```

Gets the date of marriage represented as a single date-and-or-time value.

**Returns:**
java.util.Date - The date of marriage represented as a single date-and-or-time value.

This property is a simplified version of  AnniversaryDateTimeRecord .
##### getAnniversaryTextRecord()
```
public final VCardTextRecord getAnniversaryTextRecord()
```

Gets the date of marriage represented as a single text value.

**Returns:**
VCardTextRecord - The date of marriage represented as a single text value.

This property is a simplified version of  AnniversaryRecord .
##### getTextAnniversary()
```
public final String getTextAnniversary()
```

Gets the date of marriage represented as a single text value.

**Returns:**
java.lang.String - The date of marriage represented as a single text value.

This property is a simplified version of  AnniversaryTextRecord .
##### getGenderRecord()
```
public final VCardTextRecord getGenderRecord()
```

Gets the components of the sex and gender identity of the object.

**Returns:**
VCardTextRecord - The components of the sex and gender identity of the object.
##### getGender()
```
public final String getGender()
```

Gets the components of the sex and gender identity of the object.

**Returns:**
java.lang.String - The components of the sex and gender identity of the object.

This property is a simplified version of  GenderRecord .

### VCardOrganizationalRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardorganizationalrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardOrganizationalRecordset extends VCardRecordset
```

Represents a set of Organizational vCard records. These properties are concerned with information associated with characteristics of the organization or organizational units of the object that the vCard represents.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getTitleRecords() | Gets the positions or jobs of the object. |
| getTitles() | Gets the positions or jobs of the object. |
| getRoleRecords() | Gets the functions or parts played in a particular situation by the object. |
| getRoles() | Gets the functions or parts played in a particular situation by the object. |
| getLogoRecords() | Gets the graphic images of the logo associated with the object. |
| getLogoBinaryRecords() | Gets the graphic images of the logo associated with the object. |
| getBinaryLogos() | Gets the graphic images of the logo associated with the object. |
| getLogoUriRecords() | Gets the URIs of the graphic images of the logo associated with the object. |
| getUriLogos() | Gets the URIs of the graphic images of the logo associated with the object. |
| getAgentRecords() | Gets the information about another person who will act on behalf of the vCard object. |
| getAgentObjectRecord() | Gets the information about another person who will act on behalf of the vCard object. |
| getObjectAgent() | Gets the information about another person who will act on behalf of the vCard object. |
| getAgentUriRecords() | Gets the information about another person who will act on behalf of the vCard object. |
| getUriAgents() | Gets the information about another person who will act on behalf of the vCard object. |
| getOrganizationNameRecords() | Gets the organizational names and units associated with the object. |
| getOrganizationNames() | Gets the organizational names and units associated with the object. |
| getMemberRecords() | Gets the members in the group this vCard represents. |
| getMembers() | Gets the members in the group this vCard represents. |
| getRelationshipRecords() | Gets the relationships between another entity and the entity represented by this vCard. |
| getRelationships() | Gets the relationships between another entity and the entity represented by this vCard. |
##### getTitleRecords()
```
public final VCardTextRecord[] getTitleRecords()
```

Gets the positions or jobs of the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The positions or jobs of the object.
##### getTitles()
```
public final String[] getTitles()
```

Gets the positions or jobs of the object.

**Returns:**
java.lang.String[] - The positions or jobs of the object.

This property is a simplified version of  TitleRecords .
##### getRoleRecords()
```
public final VCardTextRecord[] getRoleRecords()
```

Gets the functions or parts played in a particular situation by the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The functions or parts played in a particular situation by the object.
##### getRoles()
```
public final String[] getRoles()
```

Gets the functions or parts played in a particular situation by the object.

**Returns:**
java.lang.String[] - The functions or parts played in a particular situation by the object.

This property is a simplified version of  TitleRecords .
##### getLogoRecords()
```
public final VCardRecord[] getLogoRecords()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The graphic images of the logo associated with the object.
##### getLogoBinaryRecords()
```
public final VCardBinaryRecord[] getLogoBinaryRecords()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The graphic images of the logo associated with the object.

This property is a simplified version of  LogoRecords .
##### getBinaryLogos()
```
public final byte[][] getBinaryLogos()
```

Gets the graphic images of the logo associated with the object.

**Returns:**
byte[][] - The graphic images of the logo associated with the object.

This property is a simplified version of  LogoBinaryRecords .
##### getLogoUriRecords()
```
public final VCardTextRecord[] getLogoUriRecords()
```

Gets the URIs of the graphic images of the logo associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The URIs of the graphic images of the logo associated with the object.

This property is a simplified version of  LogoRecords .
##### getUriLogos()
```
public final String[] getUriLogos()
```

Gets the URIs of the graphic images of the logo associated with the object.

**Returns:**
java.lang.String[] - The URIs of the graphic images of the logo associated with the object.

This property is a simplified version of  LogoUriRecords .
##### getAgentRecords()
```
public final VCardRecord[] getAgentRecords()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The information about another person who will act on behalf of the vCard object.
##### getAgentObjectRecord()
```
public final VCardAgentRecord getAgentObjectRecord()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
VCardAgentRecord - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentRecords .
##### getObjectAgent()
```
public final VCardCard getObjectAgent()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
VCardCard - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentObjectRecord .
##### getAgentUriRecords()
```
public final VCardTextRecord[] getAgentUriRecords()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentRecords .
##### getUriAgents()
```
public final String[] getUriAgents()
```

Gets the information about another person who will act on behalf of the vCard object.

**Returns:**
java.lang.String[] - The information about another person who will act on behalf of the vCard object.

This property is a simplified version of  AgentUriRecords .
##### getOrganizationNameRecords()
```
public final VCardTextRecord[] getOrganizationNameRecords()
```

Gets the organizational names and units associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The organizational names and units associated with the object.
##### getOrganizationNames()
```
public final String[] getOrganizationNames()
```

Gets the organizational names and units associated with the object.

**Returns:**
java.lang.String[] - The organizational names and units associated with the object.

This property is a simplified version of  OrganizationNameRecords .
##### getMemberRecords()
```
public final VCardTextRecord[] getMemberRecords()
```

Gets the members in the group this vCard represents.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The members in the group this vCard represents.
##### getMembers()
```
public final String[] getMembers()
```

Gets the members in the group this vCard represents.

**Returns:**
java.lang.String[] - The members in the group this vCard represents.

This property is a simplified version of  MemberRecords .
##### getRelationshipRecords()
```
public final VCardTextRecord[] getRelationshipRecords()
```

Gets the relationships between another entity and the entity represented by this vCard.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The relationships between another entity and the entity represented by this vCard.
##### getRelationships()
```
public final String[] getRelationships()
```

Gets the relationships between another entity and the entity represented by this vCard.

**Returns:**
java.lang.String[] - The relationships between another entity and the entity represented by this vCard.

This property is a simplified version of  RelationshipRecords .

### VCardPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public final class VCardPackage extends VCardBasePackage
```

Represents VCF (Virtual Contact File) electronic business card format metadata.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getCards() | Gets an array of the cards extracted from the file. |
##### getCards()
```
public final VCardCard[] getCards()
```

Gets an array of the cards extracted from the file.

**Returns:**
com.groupdocs.metadata.core.VCardCard[] - An array of the cards extracted from the file.

### VCardRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public abstract class VCardRecord extends VCardBasePackage
```

Represents abstract vCard record metadata class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getGroup() | Gets the grouping value. |
| getValueParameters() | Gets the value parameters. |
| getPrefParameter() | Gets the preferred parameter. |
| getAltIdParameter() | Gets the alternative representations parameter value. |
| getTypeParameters() | Gets the type parameter values. |
| getEncodingParameter() | Gets the encoding parameter value. |
| getLanguageParameter() | Gets the language parameter value. |
| getAnonymParameters() | Gets the anonymous parameters. |
| getContentType() | Gets the content type of record. |
| getTypeName() | Gets the type of the record. |
##### getGroup()
```
public final String getGroup()
```

Gets the grouping value.

**Returns:**
java.lang.String - The grouping value.
##### getValueParameters()
```
public final String[] getValueParameters()
```

Gets the value parameters.

**Returns:**
java.lang.String[] - The value parameters.

Used to identify the value type (data type) and format of the value.
##### getPrefParameter()
```
public final Integer getPrefParameter()
```

Gets the preferred parameter.

**Returns:**
java.lang.Integer - The preferred parameter.

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### getAltIdParameter()
```
public final String getAltIdParameter()
```

Gets the alternative representations parameter value.

**Returns:**
java.lang.String - The alternative representations parameter value.

Used to "tag" property instances as being alternative representations of the same logical property.
##### getTypeParameters()
```
public final String[] getTypeParameters()
```

Gets the type parameter values.

**Returns:**
java.lang.String[] - The type parameter values.

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### getEncodingParameter()
```
public final String getEncodingParameter()
```

Gets the encoding parameter value.

**Returns:**
java.lang.String - The encoding parameter value.
##### getLanguageParameter()
```
public final String getLanguageParameter()
```

Gets the language parameter value.

**Returns:**
java.lang.String - The language parameter value.
##### getAnonymParameters()
```
public final String[] getAnonymParameters()
```

Gets the anonymous parameters.

**Returns:**
java.lang.String[] - The anonymous parameters.
##### getContentType()
```
public abstract VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getTypeName()
```
public final String getTypeName()
```

Gets the type of the record.

**Returns:**
java.lang.String - The type of the record.

### VCardRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage
```
public class VCardRecordset extends VCardBasePackage
```

Provides a base vCard record union class.

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata

### VCardRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class VCardRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a VCard file.

This code sample demonstrates how to read metadata properties of a vCard file.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.InputVcf)) {
>          VCardRootPackage root = metadata.getRootPackageGeneric();
>          for (VCardCard vCard : root.getVCardPackage().getCards()) {
>              System.out.println(vCard.getIdentificationRecordset().getName());
>              PrintArray(vCard.getIdentificationRecordset().getFormattedNames());
>              PrintArray(vCard.getCommunicationRecordset().getEmails());
>              PrintArray(vCard.getCommunicationRecordset().getTelephones());
>              PrintArray(vCard.getDeliveryAddressingRecordset().getAddresses());
>              // ...
>          }
>      }
>  }
>  private static void PrintArray(String[] values) {
>      if (values != null) {
>          for (String value : values) {
>              System.out.println(value);
>          }
>      }
>  }
>
> ```
> ```

[Working with vCard metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+vCard+metadata
#### Methods

| Method | Description |
| --- | --- |
| getVCardPackage() | Gets the VCard metadata package. |
##### getVCardPackage()
```
public final VCardPackage getVCardPackage()
```

Gets the VCard metadata package.

**Returns:**
VCardPackage - The VCard metadata package.

### VCardSecurityRecordset
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardsecurityrecordset.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecordset
```
public class VCardSecurityRecordset extends VCardRecordset
```

Represents a set of Security vCard records. These properties are concerned with the security of communication pathways or access to the vCard.
#### Methods

| Method | Description |
| --- | --- |
| getAccessClassification() | Gets the sensitivity of the information in the vCard. |
| getPublicKeyRecords() | Gets the public keys or authentication certificates associated with the object. |
| getPublicKeyBinaryRecords() | Gets the public keys or authentication certificates associated with the object. |
| getBinaryPublicKeys() | Gets the public keys or authentication certificates associated with the object. |
| getPublicKeyUriRecords() | Gets the public keys or authentication certificates associated with the object. |
| getUriPublicKeys() | Gets the public keys or authentication certificates associated with the object. |
##### getAccessClassification()
```
public final String getAccessClassification()
```

Gets the sensitivity of the information in the vCard.

**Returns:**
java.lang.String - The sensitivity of the information in the vCard.
##### getPublicKeyRecords()
```
public final VCardRecord[] getPublicKeyRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardRecord[] - The public keys or authentication certificates associated with the object.
##### getPublicKeyBinaryRecords()
```
public final VCardBinaryRecord[] getPublicKeyBinaryRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardBinaryRecord[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyRecords .
##### getBinaryPublicKeys()
```
public final byte[][] getBinaryPublicKeys()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
byte[][] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyBinaryRecords .
##### getPublicKeyUriRecords()
```
public final VCardTextRecord[] getPublicKeyUriRecords()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
com.groupdocs.metadata.core.VCardTextRecord[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyRecords .
##### getUriPublicKeys()
```
public final String[] getUriPublicKeys()
```

Gets the public keys or authentication certificates associated with the object.

**Returns:**
java.lang.String[] - The public keys or authentication certificates associated with the object.

This property is a simplified version of  PublicKeyUriRecords .

### VCardTextRecord
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/vcardtextrecord.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.VCardBasePackage, com.groupdocs.metadata.core.VCardRecord

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IVCardRecord
```
public class VCardTextRecord extends VCardRecord implements IVCardRecord<String>
```

Represents vCard text record metadata class.
#### Methods

| Method | Description |
| --- | --- |
| getContentType() | Gets the content type of record. |
| getMediaTypeParameter() | Gets the media type parameter value. |
| getCharsetParameter() | Gets the charset parameter. |
| getValue() | Gets the record value. |
| isQuotedPrintable() | Gets a value indicating whether this instance is quoted printable string. |
| getReadabilityValue(String codePageName) | Gets the readability value. |
##### getContentType()
```
public VCardContentType getContentType()
```

Gets the content type of record.

**Returns:**
VCardContentType - The content type of record.
##### getMediaTypeParameter()
```
public final String getMediaTypeParameter()
```

Gets the media type parameter value.

**Returns:**
java.lang.String - The media type parameter value.

Used with properties whose value is a URI. It provides a hint to the vCard consumer application about the media type [RFC2046] of the resource identified by the URI.
##### getCharsetParameter()
```
public final String getCharsetParameter()
```

Gets the charset parameter.

**Returns:**
java.lang.String - The charset parameter.
##### getValue()
```
public final String getValue()
```

Gets the record value.

**Returns:**
java.lang.String - The record value.
##### isQuotedPrintable()
```
public final boolean isQuotedPrintable()
```

Gets a value indicating whether this instance is quoted printable string.

**Returns:**
boolean -  true  if this instance is quoted printable; otherwise,  false .
##### getReadabilityValue(String codePageName)
```
public final String getReadabilityValue(String codePageName)
```

Gets the readability value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| codePageName | java.lang.String | The using encoding code page name or null for ASCII encoding. |

**Returns:**
java.lang.String - The readability value.

### WavPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wavpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WavPackage extends CustomPackage
```

Represents a native metadata package in a WAV audio file.

This code sample shows how to extract technical audio information from a WAV file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputWav)) {
>      WavRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getWavPackage() != null) {
>          System.out.println(root.getWavPackage().getAudioFormat());
>          System.out.println(root.getWavPackage().getBitsPerSample());
>          System.out.println(root.getWavPackage().getBlockAlign());
>          System.out.println(root.getWavPackage().getByteRate());
>          System.out.println(root.getWavPackage().getNumberOfChannels());
>          System.out.println(root.getWavPackage().getSampleRate());
>      }
>  }
>
> ```
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| WavPackage() | Initializes a new instance of the  WavPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAudioFormat() | Gets the audio format. |
| getNumberOfChannels() | Gets the number of channels. |
| getSampleRate() | Gets the sample rate. |
| getByteRate() | Gets the byte rate. |
| getBlockAlign() | Gets the block align. |
| getBitsPerSample() | Gets the bits per sample value. |
##### WavPackage()
```
public WavPackage()
```

Initializes a new instance of the  WavPackage  class.

##### getAudioFormat()
```
public final int getAudioFormat()
```

Gets the audio format. PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression.

**Returns:**
int - The audio format.
##### getNumberOfChannels()
```
public final int getNumberOfChannels()
```

Gets the number of channels.

**Returns:**
int - The number of channels.
##### getSampleRate()
```
public final int getSampleRate()
```

Gets the sample rate.

**Returns:**
int - The sample rate.
##### getByteRate()
```
public final int getByteRate()
```

Gets the byte rate.

**Returns:**
int - The byte rate.
##### getBlockAlign()
```
public final int getBlockAlign()
```

Gets the block align.

**Returns:**
int - The block align.
##### getBitsPerSample()
```
public final int getBitsPerSample()
```

Gets the bits per sample value.

**Returns:**
int - The bits per sample value.

### WavRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wavrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp
```
public class WavRootPackage extends RootMetadataPackage implements IXmp
```

Represents the root package allowing working with metadata in a WAV audio.

This code sample shows how to extract technical audio information from a WAV file.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputWav)) {
>      WavRootPackage root = metadata.getRootPackageGeneric();
>      if (root.getWavPackage() != null) {
>          System.out.println(root.getWavPackage().getAudioFormat());
>          System.out.println(root.getWavPackage().getBitsPerSample());
>          System.out.println(root.getWavPackage().getBlockAlign());
>          System.out.println(root.getWavPackage().getByteRate());
>          System.out.println(root.getWavPackage().getNumberOfChannels());
>          System.out.println(root.getWavPackage().getSampleRate());
>      }
>  }
>
> ```
> ```
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getWavPackage() | Gets the WAV native metadata package. |
| getRiffInfoPackage() | Gets the package containing RIFF Info tags. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getWavPackage()
```
public final WavPackage getWavPackage()
```

Gets the WAV native metadata package.

**Returns:**
WavPackage - The WAV native metadata package.
##### getRiffInfoPackage()
```
public final RiffInfoPackage getRiffInfoPackage()
```

Gets the package containing RIFF Info tags.

**Returns:**
RiffInfoPackage - The package containing RIFF Info tags.

### WebPRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/webprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmp, com.groupdocs.metadata.core.IExif
```
public class WebPRootPackage extends ImageRootPackage implements IXmp, IExif
```

Represents the root package allowing working with metadata in a WEBP image.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Methods

| Method | Description |
| --- | --- |
| getXmpPackage() | Gets the XMP metadata package. |
| setXmpPackage(XmpPacketWrapper value) | Sets the XMP metadata package. |
| getExifPackage() | Gets the EXIF metadata package. |
| setExifPackage(ExifPackage value) | Sets the EXIF metadata package. |
##### getXmpPackage()
```
public final XmpPacketWrapper getXmpPackage()
```

Gets the XMP metadata package.

**Returns:**
XmpPacketWrapper - The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
##### setXmpPackage(XmpPacketWrapper value)
```
public final void setXmpPackage(XmpPacketWrapper value)
```

Sets the XMP metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPacketWrapper | The XMP metadata package.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata |

##### getExifPackage()
```
public final ExifPackage getExifPackage()
```

Gets the EXIF metadata package.

**Returns:**
ExifPackage - The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata
##### setExifPackage(ExifPackage value)
```
public final void setExifPackage(ExifPackage value)
```

Sets the EXIF metadata package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ExifPackage | The EXIF metadata package.

[Working with EXIF metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+EXIF+metadata |

### WmfRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wmfrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.ImageRootPackage
```
public class WmfRootPackage extends ImageRootPackage
```

Represents the root package intended to work with metadata in a WMF image.

### WordProcessingComment
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingcomment.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingComment extends CustomPackage
```

Represents a comment in a word processing document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getId() | Gets the comment id. |
| getAuthor() | Gets the author. |
| setAuthor(String value) | Sets the author. |
| getInitials() | Gets the author's initials. |
| setInitials(String value) | Sets the author's initials. |
| getText() | Gets the text of the comment. |
| setText(String value) | Sets the text of the comment. |
| getCreatedDate() | Gets the date the comment was created. |
| setCreatedDate(Date value) | Sets the date the comment was created. |
##### getId()
```
public final int getId()
```

Gets the comment id.

**Returns:**
int - The comment identifier.
##### getAuthor()
```
public final String getAuthor()
```

Gets the author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getInitials()
```
public final String getInitials()
```

Gets the author's initials.

**Returns:**
java.lang.String - The initials of the author.
##### setInitials(String value)
```
public final void setInitials(String value)
```

Sets the author's initials.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The initials of the author. |

##### getText()
```
public final String getText()
```

Gets the text of the comment.

**Returns:**
java.lang.String - The text of the comment.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text of the comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of the comment. |

##### getCreatedDate()
```
public final Date getCreatedDate()
```

Gets the date the comment was created.

**Returns:**
java.util.Date - The date the comment was created.
##### setCreatedDate(Date value)
```
public final void setCreatedDate(Date value)
```

Sets the date the comment was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the comment was created. |

### WordProcessingField
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingfield.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public class WordProcessingField extends CustomPackage
```

Represents a field in a word processing document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getCode() | Gets the field code. |
| getResult() | Gets the field result. |
##### getCode()
```
public final String getCode()
```

Gets the field code.

**Returns:**
java.lang.String - The field code.
##### getResult()
```
public final String getResult()
```

Gets the field result.

**Returns:**
java.lang.String - The field result.

### WordProcessingFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum WordProcessingFormat extends Enum<WordProcessingFormat> implements IEnumValue
```

Defines various word processing document subformats.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | The format is not recognized. |
| Doc | Represents the .DOC Word format. |
| Docm | Represents the .DOCM Word format. |
| Docx | Represents the .DOCX Word format. |
| Dot | Represents the .DOT Word format. |
| Dotx | Represents the .DOTX Word format. |
| Dotm | Represents the .DOTM Word format. |
| Odt | Represents the .ODT format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unknown
```
public static final WordProcessingFormat Unknown
```

The format is not recognized.

##### Doc
```
public static final WordProcessingFormat Doc
```

Represents the .DOC Word format. Files with .doc extension represent documents generated by Microsoft Word or other word processing applications in binary file format. The extension was initially used for plain text documentation on several different operating systems. It can contain several different types of data such as images, formatted as well as plain text, graphs, charts, embedded objects, links, pages, page formatting, print settings and a lot others. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/doc/

##### Docm
```
public static final WordProcessingFormat Docm
```

Represents the .DOCM Word format. DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. It is similar to DOCX file format but the ability to run macros makes it different from DOCX. Like DOCX, DOCM files can be store text, images, tables, shapes, charts and other contents. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docm/

##### Docx
```
public static final WordProcessingFormat Docx
```

Represents the .DOCX Word format. 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. Docx files can be opened with Word 2007 and lateral versions but not with the earlier versions of MS Word which support DOC file extensions. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/docx/

##### Dot
```
public static final WordProcessingFormat Dot
```

Represents the .DOT Word format. Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent files created from these. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dot/

##### Dotx
```
public static final WordProcessingFormat Dotx
```

Represents the .DOTX Word format. Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. A template file is created in order to have specific user settings that should be applied to subsequent flies created from these. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotx/

##### Dotm
```
public static final WordProcessingFormat Dotm
```

Represents the .DOTM Word format. A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. It is similar to the popular DOCX file format other than it retains the user defined settings for reuse in case of creating new documents. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dotm/

##### Odt
```
public static final WordProcessingFormat Odt
```

Represents the .ODT format. ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/odt/

##### values()
```
public static WordProcessingFormat[] values()
```

**Returns:**
com.groupdocs.metadata.core.WordProcessingFormat[]
##### valueOf(String name)
```
public static WordProcessingFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
WordProcessingFormat
##### getByRawValue(int rawValue)
```
public static WordProcessingFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
WordProcessingFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### WordProcessingInspectionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessinginspectionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingInspectionPackage extends CustomPackage
```

Contains information about document parts that can be considered as metadata in some cases.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets an array of the user comments. |
| getFields() | Gets an array of document fields. |
| getHiddenText() | Gets an array of hidden text fragments extracted from the document. |
| getDigitalSignatures() | Gets an array of digital signatures presented in the document. |
| getRevisions() | Gets an array of digital signatures presented in the document. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| clearComments() | Removes all detected user comments from the document. |
| clearFields() | Removes all detected fields from the document. |
| clearHiddenText() | Removes all hidden text fragments from the document. |
| acceptAllRevisions() | Accepts all detected revisions in the document. |
| rejectAllRevisions() | Rejects all detected revisions in the document. |
| sanitize() | Removes writable metadata properties from the package. |
##### getComments()
```
public final WordProcessingComment[] getComments()
```

Gets an array of the user comments.

**Returns:**
com.groupdocs.metadata.core.WordProcessingComment[] - The user comments.
##### getFields()
```
public final WordProcessingField[] getFields()
```

Gets an array of document fields.

**Returns:**
com.groupdocs.metadata.core.WordProcessingField[] - An array of document fields.
##### getHiddenText()
```
public final String[] getHiddenText()
```

Gets an array of hidden text fragments extracted from the document.

**Returns:**
java.lang.String[] - An array of hidden text fragments extracted from the document.
##### getDigitalSignatures()
```
public final DigitalSignature[] getDigitalSignatures()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.DigitalSignature[] - The digital signatures.
##### getRevisions()
```
public final WordProcessingRevision[] getRevisions()
```

Gets an array of digital signatures presented in the document.

**Returns:**
com.groupdocs.metadata.core.WordProcessingRevision[] - The digital signatures.
##### removeProperties(Specification specification)
```
public int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |

**Returns:**
int - The number of affected properties.
##### clearComments()
```
public final void clearComments()
```

Removes all detected user comments from the document.

##### clearFields()
```
public final void clearFields()
```

Removes all detected fields from the document.

##### clearHiddenText()
```
public final void clearHiddenText()
```

Removes all hidden text fragments from the document.

##### acceptAllRevisions()
```
public final void acceptAllRevisions()
```

Accepts all detected revisions in the document.

##### rejectAllRevisions()
```
public final void rejectAllRevisions()
```

Rejects all detected revisions in the document.

##### sanitize()
```
public int sanitize()
```

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

### WordProcessingPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.DocumentPackage
```
public class WordProcessingPackage extends DocumentPackage
```

Represents a native metadata package in a word processing document.

This code sample shows how to update built-in metadata properties in a WordProcessing document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDoc)) {
>      WordProcessingRootPackage root = metadata.getRootPackageGeneric();
>      root.getDocumentProperties().setAuthor("test author");
>      root.getDocumentProperties().setCreatedTime(new Date());
>      root.getDocumentProperties().setCompany("GroupDocs");
>      root.getDocumentProperties().setCategory("test category");
>      root.getDocumentProperties().setKeywords("metadata, built-in, update");
>      // ...
>      metadata.save(Constants.OutputDoc);
>  }
>
> ```
> ```

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the document's author. |
| setAuthor(String value) | Sets the document's author. |
| getBytesInDocument() | Gets an estimate of the number of bytes in the document. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getComments() | Gets the comments. |
| setComments(String value) | Sets the comments. |
| getCompany() | Gets the company. |
| setCompany(String value) | Sets the company. |
| getContentStatus() | Gets the content status. |
| setContentStatus(String value) | Sets the content status. |
| getContentType() | Gets the content type of the document. |
| setContentType(String value) | Sets the content type of the document. |
| getCreatedTime() | Gets the document created date. |
| setCreatedTime(Date value) | Sets the document created date. |
| getHyperlinkBase() | Gets the hyperlink base. |
| setHyperlinkBase(String value) | Sets the hyperlink base. |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getSubject() | Gets the subject. |
| setSubject(String value) | Sets the subject. |
| getTemplate() | Gets the template. |
| setTemplate(String value) | Sets the template. |
| getLastPrintedDate() | Gets the last printed date. |
| setLastPrintedDate(Date value) | Sets the last printed date. |
| getLastSavedBy() | Gets the name of the last author. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| getLastSavedTime() | Gets the time of the last save. |
| setLastSavedTime(Date value) | Sets the time of the last save. |
| getManager() | Gets the manager. |
| setManager(String value) | Sets the manager. |
| getNameOfApplication() | Gets the name of the application. |
| getRevisionNumber() | Gets the revision number. |
| setRevisionNumber(Integer value) | Sets the revision number. |
| getVersion() | Gets the version number of the application that created the document. |
| getTotalEditingTime() | Gets the total editing time in minutes. |
| setTotalEditingTime(Integer value) | Sets the total editing time in minutes. |
| getTitle() | Gets the title of the document. |
| setTitle(String value) | Sets the title of the document. |
| getLinksUpToDate() | Gets a value indicating whether the hyperlinks in the document are up-to-date. |
| setLinksUpToDate(Boolean value) | Sets a value indicating whether the hyperlinks in the document are up-to-date. |
| getTitlesOfParts() | Gets the titles of document parts. |
| getWords() | Gets an estimate of the number of words in the document. |
| set(String propertyName, String value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, boolean value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, Date value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, int value) | Adds or replaces the metadata property with the specified name. |
| set(String propertyName, double value) | Adds or replaces the metadata property with the specified name. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the document's author.

**Returns:**
java.lang.String - The author.
##### setAuthor(String value)
```
public final void setAuthor(String value)
```

Sets the document's author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The author. |

##### getBytesInDocument()
```
public final Integer getBytesInDocument()
```

Gets an estimate of the number of bytes in the document.

**Returns:**
java.lang.Integer - An estimate of the number of bytes in the document.
##### getCategory()
```
public final String getCategory()
```

Gets the category.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getComments()
```
public final String getComments()
```

Gets the comments.

**Returns:**
java.lang.String - The comments.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comments. |

##### getCompany()
```
public final String getCompany()
```

Gets the company.

**Returns:**
java.lang.String - The company.
##### setCompany(String value)
```
public final void setCompany(String value)
```

Sets the company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The company. |

##### getContentStatus()
```
public final String getContentStatus()
```

Gets the content status.

**Returns:**
java.lang.String - The content status.
##### setContentStatus(String value)
```
public final void setContentStatus(String value)
```

Sets the content status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The content status. |

##### getContentType()
```
public final String getContentType()
```

Gets the content type of the document.

**Returns:**
java.lang.String - The type of the content.
##### setContentType(String value)
```
public final void setContentType(String value)
```

Sets the content type of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the content. |

##### getCreatedTime()
```
public final Date getCreatedTime()
```

Gets the document created date.

**Returns:**
java.util.Date - The created time.
##### setCreatedTime(Date value)
```
public final void setCreatedTime(Date value)
```

Sets the document created date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The created time. |

##### getHyperlinkBase()
```
public final String getHyperlinkBase()
```

Gets the hyperlink base.

**Returns:**
java.lang.String - The hyperlink base.
##### setHyperlinkBase(String value)
```
public final void setHyperlinkBase(String value)
```

Sets the hyperlink base.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink base. |

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getSubject()
```
public final String getSubject()
```

Gets the subject.

**Returns:**
java.lang.String - The subject.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject. |

##### getTemplate()
```
public final String getTemplate()
```

Gets the template.

**Returns:**
java.lang.String - The template.
##### setTemplate(String value)
```
public final void setTemplate(String value)
```

Sets the template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The template. |

##### getLastPrintedDate()
```
public final Date getLastPrintedDate()
```

Gets the last printed date.

**Returns:**
java.util.Date - The last printed date.
##### setLastPrintedDate(Date value)
```
public final void setLastPrintedDate(Date value)
```

Sets the last printed date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last printed date. |

##### getLastSavedBy()
```
public final String getLastSavedBy()
```

Gets the name of the last author.

**Returns:**
java.lang.String - The name of the last author.
##### setLastSavedBy(String value)
```
public final void setLastSavedBy(String value)
```

Sets the name of the last author.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the last author. |

##### getLastSavedTime()
```
public final Date getLastSavedTime()
```

Gets the time of the last save.

**Returns:**
java.util.Date - The time of the last save.
##### setLastSavedTime(Date value)
```
public final void setLastSavedTime(Date value)
```

Sets the time of the last save.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The time of the last save. |

##### getManager()
```
public final String getManager()
```

Gets the manager.

**Returns:**
java.lang.String - The manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The manager. |

##### getNameOfApplication()
```
public final String getNameOfApplication()
```

Gets the name of the application.

**Returns:**
java.lang.String - The name of the application.
##### getRevisionNumber()
```
public final Integer getRevisionNumber()
```

Gets the revision number.

**Returns:**
java.lang.Integer - The revision number.
##### setRevisionNumber(Integer value)
```
public final void setRevisionNumber(Integer value)
```

Sets the revision number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The revision number. |

##### getVersion()
```
public final Integer getVersion()
```

Gets the version number of the application that created the document.

**Returns:**
java.lang.Integer - The version number of the application that created the document.

When a document was created by Microsoft Word, then high 16 bit represent the major version and low 16 bit represent the build number.
##### getTotalEditingTime()
```
public final Integer getTotalEditingTime()
```

Gets the total editing time in minutes.

**Returns:**
java.lang.Integer - The total editing time in minutes.
##### setTotalEditingTime(Integer value)
```
public final void setTotalEditingTime(Integer value)
```

Sets the total editing time in minutes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The total editing time in minutes. |

##### getTitle()
```
public final String getTitle()
```

Gets the title of the document.

**Returns:**
java.lang.String - The title of the document.
##### setTitle(String value)
```
public final void setTitle(String value)
```

Sets the title of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The title of the document. |

##### getLinksUpToDate()
```
public final Boolean getLinksUpToDate()
```

Gets a value indicating whether the hyperlinks in the document are up-to-date.

**Returns:**
java.lang.Boolean - A value indicating whether the hyperlinks in the document are up-to-date.
##### setLinksUpToDate(Boolean value)
```
public final void setLinksUpToDate(Boolean value)
```

Sets a value indicating whether the hyperlinks in the document are up-to-date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the hyperlinks in the document are up-to-date. |

##### getTitlesOfParts()
```
public final String[] getTitlesOfParts()
```

Gets the titles of document parts. Read-only.

**Returns:**
java.lang.String[] - The titles of document parts.
##### getWords()
```
public final Integer getWords()
```

Gets an estimate of the number of words in the document.

**Returns:**
java.lang.Integer - The number of words in the document.
##### set(String propertyName, String value)
```
public final void set(String propertyName, String value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.lang.String | The property value. |

##### set(String propertyName, boolean value)
```
public final void set(String propertyName, boolean value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | boolean | The property value. |

##### set(String propertyName, Date value)
```
public final void set(String propertyName, Date value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | java.util.Date | The property value. |

##### set(String propertyName, int value)
```
public final void set(String propertyName, int value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | int | The property value. |

##### set(String propertyName, double value)
```
public final void set(String propertyName, double value)
```

Adds or replaces the metadata property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The property name. |
| value | double | The property value. |

### WordProcessingRevision
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingrevision.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class WordProcessingRevision extends CustomPackage
```

Represents a revision (tracked change) in a document.

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Gets the author of the revision. |
| getDateTime() | Gets the date/time of the revision. |
| getRevisionType() | Gets the type of the revision. |
##### getAuthor()
```
public final String getAuthor()
```

Gets the author of the revision.

**Returns:**
java.lang.String - The author of the revision.
##### getDateTime()
```
public final Date getDateTime()
```

Gets the date/time of the revision.

**Returns:**
java.util.Date - The date/time of the revision.
##### getRevisionType()
```
public final WordProcessingRevisionType getRevisionType()
```

Gets the type of the revision.

**Returns:**
WordProcessingRevisionType - The type of the revision.

### WordProcessingRevisionType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingrevisiontype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum WordProcessingRevisionType extends Enum<WordProcessingRevisionType> implements IEnumValue
```

Specifies the type of the change being tracked by a revision.
#### Fields

| Field | Description |
| --- | --- |
| Insertion | New content was inserted into the document. |
| Deletion | Content was removed from the document. |
| FormatChange | Change of formatting was applied to the parent node. |
| StyleDefinitionChange | Change of formatting was applied to the parent style. |
| Moving | Content was moved in the document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Insertion
```
public static final WordProcessingRevisionType Insertion
```

New content was inserted into the document.

##### Deletion
```
public static final WordProcessingRevisionType Deletion
```

Content was removed from the document.

##### FormatChange
```
public static final WordProcessingRevisionType FormatChange
```

Change of formatting was applied to the parent node.

##### StyleDefinitionChange
```
public static final WordProcessingRevisionType StyleDefinitionChange
```

Change of formatting was applied to the parent style.

##### Moving
```
public static final WordProcessingRevisionType Moving
```

Content was moved in the document.

##### values()
```
public static WordProcessingRevisionType[] values()
```

**Returns:**
com.groupdocs.metadata.core.WordProcessingRevisionType[]
##### valueOf(String name)
```
public static WordProcessingRevisionType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
WordProcessingRevisionType
##### getByRawValue(int rawValue)
```
public static WordProcessingRevisionType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
WordProcessingRevisionType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### WordProcessingRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingrootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage, com.groupdocs.metadata.core.DocumentRootPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IDublinCore
```
public class WordProcessingRootPackage extends DocumentRootPackage<WordProcessingPackage> implements IDublinCore
```

Represents the root package allowing working with metadata in a word processing document.

This code sample demonstrates how to read built-in metadata properties of a WordProcessing document.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>      WordProcessingRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getDocumentProperties().getAuthor());
>      System.out.println(root.getDocumentProperties().getCreatedTime());
>      System.out.println(root.getDocumentProperties().getCompany());
>      System.out.println(root.getDocumentProperties().getCategory());
>      System.out.println(root.getDocumentProperties().getKeywords());
>      // ...
>  }
>
> ```
> ```

[Working with metadata in WordProcessing documents]: https://docs.groupdocs.com/display/metadatajava/Working+with+metadata+in+Word+Processing+documents
#### Methods

| Method | Description |
| --- | --- |
| getWordProcessingType() | Gets the file type metadata package. |
| getDublinCorePackage() | Gets the Dublin Core metadata package extracted from the document. |
| getInspectionPackage() | Gets a metadata package containing inspection results for the document. |
| getDocumentStatistics() | Gets the document statistics package. |
| updateDocumentStatistics() | Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages. |
##### getWordProcessingType()
```
public final WordProcessingTypePackage getWordProcessingType()
```

Gets the file type metadata package.

**Returns:**
WordProcessingTypePackage - The file type metadata package.
##### getDublinCorePackage()
```
public final DublinCorePackage getDublinCorePackage()
```

Gets the Dublin Core metadata package extracted from the document.

**Returns:**
DublinCorePackage - The Dublin Core metadata package extracted from the document.
##### getInspectionPackage()
```
public final WordProcessingInspectionPackage getInspectionPackage()
```

Gets a metadata package containing inspection results for the document. The package contains information about document parts that can be considered as metadata in some cases.

**Returns:**
WordProcessingInspectionPackage - A metadata package containing inspection results for the document.
##### getDocumentStatistics()
```
public final DocumentStatistics getDocumentStatistics()
```

Gets the document statistics package.

**Returns:**
DocumentStatistics - The document statistics package.
##### updateDocumentStatistics()
```
public final void updateDocumentStatistics()
```

Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages.

### WordProcessingTypePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/wordprocessingtypepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.FileTypePackage
```
public class WordProcessingTypePackage extends FileTypePackage
```

Represents a metadata package containing document-specific file format information.
#### Methods

| Method | Description |
| --- | --- |
| getWordProcessingFormat() | Gets the exact word processing format. |
##### getWordProcessingFormat()
```
public final WordProcessingFormat getWordProcessingFormat()
```

Gets the exact word processing format.

**Returns:**
WordProcessingFormat - The exact word processing format.

### XmpArray
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmparray.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpArray extends XmpValueBase
```

Represents base abstraction for XMP array.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpArray(XmpArrayType arrayType, XmpValueBase[] items) | Initializes a new instance of the  XmpArray  class. |
| XmpArray(XmpArrayType arrayType, XmpComplexType[] items) | Initializes a new instance of the  XmpArray  class. |
#### Methods

| Method | Description |
| --- | --- |
| getArrayType() | Gets the type of the XMP array. |
| <T>from(T[] array, XmpArrayType type) | Creates an  XmpArray  instance form an array of  XmpComplexType . |
| from(String[] array, XmpArrayType type) | Creates an  XmpArray  instance form a string array. |
| from(int[] array, XmpArrayType type) | Creates an  XmpArray  instance form an integer array. |
| from(Date[] array, XmpArrayType type) | Creates an  XmpArray  instance form a date array. |
| from(double[] array, XmpArrayType type) | Creates an  XmpArray  instance form a double array. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
| <T>toPlatformArray(Class<T> type) | Converts the  XmpArray  to a platform-specific array. |
##### XmpArray(XmpArrayType arrayType, XmpValueBase[] items)
```
public XmpArray(XmpArrayType arrayType, XmpValueBase[] items)
```

Initializes a new instance of the  XmpArray  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpValueBase\[\] | Array items. |

##### XmpArray(XmpArrayType arrayType, XmpComplexType[] items)
```
public XmpArray(XmpArrayType arrayType, XmpComplexType[] items)
```

Initializes a new instance of the  XmpArray  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arrayType | XmpArrayType | Array type. |
| items | XmpComplexType\[\] | Array items. |

##### getArrayType()
```
public final XmpArrayType getArrayType()
```

Gets the type of the XMP array.

**Returns:**
XmpArrayType - The type of the XMP array.
##### <T>from(T[] array, XmpArrayType type)
```
public static XmpArray <T>from(T[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form an array of  XmpComplexType .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | T[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray .

 T : The element type of the source array. |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(String[] array, XmpArrayType type)
```
public static XmpArray from(String[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a string array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | java.lang.String[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(int[] array, XmpArrayType type)
```
public static XmpArray from(int[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form an integer array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | int[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(Date[] array, XmpArrayType type)
```
public static XmpArray from(Date[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a date array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | java.util.Date[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### from(double[] array, XmpArrayType type)
```
public static XmpArray from(double[] array, XmpArrayType type)
```

Creates an  XmpArray  instance form a double array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | double[] | The array to create an  XmpArray  from. |
| type | XmpArrayType | The type of the  XmpArray . |

**Returns:**
XmpArray - An  XmpArray  containing all the elements from the original array.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.
##### <T>toPlatformArray(Class<T> type)
```
public final T[] <T>toPlatformArray(Class<T> type)
```

Converts the  XmpArray  to a platform-specific array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T[] - A platform-specific array containing elements of the  XmpArray .

 T : The type of the array element.

### XmpArrayType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmparraytype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpArrayType extends Enum<XmpArrayType> implements IEnumValue
```

Represents array type in  XmpArray .
#### Fields

| Field | Description |
| --- | --- |
| Unordered | An unordered array. |
| Ordered | An ordered array. |
| Alternative | An alternative array. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Unordered
```
public static final XmpArrayType Unordered
```

An unordered array.

##### Ordered
```
public static final XmpArrayType Ordered
```

An ordered array.

##### Alternative
```
public static final XmpArrayType Alternative
```

An alternative array.

##### values()
```
public static XmpArrayType[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpArrayType[]
##### valueOf(String name)
```
public static XmpArrayType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpArrayType
##### getByRawValue(int rawValue)
```
public static XmpArrayType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpArrayType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpAudioChannelType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpaudiochanneltype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpAudioChannelType extends XmpClosedChoice<String>
```

Represents audio channel type.
#### Methods

| Method | Description |
| --- | --- |
| getMono() | Gets mono audio channel. |
| getStereo() | Gets stereo audio channel. |
| getAudio51() | Gets 5.1 audio channel. |
| getAudio71() | Gets 7.1 audio channel. |
| getAudio16Channel() | Gets 16 audio channel. |
| getOtherChannel() | Gets other channel. |
##### getMono()
```
public static XmpAudioChannelType getMono()
```

Gets mono audio channel.

**Returns:**
XmpAudioChannelType - The mono.
##### getStereo()
```
public static XmpAudioChannelType getStereo()
```

Gets stereo audio channel.

**Returns:**
XmpAudioChannelType - The stereo.
##### getAudio51()
```
public static XmpAudioChannelType getAudio51()
```

Gets 5.1 audio channel.

**Returns:**
XmpAudioChannelType - The audio 5.1.
##### getAudio71()
```
public static XmpAudioChannelType getAudio71()
```

Gets 7.1 audio channel.

**Returns:**
XmpAudioChannelType - The audio 7.1.
##### getAudio16Channel()
```
public static XmpAudioChannelType getAudio16Channel()
```

Gets 16 audio channel.

**Returns:**
XmpAudioChannelType - 16 channel audio.
##### getOtherChannel()
```
public static XmpAudioChannelType getOtherChannel()
```

Gets other channel.

**Returns:**
XmpAudioChannelType - The other channel.

### XmpAudioSampleType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpaudiosampletype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpAudioSampleType extends XmpClosedChoice<String>
```

Represents Audio sample type in  XmpDynamicMediaPackage .
#### Methods

| Method | Description |
| --- | --- |
| getSample8Int() | Gets 8Int audio sample. |
| getSample16Int() | Gets 16Int audio sample. |
| getSample24Int() | Gets 24Int audio sample. |
| getSample32Int() | Gets 32Int audio sample. |
| getSample32Float() | Gets 32Float audio sample. |
| getCompressed() | Gets Compressed audio sample. |
| getPacked() | Gets Packed audio sample. |
| getOther() | Gets Other audio sample. |
##### getSample8Int()
```
public static XmpAudioSampleType getSample8Int()
```

Gets 8Int audio sample.

**Returns:**
XmpAudioSampleType - 8Int.
##### getSample16Int()
```
public static XmpAudioSampleType getSample16Int()
```

Gets 16Int audio sample.

**Returns:**
XmpAudioSampleType - 16Int.
##### getSample24Int()
```
public static XmpAudioSampleType getSample24Int()
```

Gets 24Int audio sample.

**Returns:**
XmpAudioSampleType - 24Int.
##### getSample32Int()
```
public static XmpAudioSampleType getSample32Int()
```

Gets 32Int audio sample.

**Returns:**
XmpAudioSampleType - 32Int.
##### getSample32Float()
```
public static XmpAudioSampleType getSample32Float()
```

Gets 32Float audio sample.

**Returns:**
XmpAudioSampleType - 32Float.
##### getCompressed()
```
public static XmpAudioSampleType getCompressed()
```

Gets Compressed audio sample.

**Returns:**
XmpAudioSampleType - The compressed audio.
##### getPacked()
```
public static XmpAudioSampleType getPacked()
```

Gets Packed audio sample.

**Returns:**
XmpAudioSampleType - The packed audio.
##### getOther()
```
public static XmpAudioSampleType getOther()
```

Gets Other audio sample.

**Returns:**
XmpAudioSampleType - The packed audio.

### XmpBasicJobTicketPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpbasicjobticketpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpBasicJobTicketPackage extends XmpPackage
```

Represents Basic Job-Ticket namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBasicJobTicketPackage() | Initializes a new instance of the  XmpBasicJobTicketPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getJobs() | Gets the jobs. |
| setJobs(XmpJob[] value) | Sets the jobs. |
##### XmpBasicJobTicketPackage()
```
public XmpBasicJobTicketPackage()
```

Initializes a new instance of the  XmpBasicJobTicketPackage  class.

##### getJobs()
```
public final XmpJob[] getJobs()
```

Gets the jobs.

**Returns:**
com.groupdocs.metadata.core.XmpJob[] - The jobs.
##### setJobs(XmpJob[] value)
```
public final void setJobs(XmpJob[] value)
```

Sets the jobs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpJob\[\] | The jobs. |

### XmpBasicPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpbasicpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpBasicPackage extends XmpPackage
```

Represents the XMP basic namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBasicPackage() | Initializes a new instance of the  XmpBasicPackage  class. |
#### Fields

| Field | Description |
| --- | --- |
| RatingRejected | Rating rejected value. |
| RatingMin | Rating min value. |
| RatingMax | Rating max value. |
#### Methods

| Method | Description |
| --- | --- |
| getBaseUrl() | Gets the base URL for relative URLs in the document content. |
| setBaseUrl(String value) | Sets the base URL for relative URLs in the document content. |
| getCreateDate() | Gets the date and time the resource was created. |
| setCreateDate(Date value) | Sets the date and time the resource was created. |
| getCreatorTool() | Gets the name of the tool used to create the resource. |
| setCreatorTool(String value) | Sets the name of the tool used to create the resource. |
| getIdentifiers() | Gets an unordered array of text strings that unambiguously identify the resource within a given context. |
| setIdentifiers(String[] value) | Sets an unordered array of text strings that unambiguously identify the resource within a given context. |
| getLabel() | Gets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| setLabel(String value) | Sets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| getMetadataDate() | Gets the date and time that any metadata for this resource was last changed. |
| setMetadataDate(Date value) | Sets the date and time that any metadata for this resource was last changed. |
| getModifyDate() | Gets the date and time the resource was last modified. |
| setModifyDate(Date value) | Sets the date and time the resource was last modified. |
| getNickname() | Gets a short informal name for the resource. |
| setNickname(String value) | Sets a short informal name for the resource. |
| getRating() | Gets a user-assigned rating for this file. |
| setRating(double value) | Sets a user-assigned rating for this file. |
| getThumbnails() | Gets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| setThumbnails(XmpThumbnail[] value) | Sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| set(String name, String value) | Adds string property. |
##### XmpBasicPackage()
```
public XmpBasicPackage()
```

Initializes a new instance of the  XmpBasicPackage  class.

##### RatingRejected
```
public static final float RatingRejected
```

Rating rejected value.

##### RatingMin
```
public static final float RatingMin
```

Rating min value.

##### RatingMax
```
public static final float RatingMax
```

Rating max value.

##### getBaseUrl()
```
public final String getBaseUrl()
```

Gets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL.

**Returns:**
java.lang.String - The base URL.
##### setBaseUrl(String value)
```
public final void setBaseUrl(String value)
```

Sets the base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, they are relative to this base URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The base URL. |

##### getCreateDate()
```
public final Date getCreateDate()
```

Gets the date and time the resource was created.

**Returns:**
java.util.Date - The resource creation date.
##### setCreateDate(Date value)
```
public final void setCreateDate(Date value)
```

Sets the date and time the resource was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The resource creation date. |

##### getCreatorTool()
```
public final String getCreatorTool()
```

Gets the name of the tool used to create the resource.

**Returns:**
java.lang.String - The name of the tool used to create the resource.
##### setCreatorTool(String value)
```
public final void setCreatorTool(String value)
```

Sets the name of the tool used to create the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the tool used to create the resource. |

##### getIdentifiers()
```
public final String[] getIdentifiers()
```

Gets an unordered array of text strings that unambiguously identify the resource within a given context.

**Returns:**
java.lang.String[] - An array of the identifiers.
##### setIdentifiers(String[] value)
```
public final void setIdentifiers(String[] value)
```

Sets an unordered array of text strings that unambiguously identify the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the identifiers. |

##### getLabel()
```
public final String getLabel()
```

Gets a word or short phrase that identifies the resource as a member of a user-defined collection.

**Returns:**
java.lang.String - The label of the resource.
##### setLabel(String value)
```
public final void setLabel(String value)
```

Sets a word or short phrase that identifies the resource as a member of a user-defined collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The label of the resource. |

##### getMetadataDate()
```
public final Date getMetadataDate()
```

Gets the date and time that any metadata for this resource was last changed.

**Returns:**
java.util.Date - The metadata date.
##### setMetadataDate(Date value)
```
public final void setMetadataDate(Date value)
```

Sets the date and time that any metadata for this resource was last changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The metadata date. |

##### getModifyDate()
```
public final Date getModifyDate()
```

Gets the date and time the resource was last modified.

**Returns:**
java.util.Date - The last modification date.
##### setModifyDate(Date value)
```
public final void setModifyDate(Date value)
```

Sets the date and time the resource was last modified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last modification date. |

##### getNickname()
```
public final String getNickname()
```

Gets a short informal name for the resource.

**Returns:**
java.lang.String - The nickname.
##### setNickname(String value)
```
public final void setNickname(String value)
```

Sets a short informal name for the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The nickname. |

##### getRating()
```
public final double getRating()
```

Gets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates \\u201crejected\\u201d and 0 indicates \\u201cunrated\\u201d.

**Returns:**
double - The rating.
##### setRating(double value)
```
public final void setRating(double value)
```

Sets a user-assigned rating for this file. The value shall be -1 or in the range [0..5], where -1 indicates \\u201crejected\\u201d and 0 indicates \\u201cunrated\\u201d.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rating. |

##### getThumbnails()
```
public final XmpThumbnail[] getThumbnails()
```

Gets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.

**Returns:**
com.groupdocs.metadata.core.XmpThumbnail[] - The thumbnails.
##### setThumbnails(XmpThumbnail[] value)
```
public final void setThumbnails(XmpThumbnail[] value)
```

Sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpThumbnail\[\] | The thumbnails. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Adds string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XmpBasic key. |
| value | java.lang.String | String value. |

### XmpBoolean
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpboolean.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpBoolean extends XmpValueBase
```

Represents XMP Boolean basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpBoolean(boolean value) | Initializes a new instance of the  XmpBoolean  class based on boolean value. |
| XmpBoolean() | Initializes a new instance of the  XmpBoolean  class with default value. |
| XmpBoolean(String value) | Initializes a new instance of the  XmpBoolean  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpBoolean(boolean value)
```
public XmpBoolean(boolean value)
```

Initializes a new instance of the  XmpBoolean  class based on boolean value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  bool  value. |

##### XmpBoolean()
```
public XmpBoolean()
```

Initializes a new instance of the  XmpBoolean  class with default value.

##### XmpBoolean(String value)
```
public XmpBoolean(String value)
```

Initializes a new instance of the  XmpBoolean  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final boolean getValue()
```

Gets the value.

**Returns:**
boolean - Boolean value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  String  contained XMP representation.

### XmpCameraRawPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcamerarawpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpCameraRawPackage extends XmpPackage
```

Represents Camera Raw schema.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpCameraRawPackage() | Initializes a new instance of the  XmpCameraRawPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAutoBrightness() | Gets the AutoBrightness value. |
| setAutoBrightness(Boolean value) | Sets the AutoBrightness value. |
| getAutoContrast() | Gets the AutoContrast value. |
| setAutoContrast(Boolean value) | Sets the AutoContrast value. |
| getAutoExposure() | Gets the AutoExposure value. |
| setAutoExposure(Boolean value) | Sets the AutoExposure value. |
| getAutoShadows() | Gets the AutoShadows value. |
| setAutoShadows(Boolean value) | Sets the AutoShadows value. |
| getBlueHue() | Gets the BlueHue value. |
| setBlueHue(Integer value) | Sets the BlueHue value. |
| getBlueSaturation() | Gets the BlueSaturation. |
| setBlueSaturation(Integer value) | Sets the BlueSaturation. |
| getBrightness() | Gets the Brightness value. |
| setBrightness(Integer value) | Sets the Brightness value. |
| getCameraProfile() | Gets the CameraProfile value. |
| setCameraProfile(String value) | Sets the CameraProfile value. |
| getChromaticAberrationB() | Gets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. |
| setChromaticAberrationB(Integer value) | Sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. |
| getChromaticAberrationR() | Gets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. |
| setChromaticAberrationR(Integer value) | Sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. |
| getColorNoiseReduction() | Gets the Color Noise Reduction setting. |
| setColorNoiseReduction(Integer value) | Sets the Color Noise Reduction setting. |
| getContrast() | Gets the Contrast setting. |
| setContrast(Integer value) | Sets the Contrast setting. |
| getCropTop() | Gets the CropTop setting. |
| setCropTop(Double value) | Sets the CropTop setting. |
| getCropLeft() | Gets the CropLeft setting. |
| setCropLeft(Double value) | Sets the CropLeft setting. |
| getCropBottom() | Gets the CropBottom setting. |
| setCropBottom(Double value) | Sets the CropBottom setting. |
| getCropRight() | Gets the CropRight setting. |
| setCropRight(Double value) | Sets the CropRight setting. |
| getCropAngle() | Gets the CropAngle setting. |
| setCropAngle(Double value) | Sets the CropAngle setting. |
| getCropWidth() | Gets the width of the resulting cropped image in  CropUnits  units. |
| setCropWidth(Double value) | Sets the width of the resulting cropped image in  CropUnits  units. |
| getCropHeight() | Gets the height of the resulting cropped image in  CropUnits  units. |
| setCropHeight(Double value) | Sets the height of the resulting cropped image in  CropUnits  units. |
| getCropUnits() | Gets units for  CropWidth  and  CropHeight . |
| setCropUnits(XmpCropUnit value) | Sets units for  CropWidth  and  CropHeight . |
| getExposure() | Gets the Exposure setting. |
| setExposure(Double value) | Sets the Exposure setting. |
| getGreenHue() | Gets the Green Hue setting. |
| setGreenHue(Integer value) | Sets the Green Hue setting. |
| getGreenSaturation() | Gets the Green Saturation setting. |
| setGreenSaturation(Integer value) | Sets the Green Saturation setting. |
| hasCrop() | Gets or sets the HasCrop value. |
| setCrop(Boolean value) | Sets the HasCrop value. |
| hasSettings() | Gets or sets HasSettings value. |
| setSettings(Boolean value) | Sets HasSettings value. |
| getLuminanceSmoothing() | Gets the LuminanceSmoothing setting. |
| setLuminanceSmoothing(Integer value) | Sets the LuminanceSmoothing setting. |
| getRawFileName() | Gets the file name for a raw file (not a complete path). |
| setRawFileName(String value) | Sets the file name for a raw file (not a complete path). |
| getRedHue() | Gets the Red Hue setting. |
| setRedHue(Integer value) | Sets the Red Hue setting. |
| getRedSaturation() | Gets the Red Saturation setting. |
| setRedSaturation(Integer value) | Sets the Red Saturation setting. |
| getSaturation() | Gets the Saturation setting. |
| setSaturation(Integer value) | Sets the Saturation setting. |
| getShadows() | Gets the Shadows setting. |
| setShadows(Integer value) | Sets the Shadows setting. |
| getShadowTint() | Gets the ShadowTint setting. |
| setShadowTint(Integer value) | Sets the ShadowTint setting. |
| getSharpness() | Gets the Sharpness setting. |
| setSharpness(Integer value) | Sets the Sharpness setting. |
| getTemperature() | Gets the Temperature setting. |
| setTemperature(Integer value) | Sets the Temperature setting. |
| getTint() | Gets the Tint setting. |
| setTint(Integer value) | Sets the Tint setting. |
| getVersion() | Gets the version of the Camera Raw plug-in. |
| setVersion(String value) | Sets the version of the Camera Raw plug-in. |
| getVignetteAmount() | Gets the Vignette Amount setting. |
| setVignetteAmount(Integer value) | Sets the Vignette Amount setting. |
| getVignetteMidpoint() | Gets the Vignetting Midpoint setting. |
| setVignetteMidpoint(Integer value) | Sets the Vignetting Midpoint setting. |
| getWhiteBalance() | Gets White Balance setting. |
| set(String name, String value) | Adds string property. |
| setWhiteBalance(XmpWhiteBalance whiteBalance) | Sets the white balance. |
##### XmpCameraRawPackage()
```
public XmpCameraRawPackage()
```

Initializes a new instance of the  XmpCameraRawPackage  class.

##### getAutoBrightness()
```
public final Boolean getAutoBrightness()
```

Gets the AutoBrightness value. When true,  Brightness  is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic brightness]; otherwise,  false .
##### setAutoBrightness(Boolean value)
```
public final void setAutoBrightness(Boolean value)
```

Sets the AutoBrightness value. When true,  Brightness  is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic brightness]; otherwise,  false . |

##### getAutoContrast()
```
public final Boolean getAutoContrast()
```

Gets the AutoContrast value. When true, "Contrast" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic contrast]; otherwise,  false .
##### setAutoContrast(Boolean value)
```
public final void setAutoContrast(Boolean value)
```

Sets the AutoContrast value. When true, "Contrast" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic contrast]; otherwise,  false . |

##### getAutoExposure()
```
public final Boolean getAutoExposure()
```

Gets the AutoExposure value. When true, "Exposure" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic exposure]; otherwise,  false .
##### setAutoExposure(Boolean value)
```
public final void setAutoExposure(Boolean value)
```

Sets the AutoExposure value. When true, "Exposure" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic exposure]; otherwise,  false . |

##### getAutoShadows()
```
public final Boolean getAutoShadows()
```

Gets the AutoShadows value. When true, "Shadows" is automatically adjusted.

**Returns:**
java.lang.Boolean -  true  if [automatic shadows]; otherwise,  false .
##### setAutoShadows(Boolean value)
```
public final void setAutoShadows(Boolean value)
```

Sets the AutoShadows value. When true, "Shadows" is automatically adjusted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if [automatic shadows]; otherwise,  false . |

##### getBlueHue()
```
public final Integer getBlueHue()
```

Gets the BlueHue value. Null if undefined.

**Returns:**
java.lang.Integer - The blue hue.
##### setBlueHue(Integer value)
```
public final void setBlueHue(Integer value)
```

Sets the BlueHue value. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue hue. |

##### getBlueSaturation()
```
public final Integer getBlueSaturation()
```

Gets the BlueSaturation. Null if undefined.

**Returns:**
java.lang.Integer - The blue saturation.
##### setBlueSaturation(Integer value)
```
public final void setBlueSaturation(Integer value)
```

Sets the BlueSaturation. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue saturation. |

##### getBrightness()
```
public final Integer getBrightness()
```

Gets the Brightness value. Null if undefined.

**Returns:**
java.lang.Integer - The brightness.
##### setBrightness(Integer value)
```
public final void setBrightness(Integer value)
```

Sets the Brightness value. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The brightness. |

##### getCameraProfile()
```
public final String getCameraProfile()
```

Gets the CameraProfile value.

**Returns:**
java.lang.String - The camera profile.
##### setCameraProfile(String value)
```
public final void setCameraProfile(String value)
```

Sets the CameraProfile value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The camera profile. |

##### getChromaticAberrationB()
```
public final Integer getChromaticAberrationB()
```

Gets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.

**Returns:**
java.lang.Integer - The chromatic aberration B.
##### setChromaticAberrationB(Integer value)
```
public final void setChromaticAberrationB(Integer value)
```

Sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The chromatic aberration B. |

##### getChromaticAberrationR()
```
public final Integer getChromaticAberrationR()
```

Gets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.

**Returns:**
java.lang.Integer - The chromatic aberration R.
##### setChromaticAberrationR(Integer value)
```
public final void setChromaticAberrationR(Integer value)
```

Sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The chromatic aberration R. |

##### getColorNoiseReduction()
```
public final Integer getColorNoiseReduction()
```

Gets the Color Noise Reduction setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The color noise reduction.
##### setColorNoiseReduction(Integer value)
```
public final void setColorNoiseReduction(Integer value)
```

Sets the Color Noise Reduction setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The color noise reduction. |

##### getContrast()
```
public final Integer getContrast()
```

Gets the Contrast setting. Range -50 to 100.

**Returns:**
java.lang.Integer - The contrast.
##### setContrast(Integer value)
```
public final void setContrast(Integer value)
```

Sets the Contrast setting. Range -50 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The contrast. |

##### getCropTop()
```
public final Double getCropTop()
```

Gets the CropTop setting. When HasCrop is true, top of the crop rectangle.

**Returns:**
java.lang.Double - The crop top.
##### setCropTop(Double value)
```
public final void setCropTop(Double value)
```

Sets the CropTop setting. When HasCrop is true, top of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop top. |

##### getCropLeft()
```
public final Double getCropLeft()
```

Gets the CropLeft setting. When HasCrop is true, left of the crop rectangle.

**Returns:**
java.lang.Double - The crop left.
##### setCropLeft(Double value)
```
public final void setCropLeft(Double value)
```

Sets the CropLeft setting. When HasCrop is true, left of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop left. |

##### getCropBottom()
```
public final Double getCropBottom()
```

Gets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.

**Returns:**
java.lang.Double - The crop bottom.
##### setCropBottom(Double value)
```
public final void setCropBottom(Double value)
```

Sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop bottom. |

##### getCropRight()
```
public final Double getCropRight()
```

Gets the CropRight setting. When HasCrop is true, right of the crop rectangle.

**Returns:**
java.lang.Double - The crop right.
##### setCropRight(Double value)
```
public final void setCropRight(Double value)
```

Sets the CropRight setting. When HasCrop is true, right of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop right. |

##### getCropAngle()
```
public final Double getCropAngle()
```

Gets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.

**Returns:**
java.lang.Double - The crop angle.
##### setCropAngle(Double value)
```
public final void setCropAngle(Double value)
```

Sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The crop angle. |

##### getCropWidth()
```
public final Double getCropWidth()
```

Gets the width of the resulting cropped image in  CropUnits  units.

**Returns:**
java.lang.Double - The width of the crop.
##### setCropWidth(Double value)
```
public final void setCropWidth(Double value)
```

Sets the width of the resulting cropped image in  CropUnits  units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The width of the crop. |

##### getCropHeight()
```
public final Double getCropHeight()
```

Gets the height of the resulting cropped image in  CropUnits  units.

**Returns:**
java.lang.Double - The height of the crop.
##### setCropHeight(Double value)
```
public final void setCropHeight(Double value)
```

Sets the height of the resulting cropped image in  CropUnits  units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The height of the crop. |

##### getCropUnits()
```
public final XmpCropUnit getCropUnits()
```

Gets units for  CropWidth  and  CropHeight .

**Returns:**
XmpCropUnit - The crop units.
##### setCropUnits(XmpCropUnit value)
```
public final void setCropUnits(XmpCropUnit value)
```

Sets units for  CropWidth  and  CropHeight .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpCropUnit | The crop units. |

##### getExposure()
```
public final Double getExposure()
```

Gets the Exposure setting.

**Returns:**
java.lang.Double - The exposure.
##### setExposure(Double value)
```
public final void setExposure(Double value)
```

Sets the Exposure setting.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The exposure. |

##### getGreenHue()
```
public final Integer getGreenHue()
```

Gets the Green Hue setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The green hue.
##### setGreenHue(Integer value)
```
public final void setGreenHue(Integer value)
```

Sets the Green Hue setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green hue. |

##### getGreenSaturation()
```
public final Integer getGreenSaturation()
```

Gets the Green Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The green saturation.
##### setGreenSaturation(Integer value)
```
public final void setGreenSaturation(Integer value)
```

Sets the Green Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green saturation. |

##### hasCrop()
```
public final Boolean hasCrop()
```

Gets or sets the HasCrop value. When true, the image has a cropping rectangle.

**Returns:**
java.lang.Boolean -  true  if the image has a cropping rectangle; otherwise,  false .
##### setCrop(Boolean value)
```
public final void setCrop(Boolean value)
```

Sets the HasCrop value. When true, the image has a cropping rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the image has a cropping rectangle; otherwise,  false . |

##### hasSettings()
```
public final Boolean hasSettings()
```

Gets or sets HasSettings value. When true, non-default camera raw settings.

**Returns:**
java.lang.Boolean -  true  if image has non-default camera raw settings; otherwise,  false .
##### setSettings(Boolean value)
```
public final void setSettings(Boolean value)
```

Sets HasSettings value. When true, non-default camera raw settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if image has non-default camera raw settings; otherwise,  false . |

##### getLuminanceSmoothing()
```
public final Integer getLuminanceSmoothing()
```

Gets the LuminanceSmoothing setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The luminance smoothing.
##### setLuminanceSmoothing(Integer value)
```
public final void setLuminanceSmoothing(Integer value)
```

Sets the LuminanceSmoothing setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The luminance smoothing. |

##### getRawFileName()
```
public final String getRawFileName()
```

Gets the file name for a raw file (not a complete path).

**Returns:**
java.lang.String - The name of the raw file.
##### setRawFileName(String value)
```
public final void setRawFileName(String value)
```

Sets the file name for a raw file (not a complete path).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the raw file. |

##### getRedHue()
```
public final Integer getRedHue()
```

Gets the Red Hue setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The red hue.
##### setRedHue(Integer value)
```
public final void setRedHue(Integer value)
```

Sets the Red Hue setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red hue. |

##### getRedSaturation()
```
public final Integer getRedSaturation()
```

Gets the Red Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The red saturation.
##### setRedSaturation(Integer value)
```
public final void setRedSaturation(Integer value)
```

Sets the Red Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red saturation. |

##### getSaturation()
```
public final Integer getSaturation()
```

Gets the Saturation setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The saturation.
##### setSaturation(Integer value)
```
public final void setSaturation(Integer value)
```

Sets the Saturation setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The saturation. |

##### getShadows()
```
public final Integer getShadows()
```

Gets the Shadows setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The shadows.
##### setShadows(Integer value)
```
public final void setShadows(Integer value)
```

Sets the Shadows setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The shadows. |

##### getShadowTint()
```
public final Integer getShadowTint()
```

Gets the ShadowTint setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The shadow tint.
##### setShadowTint(Integer value)
```
public final void setShadowTint(Integer value)
```

Sets the ShadowTint setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The shadow tint. |

##### getSharpness()
```
public final Integer getSharpness()
```

Gets the Sharpness setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The sharpness.
##### setSharpness(Integer value)
```
public final void setSharpness(Integer value)
```

Sets the Sharpness setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The sharpness. |

##### getTemperature()
```
public final Integer getTemperature()
```

Gets the Temperature setting. Range 2000 to 50000.

**Returns:**
java.lang.Integer - The temperature.
##### setTemperature(Integer value)
```
public final void setTemperature(Integer value)
```

Sets the Temperature setting. Range 2000 to 50000.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The temperature. |

##### getTint()
```
public final Integer getTint()
```

Gets the Tint setting. Range -150 to 150.

**Returns:**
java.lang.Integer - The tint.
##### setTint(Integer value)
```
public final void setTint(Integer value)
```

Sets the Tint setting. Range -150 to 150.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The tint. |

##### getVersion()
```
public final String getVersion()
```

Gets the version of the Camera Raw plug-in.

**Returns:**
java.lang.String - The version.
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the version of the Camera Raw plug-in.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The version. |

##### getVignetteAmount()
```
public final Integer getVignetteAmount()
```

Gets the Vignette Amount setting. Range -100 to 100.

**Returns:**
java.lang.Integer - The vignette amount.
##### setVignetteAmount(Integer value)
```
public final void setVignetteAmount(Integer value)
```

Sets the Vignette Amount setting. Range -100 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The vignette amount. |

##### getVignetteMidpoint()
```
public final Integer getVignetteMidpoint()
```

Gets the Vignetting Midpoint setting. Range 0 to 100.

**Returns:**
java.lang.Integer - The Vignette Midpoint.
##### setVignetteMidpoint(Integer value)
```
public final void setVignetteMidpoint(Integer value)
```

Sets the Vignetting Midpoint setting. Range 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The Vignette Midpoint. |

##### getWhiteBalance()
```
public final String getWhiteBalance()
```

Gets White Balance setting. Use  SetWhiteBalance  to set white balance value.

**Returns:**
java.lang.String - The white balance.
##### set(String name, String value)
```
public void set(String name, String value)
```

Adds string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata key. |
| value | java.lang.String | XMP metadata value. |

##### setWhiteBalance(XmpWhiteBalance whiteBalance)
```
public final void setWhiteBalance(XmpWhiteBalance whiteBalance)
```

Sets the white balance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whiteBalance | XmpWhiteBalance | The white balance. |

### XmpClosedChoice
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpclosedchoice.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public abstract class XmpClosedChoice<T> implements System.IEquatable<XmpClosedChoice<T>>
```

Represents XMP Closed Choice.

 T : Type of closed choice.
#### Methods

| Method | Description |
| --- | --- |
| hashCode() | Returns a hash code for this instance. |
| equals(Object obj) | Indicates whether the current object is equal to another object of the same type. |
| equals(XmpClosedChoice<T> other) | Indicates whether the current object is equal to another object of the same type. |
| toString() | Returns a  String  that represents this instance. |
##### hashCode()
```
public int hashCode()
```

Returns a hash code for this instance.

**Returns:**
int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  obj  parameter; otherwise, false.
##### equals(XmpClosedChoice<T> other)
```
public final boolean equals(XmpClosedChoice<T> other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | XmpClosedChoice | An object to compare with this object. |

**Returns:**
boolean - true if the current object is equal to the  other  parameter; otherwise, false.
##### toString()
```
public String toString()
```

Returns a  String  that represents this instance.

**Returns:**
java.lang.String - A  String  that represents this instance.

### XmpColorantBase
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolorantbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public class XmpColorantBase extends XmpComplexType
```

A structure containing the characteristics of a colorant (swatch) used in a document.
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the colour space in which the colour is defined. |
| getSwatchName() | Gets the name of the swatch. |
| setSwatchName(String value) | Sets the name of the swatch. |
| getColorType() | Gets the type of color. |
| setColorType(XmpColorType value) | Sets the type of color. |
##### getMode()
```
public final XmpColorantColorMode getMode()
```

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.

**Returns:**
XmpColorantColorMode - The color mode.
##### getSwatchName()
```
public final String getSwatchName()
```

Gets the name of the swatch.

**Returns:**
java.lang.String - The name of the swatch.
##### setSwatchName(String value)
```
public final void setSwatchName(String value)
```

Sets the name of the swatch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the swatch. |

##### getColorType()
```
public final XmpColorType getColorType()
```

Gets the type of color.

**Returns:**
XmpColorType - The color type.
##### setColorType(XmpColorType value)
```
public final void setColorType(XmpColorType value)
```

Sets the type of color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorType | The color type. |

### XmpColorantCmyk
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolorantcmyk.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantCmyk extends XmpColorantBase
```

Represents the CMYK Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantCmyk() | Initializes a new instance of the  XmpColorantCmyk  class. |
| XmpColorantCmyk(double cyan, double magenta, double yellow, double black) | Initializes a new instance of the  XmpColorantCmyk  class. |
#### Fields

| Field | Description |
| --- | --- |
| ColorValueMax | Color max value in CMYK colorant. |
| ColorValueMin | Color min value in CMYK colorant. |
#### Methods

| Method | Description |
| --- | --- |
| getBlack() | Gets the black component. |
| setBlack(Double value) | Sets the black component. |
| getCyan() | Gets the cyan component. |
| setCyan(Double value) | Sets the cyan component. |
| getMagenta() | Gets the magenta component. |
| setMagenta(Double value) | Sets the magenta component. |
| getYellow() | Gets the yellow component. |
| setYellow(Double value) | Sets the yellow component. |
##### XmpColorantCmyk()
```
public XmpColorantCmyk()
```

Initializes a new instance of the  XmpColorantCmyk  class.

##### XmpColorantCmyk(double cyan, double magenta, double yellow, double black)
```
public XmpColorantCmyk(double cyan, double magenta, double yellow, double black)
```

Initializes a new instance of the  XmpColorantCmyk  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cyan | double | Cyan component. |
| magenta | double | Magenta component. |
| yellow | double | Yellow component. |
| black | double | Black component. |

##### ColorValueMax
```
public static final double ColorValueMax
```

Color max value in CMYK colorant.

##### ColorValueMin
```
public static final double ColorValueMin
```

Color min value in CMYK colorant.

##### getBlack()
```
public final Double getBlack()
```

Gets the black component.

**Returns:**
java.lang.Double - The black value.
##### setBlack(Double value)
```
public final void setBlack(Double value)
```

Sets the black component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The black value. |

##### getCyan()
```
public final Double getCyan()
```

Gets the cyan component.

**Returns:**
java.lang.Double - The cyan value.
##### setCyan(Double value)
```
public final void setCyan(Double value)
```

Sets the cyan component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The cyan value. |

##### getMagenta()
```
public final Double getMagenta()
```

Gets the magenta component.

**Returns:**
java.lang.Double - The magenta value.
##### setMagenta(Double value)
```
public final void setMagenta(Double value)
```

Sets the magenta component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The magenta value. |

##### getYellow()
```
public final Double getYellow()
```

Gets the yellow component.

**Returns:**
java.lang.Double - The yellow value.
##### setYellow(Double value)
```
public final void setYellow(Double value)
```

Sets the yellow component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The yellow value. |

### XmpColorantColorMode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolorantcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpColorantColorMode extends Enum<XmpColorantColorMode> implements IEnumValue
```

Represents color mode in  XmpColorantBase .
#### Fields

| Field | Description |
| --- | --- |
| Undefined | The color mode is undefined. |
| Cmyk | CMYK color mode. |
| Rgb | RGB color mode. |
| Lab | LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Undefined
```
public static final XmpColorantColorMode Undefined
```

The color mode is undefined.

##### Cmyk
```
public static final XmpColorantColorMode Cmyk
```

CMYK color mode.

##### Rgb
```
public static final XmpColorantColorMode Rgb
```

RGB color mode.

##### Lab
```
public static final XmpColorantColorMode Lab
```

LAB color mode.

##### values()
```
public static XmpColorantColorMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpColorantColorMode[]
##### valueOf(String name)
```
public static XmpColorantColorMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpColorantColorMode
##### getByRawValue(int rawValue)
```
public static XmpColorantColorMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpColorantColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpColorantLab
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolorantlab.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantLab extends XmpColorantBase
```

Represents the LAB Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantLab() | Initializes a new instance of the  XmpColorantLab  class. |
| XmpColorantLab(byte a, byte b, double l) | Initializes a new instance of the  XmpColorantLab  class. |
#### Fields

| Field | Description |
| --- | --- |
| MinL | Component L min value. |
| MaxL | Component L max value. |
#### Methods

| Method | Description |
| --- | --- |
| getA() | Gets the A component. |
| setA(Byte value) | Sets the A component. |
| getB() | Gets the B component. |
| setB(Byte value) | Sets the B component. |
| getL() | Gets the L component. |
| setL(Double value) | Sets the L component. |
##### XmpColorantLab()
```
public XmpColorantLab()
```

Initializes a new instance of the  XmpColorantLab  class.

##### XmpColorantLab(byte a, byte b, double l)
```
public XmpColorantLab(byte a, byte b, double l)
```

Initializes a new instance of the  XmpColorantLab  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | byte | A component. |
| b | byte | B component. |
| l | double | L component. |

##### MinL
```
public static final double MinL
```

Component L min value.

##### MaxL
```
public static final double MaxL
```

Component L max value.

##### getA()
```
public final Byte getA()
```

Gets the A component.

**Returns:**
java.lang.Byte - The A component.
##### setA(Byte value)
```
public final void setA(Byte value)
```

Sets the A component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte | The A component. |

##### getB()
```
public final Byte getB()
```

Gets the B component.

**Returns:**
java.lang.Byte - The B component.
##### setB(Byte value)
```
public final void setB(Byte value)
```

Sets the B component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Byte | The B component. |

##### getL()
```
public final Double getL()
```

Gets the L component.

**Returns:**
java.lang.Double - The L component.
##### setL(Double value)
```
public final void setL(Double value)
```

Sets the L component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The L component. |

### XmpColorantRgb
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolorantrgb.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType, com.groupdocs.metadata.core.XmpColorantBase
```
public final class XmpColorantRgb extends XmpColorantBase
```

Represents the RGB Colorant.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpColorantRgb() | Initializes a new instance of the  XmpColorantRgb  class. |
| XmpColorantRgb(int red, int green, int blue) | Initializes a new instance of the  XmpColorantRgb  class. |
#### Methods

| Method | Description |
| --- | --- |
| getRed() | Gets the red component. |
| setRed(Integer value) | Sets the red component. |
| getGreen() | Gets the green value. |
| setGreen(Integer value) | Sets the green value. |
| getBlue() | Gets the blue component. |
| setBlue(Integer value) | Sets the blue component. |
##### XmpColorantRgb()
```
public XmpColorantRgb()
```

Initializes a new instance of the  XmpColorantRgb  class.

##### XmpColorantRgb(int red, int green, int blue)
```
public XmpColorantRgb(int red, int green, int blue)
```

Initializes a new instance of the  XmpColorantRgb  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | Red component. |
| green | int | Green component. |
| blue | int | Blue component. |

##### getRed()
```
public final Integer getRed()
```

Gets the red component.

**Returns:**
java.lang.Integer - The red component.
##### setRed(Integer value)
```
public final void setRed(Integer value)
```

Sets the red component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The red component. |

##### getGreen()
```
public final Integer getGreen()
```

Gets the green value.

**Returns:**
java.lang.Integer - The green component.
##### setGreen(Integer value)
```
public final void setGreen(Integer value)
```

Sets the green value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The green component. |

##### getBlue()
```
public final Integer getBlue()
```

Gets the blue component.

**Returns:**
java.lang.Integer - The blue component.
##### setBlue(Integer value)
```
public final void setBlue(Integer value)
```

Sets the blue component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The blue component. |

### XmpColorType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcolortype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpColorType extends Enum<XmpColorType> implements IEnumValue
```

Type of color in  XmpColorantBase .
#### Fields

| Field | Description |
| --- | --- |
| Process | The Process color type. |
| Spot | The Spot color type. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Process
```
public static final XmpColorType Process
```

The Process color type.

##### Spot
```
public static final XmpColorType Spot
```

The Spot color type.

##### values()
```
public static XmpColorType[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpColorType[]
##### valueOf(String name)
```
public static XmpColorType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpColorType
##### getByRawValue(int rawValue)
```
public static XmpColorType getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpColorType
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpComplexType
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcomplextype.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer
```
public class XmpComplexType extends XmpMetadataContainer
```

Represents base abstraction for XMP Complex value type.

See more: XMP Specification Part 2, Chapter 1.2.2
#### Methods

| Method | Description |
| --- | --- |
| getPrefixes() | Gets the namespace prefixes that are used in the  XmpComplexType  instance. |
| getNamespaceUris() | Gets the namespace URIs that are used in the  XmpComplexType  instance. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
| toString() | Returns a  String  that represents this instance. |
| getNamespaceUri(String prefix) | Gets the namespace URI associated with the specified prefix. |
##### getPrefixes()
```
public final String[] getPrefixes()
```

Gets the namespace prefixes that are used in the  XmpComplexType  instance.

**Returns:**
java.lang.String[] - The namespace prefixes.
##### getNamespaceUris()
```
public final String[] getNamespaceUris()
```

Gets the namespace URIs that are used in the  XmpComplexType  instance.

**Returns:**
java.lang.String[] - The namespace URIs.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.
##### toString()
```
public String toString()
```

Returns a  String  that represents this instance.

**Returns:**
java.lang.String - A  String  that represents this instance.
##### getNamespaceUri(String prefix)
```
public final String getNamespaceUri(String prefix)
```

Gets the namespace URI associated with the specified prefix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| prefix | java.lang.String | The prefix of the namespace to get. |

**Returns:**
java.lang.String - The associated namespace URI if the prefix is registered; otherwise, null.

### XmpComplexTypeValue
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcomplextypevalue.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpComplexTypeValue extends XmpValueBase
```

Represents an XMP value containing a complex type instance.
#### Methods

| Method | Description |
| --- | --- |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpCropUnit
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpcropunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpCropUnit extends Enum<XmpCropUnit> implements IEnumValue
```

Represent a unit for CropWidth and CropHeight in  XmpCameraRawPackage .
#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels units. |
| Inches | Inches units. |
| Cm | Centimeters units. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Pixels
```
public static final XmpCropUnit Pixels
```

Pixels units.

##### Inches
```
public static final XmpCropUnit Inches
```

Inches units.

##### Cm
```
public static final XmpCropUnit Cm
```

Centimeters units.

##### values()
```
public static XmpCropUnit[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpCropUnit[]
##### valueOf(String name)
```
public static XmpCropUnit valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpCropUnit
##### getByRawValue(int rawValue)
```
public static XmpCropUnit getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpCropUnit
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpDate
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpdate.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpDate extends XmpValueBase
```

Represents Date in XMP packet.

A date-time value is represented using a subset of the formats as defined in Date and Time Formats: YYYY YYYY-MM YYYY-MM-DD YYYY-MM-DDThh:mmTZD YYYY-MM-DDThh:mm:ssTZD YYYY-MM-DDThh:mm:ss.sTZD
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDate(Date dateTime) | Initializes a new instance of the  XmpDate  class. |
| XmpDate(String dateString) | Initializes a new instance of the  XmpDate  class. |
#### Fields

| Field | Description |
| --- | --- |
| Iso8601Format | The ISO 8601 (roundtrip) format string. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getFormat() | Gets format string for current value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpDate(Date dateTime)
```
public XmpDate(Date dateTime)
```

Initializes a new instance of the  XmpDate  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateTime | java.util.Date |  DateTime  value. |

##### XmpDate(String dateString)
```
public XmpDate(String dateString)
```

Initializes a new instance of the  XmpDate  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateString | java.lang.String | Date in string representation. |

##### Iso8601Format
```
public static final String Iso8601Format
```

The ISO 8601 (roundtrip) format string.

See more: https://en.wikipedia.org/wiki/ISO\_8601.

##### getValue()
```
public final Date getValue()
```

Gets the value.

**Returns:**
java.util.Date - DateTime value.
##### getFormat()
```
public final String getFormat()
```

Gets format string for current value.

**Returns:**
java.lang.String - XMP date format string.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpDimensions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpdimensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpDimensions extends XmpComplexType
```

Containing dimensions for a drawn object.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDimensions() | Initializes a new instance of the  XmpDimensions  class. |
| XmpDimensions(double width, double height) | Initializes a new instance of the  XmpDimensions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width. |
| setWidth(Double value) | Sets the width. |
| getHeight() | Gets the height. |
| setHeight(Double value) | Sets the height. |
| getUnits() | Gets the units. |
| setUnits(String value) | Sets the units. |
##### XmpDimensions()
```
public XmpDimensions()
```

Initializes a new instance of the  XmpDimensions  class.

##### XmpDimensions(double width, double height)
```
public XmpDimensions(double width, double height)
```

Initializes a new instance of the  XmpDimensions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | double | The width. |
| height | double | The height. |

##### getWidth()
```
public final Double getWidth()
```

Gets the width.

**Returns:**
java.lang.Double - The width.
##### setWidth(Double value)
```
public final void setWidth(Double value)
```

Sets the width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The width. |

##### getHeight()
```
public final Double getHeight()
```

Gets the height.

**Returns:**
java.lang.Double - The height.
##### setHeight(Double value)
```
public final void setHeight(Double value)
```

Sets the height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The height. |

##### getUnits()
```
public final String getUnits()
```

Gets the units.

**Returns:**
java.lang.String - The units.
##### setUnits(String value)
```
public final void setUnits(String value)
```

Sets the units.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The units. |

### XmpDublinCorePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpdublincorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpDublinCorePackage extends XmpPackage
```

Represents the Dublin Core scheme.

For more information see: http://dublincore.org/documents/usageguide/elements.shtml.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDublinCorePackage() | Initializes a new instance of the  XmpDublinCorePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getContributors() | Gets an array of the contributors. |
| setContributors(String[] value) | Sets an array of the contributors. |
| getCoverage() | Gets the extent or scope of the resource. |
| setCoverage(String value) | Sets the extent or scope of the resource. |
| getCreators() | Gets an array of the creators. |
| setCreators(String[] value) | Sets an array of the creators. |
| getDates() | Gets an array of dates associated with an event in the life cycle of the resource. |
| setDates(Date[] value) | Sets an array of dates associated with an event in the life cycle of the resource. |
| getDescriptions() | Gets an array of textual descriptions of the content of the resource, given in various languages. |
| setDescriptions(XmpLangAlt value) | Sets an array of textual descriptions of the content of the resource, given in various languages. |
| getFormat() | Gets the MIME type of the resource. |
| setFormat(String value) | Sets the MIME type of the resource. |
| getIdentifier() | Gets a string value representing an unambiguous reference to the resource within a given context. |
| setIdentifier(String value) | Sets a string value representing an unambiguous reference to the resource within a given context. |
| getLanguages() | Gets an array of languages used in the content of the resource. |
| setLanguages(String[] value) | Sets an array of languages used in the content of the resource. |
| getPublishers() | Gets an array of publishers made the resource available. |
| setPublishers(String[] value) | Sets an array of publishers made the resource available. |
| getRelations() | Gets an array of the related resources. |
| setRelations(String[] value) | Sets an array of the related resources. |
| getRights() | Gets an array of the informal rights statements, given in various languages. |
| setRights(XmpLangAlt value) | Sets an array of the informal rights statements, given in various languages. |
| getSource() | Gets the related resource from which the described resource is derived. |
| setSource(String value) | Sets the related resource from which the described resource is derived. |
| getSubjects() | Gets an array of descriptive phrases or keywords that specify the content of the resource. |
| setSubjects(String[] value) | Sets an array of descriptive phrases or keywords that specify the content of the resource. |
| getTitles() | Gets the title or name of the resource, given in various languages. |
| setTitles(XmpLangAlt value) | Sets the title or name of the resource, given in various languages. |
| getTypes() | Gets an array of string values representing the nature or genre of the resource. |
| setTypes(String[] value) | Sets an array of string values representing the nature or genre of the resource. |
| setContributor(String contributor) | Sets a single contributor of the resource. |
| setCreator(String creator) | Sets a single creator of the resource. |
| setDate(Date date) | Sets a single date associated with the resource. |
| setDescription(String description) | Sets the resource description, given in a single laguage. |
| setLanguage(String language) | Sets a single language associated with the resource. |
| setPublisher(String publisher) | Sets a single publisher of the resource. |
| setRelation(String relation) | Sets a single related resource. |
| setRights(String rights) | Sets the resource rights, given in a single laguage. |
| setSubject(String subject) | Sets a single subject of the resource. |
| setTitle(String title) | Sets the resource title, given in a single laguage. |
| setType(String type) | Sets a single type of the resource. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpDublinCorePackage()
```
public XmpDublinCorePackage()
```

Initializes a new instance of the  XmpDublinCorePackage  class.

##### getContributors()
```
public final String[] getContributors()
```

Gets an array of the contributors.

**Returns:**
java.lang.String[] - An array of the contributors.

These contributors should not include those listed in dc:creator.
##### setContributors(String[] value)
```
public final void setContributors(String[] value)
```

Sets an array of the contributors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the contributors.

These contributors should not include those listed in dc:creator. |

##### getCoverage()
```
public final String getCoverage()
```

Gets the extent or scope of the resource.

**Returns:**
java.lang.String - The extent or scope of the resource.
##### setCoverage(String value)
```
public final void setCoverage(String value)
```

Sets the extent or scope of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The extent or scope of the resource. |

##### getCreators()
```
public final String[] getCreators()
```

Gets an array of the creators.

**Returns:**
java.lang.String[] - An array of the creators.

Entities should be listed in order of decreasing precedence, if such order is significant. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity.
##### setCreators(String[] value)
```
public final void setCreators(String[] value)
```

Sets an array of the creators.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the creators.

Entities should be listed in order of decreasing precedence, if such order is significant. Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity. |

##### getDates()
```
public final Date[] getDates()
```

Gets an array of dates associated with an event in the life cycle of the resource.

**Returns:**
java.util.Date[] - A point or period of time associated with an event in the life cycle of the resource.
##### setDates(Date[] value)
```
public final void setDates(Date[] value)
```

Sets an array of dates associated with an event in the life cycle of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date[] | A point or period of time associated with an event in the life cycle of the resource. |

##### getDescriptions()
```
public final XmpLangAlt getDescriptions()
```

Gets an array of textual descriptions of the content of the resource, given in various languages.

**Returns:**
XmpLangAlt - An array of textual descriptions of the content of the resource, given in various languages.
##### setDescriptions(XmpLangAlt value)
```
public final void setDescriptions(XmpLangAlt value)
```

Sets an array of textual descriptions of the content of the resource, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | An array of textual descriptions of the content of the resource, given in various languages. |

##### getFormat()
```
public final String getFormat()
```

Gets the MIME type of the resource.

**Returns:**
java.lang.String - The MIME type of the resource.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the MIME type of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The MIME type of the resource. |

##### getIdentifier()
```
public final String getIdentifier()
```

Gets a string value representing an unambiguous reference to the resource within a given context.

**Returns:**
java.lang.String - A string value representing an unambiguous reference to the resource within a given context.

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
##### setIdentifier(String value)
```
public final void setIdentifier(String value)
```

Sets a string value representing an unambiguous reference to the resource within a given context.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A string value representing an unambiguous reference to the resource within a given context.

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system. |

##### getLanguages()
```
public final String[] getLanguages()
```

Gets an array of languages used in the content of the resource.

**Returns:**
java.lang.String[] - An array of languages used in the content of the resource.
##### setLanguages(String[] value)
```
public final void setLanguages(String[] value)
```

Sets an array of languages used in the content of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of languages used in the content of the resource. |

##### getPublishers()
```
public final String[] getPublishers()
```

Gets an array of publishers made the resource available.

**Returns:**
java.lang.String[] - An array of publishers made the resource available.

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity.
##### setPublishers(String[] value)
```
public final void setPublishers(String[] value)
```

Sets an array of publishers made the resource available.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of publishers made the resource available.

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity. |

##### getRelations()
```
public final String[] getRelations()
```

Gets an array of the related resources.

**Returns:**
java.lang.String[] - An array of the related resources.

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### setRelations(String[] value)
```
public final void setRelations(String[] value)
```

Sets an array of the related resources.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of the related resources.

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. |

##### getRights()
```
public final XmpLangAlt getRights()
```

Gets an array of the informal rights statements, given in various languages.

**Returns:**
XmpLangAlt - An array of the informal rights statements, given in various languages.

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.
##### setRights(XmpLangAlt value)
```
public final void setRights(XmpLangAlt value)
```

Sets an array of the informal rights statements, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | An array of the informal rights statements, given in various languages.

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights. |

##### getSource()
```
public final String getSource()
```

Gets the related resource from which the described resource is derived.

**Returns:**
java.lang.String - The related resource from which the described resource is derived.

The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets the related resource from which the described resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The related resource from which the described resource is derived.

The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system. |

##### getSubjects()
```
public final String[] getSubjects()
```

Gets an array of descriptive phrases or keywords that specify the content of the resource.

**Returns:**
java.lang.String[] - An array of descriptive phrases or keywords that specify the content of the resource.
##### setSubjects(String[] value)
```
public final void setSubjects(String[] value)
```

Sets an array of descriptive phrases or keywords that specify the content of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of descriptive phrases or keywords that specify the content of the resource. |

##### getTitles()
```
public final XmpLangAlt getTitles()
```

Gets the title or name of the resource, given in various languages.

**Returns:**
XmpLangAlt - The title or name of the resource, given in various languages.
##### setTitles(XmpLangAlt value)
```
public final void setTitles(XmpLangAlt value)
```

Sets the title or name of the resource, given in various languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The title or name of the resource, given in various languages. |

##### getTypes()
```
public final String[] getTypes()
```

Gets an array of string values representing the nature or genre of the resource.

**Returns:**
java.lang.String[] - An array of string values representing the nature or genre of the resource.
##### setTypes(String[] value)
```
public final void setTypes(String[] value)
```

Sets an array of string values representing the nature or genre of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | An array of string values representing the nature or genre of the resource. |

##### setContributor(String contributor)
```
public final void setContributor(String contributor)
```

Sets a single contributor of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contributor | java.lang.String | The contributor to set. |

##### setCreator(String creator)
```
public final void setCreator(String creator)
```

Sets a single creator of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| creator | java.lang.String | The creator to set. |

##### setDate(Date date)
```
public final void setDate(Date date)
```

Sets a single date associated with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| date | java.util.Date | The date to set. |

##### setDescription(String description)
```
public final void setDescription(String description)
```

Sets the resource description, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | The description to set. |

##### setLanguage(String language)
```
public final void setLanguage(String language)
```

Sets a single language associated with the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language to set. |

##### setPublisher(String publisher)
```
public final void setPublisher(String publisher)
```

Sets a single publisher of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publisher | java.lang.String | The publisher to set. |

##### setRelation(String relation)
```
public final void setRelation(String relation)
```

Sets a single related resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relation | java.lang.String | The relation to set. |

##### setRights(String rights)
```
public final void setRights(String rights)
```

Sets the resource rights, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rights | java.lang.String | The rights statements to set. |

##### setSubject(String subject)
```
public final void setSubject(String subject)
```

Sets a single subject of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subject | java.lang.String | The subject to set. |

##### setTitle(String title)
```
public final void setTitle(String title)
```

Sets the resource title, given in a single laguage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | The title to set. |

##### setType(String type)
```
public final void setType(String type)
```

Sets a single type of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.String | The type to set. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpDynamicMediaPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpdynamicmediapackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpDynamicMediaPackage extends XmpPackage
```

Represents XMP Dynamic Media namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpDynamicMediaPackage() | Initializes a new instance of the  XmpDynamicMediaPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAbsPeakAudioFilePath() | Gets the absolute path to the file\\u2019s peak audio file. |
| setAbsPeakAudioFilePath(String value) | Sets the absolute path to the file\\u2019s peak audio file. |
| getAlbum() | Gets the name of the album. |
| setAlbum(String value) | Sets the name of the album. |
| getAltTapeName() | Gets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| setAltTapeName(String value) | Sets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| getAltTimecode() | Gets the timecode set by the user. |
| setAltTimecode(XmpTimecode value) | Sets the timecode set by the user. |
| getArtist() | Gets the name of the artist or artists. |
| setArtist(String value) | Sets the name of the artist or artists. |
| getAudioChannelType() | Gets the audio channel type. |
| setAudioChannelType(String value) | Sets the audio channel type. |
| getAudioCompressor() | Gets the audio compression used. |
| setAudioCompressor(String value) | Sets the audio compression used. |
| getAudioSampleRate() | Gets the audio sample rate. |
| setAudioSampleRate(Integer value) | Sets the audio sample rate. |
| getAudioSampleType() | Gets the audio sample type. |
| setAudioSampleType(String value) | Sets the audio sample type. |
| getCameraAngle() | Gets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| setCameraAngle(String value) | Sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| getCameraLabel() | Gets the description of the camera used for a shoot. |
| setCameraLabel(String value) | Sets the description of the camera used for a shoot. |
| getCameraModel() | Gets the make and model of the camera used for a shoot. |
| setCameraModel(String value) | Sets the make and model of the camera used for a shoot. |
| getCameraMove() | Gets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| setCameraMove(String value) | Sets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| getClient() | Gets the client for the job of which this shot or take is a part. |
| setClient(String value) | Sets the client for the job of which this shot or take is a part. |
| getComment() | Gets the user\\u2019s comments. |
| setComment(String value) | Sets the user\\u2019s comments. |
| getComposer() | Gets the composer\\u2019s names. |
| setComposer(String value) | Sets the composer\\u2019s names. |
| getDirector() | Gets the director of the scene. |
| setDirector(String value) | Sets the director of the scene. |
| getDirectorPhotography() | Gets the director of photography for the scene. |
| setDirectorPhotography(String value) | Sets the director of photography for the scene. |
| getDuration() | Gets the duration of the media file. |
| setDuration(XmpTime value) | Sets the duration of the media file. |
| getEngineer() | Gets the engineer's names. |
| setEngineer(String value) | Sets the engineer's names. |
| getFileDataRate() | Gets the file data rate in megabytes per second. |
| setFileDataRate(XmpRational value) | Sets the file data rate in megabytes per second. |
| getGenre() | Gets the name of the genres. |
| setGenre(String value) | Sets the name of the genres. |
| getGood() | Gets a value indicating whether the shot is a keeper. |
| setGood(Boolean value) | Sets a value indicating whether the shot is a keeper. |
| getInstrument() | Gets the musical instruments. |
| setInstrument(String value) | Sets the musical instruments. |
| getIntroTime() | Gets the duration of lead time for queuing music. |
| setIntroTime(XmpTime value) | Sets the duration of lead time for queuing music. |
| getKey() | Gets the audio\\u2019s musical key. |
| setKey(String value) | Sets the audio\\u2019s musical key. |
| getLogComment() | Gets the user\\u2019s log comments. |
| setLogComment(String value) | Sets the user\\u2019s log comments. |
| getLoop() | Gets a value indicating whether the clip can be looped seamlessly. |
| setLoop(Boolean value) | Sets a value indicating whether the clip can be looped seamlessly. |
| getNumberOfBeats() | Gets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| setNumberOfBeats(Double value) | Sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| getOutCue() | Gets the time at which to fade out. |
| setOutCue(XmpTime value) | Sets the time at which to fade out. |
| getProjectName() | Gets the name of the project of which this file is a part. |
| setProjectName(String value) | Sets the name of the project of which this file is a part. |
| getRelativeTimestamp() | Gets the start time of the media inside the audio project. |
| setRelativeTimestamp(XmpTime value) | Sets the start time of the media inside the audio project. |
| getReleaseDate() | Gets the date the title was released. |
| setReleaseDate(Date value) | Sets the date the title was released. |
| getShotDate() | Gets the date and time when the video was shot. |
| setShotDate(Date value) | Sets the date and time when the video was shot. |
| getStartTimecode() | Gets the timecode of the first frame of video in the file, as obtained from the device control. |
| setStartTimecode(XmpTimecode value) | Sets the timecode of the first frame of video in the file, as obtained from the device control. |
| getTakeNumber() | Gets a numeric value indicating the absolute number of a take. |
| setTakeNumber(Integer value) | Sets a numeric value indicating the absolute number of a take. |
| getTempo() | Gets the audio\\u2019s tempo. |
| setTempo(Double value) | Sets the audio\\u2019s tempo. |
| getTrackNumber() | Gets a numeric value indicating the order of the audio file within its original recording. |
| setTrackNumber(Integer value) | Sets a numeric value indicating the order of the audio file within its original recording. |
| getVideoAlphaPremultipleColor() | Gets the timecode of the first frame of video in the file, as obtained from the device control. |
| setVideoAlphaPremultipleColor(XmpColorantBase value) | Sets the timecode of the first frame of video in the file, as obtained from the device control. |
| getVideoAlphaUnityIsTransparent() | Gets a value indicating whether the unity is clear. |
| setVideoAlphaUnityIsTransparent(Boolean value) | Sets a value indicating whether the unity is clear. |
| getVideoFrameRate() | Gets the video frame rate. |
| setVideoFrameRate(Double value) | Sets the video frame rate. |
| getVideoFrameSize() | Gets the frame size. |
| setVideoFrameSize(XmpDimensions value) | Sets the frame size. |
| getVideoPixelAspectRatio() | Gets the aspect ratio, expressed as wd/ht. |
| setVideoPixelAspectRatio(XmpRational value) | Sets the aspect ratio, expressed as wd/ht. |
| getPartOfCompilation() | Gets a value indicating whether the resource is a part of compilation. |
| setPartOfCompilation(Boolean value) | Sets a value indicating whether the resource is a part of compilation. |
| set(String name, String value) | Sets string property. |
| set(String name, XmpComplexType value) | Sets the value inherited from  XmpComplexType  . |
| setAudioChannelType(XmpAudioChannelType audioChannelType) | Sets the audio channel type. |
| setAudioSampleType(XmpAudioSampleType audioSampleType) | Sets the audio sample type. |
##### XmpDynamicMediaPackage()
```
public XmpDynamicMediaPackage()
```

Initializes a new instance of the  XmpDynamicMediaPackage  class.

##### getAbsPeakAudioFilePath()
```
public final String getAbsPeakAudioFilePath()
```

Gets the absolute path to the file\\u2019s peak audio file.

**Returns:**
java.lang.String - The absolute path to the file\\u2019s peak audio file. If empty, no peak file exists.
##### setAbsPeakAudioFilePath(String value)
```
public final void setAbsPeakAudioFilePath(String value)
```

Sets the absolute path to the file\\u2019s peak audio file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The absolute path to the file\\u2019s peak audio file. If empty, no peak file exists. |

##### getAlbum()
```
public final String getAlbum()
```

Gets the name of the album.

**Returns:**
java.lang.String - The name of the album.
##### setAlbum(String value)
```
public final void setAlbum(String value)
```

Sets the name of the album.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the album. |

##### getAltTapeName()
```
public final String getAltTapeName()
```

Gets the alternative tape name, set via the project window or timecode dialog in Premiere.

**Returns:**
java.lang.String - The alternative tape name, set via the project window or timecode dialog in Premiere.
##### setAltTapeName(String value)
```
public final void setAltTapeName(String value)
```

Sets the alternative tape name, set via the project window or timecode dialog in Premiere.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The alternative tape name, set via the project window or timecode dialog in Premiere. |

##### getAltTimecode()
```
public final XmpTimecode getAltTimecode()
```

Gets the timecode set by the user.

**Returns:**
XmpTimecode - The timecode set by the user. When specified, it is used instead of the startTimecode.
##### setAltTimecode(XmpTimecode value)
```
public final void setAltTimecode(XmpTimecode value)
```

Sets the timecode set by the user.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTimecode | The timecode set by the user. When specified, it is used instead of the startTimecode. |

##### getArtist()
```
public final String getArtist()
```

Gets the name of the artist or artists.

**Returns:**
java.lang.String - The name of the artist or artists.
##### setArtist(String value)
```
public final void setArtist(String value)
```

Sets the name of the artist or artists.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the artist or artists. |

##### getAudioChannelType()
```
public final String getAudioChannelType()
```

Gets the audio channel type.

**Returns:**
java.lang.String - The audio channel type. One of: Mono, Stereo, 5.1, 7.1, 16 Channel, Other
##### setAudioChannelType(String value)
```
public final void setAudioChannelType(String value)
```

Sets the audio channel type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio channel type. One of: Mono, Stereo, 5.1, 7.1, 16 Channel, Other |

##### getAudioCompressor()
```
public final String getAudioCompressor()
```

Gets the audio compression used.

**Returns:**
java.lang.String - The audio compression used. For example, MP3.
##### setAudioCompressor(String value)
```
public final void setAudioCompressor(String value)
```

Sets the audio compression used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio compression used. For example, MP3. |

##### getAudioSampleRate()
```
public final Integer getAudioSampleRate()
```

Gets the audio sample rate.

**Returns:**
java.lang.Integer - The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000.
##### setAudioSampleRate(Integer value)
```
public final void setAudioSampleRate(Integer value)
```

Sets the audio sample rate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The audio sample rate. Can be any value, but commonly 32000, 44100, or 48000. |

##### getAudioSampleType()
```
public final String getAudioSampleType()
```

Gets the audio sample type.

**Returns:**
java.lang.String - The audio sample type. One of: 8Int, 16Int, 24Int, 32Int, 32Float, Compressed, Packed, Other.
##### setAudioSampleType(String value)
```
public final void setAudioSampleType(String value)
```

Sets the audio sample type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio sample type. One of: 8Int, 16Int, 24Int, 32Int, 32Float, Compressed, Packed, Other. |

##### getCameraAngle()
```
public final String getCameraAngle()
```

Gets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.

**Returns:**
java.lang.String - The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. Predefined values include: Low Angle, Eye Level, High Angle, Overhead Shot, Birds Eye Shot, Dutch Angle, POV, Over the Shoulder, Reaction Shot.
##### setCameraAngle(String value)
```
public final void setCameraAngle(String value)
```

Sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. Predefined values include: Low Angle, Eye Level, High Angle, Overhead Shot, Birds Eye Shot, Dutch Angle, POV, Over the Shoulder, Reaction Shot. |

##### getCameraLabel()
```
public final String getCameraLabel()
```

Gets the description of the camera used for a shoot.

**Returns:**
java.lang.String - The description of the camera used for a shoot. Can be any string, but is usually simply a number, for example "1", "2", or more explicitly "Camera 1".
##### setCameraLabel(String value)
```
public final void setCameraLabel(String value)
```

Sets the description of the camera used for a shoot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The description of the camera used for a shoot. Can be any string, but is usually simply a number, for example "1", "2", or more explicitly "Camera 1". |

##### getCameraModel()
```
public final String getCameraModel()
```

Gets the make and model of the camera used for a shoot.

**Returns:**
java.lang.String - The make and model of the camera used for a shoot.
##### setCameraModel(String value)
```
public final void setCameraModel(String value)
```

Sets the make and model of the camera used for a shoot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The make and model of the camera used for a shoot. |

##### getCameraMove()
```
public final String getCameraMove()
```

Gets the movement of the camera during the shot, from a fixed set of industry standard terminology.

**Returns:**
java.lang.String - The movement of the camera during the shot, from a fixed set of industry standard terminology. Predefined values include: Aerial, Boom Up, Boom Down, Crane Up, Crane Down, Dolly In, Dolly Out, Pan Left, Pan Right, Pedestal Up, Pedestal Down, Tilt Up, Tilt Down, Tracking, Truck Left, Truck Right, Zoom In, Zoom Out.
##### setCameraMove(String value)
```
public final void setCameraMove(String value)
```

Sets the movement of the camera during the shot, from a fixed set of industry standard terminology.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The movement of the camera during the shot, from a fixed set of industry standard terminology. Predefined values include: Aerial, Boom Up, Boom Down, Crane Up, Crane Down, Dolly In, Dolly Out, Pan Left, Pan Right, Pedestal Up, Pedestal Down, Tilt Up, Tilt Down, Tracking, Truck Left, Truck Right, Zoom In, Zoom Out. |

##### getClient()
```
public final String getClient()
```

Gets the client for the job of which this shot or take is a part.

**Returns:**
java.lang.String - The client for the job of which this shot or take is a part.
##### setClient(String value)
```
public final void setClient(String value)
```

Sets the client for the job of which this shot or take is a part.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The client for the job of which this shot or take is a part. |

##### getComment()
```
public final String getComment()
```

Gets the user\\u2019s comments.

**Returns:**
java.lang.String - The user\\u2019s comments.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the user\\u2019s comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user\\u2019s comments. |

##### getComposer()
```
public final String getComposer()
```

Gets the composer\\u2019s names.

**Returns:**
java.lang.String - The composer\\u2019s names.
##### setComposer(String value)
```
public final void setComposer(String value)
```

Sets the composer\\u2019s names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The composer\\u2019s names. |

##### getDirector()
```
public final String getDirector()
```

Gets the director of the scene.

**Returns:**
java.lang.String - The director of the scene.
##### setDirector(String value)
```
public final void setDirector(String value)
```

Sets the director of the scene.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The director of the scene. |

##### getDirectorPhotography()
```
public final String getDirectorPhotography()
```

Gets the director of photography for the scene.

**Returns:**
java.lang.String - The director of photography for the scene.
##### setDirectorPhotography(String value)
```
public final void setDirectorPhotography(String value)
```

Sets the director of photography for the scene.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The director of photography for the scene. |

##### getDuration()
```
public final XmpTime getDuration()
```

Gets the duration of the media file.

**Returns:**
XmpTime - The duration of the media file.
##### setDuration(XmpTime value)
```
public final void setDuration(XmpTime value)
```

Sets the duration of the media file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The duration of the media file. |

##### getEngineer()
```
public final String getEngineer()
```

Gets the engineer's names.

**Returns:**
java.lang.String - The engineer's names.
##### setEngineer(String value)
```
public final void setEngineer(String value)
```

Sets the engineer's names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The engineer's names. |

##### getFileDataRate()
```
public final XmpRational getFileDataRate()
```

Gets the file data rate in megabytes per second.

**Returns:**
XmpRational - The file data rate in megabytes per second. For example: "36/10" = 3.6 MB/sec.
##### setFileDataRate(XmpRational value)
```
public final void setFileDataRate(XmpRational value)
```

Sets the file data rate in megabytes per second.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The file data rate in megabytes per second. For example: "36/10" = 3.6 MB/sec. |

##### getGenre()
```
public final String getGenre()
```

Gets the name of the genres.

**Returns:**
java.lang.String - The name of the genres.
##### setGenre(String value)
```
public final void setGenre(String value)
```

Sets the name of the genres.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the genres. |

##### getGood()
```
public final Boolean getGood()
```

Gets a value indicating whether the shot is a keeper.

**Returns:**
java.lang.Boolean - A value indicating whether the shot is a keeper.
##### setGood(Boolean value)
```
public final void setGood(Boolean value)
```

Sets a value indicating whether the shot is a keeper.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the shot is a keeper. |

##### getInstrument()
```
public final String getInstrument()
```

Gets the musical instruments.

**Returns:**
java.lang.String - The musical instruments.
##### setInstrument(String value)
```
public final void setInstrument(String value)
```

Sets the musical instruments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The musical instruments. |

##### getIntroTime()
```
public final XmpTime getIntroTime()
```

Gets the duration of lead time for queuing music.

**Returns:**
XmpTime - The duration of lead time for queuing music.
##### setIntroTime(XmpTime value)
```
public final void setIntroTime(XmpTime value)
```

Sets the duration of lead time for queuing music.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The duration of lead time for queuing music. |

##### getKey()
```
public final String getKey()
```

Gets the audio\\u2019s musical key.

**Returns:**
java.lang.String - The audio\\u2019s musical key. One of: C, C\#, D, D\#, E, F, F\#, G, G\#, A, A\#, B.
##### setKey(String value)
```
public final void setKey(String value)
```

Sets the audio\\u2019s musical key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The audio\\u2019s musical key. One of: C, C\#, D, D\#, E, F, F\#, G, G\#, A, A\#, B. |

##### getLogComment()
```
public final String getLogComment()
```

Gets the user\\u2019s log comments.

**Returns:**
java.lang.String - The user\\u2019s log comments.
##### setLogComment(String value)
```
public final void setLogComment(String value)
```

Sets the user\\u2019s log comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user\\u2019s log comments. |

##### getLoop()
```
public final Boolean getLoop()
```

Gets a value indicating whether the clip can be looped seamlessly.

**Returns:**
java.lang.Boolean - A value indicating whether the clip can be looped seamlessly.
##### setLoop(Boolean value)
```
public final void setLoop(Boolean value)
```

Sets a value indicating whether the clip can be looped seamlessly.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the clip can be looped seamlessly. |

##### getNumberOfBeats()
```
public final Double getNumberOfBeats()
```

Gets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

**Returns:**
java.lang.Double - The total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.
##### setNumberOfBeats(Double value)
```
public final void setNumberOfBeats(Double value)
```

Sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |

##### getOutCue()
```
public final XmpTime getOutCue()
```

Gets the time at which to fade out.

**Returns:**
XmpTime - The time at which to fade out.
##### setOutCue(XmpTime value)
```
public final void setOutCue(XmpTime value)
```

Sets the time at which to fade out.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The time at which to fade out. |

##### getProjectName()
```
public final String getProjectName()
```

Gets the name of the project of which this file is a part.

**Returns:**
java.lang.String - The name of the project of which this file is a part.
##### setProjectName(String value)
```
public final void setProjectName(String value)
```

Sets the name of the project of which this file is a part.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the project of which this file is a part. |

##### getRelativeTimestamp()
```
public final XmpTime getRelativeTimestamp()
```

Gets the start time of the media inside the audio project.

**Returns:**
XmpTime - The start time of the media inside the audio project.
##### setRelativeTimestamp(XmpTime value)
```
public final void setRelativeTimestamp(XmpTime value)
```

Sets the start time of the media inside the audio project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTime | The start time of the media inside the audio project. |

##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the date the title was released.

**Returns:**
java.util.Date - The date the title was released.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the date the title was released.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date the title was released. |

##### getShotDate()
```
public final Date getShotDate()
```

Gets the date and time when the video was shot.

**Returns:**
java.util.Date - The date and time when the video was shot.
##### setShotDate(Date value)
```
public final void setShotDate(Date value)
```

Sets the date and time when the video was shot.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date and time when the video was shot. |

##### getStartTimecode()
```
public final XmpTimecode getStartTimecode()
```

Gets the timecode of the first frame of video in the file, as obtained from the device control.

**Returns:**
XmpTimecode - The timecode of the first frame of video in the file, as obtained from the device control.
##### setStartTimecode(XmpTimecode value)
```
public final void setStartTimecode(XmpTimecode value)
```

Sets the timecode of the first frame of video in the file, as obtained from the device control.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTimecode | The timecode of the first frame of video in the file, as obtained from the device control. |

##### getTakeNumber()
```
public final Integer getTakeNumber()
```

Gets a numeric value indicating the absolute number of a take.

**Returns:**
java.lang.Integer - A numeric value indicating the absolute number of a take.
##### setTakeNumber(Integer value)
```
public final void setTakeNumber(Integer value)
```

Sets a numeric value indicating the absolute number of a take.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A numeric value indicating the absolute number of a take. |

##### getTempo()
```
public final Double getTempo()
```

Gets the audio\\u2019s tempo.

**Returns:**
java.lang.Double - The audio\\u2019s tempo.
##### setTempo(Double value)
```
public final void setTempo(Double value)
```

Sets the audio\\u2019s tempo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The audio\\u2019s tempo. |

##### getTrackNumber()
```
public final Integer getTrackNumber()
```

Gets a numeric value indicating the order of the audio file within its original recording.

**Returns:**
java.lang.Integer - A numeric value indicating the order of the audio file within its original recording.
##### setTrackNumber(Integer value)
```
public final void setTrackNumber(Integer value)
```

Sets a numeric value indicating the order of the audio file within its original recording.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | A numeric value indicating the order of the audio file within its original recording. |

##### getVideoAlphaPremultipleColor()
```
public final XmpColorantBase getVideoAlphaPremultipleColor()
```

Gets the timecode of the first frame of video in the file, as obtained from the device control.

**Returns:**
XmpColorantBase - The timecode of the first frame of video in the file, as obtained from the device control.
##### setVideoAlphaPremultipleColor(XmpColorantBase value)
```
public final void setVideoAlphaPremultipleColor(XmpColorantBase value)
```

Sets the timecode of the first frame of video in the file, as obtained from the device control.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorantBase | The timecode of the first frame of video in the file, as obtained from the device control. |

##### getVideoAlphaUnityIsTransparent()
```
public final Boolean getVideoAlphaUnityIsTransparent()
```

Gets a value indicating whether the unity is clear.

**Returns:**
java.lang.Boolean -  true , if unity is clear; otherwise, it is opaque.
##### setVideoAlphaUnityIsTransparent(Boolean value)
```
public final void setVideoAlphaUnityIsTransparent(Boolean value)
```

Sets a value indicating whether the unity is clear.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true , if unity is clear; otherwise, it is opaque. |

##### getVideoFrameRate()
```
public final Double getVideoFrameRate()
```

Gets the video frame rate.

**Returns:**
java.lang.Double - The video frame rate.
##### setVideoFrameRate(Double value)
```
public final void setVideoFrameRate(Double value)
```

Sets the video frame rate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Double | The video frame rate. |

##### getVideoFrameSize()
```
public final XmpDimensions getVideoFrameSize()
```

Gets the frame size.

**Returns:**
XmpDimensions - The frame size.
##### setVideoFrameSize(XmpDimensions value)
```
public final void setVideoFrameSize(XmpDimensions value)
```

Sets the frame size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDimensions | The frame size. |

##### getVideoPixelAspectRatio()
```
public final XmpRational getVideoPixelAspectRatio()
```

Gets the aspect ratio, expressed as wd/ht.

**Returns:**
XmpRational - The aspect ratio, expressed as wd/ht.
##### setVideoPixelAspectRatio(XmpRational value)
```
public final void setVideoPixelAspectRatio(XmpRational value)
```

Sets the aspect ratio, expressed as wd/ht.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The aspect ratio, expressed as wd/ht. |

##### getPartOfCompilation()
```
public final Boolean getPartOfCompilation()
```

Gets a value indicating whether the resource is a part of compilation.

**Returns:**
java.lang.Boolean - A value indicating whether the resource is a part of compilation.
##### setPartOfCompilation(Boolean value)
```
public final void setPartOfCompilation(Boolean value)
```

Sets a value indicating whether the resource is a part of compilation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | A value indicating whether the resource is a part of compilation. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpComplexType value)
```
public void set(String name, XmpComplexType value)
```

Sets the value inherited from  XmpComplexType  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

##### setAudioChannelType(XmpAudioChannelType audioChannelType)
```
public final void setAudioChannelType(XmpAudioChannelType audioChannelType)
```

Sets the audio channel type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioChannelType | XmpAudioChannelType | The audio channel type. |

##### setAudioSampleType(XmpAudioSampleType audioSampleType)
```
public final void setAudioSampleType(XmpAudioSampleType audioSampleType)
```

Sets the audio sample type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| audioSampleType | XmpAudioSampleType | The audio sample type. |

### XmpElementBase
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpelementbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public abstract class XmpElementBase extends CustomPackage
```

Represents base XMP element that contains attributes.
#### Methods

| Method | Description |
| --- | --- |
| setAttribute(String attribute, String value) | Adds the attribute. |
| clearAttributes() | Removes all attributes. |
| containsAttribute(String attribute) | Determines whether the element contains a specific attribute. |
| getAttribute(String attribute) | Gets the attribute. |
##### setAttribute(String attribute, String value)
```
public void setAttribute(String attribute, String value)
```

Adds the attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | Attribute key. |
| value | java.lang.String | Attribute value. |

##### clearAttributes()
```
public final void clearAttributes()
```

Removes all attributes.

##### containsAttribute(String attribute)
```
public final boolean containsAttribute(String attribute)
```

Determines whether the element contains a specific attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | Attribute name. |

**Returns:**
boolean - true if attribute is exist; otherwise false.
##### getAttribute(String attribute)
```
public final String getAttribute(String attribute)
```

Gets the attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | The attribute. |

**Returns:**
java.lang.String - The attribute value.

### XmpException
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.metadata.core.GroupDocsMetadataException
```
public final class XmpException extends GroupDocsMetadataException
```

The exception that is thrown when XMP has invalid structure.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpException() | Initializes a new instance of the  XmpException  class. |
| XmpException(String message) | Initializes a new instance of the  XmpException  class. |
| XmpException(String message, RuntimeException innerException) | Initializes a new instance of the  XmpException  class. |
##### XmpException()
```
public XmpException()
```

Initializes a new instance of the  XmpException  class.

##### XmpException(String message)
```
public XmpException(String message)
```

Initializes a new instance of the  XmpException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

##### XmpException(String message, RuntimeException innerException)
```
public XmpException(String message, RuntimeException innerException)
```

Initializes a new instance of the  XmpException  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| innerException | java.lang.RuntimeException | The inner exception. |

### XmpFont
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpfont.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpFont extends XmpComplexType
```

A structure containing the characteristics of a font used in a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpFont() | Initializes a new instance of the  XmpFont  class. |
| XmpFont(String fontFamily) | Initializes a new instance of the  XmpFont  class. |
#### Methods

| Method | Description |
| --- | --- |
| getChildFontFiles() | Gets the list of file names for the fonts that make up a composite font. |
| setChildFontFiles(String[] value) | Sets the list of file names for the fonts that make up a composite font. |
| isComposite() | Gets a value indicating whether whether the font is composite. |
| setComposite(Boolean value) | Sets a value indicating whether whether the font is composite. |
| getFontFace() | Gets the font face name. |
| setFontFace(String value) | Sets the font face name. |
| getFontFamily() | Gets the font family name. |
| setFontFamily(String value) | Sets the font family name. |
| getFontFileName() | Gets the font file name (not a complete path). |
| setFontFileName(String value) | Sets the font file name (not a complete path). |
| getFontName() | Gets the PostScript name of the font. |
| setFontName(String value) | Sets the PostScript name of the font. |
| getFontType() | Gets the font type. |
| setFontType(String value) | Sets the font type. |
| getVersion() | Gets the font version. |
| setVersion(String value) | Sets the font version. |
##### XmpFont()
```
public XmpFont()
```

Initializes a new instance of the  XmpFont  class.

##### XmpFont(String fontFamily)
```
public XmpFont(String fontFamily)
```

Initializes a new instance of the  XmpFont  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamily | java.lang.String | Font family. |

##### getChildFontFiles()
```
public final String[] getChildFontFiles()
```

Gets the list of file names for the fonts that make up a composite font.

**Returns:**
java.lang.String[] - The list of file names for the fonts that make up a composite font.
##### setChildFontFiles(String[] value)
```
public final void setChildFontFiles(String[] value)
```

Sets the list of file names for the fonts that make up a composite font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The list of file names for the fonts that make up a composite font. |

##### isComposite()
```
public final Boolean isComposite()
```

Gets a value indicating whether whether the font is composite.

**Returns:**
java.lang.Boolean -  true  if the font is composite; otherwise,  false .
##### setComposite(Boolean value)
```
public final void setComposite(Boolean value)
```

Sets a value indicating whether whether the font is composite.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the font is composite; otherwise,  false . |

##### getFontFace()
```
public final String getFontFace()
```

Gets the font face name.

**Returns:**
java.lang.String - The font face name.
##### setFontFace(String value)
```
public final void setFontFace(String value)
```

Sets the font face name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font face name. |

##### getFontFamily()
```
public final String getFontFamily()
```

Gets the font family name.

**Returns:**
java.lang.String - The font family name.
##### setFontFamily(String value)
```
public final void setFontFamily(String value)
```

Sets the font family name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font family name. |

##### getFontFileName()
```
public final String getFontFileName()
```

Gets the font file name (not a complete path).

**Returns:**
java.lang.String - The name of the font file.
##### setFontFileName(String value)
```
public final void setFontFileName(String value)
```

Sets the font file name (not a complete path).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the font file. |

##### getFontName()
```
public final String getFontName()
```

Gets the PostScript name of the font.

**Returns:**
java.lang.String - The PostScript name of the font.
##### setFontName(String value)
```
public final void setFontName(String value)
```

Sets the PostScript name of the font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The PostScript name of the font. |

##### getFontType()
```
public final String getFontType()
```

Gets the font type.

**Returns:**
java.lang.String - The font type.

TrueType, Type 1, Open Type, and so on.
##### setFontType(String value)
```
public final void setFontType(String value)
```

Sets the font type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font type.

TrueType, Type 1, Open Type, and so on. |

##### getVersion()
```
public final String getVersion()
```

Gets the font version.

**Returns:**
java.lang.String - The version.

/version for Type1 fonts nameId 5 for Apple True Type and OpenType /CIDFontVersion for CID fonts The empty string for bitmap fonts
##### setVersion(String value)
```
public final void setVersion(String value)
```

Sets the font version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The version.

/version for Type1 fonts nameId 5 for Apple True Type and OpenType /CIDFontVersion for CID fonts The empty string for bitmap fonts |

### XmpGuid
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpguid.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpGuid extends XmpValueBase
```

Represents XMP global unique identifier.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpGuid(String value) | Initializes a new instance of the  XmpGuid  class. |
| XmpGuid(UUID value) | Initializes a new instance of the  XmpGuid  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpGuid(String value)
```
public XmpGuid(String value)
```

Initializes a new instance of the  XmpGuid  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### XmpGuid(UUID value)
```
public XmpGuid(UUID value)
```

Initializes a new instance of the  XmpGuid  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.UUID | The unique identifier. |

##### getValue()
```
public final UUID getValue()
```

Gets the value.

**Returns:**
java.util.UUID - The value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpHeaderPI
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpheaderpi.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpHeaderPI implements IXmpType
```

Represents XMP header processing instruction.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpHeaderPI() | Initializes a new instance of the  XmpHeaderPI  class. |
#### Methods

| Method | Description |
| --- | --- |
| getGuid() | Represents Header GUID. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpHeaderPI()
```
public XmpHeaderPI()
```

Initializes a new instance of the  XmpHeaderPI  class.

##### getGuid()
```
public final String getGuid()
```

Represents Header GUID.

**Returns:**
java.lang.String - The unique identifier.

The text of the header PI contains a GUID, making it unlikely to appear by accident in the data stream.
##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpInteger
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpinteger.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpInteger extends XmpValueBase
```

Represents XMP Integer basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpInteger(long value) | Initializes a new instance of the  XmpInteger  class. |
| XmpInteger(int value) | Initializes a new instance of the  XmpInteger  class. |
| XmpInteger(String value) | Initializes a new instance of the  XmpInteger  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpInteger(long value)
```
public XmpInteger(long value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The value. |

##### XmpInteger(int value)
```
public XmpInteger(int value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value. |

##### XmpInteger(String value)
```
public XmpInteger(String value)
```

Initializes a new instance of the  XmpInteger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | String value contained integer. |

##### getValue()
```
public final long getValue()
```

Gets the value.

**Returns:**
long - Integer value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpIptcCorePackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpiptccorepackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcCorePackage extends XmpPackage
```

Represents the IPTC Core XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcCorePackage() | Initializes a new instance of the  XmpIptcCorePackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCountryCode() | Gets the code of the country the content is focusing on. |
| setCountryCode(String value) | Sets the code of the country the content is focusing on. |
| getIntellectualGenre() | Gets the intellectual genre. |
| setIntellectualGenre(String value) | Sets the intellectual genre. |
| getLocation() | Gets the location the content is focusing on. |
| setLocation(String value) | Sets the location the content is focusing on. |
| getScenes() | Gets the scene of the photo content. |
| setScenes(String[] value) | Sets the scene of the photo content. |
| getSubjectCodes() | Gets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |
| setSubjectCodes(String[] value) | Sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |
##### XmpIptcCorePackage()
```
public XmpIptcCorePackage()
```

Initializes a new instance of the  XmpIptcCorePackage  class.

##### getCountryCode()
```
public final String getCountryCode()
```

Gets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.

**Returns:**
java.lang.String - The country code.
##### setCountryCode(String value)
```
public final void setCountryCode(String value)
```

Sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The country code. |

##### getIntellectualGenre()
```
public final String getIntellectualGenre()
```

Gets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.

**Returns:**
java.lang.String - The intellectual genre.
##### setIntellectualGenre(String value)
```
public final void setIntellectualGenre(String value)
```

Sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The intellectual genre. |

##### getLocation()
```
public final String getLocation()
```

Gets the location the content is focusing on.

**Returns:**
java.lang.String - The location.

This location name could either be the name of a sublocation to a city or the name of a well known location or (natural) monument outside a city. In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy.
##### setLocation(String value)
```
public final void setLocation(String value)
```

Sets the location the content is focusing on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The location.

This location name could either be the name of a sublocation to a city or the name of a well known location or (natural) monument outside a city. In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy. |

##### getScenes()
```
public final String[] getScenes()
```

Gets the scene of the photo content.

**Returns:**
java.lang.String[] - The scene codes.

Specifies one or more terms from the IPTC "Scene-NewsCodes". Each Scene is represented as a string of 6 digits in an unordered list
##### setScenes(String[] value)
```
public final void setScenes(String[] value)
```

Sets the scene of the photo content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The scene codes.

Specifies one or more terms from the IPTC "Scene-NewsCodes". Each Scene is represented as a string of 6 digits in an unordered list |

##### getSubjectCodes()
```
public final String[] getSubjectCodes()
```

Gets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

**Returns:**
java.lang.String[] - The subject codes.

More about IPTC Subject-NewsCodes at http://www.newscodes.org.
##### setSubjectCodes(String[] value)
```
public final void setSubjectCodes(String[] value)
```

Sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The subject codes.

More about IPTC Subject-NewsCodes at http://www.newscodes.org. |

### XmpIptcExtensionPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpiptcextensionpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcExtensionPackage extends XmpPackage
```

Represents the IPTC Extension XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcExtensionPackage() | Initializes a new instance of the  XmpIptcExtensionPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAdditionalModelInformation() | Gets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| setAdditionalModelInformation(String value) | Sets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| getOrganisationInImageCodes() | Gets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| setOrganisationInImageCodes(String[] value) | Sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| getOrganisationInImageNames() | Gets names of the organisations or companies which are featured in the image. |
| setOrganisationInImageNames(String[] value) | Sets names of the organisations or companies which are featured in the image. |
| getAgesOfModels() | Gets ages of the human models at the time this image was taken in a model released image. |
| setAgesOfModels(int[] value) | Sets ages of the human models at the time this image was taken in a model released image. |
| getPersonsInImage() | Gets names of the persons the content of the item is about. |
| setPersonsInImage(String[] value) | Sets names of the persons the content of the item is about. |
| getDigitalImageGuid() | Gets the globally unique identifier for this digital image. |
| setDigitalImageGuid(String value) | Sets the globally unique identifier for this digital image. |
| getDigitalSourceType() | Gets the type of the source of this digital image. |
| setDigitalSourceType(String value) | Sets the type of the source of this digital image. |
| getEvent() | Gets the description of the specific event at which the photo was taken. |
| setEvent(XmpLangAlt value) | Sets the description of the specific event at which the photo was taken. |
| getIptcLastEdited() | Gets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| setIptcLastEdited(Date value) | Sets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| getMaxAvailableHeight() | Gets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| setMaxAvailableHeight(Integer value) | Sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| getMaxAvailableWidth() | Gets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |
| setMaxAvailableWidth(Integer value) | Sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |
| set(String name, String value) | Sets string property. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpIptcExtensionPackage()
```
public XmpIptcExtensionPackage()
```

Initializes a new instance of the  XmpIptcExtensionPackage  class.

##### getAdditionalModelInformation()
```
public final String getAdditionalModelInformation()
```

Gets the information about the ethnicity and other facets of the model(s) in a model-released image.

**Returns:**
java.lang.String - The additional model information.
##### setAdditionalModelInformation(String value)
```
public final void setAdditionalModelInformation(String value)
```

Sets the information about the ethnicity and other facets of the model(s) in a model-released image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The additional model information. |

##### getOrganisationInImageCodes()
```
public final String[] getOrganisationInImageCodes()
```

Gets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.

**Returns:**
java.lang.String[] - The codes of the organisations.
##### setOrganisationInImageCodes(String[] value)
```
public final void setOrganisationInImageCodes(String[] value)
```

Sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The codes of the organisations. |

##### getOrganisationInImageNames()
```
public final String[] getOrganisationInImageNames()
```

Gets names of the organisations or companies which are featured in the image.

**Returns:**
java.lang.String[] - Names of the organisations.
##### setOrganisationInImageNames(String[] value)
```
public final void setOrganisationInImageNames(String[] value)
```

Sets names of the organisations or companies which are featured in the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | Names of the organisations. |

##### getAgesOfModels()
```
public final int[] getAgesOfModels()
```

Gets ages of the human models at the time this image was taken in a model released image.

**Returns:**
int[] - Ages of the models.
##### setAgesOfModels(int[] value)
```
public final void setAgesOfModels(int[] value)
```

Sets ages of the human models at the time this image was taken in a model released image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | Ages of the models. |

##### getPersonsInImage()
```
public final String[] getPersonsInImage()
```

Gets names of the persons the content of the item is about.

**Returns:**
java.lang.String[] - Names of the persons that are shown in the image.
##### setPersonsInImage(String[] value)
```
public final void setPersonsInImage(String[] value)
```

Sets names of the persons the content of the item is about.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | Names of the persons that are shown in the image. |

##### getDigitalImageGuid()
```
public final String getDigitalImageGuid()
```

Gets the globally unique identifier for this digital image.

**Returns:**
java.lang.String - The image GUID.

It is created and applied by the creator of the digital image at the time of its creation. This value shall not be changed after that time.
##### setDigitalImageGuid(String value)
```
public final void setDigitalImageGuid(String value)
```

Sets the globally unique identifier for this digital image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image GUID.

It is created and applied by the creator of the digital image at the time of its creation. This value shall not be changed after that time. |

##### getDigitalSourceType()
```
public final String getDigitalSourceType()
```

Gets the type of the source of this digital image.

**Returns:**
java.lang.String - The type of the source digital file.
##### setDigitalSourceType(String value)
```
public final void setDigitalSourceType(String value)
```

Sets the type of the source of this digital image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the source digital file. |

##### getEvent()
```
public final XmpLangAlt getEvent()
```

Gets the description of the specific event at which the photo was taken.

**Returns:**
XmpLangAlt - The specific event at which the photo was taken.
##### setEvent(XmpLangAlt value)
```
public final void setEvent(XmpLangAlt value)
```

Sets the description of the specific event at which the photo was taken.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The specific event at which the photo was taken. |

##### getIptcLastEdited()
```
public final Date getIptcLastEdited()
```

Gets the date and optionally time when any of the IPTC photo metadata fields has been last edited.

**Returns:**
java.util.Date - The last edited date.
##### setIptcLastEdited(Date value)
```
public final void setIptcLastEdited(Date value)
```

Sets the date and optionally time when any of the IPTC photo metadata fields has been last edited.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The last edited date. |

##### getMaxAvailableHeight()
```
public final Integer getMaxAvailableHeight()
```

Gets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.

**Returns:**
java.lang.Integer - The maximum available height.
##### setMaxAvailableHeight(Integer value)
```
public final void setMaxAvailableHeight(Integer value)
```

Sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The maximum available height. |

##### getMaxAvailableWidth()
```
public final Integer getMaxAvailableWidth()
```

Gets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.

**Returns:**
java.lang.Integer - The maximum available width.
##### setMaxAvailableWidth(Integer value)
```
public final void setMaxAvailableWidth(Integer value)
```

Sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The maximum available width. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpIptcIimPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpiptciimpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpIptcIimPackage extends XmpPackage
```

Represents the IPTC-IIM XMP package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpIptcIimPackage() | Initializes a new instance of the  XmpIptcIimPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getModelVersion() | Gets the binary number identifying the version of the Information |
| setModelVersion(Integer value) | Sets the binary number identifying the version of the Information |
| getDestination() | Gets the destination. |
| setDestination(String[] value) | Sets the destination. |
| getFileFormat() | Gets the binary number identifying the version of the Information |
| setFileFormat(Integer value) | Sets the binary number identifying the version of the Information |
| getFileFormatVersion() | Gets the file format version. |
| setFileFormatVersion(Integer value) | Sets the file format version. |
| getServiceIdentifier() | Gets the service identifier. |
| setServiceIdentifier(String value) | Sets the service identifier. |
| getEnvelopeNumber() | Gets the envelope number. |
| setEnvelopeNumber(String value) | Sets the envelope number. |
| getProductIDs() | Gets the product identifiers. |
| setProductIDs(String[] value) | Sets the product identifiers. |
| getEnvelopePriority() | Gets the envelope handling priority. |
| setEnvelopePriority(Integer value) | Sets the envelope handling priority. |
| getDateSent() | Gets the date the service sent the material. |
| setDateSent(Date value) | Sets the date the service sent the material. |
| getUniqueNameOfObject() | Gets the unique name of the object. |
| setUniqueNameOfObject(String value) | Sets the unique name of the object. |
| getObjectTypeReference() | Gets the object type reference. |
| setObjectTypeReference(String value) | Sets the object type reference. |
| getEditStatus() | Gets the status of the object data, according to the practice of the provider. |
| setEditStatus(String value) | Sets the status of the object data, according to the practice of the provider. |
| getUrgency() | Gets the editorial urgency of the content. |
| setUrgency(Integer value) | Sets the editorial urgency of the content. |
| getCategory() | Gets the subject of the object data in the opinion of the provider. |
| setCategory(String value) | Sets the subject of the object data in the opinion of the provider. |
| getSupplementalCategories() | Gets the supplemental categories. |
| setSupplementalCategories(String[] value) | Sets the supplemental categories. |
| getFixtureIdentifier() | Gets the object data that recurs often and predictably. |
| setFixtureIdentifier(String value) | Sets the object data that recurs often and predictably. |
| getContentLocationCodes() | Gets the content location codes. |
| setContentLocationCodes(String[] value) | Sets the content location codes. |
| getContentLocationNames() | Gets the content location names. |
| setContentLocationNames(String[] value) | Sets the content location names. |
| getReleaseDate() | Gets the earliest date the provider intends the object to be used. |
| setReleaseDate(Date value) | Sets the earliest date the provider intends the object to be used. |
| getExpirationDate() | Gets the latest date the provider or owner intends the object data to be used. |
| setExpirationDate(Date value) | Sets the latest date the provider or owner intends the object data to be used. |
| getActionAdvised() | Gets the type of action that this object provides to a previous object. |
| setActionAdvised(String value) | Sets the type of action that this object provides to a previous object. |
| getReferenceService() | Gets the Service Identifier of a prior envelope to which the current object refers. |
| setReferenceService(String value) | Sets the Service Identifier of a prior envelope to which the current object refers. |
| getReferenceDate() | Gets the date of a prior envelope to which the current object refers. |
| setReferenceDate(Date value) | Sets the date of a prior envelope to which the current object refers. |
| getReferenceNumber() | Gets the Envelope Number of a prior envelope to which the current object refers. |
| setReferenceNumber(String value) | Sets the Envelope Number of a prior envelope to which the current object refers. |
| getDigitalCreationDate() | Gets the date the digital representation of the object data was created. |
| setDigitalCreationDate(Date value) | Sets the date the digital representation of the object data was created. |
| getOriginatingProgram() | Gets the type of program used to originate the object data. |
| setOriginatingProgram(String value) | Sets the type of program used to originate the object data. |
| getProgramVersion() | Gets the program version. |
| setProgramVersion(String value) | Sets the program version. |
| getImageType() | Gets the type of the image. |
| setImageType(String value) | Sets the type of the image. |
| getImageOrientation() | Gets the image orientation. |
| setImageOrientation(String value) | Sets the image orientation. |
| getLanguageIdentifier() | Gets the language identifier according to the 2-letter codes of ISO 639:1988. |
| setLanguageIdentifier(String value) | Sets the language identifier according to the 2-letter codes of ISO 639:1988. |
| set(String name, String value) | Sets string property. |
##### XmpIptcIimPackage()
```
public XmpIptcIimPackage()
```

Initializes a new instance of the  XmpIptcIimPackage  class.

##### getModelVersion()
```
public final Integer getModelVersion()
```

Gets the binary number identifying the version of the Information

**Returns:**
java.lang.Integer - The model version.
##### setModelVersion(Integer value)
```
public final void setModelVersion(Integer value)
```

Sets the binary number identifying the version of the Information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The model version. |

##### getDestination()
```
public final String[] getDestination()
```

Gets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

**Returns:**
java.lang.String[] - The destination.
##### setDestination(String[] value)
```
public final void setDestination(String[] value)
```

Sets the destination. This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The destination. |

##### getFileFormat()
```
public final Integer getFileFormat()
```

Gets the binary number identifying the version of the Information

**Returns:**
java.lang.Integer - The file format.
##### setFileFormat(Integer value)
```
public final void setFileFormat(Integer value)
```

Sets the binary number identifying the version of the Information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format. |

##### getFileFormatVersion()
```
public final Integer getFileFormatVersion()
```

Gets the file format version.

**Returns:**
java.lang.Integer - The file format version.
##### setFileFormatVersion(Integer value)
```
public final void setFileFormatVersion(Integer value)
```

Sets the file format version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The file format version. |

##### getServiceIdentifier()
```
public final String getServiceIdentifier()
```

Gets the service identifier. Identifies the provider and product.

**Returns:**
java.lang.String - The service identifier.
##### setServiceIdentifier(String value)
```
public final void setServiceIdentifier(String value)
```

Sets the service identifier. Identifies the provider and product.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The service identifier. |

##### getEnvelopeNumber()
```
public final String getEnvelopeNumber()
```

Gets the envelope number.

**Returns:**
java.lang.String - The envelope number.
##### setEnvelopeNumber(String value)
```
public final void setEnvelopeNumber(String value)
```

Sets the envelope number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The envelope number. |

##### getProductIDs()
```
public final String[] getProductIDs()
```

Gets the product identifiers.

**Returns:**
java.lang.String[] - The product identifier.

Used to provide receiving organization data on which to select, route, or otherwise handle data.
##### setProductIDs(String[] value)
```
public final void setProductIDs(String[] value)
```

Sets the product identifiers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The product identifier.

Used to provide receiving organization data on which to select, route, or otherwise handle data. |

##### getEnvelopePriority()
```
public final Integer getEnvelopePriority()
```

Gets the envelope handling priority.

**Returns:**
java.lang.Integer - The envelope priority.
##### setEnvelopePriority(Integer value)
```
public final void setEnvelopePriority(Integer value)
```

Sets the envelope handling priority.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The envelope priority. |

##### getDateSent()
```
public final Date getDateSent()
```

Gets the date the service sent the material.

**Returns:**
java.util.Date - The date sent.
##### setDateSent(Date value)
```
public final void setDateSent(Date value)
```

Sets the date the service sent the material.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date sent. |

##### getUniqueNameOfObject()
```
public final String getUniqueNameOfObject()
```

Gets the unique name of the object.

**Returns:**
java.lang.String - The unique name of the object.
##### setUniqueNameOfObject(String value)
```
public final void setUniqueNameOfObject(String value)
```

Sets the unique name of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The unique name of the object. |

##### getObjectTypeReference()
```
public final String getObjectTypeReference()
```

Gets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.

**Returns:**
java.lang.String - The object type reference.
##### setObjectTypeReference(String value)
```
public final void setObjectTypeReference(String value)
```

Sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The object type reference. |

##### getEditStatus()
```
public final String getEditStatus()
```

Gets the status of the object data, according to the practice of the provider.

**Returns:**
java.lang.String - The edit status.
##### setEditStatus(String value)
```
public final void setEditStatus(String value)
```

Sets the status of the object data, according to the practice of the provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The edit status. |

##### getUrgency()
```
public final Integer getUrgency()
```

Gets the editorial urgency of the content.

**Returns:**
java.lang.Integer - The urgency.
##### setUrgency(Integer value)
```
public final void setUrgency(Integer value)
```

Sets the editorial urgency of the content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The urgency. |

##### getCategory()
```
public final String getCategory()
```

Gets the subject of the object data in the opinion of the provider.

**Returns:**
java.lang.String - The category.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the subject of the object data in the opinion of the provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. |

##### getSupplementalCategories()
```
public final String[] getSupplementalCategories()
```

Gets the supplemental categories.

**Returns:**
java.lang.String[] - The supplemental categories.
##### setSupplementalCategories(String[] value)
```
public final void setSupplementalCategories(String[] value)
```

Sets the supplemental categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The supplemental categories. |

##### getFixtureIdentifier()
```
public final String getFixtureIdentifier()
```

Gets the object data that recurs often and predictably.

**Returns:**
java.lang.String - The fixture identifier.
##### setFixtureIdentifier(String value)
```
public final void setFixtureIdentifier(String value)
```

Sets the object data that recurs often and predictably.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The fixture identifier. |

##### getContentLocationCodes()
```
public final String[] getContentLocationCodes()
```

Gets the content location codes.

**Returns:**
java.lang.String[] - The content location codes.

Indicates the code of a country/geographical location referenced by the content of the object.
##### setContentLocationCodes(String[] value)
```
public final void setContentLocationCodes(String[] value)
```

Sets the content location codes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location codes.

Indicates the code of a country/geographical location referenced by the content of the object. |

##### getContentLocationNames()
```
public final String[] getContentLocationNames()
```

Gets the content location names.

**Returns:**
java.lang.String[] - The content location names.

Provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider.
##### setContentLocationNames(String[] value)
```
public final void setContentLocationNames(String[] value)
```

Sets the content location names.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The content location names.

Provides a full, publishable name of a country/geographical location referenced by the content of the object, according to guidelines of the provider. |

##### getReleaseDate()
```
public final Date getReleaseDate()
```

Gets the earliest date the provider intends the object to be used.

**Returns:**
java.util.Date - The release date.
##### setReleaseDate(Date value)
```
public final void setReleaseDate(Date value)
```

Sets the earliest date the provider intends the object to be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The release date. |

##### getExpirationDate()
```
public final Date getExpirationDate()
```

Gets the latest date the provider or owner intends the object data to be used.

**Returns:**
java.util.Date - The expiration date.
##### setExpirationDate(Date value)
```
public final void setExpirationDate(Date value)
```

Sets the latest date the provider or owner intends the object data to be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The expiration date. |

##### getActionAdvised()
```
public final String getActionAdvised()
```

Gets the type of action that this object provides to a previous object.

**Returns:**
java.lang.String - The type of action.
##### setActionAdvised(String value)
```
public final void setActionAdvised(String value)
```

Sets the type of action that this object provides to a previous object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of action. |

##### getReferenceService()
```
public final String getReferenceService()
```

Gets the Service Identifier of a prior envelope to which the current object refers.

**Returns:**
java.lang.String - The reference service.
##### setReferenceService(String value)
```
public final void setReferenceService(String value)
```

Sets the Service Identifier of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference service. |

##### getReferenceDate()
```
public final Date getReferenceDate()
```

Gets the date of a prior envelope to which the current object refers.

**Returns:**
java.util.Date - The reference date.
##### setReferenceDate(Date value)
```
public final void setReferenceDate(Date value)
```

Sets the date of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The reference date. |

##### getReferenceNumber()
```
public final String getReferenceNumber()
```

Gets the Envelope Number of a prior envelope to which the current object refers.

**Returns:**
java.lang.String - The reference number.
##### setReferenceNumber(String value)
```
public final void setReferenceNumber(String value)
```

Sets the Envelope Number of a prior envelope to which the current object refers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The reference number. |

##### getDigitalCreationDate()
```
public final Date getDigitalCreationDate()
```

Gets the date the digital representation of the object data was created.

**Returns:**
java.util.Date - The digital creation date.
##### setDigitalCreationDate(Date value)
```
public final void setDigitalCreationDate(Date value)
```

Sets the date the digital representation of the object data was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The digital creation date. |

##### getOriginatingProgram()
```
public final String getOriginatingProgram()
```

Gets the type of program used to originate the object data.

**Returns:**
java.lang.String - The originating program.
##### setOriginatingProgram(String value)
```
public final void setOriginatingProgram(String value)
```

Sets the type of program used to originate the object data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The originating program. |

##### getProgramVersion()
```
public final String getProgramVersion()
```

Gets the program version.

**Returns:**
java.lang.String - The program version.
##### setProgramVersion(String value)
```
public final void setProgramVersion(String value)
```

Sets the program version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The program version. |

##### getImageType()
```
public final String getImageType()
```

Gets the type of the image.

**Returns:**
java.lang.String - The type of the image.

The first is a numeric character and the second is an alphabetic character.
##### setImageType(String value)
```
public final void setImageType(String value)
```

Sets the type of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The type of the image.

The first is a numeric character and the second is an alphabetic character. |

##### getImageOrientation()
```
public final String getImageOrientation()
```

Gets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).

**Returns:**
java.lang.String - The image orientation.
##### setImageOrientation(String value)
```
public final void setImageOrientation(String value)
```

Sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The image orientation. |

##### getLanguageIdentifier()
```
public final String getLanguageIdentifier()
```

Gets the language identifier according to the 2-letter codes of ISO 639:1988.

**Returns:**
java.lang.String - The language identifier.
##### setLanguageIdentifier(String value)
```
public final void setLanguageIdentifier(String value)
```

Sets the language identifier according to the 2-letter codes of ISO 639:1988.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The language identifier. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpJob
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpjob.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpJob extends XmpComplexType
```

Represents Job.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpJob() | Initializes a new instance of the  XmpJob  class. |
#### Methods

| Method | Description |
| --- | --- |
| getID() | Gets unique id for the job. |
| setID(String value) | Sets unique id for the job. |
| getName() | Gets informal name of the job. |
| setName(String value) | Sets informal name of the job. |
| getUrl() | Gets a file URL referencing an external job management file. |
| setUrl(String value) | Sets a file URL referencing an external job management file. |
##### XmpJob()
```
public XmpJob()
```

Initializes a new instance of the  XmpJob  class.

##### getID()
```
public final String getID()
```

Gets unique id for the job. This field is a reference into some external job management system.

**Returns:**
java.lang.String - The identifier.
##### setID(String value)
```
public final void setID(String value)
```

Sets unique id for the job. This field is a reference into some external job management system.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The identifier. |

##### getName()
```
public final String getName()
```

Gets informal name of the job. This name is for user display and informal systems.

**Returns:**
java.lang.String - The name.
##### setName(String value)
```
public final void setName(String value)
```

Sets informal name of the job. This name is for user display and informal systems.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name. |

##### getUrl()
```
public final String getUrl()
```

Gets a file URL referencing an external job management file.

**Returns:**
java.lang.String - The URL.
##### setUrl(String value)
```
public final void setUrl(String value)
```

Sets a file URL referencing an external job management file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URL. |

### XmpLangAlt
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmplangalt.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase, com.groupdocs.metadata.core.XmpArray
```
public final class XmpLangAlt extends XmpArray
```

Represents XMP Language Alternative.

An alternative array of simple text items. Language alternatives facilitate the selection of a simple text item based on a desired language. Each array item shall have an xml:lang qualifier. Each xml:lang value shall be unique among the items.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpLangAlt(String defaultValue) | Initializes a new instance of the  XmpLangAlt  class. |
| XmpLangAlt(Hashtable<String,String> dictionary) | Initializes a new instance of the  XmpLangAlt  class. |
#### Methods

| Method | Description |
| --- | --- |
| get_Item(String language) | Gets the value associated with the specified language. |
| getLanguages() | Gets an array of all languages registered in the instance of  XmpLangAlt . |
| contains(String language) | Determines whether the  XmpLangAlt  contains the specified language. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpLangAlt(String defaultValue)
```
public XmpLangAlt(String defaultValue)
```

Initializes a new instance of the  XmpLangAlt  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| defaultValue | java.lang.String | The default value. |

##### XmpLangAlt(Hashtable<String,String> dictionary)
```
public XmpLangAlt(Hashtable<String,String> dictionary)
```

Initializes a new instance of the  XmpLangAlt  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | java.util.Hashtable<java.lang.String,java.lang.String> | A dictionary containing values by languages. |

##### get_Item(String language)
```
public final String get_Item(String language)
```

Gets the value associated with the specified language.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language. Value: String value. |

**Returns:**
java.lang.String - Value for the specified language.
##### getLanguages()
```
public final String[] getLanguages()
```

Gets an array of all languages registered in the instance of  XmpLangAlt .

**Returns:**
java.lang.String[] - An array of all languages registered in the instance of  XmpLangAlt .
##### contains(String language)
```
public final boolean contains(String language)
```

Determines whether the  XmpLangAlt  contains the specified language.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | java.lang.String | The language to locate in the  XmpLangAlt . |

**Returns:**
boolean - True if the  XmpLangAlt  contains an element with the specified language; otherwise, false.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpMediaManagementPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpmediamanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpMediaManagementPackage extends XmpPackage
```

Represents the XMP Media Management namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpMediaManagementPackage() | Initializes a new instance of the  XmpMediaManagementPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDerivedFrom() | Gets the reference to the resource from which this one is derived. |
| setDerivedFrom(XmpResourceRef value) | Sets the reference to the resource from which this one is derived. |
| getDocumentID() | Gets the common identifier for all versions and renditions of the resource. |
| setDocumentID(String value) | Sets the common identifier for all versions and renditions of the resource. |
| getHistory() | Gets an array of high-level actions that resulted in this resource. |
| setHistory(XmpResourceEvent[] value) | Sets an array of high-level actions that resulted in this resource. |
| getIngredients() | Gets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| setIngredients(XmpResourceRef[] value) | Sets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| getInstanceID() | Gets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| setInstanceID(String value) | Sets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| getManagedFrom() | Gets the reference to the document as it was prior to becoming managed. |
| setManagedFrom(XmpResourceRef value) | Sets the reference to the document as it was prior to becoming managed. |
| getManager() | Gets the name of the asset management system that manages this resource. |
| setManager(String value) | Sets the name of the asset management system that manages this resource. |
| getManageTo() | Gets the URI identifying the managed resource to the asset management system |
| setManageTo(String value) | Sets the URI identifying the managed resource to the asset management system |
| getManageUI() | Gets the URI that can be used to access information about the managed resource through a web browser. |
| setManageUI(String value) | Sets the URI that can be used to access information about the managed resource through a web browser. |
| getManagerVariant() | Gets the particular variant of the asset management system. |
| setManagerVariant(String value) | Sets the particular variant of the asset management system. |
| getOriginalDocumentID() | Gets the common identifier for the original resource from which the current resource is derived. |
| setOriginalDocumentID(String value) | Sets the common identifier for the original resource from which the current resource is derived. |
| getRenditionClass() | Gets the rendition class name for this resource. |
| setRenditionClass(String value) | Sets the rendition class name for this resource. |
| getRenditionParams() | Gets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass. |
| setRenditionParams(String value) | Sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass. |
| getVersionID() | Gets the document version identifier for this resource. |
| setVersionID(String value) | Sets the document version identifier for this resource. |
| getVersions() | Gets the version history associated with this resource. |
| setVersions(XmpVersion[] value) | Sets the version history associated with this resource. |
##### XmpMediaManagementPackage()
```
public XmpMediaManagementPackage()
```

Initializes a new instance of the  XmpMediaManagementPackage  class.

##### getDerivedFrom()
```
public final XmpResourceRef getDerivedFrom()
```

Gets the reference to the resource from which this one is derived.

**Returns:**
XmpResourceRef - The the reference to the resource from which this one is derived.
##### setDerivedFrom(XmpResourceRef value)
```
public final void setDerivedFrom(XmpResourceRef value)
```

Sets the reference to the resource from which this one is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef | The the reference to the resource from which this one is derived. |

##### getDocumentID()
```
public final String getDocumentID()
```

Gets the common identifier for all versions and renditions of the resource.

**Returns:**
java.lang.String - The common identifier for all versions and renditions of the resource.
##### setDocumentID(String value)
```
public final void setDocumentID(String value)
```

Sets the common identifier for all versions and renditions of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The common identifier for all versions and renditions of the resource. |

##### getHistory()
```
public final XmpResourceEvent[] getHistory()
```

Gets an array of high-level actions that resulted in this resource.

**Returns:**
com.groupdocs.metadata.core.XmpResourceEvent[] - An array of high-level actions that resulted in this resource.
##### setHistory(XmpResourceEvent[] value)
```
public final void setHistory(XmpResourceEvent[] value)
```

Sets an array of high-level actions that resulted in this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceEvent\[\] | An array of high-level actions that resulted in this resource. |

##### getIngredients()
```
public final XmpResourceRef[] getIngredients()
```

Gets the references to resources that were incorporated, by inclusion or reference, into this resource.

**Returns:**
com.groupdocs.metadata.core.XmpResourceRef[] - The references to resources that were incorporated, by inclusion or reference, into this resource.
##### setIngredients(XmpResourceRef[] value)
```
public final void setIngredients(XmpResourceRef[] value)
```

Sets the references to resources that were incorporated, by inclusion or reference, into this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef\[\] | The references to resources that were incorporated, by inclusion or reference, into this resource. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the identifier for a specific incarnation of a resource, updated each time the file is saved.

**Returns:**
java.lang.String - The identifier for a specific incarnation of a resource, updated each time a file is saved.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the identifier for a specific incarnation of a resource, updated each time the file is saved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The identifier for a specific incarnation of a resource, updated each time a file is saved. |

##### getManagedFrom()
```
public final XmpResourceRef getManagedFrom()
```

Gets the reference to the document as it was prior to becoming managed.

**Returns:**
XmpResourceRef - The reference to the document as it was prior to becoming managed.
##### setManagedFrom(XmpResourceRef value)
```
public final void setManagedFrom(XmpResourceRef value)
```

Sets the reference to the document as it was prior to becoming managed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceRef | The reference to the document as it was prior to becoming managed. |

##### getManager()
```
public final String getManager()
```

Gets the name of the asset management system that manages this resource.

**Returns:**
java.lang.String - The name of the asset management system that manages this resource.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the name of the asset management system that manages this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the asset management system that manages this resource. |

##### getManageTo()
```
public final String getManageTo()
```

Gets the URI identifying the managed resource to the asset management system

**Returns:**
java.lang.String - The URI identifying the managed resource to the asset management system.
##### setManageTo(String value)
```
public final void setManageTo(String value)
```

Sets the URI identifying the managed resource to the asset management system

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URI identifying the managed resource to the asset management system. |

##### getManageUI()
```
public final String getManageUI()
```

Gets the URI that can be used to access information about the managed resource through a web browser.

**Returns:**
java.lang.String - The URI that can be used to access information about the managed resource through a web browser.
##### setManageUI(String value)
```
public final void setManageUI(String value)
```

Sets the URI that can be used to access information about the managed resource through a web browser.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The URI that can be used to access information about the managed resource through a web browser. |

##### getManagerVariant()
```
public final String getManagerVariant()
```

Gets the particular variant of the asset management system.

**Returns:**
java.lang.String - The particular variant of the asset management system. The format of this property is private to the specific asset management system.
##### setManagerVariant(String value)
```
public final void setManagerVariant(String value)
```

Sets the particular variant of the asset management system.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The particular variant of the asset management system. The format of this property is private to the specific asset management system. |

##### getOriginalDocumentID()
```
public final String getOriginalDocumentID()
```

Gets the common identifier for the original resource from which the current resource is derived.

**Returns:**
java.lang.String - The common identifier for the original resource from which the current resource is derived
##### setOriginalDocumentID(String value)
```
public final void setOriginalDocumentID(String value)
```

Sets the common identifier for the original resource from which the current resource is derived.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The common identifier for the original resource from which the current resource is derived |

##### getRenditionClass()
```
public final String getRenditionClass()
```

Gets the rendition class name for this resource.

**Returns:**
java.lang.String - The rendition class name for this resource. This property should be absent or set to default for a resource that is not a derived rendition.
##### setRenditionClass(String value)
```
public final void setRenditionClass(String value)
```

Sets the rendition class name for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The rendition class name for this resource. This property should be absent or set to default for a resource that is not a derived rendition. |

##### getRenditionParams()
```
public final String getRenditionParams()
```

Gets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass.

**Returns:**
java.lang.String - The value that is used to provide additional rendition parameters.
##### setRenditionParams(String value)
```
public final void setRenditionParams(String value)
```

Sets the value that is used to provide additional rendition parameters that are too complex or verbose to encode in xmpMM:RenditionClass.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value that is used to provide additional rendition parameters. |

##### getVersionID()
```
public final String getVersionID()
```

Gets the document version identifier for this resource.

**Returns:**
java.lang.String - The document version identifier for this resource.
##### setVersionID(String value)
```
public final void setVersionID(String value)
```

Sets the document version identifier for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document version identifier for this resource. |

##### getVersions()
```
public final XmpVersion[] getVersions()
```

Gets the version history associated with this resource.

**Returns:**
com.groupdocs.metadata.core.XmpVersion[] - The version history associated with this resource. Entry [0] is the oldest known version for this document, entry [Versions.Length - 1] is the most recent version.
##### setVersions(XmpVersion[] value)
```
public final void setVersions(XmpVersion[] value)
```

Sets the version history associated with this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpVersion\[\] | The version history associated with this resource. Entry [0] is the oldest known version for this document, entry [Versions.Length - 1] is the most recent version. |

### XmpMeta
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpmeta.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpElementBase

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpMeta extends XmpElementBase implements IXmpType
```

Represents xmpmeta. Optional. The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpMeta() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAdobeXmpToolkit() | Gets Adobe XMP toolkit version. |
| setAttribute(String attribute, String value) | Adds an attribute. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpMeta()
```
public XmpMeta()
```

##### getAdobeXmpToolkit()
```
public final String getAdobeXmpToolkit()
```

Gets Adobe XMP toolkit version.

**Returns:**
java.lang.String - The toolkit version.
##### setAttribute(String attribute, String value)
```
public void setAttribute(String attribute, String value)
```

Adds an attribute.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attribute | java.lang.String | The attribute. |
| value | java.lang.String | The value. |

##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpMetadataContainer
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpmetadatacontainer.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public abstract class XmpMetadataContainer extends CustomPackage implements IXmpType
```

Represents a container for XMP metadata properties.
#### Methods

| Method | Description |
| --- | --- |
| getXmpRepresentation() | Converts the XMP value to the XML representation. |
##### getXmpRepresentation()
```
public abstract String getXmpRepresentation()
```

Converts the XMP value to the XML representation.

**Returns:**
java.lang.String - A  string  representation of the XMP value.

### XmpNamespaces
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpnamespaces.md

**Inheritance:**
java.lang.Object
```
public class XmpNamespaces
```

Contains namespaces used in  XmpPackage  and  XmpComplexType .
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpNamespaces() |  |
#### Fields

| Field | Description |
| --- | --- |
| Xml | Xml namespace. |
| Rdf | Resource definition framework namespace. |
| BasicJob | Basic Job Ticket namespace. |
| CameraRaw | Camera Raw namespace. |
| DublinCore | Dublin Core namespace. |
| Iptc4XmpIim | IPTC IIM namespace. |
| Iptc4XmpCore | IPTC Core namespace. |
| Iptc4XmpExt | IPTC Extension namespace. |
| XmpBasic | XMP Basic namespace. |
| XmpRights | XMP Rights Management namespace. |
| XmpMM | XMP digital asset management namespace. |
| XmpDM | XMP Dynamic Media namespace. |
| Pdf | Adobe PDF namespace. |
| Photoshop | Adobe Photoshop namespace. |
| PagedText | XMP Paged-Text namespace. |
| XmpGraphics | XMP graphics namespace. |
| XmpGraphicsThumbnail | XMP graphics namespace. |
| XmpTypeFont | XMP Font type. |
| XmpTypeDimensions | XMP Dimensions type. |
| XmpTypeResourceRef | XMP ResourceRef URI. |
| XmpTypeResourceEvent | XMP ResourceEvent URI. |
| XmpTypeVersion | XMP Version. |
| XmpTypeJob | XMP Job Ticket. |
##### XmpNamespaces()
```
public XmpNamespaces()
```

##### Xml
```
public static final String Xml
```

Xml namespace.

##### Rdf
```
public static final String Rdf
```

Resource definition framework namespace.

##### BasicJob
```
public static final String BasicJob
```

Basic Job Ticket namespace.

##### CameraRaw
```
public static final String CameraRaw
```

Camera Raw namespace.

##### DublinCore
```
public static final String DublinCore
```

Dublin Core namespace.

##### Iptc4XmpIim
```
public static final String Iptc4XmpIim
```

IPTC IIM namespace.

##### Iptc4XmpCore
```
public static final String Iptc4XmpCore
```

IPTC Core namespace.

##### Iptc4XmpExt
```
public static final String Iptc4XmpExt
```

IPTC Extension namespace.

##### XmpBasic
```
public static final String XmpBasic
```

XMP Basic namespace.

##### XmpRights
```
public static final String XmpRights
```

XMP Rights Management namespace.

##### XmpMM
```
public static final String XmpMM
```

XMP digital asset management namespace.

##### XmpDM
```
public static final String XmpDM
```

XMP Dynamic Media namespace.

##### Pdf
```
public static final String Pdf
```

Adobe PDF namespace.

##### Photoshop
```
public static final String Photoshop
```

Adobe Photoshop namespace.

##### PagedText
```
public static final String PagedText
```

XMP Paged-Text namespace.

##### XmpGraphics
```
public static final String XmpGraphics
```

XMP graphics namespace.

##### XmpGraphicsThumbnail
```
public static final String XmpGraphicsThumbnail
```

XMP graphics namespace.

##### XmpTypeFont
```
public static final String XmpTypeFont
```

XMP Font type.

##### XmpTypeDimensions
```
public static final String XmpTypeDimensions
```

XMP Dimensions type.

##### XmpTypeResourceRef
```
public static final String XmpTypeResourceRef
```

XMP ResourceRef URI.

##### XmpTypeResourceEvent
```
public static final String XmpTypeResourceEvent
```

XMP ResourceEvent URI.

##### XmpTypeVersion
```
public static final String XmpTypeVersion
```

XMP Version.

##### XmpTypeJob
```
public static final String XmpTypeJob
```

XMP Job Ticket.

### XmpPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer
```
public class XmpPackage extends XmpMetadataContainer
```

Represents base abstraction for XMP package.

This example demonstrates how to add a custom XMP package to a file of any supported format.

> ```
> ```
>
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      IXmp root = (IXmp) metadata.getRootPackage();
>      XmpPacketWrapper packet = new XmpPacketWrapper();
>      XmpPackage custom = new XmpPackage("gd", "https://groupdocs.com");
>      custom.set("gd:Copyright", "Copyright (C) 2011-2024 GroupDocs. All Rights Reserved.");
>      custom.set("gd:CreationDate", new Date());
>      custom.set("gd:Company", XmpArray.from(new String[]{"Aspose", "GroupDocs"}, XmpArrayType.Ordered));
>      packet.addPackage(custom);
>      root.setXmpPackage(packet);
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPackage(String prefix, String namespaceUri) | Initializes a new instance of the  XmpPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPrefix() | Gets the xmlns prefix. |
| getNamespaceUri() | Gets the namespace URI. |
| getXmlNamespace() | Gets the XML namespace. |
| set(String name, String value) | Sets string property. |
| set(String name, int value) | Sets integer property. |
| set(String name, boolean value) | Sets boolean property. |
| set(String name, Date value) | Sets  DateTime  property. |
| set(String name, double value) | Sets double property. |
| remove(String name) | Removes the property with the specified name. |
| clear() | Removes all XMP properties. |
| set(String name, XmpValueBase value) | Sets the value inherited from  XmpValueBase  . |
| set(String name, XmpComplexType value) | Sets the value inherited from  XmpComplexType  . |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
| getXmpRepresentation() | Converts the XMP value to the XML representation. |
##### XmpPackage(String prefix, String namespaceUri)
```
public XmpPackage(String prefix, String namespaceUri)
```

Initializes a new instance of the  XmpPackage  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| prefix | java.lang.String | XMP prefix, for example dc:title. |
| namespaceUri | java.lang.String | Namespace uri. |

##### getPrefix()
```
public final String getPrefix()
```

Gets the xmlns prefix.

**Returns:**
java.lang.String - The prefix.
##### getNamespaceUri()
```
public final String getNamespaceUri()
```

Gets the namespace URI.

**Returns:**
java.lang.String - The namespace URI.
##### getXmlNamespace()
```
public final String getXmlNamespace()
```

Gets the XML namespace.

**Returns:**
java.lang.String - The XML namespace.
##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, int value)
```
public final void set(String name, int value)
```

Sets integer property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

##### set(String name, boolean value)
```
public final void set(String name, boolean value)
```

Sets boolean property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | boolean | XMP metadata property value. |

##### set(String name, Date value)
```
public final void set(String name, Date value)
```

Sets  DateTime  property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.util.Date | XMP metadata property value. |

##### set(String name, double value)
```
public final void set(String name, double value)
```

Sets double property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | double | XMP metadata property value. |

##### remove(String name)
```
public final boolean remove(String name)
```

Removes the property with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |

**Returns:**
boolean - True if the specified metadata property is found and removed; otherwise, false.
##### clear()
```
public final void clear()
```

Removes all XMP properties.

##### set(String name, XmpValueBase value)
```
public final void set(String name, XmpValueBase value)
```

Sets the value inherited from  XmpValueBase  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpValueBase | XMP metadata property value. |

##### set(String name, XmpComplexType value)
```
public void set(String name, XmpComplexType value)
```

Sets the value inherited from  XmpComplexType  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpComplexType | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Converts the XMP value to the XML representation.

**Returns:**
java.lang.String - A  string  representation of the XMP value.

### XmpPacketWrapper
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmppacketwrapper.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public class XmpPacketWrapper extends MetadataPackage implements IXmpType
```

Contains serialized XMP package including header and trailer. A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

[Working with XMP metadata]: https://docs.groupdocs.com/display/metadatajava/Working+with+XMP+metadata
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta) | Initializes a new instance of the  XmpPacketWrapper  class. |
| XmpPacketWrapper() | Initializes a new instance of the  XmpPacketWrapper  class. |
#### Methods

| Method | Description |
| --- | --- |
| getHeaderPI() | Gets the header processing instruction. |
| setHeaderPI(XmpHeaderPI value) | Sets the header processing instruction. |
| getMeta() | Gets the XMP meta. |
| setMeta(XmpMeta value) | Sets the XMP meta. |
| getTrailerPI() | Gets the trailer processing instruction. |
| setTrailerPI(XmpTrailerPI value) | Sets the trailer processing instruction. |
| getPackages() | Gets array of  XmpPackage  inside XMP. |
| getPackageCount() | Gets the number of packages inside the XMP structure. |
| getSchemes() | Provides access to known XMP schemas. |
| addPackage(XmpPackage package_) | Adds the package. |
| getPackage(String namespaceUri) | Gets package by namespace uri. |
| containsPackage(String namespaceUri) | Determines whether package is exist in XMP wrapper. |
| removePackage(XmpPackage package_) | Removes the specified package. |
| clearPackages() | Removes all  XmpPackage  inside XMP. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)
```
public XmpPacketWrapper(XmpHeaderPI header, XmpTrailerPI trailer, XmpMeta xmpMeta)
```

Initializes a new instance of the  XmpPacketWrapper  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| header | XmpHeaderPI | XMP header processing instruction. |
| trailer | XmpTrailerPI | XMP trailer processing instruction. |
| xmpMeta | XmpMeta | Instance of  XmpMeta . |

##### XmpPacketWrapper()
```
public XmpPacketWrapper()
```

Initializes a new instance of the  XmpPacketWrapper  class.

##### getHeaderPI()
```
public final XmpHeaderPI getHeaderPI()
```

Gets the header processing instruction.

**Returns:**
XmpHeaderPI - The header processing instruction.
##### setHeaderPI(XmpHeaderPI value)
```
public final void setHeaderPI(XmpHeaderPI value)
```

Sets the header processing instruction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpHeaderPI | The header processing instruction. |

##### getMeta()
```
public final XmpMeta getMeta()
```

Gets the XMP meta.

**Returns:**
XmpMeta - The XMP meta.
##### setMeta(XmpMeta value)
```
public final void setMeta(XmpMeta value)
```

Sets the XMP meta.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpMeta | The XMP meta. |

##### getTrailerPI()
```
public final XmpTrailerPI getTrailerPI()
```

Gets the trailer processing instruction.

**Returns:**
XmpTrailerPI - The trailer processing instruction.
##### setTrailerPI(XmpTrailerPI value)
```
public final void setTrailerPI(XmpTrailerPI value)
```

Sets the trailer processing instruction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpTrailerPI | The trailer processing instruction. |

##### getPackages()
```
public final XmpPackage[] getPackages()
```

Gets array of  XmpPackage  inside XMP.

**Returns:**
com.groupdocs.metadata.core.XmpPackage[] - XMP packages.
##### getPackageCount()
```
public final int getPackageCount()
```

Gets the number of packages inside the XMP structure.

**Returns:**
int - The package count.
##### getSchemes()
```
public final XmpSchemes getSchemes()
```

Provides access to known XMP schemas.

**Returns:**
XmpSchemes - XMP schemes.
##### addPackage(XmpPackage package_)
```
public final void addPackage(XmpPackage package_)
```

Adds the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| package_ | XmpPackage |  |

##### getPackage(String namespaceUri)
```
public final XmpPackage getPackage(String namespaceUri)
```

Gets package by namespace uri.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | java.lang.String | Package schema uri. |

**Returns:**
XmpPackage - Appropriate  XmpPackage  if package found by  namespaceUri ; otherwise null.
##### containsPackage(String namespaceUri)
```
public final boolean containsPackage(String namespaceUri)
```

Determines whether package is exist in XMP wrapper.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| namespaceUri | java.lang.String | Package namespace URI. |

**Returns:**
boolean -  true  if package found by  namespaceUri ; otherwise  false .
##### removePackage(XmpPackage package_)
```
public final void removePackage(XmpPackage package_)
```

Removes the specified package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| package_ | XmpPackage |  |

##### clearPackages()
```
public final void clearPackages()
```

Removes all  XmpPackage  inside XMP.

##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpPagedTextPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmppagedtextpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPagedTextPackage extends XmpPackage
```

Represents the XMP Paged-Text package.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPagedTextPackage() | Initializes a new instance of the  XmpPagedTextPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getColorants() | Gets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| setColorants(XmpColorantBase[] value) | Sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| getFonts() | Gets an unordered array of fonts that are used in the document (including any in contained documents). |
| setFonts(XmpFont[] value) | Sets an unordered array of fonts that are used in the document (including any in contained documents). |
| getMaxPageSize() | Gets the size of the largest page in the document (including any in contained documents). |
| setMaxPageSize(XmpDimensions value) | Sets the size of the largest page in the document (including any in contained documents). |
| getNumberOfPages() | Gets the number of pages in the document. |
| setNumberOfPages(Integer value) | Sets the number of pages in the document. |
| getPlateNames() | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |
| setPlateNames(String[] value) | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |
| set(String name, String value) | Sets string property. |
| set(String name, XmpArray value) | Sets the value inherited from  XmpArray  . |
##### XmpPagedTextPackage()
```
public XmpPagedTextPackage()
```

Initializes a new instance of the  XmpPagedTextPackage  class.

##### getColorants()
```
public final XmpColorantBase[] getColorants()
```

Gets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).

**Returns:**
com.groupdocs.metadata.core.XmpColorantBase[] - An array of the colorants.
##### setColorants(XmpColorantBase[] value)
```
public final void setColorants(XmpColorantBase[] value)
```

Sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpColorantBase\[\] | An array of the colorants. |

##### getFonts()
```
public final XmpFont[] getFonts()
```

Gets an unordered array of fonts that are used in the document (including any in contained documents).

**Returns:**
com.groupdocs.metadata.core.XmpFont[] - An array of the fonts.
##### setFonts(XmpFont[] value)
```
public final void setFonts(XmpFont[] value)
```

Sets an unordered array of fonts that are used in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpFont\[\] | An array of the fonts. |

##### getMaxPageSize()
```
public final XmpDimensions getMaxPageSize()
```

Gets the size of the largest page in the document (including any in contained documents).

**Returns:**
XmpDimensions - The size of the largest page.
##### setMaxPageSize(XmpDimensions value)
```
public final void setMaxPageSize(XmpDimensions value)
```

Sets the size of the largest page in the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDimensions | The size of the largest page. |

##### getNumberOfPages()
```
public final Integer getNumberOfPages()
```

Gets the number of pages in the document.

**Returns:**
java.lang.Integer - The number of pages.
##### setNumberOfPages(Integer value)
```
public final void setNumberOfPages(Integer value)
```

Sets the number of pages in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The number of pages. |

##### getPlateNames()
```
public final String[] getPlateNames()
```

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).

**Returns:**
java.lang.String[] - The plate names.
##### setPlateNames(String[] value)
```
public final void setPlateNames(String[] value)
```

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] |  |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

##### set(String name, XmpArray value)
```
public void set(String name, XmpArray value)
```

Sets the value inherited from  XmpArray  .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | XmpArray | XMP metadata property value. |

### XmpPdfPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmppdfpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPdfPackage extends XmpPackage
```

Specifies properties used with Adobe PDF documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPdfPackage() | Initializes a new instance of the  XmpPdfPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getKeywords() | Gets the keywords. |
| setKeywords(String value) | Sets the keywords. |
| getPdfVersion() | Gets the PDF file version. |
| setPdfVersion(String value) | Sets the PDF file version. |
| getProducer() | Gets the name of the tool that created the PDF document. |
| setProducer(String value) | Sets the name of the tool that created the PDF document. |
| isTrapped() | Gets a value indicating whether the document has been trapped. |
| setTrapped(Boolean value) | Sets a value indicating whether the document has been trapped. |
| set(String name, String value) | Sets string property. |
##### XmpPdfPackage()
```
public XmpPdfPackage()
```

Initializes a new instance of the  XmpPdfPackage  class.

##### getKeywords()
```
public final String getKeywords()
```

Gets the keywords.

**Returns:**
java.lang.String - The keywords.
##### setKeywords(String value)
```
public final void setKeywords(String value)
```

Sets the keywords.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getPdfVersion()
```
public final String getPdfVersion()
```

Gets the PDF file version. For example, 1.0, 1.3 and so on.

**Returns:**
java.lang.String - The PDF version.
##### setPdfVersion(String value)
```
public final void setPdfVersion(String value)
```

Sets the PDF file version. For example, 1.0, 1.3 and so on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The PDF version. |

##### getProducer()
```
public final String getProducer()
```

Gets the name of the tool that created the PDF document.

**Returns:**
java.lang.String - The producer.
##### setProducer(String value)
```
public final void setProducer(String value)
```

Sets the name of the tool that created the PDF document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The producer. |

##### isTrapped()
```
public final Boolean isTrapped()
```

Gets a value indicating whether the document has been trapped.

**Returns:**
java.lang.Boolean -  true  if the document has been trapped; otherwise,  false .
##### setTrapped(Boolean value)
```
public final void setTrapped(Boolean value)
```

Sets a value indicating whether the document has been trapped.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the document has been trapped; otherwise,  false . |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpPhotoshopColorMode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpphotoshopcolormode.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum XmpPhotoshopColorMode extends Enum<XmpPhotoshopColorMode> implements IEnumValue
```

Represents a color mode in  XmpPhotoshopPackage .
#### Fields

| Field | Description |
| --- | --- |
| Bitmap | The bitmap color mode. |
| GrayScale | The gray scale color mode. |
| IndexedColor | The indexed color. |
| Rgb | The RGB color mode. |
| Cmyk | The CMYK color mode. |
| MultiChannel | The multi-channel color mode. |
| Duotone | The duo-tone color mode. |
| LabColor | The LAB color mode. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Bitmap
```
public static final XmpPhotoshopColorMode Bitmap
```

The bitmap color mode.

##### GrayScale
```
public static final XmpPhotoshopColorMode GrayScale
```

The gray scale color mode.

##### IndexedColor
```
public static final XmpPhotoshopColorMode IndexedColor
```

The indexed color.

##### Rgb
```
public static final XmpPhotoshopColorMode Rgb
```

The RGB color mode.

##### Cmyk
```
public static final XmpPhotoshopColorMode Cmyk
```

The CMYK color mode.

##### MultiChannel
```
public static final XmpPhotoshopColorMode MultiChannel
```

The multi-channel color mode.

##### Duotone
```
public static final XmpPhotoshopColorMode Duotone
```

The duo-tone color mode.

##### LabColor
```
public static final XmpPhotoshopColorMode LabColor
```

The LAB color mode.

##### values()
```
public static XmpPhotoshopColorMode[] values()
```

**Returns:**
com.groupdocs.metadata.core.XmpPhotoshopColorMode[]
##### valueOf(String name)
```
public static XmpPhotoshopColorMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
XmpPhotoshopColorMode
##### getByRawValue(int rawValue)
```
public static XmpPhotoshopColorMode getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
XmpPhotoshopColorMode
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### XmpPhotoshopPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpphotoshoppackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpPhotoshopPackage extends XmpPackage
```

Represents Adobe Photoshop namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpPhotoshopPackage() | Initializes a new instance of the  XmpPhotoshopPackage  class. |
#### Fields

| Field | Description |
| --- | --- |
| UrgencyMax | Urgency max value. |
| UrgencyMin | Urgency min value. |
#### Methods

| Method | Description |
| --- | --- |
| getAuthorsPosition() | Gets the by-line title. |
| setAuthorsPosition(String value) | Sets the by-line title. |
| getCaptionWriter() | Gets the writer/editor. |
| setCaptionWriter(String value) | Sets the writer/editor. |
| getCategory() | Gets the category. |
| setCategory(String value) | Sets the category. |
| getCity() | Gets the city. |
| setCity(String value) | Sets the city. |
| getColorMode() | Gets the color mode. |
| setColorMode(XmpPhotoshopColorMode value) | Sets the color mode. |
| getCountry() | Gets the country. |
| setCountry(String value) | Sets the country. |
| getCredit() | Gets the credit. |
| setCredit(String value) | Sets the credit. |
| getDateCreated() | Gets the date the intellectual content of the document was created. |
| setDateCreated(Date value) | Sets the date the intellectual content of the document was created. |
| getHeadline() | Gets the headline. |
| setHeadline(String value) | Sets the headline. |
| getHistory() | Gets the history that appears in the FileInfo panel, if activated in the application preferences. |
| setHistory(String value) | Sets the history that appears in the FileInfo panel, if activated in the application preferences. |
| getIccProfile() | Gets the color profile, such as AppleRGB, AdobeRGB1998. |
| setIccProfile(String value) | Sets the color profile, such as AppleRGB, AdobeRGB1998. |
| getInstructions() | Gets the special instructions. |
| setInstructions(String value) | Sets the special instructions. |
| getSource() | Gets the source. |
| setSource(String value) | Sets the source. |
| getState() | Gets the province/state. |
| setState(String value) | Sets the province/state. |
| getSupplementalCategories() | Gets the supplemental categories. |
| setSupplementalCategories(String[] value) | Sets the supplemental categories. |
| getTransmissionReference() | Gets the original transmission reference. |
| setTransmissionReference(String value) | Sets the original transmission reference. |
| getUrgency() | Gets the urgency. |
| setUrgency(Integer value) | Sets the urgency. |
| set(String name, String value) | Sets string property. |
##### XmpPhotoshopPackage()
```
public XmpPhotoshopPackage()
```

Initializes a new instance of the  XmpPhotoshopPackage  class.

##### UrgencyMax
```
public static final int UrgencyMax
```

Urgency max value.

##### UrgencyMin
```
public static final int UrgencyMin
```

Urgency min value.

##### getAuthorsPosition()
```
public final String getAuthorsPosition()
```

Gets the by-line title.

**Returns:**
java.lang.String - The authors position.
##### setAuthorsPosition(String value)
```
public final void setAuthorsPosition(String value)
```

Sets the by-line title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The authors position. |

##### getCaptionWriter()
```
public final String getCaptionWriter()
```

Gets the writer/editor.

**Returns:**
java.lang.String - The caption writer.
##### setCaptionWriter(String value)
```
public final void setCaptionWriter(String value)
```

Sets the writer/editor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The caption writer. |

##### getCategory()
```
public final String getCategory()
```

Gets the category. Limited to 3 7-bit ASCII characters.

**Returns:**
java.lang.String - The category. Limited to 3 ASCII characters.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets the category. Limited to 3 7-bit ASCII characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The category. Limited to 3 ASCII characters. |

##### getCity()
```
public final String getCity()
```

Gets the city.

**Returns:**
java.lang.String - The city.
##### setCity(String value)
```
public final void setCity(String value)
```

Sets the city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The city. |

##### getColorMode()
```
public final XmpPhotoshopColorMode getColorMode()
```

Gets the color mode.

**Returns:**
XmpPhotoshopColorMode - The color mode.
##### setColorMode(XmpPhotoshopColorMode value)
```
public final void setColorMode(XmpPhotoshopColorMode value)
```

Sets the color mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPhotoshopColorMode | The color mode. |

##### getCountry()
```
public final String getCountry()
```

Gets the country.

**Returns:**
java.lang.String - The country.
##### setCountry(String value)
```
public final void setCountry(String value)
```

Sets the country.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The country. |

##### getCredit()
```
public final String getCredit()
```

Gets the credit.

**Returns:**
java.lang.String - The credit.
##### setCredit(String value)
```
public final void setCredit(String value)
```

Sets the credit.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The credit. |

##### getDateCreated()
```
public final Date getDateCreated()
```

Gets the date the intellectual content of the document was created.

**Returns:**
java.util.Date - The created date of the document.
##### setDateCreated(Date value)
```
public final void setDateCreated(Date value)
```

Sets the date the intellectual content of the document was created.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The created date of the document. |

##### getHeadline()
```
public final String getHeadline()
```

Gets the headline.

**Returns:**
java.lang.String - The headline.
##### setHeadline(String value)
```
public final void setHeadline(String value)
```

Sets the headline.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The headline. |

##### getHistory()
```
public final String getHistory()
```

Gets the history that appears in the FileInfo panel, if activated in the application preferences.

**Returns:**
java.lang.String - The history.
##### setHistory(String value)
```
public final void setHistory(String value)
```

Sets the history that appears in the FileInfo panel, if activated in the application preferences.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The history. |

##### getIccProfile()
```
public final String getIccProfile()
```

Gets the color profile, such as AppleRGB, AdobeRGB1998.

**Returns:**
java.lang.String - The ICC profile.
##### setIccProfile(String value)
```
public final void setIccProfile(String value)
```

Sets the color profile, such as AppleRGB, AdobeRGB1998.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The ICC profile. |

##### getInstructions()
```
public final String getInstructions()
```

Gets the special instructions.

**Returns:**
java.lang.String - The special instructions.
##### setInstructions(String value)
```
public final void setInstructions(String value)
```

Sets the special instructions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The special instructions. |

##### getSource()
```
public final String getSource()
```

Gets the source.

**Returns:**
java.lang.String - The source.
##### setSource(String value)
```
public final void setSource(String value)
```

Sets the source.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The source. |

##### getState()
```
public final String getState()
```

Gets the province/state.

**Returns:**
java.lang.String - The province/state.
##### setState(String value)
```
public final void setState(String value)
```

Sets the province/state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The province/state. |

##### getSupplementalCategories()
```
public final String[] getSupplementalCategories()
```

Gets the supplemental categories.

**Returns:**
java.lang.String[] - The supplemental categories.
##### setSupplementalCategories(String[] value)
```
public final void setSupplementalCategories(String[] value)
```

Sets the supplemental categories.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The supplemental categories. |

##### getTransmissionReference()
```
public final String getTransmissionReference()
```

Gets the original transmission reference.

**Returns:**
java.lang.String - The transmission reference.
##### setTransmissionReference(String value)
```
public final void setTransmissionReference(String value)
```

Sets the original transmission reference.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The transmission reference. |

##### getUrgency()
```
public final Integer getUrgency()
```

Gets the urgency.

**Returns:**
java.lang.Integer - The urgency.

Valid range is 1-8.
##### setUrgency(Integer value)
```
public final void setUrgency(Integer value)
```

Sets the urgency.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The urgency.

Valid range is 1-8. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpRational
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmprational.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpRational extends XmpValueBase
```

Represents XMP XmpRational.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRational(long numerator, long denominator) | Initializes a new instance of the  XmpRational  class. |
| XmpRational(String value) | Initializes a new instance of the  XmpBoolean  class. |
#### Methods

| Method | Description |
| --- | --- |
| getNumerator() | Gets numerator. |
| getDenominator() | Gets denominator |
| getDoubleValue() | Gets value of rational type presented in double format. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpRational(long numerator, long denominator)
```
public XmpRational(long numerator, long denominator)
```

Initializes a new instance of the  XmpRational  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numerator | long | The numerator. |
| denominator | long | The denominator. |

##### XmpRational(String value)
```
public XmpRational(String value)
```

Initializes a new instance of the  XmpBoolean  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getNumerator()
```
public final long getNumerator()
```

Gets numerator.

**Returns:**
long - The numerator.
##### getDenominator()
```
public final long getDenominator()
```

Gets denominator

**Returns:**
long - The denominator.
##### getDoubleValue()
```
public final double getDoubleValue()
```

Gets value of rational type presented in double format.

**Returns:**
double - Double value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpReal
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpreal.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public final class XmpReal extends XmpValueBase
```

Represents XMP Real.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpReal(double value) | Initializes a new instance of the  XmpReal  class. |
| XmpReal(String value) | Initializes a new instance of the  XmpReal  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpReal(double value)
```
public XmpReal(double value)
```

Initializes a new instance of the  XmpReal  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Double value. |

##### XmpReal(String value)
```
public XmpReal(String value)
```

Initializes a new instance of the  XmpReal  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final double getValue()
```

Gets the value.

**Returns:**
double - Double value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpRenditionClass
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmprenditionclass.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase, com.groupdocs.metadata.core.XmpText
```
public final class XmpRenditionClass extends XmpText
```

Represents XMP RenditionClass.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRenditionClass(String[] tokens) | Initializes a new instance of the  XmpRenditionClass  class. |
#### Fields

| Field | Description |
| --- | --- |
| Default | The master resource; no additional tokens allowed. |
| Draft | A review rendition. |
| LowRes | A low-resolution, full-size stand-in. |
| Proof | A review proof. |
| Screen | Screen resolution or Web rendition. |
| Thumbnail | A simplified or reduced preview. |
##### XmpRenditionClass(String[] tokens)
```
public XmpRenditionClass(String[] tokens)
```

Initializes a new instance of the  XmpRenditionClass  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tokens | java.lang.String[] | The token. |

##### Default
```
public static final String Default
```

The master resource; no additional tokens allowed.

##### Draft
```
public static final String Draft
```

A review rendition.

##### LowRes
```
public static final String LowRes
```

A low-resolution, full-size stand-in.

##### Proof
```
public static final String Proof
```

A review proof.

##### Screen
```
public static final String Screen
```

Screen resolution or Web rendition.

##### Thumbnail
```
public static final String Thumbnail
```

A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace.

### XmpResourceEvent
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpresourceevent.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpResourceEvent extends XmpComplexType
```

Represents a high-level event that occurred in the processing of a resource.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpResourceEvent() | Initializes a new instance of the  XmpResourceEvent  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAction() | Gets the action that occurred. |
| setAction(String value) | Sets the action that occurred. |
| getChanged() | Gets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| setChanged(String value) | Sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| getInstanceID() | Gets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| setInstanceID(String value) | Sets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| getParameters() | Gets the additional description of the action. |
| setParameters(String value) | Sets the additional description of the action. |
| getSoftwareAgent() | Gets the software agent that performed the action. |
| setSoftwareAgent(String value) | Sets the software agent that performed the action. |
| getWhen() | Gets the timestamp of when the action occurred. |
| setWhen(Date value) | Sets the timestamp of when the action occurred. |
##### XmpResourceEvent()
```
public XmpResourceEvent()
```

Initializes a new instance of the  XmpResourceEvent  class.

##### getAction()
```
public final String getAction()
```

Gets the action that occurred.

**Returns:**
java.lang.String - The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version\_updated, printed, published, managed, produced, resized, saved. New values should be verbs in the past tense.
##### setAction(String value)
```
public final void setAction(String value)
```

Sets the action that occurred.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The action that occurred. Defined values are: converted, copied, created, cropped, edited, filtered, formatted, version\_updated, printed, published, managed, produced, resized, saved. New values should be verbs in the past tense. |

##### getChanged()
```
public final String getChanged()
```

Gets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.

**Returns:**
java.lang.String - A semicolon-delimited list of the parts of the resource that were changed since the previous event history.
##### setChanged(String value)
```
public final void setChanged(String value)
```

Sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A semicolon-delimited list of the parts of the resource that were changed since the previous event history. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the value of the xmpMM:InstanceID property for the modified (output) resource.

**Returns:**
java.lang.String - The value of the xmpMM:InstanceID property for the modified (output) resource.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the value of the xmpMM:InstanceID property for the modified (output) resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:InstanceID property for the modified (output) resource. |

##### getParameters()
```
public final String getParameters()
```

Gets the additional description of the action.

**Returns:**
java.lang.String - The Additional description of the action.
##### setParameters(String value)
```
public final void setParameters(String value)
```

Sets the additional description of the action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Additional description of the action. |

##### getSoftwareAgent()
```
public final String getSoftwareAgent()
```

Gets the software agent that performed the action.

**Returns:**
java.lang.String - The software agent that performed the action.
##### setSoftwareAgent(String value)
```
public final void setSoftwareAgent(String value)
```

Sets the software agent that performed the action.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The software agent that performed the action. |

##### getWhen()
```
public final Date getWhen()
```

Gets the timestamp of when the action occurred.

**Returns:**
java.util.Date - The timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file.
##### setWhen(Date value)
```
public final void setWhen(Date value)
```

Sets the timestamp of when the action occurred.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The timestamp of when the action occurred. For events that create or write to a file, this should be the approximate modification time of the file. |

### XmpResourceRef
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpresourceref.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpResourceRef extends XmpComplexType
```

Represents a multiple part reference to a resource.

 Used to indicate prior versions, originals of renditions, originals for derived documents, and so on.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpResourceRef() | Initializes a new instance of the  XmpResourceRef  class. |
#### Methods

| Method | Description |
| --- | --- |
| getAlternatePaths() | Gets the referenced resource\\u2019s fallback file paths or URLs. |
| setAlternatePaths(String[] value) | Sets the referenced resource\\u2019s fallback file paths or URLs. |
| getDocumentID() | Gets the value of the xmpMM:DocumentID property from the referenced resource. |
| setDocumentID(String value) | Sets the value of the xmpMM:DocumentID property from the referenced resource. |
| getFilePath() | Gets the referenced resource\\u2019s file path or URL. |
| setFilePath(String value) | Sets the referenced resource\\u2019s file path or URL. |
| getInstanceID() | Gets the value of the xmpMM:InstanceID property from the referenced resource. |
| setInstanceID(String value) | Sets the value of the xmpMM:InstanceID property from the referenced resource. |
| getLastModifyDate() | Gets the value of stEvt:when for the last time the file was written. |
| setLastModifyDate(Date value) | Sets the value of stEvt:when for the last time the file was written. |
| getManager() | Gets the referenced resource\\u2019s xmpMM:Manager. |
| setManager(String value) | Sets the referenced resource\\u2019s xmpMM:Manager. |
| getManagerVariant() | Gets the referenced resource\\u2019s xmpMM:Manager. |
| setManagerVariant(String value) | Sets the referenced resource\\u2019s xmpMM:Manager. |
| getManageTo() | Gets the referenced resource\\u2019s xmpMM:ManageTo. |
| setManageTo(String value) | Sets the referenced resource\\u2019s xmpMM:ManageTo. |
| getManageUI() | Gets the referenced resource\\u2019s xmpMM:ManageUI. |
| setManageUI(String value) | Sets the referenced resource\\u2019s xmpMM:ManageUI. |
| getPartMapping() | Gets the name or URI of a mapping function used to map the fromPart to the toPart. |
| setPartMapping(String value) | Sets the name or URI of a mapping function used to map the fromPart to the toPart. |
| getRenditionClass() | Gets the value of the xmpMM:RenditionClass property from the referenced resource. |
| setRenditionClass(String value) | Sets the value of the xmpMM:RenditionClass property from the referenced resource. |
| getRenditionParams() | Gets the value of the xmpMM:RenditionParams property from the referenced resource. |
| setRenditionParams(String value) | Sets the value of the xmpMM:RenditionParams property from the referenced resource. |
| getVersionID() | Gets the value of the xmpMM:RenditionParams property from the referenced resource. |
| setVersionID(String value) | Sets the value of the xmpMM:RenditionParams property from the referenced resource. |
##### XmpResourceRef()
```
public XmpResourceRef()
```

Initializes a new instance of the  XmpResourceRef  class.

##### getAlternatePaths()
```
public final String[] getAlternatePaths()
```

Gets the referenced resource\\u2019s fallback file paths or URLs.

**Returns:**
java.lang.String[] - The referenced resource\\u2019s fallback file paths or URLs. The sequence order is the recommended order in attempting to locate the resource.
##### setAlternatePaths(String[] value)
```
public final void setAlternatePaths(String[] value)
```

Sets the referenced resource\\u2019s fallback file paths or URLs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The referenced resource\\u2019s fallback file paths or URLs. The sequence order is the recommended order in attempting to locate the resource. |

##### getDocumentID()
```
public final String getDocumentID()
```

Gets the value of the xmpMM:DocumentID property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:DocumentID property from the referenced resource.
##### setDocumentID(String value)
```
public final void setDocumentID(String value)
```

Sets the value of the xmpMM:DocumentID property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:DocumentID property from the referenced resource. |

##### getFilePath()
```
public final String getFilePath()
```

Gets the referenced resource\\u2019s file path or URL.

**Returns:**
java.lang.String - The referenced resource\\u2019s file path or URL.
##### setFilePath(String value)
```
public final void setFilePath(String value)
```

Sets the referenced resource\\u2019s file path or URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s file path or URL. |

##### getInstanceID()
```
public final String getInstanceID()
```

Gets the value of the xmpMM:InstanceID property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:InstanceID property from the referenced resource.
##### setInstanceID(String value)
```
public final void setInstanceID(String value)
```

Sets the value of the xmpMM:InstanceID property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:InstanceID property from the referenced resource. |

##### getLastModifyDate()
```
public final Date getLastModifyDate()
```

Gets the value of stEvt:when for the last time the file was written.

**Returns:**
java.util.Date - The value of stEvt:when for the last time the file was written.
##### setLastModifyDate(Date value)
```
public final void setLastModifyDate(Date value)
```

Sets the value of stEvt:when for the last time the file was written.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The value of stEvt:when for the last time the file was written. |

##### getManager()
```
public final String getManager()
```

Gets the referenced resource\\u2019s xmpMM:Manager.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:Manager.
##### setManager(String value)
```
public final void setManager(String value)
```

Sets the referenced resource\\u2019s xmpMM:Manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:Manager. |

##### getManagerVariant()
```
public final String getManagerVariant()
```

Gets the referenced resource\\u2019s xmpMM:Manager.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:Manager.
##### setManagerVariant(String value)
```
public final void setManagerVariant(String value)
```

Sets the referenced resource\\u2019s xmpMM:Manager.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:Manager. |

##### getManageTo()
```
public final String getManageTo()
```

Gets the referenced resource\\u2019s xmpMM:ManageTo.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:ManageTo.
##### setManageTo(String value)
```
public final void setManageTo(String value)
```

Sets the referenced resource\\u2019s xmpMM:ManageTo.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:ManageTo. |

##### getManageUI()
```
public final String getManageUI()
```

Gets the referenced resource\\u2019s xmpMM:ManageUI.

**Returns:**
java.lang.String - The referenced resource\\u2019s xmpMM:ManageUI.
##### setManageUI(String value)
```
public final void setManageUI(String value)
```

Sets the referenced resource\\u2019s xmpMM:ManageUI.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The referenced resource\\u2019s xmpMM:ManageUI. |

##### getPartMapping()
```
public final String getPartMapping()
```

Gets the name or URI of a mapping function used to map the fromPart to the toPart.

**Returns:**
java.lang.String - The name or URI of a mapping function used to map the fromPart to the toPart. The default for time mappings is "linear".
##### setPartMapping(String value)
```
public final void setPartMapping(String value)
```

Sets the name or URI of a mapping function used to map the fromPart to the toPart.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name or URI of a mapping function used to map the fromPart to the toPart. The default for time mappings is "linear". |

##### getRenditionClass()
```
public final String getRenditionClass()
```

Gets the value of the xmpMM:RenditionClass property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionClass property from the referenced resource.
##### setRenditionClass(String value)
```
public final void setRenditionClass(String value)
```

Sets the value of the xmpMM:RenditionClass property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionClass property from the referenced resource. |

##### getRenditionParams()
```
public final String getRenditionParams()
```

Gets the value of the xmpMM:RenditionParams property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionParams property from the referenced resource.
##### setRenditionParams(String value)
```
public final void setRenditionParams(String value)
```

Sets the value of the xmpMM:RenditionParams property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionParams property from the referenced resource. |

##### getVersionID()
```
public final String getVersionID()
```

Gets the value of the xmpMM:RenditionParams property from the referenced resource.

**Returns:**
java.lang.String - The value of the xmpMM:RenditionParams property from the referenced resource.
##### setVersionID(String value)
```
public final void setVersionID(String value)
```

Sets the value of the xmpMM:RenditionParams property from the referenced resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the xmpMM:RenditionParams property from the referenced resource. |

### XmpRightsManagementPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmprightsmanagementpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpPackage
```
public final class XmpRightsManagementPackage extends XmpPackage
```

Represents XMP Rights Management namespace.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpRightsManagementPackage() | Initializes a new instance of the  XmpRightsManagementPackage  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Gets the Web URL for a rights management certificate. |
| setCertificate(String value) | Sets the Web URL for a rights management certificate. |
| getMarked() | Gets a value indicating whether this is a rights-managed resource. |
| setMarked(Boolean value) | Sets a value indicating whether this is a rights-managed resource. |
| getOwners() | Gets the legal owners. |
| setOwners(String[] value) | Sets the legal owners. |
| getUsageTerms() | Gets the instructions on how the resource can be legally used, given in a variety of languages. |
| setUsageTerms(XmpLangAlt value) | Sets the instructions on how the resource can be legally used, given in a variety of languages. |
| getWebStatement() | Gets the Web URL for a statement of the ownership and usage rights for this resource. |
| setWebStatement(String value) | Sets the Web URL for a statement of the ownership and usage rights for this resource. |
| set(String name, String value) | Sets string property. |
##### XmpRightsManagementPackage()
```
public XmpRightsManagementPackage()
```

Initializes a new instance of the  XmpRightsManagementPackage  class.

##### getCertificate()
```
public final String getCertificate()
```

Gets the Web URL for a rights management certificate.

**Returns:**
java.lang.String - The Web URL for a rights management certificate.
##### setCertificate(String value)
```
public final void setCertificate(String value)
```

Sets the Web URL for a rights management certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Web URL for a rights management certificate. |

##### getMarked()
```
public final Boolean getMarked()
```

Gets a value indicating whether this is a rights-managed resource.

**Returns:**
java.lang.Boolean -  true  if the resource is rights-managed; otherwise  false . When false, indicates that this is a public-domain resource. Omit if the state is unknown.
##### setMarked(Boolean value)
```
public final void setMarked(Boolean value)
```

Sets a value indicating whether this is a rights-managed resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean |  true  if the resource is rights-managed; otherwise  false . When false, indicates that this is a public-domain resource. Omit if the state is unknown. |

##### getOwners()
```
public final String[] getOwners()
```

Gets the legal owners.

**Returns:**
java.lang.String[] - The legal owners.
##### setOwners(String[] value)
```
public final void setOwners(String[] value)
```

Sets the legal owners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The legal owners. |

##### getUsageTerms()
```
public final XmpLangAlt getUsageTerms()
```

Gets the instructions on how the resource can be legally used, given in a variety of languages.

**Returns:**
XmpLangAlt - The instructions on how the resource can be legally used, given in a variety of languages.
##### setUsageTerms(XmpLangAlt value)
```
public final void setUsageTerms(XmpLangAlt value)
```

Sets the instructions on how the resource can be legally used, given in a variety of languages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpLangAlt | The instructions on how the resource can be legally used, given in a variety of languages. |

##### getWebStatement()
```
public final String getWebStatement()
```

Gets the Web URL for a statement of the ownership and usage rights for this resource.

**Returns:**
java.lang.String - The Web URL for a statement of the ownership and usage rights for this resource.
##### setWebStatement(String value)
```
public final void setWebStatement(String value)
```

Sets the Web URL for a statement of the ownership and usage rights for this resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The Web URL for a statement of the ownership and usage rights for this resource. |

##### set(String name, String value)
```
public void set(String name, String value)
```

Sets string property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | XMP metadata property name. |
| value | java.lang.String | XMP metadata property value. |

### XmpSchemes
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpschemes.md

**Inheritance:**
java.lang.Object
```
public final class XmpSchemes
```

Provides access to known XMP schemes.
#### Methods

| Method | Description |
| --- | --- |
| getCameraRaw() | Gets the Camera Raw scheme. |
| setCameraRaw(XmpCameraRawPackage value) | Sets the Camera Raw scheme. |
| getDublinCore() | Gets the Dublin Core scheme. |
| setDublinCore(XmpDublinCorePackage value) | Sets the Dublin Core scheme. |
| getPagedText() | Gets the PagedText scheme. |
| setPagedText(XmpPagedTextPackage value) | Sets the PagedText scheme. |
| getPdf() | Gets the PDF scheme. |
| setPdf(XmpPdfPackage value) | Sets the PDF scheme. |
| getPhotoshop() | Gets the Photoshop scheme. |
| setPhotoshop(XmpPhotoshopPackage value) | Sets the Photoshop scheme. |
| getXmpBasic() | Gets the XmpBasic scheme. |
| setXmpBasic(XmpBasicPackage value) | Sets the XmpBasic scheme. |
| getXmpDynamicMedia() | Gets the XmpDynamicMedia scheme. |
| setXmpDynamicMedia(XmpDynamicMediaPackage value) | Sets the XmpDynamicMedia scheme. |
| getXmpMediaManagement() | Gets the XmpMediaManagement schema. |
| setXmpMediaManagement(XmpMediaManagementPackage value) | Sets the XmpMediaManagement schema. |
| getXmpRightsManagement() | Gets the XmpRightsManagement schema. |
| setXmpRightsManagement(XmpRightsManagementPackage value) | Sets the XmpRightsManagement schema. |
| getBasicJobTicket() | Gets the BasicJobTicket scheme. |
| setBasicJobTicket(XmpBasicJobTicketPackage value) | Sets the BasicJobTicket scheme. |
##### getCameraRaw()
```
public final XmpCameraRawPackage getCameraRaw()
```

Gets the Camera Raw scheme.

**Returns:**
XmpCameraRawPackage - The camera raw namespace.
##### setCameraRaw(XmpCameraRawPackage value)
```
public final void setCameraRaw(XmpCameraRawPackage value)
```

Sets the Camera Raw scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpCameraRawPackage | The camera raw namespace. |

##### getDublinCore()
```
public final XmpDublinCorePackage getDublinCore()
```

Gets the Dublin Core scheme.

**Returns:**
XmpDublinCorePackage - The dublin core namespace.
##### setDublinCore(XmpDublinCorePackage value)
```
public final void setDublinCore(XmpDublinCorePackage value)
```

Sets the Dublin Core scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDublinCorePackage | The dublin core namespace. |

##### getPagedText()
```
public final XmpPagedTextPackage getPagedText()
```

Gets the PagedText scheme.

**Returns:**
XmpPagedTextPackage - The paged text namespace.
##### setPagedText(XmpPagedTextPackage value)
```
public final void setPagedText(XmpPagedTextPackage value)
```

Sets the PagedText scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPagedTextPackage | The paged text namespace. |

##### getPdf()
```
public final XmpPdfPackage getPdf()
```

Gets the PDF scheme.

**Returns:**
XmpPdfPackage - The PDF namespace.
##### setPdf(XmpPdfPackage value)
```
public final void setPdf(XmpPdfPackage value)
```

Sets the PDF scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPdfPackage | The PDF namespace. |

##### getPhotoshop()
```
public final XmpPhotoshopPackage getPhotoshop()
```

Gets the Photoshop scheme.

**Returns:**
XmpPhotoshopPackage - The photoshop namespace.
##### setPhotoshop(XmpPhotoshopPackage value)
```
public final void setPhotoshop(XmpPhotoshopPackage value)
```

Sets the Photoshop scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpPhotoshopPackage | The photoshop namespace. |

##### getXmpBasic()
```
public final XmpBasicPackage getXmpBasic()
```

Gets the XmpBasic scheme.

**Returns:**
XmpBasicPackage - The XMP basic namespace.
##### setXmpBasic(XmpBasicPackage value)
```
public final void setXmpBasic(XmpBasicPackage value)
```

Sets the XmpBasic scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpBasicPackage | The XMP basic namespace. |

##### getXmpDynamicMedia()
```
public final XmpDynamicMediaPackage getXmpDynamicMedia()
```

Gets the XmpDynamicMedia scheme.

**Returns:**
XmpDynamicMediaPackage - The XMP dynamic media namespace.
##### setXmpDynamicMedia(XmpDynamicMediaPackage value)
```
public final void setXmpDynamicMedia(XmpDynamicMediaPackage value)
```

Sets the XmpDynamicMedia scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpDynamicMediaPackage | The XMP dynamic media namespace. |

##### getXmpMediaManagement()
```
public final XmpMediaManagementPackage getXmpMediaManagement()
```

Gets the XmpMediaManagement schema.

**Returns:**
XmpMediaManagementPackage - The XMP media management namespace.
##### setXmpMediaManagement(XmpMediaManagementPackage value)
```
public final void setXmpMediaManagement(XmpMediaManagementPackage value)
```

Sets the XmpMediaManagement schema.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpMediaManagementPackage | The XMP media management namespace. |

##### getXmpRightsManagement()
```
public final XmpRightsManagementPackage getXmpRightsManagement()
```

Gets the XmpRightsManagement schema.

**Returns:**
XmpRightsManagementPackage - The XMP rights management namespace.
##### setXmpRightsManagement(XmpRightsManagementPackage value)
```
public final void setXmpRightsManagement(XmpRightsManagementPackage value)
```

Sets the XmpRightsManagement schema.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRightsManagementPackage | The XMP rights management namespace. |

##### getBasicJobTicket()
```
public final XmpBasicJobTicketPackage getBasicJobTicket()
```

Gets the BasicJobTicket scheme.

**Returns:**
XmpBasicJobTicketPackage - The XMP job ticket namespace.
##### setBasicJobTicket(XmpBasicJobTicketPackage value)
```
public final void setBasicJobTicket(XmpBasicJobTicketPackage value)
```

Sets the BasicJobTicket scheme.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpBasicJobTicketPackage | The XMP job ticket namespace. |

### XmpText
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmptext.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue, com.groupdocs.metadata.core.XmpValueBase
```
public class XmpText extends XmpValueBase
```

Represents XMP Text basic type.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpText(String value) | Initializes a new instance of the  XmpText  class. |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### XmpText(String value)
```
public XmpText(String value)
```

Initializes a new instance of the  XmpText  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value. |

##### getValue()
```
public final String getValue()
```

Gets the value.

**Returns:**
java.lang.String - Text value.
##### getXmpRepresentation()
```
public String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpThumbnail
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpthumbnail.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpThumbnail extends XmpComplexType
```

Represents a thumbnail image for a file.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpThumbnail() | Initializes a new instance of the  XmpThumbnail  class. |
| XmpThumbnail(int width, int height) | Initializes a new instance of the  XmpThumbnail  class. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the image width in pixels. |
| setWidth(Integer value) | Sets the image width in pixels. |
| getHeight() | Gets the image height in pixels. |
| setHeight(Integer value) | Sets the image height in pixels. |
| getImageBase64() | Gets the full thumbnail image data, converted to base 64 notation. |
| setImageBase64(String value) | Sets the full thumbnail image data, converted to base 64 notation. |
| getImageData() | Gets the image data. |
| getFormat() | Gets the image format. |
| setFormat(String value) | Sets the image format. |
##### XmpThumbnail()
```
public XmpThumbnail()
```

Initializes a new instance of the  XmpThumbnail  class.

##### XmpThumbnail(int width, int height)
```
public XmpThumbnail(int width, int height)
```

Initializes a new instance of the  XmpThumbnail  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width. |
| height | int | The height. |

##### getWidth()
```
public final Integer getWidth()
```

Gets the image width in pixels.

**Returns:**
java.lang.Integer - The thumbnail width.
##### setWidth(Integer value)
```
public final void setWidth(Integer value)
```

Sets the image width in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The thumbnail width. |

##### getHeight()
```
public final Integer getHeight()
```

Gets the image height in pixels.

**Returns:**
java.lang.Integer - The thumbnail height.
##### setHeight(Integer value)
```
public final void setHeight(Integer value)
```

Sets the image height in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The thumbnail height. |

##### getImageBase64()
```
public final String getImageBase64()
```

Gets the full thumbnail image data, converted to base 64 notation.

**Returns:**
java.lang.String - The full thumbnail image data, converted to base 64 notation.
##### setImageBase64(String value)
```
public final void setImageBase64(String value)
```

Sets the full thumbnail image data, converted to base 64 notation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The full thumbnail image data, converted to base 64 notation. |

##### getImageData()
```
public final byte[] getImageData()
```

Gets the image data.

**Returns:**
byte[] - The image data.
##### getFormat()
```
public final String getFormat()
```

Gets the image format. Defined value: JPEG.

**Returns:**
java.lang.String - The thumbnail format.
##### setFormat(String value)
```
public final void setFormat(String value)
```

Sets the image format. Defined value: JPEG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The thumbnail format. |

### XmpTime
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmptime.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpTime extends XmpComplexType
```

Representation of a time value in seconds.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTime() | Initializes a new instance of the  XmpTime  class. |
| XmpTime(XmpRational scale, int value) | Initializes a new instance of the  XmpTime  class. |
#### Methods

| Method | Description |
| --- | --- |
| getScale() | Gets the scale for the time value. |
| setScale(XmpRational value) | Sets the scale for the time value. |
| getValue() | Gets the time value in the specified scale. |
| setValue(Integer value) | Sets the time value in the specified scale. |
##### XmpTime()
```
public XmpTime()
```

Initializes a new instance of the  XmpTime  class.

##### XmpTime(XmpRational scale, int value)
```
public XmpTime(XmpRational scale, int value)
```

Initializes a new instance of the  XmpTime  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| scale | XmpRational | The scale. |
| value | int | The value. |

##### getScale()
```
public final XmpRational getScale()
```

Gets the scale for the time value.

**Returns:**
XmpRational - The scale for the time value. For NTSC, use 1001/30000, or the less accurate 100/2997.

 For PAL, use 1/25.
##### setScale(XmpRational value)
```
public final void setScale(XmpRational value)
```

Sets the scale for the time value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpRational | The scale for the time value. For NTSC, use 1001/30000, or the less accurate 100/2997.

 For PAL, use 1/25. |

##### getValue()
```
public final Integer getValue()
```

Gets the time value in the specified scale.

**Returns:**
java.lang.Integer - The time value in the specified scale.
##### setValue(Integer value)
```
public final void setValue(Integer value)
```

Sets the time value in the specified scale.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer | The time value in the specified scale. |

### XmpTimecode
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmptimecode.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpTimecode extends XmpComplexType
```

Represents a timecode value in a video.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTimecode() | Initializes a new instance of the  XmpTimecode  class. |
| XmpTimecode(XmpTimeFormat format, String timeValue) | Initializes a new instance of the  XmpTimecode  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTimeFormat() | Gets the format used in the time value. |
| setTimeFormat(String value) | Sets the format used in the time value. |
| getTimeValue() | Gets the time value in the specified format. |
| setTimeValue(String value) | Sets the time value in the specified format. |
| setTimeFormat(XmpTimeFormat timeFormat) | Sets the time format. |
##### XmpTimecode()
```
public XmpTimecode()
```

Initializes a new instance of the  XmpTimecode  class.

##### XmpTimecode(XmpTimeFormat format, String timeValue)
```
public XmpTimecode(XmpTimeFormat format, String timeValue)
```

Initializes a new instance of the  XmpTimecode  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | XmpTimeFormat | Time format. |
| timeValue | java.lang.String | Time value. |

##### getTimeFormat()
```
public final String getTimeFormat()
```

Gets the format used in the time value.

**Returns:**
java.lang.String - The format used in the timeValue. One of: 24Timecode, 25Timecode, 2997DropTimecode (semicolon delimiter), 2997NonDropTimecode, 30Timecode, 50Timecode, 5994DropTimecode (semicolon delimiter), 5994NonDropTimecode, 60Timecode, 23976Timecode.
##### setTimeFormat(String value)
```
public final void setTimeFormat(String value)
```

Sets the format used in the time value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The format used in the timeValue. One of: 24Timecode, 25Timecode, 2997DropTimecode (semicolon delimiter), 2997NonDropTimecode, 30Timecode, 50Timecode, 5994DropTimecode (semicolon delimiter), 5994NonDropTimecode, 60Timecode, 23976Timecode. |

##### getTimeValue()
```
public final String getTimeValue()
```

Gets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

**Returns:**
java.lang.String - The time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff
##### setTimeValue(String value)
```
public final void setTimeValue(String value)
```

Sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff |

##### setTimeFormat(XmpTimeFormat timeFormat)
```
public final void setTimeFormat(XmpTimeFormat timeFormat)
```

Sets the time format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| timeFormat | XmpTimeFormat | The time format. |

### XmpTimeFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmptimeformat.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpTimeFormat extends XmpClosedChoice<String>
```

Represents time format in  XmpTimecode .
#### Methods

| Method | Description |
| --- | --- |
| getTimecode24() | Gets 24Timecode. |
| getTimecode25() | Gets 25Timecode. |
| getDropTimecode2997() | Gets 2997DropTimecode. |
| getNonDropTimecode2997() | Gets 2997NonDropTimecode. |
| getTimecode30() | Gets 30Timecode. |
| getTimecode50() | Gets 50Timecode. |
| getDropTimecode5994() | Gets 5994DropTimecode. |
| getNonDropTimecode5994() | Gets 5994NonDropTimecode. |
| getTimecode60() | Gets 60Timecode. |
| getTimecode23976() | Gets 23976Timecode. |
##### getTimecode24()
```
public static XmpTimeFormat getTimecode24()
```

Gets 24Timecode.

**Returns:**
XmpTimeFormat - The 24Timecode.
##### getTimecode25()
```
public static XmpTimeFormat getTimecode25()
```

Gets 25Timecode.

**Returns:**
XmpTimeFormat - The 25Timecode.
##### getDropTimecode2997()
```
public static XmpTimeFormat getDropTimecode2997()
```

Gets 2997DropTimecode.

**Returns:**
XmpTimeFormat - The drop timecode2997.
##### getNonDropTimecode2997()
```
public static XmpTimeFormat getNonDropTimecode2997()
```

Gets 2997NonDropTimecode.

**Returns:**
XmpTimeFormat
##### getTimecode30()
```
public static XmpTimeFormat getTimecode30()
```

Gets 30Timecode.

**Returns:**
XmpTimeFormat - The 30Timecode.
##### getTimecode50()
```
public static XmpTimeFormat getTimecode50()
```

Gets 50Timecode.

**Returns:**
XmpTimeFormat - The 50Timecode.
##### getDropTimecode5994()
```
public static XmpTimeFormat getDropTimecode5994()
```

Gets 5994DropTimecode.

**Returns:**
XmpTimeFormat - The 5994DropTimecode.
##### getNonDropTimecode5994()
```
public static XmpTimeFormat getNonDropTimecode5994()
```

Gets 5994NonDropTimecode.

**Returns:**
XmpTimeFormat - The 5994NonDropTimecode.
##### getTimecode60()
```
public static XmpTimeFormat getTimecode60()
```

Gets 60Timecode.

**Returns:**
XmpTimeFormat - The 60Timecode.
##### getTimecode23976()
```
public static XmpTimeFormat getTimecode23976()
```

Gets 23976Timecode.

**Returns:**
XmpTimeFormat - The 23976Timecode.

### XmpTrailerPI
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmptrailerpi.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public final class XmpTrailerPI implements IXmpType
```

Represents XMP trailer processing instruction.

The end="w" or end="r" portion shall be used by packet scanning processors to determine whether the XMP may be modified in-place.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpTrailerPI(boolean isWritable) | Initializes a new instance of the  XmpTrailerPI  class. |
| XmpTrailerPI() | Initializes a new instance of the  XmpTrailerPI  class. |
#### Methods

| Method | Description |
| --- | --- |
| isWritable() | Indicates whether form may be modified in-place. |
| getXmpRepresentation() | Converts XMP value to the xml representation. |
##### XmpTrailerPI(boolean isWritable)
```
public XmpTrailerPI(boolean isWritable)
```

Initializes a new instance of the  XmpTrailerPI  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isWritable | boolean | Indicates whether trailer is writable. |

##### XmpTrailerPI()
```
public XmpTrailerPI()
```

Initializes a new instance of the  XmpTrailerPI  class.

##### isWritable()
```
public final boolean isWritable()
```

Indicates whether form may be modified in-place.

**Returns:**
boolean -  true  if XMP packet is writable; otherwise,  false .
##### getXmpRepresentation()
```
public final String getXmpRepresentation()
```

Converts XMP value to the xml representation.

**Returns:**
java.lang.String - Returns  string  representation of XMP value.

### XmpValueBase
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpvaluebase.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.PropertyValue

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IXmpType
```
public abstract class XmpValueBase extends PropertyValue implements IXmpType
```

Represents base XMP value.
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the property value. |
| getXmpRepresentation() | Returns string contained value in XMP format. |
##### toString()
```
public String toString()
```

Returns a string that represents the property value.

**Returns:**
java.lang.String - A string that represents the property value.
##### getXmpRepresentation()
```
public abstract String getXmpRepresentation()
```

Returns string contained value in XMP format.

**Returns:**
java.lang.String -  string  contained XMP representation.

### XmpVersion
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpversion.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage, com.groupdocs.metadata.core.XmpMetadataContainer, com.groupdocs.metadata.core.XmpComplexType
```
public final class XmpVersion extends XmpComplexType
```

Represents a version of a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmpVersion() | Initializes a new instance of the  XmpVersion  class. |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets the comments concerning what was changed. |
| setComments(String value) | Sets the comments concerning what was changed. |
| getEvent() | Gets the high-level, formal description of what operation the user performed. |
| setEvent(XmpResourceEvent value) | Sets the high-level, formal description of what operation the user performed. |
| getModifier() | Gets the person who modified this version. |
| setModifier(String value) | Sets the person who modified this version. |
| getModifyDate() | Gets the date on which this version was checked in. |
| setModifyDate(Date value) | Sets the date on which this version was checked in. |
| getVersionNumber() | Gets the new version number. |
| setVersionNumber(String value) | Sets the new version number. |
##### XmpVersion()
```
public XmpVersion()
```

Initializes a new instance of the  XmpVersion  class.

##### getComments()
```
public final String getComments()
```

Gets the comments concerning what was changed.

**Returns:**
java.lang.String - The comments concerning what was changed.
##### setComments(String value)
```
public final void setComments(String value)
```

Sets the comments concerning what was changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The comments concerning what was changed. |

##### getEvent()
```
public final XmpResourceEvent getEvent()
```

Gets the high-level, formal description of what operation the user performed.

**Returns:**
XmpResourceEvent - The high-level, formal description of what operation the user performed.
##### setEvent(XmpResourceEvent value)
```
public final void setEvent(XmpResourceEvent value)
```

Sets the high-level, formal description of what operation the user performed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | XmpResourceEvent | The high-level, formal description of what operation the user performed. |

##### getModifier()
```
public final String getModifier()
```

Gets the person who modified this version.

**Returns:**
java.lang.String - The person who modified this version.
##### setModifier(String value)
```
public final void setModifier(String value)
```

Sets the person who modified this version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The person who modified this version. |

##### getModifyDate()
```
public final Date getModifyDate()
```

Gets the date on which this version was checked in.

**Returns:**
java.util.Date - The date on which this version was checked in.
##### setModifyDate(Date value)
```
public final void setModifyDate(Date value)
```

Sets the date on which this version was checked in.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The date on which this version was checked in. |

##### getVersionNumber()
```
public final String getVersionNumber()
```

Gets the new version number.

**Returns:**
java.lang.String - The new version number.
##### setVersionNumber(String value)
```
public final void setVersionNumber(String value)
```

Sets the new version number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The new version number. |

### XmpWhiteBalance
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/xmpwhitebalance.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.XmpClosedChoice
```
public final class XmpWhiteBalance extends XmpClosedChoice<String>
```

Represents the White Balance setting in  XmpCameraRawPackage .
#### Methods

| Method | Description |
| --- | --- |
| getAsShot() | White balance: As Shot. |
| getAuto() | White balance: Auto. |
| getCloudy() | White balance: Cloudy. |
| getCustom() | White balance: Custom. |
| getDaylight() | White balance: Daylight. |
| getFlash() | White balance: Flash. |
| getFluorescent() | White balance: Fluorescent. |
| getShade() | White balance: Shade. |
| getTungsten() | White balance: Tungsten. |
##### getAsShot()
```
public static XmpWhiteBalance getAsShot()
```

White balance: As Shot.

**Returns:**
XmpWhiteBalance - As shot.
##### getAuto()
```
public static XmpWhiteBalance getAuto()
```

White balance: Auto.

**Returns:**
XmpWhiteBalance - The automatic.
##### getCloudy()
```
public static XmpWhiteBalance getCloudy()
```

White balance: Cloudy.

**Returns:**
XmpWhiteBalance - Cloudy.
##### getCustom()
```
public static XmpWhiteBalance getCustom()
```

White balance: Custom.

**Returns:**
XmpWhiteBalance - Custom.
##### getDaylight()
```
public static XmpWhiteBalance getDaylight()
```

White balance: Daylight.

**Returns:**
XmpWhiteBalance - Daylight.
##### getFlash()
```
public static XmpWhiteBalance getFlash()
```

White balance: Flash.

**Returns:**
XmpWhiteBalance - Flash.
##### getFluorescent()
```
public static XmpWhiteBalance getFluorescent()
```

White balance: Fluorescent.

**Returns:**
XmpWhiteBalance - Fluorescent.
##### getShade()
```
public static XmpWhiteBalance getShade()
```

White balance: Shade.

**Returns:**
XmpWhiteBalance - Shade.
##### getTungsten()
```
public static XmpWhiteBalance getTungsten()
```

White balance: Tungsten.

**Returns:**
XmpWhiteBalance - Tungsten.

### ZipCompressionMethod
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/zipcompressionmethod.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ZipCompressionMethod extends Enum<ZipCompressionMethod> implements IEnumValue
```

Defines ZIP compression methods.
#### Fields

| Field | Description |
| --- | --- |
| NoCompression | The file is stored (no compression). |
| Shrunk | The file is Shrunk. |
| Imploded | The file is Imploded. |
| Reserved | A reserved compression method. |
| Deflated | The file is Deflated. |
| BZip2 | The file is compressed with the BZip2 algorithm. |
| Lzma | The Lempel-Ziv-Markov chain-Algorithm. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### NoCompression
```
public static final ZipCompressionMethod NoCompression
```

The file is stored (no compression).

##### Shrunk
```
public static final ZipCompressionMethod Shrunk
```

The file is Shrunk.

##### Imploded
```
public static final ZipCompressionMethod Imploded
```

The file is Imploded.

##### Reserved
```
public static final ZipCompressionMethod Reserved
```

A reserved compression method.

##### Deflated
```
public static final ZipCompressionMethod Deflated
```

The file is Deflated.

##### BZip2
```
public static final ZipCompressionMethod BZip2
```

The file is compressed with the BZip2 algorithm.

##### Lzma
```
public static final ZipCompressionMethod Lzma
```

The Lempel-Ziv-Markov chain-Algorithm.

##### values()
```
public static ZipCompressionMethod[] values()
```

**Returns:**
com.groupdocs.metadata.core.ZipCompressionMethod[]
##### valueOf(String name)
```
public static ZipCompressionMethod valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ZipCompressionMethod
##### getByRawValue(int rawValue)
```
public static ZipCompressionMethod getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ZipCompressionMethod
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ZipFile
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/zipfile.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ZipFile extends CustomPackage
```

Represents metadata associated with an archived file or directory.

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getCompressionMethod() | Gets the compression method. |
| getCompressedSize() | Gets the compressed size in bytes. |
| getUncompressedSize() | Gets the uncompressed size in bytes. |
| getFlags() | Gets the ZIP entry flags. |
| getName() | Gets the entry name. |
| getRawName() | Gets an array of bytes representing the name of the entry. |
| getModificationDateTime() | Gets the last modification date and time. |
##### getCompressionMethod()
```
public final ZipCompressionMethod getCompressionMethod()
```

Gets the compression method.

**Returns:**
ZipCompressionMethod - The compression method.
##### getCompressedSize()
```
public final long getCompressedSize()
```

Gets the compressed size in bytes.

**Returns:**
long - The compressed size in bytes.
##### getUncompressedSize()
```
public final long getUncompressedSize()
```

Gets the uncompressed size in bytes.

**Returns:**
long - The uncompressed size in bytes.
##### getFlags()
```
public final int getFlags()
```

Gets the ZIP entry flags.

**Returns:**
int - The ZIP entry flags.

Bit 00: encrypted file.

 Bit 01: compression option.

 Bit 02: compression option.

 Bit 03: data descriptor.

 Bit 04: enhanced deflation.

 Bit 05: compressed patched data.

 Bit 06: strong encryption.

 Bit 07-10: unused.

 Bit 11: language encoding.

 Bit 12: reserved.

 Bit 13: mask header values.

 Bit 14-15: reserved.

##### getName()
```
public final String getName()
```

Gets the entry name.

**Returns:**
java.lang.String - The entry name. It can be a file or directory name.
##### getRawName()
```
public final byte[] getRawName()
```

Gets an array of bytes representing the name of the entry.

**Returns:**
byte[] - An array of bytes representing the name of the entry.
##### getModificationDateTime()
```
public final Date getModificationDateTime()
```

Gets the last modification date and time.

**Returns:**
java.util.Date - The last modification date and time.

### ZipPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/zippackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage
```
public final class ZipPackage extends CustomPackage
```

Represents ZIP archive metadata.

The following code snippet shows how to get metadata from a ZIP archive.

> ```
> ```
>
>  Charset charset = Charset.forName("cp866");
>  try (Metadata metadata = new Metadata(Constants.InputZip)) {
>      ZipRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getZipPackage().getComment());
>      System.out.println(root.getZipPackage().getTotalEntries());
>      for (ZipFile file : root.getZipPackage().getFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getCompressedSize());
>          System.out.println(file.getCompressionMethod());
>          System.out.println(file.getFlags());
>          System.out.println(file.getModificationDateTime());
>          System.out.println(file.getUncompressedSize());
>          // Use a specific encoding for the file names
>          System.out.println(new String(file.getRawName(), charset));
>      }
>  }
>
> ```
> ```

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getComment() | Gets the ZIP archive comment created by a user. |
| setComment(String value) | Sets the ZIP archive comment created by a user. |
| getFiles() | Gets an array of  ZipFile  entries inside the ZIP archive. |
| getTotalEntries() | Gets the total number of entries inside the ZIP archive. |
##### getComment()
```
public final String getComment()
```

Gets the ZIP archive comment created by a user.

**Returns:**
java.lang.String - The user's comment.
##### setComment(String value)
```
public final void setComment(String value)
```

Sets the ZIP archive comment created by a user.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The user's comment. |

##### getFiles()
```
public final ZipFile[] getFiles()
```

Gets an array of  ZipFile  entries inside the ZIP archive.

**Returns:**
com.groupdocs.metadata.core.ZipFile[] - An array of  ZipFile  entries inside the ZIP archive.
##### getTotalEntries()
```
public final long getTotalEntries()
```

Gets the total number of entries inside the ZIP archive.

**Returns:**
long - The total number of entries inside the ZIP archive.

### ZipRootPackage
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.core/ziprootpackage.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.RootMetadataPackage
```
public class ZipRootPackage extends RootMetadataPackage
```

Represents the root package allowing working with metadata in a ZIP archive.

The following code snippet shows how to get metadata from a ZIP archive.

> ```
> ```
>
>  Charset charset = Charset.forName("cp866");
>  try (Metadata metadata = new Metadata(Constants.InputZip)) {
>      ZipRootPackage root = metadata.getRootPackageGeneric();
>      System.out.println(root.getZipPackage().getComment());
>      System.out.println(root.getZipPackage().getTotalEntries());
>      for (ZipFile file : root.getZipPackage().getFiles()) {
>          System.out.println(file.getName());
>          System.out.println(file.getCompressedSize());
>          System.out.println(file.getCompressionMethod());
>          System.out.println(file.getFlags());
>          System.out.println(file.getModificationDateTime());
>          System.out.println(file.getUncompressedSize());
>          // Use a specific encoding for the file names
>          System.out.println(new String(file.getRawName(), charset));
>      }
>  }
>
> ```
> ```

[Working with ZIP archives]: https://docs.groupdocs.com/display/metadatajava/Working+with+ZIP+archives
#### Methods

| Method | Description |
| --- | --- |
| getZipPackage() | Gets the ZIP metadata package. |
##### getZipPackage()
```
public final ZipPackage getZipPackage()
```

Gets the ZIP metadata package.

**Returns:**
ZipPackage - The ZIP metadata package.

### com.groupdocs.metadata.export
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export.md

The **com.groupdocs.metadata.export** namespace contains classes that allow users to export metadata properties to different representations.

#### Classes

| Class | Description |
| --- | --- |
| CsvExportOptions | Creates an export options of xml file. |
| ExcelExportOptions | Creates an export options of excel file. |
| ExportManager | Provides a row of methods allowing the user to export metadata properties to various formats. |
| ExportOptions | Abstract class export options. |
| JsonExportOptions | Creates an export options of xml file. |
| XmlExportOptions | Creates an export options of xml file. |

#### Enumerations

| Enum | Description |
| --- | --- |
| ExportFormat | Defines file formats to which you can export metadata properties. |

### CsvExportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/csvexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class CsvExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| CsvExportOptions() | Initializes a new instance of the CsvExportOptions class. |
##### CsvExportOptions()
```
public CsvExportOptions()
```

Initializes a new instance of the CsvExportOptions class.

### ExcelExportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/excelexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class ExcelExportOptions extends ExportOptions
```

Creates an export options of excel file.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExcelExportOptions() | Initializes a new instance of the ExcelExportOptions class. |
| ExcelExportOptions(boolean groupCells) | Initializes a new instance of the ExcelExportOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getGroupCells() | This flag determines whether it is necessary to group rows when exporting to Excel format |
| setGroupCells(boolean value) | This flag determines whether it is necessary to group rows when exporting to Excel format |
##### ExcelExportOptions()
```
public ExcelExportOptions()
```

Initializes a new instance of the ExcelExportOptions class.

##### ExcelExportOptions(boolean groupCells)
```
public ExcelExportOptions(boolean groupCells)
```

Initializes a new instance of the ExcelExportOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| groupCells | boolean | Group flag. |

##### getGroupCells()
```
public final boolean getGroupCells()
```

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

**Returns:**
boolean
##### setGroupCells(boolean value)
```
public final void setGroupCells(boolean value)
```

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### ExportFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/exportformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.groupdocs.metadata.core.IEnumValue
```
public enum ExportFormat extends Enum<ExportFormat> implements IEnumValue
```

Defines file formats to which you can export metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Xls | Represents the .XLS Excel format. |
| Xlsx | Represents the .XLSX Excel format. |
| Xml | Represents the .XML format. |
| Csv | Represents the .CSV format. |
| Json | Represents the .JSON format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getByRawValue(int rawValue) |  |
| getFirst() |  |
| getAllValues() |  |
| getEnumValueByRawValue(int rawValue) |  |
| getEnumValueByName(String name) |  |
| getRawValueType() |  |
| getRawValue() |  |
##### Xls
```
public static final ExportFormat Xls
```

Represents the .XLS Excel format.

##### Xlsx
```
public static final ExportFormat Xlsx
```

Represents the .XLSX Excel format.

##### Xml
```
public static final ExportFormat Xml
```

Represents the .XML format.

##### Csv
```
public static final ExportFormat Csv
```

Represents the .CSV format.

##### Json
```
public static final ExportFormat Json
```

Represents the .JSON format.

##### values()
```
public static ExportFormat[] values()
```

**Returns:**
com.groupdocs.metadata.export.ExportFormat[]
##### valueOf(String name)
```
public static ExportFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ExportFormat
##### getByRawValue(int rawValue)
```
public static ExportFormat getByRawValue(int rawValue)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
ExportFormat
##### getFirst()
```
public static IEnumValue getFirst()
```

**Returns:**
IEnumValue
##### getAllValues()
```
public Object[] getAllValues()
```

Returns the array of all values defined in the class.

**Returns:**
java.lang.Object[]
##### getEnumValueByRawValue(int rawValue)
```
public IEnumValue getEnumValueByRawValue(int rawValue)
```

Returns the enumeration value by the raw value associated with it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawValue | int |  |

**Returns:**
IEnumValue
##### getEnumValueByName(String name)
```
public IEnumValue getEnumValueByName(String name)
```

Returns the enumeration value by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IEnumValue
##### getRawValueType()
```
public RawIntegerType getRawValueType()
```

Returns the underlying type of the raw value of this enumeration value.

**Returns:**
RawIntegerType
##### getRawValue()
```
public int getRawValue()
```

Returns the raw value of this enumeration value.

**Returns:**
int

### ExportManager
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/exportmanager.md

**Inheritance:**
java.lang.Object
```
public class ExportManager
```

Provides a row of methods allowing the user to export metadata properties to various formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExportManager(Iterable<MetadataProperty> properties) | Initializes a new instance of the  ExportManager  class. |
#### Methods

| Method | Description |
| --- | --- |
| export(String filePath, ExportFormat format, ExportOptions exportOptions) | Exports the metadata properties to a file. |
| export(OutputStream document, ExportFormat format, ExportOptions exportOptions) | Exports the metadata properties to a stream. |
| export(String filePath, ExportFormat format) | Exports the metadata properties to a file. |
| export(OutputStream document, ExportFormat format) | Exports the metadata properties to a stream. |
##### ExportManager(Iterable<MetadataProperty> properties)
```
public ExportManager(Iterable<MetadataProperty> properties)
```

Initializes a new instance of the  ExportManager  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| properties | java.lang.Iterable<com.groupdocs.metadata.core.MetadataProperty> | A collection of metadata properties to be exported. |

##### export(String filePath, ExportFormat format, ExportOptions exportOptions)
```
public final void export(String filePath, ExportFormat format, ExportOptions exportOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions |  |

##### export(OutputStream document, ExportFormat format, ExportOptions exportOptions)
```
public final void export(OutputStream document, ExportFormat format, ExportOptions exportOptions)
```

Exports the metadata properties to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The full name of the output file. |
| format | ExportFormat | The format of the output file. |
| exportOptions | ExportOptions |  |

##### export(String filePath, ExportFormat format)
```
public final void export(String filePath, ExportFormat format)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file. |
| format | ExportFormat | The format of the output file. |

##### export(OutputStream document, ExportFormat format)
```
public final void export(OutputStream document, ExportFormat format)
```

Exports the metadata properties to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output file stream. |
| format | ExportFormat | The format of the output file. |

### ExportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/exportoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class ExportOptions
```

Abstract class export options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExportOptions() | Initializes a new instance of the ExportOptions class. |
##### ExportOptions()
```
public ExportOptions()
```

Initializes a new instance of the ExportOptions class.

### JsonExportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/jsonexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class JsonExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonExportOptions() | Initializes a new instance of the JsonExportOptions class. |
##### JsonExportOptions()
```
public JsonExportOptions()
```

Initializes a new instance of the JsonExportOptions class.

### XmlExportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.export/xmlexportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.export.ExportOptions
```
public class XmlExportOptions extends ExportOptions
```

Creates an export options of xml file.
#### Constructors

| Constructor | Description |
| --- | --- |
| XmlExportOptions() | Initializes a new instance of the XmlExportOptions class. |
##### XmlExportOptions()
```
public XmlExportOptions()
```

Initializes a new instance of the XmlExportOptions class.

### com.groupdocs.metadata.imports
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.imports.md

The **com.groupdocs.metadata.imports** namespace contains classes that allow users to import metadata properties to different representations.

#### Classes

| Class | Description |
| --- | --- |
| ImportFormat | Defines file formats to which you can import metadata properties. |
| ImportManager | Provides a row of methods allowing the user to export metadata properties to various formats. |
| ImportOptions | Abstract class import options. |
| JsonImportOptions | Creates an import options from json file. |

### ImportFormat
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.imports/importformat.md

**Inheritance:**
java.lang.Object
```
public final class ImportFormat
```

Defines file formats to which you can import metadata properties.
#### Fields

| Field | Description |
| --- | --- |
| Json | Represents the .JSON format. |
##### Json
```
public static final int Json
```

Represents the .JSON format.

### ImportManager
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.imports/importmanager.md

**Inheritance:**
java.lang.Object
```
public class ImportManager
```

Provides a row of methods allowing the user to export metadata properties to various formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportManager(RootMetadataPackage rootMetadataPackage) | Initializes a new instance of the ImportManager class. |
#### Methods

| Method | Description |
| --- | --- |
| import_(String filePath, int format, ImportOptions importOptions) | Exports the metadata properties to a file. |
| import_(InputStream stream, int format, ImportOptions importOptions) | Exports the metadata properties to a file. |
##### ImportManager(RootMetadataPackage rootMetadataPackage)
```
public ImportManager(RootMetadataPackage rootMetadataPackage)
```

Initializes a new instance of the ImportManager class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rootMetadataPackage | RootMetadataPackage | A collection of metadata properties where the import will be performed.. |

##### import_(String filePath, int format, ImportOptions importOptions)
```
public final void import_(String filePath, int format, ImportOptions importOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the input file. |
| format | int | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

##### import_(InputStream stream, int format, ImportOptions importOptions)
```
public final void import_(InputStream stream, int format, ImportOptions importOptions)
```

Exports the metadata properties to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The filestream of the input file. |
| format | int | The format of the input file. |
| importOptions | ImportOptions | Additional options to use when importing. |

### ImportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.imports/importoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class ImportOptions
```

Abstract class import options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImportOptions() | Initializes a new instance of the ImportOptions class. |
##### ImportOptions()
```
public ImportOptions()
```

Initializes a new instance of the ImportOptions class.

### JsonImportOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.imports/jsonimportoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.imports.ImportOptions
```
public class JsonImportOptions extends ImportOptions
```

Creates an import options from json file.
#### Constructors

| Constructor | Description |
| --- | --- |
| JsonImportOptions() | Initializes a new instance of the JsonImportOptions class. |
##### JsonImportOptions()
```
public JsonImportOptions()
```

Initializes a new instance of the JsonImportOptions class.

### com.groupdocs.metadata.licensing
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.licensing.md

The **com.groupdocs.metadata.licensing** namespace provides classes for licensing the Metadata library.

#### Classes

| Class | Description |
| --- | --- |
| License | Represents GroupDocs.Metadata license. |
| Metered | Provides methods to set metered key. |

### License
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Represents GroupDocs.Metadata license. License class should be applied once per AppDomain.

> ```
> This example demonstrates how to setup a license.
>
>  // initialize License class
>  License license = new License();
>  // set path to .lic file
>  license.SetLicense(@"C:\\GroupDocs.Metadata.lic");
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(InputStream licenseStream) | Licenses the component. |
##### License()
```
public License()
```

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

Licenses the component.

> ```
> This example demonstrates how to setup license.
>
>  // initialize License class
>  License license = new License();
>  // set path to .lic file
>  license.SetLicense(@"C:\\GroupDocs.Metadata.lic");
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The absolute path to a license file. |

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | License stream. |

### Metered
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods to set metered key.
#### 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 amount of used credits |
##### 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 amount of used credits

> ```
> 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 usedCredits = Metered.GetConsumptionCredit();
> ```

**Returns:**
java.math.BigDecimal

### com.groupdocs.metadata.options
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options.md

The **com.groupdocs.metadata.options** namespace contains all classes representing settings that allow users to control file and metadata processing.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows a developer to specify additional options (such as a password) when loading a file. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICreatePageStream | Defines a method that returns a stream to write page preview data. |
| IReleasePageStream | Defines a method which releases the stream created by the passed  ICreatePageStream  implementation. |

#### Enumerations

| Enum | Description |
| --- | --- |
| PreviewFormats | Represents supported preview formats. |

### ICreatePageStream
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options/icreatepagestream.md

### IReleasePageStream
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options/ireleasepagestream.md

### LoadOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows a developer to specify additional options (such as a password) when loading a file.

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the  LoadOptions  class. |
| LoadOptions(FileFormat fileFormat) | Initializes a new instance of the  LoadOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets the password for opening an encrypted document. |
| setPassword(String value) | Sets the password for opening an encrypted document. |
| getFileFormat() | Gets the exact type of the file that is to be loaded. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the  LoadOptions  class.

##### LoadOptions(FileFormat fileFormat)
```
public LoadOptions(FileFormat fileFormat)
```

Initializes a new instance of the  LoadOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The exact type of the file. |

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening an encrypted document.

**Returns:**
java.lang.String - Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening an encrypted document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string. |

##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the exact type of the file that is to be loaded. The default value is  FileFormat.Unknown  which means that the type should be detected automatically.

**Returns:**
FileFormat - The exact type of the file that is to be loaded.

### PreviewFormats
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options/previewformats.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PreviewFormats extends Enum<PreviewFormats>
```

Represents supported preview formats.
#### Fields

| Field | Description |
| --- | --- |
| PNG | Portable Network Graphics Format. |
| JPEG | Joint Photographic Experts Group Format. |
| BMP | Bitmap Picture Format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### PNG
```
public static final PreviewFormats PNG
```

Portable Network Graphics Format.

##### JPEG
```
public static final PreviewFormats JPEG
```

Joint Photographic Experts Group Format.

##### BMP
```
public static final PreviewFormats BMP
```

Bitmap Picture Format.

##### values()
```
public static PreviewFormats[] values()
```

**Returns:**
com.groupdocs.metadata.options.PreviewFormats[]
##### valueOf(String name)
```
public static PreviewFormats valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PreviewFormats

### PreviewOptions
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the  PreviewOptions  class causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of  PreviewOptions  class causing the output stream to be returned to the client for further use. |
#### Methods

| Method | Description |
| --- | --- |
| getCacheFolder() | Gets the cache folder. |
| setCacheFolder(String value) | Sets the cache folder. |
| getMaxDiskSpaceForCache() | Gets the maximum available disk space for cache in bytes. |
| setMaxDiskSpaceForCache(int value) | Sets the maximum available disk space for cache in bytes. |
| getMaxMemoryForCache() | Gets the maximum available memory for cache in memory in bytes. |
| setMaxMemoryForCache(int value) | Sets the maximum available memory for cache in memory in bytes. |
| getWidth() | Gets the page preview width. |
| setWidth(int value) | Sets the page preview width. |
| getHeight() | Gets the page preview height. |
| setHeight(int value) | Sets the page preview height. |
| getPageNumbers() | Gets an array of page numbers to generate previews. |
| setPageNumbers(int[] value) | Sets an array of page numbers to generate previews. |
| getPreviewFormat() | Gets the preview image format. |
| setPreviewFormat(PreviewFormats value) | Sets the preview image format. |
| getCreatePageStream() | Gets an instance of the page stream creation delegate. |
| setCreatePageStream(ICreatePageStream value) | Sets an instance of the page stream creation delegate. |
| getReleasePageStream() | Gets an instance of the page preview completion delegate. |
| setReleasePageStream(IReleasePageStream value) | Sets an instance of the page preview completion delegate. |
| getResolution() | Gets or sets the page preview resolution. |
| setResolution(int value) | Gets or sets the page preview resolution. |
##### PreviewOptions(ICreatePageStream createPageStream)
```
public PreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the  PreviewOptions  class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of  PreviewOptions  class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### getCacheFolder()
```
public final String getCacheFolder()
```

Gets the cache folder. By default the cache folder is set to user's local temp directory.

**Returns:**
java.lang.String - The cache folder.
##### setCacheFolder(String value)
```
public final void setCacheFolder(String value)
```

Sets the cache folder. By default the cache folder is set to user's local temp directory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The cache folder. |

##### getMaxDiskSpaceForCache()
```
public final int getMaxDiskSpaceForCache()
```

Gets the maximum available disk space for cache in bytes. The default value is 1073741824.

**Returns:**
int - The maximum available disk space for cache in bytes.
##### setMaxDiskSpaceForCache(int value)
```
public final void setMaxDiskSpaceForCache(int value)
```

Sets the maximum available disk space for cache in bytes. The default value is 1073741824.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum available disk space for cache in bytes. |

##### getMaxMemoryForCache()
```
public final int getMaxMemoryForCache()
```

Gets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

**Returns:**
int - The maximum available memory for cache in memory in bytes.
##### setMaxMemoryForCache(int value)
```
public final void setMaxMemoryForCache(int value)
```

Sets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum available memory for cache in memory in bytes. |

##### getWidth()
```
public final int getWidth()
```

Gets the page preview width.

**Returns:**
int - The page preview width.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview width. |

##### getHeight()
```
public final int getHeight()
```

Gets the page preview height.

**Returns:**
int - The page preview height.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview height. |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets an array of page numbers to generate previews.

**Returns:**
int[] - An array of page numbers to generate previews.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets an array of page numbers to generate previews.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | An array of page numbers to generate previews. |

##### getPreviewFormat()
```
public final PreviewFormats getPreviewFormat()
```

Gets the preview image format.

**Returns:**
PreviewFormats - The preview image format.
##### setPreviewFormat(PreviewFormats value)
```
public final void setPreviewFormat(PreviewFormats value)
```

Sets the preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PreviewFormats | The preview image format. |

##### getCreatePageStream()
```
public final ICreatePageStream getCreatePageStream()
```

Gets an instance of the page stream creation delegate.

**Returns:**
ICreatePageStream - An instance of the page stream creation delegate.
##### setCreatePageStream(ICreatePageStream value)
```
public final void setCreatePageStream(ICreatePageStream value)
```

Sets an instance of the page stream creation delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICreatePageStream | An instance of the page stream creation delegate. |

##### getReleasePageStream()
```
public final IReleasePageStream getReleasePageStream()
```

Gets an instance of the page preview completion delegate.

**Returns:**
IReleasePageStream - An instance of the page preview completion delegate.
##### setReleasePageStream(IReleasePageStream value)
```
public final void setReleasePageStream(IReleasePageStream value)
```

Sets an instance of the page preview completion delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IReleasePageStream | An instance of the page preview completion delegate. |

##### getResolution()
```
public final int getResolution()
```

Gets or sets the page preview resolution.

**Returns:**
int
##### setResolution(int value)
```
public final void setResolution(int value)
```

Gets or sets the page preview resolution.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.metadata.search
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search.md

The **com.groupdocs.metadata.search** namespace contains base classes, utility classes and interfaces used across all formats and metadata standards.

#### Classes

| Class | Description |
| --- | --- |
| AndSpecification | Represents a composite specification that uses the logical AND operator to combine two given search specifications. |
| AnySpecification | Represents a specification that applies no filters to a property. |
| ContainsTagSpecification | Represents a specification that checks whether the passed property contains the specified tag. |
| FallsIntoCategorySpecification | Represents a specification that verifies whether the passed property falls into a particular category (i.e. |
| NotSpecification | Represents a composite specification that negates any other specification. |
| OfTypeSpecification | Represents a specification that filters properties of a particular type. |
| OrSpecification | Represents a composite specification that uses the logical OR operator to combine two given search specifications. |
| Specification | Provides a base abstract class for search specifications that can be combined using logical operators. |
| WithNameSpecification | Represents a specification that filters properties with a particular name. |

### AndSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/andspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class AndSpecification extends Specification
```

Represents a composite specification that uses the logical AND operator to combine two given search specifications.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the left specification. |
| getRight() | Gets the right specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getLeft()
```
public final Specification getLeft()
```

Gets the left specification.

**Returns:**
Specification - The left specification.
##### getRight()
```
public final Specification getRight()
```

Gets the right specification.

**Returns:**
Specification - The right specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### AnySpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/anyspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class AnySpecification extends Specification
```

Represents a specification that applies no filters to a property.
#### Constructors

| Constructor | Description |
| --- | --- |
| AnySpecification() |  |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### AnySpecification()
```
public AnySpecification()
```

##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### ContainsTagSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/containstagspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class ContainsTagSpecification extends Specification
```

Represents a specification that checks whether the passed property contains the specified tag.
#### Constructors

| Constructor | Description |
| --- | --- |
| ContainsTagSpecification(PropertyTag tag) | Initializes a new instance of the  ContainsTagSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getTag() | Gets the tag a property must contain to satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### ContainsTagSpecification(PropertyTag tag)
```
public ContainsTagSpecification(PropertyTag tag)
```

Initializes a new instance of the  ContainsTagSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tag | PropertyTag | The tag a property must contain to satisfy the specification. |

##### getTag()
```
public final PropertyTag getTag()
```

Gets the tag a property must contain to satisfy the specification.

**Returns:**
PropertyTag - The tag a property must contain to satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### FallsIntoCategorySpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/fallsintocategoryspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class FallsIntoCategorySpecification extends Specification
```

Represents a specification that verifies whether the passed property falls into a particular category (i.e. contains tags from the specified category).
#### Constructors

| Constructor | Description |
| --- | --- |
| FallsIntoCategorySpecification(TagCategory category) | Initializes a new instance of the  FallsIntoCategorySpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getCategory() | Gets the category into which a property must fall to satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### FallsIntoCategorySpecification(TagCategory category)
```
public FallsIntoCategorySpecification(TagCategory category)
```

Initializes a new instance of the  FallsIntoCategorySpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| category | TagCategory | The category into which a property must fall to satisfy the specification. |

##### getCategory()
```
public final TagCategory getCategory()
```

Gets the category into which a property must fall to satisfy the specification.

**Returns:**
TagCategory - The category into which a property must fall to satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### NotSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/notspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class NotSpecification extends Specification
```

Represents a composite specification that negates any other specification.
#### Methods

| Method | Description |
| --- | --- |
| getWrapped() | Gets the base specification to be negated. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getWrapped()
```
public final Specification getWrapped()
```

Gets the base specification to be negated.

**Returns:**
Specification - The base specification to be negated.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### OfTypeSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/oftypespecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class OfTypeSpecification extends Specification
```

Represents a specification that filters properties of a particular type.
#### Constructors

| Constructor | Description |
| --- | --- |
| OfTypeSpecification(MetadataPropertyType propertyType) | Initializes a new instance of the  OfTypeSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPropertyType() | Gets the type of properties that satisfy the specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### OfTypeSpecification(MetadataPropertyType propertyType)
```
public OfTypeSpecification(MetadataPropertyType propertyType)
```

Initializes a new instance of the  OfTypeSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyType | MetadataPropertyType | The type of properties that satisfy the specification. |

##### getPropertyType()
```
public final MetadataPropertyType getPropertyType()
```

Gets the type of properties that satisfy the specification.

**Returns:**
MetadataPropertyType - The type of properties that satisfy the specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### OrSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/orspecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class OrSpecification extends Specification
```

Represents a composite specification that uses the logical OR operator to combine two given search specifications.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the left specification. |
| getRight() | Gets the right specification. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### getLeft()
```
public final Specification getLeft()
```

Gets the left specification.

**Returns:**
Specification - The left specification.
##### getRight()
```
public final Specification getRight()
```

Gets the right specification.

**Returns:**
Specification - The right specification.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### Specification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/specification.md

**Inheritance:**
java.lang.Object
```
public abstract class Specification
```

Provides a base abstract class for search specifications that can be combined using logical operators.
#### Constructors

| Constructor | Description |
| --- | --- |
| Specification() |  |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
| and(Specification other) | Combines two search specifications using the logical AND operator. |
| or(Specification other) | Combines two search specifications using the logical OR operator. |
| not() | Negates the specification. |
##### Specification()
```
public Specification()
```

##### isSatisfiedBy(MetadataProperty candidate)
```
public abstract boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.
##### and(Specification other)
```
public final Specification and(Specification other)
```

Combines two search specifications using the logical AND operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Specification | A specification to combine with. |

**Returns:**
Specification - A composite specification.
##### or(Specification other)
```
public final Specification or(Specification other)
```

Combines two search specifications using the logical OR operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Specification | A specification to combine with. |

**Returns:**
Specification - A composite specification.
##### not()
```
public final Specification not()
```

Negates the specification.

**Returns:**
Specification - A composite specification.

### WithNameSpecification
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.search/withnamespecification.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.search.Specification
```
public class WithNameSpecification extends Specification
```

Represents a specification that filters properties with a particular name.
#### Constructors

| Constructor | Description |
| --- | --- |
| WithNameSpecification(String propertyName) | Initializes a new instance of the  WithNameSpecification  class. |
| WithNameSpecification(String propertyName, boolean ignoreCase) | Initializes a new instance of the  WithNameSpecification  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPropertyName() | Gets the name of properties that satisfy the specification. |
| getIgnoreCase() | Gets a value indicating whether the case of the strings being compared should be ignored. |
| isSatisfiedBy(MetadataProperty candidate) | Verifies whether a  MetadataProperty  satisfies the specification. |
##### WithNameSpecification(String propertyName)
```
public WithNameSpecification(String propertyName)
```

Initializes a new instance of the  WithNameSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The type of properties that satisfy the specification. |

##### WithNameSpecification(String propertyName, boolean ignoreCase)
```
public WithNameSpecification(String propertyName, boolean ignoreCase)
```

Initializes a new instance of the  WithNameSpecification  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | java.lang.String | The type of properties that satisfy the specification. |
| ignoreCase | boolean | A value indicating whether the case of the strings being compared should be ignored. |

##### getPropertyName()
```
public final String getPropertyName()
```

Gets the name of properties that satisfy the specification.

**Returns:**
java.lang.String - The name of properties that satisfy the specification.
##### getIgnoreCase()
```
public final boolean getIgnoreCase()
```

Gets a value indicating whether the case of the strings being compared should be ignored.

**Returns:**
boolean - True if the case should be ignored; otherwise, false.
##### isSatisfiedBy(MetadataProperty candidate)
```
public boolean isSatisfiedBy(MetadataProperty candidate)
```

Verifies whether a  MetadataProperty  satisfies the specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | MetadataProperty | A metadata property to test. |

**Returns:**
boolean - True, if the passed property satisfies the specification; otherwise, false.

### com.groupdocs.metadata.tagging
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging.md

The **com.groupdocs.metadata.tagging** namespace contains various sets of tags with which most important metadata properties are marked.The tags allow users to find and update metadata properties in different packages regardless of the metadata standard and file format.

#### Classes

| Class | Description |
| --- | --- |
| ContentTagCategory | Provides tags that are attached to metadata properties describing the content of a file. |
| CorporateTagCategory | Provides tags intended to mark metadata properties related to a company that participated in file creation. |
| DocumentTagCategory | Provides tags that are applied to document-specific properties only. |
| LegalTagCategory | Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
| OriginTagCategory | Provides tags that help a user to determine the origin of a file (e.g. |
| PersonTagCategory | Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. |
| PropertyTag | Represents a tag used to mark metadata properties. |
| PropertyTypeTagCategory | Provides tags that bear additional information about the type of a property rather than about its purpose. |
| TagCategory | Represents a set of tags having some shared characteristics. |
| Tags | Contains various sets of tags with which most important metadata properties are marked. |
| TimeTagCategory | Provides tags that mark metadata properties used to describe the lifecycle of a file. |
| ToolTagCategory | Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |

### ContentTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/contenttagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class ContentTagCategory extends TagCategory
```

Provides tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Gets the tag that labels properties containing a description of a file. |
| getComment() | Gets the tag that denotes a comment left by a person who contributed in file creation. |
| getTitle() | Gets the tag that labels the name given to a file. |
| getThumbnail() | Gets the tag that indicates a thumbnail image attached to a file. |
| getLanguage() | Gets the tag indicating the language of the intellectual content of a file. |
| getSubject() | Gets the tag that denotes the subject the intellectual content is focused on. |
| getTableOfContents() | Gets the tag indicating properties containing the table of contents of a file. |
| getType() | Gets the tag that indicates the nature or genre of the content of a file. |
| getRating() | Gets the tag labeling a user assigned rating of a file. |
| getKeywords() | Gets the tag that denotes a metadata property containing keywords that describe the content. |
| getFileFormat() | Gets the tag that indicates a metadata property containing information about the format of a file. |
| getStatus() | Gets the tag that denotes the status of a file. |
| getVersion() | Gets the tag labeling the version or revision of a file. |
| getSharedDoc() | Gets the tag that denotes which is a common document for several manufacturers. |
| getHyperlinksChanged() | Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer. |
| getBody() | Gets the tag that denotes the body of a email file. |
| getAlbum() | Gets the tag that denotes the album name of a audio file. |
##### getDescription()
```
public final PropertyTag getDescription()
```

Gets the tag that labels properties containing a description of a file.

**Returns:**
PropertyTag - The tag that labels properties containing a description of a file.
##### getComment()
```
public final PropertyTag getComment()
```

Gets the tag that denotes a comment left by a person who contributed in file creation.

**Returns:**
PropertyTag - The tag that denotes a comment left by a person who contributed in file creation.
##### getTitle()
```
public final PropertyTag getTitle()
```

Gets the tag that labels the name given to a file.

**Returns:**
PropertyTag - The tag that labels the name given to a file.
##### getThumbnail()
```
public final PropertyTag getThumbnail()
```

Gets the tag that indicates a thumbnail image attached to a file.

**Returns:**
PropertyTag - The tag that indicates a thumbnail image attached to a file.
##### getLanguage()
```
public final PropertyTag getLanguage()
```

Gets the tag indicating the language of the intellectual content of a file.

**Returns:**
PropertyTag
##### getSubject()
```
public final PropertyTag getSubject()
```

Gets the tag that denotes the subject the intellectual content is focused on.

**Returns:**
PropertyTag - The tag that denotes the subject the intellectual content is focused on.
##### getTableOfContents()
```
public final PropertyTag getTableOfContents()
```

Gets the tag indicating properties containing the table of contents of a file.

**Returns:**
PropertyTag
##### getType()
```
public final PropertyTag getType()
```

Gets the tag that indicates the nature or genre of the content of a file. It also includes terms describing general categories, functions, aggregation levels for the content.

**Returns:**
PropertyTag
##### getRating()
```
public final PropertyTag getRating()
```

Gets the tag labeling a user assigned rating of a file.

**Returns:**
PropertyTag - The tag labeling a user assigned rating of a file.
##### getKeywords()
```
public final PropertyTag getKeywords()
```

Gets the tag that denotes a metadata property containing keywords that describe the content.

**Returns:**
PropertyTag - The tag that denotes a metadata property containing keywords that describe the content.
##### getFileFormat()
```
public final PropertyTag getFileFormat()
```

Gets the tag that indicates a metadata property containing information about the format of a file.

**Returns:**
PropertyTag - The tag that indicates a metadata property containing information about the format of a file.
##### getStatus()
```
public final PropertyTag getStatus()
```

Gets the tag that denotes the status of a file.

**Returns:**
PropertyTag - The tag that denotes the status of a file.
##### getVersion()
```
public final PropertyTag getVersion()
```

Gets the tag labeling the version or revision of a file.

**Returns:**
PropertyTag - The tag labeling the version or revision of a file.
##### getSharedDoc()
```
public final PropertyTag getSharedDoc()
```

Gets the tag that denotes which is a common document for several manufacturers.

**Returns:**
PropertyTag - The tag that denotes which is a common document for several manufacturers.
##### getHyperlinksChanged()
```
public final PropertyTag getHyperlinksChanged()
```

Gets the tag that denotes the indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.

**Returns:**
PropertyTag - The tag that denotes indicates that one or more hyperlinks in this part have been updated exclusively in this part by the manufacturer.
##### getBody()
```
public final PropertyTag getBody()
```

Gets the tag that denotes the body of a email file.

**Returns:**
PropertyTag - The tag that denotes the body of a email file.
##### getAlbum()
```
public final PropertyTag getAlbum()
```

Gets the tag that denotes the album name of a audio file.

Value: The tag that denotes the album name of a audio file.

**Returns:**
PropertyTag

### CorporateTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/corporatetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class CorporateTagCategory extends TagCategory
```

Provides tags intended to mark metadata properties related to a company that participated in file creation.
#### Methods

| Method | Description |
| --- | --- |
| getCompany() | Gets the tag that labels a property containing information about a company contributed to file creation. |
| getManager() | Gets the tag that labels information about a person who managed the making process of a file. |
##### getCompany()
```
public final PropertyTag getCompany()
```

Gets the tag that labels a property containing information about a company contributed to file creation. Alternatively, the tag can refer to a company the file content is about.

**Returns:**
PropertyTag
##### getManager()
```
public final PropertyTag getManager()
```

Gets the tag that labels information about a person who managed the making process of a file.

**Returns:**
PropertyTag - The tag that labels information about a person who managed the making process of a file.

### DocumentTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/documenttagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class DocumentTagCategory extends TagCategory
```

Provides tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.
#### Methods

| Method | Description |
| --- | --- |
| getBuiltIn() | Gets the tag that indicates that the property it labels is built-in. |
| getReadOnly() | Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata. |
| getHiddenData() | Gets the tag indicating a document part that is not visible for regular users. |
| getUserComment() | Gets the tag that labels user comments shown in the document content. |
| getPage() | Gets the tag that denotes a property holding information about a document page. |
| getStatistic() | Gets the tag indicating a property containing document statistics (word count, character count, etc). |
| getField() | Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document. |
| getRevision() | Get the tag labeling a property containing information about a document revision (tracked change). |
##### getBuiltIn()
```
public final PropertyTag getBuiltIn()
```

Gets the tag that indicates that the property it labels is built-in.

**Returns:**
PropertyTag - The tag that indicates that the property it labels is built-in.
##### getReadOnly()
```
public final PropertyTag getReadOnly()
```

Gets the tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.

**Returns:**
PropertyTag - The tag that indicates that the property it labels is read-only and cannot be changed by GroupDocs.Metadata.
##### getHiddenData()
```
public final PropertyTag getHiddenData()
```

Gets the tag indicating a document part that is not visible for regular users.

**Returns:**
PropertyTag - The tag indicating a document part that is not visible for regular users.
##### getUserComment()
```
public final PropertyTag getUserComment()
```

Gets the tag that labels user comments shown in the document content.

**Returns:**
PropertyTag - The tag that labels user comments shown in the document content.
##### getPage()
```
public final PropertyTag getPage()
```

Gets the tag that denotes a property holding information about a document page.

**Returns:**
PropertyTag - The tag that denotes a property holding information about a document page.
##### getStatistic()
```
public final PropertyTag getStatistic()
```

Gets the tag indicating a property containing document statistics (word count, character count, etc).

**Returns:**
PropertyTag - The tag indicating a property containing document statistics (word count, character count, etc).
##### getField()
```
public final PropertyTag getField()
```

Gets the tag that denotes a property holding information about a form field or calculated field extracted from a document.

**Returns:**
PropertyTag - The tag that denotes a property holding information about a form field or calculated field extracted from a document.
##### getRevision()
```
public final PropertyTag getRevision()
```

Get the tag labeling a property containing information about a document revision (tracked change).

**Returns:**
PropertyTag - The tag labeling a property containing information about a document revision (tracked change).

### LegalTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/legaltagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class LegalTagCategory extends TagCategory
```

Provides tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.
#### Methods

| Method | Description |
| --- | --- |
| getCopyright() | Gets the tag that labels a copyright notice provided by the owner. |
| getOwner() | Gets the tag that denotes information about the owners of a file. |
| getUsageTerms() | Gets the tag that labels instructions on how the file can be used. |
##### getCopyright()
```
public final PropertyTag getCopyright()
```

Gets the tag that labels a copyright notice provided by the owner.

**Returns:**
PropertyTag - The tag that labels a copyright notice provided by the owner.
##### getOwner()
```
public final PropertyTag getOwner()
```

Gets the tag that denotes information about the owners of a file.

**Returns:**
PropertyTag - The tag that denotes information about the owners of a file.
##### getUsageTerms()
```
public final PropertyTag getUsageTerms()
```

Gets the tag that labels instructions on how the file can be used.

**Returns:**
PropertyTag - The tag that labels instructions on how the file can be used.

### OriginTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/origintagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class OriginTagCategory extends TagCategory
```

Provides tags that help a user to determine the origin of a file (e.g. template or another source).
#### Methods

| Method | Description |
| --- | --- |
| getTemplate() | Gets the tag that denotes the template from which the file was created. |
| getSource() | Gets the tag that labels a reference to a resource from which the file content is derived. |
##### getTemplate()
```
public final PropertyTag getTemplate()
```

Gets the tag that denotes the template from which the file was created.

**Returns:**
PropertyTag - The tag that denotes the template from which the file was created.
##### getSource()
```
public final PropertyTag getSource()
```

Gets the tag that labels a reference to a resource from which the file content is derived.

**Returns:**
PropertyTag - The tag that labels a reference to a resource from which the file content is derived.

### PersonTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/persontagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class PersonTagCategory extends TagCategory
```

Provides tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.
#### Methods

| Method | Description |
| --- | --- |
| getCreator() | Gets the tag that denotes the original author of a file/document. |
| getContributor() | Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. |
| getEditor() | Gets the tag that labels a person who edited a file. |
| getModel() | Gets the tag that denotes information about a person the content of the file is about. |
| getClient() | Gets the tag that labels information about the client for whom the file/intellectual content was created. |
| getManager() | Gets the tag that labels information about a person who managed the making process of a file. |
| getPublisher() | Gets the tag marking a person responsible for making the file available. |
| getArtist() | Gets the tag that denotes the original performer of a file. |
| getRecipient() | Gets the tag that denotes the original recipients of a mail. |
##### getCreator()
```
public final PropertyTag getCreator()
```

Gets the tag that denotes the original author of a file/document.

**Returns:**
PropertyTag - The tag that denotes the original author of a file/document.
##### getContributor()
```
public final PropertyTag getContributor()
```

Gets the tag that labels a property containing the name of a person who somehow contributed to file creation. Please note that the tag is not applied towards metadata properties marked with more specific tags from this category. E.g. if a property labeled with the Creator tag.

**Returns:**
PropertyTag - The tag that labels a property containing the name of a person who somehow contributed to file creation.
##### getEditor()
```
public final PropertyTag getEditor()
```

Gets the tag that labels a person who edited a file. The tag is usually used to mark a property containing information about the last editor.

**Returns:**
PropertyTag - The tag that labels a person who edited a file.
##### getModel()
```
public final PropertyTag getModel()
```

Gets the tag that denotes information about a person the content of the file is about. For photos that is a person shown in the image.

**Returns:**
PropertyTag - The tag that denotes information about a person the content of the file is about.
##### getClient()
```
public final PropertyTag getClient()
```

Gets the tag that labels information about the client for whom the file/intellectual content was created.

**Returns:**
PropertyTag - The tag that labels information about the client for whom the file/intellectual content was created.
##### getManager()
```
public final PropertyTag getManager()
```

Gets the tag that labels information about a person who managed the making process of a file.

**Returns:**
PropertyTag - The tag that labels information about a person who managed the making process of a file.
##### getPublisher()
```
public final PropertyTag getPublisher()
```

Gets the tag marking a person responsible for making the file available.

**Returns:**
PropertyTag - The tag marking a person responsible for making the file available.
##### getArtist()
```
public final PropertyTag getArtist()
```

Gets the tag that denotes the original performer of a file.

**Returns:**
PropertyTag - The tag that denotes the original performer of a file.
##### getRecipient()
```
public final PropertyTag getRecipient()
```

Gets the tag that denotes the original recipients of a mail.

**Returns:**
PropertyTag - The tag that denotes the original recipients of a mail.

### PropertyTag
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/propertytag.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable
```
public final class PropertyTag implements System.IEquatable<PropertyTag>
```

Represents a tag used to mark metadata properties.
#### Methods

| Method | Description |
| --- | --- |
| getCategory() | Gets the tag category. |
| equals(PropertyTag other) | Indicates whether the current object is equal to another object of the same type. |
| equals(Object obj) | Determines whether the specified object is equal to the current object. |
| hashCode() | Serves as the default hash function. |
| op_Equality(PropertyTag left, PropertyTag right) | Indicates whether two objects of the same type are equal. |
| op_Inequality(PropertyTag left, PropertyTag right) | Indicates whether two objects of the same type are not equal. |
| toString() | Returns a string that represents the current object. |
##### getCategory()
```
public final TagCategory getCategory()
```

Gets the tag category.

**Returns:**
TagCategory - The tag category.
##### equals(PropertyTag other)
```
public final boolean equals(PropertyTag other)
```

Indicates whether the current object is equal to another object of the same type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | PropertyTag | An object to compare with this object. |

**Returns:**
boolean - True if the current object is equal to the  other  parameter; otherwise, false.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified object is equal to the current object.

**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.
##### hashCode()
```
public int hashCode()
```

Serves as the default hash function.

**Returns:**
int - A hash code for the current object.
##### op_Equality(PropertyTag left, PropertyTag right)
```
public static boolean op_Equality(PropertyTag left, PropertyTag right)
```

Indicates whether two objects of the same type are equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

**Returns:**
boolean - True if the objects are equal; otherwise, false.
##### op_Inequality(PropertyTag left, PropertyTag right)
```
public static boolean op_Inequality(PropertyTag left, PropertyTag right)
```

Indicates whether two objects of the same type are not equal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | PropertyTag | The left object. |
| right | PropertyTag | The rigt object. |

**Returns:**
boolean - True if the objects are not equal; otherwise, false.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### PropertyTypeTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/propertytypetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class PropertyTypeTagCategory extends TagCategory
```

Provides tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.
#### Methods

| Method | Description |
| --- | --- |
| getLink() | Gets the tag that denotes a property being a link to an external resource. |
| getHash() | Gets the tag that labels a property holding a hash of the file content. |
| getMeasure() | Gets the tag that indicates a property being a measured characteristic of the content. |
| getDigitalSignature() | Gets the tag that labels a digital signature. |
| getIdentifier() | Gets the tag that labels a property containing an identifier of the content. |
| getLocation() | Gets the tag that indicates a property being a reference to a geographical location. |
| getFont() | Gets the tag that denotes a property describing font characteristics. |
| getColor() | Gets the tag that labels a property describing a color. |
| getBitrate() | Gets the tag that labels a property describing a bitrate. |
##### getLink()
```
public final PropertyTag getLink()
```

Gets the tag that denotes a property being a link to an external resource.

**Returns:**
PropertyTag - The tag that denotes a property being a link to an external resource.
##### getHash()
```
public final PropertyTag getHash()
```

Gets the tag that labels a property holding a hash of the file content.

**Returns:**
PropertyTag - The tag that labels a property holding a hash of the file content.
##### getMeasure()
```
public final PropertyTag getMeasure()
```

Gets the tag that indicates a property being a measured characteristic of the content. It can be the file size, number of pages, page size, etc.

**Returns:**
PropertyTag - The tag that indicates a property being a measured characteristic of the content.
##### getDigitalSignature()
```
public final PropertyTag getDigitalSignature()
```

Gets the tag that labels a digital signature.

**Returns:**
PropertyTag - The tag that labels a digital signature.
##### getIdentifier()
```
public final PropertyTag getIdentifier()
```

Gets the tag that labels a property containing an identifier of the content.

**Returns:**
PropertyTag - The tag that labels a property containing an identifier of the content.
##### getLocation()
```
public final PropertyTag getLocation()
```

Gets the tag that indicates a property being a reference to a geographical location. The property can contain the name of a city, full address, GPS coordinates, etc.

**Returns:**
PropertyTag - The tag that indicates a property being a reference to a geographical location.
##### getFont()
```
public final PropertyTag getFont()
```

Gets the tag that denotes a property describing font characteristics.

**Returns:**
PropertyTag - The tag that denotes a property describing font characteristics.
##### getColor()
```
public final PropertyTag getColor()
```

Gets the tag that labels a property describing a color.

**Returns:**
PropertyTag - The tag that labels a property describing a color.
##### getBitrate()
```
public final PropertyTag getBitrate()
```

Gets the tag that labels a property describing a bitrate.

**Returns:**
PropertyTag - The tag that labels a property describing a bitrate.

### TagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/tagcategory.md

**Inheritance:**
java.lang.Object
```
public class TagCategory
```

Represents a set of tags having some shared characteristics.
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a string that represents the current object. |
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### Tags
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/tags.md

**Inheritance:**
java.lang.Object
```
public class Tags
```

Contains various sets of tags with which most important metadata properties are marked. The tags allow you to find and update metadata properties in different packages regardless of the metadata standard and file format.
#### Constructors

| Constructor | Description |
| --- | --- |
| Tags() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPerson() | Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. |
| getTool() | Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file. |
| getTime() | Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. |
| getContent() | Gets the tags that are attached to metadata properties describing the content of a file. |
| getPropertyType() | Gets a set of tags that bear additional information about the type of a property rather than about its purpose. |
| getDocument() | Gets a set of tags that are applied to document-specific properties only. |
| getOrigin() | Gets the tags that help a user to determine the origin of a file (e.g. |
| getCorporate() | Gets a set of tags intended to mark metadata properties related to a company that participated in file creation. |
| getLegal() | Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used. |
##### Tags()
```
public Tags()
```

##### getPerson()
```
public static PersonTagCategory getPerson()
```

Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation. These tags can help you to find the document creator, editor or even the client for whom the work was performed. Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.

**Returns:**
PersonTagCategory - A set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation.
##### getTool()
```
public static ToolTagCategory getTool()
```

Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.

**Returns:**
ToolTagCategory - The tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.
##### getTime()
```
public static TimeTagCategory getTime()
```

Gets a set of tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.

**Returns:**
TimeTagCategory - A set of tags that mark metadata properties used to describe the lifecycle of a file.
##### getContent()
```
public static ContentTagCategory getContent()
```

Gets the tags that are attached to metadata properties describing the content of a file. The tags are useful to find out the content language, type (genre), subject, rating, etc.

**Returns:**
ContentTagCategory - The tags that are attached to metadata properties describing the content of a file.
##### getPropertyType()
```
public static PropertyTypeTagCategory getPropertyType()
```

Gets a set of tags that bear additional information about the type of a property rather than about its purpose. Using these tags you can detect metadata properties that contain URL links to external resources, properties describing fonts, colors, geolocation and so on.

**Returns:**
PropertyTypeTagCategory
##### getDocument()
```
public static DocumentTagCategory getDocument()
```

Gets a set of tags that are applied to document-specific properties only. The tags can be useful to determine from which part of an office document a property was extracted.

**Returns:**
DocumentTagCategory - A set of tags that are applied to document-specific properties only.
##### getOrigin()
```
public static OriginTagCategory getOrigin()
```

Gets the tags that help a user to determine the origin of a file (e.g. template or another source).

**Returns:**
OriginTagCategory - The tags that help a user to determine the origin of a file (e.g. template or another source).
##### getCorporate()
```
public static CorporateTagCategory getCorporate()
```

Gets a set of tags intended to mark metadata properties related to a company that participated in file creation.

**Returns:**
CorporateTagCategory - A set of tags intended to mark metadata properties related to a company that participated in file creation.
##### getLegal()
```
public static LegalTagCategory getLegal()
```

Gets a set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

**Returns:**
LegalTagCategory - A set of tags that are attached to metadata properties holding information about the owners of the file content and the rules under which the content can be used.

### TimeTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/timetagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class TimeTagCategory extends TagCategory
```

Provides tags that mark metadata properties used to describe the lifecycle of a file. The tags deal with time points when a file or intellectual content was created, edited, printed, etc.
#### Methods

| Method | Description |
| --- | --- |
| getIntellectualContentCreated() | Gets the tag that denotes the date the intellectual content of a file was created. |
| getCreated() | Gets the tag that indicates the date a file was created. |
| getModified() | Gets the tag that indicates the date a file was edited. |
| getPublished() | Gets the tag that indicates the date a file became available. |
| getPrinted() | Gets the tag that denotes the date a file was printed. |
| getExpired() | Gets the tag that labels the latest date the owner intends the file data to be used. |
| getTotalEditingTime() | Gets the tag that denotes the total editing time of a file. |
| getDuration() | Gets the tag that denotes the duration of a media file. |
| getZoneCity() | Gets the tag that denotes the time zone. |
##### getIntellectualContentCreated()
```
public final PropertyTag getIntellectualContentCreated()
```

Gets the tag that denotes the date the intellectual content of a file was created.

**Returns:**
PropertyTag - The tag that denotes the date the intellectual content of a file was created.
##### getCreated()
```
public final PropertyTag getCreated()
```

Gets the tag that indicates the date a file was created.

**Returns:**
PropertyTag - The tag that indicates the date a file was created.
##### getModified()
```
public final PropertyTag getModified()
```

Gets the tag that indicates the date a file was edited.

**Returns:**
PropertyTag - The tag that indicates the date a file was edited.
##### getPublished()
```
public final PropertyTag getPublished()
```

Gets the tag that indicates the date a file became available.

**Returns:**
PropertyTag - The tag that indicates the date a file became available.
##### getPrinted()
```
public final PropertyTag getPrinted()
```

Gets the tag that denotes the date a file was printed.

**Returns:**
PropertyTag - The tag that denotes the date a file was printed.
##### getExpired()
```
public final PropertyTag getExpired()
```

Gets the tag that labels the latest date the owner intends the file data to be used.

**Returns:**
PropertyTag - The tag that labels the latest date the owner intends the file data to be used.
##### getTotalEditingTime()
```
public final PropertyTag getTotalEditingTime()
```

Gets the tag that denotes the total editing time of a file.

**Returns:**
PropertyTag - The tag that denotes the total editing time of a file.
##### getDuration()
```
public final PropertyTag getDuration()
```

Gets the tag that denotes the duration of a media file.

**Returns:**
PropertyTag - The tag that denotes the duration of a media file.
##### getZoneCity()
```
public final PropertyTag getZoneCity()
```

Gets the tag that denotes the time zone.

**Returns:**
PropertyTag - The tag that denotes the time zone.

### ToolTagCategory
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.tagging/tooltagcategory.md

**Inheritance:**
java.lang.Object, com.groupdocs.metadata.tagging.TagCategory
```
public class ToolTagCategory extends TagCategory
```

Provides tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.
#### Methods

| Method | Description |
| --- | --- |
| getSoftware() | Gets the tag that labels any kind of software used to create a file. |
| getHardware() | Gets the tag that denotes any kind of hardware used to create a file. |
| getSoftwareVersion() | Gets the tag that labels properties containing the version of the software used to create a file. |
| getHardwareVersion() | Gets the tag that labels properties containing the version of the hardware used to create a file. |
| getSoftwareManufacturer() | Gets the tag that marks a software manufacturer. |
| getHardwareManufacturer() | Gets the tag that marks a hardware manufacturer. |
| getModelId() | Gets the tag that marks a model id. |
##### getSoftware()
```
public final PropertyTag getSoftware()
```

Gets the tag that labels any kind of software used to create a file.

**Returns:**
PropertyTag - The tag that labels any kind of software used to create a file.
##### getHardware()
```
public final PropertyTag getHardware()
```

Gets the tag that denotes any kind of hardware used to create a file.

**Returns:**
PropertyTag - The tag that denotes any kind of hardware used to create a file.
##### getSoftwareVersion()
```
public final PropertyTag getSoftwareVersion()
```

Gets the tag that labels properties containing the version of the software used to create a file.

**Returns:**
PropertyTag - The tag that labels properties containing the version of the software used to create a file.
##### getHardwareVersion()
```
public final PropertyTag getHardwareVersion()
```

Gets the tag that labels properties containing the version of the hardware used to create a file.

**Returns:**
PropertyTag - The tag that labels properties containing the version of the hardware used to create a file.
##### getSoftwareManufacturer()
```
public final PropertyTag getSoftwareManufacturer()
```

Gets the tag that marks a software manufacturer.

**Returns:**
PropertyTag - The tag that marks a software manufacturer.
##### getHardwareManufacturer()
```
public final PropertyTag getHardwareManufacturer()
```

Gets the tag that marks a hardware manufacturer.

**Returns:**
PropertyTag - The tag that marks a hardware manufacturer.
##### getModelId()
```
public final PropertyTag getModelId()
```

Gets the tag that marks a model id.

**Returns:**
PropertyTag - The tag that marks a model id.

### com.groupdocs.metadata
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata.md

The **com.groupdocs.metadata** namespace is the entry point to all features of the library.

#### Classes

| Class | Description |
| --- | --- |
| Metadata | Provides the main class to access metadata in all supported formats. |

### Metadata
Path: https://reference.groupdocs.com/metadata/nodejs-java/com.groupdocs.metadata/metadata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public final class Metadata implements Closeable
```

Provides the main class to access metadata in all supported formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| Metadata(String filePath) | Initializes a new instance of the  Metadata  class. |
| Metadata(InputStream document) | Initializes a new instance of the  Metadata  class. |
| Metadata(String filePath, LoadOptions loadOptions) | Initializes a new instance of the  Metadata  class. |
| Metadata(InputStream document, LoadOptions loadOptions) | Initializes a new instance of the  Metadata  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets the type of the loaded file (if recognized). |
| getRootPackage() | Gets the root package providing access to all metadata properties extracted from the file. |
| <TRoot>getRootPackageGeneric() | Gets the root package providing access to all metadata properties extracted from the file. |
| findProperties(Specification specification) | Finds the metadata properties satisfying a specification. |
| updateProperties(Specification specification, PropertyValue value) | Updates known metadata properties satisfying a specification. |
| removeProperties(Specification specification) | Removes metadata properties satisfying a specification. |
| addProperties(Specification specification, PropertyValue value) | Adds known metadata properties satisfying the specification. |
| setProperties(Specification specification, PropertyValue value) | Sets known metadata properties satisfying the specification. |
| sanitize() | Removes writable metadata properties from all detected packages or whole packages if possible. |
| save() | Saves all changes made in the loaded document. |
| save(OutputStream document) | Saves the document content into a stream. |
| save(String filePath) | Saves the document content to the specified file. |
| generatePreview(PreviewOptions previewOptions) | Creates preview images for specified pages. |
| getDocumentInfo() | Gets common information about the loaded document. |
| copyTo(MetadataPackage metadataPackage) | Copy known metadata properties from source package to destination package. |
| copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags) | Copy known metadata properties from source package to destination package. |
| close() | Closes the loaded document and releases any system resources associated with it. |
##### Metadata(String filePath)
```
public Metadata(String filePath)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | A string that contains the full name of the file from which to create a  Metadata  instance.

This example demonstrates how to load a file from a local disk.

> ```
> ```
>
>  // Constants.InputOne is an absolute or relative path to your document. Ex: @"C:\Docs\source.one"
>  try (Metadata metadata = new Metadata(Constants.InputOne)) {
>      // Extract, edit or remove metadata here
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(InputStream document)
```
public Metadata(InputStream document)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | A stream that contains the document to load.

This example demonstrates how to load a file from a stream.

> ```
> ```
>
>  // Constants.InputDoc is an absolute or relative path to your document. Ex: @"C:\Docs\source.doc"
>  try (InputStream stream = new FileInputStream(Constants.InputDoc)) {
>      try (Metadata metadata = new Metadata(stream)) {
>          // Extract, edit or remove metadata here
>      }
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(String filePath, LoadOptions loadOptions)
```
public Metadata(String filePath, LoadOptions loadOptions)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | A string that contains the full name of the file from which to create a  Metadata  instance. |
| loadOptions | LoadOptions | Additional options to use when loading a document.

This example demonstrates how to load a password-protected document.

> ```
> ```
>
>  // Specify the password
>  LoadOptions loadOptions = new LoadOptions();
>  loadOptions.setPassword("123");
>  // Constants.ProtectedDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>  try (Metadata metadata = new Metadata(Constants.ProtectedDocx, loadOptions)) {
>      // Extract, edit or remove metadata here
>  }
>
> ```
> ```

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### Metadata(InputStream document, LoadOptions loadOptions)
```
public Metadata(InputStream document, LoadOptions loadOptions)
```

Initializes a new instance of the  Metadata  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | A stream that contains the document to load. |
| loadOptions | LoadOptions | Additional options to use when loading a document.

[Load from a local disk]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+local+disk
[Load from a stream]: https://docs.groupdocs.com/display/metadatajava/Load+from+a+stream
[Load a file of a specific format]: https://docs.groupdocs.com/display/metadatajava/Load+a+file+of+a+specific+format
[Load a password-protected document]: https://docs.groupdocs.com/display/metadatajava/Load+a+password-protected+document |

##### getFileFormat()
```
public final FileFormat getFileFormat()
```

Gets the type of the loaded file (if recognized).

**Returns:**
FileFormat - The type of the loaded file if recognized; otherwise,  F:GroupDocs.Metadata.FileFormat.Unknown .
##### getRootPackage()
```
public final RootMetadataPackage getRootPackage()
```

Gets the root package providing access to all metadata properties extracted from the file.

**Returns:**
RootMetadataPackage - The root package providing access to all metadata properties extracted from the file.

This example demonstrates how to traverse the whole metadata tree for a specific file regardless of the format.

> ```
> ```
>
>  public static void run() {
>      try (Metadata metadata = new Metadata(Constants.JpegWithXmp)) {
>          displayMetadataTree(metadata.getRootPackage(), 0);
>      }
>  }
>  private static void displayMetadataTree(MetadataPackage metadata, int indent) {
>      if (metadata != null) {
>          String stringMetadataType = String.valueOf(metadata.getMetadataType());
>          System.out.printf("%" + (stringMetadataType.length() + indent) + "s%n", stringMetadataType);
>          for (MetadataProperty property : metadata) {
>              String stringPropertyRepresentation = "Name: " + property.getName() + ", Value: " + property.getValue();
>              System.out.printf("%" + (stringPropertyRepresentation.length() + indent + 1) + "s%n", stringPropertyRepresentation);
>              if (property.getValue() != null) {
>                  switch (property.getValue().getType()) {
>                      case MetadataPropertyType.Metadata:
>                          displayMetadataTree(property.getValue().toClass(MetadataPackage.class), indent + 2);
>                      break;
>                      case MetadataPropertyType.MetadataArray:
>                          displayMetadataTree(property.getValue().toArray(MetadataPackage.class), indent + 2);
>                      break;
>                  }
>              }
>          }
>      }
>  }
>  private static void displayMetadataTree(MetadataPackage[] metadataArray, int indent) {
>      if (metadataArray != null) {
>          for (MetadataPackage metadata : metadataArray) {
>              displayMetadataTree(metadata, indent);
>          }
>      }
>  }
>
> ```
> ```

[Traverse a whole metadata tree]: https://docs.groupdocs.com/display/metadatajava/Traverse+a+whole+metadata+tree
##### <TRoot>getRootPackageGeneric()
```
public final TRoot <TRoot>getRootPackageGeneric()
```

Gets the root package providing access to all metadata properties extracted from the file.

[Traverse a whole metadata tree]: https://docs.groupdocs.com/display/metadatajava/Traverse+a+whole+metadata+tree

**Returns:**
TRoot - The root package providing access to all metadata properties extracted from the file.

 TRoot : The exact type of the root package.
##### findProperties(Specification specification)
```
public final IReadOnlyList<MetadataProperty> findProperties(Specification specification)
```

Finds the metadata properties satisfying a specification. The search is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A function to test each metadata property for a condition.

This example demonstrates how to search for specific metadata properties using tags.

> ```
> ```
>
>  // Constants.InputPptx is an absolute or relative path to your document. Ex: @"C:\Docs\source.pptx"
>  try (Metadata metadata = new Metadata(Constants.InputPptx)) {
>      // Fetch all the properties satisfying the predicate:
>      // property contains the name of the last document editor OR the date/time the document was last modified
>      IReadOnlyList properties = metadata.findProperties(
>              new ContainsTagSpecification(Tags.getPerson().getEditor()).or(new ContainsTagSpecification(Tags.getTime().getModified())));
>      for (MetadataProperty property : properties) {
>          System.out.println(String.format("Property name: %s, Property value: %s", property.getName(), property.getValue()));
>      }
>  }
>
> ```
> ```

[Extracting metadata]: https://docs.groupdocs.com/display/metadatajava/Extracting+metadata |

**Returns:**
IReadOnlyList - A collection that contains properties from the package that satisfy the condition.
##### updateProperties(Specification specification, PropertyValue value)
```
public final int updateProperties(Specification specification, PropertyValue value)
```

Updates known metadata properties satisfying a specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to update a property with a value having an inappropriate type.

This example demonstrates how to update existing metadata properties by various criteria regardless of the file format.

> ```
> ```
>
>  public class UpdatingMetadata {
>      public static void run() {
>          Date threeDaysAgo = new Date(System.currentTimeMillis() - TimeUnit.DAYS.toMillis(3));
>          File folder = new File(Constants.InputPath);
>          for (File file : folder.listFiles()) {
>              try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>                  if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>                      System.out.println();
>                      System.out.println(file.getName());
>                      // Update the file creation date/time if the existing value is older than 3 days
>                      int affected = metadata.updateProperties(new ContainsTagSpecification(Tags.getTime().getCreated()).and(
>                              new OfTypeSpecification(MetadataPropertyType.DateTime)).and(
>                              new UpdatingMetadata().new DateBeforeSpecification(threeDaysAgo)), new PropertyValue(new Date()));
>                      System.out.println(String.format("Affected properties: %s", affected));
>                      metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>                  }
>              }
>          }
>      }
>      // Define your own specifications to filter metadata properties
>      public class DateBeforeSpecification extends Specification {
>          public DateBeforeSpecification(Date date) {
>              setValue(date);
>          }
>
>          public final Date getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Date value) {
>              auto_Value = value;
>          }
>
>          private Date auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              Date date = candidate.getValue().toClass(Date.class);
>              if (date != null) {
>                  return date.before(getValue());
>              }
>              return false;
>          }
>      }
>  }
>
> ```
> ```

[Updating metadata]: https://docs.groupdocs.com/display/metadatajava/Updating+metadata |

**Returns:**
int - The number of affected properties.
##### removeProperties(Specification specification)
```
public final int removeProperties(Specification specification)
```

Removes metadata properties satisfying a specification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition.

This example demonstrates how to remove specific metadata properties using various criteria.

> ```
> ```
>
>  public class RemoveMetadataProperties {
>      public static void run() {
>          // Constants.InputDocx is an absolute or relative path to your document. Ex: @"C:\Docs\source.docx"
>          try (Metadata metadata = new Metadata(Constants.InputDocx)) {
>
>              // Remove all the properties satisfying the predicate:
>              // property contains the name of the document author OR
>              // it refers to the last editor OR
>              // the property value is a string that is equal to the given string "John" (to remove any mentions of John from the detected metadata)
>              int affected = metadata.removeProperties(
>                      new ContainsTagSpecification(Tags.getPerson().getCreator()).or(
>                              new ContainsTagSpecification(Tags.getPerson().getEditor())).or(
>                              new OfTypeSpecification(MetadataPropertyType.String).and(new RemoveMetadataProperties().new WithValueSpecification("John"))));
>
>              System.out.println(String.format("Properties removed: %s", affected));
>
>              metadata.save(Constants.OutputDocx);
>          }
>      }
>
>      // Define your own specifications to filter metadata properties
>      public class WithValueSpecification extends Specification {
>          public WithValueSpecification(Object value) {
>              setValue(value);
>          }
>
>          public final Object getValue() {
>              return auto_Value;
>          }
>
>          private void setValue(Object value) {
>              auto_Value = value;
>          }
>
>          private Object auto_Value;
>
>          public boolean isSatisfiedBy(MetadataProperty candidate) {
>              return candidate.getValue().getRawValue().equals(getValue());
>          }
>      }
>  }
>
> ```
> ```

[Removing metadata]: https://docs.groupdocs.com/display/metadatajava/Removing+metadata |

**Returns:**
int - The number of affected properties.
##### addProperties(Specification specification, PropertyValue value)
```
public final int addProperties(Specification specification, PropertyValue value)
```

Adds known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A value for the picked properties.

This example demonstrates how to add some missing metadata properties to a file regardless of its format.

> ```
> ```
>
>  File folder = new File(Constants.InputPath);
>  for (File file : folder.listFiles()) {
>      try (Metadata metadata = new Metadata(file.getAbsolutePath())) {
>          if (metadata.getFileFormat() != FileFormat.Unknown && !metadata.getDocumentInfo().isEncrypted()) {
>              System.out.println();
>              System.out.println(file.getName());
>              // Add a property containing the file last printing date if it's missing
>              // Note that the property will be added to metadata packages that satisfy the following criteria:
>              // 1) Only existing metadata packages will be affected. No new packages are added during this operation
>              // 2) There should be a known metadata property in the package structure that fits the search condition but is actually missing in the package.
>              // All properties supported by a certain package are usually defined in the specification of a particular metadata standard
>              int affected = metadata.addProperties(new ContainsTagSpecification(Tags.getTime().getPrinted()), new PropertyValue(new Date()));
>              System.out.println(String.format("Affected properties: %s", affected));
>              metadata.save(Constants.OutputPath + "output." + FilenameUtils.getExtension(file.getName()));
>          }
>      }
>  }
>
> ```
> ```

[Adding metadata]: https://docs.groupdocs.com/display/metadatajava/Adding+metadata |

**Returns:**
int - The number of affected properties.
##### setProperties(Specification specification, PropertyValue value)
```
public final int setProperties(Specification specification, PropertyValue value)
```

Sets known metadata properties satisfying the specification. The operation is recursive so it affects all nested packages as well. This method is a combination of  AddProperties  and  UpdateProperties . If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| specification | Specification | A specification to test each metadata property for a condition. |
| value | PropertyValue | A new value for the filtered properties.

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property. It's impossible to set a property with a value having inappropriate type.

This example demonstrates how to set specific metadata properties using different criteria.

> ```
> ```
>
>  // Constants.InputVsdx is an absolute or relative path to your document. Ex: @"C:\Docs\source.vsdx"
>  try (Metadata metadata = new Metadata(Constants.InputVsdx)) {
>      // Set the value of each property that satisfies the predicate:
>      // property contains the date/time the document was created OR modified
>      int affected = metadata.setProperties(
>              new ContainsTagSpecification(Tags.getTime().getCreated()).or(new ContainsTagSpecification(Tags.getTime().getModified())),
>              new PropertyValue(new Date()));
>      System.out.println(String.format("Properties set: %s", affected));
>      metadata.save(Constants.OutputVsdx);
>  }
>
> ```
> ```

[Set metadata properties]: https://docs.groupdocs.com/display/metadatajava/Set+metadata+properties |

**Returns:**
int - The number of affected properties.
##### sanitize()
```
public final int sanitize()
```

Removes writable metadata properties from all detected packages or whole packages if possible. The operation is recursive so it affects all nested packages as well.

**Returns:**
int - The number of affected properties.

This example demonstrates how to remove all detected metadata packages/properties from a file.

> ```
> ```
>
>  // Constants.InputPdf is an absolute or relative path to your document. Ex: @"C:\Docs\source.pdf"
>  try (Metadata metadata = new Metadata(Constants.InputPdf)) {
>      // Remove detected metadata packages
>      int affected = metadata.sanitize();
>      System.out.println(String.format("Properties removed: %s", affected));
>      metadata.save(Constants.OutputPdf);
>  }
>
> ```
> ```

[Clean metadata]: https://docs.groupdocs.com/display/metadatajava/Clean+metadata
##### save()
```
public final void save()
```

Saves all changes made in the loaded document.

This example shows how to save the modified content to the underlying file.

> ```
> ```
>
>  // Constants.InputPpt is an absolute or relative path to your document. Ex: @"C:\Docs\test.ppt"
>  File outputFile = new File(Constants.OutputPpt);
>  outputFile.delete();
>  Files.copy(new File(Constants.InputPpt).toPath(), outputFile.toPath());
>  try (Metadata metadata = new Metadata(Constants.OutputPpt)) {
>      // Edit or remove metadata here
>      // Saves the document to the underlying file
>      metadata.save();
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves the document content into a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | An output stream for the document.

This example shows how to save a document to the specified stream.

> ```
> ```
>
>  try (OutputStream stream = new FileOutputStream(Constants.OutputPng)) {
>      // Constants.InputPng is an absolute or relative path to your document. Ex: @"C:\Docs\test.png"
>      try (Metadata metadata = new Metadata(Constants.InputPng)) {
>          // Edit or remove metadata here
>          metadata.save(stream);
>      }
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves the document content to the specified file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full name of the output file.

This example shows how to save a document to the specified location.

> ```
> ```
>
>  // Constants.InputJpeg is an absolute or relative path to your document. Ex: @"C:\Docs\test.jpg"
>  try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
>      // Edit or remove metadata here
>      metadata.save(Constants.OutputJpeg);
>  }
>
> ```
> ```

[Save a modified file to the original source]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+the+original+source
[Save a modified file to a specified location]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+specified+location
[Save a modified file to a stream]: https://docs.groupdocs.com/display/metadatajava/Save+a+modified+file+to+a+stream |

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Creates preview images for specified pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | A set of options for preview generation.

[Generate document preview]: https://docs.groupdocs.com/display/metadatajava/Generate+document+preview |

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets common information about the loaded document.

**Returns:**
IDocumentInfo - An object representing common document information.

[Get document info]: https://docs.groupdocs.com/display/metadatajava/Get+document+info
##### copyTo(MetadataPackage metadataPackage)
```
public void copyTo(MetadataPackage metadataPackage)
```

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

> ```
> This example demonstrates how to copy metadata properties from source package to destination package.
>
>  Metadata source_metadata = new Metadata(Constants.InputPdf);
>  Metadata destination_metadata = new Metadata(Constants.DestinationPdf);
>  {
>      source_metadata.copyTo(destination_metadata);
>      source_metadata.save();
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage | A destination metadata package.

If the package types do not match, an error will be returned. |

##### copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags)
```
public int copyTo(MetadataPackage metadataPackage, List<PropertyTag> tags)
```

Copy known metadata properties from source package to destination package. The operation is recursive so it affects all nested packages as well. If an existing property its value is updated. If there is a known property missing in a destination package it is added to the package. If there is a known property missing in a source package it is not remove from destination package. If that need, use Sanitize method before.

> ```
> This example demonstrates how to copy metadata properties from source package to destination package.
>
>  Metadata source_metadata = new Metadata(Constants.InputPdf);
>  Metadata destination_metadata = new Metadata(Constants.DestinationPdf);
>  {
>      List<PropertyTag> tags = new ArrayList<PropertyTag>();
>      tags.add(Tags.getPerson().getCreator());
>      source_metadata.copyTo(destination_metadata, tags);
>      source_metadata.save();
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataPackage | MetadataPackage | A destination metadata package. |
| tags | java.util.List<com.groupdocs.metadata.tagging.PropertyTag> | A list of the tags.

If the package types do not match, an error will be returned. |

**Returns:**
int - The number of affected properties.
##### close()
```
public void close()
```

Closes the loaded document and releases any system resources associated with it.

## Python

### GroupDocs.Metadata for Python via .NET
Path: https://reference.groupdocs.com/metadata/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.metadata` | Main GroupDocs.Metadata namespace with top-level API classes. |
| `groupdocs.metadata.common` | Types under `groupdocs.metadata.common`. |
| `groupdocs.metadata.export` | Types under `groupdocs.metadata.export`. |
| `groupdocs.metadata.import_` | Types under `groupdocs.metadata.import_`. |
| `groupdocs.metadata.logging` | Logging hooks and listener interfaces. |
| `groupdocs.metadata.options` | Option classes for configuring conversions and operations. |
| `groupdocs.metadata.tagging` | Types under `groupdocs.metadata.tagging`. |

### groupdocs.metadata.common
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common.md

Types under `groupdocs.metadata.common`.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentInfo` |  |
| `FileType` |  |
| `FileTypePackage` |  |
| `Func` |  |
| `IDocumentInfo` |  |
| `IEnumValueInterpreter` |  |
| `IReadOnlyList` |  |
| `MetadataPackage` |  |
| `MetadataProperty` |  |
| `MetadataPropertyEqualityComparer` |  |
| `PageInfo` |  |
| `PropertyDescriptor` |  |
| `PropertyValue` |  |
| `PropertyValueEqualityComparer` |  |
| `ReadOnlyList` |  |
| `Rectangle` |  |
| `RootMetadataPackage` |  |
| `ValueInterpreter` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ByteOrder` |  |
| `CustomPackage` |  |
| `FileFormat` |  |
| `MetadataPropertyType` |  |
| `MetadataType` |  |
| `PropertyAccessLevels` |  |
| `ValueAcceptor` |  |

### ByteOrder class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/byteorder.md

#### ByteOrder class

The ByteOrder type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN |  |
| BIG_ENDIAN |  |
| LITTLE_ENDIAN |  |

### BIG_ENDIAN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/byteorder/big_endian.md

##### Value
`1`

### LITTLE_ENDIAN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/byteorder/little_endian.md

##### Value
`2`

### UNKNOWN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/byteorder/unknown.md

##### Value
`0`

### CustomPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage.md

#### CustomPackage class

The CustomPackage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _add_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _contains_string |  (inherited from `MetadataPackage`) |
| _find_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _get_enumerator_noargs |  (inherited from `MetadataPackage`) |
| _remove_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _sanitize_noargs |  (inherited from `MetadataPackage`) |
| _set_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _update_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| add_properties |  (inherited from `MetadataPackage`) |
| add_properties_func |  (inherited from `MetadataPackage`) |
| contains |  (inherited from `MetadataPackage`) |
| contains_file |  (inherited from `MetadataPackage`) |
| contains_string |  (inherited from `MetadataPackage`) |
| find_properties |  (inherited from `MetadataPackage`) |
| find_properties_func |  (inherited from `MetadataPackage`) |
| get_enumerator |  (inherited from `MetadataPackage`) |
| remove_properties |  (inherited from `MetadataPackage`) |
| remove_properties_func |  (inherited from `MetadataPackage`) |
| sanitize |  (inherited from `MetadataPackage`) |
| set_properties |  (inherited from `MetadataPackage`) |
| set_properties_func |  (inherited from `MetadataPackage`) |
| update_properties |  (inherited from `MetadataPackage`) |
| update_properties_func |  (inherited from `MetadataPackage`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `MetadataPackage`) |
| item |  (inherited from `MetadataPackage`) |
| keys |  (inherited from `MetadataPackage`) |
| know_property_descriptors |  (inherited from `MetadataPackage`) |
| metadata_type |  (inherited from `MetadataPackage`) |
| property_descriptors |  (inherited from `MetadataPackage`) |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/custompackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DocumentInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo.md

#### DocumentInfo class

The DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| is_encrypted |  |
| page_count |  |
| pages |  |
| size |  |

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### FileFormat class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat.md

#### FileFormat class

The FileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN |  |
| PRESENTATION |  |
| SPREADSHEET |  |
| WORD_PROCESSING |  |
| DIAGRAM |  |
| NOTE |  |
| PROJECT_MANAGEMENT |  |
| PDF |  |
| TIFF |  |
| JPEG |  |
| PSD |  |
| JPEG2000 |  |
| GIF |  |
| PNG |  |
| BMP |  |
| DICOM |  |
| WEB_P |  |
| EMF |  |
| WMF |  |
| DJ_VU |  |
| WAV |  |
| MP3 |  |
| AVI |  |
| FLV |  |
| ASF |  |
| MOV |  |
| MATROSKA |  |
| ZIP |  |
| SEVEN_ZIP |  |
| VCARD |  |
| EPUB |  |
| OPEN_TYPE |  |
| DXF |  |
| DWG |  |
| EML |  |
| MSG |  |
| TORRENT |  |
| HEIF |  |
| DNG |  |
| CR2 |  |
| RAR |  |
| TAR |  |
| THREE_DS |  |
| DAE |  |
| FBX |  |
| STL |  |
| GIS |  |
| FB2 |  |
| MOBI |  |
| OGG |  |
| SVG |  |
| GLTF |  |
| AVIF |  |

### ASF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/asf.md

##### Value
`24`

### AVI field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/avi.md

##### Value
`22`

### AVIF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/avif.md

##### Value
`52`

### BMP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/bmp.md

##### Value
`14`

### CR2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/cr2.md

##### Value
`39`

### DAE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dae.md

##### Value
`43`

### DIAGRAM field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/diagram.md

##### Value
`4`

### DICOM field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dicom.md

##### Value
`15`

### DJ_VU field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dj_vu.md

##### Value
`19`

### DNG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dng.md

##### Value
`38`

### DWG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dwg.md

##### Value
`33`

### DXF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/dxf.md

##### Value
`32`

### EMF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/emf.md

##### Value
`17`

### EML field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/eml.md

##### Value
`34`

### EPUB field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/epub.md

##### Value
`30`

### FB2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/fb2.md

##### Value
`47`

### FBX field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/fbx.md

##### Value
`44`

### FLV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/flv.md

##### Value
`23`

### GIF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/gif.md

##### Value
`12`

### GIS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/gis.md

##### Value
`46`

### GLTF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/gltf.md

##### Value
`51`

### HEIF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/heif.md

##### Value
`37`

### JPEG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/jpeg.md

##### Value
`9`

### JPEG2000 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/jpeg2000.md

##### Value
`11`

### MATROSKA field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/matroska.md

##### Value
`26`

### MOBI field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/mobi.md

##### Value
`48`

### MOV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/mov.md

##### Value
`25`

### MP3 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/mp3.md

##### Value
`21`

### MSG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/msg.md

##### Value
`35`

### NOTE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/note.md

##### Value
`5`

### OGG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/ogg.md

##### Value
`49`

### OPEN_TYPE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/open_type.md

##### Value
`31`

### PDF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/pdf.md

##### Value
`7`

### PNG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/png.md

##### Value
`13`

### PRESENTATION field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/presentation.md

##### Value
`1`

### PROJECT_MANAGEMENT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/project_management.md

##### Value
`6`

### PSD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/psd.md

##### Value
`10`

### RAR field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/rar.md

##### Value
`40`

### SEVEN_ZIP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/seven_zip.md

##### Value
`28`

### SPREADSHEET field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/spreadsheet.md

##### Value
`2`

### STL field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/stl.md

##### Value
`45`

### SVG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/svg.md

##### Value
`50`

### TAR field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/tar.md

##### Value
`41`

### THREE_DS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/three_ds.md

##### Value
`42`

### TIFF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/tiff.md

##### Value
`8`

### TORRENT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/torrent.md

##### Value
`36`

### UNKNOWN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/unknown.md

##### Value
`0`

### VCARD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/vcard.md

##### Value
`29`

### WAV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/wav.md

##### Value
`20`

### WEB_P field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/web_p.md

##### Value
`16`

### WMF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/wmf.md

##### Value
`18`

### WORD_PROCESSING field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/word_processing.md

##### Value
`3`

### ZIP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/fileformat/zip.md

##### Value
`27`

### FileType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype.md

#### FileType class

The FileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| from_extension |  |
| get_supported_file_types |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| extension |  |
| file_format |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### ASF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/asf.md

#### ASF property

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams.
Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA)
is the compressed audio format along with additional metadata in the ASF container developed by Microsoft.
Learn more about this file format
[here](https://wiki.fileformat.com/video/wmv/).
##### Definition:
```python
f ASF 
```

### AVI property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/avi.md

#### AVI property

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft.
Learn more about this file format
[here](https://wiki.fileformat.com/video/avi/).
##### Definition:
```python
f AVI 
```

### BMP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/bmp.md

#### BMP property

Files having extension .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/).
##### Definition:
```python
f BMP 
```

### CBRAR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/cbrar.md

#### CBRAR property

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file,
is a popular format used to store and distribute digital comic books.
It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading.
[here](https://wiki.fileformat.com/compression/cba/).
##### Definition:
```python
f CBRAR 
```

### CBSEVEN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/cbseven.md

#### CBSEVEN property

A CB7 file refers to Comic Book 7-Zip Archive.
It is compressed file format commonly used for storing and distributing comic book collections digitally.
CB7 files are created using 7-Zip compression software, which is known for its high compression ratio.
[here](https://wiki.fileformat.com/compression/cb7/).
##### Definition:
```python
f CBSEVEN 
```

### CBTAR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/cbtar.md

#### CBTAR property

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file,
is a popular format used to store and distribute digital comic books.
It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading.
[here](https://wiki.fileformat.com/compression/cba/).
##### Definition:
```python
f CBTAR 
```

### CBZIP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/cbzip.md

#### CBZIP property

A Comic Book Archive(CBA) file, also known as Comic Book Archive or Comic Book Reader file,
is a popular format used to store and distribute digital comic books.
It typically contains collection of individual comic book pages or images bundled together in single file for easy organization and reading.
[here](https://wiki.fileformat.com/compression/cba/).
##### Definition:
```python
f CBZIP 
```

### CR2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/cr2.md

#### CR2 property

The .CR2 file format (Canon RAW version 2) is a digital photography RAW format created by Canon.
[here](https://wiki.fileformat.com/image/cr2/).
##### Definition:
```python
f CR2 
```

### CRW property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/crw.md

#### CRW property

The .CRW file format is a digital photography RAW format created by Canon.
[here](https://wiki.fileformat.com/image/crw/).
##### Definition:
```python
f CRW 
```

### DAE property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dae.md

#### DAE property

A DAE file is a Digital Asset Exchange file format that is used for exchanging data between interactive 3D applications.
[here](https://wiki.fileformat.com/3d/dae/).
##### Definition:
```python
f DAE 
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### DICOM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dicom.md

#### DICOM property

DICOM is the acronym for Digital Imaging and Communications in Medicine and pertains to the field of Medical Informatics.
DICOM is used for the integration of medical imaging devices like printers, servers,
scanners etc from various vendors and also contains identification data of each patient for uniqueness.
Learn more about this file format
[here](https://docs.fileformat.com/image/dicom/).
##### Definition:
```python
f DICOM 
```

### DJV property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/djv.md

#### DJV 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/).
##### Definition:
```python
f DJV 
```

### DJVU property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/djvu.md

#### DJVU 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/).
##### Definition:
```python
f DJVU 
```

### DNG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dng.md

#### DNG property

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. DNG is an extension of TIFF/EP standard format and uses metadata significantly.
In order to manipulate raw data from digital cameras with the ease of flexibility and artistic control, photographers opt camera raw files.
JPEG and TIFF formats store images that are processed by the camera, therefore, not much room for alteration is available in such formats.
[here](https://wiki.fileformat.com/image/dng/).
##### Definition:
```python
f DNG 
```

### DOC property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/doc.md

#### DOC property

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/).
##### Definition:
```python
f DOC 
```

### DOCM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/docm.md

#### DOCM property

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/).
##### Definition:
```python
f DOCM 
```

### DOCX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/docx.md

#### DOCX property

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/).
##### Definition:
```python
f DOCX 
```

### DOT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dot.md

#### DOT property

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/).
##### Definition:
```python
f DOT 
```

### DOTM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dotm.md

#### DOTM property

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/).
##### Definition:
```python
f DOTM 
```

### DOTX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dotx.md

#### DOTX property

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/).
##### Definition:
```python
f DOTX 
```

### DWG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dwg.md

#### DWG property

Files with DWG extension represent proprietary binary files used for containing 2D and 3D design data.
Learn more about this file format
[here](https://wiki.fileformat.com/cad/dwg/).
##### Definition:
```python
f DWG 
```

### DXF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/dxf.md

#### DXF property

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/).
##### Definition:
```python
f DXF 
```

### EMF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/emf.md

#### EMF property

Enhanced metafile format (EMF) stores graphical images device-independently.
Learn more about this file format
[here](https://wiki.fileformat.com/image/emf/).
##### Definition:
```python
f EMF 
```

### EML property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/eml.md

#### EML property

EML file format represents email messages saved using Outlook and other relevant applications.
Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).
##### Definition:
```python
f EML 
```

### EPUB property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/epub.md

#### EPUB property

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers.
Learn more about this file format
[here](https://wiki.fileformat.com/ebook/epub/).
##### Definition:
```python
f EPUB 
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### FB2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/fb2.md

#### FB2 property

Files with .fb2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
It is based on XML format and contains special tags for describing each element of the book.
It was developed primarily for fictional writings and literature, but is not limited to these only.
The format accommodates all the metadata as well as content in itself and allows flexibility for a number of operations such as automatic processing, indexing, and conversion to other formats.
In short, it focuses on describing the structure of the file instead of specifying its appearance.
Several applications as well as APIs are available to convert FB2 to several other formats on Windows, MacOS, and Linux.
Learn more about this file format [here](https://docs.fileformat.com/ebook/fb2/).
##### Definition:
```python
f FB2 
```

### FBX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/fbx.md

#### FBX property

FBX (Filmbox) is a proprietary file format (.fbx) developed by Kaydara and owned by Autodesk since 2006. It is used to provide interoperability between digital content creation applications. FBX is also part of Autodesk Gameware, a series of video game middleware.
[here](https://wiki.fileformat.com/3d/fbx/).
##### Definition:
```python
f FBX 
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### FLV property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/flv.md

#### FLV property

FLV (Flash Video) is a container file format
which 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/).
##### Definition:
```python
f FLV 
```

### from_extension method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |

**Returns:** FileType

### GEOJSON property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/geojson.md

#### GEOJSON property

GeoJSON is a JSON based format designed to represent the geographical features with their non-spatial attributes.
[here](https://docs.fileformat.com/gis/geojson/).
##### Definition:
```python
f GEOJSON 
```

### get_supported_file_types method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/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/metadata/python-net/groupdocs.metadata.common/filetype/gif.md

#### GIF property

A GIF or Graphical Interchange Format is a type of highly compressed image.
Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).
##### Definition:
```python
f GIF 
```

### GLTF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/gltf.md

#### GLTF property

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. It was adopted for the efficient transmission and loading of 3D scenes and models by applications. glTF was developed by the Khronos Group 3D Formats Working Group and is also described as JPEG of 3D by its creators.
[here](https://wiki.fileformat.com/3d/gltf/).
##### Definition:
```python
f GLTF 
```

### GML property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/gml.md

#### GML property

GML stands for Geography Markup Language that is based on XML specifications developed by the Open Geospatial Consortium (OGC).
[here](https://docs.fileformat.com/gis/gml/).
##### Definition:
```python
f GML 
```

### GPX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/gpx.md

#### GPX property

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.
[here](https://docs.fileformat.com/gis/gpx/).
##### Definition:
```python
f GPX 
```

### HEIC property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/heic.md

#### HEIC property

An HEIC file is a High-Efficiency Container Image file format that can store multiple images as a collection in a single file.
HEIC, like HEIF, are compressed using the High Efficiency Video Coding (HEVC) standard and are smaller in size without compromising the quality.
Learn more about this file format
[here](https://docs.fileformat.com/image/heic/).
##### Definition:
```python
f HEIC 
```

### HEIF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/heif.md

#### HEIF property

An HEIF file is a High-Efficiency Container Image file format that is capable of storing a single image or a sequence of images in a single file.
HEIF file format compresses the images using the High Efficiency Video Coding (HEVC) standard.
Learn more about this file format
[here](https://docs.fileformat.com/image/heif/).
##### Definition:
```python
f HEIF 
```

### J2K property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/j2k.md

#### J2K property

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
[here](https://wiki.fileformat.com/image/j2k/).
##### Definition:
```python
f J2K 
```

### JAR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jar.md

#### JAR property

JAR is a Java Archive file that contains many different application related files as a single file.
This file format was created to reduce the speed of loading a downloaded Java Applet in browser via HTTP transaction,
Learn more about this file format
[here](https://docs.fileformat.com/programming/jar/).
##### Definition:
```python
f JAR 
```

### JP2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jp2.md

#### JP2 property

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
[here](https://wiki.fileformat.com/image/jp2/).
##### Definition:
```python
f JP2 
```

### JPE property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpe.md

#### JPE property

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).
##### Definition:
```python
f JPE 
```

### JPEG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpeg.md

#### JPEG property

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format
[here](https://wiki.fileformat.com/image/jpeg/).
##### Definition:
```python
f JPEG 
```

### JPF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpf.md

#### JPF property

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
[here](https://wiki.fileformat.com/image/jpf/).
##### Definition:
```python
f JPF 
```

### JPG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpg.md

#### JPG property

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).
##### Definition:
```python
f JPG 
```

### JPM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpm.md

#### JPM property

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
[here](https://wiki.fileformat.com/image/jpm/).
##### Definition:
```python
f JPM 
```

### JPX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/jpx.md

#### JPX property

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
[here](https://wiki.fileformat.com/image/jpx/).
##### Definition:
```python
f JPX 
```

### KML property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/kml.md

#### KML property

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.
[here](https://docs.fileformat.com/gis/kml/).
##### Definition:
```python
f KML 
```

### MJ2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mj2.md

#### MJ2 property

Video format defined as Motion JPEG 2000 (Part 3); contains a motion sequence of JPEG 2000 images;
does not involve inter-frame coding, but instead encodes each frame independently using JPEG 2000 compression.
##### Definition:
```python
f MJ2 
```

### MK3D property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mk3d.md

#### MK3D property

MK3D is actually stereoscopic 3D video created using Matroska 3D format.
The MKV file container uses a StereoMode field’s value to define the type of stereoscopic 3D video stuff.
Learn more about this file format
[here](https://docs.fileformat.com/video/mk3d/).
##### Definition:
```python
f MK3D 
```

### MKA property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mka.md

#### MKA property

MKA (Matroska Audio) is the Matroska multimedia container format used for Audio.
The MKA format supports several different kinds of audio compression algorithms such as MP3, AAC and Vobis.
Learn more about this file format
[here](https://docs.fileformat.com/audio/mka/).
##### Definition:
```python
f MKA 
```

### MKV property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mkv.md

#### MKV property

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.
Learn more about this file format
[here](https://wiki.fileformat.com/video/mkv/).
##### Definition:
```python
f MKV 
```

### MOBI property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mobi.md

#### MOBI property

The MOBI file format is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as the proprietary format for Mobipocket Reader. Like EPUB, it is supported by almost all modern e-readers specifically by mobile devices with low bandwidth. The format can be converted to several other formats such as PDF, EPUB, and several other formats using publicly available software applications such as the Kindle app. There are several companies that offer free MOBI books such as Project Gutenberg, Feedbooks, and Open Library.
Learn more about this file format [here](https://docs.fileformat.com/ebook/mobi/).
##### Definition:
```python
f MOBI 
```

### MOV property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mov.md

#### MOV property

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).
##### Definition:
```python
f MOV 
```

### MP3 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mp3.md

#### MP3 property

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://wiki.fileformat.com/audio/mp3/).
##### Definition:
```python
f MP3 
```

### MPP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mpp.md

#### MPP property

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software.
Learn more about this file format
[here](https://wiki.fileformat.com/project-management/mpp/).
##### Definition:
```python
f MPP 
```

### MPT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/mpt.md

#### MPT property

MPT is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software.
Learn more about this file format
[here](https://wiki.fileformat.com/project-management/mpt/).
##### Definition:
```python
f MPT 
```

### MSG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/msg.md

#### MSG property

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/).
##### Definition:
```python
f MSG 
```

### ODS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ods.md

#### ODS property

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
Learn more about this file format
[here](https://wiki.fileformat.com/spreadsheet/ods/).
##### Definition:
```python
f ODS 
```

### ODT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/odt.md

#### ODT property

ODT files are type of documents created with word processing applications that are based on OpenDocument
Text File format. These are created with word processor applications such as free OpenOffice Writer and
can hold content such as text, images, objects and styles. Learn more about this file format
[here](https://wiki.fileformat.com/word-processing/odt/).
##### Definition:
```python
f ODT 
```

### OGG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ogg.md

#### OGG property

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. OGG is a free and open container format that is maintained by Xiph.Org Foundation.
Learn more about this file format [here](https://docs.fileformat.com/audio/ogg/).
##### Definition:
```python
f OGG 
```

### ONE property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/one.md

#### ONE property

File represented by .ONE extension are created by Microsoft OneNote application.
Learn more about this file format
[here](https://wiki.fileformat.com/note-taking/one/).
##### Definition:
```python
f ONE 
```

### OSM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/osm.md

#### OSM property

OpenStreetMap (OSM) is a huge collection of volunteered geographic information stores in different types of files, using different encoding schemes to convert this data into bits and bytes.
[here](https://docs.fileformat.com/gis/osm/).
##### Definition:
```python
f OSM 
```

### OTC property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/otc.md

#### OTC property

OTC (OpenType Collection) is a OpenType font collection format.
An OTC file can combine the multiple font files into it.
##### Definition:
```python
f OTC 
```

### OTF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/otf.md

#### OTF property

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.
Learn more about this file format
[here](https://docs.fileformat.com/font/otf/).
##### Definition:
```python
f OTF 
```

### PDF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/pdf.md

#### PDF property

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://docs.fileformat.com/pdf/).
##### Definition:
```python
f PDF 
```

### PNG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/png.md

#### PNG property

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/png/).
##### Definition:
```python
f PNG 
```

### POT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/pot.md

#### POT property

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions.
Learn more about this file format
[here](https://wiki.fileformat.com/presentation/pot/).
##### Definition:
```python
f POT 
```

### POTM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/potm.md

#### POTM property

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/).
##### Definition:
```python
f POTM 
```

### POTX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/potx.md

#### POTX property

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/).
##### Definition:
```python
f POTX 
```

### PPS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/pps.md

#### PPS property

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/).
##### Definition:
```python
f PPS 
```

### PPSM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ppsm.md

#### PPSM property

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/).
##### Definition:
```python
f PPSM 
```

### PPSX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ppsx.md

#### PPSX property

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/).
##### Definition:
```python
f PPSX 
```

### PPT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ppt.md

#### PPT property

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/).
##### Definition:
```python
f PPT 
```

### PPTM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/pptm.md

#### PPTM property

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/).
##### Definition:
```python
f PPTM 
```

### PPTX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/pptx.md

#### PPTX property

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/).
##### Definition:
```python
f PPTX 
```

### PSD property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/psd.md

#### PSD property

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/).
##### Definition:
```python
f PSD 
```

### QT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/qt.md

#### QT property

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).
##### Definition:
```python
f QT 
```

### RAR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/rar.md

#### RAR property

RAR is a proprietary archive file format that supports data compression, error correction and file spanning.
[here](https://wiki.fileformat.com/compression/rar/).
##### Definition:
```python
f RAR 
```

### SEVENZIP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/sevenzip.md

#### SEVENZIP property

7z is a compressed archive file format that supports several different data compression,
encryption and pre-processing algorithms.
The 7z format initially appeared as implemented by the 7-Zip archiver.
The 7-Zip program is publicly available under the terms of the GNU Lesser General Public License.
[here](https://wiki.fileformat.com/compression/zip/).
##### Definition:
```python
f SEVENZIP 
```

### SHP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/shp.md

#### SHP property

The shapefile format is a geospatial vector data format for geographic information system (GIS) software.
[here](https://docs.fileformat.com/gis/shp/).
##### Definition:
```python
f SHP 
```

### STL property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/stl.md

#### STL property

STL is a file format native to the stereolithography CAD software created by 3D Systems. Chuck Hull, the inventor of stereolithography and 3D Systems’ founder, reports that the file extension is an abbreviation for stereolithography.
[here](https://wiki.fileformat.com/3d/stl/).
##### Definition:
```python
f STL 
```

### SVG property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/svg.md

#### SVG property

An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. The word Scalable refers to the fact that the SVG can be scaled to different sizes without losing any quality. Text-based description of such files makes them independent of resolution. It is one of the most used formats for building a website and print graphics in order to achieve scalability. The format can only be used for two-dimensional graphics though. SVG files can be viewed/opened in almost all modern browsers including Chrome, Internet Explorer, Firefox, and Safari.
Learn more about this file format [here](https://docs.fileformat.com/image/svg/).
##### Definition:
```python
f SVG 
```

### TAR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/tar.md

#### TAR property

In computing, tar is a computer software utility for collecting many files into one archive file, often referred to as a tarball, for distribution or backup purposes.
[here](https://wiki.fileformat.com/compression/tar/).
##### Definition:
```python
f TAR 
```

### THREEDS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/threeds.md

#### THREEDS 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.
[here](https://wiki.fileformat.com/3d/3ds/).
##### Definition:
```python
f THREEDS 
```

### TIF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/tif.md

#### TIF property

TIFF or 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. Learn more about this file format
[here](https://wiki.fileformat.com/image/tiff/).
##### Definition:
```python
f TIF 
```

### TIFF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/tiff.md

#### TIFF property

TIFF or 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. Learn more about this file format
[here](https://wiki.fileformat.com/image/tiff/).
##### Definition:
```python
f TIFF 
```

### to_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TOPOJSON property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/topojson.md

#### TOPOJSON property

TopoJSON is an extension of GeoJSON that encodes topology.
[here](https://docs.fileformat.com/gis/geojson/).
##### Definition:
```python
f TOPOJSON 
```

### TORRENT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/torrent.md

#### TORRENT property

Represents TORRENT file type.
##### Definition:
```python
f TORRENT 
```

### TTC property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ttc.md

#### TTC property

TTC (TrueType Collection) is a TrueType font collection format.
A TTC file can combine the multiple font files into it.
Learn more about this file format
[here](https://docs.fileformat.com/font/ttc/).
##### Definition:
```python
f TTC 
```

### TTF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/ttf.md

#### TTF property

TTF represents font files based on the TrueType specifications font technology.
TrueType fonts provide highest quality display on computer screens and printers without any dependency on resolution.
Learn more about this file format
[here](https://docs.fileformat.com/font/ttf/).
##### Definition:
```python
f TTF 
```

### UNKNOWN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/unknown.md

#### UNKNOWN property

Represents unknown file type.
##### Definition:
```python
f UNKNOWN 
```

### VCF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vcf.md

#### VCF property

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://docs.fileformat.com/email/vcf/).
##### Definition:
```python
f VCF 
```

### VCR property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vcr.md

#### VCR property

VCR (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.
##### Definition:
```python
f VCR 
```

### VDX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vdx.md

#### VDX property

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension.
Learn more about this file format [here](https://wiki.fileformat.com/visio/vdx/).
##### Definition:
```python
f VDX 
```

### VSD property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vsd.md

#### VSD property

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/visio/vsd/).
##### Definition:
```python
f VSD 
```

### VSDX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vsdx.md

#### VSDX property

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft
Office 2013 onwards. Learn more about this file format
[here](https://wiki.fileformat.com/visio/vsdx/).
##### Definition:
```python
f VSDX 
```

### VSS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vss.md

#### VSS property

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/visio/vss/).
##### Definition:
```python
f VSS 
```

### VSX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vsx.md

#### VSX property

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for
creating diagrams in Microsoft Visio. Learn more about this file format
[here](https://wiki.fileformat.com/visio/vsx/).
##### Definition:
```python
f VSX 
```

### VTX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/vtx.md

#### VTX property

Files with .VTX extension refer to Microsoft Visio drawing template that is saved to disc in XML file format.
Learn more about this file format
[here](https://docs.fileformat.com/visio/vtx/).
##### Definition:
```python
f VTX 
```

### WAV property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/wav.md

#### WAV property

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://wiki.fileformat.com/audio/wav/).
##### Definition:
```python
f WAV 
```

### WEBM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/webm.md

#### WEBM property

WEBM 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/).
##### Definition:
```python
f WEBM 
```

### WEBP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/webp.md

#### WEBP property

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/).
##### Definition:
```python
f WEBP 
```

### WMF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/wmf.md

#### WMF property

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/).
##### Definition:
```python
f WMF 
```

### XLS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xls.md

#### XLS property

Files with XLS extension represent 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/specification/spreadsheet/xls/).
##### Definition:
```python
f XLS 
```

### XLSB property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xlsb.md

#### XLSB property

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/specification/spreadsheet/xlsb/).
##### Definition:
```python
f XLSB 
```

### XLSM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xlsm.md

#### XLSM property

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).
##### Definition:
```python
f XLSM 
```

### XLSX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xlsx.md

#### XLSX property

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/specification/spreadsheet/xlsx/).
##### Definition:
```python
f XLSX 
```

### XLT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xlt.md

#### XLT property

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet
application which comes as part of Microsoft Office suite. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).
##### Definition:
```python
f XLT 
```

### XLTM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xltm.md

#### XLTM property

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled
template files. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).
##### Definition:
```python
f XLTM 
```

### XLTX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/xltx.md

#### XLTX property

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML
file format specifications. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).
##### Definition:
```python
f XLTX 
```

### ZIP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/zip.md

#### ZIP property

ZIP file extension represents archives that can hold one or more files or directories.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/zip/).
##### Definition:
```python
f ZIP 
```

### ZIPX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetype/zipx.md

#### ZIPX property

ZIPX is a Zip file in which WinZip has used one or more of its available advanced compression methods.
##### Definition:
```python
f ZIPX 
```

### FileTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage.md

#### FileTypePackage class

The FileTypePackage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _add_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _contains_string |  (inherited from `MetadataPackage`) |
| _find_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _get_enumerator_noargs |  (inherited from `MetadataPackage`) |
| _remove_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _sanitize_noargs |  (inherited from `MetadataPackage`) |
| _set_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _update_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| add_properties |  (inherited from `MetadataPackage`) |
| add_properties_func |  (inherited from `MetadataPackage`) |
| contains |  (inherited from `MetadataPackage`) |
| contains_file |  (inherited from `MetadataPackage`) |
| contains_string |  (inherited from `MetadataPackage`) |
| find_properties |  (inherited from `MetadataPackage`) |
| find_properties_func |  (inherited from `MetadataPackage`) |
| get_enumerator |  (inherited from `MetadataPackage`) |
| remove_properties |  (inherited from `MetadataPackage`) |
| remove_properties_func |  (inherited from `MetadataPackage`) |
| sanitize |  (inherited from `MetadataPackage`) |
| set_properties |  (inherited from `MetadataPackage`) |
| set_properties_func |  (inherited from `MetadataPackage`) |
| update_properties |  (inherited from `MetadataPackage`) |
| update_properties_func |  (inherited from `MetadataPackage`) |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| file_format |  |
| mime_type |  |
| count |  (inherited from `MetadataPackage`) |
| item |  (inherited from `MetadataPackage`) |
| keys |  (inherited from `MetadataPackage`) |
| know_property_descriptors |  (inherited from `MetadataPackage`) |
| metadata_type |  (inherited from `MetadataPackage`) |
| property_descriptors |  (inherited from `MetadataPackage`) |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/mime_type.md

##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/filetypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Func class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func.md

#### Func class

The Func type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_arg_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_arg |  |
| begin_invoke |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_arg_async_callback_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/_begin_invoke_arg_async_callback_object.md

#### _begin_invoke_arg_async_callback_object

```python
def _begin_invoke_arg_async_callback_object(self, arg, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| arg | `Any` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Any

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/_invoke_arg.md

#### _invoke_arg

```python
def _invoke_arg(self, arg):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| arg | `Any` |  |

**Returns:** Any

### begin_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/func/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### IDocumentInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| is_encrypted |  |
| page_count |  |
| pages |  |
| size |  |

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo/is_encrypted.md

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### IEnumValueInterpreter class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ienumvalueinterpreter.md

#### IEnumValueInterpreter class

The IEnumValueInterpreter type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| output_value_range |  |

### output_value_range property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ienumvalueinterpreter/output_value_range.md

##### Definition:
```python
@property
def output_value_range(self):
    ...
```

### IReadOnlyList class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist.md

#### IReadOnlyList class

The IReadOnlyList type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _contains_arg |  |
| _contains_tag_category |  |
| _index_of_arg |  |
| contains |  |
| contains_tag_category |  |
| index_of |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| item |  |

### _contains_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/_contains_arg.md

#### _contains_arg

```python
def _contains_arg(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `Any` |  |

**Returns:** bool

### _contains_tag_category method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/_contains_tag_category.md

#### _contains_tag_category

```python
def _contains_tag_category(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `TagCategory` |  |

**Returns:** bool

### _index_of_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/_index_of_arg.md

#### _index_of_arg

```python
def _index_of_arg(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `Any` |  |

**Returns:** int

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/contains.md

#### contains

```python
def contains(self):
    ...
```

### contains_tag_category method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/contains_tag_category.md

#### contains_tag_category

```python
def contains_tag_category(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/index_of.md

#### index_of

```python
def index_of(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/ireadonlylist/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### MetadataPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage.md

#### MetadataPackage class

The MetadataPackage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _add_properties_func_2_0c75_property_value |  |
| _contains_string |  |
| _find_properties_func_2_0c75 |  |
| _get_enumerator_noargs |  |
| _remove_properties_func_2_0c75 |  |
| _sanitize_noargs |  |
| _set_properties_func_2_0c75_property_value |  |
| _update_properties_func_2_0c75_property_value |  |
| add_properties |  |
| add_properties_func |  |
| contains |  |
| contains_file |  |
| contains_string |  |
| find_properties |  |
| find_properties_func |  |
| get_enumerator |  |
| remove_properties |  |
| remove_properties_func |  |
| sanitize |  |
| set_properties |  |
| set_properties_func |  |
| update_properties |  |
| update_properties_func |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| item |  |
| keys |  |
| know_property_descriptors |  |
| metadata_type |  |
| property_descriptors |  |

### _add_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_add_properties_func_2_0c75_property_value.md

#### _add_properties_func_2_0c75_property_value

```python
def _add_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### _contains_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_contains_string.md

#### _contains_string

```python
def _contains_string(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | `str` |  |

**Returns:** bool

### _find_properties_func_2_0c75 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_find_properties_func_2_0c75.md

#### _find_properties_func_2_0c75

```python
def _find_properties_func_2_0c75(self, predicate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |

**Returns:** List[Any]

### _get_enumerator_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_get_enumerator_noargs.md

#### _get_enumerator_noargs

```python
def _get_enumerator_noargs(self):
    ...
```

**Returns:** Any

### _remove_properties_func_2_0c75 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_remove_properties_func_2_0c75.md

#### _remove_properties_func_2_0c75

```python
def _remove_properties_func_2_0c75(self, predicate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |

**Returns:** int

### _sanitize_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_sanitize_noargs.md

#### _sanitize_noargs

```python
def _sanitize_noargs(self):
    ...
```

**Returns:** int

### _set_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_set_properties_func_2_0c75_property_value.md

#### _set_properties_func_2_0c75_property_value

```python
def _set_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### _update_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/_update_properties_func_2_0c75_property_value.md

#### _update_properties_func_2_0c75_property_value

```python
def _update_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/add_properties.md

#### add_properties

```python
def add_properties(self):
    ...
```

### add_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/add_properties_func.md

#### add_properties_func

```python
def add_properties_func(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/contains.md

#### contains

```python
def contains(self):
    ...
```

### contains_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/contains_file.md

#### contains_file

```python
def contains_file(self):
    ...
```

### contains_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/contains_string.md

#### contains_string

```python
def contains_string(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/find_properties.md

#### find_properties

```python
def find_properties(self):
    ...
```

### find_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/find_properties_func.md

#### find_properties_func

```python
def find_properties_func(self):
    ...
```

### get_enumerator method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/get_enumerator.md

#### get_enumerator

```python
def get_enumerator(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/keys.md

##### Definition:
```python
@property
def keys(self):
    ...
```

### know_property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/know_property_descriptors.md

##### Definition:
```python
@property
def know_property_descriptors(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/metadata_type.md

##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/property_descriptors.md

##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/remove_properties.md

#### remove_properties

```python
def remove_properties(self):
    ...
```

### remove_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/remove_properties_func.md

#### remove_properties_func

```python
def remove_properties_func(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/sanitize.md

#### sanitize

```python
def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/set_properties.md

#### set_properties

```python
def set_properties(self):
    ...
```

### set_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/set_properties_func.md

#### set_properties_func

```python
def set_properties_func(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/update_properties.md

#### update_properties

```python
def update_properties(self):
    ...
```

### update_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapackage/update_properties_func.md

#### update_properties_func

```python
def update_properties_func(self):
    ...
```

### MetadataProperty class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty.md

#### MetadataProperty class

The MetadataProperty type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| descriptor |  |
| interpreted_value |  |
| name |  |
| tags |  |
| value |  |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty/descriptor.md

##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty/interpreted_value.md

##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty/tags.md

##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadataproperty/value.md

##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### MetadataPropertyEqualityComparer class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer.md

#### MetadataPropertyEqualityComparer class

The MetadataPropertyEqualityComparer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_metadata_property_metadata_property |  |
| _get_hash_code_metadata_property |  |
| _init_noargs |  |
| equals |  |
| equals_metadata_property |  |
| get_hash_code |  |
| get_hash_code_metadata_property |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_metadata_property_metadata_property method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/_equals_metadata_property_metadata_property.md

#### _equals_metadata_property_metadata_property

```python
def _equals_metadata_property_metadata_property(self, x, y):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | `MetadataProperty` |  |
| y | `MetadataProperty` |  |

**Returns:** bool

### _get_hash_code_metadata_property method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/_get_hash_code_metadata_property.md

#### _get_hash_code_metadata_property

```python
def _get_hash_code_metadata_property(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `MetadataProperty` |  |

**Returns:** int

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_metadata_property method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/equals_metadata_property.md

#### equals_metadata_property

```python
def equals_metadata_property(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_hash_code_metadata_property method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertyequalitycomparer/get_hash_code_metadata_property.md

#### get_hash_code_metadata_property

```python
def get_hash_code_metadata_property(self):
    ...
```

### MetadataPropertyType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype.md

#### MetadataPropertyType class

The MetadataPropertyType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EMPTY |  |
| STRING |  |
| BOOLEAN |  |
| DATE_TIME |  |
| TIME_SPAN |  |
| INTEGER |  |
| LONG |  |
| DOUBLE |  |
| STRING_ARRAY |  |
| BYTE_ARRAY |  |
| DOUBLE_ARRAY |  |
| INTEGER_ARRAY |  |
| LONG_ARRAY |  |
| METADATA |  |
| METADATA_ARRAY |  |
| GUID |  |
| PROPERTY_VALUE_ARRAY |  |
| OBJECT |  |

### BOOLEAN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/boolean.md

##### Value
`2`

### BYTE_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/byte_array.md

##### Value
`9`

### DATE_TIME field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/date_time.md

##### Value
`3`

### DOUBLE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/double.md

##### Value
`7`

### DOUBLE_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/double_array.md

##### Value
`10`

### EMPTY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/empty.md

##### Value
`0`

### GUID field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/guid.md

##### Value
`15`

### INTEGER field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/integer.md

##### Value
`5`

### INTEGER_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/integer_array.md

##### Value
`11`

### LONG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/long.md

##### Value
`6`

### LONG_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/long_array.md

##### Value
`12`

### METADATA field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/metadata.md

##### Value
`13`

### METADATA_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/metadata_array.md

##### Value
`14`

### OBJECT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/object.md

##### Value
`17`

### PROPERTY_VALUE_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/property_value_array.md

##### Value
`16`

### STRING field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/string.md

##### Value
`1`

### STRING_ARRAY field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/string_array.md

##### Value
`8`

### TIME_SPAN field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatapropertytype/time_span.md

##### Value
`4`

### MetadataType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype.md

#### MetadataType class

The MetadataType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED |  |
| ROOT |  |
| XMP |  |
| EXIF |  |
| IPTC |  |
| DUBLIN_CORE |  |
| IMAGE_RESOURCE_BLOCK |  |
| FILE_FORMAT |  |
| DIGITAL_SIGNATURE |  |
| PRESENTATION |  |
| SPREADSHEET |  |
| WORD_PROCESSING |  |
| DIAGRAM |  |
| NOTE |  |
| PROJECT_MANAGEMENT |  |
| PDF |  |
| DOCUMENT_STATISTICS |  |
| PSD |  |
| JPEG2000 |  |
| DICOM |  |
| BMP |  |
| WAV |  |
| ID3V1 |  |
| ID3V2 |  |
| MPEG_AUDIO |  |
| LYRICS3 |  |
| APE_V2 |  |
| AVI |  |
| FLV |  |
| ASF |  |
| MOV |  |
| MATROSKA |  |
| ZIP |  |
| SEVEN_ZIP |  |
| VCARD |  |
| EPUB |  |
| OPEN_TYPE |  |
| CAD |  |
| EML |  |
| MSG |  |
| TORRENT |  |
| PNG |  |
| DNG |  |
| CR2 |  |
| RAR |  |
| TAR |  |
| THREE_DS |  |
| DAE |  |
| FBX |  |
| STL |  |
| GIS |  |
| FB2 |  |
| MOBI |  |
| OGG |  |
| SVG |  |
| GLTF |  |
| AVIF |  |

### APE_V2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/ape_v2.md

##### Value
`26`

### ASF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/asf.md

##### Value
`29`

### AVI field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/avi.md

##### Value
`27`

### AVIF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/avif.md

##### Value
`56`

### BMP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/bmp.md

##### Value
`20`

### CAD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/cad.md

##### Value
`37`

### CR2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/cr2.md

##### Value
`43`

### DAE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/dae.md

##### Value
`47`

### DIAGRAM field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/diagram.md

##### Value
`12`

### DICOM field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/dicom.md

##### Value
`19`

### DIGITAL_SIGNATURE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/digital_signature.md

##### Value
`8`

### DNG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/dng.md

##### Value
`42`

### DOCUMENT_STATISTICS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/document_statistics.md

##### Value
`16`

### DUBLIN_CORE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/dublin_core.md

##### Value
`5`

### EML field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/eml.md

##### Value
`38`

### EPUB field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/epub.md

##### Value
`35`

### EXIF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/exif.md

##### Value
`3`

### FB2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/fb2.md

##### Value
`51`

### FBX field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/fbx.md

##### Value
`48`

### FILE_FORMAT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/file_format.md

##### Value
`7`

### FLV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/flv.md

##### Value
`28`

### GIS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/gis.md

##### Value
`50`

### GLTF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/gltf.md

##### Value
`55`

### ID3V1 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/id3v1.md

##### Value
`22`

### ID3V2 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/id3v2.md

##### Value
`23`

### IMAGE_RESOURCE_BLOCK field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/image_resource_block.md

##### Value
`6`

### IPTC field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/iptc.md

##### Value
`4`

### JPEG2000 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/jpeg2000.md

##### Value
`18`

### LYRICS3 field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/lyrics3.md

##### Value
`25`

### MATROSKA field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/matroska.md

##### Value
`31`

### MOBI field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/mobi.md

##### Value
`52`

### MOV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/mov.md

##### Value
`30`

### MPEG_AUDIO field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/mpeg_audio.md

##### Value
`24`

### MSG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/msg.md

##### Value
`39`

### NOTE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/note.md

##### Value
`13`

### OGG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/ogg.md

##### Value
`53`

### OPEN_TYPE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/open_type.md

##### Value
`36`

### PDF field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/pdf.md

##### Value
`15`

### PNG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/png.md

##### Value
`41`

### PRESENTATION field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/presentation.md

##### Value
`9`

### PROJECT_MANAGEMENT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/project_management.md

##### Value
`14`

### PSD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/psd.md

##### Value
`17`

### RAR field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/rar.md

##### Value
`44`

### ROOT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/root.md

##### Value
`1`

### SEVEN_ZIP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/seven_zip.md

##### Value
`33`

### SPREADSHEET field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/spreadsheet.md

##### Value
`10`

### STL field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/stl.md

##### Value
`49`

### SVG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/svg.md

##### Value
`54`

### TAR field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/tar.md

##### Value
`45`

### THREE_DS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/three_ds.md

##### Value
`46`

### TORRENT field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/torrent.md

##### Value
`40`

### UNDEFINED field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/undefined.md

##### Value
`0`

### VCARD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/vcard.md

##### Value
`34`

### WAV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/wav.md

##### Value
`21`

### WORD_PROCESSING field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/word_processing.md

##### Value
`11`

### XMP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/xmp.md

##### Value
`2`

### ZIP field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/metadatatype/zip.md

##### Value
`32`

### PageInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/pageinfo.md

#### PageInfo class

The PageInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| page_number |  |
| width |  |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/pageinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/pageinfo/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/pageinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### PropertyAccessLevels class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels.md

#### PropertyAccessLevels class

The PropertyAccessLevels type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| READ |  |
| UPDATE |  |
| REMOVE |  |
| ADD |  |
| ADD_OR_UPDATE |  |
| FULL |  |

### ADD field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/add.md

##### Value
`4`

### ADD_OR_UPDATE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/add_or_update.md

##### Value
`5`

### FULL field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/full.md

##### Value
`7`

### READ field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/read.md

##### Value
`0`

### REMOVE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/remove.md

##### Value
`2`

### UPDATE field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyaccesslevels/update.md

##### Value
`1`

### PropertyDescriptor class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor.md

#### PropertyDescriptor class

The PropertyDescriptor type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| access_level |  |
| interpreter |  |
| name |  |
| tags |  |
| type |  |

### access_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor/access_level.md

##### Definition:
```python
@property
def access_level(self):
    ...
@access_level.setter
def access_level(self, value):
    ...
```

### interpreter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor/interpreter.md

##### Definition:
```python
@property
def interpreter(self):
    ...
@interpreter.setter
def interpreter(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor/tags.md

##### Definition:
```python
@property
def tags(self):
    ...
@tags.setter
def tags(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertydescriptor/type.md

##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### PropertyValue class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue.md

#### PropertyValue class

The PropertyValue type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _accept_value_value_acceptor |  |
| _init_boolean |  |
| _init_byte_array |  |
| _init_date_time |  |
| _init_double |  |
| _init_double_array |  |
| _init_int32 |  |
| _init_int32_array |  |
| _init_int64 |  |
| _init_int64_array |  |
| _init_object |  |
| _init_string |  |
| _init_string_array |  |
| _init_time_span |  |
| _init_uint16_array |  |
| _to_array_noargs |  |
| _to_class_noargs |  |
| _to_string_noargs |  |
| _to_struct_arg |  |
| _to_struct_noargs |  |
| accept_value |  |
| accept_value_value_acceptor |  |
| to_array |  |
| to_class |  |
| to_string |  |
| to_struct |  |

##### Properties
| Property | Description |
| :- | :- |
| raw_value |  |
| type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _accept_value_value_acceptor method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_accept_value_value_acceptor.md

#### _accept_value_value_acceptor

```python
def _accept_value_value_acceptor(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | `ValueAcceptor` |  |

### _init_boolean method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `bool` |  |

### _init_byte_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_byte_array.md

#### _init_byte_array

```python
def _init_byte_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `bytes` |  |

### _init_date_time method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_date_time.md

#### _init_date_time

```python
def _init_date_time(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `datetime` |  |

### _init_double method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_double.md

#### _init_double

```python
def _init_double(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `float` |  |

### _init_double_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_double_array.md

#### _init_double_array

```python
def _init_double_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `List[float]` |  |

### _init_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_int32.md

#### _init_int32

```python
def _init_int32(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

### _init_int32_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_int32_array.md

#### _init_int32_array

```python
def _init_int32_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `List[int]` |  |

### _init_int64 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_int64.md

#### _init_int64

```python
def _init_int64(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

### _init_int64_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_int64_array.md

#### _init_int64_array

```python
def _init_int64_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `List[int]` |  |

### _init_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_object.md

#### _init_object

```python
def _init_object(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `Any` |  |

### _init_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_string.md

#### _init_string

```python
def _init_string(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `str` |  |

### _init_string_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_string_array.md

#### _init_string_array

```python
def _init_string_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `List[str]` |  |

### _init_time_span method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_time_span.md

#### _init_time_span

```python
def _init_time_span(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `timedelta` |  |

### _init_uint16_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_init_uint16_array.md

#### _init_uint16_array

```python
def _init_uint16_array(self, values):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| values | `List[int]` |  |

### _to_array_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_to_array_noargs.md

#### _to_array_noargs

```python
def _to_array_noargs(self):
    ...
```

**Returns:** Any

### _to_class_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_to_class_noargs.md

#### _to_class_noargs

```python
def _to_class_noargs(self):
    ...
```

**Returns:** Any

### _to_string_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### _to_struct_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_to_struct_arg.md

#### _to_struct_arg

```python
def _to_struct_arg(self, default):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| default | `Any` |  |

**Returns:** Any

### _to_struct_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/_to_struct_noargs.md

#### _to_struct_noargs

```python
def _to_struct_noargs(self):
    ...
```

**Returns:** Any

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/accept_value.md

#### accept_value

```python
def accept_value(self):
    ...
```

### accept_value_value_acceptor method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/accept_value_value_acceptor.md

#### accept_value_value_acceptor

```python
def accept_value_value_acceptor(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/raw_value.md

##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### to_array method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/to_array.md

#### to_array

```python
def to_array(self):
    ...
```

### to_class method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/to_class.md

#### to_class

```python
def to_class(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### to_struct method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/to_struct.md

#### to_struct

```python
def to_struct(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalue/type.md

##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### PropertyValueEqualityComparer class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer.md

#### PropertyValueEqualityComparer class

The PropertyValueEqualityComparer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_property_value_property_value |  |
| _get_hash_code_property_value |  |
| _init_noargs |  |
| equals |  |
| equals_property_value |  |
| get_hash_code |  |
| get_hash_code_property_value |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_property_value_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/_equals_property_value_property_value.md

#### _equals_property_value_property_value

```python
def _equals_property_value_property_value(self, x, y):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | `PropertyValue` |  |
| y | `PropertyValue` |  |

**Returns:** bool

### _get_hash_code_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/_get_hash_code_property_value.md

#### _get_hash_code_property_value

```python
def _get_hash_code_property_value(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `PropertyValue` |  |

**Returns:** int

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/equals_property_value.md

#### equals_property_value

```python
def equals_property_value(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_hash_code_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/propertyvalueequalitycomparer/get_hash_code_property_value.md

#### get_hash_code_property_value

```python
def get_hash_code_property_value(self):
    ...
```

### ReadOnlyList class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist.md

#### ReadOnlyList class

The ReadOnlyList type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _contains_arg |  |
| _contains_tag_category |  |
| _get_enumerator_noargs |  |
| _index_of_arg |  |
| contains |  |
| contains_tag_category |  |
| get_enumerator |  |
| index_of |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| is_read_only |  |
| item |  |

### _contains_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/_contains_arg.md

#### _contains_arg

```python
def _contains_arg(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `Any` |  |

**Returns:** bool

### _contains_tag_category method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/_contains_tag_category.md

#### _contains_tag_category

```python
def _contains_tag_category(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `TagCategory` |  |

**Returns:** bool

### _get_enumerator_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/_get_enumerator_noargs.md

#### _get_enumerator_noargs

```python
def _get_enumerator_noargs(self):
    ...
```

**Returns:** Any

### _index_of_arg method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/_index_of_arg.md

#### _index_of_arg

```python
def _index_of_arg(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item | `Any` |  |

**Returns:** int

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/contains.md

#### contains

```python
def contains(self):
    ...
```

### contains_tag_category method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/contains_tag_category.md

#### contains_tag_category

```python
def contains_tag_category(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### get_enumerator method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/get_enumerator.md

#### get_enumerator

```python
def get_enumerator(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/index_of.md

#### index_of

```python
def index_of(self):
    ...
```

### is_read_only property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/is_read_only.md

##### Definition:
```python
@property
def is_read_only(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/readonlylist/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### Rectangle class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle.md

#### Rectangle class

The Rectangle type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| bottom |  |
| height |  |
| is_empty |  |
| left |  |
| right |  |
| top |  |
| width |  |
| x |  |
| y |  |

### Rectangle constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/__init__.md

#### \_\_init\_\_(self)

Constructs a new instance of Rectangle

```python

def __init__(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### bottom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/bottom.md

##### Definition:
```python
@property
def bottom(self):
    ...
```

### empty property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/empty.md

#### empty property

Gets the empty rectangle.
##### Definition:
```python
@property
def empty(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### is_empty property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/is_empty.md

##### Definition:
```python
@property
def is_empty(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/left.md

##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/right.md

##### Definition:
```python
@property
def right(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/top.md

##### Definition:
```python
@property
def top(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/x.md

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rectangle/y.md

##### Definition:
```python
@property
def y(self):
    ...
```

### RootMetadataPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage.md

#### RootMetadataPackage class

The RootMetadataPackage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _sanitize_noargs |  |
| sanitize |  |
| _add_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _contains_string |  (inherited from `MetadataPackage`) |
| _find_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _get_enumerator_noargs |  (inherited from `MetadataPackage`) |
| _remove_properties_func_2_0c75 |  (inherited from `MetadataPackage`) |
| _set_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| _update_properties_func_2_0c75_property_value |  (inherited from `MetadataPackage`) |
| add_properties |  (inherited from `MetadataPackage`) |
| add_properties_func |  (inherited from `MetadataPackage`) |
| contains |  (inherited from `MetadataPackage`) |
| contains_file |  (inherited from `MetadataPackage`) |
| contains_string |  (inherited from `MetadataPackage`) |
| find_properties |  (inherited from `MetadataPackage`) |
| find_properties_func |  (inherited from `MetadataPackage`) |
| get_enumerator |  (inherited from `MetadataPackage`) |
| remove_properties |  (inherited from `MetadataPackage`) |
| remove_properties_func |  (inherited from `MetadataPackage`) |
| set_properties |  (inherited from `MetadataPackage`) |
| set_properties_func |  (inherited from `MetadataPackage`) |
| update_properties |  (inherited from `MetadataPackage`) |
| update_properties_func |  (inherited from `MetadataPackage`) |

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| count |  (inherited from `MetadataPackage`) |
| item |  (inherited from `MetadataPackage`) |
| keys |  (inherited from `MetadataPackage`) |
| know_property_descriptors |  (inherited from `MetadataPackage`) |
| metadata_type |  (inherited from `MetadataPackage`) |
| property_descriptors |  (inherited from `MetadataPackage`) |

### _sanitize_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/_sanitize_noargs.md

#### _sanitize_noargs

```python
def _sanitize_noargs(self):
    ...
```

**Returns:** int

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/sanitize.md

#### sanitize

```python
def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/rootmetadatapackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ValueAcceptor class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueacceptor.md

#### ValueAcceptor class

The ValueAcceptor type exposes the following members:

### ValueInterpreter class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter.md

#### ValueInterpreter class

The ValueInterpreter type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_interpreted_value_property_value |  |
| _to_source_value_property_value |  |
| to_interpreted_value |  |
| to_interpreted_value_property_value |  |
| to_source_value |  |
| to_source_value_property_value |  |

##### Properties
| Property | Description |
| :- | :- |
| interpreted_value_type |  |

### _to_interpreted_value_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/_to_interpreted_value_property_value.md

#### _to_interpreted_value_property_value

```python
def _to_interpreted_value_property_value(self, original_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| original_value | `PropertyValue` |  |

**Returns:** PropertyValue

### _to_source_value_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/_to_source_value_property_value.md

#### _to_source_value_property_value

```python
def _to_source_value_property_value(self, interpreted_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| interpreted_value | `PropertyValue` |  |

**Returns:** PropertyValue

### interpreted_value_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/interpreted_value_type.md

##### Definition:
```python
@property
def interpreted_value_type(self):
    ...
```

### to_interpreted_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/to_interpreted_value.md

#### to_interpreted_value

```python
def to_interpreted_value(self):
    ...
```

### to_interpreted_value_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/to_interpreted_value_property_value.md

#### to_interpreted_value_property_value

```python
def to_interpreted_value_property_value(self):
    ...
```

### to_source_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/to_source_value.md

#### to_source_value

```python
def to_source_value(self):
    ...
```

### to_source_value_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.common/valueinterpreter/to_source_value_property_value.md

#### to_source_value_property_value

```python
def to_source_value_property_value(self):
    ...
```

### groupdocs.metadata.exceptions
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions.md

The namespace contains some specific exceptions that are thrown by the library during file reading and updating.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentProtectedException` | The exception that is thrown when document is protected by password. |
| `GroupDocsMetadataException` | Represents a product-specific exception that is thrown during file processing. |
| `InvalidFormatException` | The exception that is thrown when a file has an invalid format. |
| `MetadataValidationException` | The exception that is thrown when validation errors encountered during metadata saving. |
| `XmpException` | The exception that is thrown when XMP has invalid structure. |

### DocumentProtectedException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/documentprotectedexception.md

#### DocumentProtectedException class

The exception that is thrown when document is protected by password.

**Inheritance:** `DocumentProtectedException` →
`GroupDocsMetadataException`

The DocumentProtectedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `DocumentProtectedException` class. |

### DocumentProtectedException constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/documentprotectedexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `DocumentProtectedException` class.

```python

def __init__(self):
    ...
```

### GroupDocsMetadataException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/groupdocsmetadataexception.md

#### GroupDocsMetadataException class

Represents a product-specific exception that is thrown during file processing.

The GroupDocsMetadataException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `GroupDocsMetadataException` class. |
| `__init__(self, message)` | Initializes a new instance of the `GroupDocsMetadataException` class. |

### GroupDocsMetadataException constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/groupdocsmetadataexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `GroupDocsMetadataException` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, message)

Initializes a new instance of the `GroupDocsMetadataException` class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### InvalidFormatException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/invalidformatexception.md

#### InvalidFormatException class

The exception that is thrown when a file has an invalid format.

**Inheritance:** `InvalidFormatException` →
`GroupDocsMetadataException`

The InvalidFormatException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `InvalidFormatException` class. |
| `__init__(self, message)` | Initializes a new instance of the `InvalidFormatException` class. |

### InvalidFormatException constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/invalidformatexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `InvalidFormatException` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, message)

Initializes a new instance of the `InvalidFormatException` class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### MetadataValidationException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/metadatavalidationexception.md

#### MetadataValidationException class

The exception that is thrown when validation errors encountered during metadata saving.

**Inheritance:** `MetadataValidationException` →
`GroupDocsMetadataException`

The MetadataValidationException type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| errors | Gets an array of the validation errors that were encountered during the last metadata saving. |

### errors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/metadatavalidationexception/errors.md

#### errors property

Gets an array of the validation errors that were encountered during the last metadata saving.
##### Definition:
```python
@property
def errors(self):
    ...
```

### XmpException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/xmpexception.md

#### XmpException class

The exception that is thrown when XMP has invalid structure.

**Inheritance:** `XmpException` →
`GroupDocsMetadataException`

The XmpException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpException` class. |
| `__init__(self, message)` | Initializes a new instance of the `XmpException` class. |

### XmpException constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.exceptions/xmpexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpException` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, message)

Initializes a new instance of the `XmpException` class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message. |

### groupdocs.metadata.export
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export.md

Types under `groupdocs.metadata.export`.

##### Classes
| Class | Description |
| :- | :- |
| `CsvExportOptions` |  |
| `ExcelExportOptions` |  |
| `ExportManager` |  |
| `ExportOptions` |  |
| `JsonExportOptions` |  |
| `XmlExportOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ExportFormat` |  |

### CsvExportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/csvexportoptions.md

#### CsvExportOptions class

The CsvExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/csvexportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/csvexportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### ExcelExportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/excelexportoptions.md

#### ExcelExportOptions class

The ExcelExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| group_cells |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/excelexportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/excelexportoptions/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, group_cells):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| group_cells | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/excelexportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### group_cells property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/excelexportoptions/group_cells.md

##### Definition:
```python
@property
def group_cells(self):
    ...
@group_cells.setter
def group_cells(self, value):
    ...
```

### ExportFormat class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat.md

#### ExportFormat class

The ExportFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| XLS |  |
| XLSX |  |
| XML |  |
| CSV |  |
| JSON |  |

### CSV field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat/csv.md

##### Value
`3`

### JSON field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat/json.md

##### Value
`4`

### XLS field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat/xls.md

##### Value
`0`

### XLSX field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat/xlsx.md

##### Value
`1`

### XML field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportformat/xml.md

##### Value
`2`

### ExportManager class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager.md

#### ExportManager class

The ExportManager type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _export_stream_export_format |  |
| _export_stream_export_format_export_options |  |
| _export_string_export_format |  |
| _export_string_export_format_export_options |  |
| _init_ienumerable_1_66b9 |  |
| export |  |
| export_file |  |
| export_stream |  |
| export_streams |  |
| export_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _export_stream_export_format method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/_export_stream_export_format.md

#### _export_stream_export_format

```python
def _export_stream_export_format(self, document, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| format | `ExportFormat` |  |

### _export_stream_export_format_export_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/_export_stream_export_format_export_options.md

#### _export_stream_export_format_export_options

```python
def _export_stream_export_format_export_options(self, document, format, export_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| format | `ExportFormat` |  |
| export_options | `ExportOptions` |  |

### _export_string_export_format method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/_export_string_export_format.md

#### _export_string_export_format

```python
def _export_string_export_format(self, file_path, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| format | `ExportFormat` |  |

### _export_string_export_format_export_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/_export_string_export_format_export_options.md

#### _export_string_export_format_export_options

```python
def _export_string_export_format_export_options(self, file_path, format, export_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| format | `ExportFormat` |  |
| export_options | `ExportOptions` |  |

### _init_ienumerable_1_66b9 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/_init_ienumerable_1_66b9.md

#### _init_ienumerable_1_66b9

```python
def _init_ienumerable_1_66b9(self, properties):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| properties | `List[Any]` |  |

### export method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/export.md

#### export

```python
def export(self):
    ...
```

### export_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/export_file.md

#### export_file

```python
def export_file(self):
    ...
```

### export_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/export_stream.md

#### export_stream

```python
def export_stream(self):
    ...
```

### export_streams method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/export_streams.md

#### export_streams

```python
def export_streams(self):
    ...
```

### export_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportmanager/export_string.md

#### export_string

```python
def export_string(self):
    ...
```

### ExportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportoptions.md

#### ExportOptions class

The ExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/exportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### JsonExportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/jsonexportoptions.md

#### JsonExportOptions class

The JsonExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/jsonexportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/jsonexportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### XmlExportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/xmlexportoptions.md

#### XmlExportOptions class

The XmlExportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/xmlexportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.export/xmlexportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### groupdocs.metadata.formats.archive
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive.md

The namespace contains classes for working with archive formats.

##### Classes
| Class | Description |
| :- | :- |
| `RarFile` | Represents metadata associated with an archived file or directory. |
| `RarPackage` | Represents ZIP archive metadata. |
| `RarRootPackage` | Represents the root package allowing working with metadata in a ZIP archive. |
| `SevenZipFile` | Represents metadata associated with an archived file or directory. |
| `SevenZipPackage` | Represents ZIP archive metadata. |
| `SevenZipRootPackage` | Represents the root package allowing working with metadata in a ZIP archive. |
| `TarFile` | Represents metadata associated with an archived file or directory. |
| `TarPackage` | Represents ZIP archive metadata. |
| `TarRootPackage` | Represents the root package allowing working with metadata in a ZIP archive. |
| `ZipFile` | Represents metadata associated with an archived file or directory. |
| `ZipPackage` | Represents ZIP archive metadata. |
| `ZipRootPackage` | Represents the root package allowing working with metadata in a ZIP archive. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ZipCompressionMethod` | Defines ZIP compression methods. |

### RarFile class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile.md

#### RarFile class

Represents metadata associated with an archived file or directory.

**Inheritance:** `RarFile` →
`CustomPackage` →
`MetadataPackage`

The RarFile type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| compressed_size | Gets the compressed size in bytes. |
| uncompressed_size | Gets the uncompressed size in bytes. |
| name | Gets the entry name. |
| modification_date_time | Gets the last modification date and time. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### compressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/compressed_size.md

#### compressed_size property

Gets the compressed size in bytes.
##### Definition:
```python
@property
def compressed_size(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modification_date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/modification_date_time.md

#### modification_date_time property

Gets the last modification date and time.
##### Definition:
```python
@property
def modification_date_time(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/name.md

#### name property

Gets the entry name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### uncompressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/uncompressed_size.md

#### uncompressed_size property

Gets the uncompressed size in bytes.
##### Definition:
```python
@property
def uncompressed_size(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarfile/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RarPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage.md

#### RarPackage class

Represents ZIP archive metadata.

**Inheritance:** `RarPackage` →
`CustomPackage` →
`MetadataPackage`

The RarPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| files | Gets an array of `ZipFile` entries inside the ZIP archive. |
| total_entries | Gets the total number of entries inside the ZIP archive. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/files.md

#### files property

Gets an array of `ZipFile` entries inside the ZIP archive.
##### Definition:
```python
@property
def files(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### total_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/total_entries.md

#### total_entries property

Gets the total number of entries inside the ZIP archive.
##### Definition:
```python
@property
def total_entries(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RarRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage.md

#### RarRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

**Inheritance:** `RarRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The RarRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| rar_package | Gets the ZIP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### rar_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/rar_package.md

#### rar_package property

Gets the ZIP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def rar_package(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/rarrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SevenZipFile class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile.md

#### SevenZipFile class

Represents metadata associated with an archived file or directory.

**Inheritance:** `SevenZipFile` →
`CustomPackage` →
`MetadataPackage`

The SevenZipFile type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| compressed_size | Gets the compressed size in bytes. |
| uncompressed_size | Gets the uncompressed size in bytes. |
| name | Gets the entry name. |
| modification_date_time | Gets the last modification date and time. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### compressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/compressed_size.md

#### compressed_size property

Gets the compressed size in bytes.
##### Definition:
```python
@property
def compressed_size(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modification_date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/modification_date_time.md

#### modification_date_time property

Gets the last modification date and time.
##### Definition:
```python
@property
def modification_date_time(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/name.md

#### name property

Gets the entry name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### uncompressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/uncompressed_size.md

#### uncompressed_size property

Gets the uncompressed size in bytes.
##### Definition:
```python
@property
def uncompressed_size(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzipfile/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SevenZipPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage.md

#### SevenZipPackage class

Represents ZIP archive metadata.

**Inheritance:** `SevenZipPackage` →
`CustomPackage` →
`MetadataPackage`

The SevenZipPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| files | Gets an array of `ZipFile` entries inside the ZIP archive. |
| total_entries | Gets the total number of entries inside the ZIP archive. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/files.md

#### files property

Gets an array of `ZipFile` entries inside the ZIP archive.
##### Definition:
```python
@property
def files(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### total_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/total_entries.md

#### total_entries property

Gets the total number of entries inside the ZIP archive.
##### Definition:
```python
@property
def total_entries(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenzippackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SevenZipRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage.md

#### SevenZipRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

**Inheritance:** `SevenZipRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The SevenZipRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| seven_zip_package | Gets the ZIP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### seven_zip_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/seven_zip_package.md

#### seven_zip_package property

Gets the ZIP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def seven_zip_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/sevenziprootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### TarFile class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile.md

#### TarFile class

Represents metadata associated with an archived file or directory.

**Inheritance:** `TarFile` →
`CustomPackage` →
`MetadataPackage`

The TarFile type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| size | Gets the size in bytes. |
| name | Gets the entry name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/name.md

#### name property

Gets the entry name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/size.md

#### size property

Gets the size in bytes.
##### Definition:
```python
@property
def size(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarfile/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### TarPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage.md

#### TarPackage class

Represents ZIP archive metadata.

**Inheritance:** `TarPackage` →
`CustomPackage` →
`MetadataPackage`

The TarPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| files | Gets an array of `ZipFile` entries inside the ZIP archive. |
| total_entries | Gets the total number of entries inside the ZIP archive. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/files.md

#### files property

Gets an array of `ZipFile` entries inside the ZIP archive.
##### Definition:
```python
@property
def files(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### total_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/total_entries.md

#### total_entries property

Gets the total number of entries inside the ZIP archive.
##### Definition:
```python
@property
def total_entries(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### TarRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage.md

#### TarRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

**Inheritance:** `TarRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The TarRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| tar_package | Gets the ZIP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### tar_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/tar_package.md

#### tar_package property

Gets the ZIP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def tar_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/tarrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ZipCompressionMethod enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipcompressionmethod.md

#### ZipCompressionMethod enumeration

Defines ZIP compression methods.

The ZipCompressionMethod type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NO_COMPRESSION | The file is stored (no compression). |
| SHRUNK | The file is Shrunk. |
| IMPLODED | The file is Imploded. |
| RESERVED | A reserved compression method. |
| DEFLATED | The file is Deflated. |
| B_ZIP2 | The file is compressed with the BZip2 algorithm. |
| LZMA | The Lempel-Ziv-Markov chain-Algorithm. |

### ZipFile class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile.md

#### ZipFile class

Represents metadata associated with an archived file or directory.

**Inheritance:** `ZipFile` →
`CustomPackage` →
`MetadataPackage`

The ZipFile type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| compression_method | Gets the compression method. |
| compressed_size | Gets the compressed size in bytes. |
| uncompressed_size | Gets the uncompressed size in bytes. |
| flags | Gets the ZIP entry flags. |
| name | Gets the entry name. |
| raw_name | Gets an array of bytes representing the name of the entry. |
| modification_date_time | Gets the last modification date and time. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### compressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/compressed_size.md

#### compressed_size property

Gets the compressed size in bytes.
##### Definition:
```python
@property
def compressed_size(self):
    ...
```

### compression_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/compression_method.md

#### compression_method property

Gets the compression method.
##### Definition:
```python
@property
def compression_method(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/flags.md

#### flags property

Gets the ZIP entry flags.

##### Remarks

Bit 00: encrypted file.

Bit 01: compression option.

Bit 02: compression option.

Bit 03: data descriptor.

Bit 04: enhanced deflation.

Bit 05: compressed patched data.

Bit 06: strong encryption.

Bit 07-10: unused.

Bit 11: language encoding.

Bit 12: reserved.

Bit 13: mask header values.

Bit 14-15: reserved.
##### Definition:
```python
@property
def flags(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modification_date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/modification_date_time.md

#### modification_date_time property

Gets the last modification date and time.
##### Definition:
```python
@property
def modification_date_time(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/name.md

#### name property

Gets the entry name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/raw_name.md

#### raw_name property

Gets an array of bytes representing the name of the entry.
##### Definition:
```python
@property
def raw_name(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### uncompressed_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/uncompressed_size.md

#### uncompressed_size property

Gets the uncompressed size in bytes.
##### Definition:
```python
@property
def uncompressed_size(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zipfile/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ZipPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage.md

#### ZipPackage class

Represents ZIP archive metadata.

**Inheritance:** `ZipPackage` →
`CustomPackage` →
`MetadataPackage`

The ZipPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comment | Gets or sets the ZIP archive comment created by a user. |
| files | Gets an array of `ZipFile` entries inside the ZIP archive. |
| total_entries | Gets the total number of entries inside the ZIP archive. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/comment.md

#### comment property

Gets or sets the ZIP archive comment created by a user.

##### Example

The following code snippet shows how to remove the user comment from a ZIP archive.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/files.md

#### files property

Gets an array of `ZipFile` entries inside the ZIP archive.
##### Definition:
```python
@property
def files(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### total_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/total_entries.md

#### total_entries property

Gets the total number of entries inside the ZIP archive.
##### Definition:
```python
@property
def total_entries(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/zippackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ZipRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage.md

#### ZipRootPackage class

Represents the root package allowing working with metadata in a ZIP archive.

**Inheritance:** `ZipRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The ZipRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| zip_package | Gets the ZIP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a ZIP archive.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### zip_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.archive/ziprootpackage/zip_package.md

#### zip_package property

Gets the ZIP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def zip_package(self):
    ...
```

### groupdocs.metadata.formats.audio.ogg
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg.md

##### Classes
| Class | Description |
| :- | :- |
| `OggPackage` | Represents a native metadata package in a OGG audio file. |
| `OggRootPackage` | Represents a native metadata package in a OGG audio file. |
| `OggUserComment` | Represents Ogg User Comment metadata class. |

### OggPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage.md

#### OggPackage class

Represents a native metadata package in a OGG audio file.

**Inheritance:** `OggPackage` →
`CustomPackage` →
`MetadataPackage`

The OggPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `OggPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| vendor | Vendor |
| title | Track/Work name |
| version | The version field may be used to differentiate multiple versions of the same track title in a single collection. (e.g. remix info) |
| album | The collection name to which this track belongs |
| tracknumber | The track number of this piece if part of a specific larger collection or album |
| artist | The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text. |
| performer | The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted. |
| copyright | Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt' |
| license | License information, for example, 'All Rights Reserved', 'Any Use Permitted', a URL to a license such as a Creative Commons license (e.g. "creativecommons.org/licenses/by/4.0/"), or similar. |
| organization | Name of the organization producing the track (i.e. the 'record label') |
| description | A short text description of the contents |
| genre | A short text indication of music genre |
| date | Date the track was recorded |
| location | Location where track was recorded |
| contact | Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label. |
| isrc | ISRC number for the track |
| ogg_user_comments | Gets an array of `OggUserComment` entries inside the metadata. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract technical audio information from a OGG file.

### OggPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `OggPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/album.md

#### album property

The collection name to which this track belongs
##### Definition:
```python
@property
def album(self):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/artist.md

#### artist property

The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
##### Definition:
```python
@property
def artist(self):
    ...
```

### contact property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/contact.md

#### contact property

Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
##### Definition:
```python
@property
def contact(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/copyright.md

#### copyright property

Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/date.md

#### date property

Date the track was recorded
##### Definition:
```python
@property
def date(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/description.md

#### description property

A short text description of the contents
##### Definition:
```python
@property
def description(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/genre.md

#### genre property

A short text indication of music genre
##### Definition:
```python
@property
def genre(self):
    ...
```

### isrc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/isrc.md

#### isrc property

ISRC number for the track
##### Definition:
```python
@property
def isrc(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### license property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/license.md

#### license property

License information, for example, 'All Rights Reserved', 'Any Use Permitted', a URL to a license such as a Creative Commons license (e.g. "creativecommons.org/licenses/by/4.0/"), or similar.
##### Definition:
```python
@property
def license(self):
    ...
```

### location property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/location.md

#### location property

Location where track was recorded
##### Definition:
```python
@property
def location(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### ogg_user_comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/ogg_user_comments.md

#### ogg_user_comments property

Gets an array of `OggUserComment` entries inside the metadata.
##### Definition:
```python
@property
def ogg_user_comments(self):
    ...
```

### organization property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/organization.md

#### organization property

Name of the organization producing the track (i.e. the 'record label')
##### Definition:
```python
@property
def organization(self):
    ...
```

### performer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/performer.md

#### performer property

The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
##### Definition:
```python
@property
def performer(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/title.md

#### title property

Track/Work name
##### Definition:
```python
@property
def title(self):
    ...
```

### tracknumber property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/tracknumber.md

#### tracknumber property

The track number of this piece if part of a specific larger collection or album
##### Definition:
```python
@property
def tracknumber(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### vendor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/vendor.md

#### vendor property

Vendor
##### Definition:
```python
@property
def vendor(self):
    ...
```

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggpackage/version.md

#### version property

The version field may be used to differentiate multiple versions of the same track title in a single collection. (e.g. remix info)
##### Definition:
```python
@property
def version(self):
    ...
```

### OggRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage.md

#### OggRootPackage class

Represents a native metadata package in a OGG audio file.

**Inheritance:** `OggRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The OggRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| ogg_package | Gets the Ogg native metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract technical audio information from a OGG file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### ogg_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/ogg_package.md

#### ogg_package property

Gets the Ogg native metadata package.
##### Definition:
```python
@property
def ogg_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### OggUserComment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment.md

#### OggUserComment class

Represents Ogg User Comment metadata class.

**Inheritance:** `OggUserComment` →
`CustomPackage` →
`MetadataPackage`

The OggUserComment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| header | Gets the user comments header |
| value | Gets the user comments value |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/header.md

#### header property

Gets the user comments header
##### Definition:
```python
@property
def header(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.ogg/oggusercomment/value.md

#### value property

Gets the user comments value
##### Definition:
```python
@property
def value(self):
    ...
```

### groupdocs.metadata.formats.audio
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio.md

The namespace provides classes intended to work with different audio formats.

##### Classes
| Class | Description |
| :- | :- |
| `ApePackage` | Represents an APE v2 metadata package.
<br/>Please find more information at [http://wiki.hydrogenaud.io/index.php?title=APE_key](http://wiki.hydrogenaud.io/index.php?title=APE_key). |
| `ID3Tag` | Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags. |
| `ID3V1Tag` | Represents an ID3v1 tag.
<br/>Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v1](https://en.wikipedia.org/wiki/ID3#ID3v1). |
| `ID3V2AttachedPictureFrame` | Represents an APIC frame in an `ID3V2Tag`. |
| `ID3V2CommentFrame` | Represents a COMM frame in an `ID3V2Tag`. |
| `ID3V2MlltFrame` | Represents an MLLT frame in an `ID3V2Tag`. |
| `ID3V2PlayCounterFrame` | Represents a PCNT frame in an `ID3V2Tag`.
<br/>This is simply a counter of the number of times a file has been played. |
| `ID3V2PrivateFrame` | Represents a PRIV frame in an `ID3V2Tag`.
<br/>The frame is used to contain information from a software producer that its program uses
<br/>and does not fit into the other frames. |
| `ID3V2Tag` | Represents an ID3v2 tag.
<br/>Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v2](https://en.wikipedia.org/wiki/ID3#ID3v2). |
| `ID3V2TagFrame` | Represents a generic frame in an `ID3V2Tag`. |
| `ID3V2TagFrameFlags` | Represents flags used in a ID3v2 tag frame. |
| `ID3V2TextFrame` | Represents a text frame in an `ID3V2Tag`.
<br/>Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the `ID3V2UserDefinedFrame` class. |
| `ID3V2UrlLinkFrame` | Represents a URL link frame in an `ID3V2Tag`. Name of the frame always starts with the W character. |
| `ID3V2UserDefinedFrame` | Represents a TXXX frame in an `ID3V2Tag`. |
| `ID3V2UserDefinedUrlLinkFrame` | Represents a WXXX frame in an `ID3V2Tag`. |
| `LyricsField` | Represents a `LyricsTag` field. |
| `LyricsTag` | Represents Lyrics3 v2.00 metadata.
<br/>Please find more information at [http://id3.org/Lyrics3v2](). |
| `MP3RootPackage` | Represents the root package allowing working with metadata in an MP3 audio. |
| `WavPackage` | Represents a native metadata package in a WAV audio file. |
| `WavRootPackage` | Represents the root package allowing working with metadata in a WAV audio. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ID3V1Genre` | Specifies genres used in an Id3v1 tag. |
| `ID3V2AttachedPictureType` | Represents the type of an attached picture. |
| `ID3V2EncodingType` | Defines different types of text encoding used in ID3v2. |

### ApePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage.md

#### ApePackage class

Represents an APE v2 metadata package.
Please find more information at [http://wiki.hydrogenaud.io/index.php?title=APE_key](http://wiki.hydrogenaud.io/index.php?title=APE_key).

**Inheritance:** `ApePackage` →
`CustomPackage` →
`MetadataPackage`

The ApePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| title | Gets the title. |
| subtitle | Gets the subtitle. |
| artist | Gets the artist. |
| album | Gets the album. |
| debut_album | Gets the debut album. |
| publisher | Gets the publisher. |
| conductor | Gets the conductor. |
| track | Gets the track number. |
| composer | Gets the composer. |
| comment | Gets the comment. |
| copyright | Gets the copyright. |
| publication_right | Gets the publication right. |
| file | Gets the file. |
| isbn | Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International_Standard_Book_Number. |
| record_location | Gets the record location. |
| genre | Gets the genre. |
| isrc | Gets the International Standard Recording Number. |
| abstract | Gets the abstract link. |
| language | Gets the language. |
| bibliography | Gets the bibliography. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to read the APEv2 tag in an MP3 file.

### abstract property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/abstract.md

#### abstract property

Gets the abstract link.
##### Definition:
```python
@property
def abstract(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/album.md

#### album property

Gets the album.
##### Definition:
```python
@property
def album(self):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/artist.md

#### artist property

Gets the artist.
##### Definition:
```python
@property
def artist(self):
    ...
```

### bibliography property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/bibliography.md

#### bibliography property

Gets the bibliography.
##### Definition:
```python
@property
def bibliography(self):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/comment.md

#### comment property

Gets the comment.
##### Definition:
```python
@property
def comment(self):
    ...
```

### composer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/composer.md

#### composer property

Gets the composer.
##### Definition:
```python
@property
def composer(self):
    ...
```

### conductor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/conductor.md

#### conductor property

Gets the conductor.
##### Definition:
```python
@property
def conductor(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/copyright.md

#### copyright property

Gets the copyright.
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### debut_album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/debut_album.md

#### debut_album property

Gets the debut album.
##### Definition:
```python
@property
def debut_album(self):
    ...
```

### file property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/file.md

#### file property

Gets the file.
##### Definition:
```python
@property
def file(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/genre.md

#### genre property

Gets the genre.
##### Definition:
```python
@property
def genre(self):
    ...
```

### isbn property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/isbn.md

#### isbn property

Gets the ISBN number with check digit. See more: https://en.wikipedia.org/wiki/International_Standard_Book_Number.
##### Definition:
```python
@property
def isbn(self):
    ...
```

### isrc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/isrc.md

#### isrc property

Gets the International Standard Recording Number.
##### Definition:
```python
@property
def isrc(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/language.md

#### language property

Gets the language.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publication_right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/publication_right.md

#### publication_right property

Gets the publication right.
##### Definition:
```python
@property
def publication_right(self):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/publisher.md

#### publisher property

Gets the publisher.
##### Definition:
```python
@property
def publisher(self):
    ...
```

### record_location property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/record_location.md

#### record_location property

Gets the record location.
##### Definition:
```python
@property
def record_location(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subtitle property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/subtitle.md

#### subtitle property

Gets the subtitle.
##### Definition:
```python
@property
def subtitle(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/title.md

#### title property

Gets the title.
##### Definition:
```python
@property
def title(self):
    ...
```

### track property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/track.md

#### track property

Gets the track number.
##### Definition:
```python
@property
def track(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/apepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3Tag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag.md

#### ID3Tag class

Represents a base abstract class for the ID3(v1) and ID3(v2) audio tags.

**Inheritance:** `ID3Tag` →
`CustomPackage` →
`MetadataPackage`

The ID3Tag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| version | Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3tag/version.md

#### version property

Gets the version of the ID3 tag in string format. For example: 'ID3v1.1'.
##### Definition:
```python
@property
def version(self):
    ...
```

### ID3V1Genre enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1genre.md

#### ID3V1Genre enumeration

Specifies genres used in an Id3v1 tag.

The ID3V1Genre type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BLUES | Represents the Blues genre. |
| CLASSIC_ROCK | Represents the Classic Rock genre. |
| COUNTRY | Represents the Country genre. |
| DANCE | Represents the Dance genre. |
| DISCO | Represents the Disco genre. |
| FUNK | Represents the Funk genre. |
| GRUNGE | Represents the Grunge genre. |
| HIP_HOP | Represents the Hip-Hop genre. |
| JAZZ | Represents the Jazz genre. |
| METAL | Represents the Metal genre. |
| NEW_AGE | Represents the New Age genre. |
| OLDIES | Represents the Oldies genre. |
| OTHER | Represents the Other genre. |
| POP | Represents the Pop genre. |
| RHYTHM_AND_BLUES | Represents the Rhythm and Blues genre. |
| RAP | Represents the Rap genre. |
| REGGAE | Represents the Reggae genre. |
| ROCK | Represents the Rock genre. |
| TECHNO | Represents the Techno genre. |
| INDUSTRIAL | Represents the Industrial genre. |
| ALTERNATIVE | Represents the Alternative genre. |
| SKA | Represents the Ska genre. |
| DEATH_METAL | Represents the Death Metal genre. |
| PRANKS | Represents the Pranks genre. |
| SOUNDTRACK | Represents the Soundtrack genre. |
| EURO_TECHNO | Represents the Euro-Techno genre. |
| AMBIENT | Represents the Ambient genre. |
| TRIP_HOP | Represents the Trip-Hop genre. |
| VOCAL | Represents the Vocal genre. |
| JAZZ_AND_FUNK | Represents the JazzAndFunk genre. |
| FUSION | Represents the Fusion genre. |
| TRANCE | Represents the Trance genre. |
| CLASSICAL | Represents the Classical genre. |
| INSTRUMENTAL | Represents the Instrumental genre. |
| ACID | Represents the Acid genre. |
| HOUSE | Represents the House genre. |
| GAME | Represents the Game genre. |
| SOUND_CLIP | Represents the Sound Clip genre. |
| GOSPEL | Represents the Gospel genre. |
| NOISE | Represents the Noise genre. |
| ALTERNATIVE_ROCK | Represents the Alternative Rock genre. |
| BASS | Represents the Bass genre. |
| SOUL | Represents the Soul genre. |
| PUNK | Represents the Punk genre. |
| SPACE | Represents the Space genre. |
| MEDITATIVE | Represents the Meditative genre. |
| INSTRUMENTAL_POP | Represents the Instrumental Pop genre. |
| INSTRUMENTAL_ROCK | Represents the Instrumental Rock genre. |
| ETHNIC | Represents the Ethnic genre. |
| GOTHIC | Represents the Gothic genre. |
| DARKWAVE | Represents the Darkwave genre. |
| TECHNO_INDUSTRIAL | Represents the Techno-Industrial genre. |
| ELECTRONIC | Represents the Electronic genre. |
| POP_FOLK | Represents the Pop-Folk genre. |
| EURODANCE | Represents the Eurodance genre. |
| DREAM | Represents the Dream genre. |
| SOUTHERN_ROCK | Represents the Southern Rock genre. |
| COMEDY | Represents the Comedy genre. |
| CULT | Represents the Cult genre. |
| GANGSTA | Represents the Gangsta genre. |
| TOP40 | Represents the Top 40 genre. |
| CHRISTIAN_RAP | Represents the Christian Rap genre. |
| POP_FUNK | Represents the Pop/Funk genre. |
| JUNGLE | Represents the Jungle genre. |
| NATIVE_AMERICAN | Represents the Native American genre. |
| CABARET | Represents the Cabaret genre. |
| NEW_WAVE | Represents the New Wave genre. |
| PSYCHEDELIC | Represents the Psychedelic genre. |
| RAVE | Represents the Rave genre. |
| SHOWTUNES | Represents the Showtunes genre. |
| TRAILER | Represents the Trailer genre. |
| LO_FI | Represents the Lo-Fi genre. |
| TRIBAL | Represents the Tribal genre. |
| ACID_PUNK | Represents the Acid Punk genre. |
| ACID_JAZZ | Represents the Acid Jazz genre. |
| POLKA | Represents the Polka genre. |
| RETRO | Represents the Retro genre. |
| MUSICAL | Represents the Musical genre. |
| ROCK_N_ROLL | Represents the Rock 'n' Roll genre. |
| HARD_ROCK | Represents the Hard Rock genre. |

### ID3V1Tag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag.md

#### ID3V1Tag class

Represents an ID3v1 tag.
Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v1](https://en.wikipedia.org/wiki/ID3#ID3v1).

**Inheritance:** `ID3V1Tag` →
`ID3Tag` →
`CustomPackage` →
`MetadataPackage`

The ID3V1Tag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `ID3V1Tag` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| version | Gets the ID3 version. It can be ID3 or ID3v1.1 |
| artist | Gets or sets the artist. Maximum length is 30 characters. |
| album | Gets or sets the album. Maximum length is 30 characters. |
| genre_value | Gets or sets the genre identifier. |
| comment | Gets or sets the comment. Maximum length is 30 characters. |
| title | Gets or sets the title. |
| year | Gets or sets the year. Maximum length is 4 characters. |
| track_number | Gets or sets the track number. Presented in a ID3v1.1 tag only. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

ID3(v1) tag is a small chunk of extra data at the end of MP3.
Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1).

**Learn more** |
|
 |

##### Example

This code sample shows how to read the ID3v1 tag in an MP3 file.

### ID3V1Tag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `ID3V1Tag` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/album.md

#### album property

Gets or sets the album. Maximum length is 30 characters.
##### Definition:
```python
@property
def album(self):
    ...
@album.setter
def album(self, value):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/artist.md

#### artist property

Gets or sets the artist. Maximum length is 30 characters.
##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/comment.md

#### comment property

Gets or sets the comment. Maximum length is 30 characters.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/genre_value.md

#### genre_value property

Gets or sets the genre identifier.
##### Definition:
```python
@property
def genre_value(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/title.md

#### title property

Gets or sets the title.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/track_number.md

#### track_number property

Gets or sets the track number. Presented in a ID3v1.1 tag only.

##### Remarks

If the value of `ID3V1Tag.track_number` is a positive integer then ID3 changes version to 'ID3v1.1' automatically.
##### Definition:
```python
@property
def track_number(self):
    ...
@track_number.setter
def track_number(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/version.md

#### version property

Gets the ID3 version. It can be ID3 or ID3v1.1
##### Definition:
```python
@property
def version(self):
    ...
```

### year property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v1tag/year.md

#### year property

Gets or sets the year. Maximum length is 4 characters.
##### Definition:
```python
@property
def year(self):
    ...
@year.setter
def year(self, value):
    ...
```

### ID3V2AttachedPictureFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe.md

#### ID3V2AttachedPictureFrame class

Represents an APIC frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2AttachedPictureFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2AttachedPictureFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, encoding, mime_type, picture_type, description, picture_data)` | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |
| `__init__(self, picture_type, description, picture_data)` | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |
| `__init__(self, picture_data)` | Initializes a new instance of the `ID3V2AttachedPictureFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| description_encoding | Gets the encoding used to encode the picture description. |
| mime_type | Gets the MIME type of the picture. |
| attached_picture_type | Gets the type of the picture. |
| description | Gets the picture description.
<br/>The description has a maximum length of 64 characters, but may be empty. |
| picture_data | Gets the picture data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2AttachedPictureFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/__init__.md

#### \_\_init\_\_(self, picture_data)

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```python

def __init__(self, picture_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| picture_data | bytes | The picture data. |

#### \_\_init\_\_(self, picture_type, description, picture_data)

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```python

def __init__(self, picture_type, description, picture_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| picture_type | groupdocs.metadata.formats.audio.ID3V2AttachedPictureType | The type of the picture. |
| description | System.String | The description of the picture. |
| picture_data | bytes | The picture data. |

#### \_\_init\_\_(self, encoding, mime_type, picture_type, description, picture_data)

Initializes a new instance of the `ID3V2AttachedPictureFrame` class.

```python

def __init__(self, encoding, mime_type, picture_type, description, picture_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encoding | groupdocs.metadata.formats.audio.ID3V2EncodingType | The frame encoding. |
| mime_type | System.String | The MIME-type of the image. |
| picture_type | groupdocs.metadata.formats.audio.ID3V2AttachedPictureType | The type of the picture. |
| description | System.String | The description of the picture. |
| picture_data | bytes | The picture data. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### attached_picture_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/attached_picture_type.md

#### attached_picture_type property

Gets the type of the picture.
##### Definition:
```python
@property
def attached_picture_type(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/description.md

#### description property

Gets the picture description.
The description has a maximum length of 64 characters, but may be empty.
##### Definition:
```python
@property
def description(self):
    ...
```

### description_encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/description_encoding.md

#### description_encoding property

Gets the encoding used to encode the picture description.
##### Definition:
```python
@property
def description_encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/mime_type.md

#### mime_type property

Gets the MIME type of the picture.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### picture_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/picture_data.md

#### picture_data property

Gets the picture data.
##### Definition:
```python
@property
def picture_data(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpictureframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2AttachedPictureType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2attachedpicturetype.md

#### ID3V2AttachedPictureType enumeration

Represents the type of an attached picture.

The ID3V2AttachedPictureType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| OTHER | Attached picture of any other type. |
| FILE_ICON_32X32 | 32x32 pixels file icon (PNG only). |
| OTHER_FILE_ICON | Other file icon. |
| COVER_FRONT | Cover (front). |
| COVER_BACK | Cover (back). |
| LEAFLET_PAGE | Leaflet page. |
| MEDIA | Media (e.g. label side of CD). |
| LEAD_ARTIST | Lead artist/lead performer/soloist. |
| ARTIST | Artist/performer. |
| CONDUCTOR | Conductor. |
| BAND | Band/Orchestra. |
| COMPOSER | Composer/music author. |
| LYRICIST | Lyricist/text writer. |
| RECORDING_LOCATION | Recording Location. |
| DURING_RECORDING | During recording. |
| DURING_PERFORMANCE | During performance. |
| VIDEO_SCREEN_CAPTURE | Movie/video screen capture. |
| BRIGHT_COLOURED_FISH | A bright coloured fish. |
| ILLUSTRATION | Illustration. |
| ARTIST_LOGO | Band/artist logotype. |
| STUDIO_LOGO | Publisher/Studio logotype. |

### ID3V2CommentFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe.md

#### ID3V2CommentFrame class

Represents a COMM frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2CommentFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2CommentFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, encoding, language, description, text)` | Initializes a new instance of the `ID3V2CommentFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| comment_encoding | Gets the encoding of the comment. |
| language | Gets the language of the comment (3 characters). |
| short_content_description | Gets the short content description. |
| text | Gets the text of the comment. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

This frame is intended for any kind of full text information that does not fit in any other frame.

**Learn more** |
|
 |

### ID3V2CommentFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/__init__.md

#### \_\_init\_\_(self, encoding, language, description, text)

Initializes a new instance of the `ID3V2CommentFrame` class.

```python

def __init__(self, encoding, language, description, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encoding | groupdocs.metadata.formats.audio.ID3V2EncodingType | The encoding of the comment. |
| language | System.String | The language of the comment. |
| description | System.String | A short content description. |
| text | System.String | The text of the comment. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### comment_encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/comment_encoding.md

#### comment_encoding property

Gets the encoding of the comment.
##### Definition:
```python
@property
def comment_encoding(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/language.md

#### language property

Gets the language of the comment (3 characters).
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### short_content_description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/short_content_description.md

#### short_content_description property

Gets the short content description.
##### Definition:
```python
@property
def short_content_description(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/text.md

#### text property

Gets the text of the comment.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2commentframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2EncodingType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2encodingtype.md

#### ID3V2EncodingType enumeration

Defines different types of text encoding used in ID3v2.

The ID3V2EncodingType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ISO88591 | The ISO-8859-1 encoding. |
| UTF16 | The UTF-16 encoding with BOM. |
| UTF_16_BE | The UTF-16 encoding without BOM. |
| UTF8 | The UTF-8 encoding. |

### ID3V2MlltFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe.md

#### ID3V2MlltFrame class

Represents an MLLT frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2MlltFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2MlltFrame type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2mlltframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2PlayCounterFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe.md

#### ID3V2PlayCounterFrame class

Represents a PCNT frame in an `ID3V2Tag`.
This is simply a counter of the number of times a file has been played.

**Inheritance:** `ID3V2PlayCounterFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2PlayCounterFrame type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| value | Gets the number of times the file has been played. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2playcounterframe/value.md

#### value property

Gets the number of times the file has been played.
##### Definition:
```python
@property
def value(self):
    ...
```

### ID3V2PrivateFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe.md

#### ID3V2PrivateFrame class

Represents a PRIV frame in an `ID3V2Tag`.
The frame is used to contain information from a software producer that its program uses
and does not fit into the other frames.

**Inheritance:** `ID3V2PrivateFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2PrivateFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, owner_identifier, data)` | Initializes a new instance of the `ID3V2PrivateFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| owner_identifier | Gets the owner identifier. |
| binary_data | Gets the binary data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2PrivateFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/__init__.md

#### \_\_init\_\_(self, owner_identifier, data)

Initializes a new instance of the `ID3V2PrivateFrame` class.

```python

def __init__(self, owner_identifier, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| owner_identifier | System.String | The owner identifier. |
| data | bytes | Frame binary data. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### binary_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/binary_data.md

#### binary_data property

Gets the binary data.
##### Definition:
```python
@property
def binary_data(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### owner_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/owner_identifier.md

#### owner_identifier property

Gets the owner identifier.
##### Definition:
```python
@property
def owner_identifier(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2privateframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2Tag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag.md

#### ID3V2Tag class

Represents an ID3v2 tag.
Please find more information at [https://en.wikipedia.org/wiki/ID3#ID3v2](https://en.wikipedia.org/wiki/ID3#ID3v2).

**Inheritance:** `ID3V2Tag` →
`ID3Tag` →
`CustomPackage` →
`MetadataPackage`

The ID3V2Tag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `ID3V2Tag` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| version | Gets the ID3 version. |
| tag_size | Gets the size of the tag. |
| album | Gets or sets the Album/Movie/Show title.
<br/>This value is represented by the TALB frame. |
| artist | Gets or sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.
<br/>This value is represented by the TPE1 frame. |
| band | Gets or sets the Band/Orchestra/Accompaniment.
<br/>This value is represented by the TPE2 frame. |
| bits_per_minute | Gets or sets the number of beats per minute in the main part of the audio.
<br/>This value is represented by the TBPM frame. |
| composers | Gets or sets the composers. The names are separated with the "/" character.
<br/>This value is represented by the TCOM frame. |
| content_type | Gets or sets the content type.
<br/>This value is represented by the TCON frame. |
| copyright | Gets or sets the copyright message.
<br/>This value is represented by the TCOP frame. |
| date | Gets or sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long.
<br/>This value is represented by the TDAT frame. |
| encoded_by | Gets or sets the name of the person or organization that encoded the audio file.
<br/>This value is represented by the TENC frame. |
| publisher | Gets or sets the name of the label or publisher.
<br/>This value is represented by the TPUB frame. |
| time | Gets or sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long.
<br/>This value is represented by the TIME frame. |
| title | Gets or sets the Title/Song name/Content description.
<br/>This value is represented by the TIT2 frame. |
| subtitle | Gets or sets the Subtitle/Description refinement.
<br/>This value is represented by the TIT3 frame. |
| musical_key | Gets or sets the musical key in which the sound starts.
<br/>This value is represented by the TKEY frame. |
| length_in_milliseconds | Gets or sets the length of the audio file in milliseconds, represented as a numeric string.
<br/>This value is represented by the TLEN frame. |
| original_album | Gets or sets the original album/movie/show title.
<br/>This value is represented by the TOAL frame. |
| track_number | Gets or sets a numeric string containing the order number of the audio-file on its original recording.
<br/>This value is represented by the TRCK frame. |
| size_in_bytes | Gets or sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.
<br/>This value is represented by the TSIZ frame. |
| isrc | Gets or sets the International Standard Recording Code (ISRC) (12 characters).
<br/>This value is represented by the TSRC frame. |
| software_hardware | Gets or sets the used audio encoder and its settings when the file was encoded.
<br/>This value is represented by the TSSE frame. |
| year | Gets or sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
<br/>This value is represented by the TYER frame. |
| comments | Gets or sets the user comments.
<br/>This value is represented by the COMM frame.
<br/>The frame is intended for any kind of full text information that does not fit in any other frame. |
| attached_pictures | Gets or sets the attached pictures directly related to the audio file.
<br/>This value is represented by the APIC frame. |
| track_play_counter | Gets the number of times the file has been played.
<br/>This value is represented by the PCNT frame. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove_attached_pictures(self)` | Removes all attached pictures stored in APIC frames. |
| `get(self, frame_id)` | Gets an array of frames with the specified id. |
| `set(self, frame)` | Removes all frames having the same id as the specified one and adds the new frame to the tag. |
| `clear(self, frame_id)` | Removes all frames with the specified id. |
| `add(self, frame)` | Adds a frame to the tag. |
| `remove(self, frame)` | Removes the specified frame from the tag. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read the ID3v2 tag in an MP3 file.

### ID3V2Tag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `ID3V2Tag` class.

```python

def __init__(self):
    ...
```

### add method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/add.md

#### add(self, frame)

Adds a frame to the tag.

```python

def add(self, frame):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame | groupdocs.metadata.formats.audio.ID3V2TagFrame | The frame to be added to the tag. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | The provided frame is incompatible with the existing frames of the same kind. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/album.md

#### album property

Gets or sets the Album/Movie/Show title.
This value is represented by the TALB frame.
##### Definition:
```python
@property
def album(self):
    ...
@album.setter
def album(self, value):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/artist.md

#### artist property

Gets or sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.
This value is represented by the TPE1 frame.
##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### attached_pictures property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/attached_pictures.md

#### attached_pictures property

Gets or sets the attached pictures directly related to the audio file.
This value is represented by the APIC frame.
##### Definition:
```python
@property
def attached_pictures(self):
    ...
@attached_pictures.setter
def attached_pictures(self, value):
    ...
```

### band property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/band.md

#### band property

Gets or sets the Band/Orchestra/Accompaniment.
This value is represented by the TPE2 frame.
##### Definition:
```python
@property
def band(self):
    ...
@band.setter
def band(self, value):
    ...
```

### bits_per_minute property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/bits_per_minute.md

#### bits_per_minute property

Gets or sets the number of beats per minute in the main part of the audio.
This value is represented by the TBPM frame.
##### Definition:
```python
@property
def bits_per_minute(self):
    ...
@bits_per_minute.setter
def bits_per_minute(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/clear.md

#### clear(self, frame_id)

Removes all frames with the specified id.

```python

def clear(self, frame_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_id | System.String | The id of the frames to remove. |

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/comments.md

#### comments property

Gets or sets the user comments.
This value is represented by the COMM frame.
The frame is intended for any kind of full text information that does not fit in any other frame.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### composers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/composers.md

#### composers property

Gets or sets the composers. The names are separated with the "/" character.
This value is represented by the TCOM frame.
##### Definition:
```python
@property
def composers(self):
    ...
@composers.setter
def composers(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/content_type.md

#### content_type property

Gets or sets the content type.
This value is represented by the TCON frame.
##### Definition:
```python
@property
def content_type(self):
    ...
@content_type.setter
def content_type(self, value):
    ...
```

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/copyright.md

#### copyright property

Gets or sets the copyright message.
This value is represented by the TCOP frame.

##### Remarks

Every time this field is displayed the field must be preceded with "Copyright © ".
##### Definition:
```python
@property
def copyright(self):
    ...
@copyright.setter
def copyright(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/date.md

#### date property

Gets or sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long.
This value is represented by the TDAT frame.
##### Definition:
```python
@property
def date(self):
    ...
@date.setter
def date(self, value):
    ...
```

### encoded_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/encoded_by.md

#### encoded_by property

Gets or sets the name of the person or organization that encoded the audio file.
This value is represented by the TENC frame.
##### Definition:
```python
@property
def encoded_by(self):
    ...
@encoded_by.setter
def encoded_by(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/get.md

#### get(self, frame_id)

Gets an array of frames with the specified id.

##### Returns

An array of frames with the specified id.

```python

def get(self, frame_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_id | System.String | The id of the frames to get. |

### isrc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/isrc.md

#### isrc property

Gets or sets the International Standard Recording Code (ISRC) (12 characters).
This value is represented by the TSRC frame.
##### Definition:
```python
@property
def isrc(self):
    ...
@isrc.setter
def isrc(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### length_in_milliseconds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/length_in_milliseconds.md

#### length_in_milliseconds property

Gets or sets the length of the audio file in milliseconds, represented as a numeric string.
This value is represented by the TLEN frame.
##### Definition:
```python
@property
def length_in_milliseconds(self):
    ...
@length_in_milliseconds.setter
def length_in_milliseconds(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### musical_key property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/musical_key.md

#### musical_key property

Gets or sets the musical key in which the sound starts.
This value is represented by the TKEY frame.
##### Definition:
```python
@property
def musical_key(self):
    ...
@musical_key.setter
def musical_key(self, value):
    ...
```

### original_album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/original_album.md

#### original_album property

Gets or sets the original album/movie/show title.
This value is represented by the TOAL frame.
##### Definition:
```python
@property
def original_album(self):
    ...
@original_album.setter
def original_album(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/publisher.md

#### publisher property

Gets or sets the name of the label or publisher.
This value is represented by the TPUB frame.
##### Definition:
```python
@property
def publisher(self):
    ...
@publisher.setter
def publisher(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/remove.md

#### remove(self, frame)

Removes the specified frame from the tag.

```python

def remove(self, frame):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame | groupdocs.metadata.formats.audio.ID3V2TagFrame | The frame to be removed from the tag. |

### remove_attached_pictures method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/remove_attached_pictures.md

#### remove_attached_pictures(self)

Removes all attached pictures stored in APIC frames.

```python

def remove_attached_pictures(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/set.md

#### set(self, frame)

Removes all frames having the same id as the specified one and adds the new frame to the tag.

```python

def set(self, frame):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame | groupdocs.metadata.formats.audio.ID3V2TagFrame | The frame to replace all frames of its kind with. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### size_in_bytes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/size_in_bytes.md

#### size_in_bytes property

Gets or sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.
This value is represented by the TSIZ frame.
##### Definition:
```python
@property
def size_in_bytes(self):
    ...
@size_in_bytes.setter
def size_in_bytes(self, value):
    ...
```

### software_hardware property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/software_hardware.md

#### software_hardware property

Gets or sets the used audio encoder and its settings when the file was encoded.
This value is represented by the TSSE frame.
##### Definition:
```python
@property
def software_hardware(self):
    ...
@software_hardware.setter
def software_hardware(self, value):
    ...
```

### subtitle property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/subtitle.md

#### subtitle property

Gets or sets the Subtitle/Description refinement.
This value is represented by the TIT3 frame.
##### Definition:
```python
@property
def subtitle(self):
    ...
@subtitle.setter
def subtitle(self, value):
    ...
```

### tag_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/tag_size.md

#### tag_size property

Gets the size of the tag.
##### Definition:
```python
@property
def tag_size(self):
    ...
```

### time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/time.md

#### time property

Gets or sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long.
This value is represented by the TIME frame.
##### Definition:
```python
@property
def time(self):
    ...
@time.setter
def time(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/title.md

#### title property

Gets or sets the Title/Song name/Content description.
This value is represented by the TIT2 frame.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list of all frames contained in the ID3v2 tag.

```python

def to_list(self):
    ...
```

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/track_number.md

#### track_number property

Gets or sets a numeric string containing the order number of the audio-file on its original recording.
This value is represented by the TRCK frame.
##### Definition:
```python
@property
def track_number(self):
    ...
@track_number.setter
def track_number(self, value):
    ...
```

### track_play_counter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/track_play_counter.md

#### track_play_counter property

Gets the number of times the file has been played.
This value is represented by the PCNT frame.
##### Definition:
```python
@property
def track_play_counter(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/version.md

#### version property

Gets the ID3 version.
##### Definition:
```python
@property
def version(self):
    ...
```

### year property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tag/year.md

#### year property

Gets or sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
This value is represented by the TYER frame.
##### Definition:
```python
@property
def year(self):
    ...
@year.setter
def year(self, value):
    ...
```

### ID3V2TagFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe.md

#### ID3V2TagFrame class

Represents a generic frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2TagFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, frame_id, data)` | Initializes a new instance of the `ID3V2TagFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2TagFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/__init__.md

#### \_\_init\_\_(self, frame_id, data)

Initializes a new instance of the `ID3V2TagFrame` class.

```python

def __init__(self, frame_id, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_id | System.String | The id of the frame (four characters matching the pattern [A-Z0-9]). |
| data | bytes | The content of the frame. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2TagFrameFlags class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags.md

#### ID3V2TagFrameFlags class

Represents flags used in a ID3v2 tag frame.

The ID3V2TagFrameFlags type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| tag_alter_preservation | Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way.
<br/>This applies to all kinds of alterations,
<br/>including adding more padding and reordering the frames. |
| file_alter_preservation | Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered.
<br/>This does not apply when the audio is completely replaced with other audio data. |
| read_only | Gets the tag that tells the software that the contents of this frame is intended to be read-only. |
| compression | Gets a value indicating whether the frame is compressed. |
| encryption | Gets a value indicating whether the frame is encrypted.
<br/>If set one byte indicating with which method it was encrypted will be appended to the frame header. |
| grouping_identity | Gets a value indicating whether the frame belongs to a group of frames.
<br/>If set a group identifier byte is added to the frame header.
<br/>Every frame with the same group identifier belongs to the same group. |
| unsynchronisation | Gets a value indicating whether unsynchronisation was applied to this frame. |
| data_length_indicator | Gets a value indicating whether a data length indicator has been added to
<br/>the frame. The data length indicator is the value one would write
<br/>as the 'Frame length' if all of the frame format flags were
<br/>zeroed, represented as a 32 bit synchsafe integer. |

##### Methods
| Method | Description |
| :- | :- |
| `equals(self, other)` | Indicates whether the current object is equal to another object of the same type. |

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/compression.md

#### compression property

Gets a value indicating whether the frame is compressed.
##### Definition:
```python
@property
def compression(self):
    ...
```

### data_length_indicator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/data_length_indicator.md

#### data_length_indicator property

Gets a value indicating whether a data length indicator has been added to
the frame. The data length indicator is the value one would write
as the 'Frame length' if all of the frame format flags were
zeroed, represented as a 32 bit synchsafe integer.
##### Definition:
```python
@property
def data_length_indicator(self):
    ...
```

### encryption property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/encryption.md

#### encryption property

Gets a value indicating whether the frame is encrypted.
If set one byte indicating with which method it was encrypted will be appended to the frame header.
##### Definition:
```python
@property
def encryption(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/equals.md

#### equals(self, other)

Indicates whether the current object is equal to another object of the same type.

##### Returns

true if the current object is equal to the `other` parameter; otherwise, false.

```python

def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.formats.audio.ID3V2TagFrameFlags | An object to compare with this object. |

### file_alter_preservation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/file_alter_preservation.md

#### file_alter_preservation property

Gets the flag that tells the software what to do with this frame if it is unknown and the file, excluding the tag, is altered.
This does not apply when the audio is completely replaced with other audio data.
##### Definition:
```python
@property
def file_alter_preservation(self):
    ...
```

### grouping_identity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/grouping_identity.md

#### grouping_identity property

Gets a value indicating whether the frame belongs to a group of frames.
If set a group identifier byte is added to the frame header.
Every frame with the same group identifier belongs to the same group.
##### Definition:
```python
@property
def grouping_identity(self):
    ...
```

### read_only property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/read_only.md

#### read_only property

Gets the tag that tells the software that the contents of this frame is intended to be read-only.
##### Definition:
```python
@property
def read_only(self):
    ...
```

### tag_alter_preservation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/tag_alter_preservation.md

#### tag_alter_preservation property

Gets the flag that tells the software what to do with this frame if it is unknown and the tag is altered in any way.
This applies to all kinds of alterations,
including adding more padding and reordering the frames.
##### Definition:
```python
@property
def tag_alter_preservation(self):
    ...
```

### unsynchronisation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2tagframeflags/unsynchronisation.md

#### unsynchronisation property

Gets a value indicating whether unsynchronisation was applied to this frame.
##### Definition:
```python
@property
def unsynchronisation(self):
    ...
```

### ID3V2TextFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe.md

#### ID3V2TextFrame class

Represents a text frame in an `ID3V2Tag`.
Almost all frames starting with the T character fall into this category. There is only one exception, which is the TXXX frame represented by the `ID3V2UserDefinedFrame` class.

**Inheritance:** `ID3V2TextFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2TextFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, id, encoding, value)` | Initializes a new instance of the `ID3V2TextFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| text_encoding | Gets the text encoding. |
| text | Gets the text value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2TextFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/__init__.md

#### \_\_init\_\_(self, id, encoding, value)

Initializes a new instance of the `ID3V2TextFrame` class.

```python

def __init__(self, id, encoding, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | System.String | The frame id. |
| encoding | groupdocs.metadata.formats.audio.ID3V2EncodingType | The encoding of the frame. |
| value | System.String | The frame value. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/text.md

#### text property

Gets the text value.
##### Definition:
```python
@property
def text(self):
    ...
```

### text_encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/text_encoding.md

#### text_encoding property

Gets the text encoding.
##### Definition:
```python
@property
def text_encoding(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2textframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ID3V2UrlLinkFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe.md

#### ID3V2UrlLinkFrame class

Represents a URL link frame in an `ID3V2Tag`. Name of the frame always starts with the W character.

**Inheritance:** `ID3V2UrlLinkFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2UrlLinkFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, id, url)` | Initializes a new instance of the `ID3V2UrlLinkFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| url | Gets the URL value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2UrlLinkFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/__init__.md

#### \_\_init\_\_(self, id, url)

Initializes a new instance of the `ID3V2UrlLinkFrame` class.

```python

def __init__(self, id, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | System.String | The frame id. |
| url | System.String | The URL which is the value of the frame. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2urllinkframe/url.md

#### url property

Gets the URL value.
##### Definition:
```python
@property
def url(self):
    ...
```

### ID3V2UserDefinedFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe.md

#### ID3V2UserDefinedFrame class

Represents a TXXX frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2UserDefinedFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2UserDefinedFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, description, value)` | Initializes a new instance of the `ID3V2UserDefinedFrame` class. |
| `__init__(self, encoding, description, value)` | Initializes a new instance of the `ID3V2UserDefinedFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| encoding | Gets the encoding of the frame. |
| description | Gets the description. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2UserDefinedFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/__init__.md

#### \_\_init\_\_(self, description, value)

Initializes a new instance of the `ID3V2UserDefinedFrame` class.

```python

def __init__(self, description, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | System.String | The description. |
| value | System.String | The value. |

#### \_\_init\_\_(self, encoding, description, value)

Initializes a new instance of the `ID3V2UserDefinedFrame` class.

```python

def __init__(self, encoding, description, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encoding | groupdocs.metadata.formats.audio.ID3V2EncodingType | The encoding of the frame. |
| description | System.String | The description. |
| value | System.String | The text value. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/description.md

#### description property

Gets the description.
##### Definition:
```python
@property
def description(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/encoding.md

#### encoding property

Gets the encoding of the frame.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedframe/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### ID3V2UserDefinedUrlLinkFrame class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe.md

#### ID3V2UserDefinedUrlLinkFrame class

Represents a WXXX frame in an `ID3V2Tag`.

**Inheritance:** `ID3V2UserDefinedUrlLinkFrame` →
`ID3V2TagFrame` →
`CustomPackage` →
`MetadataPackage`

The ID3V2UserDefinedUrlLinkFrame type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, description, url)` | Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class. |
| `__init__(self, encoding, description, url)` | Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the id of the frame (four characters matching the pattern [A-Z0-9]). |
| flags | Gets the frame flags. |
| data | Gets the frame data. |
| encoding | Gets the encoding of the frame. |
| description | Gets the description. |
| url | Gets the URL. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### ID3V2UserDefinedUrlLinkFrame constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/__init__.md

#### \_\_init\_\_(self, description, url)

Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class.

```python

def __init__(self, description, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | System.String | The description. |
| url | System.String | The actual value of the frame. |

#### \_\_init\_\_(self, encoding, description, url)

Initializes a new instance of the `ID3V2UserDefinedUrlLinkFrame` class.

```python

def __init__(self, encoding, description, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encoding | groupdocs.metadata.formats.audio.ID3V2EncodingType | The encoding of the frame. |
| description | System.String | The description. |
| url | System.String | The actual value of the frame. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/data.md

#### data property

Gets the frame data.
##### Definition:
```python
@property
def data(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/description.md

#### description property

Gets the description.
##### Definition:
```python
@property
def description(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/encoding.md

#### encoding property

Gets the encoding of the frame.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/flags.md

#### flags property

Gets the frame flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/id.md

#### id property

Gets the id of the frame (four characters matching the pattern [A-Z0-9]).
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/id3v2userdefinedurllinkframe/url.md

#### url property

Gets the URL.
##### Definition:
```python
@property
def url(self):
    ...
```

### LyricsField class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield.md

#### LyricsField class

Represents a `LyricsTag` field.

**Inheritance:** `LyricsField` →
`MetadataProperty`

The LyricsField type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, id, data)` | Initializes a new instance of the `LyricsField` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| id | Gets the id of the field (it's always three characters long). |
| size | Gets the string representation of the field size. |
| data | Gets the field data. |

##### Remarks

**Learn more** |
|
 |

### LyricsField constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/__init__.md

#### \_\_init\_\_(self, id, data)

Initializes a new instance of the `LyricsField` class.

```python

def __init__(self, id, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | System.String | The three character field id. |
| data | System.String | The field data. |

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/data.md

#### data property

Gets the field data.
##### Definition:
```python
@property
def data(self):
    ...
```

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/id.md

#### id property

Gets the id of the field (it's always three characters long).
##### Definition:
```python
@property
def id(self):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/size.md

#### size property

Gets the string representation of the field size.
##### Definition:
```python
@property
def size(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricsfield/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### LyricsTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag.md

#### LyricsTag class

Represents Lyrics3 v2.00 metadata.
Please find more information at [http://id3.org/Lyrics3v2]().

**Inheritance:** `LyricsTag` →
`CustomPackage` →
`MetadataPackage`

The LyricsTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `LyricsTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| lyrics | Gets or sets the lyrics.
<br/>This value is represented by the LYR field. |
| additional_info | Gets or sets the additional information.
<br/>This value is represented by the INF field. |
| author | Gets or sets the author.
<br/>This value is represented by the AUT field. |
| album | Gets or sets the album name.
<br/>This value is represented by the EAL field. |
| artist | Gets or sets the artist name.
<br/>This value is represented by the EAR field. |
| track | Gets or sets the track title.
<br/>This value is represented by the ETT field. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set(self, field)` | Adds or replaces the specified Lyrics3 field. |
| `remove(self, id)` | Removes the field with the specified id. |
| `get(self, id)` | Gets the value of the field with the specified id. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

Lyrics3 v2.00 uses fields to represent information.
The data in a field can consist of ASCII characters in the range 01 to 254 according to the standard.
As the ASCII character map is only defined from 00 to 128 ISO-8859-1 might be assumed. Numerical fields are 5 or 6 characters long, depending on location, and are padded with zeroes.

**Learn more** |
|
 |

##### Example

This code sample shows how to read the Lyrics tag from an MP3 file.

### LyricsTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `LyricsTag` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### additional_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/additional_info.md

#### additional_info property

Gets or sets the additional information.
This value is represented by the INF field.

##### Remarks

This is always three (3) characters long in v2.00, but might be longer in a future standard.
The first byte indicates weather or not a lyrics field is present. "1" for present and "0" for otherwise.
The second character indicates if there is a timestamp in the lyrics. Again "1" for yes and "0" for no.
The third character inhibits tracks for random selection - "1" if inhibited and "0" if not.
##### Definition:
```python
@property
def additional_info(self):
    ...
@additional_info.setter
def additional_info(self, value):
    ...
```

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/album.md

#### album property

Gets or sets the album name.
This value is represented by the EAL field.
##### Definition:
```python
@property
def album(self):
    ...
@album.setter
def album(self, value):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/artist.md

#### artist property

Gets or sets the artist name.
This value is represented by the EAR field.
##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/author.md

#### author property

Gets or sets the author.
This value is represented by the AUT field.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/get.md

#### get(self, id)

Gets the value of the field with the specified id.

##### Returns

The value if the tag contains a field with the specified id; otherwise, null.

```python

def get(self, id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | System.String | The id of the field. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lyrics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/lyrics.md

#### lyrics property

Gets or sets the lyrics.
This value is represented by the LYR field.
##### Definition:
```python
@property
def lyrics(self):
    ...
@lyrics.setter
def lyrics(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/remove.md

#### remove(self, id)

Removes the field with the specified id.

```python

def remove(self, id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | System.String | The field identifier. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/set.md

#### set(self, field)

Adds or replaces the specified Lyrics3 field.

```python

def set(self, field):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| field | groupdocs.metadata.formats.audio.LyricsField | The field to be set. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list of all fields contained in the Lyrics3 tag.

```python

def to_list(self):
    ...
```

### track property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/track.md

#### track property

Gets or sets the track title.
This value is represented by the ETT field.
##### Definition:
```python
@property
def track(self):
    ...
@track.setter
def track(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/lyricstag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MP3RootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage.md

#### MP3RootPackage class

Represents the root package allowing working with metadata in an MP3 audio.

**Inheritance:** `MP3RootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The MP3RootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| mpeg_audio_package | Gets the MPEG audio metadata package. |
| id3v1 | Gets or sets the ID3v1 metadata tag.
<br/>Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1). |
| id3v2 | Gets or sets the ID3v2 metadata tag. |
| lyrics_3v2 | Gets or sets the Lyrics3v2 metadata tag. |
| ape_v2 | Gets the APE v2 metadata. |
| xmp_package | Gets or sets the XMP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_ape_v2(self)` | Removes the APEv2 audio tag. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### ape_v2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/ape_v2.md

#### ape_v2 property

Gets the APE v2 metadata.

##### Example

This example demonstrates how to read the APEv2 tag in an MP3 file.
##### Definition:
```python
@property
def ape_v2(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### id3v1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/id3v1.md

#### id3v1 property

Gets or sets the ID3v1 metadata tag.
Please find more information at [http://id3.org/ID3v1](http://id3.org/ID3v1).

##### Remarks

The ID3(v1) tag is a small chunk of extra data at the end of an MP3 file.

##### Example

This code sample shows how to update the ID3v1 tag in an MP3 file.
##### Definition:
```python
@property
def id3v1(self):
    ...
@id3v1.setter
def id3v1(self, value):
    ...
```

### id3v2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/id3v2.md

#### id3v2 property

Gets or sets the ID3v2 metadata tag.

##### Example

The code sample shows how to update the ID3v2 tag in an MP3 file.
##### Definition:
```python
@property
def id3v2(self):
    ...
@id3v2.setter
def id3v2(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lyrics_3v2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/lyrics_3v2.md

#### lyrics_3v2 property

Gets or sets the Lyrics3v2 metadata tag.

##### Example

This example shows how to update the Lyrics tag in an MP3 file
##### Definition:
```python
@property
def lyrics_3v2(self):
    ...
@lyrics_3v2.setter
def lyrics_3v2(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mpeg_audio_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/mpeg_audio_package.md

#### mpeg_audio_package property

Gets the MPEG audio metadata package.

##### Example

This example demonstrates how to read MPEG audio metadata from an MP3 file.
##### Definition:
```python
@property
def mpeg_audio_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_ape_v2 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/remove_ape_v2.md

#### remove_ape_v2(self)

Removes the APEv2 audio tag.

```python

def remove_ape_v2(self):
    ...
```

##### Remarks

This feature is not available in trial mode.
##### Example

This example shows how to remove the APEv2 tag from an MP3 file.

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/mp3rootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### WavPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage.md

#### WavPackage class

Represents a native metadata package in a WAV audio file.

**Inheritance:** `WavPackage` →
`CustomPackage` →
`MetadataPackage`

The WavPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `WavPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| audio_format | Gets the audio format.
<br/>PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression. |
| number_of_channels | Gets the number of channels. |
| sample_rate | Gets the sample rate. |
| byte_rate | Gets the byte rate. |
| block_align | Gets the block align. |
| bits_per_sample | Gets the bits per sample value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract technical audio information from a WAV file.

### WavPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `WavPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### audio_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/audio_format.md

#### audio_format property

Gets the audio format.
PCM = 1 (i.e. Linear quantization). Values other than 1 indicate some form of compression.
##### Definition:
```python
@property
def audio_format(self):
    ...
```

### bits_per_sample property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/bits_per_sample.md

#### bits_per_sample property

Gets the bits per sample value.
##### Definition:
```python
@property
def bits_per_sample(self):
    ...
```

### block_align property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/block_align.md

#### block_align property

Gets the block align.
##### Definition:
```python
@property
def block_align(self):
    ...
```

### byte_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/byte_rate.md

#### byte_rate property

Gets the byte rate.
##### Definition:
```python
@property
def byte_rate(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### number_of_channels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/number_of_channels.md

#### number_of_channels property

Gets the number of channels.
##### Definition:
```python
@property
def number_of_channels(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sample_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/sample_rate.md

#### sample_rate property

Gets the sample rate.
##### Definition:
```python
@property
def sample_rate(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WavRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage.md

#### WavRootPackage class

Represents the root package allowing working with metadata in a WAV audio.

**Inheritance:** `WavRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The WavRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| wav_package | Gets the WAV native metadata package. |
| riff_info_package | Gets the package containing RIFF Info tags. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

##### Example

This code sample shows how to extract technical audio information from a WAV file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### riff_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/riff_info_package.md

#### riff_info_package property

Gets the package containing RIFF Info tags.
##### Definition:
```python
@property
def riff_info_package(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### wav_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/wav_package.md

#### wav_package property

Gets the WAV native metadata package.
##### Definition:
```python
@property
def wav_package(self):
    ...
```

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.audio/wavrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### groupdocs.metadata.formats.businesscard
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard.md

The namespace contains classes intended to work with electronic business card formats.

##### Classes
| Class | Description |
| :- | :- |
| `VCardAgentRecord` | Represents vCard Agent record metadata class. |
| `VCardBasePackage` | Represents the base VCard metadata class. |
| `VCardBinaryRecord` | Represents vCard binary record metadata class. |
| `VCardCalendarRecordset` | Represents a set of Calendar vCard records. |
| `VCardCard` | Represents a single card extracted from a VCard file. |
| `VCardCommunicationRecordset` | Represents a set of Communication vCard records.
<br/>These properties describe information about how to communicate with the object the vCard represents. |
| `VCardCustomRecord` | Represents vCard custom record metadata class. |
| `VCardDateTimeRecord` | Represents vCard date time record metadata class. |
| `VCardDeliveryAddressingRecordset` | Represents a set of Delivery Addressing vCard records.
<br/>These types are concerned with information related to
<br/>the delivery addressing or label for the vCard object. |
| `VCardExplanatoryRecordset` | Represents a set of Explanatory vCard records.
<br/>These properties are concerned with additional explanations,
<br/>such as that related to informational notes or revisions specific to the vCard. |
| `VCardGeneralRecordset` | Represents a set of General vCard records. |
| `VCardGeographicalRecordset` | Represents a set of Geographical vCard records.
<br/>These properties are concerned with information associated with
<br/>geographical positions or regions associated with the object the vCard represents. |
| `VCardIdentificationRecordset` | Represents a set of Identification vCard records.
<br/>These types are used to capture information associated with
<br/>the identification and naming of the entity associated with the vCard. |
| `VCardOrganizationalRecordset` | Represents a set of Organizational vCard records.
<br/>These properties are concerned with information associated with
<br/>characteristics of the organization or organizational units of
<br/>the object that the vCard represents. |
| `VCardPackage` | Represents VCF (Virtual Contact File) electronic business card format metadata. |
| `VCardRecord` | Represents abstract vCard record metadata class. |
| `VCardRecordset` | Provides a base vCard record union class. |
| `VCardRootPackage` | Represents the root package allowing working with metadata in a VCard file. |
| `VCardSecurityRecordset` | Represents a set of Security vCard records.
<br/>These properties are concerned with the security of
<br/>communication pathways or access to the vCard. |
| `VCardTextRecord` | Represents vCard text record metadata class. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `VCardContentType` | Defines vCard record content types. |

### VCardAgentRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord.md

#### VCardAgentRecord class

Represents vCard Agent record metadata class.

**Inheritance:** `VCardAgentRecord` →
`VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardAgentRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |
| value | Gets the record value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/value.md

#### value property

Gets the record value.
##### Definition:
```python
@property
def value(self):
    ...
```

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardagentrecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### VCardBasePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage.md

#### VCardBasePackage class

Represents the base VCard metadata class.

**Inheritance:** `VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardBasePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbasepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardBinaryRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord.md

#### VCardBinaryRecord class

Represents vCard binary record metadata class.

**Inheritance:** `VCardBinaryRecord` →
`VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardBinaryRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |
| value | Gets the record value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/value.md

#### value property

Gets the record value.
##### Definition:
```python
@property
def value(self):
    ...
```

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardbinaryrecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### VCardCalendarRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset.md

#### VCardCalendarRecordset class

Represents a set of Calendar vCard records.

**Inheritance:** `VCardCalendarRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardCalendarRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| busy_time_records | Gets the URIs for the busy time associated with the object. |
| busy_time_entries | Gets the URIs for the busy time associated with the object. |
| calendar_address_records | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| calendar_addresses | Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard. |
| calendar_uri_records | Gets the URIs for the calendar associated with the object represented by the vCard. |
| uri_calendar_entries | Gets the URIs for the calendar associated with the object represented by the vCard. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### busy_time_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/busy_time_entries.md

#### busy_time_entries property

Gets the URIs for the busy time associated with the object.

##### Remarks

This property is a simplified version of `VCardCalendarRecordset.busy_time_records`.
##### Definition:
```python
@property
def busy_time_entries(self):
    ...
```

### busy_time_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/busy_time_records.md

#### busy_time_records property

Gets the URIs for the busy time associated with the object.
##### Definition:
```python
@property
def busy_time_records(self):
    ...
```

### calendar_address_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendar_address_records.md

#### calendar_address_records property

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.
##### Definition:
```python
@property
def calendar_address_records(self):
    ...
```

### calendar_addresses property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendar_addresses.md

#### calendar_addresses property

Gets the calendar user addresses to which a scheduling request should be sent for the object represented by the vCard.

##### Remarks

This property is a simplified version of `VCardCalendarRecordset.calendar_address_records`.
##### Definition:
```python
@property
def calendar_addresses(self):
    ...
```

### calendar_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/calendar_uri_records.md

#### calendar_uri_records property

Gets the URIs for the calendar associated with the object represented by the vCard.
##### Definition:
```python
@property
def calendar_uri_records(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### uri_calendar_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcalendarrecordset/uri_calendar_entries.md

#### uri_calendar_entries property

Gets the URIs for the calendar associated with the object represented by the vCard.

##### Remarks

This property is a simplified version of `VCardCalendarRecordset.calendar_uri_records`.
##### Definition:
```python
@property
def uri_calendar_entries(self):
    ...
```

### VCardCard class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard.md

#### VCardCard class

Represents a single card extracted from a VCard file.

**Inheritance:** `VCardCard` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardCard type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| general_recordset | Gets the general records. |
| identification_recordset | Gets the identification records. |
| delivery_addressing_recordset | Gets the delivery addressing records. |
| communication_recordset | Gets the communication records. |
| geographical_recordset | Gets the geographical records. |
| organizational_recordset | Gets the organizational records. |
| explanatory_recordset | Gets the explanatory records. |
| security_recordset | Gets the security records. |
| calendar_recordset | Gets the calendar records. |
| extension_records | Gets the private extension records. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_available_groups(self)` | Gets the available group names. |
| `filter_by_group(self, group_name)` | Filters all vCard records by the group name passed as a parameter.
<br/>For more information please see the `VCardCard.get_available_groups` method. |
| `filter_home_tags(self)` | Filters all vCard records marked with the HOME tag. |
| `filter_work_tags(self)` | Filters all vCard records marked with the WORK tag. |
| `filter_preferred(self)` | Filters the preferred records. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to use vCard property filters.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### calendar_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/calendar_recordset.md

#### calendar_recordset property

Gets the calendar records.
##### Definition:
```python
@property
def calendar_recordset(self):
    ...
```

### communication_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/communication_recordset.md

#### communication_recordset property

Gets the communication records.
##### Definition:
```python
@property
def communication_recordset(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### delivery_addressing_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/delivery_addressing_recordset.md

#### delivery_addressing_recordset property

Gets the delivery addressing records.
##### Definition:
```python
@property
def delivery_addressing_recordset(self):
    ...
```

### explanatory_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/explanatory_recordset.md

#### explanatory_recordset property

Gets the explanatory records.
##### Definition:
```python
@property
def explanatory_recordset(self):
    ...
```

### extension_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/extension_records.md

#### extension_records property

Gets the private extension records.
##### Definition:
```python
@property
def extension_records(self):
    ...
```

### filter_by_group method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/filter_by_group.md

#### filter_by_group(self, group_name)

Filters all vCard records by the group name passed as a parameter.
For more information please see the `VCardCard.get_available_groups` method.

##### Returns

The filtered vCard instance.

```python

def filter_by_group(self, group_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| group_name | System.String | The name of the group. |

### filter_home_tags method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/filter_home_tags.md

#### filter_home_tags(self)

Filters all vCard records marked with the HOME tag.

##### Returns

The filtered vCard instance.

```python

def filter_home_tags(self):
    ...
```

### filter_preferred method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/filter_preferred.md

#### filter_preferred(self)

Filters the preferred records.

##### Returns

The filtered vCard instance.

```python

def filter_preferred(self):
    ...
```

### filter_work_tags method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/filter_work_tags.md

#### filter_work_tags(self)

Filters all vCard records marked with the WORK tag.

##### Returns

Filtered vCard instance.

```python

def filter_work_tags(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### general_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/general_recordset.md

#### general_recordset property

Gets the general records.
##### Definition:
```python
@property
def general_recordset(self):
    ...
```

### geographical_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/geographical_recordset.md

#### geographical_recordset property

Gets the geographical records.
##### Definition:
```python
@property
def geographical_recordset(self):
    ...
```

### get_available_groups method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/get_available_groups.md

#### get_available_groups(self)

Gets the available group names.

##### Returns

The available group names.

```python

def get_available_groups(self):
    ...
```

### identification_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/identification_recordset.md

#### identification_recordset property

Gets the identification records.
##### Definition:
```python
@property
def identification_recordset(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### organizational_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/organizational_recordset.md

#### organizational_recordset property

Gets the organizational records.
##### Definition:
```python
@property
def organizational_recordset(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### security_recordset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/security_recordset.md

#### security_recordset property

Gets the security records.
##### Definition:
```python
@property
def security_recordset(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcard/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardCommunicationRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset.md

#### VCardCommunicationRecordset class

Represents a set of Communication vCard records.
These properties describe information about how to communicate with the object the vCard represents.

**Inheritance:** `VCardCommunicationRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardCommunicationRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| telephone_records | Gets the telephone numbers for telephony communication with the object. |
| telephones | Gets the telephone numbers for telephony communication with the object. |
| email_records | Gets the electronic mail addresses for communication with the object. |
| emails | Gets the electronic mail addresses for communication with the object. |
| mailer | Gets the type of the electronic mail software that is used by the individual associated with the vCard. |
| impp_records | Gets the URIs for instant messaging and presence protocol communications with the object. |
| impp_entries | Gets the URIs for instant messaging and presence protocol communications with the object. |
| language_records | Gets the languages that may be used for contacting the object. |
| languages | Gets the languages that may be used for contacting the object. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### email_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/email_records.md

#### email_records property

Gets the electronic mail addresses for communication with the object.
##### Definition:
```python
@property
def email_records(self):
    ...
```

### emails property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/emails.md

#### emails property

Gets the electronic mail addresses for communication with the object.

##### Remarks

This property is a simplified version of `VCardCommunicationRecordset.email_records`.
##### Definition:
```python
@property
def emails(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### impp_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/impp_entries.md

#### impp_entries property

Gets the URIs for instant messaging and presence protocol communications with the object.

##### Remarks

This property is a simplified version of `VCardCommunicationRecordset.impp_records`.
##### Definition:
```python
@property
def impp_entries(self):
    ...
```

### impp_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/impp_records.md

#### impp_records property

Gets the URIs for instant messaging and presence protocol communications with the object.
##### Definition:
```python
@property
def impp_records(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/language_records.md

#### language_records property

Gets the languages that may be used for contacting the object.
##### Definition:
```python
@property
def language_records(self):
    ...
```

### languages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/languages.md

#### languages property

Gets the languages that may be used for contacting the object.

##### Remarks

This property is a simplified version of `VCardCommunicationRecordset.language_records`.
##### Definition:
```python
@property
def languages(self):
    ...
```

### mailer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/mailer.md

#### mailer property

Gets the type of the electronic mail software that is used by the individual associated with the vCard.
##### Definition:
```python
@property
def mailer(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### telephone_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/telephone_records.md

#### telephone_records property

Gets the telephone numbers for telephony communication with the object.
##### Definition:
```python
@property
def telephone_records(self):
    ...
```

### telephones property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/telephones.md

#### telephones property

Gets the telephone numbers for telephony communication with the object.

##### Remarks

This property is a simplified version of `VCardCommunicationRecordset.telephone_records`.
##### Definition:
```python
@property
def telephones(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcommunicationrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardContentType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcontenttype.md

#### VCardContentType enumeration

Defines vCard record content types.

The VCardContentType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CUSTOM | The custom content type. |
| TEXT | The text content type. |
| BINARY | The binary content type. |
| DATE_TIME | The date time content type. |
| AGENT | The agent content type. |

### VCardCustomRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord.md

#### VCardCustomRecord class

Represents vCard custom record metadata class.

**Inheritance:** `VCardCustomRecord` →
`VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardCustomRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |
| value | Gets the record value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/value.md

#### value property

Gets the record value.
##### Definition:
```python
@property
def value(self):
    ...
```

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardcustomrecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### VCardDateTimeRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord.md

#### VCardDateTimeRecord class

Represents vCard date time record metadata class.

**Inheritance:** `VCardDateTimeRecord` →
`VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardDateTimeRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |
| value | Gets the record value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/value.md

#### value property

Gets the record value.
##### Definition:
```python
@property
def value(self):
    ...
```

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddatetimerecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### VCardDeliveryAddressingRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset.md

#### VCardDeliveryAddressingRecordset class

Represents a set of Delivery Addressing vCard records.
These types are concerned with information related to
the delivery addressing or label for the vCard object.

**Inheritance:** `VCardDeliveryAddressingRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardDeliveryAddressingRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| address_records | Gets the components of the delivery address of the object. |
| addresses | Gets the components of the delivery address of the object. |
| label_records | Gets an array containing the formatted text corresponding to delivery address of the object. |
| labels | Gets an array containing the formatted text corresponding to delivery address of the object. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### address_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/address_records.md

#### address_records property

Gets the components of the delivery address of the object.
##### Definition:
```python
@property
def address_records(self):
    ...
```

### addresses property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/addresses.md

#### addresses property

Gets the components of the delivery address of the object.

##### Remarks

This property is a simplified version of `VCardDeliveryAddressingRecordset.address_records`.
##### Definition:
```python
@property
def addresses(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### label_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/label_records.md

#### label_records property

Gets an array containing the formatted text corresponding to delivery address of the object.
##### Definition:
```python
@property
def label_records(self):
    ...
```

### labels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/labels.md

#### labels property

Gets an array containing the formatted text corresponding to delivery address of the object.

##### Remarks

This property is a simplified version of `VCardDeliveryAddressingRecordset.label_records`.
##### Definition:
```python
@property
def labels(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcarddeliveryaddressingrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardExplanatoryRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset.md

#### VCardExplanatoryRecordset class

Represents a set of Explanatory vCard records.
These properties are concerned with additional explanations,
such as that related to informational notes or revisions specific to the vCard.

**Inheritance:** `VCardExplanatoryRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardExplanatoryRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| category_records | Gets the application category information about the vCard, also known as "tags". |
| categories | Gets the application category information about the vCard, also known as "tags". |
| note_records | Gets the supplemental information or comments that are associated with the vCard. |
| notes | Gets the supplemental information or comments that are associated with the vCard. |
| product_identifier_record | Gets the identifier of the product that created the vCard object. |
| product_identifier | Gets the identifier of the product that created the vCard object. |
| revision | Gets the revision information about the current vCard. |
| sort_string | Gets the family name or given name text to be used for national-language-specific sorting of the `VCardIdentificationRecordset.formatted_names` and `VCardIdentificationRecordset.name` types. |
| sound_records | Gets the digital sound content information that annotates some aspects of the vCard. |
| sound_binary_records | Gets the digital sound content information that annotates some aspects of the vCard. |
| binary_sounds | Gets the digital sound content information that annotates some aspects of the vCard. |
| sound_uri_records | Gets the digital sound content information that annotates some aspects of the vCard. |
| uri_sounds | Gets the digital sound content information that annotates some aspects of the vCard. |
| uid_record | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| uid | Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard. |
| pid_identifier_records | Gets the global meaning of the local PID source identifier. |
| pid_identifiers | Gets the global meaning of the local PID source identifier. |
| url_records | Gets an array of URLs pointing to websites that represent the person in some way. |
| urls | Gets an array of URLs pointing to websites that represent the person in some way. |
| version | Gets the version of the vCard specification. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### binary_sounds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/binary_sounds.md

#### binary_sounds property

Gets the digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.sound_binary_records`.
##### Definition:
```python
@property
def binary_sounds(self):
    ...
```

### categories property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/categories.md

#### categories property

Gets the application category information about the vCard, also known as "tags".

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.category_records`.
##### Definition:
```python
@property
def categories(self):
    ...
```

### category_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/category_records.md

#### category_records property

Gets the application category information about the vCard, also known as "tags".
##### Definition:
```python
@property
def category_records(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### note_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/note_records.md

#### note_records property

Gets the supplemental information or comments that are associated with the vCard.
##### Definition:
```python
@property
def note_records(self):
    ...
```

### notes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/notes.md

#### notes property

Gets the supplemental information or comments that are associated with the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.note_records`.
##### Definition:
```python
@property
def notes(self):
    ...
```

### pid_identifier_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/pid_identifier_records.md

#### pid_identifier_records property

Gets the global meaning of the local PID source identifier.
##### Definition:
```python
@property
def pid_identifier_records(self):
    ...
```

### pid_identifiers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/pid_identifiers.md

#### pid_identifiers property

Gets the global meaning of the local PID source identifier.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.pid_identifier_records`.
##### Definition:
```python
@property
def pid_identifiers(self):
    ...
```

### product_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/product_identifier.md

#### product_identifier property

Gets the identifier of the product that created the vCard object.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.product_identifier_record`.
##### Definition:
```python
@property
def product_identifier(self):
    ...
```

### product_identifier_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/product_identifier_record.md

#### product_identifier_record property

Gets the identifier of the product that created the vCard object.
##### Definition:
```python
@property
def product_identifier_record(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/revision.md

#### revision property

Gets the revision information about the current vCard.
##### Definition:
```python
@property
def revision(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sort_string property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sort_string.md

#### sort_string property

Gets the family name or given name text to be used for national-language-specific sorting of the `VCardIdentificationRecordset.formatted_names` and `VCardIdentificationRecordset.name` types.
##### Definition:
```python
@property
def sort_string(self):
    ...
```

### sound_binary_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sound_binary_records.md

#### sound_binary_records property

Gets the digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.sound_records`.
##### Definition:
```python
@property
def sound_binary_records(self):
    ...
```

### sound_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sound_records.md

#### sound_records property

Gets the digital sound content information that annotates some aspects of the vCard.
##### Definition:
```python
@property
def sound_records(self):
    ...
```

### sound_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/sound_uri_records.md

#### sound_uri_records property

Gets the digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.sound_records`.
##### Definition:
```python
@property
def sound_uri_records(self):
    ...
```

### uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/uid.md

#### uid property

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.uid_record`.
##### Definition:
```python
@property
def uid(self):
    ...
```

### uid_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/uid_record.md

#### uid_record property

Gets the value that represents a globally unique identifier corresponding to the individual or resource associated with the vCard.
##### Definition:
```python
@property
def uid_record(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### uri_sounds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/uri_sounds.md

#### uri_sounds property

Gets the digital sound content information that annotates some aspects of the vCard.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.sound_uri_records`.
##### Definition:
```python
@property
def uri_sounds(self):
    ...
```

### url_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/url_records.md

#### url_records property

Gets an array of URLs pointing to websites that represent the person in some way.
##### Definition:
```python
@property
def url_records(self):
    ...
```

### urls property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/urls.md

#### urls property

Gets an array of URLs pointing to websites that represent the person in some way.

##### Remarks

This property is a simplified version of `VCardExplanatoryRecordset.url_records`.
##### Definition:
```python
@property
def urls(self):
    ...
```

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardexplanatoryrecordset/version.md

#### version property

Gets the version of the vCard specification.
##### Definition:
```python
@property
def version(self):
    ...
```

### VCardGeneralRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset.md

#### VCardGeneralRecordset class

Represents a set of General vCard records.

**Inheritance:** `VCardGeneralRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardGeneralRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| source_records | Gets the array of sources of directory information contained in the content type. |
| sources | Gets an array containing the sources of the directory information contained in the content type. |
| name_of_source | Gets the textual representation of the SOURCE property. |
| kind | Gets the kind of the object. |
| xml_records | Gets an array containing extended XML-encoded vCard data. |
| xml_entries | Gets an array containing extended XML-encoded vCard data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### kind property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/kind.md

#### kind property

Gets the kind of the object.
##### Definition:
```python
@property
def kind(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_of_source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/name_of_source.md

#### name_of_source property

Gets the textual representation of the SOURCE property.
##### Definition:
```python
@property
def name_of_source(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### source_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/source_records.md

#### source_records property

Gets the array of sources of directory information contained in the content type.
##### Definition:
```python
@property
def source_records(self):
    ...
```

### sources property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/sources.md

#### sources property

Gets an array containing the sources of the directory information contained in the content type.

##### Remarks

This property is a simplified version of `VCardGeneralRecordset.source_records`.
##### Definition:
```python
@property
def sources(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_entries property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/xml_entries.md

#### xml_entries property

Gets an array containing extended XML-encoded vCard data.

##### Remarks

This property is a simplified version of `VCardGeneralRecordset.xml_records`.
##### Definition:
```python
@property
def xml_entries(self):
    ...
```

### xml_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeneralrecordset/xml_records.md

#### xml_records property

Gets an array containing extended XML-encoded vCard data.
##### Definition:
```python
@property
def xml_records(self):
    ...
```

### VCardGeographicalRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset.md

#### VCardGeographicalRecordset class

Represents a set of Geographical vCard records.
These properties are concerned with information associated with
geographical positions or regions associated with the object the vCard represents.

**Inheritance:** `VCardGeographicalRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardGeographicalRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| time_zone_records | Gets the time zones of the object. |
| time_zones | Gets the time zones of the object. |
| geographic_position_records | Gets the information related to the global positioning of the object. |
| geographic_positions | Gets the information related to the global positioning of the object. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### geographic_position_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/geographic_position_records.md

#### geographic_position_records property

Gets the information related to the global positioning of the object.
##### Definition:
```python
@property
def geographic_position_records(self):
    ...
```

### geographic_positions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/geographic_positions.md

#### geographic_positions property

Gets the information related to the global positioning of the object.

##### Remarks

This property is a simplified version of `VCardGeographicalRecordset.geographic_position_records`.
##### Definition:
```python
@property
def geographic_positions(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### time_zone_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/time_zone_records.md

#### time_zone_records property

Gets the time zones of the object.
##### Definition:
```python
@property
def time_zone_records(self):
    ...
```

### time_zones property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/time_zones.md

#### time_zones property

Gets the time zones of the object.

##### Remarks

This property is a simplified version of `VCardGeographicalRecordset.time_zone_records`.
##### Definition:
```python
@property
def time_zones(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardgeographicalrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardIdentificationRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset.md

#### VCardIdentificationRecordset class

Represents a set of Identification vCard records.
These types are used to capture information associated with
the identification and naming of the entity associated with the vCard.

**Inheritance:** `VCardIdentificationRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardIdentificationRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| formatted_name_records | Gets an array containing the formatted text corresponding to the name of the object. |
| formatted_names | Gets an array containing the formatted text corresponding to the name of the object. |
| name_record | Gets the components of the name of the object. |
| name | Gets the components of the name of the object. |
| nickname_records | Gets an array containing the text corresponding to the nickname of the object. |
| nicknames | Gets an array containing the text corresponding to the nickname of the object. |
| photo_records | Gets an array containing the image or photograph information that annotates some aspects of the object. |
| photo_binary_records | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| binary_photos | Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object. |
| photo_uri_records | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| uri_photos | Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object. |
| birthdate_records | Gets an array containing the birth date of the object in different representations. |
| birthdate_date_time_record | Gets the birth date of the object. |
| date_time_birthdate | Gets the birth date of the object. |
| birthdate_text_records | Gets an array containing the birth date of the object in different text representations. |
| text_birthdates | Gets an array containing the birth date of the object in different text representations. |
| anniversary_record | Gets the date of marriage, or equivalent, of the object. |
| anniversary_date_time_record | Gets the date of marriage represented as a single date-and-or-time value. |
| date_time_anniversary | Gets the date of marriage represented as a single date-and-or-time value. |
| anniversary_text_record | Gets the date of marriage represented as a single text value. |
| text_anniversary | Gets the date of marriage represented as a single text value. |
| gender_record | Gets the components of the sex and gender identity of the object. |
| gender | Gets the components of the sex and gender identity of the object. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### anniversary_date_time_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversary_date_time_record.md

#### anniversary_date_time_record property

Gets the date of marriage represented as a single date-and-or-time value.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.anniversary_record`.
##### Definition:
```python
@property
def anniversary_date_time_record(self):
    ...
```

### anniversary_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversary_record.md

#### anniversary_record property

Gets the date of marriage, or equivalent, of the object.
##### Definition:
```python
@property
def anniversary_record(self):
    ...
```

### anniversary_text_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/anniversary_text_record.md

#### anniversary_text_record property

Gets the date of marriage represented as a single text value.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.anniversary_record`.
##### Definition:
```python
@property
def anniversary_text_record(self):
    ...
```

### binary_photos property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/binary_photos.md

#### binary_photos property

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.photo_binary_records`.
##### Definition:
```python
@property
def binary_photos(self):
    ...
```

### birthdate_date_time_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdate_date_time_record.md

#### birthdate_date_time_record property

Gets the birth date of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.birthdate_records`.
##### Definition:
```python
@property
def birthdate_date_time_record(self):
    ...
```

### birthdate_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdate_records.md

#### birthdate_records property

Gets an array containing the birth date of the object in different representations.
##### Definition:
```python
@property
def birthdate_records(self):
    ...
```

### birthdate_text_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/birthdate_text_records.md

#### birthdate_text_records property

Gets an array containing the birth date of the object in different text representations.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.birthdate_records`.
##### Definition:
```python
@property
def birthdate_text_records(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_time_anniversary property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/date_time_anniversary.md

#### date_time_anniversary property

Gets the date of marriage represented as a single date-and-or-time value.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.anniversary_date_time_record`.
##### Definition:
```python
@property
def date_time_anniversary(self):
    ...
```

### date_time_birthdate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/date_time_birthdate.md

#### date_time_birthdate property

Gets the birth date of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.birthdate_date_time_record`.
##### Definition:
```python
@property
def date_time_birthdate(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### formatted_name_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/formatted_name_records.md

#### formatted_name_records property

Gets an array containing the formatted text corresponding to the name of the object.
##### Definition:
```python
@property
def formatted_name_records(self):
    ...
```

### formatted_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/formatted_names.md

#### formatted_names property

Gets an array containing the formatted text corresponding to the name of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.formatted_name_records`.
##### Definition:
```python
@property
def formatted_names(self):
    ...
```

### gender property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/gender.md

#### gender property

Gets the components of the sex and gender identity of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.gender_record`.
##### Definition:
```python
@property
def gender(self):
    ...
```

### gender_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/gender_record.md

#### gender_record property

Gets the components of the sex and gender identity of the object.
##### Definition:
```python
@property
def gender_record(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/name.md

#### name property

Gets the components of the name of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.name_record`.
##### Definition:
```python
@property
def name(self):
    ...
```

### name_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/name_record.md

#### name_record property

Gets the components of the name of the object.
##### Definition:
```python
@property
def name_record(self):
    ...
```

### nickname_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/nickname_records.md

#### nickname_records property

Gets an array containing the text corresponding to the nickname of the object.
##### Definition:
```python
@property
def nickname_records(self):
    ...
```

### nicknames property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/nicknames.md

#### nicknames property

Gets an array containing the text corresponding to the nickname of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.nickname_records`.
##### Definition:
```python
@property
def nicknames(self):
    ...
```

### photo_binary_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photo_binary_records.md

#### photo_binary_records property

Gets an array containing the image or photograph information represented as binary data that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.photo_records`.
##### Definition:
```python
@property
def photo_binary_records(self):
    ...
```

### photo_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photo_records.md

#### photo_records property

Gets an array containing the image or photograph information that annotates some aspects of the object.
##### Definition:
```python
@property
def photo_records(self):
    ...
```

### photo_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/photo_uri_records.md

#### photo_uri_records property

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.photo_records`.
##### Definition:
```python
@property
def photo_uri_records(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text_anniversary property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/text_anniversary.md

#### text_anniversary property

Gets the date of marriage represented as a single text value.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.anniversary_text_record`.
##### Definition:
```python
@property
def text_anniversary(self):
    ...
```

### text_birthdates property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/text_birthdates.md

#### text_birthdates property

Gets an array containing the birth date of the object in different text representations.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.birthdate_text_records`.
##### Definition:
```python
@property
def text_birthdates(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### uri_photos property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardidentificationrecordset/uri_photos.md

#### uri_photos property

Gets an array containing the image or photograph information represented by URIs that annotates some aspects of the object.

##### Remarks

This property is a simplified version of `VCardIdentificationRecordset.photo_uri_records`.
##### Definition:
```python
@property
def uri_photos(self):
    ...
```

### VCardOrganizationalRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset.md

#### VCardOrganizationalRecordset class

Represents a set of Organizational vCard records.
These properties are concerned with information associated with
characteristics of the organization or organizational units of
the object that the vCard represents.

**Inheritance:** `VCardOrganizationalRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardOrganizationalRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| title_records | Gets the positions or jobs of the object. |
| titles | Gets the positions or jobs of the object. |
| role_records | Gets the functions or parts played in a particular situation by the object. |
| roles | Gets the functions or parts played in a particular situation by the object. |
| logo_records | Gets the graphic images of the logo associated with the object. |
| logo_binary_records | Gets the graphic images of the logo associated with the object. |
| binary_logos | Gets the graphic images of the logo associated with the object. |
| logo_uri_records | Gets the URIs of the graphic images of the logo associated with the object. |
| uri_logos | Gets the URIs of the graphic images of the logo associated with the object. |
| agent_records | Gets the information about another person who will act on behalf of the vCard object. |
| agent_object_record | Gets the information about another person who will act on behalf of the vCard object. |
| object_agent | Gets the information about another person who will act on behalf of the vCard object. |
| agent_uri_records | Gets the information about another person who will act on behalf of the vCard object. |
| uri_agents | Gets the information about another person who will act on behalf of the vCard object. |
| organization_name_records | Gets the organizational names and units associated with the object. |
| organization_names | Gets the organizational names and units associated with the object. |
| member_records | Gets the members in the group this vCard represents. |
| members | Gets the members in the group this vCard represents. |
| relationship_records | Gets the relationships between another entity and the entity represented by this vCard. |
| relationships | Gets the relationships between another entity and the entity represented by this vCard. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### agent_object_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agent_object_record.md

#### agent_object_record property

Gets the information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.agent_records`.
##### Definition:
```python
@property
def agent_object_record(self):
    ...
```

### agent_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agent_records.md

#### agent_records property

Gets the information about another person who will act on behalf of the vCard object.
##### Definition:
```python
@property
def agent_records(self):
    ...
```

### agent_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/agent_uri_records.md

#### agent_uri_records property

Gets the information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.agent_records`.
##### Definition:
```python
@property
def agent_uri_records(self):
    ...
```

### binary_logos property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/binary_logos.md

#### binary_logos property

Gets the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.logo_binary_records`.
##### Definition:
```python
@property
def binary_logos(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### logo_binary_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logo_binary_records.md

#### logo_binary_records property

Gets the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.logo_records`.
##### Definition:
```python
@property
def logo_binary_records(self):
    ...
```

### logo_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logo_records.md

#### logo_records property

Gets the graphic images of the logo associated with the object.
##### Definition:
```python
@property
def logo_records(self):
    ...
```

### logo_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/logo_uri_records.md

#### logo_uri_records property

Gets the URIs of the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.logo_records`.
##### Definition:
```python
@property
def logo_uri_records(self):
    ...
```

### member_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/member_records.md

#### member_records property

Gets the members in the group this vCard represents.
##### Definition:
```python
@property
def member_records(self):
    ...
```

### members property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/members.md

#### members property

Gets the members in the group this vCard represents.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.member_records`.
##### Definition:
```python
@property
def members(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### object_agent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/object_agent.md

#### object_agent property

Gets the information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.agent_object_record`.
##### Definition:
```python
@property
def object_agent(self):
    ...
```

### organization_name_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/organization_name_records.md

#### organization_name_records property

Gets the organizational names and units associated with the object.
##### Definition:
```python
@property
def organization_name_records(self):
    ...
```

### organization_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/organization_names.md

#### organization_names property

Gets the organizational names and units associated with the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.organization_name_records`.
##### Definition:
```python
@property
def organization_names(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### relationship_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/relationship_records.md

#### relationship_records property

Gets the relationships between another entity and the entity represented by this vCard.
##### Definition:
```python
@property
def relationship_records(self):
    ...
```

### relationships property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/relationships.md

#### relationships property

Gets the relationships between another entity and the entity represented by this vCard.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.relationship_records`.
##### Definition:
```python
@property
def relationships(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### role_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/role_records.md

#### role_records property

Gets the functions or parts played in a particular situation by the object.
##### Definition:
```python
@property
def role_records(self):
    ...
```

### roles property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/roles.md

#### roles property

Gets the functions or parts played in a particular situation by the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.title_records`.
##### Definition:
```python
@property
def roles(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/title_records.md

#### title_records property

Gets the positions or jobs of the object.
##### Definition:
```python
@property
def title_records(self):
    ...
```

### titles property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/titles.md

#### titles property

Gets the positions or jobs of the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.title_records`.
##### Definition:
```python
@property
def titles(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### uri_agents property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/uri_agents.md

#### uri_agents property

Gets the information about another person who will act on behalf of the vCard object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.agent_uri_records`.
##### Definition:
```python
@property
def uri_agents(self):
    ...
```

### uri_logos property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardorganizationalrecordset/uri_logos.md

#### uri_logos property

Gets the URIs of the graphic images of the logo associated with the object.

##### Remarks

This property is a simplified version of `VCardOrganizationalRecordset.logo_uri_records`.
##### Definition:
```python
@property
def uri_logos(self):
    ...
```

### VCardPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage.md

#### VCardPackage class

Represents VCF (Virtual Contact File) electronic business card format metadata.

**Inheritance:** `VCardPackage` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| cards | Gets an array of the cards extracted from the file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### cards property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/cards.md

#### cards property

Gets an array of the cards extracted from the file.
##### Definition:
```python
@property
def cards(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord.md

#### VCardRecord class

Represents abstract vCard record metadata class.

**Inheritance:** `VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### VCardRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset.md

#### VCardRecordset class

Provides a base vCard record union class.

**Inheritance:** `VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### VCardRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage.md

#### VCardRootPackage class

Represents the root package allowing working with metadata in a VCard file.

**Inheritance:** `VCardRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The VCardRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| v_card_package | Gets the VCard metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to read metadata properties of a vCard file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### v_card_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardrootpackage/v_card_package.md

#### v_card_package property

Gets the VCard metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract vCard fields along with descriptive parameters.
##### Definition:
```python
@property
def v_card_package(self):
    ...
```

### VCardSecurityRecordset class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset.md

#### VCardSecurityRecordset class

Represents a set of Security vCard records.
These properties are concerned with the security of
communication pathways or access to the vCard.

**Inheritance:** `VCardSecurityRecordset` →
`VCardRecordset` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardSecurityRecordset type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| access_classification | Gets the sensitivity of the information in the vCard. |
| public_key_records | Gets the public keys or authentication certificates associated with the object. |
| public_key_binary_records | Gets the public keys or authentication certificates associated with the object. |
| binary_public_keys | Gets the public keys or authentication certificates associated with the object. |
| public_key_uri_records | Gets the public keys or authentication certificates associated with the object. |
| uri_public_keys | Gets the public keys or authentication certificates associated with the object. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### access_classification property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/access_classification.md

#### access_classification property

Gets the sensitivity of the information in the vCard.
##### Definition:
```python
@property
def access_classification(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### binary_public_keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/binary_public_keys.md

#### binary_public_keys property

Gets the public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `VCardSecurityRecordset.public_key_binary_records`.
##### Definition:
```python
@property
def binary_public_keys(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### public_key_binary_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/public_key_binary_records.md

#### public_key_binary_records property

Gets the public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `VCardSecurityRecordset.public_key_records`.
##### Definition:
```python
@property
def public_key_binary_records(self):
    ...
```

### public_key_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/public_key_records.md

#### public_key_records property

Gets the public keys or authentication certificates associated with the object.
##### Definition:
```python
@property
def public_key_records(self):
    ...
```

### public_key_uri_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/public_key_uri_records.md

#### public_key_uri_records property

Gets the public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `VCardSecurityRecordset.public_key_records`.
##### Definition:
```python
@property
def public_key_uri_records(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### uri_public_keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardsecurityrecordset/uri_public_keys.md

#### uri_public_keys property

Gets the public keys or authentication certificates associated with the object.

##### Remarks

This property is a simplified version of `VCardSecurityRecordset.public_key_uri_records`.
##### Definition:
```python
@property
def uri_public_keys(self):
    ...
```

### VCardTextRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord.md

#### VCardTextRecord class

Represents vCard text record metadata class.

**Inheritance:** `VCardTextRecord` →
`VCardRecord` →
`VCardBasePackage` →
`CustomPackage` →
`MetadataPackage`

The VCardTextRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| group | Gets the grouping value. |
| value_parameters | Gets the value parameters. |
| pref_parameter | Gets the preferred parameter. |
| alt_id_parameter | Gets the alternative representations parameter value. |
| type_parameters | Gets the type parameter values. |
| encoding_parameter | Gets the encoding parameter value. |
| language_parameter | Gets the language parameter value. |
| anonym_parameters | Gets the anonymous parameters. |
| content_type | Gets the content type of record. |
| type_name | Gets the type of the record. |
| media_type_parameter | Gets the media type parameter value. |
| charset_parameter | Gets the charset parameter. |
| value | Gets the record value. |
| is_quoted_printable | Gets a value indicating whether this instance is quoted printable string. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_readability_value(self, code_page_name)` | Gets the readability value. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alt_id_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/alt_id_parameter.md

#### alt_id_parameter property

Gets the alternative representations parameter value.

##### Remarks

Used to "tag" property instances as being alternative representations of the same logical property.
##### Definition:
```python
@property
def alt_id_parameter(self):
    ...
```

### anonym_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/anonym_parameters.md

#### anonym_parameters property

Gets the anonymous parameters.
##### Definition:
```python
@property
def anonym_parameters(self):
    ...
```

### charset_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/charset_parameter.md

#### charset_parameter property

Gets the charset parameter.
##### Definition:
```python
@property
def charset_parameter(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/content_type.md

#### content_type property

Gets the content type of record.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/encoding_parameter.md

#### encoding_parameter property

Gets the encoding parameter value.
##### Definition:
```python
@property
def encoding_parameter(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_readability_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/get_readability_value.md

#### get_readability_value(self, code_page_name)

Gets the readability value.

##### Returns

The readability value.

```python

def get_readability_value(self, code_page_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| code_page_name | System.String | The using encoding code page name or null for ASCII encoding. |

### group property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/group.md

#### group property

Gets the grouping value.
##### Definition:
```python
@property
def group(self):
    ...
```

### is_quoted_printable property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/is_quoted_printable.md

#### is_quoted_printable property

Gets a value indicating whether this instance is quoted printable string.
##### Definition:
```python
@property
def is_quoted_printable(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/language_parameter.md

#### language_parameter property

Gets the language parameter value.
##### Definition:
```python
@property
def language_parameter(self):
    ...
```

### media_type_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/media_type_parameter.md

#### media_type_parameter property

Gets the media type parameter value.

##### Remarks

Used with properties whose value is a URI. It provides a hint to the vCard consumer application about the media type [RFC2046] of the
resource identified by the URI.
##### Definition:
```python
@property
def media_type_parameter(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pref_parameter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/pref_parameter.md

#### pref_parameter property

Gets the preferred parameter.

##### Remarks

Used to indicate that the corresponding instance of a property is preferred by the vCard author.
##### Definition:
```python
@property
def pref_parameter(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/type_name.md

#### type_name property

Gets the type of the record.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### type_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/type_parameters.md

#### type_parameters property

Gets the type parameter values.

##### Remarks

The type parameter has multiple, different uses. In general, it is a way of specifying class characteristics of the associated property.
##### Definition:
```python
@property
def type_parameters(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/value.md

#### value property

Gets the record value.
##### Definition:
```python
@property
def value(self):
    ...
```

### value_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.businesscard/vcardtextrecord/value_parameters.md

#### value_parameters property

Gets the value parameters.

##### Remarks

Used to identify the value type (data type) and format of the value.
##### Definition:
```python
@property
def value_parameters(self):
    ...
```

### groupdocs.metadata.formats.cad
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad.md

The namespace contains classes for working with CAD (computer-aided design) formats.

##### Classes
| Class | Description |
| :- | :- |
| `CadCustomPropertyPackage` | Represents a collection of custom CAD metadata properties. |
| `CadPackage` | Represents CAD (Computer-aided design) metadata. |
| `CadRootPackage` | Represents the root package allowing working with metadata in a CAD drawing. |
| `DwgRootPackage` | Represents the root package allowing working with metadata in a DWG drawing. |
| `DxfRootPackage` | Represents the root package allowing working with metadata in a DXF drawing. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `CadAcadVersion` | Defines AutoCAD drawing database version numbers. |

### CadAcadVersion enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadacadversion.md

#### CadAcadVersion enumeration

Defines AutoCAD drawing database version numbers.

The CadAcadVersion type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Non-versioned. |
| AC1006 | AutoCAD drawing database R10. |
| AC1009 | AutoCAD drawing database R11 and R12. |
| AC1012 | AutoCAD drawing database R13. |
| AC1014 | AutoCAD drawing database R14. |
| AC1015 | AutoCAD drawing database AutoCAD 2000. |
| AC1018 | AutoCAD drawing database AutoCAD 2004. |
| AC1021 | AutoCAD drawing database AutoCAD 2007. |
| AC1024 | AutoCAD drawing database AutoCAD 2010. |
| AC1027 | AutoCAD drawing database AutoCAD 2013. |
| AC1032 | AutoCAD drawing database AutoCAD 2018. |

### CadCustomPropertyPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage.md

#### CadCustomPropertyPackage class

Represents a collection of custom CAD metadata properties.

**Inheritance:** `CadCustomPropertyPackage` →
`CustomPackage` →
`MetadataPackage`

The CadCustomPropertyPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadcustompropertypackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CadPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage.md

#### CadPackage class

Represents CAD (Computer-aided design) metadata.

**Inheritance:** `CadPackage` →
`CustomPackage` →
`MetadataPackage`

The CadPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| acad_version | Gets the AutoCAD drawing database version number. |
| height | Gets the drawing height. |
| width | Gets the drawing width. |
| author | Gets the drawing author. |
| comments | Gets the user comments. |
| hyperlink_base | Gets the hyperlink base. |
| keywords | Gets the keywords. |
| last_saved_by | Gets the name of the last editor. |
| revision_number | Gets the revision number. |
| subject | Gets the subject. |
| title | Gets the title. |
| created_date_time | Gets the date and time when the drawing was created. |
| modified_date_time | Gets the date and time when the drawing was modified. |
| custom_properties | Gets the package containing custom metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### acad_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/acad_version.md

#### acad_version property

Gets the AutoCAD drawing database version number.
##### Definition:
```python
@property
def acad_version(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/author.md

#### author property

Gets the drawing author.
##### Definition:
```python
@property
def author(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/comments.md

#### comments property

Gets the user comments.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/created_date_time.md

#### created_date_time property

Gets the date and time when the drawing was created.
##### Definition:
```python
@property
def created_date_time(self):
    ...
```

### custom_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/custom_properties.md

#### custom_properties property

Gets the package containing custom metadata properties.
##### Definition:
```python
@property
def custom_properties(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/height.md

#### height property

Gets the drawing height.
##### Definition:
```python
@property
def height(self):
    ...
```

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/hyperlink_base.md

#### hyperlink_base property

Gets the hyperlink base.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/keywords.md

#### keywords property

Gets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
```

### last_saved_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/last_saved_by.md

#### last_saved_by property

Gets the name of the last editor.
##### Definition:
```python
@property
def last_saved_by(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modified_date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/modified_date_time.md

#### modified_date_time property

Gets the date and time when the drawing was modified.
##### Definition:
```python
@property
def modified_date_time(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/revision_number.md

#### revision_number property

Gets the revision number.
##### Definition:
```python
@property
def revision_number(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/subject.md

#### subject property

Gets the subject.
##### Definition:
```python
@property
def subject(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/title.md

#### title property

Gets the title.
##### Definition:
```python
@property
def title(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadpackage/width.md

#### width property

Gets the drawing width.
##### Definition:
```python
@property
def width(self):
    ...
```

### CadRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage.md

#### CadRootPackage class

Represents the root package allowing working with metadata in a CAD drawing.

**Inheritance:** `CadRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The CadRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| cad_package | Gets the CAD metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read metadata of a CAD drawing.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### cad_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/cad_package.md

#### cad_package property

Gets the CAD metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def cad_package(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/cadrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DwgRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage.md

#### DwgRootPackage class

Represents the root package allowing working with metadata in a DWG drawing.

**Inheritance:** `DwgRootPackage` →
`CadRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DwgRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| cad_package | Gets the CAD metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### cad_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/cad_package.md

#### cad_package property

Gets the CAD metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def cad_package(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dwgrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DxfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage.md

#### DxfRootPackage class

Represents the root package allowing working with metadata in a DXF drawing.

**Inheritance:** `DxfRootPackage` →
`CadRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DxfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| cad_package | Gets the CAD metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### cad_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/cad_package.md

#### cad_package property

Gets the CAD metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def cad_package(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.cad/dxfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.document
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document.md

The namespace provides functionality intended to work with a variety of document formats such as spreadsheets, presentations, text processing formats, etc.

##### Classes
| Class | Description |
| :- | :- |
| `DiagramPackage` | Represents a native metadata package in a diagram format. |
| `DiagramRootPackage` | Represents the root package intended to work with metadata in a diagram. |
| `DiagramTypePackage` | Represents a metadata package containing diagram-specific file format information. |
| `DocumentPackage` | Represents native metadata in an office document. |
| `DocumentStatistics` | Represents a set of document statistics. |
| `NoteInspectionPackage` | Represents a metadata package exposing the internal structure of a note section. |
| `NotePage` | Represents a page in a OneNote section. |
| `NoteRootPackage` | Represents the root package intended to work with metadata in an electronic note file. |
| `PdfAnnotation` | Represents an annotation in a PDF document. |
| `PdfAttachment` | Represents an attachment in a PDF document. |
| `PdfBookmark` | Represents a bookmark in a PDF document. |
| `PdfFormField` | Represents a form field in a PDF document. |
| `PdfInspectionPackage` | Contains information about PDF document parts that can be considered as metadata in some cases. |
| `PdfPackage` | Represents native metadata in a PDF document. |
| `PdfRootPackage` | Represents the root package allowing working with metadata in a PDF document. |
| `PdfTypePackage` | Represents a metadata package containing PDF-specific file format information. |
| `PresentationComment` | Represents a user comment in a presentation. |
| `PresentationInspectionPackage` | Contains information about presentation parts that can be considered as metadata in some cases. |
| `PresentationPackage` | Represents a native metadata package in a presentation. |
| `PresentationRootPackage` | Represents the root package intended to work with metadata in a presentation. |
| `PresentationSlide` | Represents a slide in a presentation. |
| `PresentationTypePackage` | Represents a metadata package containing presentation-specific file format information. |
| `ProjectManagementPackage` | Represents a native metadata package in a project management file. |
| `ProjectManagementRootPackage` | Represents the root package intended to work with metadata in a project management format. |
| `SpreadsheetComment` | Represents a user comment in a spreadsheet. |
| `SpreadsheetContentTypePackage` | Represents a metadata package containing spreadsheet content type properties. |
| `SpreadsheetContentTypeProperty` | Represents a content type property in a spreadsheet. |
| `SpreadsheetInspectionPackage` | Contains information about spreadsheet parts that can be considered as metadata in some cases. |
| `SpreadsheetPackage` | Represents a native metadata package in a spreadsheet. |
| `SpreadsheetRootPackage` | Represents the root package allowing working with metadata in a spreadsheet. |
| `SpreadsheetSheet` | Represents a sheet in a spreadsheet document. |
| `SpreadsheetTypePackage` | Represents a metadata package containing spreadsheet-specific file format information. |
| `WordProcessingComment` | Represents a comment in a word processing document. |
| `WordProcessingField` | Represents a field in a word processing document. |
| `WordProcessingInspectionPackage` | Contains information about document parts that can be considered as metadata in some cases. |
| `WordProcessingPackage` | Represents a native metadata package in a word processing document. |
| `WordProcessingRevision` | Represents a revision (tracked change) in a document. |
| `WordProcessingRootPackage` | Represents the root package allowing working with metadata in a word processing document. |
| `WordProcessingTypePackage` | Represents a metadata package containing document-specific file format information. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `DiagramFormat` | Defines various diagram subformats. |
| `PresentationFormat` | Defines various presentation subformats. |
| `SpreadsheetFormat` | Defines various spreadsheet subformats. |
| `WordProcessingFormat` | Defines various word processing document subformats. |
| `WordProcessingRevisionType` | Specifies the type of the change being tracked by a revision. |

### DiagramFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramformat.md

#### DiagramFormat enumeration

Defines various diagram subformats.

The DiagramFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The format is not recognized. |
| VDX | Represents the .VDX Visio format.
<br/>Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension.
<br/>A Visio drawing XML file is created in Visio software, which is developed by Microsoft.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/vdx/). |
| VSD | Represents the .VSD Visio format.
<br/>VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these.
<br/>Such drawings can contain visual objects such as visual objects, flow charts, UML diagram, information flow, organizational charts,
<br/>software diagrams, network layout, database models, objects mapping and other similar information.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/vsd/). |
| VSDX | Represents the .VSDX Visio format.
<br/>Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards.
<br/>It was developed to replace the binary file format, .VSD, which is supported by earlier versions of Microsoft Visio.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/vsdx/). |
| VSS | Represents the .VSS Visio format.
<br/>VSS are stencil files created with Microsoft Visio 2007 and earlier.
<br/>A relatively new file format is .VSSX that was introduced with Microsoft Visio 2013. Stencil files provide drawing objects that can be included in a .VSD Visio drawing.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/vss/). |
| VSX | Represents the .VSX Visio format.
<br/>Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio.
<br/>VSX files are saved in XML file format and was supported till Visio 2013.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/vsx/). |

### DiagramPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage.md

#### DiagramPackage class

Represents a native metadata package in a diagram format.

**Inheritance:** `DiagramPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The DiagramPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| alternate_names | Gets or sets the alternate names for the document. Can be updated in VDX and VSX formats only. |
| build_number_created | Gets the full build number of the instance used to create the document. |
| build_number_edited | Gets the build number of the instance last used to edit the document. |
| category | Gets or sets the descriptive text for the type of drawing, such as flowchart or office layout.
<br/>This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box. |
| company | Gets or sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for.
<br/>Maximum length is 63 characters. |
| creator | Gets or sets the person who created or last updated the file.
<br/>The maximum length is 63 characters.. |
| description | Gets or sets a descriptive text string for the document.
<br/>Use this element to store important information about the document, such as its purpose, recent changes, or pending changes.
<br/>The maximum is 191 characters. |
| hyperlink_base | Gets or sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram).
<br/>By default, a hyperlink path is relative to the current document unless a different path is specified in this element.
<br/>Maximum length is 256 characters. |
| keywords | Gets or sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number.
<br/>The maximum string length is 63 characters. |
| language | Gets or sets the language of the document.
<br/>Can be updated in VSD and VSDX formats only. |
| manager | Gets or sets a user-entered text string identifying the person in charge of the project or department.
<br/>The maximum length is 63 characters. |
| preview_picture | Gets or sets the preview picture. |
| subject | Gets or sets a user-defined text string that describes the contents of the document.
<br/>Maximum length is 63 characters. |
| template | Gets or sets a string value specifying the file name of the template from which the document was created. |
| time_created | Gets or sets a date and time value indicating when the document was created. |
| time_edited | Gets a date and time value indicating when the document was last edited. |
| time_printed | Gets a date and time value indicating when the document was last printed. |
| time_saved | Gets a date and time value indicating when the document was last saved. |
| title | Gets or sets a user-defined text string that serves as a descriptive title for the document.
<br/>Maximum length is 63 characters. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract built-in metadata properties from a diagram.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternate_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/alternate_names.md

#### alternate_names property

Gets or sets the alternate names for the document. Can be updated in VDX and VSX formats only.
##### Definition:
```python
@property
def alternate_names(self):
    ...
@alternate_names.setter
def alternate_names(self, value):
    ...
```

### build_number_created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/build_number_created.md

#### build_number_created property

Gets the full build number of the instance used to create the document.
##### Definition:
```python
@property
def build_number_created(self):
    ...
```

### build_number_edited property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/build_number_edited.md

#### build_number_edited property

Gets the build number of the instance last used to edit the document.
##### Definition:
```python
@property
def build_number_edited(self):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/category.md

#### category property

Gets or sets the descriptive text for the type of drawing, such as flowchart or office layout.
This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/company.md

#### company property

Gets or sets the user-entered information identifying the company creating the drawing or the company the drawing is being created for.
Maximum length is 63 characters.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/creator.md

#### creator property

Gets or sets the person who created or last updated the file.
The maximum length is 63 characters..
##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/description.md

#### description property

Gets or sets a descriptive text string for the document.
Use this element to store important information about the document, such as its purpose, recent changes, or pending changes.
The maximum is 191 characters.
##### Definition:
```python
@property
def description(self):
    ...
@description.setter
def description(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/hyperlink_base.md

#### hyperlink_base property

Gets or sets the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram).
By default, a hyperlink path is relative to the current document unless a different path is specified in this element.
Maximum length is 256 characters.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
@hyperlink_base.setter
def hyperlink_base(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/keywords.md

#### keywords property

Gets or sets a text string that identifies topics or other important information about the file, such as project name, client name, or version number.
The maximum string length is 63 characters.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/language.md

#### language property

Gets or sets the language of the document.
Can be updated in VSD and VSDX formats only.
##### Definition:
```python
@property
def language(self):
    ...
@language.setter
def language(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/manager.md

#### manager property

Gets or sets a user-entered text string identifying the person in charge of the project or department.
The maximum length is 63 characters.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### preview_picture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/preview_picture.md

#### preview_picture property

Gets or sets the preview picture.
##### Definition:
```python
@property
def preview_picture(self):
    ...
@preview_picture.setter
def preview_picture(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | bool | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | float | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.DateTime | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/subject.md

#### subject property

Gets or sets a user-defined text string that describes the contents of the document.
Maximum length is 63 characters.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/template.md

#### template property

Gets or sets a string value specifying the file name of the template from which the document was created.
##### Definition:
```python
@property
def template(self):
    ...
@template.setter
def template(self, value):
    ...
```

### time_created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/time_created.md

#### time_created property

Gets or sets a date and time value indicating when the document was created.
##### Definition:
```python
@property
def time_created(self):
    ...
@time_created.setter
def time_created(self, value):
    ...
```

### time_edited property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/time_edited.md

#### time_edited property

Gets a date and time value indicating when the document was last edited.
##### Definition:
```python
@property
def time_edited(self):
    ...
```

### time_printed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/time_printed.md

#### time_printed property

Gets a date and time value indicating when the document was last printed.
##### Definition:
```python
@property
def time_printed(self):
    ...
```

### time_saved property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/time_saved.md

#### time_saved property

Gets a date and time value indicating when the document was last saved.
##### Definition:
```python
@property
def time_saved(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/title.md

#### title property

Gets or sets a user-defined text string that serves as a descriptive title for the document.
Maximum length is 63 characters.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagrampackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DiagramRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage.md

#### DiagramRootPackage class

Represents the root package intended to work with metadata in a diagram.

**Inheritance:** `DiagramRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DiagramRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| document_statistics | Gets the document statistics package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code sample demonstrates how to update built-in metadata properties in a diagram document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample shows how to detect the exact type of a loaded diagram and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DiagramTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage.md

#### DiagramTypePackage class

Represents a metadata package containing diagram-specific file format information.

**Inheritance:** `DiagramTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The DiagramTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| diagram_format | Gets the exact diagram format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### diagram_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/diagram_format.md

#### diagram_format property

Gets the exact diagram format.
##### Definition:
```python
@property
def diagram_format(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/diagramtypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DocumentPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage.md

#### DocumentPackage class

Represents native metadata in an office document.

**Inheritance:** `DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The DocumentPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DocumentStatistics class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics.md

#### DocumentStatistics class

Represents a set of document statistics.

**Inheritance:** `DocumentStatistics` →
`CustomPackage` →
`MetadataPackage`

The DocumentStatistics type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `DocumentStatistics` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| character_count | Gets an estimated number of characters in the document. |
| word_count | Gets an estimated number of words in the document. |
| page_count | Gets an estimated number of pages in the document. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### DocumentStatistics constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `DocumentStatistics` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### character_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/character_count.md

#### character_count property

Gets an estimated number of characters in the document.
##### Definition:
```python
@property
def character_count(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/page_count.md

#### page_count property

Gets an estimated number of pages in the document.
##### Definition:
```python
@property
def page_count(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### word_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/documentstatistics/word_count.md

#### word_count property

Gets an estimated number of words in the document.
##### Definition:
```python
@property
def word_count(self):
    ...
```

### NoteInspectionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage.md

#### NoteInspectionPackage class

Represents a metadata package exposing the internal structure of a note section.

**Inheritance:** `NoteInspectionPackage` →
`CustomPackage` →
`MetadataPackage`

The NoteInspectionPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| pages | Gets an array of section pages. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/pages.md

#### pages property

Gets an array of section pages.
##### Definition:
```python
@property
def pages(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noteinspectionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### NotePage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage.md

#### NotePage class

Represents a page in a OneNote section.

**Inheritance:** `NotePage` →
`CustomPackage` →
`MetadataPackage`

The NotePage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets the page author. |
| title | Gets the page title. |
| creation_time | Gets the creation time. |
| last_modification_time | Gets the last modification time. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/author.md

#### author property

Gets the page author.
##### Definition:
```python
@property
def author(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/creation_time.md

#### creation_time property

Gets the creation time.
##### Definition:
```python
@property
def creation_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### last_modification_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/last_modification_time.md

#### last_modification_time property

Gets the last modification time.
##### Definition:
```python
@property
def last_modification_time(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/title.md

#### title property

Gets the page title.
##### Definition:
```python
@property
def title(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/notepage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### NoteRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage.md

#### NoteRootPackage class

Represents the root package intended to work with metadata in an electronic note file.

**Inheritance:** `NoteRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The NoteRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| inspection_package | Gets a metadata package containing inspection results for the document.
<br/>The package contains information about document parts that can be considered as metadata in some cases. |
| document_statistics | Gets the document statistics package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to inspect a note document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### inspection_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/inspection_package.md

#### inspection_package property

Gets a metadata package containing inspection results for the document.
The package contains information about document parts that can be considered as metadata in some cases.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def inspection_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/noterootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfAnnotation class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation.md

#### PdfAnnotation class

Represents an annotation in a PDF document.

**Inheritance:** `PdfAnnotation` →
`CustomPackage` →
`MetadataPackage`

The PdfAnnotation type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| text | Gets the annotation text. |
| name | Gets the name of the annotation. |
| page_number | Gets the number of the page containing the annotation. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/name.md

#### name property

Gets the name of the annotation.
##### Definition:
```python
@property
def name(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/page_number.md

#### page_number property

Gets the number of the page containing the annotation.
##### Definition:
```python
@property
def page_number(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/text.md

#### text property

Gets the annotation text.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfannotation/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfAttachment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment.md

#### PdfAttachment class

Represents an attachment in a PDF document.

**Inheritance:** `PdfAttachment` →
`CustomPackage` →
`MetadataPackage`

The PdfAttachment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the attachment name. |
| description | Gets the attachment description. |
| mime_type | Gets the MIME type of the attachment. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/description.md

#### description property

Gets the attachment description.
##### Definition:
```python
@property
def description(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/mime_type.md

#### mime_type property

Gets the MIME type of the attachment.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/name.md

#### name property

Gets the attachment name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfattachment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfBookmark class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark.md

#### PdfBookmark class

Represents a bookmark in a PDF document.

**Inheritance:** `PdfBookmark` →
`CustomPackage` →
`MetadataPackage`

The PdfBookmark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| title | Gets the title of the bookmark. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/title.md

#### title property

Gets the title of the bookmark.
##### Definition:
```python
@property
def title(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfbookmark/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfFormField class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield.md

#### PdfFormField class

Represents a form field in a PDF document.

**Inheritance:** `PdfFormField` →
`CustomPackage` →
`MetadataPackage`

The PdfFormField type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the name of the field. |
| value | Gets the field value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/name.md

#### name property

Gets the name of the field.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfformfield/value.md

#### value property

Gets the field value.
##### Definition:
```python
@property
def value(self):
    ...
```

### PdfInspectionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage.md

#### PdfInspectionPackage class

Contains information about PDF document parts that can be considered as metadata in some cases.

**Inheritance:** `PdfInspectionPackage` →
`CustomPackage` →
`MetadataPackage`

The PdfInspectionPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| annotations | Gets an array of the annotations. |
| attachments | Gets an array of the attachments. |
| bookmarks | Gets an array of the bookmarks. |
| fields | Gets an array of the form fields. |
| digital_signatures | Gets an array of the digital signatures. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_annotations(self)` | Removes all detected annotations from the document. |
| `clear_attachments(self)` | Removes all detected attachments from the document. |
| `clear_bookmarks(self)` | Removes all detected bookmarks from the document. |
| `clear_fields(self)` | Removes all detected form fields from the document. |
| `clear_digital_signatures(self)` | Removes all detected digital signatures from the document. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to remove the inspection properties in a PDF document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### annotations property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/annotations.md

#### annotations property

Gets an array of the annotations.
##### Definition:
```python
@property
def annotations(self):
    ...
```

### attachments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/attachments.md

#### attachments property

Gets an array of the attachments.
##### Definition:
```python
@property
def attachments(self):
    ...
```

### bookmarks property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/bookmarks.md

#### bookmarks property

Gets an array of the bookmarks.
##### Definition:
```python
@property
def bookmarks(self):
    ...
```

### clear_annotations method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/clear_annotations.md

#### clear_annotations(self)

Removes all detected annotations from the document.

```python

def clear_annotations(self):
    ...
```

### clear_attachments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/clear_attachments.md

#### clear_attachments(self)

Removes all detected attachments from the document.

```python

def clear_attachments(self):
    ...
```

### clear_bookmarks method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/clear_bookmarks.md

#### clear_bookmarks(self)

Removes all detected bookmarks from the document.

```python

def clear_bookmarks(self):
    ...
```

### clear_digital_signatures method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/clear_digital_signatures.md

#### clear_digital_signatures(self)

Removes all detected digital signatures from the document.

```python

def clear_digital_signatures(self):
    ...
```

### clear_fields method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/clear_fields.md

#### clear_fields(self)

Removes all detected form fields from the document.

```python

def clear_fields(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_signatures property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/digital_signatures.md

#### digital_signatures property

Gets an array of the digital signatures.
##### Definition:
```python
@property
def digital_signatures(self):
    ...
```

### fields property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/fields.md

#### fields property

Gets an array of the form fields.
##### Definition:
```python
@property
def fields(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfinspectionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage.md

#### PdfPackage class

Represents native metadata in a PDF document.

**Inheritance:** `PdfPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The PdfPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets or sets the document author. |
| created_date | Gets or sets the date of document creation. |
| creator | Gets the creator of the document. |
| keywords | Gets or sets the keywords. |
| modified_date | Gets or sets the date of the last modification. |
| producer | Gets the document producer. |
| subject | Gets or sets the subject of the document. |
| title | Gets or sets the title of the document. |
| trapped_flag | Gets or sets the trapped flag. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet demonstrates how to update built-in metadata properties in a PDF document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/author.md

#### author property

Gets or sets the document author.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/created_date.md

#### created_date property

Gets or sets the date of document creation.
##### Definition:
```python
@property
def created_date(self):
    ...
@created_date.setter
def created_date(self, value):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/creator.md

#### creator property

Gets the creator of the document.
##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modified_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/modified_date.md

#### modified_date property

Gets or sets the date of the last modification.
##### Definition:
```python
@property
def modified_date(self):
    ...
@modified_date.setter
def modified_date(self, value):
    ...
```

### producer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/producer.md

#### producer property

Gets the document producer.
##### Definition:
```python
@property
def producer(self):
    ...
@producer.setter
def producer(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/subject.md

#### subject property

Gets or sets the subject of the document.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/title.md

#### title property

Gets or sets the title of the document.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### trapped_flag property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/trapped_flag.md

#### trapped_flag property

Gets or sets the trapped flag.
##### Definition:
```python
@property
def trapped_flag(self):
    ...
@trapped_flag.setter
def trapped_flag(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PdfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage.md

#### PdfRootPackage class

Represents the root package allowing working with metadata in a PDF document.

**Inheritance:** `PdfRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The PdfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| inspection_package | Gets a metadata package containing inspection results for the document.
<br/>The package contains information about document parts that can be considered as metadata in some cases. |
| document_statistics | Gets the document statistics package. |
| xmp_package | Gets or sets the XMP metadata package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

##### Example

This code sample shows how to extract built-in metadata properties from a PDF document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to obtain the text statistics for a PDF document.
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code snippet shows how to detect the PDF version a loaded document and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### inspection_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/inspection_package.md

#### inspection_package property

Gets a metadata package containing inspection results for the document.
The package contains information about document parts that can be considered as metadata in some cases.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to inspect a PDF document.
##### Definition:
```python
@property
def inspection_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdfrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### PdfTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage.md

#### PdfTypePackage class

Represents a metadata package containing PDF-specific file format information.

**Inheritance:** `PdfTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The PdfTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| version | Gets the version of the format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/pdftypepackage/version.md

#### version property

Gets the version of the format.
##### Definition:
```python
@property
def version(self):
    ...
```

### PresentationComment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment.md

#### PresentationComment class

Represents a user comment in a presentation.

**Inheritance:** `PresentationComment` →
`CustomPackage` →
`MetadataPackage`

The PresentationComment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets the author of the comment. |
| created_time | Gets the created time of the comment. |
| slide_number | Gets the slide number the comment belongs to. |
| text | Gets the text of the comment. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/author.md

#### author property

Gets the author of the comment.
##### Definition:
```python
@property
def author(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/created_time.md

#### created_time property

Gets the created time of the comment.
##### Definition:
```python
@property
def created_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### slide_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/slide_number.md

#### slide_number property

Gets the slide number the comment belongs to.
##### Definition:
```python
@property
def slide_number(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/text.md

#### text property

Gets the text of the comment.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationcomment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PresentationFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationformat.md

#### PresentationFormat enumeration

Defines various presentation subformats.

The PresentationFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The format is not recognized. |
| PPT | Represents the .PPT PowerPoint format.
<br/>A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow.
<br/>It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. A PPT file can contain several different types of information such as text,
<br/>bulleted points, images, multimedia and other embedded OLE objects.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt/). |
| PPTX | Represents the .PPTX PowerPoint format.
<br/>Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
<br/>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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx/). |
| POTM | Represents the .POTM PowerPoint format.
<br/>Files with POTM extension are Microsoft PowerPoint template files with support for Macros.
<br/>POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm/). |
| POTX | Represents the .POTX PowerPoint format.
<br/>Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
<br/>This format was created to replace the POT file format that is based on the binary file format and is supported with PowerPoint 97-2003.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx/). |
| PPTM | Represents the .PPTM PowerPoint format.
<br/>Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
<br/>They are similar to PPTX files with the difference that the lateral can't execute macros though they can contain macros.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm/). |
| PPS | Represents the .PPS PowerPoint format.
<br/>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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps/). |
| PPSX | Represents the .PPSX PowerPoint format.
<br/>PPSX, Power Point Slide Show, files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
<br/>It is an update to the PPS file format that was supported by Microsoft PowerPoint 97-2003 versions.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx/). |
| PPSM | Represents the .PPSM PowerPoint format.
<br/>Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
<br/>Another similar file format is PPTM which differs in opening with Microsoft PowerPoint in editable format instead of running as Slide Show
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm/). |
| POT | Represents the .POT PowerPoint format.
<br/>Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
<br/>Files created with these versions of Microsoft PowerPoint are in binary format as compared to those created in Office OpenXML
<br/>file formats using the higher versions of PowerPoint.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot/). |

### PresentationInspectionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage.md

#### PresentationInspectionPackage class

Contains information about presentation parts that can be considered as metadata in some cases.

**Inheritance:** `PresentationInspectionPackage` →
`CustomPackage` →
`MetadataPackage`

The PresentationInspectionPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| hidden_slides | Gets an array of the hidden slides. |
| comments | Gets an array of the comments. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_comments(self)` | Removes all detected user comments from the presentation. |
| `clear_hidden_slides(self)` | Removes all detected hidden slides from the presentation. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to clean inspection properties in a presentation.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_comments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/clear_comments.md

#### clear_comments(self)

Removes all detected user comments from the presentation.

```python

def clear_comments(self):
    ...
```

### clear_hidden_slides method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/clear_hidden_slides.md

#### clear_hidden_slides(self)

Removes all detected hidden slides from the presentation.

```python

def clear_hidden_slides(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/comments.md

#### comments property

Gets an array of the comments.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hidden_slides property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/hidden_slides.md

#### hidden_slides property

Gets an array of the hidden slides.
##### Definition:
```python
@property
def hidden_slides(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationinspectionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PresentationPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage.md

#### PresentationPackage class

Represents a native metadata package in a presentation.

**Inheritance:** `PresentationPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The PresentationPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| application_template | Gets or sets the application template. |
| author | Gets or sets the document's author. |
| category | Gets or sets the category. |
| comments | Gets or sets the comments. |
| company | Gets or sets the company. |
| content_status | Gets or sets the content status. Can be updated in a PPTX document only. |
| content_type | Gets or sets the content type. Can be updated in a PPTX document only. |
| created_time | Gets or sets the document created date. |
| keywords | Gets or sets the keywords. |
| last_printed_date | Gets or sets the last printed date. |
| last_saved_time | Gets the date and time when the presentation was modified last time. |
| last_saved_by | Gets or sets the name of the last author. |
| manager | Gets or sets the manager. |
| name_of_application | Gets the name of the application created the document. |
| revision_number | Gets or sets the revision number. |
| subject | Gets or sets the subject. |
| title | Gets or sets the title of the document. |
| version | Gets the application version. |
| hyperlink_base | Gets or sets the hyperlink base. |
| presentation_format | Gets the presentation format. |
| shared_doc | Gets or sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only. |
| total_editing_time | Gets or sets the total editing time of the document. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to update built-in metadata properties in a presentation.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### application_template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/application_template.md

#### application_template property

Gets or sets the application template.
##### Definition:
```python
@property
def application_template(self):
    ...
@application_template.setter
def application_template(self, value):
    ...
```

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/author.md

#### author property

Gets or sets the document's author.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/category.md

#### category property

Gets or sets the category.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/comments.md

#### comments property

Gets or sets the comments.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/company.md

#### company property

Gets or sets the company.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/content_status.md

#### content_status property

Gets or sets the content status. Can be updated in a PPTX document only.

##### Remarks

Can be updated in a PPTX document only. Read-only for other supported formats.
##### Definition:
```python
@property
def content_status(self):
    ...
@content_status.setter
def content_status(self, value):
    ...
```

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/content_type.md

#### content_type property

Gets or sets the content type. Can be updated in a PPTX document only.

##### Remarks

Can be updated in a PPTX document only. Read-only for other supported formats.
##### Definition:
```python
@property
def content_type(self):
    ...
@content_type.setter
def content_type(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/created_time.md

#### created_time property

Gets or sets the document created date.
##### Definition:
```python
@property
def created_time(self):
    ...
@created_time.setter
def created_time(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/hyperlink_base.md

#### hyperlink_base property

Gets or sets the hyperlink base.

##### Remarks

Read-only in old PPT.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
@hyperlink_base.setter
def hyperlink_base(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### last_printed_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/last_printed_date.md

#### last_printed_date property

Gets or sets the last printed date.
##### Definition:
```python
@property
def last_printed_date(self):
    ...
@last_printed_date.setter
def last_printed_date(self, value):
    ...
```

### last_saved_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/last_saved_by.md

#### last_saved_by property

Gets or sets the name of the last author.
##### Definition:
```python
@property
def last_saved_by(self):
    ...
@last_saved_by.setter
def last_saved_by(self, value):
    ...
```

### last_saved_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/last_saved_time.md

#### last_saved_time property

Gets the date and time when the presentation was modified last time.
##### Definition:
```python
@property
def last_saved_time(self):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/manager.md

#### manager property

Gets or sets the manager.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_of_application property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/name_of_application.md

#### name_of_application property

Gets the name of the application created the document.
##### Definition:
```python
@property
def name_of_application(self):
    ...
```

### presentation_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/presentation_format.md

#### presentation_format property

Gets the presentation format.
##### Definition:
```python
@property
def presentation_format(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/revision_number.md

#### revision_number property

Gets or sets the revision number.
##### Definition:
```python
@property
def revision_number(self):
    ...
@revision_number.setter
def revision_number(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | bool | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.DateTime | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | int | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | float | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shared_doc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/shared_doc.md

#### shared_doc property

Gets or sets a value indicating whether the presentation is shared between multiple people. Can be updated in a PPTX document only.

##### Remarks

Can be updated in a PPTX document only. Read-only for other formats like PPT, POT etc.
##### Definition:
```python
@property
def shared_doc(self):
    ...
@shared_doc.setter
def shared_doc(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/subject.md

#### subject property

Gets or sets the subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/title.md

#### title property

Gets or sets the title of the document.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### total_editing_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/total_editing_time.md

#### total_editing_time property

Gets or sets the total editing time of the document.
##### Definition:
```python
@property
def total_editing_time(self):
    ...
@total_editing_time.setter
def total_editing_time(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationpackage/version.md

#### version property

Gets the application version.
##### Definition:
```python
@property
def version(self):
    ...
```

### PresentationRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage.md

#### PresentationRootPackage class

Represents the root package intended to work with metadata in a presentation.

**Inheritance:** `PresentationRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The PresentationRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| inspection_package | Gets a metadata package containing inspection results for the document.
<br/>The package contains information about document parts that can be considered as metadata in some cases. |
| document_statistics | Gets the document statistics package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to extract built-in metadata properties from a presentation.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to obtain simple text statistics for a presentation.
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This example demonstrates how to detect the exact type of a presentation and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### inspection_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/inspection_package.md

#### inspection_package property

Gets a metadata package containing inspection results for the document.
The package contains information about document parts that can be considered as metadata in some cases.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to inspect a presentation.
##### Definition:
```python
@property
def inspection_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PresentationSlide class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide.md

#### PresentationSlide class

Represents a slide in a presentation.

**Inheritance:** `PresentationSlide` →
`CustomPackage` →
`MetadataPackage`

The PresentationSlide type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the slide name. |
| number | Gets the slide number. |
| slide_id | Gets the slide id. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/name.md

#### name property

Gets the slide name.
##### Definition:
```python
@property
def name(self):
    ...
```

### number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/number.md

#### number property

Gets the slide number.
##### Definition:
```python
@property
def number(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### slide_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/slide_id.md

#### slide_id property

Gets the slide id.
##### Definition:
```python
@property
def slide_id(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationslide/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PresentationTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage.md

#### PresentationTypePackage class

Represents a metadata package containing presentation-specific file format information.

**Inheritance:** `PresentationTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The PresentationTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| presentation_format | Gets the exact presentation format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### presentation_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/presentation_format.md

#### presentation_format property

Gets the exact presentation format.
##### Definition:
```python
@property
def presentation_format(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/presentationtypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ProjectManagementPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage.md

#### ProjectManagementPackage class

Represents a native metadata package in a project management file.

**Inheritance:** `ProjectManagementPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The ProjectManagementPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets or sets the author of the project. |
| category | Gets or sets the category. |
| comments | Gets or sets the user comments. |
| company | Gets or sets the company. |
| creation_date | Gets or sets the creation date. |
| hyperlink_base | Gets or sets the hyperlink base. |
| keywords | Gets or sets the keywords. |
| last_author | Gets or sets the last author. |
| revision | Gets or sets the revision number. |
| subject | Gets or sets the subject. |
| title | Gets or sets the title. |
| template | Gets or sets the template. |
| manager | Gets or sets the project manager. |
| last_saved | Gets or sets the date when the project was saved last time. |
| save_version | Gets the version of Microsoft Office Project from which a project file was saved. |
| last_printed | Gets or sets the project's last print time. |
| guid | Gets or sets the id of the project. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to update built-in properties in a ProjectManagement document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/author.md

#### author property

Gets or sets the author of the project.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/category.md

#### category property

Gets or sets the category.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/comments.md

#### comments property

Gets or sets the user comments.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/company.md

#### company property

Gets or sets the company.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/creation_date.md

#### creation_date property

Gets or sets the creation date.
##### Definition:
```python
@property
def creation_date(self):
    ...
@creation_date.setter
def creation_date(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### guid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/guid.md

#### guid property

Gets or sets the id of the project.
##### Definition:
```python
@property
def guid(self):
    ...
@guid.setter
def guid(self, value):
    ...
```

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/hyperlink_base.md

#### hyperlink_base property

Gets or sets the hyperlink base.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
@hyperlink_base.setter
def hyperlink_base(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### last_author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/last_author.md

#### last_author property

Gets or sets the last author.
##### Definition:
```python
@property
def last_author(self):
    ...
@last_author.setter
def last_author(self, value):
    ...
```

### last_printed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/last_printed.md

#### last_printed property

Gets or sets the project's last print time.
##### Definition:
```python
@property
def last_printed(self):
    ...
@last_printed.setter
def last_printed(self, value):
    ...
```

### last_saved property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/last_saved.md

#### last_saved property

Gets or sets the date when the project was saved last time.
##### Definition:
```python
@property
def last_saved(self):
    ...
@last_saved.setter
def last_saved(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/manager.md

#### manager property

Gets or sets the project manager.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/revision.md

#### revision property

Gets or sets the revision number.
##### Definition:
```python
@property
def revision(self):
    ...
@revision.setter
def revision(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### save_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/save_version.md

#### save_version property

Gets the version of Microsoft Office Project from which a project file was saved.
##### Definition:
```python
@property
def save_version(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | float | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | bool | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.DateTime | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | int | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/subject.md

#### subject property

Gets or sets the subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/template.md

#### template property

Gets or sets the template.
##### Definition:
```python
@property
def template(self):
    ...
@template.setter
def template(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/title.md

#### title property

Gets or sets the title.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ProjectManagementRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage.md

#### ProjectManagementRootPackage class

Represents the root package intended to work with metadata in a project management format.

**Inheritance:** `ProjectManagementRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The ProjectManagementRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract built-in properties of a ProjectManagement document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/projectmanagementrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetComment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment.md

#### SpreadsheetComment class

Represents a user comment in a spreadsheet.

**Inheritance:** `SpreadsheetComment` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetComment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets the author of the comment. |
| text | Gets the comment text. |
| sheet_number | Gets the sheet number. |
| row | Gets the one-based row index of the comment. |
| column | Gets the one-based column index of the comment. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/author.md

#### author property

Gets the author of the comment.
##### Definition:
```python
@property
def author(self):
    ...
```

### column property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/column.md

#### column property

Gets the one-based column index of the comment.
##### Definition:
```python
@property
def column(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### row property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/row.md

#### row property

Gets the one-based row index of the comment.
##### Definition:
```python
@property
def row(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sheet_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/sheet_number.md

#### sheet_number property

Gets the sheet number.
##### Definition:
```python
@property
def sheet_number(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/text.md

#### text property

Gets the comment text.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcomment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetContentTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage.md

#### SpreadsheetContentTypePackage class

Represents a metadata package containing spreadsheet content type properties.

**Inheritance:** `SpreadsheetContentTypePackage` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetContentTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, property_value)` | Adds or replaces the content type property with the specified name. |
| `set(self, property_name, property_value, property_type)` | Adds or replaces the content type property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes the content type property with the specified name. |
| `clear(self)` | Removes all writable metadata properties. |
| `to_list(self)` | Creates a list from the package. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/clear.md

#### clear(self)

Removes all writable metadata properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/remove.md

#### remove(self, property_name)

Removes the content type property with the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the content type property to be removed. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/set.md

#### set(self, property_name, property_value)

Adds or replaces the content type property with the specified name.

```python

def set(self, property_name, property_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| property_value | System.String | The property value. |

#### set(self, property_name, property_value, property_type)

Adds or replaces the content type property with the specified name.

```python

def set(self, property_name, property_value, property_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| property_value | System.String | The property value. |
| property_type | System.String | The property type. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains properties from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetContentTypeProperty class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty.md

#### SpreadsheetContentTypeProperty class

Represents a content type property in a spreadsheet.

**Inheritance:** `SpreadsheetContentTypeProperty` →
`MetadataProperty`

The SpreadsheetContentTypeProperty type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| spreadsheet_property_type | Gets the type of the property. |
| spreadsheet_property_value | Gets the value of the property. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### spreadsheet_property_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/spreadsheet_property_type.md

#### spreadsheet_property_type property

Gets the type of the property.
##### Definition:
```python
@property
def spreadsheet_property_type(self):
    ...
```

### spreadsheet_property_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/spreadsheet_property_value.md

#### spreadsheet_property_value property

Gets the value of the property.
##### Definition:
```python
@property
def spreadsheet_property_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetcontenttypeproperty/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### SpreadsheetFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetformat.md

#### SpreadsheetFormat enumeration

Defines various spreadsheet subformats.

The SpreadsheetFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The format is not recognized. |
| XLS | Represents the .XLS Excel format.
<br/>Files with XLS extension represent Excel Binary File Format.
<br/>Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers.
<br/>File saved by Excel is known as Workbook where each workbook can have one or more worksheets.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls/). |
| XLSB | Represents the .XLSB Excel format.
<br/>XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
<br/>The content can include unstructured or semi-structured tables of numbers, text, or both numbers and text, formulas, external data connections, charts and images.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb/). |
| XLSX | Represents the .XLSX Excel format.
<br/>XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
<br/>Based on structure organized according to the Open Packaging Conventions as outlined in Part 2 of the OOXML standard ECMA-376,
<br/>the new format is a zip package that contains a number of XML files.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx/). |
| XLSM | Represents the .XLSM Excel format.
<br/>Files with XLSM extension is a type of Spreasheet files that support Macros.
<br/>From application point of view, a Macro is set of instructions that are used for automating processes.
<br/>A macro is used to record the steps that are performed repeatedly and facilitates performing the actions by running the macro again.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm/). |
| XLTX | Represents the .XLTX Excel format.
<br/>Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications.
<br/>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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltx/). |
| XLTM | Represents the .XLTM Excel format.
<br/>The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files.
<br/>XLTM files are similar to XLTX in structure other than that the later doesn't support creating template files with macros.
<br/>Such template files are used to generate and set the layout, formatting, and other settings along with the macros to facilitate creating similar XLSX files then.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm/). |
| ODS | Represents the Opendocument Spreadsheet format.
<br/>Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
<br/>Data is stored inside ODF file into rows and columns.
<br/>It is XML-based format and is one of the several subtypes in the Open Document Formats (ODF) family.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/). |
| XLT | Represents the .XLT Excel format.
<br/>Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite.
<br/>Microsoft Office 97-2003 supported creating new XLT files as well as opening these.
<br/>The latest version of Excel is still capable of opening this old format template files.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt/). |

### SpreadsheetInspectionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage.md

#### SpreadsheetInspectionPackage class

Contains information about spreadsheet parts that can be considered as metadata in some cases.

**Inheritance:** `SpreadsheetInspectionPackage` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetInspectionPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comments | Gets an array of the user comments. |
| hidden_sheets | Gets an array of the hidden sheets. |
| digital_signatures | Gets an array of digital signatures presented in the document. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_comments(self)` | Removes all detected user comments from the spreadsheet. |
| `clear_hidden_sheets(self)` | Removes all detected hidden sheets from the spreadsheet. |
| `clear_digital_signatures(self)` | Removes all detected digital signatures from the spreadsheet. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows hot to remove inspection properties from a spreadsheet.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_comments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/clear_comments.md

#### clear_comments(self)

Removes all detected user comments from the spreadsheet.

```python

def clear_comments(self):
    ...
```

### clear_digital_signatures method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/clear_digital_signatures.md

#### clear_digital_signatures(self)

Removes all detected digital signatures from the spreadsheet.

```python

def clear_digital_signatures(self):
    ...
```

### clear_hidden_sheets method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/clear_hidden_sheets.md

#### clear_hidden_sheets(self)

Removes all detected hidden sheets from the spreadsheet.

```python

def clear_hidden_sheets(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/comments.md

#### comments property

Gets an array of the user comments.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_signatures property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/digital_signatures.md

#### digital_signatures property

Gets an array of digital signatures presented in the document.
##### Definition:
```python
@property
def digital_signatures(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hidden_sheets property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/hidden_sheets.md

#### hidden_sheets property

Gets an array of the hidden sheets.
##### Definition:
```python
@property
def hidden_sheets(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetinspectionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage.md

#### SpreadsheetPackage class

Represents a native metadata package in a spreadsheet.

**Inheritance:** `SpreadsheetPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| language | Gets or sets the document language. |
| author | Gets or sets the document author. |
| category | Gets or sets the category. |
| comments | Gets or sets the comments. |
| company | Gets or sets the company. |
| content_status | Gets or sets the content status. |
| content_type | Gets or sets the content type. |
| created_time | Gets or sets the document created date. |
| total_editing_time | Gets or sets the total editing time in minutes. |
| hyperlink_base | Gets or sets the hyperlink base. |
| keywords | Gets or sets the keywords. |
| last_saved_time | Gets or sets the time of the last saving in UTC. |
| last_printed_date | Gets or sets the last printed date in UTC. |
| last_saved_by | Gets or sets the name of the last author. |
| manager | Gets or sets the manager. |
| name_of_application | Gets or sets the name of application. |
| revision | Gets or sets the document revision number. |
| subject | Gets or sets the subject. |
| template | Gets or sets the document template name. |
| title | Gets or sets the title of the document. |
| version | Gets or sets the version number of the application that created the document. |
| content_type_properties | Gets the metadata package containing the content type properties. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to update built-in metadata properties in a spreadsheet.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/author.md

#### author property

Gets or sets the document author.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/category.md

#### category property

Gets or sets the category.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/comments.md

#### comments property

Gets or sets the comments.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/company.md

#### company property

Gets or sets the company.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/content_status.md

#### content_status property

Gets or sets the content status.
##### Definition:
```python
@property
def content_status(self):
    ...
@content_status.setter
def content_status(self, value):
    ...
```

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/content_type.md

#### content_type property

Gets or sets the content type.
##### Definition:
```python
@property
def content_type(self):
    ...
@content_type.setter
def content_type(self, value):
    ...
```

### content_type_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/content_type_properties.md

#### content_type_properties property

Gets the metadata package containing the content type properties.
##### Definition:
```python
@property
def content_type_properties(self):
    ...
@content_type_properties.setter
def content_type_properties(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/created_time.md

#### created_time property

Gets or sets the document created date.
##### Definition:
```python
@property
def created_time(self):
    ...
@created_time.setter
def created_time(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/hyperlink_base.md

#### hyperlink_base property

Gets or sets the hyperlink base.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
@hyperlink_base.setter
def hyperlink_base(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/language.md

#### language property

Gets or sets the document language.
##### Definition:
```python
@property
def language(self):
    ...
@language.setter
def language(self, value):
    ...
```

### last_printed_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/last_printed_date.md

#### last_printed_date property

Gets or sets the last printed date in UTC.
##### Definition:
```python
@property
def last_printed_date(self):
    ...
@last_printed_date.setter
def last_printed_date(self, value):
    ...
```

### last_saved_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/last_saved_by.md

#### last_saved_by property

Gets or sets the name of the last author.
##### Definition:
```python
@property
def last_saved_by(self):
    ...
@last_saved_by.setter
def last_saved_by(self, value):
    ...
```

### last_saved_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/last_saved_time.md

#### last_saved_time property

Gets or sets the time of the last saving in UTC.
##### Definition:
```python
@property
def last_saved_time(self):
    ...
@last_saved_time.setter
def last_saved_time(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/manager.md

#### manager property

Gets or sets the manager.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_of_application property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/name_of_application.md

#### name_of_application property

Gets or sets the name of application.
##### Definition:
```python
@property
def name_of_application(self):
    ...
@name_of_application.setter
def name_of_application(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/revision.md

#### revision property

Gets or sets the document revision number.
##### Definition:
```python
@property
def revision(self):
    ...
@revision.setter
def revision(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | bool | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.DateTime | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | int | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | float | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/subject.md

#### subject property

Gets or sets the subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/template.md

#### template property

Gets or sets the document template name.
##### Definition:
```python
@property
def template(self):
    ...
@template.setter
def template(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/title.md

#### title property

Gets or sets the title of the document.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### total_editing_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/total_editing_time.md

#### total_editing_time property

Gets or sets the total editing time in minutes.
##### Definition:
```python
@property
def total_editing_time(self):
    ...
@total_editing_time.setter
def total_editing_time(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetpackage/version.md

#### version property

Gets or sets the version number of the application that created the document.

##### Remarks

Its format is "00.0000",for example 12.0000
##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### SpreadsheetRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage.md

#### SpreadsheetRootPackage class

Represents the root package allowing working with metadata in a spreadsheet.

**Inheritance:** `SpreadsheetRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The SpreadsheetRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| inspection_package | Gets a metadata package containing inspection results for the document.
<br/>The package contains information about document parts that can be considered as metadata in some cases. |
| document_statistics | Gets the document statistics package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet demonstrates how to extract built-in metadata properties from a spreadsheet.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This example shows how to detect the exact type of a loaded spreadsheet and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### inspection_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/inspection_package.md

#### inspection_package property

Gets a metadata package containing inspection results for the document.
The package contains information about document parts that can be considered as metadata in some cases.

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet shows how to inspect a spreadsheet document.
##### Definition:
```python
@property
def inspection_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetSheet class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet.md

#### SpreadsheetSheet class

Represents a sheet in a spreadsheet document.

**Inheritance:** `SpreadsheetSheet` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetSheet type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the sheet name. |
| number | Gets the sheet number. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/name.md

#### name property

Gets the sheet name.
##### Definition:
```python
@property
def name(self):
    ...
```

### number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/number.md

#### number property

Gets the sheet number.
##### Definition:
```python
@property
def number(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheetsheet/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### SpreadsheetTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage.md

#### SpreadsheetTypePackage class

Represents a metadata package containing spreadsheet-specific file format information.

**Inheritance:** `SpreadsheetTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The SpreadsheetTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| spreadsheet_format | Gets the exact spreadsheet format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### spreadsheet_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/spreadsheet_format.md

#### spreadsheet_format property

Gets the exact spreadsheet format.
##### Definition:
```python
@property
def spreadsheet_format(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/spreadsheettypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingComment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment.md

#### WordProcessingComment class

Represents a comment in a word processing document.

**Inheritance:** `WordProcessingComment` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingComment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| id | Gets the comment id. |
| author | Gets or sets the author. |
| initials | Gets or sets the author's initials. |
| text | Gets or sets the text of the comment. |
| created_date | Gets or sets the date the comment was created. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/author.md

#### author property

Gets or sets the author.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/created_date.md

#### created_date property

Gets or sets the date the comment was created.
##### Definition:
```python
@property
def created_date(self):
    ...
@created_date.setter
def created_date(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/id.md

#### id property

Gets the comment id.
##### Definition:
```python
@property
def id(self):
    ...
```

### initials property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/initials.md

#### initials property

Gets or sets the author's initials.
##### Definition:
```python
@property
def initials(self):
    ...
@initials.setter
def initials(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/text.md

#### text property

Gets or sets the text of the comment.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingcomment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingField class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield.md

#### WordProcessingField class

Represents a field in a word processing document.

**Inheritance:** `WordProcessingField` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingField type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| code | Gets the field code. |
| result | Gets the field result. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### code property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/code.md

#### code property

Gets the field code.
##### Definition:
```python
@property
def code(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### result property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/result.md

#### result property

Gets the field result.
##### Definition:
```python
@property
def result(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingfield/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingformat.md

#### WordProcessingFormat enumeration

Defines various word processing document subformats.

The WordProcessingFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The format is not recognized. |
| DOC | Represents the .DOC Word format.
<br/>Files with .doc extension represent documents generated by Microsoft Word or other word processing applications in binary file format.
<br/>The extension was initially used for plain text documentation on several different operating systems. It can contain several different types of data such as images,
<br/>formatted as well as plain text, graphs, charts, embedded objects, links, pages, page formatting, print settings and a lot others.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/doc/). |
| DOCM | Represents the .DOCM Word format.
<br/>DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
<br/>It is similar to DOCX file format but the ability to run macros makes it different from DOCX. Like DOCX, DOCM files can be store text, images,
<br/>tables, shapes, charts and other contents.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm/). |
| DOCX | Represents the .DOCX Word format.
<br/>DOCX is a well-known format for Microsoft Word documents.
<br/>Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from
<br/>plain binary to a combination of XML and binary files.
<br/>Docx files can be opened with Word 2007 and lateral versions but not with the earlier versions of MS Word which support DOC file extensions.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx/). |
| DOT | Represents the .DOT Word format.
<br/>Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files.
<br/>A template file is created in order to have specific user settings that should be applied to subsequent files created from these.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot/). |
| DOTX | Represents the .DOTX Word format.
<br/>Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files.
<br/>A template file is created in order to have specific user settings that should be applied to subsequent flies created from these.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx/). |
| DOTM | Represents the .DOTM Word format.
<br/>A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
<br/>It is similar to the popular DOCX file format other than it retains the user defined settings for reuse in case of creating new documents.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm/). |
| ODT | Represents the .ODT format.
<br/>ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format.
<br/>These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |

### WordProcessingInspectionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage.md

#### WordProcessingInspectionPackage class

Contains information about document parts that can be considered as metadata in some cases.

**Inheritance:** `WordProcessingInspectionPackage` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingInspectionPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comments | Gets an array of the user comments. |
| fields | Gets an array of document fields. |
| hidden_text | Gets an array of hidden text fragments extracted from the document. |
| digital_signatures | Gets an array of digital signatures presented in the document. |
| revisions | Gets an array of digital signatures presented in the document. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_comments(self)` | Removes all detected user comments from the document. |
| `clear_fields(self)` | Removes all detected fields from the document. |
| `clear_hidden_text(self)` | Removes all hidden text fragments from the document. |
| `accept_all_revisions(self)` | Accepts all detected revisions in the document. |
| `reject_all_revisions(self)` | Rejects all detected revisions in the document. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to update inspection properties in a WordProcessing document.

### accept_all_revisions method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/accept_all_revisions.md

#### accept_all_revisions(self)

Accepts all detected revisions in the document.

```python

def accept_all_revisions(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_comments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clear_comments.md

#### clear_comments(self)

Removes all detected user comments from the document.

```python

def clear_comments(self):
    ...
```

### clear_fields method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clear_fields.md

#### clear_fields(self)

Removes all detected fields from the document.

```python

def clear_fields(self):
    ...
```

### clear_hidden_text method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/clear_hidden_text.md

#### clear_hidden_text(self)

Removes all hidden text fragments from the document.

```python

def clear_hidden_text(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/comments.md

#### comments property

Gets an array of the user comments.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_signatures property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/digital_signatures.md

#### digital_signatures property

Gets an array of digital signatures presented in the document.
##### Definition:
```python
@property
def digital_signatures(self):
    ...
```

### fields property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/fields.md

#### fields property

Gets an array of document fields.
##### Definition:
```python
@property
def fields(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hidden_text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/hidden_text.md

#### hidden_text property

Gets an array of hidden text fragments extracted from the document.
##### Definition:
```python
@property
def hidden_text(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### reject_all_revisions method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/reject_all_revisions.md

#### reject_all_revisions(self)

Rejects all detected revisions in the document.

```python

def reject_all_revisions(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revisions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/revisions.md

#### revisions property

Gets an array of digital signatures presented in the document.
##### Definition:
```python
@property
def revisions(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessinginspectionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage.md

#### WordProcessingPackage class

Represents a native metadata package in a word processing document.

**Inheritance:** `WordProcessingPackage` →
`DocumentPackage` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets or sets the document's author. |
| bytes_in_document | Gets an estimate of the number of bytes in the document. |
| category | Gets or sets the category. |
| comments | Gets or sets the comments. |
| company | Gets or sets the company. |
| content_status | Gets or sets the content status. |
| content_type | Gets or sets the content type of the document. |
| created_time | Gets or sets the document created date. |
| hyperlink_base | Gets or sets the hyperlink base. |
| keywords | Gets or sets the keywords. |
| subject | Gets or sets the subject. |
| template | Gets or sets the template. |
| last_printed_date | Gets or sets the last printed date. |
| last_saved_by | Gets or sets the name of the last author. |
| last_saved_time | Gets or sets the time of the last save. |
| manager | Gets or sets the manager. |
| name_of_application | Gets the name of the application. |
| revision_number | Gets or sets the revision number. |
| version | Gets the version number of the application that created the document. |
| total_editing_time | Gets or sets the total editing time in minutes. |
| title | Gets or sets the title of the document. |
| hyperlinks_changed | Gets or sets the Hyperlinks Changed of the document. |
| scale_crop | Gets or sets the ScaleCrop of the document. |
| shared_doc | Gets or sets the SharedDoc of the document. |
| links_up_to_date | Gets or sets a value indicating whether the hyperlinks in the document are up-to-date. |
| titles_of_parts | Gets the titles of document parts. Read-only. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `set(self, property_name, value)` | Adds or replaces the metadata property with the specified name. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove(self, property_name)` | Removes a writable metadata property by the specified name. |
| `clear(self)` | Removes all writable metadata properties from the package. |
| `clear_built_in_properties(self)` | Removes all built-in metadata properties. |
| `clear_custom_properties(self)` | Removes all custom metadata properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to update built-in metadata properties in a WordProcessing document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/author.md

#### author property

Gets or sets the document's author.
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### bytes_in_document property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/bytes_in_document.md

#### bytes_in_document property

Gets an estimate of the number of bytes in the document.
##### Definition:
```python
@property
def bytes_in_document(self):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/category.md

#### category property

Gets or sets the category.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/clear.md

#### clear(self)

Removes all writable metadata properties from the package.

```python

def clear(self):
    ...
```

### clear_built_in_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/clear_built_in_properties.md

#### clear_built_in_properties(self)

Removes all built-in metadata properties.

```python

def clear_built_in_properties(self):
    ...
```

### clear_custom_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/clear_custom_properties.md

#### clear_custom_properties(self)

Removes all custom metadata properties.

```python

def clear_custom_properties(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/comments.md

#### comments property

Gets or sets the comments.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/company.md

#### company property

Gets or sets the company.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/content_status.md

#### content_status property

Gets or sets the content status.
##### Definition:
```python
@property
def content_status(self):
    ...
@content_status.setter
def content_status(self, value):
    ...
```

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/content_type.md

#### content_type property

Gets or sets the content type of the document.
##### Definition:
```python
@property
def content_type(self):
    ...
@content_type.setter
def content_type(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/created_time.md

#### created_time property

Gets or sets the document created date.
##### Definition:
```python
@property
def created_time(self):
    ...
@created_time.setter
def created_time(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### hyperlink_base property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/hyperlink_base.md

#### hyperlink_base property

Gets or sets the hyperlink base.
##### Definition:
```python
@property
def hyperlink_base(self):
    ...
@hyperlink_base.setter
def hyperlink_base(self, value):
    ...
```

### hyperlinks_changed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/hyperlinks_changed.md

#### hyperlinks_changed property

Gets or sets the Hyperlinks Changed of the document.
##### Definition:
```python
@property
def hyperlinks_changed(self):
    ...
@hyperlinks_changed.setter
def hyperlinks_changed(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### last_printed_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/last_printed_date.md

#### last_printed_date property

Gets or sets the last printed date.
##### Definition:
```python
@property
def last_printed_date(self):
    ...
@last_printed_date.setter
def last_printed_date(self, value):
    ...
```

### last_saved_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/last_saved_by.md

#### last_saved_by property

Gets or sets the name of the last author.
##### Definition:
```python
@property
def last_saved_by(self):
    ...
@last_saved_by.setter
def last_saved_by(self, value):
    ...
```

### last_saved_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/last_saved_time.md

#### last_saved_time property

Gets or sets the time of the last save.
##### Definition:
```python
@property
def last_saved_time(self):
    ...
@last_saved_time.setter
def last_saved_time(self, value):
    ...
```

### links_up_to_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/links_up_to_date.md

#### links_up_to_date property

Gets or sets a value indicating whether the hyperlinks in the document are up-to-date.
##### Definition:
```python
@property
def links_up_to_date(self):
    ...
@links_up_to_date.setter
def links_up_to_date(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/manager.md

#### manager property

Gets or sets the manager.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_of_application property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/name_of_application.md

#### name_of_application property

Gets the name of the application.
##### Definition:
```python
@property
def name_of_application(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/remove.md

#### remove(self, property_name)

Removes a writable metadata property by the specified name.

##### Returns

`true` if the property is found and deleted; otherwise `false`.

```python

def remove(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | A metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/revision_number.md

#### revision_number property

Gets or sets the revision number.
##### Definition:
```python
@property
def revision_number(self):
    ...
@revision_number.setter
def revision_number(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### scale_crop property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/scale_crop.md

#### scale_crop property

Gets or sets the ScaleCrop of the document.
##### Definition:
```python
@property
def scale_crop(self):
    ...
@scale_crop.setter
def scale_crop(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/set.md

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.String | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | bool | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | System.DateTime | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | int | The property value. |

#### set(self, property_name, value)

Adds or replaces the metadata property with the specified name.

```python

def set(self, property_name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The property name. |
| value | float | The property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shared_doc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/shared_doc.md

#### shared_doc property

Gets or sets the SharedDoc of the document.
##### Definition:
```python
@property
def shared_doc(self):
    ...
@shared_doc.setter
def shared_doc(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/subject.md

#### subject property

Gets or sets the subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/template.md

#### template property

Gets or sets the template.
##### Definition:
```python
@property
def template(self):
    ...
@template.setter
def template(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/title.md

#### title property

Gets or sets the title of the document.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### titles_of_parts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/titles_of_parts.md

#### titles_of_parts property

Gets the titles of document parts. Read-only.
##### Definition:
```python
@property
def titles_of_parts(self):
    ...
```

### total_editing_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/total_editing_time.md

#### total_editing_time property

Gets or sets the total editing time in minutes.
##### Definition:
```python
@property
def total_editing_time(self):
    ...
@total_editing_time.setter
def total_editing_time(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingpackage/version.md

#### version property

Gets the version number of the application that created the document.

##### Remarks

When a document was created by Microsoft Word, then high 16 bit represent
the major version and low 16 bit represent the build number.
##### Definition:
```python
@property
def version(self):
    ...
```

### WordProcessingRevision class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision.md

#### WordProcessingRevision class

Represents a revision (tracked change) in a document.

**Inheritance:** `WordProcessingRevision` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingRevision type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| author | Gets the author of the revision. |
| date_time | Gets the date/time of the revision. |
| revision_type | Gets the type of the revision. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/author.md

#### author property

Gets the author of the revision.
##### Definition:
```python
@property
def author(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/date_time.md

#### date_time property

Gets the date/time of the revision.
##### Definition:
```python
@property
def date_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### revision_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/revision_type.md

#### revision_type property

Gets the type of the revision.
##### Definition:
```python
@property
def revision_type(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevision/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingRevisionType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrevisiontype.md

#### WordProcessingRevisionType enumeration

Specifies the type of the change being tracked by a revision.

The WordProcessingRevisionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| INSERTION | New content was inserted into 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. |

### WordProcessingRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage.md

#### WordProcessingRootPackage class

Represents the root package allowing working with metadata in a word processing document.

**Inheritance:** `WordProcessingRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The WordProcessingRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| dublin_core_package | Gets the Dublin Core metadata package extracted from the document. |
| inspection_package | Gets a metadata package containing inspection results for the document.
<br/>The package contains information about document parts that can be considered as metadata in some cases. |
| document_statistics | Gets the document statistics package. |
| document_properties |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `update_document_statistics(self)` | Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to read built-in metadata properties of a WordProcessing document.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/document_properties.md

##### Definition:
```python
@property
def document_properties(self):
    ...
```

### document_statistics property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/document_statistics.md

#### document_statistics property

Gets the document statistics package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to obtain simple text statistics for a WordProcessing document.
##### Definition:
```python
@property
def document_statistics(self):
    ...
```

### dublin_core_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/dublin_core_package.md

#### dublin_core_package property

Gets the Dublin Core metadata package extracted from the document.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract Dublin Core metadata from a WordProcessing document.
##### Definition:
```python
@property
def dublin_core_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This example shows how to detect the exact type of a loaded document and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### inspection_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/inspection_package.md

#### inspection_package property

Gets a metadata package containing inspection results for the document.
The package contains information about document parts that can be considered as metadata in some cases.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to inspect a WordProcessing document.
##### Definition:
```python
@property
def inspection_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_document_statistics method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/update_document_statistics.md

#### update_document_statistics(self)

Recalculates count of pages, paragraphs, words, lines, characters in the document and updates appropriate metadata packages.

```python

def update_document_statistics(self):
    ...
```

##### Remarks

**Learn more** |
|
 |
##### Example

This code sample demonstrates how to update document statistics for a WordProcessing document.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### WordProcessingTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage.md

#### WordProcessingTypePackage class

Represents a metadata package containing document-specific file format information.

**Inheritance:** `WordProcessingTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The WordProcessingTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| word_processing_format | Gets the exact word processing format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### word_processing_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.document/wordprocessingtypepackage/word_processing_format.md

#### word_processing_format property

Gets the exact word processing format.
##### Definition:
```python
@property
def word_processing_format(self):
    ...
```

### groupdocs.metadata.formats.ebook.fb2
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2.md

##### Classes
| Class | Description |
| :- | :- |
| `Fb2Author` | Represents an information about the author of the book. |
| `Fb2DocumentInfo` | Description of information about the work (including translation, but excluding publication). |
| `Fb2PublishInfo` | Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether. |
| `Fb2Sequence` | Represents an information about the sequence of the book. |
| `Fb2TitleInfo` | Description of information about the work (including translation, but excluding publication). |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `Fb2Genre` | Defines Fb2 genres |

### Fb2Author class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author.md

#### Fb2Author class

Represents an information about the author of the book.

**Inheritance:** `Fb2Author` →
`CustomPackage` →
`MetadataPackage`

The Fb2Author type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, first_name, middle_name, last_name, nick_name, home_page, email, id)` | Constructs a new instance of Fb2Author |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| first_name | Gets the First Name. |
| middle_name | Gets the Middle Name. |
| last_name | Gets the Last Name. |
| nick_name | Gets the NickName. |
| home_page | Gets the HomePage. |
| email | Gets the Email. |
| id | Gets the Id. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### Fb2Author constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/__init__.md

#### \_\_init\_\_(self, first_name, middle_name, last_name, nick_name, home_page, email, id)

Constructs a new instance of Fb2Author

```python

def __init__(self, first_name, middle_name, last_name, nick_name, home_page, email, id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| first_name | System.String |  |
| middle_name | System.String |  |
| last_name | System.String |  |
| nick_name | System.String |  |
| home_page | System.String |  |
| email | System.String |  |
| id | System.String |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### email property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/email.md

#### email property

Gets the Email.
##### Definition:
```python
@property
def email(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### first_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/first_name.md

#### first_name property

Gets the First Name.
##### Definition:
```python
@property
def first_name(self):
    ...
```

### home_page property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/home_page.md

#### home_page property

Gets the HomePage.
##### Definition:
```python
@property
def home_page(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/id.md

#### id property

Gets the Id.
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### last_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/last_name.md

#### last_name property

Gets the Last Name.
##### Definition:
```python
@property
def last_name(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### middle_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/middle_name.md

#### middle_name property

Gets the Middle Name.
##### Definition:
```python
@property
def middle_name(self):
    ...
```

### nick_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/nick_name.md

#### nick_name property

Gets the NickName.
##### Definition:
```python
@property
def nick_name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2author/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Fb2DocumentInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo.md

#### Fb2DocumentInfo class

Description of information about the work (including translation, but excluding publication).

**Inheritance:** `Fb2DocumentInfo` →
`CustomPackage` →
`MetadataPackage`

The Fb2DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| authors | Information about the author of the document |
| program_used | The programs that were used in preparing the document are listed. |
| date | Date |
| src_url | Where did the original document available online come from |
| src_ocr | The author of the OCR or original document posted online. |
| id | Gets the Id. |
| version | FB2 document version. |
| publishers | Information about the author of the document |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### authors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/authors.md

#### authors property

Information about the author of the document
##### Definition:
```python
@property
def authors(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/date.md

#### date property

Date
##### Definition:
```python
@property
def date(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/id.md

#### id property

Gets the Id.
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### program_used property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/program_used.md

#### program_used property

The programs that were used in preparing the document are listed.
##### Definition:
```python
@property
def program_used(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publishers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/publishers.md

#### publishers property

Information about the author of the document
##### Definition:
```python
@property
def publishers(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### src_ocr property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/src_ocr.md

#### src_ocr property

The author of the OCR or original document posted online.
##### Definition:
```python
@property
def src_ocr(self):
    ...
```

### src_url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/src_url.md

#### src_url property

Where did the original document available online come from
##### Definition:
```python
@property
def src_url(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2documentinfo/version.md

#### version property

FB2 document version.
##### Definition:
```python
@property
def version(self):
    ...
```

### Fb2Genre enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2genre.md

#### Fb2Genre enumeration

Defines Fb2 genres

The Fb2Genre type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SF_HISTORY |  |
| SF_ACTION |  |
| SF_EPIC |  |
| SF_HEROIC |  |
| SF_DETECTIVE |  |
| SF_CYBERPUNK |  |
| SF_SPACE |  |
| SF_SOCIAL |  |
| SF_HORROR |  |
| SF_HUMOR |  |
| SF_FANTASY |  |
| SF |  |
| DET_CLASSIC |  |
| DET_POLICE |  |
| DET_ACTION |  |
| DET_IRONY |  |
| DET_HISTORY |  |
| DET_ESPIONAGE |  |
| DET_CRIME |  |
| DET_POLITICAL |  |
| DET_MANIAC |  |
| DET_HARD |  |
| THRILLER |  |
| DETECTIVE |  |
| PROSE_CLASSIC |  |
| PROSE_HISTORY |  |
| PROSE_CONTEMPORARY |  |
| PROSE_COUNTER |  |
| PROSE_RUS_CLASSIC |  |
| PROSE_SU_CLASSICS |  |
| LOVE_CONTEMPORARY |  |
| LOVE_HISTORY |  |
| LOVE_DETECTIVE |  |
| LOVE_SHORT |  |
| LOVE_EROTICA |  |
| ADV_WESTERN |  |
| ADV_HISTORY |  |
| ADV_INDIAN |  |
| ADV_MARITIME |  |
| ADV_GEO |  |
| ADV_ANIMAL |  |
| ADVENTURE |  |
| CHILD_TALE |  |
| CHILD_VERSE |  |
| CHILD_PROSE |  |
| CHILD_SF |  |
| CHILD_DET |  |
| CHILD_ADV |  |
| CHILD_EDUCATION |  |
| CHILDREN |  |
| POETRY |  |
| DRAMATURGY |  |
| ANTIQUE_ANT |  |
| ANTIQUE_EUROPEAN |  |
| ANTIQUE_RUSSIAN |  |
| ANTIQUE_EAST |  |
| ANTIQUE_MYTHS |  |
| ANTIQUE |  |
| SCI_HISTORY |  |
| SCI_PSYCHOLOGY |  |
| SCI_CULTURE |  |
| SCI_RELIGION |  |
| SCI_PHILOSOPHY |  |
| SCI_POLITICS |  |
| SCI_BUSINESS |  |
| SCI_JURIS |  |
| SCI_LINGUISTIC |  |
| SCI_MEDICINE |  |
| SCI_PHYS |  |
| SCI_MATH |  |
| SCI_CHEM |  |
| SCI_BIOLOGY |  |
| SCI_TECH |  |
| SCIENCE |  |
| COMP_WWW |  |
| COMP_PROGRAMMING |  |
| COMP_HARD |  |
| COMP_SOFT |  |
| COMP_DB |  |
| COMP_OSNET |  |
| COMPUTERS |  |
| REF_ENCYC |  |
| REF_DICT |  |
| REF_REF |  |
| REF_GUIDE |  |
| REFERENCE |  |
| NONF_BIOGRAPHY |  |
| NONF_PUBLICISM |  |
| NONF_CRITICISM |  |
| DESIGN |  |
| NONFICTION |  |
| RELIGION_REL |  |
| RELIGION_ESOTERICS |  |
| RELIGION_SELF |  |
| RELIGION |  |
| HUMOR_ANECDOTE |  |
| HUMOR_PROSE |  |
| HUMOR_VERSE |  |
| HUMOR |  |
| HOME_COOKING |  |
| HOME_PETS |  |
| HOME_CRAFTS |  |
| HOME_ENTERTAIN |  |
| HOME_HEALTH |  |
| HOME_GARDEN |  |
| HOME_DIY |  |
| HOME_SPORT |  |
| HOME_SEX |  |
| HOME |  |

### Fb2PublishInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo.md

#### Fb2PublishInfo class

Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether.

**Inheritance:** `Fb2PublishInfo` →
`CustomPackage` →
`MetadataPackage`

The Fb2PublishInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| book_name | The title of the original (paper) book. |
| publisher | The title of the original (paper) book. |
| city | City, place of publication of the original (paper) book. |
| year | Year of publication of the original (paper) book. |
| isbn | ISBN of the original (paper) book. |
| sequence | The series of publications that the book belongs to and the number in the series. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### book_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/book_name.md

#### book_name property

The title of the original (paper) book.
##### Definition:
```python
@property
def book_name(self):
    ...
```

### city property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/city.md

#### city property

City, place of publication of the original (paper) book.
##### Definition:
```python
@property
def city(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### isbn property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/isbn.md

#### isbn property

ISBN of the original (paper) book.
##### Definition:
```python
@property
def isbn(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/publisher.md

#### publisher property

The title of the original (paper) book.
##### Definition:
```python
@property
def publisher(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sequence property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/sequence.md

#### sequence property

The series of publications that the book belongs to and the number in the series.
##### Definition:
```python
@property
def sequence(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### year property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2publishinfo/year.md

#### year property

Year of publication of the original (paper) book.
##### Definition:
```python
@property
def year(self):
    ...
```

### Fb2Sequence class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence.md

#### Fb2Sequence class

Represents an information about the sequence of the book.

**Inheritance:** `Fb2Sequence` →
`CustomPackage` →
`MetadataPackage`

The Fb2Sequence type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, name, number, lang)` | Constructs a new instance of Fb2Sequence |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Series title |
| number | Book number in the series. |
| lang | Gets the language. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### Fb2Sequence constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/__init__.md

#### \_\_init\_\_(self, name, number, lang)

Constructs a new instance of Fb2Sequence

```python

def __init__(self, name, number, lang):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String |  |
| number | int |  |
| lang | System.String |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lang property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/lang.md

#### lang property

Gets the language.
##### Definition:
```python
@property
def lang(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/name.md

#### name property

Series title
##### Definition:
```python
@property
def name(self):
    ...
```

### number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/number.md

#### number property

Book number in the series.
##### Definition:
```python
@property
def number(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2sequence/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Fb2TitleInfo class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo.md

#### Fb2TitleInfo class

Description of information about the work (including translation, but excluding publication).

**Inheritance:** `Fb2TitleInfo` →
`CustomPackage` →
`MetadataPackage`

The Fb2TitleInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| book_title | The title of the book. It can either match the book title (book-name) or differ (for example, when there are several works under one cover). |
| authors | Information about the author of the book |
| genres | Describes the genre of the book. It is used to place the book in the library rubricator, for this reason the list of possible genres is strictly defined. It is allowed to specify several genres. |
| keywords | List of keywords for the book. Intended for use by search engines. |
| date | Date |
| coverpage | Contains a link to a graphic image of the book cover. |
| lang | Language of the book (work) |
| src_lang | Original language (for translations). |
| translators | Information about the author of the book |
| sequence | The series of publications that the book belongs to and the number in the series. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### authors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/authors.md

#### authors property

Information about the author of the book
##### Definition:
```python
@property
def authors(self):
    ...
```

### book_title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/book_title.md

#### book_title property

The title of the book. It can either match the book title (book-name) or differ (for example, when there are several works under one cover).
##### Definition:
```python
@property
def book_title(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### coverpage property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/coverpage.md

#### coverpage property

Contains a link to a graphic image of the book cover.
##### Definition:
```python
@property
def coverpage(self):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/date.md

#### date property

Date
##### Definition:
```python
@property
def date(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genres property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/genres.md

#### genres property

Describes the genre of the book. It is used to place the book in the library rubricator, for this reason the list of possible genres is strictly defined. It is allowed to specify several genres.
##### Definition:
```python
@property
def genres(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/keywords.md

#### keywords property

List of keywords for the book. Intended for use by search engines.
##### Definition:
```python
@property
def keywords(self):
    ...
```

### lang property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/lang.md

#### lang property

Language of the book (work)
##### Definition:
```python
@property
def lang(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sequence property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/sequence.md

#### sequence property

The series of publications that the book belongs to and the number in the series.
##### Definition:
```python
@property
def sequence(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### src_lang property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/src_lang.md

#### src_lang property

Original language (for translations).
##### Definition:
```python
@property
def src_lang(self):
    ...
```

### translators property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/translators.md

#### translators property

Information about the author of the book
##### Definition:
```python
@property
def translators(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.fb2/fb2titleinfo/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.ebook.mobi
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi.md

##### Classes
| Class | Description |
| :- | :- |
| `MobiHeader` | Represents metadata in a Mobi e-book. |
| `MobiPackage` | Represents metadata in a Mobi e-book. |
| `MobiRootPackage` | Represents the root package allowing working with metadata in an Mobi e-book. |
| `PDBHeader` | Represents metadata in a Mobi e-book. |

### MobiHeader class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader.md

#### MobiHeader class

Represents metadata in a Mobi e-book.

**Inheritance:** `MobiHeader` →
`CustomPackage` →
`MetadataPackage`

The MobiHeader type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| full_name | Gets the Mobi e-book full name. |
| mobi_type | Gets the mobi type. |
| text_encoding | Gets the Mobi Text Encoding. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### full_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/full_name.md

#### full_name property

Gets the Mobi e-book full name.
##### Definition:
```python
@property
def full_name(self):
    ...
@full_name.setter
def full_name(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mobi_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/mobi_type.md

#### mobi_type property

Gets the mobi type.
##### Definition:
```python
@property
def mobi_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text_encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/text_encoding.md

#### text_encoding property

Gets the Mobi Text Encoding.
##### Definition:
```python
@property
def text_encoding(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobiheader/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MobiPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage.md

#### MobiPackage class

Represents metadata in a Mobi e-book.

**Inheritance:** `MobiPackage` →
`CustomPackage` →
`MetadataPackage`

The MobiPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| pdb_header |  |
| mobi_header |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mobi_header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/mobi_header.md

##### Definition:
```python
@property
def mobi_header(self):
    ...
```

### pdb_header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/pdb_header.md

##### Definition:
```python
@property
def pdb_header(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobipackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MobiRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage.md

#### MobiRootPackage class

Represents the root package allowing working with metadata in an Mobi e-book.

**Inheritance:** `MobiRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The MobiRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| mobi_package | Gets the Mobi metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mobi_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/mobi_package.md

#### mobi_package property

Gets the Mobi metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read Mobi format-specific metadata properties.
##### Definition:
```python
@property
def mobi_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/mobirootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PDBHeader class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader.md

#### PDBHeader class

Represents metadata in a Mobi e-book.

**Inheritance:** `PDBHeader` →
`CustomPackage` →
`MetadataPackage`

The PDBHeader type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the Mobi e-book name. |
| attributes | Gets the mobi attributes. |
| version | Gets the Mobi version. |
| creation_date | Gets the creation date. |
| modification_date | Gets the modification date. |
| last_backup_date | Gets the last backup date. |
| modification_number | Gets the modification number. |
| app_info_id | Gets the app info ID. |
| sort_info_id | Gets the sort info ID. |
| type | Gets the type. |
| creator | Gets the creator. |
| unique_id_seed | Gets the unique ID seed. |
| next_record_list |  |
| num_records | Gets the num records. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### app_info_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/app_info_id.md

#### app_info_id property

Gets the app info ID.
##### Definition:
```python
@property
def app_info_id(self):
    ...
@app_info_id.setter
def app_info_id(self, value):
    ...
```

### attributes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/attributes.md

#### attributes property

Gets the mobi attributes.
##### Definition:
```python
@property
def attributes(self):
    ...
@attributes.setter
def attributes(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/creation_date.md

#### creation_date property

Gets the creation date.
##### Definition:
```python
@property
def creation_date(self):
    ...
@creation_date.setter
def creation_date(self, value):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/creator.md

#### creator property

Gets the creator.
##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### last_backup_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/last_backup_date.md

#### last_backup_date property

Gets the last backup date.
##### Definition:
```python
@property
def last_backup_date(self):
    ...
@last_backup_date.setter
def last_backup_date(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modification_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/modification_date.md

#### modification_date property

Gets the modification date.
##### Definition:
```python
@property
def modification_date(self):
    ...
@modification_date.setter
def modification_date(self, value):
    ...
```

### modification_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/modification_number.md

#### modification_number property

Gets the modification number.
##### Definition:
```python
@property
def modification_number(self):
    ...
@modification_number.setter
def modification_number(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/name.md

#### name property

Gets the Mobi e-book name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### next_record_list property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/next_record_list.md

##### Definition:
```python
@property
def next_record_list(self):
    ...
```

### num_records property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/num_records.md

#### num_records property

Gets the num records.
##### Definition:
```python
@property
def num_records(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sort_info_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/sort_info_id.md

#### sort_info_id property

Gets the sort info ID.
##### Definition:
```python
@property
def sort_info_id(self):
    ...
@sort_info_id.setter
def sort_info_id(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/type.md

#### type property

Gets the type.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### unique_id_seed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/unique_id_seed.md

#### unique_id_seed property

Gets the unique ID seed.
##### Definition:
```python
@property
def unique_id_seed(self):
    ...
@unique_id_seed.setter
def unique_id_seed(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.mobi/pdbheader/version.md

#### version property

Gets the Mobi version.
##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### groupdocs.metadata.formats.ebook
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook.md

The namespace provides functionality for working with electronic book formats.

##### Classes
| Class | Description |
| :- | :- |
| `EpubPackage` | Represents metadata in a EPUB e-book. |
| `EpubRootPackage` | Represents the root package allowing working with metadata in an EPUB e-book. |
| `Fb2RootPackage` | Represents the root package allowing working with metadata in an Fb2 e-book. |

### EpubPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage.md

#### EpubPackage class

Represents metadata in a EPUB e-book.

**Inheritance:** `EpubPackage` →
`CustomPackage` →
`MetadataPackage`

The EpubPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| image_cover | Gets the image cover as an array of bytes. |
| version | Gets the EPUB version. |
| unique_identifier | Gets the package unique identifier. |
| abstract | Gets or sets a summary of the resource. |
| access_rights | Gets or sets the information about who access the resource or an indication of its security status. |
| accrual_method | Gets or sets the method by which items are added to a collection. |
| accrual_periodicity | Gets or sets the frequency with which items are added to a collection. |
| accrual_policy | Gets or sets the policy governing the addition of items to a collection. |
| alternative | Gets or sets an alternative name for the resource. |
| audience | Gets or sets a class of agents for whom the resource is intended or useful. |
| available | Gets or sets the date that the resource became or will become available. |
| bibliographic_citation | Gets or sets a bibliographic reference for the resource. |
| conforms_to | Gets or sets an established standard to which the described resource conforms. |
| contributor | Gets or sets an entity responsible for making contributions to the resource. |
| coverage | Gets or sets the spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant. |
| created | Gets or sets the date of creation of the resource. |
| creator | Gets or sets an entity responsible for making the resource. |
| date | Gets or sets a point or period of time associated with an event in the lifecycle of the resource. |
| date_accepted | Gets or sets the date of acceptance of the resource. |
| date_copyrighted | Gets or sets the date of copyright of the resource. |
| date_submitted | Gets or sets the date of submission of the resource. |
| description | Gets or sets an account of the resource. |
| education_level | Gets or sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended. |
| extent | Gets or sets the size or duration of the resource. |
| format | Gets or sets the file format, physical medium, or dimensions of the resource. |
| has_format | Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format. |
| has_part | Gets or sets a related resource that is included either physically or logically in the described resource. |
| has_version | Gets or sets a related resource that is a version, edition, or adaptation of the described resource. |
| identifier | Gets or sets an unambiguous reference to the resource within a given context. |
| instructional_method | Gets or sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. |
| is_format_of | Gets or sets a pre-existing related resource that is substantially the same as the described resource, but in another format. |
| is_part_of | Gets or sets a related resource in which the described resource is physically or logically included. |
| is_referenced_by | Gets or sets a related resource that references, cites, or otherwise points to the described resource. |
| is_replaced_by | Gets or sets a related resource that supplants, displaces, or supersedes the described resource. |
| is_required_by | Gets or sets a related resource that requires the described resource to support its function, delivery, or coherence. |
| issued | Gets or sets the date of formal issuance of the resource. |
| is_version_of | Gets or sets a related resource of which the described resource is a version, edition, or adaptation. |
| language | Gets or sets the language of the resource. |
| license | Gets or sets a legal document giving official permission to do something with the resource. |
| mediator | Gets or sets an entity that mediates access to the resource. |
| medium | Gets or sets the material or physical carrier of the resource. |
| modified | Gets or sets the date on which the resource was changed. |
| provenance | Gets or sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. |
| publisher | Gets or sets an entity responsible for making the resource available. |
| references | Gets or sets a related resource that is referenced, cited, or otherwise pointed to by the described resource. |
| relation | Gets or sets a related resource. |
| replaces | Gets or sets a related resource that is supplanted, displaced, or superseded by the described resource. |
| requires | Gets or sets a related resource that is required by the described resource to support its function, delivery, or coherence. |
| rights | Gets or sets the information about rights held in and over the resource. |
| rights_holder | Gets or sets a person or organization owning or managing rights over the resource. |
| source | Gets or sets a related resource from which the described resource is derived. |
| spatial | Gets or sets the spatial characteristics of the resource. |
| subject | Gets or sets a topic of the resource. |
| table_of_contents | Gets or sets a list of subunits of the resource. |
| temporal | Gets or sets the temporal characteristics of the resource. |
| title | Gets or sets a name given to the resource. |
| type | Gets or sets the nature or genre of the resource. |
| valid | Gets or sets the date (often a range) of validity of a resource. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### abstract property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/abstract.md

#### abstract property

Gets or sets a summary of the resource.
##### Definition:
```python
@property
def abstract(self):
    ...
@abstract.setter
def abstract(self, value):
    ...
```

### access_rights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/access_rights.md

#### access_rights property

Gets or sets the information about who access the resource or an indication of its security status.
##### Definition:
```python
@property
def access_rights(self):
    ...
@access_rights.setter
def access_rights(self, value):
    ...
```

### accrual_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/accrual_method.md

#### accrual_method property

Gets or sets the method by which items are added to a collection.
##### Definition:
```python
@property
def accrual_method(self):
    ...
@accrual_method.setter
def accrual_method(self, value):
    ...
```

### accrual_periodicity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/accrual_periodicity.md

#### accrual_periodicity property

Gets or sets the frequency with which items are added to a collection.
##### Definition:
```python
@property
def accrual_periodicity(self):
    ...
@accrual_periodicity.setter
def accrual_periodicity(self, value):
    ...
```

### accrual_policy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/accrual_policy.md

#### accrual_policy property

Gets or sets the policy governing the addition of items to a collection.
##### Definition:
```python
@property
def accrual_policy(self):
    ...
@accrual_policy.setter
def accrual_policy(self, value):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternative property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/alternative.md

#### alternative property

Gets or sets an alternative name for the resource.
##### Definition:
```python
@property
def alternative(self):
    ...
@alternative.setter
def alternative(self, value):
    ...
```

### audience property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/audience.md

#### audience property

Gets or sets a class of agents for whom the resource is intended or useful.
##### Definition:
```python
@property
def audience(self):
    ...
@audience.setter
def audience(self, value):
    ...
```

### available property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/available.md

#### available property

Gets or sets the date that the resource became or will become available.
##### Definition:
```python
@property
def available(self):
    ...
@available.setter
def available(self, value):
    ...
```

### bibliographic_citation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/bibliographic_citation.md

#### bibliographic_citation property

Gets or sets a bibliographic reference for the resource.
##### Definition:
```python
@property
def bibliographic_citation(self):
    ...
@bibliographic_citation.setter
def bibliographic_citation(self, value):
    ...
```

### conforms_to property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/conforms_to.md

#### conforms_to property

Gets or sets an established standard to which the described resource conforms.
##### Definition:
```python
@property
def conforms_to(self):
    ...
@conforms_to.setter
def conforms_to(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contributor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/contributor.md

#### contributor property

Gets or sets an entity responsible for making contributions to the resource.
##### Definition:
```python
@property
def contributor(self):
    ...
@contributor.setter
def contributor(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/created.md

#### created property

Gets or sets the date of creation of the resource.
##### Definition:
```python
@property
def created(self):
    ...
@created.setter
def created(self, value):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/creator.md

#### creator property

Gets or sets an entity responsible for making the resource.
##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/date.md

#### date property

Gets or sets a point or period of time associated with an event in the lifecycle of the resource.
##### Definition:
```python
@property
def date(self):
    ...
@date.setter
def date(self, value):
    ...
```

### date_accepted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/date_accepted.md

#### date_accepted property

Gets or sets the date of acceptance of the resource.
##### Definition:
```python
@property
def date_accepted(self):
    ...
@date_accepted.setter
def date_accepted(self, value):
    ...
```

### date_copyrighted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/date_copyrighted.md

#### date_copyrighted property

Gets or sets the date of copyright of the resource.
##### Definition:
```python
@property
def date_copyrighted(self):
    ...
@date_copyrighted.setter
def date_copyrighted(self, value):
    ...
```

### date_submitted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/date_submitted.md

#### date_submitted property

Gets or sets the date of submission of the resource.
##### Definition:
```python
@property
def date_submitted(self):
    ...
@date_submitted.setter
def date_submitted(self, value):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/description.md

#### description property

Gets or sets an account of the resource.
##### Definition:
```python
@property
def description(self):
    ...
@description.setter
def description(self, value):
    ...
```

### education_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/education_level.md

#### education_level property

Gets or sets a class of agents, defined in terms of progression through an educational or training context, for which the described resource is intended.
##### Definition:
```python
@property
def education_level(self):
    ...
@education_level.setter
def education_level(self, value):
    ...
```

### extent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/extent.md

#### extent property

Gets or sets the size or duration of the resource.
##### Definition:
```python
@property
def extent(self):
    ...
@extent.setter
def extent(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/format.md

#### format property

Gets or sets the file format, physical medium, or dimensions of the resource.
##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### has_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/has_format.md

#### has_format property

Gets or sets a related resource that is substantially the same as the pre-existing described resource, but in another format.
##### Definition:
```python
@property
def has_format(self):
    ...
@has_format.setter
def has_format(self, value):
    ...
```

### has_part property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/has_part.md

#### has_part property

Gets or sets a related resource that is included either physically or logically in the described resource.
##### Definition:
```python
@property
def has_part(self):
    ...
@has_part.setter
def has_part(self, value):
    ...
```

### has_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/has_version.md

#### has_version property

Gets or sets a related resource that is a version, edition, or adaptation of the described resource.
##### Definition:
```python
@property
def has_version(self):
    ...
@has_version.setter
def has_version(self, value):
    ...
```

### identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/identifier.md

#### identifier property

Gets or sets an unambiguous reference to the resource within a given context.
##### Definition:
```python
@property
def identifier(self):
    ...
@identifier.setter
def identifier(self, value):
    ...
```

### image_cover property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/image_cover.md

#### image_cover property

Gets the image cover as an array of bytes.
##### Definition:
```python
@property
def image_cover(self):
    ...
```

### instructional_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/instructional_method.md

#### instructional_method property

Gets or sets a process, used to engender knowledge, attitudes and skills, that the described resource is designed to support.
##### Definition:
```python
@property
def instructional_method(self):
    ...
@instructional_method.setter
def instructional_method(self, value):
    ...
```

### is_format_of property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_format_of.md

#### is_format_of property

Gets or sets a pre-existing related resource that is substantially the same as the described resource, but in another format.
##### Definition:
```python
@property
def is_format_of(self):
    ...
@is_format_of.setter
def is_format_of(self, value):
    ...
```

### is_part_of property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_part_of.md

#### is_part_of property

Gets or sets a related resource in which the described resource is physically or logically included.
##### Definition:
```python
@property
def is_part_of(self):
    ...
@is_part_of.setter
def is_part_of(self, value):
    ...
```

### is_referenced_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_referenced_by.md

#### is_referenced_by property

Gets or sets a related resource that references, cites, or otherwise points to the described resource.
##### Definition:
```python
@property
def is_referenced_by(self):
    ...
@is_referenced_by.setter
def is_referenced_by(self, value):
    ...
```

### is_replaced_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_replaced_by.md

#### is_replaced_by property

Gets or sets a related resource that supplants, displaces, or supersedes the described resource.
##### Definition:
```python
@property
def is_replaced_by(self):
    ...
@is_replaced_by.setter
def is_replaced_by(self, value):
    ...
```

### is_required_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_required_by.md

#### is_required_by property

Gets or sets a related resource that requires the described resource to support its function, delivery, or coherence.
##### Definition:
```python
@property
def is_required_by(self):
    ...
@is_required_by.setter
def is_required_by(self, value):
    ...
```

### is_version_of property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/is_version_of.md

#### is_version_of property

Gets or sets a related resource of which the described resource is a version, edition, or adaptation.
##### Definition:
```python
@property
def is_version_of(self):
    ...
@is_version_of.setter
def is_version_of(self, value):
    ...
```

### issued property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/issued.md

#### issued property

Gets or sets the date of formal issuance of the resource.
##### Definition:
```python
@property
def issued(self):
    ...
@issued.setter
def issued(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/language.md

#### language property

Gets or sets the language of the resource.
##### Definition:
```python
@property
def language(self):
    ...
@language.setter
def language(self, value):
    ...
```

### license property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/license.md

#### license property

Gets or sets a legal document giving official permission to do something with the resource.
##### Definition:
```python
@property
def license(self):
    ...
@license.setter
def license(self, value):
    ...
```

### mediator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/mediator.md

#### mediator property

Gets or sets an entity that mediates access to the resource.
##### Definition:
```python
@property
def mediator(self):
    ...
@mediator.setter
def mediator(self, value):
    ...
```

### medium property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/medium.md

#### medium property

Gets or sets the material or physical carrier of the resource.
##### Definition:
```python
@property
def medium(self):
    ...
@medium.setter
def medium(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modified property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/modified.md

#### modified property

Gets or sets the date on which the resource was changed.
##### Definition:
```python
@property
def modified(self):
    ...
@modified.setter
def modified(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### provenance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/provenance.md

#### provenance property

Gets or sets a statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation.
##### Definition:
```python
@property
def provenance(self):
    ...
@provenance.setter
def provenance(self, value):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/publisher.md

#### publisher property

Gets or sets an entity responsible for making the resource available.
##### Definition:
```python
@property
def publisher(self):
    ...
@publisher.setter
def publisher(self, value):
    ...
```

### references property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/references.md

#### references property

Gets or sets a related resource that is referenced, cited, or otherwise pointed to by the described resource.
##### Definition:
```python
@property
def references(self):
    ...
@references.setter
def references(self, value):
    ...
```

### relation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/relation.md

#### relation property

Gets or sets a related resource.
##### Definition:
```python
@property
def relation(self):
    ...
@relation.setter
def relation(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### replaces property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/replaces.md

#### replaces property

Gets or sets a related resource that is supplanted, displaced, or superseded by the described resource.
##### Definition:
```python
@property
def replaces(self):
    ...
@replaces.setter
def replaces(self, value):
    ...
```

### requires property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/requires.md

#### requires property

Gets or sets a related resource that is required by the described resource to support its function, delivery, or coherence.
##### Definition:
```python
@property
def requires(self):
    ...
@requires.setter
def requires(self, value):
    ...
```

### rights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/rights.md

#### rights property

Gets or sets the information about rights held in and over the resource.
##### Definition:
```python
@property
def rights(self):
    ...
@rights.setter
def rights(self, value):
    ...
```

### rights_holder property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/rights_holder.md

#### rights_holder property

Gets or sets a person or organization owning or managing rights over the resource.
##### Definition:
```python
@property
def rights_holder(self):
    ...
@rights_holder.setter
def rights_holder(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/source.md

#### source property

Gets or sets a related resource from which the described resource is derived.
##### Definition:
```python
@property
def source(self):
    ...
@source.setter
def source(self, value):
    ...
```

### spatial property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/spatial.md

#### spatial property

Gets or sets the spatial characteristics of the resource.
##### Definition:
```python
@property
def spatial(self):
    ...
@spatial.setter
def spatial(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/subject.md

#### subject property

Gets or sets a topic of the resource.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/table_of_contents.md

#### table_of_contents property

Gets or sets a list of subunits of the resource.
##### Definition:
```python
@property
def table_of_contents(self):
    ...
@table_of_contents.setter
def table_of_contents(self, value):
    ...
```

### temporal property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/temporal.md

#### temporal property

Gets or sets the temporal characteristics of the resource.
##### Definition:
```python
@property
def temporal(self):
    ...
@temporal.setter
def temporal(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/title.md

#### title property

Gets or sets a name given to the resource.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/type.md

#### type property

Gets or sets the nature or genre of the resource.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### unique_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/unique_identifier.md

#### unique_identifier property

Gets the package unique identifier.
##### Definition:
```python
@property
def unique_identifier(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### valid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/valid.md

#### valid property

Gets or sets the date (often a range) of validity of a resource.
##### Definition:
```python
@property
def valid(self):
    ...
@valid.setter
def valid(self, value):
    ...
```

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubpackage/version.md

#### version property

Gets the EPUB version.
##### Definition:
```python
@property
def version(self):
    ...
```

### EpubRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage.md

#### EpubRootPackage class

Represents the root package allowing working with metadata in an EPUB e-book.

**Inheritance:** `EpubRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The EpubRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| epub_package | Gets the EPUB metadata package. |
| dublin_core_package | Gets the Dublin Core metadata package extracted from the e-book. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### dublin_core_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/dublin_core_package.md

#### dublin_core_package property

Gets the Dublin Core metadata package extracted from the e-book.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to extract Dublin Core metadata from an EPUB file.
##### Definition:
```python
@property
def dublin_core_package(self):
    ...
```

### epub_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/epub_package.md

#### epub_package property

Gets the EPUB metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read EPUB format-specific metadata properties.
##### Definition:
```python
@property
def epub_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/epubrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Fb2RootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage.md

#### Fb2RootPackage class

Represents the root package allowing working with metadata in an Fb2 e-book.

**Inheritance:** `Fb2RootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The Fb2RootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| fb_2_package | Gets the Fb2 metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### fb_2_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/fb_2_package.md

#### fb_2_package property

Gets the Fb2 metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read Fb2 format-specific metadata properties.
##### Definition:
```python
@property
def fb_2_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.ebook/fb2rootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.email.msg
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email.msg.md

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `MsgKnownProperties` | Defines known msg properties. |

### MsgKnownProperties enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email.msg/msgknownproperties.md

#### MsgKnownProperties enumeration

Defines known msg properties.

The MsgKnownProperties type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| OBJECT_URI |  |
| CONTACT_ETAG |  |
| PHOTO_ETAG |  |
| ACCESS |  |
| ACL_DATA |  |
| ACCESS_LEVEL |  |
| ACCOUNT |  |
| ADDITIONAL_REN_ENTRYIDS |  |
| ADDITIONAL_REN_ENTRYIDS_EX |  |
| EMS_AB_AUTH_ORIG |  |
| EMS_AB_CONTAINERID |  |
| EMS_AB_DELIV_CONT_LENGTH |  |
| EMS_AB_DISPLAY_NAME_PRINTABLE |  |
| EMS_AB_DISPLAY_TYPE_EX |  |
| EMS_AB_DL_EXTERNAL_MEMBER_COUNT |  |
| EMS_AB_DL_TOTAL_MEMBER_COUNT |  |
| EMS_AB_DL_MEM_SUBMIT_PERMS_BL_O |  |
| EMS_AB_DL_MEM_SUBMIT_PERMS |  |
| EMS_AB_DL_MEM_REJECT_PERMS |  |
| ADDRESS_BOOK_ENTRYID |  |
| EMS_AB_EXTENSION_ATTRIBUTE_1 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_10 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_11 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_12 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_13 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_14 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_15 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_2 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_3 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_4 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_5 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_6 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_7 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_8 |  |
| EMS_AB_EXTENSION_ATTRIBUTE_9 |  |
| EMS_AB_FOLDER_PATHNAME |  |
| EMS_AB_HAB_CHILD_DEPARTMENTS |  |
| EMS_AB_HAB_DEPARTMENT_MEMBERS |  |
| EMS_AB_HAB_IS_HIERARCHICAL_GROUP |  |
| EMS_AB_HAB_PARENT_DEPARTMENT |  |
| EMS_AB_HAB_ROOT_DEPARTMENT |  |
| EMS_AB_HAB_SHOW_IN_DEPARTMENTS |  |
| EMS_AB_HOME_MDB |  |
| EMS_AB_IS_MASTER |  |
| EMS_AB_IS_MEMBER_OF_DL |  |
| EMS_AB_MANAGE_DL |  |
| EMS_AB_MANAGER |  |
| EMS_AB_MANAGER_T |  |
| EMS_AB_MEMBER |  |
| EMS_AB_ENABLE_MODERATION |  |
| EMS_AB_NETWORK_ADDRESS |  |
| EMS_AB_OBJ_DIST_NAME |  |
| EMS_AB_OBJECT_GUID |  |
| EMS_AB_ORG_UNIT_ROOT_DN |  |
| EMS_AB_OWNER_O |  |
| EMS_AB_OWNER_BL_O |  |
| EMS_AB_PARENT_ENTRYID |  |
| EMS_AB_PHONETIC_COMPANY_NAME |  |
| EMS_AB_PHONETIC_DEPARTMENT_NAME |  |
| EMS_AB_PHONETIC_DISPLAY_NAME |  |
| EMS_AB_PHONETIC_GIVEN_NAME |  |
| EMS_AB_PHONETIC_SURNAME |  |
| EMS_AB_PROXY_ADDRESSES |  |
| EMS_AB_PUBLIC_DELEGATES |  |
| EMS_AB_REPORTS |  |
| EMS_AB_ROOM_CAPACITY |  |
| EMS_AB_ROOM_CONTAINERS |  |
| EMS_AB_ROOM_DESCRIPTION |  |
| EMS_AB_DL_SENDER_HINT_TRANSLATIONS_W |  |
| EMS_AB_TARGET_ADDRESS |  |
| EMS_AB_UNAUTH_ORIG |  |
| EMS_AB_X509_CERT |  |
| ADDRTYPE |  |
| ALTERNATE_RECIPIENT_ALLOWED |  |
| ANR |  |
| ARCHIVE_DATE |  |
| ARCHIVE_PERIOD |  |
| ARCHIVE_TAG |  |
| ASSISTANT |  |
| ASSISTANT_TELEPHONE_NUMBER |  |
| ATTACH_ADDITIONAL_INFO |  |
| ATTACH_CONTENT_ID |  |
| ATTACH_CONTENT_LOCATION |  |
| ATTACH_DATA_BIN |  |
| ATTACH_DATA_OBJ |  |
| ATTACH_ENCODING |  |
| ATTACH_EXTENSION |  |
| ATTACH_FILENAME |  |
| ATTACH_FLAGS |  |
| ATTACH_LONG_FILENAME |  |
| ATTACH_LONG_PATHNAME |  |
| ATTACHMENT_CONTACTPHOTO |  |
| ATTACHMENT_FLAGS |  |
| ATTACHMENT_HIDDEN |  |
| ATTACHMENT_LINKID |  |
| ATTACH_METHOD |  |
| ATTACH_MIME_TAG |  |
| ATTACH_NUM |  |
| ATTACH_PATHNAME |  |
| ATTACH_PAYLOAD_CLASS |  |
| ATTACH_PAYLOAD_PROV_GUID_STR |  |
| ATTACH_RENDERING |  |
| ATTACH_SIZE |  |
| ATTACH_TAG |  |
| ATTACH_TRANSPORT_NAME |  |
| ATTR_HIDDEN |  |
| ATTR_READONLY |  |
| AUTO_FORWARD_COMMENT |  |
| AUTO_FORWARDED |  |
| AUTO_RESPONSE_SUPPRESS |  |
| BIRTHDAY |  |
| BLOCK_STATUS |  |
| BODY |  |
| BODY_CONTENT_ID |  |
| BODY_CONTENT_LOCATION |  |
| BODY_HTML |  |
| BUSINESS2_TELEPHONE_NUMBER_A |  |
| BUSINESS2_TELEPHONE_NUMBER_A_MV |  |
| BUSINESS_FAX_NUMBER |  |
| BUSINESS_HOME_PAGE |  |
| BUSINESS_TELEPHONE_NUMBER |  |
| CALLBACK_TELEPHONE_NUMBER |  |
| CAR_TELEPHONE_NUMBER |  |
| CDO_RECURRENCEID |  |
| CHANGE_KEY |  |
| CHILDRENS_NAMES |  |
| CLIENT_ACTIONS |  |
| CLIENT_SUBMIT_TIME |  |
| CODE_PAGE_ID |  |
| COMMENT |  |
| COMPANY_MAIN_PHONE_NUMBER |  |
| COMPANY_NAME |  |
| COMPUTER_NETWORK_NAME |  |
| CONFLICT_ENTRYID |  |
| CONTAINER_CLASS |  |
| CONTAINER_CONTENTS |  |
| CONTAINER_FLAGS |  |
| CONTAINER_HIERARCHY |  |
| CONTENT_COUNT |  |
| CONTENT_FILTER_SCL |  |
| CONTENT_UNREAD |  |
| CONVERSATION_ID |  |
| CONVERSATION_INDEX |  |
| CONVERSATION_INDEX_TRACKING |  |
| CONVERSATION_TOPIC |  |
| COUNTRY |  |
| CREATION_TIME |  |
| CREATOR_ENTRYID |  |
| CREATOR_NAME |  |
| CUSTOMER_ID |  |
| DAM_BACK_PATCHED |  |
| DAM_ORIGINAL_ENTRYID |  |
| DEF_POST_MSGCLASS |  |
| DAM_ORIG_MSG_SVREID |  |
| DEFERRED_DELIVERY_TIME |  |
| DEFERRED_SEND_NUMBER |  |
| DEFERRED_SEND_TIME |  |
| DEFERRED_SEND_UNITS |  |
| DELEGATED_BY_RULE |  |
| DELEGATE_FLAGS |  |
| DELETE_AFTER_SUBMIT |  |
| DELETED_COUNT_TOTAL |  |
| DELETED_ON |  |
| DELIVER_TIME |  |
| DEPARTMENT_NAME |  |
| DEPTH |  |
| DISPLAY_BCC |  |
| DISPLAY_CC |  |
| DISPLAY_NAME |  |
| DISPLAY_NAME_PREFIX |  |
| DISPLAY_TO |  |
| DISPLAY_TYPE |  |
| DISPLAY_TYPE_EX |  |
| EMAIL_ADDRESS |  |
| END_DATE |  |
| ENTRYID |  |
| EXCEPTION_ENDTIME |  |
| EXCEPTION_REPLACETIME |  |
| EXCEPTION_STARTTIME |  |
| EXPIRY_NUMBER |  |
| EXPIRY_TIME |  |
| EXPIRY_UNITS |  |
| EXTENDED_FOLDER_FLAGS |  |
| EXTENDED_RULE_MSG_ACTIONS |  |
| EXTENDED_RULE_MSG_CONDITION |  |
| EXTENDED_RULE_SIZE_LIMIT |  |
| FLAG_COMPLETE_TIME |  |
| FLAG_STATUS |  |
| FLAT_URL_NAME |  |
| FOLDER_ASSOCIATED_CONTENTS |  |
| FOLDER_FLAGS |  |
| FOLDER_TYPE |  |
| FOLLOWUP_ICON |  |
| FREEBUSY_COUNT_MONTHS |  |
| FREEBUSY_ENTRYIDS |  |
| FREEBUSY_EMA |  |
| FREEBUSY_PUBLISH_END |  |
| FREEBUSY_PUBLISH_START |  |
| FREEBUSY_RANGE_TIMESTAMP |  |
| FTP_SITE |  |
| GATEWAY_NEEDS_TO_REFRESH |  |
| GENDER |  |
| GENERATION |  |
| GIVEN_NAME |  |
| GOVERNMENT_ID_NUMBER |  |
| HASATTACH |  |
| HAS_DAMS |  |
| HAS_NAMED_PROPERTIES |  |
| HAS_RULES |  |
| HIERARCHY_CHANGE_NUM |  |
| HIER_REV |  |
| HOBBIES |  |
| HOME2_TELEPHONE_NUMBER |  |
| HOME2_TELEPHONE_NUMBER_A_MV |  |
| HOME_ADDRESS_CITY |  |
| HOME_ADDRESS_COUNTRY |  |
| HOME_ADDRESS_POSTAL_CODE |  |
| HOME_ADDRESS_POST_OFFICE_BOX |  |
| HOME_ADDRESS_STATE_OR_PROVINCE |  |
| HOME_ADDRESS_STREET |  |
| HOME_FAX_NUMBER |  |
| HOME_TELEPHONE_NUMBER |  |
| HTML |  |
| ICON_INDEX |  |
| IMPORTANCE |  |
| IN_CONFLICT |  |
| INITIAL_DETAILS_PANE |  |
| INITIALS |  |
| IN_REPLY_TO_ID |  |
| INSTANCE_KEY |  |
| INTERNET_CPID |  |
| INETMAIL_OVERRIDE_FORMAT |  |
| INTERNET_MESSAGE_ID |  |
| INTERNET_REFERENCES |  |
| IPM_APPOINTMENT_ENTRYID |  |
| IPM_CONTACT_ENTRYID |  |
| IPM_DRAFTS_ENTRYID |  |
| IPM_JOURNAL_ENTRYID |  |
| IPM_NOTE_ENTRYID |  |
| IPM_TASK_ENTRYID |  |
| ISDN_NUMBER |  |
| JUNK_ADD_RECIPS_TO_SSL |  |
| JUNK_INCLUDE_CONTACTS |  |
| JUNK_PERMANENTLY_DELETE |  |
| JUNK_PHISHING_ENABLE_LINKS |  |
| JUNK_THRESHOLD |  |
| KEYWORD |  |
| LANGUAGE |  |
| LAST_MODIFICATION_TIME |  |
| LAST_MODIFIER_ENTRYID |  |
| LAST_MODIFIER_NAME |  |
| LAST_VERB_EXECUTED |  |
| LAST_VERB_EXECUTION_TIME |  |
| LIST_HELP |  |
| LIST_SUBSCRIBE |  |
| LIST_UNSUBSCRIBE |  |
| LOCAL_COMMIT_TIME |  |
| LOCAL_COMMIT_TIME_MAX |  |
| LOCALE_ID |  |
| LOCALITY |  |
| LOCATION |  |
| MAILBOX_OWNER_ENTRYID |  |
| MAILBOX_OWNER_NAME |  |
| MANAGER_NAME |  |
| MAPPING_SIGNATURE |  |
| MAX_SUBMIT_MESSAGE_SIZE |  |
| MEMBER_ID |  |
| MEMBER_NAME |  |
| MEMBER_RIGHTS |  |
| MESSAGE_ATTACHMENTS |  |
| MESSAGE_CC_ME |  |
| MESSAGE_CLASS |  |
| MESSAGE_CODEPAGE |  |
| MESSAGE_DELIVERY_TIME |  |
| MSG_EDITOR_FORMAT |  |
| MESSAGE_FLAGS |  |
| MHS_COMMON_NAME |  |
| MESSAGE_LOCALE_ID |  |
| MESSAGE_RECIP_ME |  |
| MESSAGE_RECIPIENTS |  |
| MESSAGE_SIZE |  |
| MESSAGE_SIZE_EXTENDED |  |
| MSG_STATUS |  |
| MESSAGE_SUBMISSION_ID |  |
| MESSAGE_TO_ME |  |
| MIDDLE_NAME |  |
| MOBILE_TELEPHONE_NUMBER |  |
| NATIVE_BODY_INFO |  |
| NEXT_SEND_ACCT |  |
| NICKNAME |  |
| NDR_DIAG_CODE |  |
| NDR_REASON_CODE |  |
| NDR_STATUS_CODE |  |
| NON_RECEIPT_NOTIFICATION_REQUESTED |  |
| NORMALIZED_SUBJECT |  |
| OBJECT_TYPE |  |
| OFFICE_LOCATION |  |
| OAB_CONTAINER_GUID |  |
| OAB_DN |  |
| OAB_MESSAGE_CLASS |  |
| OAB_NAME |  |
| OAB_SEQUENCE |  |
| OAB_TRUNCATED_PROPS |  |
| ORDINAL_MOST |  |
| ORGANIZATIONAL_ID_NUMBER |  |
| ORIGINAL_AUTHOR_ENTRYID |  |
| ORIGINAL_AUTHOR_NAME_W |  |
| ORIGINAL_DELIVERY_TIME |  |
| ORIGINAL_DISPLAY_BCC |  |
| ORIGINAL_DISPLAY_CC |  |
| ORIGINAL_DISPLAY_TO |  |
| ORIGINAL_ENTRYID |  |
| ORIG_MESSAGE_CLASS |  |
| ORIGINAL_SENDER_ADDRTYPE |  |
| ORIGINAL_SENDER_EMAIL_ADDRESS |  |
| ORIGINAL_SENDER_ENTRYID |  |
| ORIGINAL_SENDER_NAME |  |
| ORIGINAL_SENDER_SEARCH_KEY |  |
| ORIGINAL_SENSITIVITY |  |
| ORIGINAL_SENT_REPRESENTING_ADDRTYPE |  |
| ORIGINAL_SENT_REPRESENTING_EMAIL_ADDRESS |  |
| ORIGINAL_SENT_REPRESENTING_ENTRYID |  |
| ORIGINAL_SENT_REPRESENTING_NAME |  |
| ORIGINAL_SENT_REPRESENTING_SEARCH_KEY |  |
| ORIGINAL_SUBJECT |  |
| ORIGINAL_SUBMIT_TIME |  |
| ORIGINATOR_DELIVERY_REPORT_REQUESTED |  |
| ORIGINATOR_NON_DELIVERY_REPORT_REQUESTED |  |
| OSC_SYNC_ENABLEDONSERVER |  |
| OTHER_ADDRESS_CITY |  |
| OTHER_ADDRESS_COUNTRY |  |
| OTHER_ADDRESS_POSTAL_CODE |  |
| OTHER_ADDRESS_POST_OFFICE_BOX |  |
| OTHER_ADDRESS_STATE_OR_PROVINCE |  |
| OTHER_ADDRESS_STREET |  |
| OTHER_TELEPHONE_NUMBER |  |
| OOF_STATE |  |
| OWNER_APPT_ID |  |
| PAGER_TELEPHONE_NUMBER |  |
| PARENT_ENTRYID |  |
| PARENT_KEY |  |
| PARENT_SOURCE_KEY |  |
| PERSONAL_HOME_PAGE |  |
| POLICY_TAG |  |
| POSTAL_ADDRESS |  |
| POSTAL_CODE |  |
| POST_OFFICE_BOX |  |
| PREDECESSOR_CHANGE_LIST |  |
| PRIMARY_FAX_NUMBER |  |
| PRIMARY_SEND_ACCT |  |
| PRIMARY_TELEPHONE_NUMBER |  |
| PRIORITY |  |
| PROCESSED |  |
| PROFESSION |  |
| PROHIBIT_RECEIVE_QUOTA |  |
| PROHIBIT_SEND_QUOTA |  |
| PURPORTED_SENDER_DOMAIN |  |
| RADIO_TELEPHONE_NUMBER |  |
| READ |  |
| READ_RECEIPT_ENTRYID |  |
| READ_RECEIPT_REQUESTED |  |
| READ_RECEIPT_SEARCH_KEY |  |
| RECEIPT_TIME |  |
| RECEIVED_BY_ADDRTYPE |  |
| RECEIVED_BY_EMAIL_ADDRESS |  |
| RECEIVED_BY_ENTRYID |  |
| RECEIVED_BY_NAME |  |
| RECEIVED_BY_SEARCH_KEY |  |
| RCVD_REPRESENTING_ADDRTYPE |  |
| RCVD_REPRESENTING_EMAIL_ADDRESS |  |
| RCVD_REPRESENTING_ENTRYID |  |
| RCVD_REPRESENTING_NAME |  |
| RCVD_REPRESENTING_SEARCH_KEY |  |
| RECIPIENT_DISPLAY_NAME |  |
| RECIPIENT_ENTRYID |  |
| RECIPIENT_FLAGS |  |
| RECIPIENT_ORDER |  |
| RECIPIENT_PROPOSED |  |
| RECIPIENT_PROPOSEDENDTIME |  |
| RECIPIENT_PROPOSEDSTARTTIME |  |
| RECIPIENT_REASSIGNMENT_PROHIBITED |  |
| RECIPIENT_TRACKSTATUS |  |
| RECIPIENT_TRACKSTATUS_TIME |  |
| RECIPIENT_TYPE |  |
| RECORD_KEY |  |
| REFERRED_BY_NAME |  |
| REM_ONLINE_ENTRYID |  |
| DSN_REMOTE_MTA |  |
| RENDERING_POSITION |  |
| REPLY_RECIPIENT_ENTRIES |  |
| REPLY_RECIPIENT_NAMES |  |
| REPLY_REQUESTED |  |
| REPLY_TEMPLATE_ID |  |
| REPLY_TIME |  |
| REPORT_DISPOSITION_W |  |
| REPORT_DISPOSITION_MODE_W |  |
| REPORT_ENTRYID |  |
| REPORT_NAME |  |
| REPORT_SEARCH_KEY |  |
| REPORT_TAG |  |
| REPORT_TEXT |  |
| REPORT_TIME |  |
| RESOLVE_METHOD |  |
| RESPONSE_REQUESTED |  |
| RESPONSIBILITY |  |
| RETENTION_DATE |  |
| RETENTION_FLAGS |  |
| RETENTION_PERIOD |  |
| RIGHTS |  |
| ROAMING_DATATYPES |  |
| ROAMING_DICTIONARY |  |
| ROAMING_XMLSTREAM |  |
| ROWID |  |
| ROW_TYPE |  |
| RTF_COMPRESSED |  |
| RTF_IN_SYNC |  |
| RULE_ACTION_NUMBER |  |
| RULE_ACTIONS |  |
| RULE_ACTION_TYPE |  |
| RULE_CONDITION |  |
| RULE_ERROR |  |
| RULE_FOLDER_ENTRYID |  |
| RULE_ID |  |
| RULE_IDS |  |
| RULE_LEVEL |  |
| RULE_MSG_LEVEL |  |
| RULE_MSG_PROVIDER_DATA |  |
| RULE_MSG_SEQUENCE |  |
| RULE_MSG_STATE |  |
| RULE_MSG_USER_FLAGS |  |
| RULE_NAME |  |
| RULE_PROVIDER |  |
| RULE_PROVIDER_DATA |  |
| RULE_SEQUENCE |  |
| RULE_STATE |  |
| RULE_USER_FLAGS |  |
| RW_RULES_STREAM |  |
| SCHDINFO_APPT_TOMBSTONE |  |
| SCHDINFO_AUTO_ACCEPT_APPTS |  |
| SCHDINFO_DELEGATE_ENTRYIDS |  |
| SCHDINFO_DELEGATE_NAMES |  |
| SCHDINFO_DELEGATE_NAMES_W |  |
| SCHDINFO_BOSS_WANTS_COPY |  |
| SCHDINFO_BOSS_WANTS_INFO |  |
| SCHDINFO_DISALLOW_OVERLAPPING_APPTS |  |
| SCHDINFO_DISALLOW_RECURRING_APPTS |  |
| SCHDINFO_DONT_MAIL_DELEGATES |  |
| SCHDINFO_FREEBUSY |  |
| SCHDINFO_FREEBUSY_OOF |  |
| SCHDINFO_FREEBUSY_BUSY |  |
| SCHDINFO_FREEBUSY_MERGED |  |
| SCHDINFO_FREEBUSY_TENTATIVE |  |
| SCHDINFO_MONTHS_OOF |  |
| SCHDINFO_MONTHS_BUSY |  |
| SCHDINFO_MONTHS_MERGED |  |
| SCHDINFO_MONTHS_TENTATIVE |  |
| SCHDINFO_RESOURCE_TYPE |  |
| SPLUS_FREE_BUSY_ENTRYID |  |
| EMS_SCRIPT_BLOB |  |
| WB_SF_DEFINITION |  |
| WB_SF_EFP_FLAGS |  |
| WB_SF_EXPIRATION |  |
| WB_SF_ID |  |
| WB_SF_LAST_USED |  |
| WB_SF_RECREATE_INFO |  |
| WB_SF_STORAGE_TYPE |  |
| WB_SF_TAG |  |
| WB_SF_TEMPLATE_ID |  |
| SEARCH_KEY |  |
| NT_SECURITY_DESCRIPTOR_AS_XML |  |
| SELECTABLE |  |
| SENDER_ADDRTYPE |  |
| SENDER_EMAIL_ADDRESS |  |
| SENDER_ENTRYID |  |
| SENDER_ID_STATUS |  |
| SENDER_NAME |  |
| SENDER_SEARCH_KEY |  |
| SEND_INTERNET_ENCODING |  |
| SEND_RICH_INFO |  |
| SENSITIVITY |  |
| SENT_REPRESENTING_ADDRTYPE |  |
| SENT_REPRESENTING_EMAIL_ADDRESS |  |
| SENT_REPRESENTING_ENTRYID |  |
| SENT_REPRESENTING_NAME |  |
| SENT_REPRESENTING_SEARCH_KEY |  |
| SENT_REPRESENTING_SMTP_ADDRESS |  |
| SMTP_ADDRESS |  |
| SORT_LOCALE_ID |  |
| SOURCE_KEY |  |
| EMS_AB_UM_SPOKEN_NAME |  |
| SPOUSE_NAME |  |
| START_DATE |  |
| START_DATE_ETC |  |
| STATE_OR_PROVINCE |  |
| STORE_ENTRYID |  |
| STORE_STATE |  |
| STORE_SUPPORT_MASK |  |
| STREET_ADDRESS |  |
| SUBFOLDERS |  |
| SUBJECT |  |
| SUBJECT_PREFIX |  |
| SUPPLEMENTARY_INFO |  |
| SURNAME |  |
| SWAPPED_TODO_DATA |  |
| SWAPPED_TODO_STORE |  |
| TARGET_ENTRYID |  |
| TTYTDD_PHONE_NUMBER |  |
| TELEX_NUMBER |  |
| EMS_TEMPLATE_BLOB |  |
| TEMPLATEID |  |
| EMS_AB_THUMBNAIL_PHOTO |  |
| TITLE |  |
| TNEF_CORRELATION_KEY |  |
| TODO_ITEM_FLAGS |  |
| TRANSMITABLE_DISPLAY_NAME |  |
| TRANSPORT_MESSAGE_HEADERS |  |
| TRUST_SENDER |  |
| USER_CERTIFICATE |  |
| USER_ENTRYID |  |
| USER_X509_CERTIFICATE |  |
| VD_BINARY |  |
| VD_NAME |  |
| VD_STRINGS |  |
| VD_VERSION |  |
| WEDDING_ANNIVERSARY |  |
| WLINK_ABEID |  |
| WLINK_AB_EXSTOREEID |  |
| WLINK_CALENDAR_COLOR |  |
| WLINK_CLIENTID |  |
| WLINK_ENTRYID |  |
| WLINK_FLAGS |  |
| WLINK_FOLDER_TYPE |  |
| WLINK_GROUP_CLSID |  |
| WLINK_GROUP_NAME |  |
| WLINK_ORDINAL |  |
| WLINK_RECKEY |  |
| WLINK_RO_GROUP_TYPE |  |
| WLINK_SECTION |  |
| WLINK_STORE_ENTRYID |  |
| WLINK_TYPE |  |
| ABSTRACT |  |
| ACTIVE_USER_ENTRYID |  |
| ADDRBOOK_FOR_LOCAL_SITE_ENTRYID |  |
| ADDRESS_BOOK_DISPLAY_NAME |  |
| ARRIVAL_TIME |  |
| ASSOC_MESSAGE_SIZE |  |
| ASSOC_MESSAGE_SIZE_EXTENDED |  |
| ASSOC_MSG_W_ATTACH_COUNT |  |
| ATTACH_ON_ASSOC_MSG_COUNT |  |
| ATTACH_ON_NORMAL_MSG_COUNT |  |
| AUTO_ADD_NEW_SUBS |  |
| BILATERAL_INFO |  |
| CACHED_COLUMN_COUNT |  |
| CATEG_COUNT |  |
| CHANGE_ADVISOR |  |
| CHANGE_NOTIFICATION_GUID |  |
| COLLECTOR |  |
| CONTACT_COUNT |  |
| CONTENT_SEARCH_KEY |  |
| CONTENTS_SYNCHRONIZER |  |
| DELETED_ASSOC_MESSAGE_SIZE_EXTENDED |  |
| DELETED_ASSOC_MSG_COUNT |  |
| DELETED_FOLDER_COUNT |  |
| DELETED_MESSAGE_SIZE_EXTENDED |  |
| DELETED_MSG_COUNT |  |
| DELETED_NORMAL_MESSAGE_SIZE_EXTENDED |  |
| DESIGN_IN_PROGRESS |  |
| DISABLE_FULL_FIDELITY |  |
| DISABLE_WINSOCK |  |
| DL_REPORT_FLAGS |  |
| EFORMS_FOR_LOCALE_ENTRYID |  |
| EFORMS_LOCALE_ID |  |
| EFORMS_REGISTRY_ENTRYID |  |
| EMS_AB_ACCESS_CATEGORY |  |
| EMS_AB_ACTIVATION_SCHEDULE |  |
| EMS_AB_ACTIVATION_STYLE |  |
| EMS_AB_ADDRESS_ENTRY_DISPLAY_TABLE |  |
| EMS_AB_ADDRESS_ENTRY_DISPLAY_TABLE_MSDOS |  |
| EMS_AB_ADDRESS_SYNTAX |  |
| EMS_AB_ADDRESS_TYPE |  |
| EMS_AB_ADMD |  |
| EMS_AB_ADMIN_DESCRIPTION |  |
| EMS_AB_ADMIN_DISPLAY_NAME |  |
| EMS_AB_ADMIN_EXTENSION_DLL |  |
| EMS_AB_ALIASED_OBJECT_NAME |  |
| EMS_AB_ALIASED_OBJECT_NAME_O |  |
| EMS_AB_ALT_RECIPIENT |  |
| EMS_AB_ALT_RECIPIENT_BL |  |
| EMS_AB_ALT_RECIPIENT_BL_O |  |
| EMS_AB_ALT_RECIPIENT_O |  |
| EMS_AB_ANCESTOR_ID |  |
| EMS_AB_ANONYMOUS_ACCESS |  |
| EMS_AB_ANONYMOUS_ACCOUNT |  |
| EMS_AB_ASSOC_NT_ACCOUNT |  |
| EMS_AB_ASSOC_PROTOCOL_CFG_NNTP |  |
| EMS_AB_ASSOC_PROTOCOL_CFG_NNTP_O |  |
| EMS_AB_ASSOC_REMOTE_DXA |  |
| EMS_AB_ASSOC_REMOTE_DXA_O |  |
| EMS_AB_ASSOCIATION_LIFETIME |  |
| EMS_AB_ATTRIBUTE_CERTIFICATE |  |
| EMS_AB_AUTH_ORIG_BL |  |
| EMS_AB_AUTH_ORIG_BL_O |  |
| EMS_AB_AUTHENTICATION_TO_USE |  |
| EMS_AB_AUTHORITY_REVOCATION_LIST |  |
| EMS_AB_AUTHORIZED_DOMAIN |  |
| EMS_AB_AUTHORIZED_PASSWORD |  |
| EMS_AB_AUTHORIZED_PASSWORD_CONFIRM |  |
| EMS_AB_AUTHORIZED_USER |  |
| EMS_AB_AUTOREPLY |  |
| EMS_AB_AUTOREPLY_MESSAGE |  |
| EMS_AB_AUTOREPLY_SUBJECT |  |
| EMS_AB_AVAILABLE_AUTHORIZATION_PACKAGES |  |
| EMS_AB_AVAILABLE_DISTRIBUTIONS |  |
| EMS_AB_BRIDGEHEAD_SERVERS |  |
| EMS_AB_BRIDGEHEAD_SERVERS_O |  |
| EMS_AB_BUSINESS_CATEGORY |  |
| EMS_AB_BUSINESS_ROLES |  |
| EMS_AB_CA_CERTIFICATE |  |
| EMS_AB_CAN_CREATE_PF |  |
| EMS_AB_CAN_CREATE_PF_BL |  |
| EMS_AB_CAN_CREATE_PF_BL_O |  |
| EMS_AB_CAN_CREATE_PF_DL |  |
| EMS_AB_CAN_CREATE_PF_DL_BL |  |
| EMS_AB_CAN_CREATE_PF_DL_BL_O |  |
| EMS_AB_CAN_CREATE_PF_DL_O |  |
| EMS_AB_CAN_CREATE_PF_O |  |
| EMS_AB_CAN_NOT_CREATE_PF |  |
| EMS_AB_CAN_NOT_CREATE_PF_BL |  |
| EMS_AB_CAN_NOT_CREATE_PF_BL_O |  |
| EMS_AB_CAN_NOT_CREATE_PF_DL |  |
| EMS_AB_CAN_NOT_CREATE_PF_DL_BL |  |
| EMS_AB_CAN_NOT_CREATE_PF_DL_BL_O |  |
| EMS_AB_CAN_NOT_CREATE_PF_DL_O |  |
| EMS_AB_CAN_NOT_CREATE_PF_O |  |
| EMS_AB_CAN_PRESERVE_DNS |  |
| EMS_AB_CERTIFICATE_CHAIN_V3 |  |
| EMS_AB_CERTIFICATE_REVOCATION_LIST |  |
| EMS_AB_CERTIFICATE_REVOCATION_LIST_V1 |  |
| EMS_AB_CERTIFICATE_REVOCATION_LIST_V3 |  |
| EMS_AB_CHARACTER_SET |  |
| EMS_AB_CHARACTER_SET_LIST |  |
| EMS_AB_CHILD_RDNS |  |
| EMS_AB_CLIENT_ACCESS_ENABLED |  |
| EMS_AB_CLOCK_ALERT_OFFSET |  |
| EMS_AB_CLOCK_ALERT_REPAIR |  |
| EMS_AB_CLOCK_WARNING_OFFSET |  |
| EMS_AB_CLOCK_WARNING_REPAIR |  |
| EMS_AB_COMPROMISED_KEY_LIST |  |
| EMS_AB_COMPUTER_NAME |  |
| EMS_AB_CONNECTED_DOMAINS |  |
| EMS_AB_CONNECTION_LIST_FILTER |  |
| EMS_AB_CONNECTION_LIST_FILTER_TYPE |  |
| EMS_AB_CONNECTION_TYPE |  |
| EMS_AB_CONTAINER_INFO |  |
| EMS_AB_CONTENT_TYPE |  |
| EMS_AB_CONTROL_MSG_FOLDER_ID |  |
| EMS_AB_CONTROL_MSG_RULES |  |
| EMS_AB_COST |  |
| EMS_AB_COUNTRY_NAME |  |
| EMS_AB_CROSS_CERTIFICATE_CRL |  |
| EMS_AB_CROSS_CERTIFICATE_PAIR |  |
| EMS_AB_DEFAULT_MESSAGE_FORMAT |  |
| EMS_AB_DELEGATE_USER |  |
| EMS_AB_DELIV_EITS |  |
| EMS_AB_DELIV_EXT_CONT_TYPES |  |
| EMS_AB_DELIVER_AND_REDIRECT |  |
| EMS_AB_DELIVERY_MECHANISM |  |
| EMS_AB_DELTA_REVOCATION_LIST |  |
| EMS_AB_DESCRIPTION |  |
| EMS_AB_DESTINATION_INDICATOR |  |
| EMS_AB_DIAGNOSTIC_REG_KEY |  |
| EMS_AB_DISABLE_DEFERRED_COMMIT |  |
| EMS_AB_DISABLED_GATEWAY_PROXY |  |
| EMS_AB_DISPLAY_NAME_OVERRIDE |  |
| EMS_AB_DISPLAY_NAME_SUFFIX |  |
| EMS_AB_DL_MEM_REJECT_PERMS_BL |  |
| EMS_AB_DL_MEM_REJECT_PERMS_BL_O |  |
| EMS_AB_DL_MEMBER_RULE |  |
| EMS_AB_DMD_NAME |  |
| EMS_AB_DO_OAB_VERSION |  |
| EMS_AB_DOMAIN_DEF_ALT_RECIP |  |
| EMS_AB_DOMAIN_DEF_ALT_RECIP_O |  |
| EMS_AB_DOMAIN_NAME |  |
| EMS_AB_DSA_SIGNATURE |  |
| EMS_AB_DXA_ADMIN_COPY |  |
| EMS_AB_DXA_ADMIN_FORWARD |  |
| EMS_AB_DXA_ADMIN_UPDATE |  |
| EMS_AB_DXA_APPEND_REQCN |  |
| EMS_AB_DXA_CONF_CONTAINER_LIST |  |
| EMS_AB_DXA_CONF_CONTAINER_LIST_O |  |
| EMS_AB_DXA_CONF_REQ_TIME |  |
| EMS_AB_DXA_CONF_SEQ |  |
| EMS_AB_DXA_CONF_SEQ_USN |  |
| EMS_AB_DXA_EXCHANGE_OPTIONS |  |
| EMS_AB_DXA_EXPORT_NOW |  |
| EMS_AB_DXA_FLAGS |  |
| EMS_AB_DXA_IMP_SEQ |  |
| EMS_AB_DXA_IMP_SEQ_TIME |  |
| EMS_AB_DXA_IMP_SEQ_USN |  |
| EMS_AB_DXA_IMPORT_NOW |  |
| EMS_AB_DXA_IN_TEMPLATE_MAP |  |
| EMS_AB_DXA_LOCAL_ADMIN |  |
| EMS_AB_DXA_LOCAL_ADMIN_O |  |
| EMS_AB_DXA_LOGGING_LEVEL |  |
| EMS_AB_DXA_NATIVE_ADDRESS_TYPE |  |
| EMS_AB_DXA_OUT_TEMPLATE_MAP |  |
| EMS_AB_DXA_PASSWORD |  |
| EMS_AB_DXA_PREV_EXCHANGE_OPTIONS |  |
| EMS_AB_DXA_PREV_EXPORT_NATIVE_ONLY |  |
| EMS_AB_DXA_PREV_IN_EXCHANGE_SENSITIVITY |  |
| EMS_AB_DXA_PREV_REMOTE_ENTRIES |  |
| EMS_AB_DXA_PREV_REMOTE_ENTRIES_O |  |
| EMS_AB_DXA_PREV_REPLICATION_SENSITIVITY |  |
| EMS_AB_DXA_PREV_TEMPLATE_OPTIONS |  |
| EMS_AB_DXA_PREV_TYPES |  |
| EMS_AB_DXA_RECIPIENT_CP |  |
| EMS_AB_DXA_REMOTE_CLIENT |  |
| EMS_AB_DXA_REMOTE_CLIENT_O |  |
| EMS_AB_DXA_REQ_SEQ |  |
| EMS_AB_DXA_REQ_SEQ_TIME |  |
| EMS_AB_DXA_REQ_SEQ_USN |  |
| EMS_AB_DXA_REQNAME |  |
| EMS_AB_DXA_SVR_SEQ |  |
| EMS_AB_DXA_SVR_SEQ_TIME |  |
| EMS_AB_DXA_SVR_SEQ_USN |  |
| EMS_AB_DXA_TASK |  |
| EMS_AB_DXA_TEMPLATE_OPTIONS |  |
| EMS_AB_DXA_TEMPLATE_TIMESTAMP |  |
| EMS_AB_DXA_TYPES |  |
| EMS_AB_DXA_UNCONF_CONTAINER_LIST |  |
| EMS_AB_DXA_UNCONF_CONTAINER_LIST_O |  |
| EMS_AB_EMPLOYEE_NUMBER |  |
| EMS_AB_EMPLOYEE_TYPE |  |
| EMS_AB_ENABLE_COMPATIBILITY |  |
| EMS_AB_ENABLED |  |
| EMS_AB_ENABLED_AUTHORIZATION_PACKAGES |  |
| EMS_AB_ENABLED_PROTOCOL_CFG |  |
| EMS_AB_ENABLED_PROTOCOLS |  |
| EMS_AB_ENCAPSULATION_METHOD |  |
| EMS_AB_ENCRYPT |  |
| EMS_AB_ENCRYPT_ALG_LIST_NA |  |
| EMS_AB_ENCRYPT_ALG_LIST_OTHER |  |
| EMS_AB_ENCRYPT_ALG_SELECTED_NA |  |
| EMS_AB_ENCRYPT_ALG_SELECTED_OTHER |  |
| EMS_AB_EXPAND_DLS_LOCALLY |  |
| EMS_AB_EXPIRATION_TIME |  |
| EMS_AB_EXPORT_CONTAINERS |  |
| EMS_AB_EXPORT_CONTAINERS_O |  |
| EMS_AB_EXPORT_CUSTOM_RECIPIENTS |  |
| EMS_AB_EXTENDED_CHARS_ALLOWED |  |
| EMS_AB_EXTENSION_DATA |  |
| EMS_AB_EXTENSION_NAME |  |
| EMS_AB_EXTENSION_NAME_INHERITED |  |
| EMS_AB_FACSIMILE_TELEPHONE_NUMBER |  |
| EMS_AB_FILE_VERSION |  |
| EMS_AB_FILTER_LOCAL_ADDRESSES |  |
| EMS_AB_FOLDERS_CONTAINER |  |
| EMS_AB_FOLDERS_CONTAINER_O |  |
| EMS_AB_FORM_DATA |  |
| EMS_AB_FORWARDING_ADDRESS |  |
| EMS_AB_GARBAGE_COLL_PERIOD |  |
| EMS_AB_GATEWAY_LOCAL_CRED |  |
| EMS_AB_GATEWAY_LOCAL_DESIG |  |
| EMS_AB_GATEWAY_PROXY |  |
| EMS_AB_GATEWAY_ROUTING_TREE |  |
| EMS_AB_GENERATION_QUALIFIER |  |
| EMS_AB_GROUP_BY_ATTR_1 |  |
| EMS_AB_GROUP_BY_ATTR_2 |  |
| EMS_AB_GROUP_BY_ATTR_3 |  |
| EMS_AB_GROUP_BY_ATTR_4 |  |
| EMS_AB_GROUP_BY_ATTR_VALUE_DN |  |
| EMS_AB_GROUP_BY_ATTR_VALUE_DN_O |  |
| EMS_AB_GROUP_BY_ATTR_VALUE_STR |  |
| EMS_AB_GWART_LAST_MODIFIED |  |
| EMS_AB_HAS_FULL_REPLICA_NCS |  |
| EMS_AB_HAS_FULL_REPLICA_NCS_O |  |
| EMS_AB_HAS_MASTER_NCS |  |
| EMS_AB_HAS_MASTER_NCS_O |  |
| EMS_AB_HELP_DATA16 |  |
| EMS_AB_HELP_DATA32 |  |
| EMS_AB_HELP_FILE_NAME |  |
| EMS_AB_HEURISTICS |  |
| EMS_AB_HIDE_DL_MEMBERSHIP |  |
| EMS_AB_HIDE_FROM_ADDRESS_BOOK |  |
| EMS_AB_HIERARCHY_PATH |  |
| EMS_AB_HOME_MDB_BL |  |
| EMS_AB_HOME_MDB_BL_O |  |
| EMS_AB_HOME_MTA |  |
| EMS_AB_HOME_MTA_O |  |
| EMS_AB_HOME_PUBLIC_SERVER |  |
| EMS_AB_HOME_PUBLIC_SERVER_O |  |
| EMS_AB_HOUSE_IDENTIFIER |  |
| EMS_AB_HTTP_PUB_AB_ATTRIBUTES |  |
| EMS_AB_HTTP_PUB_GAL |  |
| EMS_AB_HTTP_PUB_GAL_LIMIT |  |
| EMS_AB_HTTP_PUB_PF |  |
| EMS_AB_HTTP_SERVERS |  |
| EMS_AB_IMPORT_CONTAINER |  |
| EMS_AB_IMPORT_CONTAINER_O |  |
| EMS_AB_IMPORT_SENSITIVITY |  |
| EMS_AB_IMPORTED_FROM |  |
| EMS_AB_INBOUND_ACCEPT_ALL |  |
| EMS_AB_INBOUND_DN |  |
| EMS_AB_INBOUND_DN_O |  |
| EMS_AB_INBOUND_HOST |  |
| EMS_AB_INBOUND_NEWSFEED |  |
| EMS_AB_INBOUND_NEWSFEED_TYPE |  |
| EMS_AB_INBOUND_SITES |  |
| EMS_AB_INBOUND_SITES_O |  |
| EMS_AB_INCOMING_MSG_SIZE_LIMIT |  |
| EMS_AB_INCOMING_PASSWORD |  |
| EMS_AB_INSADMIN |  |
| EMS_AB_INSADMIN_O |  |
| EMS_AB_INSTANCE_TYPE |  |
| EMS_AB_INTERNATIONAL_ISDN_NUMBER |  |
| EMS_AB_INVOCATION_ID |  |
| EMS_AB_IS_DELETED |  |
| EMS_AB_IS_SINGLE_VALUED |  |
| EMS_AB_KCC_STATUS |  |
| EMS_AB_KM_SERVER |  |
| EMS_AB_KM_SERVER_O |  |
| EMS_AB_KNOWLEDGE_INFORMATION |  |
| EMS_AB_LABELEDURI |  |
| EMS_AB_LANGUAGE |  |
| EMS_AB_LANGUAGE_ISO639 |  |
| EMS_AB_LDAP_DISPLAY_NAME |  |
| EMS_AB_LDAP_SEARCH_CFG |  |
| EMS_AB_LINE_WRAP |  |
| EMS_AB_LINK_ID |  |
| EMS_AB_LIST_PUBLIC_FOLDERS |  |
| EMS_AB_LOCAL_BRIDGE_HEAD |  |
| EMS_AB_LOCAL_BRIDGE_HEAD_ADDRESS |  |
| EMS_AB_LOCAL_INITIAL_TURN |  |
| EMS_AB_LOCAL_SCOPE |  |
| EMS_AB_LOCAL_SCOPE_O |  |
| EMS_AB_LOG_FILENAME |  |
| EMS_AB_LOG_ROLLOVER_INTERVAL |  |
| EMS_AB_MAIL_DROP |  |
| EMS_AB_MAINTAIN_AUTOREPLY_HISTORY |  |
| EMS_AB_MAPI_DISPLAY_TYPE |  |
| EMS_AB_MAPI_ID |  |
| EMS_AB_MAXIMUM_OBJECT_ID |  |
| EMS_AB_MDB_BACKOFF_INTERVAL |  |
| EMS_AB_MDB_MSG_TIME_OUT_PERIOD |  |
| EMS_AB_MDB_OVER_QUOTA_LIMIT |  |
| EMS_AB_MDB_STORAGE_QUOTA |  |
| EMS_AB_MDB_UNREAD_LIMIT |  |
| EMS_AB_MDB_USE_DEFAULTS |  |
| EMS_AB_MESSAGE_TRACKING_ENABLED |  |
| EMS_AB_MIME_TYPES |  |
| EMS_AB_MODERATED |  |
| EMS_AB_MODERATOR |  |
| EMS_AB_MONITOR_CLOCK |  |
| EMS_AB_MONITOR_SERVERS |  |
| EMS_AB_MONITOR_SERVICES |  |
| EMS_AB_MONITORED_CONFIGURATIONS |  |
| EMS_AB_MONITORED_CONFIGURATIONS_O |  |
| EMS_AB_MONITORED_SERVERS |  |
| EMS_AB_MONITORED_SERVERS_O |  |
| EMS_AB_MONITORED_SERVICES |  |
| EMS_AB_MONITORING_ALERT_DELAY |  |
| EMS_AB_MONITORING_ALERT_UNITS |  |
| EMS_AB_MONITORING_AVAILABILITY_STYLE |  |
| EMS_AB_MONITORING_AVAILABILITY_WINDOW |  |
| EMS_AB_MONITORING_CACHED_VIA_MAIL |  |
| EMS_AB_MONITORING_CACHED_VIA_MAIL_O |  |
| EMS_AB_MONITORING_CACHED_VIA_RPC |  |
| EMS_AB_MONITORING_CACHED_VIA_RPC_O |  |
| EMS_AB_MONITORING_ESCALATION_PROCEDURE |  |
| EMS_AB_MONITORING_HOTSITE_POLL_INTERVAL |  |
| EMS_AB_MONITORING_HOTSITE_POLL_UNITS |  |
| EMS_AB_MONITORING_MAIL_UPDATE_INTERVAL |  |
| EMS_AB_MONITORING_MAIL_UPDATE_UNITS |  |
| EMS_AB_MONITORING_NORMAL_POLL_INTERVAL |  |
| EMS_AB_MONITORING_NORMAL_POLL_UNITS |  |
| EMS_AB_MONITORING_RECIPIENTS |  |
| EMS_AB_MONITORING_RECIPIENTS_NDR |  |
| EMS_AB_MONITORING_RECIPIENTS_NDR_O |  |
| EMS_AB_MONITORING_RECIPIENTS_O |  |
| EMS_AB_MONITORING_RPC_UPDATE_INTERVAL |  |
| EMS_AB_MONITORING_RPC_UPDATE_UNITS |  |
| EMS_AB_MONITORING_WARNING_DELAY |  |
| EMS_AB_MONITORING_WARNING_UNITS |  |
| EMS_AB_MTA_LOCAL_CRED |  |
| EMS_AB_MTA_LOCAL_DESIG |  |
| EMS_AB_N_ADDRESS |  |
| EMS_AB_N_ADDRESS_TYPE |  |
| EMS_AB_NEWSFEED_TYPE |  |
| EMS_AB_NEWSGROUP |  |
| EMS_AB_NEWSGROUP_LIST |  |
| EMS_AB_NNTP_CHARACTER_SET |  |
| EMS_AB_NNTP_CONTENT_FORMAT |  |
| EMS_AB_NNTP_DISTRIBUTIONS |  |
| EMS_AB_NNTP_DISTRIBUTIONS_FLAG |  |
| EMS_AB_NNTP_NEWSFEEDS |  |
| EMS_AB_NNTP_NEWSFEEDS_O |  |
| EMS_AB_NT_MACHINE_NAME |  |
| EMS_AB_NT_SECURITY_DESCRIPTOR |  |
| EMS_AB_NUM_OF_OPEN_RETRIES |  |
| EMS_AB_NUM_OF_TRANSFER_RETRIES |  |
| EMS_AB_OBJ_VIEW_CONTAINERS |  |
| EMS_AB_OBJ_VIEW_CONTAINERS_O |  |
| EMS_AB_OBJECT_CLASS_CATEGORY |  |
| EMS_AB_OBJECT_OID |  |
| EMS_AB_OBJECT_VERSION |  |
| EMS_AB_OFF_LINE_AB_CONTAINERS |  |
| EMS_AB_OFF_LINE_AB_CONTAINERS_O |  |
| EMS_AB_OFF_LINE_AB_SCHEDULE |  |
| EMS_AB_OFF_LINE_AB_SERVER |  |
| EMS_AB_OFF_LINE_AB_SERVER_O |  |
| EMS_AB_OFF_LINE_AB_STYLE |  |
| EMS_AB_OID_TYPE |  |
| EMS_AB_OM_OBJECT_CLASS |  |
| EMS_AB_OM_SYNTAX |  |
| EMS_AB_OOF_REPLY_TO_ORIGINATOR |  |
| EMS_AB_OPEN_RETRY_INTERVAL |  |
| EMS_AB_ORGANIZATION_NAME |  |
| EMS_AB_ORGANIZATIONAL_UNIT_NAME |  |
| EMS_AB_ORIGINAL_DISPLAY_TABLE |  |
| EMS_AB_ORIGINAL_DISPLAY_TABLE_MSDOS |  |
| EMS_AB_OTHER_RECIPS |  |
| EMS_AB_OUTBOUND_HOST |  |
| EMS_AB_OUTBOUND_HOST_TYPE |  |
| EMS_AB_OUTBOUND_NEWSFEED |  |
| EMS_AB_OUTBOUND_SITES |  |
| EMS_AB_OUTBOUND_SITES_O |  |
| EMS_AB_OUTGOING_MSG_SIZE_LIMIT |  |
| EMS_AB_OVERRIDE_NNTP_CONTENT_FORMAT |  |
| EMS_AB_OWA_SERVER |  |
| EMS_AB_P_SELECTOR |  |
| EMS_AB_P_SELECTOR_INBOUND |  |
| EMS_AB_PER_MSG_DIALOG_DISPLAY_TABLE |  |
| EMS_AB_PER_RECIP_DIALOG_DISPLAY_TABLE |  |
| EMS_AB_PERIOD_REP_SYNC_TIMES |  |
| EMS_AB_PERIOD_REPL_STAGGER |  |
| EMS_AB_PERSONAL_TITLE |  |
| EMS_AB_PF_CONTACTS |  |
| EMS_AB_PF_CONTACTS_O |  |
| EMS_AB_POP_CHARACTER_SET |  |
| EMS_AB_POP_CONTENT_FORMAT |  |
| EMS_AB_PORT_NUMBER |  |
| EMS_AB_POSTAL_ADDRESS |  |
| EMS_AB_PREFERRED_DELIVERY_METHOD |  |
| EMS_AB_PRESERVE_INTERNET_CONTENT |  |
| EMS_AB_PRMD |  |
| EMS_AB_PROMO_EXPIRATION |  |
| EMS_AB_PROTOCOL_SETTINGS |  |
| EMS_AB_PROXY_GENERATION_ENABLED |  |
| EMS_AB_PROXY_GENERATOR_DLL |  |
| EMS_AB_PUBLIC_DELEGATES_BL |  |
| EMS_AB_PUBLIC_DELEGATES_BL_O |  |
| EMS_AB_QUOTA_NOTIFICATION_SCHEDULE |  |
| EMS_AB_QUOTA_NOTIFICATION_STYLE |  |
| EMS_AB_RANGE_LOWER |  |
| EMS_AB_RANGE_UPPER |  |
| EMS_AB_RAS_ACCOUNT |  |
| EMS_AB_RAS_CALLBACK_NUMBER |  |
| EMS_AB_RAS_PASSWORD |  |
| EMS_AB_RAS_PHONE_NUMBER |  |
| EMS_AB_RAS_PHONEBOOK_ENTRY_NAME |  |
| EMS_AB_RAS_REMOTE_SRVR_NAME |  |
| EMS_AB_REFERRAL_LIST |  |
| EMS_AB_REGISTERED_ADDRESS |  |
| EMS_AB_REMOTE_BRIDGE_HEAD |  |
| EMS_AB_REMOTE_BRIDGE_HEAD_ADDRESS |  |
| EMS_AB_REMOTE_OUT_BH_SERVER |  |
| EMS_AB_REMOTE_OUT_BH_SERVER_O |  |
| EMS_AB_REMOTE_SITE |  |
| EMS_AB_REMOTE_SITE_O |  |
| EMS_AB_REPLICATED_OBJECT_VERSION |  |
| EMS_AB_REPLICATION_MAIL_MSG_SIZE |  |
| EMS_AB_REPLICATION_SENSITIVITY |  |
| EMS_AB_REPLICATION_STAGGER |  |
| EMS_AB_REPORT_TO_ORIGINATOR |  |
| EMS_AB_REPORT_TO_OWNER |  |
| EMS_AB_REQ_SEQ |  |
| EMS_AB_REQUIRE_SSL |  |
| EMS_AB_RESPONSIBLE_LOCAL_DXA |  |
| EMS_AB_RESPONSIBLE_LOCAL_DXA_O |  |
| EMS_AB_RETURN_EXACT_MSG_SIZE |  |
| EMS_AB_RID_SERVER |  |
| EMS_AB_RID_SERVER_O |  |
| EMS_AB_ROLE_OCCUPANT |  |
| EMS_AB_ROLE_OCCUPANT_O |  |
| EMS_AB_ROOT_NEWSGROUPS_FOLDER_ID |  |
| EMS_AB_ROUTING_LIST |  |
| EMS_AB_RTS_CHECKPOINT_SIZE |  |
| EMS_AB_RTS_RECOVERY_TIMEOUT |  |
| EMS_AB_RTS_WINDOW_SIZE |  |
| EMS_AB_RUNS_ON |  |
| EMS_AB_RUNS_ON_O |  |
| EMS_AB_S_SELECTOR |  |
| EMS_AB_S_SELECTOR_INBOUND |  |
| EMS_AB_SCHEMA_FLAGS |  |
| EMS_AB_SCHEMA_VERSION |  |
| EMS_AB_SEARCH_FLAGS |  |
| EMS_AB_SEARCH_GUIDE |  |
| EMS_AB_SECURITY_POLICY |  |
| EMS_AB_SECURITY_PROTOCOL |  |
| EMS_AB_SEE_ALSO |  |
| EMS_AB_SEE_ALSO_O |  |
| EMS_AB_SEND_EMAIL_MESSAGE |  |
| EMS_AB_SEND_TNEF |  |
| EMS_AB_SERIAL_NUMBER |  |
| EMS_AB_SERVER |  |
| EMS_AB_SERVICE_ACTION_FIRST |  |
| EMS_AB_SERVICE_ACTION_OTHER |  |
| EMS_AB_SERVICE_ACTION_SECOND |  |
| EMS_AB_SERVICE_RESTART_DELAY |  |
| EMS_AB_SERVICE_RESTART_MESSAGE |  |
| EMS_AB_SESSION_DISCONNECT_TIMER |  |
| EMS_AB_SITE_AFFINITY |  |
| EMS_AB_SITE_FOLDER_GUID |  |
| EMS_AB_SITE_FOLDER_SERVER |  |
| EMS_AB_SITE_FOLDER_SERVER_O |  |
| EMS_AB_SITE_PROXY_SPACE |  |
| EMS_AB_SMIME_ALG_LIST_NA |  |
| EMS_AB_SMIME_ALG_LIST_OTHER |  |
| EMS_AB_SMIME_ALG_SELECTED_NA |  |
| EMS_AB_SMIME_ALG_SELECTED_OTHER |  |
| EMS_AB_SPACE_LAST_COMPUTED |  |
| EMS_AB_STREET_ADDRESS |  |
| EMS_AB_SUB_REFS |  |
| EMS_AB_SUB_REFS_O |  |
| EMS_AB_SUB_SITE |  |
| EMS_AB_SUBMISSION_CONT_LENGTH |  |
| EMS_AB_SUPPORT_SMIME_SIGNATURES |  |
| EMS_AB_SUPPORTED_ALGORITHMS |  |
| EMS_AB_SUPPORTED_APPLICATION_CONTEXT |  |
| EMS_AB_SUPPORTING_STACK |  |
| EMS_AB_SUPPORTING_STACK_BL |  |
| EMS_AB_SUPPORTING_STACK_BL_O |  |
| EMS_AB_SUPPORTING_STACK_O |  |
| EMS_AB_T_SELECTOR |  |
| EMS_AB_T_SELECTOR_INBOUND |  |
| EMS_AB_TARGET_MTAS |  |
| EMS_AB_TELEPHONE_NUMBER |  |
| EMS_AB_TELEPHONE_PERSONAL_PAGER |  |
| EMS_AB_TELETEX_TERMINAL_IDENTIFIER |  |
| EMS_AB_TEMP_ASSOC_THRESHOLD |  |
| EMS_AB_TOMBSTONE_LIFETIME |  |
| EMS_AB_TRACKING_LOG_PATH_NAME |  |
| EMS_AB_TRANS_RETRY_MINS |  |
| EMS_AB_TRANS_TIMEOUT_MINS |  |
| EMS_AB_TRANSFER_RETRY_INTERVAL |  |
| EMS_AB_TRANSFER_TIMEOUT_NON_URGENT |  |
| EMS_AB_TRANSFER_TIMEOUT_NORMAL |  |
| EMS_AB_TRANSFER_TIMEOUT_URGENT |  |
| EMS_AB_TRANSLATION_TABLE_USED |  |
| EMS_AB_TRANSPORT_EXPEDITED_DATA |  |
| EMS_AB_TRUST_LEVEL |  |
| EMS_AB_TURN_REQUEST_THRESHOLD |  |
| EMS_AB_TWO_WAY_ALTERNATE_FACILITY |  |
| EMS_AB_TYPE |  |
| EMS_AB_UNAUTH_ORIG_BL |  |
| EMS_AB_UNAUTH_ORIG_BL_O |  |
| EMS_AB_USE_SERVER_VALUES |  |
| EMS_AB_USE_SITE_VALUES |  |
| EMS_AB_USENET_SITE_NAME |  |
| EMS_AB_USER_PASSWORD |  |
| EMS_AB_USN_CHANGED |  |
| EMS_AB_USN_CREATED |  |
| EMS_AB_USN_DSA_LAST_OBJ_REMOVED |  |
| EMS_AB_USN_INTERSITE |  |
| EMS_AB_USN_LAST_OBJ_REM |  |
| EMS_AB_USN_SOURCE |  |
| EMS_AB_VIEW_CONTAINER_1 |  |
| EMS_AB_VIEW_CONTAINER_2 |  |
| EMS_AB_VIEW_CONTAINER_3 |  |
| EMS_AB_VIEW_DEFINITION |  |
| EMS_AB_VIEW_FLAGS |  |
| EMS_AB_VIEW_SITE |  |
| EMS_AB_VOICE_MAIL_FLAGS |  |
| EMS_AB_VOICE_MAIL_GREETINGS |  |
| EMS_AB_VOICE_MAIL_PASSWORD |  |
| EMS_AB_VOICE_MAIL_RECORDED_NAME |  |
| EMS_AB_VOICE_MAIL_RECORDING_LENGTH |  |
| EMS_AB_VOICE_MAIL_SPEED |  |
| EMS_AB_VOICE_MAIL_SYSTEM_GUID |  |
| EMS_AB_VOICE_MAIL_USER_ID |  |
| EMS_AB_VOICE_MAIL_VOLUME |  |
| EMS_AB_WWW_HOME_PAGE |  |
| EMS_AB_X121_ADDRESS |  |
| EMS_AB_X25_CALL_USER_DATA_INCOMING |  |
| EMS_AB_X25_CALL_USER_DATA_OUTGOING |  |
| EMS_AB_X25_FACILITIES_DATA_INCOMING |  |
| EMS_AB_X25_FACILITIES_DATA_OUTGOING |  |
| EMS_AB_X25_LEASED_LINE_PORT |  |
| EMS_AB_X25_LEASED_OR_SWITCHED |  |
| EMS_AB_X25_REMOTE_MTA_PHONE |  |
| EMS_AB_X400_ATTACHMENT_TYPE |  |
| EMS_AB_X400_SELECTOR_SYNTAX |  |
| EMS_AB_X500_ACCESS_CONTROL_LIST |  |
| EMS_AB_X500_NC |  |
| EMS_AB_X500_RDN |  |
| EMS_AB_XMIT_TIMEOUT_NON_URGENT |  |
| EMS_AB_XMIT_TIMEOUT_NORMAL |  |
| EMS_AB_XMIT_TIMEOUT_URGENT |  |
| EVENTS_ROOT_FOLDER_ENTRYID |  |
| EXCESS_STORAGE_USED |  |
| EXTENDED_ACL_DATA |  |
| FAST_TRANSFER |  |
| FAVORITES_DEFAULT_NAME |  |
| FOLDER_CHILD_COUNT |  |
| FOLDER_DESIGN_FLAGS |  |
| FOLDER_PATHNAME |  |
| FOREIGN_ID |  |
| FOREIGN_REPORT_ID |  |
| FOREIGN_SUBJECT_ID |  |
| FREE_BUSY_FOR_LOCAL_SITE_ENTRYID |  |
| GW_ADMIN_OPERATIONS |  |
| GW_MTSIN_ENTRYID |  |
| GW_MTSOUT_ENTRYID |  |
| HAS_MODERATOR_RULES |  |
| HIERARCHY_SERVER |  |
| HIERARCHY_SYNCHRONIZER |  |
| IMAP_INTERNAL_DATE |  |
| IN_TRANSIT |  |
| INBOUND_NEWSFEED_DN |  |
| INTERNET_CHARSET |  |
| INTERNET_NEWSGROUP_NAME |  |
| IPM_DAF_ENTRYID |  |
| IPM_FAVORITES_ENTRYID |  |
| IPM_PUBLIC_FOLDERS_ENTRYID |  |
| IS_NEWSGROUP |  |
| IS_NEWSGROUP_ANCHOR |  |
| LAST_ACCESS_TIME |  |
| LAST_FULL_BACKUP |  |
| LAST_LOGOFF_TIME |  |
| LAST_LOGON_TIME |  |
| LONGTERM_ENTRYID_FROM_TABLE |  |
| MESSAGE_PROCESSED |  |
| MESSAGE_SITE_NAME |  |
| MOVE_TO_FOLDER_ENTRYID |  |
| MOVE_TO_STORE_ENTRYID |  |
| MSG_BODY_ID |  |
| MTS_SUBJECT_ID |  |
| NEW_SUBS_GET_AUTO_ADD |  |
| NEWSFEED_INFO |  |
| NEWSGROUP_COMPONENT |  |
| NEWSGROUP_ROOT_FOLDER_ENTRYID |  |
| NNTP_ARTICLE_FOLDER_ENTRYID |  |
| NNTP_CONTROL_FOLDER_ENTRYID |  |
| NON_IPM_SUBTREE_ENTRYID |  |
| NORMAL_MESSAGE_SIZE |  |
| NORMAL_MESSAGE_SIZE_EXTENDED |  |
| NORMAL_MSG_W_ATTACH_COUNT |  |
| NT_USER_NAME |  |
| OFFLINE_ADDRBOOK_ENTRYID |  |
| OFFLINE_FLAGS |  |
| OFFLINE_MESSAGE_ENTRYID |  |
| OLDEST_DELETED_ON |  |
| ORIGINATOR_ADDR |  |
| ORIGINATOR_ADDRTYPE |  |
| ORIGINATOR_ENTRYID |  |
| ORIGINATOR_NAME |  |
| OST_ENCRYPTION |  |
| OUTBOUND_NEWSFEED_DN |  |
| OVERALL_AGE_LIMIT |  |
| OVERALL_MSG_AGE_LIMIT |  |
| OWA_URL |  |
| OWNER_COUNT |  |
| P1_CONTENT |  |
| P1_CONTENT_TYPE |  |
| PREVENT_MSG_CREATE |  |
| PREVIEW |  |
| PREVIEW_UNREAD |  |
| PROFILE_AB_FILES_PATH |  |
| PROFILE_ADDR_INFO |  |
| PROFILE_ALLPUB_COMMENT |  |
| PROFILE_ALLPUB_DISPLAY_NAME |  |
| PROFILE_BINDING_ORDER |  |
| PROFILE_CONFIG_FLAGS |  |
| PROFILE_CONNECT_FLAGS |  |
| PROFILE_FAVFLD_COMMENT |  |
| PROFILE_FAVFLD_DISPLAY_NAME |  |
| PROFILE_HOME_SERVER |  |
| PROFILE_HOME_SERVER_ADDRS |  |
| PROFILE_HOME_SERVER_DN |  |
| PROFILE_MAILBOX |  |
| PROFILE_MAX_RESTRICT |  |
| PROFILE_MOAB |  |
| PROFILE_MOAB_GUID |  |
| PROFILE_MOAB_SEQ |  |
| PROFILE_OFFLINE_INFO |  |
| PROFILE_OFFLINE_STORE_PATH |  |
| PROFILE_OPEN_FLAGS |  |
| PROFILE_OPTIONS_DATA |  |
| PROFILE_SECURE_MAILBOX |  |
| PROFILE_SERVER |  |
| PROFILE_SERVER_DN |  |
| PROFILE_TRANSPORT_FLAGS |  |
| PROFILE_TYPE |  |
| PROFILE_UI_STATE |  |
| PROFILE_UNRESOLVED_NAME |  |
| PROFILE_UNRESOLVED_SERVER |  |
| PROFILE_USER |  |
| PROFILE_VERSION |  |
| PST_ENCRYPTION |  |
| PST_PATH |  |
| PST_PW_SZ_OLD |  |
| PST_REMEMBER_PW |  |
| PUBLIC_FOLDER_ENTRYID |  |
| PUBLISH_IN_ADDRESS_BOOK |  |
| RECIPIENT_NUMBER |  |
| RECIPIENT_ON_ASSOC_MSG_COUNT |  |
| RECIPIENT_ON_NORMAL_MSG_COUNT |  |
| REPLICA_LIST |  |
| REPLICA_SERVER |  |
| REPLICA_VERSION |  |
| REPLICATION_ALWAYS_INTERVAL |  |
| REPLICATION_MESSAGE_PRIORITY |  |
| REPLICATION_MSG_SIZE |  |
| REPLICATION_SCHEDULE |  |
| REPLICATION_STYLE |  |
| REPLY_RECIPIENT_SMTP_PROXIES |  |
| REPORT_DESTINATION_ENTRYID |  |
| REPORT_DESTINATION_NAME |  |
| RESTRICTION_COUNT |  |
| RETENTION_AGE_LIMIT |  |
| RULE_TRIGGER_HISTORY |  |
| RULES_DATA |  |
| RULES_TABLE |  |
| SCHEDULE_FOLDER_ENTRYID |  |
| SECURE_IN_SITE |  |
| SECURE_ORIGINATION |  |
| STORAGE_LIMIT_INFORMATION |  |
| STORAGE_QUOTA_LIMIT |  |
| STORE_OFFLINE |  |
| STORE_SLOWLINK |  |
| SUBJECT_TRACE_INFO |  |
| SVR_GENERATING_QUOTA_MSG |  |
| SYNCHRONIZE_FLAGS |  |
| SYS_CONFIG_FOLDER_ENTRYID |  |
| TEST_LINE_SPEED |  |
| TRACE_INFO |  |
| TRANSFER_ENABLED |  |
| USER_NAME |  |
| X400_ENVELOPE_TYPE |  |
| AB_DEFAULT_DIR |  |
| AB_DEFAULT_PAB |  |
| AB_PROVIDER_ID |  |
| AB_PROVIDERS |  |
| AB_SEARCH_PATH |  |
| AB_SEARCH_PATH_UPDATE |  |
| ALTERNATE_RECIPIENT |  |
| ASSOC_CONTENT_COUNT |  |
| ATTACHMENT_X400_PARAMETERS |  |
| AUTHORIZING_USERS |  |
| BODY_CRC |  |
| COMMON_VIEWS_ENTRYID |  |
| CONTACT_ADDRTYPES |  |
| CONTACT_DEFAULT_ADDRESS_INDEX |  |
| CONTACT_EMAIL_ADDRESSES |  |
| CONTACT_ENTRYIDS |  |
| CONTACT_VERSION |  |
| CONTAINER_MODIFY_VERSION |  |
| CONTENT_CONFIDENTIALITY_ALGORITHM_ID |  |
| CONTENT_CORRELATOR |  |
| CONTENT_IDENTIFIER |  |
| CONTENT_INTEGRITY_CHECK |  |
| CONTENT_LENGTH |  |
| CONTENT_RETURN_REQUESTED |  |
| CONTENTS_SORT_ORDER |  |
| CONTROL_FLAGS |  |
| CONTROL_ID |  |
| CONTROL_STRUCTURE |  |
| CONTROL_TYPE |  |
| CONVERSATION_KEY |  |
| CONVERSION_EITS |  |
| CONVERSION_PROHIBITED |  |
| CONVERSION_WITH_LOSS_PROHIBITED |  |
| CONVERTED_EITS |  |
| CORRELATE |  |
| CORRELATE_MTSID |  |
| CREATE_TEMPLATES |  |
| CREATION_VERSION |  |
| CURRENT_VERSION |  |
| DEF_CREATE_DL |  |
| DEF_CREATE_MAILUSER |  |
| DEFAULT_PROFILE |  |
| DEFAULT_STORE |  |
| DEFAULT_VIEW_ENTRYID |  |
| DELEGATION |  |
| DELIVERY_POINT |  |
| DELTAX |  |
| DELTAY |  |
| DETAILS_TABLE |  |
| DISC_VAL |  |
| DISCARD_REASON |  |
| DISCLOSE_RECIPIENTS |  |
| DISCLOSURE_OF_RECIPIENTS |  |
| DISCRETE_VALUES |  |
| DL_EXPANSION_HISTORY |  |
| DL_EXPANSION_PROHIBITED |  |
| EXPLICIT_CONVERSION |  |
| FILTERING_HOOKS |  |
| FINDER_ENTRYID |  |
| FORM_CATEGORY |  |
| FORM_CATEGORY_SUB |  |
| FORM_CLSID |  |
| FORM_CONTACT_NAME |  |
| FORM_DESIGNER_GUID |  |
| FORM_DESIGNER_NAME |  |
| FORM_HIDDEN |  |
| FORM_HOST_MAP |  |
| FORM_MESSAGE_BEHAVIOR |  |
| FORM_VERSION |  |
| HEADER_FOLDER_ENTRYID |  |
| ICON |  |
| IDENTITY_DISPLAY |  |
| IDENTITY_ENTRYID |  |
| IDENTITY_SEARCH_KEY |  |
| IMPLICIT_CONVERSION_PROHIBITED |  |
| INCOMPLETE_COPY |  |
| INTERNET_APPROVED |  |
| INTERNET_ARTICLE_NUMBER |  |
| INTERNET_CONTROL |  |
| INTERNET_DISTRIBUTION |  |
| INTERNET_FOLLOWUP_TO |  |
| INTERNET_LINES |  |
| INTERNET_NEWSGROUPS |  |
| INTERNET_NNTP_PATH |  |
| INTERNET_ORGANIZATION |  |
| INTERNET_PRECEDENCE |  |
| IPM_ID |  |
| IPM_OUTBOX_ENTRYID |  |
| IPM_OUTBOX_SEARCH_KEY |  |
| IPM_RETURN_REQUESTED |  |
| IPM_SENTMAIL_ENTRYID |  |
| IPM_SENTMAIL_SEARCH_KEY |  |
| IPM_SUBTREE_ENTRYID |  |
| IPM_SUBTREE_SEARCH_KEY |  |
| IPM_WASTEBASKET_ENTRYID |  |
| IPM_WASTEBASKET_SEARCH_KEY |  |
| LANGUAGES |  |
| LATEST_DELIVERY_TIME |  |
| MAIL_PERMISSION |  |
| MDB_PROVIDER |  |
| MESSAGE_DELIVERY_ID |  |
| MESSAGE_DOWNLOAD_TIME |  |
| MESSAGE_SECURITY_LABEL |  |
| MESSAGE_TOKEN |  |
| MINI_ICON |  |
| MODIFY_VERSION |  |
| NEWSGROUP_NAME |  |
| NNTP_XREF |  |
| NON_RECEIPT_REASON |  |
| OBSOLETED_IPMS |  |
| ORIGIN_CHECK |  |
| ORIGINAL_AUTHOR_ADDRTYPE |  |
| ORIGINAL_AUTHOR_EMAIL_ADDRESS |  |
| ORIGINAL_AUTHOR_SEARCH_KEY |  |
| ORIGINAL_DISPLAY_NAME |  |
| ORIGINAL_EITS |  |
| ORIGINAL_SEARCH_KEY |  |
| ORIGINALLY_INTENDED_RECIP_ADDRTYPE |  |
| ORIGINALLY_INTENDED_RECIP_EMAIL_ADDRESS |  |
| ORIGINALLY_INTENDED_RECIP_ENTRYID |  |
| ORIGINALLY_INTENDED_RECIPIENT_NAME |  |
| ORIGINATING_MTA_CERTIFICATE |  |
| ORIGINATOR_AND_DL_EXPANSION_HISTORY |  |
| ORIGINATOR_CERTIFICATE |  |
| ORIGINATOR_REQUESTED_ALTERNATE_RECIPIENT |  |
| ORIGINATOR_RETURN_ADDRESS |  |
| OWN_STORE_ENTRYID |  |
| PARENT_DISPLAY |  |
| PHYSICAL_DELIVERY_BUREAU_FAX_DELIVERY |  |
| PHYSICAL_DELIVERY_MODE |  |
| PHYSICAL_DELIVERY_REPORT_REQUEST |  |
| PHYSICAL_FORWARDING_ADDRESS |  |
| PHYSICAL_FORWARDING_ADDRESS_REQUESTED |  |
| PHYSICAL_FORWARDING_PROHIBITED |  |
| PHYSICAL_RENDITION_ATTRIBUTES |  |
| POST_FOLDER_ENTRIES |  |
| POST_FOLDER_NAMES |  |
| POST_REPLY_DENIED |  |
| POST_REPLY_FOLDER_ENTRIES |  |
| POST_REPLY_FOLDER_NAMES |  |
| PREPROCESS |  |
| PRIMARY_CAPABILITY |  |
| PROFILE_NAME |  |
| PROOF_OF_DELIVERY |  |
| PROOF_OF_DELIVERY_REQUESTED |  |
| PROOF_OF_SUBMISSION |  |
| PROOF_OF_SUBMISSION_REQUESTED |  |
| PROVIDER_DISPLAY |  |
| PROVIDER_DLL_NAME |  |
| PROVIDER_ORDINAL |  |
| PROVIDER_SUBMIT_TIME |  |
| PROVIDER_UID |  |
| RECEIVE_FOLDER_SETTINGS |  |
| RECIPIENT_CERTIFICATE |  |
| RECIPIENT_NUMBER_FOR_ADVICE |  |
| RECIPIENT_STATUS |  |
| REDIRECTION_HISTORY |  |
| REGISTERED_MAIL_TYPE |  |
| RELATED_IPMS |  |
| REMOTE_PROGRESS |  |
| REMOTE_PROGRESS_TEXT |  |
| REMOTE_VALIDATE_OK |  |
| REPORTING_DL_NAME |  |
| REPORTING_MTA_CERTIFICATE |  |
| REQUESTED_DELIVERY_METHOD |  |
| RESOURCE_FLAGS |  |
| RESOURCE_METHODS |  |
| RESOURCE_PATH |  |
| RESOURCE_TYPE |  |
| RETURNED_IPM |  |
| RTF_SYNC_BODY_COUNT |  |
| RTF_SYNC_BODY_CRC |  |
| RTF_SYNC_BODY_TAG |  |
| RTF_SYNC_PREFIX_COUNT |  |
| RTF_SYNC_TRAILING_COUNT |  |
| SEARCH |  |
| SECURITY |  |
| SENTMAIL_ENTRYID |  |
| SERVICE_DELETE_FILES |  |
| SERVICE_DLL_NAME |  |
| SERVICE_ENTRY_NAME |  |
| SERVICE_EXTRA_UIDS |  |
| SERVICE_NAME |  |
| SERVICE_SUPPORT_FILES |  |
| SERVICE_UID |  |
| SERVICES |  |
| SPOOLER_STATUS |  |
| STATUS |  |
| STATUS_CODE |  |
| STATUS_STRING |  |
| STORE_PROVIDERS |  |
| STORE_RECORD_KEY |  |
| SUBJECT_IPM |  |
| SUBMIT_FLAGS |  |
| SUPERSEDES |  |
| TRANSPORT_KEY |  |
| TRANSPORT_PROVIDERS |  |
| TRANSPORT_STATUS |  |
| TYPE_OF_MTS_USER |  |
| VALID_FOLDER_MASK |  |
| VIEWS_ENTRYID |  |
| X400_CONTENT_TYPE |  |
| X400_DEFERRED_DELIVERY_CANCEL |  |
| XPOS |  |
| YPOS |  |

### groupdocs.metadata.formats.email
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email.md

The namespace contains classes representing saved email messages and their parts.

##### Classes
| Class | Description |
| :- | :- |
| `EmailAttachmentPackage` | Represents a metadata package containing email attachment name. |
| `EmailHeaderPackage` | Represents a metadata package containing email message headers. |
| `EmailPackage` | Represents email message metadata. |
| `EmailRootPackage` | Represents the root package allowing working with metadata in an email message. |
| `EmlPackage` | Represents EML message metadata. |
| `EmlRootPackage` | Represents the root package allowing working with metadata in an EML email message. |
| `MsgAttachmentPackage` | Represents a metadata package containing email attachment name and data. |
| `MsgPackage` | Represents MSG message metadata. |
| `MsgRootPackage` | Represents the root package allowing working with metadata in an MSG email message. |

### EmailAttachmentPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage.md

#### EmailAttachmentPackage class

Represents a metadata package containing email attachment name.

**Inheritance:** `EmailAttachmentPackage` →
`CustomPackage` →
`MetadataPackage`

The EmailAttachmentPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the attachment name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/name.md

#### name property

Gets the attachment name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailattachmentpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmailHeaderPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage.md

#### EmailHeaderPackage class

Represents a metadata package containing email message headers.

**Inheritance:** `EmailHeaderPackage` →
`CustomPackage` →
`MetadataPackage`

The EmailHeaderPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get(self, header)` | Gets the value of the specified header. |
| `set(self, header, value)` | Set the value of the specified header. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/get.md

#### get(self, header)

Gets the value of the specified header.

##### Returns

The value if the package contains the specified header; otherwise, null.

```python

def get(self, header):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| header | System.String | An email header. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/set.md

#### set(self, header, value)

Set the value of the specified header.

```python

def set(self, header, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| header | System.String | An email header. |
| value | groupdocs.metadata.common.PropertyValue | An email header value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailheaderpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmailPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage.md

#### EmailPackage class

Represents email message metadata.

**Inheritance:** `EmailPackage` →
`CustomPackage` →
`MetadataPackage`

The EmailPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| subject | Gets or sets the email subject. |
| recipients | Gets or sets the array of the email recipients. |
| carbon_copy_recipients | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| blind_carbon_copy_recipients | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| sender_email_address | Gets the email address of the sender. |
| headers | Gets a metadata package containing the email headers. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to remove all attachments from an email.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### blind_carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/blind_carbon_copy_recipients.md

#### blind_carbon_copy_recipients property

Gets or sets the array of BCC (blind carbon copy) recipients of the email message.
##### Definition:
```python
@property
def blind_carbon_copy_recipients(self):
    ...
@blind_carbon_copy_recipients.setter
def blind_carbon_copy_recipients(self, value):
    ...
```

### carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/carbon_copy_recipients.md

#### carbon_copy_recipients property

Gets or sets the array of CC (carbon copy) recipients of the email message.
##### Definition:
```python
@property
def carbon_copy_recipients(self):
    ...
@carbon_copy_recipients.setter
def carbon_copy_recipients(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### headers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/headers.md

#### headers property

Gets a metadata package containing the email headers.
##### Definition:
```python
@property
def headers(self):
    ...
@headers.setter
def headers(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/recipients.md

#### recipients property

Gets or sets the array of the email recipients.
##### Definition:
```python
@property
def recipients(self):
    ...
@recipients.setter
def recipients(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sender_email_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/sender_email_address.md

#### sender_email_address property

Gets the email address of the sender.
##### Definition:
```python
@property
def sender_email_address(self):
    ...
@sender_email_address.setter
def sender_email_address(self, value):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/subject.md

#### subject property

Gets or sets the email subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmailRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage.md

#### EmailRootPackage class

Represents the root package allowing working with metadata in an email message.

**Inheritance:** `EmailRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The EmailRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| email_package | Gets the email metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_attachments(self)` | Removes all the attachments form the email message. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_attachments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/clear_attachments.md

#### clear_attachments(self)

Removes all the attachments form the email message.

```python

def clear_attachments(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### email_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/email_package.md

#### email_package property

Gets the email metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def email_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emailrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmlPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage.md

#### EmlPackage class

Represents EML message metadata.

**Inheritance:** `EmlPackage` →
`EmailPackage` →
`CustomPackage` →
`MetadataPackage`

The EmlPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| subject | Gets or sets the email subject. |
| recipients | Gets or sets the array of the email recipients. |
| carbon_copy_recipients | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| blind_carbon_copy_recipients | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| sender_email_address | Gets the email address of the sender. |
| headers | Gets a metadata package containing the email headers. |
| attachments | Gets an array of the attached files. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### attachments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/attachments.md

#### attachments property

Gets an array of the attached files.
##### Definition:
```python
@property
def attachments(self):
    ...
@attachments.setter
def attachments(self, value):
    ...
```

### blind_carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/blind_carbon_copy_recipients.md

#### blind_carbon_copy_recipients property

Gets or sets the array of BCC (blind carbon copy) recipients of the email message.
##### Definition:
```python
@property
def blind_carbon_copy_recipients(self):
    ...
@blind_carbon_copy_recipients.setter
def blind_carbon_copy_recipients(self, value):
    ...
```

### carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/carbon_copy_recipients.md

#### carbon_copy_recipients property

Gets or sets the array of CC (carbon copy) recipients of the email message.
##### Definition:
```python
@property
def carbon_copy_recipients(self):
    ...
@carbon_copy_recipients.setter
def carbon_copy_recipients(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### headers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/headers.md

#### headers property

Gets a metadata package containing the email headers.
##### Definition:
```python
@property
def headers(self):
    ...
@headers.setter
def headers(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/recipients.md

#### recipients property

Gets or sets the array of the email recipients.
##### Definition:
```python
@property
def recipients(self):
    ...
@recipients.setter
def recipients(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sender_email_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/sender_email_address.md

#### sender_email_address property

Gets the email address of the sender.
##### Definition:
```python
@property
def sender_email_address(self):
    ...
@sender_email_address.setter
def sender_email_address(self, value):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/subject.md

#### subject property

Gets or sets the email subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmlRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage.md

#### EmlRootPackage class

Represents the root package allowing working with metadata in an EML email message.

**Inheritance:** `EmlRootPackage` →
`EmailRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The EmlRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| email_package | Gets the EML metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_attachments(self)` | Removes all the attachments form the email message. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract metadata from an EML message.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_attachments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/clear_attachments.md

#### clear_attachments(self)

Removes all the attachments form the email message.

```python

def clear_attachments(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### email_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/email_package.md

#### email_package property

Gets the EML metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def email_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/emlrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MsgAttachmentPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage.md

#### MsgAttachmentPackage class

Represents a metadata package containing email attachment name and data.

**Inheritance:** `MsgAttachmentPackage` →
`EmailAttachmentPackage` →
`CustomPackage` →
`MetadataPackage`

The MsgAttachmentPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, name, content)` | MsgAttachmentPackage constructor |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the attachment name. |
| content | Gets the last attachment data on byte array. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### MsgAttachmentPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/__init__.md

#### \_\_init\_\_(self, name, content)

MsgAttachmentPackage constructor

```python

def __init__(self, name, content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Attachment name |
| content | bytes | Attachment file which byte[] |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/content.md

#### content property

Gets the last attachment data on byte array.
##### Definition:
```python
@property
def content(self):
    ...
@content.setter
def content(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/name.md

#### name property

Gets the attachment name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgattachmentpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MsgPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage.md

#### MsgPackage class

Represents MSG message metadata.

**Inheritance:** `MsgPackage` →
`EmailPackage` →
`CustomPackage` →
`MetadataPackage`

The MsgPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| subject | Gets or sets the email subject. |
| recipients | Gets or sets the array of the email recipients. |
| carbon_copy_recipients | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| blind_carbon_copy_recipients | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| sender_email_address | Gets the email address of the sender. |
| headers | Gets a metadata package containing the email headers. |
| body | Gets the email message text. |
| categories | Gets the array of categories or keywords. |
| delivery_time | Gets the date and time the message was delivered. |
| client_submit_time | Gets the date and time the message was submit. |
| sender_name | Gets the name of the sender. |
| internet_message_id | Gets the message id of the message. |
| billing | Contains the billing information associated with an item. |
| body_html | Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. |
| body_rtf | Gets the BodyRtf of the message. |
| conversation_topic | Gets the Conversation Topic. |
| display_bcc | Gets the Display Bcc. |
| display_cc | Gets the Display Cc. |
| display_name | Gets the Display Name. |
| display_name_prefix | Gets the Display Name Prefix. |
| display_to | Gets the Display To. |
| is_encrypted | Gets the Is Encrypted. |
| is_signed | Gets the Is Signed. |
| is_template | Gets the Is Template. |
| normalized_subject | Gets the Normalized Subject. |
| read_receipt_requested | Gets the Read Receipt Requested. |
| reply_to | Gets the Reply To. |
| sender_address_type | Gets the Sender Address Type. |
| sender_smtp_address | Gets the Sender Smtp Address. |
| sent_representing_address_type | Gets the Sent Representing Address Type. |
| sent_representing_email_address | Gets the Sent Representing Email Address. |
| sent_representing_name | Gets the Sent Representing Name. |
| sent_representing_smtp_address | Gets the Sent Representing Smtp Address. |
| transport_message_headers | Gets the Transport Message Headers. |
| mileage | Gets the Mileage. |
| subject_prefix | Gets the Subject Prefix. |
| attachments | Gets an array of the attached files. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### attachments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/attachments.md

#### attachments property

Gets an array of the attached files.
##### Definition:
```python
@property
def attachments(self):
    ...
@attachments.setter
def attachments(self, value):
    ...
```

### billing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/billing.md

#### billing property

Contains the billing information associated with an item.
##### Definition:
```python
@property
def billing(self):
    ...
@billing.setter
def billing(self, value):
    ...
```

### blind_carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/blind_carbon_copy_recipients.md

#### blind_carbon_copy_recipients property

Gets or sets the array of BCC (blind carbon copy) recipients of the email message.
##### Definition:
```python
@property
def blind_carbon_copy_recipients(self):
    ...
@blind_carbon_copy_recipients.setter
def blind_carbon_copy_recipients(self, value):
    ...
```

### body property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/body.md

#### body property

Gets the email message text.
##### Definition:
```python
@property
def body(self):
    ...
@body.setter
def body(self, value):
    ...
```

### body_html property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/body_html.md

#### body_html property

Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.
##### Definition:
```python
@property
def body_html(self):
    ...
@body_html.setter
def body_html(self, value):
    ...
```

### body_rtf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/body_rtf.md

#### body_rtf property

Gets the BodyRtf of the message.
##### Definition:
```python
@property
def body_rtf(self):
    ...
@body_rtf.setter
def body_rtf(self, value):
    ...
```

### carbon_copy_recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/carbon_copy_recipients.md

#### carbon_copy_recipients property

Gets or sets the array of CC (carbon copy) recipients of the email message.
##### Definition:
```python
@property
def carbon_copy_recipients(self):
    ...
@carbon_copy_recipients.setter
def carbon_copy_recipients(self, value):
    ...
```

### categories property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/categories.md

#### categories property

Gets the array of categories or keywords.
##### Definition:
```python
@property
def categories(self):
    ...
@categories.setter
def categories(self, value):
    ...
```

### client_submit_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/client_submit_time.md

#### client_submit_time property

Gets the date and time the message was submit.
##### Definition:
```python
@property
def client_submit_time(self):
    ...
@client_submit_time.setter
def client_submit_time(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### conversation_topic property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/conversation_topic.md

#### conversation_topic property

Gets the Conversation Topic.
##### Definition:
```python
@property
def conversation_topic(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### delivery_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/delivery_time.md

#### delivery_time property

Gets the date and time the message was delivered.
##### Definition:
```python
@property
def delivery_time(self):
    ...
@delivery_time.setter
def delivery_time(self, value):
    ...
```

### display_bcc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/display_bcc.md

#### display_bcc property

Gets the Display Bcc.
##### Definition:
```python
@property
def display_bcc(self):
    ...
```

### display_cc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/display_cc.md

#### display_cc property

Gets the Display Cc.
##### Definition:
```python
@property
def display_cc(self):
    ...
```

### display_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/display_name.md

#### display_name property

Gets the Display Name.
##### Definition:
```python
@property
def display_name(self):
    ...
```

### display_name_prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/display_name_prefix.md

#### display_name_prefix property

Gets the Display Name Prefix.
##### Definition:
```python
@property
def display_name_prefix(self):
    ...
```

### display_to property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/display_to.md

#### display_to property

Gets the Display To.
##### Definition:
```python
@property
def display_to(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### headers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/headers.md

#### headers property

Gets a metadata package containing the email headers.
##### Definition:
```python
@property
def headers(self):
    ...
@headers.setter
def headers(self, value):
    ...
```

### internet_message_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/internet_message_id.md

#### internet_message_id property

Gets the message id of the message.
##### Definition:
```python
@property
def internet_message_id(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/is_encrypted.md

#### is_encrypted property

Gets the Is Encrypted.
##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### is_signed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/is_signed.md

#### is_signed property

Gets the Is Signed.
##### Definition:
```python
@property
def is_signed(self):
    ...
```

### is_template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/is_template.md

#### is_template property

Gets the Is Template.
##### Definition:
```python
@property
def is_template(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mileage property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/mileage.md

#### mileage property

Gets the Mileage.
##### Definition:
```python
@property
def mileage(self):
    ...
@mileage.setter
def mileage(self, value):
    ...
```

### normalized_subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/normalized_subject.md

#### normalized_subject property

Gets the Normalized Subject.
##### Definition:
```python
@property
def normalized_subject(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### read_receipt_requested property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/read_receipt_requested.md

#### read_receipt_requested property

Gets the Read Receipt Requested.
##### Definition:
```python
@property
def read_receipt_requested(self):
    ...
@read_receipt_requested.setter
def read_receipt_requested(self, value):
    ...
```

### recipients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/recipients.md

#### recipients property

Gets or sets the array of the email recipients.
##### Definition:
```python
@property
def recipients(self):
    ...
@recipients.setter
def recipients(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### reply_to property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/reply_to.md

#### reply_to property

Gets the Reply To.
##### Definition:
```python
@property
def reply_to(self):
    ...
@reply_to.setter
def reply_to(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sender_address_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sender_address_type.md

#### sender_address_type property

Gets the Sender Address Type.
##### Definition:
```python
@property
def sender_address_type(self):
    ...
```

### sender_email_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sender_email_address.md

#### sender_email_address property

Gets the email address of the sender.
##### Definition:
```python
@property
def sender_email_address(self):
    ...
@sender_email_address.setter
def sender_email_address(self, value):
    ...
```

### sender_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sender_name.md

#### sender_name property

Gets the name of the sender.
##### Definition:
```python
@property
def sender_name(self):
    ...
@sender_name.setter
def sender_name(self, value):
    ...
```

### sender_smtp_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sender_smtp_address.md

#### sender_smtp_address property

Gets the Sender Smtp Address.
##### Definition:
```python
@property
def sender_smtp_address(self):
    ...
@sender_smtp_address.setter
def sender_smtp_address(self, value):
    ...
```

### sent_representing_address_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sent_representing_address_type.md

#### sent_representing_address_type property

Gets the Sent Representing Address Type.
##### Definition:
```python
@property
def sent_representing_address_type(self):
    ...
```

### sent_representing_email_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sent_representing_email_address.md

#### sent_representing_email_address property

Gets the Sent Representing Email Address.
##### Definition:
```python
@property
def sent_representing_email_address(self):
    ...
@sent_representing_email_address.setter
def sent_representing_email_address(self, value):
    ...
```

### sent_representing_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sent_representing_name.md

#### sent_representing_name property

Gets the Sent Representing Name.
##### Definition:
```python
@property
def sent_representing_name(self):
    ...
@sent_representing_name.setter
def sent_representing_name(self, value):
    ...
```

### sent_representing_smtp_address property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/sent_representing_smtp_address.md

#### sent_representing_smtp_address property

Gets the Sent Representing Smtp Address.
##### Definition:
```python
@property
def sent_representing_smtp_address(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/subject.md

#### subject property

Gets or sets the email subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### subject_prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/subject_prefix.md

#### subject_prefix property

Gets the Subject Prefix.
##### Definition:
```python
@property
def subject_prefix(self):
    ...
```

### transport_message_headers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/transport_message_headers.md

#### transport_message_headers property

Gets the Transport Message Headers.
##### Definition:
```python
@property
def transport_message_headers(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MsgRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage.md

#### MsgRootPackage class

Represents the root package allowing working with metadata in an MSG email message.

**Inheritance:** `MsgRootPackage` →
`EmailRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The MsgRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| email_package | Gets the MSG metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `clear_attachments(self)` | Removes all the attachments form the email message. |
| `get_string(self, tag)` | Gets the string value of the property specified by tag. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract metadata from an MSG message.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_attachments method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/clear_attachments.md

#### clear_attachments(self)

Removes all the attachments form the email message.

```python

def clear_attachments(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### email_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/email_package.md

#### email_package property

Gets the MSG metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def email_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/get_string.md

#### get_string(self, tag)

Gets the string value of the property specified by tag.

##### Returns

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

```python

def get_string(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.email.msg.MsgKnownProperties | The value from MsgKnownProperties enum . |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.email/msgrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.fb2
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2.md

##### Classes
| Class | Description |
| :- | :- |
| `Fb2Package` | Represents metadata in a Fb2 e-book. |

### Fb2Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package.md

#### Fb2Package class

Represents metadata in a Fb2 e-book.

**Inheritance:** `Fb2Package` →
`CustomPackage` →
`MetadataPackage`

The Fb2Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| title_info | Description of information about the work (including translation, but excluding publication). |
| src_title_info | Description of information about the work in the original language (not available for the original book). |
| document_info | Description of information about a specific FB2.x document (creator(s), history, etc.). |
| publish_info | Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether. |
| custom_info | Some information about the document that is not provided in the rest of the description. This may be either just some information from the author or some information that may be useful to some FB2 software. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### custom_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/custom_info.md

#### custom_info property

Some information about the document that is not provided in the rest of the description. This may be either just some information from the author or some information that may be useful to some FB2 software.
##### Definition:
```python
@property
def custom_info(self):
    ...
```

### document_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/document_info.md

#### document_info property

Description of information about a specific FB2.x document (creator(s), history, etc.).
##### Definition:
```python
@property
def document_info(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publish_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/publish_info.md

#### publish_info property

Information about the paper (or other) publication on the basis of which the FB2.x document was created. It is not recommended to fill in data from an arbitrary publication if the source is unknown, except for the case when verification was carried out on it and the document was brought to the form of this publication. If the source is unknown, it is better to omit this element altogether.
##### Definition:
```python
@property
def publish_info(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### src_title_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/src_title_info.md

#### src_title_info property

Description of information about the work in the original language (not available for the original book).
##### Definition:
```python
@property
def src_title_info(self):
    ...
```

### title_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/title_info.md

#### title_info property

Description of information about the work (including translation, but excluding publication).
##### Definition:
```python
@property
def title_info(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.fb2/fb2package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.font
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font.md

The namespace contains classes allowing users to work with formats representing scalable computer fonts.

##### Classes
| Class | Description |
| :- | :- |
| `OpenTypeBaseNameRecord` | Represents the base OpenType Name table record class. |
| `OpenTypeFont` | Represents a single font extracted from a file. |
| `OpenTypeMacintoshNameRecord` | Represents the Name record table value for the `OpenTypePlatform.MACINTOSH` platform. |
| `OpenTypePackage` | Represents an OpenType font metadata package. |
| `OpenTypeRootPackage` | Represents the root package allowing working with metadata in an OpenType font file. |
| `OpenTypeUnicodeNameRecord` | Represents the Name record table value for the `OpenTypePlatform.UNICODE` platform. |
| `OpenTypeWindowsNameRecord` | Represents the Name record table value for `OpenTypePlatform.WINDOWS` platform. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `OpenTypeDigitalSignatureFlags` | Represents OpenType font digital signature flags. |
| `OpenTypeDirectionHint` | Represents the OpenType font direction. |
| `OpenTypeFlags` | Represents OpenType font header flags. |
| `OpenTypeIsoEncoding` | Represents encoding for the `OpenTypePlatform.ISO` platform. |
| `OpenTypeLicensingRights` | Indicates font embedding licensing rights for the font. |
| `OpenTypeMacintoshEncoding` | Represents encoding for the `OpenTypePlatform.MACINTOSH` platform. |
| `OpenTypeMacintoshLanguage` | Represents language enum for the `OpenTypePlatform.MACINTOSH` platform. |
| `OpenTypeName` | Defines pre-defined IDs, they apply to all platforms unless indicated otherwise. |
| `OpenTypePlatform` | Represents OpenType platform for Name table. |
| `OpenTypeStyles` | Represents the OpenType font style. |
| `OpenTypeUnicodeEncoding` | Represents encoding for `OpenTypePlatform.UNICODE` platform. |
| `OpenTypeVersion` | Represents the OpenType version. |
| `OpenTypeWeight` | Represents the OpenType font weight.
<br/>Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font.
<br/>Values from 1 to 1000 are valid. |
| `OpenTypeWidth` | Represents the OpenType font width.
<br/>Indicates a relative change from the normal aspect ratio (width to height ratio)
<br/>as specified by a font designer for the glyphs in a font. |
| `OpenTypeWindowsEncoding` | Represents encoding for the `OpenTypePlatform.WINDOWS` platform. |
| `OpenTypeWindowsLanguage` | Represents language for `OpenTypePlatform.WINDOWS` platform. |

### OpenTypeBaseNameRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord.md

#### OpenTypeBaseNameRecord class

Represents the base OpenType Name table record class.

**Inheritance:** `OpenTypeBaseNameRecord` →
`CustomPackage` →
`MetadataPackage`

The OpenTypeBaseNameRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name_id | Gets the name identifier. |
| platform | Gets the platform identifier. |
| value | Gets the string value of record. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/name_id.md

#### name_id property

Gets the name identifier.
##### Definition:
```python
@property
def name_id(self):
    ...
```

### platform property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/platform.md

#### platform property

Gets the platform identifier.
##### Definition:
```python
@property
def platform(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypebasenamerecord/value.md

#### value property

Gets the string value of record.
##### Definition:
```python
@property
def value(self):
    ...
```

### OpenTypeDigitalSignatureFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypedigitalsignatureflags.md

#### OpenTypeDigitalSignatureFlags enumeration

Represents OpenType font digital signature flags.

The OpenTypeDigitalSignatureFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Undefined flag. |
| CANNOT_BE_RESIGNED | Cannot be resigned. |

### OpenTypeDirectionHint enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypedirectionhint.md

#### OpenTypeDirectionHint enumeration

Represents the OpenType font direction.

The OpenTypeDirectionHint type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| FULLY_MIXED | Fully mixed directional glyphs. |
| ONLY_LEFT_TO_RIGHT | Only strongly left to right. |
| LEFT_TO_RIGHT_AND_NEUTRALS | Like `OpenTypeDirectionHint.ONLY_LEFT_TO_RIGHT` but also contains neutrals. |
| ONLY_RIGHT_TO_LEFT | Only strongly right to left. |
| RIGHT_TO_LEFT_AND_NEUTRALS | Like `OpenTypeDirectionHint.ONLY_RIGHT_TO_LEFT` but also contains neutrals. |

### OpenTypeFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeflags.md

#### OpenTypeFlags enumeration

Represents OpenType font header flags.

The OpenTypeFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Undefined, no flags. |
| BASELINE_AT_Y0 | Baseline for font at y=0. |
| LEFT_SIDEBEARING_AT_X0 | Left sidebearing point at x=0 (relevant only for TrueType rasterizers). |
| DEPEND_ON_POINT_SIZE | Instructions may depend on point size. |
| FORCE_TO_INTEGER | Force ppem to integer values for all internal scaler math; may use fractional ppem sizes if this bit is clear. |
| ALTER_ADVANCE_WIDTH | Instructions may alter advance width (the advance widths might not scale linearly). |
| LOSSLESS | Font data is “lossless” as a result of having been subjected to optimizing transformation and/or compression. |
| CONVERTED | Font converted (produce compatible metrics). |
| OPTIMIZED | Font optimized for ClearType™. |
| RESORT | Last Resort font. |

### OpenTypeFont class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont.md

#### OpenTypeFont class

Represents a single font extracted from a file.

**Inheritance:** `OpenTypeFont` →
`CustomPackage` →
`MetadataPackage`

The OpenTypeFont type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| sfnt_version | Gets the header SFNT version. |
| major_version | Gets the header major version. |
| minor_version | Gets the header minor version. |
| font_revision | Gets the font revision. |
| flags | Gets the header flags. |
| created | Gets the created date. |
| modified | Gets the modified date. |
| glyph_bounds | Gets the glyph bounds. |
| style | Gets the font style. |
| direction_hint | Gets the direction hint. |
| names | Gets the name records. |
| font_family_name | Gets the name of the font family. |
| font_subfamily_name | Gets the name of the font subfamily. |
| full_font_name | Gets the full name of the font. |
| typographic_family | Gets the typographic family. |
| typographic_subfamily | Gets the typographic subfamily. |
| weight | Gets the font weight. |
| width | Gets the font width. |
| embedding_licensing_rights | Gets the embedding licensing rights type. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/created.md

#### created property

Gets the created date.
##### Definition:
```python
@property
def created(self):
    ...
```

### direction_hint property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/direction_hint.md

#### direction_hint property

Gets the direction hint.
##### Definition:
```python
@property
def direction_hint(self):
    ...
```

### embedding_licensing_rights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/embedding_licensing_rights.md

#### embedding_licensing_rights property

Gets the embedding licensing rights type.
##### Definition:
```python
@property
def embedding_licensing_rights(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/flags.md

#### flags property

Gets the header flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### font_family_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/font_family_name.md

#### font_family_name property

Gets the name of the font family.
##### Definition:
```python
@property
def font_family_name(self):
    ...
```

### font_revision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/font_revision.md

#### font_revision property

Gets the font revision.
##### Definition:
```python
@property
def font_revision(self):
    ...
```

### font_subfamily_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/font_subfamily_name.md

#### font_subfamily_name property

Gets the name of the font subfamily.
##### Definition:
```python
@property
def font_subfamily_name(self):
    ...
```

### full_font_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/full_font_name.md

#### full_font_name property

Gets the full name of the font.
##### Definition:
```python
@property
def full_font_name(self):
    ...
```

### glyph_bounds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/glyph_bounds.md

#### glyph_bounds property

Gets the glyph bounds.
##### Definition:
```python
@property
def glyph_bounds(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### major_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/major_version.md

#### major_version property

Gets the header major version.
##### Definition:
```python
@property
def major_version(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### minor_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/minor_version.md

#### minor_version property

Gets the header minor version.
##### Definition:
```python
@property
def minor_version(self):
    ...
```

### modified property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/modified.md

#### modified property

Gets the modified date.
##### Definition:
```python
@property
def modified(self):
    ...
```

### names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/names.md

#### names property

Gets the name records.
##### Definition:
```python
@property
def names(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sfnt_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/sfnt_version.md

#### sfnt_version property

Gets the header SFNT version.
##### Definition:
```python
@property
def sfnt_version(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/style.md

#### style property

Gets the font style.
##### Definition:
```python
@property
def style(self):
    ...
```

### typographic_family property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/typographic_family.md

#### typographic_family property

Gets the typographic family.
##### Definition:
```python
@property
def typographic_family(self):
    ...
```

### typographic_subfamily property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/typographic_subfamily.md

#### typographic_subfamily property

Gets the typographic subfamily.
##### Definition:
```python
@property
def typographic_subfamily(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### weight property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/weight.md

#### weight property

Gets the font weight.
##### Definition:
```python
@property
def weight(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypefont/width.md

#### width property

Gets the font width.
##### Definition:
```python
@property
def width(self):
    ...
```

### OpenTypeIsoEncoding enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeisoencoding.md

#### OpenTypeIsoEncoding enumeration

Represents encoding for the `OpenTypePlatform.ISO` platform.

The OpenTypeIsoEncoding type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ASCII_7_BIT | The 7-bit ASCII encoding. |
| ISO10646 | The ISO 10646 encoding. |
| ISO8859 | The ISO 8859-1 encoding. |

### OpenTypeLicensingRights enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypelicensingrights.md

#### OpenTypeLicensingRights enumeration

Indicates font embedding licensing rights for the font.

The OpenTypeLicensingRights type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | The undefined licensing rights. |
| USAGE_PERMISSIONS_MASK | Usage permissions mask. |
| INSTALLABLE_EMBEDDING | Installable embedding.
<br/>The font may be embedded, and may be permanently installed for use on a remote systems, or for use by other users. |
| RESTRICTED_LICENSE_EMBEDDING | Restricted License embedding.
<br/>The font must not be modified, embedded or exchanged in any manner without first obtaining explicit permission of the legal owner. |
| PREVIEW_AND_PRINT_EMBEDDING | Preview and Print embedding.
<br/>The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or printing the document.
<br/>Documents containing Preview & Print fonts must be opened “read-only”; no edits can be applied to the document. |
| EDITABLE_EMBEDDING | Editable embedding.
<br/>The font may be embedded, and may be temporarily loaded on other systems.
<br/>As with Preview and Print embedding, documents containing Editable fonts may be opened for reading.
<br/>In addition, editing is permitted, including ability to format new text using the embedded font, and changes may be saved. |
| NO_SUBSETTING | No subsetting.
<br/>When this bit is set, the font may not be subsetted prior to embedding. Other embedding restrictions specified in bits 0 to 3 and bit 9 also apply. |
| BITMAP_EMBEDDING_ONLY | Bitmap embedding only.
<br/>When this bit is set, only bitmaps contained in the font may be embedded. No outline data may be embedded.
<br/>If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail.
<br/>Other embedding restrictions specified in bits 0-3 and 8 also apply. |

### OpenTypeMacintoshEncoding enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshencoding.md

#### OpenTypeMacintoshEncoding enumeration

Represents encoding for the `OpenTypePlatform.MACINTOSH` platform.

The OpenTypeMacintoshEncoding type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_SEMANTICS | Default semantics. |
| VERSION_11_SEMANTICS | Version 1.1 semantics. |
| ISO_106461993_SEMANTICS | ISO 10646 1993 semantics (deprecated). |
| UNICODE_20_BMP_ONLY | Unicode 2.0 or later semantics (BMP only). |
| UNICODE_20_NON_BMP | Unicode 2.0 or later semantics (non-BMP characters allowed). |
| UNICODE_VARIATION_SEQUENCES | Unicode Variation Sequences. |
| FULL_UNICODE_COVERAGE | Full Unicode coverage. |

### OpenTypeMacintoshLanguage enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshlanguage.md

#### OpenTypeMacintoshLanguage enumeration

Represents language enum for the `OpenTypePlatform.MACINTOSH` platform.

The OpenTypeMacintoshLanguage type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ENGLISH | The english language. |
| FRENCH | The french language. |
| GERMAN | The german language. |
| ITALIAN | The italian language. |
| DUTCH | The dutch language. |
| SWEDISH | The swedish language. |
| SPANISH | The spanish language. |
| DANISH | The danish language. |
| PORTUGUESE | The portuguese language. |
| NORWEGIAN | The norwegian language. |
| HEBREW | The hebrew language. |
| JAPANESE | The japanese language. |
| ARABIC | The arabic language. |
| FINNISH | The finnish language. |
| GREEK | The greek language. |
| ICELANDIC | The icelandic language. |
| MALTESE | The maltese language. |
| TURKISH | The turkish language. |
| CROATIAN | The croatian language. |
| CHINESE_TRADITIONAL | The chinese traditional language. |
| URDU | The urdu language. |
| HINDI | The hindi language. |
| THAI | The thai language. |
| KOREAN | The korean language. |
| LITHUANIAN | The lithuanian language. |
| POLISH | The polish language. |
| HUNGARIAN | The hungarian language. |
| ESTONIAN | The estonian language. |
| LATVIAN | The latvian language. |
| SAMI | The sami language. |
| FAROESE | The faroese language. |
| FARSI_PERSIAN | The farsi persian language. |
| RUSSIAN | The russian language. |
| CHINESE_SIMPLIFIED | The chinese simplifie language. |
| FLEMISH | The flemish language. |
| IRISH_GAELIC | The irish gaelic language. |
| ALBANIAN | The albanian language. |
| ROMANIAN | The romanian language. |
| CZECH | The czech language. |
| SLOVAK | The slovak language. |
| SLOVENIAN | The slovenian language. |
| YIDDISH | The yiddish language. |
| SERBIAN | The serbian language. |
| MACEDONIAN | The macedonian language. |
| BULGARIAN | The bulgarian language. |
| UKRAINIAN | The ukrainian language. |
| BYELORUSSIAN | The byelorussian language. |
| UZBEK | The uzbek language. |
| KAZAKH | The kazakh language. |
| AZERBAIJANI_CYRILLIC | The azerbaijani cyrillic language. |
| AZERBAIJANI_ARABIC | The azerbaijani arabic language. |
| ARMENIAN | The armenian language. |
| GEORGIAN | The georgian language. |
| MOLDAVIAN | The moldavian language. |
| KIRGHIZ | The kirghiz language. |
| TAJIKI | The tajiki language. |
| TURKMEN | The turkmen language. |
| MONGOLIAN_MONGOLIAN | The mongolian mongolian language. |
| MONGOLIAN_CYRILLIC | The mongolian cyrillic language. |
| PASHTO | The pashto language. |
| KURDISH | The kurdish language. |
| KASHMIRI | The kashmiri language. |
| SINDHI | The sindhi language. |
| TIBETAN | The tibetan language. |
| NEPALI | The nepali language. |
| SANSKRIT | The sanskrit language. |
| MARATHI | The marathi language. |
| BENGALI | The bengali language. |
| ASSAMESE | The assamese language. |
| GUJARATI | The gujarati language. |
| PUNJABI | The punjabi language. |
| ORIYA | The oriya language. |
| MALAYALAM | The malayalam language. |
| KANNADA | The kannada language. |
| TAMIL | The tamil language. |
| TELUGU | The telugu language. |
| SINHALESE | The sinhalese language. |
| BURMESE | The burmese language. |
| KHMER | The khmer language. |
| LAO | The lao language. |
| VIETNAMESE | The vietnamese language. |
| INDONESIAN | The indonesian language. |
| TAGALOG | The tagalog language. |
| MALAY_ROMAN | The malay roman language. |
| MALAY_ARABIC | The malay arabic language. |
| AMHARIC | The amharic language. |
| TIGRINYA | The tigrinya language. |
| GALLA | The galla language. |
| SOMALI | The somali language. |
| SWAHILI | The swahili language. |
| KINYARWANDA_OR_RUANDA | The kinyarwanda or ruanda language. |
| RUNDI | The rundi language. |
| NYANJA_OR_CHEWA | The nyanja or chewa language. |
| MALAGASY | The malagasy language. |
| ESPERANTO | The esperanto language. |
| WELSH | The welsh language. |
| BASQUE | The basque language. |
| CATALAN | The catalan language. |
| LATIN | The latin language. |
| QUECHUA | The quechua language. |
| GUARANI | The guarani language. |
| AYMARA | The aymara language. |
| TATAR | The tatar language. |
| UIGHUR | The uighur language. |
| DZONGKHA | The dzongkha language. |
| JAVANESE_ROMAN | The javanese roman language. |
| SUNDANESE_ROMAN | The sundanese roman language. |
| GALICIAN | The galician language. |
| AFRIKAANS | The afrikaans language. |
| BRETON | The breton language. |
| INUKTITUT | The inuktitut language. |
| SCOTTISH_GAELIC | The scottish gaelic language. |
| MANX_GAELIC | The manx gaelic language. |
| IRISH_GAELIC_WITH_DOT_ABOVE | The irish gaelic with dot above language. |
| TONGAN | The tongan language. |
| GREEK_POLYTONIC | The greek polytonic language. |
| GREENLANDIC | The greenlandic language. |
| AZERBAIJANI_ROMAN | The azerbaijani roman language. |

### OpenTypeMacintoshNameRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord.md

#### OpenTypeMacintoshNameRecord class

Represents the Name record table value for the `OpenTypePlatform.MACINTOSH` platform.

**Inheritance:** `OpenTypeMacintoshNameRecord` →
`OpenTypeBaseNameRecord` →
`CustomPackage` →
`MetadataPackage`

The OpenTypeMacintoshNameRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name_id | Gets the name identifier. |
| platform | Gets the platform identifier. |
| value | Gets the string value of record. |
| encoding | Gets the encoding identifier. |
| language | Gets the language identifier. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/encoding.md

#### encoding property

Gets the encoding identifier.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/language.md

#### language property

Gets the language identifier.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/name_id.md

#### name_id property

Gets the name identifier.
##### Definition:
```python
@property
def name_id(self):
    ...
```

### platform property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/platform.md

#### platform property

Gets the platform identifier.
##### Definition:
```python
@property
def platform(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypemacintoshnamerecord/value.md

#### value property

Gets the string value of record.
##### Definition:
```python
@property
def value(self):
    ...
```

### OpenTypeName enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypename.md

#### OpenTypeName enumeration

Defines pre-defined IDs, they apply to all platforms unless indicated otherwise.

The OpenTypeName type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| COPYRIGHT_NOTICE | Copyright notice. |
| FONT_FAMILY_NAME | Font Family name. |
| FONT_SUBFAMILY_NAME | Font Subfamily name. |
| UNIQUE_FONT_IDENTIFIER | Unique font identifier. |
| FULL_FONT_NAME | Full font name that reflects all family and relevant subfamily descriptors. |
| VERSION_STRING | Version string. |
| POST_SCRIPT_NAME | PostScript name for the font. |
| TRADEMARK | Trademark notice/information for this font. |
| MANUFACTURER_NAME | Manufacturer Name. |
| DESIGNER | Designer; name of the designer of the typeface. |
| DESCRIPTION | Description of the typeface. |
| URL_VENDOR | URL of font vendor (with protocol, e.g., http://, ftp://). |
| URL_DESIGNER | URL of typeface designer (with protocol, e.g., http://, ftp://). |
| LICENSE_DESCRIPTION | Description of how the font may be legally used, or different example scenarios for licensed use. |
| LICENSE_INFO_URL | URL where additional licensing information can be found. |
| TYPOGRAPHIC_FAMILY | Typographic Family name. |
| TYPOGRAPHIC_SUBFAMILY | Typographic Subfamily name. |
| COMPATIBLE_FULL | Compatible Full (Macintosh only).
<br/>On the Macintosh, the menu name is constructed using the FOND resource. |
| SAMPLE_TEXT | Sample text.
<br/>This can be the font name, or any other text that the designer thinks is the best sample to display the font in. |
| POST_SCRIPT_CID_FINDFONT | PostScript CID findfont name. |
| WWS_FAMILY_NAME | WWS Family Name. |
| WWS_SUBFAMILY_NAME | WWS Subfamily Name. |
| LIGHT_BACKGROUND_PALETTE | Light Background Palette. |
| DARK_BACKGROUND_PALETTE | Dark Background Palette. |
| VARIATIONS_POST_SCRIPT_NAME_PREFIX | Variations PostScript Name Prefix. |

### OpenTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage.md

#### OpenTypePackage class

Represents an OpenType font metadata package.

**Inheritance:** `OpenTypePackage` →
`CustomPackage` →
`MetadataPackage`

The OpenTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| fonts | Gets an array of the fonts extracted from the file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### fonts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/fonts.md

#### fonts property

Gets an array of the fonts extracted from the file.
##### Definition:
```python
@property
def fonts(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### OpenTypePlatform enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeplatform.md

#### OpenTypePlatform enumeration

Represents OpenType platform for Name table.

The OpenTypePlatform type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNICODE | The Unicode platform. |
| MACINTOSH | The Macintosh platform. |
| ISO | The ISO [deprecated] platform. |
| WINDOWS | The Windows platform. |
| CUSTOM | The Custom platform. |

### OpenTypeRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage.md

#### OpenTypeRootPackage class

Represents the root package allowing working with metadata in an OpenType font file.

**Inheritance:** `OpenTypeRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The OpenTypeRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| open_type_package | Gets the OpenType metadata package. |
| digital_signature_package | Gets the digital signature metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_signature_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/digital_signature_package.md

#### digital_signature_package property

Gets the digital signature metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet demonstrates how to extract digital signatures associated with an OpenType font.
##### Definition:
```python
@property
def digital_signature_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### open_type_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/open_type_package.md

#### open_type_package property

Gets the OpenType metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read OpenType font metadata.
##### Definition:
```python
@property
def open_type_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentyperootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### OpenTypeStyles enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypestyles.md

#### OpenTypeStyles enumeration

Represents the OpenType font style.

The OpenTypeStyles type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| REGULAR | Normal text. |
| BOLD | Bold text. |
| ITALIC | Italic text. |
| UNDERLINE | Underlined text. |
| OUTLINE | Outline text. |
| SHADOW | Shadow text. |
| CONDENSED | Condensed text. |
| EXTENDED | Extended text. |

### OpenTypeUnicodeEncoding enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodeencoding.md

#### OpenTypeUnicodeEncoding enumeration

Represents encoding for `OpenTypePlatform.UNICODE` platform.

The OpenTypeUnicodeEncoding type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNICODE10 | Unicode 1.0 semantics. |
| UNICODE11 | Unicode 1.1 semantics. |
| ISO | ISO/IEC 10646 semantics. |
| UNICODE_20_BMP | Unicode 2.0 and onwards semantics, Unicode BMP only ('cmap' subtable formats 0, 4, 6). |
| UNICODE_20_FULL | Unicode 2.0 and onwards semantics, Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12). |
| UNICODE_VARIATION | Unicode Variation Sequences ('cmap' subtable format 14). |
| UNICODE_FULL | Unicode full repertoire ('cmap' subtable formats 0, 4, 6, 10, 12, 13). |

### OpenTypeUnicodeNameRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord.md

#### OpenTypeUnicodeNameRecord class

Represents the Name record table value for the `OpenTypePlatform.UNICODE` platform.

**Inheritance:** `OpenTypeUnicodeNameRecord` →
`OpenTypeBaseNameRecord` →
`CustomPackage` →
`MetadataPackage`

The OpenTypeUnicodeNameRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name_id | Gets the name identifier. |
| platform | Gets the platform identifier. |
| value | Gets the string value of record. |
| encoding | Gets the encoding identifier. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/encoding.md

#### encoding property

Gets the encoding identifier.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/name_id.md

#### name_id property

Gets the name identifier.
##### Definition:
```python
@property
def name_id(self):
    ...
```

### platform property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/platform.md

#### platform property

Gets the platform identifier.
##### Definition:
```python
@property
def platform(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeunicodenamerecord/value.md

#### value property

Gets the string value of record.
##### Definition:
```python
@property
def value(self):
    ...
```

### OpenTypeVersion enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeversion.md

#### OpenTypeVersion enumeration

Represents the OpenType version.

The OpenTypeVersion type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TRUE_TYPE | The TrueType font. |
| CFF | The OpenType font with PostScript outlines. |
| TRUE_TYPE_OS_X | The OS X and iOS TrueType font. |

### OpenTypeWeight enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypeweight.md

#### OpenTypeWeight enumeration

Represents the OpenType font weight.
Indicates the visual weight (degree of blackness or thickness of strokes) of the characters in the font.
Values from 1 to 1000 are valid.

The OpenTypeWeight type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | The undefined weight. |
| THIN | The Thin weight. |
| EXTRA_LIGHT | The Extra-light (Ultra-light) weight. |
| LIGHT | The Light weight. |
| NORMAL | The Normal (Regular) weight. |
| MEDIUM | The Medium weight. |
| SEMI_BOLD | The Semi-bold (Demi-bold) weight. |
| BOLD | The Bold weight. |
| EXTRA_BOLD | The Extra-bold (Ultra-bold) weight. |
| HEAVY | The Black (Heavy) weight. |

### OpenTypeWidth enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewidth.md

#### OpenTypeWidth enumeration

Represents the OpenType font width.
Indicates a relative change from the normal aspect ratio (width to height ratio)
as specified by a font designer for the glyphs in a font.

The OpenTypeWidth type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | The undefined wifth. |
| ULTRA_CONDENSED | The Ultra-condensed wifth. |
| EXTRA_CONDENSED | The Extra-condensed wifth. |
| CONDENSED | The Condensed wifth. |
| SEMI_CONDENSED | The Semi-condensed wifth. |
| MEDIUM | The Medium (normal) wifth. |
| SEMI_EXPANDED | The Semi-expanded wifth. |
| EXPANDED | The Expanded wifth. |
| EXTRA_EXPANDED | The Extra-expanded wifth. |
| ULTRA_EXPANDED | The Ultra-expanded wifth. |

### OpenTypeWindowsEncoding enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsencoding.md

#### OpenTypeWindowsEncoding enumeration

Represents encoding for the `OpenTypePlatform.WINDOWS` platform.

The OpenTypeWindowsEncoding type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SYMBOL | The Symbol encoding. |
| UNICODE_BMP | The Unicode BMP encoding. |
| SHIFT_JIS | The ShiftJIS encoding. |
| PRC | The PRC encoding. |
| BIG5 | The Big5 encoding. |
| WANSUNG | The Wansung encoding. |
| JOHAB | The Johab encoding. |
| UNICODE_FULL | The Unicode full repertoire encoding. |

### OpenTypeWindowsLanguage enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowslanguage.md

#### OpenTypeWindowsLanguage enumeration

Represents language for `OpenTypePlatform.WINDOWS` platform.

The OpenTypeWindowsLanguage type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The unknown language. |
| AFRIKAANS_SOUTH_AFRICA | The afrikaans south africa language. |
| ALBANIAN_ALBANIA | The albanian Albania language. |
| ALSATIAN_FRANCE | The alsatian France language. |
| AMHARIC_ETHIOPIA | The amharic Rthiopia language. |
| ARABIC_ALGERIA | The arabic Algeria language. |
| ARABIC_BAHRAIN | The arabic Bahrain language. |
| ARABIC_EGYPT | The arabic Egypt language. |
| ARABIC_IRAQ | The arabic Iraq language. |
| ARABIC_JORDAN | The arabic Jordan language. |
| ARABIC_KUWAIT | The arabic Kuwait language. |
| ARABIC_LEBANON | The arabic Lebanon language. |
| ARABIC_LIBYA | The arabic Libya language. |
| ARABIC_MOROCCO | The arabic Morocco language. |
| ARABIC_OMAN | The arabic Oman language. |
| ARABIC_QATAR | The arabic Qatar language. |
| ARABIC_SAUDI_ARABIA | The arabic Saudi Arabia language. |
| ARABIC_SYRIA | The arabic Syria language. |
| ARABIC_TUNISIA | The arabic Tunisia language. |
| ARABIC_UAE | The arabic UAE language. |
| ARABIC_YEMEN | The arabic Yemen language. |
| ARMENIAN_ARMENIA | The armenian Armenia language. |
| ASSAMESE_INDIA | The assamese India language. |
| AZERI_CYRILLIC_AZERBAIJAN | The azeri cyrillic Azerbaijan language. |
| AZERI_LATIN_AZERBAIJAN | The azeri latin Azerbaijan language. |
| BASHKIR_RUSSIA | The bashkir Russia language. |
| BASQUE_BASQUE | The basque Basque language. |
| BELARUSIAN_BELARUS | The belarusian Belarus language. |
| BENGALI_BANGLADESH | The bengali Bangladesh language. |
| BENGALI_INDIA | The bengali India language. |
| BOSNIAN_LATIN_BOSNIA_AND_HERZEGOVINA | The bosnian latin Bosnia and Herzegovina language. |
| BRETON_FRANCE | The breton France language. |
| BULGARIAN_BULGARIA | The bulgarian Bulgaria language. |
| CATALAN_CATALAN | The catalan Catalan language. |
| CHINESE_HONG_KONG_SAR | The chinese Hong Kong SAR language. |
| CHINESE_MACAO_SAR | The chinese Macao SAR language. |
| CHINESE_PEOPLES_REPUBLIC_OF_CHINA | The chinese Peoples Republic of China language. |
| CHINESE_SINGAPORE | The chinese Singapore language. |
| CHINESE_TAIWAN | The chinese Taiwan language. |
| CORSICAN_FRANCE | The corsican France language. |
| CROATIAN_CROATIA | The croatian Croatia language. |
| CROATIAN_LATIN_BOSNIA_AND_HERZEGOVINA | The croatian latin Bosnia and Herzegovina language. |
| CZECH_CZECH_REPUBLIC | The czech Czech Republic language. |
| DANISH_DENMARK | The danish Denmark language. |
| DARI_AFGHANISTAN | The dari Afghanistan language. |
| DIVEHI_MALDIVES | The divehi Maldives language. |
| DUTCH_BELGIUM | The dutch Belgium language. |
| DUTCH_NETHERLANDS | The dutch Netherlands language. |
| ENGLISH_AUSTRALIA | The english Australia language. |
| ENGLISH_BELIZE | The english Belize language. |
| ENGLISH_CANADA | The english Canada language. |
| ENGLISH_CARIBBEAN | The english Caribbean language. |
| ENGLISH_INDIA | The english India language. |
| ENGLISH_IRELAND | The english Ireland language. |
| ENGLISH_JAMAICA | The english Jamaica language. |
| ENGLISH_MALAYSIA | The english Malaysia language. |
| ENGLISH_NEW_ZEALAND | The english New Zealand language. |
| ENGLISH_REPUBLIC_OF_THE_PHILIPPINES | The english Republic of the Philippines language. |
| ENGLISH_SINGAPORE | The english Singapore language. |
| ENGLISH_SOUTH_AFRICA | The english south africa language. |
| ENGLISH_TRINIDAD_AND_TOBAGO | The english Trinidad and Tobago language. |
| ENGLISH_UNITED_KINGDOM | The english United Kingdom language. |
| ENGLISH_UNITED_STATES | The english United States language. |
| ENGLISH_ZIMBABWE | The english Zimbabwe language. |
| ESTONIAN_ESTONIA | The estonian Estonia language. |
| FAROESE_FAROE_ISLANDS | The faroese Faroe Islands language. |
| FILIPINO_PHILIPPINES | The filipino Philippines language. |
| FINNISH_FINLAND | The finnish Finland language. |
| FRENCH_BELGIUM | The french Belgium language. |
| FRENCH_CANADA | The french Canada language. |
| FRENCH_FRANCE | The french France language. |
| FRENCH_LUXEMBOURG | The french Luxembourg language. |
| FRENCH_PRINCIPALITY_OF_MONACO | The french Principality of Monaco language. |
| FRENCH_SWITZERLAND | The french Switzerland language. |
| FRISIAN_NETHERLANDS | The frisian Netherlands language. |
| GALICIAN_GALICIAN | The galician Galician language. |
| GEORGIAN_GEORGIA | The georgian Georgia language. |
| GERMAN_AUSTRIA | The german Austria language. |
| GERMAN_GERMANY | The german Germany language. |
| GERMAN_LIECHTENSTEIN | The german Liechtenstein language. |
| GERMAN_LUXEMBOURG | The german Luxembourg language. |
| GERMAN_SWITZERLAND | The german Switzerland language. |
| GREEK_GREECE | The greek Greece language. |
| GREENLANDIC_GREENLAND | The greenlandic Greenland language. |
| GUJARATI_INDIA | The gujarati India language. |
| HAUSA_LATIN_NIGERIA | The hausa latin Nigeria language. |
| HEBREW_ISRAEL | The hebrew Israel language. |
| HINDI_INDIA | The hindi India language. |
| HUNGARIAN_HUNGARY | The hungarian Hungary language. |
| ICELANDIC_ICELAND | The icelandic Iceland language. |
| IGBO_NIGERIA | The igbo Nigeria language. |
| INDONESIAN_INDONESIA | The indonesian Indonesia language. |
| INUKTITUT_CANADA | The inuktitut Canada language. |
| INUKTITUT_LATIN_CANADA | The inuktitut latin Canada language. |
| IRISH_IRELAND | The irish Ireland language. |
| ISI_XHOSA_SOUTH_AFRICA | The isi xhosa South Africa language. |
| ISI_ZULU_SOUTH_AFRICA | The isi zulu South Africa language. |
| ITALIAN_ITALY | The italian Italy language. |
| ITALIAN_SWITZERLAND | The italian Switzerland language. |
| JAPANESE_JAPAN | The japanese Japan language. |
| KANNADA_INDIA | The kannada India language. |
| KAZAKH_KAZAKHSTAN | The kazakh Kazakhstan language. |
| KHMER_CAMBODIA | The khmer Cambodia language. |
| KICHE_GUATEMALA | The kiche Guatemala language. |
| KINYARWANDA_RWANDA | The kinyarwanda Rwanda language. |
| KISWAHILI_KENYA | The kiswahili Kenya language. |
| KONKANI_INDIA | The konkani India language. |
| KOREAN_KOREA | The korean Korea language. |
| KYRGYZ_KYRGYZSTAN | The kyrgyz Kyrgyzstan language. |
| LAO_LAO_PDR | The lao lao PDR language. |
| LATVIAN_LATVIA | The latvian Latvia language. |
| LITHUANIAN_LITHUANIA | The lithuanian Lithuania language. |
| LOWER_SORBIAN_GERMANY | The lower sorbian Germany language. |
| LUXEMBOURGISH_LUXEMBOURG | The luxembourgish Luxembourg language. |
| MACEDONIAN_FYROM_FORMER_YUGOSLAV_REPUBLIC_OF_MACEDONIA | The macedonian fyrom former Yugoslav Republic of Macedonia language. |
| MALAY_BRUNEI_DARUSSALAM | The malay brunei Darussalam language. |
| MALAY_MALAYSIA | The malay Malaysia language. |
| MALAYALAM_INDIA | The malayalam India language. |
| MALTESE_MALTA | The maltese Malta language. |
| MAORI_NEW_ZEALAND | The maori New Zealand language. |
| MAPUDUNGUN_CHILE | The mapudungun Chile language. |
| MARATHI_INDIA | The marathi India language. |
| MOHAWK_MOHAWK | The mohawk Mohawk language. |
| MONGOLIAN_CYRILLIC_MONGOLIA | The mongolian cyrillic Mongolia language. |
| MONGOLIAN_TRADITIONAL_PEOPLES_REPUBLIC_OF_CHINA | The mongolian traditional Peoples Republic of China language. |
| NEPALI_NEPAL | The nepali Nepal language. |
| NORWEGIAN_BOKMAL_NORWAY | The norwegian bokmal Norway language. |
| NORWEGIAN_NYNORSK_NORWAY | The norwegian nynorsk Norway language. |
| OCCITAN_FRANCE | The occitan France language. |
| ODIA_FORMERLY_ORIYA_INDIA | The odia formerly oriya India language. |
| PASHTO_AFGHANISTAN | The pashto Afghanistan language. |
| POLISH_POLAND | The polish Poland language. |
| PORTUGUESE_BRAZIL | The portuguese Brazil language. |
| PORTUGUESE_PORTUGAL | The portuguese Portugal language. |
| PUNJABI_INDIA | The punjabi India language. |
| QUECHUA_BOLIVIA | The quechua Bolivia language. |
| QUECHUA_ECUADOR | The quechua Ecuador language. |
| QUECHUA_PERU | The quechua Peru language. |
| ROMANIAN_ROMANIA | The romanian Romania language. |
| ROMANSH_SWITZERLAND | The romansh Switzerland language. |
| RUSSIAN_RUSSIA | The russian Russia language. |
| SAMI_INARI_FINLAND | The sami inari Finland language. |
| SAMI_LULE_NORWAY | The sami lule Norway language. |
| SAMI_LULE_SWEDEN | The sami lule Sweden language. |
| SAMI_NORTHERN_FINLAND | The sami northern Finland language. |
| SAMI_NORTHERN_NORWAY | The sami northern Norway language. |
| SAMI_NORTHERN_SWEDEN | The sami northern Sweden language. |
| SAMI_SKOLT_FINLAND | The sami skolt Finland language. |
| SAMI_SOUTHERN_NORWAY | The sami southern Norway language. |
| SAMI_SOUTHERN_SWEDEN | The sami southern Sweden language. |
| SANSKRIT_INDIA | The sanskrit India language. |
| SERBIAN_CYRILLIC_BOSNIA_AND_HERZEGOVINA | The serbian cyrillic Bosnia and Herzegovina language. |
| SERBIAN_CYRILLIC_SERBIA | The serbian cyrillic Serbia language. |
| SERBIAN_LATIN_BOSNIA_AND_HERZEGOVINA | The serbian latin Bosnia and Herzegovina language. |
| SERBIAN_LATIN_SERBIA | The serbian latin Serbia language. |
| SESOTHO_SA_LEBOA_SOUTH_AFRICA | The sesotho sa leboa South Africa language. |
| SETSWANA_SOUTH_AFRICA | The setswana South Africa language. |
| SINHALA_SRI_LANKA | The sinhala Sri Lanka language. |
| SLOVAK_SLOVAKIA | The slovak Slovakia language. |
| SLOVENIAN_SLOVENIA | The slovenian Slovenia language. |
| SPANISH_ARGENTINA | The spanish Argentina language. |
| SPANISH_BOLIVIA | The spanish Bolivia language. |
| SPANISH_CHILE | The spanish Chile language. |
| SPANISH_COLOMBIA | The spanish Colombia language. |
| SPANISH_COSTA_RICA | The spanish Costa Rica language. |
| SPANISH_DOMINICAN_REPUBLIC | The spanish Dominican Republic language. |
| SPANISH_ECUADOR | The spanish Ecuador language. |
| SPANISH_EL_SALVADOR | The spanish El Salvador language. |
| SPANISH_GUATEMALA | The spanish Guatemala language. |
| SPANISH_HONDURAS | The spanish Honduras language. |
| SPANISH_MEXICO | The spanish Mexico language. |
| SPANISH_NICARAGUA | The spanish Nicaragua language. |
| SPANISH_PANAMA | The spanish Panama language. |
| SPANISH_PARAGUAY | The spanish Paraguay language. |
| SPANISH_PERU | The spanish Peru language. |
| SPANISH_PUERTO_RICO | The spanish Puerto Rico language. |
| SPANISH_MODERN_SORT_SPAIN | The spanish modern sort Spain language. |
| SPANISH_TRADITIONAL_SORT_SPAIN | The spanish traditional sort Spain language. |
| SPANISH_UNITED_STATES | The spanish United States language. |
| SPANISH_URUGUAY | The spanish Uruguay language. |
| SPANISH_VENEZUELA | The spanish Venezuela language. |
| SWEDEN_FINLAND | The sweden Finland language. |
| SWEDISH_SWEDEN | The swedish Sweden language. |
| SYRIAC_SYRIA | The syriac Syria language. |
| TAJIK_CYRILLIC_TAJIKISTAN | The tajik cyrillic tajikistan language. |
| TAMAZIGHT_LATIN_ALGERIA | The tamazight latin Algeria language. |
| TAMIL_INDIA | The tamil India language. |
| TATAR_RUSSIA | The tatar Russia language. |
| TELUGU_INDIA | The telugu India language. |
| THAI_THAILAND | The thai Thailand language. |
| TIBETAN_PRC | The tibetan PRC language. |
| TURKISH_TURKEY | The turkish Turkey language. |
| TURKMEN_TURKMENISTAN | The turkmen Turkmenistan language. |
| UIGHUR_PRC | The uighur PRC language. |
| UKRAINIAN_UKRAINE | The ukrainian Ukraine language. |
| UPPER_SORBIAN_GERMANY | The upper sorbian Germany language. |
| URDU_ISLAMIC_REPUBLIC_OF_PAKISTAN | The urdu Islamic Republic of Pakistan language. |
| UZBEK_CYRILLIC_UZBEKISTAN | The uzbek cyrillic Uzbekistan language. |
| UZBEK_LATIN_UZBEKISTAN | The uzbek latin Uzbekistan language. |
| VIETNAMESE_VIETNAM | The vietnamese Vietnam language. |
| WELSH_UNITED_KINGDOM | The welsh United Kingdom language. |
| WOLOF_SENEGAL | The wolof Senegal language. |
| YAKUT_RUSSIA | The yakut Russia language. |
| YI_PRC | The yi PRC language. |
| YORUBA_NIGERIA | The yoruba Nigeria language. |

### OpenTypeWindowsNameRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord.md

#### OpenTypeWindowsNameRecord class

Represents the Name record table value for `OpenTypePlatform.WINDOWS` platform.

**Inheritance:** `OpenTypeWindowsNameRecord` →
`OpenTypeBaseNameRecord` →
`CustomPackage` →
`MetadataPackage`

The OpenTypeWindowsNameRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name_id | Gets the name identifier. |
| platform | Gets the platform identifier. |
| value | Gets the string value of record. |
| encoding | Gets the encoding identifier. |
| language | Gets the language identifier. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/encoding.md

#### encoding property

Gets the encoding identifier.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/language.md

#### language property

Gets the language identifier.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/name_id.md

#### name_id property

Gets the name identifier.
##### Definition:
```python
@property
def name_id(self):
    ...
```

### platform property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/platform.md

#### platform property

Gets the platform identifier.
##### Definition:
```python
@property
def platform(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.font/opentypewindowsnamerecord/value.md

#### value property

Gets the string value of record.
##### Definition:
```python
@property
def value(self):
    ...
```

### groupdocs.metadata.formats.gis
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis.md

##### Classes
| Class | Description |
| :- | :- |
| `GisAttribute` | Represents metadata associated with layer. |
| `GisFeature` | Represents metadata associated with feature. |
| `GisPackage` | Represents gis metadata. |
| `GisRootPackage` | Represents gis metadata. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `GisFormat` | Defines various gis subformats. |

### GisAttribute class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute.md

#### GisAttribute class

Represents metadata associated with layer.

**Inheritance:** `GisAttribute` →
`CustomPackage` →
`MetadataPackage`

The GisAttribute type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the attribute name. |
| value | Gets the attribute value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/name.md

#### name property

Gets the attribute name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisattribute/value.md

#### value property

Gets the attribute value.
##### Definition:
```python
@property
def value(self):
    ...
```

### GisFeature class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature.md

#### GisFeature class

Represents metadata associated with feature.

**Inheritance:** `GisFeature` →
`CustomPackage` →
`MetadataPackage`

The GisFeature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| attributes | Gets an array of `GisAttribute`. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### attributes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/attributes.md

#### attributes property

Gets an array of `GisAttribute`.
##### Definition:
```python
@property
def attributes(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisfeature/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GisFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisformat.md

#### GisFormat enumeration

Defines various gis subformats.

The GisFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | The format is not recognized. |
| SHP | Shp file. |
| GEO_JSON | GeoJson file. |
| TOPO_JSON | TopoJson file. |
| GML | Gml file. |
| OSM | Osm file. |
| KML | Kml file. |
| GPX | Gpx file. |

### GisPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage.md

#### GisPackage class

Represents gis metadata.

**Inheritance:** `GisPackage` →
`CustomPackage` →
`MetadataPackage`

The GisPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| features | Gets an array of `GisFeature`. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Example

The following code snippet shows how to get metadata from a gis file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### features property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/features.md

#### features property

Gets an array of `GisFeature`.
##### Definition:
```python
@property
def features(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gispackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GisRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage.md

#### GisRootPackage class

Represents gis metadata.

**Inheritance:** `GisRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The GisRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| gis_package | Gets the Gis metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Example

The following code snippet shows how to get metadata from a gis file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gis_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/gis_package.md

#### gis_package property

Gets the Gis metadata package.
##### Definition:
```python
@property
def gis_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.gis/gisrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.image.dng
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng.md

##### Classes
| Class | Description |
| :- | :- |
| `DngPackage` | Represents native DNG metadata. |
| `DngRootPackage` | Represents the root package intended to work with metadata in a DNG image. |

### DngPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage.md

#### DngPackage class

Represents native DNG metadata.

**Inheritance:** `DngPackage` →
`CustomPackage` →
`MetadataPackage`

The DngPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Metadata` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| camera_manufacturer | Gets the camera manufacturer. |
| colors_count | Gets the colors. |
| description | Gets the description of colors (RGBG,RGBE,GMCY, or GBTG). |
| dng_version | Gets the DNG version. |
| filters | Gets the Bit mask describing the order of color pixels in the matrix. |
| is_foveon | Gets the is foveon matrix. |
| model | Gets the camera model. |
| raw_count | Gets the number of RAW images in file (0 means that the file has not been recognized). |
| software | Gets the software. |
| translation_cfa_dng | Gets the translation array for CFA mosaic DNG format. |
| aperture | Gets the aperture. |
| artist | Gets the author of image. |
| focal_length | Gets the length of the focal. |
| gps_data | Gets the GPS data. |
| iso_speed | Gets the ISO sensitivity. |
| shot_order | Gets serial number of image. |
| shutter_speed | Gets the shutter speed. |
| timestamp | Gets the date of shooting. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### DngPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Metadata` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### aperture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/aperture.md

#### aperture property

Gets the aperture.
##### Definition:
```python
@property
def aperture(self):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/artist.md

#### artist property

Gets the author of image.
##### Definition:
```python
@property
def artist(self):
    ...
```

### camera_manufacturer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/camera_manufacturer.md

#### camera_manufacturer property

Gets the camera manufacturer.
##### Definition:
```python
@property
def camera_manufacturer(self):
    ...
```

### colors_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/colors_count.md

#### colors_count property

Gets the colors.
##### Definition:
```python
@property
def colors_count(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/description.md

#### description property

Gets the description of colors (RGBG,RGBE,GMCY, or GBTG).
##### Definition:
```python
@property
def description(self):
    ...
```

### dng_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/dng_version.md

#### dng_version property

Gets the DNG version.
##### Definition:
```python
@property
def dng_version(self):
    ...
```

### filters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/filters.md

#### filters property

Gets the Bit mask describing the order of color pixels in the matrix.
##### Definition:
```python
@property
def filters(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/focal_length.md

#### focal_length property

Gets the length of the focal.
##### Definition:
```python
@property
def focal_length(self):
    ...
```

### gps_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/gps_data.md

#### gps_data property

Gets the GPS data.
##### Definition:
```python
@property
def gps_data(self):
    ...
```

### is_foveon property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/is_foveon.md

#### is_foveon property

Gets the is foveon matrix.
##### Definition:
```python
@property
def is_foveon(self):
    ...
```

### iso_speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/iso_speed.md

#### iso_speed property

Gets the ISO sensitivity.
##### Definition:
```python
@property
def iso_speed(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/model.md

#### model property

Gets the camera model.
##### Definition:
```python
@property
def model(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/raw_count.md

#### raw_count property

Gets the number of RAW images in file (0 means that the file has not been recognized).
##### Definition:
```python
@property
def raw_count(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shot_order property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/shot_order.md

#### shot_order property

Gets serial number of image.
##### Definition:
```python
@property
def shot_order(self):
    ...
```

### shutter_speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/shutter_speed.md

#### shutter_speed property

Gets the shutter speed.
##### Definition:
```python
@property
def shutter_speed(self):
    ...
```

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/software.md

#### software property

Gets the software.
##### Definition:
```python
@property
def software(self):
    ...
```

### timestamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/timestamp.md

#### timestamp property

Gets the date of shooting.
##### Definition:
```python
@property
def timestamp(self):
    ...
```

### translation_cfa_dng property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/translation_cfa_dng.md

#### translation_cfa_dng property

Gets the translation array for CFA mosaic DNG format.
##### Definition:
```python
@property
def translation_cfa_dng(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DngRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage.md

#### DngRootPackage class

Represents the root package intended to work with metadata in a DNG image.

**Inheritance:** `DngRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DngRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| dng_package | Gets the DNG header metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### dng_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/dng_package.md

#### dng_package property

Gets the DNG header metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def dng_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.dng/dngrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.image.svg
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg.md

##### Classes
| Class | Description |
| :- | :- |
| `SvgPackage` | Represents a native metadata package in a SVG image file. |
| `SvgRootPackage` | Represents a native metadata package in a SVG image file. |

### SvgPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage.md

#### SvgPackage class

Represents a native metadata package in a SVG image file.

**Inheritance:** `SvgPackage` →
`CustomPackage` →
`MetadataPackage`

The SvgPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `SvgPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| height | Gets the image height. |
| width | Gets the image width. |
| height_f | Gets the object height, in inches. |
| width_f | Gets the object width, in inches. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract technical information from a SVG file.

### SvgPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `SvgPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/height.md

#### height property

Gets the image height.
##### Definition:
```python
@property
def height(self):
    ...
```

### height_f property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/height_f.md

#### height_f property

Gets the object height, in inches.
##### Definition:
```python
@property
def height_f(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/width.md

#### width property

Gets the image width.
##### Definition:
```python
@property
def width(self):
    ...
```

### width_f property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgpackage/width_f.md

#### width_f property

Gets the object width, in inches.
##### Definition:
```python
@property
def width_f(self):
    ...
```

### SvgRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage.md

#### SvgRootPackage class

Represents a native metadata package in a SVG image file.

**Inheritance:** `SvgRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The SvgRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| svg_package | Gets the Svg native metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to extract technical information from a SVG file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### svg_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/svg_package.md

#### svg_package property

Gets the Svg native metadata package.
##### Definition:
```python
@property
def svg_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.svg/svgrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### groupdocs.metadata.formats.image
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image.md

The namespace provides functionality allowing users to read and update metadata stored in different image formats.

##### Classes
| Class | Description |
| :- | :- |
| `BmpHeaderPackage` | Represents BMP header info. |
| `BmpRootPackage` | Represents the root package intended to work with metadata in a BMP image. |
| `DicomPackage` | Represents native DICOM metadata. |
| `DicomRootPackage` | Represents the root package intended to work with metadata in a DICOM image. |
| `DjVuRootPackage` | Represents the root package intended to work with metadata in an DjVu image. |
| `EmfRootPackage` | Represents the root package intended to work with metadata in an EMF image. |
| `GifImageTypePackage` | Represents a metadata package containing GIF-specific file format information. |
| `GifRootPackage` | Represents the root package intended to work with metadata in a GIF image. |
| `HeifRootPackage` | Represents the root package intended to work with metadata in a HEIF image. |
| `ImageResourceBlock` | Represents a Photoshop Image Resource block.
<br/><br/>
<br/>Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF.
<br/>Image resources are used to store non-pixel data associated with images, such as pen tool paths. |
| `ImageResourcePackage` | Represents a metadata package containing Photoshop Image Resources. |
| `ImageRootPackage` | Provides a base abstract class for all image root packages. |
| `ImageTypePackage` | Represents a metadata package containing image-specific file format information. |
| `Jpeg2000Package` | Represents native JPEG2000 metadata. |
| `Jpeg2000RootPackage` | Represents the root package intended to work with metadata in a JPEG2000 image. |
| `JpegRootPackage` | Represents the root package allowing working with metadata in a JPEG image. |
| `PngCompressedTextChunk` | Represents compressed textual data extracted from a PNG image. |
| `PngInternationalTextChunk` | Represents international textual data extracted from a PNG image. |
| `PngPackage` | Represents native PNG metadata. |
| `PngRootPackage` | Represents the root package intended to work with metadata in a PNG image. |
| `PngTextChunk` | Represents textual data extracted from a PNG image. |
| `PsdLayer` | Represents a layer in a PSD file. |
| `PsdPackage` | Represents native Photoshop metadata. |
| `PsdRootPackage` | Represents the root package allowing working with metadata in a Photoshop Document. |
| `RawDoubleTag` | Represents a Raw Double tag. |
| `RawFloatTag` | Represents a Raw float tag. |
| `RawRational` | Represents a rational number. |
| `RawRationalTag` | Represents a Raw Rational tag. |
| `RawSByteTag` | Represents a Raw SByte tag. |
| `RawSLongTag` | Represents a Raw SLong tag. |
| `RawSRational` | Represents signed rational number. |
| `RawSRationalTag` | Represents a Raw SRational tag. |
| `RawSShortTag` | Represents a Raw SShort tag. |
| `RawTypePackage` | Represents a metadata package containing image-specific file format information. |
| `RawUndefinedTag` | Represents a Raw tag with the Undefined type. |
| `TiffAsciiTag` | Represents a TIFF ASCII tag. |
| `TiffByteTag` | Represents a Byte tag. |
| `TiffDoubleTag` | Represents a TIFF Double tag. |
| `TiffFloatTag` | Represents a TIFF float tag. |
| `TiffLongTag` | Represents a TIFF Long tag. |
| `TiffRational` | Represents a rational number. |
| `TiffRationalTag` | Represents a TIFF Rational tag. |
| `TiffRootPackage` | Represents the root package allowing working with metadata in a TIFF image. |
| `TiffSByteTag` | Represents a TIFF SByte tag. |
| `TiffSLongTag` | Represents a TIFF SLong tag. |
| `TiffSRational` | Represents signed rational number. |
| `TiffSRationalTag` | Represents a TIFF SRational tag. |
| `TiffSShortTag` | Represents a TIFF SShort tag. |
| `TiffShortTag` | Represents a TIFF Short tag. |
| `TiffTag` | Represents a TIFF tag. |
| `TiffUndefinedTag` | Represents a TIFF tag with the Undefined type. |
| `WebPRootPackage` | Represents the root package allowing working with metadata in a WEBP image. |
| `WmfRootPackage` | Represents the root package intended to work with metadata in a WMF image. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ImageResourceID` | Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file. |
| `PngCompressionMethod` | Defines compression methods used in the PNG format. |
| `PsdColorMode` | Represents the psd file format color mode. |
| `PsdCompressionMethod` | Defines the compression method used for image data. |
| `PsdLayerFlags` | The Photoshop layer flags. |
| `TiffTagID` | Defines ids of TIFF tags. |
| `TiffTagType` | Represents the IFD data type. |

### BmpHeaderPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage.md

#### BmpHeaderPackage class

Represents BMP header info.

**Inheritance:** `BmpHeaderPackage` →
`CustomPackage` →
`MetadataPackage`

The BmpHeaderPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| header_size | Gets the size of the header in bytes. |
| bits_per_pixel | Gets the bits per pixel value. |
| image_size | Gets the bitmap raw data size in bytes. |
| planes | Gets the number of planes. |
| colors_important | Gets the number of important palette colors. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bits_per_pixel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/bits_per_pixel.md

#### bits_per_pixel property

Gets the bits per pixel value.
##### Definition:
```python
@property
def bits_per_pixel(self):
    ...
```

### colors_important property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/colors_important.md

#### colors_important property

Gets the number of important palette colors.
##### Definition:
```python
@property
def colors_important(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### header_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/header_size.md

#### header_size property

Gets the size of the header in bytes.
##### Definition:
```python
@property
def header_size(self):
    ...
```

### image_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/image_size.md

#### image_size property

Gets the bitmap raw data size in bytes.
##### Definition:
```python
@property
def image_size(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### planes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/planes.md

#### planes property

Gets the number of planes.
##### Definition:
```python
@property
def planes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmpheaderpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### BmpRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage.md

#### BmpRootPackage class

Represents the root package intended to work with metadata in a BMP image.

**Inheritance:** `BmpRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The BmpRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| bmp_header | Gets the BMP header metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read the header of a BMP file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bmp_header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/bmp_header.md

#### bmp_header property

Gets the BMP header metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def bmp_header(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/bmprootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DicomPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage.md

#### DicomPackage class

Represents native DICOM metadata.

**Inheritance:** `DicomPackage` →
`CustomPackage` →
`MetadataPackage`

The DicomPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Metadata` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| header_offset | Gets the header offset. |
| header_bytes | Gets the header information by bytes. |
| bits_allocated | Gets the bits allocated value. |
| dicom_info | Gets the header information of the DICOM file. |
| blues | Gets the array colors of the blue. |
| greens | Gets the array colors of the green. |
| reds | Gets the array colors of the red. |
| number_of_frames | Gets the number of frames. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### DicomPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Metadata` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bits_allocated property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/bits_allocated.md

#### bits_allocated property

Gets the bits allocated value.
##### Definition:
```python
@property
def bits_allocated(self):
    ...
```

### blues property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/blues.md

#### blues property

Gets the array colors of the blue.
##### Definition:
```python
@property
def blues(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### dicom_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/dicom_info.md

#### dicom_info property

Gets the header information of the DICOM file.
##### Definition:
```python
@property
def dicom_info(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### greens property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/greens.md

#### greens property

Gets the array colors of the green.
##### Definition:
```python
@property
def greens(self):
    ...
```

### header_bytes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/header_bytes.md

#### header_bytes property

Gets the header information by bytes.
##### Definition:
```python
@property
def header_bytes(self):
    ...
```

### header_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/header_offset.md

#### header_offset property

Gets the header offset.
##### Definition:
```python
@property
def header_offset(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### number_of_frames property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/number_of_frames.md

#### number_of_frames property

Gets the number of frames.
##### Definition:
```python
@property
def number_of_frames(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### reds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/reds.md

#### reds property

Gets the array colors of the red.
##### Definition:
```python
@property
def reds(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicompackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DicomRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage.md

#### DicomRootPackage class

Represents the root package intended to work with metadata in a DICOM image.

**Inheritance:** `DicomRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DicomRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| dicom_package | Gets the DICOM native metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to read DICOM format-specific metadata properties.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### dicom_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/dicom_package.md

#### dicom_package property

Gets the DICOM native metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def dicom_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/dicomrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DjVuRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage.md

#### DjVuRootPackage class

Represents the root package intended to work with metadata in an DjVu image.

**Inheritance:** `DjVuRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DjVuRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/djvurootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### EmfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage.md

#### EmfRootPackage class

Represents the root package intended to work with metadata in an EMF image.

**Inheritance:** `EmfRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The EmfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/emfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GifImageTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage.md

#### GifImageTypePackage class

Represents a metadata package containing GIF-specific file format information.

**Inheritance:** `GifImageTypePackage` →
`ImageTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The GifImageTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| width | Gets the image width. |
| height | Gets the image height. |
| byte_order | Gets the byte-order of the image.
<br/>Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |
| version | Gets the version of the format. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### byte_order property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/byte_order.md

#### byte_order property

Gets the byte-order of the image.
Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information.
##### Definition:
```python
@property
def byte_order(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/height.md

#### height property

Gets the image height.
##### Definition:
```python
@property
def height(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/version.md

#### version property

Gets the version of the format.
##### Definition:
```python
@property
def version(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifimagetypepackage/width.md

#### width property

Gets the image width.
##### Definition:
```python
@property
def width(self):
    ...
```

### GifRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage.md

#### GifRootPackage class

Represents the root package intended to work with metadata in a GIF image.

**Inheritance:** `GifRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The GifRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| is_xmp_supported | Gets a value indicating whether the XMP metadata is supported for this image. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code snippet shows how to detect the version of a loaded GIF image and extract some additional file format information.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### is_xmp_supported property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/is_xmp_supported.md

#### is_xmp_supported property

Gets a value indicating whether the XMP metadata is supported for this image.
##### Definition:
```python
@property
def is_xmp_supported(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/gifrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### HeifRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage.md

#### HeifRootPackage class

Represents the root package intended to work with metadata in a HEIF image.

**Inheritance:** `HeifRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The HeifRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/heifrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### ImageResourceBlock class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock.md

#### ImageResourceBlock class

Represents a Photoshop Image Resource block.

Image resource blocks are the basic building unit of several file formats, including Photoshop's native file format, JPEG, and TIFF.
Image resources are used to store non-pixel data associated with images, such as pen tool paths.

**Inheritance:** `ImageResourceBlock` →
`CustomPackage` →
`MetadataPackage`

The ImageResourceBlock type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| signature | Gets the image resource block signature. |
| id | Gets the unique identifier for the resource. |
| name | Gets the image resource block name. |
| data | Gets the resource data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/data.md

#### data property

Gets the resource data.
##### Definition:
```python
@property
def data(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/id.md

#### id property

Gets the unique identifier for the resource.
##### Definition:
```python
@property
def id(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/name.md

#### name property

Gets the image resource block name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### signature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/signature.md

#### signature property

Gets the image resource block signature.
##### Definition:
```python
@property
def signature(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceblock/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ImageResourceID enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourceid.md

#### ImageResourceID enumeration

Image resources standard ID numbers. Not all file formats use all ID's. Some information may be stored in other sections of the file.

The ImageResourceID type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RESOLUTION_INFO | ResolutionInfo structure. See Appendix A in Photoshop API Guide PDF document. |
| NAMES_OF_ALPHA_CHANNELS | Names of the alpha channels as a series of Pascal strings. |
| CAPTION | The caption as a Pascal string. |
| BORDER_INFORMATION | Border information.
<br/>Contains a fixed number (2 bytes real, 2 bytes fraction) for the border width,
<br/>and 2 bytes for border units (1 = inches, 2 = cm, 3 = points, 4 = picas, 5 = columns). |
| BACKGROUND_COLOR | Background color. |
| PRINT_FLAGS | Print flags.
<br/>A series of one-byte boolean values (see Page Setup dialog):
<br/>labels, crop marks, color bars, registration marks, negative, flip, interpolate, caption, print flags. |
| GRAYSCALE | Grayscale and multichannel halftoning information. |
| COLOR_HALFTONING | Color halftoning information. |
| DUOTONE_HALFTONING | Duotone halftoning information. |
| GRAYSCALE_FUNCTION | Grayscale and multichannel transfer function. |
| COLOR_TRANSFER_FUNCTIONS | Color transfer functions. |
| DUOTONE_TRANSFER_FUNCTIONS | Duotone transfer functions. |
| DUOTONE_IMAGE_INFORMATION | Duotone image information. |
| EPS_OPTIONS | EPS options. |
| QUICK_MASK_INFORMATION | Quick Mask information. 2 bytes containing Quick Mask channel ID; 1- byte boolean indicating whether the mask was initially empty. |
| LAYER_STATE_INFORMATION | Layer state information. 2 bytes containing the index of target layer (0 = bottom layer). |
| WORKING_PATH | Working path (not saved). See See Path resource format. |
| LAYERS_GROUP_INFORMATION | Layers group information.
<br/>2 bytes per layer containing a group ID for the dragging groups. Layers in a group have the same group ID. |
| IPTC | IPTC-NAA record. Contains the File Info... information. See the documentation in the IPTC folder of the Documentation folder. |
| IMAGE_MODE_FOR_RAW_FORMAT | Image mode for raw format files. |
| JPEG_QUALITY | JPEG quality. Private. |
| GRID_AND_GUIDES_INFO_PHOTOSHOP4 | Grid and guides information. |
| THUMBNAIL_RESOURCE_PHOTOSHOP4 | Thumbnail resource for Photoshop 4.0 only. |
| COPYRIGHT_FLAG_PHOTOSHOP4 | Copyright flag. Boolean indicating whether image is copyrighted. Can be set via Property suite or by user in File Info... |
| URL_PHOTOSHOP4 | URL. Handle of a text string with uniform resource locator. Can be set via Property suite or by user in File Info... |
| THUMBNAIL_RESOURCE_PHOTOSHOP5 | Thumbnail resource (supersedes resource 1033). See See Thumbnail resource format. |
| GLOBAL_ANGLE_PHOTOSHOP5 | Global Angle.
<br/>4 bytes that contain an integer between 0 and 359, which is the global lighting angle for effects layer. If not present, assumed to be 30. |
| ICC_PROFILE_PHOTOSHOP5 | (Photoshop 5.0) ICC Profile.
<br/>The raw bytes of an ICC (International Color Consortium) format profile. See ICC1v42_2006-05.pdf in the Documentation folder and icProfileHeader.h in Sample Code\Common\Includes. |
| WATERMARK_PHOTOSHOP5 | Watermark. One byte. |
| ICC_UNTAGGED_PROFILE_PHOTOSHOP5 | ICC Untagged Profile. 1 byte that disables any assumed profile handling when opening the file. 1 = intentionally untagged. |
| TRANSPARENCY_INDEX_PHOTOSHOP6 | Transparency Index. 2 bytes for the index of transparent color, if any. |
| GLOBAL_ALTITUDE_PHOTOSHOP6 | Global Altitude. 4 byte entry for altitude. |
| SLICES_PHOTOSHOP6 | Slices (Photoshop 6). |
| WORKFLOW_URL_PHOTOSHOP6 | Workflow URL. Unicode string. Photoshop 6. |
| ALPHA_IDENTIFIERS_PHOTOSHOP6 | Alpha Identifiers. 4 bytes of length, followed by 4 bytes each for every alpha identifier. |
| URL_LIST_PHOTOSHOP6 | URL InternalList. 4 byte count of URLs, followed by 4 byte long, 4 byte ID, and Unicode string for each count. |
| VERSION_INFO_PHOTOSHOP6 | Version Info. 4 bytes version, 1 byte hasRealMergedData , Unicode string: writer name, Unicode string: reader name, 4 bytes file version. |
| EXIF_DATA_1_PHOTOSHOP_7 | EXIF data 1 |
| EXIF_DATA_3_PHOTOSHOP_7 | ExifData3Photoshop7 |
| XMP_PHOTOSHOP7 | XMP metadata. File info as XML description. |
| CAPTION_DIGEST_PHOTOSHOP7 | Caption digest. 16 bytes: RSA Data Security, MD5 message-digest algorithm. |
| PRINT_SCALE_PHOTOSHOP7 | Print scale. 2 bytes style (0 = centered, 1 = size to fit, 2 = user defined).
<br/>4 bytes x location (floating point).
<br/>4 bytes y location (floating point).
<br/>4 bytes scale (floating point). |
| PIXEL_ASPECT_RATIO | Pixel Aspect Ratio. 4 bytes (version = 1 or 2), 8 bytes double, x / y of a pixel.
<br/>Version 2, attempting to correct values for NTSC and PAL, previously off by a factor of approx. 5%. |
| LAYER_COMPS | Layer Comps. 4 bytes (descriptor version = 16), Descriptor. |
| LAYER_SELECTION_IDS | Layer Selection ID(s).
<br/>2 bytes count, following is repeated for each count: 4 bytes layer ID. |
| PRINT_INFO_CS2 | Print info (Photoshop CS2). |
| LAYER_GROUP_ENABLED_ID_CS2 | Layer Group(s) Enabled ID.
<br/>1 byte for each layer in the document, repeated by length of the resource.
<br/>NOTE: Layer groups have start and end markers (Photoshop CS2). |
| COLOR_SAMPLERS_RESOURCE_CS3 | Color samplers resource. Also see ID 1038 for old format. |
| MEASUREMENT_SCALE_CS3 | Measurement Scale. 4 bytes (descriptor version = 16), Descriptor. |
| TIMELINE_INFORMATION_CS3 | Timeline Information. 4 bytes (descriptor version = 16), Descriptor. |
| SHEET_DISCLOSURE_CS3 | Sheet Disclosure. 4 bytes (descriptor version = 16), Descriptor. |
| PRINT_INFORMATION_CS5 | Print Information (Photoshop CS5). |
| PRINT_STYLE_CS5 | Print Style (Photoshop CS5). |
| MACINTOSH_NS_PRINT_INFO_CS5 | Macintosh NSPrintInfo.
<br/>Variable OS specific info for Macintosh. NSPrintInfo.
<br/>It is recommended that you do not interpret or use this data. (Photoshop CS5). |
| WINDOWS_DEVMODE_CS5 | Windows DEVMODE.
<br/>Variable OS specific info for Windows. DEVMODE.
<br/>It is recommended that you do not interpret or use this data. (Photoshop CS5). |
| AUTO_SAVE_FILE_PATH_CS6 | Auto Save File Path. Unicode string. (Photoshop CS6). |
| AUTO_SAVE_FORMAT_CS6 | Auto Save Format. Unicode string. (Photoshop CS6). |
| PATH_SELECTION_STATE_CC | Path Selection State. (Photoshop CC). |
| IMAGE_READY_VARIABLES | Image Ready variables. XML representation of variables definition. |
| IMAGE_READY_DATASETS | Image Ready data sets. |
| PRINT_FLAGS_INFORMATION | Print flags information.
<br/>2 bytes version ( = 1),
<br/>1 byte center crop marks,
<br/>1 byte ( = 0), 4 bytes bleed width value, 2 bytes bleed width scale. |

### ImageResourcePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage.md

#### ImageResourcePackage class

Represents a metadata package containing Photoshop Image Resources.

**Inheritance:** `ImageResourcePackage` →
`CustomPackage` →
`MetadataPackage`

The ImageResourcePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Image Resource Blocks from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imageresourcepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ImageRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage.md

#### ImageRootPackage class

Provides a base abstract class for all image root packages.

**Inheritance:** `ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The ImageRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagerootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ImageTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage.md

#### ImageTypePackage class

Represents a metadata package containing image-specific file format information.

**Inheritance:** `ImageTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The ImageTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| width | Gets the image width. |
| height | Gets the image height. |
| byte_order | Gets the byte-order of the image.
<br/>Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### byte_order property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/byte_order.md

#### byte_order property

Gets the byte-order of the image.
Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information.
##### Definition:
```python
@property
def byte_order(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/height.md

#### height property

Gets the image height.
##### Definition:
```python
@property
def height(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/imagetypepackage/width.md

#### width property

Gets the image width.
##### Definition:
```python
@property
def width(self):
    ...
```

### Jpeg2000Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package.md

#### Jpeg2000Package class

Represents native JPEG2000 metadata.

**Inheritance:** `Jpeg2000Package` →
`CustomPackage` →
`MetadataPackage`

The Jpeg2000Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comments | Gets the JPEG2000 comments. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/comments.md

#### comments property

Gets the JPEG2000 comments.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Jpeg2000RootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage.md

#### Jpeg2000RootPackage class

Represents the root package intended to work with metadata in a JPEG2000 image.

**Inheritance:** `Jpeg2000RootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The Jpeg2000RootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |
| jpeg_2000_package | Gets the JPEG2000 native metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### jpeg_2000_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/jpeg_2000_package.md

#### jpeg_2000_package property

Gets the JPEG2000 native metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet demonstrates how to read JPEG2000 image comments.
##### Definition:
```python
@property
def jpeg_2000_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpeg2000rootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### JpegRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage.md

#### JpegRootPackage class

Represents the root package allowing working with metadata in a JPEG image.

**Inheritance:** `JpegRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The JpegRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |
| iptc_package | Gets or sets the IPTC metadata package. |
| image_resource_package | Gets the Photoshop Image Resource metadata package.
<br/>Image resource blocks are the basic building unit of Photoshop native file format. |
| maker_note_package | Gets or sets the MakerNote metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_image_resource_package(self)` | Removes Photoshop Image Resource metadata package. |
| `detect_barcode_types(self)` | Extracts the types of the barcodes presented in the image. |

##### Remarks

**Learn more** |
|
 |
 |
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### detect_barcode_types method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/detect_barcode_types.md

#### detect_barcode_types(self)

Extracts the types of the barcodes presented in the image.

##### Returns

An array of barcode types.

```python

def detect_barcode_types(self):
    ...
```

##### Remarks

**Learn more** |
|
 |
##### Example

This code snippet demonstrates how to detect barcodes in a JPEG image.

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### image_resource_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/image_resource_package.md

#### image_resource_package property

Gets the Photoshop Image Resource metadata package.
Image resource blocks are the basic building unit of Photoshop native file format.

##### Remarks

**Learn more** |
|
 |

##### Example

The code sample below demonstrates how to extract image resource blocks (building blocks of the Photoshop file format) from a JPEG image.
##### Definition:
```python
@property
def image_resource_package(self):
    ...
```

### iptc_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/iptc_package.md

#### iptc_package property

Gets or sets the IPTC metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read basic IPTC metadata properties.
##### Definition:
```python
@property
def iptc_package(self):
    ...
@iptc_package.setter
def iptc_package(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### maker_note_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/maker_note_package.md

#### maker_note_package property

Gets or sets the MakerNote metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def maker_note_package(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_image_resource_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/remove_image_resource_package.md

#### remove_image_resource_package(self)

Removes Photoshop Image Resource metadata package.

```python

def remove_image_resource_package(self):
    ...
```

##### Remarks

**Learn more** |
|
 |
##### Example

This code snippet demonstrates how to remove Photoshop metadata from a JPEG image.

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/jpegrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### PngCompressedTextChunk class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk.md

#### PngCompressedTextChunk class

Represents compressed textual data extracted from a PNG image.

**Inheritance:** `PngCompressedTextChunk` →
`PngTextChunk` →
`CustomPackage` →
`MetadataPackage`

The PngCompressedTextChunk type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| keyword | Gets the keyword that indicates the type of information represented by the chunk. |
| text | Gets the actual text string represented by the chunk. |
| compression_method | Gets the algorithm used to compress the chunk data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### compression_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/compression_method.md

#### compression_method property

Gets the algorithm used to compress the chunk data.
##### Definition:
```python
@property
def compression_method(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keyword property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/keyword.md

#### keyword property

Gets the keyword that indicates the type of information represented by the chunk.
##### Definition:
```python
@property
def keyword(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/text.md

#### text property

Gets the actual text string represented by the chunk.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressedtextchunk/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PngCompressionMethod enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngcompressionmethod.md

#### PngCompressionMethod enumeration

Defines compression methods used in the PNG format.

The PngCompressionMethod type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFLATE | Represents the deflate/inflate compression with a sliding window. |

### PngInternationalTextChunk class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk.md

#### PngInternationalTextChunk class

Represents international textual data extracted from a PNG image.

**Inheritance:** `PngInternationalTextChunk` →
`PngCompressedTextChunk` →
`PngTextChunk` →
`CustomPackage` →
`MetadataPackage`

The PngInternationalTextChunk type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| keyword | Gets the keyword that indicates the type of information represented by the chunk. |
| text | Gets the actual text string represented by the chunk. |
| compression_method | Gets the algorithm used to compress the chunk data. |
| is_compressed | Gets a value indicating whether the chunk is compressed. |
| language | Gets the human language used by the translated keyword and the text. |
| translated_keyword | Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### compression_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/compression_method.md

#### compression_method property

Gets the algorithm used to compress the chunk data.
##### Definition:
```python
@property
def compression_method(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### is_compressed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/is_compressed.md

#### is_compressed property

Gets a value indicating whether the chunk is compressed.
##### Definition:
```python
@property
def is_compressed(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keyword property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/keyword.md

#### keyword property

Gets the keyword that indicates the type of information represented by the chunk.
##### Definition:
```python
@property
def keyword(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/language.md

#### language property

Gets the human language used by the translated keyword and the text.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/text.md

#### text property

Gets the actual text string represented by the chunk.
##### Definition:
```python
@property
def text(self):
    ...
```

### translated_keyword property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/translated_keyword.md

#### translated_keyword property

Gets the translated keyword that contains a translation of the keyword into the language indicated by the language property.
##### Definition:
```python
@property
def translated_keyword(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pnginternationaltextchunk/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PngPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage.md

#### PngPackage class

Represents native PNG metadata.

**Inheritance:** `PngPackage` →
`CustomPackage` →
`MetadataPackage`

The PngPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| text_chunks | Gets the collection of text chunks extracted from the image. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text_chunks property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/text_chunks.md

#### text_chunks property

Gets the collection of text chunks extracted from the image.
##### Definition:
```python
@property
def text_chunks(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PngRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage.md

#### PngRootPackage class

Represents the root package intended to work with metadata in a PNG image.

**Inheritance:** `PngRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The PngRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |
| png_package | Gets the PNG native metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### png_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/png_package.md

#### png_package property

Gets the PNG native metadata package.
##### Definition:
```python
@property
def png_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### PngTextChunk class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk.md

#### PngTextChunk class

Represents textual data extracted from a PNG image.

**Inheritance:** `PngTextChunk` →
`CustomPackage` →
`MetadataPackage`

The PngTextChunk type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| keyword | Gets the keyword that indicates the type of information represented by the chunk. |
| text | Gets the actual text string represented by the chunk. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keyword property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/keyword.md

#### keyword property

Gets the keyword that indicates the type of information represented by the chunk.
##### Definition:
```python
@property
def keyword(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/text.md

#### text property

Gets the actual text string represented by the chunk.
##### Definition:
```python
@property
def text(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/pngtextchunk/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### PsdColorMode enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdcolormode.md

#### PsdColorMode enumeration

Represents the psd file format color mode.

The PsdColorMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BITMAP | The bitmap color mode. |
| GRAYSCALE | The grayscale mode. |
| INDEXED | The indexed color mode. |
| RGB | The RGB color mode. |
| CMYK | The CMYK color mode. |
| MULTICHANNEL | The multichannel color mode. |
| DUOTONE | The duotone color mode. |
| LAB | The LAB color mode. |

### PsdCompressionMethod enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdcompressionmethod.md

#### PsdCompressionMethod enumeration

Defines the compression method used for image data.

The PsdCompressionMethod type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RAW | No compression. The image data stored as raw bytes in RGBA planar order.
<br/>That means that first all R data is written, then all G is written, then all B and finally all A data is written. |
| RLE | RLE compressed. The image data starts with the byte counts for all the scan lines (rows * channels), with each
<br/>count stored as a two-byte value. The RLE compressed data follows, with each scan line compressed separately.
<br/>The RLE compression is the same compression algorithm used by the Macintosh ROM routine PackBits and the TIFF standard. |
| ZIP_WITHOUT_PREDICTION | ZIP without prediction. |
| ZIP_WITH_PREDICTION | ZIP with prediction. |

### PsdLayer class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer.md

#### PsdLayer class

Represents a layer in a PSD file.

**Inheritance:** `PsdLayer` →
`CustomPackage` →
`MetadataPackage`

The PsdLayer type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| bits_per_pixel | Gets the bits per pixel value. |
| channel_count | Gets the number of channels. |
| flags | Gets the layer flags. |
| length | Gets the overall layer length in bytes. |
| opacity | Gets the layer opacity. 0 = transparent, 255 = opaque. |
| top | Gets the top layer position. |
| left | Gets the left layer position. |
| bottom | Gets the bottom layer position. |
| right | Gets the right layer position. |
| height | Gets the height. |
| width | Gets the width. |
| name | Gets the layer name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bits_per_pixel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/bits_per_pixel.md

#### bits_per_pixel property

Gets the bits per pixel value.
##### Definition:
```python
@property
def bits_per_pixel(self):
    ...
```

### bottom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/bottom.md

#### bottom property

Gets the bottom layer position.
##### Definition:
```python
@property
def bottom(self):
    ...
```

### channel_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/channel_count.md

#### channel_count property

Gets the number of channels.
##### Definition:
```python
@property
def channel_count(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/flags.md

#### flags property

Gets the layer flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/height.md

#### height property

Gets the height.
##### Definition:
```python
@property
def height(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/left.md

#### left property

Gets the left layer position.
##### Definition:
```python
@property
def left(self):
    ...
```

### length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/length.md

#### length property

Gets the overall layer length in bytes.
##### Definition:
```python
@property
def length(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/name.md

#### name property

Gets the layer name.
##### Definition:
```python
@property
def name(self):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/opacity.md

#### opacity property

Gets the layer opacity. 0 = transparent, 255 = opaque.
##### Definition:
```python
@property
def opacity(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/right.md

#### right property

Gets the right layer position.
##### Definition:
```python
@property
def right(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### top property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/top.md

#### top property

Gets the top layer position.
##### Definition:
```python
@property
def top(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayer/width.md

#### width property

Gets the width.
##### Definition:
```python
@property
def width(self):
    ...
```

### PsdLayerFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdlayerflags.md

#### PsdLayerFlags enumeration

The Photoshop layer flags.

The PsdLayerFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No flags are set. |
| TRANSPARENCY_PROTECTED | The transparency protected flag. |
| VISIBLE | The visibility flag. |
| OBSOLETE | The obsolete flag. |
| HAS_USEFUL_INFORMATION | Defines if bit 4 has useful information. 1 for Photoshop 5.0 and later, |
| PIXEL_DATA_IRRELEVANT_TO_APPEARANCE_IN_DOCUMENT | The pixel data is irrelevant to appearance in a document. |
| UNDOCUMENTED | An undocumented flag. |

### PsdPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage.md

#### PsdPackage class

Represents native Photoshop metadata.

**Inheritance:** `PsdPackage` →
`CustomPackage` →
`MetadataPackage`

The PsdPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| channel_count | Gets the number of channels. |
| color_mode | Gets the psd color mode. |
| compression | Gets the compression method used for image data. |
| photoshop_version | Gets the Photoshop version. |
| height | Gets the height of the image. |
| width | Gets PSD width of the image. |
| layers | Gets the Photoshop layers. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### channel_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/channel_count.md

#### channel_count property

Gets the number of channels.
##### Definition:
```python
@property
def channel_count(self):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/color_mode.md

#### color_mode property

Gets the psd color mode.
##### Definition:
```python
@property
def color_mode(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/compression.md

#### compression property

Gets the compression method used for image data.
##### Definition:
```python
@property
def compression(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/height.md

#### height property

Gets the height of the image.
##### Definition:
```python
@property
def height(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### layers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/layers.md

#### layers property

Gets the Photoshop layers.
##### Definition:
```python
@property
def layers(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### photoshop_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/photoshop_version.md

#### photoshop_version property

Gets the Photoshop version.
##### Definition:
```python
@property
def photoshop_version(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdpackage/width.md

#### width property

Gets PSD width of the image.
##### Definition:
```python
@property
def width(self):
    ...
```

### PsdRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage.md

#### PsdRootPackage class

Represents the root package allowing working with metadata in a Photoshop Document.

**Inheritance:** `PsdRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The PsdRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |
| iptc_package | Gets or sets the IPTC metadata package. |
| image_resource_package | Gets the Photoshop Image Resource metadata package.
<br/>Image resource blocks are the basic building unit of Photoshop native file format. |
| psd_package | Gets the metadata package containing information about the PSD file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties from a PSD image.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### image_resource_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/image_resource_package.md

#### image_resource_package property

Gets the Photoshop Image Resource metadata package.
Image resource blocks are the basic building unit of Photoshop native file format.

##### Remarks

**Learn more** |
|
 |

##### Example

The code sample below demonstrates how to extract image resource blocks (building blocks of the Photoshop file format) from a PSD image.
##### Definition:
```python
@property
def image_resource_package(self):
    ...
```

### iptc_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/iptc_package.md

#### iptc_package property

Gets or sets the IPTC metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read basic IPTC metadata properties.
##### Definition:
```python
@property
def iptc_package(self):
    ...
@iptc_package.setter
def iptc_package(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### psd_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/psd_package.md

#### psd_package property

Gets the metadata package containing information about the PSD file.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to read the header of a PSD file and extract some information about the PSD layers.
##### Definition:
```python
@property
def psd_package(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/psdrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### RawDoubleTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag.md

#### RawDoubleTag class

Represents a Raw Double tag.

**Inheritance:** `RawDoubleTag` →
`RawTag` →
`MetadataProperty`

The RawDoubleTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawDoubleTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawDoubleTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawDoubleTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawdoubletag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawFloatTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag.md

#### RawFloatTag class

Represents a Raw float tag.

**Inheritance:** `RawFloatTag` →
`RawTag` →
`MetadataProperty`

The RawFloatTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawFloatTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawFloatTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawFloatTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawfloattag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawRational class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational.md

#### RawRational class

Represents a rational number.

The RawRational type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, numerator, denominator)` | Initializes a new instance of the `RawRational` class. |

##### Properties
| Property | Description |
| :- | :- |
| numerator | Gets the numerator. |
| denominator | Gets the denominator. |
| value | Gets the rational value. |

##### Methods
| Method | Description |
| :- | :- |
| `equals(, rational, other)` | Compares a pair of `RawRational` numbers. |
| `equals(self, other)` | Indicates whether the current object is equal to another object of the same type. |

### RawRational constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational/__init__.md

#### \_\_init\_\_(self, numerator, denominator)

Initializes a new instance of the `RawRational` class.

```python

def __init__(self, numerator, denominator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

### denominator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational/denominator.md

#### denominator property

Gets the denominator.
##### Definition:
```python
@property
def denominator(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational/equals.md

#### equals(self, other)

Indicates whether the current object is equal to another object of the same type.

##### Returns

`true` if the current object is equal to the `other` parameter; otherwise, `false`.

```python

def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.formats.image.RawRational | An object to compare with this object. |

#### equals(, rational, other)

Compares a pair of `RawRational` numbers.

##### Returns

`true` if the objects are equal; otherwise, `false`.

```python

@staticmethod
def equals(rational, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rational | groupdocs.metadata.formats.image.RawRational | A rational number. |
| other | groupdocs.metadata.formats.image.RawRational | Another rational number. |

### numerator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational/numerator.md

#### numerator property

Gets the numerator.
##### Definition:
```python
@property
def numerator(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrational/value.md

#### value property

Gets the rational value.
##### Definition:
```python
@property
def value(self):
    ...
```

### RawRationalTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag.md

#### RawRationalTag class

Represents a Raw Rational tag.

**Inheritance:** `RawRationalTag` →
`RawTag` →
`MetadataProperty`

The RawRationalTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawRationalTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawRationalTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawRationalTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawrationaltag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawSByteTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag.md

#### RawSByteTag class

Represents a Raw SByte tag.

**Inheritance:** `RawSByteTag` →
`RawTag` →
`MetadataProperty`

The RawSByteTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawSByteTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawSByteTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawSByteTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsbytetag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawSLongTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag.md

#### RawSLongTag class

Represents a Raw SLong tag.

**Inheritance:** `RawSLongTag` →
`RawTag` →
`MetadataProperty`

The RawSLongTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawSLongTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawSLongTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawSLongTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawslongtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawSRational class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational.md

#### RawSRational class

Represents signed rational number.

The RawSRational type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, numerator, denominator)` | Initializes a new instance of the `RawSRational` class. |

##### Properties
| Property | Description |
| :- | :- |
| numerator | Gets numerator. |
| denominator | Gets denominator. |
| value | Gets actual value represented as double. |

##### Methods
| Method | Description |
| :- | :- |
| `equals(, rational, other)` | Compares pair of `RawSRational`. |
| `equals(self, other)` | Indicates whether the current object is equal to another object of the same type. |

### RawSRational constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational/__init__.md

#### \_\_init\_\_(self, numerator, denominator)

Initializes a new instance of the `RawSRational` class.

```python

def __init__(self, numerator, denominator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

### denominator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational/denominator.md

#### denominator property

Gets denominator.
##### Definition:
```python
@property
def denominator(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational/equals.md

#### equals(self, other)

Indicates whether the current object is equal to another object of the same type.

##### Returns

`true` if the current object is equal to the `other` parameter; otherwise, `false`.

```python

def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.formats.image.RawSRational | An object to compare with this object. |

#### equals(, rational, other)

Compares pair of `RawSRational`.

##### Returns

`true` if objects are equal; otherwise `false`.

```python

@staticmethod
def equals(rational, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rational | groupdocs.metadata.formats.image.RawSRational | Comparing item. |
| other | groupdocs.metadata.formats.image.RawSRational | Other item. |

### numerator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational/numerator.md

#### numerator property

Gets numerator.
##### Definition:
```python
@property
def numerator(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrational/value.md

#### value property

Gets actual value represented as double.
##### Definition:
```python
@property
def value(self):
    ...
```

### RawSRationalTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag.md

#### RawSRationalTag class

Represents a Raw SRational tag.

**Inheritance:** `RawSRationalTag` →
`RawTag` →
`MetadataProperty`

The RawSRationalTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawSRationalTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawSRationalTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawSRationalTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsrationaltag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawSShortTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag.md

#### RawSShortTag class

Represents a Raw SShort tag.

**Inheritance:** `RawSShortTag` →
`RawTag` →
`MetadataProperty`

The RawSShortTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawSShortTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawSShortTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawSShortTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawsshorttag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawTypePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage.md

#### RawTypePackage class

Represents a metadata package containing image-specific file format information.

**Inheritance:** `RawTypePackage` →
`FileTypePackage` →
`CustomPackage` →
`MetadataPackage`

The RawTypePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_format | Gets the file format. |
| mime_type | Gets the MIME type. |
| extension | Gets the file extension. |
| byte_order | Gets the byte-order of the image.
<br/>Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### byte_order property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/byte_order.md

#### byte_order property

Gets the byte-order of the image.
Please see [https://en.wikipedia.org/wiki/Endianness](https://en.wikipedia.org/wiki/Endianness) for more information.
##### Definition:
```python
@property
def byte_order(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/extension.md

#### extension property

Gets the file extension.
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mime_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/mime_type.md

#### mime_type property

Gets the MIME type.
##### Definition:
```python
@property
def mime_type(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawtypepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawUndefinedTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag.md

#### RawUndefinedTag class

Represents a Raw tag with the Undefined type.

**Inheritance:** `RawUndefinedTag` →
`RawTag` →
`MetadataProperty`

The RawUndefinedTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawUndefinedTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawUndefinedTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawUndefinedTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | bytes | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/rawundefinedtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffAsciiTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag.md

#### TiffAsciiTag class

Represents a TIFF ASCII tag.

**Inheritance:** `TiffAsciiTag` →
`TiffTag` →
`MetadataProperty`

The TiffAsciiTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffAsciiTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value | Gets the tag value. |

### TiffAsciiTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffAsciiTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | System.String | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/tag_value.md

#### tag_value property

Gets the tag value.
##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffasciitag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffByteTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag.md

#### TiffByteTag class

Represents a Byte tag.

**Inheritance:** `TiffByteTag` →
`TiffTag` →
`MetadataProperty`

The TiffByteTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffByteTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffByteTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffByteTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | bytes | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffbytetag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffDoubleTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag.md

#### TiffDoubleTag class

Represents a TIFF Double tag.

**Inheritance:** `TiffDoubleTag` →
`TiffTag` →
`MetadataProperty`

The TiffDoubleTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffDoubleTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffDoubleTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffDoubleTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffdoubletag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffFloatTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag.md

#### TiffFloatTag class

Represents a TIFF float tag.

**Inheritance:** `TiffFloatTag` →
`TiffTag` →
`MetadataProperty`

The TiffFloatTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffFloatTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffFloatTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffFloatTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifffloattag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffLongTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag.md

#### TiffLongTag class

Represents a TIFF Long tag.

**Inheritance:** `TiffLongTag` →
`TiffTag` →
`MetadataProperty`

The TiffLongTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffLongTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffLongTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffLongTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifflongtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffRational class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational.md

#### TiffRational class

Represents a rational number.

The TiffRational type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, numerator, denominator)` | Initializes a new instance of the `TiffRational` class. |

##### Properties
| Property | Description |
| :- | :- |
| numerator | Gets the numerator. |
| denominator | Gets the denominator. |
| value | Gets the rational value. |

##### Methods
| Method | Description |
| :- | :- |
| `equals(, rational, other)` | Compares a pair of `TiffRational` numbers. |
| `equals(self, other)` | Indicates whether the current object is equal to another object of the same type. |

### TiffRational constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational/__init__.md

#### \_\_init\_\_(self, numerator, denominator)

Initializes a new instance of the `TiffRational` class.

```python

def __init__(self, numerator, denominator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

### denominator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational/denominator.md

#### denominator property

Gets the denominator.
##### Definition:
```python
@property
def denominator(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational/equals.md

#### equals(self, other)

Indicates whether the current object is equal to another object of the same type.

##### Returns

`true` if the current object is equal to the `other` parameter; otherwise, `false`.

```python

def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.formats.image.TiffRational | An object to compare with this object. |

#### equals(, rational, other)

Compares a pair of `TiffRational` numbers.

##### Returns

`true` if the objects are equal; otherwise, `false`.

```python

@staticmethod
def equals(rational, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rational | groupdocs.metadata.formats.image.TiffRational | A rational number. |
| other | groupdocs.metadata.formats.image.TiffRational | Another rational number. |

### numerator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational/numerator.md

#### numerator property

Gets the numerator.
##### Definition:
```python
@property
def numerator(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrational/value.md

#### value property

Gets the rational value.
##### Definition:
```python
@property
def value(self):
    ...
```

### TiffRationalTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag.md

#### TiffRationalTag class

Represents a TIFF Rational tag.

**Inheritance:** `TiffRationalTag` →
`TiffTag` →
`MetadataProperty`

The TiffRationalTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffRationalTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffRationalTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffRationalTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrationaltag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage.md

#### TiffRootPackage class

Represents the root package allowing working with metadata in a TIFF image.

**Inheritance:** `TiffRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The TiffRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |
| iptc_package | Gets or sets the IPTC metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### iptc_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/iptc_package.md

#### iptc_package property

Gets or sets the IPTC metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to extract basic IPTC metadata properties from a TIFF image.
##### Definition:
```python
@property
def iptc_package(self):
    ...
@iptc_package.setter
def iptc_package(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### TiffSByteTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag.md

#### TiffSByteTag class

Represents a TIFF SByte tag.

**Inheritance:** `TiffSByteTag` →
`TiffTag` →
`MetadataProperty`

The TiffSByteTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffSByteTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffSByteTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffSByteTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsbytetag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffShortTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag.md

#### TiffShortTag class

Represents a TIFF Short tag.

**Inheritance:** `TiffShortTag` →
`TiffTag` →
`MetadataProperty`

The TiffShortTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffShortTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffShortTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffShortTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffshorttag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffSLongTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag.md

#### TiffSLongTag class

Represents a TIFF SLong tag.

**Inheritance:** `TiffSLongTag` →
`TiffTag` →
`MetadataProperty`

The TiffSLongTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffSLongTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffSLongTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffSLongTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffslongtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffSRational class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational.md

#### TiffSRational class

Represents signed rational number.

The TiffSRational type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, numerator, denominator)` | Initializes a new instance of the `TiffSRational` class. |

##### Properties
| Property | Description |
| :- | :- |
| numerator | Gets numerator. |
| denominator | Gets denominator. |
| value | Gets actual value represented as double. |

##### Methods
| Method | Description |
| :- | :- |
| `equals(, rational, other)` | Compares pair of `TiffSRational`. |
| `equals(self, other)` | Indicates whether the current object is equal to another object of the same type. |

### TiffSRational constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational/__init__.md

#### \_\_init\_\_(self, numerator, denominator)

Initializes a new instance of the `TiffSRational` class.

```python

def __init__(self, numerator, denominator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

### denominator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational/denominator.md

#### denominator property

Gets denominator.
##### Definition:
```python
@property
def denominator(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational/equals.md

#### equals(self, other)

Indicates whether the current object is equal to another object of the same type.

##### Returns

`true` if the current object is equal to the `other` parameter; otherwise, `false`.

```python

def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.formats.image.TiffSRational | An object to compare with this object. |

#### equals(, rational, other)

Compares pair of `TiffSRational`.

##### Returns

`true` if objects are equal; otherwise `false`.

```python

@staticmethod
def equals(rational, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rational | groupdocs.metadata.formats.image.TiffSRational | Comparing item. |
| other | groupdocs.metadata.formats.image.TiffSRational | Other item. |

### numerator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational/numerator.md

#### numerator property

Gets numerator.
##### Definition:
```python
@property
def numerator(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrational/value.md

#### value property

Gets actual value represented as double.
##### Definition:
```python
@property
def value(self):
    ...
```

### TiffSRationalTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag.md

#### TiffSRationalTag class

Represents a TIFF SRational tag.

**Inheritance:** `TiffSRationalTag` →
`TiffTag` →
`MetadataProperty`

The TiffSRationalTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffSRationalTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffSRationalTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffSRationalTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsrationaltag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffSShortTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag.md

#### TiffSShortTag class

Represents a TIFF SShort tag.

**Inheritance:** `TiffSShortTag` →
`TiffTag` →
`MetadataProperty`

The TiffSShortTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffSShortTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffSShortTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffSShortTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffsshorttag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag.md

#### TiffTag class

Represents a TIFF tag.

**Inheritance:** `TiffTag` →
`MetadataProperty`

The TiffTag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TiffTagID enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftagid.md

#### TiffTagID enumeration

Defines ids of TIFF tags.

The TiffTagID type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GPS_VERSION_ID | Indicates the version of GPSInfoIFD. |
| GPS_LATITUDE_REF | Indicates whether the latitude is north or south latitude. |
| GPS_LATITUDE | Indicates the latitude. |
| GPS_LONGITUDE_REF | Indicates whether the longitude is east or west longitude. |
| GPS_LONGITUDE | Indicates the longitude. |
| GPS_ALTITUDE_REF | Indicates the altitude used as the reference altitude. |
| GPS_ALTITUDE | Indicates the altitude based on the reference in GPSAltitudeRef. |
| GPS_TIME_STAMP | Indicates the time as UTC (Coordinated Universal Time). |
| GPS_SATELLITES | ndicates the GPS satellites used for measurements. |
| GPS_STATUS | Indicates the status of the GPS receiver when the image is recorded. |
| GPS_MEASURE_MODE | Indicates the GPS measurement mode. |
| GPS_DOP | Indicates the GPS DOP (data degree of precision). |
| GPS_SPEED_REF | Indicates the unit used to express the GPS receiver speed of movement |
| GPS_SPEED | Indicates the speed of GPS receiver movement. |
| GPS_TRACK_REF | Indicates the reference for giving the direction of GPS receiver movement. |
| GPS_TRACK | Indicates the direction of GPS receiver movement. |
| GPS_IMG_DIRECTION_REF | Indicates the reference for giving the direction of the image when it is captured. |
| GPS_IMG_DIRECTION | Indicates the direction of the image when it was captured. |
| GPS_MAP_DATUM | Indicates the geodetic survey data used by the GPS receiver. |
| GPS_DEST_LATITUDE_REF | Indicates whether the latitude of the destination point is north or south latitude. |
| GPS_DEST_LATITUDE | Indicates the latitude of the destination point. |
| GPS_DEST_LONGITUDE_REF | Indicates whether the longitude of the destination point is east or west longitude. |
| GPS_DEST_LONGITUDE | Indicates the longitude of the destination point. |
| GPS_DEST_BEARING_REF | Indicates the reference used for giving the bearing to the destination point. |
| GPS_DEST_BEARING | Indicates the bearing to the destination point. |
| GPS_DEST_DISTANCE_REF | Indicates the unit used to express the distance to the destination point. |
| GPS_DEST_DISTANCE | Indicates the distance to the destination point. |
| GPS_PROCESSING_METHOD | A character string recording the name of the method used for location finding. |
| GPS_AREA_INFORMATION | A character string recording the name of the GPS area. |
| GPS_DATE_STAMP | A character string recording date and time information relative to UTC (Coordinated Universal Time). |
| GPS_DIFFERENTIAL | Indicates whether differential correction is applied to the GPS receiver. |
| GPS_H_POSITIONING_ERROR | This tag indicates horizontal positioning errors in meters. |
| NEW_SUBFILE_TYPE | A general indication of the kind of data contained in this sub-file. |
| SUBFILE_TYPE | A general indication of the kind of data contained in this subfile.
<br/>This field is deprecated. The NewSubfileType field should be used instead |
| IMAGE_WIDTH | The number of columns in the image, i.e., the number of pixels per scan line. |
| IMAGE_LENGTH | The number of rows (sometimes described as scan lines) in the image. |
| BITS_PER_SAMPLE | Number of bits per component. |
| COMPRESSION | Compression scheme used on the image data. |
| PHOTOMETRIC_INTERPRETATION | The color space of the image data. |
| THRESHHOLDING | For black and white TIFF files that represent shades of gray, the technique used to convert from gray to black and white pixels. |
| CELL_WIDTH | The width of the dithering or halftoning matrix used to create a dithered or
<br/>halftoned bi-level file. |
| CELL_LENGTH | The length of the dithering or halftoning matrix used to create a dithered or
<br/>halftoned bi-level file. |
| FILL_ORDER | The logical order of bits within a byte. |
| DOCUMENT_NAME | The name of the document from which this image was scanned. |
| IMAGE_DESCRIPTION | A string that describes the subject of the image. |
| MAKE | The scanner manufacturer. |
| MODEL | The scanner model name or number. |
| STRIP_OFFSETS | For each strip, the byte offset of that strip. |
| ORIENTATION | The orientation of the image with respect to the rows and columns. |
| SAMPLES_PER_PIXEL | The number of components per pixel. |
| ROWS_PER_STRIP | The number of rows per strip. |
| STRIP_BYTE_COUNTS | For each strip, the number of bytes in the strip after compression. |
| MIN_SAMPLE_VALUE | The minimum component value used. |
| MAX_SAMPLE_VALUE | The maximum component value used. |
| X_RESOLUTION | The number of pixels per ResolutionUnit in the ImageWidth direction. |
| Y_RESOLUTION | The number of pixels per ResolutionUnit in the ImageLength direction. |
| PLANAR_CONFIGURATION | How the components of each pixel are stored. |
| PAGE_NAME | The name of the page from which this image was scanned. |
| X_POSITION | X position of the image. |
| Y_POSITION | Y position of the image. |
| FREE_OFFSETS | For each string of contiguous unused bytes in a TIFF file, the byte offset of the string. |
| FREE_BYTE_COUNTS | For each string of contiguous unused bytes in a TIFF file, the number of bytes in the string. |
| GRAY_RESPONSE_UNIT | The precision of the information contained in the GrayResponseCurve. |
| GRAY_RESPONSE_CURVE | For grayscale data, the optical density of each possible pixel value. |
| T4_OPTIONS | T4-encoding options. |
| T6_OPTIONS | T6-encoding options. |
| RESOLUTION_UNIT | The unit of measurement for XResolution and YResolution. |
| PAGE_NUMBER | The page number of the page from which this image was scanned. |
| TRANSFER_FUNCTION | Describes a transfer function for the image in tabular style. Pixel components can
<br/>be gamma-compensated, companded, non-uniformly quantized, or coded in some
<br/>other way. The TransferFunction maps the pixel components from a non-linear
<br/>BitsPerSample (e.g. 8-bit) form into a 16-bit linear form without a perceptible loss
<br/>of accuracy. |
| SOFTWARE | Name and version number of the software package(s) used to create the image. |
| DATE_TIME | Date and time of image creation. |
| ARTIST | Person who created the image. |
| HOST_COMPUTER | The computer and/or operating system in use at the time of image creation. |
| PREDICTOR | This section defines a Predictor that greatly improves compression ratios for some images. |
| WHITE_POINT | The chromaticity of the white point of the image. |
| PRIMARY_CHROMATICITIES | The chromaticities of the primaries of the image. |
| COLOR_MAP | A color map for palette color images. |
| HALFTONE_HINTS | The purpose of the HalftoneHints field is to convey to the halftone function the
<br/>range of gray levels within a colorimetrically-specified image that should retain
<br/>tonal detail. |
| TILE_WIDTH | The tile width in pixels. This is the number of columns in each tile. |
| TILE_LENGTH | The tile length (height) in pixels. This is the number of rows in each tile. |
| TILE_OFFSETS | For each tile, the byte offset of that tile, as compressed and stored on disk.
<br/>The offset is specified with respect to the beginning of the TIFF file.
<br/>Note that this implies that each tile has a location independent of the locations of other tiles. |
| TILE_BYTE_COUNTS | For each tile, the number of (compressed) bytes in that tile. |
| INK_SET | The set of inks used in a separated (PhotometricInterpretation=5) image. |
| INK_NAMES | The name of each ink used in a separated (PhotometricInterpretation=5) image,
<br/>written as a list of concatenated, NUL-terminated ASCII strings. |
| NUMBER_OF_INKS | The number of inks. Usually equal to SamplesPerPixel, unless there are extra samples. |
| DOT_RANGE | The component values that correspond to a 0% dot and 100% dot. DotRange[0]
<br/>corresponds to a 0% dot, and DotRange[1] corresponds to a 100% dot. |
| EXTRA_SAMPLES | Description of extra components. |
| SAMPLE_FORMAT | This field specifies how to interpret each data sample in a pixel. |
| S_MIN_SAMPLE_VALUE | This field specifies the minimum sample value. |
| S_MAX_SAMPLE_VALUE | This new field specifies the maximum sample value. |
| TRANSFER_RANGE | Expands the range of the TransferFunction. |
| JPEG_PROC | This Field indicates the JPEG process used to produce the compressed data. |
| JPEG_INTERCHANGE_FORMAT | This Field indicates whether a JPEG interchange format bitstream is present in the TIFF file. |
| JPEG_INTERCHANGE_FORMAT_LENGTH | This Field indicates the length in bytes of the JPEG interchange format bitstream |
| JPEG_RESTART_INTERVAL | This Field indicates the length of the restart interval used in the compressed image data. |
| JPEG_LOSSLESS_PREDICTORS | This Field points to a list of lossless predictor-selection values, one per component. |
| JPEG_POINT_TRANSFORMS | This Field points to a list of point transform values, one per component. |
| JPEG_Q_TABLES | This Field points to a list of offsets to the quantization tables, one per component. |
| JPEG_DC_TABLES | This Field points to a list of offsets to the DC Huffman tables or the lossless
<br/>Huffman tables, one per component. |
| JPEG_AC_TABLES | This Field points to a list of offsets to the Huffman AC tables, one per component. |
| Y_CB_CR_COEFFICIENTS | The matrix cofficients for transformation from RGB to YCbCr image data. |
| Y_CB_CR_SUB_SAMPLING | The sampling ratio of chrominance components in relation to the luminance component. |
| Y_CB_CR_POSITIONING | Specifies the positioning of subsampled chrominance components relative to luminance samples. |
| REFERENCE_BLACK_WHITE | Specifies a pair of headroom and footroom image data values (codes) for each pixel component. |
| COPYRIGHT | Copyright notice. |
| USER_COMMENT | Keywords or comments on the image; complements ImageDescription. |
| XMP | Pointer to the XMP metadata. |
| IMAGE_ID | OPI-related. |
| IPTC | IPTC (International Press Telecommunications Council) metadata.
<br/>Often times, the data type is incorrectly specified as LONG. |
| PHOTOSHOP | Collection of Photoshop 'Image Resource Blocks'. |
| IMAGE_LAYER | Image layer. |
| ICC_PROFILE | Color profile data. |
| EXIF_IFD | Pointer to collection of all EXIF Metadata.
<br/>EXIF uses field names rather than tags to indicate the field content. |
| GPS_IFD | Pointer to GPS data. |
| MAKERNOTES | Pointer to makernotes data. |
| INTEROPERABILITY_IFD | Exif-related Interoperability IFD. |
| CAMERA_OWNER_NAME | Camera owner name as ASCII string. |
| BODY_SERIAL_NUMBER | Camera body serial number as ASCII string. |
| CFA_PATTERN | ndicates the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. It does not apply to all sensing methods. |
| EXIF_VERSION | The version of the EXIF standard supported. |
| COMPONENTS_CONFIGURATION | Information specific to the compressed data. The channels of each component are arranged in order from the 1st component to the 4th. |
| FLASHPIX_VERSION | The Flashpix format version supported by a FPXR file. If the FPXR function supports Flashpix format Ver. 1.0, this is indicated similarly to ExifVersion by recording "0100" as 4-byte ASCII. |
| COLOR_SPACE | The color space information tag (ColorSpace) is always recorded as the color space specifier.
<br/>Normally sRGB (=1) is used to define the color space based on the PC monitor conditions and environment.
<br/>If a color space other than sRGB is used, Uncalibrated (=FFFF.H) is set. |
| PIXEL_X_DIMENSION | Information specific to compressed data. When a compressed file is recorded,
<br/>the valid width of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker. |
| PIXEL_Y_DIMENSION | Information specific to compressed data. When a compressed file is recorded,
<br/>the valid height of the meaningful image shall be recorded in this tag, whether or not there is padding data or a restart marker. |
| SCENE_CAPTURE_TYPE | This tag indicates the type of scene that was shot. It may also be used to record the mode in which the image was shot. |
| GAMMA | Indicates the value of coefficient gamma. |
| COMPRESSED_BITS_PER_PIXEL | Information specific to compressed data. The compression mode used for a compressed image is indicated in unit bits per pixel. |
| RELATED_SOUND_FILE | This tag is used to record the name of an audio file related to the image data.
<br/>The only relational information recorded here is the Exif audio file name and extension
<br/>(an ASCII string consisting of 8 characters + '.' + 3 characters). |
| DATE_TIME_ORIGINAL | The date and time when the original image data was generated.
<br/>For a DSC the date and time the picture was taken are recorded.
<br/>The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character. |
| DATE_TIME_DIGITIZED | The date and time when the image was stored as digital data.
<br/>If, for example, an image was captured by DSC and at the same time the file was recorded, then the DateTimeOriginal and DateTimeDigitized will have the same contents.
<br/>The format is "YYYY:MM:DD HH:MM:SS" with time shown in 24-hour format, and the date and time separated by one blank character. |
| OFFSET_TIME | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTime tag.
<br/>The format when recording the offset is "±HH:MM".
<br/>The part of "±" shall be recorded as "+" or "-". |
| OFFSET_TIME_ORIGINAL | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeOriginal tag.
<br/>The format when recording the offset is "±HH:MM".
<br/>The part of "±" shall be recorded as "+" or "-". |
| OFFSET_TIME_DIGITIZED | A tag used to record the offset from UTC (the time difference from Universal Time Coordinated including daylight saving time) of the time of DateTimeDigitized tag.
<br/>The format when recording the offset is "±HH:MM".
<br/>The part of "±" shall be recorded as "+" or "-". |
| SUBSEC_TIME | A tag used to record fractions of seconds for the DateTime tag. |
| SUBSEC_TIME_ORIGINAL | A tag used to record fractions of seconds for the DateTimeOriginal tag. |
| SUBSEC_TIME_DIGITIZED | A tag used to record fractions of seconds for the DateTimeDigitized tag. |
| EXPOSURE_TIME | Exposure time, given in seconds (sec). |
| F_NUMBER | The F number. |
| EXPOSURE_PROGRAM | The class of the program used by the camera to set exposure when the picture is taken. |
| SPECTRAL_SENSITIVITY | Indicates the spectral sensitivity of each channel of the camera used.
<br/>The tag value is an ASCII string compatible with the standard developed by the ASTM Technical committee. |
| PHOTOGRAPHIC_SENSITIVITY | This tag indicates the sensitivity of the camera or input device when the image was shot. |
| OECF | Indicates the Opto-Electric Conversion Function (OECF) specified in ISO 14524.
<br/>OECF is the relationship between the camera optical input and the image values. |
| SENSITIVITY_TYPE | The SensitivityType tag indicates which one of the parameters of ISO12232 is the PhotographicSensitivity tag.
<br/>Although it is an optional tag, it should be recorded when a PhotographicSensitivity tag is recorded. |
| STANDARD_OUTPUT_SENSITIVITY | This tag indicates the standard output sensitivity value of a camera or input device defined in ISO 12232.
<br/>When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| RECOMMENDED_EXPOSURE_INDEX | This tag indicates the recommended exposure index value of a camera or input device defined in ISO 12232.
<br/>When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| ISO_SPEED | This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232.
<br/>When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded. |
| ISO_SPEED_LATITUDE_YYY | This tag indicates the ISO speed latitude yyy value of a camera or input device that is defined in ISO 12232. |
| ISO_SPEED_LATITUDE_ZZZ | This tag indicates the ISO speed latitude zzz value of a camera or input device that is defined in ISO 12232. |
| SHUTTER_SPEED_VALUE | Shutter speed. The unit is the APEX (Additive System of Photographic Exposure) setting. |
| APERTURE_VALUE | The lens aperture. The unit is the APEX value. |
| BRIGHTNESS_VALUE | The value of brightness. The unit is the APEX value. |
| EXPOSURE_BIAS_VALUE | The exposure bias. The unit is the APEX value. |
| MAX_APERTURE_VALUE | The smallest F number of the lens. The unit is the APEX value. |
| SUBJECT_DISTANCE | The distance to the subject, given in meters. |
| METERING_MODE | The metering mode. |
| LIGHT_SOURCE | The kind of light source. |
| FLASH | This tag indicates the status of flash when the image was shot.
<br/>Bit 0 indicates the flash firing status, bits 1 and 2 indicate the flash return status,
<br/>bits 3 and 4 indicate the flash mode, bit 5 indicates whether the flash function is present, and bit 6 indicates "red eye" mode. |
| SUBJECT_AREA | This tag indicates the location and area of the main subject in the overall scene. |
| FOCAL_LENGTH | The actual focal length of the lens, in mm. Conversion is not made to the focal length of a 35 mm film camera. |
| FLASH_ENERGY | Indicates the strobe energy at the time the image is captured, as measured in Beam Candle Power Seconds (BCPS). |
| SPATIAL_FREQUENCY_RESPONSE | This tag records the camera or input device spatial frequency table and SFR values in the direction of image width,
<br/>image height, and diagonal direction, as specified in ISO 12233. |
| FOCAL_PLANE_X_RESOLUTION | Indicates the number of pixels in the image width (X) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FOCAL_PLANE_Y_RESOLUTION | Indicates the number of pixels in the image height (Y) direction per FocalPlaneResolutionUnit on the camera focal plane. |
| FOCAL_PLANE_RESOLUTION_UNIT | Indicates the unit for measuring FocalPlaneXResolution and FocalPlaneYResolution. This value is the same as the ResolutionUnit. |
| SUBJECT_LOCATION | Indicates the location of the main subject in the scene.
<br/>The value of this tag represents the pixel at the center of the main subject relative to the left edge, prior to rotation processing as per the Rotation tag.
<br/>The first value indicates the X column number and second indicates the Y row number. |
| EXPOSURE_INDEX | Indicates the exposure index selected on the camera or input device at the time the image is captured. |
| SENSING_METHOD | Indicates the image sensor type on the camera or input device. |
| FILE_SOURCE | Indicates the image source. If a DSC recorded the image, this tag value always shall be set to 3. |
| SCENE_TYPE | Indicates the type of scene. If a DSC recorded the image, this tag value shall always be set to 1, indicating that the image was directly photographed. |
| CUSTOM_RENDERED | This tag indicates the use of special processing on image data, such as rendering geared to output. |
| EXPOSURE_MODE | This tag indicates the exposure mode set when the image was shot. In auto-bracketing mode,
<br/>the camera shoots a series of frames of the same scene at different exposure settings. |
| WHITE_BALANCE | This tag indicates the white balance mode set when the image was shot. |
| DIGITAL_ZOOM_RATIO | This tag indicates the digital zoom ratio when the image was shot.
<br/>If the numerator of the recorded value is 0, this indicates that digital zoom was not used. |
| FOCAL_LENGTH_IN_35MM_FILM | This tag indicates the equivalent focal length assuming a 35mm film camera, in mm.
<br/>A value of 0 means the focal length is unknown. Note that this tag differs from the FocalLength tag. |
| GAIN_CONTROL | This tag indicates the degree of overall image gain adjustment. |
| CONTRAST | This tag indicates the direction of contrast processing applied by the camera when the image was shot. |
| SATURATION | This tag indicates the direction of saturation processing applied by the camera when the image was shot. |
| SHARPNESS | This tag indicates the direction of sharpness processing applied by the camera when the image was shot. |
| DEVICE_SETTING_DESCRIPTION | This tag indicates information on the picture-taking conditions of a particular camera model. |
| SUBJECT_DISTANCE_RANGE | This tag indicates the distance to the subject. |
| COMPOSITE_IMAGE | This tag indicates whether the recorded image is a composite image* or not. |
| SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE | This tag indicates the number of the source images (tentatively recorded images) captured for a composite Image. |
| SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE | For a composite image, this tag records the parameters relating exposure time of the exposures for generating the said composite image,
<br/>such as respective exposure times of captured source images (tentatively recorded images). |
| TEMPERATURE | Temperature as the ambient situation at the shot, for example the room temperature where the photographer was holding the camera. The unit is °C. |
| HUMIDITY | Humidity as the ambient situation at the shot, for example the room humidity where the photographer was holding the camera. The unit is %. |
| PRESSURE | Pressure as the ambient situation at the shot,
<br/>for example the room atmospfere where the photographer was holding the camera or the water pressure under the sea.
<br/>The unit is hPa. |
| WATER_DEPTH | Water depth as the ambient situation at the shot, for example the water depth of the camera at underwater photography. The unit is m. |
| ACCELERATION | Acceleration (a scalar regardless of direction) as the ambient situation at the shot, for example the driving acceleration of the vehicle which the photographer rode on at the shot.
<br/>The unit is mGal (10-5 m/s2). |
| CAMERA_ELEVATION_ANGLE | Elevation/depression. angle of the orientation of the camera(imaging optical axis) as the ambient situation at the shot. The unit is degree(°). |
| IMAGE_UNIQUE_ID | This tag indicates an identifier assigned uniquely to each image. |
| LENS_SPECIFICATION | This tag notes minimum focal length, maximum focal length, minimum F number in the minimum focal length,
<br/>and minimum F number in the maximum focal length, which are specification information for the lens that was used in photography. |
| LENS_MAKE | This tag records the lens manufacturer as an ASCII string. |
| LENS_MODEL | This tag records the lens’s model name and model number as an ASCII string. |
| LENS_SERIAL_NUMBER | This tag records the serial number of the interchangeable lens that was used in photography as an ASCII string. |

### TiffTagType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tifftagtype.md

#### TiffTagType enumeration

Represents the IFD data type.

The TiffTagType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BYTE | An 8-bit unsigned integer. |
| ASCII | An 8-bit byte with a 7-bit ASCII character. |
| SHORT | A 16-bit unsigned integer. |
| LONG | A 32-bit unsigned integer. |
| RATIONAL | A pair of LONGs, numerator then denominator. |
| S_BYTE | An 8-bit signed integer. |
| UNDEFINED | An undefined 8-bit byte. |
| S_SHORT | A 16-bit signed integer. |
| S_LONG | A 32-bit signed integer. |
| S_RATIONAL | A pair of SLONGs, numerator then denominator. |
| FLOAT | A 4-byte IEEE floating point value. |
| DOUBLE | An 8-byte IEEE floating point value. |
| SUB_IFD | A 4-byte long offset value |

### TiffUndefinedTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag.md

#### TiffUndefinedTag class

Represents a TIFF tag with the Undefined type.

**Inheritance:** `TiffUndefinedTag` →
`TiffTag` →
`MetadataProperty`

The TiffUndefinedTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffUndefinedTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### TiffUndefinedTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffUndefinedTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | The tag identifier. |
| value | bytes | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/tiffundefinedtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### WebPRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage.md

#### WebPRootPackage class

Represents the root package allowing working with metadata in a WEBP image.

**Inheritance:** `WebPRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The WebPRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| exif_package | Gets or sets the EXIF metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/webprootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### WmfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage.md

#### WmfRootPackage class

Represents the root package intended to work with metadata in a WMF image.

**Inheritance:** `WmfRootPackage` →
`ImageRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The WmfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.

##### Example

This code sample demonstrates how to extract common image properties such as width and height, MIME type, byte order, etc.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.image/wmfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.mpeg
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg.md

The namespace provides functionality allowing users to work with metadata of various MPEG standards.

##### Classes
| Class | Description |
| :- | :- |
| `MpegAudioPackage` | Represents MPEG audio metadata. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `MpegAudioVersion` | Represents a particular MPEG standard. |
| `MpegChannelMode` | Defines MPEG audio channel modes. |
| `MpegEmphasis` | Defines MPEG emphasis types. |

### MpegAudioPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage.md

#### MpegAudioPackage class

Represents MPEG audio metadata.

**Inheritance:** `MpegAudioPackage` →
`CustomPackage` →
`MetadataPackage`

The MpegAudioPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `MpegAudioPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| mpeg_audio_version | Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc. |
| layer | Gets the layer description. For an MP3 audio it is '3'. |
| is_protected | Gets `true` if protected. |
| header_position | Gets the header offset. |
| bitrate | Gets the bitrate. |
| frequency | Gets the frequency. |
| padding_bit | Gets the padding bit. |
| private_bit | Gets a value indicating whether [private bit]. |
| channel_mode | Gets the channel mode. |
| copyright | Gets the copyright bit. |
| is_original | Gets the original bit. |
| emphasis | Gets the emphasis. |
| mode_extension_bits | Gets the mode extension bits. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Example

This example demonstrates how to read MPEG audio metadata from an MP3 file.

### MpegAudioPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `MpegAudioPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/bitrate.md

#### bitrate property

Gets the bitrate.
##### Definition:
```python
@property
def bitrate(self):
    ...
```

### channel_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/channel_mode.md

#### channel_mode property

Gets the channel mode.
##### Definition:
```python
@property
def channel_mode(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/copyright.md

#### copyright property

Gets the copyright bit.
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### emphasis property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/emphasis.md

#### emphasis property

Gets the emphasis.
##### Definition:
```python
@property
def emphasis(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### frequency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/frequency.md

#### frequency property

Gets the frequency.
##### Definition:
```python
@property
def frequency(self):
    ...
```

### header_position property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/header_position.md

#### header_position property

Gets the header offset.
##### Definition:
```python
@property
def header_position(self):
    ...
```

### is_original property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/is_original.md

#### is_original property

Gets the original bit.
##### Definition:
```python
@property
def is_original(self):
    ...
```

### is_protected property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/is_protected.md

#### is_protected property

Gets `true` if protected.
##### Definition:
```python
@property
def is_protected(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### layer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/layer.md

#### layer property

Gets the layer description. For an MP3 audio it is '3'.
##### Definition:
```python
@property
def layer(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mode_extension_bits property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/mode_extension_bits.md

#### mode_extension_bits property

Gets the mode extension bits.
##### Definition:
```python
@property
def mode_extension_bits(self):
    ...
```

### mpeg_audio_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/mpeg_audio_version.md

#### mpeg_audio_version property

Gets the MPEG audio version. Can be MPEG-1, MPEG-2 etc.
##### Definition:
```python
@property
def mpeg_audio_version(self):
    ...
```

### padding_bit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/padding_bit.md

#### padding_bit property

Gets the padding bit.
##### Definition:
```python
@property
def padding_bit(self):
    ...
```

### private_bit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/private_bit.md

#### private_bit property

Gets a value indicating whether [private bit].
##### Definition:
```python
@property
def private_bit(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudiopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MpegAudioVersion enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegaudioversion.md

#### MpegAudioVersion enumeration

Represents a particular MPEG standard.

The MpegAudioVersion type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MPEG25 | The MPEG 2.5 standard. |
| MPEG2 | The MPEG 2 standard. |
| MPEG1 | The MPEG 1 standard. |

### MpegChannelMode enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegchannelmode.md

#### MpegChannelMode enumeration

Defines MPEG audio channel modes.

The MpegChannelMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| STEREO | Stereo mode. |
| JOINT_STEREO | Joint stereo mode. |
| DUAL_CHANNEL | Dual channel mode. |
| MONO | Mono mode. |

### MpegEmphasis enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.mpeg/mpegemphasis.md

#### MpegEmphasis enumeration

Defines MPEG emphasis types.

The MpegEmphasis type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No emphasis indication. |
| MS5015 | 50/15 ms. |
| RESERVED | Reserved. |
| CCIT_J17 | CCIT J.17. |

### groupdocs.metadata.formats.peer2peer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer.md

The namespace contains classes intended to work with different formats based on the peer2peer protocol.

##### Classes
| Class | Description |
| :- | :- |
| `TorrentPackage` | Represents torrent descriptor file metadata.
<br/>Please find more information at [https://en.wikipedia.org/wiki/Torrent_file](https://en.wikipedia.org/wiki/Torrent_file). |
| `TorrentRootPackage` | Represents the root package intended to work with metadata of a TORRENT file. |
| `TorrentSharedFilePackage` | Represents shared file information.
<br/>Contains detailed info about each file in a torrent distribution. |

### TorrentPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage.md

#### TorrentPackage class

Represents torrent descriptor file metadata.
Please find more information at [https://en.wikipedia.org/wiki/Torrent_file](https://en.wikipedia.org/wiki/Torrent_file).

**Inheritance:** `TorrentPackage` →
`CustomPackage` →
`MetadataPackage`

The TorrentPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| announce | Gets or sets the URL of the tracker. |
| comment | Gets or sets the author's comment. |
| creation_date | Gets or sets the creation date of the torrent. |
| created_by | Gets or sets the name and version of the program used to create the torrent. |
| shared_files | Gets an array containing shared file information entries. |
| piece_length | Gets the number of bytes in each piece. For more information please see `TorrentPackage.pieces`. |
| pieces | Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### announce property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/announce.md

#### announce property

Gets or sets the URL of the tracker.
##### Definition:
```python
@property
def announce(self):
    ...
@announce.setter
def announce(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/comment.md

#### comment property

Gets or sets the author's comment.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### created_by property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/created_by.md

#### created_by property

Gets or sets the name and version of the program used to create the torrent.
##### Definition:
```python
@property
def created_by(self):
    ...
@created_by.setter
def created_by(self, value):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/creation_date.md

#### creation_date property

Gets or sets the creation date of the torrent.
##### Definition:
```python
@property
def creation_date(self):
    ...
@creation_date.setter
def creation_date(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### piece_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/piece_length.md

#### piece_length property

Gets the number of bytes in each piece. For more information please see `TorrentPackage.pieces`.
##### Definition:
```python
@property
def piece_length(self):
    ...
```

### pieces property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/pieces.md

#### pieces property

Gets a byte array consisting of the concatenation of all 20-byte SHA1 hash values, one per piece.
##### Definition:
```python
@property
def pieces(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shared_files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/shared_files.md

#### shared_files property

Gets an array containing shared file information entries.
##### Definition:
```python
@property
def shared_files(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### TorrentRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage.md

#### TorrentRootPackage class

Represents the root package intended to work with metadata of a TORRENT file.

**Inheritance:** `TorrentRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The TorrentRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| torrent_package | Gets the TORRENT file metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to read metadata of a TORRENT file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### torrent_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/torrent_package.md

#### torrent_package property

Gets the TORRENT file metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to update metadata in a TORRENT file.
##### Definition:
```python
@property
def torrent_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### TorrentSharedFilePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage.md

#### TorrentSharedFilePackage class

Represents shared file information.
Contains detailed info about each file in a torrent distribution.

**Inheritance:** `TorrentSharedFilePackage` →
`CustomPackage` →
`MetadataPackage`

The TorrentSharedFilePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the full name of the file (relative path to the file from the root torrent folder). |
| length | Gets the length of the file in bytes. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/length.md

#### length property

Gets the length of the file in bytes.
##### Definition:
```python
@property
def length(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/name.md

#### name property

Gets the full name of the file (relative path to the file from the root torrent folder).
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.peer2peer/torrentsharedfilepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.raw.cr2
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2.md

##### Classes
| Class | Description |
| :- | :- |
| `Cr2AFConfigPackage` | Represents Canon MakerNotes tags. |
| `Cr2AFInfo2Package` | Represents Canon MakerNotes tags. |
| `Cr2AFInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2AFMicroAdjPackage` | Represents Canon MakerNotes tags. |
| `Cr2AspectInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2CameraSettingsPackage` | Represents Canon MakerNotes tags. |
| `Cr2ColorBalancePackage` | Represents Canon MakerNotes tags. |
| `Cr2ColorInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2CropInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2FileInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2FocalLengthPackage` | Represents Canon MakerNotes tags. |
| `Cr2Functions1DPackage` | Represents Canon MakerNotes tags. |
| `Cr2LightingOptPackage` | Represents Canon MakerNotes tags. |
| `Cr2LogInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2MakerNotePackage` | Represents Canon MakerNotes tags. |
| `Cr2ModifiedInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2MovieInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2MultiExpPackage` | Represents Canon MakerNotes tags. |
| `Cr2Package` | Represents native CR2 metadata. |
| `Cr2PanoramaPackage` | Represents Canon MakerNotes tags. |
| `Cr2PersonalFuncValuesPackage` | Represents Canon MakerNotes tags. |
| `Cr2PersonalFuncsPackage` | Represents Canon MakerNotes tags. |
| `Cr2ProcessingPackage` | Represents Canon MakerNotes tags. |
| `Cr2RootPackage` | Represents an entry point to all metadata packages presented in a particular file CR2. |
| `Cr2SensorInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2ShotInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2TimeInfoPackage` | Represents Canon MakerNotes tags. |
| `Cr2VignettingCorr2Package` | Represents Canon MakerNotes tags. |
| `Cr2WBInfoPackage` | Represents Canon MakerNotes tags. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `Cr2AFConfigIndex` | Defines ids of Cr2AFConfig tags. |
| `Cr2AFInfo2Index` | Defines ids of Cr2AFInfo2 tags. |
| `Cr2AFInfoIndex` | Defines ids of Cr2AFInfo tags. |
| `Cr2AFMicroAdjIndex` | Defines ids of Cr2AFMicroAdj tags. |
| `Cr2AspectInfoIndex` | Defines ids of Cr2AspectInfo tags. |
| `Cr2CameraSettingsIndex` | Defines ids of Cr2CameraSettings tags. |
| `Cr2ColorBalanceIndex` | Defines ids of Cr2ColorBalance tags. |
| `Cr2ColorInfoIndex` | Defines ids of Cr2ColorInfo tags. |
| `Cr2CropInfoIndex` | Defines ids of Cr2CropInfo tags. |
| `Cr2FileInfoIndex` | Defines ids of Cr2FileInfo tags. |
| `Cr2FilterInfoIndex` | Defines ids of Cr2FilterInfo tags. |
| `Cr2FocalLengthIndex` | Defines ids of Cr2FocalLength tags. |
| `Cr2Functions1DIndex` | Defines ids of Cr2Functions1D tags. |
| `Cr2Functions2Index` | Defines ids of Cr2Functions2 tags. |
| `Cr2LightingOptIndex` | Defines ids of Cr2LightingOpt tags. |
| `Cr2LogInfoIndex` | Defines ids of Cr2LogInfo tags. |
| `Cr2MakerNoteIndex` | Defines ids of Cr2MakerNote tags. |
| `Cr2ModifiedInfoIndex` | Defines ids of Cr2ModifiedInfo tags. |
| `Cr2MovieInfoIndex` | Defines ids of Cr2MovieInfo tags. |
| `Cr2MultiExpIndex` | Defines ids of Cr2MultiExp tags. |
| `Cr2PanoramaIndex` | Defines ids of Cr2Panorama tags. |
| `Cr2PersonalFuncValuesIndex` | Defines ids of Cr2PersonalFuncValues tags. |
| `Cr2PersonalFuncsIndex` | Defines ids of Cr2PersonalFuncs tags. |
| `Cr2ProcessingIndex` | Defines ids of Cr2Processing tags. |
| `Cr2SensorInfoIndex` | Defines ids of Cr2SensorInfo tags. |
| `Cr2ShotInfoIndex` | Defines ids of Cr2ShotInfo tags. |
| `Cr2TimeInfoIndex` | Defines ids of Cr2TimeInfo tags. |
| `Cr2VignettingCorr2Index` | Defines ids of Cr2VignettingCorr2 tags. |
| `Cr2WBInfoIndex` | Defines ids of Cr2WBInfo tags. |

### Cr2AFConfigIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigindex.md

#### Cr2AFConfigIndex enumeration

Defines ids of Cr2AFConfig tags.

The Cr2AFConfigIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| AF_CONFIG_TOOL | Indicates the AFConfigTool. |
| AF_TRACKING_SENSITIVITY | Indicates the AFTrackingSensitivity. |
| AF_ACCEL_DECEL_TRACKING | Indicates the AFAccelDecelTracking. |
| AF_POINT_SWITCHING | Indicates the AFPointSwitching. |
| AI_SERVO_FIRST_IMAGE | Indicates the AIServoFirstImage. |
| AI_SERVO_SECOND_IMAGE | Indicates the AIServoSecondImage. |
| USM_LENS_ELECTRONIC_MF | Indicates the USMLensElectronicMF. |
| AF_ASSIST_BEAM | Indicates the AFAssistBeam. |
| ONE_SHOT_AF_RELEASE | Indicates the OneShotAFRelease. |
| AUTO_AF_POINT_SEL_EO_SI_TRAF | Indicates the AutoAFPointSelEOSiTRAF. |
| LENS_DRIVE_WHEN_AF_IMPOSSIBLE | Indicates the LensDriveWhenAFImpossible. |
| SELECT_AF_AREA_SELECTION_MODE | Indicates the SelectAFAreaSelectionMode. |
| AF_AREA_SELECTION_METHOD | Indicates the AFAreaSelectionMethod. |
| ORIENTATION_LINKED_AF | Indicates the OrientationLinkedAF. |
| MANUAL_AF_POINT_SEL_PATTERN | Indicates the ManualAFPointSelPattern. |
| AF_POINT_DISPLAY_DURING_FOCUS | Indicates the AFPointDisplayDuringFocus. |
| VF_DISPLAY_ILLUMINATION | Indicates the VFDisplayIllumination. |
| AF_STATUS_VIEWFINDER | Indicates the AFStatusViewfinder. |
| INITIAL_AF_POINT_IN_SERVO | Indicates the InitialAFPointInServo. |

### Cr2AFConfigPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage.md

#### Cr2AFConfigPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2AFConfigPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2AFConfigPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2AFConfigPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| af_config_tool | Gets the AFConfigTool. |
| af_tracking_sensitivity | Gets the AFTrackingSensitivity. |
| af_accel_decel_tracking | Gets the AFAccelDecelTracking. |
| af_point_switching | Gets the AFPointSwitching. |
| ai_servo_first_image | Gets the AIServoFirstImage. |
| ai_servo_second_image | Gets the AIServoSecondImage. |
| usm_lens_electronic_mf | Gets the USMLensElectronicMF. |
| af_assist_beam | Gets the AFAssistBeam. |
| one_shot_af_release | Gets the OneShotAFRelease. |
| auto_af_point_sel_eo_si_traf | Gets the AutoAFPointSelEOSiTRAF. |
| lens_drive_when_af_impossible | Gets the LensDriveWhenAFImpossible. |
| select_af_area_selection_mode | Gets the SelectAFAreaSelectionMode. |
| af_area_selection_method | Gets the AFAreaSelectionMethod. |
| orientation_linked_af | Gets the OrientationLinkedAF. |
| manual_af_point_sel_pattern | Gets the ManualAFPointSelPattern. |
| af_point_display_during_focus | Gets the AFPointDisplayDuringFocus. |
| vf_display_illumination | Gets the VFDisplayIllumination. |
| af_status_viewfinder | Gets the AFStatusViewfinder. |
| initial_af_point_in_servo | Gets the InitialAFPointInServo. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2AFConfigPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2AFConfigPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2AFConfigPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_accel_decel_tracking property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_accel_decel_tracking.md

#### af_accel_decel_tracking property

Gets the AFAccelDecelTracking.
##### Definition:
```python
@property
def af_accel_decel_tracking(self):
    ...
```

### af_area_selection_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_area_selection_method.md

#### af_area_selection_method property

Gets the AFAreaSelectionMethod.
##### Definition:
```python
@property
def af_area_selection_method(self):
    ...
```

### af_assist_beam property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_assist_beam.md

#### af_assist_beam property

Gets the AFAssistBeam.
##### Definition:
```python
@property
def af_assist_beam(self):
    ...
```

### af_config_tool property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_config_tool.md

#### af_config_tool property

Gets the AFConfigTool.
##### Definition:
```python
@property
def af_config_tool(self):
    ...
```

### af_point_display_during_focus property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_point_display_during_focus.md

#### af_point_display_during_focus property

Gets the AFPointDisplayDuringFocus.
##### Definition:
```python
@property
def af_point_display_during_focus(self):
    ...
```

### af_point_switching property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_point_switching.md

#### af_point_switching property

Gets the AFPointSwitching.
##### Definition:
```python
@property
def af_point_switching(self):
    ...
```

### af_status_viewfinder property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_status_viewfinder.md

#### af_status_viewfinder property

Gets the AFStatusViewfinder.
##### Definition:
```python
@property
def af_status_viewfinder(self):
    ...
```

### af_tracking_sensitivity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/af_tracking_sensitivity.md

#### af_tracking_sensitivity property

Gets the AFTrackingSensitivity.
##### Definition:
```python
@property
def af_tracking_sensitivity(self):
    ...
```

### ai_servo_first_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/ai_servo_first_image.md

#### ai_servo_first_image property

Gets the AIServoFirstImage.
##### Definition:
```python
@property
def ai_servo_first_image(self):
    ...
```

### ai_servo_second_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/ai_servo_second_image.md

#### ai_servo_second_image property

Gets the AIServoSecondImage.
##### Definition:
```python
@property
def ai_servo_second_image(self):
    ...
```

### auto_af_point_sel_eo_si_traf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/auto_af_point_sel_eo_si_traf.md

#### auto_af_point_sel_eo_si_traf property

Gets the AutoAFPointSelEOSiTRAF.
##### Definition:
```python
@property
def auto_af_point_sel_eo_si_traf(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### initial_af_point_in_servo property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/initial_af_point_in_servo.md

#### initial_af_point_in_servo property

Gets the InitialAFPointInServo.
##### Definition:
```python
@property
def initial_af_point_in_servo(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_drive_when_af_impossible property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/lens_drive_when_af_impossible.md

#### lens_drive_when_af_impossible property

Gets the LensDriveWhenAFImpossible.
##### Definition:
```python
@property
def lens_drive_when_af_impossible(self):
    ...
```

### manual_af_point_sel_pattern property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/manual_af_point_sel_pattern.md

#### manual_af_point_sel_pattern property

Gets the ManualAFPointSelPattern.
##### Definition:
```python
@property
def manual_af_point_sel_pattern(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### one_shot_af_release property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/one_shot_af_release.md

#### one_shot_af_release property

Gets the OneShotAFRelease.
##### Definition:
```python
@property
def one_shot_af_release(self):
    ...
```

### orientation_linked_af property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/orientation_linked_af.md

#### orientation_linked_af property

Gets the OrientationLinkedAF.
##### Definition:
```python
@property
def orientation_linked_af(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### select_af_area_selection_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/select_af_area_selection_mode.md

#### select_af_area_selection_mode property

Gets the SelectAFAreaSelectionMode.
##### Definition:
```python
@property
def select_af_area_selection_mode(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### usm_lens_electronic_mf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/usm_lens_electronic_mf.md

#### usm_lens_electronic_mf property

Gets the USMLensElectronicMF.
##### Definition:
```python
@property
def usm_lens_electronic_mf(self):
    ...
```

### vf_display_illumination property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afconfigpackage/vf_display_illumination.md

#### vf_display_illumination property

Gets the VFDisplayIllumination.
##### Definition:
```python
@property
def vf_display_illumination(self):
    ...
```

### Cr2AFInfo2Index enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2index.md

#### Cr2AFInfo2Index enumeration

Defines ids of Cr2AFInfo2 tags.

The Cr2AFInfo2Index type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AF_INFO_SIZE | Indicates the AFInfoSize. |
| AF_AREA_MODE | Indicates the AFAreaMode. |
| NUM_AF_POINTS | Indicates the NumAFPoints. |
| VALID_AF_POINTS | Indicates the ValidAFPoints. |
| CANON_IMAGE_WIDTH | Indicates the CanonImageWidth. |
| CANON_IMAGE_HEIGHT | Indicates the CanonImageHeight. |
| AF_IMAGE_WIDTH | Indicates the AFImageWidth. |
| AF_IMAGE_HEIGHT | Indicates the AFImageHeight. |
| AF_AREA_WIDTHS | Indicates the AFAreaWidths. |
| AF_AREA_HEIGHTS | Indicates the AFAreaHeights. |
| AF_AREA_X_POSITIONS | Indicates the AFAreaXPositions. |
| AF_AREA_Y_POSITIONS | Indicates the AFAreaYPositions. |
| AF_POINTS_IN_FOCUS | Indicates the AFPointsInFocus. |
| AF_POINTS_SELECTED | Indicates the AFPointsSelected. |
| PRIMARY_AF_POINT | Indicates the PrimaryAFPoint. |

### Cr2AFInfo2Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package.md

#### Cr2AFInfo2Package class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2AFInfo2Package` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2AFInfo2Package type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2AFInfo2Package` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| af_info_size | Gets the AFInfoSize. |
| af_area_mode | Gets the AFAreaMode. |
| num_af_points | Gets the NumAFPoints. |
| valid_af_points | Gets the ValidAFPoints. |
| canon_image_width | Gets the CanonImageWidth. |
| canon_image_height | Gets the CanonImageHeight. |
| af_image_width | Gets the AFImageWidth. |
| af_image_height | Gets the AFImageHeight. |
| af_area_widths | Gets the AFAreaWidths. |
| af_area_heights | Gets the AFAreaHeights. |
| af_area_x_positions | Gets the AFAreaXPositions. |
| af_area_y_positions | Gets the AFAreaYPositions. |
| af_points_in_focus | Gets the AFPointsInFocus. |
| af_points_selected | Gets the AFPointsSelected. |
| primary_af_point | Gets the PrimaryAFPoint. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2AFInfo2Package indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2AFInfo2Package constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2AFInfo2Package` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_area_heights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_area_heights.md

#### af_area_heights property

Gets the AFAreaHeights.
##### Definition:
```python
@property
def af_area_heights(self):
    ...
```

### af_area_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_area_mode.md

#### af_area_mode property

Gets the AFAreaMode.
##### Definition:
```python
@property
def af_area_mode(self):
    ...
```

### af_area_widths property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_area_widths.md

#### af_area_widths property

Gets the AFAreaWidths.
##### Definition:
```python
@property
def af_area_widths(self):
    ...
```

### af_area_x_positions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_area_x_positions.md

#### af_area_x_positions property

Gets the AFAreaXPositions.
##### Definition:
```python
@property
def af_area_x_positions(self):
    ...
```

### af_area_y_positions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_area_y_positions.md

#### af_area_y_positions property

Gets the AFAreaYPositions.
##### Definition:
```python
@property
def af_area_y_positions(self):
    ...
```

### af_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_image_height.md

#### af_image_height property

Gets the AFImageHeight.
##### Definition:
```python
@property
def af_image_height(self):
    ...
```

### af_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_image_width.md

#### af_image_width property

Gets the AFImageWidth.
##### Definition:
```python
@property
def af_image_width(self):
    ...
```

### af_info_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_info_size.md

#### af_info_size property

Gets the AFInfoSize.
##### Definition:
```python
@property
def af_info_size(self):
    ...
```

### af_points_in_focus property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_points_in_focus.md

#### af_points_in_focus property

Gets the AFPointsInFocus.
##### Definition:
```python
@property
def af_points_in_focus(self):
    ...
```

### af_points_selected property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/af_points_selected.md

#### af_points_selected property

Gets the AFPointsSelected.
##### Definition:
```python
@property
def af_points_selected(self):
    ...
```

### canon_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/canon_image_height.md

#### canon_image_height property

Gets the CanonImageHeight.
##### Definition:
```python
@property
def canon_image_height(self):
    ...
```

### canon_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/canon_image_width.md

#### canon_image_width property

Gets the CanonImageWidth.
##### Definition:
```python
@property
def canon_image_width(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### num_af_points property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/num_af_points.md

#### num_af_points property

Gets the NumAFPoints.
##### Definition:
```python
@property
def num_af_points(self):
    ...
```

### primary_af_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/primary_af_point.md

#### primary_af_point property

Gets the PrimaryAFPoint.
##### Definition:
```python
@property
def primary_af_point(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### valid_af_points property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfo2package/valid_af_points.md

#### valid_af_points property

Gets the ValidAFPoints.
##### Definition:
```python
@property
def valid_af_points(self):
    ...
```

### Cr2AFInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfoindex.md

#### Cr2AFInfoIndex enumeration

Defines ids of Cr2AFInfo tags.

The Cr2AFInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NUM_AF_POINTS | Indicates the NumAFPoints. |
| VALID_AF_POINTS | Indicates the ValidAFPoints. |
| CANON_IMAGE_WIDTH | Indicates the CanonImageWidth. |
| CANON_IMAGE_HEIGHT | Indicates the CanonImageHeight. |
| AF_IMAGE_WIDTH | Indicates the AFImageWidth. |
| AF_IMAGE_HEIGHT | Indicates the AFImageHeight. |
| AF_AREA_WIDTH | Indicates the AFAreaWidth. |
| AF_AREA_HEIGHT | Indicates the AFAreaHeight. |
| AF_AREA_X_POSITIONS | Indicates the AFAreaXPositions. |
| AF_AREA_Y_POSITIONS | Indicates the AFAreaYPositions. |
| AF_POINTS_IN_FOCUS | Indicates the AFPointsInFocus. |
| PRIMARY_AF_POINT_AF_INFO | Indicates the PrimaryAFPointAFInfo. |
| PRIMARY_AF_POINT | Indicates the PrimaryAFPoint. |

### Cr2AFInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage.md

#### Cr2AFInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2AFInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2AFInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2AFInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| num_af_points | Gets the NumAFPoints. |
| valid_af_points | Gets the ValidAFPoints. |
| canon_image_width | Gets the CanonImageWidth. |
| canon_image_height | Gets the CanonImageHeight. |
| af_image_width | Gets the AFImageWidth. |
| af_image_height | Gets the AFImageHeight. |
| af_area_width | Gets the AFAreaWidth. |
| af_area_height | Gets the AFAreaHeight. |
| af_area_x_positions | Gets the AFAreaXPositions. |
| af_area_y_positions | Gets the AFAreaYPositions. |
| af_points_in_focus | Gets the AFPointsInFocus. |
| primary_af_point_af_info | Gets the PrimaryAFPointAFInfo. |
| primary_af_point | Gets the PrimaryAFPoint. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2AFInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2AFInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2AFInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_area_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_area_height.md

#### af_area_height property

Gets the AFAreaHeight.
##### Definition:
```python
@property
def af_area_height(self):
    ...
```

### af_area_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_area_width.md

#### af_area_width property

Gets the AFAreaWidth.
##### Definition:
```python
@property
def af_area_width(self):
    ...
```

### af_area_x_positions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_area_x_positions.md

#### af_area_x_positions property

Gets the AFAreaXPositions.
##### Definition:
```python
@property
def af_area_x_positions(self):
    ...
```

### af_area_y_positions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_area_y_positions.md

#### af_area_y_positions property

Gets the AFAreaYPositions.
##### Definition:
```python
@property
def af_area_y_positions(self):
    ...
```

### af_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_image_height.md

#### af_image_height property

Gets the AFImageHeight.
##### Definition:
```python
@property
def af_image_height(self):
    ...
```

### af_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_image_width.md

#### af_image_width property

Gets the AFImageWidth.
##### Definition:
```python
@property
def af_image_width(self):
    ...
```

### af_points_in_focus property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/af_points_in_focus.md

#### af_points_in_focus property

Gets the AFPointsInFocus.
##### Definition:
```python
@property
def af_points_in_focus(self):
    ...
```

### canon_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/canon_image_height.md

#### canon_image_height property

Gets the CanonImageHeight.
##### Definition:
```python
@property
def canon_image_height(self):
    ...
```

### canon_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/canon_image_width.md

#### canon_image_width property

Gets the CanonImageWidth.
##### Definition:
```python
@property
def canon_image_width(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### num_af_points property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/num_af_points.md

#### num_af_points property

Gets the NumAFPoints.
##### Definition:
```python
@property
def num_af_points(self):
    ...
```

### primary_af_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/primary_af_point.md

#### primary_af_point property

Gets the PrimaryAFPoint.
##### Definition:
```python
@property
def primary_af_point(self):
    ...
```

### primary_af_point_af_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/primary_af_point_af_info.md

#### primary_af_point_af_info property

Gets the PrimaryAFPointAFInfo.
##### Definition:
```python
@property
def primary_af_point_af_info(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### valid_af_points property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afinfopackage/valid_af_points.md

#### valid_af_points property

Gets the ValidAFPoints.
##### Definition:
```python
@property
def valid_af_points(self):
    ...
```

### Cr2AFMicroAdjIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjindex.md

#### Cr2AFMicroAdjIndex enumeration

Defines ids of Cr2AFMicroAdj tags.

The Cr2AFMicroAdjIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| AF_MICRO_ADJ_MODE | Indicates the AFMicroAdjMode. |
| AF_MICRO_ADJ_VALUE | Indicates the AFMicroAdjValue. |

### Cr2AFMicroAdjPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage.md

#### Cr2AFMicroAdjPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2AFMicroAdjPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2AFMicroAdjPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2AFMicroAdjPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| af_micro_adj_mode | Gets the AFMicroAdjMode. |
| af_micro_adj_value | Gets the AFMicroAdjValue. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2AFMicroAdjPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2AFMicroAdjPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2AFMicroAdjPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_micro_adj_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/af_micro_adj_mode.md

#### af_micro_adj_mode property

Gets the AFMicroAdjMode.
##### Definition:
```python
@property
def af_micro_adj_mode(self):
    ...
```

### af_micro_adj_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/af_micro_adj_value.md

#### af_micro_adj_value property

Gets the AFMicroAdjValue.
##### Definition:
```python
@property
def af_micro_adj_value(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2afmicroadjpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2AspectInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfoindex.md

#### Cr2AspectInfoIndex enumeration

Defines ids of Cr2AspectInfo tags.

The Cr2AspectInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ASPECT_RATIO | Indicates the AspectRatio. |
| CROPPED_IMAGE_WIDTH | Indicates the CroppedImageWidth. |
| CROPPED_IMAGE_HEIGHT | Indicates the CroppedImageHeight. |
| CROPPED_IMAGE_LEFT | Indicates the CroppedImageLeft. |
| CROPPED_IMAGE_TOP | Indicates the CroppedImageTop. |

### Cr2AspectInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage.md

#### Cr2AspectInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2AspectInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2AspectInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2AspectInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| aspect_ratio | Gets the AspectRatio. |
| cropped_image_width | Gets the CroppedImageWidth. |
| cropped_image_height | Gets the CroppedImageHeight. |
| cropped_image_left | Gets the CroppedImageLeft. |
| cropped_image_top | Gets the CroppedImageTop. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2AspectInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2AspectInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2AspectInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### aspect_ratio property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/aspect_ratio.md

#### aspect_ratio property

Gets the AspectRatio.
##### Definition:
```python
@property
def aspect_ratio(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### cropped_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/cropped_image_height.md

#### cropped_image_height property

Gets the CroppedImageHeight.
##### Definition:
```python
@property
def cropped_image_height(self):
    ...
```

### cropped_image_left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/cropped_image_left.md

#### cropped_image_left property

Gets the CroppedImageLeft.
##### Definition:
```python
@property
def cropped_image_left(self):
    ...
```

### cropped_image_top property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/cropped_image_top.md

#### cropped_image_top property

Gets the CroppedImageTop.
##### Definition:
```python
@property
def cropped_image_top(self):
    ...
```

### cropped_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/cropped_image_width.md

#### cropped_image_width property

Gets the CroppedImageWidth.
##### Definition:
```python
@property
def cropped_image_width(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2aspectinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2CameraSettingsIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingsindex.md

#### Cr2CameraSettingsIndex enumeration

Defines ids of Cr2CameraSettings tags.

The Cr2CameraSettingsIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| MACRO_MODE | Indicates the MacroMode. |
| SELF_TIMER | Indicates the SelfTimer. |
| QUALITY | Indicates the Quality. |
| CANON_FLASH_MODE | Indicates the CanonFlashMode. |
| CONTINUOUS_DRIVE | Indicates the ContinuousDrive. |
| UNKNOWN2 | Unknown tag. |
| FOCUS_MODE | Indicates the FocusMode. |
| UNKNOWN3 | Unknown tag. |
| RECORD_MODE | Indicates the RecordMode. |
| CANON_IMAGE_SIZE | Indicates the CanonImageSize. |
| EASY_MODE | Indicates the EasyMode. |
| DIGITAL_ZOOM | Indicates the DigitalZoom. |
| CONTRAST | Indicates the Contrast. |
| SATURATION | Indicates the Saturation. |
| SHARPNESS | Indicates the Sharpness. |
| CAMERA_ISO | Indicates the CameraIso. |
| METERING_MODE | Indicates the MeteringMode. |
| FOCUS_RANGE | Indicates the FocusRange. |
| AF_POINT | Indicates the AFPoint. |
| CANON_EXPOSURE_MODE | Indicates the CanonExposureMode. |
| UNKNOWN4 | Unknown tag. |
| LENS_TYPE | Indicates the LensType. |
| MAX_FOCAL_LENGTH | Indicates the MaxFocalLength. |
| MIN_FOCAL_LENGTH | Indicates the MinFocalLength. |
| FOCAL_UNITS | Indicates the FocalUnits. |
| MAX_APERTURE | Indicates the MaxAperture. |
| MIN_APERTURE | Indicates the MinAperture. |
| FLASH_ACTIVITY | Indicates the FlashActivity. |
| FLASH_BITS | Indicates the FlashBits. |
| FOCUS_CONTINUOUS | Indicates the FocusContinuous. |
| AE_SETTING | Indicates the AESetting. |
| IMAGE_STABILIZATION | Indicates the ImageStabilization. |
| DISPLAY_APERTURE | Indicates the DisplayAperture. |
| ZOOM_SOURCE_WIDTH | Indicates the ZoomSourceWidth. |
| ZOOM_TARGET_WIDTH | Indicates the ZoomTargetWidth. |
| UNKNOWN5 | Unknown tag. |
| SPOT_METERING_MODE | Indicates the SpotMeteringMode. |
| PHOTO_EFFECT | Indicates the PhotoEffect. |
| MANUAL_FLASH_OUTPUT | Indicates the ManualFlashOutput. |
| UNKNOWN6 | Unknown tag. |
| COLOR_TONE | Indicates the ColorTone. |
| UNKNOWN7 | Unknown tag. |
| UNKNOWN8 | Unknown tag. |
| UNKNOWN9 | Unknown tag. |
| SRAW_QUALITY | Indicates the SRAWQuality. |
| UNKNOWN10 | Unknown tag. |
| UNKNOWN11 | Unknown tag. |
| UNKNOWN12 | Unknown tag. |

### Cr2CameraSettingsPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage.md

#### Cr2CameraSettingsPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2CameraSettingsPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2CameraSettingsPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2CameraSettingsPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| macro_mode | Gets the MacroMode. |
| self_timer | Gets the SelfTimer. |
| quality | Gets the Quality. |
| canon_flash_mode | Gets the CanonFlashMode. |
| continuous_drive | Gets the ContinuousDrive. |
| focus_mode | Gets the FocusMode. |
| record_mode | Gets the RecordMode. |
| canon_image_size | Gets the CanonImageSize. |
| easy_mode | Gets the EasyMode. |
| digital_zoom | Gets the DigitalZoom. |
| contrast | Gets the Contrast. |
| saturation | Gets the Saturation. |
| sharpness | Gets the Sharpness. |
| camera_iso | Gets the CameraIso. |
| metering_mode | Gets the MeteringMode. |
| focus_range | Gets the FocusRange. |
| af_point | Gets the AFPoint. |
| canon_exposure_mode | Gets the CanonExposureMode. |
| lens_type | Gets the LensType. |
| max_focal_length | Gets the MaxFocalLength. |
| min_focal_length | Gets the MinFocalLength. |
| focal_units | Gets the FocalUnits. |
| max_aperture | Gets the MaxAperture. |
| min_aperture | Gets the MinAperture. |
| flash_activity | Gets the FlashActivity. |
| flash_bits | Gets the FlashBits. |
| focus_continuous | Gets the FocusContinuous. |
| ae_setting | Gets the AESetting. |
| image_stabilization | Gets the ImageStabilization. |
| display_aperture | Gets the DisplayAperture. |
| zoom_source_width | Gets the ZoomSourceWidth. |
| zoom_target_width | Gets the ZoomTargetWidth. |
| spot_metering_mode | Gets the SpotMeteringMode. |
| photo_effect | Gets the PhotoEffect. |
| manual_flash_output | Gets the ManualFlashOutput. |
| color_tone | Gets the ColorTone. |
| sraw_quality | Gets the SRAWQuality. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2CameraSettingsPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2CameraSettingsPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2CameraSettingsPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### ae_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/ae_setting.md

#### ae_setting property

Gets the AESetting.
##### Definition:
```python
@property
def ae_setting(self):
    ...
```

### af_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/af_point.md

#### af_point property

Gets the AFPoint.
##### Definition:
```python
@property
def af_point(self):
    ...
```

### camera_iso property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/camera_iso.md

#### camera_iso property

Gets the CameraIso.
##### Definition:
```python
@property
def camera_iso(self):
    ...
```

### canon_exposure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canon_exposure_mode.md

#### canon_exposure_mode property

Gets the CanonExposureMode.
##### Definition:
```python
@property
def canon_exposure_mode(self):
    ...
```

### canon_flash_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canon_flash_mode.md

#### canon_flash_mode property

Gets the CanonFlashMode.
##### Definition:
```python
@property
def canon_flash_mode(self):
    ...
```

### canon_image_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/canon_image_size.md

#### canon_image_size property

Gets the CanonImageSize.
##### Definition:
```python
@property
def canon_image_size(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_tone property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/color_tone.md

#### color_tone property

Gets the ColorTone.
##### Definition:
```python
@property
def color_tone(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### continuous_drive property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/continuous_drive.md

#### continuous_drive property

Gets the ContinuousDrive.
##### Definition:
```python
@property
def continuous_drive(self):
    ...
```

### contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/contrast.md

#### contrast property

Gets the Contrast.
##### Definition:
```python
@property
def contrast(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_zoom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/digital_zoom.md

#### digital_zoom property

Gets the DigitalZoom.
##### Definition:
```python
@property
def digital_zoom(self):
    ...
```

### display_aperture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/display_aperture.md

#### display_aperture property

Gets the DisplayAperture.
##### Definition:
```python
@property
def display_aperture(self):
    ...
```

### easy_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/easy_mode.md

#### easy_mode property

Gets the EasyMode.
##### Definition:
```python
@property
def easy_mode(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash_activity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/flash_activity.md

#### flash_activity property

Gets the FlashActivity.
##### Definition:
```python
@property
def flash_activity(self):
    ...
```

### flash_bits property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/flash_bits.md

#### flash_bits property

Gets the FlashBits.
##### Definition:
```python
@property
def flash_bits(self):
    ...
```

### focal_units property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focal_units.md

#### focal_units property

Gets the FocalUnits.
##### Definition:
```python
@property
def focal_units(self):
    ...
```

### focus_continuous property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focus_continuous.md

#### focus_continuous property

Gets the FocusContinuous.
##### Definition:
```python
@property
def focus_continuous(self):
    ...
```

### focus_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focus_mode.md

#### focus_mode property

Gets the FocusMode.
##### Definition:
```python
@property
def focus_mode(self):
    ...
```

### focus_range property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/focus_range.md

#### focus_range property

Gets the FocusRange.
##### Definition:
```python
@property
def focus_range(self):
    ...
```

### image_stabilization property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/image_stabilization.md

#### image_stabilization property

Gets the ImageStabilization.
##### Definition:
```python
@property
def image_stabilization(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/lens_type.md

#### lens_type property

Gets the LensType.
##### Definition:
```python
@property
def lens_type(self):
    ...
```

### macro_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/macro_mode.md

#### macro_mode property

Gets the MacroMode.
##### Definition:
```python
@property
def macro_mode(self):
    ...
```

### manual_flash_output property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/manual_flash_output.md

#### manual_flash_output property

Gets the ManualFlashOutput.
##### Definition:
```python
@property
def manual_flash_output(self):
    ...
```

### max_aperture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/max_aperture.md

#### max_aperture property

Gets the MaxAperture.
##### Definition:
```python
@property
def max_aperture(self):
    ...
```

### max_focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/max_focal_length.md

#### max_focal_length property

Gets the MaxFocalLength.
##### Definition:
```python
@property
def max_focal_length(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### metering_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/metering_mode.md

#### metering_mode property

Gets the MeteringMode.
##### Definition:
```python
@property
def metering_mode(self):
    ...
```

### min_aperture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/min_aperture.md

#### min_aperture property

Gets the MinAperture.
##### Definition:
```python
@property
def min_aperture(self):
    ...
```

### min_focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/min_focal_length.md

#### min_focal_length property

Gets the MinFocalLength.
##### Definition:
```python
@property
def min_focal_length(self):
    ...
```

### photo_effect property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/photo_effect.md

#### photo_effect property

Gets the PhotoEffect.
##### Definition:
```python
@property
def photo_effect(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/quality.md

#### quality property

Gets the Quality.
##### Definition:
```python
@property
def quality(self):
    ...
```

### record_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/record_mode.md

#### record_mode property

Gets the RecordMode.
##### Definition:
```python
@property
def record_mode(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/saturation.md

#### saturation property

Gets the Saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### self_timer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/self_timer.md

#### self_timer property

Gets the SelfTimer.
##### Definition:
```python
@property
def self_timer(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/sharpness.md

#### sharpness property

Gets the Sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### spot_metering_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/spot_metering_mode.md

#### spot_metering_mode property

Gets the SpotMeteringMode.
##### Definition:
```python
@property
def spot_metering_mode(self):
    ...
```

### sraw_quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/sraw_quality.md

#### sraw_quality property

Gets the SRAWQuality.
##### Definition:
```python
@property
def sraw_quality(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### zoom_source_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/zoom_source_width.md

#### zoom_source_width property

Gets the ZoomSourceWidth.
##### Definition:
```python
@property
def zoom_source_width(self):
    ...
```

### zoom_target_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2camerasettingspackage/zoom_target_width.md

#### zoom_target_width property

Gets the ZoomTargetWidth.
##### Definition:
```python
@property
def zoom_target_width(self):
    ...
```

### Cr2ColorBalanceIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalanceindex.md

#### Cr2ColorBalanceIndex enumeration

Defines ids of Cr2ColorBalance tags.

The Cr2ColorBalanceIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| WB_RGGB_LEVELS_AUTO | Indicates the WB_RGGBLevelsAuto. |
| WB_RGGB_LEVELS_DAYLIGHT | Indicates the WB_RGGBLevelsDaylight. |
| WB_RGGB_LEVELS_SHADE | Indicates the WB_RGGBLevelsShade. |
| WB_RGGB_LEVELS_CLOUDY | Indicates the WB_RGGBLevelsCloudy. |
| WB_RGGB_LEVELS_TUNGSTEN | Indicates the WB_RGGBLevelsTungsten. |
| WB_RGGB_LEVELS_FLUORESCENT | Indicates the WB_RGGBLevelsFluorescent. |
| WB_RGGB_LEVELS_FLASH | Indicates the WB_RGGBLevelsFlash. |
| WB_RGGB_LEVELS_KELVIN | Indicates the WB_RGGBLevelsKelvin. |
| WB_RGGB_BLACK_LEVELS | Indicates the WB_RGGBBlackLevels. |

### Cr2ColorBalancePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage.md

#### Cr2ColorBalancePackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2ColorBalancePackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2ColorBalancePackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2ColorBalancePackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| wb_rggb_levels_auto | Gets the WB_RGGBLevelsAuto. |
| wb_rggb_levels_daylight | Gets the WB_RGGBLevelsDaylight. |
| wb_rggb_levels_shade | Gets the WB_RGGBLevelsShade. |
| wb_rggb_levels_cloudy | Gets the WB_RGGBLevelsCloudy. |
| wb_rggb_levels_tungsten | Gets the WB_RGGBLevelsTungsten. |
| wb_rggb_levels_fluorescent | Gets the WB_RGGBLevelsFluorescent. |
| wb_rggb_levels_flash | Gets the WB_RGGBLevelsFlash. |
| wb_rggb_levels_kelvin | Gets the WB_RGGBLevelsKelvin. |
| wb_rggb_black_levels | Gets the WB_RGGBBlackLevels. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2ColorBalancePackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2ColorBalancePackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2ColorBalancePackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### wb_rggb_black_levels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_black_levels.md

#### wb_rggb_black_levels property

Gets the WB_RGGBBlackLevels.
##### Definition:
```python
@property
def wb_rggb_black_levels(self):
    ...
```

### wb_rggb_levels_auto property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_auto.md

#### wb_rggb_levels_auto property

Gets the WB_RGGBLevelsAuto.
##### Definition:
```python
@property
def wb_rggb_levels_auto(self):
    ...
```

### wb_rggb_levels_cloudy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_cloudy.md

#### wb_rggb_levels_cloudy property

Gets the WB_RGGBLevelsCloudy.
##### Definition:
```python
@property
def wb_rggb_levels_cloudy(self):
    ...
```

### wb_rggb_levels_daylight property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_daylight.md

#### wb_rggb_levels_daylight property

Gets the WB_RGGBLevelsDaylight.
##### Definition:
```python
@property
def wb_rggb_levels_daylight(self):
    ...
```

### wb_rggb_levels_flash property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_flash.md

#### wb_rggb_levels_flash property

Gets the WB_RGGBLevelsFlash.
##### Definition:
```python
@property
def wb_rggb_levels_flash(self):
    ...
```

### wb_rggb_levels_fluorescent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_fluorescent.md

#### wb_rggb_levels_fluorescent property

Gets the WB_RGGBLevelsFluorescent.
##### Definition:
```python
@property
def wb_rggb_levels_fluorescent(self):
    ...
```

### wb_rggb_levels_kelvin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_kelvin.md

#### wb_rggb_levels_kelvin property

Gets the WB_RGGBLevelsKelvin.
##### Definition:
```python
@property
def wb_rggb_levels_kelvin(self):
    ...
```

### wb_rggb_levels_shade property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_shade.md

#### wb_rggb_levels_shade property

Gets the WB_RGGBLevelsShade.
##### Definition:
```python
@property
def wb_rggb_levels_shade(self):
    ...
```

### wb_rggb_levels_tungsten property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorbalancepackage/wb_rggb_levels_tungsten.md

#### wb_rggb_levels_tungsten property

Gets the WB_RGGBLevelsTungsten.
##### Definition:
```python
@property
def wb_rggb_levels_tungsten(self):
    ...
```

### Cr2ColorInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfoindex.md

#### Cr2ColorInfoIndex enumeration

Defines ids of Cr2ColorInfo tags.

The Cr2ColorInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| SATURATION | Indicates the Saturation. |
| COLOR_TONE | Indicates the ColorTone. |
| COLOR_SPACE | Indicates the ColorSpace. |

### Cr2ColorInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage.md

#### Cr2ColorInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2ColorInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2ColorInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2ColorInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| saturation | Gets the Saturation. |
| color_tone | Gets the ColorTone. |
| color_space | Gets the ColorSpace. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2ColorInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2ColorInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2ColorInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_space property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/color_space.md

#### color_space property

Gets the ColorSpace.
##### Definition:
```python
@property
def color_space(self):
    ...
```

### color_tone property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/color_tone.md

#### color_tone property

Gets the ColorTone.
##### Definition:
```python
@property
def color_tone(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/saturation.md

#### saturation property

Gets the Saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2colorinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2CropInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfoindex.md

#### Cr2CropInfoIndex enumeration

Defines ids of Cr2CropInfo tags.

The Cr2CropInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CROP_LEFT_MARGIN | Indicates the CropLeftMargin. |
| CROP_RIGHT_MARGIN | Indicates the CropRightMargin. |
| CROP_TOP_MARGIN | Indicates the CropTopMargin. |
| CROP_BOTTOM_MARGIN | Indicates the CropBottomMargin. |

### Cr2CropInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage.md

#### Cr2CropInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2CropInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2CropInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2CropInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| crop_left_margin | Gets the CropLeftMargin. |
| crop_right_margin | Gets the CropRightMargin. |
| crop_top_margin | Gets the CropTopMargin. |
| crop_bottom_margin | Gets the CropBottomMargin. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2CropInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2CropInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2CropInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### crop_bottom_margin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/crop_bottom_margin.md

#### crop_bottom_margin property

Gets the CropBottomMargin.
##### Definition:
```python
@property
def crop_bottom_margin(self):
    ...
```

### crop_left_margin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/crop_left_margin.md

#### crop_left_margin property

Gets the CropLeftMargin.
##### Definition:
```python
@property
def crop_left_margin(self):
    ...
```

### crop_right_margin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/crop_right_margin.md

#### crop_right_margin property

Gets the CropRightMargin.
##### Definition:
```python
@property
def crop_right_margin(self):
    ...
```

### crop_top_margin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/crop_top_margin.md

#### crop_top_margin property

Gets the CropTopMargin.
##### Definition:
```python
@property
def crop_top_margin(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2cropinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2FileInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfoindex.md

#### Cr2FileInfoIndex enumeration

Defines ids of Cr2FileInfo tags.

The Cr2FileInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| FILE_NUMBER_OR_SHUTTER_COUNT | Indicates the FileNumber or ShutterCount. |
| BRACKET_MODE | Indicates the BracketMode. |
| BRACKET_VALUE | Indicates the BracketValue. |
| BRACKET_SHOT_NUMBER | Indicates the BracketShotNumber. |
| RAW_JPG_QUALITY | Indicates the RawJpgQuality. |
| RAW_JPG_SIZE | Indicates the RawJpgSize. |
| LONG_EXPOSURE_NOISE_REDUCTION2 | Indicates the LongExposureNoiseReduction2. |
| WB_BRACKET_MODE | Indicates the WBBracketMode. |
| UNKNOWN2 | Unknown tag. |
| UNKNOWN3 | Unknown tag. |
| WB_BRACKET_VALUE_AB | Indicates the WBBracketValueAB. |
| WB_BRACKET_VALUE_GM | Indicates the WBBracketValueGM. |
| FILTER_EFFECT | Indicates the FilterEffect. |
| TONING_EFFECT | Indicates the ToningEffect. |
| MACRO_MAGNIFICATION | Indicates the MacroMagnification. |
| UNKNOWN4 | Unknown tag. |
| UNKNOWN5 | Unknown tag. |
| LIVE_VIEW_SHOOTING | Indicates the LiveViewShooting. |
| FOCUS_DISTANCE_UPPER | Indicates the FocusDistanceUpper. |
| FOCUS_DISTANCE_LOWER | Indicates the FocusDistanceLower. |
| SHUTTER_MODE | Indicates the ShutterMode. |
| FLASH_EXPOSURE_LOCK | Indicates the FlashExposureLock. |
| RF_LENS_TYPE | Indicates the RFLensType. |

### Cr2FileInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage.md

#### Cr2FileInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2FileInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2FileInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2FileInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| size | Gets the Size. |
| file_number_or_shutter_count | Gets the FileNumberOrShutterCount. |
| bracket_mode | Gets the BracketMode. |
| bracket_value | Gets the BracketValue. |
| bracket_shot_number | Gets the BracketShotNumber. |
| raw_jpg_quality | Gets the RawJpgQuality. |
| raw_jpg_size | Gets the RawJpgSize. |
| long_exposure_noise_reduction2 | Gets the LongExposureNoiseReduction2. |
| wb_bracket_mode | Gets the WBBracketMode. |
| wb_bracket_value_ab | Gets the WBBracketValueAB. |
| wb_bracket_value_gm | Gets the WBBracketValueGM. |
| filter_effect | Gets the FilterEffect. |
| toning_effect | Gets the ToningEffect. |
| macro_magnification | Gets the MacroMagnification. |
| live_view_shooting | Gets the LiveViewShooting. |
| focus_distance_upper | Gets the FocusDistanceUpper. |
| focus_distance_lower | Gets the FocusDistanceLower. |
| shutter_mode | Gets the ShutterMode. |
| flash_exposure_lock | Gets the FlashExposureLock. |
| rf_lens_type | Gets the RFLensType. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2FileInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2FileInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2FileInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bracket_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracket_mode.md

#### bracket_mode property

Gets the BracketMode.
##### Definition:
```python
@property
def bracket_mode(self):
    ...
```

### bracket_shot_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracket_shot_number.md

#### bracket_shot_number property

Gets the BracketShotNumber.
##### Definition:
```python
@property
def bracket_shot_number(self):
    ...
```

### bracket_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/bracket_value.md

#### bracket_value property

Gets the BracketValue.
##### Definition:
```python
@property
def bracket_value(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_number_or_shutter_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/file_number_or_shutter_count.md

#### file_number_or_shutter_count property

Gets the FileNumberOrShutterCount.
##### Definition:
```python
@property
def file_number_or_shutter_count(self):
    ...
```

### filter_effect property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/filter_effect.md

#### filter_effect property

Gets the FilterEffect.
##### Definition:
```python
@property
def filter_effect(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash_exposure_lock property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/flash_exposure_lock.md

#### flash_exposure_lock property

Gets the FlashExposureLock.
##### Definition:
```python
@property
def flash_exposure_lock(self):
    ...
```

### focus_distance_lower property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/focus_distance_lower.md

#### focus_distance_lower property

Gets the FocusDistanceLower.
##### Definition:
```python
@property
def focus_distance_lower(self):
    ...
```

### focus_distance_upper property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/focus_distance_upper.md

#### focus_distance_upper property

Gets the FocusDistanceUpper.
##### Definition:
```python
@property
def focus_distance_upper(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### live_view_shooting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/live_view_shooting.md

#### live_view_shooting property

Gets the LiveViewShooting.
##### Definition:
```python
@property
def live_view_shooting(self):
    ...
```

### long_exposure_noise_reduction2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/long_exposure_noise_reduction2.md

#### long_exposure_noise_reduction2 property

Gets the LongExposureNoiseReduction2.
##### Definition:
```python
@property
def long_exposure_noise_reduction2(self):
    ...
```

### macro_magnification property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/macro_magnification.md

#### macro_magnification property

Gets the MacroMagnification.
##### Definition:
```python
@property
def macro_magnification(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_jpg_quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/raw_jpg_quality.md

#### raw_jpg_quality property

Gets the RawJpgQuality.
##### Definition:
```python
@property
def raw_jpg_quality(self):
    ...
```

### raw_jpg_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/raw_jpg_size.md

#### raw_jpg_size property

Gets the RawJpgSize.
##### Definition:
```python
@property
def raw_jpg_size(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### rf_lens_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/rf_lens_type.md

#### rf_lens_type property

Gets the RFLensType.
##### Definition:
```python
@property
def rf_lens_type(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shutter_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/shutter_mode.md

#### shutter_mode property

Gets the ShutterMode.
##### Definition:
```python
@property
def shutter_mode(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/size.md

#### size property

Gets the Size.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### toning_effect property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/toning_effect.md

#### toning_effect property

Gets the ToningEffect.
##### Definition:
```python
@property
def toning_effect(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### wb_bracket_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wb_bracket_mode.md

#### wb_bracket_mode property

Gets the WBBracketMode.
##### Definition:
```python
@property
def wb_bracket_mode(self):
    ...
```

### wb_bracket_value_ab property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wb_bracket_value_ab.md

#### wb_bracket_value_ab property

Gets the WBBracketValueAB.
##### Definition:
```python
@property
def wb_bracket_value_ab(self):
    ...
```

### wb_bracket_value_gm property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2fileinfopackage/wb_bracket_value_gm.md

#### wb_bracket_value_gm property

Gets the WBBracketValueGM.
##### Definition:
```python
@property
def wb_bracket_value_gm(self):
    ...
```

### Cr2FilterInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2filterinfoindex.md

#### Cr2FilterInfoIndex enumeration

Defines ids of Cr2FilterInfo tags.

The Cr2FilterInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GRAINY_BW_FILTER | Indicates the GrainyBWFilter. |
| SOFT_FOCUS_FILTER | Indicates the SoftFocusFilter. |
| TOY_CAMERA_FILTER | Indicates the ToyCameraFilter. |
| MINIATURE_FILTER | Indicates the MiniatureFilter. |
| MINIATURE_FILTER_ORIENTATION | Indicates the MiniatureFilterOrientation. |
| MINIATURE_FILTER_POSITION | Indicates the MiniatureFilterPosition. |
| MINIATURE_FILTER_PARAMETER | Indicates the MiniatureFilterParameter. |
| FISHEYE_FILTER | Indicates the FisheyeFilter. |
| PAINTING_FILTER | Indicates the PaintingFilter. |
| WATERCOLOR_FILTER | Indicates the WatercolorFilter. |

### Cr2FocalLengthIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthindex.md

#### Cr2FocalLengthIndex enumeration

Defines ids of Cr2FocalLength tags.

The Cr2FocalLengthIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| FOCAL_TYPE | Indicates the FocalType. |
| FOCAL_LENGTH | Indicates the FocalLength. |
| FOCAL_PLANE_X_SIZE | Indicates the FocalPlaneXSize. |
| FOCAL_PLANE_Y_SIZE | Indicates the FocalPlaneYSize. |

### Cr2FocalLengthPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage.md

#### Cr2FocalLengthPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2FocalLengthPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2FocalLengthPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2FocalLengthPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| focal_type | Gets the FocalType. |
| focal_length | Gets the FocalLength. |
| focal_plane_x_size | Gets the FocalPlaneXSize. |
| focal_plane_y_size | Gets the FocalPlaneYSize. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2FocalLengthPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2FocalLengthPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2FocalLengthPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focal_length.md

#### focal_length property

Gets the FocalLength.
##### Definition:
```python
@property
def focal_length(self):
    ...
```

### focal_plane_x_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focal_plane_x_size.md

#### focal_plane_x_size property

Gets the FocalPlaneXSize.
##### Definition:
```python
@property
def focal_plane_x_size(self):
    ...
```

### focal_plane_y_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focal_plane_y_size.md

#### focal_plane_y_size property

Gets the FocalPlaneYSize.
##### Definition:
```python
@property
def focal_plane_y_size(self):
    ...
```

### focal_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/focal_type.md

#### focal_type property

Gets the FocalType.
##### Definition:
```python
@property
def focal_type(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2focallengthpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2Functions1DIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dindex.md

#### Cr2Functions1DIndex enumeration

Defines ids of Cr2Functions1D tags.

The Cr2Functions1DIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| FOCUSING_SCREEN | Indicates the FocusingScreen. |
| FINDER_DISPLAY_DURING_EXPOSURE | Indicates the FinderDisplayDuringExposure. |
| SHUTTER_RELEASE_NO_CF_CARD | Indicates the ShutterReleaseNoCFCard. |
| ISO_SPEED_EXPANSION | Indicates the ISOSpeedExpansion. |
| SHUTTER_AEL_BUTTON | Indicates the ShutterAELButton. |
| MANUAL_TV | Indicates the ManualTv. |
| EXPOSURE_LEVEL_INCREMENTS | Indicates the ExposureLevelIncrements. |
| USM_LENS_ELECTRONIC_MF | Indicates the USMLensElectronicMF. |
| LCD_PANELS | Indicates the LCDPanels. |
| AEB_SEQUENCE_AUTO_CANCEL | Indicates the AEBSequenceAutoCancel. |
| AF_POINT_ILLUMINATION | Indicates the AFPointIllumination. |
| AF_POINT_SELECTION | Indicates the AFPointSelection. |
| MIRROR_LOCKUP | Indicates the MirrorLockup. |
| AF_POINT_SPOT_METERING | Indicates the AFPointSpotMetering. |
| FILL_FLASH_AUTO_REDUCTION | Indicates the FillFlashAutoReduction. |
| SHUTTER_CURTAIN_SYNC | Indicates the ShutterCurtainSync. |
| SAFETY_SHIFT_IN_AV_OR_TV | Indicates the SafetyShiftInAvOrTv. |
| AF_POINT_ACTIVATION_AREA | Indicates the AFPointActivationArea. |
| SWITCH_TO_REGISTERED_AF_POINT | Indicates the SwitchToRegisteredAFPoint. |
| LENS_AF_STOP_BUTTON | Indicates the LensAFStopButton. |
| AI_SERVO_TRACKING_SENSITIVITY | Indicates the AIServoTrackingSensitivity. |
| AI_SERVO_CONTINUOUS_SHOOTING | Indicates the AIServoContinuousShooting. |

### Cr2Functions1DPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage.md

#### Cr2Functions1DPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2Functions1DPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2Functions1DPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2Functions1DPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| focusing_screen | Gets the FocusingScreen. |
| finder_display_during_exposure | Gets the FinderDisplayDuringExposure. |
| shutter_release_no_cf_card | Gets the ShutterReleaseNoCFCard. |
| iso_speed_expansion | Gets the ISOSpeedExpansion. |
| shutter_ael_button | Gets the ShutterAELButton. |
| manual_tv | Gets the ManualTv. |
| exposure_level_increments | Gets the ExposureLevelIncrements. |
| usm_lens_electronic_mf | Gets the USMLensElectronicMF. |
| lcd_panels | Gets the LCDPanels. |
| aeb_sequence_auto_cancel | Gets the AEBSequenceAutoCancel. |
| af_point_illumination | Gets the AFPointIllumination. |
| af_point_selection | Gets the AFPointSelection. |
| mirror_lockup | Gets the MirrorLockup. |
| af_point_spot_metering | Gets the AFPointSpotMetering. |
| fill_flash_auto_reduction | Gets the FillFlashAutoReduction. |
| shutter_curtain_sync | Gets the ShutterCurtainSync. |
| safety_shift_in_av_or_tv | Gets the SafetyShiftInAvOrTv. |
| af_point_activation_area | Gets the AFPointActivationArea. |
| switch_to_registered_af_point | Gets the SwitchToRegisteredAFPoint. |
| lens_af_stop_button | Gets the LensAFStopButton. |
| ai_servo_tracking_sensitivity | Gets the AIServoTrackingSensitivity. |
| ai_servo_continuous_shooting | Gets the AIServoContinuousShooting. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2Functions1DPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2Functions1DPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2Functions1DPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### aeb_sequence_auto_cancel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/aeb_sequence_auto_cancel.md

#### aeb_sequence_auto_cancel property

Gets the AEBSequenceAutoCancel.
##### Definition:
```python
@property
def aeb_sequence_auto_cancel(self):
    ...
```

### af_point_activation_area property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/af_point_activation_area.md

#### af_point_activation_area property

Gets the AFPointActivationArea.
##### Definition:
```python
@property
def af_point_activation_area(self):
    ...
```

### af_point_illumination property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/af_point_illumination.md

#### af_point_illumination property

Gets the AFPointIllumination.
##### Definition:
```python
@property
def af_point_illumination(self):
    ...
```

### af_point_selection property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/af_point_selection.md

#### af_point_selection property

Gets the AFPointSelection.
##### Definition:
```python
@property
def af_point_selection(self):
    ...
```

### af_point_spot_metering property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/af_point_spot_metering.md

#### af_point_spot_metering property

Gets the AFPointSpotMetering.
##### Definition:
```python
@property
def af_point_spot_metering(self):
    ...
```

### ai_servo_continuous_shooting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/ai_servo_continuous_shooting.md

#### ai_servo_continuous_shooting property

Gets the AIServoContinuousShooting.
##### Definition:
```python
@property
def ai_servo_continuous_shooting(self):
    ...
```

### ai_servo_tracking_sensitivity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/ai_servo_tracking_sensitivity.md

#### ai_servo_tracking_sensitivity property

Gets the AIServoTrackingSensitivity.
##### Definition:
```python
@property
def ai_servo_tracking_sensitivity(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exposure_level_increments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/exposure_level_increments.md

#### exposure_level_increments property

Gets the ExposureLevelIncrements.
##### Definition:
```python
@property
def exposure_level_increments(self):
    ...
```

### fill_flash_auto_reduction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/fill_flash_auto_reduction.md

#### fill_flash_auto_reduction property

Gets the FillFlashAutoReduction.
##### Definition:
```python
@property
def fill_flash_auto_reduction(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### finder_display_during_exposure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/finder_display_during_exposure.md

#### finder_display_during_exposure property

Gets the FinderDisplayDuringExposure.
##### Definition:
```python
@property
def finder_display_during_exposure(self):
    ...
```

### focusing_screen property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/focusing_screen.md

#### focusing_screen property

Gets the FocusingScreen.
##### Definition:
```python
@property
def focusing_screen(self):
    ...
```

### iso_speed_expansion property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/iso_speed_expansion.md

#### iso_speed_expansion property

Gets the ISOSpeedExpansion.
##### Definition:
```python
@property
def iso_speed_expansion(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lcd_panels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/lcd_panels.md

#### lcd_panels property

Gets the LCDPanels.
##### Definition:
```python
@property
def lcd_panels(self):
    ...
```

### lens_af_stop_button property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/lens_af_stop_button.md

#### lens_af_stop_button property

Gets the LensAFStopButton.
##### Definition:
```python
@property
def lens_af_stop_button(self):
    ...
```

### manual_tv property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/manual_tv.md

#### manual_tv property

Gets the ManualTv.
##### Definition:
```python
@property
def manual_tv(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mirror_lockup property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/mirror_lockup.md

#### mirror_lockup property

Gets the MirrorLockup.
##### Definition:
```python
@property
def mirror_lockup(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### safety_shift_in_av_or_tv property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/safety_shift_in_av_or_tv.md

#### safety_shift_in_av_or_tv property

Gets the SafetyShiftInAvOrTv.
##### Definition:
```python
@property
def safety_shift_in_av_or_tv(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shutter_ael_button property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shutter_ael_button.md

#### shutter_ael_button property

Gets the ShutterAELButton.
##### Definition:
```python
@property
def shutter_ael_button(self):
    ...
```

### shutter_curtain_sync property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shutter_curtain_sync.md

#### shutter_curtain_sync property

Gets the ShutterCurtainSync.
##### Definition:
```python
@property
def shutter_curtain_sync(self):
    ...
```

### shutter_release_no_cf_card property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/shutter_release_no_cf_card.md

#### shutter_release_no_cf_card property

Gets the ShutterReleaseNoCFCard.
##### Definition:
```python
@property
def shutter_release_no_cf_card(self):
    ...
```

### switch_to_registered_af_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/switch_to_registered_af_point.md

#### switch_to_registered_af_point property

Gets the SwitchToRegisteredAFPoint.
##### Definition:
```python
@property
def switch_to_registered_af_point(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### usm_lens_electronic_mf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions1dpackage/usm_lens_electronic_mf.md

#### usm_lens_electronic_mf property

Gets the USMLensElectronicMF.
##### Definition:
```python
@property
def usm_lens_electronic_mf(self):
    ...
```

### Cr2Functions2Index enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2functions2index.md

#### Cr2Functions2Index enumeration

Defines ids of Cr2Functions2 tags.

The Cr2Functions2Index type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| EXPOSURE_LEVEL_INCREMENTS | Indicates the ExposureLevelIncrements. |
| ISO_SPEED_INCREMENTS | Indicates the ISOSpeedIncrements. |
| ISO_SPEED_RANGE | Indicates the ISOSpeedRange. |
| AEB_AUTO_CANCEL | Indicates the AEBAutoCancel. |
| AEB_SEQUENCE | Indicates the AEBSequence. |
| AEB_SHOT_COUNT | Indicates the AEBShotCount. |
| SPOT_METER_LINK_TO_AF_POINT | Indicates the SpotMeterLinkToAFPoint. |
| SAFETY_SHIFT | Indicates the SafetyShift. |
| USABLE_SHOOTING_MODES | Indicates the UsableShootingModes. |
| USABLE_METERING_MODES | Indicates the UsableMeteringModes. |
| EXPOSURE_MODE_IN_MANUAL | Indicates the ExposureModeInManual. |
| SHUTTER_SPEED_RANGE | Indicates the ShutterSpeedRange. |
| APERTURE_RANGE | Indicates the ApertureRange. |
| APPLY_SHOOTING_METERING_MODE | Indicates the ApplyShootingMeteringMode. |
| FLASH_SYNC_SPEED_AV | Indicates the FlashSyncSpeedAv. |
| AE_MICROADJUSTMENT | Indicates the AEMicroadjustment. |
| FE_MICROADJUSTMENT | Indicates the FEMicroadjustment. |
| SAME_EXPOSURE_FOR_NEW_APERTURE | Indicates the SameExposureForNewAperture. |
| EXPOSURE_COMP_AUTO_CANCEL | Indicates the ExposureCompAutoCancel. |
| AE_LOCK_METER_MODE_AFTER_FOCUS | Indicates the AELockMeterModeAfterFocus. |
| UNKNOWN2 | Unknown tag. |
| LONG_EXPOSURE_NOISE_REDUCTION | Indicates the LongExposureNoiseReduction. |
| HIGH_ISO_NOISE_REDUCTION | Indicates the HighISONoiseReduction. |
| HIGHLIGHT_TONE_PRIORITY | Indicates the HighlightTonePriority. |
| AUTO_LIGHTING_OPTIMIZER | Indicates the AutoLightingOptimizer. |
| ETTLII | Indicates the ETTLII. |
| SHUTTER_CURTAIN_SYNC | Indicates the ShutterCurtainSync. |
| FLASH_FIRING | Indicates the FlashFiring. |
| VIEW_INFO_DURING_EXPOSURE | Indicates the ViewInfoDuringExposure. |
| LCD_ILLUMINATION_DURING_BULB | Indicates the LCDIlluminationDuringBulb. |
| INFO_BUTTON_WHEN_SHOOTING | Indicates the InfoButtonWhenShooting. |
| VIEWFINDER_WARNINGS | Indicates the ViewfinderWarnings. |
| LV_SHOOTING_AREA_DISPLAY | Indicates the LVShootingAreaDisplay. |
| LV_SHOOTING_AREA_DISPLAY2 | Indicates the LVShootingAreaDisplay2. |
| UNKNOWN3 | Unknown tag. |
| USM_LENS_ELECTRONIC_MF | Indicates the USMLensElectronicMF. |
| AI_SERVO_TRACKING_SENSITIVITY | Indicates the AIServoTrackingSensitivity. |
| AI_SERVO_IMAGE_PRIORITY | Indicates the AIServoImagePriority. |
| AI_SERVO_TRACKING_METHOD | Indicates the AIServoTrackingMethod. |
| LENS_DRIVE_NO_AF | Indicates the LensDriveNoAF. |
| LENS_AF_STOP_BUTTON | Indicates the LensAFStopButton. |
| AF_MICROADJUSTMENT | Indicates the AFMicroadjustment. |
| AF_POINT_AREA_EXPANSION | Indicates the AFPointAreaExpansion. |
| SELECTABLE_AF_POINT | Indicates the SelectableAFPoint. |
| SWITCH_TO_REGISTERED_AF_POINT | Indicates the SwitchToRegisteredAFPoint. |
| AF_POINT_AUTO_SELECTION | Indicates the AFPointAutoSelection. |
| AF_POINT_DISPLAY_DURING_FOCUS | Indicates the AFPointDisplayDuringFocus. |
| AF_POINT_BRIGHTNESS | Indicates the AFPointBrightness. |
| AF_ASSIST_BEAM | Indicates the AFAssistBeam. |
| AF_POINT_SELECTION_METHOD | Indicates the AFPointSelectionMethod. |
| AF_DURING_LIVE_VIEW | Indicates the AFDuringLiveView. |
| SELECT_AF_AREA_SELECT_MODE | Indicates the SelectAFAreaSelectMode. |
| MANUAL_AF_POINT_SELECT_PATTERN | Indicates the ManualAFPointSelectPattern. |
| DISPLAY_ALL_AF_POINTS | Indicates the DisplayAllAFPoints. |
| FOCUS_DISPLAY_AI_SERVO_AND_MF | Indicates the FocusDisplayAIServoAndMF. |
| ORIENTATION_LINKED_AF_POINT | Indicates the OrientationLinkedAFPoint. |
| MULTI_CONTROLLER_WHILE_METERING | Indicates the MultiControllerWhileMetering. |
| ACCELERATION_TRACKING | Indicates the AccelerationTracking. |
| AI_SERVO_FIRST_IMAGE_PRIORITY | Indicates the AIServoFirstImagePriority. |
| AI_SERVO_SECOND_IMAGE_PRIORITY | Indicates the AIServoSecondImagePriority. |
| AF_AREA_SELECT_METHOD | Indicates the AFAreaSelectMethod. |
| AUTO_AF_POINT_COLOR_TRACKING | Indicates the AutoAFPointColorTracking. |
| VF_DISPLAY_ILLUMINATION | Indicates the VFDisplayIllumination. |
| INITIAL_AF_POINT_AI_SERVO_AF | Indicates the InitialAFPointAIServoAF. |
| MIRROR_LOCKUP | Indicates the MirrorLockup. |
| CONTINUOUS_SHOOTING_SPEED | Indicates the ContinuousShootingSpeed. |
| CONTINUOUS_SHOT_LIMIT | Indicates the ContinuousShotLimit. |
| RESTRICT_DRIVE_MODES | Indicates the RestrictDriveModes. |
| SHUTTER_AE_LOCK | Indicates the ShutterAELock. |
| AF_ON_AE_LOCK_BUTTON_SWITCH | Indicates the AFOnAELockButtonSwitch. |
| QUICK_CONTROL_DIAL_IN_METER | Indicates the QuickControlDialInMeter. |
| SET_BUTTON_WHEN_SHOOTING | Indicates the SetButtonWhenShooting. |
| MANUAL_TV | Indicates the ManualTv. |
| DIAL_DIRECTION_TV_AV | Indicates the DialDirectionTvAv. |
| AV_SETTING_WITHOUT_LENS | Indicates the AvSettingWithoutLens. |
| WB_MEDIA_IMAGE_SIZE_SETTING | Indicates the WBMediaImageSizeSetting. |
| LOCK_MICROPHONE_BUTTON | Indicates the LockMicrophoneButton. |
| BUTTON_FUNCTION_CONTROL_OFF | Indicates the ButtonFunctionControlOff. |
| ASSIGN_FUNC_BUTTON | Indicates the AssignFuncButton. |
| CUSTOM_CONTROLS | Indicates the CustomControls. |
| START_MOVIE_SHOOTING | Indicates the StartMovieShooting. |
| FLASH_BUTTON_FUNCTION | Indicates the FlashButtonFunction. |
| MULTI_FUNCTION_LOCK | Indicates the MultiFunctionLock. |
| TRASH_BUTTON_FUNCTION | Indicates the TrashButtonFunction. |
| SHUTTER_RELEASE_WITHOUT_LENS | Indicates the ShutterReleaseWithoutLens. |
| CONTROL_RING_ROTATION | Indicates the ControlRingRotation. |
| FOCUS_RING_ROTATION | Indicates the FocusRingRotation. |
| RF_LENS_MF_FOCUS_RING_SENSITIVITY | Indicates the RFLensMFFocusRingSensitivity. |
| CUSTOMIZE_DIALS | Indicates the CustomizeDials. |
| FOCUSING_SCREEN | Indicates the FocusingScreen. |
| TIMER_LENGTH | Indicates the TimerLength. |
| SHORT_RELEASE_TIME_LAG | Indicates the ShortReleaseTimeLag. |
| ADD_ASPECT_RATIO_INFO | Indicates the AddAspectRatioInfo. |
| ADD_ORIGINAL_DECISION_DATA | Indicates the AddOriginalDecisionData. |
| LIVE_VIEW_EXPOSURE_SIMULATION | Indicates the LiveViewExposureSimulation. |
| LCD_DISPLAY_AT_POWER_ON | Indicates the LCDDisplayAtPowerOn. |
| MEMO_AUDIO_QUALITY | Indicates the MemoAudioQuality. |
| DEFAULT_ERASE_OPTION | Indicates the DefaultEraseOption. |
| RETRACT_LENS_ON_POWER_OFF | Indicates the RetractLensOnPowerOff. |
| ADD_IPTC_INFORMATION | Indicates the AddIPTCInformation. |
| AUDIO_COMPRESSION | Indicates the AudioCompression. |

### Cr2LightingOptIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptindex.md

#### Cr2LightingOptIndex enumeration

Defines ids of Cr2LightingOpt tags.

The Cr2LightingOptIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| PERIPHERAL_ILLUMINATION_CORR | Indicates the PeripheralIlluminationCorr. |
| AUTO_LIGHTING_OPTIMIZER | Indicates the AutoLightingOptimizer. |
| HIGHLIGHT_TONE_PRIORITY | Indicates the HighlightTonePriority. |
| LONG_EXPOSURE_NOISE_REDUCTION | Indicates the LongExposureNoiseReduction. |
| HIGH_ISO_NOISE_REDUCTION | Indicates the HighISONoiseReduction. |
| DIGITAL_LENS_OPTIMIZER | Indicates the DigitalLensOptimizer. |

### Cr2LightingOptPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage.md

#### Cr2LightingOptPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2LightingOptPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2LightingOptPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2LightingOptPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| size | Gets the Size. |
| peripheral_illumination_corr | Gets the PeripheralIlluminationCorr. |
| auto_lighting_optimizer | Gets the AutoLightingOptimizer. |
| highlight_tone_priority | Gets the HighlightTonePriority. |
| long_exposure_noise_reduction | Gets the LongExposureNoiseReduction. |
| high_iso_noise_reduction | Gets the HighISONoiseReduction. |
| digital_lens_optimizer | Gets the DigitalLensOptimizer. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2LightingOptPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2LightingOptPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2LightingOptPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### auto_lighting_optimizer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/auto_lighting_optimizer.md

#### auto_lighting_optimizer property

Gets the AutoLightingOptimizer.
##### Definition:
```python
@property
def auto_lighting_optimizer(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_lens_optimizer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/digital_lens_optimizer.md

#### digital_lens_optimizer property

Gets the DigitalLensOptimizer.
##### Definition:
```python
@property
def digital_lens_optimizer(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### high_iso_noise_reduction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/high_iso_noise_reduction.md

#### high_iso_noise_reduction property

Gets the HighISONoiseReduction.
##### Definition:
```python
@property
def high_iso_noise_reduction(self):
    ...
```

### highlight_tone_priority property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/highlight_tone_priority.md

#### highlight_tone_priority property

Gets the HighlightTonePriority.
##### Definition:
```python
@property
def highlight_tone_priority(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### long_exposure_noise_reduction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/long_exposure_noise_reduction.md

#### long_exposure_noise_reduction property

Gets the LongExposureNoiseReduction.
##### Definition:
```python
@property
def long_exposure_noise_reduction(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### peripheral_illumination_corr property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/peripheral_illumination_corr.md

#### peripheral_illumination_corr property

Gets the PeripheralIlluminationCorr.
##### Definition:
```python
@property
def peripheral_illumination_corr(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/size.md

#### size property

Gets the Size.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2lightingoptpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2LogInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfoindex.md

#### Cr2LogInfoIndex enumeration

Defines ids of Cr2LogInfo tags.

The Cr2LogInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| COMPRESSION_FORMAT | Indicates the CompressionFormat. |
| SHARPNESS | Indicates the Sharpness. |
| SATURATION | Indicates the Saturation. |
| COLOR_TONE | Indicates the ColorTone. |
| COLOR_SPACE2 | Indicates the ColorSpace2. |
| COLOR_MATRIX | Indicates the ColorMatrix. |
| CANON_LOG_VERSION | Indicates the CanonLogVersion. |

### Cr2LogInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage.md

#### Cr2LogInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2LogInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2LogInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2LogInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| compression_format | Gets the CompressionFormat. |
| sharpness | Gets the Sharpness. |
| saturation | Gets the Saturation. |
| color_tone | Gets the ColorTone. |
| color_space2 | Gets the ColorSpace2. |
| color_matrix | Gets the ColorMatrix. |
| canon_log_version | Gets the CanonLogVersion. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2LogInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2LogInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2LogInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### canon_log_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/canon_log_version.md

#### canon_log_version property

Gets the CanonLogVersion.
##### Definition:
```python
@property
def canon_log_version(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_matrix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/color_matrix.md

#### color_matrix property

Gets the ColorMatrix.
##### Definition:
```python
@property
def color_matrix(self):
    ...
```

### color_space2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/color_space2.md

#### color_space2 property

Gets the ColorSpace2.
##### Definition:
```python
@property
def color_space2(self):
    ...
```

### color_tone property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/color_tone.md

#### color_tone property

Gets the ColorTone.
##### Definition:
```python
@property
def color_tone(self):
    ...
```

### compression_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/compression_format.md

#### compression_format property

Gets the CompressionFormat.
##### Definition:
```python
@property
def compression_format(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/saturation.md

#### saturation property

Gets the Saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/sharpness.md

#### sharpness property

Gets the Sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2loginfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2MakerNoteIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernoteindex.md

#### Cr2MakerNoteIndex enumeration

Defines ids of Cr2MakerNote tags.

The Cr2MakerNoteIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CAMERA_SETTINGS | Indicates the CameraSettings. |
| FOCAL_LENGTH | Indicates the FocalLength. |
| SHOT_INFO | Indicates the ShotInfo. |
| PANORAMA | Indicates the Panorama. |
| IMAGE_TYPE | Indicates the ImageType. |
| FIRMWARE_VERSION | Indicates the FirmwareVersion. |
| FILE_NUMBER | Indicates the FileNumber. |
| OWNER_NAME | Indicates the OwnerName. |
| SERIAL_NUMBER | Indicates the SerialNumber. |
| CAMERA_INFO | Indicates the CameraInfo. |
| FILE_LENGTH | Indicates the FileLength. |
| CUSTOM_FUNCTIONS | Indicates the CustomFunctions. |
| MODEL_ID | Indicates the ModelID. |
| MOVIE_INFO | Indicates the MovieInfo. |
| CANON_AF_INFO | Indicates the CanonAFInfo. |
| THUMBNAIL_IMAGE_VALID_AREA | Indicates the ThumbnailImageValidArea. |
| SERIAL_NUMBER_FORMAT | Indicates the SerialNumberFormat. |
| SUPER_MACRO | Indicates the SuperMacro. |
| DATE_STAMP_MODE | Indicates the DateStampMode. |
| MY_COLORS | Indicates the MyColors. |
| CATEGORIES | Indicates the Categories. |
| FACE_DETECT1 | Indicates the FaceDetect1. |
| FACE_DETECT2 | Indicates the FaceDetect2. |
| CANON_AF_INFO2 | Indicates the CanonAFInfo2. |
| CONTRAST_INFO | Indicates the ContrastInfo. |
| IMAGE_UNIQUE_ID | Indicates the ImageUniqueID. |
| WB_INFO | Indicates the WBInfo. |
| FACE_DETECT3 | Indicates the FaceDetect3. |
| TIME_INFO | Indicates the TimeInfo. |
| BATTERY_TYPE | Indicates the BatteryType. |
| AF_INFO3 | Indicates the AFInfo3. |
| RAW_DATA_OFFSET | Indicates the RawDataOffset. |
| ORIGINAL_DECISION_DATA_OFFSET | Indicates the OriginalDecisionDataOffset. |
| CUSTOM_FUNCTIONS_1D | Indicates the CustomFunctions1D. |
| PERSONAL_FUNCTIONS | Indicates the PersonalFunctions. |
| PERSONAL_FUNCTION_VALUES | Indicates the PersonalFunctionValues. |
| CANON_FILE_INFO | Indicates the CanonFileInfo. |
| AF_POINTS_IN_FOCUS_1D | Indicates the AFPointsInFocus1D. |
| LENS_MODEL | Indicates the LensModel. |
| SERIAL_INFO | Indicates the SerialInfo. |
| DUST_REMOVAL_DATA | Indicates the DustRemovalData. |
| CROP_INFO | Indicates the CropInfo. |
| CUSTOM_FUNCTIONS2 | Indicates the CustomFunctions2. |
| ASPECT_INFO | Indicates the AspectInfo. |
| PROCESSING_INFO | Indicates the ProcessingInfo. |
| TONE_CURVE_TABLE | Indicates the ToneCurveTable. |
| SHARPNESS_TABLE | Indicates the SharpnessTable. |
| SHARPNESS_FREQ_TABLE | Indicates the SharpnessFreqTable. |
| WHITE_BALANCE_TABLE | Indicates the WhiteBalanceTable. |
| COLOR_BALANCE | Indicates the ColorBalance. |
| MEASURED_COLOR | Indicates the MeasuredColor. |
| COLOR_TEMPERATURE | Indicates the ColorTemperature. |
| CANON_FLAGS | Indicates the CanonFlags. |
| MODIFIED_INFO | Indicates the ModifiedInfo. |
| TONE_CURVE_MATCHING | Indicates the ToneCurveMatching. |
| WHITE_BALANCE_MATCHING | Indicates the WhiteBalanceMatching. |
| COLOR_SPACE | Indicates the ColorSpace. |
| PREVIEW_IMAGE_INFO | Indicates the PreviewImageInfo. |
| VRD_OFFSET | Indicates the VRDOffset. |
| SENSOR_INFO | Indicates the SensorInfo. |
| COLOR_DATA1 | Indicates the ColorData1. |
| CRW_PARAM | Indicates the CRWParam. |
| COLOR_INFO | Indicates the ColorInfo. |
| FLAVOR | Indicates the Flavor. |
| PICTURE_STYLE_USER_DEF | Indicates the PictureStyleUserDef. |
| PICTURE_STYLE_PC | Indicates the PictureStylePC. |
| CUSTOM_PICTURE_STYLE_FILE_NAME | Indicates the CustomPictureStyleFileName. |
| AF_MICRO_ADJ | Indicates the AFMicroAdj. |
| VIGNETTING_CORR | Indicates the VignettingCorr. |
| VIGNETTING_CORR2 | Indicates the VignettingCorr2. |
| LIGHTING_OPT | Indicates the LightingOpt. |
| LENS_INFO | Indicates the LensInfo. |
| AMBIENCE_INFO | Indicates the AmbienceInfo. |
| MULTI_EXP | Indicates the MultiExp. |
| FILTER_INFO | Indicates the FilterInfo. |
| HDR_INFO | Indicates the HDRInfo. |
| LOG_INFO | Indicates the LogInfo. |
| AF_CONFIG | Indicates the AFConfig. |
| RAW_BURST_MODE_ROLL | Indicates the RawBurstModeRoll. |

### Cr2MakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage.md

#### Cr2MakerNotePackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2MakerNotePackage` →
`RawMakerNotePackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2MakerNotePackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2MakerNotePackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| cr_2_camera_settings_package | Gets the CanonCameraSettings. |
| camera_settings | Gets the CanonCameraSettings Offset. |
| cr_2_focal_length_package | Gets the CanonFocalLength. |
| cr_2_focal_length | Gets the CanonCameraSettings Offset. |
| cr_2_shot_info_package | Gets the CanonShotInfo. |
| cr_2_shot_info | Gets the CanonCameraSettings Offset. |
| cr_2_panorama_package | Gets the CanonPanorama. |
| cr_2_panorama | Gets the CanonCameraSettings Offset. |
| cr_2_movie_info_package | Gets the MovieInfo (Tags written by some Canon cameras when recording video). |
| cr_2_movie_info | Gets the CanonCameraSettings Offset. |
| cr_2af_info_2_package | Gets the AFInfo3 (Newer version of the AFInfo record). |
| cr_2af_info_2 | Gets the CanonCameraSettings Offset. |
| cr_2wb_info_package | Gets the WBInfo (WB tags for the Canon G9). |
| cr_2wb_info | Gets the CanonCameraSettings Offset. |
| cr_2_time_info_package | Gets the TimeInfo. |
| cr_2_time_info | Gets the CanonCameraSettings Offset. |
| cr_2af_info_3_package | Gets the AFInfo3. |
| cr_2af_info_3 | Gets the CanonCameraSettings Offset. |
| cr_2_functions_1d_package | Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.). |
| cr_2_functions_1d | Gets the CanonCameraSettings Offset. |
| cr_2_personal_funcs_package | Gets the PersonalFunctions (Personal function settings for the EOS-1D.). |
| cr_2_personal_funcs | Gets the CanonCameraSettings Offset. |
| cr_2_personal_func_values_package | Gets the PersonalFunctionValues. |
| cr_2_personal_func_values | Gets the CanonCameraSettings Offset. |
| cr_2_file_info_package | Not used in this version. Gets the CanonFileInfo. |
| cr_2_file_info | Gets the CanonCameraSettings Offset. |
| cr_2_crop_info_package | Gets the CropInfo. |
| cr_2_crop_info | Gets the CanonCameraSettings Offset. |
| cr_2_aspect_info_package | Gets the AspectInfo. |
| cr_2_aspect_info | Gets the CanonCameraSettings Offset. |
| cr_2_processing_package | Gets the ProcessingInfo. |
| cr_2_processing | Gets the CanonCameraSettings Offset. |
| cr_2_color_balance_package | Gets the ColorBalance (These tags are used by the 10D and 300D.). |
| cr_2_color_balance | Gets the CanonCameraSettings Offset. |
| cr_2_modified_info_package | Gets the MeasuredColor. |
| cr_2_modified_info | Gets the CanonCameraSettings Offset. |
| cr_2_sensor_info_package | Gets the SensorInfo. |
| cr_2_sensor_info | Gets the CanonCameraSettings Offset. |
| cr_2_color_info_package | Gets the ColorInfo. |
| cr_2_color_info | Gets the CanonCameraSettings Offset. |
| cr_2af_micro_adj_package | Gets the AFMicroAdj. |
| cr_2af_micro_adj | Gets the CanonCameraSettings Offset. |
| cr_2_lighting_opt_package | Gets the LightingOpt (This information is new in images from the EOS 7D.). |
| cr_2_lighting_opt | Gets the CanonCameraSettings Offset. |
| cr_2_multi_exp_package | Gets the MultiExp. |
| cr_2_multi_exp | Gets the CanonCameraSettings Offset. |
| cr_2_log_info_package | Gets the LogInfo. |
| cr_2_log_info | Gets the CanonCameraSettings Offset. |
| cr_2af_config_package | Gets the AFConfig. |
| cr_2af_config | Gets the CanonCameraSettings Offset. |
| image_type | Gets the ImageType. |
| firmware_version | Gets the FirmwareVersion. |
| file_number | Gets the FileNumber. |
| owner_name | Gets the OwnerName. |
| serial_number | Gets the SerialNumber. |
| file_length | Gets the FileLength. |
| model_id | Gets the ModelID. |
| thumbnail_image_valid_area | Gets the ThumbnailImageValidArea. |
| serial_number_format | Gets the SerialNumberFormat. |
| super_macro | Gets the SuperMacro. |
| date_stamp_mode | Gets the DateStampMode. |
| my_colors | Gets the MyColors. |
| contrast_info | Gets the ContrastInfo. |
| categories | Gets the Categories. |
| image_unique_id | Gets the ImageUniqueID. |
| original_decision_data_offset | Gets the OriginalDecisionDataOffset. |
| lens_model | Gets the LensModel. |
| internal_serial_number | Gets the InternalSerialNumber. |
| color_temperature | Gets the ColorTemperature. |
| measured_color | Gets the MeasuredColor. |
| color_space | Gets the ColorSpace. |
| canon_flags | Gets the CanonFlags. |
| vrd_offset | Gets the VRDOffset. |
| picture_style_user_def | Gets the PictureStyleUserDef. |
| picture_style_pc | Gets the PictureStylePC. |
| custom_picture_style_file_name | Gets the CustomPictureStyleFileName. |
| lens_info | Gets the LensInfo. |
| ambience_info | Gets the LensInfo. |
| camera_info | Gets the CameraInfo. |
| custom_functions | Gets the CustomFunctions. |
| face_detect1 | Gets the FaceDetect1. |
| face_detect2 | Gets the FaceDetect2. |
| face_detect3 | Gets the FaceDetect3. |
| preview_image_info | Gets the PreviewImageInfo. |
| color_data1 | Gets the ColorData1. |
| vignetting_corr | Gets the VignettingCorr. |
| hdr_info | Gets the HDRInfo. |
| raw_burst_mode_roll | Gets the RawBurstModeRoll. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2MakerNotePackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2MakerNotePackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2MakerNotePackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### ambience_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/ambience_info.md

#### ambience_info property

Gets the LensInfo.
##### Definition:
```python
@property
def ambience_info(self):
    ...
@ambience_info.setter
def ambience_info(self, value):
    ...
```

### camera_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/camera_info.md

#### camera_info property

Gets the CameraInfo.
##### Definition:
```python
@property
def camera_info(self):
    ...
@camera_info.setter
def camera_info(self, value):
    ...
```

### camera_settings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/camera_settings.md

#### camera_settings property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def camera_settings(self):
    ...
@camera_settings.setter
def camera_settings(self, value):
    ...
```

### canon_flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/canon_flags.md

#### canon_flags property

Gets the CanonFlags.
##### Definition:
```python
@property
def canon_flags(self):
    ...
@canon_flags.setter
def canon_flags(self, value):
    ...
```

### categories property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/categories.md

#### categories property

Gets the Categories.
##### Definition:
```python
@property
def categories(self):
    ...
@categories.setter
def categories(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_data1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/color_data1.md

#### color_data1 property

Gets the ColorData1.
##### Definition:
```python
@property
def color_data1(self):
    ...
@color_data1.setter
def color_data1(self, value):
    ...
```

### color_space property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/color_space.md

#### color_space property

Gets the ColorSpace.
##### Definition:
```python
@property
def color_space(self):
    ...
@color_space.setter
def color_space(self, value):
    ...
```

### color_temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/color_temperature.md

#### color_temperature property

Gets the ColorTemperature.
##### Definition:
```python
@property
def color_temperature(self):
    ...
@color_temperature.setter
def color_temperature(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contrast_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/contrast_info.md

#### contrast_info property

Gets the ContrastInfo.
##### Definition:
```python
@property
def contrast_info(self):
    ...
@contrast_info.setter
def contrast_info(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### cr_2_aspect_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_aspect_info.md

#### cr_2_aspect_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_aspect_info(self):
    ...
@cr_2_aspect_info.setter
def cr_2_aspect_info(self, value):
    ...
```

### cr_2_aspect_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_aspect_info_package.md

#### cr_2_aspect_info_package property

Gets the AspectInfo.
##### Definition:
```python
@property
def cr_2_aspect_info_package(self):
    ...
@cr_2_aspect_info_package.setter
def cr_2_aspect_info_package(self, value):
    ...
```

### cr_2_camera_settings_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_camera_settings_package.md

#### cr_2_camera_settings_package property

Gets the CanonCameraSettings.
##### Definition:
```python
@property
def cr_2_camera_settings_package(self):
    ...
@cr_2_camera_settings_package.setter
def cr_2_camera_settings_package(self, value):
    ...
```

### cr_2_color_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_color_balance.md

#### cr_2_color_balance property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_color_balance(self):
    ...
@cr_2_color_balance.setter
def cr_2_color_balance(self, value):
    ...
```

### cr_2_color_balance_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_color_balance_package.md

#### cr_2_color_balance_package property

Gets the ColorBalance (These tags are used by the 10D and 300D.).
##### Definition:
```python
@property
def cr_2_color_balance_package(self):
    ...
@cr_2_color_balance_package.setter
def cr_2_color_balance_package(self, value):
    ...
```

### cr_2_color_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_color_info.md

#### cr_2_color_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_color_info(self):
    ...
@cr_2_color_info.setter
def cr_2_color_info(self, value):
    ...
```

### cr_2_color_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_color_info_package.md

#### cr_2_color_info_package property

Gets the ColorInfo.
##### Definition:
```python
@property
def cr_2_color_info_package(self):
    ...
@cr_2_color_info_package.setter
def cr_2_color_info_package(self, value):
    ...
```

### cr_2_crop_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_crop_info.md

#### cr_2_crop_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_crop_info(self):
    ...
@cr_2_crop_info.setter
def cr_2_crop_info(self, value):
    ...
```

### cr_2_crop_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_crop_info_package.md

#### cr_2_crop_info_package property

Gets the CropInfo.
##### Definition:
```python
@property
def cr_2_crop_info_package(self):
    ...
@cr_2_crop_info_package.setter
def cr_2_crop_info_package(self, value):
    ...
```

### cr_2_file_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_file_info.md

#### cr_2_file_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_file_info(self):
    ...
@cr_2_file_info.setter
def cr_2_file_info(self, value):
    ...
```

### cr_2_file_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_file_info_package.md

#### cr_2_file_info_package property

Not used in this version. Gets the CanonFileInfo.
##### Definition:
```python
@property
def cr_2_file_info_package(self):
    ...
@cr_2_file_info_package.setter
def cr_2_file_info_package(self, value):
    ...
```

### cr_2_focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_focal_length.md

#### cr_2_focal_length property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_focal_length(self):
    ...
@cr_2_focal_length.setter
def cr_2_focal_length(self, value):
    ...
```

### cr_2_focal_length_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_focal_length_package.md

#### cr_2_focal_length_package property

Gets the CanonFocalLength.
##### Definition:
```python
@property
def cr_2_focal_length_package(self):
    ...
@cr_2_focal_length_package.setter
def cr_2_focal_length_package(self, value):
    ...
```

### cr_2_functions_1d property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_functions_1d.md

#### cr_2_functions_1d property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_functions_1d(self):
    ...
@cr_2_functions_1d.setter
def cr_2_functions_1d(self, value):
    ...
```

### cr_2_functions_1d_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_functions_1d_package.md

#### cr_2_functions_1d_package property

Gets the CustomFunctions1D (These custom functions are used by all 1D models up to but not including the Mark III.).
##### Definition:
```python
@property
def cr_2_functions_1d_package(self):
    ...
@cr_2_functions_1d_package.setter
def cr_2_functions_1d_package(self, value):
    ...
```

### cr_2_lighting_opt property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_lighting_opt.md

#### cr_2_lighting_opt property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_lighting_opt(self):
    ...
@cr_2_lighting_opt.setter
def cr_2_lighting_opt(self, value):
    ...
```

### cr_2_lighting_opt_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_lighting_opt_package.md

#### cr_2_lighting_opt_package property

Gets the LightingOpt (This information is new in images from the EOS 7D.).
##### Definition:
```python
@property
def cr_2_lighting_opt_package(self):
    ...
@cr_2_lighting_opt_package.setter
def cr_2_lighting_opt_package(self, value):
    ...
```

### cr_2_log_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_log_info.md

#### cr_2_log_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_log_info(self):
    ...
@cr_2_log_info.setter
def cr_2_log_info(self, value):
    ...
```

### cr_2_log_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_log_info_package.md

#### cr_2_log_info_package property

Gets the LogInfo.
##### Definition:
```python
@property
def cr_2_log_info_package(self):
    ...
@cr_2_log_info_package.setter
def cr_2_log_info_package(self, value):
    ...
```

### cr_2_modified_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_modified_info.md

#### cr_2_modified_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_modified_info(self):
    ...
@cr_2_modified_info.setter
def cr_2_modified_info(self, value):
    ...
```

### cr_2_modified_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_modified_info_package.md

#### cr_2_modified_info_package property

Gets the MeasuredColor.
##### Definition:
```python
@property
def cr_2_modified_info_package(self):
    ...
@cr_2_modified_info_package.setter
def cr_2_modified_info_package(self, value):
    ...
```

### cr_2_movie_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_movie_info.md

#### cr_2_movie_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_movie_info(self):
    ...
@cr_2_movie_info.setter
def cr_2_movie_info(self, value):
    ...
```

### cr_2_movie_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_movie_info_package.md

#### cr_2_movie_info_package property

Gets the MovieInfo (Tags written by some Canon cameras when recording video).
##### Definition:
```python
@property
def cr_2_movie_info_package(self):
    ...
@cr_2_movie_info_package.setter
def cr_2_movie_info_package(self, value):
    ...
```

### cr_2_multi_exp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_multi_exp.md

#### cr_2_multi_exp property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_multi_exp(self):
    ...
@cr_2_multi_exp.setter
def cr_2_multi_exp(self, value):
    ...
```

### cr_2_multi_exp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_multi_exp_package.md

#### cr_2_multi_exp_package property

Gets the MultiExp.
##### Definition:
```python
@property
def cr_2_multi_exp_package(self):
    ...
@cr_2_multi_exp_package.setter
def cr_2_multi_exp_package(self, value):
    ...
```

### cr_2_panorama property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_panorama.md

#### cr_2_panorama property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_panorama(self):
    ...
@cr_2_panorama.setter
def cr_2_panorama(self, value):
    ...
```

### cr_2_panorama_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_panorama_package.md

#### cr_2_panorama_package property

Gets the CanonPanorama.
##### Definition:
```python
@property
def cr_2_panorama_package(self):
    ...
@cr_2_panorama_package.setter
def cr_2_panorama_package(self, value):
    ...
```

### cr_2_personal_func_values property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_personal_func_values.md

#### cr_2_personal_func_values property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_personal_func_values(self):
    ...
@cr_2_personal_func_values.setter
def cr_2_personal_func_values(self, value):
    ...
```

### cr_2_personal_func_values_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_personal_func_values_package.md

#### cr_2_personal_func_values_package property

Gets the PersonalFunctionValues.
##### Definition:
```python
@property
def cr_2_personal_func_values_package(self):
    ...
@cr_2_personal_func_values_package.setter
def cr_2_personal_func_values_package(self, value):
    ...
```

### cr_2_personal_funcs property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_personal_funcs.md

#### cr_2_personal_funcs property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_personal_funcs(self):
    ...
@cr_2_personal_funcs.setter
def cr_2_personal_funcs(self, value):
    ...
```

### cr_2_personal_funcs_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_personal_funcs_package.md

#### cr_2_personal_funcs_package property

Gets the PersonalFunctions (Personal function settings for the EOS-1D.).
##### Definition:
```python
@property
def cr_2_personal_funcs_package(self):
    ...
@cr_2_personal_funcs_package.setter
def cr_2_personal_funcs_package(self, value):
    ...
```

### cr_2_processing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_processing.md

#### cr_2_processing property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_processing(self):
    ...
@cr_2_processing.setter
def cr_2_processing(self, value):
    ...
```

### cr_2_processing_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_processing_package.md

#### cr_2_processing_package property

Gets the ProcessingInfo.
##### Definition:
```python
@property
def cr_2_processing_package(self):
    ...
@cr_2_processing_package.setter
def cr_2_processing_package(self, value):
    ...
```

### cr_2_sensor_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_sensor_info.md

#### cr_2_sensor_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_sensor_info(self):
    ...
@cr_2_sensor_info.setter
def cr_2_sensor_info(self, value):
    ...
```

### cr_2_sensor_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_sensor_info_package.md

#### cr_2_sensor_info_package property

Gets the SensorInfo.
##### Definition:
```python
@property
def cr_2_sensor_info_package(self):
    ...
@cr_2_sensor_info_package.setter
def cr_2_sensor_info_package(self, value):
    ...
```

### cr_2_shot_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_shot_info.md

#### cr_2_shot_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_shot_info(self):
    ...
@cr_2_shot_info.setter
def cr_2_shot_info(self, value):
    ...
```

### cr_2_shot_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_shot_info_package.md

#### cr_2_shot_info_package property

Gets the CanonShotInfo.
##### Definition:
```python
@property
def cr_2_shot_info_package(self):
    ...
@cr_2_shot_info_package.setter
def cr_2_shot_info_package(self, value):
    ...
```

### cr_2_time_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_time_info.md

#### cr_2_time_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2_time_info(self):
    ...
@cr_2_time_info.setter
def cr_2_time_info(self, value):
    ...
```

### cr_2_time_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2_time_info_package.md

#### cr_2_time_info_package property

Gets the TimeInfo.
##### Definition:
```python
@property
def cr_2_time_info_package(self):
    ...
@cr_2_time_info_package.setter
def cr_2_time_info_package(self, value):
    ...
```

### cr_2af_config property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_config.md

#### cr_2af_config property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2af_config(self):
    ...
@cr_2af_config.setter
def cr_2af_config(self, value):
    ...
```

### cr_2af_config_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_config_package.md

#### cr_2af_config_package property

Gets the AFConfig.
##### Definition:
```python
@property
def cr_2af_config_package(self):
    ...
@cr_2af_config_package.setter
def cr_2af_config_package(self, value):
    ...
```

### cr_2af_info_2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_info_2.md

#### cr_2af_info_2 property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2af_info_2(self):
    ...
@cr_2af_info_2.setter
def cr_2af_info_2(self, value):
    ...
```

### cr_2af_info_2_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_info_2_package.md

#### cr_2af_info_2_package property

Gets the AFInfo3 (Newer version of the AFInfo record).
##### Definition:
```python
@property
def cr_2af_info_2_package(self):
    ...
@cr_2af_info_2_package.setter
def cr_2af_info_2_package(self, value):
    ...
```

### cr_2af_info_3 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_info_3.md

#### cr_2af_info_3 property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2af_info_3(self):
    ...
@cr_2af_info_3.setter
def cr_2af_info_3(self, value):
    ...
```

### cr_2af_info_3_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_info_3_package.md

#### cr_2af_info_3_package property

Gets the AFInfo3.
##### Definition:
```python
@property
def cr_2af_info_3_package(self):
    ...
@cr_2af_info_3_package.setter
def cr_2af_info_3_package(self, value):
    ...
```

### cr_2af_micro_adj property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_micro_adj.md

#### cr_2af_micro_adj property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2af_micro_adj(self):
    ...
@cr_2af_micro_adj.setter
def cr_2af_micro_adj(self, value):
    ...
```

### cr_2af_micro_adj_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2af_micro_adj_package.md

#### cr_2af_micro_adj_package property

Gets the AFMicroAdj.
##### Definition:
```python
@property
def cr_2af_micro_adj_package(self):
    ...
@cr_2af_micro_adj_package.setter
def cr_2af_micro_adj_package(self, value):
    ...
```

### cr_2wb_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2wb_info.md

#### cr_2wb_info property

Gets the CanonCameraSettings Offset.
##### Definition:
```python
@property
def cr_2wb_info(self):
    ...
@cr_2wb_info.setter
def cr_2wb_info(self, value):
    ...
```

### cr_2wb_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/cr_2wb_info_package.md

#### cr_2wb_info_package property

Gets the WBInfo (WB tags for the Canon G9).
##### Definition:
```python
@property
def cr_2wb_info_package(self):
    ...
@cr_2wb_info_package.setter
def cr_2wb_info_package(self, value):
    ...
```

### custom_functions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/custom_functions.md

#### custom_functions property

Gets the CustomFunctions.
##### Definition:
```python
@property
def custom_functions(self):
    ...
@custom_functions.setter
def custom_functions(self, value):
    ...
```

### custom_picture_style_file_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/custom_picture_style_file_name.md

#### custom_picture_style_file_name property

Gets the CustomPictureStyleFileName.
##### Definition:
```python
@property
def custom_picture_style_file_name(self):
    ...
@custom_picture_style_file_name.setter
def custom_picture_style_file_name(self, value):
    ...
```

### date_stamp_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/date_stamp_mode.md

#### date_stamp_mode property

Gets the DateStampMode.
##### Definition:
```python
@property
def date_stamp_mode(self):
    ...
@date_stamp_mode.setter
def date_stamp_mode(self, value):
    ...
```

### face_detect1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/face_detect1.md

#### face_detect1 property

Gets the FaceDetect1.
##### Definition:
```python
@property
def face_detect1(self):
    ...
@face_detect1.setter
def face_detect1(self, value):
    ...
```

### face_detect2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/face_detect2.md

#### face_detect2 property

Gets the FaceDetect2.
##### Definition:
```python
@property
def face_detect2(self):
    ...
@face_detect2.setter
def face_detect2(self, value):
    ...
```

### face_detect3 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/face_detect3.md

#### face_detect3 property

Gets the FaceDetect3.
##### Definition:
```python
@property
def face_detect3(self):
    ...
@face_detect3.setter
def face_detect3(self, value):
    ...
```

### file_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/file_length.md

#### file_length property

Gets the FileLength.
##### Definition:
```python
@property
def file_length(self):
    ...
@file_length.setter
def file_length(self, value):
    ...
```

### file_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/file_number.md

#### file_number property

Gets the FileNumber.
##### Definition:
```python
@property
def file_number(self):
    ...
@file_number.setter
def file_number(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### firmware_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/firmware_version.md

#### firmware_version property

Gets the FirmwareVersion.
##### Definition:
```python
@property
def firmware_version(self):
    ...
@firmware_version.setter
def firmware_version(self, value):
    ...
```

### hdr_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/hdr_info.md

#### hdr_info property

Gets the HDRInfo.
##### Definition:
```python
@property
def hdr_info(self):
    ...
@hdr_info.setter
def hdr_info(self, value):
    ...
```

### image_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/image_type.md

#### image_type property

Gets the ImageType.
##### Definition:
```python
@property
def image_type(self):
    ...
@image_type.setter
def image_type(self, value):
    ...
```

### image_unique_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/image_unique_id.md

#### image_unique_id property

Gets the ImageUniqueID.
##### Definition:
```python
@property
def image_unique_id(self):
    ...
@image_unique_id.setter
def image_unique_id(self, value):
    ...
```

### internal_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/internal_serial_number.md

#### internal_serial_number property

Gets the InternalSerialNumber.
##### Definition:
```python
@property
def internal_serial_number(self):
    ...
@internal_serial_number.setter
def internal_serial_number(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/lens_info.md

#### lens_info property

Gets the LensInfo.
##### Definition:
```python
@property
def lens_info(self):
    ...
@lens_info.setter
def lens_info(self, value):
    ...
```

### lens_model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/lens_model.md

#### lens_model property

Gets the LensModel.
##### Definition:
```python
@property
def lens_model(self):
    ...
@lens_model.setter
def lens_model(self, value):
    ...
```

### measured_color property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/measured_color.md

#### measured_color property

Gets the MeasuredColor.
##### Definition:
```python
@property
def measured_color(self):
    ...
@measured_color.setter
def measured_color(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/model_id.md

#### model_id property

Gets the ModelID.
##### Definition:
```python
@property
def model_id(self):
    ...
@model_id.setter
def model_id(self, value):
    ...
```

### my_colors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/my_colors.md

#### my_colors property

Gets the MyColors.
##### Definition:
```python
@property
def my_colors(self):
    ...
@my_colors.setter
def my_colors(self, value):
    ...
```

### original_decision_data_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/original_decision_data_offset.md

#### original_decision_data_offset property

Gets the OriginalDecisionDataOffset.
##### Definition:
```python
@property
def original_decision_data_offset(self):
    ...
@original_decision_data_offset.setter
def original_decision_data_offset(self, value):
    ...
```

### owner_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/owner_name.md

#### owner_name property

Gets the OwnerName.
##### Definition:
```python
@property
def owner_name(self):
    ...
@owner_name.setter
def owner_name(self, value):
    ...
```

### picture_style_pc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/picture_style_pc.md

#### picture_style_pc property

Gets the PictureStylePC.
##### Definition:
```python
@property
def picture_style_pc(self):
    ...
@picture_style_pc.setter
def picture_style_pc(self, value):
    ...
```

### picture_style_user_def property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/picture_style_user_def.md

#### picture_style_user_def property

Gets the PictureStyleUserDef.
##### Definition:
```python
@property
def picture_style_user_def(self):
    ...
@picture_style_user_def.setter
def picture_style_user_def(self, value):
    ...
```

### preview_image_info property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/preview_image_info.md

#### preview_image_info property

Gets the PreviewImageInfo.
##### Definition:
```python
@property
def preview_image_info(self):
    ...
@preview_image_info.setter
def preview_image_info(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_burst_mode_roll property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/raw_burst_mode_roll.md

#### raw_burst_mode_roll property

Gets the RawBurstModeRoll.
##### Definition:
```python
@property
def raw_burst_mode_roll(self):
    ...
@raw_burst_mode_roll.setter
def raw_burst_mode_roll(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/serial_number.md

#### serial_number property

Gets the SerialNumber.
##### Definition:
```python
@property
def serial_number(self):
    ...
@serial_number.setter
def serial_number(self, value):
    ...
```

### serial_number_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/serial_number_format.md

#### serial_number_format property

Gets the SerialNumberFormat.
##### Definition:
```python
@property
def serial_number_format(self):
    ...
@serial_number_format.setter
def serial_number_format(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### super_macro property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/super_macro.md

#### super_macro property

Gets the SuperMacro.
##### Definition:
```python
@property
def super_macro(self):
    ...
@super_macro.setter
def super_macro(self, value):
    ...
```

### thumbnail_image_valid_area property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/thumbnail_image_valid_area.md

#### thumbnail_image_valid_area property

Gets the ThumbnailImageValidArea.
##### Definition:
```python
@property
def thumbnail_image_valid_area(self):
    ...
@thumbnail_image_valid_area.setter
def thumbnail_image_valid_area(self, value):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### vignetting_corr property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/vignetting_corr.md

#### vignetting_corr property

Gets the VignettingCorr.
##### Definition:
```python
@property
def vignetting_corr(self):
    ...
@vignetting_corr.setter
def vignetting_corr(self, value):
    ...
```

### vrd_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2makernotepackage/vrd_offset.md

#### vrd_offset property

Gets the VRDOffset.
##### Definition:
```python
@property
def vrd_offset(self):
    ...
@vrd_offset.setter
def vrd_offset(self, value):
    ...
```

### Cr2ModifiedInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfoindex.md

#### Cr2ModifiedInfoIndex enumeration

Defines ids of Cr2ModifiedInfo tags.

The Cr2ModifiedInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MODIFIED_TONE_CURVE | Indicates the ModifiedToneCurve. |
| MODIFIED_SHARPNESS | Indicates the ModifiedSharpness. |
| MODIFIED_SHARPNESS_FREQ | Indicates the ModifiedSharpnessFreq. |
| MODIFIED_SENSOR_RED_LEVEL | Indicates the ModifiedSensorRedLevel. |
| MODIFIED_SENSOR_BLUE_LEVEL | Indicates the ModifiedSensorBlueLevel. |
| MODIFIED_WHITE_BALANCE_RED | Indicates the ModifiedWhiteBalanceRed. |
| MODIFIED_WHITE_BALANCE_BLUE | Indicates the ModifiedWhiteBalanceBlue. |
| MODIFIED_WHITE_BALANCE | Indicates the ModifiedWhiteBalance. |
| MODIFIED_COLOR_TEMP | Indicates the ModifiedColorTemp. |
| MODIFIED_PICTURE_STYLE | Indicates the ModifiedPictureStyle. |
| MODIFIED_DIGITAL_GAIN | Indicates the ModifiedDigitalGain. |

### Cr2ModifiedInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage.md

#### Cr2ModifiedInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2ModifiedInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2ModifiedInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2ModifiedInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| modified_tone_curve | Gets the ModifiedToneCurve. |
| modified_sharpness | Gets the ModifiedSharpness. |
| modified_sharpness_freq | Gets the ModifiedSharpnessFreq. |
| modified_sensor_red_level | Gets the ModifiedSensorRedLevel. |
| modified_sensor_blue_level | Gets the ModifiedSensorBlueLevel. |
| modified_white_balance_red | Gets the ModifiedWhiteBalanceRed. |
| modified_white_balance_blue | Gets the ModifiedWhiteBalanceBlue. |
| modified_white_balance | Gets the ModifiedWhiteBalance. |
| modified_color_temp | Gets the ModifiedColorTemp. |
| modified_picture_style | Gets the ModifiedPictureStyle. |
| modified_digital_gain | Gets the ModifiedDigitalGain. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2ModifiedInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2ModifiedInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2ModifiedInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modified_color_temp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_color_temp.md

#### modified_color_temp property

Gets the ModifiedColorTemp.
##### Definition:
```python
@property
def modified_color_temp(self):
    ...
```

### modified_digital_gain property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_digital_gain.md

#### modified_digital_gain property

Gets the ModifiedDigitalGain.
##### Definition:
```python
@property
def modified_digital_gain(self):
    ...
```

### modified_picture_style property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_picture_style.md

#### modified_picture_style property

Gets the ModifiedPictureStyle.
##### Definition:
```python
@property
def modified_picture_style(self):
    ...
```

### modified_sensor_blue_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_sensor_blue_level.md

#### modified_sensor_blue_level property

Gets the ModifiedSensorBlueLevel.
##### Definition:
```python
@property
def modified_sensor_blue_level(self):
    ...
```

### modified_sensor_red_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_sensor_red_level.md

#### modified_sensor_red_level property

Gets the ModifiedSensorRedLevel.
##### Definition:
```python
@property
def modified_sensor_red_level(self):
    ...
```

### modified_sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_sharpness.md

#### modified_sharpness property

Gets the ModifiedSharpness.
##### Definition:
```python
@property
def modified_sharpness(self):
    ...
```

### modified_sharpness_freq property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_sharpness_freq.md

#### modified_sharpness_freq property

Gets the ModifiedSharpnessFreq.
##### Definition:
```python
@property
def modified_sharpness_freq(self):
    ...
```

### modified_tone_curve property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_tone_curve.md

#### modified_tone_curve property

Gets the ModifiedToneCurve.
##### Definition:
```python
@property
def modified_tone_curve(self):
    ...
```

### modified_white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_white_balance.md

#### modified_white_balance property

Gets the ModifiedWhiteBalance.
##### Definition:
```python
@property
def modified_white_balance(self):
    ...
```

### modified_white_balance_blue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_white_balance_blue.md

#### modified_white_balance_blue property

Gets the ModifiedWhiteBalanceBlue.
##### Definition:
```python
@property
def modified_white_balance_blue(self):
    ...
```

### modified_white_balance_red property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/modified_white_balance_red.md

#### modified_white_balance_red property

Gets the ModifiedWhiteBalanceRed.
##### Definition:
```python
@property
def modified_white_balance_red(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2modifiedinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2MovieInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfoindex.md

#### Cr2MovieInfoIndex enumeration

Defines ids of Cr2MovieInfo tags.

The Cr2MovieInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| FRAME_RATE | Indicates the FrameRate. |
| FRAME_COUNT | Indicates the FrameCount. |
| FRAME_COUNT2 | Indicates the FrameCount2. |
| FRAME_RATE2 | Indicates the FrameRate2. |
| DURATION | Indicates the Duration. |
| AUDIO_BITRATE | Indicates the AudioBitrate. |
| AUDIO_SAMPLE_RATE | Indicates the AudioSampleRate. |
| AUDIO_CHANNELS | Indicates the AudioChannels. |
| VIDEO_CODEC | Indicates the VideoCodec. |

### Cr2MovieInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage.md

#### Cr2MovieInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2MovieInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2MovieInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2MovieInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| frame_rate | Gets the FrameRate. |
| frame_count | Gets the FrameCount. |
| frame_count2 | Gets the FrameCount2. |
| frame_rate2 | Gets the FrameRate2. |
| duration | Gets the Duration. |
| audio_bitrate | Gets the AudioBitrate. |
| audio_sample_rate | Gets the AudioSampleRate. |
| audio_channels | Gets the AudioChannels. |
| video_codec | Gets the VideoCodec. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2MovieInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2MovieInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2MovieInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### audio_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audio_bitrate.md

#### audio_bitrate property

Gets the AudioBitrate.
##### Definition:
```python
@property
def audio_bitrate(self):
    ...
```

### audio_channels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audio_channels.md

#### audio_channels property

Gets the AudioChannels.
##### Definition:
```python
@property
def audio_channels(self):
    ...
```

### audio_sample_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/audio_sample_rate.md

#### audio_sample_rate property

Gets the AudioSampleRate.
##### Definition:
```python
@property
def audio_sample_rate(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/duration.md

#### duration property

Gets the Duration.
##### Definition:
```python
@property
def duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### frame_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/frame_count.md

#### frame_count property

Gets the FrameCount.
##### Definition:
```python
@property
def frame_count(self):
    ...
```

### frame_count2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/frame_count2.md

#### frame_count2 property

Gets the FrameCount2.
##### Definition:
```python
@property
def frame_count2(self):
    ...
```

### frame_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/frame_rate.md

#### frame_rate property

Gets the FrameRate.
##### Definition:
```python
@property
def frame_rate(self):
    ...
```

### frame_rate2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/frame_rate2.md

#### frame_rate2 property

Gets the FrameRate2.
##### Definition:
```python
@property
def frame_rate2(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### video_codec property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2movieinfopackage/video_codec.md

#### video_codec property

Gets the VideoCodec.
##### Definition:
```python
@property
def video_codec(self):
    ...
```

### Cr2MultiExpIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexpindex.md

#### Cr2MultiExpIndex enumeration

Defines ids of Cr2MultiExp tags.

The Cr2MultiExpIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| MULTI_EXPOSURE | Indicates the MultiExposure. |
| MULTI_EXPOSURE_CONTROL | Indicates the MultiExposureControl. |
| MULTI_EXPOSURE_SHOTS | Indicates the MultiExposureShots. |
| UNKNOWN2 | Unknown tag. |

### Cr2MultiExpPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage.md

#### Cr2MultiExpPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2MultiExpPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2MultiExpPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2MultiExpPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| multi_exposure | Gets the MultiExposure. |
| multi_exposure_control | Gets the MultiExposureControl. |
| multi_exposure_shots | Gets the MultiExposureShots. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2MultiExpPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2MultiExpPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2MultiExpPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### multi_exposure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multi_exposure.md

#### multi_exposure property

Gets the MultiExposure.
##### Definition:
```python
@property
def multi_exposure(self):
    ...
```

### multi_exposure_control property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multi_exposure_control.md

#### multi_exposure_control property

Gets the MultiExposureControl.
##### Definition:
```python
@property
def multi_exposure_control(self):
    ...
```

### multi_exposure_shots property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/multi_exposure_shots.md

#### multi_exposure_shots property

Gets the MultiExposureShots.
##### Definition:
```python
@property
def multi_exposure_shots(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2multiexppackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package.md

#### Cr2Package class

Represents native CR2 metadata.

**Inheritance:** `Cr2Package` →
`RawPackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| raw_tiff_tag_package | Gets the Tag Support Levels. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_tiff_tag_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/raw_tiff_tag_package.md

#### raw_tiff_tag_package property

Gets the Tag Support Levels.
##### Definition:
```python
@property
def raw_tiff_tag_package(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2PanoramaIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramaindex.md

#### Cr2PanoramaIndex enumeration

Defines ids of Cr2Panorama tags.

The Cr2PanoramaIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PANORAMA_FRAME_NUMBER | Indicates the PanoramaFrameNumber. |
| PANORAMA_DIRECTION | Indicates the PanoramaDirection. |

### Cr2PanoramaPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage.md

#### Cr2PanoramaPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2PanoramaPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2PanoramaPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2PanoramaPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| panorama_frame_number | Gets the PanoramaFrameNumber. |
| panorama_direction | Gets the PanoramaDirection. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2PanoramaPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2PanoramaPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2PanoramaPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### panorama_direction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/panorama_direction.md

#### panorama_direction property

Gets the PanoramaDirection.
##### Definition:
```python
@property
def panorama_direction(self):
    ...
```

### panorama_frame_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/panorama_frame_number.md

#### panorama_frame_number property

Gets the PanoramaFrameNumber.
##### Definition:
```python
@property
def panorama_frame_number(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2panoramapackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2PersonalFuncsIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncsindex.md

#### Cr2PersonalFuncsIndex enumeration

Defines ids of Cr2PersonalFuncs tags.

The Cr2PersonalFuncsIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| PF0_CUSTOM_FUNC_REGISTRATION | Indicates the PF0CustomFuncRegistration. |
| PF1_DISABLE_SHOOTING_MODES | Indicates the PF1DisableShootingModes. |
| PF2_DISABLE_METERING_MODES | Indicates the PF2DisableMeteringModes. |
| PF3_MANUAL_EXPOSURE_METERING | Indicates the PF3ManualExposureMetering. |
| PF4_EXPOSURE_TIME_LIMITS | Indicates the PF4ExposureTimeLimits. |
| PF5_APERTURE_LIMITS | Indicates the PF5ApertureLimits. |
| PF6_PRESET_SHOOTING_MODES | Indicates the PF6PresetShootingModes. |
| PF7_BRACKET_CONTINUOUS_SHOOT | Indicates the PF7BracketContinuousShoot. |
| PF8_SET_BRACKET_SHOTS | Indicates the PF8SetBracketShots. |
| PF9_CHANGE_BRACKET_SEQUENCE | Indicates the PF9ChangeBracketSequence. |
| PF10_RETAIN_PROGRAM_SHIFT | Indicates the PF10RetainProgramShift. |
| PF13_DRIVE_PRIORITY | Indicates the PF13DrivePriority. |
| PF14_DISABLE_FOCUS_SEARCH | Indicates the PF14DisableFocusSearch. |
| PF15_DISABLE_AF_ASSIST_BEAM | Indicates the PF15DisableAFAssistBeam. |
| PF16_AUTO_FOCUS_POINT_SHOOT | Indicates the PF16AutoFocusPointShoot. |
| PF17_DISABLE_AF_POINT_SEL | Indicates the PF17DisableAFPointSel. |
| PF18_ENABLE_AUTO_AF_POINT_SEL | Indicates the PF18EnableAutoAFPointSel. |
| PF19_CONTINUOUS_SHOOT_SPEED | Indicates the PF19ContinuousShootSpeed. |
| PF20_LIMIT_CONTINOUS_SHOTS | Indicates the PF20LimitContinousShots. |
| PF21_ENABLE_QUIET_OPERATION | Indicates the PF21EnableQuietOperation. |
| PF23_SET_TIMER_LENGTHS | Indicates the PF23SetTimerLengths. |
| PF24_LIGHT_LCD_DURING_BULB | Indicates the PF24LightLCDDuringBulb. |
| PF25_DEFAULT_CLEAR_SETTINGS | Indicates the PF25DefaultClearSettings. |
| PF26_SHORTEN_RELEASE_LAG | Indicates the PF26ShortenReleaseLag. |
| PF27_REVERSE_DIAL_ROTATION | Indicates the PF27ReverseDialRotation. |
| PF28_NO_QUICK_DIAL_EXP_COMP | Indicates the PF28NoQuickDialExpComp. |
| PF29_QUICK_DIAL_SWITCH_OFF | Indicates the PF29QuickDialSwitchOff. |
| PF30_ENLARGEMENT_MODE | Indicates the PF30EnlargementMode. |
| PF31_ORIGINAL_DECISION_DATA | Indicates the PF31OriginalDecisionData. |

### Cr2PersonalFuncsPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage.md

#### Cr2PersonalFuncsPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2PersonalFuncsPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2PersonalFuncsPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2PersonalFuncsPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| pf0_custom_func_registration | Gets the PF0CustomFuncRegistration. |
| pf1_disable_shooting_modes | Gets the PF1DisableShootingModes. |
| pf2_disable_metering_modes | Gets the PF2DisableMeteringModes. |
| pf3_manual_exposure_metering | Gets the PF3ManualExposureMetering. |
| pf4_exposure_time_limits | Gets the PF4ExposureTimeLimits. |
| pf5_aperture_limits | Gets the PF5ApertureLimits. |
| pf6_preset_shooting_modes | Gets the PF6PresetShootingModes. |
| pf7_bracket_continuous_shoot | Gets the PF7BracketContinuousShoot. |
| pf8_set_bracket_shots | Gets the PF8SetBracketShots. |
| pf9_change_bracket_sequence | Gets the PF9ChangeBracketSequence. |
| pf10_retain_program_shift | Gets the PF10RetainProgramShift. |
| pf13_drive_priority | Gets the PF13DrivePriority. |
| pf14_disable_focus_search | Gets the PF14DisableFocusSearch. |
| pf15_disable_af_assist_beam | Gets the PF15DisableAFAssistBeam. |
| pf16_auto_focus_point_shoot | Gets the PF16AutoFocusPointShoot. |
| pf17_disable_af_point_sel | Gets the PF17DisableAFPointSel. |
| pf18_enable_auto_af_point_sel | Gets the PF18EnableAutoAFPointSel. |
| pf19_continuous_shoot_speed | Gets the PF19ContinuousShootSpeed. |
| pf20_limit_continous_shots | Gets the PF20LimitContinousShots. |
| pf21_enable_quiet_operation | Gets the PF21EnableQuietOperation. |
| pf23_set_timer_lengths | Gets the PF23SetTimerLengths. |
| pf24_light_lcd_during_bulb | Gets the PF24LightLCDDuringBulb. |
| pf25_default_clear_settings | Gets the PF25DefaultClearSettings. |
| pf26_shorten_release_lag | Gets the PF26ShortenReleaseLag. |
| pf27_reverse_dial_rotation | Gets the PF27ReverseDialRotation. |
| pf28_no_quick_dial_exp_comp | Gets the PF28NoQuickDialExpComp. |
| pf29_quick_dial_switch_off | Gets the PF29QuickDialSwitchOff. |
| pf30_enlargement_mode | Gets the PF30EnlargementMode. |
| pf31_original_decision_data | Gets the PF31OriginalDecisionData. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2PersonalFuncsPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2PersonalFuncsPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2PersonalFuncsPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pf0_custom_func_registration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf0_custom_func_registration.md

#### pf0_custom_func_registration property

Gets the PF0CustomFuncRegistration.
##### Definition:
```python
@property
def pf0_custom_func_registration(self):
    ...
```

### pf10_retain_program_shift property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf10_retain_program_shift.md

#### pf10_retain_program_shift property

Gets the PF10RetainProgramShift.
##### Definition:
```python
@property
def pf10_retain_program_shift(self):
    ...
```

### pf13_drive_priority property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf13_drive_priority.md

#### pf13_drive_priority property

Gets the PF13DrivePriority.
##### Definition:
```python
@property
def pf13_drive_priority(self):
    ...
```

### pf14_disable_focus_search property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf14_disable_focus_search.md

#### pf14_disable_focus_search property

Gets the PF14DisableFocusSearch.
##### Definition:
```python
@property
def pf14_disable_focus_search(self):
    ...
```

### pf15_disable_af_assist_beam property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf15_disable_af_assist_beam.md

#### pf15_disable_af_assist_beam property

Gets the PF15DisableAFAssistBeam.
##### Definition:
```python
@property
def pf15_disable_af_assist_beam(self):
    ...
```

### pf16_auto_focus_point_shoot property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf16_auto_focus_point_shoot.md

#### pf16_auto_focus_point_shoot property

Gets the PF16AutoFocusPointShoot.
##### Definition:
```python
@property
def pf16_auto_focus_point_shoot(self):
    ...
```

### pf17_disable_af_point_sel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf17_disable_af_point_sel.md

#### pf17_disable_af_point_sel property

Gets the PF17DisableAFPointSel.
##### Definition:
```python
@property
def pf17_disable_af_point_sel(self):
    ...
```

### pf18_enable_auto_af_point_sel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf18_enable_auto_af_point_sel.md

#### pf18_enable_auto_af_point_sel property

Gets the PF18EnableAutoAFPointSel.
##### Definition:
```python
@property
def pf18_enable_auto_af_point_sel(self):
    ...
```

### pf19_continuous_shoot_speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf19_continuous_shoot_speed.md

#### pf19_continuous_shoot_speed property

Gets the PF19ContinuousShootSpeed.
##### Definition:
```python
@property
def pf19_continuous_shoot_speed(self):
    ...
```

### pf1_disable_shooting_modes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf1_disable_shooting_modes.md

#### pf1_disable_shooting_modes property

Gets the PF1DisableShootingModes.
##### Definition:
```python
@property
def pf1_disable_shooting_modes(self):
    ...
```

### pf20_limit_continous_shots property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf20_limit_continous_shots.md

#### pf20_limit_continous_shots property

Gets the PF20LimitContinousShots.
##### Definition:
```python
@property
def pf20_limit_continous_shots(self):
    ...
```

### pf21_enable_quiet_operation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf21_enable_quiet_operation.md

#### pf21_enable_quiet_operation property

Gets the PF21EnableQuietOperation.
##### Definition:
```python
@property
def pf21_enable_quiet_operation(self):
    ...
```

### pf23_set_timer_lengths property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf23_set_timer_lengths.md

#### pf23_set_timer_lengths property

Gets the PF23SetTimerLengths.
##### Definition:
```python
@property
def pf23_set_timer_lengths(self):
    ...
```

### pf24_light_lcd_during_bulb property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf24_light_lcd_during_bulb.md

#### pf24_light_lcd_during_bulb property

Gets the PF24LightLCDDuringBulb.
##### Definition:
```python
@property
def pf24_light_lcd_during_bulb(self):
    ...
```

### pf25_default_clear_settings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf25_default_clear_settings.md

#### pf25_default_clear_settings property

Gets the PF25DefaultClearSettings.
##### Definition:
```python
@property
def pf25_default_clear_settings(self):
    ...
```

### pf26_shorten_release_lag property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf26_shorten_release_lag.md

#### pf26_shorten_release_lag property

Gets the PF26ShortenReleaseLag.
##### Definition:
```python
@property
def pf26_shorten_release_lag(self):
    ...
```

### pf27_reverse_dial_rotation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf27_reverse_dial_rotation.md

#### pf27_reverse_dial_rotation property

Gets the PF27ReverseDialRotation.
##### Definition:
```python
@property
def pf27_reverse_dial_rotation(self):
    ...
```

### pf28_no_quick_dial_exp_comp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf28_no_quick_dial_exp_comp.md

#### pf28_no_quick_dial_exp_comp property

Gets the PF28NoQuickDialExpComp.
##### Definition:
```python
@property
def pf28_no_quick_dial_exp_comp(self):
    ...
```

### pf29_quick_dial_switch_off property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf29_quick_dial_switch_off.md

#### pf29_quick_dial_switch_off property

Gets the PF29QuickDialSwitchOff.
##### Definition:
```python
@property
def pf29_quick_dial_switch_off(self):
    ...
```

### pf2_disable_metering_modes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf2_disable_metering_modes.md

#### pf2_disable_metering_modes property

Gets the PF2DisableMeteringModes.
##### Definition:
```python
@property
def pf2_disable_metering_modes(self):
    ...
```

### pf30_enlargement_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf30_enlargement_mode.md

#### pf30_enlargement_mode property

Gets the PF30EnlargementMode.
##### Definition:
```python
@property
def pf30_enlargement_mode(self):
    ...
```

### pf31_original_decision_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf31_original_decision_data.md

#### pf31_original_decision_data property

Gets the PF31OriginalDecisionData.
##### Definition:
```python
@property
def pf31_original_decision_data(self):
    ...
```

### pf3_manual_exposure_metering property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf3_manual_exposure_metering.md

#### pf3_manual_exposure_metering property

Gets the PF3ManualExposureMetering.
##### Definition:
```python
@property
def pf3_manual_exposure_metering(self):
    ...
```

### pf4_exposure_time_limits property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf4_exposure_time_limits.md

#### pf4_exposure_time_limits property

Gets the PF4ExposureTimeLimits.
##### Definition:
```python
@property
def pf4_exposure_time_limits(self):
    ...
```

### pf5_aperture_limits property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf5_aperture_limits.md

#### pf5_aperture_limits property

Gets the PF5ApertureLimits.
##### Definition:
```python
@property
def pf5_aperture_limits(self):
    ...
```

### pf6_preset_shooting_modes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf6_preset_shooting_modes.md

#### pf6_preset_shooting_modes property

Gets the PF6PresetShootingModes.
##### Definition:
```python
@property
def pf6_preset_shooting_modes(self):
    ...
```

### pf7_bracket_continuous_shoot property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf7_bracket_continuous_shoot.md

#### pf7_bracket_continuous_shoot property

Gets the PF7BracketContinuousShoot.
##### Definition:
```python
@property
def pf7_bracket_continuous_shoot(self):
    ...
```

### pf8_set_bracket_shots property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf8_set_bracket_shots.md

#### pf8_set_bracket_shots property

Gets the PF8SetBracketShots.
##### Definition:
```python
@property
def pf8_set_bracket_shots(self):
    ...
```

### pf9_change_bracket_sequence property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/pf9_change_bracket_sequence.md

#### pf9_change_bracket_sequence property

Gets the PF9ChangeBracketSequence.
##### Definition:
```python
@property
def pf9_change_bracket_sequence(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2PersonalFuncValuesIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluesindex.md

#### Cr2PersonalFuncValuesIndex enumeration

Defines ids of Cr2PersonalFuncValues tags.

The Cr2PersonalFuncValuesIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| PF1_VALUE | Indicates the PF1Value. |
| PF2_VALUE | Indicates the PF2Value. |
| PF3_VALUE | Indicates the PF3Value. |
| PF4_EXPOSURE_TIME_MIN | Indicates the PF4ExposureTimeMin. |
| PF4_EXPOSURE_TIME_MAX | Indicates the PF4ExposureTimeMax. |
| PF5_APERTURE_MIN | Indicates the PF5ApertureMin. |
| PF5_APERTURE_MAX | Indicates the PF5ApertureMax. |
| PF8_BRACKET_SHOTS | Indicates the PF8BracketShots. |
| PF19_SHOOTING_SPEED_LOW | Indicates the PF19ShootingSpeedLow. |
| PF19_SHOOTING_SPEED_HIGH | Indicates the PF19ShootingSpeedHigh. |
| PF20_MAX_CONTINOUS_SHOTS | Indicates the PF20MaxContinousShots. |
| PF23_SHUTTER_BUTTON_TIME | Indicates the PF23ShutterButtonTime. |
| PF23FE_LOCK_TIME | Indicates the PF23FELockTime. |
| PF23_POST_RELEASE_TIME | Indicates the PF23PostReleaseTime. |
| PF25AE_MODE | Indicates the PF25AEMode. |
| PF25_METERING_MODE | Indicates the PF25MeteringMode. |
| PF25_DRIVE_MODE | Indicates the PF25DriveMode. |
| PF25AF_MODE | Indicates the PF25AFMode. |
| PF25AF_POINT_SEL | Indicates the PF25AFPointSel. |
| PF25_IMAGE_SIZE | Indicates the PF25ImageSize. |
| PF25WB_MODE | Indicates the PF25WBMode. |
| PF25_PARAMETERS | Indicates the PF25Parameters. |
| PF25_COLOR_MATRIX | Indicates the PF25ColorMatrix. |
| PF27_VALUE | Indicates the PF27Value. |

### Cr2PersonalFuncValuesPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage.md

#### Cr2PersonalFuncValuesPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2PersonalFuncValuesPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2PersonalFuncValuesPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2PersonalFuncValuesPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| pf1_value | Gets the PF1Value. |
| pf2_value | Gets the PF2Value. |
| pf3_value | Gets the PF3Value. |
| pf4_exposure_time_min | Gets the PF4ExposureTimeMin. |
| pf4_exposure_time_max | Gets the PF4ExposureTimeMax. |
| pf5_aperture_min | Gets the PF5ApertureMin. |
| pf5_aperture_max | Gets the PF5ApertureMax. |
| pf8_bracket_shots | Gets the PF8BracketShots. |
| pf19_shooting_speed_low | Gets the PF19ShootingSpeedLow. |
| pf19_shooting_speed_high | Gets the PF19ShootingSpeedHigh. |
| pf20_max_continous_shots | Gets the PF20MaxContinousShots. |
| pf23_shutter_button_time | Gets the PF23ShutterButtonTime. |
| pf23fe_lock_time | Gets the PF23FELockTime. |
| pf23_post_release_time | Gets the PF23PostReleaseTime. |
| pf25ae_mode | Gets the PF25AEMode. |
| pf25_metering_mode | Gets the PF25MeteringMode. |
| pf25_drive_mode | Gets the PF25DriveMode. |
| pf25af_mode | Gets the PF25AFMode. |
| pf25af_point_sel | Gets the PF25AFPointSel. |
| pf25_image_size | Gets the PF25ImageSize. |
| pf25wb_mode | Gets the PF25WBMode. |
| pf25_parameters | Gets the PF25Parameters. |
| pf25_color_matrix | Gets the PF25ColorMatrix. |
| pf27_value | Gets the PF27Value. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2PersonalFuncValuesPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2PersonalFuncValuesPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2PersonalFuncValuesPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### pf19_shooting_speed_high property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf19_shooting_speed_high.md

#### pf19_shooting_speed_high property

Gets the PF19ShootingSpeedHigh.
##### Definition:
```python
@property
def pf19_shooting_speed_high(self):
    ...
```

### pf19_shooting_speed_low property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf19_shooting_speed_low.md

#### pf19_shooting_speed_low property

Gets the PF19ShootingSpeedLow.
##### Definition:
```python
@property
def pf19_shooting_speed_low(self):
    ...
```

### pf1_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf1_value.md

#### pf1_value property

Gets the PF1Value.
##### Definition:
```python
@property
def pf1_value(self):
    ...
```

### pf20_max_continous_shots property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf20_max_continous_shots.md

#### pf20_max_continous_shots property

Gets the PF20MaxContinousShots.
##### Definition:
```python
@property
def pf20_max_continous_shots(self):
    ...
```

### pf23_post_release_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23_post_release_time.md

#### pf23_post_release_time property

Gets the PF23PostReleaseTime.
##### Definition:
```python
@property
def pf23_post_release_time(self):
    ...
```

### pf23_shutter_button_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23_shutter_button_time.md

#### pf23_shutter_button_time property

Gets the PF23ShutterButtonTime.
##### Definition:
```python
@property
def pf23_shutter_button_time(self):
    ...
```

### pf23fe_lock_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf23fe_lock_time.md

#### pf23fe_lock_time property

Gets the PF23FELockTime.
##### Definition:
```python
@property
def pf23fe_lock_time(self):
    ...
```

### pf25_color_matrix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25_color_matrix.md

#### pf25_color_matrix property

Gets the PF25ColorMatrix.
##### Definition:
```python
@property
def pf25_color_matrix(self):
    ...
```

### pf25_drive_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25_drive_mode.md

#### pf25_drive_mode property

Gets the PF25DriveMode.
##### Definition:
```python
@property
def pf25_drive_mode(self):
    ...
```

### pf25_image_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25_image_size.md

#### pf25_image_size property

Gets the PF25ImageSize.
##### Definition:
```python
@property
def pf25_image_size(self):
    ...
```

### pf25_metering_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25_metering_mode.md

#### pf25_metering_mode property

Gets the PF25MeteringMode.
##### Definition:
```python
@property
def pf25_metering_mode(self):
    ...
```

### pf25_parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25_parameters.md

#### pf25_parameters property

Gets the PF25Parameters.
##### Definition:
```python
@property
def pf25_parameters(self):
    ...
```

### pf25ae_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25ae_mode.md

#### pf25ae_mode property

Gets the PF25AEMode.
##### Definition:
```python
@property
def pf25ae_mode(self):
    ...
```

### pf25af_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25af_mode.md

#### pf25af_mode property

Gets the PF25AFMode.
##### Definition:
```python
@property
def pf25af_mode(self):
    ...
```

### pf25af_point_sel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25af_point_sel.md

#### pf25af_point_sel property

Gets the PF25AFPointSel.
##### Definition:
```python
@property
def pf25af_point_sel(self):
    ...
```

### pf25wb_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf25wb_mode.md

#### pf25wb_mode property

Gets the PF25WBMode.
##### Definition:
```python
@property
def pf25wb_mode(self):
    ...
```

### pf27_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf27_value.md

#### pf27_value property

Gets the PF27Value.
##### Definition:
```python
@property
def pf27_value(self):
    ...
```

### pf2_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf2_value.md

#### pf2_value property

Gets the PF2Value.
##### Definition:
```python
@property
def pf2_value(self):
    ...
```

### pf3_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf3_value.md

#### pf3_value property

Gets the PF3Value.
##### Definition:
```python
@property
def pf3_value(self):
    ...
```

### pf4_exposure_time_max property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf4_exposure_time_max.md

#### pf4_exposure_time_max property

Gets the PF4ExposureTimeMax.
##### Definition:
```python
@property
def pf4_exposure_time_max(self):
    ...
```

### pf4_exposure_time_min property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf4_exposure_time_min.md

#### pf4_exposure_time_min property

Gets the PF4ExposureTimeMin.
##### Definition:
```python
@property
def pf4_exposure_time_min(self):
    ...
```

### pf5_aperture_max property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf5_aperture_max.md

#### pf5_aperture_max property

Gets the PF5ApertureMax.
##### Definition:
```python
@property
def pf5_aperture_max(self):
    ...
```

### pf5_aperture_min property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf5_aperture_min.md

#### pf5_aperture_min property

Gets the PF5ApertureMin.
##### Definition:
```python
@property
def pf5_aperture_min(self):
    ...
```

### pf8_bracket_shots property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/pf8_bracket_shots.md

#### pf8_bracket_shots property

Gets the PF8BracketShots.
##### Definition:
```python
@property
def pf8_bracket_shots(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2personalfuncvaluespackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2ProcessingIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingindex.md

#### Cr2ProcessingIndex enumeration

Defines ids of Cr2Processing tags.

The Cr2ProcessingIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| TONE_CURVE | Indicates the ToneCurve. |
| SHARPNESS | Indicates the Sharpness. |
| SHARPNESS_FREQUENCY | Indicates the SharpnessFrequency. |
| SENSOR_RED_LEVEL | Indicates the SensorRedLevel. |
| SENSOR_BLUE_LEVEL | Indicates the SensorBlueLevel. |
| WHITE_BALANCE_RED | Indicates the WhiteBalanceRed. |
| WHITE_BALANCE_BLUE | Indicates the WhiteBalanceBlue. |
| WHITE_BALANCE | Indicates the WhiteBalance. |
| COLOR_TEMPERATURE | Indicates the ColorTemperature. |
| PICTURE_STYLE | Indicates the PictureStyle. |
| DIGITAL_GAIN | Indicates the DigitalGain. |
| WB_SHIFT_AB | Indicates the WBShiftAB. |
| WB_SHIFT_GM | Indicates the WBShiftGM. |

### Cr2ProcessingPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage.md

#### Cr2ProcessingPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2ProcessingPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2ProcessingPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2ProcessingPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| tone_curve | Gets the ToneCurve. |
| sharpness | Gets the Sharpness. |
| sharpness_frequency | Gets the SharpnessFrequency. |
| sensor_red_level | Gets the SensorRedLevel. |
| sensor_blue_level | Gets the SensorBlueLevel. |
| white_balance_red | Gets the WhiteBalanceRed. |
| white_balance_blue | Gets the WhiteBalanceBlue. |
| white_balance | Gets the WhiteBalance. |
| color_temperature | Gets the ColorTemperature. |
| picture_style | Gets the PictureStyle. |
| digital_gain | Gets the DigitalGain. |
| wb_shift_ab | Gets the WBShiftAB. |
| wb_shift_gm | Gets the WBShiftGM. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2ProcessingPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2ProcessingPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2ProcessingPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/color_temperature.md

#### color_temperature property

Gets the ColorTemperature.
##### Definition:
```python
@property
def color_temperature(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_gain property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/digital_gain.md

#### digital_gain property

Gets the DigitalGain.
##### Definition:
```python
@property
def digital_gain(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### picture_style property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/picture_style.md

#### picture_style property

Gets the PictureStyle.
##### Definition:
```python
@property
def picture_style(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sensor_blue_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sensor_blue_level.md

#### sensor_blue_level property

Gets the SensorBlueLevel.
##### Definition:
```python
@property
def sensor_blue_level(self):
    ...
```

### sensor_red_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sensor_red_level.md

#### sensor_red_level property

Gets the SensorRedLevel.
##### Definition:
```python
@property
def sensor_red_level(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sharpness.md

#### sharpness property

Gets the Sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### sharpness_frequency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/sharpness_frequency.md

#### sharpness_frequency property

Gets the SharpnessFrequency.
##### Definition:
```python
@property
def sharpness_frequency(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### tone_curve property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/tone_curve.md

#### tone_curve property

Gets the ToneCurve.
##### Definition:
```python
@property
def tone_curve(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### wb_shift_ab property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/wb_shift_ab.md

#### wb_shift_ab property

Gets the WBShiftAB.
##### Definition:
```python
@property
def wb_shift_ab(self):
    ...
```

### wb_shift_gm property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/wb_shift_gm.md

#### wb_shift_gm property

Gets the WBShiftGM.
##### Definition:
```python
@property
def wb_shift_gm(self):
    ...
```

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/white_balance.md

#### white_balance property

Gets the WhiteBalance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### white_balance_blue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/white_balance_blue.md

#### white_balance_blue property

Gets the WhiteBalanceBlue.
##### Definition:
```python
@property
def white_balance_blue(self):
    ...
```

### white_balance_red property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2processingpackage/white_balance_red.md

#### white_balance_red property

Gets the WhiteBalanceRed.
##### Definition:
```python
@property
def white_balance_red(self):
    ...
```

### Cr2RootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage.md

#### Cr2RootPackage class

Represents an entry point to all metadata packages presented in a particular file CR2.

**Inheritance:** `Cr2RootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The Cr2RootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| cr_2_package | Gets the CR2 header metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### cr_2_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/cr_2_package.md

#### cr_2_package property

Gets the CR2 header metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def cr_2_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2rootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2SensorInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfoindex.md

#### Cr2SensorInfoIndex enumeration

Defines ids of Cr2SensorInfo tags.

The Cr2SensorInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| SENSOR_WIDTH | Indicates the SensorWidth. |
| SENSOR_HEIGHT | Indicates the SensorHeight. |
| UNKNOWN2 | Unknown tag. |
| UNKNOWN3 | Unknown tag. |
| SENSOR_LEFT_BORDER | Indicates the SensorLeftBorder. |
| SENSOR_TOP_BORDER | Indicates the SensorTopBorder. |
| SENSOR_RIGHT_BORDER | Indicates the SensorRightBorder. |
| SENSOR_BOTTOM_BORDER | Indicates the SensorBottomBorder. |
| BLACK_MASK_LEFT_BORDER | Indicates the BlackMaskLeftBorder. |
| BLACK_MASK_TOP_BORDER | Indicates the BlackMaskTopBorder. |
| BLACK_MASK_RIGHT_BORDER | Indicates the BlackMaskRightBorder. |
| BLACK_MASK_BOTTOM_BORDER | Indicates the BlackMaskBottomBorder. |

### Cr2SensorInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage.md

#### Cr2SensorInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2SensorInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2SensorInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2SensorInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| sensor_width | Gets the SensorWidth. |
| sensor_height | Gets the SensorHeight. |
| sensor_left_border | Gets the SensorLeftBorder. |
| sensor_top_border | Gets the SensorTopBorder. |
| sensor_right_border | Gets the SensorRightBorder. |
| sensor_bottom_border | Gets the SensorBottomBorder. |
| black_mask_left_border | Gets the BlackMaskLeftBorder. |
| black_mask_top_border | Gets the BlackMaskTopBorder. |
| black_mask_right_border | Gets the BlackMaskRightBorder. |
| black_mask_bottom_border | Gets the BlackMaskBottomBorder. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2SensorInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2SensorInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2SensorInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### black_mask_bottom_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/black_mask_bottom_border.md

#### black_mask_bottom_border property

Gets the BlackMaskBottomBorder.
##### Definition:
```python
@property
def black_mask_bottom_border(self):
    ...
```

### black_mask_left_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/black_mask_left_border.md

#### black_mask_left_border property

Gets the BlackMaskLeftBorder.
##### Definition:
```python
@property
def black_mask_left_border(self):
    ...
```

### black_mask_right_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/black_mask_right_border.md

#### black_mask_right_border property

Gets the BlackMaskRightBorder.
##### Definition:
```python
@property
def black_mask_right_border(self):
    ...
```

### black_mask_top_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/black_mask_top_border.md

#### black_mask_top_border property

Gets the BlackMaskTopBorder.
##### Definition:
```python
@property
def black_mask_top_border(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### sensor_bottom_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_bottom_border.md

#### sensor_bottom_border property

Gets the SensorBottomBorder.
##### Definition:
```python
@property
def sensor_bottom_border(self):
    ...
```

### sensor_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_height.md

#### sensor_height property

Gets the SensorHeight.
##### Definition:
```python
@property
def sensor_height(self):
    ...
```

### sensor_left_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_left_border.md

#### sensor_left_border property

Gets the SensorLeftBorder.
##### Definition:
```python
@property
def sensor_left_border(self):
    ...
```

### sensor_right_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_right_border.md

#### sensor_right_border property

Gets the SensorRightBorder.
##### Definition:
```python
@property
def sensor_right_border(self):
    ...
```

### sensor_top_border property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_top_border.md

#### sensor_top_border property

Gets the SensorTopBorder.
##### Definition:
```python
@property
def sensor_top_border(self):
    ...
```

### sensor_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/sensor_width.md

#### sensor_width property

Gets the SensorWidth.
##### Definition:
```python
@property
def sensor_width(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2sensorinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2ShotInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfoindex.md

#### Cr2ShotInfoIndex enumeration

Defines ids of Cr2ShotInfo tags.

The Cr2ShotInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| AUTO_ISO | Indicates the AutoISO. |
| BASE_ISO | Indicates the BaseISO. |
| MEASURED_EV | Indicates the MeasuredEV. |
| TARGET_APERTURE | Indicates the TargetAperture. |
| TARGET_EXPOSURE_TIME | Indicates the TargetExposureTime. |
| EXPOSURE_COMPENSATION | Indicates the ExposureCompensation. |
| WHITE_BALANCE | Indicates the WhiteBalance. |
| SLOW_SHUTTER | Indicates the SlowShutter. |
| SEQUENCE_NUMBER | Indicates the SequenceNumber. |
| OPTICAL_ZOOM_CODE | Indicates the OpticalZoomCode. |
| UNKNOWN2 | Unknown tag. |
| CAMERA_TEMPERATURE | Indicates the CameraTemperature. |
| FLASH_GUIDE_NUMBER | Indicates the FlashGuideNumber. |
| AF_POINTS_IN_FOCUS | Indicates the AFPointsInFocus. |
| FLASH_EXPOSURE_COMP | Indicates the FlashExposureComp. |
| AUTO_EXPOSURE_BRACKETING | Indicates the AutoExposureBracketing. |
| AEB_BRACKET_VALUE | Indicates the AEBBracketValue. |
| CONTROL_MODE | Indicates the ControlMode. |
| FOCUS_DISTANCE_UPPER | Indicates the FocusDistanceUpper. |
| FOCUS_DISTANCE_LOWER | Indicates the FocusDistanceLower. |
| F_NUMBER | Indicates the FNumber. |
| EXPOSURE_TIME | Indicates the ExposureTime. |
| MEASURED_EV2 | Indicates the MeasuredEV2. |
| BULB_DURATION | Indicates the BulbDuration. |
| UNKNOWN3 | Unknown tag. |
| CAMERA_TYPE | Indicates the CameraType. |
| AUTO_ROTATE | Indicates the AutoRotate. |
| ND_FILTER | Indicates the NDFilter. |
| SELF_TIMER2 | Indicates the SelfTimer2. |
| UNKNOWN4 | Unknown tag. |
| UNKNOWN5 | Unknown tag. |
| UNKNOWN6 | Unknown tag. |
| FLASH_OUTPUT | Indicates the FlashOutput. |

### Cr2ShotInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage.md

#### Cr2ShotInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2ShotInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2ShotInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2ShotInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| auto_iso | Gets the AutoISO. |
| base_iso | Gets the BaseISO. |
| measured_ev | Gets the MeasuredEV. |
| target_aperture | Gets the TargetAperture. |
| target_exposure_time | Gets the TargetExposureTime. |
| exposure_compensation | Gets the ExposureCompensation. |
| white_balance | Gets the WhiteBalance. |
| slow_shutter | Gets the SlowShutter. |
| sequence_number | Gets the SequenceNumber. |
| optical_zoom_code | Gets the OpticalZoomCode. |
| camera_temperature | Gets the CameraTemperature. |
| flash_guide_number | Gets the FlashGuideNumber. |
| af_points_in_focus | Gets the AFPointsInFocus. |
| flash_exposure_comp | Gets the FlashExposureComp. |
| auto_exposure_bracketing | Gets the AutoExposureBracketing. |
| aeb_bracket_value | Gets the AEBBracketValue. |
| control_mode | Gets the ControlMode. |
| focus_distance_upper | Gets the FocusDistanceUpper. |
| focus_distance_lower | Gets the FocusDistanceLower. |
| f_number | Gets the FNumber. |
| exposure_time | Gets the ExposureTime. |
| measured_ev2 | Gets the MeasuredEV2. |
| bulb_duration | Gets the BulbDuration. |
| camera_type | Gets the CameraType. |
| auto_rotate | Gets the AutoRotate. |
| nd_filter | Gets the NDFilter. |
| self_timer2 | Gets the SelfTimer2. |
| flash_output | Gets the FlashOutput. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2ShotInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2ShotInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2ShotInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### aeb_bracket_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/aeb_bracket_value.md

#### aeb_bracket_value property

Gets the AEBBracketValue.
##### Definition:
```python
@property
def aeb_bracket_value(self):
    ...
```

### af_points_in_focus property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/af_points_in_focus.md

#### af_points_in_focus property

Gets the AFPointsInFocus.
##### Definition:
```python
@property
def af_points_in_focus(self):
    ...
```

### auto_exposure_bracketing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/auto_exposure_bracketing.md

#### auto_exposure_bracketing property

Gets the AutoExposureBracketing.
##### Definition:
```python
@property
def auto_exposure_bracketing(self):
    ...
```

### auto_iso property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/auto_iso.md

#### auto_iso property

Gets the AutoISO.
##### Definition:
```python
@property
def auto_iso(self):
    ...
```

### auto_rotate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/auto_rotate.md

#### auto_rotate property

Gets the AutoRotate.
##### Definition:
```python
@property
def auto_rotate(self):
    ...
```

### base_iso property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/base_iso.md

#### base_iso property

Gets the BaseISO.
##### Definition:
```python
@property
def base_iso(self):
    ...
```

### bulb_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/bulb_duration.md

#### bulb_duration property

Gets the BulbDuration.
##### Definition:
```python
@property
def bulb_duration(self):
    ...
```

### camera_temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/camera_temperature.md

#### camera_temperature property

Gets the CameraTemperature.
##### Definition:
```python
@property
def camera_temperature(self):
    ...
```

### camera_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/camera_type.md

#### camera_type property

Gets the CameraType.
##### Definition:
```python
@property
def camera_type(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### control_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/control_mode.md

#### control_mode property

Gets the ControlMode.
##### Definition:
```python
@property
def control_mode(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### exposure_compensation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/exposure_compensation.md

#### exposure_compensation property

Gets the ExposureCompensation.
##### Definition:
```python
@property
def exposure_compensation(self):
    ...
```

### exposure_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/exposure_time.md

#### exposure_time property

Gets the ExposureTime.
##### Definition:
```python
@property
def exposure_time(self):
    ...
```

### f_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/f_number.md

#### f_number property

Gets the FNumber.
##### Definition:
```python
@property
def f_number(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash_exposure_comp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flash_exposure_comp.md

#### flash_exposure_comp property

Gets the FlashExposureComp.
##### Definition:
```python
@property
def flash_exposure_comp(self):
    ...
```

### flash_guide_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flash_guide_number.md

#### flash_guide_number property

Gets the FlashGuideNumber.
##### Definition:
```python
@property
def flash_guide_number(self):
    ...
```

### flash_output property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/flash_output.md

#### flash_output property

Gets the FlashOutput.
##### Definition:
```python
@property
def flash_output(self):
    ...
```

### focus_distance_lower property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/focus_distance_lower.md

#### focus_distance_lower property

Gets the FocusDistanceLower.
##### Definition:
```python
@property
def focus_distance_lower(self):
    ...
```

### focus_distance_upper property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/focus_distance_upper.md

#### focus_distance_upper property

Gets the FocusDistanceUpper.
##### Definition:
```python
@property
def focus_distance_upper(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### measured_ev property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/measured_ev.md

#### measured_ev property

Gets the MeasuredEV.
##### Definition:
```python
@property
def measured_ev(self):
    ...
```

### measured_ev2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/measured_ev2.md

#### measured_ev2 property

Gets the MeasuredEV2.
##### Definition:
```python
@property
def measured_ev2(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### nd_filter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/nd_filter.md

#### nd_filter property

Gets the NDFilter.
##### Definition:
```python
@property
def nd_filter(self):
    ...
```

### optical_zoom_code property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/optical_zoom_code.md

#### optical_zoom_code property

Gets the OpticalZoomCode.
##### Definition:
```python
@property
def optical_zoom_code(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### self_timer2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/self_timer2.md

#### self_timer2 property

Gets the SelfTimer2.
##### Definition:
```python
@property
def self_timer2(self):
    ...
```

### sequence_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/sequence_number.md

#### sequence_number property

Gets the SequenceNumber.
##### Definition:
```python
@property
def sequence_number(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### slow_shutter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/slow_shutter.md

#### slow_shutter property

Gets the SlowShutter.
##### Definition:
```python
@property
def slow_shutter(self):
    ...
```

### target_aperture property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/target_aperture.md

#### target_aperture property

Gets the TargetAperture.
##### Definition:
```python
@property
def target_aperture(self):
    ...
```

### target_exposure_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/target_exposure_time.md

#### target_exposure_time property

Gets the TargetExposureTime.
##### Definition:
```python
@property
def target_exposure_time(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2shotinfopackage/white_balance.md

#### white_balance property

Gets the WhiteBalance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### Cr2TimeInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfoindex.md

#### Cr2TimeInfoIndex enumeration

Defines ids of Cr2TimeInfo tags.

The Cr2TimeInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN1 | Unknown tag. |
| TIME_ZONE | Indicates the TimeZone. |
| TIME_ZONE_CITY | Indicates the TimeZoneCity. |
| DAYLIGHT_SAVINGS | Indicates the DaylightSavings. |

### Cr2TimeInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage.md

#### Cr2TimeInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2TimeInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2TimeInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2TimeInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| time_zone | Gets the TimeZone. |
| time_zone_city | Gets the TimeZoneCity. |
| daylight_savings | Gets the DaylightSavings. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2TimeInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2TimeInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2TimeInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### daylight_savings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/daylight_savings.md

#### daylight_savings property

Gets the DaylightSavings.
##### Definition:
```python
@property
def daylight_savings(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### time_zone property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/time_zone.md

#### time_zone property

Gets the TimeZone.
##### Definition:
```python
@property
def time_zone(self):
    ...
```

### time_zone_city property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/time_zone_city.md

#### time_zone_city property

Gets the TimeZoneCity.
##### Definition:
```python
@property
def time_zone_city(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2timeinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2VignettingCorr2Index enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2index.md

#### Cr2VignettingCorr2Index enumeration

Defines ids of Cr2VignettingCorr2 tags.

The Cr2VignettingCorr2Index type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PERIPHERAL_LIGHTING_SETTING | Indicates the PeripheralLightingSetting. |
| CHROMATIC_ABERRATION_SETTING | Indicates the ChromaticAberrationSetting. |
| DISTORTION_CORRECTION_SETTING | Indicates the DistortionCorrectionSetting. |
| DIGITAL_LENS_OPTIMIZER_SETTING | Indicates the DigitalLensOptimizerSetting. |

### Cr2VignettingCorr2Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package.md

#### Cr2VignettingCorr2Package class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2VignettingCorr2Package` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2VignettingCorr2Package type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2VignettingCorr2Package` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| peripheral_lighting_setting | Gets the PeripheralLightingSetting. |
| chromatic_aberration_setting | Gets the ChromaticAberrationSetting. |
| distortion_correction_setting | Gets the DistortionCorrectionSetting. |
| digital_lens_optimizer_setting | Gets the DigitalLensOptimizerSetting. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2VignettingCorr2Package indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2VignettingCorr2Package constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2VignettingCorr2Package` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### chromatic_aberration_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/chromatic_aberration_setting.md

#### chromatic_aberration_setting property

Gets the ChromaticAberrationSetting.
##### Definition:
```python
@property
def chromatic_aberration_setting(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_lens_optimizer_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/digital_lens_optimizer_setting.md

#### digital_lens_optimizer_setting property

Gets the DigitalLensOptimizerSetting.
##### Definition:
```python
@property
def digital_lens_optimizer_setting(self):
    ...
```

### distortion_correction_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/distortion_correction_setting.md

#### distortion_correction_setting property

Gets the DistortionCorrectionSetting.
##### Definition:
```python
@property
def distortion_correction_setting(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### peripheral_lighting_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/peripheral_lighting_setting.md

#### peripheral_lighting_setting property

Gets the PeripheralLightingSetting.
##### Definition:
```python
@property
def peripheral_lighting_setting(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2vignettingcorr2package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Cr2WBInfoIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfoindex.md

#### Cr2WBInfoIndex enumeration

Defines ids of Cr2WBInfo tags.

The Cr2WBInfoIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| WB_GRBG_LEVELS_AUTO | Indicates the WB_GRBGLevelsAuto. |
| UNKNOWN1 | Unknown tag. |
| WB_GRBG_LEVELS_DAYLIGHT | Indicates the WB_GRBGLevelsDaylight. |
| UNKNOWN2 | Unknown tag. |
| WB_GRBG_LEVELS_CLOUDY | Indicates the WB_GRBGLevelsCloudy. |
| UNKNOWN3 | Unknown tag. |
| WB_GRBG_LEVELS_TUNGSTEN | Indicates the WB_GRBGLevelsTungsten. |
| UNKNOWN4 | Unknown tag. |
| WB_GRBG_LEVELS_FLUORESCENT | Indicates the WB_GRBGLevelsFluorescent. |
| UNKNOWN5 | Unknown tag. |
| WB_GRBG_LEVELS_FLUOR_HIGH | Indicates the WB_GRBGLevelsFluorHigh. |
| UNKNOWN6 | Unknown tag. |
| WB_GRBG_LEVELS_FLASH | Indicates the WB_GRBGLevelsFlash. |
| UNKNOWN7 | Unknown tag. |
| WB_GRBG_LEVELS_UNDERWATER | Indicates the WB_GRBGLevelsUnderwater. |
| UNKNOWN8 | Unknown tag. |
| WB_GRBG_LEVELS_CUSTOM1 | Indicates the WB_GRBGLevelsCustom1. |
| UNKNOWN9 | Unknown tag. |
| WB_GRBG_LEVELS_CUSTOM2 | Indicates the WB_GRBGLevelsCustom2. |

### Cr2WBInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage.md

#### Cr2WBInfoPackage class

Represents Canon MakerNotes tags.

**Inheritance:** `Cr2WBInfoPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The Cr2WBInfoPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `Cr2WBInfoPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| wb_grbg_levels_auto | Gets the WB_GRBGLevelsAuto. |
| wb_grbg_levels_daylight | Gets the WB_GRBGLevelsDaylight. |
| wb_grbg_levels_cloudy | Gets the WB_GRBGLevelsCloudy. |
| wb_grbg_levels_tungsten | Gets the WB_GRBGLevelsTungsten. |
| wb_grbg_levels_fluorescent | Gets the WB_GRBGLevelsFluorescent. |
| wb_grbg_levels_fluor_high | Gets the WB_GRBGLevelsFluorHigh. |
| wb_grbg_levels_flash | Gets the WB_GRBGLevelsFlash. |
| wb_grbg_levels_underwater | Gets the WB_GRBGLevelsUnderwater. |
| wb_grbg_levels_custom1 | Gets the WB_GRBGLevelsCustom1. |
| wb_grbg_levels_custom2 | Gets the WB_GRBGLevelsCustom2. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### Cr2WBInfoPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### Cr2WBInfoPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `Cr2WBInfoPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### wb_grbg_levels_auto property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_auto.md

#### wb_grbg_levels_auto property

Gets the WB_GRBGLevelsAuto.
##### Definition:
```python
@property
def wb_grbg_levels_auto(self):
    ...
```

### wb_grbg_levels_cloudy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_cloudy.md

#### wb_grbg_levels_cloudy property

Gets the WB_GRBGLevelsCloudy.
##### Definition:
```python
@property
def wb_grbg_levels_cloudy(self):
    ...
```

### wb_grbg_levels_custom1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_custom1.md

#### wb_grbg_levels_custom1 property

Gets the WB_GRBGLevelsCustom1.
##### Definition:
```python
@property
def wb_grbg_levels_custom1(self):
    ...
```

### wb_grbg_levels_custom2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_custom2.md

#### wb_grbg_levels_custom2 property

Gets the WB_GRBGLevelsCustom2.
##### Definition:
```python
@property
def wb_grbg_levels_custom2(self):
    ...
```

### wb_grbg_levels_daylight property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_daylight.md

#### wb_grbg_levels_daylight property

Gets the WB_GRBGLevelsDaylight.
##### Definition:
```python
@property
def wb_grbg_levels_daylight(self):
    ...
```

### wb_grbg_levels_flash property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_flash.md

#### wb_grbg_levels_flash property

Gets the WB_GRBGLevelsFlash.
##### Definition:
```python
@property
def wb_grbg_levels_flash(self):
    ...
```

### wb_grbg_levels_fluor_high property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_fluor_high.md

#### wb_grbg_levels_fluor_high property

Gets the WB_GRBGLevelsFluorHigh.
##### Definition:
```python
@property
def wb_grbg_levels_fluor_high(self):
    ...
```

### wb_grbg_levels_fluorescent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_fluorescent.md

#### wb_grbg_levels_fluorescent property

Gets the WB_GRBGLevelsFluorescent.
##### Definition:
```python
@property
def wb_grbg_levels_fluorescent(self):
    ...
```

### wb_grbg_levels_tungsten property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_tungsten.md

#### wb_grbg_levels_tungsten property

Gets the WB_GRBGLevelsTungsten.
##### Definition:
```python
@property
def wb_grbg_levels_tungsten(self):
    ...
```

### wb_grbg_levels_underwater property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.cr2/cr2wbinfopackage/wb_grbg_levels_underwater.md

#### wb_grbg_levels_underwater property

Gets the WB_GRBGLevelsUnderwater.
##### Definition:
```python
@property
def wb_grbg_levels_underwater(self):
    ...
```

### groupdocs.metadata.formats.raw.tag
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag.md

##### Classes
| Class | Description |
| :- | :- |
| `RawAsciiTag` | Represents a Raw ASCII tag. |
| `RawByteTag` | Represents an byte-based TIFF tag. |
| `RawLongTag` | Represents a Raw Long tag. |
| `RawShortTag` | Represents a Raw Short tag. |
| `RawTag` | Represents a RawTag property. |

### RawAsciiTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag.md

#### RawAsciiTag class

Represents a Raw ASCII tag.

**Inheritance:** `RawAsciiTag` →
`RawTag` →
`MetadataProperty`

The RawAsciiTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawAsciiTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value | Gets the tag value. |

### RawAsciiTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawAsciiTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | System.String | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/tag_value.md

#### tag_value property

Gets the tag value.
##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawasciitag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawByteTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag.md

#### RawByteTag class

Represents an byte-based TIFF tag.

**Inheritance:** `RawByteTag` →
`RawTag` →
`MetadataProperty`

The RawByteTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `TiffByteTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawByteTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `TiffByteTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | bytes | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawbytetag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawLongTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag.md

#### RawLongTag class

Represents a Raw Long tag.

**Inheritance:** `RawLongTag` →
`RawTag` →
`MetadataProperty`

The RawLongTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawLongTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawLongTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawLongTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawlongtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawShortTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag.md

#### RawShortTag class

Represents a Raw Short tag.

**Inheritance:** `RawShortTag` →
`RawTag` →
`MetadataProperty`

The RawShortTag type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag_id, value)` | Initializes a new instance of the `RawShortTag` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |
| tag_value |  |

### RawShortTag constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/__init__.md

#### \_\_init\_\_(self, tag_id, value)

Initializes a new instance of the `RawShortTag` class.

```python

def __init__(self, tag_id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | The tag identifier. |
| value | list | The value. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tag_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/tag_value.md

##### Definition:
```python
@property
def tag_value(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawshorttag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### RawTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag.md

#### RawTag class

Represents a RawTag property.

**Inheritance:** `RawTag` →
`MetadataProperty`

The RawTag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
@tag_id.setter
def tag_id(self, value):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
@tag_type.setter
def tag_type(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.tag/rawtag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### groupdocs.metadata.formats.raw
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw.md

##### Classes
| Class | Description |
| :- | :- |
| `ExifTag` | Represents a ExifTag property. |
| `GpsIfdPackage` | Represents GPS IFD. |
| `InteroperabilityIFDPointerPackage` | Represents Interoperability IFD. |
| `RawDictionaryBasePackage` | Provides an abstract base class for EXIF metadata dictionaries. |
| `RawExifTagPackage` | Represents Exif tags. |
| `RawIFD1Package` | Represents IFD1 tags. |
| `RawIFD2Package` | Represents IFD1 tags. |
| `RawIFD3Package` | Represents IFD1 tags. |
| `RawMakerNotePackage` | Represents Raw MakerNotes tags. |
| `RawPackage` | Represents Raw Package. |
| `RawTiffTagPackage` | Represents Tiff tags. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ExifTagID` | Defines ids of Exif tags. |
| `GpsIfdIndex` | Defines ids of GpsIfd tags. |
| `InteroperabilityIFDPointerIndex` | Defines ids of InteroperabilityIFDPointer tags. |
| `RawExifIndex` | Defines ids of RawExif tags. |
| `RawTagType` | Represents the IFD data type. |

### ExifTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag.md

#### ExifTag class

Represents a ExifTag property.

**Inheritance:** `ExifTag` →
`MetadataProperty`

The ExifTag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| tag_type | Gets the type of the tag. |
| tag_id | Gets the tag id. |

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tag_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/tag_id.md

#### tag_id property

Gets the tag id.
##### Definition:
```python
@property
def tag_id(self):
    ...
```

### tag_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/tag_type.md

#### tag_type property

Gets the type of the tag.
##### Definition:
```python
@property
def tag_type(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftag/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### ExifTagID enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/exiftagid.md

#### ExifTagID enumeration

Defines ids of Exif tags.

The ExifTagID type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EXPOSURE_TIME | Exposure Time |
| F_NUMBER | F-Number |
| EXPOSURE_PROGRAM | ExposureProgram |
| SPECTRAL_SENSITIVITY | SpectralSensitivity |
| GPS_INFO | GPSInfo |
| ISO_SPEED_RATINGS | ISO Speed Ratings |
| MAKER_NOTE_CANON | ISO Speed Ratings |

### GpsIfdIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdindex.md

#### GpsIfdIndex enumeration

Defines ids of GpsIfd tags.

The GpsIfdIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GPS_VERSION_ID | Indicates the GPSVersionID. |
| GPS_LATITUDE_REF | Indicates the GPSLatitudeRef. |
| GPS_LATITUDE | Indicates the GPSLatitude. |
| GPS_LONGITUDE_REF | Indicates the GPSLongitudeRef. |
| GPS_LONGITUDE | Indicates the GPSLongitude. |
| GPS_ALTITUDE_REF | Indicates the GPSAltitudeRef. |
| GPS_ALTITUDE | Indicates the GPSAltitude. |
| GPS_TIME_STAMP | Indicates the GPSTimeStamp. |
| GPS_SATELLITES | Indicates the GPSSatellites. |
| GPS_STATUS | Indicates the GPSStatus. |
| GPS_MEASURE_MODE | Indicates the GPSMeasureMode. |
| GPSDOP | Indicates the GPSDOP. |
| GPS_SPEED_REF | Indicates the GPSSpeedRef. |
| GPS_SPEED | Indicates the GPSSpeed. |
| GPS_TRACK_REF | Indicates the GPSTrackRef. |
| GPS_TRACK | Indicates the GPSTrack. |
| GPS_IMG_DIRECTION_REF | Indicates the GPSImgDirectionRef. |
| GPS_IMG_DIRECTION | Indicates the GPSImgDirection. |
| GPS_MAP_DATUM | Indicates the GPSMapDatum. |
| GPS_DEST_LATITUDE_REF | Indicates the GPSDestLatitudeRef. |
| GPS_DEST_LATITUDE | Indicates the GPSDestLatitude. |
| GPS_DEST_LONGITUDE_REF | Indicates the GPSDestLongitudeRef. |
| GPS_DEST_LONGITUDE | Indicates the GPSDestLongitude. |
| GPS_DEST_BEARING_REF | Indicates the GPSDestBearingRef. |
| GPS_DEST_BEARING | Indicates the GPSDestBearing. |
| GPS_DEST_DISTANCE_REF | Indicates the GPSDestDistanceRef. |
| GPS_DEST_DISTANCE | Indicates the GPSDestDistance. |
| GPS_PROCESSING_METHOD | Indicates the GPSProcessingMethod. |
| GPS_AREA_INFORMATION | Indicates the GPSAreaInformation. |
| GPS_DATE_STAMP | Indicates the GPSDateStamp. |
| GPS_DIFFERENTIAL | Indicates the GPSDifferential. |
| GPSH_POSITIONING_ERROR | Indicates the GPSHPositioningError. |

### GpsIfdPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage.md

#### GpsIfdPackage class

Represents GPS IFD.

**Inheritance:** `GpsIfdPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The GpsIfdPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| gps_version_id | Gets the GPSVersionID. |
| gps_latitude_ref | Gets the GPSLatitudeRef. |
| gps_latitude | Gets the GPSLatitude. |
| gps_longitude_ref | Gets the GPSLongitudeRef. |
| gps_longitude | Gets the GPSLongitude. |
| gps_altitude_ref | Gets the GPSAltitudeRef. |
| gps_altitude | Gets the GPSAltitude. |
| gps_time_stamp | Gets the GPSTimeStamp. |
| gps_satellites | Gets the GPSSatellites. |
| gps_status | Gets the GPSStatus. |
| gps_measure_mode | Gets the GPSMeasureMode. |
| gpsdop | Gets the GPSDOP. |
| gps_speed_ref | Gets the GPSSpeedRef. |
| gps_speed | Gets the GPSSpeed. |
| gps_track_ref | Gets the GPSTrackRef. |
| gps_track | Gets the GPSTrack. |
| gps_img_direction_ref | Gets the GPSImgDirectionRef. |
| gps_img_direction | Gets the GPSImgDirection. |
| gps_map_datum | Gets the GPSMapDatum. |
| gps_dest_latitude_ref | Gets the GPSDestLatitudeRef. |
| gps_dest_latitude | Gets the GPSDestLatitude. |
| gps_dest_longitude_ref | Gets the GPSDestLongitudeRef. |
| gps_dest_longitude | Gets the GPSDestLongitude. |
| gps_dest_bearing_ref | Gets the GPSDestBearingRef. |
| gps_dest_bearing | Gets the GPSDestBearing. |
| gps_dest_distance_ref | Gets the GPSDestDistanceRef. |
| gps_dest_distance | Gets the GPSDestDistance. |
| gps_processing_method | Gets the GPSProcessingMethod. |
| gps_area_information | Gets the GPSAreaInformation. |
| gps_date_stamp | Gets the GPSDateStamp. |
| gps_differential | Gets the GPSDifferential. |
| gpsh_positioning_error | Gets the GPSHPositioningError. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### GpsIfdPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gps_altitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_altitude.md

#### gps_altitude property

Gets the GPSAltitude.
##### Definition:
```python
@property
def gps_altitude(self):
    ...
```

### gps_altitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_altitude_ref.md

#### gps_altitude_ref property

Gets the GPSAltitudeRef.
##### Definition:
```python
@property
def gps_altitude_ref(self):
    ...
```

### gps_area_information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_area_information.md

#### gps_area_information property

Gets the GPSAreaInformation.
##### Definition:
```python
@property
def gps_area_information(self):
    ...
```

### gps_date_stamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_date_stamp.md

#### gps_date_stamp property

Gets the GPSDateStamp.
##### Definition:
```python
@property
def gps_date_stamp(self):
    ...
```

### gps_dest_bearing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_bearing.md

#### gps_dest_bearing property

Gets the GPSDestBearing.
##### Definition:
```python
@property
def gps_dest_bearing(self):
    ...
```

### gps_dest_bearing_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_bearing_ref.md

#### gps_dest_bearing_ref property

Gets the GPSDestBearingRef.
##### Definition:
```python
@property
def gps_dest_bearing_ref(self):
    ...
```

### gps_dest_distance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_distance.md

#### gps_dest_distance property

Gets the GPSDestDistance.
##### Definition:
```python
@property
def gps_dest_distance(self):
    ...
```

### gps_dest_distance_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_distance_ref.md

#### gps_dest_distance_ref property

Gets the GPSDestDistanceRef.
##### Definition:
```python
@property
def gps_dest_distance_ref(self):
    ...
```

### gps_dest_latitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_latitude.md

#### gps_dest_latitude property

Gets the GPSDestLatitude.
##### Definition:
```python
@property
def gps_dest_latitude(self):
    ...
```

### gps_dest_latitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_latitude_ref.md

#### gps_dest_latitude_ref property

Gets the GPSDestLatitudeRef.
##### Definition:
```python
@property
def gps_dest_latitude_ref(self):
    ...
```

### gps_dest_longitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_longitude.md

#### gps_dest_longitude property

Gets the GPSDestLongitude.
##### Definition:
```python
@property
def gps_dest_longitude(self):
    ...
```

### gps_dest_longitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_dest_longitude_ref.md

#### gps_dest_longitude_ref property

Gets the GPSDestLongitudeRef.
##### Definition:
```python
@property
def gps_dest_longitude_ref(self):
    ...
```

### gps_differential property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_differential.md

#### gps_differential property

Gets the GPSDifferential.
##### Definition:
```python
@property
def gps_differential(self):
    ...
```

### gps_img_direction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_img_direction.md

#### gps_img_direction property

Gets the GPSImgDirection.
##### Definition:
```python
@property
def gps_img_direction(self):
    ...
```

### gps_img_direction_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_img_direction_ref.md

#### gps_img_direction_ref property

Gets the GPSImgDirectionRef.
##### Definition:
```python
@property
def gps_img_direction_ref(self):
    ...
```

### gps_latitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_latitude.md

#### gps_latitude property

Gets the GPSLatitude.
##### Definition:
```python
@property
def gps_latitude(self):
    ...
```

### gps_latitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_latitude_ref.md

#### gps_latitude_ref property

Gets the GPSLatitudeRef.
##### Definition:
```python
@property
def gps_latitude_ref(self):
    ...
```

### gps_longitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_longitude.md

#### gps_longitude property

Gets the GPSLongitude.
##### Definition:
```python
@property
def gps_longitude(self):
    ...
```

### gps_longitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_longitude_ref.md

#### gps_longitude_ref property

Gets the GPSLongitudeRef.
##### Definition:
```python
@property
def gps_longitude_ref(self):
    ...
```

### gps_map_datum property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_map_datum.md

#### gps_map_datum property

Gets the GPSMapDatum.
##### Definition:
```python
@property
def gps_map_datum(self):
    ...
```

### gps_measure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_measure_mode.md

#### gps_measure_mode property

Gets the GPSMeasureMode.
##### Definition:
```python
@property
def gps_measure_mode(self):
    ...
```

### gps_processing_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_processing_method.md

#### gps_processing_method property

Gets the GPSProcessingMethod.
##### Definition:
```python
@property
def gps_processing_method(self):
    ...
```

### gps_satellites property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_satellites.md

#### gps_satellites property

Gets the GPSSatellites.
##### Definition:
```python
@property
def gps_satellites(self):
    ...
```

### gps_speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_speed.md

#### gps_speed property

Gets the GPSSpeed.
##### Definition:
```python
@property
def gps_speed(self):
    ...
```

### gps_speed_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_speed_ref.md

#### gps_speed_ref property

Gets the GPSSpeedRef.
##### Definition:
```python
@property
def gps_speed_ref(self):
    ...
```

### gps_status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_status.md

#### gps_status property

Gets the GPSStatus.
##### Definition:
```python
@property
def gps_status(self):
    ...
```

### gps_time_stamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_time_stamp.md

#### gps_time_stamp property

Gets the GPSTimeStamp.
##### Definition:
```python
@property
def gps_time_stamp(self):
    ...
```

### gps_track property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_track.md

#### gps_track property

Gets the GPSTrack.
##### Definition:
```python
@property
def gps_track(self):
    ...
```

### gps_track_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_track_ref.md

#### gps_track_ref property

Gets the GPSTrackRef.
##### Definition:
```python
@property
def gps_track_ref(self):
    ...
```

### gps_version_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gps_version_id.md

#### gps_version_id property

Gets the GPSVersionID.
##### Definition:
```python
@property
def gps_version_id(self):
    ...
```

### gpsdop property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsdop.md

#### gpsdop property

Gets the GPSDOP.
##### Definition:
```python
@property
def gpsdop(self):
    ...
```

### gpsh_positioning_error property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/gpsh_positioning_error.md

#### gpsh_positioning_error property

Gets the GPSHPositioningError.
##### Definition:
```python
@property
def gpsh_positioning_error(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/gpsifdpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### InteroperabilityIFDPointerIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerindex.md

#### InteroperabilityIFDPointerIndex enumeration

Defines ids of InteroperabilityIFDPointer tags.

The InteroperabilityIFDPointerIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TAG_INTEROP_INDEX | Indicates the TagInteropIndex. |
| TAG_INTEROP_VERSION | Indicates the TagInteropVersion. |

### InteroperabilityIFDPointerPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage.md

#### InteroperabilityIFDPointerPackage class

Represents Interoperability IFD.

**Inheritance:** `InteroperabilityIFDPointerPackage` →
`CustomPackage` →
`MetadataPackage`

The InteroperabilityIFDPointerPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| tag_interop_index | Gets the TagInteropIndex. |
| tag_interop_version | Gets the TagInteropVersion. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### tag_interop_index property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/tag_interop_index.md

#### tag_interop_index property

Gets the TagInteropIndex.
##### Definition:
```python
@property
def tag_interop_index(self):
    ...
```

### tag_interop_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/tag_interop_version.md

#### tag_interop_version property

Gets the TagInteropVersion.
##### Definition:
```python
@property
def tag_interop_version(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/interoperabilityifdpointerpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawDictionaryBasePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage.md

#### RawDictionaryBasePackage class

Provides an abstract base class for EXIF metadata dictionaries.

**Inheritance:** `RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawDictionaryBasePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

##### Remarks

**Learn more** |
|
 |

### RawDictionaryBasePackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawdictionarybasepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawExifIndex enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexifindex.md

#### RawExifIndex enumeration

Defines ids of RawExif tags.

The RawExifIndex type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EXPOSURE_TIME | Indicates the ExposureTime. |
| F_NUMBER | Indicates the FNumber. |
| EXPOSURE_PROGRAM | Indicates the ExposureProgram. |
| SPECTRAL_SENSITIVITY | Indicates the SpectralSensitivity. |
| PHOTOGRAPHIC_SENSITIVITY | Indicates the PhotographicSensitivity. |
| OECF | Indicates the OECF. |
| SENSITIVITY_TYPE | Indicates the SensitivityType. |
| STANDARD_OUTPUT_SENSITIVITY | Indicates the StandardOutputSensitivity. |
| RECOMMENDED_EXPOSURE_INDEX | Indicates the RecommendedExposureIndex. |
| ISO_SPEED | Indicates the ISOSpeed. |
| ISO_SPEED_LATITUDEYYY | Indicates the ISOSpeedLatitudeyyy. |
| ISO_SPEED_LATITUDEZZZ | Indicates the ISOSpeedLatitudezzz. |
| EXIF_VERSION | Indicates the ExifVersion. |
| DATE_TIME_ORIGINAL | Indicates the DateTimeOriginal. |
| DATE_TIME_DIGITIZED | Indicates the DateTimeDigitized. |
| OFFSET_TIME | Indicates the OffsetTime. |
| OFFSET_TIME_ORIGINAL | Indicates the OffsetTimeOriginal. |
| OFFSET_TIME_DIGITIZED | Indicates the OffsetTimeDigitized. |
| COMPONENTS_CONFIGURATION | Indicates the ComponentsConfiguration. |
| SHUTTER_SPEED_VALUE | Indicates the ShutterSpeedValue. |
| APERTURE_VALUE | Indicates the ApertureValue. |
| BRIGHTNESS_VALUE | Indicates the BrightnessValue. |
| EXPOSURE_BIAS_VALUE | Indicates the ExposureBiasValue. |
| MAX_APERTURE_VALUE | Indicates the MaxApertureValue. |
| SUBJECT_DISTANCE | Indicates the SubjectDistance. |
| METERING_MODE | Indicates the MeteringMode. |
| LIGHT_SOURCE | Indicates the LightSource. |
| FLASH | Indicates the Flash. |
| FOCAL_LENGTH | Indicates the FocalLength. |
| SUBJECT_AREA | Indicates the SubjectArea. |
| MAKER_NOTE | Indicates the MakerNote. |
| USER_COMMENT | Indicates the UserComment. |
| SUB_SEC_TIME | Indicates the SubSecTime. |
| SUB_SEC_TIME_ORIGINAL | Indicates the SubSecTimeOriginal. |
| SUB_SEC_TIME_DIGITIZED | Indicates the SubSecTimeDigitized. |
| TEMPERATURE | Indicates the Temperature. |
| HUMIDITY | Indicates the Humidity. |
| PRESSURE | Indicates the Pressure. |
| WATER_DEPTH | Indicates the WaterDepth. |
| ACCELERATION | Indicates the Acceleration. |
| CAMERA_ELEVATION_ANGLE | Indicates the CameraElevationAngle. |
| FLASHPIX_VERSION | Indicates the FlashpixVersion. |
| COLOR_SPACE | Indicates the ColorSpace. |
| PIXEL_X_DIMENSION | Indicates the PixelXDimension. |
| PIXEL_Y_DIMENSION | Indicates the PixelYDimension. |
| RELATED_SOUND_FILE | Indicates the RelatedSoundFile. |
| INTEROPERABILITY_IFD_POINTER | Indicates the InteroperabilityIFDPointer. |
| FLASH_ENERGY | Indicates the FlashEnergy. |
| SPATIAL_FREQUENCY_RESPONSE | Indicates the SpatialFrequencyResponse. |
| FOCAL_PLANE_X_RESOLUTION | Indicates the FocalPlaneXResolution. |
| FOCAL_PLANE_Y_RESOLUTION | Indicates the FocalPlaneYResolution. |
| FOCAL_PLANE_RESOLUTION_UNIT | Indicates the FocalPlaneResolutionUnit. |
| SUBJECT_LOCATION | Indicates the SubjectLocation. |
| EXPOSURE_INDEX | Indicates the ExposureIndex. |
| SENSING_METHOD | Indicates the SensingMethod. |
| FILE_SOURCE | Indicates the FileSource. |
| SCENE_TYPE | Indicates the SceneType. |
| CFA_PATTERN | Indicates the CFAPattern. |
| CUSTOM_RENDERED | Indicates the CustomRendered. |
| EXPOSURE_MODE | Indicates the ExposureMode. |
| WHITE_BALANCE | Indicates the WhiteBalance. |
| DIGITAL_ZOOM_RATIO | Indicates the DigitalZoomRatio. |
| FOCAL_LENGTH_IN_35MM_FILM | Indicates the FocalLengthIn35mmFilm. |
| SCENE_CAPTURE_TYPE | Indicates the SceneCaptureType. |
| GAIN_CONTROL | Indicates the GainControl. |
| CONTRAST | Indicates the Contrast. |
| SATURATION | Indicates the Saturation. |
| SHARPNESS | Indicates the Sharpness. |
| DEVICE_SETTING_DESCRIPTION | Indicates the DeviceSettingDescription. |
| SUBJECT_DISTANCE_RANGE | Indicates the SubjectDistanceRange. |
| IMAGE_UNIQUE_ID | Indicates the ImageUniqueID. |
| CAMERA_OWNER_NAME | Indicates the CameraOwnerName. |
| BODY_SERIAL_NUMBER | Indicates the BodySerialNumber. |
| LENS_SPECIFICATION | Indicates the LensSpecification. |
| LENS_MAKE | Indicates the LensMake. |
| LENS_MODEL | Indicates the LensModel. |
| LENS_SERIAL_NUMBER | Indicates the LensSerialNumber. |
| COMPOSITE_IMAGE | Indicates the CompositeImage. |
| SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE | Indicates the SourceImageNumberOfCompositeImage. |
| SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE | Indicates the SourceExposureTimesOfCompositeImage. |
| GAMMA | Indicates the Gamma. |

### RawExifTagPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage.md

#### RawExifTagPackage class

Represents Exif tags.

**Inheritance:** `RawExifTagPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawExifTagPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| raw_maker_note_package | Gets the Manufacturer notes (MakerNote). |
| interoperability_ifd_pointer_package | Gets the Interoperability tag (Interoperability IFD Pointer). |
| interoperability_ifd_pointer | Gets the Interoperability tag (Interoperability IFD Pointer). |
| exposure_time | Gets the Exposure time. |
| f_number | Gets the F number. |
| exposure_program | Gets the Exposure program. |
| spectral_sensitivity | Gets the Spectral sensitivity. |
| photographic_sensitivity | Gets the Photographic Sensitivity. |
| oecf | Gets the Optoelectric conversion factor. |
| sensitivity_type | Gets the Sensitivity Type. |
| standard_output_sensitivity | Gets the Standard Output Sensitivity. |
| recommended_exposure_index | Gets the Recommended ExposureIndexs. |
| iso_speed | Gets the ISO Speed. |
| iso_speed_latitudeyyy | Gets the ISO Speed Latitude yyy. |
| iso_speed_latitudezzz | Gets the ISO Speed Latitude zzz. |
| exif_version | Gets the ExifVersion. |
| date_time_original | Gets the Date and time of original data generation. |
| date_time_digitized | Gets the Date and time of digital data generation. |
| offset_time | Gets the Offset data of DateTime. |
| offset_time_original | Gets the Offset data of DateTimeOriginal. |
| offset_time_digitized | Gets the Offset data of DateTimeDigitized. |
| components_configuration | Gets the Meaning of each component. |
| shutter_speed_value | Gets the Shutter speed. |
| aperture_value | Gets the Aperture. |
| brightness_value | Gets the Brightness. |
| exposure_bias_value | Gets the Exposure bias. |
| max_aperture_value | Gets the Maximum lens aperture. |
| subject_distance | Gets the Subject distance. |
| metering_mode | Gets the Metering mode. |
| light_source | Gets the Light source. |
| flash | Gets the Flash. |
| focal_length | Gets the Lens focal length. |
| subject_area | Gets the Subject area. |
| user_comment | Gets the User comments. |
| sub_sec_time | Gets the DateTime subseconds. |
| sub_sec_time_original | Gets the DateTimeOriginal subseconds. |
| sub_sec_time_digitized | Gets the DateTimeDigitized subseconds. |
| temperature | Gets the Temperature. |
| humidity | Gets the Humidity. |
| pressure | Gets the Pressure. |
| water_depth | Gets the WaterDepth. |
| acceleration | Gets the Acceleration. |
| camera_elevation_angle | Gets the Camera elevation angle. |
| flashpix_version | Gets the Temperature. |
| color_space | Gets the Color space information . |
| pixel_x_dimension | Gets the Valid image width. |
| pixel_y_dimension | Gets the Valid image height. |
| related_sound_file | Gets the Related audio file. |
| flash_energy | Gets the Flash energy. |
| spatial_frequency_response | Gets the Spatial frequency response. |
| focal_plane_x_resolution | Gets Focal plane X resolution. |
| focal_plane_y_resolution | Gets the Focal plane Y resolution. |
| focal_plane_resolution_unit | Gets the Focal plane resolution unit. |
| subject_location | Gets the Subject location. |
| exposure_index | Gets the Exposure index. |
| sensing_method | Gets the Sensing method. |
| file_source | Gets the File source. |
| scene_type | Gets the Scene Type. |
| cfa_pattern | Gets the CFA pattern. |
| custom_rendered | Gets the Custom image processing. |
| exposure_mode | Gets the Exposure mode. |
| white_balance | Gets the White balance. |
| digital_zoom_ratio | Gets the Digital zoom ratio. |
| focal_length_in_35mm_film | Gets the Focal length in 35 mm film. |
| scene_capture_type | Gets the Scene capture type. |
| gain_control | Gets the Gain control. |
| contrast | Gets the Contrast. |
| saturation | Gets the Saturation. |
| sharpness | Gets the Sharpness. |
| device_setting_description | Gets the Device settings description. |
| subject_distance_range | Gets the Subject distance range. |
| image_unique_id | Gets the Unique image ID. |
| camera_owner_name | Gets the Camera Owner Name. |
| body_serial_number | Gets the Body Serial Number. |
| lens_specification | Gets the Lens Specification. |
| lens_model | Gets the Lens Model. |
| lens_make | Gets the Lens Make. |
| lens_serial_number | Gets the Lens Serial Number. |
| composite_image | Gets the Composite image. |
| source_image_number_of_composite_image | Gets the Source image number of composite image. |
| source_exposure_times_of_composite_image | Gets the Source exposure times of composite image. |
| gamma | Gets the Gamma. |
| maker_note | Gets the Standard Output Sensitivity. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawExifTagPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### acceleration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/acceleration.md

#### acceleration property

Gets the Acceleration.
##### Definition:
```python
@property
def acceleration(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### aperture_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/aperture_value.md

#### aperture_value property

Gets the Aperture.
##### Definition:
```python
@property
def aperture_value(self):
    ...
```

### body_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/body_serial_number.md

#### body_serial_number property

Gets the Body Serial Number.
##### Definition:
```python
@property
def body_serial_number(self):
    ...
```

### brightness_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/brightness_value.md

#### brightness_value property

Gets the Brightness.
##### Definition:
```python
@property
def brightness_value(self):
    ...
```

### camera_elevation_angle property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/camera_elevation_angle.md

#### camera_elevation_angle property

Gets the Camera elevation angle.
##### Definition:
```python
@property
def camera_elevation_angle(self):
    ...
```

### camera_owner_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/camera_owner_name.md

#### camera_owner_name property

Gets the Camera Owner Name.
##### Definition:
```python
@property
def camera_owner_name(self):
    ...
```

### cfa_pattern property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/cfa_pattern.md

#### cfa_pattern property

Gets the CFA pattern.
##### Definition:
```python
@property
def cfa_pattern(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### color_space property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/color_space.md

#### color_space property

Gets the Color space information .
##### Definition:
```python
@property
def color_space(self):
    ...
```

### components_configuration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/components_configuration.md

#### components_configuration property

Gets the Meaning of each component.
##### Definition:
```python
@property
def components_configuration(self):
    ...
```

### composite_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/composite_image.md

#### composite_image property

Gets the Composite image.
##### Definition:
```python
@property
def composite_image(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/contrast.md

#### contrast property

Gets the Contrast.
##### Definition:
```python
@property
def contrast(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### custom_rendered property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/custom_rendered.md

#### custom_rendered property

Gets the Custom image processing.
##### Definition:
```python
@property
def custom_rendered(self):
    ...
```

### date_time_digitized property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/date_time_digitized.md

#### date_time_digitized property

Gets the Date and time of digital data generation.
##### Definition:
```python
@property
def date_time_digitized(self):
    ...
```

### date_time_original property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/date_time_original.md

#### date_time_original property

Gets the Date and time of original data generation.
##### Definition:
```python
@property
def date_time_original(self):
    ...
```

### device_setting_description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/device_setting_description.md

#### device_setting_description property

Gets the Device settings description.
##### Definition:
```python
@property
def device_setting_description(self):
    ...
```

### digital_zoom_ratio property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/digital_zoom_ratio.md

#### digital_zoom_ratio property

Gets the Digital zoom ratio.
##### Definition:
```python
@property
def digital_zoom_ratio(self):
    ...
```

### exif_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exif_version.md

#### exif_version property

Gets the ExifVersion.
##### Definition:
```python
@property
def exif_version(self):
    ...
```

### exposure_bias_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposure_bias_value.md

#### exposure_bias_value property

Gets the Exposure bias.
##### Definition:
```python
@property
def exposure_bias_value(self):
    ...
```

### exposure_index property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposure_index.md

#### exposure_index property

Gets the Exposure index.
##### Definition:
```python
@property
def exposure_index(self):
    ...
```

### exposure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposure_mode.md

#### exposure_mode property

Gets the Exposure mode.
##### Definition:
```python
@property
def exposure_mode(self):
    ...
```

### exposure_program property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposure_program.md

#### exposure_program property

Gets the Exposure program.
##### Definition:
```python
@property
def exposure_program(self):
    ...
```

### exposure_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/exposure_time.md

#### exposure_time property

Gets the Exposure time.
##### Definition:
```python
@property
def exposure_time(self):
    ...
```

### f_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/f_number.md

#### f_number property

Gets the F number.
##### Definition:
```python
@property
def f_number(self):
    ...
```

### file_source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/file_source.md

#### file_source property

Gets the File source.
##### Definition:
```python
@property
def file_source(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/flash.md

#### flash property

Gets the Flash.
##### Definition:
```python
@property
def flash(self):
    ...
```

### flash_energy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/flash_energy.md

#### flash_energy property

Gets the Flash energy.
##### Definition:
```python
@property
def flash_energy(self):
    ...
```

### flashpix_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/flashpix_version.md

#### flashpix_version property

Gets the Temperature.
##### Definition:
```python
@property
def flashpix_version(self):
    ...
```

### focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/focal_length.md

#### focal_length property

Gets the Lens focal length.
##### Definition:
```python
@property
def focal_length(self):
    ...
```

### focal_length_in_35mm_film property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/focal_length_in_35mm_film.md

#### focal_length_in_35mm_film property

Gets the Focal length in 35 mm film.
##### Definition:
```python
@property
def focal_length_in_35mm_film(self):
    ...
```

### focal_plane_resolution_unit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/focal_plane_resolution_unit.md

#### focal_plane_resolution_unit property

Gets the Focal plane resolution unit.
##### Definition:
```python
@property
def focal_plane_resolution_unit(self):
    ...
```

### focal_plane_x_resolution property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/focal_plane_x_resolution.md

#### focal_plane_x_resolution property

Gets Focal plane X resolution.
##### Definition:
```python
@property
def focal_plane_x_resolution(self):
    ...
```

### focal_plane_y_resolution property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/focal_plane_y_resolution.md

#### focal_plane_y_resolution property

Gets the Focal plane Y resolution.
##### Definition:
```python
@property
def focal_plane_y_resolution(self):
    ...
```

### gain_control property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/gain_control.md

#### gain_control property

Gets the Gain control.
##### Definition:
```python
@property
def gain_control(self):
    ...
```

### gamma property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/gamma.md

#### gamma property

Gets the Gamma.
##### Definition:
```python
@property
def gamma(self):
    ...
```

### humidity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/humidity.md

#### humidity property

Gets the Humidity.
##### Definition:
```python
@property
def humidity(self):
    ...
```

### image_unique_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/image_unique_id.md

#### image_unique_id property

Gets the Unique image ID.
##### Definition:
```python
@property
def image_unique_id(self):
    ...
```

### interoperability_ifd_pointer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/interoperability_ifd_pointer.md

#### interoperability_ifd_pointer property

Gets the Interoperability tag (Interoperability IFD Pointer).
##### Definition:
```python
@property
def interoperability_ifd_pointer(self):
    ...
```

### interoperability_ifd_pointer_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/interoperability_ifd_pointer_package.md

#### interoperability_ifd_pointer_package property

Gets the Interoperability tag (Interoperability IFD Pointer).
##### Definition:
```python
@property
def interoperability_ifd_pointer_package(self):
    ...
```

### iso_speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/iso_speed.md

#### iso_speed property

Gets the ISO Speed.
##### Definition:
```python
@property
def iso_speed(self):
    ...
```

### iso_speed_latitudeyyy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/iso_speed_latitudeyyy.md

#### iso_speed_latitudeyyy property

Gets the ISO Speed Latitude yyy.
##### Definition:
```python
@property
def iso_speed_latitudeyyy(self):
    ...
```

### iso_speed_latitudezzz property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/iso_speed_latitudezzz.md

#### iso_speed_latitudezzz property

Gets the ISO Speed Latitude zzz.
##### Definition:
```python
@property
def iso_speed_latitudezzz(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_make property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/lens_make.md

#### lens_make property

Gets the Lens Make.
##### Definition:
```python
@property
def lens_make(self):
    ...
```

### lens_model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/lens_model.md

#### lens_model property

Gets the Lens Model.
##### Definition:
```python
@property
def lens_model(self):
    ...
```

### lens_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/lens_serial_number.md

#### lens_serial_number property

Gets the Lens Serial Number.
##### Definition:
```python
@property
def lens_serial_number(self):
    ...
```

### lens_specification property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/lens_specification.md

#### lens_specification property

Gets the Lens Specification.
##### Definition:
```python
@property
def lens_specification(self):
    ...
```

### light_source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/light_source.md

#### light_source property

Gets the Light source.
##### Definition:
```python
@property
def light_source(self):
    ...
```

### maker_note property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/maker_note.md

#### maker_note property

Gets the Standard Output Sensitivity.
##### Definition:
```python
@property
def maker_note(self):
    ...
```

### max_aperture_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/max_aperture_value.md

#### max_aperture_value property

Gets the Maximum lens aperture.
##### Definition:
```python
@property
def max_aperture_value(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### metering_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/metering_mode.md

#### metering_mode property

Gets the Metering mode.
##### Definition:
```python
@property
def metering_mode(self):
    ...
```

### oecf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/oecf.md

#### oecf property

Gets the Optoelectric conversion factor.
##### Definition:
```python
@property
def oecf(self):
    ...
```

### offset_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/offset_time.md

#### offset_time property

Gets the Offset data of DateTime.
##### Definition:
```python
@property
def offset_time(self):
    ...
```

### offset_time_digitized property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/offset_time_digitized.md

#### offset_time_digitized property

Gets the Offset data of DateTimeDigitized.
##### Definition:
```python
@property
def offset_time_digitized(self):
    ...
```

### offset_time_original property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/offset_time_original.md

#### offset_time_original property

Gets the Offset data of DateTimeOriginal.
##### Definition:
```python
@property
def offset_time_original(self):
    ...
```

### photographic_sensitivity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/photographic_sensitivity.md

#### photographic_sensitivity property

Gets the Photographic Sensitivity.
##### Definition:
```python
@property
def photographic_sensitivity(self):
    ...
```

### pixel_x_dimension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/pixel_x_dimension.md

#### pixel_x_dimension property

Gets the Valid image width.
##### Definition:
```python
@property
def pixel_x_dimension(self):
    ...
```

### pixel_y_dimension property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/pixel_y_dimension.md

#### pixel_y_dimension property

Gets the Valid image height.
##### Definition:
```python
@property
def pixel_y_dimension(self):
    ...
```

### pressure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/pressure.md

#### pressure property

Gets the Pressure.
##### Definition:
```python
@property
def pressure(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_maker_note_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/raw_maker_note_package.md

#### raw_maker_note_package property

Gets the Manufacturer notes (MakerNote).
##### Definition:
```python
@property
def raw_maker_note_package(self):
    ...
```

### recommended_exposure_index property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/recommended_exposure_index.md

#### recommended_exposure_index property

Gets the Recommended ExposureIndexs.
##### Definition:
```python
@property
def recommended_exposure_index(self):
    ...
```

### related_sound_file property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/related_sound_file.md

#### related_sound_file property

Gets the Related audio file.
##### Definition:
```python
@property
def related_sound_file(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/saturation.md

#### saturation property

Gets the Saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### scene_capture_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/scene_capture_type.md

#### scene_capture_type property

Gets the Scene capture type.
##### Definition:
```python
@property
def scene_capture_type(self):
    ...
```

### scene_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/scene_type.md

#### scene_type property

Gets the Scene Type.
##### Definition:
```python
@property
def scene_type(self):
    ...
```

### sensing_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sensing_method.md

#### sensing_method property

Gets the Sensing method.
##### Definition:
```python
@property
def sensing_method(self):
    ...
```

### sensitivity_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sensitivity_type.md

#### sensitivity_type property

Gets the Sensitivity Type.
##### Definition:
```python
@property
def sensitivity_type(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sharpness.md

#### sharpness property

Gets the Sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### shutter_speed_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/shutter_speed_value.md

#### shutter_speed_value property

Gets the Shutter speed.
##### Definition:
```python
@property
def shutter_speed_value(self):
    ...
```

### source_exposure_times_of_composite_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/source_exposure_times_of_composite_image.md

#### source_exposure_times_of_composite_image property

Gets the Source exposure times of composite image.
##### Definition:
```python
@property
def source_exposure_times_of_composite_image(self):
    ...
```

### source_image_number_of_composite_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/source_image_number_of_composite_image.md

#### source_image_number_of_composite_image property

Gets the Source image number of composite image.
##### Definition:
```python
@property
def source_image_number_of_composite_image(self):
    ...
```

### spatial_frequency_response property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/spatial_frequency_response.md

#### spatial_frequency_response property

Gets the Spatial frequency response.
##### Definition:
```python
@property
def spatial_frequency_response(self):
    ...
```

### spectral_sensitivity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/spectral_sensitivity.md

#### spectral_sensitivity property

Gets the Spectral sensitivity.
##### Definition:
```python
@property
def spectral_sensitivity(self):
    ...
```

### standard_output_sensitivity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/standard_output_sensitivity.md

#### standard_output_sensitivity property

Gets the Standard Output Sensitivity.
##### Definition:
```python
@property
def standard_output_sensitivity(self):
    ...
```

### sub_sec_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sub_sec_time.md

#### sub_sec_time property

Gets the DateTime subseconds.
##### Definition:
```python
@property
def sub_sec_time(self):
    ...
```

### sub_sec_time_digitized property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sub_sec_time_digitized.md

#### sub_sec_time_digitized property

Gets the DateTimeDigitized subseconds.
##### Definition:
```python
@property
def sub_sec_time_digitized(self):
    ...
```

### sub_sec_time_original property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/sub_sec_time_original.md

#### sub_sec_time_original property

Gets the DateTimeOriginal subseconds.
##### Definition:
```python
@property
def sub_sec_time_original(self):
    ...
```

### subject_area property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/subject_area.md

#### subject_area property

Gets the Subject area.
##### Definition:
```python
@property
def subject_area(self):
    ...
```

### subject_distance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/subject_distance.md

#### subject_distance property

Gets the Subject distance.
##### Definition:
```python
@property
def subject_distance(self):
    ...
```

### subject_distance_range property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/subject_distance_range.md

#### subject_distance_range property

Gets the Subject distance range.
##### Definition:
```python
@property
def subject_distance_range(self):
    ...
```

### subject_location property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/subject_location.md

#### subject_location property

Gets the Subject location.
##### Definition:
```python
@property
def subject_location(self):
    ...
```

### temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/temperature.md

#### temperature property

Gets the Temperature.
##### Definition:
```python
@property
def temperature(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### user_comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/user_comment.md

#### user_comment property

Gets the User comments.
##### Definition:
```python
@property
def user_comment(self):
    ...
```

### water_depth property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/water_depth.md

#### water_depth property

Gets the WaterDepth.
##### Definition:
```python
@property
def water_depth(self):
    ...
```

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawexiftagpackage/white_balance.md

#### white_balance property

Gets the White balance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### RawIFD1Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package.md

#### RawIFD1Package class

Represents IFD1 tags.

**Inheritance:** `RawIFD1Package` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawIFD1Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| thumbnail_offset | Gets the ThumbnailOffset. |
| thumbnail_lenght | Gets the ThumbnailLenght. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawIFD1Package indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### thumbnail_lenght property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/thumbnail_lenght.md

#### thumbnail_lenght property

Gets the ThumbnailLenght.
##### Definition:
```python
@property
def thumbnail_lenght(self):
    ...
```

### thumbnail_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/thumbnail_offset.md

#### thumbnail_offset property

Gets the ThumbnailOffset.
##### Definition:
```python
@property
def thumbnail_offset(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd1package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawIFD2Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package.md

#### RawIFD2Package class

Represents IFD1 tags.

**Inheritance:** `RawIFD2Package` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawIFD2Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| image_width | Gets the image width. |
| image_height | Gets the image height. |
| bits_per_sample | Gets the image BitsPerSample. |
| compression | Gets the image Compression. |
| photometric_interpretation | Gets the image PhotometricInterpretation. |
| strip_offset | Gets the image StripOffset. |
| samples_per_pixel | Gets the SamplesPerPixel. |
| row_per_strip | Gets the RowPerStrip. |
| strip_byte_counts | Gets the StripByteCounts. |
| planar_configuration | Gets the PlanarConfiguration. |
| unknown1 | Gets the Unknown1. |
| unknown2 | Gets the Unknown2. |
| unknown3 | Gets the Unknown3. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawIFD2Package indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bits_per_sample property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/bits_per_sample.md

#### bits_per_sample property

Gets the image BitsPerSample.
##### Definition:
```python
@property
def bits_per_sample(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/compression.md

#### compression property

Gets the image Compression.
##### Definition:
```python
@property
def compression(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/image_height.md

#### image_height property

Gets the image height.
##### Definition:
```python
@property
def image_height(self):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/image_width.md

#### image_width property

Gets the image width.
##### Definition:
```python
@property
def image_width(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### photometric_interpretation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/photometric_interpretation.md

#### photometric_interpretation property

Gets the image PhotometricInterpretation.
##### Definition:
```python
@property
def photometric_interpretation(self):
    ...
```

### planar_configuration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/planar_configuration.md

#### planar_configuration property

Gets the PlanarConfiguration.
##### Definition:
```python
@property
def planar_configuration(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### row_per_strip property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/row_per_strip.md

#### row_per_strip property

Gets the RowPerStrip.
##### Definition:
```python
@property
def row_per_strip(self):
    ...
```

### samples_per_pixel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/samples_per_pixel.md

#### samples_per_pixel property

Gets the SamplesPerPixel.
##### Definition:
```python
@property
def samples_per_pixel(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### strip_byte_counts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/strip_byte_counts.md

#### strip_byte_counts property

Gets the StripByteCounts.
##### Definition:
```python
@property
def strip_byte_counts(self):
    ...
```

### strip_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/strip_offset.md

#### strip_offset property

Gets the image StripOffset.
##### Definition:
```python
@property
def strip_offset(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### unknown1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/unknown1.md

#### unknown1 property

Gets the Unknown1.
##### Definition:
```python
@property
def unknown1(self):
    ...
```

### unknown2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/unknown2.md

#### unknown2 property

Gets the Unknown2.
##### Definition:
```python
@property
def unknown2(self):
    ...
```

### unknown3 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/unknown3.md

#### unknown3 property

Gets the Unknown3.
##### Definition:
```python
@property
def unknown3(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd2package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawIFD3Package class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package.md

#### RawIFD3Package class

Represents IFD1 tags.

**Inheritance:** `RawIFD3Package` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawIFD3Package type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| image_width | Gets the image width. |
| image_height | Gets the image height. |
| compression | Gets the image Compression. |
| strip_offset | Gets the image StripOffset. |
| strip_byte_counts | Gets the image StripByteCounts. |
| unknown1 | Gets the Unknown1. |
| unknown2 | Gets the Unknown2. |
| unknown3 | Gets the Unknown3. |
| unknown4 | Gets the Unknown4. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawIFD3Package indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/compression.md

#### compression property

Gets the image Compression.
##### Definition:
```python
@property
def compression(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/image_height.md

#### image_height property

Gets the image height.
##### Definition:
```python
@property
def image_height(self):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/image_width.md

#### image_width property

Gets the image width.
##### Definition:
```python
@property
def image_width(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### strip_byte_counts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/strip_byte_counts.md

#### strip_byte_counts property

Gets the image StripByteCounts.
##### Definition:
```python
@property
def strip_byte_counts(self):
    ...
```

### strip_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/strip_offset.md

#### strip_offset property

Gets the image StripOffset.
##### Definition:
```python
@property
def strip_offset(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### unknown1 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/unknown1.md

#### unknown1 property

Gets the Unknown1.
##### Definition:
```python
@property
def unknown1(self):
    ...
```

### unknown2 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/unknown2.md

#### unknown2 property

Gets the Unknown2.
##### Definition:
```python
@property
def unknown2(self):
    ...
```

### unknown3 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/unknown3.md

#### unknown3 property

Gets the Unknown3.
##### Definition:
```python
@property
def unknown3(self):
    ...
```

### unknown4 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/unknown4.md

#### unknown4 property

Gets the Unknown4.
##### Definition:
```python
@property
def unknown4(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawifd3package/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawMakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage.md

#### RawMakerNotePackage class

Represents Raw MakerNotes tags.

**Inheritance:** `RawMakerNotePackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawMakerNotePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawMakerNotePackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawmakernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage.md

#### RawPackage class

Represents Raw Package.

**Inheritance:** `RawPackage` →
`CustomPackage` →
`MetadataPackage`

The RawPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### RawTagType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtagtype.md

#### RawTagType enumeration

Represents the IFD data type.

The RawTagType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BYTE | An 8-bit unsigned integer. |
| ASCII | An 8-bit byte with a 7-bit ASCII character. |
| SHORT | A 16-bit unsigned integer. |
| LONG | A 32-bit unsigned integer. |
| RATIONAL | A pair of LONGs, numerator then denominator. |
| S_BYTE | An 8-bit signed integer. |
| UNDEFINED | An undefined 8-bit byte. |
| S_SHORT | A 16-bit signed integer. |
| S_LONG | A 32-bit signed integer. |
| S_RATIONAL | A pair of SLONGs, numerator then denominator. |
| FLOAT | A 4-byte IEEE floating point value. |
| DOUBLE | An 8-byte IEEE floating point value. |
| SUB_IFD | A 4-byte long offset value |

### RawTiffTagPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage.md

#### RawTiffTagPackage class

Represents Tiff tags.

**Inheritance:** `RawTiffTagPackage` →
`RawDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The RawTiffTagPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| raw_ifd1_package | Gets the IFD1. |
| raw_ifd2_package | Gets the IFD2. |
| raw_ifd3_package | Gets the IFD3. |
| raw_exif_tag_package | Gets the Exif tag (Exif IFD Pointer). |
| gps_ifd_package | Gets the GPS tag (GPSInfo IFD Pointer). |
| image_width | Gets the image width. |
| image_height | Gets the image height. |
| bits_per_sample | Gets the bits per sample. |
| compression | Gets compression. |
| photometric_interpretation | Gets 	PhotometricInterpretation. |
| image_description | Gets or sets a character string giving the title of the image.
<br/>It may be a comment such as "1988 company picnic" or the like. |
| make | Gets the macro mode. |
| model | Gets the model. |
| strip_offset | Gets the StripOffset. |
| orientation | Gets the orientation. |
| samples_per_pixel | Gets the SamplesPerPixel. |
| rows_per_strip | Gets the RowsPerStrip. |
| strip_byte_counts | Gets the strip byte counts. |
| x_resolution | Gets the XResolution. |
| y_resolution | Gets the YResolution. |
| planar_configuration | Gets the PlanarConfiguration. |
| resolution_unit | Gets the Resolution Unit. |
| transfer_function | Gets the TransferFunction. |
| software | Gets the Software. |
| date_time | Gets the DateTime. |
| artist | Gets the Artist. |
| white_point | Gets the WhitePoint. |
| primary_chromaticities | Gets the PrimaryChromaticities. |
| jpeg_interchange_format | Gets the JpegInterchangeFormat. |
| jpeg_interchange_format_length | Gets the JpegInterchangeFormatLength. |
| y_cb_cr_coefficients | Gets the YCbCrCoefficients. |
| y_cb_cr_sub_sampling | Gets the YCbCrSubSampling. |
| y_cb_cr_positioning | Gets the YCbCrPositioning. |
| reference_black_white | Gets the ReferenceBlackWhite. |
| copyright | Gets the Copyright. |
| exif | Gets the EXIF. |
| gps_ifd | Gets the EXIF. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all Raw tags stored in the package. |

### RawTiffTagPackage indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/artist.md

#### artist property

Gets the Artist.
##### Definition:
```python
@property
def artist(self):
    ...
```

### bits_per_sample property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/bits_per_sample.md

#### bits_per_sample property

Gets the bits per sample.
##### Definition:
```python
@property
def bits_per_sample(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/clear.md

#### clear(self)

Removes all Raw tags stored in the package.

```python

def clear(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/compression.md

#### compression property

Gets compression.
##### Definition:
```python
@property
def compression(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/copyright.md

#### copyright property

Gets the Copyright.
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/date_time.md

#### date_time property

Gets the DateTime.
##### Definition:
```python
@property
def date_time(self):
    ...
```

### exif property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/exif.md

#### exif property

Gets the EXIF.
##### Definition:
```python
@property
def exif(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gps_ifd property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/gps_ifd.md

#### gps_ifd property

Gets the EXIF.
##### Definition:
```python
@property
def gps_ifd(self):
    ...
```

### gps_ifd_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/gps_ifd_package.md

#### gps_ifd_package property

Gets the GPS tag (GPSInfo IFD Pointer).
##### Definition:
```python
@property
def gps_ifd_package(self):
    ...
```

### image_description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/image_description.md

#### image_description property

Gets or sets a character string giving the title of the image.
It may be a comment such as "1988 company picnic" or the like.
##### Definition:
```python
@property
def image_description(self):
    ...
@image_description.setter
def image_description(self, value):
    ...
```

### image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/image_height.md

#### image_height property

Gets the image height.
##### Definition:
```python
@property
def image_height(self):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/image_width.md

#### image_width property

Gets the image width.
##### Definition:
```python
@property
def image_width(self):
    ...
```

### jpeg_interchange_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/jpeg_interchange_format.md

#### jpeg_interchange_format property

Gets the JpegInterchangeFormat.
##### Definition:
```python
@property
def jpeg_interchange_format(self):
    ...
```

### jpeg_interchange_format_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/jpeg_interchange_format_length.md

#### jpeg_interchange_format_length property

Gets the JpegInterchangeFormatLength.
##### Definition:
```python
@property
def jpeg_interchange_format_length(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### make property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/make.md

#### make property

Gets the macro mode.
##### Definition:
```python
@property
def make(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/model.md

#### model property

Gets the model.
##### Definition:
```python
@property
def model(self):
    ...
```

### orientation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/orientation.md

#### orientation property

Gets the orientation.
##### Definition:
```python
@property
def orientation(self):
    ...
```

### photometric_interpretation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/photometric_interpretation.md

#### photometric_interpretation property

Gets 	PhotometricInterpretation.
##### Definition:
```python
@property
def photometric_interpretation(self):
    ...
```

### planar_configuration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/planar_configuration.md

#### planar_configuration property

Gets the PlanarConfiguration.
##### Definition:
```python
@property
def planar_configuration(self):
    ...
```

### primary_chromaticities property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/primary_chromaticities.md

#### primary_chromaticities property

Gets the PrimaryChromaticities.
##### Definition:
```python
@property
def primary_chromaticities(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_exif_tag_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/raw_exif_tag_package.md

#### raw_exif_tag_package property

Gets the Exif tag (Exif IFD Pointer).
##### Definition:
```python
@property
def raw_exif_tag_package(self):
    ...
```

### raw_ifd1_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/raw_ifd1_package.md

#### raw_ifd1_package property

Gets the IFD1.
##### Definition:
```python
@property
def raw_ifd1_package(self):
    ...
```

### raw_ifd2_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/raw_ifd2_package.md

#### raw_ifd2_package property

Gets the IFD2.
##### Definition:
```python
@property
def raw_ifd2_package(self):
    ...
```

### raw_ifd3_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/raw_ifd3_package.md

#### raw_ifd3_package property

Gets the IFD3.
##### Definition:
```python
@property
def raw_ifd3_package(self):
    ...
```

### reference_black_white property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/reference_black_white.md

#### reference_black_white property

Gets the ReferenceBlackWhite.
##### Definition:
```python
@property
def reference_black_white(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified Raw tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | int | A Raw tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### resolution_unit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/resolution_unit.md

#### resolution_unit property

Gets the Resolution Unit.
##### Definition:
```python
@property
def resolution_unit(self):
    ...
```

### rows_per_strip property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/rows_per_strip.md

#### rows_per_strip property

Gets the RowsPerStrip.
##### Definition:
```python
@property
def rows_per_strip(self):
    ...
```

### samples_per_pixel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/samples_per_pixel.md

#### samples_per_pixel property

Gets the SamplesPerPixel.
##### Definition:
```python
@property
def samples_per_pixel(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.raw.tag.RawTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/software.md

#### software property

Gets the Software.
##### Definition:
```python
@property
def software(self):
    ...
```

### strip_byte_counts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/strip_byte_counts.md

#### strip_byte_counts property

Gets the strip byte counts.
##### Definition:
```python
@property
def strip_byte_counts(self):
    ...
```

### strip_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/strip_offset.md

#### strip_offset property

Gets the StripOffset.
##### Definition:
```python
@property
def strip_offset(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all Raw tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### transfer_function property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/transfer_function.md

#### transfer_function property

Gets the TransferFunction.
##### Definition:
```python
@property
def transfer_function(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### white_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/white_point.md

#### white_point property

Gets the WhitePoint.
##### Definition:
```python
@property
def white_point(self):
    ...
```

### x_resolution property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/x_resolution.md

#### x_resolution property

Gets the XResolution.
##### Definition:
```python
@property
def x_resolution(self):
    ...
```

### y_cb_cr_coefficients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/y_cb_cr_coefficients.md

#### y_cb_cr_coefficients property

Gets the YCbCrCoefficients.
##### Definition:
```python
@property
def y_cb_cr_coefficients(self):
    ...
```

### y_cb_cr_positioning property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/y_cb_cr_positioning.md

#### y_cb_cr_positioning property

Gets the YCbCrPositioning.
##### Definition:
```python
@property
def y_cb_cr_positioning(self):
    ...
```

### y_cb_cr_sub_sampling property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/y_cb_cr_sub_sampling.md

#### y_cb_cr_sub_sampling property

Gets the YCbCrSubSampling.
##### Definition:
```python
@property
def y_cb_cr_sub_sampling(self):
    ...
```

### y_resolution property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.raw/rawtifftagpackage/y_resolution.md

#### y_resolution property

Gets the YResolution.
##### Definition:
```python
@property
def y_resolution(self):
    ...
```

### groupdocs.metadata.formats.riff
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff.md

The namespace provides functionality allowing users to work with metadata of various formats derived from the RIFF container.

##### Classes
| Class | Description |
| :- | :- |
| `RiffInfoPackage` | Represents the metadata package containing properties extracted from the RIFF INFO chunk. |

### RiffInfoPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage.md

#### RiffInfoPackage class

Represents the metadata package containing properties extracted from the RIFF INFO chunk.

**Inheritance:** `RiffInfoPackage` →
`CustomPackage` →
`MetadataPackage`

The RiffInfoPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| artist | Gets the artist of the original subject of the file. |
| comment | Gets the comment about the file or the subject of the file. |
| copyright | Gets the copyright information for the file. |
| creation_date | Gets the date the subject of the file was created. |
| engineer | Gets the name of the engineer who worked on the file. |
| genre | Gets the genre of the original work. |
| keywords | Gets the keywords that refer to the file or subject of the file. |
| name | Gets the title of the subject of the file. |
| subject | Gets a description of the file contents, such as "Aerial view of Seattle." |
| software | Gets the name of the software package used to create the file. |
| source | Gets the name of the person or organization who supplied the original subject of the file. |
| technician | Gets the technician who digitized the subject file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/artist.md

#### artist property

Gets the artist of the original subject of the file.
##### Definition:
```python
@property
def artist(self):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/comment.md

#### comment property

Gets the comment about the file or the subject of the file.
##### Definition:
```python
@property
def comment(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/copyright.md

#### copyright property

Gets the copyright information for the file.
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/creation_date.md

#### creation_date property

Gets the date the subject of the file was created.
##### Definition:
```python
@property
def creation_date(self):
    ...
```

### engineer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/engineer.md

#### engineer property

Gets the name of the engineer who worked on the file.
##### Definition:
```python
@property
def engineer(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/genre.md

#### genre property

Gets the genre of the original work.
##### Definition:
```python
@property
def genre(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/keywords.md

#### keywords property

Gets the keywords that refer to the file or subject of the file.
##### Definition:
```python
@property
def keywords(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/name.md

#### name property

Gets the title of the subject of the file.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/software.md

#### software property

Gets the name of the software package used to create the file.
##### Definition:
```python
@property
def software(self):
    ...
```

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/source.md

#### source property

Gets the name of the person or organization who supplied the original subject of the file.
##### Definition:
```python
@property
def source(self):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/subject.md

#### subject property

Gets a description of the file contents, such as "Aerial view of Seattle."
##### Definition:
```python
@property
def subject(self):
    ...
```

### technician property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/technician.md

#### technician property

Gets the technician who digitized the subject file.
##### Definition:
```python
@property
def technician(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.riff/riffinfopackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed.dae
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae.md

##### Classes
| Class | Description |
| :- | :- |
| `DaeNode` | Represents metadata associated with an .dae file. |
| `DaePackage` | Represents .dae file metadata. |
| `DaeRootPackage` | Represents .dae file metadata. |

### DaeNode class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode.md

#### DaeNode class

Represents metadata associated with an .dae file.

**Inheritance:** `DaeNode` →
`CustomPackage` →
`MetadataPackage`

The DaeNode type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daenode/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DaePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage.md

#### DaePackage class

Represents .dae file metadata.

**Inheritance:** `DaePackage` →
`CustomPackage` →
`MetadataPackage`

The DaePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |
| creation_time | Gets or Sets the creation time of this asset. |
| modification_time | Gets or Sets the modification time of this asset. |
| author | Gets or sets the author of this asset |
| comment | Gets or sets the comment of this asset. |
| title | Gets or sets the title of this asset |
| nodes | Gets an array of `DaeNode` entries inside the dae file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/author.md

#### author property

Gets or sets the author of this asset
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/comment.md

#### comment property

Gets or sets the comment of this asset.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/creation_time.md

#### creation_time property

Gets or Sets the creation time of this asset.
##### Definition:
```python
@property
def creation_time(self):
    ...
@creation_time.setter
def creation_time(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modification_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/modification_time.md

#### modification_time property

Gets or Sets the modification time of this asset.
##### Definition:
```python
@property
def modification_time(self):
    ...
@modification_time.setter
def modification_time(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### nodes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/nodes.md

#### nodes property

Gets an array of `DaeNode` entries inside the dae file.
##### Definition:
```python
@property
def nodes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/title.md

#### title property

Gets or sets the title of this asset
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### DaeRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage.md

#### DaeRootPackage class

Represents .dae file metadata.

**Inheritance:** `DaeRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The DaeRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| dae_package | Gets the Dae metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### dae_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/dae_package.md

#### dae_package property

Gets the Dae metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def dae_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.dae/daerootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed.fbx
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx.md

##### Classes
| Class | Description |
| :- | :- |
| `FbxNode` | Represents metadata associated with an .fbx file. |
| `FbxPackage` | Represents .fbx file metadata. |
| `FbxRootPackage` | Represents .fbx file metadata. |

### FbxNode class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode.md

#### FbxNode class

Represents metadata associated with an .fbx file.

**Inheritance:** `FbxNode` →
`CustomPackage` →
`MetadataPackage`

The FbxNode type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxnode/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### FbxPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage.md

#### FbxPackage class

Represents .fbx file metadata.

**Inheritance:** `FbxPackage` →
`CustomPackage` →
`MetadataPackage`

The FbxPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |
| author | Gets or sets the author of this asset |
| comment | Gets or sets the comment of this asset. |
| application_name | Gets or sets the application name of this asset |
| application_vendor | Gets or sets the a application vendor of this asset |
| application_version | Gets or sets the application version of this asset |
| url | Gets or sets the url of this asset |
| nodes | Gets an array of `FbxNode` entries inside the Fbx file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### application_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/application_name.md

#### application_name property

Gets or sets the application name of this asset
##### Definition:
```python
@property
def application_name(self):
    ...
@application_name.setter
def application_name(self, value):
    ...
```

### application_vendor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/application_vendor.md

#### application_vendor property

Gets or sets the a application vendor of this asset
##### Definition:
```python
@property
def application_vendor(self):
    ...
@application_vendor.setter
def application_vendor(self, value):
    ...
```

### application_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/application_version.md

#### application_version property

Gets or sets the application version of this asset
##### Definition:
```python
@property
def application_version(self):
    ...
@application_version.setter
def application_version(self, value):
    ...
```

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/author.md

#### author property

Gets or sets the author of this asset
##### Definition:
```python
@property
def author(self):
    ...
@author.setter
def author(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/comment.md

#### comment property

Gets or sets the comment of this asset.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### nodes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/nodes.md

#### nodes property

Gets an array of `FbxNode` entries inside the Fbx file.
##### Definition:
```python
@property
def nodes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxpackage/url.md

#### url property

Gets or sets the url of this asset
##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### FbxRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage.md

#### FbxRootPackage class

Represents .fbx file metadata.

**Inheritance:** `FbxRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The FbxRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| fbx_package | Gets the Fbx metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### fbx_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/fbx_package.md

#### fbx_package property

Gets the Fbx metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def fbx_package(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.fbx/fbxrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed.gltf
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf.md

##### Classes
| Class | Description |
| :- | :- |
| `GltfPackage` | Represents .glTF file metadata. |
| `GltfPropertyDefinition` | Represents metadata associated with an .glTF file. |
| `GltfPropertyTable` | Represents metadata associated with an .glTF file. |
| `GltfRootPackage` | Represents .glTF file metadata. |

### GltfPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage.md

#### GltfPackage class

Represents .glTF file metadata.

**Inheritance:** `GltfPackage` →
`CustomPackage` →
`MetadataPackage`

The GltfPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| property_tables |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### property_tables property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/property_tables.md

##### Definition:
```python
@property
def property_tables(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GltfPropertyDefinition class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition.md

#### GltfPropertyDefinition class

Represents metadata associated with an .glTF file.

**Inheritance:** `GltfPropertyDefinition` →
`CustomPackage` →
`MetadataPackage`

The GltfPropertyDefinition type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| property_name | Gets the property name. |
| property_type | Gets the property type. |
| property_value | Gets the property value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### property_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/property_name.md

#### property_name property

Gets the property name.
##### Definition:
```python
@property
def property_name(self):
    ...
```

### property_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/property_type.md

#### property_type property

Gets the property type.
##### Definition:
```python
@property
def property_type(self):
    ...
```

### property_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/property_value.md

#### property_value property

Gets the property value.
##### Definition:
```python
@property
def property_value(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertydefinition/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GltfPropertyTable class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable.md

#### GltfPropertyTable class

Represents metadata associated with an .glTF file.

**Inheritance:** `GltfPropertyTable` →
`CustomPackage` →
`MetadataPackage`

The GltfPropertyTable type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| property_table_name | Gets the Property Table name. |
| meta_class_name | Gets the Meta Class name. |
| properties | Gets the Properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### meta_class_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/meta_class_name.md

#### meta_class_name property

Gets the Meta Class name.
##### Definition:
```python
@property
def meta_class_name(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/properties.md

#### properties property

Gets the Properties.
##### Definition:
```python
@property
def properties(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### property_table_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/property_table_name.md

#### property_table_name property

Gets the Property Table name.
##### Definition:
```python
@property
def property_table_name(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfpropertytable/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### GltfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage.md

#### GltfRootPackage class

Represents .glTF file metadata.

**Inheritance:** `GltfRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The GltfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| gltf_package | Gets the Gltf metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gltf_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/gltf_package.md

#### gltf_package property

Gets the Gltf metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def gltf_package(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.gltf/gltfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed.stl
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl.md

##### Classes
| Class | Description |
| :- | :- |
| `StlNode` | Represents metadata associated with an .stl file. |
| `StlPackage` | Represents .stl file metadata. |
| `StlRootPackage` | Represents .stl file metadata. |

### StlNode class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode.md

#### StlNode class

Represents metadata associated with an .stl file.

**Inheritance:** `StlNode` →
`CustomPackage` →
`MetadataPackage`

The StlNode type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlnode/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### StlPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage.md

#### StlPackage class

Represents .stl file metadata.

**Inheritance:** `StlPackage` →
`CustomPackage` →
`MetadataPackage`

The StlPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |
| nodes | Gets an array of `StlNode` entries inside the 3ds file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### nodes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/nodes.md

#### nodes property

Gets an array of `StlNode` entries inside the 3ds file.
##### Definition:
```python
@property
def nodes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### StlRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage.md

#### StlRootPackage class

Represents .stl file metadata.

**Inheritance:** `StlRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The StlRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| stl_package | Gets the Stl package package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### stl_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/stl_package.md

#### stl_package property

Gets the Stl package package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def stl_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.stl/stlrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed.threeds
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds.md

##### Classes
| Class | Description |
| :- | :- |
| `ThreeDSNode` | Represents metadata associated with an .3ds file. |
| `ThreeDSPackage` | Represents .3ds file metadata. |
| `ThreeDSRootPackage` | Represents .3ds file metadata. |

### ThreeDSNode class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode.md

#### ThreeDSNode class

Represents metadata associated with an .3ds file.

**Inheritance:** `ThreeDSNode` →
`CustomPackage` →
`MetadataPackage`

The ThreeDSNode type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |
| materials | Gets the array of materials. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### materials property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/materials.md

#### materials property

Gets the array of materials.
##### Definition:
```python
@property
def materials(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsnode/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ThreeDSPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage.md

#### ThreeDSPackage class

Represents .3ds file metadata.

**Inheritance:** `ThreeDSPackage` →
`CustomPackage` →
`MetadataPackage`

The ThreeDSPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the node name. |
| materials | Gets the array of materials. |
| nodes | Gets an array of `ThreeDSNode` entries inside the 3ds file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### materials property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/materials.md

#### materials property

Gets the array of materials.
##### Definition:
```python
@property
def materials(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/name.md

#### name property

Gets the node name.
##### Definition:
```python
@property
def name(self):
    ...
```

### nodes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/nodes.md

#### nodes property

Gets an array of `ThreeDSNode` entries inside the 3ds file.
##### Definition:
```python
@property
def nodes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ThreeDSRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage.md

#### ThreeDSRootPackage class

Represents .3ds file metadata.

**Inheritance:** `ThreeDSRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The ThreeDSRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| three_ds_package | Gets the 3ds metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

The following code snippet shows how to get metadata from a 3D file.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### three_ds_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/three_ds_package.md

#### three_ds_package property

Gets the 3ds metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def three_ds_package(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.threeds/threedsrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.formats.threed
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.threed.md

### groupdocs.metadata.formats.video
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video.md

The namespace contains classes for working with the most popular video formats.

##### Classes
| Class | Description |
| :- | :- |
| `AsfAudioStreamProperty` | Represents Audio stream property metadata in the ASF media container. |
| `AsfBaseDescriptor` | Represents an ASF base metadata descriptor object. |
| `AsfBaseStreamProperty` | Represents base stream property metadata in the ASF media container. |
| `AsfCodec` | Represents ASF codec metadata. |
| `AsfContentDescriptor` | Represents an ASF content descriptor object. |
| `AsfMetadataDescriptor` | Represents an ASF metadata descriptor. |
| `AsfMetadataDescriptorCollection` | Represents a collection of metadata descriptors. |
| `AsfPackage` | Represents native metadata of the ASF media container. |
| `AsfRootPackage` | Represents the root package allowing working with metadata in an ASF video. |
| `AsfVideoStreamProperty` | Represents Video stream property metadata in the ASF media container. |
| `AviHeader` | Represents the AVIMAINHEADER structure in an AVI video. |
| `AviRootPackage` | Represents the root package allowing working with metadata in an AVI video. |
| `FlvHeader` | Represents a FLV video header. |
| `FlvRootPackage` | Represents the root package allowing working with metadata in an FLV video. |
| `MatroskaAudioTrack` | Represents audio metadata in a Matroska video. |
| `MatroskaBasePackage` | Provides a base metadata class for all packages extracted from a Matroska video. |
| `MatroskaEbmlHeader` | Represents EBML header metadata in a Matroska video. |
| `MatroskaPackage` | Represents a metadata container in a Matroska video. |
| `MatroskaRootPackage` | Represents the root package allowing working with metadata in a Matroska video. |
| `MatroskaSegment` | Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video. |
| `MatroskaSimpleTag` | Represents general information about the target in a Matroska video. |
| `MatroskaSubtitle` | Represents subtitle metadata in a Matroska video. |
| `MatroskaSubtitleTrack` | Represents subtitle metadata in a Matroska video. |
| `MatroskaTag` | Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video. |
| `MatroskaTrack` | Represents track metadata in a Matroska video. |
| `MatroskaVideoTrack` | Represents video metadata in a Matroska video. |
| `MovAtom` | Represents a QuickTime atom. |
| `MovPackage` | Represents QuickTime metadata. |
| `MovRootPackage` | Represents the root package allowing working with metadata in a QuickTime video. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `AsfCodecType` | Defines ASF codec types. |
| `AsfDescriptorType` | Defines ASF descriptor types. |
| `AsfExtendedStreamPropertyFlags` | Defines ASF extended stream property flags. |
| `AsfFilePropertyFlags` | Defines ASF file property flags. |
| `AsfStreamType` | Defines ASF stream types. |
| `AviHeaderFlags` | Represents AVI Header flags. |
| `MatroskaContentType` | Represents a Matroska content type. |
| `MatroskaTargetTypeValue` | Represents a number to indicate the logical level of the Matroska tag target. |
| `MatroskaTrackType` | Represents Matroska track types coded in 8 bits. |
| `MatroskaVideoDisplayUnit` | Defines how Matroska DisplayWidth and DisplayHeight are interpreted. |
| `MatroskaVideoFieldOrder` | Represents the field ordering of the Matroska video.
<br/>If FlagInterlaced is not set to 1, this Element MUST be ignored. |
| `MatroskaVideoFlagInterlaced` | Represents a flag to declare if the Matroska video is known to be progressive or interlaced
<br/>and if applicable to declare details about the interlacement. |
| `MatroskaVideoStereoMode` | Represents Matroska Stereo-3D video modes. |

### AsfAudioStreamProperty class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty.md

#### AsfAudioStreamProperty class

Represents Audio stream property metadata in the ASF media container.

**Inheritance:** `AsfAudioStreamProperty` →
`AsfBaseStreamProperty` →
`CustomPackage` →
`MetadataPackage`

The AsfAudioStreamProperty type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| stream_type | Gets the type of this stream. |
| stream_number | Gets the number of this stream. |
| start_time | Gets the presentation time of the first object, indicating where this digital media stream
<br/>starts within the context of the timeline of the ASF file as a whole. |
| end_time | Gets the presentation time of the last object plus the duration of play, indicating where
<br/>this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| bitrate | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| alternate_bitrate | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| flags | Gets the flags. |
| language | Gets the stream language. |
| average_time_per_frame | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| average_bitrate | Gets the average bitrate. |
| format_tag | Gets the unique ID of the codec used to encode the audio data. |
| channels | Gets the number of audio channels. |
| samples_per_second | Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream. |
| bits_per_sample | Gets the number of bits per sample of monaural data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternate_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/alternate_bitrate.md

#### alternate_bitrate property

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def alternate_bitrate(self):
    ...
```

### average_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/average_bitrate.md

#### average_bitrate property

Gets the average bitrate.
##### Definition:
```python
@property
def average_bitrate(self):
    ...
```

### average_time_per_frame property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/average_time_per_frame.md

#### average_time_per_frame property

Gets the average time duration, measured in 100-nanosecond units, of each frame.
##### Definition:
```python
@property
def average_time_per_frame(self):
    ...
```

### bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/bitrate.md

#### bitrate property

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def bitrate(self):
    ...
```

### bits_per_sample property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/bits_per_sample.md

#### bits_per_sample property

Gets the number of bits per sample of monaural data.
##### Definition:
```python
@property
def bits_per_sample(self):
    ...
```

### channels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/channels.md

#### channels property

Gets the number of audio channels.
##### Definition:
```python
@property
def channels(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### end_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/end_time.md

#### end_time property

Gets the presentation time of the last object plus the duration of play, indicating where
this digital media stream ends within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def end_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/flags.md

#### flags property

Gets the flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### format_tag property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/format_tag.md

#### format_tag property

Gets the unique ID of the codec used to encode the audio data.
##### Definition:
```python
@property
def format_tag(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/language.md

#### language property

Gets the stream language.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### samples_per_second property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/samples_per_second.md

#### samples_per_second property

Gets a value in Hertz (cycles per second) that represents the sampling rate of the audio stream.
##### Definition:
```python
@property
def samples_per_second(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### start_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/start_time.md

#### start_time property

Gets the presentation time of the first object, indicating where this digital media stream
starts within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def start_time(self):
    ...
```

### stream_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/stream_number.md

#### stream_number property

Gets the number of this stream.
##### Definition:
```python
@property
def stream_number(self):
    ...
```

### stream_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/stream_type.md

#### stream_type property

Gets the type of this stream.
##### Definition:
```python
@property
def stream_type(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfaudiostreamproperty/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AsfBaseDescriptor class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor.md

#### AsfBaseDescriptor class

Represents an ASF base metadata descriptor object.

**Inheritance:** `AsfBaseDescriptor` →
`MetadataProperty`

The AsfBaseDescriptor type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| asf_content_type | Gets the type of the content. |

##### Remarks

**Learn more** |
|
 |

### asf_content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/asf_content_type.md

#### asf_content_type property

Gets the type of the content.
##### Definition:
```python
@property
def asf_content_type(self):
    ...
```

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasedescriptor/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### AsfBaseStreamProperty class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty.md

#### AsfBaseStreamProperty class

Represents base stream property metadata in the ASF media container.

**Inheritance:** `AsfBaseStreamProperty` →
`CustomPackage` →
`MetadataPackage`

The AsfBaseStreamProperty type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| stream_type | Gets the type of this stream. |
| stream_number | Gets the number of this stream. |
| start_time | Gets the presentation time of the first object, indicating where this digital media stream
<br/>starts within the context of the timeline of the ASF file as a whole. |
| end_time | Gets the presentation time of the last object plus the duration of play, indicating where
<br/>this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| bitrate | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| alternate_bitrate | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| flags | Gets the flags. |
| language | Gets the stream language. |
| average_time_per_frame | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| average_bitrate | Gets the average bitrate. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternate_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/alternate_bitrate.md

#### alternate_bitrate property

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def alternate_bitrate(self):
    ...
```

### average_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/average_bitrate.md

#### average_bitrate property

Gets the average bitrate.
##### Definition:
```python
@property
def average_bitrate(self):
    ...
```

### average_time_per_frame property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/average_time_per_frame.md

#### average_time_per_frame property

Gets the average time duration, measured in 100-nanosecond units, of each frame.
##### Definition:
```python
@property
def average_time_per_frame(self):
    ...
```

### bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/bitrate.md

#### bitrate property

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def bitrate(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### end_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/end_time.md

#### end_time property

Gets the presentation time of the last object plus the duration of play, indicating where
this digital media stream ends within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def end_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/flags.md

#### flags property

Gets the flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/language.md

#### language property

Gets the stream language.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### start_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/start_time.md

#### start_time property

Gets the presentation time of the first object, indicating where this digital media stream
starts within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def start_time(self):
    ...
```

### stream_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/stream_number.md

#### stream_number property

Gets the number of this stream.
##### Definition:
```python
@property
def stream_number(self):
    ...
```

### stream_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/stream_type.md

#### stream_type property

Gets the type of this stream.
##### Definition:
```python
@property
def stream_type(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfbasestreamproperty/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AsfCodec class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec.md

#### AsfCodec class

Represents ASF codec metadata.

**Inheritance:** `AsfCodec` →
`CustomPackage` →
`MetadataPackage`

The AsfCodec type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| name | Gets the property name. |
| codec_type | Gets the type of the codec. |
| description | Gets the description. |
| information | Gets the information string. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### codec_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/codec_type.md

#### codec_type property

Gets the type of the codec.
##### Definition:
```python
@property
def codec_type(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/description.md

#### description property

Gets the description.
##### Definition:
```python
@property
def description(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/information.md

#### information property

Gets the information string.
##### Definition:
```python
@property
def information(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodec/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AsfCodecType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcodectype.md

#### AsfCodecType enumeration

Defines ASF codec types.

The AsfCodecType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Undefined codec. |
| VIDEO | Video codec. |
| AUDIO | Audio codec. |
| UNKNOWN | Unknown codec. |

### AsfContentDescriptor class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor.md

#### AsfContentDescriptor class

Represents an ASF content descriptor object.

**Inheritance:** `AsfContentDescriptor` →
`AsfBaseDescriptor` →
`MetadataProperty`

The AsfContentDescriptor type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| asf_content_type | Gets the type of the content. |

##### Remarks

**Learn more** |
|
 |

### asf_content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/asf_content_type.md

#### asf_content_type property

Gets the type of the content.
##### Definition:
```python
@property
def asf_content_type(self):
    ...
```

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfcontentdescriptor/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### AsfDescriptorType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfdescriptortype.md

#### AsfDescriptorType enumeration

Defines ASF descriptor types.

The AsfDescriptorType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNICODE | The unicode string type. |
| BYTE_ARRAY | The byte array type. |
| BOOL | The 32-bit bool type. |
| D_WORD | The 32-bit unsigned integer type. |
| Q_WORD | The 64-bit unsigned integer type. |
| WORD | The 16-bit unsigned integer type. |
| GUID | The 128-bit (16 byte) GUID type. |

### AsfExtendedStreamPropertyFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfextendedstreampropertyflags.md

#### AsfExtendedStreamPropertyFlags enumeration

Defines ASF extended stream property flags.

The AsfExtendedStreamPropertyFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RELIABLE | This digital media stream, if sent over a network, must be carried over a reliable data communications transport mechanism. |
| SEEKABLE | This flag should be set only if the stream is seekable. |
| NO_CLEANPOINTS | The stream does not contain any cleanpoints. |
| RESEND_LIVE_CLEANPOINTS | A stream is joined in mid-transmission, all information from the most recent
<br/>cleanpoint up to the current time should be sent before normal streaming begins at the current time. |

### AsfFilePropertyFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asffilepropertyflags.md

#### AsfFilePropertyFlags enumeration

Defines ASF file property flags.

The AsfFilePropertyFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | The undefined flag. |
| BROADCAST | Specifies, that a file is in the process of being created,
<br/>and thus that various values stored in the header objects are invalid. |
| SEEKABLE | Specifies, that a file is seekable. |

### AsfMetadataDescriptor class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor.md

#### AsfMetadataDescriptor class

Represents an ASF metadata descriptor.

**Inheritance:** `AsfMetadataDescriptor` →
`AsfBaseDescriptor` →
`MetadataProperty`

The AsfMetadataDescriptor type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| asf_content_type | Gets the type of the content. |
| language | Gets the language. |
| stream_number | Gets the stream number. |
| original_name | Gets the original name of the descriptor. |

##### Remarks

**Learn more** |
|
 |

### asf_content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/asf_content_type.md

#### asf_content_type property

Gets the type of the content.
##### Definition:
```python
@property
def asf_content_type(self):
    ...
```

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/language.md

#### language property

Gets the language.
##### Definition:
```python
@property
def language(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### original_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/original_name.md

#### original_name property

Gets the original name of the descriptor.
##### Definition:
```python
@property
def original_name(self):
    ...
```

### stream_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/stream_number.md

#### stream_number property

Gets the stream number.
##### Definition:
```python
@property
def stream_number(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptor/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### AsfMetadataDescriptorCollection class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection.md

#### AsfMetadataDescriptorCollection class

Represents a collection of metadata descriptors.

**Inheritance:** `AsfMetadataDescriptorCollection` →
`CustomPackage` →
`MetadataPackage`

The AsfMetadataDescriptorCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfmetadatadescriptorcollection/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AsfPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage.md

#### AsfPackage class

Represents native metadata of the ASF media container.

**Inheritance:** `AsfPackage` →
`CustomPackage` →
`MetadataPackage`

The AsfPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_id | Gets the unique identifier for this file. |
| creation_date | Gets the date and time of the initial creation of the file. |
| flags | Gets the header flags. |
| stream_properties | Gets the digital media stream properties. |
| metadata_descriptors | Gets the metadata descriptors. |
| codec_information | Gets the codec info entries. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### codec_information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/codec_information.md

#### codec_information property

Gets the codec info entries.
##### Definition:
```python
@property
def codec_information(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/creation_date.md

#### creation_date property

Gets the date and time of the initial creation of the file.
##### Definition:
```python
@property
def creation_date(self):
    ...
```

### file_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/file_id.md

#### file_id property

Gets the unique identifier for this file.
##### Definition:
```python
@property
def file_id(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/flags.md

#### flags property

Gets the header flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/metadata_descriptors.md

#### metadata_descriptors property

Gets the metadata descriptors.
##### Definition:
```python
@property
def metadata_descriptors(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### stream_properties property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/stream_properties.md

#### stream_properties property

Gets the digital media stream properties.
##### Definition:
```python
@property
def stream_properties(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AsfRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage.md

#### AsfRootPackage class

Represents the root package allowing working with metadata in an ASF video.

**Inheritance:** `AsfRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The AsfRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| asf_package | Gets the ASF metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### asf_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/asf_package.md

#### asf_package property

Gets the ASF metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to read native ASF metadata.
##### Definition:
```python
@property
def asf_package(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### AsfStreamType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfstreamtype.md

#### AsfStreamType enumeration

Defines ASF stream types.

The AsfStreamType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Undefined stream type. |
| AUDIO | ASF Audio Media. |
| VIDEO | ASF Video Media. |
| COMMAND | ASF Command Media. |
| JFIF | ASF JFIF Media. |
| DEGRADABLE_JPEG | ASF Degradable JPEG Media. |
| FILE_TRANSFER | ASF File Transfer Media. |
| BINARY | ASF Binary Media. |
| WEB_STREAM_SUBTYPE | ASF Web Stream Media Subtype. |
| WEB_STREAM_FORMAT | ASF Web Stream Format. |

### AsfVideoStreamProperty class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty.md

#### AsfVideoStreamProperty class

Represents Video stream property metadata in the ASF media container.

**Inheritance:** `AsfVideoStreamProperty` →
`AsfBaseStreamProperty` →
`CustomPackage` →
`MetadataPackage`

The AsfVideoStreamProperty type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| stream_type | Gets the type of this stream. |
| stream_number | Gets the number of this stream. |
| start_time | Gets the presentation time of the first object, indicating where this digital media stream
<br/>starts within the context of the timeline of the ASF file as a whole. |
| end_time | Gets the presentation time of the last object plus the duration of play, indicating where
<br/>this digital media stream ends within the context of the timeline of the ASF file as a whole. |
| bitrate | Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| alternate_bitrate | Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
<br/>of the stream without overflowing, excluding all ASF Data Packet overhead. |
| flags | Gets the flags. |
| language | Gets the stream language. |
| average_time_per_frame | Gets the average time duration, measured in 100-nanosecond units, of each frame. |
| average_bitrate | Gets the average bitrate. |
| image_width | Gets the width of the encoded image in pixels. |
| image_height | Gets the height of the encoded image in pixels. |
| compression | Gets the video compression Id. |
| bits_per_pixels | Gets the bits per pixels. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternate_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/alternate_bitrate.md

#### alternate_bitrate property

Gets the leak rate RAlt, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def alternate_bitrate(self):
    ...
```

### average_bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/average_bitrate.md

#### average_bitrate property

Gets the average bitrate.
##### Definition:
```python
@property
def average_bitrate(self):
    ...
```

### average_time_per_frame property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/average_time_per_frame.md

#### average_time_per_frame property

Gets the average time duration, measured in 100-nanosecond units, of each frame.
##### Definition:
```python
@property
def average_time_per_frame(self):
    ...
```

### bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/bitrate.md

#### bitrate property

Gets the leak rate R, in bits per second, of a leaky bucket that contains the data portion
of the stream without overflowing, excluding all ASF Data Packet overhead.
##### Definition:
```python
@property
def bitrate(self):
    ...
```

### bits_per_pixels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/bits_per_pixels.md

#### bits_per_pixels property

Gets the bits per pixels.
##### Definition:
```python
@property
def bits_per_pixels(self):
    ...
```

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/compression.md

#### compression property

Gets the video compression Id.
##### Definition:
```python
@property
def compression(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### end_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/end_time.md

#### end_time property

Gets the presentation time of the last object plus the duration of play, indicating where
this digital media stream ends within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def end_time(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/flags.md

#### flags property

Gets the flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/image_height.md

#### image_height property

Gets the height of the encoded image in pixels.
##### Definition:
```python
@property
def image_height(self):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/image_width.md

#### image_width property

Gets the width of the encoded image in pixels.
##### Definition:
```python
@property
def image_width(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/language.md

#### language property

Gets the stream language.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### start_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/start_time.md

#### start_time property

Gets the presentation time of the first object, indicating where this digital media stream
starts within the context of the timeline of the ASF file as a whole.
##### Definition:
```python
@property
def start_time(self):
    ...
```

### stream_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/stream_number.md

#### stream_number property

Gets the number of this stream.
##### Definition:
```python
@property
def stream_number(self):
    ...
```

### stream_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/stream_type.md

#### stream_type property

Gets the type of this stream.
##### Definition:
```python
@property
def stream_type(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/asfvideostreamproperty/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### AviHeader class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader.md

#### AviHeader class

Represents the AVIMAINHEADER structure in an AVI video.

**Inheritance:** `AviHeader` →
`CustomPackage` →
`MetadataPackage`

The AviHeader type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `AviHeader` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| micro_sec_per_frame | Gets the the number of microseconds between frames. This value indicates the overall timing for the file. |
| max_bytes_per_sec | Gets the approximate maximum data rate of the file.
<br/><br/>
<br/>This value indicates the number of bytes per second the system must handle to present an AVI sequence as
<br/>specified by the other parameters contained in the main header and stream header chunks. |
| padding_granularity | Gets the alignment for data, in bytes. Pad the data to multiples of this value. |
| avi_header_flags | Gets a bitwise combination of zero or more of the AVI flags. |
| total_frames | Gets the the total number of frames of data in the file. |
| initial_frames | Gets the initial frame for interleaved files.
<br/><br/>
<br/>Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames
<br/>in the file prior to the initial frame of the AVI sequence in this member. |
| streams | Gets the number of streams in the file. For example, a file with audio and video has two streams. |
| suggested_buffer_size | Gets the suggested buffer size for reading the file.
<br/><br/>
<br/>Generally, this size should be large enough to contain the largest chunk in the file.
<br/>If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file,
<br/>the buffer size should be large enough to read an entire record, and not just a chunk. |
| width | Gets the width of the AVI file in pixels. |
| height | Gets the height of the AVI file in pixels. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### AviHeader constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `AviHeader` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### avi_header_flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/avi_header_flags.md

#### avi_header_flags property

Gets a bitwise combination of zero or more of the AVI flags.
##### Definition:
```python
@property
def avi_header_flags(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/height.md

#### height property

Gets the height of the AVI file in pixels.
##### Definition:
```python
@property
def height(self):
    ...
```

### initial_frames property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/initial_frames.md

#### initial_frames property

Gets the initial frame for interleaved files.

Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames
in the file prior to the initial frame of the AVI sequence in this member.
##### Definition:
```python
@property
def initial_frames(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### max_bytes_per_sec property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/max_bytes_per_sec.md

#### max_bytes_per_sec property

Gets the approximate maximum data rate of the file.

This value indicates the number of bytes per second the system must handle to present an AVI sequence as
specified by the other parameters contained in the main header and stream header chunks.
##### Definition:
```python
@property
def max_bytes_per_sec(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### micro_sec_per_frame property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/micro_sec_per_frame.md

#### micro_sec_per_frame property

Gets the the number of microseconds between frames. This value indicates the overall timing for the file.
##### Definition:
```python
@property
def micro_sec_per_frame(self):
    ...
```

### padding_granularity property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/padding_granularity.md

#### padding_granularity property

Gets the alignment for data, in bytes. Pad the data to multiples of this value.
##### Definition:
```python
@property
def padding_granularity(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### streams property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/streams.md

#### streams property

Gets the number of streams in the file. For example, a file with audio and video has two streams.
##### Definition:
```python
@property
def streams(self):
    ...
```

### suggested_buffer_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/suggested_buffer_size.md

#### suggested_buffer_size property

Gets the suggested buffer size for reading the file.

Generally, this size should be large enough to contain the largest chunk in the file.
If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance. For an interleaved file,
the buffer size should be large enough to read an entire record, and not just a chunk.
##### Definition:
```python
@property
def suggested_buffer_size(self):
    ...
```

### total_frames property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/total_frames.md

#### total_frames property

Gets the the total number of frames of data in the file.
##### Definition:
```python
@property
def total_frames(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheader/width.md

#### width property

Gets the width of the AVI file in pixels.
##### Definition:
```python
@property
def width(self):
    ...
```

### AviHeaderFlags enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/aviheaderflags.md

#### AviHeaderFlags enumeration

Represents AVI Header flags.

The AviHeaderFlags type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HAS_INDEX | Indicates the AVI file has an index. |
| MUST_USE_INDEX | Indicates that application should use the index, rather than the physical ordering of the chunks in the file,
<br/>to determine the order of presentation of the data. For example, this flag could be used to create a list of frames for editing. |
| IS_INTERLEAVED | Indicates the AVI file is interleaved. |
| TRUST_CK_TYPE | Use CKType to find key frames. |
| WAS_CAPTURE_FILE | Indicates the AVI file is a specially allocated file used for capturing real-time video.
<br/>Applications should warn the user before writing over a file with this flag set because the user probably defragmented this file. |
| COPYRIGHTED | Indicates the AVI file contains copyrighted data and software.
<br/>When this flag is used, software should not permit the data to be duplicated. |

### AviRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage.md

#### AviRootPackage class

Represents the root package allowing working with metadata in an AVI video.

**Inheritance:** `AviRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The AviRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| header | Gets the AVI header package. |
| riff_info_package | Gets the package containing RIFF Info tags. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/header.md

#### header property

Gets the AVI header package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code snippet shows how to read AVI header properties.
##### Definition:
```python
@property
def header(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### riff_info_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/riff_info_package.md

#### riff_info_package property

Gets the package containing RIFF Info tags.
##### Definition:
```python
@property
def riff_info_package(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/avirootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### FlvHeader class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader.md

#### FlvHeader class

Represents a FLV video header.

**Inheritance:** `FlvHeader` →
`CustomPackage` →
`MetadataPackage`

The FlvHeader type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| version | Gets the file version. |
| type_flags | Gets the FLV type flags. |
| has_audio_tags | Gets a value indicating whether audio tags are present in the file. |
| has_video_tags | Gets a value indicating whether video tags are present in the file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### has_audio_tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/has_audio_tags.md

#### has_audio_tags property

Gets a value indicating whether audio tags are present in the file.
##### Definition:
```python
@property
def has_audio_tags(self):
    ...
```

### has_video_tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/has_video_tags.md

#### has_video_tags property

Gets a value indicating whether video tags are present in the file.
##### Definition:
```python
@property
def has_video_tags(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### type_flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/type_flags.md

#### type_flags property

Gets the FLV type flags.
##### Definition:
```python
@property
def type_flags(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvheader/version.md

#### version property

Gets the file version.
##### Definition:
```python
@property
def version(self):
    ...
```

### FlvRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage.md

#### FlvRootPackage class

Represents the root package allowing working with metadata in an FLV video.

**Inheritance:** `FlvRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The FlvRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |
| header | Gets the FLV header package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/header.md

#### header property

Gets the FLV header package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read FLV header properties.
##### Definition:
```python
@property
def header(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/flvrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### MatroskaAudioTrack class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack.md

#### MatroskaAudioTrack class

Represents audio metadata in a Matroska video.

**Inheritance:** `MatroskaAudioTrack` →
`MatroskaTrack` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaAudioTrack type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| track_number | Gets the track number as used in the Block Header.
<br/>Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| track_uid | Gets the unique ID to identify the Track.
<br/>This SHOULD be kept the same when making a direct stream copy of the Track to another file. |
| track_type | Gets the type of the track. |
| flag_enabled | Gets the enabled flag, true if the track is usable. |
| default_duration | Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame. |
| name | Gets the human-readable track name. |
| language | Gets the language of the track in the Matroska languages form.
<br/>This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry. |
| language_ietf | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
<br/>If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored. |
| codec_id | Gets an ID corresponding to the codec. |
| codec_name | Gets a human-readable string specifying the codec. |
| sampling_frequency | Gets the sampling frequency in Hz. |
| output_sampling_frequency | Gets the real output sampling frequency in Hz (used for SBR techniques). |
| channels | Gets the numbers of channels in the track. |
| bit_depth | Gets the bits per sample, mostly used for PCM. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### bit_depth property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/bit_depth.md

#### bit_depth property

Gets the bits per sample, mostly used for PCM.
##### Definition:
```python
@property
def bit_depth(self):
    ...
```

### channels property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/channels.md

#### channels property

Gets the numbers of channels in the track.
##### Definition:
```python
@property
def channels(self):
    ...
```

### codec_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/codec_id.md

#### codec_id property

Gets an ID corresponding to the codec.

##### Remarks

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### Definition:
```python
@property
def codec_id(self):
    ...
```

### codec_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/codec_name.md

#### codec_name property

Gets a human-readable string specifying the codec.
##### Definition:
```python
@property
def codec_name(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### default_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/default_duration.md

#### default_duration property

Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame.

##### Remarks

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### Definition:
```python
@property
def default_duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flag_enabled property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/flag_enabled.md

#### flag_enabled property

Gets the enabled flag, true if the track is usable.
##### Definition:
```python
@property
def flag_enabled(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/language.md

#### language property

Gets the language of the track in the Matroska languages form.
This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry.

##### Remarks

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french),
or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French).
Country codes are the same as used for internet domains.
##### Definition:
```python
@property
def language(self):
    ...
```

### language_ietf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/language_ietf.md

#### language_ietf property

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored.
##### Definition:
```python
@property
def language_ietf(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/name.md

#### name property

Gets the human-readable track name.
##### Definition:
```python
@property
def name(self):
    ...
```

### output_sampling_frequency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/output_sampling_frequency.md

#### output_sampling_frequency property

Gets the real output sampling frequency in Hz (used for SBR techniques).
##### Definition:
```python
@property
def output_sampling_frequency(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sampling_frequency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/sampling_frequency.md

#### sampling_frequency property

Gets the sampling frequency in Hz.
##### Definition:
```python
@property
def sampling_frequency(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/track_number.md

#### track_number property

Gets the track number as used in the Block Header.
Using more than 127 tracks is not encouraged, though the design allows an unlimited number.
##### Definition:
```python
@property
def track_number(self):
    ...
```

### track_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/track_type.md

#### track_type property

Gets the type of the track.
##### Definition:
```python
@property
def track_type(self):
    ...
```

### track_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/track_uid.md

#### track_uid property

Gets the unique ID to identify the Track.
This SHOULD be kept the same when making a direct stream copy of the Track to another file.
##### Definition:
```python
@property
def track_uid(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaaudiotrack/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaBasePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage.md

#### MatroskaBasePackage class

Provides a base metadata class for all packages extracted from a Matroska video.

**Inheritance:** `MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaBasePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskabasepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaContentType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskacontenttype.md

#### MatroskaContentType enumeration

Represents a Matroska content type.

The MatroskaContentType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Undefined content. |
| AUDIO | Defines the Matroska audio type. |
| VIDEO | Defines the Matroska video type. |
| VIDEO_3D | Defines the Matroska 3D video type. |

### MatroskaEbmlHeader class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader.md

#### MatroskaEbmlHeader class

Represents EBML header metadata in a Matroska video.

**Inheritance:** `MatroskaEbmlHeader` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaEbmlHeader type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| version | Gets the version of the EBML Writer that has been used to create the file. |
| read_version | Gets the minimum version an EBML parser needs to be compliant with to be able to read the file. |
| doc_type | Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'. |
| doc_type_version | Gets the version of the `MatroskaEbmlHeader.doc_type` writer used to create the file. |
| doc_type_read_version | Gets the minimum version number a `MatroskaEbmlHeader.doc_type` parser must be compliant with to read the file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### doc_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/doc_type.md

#### doc_type property

Gets the contents of the file. In the case of a MATROSKA file, its value is 'matroska'.
##### Definition:
```python
@property
def doc_type(self):
    ...
```

### doc_type_read_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/doc_type_read_version.md

#### doc_type_read_version property

Gets the minimum version number a `MatroskaEbmlHeader.doc_type` parser must be compliant with to read the file.
##### Definition:
```python
@property
def doc_type_read_version(self):
    ...
```

### doc_type_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/doc_type_version.md

#### doc_type_version property

Gets the version of the `MatroskaEbmlHeader.doc_type` writer used to create the file.
##### Definition:
```python
@property
def doc_type_version(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### read_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/read_version.md

#### read_version property

Gets the minimum version an EBML parser needs to be compliant with to be able to read the file.
##### Definition:
```python
@property
def read_version(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskaebmlheader/version.md

#### version property

Gets the version of the EBML Writer that has been used to create the file.
##### Definition:
```python
@property
def version(self):
    ...
```

### MatroskaPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage.md

#### MatroskaPackage class

Represents a metadata container in a Matroska video.

**Inheritance:** `MatroskaPackage` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| ebml_header | Gets the EBML header metadata. |
| segments | Gets the segment information metadata. |
| tracks | Gets the track metadata entries. |
| tags | Gets the tagging metadata. |
| content_type | Gets the Matroska content type. |
| subtitle_tracks | Gets the subtitle metadata entries. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/content_type.md

#### content_type property

Gets the Matroska content type.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### ebml_header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/ebml_header.md

#### ebml_header property

Gets the EBML header metadata.
##### Definition:
```python
@property
def ebml_header(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### segments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/segments.md

#### segments property

Gets the segment information metadata.
##### Definition:
```python
@property
def segments(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subtitle_tracks property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/subtitle_tracks.md

#### subtitle_tracks property

Gets the subtitle metadata entries.
##### Definition:
```python
@property
def subtitle_tracks(self):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/tags.md

#### tags property

Gets the tagging metadata.
##### Definition:
```python
@property
def tags(self):
    ...
```

### tracks property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/tracks.md

#### tracks property

Gets the track metadata entries.
##### Definition:
```python
@property
def tracks(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskapackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage.md

#### MatroskaRootPackage class

Represents the root package allowing working with metadata in a Matroska video.

**Inheritance:** `MatroskaRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The MatroskaRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| matroska_package | Gets the Matroska metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract subtitles from an MKV video.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### matroska_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/matroska_package.md

#### matroska_package property

Gets the Matroska metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to read Matroska format-specific metadata properties.
##### Definition:
```python
@property
def matroska_package(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskarootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaSegment class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment.md

#### MatroskaSegment class

Represents a SEGMENTINFO element containing general information about the SEGMENT in a Matroska video.

**Inheritance:** `MatroskaSegment` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaSegment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| segment_uid | Gets the unique 128 bit number identifying a SEGMENT.
<br/>Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID. |
| segment_filename | Gets the filename corresponding to this Segment. |
| timecode_scale | Gets the timecode scale value.
<br/>Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled! |
| duration | Gets the duration of the SEGMENT.
<br/>Please see `MatroskaSegment.timecode_scale` for more information. |
| date_utc | Gets the date and time that the Segment was created by the muxing application or library. |
| title | Gets the general name of the Segment. |
| muxing_app | Gets the full name of the application or library followed by the version number. |
| writing_app | Gets the full name of the application followed by the version number. |
| scaled_duration | Gets the scaled duration of the SEGMENT. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_utc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/date_utc.md

#### date_utc property

Gets the date and time that the Segment was created by the muxing application or library.
##### Definition:
```python
@property
def date_utc(self):
    ...
```

### duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/duration.md

#### duration property

Gets the duration of the SEGMENT.
Please see `MatroskaSegment.timecode_scale` for more information.
##### Definition:
```python
@property
def duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### muxing_app property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/muxing_app.md

#### muxing_app property

Gets the full name of the application or library followed by the version number.
##### Definition:
```python
@property
def muxing_app(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### scaled_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/scaled_duration.md

#### scaled_duration property

Gets the scaled duration of the SEGMENT.
##### Definition:
```python
@property
def scaled_duration(self):
    ...
```

### segment_filename property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/segment_filename.md

#### segment_filename property

Gets the filename corresponding to this Segment.
##### Definition:
```python
@property
def segment_filename(self):
    ...
```

### segment_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/segment_uid.md

#### segment_uid property

Gets the unique 128 bit number identifying a SEGMENT.
Obviously, a file can only be referred to by another file if a SEGMENTUID is present, however, playback is possible without that UID.
##### Definition:
```python
@property
def segment_uid(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### timecode_scale property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/timecode_scale.md

#### timecode_scale property

Gets the timecode scale value.
Each scaled timecode in a MATROSKA file is multiplied by TIMECODESCALE to obtain the timecode in nanoseconds. Note that not all timecodes are scaled!
##### Definition:
```python
@property
def timecode_scale(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/title.md

#### title property

Gets the general name of the Segment.
##### Definition:
```python
@property
def title(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### writing_app property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasegment/writing_app.md

#### writing_app property

Gets the full name of the application followed by the version number.
##### Definition:
```python
@property
def writing_app(self):
    ...
```

### MatroskaSimpleTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag.md

#### MatroskaSimpleTag class

Represents general information about the target in a Matroska video.

**Inheritance:** `MatroskaSimpleTag` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaSimpleTag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasimpletag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaSubtitle class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle.md

#### MatroskaSubtitle class

Represents subtitle metadata in a Matroska video.

**Inheritance:** `MatroskaSubtitle` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaSubtitle type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| timecode | Gets the time code. |
| duration | Gets the duration. |
| text | Gets the subtitle text. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/duration.md

#### duration property

Gets the duration.
##### Definition:
```python
@property
def duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/text.md

#### text property

Gets the subtitle text.
##### Definition:
```python
@property
def text(self):
    ...
```

### timecode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/timecode.md

#### timecode property

Gets the time code.
##### Definition:
```python
@property
def timecode(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitle/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaSubtitleTrack class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack.md

#### MatroskaSubtitleTrack class

Represents subtitle metadata in a Matroska video.

**Inheritance:** `MatroskaSubtitleTrack` →
`MatroskaTrack` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaSubtitleTrack type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| track_number | Gets the track number as used in the Block Header.
<br/>Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| track_uid | Gets the unique ID to identify the Track.
<br/>This SHOULD be kept the same when making a direct stream copy of the Track to another file. |
| track_type | Gets the type of the track. |
| flag_enabled | Gets the enabled flag, true if the track is usable. |
| default_duration | Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame. |
| name | Gets the human-readable track name. |
| language | Gets the language of the track in the Matroska languages form.
<br/>This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry. |
| language_ietf | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
<br/>If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored. |
| codec_id | Gets an ID corresponding to the codec. |
| codec_name | Gets a human-readable string specifying the codec. |
| subtitles | Gets the subtitles. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### codec_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/codec_id.md

#### codec_id property

Gets an ID corresponding to the codec.

##### Remarks

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### Definition:
```python
@property
def codec_id(self):
    ...
```

### codec_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/codec_name.md

#### codec_name property

Gets a human-readable string specifying the codec.
##### Definition:
```python
@property
def codec_name(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### default_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/default_duration.md

#### default_duration property

Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame.

##### Remarks

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### Definition:
```python
@property
def default_duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flag_enabled property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/flag_enabled.md

#### flag_enabled property

Gets the enabled flag, true if the track is usable.
##### Definition:
```python
@property
def flag_enabled(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/language.md

#### language property

Gets the language of the track in the Matroska languages form.
This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry.

##### Remarks

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french),
or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French).
Country codes are the same as used for internet domains.
##### Definition:
```python
@property
def language(self):
    ...
```

### language_ietf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/language_ietf.md

#### language_ietf property

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored.
##### Definition:
```python
@property
def language_ietf(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/name.md

#### name property

Gets the human-readable track name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subtitles property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/subtitles.md

#### subtitles property

Gets the subtitles.
##### Definition:
```python
@property
def subtitles(self):
    ...
```

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/track_number.md

#### track_number property

Gets the track number as used in the Block Header.
Using more than 127 tracks is not encouraged, though the design allows an unlimited number.
##### Definition:
```python
@property
def track_number(self):
    ...
```

### track_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/track_type.md

#### track_type property

Gets the type of the track.
##### Definition:
```python
@property
def track_type(self):
    ...
```

### track_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/track_uid.md

#### track_uid property

Gets the unique ID to identify the Track.
This SHOULD be kept the same when making a direct stream copy of the Track to another file.
##### Definition:
```python
@property
def track_uid(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskasubtitletrack/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag.md

#### MatroskaTag class

Represents metadata describing Tracks, Editions, Chapters, Attachments, or the Segment as a whole in a Matroska video.

**Inheritance:** `MatroskaTag` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaTag type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| target_type_value | Gets the number to indicate the logical level of the target. |
| target_type | Gets an informational string that can be used to display the logical level of the target.
<br/>Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc. |
| tag_track_uid | Gets a unique ID to identify the Track(s) the tags belong to.
<br/>If the value is 0 at this level, the tags apply to all tracks in the Segment. |
| simple_tags | Gets the general information about the target. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### simple_tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/simple_tags.md

#### simple_tags property

Gets the general information about the target.
##### Definition:
```python
@property
def simple_tags(self):
    ...
```

### tag_track_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/tag_track_uid.md

#### tag_track_uid property

Gets a unique ID to identify the Track(s) the tags belong to.
If the value is 0 at this level, the tags apply to all tracks in the Segment.
##### Definition:
```python
@property
def tag_track_uid(self):
    ...
```

### target_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/target_type.md

#### target_type property

Gets an informational string that can be used to display the logical level of the target.
Like "ALBUM", "TRACK", "MOVIE", "CHAPTER", etc.
##### Definition:
```python
@property
def target_type(self):
    ...
```

### target_type_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/target_type_value.md

#### target_type_value property

Gets the number to indicate the logical level of the target.
##### Definition:
```python
@property
def target_type_value(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatag/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaTargetTypeValue enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatargettypevalue.md

#### MatroskaTargetTypeValue enumeration

Represents a number to indicate the logical level of the Matroska tag target.

The MatroskaTargetTypeValue type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Undefined level. |
| COLLECTION | COLLECTION level. |
| EDITION | EDITION / ISSUE / VOLUME / OPUS / SEASON / SEQUEL level. |
| ALBUM | ALBUM / OPERA / CONCERT / MOVIE / EPISODE / CONCERT level. |
| PART | PART / SESSION level. |
| TRACK | TRACK / SONG / CHAPTER level. |
| SUBTRACK | SUBTRACK / PART / MOVEMENT / SCENE level. |
| SHOT | SHOT level. |

### MatroskaTrack class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack.md

#### MatroskaTrack class

Represents track metadata in a Matroska video.

**Inheritance:** `MatroskaTrack` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaTrack type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| track_number | Gets the track number as used in the Block Header.
<br/>Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| track_uid | Gets the unique ID to identify the Track.
<br/>This SHOULD be kept the same when making a direct stream copy of the Track to another file. |
| track_type | Gets the type of the track. |
| flag_enabled | Gets the enabled flag, true if the track is usable. |
| default_duration | Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame. |
| name | Gets the human-readable track name. |
| language | Gets the language of the track in the Matroska languages form.
<br/>This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry. |
| language_ietf | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
<br/>If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored. |
| codec_id | Gets an ID corresponding to the codec. |
| codec_name | Gets a human-readable string specifying the codec. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### codec_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/codec_id.md

#### codec_id property

Gets an ID corresponding to the codec.

##### Remarks

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### Definition:
```python
@property
def codec_id(self):
    ...
```

### codec_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/codec_name.md

#### codec_name property

Gets a human-readable string specifying the codec.
##### Definition:
```python
@property
def codec_name(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### default_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/default_duration.md

#### default_duration property

Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame.

##### Remarks

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### Definition:
```python
@property
def default_duration(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flag_enabled property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/flag_enabled.md

#### flag_enabled property

Gets the enabled flag, true if the track is usable.
##### Definition:
```python
@property
def flag_enabled(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/language.md

#### language property

Gets the language of the track in the Matroska languages form.
This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry.

##### Remarks

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french),
or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French).
Country codes are the same as used for internet domains.
##### Definition:
```python
@property
def language(self):
    ...
```

### language_ietf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/language_ietf.md

#### language_ietf property

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored.
##### Definition:
```python
@property
def language_ietf(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/name.md

#### name property

Gets the human-readable track name.
##### Definition:
```python
@property
def name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/track_number.md

#### track_number property

Gets the track number as used in the Block Header.
Using more than 127 tracks is not encouraged, though the design allows an unlimited number.
##### Definition:
```python
@property
def track_number(self):
    ...
```

### track_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/track_type.md

#### track_type property

Gets the type of the track.
##### Definition:
```python
@property
def track_type(self):
    ...
```

### track_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/track_uid.md

#### track_uid property

Gets the unique ID to identify the Track.
This SHOULD be kept the same when making a direct stream copy of the Track to another file.
##### Definition:
```python
@property
def track_uid(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatrack/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MatroskaTrackType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskatracktype.md

#### MatroskaTrackType enumeration

Represents Matroska track types coded in 8 bits.

The MatroskaTrackType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | The undefined track type. |
| VIDEO | Track is a video track. |
| AUDIO | Track is an audio track. |
| COMPLEX | Track is a complex track, i.e. a combined video and audio track. |
| LOGO | Track is a logo track. |
| SUBTITLE | Track is a subtitle track. |
| BUTTON | Track is a button track. |
| CONTROL | Track is a control track. |

### MatroskaVideoDisplayUnit enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideodisplayunit.md

#### MatroskaVideoDisplayUnit enumeration

Defines how Matroska DisplayWidth and DisplayHeight are interpreted.

The MatroskaVideoDisplayUnit type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PIXELS | Pixels unit. |
| CENTIMETERS | Centimeters unit. |
| INCHES | Inches unit. |
| ASPECT_RATIO | Display aspect ratio unit. |
| UNKNOWN | Unknown unit. |

### MatroskaVideoFieldOrder enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideofieldorder.md

#### MatroskaVideoFieldOrder enumeration

Represents the field ordering of the Matroska video.
If FlagInterlaced is not set to 1, this Element MUST be ignored.

The MatroskaVideoFieldOrder type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PROGRESSIVE | Progressive ordering. |
| TFF | Tiff ordering. |
| UNDETERMINED | Undetermined ordering. |
| BFF | Biff ordering. |
| BFF_SWAPPED | Bff (swapped) ordering. |
| TFF_SWAPPED | Tff (swapped) ordering. |

### MatroskaVideoFlagInterlaced enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideoflaginterlaced.md

#### MatroskaVideoFlagInterlaced enumeration

Represents a flag to declare if the Matroska video is known to be progressive or interlaced
and if applicable to declare details about the interlacement.

The MatroskaVideoFlagInterlaced type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDETERMINED | Undetermined flag. |
| INTERLACED | Interlaced flag. |
| PROGRESSIVE | Progressive flag. |

### MatroskaVideoStereoMode enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideostereomode.md

#### MatroskaVideoStereoMode enumeration

Represents Matroska Stereo-3D video modes.

The MatroskaVideoStereoMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MONO | Mono mode. |
| SIDE_BY_SIDE_LEFT | Side by side (left eye first) video mode. |
| TOP_BOTTOM_RIGHT | Top - bottom (right eye is first) video mode. |
| TOP_BOTTOM_LEFT | Top - bottom (left eye is first) video mode. |
| CHECKBOARD_RIGHT | Checkboard (right eye is first) video mode. |
| CHECKBOARD_LLEFT | Checkboard (left eye is first) video mode. |
| ROW_INTERLEAVED_RIGHT | Row interleaved (right eye is first) video mode. |
| ROW_INTERLEAVED_LEFT | Row interleaved (left eye is first) video mode. |
| COLUMN_INTERLEAVED_RIGHT | Column interleaved (right eye is first) video mode. |
| COLUMN_INTERLEAVED_LEFT | Column interleaved (left eye is first) video mode. |
| ANAGLYPH_CYAN_RED | Anaglyph (cyan/red) video mode. |
| SIDE_BY_SIDE_RIGHT | Side by side (right eye first) video mode. |
| ANAGLYPH_GREEN_MAGENTA | Anaglyph (green/magenta) video mode. |
| BOTH_EYES_LACED_LEFT | Both eyes laced in one Block (left eye is first) video mode. |
| BOTH_EYES_LACED_RIGHT | Both eyes laced in one Block (right eye is first) video mode. |

### MatroskaVideoTrack class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack.md

#### MatroskaVideoTrack class

Represents video metadata in a Matroska video.

**Inheritance:** `MatroskaVideoTrack` →
`MatroskaTrack` →
`MatroskaBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MatroskaVideoTrack type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| track_number | Gets the track number as used in the Block Header.
<br/>Using more than 127 tracks is not encouraged, though the design allows an unlimited number. |
| track_uid | Gets the unique ID to identify the Track.
<br/>This SHOULD be kept the same when making a direct stream copy of the Track to another file. |
| track_type | Gets the type of the track. |
| flag_enabled | Gets the enabled flag, true if the track is usable. |
| default_duration | Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame. |
| name | Gets the human-readable track name. |
| language | Gets the language of the track in the Matroska languages form.
<br/>This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry. |
| language_ietf | Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
<br/>If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored. |
| codec_id | Gets an ID corresponding to the codec. |
| codec_name | Gets a human-readable string specifying the codec. |
| flag_interlaced | Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement. |
| field_order | Gets declare the field ordering of the video.
<br/>If FlagInterlaced is not set to 1, this Element MUST be ignored. |
| stereo_mode | Gets the stereo-3D video mode. |
| alpha_mode | Gets the alpha Video Mode.
<br/>Presence of this Element indicates that the BlockAdditional Element could contain Alpha data. |
| pixel_width | Gets the width of the encoded video frames in pixels. |
| pixel_height | Gets the height of the encoded video frames in pixels. |
| pixel_crop_bottom | Gets the number of video pixels to remove at the bottom of the image. |
| pixel_crop_top | Gets the number of video pixels to remove at the top of the image. |
| pixel_crop_left | Gets the number of video pixels to remove on the left of the image. |
| pixel_crop_right | Gets the number of video pixels to remove on the right of the image. |
| display_width | Gets the width of the video frames to display.
<br/>Applies to the video frame after cropping (PixelCrop* Elements). |
| display_height | Gets the height of the video frames to display.
<br/>Applies to the video frame after cropping (PixelCrop* Elements). |
| display_unit | Gets the how `MatroskaVideoTrack.display_width`and `MatroskaVideoTrack.display_height` are interpreted. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alpha_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/alpha_mode.md

#### alpha_mode property

Gets the alpha Video Mode.
Presence of this Element indicates that the BlockAdditional Element could contain Alpha data.
##### Definition:
```python
@property
def alpha_mode(self):
    ...
```

### codec_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/codec_id.md

#### codec_id property

Gets an ID corresponding to the codec.

##### Remarks

See the http://www.matroska.org/technical/specs/codecid/index.html codec page for more info.
##### Definition:
```python
@property
def codec_id(self):
    ...
```

### codec_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/codec_name.md

#### codec_name property

Gets a human-readable string specifying the codec.
##### Definition:
```python
@property
def codec_name(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### default_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/default_duration.md

#### default_duration property

Gets the number of nanoseconds (not scaled via `MatroskaSegment.timecode_scale`) per frame.

##### Remarks

Note: 'frame' in the Matroska sense -- one Element put into a (Simple)Block.
##### Definition:
```python
@property
def default_duration(self):
    ...
```

### display_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/display_height.md

#### display_height property

Gets the height of the video frames to display.
Applies to the video frame after cropping (PixelCrop* Elements).
##### Definition:
```python
@property
def display_height(self):
    ...
```

### display_unit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/display_unit.md

#### display_unit property

Gets the how `MatroskaVideoTrack.display_width`and `MatroskaVideoTrack.display_height` are interpreted.
##### Definition:
```python
@property
def display_unit(self):
    ...
```

### display_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/display_width.md

#### display_width property

Gets the width of the video frames to display.
Applies to the video frame after cropping (PixelCrop* Elements).
##### Definition:
```python
@property
def display_width(self):
    ...
```

### field_order property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/field_order.md

#### field_order property

Gets declare the field ordering of the video.
If FlagInterlaced is not set to 1, this Element MUST be ignored.
##### Definition:
```python
@property
def field_order(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flag_enabled property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/flag_enabled.md

#### flag_enabled property

Gets the enabled flag, true if the track is usable.
##### Definition:
```python
@property
def flag_enabled(self):
    ...
```

### flag_interlaced property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/flag_interlaced.md

#### flag_interlaced property

Gets a flag to declare if the video is known to be progressive or interlaced and if applicable to declare details about the interlacement.
##### Definition:
```python
@property
def flag_interlaced(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/language.md

#### language property

Gets the language of the track in the Matroska languages form.
This Element MUST be ignored if the `MatroskaTrack.language_ietf` Element is used in the same TrackEntry.

##### Remarks

Language codes can be either the 3 letters bibliographic ISO-639-2 form (like "fre" for french),
or such a language code followed by a dash and a country code for specialities in languages(like "fre-ca" for Canadian French).
Country codes are the same as used for internet domains.
##### Definition:
```python
@property
def language(self):
    ...
```

### language_ietf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/language_ietf.md

#### language_ietf property

Gets the language of the track according to BCP 47 and using the IANA Language Subtag Registry.
If this Element is used, then any `MatroskaTrack.language` Elements used in the same TrackEntry MUST be ignored.
##### Definition:
```python
@property
def language_ietf(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/name.md

#### name property

Gets the human-readable track name.
##### Definition:
```python
@property
def name(self):
    ...
```

### pixel_crop_bottom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_crop_bottom.md

#### pixel_crop_bottom property

Gets the number of video pixels to remove at the bottom of the image.
##### Definition:
```python
@property
def pixel_crop_bottom(self):
    ...
```

### pixel_crop_left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_crop_left.md

#### pixel_crop_left property

Gets the number of video pixels to remove on the left of the image.
##### Definition:
```python
@property
def pixel_crop_left(self):
    ...
```

### pixel_crop_right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_crop_right.md

#### pixel_crop_right property

Gets the number of video pixels to remove on the right of the image.
##### Definition:
```python
@property
def pixel_crop_right(self):
    ...
```

### pixel_crop_top property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_crop_top.md

#### pixel_crop_top property

Gets the number of video pixels to remove at the top of the image.
##### Definition:
```python
@property
def pixel_crop_top(self):
    ...
```

### pixel_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_height.md

#### pixel_height property

Gets the height of the encoded video frames in pixels.
##### Definition:
```python
@property
def pixel_height(self):
    ...
```

### pixel_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/pixel_width.md

#### pixel_width property

Gets the width of the encoded video frames in pixels.
##### Definition:
```python
@property
def pixel_width(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### stereo_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/stereo_mode.md

#### stereo_mode property

Gets the stereo-3D video mode.
##### Definition:
```python
@property
def stereo_mode(self):
    ...
```

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/track_number.md

#### track_number property

Gets the track number as used in the Block Header.
Using more than 127 tracks is not encouraged, though the design allows an unlimited number.
##### Definition:
```python
@property
def track_number(self):
    ...
```

### track_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/track_type.md

#### track_type property

Gets the type of the track.
##### Definition:
```python
@property
def track_type(self):
    ...
```

### track_uid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/track_uid.md

#### track_uid property

Gets the unique ID to identify the Track.
This SHOULD be kept the same when making a direct stream copy of the Track to another file.
##### Definition:
```python
@property
def track_uid(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/matroskavideotrack/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MovAtom class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom.md

#### MovAtom class

Represents a QuickTime atom.

**Inheritance:** `MovAtom` →
`CustomPackage` →
`MetadataPackage`

The MovAtom type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| offset | Gets the atom offset. |
| size | Gets the atom size in bytes. |
| long_size | Gets the atom size in bytes. |
| type | Gets the 4-characters type. |
| data_offset | Gets the data offset. |
| data_size | Gets the data size in bytes. |
| has_extended_size | Gets a value indicating whether the extended size field was used to store the atom data. |
| atoms | Gets an array of `MovAtom` atoms. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### atoms property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/atoms.md

#### atoms property

Gets an array of `MovAtom` atoms.
##### Definition:
```python
@property
def atoms(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data_offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/data_offset.md

#### data_offset property

Gets the data offset.
##### Definition:
```python
@property
def data_offset(self):
    ...
```

### data_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/data_size.md

#### data_size property

Gets the data size in bytes.
##### Definition:
```python
@property
def data_size(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### has_extended_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/has_extended_size.md

#### has_extended_size property

Gets a value indicating whether the extended size field was used to store the atom data.
##### Definition:
```python
@property
def has_extended_size(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### long_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/long_size.md

#### long_size property

Gets the atom size in bytes.
##### Definition:
```python
@property
def long_size(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### offset property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/offset.md

#### offset property

Gets the atom offset.
##### Definition:
```python
@property
def offset(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/size.md

#### size property

Gets the atom size in bytes.
##### Definition:
```python
@property
def size(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/type.md

#### type property

Gets the 4-characters type.
##### Definition:
```python
@property
def type(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movatom/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MovPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage.md

#### MovPackage class

Represents QuickTime metadata.

**Inheritance:** `MovPackage` →
`CustomPackage` →
`MetadataPackage`

The MovPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| director | Name of the director of the movie content. |
| description | Description of the movie file content. |
| location_motion | An indication of the direction the camera is moving during the shot. |
| location_facing | An indication of the direction the camera is facing during the shot. |
| location_date | A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format. |
| location_role | A single byte, binary value containing a value from the set: 0 indicates “shooting location”, 1 indicates “real location”, 2 indicates “fictional location”.
<br/>Other values are reserved. |
| location_note | Descriptive comment. |
| location_body | The astronomical body, for compatibility with the 3GPP format |
| location_name | Name of the location. |
| user_ratings | A number, assigned by the user, that indicates the rating or relative value of the movie.
<br/>This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie. |
| users | A name indicating a user-defined collection that includes this movie. |
| year | Year when the movie file or the original content was created or recorded. |
| software | Name of software used to create the movie file content. |
| producer | Name of producer of movie file content. |
| album | Album or collection name of which the movie content forms a part |
| keywords | Keywords associated with the movie file content. |
| information | Information about the movie file content. |
| genre | Text describing the genre or genres to which the movie content conforms. |
| title | The title of the movie file content. |
| creation_date | The date the movie file content was created. |
| copyright | Copyright statement for the movie file content. |
| comment | User entered comment regarding the movie file content. |
| author | Name of the author of the movie file content. |
| artwork | A single image that can represent the movie file content. |
| artist | Name of the artist who created the movie file content. |
| publisher | Name of publisher of movie file content. |
| movie_creation_time | A 32-bit integer that specifies the creation calendar date and time for the movie atom. |
| movie_modification_time | A 32-bit integer that specifies the calendar date and time of the last change to the movie atom. |
| movie_duration | A time value that indicates the duration of the movie in seconds. |
| atoms | Gets an array of `MovAtom` atoms. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/album.md

#### album property

Album or collection name of which the movie content forms a part
##### Definition:
```python
@property
def album(self):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/artist.md

#### artist property

Name of the artist who created the movie file content.
##### Definition:
```python
@property
def artist(self):
    ...
```

### artwork property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/artwork.md

#### artwork property

A single image that can represent the movie file content.
##### Definition:
```python
@property
def artwork(self):
    ...
```

### atoms property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/atoms.md

#### atoms property

Gets an array of `MovAtom` atoms.
##### Definition:
```python
@property
def atoms(self):
    ...
```

### author property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/author.md

#### author property

Name of the author of the movie file content.
##### Definition:
```python
@property
def author(self):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/comment.md

#### comment property

User entered comment regarding the movie file content.
##### Definition:
```python
@property
def comment(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/copyright.md

#### copyright property

Copyright statement for the movie file content.
##### Definition:
```python
@property
def copyright(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/creation_date.md

#### creation_date property

The date the movie file content was created.
##### Definition:
```python
@property
def creation_date(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/description.md

#### description property

Description of the movie file content.
##### Definition:
```python
@property
def description(self):
    ...
```

### director property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/director.md

#### director property

Name of the director of the movie content.
##### Definition:
```python
@property
def director(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/genre.md

#### genre property

Text describing the genre or genres to which the movie content conforms.
##### Definition:
```python
@property
def genre(self):
    ...
```

### information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/information.md

#### information property

Information about the movie file content.
##### Definition:
```python
@property
def information(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/keywords.md

#### keywords property

Keywords associated with the movie file content.
##### Definition:
```python
@property
def keywords(self):
    ...
```

### location_body property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_body.md

#### location_body property

The astronomical body, for compatibility with the 3GPP format
##### Definition:
```python
@property
def location_body(self):
    ...
```

### location_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_date.md

#### location_date property

A date and time, stored using the extended format defined in ISO 8601:2004- Data elements and interchange format.
##### Definition:
```python
@property
def location_date(self):
    ...
```

### location_facing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_facing.md

#### location_facing property

An indication of the direction the camera is facing during the shot.
##### Definition:
```python
@property
def location_facing(self):
    ...
```

### location_motion property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_motion.md

#### location_motion property

An indication of the direction the camera is moving during the shot.
##### Definition:
```python
@property
def location_motion(self):
    ...
```

### location_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_name.md

#### location_name property

Name of the location.
##### Definition:
```python
@property
def location_name(self):
    ...
```

### location_note property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_note.md

#### location_note property

Descriptive comment.
##### Definition:
```python
@property
def location_note(self):
    ...
```

### location_role property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/location_role.md

#### location_role property

A single byte, binary value containing a value from the set: 0 indicates “shooting location”, 1 indicates “real location”, 2 indicates “fictional location”.
Other values are reserved.
##### Definition:
```python
@property
def location_role(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### movie_creation_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/movie_creation_time.md

#### movie_creation_time property

A 32-bit integer that specifies the creation calendar date and time for the movie atom.
##### Definition:
```python
@property
def movie_creation_time(self):
    ...
@movie_creation_time.setter
def movie_creation_time(self, value):
    ...
```

### movie_duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/movie_duration.md

#### movie_duration property

A time value that indicates the duration of the movie in seconds.
##### Definition:
```python
@property
def movie_duration(self):
    ...
```

### movie_modification_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/movie_modification_time.md

#### movie_modification_time property

A 32-bit integer that specifies the calendar date and time of the last change to the movie atom.
##### Definition:
```python
@property
def movie_modification_time(self):
    ...
@movie_modification_time.setter
def movie_modification_time(self, value):
    ...
```

### producer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/producer.md

#### producer property

Name of producer of movie file content.
##### Definition:
```python
@property
def producer(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/publisher.md

#### publisher property

Name of publisher of movie file content.
##### Definition:
```python
@property
def publisher(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/software.md

#### software property

Name of software used to create the movie file content.
##### Definition:
```python
@property
def software(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/title.md

#### title property

The title of the movie file content.
##### Definition:
```python
@property
def title(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### user_ratings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/user_ratings.md

#### user_ratings property

A number, assigned by the user, that indicates the rating or relative value of the movie.
This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.
##### Definition:
```python
@property
def user_ratings(self):
    ...
```

### users property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/users.md

#### users property

A name indicating a user-defined collection that includes this movie.
##### Definition:
```python
@property
def users(self):
    ...
```

### year property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movpackage/year.md

#### year property

Year when the movie file or the original content was created or recorded.
##### Definition:
```python
@property
def year(self):
    ...
```

### MovRootPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage.md

#### MovRootPackage class

Represents the root package allowing working with metadata in a QuickTime video.

**Inheritance:** `MovRootPackage` →
`RootMetadataPackage` →
`MetadataPackage`

The MovRootPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| file_type | Gets the file type metadata package. |
| mov_package | Gets the QuickTime metadata package. |
| xmp_package | Gets or sets the XMP metadata package. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

##### Remarks

**Learn more** |
|
 |
 |

##### Example

This example shows how to read QuickTime atoms in a MOV video.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/file_type.md

#### file_type property

Gets the file type metadata package.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mov_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/mov_package.md

#### mov_package property

Gets the QuickTime metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def mov_package(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.video/movrootpackage/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### groupdocs.metadata.formats
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.formats.md

### groupdocs.metadata.import_
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_.md

Types under `groupdocs.metadata.import_`.

##### Classes
| Class | Description |
| :- | :- |
| `ImportManager` |  |
| `ImportOptions` |  |
| `JsonImportOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ImportFormat` |  |

### ImportFormat class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importformat.md

#### ImportFormat class

The ImportFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| JSON |  |

### JSON field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importformat/json.md

##### Value
`0`

### ImportManager class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager.md

#### ImportManager class

The ImportManager type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _import__stream_import_format_import_options |  |
| _import__string_import_format_import_options |  |
| _init_root_metadata_package |  |
| import_ |  |
| import_file |  |
| import_stream |  |
| import_streams |  |
| import_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _import__stream_import_format_import_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/_import__stream_import_format_import_options.md

#### _import__stream_import_format_import_options

```python
def _import__stream_import_format_import_options(self, stream, format, import_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| format | `ImportFormat` |  |
| import_options | `ImportOptions` |  |

### _import__string_import_format_import_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/_import__string_import_format_import_options.md

#### _import__string_import_format_import_options

```python
def _import__string_import_format_import_options(self, file_path, format, import_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| format | `ImportFormat` |  |
| import_options | `ImportOptions` |  |

### _init_root_metadata_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/_init_root_metadata_package.md

#### _init_root_metadata_package

```python
def _init_root_metadata_package(self, root_metadata_package):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| root_metadata_package | `RootMetadataPackage` |  |

### import_ method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/import_.md

#### import_

```python
def import_(self):
    ...
```

### import_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/import_file.md

#### import_file

```python
def import_file(self):
    ...
```

### import_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/import_stream.md

#### import_stream

```python
def import_stream(self):
    ...
```

### import_streams method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/import_streams.md

#### import_streams

```python
def import_streams(self):
    ...
```

### import_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importmanager/import_string.md

#### import_string

```python
def import_string(self):
    ...
```

### ImportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importoptions.md

#### ImportOptions class

The ImportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/importoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### JsonImportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/jsonimportoptions.md

#### JsonImportOptions class

The JsonImportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/jsonimportoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.import_/jsonimportoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### groupdocs.metadata.importing
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing.md

##### Classes
| Class | Description |
| :- | :- |
| `ImportManager` | Provides a row of methods allowing the user to import metadata properties to various formats. |
| `ImportOptions` | Abstract class import options. |
| `JsonImportOptions` | Creates an import options from json file. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ImportFormat` | Defines file formats to which you can import metadata properties. |

### ImportFormat enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/importformat.md

#### ImportFormat enumeration

Defines file formats to which you can import metadata properties.

The ImportFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| JSON | Represents the .JSON format. |

### ImportManager class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/importmanager.md

#### ImportManager class

Provides a row of methods allowing the user to import metadata properties to various formats.

The ImportManager type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, root_metadata_package)` | Initializes a new instance of the `ImportManager` class. |

##### Methods
| Method | Description |
| :- | :- |
| `import_metadata(self, file_path, format, import_options)` | Imports the metadata properties to a file. |
| `import_metadata(self, stream, format, import_options)` | Imports the metadata properties to a file. |

### ImportManager constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/importmanager/__init__.md

#### \_\_init\_\_(self, root_metadata_package)

Initializes a new instance of the `ImportManager` class.

```python

def __init__(self, root_metadata_package):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| root_metadata_package | groupdocs.metadata.common.RootMetadataPackage | A collection of metadata properties where the import will be performed. |

### import_metadata method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/importmanager/import_metadata.md

#### import_metadata(self, file_path, format, import_options)

Imports the metadata properties to a file.

```python

def import_metadata(self, file_path, format, import_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The full name of the input file. |
| format | groupdocs.metadata.importing.ImportFormat | The format of the input file. |
| import_options | groupdocs.metadata.importing.ImportOptions | Additional options to use when importing. |

#### import_metadata(self, stream, format, import_options)

Imports the metadata properties to a file.

```python

def import_metadata(self, stream, format, import_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The filestream of the input file. |
| format | groupdocs.metadata.importing.ImportFormat | The format of the input file. |
| import_options | groupdocs.metadata.importing.ImportOptions | Additional options to use when importing. |

### ImportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/importoptions.md

#### ImportOptions class

Abstract class import options.

The ImportOptions type exposes the following members:

### JsonImportOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/jsonimportoptions.md

#### JsonImportOptions class

Creates an import options from json file.

**Inheritance:** `JsonImportOptions` →
`ImportOptions`

The JsonImportOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `JsonImportOptions` class. |

### JsonImportOptions constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.importing/jsonimportoptions/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `JsonImportOptions` class.

```python

def __init__(self):
    ...
```

### groupdocs.metadata.logging
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` |  |
| `FileLogger` |  |
| `ILogger` |  |
| `Logging` |  |

### ConsoleLogger class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.logging/consolelogger/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _trace_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.logging/consolelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### FileLogger class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger.md

#### FileLogger class

The FileLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _init_string |  |
| _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/metadata/python-net/groupdocs.metadata.logging/filelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| exception | `Exception` |  |

### _init_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/_init_string.md

#### _init_string

```python
def _init_string(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

### _trace_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/filelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.logging/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### Logging class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/logging.md

#### Logging class

The Logging type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| start |  |
| stop |  |

### start method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/logging/start.md

#### start

```python
def start(cls, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |

### stop method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.logging/logging/stop.md

#### stop

```python
def stop(cls):
    ...
```

### groupdocs.metadata.options
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `CreatePageStream` |  |
| `LoadOptions` |  |
| `PreviewOptions` |  |
| `ReleasePageStream` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PreviewFormats` |  |

### CreatePageStream class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream.md

#### CreatePageStream class

The CreatePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32 |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_async_callback_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/_begin_invoke_int32_async_callback_object.md

#### _begin_invoke_int32_async_callback_object

```python
def _begin_invoke_int32_async_callback_object(self, page_number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/_invoke_int32.md

#### _invoke_int32

```python
def _invoke_int32(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.options/createpagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_format |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| file_format |  |
| password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_format method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions/_init_file_format.md

#### _init_file_format

```python
def _init_file_format(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | `FileFormat` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/loadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### PreviewFormats class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.options/previewformats/bmp.md

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewformats/jpeg.md

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewformats/png.md

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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 |
| :- | :- |
| cache_folder |  |
| create_page_stream |  |
| height |  |
| max_disk_space_for_cache |  |
| max_memory_for_cache |  |
| page_numbers |  |
| preview_format |  |
| release_page_stream |  |
| resolution |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_page_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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` |  |

### cache_folder property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewoptions/cache_folder.md

##### Definition:
```python
@property
def cache_folder(self):
    ...
@cache_folder.setter
def cache_folder(self, value):
    ...
```

### create_page_stream property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.options/previewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### max_disk_space_for_cache property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewoptions/max_disk_space_for_cache.md

##### Definition:
```python
@property
def max_disk_space_for_cache(self):
    ...
@max_disk_space_for_cache.setter
def max_disk_space_for_cache(self, value):
    ...
```

### max_memory_for_cache property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewoptions/max_memory_for_cache.md

##### Definition:
```python
@property
def max_memory_for_cache(self):
    ...
@max_memory_for_cache.setter
def max_memory_for_cache(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.options/previewoptions/resolution.md

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/previewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream.md

#### ReleasePageStream class

The ReleasePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_stream |  |
| 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/metadata/python-net/groupdocs.metadata.options/releasepagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_stream_async_callback_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/_begin_invoke_int32_stream_async_callback_object.md

#### _begin_invoke_int32_stream_async_callback_object

```python
def _begin_invoke_int32_stream_async_callback_object(self, page_number, page_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/_invoke_int32_stream.md

#### _invoke_int32_stream

```python
def _invoke_int32_stream(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.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/metadata/python-net/groupdocs.metadata.options/releasepagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.options/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### groupdocs.metadata.search
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search.md

##### Classes
| Class | Description |
| :- | :- |
| `AndSpecification` | Represents a composite specification that uses the logical AND operator to combine two given search specifications. |
| `AnySpecification` | Represents a specification that applies no filters to a property. |
| `ContainsTagSpecification` | Represents a specification that checks whether the passed property contains the specified tag. |
| `FallsIntoCategorySpecification` | Represents a specification that verifies whether the passed property falls into a particular category
<br/>(i.e. contains tags from the specified category). |
| `NotSpecification` | Represents a composite specification that negates any other specification. |
| `OfTypeSpecification` | Represents a specification that filters properties of a particular type. |
| `OrSpecification` | Represents a composite specification that uses the logical OR operator to combine two given search specifications. |
| `Specification` | Provides a base abstract class for search specifications that can be combined using logical operators. |
| `WithNameSpecification` | Represents a specification that filters properties with a particular name. |
| `WithValueSpecification` | Represents a specification that filters properties with a particular value. |

### AndSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification.md

#### AndSpecification class

Represents a composite specification that uses the logical AND operator to combine two given search specifications.

**Inheritance:** `AndSpecification` →
`Specification`

The AndSpecification type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| left | Gets the left specification. |
| right | Gets the right specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/left.md

#### left property

Gets the left specification.
##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/andspecification/right.md

#### right property

Gets the right specification.
##### Definition:
```python
@property
def right(self):
    ...
```

### AnySpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification.md

#### AnySpecification class

Represents a specification that applies no filters to a property.

**Inheritance:** `AnySpecification` →
`Specification`

The AnySpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Constructs a new instance of AnySpecification |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### AnySpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification/__init__.md

#### \_\_init\_\_(self)

Constructs a new instance of AnySpecification

```python

def __init__(self):
    ...
```

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/anyspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### ContainsTagSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification.md

#### ContainsTagSpecification class

Represents a specification that checks whether the passed property contains the specified tag.

**Inheritance:** `ContainsTagSpecification` →
`Specification`

The ContainsTagSpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tag)` | Initializes a new instance of the `ContainsTagSpecification` class. |

##### Properties
| Property | Description |
| :- | :- |
| tag | Gets the tag a property must contain to satisfy the specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### ContainsTagSpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/__init__.md

#### \_\_init\_\_(self, tag)

Initializes a new instance of the `ContainsTagSpecification` class.

```python

def __init__(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.tagging.PropertyTag | The tag a property must contain to satisfy the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### tag property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/containstagspecification/tag.md

#### tag property

Gets the tag a property must contain to satisfy the specification.
##### Definition:
```python
@property
def tag(self):
    ...
```

### FallsIntoCategorySpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification.md

#### FallsIntoCategorySpecification class

Represents a specification that verifies whether the passed property falls into a particular category
(i.e. contains tags from the specified category).

**Inheritance:** `FallsIntoCategorySpecification` →
`Specification`

The FallsIntoCategorySpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, category)` | Initializes a new instance of the `FallsIntoCategorySpecification` class. |

##### Properties
| Property | Description |
| :- | :- |
| category | Gets the category into which a property must fall to satisfy the specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### FallsIntoCategorySpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/__init__.md

#### \_\_init\_\_(self, category)

Initializes a new instance of the `FallsIntoCategorySpecification` class.

```python

def __init__(self, category):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| category | groupdocs.metadata.tagging.TagCategory | The category into which a property must fall to satisfy the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/category.md

#### category property

Gets the category into which a property must fall to satisfy the specification.
##### Definition:
```python
@property
def category(self):
    ...
```

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/fallsintocategoryspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### NotSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification.md

#### NotSpecification class

Represents a composite specification that negates any other specification.

**Inheritance:** `NotSpecification` →
`Specification`

The NotSpecification type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| wrapped | Gets the base specification to be negated. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### wrapped property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/notspecification/wrapped.md

#### wrapped property

Gets the base specification to be negated.
##### Definition:
```python
@property
def wrapped(self):
    ...
```

### OfTypeSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification.md

#### OfTypeSpecification class

Represents a specification that filters properties of a particular type.

**Inheritance:** `OfTypeSpecification` →
`Specification`

The OfTypeSpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, property_type)` | Initializes a new instance of the `OfTypeSpecification` class. |

##### Properties
| Property | Description |
| :- | :- |
| property_type | Gets the type of properties that satisfy the specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### OfTypeSpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/__init__.md

#### \_\_init\_\_(self, property_type)

Initializes a new instance of the `OfTypeSpecification` class.

```python

def __init__(self, property_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_type | groupdocs.metadata.common.MetadataPropertyType | The type of properties that satisfy the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### property_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/oftypespecification/property_type.md

#### property_type property

Gets the type of properties that satisfy the specification.
##### Definition:
```python
@property
def property_type(self):
    ...
```

### OrSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification.md

#### OrSpecification class

Represents a composite specification that uses the logical OR operator to combine two given search specifications.

**Inheritance:** `OrSpecification` →
`Specification`

The OrSpecification type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| left | Gets the left specification. |
| right | Gets the right specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/left.md

#### left property

Gets the left specification.
##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/orspecification/right.md

#### right property

Gets the right specification.
##### Definition:
```python
@property
def right(self):
    ...
```

### Specification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/specification.md

#### Specification class

Provides a base abstract class for search specifications that can be combined using logical operators.

The Specification type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/specification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/specification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/specification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/specification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### WithNameSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification.md

#### WithNameSpecification class

Represents a specification that filters properties with a particular name.

**Inheritance:** `WithNameSpecification` →
`Specification`

The WithNameSpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, property_name)` | Initializes a new instance of the `WithNameSpecification` class. |
| `__init__(self, property_name, ignore_case)` | Initializes a new instance of the `WithNameSpecification` class. |

##### Properties
| Property | Description |
| :- | :- |
| property_name | Gets the name of properties that satisfy the specification. |
| ignore_case | Gets a value indicating whether the case of the strings being compared should be ignored. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### WithNameSpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/__init__.md

#### \_\_init\_\_(self, property_name)

Initializes a new instance of the `WithNameSpecification` class.

```python

def __init__(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The type of properties that satisfy the specification. |

#### \_\_init\_\_(self, property_name, ignore_case)

Initializes a new instance of the `WithNameSpecification` class.

```python

def __init__(self, property_name, ignore_case):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The type of properties that satisfy the specification. |
| ignore_case | bool | A value indicating whether the case of the strings being compared should be ignored. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### ignore_case property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/ignore_case.md

#### ignore_case property

Gets a value indicating whether the case of the strings being compared should be ignored.
##### Definition:
```python
@property
def ignore_case(self):
    ...
```

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### property_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withnamespecification/property_name.md

#### property_name property

Gets the name of properties that satisfy the specification.
##### Definition:
```python
@property
def property_name(self):
    ...
```

### WithValueSpecification class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification.md

#### WithValueSpecification class

Represents a specification that filters properties with a particular value.

**Inheritance:** `WithValueSpecification` →
`Specification`

The WithValueSpecification type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, property_value)` | Initializes a new instance of the `WithNameSpecification` class. |

##### Properties
| Property | Description |
| :- | :- |
| property_value | Gets the value of properties that satisfy the specification. |

##### Methods
| Method | Description |
| :- | :- |
| `is_satisfied_by(self, candidate)` | Verifies whether a `MetadataProperty` satisfies the specification. |
| `both(self, other)` | Combines two search specifications using the logical AND operator. |
| `either(self, other)` | Combines two search specifications using the logical OR operator. |
| `is_not(self)` | Negates the specification. |

### WithValueSpecification constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/__init__.md

#### \_\_init\_\_(self, property_value)

Initializes a new instance of the `WithNameSpecification` class.

```python

def __init__(self, property_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_value | System.Object | The type of properties that satisfy the specification. |

### both method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/both.md

#### both(self, other)

Combines two search specifications using the logical AND operator.

##### Returns

A composite specification.

```python

def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### either method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/either.md

#### either(self, other)

Combines two search specifications using the logical OR operator.

##### Returns

A composite specification.

```python

def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.metadata.search.Specification | A specification to combine with. |

### is_not method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/is_not.md

#### is_not(self)

Negates the specification.

##### Returns

A composite specification.

```python

def is_not(self):
    ...
```

### is_satisfied_by method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/is_satisfied_by.md

#### is_satisfied_by(self, candidate)

Verifies whether a `MetadataProperty` satisfies the specification.

##### Returns

True, if the passed property satisfies the specification; otherwise, false.

```python

def is_satisfied_by(self, candidate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| candidate | groupdocs.metadata.common.MetadataProperty | A metadata property to test. |

### property_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.search/withvaluespecification/property_value.md

#### property_value property

Gets the value of properties that satisfy the specification.
##### Definition:
```python
@property
def property_value(self):
    ...
```

### groupdocs.metadata.standards.dublincore
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore.md

The namespace contains functionality intended to read DublinCore metadata from files of different formats.

##### Classes
| Class | Description |
| :- | :- |
| `DublinCorePackage` | Represents a Dublin Core metadata package. |
| `IDublinCore` | Defines base operations allowing working with Dublin Core metadata. |

### DublinCorePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage.md

#### DublinCorePackage class

Represents a Dublin Core metadata package.

**Inheritance:** `DublinCorePackage` →
`CustomPackage` →
`MetadataPackage`

The DublinCorePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| contributor | Gets the contributor Dublin Core element. |
| coverage | Gets the coverage Dublin Core element. |
| creator | Gets the creator Dublin Core element. |
| date | Gets the date Dublin Core element. |
| description | Gets the description Dublin Core element. |
| format | Gets the format Dublin Core element. |
| language | Gets the language Dublin Core element. |
| publisher | Gets the publisher Dublin Core element. |
| relation | Gets the relation Dublin Core element. |
| source | Gets the source Dublin Core element. |
| subject | Gets the subject Dublin Core element. |
| title | Gets the title Dublin Core element. |
| type | Gets the type Dublin Core element. |
| rights | Gets the rights Dublin Core element. |
| identifier | Gets the identifier Dublin Core element. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contributor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/contributor.md

#### contributor property

Gets the contributor Dublin Core element.
##### Definition:
```python
@property
def contributor(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/creator.md

#### creator property

Gets the creator Dublin Core element.
##### Definition:
```python
@property
def creator(self):
    ...
```

### date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/date.md

#### date property

Gets the date Dublin Core element.
##### Definition:
```python
@property
def date(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/description.md

#### description property

Gets the description Dublin Core element.
##### Definition:
```python
@property
def description(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/format.md

#### format property

Gets the format Dublin Core element.
##### Definition:
```python
@property
def format(self):
    ...
```

### identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/identifier.md

#### identifier property

Gets the identifier Dublin Core element.
##### Definition:
```python
@property
def identifier(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/language.md

#### language property

Gets the language Dublin Core element.
##### Definition:
```python
@property
def language(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/publisher.md

#### publisher property

Gets the publisher Dublin Core element.
##### Definition:
```python
@property
def publisher(self):
    ...
```

### relation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/relation.md

#### relation property

Gets the relation Dublin Core element.
##### Definition:
```python
@property
def relation(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### rights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/rights.md

#### rights property

Gets the rights Dublin Core element.
##### Definition:
```python
@property
def rights(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/source.md

#### source property

Gets the source Dublin Core element.
##### Definition:
```python
@property
def source(self):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/subject.md

#### subject property

Gets the subject Dublin Core element.
##### Definition:
```python
@property
def subject(self):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/title.md

#### title property

Gets the title Dublin Core element.
##### Definition:
```python
@property
def title(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/type.md

#### type property

Gets the type Dublin Core element.
##### Definition:
```python
@property
def type(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/dublincorepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IDublinCore class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/idublincore.md

#### IDublinCore class

Defines base operations allowing working with Dublin Core metadata.

The IDublinCore type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| dublin_core_package | Gets the Dublin Core metadata package extracted from the document. |

### dublin_core_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.dublincore/idublincore/dublin_core_package.md

#### dublin_core_package property

Gets the Dublin Core metadata package extracted from the document.
##### Definition:
```python
@property
def dublin_core_package(self):
    ...
```

### groupdocs.metadata.standards.exif.makernote
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote.md

The namespace contains classes intended to work with MakerNote metadata written by various camera manufacturers.

##### Classes
| Class | Description |
| :- | :- |
| `CanonCameraSettingsPackage` | Represents CANON camera settings. |
| `CanonMakerNotePackage` | Represents CANON MakerNote metadata. |
| `MakerNotePackage` | Provides an abstract base class for MakerNote metadata packages. |
| `NikonMakerNotePackage` | Represents NIKON MakerNote metadata. |
| `PanasonicMakerNotePackage` | Represents PANASONIC MakerNote metadata. |
| `SonyMakerNotePackage` | Represents SONY MakerNote metadata. |

### CanonCameraSettingsPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage.md

#### CanonCameraSettingsPackage class

Represents CANON camera settings.

**Inheritance:** `CanonCameraSettingsPackage` →
`CustomPackage` →
`MetadataPackage`

The CanonCameraSettingsPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| macro_mode | Gets the macro mode. |
| self_timer | Gets the self timer. |
| quality | Gets the quality. |
| canon_flash_mode | Gets the canon flash mode. |
| continuous_drive | Gets the continuous drive. |
| focus_mode | Gets the focus mode. |
| record_mode | Gets the record mode. |
| canon_image_size | Gets the size of the canon image. |
| easy_mode | Gets the easy mode. |
| digital_zoom | Gets the digital zoom. |
| contrast | Gets the contrast. |
| saturation | Gets the saturation. |
| sharpness | Gets the sharpness. |
| camera_iso | Gets the camera iso. |
| metering_mode | Gets the metering mode. |
| focus_range | Gets the focus range. |
| af_point | Gets the AFPoint. |
| canon_exposure_mode | Gets the canon exposure mode. |
| lens_type | Gets the type of the lens. |
| max_focal_length | Gets the maximum length of the focal. |
| min_focal_length | Gets the minimum length of the focal. |
| image_stabilization | Gets the image stabilization. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_point property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/af_point.md

#### af_point property

Gets the AFPoint.
##### Definition:
```python
@property
def af_point(self):
    ...
```

### camera_iso property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/camera_iso.md

#### camera_iso property

Gets the camera iso.
##### Definition:
```python
@property
def camera_iso(self):
    ...
```

### canon_exposure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canon_exposure_mode.md

#### canon_exposure_mode property

Gets the canon exposure mode.
##### Definition:
```python
@property
def canon_exposure_mode(self):
    ...
```

### canon_flash_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canon_flash_mode.md

#### canon_flash_mode property

Gets the canon flash mode.
##### Definition:
```python
@property
def canon_flash_mode(self):
    ...
```

### canon_image_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/canon_image_size.md

#### canon_image_size property

Gets the size of the canon image.
##### Definition:
```python
@property
def canon_image_size(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### continuous_drive property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/continuous_drive.md

#### continuous_drive property

Gets the continuous drive.
##### Definition:
```python
@property
def continuous_drive(self):
    ...
```

### contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/contrast.md

#### contrast property

Gets the contrast.
##### Definition:
```python
@property
def contrast(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_zoom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/digital_zoom.md

#### digital_zoom property

Gets the digital zoom.
##### Definition:
```python
@property
def digital_zoom(self):
    ...
```

### easy_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/easy_mode.md

#### easy_mode property

Gets the easy mode.
##### Definition:
```python
@property
def easy_mode(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### focus_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/focus_mode.md

#### focus_mode property

Gets the focus mode.
##### Definition:
```python
@property
def focus_mode(self):
    ...
```

### focus_range property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/focus_range.md

#### focus_range property

Gets the focus range.
##### Definition:
```python
@property
def focus_range(self):
    ...
```

### image_stabilization property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/image_stabilization.md

#### image_stabilization property

Gets the image stabilization.
##### Definition:
```python
@property
def image_stabilization(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/lens_type.md

#### lens_type property

Gets the type of the lens.
##### Definition:
```python
@property
def lens_type(self):
    ...
```

### macro_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/macro_mode.md

#### macro_mode property

Gets the macro mode.
##### Definition:
```python
@property
def macro_mode(self):
    ...
```

### max_focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/max_focal_length.md

#### max_focal_length property

Gets the maximum length of the focal.
##### Definition:
```python
@property
def max_focal_length(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### metering_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/metering_mode.md

#### metering_mode property

Gets the metering mode.
##### Definition:
```python
@property
def metering_mode(self):
    ...
```

### min_focal_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/min_focal_length.md

#### min_focal_length property

Gets the minimum length of the focal.
##### Definition:
```python
@property
def min_focal_length(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/quality.md

#### quality property

Gets the quality.
##### Definition:
```python
@property
def quality(self):
    ...
```

### record_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/record_mode.md

#### record_mode property

Gets the record mode.
##### Definition:
```python
@property
def record_mode(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/saturation.md

#### saturation property

Gets the saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### self_timer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/self_timer.md

#### self_timer property

Gets the self timer.
##### Definition:
```python
@property
def self_timer(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/sharpness.md

#### sharpness property

Gets the sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canoncamerasettingspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CanonMakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage.md

#### CanonMakerNotePackage class

Represents CANON MakerNote metadata.

**Inheritance:** `CanonMakerNotePackage` →
`MakerNotePackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The CanonMakerNotePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| camera_settings | Gets the camera settings. |
| canon_image_type | Gets the Canon image type. |
| canon_firmware_version | Gets the canon firmware version. |
| file_number | Gets the file number. |
| owner_name | Gets the name of the owner. |
| serial_number | Gets the serial number. |
| canon_file_length | Gets the length of the canon file. |
| canon_model_id | Gets the canon model identifier. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### camera_settings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/camera_settings.md

#### camera_settings property

Gets the camera settings.
##### Definition:
```python
@property
def camera_settings(self):
    ...
```

### canon_file_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canon_file_length.md

#### canon_file_length property

Gets the length of the canon file.
##### Definition:
```python
@property
def canon_file_length(self):
    ...
```

### canon_firmware_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canon_firmware_version.md

#### canon_firmware_version property

Gets the canon firmware version.
##### Definition:
```python
@property
def canon_firmware_version(self):
    ...
```

### canon_image_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canon_image_type.md

#### canon_image_type property

Gets the Canon image type.
##### Definition:
```python
@property
def canon_image_type(self):
    ...
```

### canon_model_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/canon_model_id.md

#### canon_model_id property

Gets the canon model identifier.
##### Definition:
```python
@property
def canon_model_id(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### file_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/file_number.md

#### file_number property

Gets the file number.
##### Definition:
```python
@property
def file_number(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### owner_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/owner_name.md

#### owner_name property

Gets the name of the owner.
##### Definition:
```python
@property
def owner_name(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/serial_number.md

#### serial_number property

Gets the serial number.
##### Definition:
```python
@property
def serial_number(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/canonmakernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### MakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage.md

#### MakerNotePackage class

Provides an abstract base class for MakerNote metadata packages.

**Inheritance:** `MakerNotePackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The MakerNotePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/makernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### NikonMakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage.md

#### NikonMakerNotePackage class

Represents NIKON MakerNote metadata.

**Inheritance:** `NikonMakerNotePackage` →
`MakerNotePackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The NikonMakerNotePackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tags)` | Initializes a new instance of the `NikonMakerNotePackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| maker_note_version | Gets the MakerNote version. |
| iso | Gets the iso. |
| color_mode | Gets the color mode. |
| quality | Gets the quality string. |
| white_balance | Gets the white balance. |
| sharpness | Gets the sharpness. |
| focus_mode | Gets the focus mode. |
| flash_setting | Gets the flash setting. |
| flash_type | Gets the type of the flash. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

### NikonMakerNotePackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/__init__.md

#### \_\_init\_\_(self, tags)

Initializes a new instance of the `NikonMakerNotePackage` class.

```python

def __init__(self, tags):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tags | list | Array of TIFF tags. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/color_mode.md

#### color_mode property

Gets the color mode.
##### Definition:
```python
@property
def color_mode(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash_setting property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/flash_setting.md

#### flash_setting property

Gets the flash setting.
##### Definition:
```python
@property
def flash_setting(self):
    ...
```

### flash_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/flash_type.md

#### flash_type property

Gets the type of the flash.
##### Definition:
```python
@property
def flash_type(self):
    ...
```

### focus_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/focus_mode.md

#### focus_mode property

Gets the focus mode.
##### Definition:
```python
@property
def focus_mode(self):
    ...
```

### iso property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/iso.md

#### iso property

Gets the iso.
##### Definition:
```python
@property
def iso(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### maker_note_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/maker_note_version.md

#### maker_note_version property

Gets the MakerNote version.
##### Definition:
```python
@property
def maker_note_version(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/quality.md

#### quality property

Gets the quality string.
##### Definition:
```python
@property
def quality(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/sharpness.md

#### sharpness property

Gets the sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/nikonmakernotepackage/white_balance.md

#### white_balance property

Gets the white balance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### PanasonicMakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage.md

#### PanasonicMakerNotePackage class

Represents PANASONIC MakerNote metadata.

**Inheritance:** `PanasonicMakerNotePackage` →
`MakerNotePackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The PanasonicMakerNotePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| image_quality | Gets the image quality. |
| firmware_version | Gets the firmware version. |
| white_balance | Gets the white balance. |
| focus_mode | Gets the focus mode. |
| af_mode | Gets the AF mode. |
| image_stabilization | Gets the image stabilization mode. |
| macro_mode | Gets the macro mode. |
| shooting_mode | Gets the shooting mode. |
| audio | Gets the audio mode. |
| lens_type | Gets the type of the lens. |
| lens_serial_number | Gets the lens serial number. |
| accessory_type | Gets the type of the accessory. |
| accessory_serial_number | Gets the accessory serial number. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

### accessory_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/accessory_serial_number.md

#### accessory_serial_number property

Gets the accessory serial number.
##### Definition:
```python
@property
def accessory_serial_number(self):
    ...
```

### accessory_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/accessory_type.md

#### accessory_type property

Gets the type of the accessory.
##### Definition:
```python
@property
def accessory_type(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/af_mode.md

#### af_mode property

Gets the AF mode.
##### Definition:
```python
@property
def af_mode(self):
    ...
```

### audio property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/audio.md

#### audio property

Gets the audio mode.
##### Definition:
```python
@property
def audio(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### firmware_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/firmware_version.md

#### firmware_version property

Gets the firmware version.
##### Definition:
```python
@property
def firmware_version(self):
    ...
```

### focus_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/focus_mode.md

#### focus_mode property

Gets the focus mode.
##### Definition:
```python
@property
def focus_mode(self):
    ...
```

### image_quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/image_quality.md

#### image_quality property

Gets the image quality.
##### Definition:
```python
@property
def image_quality(self):
    ...
```

### image_stabilization property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/image_stabilization.md

#### image_stabilization property

Gets the image stabilization mode.
##### Definition:
```python
@property
def image_stabilization(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### lens_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/lens_serial_number.md

#### lens_serial_number property

Gets the lens serial number.
##### Definition:
```python
@property
def lens_serial_number(self):
    ...
```

### lens_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/lens_type.md

#### lens_type property

Gets the type of the lens.
##### Definition:
```python
@property
def lens_type(self):
    ...
```

### macro_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/macro_mode.md

#### macro_mode property

Gets the macro mode.
##### Definition:
```python
@property
def macro_mode(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shooting_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/shooting_mode.md

#### shooting_mode property

Gets the shooting mode.
##### Definition:
```python
@property
def shooting_mode(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/panasonicmakernotepackage/white_balance.md

#### white_balance property

Gets the white balance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### SonyMakerNotePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage.md

#### SonyMakerNotePackage class

Represents SONY MakerNote metadata.

**Inheritance:** `SonyMakerNotePackage` →
`MakerNotePackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The SonyMakerNotePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| header | Gets the MakerNote header. |
| quality | Gets the image quality. |
| white_balance | Gets the white balance. |
| teleconverter | Gets the teleconverter type. |
| multi_burst_mode | Gets a value indicating whether the multi burst mode is on. |
| multi_burst_image_width | Gets the width of the multi burst image. |
| multi_burst_image_height | Gets the height of the multi burst image. |
| rating | Gets the rating. |
| contrast | Gets the contrast. |
| saturation | Gets the saturation. |
| sharpness | Gets the sharpness. |
| brightness | Gets the brightness. |
| picture_effect | Gets the picture effect. |
| soft_skin_effect | Gets the soft skin effect. |
| sony_model_id | Gets the sony model identifier. |
| creative_style | Gets the creative style. |
| color_temperature | Gets the color temperature. |
| color_mode | Gets the color mode. |
| macro | Gets the macro. |
| exposure_mode | Gets the exposure mode. |
| focus_mode | Gets the focus mode. |
| jpeg_quality | Gets the JPEG quality. |
| af_illuminator | Gets the AF illuminator type. |
| flash_level | Gets the flash level. |
| release_mode | Gets the release mode. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### af_illuminator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/af_illuminator.md

#### af_illuminator property

Gets the AF illuminator type.
##### Definition:
```python
@property
def af_illuminator(self):
    ...
```

### brightness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/brightness.md

#### brightness property

Gets the brightness.
##### Definition:
```python
@property
def brightness(self):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/color_mode.md

#### color_mode property

Gets the color mode.
##### Definition:
```python
@property
def color_mode(self):
    ...
```

### color_temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/color_temperature.md

#### color_temperature property

Gets the color temperature.
##### Definition:
```python
@property
def color_temperature(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/contrast.md

#### contrast property

Gets the contrast.
##### Definition:
```python
@property
def contrast(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creative_style property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/creative_style.md

#### creative_style property

Gets the creative style.
##### Definition:
```python
@property
def creative_style(self):
    ...
```

### exposure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/exposure_mode.md

#### exposure_mode property

Gets the exposure mode.
##### Definition:
```python
@property
def exposure_mode(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flash_level property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/flash_level.md

#### flash_level property

Gets the flash level.
##### Definition:
```python
@property
def flash_level(self):
    ...
```

### focus_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/focus_mode.md

#### focus_mode property

Gets the focus mode.
##### Definition:
```python
@property
def focus_mode(self):
    ...
```

### header property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/header.md

#### header property

Gets the MakerNote header.
##### Definition:
```python
@property
def header(self):
    ...
```

### jpeg_quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/jpeg_quality.md

#### jpeg_quality property

Gets the JPEG quality.
##### Definition:
```python
@property
def jpeg_quality(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### macro property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/macro.md

#### macro property

Gets the macro.
##### Definition:
```python
@property
def macro(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### multi_burst_image_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multi_burst_image_height.md

#### multi_burst_image_height property

Gets the height of the multi burst image.
##### Definition:
```python
@property
def multi_burst_image_height(self):
    ...
```

### multi_burst_image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multi_burst_image_width.md

#### multi_burst_image_width property

Gets the width of the multi burst image.
##### Definition:
```python
@property
def multi_burst_image_width(self):
    ...
```

### multi_burst_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/multi_burst_mode.md

#### multi_burst_mode property

Gets a value indicating whether the multi burst mode is on.
##### Definition:
```python
@property
def multi_burst_mode(self):
    ...
```

### picture_effect property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/picture_effect.md

#### picture_effect property

Gets the picture effect.
##### Definition:
```python
@property
def picture_effect(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### quality property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/quality.md

#### quality property

Gets the image quality.
##### Definition:
```python
@property
def quality(self):
    ...
```

### rating property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/rating.md

#### rating property

Gets the rating.
##### Definition:
```python
@property
def rating(self):
    ...
```

### release_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/release_mode.md

#### release_mode property

Gets the release mode.
##### Definition:
```python
@property
def release_mode(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/saturation.md

#### saturation property

Gets the saturation.
##### Definition:
```python
@property
def saturation(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/sharpness.md

#### sharpness property

Gets the sharpness.
##### Definition:
```python
@property
def sharpness(self):
    ...
```

### soft_skin_effect property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/soft_skin_effect.md

#### soft_skin_effect property

Gets the soft skin effect.
##### Definition:
```python
@property
def soft_skin_effect(self):
    ...
```

### sony_model_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/sony_model_id.md

#### sony_model_id property

Gets the sony model identifier.
##### Definition:
```python
@property
def sony_model_id(self):
    ...
```

### teleconverter property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/teleconverter.md

#### teleconverter property

Gets the teleconverter type.
##### Definition:
```python
@property
def teleconverter(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.makernote/sonymakernotepackage/white_balance.md

#### white_balance property

Gets the white balance.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### groupdocs.metadata.standards.exif
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif.md

The namespace contains functionality intended to read and write EXIF (exchangeable image file format) metadata.

##### Classes
| Class | Description |
| :- | :- |
| `ExifDictionaryBasePackage` | Provides an abstract base class for EXIF metadata dictionaries. |
| `ExifGpsPackage` | Represents GPS metadata in an EXIF metadata package. |
| `ExifIfdPackage` | Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information. |
| `ExifPackage` | Represents an EXIF metadata package (Exchangeable Image File Format). |
| `IExif` | Defines base operations intended to work with EXIF metadata. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `ExifGpsAltitudeRef` | Represents a GPS altitude reference. |
| `ExifOrientation` | Exif image orientation. |

### ExifDictionaryBasePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage.md

#### ExifDictionaryBasePackage class

Provides an abstract base class for EXIF metadata dictionaries.

**Inheritance:** `ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The ExifDictionaryBasePackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifdictionarybasepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### ExifGpsAltitudeRef enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpsaltituderef.md

#### ExifGpsAltitudeRef enumeration

Represents a GPS altitude reference.

The ExifGpsAltitudeRef type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ABOVE_SEA_LEVEL | Above sea level. |
| BELOW_SEA_LEVEL | Below sea level. |

### ExifGpsPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage.md

#### ExifGpsPackage class

Represents GPS metadata in an EXIF metadata package.

**Inheritance:** `ExifGpsPackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The ExifGpsPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `ExifGpsPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| altitude | Gets or sets the altitude based on the reference in `ExifGpsPackage.altitude_ref`.
<br/>The reference unit is meters. |
| altitude_ref | Gets or sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given.
<br/>If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the `ExifGpsPackage.altitude` tag. |
| area_information | Gets or sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area. |
| date_stamp | Gets or sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD. |
| dest_bearing | Gets or sets the GPS bearing to the destination point.
<br/>The range of values is from 0.00 to 359.99. |
| dest_bearing_ref | Gets or sets the GPS reference used for giving the bearing to the destination point.
<br/>'T' denotes true direction and 'M' is magnetic direction. |
| dest_distance | Gets or sets the GPS distance to the destination point. |
| dest_distance_ref | Gets or sets the GPS unit used to express the distance to the destination point.
<br/>'K', 'M' and 'N' represent kilometers, miles and knots. |
| dest_latitude | Gets or sets the GPS latitude of the destination point. |
| dest_latitude_ref | Gets or sets the GPS value which indicates whether the latitude of the destination point is north or south latitude.
<br/>The ASCII value 'N' indicates north latitude, and 'S' is south latitude. |
| dest_longitude | Gets or sets the GPS longitude of the destination point. |
| dest_longitude_ref | Gets or sets the GPS value which indicates whether the longitude of the destination point is east or west longitude.
<br/>ASCII 'E' indicates east longitude, and 'W' is west longitude. |
| differential | Gets or sets a GPS value which indicates whether differential correction is applied to the GPS receiver. |
| data_degree_of_precision | Gets or sets the GPS DOP (data degree of precision).
<br/>An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement. |
| img_direction | Gets or sets the GPS direction of the image when it was captured.
<br/>The range of values is from 0.00 to 359.99. |
| img_direction_ref | Gets or sets the GPS reference for giving the direction of the image when it is captured.
<br/>'T' denotes true direction and 'M' is magnetic direction. |
| latitude | Gets or sets the GPS latitude. |
| latitude_ref | Gets or sets a GPS value indicating whether the latitude is north or south latitude. |
| longitude | Gets or sets the GPS longitude. |
| longitude_ref | Gets or sets a GPS value indicating whether the longitude is east or west longitude. |
| map_datum | Gets or sets the geodetic survey data used by the GPS receiver. |
| measure_mode | Gets or sets the GPS measurement mode. |
| processing_method | Gets or sets a character string recording the name of the method used for location finding.
<br/>The first byte indicates the character code used, and this is followed by the name of the method. |
| satellites | Gets or sets the GPS satellites used for measurements.
<br/>This tag can be used to describe the number of satellites,
<br/>their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not
<br/>specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL. |
| speed | Gets or sets the speed of GPS receiver movement. |
| speed_ref | Gets or sets the unit used to express the GPS receiver speed of movement.
<br/>'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots. |
| status | Gets or sets the status of the GPS receiver when the image is recorded. |
| time_stamp | Gets or sets the time as UTC (Coordinated Universal Time).
<br/>TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second. |
| gps_track | Gets or sets the direction of GPS receiver movement. |
| track_ref | Gets or sets the reference for giving the direction of GPS receiver movement.
<br/>'T' denotes true direction and 'M' is magnetic direction. |
| version_id | Gets or sets the version of GPS IFD. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

##### Remarks

**Learn more** |
|
 |

### ExifGpsPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `ExifGpsPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### altitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/altitude.md

#### altitude property

Gets or sets the altitude based on the reference in `ExifGpsPackage.altitude_ref`.
The reference unit is meters.
##### Definition:
```python
@property
def altitude(self):
    ...
@altitude.setter
def altitude(self, value):
    ...
```

### altitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/altitude_ref.md

#### altitude_ref property

Gets or sets the altitude used as the reference altitude. If the reference is sea level and the altitude is above sea level, 0 is given.
If the altitude is below sea level, a value of 1 is given and the altitude is indicated as an absolute value in the `ExifGpsPackage.altitude` tag.
##### Definition:
```python
@property
def altitude_ref(self):
    ...
@altitude_ref.setter
def altitude_ref(self, value):
    ...
```

### area_information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/area_information.md

#### area_information property

Gets or sets the character string recording the name of the GPS area. The first byte indicates the character code used, and this is followed by the name of the GPS area.
##### Definition:
```python
@property
def area_information(self):
    ...
@area_information.setter
def area_information(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### data_degree_of_precision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/data_degree_of_precision.md

#### data_degree_of_precision property

Gets or sets the GPS DOP (data degree of precision).
An HDOP value is written during two-dimensional measurement, and PDOP during three-dimensional measurement.
##### Definition:
```python
@property
def data_degree_of_precision(self):
    ...
@data_degree_of_precision.setter
def data_degree_of_precision(self, value):
    ...
```

### date_stamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/date_stamp.md

#### date_stamp property

Gets or sets the character string recording date and time information relative to UTC (Coordinated Universal Time). The format is YYYY:MM:DD.
##### Definition:
```python
@property
def date_stamp(self):
    ...
@date_stamp.setter
def date_stamp(self, value):
    ...
```

### dest_bearing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_bearing.md

#### dest_bearing property

Gets or sets the GPS bearing to the destination point.
The range of values is from 0.00 to 359.99.
##### Definition:
```python
@property
def dest_bearing(self):
    ...
@dest_bearing.setter
def dest_bearing(self, value):
    ...
```

### dest_bearing_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_bearing_ref.md

#### dest_bearing_ref property

Gets or sets the GPS reference used for giving the bearing to the destination point.
'T' denotes true direction and 'M' is magnetic direction.
##### Definition:
```python
@property
def dest_bearing_ref(self):
    ...
@dest_bearing_ref.setter
def dest_bearing_ref(self, value):
    ...
```

### dest_distance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_distance.md

#### dest_distance property

Gets or sets the GPS distance to the destination point.
##### Definition:
```python
@property
def dest_distance(self):
    ...
@dest_distance.setter
def dest_distance(self, value):
    ...
```

### dest_distance_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_distance_ref.md

#### dest_distance_ref property

Gets or sets the GPS unit used to express the distance to the destination point.
'K', 'M' and 'N' represent kilometers, miles and knots.
##### Definition:
```python
@property
def dest_distance_ref(self):
    ...
@dest_distance_ref.setter
def dest_distance_ref(self, value):
    ...
```

### dest_latitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_latitude.md

#### dest_latitude property

Gets or sets the GPS latitude of the destination point.
##### Definition:
```python
@property
def dest_latitude(self):
    ...
@dest_latitude.setter
def dest_latitude(self, value):
    ...
```

### dest_latitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_latitude_ref.md

#### dest_latitude_ref property

Gets or sets the GPS value which indicates whether the latitude of the destination point is north or south latitude.
The ASCII value 'N' indicates north latitude, and 'S' is south latitude.
##### Definition:
```python
@property
def dest_latitude_ref(self):
    ...
@dest_latitude_ref.setter
def dest_latitude_ref(self, value):
    ...
```

### dest_longitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_longitude.md

#### dest_longitude property

Gets or sets the GPS longitude of the destination point.
##### Definition:
```python
@property
def dest_longitude(self):
    ...
@dest_longitude.setter
def dest_longitude(self, value):
    ...
```

### dest_longitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/dest_longitude_ref.md

#### dest_longitude_ref property

Gets or sets the GPS value which indicates whether the longitude of the destination point is east or west longitude.
ASCII 'E' indicates east longitude, and 'W' is west longitude.
##### Definition:
```python
@property
def dest_longitude_ref(self):
    ...
@dest_longitude_ref.setter
def dest_longitude_ref(self, value):
    ...
```

### differential property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/differential.md

#### differential property

Gets or sets a GPS value which indicates whether differential correction is applied to the GPS receiver.
##### Definition:
```python
@property
def differential(self):
    ...
@differential.setter
def differential(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gps_track property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/gps_track.md

#### gps_track property

Gets or sets the direction of GPS receiver movement.
##### Definition:
```python
@property
def gps_track(self):
    ...
@gps_track.setter
def gps_track(self, value):
    ...
```

### img_direction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/img_direction.md

#### img_direction property

Gets or sets the GPS direction of the image when it was captured.
The range of values is from 0.00 to 359.99.
##### Definition:
```python
@property
def img_direction(self):
    ...
@img_direction.setter
def img_direction(self, value):
    ...
```

### img_direction_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/img_direction_ref.md

#### img_direction_ref property

Gets or sets the GPS reference for giving the direction of the image when it is captured.
'T' denotes true direction and 'M' is magnetic direction.
##### Definition:
```python
@property
def img_direction_ref(self):
    ...
@img_direction_ref.setter
def img_direction_ref(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### latitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/latitude.md

#### latitude property

Gets or sets the GPS latitude.
##### Definition:
```python
@property
def latitude(self):
    ...
@latitude.setter
def latitude(self, value):
    ...
```

### latitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/latitude_ref.md

#### latitude_ref property

Gets or sets a GPS value indicating whether the latitude is north or south latitude.
##### Definition:
```python
@property
def latitude_ref(self):
    ...
@latitude_ref.setter
def latitude_ref(self, value):
    ...
```

### longitude property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/longitude.md

#### longitude property

Gets or sets the GPS longitude.
##### Definition:
```python
@property
def longitude(self):
    ...
@longitude.setter
def longitude(self, value):
    ...
```

### longitude_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/longitude_ref.md

#### longitude_ref property

Gets or sets a GPS value indicating whether the longitude is east or west longitude.
##### Definition:
```python
@property
def longitude_ref(self):
    ...
@longitude_ref.setter
def longitude_ref(self, value):
    ...
```

### map_datum property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/map_datum.md

#### map_datum property

Gets or sets the geodetic survey data used by the GPS receiver.
##### Definition:
```python
@property
def map_datum(self):
    ...
@map_datum.setter
def map_datum(self, value):
    ...
```

### measure_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/measure_mode.md

#### measure_mode property

Gets or sets the GPS measurement mode.
##### Definition:
```python
@property
def measure_mode(self):
    ...
@measure_mode.setter
def measure_mode(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### processing_method property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/processing_method.md

#### processing_method property

Gets or sets a character string recording the name of the method used for location finding.
The first byte indicates the character code used, and this is followed by the name of the method.
##### Definition:
```python
@property
def processing_method(self):
    ...
@processing_method.setter
def processing_method(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### satellites property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/satellites.md

#### satellites property

Gets or sets the GPS satellites used for measurements.
This tag can be used to describe the number of satellites,
their ID number, angle of elevation, azimuth, SNR and other information in ASCII notation. The format is not
specified. If the GPS receiver is incapable of taking measurements, value of the tag shall be set to NULL.
##### Definition:
```python
@property
def satellites(self):
    ...
@satellites.setter
def satellites(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### speed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/speed.md

#### speed property

Gets or sets the speed of GPS receiver movement.
##### Definition:
```python
@property
def speed(self):
    ...
@speed.setter
def speed(self, value):
    ...
```

### speed_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/speed_ref.md

#### speed_ref property

Gets or sets the unit used to express the GPS receiver speed of movement.
'K' 'M' and 'N' represents kilometers per hour, miles per hour, and knots.
##### Definition:
```python
@property
def speed_ref(self):
    ...
@speed_ref.setter
def speed_ref(self, value):
    ...
```

### status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/status.md

#### status property

Gets or sets the status of the GPS receiver when the image is recorded.
##### Definition:
```python
@property
def status(self):
    ...
@status.setter
def status(self, value):
    ...
```

### time_stamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/time_stamp.md

#### time_stamp property

Gets or sets the time as UTC (Coordinated Universal Time).
TimeStamp is expressed as three RATIONAL values giving the hour, minute, and second.
##### Definition:
```python
@property
def time_stamp(self):
    ...
@time_stamp.setter
def time_stamp(self, value):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### track_ref property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/track_ref.md

#### track_ref property

Gets or sets the reference for giving the direction of GPS receiver movement.
'T' denotes true direction and 'M' is magnetic direction.
##### Definition:
```python
@property
def track_ref(self):
    ...
@track_ref.setter
def track_ref(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifgpspackage/version_id.md

#### version_id property

Gets or sets the version of GPS IFD.
##### Definition:
```python
@property
def version_id(self):
    ...
@version_id.setter
def version_id(self, value):
    ...
```

### ExifIfdPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage.md

#### ExifIfdPackage class

Represents the Exif Image File Directory. Exif IFD is a set of tags for recording Exif-specific attribute information.

**Inheritance:** `ExifIfdPackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The ExifIfdPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| camera_owner_name | Gets or sets the camera owner's name. |
| body_serial_number | Gets or sets the camera body serial number. |
| cfa_pattern | Gets or sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used. |
| user_comment | Gets or sets the user comment. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

##### Remarks

**Learn more** |
|
 |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### body_serial_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/body_serial_number.md

#### body_serial_number property

Gets or sets the camera body serial number.
##### Definition:
```python
@property
def body_serial_number(self):
    ...
@body_serial_number.setter
def body_serial_number(self, value):
    ...
```

### camera_owner_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/camera_owner_name.md

#### camera_owner_name property

Gets or sets the camera owner's name.
##### Definition:
```python
@property
def camera_owner_name(self):
    ...
@camera_owner_name.setter
def camera_owner_name(self, value):
    ...
```

### cfa_pattern property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/cfa_pattern.md

#### cfa_pattern property

Gets or sets the color filter array (CFA) geometric pattern of the image sensor when a one-chip color area sensor is used.
##### Definition:
```python
@property
def cfa_pattern(self):
    ...
@cfa_pattern.setter
def cfa_pattern(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### user_comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exififdpackage/user_comment.md

#### user_comment property

Gets or sets the user comment.
##### Definition:
```python
@property
def user_comment(self):
    ...
@user_comment.setter
def user_comment(self, value):
    ...
```

### ExifOrientation enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exiforientation.md

#### ExifOrientation enumeration

Exif image orientation.

The ExifOrientation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TOP_LEFT | Top left. Default orientation. |
| TOP_RIGHT | Top right. Horizontally reversed. |
| BOTTOM_RIGHT | Bottom right. Rotated by 180 degrees. |
| BOTTOM_LEFT | Bottom left. Rotated by 180 degrees and then horizontally reversed. |
| LEFT_TOP | Left top. Rotated by 90 degrees counterclockwise and then horizontally reversed. |
| RIGHT_TOP | Right top. Rotated by 90 degrees clockwise. |
| RIGHT_BOTTOM | Right bottom. Rotated by 90 degrees clockwise and then horizontally reversed. |
| LEFT_BOTTOM | Left bottom. Rotated by 90 degrees counterclockwise. |

### ExifPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage.md

#### ExifPackage class

Represents an EXIF metadata package (Exchangeable Image File Format).

**Inheritance:** `ExifPackage` →
`ExifDictionaryBasePackage` →
`CustomPackage` →
`MetadataPackage`

The ExifPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `ExifPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| gps_package | Gets the GPS data. |
| exif_ifd_package | Gets the EXIF IFD data. |
| thumbnail | Gets the image thumbnail represented as an array of bytes. |
| artist | Gets or sets the name of the camera owner, photographer or image creator. |
| copyright | Gets or sets the copyright notice. |
| date_time | Gets or sets the date and time of image creation.
<br/>In the EXIF standard, it is the date and time the file was changed. |
| image_description | Gets or sets a character string giving the title of the image.
<br/>It may be a comment such as "1988 company picnic" or the like. |
| image_length | Gets or sets the number of rows of image data. |
| orientation | Gets or sets the orientation. |
| image_width | Gets or sets the number of columns of image data, equal to the number of pixels per row. |
| make | Gets or sets the manufacturer of the recording equipment.
<br/>This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image. |
| model | Gets or sets the model name or model number of the equipment.
<br/>This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image. |
| software | Gets or sets the name and version of the software or firmware of the camera or image input device used to generate the image. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |
| `remove(self, tag_id)` | Removes the property with the specified id. |
| `set(self, tag)` | Adds or replaces the specified tag. |
| `clear(self)` | Removes all TIFF tags stored in the package. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to update common EXIF properties.

### ExifPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `ExifPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/artist.md

#### artist property

Gets or sets the name of the camera owner, photographer or image creator.
##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/clear.md

#### clear(self)

Removes all TIFF tags stored in the package.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/copyright.md

#### copyright property

Gets or sets the copyright notice.
##### Definition:
```python
@property
def copyright(self):
    ...
@copyright.setter
def copyright(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/date_time.md

#### date_time property

Gets or sets the date and time of image creation.
In the EXIF standard, it is the date and time the file was changed.
##### Definition:
```python
@property
def date_time(self):
    ...
@date_time.setter
def date_time(self, value):
    ...
```

### exif_ifd_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/exif_ifd_package.md

#### exif_ifd_package property

Gets the EXIF IFD data.
##### Definition:
```python
@property
def exif_ifd_package(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### gps_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/gps_package.md

#### gps_package property

Gets the GPS data.
##### Definition:
```python
@property
def gps_package(self):
    ...
```

### image_description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/image_description.md

#### image_description property

Gets or sets a character string giving the title of the image.
It may be a comment such as "1988 company picnic" or the like.
##### Definition:
```python
@property
def image_description(self):
    ...
@image_description.setter
def image_description(self, value):
    ...
```

### image_length property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/image_length.md

#### image_length property

Gets or sets the number of rows of image data.
##### Definition:
```python
@property
def image_length(self):
    ...
@image_length.setter
def image_length(self, value):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/image_width.md

#### image_width property

Gets or sets the number of columns of image data, equal to the number of pixels per row.
##### Definition:
```python
@property
def image_width(self):
    ...
@image_width.setter
def image_width(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### make property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/make.md

#### make property

Gets or sets the manufacturer of the recording equipment.
This is the manufacturer of the DSC, scanner, video digitizer or other equipment that generated the image.
##### Definition:
```python
@property
def make(self):
    ...
@make.setter
def make(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/model.md

#### model property

Gets or sets the model name or model number of the equipment.
This is the model name or number of the DSC, scanner, video digitizer or other equipment that generated the image.
##### Definition:
```python
@property
def model(self):
    ...
@model.setter
def model(self, value):
    ...
```

### orientation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/orientation.md

#### orientation property

Gets or sets the orientation.
##### Definition:
```python
@property
def orientation(self):
    ...
@orientation.setter
def orientation(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/remove.md

#### remove(self, tag_id)

Removes the property with the specified id.

##### Returns

True if the specified TIFF tag is found and removed; otherwise, false.

```python

def remove(self, tag_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag_id | groupdocs.metadata.formats.image.TiffTagID | A TIFF tag id. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/set.md

#### set(self, tag)

Adds or replaces the specified tag.

```python

def set(self, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tag | groupdocs.metadata.formats.image.TiffTag | The tag to set. |

##### Example

This code sample demonstrates how to add a custom tag to an EXIF package.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/software.md

#### software property

Gets or sets the name and version of the software or firmware of the camera or image input device used to generate the image.
##### Definition:
```python
@property
def software(self):
    ...
@software.setter
def software(self, value):
    ...
```

### thumbnail property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/thumbnail.md

#### thumbnail property

Gets the image thumbnail represented as an array of bytes.

##### Remarks

This feature is not available in trial mode.
##### Definition:
```python
@property
def thumbnail(self):
    ...
```

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all TIFF tags from the package.

```python

def to_list(self):
    ...
```

##### Example

This example demonstrates how to read all EXIF tags extracted from a file.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/exifpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IExif class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/iexif.md

#### IExif class

Defines base operations intended to work with EXIF metadata.

The IExif type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| exif_package | Gets or sets the EXIF metadata package associated with the file. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample demonstrates how to extract basic EXIF metadata properties.

### exif_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.exif/iexif/exif_package.md

#### exif_package property

Gets or sets the EXIF metadata package associated with the file.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to remove EXIF metadata from a file.
##### Definition:
```python
@property
def exif_package(self):
    ...
@exif_package.setter
def exif_package(self, value):
    ...
```

### groupdocs.metadata.standards.iptc
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc.md

The namespace contains classes allowing users to work with IPTC metadata.

##### Classes
| Class | Description |
| :- | :- |
| `IIptc` | Represents base operations intended to work with IPTC metadata.
<br/>Please find more information at [http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council](http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council). |
| `IptcApplicationRecord` | Represents an IPTC Application Record. |
| `IptcDataSet` | Represents an IPTC DataSet (metadata property). |
| `IptcEnvelopeRecord` | Represents an IPTC Envelope Record. |
| `IptcRecord` | Represents an IPTC record. |
| `IptcRecordSet` | Represents a collection of IPTC records. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `IptcApplicationRecordDataSet` | Defines IPTC Application Record dataSet numbers. |
| `IptcEnvelopeRecordDataSet` | Defines IPTC Envelope Record dataSet numbers. |
| `IptcRecordType` | Defines IPTC record types. |

### IIptc class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iiptc.md

#### IIptc class

Represents base operations intended to work with IPTC metadata.
Please find more information at [http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council](http://en.wikipedia.org/wiki/International_Press_Telecommunications_Council).

The IIptc type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| iptc_package | Gets or sets the IPTC metadata package associated with the file. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to read basic IPTC metadata properties.

### iptc_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iiptc/iptc_package.md

#### iptc_package property

Gets or sets the IPTC metadata package associated with the file.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to remove IPTC metadata from a file.
##### Definition:
```python
@property
def iptc_package(self):
    ...
@iptc_package.setter
def iptc_package(self, value):
    ...
```

### IptcApplicationRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord.md

#### IptcApplicationRecord class

Represents an IPTC Application Record.

**Inheritance:** `IptcApplicationRecord` →
`IptcRecord` →
`CustomPackage` →
`MetadataPackage`

The IptcApplicationRecord type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `IptcApplicationRecord` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| record_number | Gets the record number. |
| by_line | Gets or sets the name of the creator of the object, e.g. writer, photographer or graphic artist. |
| by_lines | Gets or sets the names of the creators of the object, e.g. writer, photographer or graphic artist. |
| by_line_title | Gets or sets the title of the creator or creators of the object. |
| by_line_titles | Gets or sets the titles of the creator or creators of the object. |
| content_location_code | Gets or sets the content location code. |
| content_location_codes | Gets or sets the content location codes. |
| content_location_name | Gets or sets the content location name. |
| content_location_names | Gets or sets the content location names. |
| date_created | Gets or sets the date the intellectual content of the object was created. |
| reference_date | Gets or sets the date of a prior envelope to which the current object refers. |
| reference_dates | Gets the dates of a prior envelope to which the current object refers. |
| release_date | Gets or sets the release date. |
| credit | Gets or sets information about the provider of the object, not necessarily the owner/creator. |
| headline | Gets or sets a publishable entry providing a synopsis of the contents of the object. |
| copyright_notice | Gets or sets the copyright notice. |
| contact | Gets or sets information about the person or organisation which can provide further background information on the object. |
| contacts | Gets or sets information about the person or organisation which can provide further background information on the object. |
| city | Gets or sets the city. |
| caption_abstract | Gets or sets a textual description of the object, particularly used where the object is not text. |
| keywords | Gets or sets the keywords. |
| all_keywords | Gets or sets the keywords. |
| program_version | Gets or sets the program version. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

**Learn more** |
|
 |

### IptcApplicationRecord indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### IptcApplicationRecord constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `IptcApplicationRecord` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### all_keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/all_keywords.md

#### all_keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def all_keywords(self):
    ...
@all_keywords.setter
def all_keywords(self, value):
    ...
```

### by_line property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/by_line.md

#### by_line property

Gets or sets the name of the creator of the object, e.g. writer, photographer or graphic artist.
##### Definition:
```python
@property
def by_line(self):
    ...
@by_line.setter
def by_line(self, value):
    ...
```

### by_line_title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/by_line_title.md

#### by_line_title property

Gets or sets the title of the creator or creators of the object.
##### Definition:
```python
@property
def by_line_title(self):
    ...
@by_line_title.setter
def by_line_title(self, value):
    ...
```

### by_line_titles property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/by_line_titles.md

#### by_line_titles property

Gets or sets the titles of the creator or creators of the object.
##### Definition:
```python
@property
def by_line_titles(self):
    ...
@by_line_titles.setter
def by_line_titles(self, value):
    ...
```

### by_lines property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/by_lines.md

#### by_lines property

Gets or sets the names of the creators of the object, e.g. writer, photographer or graphic artist.
##### Definition:
```python
@property
def by_lines(self):
    ...
@by_lines.setter
def by_lines(self, value):
    ...
```

### caption_abstract property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/caption_abstract.md

#### caption_abstract property

Gets or sets a textual description of the object, particularly used where the object is not text.
##### Definition:
```python
@property
def caption_abstract(self):
    ...
@caption_abstract.setter
def caption_abstract(self, value):
    ...
```

### city property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/city.md

#### city property

Gets or sets the city.
##### Definition:
```python
@property
def city(self):
    ...
@city.setter
def city(self, value):
    ...
```

### contact property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contact.md

#### contact property

Gets or sets information about the person or organisation which can provide further background information on the object.
##### Definition:
```python
@property
def contact(self):
    ...
@contact.setter
def contact(self, value):
    ...
```

### contacts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contacts.md

#### contacts property

Gets or sets information about the person or organisation which can provide further background information on the object.
##### Definition:
```python
@property
def contacts(self):
    ...
@contacts.setter
def contacts(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_location_code property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/content_location_code.md

#### content_location_code property

Gets or sets the content location code.
##### Definition:
```python
@property
def content_location_code(self):
    ...
@content_location_code.setter
def content_location_code(self, value):
    ...
```

### content_location_codes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/content_location_codes.md

#### content_location_codes property

Gets or sets the content location codes.
##### Definition:
```python
@property
def content_location_codes(self):
    ...
@content_location_codes.setter
def content_location_codes(self, value):
    ...
```

### content_location_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/content_location_name.md

#### content_location_name property

Gets or sets the content location name.
##### Definition:
```python
@property
def content_location_name(self):
    ...
@content_location_name.setter
def content_location_name(self, value):
    ...
```

### content_location_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/content_location_names.md

#### content_location_names property

Gets or sets the content location names.
##### Definition:
```python
@property
def content_location_names(self):
    ...
@content_location_names.setter
def content_location_names(self, value):
    ...
```

### copyright_notice property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/copyright_notice.md

#### copyright_notice property

Gets or sets the copyright notice.
##### Definition:
```python
@property
def copyright_notice(self):
    ...
@copyright_notice.setter
def copyright_notice(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### credit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/credit.md

#### credit property

Gets or sets information about the provider of the object, not necessarily the owner/creator.
##### Definition:
```python
@property
def credit(self):
    ...
@credit.setter
def credit(self, value):
    ...
```

### date_created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/date_created.md

#### date_created property

Gets or sets the date the intellectual content of the object was created.
##### Definition:
```python
@property
def date_created(self):
    ...
@date_created.setter
def date_created(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### headline property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/headline.md

#### headline property

Gets or sets a publishable entry providing a synopsis of the contents of the object.
##### Definition:
```python
@property
def headline(self):
    ...
@headline.setter
def headline(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### program_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/program_version.md

#### program_version property

Gets or sets the program version.
##### Definition:
```python
@property
def program_version(self):
    ...
@program_version.setter
def program_version(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### record_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/record_number.md

#### record_number property

Gets the record number.
##### Definition:
```python
@property
def record_number(self):
    ...
@record_number.setter
def record_number(self, value):
    ...
```

### reference_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/reference_date.md

#### reference_date property

Gets or sets the date of a prior envelope to which the current object refers.
##### Definition:
```python
@property
def reference_date(self):
    ...
@reference_date.setter
def reference_date(self, value):
    ...
```

### reference_dates property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/reference_dates.md

#### reference_dates property

Gets the dates of a prior envelope to which the current object refers.
##### Definition:
```python
@property
def reference_dates(self):
    ...
```

### release_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/release_date.md

#### release_date property

Gets or sets the release date.
##### Definition:
```python
@property
def release_date(self):
    ...
@release_date.setter
def release_date(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all IPTC dataSets from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IptcApplicationRecordDataSet enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcapplicationrecorddataset.md

#### IptcApplicationRecordDataSet enumeration

Defines IPTC Application Record dataSet numbers.

The IptcApplicationRecordDataSet type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RECORD_VERSION | Represents the record version. Binary. Always 2 in JPEGs. |
| OBJECT_TYPE_REFERENCE | Object type reference. Used pattern: "/\d{2}:[\w\s]{0,64}?/". |
| OBJECT_ATTRIBUTE_REFERENCE | The object attribute reference. |
| OBJECT_NAME | Used as a shorthand reference for the object. |
| EDIT_STATUS | Status of the objectdata, according to the practice of the provider. |
| EDITORIAL_UPDATE | Indicates the type of update that this object provides to a previous object. |
| URGENCY | Specifies the editorial urgency of content and not necessarily the envelope handling priority (see 1:60, Envelope Priority). |
| SUBJECT_REFERENCE | The subject reference. |
| CATEGORY | Identifies the subject of the objectdata in the opinion of the provider. |
| SUPPLEMENTAL_CATEGORY | Supplemental categories further refine the subject of an objectdata. <br/>
<br/>Only a single supplemental category may be contained in each DataSet. A supplemental category may include any of the recognised categories as used in 2:15. |
| FIXTURE_IDENTIFIER | The fixture identifier. |
| KEYWORDS | Used to indicate specific information retrieval words.
<br/>Each keyword uses a single Keywords DataSet. Multiple keywords use multiple Keywords DataSets. |
| CONTENT_LOCATION_CODE | Indicates the code of a country/geographical location referenced by the content of the object. |
| CONTENT_LOCATION_NAME | Provides a full, publishable name of a country/geographical location referenced by the content of the object, <br/>
<br/>according to guidelines of the provider. |
| RELEASE_DATE | Designates in the form CCYYMMDD the earliest date the provider intends the object to be used. Follows ISO 8601 standard. |
| RELEASE_TIME | Designates in the form HHMMSS±HHMM the earliest time the provider intends the object to be used. Follows ISO 8601 standard. |
| EXPIRATION_DATE | Designates in the form CCYYMMDD the latest date the provider or owner intends the objectdata to be used. Follows ISO 8601 standard. |
| SPECIAL_INSTRUCTIONS | Other editorial instructions concerning the use of the objectdata, such as embargoes and warnings. |
| ACTION_ADVISED | Indicates the type of action that this object provides to a previous object. |
| REFERENCE_SERVICE | Identifies the Service Identifier of a prior envelope to which the current object refers. |
| REFERENCE_DATE | Identifies the date of a prior envelope to which the current object refers. |
| REFERENCE_NUMBER | Identifies the Envelope Number of a prior envelope to which the current object refers. |
| DATE_CREATED | Represented in the form CCYYMMDD to designate the date the intellectual content of the objectdata was created rather than the date of the creation of the physical representation. |
| TIME_CREATED | Represented in the form HHMMSS±HHMM to designate the time the intellectual content of the objectdata
<br/>current source material was created rather than the creation of the physical representation. |
| DIGITAL_CREATION_DATE | Represented in the form CCYYMMDD to designate the date the digital representation of the objectdata was created. |
| DIGITAL_CREATION_TIME | Represented in the form HHMMSS±HHMM to designate the time the digital representation of the objectdata was created. |
| ORIGINATING_PROGRAM | Identifies the type of program used to originate the objectdata. |
| PROGRAM_VERSION | Used to identify the version of the program mentioned in 2:65. DataSet 2:70 is invalid if 2:65 is not present. |
| OBJECT_CYCLE | Consisting of an alphabetic character. Where: 'a' = morning, 'p' = evening, 'b' = both. |
| BYLINE | Contains name of the creator of the objectdata, e.g. writer, photographer or graphic artist. |
| BYLINE_TITLE | A by-line title is the title of the creator or creators of an object data. |
| CITY | Identifies city of objectdata origin according to guidelines established by the provider. |
| SUB_LOCATION | Identifies the location within a city from which the objectdata originates, according to guidelines established by the provider. |
| PROVINCE_STATE | Identifies Province/State of origin according to guidelines established by the provider. |
| PRIMARY_LOCATION_CODE | Indicates the code of the country/primary location where the intellectual property of the objectdata was created, e.g. a photo was taken, an event occurred. |
| PRIMARY_LOCATION_NAME | Provides full, publishable, name of the country/primary location where the intellectual property of the objectdata was created,
<br/>according to guidelines of the provider. |
| ORIGINAL_TRANSMISSION_REFERENCE | A code representing the location of original transmission according to practices of the provider. |
| HEADLINE | A publishable entry providing a synopsis of the contents of the objectdata. |
| CREDIT | Identifies the provider of the objectdata, not necessarily the owner/creator. |
| SOURCE | The name of a person or party who has a role in the content supply chain.
<br/>This could be an agency, a member of an agency, an individual or a combination. |
| COPYRIGHT_NOTICE | Contains any necessary copyright notice. |
| CONTACT | Identifies the person or organization which can provide further background information on the object data. |
| CAPTION_ABSTRACT | A textual description of the objectdata, particularly used where the object is not text. |
| WRITER_EDITOR | Identification of the name of the person involved in the writing, editing or correcting the objectdata or caption/abstract. |
| RASTERIZED_CAPTION | Image width 460 pixels and image height 128 pixels. Scanning direction bottom to top, left to right. |
| IMAGE_TYPE | The numeric characters 1 to 4 indicate the number of components in an image, in single or multiple envelopes. |
| IMAGE_ORIENTATION | Indicates the layout of the image area. |
| LANGUAGE_IDENTIFIER | Describes the major national language of the object, according to the 2-letter codes of ISO 639:1988. |
| AUDIO_TYPE | The audio type. |
| AUDIO_SAMPLING_RATE | Sampling rate numeric characters, representing the sampling rate in hertz (Hz). |
| AUDIO_SAMPLING_RESOLUTION | The number of bits in each audio sample. |
| AUDIO_DURATION | Duration Designates in the form HHMMSS the running time of an audio object data when played back at the speed at which it was recorded. |
| AUDIO_OUTCUE | Identifies the content of the end of an audio objectdata, according to guidelines established by the provider. |
| OBJ_DATA_PREVIEW_FILE_FORMAT | A binary number representing the file format of the ObjectData Preview. |
| OBJ_DATA_PREVIEW_FILE_FORMAT_VER | A binary number representing the particular version of the ObjectData Preview File Format specified in 2:200. |
| OBJ_DATA_PREVIEW_DATA | The object data preview. |

### IptcDataSet class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset.md

#### IptcDataSet class

Represents an IPTC DataSet (metadata property).

**Inheritance:** `IptcDataSet` →
`MetadataProperty`

The IptcDataSet type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, record_number, data_set_number, value)` | Initializes a new instance of the `IptcDataSet` class. |
| `__init__(self, record_number, data_set_number, value)` | Initializes a new instance of the `IptcDataSet` class. |
| `__init__(self, record_number, data_set_number, value)` | Initializes a new instance of the `IptcDataSet` class. |
| `__init__(self, record_number, data_set_number, value)` | Initializes a new instance of the `IptcDataSet` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the property name. |
| value | Gets the property value. |
| interpreted_value | Gets the interpreted property value, if available.
<br/>The interpreted value is a user-friendly form of the original property value.
<br/>For example, it returns a human-readable string instead of numeric flags and ids,
<br/>if necessary, translates byte arrays to text, etc. |
| descriptor | Gets the descriptor associated with the metadata property. |
| tags | Gets a collection of tags associated with the property. |
| record_number | Gets the record number. |
| data_set_number | Gets the dataSet number. |
| alternative_name | Gets the alternative name of the dataSet. |

##### Remarks

**Learn more** |
|
 |

### IptcDataSet constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/__init__.md

#### \_\_init\_\_(self, record_number, data_set_number, value)

Initializes a new instance of the `IptcDataSet` class.

```python

def __init__(self, record_number, data_set_number, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |
| data_set_number | int | The dataSet number. |
| value | bytes | A byte array value. |

#### \_\_init\_\_(self, record_number, data_set_number, value)

Initializes a new instance of the `IptcDataSet` class.

```python

def __init__(self, record_number, data_set_number, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |
| data_set_number | int | The dataSet number. |
| value | System.String | A string value. |

#### \_\_init\_\_(self, record_number, data_set_number, value)

Initializes a new instance of the `IptcDataSet` class.

```python

def __init__(self, record_number, data_set_number, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |
| data_set_number | int | The dataSet number. |
| value | int | An integer value. |

#### \_\_init\_\_(self, record_number, data_set_number, value)

Initializes a new instance of the `IptcDataSet` class.

```python

def __init__(self, record_number, data_set_number, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |
| data_set_number | int | The dataSet number. |
| value | System.DateTime | A date value. |

### alternative_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/alternative_name.md

#### alternative_name property

Gets the alternative name of the dataSet.
##### Definition:
```python
@property
def alternative_name(self):
    ...
```

### data_set_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/data_set_number.md

#### data_set_number property

Gets the dataSet number.
##### Definition:
```python
@property
def data_set_number(self):
    ...
@data_set_number.setter
def data_set_number(self, value):
    ...
```

### descriptor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/descriptor.md

#### descriptor property

Gets the descriptor associated with the metadata property.
##### Definition:
```python
@property
def descriptor(self):
    ...
@descriptor.setter
def descriptor(self, value):
    ...
```

### interpreted_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/interpreted_value.md

#### interpreted_value property

Gets the interpreted property value, if available.
The interpreted value is a user-friendly form of the original property value.
For example, it returns a human-readable string instead of numeric flags and ids,
if necessary, translates byte arrays to text, etc.
##### Definition:
```python
@property
def interpreted_value(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/name.md

#### name property

Gets the property name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### record_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/record_number.md

#### record_number property

Gets the record number.
##### Definition:
```python
@property
def record_number(self):
    ...
@record_number.setter
def record_number(self, value):
    ...
```

### tags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/tags.md

#### tags property

Gets a collection of tags associated with the property.
##### Definition:
```python
@property
def tags(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcdataset/value.md

#### value property

Gets the property value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### IptcEnvelopeRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord.md

#### IptcEnvelopeRecord class

Represents an IPTC Envelope Record.

**Inheritance:** `IptcEnvelopeRecord` →
`IptcRecord` →
`CustomPackage` →
`MetadataPackage`

The IptcEnvelopeRecord type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `IptcEnvelopeRecord` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| record_number | Gets the record number. |
| model_version | Gets or sets a number identifying the version of the information. |
| destination | Gets or sets the destination. |
| destinations | Gets or sets an array of destinations. |
| file_format | Gets or sets the file format. |
| file_format_version | Gets or sets the file format version.
<br/>A number representing the particular version of the File Format specified in `IptcEnvelopeRecord.file_format`. |
| service_identifier | Gets or sets the service identifier. |
| product_id | Gets or sets the product identifier. |
| product_ids | Gets or sets the product identifiers. |
| date_sent | Gets or sets the date the service sent the material. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

**Learn more** |
|
 |

### IptcEnvelopeRecord indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### IptcEnvelopeRecord constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `IptcEnvelopeRecord` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_sent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/date_sent.md

#### date_sent property

Gets or sets the date the service sent the material.
##### Definition:
```python
@property
def date_sent(self):
    ...
@date_sent.setter
def date_sent(self, value):
    ...
```

### destination property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/destination.md

#### destination property

Gets or sets the destination.
##### Definition:
```python
@property
def destination(self):
    ...
@destination.setter
def destination(self, value):
    ...
```

### destinations property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/destinations.md

#### destinations property

Gets or sets an array of destinations.
##### Definition:
```python
@property
def destinations(self):
    ...
@destinations.setter
def destinations(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/file_format.md

#### file_format property

Gets or sets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### file_format_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/file_format_version.md

#### file_format_version property

Gets or sets the file format version.
A number representing the particular version of the File Format specified in `IptcEnvelopeRecord.file_format`.
##### Definition:
```python
@property
def file_format_version(self):
    ...
@file_format_version.setter
def file_format_version(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/model_version.md

#### model_version property

Gets or sets a number identifying the version of the information.
##### Definition:
```python
@property
def model_version(self):
    ...
@model_version.setter
def model_version(self, value):
    ...
```

### product_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/product_id.md

#### product_id property

Gets or sets the product identifier.
##### Definition:
```python
@property
def product_id(self):
    ...
@product_id.setter
def product_id(self, value):
    ...
```

### product_ids property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/product_ids.md

#### product_ids property

Gets or sets the product identifiers.
##### Definition:
```python
@property
def product_ids(self):
    ...
@product_ids.setter
def product_ids(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### record_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/record_number.md

#### record_number property

Gets the record number.
##### Definition:
```python
@property
def record_number(self):
    ...
@record_number.setter
def record_number(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### service_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/service_identifier.md

#### service_identifier property

Gets or sets the service identifier.
##### Definition:
```python
@property
def service_identifier(self):
    ...
@service_identifier.setter
def service_identifier(self, value):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all IPTC dataSets from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IptcEnvelopeRecordDataSet enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcenveloperecorddataset.md

#### IptcEnvelopeRecordDataSet enumeration

Defines IPTC Envelope Record dataSet numbers.

The IptcEnvelopeRecordDataSet type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MODEL_VERSION | A binary number identifying the version of the Information
<br/><br/>
<br/>Interchange Model, Part I, utilised by the provider. Version numbers are assigned by IPTC and NAA.
<br/><br/>
<br/>The version number of this record is four (4). |
| DESTINATION | Optional, repeatable, maximum 1024 octets, consisting of sequentially contiguous graphic characters.
<br/><br/>
<br/>This DataSet is to accommodate some providers who require routing information above the appropriate OSI layers. |
| FILE_FORMAT | File format. |
| FILE_FORMAT_VERSION | Mandatory, not repeatable, two octets.
<br/><br/>
<br/>A binary number representing the particular version of the File Format specified in 1:20.
<br/><br/>
<br/>A list of File Formats, including version cross references, is included as Appendix A. |
| SERVICE_IDENTIFIER | Mandatory, not repeatable. Up to 10 octets, consisting of graphic characters.
<br/><br/>
<br/>Identifies the provider and product. |
| ENVELOPE_NUMBER | Mandatory, not repeatable, eight octets, consisting of numeric characters.
<br/><br/>
<br/>The characters form a number that will be unique for the date
<br/>specified in 1:70 and for the Service Identifier specified in 1:30.
<br/><br/>
<br/>If identical envelope numbers appear with the same date and
<br/>with the same Service Identifier, records 2-9 must be unchanged
<br/>from the original.
<br/><br/>
<br/>This is not intended to be a sequential serial
<br/>number reception check. |
| PRODUCT_ID | Optional, repeatable. Up to 32 octets, consisting of graphic characters.
<br/><br/>
<br/>Allows a provider to identify subsets of its overall service.
<br/><br/>
<br/>Used to provide receiving organization data on which to select, route, or otherwise handle data. |
| ENVELOPE_PRIORITY | Optional, not repeatable. A single octet, consisting of a numeric character.
<br/><br/>
<br/>Specifies the envelope handling priority and not the editorial urgency (see 2:10, Urgency).
<br/>'1' indicates the most urgent,
<br/>'5' the normal urgency,
<br/>and '8' the least urgent copy.
<br/>The numeral '9' indicates a User Defined Priority.
<br/>The numeral '0' is reserved for future use. |
| DATE_SENT | Mandatory, not repeatable. Eight octets, consisting of numeric characters.
<br/><br/>
<br/>Uses the format CCYYMMDD (century, year, month, day) as defined in ISO 8601 to indicate year, month and day the service sent the material. |
| TIME_SENT | Uses the format HHMMSS±HHMM where HHMMSS refers to
<br/>local hour, minute and seconds and HHMM refers to hours and
<br/>minutes ahead (+) or behind (-) Universal Coordinated Time as
<br/>described in ISO 8601. This is the time the service sent the
<br/>material. |
| CODED_CHARACTER_SET | Optional, not repeatable, up to 32 octets, consisting of one or
<br/>more control functions used for the announcement, invocation or
<br/>designation of coded character sets. The control functions follow
<br/>the ISO 2022 standard and may consist of the escape control
<br/>character and one or more graphic characters. For more details
<br/>see Appendix C, the IPTC-NAA Code Library. |
| UNO | Invalid (eternal identifier). |
| ARM_IDENTIFIER | The DataSet identifies the Abstract Relationship Method (ARM) which is described
<br/>in a document registered by the originator of the ARM with the IPTC and NAA. |
| ARM_VERSION | Binary number representing the particular version of the ARM specified in DataSet 1:120. |

### IptcRecord class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord.md

#### IptcRecord class

Represents an IPTC record.

**Inheritance:** `IptcRecord` →
`CustomPackage` →
`MetadataPackage`

The IptcRecord type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| record_number | Gets the record number. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

**Learn more** |
|
 |

### IptcRecord indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### record_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/record_number.md

#### record_number property

Gets the record number.
##### Definition:
```python
@property
def record_number(self):
    ...
@record_number.setter
def record_number(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all IPTC dataSets from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecord/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IptcRecordSet class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset.md

#### IptcRecordSet class

Represents a collection of IPTC records.

**Inheritance:** `IptcRecordSet` →
`CustomPackage` →
`MetadataPackage`

The IptcRecordSet type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `IptcRecordSet` class. |
| `__init__(self, data_sets)` | Initializes a new instance of the `IptcRecordSet` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| envelope_record | Gets or sets the Envelope Record. |
| application_record | Gets or sets the Application Record. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| `remove(self, record_number, data_set_number)` | Removes the dataSet with the specified record and dataSet number. |
| `remove(self, record_number)` | Removes the record with the specified record number. |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set(self, data_set)` | Adds or updates the specified dataSet in the appropriate record. |
| `add(self, data_set)` | Adds the specified dataSet to the appropriate record.
<br/>The dataSet is considered as repeatable if a dataSet with the specified number already exists. |
| `clear(self)` | Removes all records from the collection. |
| `to_data_set_list(self)` | Creates a list of dataSets from the package. |
| `to_list(self)` | Creates a list from the package. |

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows hot to update basic IPTC metadata properties.

### IptcRecordSet indexer
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### IptcRecordSet constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `IptcRecordSet` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, data_sets)

Initializes a new instance of the `IptcRecordSet` class.

```python

def __init__(self, data_sets):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_sets | list | An array of IPTC dataSets. |

### add method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/add.md

#### add(self, data_set)

Adds the specified dataSet to the appropriate record.
The dataSet is considered as repeatable if a dataSet with the specified number already exists.

```python

def add(self, data_set):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_set | groupdocs.metadata.standards.iptc.IptcDataSet | The IPTC dataSet to add. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### application_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/application_record.md

#### application_record property

Gets or sets the Application Record.
##### Definition:
```python
@property
def application_record(self):
    ...
@application_record.setter
def application_record(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/clear.md

#### clear(self)

Removes all records from the collection.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### envelope_record property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/envelope_record.md

#### envelope_record property

Gets or sets the Envelope Record.
##### Definition:
```python
@property
def envelope_record(self):
    ...
@envelope_record.setter
def envelope_record(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/remove.md

#### remove(self, record_number)

Removes the record with the specified record number.

##### Returns

True if the specified IPTC record is found and removed; otherwise, false.

```python

def remove(self, record_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |

#### remove(self, record_number, data_set_number)

Removes the dataSet with the specified record and dataSet number.

##### Returns

True if the specified IPTC dataSet is found and removed; otherwise, false.

```python

def remove(self, record_number, data_set_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record_number | int | The record number. |
| data_set_number | int | The dataSet number. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/set.md

#### set(self, data_set)

Adds or updates the specified dataSet in the appropriate record.

```python

def set(self, data_set):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_set | groupdocs.metadata.standards.iptc.IptcDataSet | The IPTC dataSet to add/update. |

##### Example

This example shows how to add or update custom IPTC datasets in a file.

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### to_data_set_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/to_data_set_list.md

#### to_data_set_list(self)

Creates a list of dataSets from the package.

##### Returns

A list that contains all IPTC dataSets from the package.

```python

def to_data_set_list(self):
    ...
```

##### Example

This example demonstrates how to read all IPTC IIM datasets from an IPTC metadata package.

### to_list method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/to_list.md

#### to_list(self)

Creates a list from the package.

##### Returns

A list that contains all IPTC records from the package.

```python

def to_list(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordset/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### IptcRecordType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.iptc/iptcrecordtype.md

#### IptcRecordType enumeration

Defines IPTC record types.

The IptcRecordType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ENVELOPE_RECORD | Represents an Envelope Record. |
| APPLICATION_RECORD | Represents an Application Record. |

### groupdocs.metadata.standards.pkcs
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs.md

The namespace provides functionality intended to work with digital signatures based on the syntax of PKCS #7, specified in RFC 5652.

##### Classes
| Class | Description |
| :- | :- |
| `Cms` | Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages.
<br/>CMS is based on the syntax of PKCS #7, specified in RFC 5652.
<br/>Please see [https://tools.ietf.org/html/rfc5652](https://tools.ietf.org/html/rfc5652) for more information. |
| `CmsAttribute` | Represents a CMS signer info attribute. |
| `CmsCertificate` | Represents a CMS certificate. |
| `CmsEncapsulatedContent` | Represents a signed content container, consisting of a content type identifier and the content itself. |
| `CmsPackage` | Represents a CMS digital signature metadata package. |
| `CmsSigner` | Represents CMS per-signer information. |
| `Oid` | Represents an object identifier (OID).
<br/>An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC
<br/>for naming any object, concept, or "thing" with a globally unambiguous persistent name. |

### Cms class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms.md

#### Cms class

Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF's standard for cryptographically protected messages.
CMS is based on the syntax of PKCS #7, specified in RFC 5652.
Please see [https://tools.ietf.org/html/rfc5652](https://tools.ietf.org/html/rfc5652) for more information.

**Inheritance:** `Cms` →
`DigitalSignature` →
`CustomPackage` →
`MetadataPackage`

The Cms type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comments | Gets the signing purpose comment. |
| is_valid | Gets a value indicating whether the signature is valid. |
| sign_time | Gets the time at which the signer (purportedly) performed the signing process. |
| certificate_subject | Gets the subject distinguished name from a certificate. |
| certificate_raw_data | Gets the certificate raw data. |
| digest_algorithms | Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero. |
| encapsulated_content | Gets the signed content, consisting of a content type identifier and the content itself. |
| certificates | Gets the collection of certificates. |
| signers | Gets the collection of per-signer information packages. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### certificate_raw_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/certificate_raw_data.md

#### certificate_raw_data property

Gets the certificate raw data.
##### Definition:
```python
@property
def certificate_raw_data(self):
    ...
```

### certificate_subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/certificate_subject.md

#### certificate_subject property

Gets the subject distinguished name from a certificate.
##### Definition:
```python
@property
def certificate_subject(self):
    ...
```

### certificates property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/certificates.md

#### certificates property

Gets the collection of certificates.

##### Remarks

It is intended that the set of certificates be sufficient to contain certification paths from a recognized "root" or "top-level
certification authority" to all of the signers in the SignerInfo field.
##### Definition:
```python
@property
def certificates(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/comments.md

#### comments property

Gets the signing purpose comment.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digest_algorithms property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/digest_algorithms.md

#### digest_algorithms property

Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero.
##### Definition:
```python
@property
def digest_algorithms(self):
    ...
```

### encapsulated_content property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/encapsulated_content.md

#### encapsulated_content property

Gets the signed content, consisting of a content type identifier and the content itself.
##### Definition:
```python
@property
def encapsulated_content(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### is_valid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/is_valid.md

#### is_valid property

Gets a value indicating whether the signature is valid.
##### Definition:
```python
@property
def is_valid(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sign_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/sign_time.md

#### sign_time property

Gets the time at which the signer (purportedly) performed the signing process.
##### Definition:
```python
@property
def sign_time(self):
    ...
```

### signers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/signers.md

#### signers property

Gets the collection of per-signer information packages.

##### Remarks

There may be any number of elements in the collection, including zero.
##### Definition:
```python
@property
def signers(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cms/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CmsAttribute class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute.md

#### CmsAttribute class

Represents a CMS signer info attribute.

**Inheritance:** `CmsAttribute` →
`CustomPackage` →
`MetadataPackage`

The CmsAttribute type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| oid | Gets the attribute OID. |
| value | Gets the attribute value represented as a string. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### oid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/oid.md

#### oid property

Gets the attribute OID.
##### Definition:
```python
@property
def oid(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsattribute/value.md

#### value property

Gets the attribute value represented as a string.
##### Definition:
```python
@property
def value(self):
    ...
```

### CmsCertificate class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate.md

#### CmsCertificate class

Represents a CMS certificate.

**Inheritance:** `CmsCertificate` →
`CustomPackage` →
`MetadataPackage`

The CmsCertificate type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| not_after | Gets the date in local time after which a certificate is no longer valid. |
| not_before | Gets the date in local time on which a certificate becomes valid. |
| raw_data | Gets the raw data of this certificate. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### not_after property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/not_after.md

#### not_after property

Gets the date in local time after which a certificate is no longer valid.
##### Definition:
```python
@property
def not_after(self):
    ...
```

### not_before property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/not_before.md

#### not_before property

Gets the date in local time on which a certificate becomes valid.
##### Definition:
```python
@property
def not_before(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/raw_data.md

#### raw_data property

Gets the raw data of this certificate.
##### Definition:
```python
@property
def raw_data(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmscertificate/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CmsEncapsulatedContent class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent.md

#### CmsEncapsulatedContent class

Represents a signed content container, consisting of a content type identifier and the content itself.

**Inheritance:** `CmsEncapsulatedContent` →
`CustomPackage` →
`MetadataPackage`

The CmsEncapsulatedContent type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| content_type | Gets the object identifier uniquely specifies the content type. |
| content_raw_data | Gets the raw data of content info. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_raw_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/content_raw_data.md

#### content_raw_data property

Gets the raw data of content info.
##### Definition:
```python
@property
def content_raw_data(self):
    ...
```

### content_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/content_type.md

#### content_type property

Gets the object identifier uniquely specifies the content type.
##### Definition:
```python
@property
def content_type(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmsencapsulatedcontent/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CmsPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage.md

#### CmsPackage class

Represents a CMS digital signature metadata package.

**Inheritance:** `CmsPackage` →
`CustomPackage` →
`MetadataPackage`

The CmsPackage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| signatures | Gets an array of the signatures extracted from the file. |
| flags | Gets the digital signature flags. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### flags property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/flags.md

#### flags property

Gets the digital signature flags.
##### Definition:
```python
@property
def flags(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### signatures property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/signatures.md

#### signatures property

Gets an array of the signatures extracted from the file.
##### Definition:
```python
@property
def signatures(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmspackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### CmsSigner class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner.md

#### CmsSigner class

Represents CMS per-signer information.

**Inheritance:** `CmsSigner` →
`CustomPackage` →
`MetadataPackage`

The CmsSigner type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| signer_identifier | Gets the signer's certificate (and thereby the signer's public key) raw data. |
| digest_algorithm | Gets the message digest algorithm, and any associated parameters, used by the signer. |
| signed_attributes | Gets the collection of attributes that are signed. |
| signature_algorithm | Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature. |
| signature_value | Gets the result of digital signature generation, using the message digest and the signer's private key. |
| unsigned_attributes | Gets the collection of attributes that are not signed. |
| signing_time | Gets the time at which the signer (purportedly) performed the signing process. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digest_algorithm property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/digest_algorithm.md

#### digest_algorithm property

Gets the message digest algorithm, and any associated parameters, used by the signer.
##### Definition:
```python
@property
def digest_algorithm(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### signature_algorithm property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/signature_algorithm.md

#### signature_algorithm property

Gets the signature algorithm, and any associated parameters, used by the signer to generate the digital signature.
##### Definition:
```python
@property
def signature_algorithm(self):
    ...
```

### signature_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/signature_value.md

#### signature_value property

Gets the result of digital signature generation, using the message digest and the signer's private key.
##### Definition:
```python
@property
def signature_value(self):
    ...
```

### signed_attributes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/signed_attributes.md

#### signed_attributes property

Gets the collection of attributes that are signed.
##### Definition:
```python
@property
def signed_attributes(self):
    ...
```

### signer_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/signer_identifier.md

#### signer_identifier property

Gets the signer's certificate (and thereby the signer's public key) raw data.
##### Definition:
```python
@property
def signer_identifier(self):
    ...
```

### signing_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/signing_time.md

#### signing_time property

Gets the time at which the signer (purportedly) performed the signing process.
##### Definition:
```python
@property
def signing_time(self):
    ...
```

### unsigned_attributes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/unsigned_attributes.md

#### unsigned_attributes property

Gets the collection of attributes that are not signed.
##### Definition:
```python
@property
def unsigned_attributes(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/cmssigner/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### Oid class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid.md

#### Oid class

Represents an object identifier (OID).
An identifier mechanism standardized by the International Telecommunications Union (ITU) and ISO/IEC
for naming any object, concept, or "thing" with a globally unambiguous persistent name.

**Inheritance:** `Oid` →
`CustomPackage` →
`MetadataPackage`

The Oid type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| value | Gets the object identifier (OID) value. |
| friendly_name | Gets the friendly name. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### friendly_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/friendly_name.md

#### friendly_name property

Gets the friendly name.
##### Definition:
```python
@property
def friendly_name(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.pkcs/oid/value.md

#### value property

Gets the object identifier (OID) value.
##### Definition:
```python
@property
def value(self):
    ...
```

### groupdocs.metadata.standards.signing
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing.md

The namespace provides base functionality intended to work with digital signatures.

##### Classes
| Class | Description |
| :- | :- |
| `DigitalSignature` | Represents a digital signature used to sign a document. |

### DigitalSignature class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature.md

#### DigitalSignature class

Represents a digital signature used to sign a document.

**Inheritance:** `DigitalSignature` →
`CustomPackage` →
`MetadataPackage`

The DigitalSignature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| comments | Gets the signing purpose comment. |
| is_valid | Gets a value indicating whether the signature is valid. |
| sign_time | Gets the time the document was signed. |
| certificate_subject | Gets the subject distinguished name from a certificate. |
| certificate_raw_data | Gets the certificate raw data. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### certificate_raw_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/certificate_raw_data.md

#### certificate_raw_data property

Gets the certificate raw data.
##### Definition:
```python
@property
def certificate_raw_data(self):
    ...
```

### certificate_subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/certificate_subject.md

#### certificate_subject property

Gets the subject distinguished name from a certificate.
##### Definition:
```python
@property
def certificate_subject(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/comments.md

#### comments property

Gets the signing purpose comment.
##### Definition:
```python
@property
def comments(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### is_valid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/is_valid.md

#### is_valid property

Gets a value indicating whether the signature is valid.
##### Definition:
```python
@property
def is_valid(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### sign_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/sign_time.md

#### sign_time property

Gets the time the document was signed.
##### Definition:
```python
@property
def sign_time(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.signing/digitalsignature/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### groupdocs.metadata.standards.xmp.schemes
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes.md

Contains the implementation of different XMP Schemes.

##### Classes
| Class | Description |
| :- | :- |
| `XmpAudioChannelType` | Represents audio channel type. |
| `XmpAudioSampleType` | Represents Audio sample type in `XmpDynamicMediaPackage`. |
| `XmpBasicJobTicketPackage` | Represents Basic Job-Ticket namespace. |
| `XmpBasicPackage` | Represents the XMP basic namespace. |
| `XmpCameraRawPackage` | Represents Camera Raw schema. |
| `XmpDublinCorePackage` | Represents the Dublin Core scheme. |
| `XmpDynamicMediaPackage` | Represents XMP Dynamic Media namespace. |
| `XmpIptcCorePackage` | Represents the IPTC Core XMP package. |
| `XmpIptcExtensionPackage` | Represents the IPTC Extension XMP package. |
| `XmpIptcIimPackage` | Represents the IPTC-IIM XMP package. |
| `XmpMediaManagementPackage` | Represents the XMP Media Management namespace. |
| `XmpPagedTextPackage` | Represents the XMP Paged-Text package. |
| `XmpPdfPackage` | Specifies properties used with Adobe PDF documents. |
| `XmpPhotoshopPackage` | Represents Adobe Photoshop namespace. |
| `XmpRightsManagementPackage` | Represents XMP Rights Management namespace. |
| `XmpTimeFormat` | Represents time format in `XmpTimecode`. |
| `XmpWhiteBalance` | Represents the White Balance setting in `XmpCameraRawPackage`. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `XmpCropUnit` | Represent a unit for CropWidth and CropHeight in `XmpCameraRawPackage`. |
| `XmpPhotoshopColorMode` | Represents a color mode in `XmpPhotoshopPackage`. |

### XmpAudioChannelType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype.md

#### XmpAudioChannelType class

Represents audio channel type.

The XmpAudioChannelType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| mono | Gets mono audio channel. |
| stereo | Gets stereo audio channel. |
| audio51 | Gets 5.1 audio channel. |
| audio71 | Gets 7.1 audio channel. |
| audio_16_channel | Gets 16 audio channel. |
| other_channel | Gets other channel. |

### audio51 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio51.md

#### audio51 property

Gets 5.1 audio channel.
##### Definition:
```python
@property
def audio51(self):
    ...
```

### audio71 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio71.md

#### audio71 property

Gets 7.1 audio channel.
##### Definition:
```python
@property
def audio71(self):
    ...
```

### audio_16_channel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/audio_16_channel.md

#### audio_16_channel property

Gets 16 audio channel.
##### Definition:
```python
@property
def audio_16_channel(self):
    ...
```

### mono property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/mono.md

#### mono property

Gets mono audio channel.
##### Definition:
```python
@property
def mono(self):
    ...
```

### other_channel property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/other_channel.md

#### other_channel property

Gets other channel.
##### Definition:
```python
@property
def other_channel(self):
    ...
```

### stereo property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiochanneltype/stereo.md

#### stereo property

Gets stereo audio channel.
##### Definition:
```python
@property
def stereo(self):
    ...
```

### XmpAudioSampleType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype.md

#### XmpAudioSampleType class

Represents Audio sample type in `XmpDynamicMediaPackage`.

The XmpAudioSampleType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| sample_8_int | Gets 8Int audio sample. |
| sample_16_int | Gets 16Int audio sample. |
| sample_24_int | Gets 24Int audio sample. |
| sample_32_int | Gets 32Int audio sample. |
| sample_32_float | Gets 32Float audio sample. |
| compressed | Gets Compressed audio sample. |
| packed | Gets Packed audio sample. |
| other | Gets Other audio sample. |

### compressed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/compressed.md

#### compressed property

Gets Compressed audio sample.
##### Definition:
```python
@property
def compressed(self):
    ...
```

### other property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/other.md

#### other property

Gets Other audio sample.
##### Definition:
```python
@property
def other(self):
    ...
```

### packed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/packed.md

#### packed property

Gets Packed audio sample.
##### Definition:
```python
@property
def packed(self):
    ...
```

### sample_16_int property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample_16_int.md

#### sample_16_int property

Gets 16Int audio sample.
##### Definition:
```python
@property
def sample_16_int(self):
    ...
```

### sample_24_int property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample_24_int.md

#### sample_24_int property

Gets 24Int audio sample.
##### Definition:
```python
@property
def sample_24_int(self):
    ...
```

### sample_32_float property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample_32_float.md

#### sample_32_float property

Gets 32Float audio sample.
##### Definition:
```python
@property
def sample_32_float(self):
    ...
```

### sample_32_int property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample_32_int.md

#### sample_32_int property

Gets 32Int audio sample.
##### Definition:
```python
@property
def sample_32_int(self):
    ...
```

### sample_8_int property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpaudiosampletype/sample_8_int.md

#### sample_8_int property

Gets 8Int audio sample.
##### Definition:
```python
@property
def sample_8_int(self):
    ...
```

### XmpBasicJobTicketPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage.md

#### XmpBasicJobTicketPackage class

Represents Basic Job-Ticket namespace.

**Inheritance:** `XmpBasicJobTicketPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpBasicJobTicketPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpBasicJobTicketPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| jobs | Gets or sets the jobs. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpBasicJobTicketPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpBasicJobTicketPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### jobs property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/jobs.md

#### jobs property

Gets or sets the jobs.
##### Definition:
```python
@property
def jobs(self):
    ...
@jobs.setter
def jobs(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicjobticketpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpBasicPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage.md

#### XmpBasicPackage class

Represents the XMP basic namespace.

**Inheritance:** `XmpBasicPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpBasicPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpBasicPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| base_url | Gets or sets the base URL for relative URLs in the document content.
<br/>If this document contains Internet links, and those links are relative, they are relative to this base URL. |
| create_date | Gets or sets the date and time the resource was created. |
| creator_tool | Gets or sets the name of the tool used to create the resource. |
| identifiers | Gets or sets an unordered array of text strings that unambiguously identify the resource within a given context. |
| label | Gets or sets a word or short phrase that identifies the resource as a member of a user-defined collection. |
| metadata_date | Gets or sets the date and time that any metadata for this resource was last changed. |
| modify_date | Gets or sets the date and time the resource was last modified. |
| nickname | Gets or sets a short informal name for the resource. |
| rating | Gets or sets a user-assigned rating for this file.
<br/>The value shall be -1 or in the range [0..5], where -1 indicates “rejected” and 0 indicates “unrated”. |
| thumbnails | Gets or sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding. |
| RATING_REJECTED | Rating rejected value. |
| RATING_MIN | Rating min value. |
| RATING_MAX | Rating max value. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Adds string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpBasicPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpBasicPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### base_url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/base_url.md

#### base_url property

Gets or sets the base URL for relative URLs in the document content.
If this document contains Internet links, and those links are relative, they are relative to this base URL.
##### Definition:
```python
@property
def base_url(self):
    ...
@base_url.setter
def base_url(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### create_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/create_date.md

#### create_date property

Gets or sets the date and time the resource was created.
##### Definition:
```python
@property
def create_date(self):
    ...
@create_date.setter
def create_date(self, value):
    ...
```

### creator_tool property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/creator_tool.md

#### creator_tool property

Gets or sets the name of the tool used to create the resource.
##### Definition:
```python
@property
def creator_tool(self):
    ...
@creator_tool.setter
def creator_tool(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### identifiers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/identifiers.md

#### identifiers property

Gets or sets an unordered array of text strings that unambiguously identify the resource within a given context.
##### Definition:
```python
@property
def identifiers(self):
    ...
@identifiers.setter
def identifiers(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### label property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/label.md

#### label property

Gets or sets a word or short phrase that identifies the resource as a member of a user-defined collection.
##### Definition:
```python
@property
def label(self):
    ...
@label.setter
def label(self, value):
    ...
```

### metadata_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/metadata_date.md

#### metadata_date property

Gets or sets the date and time that any metadata for this resource was last changed.
##### Definition:
```python
@property
def metadata_date(self):
    ...
@metadata_date.setter
def metadata_date(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modify_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/modify_date.md

#### modify_date property

Gets or sets the date and time the resource was last modified.
##### Definition:
```python
@property
def modify_date(self):
    ...
@modify_date.setter
def modify_date(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### nickname property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/nickname.md

#### nickname property

Gets or sets a short informal name for the resource.
##### Definition:
```python
@property
def nickname(self):
    ...
@nickname.setter
def nickname(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### rating property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/rating.md

#### rating property

Gets or sets a user-assigned rating for this file.
The value shall be -1 or in the range [0..5], where -1 indicates “rejected” and 0 indicates “unrated”.
##### Definition:
```python
@property
def rating(self):
    ...
@rating.setter
def rating(self, value):
    ...
```

### RATING_MAX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/rating_max.md

#### RATING_MAX property

Rating max value.
##### Definition:
```python
f RATING_MAX 
```

### RATING_MIN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/rating_min.md

#### RATING_MIN property

Rating min value.
##### Definition:
```python
f RATING_MIN 
```

### RATING_REJECTED property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/rating_rejected.md

#### RATING_REJECTED property

Rating rejected value.
##### Definition:
```python
f RATING_REJECTED 
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/set.md

#### set(self, name, value)

Adds string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XmpBasic key. |
| value | System.String | String value. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Metadata key is not provided. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### thumbnails property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/thumbnails.md

#### thumbnails property

Gets or sets an array of thumbnail images for the file, which can differ in characteristics such as size or image encoding.
##### Definition:
```python
@property
def thumbnails(self):
    ...
@thumbnails.setter
def thumbnails(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpbasicpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpCameraRawPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage.md

#### XmpCameraRawPackage class

Represents Camera Raw schema.

**Inheritance:** `XmpCameraRawPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpCameraRawPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpCameraRawPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| auto_brightness | Gets or sets the AutoBrightness value. When true, `XmpCameraRawPackage.brightness` is automatically adjusted. |
| auto_contrast | Gets or sets the AutoContrast value. When true, "Contrast" is automatically adjusted. |
| auto_exposure | Gets or sets the AutoExposure value. When true, "Exposure" is automatically adjusted. |
| auto_shadows | Gets or sets the AutoShadows value. When true, "Shadows" is automatically adjusted. |
| blue_hue | Gets or sets the BlueHue value. Null if undefined. |
| blue_saturation | Gets or sets the BlueSaturation. Null if undefined. |
| brightness | Gets or sets the Brightness value. Null if undefined. |
| camera_profile | Gets or sets the CameraProfile value. |
| chromatic_aberration_b | Gets or sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined. |
| chromatic_aberration_r | Gets or sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined. |
| color_noise_reduction | Gets or sets the Color Noise Reduction setting. Range 0 to 100. |
| contrast | Gets or sets the Contrast setting. Range -50 to 100. |
| crop_top | Gets or sets the CropTop setting. When HasCrop is true, top of the crop rectangle. |
| crop_left | Gets or sets the CropLeft setting. When HasCrop is true, left of the crop rectangle. |
| crop_bottom | Gets or sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle. |
| crop_right | Gets or sets the CropRight setting. When HasCrop is true, right of the crop rectangle. |
| crop_angle | Gets or sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle. |
| crop_width | Gets or sets the width of the resulting cropped image in `XmpCameraRawPackage.crop_units` units. |
| crop_height | Gets or sets the height of the resulting cropped image in `XmpCameraRawPackage.crop_units` units. |
| crop_units | Gets or sets units for `XmpCameraRawPackage.crop_width` and `XmpCameraRawPackage.crop_height`. |
| exposure | Gets or sets the Exposure setting. |
| green_hue | Gets or sets the Green Hue setting. Range -100 to 100. |
| green_saturation | Gets or sets the Green Saturation setting. Range -100 to 100. |
| has_crop | Gets or sets the HasCrop value. When true, the image has a cropping rectangle. |
| has_settings | Gets or sets HasSettings value. When true, non-default camera raw settings. |
| luminance_smoothing | Gets or sets the LuminanceSmoothing setting. Range 0 to 100. |
| raw_file_name | Gets or sets the file name for a raw file (not a complete path). |
| red_hue | Gets or sets the Red Hue setting. Range -100 to 100. |
| red_saturation | Gets or sets the Red Saturation setting. Range -100 to 100. |
| saturation | Gets or sets the Saturation setting. Range -100 to 100. |
| shadows | Gets or sets the Shadows setting. Range 0 to 100. |
| shadow_tint | Gets or sets the ShadowTint setting. Range -100 to 100. |
| sharpness | Gets or sets the Sharpness setting. Range 0 to 100. |
| temperature | Gets or sets the Temperature setting. Range 2000 to 50000. |
| tint | Gets or sets the Tint setting. Range -150 to 150. |
| version | Gets or sets the version of the Camera Raw plug-in. |
| vignette_amount | Gets or sets the Vignette Amount setting. Range -100 to 100. |
| vignette_midpoint | Gets or sets the Vignetting Midpoint setting. Range 0 to 100. |
| white_balance | Gets White Balance setting. Use `XmpCameraRawPackage.set_white_balance` to set white balance value. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Adds string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |
| `set_white_balance(self, white_balance)` | Sets the white balance. |

### XmpCameraRawPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpCameraRawPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### auto_brightness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/auto_brightness.md

#### auto_brightness property

Gets or sets the AutoBrightness value. When true, `XmpCameraRawPackage.brightness` is automatically adjusted.
##### Definition:
```python
@property
def auto_brightness(self):
    ...
@auto_brightness.setter
def auto_brightness(self, value):
    ...
```

### auto_contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/auto_contrast.md

#### auto_contrast property

Gets or sets the AutoContrast value. When true, "Contrast" is automatically adjusted.
##### Definition:
```python
@property
def auto_contrast(self):
    ...
@auto_contrast.setter
def auto_contrast(self, value):
    ...
```

### auto_exposure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/auto_exposure.md

#### auto_exposure property

Gets or sets the AutoExposure value. When true, "Exposure" is automatically adjusted.
##### Definition:
```python
@property
def auto_exposure(self):
    ...
@auto_exposure.setter
def auto_exposure(self, value):
    ...
```

### auto_shadows property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/auto_shadows.md

#### auto_shadows property

Gets or sets the AutoShadows value. When true, "Shadows" is automatically adjusted.
##### Definition:
```python
@property
def auto_shadows(self):
    ...
@auto_shadows.setter
def auto_shadows(self, value):
    ...
```

### blue_hue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/blue_hue.md

#### blue_hue property

Gets or sets the BlueHue value. Null if undefined.
##### Definition:
```python
@property
def blue_hue(self):
    ...
@blue_hue.setter
def blue_hue(self, value):
    ...
```

### blue_saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/blue_saturation.md

#### blue_saturation property

Gets or sets the BlueSaturation. Null if undefined.
##### Definition:
```python
@property
def blue_saturation(self):
    ...
@blue_saturation.setter
def blue_saturation(self, value):
    ...
```

### brightness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/brightness.md

#### brightness property

Gets or sets the Brightness value. Null if undefined.
##### Definition:
```python
@property
def brightness(self):
    ...
@brightness.setter
def brightness(self, value):
    ...
```

### camera_profile property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/camera_profile.md

#### camera_profile property

Gets or sets the CameraProfile value.
##### Definition:
```python
@property
def camera_profile(self):
    ...
@camera_profile.setter
def camera_profile(self, value):
    ...
```

### chromatic_aberration_b property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/chromatic_aberration_b.md

#### chromatic_aberration_b property

Gets or sets the "Chromatic Aberration, Fix Blue/Yellow Fringe" setting. Null if undefined.
##### Definition:
```python
@property
def chromatic_aberration_b(self):
    ...
@chromatic_aberration_b.setter
def chromatic_aberration_b(self, value):
    ...
```

### chromatic_aberration_r property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/chromatic_aberration_r.md

#### chromatic_aberration_r property

Gets or sets the "Chromatic Aberration, Fix Red/Cyan Fringe" setting. Null if undefined.
##### Definition:
```python
@property
def chromatic_aberration_r(self):
    ...
@chromatic_aberration_r.setter
def chromatic_aberration_r(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### color_noise_reduction property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/color_noise_reduction.md

#### color_noise_reduction property

Gets or sets the Color Noise Reduction setting. Range 0 to 100.
##### Definition:
```python
@property
def color_noise_reduction(self):
    ...
@color_noise_reduction.setter
def color_noise_reduction(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contrast property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/contrast.md

#### contrast property

Gets or sets the Contrast setting. Range -50 to 100.
##### Definition:
```python
@property
def contrast(self):
    ...
@contrast.setter
def contrast(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### crop_angle property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_angle.md

#### crop_angle property

Gets or sets the CropAngle setting. When HasCrop is true, angle of the crop rectangle.
##### Definition:
```python
@property
def crop_angle(self):
    ...
@crop_angle.setter
def crop_angle(self, value):
    ...
```

### crop_bottom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_bottom.md

#### crop_bottom property

Gets or sets the CropBottom setting. When HasCrop is true, bottom of the crop rectangle.
##### Definition:
```python
@property
def crop_bottom(self):
    ...
@crop_bottom.setter
def crop_bottom(self, value):
    ...
```

### crop_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_height.md

#### crop_height property

Gets or sets the height of the resulting cropped image in `XmpCameraRawPackage.crop_units` units.
##### Definition:
```python
@property
def crop_height(self):
    ...
@crop_height.setter
def crop_height(self, value):
    ...
```

### crop_left property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_left.md

#### crop_left property

Gets or sets the CropLeft setting. When HasCrop is true, left of the crop rectangle.
##### Definition:
```python
@property
def crop_left(self):
    ...
@crop_left.setter
def crop_left(self, value):
    ...
```

### crop_right property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_right.md

#### crop_right property

Gets or sets the CropRight setting. When HasCrop is true, right of the crop rectangle.
##### Definition:
```python
@property
def crop_right(self):
    ...
@crop_right.setter
def crop_right(self, value):
    ...
```

### crop_top property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_top.md

#### crop_top property

Gets or sets the CropTop setting. When HasCrop is true, top of the crop rectangle.
##### Definition:
```python
@property
def crop_top(self):
    ...
@crop_top.setter
def crop_top(self, value):
    ...
```

### crop_units property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_units.md

#### crop_units property

Gets or sets units for `XmpCameraRawPackage.crop_width` and `XmpCameraRawPackage.crop_height`.
##### Definition:
```python
@property
def crop_units(self):
    ...
@crop_units.setter
def crop_units(self, value):
    ...
```

### crop_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/crop_width.md

#### crop_width property

Gets or sets the width of the resulting cropped image in `XmpCameraRawPackage.crop_units` units.
##### Definition:
```python
@property
def crop_width(self):
    ...
@crop_width.setter
def crop_width(self, value):
    ...
```

### exposure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/exposure.md

#### exposure property

Gets or sets the Exposure setting.
##### Definition:
```python
@property
def exposure(self):
    ...
@exposure.setter
def exposure(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### green_hue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/green_hue.md

#### green_hue property

Gets or sets the Green Hue setting. Range -100 to 100.
##### Definition:
```python
@property
def green_hue(self):
    ...
@green_hue.setter
def green_hue(self, value):
    ...
```

### green_saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/green_saturation.md

#### green_saturation property

Gets or sets the Green Saturation setting. Range -100 to 100.
##### Definition:
```python
@property
def green_saturation(self):
    ...
@green_saturation.setter
def green_saturation(self, value):
    ...
```

### has_crop property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/has_crop.md

#### has_crop property

Gets or sets the HasCrop value. When true, the image has a cropping rectangle.
##### Definition:
```python
@property
def has_crop(self):
    ...
@has_crop.setter
def has_crop(self, value):
    ...
```

### has_settings property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/has_settings.md

#### has_settings property

Gets or sets HasSettings value. When true, non-default camera raw settings.
##### Definition:
```python
@property
def has_settings(self):
    ...
@has_settings.setter
def has_settings(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### luminance_smoothing property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/luminance_smoothing.md

#### luminance_smoothing property

Gets or sets the LuminanceSmoothing setting. Range 0 to 100.
##### Definition:
```python
@property
def luminance_smoothing(self):
    ...
@luminance_smoothing.setter
def luminance_smoothing(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### raw_file_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/raw_file_name.md

#### raw_file_name property

Gets or sets the file name for a raw file (not a complete path).
##### Definition:
```python
@property
def raw_file_name(self):
    ...
@raw_file_name.setter
def raw_file_name(self, value):
    ...
```

### red_hue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/red_hue.md

#### red_hue property

Gets or sets the Red Hue setting. Range -100 to 100.
##### Definition:
```python
@property
def red_hue(self):
    ...
@red_hue.setter
def red_hue(self, value):
    ...
```

### red_saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/red_saturation.md

#### red_saturation property

Gets or sets the Red Saturation setting. Range -100 to 100.
##### Definition:
```python
@property
def red_saturation(self):
    ...
@red_saturation.setter
def red_saturation(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### saturation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/saturation.md

#### saturation property

Gets or sets the Saturation setting. Range -100 to 100.
##### Definition:
```python
@property
def saturation(self):
    ...
@saturation.setter
def saturation(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/set.md

#### set(self, name, value)

Adds string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata key. |
| value | System.String | XMP metadata value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### set_white_balance method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/set_white_balance.md

#### set_white_balance(self, white_balance)

Sets the white balance.

```python

def set_white_balance(self, white_balance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| white_balance | groupdocs.metadata.standards.xmp.schemes.XmpWhiteBalance | The white balance. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | WhiteBalance could not be null. |

### shadow_tint property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/shadow_tint.md

#### shadow_tint property

Gets or sets the ShadowTint setting. Range -100 to 100.
##### Definition:
```python
@property
def shadow_tint(self):
    ...
@shadow_tint.setter
def shadow_tint(self, value):
    ...
```

### shadows property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/shadows.md

#### shadows property

Gets or sets the Shadows setting. Range 0 to 100.
##### Definition:
```python
@property
def shadows(self):
    ...
@shadows.setter
def shadows(self, value):
    ...
```

### sharpness property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/sharpness.md

#### sharpness property

Gets or sets the Sharpness setting. Range 0 to 100.
##### Definition:
```python
@property
def sharpness(self):
    ...
@sharpness.setter
def sharpness(self, value):
    ...
```

### temperature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/temperature.md

#### temperature property

Gets or sets the Temperature setting. Range 2000 to 50000.
##### Definition:
```python
@property
def temperature(self):
    ...
@temperature.setter
def temperature(self, value):
    ...
```

### tint property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/tint.md

#### tint property

Gets or sets the Tint setting. Range -150 to 150.
##### Definition:
```python
@property
def tint(self):
    ...
@tint.setter
def tint(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/version.md

#### version property

Gets or sets the version of the Camera Raw plug-in.
##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### vignette_amount property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/vignette_amount.md

#### vignette_amount property

Gets or sets the Vignette Amount setting. Range -100 to 100.
##### Definition:
```python
@property
def vignette_amount(self):
    ...
@vignette_amount.setter
def vignette_amount(self, value):
    ...
```

### vignette_midpoint property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/vignette_midpoint.md

#### vignette_midpoint property

Gets or sets the Vignetting Midpoint setting. Range 0 to 100.
##### Definition:
```python
@property
def vignette_midpoint(self):
    ...
@vignette_midpoint.setter
def vignette_midpoint(self, value):
    ...
```

### white_balance property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/white_balance.md

#### white_balance property

Gets White Balance setting. Use `XmpCameraRawPackage.set_white_balance` to set white balance value.
##### Definition:
```python
@property
def white_balance(self):
    ...
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcamerarawpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpCropUnit enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpcropunit.md

#### XmpCropUnit enumeration

Represent a unit for CropWidth and CropHeight in `XmpCameraRawPackage`.

The XmpCropUnit type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PIXELS | Pixels units. |
| INCHES | Inches units. |
| CM | Centimeters units. |

### XmpDublinCorePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage.md

#### XmpDublinCorePackage class

Represents the Dublin Core scheme.

**Inheritance:** `XmpDublinCorePackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpDublinCorePackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpDublinCorePackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| contributors | Gets or sets an array of the contributors. |
| coverage | Gets or sets the extent or scope of the resource. |
| creators | Gets or sets an array of the creators. |
| dates | Gets or sets an array of dates associated with an event in the life cycle of the resource. |
| descriptions | Gets or sets an array of textual descriptions of the content of the resource, given in various languages. |
| format | Gets or sets the MIME type of the resource. |
| identifier | Gets or sets a string value representing an unambiguous reference to the resource within a given context. |
| languages | Gets or sets an array of languages used in the content of the resource. |
| publishers | Gets or sets an array of publishers made the resource available. |
| relations | Gets or sets an array of the related resources. |
| rights | Gets or sets an array of the informal rights statements, given in various languages. |
| source | Gets or sets the related resource from which the described resource is derived. |
| subjects | Gets or sets an array of descriptive phrases or keywords that specify the content of the resource. |
| titles | Gets or sets the title or name of the resource, given in various languages. |
| types | Gets or sets an array of string values representing the nature or genre of the resource. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |
| `set_contributor(self, contributor)` | Sets a single contributor of the resource. |
| `set_creator(self, creator)` | Sets a single creator of the resource. |
| `set_date(self, date)` | Sets a single date associated with the resource. |
| `set_description(self, description)` | Sets the resource description, given in a single laguage. |
| `set_language(self, language)` | Sets a single language associated with the resource. |
| `set_publisher(self, publisher)` | Sets a single publisher of the resource. |
| `set_relation(self, relation)` | Sets a single related resource. |
| `set_rights(self, rights)` | Sets the resource rights, given in a single laguage. |
| `set_subject(self, subject)` | Sets a single subject of the resource. |
| `set_title(self, title)` | Sets the resource title, given in a single laguage. |
| `set_type(self, type)` | Sets a single type of the resource. |

##### Remarks

For more information see: http://dublincore.org/documents/usageguide/elements.shtml.

### XmpDublinCorePackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpDublinCorePackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contributors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/contributors.md

#### contributors property

Gets or sets an array of the contributors.

##### Remarks

These contributors should not include those listed in dc:creator.
##### Definition:
```python
@property
def contributors(self):
    ...
@contributors.setter
def contributors(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### creators property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/creators.md

#### creators property

Gets or sets an array of the creators.

##### Remarks

Entities should be listed in order of decreasing precedence, if such order is significant.
Examples of a creator include a person, an organization, or a service. Typically, the name of a creator should be used to indicate the entity.
##### Definition:
```python
@property
def creators(self):
    ...
@creators.setter
def creators(self, value):
    ...
```

### dates property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/dates.md

#### dates property

Gets or sets an array of dates associated with an event in the life cycle of the resource.
##### Definition:
```python
@property
def dates(self):
    ...
@dates.setter
def dates(self, value):
    ...
```

### descriptions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/descriptions.md

#### descriptions property

Gets or sets an array of textual descriptions of the content of the resource, given in various languages.
##### Definition:
```python
@property
def descriptions(self):
    ...
@descriptions.setter
def descriptions(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/format.md

#### format property

Gets or sets the MIME type of the resource.
##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/identifier.md

#### identifier property

Gets or sets a string value representing an unambiguous reference to the resource within a given context.

##### Remarks

Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
##### Definition:
```python
@property
def identifier(self):
    ...
@identifier.setter
def identifier(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### languages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/languages.md

#### languages property

Gets or sets an array of languages used in the content of the resource.
##### Definition:
```python
@property
def languages(self):
    ...
@languages.setter
def languages(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### publishers property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/publishers.md

#### publishers property

Gets or sets an array of publishers made the resource available.

##### Remarks

Examples of a publisher include a person, an organization, or a service. Typically, the name of a publisher should be used to indicate the entity.
##### Definition:
```python
@property
def publishers(self):
    ...
@publishers.setter
def publishers(self, value):
    ...
```

### relations property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/relations.md

#### relations property

Gets or sets an array of the related resources.

##### Remarks

Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### Definition:
```python
@property
def relations(self):
    ...
@relations.setter
def relations(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### rights property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/rights.md

#### rights property

Gets or sets an array of the informal rights statements, given in various languages.

##### Remarks

Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.
##### Definition:
```python
@property
def rights(self):
    ...
@rights.setter
def rights(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set.md

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

### set_contributor method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_contributor.md

#### set_contributor(self, contributor)

Sets a single contributor of the resource.

```python

def set_contributor(self, contributor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| contributor | System.String | The contributor to set. |

### set_creator method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_creator.md

#### set_creator(self, creator)

Sets a single creator of the resource.

```python

def set_creator(self, creator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| creator | System.String | The creator to set. |

### set_date method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_date.md

#### set_date(self, date)

Sets a single date associated with the resource.

```python

def set_date(self, date):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| date | System.DateTime | The date to set. |

### set_description method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_description.md

#### set_description(self, description)

Sets the resource description, given in a single laguage.

```python

def set_description(self, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | System.String | The description to set. |

### set_language method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_language.md

#### set_language(self, language)

Sets a single language associated with the resource.

```python

def set_language(self, language):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| language | System.String | The language to set. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### set_publisher method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_publisher.md

#### set_publisher(self, publisher)

Sets a single publisher of the resource.

```python

def set_publisher(self, publisher):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| publisher | System.String | The publisher to set. |

### set_relation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_relation.md

#### set_relation(self, relation)

Sets a single related resource.

```python

def set_relation(self, relation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| relation | System.String | The relation to set. |

### set_rights method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_rights.md

#### set_rights(self, rights)

Sets the resource rights, given in a single laguage.

```python

def set_rights(self, rights):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rights | System.String | The rights statements to set. |

### set_subject method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_subject.md

#### set_subject(self, subject)

Sets a single subject of the resource.

```python

def set_subject(self, subject):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| subject | System.String | The subject to set. |

### set_title method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_title.md

#### set_title(self, title)

Sets the resource title, given in a single laguage.

```python

def set_title(self, title):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| title | System.String | The title to set. |

### set_type method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/set_type.md

#### set_type(self, type)

Sets a single type of the resource.

```python

def set_type(self, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| type | System.String | The type to set. |

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/source.md

#### source property

Gets or sets the related resource from which the described resource is derived.

##### Remarks

The described resource may be derived from the related resource in whole or in part.
Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
##### Definition:
```python
@property
def source(self):
    ...
@source.setter
def source(self, value):
    ...
```

### subjects property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/subjects.md

#### subjects property

Gets or sets an array of descriptive phrases or keywords that specify the content of the resource.
##### Definition:
```python
@property
def subjects(self):
    ...
@subjects.setter
def subjects(self, value):
    ...
```

### titles property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/titles.md

#### titles property

Gets or sets the title or name of the resource, given in various languages.
##### Definition:
```python
@property
def titles(self):
    ...
@titles.setter
def titles(self, value):
    ...
```

### types property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/types.md

#### types property

Gets or sets an array of string values representing the nature or genre of the resource.
##### Definition:
```python
@property
def types(self):
    ...
@types.setter
def types(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdublincorepackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpDynamicMediaPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage.md

#### XmpDynamicMediaPackage class

Represents XMP Dynamic Media namespace.

**Inheritance:** `XmpDynamicMediaPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpDynamicMediaPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpDynamicMediaPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| abs_peak_audio_file_path | Gets or sets the absolute path to the file’s peak audio file. |
| album | Gets or sets the name of the album. |
| alt_tape_name | Gets or sets the alternative tape name, set via the project window or timecode dialog in Premiere. |
| alt_timecode | Gets or sets the timecode set by the user. |
| artist | Gets or sets the name of the artist or artists. |
| audio_channel_type | Gets or sets the audio channel type. |
| audio_compressor | Gets or sets the audio compression used. |
| audio_sample_rate | Gets or sets the audio sample rate. |
| audio_sample_type | Gets or sets the audio sample type. |
| camera_angle | Gets or sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology. |
| camera_label | Gets or sets the description of the camera used for a shoot. |
| camera_model | Gets or sets the make and model of the camera used for a shoot. |
| camera_move | Gets or sets the movement of the camera during the shot, from a fixed set of industry standard terminology. |
| client | Gets or sets the client for the job of which this shot or take is a part. |
| comment | Gets or sets the user’s comments. |
| composer | Gets or sets the composer’s names. |
| director | Gets or sets the director of the scene. |
| director_photography | Gets or sets the director of photography for the scene. |
| duration | Gets or sets the duration of the media file. |
| engineer | Gets or sets the engineer's names. |
| file_data_rate | Gets or sets the file data rate in megabytes per second. |
| genre | Gets or sets the name of the genres. |
| good | Gets or sets a value indicating whether the shot is a keeper. |
| instrument | Gets or sets the musical instruments. |
| intro_time | Gets or sets the duration of lead time for queuing music. |
| key | Gets or sets the audio’s musical key. |
| log_comment | Gets or sets the user’s log comments. |
| loop | Gets or sets a value indicating whether the clip can be looped seamlessly. |
| number_of_beats | Gets or sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds. |
| out_cue | Gets or sets the time at which to fade out. |
| project_name | Gets or sets the name of the project of which this file is a part. |
| relative_timestamp | Gets or sets the start time of the media inside the audio project. |
| release_date | Gets or sets the date the title was released. |
| shot_date | Gets or sets the date and time when the video was shot. |
| start_timecode | Gets or sets the timecode of the first frame of video in the file, as obtained from the device control. |
| take_number | Gets or sets a numeric value indicating the absolute number of a take. |
| tempo | Gets or sets the audio’s tempo. |
| track_number | Gets or sets a numeric value indicating the order of the audio file within its original recording. |
| video_alpha_premultiple_color | Gets or sets the timecode of the first frame of video in the file, as obtained from the device control. |
| video_alpha_unity_is_transparent | Gets or sets a value indicating whether the unity is clear. |
| video_frame_rate | Gets or sets the video frame rate. |
| video_frame_size | Gets or sets the frame size. |
| video_pixel_aspect_ratio | Gets or sets the aspect ratio, expressed as wd/ht. |
| part_of_compilation | Gets or sets a value indicating whether the resource is a part of compilation. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |
| `set_audio_channel_type(self, audio_channel_type)` | Sets the audio channel type. |
| `set_audio_sample_type(self, audio_sample_type)` | Sets the audio sample type. |

### XmpDynamicMediaPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpDynamicMediaPackage` class.

```python

def __init__(self):
    ...
```

### abs_peak_audio_file_path property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/abs_peak_audio_file_path.md

#### abs_peak_audio_file_path property

Gets or sets the absolute path to the file’s peak audio file.
##### Definition:
```python
@property
def abs_peak_audio_file_path(self):
    ...
@abs_peak_audio_file_path.setter
def abs_peak_audio_file_path(self, value):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/album.md

#### album property

Gets or sets the name of the album.
##### Definition:
```python
@property
def album(self):
    ...
@album.setter
def album(self, value):
    ...
```

### alt_tape_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/alt_tape_name.md

#### alt_tape_name property

Gets or sets the alternative tape name, set via the project window or timecode dialog in Premiere.
##### Definition:
```python
@property
def alt_tape_name(self):
    ...
@alt_tape_name.setter
def alt_tape_name(self, value):
    ...
```

### alt_timecode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/alt_timecode.md

#### alt_timecode property

Gets or sets the timecode set by the user.
##### Definition:
```python
@property
def alt_timecode(self):
    ...
@alt_timecode.setter
def alt_timecode(self, value):
    ...
```

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/artist.md

#### artist property

Gets or sets the name of the artist or artists.
##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### audio_channel_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audio_channel_type.md

#### audio_channel_type property

Gets or sets the audio channel type.
##### Definition:
```python
@property
def audio_channel_type(self):
    ...
@audio_channel_type.setter
def audio_channel_type(self, value):
    ...
```

### audio_compressor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audio_compressor.md

#### audio_compressor property

Gets or sets the audio compression used.
##### Definition:
```python
@property
def audio_compressor(self):
    ...
@audio_compressor.setter
def audio_compressor(self, value):
    ...
```

### audio_sample_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audio_sample_rate.md

#### audio_sample_rate property

Gets or sets the audio sample rate.
##### Definition:
```python
@property
def audio_sample_rate(self):
    ...
@audio_sample_rate.setter
def audio_sample_rate(self, value):
    ...
```

### audio_sample_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/audio_sample_type.md

#### audio_sample_type property

Gets or sets the audio sample type.
##### Definition:
```python
@property
def audio_sample_type(self):
    ...
@audio_sample_type.setter
def audio_sample_type(self, value):
    ...
```

### camera_angle property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/camera_angle.md

#### camera_angle property

Gets or sets the orientation of the camera to the subject in a static shot, from a fixed set of industry standard terminology.
##### Definition:
```python
@property
def camera_angle(self):
    ...
@camera_angle.setter
def camera_angle(self, value):
    ...
```

### camera_label property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/camera_label.md

#### camera_label property

Gets or sets the description of the camera used for a shoot.
##### Definition:
```python
@property
def camera_label(self):
    ...
@camera_label.setter
def camera_label(self, value):
    ...
```

### camera_model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/camera_model.md

#### camera_model property

Gets or sets the make and model of the camera used for a shoot.
##### Definition:
```python
@property
def camera_model(self):
    ...
@camera_model.setter
def camera_model(self, value):
    ...
```

### camera_move property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/camera_move.md

#### camera_move property

Gets or sets the movement of the camera during the shot, from a fixed set of industry standard terminology.
##### Definition:
```python
@property
def camera_move(self):
    ...
@camera_move.setter
def camera_move(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### client property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/client.md

#### client property

Gets or sets the client for the job of which this shot or take is a part.
##### Definition:
```python
@property
def client(self):
    ...
@client.setter
def client(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/comment.md

#### comment property

Gets or sets the user’s comments.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### composer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/composer.md

#### composer property

Gets or sets the composer’s names.
##### Definition:
```python
@property
def composer(self):
    ...
@composer.setter
def composer(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### director property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/director.md

#### director property

Gets or sets the director of the scene.
##### Definition:
```python
@property
def director(self):
    ...
@director.setter
def director(self, value):
    ...
```

### director_photography property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/director_photography.md

#### director_photography property

Gets or sets the director of photography for the scene.
##### Definition:
```python
@property
def director_photography(self):
    ...
@director_photography.setter
def director_photography(self, value):
    ...
```

### duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/duration.md

#### duration property

Gets or sets the duration of the media file.
##### Definition:
```python
@property
def duration(self):
    ...
@duration.setter
def duration(self, value):
    ...
```

### engineer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/engineer.md

#### engineer property

Gets or sets the engineer's names.
##### Definition:
```python
@property
def engineer(self):
    ...
@engineer.setter
def engineer(self, value):
    ...
```

### file_data_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/file_data_rate.md

#### file_data_rate property

Gets or sets the file data rate in megabytes per second.
##### Definition:
```python
@property
def file_data_rate(self):
    ...
@file_data_rate.setter
def file_data_rate(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/genre.md

#### genre property

Gets or sets the name of the genres.
##### Definition:
```python
@property
def genre(self):
    ...
@genre.setter
def genre(self, value):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### good property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/good.md

#### good property

Gets or sets a value indicating whether the shot is a keeper.
##### Definition:
```python
@property
def good(self):
    ...
@good.setter
def good(self, value):
    ...
```

### instrument property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/instrument.md

#### instrument property

Gets or sets the musical instruments.
##### Definition:
```python
@property
def instrument(self):
    ...
@instrument.setter
def instrument(self, value):
    ...
```

### intro_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/intro_time.md

#### intro_time property

Gets or sets the duration of lead time for queuing music.
##### Definition:
```python
@property
def intro_time(self):
    ...
@intro_time.setter
def intro_time(self, value):
    ...
```

### key property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/key.md

#### key property

Gets or sets the audio’s musical key.
##### Definition:
```python
@property
def key(self):
    ...
@key.setter
def key(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### log_comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/log_comment.md

#### log_comment property

Gets or sets the user’s log comments.
##### Definition:
```python
@property
def log_comment(self):
    ...
@log_comment.setter
def log_comment(self, value):
    ...
```

### loop property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/loop.md

#### loop property

Gets or sets a value indicating whether the clip can be looped seamlessly.
##### Definition:
```python
@property
def loop(self):
    ...
@loop.setter
def loop(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### number_of_beats property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/number_of_beats.md

#### number_of_beats property

Gets or sets the total number of musical beats in a clip; for example, the beats-per-second times the duration in seconds.
##### Definition:
```python
@property
def number_of_beats(self):
    ...
@number_of_beats.setter
def number_of_beats(self, value):
    ...
```

### out_cue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/out_cue.md

#### out_cue property

Gets or sets the time at which to fade out.
##### Definition:
```python
@property
def out_cue(self):
    ...
@out_cue.setter
def out_cue(self, value):
    ...
```

### part_of_compilation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/part_of_compilation.md

#### part_of_compilation property

Gets or sets a value indicating whether the resource is a part of compilation.
##### Definition:
```python
@property
def part_of_compilation(self):
    ...
@part_of_compilation.setter
def part_of_compilation(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### project_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/project_name.md

#### project_name property

Gets or sets the name of the project of which this file is a part.
##### Definition:
```python
@property
def project_name(self):
    ...
@project_name.setter
def project_name(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### relative_timestamp property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/relative_timestamp.md

#### relative_timestamp property

Gets or sets the start time of the media inside the audio project.
##### Definition:
```python
@property
def relative_timestamp(self):
    ...
@relative_timestamp.setter
def relative_timestamp(self, value):
    ...
```

### release_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/release_date.md

#### release_date property

Gets or sets the date the title was released.
##### Definition:
```python
@property
def release_date(self):
    ...
@release_date.setter
def release_date(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_audio_channel_type method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/set_audio_channel_type.md

#### set_audio_channel_type(self, audio_channel_type)

Sets the audio channel type.

```python

def set_audio_channel_type(self, audio_channel_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| audio_channel_type | groupdocs.metadata.standards.xmp.schemes.XmpAudioChannelType | The audio channel type. |

### set_audio_sample_type method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/set_audio_sample_type.md

#### set_audio_sample_type(self, audio_sample_type)

Sets the audio sample type.

```python

def set_audio_sample_type(self, audio_sample_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| audio_sample_type | groupdocs.metadata.standards.xmp.schemes.XmpAudioSampleType | The audio sample type. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### shot_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/shot_date.md

#### shot_date property

Gets or sets the date and time when the video was shot.
##### Definition:
```python
@property
def shot_date(self):
    ...
@shot_date.setter
def shot_date(self, value):
    ...
```

### start_timecode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/start_timecode.md

#### start_timecode property

Gets or sets the timecode of the first frame of video in the file, as obtained from the device control.
##### Definition:
```python
@property
def start_timecode(self):
    ...
@start_timecode.setter
def start_timecode(self, value):
    ...
```

### take_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/take_number.md

#### take_number property

Gets or sets a numeric value indicating the absolute number of a take.
##### Definition:
```python
@property
def take_number(self):
    ...
@take_number.setter
def take_number(self, value):
    ...
```

### tempo property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/tempo.md

#### tempo property

Gets or sets the audio’s tempo.
##### Definition:
```python
@property
def tempo(self):
    ...
@tempo.setter
def tempo(self, value):
    ...
```

### track_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/track_number.md

#### track_number property

Gets or sets a numeric value indicating the order of the audio file within its original recording.
##### Definition:
```python
@property
def track_number(self):
    ...
@track_number.setter
def track_number(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### video_alpha_premultiple_color property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/video_alpha_premultiple_color.md

#### video_alpha_premultiple_color property

Gets or sets the timecode of the first frame of video in the file, as obtained from the device control.
##### Definition:
```python
@property
def video_alpha_premultiple_color(self):
    ...
@video_alpha_premultiple_color.setter
def video_alpha_premultiple_color(self, value):
    ...
```

### video_alpha_unity_is_transparent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/video_alpha_unity_is_transparent.md

#### video_alpha_unity_is_transparent property

Gets or sets a value indicating whether the unity is clear.
##### Definition:
```python
@property
def video_alpha_unity_is_transparent(self):
    ...
@video_alpha_unity_is_transparent.setter
def video_alpha_unity_is_transparent(self, value):
    ...
```

### video_frame_rate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/video_frame_rate.md

#### video_frame_rate property

Gets or sets the video frame rate.
##### Definition:
```python
@property
def video_frame_rate(self):
    ...
@video_frame_rate.setter
def video_frame_rate(self, value):
    ...
```

### video_frame_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/video_frame_size.md

#### video_frame_size property

Gets or sets the frame size.
##### Definition:
```python
@property
def video_frame_size(self):
    ...
@video_frame_size.setter
def video_frame_size(self, value):
    ...
```

### video_pixel_aspect_ratio property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/video_pixel_aspect_ratio.md

#### video_pixel_aspect_ratio property

Gets or sets the aspect ratio, expressed as wd/ht.
##### Definition:
```python
@property
def video_pixel_aspect_ratio(self):
    ...
@video_pixel_aspect_ratio.setter
def video_pixel_aspect_ratio(self, value):
    ...
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpdynamicmediapackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpIptcCorePackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage.md

#### XmpIptcCorePackage class

Represents the IPTC Core XMP package.

**Inheritance:** `XmpIptcCorePackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpIptcCorePackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpIptcCorePackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| country_code | Gets or sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code. |
| intellectual_genre | Gets or sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content. |
| location | Gets or sets the location the content is focusing on. |
| scenes | Gets or sets the scene of the photo content. |
| subject_codes | Gets or sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpIptcCorePackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpIptcCorePackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### country_code property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/country_code.md

#### country_code property

Gets or sets the code of the country the content is focusing on. The code should be taken from ISO 3166 two or three letter code.
##### Definition:
```python
@property
def country_code(self):
    ...
@country_code.setter
def country_code(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### intellectual_genre property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/intellectual_genre.md

#### intellectual_genre property

Gets or sets the intellectual genre. Describes the nature, intellectual, artistic or journalistic characteristic of a news object, not specifically its content.
##### Definition:
```python
@property
def intellectual_genre(self):
    ...
@intellectual_genre.setter
def intellectual_genre(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### location property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/location.md

#### location property

Gets or sets the location the content is focusing on.

##### Remarks

This location name could either be the name of a sublocation to a city or the name of a well known location
or (natural) monument outside a city.
In the sense of a sublocation to a city this element is at the fourth level of a top-down geographical hierarchy.
##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### scenes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/scenes.md

#### scenes property

Gets or sets the scene of the photo content.

##### Remarks

Specifies one or more terms from the IPTC "Scene-NewsCodes".
Each Scene is represented as a string of 6 digits in an unordered list
##### Definition:
```python
@property
def scenes(self):
    ...
@scenes.setter
def scenes(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### subject_codes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/subject_codes.md

#### subject_codes property

Gets or sets one or more Subjects from the IPTC "Subject-NewsCodes" taxonomy to categorize the content.Each Subject is represented as a string of 8 digits in an unordered list.

##### Remarks

More about IPTC Subject-NewsCodes at http://www.newscodes.org.
##### Definition:
```python
@property
def subject_codes(self):
    ...
@subject_codes.setter
def subject_codes(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptccorepackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpIptcExtensionPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage.md

#### XmpIptcExtensionPackage class

Represents the IPTC Extension XMP package.

**Inheritance:** `XmpIptcExtensionPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpIptcExtensionPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpIptcExtensionPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| additional_model_information | Gets or sets the information about the ethnicity and other facets of the model(s) in a model-released image. |
| organisation_in_image_codes | Gets or sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image. |
| organisation_in_image_names | Gets or sets names of the organisations or companies which are featured in the image. |
| ages_of_models | Gets or sets ages of the human models at the time this image was taken in a model released image. |
| persons_in_image | Gets or sets names of the persons the content of the item is about. |
| digital_image_guid | Gets or sets the globally unique identifier for this digital image. |
| digital_source_type | Gets or sets the type of the source of this digital image. |
| event | Gets or sets the description of the specific event at which the photo was taken. |
| iptc_last_edited | Gets or sets the date and optionally time when any of the IPTC photo metadata fields has been last edited. |
| max_available_height | Gets or sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing. |
| max_available_width | Gets or sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpIptcExtensionPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpIptcExtensionPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### additional_model_information property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/additional_model_information.md

#### additional_model_information property

Gets or sets the information about the ethnicity and other facets of the model(s) in a model-released image.
##### Definition:
```python
@property
def additional_model_information(self):
    ...
@additional_model_information.setter
def additional_model_information(self, value):
    ...
```

### ages_of_models property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/ages_of_models.md

#### ages_of_models property

Gets or sets ages of the human models at the time this image was taken in a model released image.
##### Definition:
```python
@property
def ages_of_models(self):
    ...
@ages_of_models.setter
def ages_of_models(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### digital_image_guid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/digital_image_guid.md

#### digital_image_guid property

Gets or sets the globally unique identifier for this digital image.

##### Remarks

It is created and applied by the creator of the digital image at the time of its creation.
This value shall not be changed after that time.
##### Definition:
```python
@property
def digital_image_guid(self):
    ...
@digital_image_guid.setter
def digital_image_guid(self, value):
    ...
```

### digital_source_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/digital_source_type.md

#### digital_source_type property

Gets or sets the type of the source of this digital image.
##### Definition:
```python
@property
def digital_source_type(self):
    ...
@digital_source_type.setter
def digital_source_type(self, value):
    ...
```

### event property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/event.md

#### event property

Gets or sets the description of the specific event at which the photo was taken.
##### Definition:
```python
@property
def event(self):
    ...
@event.setter
def event(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### iptc_last_edited property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/iptc_last_edited.md

#### iptc_last_edited property

Gets or sets the date and optionally time when any of the IPTC photo metadata fields has been last edited.
##### Definition:
```python
@property
def iptc_last_edited(self):
    ...
@iptc_last_edited.setter
def iptc_last_edited(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### max_available_height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/max_available_height.md

#### max_available_height property

Gets or sets the maximum available height in pixels of the original photo from which this photo has been derived by downsizing.
##### Definition:
```python
@property
def max_available_height(self):
    ...
@max_available_height.setter
def max_available_height(self, value):
    ...
```

### max_available_width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/max_available_width.md

#### max_available_width property

Gets or sets the the maximum available width in pixels of the original photo from which this photo has been derived by downsizing.
##### Definition:
```python
@property
def max_available_width(self):
    ...
@max_available_width.setter
def max_available_width(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### organisation_in_image_codes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/organisation_in_image_codes.md

#### organisation_in_image_codes property

Gets or sets codes from a controlled vocabulary for identifying the organisations or companies which are featured in the image.
##### Definition:
```python
@property
def organisation_in_image_codes(self):
    ...
@organisation_in_image_codes.setter
def organisation_in_image_codes(self, value):
    ...
```

### organisation_in_image_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/organisation_in_image_names.md

#### organisation_in_image_names property

Gets or sets names of the organisations or companies which are featured in the image.
##### Definition:
```python
@property
def organisation_in_image_names(self):
    ...
@organisation_in_image_names.setter
def organisation_in_image_names(self, value):
    ...
```

### persons_in_image property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/persons_in_image.md

#### persons_in_image property

Gets or sets names of the persons the content of the item is about.
##### Definition:
```python
@property
def persons_in_image(self):
    ...
@persons_in_image.setter
def persons_in_image(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptcextensionpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpIptcIimPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage.md

#### XmpIptcIimPackage class

Represents the IPTC-IIM XMP package.

**Inheritance:** `XmpIptcIimPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpIptcIimPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpIptcIimPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| model_version | Gets or sets the binary number identifying the version of the Information |
| destination | Gets or sets the destination. This DataSet is to accommodate some providers who require routing
<br/>information above the appropriate OSI layers. |
| file_format | Gets or sets the binary number identifying the version of the Information |
| file_format_version | Gets or sets the file format version. |
| service_identifier | Gets or sets the service identifier. Identifies the provider and product. |
| envelope_number | Gets or sets the envelope number. |
| product_i_ds | Gets or sets the product identifiers. |
| envelope_priority | Gets or sets the envelope handling priority. |
| date_sent | Gets or sets the date the service sent the material. |
| unique_name_of_object | Gets or sets the unique name of the object. |
| object_type_reference | Gets or sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM. |
| edit_status | Gets or sets the status of the object data, according to the practice of the provider. |
| urgency | Gets or sets the editorial urgency of the content. |
| category | Gets or sets the subject of the object data in the opinion of the provider. |
| supplemental_categories | Gets or sets the supplemental categories. |
| fixture_identifier | Gets or sets the object data that recurs often and predictably. |
| content_location_codes | Gets or sets the content location codes. |
| content_location_names | Gets or sets the content location names. |
| release_date | Gets or sets the earliest date the provider intends the object to be used. |
| expiration_date | Gets or sets the latest date the provider or owner intends the object data to be used. |
| action_advised | Gets or sets the type of action that this object provides to a previous object. |
| reference_service | Gets or sets the Service Identifier of a prior envelope to which the current object refers. |
| reference_date | Gets or sets the date of a prior envelope to which the current object refers. |
| reference_number | Gets or sets the Envelope Number of a prior envelope to which the current object refers. |
| digital_creation_date | Gets or sets the date the digital representation of the object data was created. |
| originating_program | Gets or sets the type of program used to originate the object data. |
| program_version | Gets or sets the program version. |
| image_type | Gets or sets the type of the image. |
| image_orientation | Gets or sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square). |
| language_identifier | Gets or sets the language identifier according to the 2-letter codes of ISO 639:1988. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpIptcIimPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpIptcIimPackage` class.

```python

def __init__(self):
    ...
```

### action_advised property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/action_advised.md

#### action_advised property

Gets or sets the type of action that this object provides to a previous object.
##### Definition:
```python
@property
def action_advised(self):
    ...
@action_advised.setter
def action_advised(self, value):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/category.md

#### category property

Gets or sets the subject of the object data in the opinion of the provider.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### content_location_codes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/content_location_codes.md

#### content_location_codes property

Gets or sets the content location codes.

##### Remarks

Indicates the code of a country/geographical location referenced by the content of the object.
##### Definition:
```python
@property
def content_location_codes(self):
    ...
@content_location_codes.setter
def content_location_codes(self, value):
    ...
```

### content_location_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/content_location_names.md

#### content_location_names property

Gets or sets the content location names.

##### Remarks

Provides a full, publishable name of a country/geographical location referenced by the content of the object,
according to guidelines of the provider.
##### Definition:
```python
@property
def content_location_names(self):
    ...
@content_location_names.setter
def content_location_names(self, value):
    ...
```

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### date_sent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/date_sent.md

#### date_sent property

Gets or sets the date the service sent the material.
##### Definition:
```python
@property
def date_sent(self):
    ...
@date_sent.setter
def date_sent(self, value):
    ...
```

### destination property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/destination.md

#### destination property

Gets or sets the destination. This DataSet is to accommodate some providers who require routing
information above the appropriate OSI layers.
##### Definition:
```python
@property
def destination(self):
    ...
@destination.setter
def destination(self, value):
    ...
```

### digital_creation_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/digital_creation_date.md

#### digital_creation_date property

Gets or sets the date the digital representation of the object data was created.
##### Definition:
```python
@property
def digital_creation_date(self):
    ...
@digital_creation_date.setter
def digital_creation_date(self, value):
    ...
```

### edit_status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/edit_status.md

#### edit_status property

Gets or sets the status of the object data, according to the practice of the provider.
##### Definition:
```python
@property
def edit_status(self):
    ...
@edit_status.setter
def edit_status(self, value):
    ...
```

### envelope_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/envelope_number.md

#### envelope_number property

Gets or sets the envelope number.
##### Definition:
```python
@property
def envelope_number(self):
    ...
@envelope_number.setter
def envelope_number(self, value):
    ...
```

### envelope_priority property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/envelope_priority.md

#### envelope_priority property

Gets or sets the envelope handling priority.
##### Definition:
```python
@property
def envelope_priority(self):
    ...
@envelope_priority.setter
def envelope_priority(self, value):
    ...
```

### expiration_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/expiration_date.md

#### expiration_date property

Gets or sets the latest date the provider or owner intends the object data to be used.
##### Definition:
```python
@property
def expiration_date(self):
    ...
@expiration_date.setter
def expiration_date(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/file_format.md

#### file_format property

Gets or sets the binary number identifying the version of the Information
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### file_format_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/file_format_version.md

#### file_format_version property

Gets or sets the file format version.
##### Definition:
```python
@property
def file_format_version(self):
    ...
@file_format_version.setter
def file_format_version(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### fixture_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/fixture_identifier.md

#### fixture_identifier property

Gets or sets the object data that recurs often and predictably.
##### Definition:
```python
@property
def fixture_identifier(self):
    ...
@fixture_identifier.setter
def fixture_identifier(self, value):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### image_orientation property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/image_orientation.md

#### image_orientation property

Gets or sets the image orientation. Indicates the layout of the image area. Allowed values are P (for Portrait), L (for Landscape) and S (for Square).
##### Definition:
```python
@property
def image_orientation(self):
    ...
@image_orientation.setter
def image_orientation(self, value):
    ...
```

### image_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/image_type.md

#### image_type property

Gets or sets the type of the image.

##### Remarks

The first is a numeric character and the second is an alphabetic character.
##### Definition:
```python
@property
def image_type(self):
    ...
@image_type.setter
def image_type(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### language_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/language_identifier.md

#### language_identifier property

Gets or sets the language identifier according to the 2-letter codes of ISO 639:1988.
##### Definition:
```python
@property
def language_identifier(self):
    ...
@language_identifier.setter
def language_identifier(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### model_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/model_version.md

#### model_version property

Gets or sets the binary number identifying the version of the Information
##### Definition:
```python
@property
def model_version(self):
    ...
@model_version.setter
def model_version(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### object_type_reference property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/object_type_reference.md

#### object_type_reference property

Gets or sets the object type reference. The Object Type is used to distinguish between different types of objects within the IIM.
##### Definition:
```python
@property
def object_type_reference(self):
    ...
@object_type_reference.setter
def object_type_reference(self, value):
    ...
```

### originating_program property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/originating_program.md

#### originating_program property

Gets or sets the type of program used to originate the object data.
##### Definition:
```python
@property
def originating_program(self):
    ...
@originating_program.setter
def originating_program(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### product_i_ds property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/product_i_ds.md

#### product_i_ds property

Gets or sets the product identifiers.

##### Remarks

Used to provide receiving organization data on which to select, route, or
otherwise handle data.
##### Definition:
```python
@property
def product_i_ds(self):
    ...
@product_i_ds.setter
def product_i_ds(self, value):
    ...
```

### program_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/program_version.md

#### program_version property

Gets or sets the program version.
##### Definition:
```python
@property
def program_version(self):
    ...
@program_version.setter
def program_version(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### reference_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/reference_date.md

#### reference_date property

Gets or sets the date of a prior envelope to which the current object refers.
##### Definition:
```python
@property
def reference_date(self):
    ...
@reference_date.setter
def reference_date(self, value):
    ...
```

### reference_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/reference_number.md

#### reference_number property

Gets or sets the Envelope Number of a prior envelope to which the current object refers.
##### Definition:
```python
@property
def reference_number(self):
    ...
@reference_number.setter
def reference_number(self, value):
    ...
```

### reference_service property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/reference_service.md

#### reference_service property

Gets or sets the Service Identifier of a prior envelope to which the current object refers.
##### Definition:
```python
@property
def reference_service(self):
    ...
@reference_service.setter
def reference_service(self, value):
    ...
```

### release_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/release_date.md

#### release_date property

Gets or sets the earliest date the provider intends the object to be used.
##### Definition:
```python
@property
def release_date(self):
    ...
@release_date.setter
def release_date(self, value):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### service_identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/service_identifier.md

#### service_identifier property

Gets or sets the service identifier. Identifies the provider and product.
##### Definition:
```python
@property
def service_identifier(self):
    ...
@service_identifier.setter
def service_identifier(self, value):
    ...
```

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### supplemental_categories property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/supplemental_categories.md

#### supplemental_categories property

Gets or sets the supplemental categories.
##### Definition:
```python
@property
def supplemental_categories(self):
    ...
@supplemental_categories.setter
def supplemental_categories(self, value):
    ...
```

### unique_name_of_object property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/unique_name_of_object.md

#### unique_name_of_object property

Gets or sets the unique name of the object.
##### Definition:
```python
@property
def unique_name_of_object(self):
    ...
@unique_name_of_object.setter
def unique_name_of_object(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### urgency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/urgency.md

#### urgency property

Gets or sets the editorial urgency of the content.
##### Definition:
```python
@property
def urgency(self):
    ...
@urgency.setter
def urgency(self, value):
    ...
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpiptciimpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpMediaManagementPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage.md

#### XmpMediaManagementPackage class

Represents the XMP Media Management namespace.

**Inheritance:** `XmpMediaManagementPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpMediaManagementPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpMediaManagementPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| derived_from | Gets or sets the reference to the resource from which this one is derived. |
| document_id | Gets or sets the common identifier for all versions and renditions of the resource. |
| history | Gets or sets an array of high-level actions that resulted in this resource. |
| ingredients | Gets or sets the references to resources that were incorporated, by inclusion or reference, into this resource. |
| instance_id | Gets or sets the identifier for a specific incarnation of a resource, updated each time the file is saved. |
| managed_from | Gets or sets the reference to the document as it was prior to becoming managed. |
| manager | Gets or sets the name of the asset management system that manages this resource. |
| manage_to | Gets or sets the URI identifying the managed resource to the asset management system |
| manage_ui | Gets or sets the URI that can be used to access information about the managed resource through a web browser. |
| manager_variant | Gets or sets the particular variant of the asset management system. |
| original_document_id | Gets or sets the common identifier for the original resource from which the current resource is derived. |
| rendition_class | Gets or sets the rendition class name for this resource. |
| rendition_params | Gets or sets the value that is used to provide additional rendition parameters
<br/>that are too complex or verbose to encode in xmpMM:RenditionClass. |
| version_id | Gets or sets the document version identifier for this resource. |
| versions | Gets or sets the version history associated with this resource. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpMediaManagementPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpMediaManagementPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### derived_from property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/derived_from.md

#### derived_from property

Gets or sets the reference to the resource from which this one is derived.
##### Definition:
```python
@property
def derived_from(self):
    ...
@derived_from.setter
def derived_from(self, value):
    ...
```

### document_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/document_id.md

#### document_id property

Gets or sets the common identifier for all versions and renditions of the resource.
##### Definition:
```python
@property
def document_id(self):
    ...
@document_id.setter
def document_id(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### history property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/history.md

#### history property

Gets or sets an array of high-level actions that resulted in this resource.
##### Definition:
```python
@property
def history(self):
    ...
@history.setter
def history(self, value):
    ...
```

### ingredients property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/ingredients.md

#### ingredients property

Gets or sets the references to resources that were incorporated, by inclusion or reference, into this resource.
##### Definition:
```python
@property
def ingredients(self):
    ...
@ingredients.setter
def ingredients(self, value):
    ...
```

### instance_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/instance_id.md

#### instance_id property

Gets or sets the identifier for a specific incarnation of a resource, updated each time the file is saved.
##### Definition:
```python
@property
def instance_id(self):
    ...
@instance_id.setter
def instance_id(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### manage_to property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manage_to.md

#### manage_to property

Gets or sets the URI identifying the managed resource to the asset management system
##### Definition:
```python
@property
def manage_to(self):
    ...
@manage_to.setter
def manage_to(self, value):
    ...
```

### manage_ui property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manage_ui.md

#### manage_ui property

Gets or sets the URI that can be used to access information about the managed resource through a web browser.
##### Definition:
```python
@property
def manage_ui(self):
    ...
@manage_ui.setter
def manage_ui(self, value):
    ...
```

### managed_from property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/managed_from.md

#### managed_from property

Gets or sets the reference to the document as it was prior to becoming managed.
##### Definition:
```python
@property
def managed_from(self):
    ...
@managed_from.setter
def managed_from(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manager.md

#### manager property

Gets or sets the name of the asset management system that manages this resource.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### manager_variant property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/manager_variant.md

#### manager_variant property

Gets or sets the particular variant of the asset management system.
##### Definition:
```python
@property
def manager_variant(self):
    ...
@manager_variant.setter
def manager_variant(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### original_document_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/original_document_id.md

#### original_document_id property

Gets or sets the common identifier for the original resource from which the current resource is derived.
##### Definition:
```python
@property
def original_document_id(self):
    ...
@original_document_id.setter
def original_document_id(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### rendition_class property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/rendition_class.md

#### rendition_class property

Gets or sets the rendition class name for this resource.
##### Definition:
```python
@property
def rendition_class(self):
    ...
@rendition_class.setter
def rendition_class(self, value):
    ...
```

### rendition_params property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/rendition_params.md

#### rendition_params property

Gets or sets the value that is used to provide additional rendition parameters
that are too complex or verbose to encode in xmpMM:RenditionClass.
##### Definition:
```python
@property
def rendition_params(self):
    ...
@rendition_params.setter
def rendition_params(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/version_id.md

#### version_id property

Gets or sets the document version identifier for this resource.
##### Definition:
```python
@property
def version_id(self):
    ...
@version_id.setter
def version_id(self, value):
    ...
```

### versions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/versions.md

#### versions property

Gets or sets the version history associated with this resource.
##### Definition:
```python
@property
def versions(self):
    ...
@versions.setter
def versions(self, value):
    ...
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpmediamanagementpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpPagedTextPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage.md

#### XmpPagedTextPackage class

Represents the XMP Paged-Text package.

**Inheritance:** `XmpPagedTextPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpPagedTextPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpPagedTextPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| colorants | Gets or sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents). |
| fonts | Gets or sets an unordered array of fonts that are used in the document (including any in contained documents). |
| max_page_size | Gets or sets the size of the largest page in the document (including any in contained documents). |
| number_of_pages | Gets or sets the number of pages in the document. |
| plate_names | Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents). |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpPagedTextPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpPagedTextPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### colorants property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/colorants.md

#### colorants property

Gets or sets an ordered array of colorants (swatches) that are used in the document (including any in contained documents).
##### Definition:
```python
@property
def colorants(self):
    ...
@colorants.setter
def colorants(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### fonts property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/fonts.md

#### fonts property

Gets or sets an unordered array of fonts that are used in the document (including any in contained documents).
##### Definition:
```python
@property
def fonts(self):
    ...
@fonts.setter
def fonts(self, value):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### max_page_size property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/max_page_size.md

#### max_page_size property

Gets or sets the size of the largest page in the document (including any in contained documents).
##### Definition:
```python
@property
def max_page_size(self):
    ...
@max_page_size.setter
def max_page_size(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### number_of_pages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/number_of_pages.md

#### number_of_pages property

Gets or sets the number of pages in the document.
##### Definition:
```python
@property
def number_of_pages(self):
    ...
@number_of_pages.setter
def number_of_pages(self, value):
    ...
```

### plate_names property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/plate_names.md

#### plate_names property

Gets or set an ordered array of plate names that are needed to print the document (including any in contained documents).
##### Definition:
```python
@property
def plate_names(self):
    ...
@plate_names.setter
def plate_names(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppagedtextpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpPdfPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage.md

#### XmpPdfPackage class

Specifies properties used with Adobe PDF documents.

**Inheritance:** `XmpPdfPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpPdfPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpPdfPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| keywords | Gets or sets the keywords. |
| pdf_version | Gets or sets the PDF file version. For example, 1.0, 1.3 and so on. |
| producer | Gets or sets the name of the tool that created the PDF document. |
| is_trapped | Gets or sets a value indicating whether the document has been trapped. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpPdfPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpPdfPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### is_trapped property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/is_trapped.md

#### is_trapped property

Gets or sets a value indicating whether the document has been trapped.
##### Definition:
```python
@property
def is_trapped(self):
    ...
@is_trapped.setter
def is_trapped(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/keywords.md

#### keywords property

Gets or sets the keywords.
##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### pdf_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/pdf_version.md

#### pdf_version property

Gets or sets the PDF file version. For example, 1.0, 1.3 and so on.
##### Definition:
```python
@property
def pdf_version(self):
    ...
@pdf_version.setter
def pdf_version(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### producer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/producer.md

#### producer property

Gets or sets the name of the tool that created the PDF document.
##### Definition:
```python
@property
def producer(self):
    ...
@producer.setter
def producer(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmppdfpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpPhotoshopColorMode enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshopcolormode.md

#### XmpPhotoshopColorMode enumeration

Represents a color mode in `XmpPhotoshopPackage`.

The XmpPhotoshopColorMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BITMAP | The bitmap color mode. |
| GRAY_SCALE | The gray scale color mode. |
| INDEXED_COLOR | The indexed color. |
| RGB | The RGB color mode. |
| CMYK | The CMYK color mode. |
| MULTI_CHANNEL | The multi-channel color mode. |
| DUOTONE | The duo-tone color mode. |
| LAB_COLOR | The LAB color mode. |

### XmpPhotoshopPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage.md

#### XmpPhotoshopPackage class

Represents Adobe Photoshop namespace.

**Inheritance:** `XmpPhotoshopPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpPhotoshopPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpPhotoshopPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| authors_position | Gets or sets the by-line title. |
| caption_writer | Gets or sets the writer/editor. |
| category | Gets or sets the category. Limited to 3 7-bit ASCII characters. |
| city | Gets or sets the city. |
| color_mode | Gets or sets the color mode. |
| country | Gets or sets the country. |
| credit | Gets or sets the credit. |
| date_created | Gets or sets the date the intellectual content of the document was created. |
| headline | Gets or sets the headline. |
| history | Gets or sets the history that appears in the FileInfo panel, if activated in the application preferences. |
| icc_profile | Gets or sets the color profile, such as AppleRGB, AdobeRGB1998. |
| instructions | Gets or sets the special instructions. |
| source | Gets or sets the source. |
| state | Gets or sets the province/state. |
| supplemental_categories | Gets or sets the supplemental categories. |
| transmission_reference | Gets or sets the original transmission reference. |
| urgency | Gets or sets the urgency. |
| URGENCY_MAX | Urgency max value. |
| URGENCY_MIN | Urgency min value. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpPhotoshopPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpPhotoshopPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### authors_position property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/authors_position.md

#### authors_position property

Gets or sets the by-line title.
##### Definition:
```python
@property
def authors_position(self):
    ...
@authors_position.setter
def authors_position(self, value):
    ...
```

### caption_writer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/caption_writer.md

#### caption_writer property

Gets or sets the writer/editor.
##### Definition:
```python
@property
def caption_writer(self):
    ...
@caption_writer.setter
def caption_writer(self, value):
    ...
```

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/category.md

#### category property

Gets or sets the category. Limited to 3 7-bit ASCII characters.
##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### city property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/city.md

#### city property

Gets or sets the city.
##### Definition:
```python
@property
def city(self):
    ...
@city.setter
def city(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### color_mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/color_mode.md

#### color_mode property

Gets or sets the color mode.
##### Definition:
```python
@property
def color_mode(self):
    ...
@color_mode.setter
def color_mode(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### country property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/country.md

#### country property

Gets or sets the country.
##### Definition:
```python
@property
def country(self):
    ...
@country.setter
def country(self, value):
    ...
```

### credit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/credit.md

#### credit property

Gets or sets the credit.
##### Definition:
```python
@property
def credit(self):
    ...
@credit.setter
def credit(self, value):
    ...
```

### date_created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/date_created.md

#### date_created property

Gets or sets the date the intellectual content of the document was created.
##### Definition:
```python
@property
def date_created(self):
    ...
@date_created.setter
def date_created(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### headline property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/headline.md

#### headline property

Gets or sets the headline.
##### Definition:
```python
@property
def headline(self):
    ...
@headline.setter
def headline(self, value):
    ...
```

### history property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/history.md

#### history property

Gets or sets the history that appears in the FileInfo panel, if activated in the application preferences.
##### Definition:
```python
@property
def history(self):
    ...
@history.setter
def history(self, value):
    ...
```

### icc_profile property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/icc_profile.md

#### icc_profile property

Gets or sets the color profile, such as AppleRGB, AdobeRGB1998.
##### Definition:
```python
@property
def icc_profile(self):
    ...
@icc_profile.setter
def icc_profile(self, value):
    ...
```

### instructions property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/instructions.md

#### instructions property

Gets or sets the special instructions.
##### Definition:
```python
@property
def instructions(self):
    ...
@instructions.setter
def instructions(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/source.md

#### source property

Gets or sets the source.
##### Definition:
```python
@property
def source(self):
    ...
@source.setter
def source(self, value):
    ...
```

### state property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/state.md

#### state property

Gets or sets the province/state.
##### Definition:
```python
@property
def state(self):
    ...
@state.setter
def state(self, value):
    ...
```

### supplemental_categories property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/supplemental_categories.md

#### supplemental_categories property

Gets or sets the supplemental categories.
##### Definition:
```python
@property
def supplemental_categories(self):
    ...
@supplemental_categories.setter
def supplemental_categories(self, value):
    ...
```

### transmission_reference property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/transmission_reference.md

#### transmission_reference property

Gets or sets the original transmission reference.
##### Definition:
```python
@property
def transmission_reference(self):
    ...
@transmission_reference.setter
def transmission_reference(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### urgency property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgency.md

#### urgency property

Gets or sets the urgency.

##### Remarks

Valid range is 1-8.
##### Definition:
```python
@property
def urgency(self):
    ...
@urgency.setter
def urgency(self, value):
    ...
```

### URGENCY_MAX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgency_max.md

#### URGENCY_MAX property

Urgency max value.
##### Definition:
```python
f URGENCY_MAX 
```

### URGENCY_MIN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/urgency_min.md

#### URGENCY_MIN property

Urgency min value.
##### Definition:
```python
f URGENCY_MIN 
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpphotoshoppackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpRightsManagementPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage.md

#### XmpRightsManagementPackage class

Represents XMP Rights Management namespace.

**Inheritance:** `XmpRightsManagementPackage` →
`XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpRightsManagementPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpRightsManagementPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |
| certificate | Gets or sets the Web URL for a rights management certificate. |
| marked | Gets or sets a value indicating whether this is a rights-managed resource. |
| owners | Gets or sets the legal owners. |
| usage_terms | Gets or sets the instructions on how the resource can be legally used, given in a variety of languages. |
| web_statement | Gets or sets the Web URL for a statement of the ownership and usage rights for this resource. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

### XmpRightsManagementPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpRightsManagementPackage` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### certificate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/certificate.md

#### certificate property

Gets or sets the Web URL for a rights management certificate.
##### Definition:
```python
@property
def certificate(self):
    ...
@certificate.setter
def certificate(self, value):
    ...
```

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### marked property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/marked.md

#### marked property

Gets or sets a value indicating whether this is a rights-managed resource.
##### Definition:
```python
@property
def marked(self):
    ...
@marked.setter
def marked(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### owners property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/owners.md

#### owners property

Gets or sets the legal owners.
##### Definition:
```python
@property
def owners(self):
    ...
@owners.setter
def owners(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### usage_terms property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/usage_terms.md

#### usage_terms property

Gets or sets the instructions on how the resource can be legally used, given in a variety of languages.
##### Definition:
```python
@property
def usage_terms(self):
    ...
@usage_terms.setter
def usage_terms(self, value):
    ...
```

### web_statement property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/web_statement.md

#### web_statement property

Gets or sets the Web URL for a statement of the ownership and usage rights for this resource.
##### Definition:
```python
@property
def web_statement(self):
    ...
@web_statement.setter
def web_statement(self, value):
    ...
```

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmprightsmanagementpackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpTimeFormat class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat.md

#### XmpTimeFormat class

Represents time format in `XmpTimecode`.

The XmpTimeFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| timecode24 | Gets 24Timecode. |
| timecode25 | Gets 25Timecode. |
| drop_timecode2997 | Gets 2997DropTimecode. |
| non_drop_timecode2997 | Gets 2997NonDropTimecode. |
| timecode30 | Gets 30Timecode. |
| timecode50 | Gets 50Timecode. |
| drop_timecode5994 | Gets 5994DropTimecode. |
| non_drop_timecode5994 | Gets 5994NonDropTimecode. |
| timecode60 | Gets 60Timecode. |
| timecode23976 | Gets 23976Timecode. |

### drop_timecode2997 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/drop_timecode2997.md

#### drop_timecode2997 property

Gets 2997DropTimecode.
##### Definition:
```python
@property
def drop_timecode2997(self):
    ...
```

### drop_timecode5994 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/drop_timecode5994.md

#### drop_timecode5994 property

Gets 5994DropTimecode.
##### Definition:
```python
@property
def drop_timecode5994(self):
    ...
```

### non_drop_timecode2997 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/non_drop_timecode2997.md

#### non_drop_timecode2997 property

Gets 2997NonDropTimecode.
##### Definition:
```python
@property
def non_drop_timecode2997(self):
    ...
```

### non_drop_timecode5994 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/non_drop_timecode5994.md

#### non_drop_timecode5994 property

Gets 5994NonDropTimecode.
##### Definition:
```python
@property
def non_drop_timecode5994(self):
    ...
```

### timecode23976 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode23976.md

#### timecode23976 property

Gets 23976Timecode.
##### Definition:
```python
@property
def timecode23976(self):
    ...
```

### timecode24 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode24.md

#### timecode24 property

Gets 24Timecode.
##### Definition:
```python
@property
def timecode24(self):
    ...
```

### timecode25 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode25.md

#### timecode25 property

Gets 25Timecode.
##### Definition:
```python
@property
def timecode25(self):
    ...
```

### timecode30 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode30.md

#### timecode30 property

Gets 30Timecode.
##### Definition:
```python
@property
def timecode30(self):
    ...
```

### timecode50 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode50.md

#### timecode50 property

Gets 50Timecode.
##### Definition:
```python
@property
def timecode50(self):
    ...
```

### timecode60 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmptimeformat/timecode60.md

#### timecode60 property

Gets 60Timecode.
##### Definition:
```python
@property
def timecode60(self):
    ...
```

### XmpWhiteBalance class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance.md

#### XmpWhiteBalance class

Represents the White Balance setting in `XmpCameraRawPackage`.

The XmpWhiteBalance type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| as_shot | White balance: As Shot. |
| auto | White balance: Auto. |
| cloudy | White balance: Cloudy. |
| custom | White balance: Custom. |
| daylight | White balance: Daylight. |
| flash | White balance: Flash. |
| fluorescent | White balance: Fluorescent. |
| shade | White balance: Shade. |
| tungsten | White balance: Tungsten. |

### as_shot property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/as_shot.md

#### as_shot property

White balance: As Shot.
##### Definition:
```python
@property
def as_shot(self):
    ...
```

### auto property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/auto.md

#### auto property

White balance: Auto.
##### Definition:
```python
@property
def auto(self):
    ...
```

### cloudy property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/cloudy.md

#### cloudy property

White balance: Cloudy.
##### Definition:
```python
@property
def cloudy(self):
    ...
```

### custom property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/custom.md

#### custom property

White balance: Custom.
##### Definition:
```python
@property
def custom(self):
    ...
```

### daylight property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/daylight.md

#### daylight property

White balance: Daylight.
##### Definition:
```python
@property
def daylight(self):
    ...
```

### flash property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/flash.md

#### flash property

White balance: Flash.
##### Definition:
```python
@property
def flash(self):
    ...
```

### fluorescent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/fluorescent.md

#### fluorescent property

White balance: Fluorescent.
##### Definition:
```python
@property
def fluorescent(self):
    ...
```

### shade property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/shade.md

#### shade property

White balance: Shade.
##### Definition:
```python
@property
def shade(self):
    ...
```

### tungsten property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.schemes/xmpwhitebalance/tungsten.md

#### tungsten property

White balance: Tungsten.
##### Definition:
```python
@property
def tungsten(self):
    ...
```

### groupdocs.metadata.standards.xmp
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp.md

The namespace provides functionality for XMP (Extensible Metadata Platform) metadata reading and writing.

##### Classes
| Class | Description |
| :- | :- |
| `IXmp` | Defines base operations intended to work with XMP metadata. |
| `IXmpType` | Base interface for XMP type. |
| `XmpArray` | Represents base abstraction for XMP array. |
| `XmpBoolean` | Represents XMP Boolean basic type. |
| `XmpColorantBase` | A structure containing the characteristics of a colorant (swatch) used in a document. |
| `XmpColorantCmyk` | Represents the CMYK Colorant. |
| `XmpColorantLab` | Represents the LAB Colorant. |
| `XmpColorantRgb` | Represents the RGB Colorant. |
| `XmpComplexType` | Represents base abstraction for XMP Complex value type. |
| `XmpComplexTypeValue` | Represents an XMP value containing a complex type instance. |
| `XmpDate` | Represents Date in XMP packet. |
| `XmpDimensions` | Containing dimensions for a drawn object. |
| `XmpElementBase` | Represents base XMP element that contains attributes. |
| `XmpFont` | A structure containing the characteristics of a font used in a document. |
| `XmpGuid` | Represents XMP global unique identifier. |
| `XmpHeaderPI` | Represents XMP header processing instruction. |
| `XmpInteger` | Represents XMP Integer basic type. |
| `XmpJob` | Represents Job. |
| `XmpLangAlt` | Represents XMP Language Alternative. <br/><br/><br/>
<br/>An alternative array of simple text items. Language alternatives facilitate the selection of a simple text item
<br/>based on a desired language. Each array item shall have an xml:lang qualifier. Each xml:lang value shall be
<br/>unique among the items. |
| `XmpMeta` | Represents xmpmeta. Optional.
<br/>The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF. |
| `XmpMetadataContainer` | Represents a container for XMP metadata properties. |
| `XmpNamespaces` | Contains namespaces used in `XmpPackage` and `XmpComplexType`. |
| `XmpPackage` | Represents base abstraction for XMP package. |
| `XmpPacketWrapper` | Contains serialized XMP package including header and trailer.
<br/>A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element. |
| `XmpRational` | Represents XMP XmpRational. |
| `XmpReal` | Represents XMP Real. |
| `XmpRenditionClass` | Represents XMP RenditionClass. |
| `XmpResourceEvent` | Represents a high-level event that occurred in the processing of a resource. |
| `XmpResourceRef` | Represents a multiple part reference to a resource.  <br/>
<br/>Used to indicate prior versions, originals of renditions, originals for derived documents, and so on. |
| `XmpSchemes` | Provides access to known XMP schemes. |
| `XmpText` | Represents XMP Text basic type. |
| `XmpThumbnail` | Represents a thumbnail image for a file. |
| `XmpTime` | Representation of a time value in seconds. |
| `XmpTimecode` | Represents a timecode value in a video. |
| `XmpTrailerPI` | Represents XMP trailer processing instruction. |
| `XmpValueBase` | Represents base XMP value. |
| `XmpVersion` | Represents a version of a document. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `XmpArrayType` | Represents array type in `XmpArray`. |
| `XmpColorType` | Type of color in `XmpColorantBase`. |
| `XmpColorantColorMode` | Represents color mode in `XmpColorantBase`. |

### IXmp class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/ixmp.md

#### IXmp class

Defines base operations intended to work with XMP metadata.

The IXmp type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| xmp_package | Gets or sets the XMP metadata package. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to extract XMP metadata from a file.

### xmp_package property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/ixmp/xmp_package.md

#### xmp_package property

Gets or sets the XMP metadata package.

##### Remarks

**Learn more** |
|
 |

##### Example

This code sample shows how to remove XMP metadata from a file.
##### Definition:
```python
@property
def xmp_package(self):
    ...
@xmp_package.setter
def xmp_package(self, value):
    ...
```

### IXmpType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/ixmptype.md

#### IXmpType class

Base interface for XMP type.

The IXmpType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/ixmptype/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### XmpArray class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray.md

#### XmpArray class

Represents base abstraction for XMP array.

**Inheritance:** `XmpArray` →
`XmpValueBase` →
`PropertyValue`

The XmpArray type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, array_type, items)` | Initializes a new instance of the `XmpArray` class. |
| `__init__(self, array_type, items)` | Initializes a new instance of the `XmpArray` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| array_type | Gets the type of the XMP array. |

##### Methods
| Method | Description |
| :- | :- |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a string array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form an integer array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a date array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a double array. |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Converts XMP value to the xml representation. |

### XmpArray constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/__init__.md

#### \_\_init\_\_(self, array_type, items)

Initializes a new instance of the `XmpArray` class.

```python

def __init__(self, array_type, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array_type | groupdocs.metadata.standards.xmp.XmpArrayType | Array type. |
| items | list | Array items. |

#### \_\_init\_\_(self, array_type, items)

Initializes a new instance of the `XmpArray` class.

```python

def __init__(self, array_type, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array_type | groupdocs.metadata.standards.xmp.XmpArrayType | Array type. |
| items | list | Array items. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### array_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/array_type.md

#### array_type property

Gets the type of the XMP array.
##### Definition:
```python
@property
def array_type(self):
    ...
@array_type.setter
def array_type(self, value):
    ...
```

### from_address method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/from_address.md

#### from_address(, array, type)

Creates an `XmpArray` instance form a string array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form an integer array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form a date array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form a double array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/get_xmp_representation.md

#### get_xmp_representation(self)

Converts XMP value to the xml representation.

##### Returns

Returns String representation of XMP value.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparray/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### XmpArrayType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmparraytype.md

#### XmpArrayType enumeration

Represents array type in `XmpArray`.

The XmpArrayType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNORDERED | An unordered array. |
| ORDERED | An ordered array. |
| ALTERNATIVE | An alternative array. |

### XmpBoolean class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean.md

#### XmpBoolean class

Represents XMP Boolean basic type.

**Inheritance:** `XmpBoolean` →
`XmpValueBase` →
`PropertyValue`

The XmpBoolean type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, value)` | Initializes a new instance of the `XmpBoolean` class based on boolean value. |
| `__init__(self)` | Initializes a new instance of the `XmpBoolean` class with default value. |
| `__init__(self, value)` | Initializes a new instance of the `XmpBoolean` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpBoolean constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpBoolean` class with default value.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpBoolean` class based on boolean value.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | bool | Boolean value. |

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpBoolean` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpboolean/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpColorantBase class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase.md

#### XmpColorantBase class

A structure containing the characteristics of a colorant (swatch) used in a document.

**Inheritance:** `XmpColorantBase` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpColorantBase type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| mode | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| swatch_name | Gets or sets the name of the swatch. |
| color_type | Gets or sets the type of color. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### color_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/color_type.md

#### color_type property

Gets or sets the type of color.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/mode.md

#### mode property

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
##### Definition:
```python
@property
def mode(self):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### swatch_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/swatch_name.md

#### swatch_name property

Gets or sets the name of the swatch.
##### Definition:
```python
@property
def swatch_name(self):
    ...
@swatch_name.setter
def swatch_name(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantbase/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpColorantCmyk class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk.md

#### XmpColorantCmyk class

Represents the CMYK Colorant.

**Inheritance:** `XmpColorantCmyk` →
`XmpColorantBase` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpColorantCmyk type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpColorantCmyk` class. |
| `__init__(self, cyan, magenta, yellow, black)` | Initializes a new instance of the `XmpColorantCmyk` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| mode | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| swatch_name | Gets or sets the name of the swatch. |
| color_type | Gets or sets the type of color. |
| black | Gets or sets the black component. |
| cyan | Gets or sets the cyan component. |
| magenta | Gets or sets the magenta component. |
| yellow | Gets or sets the yellow component. |
| COLOR_VALUE_MAX | Color max value in CMYK colorant. |
| COLOR_VALUE_MIN | Color min value in CMYK colorant. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpColorantCmyk constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpColorantCmyk` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, cyan, magenta, yellow, black)

Initializes a new instance of the `XmpColorantCmyk` class.

```python

def __init__(self, cyan, magenta, yellow, black):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cyan | float | Cyan component. |
| magenta | float | Magenta component. |
| yellow | float | Yellow component. |
| black | float | Black component. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### black property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/black.md

#### black property

Gets or sets the black component.
##### Definition:
```python
@property
def black(self):
    ...
@black.setter
def black(self, value):
    ...
```

### color_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/color_type.md

#### color_type property

Gets or sets the type of color.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### COLOR_VALUE_MAX property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/color_value_max.md

#### COLOR_VALUE_MAX property

Color max value in CMYK colorant.
##### Definition:
```python
f COLOR_VALUE_MAX 
```

### COLOR_VALUE_MIN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/color_value_min.md

#### COLOR_VALUE_MIN property

Color min value in CMYK colorant.
##### Definition:
```python
f COLOR_VALUE_MIN 
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### cyan property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/cyan.md

#### cyan property

Gets or sets the cyan component.
##### Definition:
```python
@property
def cyan(self):
    ...
@cyan.setter
def cyan(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### magenta property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/magenta.md

#### magenta property

Gets or sets the magenta component.
##### Definition:
```python
@property
def magenta(self):
    ...
@magenta.setter
def magenta(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/mode.md

#### mode property

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
##### Definition:
```python
@property
def mode(self):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### swatch_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/swatch_name.md

#### swatch_name property

Gets or sets the name of the swatch.
##### Definition:
```python
@property
def swatch_name(self):
    ...
@swatch_name.setter
def swatch_name(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### yellow property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcmyk/yellow.md

#### yellow property

Gets or sets the yellow component.
##### Definition:
```python
@property
def yellow(self):
    ...
@yellow.setter
def yellow(self, value):
    ...
```

### XmpColorantColorMode enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantcolormode.md

#### XmpColorantColorMode enumeration

Represents color mode in `XmpColorantBase`.

The XmpColorantColorMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | The color mode is undefined. |
| CMYK | CMYK color mode. |
| RGB | RGB color mode. |
| LAB | LAB color mode. |

### XmpColorantLab class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab.md

#### XmpColorantLab class

Represents the LAB Colorant.

**Inheritance:** `XmpColorantLab` →
`XmpColorantBase` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpColorantLab type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpColorantLab` class. |
| `__init__(self, a, b, l)` | Initializes a new instance of the `XmpColorantLab` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| mode | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| swatch_name | Gets or sets the name of the swatch. |
| color_type | Gets or sets the type of color. |
| a | Gets or sets the A component. |
| b | Gets or sets the B component. |
| l | Gets or sets the L component. |
| MIN_L | Component L min value. |
| MAX_L | Component L max value. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpColorantLab constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpColorantLab` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, a, b, l)

Initializes a new instance of the `XmpColorantLab` class.

```python

def __init__(self, a, b, l):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| a | int | A component. |
| b | int | B component. |
| l | float | L component. |

### a property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/a.md

#### a property

Gets or sets the A component.
##### Definition:
```python
@property
def a(self):
    ...
@a.setter
def a(self, value):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### b property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/b.md

#### b property

Gets or sets the B component.
##### Definition:
```python
@property
def b(self):
    ...
@b.setter
def b(self, value):
    ...
```

### color_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/color_type.md

#### color_type property

Gets or sets the type of color.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### l property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/l.md

#### l property

Gets or sets the L component.
##### Definition:
```python
@property
def l(self):
    ...
@l.setter
def l(self, value):
    ...
```

### MAX_L property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/max_l.md

#### MAX_L property

Component L max value.
##### Definition:
```python
f MAX_L 
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### MIN_L property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/min_l.md

#### MIN_L property

Component L min value.
##### Definition:
```python
f MIN_L 
```

### mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/mode.md

#### mode property

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
##### Definition:
```python
@property
def mode(self):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### swatch_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/swatch_name.md

#### swatch_name property

Gets or sets the name of the swatch.
##### Definition:
```python
@property
def swatch_name(self):
    ...
@swatch_name.setter
def swatch_name(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantlab/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpColorantRgb class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb.md

#### XmpColorantRgb class

Represents the RGB Colorant.

**Inheritance:** `XmpColorantRgb` →
`XmpColorantBase` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpColorantRgb type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpColorantRgb` class. |
| `__init__(self, red, green, blue)` | Initializes a new instance of the `XmpColorantRgb` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| mode | Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB. |
| swatch_name | Gets or sets the name of the swatch. |
| color_type | Gets or sets the type of color. |
| red | Gets or sets the red component. |
| green | Gets or sets the green value. |
| blue | Gets or sets the blue component. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpColorantRgb constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpColorantRgb` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, red, green, blue)

Initializes a new instance of the `XmpColorantRgb` class.

```python

def __init__(self, red, green, blue):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| red | int | Red component. |
| green | int | Green component. |
| blue | int | Blue component. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### blue property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/blue.md

#### blue property

Gets or sets the blue component.
##### Definition:
```python
@property
def blue(self):
    ...
@blue.setter
def blue(self, value):
    ...
```

### color_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/color_type.md

#### color_type property

Gets or sets the type of color.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### green property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/green.md

#### green property

Gets or sets the green value.
##### Definition:
```python
@property
def green(self):
    ...
@green.setter
def green(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### mode property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/mode.md

#### mode property

Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
##### Definition:
```python
@property
def mode(self):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### red property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/red.md

#### red property

Gets or sets the red component.
##### Definition:
```python
@property
def red(self):
    ...
@red.setter
def red(self, value):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### swatch_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/swatch_name.md

#### swatch_name property

Gets or sets the name of the swatch.
##### Definition:
```python
@property
def swatch_name(self):
    ...
@swatch_name.setter
def swatch_name(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolorantrgb/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpColorType enumeration
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcolortype.md

#### XmpColorType enumeration

Type of color in `XmpColorantBase`.

The XmpColorType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PROCESS | The Process color type. |
| SPOT | The Spot color type. |

### XmpComplexType class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype.md

#### XmpComplexType class

Represents base abstraction for XMP Complex value type.

**Inheritance:** `XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpComplexType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

##### Remarks

See more: XMP Specification Part 2, Chapter 1.2.2

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextype/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpComplexTypeValue class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue.md

#### XmpComplexTypeValue class

Represents an XMP value containing a complex type instance.

**Inheritance:** `XmpComplexTypeValue` →
`XmpValueBase` →
`PropertyValue`

The XmpComplexTypeValue type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpcomplextypevalue/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### XmpDate class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate.md

#### XmpDate class

Represents Date in XMP packet.

**Inheritance:** `XmpDate` →
`XmpValueBase` →
`PropertyValue`

The XmpDate type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, date_time)` | Initializes a new instance of the `XmpDate` class. |
| `__init__(self, date_string)` | Initializes a new instance of the `XmpDate` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |
| format | Gets format string for current value. |
| ISO_8601_FORMAT | The ISO 8601 (roundtrip) format string. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

##### Remarks

A date-time value is represented using a subset of the formats as defined in Date and Time Formats:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmTZD
YYYY-MM-DDThh:mm:ssTZD
YYYY-MM-DDThh:mm:ss.sTZD

### XmpDate constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/__init__.md

#### \_\_init\_\_(self, date_time)

Initializes a new instance of the `XmpDate` class.

```python

def __init__(self, date_time):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| date_time | System.DateTime | DateTime value. |

#### \_\_init\_\_(self, date_string)

Initializes a new instance of the `XmpDate` class.

```python

def __init__(self, date_string):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| date_string | System.String | Date in string representation. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | Invalid date format. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/format.md

#### format property

Gets format string for current value.
##### Definition:
```python
@property
def format(self):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### ISO_8601_FORMAT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/iso_8601_format.md

#### ISO_8601_FORMAT property

The ISO 8601 (roundtrip) format string.

##### Remarks

See more: https://en.wikipedia.org/wiki/ISO_8601.
##### Definition:
```python
f ISO_8601_FORMAT 
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdate/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpDimensions class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions.md

#### XmpDimensions class

Containing dimensions for a drawn object.

**Inheritance:** `XmpDimensions` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpDimensions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpDimensions` class. |
| `__init__(self, width, height)` | Initializes a new instance of the `XmpDimensions` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| width | Gets or sets the width. |
| height | Gets or sets the height. |
| units | Gets or sets the units. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpDimensions constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpDimensions` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, width, height)

Initializes a new instance of the `XmpDimensions` class.

```python

def __init__(self, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | float | The width. |
| height | float | The height. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/height.md

#### height property

Gets or sets the height.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### units property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/units.md

#### units property

Gets or sets the units.

##### Example

For example: inch, mm, pixel, pica, point etc.
##### Definition:
```python
@property
def units(self):
    ...
@units.setter
def units(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpdimensions/width.md

#### width property

Gets or sets the width.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### XmpElementBase class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase.md

#### XmpElementBase class

Represents base XMP element that contains attributes.

**Inheritance:** `XmpElementBase` →
`CustomPackage` →
`MetadataPackage`

The XmpElementBase type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_attribute(self, attribute, value)` | Adds the attribute. |
| `clear_attributes(self)` | Removes all attributes. |
| `contains_attribute(self, attribute)` | Determines whether the element contains a specific attribute. |
| `get_attribute(self, attribute)` | Gets the attribute. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_attributes method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/clear_attributes.md

#### clear_attributes(self)

Removes all attributes.

```python

def clear_attributes(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contains_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/contains_attribute.md

#### contains_attribute(self, attribute)

Determines whether the element contains a specific attribute.

##### Returns

true if attribute is exist; otherwise false.

```python

def contains_attribute(self, attribute):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | Attribute name. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/get_attribute.md

#### get_attribute(self, attribute)

Gets the attribute.

##### Returns

The attribute value.

```python

def get_attribute(self, attribute):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | The attribute. |

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/set_attribute.md

#### set_attribute(self, attribute, value)

Adds the attribute.

```python

def set_attribute(self, attribute, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | Attribute key. |
| value | System.String | Attribute value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpelementbase/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpFont class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont.md

#### XmpFont class

A structure containing the characteristics of a font used in a document.

**Inheritance:** `XmpFont` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpFont type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpFont` class. |
| `__init__(self, font_family)` | Initializes a new instance of the `XmpFont` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| child_font_files | Gets or sets the list of file names for the fonts that make up a composite font. |
| is_composite | Gets or sets a value indicating whether whether the font is composite. |
| font_face | Gets or sets the font face name. |
| font_family | Gets or sets the font family name. |
| font_file_name | Gets or sets the font file name (not a complete path). |
| font_name | Gets or sets the PostScript name of the font. |
| font_type | Gets or sets the font type. |
| version | Gets or sets the font version. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpFont constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpFont` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, font_family)

Initializes a new instance of the `XmpFont` class.

```python

def __init__(self, font_family):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family | System.String | Font family. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### child_font_files property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/child_font_files.md

#### child_font_files property

Gets or sets the list of file names for the fonts that make up a composite font.
##### Definition:
```python
@property
def child_font_files(self):
    ...
@child_font_files.setter
def child_font_files(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### font_face property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/font_face.md

#### font_face property

Gets or sets the font face name.
##### Definition:
```python
@property
def font_face(self):
    ...
@font_face.setter
def font_face(self, value):
    ...
```

### font_family property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/font_family.md

#### font_family property

Gets or sets the font family name.
##### Definition:
```python
@property
def font_family(self):
    ...
@font_family.setter
def font_family(self, value):
    ...
```

### font_file_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/font_file_name.md

#### font_file_name property

Gets or sets the font file name (not a complete path).
##### Definition:
```python
@property
def font_file_name(self):
    ...
@font_file_name.setter
def font_file_name(self, value):
    ...
```

### font_name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/font_name.md

#### font_name property

Gets or sets the PostScript name of the font.
##### Definition:
```python
@property
def font_name(self):
    ...
@font_name.setter
def font_name(self, value):
    ...
```

### font_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/font_type.md

#### font_type property

Gets or sets the font type.

##### Remarks

TrueType, Type 1, Open Type, and so on.
##### Definition:
```python
@property
def font_type(self):
    ...
@font_type.setter
def font_type(self, value):
    ...
```

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### is_composite property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/is_composite.md

#### is_composite property

Gets or sets a value indicating whether whether the font is composite.
##### Definition:
```python
@property
def is_composite(self):
    ...
@is_composite.setter
def is_composite(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpfont/version.md

#### version property

Gets or sets the font version.

##### Remarks

/version for Type1 fonts
nameId 5 for Apple True Type and OpenType
/CIDFontVersion for CID fonts
The empty string for bitmap fonts
##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### XmpGuid class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid.md

#### XmpGuid class

Represents XMP global unique identifier.

**Inheritance:** `XmpGuid` →
`XmpValueBase` →
`PropertyValue`

The XmpGuid type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, value)` | Initializes a new instance of the `XmpGuid` class. |
| `__init__(self, value)` | Initializes a new instance of the `XmpGuid` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpGuid constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/__init__.md

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpGuid` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid GUID value. |

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpGuid` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Guid | The unique identifier. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpguid/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpHeaderPI class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpheaderpi.md

#### XmpHeaderPI class

Represents XMP header processing instruction.

The XmpHeaderPI type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpHeaderPI` class. |

##### Properties
| Property | Description |
| :- | :- |
| guid | Represents Header GUID. |

##### Methods
| Method | Description |
| :- | :- |
| `get_xmp_representation(self)` | Converts XMP value to the xml representation. |

### XmpHeaderPI constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpheaderpi/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpHeaderPI` class.

```python

def __init__(self):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpheaderpi/get_xmp_representation.md

#### get_xmp_representation(self)

Converts XMP value to the xml representation.

##### Returns

Returns String representation of XMP value.

```python

def get_xmp_representation(self):
    ...
```

### guid property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpheaderpi/guid.md

#### guid property

Represents Header GUID.

##### Remarks

The text of the header PI contains a GUID, making it unlikely to appear by accident in the data stream.
##### Definition:
```python
@property
def guid(self):
    ...
```

### XmpInteger class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger.md

#### XmpInteger class

Represents XMP Integer basic type.

**Inheritance:** `XmpInteger` →
`XmpValueBase` →
`PropertyValue`

The XmpInteger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, value)` | Initializes a new instance of the `XmpInteger` class. |
| `__init__(self, value)` | Initializes a new instance of the `XmpInteger` class. |
| `__init__(self, value)` | Initializes a new instance of the `XmpInteger` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpInteger constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/__init__.md

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpInteger` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | int | The value. |

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpInteger` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | int | The value. |

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpInteger` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | String value contained integer. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpinteger/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpJob class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob.md

#### XmpJob class

Represents Job.

**Inheritance:** `XmpJob` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpJob type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpJob` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| id | Gets or sets unique id for the job. This field is a reference into some external job management system. |
| name | Gets or sets informal name of the job. This name is for user display and informal systems. |
| url | Gets or sets a file URL referencing an external job management file. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpJob constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpJob` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/id.md

#### id property

Gets or sets unique id for the job. This field is a reference into some external job management system.
##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/name.md

#### name property

Gets or sets informal name of the job. This name is for user display and informal systems.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### url property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpjob/url.md

#### url property

Gets or sets a file URL referencing an external job management file.
##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### XmpLangAlt class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt.md

#### XmpLangAlt class

Represents XMP Language Alternative.

An alternative array of simple text items. Language alternatives facilitate the selection of a simple text item
based on a desired language. Each array item shall have an xml:lang qualifier. Each xml:lang value shall be
unique among the items.

**Inheritance:** `XmpLangAlt` →
`XmpArray` →
`XmpValueBase` →
`PropertyValue`

The XmpLangAlt type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, default_value)` | Initializes a new instance of the `XmpLangAlt` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| array_type | Gets the type of the XMP array. |
| languages | Gets an array of all languages registered in the instance of `XmpLangAlt`. |

##### Methods
| Method | Description |
| :- | :- |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a string array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form an integer array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a date array. |
| `from_address(, array, type)` | Creates an `XmpArray` instance form a double array. |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Converts XMP value to the xml representation. |
| `contains(self, language)` | Determines whether the `XmpLangAlt` contains the specified language. |

### XmpLangAlt constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/__init__.md

#### \_\_init\_\_(self, default_value)

Initializes a new instance of the `XmpLangAlt` class.

```python

def __init__(self, default_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| default_value | System.String | The default value. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### array_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/array_type.md

#### array_type property

Gets the type of the XMP array.
##### Definition:
```python
@property
def array_type(self):
    ...
@array_type.setter
def array_type(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/contains.md

#### contains(self, language)

Determines whether the `XmpLangAlt` contains the specified language.

##### Returns

True if the `XmpLangAlt` contains an element with the specified language; otherwise, false.

```python

def contains(self, language):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| language | System.String | The language to locate in the `XmpLangAlt`. |

### from_address method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/from_address.md

#### from_address(, array, type)

Creates an `XmpArray` instance form a string array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form an integer array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form a date array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

#### from_address(, array, type)

Creates an `XmpArray` instance form a double array.

##### Returns

An `XmpArray` containing all the elements from the original array.

```python

@staticmethod
def from_address(array, type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| array | list | The array to create an `XmpArray` from. |
| type | groupdocs.metadata.standards.xmp.XmpArrayType | The type of the `XmpArray`. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/get_xmp_representation.md

#### get_xmp_representation(self)

Converts XMP value to the xml representation.

##### Returns

Returns String representation of XMP value.

```python

def get_xmp_representation(self):
    ...
```

### languages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/languages.md

#### languages property

Gets an array of all languages registered in the instance of `XmpLangAlt`.
##### Definition:
```python
@property
def languages(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmplangalt/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### XmpMeta class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta.md

#### XmpMeta class

Represents xmpmeta. Optional.
The purpose of this element is to identify XMP metadata within general XML text that might contain other non-XMP uses of RDF.

**Inheritance:** `XmpMeta` →
`XmpElementBase` →
`CustomPackage` →
`MetadataPackage`

The XmpMeta type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpElementBase` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| adobe_xmp_toolkit | Gets Adobe XMP toolkit version. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_attribute(self, attribute, value)` | Adds an attribute. |
| `clear_attributes(self)` | Removes all attributes. |
| `contains_attribute(self, attribute)` | Determines whether the element contains a specific attribute. |
| `get_attribute(self, attribute)` | Gets the attribute. |
| `get_xmp_representation(self)` | Converts XMP value to the xml representation. |

### XmpMeta constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpElementBase` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### adobe_xmp_toolkit property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/adobe_xmp_toolkit.md

#### adobe_xmp_toolkit property

Gets Adobe XMP toolkit version.
##### Definition:
```python
@property
def adobe_xmp_toolkit(self):
    ...
```

### clear_attributes method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/clear_attributes.md

#### clear_attributes(self)

Removes all attributes.

```python

def clear_attributes(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contains_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/contains_attribute.md

#### contains_attribute(self, attribute)

Determines whether the element contains a specific attribute.

##### Returns

true if attribute is exist; otherwise false.

```python

def contains_attribute(self, attribute):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | Attribute name. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/get_attribute.md

#### get_attribute(self, attribute)

Gets the attribute.

##### Returns

The attribute value.

```python

def get_attribute(self, attribute):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | The attribute. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/get_xmp_representation.md

#### get_xmp_representation(self)

Converts XMP value to the xml representation.

##### Returns

Returns String representation of XMP value.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_attribute method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/set_attribute.md

#### set_attribute(self, attribute, value)

Adds an attribute.

```python

def set_attribute(self, attribute, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attribute | System.String | The attribute. |
| value | System.String | The value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmeta/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpMetadataContainer class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer.md

#### XmpMetadataContainer class

Represents a container for XMP metadata properties.

**Inheritance:** `XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpMetadataContainer type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpmetadatacontainer/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpNamespaces class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces.md

#### XmpNamespaces class

Contains namespaces used in `XmpPackage` and `XmpComplexType`.

The XmpNamespaces type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| XML | Xml namespace. |
| RDF | Resource definition framework namespace. |
| BASIC_JOB | Basic Job Ticket namespace. |
| CAMERA_RAW | Camera Raw namespace. |
| DUBLIN_CORE | Dublin Core namespace. |
| IPTC_4_XMP_IIM | IPTC IIM namespace. |
| IPTC_4_XMP_CORE | IPTC Core namespace. |
| IPTC_4_XMP_EXT | IPTC Extension namespace. |
| XMP_BASIC | XMP Basic namespace. |
| XMP_RIGHTS | XMP Rights Management namespace. |
| XMP_MM | XMP digital asset management namespace. |
| XMP_DM | XMP Dynamic Media namespace. |
| PDF | Adobe PDF namespace. |
| PHOTOSHOP | Adobe Photoshop namespace. |
| PAGED_TEXT | XMP Paged-Text namespace. |
| XMP_GRAPHICS | XMP graphics namespace. |
| XMP_GRAPHICS_THUMBNAIL | XMP graphics namespace. |
| XMP_TYPE_FONT | XMP Font type. |
| XMP_TYPE_DIMENSIONS | XMP Dimensions type. |
| XMP_TYPE_RESOURCE_REF | XMP ResourceRef URI. |
| XMP_TYPE_RESOURCE_EVENT | XMP ResourceEvent URI. |
| XMP_TYPE_VERSION | XMP Version. |
| XMP_TYPE_JOB | XMP Job Ticket. |

### BASIC_JOB property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/basic_job.md

#### BASIC_JOB property

Basic Job Ticket namespace.
##### Definition:
```python
f BASIC_JOB 
```

### CAMERA_RAW property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/camera_raw.md

#### CAMERA_RAW property

Camera Raw namespace.
##### Definition:
```python
f CAMERA_RAW 
```

### DUBLIN_CORE property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/dublin_core.md

#### DUBLIN_CORE property

Dublin Core namespace.
##### Definition:
```python
f DUBLIN_CORE 
```

### IPTC_4_XMP_CORE property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc_4_xmp_core.md

#### IPTC_4_XMP_CORE property

IPTC Core namespace.
##### Definition:
```python
f IPTC_4_XMP_CORE 
```

### IPTC_4_XMP_EXT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc_4_xmp_ext.md

#### IPTC_4_XMP_EXT property

IPTC Extension namespace.
##### Definition:
```python
f IPTC_4_XMP_EXT 
```

### IPTC_4_XMP_IIM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/iptc_4_xmp_iim.md

#### IPTC_4_XMP_IIM property

IPTC IIM namespace.
##### Definition:
```python
f IPTC_4_XMP_IIM 
```

### PAGED_TEXT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/paged_text.md

#### PAGED_TEXT property

XMP Paged-Text namespace.
##### Definition:
```python
f PAGED_TEXT 
```

### PDF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/pdf.md

#### PDF property

Adobe PDF namespace.
##### Definition:
```python
f PDF 
```

### PHOTOSHOP property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/photoshop.md

#### PHOTOSHOP property

Adobe Photoshop namespace.
##### Definition:
```python
f PHOTOSHOP 
```

### RDF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/rdf.md

#### RDF property

Resource definition framework namespace.
##### Definition:
```python
f RDF 
```

### XML property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xml.md

#### XML property

Xml namespace.
##### Definition:
```python
f XML 
```

### XMP_BASIC property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_basic.md

#### XMP_BASIC property

XMP Basic namespace.
##### Definition:
```python
f XMP_BASIC 
```

### XMP_DM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_dm.md

#### XMP_DM property

XMP Dynamic Media namespace.
##### Definition:
```python
f XMP_DM 
```

### XMP_GRAPHICS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_graphics.md

#### XMP_GRAPHICS property

XMP graphics namespace.
##### Definition:
```python
f XMP_GRAPHICS 
```

### XMP_GRAPHICS_THUMBNAIL property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_graphics_thumbnail.md

#### XMP_GRAPHICS_THUMBNAIL property

XMP graphics namespace.
##### Definition:
```python
f XMP_GRAPHICS_THUMBNAIL 
```

### XMP_MM property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_mm.md

#### XMP_MM property

XMP digital asset management namespace.
##### Definition:
```python
f XMP_MM 
```

### XMP_RIGHTS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_rights.md

#### XMP_RIGHTS property

XMP Rights Management namespace.
##### Definition:
```python
f XMP_RIGHTS 
```

### XMP_TYPE_DIMENSIONS property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_dimensions.md

#### XMP_TYPE_DIMENSIONS property

XMP Dimensions type.
##### Definition:
```python
f XMP_TYPE_DIMENSIONS 
```

### XMP_TYPE_FONT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_font.md

#### XMP_TYPE_FONT property

XMP Font type.
##### Definition:
```python
f XMP_TYPE_FONT 
```

### XMP_TYPE_JOB property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_job.md

#### XMP_TYPE_JOB property

XMP Job Ticket.
##### Definition:
```python
f XMP_TYPE_JOB 
```

### XMP_TYPE_RESOURCE_EVENT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_resource_event.md

#### XMP_TYPE_RESOURCE_EVENT property

XMP ResourceEvent URI.
##### Definition:
```python
f XMP_TYPE_RESOURCE_EVENT 
```

### XMP_TYPE_RESOURCE_REF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_resource_ref.md

#### XMP_TYPE_RESOURCE_REF property

XMP ResourceRef URI.
##### Definition:
```python
f XMP_TYPE_RESOURCE_REF 
```

### XMP_TYPE_VERSION property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpnamespaces/xmp_type_version.md

#### XMP_TYPE_VERSION property

XMP Version.
##### Definition:
```python
f XMP_TYPE_VERSION 
```

### XmpPackage class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage.md

#### XmpPackage class

Represents base abstraction for XMP package.

**Inheritance:** `XmpPackage` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpPackage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, prefix, namespace_uri)` | Initializes a new instance of the `XmpPackage` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefix | Gets the xmlns prefix. |
| namespace_uri | Gets the namespace URI. |
| xml_namespace | Gets the XML namespace. |

##### Methods
| Method | Description |
| :- | :- |
| `set(self, name, value)` | Sets string property. |
| `set(self, name, value)` | Sets integer property. |
| `set(self, name, value)` | Sets boolean property. |
| `set(self, name, value)` | Sets DateTime property. |
| `set(self, name, value)` | Sets double property. |
| `set(self, name, value)` | Sets the value inherited from `XmpValueBase` . |
| `set(self, name, value)` | Sets the value inherited from `XmpComplexType` . |
| `set(self, name, value)` | Sets the value inherited from `XmpArray` . |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Converts the XMP value to the XML representation. |
| `remove(self, name)` | Removes the property with the specified name. |
| `clear(self)` | Removes all XMP properties. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example demonstrates how to add a custom XMP package to a file of any supported format.

### XmpPackage constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/__init__.md

#### \_\_init\_\_(self, prefix, namespace_uri)

Initializes a new instance of the `XmpPackage` class.

```python

def __init__(self, prefix, namespace_uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | XMP prefix, for example dc:title. |
| namespace_uri | System.String | Namespace uri. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/clear.md

#### clear(self)

Removes all XMP properties.

```python

def clear(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/get_xmp_representation.md

#### get_xmp_representation(self)

Converts the XMP value to the XML representation.

##### Returns

A String representation of the XMP value.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uri property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/namespace_uri.md

#### namespace_uri property

Gets the namespace URI.
##### Definition:
```python
@property
def namespace_uri(self):
    ...
@namespace_uri.setter
def namespace_uri(self, value):
    ...
```

### prefix property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/prefix.md

#### prefix property

Gets the xmlns prefix.
##### Definition:
```python
@property
def prefix(self):
    ...
@prefix.setter
def prefix(self, value):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/remove.md

#### remove(self, name)

Removes the property with the specified name.

##### Returns

True if the specified metadata property is found and removed; otherwise, false.

```python

def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/set.md

#### set(self, name, value)

Sets string property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.String | XMP metadata property value. |

#### set(self, name, value)

Sets integer property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | int | XMP metadata property value. |

#### set(self, name, value)

Sets boolean property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | bool | XMP metadata property value. |

#### set(self, name, value)

Sets DateTime property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | System.DateTime | XMP metadata property value. |

#### set(self, name, value)

Sets double property.

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | float | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpValueBase` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpValueBase | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpComplexType` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpComplexType | XMP metadata property value. |

#### set(self, name, value)

Sets the value inherited from `XmpArray` .

```python

def set(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | XMP metadata property name. |
| value | groupdocs.metadata.standards.xmp.XmpArray | XMP metadata property value. |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### xml_namespace property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppackage/xml_namespace.md

#### xml_namespace property

Gets the XML namespace.
##### Definition:
```python
@property
def xml_namespace(self):
    ...
```

### XmpPacketWrapper class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper.md

#### XmpPacketWrapper class

Contains serialized XMP package including header and trailer.
A wrapper consisting of a pair of XML processing instructions (PIs) may be placed around the rdf:RDF element.

**Inheritance:** `XmpPacketWrapper` →
`MetadataPackage`

The XmpPacketWrapper type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, header, trailer, xmp_meta)` | Initializes a new instance of the `XmpPacketWrapper` class. |
| `__init__(self)` | Initializes a new instance of the `XmpPacketWrapper` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| header_pi | Gets or sets the header processing instruction. |
| meta | Gets or sets the XMP meta. |
| trailer_pi | Gets or sets the trailer processing instruction. |
| packages | Gets array of `XmpPackage` inside XMP. |
| package_count | Gets the number of packages inside the XMP structure. |
| schemes | Provides access to known XMP schemas. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `add_package(self, package)` | Adds the package. |
| `get_package(self, namespace_uri)` | Gets package by namespace uri. |
| `contains_package(self, namespace_uri)` | Determines whether package is exist in XMP wrapper. |
| `remove_package(self, package)` | Removes the specified package. |
| `clear_packages(self)` | Removes all `XmpPackage` inside XMP. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

##### Remarks

**Learn more** |
|
 |

##### Example

This example shows how to update XMP metadata properties.

### XmpPacketWrapper constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpPacketWrapper` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, header, trailer, xmp_meta)

Initializes a new instance of the `XmpPacketWrapper` class.

```python

def __init__(self, header, trailer, xmp_meta):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| header | groupdocs.metadata.standards.xmp.XmpHeaderPI | XMP header processing instruction. |
| trailer | groupdocs.metadata.standards.xmp.XmpTrailerPI | XMP trailer processing instruction. |
| xmp_meta | groupdocs.metadata.standards.xmp.XmpMeta | Instance of `XmpMeta`. |

### add_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/add_package.md

#### add_package(self, package)

Adds the package.

```python

def add_package(self, package):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| package | groupdocs.metadata.standards.xmp.XmpPackage | The package. |

##### Example

This example demonstrates how to add a custom XMP package to a file of any supported format.

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### clear_packages method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/clear_packages.md

#### clear_packages(self)

Removes all `XmpPackage` inside XMP.

```python

def clear_packages(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### contains_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/contains_package.md

#### contains_package(self, namespace_uri)

Determines whether package is exist in XMP wrapper.

##### Returns

`true` if package found by `namespace_uri`; otherwise `false`.

```python

def contains_package(self, namespace_uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| namespace_uri | System.String | Package namespace URI. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Namespace URI could not be null. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/get_package.md

#### get_package(self, namespace_uri)

Gets package by namespace uri.

##### Returns

Appropriate `XmpPackage` if package found by `namespace_uri`; otherwise null.

```python

def get_package(self, namespace_uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| namespace_uri | System.String | Package schema uri. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Namespace URI could not be null. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### header_pi property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/header_pi.md

#### header_pi property

Gets or sets the header processing instruction.
##### Definition:
```python
@property
def header_pi(self):
    ...
@header_pi.setter
def header_pi(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### meta property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/meta.md

#### meta property

Gets or sets the XMP meta.
##### Definition:
```python
@property
def meta(self):
    ...
@meta.setter
def meta(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### package_count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/package_count.md

#### package_count property

Gets the number of packages inside the XMP structure.
##### Definition:
```python
@property
def package_count(self):
    ...
```

### packages property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/packages.md

#### packages property

Gets array of `XmpPackage` inside XMP.
##### Definition:
```python
@property
def packages(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/remove_package.md

#### remove_package(self, package)

Removes the specified package.

```python

def remove_package(self, package):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| package | groupdocs.metadata.standards.xmp.XmpPackage | The package. |

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### schemes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/schemes.md

#### schemes property

Provides access to known XMP schemas.
##### Definition:
```python
@property
def schemes(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### trailer_pi property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/trailer_pi.md

#### trailer_pi property

Gets or sets the trailer processing instruction.
##### Definition:
```python
@property
def trailer_pi(self):
    ...
@trailer_pi.setter
def trailer_pi(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmppacketwrapper/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpRational class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational.md

#### XmpRational class

Represents XMP XmpRational.

**Inheritance:** `XmpRational` →
`XmpValueBase` →
`PropertyValue`

The XmpRational type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, numerator, denominator)` | Initializes a new instance of the `XmpRational` class. |
| `__init__(self, value)` | Initializes a new instance of the `XmpBoolean` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| numerator | Gets numerator. |
| denominator | Gets denominator |
| double_value | Gets value of rational type presented in double format. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpRational constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/__init__.md

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpBoolean` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid string value. |

#### \_\_init\_\_(self, numerator, denominator)

Initializes a new instance of the `XmpRational` class.

```python

def __init__(self, numerator, denominator):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| numerator | int | The numerator. |
| denominator | int | The denominator. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### denominator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/denominator.md

#### denominator property

Gets denominator
##### Definition:
```python
@property
def denominator(self):
    ...
@denominator.setter
def denominator(self, value):
    ...
```

### double_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/double_value.md

#### double_value property

Gets value of rational type presented in double format.
##### Definition:
```python
@property
def double_value(self):
    ...
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### numerator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/numerator.md

#### numerator property

Gets numerator.
##### Definition:
```python
@property
def numerator(self):
    ...
@numerator.setter
def numerator(self, value):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprational/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### XmpReal class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal.md

#### XmpReal class

Represents XMP Real.

**Inheritance:** `XmpReal` →
`XmpValueBase` →
`PropertyValue`

The XmpReal type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, value)` | Initializes a new instance of the `XmpReal` class. |
| `__init__(self, value)` | Initializes a new instance of the `XmpReal` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpReal constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/__init__.md

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpReal` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | float | Double value. |

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpReal` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Value could not be null. |
| ArgumentException | Invalid value. Should be double. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpreal/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpRenditionClass class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass.md

#### XmpRenditionClass class

Represents XMP RenditionClass.

**Inheritance:** `XmpRenditionClass` →
`XmpText` →
`XmpValueBase` →
`PropertyValue`

The XmpRenditionClass type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, tokens)` | Initializes a new instance of the `XmpRenditionClass` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |
| DEFAULT | The master resource; no additional tokens allowed. |
| DRAFT | A review rendition. |
| LOW_RES | A low-resolution, full-size stand-in. |
| PROOF | A review proof. |
| SCREEN | Screen resolution or Web rendition. |
| THUMBNAIL | A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpRenditionClass constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/__init__.md

#### \_\_init\_\_(self, tokens)

Initializes a new instance of the `XmpRenditionClass` class.

```python

def __init__(self, tokens):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tokens | list | The token. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### DEFAULT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/default.md

#### DEFAULT property

The master resource; no additional tokens allowed.
##### Definition:
```python
f DEFAULT 
```

### DRAFT property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/draft.md

#### DRAFT property

A review rendition.
##### Definition:
```python
f DRAFT 
```

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### LOW_RES property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/low_res.md

#### LOW_RES property

A low-resolution, full-size stand-in.
##### Definition:
```python
f LOW_RES 
```

### PROOF property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/proof.md

#### PROOF property

A review proof.
##### Definition:
```python
f PROOF 
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### SCREEN property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/screen.md

#### SCREEN property

Screen resolution or Web rendition.
##### Definition:
```python
f SCREEN 
```

### THUMBNAIL property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/thumbnail.md

#### THUMBNAIL property

A simplified or reduced preview. Additional tokens can provide characteristics. The recommended order is thumbnail:format:size:colorspace.
##### Definition:
```python
f THUMBNAIL 
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmprenditionclass/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpResourceEvent class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent.md

#### XmpResourceEvent class

Represents a high-level event that occurred in the processing of a resource.

**Inheritance:** `XmpResourceEvent` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpResourceEvent type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpResourceEvent` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| action | Gets or sets the action that occurred. |
| changed | Gets or sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history. |
| instance_id | Gets or sets the value of the xmpMM:InstanceID property for the modified (output) resource. |
| parameters | Gets or sets the additional description of the action. |
| software_agent | Gets or sets the software agent that performed the action. |
| when | Gets or sets the timestamp of when the action occurred. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpResourceEvent constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpResourceEvent` class.

```python

def __init__(self):
    ...
```

### action property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/action.md

#### action property

Gets or sets the action that occurred.
##### Definition:
```python
@property
def action(self):
    ...
@action.setter
def action(self, value):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### changed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/changed.md

#### changed property

Gets or sets a semicolon-delimited list of the parts of the resource that were changed since the previous event history.
##### Definition:
```python
@property
def changed(self):
    ...
@changed.setter
def changed(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### instance_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/instance_id.md

#### instance_id property

Gets or sets the value of the xmpMM:InstanceID property for the modified (output) resource.
##### Definition:
```python
@property
def instance_id(self):
    ...
@instance_id.setter
def instance_id(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### parameters property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/parameters.md

#### parameters property

Gets or sets the additional description of the action.
##### Definition:
```python
@property
def parameters(self):
    ...
@parameters.setter
def parameters(self, value):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### software_agent property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/software_agent.md

#### software_agent property

Gets or sets the software agent that performed the action.
##### Definition:
```python
@property
def software_agent(self):
    ...
@software_agent.setter
def software_agent(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### when property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceevent/when.md

#### when property

Gets or sets the timestamp of when the action occurred.
##### Definition:
```python
@property
def when(self):
    ...
@when.setter
def when(self, value):
    ...
```

### XmpResourceRef class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref.md

#### XmpResourceRef class

Represents a multiple part reference to a resource.

Used to indicate prior versions, originals of renditions, originals for derived documents, and so on.

**Inheritance:** `XmpResourceRef` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpResourceRef type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpResourceRef` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| alternate_paths | Gets or sets the referenced resource’s fallback file paths or URLs. |
| document_id | Gets or sets the value of the xmpMM:DocumentID property from the referenced resource. |
| file_path | Gets or sets the referenced resource’s file path or URL. |
| instance_id | Gets or sets the value of the xmpMM:InstanceID property from the referenced resource. |
| last_modify_date | Gets or sets the value of stEvt:when for the last time the file was written. |
| manager | Gets or sets the referenced resource’s xmpMM:Manager. |
| manager_variant | Gets or sets the referenced resource’s xmpMM:Manager. |
| manage_to | Gets or sets the referenced resource’s xmpMM:ManageTo. |
| manage_ui | Gets or sets the referenced resource’s xmpMM:ManageUI. |
| part_mapping | Gets or sets the name or URI of a mapping function used to map the fromPart to the toPart. |
| rendition_class | Gets or sets the value of the xmpMM:RenditionClass property from the referenced resource. |
| rendition_params | Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource. |
| version_id | Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpResourceRef constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpResourceRef` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### alternate_paths property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/alternate_paths.md

#### alternate_paths property

Gets or sets the referenced resource’s fallback file paths or URLs.
##### Definition:
```python
@property
def alternate_paths(self):
    ...
@alternate_paths.setter
def alternate_paths(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### document_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/document_id.md

#### document_id property

Gets or sets the value of the xmpMM:DocumentID property from the referenced resource.
##### Definition:
```python
@property
def document_id(self):
    ...
@document_id.setter
def document_id(self, value):
    ...
```

### file_path property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/file_path.md

#### file_path property

Gets or sets the referenced resource’s file path or URL.
##### Definition:
```python
@property
def file_path(self):
    ...
@file_path.setter
def file_path(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### instance_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/instance_id.md

#### instance_id property

Gets or sets the value of the xmpMM:InstanceID property from the referenced resource.
##### Definition:
```python
@property
def instance_id(self):
    ...
@instance_id.setter
def instance_id(self, value):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### last_modify_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/last_modify_date.md

#### last_modify_date property

Gets or sets the value of stEvt:when for the last time the file was written.
##### Definition:
```python
@property
def last_modify_date(self):
    ...
@last_modify_date.setter
def last_modify_date(self, value):
    ...
```

### manage_to property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/manage_to.md

#### manage_to property

Gets or sets the referenced resource’s xmpMM:ManageTo.
##### Definition:
```python
@property
def manage_to(self):
    ...
@manage_to.setter
def manage_to(self, value):
    ...
```

### manage_ui property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/manage_ui.md

#### manage_ui property

Gets or sets the referenced resource’s xmpMM:ManageUI.
##### Definition:
```python
@property
def manage_ui(self):
    ...
@manage_ui.setter
def manage_ui(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/manager.md

#### manager property

Gets or sets the referenced resource’s xmpMM:Manager.
##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### manager_variant property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/manager_variant.md

#### manager_variant property

Gets or sets the referenced resource’s xmpMM:Manager.
##### Definition:
```python
@property
def manager_variant(self):
    ...
@manager_variant.setter
def manager_variant(self, value):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### part_mapping property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/part_mapping.md

#### part_mapping property

Gets or sets the name or URI of a mapping function used to map the fromPart to the toPart.
##### Definition:
```python
@property
def part_mapping(self):
    ...
@part_mapping.setter
def part_mapping(self, value):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### rendition_class property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/rendition_class.md

#### rendition_class property

Gets or sets the value of the xmpMM:RenditionClass property from the referenced resource.
##### Definition:
```python
@property
def rendition_class(self):
    ...
@rendition_class.setter
def rendition_class(self, value):
    ...
```

### rendition_params property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/rendition_params.md

#### rendition_params property

Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource.
##### Definition:
```python
@property
def rendition_params(self):
    ...
@rendition_params.setter
def rendition_params(self, value):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpresourceref/version_id.md

#### version_id property

Gets or sets the value of the xmpMM:RenditionParams property from the referenced resource.
##### Definition:
```python
@property
def version_id(self):
    ...
@version_id.setter
def version_id(self, value):
    ...
```

### XmpSchemes class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes.md

#### XmpSchemes class

Provides access to known XMP schemes.

The XmpSchemes type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| camera_raw | Gets or sets the Camera Raw scheme. |
| dublin_core | Gets or sets the Dublin Core scheme. |
| paged_text | Gets or sets the PagedText scheme. |
| pdf | Gets or sets the PDF scheme. |
| photoshop | Gets or sets the Photoshop scheme. |
| xmp_basic | Gets or sets the XmpBasic scheme. |
| xmp_dynamic_media | Gets or sets the XmpDynamicMedia scheme. |
| xmp_media_management | Gets or sets the XmpMediaManagement schema. |
| xmp_rights_management | Gets or sets the XmpRightsManagement schema. |
| basic_job_ticket | Gets or sets the BasicJobTicket scheme. |

##### Example

This example demonstrates how to extract XMP metadata from a file.

### basic_job_ticket property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/basic_job_ticket.md

#### basic_job_ticket property

Gets or sets the BasicJobTicket scheme.
##### Definition:
```python
@property
def basic_job_ticket(self):
    ...
@basic_job_ticket.setter
def basic_job_ticket(self, value):
    ...
```

### camera_raw property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/camera_raw.md

#### camera_raw property

Gets or sets the Camera Raw scheme.
##### Definition:
```python
@property
def camera_raw(self):
    ...
@camera_raw.setter
def camera_raw(self, value):
    ...
```

### dublin_core property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/dublin_core.md

#### dublin_core property

Gets or sets the Dublin Core scheme.
##### Definition:
```python
@property
def dublin_core(self):
    ...
@dublin_core.setter
def dublin_core(self, value):
    ...
```

### paged_text property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/paged_text.md

#### paged_text property

Gets or sets the PagedText scheme.
##### Definition:
```python
@property
def paged_text(self):
    ...
@paged_text.setter
def paged_text(self, value):
    ...
```

### pdf property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/pdf.md

#### pdf property

Gets or sets the PDF scheme.
##### Definition:
```python
@property
def pdf(self):
    ...
@pdf.setter
def pdf(self, value):
    ...
```

### photoshop property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/photoshop.md

#### photoshop property

Gets or sets the Photoshop scheme.
##### Definition:
```python
@property
def photoshop(self):
    ...
@photoshop.setter
def photoshop(self, value):
    ...
```

### xmp_basic property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/xmp_basic.md

#### xmp_basic property

Gets or sets the XmpBasic scheme.
##### Definition:
```python
@property
def xmp_basic(self):
    ...
@xmp_basic.setter
def xmp_basic(self, value):
    ...
```

### xmp_dynamic_media property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/xmp_dynamic_media.md

#### xmp_dynamic_media property

Gets or sets the XmpDynamicMedia scheme.
##### Definition:
```python
@property
def xmp_dynamic_media(self):
    ...
@xmp_dynamic_media.setter
def xmp_dynamic_media(self, value):
    ...
```

### xmp_media_management property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/xmp_media_management.md

#### xmp_media_management property

Gets or sets the XmpMediaManagement schema.
##### Definition:
```python
@property
def xmp_media_management(self):
    ...
@xmp_media_management.setter
def xmp_media_management(self, value):
    ...
```

### xmp_rights_management property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpschemes/xmp_rights_management.md

#### xmp_rights_management property

Gets or sets the XmpRightsManagement schema.
##### Definition:
```python
@property
def xmp_rights_management(self):
    ...
@xmp_rights_management.setter
def xmp_rights_management(self, value):
    ...
```

### XmpText class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext.md

#### XmpText class

Represents XMP Text basic type.

**Inheritance:** `XmpText` →
`XmpValueBase` →
`PropertyValue`

The XmpText type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, value)` | Initializes a new instance of the `XmpText` class. |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |
| value | Gets the value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### XmpText constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/__init__.md

#### \_\_init\_\_(self, value)

Initializes a new instance of the `XmpText` class.

```python

def __init__(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptext/value.md

#### value property

Gets the value.
##### Definition:
```python
@property
def value(self):
    ...
```

### XmpThumbnail class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail.md

#### XmpThumbnail class

Represents a thumbnail image for a file.

**Inheritance:** `XmpThumbnail` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpThumbnail type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpThumbnail` class. |
| `__init__(self, width, height)` | Initializes a new instance of the `XmpThumbnail` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| width | Gets or sets the image width in pixels. |
| height | Gets or sets the image height in pixels. |
| image_base64 | Gets or sets the full thumbnail image data, converted to base 64 notation. |
| image_data | Gets the image data. |
| format | Gets or sets the image format. Defined value: JPEG. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpThumbnail constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpThumbnail` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, width, height)

Initializes a new instance of the `XmpThumbnail` class.

```python

def __init__(self, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | int | The width. |
| height | int | The height. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/format.md

#### format property

Gets or sets the image format. Defined value: JPEG.
##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/height.md

#### height property

Gets or sets the image height in pixels.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### image_base64 property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/image_base64.md

#### image_base64 property

Gets or sets the full thumbnail image data, converted to base 64 notation.
##### Definition:
```python
@property
def image_base64(self):
    ...
@image_base64.setter
def image_base64(self, value):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/image_data.md

#### image_data property

Gets the image data.
##### Definition:
```python
@property
def image_data(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### width property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpthumbnail/width.md

#### width property

Gets or sets the image width in pixels.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### XmpTime class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime.md

#### XmpTime class

Representation of a time value in seconds.

**Inheritance:** `XmpTime` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpTime type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpTime` class. |
| `__init__(self, scale, value)` | Initializes a new instance of the `XmpTime` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| scale | Gets or sets the scale for the time value. |
| value | Gets or sets the time value in the specified scale. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpTime constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpTime` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, scale, value)

Initializes a new instance of the `XmpTime` class.

```python

def __init__(self, scale, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| scale | groupdocs.metadata.standards.xmp.XmpRational | The scale. |
| value | int | The value. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### scale property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/scale.md

#### scale property

Gets or sets the scale for the time value.
##### Definition:
```python
@property
def scale(self):
    ...
@scale.setter
def scale(self, value):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptime/value.md

#### value property

Gets or sets the time value in the specified scale.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### XmpTimecode class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode.md

#### XmpTimecode class

Represents a timecode value in a video.

**Inheritance:** `XmpTimecode` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpTimecode type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpTimecode` class. |
| `__init__(self, format, time_value)` | Initializes a new instance of the `XmpTimecode` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| time_format | Gets or sets the format used in the time value. |
| time_value | Gets or sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |
| `set_time_format(self, time_format)` | Sets the time format. |

### XmpTimecode constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpTimecode` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, format, time_value)

Initializes a new instance of the `XmpTimecode` class.

```python

def __init__(self, format, time_value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | groupdocs.metadata.standards.xmp.schemes.XmpTimeFormat | Time format. |
| time_value | System.String | Time value. |

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### set_time_format method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/set_time_format.md

#### set_time_format(self, time_format)

Sets the time format.

```python

def set_time_format(self, time_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| time_format | groupdocs.metadata.standards.xmp.schemes.XmpTimeFormat | The time format. |

### time_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/time_format.md

#### time_format property

Gets or sets the format used in the time value.
##### Definition:
```python
@property
def time_format(self):
    ...
@time_format.setter
def time_format(self, value):
    ...
```

### time_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/time_value.md

#### time_value property

Gets or sets the time value in the specified format. Time values use a colon delimiter in all formats except 2997drop and 5994drop, which uses a semicolon. The four fields indicate hours, minutes, seconds, and frames: hh:mm:ss:ff
##### Definition:
```python
@property
def time_value(self):
    ...
@time_value.setter
def time_value(self, value):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptimecode/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### XmpTrailerPI class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptrailerpi.md

#### XmpTrailerPI class

Represents XMP trailer processing instruction.

The XmpTrailerPI type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, is_writable)` | Initializes a new instance of the `XmpTrailerPI` class. |
| `__init__(self)` | Initializes a new instance of the `XmpTrailerPI` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_writable | Indicates whether form may be modified in-place. |

##### Methods
| Method | Description |
| :- | :- |
| `get_xmp_representation(self)` | Converts XMP value to the xml representation. |

##### Remarks

The end="w" or end="r" portion shall be used by packet scanning processors to determine whether the XMP
may be modified in-place.

##### Example

Allowed forms of the  trailer PI:

### XmpTrailerPI constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptrailerpi/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpTrailerPI` class.

```python

def __init__(self):
    ...
```

#### \_\_init\_\_(self, is_writable)

Initializes a new instance of the `XmpTrailerPI` class.

```python

def __init__(self, is_writable):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| is_writable | bool | Indicates whether trailer is writable. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptrailerpi/get_xmp_representation.md

#### get_xmp_representation(self)

Converts XMP value to the xml representation.

##### Returns

Returns String representation of XMP value.

```python

def get_xmp_representation(self):
    ...
```

### is_writable property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmptrailerpi/is_writable.md

#### is_writable property

Indicates whether form may be modified in-place.
##### Definition:
```python
@property
def is_writable(self):
    ...
```

### XmpValueBase class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpvaluebase.md

#### XmpValueBase class

Represents base XMP value.

**Inheritance:** `XmpValueBase` →
`PropertyValue`

The XmpValueBase type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type | Gets the `MetadataPropertyType`. |
| raw_value | Gets the raw value. |

##### Methods
| Method | Description |
| :- | :- |
| `accept_value(self, value_acceptor)` | Extracts the property value using a custom `ValueAcceptor`. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |

### accept_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpvaluebase/accept_value.md

#### accept_value(self, value_acceptor)

Extracts the property value using a custom `ValueAcceptor`.

```python

def accept_value(self, value_acceptor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_acceptor | groupdocs.metadata.common.ValueAcceptor | An acceptor that extracts the value. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpvaluebase/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### raw_value property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpvaluebase/raw_value.md

#### raw_value property

Gets the raw value.
##### Definition:
```python
@property
def raw_value(self):
    ...
@raw_value.setter
def raw_value(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpvaluebase/type.md

#### type property

Gets the `MetadataPropertyType`.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### XmpVersion class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion.md

#### XmpVersion class

Represents a version of a document.

**Inheritance:** `XmpVersion` →
`XmpComplexType` →
`XmpMetadataContainer` →
`CustomPackage` →
`MetadataPackage`

The XmpVersion type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of the `XmpVersion` class. |

##### Properties
| Property | Description |
| :- | :- |
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| prefixes | Gets the namespace prefixes that are used in the `XmpComplexType` instance. |
| namespace_uris | Gets the namespace URIs that are used in the `XmpComplexType` instance. |
| comments | Gets or sets the comments concerning what was changed. |
| event | Gets or sets the high-level, formal description of what operation the user performed. |
| modifier | Gets or sets the person who modified this version. |
| modify_date | Gets or sets the date on which this version was checked in. |
| version_number | Gets or sets the new version number. |

##### Methods
| Method | Description |
| :- | :- |
| `contains(self, property_name)` | Determines whether the package contains a metadata property with the specified name. |
| `find_properties(self, specification)` | Finds the metadata properties satisfying a specification.
<br/>The search is recursive so it affects all nested packages as well. |
| `update_properties(self, specification, value)` | Updates known metadata properties satisfying a specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `remove_properties(self, specification)` | Removes metadata properties satisfying a specification. |
| `add_properties(self, specification, value)` | Adds known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well. |
| `set_properties(self, specification, value)` | Sets known metadata properties satisfying the specification.
<br/>The operation is recursive so it affects all nested packages as well.
<br/>This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
<br/>If an existing property satisfies the specification its value is updated.
<br/>If there is a known property missing in the package that satisfies the specification it is added to the package. |
| `sanitize(self)` | Removes writable metadata properties from the package.
<br/>The operation is recursive so it affects all nested packages as well. |
| `get_xmp_representation(self)` | Returns string contained value in XMP format. |
| `get_namespace_uri(self, prefix)` | Gets the namespace URI associated with the specified prefix. |

### XmpVersion constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `XmpVersion` class.

```python

def __init__(self):
    ...
```

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/add_properties.md

#### add_properties(self, specification, value)

Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def add_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A value for the picked properties. |

### comments property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/comments.md

#### comments property

Gets or sets the comments concerning what was changed.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### contains method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/contains.md

#### contains(self, property_name)

Determines whether the package contains a metadata property with the specified name.

##### Returns

True if the package contains a property with the specified name; otherwise, false.

```python

def contains(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of the property to locate in the package. |

### count property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/count.md

#### count property

Gets the number of metadata properties.
##### Definition:
```python
@property
def count(self):
    ...
```

### event property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/event.md

#### event property

Gets or sets the high-level, formal description of what operation the user performed.
##### Definition:
```python
@property
def event(self):
    ...
@event.setter
def event(self, value):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/find_properties.md

#### find_properties(self, specification)

Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.

##### Returns

A collection that contains properties from the package that satisfy the condition.

```python

def find_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A function to test each metadata property for a condition. |

### get_namespace_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/get_namespace_uri.md

#### get_namespace_uri(self, prefix)

Gets the namespace URI associated with the specified prefix.

##### Returns

The associated namespace URI if the prefix is registered; otherwise, null.

```python

def get_namespace_uri(self, prefix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| prefix | System.String | The prefix of the namespace to get. |

### get_xmp_representation method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/get_xmp_representation.md

#### get_xmp_representation(self)

Returns string contained value in XMP format.

##### Returns

String contained XMP representation.

```python

def get_xmp_representation(self):
    ...
```

### keys property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/keys.md

#### keys property

Gets a collection of the metadata property names.
##### Definition:
```python
@property
def keys(self):
    ...
```

### metadata_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/metadata_type.md

#### metadata_type property

Gets the metadata type.
##### Definition:
```python
@property
def metadata_type(self):
    ...
@metadata_type.setter
def metadata_type(self, value):
    ...
```

### modifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/modifier.md

#### modifier property

Gets or sets the person who modified this version.
##### Definition:
```python
@property
def modifier(self):
    ...
@modifier.setter
def modifier(self, value):
    ...
```

### modify_date property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/modify_date.md

#### modify_date property

Gets or sets the date on which this version was checked in.
##### Definition:
```python
@property
def modify_date(self):
    ...
@modify_date.setter
def modify_date(self, value):
    ...
```

### namespace_uris property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/namespace_uris.md

#### namespace_uris property

Gets the namespace URIs that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def namespace_uris(self):
    ...
```

### prefixes property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/prefixes.md

#### prefixes property

Gets the namespace prefixes that are used in the `XmpComplexType` instance.
##### Definition:
```python
@property
def prefixes(self):
    ...
```

### property_descriptors property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/property_descriptors.md

#### property_descriptors property

Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
##### Definition:
```python
@property
def property_descriptors(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/remove_properties.md

#### remove_properties(self, specification)

Removes metadata properties satisfying a specification.

##### Returns

The number of affected properties.

```python

def remove_properties(self, specification):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/sanitize.md

#### sanitize(self)

Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def sanitize(self):
    ...
```

##### Remarks

**Learn more** |
|
 |

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/set_properties.md

#### set_properties(self, specification, value)

Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of `MetadataPackage.add_properties` and `MetadataPackage.update_properties`.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.

##### Returns

The number of affected properties.

```python

def set_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to set a property with a value having inappropriate type.

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/update_properties.md

#### update_properties(self, specification, value)

Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.

##### Returns

The number of affected properties.

```python

def update_properties(self, specification, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| specification | groupdocs.metadata.search.Specification | A specification to test each metadata property for a condition. |
| value | groupdocs.metadata.common.PropertyValue | A new value for the filtered properties. |
##### Remarks

Please note that GroupDocs.Metadata implicitly checks the type of each filtered property.
It's impossible to update a property with a value having an inappropriate type.

### version_number property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.xmp/xmpversion/version_number.md

#### version_number property

Gets or sets the new version number.
##### Definition:
```python
@property
def version_number(self):
    ...
@version_number.setter
def version_number(self, value):
    ...
```

### groupdocs.metadata.standards
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.standards.md

### groupdocs.metadata.tagging
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging.md

Types under `groupdocs.metadata.tagging`.

##### Classes
| Class | Description |
| :- | :- |
| `ContentTagCategory` |  |
| `CorporateTagCategory` |  |
| `DocumentTagCategory` |  |
| `LegalTagCategory` |  |
| `OriginTagCategory` |  |
| `PersonTagCategory` |  |
| `PropertyTag` |  |
| `PropertyTypeTagCategory` |  |
| `TagCategory` |  |
| `TimeTagCategory` |  |
| `ToolTagCategory` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `Tags` |  |

### ContentTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory.md

#### ContentTagCategory class

The ContentTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| album |  |
| body |  |
| comment |  |
| description |  |
| file_format |  |
| hyperlinks_changed |  |
| keywords |  |
| language |  |
| rating |  |
| shared_doc |  |
| status |  |
| subject |  |
| table_of_contents |  |
| thumbnail |  |
| title |  |
| type |  |
| version |  |

### album property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/album.md

##### Definition:
```python
@property
def album(self):
    ...
@album.setter
def album(self, value):
    ...
```

### body property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/body.md

##### Definition:
```python
@property
def body(self):
    ...
@body.setter
def body(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/comment.md

##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### description property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/description.md

##### Definition:
```python
@property
def description(self):
    ...
@description.setter
def description(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### hyperlinks_changed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/hyperlinks_changed.md

##### Definition:
```python
@property
def hyperlinks_changed(self):
    ...
@hyperlinks_changed.setter
def hyperlinks_changed(self, value):
    ...
```

### keywords property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/keywords.md

##### Definition:
```python
@property
def keywords(self):
    ...
@keywords.setter
def keywords(self, value):
    ...
```

### language property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/language.md

##### Definition:
```python
@property
def language(self):
    ...
@language.setter
def language(self, value):
    ...
```

### rating property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/rating.md

##### Definition:
```python
@property
def rating(self):
    ...
@rating.setter
def rating(self, value):
    ...
```

### shared_doc property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/shared_doc.md

##### Definition:
```python
@property
def shared_doc(self):
    ...
@shared_doc.setter
def shared_doc(self, value):
    ...
```

### status property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/status.md

##### Definition:
```python
@property
def status(self):
    ...
@status.setter
def status(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/subject.md

##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### table_of_contents property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/table_of_contents.md

##### Definition:
```python
@property
def table_of_contents(self):
    ...
@table_of_contents.setter
def table_of_contents(self, value):
    ...
```

### thumbnail property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/thumbnail.md

##### Definition:
```python
@property
def thumbnail(self):
    ...
@thumbnail.setter
def thumbnail(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/title.md

##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/type.md

##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/contenttagcategory/version.md

##### Definition:
```python
@property
def version(self):
    ...
@version.setter
def version(self, value):
    ...
```

### CorporateTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/corporatetagcategory.md

#### CorporateTagCategory class

The CorporateTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| company |  |
| manager |  |

### company property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/corporatetagcategory/company.md

##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/corporatetagcategory/manager.md

##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### DocumentTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory.md

#### DocumentTagCategory class

The DocumentTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| built_in |  |
| field |  |
| hidden_data |  |
| only_update |  |
| page |  |
| read_only |  |
| revision |  |
| statistic |  |
| user_comment |  |

### built_in property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/built_in.md

##### Definition:
```python
@property
def built_in(self):
    ...
@built_in.setter
def built_in(self, value):
    ...
```

### field property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/field.md

##### Definition:
```python
@property
def field(self):
    ...
@field.setter
def field(self, value):
    ...
```

### hidden_data property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/hidden_data.md

##### Definition:
```python
@property
def hidden_data(self):
    ...
@hidden_data.setter
def hidden_data(self, value):
    ...
```

### only_update property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/only_update.md

##### Definition:
```python
@property
def only_update(self):
    ...
@only_update.setter
def only_update(self, value):
    ...
```

### page property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/page.md

##### Definition:
```python
@property
def page(self):
    ...
@page.setter
def page(self, value):
    ...
```

### read_only property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/read_only.md

##### Definition:
```python
@property
def read_only(self):
    ...
@read_only.setter
def read_only(self, value):
    ...
```

### revision property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/revision.md

##### Definition:
```python
@property
def revision(self):
    ...
@revision.setter
def revision(self, value):
    ...
```

### statistic property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/statistic.md

##### Definition:
```python
@property
def statistic(self):
    ...
@statistic.setter
def statistic(self, value):
    ...
```

### user_comment property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/documenttagcategory/user_comment.md

##### Definition:
```python
@property
def user_comment(self):
    ...
@user_comment.setter
def user_comment(self, value):
    ...
```

### LegalTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/legaltagcategory.md

#### LegalTagCategory class

The LegalTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| copyright |  |
| owner |  |
| usage_terms |  |

### copyright property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/legaltagcategory/copyright.md

##### Definition:
```python
@property
def copyright(self):
    ...
@copyright.setter
def copyright(self, value):
    ...
```

### owner property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/legaltagcategory/owner.md

##### Definition:
```python
@property
def owner(self):
    ...
@owner.setter
def owner(self, value):
    ...
```

### usage_terms property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/legaltagcategory/usage_terms.md

##### Definition:
```python
@property
def usage_terms(self):
    ...
@usage_terms.setter
def usage_terms(self, value):
    ...
```

### OriginTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/origintagcategory.md

#### OriginTagCategory class

The OriginTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| source |  |
| template |  |

### source property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/origintagcategory/source.md

##### Definition:
```python
@property
def source(self):
    ...
@source.setter
def source(self, value):
    ...
```

### template property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/origintagcategory/template.md

##### Definition:
```python
@property
def template(self):
    ...
@template.setter
def template(self, value):
    ...
```

### PersonTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory.md

#### PersonTagCategory class

The PersonTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| artist |  |
| client |  |
| contributor |  |
| creator |  |
| editor |  |
| manager |  |
| model |  |
| publisher |  |
| recipient |  |

### artist property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/artist.md

##### Definition:
```python
@property
def artist(self):
    ...
@artist.setter
def artist(self, value):
    ...
```

### client property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/client.md

##### Definition:
```python
@property
def client(self):
    ...
@client.setter
def client(self, value):
    ...
```

### contributor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/contributor.md

##### Definition:
```python
@property
def contributor(self):
    ...
@contributor.setter
def contributor(self, value):
    ...
```

### creator property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/creator.md

##### Definition:
```python
@property
def creator(self):
    ...
@creator.setter
def creator(self, value):
    ...
```

### editor property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/editor.md

##### Definition:
```python
@property
def editor(self):
    ...
@editor.setter
def editor(self, value):
    ...
```

### manager property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/manager.md

##### Definition:
```python
@property
def manager(self):
    ...
@manager.setter
def manager(self, value):
    ...
```

### model property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/model.md

##### Definition:
```python
@property
def model(self):
    ...
@model.setter
def model(self, value):
    ...
```

### publisher property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/publisher.md

##### Definition:
```python
@property
def publisher(self):
    ...
@publisher.setter
def publisher(self, value):
    ...
```

### recipient property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/persontagcategory/recipient.md

##### Definition:
```python
@property
def recipient(self):
    ...
@recipient.setter
def recipient(self, value):
    ...
```

### PropertyTag class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag.md

#### PropertyTag class

The PropertyTag type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_object |  |
| _equals_property_tag |  |
| _get_hash_code_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_object |  |
| equals_property_tag |  |
| get_hash_code |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| category |  |

### _equals_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_property_tag method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/_equals_property_tag.md

#### _equals_property_tag

```python
def _equals_property_tag(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `PropertyTag` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/_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/metadata/python-net/groupdocs.metadata.tagging/propertytag/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### category property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/category.md

##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_property_tag method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/equals_property_tag.md

#### equals_property_tag

```python
def equals_property_tag(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytag/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### PropertyTypeTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory.md

#### PropertyTypeTagCategory class

The PropertyTypeTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| bitrate |  |
| color |  |
| digital_signature |  |
| font |  |
| hash |  |
| identifier |  |
| link |  |
| location |  |
| measure |  |

### bitrate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/bitrate.md

##### Definition:
```python
@property
def bitrate(self):
    ...
@bitrate.setter
def bitrate(self, value):
    ...
```

### color property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/color.md

##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### digital_signature property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/digital_signature.md

##### Definition:
```python
@property
def digital_signature(self):
    ...
@digital_signature.setter
def digital_signature(self, value):
    ...
```

### font property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/font.md

##### Definition:
```python
@property
def font(self):
    ...
@font.setter
def font(self, value):
    ...
```

### hash property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/hash.md

##### Definition:
```python
@property
def hash(self):
    ...
@hash.setter
def hash(self, value):
    ...
```

### identifier property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/identifier.md

##### Definition:
```python
@property
def identifier(self):
    ...
@identifier.setter
def identifier(self, value):
    ...
```

### link property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/link.md

##### Definition:
```python
@property
def link(self):
    ...
@link.setter
def link(self, value):
    ...
```

### location property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/location.md

##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### measure property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/propertytypetagcategory/measure.md

##### Definition:
```python
@property
def measure(self):
    ...
@measure.setter
def measure(self, value):
    ...
```

### TagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tagcategory.md

#### TagCategory class

The TagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| to_string |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tagcategory/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### to_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tagcategory/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### Tags class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags.md

#### Tags class

The Tags type exposes the following members:

### content property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/content.md

#### content property

Gets the tags that are attached to metadata properties describing the content of a file.
The tags are useful to find out the content language, type (genre), subject, rating, etc.
##### Definition:
```python
@property
def content(self):
    ...
```

### corporate property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/corporate.md

#### corporate property

Gets a set of tags intended to mark metadata properties related to a company that participated in file creation.
##### Definition:
```python
@property
def corporate(self):
    ...
```

### document property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/document.md

#### document property

Gets a set of tags that are applied to document-specific properties only.
The tags can be useful to determine from which part of an office document a property was extracted.
##### Definition:
```python
@property
def document(self):
    ...
```

### legal property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/legal.md

#### legal property

Gets a set of tags that are attached to metadata properties holding information about the owners of the file content
and the rules under which the content can be used.
##### Definition:
```python
@property
def legal(self):
    ...
```

### origin property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/origin.md

#### origin property

Gets the tags that help a user to determine the origin of a file (e.g. template or another source).
##### Definition:
```python
@property
def origin(self):
    ...
```

### person property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/person.md

#### person property

Gets a set of tags that mark metadata properties holding information about the people contributed to file or intellectual content creation.
These tags can help you to find the document creator, editor or even the client for whom the work was performed.
Despite the name of the category some metadata properties marked with the tags can contain a company name rather than a person's name.
##### Definition:
```python
@property
def person(self):
    ...
```

### property_type property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/property_type.md

#### property_type property

Gets a set of tags that bear additional information about the type of a property rather than about its purpose.
Using these tags you can detect metadata properties that contain URL links to external resources,
properties describing fonts, colors, geolocation and so on.
##### Definition:
```python
@property
def property_type(self):
    ...
```

### time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/time.md

#### time property

Gets a set of tags that mark metadata properties used to describe the lifecycle of a file.
The tags deal with time points when a file or intellectual content was created, edited, printed, etc.
##### Definition:
```python
@property
def time(self):
    ...
```

### tool property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tags/tool.md

#### tool property

Gets the tags intended to mark metadata properties related to the tools (software and hardware) that were used to create a file.
##### Definition:
```python
@property
def tool(self):
    ...
```

### TimeTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory.md

#### TimeTagCategory class

The TimeTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| created |  |
| delivery |  |
| duration |  |
| expired |  |
| intellectual_content_created |  |
| modified |  |
| printed |  |
| published |  |
| total_editing_time |  |
| zone_city |  |

### created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/created.md

##### Definition:
```python
@property
def created(self):
    ...
@created.setter
def created(self, value):
    ...
```

### delivery property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/delivery.md

##### Definition:
```python
@property
def delivery(self):
    ...
@delivery.setter
def delivery(self, value):
    ...
```

### duration property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/duration.md

##### Definition:
```python
@property
def duration(self):
    ...
@duration.setter
def duration(self, value):
    ...
```

### expired property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/expired.md

##### Definition:
```python
@property
def expired(self):
    ...
@expired.setter
def expired(self, value):
    ...
```

### intellectual_content_created property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/intellectual_content_created.md

##### Definition:
```python
@property
def intellectual_content_created(self):
    ...
@intellectual_content_created.setter
def intellectual_content_created(self, value):
    ...
```

### modified property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/modified.md

##### Definition:
```python
@property
def modified(self):
    ...
@modified.setter
def modified(self, value):
    ...
```

### printed property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/printed.md

##### Definition:
```python
@property
def printed(self):
    ...
@printed.setter
def printed(self, value):
    ...
```

### published property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/published.md

##### Definition:
```python
@property
def published(self):
    ...
@published.setter
def published(self, value):
    ...
```

### total_editing_time property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/total_editing_time.md

##### Definition:
```python
@property
def total_editing_time(self):
    ...
@total_editing_time.setter
def total_editing_time(self, value):
    ...
```

### zone_city property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/timetagcategory/zone_city.md

##### Definition:
```python
@property
def zone_city(self):
    ...
@zone_city.setter
def zone_city(self, value):
    ...
```

### ToolTagCategory class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory.md

#### ToolTagCategory class

The ToolTagCategory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  (inherited from `TagCategory`) |
| to_string |  (inherited from `TagCategory`) |

##### Properties
| Property | Description |
| :- | :- |
| compression |  |
| hardware |  |
| hardware_manufacturer |  |
| hardware_version |  |
| model_id |  |
| software |  |
| software_manufacturer |  |
| software_version |  |

### compression property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/compression.md

##### Definition:
```python
@property
def compression(self):
    ...
@compression.setter
def compression(self, value):
    ...
```

### hardware property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/hardware.md

##### Definition:
```python
@property
def hardware(self):
    ...
@hardware.setter
def hardware(self, value):
    ...
```

### hardware_manufacturer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/hardware_manufacturer.md

##### Definition:
```python
@property
def hardware_manufacturer(self):
    ...
@hardware_manufacturer.setter
def hardware_manufacturer(self, value):
    ...
```

### hardware_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/hardware_version.md

##### Definition:
```python
@property
def hardware_version(self):
    ...
@hardware_version.setter
def hardware_version(self, value):
    ...
```

### model_id property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/model_id.md

##### Definition:
```python
@property
def model_id(self):
    ...
@model_id.setter
def model_id(self, value):
    ...
```

### software property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/software.md

##### Definition:
```python
@property
def software(self):
    ...
@software.setter
def software(self, value):
    ...
```

### software_manufacturer property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/software_manufacturer.md

##### Definition:
```python
@property
def software_manufacturer(self):
    ...
@software_manufacturer.setter
def software_manufacturer(self, value):
    ...
```

### software_version property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.tagging/tooltagcategory/software_version.md

##### Definition:
```python
@property
def software_version(self):
    ...
@software_version.setter
def software_version(self, value):
    ...
```

### groupdocs.metadata
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata.md

Main GroupDocs.Metadata namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `License` | Manages GroupDocs.Metadata licensing. |
| `Metadata` |  |
| `Metered` | Manages metered (pay-per-use) licensing. |

##### Exceptions
| Exception | Description |
| :- | :- |
| `DocumentProtectedException` |  |
| `GroupDocsMetadataException` |  |
| `InvalidFormatException` |  |
| `MetadataValidationException` |  |
| `XmpException` |  |

### DocumentProtectedException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/documentprotectedexception.md

#### DocumentProtectedException class

The DocumentProtectedException type exposes the following members:

### GroupDocsMetadataException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/groupdocsmetadataexception.md

#### GroupDocsMetadataException class

The GroupDocsMetadataException type exposes the following members:

### InvalidFormatException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/invalidformatexception.md

#### InvalidFormatException class

The InvalidFormatException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/license.md

#### License class

Manages GroupDocs.Metadata 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/metadata/python-net/groupdocs.metadata/license/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of the `License` class.

```python

def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/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. |

### Metadata class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata.md

#### Metadata class

The Metadata type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_properties_func_2_0c75_property_value |  |
| _copy_to_metadata_package |  |
| _copy_to_metadata_package_list_1_0958 |  |
| _dispose_noargs |  |
| _find_properties_func_2_0c75 |  |
| _generate_preview_preview_options |  |
| _get_document_info_noargs |  |
| _get_root_package_noargs |  |
| _init_stream |  |
| _init_stream_load_options |  |
| _init_string |  |
| _init_string_load_options |  |
| _init_uri |  |
| _init_uri_load_options |  |
| _remove_properties_func_2_0c75 |  |
| _sanitize_noargs |  |
| _save_noargs |  |
| _save_stream |  |
| _save_string |  |
| _set_properties_func_2_0c75_property_value |  |
| _update_properties_func_2_0c75_property_value |  |
| add_properties |  |
| add_properties_func |  |
| copy_to |  |
| copy_to_metadata_package |  |
| dispose |  |
| find_properties |  |
| find_properties_func |  |
| generate_preview |  |
| generate_preview_preview_options |  |
| get_document_info |  |
| get_root_package |  |
| remove_properties |  |
| remove_properties_func |  |
| sanitize |  |
| save |  |
| save_file |  |
| save_stream |  |
| save_streams |  |
| save_string |  |
| set_properties |  |
| set_properties_func |  |
| update_properties |  |
| update_properties_func |  |

##### Properties
| Property | Description |
| :- | :- |
| file_format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_add_properties_func_2_0c75_property_value.md

#### _add_properties_func_2_0c75_property_value

```python
def _add_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### _copy_to_metadata_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_copy_to_metadata_package.md

#### _copy_to_metadata_package

```python
def _copy_to_metadata_package(self, metadata):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | `MetadataPackage` |  |

### _copy_to_metadata_package_list_1_0958 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_copy_to_metadata_package_list_1_0958.md

#### _copy_to_metadata_package_list_1_0958

```python
def _copy_to_metadata_package_list_1_0958(self, metadata, tags):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | `MetadataPackage` |  |
| tags | `List[Any]` |  |

**Returns:** int

### _dispose_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _find_properties_func_2_0c75 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_find_properties_func_2_0c75.md

#### _find_properties_func_2_0c75

```python
def _find_properties_func_2_0c75(self, predicate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |

**Returns:** List[Any]

### _generate_preview_preview_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_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/metadata/python-net/groupdocs.metadata/metadata/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### _get_root_package_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_get_root_package_noargs.md

#### _get_root_package_noargs

```python
def _get_root_package_noargs(self):
    ...
```

**Returns:** RootMetadataPackage

### _init_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_init_stream.md

#### _init_stream

```python
def _init_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _init_stream_load_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_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_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_load_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_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_uri method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_init_uri.md

#### _init_uri

```python
def _init_uri(self, uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uri | `Uri` |  |

### _init_uri_load_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_init_uri_load_options.md

#### _init_uri_load_options

```python
def _init_uri_load_options(self, uri, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uri | `Uri` |  |
| load_options | `LoadOptions` |  |

### _remove_properties_func_2_0c75 method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_remove_properties_func_2_0c75.md

#### _remove_properties_func_2_0c75

```python
def _remove_properties_func_2_0c75(self, predicate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |

**Returns:** int

### _sanitize_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_sanitize_noargs.md

#### _sanitize_noargs

```python
def _sanitize_noargs(self):
    ...
```

**Returns:** int

### _save_noargs method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_save_noargs.md

#### _save_noargs

```python
def _save_noargs(self):
    ...
```

### _save_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_save_stream.md

#### _save_stream

```python
def _save_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _save_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_save_string.md

#### _save_string

```python
def _save_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _set_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_set_properties_func_2_0c75_property_value.md

#### _set_properties_func_2_0c75_property_value

```python
def _set_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### _update_properties_func_2_0c75_property_value method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/_update_properties_func_2_0c75_property_value.md

#### _update_properties_func_2_0c75_property_value

```python
def _update_properties_func_2_0c75_property_value(self, predicate, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| predicate | `bool` |  |
| value | `PropertyValue` |  |

**Returns:** int

### add_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/add_properties.md

#### add_properties

```python
def add_properties(self):
    ...
```

### add_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/add_properties_func.md

#### add_properties_func

```python
def add_properties_func(self):
    ...
```

### copy_to method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/copy_to.md

#### copy_to

```python
def copy_to(self):
    ...
```

### copy_to_metadata_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/copy_to_metadata_package.md

#### copy_to_metadata_package

```python
def copy_to_metadata_package(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### find_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/find_properties.md

#### find_properties

```python
def find_properties(self):
    ...
```

### find_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/find_properties_func.md

#### find_properties_func

```python
def find_properties_func(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/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/metadata/python-net/groupdocs.metadata/metadata/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### get_root_package method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/get_root_package.md

#### get_root_package

```python
def get_root_package(self):
    ...
```

### remove_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/remove_properties.md

#### remove_properties

```python
def remove_properties(self):
    ...
```

### remove_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/remove_properties_func.md

#### remove_properties_func

```python
def remove_properties_func(self):
    ...
```

### sanitize method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/sanitize.md

#### sanitize

```python
def sanitize(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/save.md

#### save

```python
def save(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### set_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/set_properties.md

#### set_properties

```python
def set_properties(self):
    ...
```

### set_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/set_properties_func.md

#### set_properties_func

```python
def set_properties_func(self):
    ...
```

### update_properties method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/update_properties.md

#### update_properties

```python
def update_properties(self):
    ...
```

### update_properties_func method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadata/update_properties_func.md

#### update_properties_func

```python
def update_properties_func(self):
    ...
```

### MetadataValidationException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/metadatavalidationexception.md

#### MetadataValidationException class

The MetadataValidationException type exposes the following members:

### Metered class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/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/metadata/python-net/groupdocs.metadata/metered/__init__.md

#### \_\_init\_\_(self)

Constructs a new instance of Metered

```python

def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/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/metadata/python-net/groupdocs.metadata/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/metadata/python-net/groupdocs.metadata/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. |

### XmpException class
Path: https://reference.groupdocs.com/metadata/python-net/groupdocs.metadata/xmpexception.md

#### XmpException class

The XmpException type exposes the following members:


# GroupDocs.Parser

> Extract text, images, metadata, and structured data from documents.

## Java

### GroupDocs.Parser for Java
Path: https://reference.groupdocs.com/parser/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.parser | The package provides classes for parsing data from documents.
 |
| com.groupdocs.parser.data | The package provides classes which represent parsing results.
 |
| com.groupdocs.parser.exceptions | The package provides different exceptions classes.
 |
| com.groupdocs.parser.export | The package provides classes that allow users to export data to different formats.
 |
| com.groupdocs.parser.licensing | The package provides classes to set license or use Metered billing.
 |
| com.groupdocs.parser.options | The package provides classes to specify additional options when parsing data from documents.
 |
| com.groupdocs.parser.templates | The package provides classes for creating templates for parsing document data.
 |

### com.groupdocs.parser.data
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data.md

The package provides classes which represent parsing results.

#### Classes

| Class | Description |
| --- | --- |
| ContainerItem | Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on. |
| DocumentData | Represents data of the document. |
| DocumentPageData | Represents data of the document page. |
| FieldData | Represents field data such as a name, a page index, a field value and so on. |
| HighlightItem | Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality. |
| MetadataItem | Represents a metadata item which is used in container items and metadata extraction functionality. |
| Page | Represents the document page information such as page index and page size. |
| PageArea | Represents an abstract base class for page areas which are used to represent blocks on the document page in the parsing by template functionality. |
| PageBarcodeArea | Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality. |
| PageGroupArea | Represents a group of page areas which is used to group different types of blocks of the document page in the parsing by template functionality. |
| PageHyperlinkArea | Represents a page area which is used to represent a hyperlink on the page. |
| PageImageArea | Represents a page image area which is used to represent an image on the page in the parsing by template functionality or an image attachment if images are extracted from emails or Zip archives. |
| PageTableArea | Represents a table page area which is used to represent a table in the parsing by template functionality. |
| PageTableAreaCell | Represents a table cell which is used in PageTableArea class. |
| PageTextArea | Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality. |
| Point | Represents a point. |
| Rectangle | Represents a rectangular area. |
| SearchResult | Represents the search result in the search functionality. |
| Size | Represents a size. |
| TextReader | Represents a reader that can read a sequential series of characters. |
| TextStyle | Represents the style of the text such as a font name, a font size and so on. |
| TocItem | Represents the item which is used in the table of contents extraction functionality. |

### ContainerItem
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/containeritem.md

**Inheritance:**
java.lang.Object
```
public abstract class ContainerItem
```

Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.

An instance of ContainerItem class is used as return value of Parser.getContainer() method. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata) | Initializes a new instance of ContainerItem with the item name and directory.
 |
| ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata) | Initializes a new instance of ContainerItem with the item full path.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the item.
 |
| getDirectory() | Gets the directory of the item.
 |
| getFilePath() | Gets the full path of the item.
 |
| getSize() | Gets the size of the item.
 |
| getMetadata() | Gets the collection of metadata items.
 |
| getMetadataValue(String name) | Gets the metadata value.
 |
| openStream() | Opens the stream of the item content.
 |
| openParser() | Creates the Parser object for the item content.
 |
| openParser(LoadOptions loadOptions) | Creates the Parser object for the item content with LoadOptions.
 |
| openParser(LoadOptions loadOptions, ParserSettings parserSettings) | Creates the Parser object for the item content with LoadOptions and ParserSettings.
 |
| detectFileType(FileTypeDetectionMode detectionMode) | Detects a file type of the container item.
 |
##### ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata)
```
public ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata)
```

Initializes a new instance of ContainerItem with the item name and directory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the item.
 |
| directory | java.lang.String | The directory of the item.
 |
| size | long | The size of the item.
 |
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items.
 |

##### ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata)
```
public ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata)
```

Initializes a new instance of ContainerItem with the item full path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The full path of the item.
 |
| size | long | The size of the item.
 |
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items.
 |

##### getName()
```
public String getName()
```

Gets the name of the item.

**Returns:**
java.lang.String - A string value that represents the file name of the item (without a directory).

##### getDirectory()
```
public String getDirectory()
```

Gets the directory of the item.

**Returns:**
java.lang.String - A string value that represents the directory of the item (without a file name).

##### getFilePath()
```
public String getFilePath()
```

Gets the full path of the item.

**Returns:**
java.lang.String - A string value that represents the full path of the item.

##### getSize()
```
public long getSize()
```

Gets the size of the item.

**Returns:**
long - An integer value that represents the size of the item in bytes.

##### getMetadata()
```
public Iterable<MetadataItem> getMetadata()
```

Gets the collection of metadata items.

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> - A collection of MetadataItem objects; empty if metadata isn't set.

##### getMetadataValue(String name)
```
public String getMetadataValue(String name)
```

Gets the metadata value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the metadata.
 |

**Returns:**
java.lang.String - A string value that represents the value of the metadata item;  null  if the metadata with this name isn't found.

##### openStream()
```
public abstract InputStream openStream()
```

Opens the stream of the item content.

**Returns:**
java.io.InputStream - A stream with the item content.

##### openParser()
```
public Parser openParser()
```

Creates the Parser object for the item content.

**Returns:**
Parser - An instance of Parser class of the item content.

##### openParser(LoadOptions loadOptions)
```
public Parser openParser(LoadOptions loadOptions)
```

Creates the Parser object for the item content with LoadOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | The options to open the item content.
 |

**Returns:**
Parser - An instance of Parser class of the item content.

##### openParser(LoadOptions loadOptions, ParserSettings parserSettings)
```
public abstract Parser openParser(LoadOptions loadOptions, ParserSettings parserSettings)
```

Creates the Parser object for the item content with LoadOptions and ParserSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | The options to open the item content.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

**Returns:**
Parser - An instance of Parser class of the item content.

##### detectFileType(FileTypeDetectionMode detectionMode)
```
public abstract FileType detectFileType(FileTypeDetectionMode detectionMode)
```

Detects a file type of the container item.

detectionMode
 parameter provides the ability to control file type detection:

* **Default**. The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.
* **Extension**.The file type is detected only by the file extension.
* **Content**. The file type is detected only by the file content.

The following example shows how to detect file type of container item:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(filePath)) {
     // Extract attachments from the container
     Iterable attachments = parser.getContainer();
     // Check if container extraction is supported
     if (attachments == null) {
         System.out.println("Container extraction isn't supported");
     }
     // Iterate over attachments
     for (ContainerItem item : attachments) {
         // Detect the file type
         FileType fileType = item.detectFileType(FileTypeDetectionMode.Default);
         // Print the name and file type
         System.out.println(String.format("%s: %s", item.getName(), fileType));
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| detectionMode | FileTypeDetectionMode | Defines a mode of the file type detection.
 |

**Returns:**
FileType - An instance of FileType class; FileType.Unknown if a file type isn't detected.

### DocumentData
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/documentdata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class DocumentData implements Iterable<FieldData>
```

Represents data of the document. It consists of FieldData objects which contain field data from document. An instance of DocumentData class is used as return value of Parser.parseByTemplate(Template) and Parser.parseForm() methods. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentData(Iterable<FieldData> fields) | Initializes a new instance of the FieldData class.
 |
| DocumentData(Template template, Iterable<FieldData> fields) | Initializes a new instance of the DocumentData class with the source template.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTemplate() | Gets the template that produced this document data.
 |
| getCount() | Gets the total number of the fields data.
 |
| get(int index) | Gets the field data by an index.
 |
| getFieldsByName(String fieldName) | Returns the collection of field data where the name is equal to  fieldName .
 |
| iterator() | Returns an iterator over the elements in this list in proper sequence.
 |
##### DocumentData(Iterable<FieldData> fields)
```
public DocumentData(Iterable<FieldData> fields)
```

Initializes a new instance of the FieldData class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fields | java.lang.Iterable<com.groupdocs.parser.data.FieldData> | The collection of fields data.
 |

##### DocumentData(Template template, Iterable<FieldData> fields)
```
public DocumentData(Template template, Iterable<FieldData> fields)
```

Initializes a new instance of the DocumentData class with the source template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template that produced these fields. May be  null  when the data was not produced by a template (e.g.  parseForm ).
 |
| fields | java.lang.Iterable<com.groupdocs.parser.data.FieldData> | The collection of fields data.
 |

##### getTemplate()
```
public Template getTemplate()
```

Gets the template that produced this document data.

When the data was produced by an automatic template-collection selection (see
Parser.parseByTemplate(com.groupdocs.parser.templates.TemplateCollection, com.groupdocs.parser.options.ParseByTemplateOptions)),
this is the selected template.
null
 when the data was not produced by a template.

**Returns:**
Template - The source Template, or  null .

##### getCount()
```
public int getCount()
```

Gets the total number of the fields data.

**Returns:**
int - An integer value that represents the total number of the fields data.

##### get(int index)
```
public FieldData get(int index)
```

Gets the field data by an index.

Iteration via all the fields:

````
// Print all extracted data
 for (int i = 0; i < data.getCount(); i++) {
     // Print field name
     System.out.print(data.get(i).getName() + ": ");
     // As we have defined only text fields in the template,
     // we cast PageArea property value to PageTextArea
     PageTextArea area = data.get(i).getPageArea() instanceof PageTextArea
             ? (PageTextArea) data.get(i).getPageArea()
             : null;
     System.out.println(area == null ? "Not a template field" : area.getText());
 }
 
````

FieldData class represents field data. Depending on the field PageArea property can contain any
of the inheritors of PageArea class. For example, Parser.parseForm() method extracts only text fields:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleFormsPdf)) {
     // Extract data from PDF document
     DocumentData data = parser.parseForm();
     // Check if form extraction is supported
     if (data == null) {
         System.out.println("Form extraction isn't supported.");
         return;
     }
     // Iterate over extracted data
     for (int i = 0; i < data.getCount(); i++) {
         System.out.print(data.get(i).getName() + ": ");
         PageTextArea area = data.get(i).getPageArea() instanceof PageTextArea
                 ? (PageTextArea) data.get(i).getPageArea()
                 : null;
         System.out.println(area == null ? "Not a template field" : area.getText());
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the field.
 |

**Returns:**
FieldData - An instance of FieldData class.

##### getFieldsByName(String fieldName)
```
public List<FieldData> getFieldsByName(String fieldName)
```

Returns the collection of field data where the name is equal to  fieldName .

Find fields by a field name:

````
// Print prices
 System.out.println("Prices:");
 for (FieldData field : data.getFieldsByName("Price")) {
     PageTextArea area = field.getPageArea() instanceof PageTextArea
             ? (PageTextArea) field.getPageArea()
             : null;
     System.out.println(area == null ? "Not a template field" : area.getText());
 }
 
````

FieldData class represents field data. Depending on the field PageArea property can contain
any of the inheritors of PageArea class. For example, Parser.parseForm() method extracts only text fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldName | java.lang.String | The name of the field.
 |

**Returns:**
java.util.List<com.groupdocs.parser.data.FieldData> - A collection of FieldData objects; empty collection if no field data is found.

##### iterator()
```
public Iterator<FieldData> iterator()
```

Returns an iterator over the elements in this list in proper sequence.

**Returns:**
java.util.Iterator<com.groupdocs.parser.data.FieldData> - an iterator over the elements in this list in proper sequence.

### DocumentPageData
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/documentpagedata.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.DocumentData
```
public class DocumentPageData extends DocumentData
```

Represents data of the document page. It consists of FieldData objects which contain field data from the document page.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentPageData(Iterable<FieldData> fields, int pageIndex) | Initializes a new instance of the DocumentPageData class.
 |
| DocumentPageData(Template template, Iterable<FieldData> fields, int pageIndex) | Initializes a new instance of the DocumentPageData class with the source template.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageIndex() | Gets the page index.
 |
##### DocumentPageData(Iterable<FieldData> fields, int pageIndex)
```
public DocumentPageData(Iterable<FieldData> fields, int pageIndex)
```

Initializes a new instance of the DocumentPageData class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fields | java.lang.Iterable<com.groupdocs.parser.data.FieldData> | The collection of fields data.
 |
| pageIndex | int | The zero-based page index.
 |

##### DocumentPageData(Template template, Iterable<FieldData> fields, int pageIndex)
```
public DocumentPageData(Template template, Iterable<FieldData> fields, int pageIndex)
```

Initializes a new instance of the DocumentPageData class with the source template.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template that produced these fields. May be  null .
 |
| fields | java.lang.Iterable<com.groupdocs.parser.data.FieldData> | The collection of fields data.
 |
| pageIndex | int | The zero-based page index.
 |

##### getPageIndex()
```
public int getPageIndex()
```

Gets the page index.

**Returns:**
int - A zero-based index of the page.

### FieldData
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/fielddata.md

**Inheritance:**
java.lang.Object
```
public class FieldData
```

Represents field data such as a name, a page index, a field value and so on. Depending on the field the value can be a text, an image, a table and so on.

The instances of FieldData class are used in DocumentData collection.

#### Constructors

| Constructor | Description |
| --- | --- |
| FieldData(String name, PageArea pageArea) | Initializes a new instance of the FieldData class with UPPER CASE name.
 |
| FieldData(String name, PageArea pageArea, boolean useUpperCaseName) | Initializes a new instance of the FieldData class.
 |
| FieldData(String name, PageArea pageArea, FieldData linkedField) | Initializes a new instance of the FieldData class with UPPER CASE name.
 |
| FieldData(String name, PageArea pageArea, FieldData linkedField, boolean useUpperCaseName) | Initializes a new instance of the FieldData class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the field name.
 |
| getPageIndex() | Gets the page index.
 |
| getPageArea() | Gets the value of the field.
 |
| getLinkedField() | Gets the linked field.
 |
| getText() | Gets the text.
 |
| getUseUpperCaseName() | Gets a value that indicates whether a  Name  was converted to UPPER CASE.
 |
##### FieldData(String name, PageArea pageArea)
```
public FieldData(String name, PageArea pageArea)
```

Initializes a new instance of the FieldData class with UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the field.
 |
| pageArea | PageArea | The value of the field.
 |

##### FieldData(String name, PageArea pageArea, boolean useUpperCaseName)
```
public FieldData(String name, PageArea pageArea, boolean useUpperCaseName)
```

Initializes a new instance of the FieldData class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the field.
 |
| pageArea | PageArea | The value of the field.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### FieldData(String name, PageArea pageArea, FieldData linkedField)
```
public FieldData(String name, PageArea pageArea, FieldData linkedField)
```

Initializes a new instance of the FieldData class with UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the field.
 |
| pageArea | PageArea | The value of the field.
 |
| linkedField | FieldData | The field which is linked to the field.
 |

##### FieldData(String name, PageArea pageArea, FieldData linkedField, boolean useUpperCaseName)
```
public FieldData(String name, PageArea pageArea, FieldData linkedField, boolean useUpperCaseName)
```

Initializes a new instance of the FieldData class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the field.
 |
| pageArea | PageArea | The value of the field.
 |
| linkedField | FieldData | The field which is linked to the field.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### getName()
```
public String getName()
```

Gets the field name.

**Returns:**
java.lang.String - An uppercase string value that represents the name of the field.

##### getPageIndex()
```
public int getPageIndex()
```

Gets the page index.

**Returns:**
int - A zero-based index of the page that contains the field.

##### getPageArea()
```
public PageArea getPageArea()
```

Gets the value of the field.

Depending on field PageArea property can contain any of the inheritors of PageArea class.
For example, Parser.parseForm() method extracts only text fields.

````
PageTextArea area = field.getPageArea() instanceof PageTextArea
         ? (PageTextArea) field.getPageArea()
         : null;
 System.out.println(area == null ? "Not a template field" : area.getText());
 
````

**Returns:**
PageArea - An instance of PageArea class that represents the value of the field.

##### getLinkedField()
```
public FieldData getLinkedField()
```

Gets the linked field.

**Returns:**
FieldData - An instance of FieldData class that represents the field which is linked to the field;  null  if it isn't set.

##### getText()
```
public String getText()
```

Gets the text.

**Returns:**
java.lang.String - A string value that represents a value of the field text;  null  if PageArea property isn't PageTextArea.

##### getUseUpperCaseName()
```
public boolean getUseUpperCaseName()
```

Gets a value that indicates whether a  Name  was converted to UPPER CASE.

**Returns:**
boolean - A boolean value that indicates whether a  Name  was converted to UPPER CASE.

### HighlightItem
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/highlightitem.md

**Inheritance:**
java.lang.Object
```
public class HighlightItem
```

Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality.

An instance of HighlightItem class is used as return value of Parser.getHighlight(int, boolean, com.groupdocs.parser.options.HighlightOptions) method,
SearchResult.getLeftHighlightItem() and SearchResult.getRightHighlightItem() properties. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| HighlightItem(int position, String text) | Initializes a new instance of the HighlightItem class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPosition() | Gets the position in the document text.
 |
| getText() | Gets the text of the highlight.
 |
##### HighlightItem(int position, String text)
```
public HighlightItem(int position, String text)
```

Initializes a new instance of the HighlightItem class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | int | The position in the document text.
 |
| text | java.lang.String | The text of the highlight.
 |

##### getPosition()
```
public int getPosition()
```

Gets the position in the document text.

**Returns:**
int - A zero-based index of the start position of the highlight.

##### getText()
```
public String getText()
```

Gets the text of the highlight.

**Returns:**
java.lang.String - A string value that represents the text of the highlight.

### MetadataItem
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/metadataitem.md

**Inheritance:**
java.lang.Object
```
public class MetadataItem
```

Represents a metadata item which is used in container items and metadata extraction functionality.

An instance of MetadataItem class is used as return value of Parser.getMetadata() method
and as a item in ContainerItem.getMetadata() collection. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataItem(String name, String value) | Initializes a new instance of the MetadataItem class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the metadata item.
 |
| getValue() | Gets the value of the metadata item.
 |
##### MetadataItem(String name, String value)
```
public MetadataItem(String name, String value)
```

Initializes a new instance of the MetadataItem class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the metadata item.
 |
| value | java.lang.String | The value of the metadata item.
 |

##### getName()
```
public String getName()
```

Gets the name of the metadata item.

**Returns:**
java.lang.String - A string value that represents the name of the metadata item.

##### getValue()
```
public String getValue()
```

Gets the value of the metadata item.

**Returns:**
java.lang.String - A string value that represents the value of the metadata item.

### Page
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/page.md

**Inheritance:**
java.lang.Object
```
public class Page
```

Represents the document page information such as page index and page size. It's used to represent the page that contains inheritors of PageArea class in the parsing by template functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| Page(int index, Size size) | Initializes a new instance of the Page class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getIndex() | Gets the page index.
 |
| getSize() | Gets the page size.
 |
##### Page(int index, Size size)
```
public Page(int index, Size size)
```

Initializes a new instance of the Page class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The page index.
 |
| size | Size | The page size.
 |

##### getIndex()
```
public int getIndex()
```

Gets the page index.

**Returns:**
int - A zero-based index of the page.

##### getSize()
```
public Size getSize()
```

Gets the page size.

**Returns:**
Size - An instance of Size class that represents the size of the page.

### PageArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagearea.md

**Inheritance:**
java.lang.Object
```
public abstract class PageArea
```

Represents an abstract base class for page areas which are used to represent blocks on the document page in the parsing by template functionality.

#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area.
 |
| getPage() | Gets the document page information such as page index and page size.
 |
##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area of the page that contains the page area.

##### getPage()
```
public Page getPage()
```

Gets the document page information such as page index and page size.

**Returns:**
Page - An instance of Page class that represents the page that contains the page area.

### PageBarcodeArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagebarcodearea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageBarcodeArea extends PageArea
```

Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageBarcodeArea(String value, String codeTypeName, int confidence, double angle, Page page, Rectangle rectangle) | Initializes a new instance of the PageBarcodeArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getValue() | Gets the barcode value.
 |
| getCodeTypeName() | Gets the name of the barcode type.
 |
| getConfidence() | Gets the level of confidence of the parsed barcode.
 |
| getAngle() | Gets the angle of the barcode.
 |
##### PageBarcodeArea(String value, String codeTypeName, int confidence, double angle, Page page, Rectangle rectangle)
```
public PageBarcodeArea(String value, String codeTypeName, int confidence, double angle, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageBarcodeArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The value of the barcode.
 |
| codeTypeName | java.lang.String | The type name of the barcode.
 |
| confidence | int | The level of confidence of the parsered barcode.
 |
| angle | double | The angle of the barcode.
 |
| page | Page | The page that contains the barcode area.
 |
| rectangle | Rectangle | The rectangular area that contains the barcode area.
 |

##### getValue()
```
public String getValue()
```

Gets the barcode value.

**Returns:**
java.lang.String - A string value that represents a value of the barcode page area.

##### getCodeTypeName()
```
public String getCodeTypeName()
```

Gets the name of the barcode type.

**Returns:**
java.lang.String - A string value than represents a type name of the barcode.

##### getConfidence()
```
public int getConfidence()
```

Gets the level of confidence of the parsed barcode.

**Returns:**
int - An integer value that represents the confidence of the parsed barcode (0-100).

##### getAngle()
```
public double getAngle()
```

Gets the angle of the barcode.

**Returns:**
double - An integer value that represents the angle of the barcode (0-360).

### PageGroupArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagegrouparea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageGroupArea extends PageArea
```

Represents a group of page areas which is used to group different types of blocks of the document page in the parsing by template functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageGroupArea(Iterable<PageArea> areas, Page page) | Initializes a new instance of the PageGroupArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAreas() | Gets the collection of grouped page areas.
 |
##### PageGroupArea(Iterable<PageArea> areas, Page page)
```
public PageGroupArea(Iterable<PageArea> areas, Page page)
```

Initializes a new instance of the PageGroupArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| areas | java.lang.Iterable<com.groupdocs.parser.data.PageArea> | The collection of page areas to be grouped.
 |
| page | Page | The page that contains the area.
 |

##### getAreas()
```
public Iterable<PageArea> getAreas()
```

Gets the collection of grouped page areas.

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageArea> - A collection of PageArea objects.

### PageHyperlinkArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagehyperlinkarea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageHyperlinkArea extends PageArea
```

Represents a page area which is used to represent a hyperlink on the page.

An instance of PageHyperlinkArea class is used as return value of the following methods:

* Parser.getHyperlinks()
* Parser.getHyperlinks(PageAreaOptions)
* Parser.getHyperlinks(int)
* Parser.getHyperlinks(int, PageAreaOptions)

See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageHyperlinkArea(String text, String url, Page page, Rectangle rectangle) | Initializes a new instance of the PageHyperlinkArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the hyperlink text.
 |
| getUrl() | Gets the hyperlink URL.
 |
##### PageHyperlinkArea(String text, String url, Page page, Rectangle rectangle)
```
public PageHyperlinkArea(String text, String url, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageHyperlinkArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The hyperlink text.
 |
| url | java.lang.String | The hyperlink URL.
 |
| page | Page | The page that contains the hyperlink.
 |
| rectangle | Rectangle | The rectangular area that contains the hyperlink.
 |

##### getText()
```
public String getText()
```

Gets the hyperlink text.

**Returns:**
java.lang.String - A string value that represents hyperlink text.

##### getUrl()
```
public String getUrl()
```

Gets the hyperlink URL.

**Returns:**
java.lang.String - A string value that represents hyperlink URL.

### PageImageArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pageimagearea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageImageArea extends PageArea
```

Represents a page image area which is used to represent an image on the page in the parsing by template functionality or an image attachment if images are extracted from emails or Zip archives.

An instance of PageImageArea class is used as return value of the following methods:

* Parser.getImages()
* Parser.getImages(PageAreaOptions)
* Parser.getImages(int)
* Parser.getImages(int, PageAreaOptions)

See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageImageArea(InputStream imageStream, FileType fileType, double rotation) | Initializes a new instance of the PageImageArea class.
 |
| PageImageArea(InputStream imageStream, FileType fileType, double rotation, Page page, Rectangle rectangle) | Initializes a new instance of the PageImageArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the format of the image.
 |
| getRotation() | Gets the rotation angle of the image.
 |
| getImageStream() | Returns the image stream.
 |
| getImageStream(ImageOptions options) | Returns the image stream in a different format.
 |
| save(String filePath) | Saves the image to the file.
 |
| save(String filePath, ImageOptions options) | Saves the image to the file in a different format.
 |
##### PageImageArea(InputStream imageStream, FileType fileType, double rotation)
```
public PageImageArea(InputStream imageStream, FileType fileType, double rotation)
```

Initializes a new instance of the PageImageArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | The stream of the image.
 |
| fileType | FileType | The format of the image.
 |
| rotation | double | The rotation angle of the image.
 |

##### PageImageArea(InputStream imageStream, FileType fileType, double rotation, Page page, Rectangle rectangle)
```
public PageImageArea(InputStream imageStream, FileType fileType, double rotation, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageImageArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | The stream of the image.
 |
| fileType | FileType | The format of the image.
 |
| rotation | double | The rotation angle of the image.
 |
| page | Page | The page that contains the image.
 |
| rectangle | Rectangle | The rectangular area that contains the image.
 |

##### getFileType()
```
public FileType getFileType()
```

Gets the format of the image.

**Returns:**
FileType - An instance of FileType class that represents the format of the image.

##### getRotation()
```
public double getRotation()
```

Gets the rotation angle of the image.

**Returns:**
double - A double value that represents the rotation angle of the image.

##### getImageStream()
```
public InputStream getImageStream()
```

Returns the image stream.

The following example shows how to save images to files:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Extract images from document
     Iterable images = parser.getImages();
     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Page images extraction isn't supported");
         return;
     }
     int imageNumber = 0;
     // Iterate over images
     for (PageImageArea image : images) {
         // Open the image stream
         try (InputStream imageStream = image.getImageStream()) {
             // Create the file to save image
             try (OutputStream destStream = new FileOutputStream(imageNumber + image.getFileType().getExtension())) {
                 byte[] buffer = new byte[4096];
                 int readed = 0;
                 do {
                     // Read data from the image stream
                     readed = imageStream.read(buffer, 0, buffer.length);
                     if (readed > 0) {
                         // Write data to the file stream
                         destStream.write(buffer, 0, readed);
                     }
                 }
                 while (readed > 0);
             }
             imageNumber++;
         }
     }
 }
 
````

**Returns:**
java.io.InputStream - A stream with the image.

##### getImageStream(ImageOptions options)
```
public InputStream getImageStream(ImageOptions options)
```

Returns the image stream in a different format.

The following example shows how to save images in PNG format:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Extract images from document
     Iterable images = parser.getImages();
     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Page images extraction isn't supported");
         return;
     }

     // Create the options to save images in PNG format
     ImageOptions options = new ImageOptions(ImageFormat.Png);

     int imageNumber = 0;
     // Iterate over images
     for (PageImageArea image : images) {
         // Open the image stream
         try (InputStream imageStream = image.getImageStream(options)) {
             // Create the file to save image
             try (OutputStream destStream = new FileOutputStream(imageNumber + ".png")) {
                 byte[] buffer = new byte[4096];
                 int readed = 0;
                 do {
                     // Read data from the image stream
                     readed = imageStream.read(buffer, 0, buffer.length);
                     if (readed > 0) {
                         // Write data to the file stream
                         destStream.write(buffer, 0, readed);
                     }
                 }
                 while (readed > 0);
             }
             imageNumber++;
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ImageOptions | The options which are used to extract the image.
 |

**Returns:**
java.io.InputStream - A stream with the image

##### save(String filePath)
```
public void save(String filePath)
```

Saves the image to the file.

The following example shows how to save images to files:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Extract images from document
     Iterable images = parser.getImages();

     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Page images extraction isn't supported");
         return;
     }

     int imageNumber = 0;
     // Iterate over images
     for (PageImageArea image : images)
     {
         // Save the image to the file
         image.save(Constants.getOutputFilePath(String.format("%d", imageNumber) + image.getFileType().getExtension()));

         imageNumber++;
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

##### save(String filePath, ImageOptions options)
```
public void save(String filePath, ImageOptions options)
```

Saves the image to the file in a different format.

The following example shows how to save images to files in PNG format:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Extract images from document
     Iterable images = parser.getImages();

     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Page images extraction isn't supported");
         return;
     }

     // Create the options to save images in PNG format
     ImageOptions options = new ImageOptions(ImageFormat.Png);

     int imageNumber = 0;
     // Iterate over images
     for (PageImageArea image : images)
     {
         // Save the image to the png file
         image.save(Constants.getOutputFilePath(String.format("%d.png", imageNumber)), options);

         imageNumber++;
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |
| options | ImageOptions | The options which are used to save the image.
 |

### PageTableArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagetablearea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageTableArea extends PageArea
```

Represents a table page area which is used to represent a table in the parsing by template functionality.

PageTableArea class is used to organize inheritors of PageArea class in table structure.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageTableArea(Iterable<Double> rows, Iterable<Double> columns, Iterable<PageTableAreaCell> cells, Page page, Rectangle rectangle) | Initializes a new instance of the PageTableArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCells() | Gets the collection of cells.
 |
| getRowCount() | Gets the total number of the table rows.
 |
| getColumnCount() | Gets the total number of the table colums.
 |
| getRowHeight(int rowIndex) | Returns the row height.
 |
| getColumnWidth(int columnIndex) | Returns the column width.
 |
| getCell(int rowIndex, int columnIndex) | Gets the table cell by row and column indexes.
 |
##### PageTableArea(Iterable<Double> rows, Iterable<Double> columns, Iterable<PageTableAreaCell> cells, Page page, Rectangle rectangle)
```
public PageTableArea(Iterable<Double> rows, Iterable<Double> columns, Iterable<PageTableAreaCell> cells, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageTableArea class.

Note: the C# project marks this constructor as
internal
 (commit 954951f). In Java, "internal-to-the-assembly"
does not translate cleanly to package-private because the producers (
WordProcessingParser
,
TableAreaParser
,
etc.) live in
com.groupdocs.parser
, not
com.groupdocs.parser.data
. The constructor is therefore kept

public
 so cross-package construction still works.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rows | java.lang.Iterable<java.lang.Double> | The collection of row heights.
 |
| columns | java.lang.Iterable<java.lang.Double> | The collection of column widths.
 |
| cells | java.lang.Iterable<com.groupdocs.parser.data.PageTableAreaCell> | The collection of cells.
 |
| page | Page | The page that contains the table.
 |
| rectangle | Rectangle | The rectangular area that contains the table.
 |

##### getCells()
```
public Collection<PageTableAreaCell> getCells()
```

Gets the collection of cells. A plain read-only collection of table cells.

**Returns:**
java.util.Collection<com.groupdocs.parser.data.PageTableAreaCell> - A collection of table cells

##### getRowCount()
```
public int getRowCount()
```

Gets the total number of the table rows.

**Returns:**
int - An integer value that contains the total number of the table rows.

##### getColumnCount()
```
public int getColumnCount()
```

Gets the total number of the table colums.

**Returns:**
int - An integer value that contains the total number of the table columns.

##### getRowHeight(int rowIndex)
```
public double getRowHeight(int rowIndex)
```

Returns the row height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | int | The zero-based index of the row.
 |

**Returns:**
double - A double value that represents the height of the row.

##### getColumnWidth(int columnIndex)
```
public double getColumnWidth(int columnIndex)
```

Returns the column width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnIndex | int | The zero-based index of the column.
 |

**Returns:**
double - A double value that represents the width of the column.

##### getCell(int rowIndex, int columnIndex)
```
public PageTableAreaCell getCell(int rowIndex, int columnIndex)
```

Gets the table cell by row and column indexes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | int | The zero-based index of the cell row.
 |
| columnIndex | int | The zero-based index of the cell column.
 |

**Returns:**
PageTableAreaCell - An instance of PageTableAreaCell class;  null  if no cell is found.

### PageTableAreaCell
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagetableareacell.md

**Inheritance:**
java.lang.Object
```
public class PageTableAreaCell
```

Represents a table cell which is used in PageTableArea class.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea) | Initializes a new instance of the PageTableAreaCell class.
 |
| PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea, int rowSpan, int columnSpan) | Initializes a new instance of the PageTableAreaCell class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRowIndex() | Gets the row index.
 |
| getColumnIndex() | Gets the column index.
 |
| getRowSpan() | Gets the total number of rows that contain the table cell.
 |
| getColumnSpan() | Gets the total number of columns that contain the table cell.
 |
| getPageArea() | Gets the table cell value.
 |
| getText() | Gets the table cell text value.
 |
##### PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea)
```
public PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea)
```

Initializes a new instance of the PageTableAreaCell class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | int | The zero-based index of the row.
 |
| columnIndex | int | The zero-based index of the column.
 |
| pageArea | PageArea | The value of the table cell.
 |

##### PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea, int rowSpan, int columnSpan)
```
public PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea, int rowSpan, int columnSpan)
```

Initializes a new instance of the PageTableAreaCell class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | int | The zero-based index of the row.
 |
| columnIndex | int | The zero-based index of the column.
 |
| pageArea | PageArea | The value of the table cell.
 |
| rowSpan | int | The total number of rows that contain the table cell.
 |
| columnSpan | int | The total number of columns that contain the table cell.
 |

##### getRowIndex()
```
public int getRowIndex()
```

Gets the row index.

**Returns:**
int - A zero-based index of the first row that contains the table cell.

##### getColumnIndex()
```
public int getColumnIndex()
```

Gets the column index.

**Returns:**
int - A zero-based index of the first column that contains the table cell.

##### getRowSpan()
```
public int getRowSpan()
```

Gets the total number of rows that contain the table cell.

**Returns:**
int - A positive integer value that represents the total number of rows that contain the table cell.

##### getColumnSpan()
```
public int getColumnSpan()
```

Gets the total number of columns that contain the table cell.

**Returns:**
int - A positive integer value that represents the total number of columns that contain the table cell.

##### getPageArea()
```
public PageArea getPageArea()
```

Gets the table cell value.

**Returns:**
PageArea - Depending on cell PageArea property can contain any of the inheritors of PageArea class.

##### getText()
```
public String getText()
```

Gets the table cell text value.

**Returns:**
java.lang.String - A string that represents a text value of the cell;  null  if cell doesn't contain a text value.

### PageTextArea
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/pagetextarea.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.data.PageArea
```
public class PageTextArea extends PageArea
```

Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality.

An instance of PageTextArea class is used as return value of the following methods:

* Parser.getTextAreas()
* Parser.getTextAreas(PageTextAreaOptions)
* Parser.getTextAreas(int)
* Parser.getTextAreas(int, PageTextAreaOptions)

Also an instance of PageTextArea class is used as value of PageArea property.
\*

See the usage examples there.

The text area can be single or composite. In the first case it contains a text which is bounded by a rectangular area.
In the second case it contains other text areas; text and table properties are calculated by child text areas.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageTextArea(String text, Page page, Rectangle rectangle) | Initializes a new instance of the PageTextArea class.
 |
| PageTextArea(String text, Double baseLine, TextStyle textStyle, Page page, Rectangle rectangle) | Initializes a new instance of the PageTextArea class.
 |
| PageTextArea(Iterable<PageTextArea> areas, Page page) | Initializes a new instance of the PageTextArea class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the text.
 |
| getBaseLine() | Gets the base line.
 |
| getTextStyle() | Gets the text style such as font size, font name an so on.
 |
| getAreas() | Gets the collection of child text page areas.
 |
##### PageTextArea(String text, Page page, Rectangle rectangle)
```
public PageTextArea(String text, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageTextArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The value of the text.
 |
| page | Page | The page that contains the text area.
 |
| rectangle | Rectangle | The rectangular area that contains the text area.
 |

##### PageTextArea(String text, Double baseLine, TextStyle textStyle, Page page, Rectangle rectangle)
```
public PageTextArea(String text, Double baseLine, TextStyle textStyle, Page page, Rectangle rectangle)
```

Initializes a new instance of the PageTextArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The value of the text.
 |
| baseLine | java.lang.Double | The base line of the text.
 |
| textStyle | TextStyle | The style of the text.
 |
| page | Page | The page that contains the text area.
 |
| rectangle | Rectangle | The rectangular area that contains the text area.
 |

##### PageTextArea(Iterable<PageTextArea> areas, Page page)
```
public PageTextArea(Iterable<PageTextArea> areas, Page page)
```

Initializes a new instance of the PageTextArea class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| areas | java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> | The collecton of child text page areas.
 |
| page | Page | The page that contains the text area.
 |

##### getText()
```
public String getText()
```

Gets the text.

**Returns:**
java.lang.String - A string value that represents a value of the text page area.

##### getBaseLine()
```
public double getBaseLine()
```

Gets the base line.

**Returns:**
double - A double value that represents the base line.

##### getTextStyle()
```
public TextStyle getTextStyle()
```

Gets the text style such as font size, font name an so on.

**Returns:**
TextStyle - An instance of TextStyle class that represents the text style.

##### getAreas()
```
public List<PageTextArea> getAreas()
```

Gets the collection of child text page areas.

**Returns:**
java.util.List<com.groupdocs.parser.data.PageTextArea> - A collection of child text page areas; empty if the text page area hasn't children.

### Point
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/point.md

**Inheritance:**
java.lang.Object
```
public class Point
```

Represents a point.

#### Constructors

| Constructor | Description |
| --- | --- |
| Point(double x, double y) | Initializes a new instance of the Point class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getX() | Gets the x-coordinate.
 |
| getY() | Gets the y-coordinate.
 |
| parse(String s) | Converts the string representation of a point to its class equivalent.
 |
| toString() |  |
##### Point(double x, double y)
```
public Point(double x, double y)
```

Initializes a new instance of the Point class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| x | double | The x-coordinate.
 |
| y | double | The y-coordinate.
 |

##### getX()
```
public double getX()
```

Gets the x-coordinate.

**Returns:**
double - A double value that represents the x-coordinate.

##### getY()
```
public double getY()
```

Gets the y-coordinate.

**Returns:**
double - A double value that represents the y-coordinate.

##### parse(String s)
```
public static Point parse(String s)
```

Converts the string representation of a point to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | A string containing a point to convert.
 |

**Returns:**
Point - The instance of Point class that is equivalent to the value specified in  s  parameter.

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### Rectangle
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/rectangle.md

**Inheritance:**
java.lang.Object
```
public class Rectangle
```

Represents a rectangular area.

#### Constructors

| Constructor | Description |
| --- | --- |
| Rectangle(double left, double top, double right, double bottom) | Initializes a new instance of the Rectangle class.
 |
| Rectangle(Point position, Size size) | Initializes a new instance of the Rectangle class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the x-coordinate of the left edge of the rectangular area.
 |
| getTop() | Gets the y-coordinate of the top edge of the rectangular area.
 |
| getRight() | Gets the x-coordinate of the right egde of the rectangular area.
 |
| getBottom() | Gets the y-coordinate of the bottom edge of the rectangular area.
 |
| getPosition() | Gets the coordinates of the upper-left corner of the rectangular area.
 |
| getSize() | Gets the size.
 |
| toString() |  |
##### Rectangle(double left, double top, double right, double bottom)
```
public Rectangle(double left, double top, double right, double bottom)
```

Initializes a new instance of the Rectangle class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | double | The x-coordinate of the left edge of the rectangular area.
 |
| top | double | The y-coordinate of the top edge of the rectangular area.
 |
| right | double | The x-coordinate of the right edge of the rectangular area.
 |
| bottom | double | The y-coordinate of the bottom edge of the rectangular area.
 |

##### Rectangle(Point position, Size size)
```
public Rectangle(Point position, Size size)
```

Initializes a new instance of the Rectangle class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | Point | The coordinates of the upper-left corner of the rectangular area.
 |
| size | Size | The size of the rectangular area.
 |

##### getLeft()
```
public double getLeft()
```

Gets the x-coordinate of the left edge of the rectangular area.

**Returns:**
double - A double value that represents the x-coordinate of the left edge of the rectangular area.

##### getTop()
```
public double getTop()
```

Gets the y-coordinate of the top edge of the rectangular area.

**Returns:**
double - A double value that represents the y-coordinate of the top edge of the rectangular area.

##### getRight()
```
public double getRight()
```

Gets the x-coordinate of the right egde of the rectangular area.

**Returns:**
double - A double value that represents the x-coordinate of the right edge of the rectangular area.

##### getBottom()
```
public double getBottom()
```

Gets the y-coordinate of the bottom edge of the rectangular area.

**Returns:**
double - A double value that represents the y-coordinate of the bottom edge of the rectangular area.

##### getPosition()
```
public Point getPosition()
```

Gets the coordinates of the upper-left corner of the rectangular area.

**Returns:**
Point - An instance of Point class that represents the coordinates of the upper-left corner of the rectangular area.

##### getSize()
```
public Size getSize()
```

Gets the size.

**Returns:**
Size - An instance of Size class that represents the size of the rectangular area.

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### SearchResult
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/searchresult.md

**Inheritance:**
java.lang.Object
```
public class SearchResult
```

Represents the search result in the search functionality.

An instance of SearchResult class is used as return value of Parser.search(String)
and Parser.search(String, com.groupdocs.parser.options.SearchOptions) methods. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchResult(int position, String text, Integer pageIndex, HighlightItem leftHighlightItem, HighlightItem rightHighlightItem) | Initializes a new instance of the SearchResult class.
 |
| SearchResult(int position, String text, Integer pageIndex) | Initializes a new instance of the SearchResult class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPosition() | Gets the position in the document text.
 |
| getText() | Gets the text.
 |
| getPageIndex() | Gets the page index where the text is found.
 |
| getLeftHighlightItem() | Gets the left highlight.
 |
| getRightHighlightItem() | Gets the right highlight.
 |
##### SearchResult(int position, String text, Integer pageIndex, HighlightItem leftHighlightItem, HighlightItem rightHighlightItem)
```
public SearchResult(int position, String text, Integer pageIndex, HighlightItem leftHighlightItem, HighlightItem rightHighlightItem)
```

Initializes a new instance of the SearchResult class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | int | The position in the document text.
 |
| text | java.lang.String | The found text.
 |
| pageIndex | java.lang.Integer | The page index where the text is found.
 |
| leftHighlightItem | HighlightItem | The left highlight.
 |
| rightHighlightItem | HighlightItem | The right highlight.
 |

##### SearchResult(int position, String text, Integer pageIndex)
```
public SearchResult(int position, String text, Integer pageIndex)
```

Initializes a new instance of the SearchResult class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | int | The position in the document text.
 |
| text | java.lang.String | The found text.
 |
| pageIndex | java.lang.Integer | The page index where the text is found.
 |

##### getPosition()
```
public int getPosition()
```

Gets the position in the document text.

**Returns:**
int - A zero-based index of the start position of the search result.

##### getText()
```
public String getText()
```

Gets the text.

**Returns:**
java.lang.String - A string value that respresents the found text.

##### getPageIndex()
```
public Integer getPageIndex()
```

Gets the page index where the text is found.

**Returns:**
java.lang.Integer - A zero-based index of the page where the text is found;  null  if the seach is performed on the whole document text.

##### getLeftHighlightItem()
```
public HighlightItem getLeftHighlightItem()
```

Gets the left highlight.

**Returns:**
HighlightItem - An instance of HighlightItem class;  null  if it isn't set.

##### getRightHighlightItem()
```
public HighlightItem getRightHighlightItem()
```

Gets the right highlight.

**Returns:**
HighlightItem - An instance of HighlightItem class;  null  if it isn't set.

### Size
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/size.md

**Inheritance:**
java.lang.Object
```
public class Size
```

Represents a size.

#### Constructors

| Constructor | Description |
| --- | --- |
| Size(double width, double height) | Initializes a new instance of the Size class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width.
 |
| getHeight() | Gets the height.
 |
| isEmpty() | Gets a value that indicates whether the size is empty.
 |
| parse(String s) | Converts the string representation of a size to its class equivalent.
 |
| toString() |  |
##### Size(double width, double height)
```
public Size(double width, double height)
```

Initializes a new instance of the Size class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | double | The width in pixels.
 |
| height | double | The height in pixels.
 |

##### getWidth()
```
public double getWidth()
```

Gets the width.

**Returns:**
double - A double value that represents the width in pixels.

##### getHeight()
```
public double getHeight()
```

Gets the height.

**Returns:**
double - A double value that represents the height in pixels.

##### isEmpty()
```
public boolean isEmpty()
```

Gets a value that indicates whether the size is empty.

**Returns:**
boolean -  true  if the  width  and  height  are zero; otherwise,  false .

##### parse(String s)
```
public static Size parse(String s)
```

Converts the string representation of a size to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | A string containing a size to convert.
 |

**Returns:**
Size - The instance of Size class that is equivalent to the value specified in  s  parameter.

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### TextReader
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/textreader.md

**Inheritance:**
java.lang.Object, java.io.Reader
```
public abstract class TextReader extends Reader
```

Represents a reader that can read a sequential series of characters.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextReader() |  |
#### Methods

| Method | Description |
| --- | --- |
| markSupported() |  |
| readLine() | Reads a line of characters from the text reader and returns the data as a string.
 |
| readToEnd() | Reads all characters from the current position to the end of the text reader and returns them as one string.
 |
| dispose() | Releases all resources used by TextReader object.
 |
##### TextReader()
```
public TextReader()
```

##### markSupported()
```
public boolean markSupported()
```

**Returns:**
boolean
##### readLine()
```
public abstract String readLine()
```

Reads a line of characters from the text reader and returns the data as a string.

**Returns:**
java.lang.String - The next line from the reader, or  null  if all characters have been read.

##### readToEnd()
```
public abstract String readToEnd()
```

Reads all characters from the current position to the end of the text reader and returns them as one string.

**Returns:**
java.lang.String - A string that contains all characters from the current position to the end of the text reader.

##### dispose()
```
public void dispose()
```

Releases all resources used by TextReader object.

### TextStyle
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/textstyle.md

**Inheritance:**
java.lang.Object
```
public final class TextStyle
```

Represents the style of the text such as a font name, a font size and so on.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextStyle(String name, String fontName, double fontSize, boolean bold, boolean italic) | Initializes a new instance of the TextStyle class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the style name.
 |
| getFontName() | Gets the font name.
 |
| getFontSize() | Gets the font size.
 |
| isBold() | Gets the value that indicates whether the font is bold.
 |
| isItalic() | Gets the value that indicates whether the font is italic.
 |
| equals(Object o) |  |
| hashCode() |  |
##### TextStyle(String name, String fontName, double fontSize, boolean bold, boolean italic)
```
public TextStyle(String name, String fontName, double fontSize, boolean bold, boolean italic)
```

Initializes a new instance of the TextStyle class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the style.
 |
| fontName | java.lang.String | The name of the font.
 |
| fontSize | double | The size of the font.
 |
| bold | boolean | The value that indicates whether the font is bold.
 |
| italic | boolean | The value that indicates whether the font is italic.
 |

##### getName()
```
public String getName()
```

Gets the style name.

**Returns:**
java.lang.String - A string value that represents the style name.

##### getFontName()
```
public String getFontName()
```

Gets the font name.

**Returns:**
java.lang.String - A string value that represents the font name.

##### getFontSize()
```
public double getFontSize()
```

Gets the font size.

**Returns:**
double - A double value that represents the font size.

##### isBold()
```
public boolean isBold()
```

Gets the value that indicates whether the font is bold.

**Returns:**
boolean -  true  if the font is bold; otherwise,  false .

##### isItalic()
```
public boolean isItalic()
```

Gets the value that indicates whether the font is italic.

**Returns:**
boolean -  true  if the font is italic; otherwise,  false .

##### equals(Object o)
```
public boolean equals(Object o)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int

### TocItem
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.data/tocitem.md

**Inheritance:**
java.lang.Object
```
public class TocItem
```

Represents the item which is used in the table of contents extraction functionality.

An instance of TocItem class is used as return value of Parser.getToc() method. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| TocItem(int depth, String text, Integer pageIndex) | Initializes a new instance of the TocItem class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDepth() | Gets the depth level.
 |
| getText() | Gets the text.
 |
| getPageIndex() | Gets the page index.
 |
| extractText() | Extracts a text from the document to which TocItem object refers.
 |
##### TocItem(int depth, String text, Integer pageIndex)
```
public TocItem(int depth, String text, Integer pageIndex)
```

Initializes a new instance of the TocItem class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| depth | int | The depth level of the item.
 |
| text | java.lang.String | The text of the item.
 |
| pageIndex | java.lang.Integer | The index of the page referenced by the item
 |

##### getDepth()
```
public int getDepth()
```

Gets the depth level.

**Returns:**
int - An integer value that represents the depth level of the item.

##### getText()
```
public String getText()
```

Gets the text.

**Returns:**
java.lang.String - A string value that represents the text of the item.

##### getPageIndex()
```
public Integer getPageIndex()
```

Gets the page index.

**Returns:**
java.lang.Integer - An integer value that represents the index of the page referenced by the item;  null  if it isn't set.

##### extractText()
```
public TextReader extractText()
```

Extracts a text from the document to which TocItem object refers.

The following example how to extract a text by the an item of table of contents:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleDocxWithToc)) {
     // Get table of contents
     Iterable tocItems = parser.getToc();

     // Check if toc extraction is supported
     if (tocItems == null) {
         System.out.println("Table of contents extraction isn't supported");
     }

     // Iterate over items
     for (TocItem tocItem : tocItems) {
         // Print the text of the chapter
         try (TextReader reader = tocItem.extractText()) {
             System.out.println("----");
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Returns:**
TextReader - An instance of TextReader class with the extracted text.

### com.groupdocs.parser.exceptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.exceptions.md

The package provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| CorruptedDocumentException | Thrown during document load, when the document is corrupted. |
| GroupDocsParserException | Represents the errors that occur during application execution. |
| InvalidPasswordException | Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing. |
| UnsupportedDocumentFormatException | Thrown during document load, when the document format is not recognized or not supported. |

### CorruptedDocumentException
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.exceptions/corrupteddocumentexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.parser.exceptions.GroupDocsParserException
```
public class CorruptedDocumentException extends GroupDocsParserException
```

Thrown during document load, when the document is corrupted.

#### Constructors

| Constructor | Description |
| --- | --- |
| CorruptedDocumentException() | Initializes a new instance of the CorruptedDocumentException class.
 |
| CorruptedDocumentException(String message) | Initializes a new instance of the CorruptedDocumentException class.
 |
##### CorruptedDocumentException()
```
public CorruptedDocumentException()
```

Initializes a new instance of the CorruptedDocumentException class.

##### CorruptedDocumentException(String message)
```
public CorruptedDocumentException(String message)
```

Initializes a new instance of the CorruptedDocumentException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error.
 |

### GroupDocsParserException
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.exceptions/groupdocsparserexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public class GroupDocsParserException extends RuntimeException
```

Represents the errors that occur during application execution.

#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsParserException() | Initializes a new instance of the GroupDocsParserException class.
 |
| GroupDocsParserException(String message) | Initializes a new instance of the GroupDocsParserException class.
 |
##### GroupDocsParserException()
```
public GroupDocsParserException()
```

Initializes a new instance of the GroupDocsParserException class.

##### GroupDocsParserException(String message)
```
public GroupDocsParserException(String message)
```

Initializes a new instance of the GroupDocsParserException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error.
 |

### InvalidPasswordException
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.exceptions/invalidpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.parser.exceptions.GroupDocsParserException
```
public class InvalidPasswordException extends GroupDocsParserException
```

Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.

#### Constructors

| Constructor | Description |
| --- | --- |
| InvalidPasswordException() | Initializes a new instance of the InvalidPasswordException class.
 |
| InvalidPasswordException(String message) | Initializes a new instance of the InvalidPasswordException class.
 |
##### InvalidPasswordException()
```
public InvalidPasswordException()
```

Initializes a new instance of the InvalidPasswordException class.

##### InvalidPasswordException(String message)
```
public InvalidPasswordException(String message)
```

Initializes a new instance of the InvalidPasswordException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error.
 |

### UnsupportedDocumentFormatException
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.exceptions/unsupporteddocumentformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.parser.exceptions.GroupDocsParserException
```
public class UnsupportedDocumentFormatException extends GroupDocsParserException
```

Thrown during document load, when the document format is not recognized or not supported.

#### Constructors

| Constructor | Description |
| --- | --- |
| UnsupportedDocumentFormatException() | Initializes a new instance of the UnsupportedDocumentFormatException class.
 |
| UnsupportedDocumentFormatException(String message) | Initializes a new instance of the UnsupportedDocumentFormatException class with the message.
 |
##### UnsupportedDocumentFormatException()
```
public UnsupportedDocumentFormatException()
```

Initializes a new instance of the UnsupportedDocumentFormatException class.

##### UnsupportedDocumentFormatException(String message)
```
public UnsupportedDocumentFormatException(String message)
```

Initializes a new instance of the UnsupportedDocumentFormatException class with the message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Error message.
 |

### com.groupdocs.parser.export
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.export.md

The package provides classes that allow users to export data to different formats.

#### Classes

| Class | Description |
| --- | --- |
| ExporterBase | Provides the base class for the data export functionality. |
| XmlExporter | Provides the functionality to export data in XML format. |

### ExporterBase
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.export/exporterbase.md

**Inheritance:**
java.lang.Object
```
public abstract class ExporterBase
```

Provides the base class for the data export functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExporterBase() |  |
#### Methods

| Method | Description |
| --- | --- |
| exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream) | Exports the collection of metadata to the stream.
 |
| exportMetadata(Iterable<MetadataItem> metadata, String fileName) | Exports the collection of metadata to the file.
 |
| exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream) | Exports the document information to the stream.
 |
| exportDocumentInfo(IDocumentInfo documentInfo, String fileName) | Exports the document information to the file.
 |
| exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream) | Exports the collection of text areas to the stream.
 |
| exportTextAreas(Iterable<PageTextArea> textAreas, String fileName) | Exports the collection of text areas to the file.
 |
| exportTables(Iterable<PageTableArea> tables, OutputStream outputStream) | Exports the collection of tables to the stream.
 |
| exportTables(Iterable<PageTableArea> tables, String fileName) | Exports the collection of tables to the file.
 |
| exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream) | Exports the collection of barcodes to the stream.
 |
| exportBarcodes(Iterable<PageBarcodeArea> barcodes, String fileName) | Exports the collection of barcodes to the file.
 |
| exportDocumentData(DocumentData documentData, OutputStream outputStream) | Exports document data to the stream.
 |
| exportDocumentData(DocumentData documentData, String fileName) | Exports document data to the file.
 |
##### ExporterBase()
```
public ExporterBase()
```

##### exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream)
```
public abstract void exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream)
```

Exports the collection of metadata to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportMetadata(Iterable<MetadataItem> metadata, String fileName)
```
public void exportMetadata(Iterable<MetadataItem> metadata, String fileName)
```

Exports the collection of metadata to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata.
 |
| fileName | java.lang.String | The full path to the output file.
 |

##### exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream)
```
public abstract void exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream)
```

Exports the document information to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportDocumentInfo(IDocumentInfo documentInfo, String fileName)
```
public void exportDocumentInfo(IDocumentInfo documentInfo, String fileName)
```

Exports the document information to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information.
 |
| fileName | java.lang.String | The full path to the output file.
 |

##### exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream)
```
public abstract void exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream)
```

Exports the collection of text areas to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> | The collection of the text areas.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportTextAreas(Iterable<PageTextArea> textAreas, String fileName)
```
public void exportTextAreas(Iterable<PageTextArea> textAreas, String fileName)
```

Exports the collection of text areas to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> | The collection of text areas.
 |
| fileName | java.lang.String | The full path to the output file.
 |

##### exportTables(Iterable<PageTableArea> tables, OutputStream outputStream)
```
public abstract void exportTables(Iterable<PageTableArea> tables, OutputStream outputStream)
```

Exports the collection of tables to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tables | java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> | The collection of tables.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportTables(Iterable<PageTableArea> tables, String fileName)
```
public void exportTables(Iterable<PageTableArea> tables, String fileName)
```

Exports the collection of tables to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tables | java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> | The collection of tables.
 |
| fileName | java.lang.String | The full path to the output file.
 |

##### exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream)
```
public abstract void exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream)
```

Exports the collection of barcodes to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> | The collection of barcodes.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportBarcodes(Iterable<PageBarcodeArea> barcodes, String fileName)
```
public void exportBarcodes(Iterable<PageBarcodeArea> barcodes, String fileName)
```

Exports the collection of barcodes to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> | The collection of barcodes.
 |
| fileName | java.lang.String | The full path to the output file.
 |

##### exportDocumentData(DocumentData documentData, OutputStream outputStream)
```
public abstract void exportDocumentData(DocumentData documentData, OutputStream outputStream)
```

Exports document data to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportDocumentData(DocumentData documentData, String fileName)
```
public void exportDocumentData(DocumentData documentData, String fileName)
```

Exports document data to the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data.
 |
| fileName | java.lang.String | The full path to the output file.
 |

### XmlExporter
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.export/xmlexporter.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.export.ExporterBase
```
public final class XmlExporter extends ExporterBase
```

Provides the functionality to export data in XML format.

#### Constructors

| Constructor | Description |
| --- | --- |
| XmlExporter() | Initializes a new instance of the XmlExporter class.
 |
#### Methods

| Method | Description |
| --- | --- |
| exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream) | Exports the collection of metadata to the stream.
 |
| exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream) | Exports the document information to the stream.
 |
| exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream) | Exports the collection of text areas to the stream.
 |
| exportTables(Iterable<PageTableArea> tables, OutputStream outputStream) | Exports the collection of tables to the stream.
 |
| exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream) | Exports the collection of barcodes to the stream.
 |
| exportDocumentData(DocumentData documentData, OutputStream outputStream) | Exports document data to the stream.
 |
##### XmlExporter()
```
public XmlExporter()
```

Initializes a new instance of the XmlExporter class.

##### exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream)
```
public void exportMetadata(Iterable<MetadataItem> metadata, OutputStream outputStream)
```

Exports the collection of metadata to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream)
```
public void exportDocumentInfo(IDocumentInfo documentInfo, OutputStream outputStream)
```

Exports the document information to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream)
```
public void exportTextAreas(Iterable<PageTextArea> textAreas, OutputStream outputStream)
```

Exports the collection of text areas to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> | The collection of the text areas.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportTables(Iterable<PageTableArea> tables, OutputStream outputStream)
```
public void exportTables(Iterable<PageTableArea> tables, OutputStream outputStream)
```

Exports the collection of tables to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tables | java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> | The collection of tables.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream)
```
public void exportBarcodes(Iterable<PageBarcodeArea> barcodes, OutputStream outputStream)
```

Exports the collection of barcodes to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> | The collection of barcodes.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

##### exportDocumentData(DocumentData documentData, OutputStream outputStream)
```
public void exportDocumentData(DocumentData documentData, OutputStream outputStream)
```

Exports document data to the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data.
 |
| outputStream | java.io.OutputStream | The output stream.
 |

### com.groupdocs.parser.licensing
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.licensing.md

The package provides classes to set license or use Metered billing.

#### Classes

| Class | Description |
| --- | --- |
| License | Represents GroupDocs.Parser license. |
| Metered | Provides methods to set metered key. |

### License
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Represents GroupDocs.Parser license.

This example demonstrates how to setup license.

````
 ```

 // Initialize License class
 License license = new License();
 // Set path to .lic file
 license.setLicense("C:\\GroupDocs.Parser.for.Java.lic");
 
``` 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| License() | Initializes a new instance of the License class.
 |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String filePath) | Licenses the component.
 |
| setLicense(InputStream stream) | Licenses the component.
 |
##### License()
```
public License()
```

Initializes a new instance of the License class.

##### setLicense(String filePath)
```
public final void setLicense(String filePath)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute path to license file.
 |

##### setLicense(InputStream stream)
```
public final void setLicense(InputStream stream)
```

Licenses the component.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | License stream.
 |

### Metered
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public final class Metered
```

Provides methods to set metered key.

In this example, an attempt will be made to set metered public and private key:

````
 ```

 	Metered metered = new Metered();
 	metered.setMeteredKey("PublicKey", "PrivateKey");
  
``` 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() | Initializes a new instance of the Metered class.
 |
#### Methods

| Method | Description |
| --- | --- |
| setMeteredKey(String publicKey, String privateKey) | Sets metered public and private key.
 |
| getConsumptionQuantity() | Retrieves amount of MBs processed.
 |
| getConsumptionCredit() | Retrieves count of credits consumed.
 |
##### Metered()
```
public Metered()
```

Initializes a new instance of the Metered class.

##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Sets metered public and private key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | java.lang.String | A public key.
 |
| privateKey | java.lang.String | A private key
 |

##### getConsumptionQuantity()
```
public static BigDecimal getConsumptionQuantity()
```

Retrieves amount of MBs processed.

**Returns:**
java.math.BigDecimal - A double value that represents the consumption quantity.

##### getConsumptionCredit()
```
public static BigDecimal getConsumptionCredit()
```

Retrieves count of credits consumed.

**Returns:**
java.math.BigDecimal - A double value that represents the consumption credit.

### com.groupdocs.parser.options
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options.md

The package provides classes to specify additional options when parsing data from documents.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeOptions | Provides the options which are used for barcode extraction. |
| DocumentInfo | Represents the document information. |
| EmailConnection | Represents the email connection information. |
| EmailEwsConnection | Represents the email connection information for EWS protocol. |
| EmailImapConnection | Represents the email connection information for IMAP protocol. |
| EmailPopConnection | Represents the email connection information for POP protocol. |
| ExternalResourceHandler | Provides a handler for external resources loading. |
| ExternalResourceLoadingArgs | Provides the data for ExternalResourceHandler.#onLoading(ExternalResourceLoadingArgs) method. |
| Features | Represents the supported features list. |
| FileInfo | Represents the file information. |
| FileType | Represents the file type. |
| FormattedTextOptions | Provides the options which are used for formatted text extraction. |
| HighlightOptions | Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios). |
| ImageOptions | Provides the options which are used for image extraction. |
| LoadOptions | Provides the options which are used to open a file. |
| OcrConnectorBase | Provides the OCR functionality. |
| OcrEventHandler | Provides a handler for OCR events. |
| OcrOptions | Provides the options which are used for OCR Connector. |
| PageAreaOptions | Provides the options which are used for page areas extraction. |
| PageInfo | Represents the document page information. |
| PageRenderInfo | Represents the information of how a page is rendered. |
| PageTableAreaOptions | Provides the options which are used for page table areas extraction. |
| PageTextAreaOptions | Provides the options which are used for page text areas extraction. |
| ParserSettings | Provides the settings which are used to customize data extraction. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| SearchOptions | Provides the options which are used for text search. |
| TextDocumentInfo | Represents the text document information. |
| TextOptions | Provides the options which are used for text extraction. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICreatePageStream | Represents a delegate that returns a stream to write page preview data. |
| IDocumentInfo | Represents the document information. |
| ILogger | Defines the interface of a logger that is used for logging events and errors during data extraction. |
| IPreviewPageRender | Represents a method which is called before a document page is rendered. |
| IReleasePageStream | Represents a method which releases the stream created by the ICreatePageStream delegate. |

#### Enumerations

| Enum | Description |
| --- | --- |
| FileFormat | Defines a type of the file. |
| FileTypeDetectionMode | Defines a mode of the file type detection. |
| FormattedTextMode | Defines a formatted text mode. |
| ImageFormat | Defines a format of the image. |
| PreviewFormats | Represents supported preview formats. |
| QualityMode | Defines a level of the quality. |

### BarcodeOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/barcodeoptions.md

**Inheritance:**
java.lang.Object
```
public class BarcodeOptions
```

Provides the options which are used for barcode extraction.

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeOptions() | Initializes a new instance of the BarcodeOptions class with default values.
 |
| BarcodeOptions(Rectangle rectangle) | Initializes a new instance of the BarcodeOptions class with the rectangular area.
 |
| BarcodeOptions(QualityMode imageQuality, QualityMode barcodeQuality, String[] codeTypes) | Initializes a new instance of the BarcodeOptions class with quality settings and code types.
 |
| BarcodeOptions(Rectangle rectangle, QualityMode imageQuality, QualityMode barcodeQuality, Float dimension, boolean allowIncorrectBarcodes, String[] codeTypes) | Initializes a new instance of the BarcodeOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAllowIncorrectBarcodes() | Gets the value that indicates whether the incorrect barcodes are allowed.
 |
| getDimension() | Gets the minimal size of the barcode minimal element.
 |
| getImageQuality() | Gets the quality of a source image.
 |
| getBarcodeQuality() | Gets the quality of a source barcode.
 |
| getRectangle() | Gets the rectangular area that contains page areas.
 |
| getCodeTypes() | Gets the types of barcodes to read.
 |
| setAllowIncorrectBarcodes(boolean allowIncorrectBarcodes) | Sets the value that indicates whether the incorrect barcodes are allowed.
 |
| setDimension(Float dimension) | Sets the minimal size of the barcode minimal element.
 |
| setImageQuality(QualityMode imageQuality) | Sets the quality of a source image.
 |
| setBarcodeQuality(QualityMode barcodeQuality) | Sets the quality of a source barcode.
 |
| setRectangle(Rectangle rectangle) | Sets the rectangular area that contains barcodes.
 |
| setCodeTypes(List<String> codeTypes) | Sets the types of barcodes to read.
 |
##### BarcodeOptions()
```
public BarcodeOptions()
```

Initializes a new instance of the BarcodeOptions class with default values.

##### BarcodeOptions(Rectangle rectangle)
```
public BarcodeOptions(Rectangle rectangle)
```

Initializes a new instance of the BarcodeOptions class with the rectangular area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains barcodes.
 |

##### BarcodeOptions(QualityMode imageQuality, QualityMode barcodeQuality, String[] codeTypes)
```
public BarcodeOptions(QualityMode imageQuality, QualityMode barcodeQuality, String[] codeTypes)
```

Initializes a new instance of the BarcodeOptions class with quality settings and code types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageQuality | QualityMode | The quality of a source image.
 |
| barcodeQuality | QualityMode | The quality of a source barcode.
 |
| codeTypes | java.lang.String[] | The types of barcodes to read.
 |

##### BarcodeOptions(Rectangle rectangle, QualityMode imageQuality, QualityMode barcodeQuality, Float dimension, boolean allowIncorrectBarcodes, String[] codeTypes)
```
public BarcodeOptions(Rectangle rectangle, QualityMode imageQuality, QualityMode barcodeQuality, Float dimension, boolean allowIncorrectBarcodes, String[] codeTypes)
```

Initializes a new instance of the BarcodeOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains barcodes.
 |
| imageQuality | QualityMode | The quality of a source image.
 |
| barcodeQuality | QualityMode | The quality of a source barcode.
 |
| dimension | java.lang.Float | The minimal size of the barcode minimal element.
 |
| allowIncorrectBarcodes | boolean | The value that indicates whether the incorrect barcodes are allowed.
 |
| codeTypes | java.lang.String[] | The types of barcodes to read.
 |

##### isAllowIncorrectBarcodes()
```
public boolean isAllowIncorrectBarcodes()
```

Gets the value that indicates whether the incorrect barcodes are allowed.

**Returns:**
boolean -  true  if the incorrect barcodes are allowed; otherwise,  false .

##### getDimension()
```
public Float getDimension()
```

Gets the minimal size of the barcode minimal element.

**Returns:**
java.lang.Float - The float value that represents the barcode minimal element;  null  if auto mode is used.

##### getImageQuality()
```
public QualityMode getImageQuality()
```

Gets the quality of a source image.

**Returns:**
QualityMode - The mode which defines the level of the source image quality.

##### getBarcodeQuality()
```
public QualityMode getBarcodeQuality()
```

Gets the quality of a source barcode.

**Returns:**
QualityMode - The mode which defines the level of the source barcode quality.

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains page areas.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains page areas;  null  if it isn't set.

##### getCodeTypes()
```
public List<String> getCodeTypes()
```

Gets the types of barcodes to read.

**Returns:**
java.util.List<java.lang.String> - The readonly collection that contains a types of barcodes to read; empty collection if isn't set.

##### setAllowIncorrectBarcodes(boolean allowIncorrectBarcodes)
```
public void setAllowIncorrectBarcodes(boolean allowIncorrectBarcodes)
```

Sets the value that indicates whether the incorrect barcodes are allowed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allowIncorrectBarcodes | boolean |  true  if the incorrect barcodes are allowed.
 |

##### setDimension(Float dimension)
```
public void setDimension(Float dimension)
```

Sets the minimal size of the barcode minimal element.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dimension | java.lang.Float | The barcode minimal element;  null  for auto mode.
 |

##### setImageQuality(QualityMode imageQuality)
```
public void setImageQuality(QualityMode imageQuality)
```

Sets the quality of a source image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageQuality | QualityMode | The image quality mode.
 |

##### setBarcodeQuality(QualityMode barcodeQuality)
```
public void setBarcodeQuality(QualityMode barcodeQuality)
```

Sets the quality of a source barcode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| barcodeQuality | QualityMode | The barcode quality mode.
 |

##### setRectangle(Rectangle rectangle)
```
public void setRectangle(Rectangle rectangle)
```

Sets the rectangular area that contains barcodes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area;  null  to scan the whole page.
 |

##### setCodeTypes(List<String> codeTypes)
```
public void setCodeTypes(List<String> codeTypes)
```

Sets the types of barcodes to read.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| codeTypes | java.util.List<java.lang.String> | The types of barcodes;  null  or empty for all types.
 |

### DocumentInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.parser.options.IDocumentInfo
```
public abstract class DocumentInfo implements IDocumentInfo
```

Represents the document information.

**Learn more:**

* Get document info
* Detect encoding

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the document type.
 |
| getPageCount() | Gets the total number of document pages.
 |
| getRawPageCount() | Gets the total number of document raw pages.
 |
| getSize() | Gets the size of the document in bytes.
 |
| getPages() | Gets the information about pages such as the index and page size.
 |
##### DocumentInfo()
```
public DocumentInfo()
```

##### getFileType()
```
public abstract FileType getFileType()
```

Gets the document type.

**Returns:**
FileType - An instance of FileType class that represents the type of the document.

##### getPageCount()
```
public abstract int getPageCount()
```

Gets the total number of document pages.

**Returns:**
int - An integer value that represents a total number of pages.

##### getRawPageCount()
```
public abstract int getRawPageCount()
```

Gets the total number of document raw pages.

Use getRawPageCount() property instead of getPageCount() property for raw text extraction.
Some documents have different page numbers in accurate and raw text extraction modes.
getPageCount() property may perform extra calculations which impacts on text extraction speed in raw mode.

**Returns:**
int - An integer value that represents a total number of raw pages.

##### getSize()
```
public abstract long getSize()
```

Gets the size of the document in bytes.

**Returns:**
long - An integer value that represents the size of the document in bytes.

##### getPages()
```
public abstract List<PageInfo> getPages()
```

Gets the information about pages such as the index and page size.

**Returns:**
java.util.List<com.groupdocs.parser.options.PageInfo> - A collection with instances of PageInfo classes.

### EmailConnection
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/emailconnection.md

**Inheritance:**
java.lang.Object
```
public abstract class EmailConnection
```

Represents the email connection information.

#### Methods

| Method | Description |
| --- | --- |
| getUserName() | Gets the user name.
 |
| getPassword() | Gets the password.
 |
##### getUserName()
```
public String getUserName()
```

Gets the user name.

**Returns:**
java.lang.String - A string value that represents the user name.

##### getPassword()
```
public String getPassword()
```

Gets the password.

**Returns:**
java.lang.String - A string value that represents the password.

### EmailEwsConnection
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/emailewsconnection.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.EmailConnection
```
public final class EmailEwsConnection extends EmailConnection
```

Represents the email connection information for EWS protocol.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailEwsConnection(String mailboxUri, String userName, String password) | Initializes a new instance of the EmailEwsConnection class.
 |
| EmailEwsConnection(String mailboxUri, String domain, String userName, String password) | Initializes a new instance of the EmailEwsConnection class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getMailboxUri() | Gets the URI of the mailbox.
 |
| getDomain() | Gets the domain name.
 |
##### EmailEwsConnection(String mailboxUri, String userName, String password)
```
public EmailEwsConnection(String mailboxUri, String userName, String password)
```

Initializes a new instance of the EmailEwsConnection class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailboxUri | java.lang.String | The URI of mailbox.
 |
| userName | java.lang.String | The user name.
 |
| password | java.lang.String | The password.
 |

##### EmailEwsConnection(String mailboxUri, String domain, String userName, String password)
```
public EmailEwsConnection(String mailboxUri, String domain, String userName, String password)
```

Initializes a new instance of the EmailEwsConnection class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailboxUri | java.lang.String | The URI of mailbox.
 |
| domain | java.lang.String | The domain name.
 |
| userName | java.lang.String | The user name.
 |
| password | java.lang.String | The password.
 |

##### getMailboxUri()
```
public String getMailboxUri()
```

Gets the URI of the mailbox.

**Returns:**
java.lang.String - A string value that represents a URI of the mailbox.

##### getDomain()
```
public String getDomain()
```

Gets the domain name.

**Returns:**
java.lang.String - A string value that represents the domain name.

### EmailImapConnection
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/emailimapconnection.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.EmailConnection
```
public final class EmailImapConnection extends EmailConnection
```

Represents the email connection information for IMAP protocol.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailImapConnection(String host, int port, String userName, String password) | Initializes a new instance of the EmailImapConnection class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getHost() | Gets the host name.
 |
| getPort() | Gets the port number.
 |
##### EmailImapConnection(String host, int port, String userName, String password)
```
public EmailImapConnection(String host, int port, String userName, String password)
```

Initializes a new instance of the EmailImapConnection class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| host | java.lang.String | The host name.
 |
| port | int | The port number.
 |
| userName | java.lang.String | The user name.
 |
| password | java.lang.String | The password.
 |

##### getHost()
```
public String getHost()
```

Gets the host name.

**Returns:**
java.lang.String - A string value that represents the host name.

##### getPort()
```
public int getPort()
```

Gets the port number.

**Returns:**
int - An integer value that represents the port number.

### EmailPopConnection
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/emailpopconnection.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.EmailConnection
```
public final class EmailPopConnection extends EmailConnection
```

Represents the email connection information for POP protocol.

#### Constructors

| Constructor | Description |
| --- | --- |
| EmailPopConnection(String host, int port, String userName, String password) | Initializes a new instance of the EmailPopConnection class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getHost() | Gets the host name.
 |
| getPort() | Gets the port number.
 |
##### EmailPopConnection(String host, int port, String userName, String password)
```
public EmailPopConnection(String host, int port, String userName, String password)
```

Initializes a new instance of the EmailPopConnection class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| host | java.lang.String | The host name.
 |
| port | int | The port number.
 |
| userName | java.lang.String | The user name.
 |
| password | java.lang.String | The password.
 |

##### getHost()
```
public String getHost()
```

Gets the host name.

**Returns:**
java.lang.String - A string value that represents the host name.

##### getPort()
```
public int getPort()
```

Gets the port number.

**Returns:**
int - An integer value that represents the port number.

### ExternalResourceHandler
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/externalresourcehandler.md

**Inheritance:**
java.lang.Object
```
public class ExternalResourceHandler
```

Provides a handler for external resources loading.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExternalResourceHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| onLoading(ExternalResourceLoadingArgs args) | Called before any external resource load.
 |
##### ExternalResourceHandler()
```
public ExternalResourceHandler()
```

##### onLoading(ExternalResourceLoadingArgs args)
```
public void onLoading(ExternalResourceLoadingArgs args)
```

Called before any external resource load.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| args | ExternalResourceLoadingArgs | The data to control external resource loading.
 |

### ExternalResourceLoadingArgs
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/externalresourceloadingargs.md

**Inheritance:**
java.lang.Object
```
public class ExternalResourceLoadingArgs
```

Provides the data for ExternalResourceHandler.onLoading(ExternalResourceLoadingArgs) method.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExternalResourceLoadingArgs(String uri) | Initializes a new instance of the ExternalResourceLoadingArgs class with rectangular area.
 |
#### Methods

| Method | Description |
| --- | --- |
| getUri() | Gets the URI of the external resource.
 |
| setUri(String uri) | Gets the URI of the external resource.
 |
| isSkipped() | Gets the value that indicates whether the loading of the external resource must be skipped.
 |
| setSkipped(boolean skipped) | Sets the value that indicates whether the loading of the external resource must be skipped.
 |
| getData() | Gets the user data.
 |
| setData(byte[] data) | Sets the user data.
 |
##### ExternalResourceLoadingArgs(String uri)
```
public ExternalResourceLoadingArgs(String uri)
```

Initializes a new instance of the ExternalResourceLoadingArgs class with rectangular area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| uri | java.lang.String | URI of the external resource.
 |

##### getUri()
```
public String getUri()
```

Gets the URI of the external resource.

**Returns:**
java.lang.String - A string value that represents URI of the external resource.

##### setUri(String uri)
```
public void setUri(String uri)
```

Gets the URI of the external resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| uri | java.lang.String | A string value that represents a new URI of the external resource.
 |

##### isSkipped()
```
public boolean isSkipped()
```

Gets the value that indicates whether the loading of the external resource must be skipped.

**Returns:**
boolean - true if the loading of the external resource must be skipped; otherwise, false.

##### setSkipped(boolean skipped)
```
public void setSkipped(boolean skipped)
```

Sets the value that indicates whether the loading of the external resource must be skipped.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skipped | boolean | true if the loading of the external resource must be skipped; otherwise, false.
 |

##### getData()
```
public byte[] getData()
```

Gets the user data.

**Returns:**
byte[] - The byte array with the user content of the external resource. null if isn't set.

##### setData(byte[] data)
```
public void setData(byte[] data)
```

Sets the user data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | byte[] | The byte array with the user content of the external resource. null if isn't set.
 |

### Features
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/features.md

**Inheritance:**
java.lang.Object
```
public abstract class Features
```

Represents the supported features list. Allows to obtain information which features are supported or not for the document.

An instance of this class is used as Parser.getFeatures() property. See the usage examples there.

**Learn more:**

* Get supported features

#### Constructors

| Constructor | Description |
| --- | --- |
| Features() |  |
#### Methods

| Method | Description |
| --- | --- |
| isFeatureSupported(String featureName) | Returns the value that indicates whether the feature is supported.
 |
| isText() | Gets the value that indicates whether text extraction is supported.
 |
| isTextPage() | Gets the value that indicates whether text page extraction is supported.
 |
| isFormattedText() | Gets the value that indicates whether formatted text extraction is supported.
 |
| isFormattedTextPage() | Gets the value that indicates whether formatted text page extraction is supported.
 |
| isSearch() | Gets the value that indicates whether text search is supported.
 |
| isHighlight() | Gets the value that indicates whether highlight extraction is supported.
 |
| isBarcodes() | Gets the value that indicates whether barcodes extraction is supported.
 |
| isToc() | Gets the value that indicates whether table of contents extraction is supported.
 |
| isMetadata() | Gets the value that indicates whether metadata extraction is supported.
 |
| isContainer() | Gets the value that indicates whether container extraction is supported.
 |
| isTextAreas() | Gets the value that indicates whether text areas extraction is supported.
 |
| isStructure() | Gets the value that indicates whether text structure extraction is supported.
 |
| isImages() | Gets the value that indicates whether images extraction is supported.
 |
| isHyperlinks() | Gets the value that indicates whether hyperlinks extraction is supported.
 |
| isTables() | Gets the value that indicates whether tables extraction is supported.
 |
| isParseByTemplate() | Gets the value that indicates whether parsing by template is supported.
 |
| isParseForm() | Gets the value that indicates whether form parsing is supported.
 |
| isPreview() | Gets the value that indicates whether preview generation is supported.
 |
| isPagePreview() | Gets the value that indicates whether the page preview generation is supported.
 |
| isOcr() | Gets the value that indicates whether OCR functionality is supported.
 |
| isWorksheet() | Gets the value that indicates whether the worksheet extraction is supported.
 |
##### Features()
```
public Features()
```

##### isFeatureSupported(String featureName)
```
public abstract boolean isFeatureSupported(String featureName)
```

Returns the value that indicates whether the feature is supported.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| featureName | java.lang.String | The feature name.
 |

**Returns:**
boolean -  true  if the feature is supported; otherwise,  false .

##### isText()
```
public boolean isText()
```

Gets the value that indicates whether text extraction is supported.

**Returns:**
boolean -  true  if text extraction is supported; otherwise,  false .

##### isTextPage()
```
public boolean isTextPage()
```

Gets the value that indicates whether text page extraction is supported.

**Returns:**
boolean -  true  if text page extraction is supported; otherwise,  false .

##### isFormattedText()
```
public boolean isFormattedText()
```

Gets the value that indicates whether formatted text extraction is supported.

**Returns:**
boolean -  true  if formatted text extraction is supported; otherwise,  false .

##### isFormattedTextPage()
```
public boolean isFormattedTextPage()
```

Gets the value that indicates whether formatted text page extraction is supported.

**Returns:**
boolean -  true  if formatted text page is supported; otherwise,  false .

##### isSearch()
```
public boolean isSearch()
```

Gets the value that indicates whether text search is supported.

**Returns:**
boolean -  true  if text search is supported; otherwise,  false .

##### isHighlight()
```
public boolean isHighlight()
```

Gets the value that indicates whether highlight extraction is supported.

**Returns:**
boolean -  true  if highlight extraction is supported; otherwise,  false .

##### isBarcodes()
```
public boolean isBarcodes()
```

Gets the value that indicates whether barcodes extraction is supported.

**Returns:**
boolean -  true  if barcodes extraction is supported; otherwise,  false .

##### isToc()
```
public boolean isToc()
```

Gets the value that indicates whether table of contents extraction is supported.

**Returns:**
boolean -  true  if table of contents extraction is supported; otherwise,  false .

##### isMetadata()
```
public boolean isMetadata()
```

Gets the value that indicates whether metadata extraction is supported.

**Returns:**
boolean -  true  if metadata extraction is supported; otherwise,  false .

##### isContainer()
```
public boolean isContainer()
```

Gets the value that indicates whether container extraction is supported.

**Returns:**
boolean -  true  if container extraction is supported; otherwise,  false .

##### isTextAreas()
```
public boolean isTextAreas()
```

Gets the value that indicates whether text areas extraction is supported.

**Returns:**
boolean -  true  if text areas extraction is supported; otherwise,  false .

##### isStructure()
```
public boolean isStructure()
```

Gets the value that indicates whether text structure extraction is supported.

**Returns:**
boolean -  true  if text structure extraction is supported; otherwise,  false .

##### isImages()
```
public boolean isImages()
```

Gets the value that indicates whether images extraction is supported.

**Returns:**
boolean -  true  if images extraction is supported; otherwise,  false .

##### isHyperlinks()
```
public boolean isHyperlinks()
```

Gets the value that indicates whether hyperlinks extraction is supported.

**Returns:**
boolean -  true  if hyperlinks extraction is supported; otherwise,  false .

##### isTables()
```
public boolean isTables()
```

Gets the value that indicates whether tables extraction is supported.

**Returns:**
boolean -  true  if tables extraction is supported; otherwise,  false .

##### isParseByTemplate()
```
public boolean isParseByTemplate()
```

Gets the value that indicates whether parsing by template is supported.

**Returns:**
boolean -  true  if parsing by template is supported; otherwise,  false .

##### isParseForm()
```
public boolean isParseForm()
```

Gets the value that indicates whether form parsing is supported.

**Returns:**
boolean -  true  if form parsing is supported; otherwise,  false .

##### isPreview()
```
public boolean isPreview()
```

Gets the value that indicates whether preview generation is supported.

**Returns:**
boolean -  true  if preview generation is supported; otherwise,  false .

##### isPagePreview()
```
public boolean isPagePreview()
```

Gets the value that indicates whether the page preview generation is supported.

**Returns:**
boolean -  true  if the page preview generation is supported; otherwise,  false .

##### isOcr()
```
public boolean isOcr()
```

Gets the value that indicates whether OCR functionality is supported.

**Returns:**
boolean -  true  if OCR functionality is supported; otherwise,  false .

##### isWorksheet()
```
public boolean isWorksheet()
```

Gets the value that indicates whether the worksheet extraction is supported.

**Returns:**
boolean -  true  if the worksheet extraction is supported; otherwise,  false .

### FileFormat
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/fileformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum FileFormat extends Enum<FileFormat>
```

Defines a type of the file.

**Learn more:**

* Loading specific file formats

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Default value.
 |
| WordProcessing | Word Processing document (DOC, DOCX, ODT, etc).
 |
| Spreadsheet | Spreadsheet document (XLS, XLSX, ODS, etc).
 |
| Presentation | Presentation document (PPT, PPTX, ODP, etc).
 |
| Email | Email document (email messages or email message containers).
 |
| Pdf | PDF document.
 |
| Markup | Markup document (HTML, XML, Markdown, etc).
 |
| Ebook | Ebook document (ePUB, FictionBook, etc).
 |
| Note | Note document.
 |
| Archive | Archive file.
 |
| Database | Database files (via JDBC).
 |
| Image | Image file.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Unknown
```
public static final FileFormat Unknown
```

Default value.

##### WordProcessing
```
public static final FileFormat WordProcessing
```

Word Processing document (DOC, DOCX, ODT, etc).

##### Spreadsheet
```
public static final FileFormat Spreadsheet
```

Spreadsheet document (XLS, XLSX, ODS, etc).

##### Presentation
```
public static final FileFormat Presentation
```

Presentation document (PPT, PPTX, ODP, etc).

##### Email
```
public static final FileFormat Email
```

Email document (email messages or email message containers).

##### Pdf
```
public static final FileFormat Pdf
```

PDF document.

##### Markup
```
public static final FileFormat Markup
```

Markup document (HTML, XML, Markdown, etc).

##### Ebook
```
public static final FileFormat Ebook
```

Ebook document (ePUB, FictionBook, etc).

##### Note
```
public static final FileFormat Note
```

Note document.

##### Archive
```
public static final FileFormat Archive
```

Archive file.

##### Database
```
public static final FileFormat Database
```

Database files (via JDBC).

##### Image
```
public static final FileFormat Image
```

Image file.

##### values()
```
public static FileFormat[] values()
```

**Returns:**
com.groupdocs.parser.options.FileFormat[]
##### valueOf(String name)
```
public static FileFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileFormat

### FileInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/fileinfo.md

**Inheritance:**
java.lang.Object
```
public class FileInfo
```

Represents the file information.

#### Constructors

| Constructor | Description |
| --- | --- |
| FileInfo(FileType fileType, long size, boolean encrypted) |  |
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the document type.
 |
| getSize() | Gets the size of the document in bytes.
 |
| isEncrypted() | Gets a value that represents whether a file is password-protected.
 |
##### FileInfo(FileType fileType, long size, boolean encrypted)
```
public FileInfo(FileType fileType, long size, boolean encrypted)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType |  |
| size | long |  |
| encrypted | boolean |  |

##### getFileType()
```
public FileType getFileType()
```

Gets the document type.

**Returns:**
FileType - An instance of FileType class that represents the type of the document.

##### getSize()
```
public long getSize()
```

Gets the size of the document in bytes.

**Returns:**
long - An integer value that represents the size of the document in bytes.

##### isEncrypted()
```
public boolean isEncrypted()
```

Gets a value that represents whether a file is password-protected.

**Returns:**
boolean - A boolean true if a file is password-protected; otherwise false.

### FileType
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/filetype.md

**Inheritance:**
java.lang.Object
```
public class FileType
```

Represents the file type. Provides methods to obtain list of all file types supported by GroupDocs.Parser.

**Learn more:**

* Supported File Formats
* Get supported file formats
* Get document info

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type.
 |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format.
 |
| 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.
 |
| DOCX | DOCX is a well-known format for Microsoft Word documents.
 |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
 |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files.
 |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
 |
| TXT | A file with .TXT extension represents a text document that contains plain text in the form of lines.
 |
| TEXT | A file with .TEXT extension represents a text document that contains plain text in the form of lines.
 |
| 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.
 |
| RTF | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications.
 |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s.
 |
| HTM | Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others.
 |
| HTML | HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers.
 |
| XHTML | The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0.
 |
| MHT | Files with MHT 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.
 |
| XML | XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects.
 |
| MD | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension.
 |
| FB2 | Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
 |
| CHM | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
 |
| EPUB | Files with .EPUB extension are an e-book file format that provide 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.
 |
| MOBI | The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks.
 |
| XLS | Files with XLS extension represent 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 | Files with XLSM extension is a type of Spreasheet 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.
 |
| 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.
 |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications.
 |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files.
 |
| XLA | The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code.
 |
| XLAM | The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007.
 |
| CSV | Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values.
 |
| TSV | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
 |
| ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
 |
| OTS | The OTS files contain template files used by the OpenOffice spreadsheet application.
 |
| NUMBERS | Files that contain the .numbers file extension are files that are created by the Apple iWork Numbers spreadsheet application.
 |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow.
 |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
 |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose.
 |
| 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.
 |
| POT | Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
 |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
 |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
 |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros.
 |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
 |
| OTP | Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format.
 |
| 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.
 |
| 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.
 |
| ONE | File represented by .ONE extension are created by Microsoft OneNote application.
 |
| ZIP | ZIP file extension represents archives that can hold one or more files or directories.
 |
| SEVENZ | 7z is an archiving format for compressing files and folders with a high compression ratio.
 |
| RAR | Files with .rar extension represent archive files that are created for storing information in compressed or normal form.
 |
| TAR | Files with .tar extension are archives created with Unix-based utility for collecting one or more files.
 |
| GZ | Files with .gz extension are compressed files created with gzip compression application.
 |
| BZ2 | Compressed file using Bzip2 algorithm.
 |
| 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.
 |
| 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.
 |
| 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 | Files having extension .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.
 |
| JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
 |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard.
 |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard.
 |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard.
 |
| J2C | JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard.
 |
| J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard.
 |
| JPC | JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard.
 |
| DIB | A 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.
 |
| 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.
 |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression.
 |
| 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.
 |
| 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.
 |
| PCL | PCL stands for Printer Command Language which is a Page Description Language introduced by Hewlett Packard (HP).
 |
| PSD | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development.
 |
| DCM | Files with .DCM extension represent digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
 |
| PS | PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing.
 |
| EPS | Files with EPS extension essentially describe an Encapsulated PostScript language program that describes the appearance of a single page.
 |
| ODG | The ODG file format is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
 |
| SVG | An SVG file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image.
 |
| PICT | The PICT file format is a meta-format that can be used for both bitmap images and vector images.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | File type name e.g.
 |
| getExtension() | Filename suffix (including the period ".") e.g.
 |
| getFormat() | File format e.g.
 |
| equals(Object object) |  |
| toString() |  |
| fromExtension(String extension) | Maps file extension to file type.
 |
| getSupportedFileTypes() | Retrieves supported file types
 |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### DOC
```
public static final FileType 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.

##### DOT
```
public static final FileType 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.

##### DOCX
```
public static final FileType 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.

##### DOCM
```
public static final FileType DOCM
```

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here.

##### DOTX
```
public static final FileType 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.

##### DOTM
```
public static final FileType DOTM
```

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.

##### TXT
```
public static final FileType 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.

##### TEXT
```
public static final FileType TEXT
```

A file with .TEXT extension represents a text document that contains plain text in the form of lines. Learn more about this file format here.

##### ODT
```
public static final FileType ODT
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format here.

##### OTT
```
public static final FileType 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.

##### RTF
```
public static final FileType RTF
```

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format here.

##### PDF
```
public static final FileType 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.

##### HTM
```
public static final FileType HTM
```

Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others. Learn more about this file format here.

##### HTML
```
public static final FileType HTML
```

HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers. Learn more about this file format here.

##### XHTML
```
public static final FileType XHTML
```

The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0. Learn more about this file format here.

##### MHT
```
public static final FileType MHT
```

Files with MHT extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format here.

##### MHTML
```
public static final FileType MHTML
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format here.

##### XML
```
public static final FileType 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.

##### MD
```
public static final FileType MD
```

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. Learn more about this file format here.

##### FB2
```
public static final FileType FB2
```

Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. Learn more about this file format here.

##### CHM
```
public static final FileType CHM
```

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. Learn more about this file format here.

##### EPUB
```
public static final FileType EPUB
```

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format here.

##### AZW3
```
public static final FileType 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. Learn more about this file format here.

##### MOBI
```
public static final FileType MOBI
```

The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks. Learn more about this file format here.

##### XLS
```
public static final FileType XLS
```

Files with XLS extension represent 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 FileType 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 FileType XLSM
```

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format here.

##### XLSB
```
public static final FileType 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.

##### XLT
```
public static final FileType 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. Learn more about this file format here.

##### XLTX
```
public static final FileType XLTX
```

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format here.

##### XLTM
```
public static final FileType XLTM
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format here.

##### XLA
```
public static final FileType XLA
```

The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code. Supports the use of VBA projects.

##### XLAM
```
public static final FileType XLAM
```

The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007. An Add-In is a supplemental program that is designed to run additional code. Supports the use of VBA projects and Excel 4.0 macro sheets (.xlm).

##### CSV
```
public static final FileType 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.

##### TSV
```
public static final FileType TSV
```

A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format. Learn more about this file format here.

##### ODS
```
public static final FileType ODS
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format here.

##### OTS
```
public static final FileType OTS
```

The OTS files contain template files used by the OpenOffice spreadsheet application.

##### NUMBERS
```
public static final FileType NUMBERS
```

Files that contain the .numbers file extension are files that are created by the Apple iWork Numbers spreadsheet application.

##### PPT
```
public static final FileType 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.

##### PPTX
```
public static final FileType 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.

##### PPS
```
public static final FileType 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.

##### PPSX
```
public static final FileType 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 FileType ODP
```

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format here.

##### POT
```
public static final FileType POT
```

Files with .POT extension represent Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format here.

##### PPTM
```
public static final FileType 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.

##### POTX
```
public static final FileType 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.

##### POTM
```
public static final FileType 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.

##### PPSM
```
public static final FileType 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.

##### OTP
```
public static final FileType OTP
```

Files with .OTP extension represent presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format here.

##### MSG
```
public static final FileType 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 FileType EML
```

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format here.

##### EMLX
```
public static final FileType 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.

##### PST
```
public static final FileType 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 FileType 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

##### ONE
```
public static final FileType ONE
```

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format here.

##### ZIP
```
public static final FileType ZIP
```

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format here.

##### SEVENZ
```
public static final FileType SEVENZ
```

7z is an archiving format for compressing files and folders with a high compression ratio. Learn more about this file format here.

##### RAR
```
public static final FileType RAR
```

Files with .rar extension represent archive files that are created for storing information in compressed or normal form. Learn more about this file format here.

##### TAR
```
public static final FileType TAR
```

Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Learn more about this file format here.

##### GZ
```
public static final FileType GZ
```

Files with .gz extension are compressed files created with gzip compression application. Learn more about this file format here.

##### BZ2
```
public static final FileType BZ2
```

Compressed file using Bzip2 algorithm.

##### TIF
```
public static final FileType 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. Learn more about this file format here.

##### TIFF
```
public static final FileType 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. Learn more about this file format here.

##### JPG
```
public static final FileType JPG
```

A JPG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

##### JPEG
```
public static final FileType JPEG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

##### PNG
```
public static final FileType PNG
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format here.

##### GIF
```
public static final FileType GIF
```

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format here.

##### BMP
```
public static final FileType BMP
```

Files having extension .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 FileType 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.

##### JP2
```
public static final FileType JP2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Learn more about this file format here.

##### JPF
```
public static final FileType JPF
```

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### JPX
```
public static final FileType JPX
```

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### JPM
```
public static final FileType JPM
```

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### J2C
```
public static final FileType J2C
```

JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### J2K
```
public static final FileType J2K
```

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### JPC
```
public static final FileType JPC
```

JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

##### DIB
```
public static final FileType DIB
```

A 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.

##### WMF
```
public static final FileType 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 FileType EMF
```

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format here.

##### WEBP
```
public static final FileType 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.

##### DJVU
```
public static final FileType 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.

##### CGM
```
public static final FileType 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. Learn more about this file format here.

##### PCL
```
public static final FileType 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.

##### PSD
```
public static final FileType PSD
```

PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development. Learn more about this file format here.

##### DCM
```
public static final FileType 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.

##### PS
```
public static final FileType PS
```

PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. Learn more about this file format here.

##### EPS
```
public static final FileType 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.

##### ODG
```
public static final FileType 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.

##### SVG
```
public static final FileType 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.

##### PICT
```
public static final FileType PICT
```

The PICT file format is a meta-format that can be used for both bitmap images and vector images.

##### getFileFormat()
```
public String getFileFormat()
```

File type name e.g. "Microsoft Word Document".

**Returns:**
java.lang.String - String that represents a file type.

##### getExtension()
```
public String getExtension()
```

Filename suffix (including the period ".") e.g. ".doc".

**Returns:**
java.lang.String - String that represents a file extenstion (including the period ".").

##### getFormat()
```
public FileFormat getFormat()
```

File format e.g. "WordProcessing".

**Returns:**
FileFormat - A member of FileFormat enum that represents the format of the file.

##### equals(Object object)
```
public boolean equals(Object object)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| object | java.lang.Object |  |

**Returns:**
boolean
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period ".").
 |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default Unknown file type.

##### getSupportedFileTypes()
```
public static Iterable<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.lang.Iterable<com.groupdocs.parser.options.FileType> - Returns sequence of supported file types

### FileTypeDetectionMode
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/filetypedetectionmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum FileTypeDetectionMode extends Enum<FileTypeDetectionMode>
```

Defines a mode of the file type detection.

#### Fields

| Field | Description |
| --- | --- |
| Default | The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.
 |
| Extension | The file type is detected only by the file extension.
 |
| Content | The file type is detected only by the file content.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Default
```
public static final FileTypeDetectionMode Default
```

The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.

##### Extension
```
public static final FileTypeDetectionMode Extension
```

The file type is detected only by the file extension.

##### Content
```
public static final FileTypeDetectionMode Content
```

The file type is detected only by the file content.

##### values()
```
public static FileTypeDetectionMode[] values()
```

**Returns:**
com.groupdocs.parser.options.FileTypeDetectionMode[]
##### valueOf(String name)
```
public static FileTypeDetectionMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileTypeDetectionMode

### FormattedTextMode
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/formattedtextmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum FormattedTextMode extends Enum<FormattedTextMode>
```

Defines a formatted text mode.

**Learn more:**

* Extract formatted text from document
* Extract a document text as HTML
* Extract a document text as Markdown
* Extract a document text as Plain text

#### Fields

| Field | Description |
| --- | --- |
| Html | HTML format.
 |
| Markdown | Markdown format.
 |
| PlainText | Plain text format.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Html
```
public static final FormattedTextMode Html
```

HTML format.

##### Markdown
```
public static final FormattedTextMode Markdown
```

Markdown format.

##### PlainText
```
public static final FormattedTextMode PlainText
```

Plain text format.

##### values()
```
public static FormattedTextMode[] values()
```

**Returns:**
com.groupdocs.parser.options.FormattedTextMode[]
##### valueOf(String name)
```
public static FormattedTextMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FormattedTextMode

### FormattedTextOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/formattedtextoptions.md

**Inheritance:**
java.lang.Object
```
public class FormattedTextOptions
```

Provides the options which are used for formatted text extraction.

An instance of FormattedTextOptions class is used as parameter in Parser.getFormattedText(FormattedTextOptions)
and Parser.getFormattedText(int, FormattedTextOptions) methods. See the usage examples there.

**Learn more:**

* Extract formatted text from document
* Extract a document text as HTML
* Extract a document text as Markdown
* Extract a document text as Plain text

#### Constructors

| Constructor | Description |
| --- | --- |
| FormattedTextOptions() | Initializes a new instance of the FormattedTextOptions class with no mode set.
 |
| FormattedTextOptions(FormattedTextMode mode) | Initializes a new instance of the FormattedTextOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getMode() | Gets the formatted text extraction mode.
 |
| setMode(FormattedTextMode mode) | Sets the formatted text extraction mode.
 |
##### FormattedTextOptions()
```
public FormattedTextOptions()
```

Initializes a new instance of the FormattedTextOptions class with no mode set.

##### FormattedTextOptions(FormattedTextMode mode)
```
public FormattedTextOptions(FormattedTextMode mode)
```

Initializes a new instance of the FormattedTextOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mode | FormattedTextMode | The mode of formatted text extraction.
 |

##### getMode()
```
public FormattedTextMode getMode()
```

Gets the formatted text extraction mode.

**Returns:**
FormattedTextMode - FormattedTextMode enumeration that contains a formatted text extraction mode.

##### setMode(FormattedTextMode mode)
```
public void setMode(FormattedTextMode mode)
```

Sets the formatted text extraction mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mode | FormattedTextMode | FormattedTextMode enumeration that contains a formatted text extraction mode.
 |

### HighlightOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/highlightoptions.md

**Inheritance:**
java.lang.Object
```
public class HighlightOptions
```

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

An instance of HighlightOptions class is used as parameter in Parser.getHighlight(int, boolean, HighlightOptions) method.
See the usage examples there.

**Learn more:**

* Extract highlights

#### Constructors

| Constructor | Description |
| --- | --- |
| HighlightOptions() | Initializes a new instance of the HighlightOptions class with no limits set.
 |
| HighlightOptions(int maxLength) | Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.
 |
| HighlightOptions(Integer maxLength, boolean isLineLimited) | Initializes a new instance of the HighlightOptions class which is used to extract a line-limited highlight.
 |
| HighlightOptions(Integer maxLength, int wordCount) | Initializes a new instance of the HighlightOptions class which is used to extract a highlight with the fixed word count.
 |
| HighlightOptions(Integer maxLength, Integer wordCount, boolean isLineLimited) | Initializes a new instance of the HighlightOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getMaxLength() | Gets a maximum text length.
 |
| getWordCount() | Gets a maximum word count.
 |
| isLineLimited() | Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
 |
| setMaxLength(Integer maxLength) | Sets a maximum text length.
 |
| setWordCount(Integer wordCount) | Sets a maximum word count.
 |
| setLineLimited(boolean lineLimited) | Sets the value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
 |
##### HighlightOptions()
```
public HighlightOptions()
```

Initializes a new instance of the HighlightOptions class with no limits set. Set at least one of #setMaxLength(Integer).setMaxLength(Integer), #setWordCount(Integer).setWordCount(Integer), #setLineLimited(boolean).setLineLimited(boolean) before passing to the parser.

##### HighlightOptions(int maxLength)
```
public HighlightOptions(int maxLength)
```

Initializes a new instance of the HighlightOptions class which is used to extract a fixed-length highlight.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | int | The maximum text length.
 |

##### HighlightOptions(Integer maxLength, boolean isLineLimited)
```
public HighlightOptions(Integer maxLength, boolean isLineLimited)
```

Initializes a new instance of the HighlightOptions class which is used to extract a line-limited highlight.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | java.lang.Integer | The maximum text length.
 |
| isLineLimited | boolean | The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line.
 |

##### HighlightOptions(Integer maxLength, int wordCount)
```
public HighlightOptions(Integer maxLength, int wordCount)
```

Initializes a new instance of the HighlightOptions class which is used to extract a highlight with the fixed word count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | java.lang.Integer | The maximum text length.
 |
| wordCount | int | The maximum word count.
 |

##### HighlightOptions(Integer maxLength, Integer wordCount, boolean isLineLimited)
```
public HighlightOptions(Integer maxLength, Integer wordCount, boolean isLineLimited)
```

Initializes a new instance of the HighlightOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | java.lang.Integer | The maximum text length.
 |
| wordCount | java.lang.Integer | The maximum word count.
 |
| isLineLimited | boolean | The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line.
 |

##### getMaxLength()
```
public Integer getMaxLength()
```

Gets a maximum text length.

**Returns:**
java.lang.Integer - A positive integer value that represents the maximum text length;  null  if the text length isn't limited.

##### getWordCount()
```
public Integer getWordCount()
```

Gets a maximum word count.

**Returns:**
java.lang.Integer - A positive integer value that represents the maximum word count;  null  if the word count isn't limited.

##### isLineLimited()
```
public boolean isLineLimited()
```

Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.

**Returns:**
boolean -  true  if highlight extraction is limited by the start (or the end) of a text line; otherwise,  false .

##### setMaxLength(Integer maxLength)
```
public void setMaxLength(Integer maxLength)
```

Sets a maximum text length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | java.lang.Integer | A non-negative integer;  null  to remove the length limit.
 |

##### setWordCount(Integer wordCount)
```
public void setWordCount(Integer wordCount)
```

Sets a maximum word count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordCount | java.lang.Integer | A non-negative integer;  null  to remove the word-count limit.
 |

##### setLineLimited(boolean lineLimited)
```
public void setLineLimited(boolean lineLimited)
```

Sets the value that indicates whether highlight extraction is limited by the start (or the end) of a text line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lineLimited | boolean |  true  to limit by line bounds.
 |

### ICreatePageStream
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/icreatepagestream.md

### IDocumentInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/idocumentinfo.md

### ILogger
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ilogger.md

### ImageFormat
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/imageformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ImageFormat extends Enum<ImageFormat>
```

Defines a format of the image.

#### Fields

| Field | Description |
| --- | --- |
| Bmp | Bitmap image.
 |
| Gif | Graphical Interchange Format.
 |
| Jpeg | JPEG image.
 |
| Png | Portable Network Graphic.
 |
| WebP | WebP Image.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Bmp
```
public static final ImageFormat Bmp
```

Bitmap image.

##### Gif
```
public static final ImageFormat Gif
```

Graphical Interchange Format.

##### Jpeg
```
public static final ImageFormat Jpeg
```

JPEG image.

##### Png
```
public static final ImageFormat Png
```

Portable Network Graphic.

##### WebP
```
public static final ImageFormat WebP
```

WebP Image.

##### values()
```
public static ImageFormat[] values()
```

**Returns:**
com.groupdocs.parser.options.ImageFormat[]
##### valueOf(String name)
```
public static ImageFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ImageFormat

### ImageOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/imageoptions.md

**Inheritance:**
java.lang.Object
```
public final class ImageOptions
```

Provides the options which are used for image extraction.

An instance of ImageOptions class is used as parameter
in PageImageArea.getImageStream(ImageOptions) and
PageImageArea.save(String, ImageOptions) methods. See the usage examples there.

It's used to specify the image format for image extraction.

**Learn more:**

* Extract images from document page area
* Extract images to files

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageOptions(ImageFormat imageFormat) | Provides the options which are used for image extraction.
 |
#### Methods

| Method | Description |
| --- | --- |
| getImageFormat() | Gets the image format for image extraction.
 |
##### ImageOptions(ImageFormat imageFormat)
```
public ImageOptions(ImageFormat imageFormat)
```

Provides the options which are used for image extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFormat | ImageFormat | The format of the image.
 |

##### getImageFormat()
```
public ImageFormat getImageFormat()
```

Gets the image format for image extraction.

**Returns:**
ImageFormat - ImageFormat enumeration that contains an image format.

### IPreviewPageRender
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ipreviewpagerender.md

### IReleasePageStream
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ireleasepagestream.md

### LoadOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Provides the options which are used to open a file.

An instance of this class is used as parameter in Parser class constructors:

* Parser.Parser(java.io.InputStream, LoadOptions)
* Parser.Parser(String, LoadOptions)

See the usage examples there.

**Learn more:**

* Loading specific file formats
* Password-protected documents

#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions(Duration timeout) | Initializes a new instance of the LoadOptions class with  timeout .
 |
| LoadOptions() | Initializes a new instance of the LoadOptions class with empty  Password ,  FileFormat  equal to  FileFormat.Unknown  and default encodings.
 |
| LoadOptions(String password) | Initializes a new instance of the LoadOptions class with  FileFormat  equal to  FileFormat.Unknown  and default encodings.
 |
| LoadOptions(FileFormat fileFormat) | Initializes a new instance of the LoadOptions class with empty  Password  and default encodings.
 |
| LoadOptions(FileFormat fileFormat, String password) | Initializes a new instance of the LoadOptions class with default encodings.
 |
| LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset) | Initializes a new instance of the LoadOptions class with custom encodings.
 |
| LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout) | Initializes a new instance of the LoadOptions fully customized class.
 |
| LoadOptions(FileType fileType) | Initializes a new instance of the LoadOptions class with empty  Password  and default encodings.
 |
| LoadOptions(FileType fileType, String password) | Initializes a new instance of the LoadOptions class with password and default encodings.
 |
| LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset) | Initializes a new instance of the LoadOptions class with custom encodings.
 |
| LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout) | Initializes a new instance of the LoadOptions fully customized class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets the file format.
 |
| getFileType() | Gets the file type.
 |
| getPassword() | Gets the password.
 |
| getCharset() | Gets the encoding of the document.
 |
| getDefaultAnsiCharset() | Gets the default ANSI encoding which is used for encoding detection.
 |
| getTimeout() | Gets the value that represents the number of milliseconds to wait.
 |
##### LoadOptions(Duration timeout)
```
public LoadOptions(Duration timeout)
```

Initializes a new instance of the LoadOptions class with  timeout .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| timeout | java.time.Duration | The Duration that represents the number of milliseconds to wait.
 |

##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the LoadOptions class with empty  Password ,  FileFormat  equal to  FileFormat.Unknown  and default encodings.

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes a new instance of the LoadOptions class with  FileFormat  equal to  FileFormat.Unknown  and default encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password to open the password-protected file.
 |

##### LoadOptions(FileFormat fileFormat)
```
public LoadOptions(FileFormat fileFormat)
```

Initializes a new instance of the LoadOptions class with empty  Password  and default encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file.
 |

##### LoadOptions(FileFormat fileFormat, String password)
```
public LoadOptions(FileFormat fileFormat, String password)
```

Initializes a new instance of the LoadOptions class with default encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |

##### LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset)
```
public LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset)
```

Initializes a new instance of the LoadOptions class with custom encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |
| charset | java.nio.charset.Charset | The encoding of the document.
 |
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection.
 |

##### LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)
```
public LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)
```

Initializes a new instance of the LoadOptions fully customized class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |
| charset | java.nio.charset.Charset | The encoding of the document.
 |
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection.
 |
| timeout | java.time.Duration | The Duration that represents the number of milliseconds to wait.
 |

##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes a new instance of the LoadOptions class with empty  Password  and default encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file.
 |

##### LoadOptions(FileType fileType, String password)
```
public LoadOptions(FileType fileType, String password)
```

Initializes a new instance of the LoadOptions class with password and default encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |

##### LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset)
```
public LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset)
```

Initializes a new instance of the LoadOptions class with custom encodings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |
| charset | java.nio.charset.Charset | The encoding of the document.
 |
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection.
 |

##### LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)
```
public LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout)
```

Initializes a new instance of the LoadOptions fully customized class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file.
 |
| password | java.lang.String | The password to open the password-protected file.
 |
| charset | java.nio.charset.Charset | The encoding of the document.
 |
| defaultAnsiCharset | java.nio.charset.Charset | The default ANSI encoding which is used for encoding detection.
 |
| timeout | java.time.Duration | The Duration that represents the number of milliseconds to wait.
 |

##### getFileFormat()
```
public FileFormat getFileFormat()
```

Gets the file format.

**Returns:**
FileFormat - FileFormat enumeration that contains a file format.

##### getFileType()
```
public FileType getFileType()
```

Gets the file type.

**Returns:**
FileType - FileFormat enumeration that contains a file type.

##### getPassword()
```
public String getPassword()
```

Gets the password.

**Returns:**
java.lang.String - A string value that represents a password to open the password-protected file.

##### getCharset()
```
public Charset getCharset()
```

Gets the encoding of the document.

**Returns:**
java.nio.charset.Charset - An instance of  Charset  class that represents the document encoding;  null  if it isn't set.

##### getDefaultAnsiCharset()
```
public Charset getDefaultAnsiCharset()
```

Gets the default ANSI encoding which is used for encoding detection.

**Returns:**
java.nio.charset.Charset - An instance of  Charset  class that represents the document encoding;  null  if it isn't set.

##### getTimeout()
```
public Duration getTimeout()
```

Gets the value that represents the number of milliseconds to wait.

**Returns:**
java.time.Duration - An instance of Duration that represents the number of milliseconds to wait.

### OcrConnectorBase
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ocrconnectorbase.md

**Inheritance:**
java.lang.Object
```
public class OcrConnectorBase
```

Provides the OCR functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| OcrConnectorBase() | Initializes a new instance of the OcrConnectorBase class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isTextSupported() | Gets the value that indicates whether the text extraction is supported.
 |
| isTextAreasSupported() | Gets the value that indicates whether the text areas extraction is supported.
 |
| recognizeText(InputStream imageStream, OcrOptions options) | Recognize a text from  imageStream  stream.
 |
| recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options) | Recognize text areas from  imageStream  stream.
 |
##### OcrConnectorBase()
```
public OcrConnectorBase()
```

Initializes a new instance of the OcrConnectorBase class.

##### isTextSupported()
```
public boolean isTextSupported()
```

Gets the value that indicates whether the text extraction is supported.

**Returns:**
boolean -  true  if the text extraction is supported; otherwise,  false .

##### isTextAreasSupported()
```
public boolean isTextAreasSupported()
```

Gets the value that indicates whether the text areas extraction is supported.

**Returns:**
boolean -  true  if the text extraction areas is supported; otherwise,  false .

##### recognizeText(InputStream imageStream, OcrOptions options)
```
public String recognizeText(InputStream imageStream, OcrOptions options)
```

Recognize a text from  imageStream  stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | The image representation of the document page.
 |
| options | OcrOptions | The OCR options.
 |

**Returns:**
java.lang.String - A string that represents a recognized text;  null  if text recognizing isn't supported.

##### recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options)
```
public Iterable<PageTextArea> recognizeTextAreas(InputStream imageStream, Size pageSize, OcrOptions options)
```

Recognize text areas from  imageStream  stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | The image representation of the document page.
 |
| pageSize | Size | The size of the document page.
 |
| options | OcrOptions | The OCR options.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> - A collection of PageTextArea objects;  null  if text areas recognizing isn't supported.

### OcrEventHandler
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ocreventhandler.md

**Inheritance:**
java.lang.Object
```
public class OcrEventHandler
```

Provides a handler for OCR events.

#### Constructors

| Constructor | Description |
| --- | --- |
| OcrEventHandler() | Initializes a new instance of the OcrEventHandler class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWarnings() | Gets a list of warning messages.
 |
| hasWarnings() | Gets the value that indicates whether the list of warnings isn't empty.
 |
| getWarnings(int pageIndex) | Returns a list of warning messages for the page with  pageIndex .
 |
| onWarnings(int pageIndex, Iterable<String> warnings) | Sets warning messages for the page.
 |
##### OcrEventHandler()
```
public OcrEventHandler()
```

Initializes a new instance of the OcrEventHandler class.

##### getWarnings()
```
public List<String> getWarnings()
```

Gets a list of warning messages.

**Returns:**
java.util.List<java.lang.String> - A list of warning messages for all pages.

##### hasWarnings()
```
public boolean hasWarnings()
```

Gets the value that indicates whether the list of warnings isn't empty.

**Returns:**
boolean -  true  if the list of warnings isn't empty; otherwise,  false .

##### getWarnings(int pageIndex)
```
public List<String> getWarnings(int pageIndex)
```

Returns a list of warning messages for the page with  pageIndex .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.util.List<java.lang.String> - A list of warning messages for the page; empty list if no warning messages for the page.

##### onWarnings(int pageIndex, Iterable<String> warnings)
```
public void onWarnings(int pageIndex, Iterable<String> warnings)
```

Sets warning messages for the page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| warnings | java.lang.Iterable<java.lang.String> | The list of warning messages for the page.
 |

### OcrOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/ocroptions.md

**Inheritance:**
java.lang.Object
```
public class OcrOptions
```

Provides the options which are used for OCR Connector.

#### Constructors

| Constructor | Description |
| --- | --- |
| OcrOptions() | Initializes a new instance of the OcrOptions class with default values.
 |
| OcrOptions(Rectangle rectangle) | Initializes a new instance of the OcrOptions class with rectangular area.
 |
| OcrOptions(PagePreviewOptions pagePreviewOptions) | Initializes a new instance of the OcrOptions class with page preview options.
 |
| OcrOptions(OcrEventHandler handler) | Initializes a new instance of the OcrOptions class with OcrEventHandler object.
 |
| OcrOptions(Rectangle rectangle, OcrEventHandler handler) | Initializes a new instance of the OcrOptions class with rectangular area and OcrEventHandler object.
 |
| OcrOptions(Rectangle rectangle, OcrEventHandler handler, boolean useSpellCheker) | Initializes a new instance of the OcrOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that constraints the page area which is used for text recognizing.
 |
| getHandler() | Gets the event handler to catch OCR events.
 |
| getUseSpellChecker() | Gets the value that indicates whether the spell checker is used.
 |
| getPagePreviewOptions() | Gets the page preview options used to render the page that is fed to the OCR engine.
 |
| setPagePreviewOptions(PagePreviewOptions pagePreviewOptions) | Sets the page preview options used to render the page that is fed to the OCR engine.
 |
| getLanguage() | Gets the language used for optical character recognition.
 |
| setLanguage(Language language) | Sets the language used for optical character recognition.
 |
| setRectangle(Rectangle rectangle) | Sets the rectangular area that constraints the page area which is used for text recognizing.
 |
| setHandler(OcrEventHandler handler) | Sets the event handler to catch OCR events.
 |
| setUseSpellChecker(boolean useSpellChecker) | Sets the value that indicates whether the spell checker is used.
 |
##### OcrOptions()
```
public OcrOptions()
```

Initializes a new instance of the OcrOptions class with default values.

##### OcrOptions(Rectangle rectangle)
```
public OcrOptions(Rectangle rectangle)
```

Initializes a new instance of the OcrOptions class with rectangular area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing.
 |

##### OcrOptions(PagePreviewOptions pagePreviewOptions)
```
public OcrOptions(PagePreviewOptions pagePreviewOptions)
```

Initializes a new instance of the OcrOptions class with page preview options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagePreviewOptions | PagePreviewOptions | The options used to render the page preview which is fed to the OCR engine.
 |

##### OcrOptions(OcrEventHandler handler)
```
public OcrOptions(OcrEventHandler handler)
```

Initializes a new instance of the OcrOptions class with OcrEventHandler object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| handler | OcrEventHandler | An instance of OcrEventHandler to catch OCR events.
 |

##### OcrOptions(Rectangle rectangle, OcrEventHandler handler)
```
public OcrOptions(Rectangle rectangle, OcrEventHandler handler)
```

Initializes a new instance of the OcrOptions class with rectangular area and OcrEventHandler object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing.
 |
| handler | OcrEventHandler | An instance of OcrEventHandler to catch OCR events.
 |

##### OcrOptions(Rectangle rectangle, OcrEventHandler handler, boolean useSpellCheker)
```
public OcrOptions(Rectangle rectangle, OcrEventHandler handler, boolean useSpellCheker)
```

Initializes a new instance of the OcrOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing.
 |
| handler | OcrEventHandler | An instance of OcrEventHandler to catch OCR events.
 |
| useSpellCheker | boolean | The value that indicates whether the spell checker is used.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that constraints the page area which is used for text recognizing.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that constraints the page area which is used for text recognizing;  null  if it isn't set.

##### getHandler()
```
public OcrEventHandler getHandler()
```

Gets the event handler to catch OCR events.

**Returns:**
OcrEventHandler - An instance of OcrEventHandler class which is used to catch OCR events.

##### getUseSpellChecker()
```
public boolean getUseSpellChecker()
```

Gets the value that indicates whether the spell checker is used.

**Returns:**
boolean -  true  if the spell checker is used; otherwise,  false .

##### getPagePreviewOptions()
```
public PagePreviewOptions getPagePreviewOptions()
```

Gets the page preview options used to render the page that is fed to the OCR engine.

**Returns:**
PagePreviewOptions - The PagePreviewOptions, or  null  if not set.

##### setPagePreviewOptions(PagePreviewOptions pagePreviewOptions)
```
public void setPagePreviewOptions(PagePreviewOptions pagePreviewOptions)
```

Sets the page preview options used to render the page that is fed to the OCR engine.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pagePreviewOptions | PagePreviewOptions | The page preview options.
 |

##### getLanguage()
```
public Language getLanguage()
```

Gets the language used for optical character recognition.

**Returns:**
Language - The Language enum value. Defaults to Language.Eng.

##### setLanguage(Language language)
```
public void setLanguage(Language language)
```

Sets the language used for optical character recognition.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| language | Language | The Language enum value.
 |

##### setRectangle(Rectangle rectangle)
```
public void setRectangle(Rectangle rectangle)
```

Sets the rectangular area that constraints the page area which is used for text recognizing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangle, or  null  to scan the whole page.
 |

##### setHandler(OcrEventHandler handler)
```
public void setHandler(OcrEventHandler handler)
```

Sets the event handler to catch OCR events.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| handler | OcrEventHandler | The event handler.
 |

##### setUseSpellChecker(boolean useSpellChecker)
```
public void setUseSpellChecker(boolean useSpellChecker)
```

Sets the value that indicates whether the spell checker is used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useSpellChecker | boolean |  true  to enable spell checking.
 |

### PageAreaOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/pageareaoptions.md

**Inheritance:**
java.lang.Object
```
public class PageAreaOptions
```

Provides the options which are used for page areas extraction.

An instance of PageAreaOptions class is used as parameter in Parser.getImages(PageAreaOptions)
and Parser.getImages(int, PageAreaOptions) methods. See the usage examples there.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageAreaOptions(Rectangle rectangle) | Initializes a new instance of the PageAreaOptions class with the size of the ignored border.
 |
| PageAreaOptions(Rectangle rectangle, double rectangleTolerance) | Initializes a new instance of the PageAreaOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that contains page areas.
 |
| getRectangleTolerance() | Gets the size of the border that is ignored when captured by the rectangular area.
 |
##### PageAreaOptions(Rectangle rectangle)
```
public PageAreaOptions(Rectangle rectangle)
```

Initializes a new instance of the PageAreaOptions class with the size of the ignored border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |

##### PageAreaOptions(Rectangle rectangle, double rectangleTolerance)
```
public PageAreaOptions(Rectangle rectangle, double rectangleTolerance)
```

Initializes a new instance of the PageAreaOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |
| rectangleTolerance | double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains page areas.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains page areas;  null  if it isn't set.

##### getRectangleTolerance()
```
public double getRectangleTolerance()
```

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

**Returns:**
double - The double value from 0 (no border) to 1 (ignore the whole element).

### PageInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Represents the document page information.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo(int pageNumber, int width, int height) | Initializes a new instance of the PageInfo class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets the page number.
 |
| getWidth() | Gets the page width.
 |
| getHeight() | Gets the page height.
 |
##### PageInfo(int pageNumber, int width, int height)
```
public PageInfo(int pageNumber, int width, int height)
```

Initializes a new instance of the PageInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The page number.
 |
| width | int | The page width.
 |
| height | int | The page height.
 |

##### getPageNumber()
```
public int getPageNumber()
```

Gets the page number.

**Returns:**
int - A zero-based integer value that represents the page number.

##### getWidth()
```
public int getWidth()
```

Gets the page width.

**Returns:**
int - An integer value that represents the page width.

##### getHeight()
```
public int getHeight()
```

Gets the page height.

**Returns:**
int - An integer value that represents the page height.

### PageRenderInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/pagerenderinfo.md

**Inheritance:**
java.lang.Object
```
public class PageRenderInfo
```

Represents the information of how a page is rendered.

Some documents (spreadsheets, for example) are not possible to render a page
as a single image. For those documents a page is rendered as a set of tiles.
These tiles are placed in the rectangular table.

RowCount
 and
ColumnCount
 represent the total number of rows and columns
of this table. If document page is rendered to the single image these properties are equal to 1.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageRenderInfo(int pageNumber, int rowCount, int columnCount) | Initializes a new instance of the PageRenderInfo class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets the page number.
 |
| getRowCount() | Get the total number of tiles rows.
 |
| getColumnCount() | Get the total number of tiles columns.
 |
| getColumn(int tileIndex) | Returns the index of column where the tile with  tileIndex  is placed.
 |
| getRow(int tileIndex) | Returns the index of row where the tile with  tileIndex  is placed.
 |
##### PageRenderInfo(int pageNumber, int rowCount, int columnCount)
```
public PageRenderInfo(int pageNumber, int rowCount, int columnCount)
```

Initializes a new instance of the PageRenderInfo class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page (starts with 1).
 |
| rowCount | int | The total number of tiles rows.
 |
| columnCount | int | The total number of tiles columns.
 |

##### getPageNumber()
```
public int getPageNumber()
```

Gets the page number.

**Returns:**
int - The integer value that represents the page number (starts with 1).

##### getRowCount()
```
public int getRowCount()
```

Get the total number of tiles rows.

**Returns:**
int - The integer value that represents the total number of tiles rows.

##### getColumnCount()
```
public int getColumnCount()
```

Get the total number of tiles columns.

**Returns:**
int - The integer value that represents the total number of tiles columns.

##### getColumn(int tileIndex)
```
public int getColumn(int tileIndex)
```

Returns the index of column where the tile with  tileIndex  is placed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tileIndex | int | The zero-based index of the tile.
 |

**Returns:**
int - The zero-based integer value that represents the column index.

##### getRow(int tileIndex)
```
public int getRow(int tileIndex)
```

Returns the index of row where the tile with  tileIndex  is placed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tileIndex | int | The zero-based index of the tile.
 |

**Returns:**
int - The zero-based integer value that represents the row index.

### PageTableAreaOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/pagetableareaoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.PageAreaOptions
```
public class PageTableAreaOptions extends PageAreaOptions
```

Provides the options which are used for page table areas extraction.

#### Constructors

| Constructor | Description |
| --- | --- |
| PageTableAreaOptions(TemplateTableLayout tableLayout) | Initializes a new instance of the PageTableAreaOptions class.
 |
| PageTableAreaOptions(Rectangle rectangle) | Initializes a new instance of the PageTableAreaOptions class with a search rectangle and no fixed layout.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTableLayout() | Gets the table layout which defines the table on a page.
 |
##### PageTableAreaOptions(TemplateTableLayout tableLayout)
```
public PageTableAreaOptions(TemplateTableLayout tableLayout)
```

Initializes a new instance of the PageTableAreaOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tableLayout | TemplateTableLayout | The table layout which defines the table on a page.
 |

##### PageTableAreaOptions(Rectangle rectangle)
```
public PageTableAreaOptions(Rectangle rectangle)
```

Initializes a new instance of the PageTableAreaOptions class with a search rectangle and no fixed layout.

Useful for restricting auto-detected tables to a region of the page. Mirrors the C#

new PageTableAreaOptions(null) { Rectangle = ... }
 pattern.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area on the page where tables should be detected; pass  null  to search the entire page.
 |

##### getTableLayout()
```
public TemplateTableLayout getTableLayout()
```

Gets the table layout which defines the table on a page.

**Returns:**
TemplateTableLayout - An instane of TemplateTableLayout class.

### PageTextAreaOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/pagetextareaoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.PageAreaOptions
```
public class PageTextAreaOptions extends PageAreaOptions
```

Provides the options which are used for page text areas extraction.

An instance of PageTextAreaOptions class is used as parameter in Parser.getTextAreas(PageTextAreaOptions)
and Parser.getTextAreas(int, PageTextAreaOptions) methods. See the usage examples there.

**Learn more:**

* Extract text areas

#### Constructors

| Constructor | Description |
| --- | --- |
| PageTextAreaOptions() | Initializes a new instance of the PageTextAreaOptions class with default values.
 |
| PageTextAreaOptions(boolean useOcr) | Initializes a new instance of the TextOptions class with the OCR usage option.
 |
| PageTextAreaOptions(boolean useOcr, OcrOptions ocrOptions) | Initializes a new instance of the TextOptions class with the ability to set OCR options.
 |
| PageTextAreaOptions(String expression) | Initializes a new instance of the PageTextAreaOptions class with the regular expression.
 |
| PageTextAreaOptions(String expression, Rectangle rectangle) | Initializes a new instance of the PageTextAreaOptions class with the regular expression and rectangular area.
 |
| PageTextAreaOptions(String expression, Rectangle rectangle, double rectangleTolerance) | Initializes a new instance of the PageTextAreaOptions class with the regular expression, rectangular area and the size of the ignored border.
 |
| PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle) | Initializes a new instance of the PageTextAreaOptions class.
 |
| PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle, double rectangleTolerance) | Initializes a new instance of the PageTextAreaOptions class with the size of the ignored border.
 |
#### Methods

| Method | Description |
| --- | --- |
| getExpression() | Gets the regular expression.
 |
| isMatchCase() | Gets the value that indicates whether a text case isn't ignored.
 |
| isUniteSegments() | Gets the value that indicates whether segments are united.
 |
| isIgnoreFormatting() | Gets the value that indicates whether text formatting is ignored.
 |
| isUseOcr() | Gets the value that indicates whether the OCR Connector is used to extract a text.
 |
| getOcrOptions() | Gets the additional options for OCR functionality.
 |
##### PageTextAreaOptions()
```
public PageTextAreaOptions()
```

Initializes a new instance of the PageTextAreaOptions class with default values.

##### PageTextAreaOptions(boolean useOcr)
```
public PageTextAreaOptions(boolean useOcr)
```

Initializes a new instance of the TextOptions class with the OCR usage option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useOcr | boolean | The value that indicates whether the OCR functionality is used to extract a text.
 |

##### PageTextAreaOptions(boolean useOcr, OcrOptions ocrOptions)
```
public PageTextAreaOptions(boolean useOcr, OcrOptions ocrOptions)
```

Initializes a new instance of the TextOptions class with the ability to set OCR options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useOcr | boolean | The value that indicates whether the OCR functionality is used to extract a text.
 |
| ocrOptions | OcrOptions | The additional options for OCR functionality.
 |

##### PageTextAreaOptions(String expression)
```
public PageTextAreaOptions(String expression)
```

Initializes a new instance of the PageTextAreaOptions class with the regular expression. Other options are set by default (see remarks for details).

The following properties have default values:

* MatchCase:  false
* UniteSegments:  false
* IgnoreFormatting:  false
* Rectangle:  null

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |

##### PageTextAreaOptions(String expression, Rectangle rectangle)
```
public PageTextAreaOptions(String expression, Rectangle rectangle)
```

Initializes a new instance of the PageTextAreaOptions class with the regular expression and rectangular area. Other options are set by default (see remarks for details).

The following properties have default values:

* MatchCase:  false
* UniteSegments:  false
* IgnoreFormatting:  false

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |

##### PageTextAreaOptions(String expression, Rectangle rectangle, double rectangleTolerance)
```
public PageTextAreaOptions(String expression, Rectangle rectangle, double rectangleTolerance)
```

Initializes a new instance of the PageTextAreaOptions class with the regular expression, rectangular area and the size of the ignored border. Other options are set by default (see remarks for details).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |
| rectangleTolerance | double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
 |

##### PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle)
```
public PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle)
```

Initializes a new instance of the PageTextAreaOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| uniteSegments | boolean | The value that indicates whether segments are united.
 |
| ignoreFormatting | boolean | The value that indicates whether text formatting is ignored.
 |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |

##### PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle, double rectangleTolerance)
```
public PageTextAreaOptions(String expression, boolean matchCase, boolean uniteSegments, boolean ignoreFormatting, Rectangle rectangle, double rectangleTolerance)
```

Initializes a new instance of the PageTextAreaOptions class with the size of the ignored border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| uniteSegments | boolean | The value that indicates whether segments are united.
 |
| ignoreFormatting | boolean | The value that indicates whether text formatting is ignored.
 |
| rectangle | Rectangle | The rectangular area that contains page areas.
 |
| rectangleTolerance | double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
 |

##### getExpression()
```
public String getExpression()
```

Gets the regular expression.

**Returns:**
java.lang.String - A string that represents the regular expression.

##### isMatchCase()
```
public boolean isMatchCase()
```

Gets the value that indicates whether a text case isn't ignored.

**Returns:**
boolean -  true  if a text case isn't ignored; otherwise,  false .

##### isUniteSegments()
```
public boolean isUniteSegments()
```

Gets the value that indicates whether segments are united.

**Returns:**
boolean - {code true} if segments are united; otherwise, {code false}.

##### isIgnoreFormatting()
```
public boolean isIgnoreFormatting()
```

Gets the value that indicates whether text formatting is ignored.

**Returns:**
boolean -  true  if text formatting is ignored; otherwise,  false .

##### isUseOcr()
```
public boolean isUseOcr()
```

Gets the value that indicates whether the OCR Connector is used to extract a text.

**Returns:**
boolean -  true  if the OCR functionality is used; otherwise,  false .

##### getOcrOptions()
```
public OcrOptions getOcrOptions()
```

Gets the additional options for OCR functionality.

**Returns:**
OcrOptions - An instance of OcrOptions class with the additional OCR options.

### ParserSettings
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/parsersettings.md

**Inheritance:**
java.lang.Object
```
public class ParserSettings
```

Provides the settings which are used to customize data extraction.

**Learn more:**

* Logging

#### Constructors

| Constructor | Description |
| --- | --- |
| ParserSettings(ILogger logger) | Initializes a new instance of the ParserSettings class with the logger.
 |
| ParserSettings(OcrConnectorBase ocrConnector) | Initializes a new instance of the ParserSettings class with the OCR Connector.
 |
| ParserSettings(ExternalResourceHandler externalResourceHandler) | Initializes a new instance of the ParserSettings class with the External Resource Handler.
 |
| ParserSettings(ILogger logger, OcrConnectorBase ocrConnector) | Initializes a new instance of the ParserSettings class with logger and OCR Connector.
 |
| ParserSettings(ILogger logger, OcrConnectorBase ocrConnector, ExternalResourceHandler externalResourceHandler) | Initializes a new instance of the ParserSettings class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Gets the logger which is used for logging events and errors during data extraction.
 |
| getOcrConnector() | Gets the OCR Connector which is used to provide OCR functionality.
 |
| getExternalResourceHandler() | Gets the handler for external resources.
 |
##### ParserSettings(ILogger logger)
```
public ParserSettings(ILogger logger)
```

Initializes a new instance of the ParserSettings class with the logger.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements ILogger interface.
 |

##### ParserSettings(OcrConnectorBase ocrConnector)
```
public ParserSettings(OcrConnectorBase ocrConnector)
```

Initializes a new instance of the ParserSettings class with the OCR Connector.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | OcrConnectorBase | An instance of class that inherits OcrConnectorBase class to provide OCR functionality.
 |

##### ParserSettings(ExternalResourceHandler externalResourceHandler)
```
public ParserSettings(ExternalResourceHandler externalResourceHandler)
```

Initializes a new instance of the ParserSettings class with the External Resource Handler.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| externalResourceHandler | ExternalResourceHandler | An instance of class that inherits OcrConnectorBase class to provide OCR functionality.
 |

##### ParserSettings(ILogger logger, OcrConnectorBase ocrConnector)
```
public ParserSettings(ILogger logger, OcrConnectorBase ocrConnector)
```

Initializes a new instance of the ParserSettings class with logger and OCR Connector.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements ILogger interface.
 |
| ocrConnector | OcrConnectorBase | An instance of class that inherits OcrConnectorBase class to provide OCR functionality.
 |

##### ParserSettings(ILogger logger, OcrConnectorBase ocrConnector, ExternalResourceHandler externalResourceHandler)
```
public ParserSettings(ILogger logger, OcrConnectorBase ocrConnector, ExternalResourceHandler externalResourceHandler)
```

Initializes a new instance of the ParserSettings class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements ILogger interface.
 |
| ocrConnector | OcrConnectorBase | An instance of class that inherits OcrConnectorBase class to provide OCR functionality.
 |
| externalResourceHandler | ExternalResourceHandler | An instance of class that inherits ExternalResourceHandler class to provide the control of external resource loading.
 |

##### getLogger()
```
public ILogger getLogger()
```

Gets the logger which is used for logging events and errors during data extraction.

**Returns:**
ILogger - An instance of class that implements ILogger interface.

##### getOcrConnector()
```
public OcrConnectorBase getOcrConnector()
```

Gets the OCR Connector which is used to provide OCR functionality.

**Returns:**
OcrConnectorBase - An instance of class that inherits OcrConnectorBase class to provide OCR functionality.

##### getExternalResourceHandler()
```
public ExternalResourceHandler getExternalResourceHandler()
```

Gets the handler for external resources.

**Returns:**
ExternalResourceHandler - An instance of class that inherits ExternalResourceHandler class to provide the control of external resource loading.

### PreviewFormats
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/previewformats.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PreviewFormats extends Enum<PreviewFormats>
```

Represents supported preview formats.

#### Fields

| Field | Description |
| --- | --- |
| Png | Portable Network Graphics Format.
 |
| Jpeg | Joint Photographic Experts Group Format.
 |
| Bmp | Bitmap Picture Format.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Png
```
public static final PreviewFormats Png
```

Portable Network Graphics Format.

##### Jpeg
```
public static final PreviewFormats Jpeg
```

Joint Photographic Experts Group Format.

##### Bmp
```
public static final PreviewFormats Bmp
```

Bitmap Picture Format.

##### values()
```
public static PreviewFormats[] values()
```

**Returns:**
com.groupdocs.parser.options.PreviewFormats[]
##### valueOf(String name)
```
public static PreviewFormats valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PreviewFormats

### PreviewOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation.

#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the PreviewOptions class causing the output stream to be closed.
 |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of PreviewOptions class causing the output stream to be returned to the client for further use.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the page preview width.
 |
| setWidth(int width) | Sets the page preview width.
 |
| getHeight() | Gets the page preview height.
 |
| setHeight(int height) | Sets the page preview height.
 |
| getDpi() | Gets a dpi.
 |
| setDpi(int dpi) | Sets a dpi.
 |
| getPageNumbers() | Gets an array of page numbers to generate previews.
 |
| setPageNumbers(int[] pageNumbers) | Sets an array of page numbers to generate previews.
 |
| getPreviewFormat() | Gets the preview image format.
 |
| setPreviewFormat(PreviewFormats previewFormat) | Sets the preview image format.
 |
| getCreatePageStream() | Gets an instance of the page stream creation delegate.
 |
| setCreatePageStream(ICreatePageStream createPageStream) | Sets an instance of the page stream creation delegate.
 |
| getReleasePageStream() | Gets an instance of the page preview completion delegate.
 |
| setReleasePageStream(IReleasePageStream releasePageStream) | Sets an instance of the page preview completion delegate.
 |
| getPreviewPageRender() | Gets an instance of the page preview render info delegate.
 |
| setPreviewPageRender(IPreviewPageRender previewPageRender) | Sets an instance of the page preview render info delegate.
 |
##### PreviewOptions(ICreatePageStream createPageStream)
```
public PreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the PreviewOptions class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview.
 |

##### PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of PreviewOptions class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview
 |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream.
 |

##### getWidth()
```
public int getWidth()
```

Gets the page preview width.

**Returns:**
int - The page width.

##### setWidth(int width)
```
public void setWidth(int width)
```

Sets the page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The page width.
 |

##### getHeight()
```
public int getHeight()
```

Gets the page preview height.

**Returns:**
int - The page height.

##### setHeight(int height)
```
public void setHeight(int height)
```

Sets the page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | The page height.
 |

##### getDpi()
```
public int getDpi()
```

Gets a dpi.

**Returns:**
int - An integer value that represents a dpi.

##### setDpi(int dpi)
```
public void setDpi(int dpi)
```

Sets a dpi.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dpi | int | The dpi.
 |

##### getPageNumbers()
```
public int[] getPageNumbers()
```

Gets an array of page numbers to generate previews.

**Returns:**
int[] - A collection of page numbers.

##### setPageNumbers(int[] pageNumbers)
```
public void setPageNumbers(int[] pageNumbers)
```

Sets an array of page numbers to generate previews.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumbers | int[] | A collection of page numbers.
 |

##### getPreviewFormat()
```
public PreviewFormats getPreviewFormat()
```

Gets the preview image format.

**Returns:**
PreviewFormats - PreviewFormats numeration.

##### setPreviewFormat(PreviewFormats previewFormat)
```
public void setPreviewFormat(PreviewFormats previewFormat)
```

Sets the preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewFormat | PreviewFormats | The preview format.
 |

##### getCreatePageStream()
```
public ICreatePageStream getCreatePageStream()
```

Gets an instance of the page stream creation delegate.

**Returns:**
ICreatePageStream - The page stream creation delegate.

##### setCreatePageStream(ICreatePageStream createPageStream)
```
public void setCreatePageStream(ICreatePageStream createPageStream)
```

Sets an instance of the page stream creation delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | The page stream creation delegate.
 |

##### getReleasePageStream()
```
public IReleasePageStream getReleasePageStream()
```

Gets an instance of the page preview completion delegate.

**Returns:**
IReleasePageStream - The page preview completion delegate.

##### setReleasePageStream(IReleasePageStream releasePageStream)
```
public void setReleasePageStream(IReleasePageStream releasePageStream)
```

Sets an instance of the page preview completion delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| releasePageStream | IReleasePageStream | The page preview completion delegate.
 |

##### getPreviewPageRender()
```
public IPreviewPageRender getPreviewPageRender()
```

Gets an instance of the page preview render info delegate.

**Returns:**
IPreviewPageRender - The page preview render info delegate.

##### setPreviewPageRender(IPreviewPageRender previewPageRender)
```
public void setPreviewPageRender(IPreviewPageRender previewPageRender)
```

Sets an instance of the page preview render info delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewPageRender | IPreviewPageRender | The page preview render info delegate.
 |

### QualityMode
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/qualitymode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum QualityMode extends Enum<QualityMode>
```

Defines a level of the quality.

#### Fields

| Field | Description |
| --- | --- |
| High | Hight quality.
 |
| Normal | Normal quality.
 |
| Low | Low quality.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### High
```
public static final QualityMode High
```

Hight quality. Fast processing algorithms are used.

##### Normal
```
public static final QualityMode Normal
```

Normal quality. Default processing algorithms are used.

##### Low
```
public static final QualityMode Low
```

Low quality. Slow processing algorithms are used.

##### values()
```
public static QualityMode[] values()
```

**Returns:**
com.groupdocs.parser.options.QualityMode[]
##### valueOf(String name)
```
public static QualityMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
QualityMode

### SearchOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/searchoptions.md

**Inheritance:**
java.lang.Object
```
public class SearchOptions
```

Provides the options which are used for text search.

An instance of SearchOptions class is used as parameter in Parser.search(String, SearchOptions) method.
See the usage examples there.

**Learn more:**

* Search text
* Search text in Microsoft Office Word documents
* Search text in Microsoft Office Excel spreadsheets
* Search text in Microsoft Office PowerPoint presentations
* Search text in PDF documents
* Search text in Emails
* Search text in EPUB eBooks
* Search text in HTML documents
* Search text in Microsoft OneNote sections

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) | Initializes a new instance of the SearchOptions class.
 |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, int maxPageIndex, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) | Initializes a new instance of the SearchOptions class.
 |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions) | Initializes a new instance of the SearchOptions class which is used to search with the highlight options for the left and the right highlight extraction.
 |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions highlightOptions) | Initializes a new instance of the SearchOptions class which is used to search with the same highlight options for the left and the right highlight extraction.
 |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression) | Initializes a new instance of the SearchOptions class which is used to search without highlight extraction.
 |
| SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages) | Initializes a new instance of the SearchOptions class which is used to search by pages and without highlight extraction.
 |
| SearchOptions() | Initializes a new instance of the SearchOptions class with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| isMatchCase() | Gets the value that indicates whether a text case isn't ignored.
 |
| isMatchWholeWord() | Gets the value that indicates whether text search is limited by a whole word.
 |
| isUseRegularExpression() | Gets the value that indicates whether a regular expression is used.
 |
| isSearchByPages() | Gets the value that indicates whether the search is performed by pages.
 |
| getLeftHighlightOptions() | Gets the options for the left highlight.
 |
| getRightHighlightOptions() | Gets the options for the right highlight.
 |
| getMaxPageIndex() | Gets the value that represents the max index of the page to search.
 |
##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```

Initializes a new instance of the SearchOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |
| searchByPages | boolean | The value that indicates whether the search is performed by pages.
 |
| leftHighlightOptions | HighlightOptions | The options for the left highlight.
 |
| rightHighlightOptions | HighlightOptions | The options for the right highlight.
 |

##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, int maxPageIndex, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, int maxPageIndex, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```

Initializes a new instance of the SearchOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |
| maxPageIndex | int | The value that represents the max index of the page to search
 |
| leftHighlightOptions | HighlightOptions | The options for the left highlight.
 |
| rightHighlightOptions | HighlightOptions | The options for the right highlight.
 |

##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```

Initializes a new instance of the SearchOptions class which is used to search with the highlight options for the left and the right highlight extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |
| leftHighlightOptions | HighlightOptions | The options for the left highlight.
 |
| rightHighlightOptions | HighlightOptions | The options for the right highlight.
 |

##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions highlightOptions)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, HighlightOptions highlightOptions)
```

Initializes a new instance of the SearchOptions class which is used to search with the same highlight options for the left and the right highlight extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |
| highlightOptions | HighlightOptions | The options for both highlights.
 |

##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression)
```

Initializes a new instance of the SearchOptions class which is used to search without highlight extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |

##### SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages)
```
public SearchOptions(boolean matchCase, boolean matchWholeWord, boolean useRegularExpression, boolean searchByPages)
```

Initializes a new instance of the SearchOptions class which is used to search by pages and without highlight extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |
| matchWholeWord | boolean | The value that indicates whether text search is limited by a whole word.
 |
| useRegularExpression | boolean | The value that indicates whether a regular expression is used.
 |
| searchByPages | boolean | The value that indicates whether the search is performed by pages.
 |

##### SearchOptions()
```
public SearchOptions()
```

Initializes a new instance of the SearchOptions class with default values. See remarks for details.

The following properties have default values:

* MatchCase:  false
* MatchWholeWord:  false
* UseRegularExpression:  false
* LeftHighlightOptions:  null
* RightHighlightOptions:  null

##### isMatchCase()
```
public boolean isMatchCase()
```

Gets the value that indicates whether a text case isn't ignored.

**Returns:**
boolean -  true  if a text case isn't ignored; otherwise,  false .

##### isMatchWholeWord()
```
public boolean isMatchWholeWord()
```

Gets the value that indicates whether text search is limited by a whole word.

**Returns:**
boolean -  true  if text search is limited by a whole word; otherwise,  false .

##### isUseRegularExpression()
```
public boolean isUseRegularExpression()
```

Gets the value that indicates whether a regular expression is used.

**Returns:**
boolean -  true  if a regular expression is used; otherwise,  false .

##### isSearchByPages()
```
public boolean isSearchByPages()
```

Gets the value that indicates whether the search is performed by pages.

**Returns:**
boolean -  true  if the search is performed by pages; otherwise,  false  and the search is performed on the whole document without including SearchResult.getPageIndex() property value in SearchResult class.

##### getLeftHighlightOptions()
```
public HighlightOptions getLeftHighlightOptions()
```

Gets the options for the left highlight.

**Returns:**
HighlightOptions - An instance of HighlightOptions class;  nill  if it isn't set.

##### getRightHighlightOptions()
```
public HighlightOptions getRightHighlightOptions()
```

Gets the options for the right highlight.

**Returns:**
HighlightOptions - An instance of HighlightOptions class;  nill  if it isn't set.

##### getMaxPageIndex()
```
public int getMaxPageIndex()
```

Gets the value that represents the max index of the page to search.

**Returns:**
int - An integer value that represents the max index of the page to search; -1 if not set;

### TextDocumentInfo
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/textdocumentinfo.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.options.DocumentInfo
```
public abstract class TextDocumentInfo extends DocumentInfo
```

Represents the text document information.

**Learn more:**

* Get document info
* Detect encoding

#### Constructors

| Constructor | Description |
| --- | --- |
| TextDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getCharset() | Gets the detected encoding of the text document.
 |
##### TextDocumentInfo()
```
public TextDocumentInfo()
```

##### getCharset()
```
public abstract Charset getCharset()
```

Gets the detected encoding of the text document.

**Returns:**
java.nio.charset.Charset - An instance of  Charset  class.

### TextOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.options/textoptions.md

**Inheritance:**
java.lang.Object
```
public class TextOptions
```

Provides the options which are used for text extraction.

An instance of TextOptions class is used as parameter in Parser.getText(TextOptions)
and Parser.getText(int, TextOptions) methods. See the usage examples there.

It's used to specify the raw mode of text extraction. A text in this mode is extracted in a non-accurate
way but faster than in the standard mode. If the raw mode doesn't support the document format,
then this parameter is ignored and the standard mode is used.

**Learn more:**

* Extract text in Raw Mode
* Extract text in Accurate Mode

#### Constructors

| Constructor | Description |
| --- | --- |
| TextOptions(boolean useRawModeIfPossible) | Initializes a new instance of the TextOptions class.
 |
| TextOptions(boolean useRawModeIfPossible, boolean useOcr) | Initializes a new instance of the TextOptions class with the OCR usage option.
 |
| TextOptions(boolean useRawModeIfPossible, boolean useOcr, OcrOptions ocrOptions) | Initializes a new instance of the TextOptions class with the ability to set OCR options.
 |
#### Methods

| Method | Description |
| --- | --- |
| isUseRawModeIfPossible() | Gets the value that indicates whether the raw mode is used.
 |
| isUseOcr() | Gets the value that indicates whether the OCR Connector is used to extract a text.
 |
| getOcrOptions() | Gets the additional options for OCR functionality.
 |
##### TextOptions(boolean useRawModeIfPossible)
```
public TextOptions(boolean useRawModeIfPossible)
```

Initializes a new instance of the TextOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | boolean | The value that indicates whether the raw mode is used.
 |

##### TextOptions(boolean useRawModeIfPossible, boolean useOcr)
```
public TextOptions(boolean useRawModeIfPossible, boolean useOcr)
```

Initializes a new instance of the TextOptions class with the OCR usage option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | boolean | The value that indicates whether the raw mode is used.
 |
| useOcr | boolean | The value that indicates whether the OCR functionality is used to extract a text.
 |

##### TextOptions(boolean useRawModeIfPossible, boolean useOcr, OcrOptions ocrOptions)
```
public TextOptions(boolean useRawModeIfPossible, boolean useOcr, OcrOptions ocrOptions)
```

Initializes a new instance of the TextOptions class with the ability to set OCR options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | boolean | The value that indicates whether the raw mode is used.
 |
| useOcr | boolean | The value that indicates whether the OCR functionality is used to extract a text.
 |
| ocrOptions | OcrOptions | The additional options for OCR functionality.
 |

##### isUseRawModeIfPossible()
```
public boolean isUseRawModeIfPossible()
```

Gets the value that indicates whether the raw mode is used.

**Returns:**
boolean -  true  if the raw mode is used; otherwise,  false .

##### isUseOcr()
```
public boolean isUseOcr()
```

Gets the value that indicates whether the OCR Connector is used to extract a text.

**Returns:**
boolean -  true  if the OCR functionality is used; otherwise,  false .

##### getOcrOptions()
```
public OcrOptions getOcrOptions()
```

Gets the additional options for OCR functionality.

**Returns:**
OcrOptions - An instance of OcrOptions class with the additional OCR options.

### com.groupdocs.parser.templates
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates.md

The package provides classes for creating templates for parsing document data.

#### Classes

| Class | Description |
| --- | --- |
| Template | Provides the document page template. |
| TemplateBarcode | Provides the template barcode field. |
| TemplateField | Provides the template text field. |
| TemplateFixedPosition | Provides a template field position which is defined by the rectangular area. |
| TemplateItem | Provides a base abstract class for template items. |
| TemplateLinkedPosition | Provides a template field position which uses the linked field. |
| TemplateLinkedPositionEdges | Provides the edges of the linked field where the text field is seached. |
| TemplateOptions | Provides the options which are used for parsing by template functionality. |
| TemplatePosition | Provides a base abstract class for template positions. |
| TemplateRegexPosition | Provides a template field position which uses the regular expression. |
| TemplateTable | Provides the template table. |
| TemplateTableLayout | Provides the template table layout which is used by TemplateTable class to define table position. |
| TemplateTableParameters | Provides parameters for the table detection algorithms. |

### Template
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/template.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class Template implements Iterable<TemplateItem>
```

Provides the document page template. It consists of TemplateItem objects which represent the items of the template such as text field and table definitions.

**Learn more:**

* Working with templates

#### Constructors

| Constructor | Description |
| --- | --- |
| Template(Iterable<? extends TemplateItem> items) | Initializes a new instance of the Template class.
 |
| Template(Iterable<? extends TemplateItem> items, TemplateOptions options) | Initializes a new instance of the Template class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the total number of template items.
 |
| get(int index) | Gets the template item by an index.
 |
| getOptions() | Gets the template options.
 |
| iterator() |  |
| load(String filePath) | Loads a template from a file.
 |
| load(InputStream stream) | Loads a template from a stream.
 |
| save(String filePath) | Saves a template to a file.
 |
| save(OutputStream stream) | Saves a template to a stream.
 |
##### Template(Iterable<? extends TemplateItem> items)
```
public Template(Iterable<? extends TemplateItem> items)
```

Initializes a new instance of the Template class.

Usage:

````
// Create an array of template fields
 TemplateItem[] fields = new TemplateItem[]
 {
     new TemplateField(new TemplateRegexPosition("From"), "From", 0),
     new TemplateField(
         new TemplateLinkedPosition("From", new Size(100, 10), new TemplateLinkedPositionEdges(false, false, false, true)),
         "FromCompany",
         0),
     new TemplateField(
         new TemplateLinkedPosition("FromCompany", new Size(100, 30), new TemplateLinkedPositionEdges(false, false, false, true)),
         "FromAddress",
         0)
 };
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(fields));
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| items | java.lang.Iterable<? extends com.groupdocs.parser.templates.TemplateItem> | The collection of TemplateItem objects.
 |

##### Template(Iterable<? extends TemplateItem> items, TemplateOptions options)
```
public Template(Iterable<? extends TemplateItem> items, TemplateOptions options)
```

Initializes a new instance of the Template class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| items | java.lang.Iterable<? extends com.groupdocs.parser.templates.TemplateItem> | The collection of TemplateItem objects.
 |
| options | TemplateOptions | The template options.
 |

##### getCount()
```
public int getCount()
```

Gets the total number of template items.

**Returns:**
int - An integer that represents the total number of template items.

##### get(int index)
```
public TemplateItem get(int index)
```

Gets the template item by an index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the template item.
 |

**Returns:**
TemplateItem - An instance of TemplateItem class.

##### getOptions()
```
public TemplateOptions getOptions()
```

Gets the template options.

**Returns:**
TemplateOptions - An instance of TemplateOptions class.

##### iterator()
```
public Iterator<TemplateItem> iterator()
```

**Returns:**
java.util.Iterator<com.groupdocs.parser.templates.TemplateItem>
##### load(String filePath)
```
public static Template load(String filePath)
```

Loads a template from a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

**Returns:**
Template - An instance of Template class with loaded template.

##### load(InputStream stream)
```
public static Template load(InputStream stream)
```

Loads a template from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream.
 |

**Returns:**
Template - An instance of Template class with loaded template.

##### save(String filePath)
```
public void save(String filePath)
```

Saves a template to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

##### save(OutputStream stream)
```
public void save(OutputStream stream)
```

Saves a template to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | The output stream.
 |

### TemplateBarcode
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatebarcode.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplateItem
```
public class TemplateBarcode extends TemplateItem
```

Provides the template barcode field.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateBarcode(Rectangle rectangle, String name) | Initializes a new instance of the TemplateBarcode class.
 |
| TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex) | Initializes a new instance of the TemplateBarcode clas with the UPPER CASE name.
 |
| TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth) | Initializes a new instance of the TemplateBarcode class with the UPPER CASE name.
 |
| TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, boolean useUpperCaseName) | Initializes a new instance of the TemplateBarcode class.
 |
| TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) | Initializes a new instance of the TemplateBarcode class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that contains the template barcode field.
 |
| scale(double factor) |  |
##### TemplateBarcode(Rectangle rectangle, String name)
```
public TemplateBarcode(Rectangle rectangle, String name)
```

Initializes a new instance of the TemplateBarcode class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field.
 |
| name | java.lang.String | The barcode field name.
 |

##### TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex)
```
public TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex)
```

Initializes a new instance of the TemplateBarcode clas with the UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field.
 |
| name | java.lang.String | The barcode field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |

##### TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth)
```
public TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth)
```

Initializes a new instance of the TemplateBarcode class with the UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field.
 |
| name | java.lang.String | The barcode field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |

##### TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, boolean useUpperCaseName)
```
public TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateBarcode class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field.
 |
| name | java.lang.String | The barcode field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```
public TemplateBarcode(Rectangle rectangle, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateBarcode class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field.
 |
| name | java.lang.String | The barcode field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains the template barcode field.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains the template barcode field.

##### scale(double factor)
```
public TemplateItem scale(double factor)
```

Creates a copy of the current item with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplateItem

### TemplateField
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatefield.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplateItem
```
public class TemplateField extends TemplateItem
```

Provides the template text field.

Text fields are defined by its position on the page. There are three ways to define a text field:

* Using the rectangular area: TemplateFixedPosition
* Using the regular expression: TemplateRegexPosition
* Using the linked field: TemplateLinkedPosition

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateField(TemplatePosition position, String name) | Initializes a new instance of the TemplateField class.
 |
| TemplateField(TemplatePosition position, String name, Integer pageIndex) | Initializes a new instance of the TemplateField class with the UPPER CASE name.
 |
| TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth) | Initializes a new instance of the TemplateField class with the UPPER CASE name.
 |
| TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName) | Initializes a new instance of the TemplateField class.
 |
| TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) | Initializes a new instance of the TemplateField class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPosition() | Gets the value that describes how to find the template field on the document page.
 |
| scale(double factor) |  |
##### TemplateField(TemplatePosition position, String name)
```
public TemplateField(TemplatePosition position, String name)
```

Initializes a new instance of the TemplateField class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position.
 |
| name | java.lang.String | The field name.
 |

##### TemplateField(TemplatePosition position, String name, Integer pageIndex)
```
public TemplateField(TemplatePosition position, String name, Integer pageIndex)
```

Initializes a new instance of the TemplateField class with the UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position.
 |
| name | java.lang.String | The field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |

##### TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth)
```
public TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth)
```

Initializes a new instance of the TemplateField class with the UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position.
 |
| name | java.lang.String | The field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |

##### TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName)
```
public TemplateField(TemplatePosition position, String name, Integer pageIndex, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateField class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position.
 |
| name | java.lang.String | The field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```
public TemplateField(TemplatePosition position, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateField class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position.
 |
| name | java.lang.String | The field name.
 |
| pageIndex | java.lang.Integer | An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### getPosition()
```
public TemplatePosition getPosition()
```

Gets the value that describes how to find the template field on the document page.

**Returns:**
TemplatePosition - An instance of TemplatePosition descendant class.

##### scale(double factor)
```
public TemplateItem scale(double factor)
```

Creates a copy of the current item with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplateItem

### TemplateFixedPosition
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatefixedposition.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplatePosition
```
public class TemplateFixedPosition extends TemplatePosition
```

Provides a template field position which is defined by the rectangular area.

This is simplest way to define the field position. It requires to set a rectangular area on the page that bounds
the field value. All the text that is contained (even partially) into the rectangular area will be extracted as a value:

````
// Create a fixed template field with "Address" name which is bounded by a rectangle at the position (35, 160) and with the size (110, 20)
 TemplateField templateField = new TemplateField(
     new TemplateFixedPosition(new Rectangle(new Point(35, 160), new Size(110, 20))),
     "Address");
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateFixedPosition(Rectangle rectangle) | Initializes a new instance of the TemplateFixedPosition class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that contains the template field.
 |
| scale(double factor) |  |
##### TemplateFixedPosition(Rectangle rectangle)
```
public TemplateFixedPosition(Rectangle rectangle)
```

Initializes a new instance of the TemplateFixedPosition class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template field.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains the template field.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains the template field.

##### scale(double factor)
```
public TemplatePosition scale(double factor)
```

Creates a copy of the current position with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplatePosition

### TemplateItem
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templateitem.md

**Inheritance:**
java.lang.Object
```
public abstract class TemplateItem
```

Provides a base abstract class for template items.

The inheritors of TemplateItem class are used in Template collection.

#### Methods

| Method | Description |
| --- | --- |
| scale(double factor) | Creates a copy of the current item with all coordinates scaled by the given factor.
 |
| getName() | Gets the name of the template item.
 |
| getPageIndex() | Gets the page index of the template item.
 |
| getPageWidth() | Gets the width of the page that was used to create the template item.
 |
| getUseUpperCaseName() | Gets a value that indicates whether a  Name  was converted to UPPER CASE.
 |
##### scale(double factor)
```
public abstract TemplateItem scale(double factor)
```

Creates a copy of the current item with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double | The scaling factor.
 |

**Returns:**
TemplateItem - A new TemplateItem with scaled coordinates.

##### getName()
```
public String getName()
```

Gets the name of the template item.

**Returns:**
java.lang.String - An uppercase string value that represents a name of the template item.

##### getPageIndex()
```
public Integer getPageIndex()
```

Gets the page index of the template item.

**Returns:**
java.lang.Integer - An integer value that represents the index of the page where the template item is located;  null  if the template item is located on any page.

##### getPageWidth()
```
public Double getPageWidth()
```

Gets the width of the page that was used to create the template item.

**Returns:**
java.lang.Double - The width of the page in pixels;  null  if the page width is unknown.

##### getUseUpperCaseName()
```
public boolean getUseUpperCaseName()
```

Gets a value that indicates whether a  Name  was converted to UPPER CASE.

**Returns:**
boolean - A boolean value that indicates whether a  Name  was converted to UPPER CASE.

### TemplateLinkedPosition
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatelinkedposition.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplatePosition
```
public class TemplateLinkedPosition extends TemplatePosition
```

Provides a template field position which uses the linked field.

The following example shows the code for the situation if it's known that the field with an invoice number
is placed on the right of "Invoice number" string the following code is used:

````
// Create a regex template field to find "Invoice Number" text
 TemplateField invoice = new TemplateField(new TemplateRegexPosition("Invoice Number"), "Invoice");

 // Create a related template field associated with "Invoice" field and extract the value on the right of it
 TemplateField invoiceNumber = new TemplateField(
     new TemplateLinkedPosition("invoice", new Size(100, 15), new TemplateLinkedPositionEdges(false, false, true, false)),
     "InvoiceNumber");
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges) | Initializes a new instance of the TemplateLinkedPosition class.
 |
| TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale) | Initializes a new instance of the TemplateLinkedPosition class with UPPER CASE name.
 |
| TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale, boolean useUpperCaseName) | Initializes a new instance of the TemplateLinkedPosition class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLinkedFieldName() | Gets the linked field name.
 |
| getSearchArea() | Gets the size of the area where a field is searched.
 |
| isAutoScale() | Gets the value that indicates whether  SearchArea  is scaled by the linked field size.
 |
| getEdges() | Gets the edges of the linked field where a field is searched.
 |
| scale(double factor) |  |
##### TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges)
```
public TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges)
```

Initializes a new instance of the TemplateLinkedPosition class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | java.lang.String | The name of the linked field.
 |
| searchArea | Size | The size of the area where a field is searched.
 |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched.
 |

##### TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale)
```
public TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale)
```

Initializes a new instance of the TemplateLinkedPosition class with UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | java.lang.String | The name of the linked field.
 |
| searchArea | Size | The size of the area where a field is searched.
 |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched.
 |
| autoScale | boolean | The value that indicates whether searchArea is scaled by the linked field size.
 |

##### TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale, boolean useUpperCaseName)
```
public TemplateLinkedPosition(String linkedFieldName, Size searchArea, TemplateLinkedPositionEdges edges, boolean autoScale, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateLinkedPosition class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | java.lang.String | The name of the linked field.
 |
| searchArea | Size | The size of the area where a field is searched.
 |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched.
 |
| autoScale | boolean | The value that indicates whether searchArea is scaled by the linked field size.\\
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### getLinkedFieldName()
```
public String getLinkedFieldName()
```

Gets the linked field name.

**Returns:**
java.lang.String - An uppercase string value that represents the linked field name.

##### getSearchArea()
```
public Size getSearchArea()
```

Gets the size of the area where a field is searched.

**Returns:**
Size - An instance of Size class that represents the size of the area where a field is searched.

##### isAutoScale()
```
public Boolean isAutoScale()
```

Gets the value that indicates whether  SearchArea  is scaled by the linked field size.

**Returns:**
java.lang.Boolean - {code true} if  SearchArea  is scaled by the linked field size; otherwise,  false .

##### getEdges()
```
public TemplateLinkedPositionEdges getEdges()
```

Gets the edges of the linked field where a field is searched.

**Returns:**
TemplateLinkedPositionEdges - An instance of TemplateLinkedPositionEdges class that represents the edges of the linked field where a field is searched.

##### scale(double factor)
```
public TemplatePosition scale(double factor)
```

Creates a copy of the current position with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplatePosition

### TemplateLinkedPositionEdges
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatelinkedpositionedges.md

**Inheritance:**
java.lang.Object
```
public class TemplateLinkedPositionEdges
```

Provides the edges of the linked field where the text field is seached. TemplateLinkedPositionEdges is used in TemplateLinkedPosition class.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateLinkedPositionEdges(boolean left, boolean top, boolean right, boolean bottom) | Initializes a new instance of the TemplateLinkedPositionEdges class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isEmpty() | Gets the value that indicates whether the instance is empty.
 |
| isLeft() | Gets the value that indicates whether a field is searched by the left from the linked field.
 |
| isTop() | Gets the value that indicates whether a field is searched by the top from the linked field.
 |
| isRight() | Gets the value that indicates whether a field is searched by the right from the linked field.
 |
| isBottom() | Gets the value that indicates whether a field is searched by the bottom from the linked field.
 |
| parse(String s) | Converts the string representation of edges to its class equivalent.
 |
| toString() |  |
##### TemplateLinkedPositionEdges(boolean left, boolean top, boolean right, boolean bottom)
```
public TemplateLinkedPositionEdges(boolean left, boolean top, boolean right, boolean bottom)
```

Initializes a new instance of the TemplateLinkedPositionEdges class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | boolean | The value that indicates whether a field is searched by the left from the linked field.
 |
| top | boolean | The value that indicates whether a field is searched by the top from the linked field.
 |
| right | boolean | The value that indicates whether a field is searched by the right from the linked field.
 |
| bottom | boolean | The value that indicates whether a field is searched by the bottom from the linked field.
 |

##### isEmpty()
```
public boolean isEmpty()
```

Gets the value that indicates whether the instance is empty.

**Returns:**
boolean -  true  if the instance is empty (all fields are  false ); otherwise,  false .

##### isLeft()
```
public boolean isLeft()
```

Gets the value that indicates whether a field is searched by the left from the linked field.

**Returns:**
boolean -  true  if a field is searched by the left from the linked field; otherwise,  false .

##### isTop()
```
public boolean isTop()
```

Gets the value that indicates whether a field is searched by the top from the linked field.

**Returns:**
boolean -  true  if a field is searched by the top from the linked field; otherwise,  false .

##### isRight()
```
public boolean isRight()
```

Gets the value that indicates whether a field is searched by the right from the linked field.

**Returns:**
boolean -  true  if a field is searched by the right from the linked field; otherwise,  false .

##### isBottom()
```
public boolean isBottom()
```

Gets the value that indicates whether a field is searched by the bottom from the linked field.

**Returns:**
boolean -  true  if a field is searched by the bottom from the linked field; otherwise,  false .

##### parse(String s)
```
public static TemplateLinkedPositionEdges parse(String s)
```

Converts the string representation of edges to its class equivalent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| s | java.lang.String | A string that contains edges to convert.
 |

**Returns:**
TemplateLinkedPositionEdges - An instance of TemplateLinkedPositionEdges class that is equivalent to the value specified in  s  parameter.

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### TemplateOptions
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templateoptions.md

**Inheritance:**
java.lang.Object
```
public class TemplateOptions
```

Provides the options which are used for parsing by template functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateOptions(double rectangleTolerance) | Initializes a new instance of the TemplateOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangleTolerance() | Gets the size of the border that is ignored when captured by the rectangular area.
 |
##### TemplateOptions(double rectangleTolerance)
```
public TemplateOptions(double rectangleTolerance)
```

Initializes a new instance of the TemplateOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangleTolerance | double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
 |

##### getRectangleTolerance()
```
public double getRectangleTolerance()
```

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

**Returns:**
double - The double value from 0 (no border) to 1 (ignore the whole element).

### TemplatePosition
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templateposition.md

**Inheritance:**
java.lang.Object
```
public abstract class TemplatePosition
```

Provides a base abstract class for template positions.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplatePosition() |  |
#### Methods

| Method | Description |
| --- | --- |
| scale(double factor) | Creates a copy of the current position with all coordinates scaled by the given factor.
 |
##### TemplatePosition()
```
public TemplatePosition()
```

##### scale(double factor)
```
public abstract TemplatePosition scale(double factor)
```

Creates a copy of the current position with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double | The scaling factor.
 |

**Returns:**
TemplatePosition - A new TemplatePosition with scaled coordinates.

### TemplateRegexPosition
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templateregexposition.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplatePosition
```
public class TemplateRegexPosition extends TemplatePosition
```

Provides a template field position which uses the regular expression.

The following example shows the situation if the document contains "Invoice Number INV-12345"
then template field can be defined in the following way:

````
// Create a regex template field with "InvoiceNumber" name
 TemplateField templateField = new TemplateField(
     new TemplateRegexPosition("Invoice Number\\s+[A-Z0-9\\-]+"),
     "InvoiceNumber");
 
````

In this case as a value the entire string is extracted. To extract only a part of the string
the regular expression group "value" is used:

````
// Create a regex template field with "InvoiceNumber" name with "value" group
 TemplateField templateField = new TemplateField(
     new TemplateRegexPosition("Invoice Number\\s+(?[A-Z0-9\\-]+)"),
     "InvoiceNumber");
````

In this case as a value "INV-3337" string is extracted.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateRegexPosition(String expression) | Initializes a new instance of the TemplateRegexPosition class.
 |
| TemplateRegexPosition(String expression, boolean matchCase) | Initializes a new instance of the TemplateRegexPosition class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getExpression() | Gets the regular expression.
 |
| isMatchCase() | Gets the value that indicates whether a text case isn't ignored.
 |
| scale(double factor) |  |
##### TemplateRegexPosition(String expression)
```
public TemplateRegexPosition(String expression)
```

Initializes a new instance of the TemplateRegexPosition class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |

##### TemplateRegexPosition(String expression, boolean matchCase)
```
public TemplateRegexPosition(String expression, boolean matchCase)
```

Initializes a new instance of the TemplateRegexPosition class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| expression | java.lang.String | The regular expression.
 |
| matchCase | boolean | The value that indicates whether a text case isn't ignored.
 |

##### getExpression()
```
public String getExpression()
```

Gets the regular expression.

**Returns:**
java.lang.String - A string that represents the regular expression.

##### isMatchCase()
```
public boolean isMatchCase()
```

Gets the value that indicates whether a text case isn't ignored.

**Returns:**
boolean -  true  if a text case isn't ignored; otherwise,  false .

##### scale(double factor)
```
public TemplatePosition scale(double factor)
```

Creates a copy of the current position with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplatePosition

### TemplateTable
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatetable.md

**Inheritance:**
java.lang.Object, com.groupdocs.parser.templates.TemplateItem
```
public class TemplateTable extends TemplateItem
```

Provides the template table.

There are two ways to define a table:

* Using TemplateTableLayout class. In this case the table is defined by its position on the page: rectangular area, columns and rows separators.
* Using TemplateTableParameters class. In this case the table is detected automatically by algorithms with set parameters. See TemplateTableParameters class for more information.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex) | Initializes a new instance of the TemplateTable class with the UPPER CASE name.
 |
| TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth) | Initializes a new instance of the TemplateTable class with the UPPER CASE name.
 |
| TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, boolean useUpperCaseName) | Initializes a new instance of the TemplateTable class.
 |
| TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) | Initializes a new instance of the TemplateTable class.
 |
| TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex) | Initializes a new instance of the TemplateTable class with the UPPER CASE name.
 |
| TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth) | Initializes a new instance of the TemplateTable class.
 |
| TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, boolean useUpperCaseName) | Initializes a new instance of the TemplateTable class.
 |
| TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) | Initializes a new instance of the TemplateTable class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLayout() | Gets the table layout.
 |
| getParameters() | Gets the parameters to detect the table in the automatic mode.
 |
| scale(double factor) |  |
##### TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex)
```
public TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex)
```

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

Template table is set by table layout if the table can't be detected automatically:

````
TemplateTableLayout layout = new TemplateTableLayout(
     java.util.Arrays.asList(new Double[] { 50.0, 95.0, 275.0 }),
     java.util.Arrays.asList(new Double[] { 325.0, 340.0, 365.0 }));
 TemplateTable table = new TemplateTable(layout, "Details", null);
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(new TemplateItem[] { table }));
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |

##### TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth)
```
public TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth)
```

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |

##### TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, boolean useUpperCaseName)
```
public TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateTable class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```
public TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateTable class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex)
```
public TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex)
```

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

If a template table is set by detector parameters, the table is detected automatically:

````
TemplateTableParameters parameters = new TemplateTableParameters(
     new Rectangle(new Point(175, 350), new Size(400, 200)),
     java.util.Arrays.asList(new Double[] { 185.0, 370.0, 425.0, 485.0, 545.0 }));
 TemplateTable table = new TemplateTable(parameters, "Details", 0);
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(new TemplateItem[] { table }));
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |

##### TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth)
```
public TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth)
```

Initializes a new instance of the TemplateTable class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |

##### TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, boolean useUpperCaseName)
```
public TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateTable class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```
public TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName)
```

Initializes a new instance of the TemplateTable class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode.
 |
| name | java.lang.String | The table name.
 |
| pageIndex | java.lang.Integer | The index of the page where the template table is located;  null  if the template table is located on any page.
 |
| pageWidth | java.lang.Double | The width of the page that was used to create the template item.
 |
| useUpperCaseName | boolean | The value that indicates whether a  name  is converted to UPPER CASE.
 |

##### getLayout()
```
public TemplateTableLayout getLayout()
```

Gets the table layout.

**Returns:**
TemplateTableLayout - An instance of TemplateTableLayout class that represents the table layout;  null  if it isn't set.

##### getParameters()
```
public TemplateTableParameters getParameters()
```

Gets the parameters to detect the table in the automatic mode.

**Returns:**
TemplateTableParameters - An instance of  TemplateTableParameters  class that represents the parameters to detect the table in the automatic mode;  null  if it isn't set.

##### scale(double factor)
```
public TemplateItem scale(double factor)
```

Creates a copy of the current item with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double |  |

**Returns:**
TemplateItem

### TemplateTableLayout
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatetablelayout.md

**Inheritance:**
java.lang.Object
```
public class TemplateTableLayout
```

Provides the template table layout which is used by TemplateTable class to define table position.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateTableLayout(Iterable<Double> verticalSeparators, Iterable<Double> horizontalSeparators) | Initializes a new instance of the TemplateTableLayout class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that contains the table.
 |
| getVerticalSeparators() | Gets the table columns separators.
 |
| getHorizontalSeparators() | Gets the table rows separators.
 |
| moveTo(Point point) | Creates a new layout with the same size, separators and position in the point.
 |
| scale(double factor) | Creates a copy of this layout with all coordinates scaled by the given factor.
 |
##### TemplateTableLayout(Iterable<Double> verticalSeparators, Iterable<Double> horizontalSeparators)
```
public TemplateTableLayout(Iterable<Double> verticalSeparators, Iterable<Double> horizontalSeparators)
```

Initializes a new instance of the TemplateTableLayout class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verticalSeparators | java.lang.Iterable<java.lang.Double> | The table columns separators.
 |
| horizontalSeparators | java.lang.Iterable<java.lang.Double> | The table rows separators.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains the table.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains the table.

##### getVerticalSeparators()
```
public List<Double> getVerticalSeparators()
```

Gets the table columns separators.

**Returns:**
java.util.List<java.lang.Double> - A collection of double values that represent x-coordinates of the table columns separators.

##### getHorizontalSeparators()
```
public List<Double> getHorizontalSeparators()
```

Gets the table rows separators.

**Returns:**
java.util.List<java.lang.Double> - A collection of double values that represent y-coordinates of the table rows separators.

##### moveTo(Point point)
```
public TemplateTableLayout moveTo(Point point)
```

Creates a new layout with the same size, separators and position in the point.

This functionality allows to move Table Layout.

For example, a document has tables on each page (or a set of documents with a table on the page).
These tables differ by position and content, but have the same columns and rows. In this case a user
can define TemplateTableLayout object at (0, 0) once and then move it to the location of the definite table.

If the table position depends on the other object of the page, a user can define TemplateTableLayout object
based on template document and then move it according to an anchor object. For example, if this is a summary table
and it is followed by details table (which can contain a different count of rows). In this case a user can define
TemplateTableLayout object on template document (with the known details table rectangle) and then move
TemplateTableLayout object according to the difference of details table rectangle of template and real document.

moveTo(Point)
 method returns a copy of the current object. A user can pass any coordinates
(even negative - then layout will be moved to the left/top).

````
// Create a table layout
 TemplateTableLayout layout = new TemplateTableLayout(
     java.util.Arrays.asList(new Double[] { 0.0, 25.0, 150.0, 180.0, 230.0 }),
     java.util.Arrays.asList(new Double[] { 0.0, 15.0, 30.0, 45.0, 60.0, 75.0 }));
 // Print a rectangle
 Rectangle rect = layout.getRectangle();
 // Prints: pos: (0, 0) size: (230, 75)
 System.out.println(String.format("pos: (%d, %d) size: (%d, %d)",
         rect.getLeft(), rect.getTop(),
         rect.getSize().getWidth(), rect.getSize().getHeight()));
 // Move layout to the definite table location
 TemplateTableLayout movedLayout = layout.moveTo(new Point(315, 250));
 // Ensure that the first separators are moved:
 System.out.println(movedLayout.getVerticalSeparators().get(0)); // prints: 315
 System.out.println(movedLayout.getHorizontalSeparators().get(0)); // prints: 250
 Rectangle movedRect = movedLayout.getRectangle();
 // Prints: pos: (315, 250) size: (230, 75)
 System.out.println(String.format("pos: (%d, %d) size: (%d, %d)",
         movedRect.getLeft(), movedRect.getTop(),
         movedRect.getSize().getWidth(), movedRect.getSize().getHeight()));
 // movedLayout object is a copy of layout object, thus we can tune separators without the impact on the original layout:
 movedLayout.getHorizontalSeparators().add(90.0);
 System.out.println(movedLayout.getHorizontalSeparators().size()); // prints: 7
 System.out.println(layout.getHorizontalSeparators().size()); // prints: 6
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| point | Point | The position of the new layout.
 |

**Returns:**
TemplateTableLayout - A new layout with the same size, separators and position in the point.

##### scale(double factor)
```
public TemplateTableLayout scale(double factor)
```

Creates a copy of this layout with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double | The scaling factor.
 |

**Returns:**
TemplateTableLayout - A new TemplateTableLayout with scaled separators.

### TemplateTableParameters
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.templates/templatetableparameters.md

**Inheritance:**
java.lang.Object
```
public class TemplateTableParameters
```

Provides parameters for the table detection algorithms.

There are two algorithms to detect a table:

* Allows to detect a table in the rectangular area with set columns. This algorithm is useful for simple tables (without merged columns) and provides more accurate detection.
* Allows to detect a table in any place on the page. This is a more complex algorithm. It can detect tables in any place on the page. Additional parameters help to detect a table more correctly.

In some cases when algorithms can't detect a table or do it in non-accurate way TemplateTableLayout class is used.

#### Constructors

| Constructor | Description |
| --- | --- |
| TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators) | Initializes a new instance of the TemplateTableParameters class.
 |
| TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators, Boolean mergedCells, Integer minRowCount, Integer minColumnCount, Integer minVerticalSpace) | Initializes a new instance of the TemplateTableParameters class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangular area that contains the table.
 |
| getVerticalSeparators() | Gets the table columns separators.
 |
| hasMergedCells() | Gets the value that indicates whether the table has merged cells.
 |
| getMinRowCount() | Gets the minimum number of the table rows.
 |
| getMinColumnCount() | Gets the minimum number of the table columns.
 |
| getMinVerticalSpace() | Gets the minumum space between the table columns.
 |
| scale(double factor) | Creates a copy of these parameters with all coordinates scaled by the given factor.
 |
##### TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators)
```
public TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators)
```

Initializes a new instance of the TemplateTableParameters class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the table.
 |
| verticalSeparators | java.lang.Iterable<java.lang.Double> | The table columns separators.
 |

##### TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators, Boolean mergedCells, Integer minRowCount, Integer minColumnCount, Integer minVerticalSpace)
```
public TemplateTableParameters(Rectangle rectangle, Iterable<Double> verticalSeparators, Boolean mergedCells, Integer minRowCount, Integer minColumnCount, Integer minVerticalSpace)
```

Initializes a new instance of the TemplateTableParameters class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the table.
 |
| verticalSeparators | java.lang.Iterable<java.lang.Double> | The table columns separators.
 |
| mergedCells | java.lang.Boolean | The value that indicates whether the table has merged cells.
 |
| minRowCount | java.lang.Integer | The minimum number of the table rows.
 |
| minColumnCount | java.lang.Integer | The minumum number of the table columns.
 |
| minVerticalSpace | java.lang.Integer | The minumum space between the table columns.
 |

##### getRectangle()
```
public Rectangle getRectangle()
```

Gets the rectangular area that contains the table.

**Returns:**
Rectangle - An instance of Rectangle class that represents the rectangular area that contains the table;  null  if it isn't set.

##### getVerticalSeparators()
```
public List<Double> getVerticalSeparators()
```

Gets the table columns separators.

**Returns:**
java.util.List<java.lang.Double> - A collection of double values that represent x-coordinates of the table columns separators;  null  if it isn't set.

##### hasMergedCells()
```
public Boolean hasMergedCells()
```

Gets the value that indicates whether the table has merged cells.

**Returns:**
java.lang.Boolean -  true  if the table has merged cells; otherwise,  false .  null  if it isn't set.

##### getMinRowCount()
```
public Integer getMinRowCount()
```

Gets the minimum number of the table rows.

**Returns:**
java.lang.Integer - An integer value that represents the minimum number of the table rows;  null  if it isn't set.

##### getMinColumnCount()
```
public Integer getMinColumnCount()
```

Gets the minimum number of the table columns.

**Returns:**
java.lang.Integer - An integer value that represents the minimum number of the table columns;  null  if it isn't set.

##### getMinVerticalSpace()
```
public Integer getMinVerticalSpace()
```

Gets the minumum space between the table columns.

**Returns:**
java.lang.Integer - An integer value that represents the minumum space between the table columns;  null  if it isn't set.

##### scale(double factor)
```
public TemplateTableParameters scale(double factor)
```

Creates a copy of these parameters with all coordinates scaled by the given factor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| factor | double | The scaling factor.
 |

**Returns:**
TemplateTableParameters - A new TemplateTableParameters with scaled coordinates.

### com.groupdocs.parser
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser.md

The package provides classes for parsing data from documents. With the main class Parser you may use all document data parsing and extraction features.

#### Classes

| Class | Description |
| --- | --- |
| Parser | Represents the main class that controls text, images, container extraction and parsing functionality. |

### Parser
Path: https://reference.groupdocs.com/parser/java/com.groupdocs.parser/parser.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Parser implements Closeable
```

Represents the main class that controls text, images, container extraction and parsing functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| Parser(URL url) | Initializes a new instance of the Parser class to extract data from an URL.
 |
| Parser(URL url, LoadOptions loadOptions) | Initializes a new instance of the Parser class to extract data from an URL with  loadOptions .
 |
| Parser(URL url, ParserSettings parserSettings) | Initializes a new instance of the Parser class to extract data from an URL with  parserSettings .
 |
| Parser(URL url, LoadOptions loadOptions, ParserSettings parserSettings) | Initializes a new instance of the Parser class to extract data from an URL with  loadOptions  and  parserSettings .
 |
| Parser(Connection connection) | Initializes a new instance of the Parser class to extract data from a database.
 |
| Parser(Connection connection, ParserSettings parserSettings) | Initializes a new instance of the Parser class to extract data from a database.
 |
| Parser(EmailConnection connection) | Initializes a new instance of the Parser class.
 |
| Parser(EmailConnection connection, ParserSettings parserSettings) | Initializes a new instance of the Parser class.
 |
| Parser(String filePath) | Initializes a new instance of the Parser class.
 |
| Parser(String filePath, LoadOptions loadOptions) | Initializes a new instance of the Parser class with LoadOptions.
 |
| Parser(String filePath, ParserSettings parserSettings) | Initializes a new instance of the Parser class with ParserSettings.
 |
| Parser(String filePath, LoadOptions loadOptions, ParserSettings parserSettings) | Initializes a new instance of the Parser class with LoadOptions and ParserSettings.
 |
| Parser(InputStream document) | Initializes a new instance of the Parser class.
 |
| Parser(InputStream document, LoadOptions loadOptions) | Initializes a new instance of the Parser class with LoadOptions.
 |
| Parser(InputStream document, ParserSettings parserSettings) | Initializes a new instance of the Parser class with ParserSettings.
 |
| Parser(InputStream document, LoadOptions loadOptions, ParserSettings parserSettings) | Initializes a new instance of the Parser class with LoadOptions and ParserSettings.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileInfo(String filePath) | Returns the general information about a file.
 |
| getFileInfo(InputStream document) | Returns the general information about a file.
 |
| getFeatures() | Gets the supported features.
 |
| getPagePreview(int pageIndex) | Generates a document page preview.
 |
| getPagePreview(int pageIndex, PagePreviewOptions options) | Generates a document page preview using customization options.
 |
| generatePreview(PreviewOptions previewOptions) | Get pages preview.
 |
| getDocumentInfo() | Returns the general information about the document.
 |
| getText() | Extracts a text from the document.
 |
| getText(TextOptions options) | Extracts a text page from the document using text options (to enable raw fast text extraction mode).
 |
| getText(int pageIndex) | Extracts a text from the document page.
 |
| getText(int pageIndex, TextOptions options) | Extracts a text from the document page using text options (to enable raw fast text extraction mode).
 |
| getFormattedText(FormattedTextOptions options) | Extracts a formatted text from the document.
 |
| getFormattedText(int pageIndex, FormattedTextOptions options) | Extracts a formatted text from the document page.
 |
| search(String keyword) | Searches a keyword in the document.
 |
| search(String keyword, SearchOptions options) | Searches a keyword in the document using search options (regular expression, match case, etc.).
 |
| getHighlight(int position, boolean isDirect, HighlightOptions options) | Extracts a highlight from the document.
 |
| getToc() | Extracts a table of contents from the document.
 |
| getMetadata() | Extracts metadata from the document.
 |
| getContainer() | Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc.
 |
| getTextAreas() | Extracts text areas from the document.
 |
| getTextAreas(PageTextAreaOptions options) | Extracts text areas from the document using customization options (regular expression, match case, etc.).
 |
| getTextAreas(int pageIndex) | Extracts text areas from the document page.
 |
| getTextAreas(int pageIndex, PageTextAreaOptions options) | Extracts text areas from the document page using customization options (regular expression, match case, etc.).
 |
| getImages() | Extracts images from the document.
 |
| getImages(PageAreaOptions options) | Extracts images from the document using customization options (to set the rectangular area that contains images).
 |
| getImages(int pageIndex) | Extracts images from the document page.
 |
| getImages(int pageIndex, PageAreaOptions options) | Extracts images from the document page using customization options (to set the rectangular area that contains images).
 |
| getHyperlinks() | Extracts hyperlinks from the document.
 |
| getHyperlinks(int pageIndex) | Extracts hyperlinks from the document page.
 |
| getHyperlinks(PageAreaOptions options) | Extracts hyperlinks from the document using customization options (to set the rectangular area that contains hyperlinks).
 |
| getHyperlinks(int pageIndex, PageAreaOptions options) | Extracts hyperlinks from the document page using customization options (to set the rectangular area that contains hyperlinks).
 |
| getBarcodes() | Extracts barcodes from the document.
 |
| getBarcodes(int pageIndex) | Extracts barcodes from the document page.
 |
| getBarcodes(BarcodeOptions options) | Extracts barcodes from the document using customization options (to set the rectangular area that contains barcodes).
 |
| getBarcodes(int pageIndex, BarcodeOptions options) | Extracts barcodes from the document page using customization options (to set the rectangular area that contains barcodes).
 |
| getTables(PageTableAreaOptions options) | Extracts tables from the document.
 |
| getTables() | Extracts tables from the document, detecting them automatically.
 |
| getTables(int pageIndex, PageTableAreaOptions options) | Extracts tables from the document page.
 |
| getTables(int pageIndex) | Extracts tables from the document page, detecting them automatically.
 |
| generateAdjustmentFields(GenerateTemplateOptions options) | Generates a collection of adjustment TemplateItems for the document.
 |
| getWorksheetInfo() | Extracts the info about all worksheets in the spreadsheet.
 |
| getWorksheetInfo(int worksheetIndex) | Extracts the info about the worksheet.
 |
| getWorksheetCells(int worksheetIndex) | Extracts worksheet cells.
 |
| getWorksheetCells(int worksheetIndex, WorksheetOptions options) | Extracts worksheet cells using customization options.
 |
| parseByTemplate(Template template) | Parses the document by the user-generated template.
 |
| parseByTemplate(Template template, ParseByTemplateOptions options) | Parses the document by the user-generated template with the supplied options.
 |
| parseByTemplate(TemplateCollection templates, ParseByTemplateOptions options) | Parses the document by automatically selecting the best-matching template from a collection.
 |
| parseForm() | Parses the document form.
 |
| getStructure() | Extracts a structured text from the document.
 |
| close() | Closes this resource, relinquishing any underlying resources.
 |
##### Parser(URL url)
```
public Parser(URL url)
```

Initializes a new instance of the Parser class to extract data from an URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | The URL the request is sent to
 |

##### Parser(URL url, LoadOptions loadOptions)
```
public Parser(URL url, LoadOptions loadOptions)
```

Initializes a new instance of the Parser class to extract data from an URL with  loadOptions .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | The URL the request is sent to.
 |
| loadOptions | LoadOptions | The options to open the file.
 |

##### Parser(URL url, ParserSettings parserSettings)
```
public Parser(URL url, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class to extract data from an URL with  parserSettings .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | The URL the request is sent to.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(URL url, LoadOptions loadOptions, ParserSettings parserSettings)
```
public Parser(URL url, LoadOptions loadOptions, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class to extract data from an URL with  loadOptions  and  parserSettings .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | The URL the request is sent to.
 |
| loadOptions | LoadOptions | The options to open the file.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(Connection connection)
```
public Parser(Connection connection)
```

Initializes a new instance of the Parser class to extract data from a database.

**Learn more:**

* Extract data from databases

The following example shows how to extract data from Sqlite database:

````
// Create DbConnection object
 java.sql.Connection connection = java.sql.DriverManager.getConnection(String.format("jdbc:sqlite:%s", Constants.SampleDatabase));
 // Create an instance of Parser class to extract tables from the database
 try (Parser parser = new Parser(connection)) {
     // Check if text extraction is supported
     if (!parser.getFeatures().isText()) {
         System.out.println("Text extraction isn't supported.");
         return;
     }
     // Check if toc extraction is supported
     if (!parser.getFeatures().isToc()) {
         System.out.println("Toc extraction isn't supported.");
         return;
     }
     // Get a list of tables
     Iterable toc = parser.getToc();
     // Iterate over tables
     for(TocItem i : toc)
     {
         // Print the table name
         System.out.println(i.extractText());
         // Extract a table content as a text
         try(TextReader reader = parser.getText(i.getPageIndex().intValue()))
         {
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | java.sql.Connection | The database connection.
 |

##### Parser(Connection connection, ParserSettings parserSettings)
```
public Parser(Connection connection, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class to extract data from a database.

**Learn more:**

* Extract data from databases
* Logging

The following example shows how to extract data from Sqlite database:

````
// Create DbConnection object
 java.sql.Connection connection = java.sql.DriverManager.getConnection(String.format("jdbc:sqlite:%s", Constants.SampleDatabase));
 // Create an instance of Parser class to extract tables from the database
 try (Parser parser = new Parser(connection)) {
     // Check if text extraction is supported
     if (!parser.getFeatures().isText()) {
         System.out.println("Text extraction isn't supported.");
         return;
     }
     // Check if toc extraction is supported
     if (!parser.getFeatures().isToc()) {
         System.out.println("Toc extraction isn't supported.");
         return;
     }
     // Get a list of tables
     Iterable toc = parser.getToc();
     // Iterate over tables
     for(TocItem i : toc)
     {
         // Print the table name
         System.out.println(i.extractText());
         // Extract a table content as a text
         try(TextReader reader = parser.getText(i.getPageIndex().intValue()))
         {
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | java.sql.Connection | The database connection.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(EmailConnection connection)
```
public Parser(EmailConnection connection)
```

Initializes a new instance of the Parser class.

**Learn more:**

* Extract emails from remote server via POP, IMAP or Exchange Web Services protocols

The following example shows how to extract emails from Exchange Server:

````
// Create the connection object for Exchange Web Services protocol
 EmailConnection connection = new EmailEwsConnection(
         "https://outlook.office365.com/ews/exchange.asmx",
         "email@server",
         "password");
 // Create an instance of Parser class to extract emails from the remote server
 try (Parser parser = new Parser(connection)) {
     // Check if container extraction is supported
     if (!parser.getFeatures().isContainer()) {
         System.out.println("Container extraction isn't supported.");
         return;
     }
     // Extract email messages from the server
     Iterable emails = parser.getContainer();
     // Iterate over attachments
     for (ContainerItem item : emails) {
         // Create an instance of Parser class for email message
         try (Parser emailParser = item.openParser()) {
             // Extract the email text
             try (TextReader reader = emailParser.getText()) {
                 // Print the email text
                 System.out.println(reader == null ? "Text extraction isn't supported." : reader.readToEnd());
             }
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | EmailConnection | The email connection.
 |

##### Parser(EmailConnection connection, ParserSettings parserSettings)
```
public Parser(EmailConnection connection, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class.

**Learn more:**

* Extract emails from remote server via POP, IMAP or Exchange Web Services protocols
* Logging

The following example shows how to extract emails from Exchange Server:

````
// Create the connection object for Exchange Web Services protocol
 EmailConnection connection = new EmailEwsConnection(
         "https://outlook.office365.com/ews/exchange.asmx",
         "email@server",
         "password");
 // Create an instance of Parser class to extract emails from the remote server
 try (Parser parser = new Parser(connection)) {
     // Check if container extraction is supported
     if (!parser.getFeatures().isContainer()) {
         System.out.println("Container extraction isn't supported.");
         return;
     }
     // Extract email messages from the server
     Iterable emails = parser.getContainer();
     // Iterate over attachments
     for (ContainerItem item : emails) {
         // Create an instance of Parser class for email message
         try (Parser emailParser = item.openParser()) {
             // Extract the email text
             try (TextReader reader = emailParser.getText()) {
                 // Print the email text
                 System.out.println(reader == null ? "Text extraction isn't supported." : reader.readToEnd());
             }
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| connection | EmailConnection | The email connection.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(String filePath)
```
public Parser(String filePath)
```

Initializes a new instance of the Parser class.

**Learn more:**

* Load document from local disk

The following example shows how to load the document from the local disk:

````
// Set the filePath
 String filePath = Constants.SamplePdf;
 // Create an instance of Parser class with the filePath
 try (Parser parser = new Parser(filePath)) {
     // Extract a text into the reader
     try (TextReader reader = parser.getText()) {
         // Print a text from the document
         // If text extraction isn't supported, a reader is null
         System.out.println(reader == null ? "Text extraction isn't supported" : reader.readToEnd());
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

##### Parser(String filePath, LoadOptions loadOptions)
```
public Parser(String filePath, LoadOptions loadOptions)
```

Initializes a new instance of the Parser class with LoadOptions.

**Learn more:**

* Load document from local disk
* Loading specific file formats
* Password-protected documents

The document password is passed by LoadOptions class:

````
try {
     String password = "123456";
     // Create an instance of Parser class with the password:
     try (Parser parser = new Parser(Constants.SamplePassword, new LoadOptions(password))) {
         // Check if text extraction is supported
         if (!parser.getFeatures().isText()) {
             System.out.println("Text extraction isn't supported.");
             return;
         }
         // Print the document text
         try (TextReader reader = parser.getText()) {
             System.out.println(reader.readToEnd());
         }
     }
 } catch (InvalidPasswordException ex) {
     // Print the message if the password is incorrect or empty
     System.out.println("Invalid password");
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |
| loadOptions | LoadOptions | The options to open the file.
 |

##### Parser(String filePath, ParserSettings parserSettings)
```
public Parser(String filePath, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class with ParserSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(String filePath, LoadOptions loadOptions, ParserSettings parserSettings)
```
public Parser(String filePath, LoadOptions loadOptions, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class with LoadOptions and ParserSettings.

**Learn more:**

* Load document from local disk
* Loading specific file formats
* Password-protected documents
* Logging

The following example shows how to receive the information via ILogger interface:

````
try {
     // Create an instance of Logger class
     Logger logger = new Logger();
     // Create an instance of Parser class with the parser settings
     try (Parser parser = new Parser(Constants.SamplePassword, null, new ParserSettings(logger))) {
         // Check if text extraction is supported
         if (!parser.getFeatures().isText()) {
             System.out.println("Text extraction isn't supported.");
             return;
         }
         // Print the document text
         try (TextReader reader = parser.getText()) {
             System.out.println(reader.readToEnd());
         }
     }
 } catch (InvalidPasswordException | IOException ex) {
     ; // Ignore the exception
 }

 class Logger implements ILogger {
     public void error(String message, Exception exception) {
         // Print error message
         System.out.println("Error: " + message);
     }

     public void trace(String message) {
         // Print event message
         System.out.println("Event: " + message);
     }

     public void warning(String message) {
         // Print warning message
         System.out.println("Warning: " + message);
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |
| loadOptions | LoadOptions | The options to open the file.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(InputStream document)
```
public Parser(InputStream document)
```

Initializes a new instance of the Parser class.

**Learn more:**

* Load document from stream

The following example shows how to load the document from the stream:

````
// Create the stream
 try (InputStream stream = new FileInputStream(Constants.SamplePdf)) {
     // Create an instance of Parser class with the stream
     try (Parser parser = new Parser(stream)) {
         // Extract a text into the reader
         try (TextReader reader = parser.getText()) {
             // Print a text from the document
             // If text extraction isn't supported, a reader is null
             System.out.println(reader == null ? "Text extraction isn't supported" : reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The source input stream.
 |

##### Parser(InputStream document, LoadOptions loadOptions)
```
public Parser(InputStream document, LoadOptions loadOptions)
```

Initializes a new instance of the Parser class with LoadOptions.

**Learn more:**

* Load document from stream
* Loading specific file formats
* Password-protected documents

In some cases it's necessary to define FileFormat. Both for special cases (databases, email server)
and for detecting file types by the content:

````
// Create an instance of Parser class for markdown document
 try (Parser parser = new Parser(stream, new LoadOptions(FileFormat.Markup))) {
     // Check if text extraction is supported
     if (!parser.getFeatures().isText()) {
         System.out.println("Text extraction isn't supported.");
         return;
     }
     try (TextReader reader = parser.getText()) {
         // Print the document text
         // Markdown is detected; text without special symbols is printed
         System.out.println(reader.readToEnd());
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The source input stream.
 |
| loadOptions | LoadOptions | The options to open the file.
 |

##### Parser(InputStream document, ParserSettings parserSettings)
```
public Parser(InputStream document, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class with ParserSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The source input stream.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### Parser(InputStream document, LoadOptions loadOptions, ParserSettings parserSettings)
```
public Parser(InputStream document, LoadOptions loadOptions, ParserSettings parserSettings)
```

Initializes a new instance of the Parser class with LoadOptions and ParserSettings.

**Learn more:**

* Load document from stream
* Loading specific file formats
* Password-protected documents
* Logging

The following example shows how to receive the information via ILogger interface:

````
try {
     // Create an instance of Logger class
     Logger logger = new Logger();
     // Create an instance of Parser class with the parser settings
     try (Parser parser = new Parser(Constants.SamplePassword, null, new ParserSettings(logger))) {
         // Check if text extraction is supported
         if (!parser.getFeatures().isText()) {
             System.out.println("Text extraction isn't supported.");
             return;
         }
         // Print the document text
         try (TextReader reader = parser.getText()) {
             System.out.println(reader.readToEnd());
         }
     }
 } catch (InvalidPasswordException | IOException ex) {
     ; // Ignore the exception
 }

 class Logger implements ILogger {
     public void error(String message, Exception exception) {
         // Print error message
         System.out.println("Error: " + message);
     }

     public void trace(String message) {
         // Print event message
         System.out.println("Event: " + message);
     }

     public void warning(String message) {
         // Print warning message
         System.out.println("Warning: " + message);
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The source input stream.
 |
| loadOptions | LoadOptions | The options to open the file.
 |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction.
 |

##### getFileInfo(String filePath)
```
public static FileInfo getFileInfo(String filePath)
```

Returns the general information about a file.

The following code shows how to check whether a file is password-protected:

````
// Get a file info
 FileInfo info = Parser.getFileInfo(filePath);
 // Check IsEncrypted property
 System.out.println(info.isEncrypted() ? "Password is required" : "");
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file.
 |

**Returns:**
FileInfo - An instance of FileInfo class.

##### getFileInfo(InputStream document)
```
public static FileInfo getFileInfo(InputStream document)
```

Returns the general information about a file.

The following code shows how to check whether a file is password-protected:

````
// Get a file info
 FileInfo info = Parser.getFileInfo(filePath);
 // Check IsEncrypted property
 System.out.println(info.isEncrypted() ? "Password is required" : "");
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The source input stream.
 |

**Returns:**
FileInfo - An instance of FileInfo class.

##### getFeatures()
```
public Features getFeatures()
```

Gets the supported features.

**Learn more:**

* Get supported features

If the feature isn't supported, the method returns
null
 instead of the value. Some operations may consume
significant time. So it's not optimal to call the method to just check the support for the feature.
For this purpose Features property is used:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Check if text extraction is supported for the document
     if (!parser.getFeatures().isText()) {
         System.out.println("Text extraction isn't supported");
         return;
     }
     // Extract a text from the document
     try (TextReader reader = parser.getText()) {
         System.out.println(reader.readToEnd());
     }
 }
 
````

**Returns:**
Features - An instance of Features class that represents the supported features.

##### getPagePreview(int pageIndex)
```
public OutputStream getPagePreview(int pageIndex)
```

Generates a document page preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.io.OutputStream - An instance of java.io.OutputStream containing an image of the document page;  null  if the page preview generation isn't supported.

##### getPagePreview(int pageIndex, PagePreviewOptions options)
```
public OutputStream getPagePreview(int pageIndex, PagePreviewOptions options)
```

Generates a document page preview using customization options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | PagePreviewOptions | The options to customize the preview generation.
 |

**Returns:**
java.io.OutputStream - An instance of java.io.OutputStream containing an image of the document page;  null  if the page preview generation isn't supported.

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

Get pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The options to sets requirements and stream delegates for preview generation.
 |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

Returns the general information about the document.

**Learn more:**

* Get document info
* Detect encoding

The following example shows how to get document info:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleDocx)) {
     // Get the document info
     IDocumentInfo info = parser.getDocumentInfo();
     // Print document information
     System.out.println(String.format("FileType: %s", info.getFileType()));
     System.out.println(String.format("PageCount: %d", info.getPageCount()));
     System.out.println(String.format("Size: %d", info.getSize()));
 }
 
````

**Returns:**
IDocumentInfo - An instance of class that implements IDocumentInfo interface.

##### getText()
```
public TextReader getText()
```

Extracts a text from the document.

**Learn more:**

* Extract text from documents
* Extract text in Accurate Mode

The following example shows how to extract a text from a document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Extract a text into the reader
     try (TextReader reader = parser.getText()) {
         // Print a text from the document
         // If text extraction isn't supported, a reader is null
         System.out.println(reader == null ? "Text extraction isn't supported" : reader.readToEnd());
     }
 }
 
````

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if text extraction isn't supported.

##### getText(TextOptions options)
```
public TextReader getText(TextOptions options)
```

Extracts a text page from the document using text options (to enable raw fast text extraction mode).

**Learn more:**

* Extract text in Raw Mode
* Extract text in Accurate Mode

The following example shows how to extract a raw text from a document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Extract a raw text into the reader
     try (TextReader reader = parser.getText(new TextOptions(true))) {
         // Print a text from the document
         // If text extraction isn't supported, a reader is null
         System.out.println(reader == null ? "Text extraction isn't supported" : reader.readToEnd());
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | TextOptions | The text extraction options.
 |

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if text extraction isn't supported.

##### getText(int pageIndex)
```
public TextReader getText(int pageIndex)
```

Extracts a text from the document page.

**Learn more:**

* Extract text in Accurate Mode

The following example shows how to extract a text from the document page:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Check if the document supports text extraction
     if (!parser.getFeatures().isText()) {
         System.out.println("Document isn't supports text extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int p = 0; p < documentInfo.getPageCount(); p++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", p + 1, documentInfo.getPageCount()));
         // Extract a text into the reader
         try (TextReader reader = parser.getText(p)) {
             // Print a text from the document
             // We ignore null-checking as we have checked text extraction feature support earlier
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if text page extraction isn't supported.

##### getText(int pageIndex, TextOptions options)
```
public TextReader getText(int pageIndex, TextOptions options)
```

Extracts a text from the document page using text options (to enable raw fast text extraction mode).

**Learn more:**

* Extract text in Raw Mode
* Extract text in Accurate Mode

The following example shows how to extract a raw text from the document page:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Check if the document supports text extraction
     if (!parser.getFeatures().isText()) {
         System.out.println("Document isn't supports text extraction.");
         return;
     }
     // Get the document info
     DocumentInfo documentInfo = parser.getDocumentInfo() instanceof DocumentInfo
             ? (DocumentInfo) parser.getDocumentInfo()
             : null;
     // Check if the document has pages
     if (documentInfo == null || documentInfo.getRawPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int p = 0; p < documentInfo.getRawPageCount(); p++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", p + 1, documentInfo.getPageCount()));
         // Extract a text into the reader
         try (TextReader reader = parser.getText(p, new TextOptions(true))) {
             // Print a text from the document
             // We ignore null-checking as we have checked text extraction feature support earlier
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | TextOptions | The text extraction options.
 |

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if text page extraction isn't supported.

##### getFormattedText(FormattedTextOptions options)
```
public TextReader getFormattedText(FormattedTextOptions options)
```

Extracts a formatted text from the document.

**Learn more:**

* Extract formatted text from document
* Extract a document text as HTML
* Extract a document text as Markdown
* Extract a document text as Plain text

The following example shows how to extract a document text as HTML text:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleDocx)) {
     // Extract a formatted text into the reader
     try (TextReader reader = parser.getFormattedText(new FormattedTextOptions(FormattedTextMode.Html))) {
         // Print a formatted text from the document
         // If formatted text extraction isn't supported, a reader is null
         System.out.println(reader == null ? "Formatted text extraction isn't suppported" : reader.readToEnd());
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | FormattedTextOptions | The formatted text extraction options.
 |

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if formatted text extraction isn't supported.

##### getFormattedText(int pageIndex, FormattedTextOptions options)
```
public TextReader getFormattedText(int pageIndex, FormattedTextOptions options)
```

Extracts a formatted text from the document page.

**Learn more:**

* Extract formatted text from document page
* Extract a document text as HTML
* Extract a document text as Markdown
* Extract a document text as Plain text

The following example shows how to extract a document page text as Markdown text:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleDocx)) {
     // Check if the document supports formatted text extraction
     if (!parser.getFeatures().isFormattedText()) {
         System.out.println("Document isn't supports formatted text extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int p = 0; p < documentInfo.getPageCount(); p++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", p + 1, documentInfo.getPageCount()));
         // Extract a formatted text into the reader
         try (TextReader reader = parser.getFormattedText(p, new FormattedTextOptions(FormattedTextMode.Markdown))) {
             // Print a formatted text from the document
             // We ignore null-checking as we have checked formatted text extraction feature support earlier
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | FormattedTextOptions | The formatted text extraction options.
 |

**Returns:**
TextReader - An instance of TextReader class with the extracted text;  null  if formatted text page extraction isn't supported.

##### search(String keyword)
```
public Iterable<SearchResult> search(String keyword)
```

Searches a keyword in the document.

**Learn more:**

* Search text
* Search text in Microsoft Office Word documents
* Search text in Microsoft Office Excel spreadsheets
* Search text in Microsoft Office PowerPoint presentations
* Search text in PDF documents
* Search text in Emails
* Search text in EPUB eBooks
* Search text in HTML documents
* Search text in Microsoft OneNote sections

The following example shows how to find a keyword in a document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Search a keyword:
     Iterable sr = parser.search("lorem");
     // Check if search is supported
     if (sr == null) {
         System.out.println("Search isn't supported");
         return;
     }
     // Iterate over search results
     for (SearchResult s : sr) {
         // Print an index and found text:
         System.out.println(String.format("At %d: %s", s.getPosition(), s.getText()));
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | The keyword to search.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.SearchResult> - A collection of SearchResult objects;  null  if search isn't supported.

##### search(String keyword, SearchOptions options)
```
public Iterable<SearchResult> search(String keyword, SearchOptions options)
```

Searches a keyword in the document using search options (regular expression, match case, etc.).

**Learn more:**

* Search text
* Search text in Microsoft Office Word documents
* Search text in Microsoft Office Excel spreadsheets
* Search text in Microsoft Office PowerPoint presentations
* Search text in PDF documents
* Search text in Emails
* Search text in EPUB eBooks
* Search text in HTML documents
* Search text in Microsoft OneNote sections

The following example shows how to search with a regular expression in a document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Search with a regular expression with case matching
     Iterable sr = parser.search("[0-9]+", new SearchOptions(true, false, true));
     // Check if search is supported
     if (sr == null) {
         System.out.println("Search isn't supported");
         return;
     }
     // Iterate over search results
     for (SearchResult s : sr) {
         // Print an index and found text:
         System.out.println(String.format("At %d: %s", s.getPosition(), s.getText()));
     }
 }
 
````

The following example shows how to search a text on pages:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Search a keyword with page numbers
     Iterable sr = parser.search("lorem", new SearchOptions(false, false, false, true));
     // Check if search is supported
     if (sr == null) {
         System.out.println("Search isn't supported");
         return;
     }
     // Iterate over search results
     for (SearchResult s : sr) {
         // Print an index, page number and found text:
         System.out.println(String.format("At %d (%d): %s", s.getPosition(), s.getPageIndex(), s.getText()));
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | The keyword to search.
 |
| options | SearchOptions | The search options.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.SearchResult> - A collection of SearchResult objects;  null  if search isn't supported.

##### getHighlight(int position, boolean isDirect, HighlightOptions options)
```
public HighlightItem getHighlight(int position, boolean isDirect, HighlightOptions options)
```

Extracts a highlight from the document.

**Learn more:**

* Extract highlights

The following example shows how to extract a highlight that contains 3 words:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SamplePdf)) {
     // Extract a highlight:
     HighlightItem hl = parser.getHighlight(2, true, new HighlightOptions(10, 3));
     // Check if highlight extraction is supported
     if (hl == null) {
         System.out.println("Highlight extraction isn't supported");
         return;
     }
     // Print an extracted highlight
     System.out.println(String.format("At %d: %s", hl.getPosition(), hl.getText()));
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| position | int | The start position of the highlight.
 |
| isDirect | boolean | The value that indicates whether highlight extraction is direct.  true  if the higlight is extracted by the right of position; otherwise,  false .
 |
| options | HighlightOptions | The highlight extraction options.
 |

**Returns:**
HighlightItem - An instance of HighlightItem class that represents the extracted highlight;  null  if highlight extraction isn't supported.

##### getToc()
```
public Iterable<TocItem> getToc()
```

Extracts a table of contents from the document.

**Learn more:**

* Extract table of contents
* Extract text by table of contents item
* Extract table of contents from Microsoft Office Word documents
* Extract table of contents from EPUB eBooks

The following example shows how to extract table of contents from EPUB file:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleEpub)) {
     // Check if text extraction is supported
     if (!parser.getFeatures().isText()) {
         System.out.println("Text extraction isn't supported.");
         return;
     }
     // Check if toc extraction is supported
     if (!parser.getFeatures().isToc()) {
         System.out.println("Toc extraction isn't supported.");
         return;
     }
     // Get table of contents
     Iterable toc = parser.getToc();
     // Iterate over items
     for (TocItem i : toc) {
         // Print the Toc text
         System.out.println(i.getText());
         // Check if page index has a value
         if (i.getPageIndex() == null) {
             continue;
         }
         // Extract a page text
         try (TextReader reader = parser.getText(i.getPageIndex())) {
             System.out.println(reader.readToEnd());
         }
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.TocItem> - A collection of table of contents items;  null  if table of contents extraction isn't supported.

##### getMetadata()
```
public Iterable<MetadataItem> getMetadata()
```

Extracts metadata from the document.

**Learn more:**

* Extract metadata from documents
* Extract metadata from Microsoft Office Word documents
* Extract metadata from Microsoft Office Excel spreadsheets
* Extract metadata from Microsoft Office PowerPoint presentations
* Extract metadata from PDF documents
* Extract metadata from Emails

The following example shows how to extract metadata from a document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleDocx)) {
     // Extract metadata from the document
     Iterable metadata = parser.getMetadata();
     // Check if metadata extraction is supported
     if (metadata == null) {
         System.out.println("Metatada extraction isn't supported");
     }
     // Iterate over metadata items
     for (MetadataItem item : metadata) {
         // Print an item name and value
         System.out.println(String.format("%s: %s", item.getName(), item.getValue()));
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> - A collection of metadata items;  null  if metadata extraction isn't supported.

##### getContainer()
```
public Iterable<ContainerItem> getContainer()
```

Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc.

**Learn more:**

* Extract data from attachments and ZIP archives
* Iterate through container items
* Extract attachments from PDF portfolios
* Extract attachments from Emails
* Extract emails from Outlook Storage
* Extract text from ZIP archive files

The following example shows how to extract a text from zip entities:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleZip)) {
     // Extract attachments from the container
     Iterable attachments = parser.getContainer();
     // Check if container extraction is supported
     if (attachments == null) {
         System.out.println("Container extraction isn't supported");
     }
     // Iterate over zip entities
     for (ContainerItem item : attachments) {
         // Print the file path
         System.out.println(item.getFilePath());
         try {
             // Create Parser object for the zip entity content
             try (Parser attachmentParser = item.openParser()) {
                 // Extract an zip entity text
                 try (TextReader reader = attachmentParser.getText()) {
                     System.out.println(reader == null ? "No text" : reader.readToEnd());
                 }
             }
         } catch (UnsupportedDocumentFormatException ex) {
             System.out.println("Isn't supported.");
         }
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.ContainerItem> - A collection of container items;  null  if container extraction isn't supported.

##### getTextAreas()
```
public Iterable<PageTextArea> getTextAreas()
```

Extracts text areas from the document.

**Learn more:**

* Extract text areas

The following example shows how to extract all text areas from the whole document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Extract text areas
     Iterable areas = parser.getTextAreas();
     // Check if text areas extraction is supported
     if (areas == null) {
         System.out.println("Page text areas extraction isn't supported");
         return;
     }
     // Iterate over page text areas
     for (PageTextArea a : areas) {
         // Print a page index, rectangle and text area value:
         System.out.println(String.format("Page: %d, R: %s, Text: %s", a.getPage().getIndex(), a.getRectangle(), a.getText()));
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> - A collection of PageTextArea objects;  null  if text areas extraction isn't supported.

##### getTextAreas(PageTextAreaOptions options)
```
public Iterable<PageTextArea> getTextAreas(PageTextAreaOptions options)
```

Extracts text areas from the document using customization options (regular expression, match case, etc.).

**Learn more:**

* Extract text areas

The following example shows how to extract only text areas with digits from the upper-left courner:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Create the options which are used for text area extraction
     PageTextAreaOptions options = new PageTextAreaOptions("\\s[a-z]{2}\\s", new Rectangle(new Point(0, 0), new Size(300, 100)));
     // Extract text areas which contain only digits from the upper-left corner of a page:
     Iterable areas = parser.getTextAreas(options);
     // Check if text areas extraction is supported
     if (areas == null) {
         System.out.println("Page text areas extraction isn't supported");
         return;
     }
     // Iterate over page text areas
     for (PageTextArea a : areas) {
         // Print a page index, rectangle and text area value:
         System.out.println(String.format("Page: %d, R: %s, Text: %s", a.getPage().getIndex(), a.getRectangle(), a.getText()));
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageTextAreaOptions | The options for text area extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> - A collection of PageTextArea objects;  null  if text areas extraction isn't supported.

##### getTextAreas(int pageIndex)
```
public Iterable<PageTextArea> getTextAreas(int pageIndex)
```

Extracts text areas from the document page.

**Learn more:**

* Extract text areas

To extract text areas from a document page the following method is used:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Check if the document supports text areas extraction
     if (!parser.getFeatures().isTextAreas()) {
         System.out.println("Document isn't supports text areas extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int pageIndex = 0; pageIndex < documentInfo.getPageCount(); pageIndex++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", pageIndex + 1, documentInfo.getPageCount()));
         // Iterate over page text areas
         // We ignore null-checking as we have checked text areas extraction feature support earlier
         for (PageTextArea a : parser.getTextAreas(pageIndex)) {
             // Print a rectangle and text area value:
             System.out.println(String.format("R: %s, Text: %s", a.getRectangle(), a.getText()));
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> - A collection of PageTextArea objects;  null  if text areas extraction isn't supported.

##### getTextAreas(int pageIndex, PageTextAreaOptions options)
```
public Iterable<PageTextArea> getTextAreas(int pageIndex, PageTextAreaOptions options)
```

Extracts text areas from the document page using customization options (regular expression, match case, etc.).

**Learn more:**

* Extract text areas

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | PageTextAreaOptions | The options for text area extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTextArea> - A collection of PageTextArea objects;  null  if text areas extraction isn't supported.

##### getImages()
```
public Iterable<PageImageArea> getImages()
```

Extracts images from the document.

**Learn more:**

* Extract images from documents
* Extract images to files
* Extract images from Microsoft Office Word documents
* Extract images from Microsoft Office Excel spreadsheets
* Extract images from Microsoft Office PowerPoint presentations
* Extract images from Emails
* Extract images from PDF documents

The following example shows how to extract all images from the whole document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Extract images
     Iterable images = parser.getImages();
     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Images extraction isn't supported");
         return;
     }
     // Iterate over images
     for (PageImageArea image : images) {
         // Print a page index, rectangle and image type:
         System.out.println(String.format("Page: %d, R: %s, Type: %s", image.getPage().getIndex(), image.getRectangle(), image.getFileType()));
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageImageArea> - A collection of PageImageArea objects;  null  if images extraction isn't supported.

##### getImages(PageAreaOptions options)
```
public Iterable<PageImageArea> getImages(PageAreaOptions options)
```

Extracts images from the document using customization options (to set the rectangular area that contains images).

**Learn more:**

* Extract images from documents
* Extract images to files
* Extract images from document page area
* Extract images from Microsoft Office Word documents
* Extract images from Microsoft Office Excel spreadsheets
* Extract images from Microsoft Office PowerPoint presentations
* Extract images from Emails
* Extract images from PDF documents

The following example shows how to extract only images from the upper-left courner:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Create the options which are used for images extraction
     PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(340, 150), new Size(300, 100)));
     // Extract images from the upper-left corner of a page:
     Iterable images = parser.getImages(options);
     // Check if images extraction is supported
     if (images == null) {
         System.out.println("Page images extraction isn't supported");
         return;
     }
     // Iterate over images
     for (PageImageArea image : images) {
         // Print a page index, rectangle and image type:
         System.out.println(String.format("Page: %d, R: %s, Type: %s", image.getPage().getIndex(), image.getRectangle(), image.getFileType()));
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageAreaOptions | The options for images extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageImageArea> - A collection of PageImageArea objects;  null  if images extraction isn't supported.

##### getImages(int pageIndex)
```
public Iterable<PageImageArea> getImages(int pageIndex)
```

Extracts images from the document page.

**Learn more:**

* Extract images from documents
* Extract images to files
* Extract images from document page
* Extract images from Microsoft Office Word documents
* Extract images from Microsoft Office Excel spreadsheets
* Extract images from Microsoft Office PowerPoint presentations
* Extract images from Emails
* Extract images from PDF documents

To extract images from a document page the following method is used:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleImagesPdf)) {
     // Check if the document supports images extraction
     if (!parser.getFeatures().isImages()) {
         System.out.println("Document isn't supports images extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int pageIndex = 0; pageIndex < documentInfo.getPageCount(); pageIndex++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", pageIndex + 1, documentInfo.getPageCount()));
         // Iterate over images
         // We ignore null-checking as we have checked images extraction feature support earlier
         for (PageImageArea image : parser.getImages(pageIndex)) {
             // Print a rectangle and image type
             System.out.println(String.format("R: %s, Text: %s", image.getRectangle(), image.getFileType()));
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageImageArea> - A collection of PageImageArea objects;  null  if images extraction isn't supported.

##### getImages(int pageIndex, PageAreaOptions options)
```
public Iterable<PageImageArea> getImages(int pageIndex, PageAreaOptions options)
```

Extracts images from the document page using customization options (to set the rectangular area that contains images).

**Learn more:**

* Extract images from documents
* Extract images to files
* Extract images from document page
* Extract images from document page area
* Extract images from Microsoft Office Word documents
* Extract images from Microsoft Office Excel spreadsheets
* Extract images from Microsoft Office PowerPoint presentations
* Extract images from Emails
* Extract images from PDF documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | PageAreaOptions | The options for images extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageImageArea> - A collection of PageImageArea objects;  null  if images extraction isn't supported.

##### getHyperlinks()
```
public Iterable<PageHyperlinkArea> getHyperlinks()
```

Extracts hyperlinks from the document.

The following example shows how to extract all hyperlinks from the whole document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(filePath)) {
     // Check if the document supports hyperlink extraction
     if (!parser.getFeatures().isHyperlinks()) {
         System.out.println("Document isn't supports hyperlink extraction.");
         return;
     }
     // Extract hyperlinks from the document
     Iterable hyperlinks = parser.getHyperlinks();
     // Iterate over hyperlinks
     for (PageHyperlinkArea h : hyperlinks) {
         // Print the hyperlink text
         System.out.println(h.getText());
         // Print the hyperlink URL
         System.out.println(h.getUrl());
         System.out.println();
     }
 }
 
````

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageHyperlinkArea> - A collection of PageHyperlinkArea objects;  null  if hyperlinks extraction isn't supported.

##### getHyperlinks(int pageIndex)
```
public Iterable<PageHyperlinkArea> getHyperlinks(int pageIndex)
```

Extracts hyperlinks from the document page.

The following example shows how to extract hyperlinks from the document page:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(filePath)) {
     // Check if the document supports hyperlink extraction
     if (!parser.getFeatures().isHyperlinks()) {
         System.out.println("Document isn't supports hyperlink extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int pageIndex = 0; pageIndex < documentInfo.getPageCount(); pageIndex++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", pageIndex + 1, documentInfo.getPageCount()));
         // Extract hyperlinks from the document page
         Iterable hyperlinks = parser.getHyperlinks(pageIndex);
         // Iterate over hyperlinks
         for (PageHyperlinkArea h : hyperlinks) {
             // Print the hyperlink text
             System.out.println(h.getText());
             // Print the hyperlink URL
             System.out.println(h.getUrl());
             System.out.println();
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageHyperlinkArea> - A collection of PageHyperlinkArea objects;  null  if hyperlinks extraction isn't supported.

##### getHyperlinks(PageAreaOptions options)
```
public Iterable<PageHyperlinkArea> getHyperlinks(PageAreaOptions options)
```

Extracts hyperlinks from the document using customization options (to set the rectangular area that contains hyperlinks).

The following example shows how to extract hyperlinks from the document page area:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.HyperlinksPdf)) {
     // Check if the document supports hyperlink extraction
     if (!parser.getFeatures().isHyperlinks()) {
         System.out.println("Document isn't supports hyperlink extraction.");
         return;
     }
     // Create the options which are used for hyperlink extraction
     PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(380, 90), new Size(150, 50)));
     // Extract hyperlinks from the document page area
     Iterable hyperlinks = parser.getHyperlinks(options);
     // Iterate over hyperlinks
     for (PageHyperlinkArea h : hyperlinks) {
         // Print the hyperlink text
         System.out.println(h.getText());
         // Print the hyperlink URL
         System.out.println(h.getUrl());
         System.out.println();
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageAreaOptions | The options for hyperlinks extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageHyperlinkArea> - A collection of PageHyperlinkArea objects;  null  if hyperlinks extraction isn't supported.

##### getHyperlinks(int pageIndex, PageAreaOptions options)
```
public Iterable<PageHyperlinkArea> getHyperlinks(int pageIndex, PageAreaOptions options)
```

Extracts hyperlinks from the document page using customization options (to set the rectangular area that contains hyperlinks).

The following example shows how to extract hyperlinks from the document page area using customization options:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(filePath)) {
     // Check if the document supports hyperlink extraction
     if (!parser.getFeatures().isHyperlinks()) {
         System.out.println("Document isn't supports hyperlink extraction.");
         return;
     }
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Create the options which are used for hyperlink extraction
     PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(380, 90), new Size(150, 50)));
     // Iterate over pages
     for (int pageIndex = 0; pageIndex < documentInfo.getPageCount(); pageIndex++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", pageIndex + 1, documentInfo.getPageCount()));
         // Extract hyperlinks from the document page
         Iterable hyperlinks = parser.getHyperlinks(pageIndex, options);
         // Iterate over hyperlinks
         for (PageHyperlinkArea h : hyperlinks) {
             // Print the hyperlink text
             System.out.println(h.getText());
             // Print the hyperlink URL
             System.out.println(h.getUrl());
             System.out.println();
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | PageAreaOptions | The options for hyperlinks extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageHyperlinkArea> - A collection of PageHyperlinkArea objects;  null  if hyperlinks extraction isn't supported.

##### getBarcodes()
```
public Iterable<PageBarcodeArea> getBarcodes()
```

Extracts barcodes from the document.

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> - A collection of PageBarcodeArea objects;  null  if barcodes extraction isn't supported.

##### getBarcodes(int pageIndex)
```
public Iterable<PageBarcodeArea> getBarcodes(int pageIndex)
```

Extracts barcodes from the document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> - A collection of PageBarcodeArea objects;  null  if barcodes extraction isn't supported.

##### getBarcodes(BarcodeOptions options)
```
public Iterable<PageBarcodeArea> getBarcodes(BarcodeOptions options)
```

Extracts barcodes from the document using customization options (to set the rectangular area that contains barcodes).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | BarcodeOptions | The options for barcodes extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> - A collection of PageBarcodeArea objects;  null  if barcodes extraction isn't supported.\\

##### getBarcodes(int pageIndex, BarcodeOptions options)
```
public Iterable<PageBarcodeArea> getBarcodes(int pageIndex, BarcodeOptions options)
```

Extracts barcodes from the document page using customization options (to set the rectangular area that contains barcodes).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | BarcodeOptions | The options for barcodes extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageBarcodeArea> - A collection of PageBarcodeArea objects;  null  if barcodes extraction isn't supported.

##### getTables(PageTableAreaOptions options)
```
public Iterable<PageTableArea> getTables(PageTableAreaOptions options)
```

Extracts tables from the document.

The following example shows how to extract tables from the whole document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(filePath)) {
     // Check if the document supports table extraction
     if (!parser.getFeatures().isTables()) {
         System.out.println("Document isn't supports tables extraction.");
         return;
     }
     // Create the layout of tables
     TemplateTableLayout layout = new TemplateTableLayout(
             java.util.Arrays.asList(new Double[]{50.0, 95.0, 275.0, 415.0, 485.0, 545.0}),
             java.util.Arrays.asList(new Double[]{325.0, 340.0, 365.0, 395.0}));
     // Create the options for table extraction
     PageTableAreaOptions options = new PageTableAreaOptions(layout);
     // Extract tables from the document
     Iterable tables = parser.getTables(options);
     // Iterate over tables
     for (PageTableArea t : tables) {
         // Iterate over rows
         for (int row = 0; row < t.getRowCount(); row++) {
             // Iterate over columns
             for (int column = 0; column < t.getColumnCount(); column++) {
                 // Get the table cell
                 PageTableAreaCell cell = t.getCell(row, column);
                 if (cell != null) {
                     // Print the table cell text
                     System.out.print(cell.getText());
                     System.out.print(" | ");
                 }
             }
             System.out.println();
         }
         System.out.println();
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PageTableAreaOptions | The options for tables extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> - A collection of PageTableArea objects;  null  if tables extraction isn't supported.

##### getTables()
```
public Iterable<PageTableArea> getTables()
```

Extracts tables from the document, detecting them automatically.

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> - A collection of PageTableArea objects;  null  if tables extraction isn't supported.

##### getTables(int pageIndex, PageTableAreaOptions options)
```
public Iterable<PageTableArea> getTables(int pageIndex, PageTableAreaOptions options)
```

Extracts tables from the document page.

The following example shows how to extract tables from the document page:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleInvoicePagesPdf)) {
     // Check if the document supports table extraction
     if (!parser.getFeatures().isTables()) {
         System.out.println("Document isn't supports tables extraction.");
         return;
     }
     // Create the layout of tables
     TemplateTableLayout layout = new TemplateTableLayout(
             java.util.Arrays.asList(new Double[]{50.0, 95.0, 275.0, 415.0, 485.0, 545.0}),
             java.util.Arrays.asList(new Double[]{325.0, 340.0, 365.0, 395.0}));
     // Create the options for table extraction
     PageTableAreaOptions options = new PageTableAreaOptions(layout);
     // Get the document info
     IDocumentInfo documentInfo = parser.getDocumentInfo();
     // Check if the document has pages
     if (documentInfo.getPageCount() == 0) {
         System.out.println("Document hasn't pages.");
         return;
     }
     // Iterate over pages
     for (int pageIndex = 0; pageIndex < documentInfo.getPageCount(); pageIndex++) {
         // Print a page number
         System.out.println(String.format("Page %d/%d", pageIndex + 1, documentInfo.getPageCount()));
         // Extract tables from the document page
         Iterable tables = parser.getTables(pageIndex, options);
         // Iterate over tables
         for (PageTableArea t : tables) {
             // Iterate over rows
             for (int row = 0; row < t.getRowCount(); row++) {
                 // Iterate over columns
                 for (int column = 0; column < t.getColumnCount(); column++) {
                     // Get the table cell
                     PageTableAreaCell cell = t.getCell(row, column);
                     if (cell != null) {
                         // Print the table cell text
                         System.out.print(cell.getText());
                         System.out.print(" | ");
                     }
                 }
                 System.out.println();
             }
             System.out.println();
         }
     }
 }
 
````

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |
| options | PageTableAreaOptions | The options for tables extraction.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> - A collection of PageTableArea objects;  null  if tables extraction isn't supported.

##### getTables(int pageIndex)
```
public Iterable<PageTableArea> getTables(int pageIndex)
```

Extracts tables from the document page, detecting them automatically.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | The zero-based page index.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.PageTableArea> - A collection of PageTableArea objects;  null  if tables extraction isn't supported.

##### generateAdjustmentFields(GenerateTemplateOptions options)
```
public Iterable<TemplateItem> generateAdjustmentFields(GenerateTemplateOptions options)
```

Generates a collection of adjustment TemplateItems for the document.

Java mirror of the C#
Parser.GenerateAdjustmentFields(GenerateTemplateOptions)
 API (commits d4e691b /
ae9e98c). Useful as a starting-point template that the user can then trim or rename.

##### Algorithm

1. Pick the page from  options.getPageIndex()  (default  0 ).
2. If the document supports text-area extraction, call #getTextAreas(int, com.groupdocs.parser.options.PageTextAreaOptions).getTextAreas(int, com.groupdocs.parser.options.PageTextAreaOptions) and emit one TemplateField per non-empty text area, named  {prefix}_{n}  (default prefix  "Field" ). Each field gets a TemplateFixedPosition at the text area's rectangle, with the page's width recorded as  pageWidth  so subsequent template scaling works.
3. If the document does not support text areas, return  null .

##### OCR caveat

The C# implementation runs OCR over the page preview to derive fields when the document is image-only. Java's OcrConnectorBase is user-supplied, so OCR-driven generation is only meaningful if a connector is configured AND the connector's  recognizeTextAreas(...)  returns proper rectangles. When  options.getOcrOptions()  is set and a connector is available, the OCR pipeline is preferred.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | GenerateTemplateOptions | The generation options. May be  null  (defaults applied).
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.templates.TemplateItem> - An iterable of generated TemplateItems, or  null  if not supported by this document format.

##### getWorksheetInfo()
```
public Iterable<WorksheetInfo> getWorksheetInfo()
```

Extracts the info about all worksheets in the spreadsheet.

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.WorksheetInfo> - A list of WorksheetInfo instances that contains info about all worksheets in the spreadsheet.

##### getWorksheetInfo(int worksheetIndex)
```
public WorksheetInfo getWorksheetInfo(int worksheetIndex)
```

Extracts the info about the worksheet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | int | The zero-based index of the worksheet.
 |

**Returns:**
WorksheetInfo - An instance of WorksheetInfo that contains the info about the worksheet.

##### getWorksheetCells(int worksheetIndex)
```
public Iterable<WorksheetCell> getWorksheetCells(int worksheetIndex)
```

Extracts worksheet cells.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | int | The zero-based index of the worksheet.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.WorksheetCell> - A collection of WorksheetCell instances that contains the cell data.

##### getWorksheetCells(int worksheetIndex, WorksheetOptions options)
```
public Iterable<WorksheetCell> getWorksheetCells(int worksheetIndex, WorksheetOptions options)
```

Extracts worksheet cells using customization options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | int | The zero-based index of the worksheet.
 |
| options | WorksheetOptions | The worksheet extraction options.
 |

**Returns:**
java.lang.Iterable<com.groupdocs.parser.data.WorksheetCell> - A collection of WorksheetCell instances that contains the cell data.

##### parseByTemplate(Template template)
```
public DocumentData parseByTemplate(Template template)
```

Parses the document by the user-generated template.

**Learn more:**

* Parse data from documents
* Working with templates
* Working with data extracted by template
* Parse data from PDF documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The user-generated template.
 |

**Returns:**
DocumentData - An instance of DocumentData class that contains the extracted data;  null  if parsing by template isn't supported.

##### parseByTemplate(Template template, ParseByTemplateOptions options)
```
public DocumentData parseByTemplate(Template template, ParseByTemplateOptions options)
```

Parses the document by the user-generated template with the supplied options.

If
options.getPageIndex()
 is set, only that page is parsed; otherwise all pages are parsed.

OCR support depends on the OcrConnectorBase configured in ParserSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The user-generated template.
 |
| options | ParseByTemplateOptions | The parse-by-template options.
 |

**Returns:**
DocumentData - An instance of DocumentData class that contains the extracted data;  null  if parsing by template isn't supported.

##### parseByTemplate(TemplateCollection templates, ParseByTemplateOptions options)
```
public DocumentData parseByTemplate(TemplateCollection templates, ParseByTemplateOptions options)
```

Parses the document by automatically selecting the best-matching template from a collection.

Mirror of the C#
Parser.ParseByTemplate(TemplateCollection, ParseByTemplateOptions)
 introduced in commit 71f3f21.

**Selection heuristic** (Java port): each candidate template is applied via
#parseByTemplate(Template, com.groupdocs.parser.options.ParseByTemplateOptions).parseByTemplate(Template, com.groupdocs.parser.options.ParseByTemplateOptions), and the template that yields
the highest number of populated fields (non-null page areas with non-empty text) wins. The C# implementation uses
hidden-marker matching against an OCR pass; that path is not yet available in Java because hidden-field markers and
the OCR-driven TemplatePageOcrParser aren't ported, so this populated-field count is used as a transparent fallback.
Callers that need C#-identical behavior should plug in a custom selector once the OCR engine is wired.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| templates | TemplateCollection | A collection of candidate templates. The parser will pick the best-matching one.
 |
| options | ParseByTemplateOptions | Parse options. May be  null .
 |

**Returns:**
DocumentData - The extracted data with DocumentData.getTemplate() set to the selected template, or  null  if the document does not support parsing-by-template or the collection is empty / produced no result.

##### parseForm()
```
public DocumentData parseForm()
```

Parses the document form.

**Learn more:**

* Extract data from PDF forms
* Working with data extracted by template
* Parse data from PDF documents

The following example shows how to parse a form of the document:

````
// Create an instance of Parser class
 try (Parser parser = new Parser(Constants.SampleFormsPdf)) {
     // Extract data from PDF document
     DocumentData data = parser.parseForm();
     // Check if form extraction is supported
     if (data == null) {
         System.out.println("Form extraction isn't supported.");
         return;
     }
     // Iterate over extracted data
     for (int i = 0; i < data.getCount(); i++) {
         System.out.print(data.get(i).getName() + ": ");
         PageTextArea area = data.get(i).getPageArea() instanceof PageTextArea
                 ? (PageTextArea) data.get(i).getPageArea()
                 : null;
         System.out.println(area == null ? "Not a template field" : area.getText());
     }
 }
 
````

**Returns:**
DocumentData - An instance of DocumentData class that contains the extracted data;  null  if parsing by template isn't supported.

##### getStructure()
```
public Document getStructure()
```

Extracts a structured text from the document.

**Learn more:**

* Extract text structure

**Returns:**
org.w3c.dom.Document - An instance of  org.w3c.dom.Document  class with XML text structure;  null  if text structure extraction isn't supported.

##### close()
```
public void close()
```

Closes this resource, relinquishing any underlying resources.

## .NET

### GroupDocs.Parser for .NET
Path: https://reference.groupdocs.com/parser/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Parser | The namespace provides classes for parsing data from documents. With the main class `Parser` you may use all document data parsing and extraction features. |
| GroupDocs.Parser.Data | The namespace provides classes which represent parsing results. |
| GroupDocs.Parser.Exceptions | The namespace provides different exceptions classes. |
| GroupDocs.Parser.Export | The namespace provides classes that allow users to export data to different formats. |
| GroupDocs.Parser.Options | The namespace provides classes to specify additional options when parsing data from documents. |
| GroupDocs.Parser.Templates | The namespace provides classes for creating templates for parsing document data. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### GroupDocs.Parser.Data
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data.md

The namespace provides classes which represent parsing results.

#### Classes

| Class | Description |
| --- | --- |
| ContainerItem | Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on. |
| DocumentData | Represents data of the document. It consists of `FieldData` objects which contain field data from document. |
| DocumentPageData | Represents data of the document page. It consists of `FieldData` objects which contain field data from the document page. |
| FieldData | Represents field data such as a name, a page index, a field value and so on. Depending on the field the value can be a text, an image, a table and so on. |
| HighlightItem | Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality. |
| MetadataItem | Represents a metadata item which is used in container items and metadata extraction functionality. |
| Page | Represents the document page information such as page index and page size. It's used to represent the page that contains inheritors of `PageArea` class in the parsing by template functionality. |
| PageArea | Represents an abstract base class for page areas which are used to represent blocks on the document page in the parsing by template functionality. |
| PageBarcodeArea | Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality. |
| PageGroupArea | Represents a group of page areas which is used to group different types of blocks of the document page in the parsing by template functionality. |
| PageHyperlinkArea | Represents a page area which is used to represent a hyperlink on the page. |
| PageImageArea | Represents a page image area which is used to represent an image on the page in the parsing by template functionality or an image attachment if images are extracted from emails or Zip archives. |
| PageTableArea | Represents a table page area which is used to represent a table in the parsing by template functionality. |
| PageTableAreaCell | Represents a table cell which is used in `PageTableArea` class. |
| PageTextArea | Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality. |
| Point | Represents a point. |
| Rectangle | Represents a rectangular area. |
| SearchResult | Represents the search result in the search functionality. |
| Size | Represents a size. |
| TextStyle | Represents the style of the text such as a font name, a font size and so on. |
| TocItem | Represents the item which is used in the table of contents extraction functionality. |
| WorksheetCell | Represents a worksheet cell. |
| WorksheetInfo | Represents a sheet info. |
| WorksheetRange | Provides the range which are used for the worksheet extraction. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### ContainerItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem.md

#### ContainerItem class

Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.

```csharp
public sealed class ContainerItem
```

#### Properties

| Name | Description |
| --- | --- |
| Directory { get; } | Gets the directory of the item. |
| FilePath { get; } | Gets the full path of the item. |
| Metadata { get; } | Gets the collection of metadata items. |
| Name { get; } | Gets the name of the item. |
| Size { get; } | Gets the size of the item. |

#### Methods

| Name | Description |
| --- | --- |
| DetectFileType(FileTypeDetectionMode) | Detects a file type of the container item. |
| GetMetadataValue(string) | Gets the metadata value. |
| OpenParser() | Creates the `Parser` object for the item content. |
| OpenParser(LoadOptions) | Creates the `Parser` object for the item content with `LoadOptions`. |
| OpenParser(LoadOptions, ParserSettings) | Creates the `Parser` object for the item content with `LoadOptions` and `ParserSettings`. |
| OpenStream() | Opens the stream of the item content. |

##### Remarks

An instance of `ContainerItem` class is used as return value of `GetContainer` method. See the usage examples there.

### DetectFileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/detectfiletype.md

#### ContainerItem.DetectFileType method

Detects a file type of the container item.

```csharp
public FileType DetectFileType(FileTypeDetectionMode detectionMode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| detectionMode | FileTypeDetectionMode | Defines a mode of the file type detection. |

##### Return Value

An instance of `FileType` class; `Unknown` if a file type isn't detected.

##### Remarks

*detectionMode* parameter provides the ability to control file type detection:

* **Default**. The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.
* **Extension**.The file type is detected only by the file extension.
* **Content**. The file type is detected only by the file content.

##### Examples

The following example shows how to detect file type of container item:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract attachments from the container
    IEnumerable<ContainerItem> attachments = parser.GetContainer();
    // Check if container extraction is supported
    if (attachments == null)
    {
        Console.WriteLine("Container extraction isn't supported");
    }
    // Iterate over attachments
    foreach (ContainerItem item in attachments)
    {
        // Detect the file type
        Options.FileType fileType = item.DetectFileType(Options.FileTypeDetectionMode.Default);

        // Print the name and file type
        Console.WriteLine(string.Format("{0}: {1}", item.Name, fileType));
    }
}
```

### Directory
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/directory.md

#### ContainerItem.Directory property

Gets the directory of the item.

```csharp
public string Directory { get; }
```

##### Property Value

A string value that represents the directory of the item (without a file name).

### FilePath
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/filepath.md

#### ContainerItem.FilePath property

Gets the full path of the item.

```csharp
public string FilePath { get; }
```

##### Property Value

A string value that represents the full path of the item.

### GetMetadataValue
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/getmetadatavalue.md

#### ContainerItem.GetMetadataValue method

Gets the metadata value.

```csharp
public string GetMetadataValue(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the metadata. |

##### Return Value

A string value that represents the value of the metadata item; `null` if the metadata with this name isn't found.

### Metadata
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/metadata.md

#### ContainerItem.Metadata property

Gets the collection of metadata items.

```csharp
public IEnumerable<MetadataItem> Metadata { get; }
```

##### Property Value

A collection of `MetadataItem` objects; empty if metadata isn't set.

##### Remarks

These metadata refer to a container element itself, not a document. Depending on the container type metadata can contain the following items:

**Email Attachments**

**Name**

**Description**

**content-type**

The MIME type of the attachment content.

**ZIP Archives**

**Name**

**Description**

**date**

The time and date at which the file indicated by the Zip Entry was last modified.

**disposition**

To detect if image attachment is inline 'disposition' metadata is used. If it's present, it can take 'inline' or 'attachment' values.

**Outlook Storage**

**Name**

**Description**

**date**

The time and date at which the Outlook Storage item was last modified.

**email-sender**

The value of "sender" field.

**email-to**

The value of "to" field.

**subject**

The value of "subject" field.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/name.md

#### ContainerItem.Name property

Gets the name of the item.

```csharp
public string Name { get; }
```

##### Property Value

A string value that represents the file name of the item (without a directory).

### OpenParser
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/openparser.md

#### OpenParser()

Creates the `Parser` object for the item content.

```csharp
public Parser OpenParser()
```

##### Return Value

An instance of `Parser` class of the item content.

#### OpenParser(LoadOptions)

Creates the `Parser` object for the item content with `LoadOptions`.

```csharp
public Parser OpenParser(LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | The options to open the item content. |

##### Return Value

An instance of `Parser` class of the item content.

#### OpenParser(LoadOptions, ParserSettings)

Creates the `Parser` object for the item content with `LoadOptions` and `ParserSettings`.

```csharp
public Parser OpenParser(LoadOptions loadOptions, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | The options to open the item content. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

##### Return Value

An instance of `Parser` class of the item content.

### OpenStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/openstream.md

#### ContainerItem.OpenStream method

Opens the stream of the item content.

```csharp
public Stream OpenStream()
```

##### Return Value

A stream with the item content.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/containeritem/size.md

#### ContainerItem.Size property

Gets the size of the item.

```csharp
public long Size { get; }
```

##### Property Value

An integer value that represents the size of the item in bytes.

### DocumentData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata.md

#### DocumentData class

Represents data of the document. It consists of `FieldData` objects which contain field data from document.

```csharp
public class DocumentData : IEnumerable<FieldData>
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentData(IEnumerable&lt;FieldData&gt;) | Initializes a new instance of the `DocumentData` class. |
| DocumentData(Template, IEnumerable&lt;FieldData&gt;) | Initializes a new instance of the `DocumentData` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of the fields data. |
| Item { get; } | Gets the field data by an index. |
| Template { get; } | Gets the template. |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns an enumerator for the fields data. |
| GetFieldsByName(string) | Returns the collection of field data where the name is equal to *fieldName*. |

##### Remarks

An instance of `DocumentData` class is used as return value of `ParseByTemplate` and `ParseForm` methods. See the usage examples there.

### Count
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/count.md

#### DocumentData.Count property

Gets the total number of the fields data.

```csharp
public int Count { get; }
```

##### Property Value

An integer value that represents the total number of the fields data.

### DocumentData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/documentdata.md

#### DocumentData(IEnumerable&lt;FieldData&gt;)

Initializes a new instance of the `DocumentData` class.

```csharp
public DocumentData(IEnumerable<FieldData> fields)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fields | IEnumerable`1 | The collection of fields data. |

#### DocumentData(Template, IEnumerable&lt;FieldData&gt;)

Initializes a new instance of the `DocumentData` class.

```csharp
public DocumentData(Template template, IEnumerable<FieldData> fields)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template. |
| fields | IEnumerable`1 | The collection of fields data. |

### GetEnumerator
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/getenumerator.md

#### DocumentData.GetEnumerator method

Returns an enumerator for the fields data.

```csharp
public IEnumerator<FieldData> GetEnumerator()
```

##### Return Value

An enumerator for the fields data.

### GetFieldsByName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/getfieldsbyname.md

#### DocumentData.GetFieldsByName method

Returns the collection of field data where the name is equal to *fieldName*.

```csharp
public IList<FieldData> GetFieldsByName(string fieldName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fieldName | String | The name of the field. |

##### Return Value

A collection of `FieldData` objects; empty collection if no field data is found.

##### Examples

Find fields by a field name:

```csharp
// Get all the fields with "Address" name
IList<FieldData> addressFields = data.GetFieldsByName("Address");
if(addressFields.Count == 0) {
    Console.WriteLine("Address not found");
}
else {
    Console.WriteLine("Address");
    // Iterate over the fields collection
    for (int i = 0; i < addressFields.Count; i++) {
        PageTextArea area = addressFields[i].PageArea as PageTextArea;
        Console.WriteLine(area == null ? "Not a template field" : area.Text);       
         
        // If it's a related field:
        if(addressFields[i].LinkedField != null) {
            Console.Write("Linked to ");
            PageTextArea linkedArea = addressFields[i].LinkedField.PageArea as PageTextArea;
            Console.WriteLine(area == null ? "Not a template field" : area.Text);           
        }
    }
}
```

`FieldData` class represents field data. Depending on the field `PageArea` property can contain any of the inheritors of `PageArea` class. For example, `ParseForm` method extracts only text fields.

### Item
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/item.md

#### DocumentData indexer

Gets the field data by an index.

```csharp
public FieldData this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the field. |

##### Return Value

An instance of `FieldData` class.

##### Examples

Iteration via all the fields:

```csharp
for (int i = 0; i < data.Count; i++)
{
    Console.Write(data[i].Name + ": ");
    PageTextArea area = data[i].PageArea as PageTextArea;
    Console.WriteLine(area == null ? "Not a template field" : area.Text);
}
```

`FieldData` class represents field data. Depending on the field `PageArea` property can contain any of the inheritors of `PageArea` class. For example, `ParseForm` method extracts only text fields:

```csharp
// Create the parser
using (Parser parser = new Parser(filePath))
{
    // Extract data from PDF Form
    DocumentData data = parser.ParseForm();
    // Iterate over extracted fields
    for (int i = 0; i < data.Count; i++)
    {
        // Get the extracted field
        FieldData field = data[i];
        // Print the field name
        Console.Write(field.Name + ": ");
        // Check if the field value is a text and print it
        PageTextArea area = field.PageArea as PageTextArea;
        Console.WriteLine(area == null ? "Not a template field" : area.Text);
    }
}
```

### Template
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentdata/template.md

#### DocumentData.Template property

Gets the template.

```csharp
public Template Template { get; }
```

##### Property Value

The template.

### DocumentPageData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentpagedata.md

#### DocumentPageData class

Represents data of the document page. It consists of `FieldData` objects which contain field data from the document page.

```csharp
public sealed class DocumentPageData : DocumentData
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentPageData(Template, IEnumerable&lt;FieldData&gt;, int) | Initializes a new instance of the `DocumentPageData` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of the fields data. |
| Item { get; } | Gets the field data by an index. |
| PageIndex { get; } | Gets the page index. |
| Template { get; } | Gets the template. |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns an enumerator for the fields data. |
| GetFieldsByName(string) | Returns the collection of field data where the name is equal to *fieldName*. |

### DocumentPageData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentpagedata/documentpagedata.md

#### DocumentPageData constructor

Initializes a new instance of the `DocumentPageData` class.

```csharp
public DocumentPageData(Template template, IEnumerable<FieldData> fields, int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template. |
| fields | IEnumerable`1 | The collection of fields data. |
| pageIndex | Int32 | The zero-based page index. |

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/documentpagedata/pageindex.md

#### DocumentPageData.PageIndex property

Gets the page index.

```csharp
public int PageIndex { get; }
```

##### Property Value

A zero-based index of the page.

### FieldData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata.md

#### FieldData class

Represents field data such as a name, a page index, a field value and so on. Depending on the field the value can be a text, an image, a table and so on.

```csharp
public sealed class FieldData
```

#### Constructors

| Name | Description |
| --- | --- |
| FieldData(string, PageArea) | Initializes a new instance of the `FieldData` class with UPPER CASE name. |
| FieldData(string, PageArea, bool) | Initializes a new instance of the `FieldData` class. |
| FieldData(string, PageArea, FieldData) | Initializes a new instance of the `FieldData` class with UPPER CASE name. |
| FieldData(string, PageArea, FieldData, bool) | Initializes a new instance of the `FieldData` class. |

#### Properties

| Name | Description |
| --- | --- |
| LinkedField { get; } | Gets the linked field. |
| Name { get; } | Gets the field name. |
| PageArea { get; } | Gets the value of the field. |
| PageIndex { get; } | Gets the page index. |
| Text { get; } | Gets the text. |
| UseUpperCaseName { get; } | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

##### Remarks

The instances of `FieldData` class are used in `DocumentData` collection.

### FieldData
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/fielddata.md

#### FieldData(string, PageArea, FieldData)

Initializes a new instance of the `FieldData` class with UPPER CASE name.

```csharp
public FieldData(string name, PageArea pageArea, FieldData linkedDataField)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the field. |
| pageArea | PageArea | The value of the field. |
| linkedDataField | FieldData | The field which is linked to the field. |

#### FieldData(string, PageArea, FieldData, bool)

Initializes a new instance of the `FieldData` class.

```csharp
public FieldData(string name, PageArea pageArea, FieldData linkedDataField, bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the field. |
| pageArea | PageArea | The value of the field. |
| linkedDataField | FieldData | The field which is linked to the field. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

#### FieldData(string, PageArea)

Initializes a new instance of the `FieldData` class with UPPER CASE name.

```csharp
public FieldData(string name, PageArea pageArea)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the field. |
| pageArea | PageArea | The value of the field. |

#### FieldData(string, PageArea, bool)

Initializes a new instance of the `FieldData` class.

```csharp
public FieldData(string name, PageArea pageArea, bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the field. |
| pageArea | PageArea | The value of the field. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

### LinkedField
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/linkedfield.md

#### FieldData.LinkedField property

Gets the linked field.

```csharp
public FieldData LinkedField { get; }
```

##### Property Value

An instance of `FieldData` class that represents the field which is linked to the field; `null` if it isn't set.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/name.md

#### FieldData.Name property

Gets the field name.

```csharp
public string Name { get; }
```

##### Property Value

An uppercase string value that represents the name of the field.

### PageArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/pagearea.md

#### FieldData.PageArea property

Gets the value of the field.

```csharp
public PageArea PageArea { get; }
```

##### Property Value

An instance of `PageArea` class that represents the value of the field.

##### Examples

Depending on field `PageArea` property can contain any of the inheritors of `PageArea` class. For example, `ParseForm` method extracts only text fields.

```csharp
// Get the field data
FieldData field = data[i];
// Check if the field data contains a text
if(field.PageArea is PageTextArea)
{
    // Print the field text value
    Console.WriteLine(field.Text);
}
```

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/pageindex.md

#### FieldData.PageIndex property

Gets the page index.

```csharp
public int PageIndex { get; }
```

##### Property Value

A zero-based index of the page that contains the field.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/text.md

#### FieldData.Text property

Gets the text.

```csharp
public string Text { get; }
```

##### Property Value

A string value that represents a value of the field text; `null` if `PageArea` property isn't `PageTextArea`.

### UseUpperCaseName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/fielddata/useuppercasename.md

#### FieldData.UseUpperCaseName property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

```csharp
public bool UseUpperCaseName { get; }
```

### HighlightItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/highlightitem.md

#### HighlightItem class

Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality.

```csharp
public sealed class HighlightItem
```

#### Properties

| Name | Description |
| --- | --- |
| Position { get; } | Gets the position in the document text. |
| Text { get; } | Gets the text of the highlight. |

##### Remarks

An instance of `HighlightItem` class is used as return value of `GetHighlight` method, `LeftHighlightItem` and `RightHighlightItem` properties. See the usage examples there.

### Position
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/highlightitem/position.md

#### HighlightItem.Position property

Gets the position in the document text.

```csharp
public int Position { get; }
```

##### Property Value

A zero-based index of the start position of the highlight.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/highlightitem/text.md

#### HighlightItem.Text property

Gets the text of the highlight.

```csharp
public string Text { get; }
```

##### Property Value

A string value that represents the text of the highlight.

### MetadataItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/metadataitem.md

#### MetadataItem class

Represents a metadata item which is used in container items and metadata extraction functionality.

```csharp
public sealed class MetadataItem
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataItem(string, string) | Initializes a new instance of the `MetadataItem` class. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Gets the name of the metadata item. |
| Value { get; } | Gets the value of the metadata item. |

##### Remarks

An instance of `MetadataItem` class is used as return value of `GetMetadata` method and as a item in `Metadata` collection. See the usage examples there.

### MetadataItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/metadataitem/metadataitem.md

#### MetadataItem constructor

Initializes a new instance of the `MetadataItem` class.

```csharp
public MetadataItem(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the metadata item. |
| value | String | The value of the metadata item. |

##### Remarks

An instance of `MetadataItem` class is used as return value of `GetMetadata` method.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/metadataitem/name.md

#### MetadataItem.Name property

Gets the name of the metadata item.

```csharp
public string Name { get; }
```

##### Property Value

A string value that represents the name of the metadata item.

### Value
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/metadataitem/value.md

#### MetadataItem.Value property

Gets the value of the metadata item.

```csharp
public string Value { get; }
```

##### Property Value

A string value that represents the value of the metadata item.

### Page
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/page.md

#### Page class

Represents the document page information such as page index and page size. It's used to represent the page that contains inheritors of `PageArea` class in the parsing by template functionality.

```csharp
public sealed class Page
```

#### Constructors

| Name | Description |
| --- | --- |
| Page(int, Size) | Initializes a new instance of the `Page` class. |

#### Properties

| Name | Description |
| --- | --- |
| Index { get; } | Gets the page index. |
| Size { get; } | Gets the page size. |

### Index
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/page/index.md

#### Page.Index property

Gets the page index.

```csharp
public int Index { get; }
```

##### Property Value

A zero-based index of the page.

### Page
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/page/page.md

#### Page constructor

Initializes a new instance of the `Page` class.

```csharp
public Page(int index, Size size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The page index. |
| size | Size | The page size. |

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/page/size.md

#### Page.Size property

Gets the page size.

```csharp
public Size Size { get; }
```

##### Property Value

An instance of `Size` class that represents the size of the page.

### PageArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagearea.md

#### PageArea class

Represents an abstract base class for page areas which are used to represent blocks on the document page in the parsing by template functionality.

```csharp
public abstract class PageArea
```

#### Properties

| Name | Description |
| --- | --- |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |

### Page
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagearea/page.md

#### PageArea.Page property

Gets the document page information such as page index and page size.

```csharp
public Page Page { get; }
```

##### Property Value

An instance of `Page` class that represents the page that contains the page area.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagearea/rectangle.md

#### PageArea.Rectangle property

Gets the rectangular area.

```csharp
public Rectangle Rectangle { get; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area of the page that contains the page area.

### PageBarcodeArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea.md

#### PageBarcodeArea class

Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality.

```csharp
public sealed class PageBarcodeArea : PageArea
```

#### Constructors

| Name | Description |
| --- | --- |
| PageBarcodeArea(string, string, int, double, Page, Rectangle) | Initializes a new instance of the `PageBarcodeArea` class. |

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; } | Gets the angle of the barcode. |
| CodeTypeName { get; } | Gets the name of the barcode type. |
| Confidence { get; } | Gets the level of confidence of the parsered barcode. |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |
| Value { get; } | Gets the barcode value. |

### Angle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea/angle.md

#### PageBarcodeArea.Angle property

Gets the angle of the barcode.

```csharp
public double Angle { get; }
```

##### Property Value

An integer value that represents the angle of the barcode (0-360).

### CodeTypeName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea/codetypename.md

#### PageBarcodeArea.CodeTypeName property

Gets the name of the barcode type.

```csharp
public string CodeTypeName { get; }
```

##### Property Value

A string value than represents a type name of the barcode.

### Confidence
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea/confidence.md

#### PageBarcodeArea.Confidence property

Gets the level of confidence of the parsered barcode.

```csharp
public int Confidence { get; }
```

##### Property Value

An integer value that represents the confidence of the parsered barcode (0-100).

### PageBarcodeArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea/pagebarcodearea.md

#### PageBarcodeArea constructor

Initializes a new instance of the `PageBarcodeArea` class.

```csharp
public PageBarcodeArea(string value, string codeTypeName, int confidence, double angle, Page page, 
    Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | String | The value of the barcode. |
| codeTypeName | String | The type name of the barcode. |
| confidence | Int32 | The level of confidence of the parsered barcode. |
| angle | Double | The angle of the barcode. |
| page | Page | The page that contains the barcode area. |
| rectangle | Rectangle | The rectangular area that contains the barcode area. |

### Value
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagebarcodearea/value.md

#### PageBarcodeArea.Value property

Gets the barcode value.

```csharp
public string Value { get; }
```

##### Property Value

A string value that represents a value of the barcode page area.

### PageGroupArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagegrouparea.md

#### PageGroupArea class

Represents a group of page areas which is used to group different types of blocks of the document page in the parsing by template functionality.

```csharp
public sealed class PageGroupArea : PageArea
```

#### Constructors

| Name | Description |
| --- | --- |
| PageGroupArea(IEnumerable&lt;PageArea&gt;, Page) | Initializes a new instance of the `PageGroupArea` class. |

#### Properties

| Name | Description |
| --- | --- |
| Areas { get; } | Gets the collection of grouped page areas. |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |

### Areas
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagegrouparea/areas.md

#### PageGroupArea.Areas property

Gets the collection of grouped page areas.

```csharp
public IEnumerable<PageArea> Areas { get; }
```

##### Property Value

A collection of `PageArea` objects.

### PageGroupArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagegrouparea/pagegrouparea.md

#### PageGroupArea constructor

Initializes a new instance of the `PageGroupArea` class.

```csharp
public PageGroupArea(IEnumerable<PageArea> areas, Page page)
```

| Parameter | Type | Description |
| --- | --- | --- |
| areas | IEnumerable`1 | The collection of page areas to be grouped. |
| page | Page | The page that contains the area. |

### PageHyperlinkArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagehyperlinkarea.md

#### PageHyperlinkArea class

Represents a page area which is used to represent a hyperlink on the page.

```csharp
public sealed class PageHyperlinkArea : PageArea
```

#### Constructors

| Name | Description |
| --- | --- |
| PageHyperlinkArea(string, string, Page, Rectangle) | Initializes a new instance of the `PageHyperlinkArea` class. |

#### Properties

| Name | Description |
| --- | --- |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |
| Text { get; } | Gets the hyperlink text. |
| Url { get; } | Gets the hyperlink URL. |

##### Remarks

An instance of `PageHyperlinkArea` class is used as return value of the following methods:

* `GetHyperlinks`
* `GetHyperlinks`
* `GetHyperlinks`
* `GetHyperlinks`

See the usage examples there.

### PageHyperlinkArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagehyperlinkarea/pagehyperlinkarea.md

#### PageHyperlinkArea constructor

Initializes a new instance of the `PageHyperlinkArea` class.

```csharp
public PageHyperlinkArea(string text, string url, Page page, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The hyperlink text. |
| url | String | The hyperlink URL. |
| page | Page | The page that contains the hyperlink. |
| rectangle | Rectangle | The rectangular area that contains the hyperlink. |

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagehyperlinkarea/text.md

#### PageHyperlinkArea.Text property

Gets the hyperlink text.

```csharp
public string Text { get; }
```

##### Property Value

A string value that represents hyperlink text.

### Url
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagehyperlinkarea/url.md

#### PageHyperlinkArea.Url property

Gets the hyperlink URL.

```csharp
public string Url { get; }
```

##### Property Value

A string value that represents hyperlink URL.

### PageImageArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea.md

#### PageImageArea class

Represents a page image area which is used to represent an image on the page in the parsing by template functionality or an image attachment if images are extracted from emails or Zip archives.

```csharp
public sealed class PageImageArea : PageArea
```

#### Constructors

| Name | Description |
| --- | --- |
| PageImageArea(Stream, FileType, double) | Initializes a new instance of the `PageImageArea` class. |
| PageImageArea(Stream, FileType, double, Page, Rectangle) | Initializes a new instance of the `PageImageArea` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the format of the image. |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |
| Rotation { get; } | Gets the rotation angle of the image. |

#### Methods

| Name | Description |
| --- | --- |
| GetImageStream() | Returns the image stream. |
| GetImageStream(ImageOptions) | Returns the image stream in a different format. |
| Save(string) | Saves the image to the file. |
| Save(string, ImageOptions) | Saves the image to the file in a different format. |

##### Remarks

An instance of `PageImageArea` class is used as return value of the following methods:

* `GetImages`
* `GetImages`
* `GetImages`
* `GetImages`

See the usage examples there.

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea/filetype.md

#### PageImageArea.FileType property

Gets the format of the image.

```csharp
public FileType FileType { get; }
```

##### Property Value

An instance of `FileType` class that represents the format of the image.

### GetImageStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea/getimagestream.md

#### GetImageStream()

Returns the image stream.

```csharp
public Stream GetImageStream()
```

##### Return Value

A stream with the image.

##### Examples

The following example shows how to save images to files:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract images from document
    IEnumerable<PageImageArea> images = parser.GetImages();
    
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Page images extraction isn't supported");
        return;
    }

    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Open the image stream
        using (Stream imageStream = image.GetImageStream())
        {
            // Create the file to save image
            using (Stream destStream = File.Create(Guid.NewGuid().ToString() + image.FileType.Extension))
            {
                byte[] buffer = new byte[4096];
                int readed = 0;

                do
                {
                    // Read data from the image stream
                    readed = imageStream.Read(buffer, 0, buffer.Length);

                    if (readed > 0)
                    {
                        // Write data to the file stream
                        destStream.Write(buffer, 0, readed);
                    }
                }
                while (readed > 0);
            }
        }
    }
}
```

#### GetImageStream(ImageOptions)

Returns the image stream in a different format.

```csharp
public Stream GetImageStream(ImageOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ImageOptions | The options which are used to extract the image. |

##### Return Value

A stream with the image.

##### Examples

The following example shows how to save images to files in a different format:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract images from document
    IEnumerable<PageImageArea> images = parser.GetImages();
    
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Page images extraction isn't supported");
        return;
    }

    // Create the options to save images in PNG format
    ImageOptions options = new ImageOptions(ImageFormat.Png);
    
    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Open the image stream
        using (Stream imageStream = image.GetImageStream(options))
        {
            // Create the file to save image
            using (Stream destStream = File.Create(Guid.NewGuid().ToString() + ".png"))
            {
                byte[] buffer = new byte[4096];
                int readed = 0;

                do
                {
                    // Read data from the image stream
                    readed = imageStream.Read(buffer, 0, buffer.Length);

                    if (readed > 0)
                    {
                        // Write data to the file stream
                        destStream.Write(buffer, 0, readed);
                    }
                }
                while (readed > 0);
            }
        }
    }
}
```

### PageImageArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea/pageimagearea.md

#### PageImageArea(Stream, FileType, double)

Initializes a new instance of the `PageImageArea` class.

```csharp
public PageImageArea(Stream imageStream, FileType fileType, double rotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | The stream of the image. |
| fileType | FileType | The format of the image. |
| rotation | Double | The rotation angle of the image. |

#### PageImageArea(Stream, FileType, double, Page, Rectangle)

Initializes a new instance of the `PageImageArea` class.

```csharp
public PageImageArea(Stream imageStream, FileType fileType, double rotation, Page page, 
    Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | The stream of the image. |
| fileType | FileType | The format of the image. |
| rotation | Double | The rotation angle of the image. |
| page | Page | The page that contains the image. |
| rectangle | Rectangle | The rectangular area that contains the image. |

### Rotation
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea/rotation.md

#### PageImageArea.Rotation property

Gets the rotation angle of the image.

```csharp
public double Rotation { get; }
```

##### Property Value

A double value that represents the rotation angle of the image.

### Save
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pageimagearea/save.md

#### Save(string)

Saves the image to the file.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |

##### Examples

The following example shows how to save images to files:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract images from document
    IEnumerable<PageImageArea> images = parser.GetImages();
    
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Page images extraction isn't supported");
        return;
    }

    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Save the image to the file
        image.Save(Guid.NewGuid().ToString() + image.FileType.Extension);
    }
}
```

#### Save(string, ImageOptions)

Saves the image to the file in a different format.

```csharp
public void Save(string filePath, ImageOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |
| options | ImageOptions | The options which are used to save the image. |

##### Examples

The following example shows how to save images to files in a different format:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract images from document
    IEnumerable<PageImageArea> images = parser.GetImages();
    
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Page images extraction isn't supported");
        return;
    }

    // Create the options to save images in PNG format
    ImageOptions options = new ImageOptions(ImageFormat.Png);
    
    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Save the image to the png file
        image.Save(Guid.NewGuid().ToString() + ".png", options);
    }
}
```

### PageTableArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea.md

#### PageTableArea class

Represents a table page area which is used to represent a table in the parsing by template functionality.

```csharp
public sealed class PageTableArea : PageArea
```

#### Properties

| Name | Description |
| --- | --- |
| Cells { get; } | Gets the collection of cells. |
| ColumnCount { get; } | Gets the total number of the table colums. |
| Item { get; } | Gets the table cell by row and column indexes. |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |
| RowCount { get; } | Gets the total number of the table rows. |

#### Methods

| Name | Description |
| --- | --- |
| GetColumnWidth(int) | Returns the column width. |
| GetRowHeight(int) | Returns the row height. |

##### Remarks

`PageTableArea` class is used to organize inheritors of `PageArea` class in table structure.

### Cells
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/cells.md

#### PageTableArea.Cells property

Gets the collection of cells.

```csharp
public ICollection<PageTableAreaCell> Cells { get; }
```

##### Property Value

A plain read-only collection of table cells.

### ColumnCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/columncount.md

#### PageTableArea.ColumnCount property

Gets the total number of the table colums.

```csharp
public int ColumnCount { get; }
```

##### Property Value

An integer value that contains the total number of the table columns.

### GetColumnWidth
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/getcolumnwidth.md

#### PageTableArea.GetColumnWidth method

Returns the column width.

```csharp
public double GetColumnWidth(int columnIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| columnIndex | Int32 | The zero-based index of the column. |

##### Return Value

A double value that represents the width of the column.

### GetRowHeight
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/getrowheight.md

#### PageTableArea.GetRowHeight method

Returns the row height.

```csharp
public double GetRowHeight(int rowIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | Int32 | The zero-based index of the row. |

##### Return Value

A double value that represents the height of the row.

### Item
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/item.md

#### PageTableArea indexer

Gets the table cell by row and column indexes.

```csharp
public PageTableAreaCell this[int rowIndex, int columnIndex] { get; }
```

| Parameter | Description |
| --- | --- |
| rowIndex | The zero-based index of the cell row. |
| columnIndex | The zero-based index of the cell column. |

##### Return Value

An instance of `PageTableAreaCell` class; `null` if no cell is found.

### RowCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetablearea/rowcount.md

#### PageTableArea.RowCount property

Gets the total number of the table rows.

```csharp
public int RowCount { get; }
```

##### Property Value

An integer value that contains the total number of the table rows.

### PageTableAreaCell
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell.md

#### PageTableAreaCell class

Represents a table cell which is used in `PageTableArea` class.

```csharp
public sealed class PageTableAreaCell
```

#### Constructors

| Name | Description |
| --- | --- |
| PageTableAreaCell(int, int, PageArea) | Initializes a new instance of the `PageTableAreaCell` class. |
| PageTableAreaCell(int, int, PageArea, int, int) | Initializes a new instance of the `PageTableAreaCell` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColumnIndex { get; } | Gets the column index. |
| ColumnSpan { get; } | Gets the total number of columns that contain the table cell. |
| PageArea { get; } | Gets the table cell value. |
| RowIndex { get; } | Gets the row index. |
| RowSpan { get; } | Gets the total number of rows that contain the table cell. |
| Text { get; } | Gets the table cell text value. |

### ColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/columnindex.md

#### PageTableAreaCell.ColumnIndex property

Gets the column index.

```csharp
public int ColumnIndex { get; }
```

##### Property Value

A zero-based index of the first column that contains the table cell.

### ColumnSpan
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/columnspan.md

#### PageTableAreaCell.ColumnSpan property

Gets the total number of columns that contain the table cell.

```csharp
public int ColumnSpan { get; }
```

##### Property Value

A positive integer value that represents the total number of columns that contain the table cell.

### PageArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/pagearea.md

#### PageTableAreaCell.PageArea property

Gets the table cell value.

```csharp
public PageArea PageArea { get; }
```

##### Property Value

An instance of `PageArea` class that represents a value of the table cell.

##### Remarks

Depending on cell `PageArea` property can contain any of the inheritors of `PageArea` class.

### PageTableAreaCell
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/pagetableareacell.md

#### PageTableAreaCell(int, int, PageArea, int, int)

Initializes a new instance of the `PageTableAreaCell` class.

```csharp
public PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea, int rowSpan, 
    int columnSpan)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | Int32 | The zero-based index of the row. |
| columnIndex | Int32 | The zero-based index of the column. |
| pageArea | PageArea | The value of the table cell. |
| rowSpan | Int32 | The total number of rows that contain the table cell. |
| columnSpan | Int32 | The total number of columns that contain the table cell. |

#### PageTableAreaCell(int, int, PageArea)

Initializes a new instance of the `PageTableAreaCell` class.

```csharp
public PageTableAreaCell(int rowIndex, int columnIndex, PageArea pageArea)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | Int32 | The zero-based index of the row. |
| columnIndex | Int32 | The zero-based index of the column. |
| pageArea | PageArea | The value of the table cell. |

### RowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/rowindex.md

#### PageTableAreaCell.RowIndex property

Gets the row index.

```csharp
public int RowIndex { get; }
```

##### Property Value

A zero-based index of the first row that contains the table cell.

### RowSpan
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/rowspan.md

#### PageTableAreaCell.RowSpan property

Gets the total number of rows that contain the table cell.

```csharp
public int RowSpan { get; }
```

##### Property Value

A positive integer value that represents the total number of rows that contain the table cell.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetableareacell/text.md

#### PageTableAreaCell.Text property

Gets the table cell text value.

```csharp
public string Text { get; }
```

##### Property Value

A string that represents a text value of the cell; `null` if cell doesn't contain a text value.

### PageTextArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea.md

#### PageTextArea class

Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality.

```csharp
public sealed class PageTextArea : PageArea
```

#### Constructors

| Name | Description |
| --- | --- |
| PageTextArea(IEnumerable&lt;PageTextArea&gt;, Page) | Initializes a new instance of the `PageTextArea` class. |
| PageTextArea(string, Page, Rectangle) | Initializes a new instance of the `PageTextArea` class. |
| PageTextArea(string, double?, TextStyle, Page, Rectangle) | Initializes a new instance of the `PageTextArea` class. |

#### Properties

| Name | Description |
| --- | --- |
| Areas { get; } | Gets the collection of child text page areas. |
| BaseLine { get; } | Gets the base line. |
| Page { get; } | Gets the document page information such as page index and page size. |
| Rectangle { get; } | Gets the rectangular area. |
| Text { get; } | Gets the text. |
| TextStyle { get; } | Gets the text style such as font size, font name an so on. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Converts the value of this instance to String. |

##### Remarks

An instance of `PageTextArea` class is used as return value of the following methods:

* `GetTextAreas`
* `GetTextAreas`
* `GetTextAreas`
* `GetTextAreas`

Also an instance of `PageTextArea` class is used as value of `PageArea` property.

See the usage examples there.

The text area can be single or composite. In the first case it contains a text which is bounded by a rectangular area. In the second case it contains other text areas; text and table properties are calculated by child text areas.

### Areas
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/areas.md

#### PageTextArea.Areas property

Gets the collection of child text page areas.

```csharp
public IList<PageTextArea> Areas { get; }
```

##### Property Value

A collection of child text page areas; empty if the text page area hasn't children.

### BaseLine
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/baseline.md

#### PageTextArea.BaseLine property

Gets the base line.

```csharp
public double BaseLine { get; }
```

##### Property Value

A double value that represents the base line.

### PageTextArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/pagetextarea.md

#### PageTextArea(string, Page, Rectangle)

Initializes a new instance of the `PageTextArea` class.

```csharp
public PageTextArea(string text, Page page, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The value of the text. |
| page | Page | The page that contains the text area. |
| rectangle | Rectangle | The rectangular area that contains the text area. |

#### PageTextArea(string, double?, TextStyle, Page, Rectangle)

Initializes a new instance of the `PageTextArea` class.

```csharp
public PageTextArea(string text, double? baseLine, TextStyle textStyle, Page page, 
    Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The value of the text. |
| baseLine | Nullable`1 | The base line of the text. |
| textStyle | TextStyle | The style of the text. |
| page | Page | The page that contains the text area. |
| rectangle | Rectangle | The rectangular area that contains the text area. |

#### PageTextArea(IEnumerable&lt;PageTextArea&gt;, Page)

Initializes a new instance of the `PageTextArea` class.

```csharp
public PageTextArea(IEnumerable<PageTextArea> areas, Page page)
```

| Parameter | Type | Description |
| --- | --- | --- |
| areas | IEnumerable`1 | The collecton of child text page areas. |
| page | Page | The page that contains the text area. |

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/text.md

#### PageTextArea.Text property

Gets the text.

```csharp
public string Text { get; }
```

##### Property Value

A string value that represents a value of the text page area.

### TextStyle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/textstyle.md

#### PageTextArea.TextStyle property

Gets the text style such as font size, font name an so on.

```csharp
public TextStyle TextStyle { get; }
```

##### Property Value

An instance of `TextStyle` class that represents the text style.

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/pagetextarea/tostring.md

#### PageTextArea.ToString method

Converts the value of this instance to String.

```csharp
public override string ToString()
```

##### Return Value

A string whose value is the same as this instance.

### Point
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point.md

#### Point class

Represents a point.

```csharp
public sealed class Point : IEquatable<Point>
```

#### Constructors

| Name | Description |
| --- | --- |
| Point(double, double) | Initializes a new instance of the `Point` class. |

#### Properties

| Name | Description |
| --- | --- |
| X { get; } | Gets the x-coordinate. |
| Y { get; } | Gets the y-coordinate. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Converts the string representation of a point to its class equivalent. |
| override Equals(object) | Determines whether the current `Point` is the same as specified object. |
| Equals(Point) | Determines whether the current `Point` is the same as specified `Point` object. |
| override GetHashCode() | Returns the hash code for the current `Point` object. |
| override ToString() | Converts the value of this instance to String. |
| static TryParse(string, out Point) | Converts the string representation of a point to its class equivalent. A return value indicates whether the conversion is succeeded or failed. |
| operator == | Determines whether two `Point` objects are the same. |
| operator != | Determines whether two `Point` objects are not the same. |

### Equals
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/equals.md

#### Equals(object)

Determines whether the current `Point` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `Point` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `Point` and is the same as current `Point` object; otherwise,

```csharp
false
```

#### Equals(Point)

Determines whether the current `Point` is the same as specified `Point` object.

```csharp
public bool Equals(Point other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Point | The object to compare with the current `Point` object. |

##### Return Value

```csharp
true
```

if both `Point` objects are the same; otherwise,

```csharp
false
```

### GetHashCode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/gethashcode.md

#### Point.GetHashCode method

Returns the hash code for the current `Point` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `Point` object.

### op_Equality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/op_equality.md

#### Point Equality operator

Determines whether two `Point` objects are the same.

```csharp
public static bool operator ==(Point left, Point right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | Left `Point` object. |
| right | Point | Right `Point` object. |

##### Return Value

```csharp
true
```

if both `Point` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/op_inequality.md

#### Point Inequality operator

Determines whether two `Point` objects are not the same.

```csharp
public static bool operator !=(Point left, Point right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Point | Left `Point` object. |
| right | Point | Right `Point` object. |

##### Return Value

```csharp
true
```

if both `Point` objects are not the same; otherwise,

```csharp
false
```

### Parse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/parse.md

#### Point.Parse method

Converts the string representation of a point to its class equivalent.

```csharp
public static Point Parse(string s)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string that contains a point to convert. |

##### Return Value

An instance of `Point` class that is equivalent to the value specified in *s* parameter.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | *s* does not represent a point in a valid format. |

### Point
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/point.md

#### Point constructor

Initializes a new instance of the `Point` class.

```csharp
public Point(double x, double y)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Double | The x-coordinate. |
| y | Double | The y-coordinate. |

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/tostring.md

#### Point.ToString method

Converts the value of this instance to String.

```csharp
public override string ToString()
```

##### Return Value

A string whose value is the same as this instance.

### TryParse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/tryparse.md

#### Point.TryParse method

Converts the string representation of a point to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

```csharp
public static bool TryParse(string s, out Point point)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string containing a point to convert. |
| point | Point& | When the method returns, it contains the instance of `Point` class that is equivalent to the value specified in *s* parameter, if the conversion is succeeded; otherwise, `null`. |

##### Return Value

`true` if *s* is converted successfully; otherwise, `false`.

### X
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/x.md

#### Point.X property

Gets the x-coordinate.

```csharp
public double X { get; }
```

##### Property Value

A double value that represents the x-coordinate.

### Y
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/point/y.md

#### Point.Y property

Gets the y-coordinate.

```csharp
public double Y { get; }
```

##### Property Value

A double value that represents the y-coordinate.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle.md

#### Rectangle class

Represents a rectangular area.

```csharp
public sealed class Rectangle
```

#### Constructors

| Name | Description |
| --- | --- |
| Rectangle(Point, Size) | Initializes a new instance of the `Rectangle` class. |
| Rectangle(double, double, double, double) | Initializes a new instance of the `Rectangle` class. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; } | Gets the y-coordinate of the bottom edge of the rectangular area. |
| Left { get; } | Gets the x-coordinate of the left edge of the rectangular area. |
| Position { get; } | Gets the coordinates of the upper-left corner of the rectangular area. |
| Right { get; } | Gets the x-coordinate of the right egde of the rectangular area. |
| Size { get; } | Gets the size. |
| Top { get; } | Gets the y-coordinate of the top edge of the rectangular area. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Converts the value of this instance to String. |

### Bottom
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/bottom.md

#### Rectangle.Bottom property

Gets the y-coordinate of the bottom edge of the rectangular area.

```csharp
public double Bottom { get; }
```

##### Property Value

A double value that represents the y-coordinate of the bottom edge of the rectangular area.

### Left
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/left.md

#### Rectangle.Left property

Gets the x-coordinate of the left edge of the rectangular area.

```csharp
public double Left { get; }
```

##### Property Value

A double value that represents the x-coordinate of the left edge of the rectangular area.

### Position
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/position.md

#### Rectangle.Position property

Gets the coordinates of the upper-left corner of the rectangular area.

```csharp
public Point Position { get; }
```

##### Property Value

An instance of `Point` class that represents the coordinates of the upper-left corner of the rectangular area.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/rectangle.md

#### Rectangle(double, double, double, double)

Initializes a new instance of the `Rectangle` class.

```csharp
public Rectangle(double left, double top, double right, double bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Double | The x-coordinate of the left edge of the rectangular area. |
| top | Double | The y-coordinate of the top edge of the rectangular area. |
| right | Double | The x-coordinate of the right edge of the rectangular area. |
| bottom | Double | The y-coordinate of the bottom edge of the rectangular area. |

#### Rectangle(Point, Size)

Initializes a new instance of the `Rectangle` class.

```csharp
public Rectangle(Point position, Size size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| position | Point | The coordinates of the upper-left corner of the rectangular area. |
| size | Size | The size of the rectangular area. |

### Right
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/right.md

#### Rectangle.Right property

Gets the x-coordinate of the right egde of the rectangular area.

```csharp
public double Right { get; }
```

##### Property Value

A double value that represents the x-coordinate of the right edge of the rectangular area.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/size.md

#### Rectangle.Size property

Gets the size.

```csharp
public Size Size { get; }
```

##### Property Value

An instance of `Size` class that represents the size of the rectangular area.

### Top
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/top.md

#### Rectangle.Top property

Gets the y-coordinate of the top edge of the rectangular area.

```csharp
public double Top { get; }
```

##### Property Value

A double value that represents the y-coordinate of the top edge of the rectangular area.

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/rectangle/tostring.md

#### Rectangle.ToString method

Converts the value of this instance to String.

```csharp
public override string ToString()
```

##### Return Value

A string whose value is the same as this instance.

### SearchResult
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult.md

#### SearchResult class

Represents the search result in the search functionality.

```csharp
public sealed class SearchResult
```

#### Properties

| Name | Description |
| --- | --- |
| LeftHighlightItem { get; } | Gets the left highlight. |
| PageIndex { get; } | Gets the page index where the text is found. |
| Position { get; } | Gets the position in the document text. |
| RightHighlightItem { get; } | Gets the right highlight. |
| Text { get; } | Gets the text. |

##### Remarks

An instance of `SearchResult` class is used as return value of `Search` and `Search` methods. See the usage examples there.

### LeftHighlightItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult/lefthighlightitem.md

#### SearchResult.LeftHighlightItem property

Gets the left highlight.

```csharp
public HighlightItem LeftHighlightItem { get; }
```

##### Property Value

An instance of `HighlightItem` class; `null` if it isn't set.

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult/pageindex.md

#### SearchResult.PageIndex property

Gets the page index where the text is found.

```csharp
public int? PageIndex { get; }
```

##### Property Value

A zero-based index of the page where the text is found; `null` if the seach is performed on the whole document text.

### Position
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult/position.md

#### SearchResult.Position property

Gets the position in the document text.

```csharp
public int Position { get; }
```

##### Property Value

A zero-based index of the start position of the search result. Depeding on `SearchByPages` property value this index starts from the document start or the document page start.

### RightHighlightItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult/righthighlightitem.md

#### SearchResult.RightHighlightItem property

Gets the right highlight.

```csharp
public HighlightItem RightHighlightItem { get; }
```

##### Property Value

An instance of `HighlightItem` class; `null` if it isn't set.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/searchresult/text.md

#### SearchResult.Text property

Gets the text.

```csharp
public string Text { get; }
```

##### Property Value

A string value that respresents the found text.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size.md

#### Size class

Represents a size.

```csharp
public sealed class Size
```

#### Constructors

| Name | Description |
| --- | --- |
| Size(double, double) | Initializes a new instance of the `Size` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height. |
| IsEmpty { get; } | Gets a value that indicates whether the size is empty. |
| Width { get; } | Gets the width. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Converts the string representation of a size to its class equivalent. |
| override ToString() | Converts the value of this instance to String. |
| static TryParse(string, out Size) | Converts the string representation of a size to its class equivalent. A return value indicates whether the conversion is succeeded or failed. |

### Height
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/height.md

#### Size.Height property

Gets the height.

```csharp
public double Height { get; }
```

##### Property Value

A double value that represents the height in pixels.

### IsEmpty
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/isempty.md

#### Size.IsEmpty property

Gets a value that indicates whether the size is empty.

```csharp
public bool IsEmpty { get; }
```

##### Return Value

`true` if the `Width` and `Height` are zero; otherwise, `false`.

### Parse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/parse.md

#### Size.Parse method

Converts the string representation of a size to its class equivalent.

```csharp
public static Size Parse(string s)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string that contains a size to convert. |

##### Return Value

An instance of `Size` class that is equivalent to the value specified in *s* parameter.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | *s* does not represent a size in a valid format. |

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/size.md

#### Size constructor

Initializes a new instance of the `Size` class.

```csharp
public Size(double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Double | The width in pixels. |
| height | Double | The height in pixels. |

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/tostring.md

#### Size.ToString method

Converts the value of this instance to String.

```csharp
public override string ToString()
```

##### Return Value

A string whose value is the same as this instance.

### TryParse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/tryparse.md

#### Size.TryParse method

Converts the string representation of a size to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

```csharp
public static bool TryParse(string s, out Size size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string containing a size to convert. |
| size | Size& | When the method returns, it contains the instance of `Size` class that is equivalent to the value specified in *s* parameter, if the conversion is succeeded; otherwise, `null`. |

##### Return Value

`true` if *s* is converted successfully; otherwise, `false`.

### Width
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/size/width.md

#### Size.Width property

Gets the width.

```csharp
public double Width { get; }
```

##### Property Value

A double value that represents the width in pixels.

### TextStyle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle.md

#### TextStyle class

Represents the style of the text such as a font name, a font size and so on.

```csharp
public sealed class TextStyle
```

#### Constructors

| Name | Description |
| --- | --- |
| TextStyle(string, string, double, bool, bool) | Initializes a new instance of the `TextStyle` class. |

#### Properties

| Name | Description |
| --- | --- |
| FontName { get; } | Gets the font name. |
| FontSize { get; } | Gets the font size. |
| IsBold { get; } | Gets the value that indicates whether the font is bold. |
| IsItalic { get; } | Gets a value that indicates whether the font is italic. |
| Name { get; } | Gets the style name. |

### FontName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/fontname.md

#### TextStyle.FontName property

Gets the font name.

```csharp
public string FontName { get; }
```

##### Property Value

A string value that represents the font name.

### FontSize
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/fontsize.md

#### TextStyle.FontSize property

Gets the font size.

```csharp
public double FontSize { get; }
```

##### Property Value

A double value that represents the font size.

### IsBold
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/isbold.md

#### TextStyle.IsBold property

Gets the value that indicates whether the font is bold.

```csharp
public bool IsBold { get; }
```

##### Return Value

`true` if the font is bold; otherwise, `false`.

### IsItalic
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/isitalic.md

#### TextStyle.IsItalic property

Gets a value that indicates whether the font is italic.

```csharp
public bool IsItalic { get; }
```

##### Return Value

`true` if the font is italic; otherwise, `false`.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/name.md

#### TextStyle.Name property

Gets the style name.

```csharp
public string Name { get; }
```

##### Property Value

A string value that represents the style name.

### TextStyle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/textstyle/textstyle.md

#### TextStyle constructor

Initializes a new instance of the `TextStyle` class.

```csharp
public TextStyle(string name, string fontName, double fontSize, bool isBold, bool isItalic)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the style. |
| fontName | String | The name of the font. |
| fontSize | Double | The size of the font. |
| isBold | Boolean | The value that indicates whether the font is bold. |
| isItalic | Boolean | The value that indicates whether the font is italic. |

### TocItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem.md

#### TocItem class

Represents the item which is used in the table of contents extraction functionality.

```csharp
public class TocItem
```

#### Constructors

| Name | Description |
| --- | --- |
| TocItem(int, string, int?) | Initializes a new instance of the `TocItem` class. |

#### Properties

| Name | Description |
| --- | --- |
| Depth { get; } | Gets the depth level. |
| PageIndex { get; } | Gets the page index. |
| Text { get; } | Gets the text. |

#### Methods

| Name | Description |
| --- | --- |
| virtual ExtractText() | Extracts a text from the document to which `TocItem` object refers. |

##### Remarks

An instance of `TocItem` class is used as return value of `GetToc` methods. See the usage examples there.

### Depth
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem/depth.md

#### TocItem.Depth property

Gets the depth level.

```csharp
public int Depth { get; }
```

##### Property Value

An integer value that represents the depth level of the item.

### ExtractText
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem/extracttext.md

#### TocItem.ExtractText method

Extracts a text from the document to which `TocItem` object refers.

```csharp
public virtual TextReader ExtractText()
```

##### Return Value

An instance of TextReader class with the extracted text.

##### Examples

The following example how to extract a text by the an item of table of contents:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(Constants.SampleDocxWithToc))
{
    // Get table of contents
    IEnumerable<TocItem> tocItems = parser.GetToc();
    // Check if toc extraction is supported
    if (tocItems == null)
    {
        Console.WriteLine("Table of contents extraction isn't supported");
    }
    // Iterate over items
    foreach (TocItem tocItem in tocItems)
    {
        // Print the text of the chapter
        using (TextReader reader = tocItem.ExtractText())
        {
            Console.WriteLine("----");
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem/pageindex.md

#### TocItem.PageIndex property

Gets the page index.

```csharp
public int? PageIndex { get; }
```

##### Property Value

An integer value that represents the index of the page referenced by the item; `null` if it isn't set.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem/text.md

#### TocItem.Text property

Gets the text.

```csharp
public string Text { get; }
```

##### Property Value

A string value that represents the text of the item.

### TocItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/tocitem/tocitem.md

#### TocItem constructor

Initializes a new instance of the `TocItem` class.

```csharp
public TocItem(int depth, string text, int? pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| depth | Int32 | The depth level of the item. |
| text | String | The text of the item. |
| pageIndex | Nullable`1 | The index of the page referenced by the item |

### WorksheetCell
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell.md

#### WorksheetCell class

Represents a worksheet cell.

```csharp
public sealed class WorksheetCell
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetCell(int, int, int, string) | Initializes a new instance of the `WorksheetCell` class. |
| WorksheetCell(int, int, int, int, int, string) | Initializes a new instance of the `WorksheetCell` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColumnIndex { get; } | Gets the column index. |
| ColumnSpan { get; } | Gets the total number of columns that contain the cell. |
| RowIndex { get; } | Gets the row index. |
| RowSpan { get; } | Gets the total number of rows that contain the cell. |
| Text { get; } | Gets the worksheet cell text value. |
| WorksheetIndex { get; } | Gets the worksheet index. |

### ColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/columnindex.md

#### WorksheetCell.ColumnIndex property

Gets the column index.

```csharp
public int ColumnIndex { get; }
```

##### Property Value

A zero-based index of the first column that contains the cell.

### ColumnSpan
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/columnspan.md

#### WorksheetCell.ColumnSpan property

Gets the total number of columns that contain the cell.

```csharp
public int ColumnSpan { get; }
```

##### Property Value

A positive integer value that represents the total number of columns that contain the cell.

### RowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/rowindex.md

#### WorksheetCell.RowIndex property

Gets the row index.

```csharp
public int RowIndex { get; }
```

##### Property Value

A zero-based index of the first row that contains the cell.

### RowSpan
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/rowspan.md

#### WorksheetCell.RowSpan property

Gets the total number of rows that contain the cell.

```csharp
public int RowSpan { get; }
```

##### Property Value

A positive integer value that represents the total number of rows that contain the cell.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/text.md

#### WorksheetCell.Text property

Gets the worksheet cell text value.

```csharp
public string Text { get; }
```

##### Property Value

A string that represents a text value of the cell; `null` if cell doesn't contain a text value.

### WorksheetCell
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/worksheetcell.md

#### WorksheetCell(int, int, int, string)

Initializes a new instance of the `WorksheetCell` class.

```csharp
public WorksheetCell(int worksheetIndex, int rowIndex, int columnIndex, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | The zero-based index of the worksheet. |
| rowIndex | Int32 | The zero-based index of the row. |
| columnIndex | Int32 | The zero-based index of the column. |
| text | String | the worksheet cell text value. |

#### WorksheetCell(int, int, int, int, int, string)

Initializes a new instance of the `WorksheetCell` class.

```csharp
public WorksheetCell(int worksheetIndex, int rowIndex, int columnIndex, int rowSpan, 
    int columnSpan, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | The zero-based index of the worksheet. |
| rowIndex | Int32 | The zero-based index of the row. |
| columnIndex | Int32 | The zero-based index of the column. |
| rowSpan | Int32 | The total number of rows that contain the cell. |
| columnSpan | Int32 | The total number of columns that contain the cell. |
| text | String | the worksheet cell text value. |

### WorksheetIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetcell/worksheetindex.md

#### WorksheetCell.WorksheetIndex property

Gets the worksheet index.

```csharp
public int WorksheetIndex { get; }
```

##### Property Value

A zero-based index of the worksheet that contains the cell.

### WorksheetInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo.md

#### WorksheetInfo class

Represents a sheet info.

```csharp
public sealed class WorksheetInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetInfo(int, string, WorksheetRange) | Initializes a new instance of the `WorksheetInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| Index { get; } | Gets an index of the worksheet. |
| IsEmpty { get; } | Gets a value that indicates whether the worksheet is empty. |
| MaxColumnIndex { get; } | Gets an index of the last column. |
| MaxRowIndex { get; } | Gets an index of the last row. |
| MinColumnIndex { get; } | Gets an index of the first column. |
| MinRowIndex { get; } | Gets an index of the first row. |
| Name { get; } | Gets a name of the worksheet. |

### Index
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/index.md

#### WorksheetInfo.Index property

Gets an index of the worksheet.

```csharp
public int Index { get; }
```

##### Property Value

The zero-based index of the worksheet.

### IsEmpty
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/isempty.md

#### WorksheetInfo.IsEmpty property

Gets a value that indicates whether the worksheet is empty.

```csharp
public bool IsEmpty { get; }
```

##### Return Value

`true` if the worksheet is empty; otherwise, `false`.

### MaxColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/maxcolumnindex.md

#### WorksheetInfo.MaxColumnIndex property

Gets an index of the last column.

```csharp
public int MaxColumnIndex { get; }
```

##### Property Value

The zero-based index of the last column.

### MaxRowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/maxrowindex.md

#### WorksheetInfo.MaxRowIndex property

Gets an index of the last row.

```csharp
public int MaxRowIndex { get; }
```

##### Property Value

The zero-based index of the last row.

### MinColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/mincolumnindex.md

#### WorksheetInfo.MinColumnIndex property

Gets an index of the first column.

```csharp
public int MinColumnIndex { get; }
```

##### Property Value

The zero-based index of the first column.

### MinRowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/minrowindex.md

#### WorksheetInfo.MinRowIndex property

Gets an index of the first row.

```csharp
public int MinRowIndex { get; }
```

##### Property Value

The zero-based index of the first row.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/name.md

#### WorksheetInfo.Name property

Gets a name of the worksheet.

```csharp
public string Name { get; }
```

##### Property Value

A string value that represents the worksheet name.

### WorksheetInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetinfo/worksheetinfo.md

#### WorksheetInfo constructor

Initializes a new instance of the `WorksheetInfo` class.

```csharp
public WorksheetInfo(int index, string name, WorksheetRange range)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index of the worksheet. |
| name | String | A string value that represents the worksheet name. |
| range | WorksheetRange | An instance of `WorksheetRange` class that represents the size of the worksheet. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | An index of the worksheet can't be negative. |
| ArgumentNullException | The size of the worksheet can't be `null`. |

### WorksheetRange
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange.md

#### WorksheetRange class

Provides the range which are used for the worksheet extraction.

```csharp
public sealed class WorksheetRange
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetRange(int, int, int, int) | Initializes a new instance of the `WorksheetRange` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsEmpty { get; } | Gets a value that indicates whether the range is empty. |
| MaxColumnIndex { get; } | Gets an index of the last column. |
| MaxRowIndex { get; } | Gets an index of the last row. |
| MinColumnIndex { get; } | Gets an index of the first column. |
| MinRowIndex { get; } | Gets an index of the first row. |

### IsEmpty
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/isempty.md

#### WorksheetRange.IsEmpty property

Gets a value that indicates whether the range is empty.

```csharp
public bool IsEmpty { get; }
```

##### Return Value

`true` if the range is empty; otherwise, `false`.

### MaxColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/maxcolumnindex.md

#### WorksheetRange.MaxColumnIndex property

Gets an index of the last column.

```csharp
public int MaxColumnIndex { get; }
```

##### Property Value

The zero-based index of the last column.

### MaxRowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/maxrowindex.md

#### WorksheetRange.MaxRowIndex property

Gets an index of the last row.

```csharp
public int MaxRowIndex { get; }
```

##### Property Value

The zero-based index of the last row.

### MinColumnIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/mincolumnindex.md

#### WorksheetRange.MinColumnIndex property

Gets an index of the first column.

```csharp
public int MinColumnIndex { get; }
```

##### Property Value

The zero-based index of the first column.

### MinRowIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/minrowindex.md

#### WorksheetRange.MinRowIndex property

Gets an index of the first row.

```csharp
public int MinRowIndex { get; }
```

##### Property Value

The zero-based index of the first row.

### WorksheetRange
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.data/worksheetrange/worksheetrange.md

#### WorksheetRange constructor

Initializes a new instance of the `WorksheetRange` class.

```csharp
public WorksheetRange(int minRowIndex, int maxRowIndex, int minColumnIndex, int maxColumnIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| minRowIndex | Int32 | The zero-based index of the first row. |
| maxRowIndex | Int32 | The zero-based index of the last row. |
| minColumnIndex | Int32 | The zero-based index of the first column. |
| maxColumnIndex | Int32 | The zero-based index of the last column. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException |  |

### GroupDocs.Parser.Exceptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions.md

The namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| CorruptedDocumentException | Thrown during document load, when the document is corrupted. |
| GroupDocsParserException | Represents the errors that occur during application execution. |
| InvalidPasswordException | Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing. |
| UnsupportedDocumentFormatException | Thrown during document load, when the document format is not recognized or not supported. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### CorruptedDocumentException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/corrupteddocumentexception.md

#### CorruptedDocumentException class

Thrown during document load, when the document is corrupted.

```csharp
public sealed class CorruptedDocumentException : GroupDocsParserException
```

#### Constructors

| Name | Description |
| --- | --- |
| CorruptedDocumentException() | Initializes a new instance of the `CorruptedDocumentException` class. |
| CorruptedDocumentException(string) | Initializes a new instance of the `CorruptedDocumentException` class with the message. |

### CorruptedDocumentException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/corrupteddocumentexception/corrupteddocumentexception.md

#### CorruptedDocumentException()

Initializes a new instance of the `CorruptedDocumentException` class.

```csharp
public CorruptedDocumentException()
```

#### CorruptedDocumentException(string)

Initializes a new instance of the `CorruptedDocumentException` class with the message.

```csharp
public CorruptedDocumentException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### GroupDocsParserException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/groupdocsparserexception.md

#### GroupDocsParserException class

Represents the errors that occur during application execution.

```csharp
public class GroupDocsParserException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsParserException() | Initializes a new instance of the `GroupDocsParserException` class. |
| GroupDocsParserException(string) | Initializes a new instance of the `GroupDocsParserException` class. |

### GroupDocsParserException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/groupdocsparserexception/groupdocsparserexception.md

#### GroupDocsParserException()

Initializes a new instance of the `GroupDocsParserException` class.

```csharp
public GroupDocsParserException()
```

#### GroupDocsParserException(string)

Initializes a new instance of the `GroupDocsParserException` class.

```csharp
public GroupDocsParserException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### InvalidPasswordException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.

```csharp
public sealed class InvalidPasswordException : GroupDocsParserException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidPasswordException() | Initializes a new instance of the `InvalidPasswordException` class. |
| InvalidPasswordException(string) | Initializes a new instance of the `InvalidPasswordException` class. |

### InvalidPasswordException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/invalidpasswordexception/invalidpasswordexception.md

#### InvalidPasswordException()

Initializes a new instance of the `InvalidPasswordException` class.

```csharp
public InvalidPasswordException()
```

#### InvalidPasswordException(string)

Initializes a new instance of the `InvalidPasswordException` class.

```csharp
public InvalidPasswordException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### UnsupportedDocumentFormatException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/unsupporteddocumentformatexception.md

#### UnsupportedDocumentFormatException class

Thrown during document load, when the document format is not recognized or not supported.

```csharp
public sealed class UnsupportedDocumentFormatException : GroupDocsParserException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnsupportedDocumentFormatException() | Initializes a new instance of the `UnsupportedDocumentFormatException` class. |
| UnsupportedDocumentFormatException(string) | Initializes a new instance of the `UnsupportedDocumentFormatException` class. |

### UnsupportedDocumentFormatException
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.exceptions/unsupporteddocumentformatexception/unsupporteddocumentformatexception.md

#### UnsupportedDocumentFormatException()

Initializes a new instance of the `UnsupportedDocumentFormatException` class.

```csharp
public UnsupportedDocumentFormatException()
```

#### UnsupportedDocumentFormatException(string)

Initializes a new instance of the `UnsupportedDocumentFormatException` class.

```csharp
public UnsupportedDocumentFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### GroupDocs.Parser.Export
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export.md

The namespace provides classes that allow users to export data to different formats.

#### Classes

| Class | Description |
| --- | --- |
| ExporterBase | Provides the base class for the data export functionality. |
| Extensions | Provides extensions methods for the data export functionality. |
| JsonExporter | Provides the functionality to export data in JSON format. |
| XmlExporter | Provides the functionality to export data in XML format. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### ExporterBase
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/exporterbase.md

#### ExporterBase class

Provides the base class for the data export functionality.

```csharp
public abstract class ExporterBase
```

#### Methods

| Name | Description |
| --- | --- |
| abstract Export(DocumentData, Stream) | Exports document data to the stream. |
| Export(DocumentData, string) | Exports document data to the file. |
| abstract Export(IDocumentInfo, Stream) | Exports the document information to the stream. |
| Export(IDocumentInfo, string) | Exports the document information to the file. |
| abstract Export(IEnumerable&lt;MetadataItem&gt;, Stream) | Exports the collection of metadata to the stream. |
| Export(IEnumerable&lt;MetadataItem&gt;, string) | Exports the collection of metadata to the file. |
| abstract Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream) | Exports the collection of barcodes to the stream. |
| Export(IEnumerable&lt;PageBarcodeArea&gt;, string) | Exports the collection of barcodes to the file. |
| abstract Export(IEnumerable&lt;PageTableArea&gt;, Stream) | Exports the collection of tables to the stream. |
| Export(IEnumerable&lt;PageTableArea&gt;, string) | Exports the collection of tables to the file. |
| abstract Export(IEnumerable&lt;PageTextArea&gt;, Stream) | Exports the collection of text areas to the stream. |
| Export(IEnumerable&lt;PageTextArea&gt;, string) | Exports the collection of text areas to the file. |

### Export
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/exporterbase/export.md

#### Export(IEnumerable&lt;MetadataItem&gt;, Stream)

Exports the collection of metadata to the stream.

```csharp
public abstract void Export(IEnumerable<MetadataItem> metadata, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;MetadataItem&gt;, string)

Exports the collection of metadata to the file.

```csharp
public void Export(IEnumerable<MetadataItem> metadata, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| fileName | String | The full path to the output file. |

#### Export(IDocumentInfo, Stream)

Exports the document information to the stream.

```csharp
public abstract void Export(IDocumentInfo documentInfo, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| stream | Stream | The output stream. |

#### Export(IDocumentInfo, string)

Exports the document information to the file.

```csharp
public void Export(IDocumentInfo documentInfo, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| fileName | String | The full path to the output file. |

#### Export(IEnumerable&lt;PageTextArea&gt;, Stream)

Exports the collection of text areas to the stream.

```csharp
public abstract void Export(IEnumerable<PageTextArea> textAreas, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of the text areas. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTextArea&gt;, string)

Exports the collection of text areas to the file.

```csharp
public void Export(IEnumerable<PageTextArea> textAreas, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of text areas. |
| fileName | String | The full path to the output file. |

#### Export(IEnumerable&lt;PageTableArea&gt;, Stream)

Exports the collection of tables to the stream.

```csharp
public abstract void Export(IEnumerable<PageTableArea> tables, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collecton of tables. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTableArea&gt;, string)

Exports the collection of tables to the file.

```csharp
public void Export(IEnumerable<PageTableArea> tables, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collection of tables. |
| fileName | String | The full path to the output file. |

#### Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream)

Exports the collection of barcodes to the stream.

```csharp
public abstract void Export(IEnumerable<PageBarcodeArea> barcodes, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageBarcodeArea&gt;, string)

Exports the collection of barcodes to the file.

```csharp
public void Export(IEnumerable<PageBarcodeArea> barcodes, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| fileName | String | The full path to the output file. |

#### Export(DocumentData, Stream)

Exports document data to the stream.

```csharp
public abstract void Export(DocumentData documentData, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| stream | Stream | The output stream. |

#### Export(DocumentData, string)

Exports document data to the file.

```csharp
public void Export(DocumentData documentData, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| fileName | String | The full path to the output file. |

### Extensions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/extensions.md

#### Extensions class

Provides extensions methods for the data export functionality.

```csharp
public static class Extensions
```

#### Methods

| Name | Description |
| --- | --- |
| static ExportAsJson(this DocumentData, Stream) | Exports document data to the stream in JSON format. |
| static ExportAsJson(this DocumentData, string) | Exports document data to the file in JSON format. |
| static ExportAsJson(this IDocumentInfo, Stream) | Exports the document information to the stream in JSON format. |
| static ExportAsJson(this IDocumentInfo, string) | Exports the document information to the file in JSON format. |
| static ExportAsJson(this IEnumerable&lt;MetadataItem&gt;, Stream) | Exports the collection of metadata to the stream in JSON format. |
| static ExportAsJson(this IEnumerable&lt;MetadataItem&gt;, string) | Exports the collection of metadata to the file in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageBarcodeArea&gt;, Stream) | Exports the collection of barcodes to the stream in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageBarcodeArea&gt;, string) | Exports the collection of barcodes to the file in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageTableArea&gt;, Stream) | Exports the collection of tables to the stream in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageTableArea&gt;, string) | Exports the collection of tables to the file in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageTextArea&gt;, Stream) | Exports the collection of text areas to the stream in JSON format. |
| static ExportAsJson(this IEnumerable&lt;PageTextArea&gt;, string) | Exports the collectiob of text areas to the file in JSON format. |
| static ExportAsXml(this DocumentData, Stream) | Exports document data to the stream in XML format. |
| static ExportAsXml(this DocumentData, string) | Exports document data to the file in XML format. |
| static ExportAsXml(this IDocumentInfo, Stream) | Exports the document information to the stream in XML format. |
| static ExportAsXml(this IDocumentInfo, string) | Exports the document information to the file in XML format. |
| static ExportAsXml(this IEnumerable&lt;MetadataItem&gt;, Stream) | Exports the collection of metadata to the stream in XML format. |
| static ExportAsXml(this IEnumerable&lt;MetadataItem&gt;, string) | Exports the collection of metadata to the file in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageBarcodeArea&gt;, Stream) | Exports the collection of barcodes to the stream in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageBarcodeArea&gt;, string) | Exports the collection of barcodes to the file in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageTableArea&gt;, Stream) | Exports the collection of tables to the stream in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageTableArea&gt;, string) | Exports the collection of tables to the file in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageTextArea&gt;, Stream) | Exports the collection of text areas to the stream in XML format. |
| static ExportAsXml(this IEnumerable&lt;PageTextArea&gt;, string) | Exports the collectiob of text areas to the file in XML format. |

### ExportAsJson
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/extensions/exportasjson.md

#### ExportAsJson(this IEnumerable&lt;MetadataItem&gt;, Stream)

Exports the collection of metadata to the stream in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<MetadataItem> metadata, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| stream | Stream | The output stream. |

#### ExportAsJson(this IEnumerable&lt;MetadataItem&gt;, string)

Exports the collection of metadata to the file in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<MetadataItem> metadata, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| fileName | String | The full path to the output file. |

#### ExportAsJson(this IDocumentInfo, Stream)

Exports the document information to the stream in JSON format.

```csharp
public static void ExportAsJson(this IDocumentInfo documentInfo, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| stream | Stream | The output stream. |

#### ExportAsJson(this IDocumentInfo, string)

Exports the document information to the file in JSON format.

```csharp
public static void ExportAsJson(this IDocumentInfo documentInfo, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| fileName | String | The full path to the output file. |

#### ExportAsJson(this IEnumerable&lt;PageTextArea&gt;, Stream)

Exports the collection of text areas to the stream in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageTextArea> textAreas, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of the text areas. |
| stream | Stream | The output stream. |

#### ExportAsJson(this IEnumerable&lt;PageTextArea&gt;, string)

Exports the collectiob of text areas to the file in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageTextArea> textAreas, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of text areas. |
| fileName | String | The full path to the output file. |

#### ExportAsJson(this IEnumerable&lt;PageTableArea&gt;, Stream)

Exports the collection of tables to the stream in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageTableArea> tables, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collecton of tables. |
| stream | Stream | The output stream. |

#### ExportAsJson(this IEnumerable&lt;PageTableArea&gt;, string)

Exports the collection of tables to the file in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageTableArea> tables, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collection of tables. |
| fileName | String | The full path to the output file. |

#### ExportAsJson(this IEnumerable&lt;PageBarcodeArea&gt;, Stream)

Exports the collection of barcodes to the stream in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageBarcodeArea> barcodes, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| stream | Stream | The output stream. |

#### ExportAsJson(this IEnumerable&lt;PageBarcodeArea&gt;, string)

Exports the collection of barcodes to the file in JSON format.

```csharp
public static void ExportAsJson(this IEnumerable<PageBarcodeArea> barcodes, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| fileName | String | The full path to the output file. |

#### ExportAsJson(this DocumentData, Stream)

Exports document data to the stream in JSON format.

```csharp
public static void ExportAsJson(this DocumentData documentData, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| stream | Stream | The output stream. |

#### ExportAsJson(this DocumentData, string)

Exports document data to the file in JSON format.

```csharp
public static void ExportAsJson(this DocumentData documentData, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| fileName | String | The full path to the output file. |

### ExportAsXml
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/extensions/exportasxml.md

#### ExportAsXml(this IEnumerable&lt;MetadataItem&gt;, Stream)

Exports the collection of metadata to the stream in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<MetadataItem> metadata, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| stream | Stream | The output stream. |

#### ExportAsXml(this IEnumerable&lt;MetadataItem&gt;, string)

Exports the collection of metadata to the file in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<MetadataItem> metadata, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| fileName | String | The full path to the output file. |

#### ExportAsXml(this IDocumentInfo, Stream)

Exports the document information to the stream in XML format.

```csharp
public static void ExportAsXml(this IDocumentInfo documentInfo, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| stream | Stream | The output stream. |

#### ExportAsXml(this IDocumentInfo, string)

Exports the document information to the file in XML format.

```csharp
public static void ExportAsXml(this IDocumentInfo documentInfo, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| fileName | String | The full path to the output file. |

#### ExportAsXml(this IEnumerable&lt;PageTextArea&gt;, Stream)

Exports the collection of text areas to the stream in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageTextArea> textAreas, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of the text areas. |
| stream | Stream | The output stream. |

#### ExportAsXml(this IEnumerable&lt;PageTextArea&gt;, string)

Exports the collectiob of text areas to the file in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageTextArea> textAreas, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of text areas. |
| fileName | String | The full path to the output file. |

#### ExportAsXml(this IEnumerable&lt;PageTableArea&gt;, Stream)

Exports the collection of tables to the stream in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageTableArea> tables, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collecton of tables. |
| stream | Stream | The output stream. |

#### ExportAsXml(this IEnumerable&lt;PageTableArea&gt;, string)

Exports the collection of tables to the file in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageTableArea> tables, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collection of tables. |
| fileName | String | The full path to the output file. |

#### ExportAsXml(this IEnumerable&lt;PageBarcodeArea&gt;, Stream)

Exports the collection of barcodes to the stream in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageBarcodeArea> barcodes, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| stream | Stream | The output stream. |

#### ExportAsXml(this IEnumerable&lt;PageBarcodeArea&gt;, string)

Exports the collection of barcodes to the file in XML format.

```csharp
public static void ExportAsXml(this IEnumerable<PageBarcodeArea> barcodes, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| fileName | String | The full path to the output file. |

#### ExportAsXml(this DocumentData, Stream)

Exports document data to the stream in XML format.

```csharp
public static void ExportAsXml(this DocumentData documentData, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| stream | Stream | The output stream. |

#### ExportAsXml(this DocumentData, string)

Exports document data to the file in XML format.

```csharp
public static void ExportAsXml(this DocumentData documentData, string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| fileName | String | The full path to the output file. |

### JsonExporter
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/jsonexporter.md

#### JsonExporter class

Provides the functionality to export data in JSON format.

```csharp
public sealed class JsonExporter : ExporterBase
```

#### Constructors

| Name | Description |
| --- | --- |
| JsonExporter() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| override Export(DocumentData, Stream) | Exports document data to the stream. |
| Export(DocumentData, string) | Exports document data to the file. |
| override Export(IDocumentInfo, Stream) | Exports the document information to the stream. |
| Export(IDocumentInfo, string) | Exports the document information to the file. |
| override Export(IEnumerable&lt;MetadataItem&gt;, Stream) | Exports the collection of metadata to the stream. |
| Export(IEnumerable&lt;MetadataItem&gt;, string) | Exports the collection of metadata to the file. |
| override Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream) | Exports the collection of barcodes to the stream. |
| Export(IEnumerable&lt;PageBarcodeArea&gt;, string) | Exports the collection of barcodes to the file. |
| override Export(IEnumerable&lt;PageTableArea&gt;, Stream) | Exports the collection of tables to the stream. |
| Export(IEnumerable&lt;PageTableArea&gt;, string) | Exports the collection of tables to the file. |
| override Export(IEnumerable&lt;PageTextArea&gt;, Stream) | Exports the collection of text areas to the stream. |
| Export(IEnumerable&lt;PageTextArea&gt;, string) | Exports the collection of text areas to the file. |

### Export
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/jsonexporter/export.md

#### Export(IEnumerable&lt;MetadataItem&gt;, Stream)

Exports the collection of metadata to the stream.

```csharp
public override void Export(IEnumerable<MetadataItem> metadata, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| stream | Stream | The output stream. |

#### Export(IDocumentInfo, Stream)

Exports the document information to the stream.

```csharp
public override void Export(IDocumentInfo documentInfo, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTextArea&gt;, Stream)

Exports the collection of text areas to the stream.

```csharp
public override void Export(IEnumerable<PageTextArea> textAreas, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of the text areas. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTableArea&gt;, Stream)

Exports the collection of tables to the stream.

```csharp
public override void Export(IEnumerable<PageTableArea> tables, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collecton of tables. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream)

Exports the collection of barcodes to the stream.

```csharp
public override void Export(IEnumerable<PageBarcodeArea> barcodes, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| stream | Stream | The output stream. |

#### Export(DocumentData, Stream)

Exports document data to the stream.

```csharp
public override void Export(DocumentData documentData, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| stream | Stream | The output stream. |

### JsonExporter
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/jsonexporter/jsonexporter.md

#### JsonExporter constructor

The default constructor.

```csharp
public JsonExporter()
```

### XmlExporter
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/xmlexporter.md

#### XmlExporter class

Provides the functionality to export data in XML format.

```csharp
public sealed class XmlExporter : ExporterBase
```

#### Constructors

| Name | Description |
| --- | --- |
| XmlExporter() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| override Export(DocumentData, Stream) | Exports document data to the stream. |
| Export(DocumentData, string) | Exports document data to the file. |
| override Export(IDocumentInfo, Stream) | Exports the document information to the stream. |
| Export(IDocumentInfo, string) | Exports the document information to the file. |
| override Export(IEnumerable&lt;MetadataItem&gt;, Stream) | Exports the collection of metadata to the stream. |
| Export(IEnumerable&lt;MetadataItem&gt;, string) | Exports the collection of metadata to the file. |
| override Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream) | Exports the collection of barcodes to the stream. |
| Export(IEnumerable&lt;PageBarcodeArea&gt;, string) | Exports the collection of barcodes to the file. |
| override Export(IEnumerable&lt;PageTableArea&gt;, Stream) | Exports the collection of tables to the stream. |
| Export(IEnumerable&lt;PageTableArea&gt;, string) | Exports the collection of tables to the file. |
| override Export(IEnumerable&lt;PageTextArea&gt;, Stream) | Exports the collection of text areas to the stream. |
| Export(IEnumerable&lt;PageTextArea&gt;, string) | Exports the collection of text areas to the file. |

### Export
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/xmlexporter/export.md

#### Export(IEnumerable&lt;MetadataItem&gt;, Stream)

Exports the collection of metadata to the stream.

```csharp
public override void Export(IEnumerable<MetadataItem> metadata, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadata | IEnumerable`1 | The collection of metadata. |
| stream | Stream | The output stream. |

#### Export(IDocumentInfo, Stream)

Exports the document information to the stream.

```csharp
public override void Export(IDocumentInfo documentInfo, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | IDocumentInfo | The document information. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTextArea&gt;, Stream)

Exports the collection of text areas to the stream.

```csharp
public override void Export(IEnumerable<PageTextArea> textAreas, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| textAreas | IEnumerable`1 | The collection of the text areas. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageTableArea&gt;, Stream)

Exports the collection of tables to the stream.

```csharp
public override void Export(IEnumerable<PageTableArea> tables, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tables | IEnumerable`1 | The collecton of tables. |
| stream | Stream | The output stream. |

#### Export(IEnumerable&lt;PageBarcodeArea&gt;, Stream)

Exports the collection of barcodes to the stream.

```csharp
public override void Export(IEnumerable<PageBarcodeArea> barcodes, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| barcodes | IEnumerable`1 | The collection of barcodes. |
| stream | Stream | The output stream. |

#### Export(DocumentData, Stream)

Exports document data to the stream.

```csharp
public override void Export(DocumentData documentData, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentData | DocumentData | Document data. |
| stream | Stream | The output stream. |

### XmlExporter
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.export/xmlexporter/xmlexporter.md

#### XmlExporter constructor

The default constructor.

```csharp
public XmlExporter()
```

### GroupDocs.Parser.Options
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options.md

The namespace provides classes to specify additional options when parsing data from documents.

#### Classes

| Class | Description |
| --- | --- |
| AdjustmentFieldsOptions | Provides the options which are used to generate the adjustment fields. |
| BarcodeOptions | Provides the options which are used for barcode extraction. |
| CreatePageStream | Represents a method that returns a stream to write page preview data. |
| DocumentInfo | Represents the document information. |
| EmailConnection | Represents the email connection information. |
| EmailEwsConnection | Represents the email connection information for EWS protocol. |
| EmailImapConnection | Represents the email connection information for IMAP protocol. |
| EmailPopConnection | Represents the email connection information for POP protocol. |
| ExternalResourceHandler | Provides a handler for external resources loading. |
| ExternalResourceLoadingArgs | Provides the data for `OnLoading` method. |
| Features | Represents the supported features list. Allows to obtain information which features are supported or not for the document. |
| FileInfo | Represents the file information. |
| FileType | Represents the file type. Provides methods to obtain list of all file types supported by **GroupDocs.Parser**. |
| FormattedTextOptions | Provides the options which are used for formatted text extraction. |
| HighlightOptions | Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios). |
| ImageOptions | Provides the options which are used for image extraction. |
| LoadOptions | Provides the options which are used to open a file. |
| OcrConnectorBase | Provides the OCR functionality. |
| OcrEventHandler | Provides a handler for OCR events. |
| OcrOptions | Provides the options which are used for OCR Connector. |
| PageAreaOptions | Provides the options which are used for page areas extraction. |
| PageInfo | Represents the document page information. |
| PagePreviewOptions | Provides the options which are used to generate the document page preview. |
| PageRenderInfo | Represents the information of how a page is rendered. |
| PageTableAreaOptions | Provides the options which are used for page table areas extraction. |
| PageTextAreaOptions | Provides the options which are used for page text areas extraction. |
| ParseByTemplateOptions | Provides the options which are used to parse by template. |
| ParserSettings | Provides the settings which are used to customize data extraction. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| PreviewPageRender | Represents a method which is called before a document page is rendered. |
| ReleasePageStream | Represents a method which releases the stream created by the `CreatePageStream` delegate. |
| SearchOptions | Provides the options which are used for text search. |
| TextDocumentInfo | Represents the text document information. |
| TextOptions | Provides the options which are used for text extraction. |
| WorksheetOptions | Provides the options which are used for the worksheet extraction. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Represents the document information. |
| ILogger | Defines the interface of a logger that is used for logging events and errors during data extraction. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FileFormat | Defines a type of the file. |
| FileTypeDetectionMode | Defines a mode of the file type detection. |
| FormattedTextMode | Defines a formatted text mode. |
| ImageFormat | Defines a format of the image. |
| PagePreviewFormat | Represents supported preview formats. |
| PreviewOptions.PreviewFormats | Represents supported preview formats. |
| QualityMode | Defines a level of the quality. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### AdjustmentFieldsOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions.md

#### AdjustmentFieldsOptions class

Provides the options which are used to generate the adjustment fields.

```csharp
public sealed class AdjustmentFieldsOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| AdjustmentFieldsOptions() | Initializes a new instance of the `AdjustmentFieldsOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FieldNamePrefix { get; set; } | Gets or sets the generated field name prefix. The default value is `"Generated"`. |
| OcrOptions { get; set; } | Gets or sets the additional options for OCR functionality. The default value is `null`. |
| PageIndex { get; set; } | Gets or sets index of the page for which the adjustment fields are to be generated. The default value is `0`. |
| RequestedPageWidth { get; set; } | Gets or sets the requested page width value. This value is used to scale the template fields to the desired page size. The default value is `null` which means no scaling is made. |

### AdjustmentFieldsOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions/adjustmentfieldsoptions.md

#### AdjustmentFieldsOptions constructor

Initializes a new instance of the `AdjustmentFieldsOptions` class.

```csharp
public AdjustmentFieldsOptions()
```

### FieldNamePrefix
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions/fieldnameprefix.md

#### AdjustmentFieldsOptions.FieldNamePrefix property

Gets or sets the generated field name prefix. The default value is `"Generated"`.

```csharp
public string FieldNamePrefix { get; set; }
```

##### Property Value

The generated field name prefix.

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions/ocroptions.md

#### AdjustmentFieldsOptions.OcrOptions property

Gets or sets the additional options for OCR functionality. The default value is `null`.

```csharp
public OcrOptions OcrOptions { get; set; }
```

##### Property Value

An instance of `OcrOptions` class with the additional OCR options.

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions/pageindex.md

#### AdjustmentFieldsOptions.PageIndex property

Gets or sets index of the page for which the adjustment fields are to be generated. The default value is `0`.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index.

### RequestedPageWidth
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/adjustmentfieldsoptions/requestedpagewidth.md

#### AdjustmentFieldsOptions.RequestedPageWidth property

Gets or sets the requested page width value. This value is used to scale the template fields to the desired page size. The default value is `null` which means no scaling is made.

```csharp
public double? RequestedPageWidth { get; set; }
```

##### Property Value

The requested page width value.

### BarcodeOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions.md

#### BarcodeOptions class

Provides the options which are used for barcode extraction.

```csharp
public sealed class BarcodeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BarcodeOptions() | Initializes a new instance of the `BarcodeOptions` class with default values. |
| BarcodeOptions(Rectangle) | Initializes a new instance of the `BarcodeOptions` class with the rectangular area. |
| BarcodeOptions(QualityMode, QualityMode, params string[]) | Initializes a new instance of the `BarcodeOptions` class with quality settings and code types. |
| BarcodeOptions(Rectangle, QualityMode, QualityMode, float?, bool, params string[]) | Initializes a new instance of the `BarcodeOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AllowIncorrectBarcodes { get; set; } | Gets the value that indicates whether the incorrect barcodes are allowed. |
| BarcodeQuality { get; set; } | Gets the quality of a source barcode. |
| CodeTypes { get; set; } | Gets the types of barcodes to read. |
| Dimension { get; set; } | Gets the minimal size of the barcode minimal element. |
| ImageQuality { get; set; } | Gets the quality of a source image. |
| PagePreviewOptions { get; set; } | Gets or sets the document page preview options. |
| Rectangle { get; set; } | Gets the rectangular area that contains page areas. |

### AllowIncorrectBarcodes
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/allowincorrectbarcodes.md

#### BarcodeOptions.AllowIncorrectBarcodes property

Gets the value that indicates whether the incorrect barcodes are allowed.

```csharp
public bool AllowIncorrectBarcodes { get; set; }
```

##### Property Value

`true` if the incorrect barcodes are allowed; otherwise, `false`.

### BarcodeOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/barcodeoptions.md

#### BarcodeOptions()

Initializes a new instance of the `BarcodeOptions` class with default values.

```csharp
public BarcodeOptions()
```

#### BarcodeOptions(Rectangle)

Initializes a new instance of the `BarcodeOptions` class with the rectangular area.

```csharp
public BarcodeOptions(Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains barcodes. |

#### BarcodeOptions(QualityMode, QualityMode, params string[])

Initializes a new instance of the `BarcodeOptions` class with quality settings and code types.

```csharp
public BarcodeOptions(QualityMode imageQuality, QualityMode barcodeQuality, 
    params string[] codeTypes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageQuality | QualityMode | The quality of a source image. |
| barcodeQuality | QualityMode | The quality of a source barcode. |
| codeTypes | String[] | The types of barcodes to read. |

#### BarcodeOptions(Rectangle, QualityMode, QualityMode, float?, bool, params string[])

Initializes a new instance of the `BarcodeOptions` class.

```csharp
public BarcodeOptions(Rectangle rectangle, QualityMode imageQuality, QualityMode barcodeQuality, 
    float? dimension, bool allowIncorrectBarcodes, params string[] codeTypes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains barcodes. |
| imageQuality | QualityMode | The quality of a source image. |
| barcodeQuality | QualityMode | The quality of a source barcode. |
| dimension | Nullable`1 | The minimal size of the barcode minimal element. |
| allowIncorrectBarcodes | Boolean | The value that indicates whether the incorrect barcodes are allowed. |
| codeTypes | String[] | The types of barcodes to read. |

### BarcodeQuality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/barcodequality.md

#### BarcodeOptions.BarcodeQuality property

Gets the quality of a source barcode.

```csharp
public QualityMode BarcodeQuality { get; set; }
```

##### Property Value

The mode which defines the level of the source barcode quality.

### CodeTypes
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/codetypes.md

#### BarcodeOptions.CodeTypes property

Gets the types of barcodes to read.

```csharp
public IReadOnlyList<string> CodeTypes { get; set; }
```

##### Property Value

The readonly collection that contains a types of barcodes to read; empty collection if isn't set.

### Dimension
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/dimension.md

#### BarcodeOptions.Dimension property

Gets the minimal size of the barcode minimal element.

```csharp
public float? Dimension { get; set; }
```

##### Property Value

The float value that represents the barcode minimal element; `null` if auto mode is used.

### ImageQuality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/imagequality.md

#### BarcodeOptions.ImageQuality property

Gets the quality of a source image.

```csharp
public QualityMode ImageQuality { get; set; }
```

##### Property Value

The mode which defines the level of the source image quality.

### PagePreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/pagepreviewoptions.md

#### BarcodeOptions.PagePreviewOptions property

Gets or sets the document page preview options.

```csharp
public PagePreviewOptions PagePreviewOptions { get; set; }
```

##### Property Value

An instance of `PagePreviewOptions` class that sets properties for the document page preview generation.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/barcodeoptions/rectangle.md

#### BarcodeOptions.Rectangle property

Gets the rectangular area that contains page areas.

```csharp
public Rectangle Rectangle { get; set; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains page areas; `null` if it isn't set.

### CreatePageStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/createpagestream.md

#### CreatePageStream delegate

Represents a method that returns a stream to write page preview data.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a page to generate a thumbnail. |

##### Return Value

The stream to write the page preview.

### DocumentInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo.md

#### DocumentInfo class

Represents the document information.

```csharp
public class DocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the document type. |
| PageCount { get; } | Gets the total number of document pages. |
| Pages { get; } | Gets the information about pages such as the index and page size. |
| RawPageCount { get; } | Gets the total number of document raw pages. |
| Size { get; } | Gets the size of the document in bytes. |

##### Remarks

**Learn more:**

* [Get document info](https://docs.groupdocs.com/display/parsernet/Get+document+info)
* [Detect encoding](https://docs.groupdocs.com/display/parsernet/Detect+encoding)

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo/filetype.md

#### DocumentInfo.FileType property

Gets the document type.

```csharp
public FileType FileType { get; }
```

##### Property Value

An instance of `FileType` class that represents the type of the document.

### PageCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

Gets the total number of document pages.

```csharp
public int PageCount { get; }
```

##### Property Value

An integer value that represents a total number of pages.

### Pages
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo/pages.md

#### DocumentInfo.Pages property

Gets the information about pages such as the index and page size.

```csharp
public IList<PageInfo> Pages { get; }
```

##### Property Value

A collection with instances of `PageInfo` classes.

### RawPageCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo/rawpagecount.md

#### DocumentInfo.RawPageCount property

Gets the total number of document raw pages.

```csharp
public int RawPageCount { get; }
```

##### Property Value

An integer value that represents a total number of raw pages.

##### Remarks

Use `RawPageCount` property instead of `PageCount` property for raw text extraction. Some documents have different page numbers in accurate and raw text extraction modes. `PageCount` property may perform extra calculations which impacts on text extraction speed in raw mode.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/documentinfo/size.md

#### DocumentInfo.Size property

Gets the size of the document in bytes.

```csharp
public long Size { get; }
```

##### Property Value

An integer value that represents the size of the document in bytes.

### EmailConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailconnection.md

#### EmailConnection class

Represents the email connection information.

```csharp
public abstract class EmailConnection
```

#### Properties

| Name | Description |
| --- | --- |
| Password { get; } | Gets the password. |
| UserName { get; } | Gets the user name. |

### Password
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailconnection/password.md

#### EmailConnection.Password property

Gets the password.

```csharp
public string Password { get; }
```

##### Property Value

A string value that represents the password.

### UserName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailconnection/username.md

#### EmailConnection.UserName property

Gets the user name.

```csharp
public string UserName { get; }
```

##### Property Value

A string value that represents the user name.

### EmailEwsConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailewsconnection.md

#### EmailEwsConnection class

Represents the email connection information for EWS protocol.

```csharp
public sealed class EmailEwsConnection : EmailConnection
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailEwsConnection(string, string, string) | Initializes a new instance of the `EmailEwsConnection` class. |
| EmailEwsConnection(string, string, string, string) | Initializes a new instance of the `EmailEwsConnection` class. |

#### Properties

| Name | Description |
| --- | --- |
| Domain { get; } | Gets the domain name. |
| MailboxUri { get; } | Gets the URI of the mailbox. |
| Password { get; } | Gets the password. |
| UserName { get; } | Gets the user name. |

### Domain
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailewsconnection/domain.md

#### EmailEwsConnection.Domain property

Gets the domain name.

```csharp
public string Domain { get; }
```

##### Property Value

A string value that represents the domain name.

### EmailEwsConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailewsconnection/emailewsconnection.md

#### EmailEwsConnection(string, string, string)

Initializes a new instance of the `EmailEwsConnection` class.

```csharp
public EmailEwsConnection(string mailboxUri, string userName, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mailboxUri | String | The URI of mailbox. |
| userName | String | The user name. |
| password | String | The password. |

#### EmailEwsConnection(string, string, string, string)

Initializes a new instance of the `EmailEwsConnection` class.

```csharp
public EmailEwsConnection(string mailboxUri, string domain, string userName, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mailboxUri | String | The URI of the mailbox. |
| domain | String | The domain name. |
| userName | String | The user name. |
| password | String | The password. |

### MailboxUri
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailewsconnection/mailboxuri.md

#### EmailEwsConnection.MailboxUri property

Gets the URI of the mailbox.

```csharp
public string MailboxUri { get; }
```

##### Property Value

A string value that represents a URI of the mailbox.

### EmailImapConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailimapconnection.md

#### EmailImapConnection class

Represents the email connection information for IMAP protocol.

```csharp
public sealed class EmailImapConnection : EmailConnection
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailImapConnection(string, int, string, string) | Initializes a new instance of the `EmailImapConnection` class. |

#### Properties

| Name | Description |
| --- | --- |
| Host { get; } | Gets the host name. |
| Password { get; } | Gets the password. |
| Port { get; } | Gets the port number. |
| UserName { get; } | Gets the user name. |

### EmailImapConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailimapconnection/emailimapconnection.md

#### EmailImapConnection constructor

Initializes a new instance of the `EmailImapConnection` class.

```csharp
public EmailImapConnection(string host, int port, string userName, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| host | String | The host name. |
| port | Int32 | The port number. |
| userName | String | The user name. |
| password | String | The password. |

### Host
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailimapconnection/host.md

#### EmailImapConnection.Host property

Gets the host name.

```csharp
public string Host { get; }
```

##### Property Value

A string value that represents the host name.

### Port
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailimapconnection/port.md

#### EmailImapConnection.Port property

Gets the port number.

```csharp
public int Port { get; }
```

##### Property Value

An integer value that represents the port number.

### EmailPopConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailpopconnection.md

#### EmailPopConnection class

Represents the email connection information for POP protocol.

```csharp
public sealed class EmailPopConnection : EmailConnection
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailPopConnection(string, int, string, string) | Initializes a new instance of the `EmailPopConnection` class. |

#### Properties

| Name | Description |
| --- | --- |
| Host { get; } | Gets the host name. |
| Password { get; } | Gets the password. |
| Port { get; } | Gets the port number. |
| UserName { get; } | Gets the user name. |

### EmailPopConnection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailpopconnection/emailpopconnection.md

#### EmailPopConnection constructor

Initializes a new instance of the `EmailPopConnection` class.

```csharp
public EmailPopConnection(string host, int port, string userName, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| host | String | The host name. |
| port | Int32 | The port number. |
| userName | String | The user name. |
| password | String | The password. |

### Host
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailpopconnection/host.md

#### EmailPopConnection.Host property

Gets the host name.

```csharp
public string Host { get; }
```

##### Property Value

A string value that represents the host name.

### Port
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/emailpopconnection/port.md

#### EmailPopConnection.Port property

Gets the port number.

```csharp
public int Port { get; }
```

##### Property Value

An integer value that represents the port number.

### ExternalResourceHandler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourcehandler.md

#### ExternalResourceHandler class

Provides a handler for external resources loading.

```csharp
public class ExternalResourceHandler
```

#### Constructors

| Name | Description |
| --- | --- |
| ExternalResourceHandler() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| virtual OnLoading(ExternalResourceLoadingArgs) | Called before any external resource load. |

### ExternalResourceHandler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourcehandler/externalresourcehandler.md

#### ExternalResourceHandler constructor

The default constructor.

```csharp
public ExternalResourceHandler()
```

### OnLoading
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourcehandler/onloading.md

#### ExternalResourceHandler.OnLoading method

Called before any external resource load.

```csharp
public virtual void OnLoading(ExternalResourceLoadingArgs args)
```

| Parameter | Type | Description |
| --- | --- | --- |
| args | ExternalResourceLoadingArgs | The data to control external resource loading. |

### ExternalResourceLoadingArgs
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourceloadingargs.md

#### ExternalResourceLoadingArgs class

Provides the data for `OnLoading` method.

```csharp
public sealed class ExternalResourceLoadingArgs
```

#### Constructors

| Name | Description |
| --- | --- |
| ExternalResourceLoadingArgs(string) | Initializes a new instance of the `ExternalResourceLoadingArgs` class. |

#### Properties

| Name | Description |
| --- | --- |
| Data { get; set; } | Gets or sets the user data. |
| Skipped { get; set; } | Gets or sets the value that indicates whether the loading of the external resource must be skipped. |
| Uri { get; set; } | Gets or sets the URI of the external resource. |

### Data
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourceloadingargs/data.md

#### ExternalResourceLoadingArgs.Data property

Gets or sets the user data.

```csharp
public byte[] Data { get; set; }
```

##### Property Value

The byte array with the user content of the external resource. If set, loading is skipped and these data are used.

### ExternalResourceLoadingArgs
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourceloadingargs/externalresourceloadingargs.md

#### ExternalResourceLoadingArgs constructor

Initializes a new instance of the `ExternalResourceLoadingArgs` class.

```csharp
public ExternalResourceLoadingArgs(string uri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | String | URI of the external resource. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Throws if *uri* is `null` or an empty string. |

### Skipped
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourceloadingargs/skipped.md

#### ExternalResourceLoadingArgs.Skipped property

Gets or sets the value that indicates whether the loading of the external resource must be skipped.

```csharp
public bool Skipped { get; set; }
```

##### Property Value

`true` if the loading of the external resource must be skipped; otherwise, `false`.

### Uri
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/externalresourceloadingargs/uri.md

#### ExternalResourceLoadingArgs.Uri property

Gets or sets the URI of the external resource.

```csharp
public string Uri { get; set; }
```

##### Property Value

A string value that represents URI of the external resource. Can be changed by a user. In this case the external resource is loaded from a new URI.

### Features
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features.md

#### Features class

Represents the supported features list. Allows to obtain information which features are supported or not for the document.

```csharp
public sealed class Features
```

#### Properties

| Name | Description |
| --- | --- |
| Barcodes { get; } | Gets the value that indicates whether barcodes extraction is supported. |
| Container { get; } | Gets the value that indicates whether container extraction is supported. |
| FormattedText { get; } | Gets the value that indicates whether formatted text extraction is supported. |
| FormattedTextPage { get; } | Gets the value that indicates whether formatted text page extraction is supported. |
| Highlight { get; } | Gets the value that indicates whether highlight extraction is supported. |
| Hyperlinks { get; } | Gets the value that indicates whether hyperlinks extraction is supported. |
| Images { get; } | Gets the value that indicates whether images extraction is supported. |
| Metadata { get; } | Gets the value that indicates whether metadata extraction is supported. |
| Ocr { get; } | Gets the value that indicates whether OCR functionality is supported. |
| PagePreview { get; } | Gets the value that indicates whether the page preview generation is supported. |
| ParseByTemplate { get; } | Gets the value that indicates whether parsing by template is supported. |
| ParseForm { get; } | Gets the value that indicates whether form parsing is supported. |
| Preview { get; } | Gets the value that indicates whether preview generation is supported. |
| Search { get; } | Gets the value that indicates whether text search is supported. |
| Structure { get; } | Gets the value that indicates whether text structure extraction is supported. |
| Tables { get; } | Gets the value that indicates whether tables extraction is supported. |
| Text { get; } | Gets the value that indicates whether text extraction is supported. |
| TextAreas { get; } | Gets the value that indicates whether text areas extraction is supported. |
| TextPage { get; } | Gets the value that indicates whether text page extraction is supported. |
| Toc { get; } | Gets the value that indicates whether table of contents extraction is supported. |
| Worksheet { get; } | Gets the value that indicates whether the worksheet extraction is supported. |

#### Methods

| Name | Description |
| --- | --- |
| IsFeatureSupported(string) | Returns the value that indicates whether the feature is supported. |

##### Remarks

An instance of this class is used as `Features` property. See the usage examples there.

**Learn more:**

* [Get supported features](https://docs.groupdocs.com/display/parsernet/Get+supported+features)

### Barcodes
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/barcodes.md

#### Features.Barcodes property

Gets the value that indicates whether barcodes extraction is supported.

```csharp
public bool Barcodes { get; }
```

##### Return Value

`true` if barcodes extraction is supported; otherwise, `false`.

### Container
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/container.md

#### Features.Container property

Gets the value that indicates whether container extraction is supported.

```csharp
public bool Container { get; }
```

##### Return Value

`true` if container extraction is supported; otherwise, `false`.

### FormattedText
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/formattedtext.md

#### Features.FormattedText property

Gets the value that indicates whether formatted text extraction is supported.

```csharp
public bool FormattedText { get; }
```

##### Return Value

`true` if formatted text extraction is supported; otherwise, `false`.

### FormattedTextPage
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/formattedtextpage.md

#### Features.FormattedTextPage property

Gets the value that indicates whether formatted text page extraction is supported.

```csharp
public bool FormattedTextPage { get; }
```

##### Return Value

`true` if formatted text page extraction is supported; otherwise, `false`.

### Highlight
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/highlight.md

#### Features.Highlight property

Gets the value that indicates whether highlight extraction is supported.

```csharp
public bool Highlight { get; }
```

##### Return Value

`true` if highlight extraction is supported; otherwise, `false`.

### Hyperlinks
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/hyperlinks.md

#### Features.Hyperlinks property

Gets the value that indicates whether hyperlinks extraction is supported.

```csharp
public bool Hyperlinks { get; }
```

##### Return Value

`true` if hyperlinks extraction is supported; otherwise, `false`.

### Images
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/images.md

#### Features.Images property

Gets the value that indicates whether images extraction is supported.

```csharp
public bool Images { get; }
```

##### Return Value

`true` if images extraction is supported; otherwise, `false`.

### IsFeatureSupported
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/isfeaturesupported.md

#### Features.IsFeatureSupported method

Returns the value that indicates whether the feature is supported.

```csharp
public bool IsFeatureSupported(string featureName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| featureName | String | The feature name. |

##### Return Value

`true` if the feature is supported; otherwise, `false`.

### Metadata
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/metadata.md

#### Features.Metadata property

Gets the value that indicates whether metadata extraction is supported.

```csharp
public bool Metadata { get; }
```

##### Return Value

`true` if metadata extraction is supported; otherwise, `false`.

### Ocr
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/ocr.md

#### Features.Ocr property

Gets the value that indicates whether OCR functionality is supported.

```csharp
public bool Ocr { get; }
```

##### Return Value

`true` if OCR functionality is supported; otherwise, `false`.

### PagePreview
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/pagepreview.md

#### Features.PagePreview property

Gets the value that indicates whether the page preview generation is supported.

```csharp
public bool PagePreview { get; }
```

##### Return Value

`true` if the page preview generation is supported; otherwise, `false`.

### ParseByTemplate
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/parsebytemplate.md

#### Features.ParseByTemplate property

Gets the value that indicates whether parsing by template is supported.

```csharp
public bool ParseByTemplate { get; }
```

##### Return Value

`true` if parsing by template is supported; otherwise, `false`.

### ParseForm
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/parseform.md

#### Features.ParseForm property

Gets the value that indicates whether form parsing is supported.

```csharp
public bool ParseForm { get; }
```

##### Return Value

`true` if form parsing is supported; otherwise, `false`.

### Preview
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/preview.md

#### Features.Preview property

Gets the value that indicates whether preview generation is supported.

```csharp
public bool Preview { get; }
```

##### Return Value

`true` if preview generation is supported; otherwise, `false`.

### Search
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/search.md

#### Features.Search property

Gets the value that indicates whether text search is supported.

```csharp
public bool Search { get; }
```

##### Return Value

`true` if text search is supported; otherwise, `false`.

### Structure
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/structure.md

#### Features.Structure property

Gets the value that indicates whether text structure extraction is supported.

```csharp
public bool Structure { get; }
```

##### Return Value

`true` if text structure extraction is supported; otherwise, `false`.

### Tables
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/tables.md

#### Features.Tables property

Gets the value that indicates whether tables extraction is supported.

```csharp
public bool Tables { get; }
```

##### Return Value

`true` if tables extraction is supported; otherwise, `false`.

### Text
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/text.md

#### Features.Text property

Gets the value that indicates whether text extraction is supported.

```csharp
public bool Text { get; }
```

##### Return Value

`true` if text extraction is supported; otherwise, `false`.

### TextAreas
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/textareas.md

#### Features.TextAreas property

Gets the value that indicates whether text areas extraction is supported.

```csharp
public bool TextAreas { get; }
```

##### Return Value

`true` if text areas extraction is supported; otherwise, `false`.

### TextPage
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/textpage.md

#### Features.TextPage property

Gets the value that indicates whether text page extraction is supported.

```csharp
public bool TextPage { get; }
```

##### Return Value

`true` if text page extraction is supported; otherwise, `false`.

### Toc
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/toc.md

#### Features.Toc property

Gets the value that indicates whether table of contents extraction is supported.

```csharp
public bool Toc { get; }
```

##### Return Value

`true` if table of contents extraction is supported; otherwise, `false`.

### Worksheet
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/features/worksheet.md

#### Features.Worksheet property

Gets the value that indicates whether the worksheet extraction is supported.

```csharp
public bool Worksheet { get; }
```

##### Return Value

`true` if the worksheet extraction is supported; otherwise, `false`.

### FileFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/fileformat.md

#### FileFormat enumeration

Defines a type of the file.

```csharp
public enum FileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Default value. |
| WordProcessing | `1` | Word Processing document (DOC, DOCX, ODT, etc). |
| Spreadsheet | `2` | Spreadsheet document (XLS, XLSX, ODS, etc). |
| Presentation | `3` | Presentation document (PPT, PPTX, ODP, etc). |
| Email | `4` | Email document (email messages or email message containers). |
| Pdf | `5` | PDF document. |
| Markup | `6` | Markup document (HTML, XML, Markdown, etc). |
| Ebook | `7` | Ebook document (ePUB, FictionBook, etc). |
| Note | `8` | Note document. |
| Archive | `9` | Archive file. |
| Database | `10` | Database files (via ADO.NET). |
| Image | `11` | Image file. |

##### Remarks

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)

### FileInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/fileinfo.md

#### FileInfo class

Represents the file information.

```csharp
public class FileInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the document type. |
| IsEncrypted { get; } | Gets a value that represents whether a file is password-protected. |
| Size { get; } | Gets the size of the document in bytes. |

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/fileinfo/filetype.md

#### FileInfo.FileType property

Gets the document type.

```csharp
public FileType FileType { get; }
```

##### Property Value

An instance of `FileType` class that represents the type of the document.

### IsEncrypted
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/fileinfo/isencrypted.md

#### FileInfo.IsEncrypted property

Gets a value that represents whether a file is password-protected.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

A boolean true if a file is password-protected; otherwise false.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/fileinfo/size.md

#### FileInfo.Size property

Gets the size of the document in bytes.

```csharp
public long Size { get; }
```

##### Property Value

An integer value that represents the size of the document in bytes.

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype.md

#### FileType class

Represents the file type. Provides methods to obtain list of all file types supported by **GroupDocs.Parser**.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Filename suffix (including the period ".") e.g. ".doc". |
| FileFormat { get; } | File type name e.g. "Microsoft Word Document". |
| Format { get; } | Format of the file e.g. "WordProcessing". |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps file extension to file type. |
| Equals(FileType) | Determines whether the current `FileType` is the same as specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static GetSupportedFileTypes() | Retrieves supported file types |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

#### 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. Learn more about this file format [here](https://wiki.fileformat.com/ebook/azw3/). |
| static readonly BMP | Files having extension .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 BZ2 | Compressed file using Bzip2 algorithm. |
| 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. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/cgm/). |
| static readonly CHM | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. Learn more about this file format [here](https://wiki.fileformat.com/web/chm/). |
| 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 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 | A 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 DJVU | DjVu, pronounced as “déjà vu”, 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 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 EMF | Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/). |
| static readonly EML | EML file format represents email messages saved using Outlook and other relevant applications. 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 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 EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/). |
| static readonly FB2 | Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. Learn more about this file format [here](https://wiki.fileformat.com/ebook/fb2/). |
| static readonly GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| static readonly GZ | Files with .gz extension are compressed files created with gzip compression application. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz/). |
| static readonly HTM | Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others. Learn more about this file format [here](https://wiki.fileformat.com/web/htm/). |
| 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 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 | JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| 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 | JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPEG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPG | A JPG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly MD | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md/). |
| static readonly MHT | Files with MHT extension represent a web page archive format that can be created by a number of different applications. 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. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/). |
| static readonly MOBI | The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks. Learn more about this file format [here](https://wiki.fileformat.com/ebook/mobi/). |
| 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 NUMBERS | Files that contain the .numbers file extension are files that are created by the Apple iWork Numbers spreadsheet application. |
| 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 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 ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/). |
| static readonly ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |
| static readonly ONE | File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/). |
| 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 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 OTS | The OTS files contain template files used by the OpenOffice spreadsheet application. |
| 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 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 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/). |
| static readonly PICT | The PICT file format is a meta-format that can be used for both bitmap images and vector images. |
| static readonly PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| 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/). |
| static readonly PS | PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/ps/). |
| 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 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 RAR | Files with .rar extension represent archive files that are created for storing information in compressed or normal form. Learn more about this file format [here](https://wiki.fileformat.com/compression/rar/). |
| 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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/). |
| static readonly SEVENZ | 7z is an archiving format for compressing files and folders with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/7z/). |
| 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 a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image and compressed with gzip compression. |
| static readonly TAR | Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://wiki.fileformat.com/compression/tar/). |
| static readonly TEXT | A file with .TEXT 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/). |
| 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. 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| 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 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/). |
| static readonly Unknown | Represents unknown file type. |
| 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 XHTML | The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0. Learn more about this file format [here](https://wiki.fileformat.com/web/xhtml/). |
| static readonly XLA | The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code. Supports the use of VBA projects. |
| static readonly XLAM | The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007. An Add-In is a supplemental program that is designed to run additional code. Supports the use of VBA projects and Excel 4.0 macro sheets (.xlm). |
| static readonly XLS | Files with XLS extension represent 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/specification/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/specification/spreadsheet/xlsb/). |
| static readonly XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/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/specification/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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/). |
| static readonly XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/). |
| static readonly XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/). |
| 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/). |
| static readonly ZIP | ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/). |

##### Remarks

**Learn more:**

* [Supported Document Formats](https://docs.groupdocs.com/display/parsernet/Supported+Document+Formats)
* [Get supported file formats](https://docs.groupdocs.com/display/parsernet/Get+supported+file+formats)
* [Get document info](https://docs.groupdocs.com/display/parsernet/Get+document+info)

### AZW3
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/azw3.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/ebook/azw3/).

```csharp
public static readonly FileType AZW3;
```

### BMP
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/bmp.md

#### FileType.BMP field

Files having extension .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 FileType BMP;
```

### BZ2
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/bz2.md

#### FileType.BZ2 field

Compressed file using Bzip2 algorithm.

```csharp
public static readonly FileType BZ2;
```

### CGM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/cgm.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/cgm/).

```csharp
public static readonly FileType CGM;
```

### CHM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/chm.md

#### FileType.CHM field

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. Learn more about this file format [here](https://wiki.fileformat.com/web/chm/).

```csharp
public static readonly FileType CHM;
```

### CSV
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/csv.md

#### FileType.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 FileType CSV;
```

### DCM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/dcm.md

#### FileType.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 FileType DCM;
```

### DIB
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/dib.md

#### FileType.DIB field

A 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 FileType DIB;
```

### DJVU
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/djvu.md

#### FileType.DJVU field

DjVu, pronounced as “déjà vu”, 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 FileType DJVU;
```

### DOC
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/doc.md

#### FileType.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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/docm.md

#### FileType.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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/docx.md

#### FileType.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/dot.md

#### FileType.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 FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/dotm.md

#### FileType.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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/dotx.md

#### FileType.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 FileType DOTX;
```

### EMF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/emf.md

#### FileType.EMF field

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/).

```csharp
public static readonly FileType EMF;
```

### EML
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/eml.md

#### FileType.EML field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).

```csharp
public static readonly FileType EML;
```

### EMLX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/emlx.md

#### FileType.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 FileType EMLX;
```

### EPS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/eps.md

#### FileType.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 FileType EPS;
```

### EPUB
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/epub.md

#### FileType.EPUB field

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/).

```csharp
public static readonly FileType EPUB;
```

### Equals
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FileType` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

### Extension
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/extension.md

#### FileType.Extension property

Filename suffix (including the period ".") e.g. ".doc".

```csharp
public string Extension { get; }
```

### FB2
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/fb2.md

#### FileType.FB2 field

Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. Learn more about this file format [here](https://wiki.fileformat.com/ebook/fb2/).

```csharp
public static readonly FileType FB2;
```

### FileFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/fileformat.md

#### FileType.FileFormat property

File type name e.g. "Microsoft Word Document".

```csharp
public string FileFormat { get; }
```

### Format
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/format.md

#### FileType.Format property

Format of the file e.g. "WordProcessing".

```csharp
public FileFormat Format { get; }
```

### FromExtension
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/fromextension.md

#### FileType.FromExtension method

Maps file extension to file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension (including the period "."). |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty string. |

### GetHashCode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns the hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns sequence of supported file types

### GIF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/gif.md

#### FileType.GIF field

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).

```csharp
public static readonly FileType GIF;
```

### GZ
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/gz.md

#### FileType.GZ field

Files with .gz extension are compressed files created with gzip compression application. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz/).

```csharp
public static readonly FileType GZ;
```

### HTM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/htm.md

#### FileType.HTM field

Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others. Learn more about this file format [here](https://wiki.fileformat.com/web/htm/).

```csharp
public static readonly FileType HTM;
```

### HTML
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/html.md

#### FileType.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 FileType HTML;
```

### ICO
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ico.md

#### FileType.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 FileType ICO;
```

### J2C
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/j2c.md

#### FileType.J2C field

JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType J2C;
```

### J2K
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/j2k.md

#### FileType.J2K field

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType J2K;
```

### JP2
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jp2.md

#### FileType.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 FileType JP2;
```

### JPC
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpc.md

#### FileType.JPC field

JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPC;
```

### JPEG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpeg.md

#### FileType.JPEG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPEG;
```

### JPF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpf.md

#### FileType.JPF field

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPF;
```

### JPG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpg.md

#### FileType.JPG field

A JPG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPG;
```

### JPM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpm.md

#### FileType.JPM field

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPM;
```

### JPX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/jpx.md

#### FileType.JPX field

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPX;
```

### MD
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/md.md

#### FileType.MD field

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md/).

```csharp
public static readonly FileType MD;
```

### MHT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/mht.md

#### FileType.MHT field

Files with MHT extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/).

```csharp
public static readonly FileType MHT;
```

### MHTML
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/mhtml.md

#### FileType.MHTML field

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/).

```csharp
public static readonly FileType MHTML;
```

### MOBI
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/mobi.md

#### FileType.MOBI field

The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks. Learn more about this file format [here](https://wiki.fileformat.com/ebook/mobi/).

```csharp
public static readonly FileType MOBI;
```

### MSG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/msg.md

#### FileType.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 FileType MSG;
```

### NUMBERS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/numbers.md

#### FileType.NUMBERS field

Files that contain the .numbers file extension are files that are created by the Apple iWork Numbers spreadsheet application.

```csharp
public static readonly FileType NUMBERS;
```

### ODG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/odg.md

#### FileType.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 FileType ODG;
```

### ODP
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/odp.md

#### FileType.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 FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ods.md

#### FileType.ODS field

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/).

```csharp
public static readonly FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/odt.md

#### FileType.ODT field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/).

```csharp
public static readonly FileType ODT;
```

### ONE
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/one.md

#### FileType.ONE field

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/).

```csharp
public static readonly FileType ONE;
```

### op_Equality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

### OST
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ost.md

#### FileType.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 FileType OST;
```

### OTP
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/otp.md

#### FileType.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 FileType OTP;
```

### OTS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ots.md

#### FileType.OTS field

The OTS files contain template files used by the OpenOffice spreadsheet application.

```csharp
public static readonly FileType OTS;
```

### OTT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ott.md

#### FileType.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 FileType OTT;
```

### PCL
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pcl.md

#### FileType.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 FileType PCL;
```

### PDF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pdf.md

#### FileType.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 FileType PDF;
```

### PICT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pict.md

#### FileType.PICT field

The PICT file format is a meta-format that can be used for both bitmap images and vector images.

```csharp
public static readonly FileType PICT;
```

### PNG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/png.md

#### FileType.PNG field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/).

```csharp
public static readonly FileType PNG;
```

### POT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pot.md

#### FileType.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 FileType POT;
```

### POTM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/potm.md

#### FileType.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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/potx.md

#### FileType.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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pps.md

#### FileType.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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ppsm.md

#### FileType.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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ppsx.md

#### FileType.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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ppt.md

#### FileType.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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pptm.md

#### FileType.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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pptx.md

#### FileType.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 FileType PPTX;
```

### PS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/ps.md

#### FileType.PS field

PostScript (PS) is a general-purpose page description language used in the business of desktop and electronic publishing. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/ps/).

```csharp
public static readonly FileType PS;
```

### PSD
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/psd.md

#### FileType.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 FileType PSD;
```

### PST
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/pst.md

#### FileType.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 FileType PST;
```

### RAR
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/rar.md

#### FileType.RAR field

Files with .rar extension represent archive files that are created for storing information in compressed or normal form. Learn more about this file format [here](https://wiki.fileformat.com/compression/rar/).

```csharp
public static readonly FileType RAR;
```

### RTF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/rtf.md

#### FileType.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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/).

```csharp
public static readonly FileType RTF;
```

### SEVENZ
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/sevenz.md

#### FileType.SEVENZ field

7z is an archiving format for compressing files and folders with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/7z/).

```csharp
public static readonly FileType SEVENZ;
```

### SVG
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/svg.md

#### FileType.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 FileType SVG;
```

### SVGZ
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/svgz.md

#### FileType.SVGZ field

An SVGZ file is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image and compressed with gzip compression.

```csharp
public static readonly FileType SVGZ;
```

### TAR
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/tar.md

#### FileType.TAR field

Files with .tar extension are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://wiki.fileformat.com/compression/tar/).

```csharp
public static readonly FileType TAR;
```

### TEXT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/text.md

#### FileType.TEXT field

A file with .TEXT 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 FileType TEXT;
```

### TIF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/tif.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/tiff.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIFF;
```

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TSV
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/tsv.md

#### FileType.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 FileType TSV;
```

### TXT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/txt.md

#### FileType.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 FileType TXT;
```

### Unknown
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### WEBP
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/webp.md

#### FileType.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 FileType WEBP;
```

### WMF
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/wmf.md

#### FileType.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 FileType WMF;
```

### XHTML
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xhtml.md

#### FileType.XHTML field

The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0. Learn more about this file format [here](https://wiki.fileformat.com/web/xhtml/).

```csharp
public static readonly FileType XHTML;
```

### XLA
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xla.md

#### FileType.XLA field

The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code. Supports the use of VBA projects.

```csharp
public static readonly FileType XLA;
```

### XLAM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xlam.md

#### FileType.XLAM field

The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007. An Add-In is a supplemental program that is designed to run additional code. Supports the use of VBA projects and Excel 4.0 macro sheets (.xlm).

```csharp
public static readonly FileType XLAM;
```

### XLS
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xls.md

#### FileType.XLS field

Files with XLS extension represent 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/specification/spreadsheet/xls/).

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xlsb.md

#### FileType.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/specification/spreadsheet/xlsb/).

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xlsm.md

#### FileType.XLSM field

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xlsx.md

#### FileType.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/specification/spreadsheet/xlsx/).

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xlt.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xltm.md

#### FileType.XLTM field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).

```csharp
public static readonly FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xltx.md

#### FileType.XLTX field

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).

```csharp
public static readonly FileType XLTX;
```

### XML
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/xml.md

#### FileType.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 FileType XML;
```

### ZIP
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetype/zip.md

#### FileType.ZIP field

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/).

```csharp
public static readonly FileType ZIP;
```

### FileTypeDetectionMode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/filetypedetectionmode.md

#### FileTypeDetectionMode enumeration

Defines a mode of the file type detection.

```csharp
public enum FileTypeDetectionMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content. |
| Extension | `1` | The file type is detected only by the file extension. |
| Content | `2` | The file type is detected only by the file content. |

### FormattedTextMode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/formattedtextmode.md

#### FormattedTextMode enumeration

Defines a formatted text mode.

```csharp
public enum FormattedTextMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Html | `0` | HTML format. |
| Markdown | `1` | Markdown format. |
| PlainText | `2` | Plain text format. |

##### Remarks

**Learn more:**

* [Extract formatted text from document](https://docs.groupdocs.com/display/parsernet/Extract+formatted+text+from+document)
* Extract a document text as [HTML](https://docs.groupdocs.com/display/parsernet/HTML)
* Extract a document text as [Markdown](https://docs.groupdocs.com/display/parsernet/Markdown)
* Extract a document text as [Plain text](https://docs.groupdocs.com/display/parsernet/Plain+text)

### FormattedTextOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/formattedtextoptions.md

#### FormattedTextOptions class

Provides the options which are used for formatted text extraction.

```csharp
public sealed class FormattedTextOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FormattedTextOptions() | Initializes a new instance of the `FormattedTextOptions` class. |
| FormattedTextOptions(FormattedTextMode) | Initializes a new instance of the `FormattedTextOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Mode { get; set; } | Gets the formatted text extraction mode. |

##### Remarks

An instance of `FormattedTextOptions` class is used as parameter in `GetFormattedText` and `GetFormattedText` methods. See the usage examples there.

**Learn more:**

* [Extract formatted text from document](https://docs.groupdocs.com/display/parsernet/Extract+formatted+text+from+document)
* Extract a document text as [HTML](https://docs.groupdocs.com/display/parsernet/HTML)
* Extract a document text as [Markdown](https://docs.groupdocs.com/display/parsernet/Markdown)
* Extract a document text as [Plain text](https://docs.groupdocs.com/display/parsernet/Plain+text)

### FormattedTextOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/formattedtextoptions/formattedtextoptions.md

#### FormattedTextOptions()

Initializes a new instance of the `FormattedTextOptions` class.

```csharp
public FormattedTextOptions()
```

#### FormattedTextOptions(FormattedTextMode)

Initializes a new instance of the `FormattedTextOptions` class.

```csharp
public FormattedTextOptions(FormattedTextMode mode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mode | FormattedTextMode | The mode of formatted text extraction. |

### Mode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/formattedtextoptions/mode.md

#### FormattedTextOptions.Mode property

Gets the formatted text extraction mode.

```csharp
public FormattedTextMode Mode { get; set; }
```

##### Property Value

`FormattedTextMode` enumeration that contains a formatted text extraction mode.

### HighlightOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/highlightoptions.md

#### HighlightOptions class

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

```csharp
public sealed class HighlightOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| HighlightOptions() | Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight. |
| HighlightOptions(int) | Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight. |
| HighlightOptions(int?, bool) | Initializes a new instance of the `HighlightOptions` class which is used to extract a line-limited highlight. |
| HighlightOptions(int?, int) | Initializes a new instance of the `HighlightOptions` class which is used to extract a highlight with the fixed word count. |
| HighlightOptions(int?, int?, bool) | Initializes a new instance of the `HighlightOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsLineLimited { get; set; } | Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line. |
| MaxLength { get; set; } | Gets a maximum text length. |
| WordCount { get; set; } | Gets a maximum word count. |

##### Remarks

An instance of `HighlightOptions` class is used as parameter in `GetHighlight` method. See the usage examples there.

**Learn more:**

* [Extract highlights](https://docs.groupdocs.com/display/parsernet/Extract+highlights)

### HighlightOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/highlightoptions/highlightoptions.md

#### HighlightOptions()

Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight.

```csharp
public HighlightOptions()
```

#### HighlightOptions(int)

Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight.

```csharp
public HighlightOptions(int maxLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | Int32 | The maximum text length. |

#### HighlightOptions(int?, bool)

Initializes a new instance of the `HighlightOptions` class which is used to extract a line-limited highlight.

```csharp
public HighlightOptions(int? maxLength, bool isLineLimited)
```

| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | Nullable`1 | The maximum text length. |
| isLineLimited | Boolean | The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line. |

#### HighlightOptions(int?, int)

Initializes a new instance of the `HighlightOptions` class which is used to extract a highlight with the fixed word count.

```csharp
public HighlightOptions(int? maxLength, int wordCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | Nullable`1 | The maximum text length. |
| wordCount | Int32 | The maximum word count. |

#### HighlightOptions(int?, int?, bool)

Initializes a new instance of the `HighlightOptions` class.

```csharp
public HighlightOptions(int? maxLength, int? wordCount, bool isLineLimited)
```

| Parameter | Type | Description |
| --- | --- | --- |
| maxLength | Nullable`1 | The maximum text length. |
| wordCount | Nullable`1 | The maximum word count. |
| isLineLimited | Boolean | The value that indicates whether the highlight extraction is limited by the start (or the end) of a text line. |

### IsLineLimited
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/highlightoptions/islinelimited.md

#### HighlightOptions.IsLineLimited property

Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.

```csharp
public bool IsLineLimited { get; set; }
```

##### Return Value

`true` if highlight extraction is limited by the start (or the end) of a text line; otherwise, `false`.

### MaxLength
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/highlightoptions/maxlength.md

#### HighlightOptions.MaxLength property

Gets a maximum text length.

```csharp
public int? MaxLength { get; set; }
```

##### Property Value

A positive integer value that represents the maximum text length; `null` if the text length isn't limited.

### WordCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/highlightoptions/wordcount.md

#### HighlightOptions.WordCount property

Gets a maximum word count.

```csharp
public int? WordCount { get; set; }
```

##### Property Value

A positive integer value that represents the maximum word count; `null` if the word count isn't limited.

### IDocumentInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo.md

#### IDocumentInfo interface

Represents the document information.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the document type. |
| PageCount { get; } | Gets the total number of document pages. |
| Pages { get; } | Gets the information about pages such as the index and page size. |
| RawPageCount { get; } | Gets the total number of document raw pages. |
| Size { get; } | Gets the size of the document in bytes. |

##### Remarks

The objects which implement this interface are returned by `GetDocumentInfo` method. See the usage examples there. **Learn more:**

* [Get document info](https://docs.groupdocs.com/display/parsernet/Get+document+info)
* [Detect encoding](https://docs.groupdocs.com/display/parsernet/Detect+encoding)

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Gets the document type.

```csharp
public FileType FileType { get; }
```

##### Property Value

An instance of `FileType` class that represents the type of the document.

### PageCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Gets the total number of document pages.

```csharp
public int PageCount { get; }
```

##### Property Value

An integer value that represents a total number of pages.

### Pages
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Gets the information about pages such as the index and page size.

```csharp
public IList<PageInfo> Pages { get; }
```

##### Property Value

A collection with instances of `PageInfo` classes.

### RawPageCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo/rawpagecount.md

#### IDocumentInfo.RawPageCount property

Gets the total number of document raw pages.

```csharp
public int RawPageCount { get; }
```

##### Property Value

An integer value that represents a total number of raw pages.

##### Remarks

Use `RawPageCount` property instead of `PageCount` property for raw text extraction. Some documents have different page numbers in accurate and raw text extraction modes. `PageCount` property may perform extra calculations which impacts on text extraction speed in raw mode.

### Size
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/idocumentinfo/size.md

#### IDocumentInfo.Size property

Gets the size of the document in bytes.

```csharp
public long Size { get; }
```

##### Property Value

An integer value that represents the size of the document in bytes.

### ILogger
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ilogger.md

#### ILogger interface

Defines the interface of a logger that is used for logging events and errors during data extraction.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Logs an error that occurred during data extraction. |
| Trace(string) | Logs an event occurred during data extraction. |
| Warning(string) | Logs a warning that occurred during data extraction. |

##### Remarks

**Learn more:**

* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)

### Error
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ilogger/error.md

#### ILogger.Error method

Logs an error that occurred during data extraction.

```csharp
public void Error(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| exception | Exception | The instance of occured exception. |

### Trace
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ilogger/trace.md

#### ILogger.Trace method

Logs an event occurred during data extraction.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The event message. |

### Warning
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ilogger/warning.md

#### ILogger.Warning method

Logs a warning that occurred during data extraction.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

### ImageFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/imageformat.md

#### ImageFormat enumeration

Defines a format of the image.

```csharp
public enum ImageFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Bmp | `0` | Bitmap image. |
| Gif | `1` | Graphical Interchange Format. |
| Jpeg | `2` | JPEG image. |
| Png | `3` | Portable Network Graphic. |
| WebP | `4` | WebP Image. |

### ImageOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/imageoptions.md

#### ImageOptions class

Provides the options which are used for image extraction.

```csharp
public sealed class ImageOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageOptions(ImageFormat) | Initializes a new instance of the `ImageOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ImageFormat { get; } | Gets the image format for image extraction. |

##### Remarks

An instance of `ImageOptions` class is used as parameter in `GetImageStream` and `Save` methods. See the usage examples there.

It's used to specify the image format for image extraction.

**Learn more:**

* [Extract images from document page area](https://docs.groupdocs.com/display/parsernet/Extract+images+from+document+page+area)
* [Extract images to files](https://docs.groupdocs.com/display/parsernet/Extract+images+to+files)

### ImageFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/imageoptions/imageformat.md

#### ImageOptions.ImageFormat property

Gets the image format for image extraction.

```csharp
public ImageFormat ImageFormat { get; }
```

##### Property Value

`ImageFormat` enumeration that contains an image format.

### ImageOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/imageoptions/imageoptions.md

#### ImageOptions constructor

Initializes a new instance of the `ImageOptions` class.

```csharp
public ImageOptions(ImageFormat imageFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageFormat | ImageFormat | The format of the image. |

### LoadOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions.md

#### LoadOptions class

Provides the options which are used to open a file.

```csharp
public sealed class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the `LoadOptions` class with empty `Password`, `FileFormat` equal to Unknown and default encodings. |
| LoadOptions(FileFormat) | Initializes a new instance of the `LoadOptions` class with empty `Password` and default encodings. |
| LoadOptions(FileType) | Initializes a new instance of the `LoadOptions` class with empty `Password` and default encodings. |
| LoadOptions(string) | Initializes a new instance of the `LoadOptions` class with `FileFormat` equal to Unknown and default encodings. |
| LoadOptions(TimeSpan) | Initializes a new instance of the `LoadOptions` class with *timeout*. |
| LoadOptions(FileFormat, string) | Initializes a new instance of the `LoadOptions` class with the password and default encodings. |
| LoadOptions(FileType, string) | Initializes a new instance of the `LoadOptions` class with the password and default encodings. |
| LoadOptions(FileFormat, string, Encoding, Encoding) | Initializes a new instance of the `LoadOptions` class with custom encodings. |
| LoadOptions(FileType, string, Encoding, Encoding) | Initializes a new instance of the `LoadOptions` class with custom encodings. |
| LoadOptions(FileFormat, string, Encoding, Encoding, TimeSpan) | Initializes a new instance of the `LoadOptions` fully customized class. |
| LoadOptions(FileType, string, Encoding, Encoding, TimeSpan) | Initializes a new instance of the `LoadOptions` fully customized class. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultAnsiEncoding { get; } | Gets the default ANSI encoding which is used for encoding detection. |
| Encoding { get; } | Gets the encoding of the document. |
| FileFormat { get; } | Gets the file format. |
| FileType { get; } | Gets the file type. |
| Password { get; } | Gets the password. |
| Timeout { get; } | Gets the value that represents the number of milliseconds to wait. |

##### Remarks

An instance of this class is used as parameter in `Parser` class constructors:

* `Parser`
* `Parser`

See the usage examples there.

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)
* [Loading password-protected documents](https://docs.groupdocs.com/display/parsernet/Password-protected+documents)

### DefaultAnsiEncoding
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/defaultansiencoding.md

#### LoadOptions.DefaultAnsiEncoding property

Gets the default ANSI encoding which is used for encoding detection.

```csharp
public Encoding DefaultAnsiEncoding { get; }
```

##### Property Value

An instance of Encoding class that represents the document encoding; `null` if it isn't set.

### Encoding
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/encoding.md

#### LoadOptions.Encoding property

Gets the encoding of the document.

```csharp
public Encoding Encoding { get; }
```

##### Property Value

An instance of Encoding class that represents the document encoding; `null` if it isn't set.

### FileFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/fileformat.md

#### LoadOptions.FileFormat property

Gets the file format.

```csharp
public FileFormat FileFormat { get; }
```

##### Property Value

`FileFormat` enumeration that contains a file format.

### FileType
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/filetype.md

#### LoadOptions.FileType property

Gets the file type.

```csharp
public FileType FileType { get; }
```

##### Property Value

`FileType` enumeration that contains a file type.

### LoadOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of the `LoadOptions` class with empty `Password`, `FileFormat` equal to Unknown and default encodings.

```csharp
public LoadOptions()
```

#### LoadOptions(TimeSpan)

Initializes a new instance of the `LoadOptions` class with *timeout*.

```csharp
public LoadOptions(TimeSpan timeout)
```

| Parameter | Type | Description |
| --- | --- | --- |
| timeout | TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

#### LoadOptions(string)

Initializes a new instance of the `LoadOptions` class with `FileFormat` equal to Unknown and default encodings.

```csharp
public LoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password to open the password-protected file. |

#### LoadOptions(FileFormat)

Initializes a new instance of the `LoadOptions` class with empty `Password` and default encodings.

```csharp
public LoadOptions(FileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file. |

#### LoadOptions(FileFormat, string)

Initializes a new instance of the `LoadOptions` class with the password and default encodings.

```csharp
public LoadOptions(FileFormat fileFormat, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file. |
| password | String | The password to open the password-protected file. |

#### LoadOptions(FileFormat, string, Encoding, Encoding)

Initializes a new instance of the `LoadOptions` class with custom encodings.

```csharp
public LoadOptions(FileFormat fileFormat, string password, Encoding encoding, 
    Encoding defaultAnsiEncoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file. |
| password | String | The password to open the password-protected file. |
| encoding | Encoding | The encoding of the document. |
| defaultAnsiEncoding | Encoding | The default ANSI encoding which is used for encoding detection. |

#### LoadOptions(FileFormat, string, Encoding, Encoding, TimeSpan)

Initializes a new instance of the `LoadOptions` fully customized class.

```csharp
public LoadOptions(FileFormat fileFormat, string password, Encoding encoding, 
    Encoding defaultAnsiEncoding, TimeSpan timeout)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | FileFormat | The format of the file. |
| password | String | The password to open the password-protected file. |
| encoding | Encoding | The encoding of the document. |
| defaultAnsiEncoding | Encoding | The default ANSI encoding which is used for encoding detection. |
| timeout | TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

#### LoadOptions(FileType)

Initializes a new instance of the `LoadOptions` class with empty `Password` and default encodings.

```csharp
public LoadOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |

#### LoadOptions(FileType, string)

Initializes a new instance of the `LoadOptions` class with the password and default encodings.

```csharp
public LoadOptions(FileType fileType, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| password | String | The password to open the password-protected file. |

#### LoadOptions(FileType, string, Encoding, Encoding)

Initializes a new instance of the `LoadOptions` class with custom encodings.

```csharp
public LoadOptions(FileType fileType, string password, Encoding encoding, 
    Encoding defaultAnsiEncoding)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| password | String | The password to open the password-protected file. |
| encoding | Encoding | The encoding of the document. |
| defaultAnsiEncoding | Encoding | The default ANSI encoding which is used for encoding detection. |

#### LoadOptions(FileType, string, Encoding, Encoding, TimeSpan)

Initializes a new instance of the `LoadOptions` fully customized class.

```csharp
public LoadOptions(FileType fileType, string password, Encoding encoding, 
    Encoding defaultAnsiEncoding, TimeSpan timeout)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| password | String | The password to open the password-protected file. |
| encoding | Encoding | The encoding of the document. |
| defaultAnsiEncoding | Encoding | The default ANSI encoding which is used for encoding detection. |
| timeout | TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

### Password
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/password.md

#### LoadOptions.Password property

Gets the password.

```csharp
public string Password { get; }
```

##### Property Value

A string value that represents a password to open the password-protected file.

### Timeout
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/loadoptions/timeout.md

#### LoadOptions.Timeout property

Gets the value that represents the number of milliseconds to wait.

```csharp
public TimeSpan Timeout { get; }
```

##### Property Value

A TimeSpan that represents the number of milliseconds to wait.

### OcrConnectorBase
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocrconnectorbase.md

#### OcrConnectorBase class

Provides the OCR functionality.

```csharp
public abstract class OcrConnectorBase
```

#### Properties

| Name | Description |
| --- | --- |
| virtual IsTextAreasSupported { get; } | Gets the value that indicates whether the text areas extraction is supported. |
| virtual IsTextSupported { get; } | Gets the value that indicates whether the text extraction is supported. |

#### Methods

| Name | Description |
| --- | --- |
| virtual RecognizeText(Stream, OcrOptions) | Recognize a text from *imageStream* stream. |
| virtual RecognizeTextAreas(Stream, Page, OcrOptions) | Recognize text areas from *imageStream* stream. |
| virtual RecognizeTextAreas(Stream, IEnumerable&lt;Rectangle&gt;, string, Page, OcrOptions) | Recognize text areas from *imageStream* stream. |

### IsTextAreasSupported
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocrconnectorbase/istextareassupported.md

#### OcrConnectorBase.IsTextAreasSupported property

Gets the value that indicates whether the text areas extraction is supported.

```csharp
public virtual bool IsTextAreasSupported { get; }
```

##### Property Value

`true` if the text areas extraction is supported; otherwise, `false`.

### IsTextSupported
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocrconnectorbase/istextsupported.md

#### OcrConnectorBase.IsTextSupported property

Gets the value that indicates whether the text extraction is supported.

```csharp
public virtual bool IsTextSupported { get; }
```

##### Property Value

`true` if the text extraction is supported; otherwise, `false`.

### RecognizeText
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocrconnectorbase/recognizetext.md

#### OcrConnectorBase.RecognizeText method

Recognize a text from *imageStream* stream.

```csharp
public virtual string RecognizeText(Stream imageStream, OcrOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | The image representation of the document page. |
| options | OcrOptions | The OCR options. |

##### Return Value

A string that represents a recognized text; `null` if text recognizing isn't supported.

### RecognizeTextAreas
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocrconnectorbase/recognizetextareas.md

#### RecognizeTextAreas(Stream, Page, OcrOptions)

Recognize text areas from *imageStream* stream.

```csharp
public virtual IList<PageTextArea> RecognizeTextAreas(Stream imageStream, Page page, 
    OcrOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | The image representation of the document page. |
| page | Page | The the document page. |
| options | OcrOptions | The OCR options. |

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas recognizing isn't supported.

#### RecognizeTextAreas(Stream, IEnumerable&lt;Rectangle&gt;, string, Page, OcrOptions)

Recognize text areas from *imageStream* stream.

```csharp
public virtual IList<PageTextArea> RecognizeTextAreas(Stream imageStream, 
    IEnumerable<Rectangle> rectangles, string allowedSymbols, Page page, OcrOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | The image representation of the document page. |
| rectangles | IEnumerable`1 | The collection of rectangular areas that limits the OCR functionality. |
| allowedSymbols | String | The filter of allowed symbols by OCR. |
| page | Page | The the document page. |
| options | OcrOptions | The OCR options. |

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas recognizing isn't supported.

### OcrEventHandler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler.md

#### OcrEventHandler class

Provides a handler for OCR events.

```csharp
public class OcrEventHandler
```

#### Constructors

| Name | Description |
| --- | --- |
| OcrEventHandler() | Initializes a new instance of the `OcrEventHandler` class. |

#### Properties

| Name | Description |
| --- | --- |
| HasWarnings { get; } | Gets the value that indicates whether the list of warnings isn't empty. |
| Warnings { get; } | Gets a list of warning messages. |

#### Methods

| Name | Description |
| --- | --- |
| GetWarnings(int) | Returns a list of warning messages for the page with *pageIndex*. |
| virtual OnWarnings(int, IList&lt;string&gt;) | Sets warning messages for the page. |

### GetWarnings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler/getwarnings.md

#### OcrEventHandler.GetWarnings method

Returns a list of warning messages for the page with *pageIndex*.

```csharp
public IList<string> GetWarnings(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A list of warning messages for the page; empty list if no warning messages for the page.

### HasWarnings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler/haswarnings.md

#### OcrEventHandler.HasWarnings property

Gets the value that indicates whether the list of warnings isn't empty.

```csharp
public bool HasWarnings { get; }
```

##### Return Value

`true` if the list of warnings isn't empty; otherwise, `false`.

### OcrEventHandler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler/ocreventhandler.md

#### OcrEventHandler constructor

Initializes a new instance of the `OcrEventHandler` class.

```csharp
public OcrEventHandler()
```

### OnWarnings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler/onwarnings.md

#### OcrEventHandler.OnWarnings method

Sets warning messages for the page.

```csharp
public virtual void OnWarnings(int pageIndex, IList<string> warnings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| warnings | IList`1 | The list of warning messages for the page. |

### Warnings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocreventhandler/warnings.md

#### OcrEventHandler.Warnings property

Gets a list of warning messages.

```csharp
public IList<string> Warnings { get; }
```

##### Property Value

A list of warning messages for all pages.

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions.md

#### OcrOptions class

Provides the options which are used for OCR Connector.

```csharp
public class OcrOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OcrOptions() | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| OcrOptions(OcrEventHandler) | Initializes a new instance of the `OcrOptions` class with `OcrEventHandler` object. |
| OcrOptions(PagePreviewOptions) | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| OcrOptions(Rectangle) | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| OcrOptions(Rectangle, OcrEventHandler) | Initializes a new instance of the `OcrOptions` class with rectangular area and `OcrEventHandler` object. |
| OcrOptions(Rectangle, OcrEventHandler, PagePreviewOptions, bool) | Initializes a new instance of the `OcrOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Handler { get; set; } | Gets the event handler to catch OCR events. |
| PagePreviewOptions { get; set; } | Gets the document page preview options. |
| Rectangle { get; set; } | Gets the rectangular area that constraints the page area which is used for text recognizing. |
| UseSpellChecker { get; set; } | Gets the value that indicates whether the spell checker is used. |

### Handler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions/handler.md

#### OcrOptions.Handler property

Gets the event handler to catch OCR events.

```csharp
public OcrEventHandler Handler { get; set; }
```

##### Property Value

An instance of `OcrEventHandler` class which is used to catch OCR events.

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions/ocroptions.md

#### OcrOptions()

Initializes a new instance of the `OcrOptions` class with rectangular area.

```csharp
public OcrOptions()
```

#### OcrOptions(PagePreviewOptions)

Initializes a new instance of the `OcrOptions` class with rectangular area.

```csharp
public OcrOptions(PagePreviewOptions pagePreviewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pagePreviewOptions | PagePreviewOptions | An instance of `PagePreviewOptions` class that sets properties for the document page preview generation. |

#### OcrOptions(Rectangle)

Initializes a new instance of the `OcrOptions` class with rectangular area.

```csharp
public OcrOptions(Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |

#### OcrOptions(OcrEventHandler)

Initializes a new instance of the `OcrOptions` class with `OcrEventHandler` object.

```csharp
public OcrOptions(OcrEventHandler handler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| handler | OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |

#### OcrOptions(Rectangle, OcrEventHandler)

Initializes a new instance of the `OcrOptions` class with rectangular area and `OcrEventHandler` object.

```csharp
public OcrOptions(Rectangle rectangle, OcrEventHandler handler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |
| handler | OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |

#### OcrOptions(Rectangle, OcrEventHandler, PagePreviewOptions, bool)

Initializes a new instance of the `OcrOptions` class.

```csharp
public OcrOptions(Rectangle rectangle, OcrEventHandler handler, 
    PagePreviewOptions pagePreviewOptions, bool useSpellCheker)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |
| handler | OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |
| pagePreviewOptions | PagePreviewOptions | An instance of `PagePreviewOptions` class that sets properties for the document page preview generation. |
| useSpellCheker | Boolean | The value that indicates whether the spell checker is used. |

### PagePreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions/pagepreviewoptions.md

#### OcrOptions.PagePreviewOptions property

Gets the document page preview options.

```csharp
public PagePreviewOptions PagePreviewOptions { get; set; }
```

##### Property Value

An instance of `PagePreviewOptions` class that sets properties for the document page preview generation.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions/rectangle.md

#### OcrOptions.Rectangle property

Gets the rectangular area that constraints the page area which is used for text recognizing.

```csharp
public Rectangle Rectangle { get; set; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that constraints the page area which is used for text recognizing.; `null` if it isn't set.

### UseSpellChecker
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/ocroptions/usespellchecker.md

#### OcrOptions.UseSpellChecker property

Gets the value that indicates whether the spell checker is used.

```csharp
public bool UseSpellChecker { get; set; }
```

##### Property Value

`true` if the spell checker is used; otherwise, `false`.

### PageAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageareaoptions.md

#### PageAreaOptions class

Provides the options which are used for page areas extraction.

```csharp
public class PageAreaOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageAreaOptions() | Initializes a new instance of the `PageAreaOptions` class. |
| PageAreaOptions(Rectangle) | Initializes a new instance of the `PageAreaOptions` class. |
| PageAreaOptions(Rectangle, double) | Initializes a new instance of the `PageAreaOptions` class with the size of the ignored border. |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; set; } | Gets the rectangular area that contains page areas. |
| RectangleTolerance { get; set; } | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

##### Remarks

An instance of `PageAreaOptions` class is used as parameter in the following methods:

* `GetImages`
* `GetImages`
* `GetHyperlinks`
* `GetHyperlinks`
* `GetHyperlinks`
* `GetHyperlinks`

See the usage examples there.

### PageAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageareaoptions/pageareaoptions.md

#### PageAreaOptions()

Initializes a new instance of the `PageAreaOptions` class.

```csharp
public PageAreaOptions()
```

#### PageAreaOptions(Rectangle)

Initializes a new instance of the `PageAreaOptions` class.

```csharp
public PageAreaOptions(Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains page areas. |

#### PageAreaOptions(Rectangle, double)

Initializes a new instance of the `PageAreaOptions` class with the size of the ignored border.

```csharp
public PageAreaOptions(Rectangle rectangle, double rectangleTolerance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains page areas. |
| rectangleTolerance | Double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageareaoptions/rectangle.md

#### PageAreaOptions.Rectangle property

Gets the rectangular area that contains page areas.

```csharp
public Rectangle Rectangle { get; set; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains page areas; `null` if it isn't set.

### RectangleTolerance
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageareaoptions/rectangletolerance.md

#### PageAreaOptions.RectangleTolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

```csharp
public double RectangleTolerance { get; set; }
```

##### Return Value

The double value from 0 (no border) to 1 (ignore the whole element).

### PageInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageinfo.md

#### PageInfo class

Represents the document page information.

```csharp
public sealed class PageInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the page height. |
| PageNumber { get; } | Gets the page number. |
| Width { get; } | Gets the page width. |

### Height
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageinfo/height.md

#### PageInfo.Height property

Gets the page height.

```csharp
public int Height { get; }
```

##### Property Value

An integer value that represents the page height.

### PageNumber
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Gets the page number.

```csharp
public int PageNumber { get; }
```

##### Property Value

A zero-based integer value that represents the page number.

### Width
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pageinfo/width.md

#### PageInfo.Width property

Gets the page width.

```csharp
public int Width { get; }
```

##### Property Value

An integer value that represents the page width.

### PagePreviewFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewformat.md

#### PagePreviewFormat enumeration

Represents supported preview formats.

```csharp
public enum PagePreviewFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | PNG, JPEG and BMP images retain their format if no changes are required. For other cases, PNG format is used. |
| Png | `1` | PNG image (Portable Network Graphics). |
| Jpeg | `2` | JPEG image (Joint Photographic Experts Group Format). |
| Bmp | `3` | Bitmap image (Bitmap Picture Format). |

### PagePreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions.md

#### PagePreviewOptions class

Provides the options which are used to generate the document page preview.

```csharp
public sealed class PagePreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PagePreviewOptions() | Initializes a new instance of the `PagePreviewOptions` class. |
| PagePreviewOptions(int) | Initializes a new instance of the `PagePreviewOptions` class with the preview dpi. |
| PagePreviewOptions(PagePreviewFormat) | Initializes a new instance of the `PagePreviewOptions` class with the preview format. |
| PagePreviewOptions(PagePreviewFormat, int) | Initializes a new instance of the `PagePreviewOptions` class the preview format and dpi. |

#### Properties

| Name | Description |
| --- | --- |
| Dpi { get; set; } | Gets a DPI of the document page image. |
| Format { get; set; } | Gets a format of the document page image. |
| ScaleFactor { get; } | Gets a scale factor. |

#### Fields

| Name | Description |
| --- | --- |
| const DEFAULT_DPI | Defines a default value of `Dpi` property. |

### DEFAULT_DPI
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions/default_dpi.md

#### PagePreviewOptions.DEFAULT_DPI field

Defines a default value of `Dpi` property.

```csharp
public const int DEFAULT_DPI;
```

### Dpi
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions/dpi.md

#### PagePreviewOptions.Dpi property

Gets a DPI of the document page image.

```csharp
public int Dpi { get; set; }
```

##### Property Value

A value that sets the document page DPI. If not set, value is `DEFAULT_DPI`.

### Format
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions/format.md

#### PagePreviewOptions.Format property

Gets a format of the document page image.

```csharp
public PagePreviewFormat Format { get; set; }
```

##### Property Value

A value that sets the document page image format. If not set, value is Png.

### PagePreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions/pagepreviewoptions.md

#### PagePreviewOptions()

Initializes a new instance of the `PagePreviewOptions` class.

```csharp
public PagePreviewOptions()
```

#### PagePreviewOptions(PagePreviewFormat)

Initializes a new instance of the `PagePreviewOptions` class with the preview format.

```csharp
public PagePreviewOptions(PagePreviewFormat format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | PagePreviewFormat | The format of the document page image. |

#### PagePreviewOptions(int)

Initializes a new instance of the `PagePreviewOptions` class with the preview dpi.

```csharp
public PagePreviewOptions(int dpi)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dpi | Int32 | The DPI of the document page image. |

#### PagePreviewOptions(PagePreviewFormat, int)

Initializes a new instance of the `PagePreviewOptions` class the preview format and dpi.

```csharp
public PagePreviewOptions(PagePreviewFormat format, int dpi)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | PagePreviewFormat | The format of the document page image. |
| dpi | Int32 | The DPI of the document page image. |

### ScaleFactor
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagepreviewoptions/scalefactor.md

#### PagePreviewOptions.ScaleFactor property

Gets a scale factor.

```csharp
public double ScaleFactor { get; }
```

##### Property Value

The value that specifies how many times the image should be scaled; `1` for `DEFAULT_DPI`.

### PageRenderInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo.md

#### PageRenderInfo class

Represents the information of how a page is rendered.

```csharp
public sealed class PageRenderInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PageRenderInfo(int, int, int) | Initializes a new instance of the `PageRenderInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| ColumnCount { get; } | Get the total number of tiles columns. |
| PageNumber { get; } | Gets the page number. |
| RowCount { get; } | Get the total number of tiles rows. |

#### Methods

| Name | Description |
| --- | --- |
| GetColumn(int) | Returns the index of column where the tile with *tileIndex* is placed. |
| GetRow(int) | Returns the index of row where the tile with *tileIndex* is placed. |

##### Remarks

Some documents (spreadsheets, for example) are not possible to render a page as a single image. For those documents a page is rendered as a set of tiles. These tiles are placed in the rectangular table.

`RowCount` and `ColumnCount` represent the total number of rows and columns of this table. If document page is rendered to the single image these properties are equal to 1.

### ColumnCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/columncount.md

#### PageRenderInfo.ColumnCount property

Get the total number of tiles columns.

```csharp
public int ColumnCount { get; }
```

##### Property Value

The integer value that represents the total number of tiles columns.

### GetColumn
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/getcolumn.md

#### PageRenderInfo.GetColumn method

Returns the index of column where the tile with *tileIndex* is placed.

```csharp
public int GetColumn(int tileIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tileIndex | Int32 | The zero-based index of the tile. |

##### Return Value

The zero-based integer value that represents the column index.

### GetRow
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/getrow.md

#### PageRenderInfo.GetRow method

Returns the index of row where the tile with *tileIndex* is placed.

```csharp
public int GetRow(int tileIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tileIndex | Int32 | The zero-based index of the tile. |

##### Return Value

The zero-based integer value that represents the row index.

### PageNumber
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/pagenumber.md

#### PageRenderInfo.PageNumber property

Gets the page number.

```csharp
public int PageNumber { get; }
```

##### Property Value

The integer value that represents the page number (starts with 1).

### PageRenderInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/pagerenderinfo.md

#### PageRenderInfo constructor

Initializes a new instance of the `PageRenderInfo` class.

```csharp
public PageRenderInfo(int pageNumber, int rowCount, int columnCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of the page (starts with 1). |
| rowCount | Int32 | The total number of tiles rows. |
| columnCount | Int32 | The total number of tiles columns. |

### RowCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagerenderinfo/rowcount.md

#### PageRenderInfo.RowCount property

Get the total number of tiles rows.

```csharp
public int RowCount { get; }
```

##### Property Value

The integer value that represents the total number of tiles rows.

### PageTableAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetableareaoptions.md

#### PageTableAreaOptions class

Provides the options which are used for page table areas extraction.

```csharp
public sealed class PageTableAreaOptions : PageAreaOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageTableAreaOptions(TemplateTableLayout) | Initializes a new instance of the `PageAreaOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; set; } | Gets the rectangular area that contains page areas. |
| RectangleTolerance { get; set; } | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |
| TableLayout { get; } | Gets the table layout which defines the table on a page. |

##### Remarks

An instance of `PageTableAreaOptions` class is used as parameter in `GetTables` and `GetTables` methods. See the usage examples there.

### PageTableAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetableareaoptions/pagetableareaoptions.md

#### PageTableAreaOptions constructor

Initializes a new instance of the `PageAreaOptions` class.

```csharp
public PageTableAreaOptions(TemplateTableLayout tableLayout)
```

| Parameter | Type | Description |
| --- | --- | --- |
| tableLayout | TemplateTableLayout | The table layout which defines the table on a page. |

### TableLayout
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetableareaoptions/tablelayout.md

#### PageTableAreaOptions.TableLayout property

Gets the table layout which defines the table on a page.

```csharp
public TemplateTableLayout TableLayout { get; }
```

##### Property Value

An instane of `TemplateTableLayout` class.

### PageTextAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions.md

#### PageTextAreaOptions class

Provides the options which are used for page text areas extraction.

```csharp
public sealed class PageTextAreaOptions : PageAreaOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PageTextAreaOptions() | Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option. |
| PageTextAreaOptions(bool) | Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option. |
| PageTextAreaOptions(string) | Initializes a new instance of the `PageTextAreaOptions` class with the regular expression. Other options are set by default (see remarks for details). |
| PageTextAreaOptions(bool, OcrOptions) | Initializes a new instance of the `PageTextAreaOptions` class with the ability to set OCR options. |
| PageTextAreaOptions(string, Rectangle) | Initializes a new instance of the `PageTextAreaOptions` class with the regular expression and rectangular area. Other options are set by default (see remarks for details). |
| PageTextAreaOptions(string, Rectangle, double) | Initializes a new instance of the `PageTextAreaOptions` class with the regular expression, rectangular area and the size of the ignored border. Other options are set by default (see remarks for details). |
| PageTextAreaOptions(string, bool, bool, bool, Rectangle) | Initializes a new instance of the `PageTextAreaOptions` class. |
| PageTextAreaOptions(string, bool, bool, bool, Rectangle, double) | Initializes a new instance of the `PageTextAreaOptions` class with the size of the ignored border. |

#### Properties

| Name | Description |
| --- | --- |
| Expression { get; set; } | Gets the regular expression. |
| IgnoreFormatting { get; set; } | Gets the value that indicates whether text formatting is ignored. |
| MatchCase { get; set; } | Gets the value that indicates whether a text case isn't ignored. |
| OcrOptions { get; set; } | Gets the additional options for OCR functionality. |
| Rectangle { get; set; } | Gets the rectangular area that contains page areas. |
| RectangleTolerance { get; set; } | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |
| UniteSegments { get; set; } | Gets the value that indicates whether segments are united. |
| UseOcr { get; set; } | Gets the value that indicates whether OCR functionality is used to extract text areas. |

##### Remarks

An instance of `PageTextAreaOptions` class is used as parameter in `GetTextAreas` and `GetTextAreas` methods. See the usage examples there. **Learn more:**

* [Extract text areas](https://docs.groupdocs.com/display/parsernet/Extract+text+areas)

### Expression
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/expression.md

#### PageTextAreaOptions.Expression property

Gets the regular expression.

```csharp
public string Expression { get; set; }
```

##### Property Value

A string that represents the regular expression.

### IgnoreFormatting
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/ignoreformatting.md

#### PageTextAreaOptions.IgnoreFormatting property

Gets the value that indicates whether text formatting is ignored.

```csharp
public bool IgnoreFormatting { get; set; }
```

##### Property Value

`true` if text formatting is ignored; otherwise, `false`.

### MatchCase
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/matchcase.md

#### PageTextAreaOptions.MatchCase property

Gets the value that indicates whether a text case isn't ignored.

```csharp
public bool MatchCase { get; set; }
```

##### Property Value

`true` if a text case isn't ignored; otherwise, `false`.

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/ocroptions.md

#### PageTextAreaOptions.OcrOptions property

Gets the additional options for OCR functionality.

```csharp
public OcrOptions OcrOptions { get; set; }
```

##### Property Value

An instance of `OcrOptions` class with the additional OCR options.

### PageTextAreaOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/pagetextareaoptions.md

#### PageTextAreaOptions()

Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option.

```csharp
public PageTextAreaOptions()
```

#### PageTextAreaOptions(bool)

Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option.

```csharp
public PageTextAreaOptions(bool useOcr)
```

| Parameter | Type | Description |
| --- | --- | --- |
| useOcr | Boolean | The value that indicates whether OCR functionality is used to extract text areas. |

#### PageTextAreaOptions(bool, OcrOptions)

Initializes a new instance of the `PageTextAreaOptions` class with the ability to set OCR options.

```csharp
public PageTextAreaOptions(bool useOcr, OcrOptions ocrOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| useOcr | Boolean | The value that indicates whether OCR functionality is used to extract text areas. |
| ocrOptions | OcrOptions | The additional options for OCR functionality. |

#### PageTextAreaOptions(string)

Initializes a new instance of the `PageTextAreaOptions` class with the regular expression. Other options are set by default (see remarks for details).

```csharp
public PageTextAreaOptions(string expression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |

##### Remarks

The following properties have default values:

**`MatchCase`**

`false`

**`UniteSegments`**

`false`

**`IgnoreFormatting`**

`false`

**`Rectangle`**

`null`

#### PageTextAreaOptions(string, Rectangle)

Initializes a new instance of the `PageTextAreaOptions` class with the regular expression and rectangular area. Other options are set by default (see remarks for details).

```csharp
public PageTextAreaOptions(string expression, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |
| rectangle | Rectangle | The rectangular area that contains page areas. |

##### Remarks

The following properties have default values:

**`MatchCase`**

`false`

**`UniteSegments`**

`false`

**`IgnoreFormatting`**

`false`

#### PageTextAreaOptions(string, Rectangle, double)

Initializes a new instance of the `PageTextAreaOptions` class with the regular expression, rectangular area and the size of the ignored border. Other options are set by default (see remarks for details).

```csharp
public PageTextAreaOptions(string expression, Rectangle rectangle, double rectangleTolerance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |
| rectangle | Rectangle | The rectangular area that contains page areas. |
| rectangleTolerance | Double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

#### PageTextAreaOptions(string, bool, bool, bool, Rectangle)

Initializes a new instance of the `PageTextAreaOptions` class.

```csharp
public PageTextAreaOptions(string expression, bool matchCase, bool uniteSegments, 
    bool ignoreFormatting, Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| uniteSegments | Boolean | The value that indicates whether segments are united. |
| ignoreFormatting | Boolean | The value that indicates whether text formatting is ignored. |
| rectangle | Rectangle | The rectangular area that contains page areas. |

#### PageTextAreaOptions(string, bool, bool, bool, Rectangle, double)

Initializes a new instance of the `PageTextAreaOptions` class with the size of the ignored border.

```csharp
public PageTextAreaOptions(string expression, bool matchCase, bool uniteSegments, 
    bool ignoreFormatting, Rectangle rectangle, double rectangleTolerance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| uniteSegments | Boolean | The value that indicates whether segments are united. |
| ignoreFormatting | Boolean | The value that indicates whether text formatting is ignored. |
| rectangle | Rectangle | The rectangular area that contains page areas. |
| rectangleTolerance | Double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### UniteSegments
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/unitesegments.md

#### PageTextAreaOptions.UniteSegments property

Gets the value that indicates whether segments are united.

```csharp
public bool UniteSegments { get; set; }
```

##### Property Value

`true` if segments are united; otherwise, `false`.

### UseOcr
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/pagetextareaoptions/useocr.md

#### PageTextAreaOptions.UseOcr property

Gets the value that indicates whether OCR functionality is used to extract text areas.

```csharp
public bool UseOcr { get; set; }
```

##### Property Value

`true` if OCR functionality is used; otherwise, `false`.

### ParseByTemplateOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsebytemplateoptions.md

#### ParseByTemplateOptions class

Provides the options which are used to parse by template.

```csharp
public class ParseByTemplateOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ParseByTemplateOptions() | Initializes a new instance of the `ParseByTemplateOptions` class. |
| ParseByTemplateOptions(int) | Initializes a new instance of the `ParseByTemplateOptions` class. |
| ParseByTemplateOptions(int, bool) | Initializes a new instance of the `ParseByTemplateOptions` class with the OCR usage option. |
| ParseByTemplateOptions(int, bool, OcrOptions) | Initializes a new instance of the `ParseByTemplateOptions` class with the ability to set OCR options. |

#### Properties

| Name | Description |
| --- | --- |
| OcrOptions { get; set; } | Gets the additional options for OCR functionality. |
| PageIndex { get; set; } | Gets or sets index of the page for which to perform a parsing by template. The default value is `0`. |
| UseOcr { get; set; } | Gets the value that indicates whether the OCR Connector is used to parse by template. |

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsebytemplateoptions/ocroptions.md

#### ParseByTemplateOptions.OcrOptions property

Gets the additional options for OCR functionality.

```csharp
public OcrOptions OcrOptions { get; set; }
```

##### Property Value

An instance of `OcrOptions` class with the additional OCR options.

### PageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsebytemplateoptions/pageindex.md

#### ParseByTemplateOptions.PageIndex property

Gets or sets index of the page for which to perform a parsing by template. The default value is `0`.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index.

### ParseByTemplateOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsebytemplateoptions/parsebytemplateoptions.md

#### ParseByTemplateOptions()

Initializes a new instance of the `ParseByTemplateOptions` class.

```csharp
public ParseByTemplateOptions()
```

#### ParseByTemplateOptions(int)

Initializes a new instance of the `ParseByTemplateOptions` class.

```csharp
public ParseByTemplateOptions(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The page index. |

#### ParseByTemplateOptions(int, bool)

Initializes a new instance of the `ParseByTemplateOptions` class with the OCR usage option.

```csharp
public ParseByTemplateOptions(int pageIndex, bool useOcr)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The page index. |
| useOcr | Boolean | The value that indicates whether the OCR functionality is used to parse by template. |

#### ParseByTemplateOptions(int, bool, OcrOptions)

Initializes a new instance of the `ParseByTemplateOptions` class with the ability to set OCR options.

```csharp
public ParseByTemplateOptions(int pageIndex, bool useOcr, OcrOptions ocrOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The page index. |
| useOcr | Boolean | The value that indicates whether the OCR functionality is used to parse by template. |
| ocrOptions | OcrOptions | The additional options for OCR functionality. |

### UseOcr
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsebytemplateoptions/useocr.md

#### ParseByTemplateOptions.UseOcr property

Gets the value that indicates whether the OCR Connector is used to parse by template.

```csharp
public bool UseOcr { get; set; }
```

##### Property Value

`true` if the OCR functionality is used; otherwise, `false`.

### ParserSettings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsersettings.md

#### ParserSettings class

Provides the settings which are used to customize data extraction.

```csharp
public sealed class ParserSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| ParserSettings(ExternalResourceHandler) | Initializes a new instance of the `ParserSettings` class with the External Resource Handler. |
| ParserSettings(ILogger) | Initializes a new instance of the `ParserSettings` class with the logger. |
| ParserSettings(OcrConnectorBase) | Initializes a new instance of the `ParserSettings` class with the OCR Connector. |
| ParserSettings(ILogger, OcrConnectorBase) | Initializes a new instance of the `ParserSettings` class with logger and OCR Connector. |
| ParserSettings(ILogger, OcrConnectorBase, ExternalResourceHandler) | Initializes a new instance of the `ParserSettings` class with logger, OCR Connector and External Resource Handler. |

#### Properties

| Name | Description |
| --- | --- |
| ExternalResourceHandler { get; } | Gets the handler for external resources. |
| Logger { get; } | Gets the logger which is used for logging events and errors during data extraction. |
| OcrConnector { get; } | Gets the OCR Connector which is used to provide OCR functionality. |

##### Remarks

**Learn more:**

* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)

### ExternalResourceHandler
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsersettings/externalresourcehandler.md

#### ParserSettings.ExternalResourceHandler property

Gets the handler for external resources.

```csharp
public ExternalResourceHandler ExternalResourceHandler { get; }
```

##### Property Value

An instance of class that inherits `ExternalResourceHandler` class to provide the control of external resource loading.

### Logger
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsersettings/logger.md

#### ParserSettings.Logger property

Gets the logger which is used for logging events and errors during data extraction.

```csharp
public ILogger Logger { get; }
```

##### Property Value

An instance of class that implements `ILogger` interface.

### OcrConnector
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsersettings/ocrconnector.md

#### ParserSettings.OcrConnector property

Gets the OCR Connector which is used to provide OCR functionality.

```csharp
public OcrConnectorBase OcrConnector { get; }
```

##### Property Value

An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality.

### ParserSettings
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/parsersettings/parsersettings.md

#### ParserSettings(ILogger)

Initializes a new instance of the `ParserSettings` class with the logger.

```csharp
public ParserSettings(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements `ILogger` interface. |

#### ParserSettings(OcrConnectorBase)

Initializes a new instance of the `ParserSettings` class with the OCR Connector.

```csharp
public ParserSettings(OcrConnectorBase ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |

#### ParserSettings(ExternalResourceHandler)

Initializes a new instance of the `ParserSettings` class with the External Resource Handler.

```csharp
public ParserSettings(ExternalResourceHandler externalResourceHandler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| externalResourceHandler | ExternalResourceHandler | An instance of class that inherits `ExternalResourceHandler` class to provide the control of external resources loading. |

#### ParserSettings(ILogger, OcrConnectorBase)

Initializes a new instance of the `ParserSettings` class with logger and OCR Connector.

```csharp
public ParserSettings(ILogger logger, OcrConnectorBase ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements `ILogger` interface. |
| ocrConnector | OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |

#### ParserSettings(ILogger, OcrConnectorBase, ExternalResourceHandler)

Initializes a new instance of the `ParserSettings` class with logger, OCR Connector and External Resource Handler.

```csharp
public ParserSettings(ILogger logger, OcrConnectorBase ocrConnector, 
    ExternalResourceHandler externalResourceHandler)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of class that implements `ILogger` interface. |
| ocrConnector | OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |
| externalResourceHandler | ExternalResourceHandler | An instance of class that inherits `ExternalResourceHandler` class to provide the control of external resource loading. |

### PreviewOptions.PreviewFormats
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions.previewformats.md

#### PreviewOptions.PreviewFormats enumeration

Represents supported preview formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` |  |
| JPEG | `1` |  |
| BMP | `2` |  |

### PreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions.md

#### PreviewOptions class

Provides options to sets requirements and stream delegates for preview generation.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Dpi { get; set; } | Gets or sets a dpi. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| PreviewPageRender { get; set; } | Gets or sets an instance of the page preview render info delegate. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Width { get; set; } | Gets or sets the page preview width. |

### CreatePageStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Gets or sets an instance of the page stream creation delegate.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

### Dpi
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/dpi.md

#### PreviewOptions.Dpi property

Gets or sets a dpi.

```csharp
public int Dpi { get; set; }
```

### Height
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/height.md

#### PreviewOptions.Height property

Gets or sets the page preview height.

```csharp
public int Height { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Gets or sets an array of page numbers to generate previews.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Gets or sets the preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### PreviewPageRender
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/previewpagerender.md

#### PreviewOptions.PreviewPageRender property

Gets or sets an instance of the page preview render info delegate.

```csharp
public PreviewPageRender PreviewPageRender { get; set; }
```

### ReleasePageStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Gets or sets an instance of the page preview completion delegate.

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

### Width
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewoptions/width.md

#### PreviewOptions.Width property

Gets or sets the page preview width.

```csharp
public int Width { get; set; }
```

### PreviewPageRender
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/previewpagerender.md

#### PreviewPageRender delegate

Represents a method which is called before a document page is rendered.

```csharp
public delegate void PreviewPageRender(PageRenderInfo info);
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | PageRenderInfo | The information of how a page is rendered. |

### QualityMode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/qualitymode.md

#### QualityMode enumeration

Defines a level of the quality.

```csharp
public enum QualityMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| High | `0` | Hight quality. Fast processing algorithms are used. |
| Normal | `1` | Normal quality. Default processing algorithms are used. |
| Low | `2` | Low quality. Slow processing algorithms are used. |

### ReleasePageStream
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/releasepagestream.md

#### ReleasePageStream delegate

Represents a method which releases the stream created by the `CreatePageStream` delegate.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a generated page preview. |
| pageStream | Stream | The stream containing the generated page preview. |

### SearchOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions.md

#### SearchOptions class

Provides the options which are used for text search.

```csharp
public sealed class SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SearchOptions() | Initializes a new instance of the `SearchOptions` class with default values. See remarks for details. |
| SearchOptions(bool, bool, bool) | Initializes a new instance of the `SearchOptions` class which is used to search without highlight extraction. |
| SearchOptions(bool, bool, bool, bool) | Initializes a new instance of the `SearchOptions` class which is used to search by pages and without highlight extraction. |
| SearchOptions(bool, bool, bool, HighlightOptions) | Initializes a new instance of the `SearchOptions` class which is used to search with the same highlight options for the left and the right highlight extraction. |
| SearchOptions(bool, bool, bool, HighlightOptions, HighlightOptions) | Initializes a new instance of the `SearchOptions` class which is used to search with the highlight options for the left and the right highlight extraction. |
| SearchOptions(bool, bool, bool, bool, HighlightOptions, HighlightOptions) | Initializes a new instance of the `SearchOptions` class. |
| SearchOptions(bool, bool, bool, int, HighlightOptions, HighlightOptions) | Initializes a new instance of the `SearchOptions` class with the page limit. |

#### Properties

| Name | Description |
| --- | --- |
| LeftHighlightOptions { get; set; } | Gets the options for the left highlight. |
| MatchCase { get; set; } | Gets the value that indicates whether a text case isn't ignored. |
| MatchWholeWord { get; set; } | Gets the value that indicates whether text search is limited by a whole word. |
| MaxPageIndex { get; set; } | Gets the value that represents the max index of the page to search. |
| RightHighlightOptions { get; set; } | Gets the options for the right highlight. |
| SearchByPages { get; set; } | Gets the value that indicates whether the search is performed by pages. |
| UseRegularExpression { get; set; } | Gets the value that indicates whether a regular expression is used. |

##### Remarks

An instance of `SearchOptions` class is used as parameter in `Search` method. See the usage examples there.

**Learn more:**

* [Search text](https://docs.groupdocs.com/display/parsernet/Search+text)
* [Search text in Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Word+documents)
* [Search text in Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Excel+spreadsheets)
* [Search text in Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+PowerPoint+presentations)
* [Search text in PDF documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+PDF+documents)
* [Search text in Emails](https://docs.groupdocs.com/display/parsernet/Search+text+in+Emails)
* [Search text in EPUB eBooks](https://docs.groupdocs.com/display/parsernet/Search+text+in+EPUB+eBooks)
* [Search text in HTML documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+HTML+documents)
* [Search text in Microsoft OneNote sections](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+OneNote+sections)

### LeftHighlightOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/lefthighlightoptions.md

#### SearchOptions.LeftHighlightOptions property

Gets the options for the left highlight.

```csharp
public HighlightOptions LeftHighlightOptions { get; set; }
```

##### Property Value

An instance of `HighlightOptions` class; `null` if it isn't set.

### MatchCase
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/matchcase.md

#### SearchOptions.MatchCase property

Gets the value that indicates whether a text case isn't ignored.

```csharp
public bool MatchCase { get; set; }
```

##### Property Value

`true` if a text case isn't ignored; otherwise, `false`.

### MatchWholeWord
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/matchwholeword.md

#### SearchOptions.MatchWholeWord property

Gets the value that indicates whether text search is limited by a whole word.

```csharp
public bool MatchWholeWord { get; set; }
```

##### Property Value

`true` if text search is limited by a whole word; otherwise, `false`.

### MaxPageIndex
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/maxpageindex.md

#### SearchOptions.MaxPageIndex property

Gets the value that represents the max index of the page to search.

```csharp
public int MaxPageIndex { get; set; }
```

##### Property Value

An integer value that represents the max index of the page to search; -1 if not set;

### RightHighlightOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/righthighlightoptions.md

#### SearchOptions.RightHighlightOptions property

Gets the options for the right highlight.

```csharp
public HighlightOptions RightHighlightOptions { get; set; }
```

##### Property Value

An instance of `HighlightOptions` class; `null` if it isn't set.

### SearchByPages
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/searchbypages.md

#### SearchOptions.SearchByPages property

Gets the value that indicates whether the search is performed by pages.

```csharp
public bool SearchByPages { get; set; }
```

##### Property Value

`true` if the search is performed by pages; otherwise, `false` and the search is performed on the whole document without including `PageIndex` property value in `SearchResult` class.

### SearchOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/searchoptions.md

#### SearchOptions(bool, bool, bool, bool, HighlightOptions, HighlightOptions)

Initializes a new instance of the `SearchOptions` class.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression, 
    bool searchByPages, HighlightOptions leftHighlightOptions, 
    HighlightOptions rightHighlightOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |
| searchByPages | Boolean | The value that indicates whether the search is performed by pages. |
| leftHighlightOptions | HighlightOptions | The options for the left highlight. |
| rightHighlightOptions | HighlightOptions | The options for the right highlight. |

#### SearchOptions(bool, bool, bool, int, HighlightOptions, HighlightOptions)

Initializes a new instance of the `SearchOptions` class with the page limit.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression, 
    int maxPageIndex, HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |
| maxPageIndex | Int32 | he value that indicates whether the search is performed by pages. |
| leftHighlightOptions | HighlightOptions | The options for the left highlight. |
| rightHighlightOptions | HighlightOptions | The options for the right highlight. |

#### SearchOptions(bool, bool, bool, HighlightOptions, HighlightOptions)

Initializes a new instance of the `SearchOptions` class which is used to search with the highlight options for the left and the right highlight extraction.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression, 
    HighlightOptions leftHighlightOptions, HighlightOptions rightHighlightOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |
| leftHighlightOptions | HighlightOptions | The options for the left highlight. |
| rightHighlightOptions | HighlightOptions | The options for the right highlight. |

#### SearchOptions(bool, bool, bool, HighlightOptions)

Initializes a new instance of the `SearchOptions` class which is used to search with the same highlight options for the left and the right highlight extraction.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression, 
    HighlightOptions highlightOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |
| highlightOptions | HighlightOptions | The options for both highlights. |

#### SearchOptions(bool, bool, bool)

Initializes a new instance of the `SearchOptions` class which is used to search without highlight extraction.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |

#### SearchOptions(bool, bool, bool, bool)

Initializes a new instance of the `SearchOptions` class which is used to search by pages and without highlight extraction.

```csharp
public SearchOptions(bool matchCase, bool matchWholeWord, bool useRegularExpression, 
    bool searchByPages)
```

| Parameter | Type | Description |
| --- | --- | --- |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |
| matchWholeWord | Boolean | The value that indicates whether text search is limited by a whole word. |
| useRegularExpression | Boolean | The value that indicates whether a regular expression is used. |
| searchByPages | Boolean | The value that indicates whether the search is performed by pages. |

#### SearchOptions()

Initializes a new instance of the `SearchOptions` class with default values. See remarks for details.

```csharp
public SearchOptions()
```

##### Remarks

The following properties have default values:

**`MatchCase`**

`false`

**`MatchWholeWord`**

`false`

**`UseRegularExpression`**

`false`

**`LeftHighlightOptions`**

`null`

**`RightHighlightOptions`**

`null`

### UseRegularExpression
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/searchoptions/useregularexpression.md

#### SearchOptions.UseRegularExpression property

Gets the value that indicates whether a regular expression is used.

```csharp
public bool UseRegularExpression { get; set; }
```

##### Property Value

`true` if a regular expression is used; otherwise, `false`.

### TextDocumentInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textdocumentinfo.md

#### TextDocumentInfo class

Represents the text document information.

```csharp
public class TextDocumentInfo : DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Encoding { get; } | Gets the detected encoding of the text document. |
| FileType { get; } | Gets the document type. |
| PageCount { get; } | Gets the total number of document pages. |
| Pages { get; } | Gets the information about pages such as the index and page size. |
| RawPageCount { get; } | Gets the total number of document raw pages. |
| Size { get; } | Gets the size of the document in bytes. |

##### Remarks

**Learn more:**

* [Get document info](https://docs.groupdocs.com/display/parsernet/Get+document+info)
* [Detect encoding](https://docs.groupdocs.com/display/parsernet/Detect+encoding)

### Encoding
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textdocumentinfo/encoding.md

#### TextDocumentInfo.Encoding property

Gets the detected encoding of the text document.

```csharp
public Encoding Encoding { get; }
```

##### Property Value

An instance of Encoding class.

### TextOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textoptions.md

#### TextOptions class

Provides the options which are used for text extraction.

```csharp
public sealed class TextOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextOptions() | Initializes a new instance of the `TextOptions` class. |
| TextOptions(bool) | Initializes a new instance of the `TextOptions` class. |
| TextOptions(bool, bool) | Initializes a new instance of the `TextOptions` class with the OCR usage option. |
| TextOptions(bool, bool, OcrOptions) | Initializes a new instance of the `TextOptions` class with the ability to set OCR options. |

#### Properties

| Name | Description |
| --- | --- |
| OcrOptions { get; set; } | Gets the additional options for OCR functionality. |
| UseOcr { get; set; } | Gets the value that indicates whether the OCR Connector is used to extract a text. |
| UseRawModeIfPossible { get; set; } | Gets the value that indicates whether the raw mode is used. |

##### Remarks

An instance of `TextOptions` class is used as parameter in `GetText` and `GetText` methods. See the usage examples there.

It's used to specify the raw mode of text extraction. A text in this mode is extracted in a non-accurate way but faster than in the standard mode. If the raw mode doesn't support the document format, then this parameter is ignored and the standard mode is used.

**Learn more:**

* [Extract text in Accurate mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Accurate+mode)
* [Extract text in Raw mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Raw+mode)

### OcrOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textoptions/ocroptions.md

#### TextOptions.OcrOptions property

Gets the additional options for OCR functionality.

```csharp
public OcrOptions OcrOptions { get; set; }
```

##### Property Value

An instance of `OcrOptions` class with the additional OCR options.

### TextOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textoptions/textoptions.md

#### TextOptions()

Initializes a new instance of the `TextOptions` class.

```csharp
public TextOptions()
```

#### TextOptions(bool)

Initializes a new instance of the `TextOptions` class.

```csharp
public TextOptions(bool useRawModeIfPossible)
```

| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | Boolean | The value that indicates whether the raw mode is used. |

#### TextOptions(bool, bool)

Initializes a new instance of the `TextOptions` class with the OCR usage option.

```csharp
public TextOptions(bool useRawModeIfPossible, bool useOcr)
```

| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | Boolean | The value that indicates whether the raw mode is used. |
| useOcr | Boolean | The value that indicates whether the OCR functionality is used to extract a text. |

#### TextOptions(bool, bool, OcrOptions)

Initializes a new instance of the `TextOptions` class with the ability to set OCR options.

```csharp
public TextOptions(bool useRawModeIfPossible, bool useOcr, OcrOptions ocrOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| useRawModeIfPossible | Boolean | The value that indicates whether the raw mode is used. |
| useOcr | Boolean | The value that indicates whether the OCR functionality is used to extract a text. |
| ocrOptions | OcrOptions | The additional options for OCR functionality. |

### UseOcr
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textoptions/useocr.md

#### TextOptions.UseOcr property

Gets the value that indicates whether the OCR Connector is used to extract a text.

```csharp
public bool UseOcr { get; set; }
```

##### Property Value

`true` if the OCR functionality is used; otherwise, `false`.

### UseRawModeIfPossible
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/textoptions/userawmodeifpossible.md

#### TextOptions.UseRawModeIfPossible property

Gets the value that indicates whether the raw mode is used.

```csharp
public bool UseRawModeIfPossible { get; set; }
```

##### Property Value

`true` if the raw mode is used; otherwise, `false`.

### WorksheetOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/worksheetoptions.md

#### WorksheetOptions class

Provides the options which are used for the worksheet extraction.

```csharp
public sealed class WorksheetOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WorksheetOptions(params WorksheetRange[]) | Initializes a new instance of the `WorksheetOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Ranges { get; } | Get a list of ranges. |

### Ranges
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/worksheetoptions/ranges.md

#### WorksheetOptions.Ranges property

Get a list of ranges.

```csharp
public IList<WorksheetRange> Ranges { get; }
```

##### Property Value

A list of instances of `WorksheetRange` class that limits the range to extract cells.

### WorksheetOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.options/worksheetoptions/worksheetoptions.md

#### WorksheetOptions constructor

Initializes a new instance of the `WorksheetOptions` class.

```csharp
public WorksheetOptions(params WorksheetRange[] ranges)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ranges | WorksheetRange[] | The collection of ranges. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | The range collection or any of its elements cannot be null. |

### GroupDocs.Parser.Templates
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates.md

The namespace provides classes for creating templates for parsing document data.

#### Classes

| Class | Description |
| --- | --- |
| Template | Provides the document page template. It consists of `TemplateItem` objects which represent the items of the template such as text field and table definitions. |
| TemplateBarcode | Provides the template barcode field. |
| TemplateCollection | Represents a collection of document parsing templates. |
| TemplateField | Provides the template text field. |
| TemplateFixedPosition | Provides a template field position which is defined by the rectangular area. |
| TemplateItem | Provides a base abstract class for template items. |
| TemplateLinkedPosition | Provides a template field position which uses the linked field. |
| TemplateLinkedPositionEdges | Provides the edges of the linked field where the text field is seached. `TemplateLinkedPositionEdges` is used in `TemplateLinkedPosition` class. |
| TemplateOptions | Provides the options which are used for parsing by template functionality. |
| TemplatePosition | Provides a base abstract class for template positions. |
| TemplateRegexPosition | Provides a template field position which uses the regular expression. |
| TemplateTable | Provides the template table. |
| TemplateTableLayout | Provides the template table layout which is used by `TemplateTable` class to define table position. |
| TemplateTableParameters | Provides parameters for the table detection algorithms. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### Template
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template.md

#### Template class

Provides the document page template. It consists of `TemplateItem` objects which represent the items of the template such as text field and table definitions.

```csharp
public sealed class Template : IEnumerable<TemplateItem>
```

#### Constructors

| Name | Description |
| --- | --- |
| Template(IEnumerable&lt;TemplateItem&gt;) | Initializes a new instance of the `Template` class. |
| Template(IEnumerable&lt;TemplateItem&gt;, TemplateOptions) | Initializes a new instance of the `Template` class with template options. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the total number of template items. |
| IsOcrCompatible { get; } | Gets the value that indicates whether the template is compatible with OCR. |
| Item { get; } | Gets the template item by an index. |
| Options { get; } | Gets the template options. |

#### Methods

| Name | Description |
| --- | --- |
| static Load(Stream) | Loads a template from a stream. |
| static Load(string) | Loads a template from a file. |
| GetEnumerator() | Returns an enumerator for template items. |
| Save(Stream) | Saves a template to a stream. |
| Save(string) | Saves a template to a file. |

##### Remarks

**Learn more:**

* [Working with templates](https://docs.groupdocs.com/display/parsernet/Working+with+templates)

### Count
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/count.md

#### Template.Count property

Gets the total number of template items.

```csharp
public int Count { get; }
```

##### Property Value

An integer that represents the total number of template items.

### GetEnumerator
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/getenumerator.md

#### Template.GetEnumerator method

Returns an enumerator for template items.

```csharp
public IEnumerator<TemplateItem> GetEnumerator()
```

##### Return Value

An enumerator for template items.

### IsOcrCompatible
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/isocrcompatible.md

#### Template.IsOcrCompatible property

Gets the value that indicates whether the template is compatible with OCR.

```csharp
public bool IsOcrCompatible { get; }
```

##### Property Value

`true` if the template is compatible with OCR; otherwise, `false`.

### Item
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/item.md

#### Template indexer

Gets the template item by an index.

```csharp
public TemplateItem this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the template item. |

##### Return Value

An instance of `TemplateItem` class.

### Load
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/load.md

#### Load(string)

Loads a template from a file.

```csharp
public static Template Load(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |

##### Return Value

An instance of `Template` class with loaded template.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsParserException | The file does not represent the template in a valid format. |

#### Load(Stream)

Loads a template from a stream.

```csharp
public static Template Load(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The input stream. |

##### Return Value

An instance of `Template` class with loaded template.

##### Exceptions

| exception | condition |
| --- | --- |
| GroupDocsParserException | The stream does not represent the template in a valid format. |

### Options
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/options.md

#### Template.Options property

Gets the template options.

```csharp
public TemplateOptions Options { get; }
```

##### Return Value

An instance of `TemplateOptions` class.

### Save
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/save.md

#### Save(string)

Saves a template to a file.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |

#### Save(Stream)

Saves a template to a stream.

```csharp
public void Save(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The output stream. |

### Template
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/template/template.md

#### Template(IEnumerable&lt;TemplateItem&gt;)

Initializes a new instance of the `Template` class.

```csharp
public Template(IEnumerable<TemplateItem> items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| items | IEnumerable`1 | The collection of `TemplateItem` objects. |

##### Examples

Usage:

```csharp
// Create an array of template fields
TemplateItem[] fields = new TemplateItem[]
{
   new TemplateField(new TemplateRegexPosition("From"), "From", 0),
   new TemplateField(
       new TemplateLinkedPosition("From", new Size(100, 10), new TemplateLinkedPositionEdges(false, false, false, true)),
       "FromCompany",
       0),
   new TemplateField(
       new TemplateLinkedPosition("FromCompany", new Size(100, 30), new TemplateLinkedPositionEdges(false, false, false, true)),
       "FromAddress",
       0)
};

// Create a document template
Template template = new Template(fields);
```

#### Template(IEnumerable&lt;TemplateItem&gt;, TemplateOptions)

Initializes a new instance of the `Template` class with template options.

```csharp
public Template(IEnumerable<TemplateItem> items, TemplateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| items | IEnumerable`1 | The collection of `TemplateItem` objects. |
| options | TemplateOptions | The template options. |

### TemplateBarcode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatebarcode.md

#### TemplateBarcode class

Provides the template barcode field.

```csharp
public sealed class TemplateBarcode : TemplateItem
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateBarcode(Rectangle, string) | Initializes a new instance of the `TemplateBarcode` class. |
| TemplateBarcode(Rectangle, string, double?) | Initializes a new instance of the `TemplateBarcode` class. |
| TemplateBarcode(Rectangle, string, double?, bool) | Initializes a new instance of the `TemplateBarcode` class. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Gets the name of the template item. |
| PageWidth { get; } | Gets the width of the page that was used to create the template item. |
| Rectangle { get; } | Gets the rectangular area that contains the template barcode field. |
| UseUpperCaseName { get; } | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

#### Methods

| Name | Description |
| --- | --- |
| override Scale(double) | Scales this template item by a given factor. |

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatebarcode/rectangle.md

#### TemplateBarcode.Rectangle property

Gets the rectangular area that contains the template barcode field.

```csharp
public Rectangle Rectangle { get; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains the template barcode field.

### Scale
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatebarcode/scale.md

#### TemplateBarcode.Scale method

Scales this template item by a given factor.

```csharp
public override TemplateItem Scale(double factor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| factor | Double | The scale factor. |

##### Return Value

A new template item scaled by the given factor.

### TemplateBarcode
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatebarcode/templatebarcode.md

#### TemplateBarcode(Rectangle, string)

Initializes a new instance of the `TemplateBarcode` class.

```csharp
public TemplateBarcode(Rectangle rectangle, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field. |
| name | String | The barcode field name. |

#### TemplateBarcode(Rectangle, string, double?)

Initializes a new instance of the `TemplateBarcode` class.

```csharp
public TemplateBarcode(Rectangle rectangle, string name, double? pageWidth)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field. |
| name | String | The barcode field name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |

#### TemplateBarcode(Rectangle, string, double?, bool)

Initializes a new instance of the `TemplateBarcode` class.

```csharp
public TemplateBarcode(Rectangle rectangle, string name, double? pageWidth, bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template barcode field. |
| name | String | The barcode field name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

### TemplateCollection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection.md

#### TemplateCollection class

Represents a collection of document parsing templates.

```csharp
public class TemplateCollection : IEnumerable<Template>
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateCollection() | Initializes a new instance of the `TemplateCollection` class. |
| TemplateCollection(IEnumerable&lt;Template&gt;) | Initializes a new instance of the `TemplateCollection` class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of templates contained in the `TemplateCollection`. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Template) | Adds a template to the end of the `TemplateCollection`. |
| Clear() | Removes all elements from the `TemplateCollection`. |
| Get(int) | Gets the template at the specified index. |
| GetEnumerator() | Returns an enumerator that iterates through the `TemplateCollection`. |
| Remove(Template) | Removes the first occurrence of a specific template from the `TemplateCollection`. |
| RemoveAt(int) | Removes the template at the specified index of the `TemplateCollection`. |

### Add
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/add.md

#### TemplateCollection.Add method

Adds a template to the end of the `TemplateCollection`.

```csharp
public void Add(Template template)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template to be added to the end of the `TemplateCollection`. |

### Clear
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/clear.md

#### TemplateCollection.Clear method

Removes all elements from the `TemplateCollection`.

```csharp
public void Clear()
```

### Count
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/count.md

#### TemplateCollection.Count property

Gets the number of templates contained in the `TemplateCollection`.

```csharp
public int Count { get; }
```

##### Property Value

The number of templates contained in the `TemplateCollection`.

### Get
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/get.md

#### TemplateCollection.Get method

Gets the template at the specified index.

```csharp
public Template Get(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index of the template to get. |

##### Return Value

The template at the specified index.

### GetEnumerator
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/getenumerator.md

#### TemplateCollection.GetEnumerator method

Returns an enumerator that iterates through the `TemplateCollection`.

```csharp
public IEnumerator<Template> GetEnumerator()
```

##### Return Value

An enumerator for this `TemplateCollection`.

### Remove
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/remove.md

#### TemplateCollection.Remove method

Removes the first occurrence of a specific template from the `TemplateCollection`.

```csharp
public bool Remove(Template template)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The template to remove from the `TemplateCollection`. |

##### Return Value

`true` if template is successfully removed; otherwise, `false`.

### RemoveAt
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/removeat.md

#### TemplateCollection.RemoveAt method

Removes the template at the specified index of the `TemplateCollection`.

```csharp
public void RemoveAt(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index of the element to remove. |

### TemplateCollection
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatecollection/templatecollection.md

#### TemplateCollection()

Initializes a new instance of the `TemplateCollection` class.

```csharp
public TemplateCollection()
```

#### TemplateCollection(IEnumerable&lt;Template&gt;)

Initializes a new instance of the `TemplateCollection` class.

```csharp
public TemplateCollection(IEnumerable<Template> templates)
```

| Parameter | Type | Description |
| --- | --- | --- |
| templates | IEnumerable`1 | The collection whose elements are copied to the new collection. |

### TemplateField
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield.md

#### TemplateField class

Provides the template text field.

```csharp
public sealed class TemplateField : TemplateItem
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateField(TemplatePosition, string) | Initializes a new instance of the `TemplateField` class. |
| TemplateField(TemplatePosition, string, double?) | Initializes a new instance of the `TemplateField` class. |
| TemplateField(TemplatePosition, string, double?, bool) | Initializes a new instance of the `TemplateField` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsHidden { get; set; } | Gets or sets the hidden template field flag. |
| Name { get; } | Gets the name of the template item. |
| PageWidth { get; } | Gets the width of the page that was used to create the template item. |
| Position { get; } | Gets the value that describes how to find the template field on the document page. |
| UseUpperCaseName { get; } | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |
| Value { get; set; } | Gets or sets the value of the template field. |

#### Methods

| Name | Description |
| --- | --- |
| override Scale(double) | Scales this template item by a given factor. |

##### Remarks

Text fields are defined by its position on the page. There are three ways to define a text field:

* `Using the rectangular area`
* `Using the regular expression`
* `Using the linked field`

### IsHidden
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield/ishidden.md

#### TemplateField.IsHidden property

Gets or sets the hidden template field flag.

```csharp
public bool IsHidden { get; set; }
```

##### Property Value

The hidden field flag.

### Position
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield/position.md

#### TemplateField.Position property

Gets the value that describes how to find the template field on the document page.

```csharp
public TemplatePosition Position { get; }
```

##### Property Value

An instance of `TemplatePosition` descendant class.

### Scale
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield/scale.md

#### TemplateField.Scale method

Scales this template item by a given factor.

```csharp
public override TemplateItem Scale(double factor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| factor | Double | The scale factor. |

##### Return Value

A new template item scaled by the given factor.

### TemplateField
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield/templatefield.md

#### TemplateField(TemplatePosition, string)

Initializes a new instance of the `TemplateField` class.

```csharp
public TemplateField(TemplatePosition position, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position. |
| name | String | The field name. |

#### TemplateField(TemplatePosition, string, double?)

Initializes a new instance of the `TemplateField` class.

```csharp
public TemplateField(TemplatePosition position, string name, double? pageWidth)
```

| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position. |
| name | String | The field name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |

#### TemplateField(TemplatePosition, string, double?, bool)

Initializes a new instance of the `TemplateField` class.

```csharp
public TemplateField(TemplatePosition position, string name, double? pageWidth, 
    bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| position | TemplatePosition | The field position. |
| name | String | The field name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

### Value
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefield/value.md

#### TemplateField.Value property

Gets or sets the value of the template field.

```csharp
public string Value { get; set; }
```

##### Property Value

The value of the template field.

### TemplateFixedPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefixedposition.md

#### TemplateFixedPosition class

Provides a template field position which is defined by the rectangular area.

```csharp
public sealed class TemplateFixedPosition : TemplatePosition
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateFixedPosition(Rectangle) | Initializes a new instance of the `TemplateFixedPosition` class. |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; } | Gets the rectangular area that contains the template field. |

##### Examples

This is simplest way to define the field position. It requires to set a rectangular area on the page that bounds the field value. All the text that is contained (even partially) into the rectangular area will be extracted as a value:

```csharp
// Create a fixed template field with "Address" name which is bounded by a rectangle at the position (35, 160) and with the size (110, 20)
TemplateField templateField = new TemplateField(
    new TemplateFixedPosition(new Rectangle(new Point(35, 160), new Size(110, 20))),
    "Address");
```

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefixedposition/rectangle.md

#### TemplateFixedPosition.Rectangle property

Gets the rectangular area that contains the template field.

```csharp
public Rectangle Rectangle { get; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains the template field.

### TemplateFixedPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatefixedposition/templatefixedposition.md

#### TemplateFixedPosition constructor

Initializes a new instance of the `TemplateFixedPosition` class.

```csharp
public TemplateFixedPosition(Rectangle rectangle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the template field. |

### TemplateItem
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateitem.md

#### TemplateItem class

Provides a base abstract class for template items.

```csharp
public abstract class TemplateItem
```

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Gets the name of the template item. |
| PageWidth { get; } | Gets the width of the page that was used to create the template item. |
| UseUpperCaseName { get; } | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

#### Methods

| Name | Description |
| --- | --- |
| abstract Scale(double) | Scales this template item by a given factor. |

##### Remarks

The inheritors of `TemplateItem` class are used in `Template` collection.

### Name
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateitem/name.md

#### TemplateItem.Name property

Gets the name of the template item.

```csharp
public string Name { get; }
```

##### Property Value

An uppercase string value that represents a name of the template item.

### PageWidth
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateitem/pagewidth.md

#### TemplateItem.PageWidth property

Gets the width of the page that was used to create the template item.

```csharp
public double? PageWidth { get; }
```

##### Property Value

The width of the page in pixels; `null` if the page width is unknown.

### Scale
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateitem/scale.md

#### TemplateItem.Scale method

Scales this template item by a given factor.

```csharp
public abstract TemplateItem Scale(double factor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| factor | Double | The scale factor. |

##### Return Value

A new template item scaled by the given factor.

### UseUpperCaseName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateitem/useuppercasename.md

#### TemplateItem.UseUpperCaseName property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

```csharp
public bool UseUpperCaseName { get; }
```

##### Property Value

A boolean value that indicates whether a `Name` was converted to UPPER CASE.

### TemplateLinkedPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition.md

#### TemplateLinkedPosition class

Provides a template field position which uses the linked field.

```csharp
public sealed class TemplateLinkedPosition : TemplatePosition
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges) | Initializes a new instance of the `TemplateLinkedPosition` class. |
| TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges, bool) | Initializes a new instance of the `TemplateLinkedPosition` class with UPPER CASE linked field name. |
| TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges, bool, bool) | Initializes a new instance of the `TemplateLinkedPosition` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoScale { get; } | Gets the value that indicates whether `SearchArea` is scaled by the linked field size. |
| Edges { get; } | Gets the edges of the linked field where a field is searched. |
| LinkedFieldName { get; } | Gets the linked field name. |
| SearchArea { get; } | Gets the size of the area where a field is searched. |

##### Examples

The following example shows the code for the situation if it's known that the field with an invoice number is placed on the right of "Invoice number" string the following code is used:

```csharp
// Create a regex template field to find "Invoice Number" text
TemplateField invoice = new TemplateField(new TemplateRegexPosition("Invoice Number"), "Invoice");

// Create a related template field associated with "Invoice" field and extract the value on the right of it
TemplateField invoiceNumber = new TemplateField(
    new TemplateLinkedPosition("invoice", new Size(100, 15), new TemplateLinkedPositionEdges(false, false, true, false)),
    "InvoiceNumber");
```

### AutoScale
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition/autoscale.md

#### TemplateLinkedPosition.AutoScale property

Gets the value that indicates whether `SearchArea` is scaled by the linked field size.

```csharp
public bool AutoScale { get; }
```

##### Property Value

`true` if `SearchArea` is scaled by the linked field size; otherwise, `false`

### Edges
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition/edges.md

#### TemplateLinkedPosition.Edges property

Gets the edges of the linked field where a field is searched.

```csharp
public TemplateLinkedPositionEdges Edges { get; }
```

##### Property Value

An instance of `TemplateLinkedPositionEdges` class that represents the edges of the linked field where a field is searched.

### LinkedFieldName
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition/linkedfieldname.md

#### TemplateLinkedPosition.LinkedFieldName property

Gets the linked field name.

```csharp
public string LinkedFieldName { get; }
```

##### Property Value

An uppercase string value that represents the linked field name.

### SearchArea
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition/searcharea.md

#### TemplateLinkedPosition.SearchArea property

Gets the size of the area where a field is searched.

```csharp
public Size SearchArea { get; }
```

##### Property Value

An instance of `Size` class that represents the size of the area where a field is searched.

### TemplateLinkedPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedposition/templatelinkedposition.md

#### TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges)

Initializes a new instance of the `TemplateLinkedPosition` class.

```csharp
public TemplateLinkedPosition(string linkedFieldName, Size searchArea, 
    TemplateLinkedPositionEdges edges)
```

| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | String | The name of the linked field. |
| searchArea | Size | The size of the area where a field is searched. |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |

#### TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges, bool)

Initializes a new instance of the `TemplateLinkedPosition` class with UPPER CASE linked field name.

```csharp
public TemplateLinkedPosition(string linkedFieldName, Size searchArea, 
    TemplateLinkedPositionEdges edges, bool autoScale)
```

| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | String | The name of the linked field. |
| searchArea | Size | The size of the area where a field is searched. |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |
| autoScale | Boolean | The value that indicates whether *searchArea* is scaled by the linked field size. |

#### TemplateLinkedPosition(string, Size, TemplateLinkedPositionEdges, bool, bool)

Initializes a new instance of the `TemplateLinkedPosition` class.

```csharp
public TemplateLinkedPosition(string linkedFieldName, Size searchArea, 
    TemplateLinkedPositionEdges edges, bool autoScale, bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| linkedFieldName | String | The name of the linked field. |
| searchArea | Size | The size of the area where a field is searched. |
| edges | TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |
| autoScale | Boolean | The value that indicates whether *searchArea* is scaled by the linked field size. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

### TemplateLinkedPositionEdges
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges.md

#### TemplateLinkedPositionEdges class

Provides the edges of the linked field where the text field is seached. `TemplateLinkedPositionEdges` is used in `TemplateLinkedPosition` class.

```csharp
public sealed class TemplateLinkedPositionEdges
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateLinkedPositionEdges(bool, bool, bool, bool) | Initializes a new instance of the `TemplateLinkedPositionEdges` class. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; } | Gets the value that indicates whether a field is searched by the bottom from the linked field. |
| IsEmpty { get; } | Gets the value that indicates whether the instance is empty. |
| Left { get; } | Gets the value that indicates whether a field is searched by the left from the linked field. |
| Right { get; } | Gets the value that indicates whether a field is searched by the right from the linked field. |
| Top { get; } | Gets the value that indicates whether a field is searched by the top from the linked field. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Converts the string representation of edges to its class equivalent. |
| override ToString() | Converts the value of this instance to String. |
| static TryParse(string, out TemplateLinkedPositionEdges) | Converts the string representation of edges to its class equivalent. A return value indicates whether the conversion is succeeded or failed. |

### Bottom
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/bottom.md

#### TemplateLinkedPositionEdges.Bottom property

Gets the value that indicates whether a field is searched by the bottom from the linked field.

```csharp
public bool Bottom { get; }
```

##### Property Value

`true` if a field is searched by the bottom from the linked field; otherwise, `false`.

### IsEmpty
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/isempty.md

#### TemplateLinkedPositionEdges.IsEmpty property

Gets the value that indicates whether the instance is empty.

```csharp
public bool IsEmpty { get; }
```

##### Property Value

`true` if the instance is empty (all fields are `false`); otherwise, `false`.

### Left
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/left.md

#### TemplateLinkedPositionEdges.Left property

Gets the value that indicates whether a field is searched by the left from the linked field.

```csharp
public bool Left { get; }
```

##### Property Value

`true` if a field is searched by the left from the linked field; otherwise, `false`.

### Parse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/parse.md

#### TemplateLinkedPositionEdges.Parse method

Converts the string representation of edges to its class equivalent.

```csharp
public static TemplateLinkedPositionEdges Parse(string s)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string that contains edges to convert. |

##### Return Value

An instance of `TemplateLinkedPositionEdges` class that is equivalent to the value specified in *s* parameter.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | *s* does not represent edges in a valid format. |

### Right
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/right.md

#### TemplateLinkedPositionEdges.Right property

Gets the value that indicates whether a field is searched by the right from the linked field.

```csharp
public bool Right { get; }
```

##### Property Value

`true` if a field is searched by the right from the linked field; otherwise, `false`.

### TemplateLinkedPositionEdges
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/templatelinkedpositionedges.md

#### TemplateLinkedPositionEdges constructor

Initializes a new instance of the `TemplateLinkedPositionEdges` class.

```csharp
public TemplateLinkedPositionEdges(bool left, bool top, bool right, bool bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Boolean | The value that indicates whether a field is searched by the left from the linked field. |
| top | Boolean | The value that indicates whether a field is searched by the top from the linked field. |
| right | Boolean | The value that indicates whether a field is searched by the right from the linked field. |
| bottom | Boolean | The value that indicates whether a field is searched by the bottom from the linked field. |

### Top
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/top.md

#### TemplateLinkedPositionEdges.Top property

Gets the value that indicates whether a field is searched by the top from the linked field.

```csharp
public bool Top { get; }
```

##### Property Value

`true` if a field is searched by the top from the linked field; otherwise, `false`.

### ToString
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/tostring.md

#### TemplateLinkedPositionEdges.ToString method

Converts the value of this instance to String.

```csharp
public override string ToString()
```

##### Return Value

A string whose value is the same as this instance.

### TryParse
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatelinkedpositionedges/tryparse.md

#### TemplateLinkedPositionEdges.TryParse method

Converts the string representation of edges to its class equivalent. A return value indicates whether the conversion is succeeded or failed.

```csharp
public static bool TryParse(string s, out TemplateLinkedPositionEdges edges)
```

| Parameter | Type | Description |
| --- | --- | --- |
| s | String | A string containing edges to convert. |
| edges | TemplateLinkedPositionEdges& | When the method returns, it contains the instance of `TemplateLinkedPositionEdges` class that is equivalent to the value specified in *s* parameter, if the conversion is succeeded; otherwise, `null`. |

##### Return Value

`true` if *s* is converted successfully; otherwise, `false`.

### TemplateOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateoptions.md

#### TemplateOptions class

Provides the options which are used for parsing by template functionality.

```csharp
public sealed class TemplateOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateOptions(double) | Initializes a new instance of the `TemplateOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| RectangleTolerance { get; } | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### RectangleTolerance
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateoptions/rectangletolerance.md

#### TemplateOptions.RectangleTolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

```csharp
public double RectangleTolerance { get; }
```

##### Return Value

The double value from 0 (no border) to 1 (ignore the whole element).

### TemplateOptions
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateoptions/templateoptions.md

#### TemplateOptions constructor

Initializes a new instance of the `TemplateOptions` class.

```csharp
public TemplateOptions(double rectangleTolerance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangleTolerance | Double | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### TemplatePosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateposition.md

#### TemplatePosition class

Provides a base abstract class for template positions.

```csharp
public abstract class TemplatePosition
```

### TemplateRegexPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateregexposition.md

#### TemplateRegexPosition class

Provides a template field position which uses the regular expression.

```csharp
public sealed class TemplateRegexPosition : TemplatePosition
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateRegexPosition(string) | Initializes a new instance of the `TemplateRegexPosition` class. |
| TemplateRegexPosition(string, bool) | Initializes a new instance of the `TemplateRegexPosition` class. |

#### Properties

| Name | Description |
| --- | --- |
| Expression { get; } | Gets the regular expression. |
| MatchCase { get; } | Gets the value that indicates whether a text case isn't ignored. |

##### Examples

The following example shows the situation if the document contains "Invoice Number INV-12345" then template field can be defined in the following way:

```csharp
// Create a regex template field with "InvoiceNumber" name
TemplateField templateField = new TemplateField(
    new TemplateRegexPosition("Invoice Number\\s+[A-Z0-9\\-]+"),
    "InvoiceNumber");
```

In this case as a value the entire string is extracted. To extract only a part of the string the regular expression group "value" is used:

```csharp
// Create a regex template field with "InvoiceNumber" name with "value" group
TemplateField templateField = new TemplateField(
    new TemplateRegexPosition("Invoice Number\\s+(?<value>[A-Z0-9\\-]+)"),
    "InvoiceNumber");
```

In this case as a value "INV-3337" string is extracted.

### Expression
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateregexposition/expression.md

#### TemplateRegexPosition.Expression property

Gets the regular expression.

```csharp
public string Expression { get; }
```

##### Property Value

A string that represents the regular expression.

### MatchCase
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateregexposition/matchcase.md

#### TemplateRegexPosition.MatchCase property

Gets the value that indicates whether a text case isn't ignored.

```csharp
public bool MatchCase { get; }
```

##### Property Value

`true` if a text case isn't ignored; otherwise, `false`.

### TemplateRegexPosition
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templateregexposition/templateregexposition.md

#### TemplateRegexPosition(string)

Initializes a new instance of the `TemplateRegexPosition` class.

```csharp
public TemplateRegexPosition(string expression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |

#### TemplateRegexPosition(string, bool)

Initializes a new instance of the `TemplateRegexPosition` class.

```csharp
public TemplateRegexPosition(string expression, bool matchCase)
```

| Parameter | Type | Description |
| --- | --- | --- |
| expression | String | The regular expression. |
| matchCase | Boolean | The value that indicates whether a text case isn't ignored. |

### TemplateTable
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetable.md

#### TemplateTable class

Provides the template table.

```csharp
public sealed class TemplateTable : TemplateItem
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateTable(TemplateTableLayout, string) | Initializes a new instance of the `TemplateTable` class with the UPPER CASE name. |
| TemplateTable(TemplateTableParameters, string) | Initializes a new instance of the `TemplateTable` class. |
| TemplateTable(TemplateTableLayout, string, double?) | Initializes a new instance of the `TemplateTable` class with the UPPER CASE name. |
| TemplateTable(TemplateTableParameters, string, double?) | Initializes a new instance of the `TemplateTable` class. |
| TemplateTable(TemplateTableLayout, string, double?, bool) | Initializes a new instance of the `TemplateTable` class. |
| TemplateTable(TemplateTableParameters, string, double?, bool) | Initializes a new instance of the `TemplateTable` class. |

#### Properties

| Name | Description |
| --- | --- |
| Layout { get; } | Gets the table layout. |
| Name { get; } | Gets the name of the template item. |
| PageWidth { get; } | Gets the width of the page that was used to create the template item. |
| Parameters { get; } | Gets the parameters to detect the table in the automatic mode. |
| UseUpperCaseName { get; } | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

#### Methods

| Name | Description |
| --- | --- |
| override Scale(double) | Scales this template item by a given factor. |

##### Remarks

There are two ways to define a table:

* Using `TemplateTableLayout` class. In this case the table is defined by its position on the page: rectangular area, columns and rows separators.
* Using `TemplateTableParameters` class. In this case the table is detected automatically by algorithms with set parameters. See `TemplateTableParameters` class for more information.

### Layout
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetable/layout.md

#### TemplateTable.Layout property

Gets the table layout.

```csharp
public TemplateTableLayout Layout { get; }
```

##### Property Value

An instance of `TemplateTableLayout` class that represents the table layout; `null` if it isn't set.

### Parameters
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetable/parameters.md

#### TemplateTable.Parameters property

Gets the parameters to detect the table in the automatic mode.

```csharp
public TemplateTableParameters Parameters { get; }
```

##### Property Value

An instance of `TemplateTableParameters` class that represents the parameters to detect the table in the automatic mode; `null` if it isn't set.

### Scale
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetable/scale.md

#### TemplateTable.Scale method

Scales this template item by a given factor.

```csharp
public override TemplateItem Scale(double factor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| factor | Double | The scale factor. |

##### Return Value

A new template item scaled by the given factor.

### TemplateTable
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetable/templatetable.md

#### TemplateTable(TemplateTableLayout, string)

Initializes a new instance of the `TemplateTable` class with the UPPER CASE name.

```csharp
public TemplateTable(TemplateTableLayout layout, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout. |
| name | String | The table name. |

##### Examples

Template table is set by table layout if the table can't be detected automatically:

```csharp
TemplateTableLayout layout = new TemplateTableLayout(
    new double[] { 50, 95, 275 },
    new double[] { 325, 340, 365 });
 
TemplateTable table = new TemplateTable(layout, "Details", null);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

#### TemplateTable(TemplateTableLayout, string, double?)

Initializes a new instance of the `TemplateTable` class with the UPPER CASE name.

```csharp
public TemplateTable(TemplateTableLayout layout, string name, double? pageWidth)
```

| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout. |
| name | String | The table name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |

##### Examples

Template table is set by table layout if the table can't be detected automatically:

```csharp
TemplateTableLayout layout = new TemplateTableLayout(
    new double[] { 50, 95, 275 },
    new double[] { 325, 340, 365 });
 
TemplateTable table = new TemplateTable(layout, "Details", null);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

#### TemplateTable(TemplateTableLayout, string, double?, bool)

Initializes a new instance of the `TemplateTable` class.

```csharp
public TemplateTable(TemplateTableLayout layout, string name, double? pageWidth, 
    bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| layout | TemplateTableLayout | The table layout. |
| name | String | The table name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

##### Examples

Template table is set by table layout if the table can't be detected automatically:

```csharp
TemplateTableLayout layout = new TemplateTableLayout(
    new double[] { 50, 95, 275 },
    new double[] { 325, 340, 365 });
 
TemplateTable table = new TemplateTable(layout, "Details", null, false);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

#### TemplateTable(TemplateTableParameters, string)

Initializes a new instance of the `TemplateTable` class.

```csharp
public TemplateTable(TemplateTableParameters parameters, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode. |
| name | String | The table name. |

##### Examples

If a template table is set by detector parameters, the table is detected automatically:

```csharp
TemplateTableParameters parameters = new TemplateTableParameters(
    new Rectangle(new Point(175, 350), new Size(400, 200)),
    new double[] { 185, 370, 425, 485, 545 });

TemplateTable table = new TemplateTable(parameters, "Details", 0);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

#### TemplateTable(TemplateTableParameters, string, double?)

Initializes a new instance of the `TemplateTable` class.

```csharp
public TemplateTable(TemplateTableParameters parameters, string name, double? pageWidth)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode. |
| name | String | The table name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |

##### Examples

If a template table is set by detector parameters, the table is detected automatically:

```csharp
TemplateTableParameters parameters = new TemplateTableParameters(
    new Rectangle(new Point(175, 350), new Size(400, 200)),
    new double[] { 185, 370, 425, 485, 545 });

TemplateTable table = new TemplateTable(parameters, "Details", 0, false);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

#### TemplateTable(TemplateTableParameters, string, double?, bool)

Initializes a new instance of the `TemplateTable` class.

```csharp
public TemplateTable(TemplateTableParameters parameters, string name, double? pageWidth, 
    bool useUpperCaseName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parameters | TemplateTableParameters | The parameters to detect the table in the automatic mode. |
| name | String | The table name. |
| pageWidth | Nullable`1 | The width of the page that was used to create the template item. |
| useUpperCaseName | Boolean | The value that indicates whether a `name` is converted to UPPER CASE. |

##### Examples

If a template table is set by detector parameters, the table is detected automatically:

```csharp
TemplateTableParameters parameters = new TemplateTableParameters(
    new Rectangle(new Point(175, 350), new Size(400, 200)),
    new double[] { 185, 370, 425, 485, 545 });

TemplateTable table = new TemplateTable(parameters, "Details", 0, false);

// Create a document template
Template template = new Template(new TemplateItem[] { table });
```

### TemplateTableLayout
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout.md

#### TemplateTableLayout class

Provides the template table layout which is used by `TemplateTable` class to define table position.

```csharp
public sealed class TemplateTableLayout
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateTableLayout(IEnumerable&lt;double&gt;, IEnumerable&lt;double&gt;) | Initializes a new instance of the `TemplateTableLayout` class. |

#### Properties

| Name | Description |
| --- | --- |
| HorizontalSeparators { get; } | Gets the table rows separators. |
| Rectangle { get; } | Gets the rectangular area that contains the table. |
| VerticalSeparators { get; } | Gets the table columns separators. |

#### Methods

| Name | Description |
| --- | --- |
| MoveTo(Point) | Creates a new layout with the same size, separators and position in the *point*. |

### HorizontalSeparators
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout/horizontalseparators.md

#### TemplateTableLayout.HorizontalSeparators property

Gets the table rows separators.

```csharp
public IList<double> HorizontalSeparators { get; }
```

##### Property Value

A collection of double values that represent y-coordinates of the table rows separators.

### MoveTo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout/moveto.md

#### TemplateTableLayout.MoveTo method

Creates a new layout with the same size, separators and position in the *point*.

```csharp
public TemplateTableLayout MoveTo(Point point)
```

| Parameter | Type | Description |
| --- | --- | --- |
| point | Point | The position of the new layout. |

##### Return Value

A new layout with the same size, separators and position in the *point*.

##### Examples

This functionality allows to move Table Layout.

For example, a document has tables on each page (or a set of documents with a table on the page). These tables differ by position and content, but have the same columns and rows. In this case a user can define `TemplateTableLayout` object at `(0, 0)` once and then move it to the location of the definite table.

If the table position depends on the other object of the page, a user can define `TemplateTableLayout` object based on template document and then move it according to an anchor object. For example, if this is a summary table and it is followed by details table (which can contain a different count of rows). In this case a user can define `TemplateTableLayout` object on template document (with the known details table rectangle) and then move `TemplateTableLayout` object according to the difference of details table rectangle of template and real document.

`MoveTo` method returns a copy of the current object. A user can pass any coordinates (even negative - then layout will be moved to the left/top).

```csharp
// Create a table layout
TemplateTableLayout layout = new TemplateTableLayout(
    new double[] { 0, 25, 150, 180, 230 },
    new double[] { 0, 15, 30, 45, 60, 75 });

// Print a rectangle
Rectangle rect = layout.Rectangle;

// Prints: pos: (0, 0) size: (230, 75)
Console.WriteLine(string.Format("pos: ({0}, {1}) size: ({2}, {3})", rect.Left, rect.Top, rect.Size.Width, rect.Size.Height));

// Move layout to the definite table location
TemplateTableLayout movedLayout = layout.MoveTo(new Point(315, 250));

// Ensure that the first separators are moved:
Console.WriteLine(movedLayout.VerticalSeparators[0]); // prints: 315
Console.WriteLine(movedLayout.HorizontalSeparators[0]); // prints: 250

Rectangle movedRect = movedLayout.Rectangle;

// Prints: pos: (315, 250) size: (230, 75)
Console.WriteLine(string.Format("pos: ({0}, {1}) size: ({2}, {3})", movedRect.Left, movedRect.Top, movedRect.Size.Width, movedRect.Size.Height));

// movedLayout object is a copy of layout object, thus we can tune separators without the impact on the original layout:
movedLayout.HorizontalSeparators.Add(90);

Console.WriteLine(movedLayout.HorizontalSeparators.Count); // prints: 7
Console.WriteLine(layout.HorizontalSeparators.Count); // prints: 6
```

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout/rectangle.md

#### TemplateTableLayout.Rectangle property

Gets the rectangular area that contains the table.

```csharp
public Rectangle Rectangle { get; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains the table.

### TemplateTableLayout
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout/templatetablelayout.md

#### TemplateTableLayout constructor

Initializes a new instance of the `TemplateTableLayout` class.

```csharp
public TemplateTableLayout(IEnumerable<double> verticalSeparators, 
    IEnumerable<double> horizontalSeparators)
```

| Parameter | Type | Description |
| --- | --- | --- |
| verticalSeparators | IEnumerable`1 | The table columns separators. |
| horizontalSeparators | IEnumerable`1 | The table rows separators. |

### VerticalSeparators
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetablelayout/verticalseparators.md

#### TemplateTableLayout.VerticalSeparators property

Gets the table columns separators.

```csharp
public IList<double> VerticalSeparators { get; }
```

##### Property Value

A collection of double values that represent x-coordinates of the table columns separators.

### TemplateTableParameters
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters.md

#### TemplateTableParameters class

Provides parameters for the table detection algorithms.

```csharp
public sealed class TemplateTableParameters
```

#### Constructors

| Name | Description |
| --- | --- |
| TemplateTableParameters(Rectangle, IEnumerable&lt;double&gt;) | Initializes a new instance of the `TemplateTableParameters` class. |
| TemplateTableParameters(Rectangle, IEnumerable&lt;double&gt;, bool?, int?, int?, int?) | Initializes a new instance of the `TemplateTableParameters` class. |

#### Properties

| Name | Description |
| --- | --- |
| HasMergedCells { get; } | Gets the value that indicates whether the table has merged cells. |
| MinColumnCount { get; } | Gets the minimum number of the table columns. |
| MinRowCount { get; } | Gets the minimum number of the table rows. |
| MinVerticalSpace { get; } | Gets the minumum space between the table columns. |
| Rectangle { get; } | Gets the rectangular area that contains the table. |
| VerticalSeparators { get; } | Gets the table columns separators. |

##### Remarks

There are two algorithms to detect a table:

* Allows to detect a table in the rectangular area with set columns. This algorithm is useful for simple tables (without merged columns) and provides more accurate detection.
* Allows to detect a table in any place on the page. This is a more complex algorithm. It can detect tables in any place on the page. Additional parameters help to detect a table more correctly.

In some cases when algorithms can't detect a table or do it in non-accurate way `TemplateTableLayout` class is used.

### HasMergedCells
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/hasmergedcells.md

#### TemplateTableParameters.HasMergedCells property

Gets the value that indicates whether the table has merged cells.

```csharp
public bool? HasMergedCells { get; }
```

##### Property Value

`true` if the table has merged cells; otherwise, `false`. `null` if it isn't set.

### MinColumnCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/mincolumncount.md

#### TemplateTableParameters.MinColumnCount property

Gets the minimum number of the table columns.

```csharp
public int? MinColumnCount { get; }
```

##### Property Value

An integer value that represents the minimum number of the table columns; `null` if it isn't set.

### MinRowCount
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/minrowcount.md

#### TemplateTableParameters.MinRowCount property

Gets the minimum number of the table rows.

```csharp
public int? MinRowCount { get; }
```

##### Property Value

An integer value that represents the minimum number of the table rows; `null` if it isn't set.

### MinVerticalSpace
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/minverticalspace.md

#### TemplateTableParameters.MinVerticalSpace property

Gets the minumum space between the table columns.

```csharp
public int? MinVerticalSpace { get; }
```

##### Property Value

An integer value that represents the minumum space between the table columns; `null` if it isn't set.

### Rectangle
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/rectangle.md

#### TemplateTableParameters.Rectangle property

Gets the rectangular area that contains the table.

```csharp
public Rectangle Rectangle { get; }
```

##### Property Value

An instance of `Rectangle` class that represents the rectangular area that contains the table; `null` if it isn't set.

### TemplateTableParameters
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/templatetableparameters.md

#### TemplateTableParameters(Rectangle, IEnumerable&lt;double&gt;)

Initializes a new instance of the `TemplateTableParameters` class.

```csharp
public TemplateTableParameters(Rectangle rectangle, IEnumerable<double> verticalSeparators)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the table. |
| verticalSeparators | IEnumerable`1 | The table columns separators. |

#### TemplateTableParameters(Rectangle, IEnumerable&lt;double&gt;, bool?, int?, int?, int?)

Initializes a new instance of the `TemplateTableParameters` class.

```csharp
public TemplateTableParameters(Rectangle rectangle, IEnumerable<double> verticalSeparators, 
    bool? hasMergedCells, int? minRowCount, int? minColumnCount, int? minVerticalSpace)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | Rectangle | The rectangular area that contains the table. |
| verticalSeparators | IEnumerable`1 | The table columns separators. |
| hasMergedCells | Nullable`1 | The value that indicates whether the table has merged cells. |
| minRowCount | Nullable`1 | The minimum number of the table rows. |
| minColumnCount | Nullable`1 | The minumum number of the table columns. |
| minVerticalSpace | Nullable`1 | The minumum space between the table columns. |

### VerticalSeparators
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.templates/templatetableparameters/verticalseparators.md

#### TemplateTableParameters.VerticalSeparators property

Gets the table columns separators.

```csharp
public IList<double> VerticalSeparators { get; }
```

##### Property Value

A collection of double values that represent x-coordinates of the table columns separators; `null` if it isn't set.

### GroupDocs.Parser
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser.md

The namespace provides classes for parsing data from documents. With the main class `Parser` you may use all document data parsing and extraction features.

#### Classes

| Class | Description |
| --- | --- |
| 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. |
| Parser | Represents the main class that controls text, images, container extraction and parsing functionality. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.parser.dll -->

### License
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/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() | Initializes a new instance of the `License` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### License
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/license/license.md

#### License constructor

Initializes a new instance of the `License` class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute path to license file. |

##### Examples

The following example demonstrates how to set a license passing a path to the license file.

```csharp
string licensePath = "LicenseFile.lic"";
GroupDocs.Parser.License license = new GroupDocs.Parser.License();
lic.SetLicense(licensePath);
```

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | 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.Parser.License license = new GroupDocs.Parser.License();
    license.SetLicense(licenseStream);
}
```

### Metered
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/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() | Initializes a new instance of the `Metered` class. |

#### 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/parser/net/groupdocs.parser/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves count of credits consumed.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

A decimal value that represents the consumption credit.

##### 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/parser/net/groupdocs.parser/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Retrieves amount of MBs processed.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

A decimal value that represents the consumption quantity.

##### 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/parser/net/groupdocs.parser/metered/metered.md

#### Metered constructor

Initializes a new instance of the `Metered` class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Activates product with Metered keys.

```csharp
public void SetMeteredKey(string publicKey, string privateKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| publicKey | String | A public key. |
| privateKey | String | A 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);
```

### Parser
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser.md

#### Parser class

Represents the main class that controls text, images, container extraction and parsing functionality.

```csharp
public sealed class Parser : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Parser(DbConnection) | Initializes a new instance of the `Parser` class to extract data from a database. |
| Parser(EmailConnection) | Initializes a new instance of the `Parser` class to extract data from a remote email server. |
| Parser(Stream) | Initializes a new instance of the `Parser` class. |
| Parser(string) | Initializes a new instance of the `Parser` class. |
| Parser(Uri) | Initializes a new instance of the `Parser` class to extract data from an URI. |
| Parser(DbConnection, ParserSettings) | Initializes a new instance of the `Parser` class to extract data from a database. |
| Parser(EmailConnection, ParserSettings) | Initializes a new instance of the `Parser` class to extract data from a remote email server. |
| Parser(Stream, LoadOptions) | Initializes a new instance of the `Parser` class with `LoadOptions`. |
| Parser(Stream, ParserSettings) | Initializes a new instance of the `Parser` class with `ParserSettings`. |
| Parser(string, LoadOptions) | Initializes a new instance of the `Parser` class with `LoadOptions`. |
| Parser(string, ParserSettings) | Initializes a new instance of the `Parser` class with `ParserSettings`. |
| Parser(Uri, LoadOptions) | Initializes a new instance of the `Parser` class to extract data from an URI with *loadOptions*. |
| Parser(Uri, ParserSettings) | Initializes a new instance of the `Parser` class to extract data from an URI with *parserSettings*. |
| Parser(Stream, LoadOptions, ParserSettings) | Initializes a new instance of the `Parser` class with `LoadOptions` and `ParserSettings`. |
| Parser(string, LoadOptions, ParserSettings) | Initializes a new instance of the `Parser` class with `LoadOptions` and `ParserSettings`. |
| Parser(Uri, LoadOptions, ParserSettings) | Initializes a new instance of the `Parser` class to extract data from an URI with *loadOptions* and *parserSettings*. |

#### Properties

| Name | Description |
| --- | --- |
| Features { get; } | Gets the supported features. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| GenerateAdjustmentFields(AdjustmentFieldsOptions) | Generates fields for automatic adjustment of template position and scale. |
| GeneratePreview(PreviewOptions) | Get pages preview. |
| GetBarcodes() | Extracts barcodes from the document. |
| GetBarcodes(BarcodeOptions) | Extracts barcodes from the document using customization options. |
| GetBarcodes(int) | Extracts barcodes from the document page. |
| GetBarcodes(int, BarcodeOptions) | Extracts barcodes from the document page using customization options. |
| GetContainer() | Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc. |
| GetDocumentInfo() | Returns the general information about the document. |
| GetFormattedText(FormattedTextOptions) | Extracts a formatted text from the document. |
| GetFormattedText(int, FormattedTextOptions) | Extracts a formatted text from the document page. |
| GetHighlight(int, bool, HighlightOptions) | Extracts a highlight from the document. |
| GetHyperlinks() | Extracts hyperlinks from the document. |
| GetHyperlinks(int) | Extracts hyperlinks from the document page. |
| GetHyperlinks(PageAreaOptions) | Extracts hyperlinks from the document using customization options (to set the rectangular area that contains hyperlinks). |
| GetHyperlinks(int, PageAreaOptions) | Extracts hyperlinks from the document page using customization options (to set the rectangular area that contains hyperlinks). |
| GetImages() | Extracts images from the document. |
| GetImages(int) | Extracts images from the document page. |
| GetImages(PageAreaOptions) | Extracts images from the document using customization options (to set the rectangular area that contains images). |
| GetImages(int, PageAreaOptions) | Extracts images from the document page using customization options (to set the rectangular area that contains images). |
| GetMetadata() | Extracts metadata from the document. |
| GetPagePreview(int) | Generates a document page preview. |
| GetPagePreview(int, PagePreviewOptions) | Generates a document page preview using customization options. |
| GetStructure() | Extracts a structured text from the document. |
| GetTables() | Extracts tables from the document. |
| GetTables(int) | Extracts tables from the document page. |
| GetTables(PageTableAreaOptions) | Extracts tables from the document. |
| GetTables(int, PageTableAreaOptions) | Extracts tables from the document page. |
| GetText() | Extracts a text from the document. |
| GetText(int) | Extracts a text from the document page. |
| GetText(TextOptions) | Extracts a text page from the document using text options (to enable raw fast text extraction mode). |
| GetText(int, TextOptions) | Extracts a text from the document page using text options (to enable raw fast text extraction mode). |
| GetTextAreas() | Extracts text areas from the document. |
| GetTextAreas(int) | Extracts text areas from the document page. |
| GetTextAreas(PageTextAreaOptions) | Extracts text areas from the document using customization options (regular expression, match case, etc.). |
| GetTextAreas(int, PageTextAreaOptions) | Extracts text areas from the document page using customization options (regular expression, match case, etc.). |
| GetToc() | Extracts a table of contents from the document. |
| GetWorksheetCells(int) | Extracts worksheet cells. |
| GetWorksheetCells(int, WorksheetOptions) | Extracts worksheet cells using customization options. |
| GetWorksheetInfo() | Extracts the info about all worksheets in the spreadsheet. |
| GetWorksheetInfo(int) | Extracts the info about the worksheet. |
| ParseByTemplate(Template) | Parses the document by the user-generated template. |
| ParseByTemplate(Template, ParseByTemplateOptions) | Parses the document by the user-generated template using customization options. |
| ParseByTemplate(TemplateCollection, ParseByTemplateOptions) | Selects the most suitable template from the provided collection and then parses the document against the selected template. |
| ParseForm() | Parses the document form. |
| Search(string) | Searches a *keyword* in the document. |
| Search(string, SearchOptions) | Searches a *keyword* in the document using search options (regular expression, match case, etc.). |
| static GetFileInfo(Stream) | Returns the general information about a file. |
| static GetFileInfo(string) | Returns the general information about a file. |
| static GetFileInfo(Stream, LoadOptions) | Returns the general information about a file. |
| static GetFileInfo(string, LoadOptions) | Returns the general information about a file. |

### Dispose
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/dispose.md

#### Parser.Dispose method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

```csharp
public void Dispose()
```

### Features
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/features.md

#### Parser.Features property

Gets the supported features.

```csharp
public Features Features { get; }
```

##### Property Value

An instance of `Features` class that represents the supported features.

##### Remarks

**Learn more:**

* [Get supported features](https://docs.groupdocs.com/display/parsernet/Get+supported+features)

##### Examples

If the feature isn't supported, the method returns `null` instead of the value. Some operations may consume significant time. So it's not optimal to call the method to just check the support for the feature. For this purpose Features property is used:

```csharp
using(Parser parser = new Parser("doc.zip"))
{
    if(!parser.Features.Text)
    {
        Console.WriteLine("Text extraction isn't supported");
        return;
    }
 
    using(TextReader reader = parser.GetText())
    {
        Console.WriteLine(reader.ReadToEnd());
    }
}
```

### GenerateAdjustmentFields
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/generateadjustmentfields.md

#### Parser.GenerateAdjustmentFields method

Generates fields for automatic adjustment of template position and scale.

```csharp
public IEnumerable<TemplateItem> GenerateAdjustmentFields(AdjustmentFieldsOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | AdjustmentFieldsOptions | The generate fields options. |

##### Return Value

Generated auxiliary template fields for a document page.

### GeneratePreview
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/generatepreview.md

#### Parser.GeneratePreview method

Get pages preview.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The options to sets requirements and stream delegates for preview generation. |

##### Exceptions

| exception | condition |
| --- | --- |
| NotSupportedException | Preview generation isn't supported for this document type. |

### GetBarcodes
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getbarcodes.md

#### GetBarcodes()

Extracts barcodes from the document.

```csharp
public IEnumerable<PageBarcodeArea> GetBarcodes()
```

##### Return Value

A collection of `PageBarcodeArea` objects; `null` if barcodes extraction isn't supported.

##### Examples

The following example shows how to extract barcodes from a document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract barcodes from the document.
    IEnumerable<PageBarcodeArea> barcodes = parser.GetBarcodes();

    // Iterate over barcodes
    foreach(PageBarcodeArea barcode in barcodes)
    {
        // Print the page index
        Console.WriteLine("Page: " + barcode.Page.Index.ToString());
        // Print the barcode value
        Console.WriteLine("Value: " + barcode.Value);
    }
}
```

#### GetBarcodes(int)

Extracts barcodes from the document page.

```csharp
public IEnumerable<PageBarcodeArea> GetBarcodes(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A collection of `PageBarcodeArea` objects; `null` if barcodes extraction isn't supported.

##### Examples

The following example shows how to extract barcodes from a document page:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract barcodes from the second document page.
    IEnumerable<PageBarcodeArea> barcodes = parser.GetBarcodes(1);

    // Iterate over barcodes
    foreach(PageBarcodeArea barcode in barcodes)
    {
        // Print the page index
        Console.WriteLine("Page: " + barcode.Page.Index.ToString());
        // Print the barcode value
        Console.WriteLine("Value: " + barcode.Value);
    }
}
```

#### GetBarcodes(BarcodeOptions)

Extracts barcodes from the document using customization options.

```csharp
public IEnumerable<PageBarcodeArea> GetBarcodes(BarcodeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | BarcodeOptions | The options for barcodes extraction. |

##### Return Value

A collection of `PageBarcodeArea` objects; `null` if barcodes extraction isn't supported.

##### Examples

The following example shows how to extract barcodes from the upper-right corner.

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Create the options which are used for barcodes extraction
    BarcodeOptions options = new BarcodeOptions(new Rectangle(new Point(590, 80), new Size(150, 150)));
    // Extract barcodes from the upper-right corner.
    IEnumerable<PageBarcodeArea> barcodes = parser.GetBarcodes(options);

    // Iterate over barcodes
    foreach (PageBarcodeArea barcode in barcodes)
    {
        // Print the page index
        Console.WriteLine("Page: " + barcode.Page.Index.ToString());
        // Print the barcode value
        Console.WriteLine("Value: " + barcode.Value);
    }
}
```

#### GetBarcodes(int, BarcodeOptions)

Extracts barcodes from the document page using customization options.

```csharp
public IEnumerable<PageBarcodeArea> GetBarcodes(int pageIndex, BarcodeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | BarcodeOptions | The options for barcodes extraction. |

##### Return Value

A collection of `PageBarcodeArea` objects; `null` if barcodes extraction isn't supported.

### GetContainer
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getcontainer.md

#### Parser.GetContainer method

Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc.

```csharp
public IEnumerable<ContainerItem> GetContainer()
```

##### Return Value

A collection of container items; `null` if container extraction isn't supported.

##### Remarks

To check if the format supports extracting attachments see [Supported Document Formats](https://docs.groupdocs.com/parser/net/supported-document-formats/) (**Extract Containers and Attachments** column).

**Learn more:**

* [Extract data from attachments and ZIP archives](https://docs.groupdocs.com/display/parsernet/Extract+data+from+attachments+and+ZIP+archives)
* [Iterate through container items](https://docs.groupdocs.com/display/parsernet/Iterate+through+container+items)
* [Extract attachments from PDF portfolios](https://docs.groupdocs.com/display/parsernet/Extract+attachments+from+PDF+portfolios)
* [Extract attachments from Emails](https://docs.groupdocs.com/display/parsernet/Extract+attachments+from+Emails)
* [Extract emails from Outlook Storage](https://docs.groupdocs.com/display/parsernet/Extract+emails+from+Outlook+Storage)
* [Extract text from ZIP archive files](https://docs.groupdocs.com/display/parsernet/Extract+text+from+ZIP+archive+files)

##### Examples

The following example shows how to extract attachments from a container:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Extract attachments from the container
    IEnumerable<ContainerItem> attachments = parser.GetContainer();
    // Check if container extraction is supported
    if(attachments == null)
    {
        Console.WriteLine("Container extraction isn't supported");
    }
 
    // Iterate over attachments
    foreach(ContainerItem item in attachments)
    {
        // Print an item name and size
        Console.WriteLine(string.Format("{0}: {1}", item.Name, item.Size));
    }
}
```

### GetDocumentInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getdocumentinfo.md

#### Parser.GetDocumentInfo method

Returns the general information about the document.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

An instance of class that implements `IDocumentInfo` interface.

##### Remarks

**Learn more:**

* [Get document info](https://docs.groupdocs.com/display/parsernet/Get+document+info)
* [Detect encoding](https://docs.groupdocs.com/display/parsernet/Detect+encoding)

##### Examples

The following example shows how to get document info:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Get the document info
    IDocumentInfo info = parser.GetDocumentInfo();

    Console.WriteLine(string.Format("FileType: {0}", info.FileType));
    Console.WriteLine(string.Format("PageCount: {0}", info.PageCount));
    Console.WriteLine(string.Format("Size: {0}", info.Size));
}
```

### GetFileInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getfileinfo.md

#### GetFileInfo(string)

Returns the general information about a file.

```csharp
public static FileInfo GetFileInfo(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |

##### Return Value

An instance of `FileInfo` class.

##### Examples

The following code shows how to check whether a file is password-protected:

```csharp
// Get a file info
Options.FileInfo info = Parser.GetFileInfo(filePath);
// Check IsEncrypted property
Console.WriteLine(info.IsEncrypted ? "Password is required" : "");
```

#### GetFileInfo(string, LoadOptions)

Returns the general information about a file.

```csharp
public static FileInfo GetFileInfo(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |
| loadOptions | LoadOptions | The options to open the file. |

##### Return Value

An instance of `FileInfo` class.

##### Examples

The following code shows how to check a file type of the password-protected document:

```csharp
// Get a file info
Options.FileInfo info = Parser.GetFileInfo(filePath, new LoadOptions("password"));
// Check IsEncrypted property
Console.WriteLine(info.IsEncrypted ? "Password is required" : "");
// Print the file type
Console.WriteLine(info.FileType.ToString());
```

#### GetFileInfo(Stream)

Returns the general information about a file.

```csharp
public static FileInfo GetFileInfo(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |

##### Return Value

An instance of `FileInfo` class.

##### Examples

The following code shows how to check whether a file is password-protected:

```csharp
// Get a file info
Options.FileInfo info = Parser.GetFileInfo(document);
// Check IsEncrypted property
Console.WriteLine(info.IsEncrypted ? "Password is required" : "");
```

#### GetFileInfo(Stream, LoadOptions)

Returns the general information about a file.

```csharp
public static FileInfo GetFileInfo(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |
| loadOptions | LoadOptions | The options to open the file. |

##### Return Value

An instance of `FileInfo` class.

##### Examples

The following code shows how to check a file type of the password-protected document:

```csharp
// Get a file info
Options.FileInfo info = Parser.GetFileInfo(document);
// Check IsEncrypted property
Console.WriteLine(info.IsEncrypted ? "Password is required" : "");
// Print the file type
Console.WriteLine(info.FileType.ToString());
```

### GetFormattedText
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getformattedtext.md

#### GetFormattedText(FormattedTextOptions)

Extracts a formatted text from the document.

```csharp
public TextReader GetFormattedText(FormattedTextOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | FormattedTextOptions | The formatted text extraction options. |

##### Return Value

An instance of TextReader class with the extracted text; `null` if formatted text extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract formatted text from document](https://docs.groupdocs.com/display/parsernet/Extract+formatted+text+from+document)
* Extract a document text as [HTML](https://docs.groupdocs.com/display/parsernet/HTML)
* Extract a document text as [Markdown](https://docs.groupdocs.com/display/parsernet/Markdown)
* Extract a document text as [Plain text](https://docs.groupdocs.com/display/parsernet/Plain+text)

##### Examples

The following example shows how to extract a document text as HTML text:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract a formatted text into the reader
    using (TextReader reader = parser.GetFormattedText(new FormattedTextOptions(FormattedTextMode.Html)))
    {
        // Print a formatted text from the document
        // If formatted text extraction isn't supported, a reader is null
        Console.WriteLine(reader == null ? "Formatted text extraction isn't suppported" : reader.ReadToEnd());
    }
}
```

#### GetFormattedText(int, FormattedTextOptions)

Extracts a formatted text from the document page.

```csharp
public TextReader GetFormattedText(int pageIndex, FormattedTextOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | FormattedTextOptions | The formatted text extraction options. |

##### Return Value

An instance of TextReader class with the extracted text; `null` if formatted text page extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract formatted text from document page](https://docs.groupdocs.com/display/parsernet/Extract+formatted+text+from+document+page)
* Extract a document text as [HTML](https://docs.groupdocs.com/display/parsernet/HTML)
* Extract a document text as [Markdown](https://docs.groupdocs.com/display/parsernet/Markdown)
* Extract a document text as [Plain text](https://docs.groupdocs.com/display/parsernet/Plain+text)

##### Examples

The following example shows how to extract a document page text as Markdown text:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports formatted text extraction
    if (!parser.Features.FormattedText)
    {
        Console.WriteLine("Document isn't supports formatted text extraction.");
        return;
    }
    
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
    
    // Iterate over pages
    for (int p = 0; p<documentInfo.PageCount; p++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", p + 1, documentInfo.PageCount));
        // Extract a formatted text into the reader
        using (TextReader reader = parser.GetFormattedText(p, new FormattedTextOptions(FormattedTextMode.Markdown)))
        {
            // Print a formatted text from the document
            // We ignore null-checking as we have checked formatted text extraction feature support earlier
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

### GetHighlight
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gethighlight.md

#### Parser.GetHighlight method

Extracts a highlight from the document.

```csharp
public HighlightItem GetHighlight(int position, bool isDirect, HighlightOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| position | Int32 | The start position of the highlight. |
| isDirect | Boolean | The value that indicates whether highlight extraction is direct. `true` if the higlight is extracted by the right of *position*; otherwise, `false`. |
| options | HighlightOptions | The highlight extraction options. |

##### Return Value

An instance of `HighlightItem` class that represents the extracted highlight; `null` if highlight extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract highlights](https://docs.groupdocs.com/display/parsernet/Extract+highlights)

##### Examples

The following example shows how to extract a highlight that contains 3 words:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract a highlight:
    HighlightItem hl = parser.GetHighlight(2, true, new HighlightOptions(3));
    
    // Check if highlight extraction is supported
    if (hl == null)
    {
        Console.WriteLine("Highlight extraction isn't supported");
        return;
    }
    
    // Print an extracted highlight
    Console.WriteLine(string.Format("At {0}: {1}", hl.Position, hl.Text));
}
```

### GetHyperlinks
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gethyperlinks.md

#### GetHyperlinks()

Extracts hyperlinks from the document.

```csharp
public IEnumerable<PageHyperlinkArea> GetHyperlinks()
```

##### Return Value

A collection of `PageHyperlinkArea` objects; `null` if hyperlinks extraction isn't supported.

##### Examples

The following example shows how to extract all hyperlinks from the whole document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports hyperlink extraction
    if (!parser.Features.Hyperlinks)
    {
        Console.WriteLine("Document isn't supports hyperlink extraction.");
        return;
    }
    // Extract hyperlinks from the document
    IEnumerable<PageHyperlinkArea> hyperlinks = parser.GetHyperlinks();
    // Iterate over hyperlinks
    foreach (PageHyperlinkArea h in hyperlinks)
    {
        // Print the hyperlink text
        Console.WriteLine(h.Text);
        // Print the hyperlink URL
        Console.WriteLine(h.Url);
        Console.WriteLine();
    }
}
```

#### GetHyperlinks(int)

Extracts hyperlinks from the document page.

```csharp
public IEnumerable<PageHyperlinkArea> GetHyperlinks(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A collection of `PageHyperlinkArea` objects; `null` if hyperlinks extraction isn't supported.

##### Examples

The following example shows how to extract hyperlinks from the document page:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports hyperlink extraction
    if (!parser.Features.Hyperlinks)
    {
        Console.WriteLine("Document isn't supports hyperlink extraction.");
        return;
    }
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
    // Iterate over pages
    for (int pageIndex = 0; pageIndex < documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));
        // Extract hyperlinks from the document page
        IEnumerable<PageHyperlinkArea> hyperlinks = parser.GetHyperlinks(pageIndex);
        // Iterate over hyperlinks
        foreach (PageHyperlinkArea h in hyperlinks)
        {
            // Print the hyperlink text
            Console.WriteLine(h.Text);
            // Print the hyperlink URL
            Console.WriteLine(h.Url);
            Console.WriteLine();
        }
    }
}
```

#### GetHyperlinks(PageAreaOptions)

Extracts hyperlinks from the document using customization options (to set the rectangular area that contains hyperlinks).

```csharp
public IEnumerable<PageHyperlinkArea> GetHyperlinks(PageAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PageAreaOptions | The options for hyperlinks extraction. |

##### Return Value

A collection of `PageHyperlinkArea` objects; `null` if hyperlinks extraction isn't supported.

##### Examples

The following example shows how to extract hyperlinks from the document page area:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports hyperlink extraction
    if (!parser.Features.Hyperlinks)
    {
        Console.WriteLine("Document isn't supports hyperlink extraction.");
        return;
    }
    // Create the options which are used for hyperlink extraction
    PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(380, 90), new Size(150, 50)));
    // Extract hyperlinks from the document page area
    IEnumerable<PageHyperlinkArea> hyperlinks = parser.GetHyperlinks(options);
    // Iterate over hyperlinks
    foreach (PageHyperlinkArea h in hyperlinks)
    {
        // Print the hyperlink text
        Console.WriteLine(h.Text);
        // Print the hyperlink URL
        Console.WriteLine(h.Url);
        Console.WriteLine();
    }
}
```

#### GetHyperlinks(int, PageAreaOptions)

Extracts hyperlinks from the document page using customization options (to set the rectangular area that contains hyperlinks).

```csharp
public IEnumerable<PageHyperlinkArea> GetHyperlinks(int pageIndex, PageAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | PageAreaOptions | The options for hyperlinks extraction. |

##### Return Value

A collection of `PageHyperlinkArea` objects; `null` if hyperlinks extraction isn't supported.

##### Examples

The following example shows how to extract hyperlinks from the document page area using customization options:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports hyperlink extraction
    if (!parser.Features.Hyperlinks)
    {
        Console.WriteLine("Document isn't supports hyperlink extraction.");
        return;
    }
    
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
    
    // Create the options which are used for hyperlink extraction
    PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(380, 90), new Size(150, 50)));
    // Iterate over pages
    for (int pageIndex = 0; pageIndex < documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));         
        // Extract hyperlinks from the document page area
        IEnumerable<PageHyperlinkArea> hyperlinks = parser.GetHyperlinks(pageIndex, options);
        // Iterate over hyperlinks
        foreach (PageHyperlinkArea h in hyperlinks)
        {
            // Print the hyperlink text
            Console.WriteLine(h.Text);
            // Print the hyperlink URL
            Console.WriteLine(h.Url);
            Console.WriteLine();
        }
}
```

### GetImages
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getimages.md

#### GetImages()

Extracts images from the document.

```csharp
public IEnumerable<PageImageArea> GetImages()
```

##### Return Value

A collection of `PageImageArea` objects; `null` if images extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract images from documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+documents)
* [Extract images to files](https://docs.groupdocs.com/display/parsernet/Extract+images+to+files)
* [Extract images from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Word+documents)
* [Extract images from Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Excel+spreadsheets)
* [Extract images from Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+PowerPoint+presentations)
* [Extract images from Emails](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Emails)
* [Extract images from PDF documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+PDF+documents)

##### Examples

The following example shows how to extract all images from the whole document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract images
    IEnumerable<PageImageArea> images = parser.GetImages();
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Images extraction isn't supported");
        return;
    }
    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Print a page index, rectangle and image type:
        Console.WriteLine(string.Format("Page: {0}, R: {1}, Type: {2}", image.Page.Index, image.Rectangle, image.FileType));
    }
}
```

#### GetImages(PageAreaOptions)

Extracts images from the document using customization options (to set the rectangular area that contains images).

```csharp
public IEnumerable<PageImageArea> GetImages(PageAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PageAreaOptions | The options for images extraction. |

##### Return Value

A collection of `PageImageArea` objects; `null` if images extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract images from documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+documents)
* [Extract images to files](https://docs.groupdocs.com/display/parsernet/Extract+images+to+files)
* [Extract images from document page area](https://docs.groupdocs.com/display/parsernet/Extract+images+from+document+page+area)
* [Extract images from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Word+documents)
* [Extract images from Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Excel+spreadsheets)
* [Extract images from Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+PowerPoint+presentations)
* [Extract images from Emails](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Emails)
* [Extract images from PDF documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+PDF+documents)

##### Examples

The following example shows how to extract only images from the upper-left courner:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Create the options which are used for images extraction
    PageAreaOptions options = new PageAreaOptions(new Rectangle(new Point(0, 0), new Size(300, 100)));
    // Extract images from the upper-left courner of a page:
    IEnumerable<PageImageArea> images = parser.GetImages(options);
    // Check if images extraction is supported
    if (images == null)
    {
        Console.WriteLine("Page images extraction isn't supported");
        return;
    }
    // Iterate over images
    foreach (PageImageArea image in images)
    {
        // Print a page index, rectangle and image type:
        Console.WriteLine(string.Format("Page: {0}, R: {1}, Type: {2}", image.Page.Index, image.Rectangle, image.FileType));
    }
}
```

#### GetImages(int)

Extracts images from the document page.

```csharp
public IEnumerable<PageImageArea> GetImages(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A collection of `PageImageArea` objects; `null` if images extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract images from documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+documents)
* [Extract images to files](https://docs.groupdocs.com/display/parsernet/Extract+images+to+files)
* [Extract images from document page](https://docs.groupdocs.com/display/parsernet/Extract+images+from+document+page)
* [Extract images from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Word+documents)
* [Extract images from Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Excel+spreadsheets)
* [Extract images from Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+PowerPoint+presentations)
* [Extract images from Emails](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Emails)
* [Extract images from PDF documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+PDF+documents)

##### Examples

To extract images from a document page the following method is used:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports images extraction
    if (!parser.Features.Images)
    {
        Console.WriteLine("Document isn't supports images extraction.");
        return;
    }
    
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
    
    // Iterate over pages
    for (int pageIndex = 0; pageIndex<documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));
        // Iterate over images
        // We ignore null-checking as we have checked images extraction feature support earlier
        foreach (PageImageArea image in parser.GetImages(pageIndex))
        {
            // Print a rectangle and image type
            Console.WriteLine(string.Format("R: {0}, Text: {1}", image.Rectangle, image.FileType));
        }
    }
}
```

#### GetImages(int, PageAreaOptions)

Extracts images from the document page using customization options (to set the rectangular area that contains images).

```csharp
public IEnumerable<PageImageArea> GetImages(int pageIndex, PageAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | PageAreaOptions | The options for images extraction. |

##### Return Value

A collection of `PageImageArea` objects; `null` if images extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract images from documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+documents)
* [Extract images to files](https://docs.groupdocs.com/display/parsernet/Extract+images+to+files)
* [Extract images from document page](https://docs.groupdocs.com/display/parsernet/Extract+images+from+document+page)
* [Extract images from document page area](https://docs.groupdocs.com/display/parsernet/Extract+images+from+document+page+area)
* [Extract images from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Word+documents)
* [Extract images from Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+Excel+spreadsheets)
* [Extract images from Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Microsoft+Office+PowerPoint+presentations)
* [Extract images from Emails](https://docs.groupdocs.com/display/parsernet/Extract+images+from+Emails)
* [Extract images from PDF documents](https://docs.groupdocs.com/display/parsernet/Extract+images+from+PDF+documents)

### GetMetadata
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getmetadata.md

#### Parser.GetMetadata method

Extracts metadata from the document.

```csharp
public IEnumerable<MetadataItem> GetMetadata()
```

##### Return Value

A collection of metadata items; `null` if metadata extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract metadata from documents](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+documents)
* [Extract metadata from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+Microsoft+Office+Word+documents)
* [Extract metadata from Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+Microsoft+Office+Excel+spreadsheets)
* [Extract metadata from Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+Microsoft+Office+PowerPoint+presentations)
* [Extract metadata from PDF documents](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+PDF+documents)
* [Extract metadata from Emails](https://docs.groupdocs.com/display/parsernet/Extract+metadata+from+Emails)

##### Examples

The following example shows how to extract metadata from a document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Extract metadata from the document
    IEnumerable<MetadataItem> metadata = parser.GetMetadata();
    // Check if metadata extraction is supported
    if(metadata == null)
    {
        Console.WriteLine("Metatada extraction isn't supported");
    }
 
    // Iterate over metadata items
    foreach(MetadataItem item in metadata)
    {
        // Print an item name and value
        Console.WriteLine(string.Format("{0}: {1}", item.Name, item.Value));
    }
}
```

### GetPagePreview
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getpagepreview.md

#### GetPagePreview(int)

Generates a document page preview.

```csharp
public Stream GetPagePreview(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

An instance of Stream containing an image of the document page; `null` if the page preview generation isn't supported.

#### GetPagePreview(int, PagePreviewOptions)

Generates a document page preview using customization options.

```csharp
public Stream GetPagePreview(int pageIndex, PagePreviewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | PagePreviewOptions | The options to customize the preview generation. |

##### Return Value

An instance of Stream containing an image of the document page; `null` if the page preview generation isn't supported.

### GetStructure
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getstructure.md

#### Parser.GetStructure method

Extracts a structured text from the document.

```csharp
public XmlReader GetStructure()
```

##### Return Value

An instance of XmlReader class with XML text structure; `null` if text structure extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text structure](https://docs.groupdocs.com/display/parsernet/Extract+text+structure)

### GetTables
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gettables.md

#### GetTables(PageTableAreaOptions)

Extracts tables from the document.

```csharp
public IEnumerable<PageTableArea> GetTables(PageTableAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PageTableAreaOptions | The options for tables extraction. |

##### Return Value

A collection of `PageTableArea` objects; `null` if tables extraction isn't supported.

##### Examples

The following example shows how to extract tables from the whole document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports table extraction
    if (!parser.Features.Tables)
    {
        Console.WriteLine("Document isn't supports tables extraction.");
        return;
    }
    // Create the layout of tables
    TemplateTableLayout layout = new TemplateTableLayout(
        new double[] { 50, 95, 275, 415, 485, 545 },
        new double[] { 325, 340, 365, 395 });
    // Create the options for table extraction
    PageTableAreaOptions options = new PageTableAreaOptions(layout);
    // Extract tables from the document
    IEnumerable<PageTableArea> tables = parser.GetTables(options);
    // Iterate over tables
    foreach (PageTableArea t in tables)
    {
        // Iterate over rows
        for (int row = 0; row < t.RowCount; row++)
        {
            // Iterate over columns
            for (int column = 0; column < t.ColumnCount; column++)
            {
                // Get the table cell
                PageTableAreaCell cell = t[row, column];
                if (cell != null)
                {
                    // Print the table cell text
                    Console.Write(cell.Text);
                    Console.Write(" | ");
                }
            }
            Console.WriteLine();
        }
        Console.WriteLine();
    }
}
```

#### GetTables(int, PageTableAreaOptions)

Extracts tables from the document page.

```csharp
public IEnumerable<PageTableArea> GetTables(int pageIndex, PageTableAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | PageTableAreaOptions | The options for tables extraction. |

##### Return Value

A collection of `PageTableArea` objects; `null` if tables extraction isn't supported.

##### Examples

The following example shows how to extract tables from the document page:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports table extraction
    if (!parser.Features.Tables)
    {
        Console.WriteLine("The document does not support tables extraction.");
        return;
    }
    // Create the layout of tables
    TemplateTableLayout layout = new TemplateTableLayout(
        new double[] { 50, 95, 275, 415, 485, 545 },
        new double[] { 325, 340, 365, 395 });
    // Create the options for table extraction
    PageTableAreaOptions options = new PageTableAreaOptions(layout);
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("The document has no pages.");
        return;
    }
    // Iterate over pages
    for (int pageIndex = 0; pageIndex < documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));
        // Extract tables from the document page
        IEnumerable<PageTableArea> tables = parser.GetTables(pageIndex, options);
        // Iterate over tables
        foreach (PageTableArea t in tables)
        {
            // Iterate over rows
            for (int row = 0; row < t.RowCount; row++)
            {
                // Iterate over columns
                for (int column = 0; column < t.ColumnCount; column++)
                {
                    // Get the table cell
                    PageTableAreaCell cell = t[row, column];
                    if (cell != null)
                    {
                        // Print the table cell text
                        Console.Write(cell.Text);
                        Console.Write(" | ");
                    }
                }
                Console.WriteLine();
            }
            Console.WriteLine();
        }
    }
}
```

#### GetTables()

Extracts tables from the document.

```csharp
public IEnumerable<PageTableArea> GetTables()
```

##### Return Value

A collection of `PageTableArea` objects; `null` if tables extraction isn't supported.

##### Examples

The following example shows how to extract tables from the whole document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports table extraction
    if (!parser.Features.Tables)
    {
        Console.WriteLine("The document does not support tables extraction.");
        return;
    }
    // Extract tables from the document
    IEnumerable<PageTableArea> tables = parser.GetTables();
    // Iterate over tables
    foreach (PageTableArea t in tables)
    {
        // Iterate over rows
        for (int row = 0; row < t.RowCount; row++)
        {
            // Iterate over columns
            for (int column = 0; column < t.ColumnCount; column++)
            {
                // Get the table cell
                PageTableAreaCell cell = t[row, column];
                if (cell != null)
                {
                    // Print the table cell text
                    Console.Write(cell.Text);
                    Console.Write(" | ");
                }
            }
            Console.WriteLine();
        }
        Console.WriteLine();
    }
}
```

#### GetTables(int)

Extracts tables from the document page.

```csharp
public IEnumerable<PageTableArea> GetTables(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A collection of `PageTableArea` objects; `null` if tables extraction isn't supported.

##### Examples

The following example shows how to extract tables from the document page:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if the document supports table extraction
    if (!parser.Features.Tables)
    {
        Console.WriteLine("The document does not support tables extraction.");
        return;
    }
    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if (documentInfo.PageCount == 0)
    {
        Console.WriteLine("The document has no pages.");
        return;
    }
    // Iterate over pages
    for (int pageIndex = 0; pageIndex < documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));
        // Extract tables from the document page
        IEnumerable<PageTableArea> tables = parser.GetTables(pageIndex);
        // Iterate over tables
        foreach (PageTableArea t in tables)
        {
            // Iterate over rows
            for (int row = 0; row < t.RowCount; row++)
            {
                // Iterate over columns
                for (int column = 0; column < t.ColumnCount; column++)
                {
                    // Get the table cell
                    PageTableAreaCell cell = t[row, column];
                    if (cell != null)
                    {
                        // Print the table cell text
                        Console.Write(cell.Text);
                        Console.Write(" | ");
                    }
                }
                Console.WriteLine();
            }
            Console.WriteLine();
        }
    }
}
```

### GetText
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gettext.md

#### GetText()

Extracts a text from the document.

```csharp
public TextReader GetText()
```

##### Return Value

An instance of TextReader class with the extracted text; `null` if text extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text from documents](https://docs.groupdocs.com/display/parsernet/Extract+text+from+documents)
* [Extract text in Accurate mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Accurate+mode)

##### Examples

The following example shows how to extract a text from a document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Extract a text into the reader
    using(TextReader reader = parser.GetText())
    {
        // Print a text from the document
        // If text extraction isn't supported, a reader is null
        Console.WriteLine(reader == null ? "Text extraction isn't supported" : reader.ReadToEnd());
    }
}
```

#### GetText(TextOptions)

Extracts a text page from the document using text options (to enable raw fast text extraction mode).

```csharp
public TextReader GetText(TextOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | TextOptions | The text extraction options. |

##### Return Value

An instance of TextReader class with the extracted text; `null` if text extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text in Accurate mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Accurate+mode)
* [Extract text in Raw mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Raw+mode)

##### Examples

The following example shows how to extract a raw text from a document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Extract a raw text into the reader
    using(TextReader reader = parser.GetText(new TextOptions(true)))
    {
        // Print a text from the document
        // If text extraction isn't supported, a reader is null
        Console.WriteLine(reader == null ? "Text extraction isn't supported" : reader.ReadToEnd());
    }
}
```

#### GetText(int)

Extracts a text from the document page.

```csharp
public TextReader GetText(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

An instance of TextReader class with the extracted text; `null` if text page extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text in Accurate mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Accurate+mode)

##### Examples

The following example shows how to extract a text from the document page:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Check if the document supports text extraction
    if(!parser.Features.Text)
    {
        Console.WriteLine("Document isn't supports text extraction.");
        return;
    }

    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if(documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
 
    // Iterate over pages
    for(int p = 0; p<documentInfo.PageCount; p++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", p + 1, documentInfo.PageCount));
 
        // Extract a text into the reader
        using(TextReader reader = parser.GetText(p))
        {
            // Print a text from the document
            // We ignore null-checking as we have checked text extraction feature support earlier
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

#### GetText(int, TextOptions)

Extracts a text from the document page using text options (to enable raw fast text extraction mode).

```csharp
public TextReader GetText(int pageIndex, TextOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | TextOptions | The text extraction options. |

##### Return Value

An instance of TextReader class with the extracted text; `null` if text page extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text in Accurate mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Accurate+mode)
* [Extract text in Raw mode](https://docs.groupdocs.com/display/parsernet/Extract+text+in+Raw+mode)

##### Examples

The following example shows how to extract a raw text from the document page:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Check if the document supports text extraction
    if(!parser.Features.Text)
    {
        Console.WriteLine("Document isn't supports text extraction.");
        return;
    }

    // Get the document info
    DocumentInfo documentInfo = parser.GetDocumentInfo() as DocumentInfo;
    // Check if the document has pages
    if(documentInfo == null || documentInfo.RawPageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
 
    // Iterate over pages
    for(int p = 0; p<documentInfo.RawPageCount; p++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", p + 1, documentInfo.RawPageCount));
 
        // Extract a text into the reader
        using(TextReader reader = parser.GetText(p, new TextOptions(true)))
        {
            // Print a text from the document
            // We ignore null-checking as we have checked text extraction feature support earlier
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

### GetTextAreas
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gettextareas.md

#### GetTextAreas()

Extracts text areas from the document.

```csharp
public IEnumerable<PageTextArea> GetTextAreas()
```

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text areas](https://docs.groupdocs.com/display/parsernet/Extract+text+areas)

##### Examples

The following example shows how to extract all text areas from the whole document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Extract text areas
    IEnumerable<PageTextArea> areas = parser.GetTextAreas();
    // Check if text areas extraction is supported
    if(areas == null)
    {
        Console.WriteLine("Page text areas extraction isn't supported");
        return;
    }
 
    // Iterate over page text areas
    foreach(PageTextArea a in areas)
    {
        // Print a page index, rectangle and text area value:
        Console.WriteLine(string.Format("Page: {0}, R: {1}, Text: {2}", a.Page.Index, a.Rectangle, a.Text));
    }
}
```

#### GetTextAreas(PageTextAreaOptions)

Extracts text areas from the document using customization options (regular expression, match case, etc.).

```csharp
public IEnumerable<PageTextArea> GetTextAreas(PageTextAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PageTextAreaOptions | The options for text area extraction. |

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text areas](https://docs.groupdocs.com/display/parsernet/Extract+text+areas)

##### Examples

The following example shows how to extract only text areas with digits from the upper-left courner:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Create the options which are used for text area extraction
    PageTextAreaOptions options = new PageTextAreaOptions("[0-9]+", new Rectangle(new Point(0, 0), new Size(300, 100)));

    // Extract text areas which contain only digits from the upper-left courner of a page:
    IEnumerable<PageTextArea> areas = parser.GetTextAreas(options);
    // Check if text areas extraction is supported
    if(areas == null)
    {
        Console.WriteLine("Page text areas extraction isn't supported");
        return;
    }
 
    // Iterate over page text areas
    foreach(PageTextArea a in areas)
    {
        // Print a page index, rectangle and text area value:
        Console.WriteLine(string.Format("Page: {0}, R: {1}, Text: {2}", a.Page.Index, a.Rectangle, a.Text));
    }
}
```

#### GetTextAreas(int)

Extracts text areas from the document page.

```csharp
public IEnumerable<PageTextArea> GetTextAreas(int pageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text areas](https://docs.groupdocs.com/display/parsernet/Extract+text+areas)

##### Examples

To extract text areas from a document page the following method is used:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Check if the document supports text areas extraction
    if(!parser.Features.TextAreas)
    {
        Console.WriteLine("Document isn't supports text areas extraction.");
        return;
    }

    // Get the document info
    IDocumentInfo documentInfo = parser.GetDocumentInfo();
    // Check if the document has pages
    if(documentInfo.PageCount == 0)
    {
        Console.WriteLine("Document hasn't pages.");
        return;
    }
 
    // Iterate over pages
    for(int pageIndex = 0; pageIndex<documentInfo.PageCount; pageIndex++)
    {
        // Print a page number 
        Console.WriteLine(string.Format("Page {0}/{1}", pageIndex + 1, documentInfo.PageCount));
 
        // Iterate over page text areas
        // We ignore null-checking as we have checked text areas extraction feature support earlier
        foreach(PageTextArea a in parser.GetTextAreas(pageIndex))
        {
            // Print a rectangle and text area value:
            Console.WriteLine(string.Format("R: {0}, Text: {1}", a.Rectangle, a.Text));
        }
    }
}
```

#### GetTextAreas(int, PageTextAreaOptions)

Extracts text areas from the document page using customization options (regular expression, match case, etc.).

```csharp
public IEnumerable<PageTextArea> GetTextAreas(int pageIndex, PageTextAreaOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | Int32 | The zero-based page index. |
| options | PageTextAreaOptions | The options for text area extraction. |

##### Return Value

A collection of `PageTextArea` objects; `null` if text areas extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract text areas](https://docs.groupdocs.com/display/parsernet/Extract+text+areas)

### GetToc
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/gettoc.md

#### Parser.GetToc method

Extracts a table of contents from the document.

```csharp
public IEnumerable<TocItem> GetToc()
```

##### Return Value

A collection of table of contents items; `null` if table of contents extraction isn't supported.

##### Remarks

**Learn more:**

* [Extract table of contents](https://docs.groupdocs.com/display/parsernet/Extract+table+of+contents)
* [Extract text by table of contents item](https://docs.groupdocs.com/display/parsernet/Extract+text+by+table+of+contents+item)
* [Extract table of contents from Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Extract+table+of+contents+from+Microsoft+Office+Word+documents)
* [Extract table of contents from EPUB eBooks](https://docs.groupdocs.com/display/parsernet/Extract+table+of+contents+from+EPUB+eBooks)

##### Examples

The following example shows how to extract table of contents from CHM file:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Check if text extraction is supported
    if (!parser.Features.Text)
    {
        Console.WriteLine("Text extraction isn't supported.");
        return;
    }

    // Check if toc extraction is supported
    if (!parser.Features.Toc)
    {
        Console.WriteLine("Toc extraction isn't supported.");
        return;
    }
 
    // Get table of contents
    IEnumerable<TocItem> toc = parser.GetToc();
    
    // Iterate over items
    foreach (TocItem i in toc)
    {
        // Print the Toc text
        Console.WriteLine(i.Text);
        // Check if page index has a value
        if (i.PageIndex == null)
        {
            continue;
        }
        // Extract a page text
        using (TextReader reader = parser.GetText(i.PageIndex.Value))
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

### GetWorksheetCells
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getworksheetcells.md

#### GetWorksheetCells(int)

Extracts worksheet cells.

```csharp
public IEnumerable<WorksheetCell> GetWorksheetCells(int worksheetIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | The zero-based index of the worksheet. |

##### Return Value

A collection of instances of `WorksheetCell` class that contains the cell data.

#### GetWorksheetCells(int, WorksheetOptions)

Extracts worksheet cells using customization options.

```csharp
public IEnumerable<WorksheetCell> GetWorksheetCells(int worksheetIndex, WorksheetOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | The zero-based index of the worksheet. |
| options | WorksheetOptions | The customization options. |

##### Return Value

A collection of instances of `WorksheetCell` class that contains the cell data.

### GetWorksheetInfo
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/getworksheetinfo.md

#### GetWorksheetInfo()

Extracts the info about all worksheets in the spreadsheet.

```csharp
public IEnumerable<WorksheetInfo> GetWorksheetInfo()
```

##### Return Value

A collection of instances of `WorksheetInfo` class that contains the info about all worksheets in the spreadsheet.

#### GetWorksheetInfo(int)

Extracts the info about the worksheet.

```csharp
public WorksheetInfo GetWorksheetInfo(int worksheetIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| worksheetIndex | Int32 | The zero-based index of the worksheet. |

##### Return Value

An instance of `WorksheetInfo` class that contains the info about all worksheets in the spreadsheet.

### ParseByTemplate
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/parsebytemplate.md

#### ParseByTemplate(Template)

Parses the document by the user-generated template.

```csharp
public DocumentData ParseByTemplate(Template template)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The user-generated template. |

##### Return Value

An instance of `DocumentData` class that contains the extracted data; `null` if parsing by template isn't supported.

##### Remarks

**Learn more:**

* [Parse data from documents](https://docs.groupdocs.com/display/parsernet/Parse+data+from+documents)
* [Working with templates](https://docs.groupdocs.com/display/parsernet/Working+with+templates)
* [Working with data extracted by template](https://docs.groupdocs.com/display/parsernet/Working+with+data+extracted+by+template)
* [Parse data from PDF documents](https://docs.groupdocs.com/display/parsernet/Parse+data+from+PDF+documents)

#### ParseByTemplate(Template, ParseByTemplateOptions)

Parses the document by the user-generated template using customization options.

```csharp
public DocumentData ParseByTemplate(Template template, ParseByTemplateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| template | Template | The user-generated template. |
| options | ParseByTemplateOptions | The customization options. |

##### Return Value

An instance of `DocumentData` class that contains the extracted data; `null` if parsing by template isn't supported.

##### Remarks

**Learn more:**

* [Parse data from documents](https://docs.groupdocs.com/display/parsernet/Parse+data+from+documents)
* [Working with templates](https://docs.groupdocs.com/display/parsernet/Working+with+templates)
* [Working with data extracted by template](https://docs.groupdocs.com/display/parsernet/Working+with+data+extracted+by+template)
* [Parse data from PDF documents](https://docs.groupdocs.com/display/parsernet/Parse+data+from+PDF+documents)

#### ParseByTemplate(TemplateCollection, ParseByTemplateOptions)

Selects the most suitable template from the provided collection and then parses the document against the selected template.

```csharp
public DocumentData ParseByTemplate(TemplateCollection templateCollection, 
    ParseByTemplateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| templateCollection | TemplateCollection | The template collection. |
| options | ParseByTemplateOptions | The customization options. |

##### Return Value

An instance of `DocumentData` class that contains the extracted data; `null` if parsing by template isn't supported.

### ParseForm
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/parseform.md

#### Parser.ParseForm method

Parses the document form.

```csharp
public DocumentData ParseForm()
```

##### Return Value

An instance of `DocumentData` class that contains the extracted data; `null` if parsing by template isn't supported.

##### Remarks

**Learn more:**

* [Extract data from PDF forms](https://docs.groupdocs.com/display/parsernet/Extract+data+from+PDF+forms)
* [Working with extracted data](https://docs.groupdocs.com/display/parsernet/Working+with+data+extracted+by+template)
* [Parse data from PDF documents](https://docs.groupdocs.com/display/parsernet/Parse+data+from+PDF+documents)

##### Examples

The following example shows how to parse a form of the document:

```csharp
// Create an instance of Parser class
using (Parser parser = new Parser(filePath))
{
    // Extract data from PDF document
    DocumentData data = parser.ParseForm();
    // Iterate over extracted data
    for (int i = 0; i<data.Count; i++)
    {
        Console.Write(data[i].Name + ": ");
        PageTextArea area = data[i].PageArea as PageTextArea;
        Console.WriteLine(area == null ? "Not a template field" : area.Text);
    }
}
```

### Parser
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/parser.md

#### Parser(Uri)

Initializes a new instance of the `Parser` class to extract data from an URI.

```csharp
public Parser(Uri uri)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | The Uri the request is sent to. |

#### Parser(Uri, LoadOptions)

Initializes a new instance of the `Parser` class to extract data from an URI with *loadOptions*.

```csharp
public Parser(Uri uri, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | The Uri the request is sent to. |
| loadOptions | LoadOptions | The options to open the file. |

#### Parser(Uri, ParserSettings)

Initializes a new instance of the `Parser` class to extract data from an URI with *parserSettings*.

```csharp
public Parser(Uri uri, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | The Uri the request is sent to. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

#### Parser(Uri, LoadOptions, ParserSettings)

Initializes a new instance of the `Parser` class to extract data from an URI with *loadOptions* and *parserSettings*.

```csharp
public Parser(Uri uri, LoadOptions loadOptions, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uri | Uri | The Uri the request is sent to. |
| loadOptions | LoadOptions | The options to open the file. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

#### Parser(DbConnection)

Initializes a new instance of the `Parser` class to extract data from a database.

```csharp
public Parser(DbConnection connection)
```

| Parameter | Type | Description |
| --- | --- | --- |
| connection | DbConnection | The database connection. |

##### Remarks

**Learn more:**

* [Extract data from databases](https://docs.groupdocs.com/display/parsernet/Extract+data+from+databases)

##### Examples

The following example shows how to extract data from Sqlite database:

```csharp
// Create DbConnection object
DbConnection connection = new SQLiteConnection(string.Format("Data Source={0};Version=3;", Constants.SampleDatabase));
// Create an instance of Parser class to extract tables from the database
using (Parser parser = new Parser(connection))
{
    // Check if text extraction is supported
    if (!parser.Features.Text)
    {
        Console.WriteLine("Text extraction isn't supported.");
        return;
    }
    // Check if toc extraction is supported
    if (!parser.Features.Toc)
    {
        Console.WriteLine("Toc extraction isn't supported.");
        return;
    }
    // Get a list of tables
    IEnumerable<TocItem> toc = parser.GetToc();
    // Iterate over tables
    foreach (TocItem i in toc)
    {
        // Print the table name
        Console.WriteLine(i.Text);
        // Extract a table content as a text
        using (TextReader reader = parser.GetText(i.PageIndex.Value))
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

#### Parser(DbConnection, ParserSettings)

Initializes a new instance of the `Parser` class to extract data from a database.

```csharp
public Parser(DbConnection connection, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| connection | DbConnection | The database connection. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

##### Remarks

**Learn more:**

* [Extract data from databases](https://docs.groupdocs.com/display/parsernet/Extract+data+from+databases)
* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)

##### Examples

The following example shows how to extract data from Sqlite database:

```csharp
// Create DbConnection object
DbConnection connection = new SQLiteConnection(string.Format("Data Source={0};Version=3;", Constants.SampleDatabase));
// Create an instance of Parser class to extract tables from the database
using (Parser parser = new Parser(connection))
{
    // Check if text extraction is supported
    if (!parser.Features.Text)
    {
        Console.WriteLine("Text extraction isn't supported.");
        return;
    }
    // Check if toc extraction is supported
    if (!parser.Features.Toc)
    {
        Console.WriteLine("Toc extraction isn't supported.");
        return;
    }
    // Get a list of tables
    IEnumerable<TocItem> toc = parser.GetToc();
    // Iterate over tables
    foreach (TocItem i in toc)
    {
        // Print the table name
        Console.WriteLine(i.Text);
        // Extract a table content as a text
        using (TextReader reader = parser.GetText(i.PageIndex.Value))
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
```

#### Parser(EmailConnection)

Initializes a new instance of the `Parser` class to extract data from a remote email server.

```csharp
public Parser(EmailConnection connection)
```

| Parameter | Type | Description |
| --- | --- | --- |
| connection | EmailConnection | The email connection. |

##### Remarks

**Learn more:**

* [Extract emails from remote server via POP, IMAP or Exchange Web Services protocols](https://docs.groupdocs.com/display/parsernet/Extract+emails+from+remote+server+via+POP%2C+IMAP+or+Exchange+Web+Services+protocols)

##### Examples

The following example shows how to extract emails from Exchange Server:

```csharp
// Create the connection object for Exchange Web Services protocol 
EmailConnection connection = new EmailEwsConnection(
    "https://outlook.office365.com/ews/exchange.asmx",
    "email@server",
    "password");
 
// Create an instance of Parser class to extract emails from the remote server
using (Parser parser = new Parser(connection))
{
    // Check if container extraction is supported
    if (!parser.Features.Container)
    {
        Console.WriteLine("Container extraction isn't supported.");
        return;
    }

// Extract email messages from the server
IEnumerable<ContainerItem> emails = parser.GetContainer();
 
    // Iterate over attachments
    foreach (ContainerItem item in emails)
    {
        // Create an instance of Parser class for email message
        using (Parser emailParser = item.OpenParser())
        {
            // Extract the email text
            using (TextReader reader = emailParser.GetText())
            {
                // Print the email text
                Console.WriteLine(reader == null ? "Text extraction isn't supported." : reader.ReadToEnd());
            }
        }
    }
}   
```

#### Parser(EmailConnection, ParserSettings)

Initializes a new instance of the `Parser` class to extract data from a remote email server.

```csharp
public Parser(EmailConnection connection, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| connection | EmailConnection | The email connection. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

##### Remarks

**Learn more:**

* [Extract emails from remote server via POP, IMAP or Exchange Web Services protocols](https://docs.groupdocs.com/display/parsernet/Extract+emails+from+remote+server+via+POP%2C+IMAP+or+Exchange+Web+Services+protocols)
* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)

##### Examples

The following example shows how to extract emails from Exchange Server:

```csharp
// Create the connection object for Exchange Web Services protocol 
EmailConnection connection = new EmailEwsConnection(
    "https://outlook.office365.com/ews/exchange.asmx",
    "email@server",
    "password");
 
// Create an instance of Parser class to extract emails from the remote server
using (Parser parser = new Parser(connection))
{
    // Check if container extraction is supported
    if (!parser.Features.Container)
    {
        Console.WriteLine("Container extraction isn't supported.");
        return;
    }

// Extract email messages from the server
IEnumerable<ContainerItem> emails = parser.GetContainer();
 
    // Iterate over attachments
    foreach (ContainerItem item in emails)
    {
        // Create an instance of Parser class for email message
        using (Parser emailParser = item.OpenParser())
        {
            // Extract the email text
            using (TextReader reader = emailParser.GetText())
            {
                // Print the email text
                Console.WriteLine(reader == null ? "Text extraction isn't supported." : reader.ReadToEnd());
            }
        }
    }
}   
```

#### Parser(string)

Initializes a new instance of the `Parser` class.

```csharp
public Parser(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |

##### Remarks

**Learn more:**

* [Load document from local disk](https://docs.groupdocs.com/display/parsernet/Load+document+from+local+disk)

##### Examples

The following example shows how to load the document from the local disk:

```csharp
// Create an instance of Parser class with the filePath
using (Parser parser = new Parser(filePath))
{
    // Extract a text into the reader
    using (TextReader reader = parser.GetText())
    {
        // Print a text from the document
        // If text extraction isn't supported, a reader is null
        Console.WriteLine(reader == null ? "Text extraction isn't supported" : reader.ReadToEnd());
    }
}
```

#### Parser(string, LoadOptions)

Initializes a new instance of the `Parser` class with `LoadOptions`.

```csharp
public Parser(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |
| loadOptions | LoadOptions | The options to open the file. |

##### Remarks

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)
* [Loading password-protected documents](https://docs.groupdocs.com/display/parsernet/Password-protected+documents)
* [Load document from local disk](https://docs.groupdocs.com/display/parsernet/Load+document+from+local+disk)

##### Examples

The document password is passed by LoadOptions class:

```csharp
try
{
    // Create an instance of Parser class with the password:
    using (Parser parser = new Parser(filePath, new LoadOptions(password)))
    {
        // Check if text extraction is supported
        if (!parser.Features.Text)
        {
            Console.WriteLine("Text extraction isn't supported.");
            return;
        }
        // Print the document text
        using (TextReader reader = parser.GetText())
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
catch (InvalidPasswordException)
{
    // Print the message if the password is incorrect or empty
    Console.WriteLine("Invalid password");
}
```

#### Parser(string, ParserSettings)

Initializes a new instance of the `Parser` class with `ParserSettings`.

```csharp
public Parser(string filePath, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

#### Parser(string, LoadOptions, ParserSettings)

Initializes a new instance of the `Parser` class with `LoadOptions` and `ParserSettings`.

```csharp
public Parser(string filePath, LoadOptions loadOptions, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file. |
| loadOptions | LoadOptions | The options to open the file. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

##### Remarks

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)
* [Loading password-protected documents](https://docs.groupdocs.com/display/parsernet/Password-protected+documents)
* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)
* [Load document from local disk](https://docs.groupdocs.com/display/parsernet/Load+document+from+local+disk)

##### Examples

The following example shows how to receive the information via `ILogger` interface:

```csharp
// try
{
    // Create an instance of Logger class
    Logger logger = new Logger();
    // Create an instance of Parser class with the parser settings
    using (Parser parser = new Parser(filePath, null, new ParserSettings(logger)))
    {
        // Check if text extraction is supported
        if (!parser.Features.Text)
        {
            Console.WriteLine("Text extraction isn't supported.");
            return;
        }
        // Print the document text
        using (TextReader reader = parser.GetText())
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
catch (InvalidPasswordException)
{
    ; // Ignore the exception
}
 
private class Logger : ILogger
{
    public void Error(string message, Exception exception)
    {
        // Print error message
        Console.WriteLine("Error: " + message);
    }
    public void Trace(string message)
    {
        // Print event message
        Console.WriteLine("Event: " + message);
    }
    public void Warning(string message)
    {
        // Print warning message
        Console.WriteLine("Warning: " + message);
    }
}
```

#### Parser(Stream)

Initializes a new instance of the `Parser` class.

```csharp
public Parser(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |

##### Remarks

**Learn more:**

* [Load document from stream](https://docs.groupdocs.com/display/parsernet/Load+document+from+stream)

##### Examples

The following example shows how to load the document from the stream:

```csharp
// Create an instance of Parser class with the stream
using (Parser parser = new Parser(stream))
{
    // Extract a text into the reader
    using (TextReader reader = parser.GetText())
    {
        // Print a text from the document
        // If text extraction isn't supported, a reader is null
        Console.WriteLine(reader == null ? "Text extraction isn't supported" : reader.ReadToEnd());
    }
}
```

#### Parser(Stream, LoadOptions)

Initializes a new instance of the `Parser` class with `LoadOptions`.

```csharp
public Parser(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |
| loadOptions | LoadOptions | The options to open the file. |

##### Remarks

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)
* [Loading password-protected documents](https://docs.groupdocs.com/display/parsernet/Password-protected+documents)
* [Load document from stream](https://docs.groupdocs.com/display/parsernet/Load+document+from+stream)

##### Examples

In some cases it's necessary to define `FileFormat`. Both for special cases (databases, email server) and for detecting file types by the content:

```csharp
// Create an instance of Parser class for markdown document
using (Parser parser = new Parser(stream, new LoadOptions(FileFormat.Markup)))
{
    // Check if text extraction is supported
    if (!parser.Features.Text)
    {
        Console.WriteLine("Text extraction isn't supported.");
        return;
    }
    using (TextReader reader = parser.GetText())
    {
        // Print the document text
        // Markdown is detected; text without special symbols is printed
        Console.WriteLine(reader.ReadToEnd());
    }
}
```

The document password is passed by `LoadOptions` class:

```csharp
try
{
    // Create an instance of Parser class with the password:
    using (Parser parser = new Parser(filePath, new LoadOptions(password)))
    {
        // Check if text extraction is supported
        if (!parser.Features.Text)
        {
            Console.WriteLine("Text extraction isn't supported.");
            return;
        }
        // Print the document text
        using (TextReader reader = parser.GetText())
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
catch (InvalidPasswordException)
{
    // Print the message if the password is incorrect or empty
    Console.WriteLine("Invalid password");
}
```

#### Parser(Stream, ParserSettings)

Initializes a new instance of the `Parser` class with `ParserSettings`.

```csharp
public Parser(Stream document, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

#### Parser(Stream, LoadOptions, ParserSettings)

Initializes a new instance of the `Parser` class with `LoadOptions` and `ParserSettings`.

```csharp
public Parser(Stream document, LoadOptions loadOptions, ParserSettings parserSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The source input stream. |
| loadOptions | LoadOptions | The options to open the file. |
| parserSettings | ParserSettings | The parser settings which are used to customize data extraction. |

##### Remarks

**Learn more:**

* [Loading specific file formats](https://docs.groupdocs.com/display/parsernet/Loading+specific+file+formats)
* [Loading password-protected documents](https://docs.groupdocs.com/display/parsernet/Password-protected+documents)
* [Load document from stream](https://docs.groupdocs.com/display/parsernet/Load+document+from+stream)
* [Logging](https://docs.groupdocs.com/display/parsernet/Logging)

##### Examples

The following example shows how to receive the information via `ILogger` interface:

```csharp
// try
{
    // Create an instance of Logger class
    Logger logger = new Logger();
    // Create an instance of Parser class with the parser settings
    using (Parser parser = new Parser(stream, null, new ParserSettings(logger)))
    {
        // Check if text extraction is supported
        if (!parser.Features.Text)
        {
            Console.WriteLine("Text extraction isn't supported.");
            return;
        }
        // Print the document text
        using (TextReader reader = parser.GetText())
        {
            Console.WriteLine(reader.ReadToEnd());
        }
    }
}
catch (InvalidPasswordException)
{
    ; // Ignore the exception
}
 
private class Logger : ILogger
{
    public void Error(string message, Exception exception)
    {
        // Print error message
        Console.WriteLine("Error: " + message);
    }
    public void Trace(string message)
    {
        // Print event message
        Console.WriteLine("Event: " + message);
    }
    public void Warning(string message)
    {
        // Print warning message
        Console.WriteLine("Warning: " + message);
    }
}
```

### Search
Path: https://reference.groupdocs.com/parser/net/groupdocs.parser/parser/search.md

#### Search(string)

Searches a *keyword* in the document.

```csharp
public IEnumerable<SearchResult> Search(string keyword)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | The keyword to search. |

##### Return Value

A collection of `SearchResult` objects; `null` if search isn't supported.

##### Remarks

**Learn more:**

* [Search text](https://docs.groupdocs.com/display/parsernet/Search+text)
* [Search text in Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Word+documents)
* [Search text in Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Excel+spreadsheets)
* [Search text in Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+PowerPoint+presentations)
* [Search text in PDF documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+PDF+documents)
* [Search text in Emails](https://docs.groupdocs.com/display/parsernet/Search+text+in+Emails)
* [Search text in EPUB eBooks](https://docs.groupdocs.com/display/parsernet/Search+text+in+EPUB+eBooks)
* [Search text in HTML documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+HTML+documents)
* [Search text in Microsoft OneNote sections](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+OneNote+sections)

##### Examples

The following example shows how to find a keyword in a document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Search a keyword:
    IEnumerable<SearchResult> sr = parser.Search("page number");
    // Check if search is supported
    if(sr == null)
    {
        Console.WriteLine("Search isn't supported");
        return;
    }
 
    // Iterate over search results
    foreach(SearchResult s in sr)
    {
        // Print an index and found text:
        Console.WriteLine(string.Format("At {0}: {1}", s.Position, s.Text));
    }
}
```

#### Search(string, SearchOptions)

Searches a *keyword* in the document using search options (regular expression, match case, etc.).

```csharp
public IEnumerable<SearchResult> Search(string keyword, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | The keyword to search. |
| options | SearchOptions | The search options. |

##### Return Value

A collection of `SearchResult` objects; `null` if search isn't supported.

##### Remarks

**Learn more:**

* [Search text](https://docs.groupdocs.com/display/parsernet/Search+text)
* [Search text in Microsoft Office Word documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Word+documents)
* [Search text in Microsoft Office Excel spreadsheets](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+Excel+spreadsheets)
* [Search text in Microsoft Office PowerPoint presentations](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+Office+PowerPoint+presentations)
* [Search text in PDF documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+PDF+documents)
* [Search text in Emails](https://docs.groupdocs.com/display/parsernet/Search+text+in+Emails)
* [Search text in EPUB eBooks](https://docs.groupdocs.com/display/parsernet/Search+text+in+EPUB+eBooks)
* [Search text in HTML documents](https://docs.groupdocs.com/display/parsernet/Search+text+in+HTML+documents)
* [Search text in Microsoft OneNote sections](https://docs.groupdocs.com/display/parsernet/Search+text+in+Microsoft+OneNote+sections)

##### Examples

The following example shows how to search with a regular expression in a document:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Search with a regular expression with case matching
    IEnumerable<SearchResult> sr = parser.Search("page number: [0-9]+", new SearchOptions(true, false, true));
    // Check if search is supported
    if(sr == null)
    {
        Console.WriteLine("Search isn't supported");
        return;
    }
 
    // Iterate over search results
    foreach(SearchResult s in sr)
    {
        // Print an index and found text:
        Console.WriteLine(string.Format("At {0}: {1}", s.Position, s.Text));
    }
}
```

The following example shows how to search a text on pages:

```csharp
// Create an instance of Parser class
using(Parser parser = new Parser(filePath))
{
    // Search a keyword with page numbers
    IEnumerable<SearchResult> sr = parser.Search("line", new SearchOptions(false, false, false, true));
    // Check if search is supported
    if(sr == null)
    {
        Console.WriteLine("Search isn't supported");
        return;
    }
 
    // Iterate over search results
    foreach(SearchResult s in sr)
    {
        // Print an index, page number and found text:
        Console.WriteLine(string.Format("At {0} (page {1}): {2}", s.Position, s.PageIndex, s.Text));
    }
}
```

## Python

### GroupDocs.Parser for Python via .NET
Path: https://reference.groupdocs.com/parser/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.parser` | The namespace provides classes for parsing data from documents.
<br/>With the main class `Parser` you may use all document data parsing and extraction features. |
| `groupdocs.parser.data` | The namespace provides classes which represent parsing results. |
| `groupdocs.parser.exceptions` | The namespace provides different exceptions classes. |
| `groupdocs.parser.export` | The namespace provides classes that allow users to export data to different formats. |
| `groupdocs.parser.options` | The namespace provides classes to specify additional options when parsing data from documents. |
| `groupdocs.parser.templates` | The namespace provides classes for creating templates for parsing document data. |

### groupdocs.parser.data
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data.md

The namespace provides classes which represent parsing results.

##### Classes
| Class | Description |
| :- | :- |
| `ContainerItem` | Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on. |
| `DocumentData` | Represents data of the document. It consists of `FieldData` objects
<br/>which contain field data from document. |
| `DocumentPageData` | Represents data of the document page. It consists of `FieldData` objects
<br/>which contain field data from the document page. |
| `FieldData` | Represents field data such as a name, a page index, a field value and so on.
<br/>Depending on the field the value can be a text, an image, a table and so on. |
| `HighlightItem` | Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality. |
| `MetadataItem` | Represents a metadata item which is used in container items and metadata extraction functionality. |
| `Page` | Represents the document page information such as page index and page size.
<br/>It's used to represent the page that contains inheritors of `PageArea` class
<br/>in the parsing by template functionality. |
| `PageArea` | Represents an abstract base class for page areas
<br/>which are used to represent blocks on the document page in the parsing by template functionality. |
| `PageBarcodeArea` | Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality. |
| `PageGroupArea` | Represents a group of page areas
<br/>which is used to group different types of blocks of the document page in the parsing by template functionality. |
| `PageHyperlinkArea` | Represents a page area which is used to represent a hyperlink on the page. |
| `PageImageArea` | Represents a page image area which is used to represent an image on the page in the parsing by template functionality
<br/>or an image attachment if images are extracted from emails or Zip archives. |
| `PageTableArea` | Represents a table page area which is used to represent a table in the parsing by template functionality. |
| `PageTableAreaCell` | Represents a table cell which is used in `PageTableArea` class. |
| `PageTextArea` | Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality. |
| `Point` | Represents a point. |
| `Rectangle` | Represents a rectangular area. |
| `SearchResult` | Represents the search result in the search functionality. |
| `Size` | Represents a size. |
| `TextStyle` | Represents the style of the text such as a font name, a font size and so on. |
| `TocItem` | Represents the item which is used in the table of contents extraction functionality. |
| `WorksheetCell` | Represents a worksheet cell. |
| `WorksheetInfo` | Represents a sheet info. |
| `WorksheetRange` | Provides the range which are used for the worksheet extraction. |

### ContainerItem class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem.md

#### ContainerItem class

Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.

The ContainerItem type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the item. |
| directory | Gets the directory of the item. |
| file_path | Gets the full path of the item. |
| size | Gets the size of the item. |
| metadata | Gets the collection of metadata items. |

##### Methods
| Method | Description |
| :- | :- |
| open_parser | Creates the `Parser` object for the item content. |
| open_parser | Creates the `Parser` object for the item content with `LoadOptions`. |
| open_parser | Creates the `Parser` object for the item content with `LoadOptions`
<br/>and `ParserSettings`. |
| get_metadata_value | Gets the metadata value. |
| open_stream | Opens the stream of the item content. |
| detect_file_type | Detects a file type of the container item. |

##### Remarks

An instance of `ContainerItem` class is used as return value
of `Parser.get_container` method. See the usage examples there.

### detect_file_type method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/detect_file_type.md

#### detect_file_type

Detects a file type of the container item.

##### Returns

An instance of `FileType` class; `FileType.Unknown` if a file type isn't detected.

```python
def detect_file_type(self, detection_mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| detection_mode | groupdocs.parser.options.FileTypeDetectionMode | Defines a mode of the file type detection. |

##### Example

The following example shows how to detect file type of container item:

### directory property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/directory.md

#### directory property

Gets the directory of the item.
##### Definition:
```python
@property
def directory(self):
    ...
```

### file_path property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/file_path.md

#### file_path property

Gets the full path of the item.
##### Definition:
```python
@property
def file_path(self):
    ...
```

### get_metadata_value method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/get_metadata_value.md

#### get_metadata_value

Gets the metadata value.

##### Returns

A string value that represents the value of the metadata item; `null` if the metadata with this name isn't found.

```python
def get_metadata_value(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the metadata. |

### metadata property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/metadata.md

#### metadata property

Gets the collection of metadata items.

##### Remarks

These metadata refer to a container element itself, not a document. Depending on the container type
metadata can contain the following items:

**Email Attachments**

| Description |
| :- |
| The MIME type of the attachment content. |

**ZIP Archives**

| Description |
| :- |
| The time and date at which the file indicated by the Zip Entry was last modified. |
| To detect if image attachment is inline 'disposition' metadata is used. If it's present, it can take 'inline' or 'attachment' values. |

**Outlook Storage**

| Description |
| :- |
| The time and date at which the Outlook Storage item was last modified. |
| The value of "sender" field. |
| The value of "to" field. |
| The value of "subject" field. |
##### Definition:
```python
@property
def metadata(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/name.md

#### name property

Gets the name of the item.
##### Definition:
```python
@property
def name(self):
    ...
```

### open_parser method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/open_parser.md

#### open_parser

Creates the `Parser` object for the item content.

##### Returns

An instance of `Parser` class of the item content.

```python
def open_parser(self):
    ...
```

#### open_parser

Creates the `Parser` object for the item content with `LoadOptions`.

##### Returns

An instance of `Parser` class of the item content.

```python
def open_parser(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the item content. |

#### open_parser

Creates the `Parser` object for the item content with `LoadOptions`
and `ParserSettings`.

##### Returns

An instance of `Parser` class of the item content.

```python
def open_parser(self, load_options, parser_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the item content. |
| parser_settings | groupdocs.parser.options.ParserSettings | The parser settings which are used to customize data extraction. |

### open_stream method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/open_stream.md

#### open_stream

Opens the stream of the item content.

##### Returns

A stream with the item content.

```python
def open_stream(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/containeritem/size.md

#### size property

Gets the size of the item.
##### Definition:
```python
@property
def size(self):
    ...
```

### DocumentData class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata.md

#### DocumentData class

Represents data of the document. It consists of `FieldData` objects
which contain field data from document.

The DocumentData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of DocumentData |
| __init__ | Constructs a new instance of DocumentData |

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the total number of the fields data. |
| template | Gets the template. |

Gets the field data by an index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | The zero-based index of the field. |

##### Methods
| Method | Description |
| :- | :- |
| get_fields_by_name | Returns the collection of field data where the name is equal to `field_name`. |

##### Remarks

An instance of `DocumentData` class is used as return value
of `Parser.parse_by_template` and `Parser.parse_form` methods.
See the usage examples there.

### DocumentData indexer
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata/__getitem__.md

#### DocumentData indexer

Gets the field data by an index.
##### Indexer
| Name | Description |
| :- | :- |
| index | The zero-based index of the field. |

##### Returns

An instance of `FieldData` class.

##### Example

Iteration via all the fields:

`FieldData` class represents field data. Depending on the field `FieldData.page_area` property
can contain any of the inheritors of `PageArea` class. For example, `Parser.parse_form` method
extracts only text fields:

### DocumentData constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata/__init__.md

#### __init__

Constructs a new instance of DocumentData

```python
def __init__(self, fields):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| fields | list |  |

#### __init__

Constructs a new instance of DocumentData

```python
def __init__(self, template, fields):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template |  |
| fields | list |  |

### count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata/count.md

#### count property

Gets the total number of the fields data.
##### Definition:
```python
@property
def count(self):
    ...
```

### get_fields_by_name method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata/get_fields_by_name.md

#### get_fields_by_name

Returns the collection of field data where the name is equal to `field_name`.

##### Returns

A collection of `FieldData` objects; empty collection if no field data is found.

```python
def get_fields_by_name(self, field_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| field_name | System.String | The name of the field. |

##### Example

Find fields by a field name:

`FieldData` class represents field data. Depending on the field `FieldData.page_area` property
can contain any of the inheritors of `PageArea` class. For example, `Parser.parse_form` method
extracts only text fields.

### template property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentdata/template.md

#### template property

Gets the template.
##### Definition:
```python
@property
def template(self):
    ...
```

### DocumentPageData class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata.md

#### DocumentPageData class

Represents data of the document page. It consists of `FieldData` objects
which contain field data from the document page.

**Inheritance:** `DocumentPageData` →
`DocumentData`

The DocumentPageData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of DocumentPageData |

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the total number of the fields data. |
| template | Gets the template. |
| page_index | Gets the page index. |

##### Indexer
| Name | Description |
| :- | :- |
| [index] |  |

##### Methods
| Method | Description |
| :- | :- |
| get_fields_by_name | Returns the collection of field data where the name is equal to `field_name`. |

### DocumentPageData indexer
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/__getitem__.md

##### Indexer
| Name | Description |
| :- | :- |
| index |  |

### DocumentPageData constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/__init__.md

#### __init__

Constructs a new instance of DocumentPageData

```python
def __init__(self, template, fields, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template |  |
| fields | list |  |
| page_index | int |  |

### count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/count.md

#### count property

Gets the total number of the fields data.

### get_fields_by_name method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/get_fields_by_name.md

#### get_fields_by_name

Returns the collection of field data where the name is equal to `field_name`.

##### Returns

A collection of `FieldData` objects; empty collection if no field data is found.

```python
def get_fields_by_name(self, field_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| field_name | System.String | The name of the field. |

##### Example

Find fields by a field name:

`FieldData` class represents field data. Depending on the field `FieldData.page_area` property
can contain any of the inheritors of `PageArea` class. For example, `Parser.parse_form` method
extracts only text fields.

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/page_index.md

#### page_index property

Gets the page index.
##### Definition:
```python
@property
def page_index(self):
    ...
```

### template property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/documentpagedata/template.md

#### template property

Gets the template.

### FieldData class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata.md

#### FieldData class

Represents field data such as a name, a page index, a field value and so on.
Depending on the field the value can be a text, an image, a table and so on.

The FieldData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `FieldData` class with UPPER CASE name. |
| __init__ | Initializes a new instance of the `FieldData` class. |
| __init__ | Initializes a new instance of the `FieldData` class with UPPER CASE name. |
| __init__ | Initializes a new instance of the `FieldData` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the field name. |
| page_index | Gets the page index. |
| page_area | Gets the value of the field. |
| text | Gets the text. |
| linked_field | Gets the linked field. |
| use_upper_case_name | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

##### Remarks

The instances of `FieldData` class are used in `DocumentData` collection.

### FieldData constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/__init__.md

#### __init__

Initializes a new instance of the `FieldData` class with UPPER CASE name.

```python
def __init__(self, name, page_area):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the field. |
| page_area | groupdocs.parser.data.PageArea | The value of the field. |

#### __init__

Initializes a new instance of the `FieldData` class with UPPER CASE name.

```python
def __init__(self, name, page_area, linked_data_field):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the field. |
| page_area | groupdocs.parser.data.PageArea | The value of the field. |
| linked_data_field | groupdocs.parser.data.FieldData | The field which is linked to the field. |

#### __init__

Initializes a new instance of the `FieldData` class.

```python
def __init__(self, name, page_area, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the field. |
| page_area | groupdocs.parser.data.PageArea | The value of the field. |
| use_upper_case_name | bool | The value that indicates whether a `name` is converted to UPPER CASE. |

#### __init__

Initializes a new instance of the `FieldData` class.

```python
def __init__(self, name, page_area, linked_data_field, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the field. |
| page_area | groupdocs.parser.data.PageArea | The value of the field. |
| linked_data_field | groupdocs.parser.data.FieldData | The field which is linked to the field. |
| use_upper_case_name | bool | The value that indicates whether a `name` is converted to UPPER CASE. |

### linked_field property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/linked_field.md

#### linked_field property

Gets the linked field.
##### Definition:
```python
@property
def linked_field(self):
    ...
@linked_field.setter
def linked_field(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/name.md

#### name property

Gets the field name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### page_area property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/page_area.md

#### page_area property

Gets the value of the field.

##### Example

Depending on field `FieldData.page_area` property
can contain any of the inheritors of `PageArea` class.
For example, `Parser.parse_form` method extracts only text fields.
##### Definition:
```python
@property
def page_area(self):
    ...
@page_area.setter
def page_area(self, value):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/page_index.md

#### page_index property

Gets the page index.
##### Definition:
```python
@property
def page_index(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/text.md

#### text property

Gets the text.
##### Definition:
```python
@property
def text(self):
    ...
```

### use_upper_case_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/fielddata/use_upper_case_name.md

#### use_upper_case_name property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.
##### Definition:
```python
@property
def use_upper_case_name(self):
    ...
@use_upper_case_name.setter
def use_upper_case_name(self, value):
    ...
```

### HighlightItem class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/highlightitem.md

#### HighlightItem class

Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality.

The HighlightItem type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| position | Gets the position in the document text. |
| text | Gets the text of the highlight. |

##### Remarks

An instance of `HighlightItem` class is used as return value
of `Parser.get_highlight` method,
`SearchResult.left_highlight_item` and `SearchResult.right_highlight_item` properties.
See the usage examples there.

### position property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/highlightitem/position.md

#### position property

Gets the position in the document text.
##### Definition:
```python
@property
def position(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/highlightitem/text.md

#### text property

Gets the text of the highlight.
##### Definition:
```python
@property
def text(self):
    ...
```

### MetadataItem class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/metadataitem.md

#### MetadataItem class

Represents a metadata item which is used in container items and metadata extraction functionality.

The MetadataItem type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `MetadataItem` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the metadata item. |
| value | Gets the value of the metadata item. |

##### Remarks

An instance of `MetadataItem` class is used as return value
of `Parser.get_metadata` method and as a item in `ContainerItem.metadata` collection.
See the usage examples there.

### MetadataItem constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/metadataitem/__init__.md

#### __init__

Initializes a new instance of the `MetadataItem` class.

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the metadata item. |
| value | System.String | The value of the metadata item. |

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/metadataitem/name.md

#### name property

Gets the name of the metadata item.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/metadataitem/value.md

#### value property

Gets the value of the metadata item.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### Page class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/page.md

#### Page class

Represents the document page information such as page index and page size.
It's used to represent the page that contains inheritors of `PageArea` class
in the parsing by template functionality.

The Page type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Page` class. |

##### Properties
| Property | Description |
| :- | :- |
| index | Gets the page index. |
| size | Gets the page size. |

### Page constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/page/__init__.md

#### __init__

Initializes a new instance of the `Page` class.

```python
def __init__(self, index, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The page index. |
| size | groupdocs.parser.data.Size | The page size. |

### index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/page/index.md

#### index property

Gets the page index.
##### Definition:
```python
@property
def index(self):
    ...
@index.setter
def index(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/page/size.md

#### size property

Gets the page size.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### PageArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagearea.md

#### PageArea class

Represents an abstract base class for page areas
which are used to represent blocks on the document page in the parsing by template functionality.

The PageArea type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagearea/page.md

#### page property

Gets the document page information such as page index and page size.
##### Definition:
```python
@property
def page(self):
    ...
@page.setter
def page(self, value):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagearea/rectangle.md

#### rectangle property

Gets the rectangular area.
##### Definition:
```python
@property
def rectangle(self):
    ...
@rectangle.setter
def rectangle(self, value):
    ...
```

### PageBarcodeArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea.md

#### PageBarcodeArea class

Represents a page barcode area which is used to represent a barcode value in the parsing by template functionality.

**Inheritance:** `PageBarcodeArea` →
`PageArea`

The PageBarcodeArea type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageBarcodeArea` class. |
| __init__ | Initializes a new instance of the `PageBarcodeArea` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| value | Gets the barcode value. |
| code_type_name | Gets the name of the barcode type. |
| confidence | Gets the level of confidence of the parsered barcode. |
| angle | Gets the angle of the barcode. |

### PageBarcodeArea constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/__init__.md

#### __init__

Initializes a new instance of the `PageBarcodeArea` class.

```python
def __init__(self, value, code_type_name, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value of the barcode. |
| code_type_name | System.String | The type name of the barcode. |
| page | groupdocs.parser.data.Page | The page that contains the barcode area. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the barcode area. |

#### __init__

Initializes a new instance of the `PageBarcodeArea` class.

```python
def __init__(self, value, code_type_name, confidence, angle, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.String | The value of the barcode. |
| code_type_name | System.String | The type name of the barcode. |
| confidence | int | The level of confidence of the parsered barcode. |
| angle | float | The angle of the barcode. |
| page | groupdocs.parser.data.Page | The page that contains the barcode area. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the barcode area. |

### angle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/angle.md

#### angle property

Gets the angle of the barcode.
##### Definition:
```python
@property
def angle(self):
    ...
@angle.setter
def angle(self, value):
    ...
```

### code_type_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/code_type_name.md

#### code_type_name property

Gets the name of the barcode type.
##### Definition:
```python
@property
def code_type_name(self):
    ...
@code_type_name.setter
def code_type_name(self, value):
    ...
```

### confidence property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/confidence.md

#### confidence property

Gets the level of confidence of the parsered barcode.
##### Definition:
```python
@property
def confidence(self):
    ...
@confidence.setter
def confidence(self, value):
    ...
```

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/rectangle.md

#### rectangle property

Gets the rectangular area.

### value property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagebarcodearea/value.md

#### value property

Gets the barcode value.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### PageGroupArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagegrouparea.md

#### PageGroupArea class

Represents a group of page areas
which is used to group different types of blocks of the document page in the parsing by template functionality.

**Inheritance:** `PageGroupArea` →
`PageArea`

The PageGroupArea type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of PageGroupArea |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| areas | Gets the collection of grouped page areas. |

### PageGroupArea constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagegrouparea/__init__.md

#### __init__

Constructs a new instance of PageGroupArea

```python
def __init__(self, areas, page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| areas | list |  |
| page | groupdocs.parser.data.Page |  |

### areas property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagegrouparea/areas.md

#### areas property

Gets the collection of grouped page areas.
##### Definition:
```python
@property
def areas(self):
    ...
```

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagegrouparea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagegrouparea/rectangle.md

#### rectangle property

Gets the rectangular area.

### PageHyperlinkArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea.md

#### PageHyperlinkArea class

Represents a page area which is used to represent a hyperlink on the page.

**Inheritance:** `PageHyperlinkArea` →
`PageArea`

The PageHyperlinkArea type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageHyperlinkArea` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| text | Gets the hyperlink text. |
| url | Gets the hyperlink URL. |

##### Remarks

An instance of `PageHyperlinkArea` class is used as return value
of the following methods:

|
|
 |
 |
 |
 |

See the usage examples there.

### PageHyperlinkArea constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea/__init__.md

#### __init__

Initializes a new instance of the `PageHyperlinkArea` class.

```python
def __init__(self, text, url, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The hyperlink text. |
| url | System.String | The hyperlink URL. |
| page | groupdocs.parser.data.Page | The page that contains the hyperlink. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the hyperlink. |

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea/rectangle.md

#### rectangle property

Gets the rectangular area.

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea/text.md

#### text property

Gets the hyperlink text.
##### Definition:
```python
@property
def text(self):
    ...
```

### url property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagehyperlinkarea/url.md

#### url property

Gets the hyperlink URL.
##### Definition:
```python
@property
def url(self):
    ...
```

### PageImageArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea.md

#### PageImageArea class

Represents a page image area which is used to represent an image on the page in the parsing by template functionality
or an image attachment if images are extracted from emails or Zip archives.

**Inheritance:** `PageImageArea` →
`PageArea`

The PageImageArea type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageImageArea` class. |
| __init__ | Initializes a new instance of the `PageImageArea` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| file_type | Gets the format of the image. |
| rotation | Gets the rotation angle of the image. |

##### Methods
| Method | Description |
| :- | :- |
| get_image_stream | Returns the image stream. |
| get_image_stream | Returns the image stream in a different format. |
| save | Saves the image to the file. |
| save | Saves the image to the file in a different format. |

##### Remarks

An instance of `PageImageArea` class is used as return value
of the following methods:

|
|
 |
 |
 |
 |

See the usage examples there.

### PageImageArea constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/__init__.md

#### __init__

Initializes a new instance of the `PageImageArea` class.

```python
def __init__(self, image_stream, file_type, rotation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The stream of the image. |
| file_type | groupdocs.parser.options.FileType | The format of the image. |
| rotation | float | The rotation angle of the image. |

#### __init__

Initializes a new instance of the `PageImageArea` class.

```python
def __init__(self, image_stream, file_type, rotation, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The stream of the image. |
| file_type | groupdocs.parser.options.FileType | The format of the image. |
| rotation | float | The rotation angle of the image. |
| page | groupdocs.parser.data.Page | The page that contains the image. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the image. |

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/file_type.md

#### file_type property

Gets the format of the image.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### get_image_stream method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/get_image_stream.md

#### get_image_stream

Returns the image stream.

##### Returns

A stream with the image.

```python
def get_image_stream(self):
    ...
```

##### Example

The following example shows how to save images to files:

#### get_image_stream

Returns the image stream in a different format.

##### Returns

A stream with the image.

```python
def get_image_stream(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.ImageOptions | The options which are used to extract the image. |

##### Example

The following example shows how to save images to files in a different format:

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/rectangle.md

#### rectangle property

Gets the rectangular area.

### rotation property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/rotation.md

#### rotation property

Gets the rotation angle of the image.
##### Definition:
```python
@property
def rotation(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pageimagearea/save.md

#### save

Saves the image to the file.

```python
def save(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |

##### Example

The following example shows how to save images to files:

#### save

Saves the image to the file in a different format.

```python
def save(self, file_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
| options | groupdocs.parser.options.ImageOptions | The options which are used to save the image. |

##### Example

The following example shows how to save images to files in a different format:

### PageTableArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea.md

#### PageTableArea class

Represents a table page area which is used to represent a table in the parsing by template functionality.

**Inheritance:** `PageTableArea` →
`PageArea`

The PageTableArea type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| row_count | Gets the total number of the table rows. |
| column_count | Gets the total number of the table colums. |
| cells | Gets the collection of cells. |

##### Methods
| Method | Description |
| :- | :- |
| get_row_height | Returns the row height. |
| get_column_width | Returns the column width. |

##### Remarks

`PageTableArea` class is used to organize inheritors of `PageArea` class
in table structure.

### cells property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/cells.md

#### cells property

Gets the collection of cells.
##### Definition:
```python
@property
def cells(self):
    ...
```

### column_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/column_count.md

#### column_count property

Gets the total number of the table colums.
##### Definition:
```python
@property
def column_count(self):
    ...
```

### get_column_width method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/get_column_width.md

#### get_column_width

Returns the column width.

##### Returns

A double value that represents the width of the column.

```python
def get_column_width(self, column_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| column_index | int | The zero-based index of the column. |

### get_row_height method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/get_row_height.md

#### get_row_height

Returns the row height.

##### Returns

A double value that represents the height of the row.

```python
def get_row_height(self, row_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row_index | int | The zero-based index of the row. |

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/rectangle.md

#### rectangle property

Gets the rectangular area.

### row_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetablearea/row_count.md

#### row_count property

Gets the total number of the table rows.
##### Definition:
```python
@property
def row_count(self):
    ...
```

### PageTableAreaCell class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell.md

#### PageTableAreaCell class

Represents a table cell which is used in `PageTableArea` class.

The PageTableAreaCell type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageTableAreaCell` class. |
| __init__ | Initializes a new instance of the `PageTableAreaCell` class. |

##### Properties
| Property | Description |
| :- | :- |
| row_index | Gets the row index. |
| column_index | Gets the column index. |
| row_span | Gets the total number of rows that contain the table cell. |
| column_span | Gets the total number of columns that contain the table cell. |
| page_area | Gets the table cell value. |
| text | Gets the table cell text value. |

### PageTableAreaCell constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/__init__.md

#### __init__

Initializes a new instance of the `PageTableAreaCell` class.

```python
def __init__(self, row_index, column_index, page_area):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row_index | int | The zero-based index of the row. |
| column_index | int | The zero-based index of the column. |
| page_area | groupdocs.parser.data.PageArea | The value of the table cell. |

#### __init__

Initializes a new instance of the `PageTableAreaCell` class.

```python
def __init__(self, row_index, column_index, page_area, row_span, column_span):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row_index | int | The zero-based index of the row. |
| column_index | int | The zero-based index of the column. |
| page_area | groupdocs.parser.data.PageArea | The value of the table cell. |
| row_span | int | The total number of rows that contain the table cell. |
| column_span | int | The total number of columns that contain the table cell. |

### column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/column_index.md

#### column_index property

Gets the column index.
##### Definition:
```python
@property
def column_index(self):
    ...
@column_index.setter
def column_index(self, value):
    ...
```

### column_span property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/column_span.md

#### column_span property

Gets the total number of columns that contain the table cell.
##### Definition:
```python
@property
def column_span(self):
    ...
@column_span.setter
def column_span(self, value):
    ...
```

### page_area property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/page_area.md

#### page_area property

Gets the table cell value.

##### Remarks

Depending on cell `PageTableAreaCell.page_area` property
can contain any of the inheritors of `PageArea` class.
##### Definition:
```python
@property
def page_area(self):
    ...
@page_area.setter
def page_area(self, value):
    ...
```

### row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/row_index.md

#### row_index property

Gets the row index.
##### Definition:
```python
@property
def row_index(self):
    ...
@row_index.setter
def row_index(self, value):
    ...
```

### row_span property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/row_span.md

#### row_span property

Gets the total number of rows that contain the table cell.
##### Definition:
```python
@property
def row_span(self):
    ...
@row_span.setter
def row_span(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetableareacell/text.md

#### text property

Gets the table cell text value.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### PageTextArea class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea.md

#### PageTextArea class

Represents a page text area which is used to represent a text value in the parsing by template or parsing form functionality.

**Inheritance:** `PageTextArea` →
`PageArea`

The PageTextArea type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageTextArea` class. |
| __init__ | Constructs a new instance of PageTextArea |
| __init__ | Constructs a new instance of PageTextArea |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area. |
| page | Gets the document page information such as page index and page size. |
| text | Gets the text. |
| base_line | Gets the base line. |
| text_style | Gets the text style such as font size, font name an so on. |
| areas | Gets the collection of child text page areas. |

##### Remarks

An instance of `PageTextArea` class is used as return value
of the following methods:

|
|
 |
 |
 |
 |

Also an instance of `PageTextArea` class is used as value
of `FieldData.page_area` property.

See the usage examples there.

The text area can be single or composite.
In the first case it contains a text which is bounded by a rectangular area.
In the second case it contains other text areas; text and table properties are calculated by child text areas.

### PageTextArea constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/__init__.md

#### __init__

Constructs a new instance of PageTextArea

```python
def __init__(self, areas, page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| areas | list |  |
| page | groupdocs.parser.data.Page |  |

#### __init__

Initializes a new instance of the `PageTextArea` class.

```python
def __init__(self, text, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The value of the text. |
| page | groupdocs.parser.data.Page | The page that contains the text area. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the text area. |

#### __init__

Constructs a new instance of PageTextArea

```python
def __init__(self, text, base_line, text_style, page, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String |  |
| base_line | System.Nullable`1[[System.Double]] |  |
| text_style | groupdocs.parser.data.TextStyle |  |
| page | groupdocs.parser.data.Page |  |
| rectangle | groupdocs.parser.data.Rectangle |  |

### areas property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/areas.md

#### areas property

Gets the collection of child text page areas.
##### Definition:
```python
@property
def areas(self):
    ...
@areas.setter
def areas(self, value):
    ...
```

### base_line property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/base_line.md

#### base_line property

Gets the base line.
##### Definition:
```python
@property
def base_line(self):
    ...
@base_line.setter
def base_line(self, value):
    ...
```

### page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/page.md

#### page property

Gets the document page information such as page index and page size.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/rectangle.md

#### rectangle property

Gets the rectangular area.

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/text.md

#### text property

Gets the text.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### text_style property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/pagetextarea/text_style.md

#### text_style property

Gets the text style such as font size, font name an so on.
##### Definition:
```python
@property
def text_style(self):
    ...
@text_style.setter
def text_style(self, value):
    ...
```

### Point class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point.md

#### Point class

Represents a point.

The Point type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Point` class. |

##### Properties
| Property | Description |
| :- | :- |
| x | Gets the x-coordinate. |
| y | Gets the y-coordinate. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Converts the string representation of a point to its class equivalent. |
| try_parse | Converts the string representation of a point to its class equivalent.
<br/>A return value indicates whether the conversion is succeeded or failed. |
| equals | Determines whether the current `Point` is the same as specified `Point` object. |

### Point constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/__init__.md

#### __init__

Initializes a new instance of the `Point` class.

```python
def __init__(self, x, y):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| x | float | The x-coordinate. |
| y | float | The y-coordinate. |

### equals method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/equals.md

#### equals

Determines whether the current `Point` is the same as specified `Point` object.

##### Returns

if both `Point` objects are the same; otherwise,

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.parser.data.Point | The object to compare with the current `Point` object. |

### parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/parse.md

#### parse

Converts the string representation of a point to its class equivalent.

##### Returns

An instance of `Point` class that is equivalent to the value specified in `s` parameter.

```python
def parse(self, s):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string that contains a point to convert. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | `s` does not represent a point in a valid format. |

### try_parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/try_parse.md

#### try_parse

Converts the string representation of a point to its class equivalent.
A return value indicates whether the conversion is succeeded or failed.

##### Returns

`true` if `s` is converted successfully; otherwise, `false`.

```python
def try_parse(self, s, point):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string containing a point to convert. |
| point | any | When the method returns, it contains the instance of `Point` class
<br/>that is equivalent to the value specified in `s` parameter, if the conversion is succeeded; otherwise, `null`. |

### x property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/x.md

#### x property

Gets the x-coordinate.
##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/point/y.md

#### y property

Gets the y-coordinate.
##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### Rectangle class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle.md

#### Rectangle class

Represents a rectangular area.

The Rectangle type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Rectangle` class. |
| __init__ | Initializes a new instance of the `Rectangle` class. |

##### Properties
| Property | Description |
| :- | :- |
| left | Gets the x-coordinate of the left edge of the rectangular area. |
| top | Gets the y-coordinate of the top edge of the rectangular area. |
| right | Gets the x-coordinate of the right egde of the rectangular area. |
| bottom | Gets the y-coordinate of the bottom edge of the rectangular area. |
| position | Gets the coordinates of the upper-left corner of the rectangular area. |
| size | Gets the size. |

### Rectangle constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/__init__.md

#### __init__

Initializes a new instance of the `Rectangle` class.

```python
def __init__(self, position, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| position | groupdocs.parser.data.Point | The coordinates of the upper-left corner of the rectangular area. |
| size | groupdocs.parser.data.Size | The size of the rectangular area. |

#### __init__

Initializes a new instance of the `Rectangle` class.

```python
def __init__(self, left, top, right, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | float | The x-coordinate of the left edge of the rectangular area. |
| top | float | The y-coordinate of the top edge of the rectangular area. |
| right | float | The x-coordinate of the right edge of the rectangular area. |
| bottom | float | The y-coordinate of the bottom edge of the rectangular area. |

### bottom property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/bottom.md

#### bottom property

Gets the y-coordinate of the bottom edge of the rectangular area.
##### Definition:
```python
@property
def bottom(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/left.md

#### left property

Gets the x-coordinate of the left edge of the rectangular area.
##### Definition:
```python
@property
def left(self):
    ...
```

### position property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/position.md

#### position property

Gets the coordinates of the upper-left corner of the rectangular area.
##### Definition:
```python
@property
def position(self):
    ...
@position.setter
def position(self, value):
    ...
```

### right property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/right.md

#### right property

Gets the x-coordinate of the right egde of the rectangular area.
##### Definition:
```python
@property
def right(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/size.md

#### size property

Gets the size.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/rectangle/top.md

#### top property

Gets the y-coordinate of the top edge of the rectangular area.
##### Definition:
```python
@property
def top(self):
    ...
```

### SearchResult class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult.md

#### SearchResult class

Represents the search result in the search functionality.

The SearchResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| position | Gets the position in the document text. |
| text | Gets the text. |
| page_index | Gets the page index where the text is found. |
| left_highlight_item | Gets the left highlight. |
| right_highlight_item | Gets the right highlight. |

##### Remarks

An instance of `SearchResult` class is used as return value
of `Parser.search` and `Parser.search` methods.
See the usage examples there.

### left_highlight_item property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult/left_highlight_item.md

#### left_highlight_item property

Gets the left highlight.
##### Definition:
```python
@property
def left_highlight_item(self):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult/page_index.md

#### page_index property

Gets the page index where the text is found.
##### Definition:
```python
@property
def page_index(self):
    ...
```

### position property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult/position.md

#### position property

Gets the position in the document text.
##### Definition:
```python
@property
def position(self):
    ...
```

### right_highlight_item property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult/right_highlight_item.md

#### right_highlight_item property

Gets the right highlight.
##### Definition:
```python
@property
def right_highlight_item(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/searchresult/text.md

#### text property

Gets the text.
##### Definition:
```python
@property
def text(self):
    ...
```

### Size class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size.md

#### Size class

Represents a size.

The Size type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Size` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_empty | Gets a value that indicates whether the size is empty. |
| width | Gets the width. |
| height | Gets the height. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Converts the string representation of a size to its class equivalent. |
| try_parse | Converts the string representation of a size to its class equivalent.
<br/>A return value indicates whether the conversion is succeeded or failed. |

### Size constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/__init__.md

#### __init__

Initializes a new instance of the `Size` class.

```python
def __init__(self, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | float | The width in pixels. |
| height | float | The height in pixels. |

### height property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/height.md

#### height property

Gets the height.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### is_empty property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/is_empty.md

#### is_empty property

Gets a value that indicates whether the size is empty.
##### Definition:
```python
@property
def is_empty(self):
    ...
```

### parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/parse.md

#### parse

Converts the string representation of a size to its class equivalent.

##### Returns

An instance of `Size` class that is equivalent to the value specified in `s` parameter.

```python
def parse(self, s):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string that contains a size to convert. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | `s` does not represent a size in a valid format. |

### try_parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/try_parse.md

#### try_parse

Converts the string representation of a size to its class equivalent.
A return value indicates whether the conversion is succeeded or failed.

##### Returns

`true` if `s` is converted successfully; otherwise, `false`.

```python
def try_parse(self, s, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string containing a size to convert. |
| size | any | When the method returns, it contains the instance of `Size` class
<br/>that is equivalent to the value specified in `s` parameter, if the conversion is succeeded; otherwise, `null`. |

### width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/size/width.md

#### width property

Gets the width.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### TextStyle class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle.md

#### TextStyle class

Represents the style of the text such as a font name, a font size and so on.

The TextStyle type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextStyle` class. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the style name. |
| font_name | Gets the font name. |
| font_size | Gets the font size. |
| is_bold | Gets the value that indicates whether the font is bold. |
| is_italic | Gets a value that indicates whether the font is italic. |

### TextStyle constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/__init__.md

#### __init__

Initializes a new instance of the `TextStyle` class.

```python
def __init__(self, name, font_name, font_size, is_bold, is_italic):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The name of the style. |
| font_name | System.String | The name of the font. |
| font_size | float | The size of the font. |
| is_bold | bool | The value that indicates whether the font is bold. |
| is_italic | bool | The value that indicates whether the font is italic. |

### font_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/font_name.md

#### font_name property

Gets the font name.
##### Definition:
```python
@property
def font_name(self):
    ...
@font_name.setter
def font_name(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/font_size.md

#### font_size property

Gets the font size.
##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### is_bold property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/is_bold.md

#### is_bold property

Gets the value that indicates whether the font is bold.
##### Definition:
```python
@property
def is_bold(self):
    ...
@is_bold.setter
def is_bold(self, value):
    ...
```

### is_italic property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/is_italic.md

#### is_italic property

Gets a value that indicates whether the font is italic.
##### Definition:
```python
@property
def is_italic(self):
    ...
@is_italic.setter
def is_italic(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/textstyle/name.md

#### name property

Gets the style name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### TocItem class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/tocitem.md

#### TocItem class

Represents the item which is used in the table of contents extraction functionality.

The TocItem type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of TocItem |

##### Properties
| Property | Description |
| :- | :- |
| depth | Gets the depth level. |
| page_index | Gets the page index. |
| text | Gets the text. |

##### Remarks

An instance of `TocItem` class is used as return value
of `Parser.get_toc` methods. See the usage examples there.

### TocItem constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/tocitem/__init__.md

#### __init__

Constructs a new instance of TocItem

```python
def __init__(self, depth, text, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| depth | int |  |
| text | System.String |  |
| page_index | System.Nullable`1[[System.Int32]] |  |

### depth property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/tocitem/depth.md

#### depth property

Gets the depth level.
##### Definition:
```python
@property
def depth(self):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/tocitem/page_index.md

#### page_index property

Gets the page index.
##### Definition:
```python
@property
def page_index(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/tocitem/text.md

#### text property

Gets the text.
##### Definition:
```python
@property
def text(self):
    ...
```

### WorksheetCell class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell.md

#### WorksheetCell class

Represents a worksheet cell.

The WorksheetCell type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WorksheetCell` class. |
| __init__ | Initializes a new instance of the `WorksheetCell` class. |

##### Properties
| Property | Description |
| :- | :- |
| worksheet_index | Gets the worksheet index. |
| row_index | Gets the row index. |
| column_index | Gets the column index. |
| row_span | Gets the total number of rows that contain the cell. |
| column_span | Gets the total number of columns that contain the cell. |
| text | Gets the worksheet cell text value. |

### WorksheetCell constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/__init__.md

#### __init__

Initializes a new instance of the `WorksheetCell` class.

```python
def __init__(self, worksheet_index, row_index, column_index, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | int | The zero-based index of the worksheet. |
| row_index | int | The zero-based index of the row. |
| column_index | int | The zero-based index of the column. |
| text | System.String | the worksheet cell text value. |

#### __init__

Initializes a new instance of the `WorksheetCell` class.

```python
def __init__(self, worksheet_index, row_index, column_index, row_span, column_span, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | int | The zero-based index of the worksheet. |
| row_index | int | The zero-based index of the row. |
| column_index | int | The zero-based index of the column. |
| row_span | int | The total number of rows that contain the cell. |
| column_span | int | The total number of columns that contain the cell. |
| text | System.String | the worksheet cell text value. |

### column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/column_index.md

#### column_index property

Gets the column index.
##### Definition:
```python
@property
def column_index(self):
    ...
```

### column_span property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/column_span.md

#### column_span property

Gets the total number of columns that contain the cell.
##### Definition:
```python
@property
def column_span(self):
    ...
```

### row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/row_index.md

#### row_index property

Gets the row index.
##### Definition:
```python
@property
def row_index(self):
    ...
```

### row_span property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/row_span.md

#### row_span property

Gets the total number of rows that contain the cell.
##### Definition:
```python
@property
def row_span(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/text.md

#### text property

Gets the worksheet cell text value.
##### Definition:
```python
@property
def text(self):
    ...
```

### worksheet_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetcell/worksheet_index.md

#### worksheet_index property

Gets the worksheet index.
##### Definition:
```python
@property
def worksheet_index(self):
    ...
```

### WorksheetInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo.md

#### WorksheetInfo class

Represents a sheet info.

The WorksheetInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WorksheetInfo` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_empty | Gets a value that indicates whether the worksheet is empty. |
| index | Gets an index of the worksheet. |
| min_row_index | Gets an index of the first row. |
| max_row_index | Gets an index of the last row. |
| min_column_index | Gets an index of the first column. |
| max_column_index | Gets an index of the last column. |
| name | Gets a name of the worksheet. |

### WorksheetInfo constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/__init__.md

#### __init__

Initializes a new instance of the `WorksheetInfo` class.

```python
def __init__(self, index, name, range):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The zero-based index of the worksheet. |
| name | System.String | A string value that represents the worksheet name. |
| range | groupdocs.parser.data.WorksheetRange | An instance of `WorksheetRange` class that represents the size of the worksheet. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentOutOfRangeException | An index of the worksheet can't be negative. |
| ArgumentNullException | The size of the worksheet can't be `null`. |

### index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/index.md

#### index property

Gets an index of the worksheet.
##### Definition:
```python
@property
def index(self):
    ...
```

### is_empty property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/is_empty.md

#### is_empty property

Gets a value that indicates whether the worksheet is empty.
##### Definition:
```python
@property
def is_empty(self):
    ...
```

### max_column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/max_column_index.md

#### max_column_index property

Gets an index of the last column.
##### Definition:
```python
@property
def max_column_index(self):
    ...
```

### max_row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/max_row_index.md

#### max_row_index property

Gets an index of the last row.
##### Definition:
```python
@property
def max_row_index(self):
    ...
```

### min_column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/min_column_index.md

#### min_column_index property

Gets an index of the first column.
##### Definition:
```python
@property
def min_column_index(self):
    ...
```

### min_row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/min_row_index.md

#### min_row_index property

Gets an index of the first row.
##### Definition:
```python
@property
def min_row_index(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetinfo/name.md

#### name property

Gets a name of the worksheet.
##### Definition:
```python
@property
def name(self):
    ...
```

### WorksheetRange class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange.md

#### WorksheetRange class

Provides the range which are used for the worksheet extraction.

The WorksheetRange type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WorksheetRange` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_empty | Gets a value that indicates whether the range is empty. |
| min_row_index | Gets an index of the first row. |
| max_row_index | Gets an index of the last row. |
| min_column_index | Gets an index of the first column. |
| max_column_index | Gets an index of the last column. |

### WorksheetRange constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/__init__.md

#### __init__

Initializes a new instance of the `WorksheetRange` class.

```python
def __init__(self, min_row_index, max_row_index, min_column_index, max_column_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| min_row_index | int | The zero-based index of the first row. |
| max_row_index | int | The zero-based index of the last row. |
| min_column_index | int | The zero-based index of the first column. |
| max_column_index | int | The zero-based index of the last column. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentOutOfRangeException |  |

### is_empty property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/is_empty.md

#### is_empty property

Gets a value that indicates whether the range is empty.
##### Definition:
```python
@property
def is_empty(self):
    ...
```

### max_column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/max_column_index.md

#### max_column_index property

Gets an index of the last column.
##### Definition:
```python
@property
def max_column_index(self):
    ...
```

### max_row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/max_row_index.md

#### max_row_index property

Gets an index of the last row.
##### Definition:
```python
@property
def max_row_index(self):
    ...
```

### min_column_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/min_column_index.md

#### min_column_index property

Gets an index of the first column.
##### Definition:
```python
@property
def min_column_index(self):
    ...
```

### min_row_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.data/worksheetrange/min_row_index.md

#### min_row_index property

Gets an index of the first row.
##### Definition:
```python
@property
def min_row_index(self):
    ...
```

### groupdocs.parser.exceptions
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions.md

The namespace provides different exceptions classes.

##### Classes
| Class | Description |
| :- | :- |
| `CorruptedDocumentException` | Thrown during document load, when the document is corrupted. |
| `GroupDocsParserException` | Represents the errors that occur during application execution. |
| `InvalidPasswordException` | Thrown if a document is encrypted with a password and the password specified
<br/>when opening the document is incorrect or missing. |
| `UnsupportedDocumentFormatException` | Thrown during document load, when the document format is not recognized or not supported. |

### CorruptedDocumentException class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/corrupteddocumentexception.md

#### CorruptedDocumentException class

Thrown during document load, when the document is corrupted.

**Inheritance:** `CorruptedDocumentException` →
`GroupDocsParserException`

The CorruptedDocumentException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `CorruptedDocumentException` class. |
| __init__ | Initializes a new instance of the `CorruptedDocumentException` class with the message. |

### CorruptedDocumentException constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/corrupteddocumentexception/__init__.md

#### __init__

Initializes a new instance of the `CorruptedDocumentException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `CorruptedDocumentException` class with the message.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### GroupDocsParserException class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/groupdocsparserexception.md

#### GroupDocsParserException class

Represents the errors that occur during application execution.

The GroupDocsParserException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `GroupDocsParserException` class. |
| __init__ | Initializes a new instance of the `GroupDocsParserException` class. |

### GroupDocsParserException constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/groupdocsparserexception/__init__.md

#### __init__

Initializes a new instance of the `GroupDocsParserException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `GroupDocsParserException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### InvalidPasswordException class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

Thrown if a document is encrypted with a password and the password specified
when opening the document is incorrect or missing.

**Inheritance:** `InvalidPasswordException` →
`GroupDocsParserException`

The InvalidPasswordException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `InvalidPasswordException` class. |
| __init__ | Initializes a new instance of the `InvalidPasswordException` class. |

### InvalidPasswordException constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/invalidpasswordexception/__init__.md

#### __init__

Initializes a new instance of the `InvalidPasswordException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `InvalidPasswordException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### UnsupportedDocumentFormatException class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/unsupporteddocumentformatexception.md

#### UnsupportedDocumentFormatException class

Thrown during document load, when the document format is not recognized or not supported.

**Inheritance:** `UnsupportedDocumentFormatException` →
`GroupDocsParserException`

The UnsupportedDocumentFormatException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `UnsupportedDocumentFormatException` class. |
| __init__ | Initializes a new instance of the `UnsupportedDocumentFormatException` class. |

### UnsupportedDocumentFormatException constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.exceptions/unsupporteddocumentformatexception/__init__.md

#### __init__

Initializes a new instance of the `UnsupportedDocumentFormatException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `UnsupportedDocumentFormatException` class.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### groupdocs.parser.export
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export.md

The namespace provides classes that allow users to export data to different formats.

##### Classes
| Class | Description |
| :- | :- |
| `ExporterBase` | Provides the base class for the data export functionality. |
| `Extensions` | Provides extensions methods for the data export functionality. |
| `JsonExporter` | Provides the functionality to export data in JSON format. |
| `XmlExporter` | Provides the functionality to export data in XML format. |

### ExporterBase class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/exporterbase.md

#### ExporterBase class

Provides the base class for the data export functionality.

The ExporterBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| export |  |
| export |  |
| export | Exports the document information to the stream. |
| export | Exports the document information to the file. |
| export |  |
| export |  |
| export |  |
| export |  |
| export |  |
| export |  |
| export | Exports document data to the stream. |
| export | Exports document data to the file. |

### export method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/exporterbase/export.md

#### export

```python
def export(self, metadata, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, metadata, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| file_name | System.String |  |

#### export

Exports the document information to the stream.

```python
def export(self, document_info, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| stream | io.RawIOBase | The output stream. |

#### export

Exports the document information to the file.

```python
def export(self, document_info, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| file_name | System.String | The full path to the output file. |

#### export

```python
def export(self, text_areas, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, text_areas, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, tables, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, tables, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, barcodes, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, barcodes, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| file_name | System.String |  |

#### export

Exports document data to the stream.

```python
def export(self, document_data, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| stream | io.RawIOBase | The output stream. |

#### export

Exports document data to the file.

```python
def export(self, document_data, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| file_name | System.String | The full path to the output file. |

### Extensions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/extensions.md

#### Extensions class

Provides extensions methods for the data export functionality.

The Extensions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| export_as_json |  |
| export_as_json |  |
| export_as_json | Exports the document information to the stream in JSON format. |
| export_as_json | Exports the document information to the file in JSON format. |
| export_as_json |  |
| export_as_json |  |
| export_as_json |  |
| export_as_json |  |
| export_as_json |  |
| export_as_json |  |
| export_as_json | Exports document data to the stream in JSON format. |
| export_as_json | Exports document data to the file in JSON format. |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml | Exports the document information to the stream in XML format. |
| export_as_xml | Exports the document information to the file in XML format. |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml |  |
| export_as_xml | Exports document data to the stream in XML format. |
| export_as_xml | Exports document data to the file in XML format. |

### export_as_json method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/extensions/export_as_json.md

#### export_as_json

```python
def export_as_json(self, metadata, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| stream | io.RawIOBase |  |

#### export_as_json

```python
def export_as_json(self, metadata, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| file_name | System.String |  |

#### export_as_json

Exports the document information to the stream in JSON format.

```python
def export_as_json(self, document_info, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| stream | io.RawIOBase | The output stream. |

#### export_as_json

Exports the document information to the file in JSON format.

```python
def export_as_json(self, document_info, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| file_name | System.String | The full path to the output file. |

#### export_as_json

```python
def export_as_json(self, text_areas, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| stream | io.RawIOBase |  |

#### export_as_json

```python
def export_as_json(self, text_areas, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| file_name | System.String |  |

#### export_as_json

```python
def export_as_json(self, tables, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| stream | io.RawIOBase |  |

#### export_as_json

```python
def export_as_json(self, tables, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| file_name | System.String |  |

#### export_as_json

```python
def export_as_json(self, barcodes, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| stream | io.RawIOBase |  |

#### export_as_json

```python
def export_as_json(self, barcodes, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| file_name | System.String |  |

#### export_as_json

Exports document data to the stream in JSON format.

```python
def export_as_json(self, document_data, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| stream | io.RawIOBase | The output stream. |

#### export_as_json

Exports document data to the file in JSON format.

```python
def export_as_json(self, document_data, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| file_name | System.String | The full path to the output file. |

### export_as_xml method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/extensions/export_as_xml.md

#### export_as_xml

```python
def export_as_xml(self, metadata, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| stream | io.RawIOBase |  |

#### export_as_xml

```python
def export_as_xml(self, metadata, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| file_name | System.String |  |

#### export_as_xml

Exports the document information to the stream in XML format.

```python
def export_as_xml(self, document_info, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| stream | io.RawIOBase | The output stream. |

#### export_as_xml

Exports the document information to the file in XML format.

```python
def export_as_xml(self, document_info, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| file_name | System.String | The full path to the output file. |

#### export_as_xml

```python
def export_as_xml(self, text_areas, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| stream | io.RawIOBase |  |

#### export_as_xml

```python
def export_as_xml(self, text_areas, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| file_name | System.String |  |

#### export_as_xml

```python
def export_as_xml(self, tables, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| stream | io.RawIOBase |  |

#### export_as_xml

```python
def export_as_xml(self, tables, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| file_name | System.String |  |

#### export_as_xml

```python
def export_as_xml(self, barcodes, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| stream | io.RawIOBase |  |

#### export_as_xml

```python
def export_as_xml(self, barcodes, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| file_name | System.String |  |

#### export_as_xml

Exports document data to the stream in XML format.

```python
def export_as_xml(self, document_data, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| stream | io.RawIOBase | The output stream. |

#### export_as_xml

Exports document data to the file in XML format.

```python
def export_as_xml(self, document_data, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| file_name | System.String | The full path to the output file. |

### JsonExporter class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/jsonexporter.md

#### JsonExporter class

Provides the functionality to export data in JSON format.

**Inheritance:** `JsonExporter` →
`ExporterBase`

The JsonExporter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of JsonExporter |

##### Methods
| Method | Description |
| :- | :- |
| export |  |
| export | Exports the document information to the stream. |
| export |  |
| export |  |
| export |  |
| export | Exports document data to the stream. |
| export |  |
| export | Exports the document information to the file. |
| export |  |
| export |  |
| export |  |
| export | Exports document data to the file. |

### JsonExporter constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/jsonexporter/__init__.md

#### __init__

Constructs a new instance of JsonExporter

```python
def __init__(self):
    ...
```

### export method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/jsonexporter/export.md

#### export

```python
def export(self, metadata, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| stream | io.RawIOBase |  |

#### export

Exports the document information to the stream.

```python
def export(self, document_info, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| stream | io.RawIOBase | The output stream. |

#### export

```python
def export(self, text_areas, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, tables, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, barcodes, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| stream | io.RawIOBase |  |

#### export

Exports document data to the stream.

```python
def export(self, document_data, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| stream | io.RawIOBase | The output stream. |

#### export

```python
def export(self, metadata, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| file_name | System.String |  |

#### export

Exports the document information to the file.

```python
def export(self, document_info, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| file_name | System.String | The full path to the output file. |

#### export

```python
def export(self, text_areas, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, tables, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, barcodes, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| file_name | System.String |  |

#### export

Exports document data to the file.

```python
def export(self, document_data, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| file_name | System.String | The full path to the output file. |

### XmlExporter class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/xmlexporter.md

#### XmlExporter class

Provides the functionality to export data in XML format.

**Inheritance:** `XmlExporter` →
`ExporterBase`

The XmlExporter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of XmlExporter |

##### Methods
| Method | Description |
| :- | :- |
| export |  |
| export | Exports the document information to the stream. |
| export |  |
| export |  |
| export |  |
| export | Exports document data to the stream. |
| export |  |
| export | Exports the document information to the file. |
| export |  |
| export |  |
| export |  |
| export | Exports document data to the file. |

### XmlExporter constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/xmlexporter/__init__.md

#### __init__

Constructs a new instance of XmlExporter

```python
def __init__(self):
    ...
```

### export method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.export/xmlexporter/export.md

#### export

```python
def export(self, metadata, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| stream | io.RawIOBase |  |

#### export

Exports the document information to the stream.

```python
def export(self, document_info, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| stream | io.RawIOBase | The output stream. |

#### export

```python
def export(self, text_areas, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, tables, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| stream | io.RawIOBase |  |

#### export

```python
def export(self, barcodes, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| stream | io.RawIOBase |  |

#### export

Exports document data to the stream.

```python
def export(self, document_data, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| stream | io.RawIOBase | The output stream. |

#### export

```python
def export(self, metadata, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata | list |  |
| file_name | System.String |  |

#### export

Exports the document information to the file.

```python
def export(self, document_info, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_info | groupdocs.parser.options.IDocumentInfo | The document information. |
| file_name | System.String | The full path to the output file. |

#### export

```python
def export(self, text_areas, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text_areas | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, tables, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tables | list |  |
| file_name | System.String |  |

#### export

```python
def export(self, barcodes, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| barcodes | list |  |
| file_name | System.String |  |

#### export

Exports document data to the file.

```python
def export(self, document_data, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document_data | groupdocs.parser.data.DocumentData | Document data. |
| file_name | System.String | The full path to the output file. |

### groupdocs.parser.options
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options.md

The namespace provides classes to specify additional options when parsing data from documents.

##### Classes
| Class | Description |
| :- | :- |
| `AdjustmentFieldsOptions` | Provides the options which are used to generate the adjustment fields. |
| `BarcodeOptions` | Provides the options which are used for barcode extraction. |
| `DocumentInfo` | Represents the document information. |
| `EmailConnection` | Represents the email connection information. |
| `EmailEwsConnection` | Represents the email connection information for EWS protocol. |
| `EmailImapConnection` | Represents the email connection information for IMAP protocol. |
| `EmailPopConnection` | Represents the email connection information for POP protocol. |
| `ExternalResourceHandler` | Provides a handler for external resources loading. |
| `ExternalResourceLoadingArgs` | Provides the data for `ExternalResourceHandler.on_loading` method. |
| `Features` | Represents the supported features list. Allows to obtain information which features are supported or not for the document. |
| `FileInfo` | Represents the file information. |
| `FileType` | Represents the file type. Provides methods to obtain list of all file types supported by **GroupDocs.Parser** . |
| `FormattedTextOptions` | Provides the options which are used for formatted text extraction. |
| `HighlightOptions` | Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios). |
| `ICreatePageStream` | Represents a delegate that returns a stream to write page preview data. |
| `IDocumentInfo` | Represents the document information. |
| `ILogger` | Defines the interface of a logger that is used for logging events and errors during data extraction. |
| `IPreviewPageRender` | Represents a method which is called before a document page is rendered. |
| `IReleasePageStream` | Represents a method which releases the stream created by the CreatePageStream delegate. |
| `ImageOptions` | Provides the options which are used for image extraction. |
| `LoadOptions` | Provides the options which are used to open a file. |
| `OcrConnectorBase` | Provides the OCR functionality. |
| `OcrEventHandler` | Provides a handler for OCR events. |
| `OcrOptions` | Provides the options which are used for OCR Connector. |
| `PageAreaOptions` | Provides the options which are used for page areas extraction. |
| `PageInfo` | Represents the document page information. |
| `PagePreviewOptions` | Provides the options which are used to generate the document page preview. |
| `PageRenderInfo` | Represents the information of how a page is rendered. |
| `PageTableAreaOptions` | Provides the options which are used for page table areas extraction. |
| `PageTextAreaOptions` | Provides the options which are used for page text areas extraction. |
| `ParseByTemplateOptions` | Provides the options which are used to parse by template. |
| `ParserSettings` | Provides the settings which are used to customize data extraction. |
| `PreviewOptions` | Provides options to sets requirements and stream delegates for preview generation. |
| `SearchOptions` | Provides the options which are used for text search. |
| `TextDocumentInfo` | Represents the text document information. |
| `TextOptions` | Provides the options which are used for text extraction. |
| `WorksheetOptions` | Provides the options which are used for the worksheet extraction. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `FileFormat` | Defines a type of the file. |
| `FileTypeDetectionMode` | Defines a mode of the file type detection. |
| `FormattedTextMode` | Defines a formatted text mode. |
| `ImageFormat` | Defines a format of the image. |
| `PagePreviewFormat` | Represents supported preview formats. |
| `QualityMode` | Defines a level of the quality. |

### AdjustmentFieldsOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions.md

#### AdjustmentFieldsOptions class

Provides the options which are used to generate the adjustment fields.

The AdjustmentFieldsOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `AdjustmentFieldsOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| ocr_options | Gets or sets the additional options for OCR functionality.
<br/>The default value is `null`. |
| requested_page_width | Gets or sets the requested page width value.
<br/>This value is used to scale the template fields to the desired page size.
<br/>The default value is `null` which means no scaling is made. |
| field_name_prefix | Gets or sets the generated field name prefix.
<br/>The default value is `"Generated"`. |
| page_index | Gets or sets index of the page for which the adjustment fields are to be generated.
<br/>The default value is `0`. |

### AdjustmentFieldsOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions/__init__.md

#### __init__

Initializes a new instance of the `AdjustmentFieldsOptions` class.

```python
def __init__(self):
    ...
```

### field_name_prefix property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions/field_name_prefix.md

#### field_name_prefix property

Gets or sets the generated field name prefix.
The default value is `"Generated"`.
##### Definition:
```python
@property
def field_name_prefix(self):
    ...
@field_name_prefix.setter
def field_name_prefix(self, value):
    ...
```

### ocr_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions/ocr_options.md

#### ocr_options property

Gets or sets the additional options for OCR functionality.
The default value is `null`.
##### Definition:
```python
@property
def ocr_options(self):
    ...
@ocr_options.setter
def ocr_options(self, value):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions/page_index.md

#### page_index property

Gets or sets index of the page for which the adjustment fields are to be generated.
The default value is `0`.
##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### requested_page_width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/adjustmentfieldsoptions/requested_page_width.md

#### requested_page_width property

Gets or sets the requested page width value.
This value is used to scale the template fields to the desired page size.
The default value is `null` which means no scaling is made.
##### Definition:
```python
@property
def requested_page_width(self):
    ...
@requested_page_width.setter
def requested_page_width(self, value):
    ...
```

### BarcodeOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions.md

#### BarcodeOptions class

Provides the options which are used for barcode extraction.

The BarcodeOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `BarcodeOptions` class with default values. |
| __init__ | Initializes a new instance of the `BarcodeOptions` class with the rectangular area. |
| __init__ | Initializes a new instance of the `BarcodeOptions` class with quality settings and code types. |
| __init__ | Constructs a new instance of BarcodeOptions |

##### Properties
| Property | Description |
| :- | :- |
| allow_incorrect_barcodes | Gets the value that indicates whether the incorrect barcodes are allowed. |
| dimension | Gets the minimal size of the barcode minimal element. |
| image_quality | Gets the quality of a source image. |
| barcode_quality | Gets the quality of a source barcode. |
| rectangle | Gets the rectangular area that contains page areas. |
| code_types | Gets the types of barcodes to read. |
| page_preview_options | Gets or sets the document page preview options. |

### BarcodeOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/__init__.md

#### __init__

Initializes a new instance of the `BarcodeOptions` class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `BarcodeOptions` class with the rectangular area.

```python
def __init__(self, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains barcodes. |

#### __init__

Initializes a new instance of the `BarcodeOptions` class with quality settings and code types.

```python
def __init__(self, image_quality, barcode_quality, code_types):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_quality | groupdocs.parser.options.QualityMode | The quality of a source image. |
| barcode_quality | groupdocs.parser.options.QualityMode | The quality of a source barcode. |
| code_types | list | The types of barcodes to read. |

#### __init__

Constructs a new instance of BarcodeOptions

```python
def __init__(self, rectangle, image_quality, barcode_quality, dimension, allow_incorrect_barcodes, code_types):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle |  |
| image_quality | groupdocs.parser.options.QualityMode |  |
| barcode_quality | groupdocs.parser.options.QualityMode |  |
| dimension | System.Nullable`1[[System.Single]] |  |
| allow_incorrect_barcodes | bool |  |
| code_types | list |  |

### allow_incorrect_barcodes property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/allow_incorrect_barcodes.md

#### allow_incorrect_barcodes property

Gets the value that indicates whether the incorrect barcodes are allowed.
##### Definition:
```python
@property
def allow_incorrect_barcodes(self):
    ...
@allow_incorrect_barcodes.setter
def allow_incorrect_barcodes(self, value):
    ...
```

### barcode_quality property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/barcode_quality.md

#### barcode_quality property

Gets the quality of a source barcode.
##### Definition:
```python
@property
def barcode_quality(self):
    ...
@barcode_quality.setter
def barcode_quality(self, value):
    ...
```

### code_types property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/code_types.md

#### code_types property

Gets the types of barcodes to read.
##### Definition:
```python
@property
def code_types(self):
    ...
@code_types.setter
def code_types(self, value):
    ...
```

### dimension property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/dimension.md

#### dimension property

Gets the minimal size of the barcode minimal element.
##### Definition:
```python
@property
def dimension(self):
    ...
@dimension.setter
def dimension(self, value):
    ...
```

### image_quality property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/image_quality.md

#### image_quality property

Gets the quality of a source image.
##### Definition:
```python
@property
def image_quality(self):
    ...
@image_quality.setter
def image_quality(self, value):
    ...
```

### page_preview_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/page_preview_options.md

#### page_preview_options property

Gets or sets the document page preview options.
##### Definition:
```python
@property
def page_preview_options(self):
    ...
@page_preview_options.setter
def page_preview_options(self, value):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/barcodeoptions/rectangle.md

#### rectangle property

Gets the rectangular area that contains page areas.
##### Definition:
```python
@property
def rectangle(self):
    ...
@rectangle.setter
def rectangle(self, value):
    ...
```

### DocumentInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo.md

#### DocumentInfo class

Represents the document information.

The DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | Gets the document type. |
| page_count | Gets the total number of document pages. |
| raw_page_count | Gets the total number of document raw pages. |
| size | Gets the size of the document in bytes. |
| pages | Gets the information about pages such as the index and page size. |

##### Remarks

**Learn more:** |
|
 |
 |

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo/file_type.md

#### file_type property

Gets the document type.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo/page_count.md

#### page_count property

Gets the total number of document pages.
##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo/pages.md

#### pages property

Gets the information about pages such as the index and page size.
##### Definition:
```python
@property
def pages(self):
    ...
```

### raw_page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo/raw_page_count.md

#### raw_page_count property

Gets the total number of document raw pages.

##### Remarks

Use `DocumentInfo.raw_page_count` property instead of `DocumentInfo.page_count` property for raw text extraction.
Some documents have different page numbers in accurate and raw text extraction modes.
`DocumentInfo.page_count` property may perform extra calculations which impacts on text extraction speed in raw mode.
##### Definition:
```python
@property
def raw_page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/documentinfo/size.md

#### size property

Gets the size of the document in bytes.
##### Definition:
```python
@property
def size(self):
    ...
```

### EmailConnection class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailconnection.md

#### EmailConnection class

Represents the email connection information.

The EmailConnection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| user_name | Gets the user name. |
| password | Gets the password. |

### password property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailconnection/password.md

#### password property

Gets the password.
##### Definition:
```python
@property
def password(self):
    ...
```

### user_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailconnection/user_name.md

#### user_name property

Gets the user name.
##### Definition:
```python
@property
def user_name(self):
    ...
```

### EmailEwsConnection class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection.md

#### EmailEwsConnection class

Represents the email connection information for EWS protocol.

**Inheritance:** `EmailEwsConnection` →
`EmailConnection`

The EmailEwsConnection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailEwsConnection` class. |
| __init__ | Initializes a new instance of the `EmailEwsConnection` class. |

##### Properties
| Property | Description |
| :- | :- |
| user_name | Gets the user name. |
| password | Gets the password. |
| mailbox_uri | Gets the URI of the mailbox. |
| domain | Gets the domain name. |

### EmailEwsConnection constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection/__init__.md

#### __init__

Initializes a new instance of the `EmailEwsConnection` class.

```python
def __init__(self, mailbox_uri, user_name, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mailbox_uri | System.String | The URI of mailbox. |
| user_name | System.String | The user name. |
| password | System.String | The password. |

#### __init__

Initializes a new instance of the `EmailEwsConnection` class.

```python
def __init__(self, mailbox_uri, domain, user_name, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mailbox_uri | System.String | The URI of the mailbox. |
| domain | System.String | The domain name. |
| user_name | System.String | The user name. |
| password | System.String | The password. |

### domain property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection/domain.md

#### domain property

Gets the domain name.
##### Definition:
```python
@property
def domain(self):
    ...
```

### mailbox_uri property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection/mailbox_uri.md

#### mailbox_uri property

Gets the URI of the mailbox.
##### Definition:
```python
@property
def mailbox_uri(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection/password.md

#### password property

Gets the password.

### user_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailewsconnection/user_name.md

#### user_name property

Gets the user name.

### EmailImapConnection class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection.md

#### EmailImapConnection class

Represents the email connection information for IMAP protocol.

**Inheritance:** `EmailImapConnection` →
`EmailConnection`

The EmailImapConnection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailImapConnection` class. |

##### Properties
| Property | Description |
| :- | :- |
| user_name | Gets the user name. |
| password | Gets the password. |
| host | Gets the host name. |
| port | Gets the port number. |

### EmailImapConnection constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection/__init__.md

#### __init__

Initializes a new instance of the `EmailImapConnection` class.

```python
def __init__(self, host, port, user_name, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| host | System.String | The host name. |
| port | int | The port number. |
| user_name | System.String | The user name. |
| password | System.String | The password. |

### host property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection/host.md

#### host property

Gets the host name.
##### Definition:
```python
@property
def host(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection/password.md

#### password property

Gets the password.

### port property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection/port.md

#### port property

Gets the port number.
##### Definition:
```python
@property
def port(self):
    ...
```

### user_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailimapconnection/user_name.md

#### user_name property

Gets the user name.

### EmailPopConnection class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection.md

#### EmailPopConnection class

Represents the email connection information for POP protocol.

**Inheritance:** `EmailPopConnection` →
`EmailConnection`

The EmailPopConnection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailPopConnection` class. |

##### Properties
| Property | Description |
| :- | :- |
| user_name | Gets the user name. |
| password | Gets the password. |
| host | Gets the host name. |
| port | Gets the port number. |

### EmailPopConnection constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection/__init__.md

#### __init__

Initializes a new instance of the `EmailPopConnection` class.

```python
def __init__(self, host, port, user_name, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| host | System.String | The host name. |
| port | int | The port number. |
| user_name | System.String | The user name. |
| password | System.String | The password. |

### host property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection/host.md

#### host property

Gets the host name.
##### Definition:
```python
@property
def host(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection/password.md

#### password property

Gets the password.

### port property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection/port.md

#### port property

Gets the port number.
##### Definition:
```python
@property
def port(self):
    ...
```

### user_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/emailpopconnection/user_name.md

#### user_name property

Gets the user name.

### ExternalResourceHandler class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourcehandler.md

#### ExternalResourceHandler class

Provides a handler for external resources loading.

The ExternalResourceHandler type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of ExternalResourceHandler |

##### Methods
| Method | Description |
| :- | :- |
| on_loading | Called before any external resource load. |

### ExternalResourceHandler constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourcehandler/__init__.md

#### __init__

Constructs a new instance of ExternalResourceHandler

```python
def __init__(self):
    ...
```

### on_loading method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourcehandler/on_loading.md

#### on_loading

Called before any external resource load.

```python
def on_loading(self, args):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| args | groupdocs.parser.options.ExternalResourceLoadingArgs | The data to control external resource loading. |

### ExternalResourceLoadingArgs class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourceloadingargs.md

#### ExternalResourceLoadingArgs class

Provides the data for `ExternalResourceHandler.on_loading` method.

The ExternalResourceLoadingArgs type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ExternalResourceLoadingArgs` class. |

##### Properties
| Property | Description |
| :- | :- |
| uri | Gets or sets the URI of the external resource. |
| skipped | Gets or sets the value that indicates whether the loading of the external resource must be skipped. |
| data | Gets or sets the user data. |

### ExternalResourceLoadingArgs constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourceloadingargs/__init__.md

#### __init__

Initializes a new instance of the `ExternalResourceLoadingArgs` class.

```python
def __init__(self, uri):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uri | System.String | URI of the external resource. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | Throws if `uri` is `null` or an empty string. |

### data property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourceloadingargs/data.md

#### data property

Gets or sets the user data.
##### Definition:
```python
@property
def data(self):
    ...
@data.setter
def data(self, value):
    ...
```

### skipped property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourceloadingargs/skipped.md

#### skipped property

Gets or sets the value that indicates whether the loading of the external resource must be skipped.
##### Definition:
```python
@property
def skipped(self):
    ...
@skipped.setter
def skipped(self, value):
    ...
```

### uri property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/externalresourceloadingargs/uri.md

#### uri property

Gets or sets the URI of the external resource.
##### Definition:
```python
@property
def uri(self):
    ...
@uri.setter
def uri(self, value):
    ...
```

### Features class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features.md

#### Features class

Represents the supported features list. Allows to obtain information which features are supported or not for the document.

The Features type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | Gets the value that indicates whether text extraction is supported. |
| text_page | Gets the value that indicates whether text page extraction is supported. |
| formatted_text | Gets the value that indicates whether formatted text extraction is supported. |
| formatted_text_page | Gets the value that indicates whether formatted text page extraction is supported. |
| search | Gets the value that indicates whether text search is supported. |
| highlight | Gets the value that indicates whether highlight extraction is supported. |
| structure | Gets the value that indicates whether text structure extraction is supported. |
| toc | Gets the value that indicates whether table of contents extraction is supported. |
| container | Gets the value that indicates whether container extraction is supported. |
| metadata | Gets the value that indicates whether metadata extraction is supported. |
| text_areas | Gets the value that indicates whether text areas extraction is supported. |
| images | Gets the value that indicates whether images extraction is supported. |
| hyperlinks | Gets the value that indicates whether hyperlinks extraction is supported. |
| barcodes | Gets the value that indicates whether barcodes extraction is supported. |
| tables | Gets the value that indicates whether tables extraction is supported. |
| parse_by_template | Gets the value that indicates whether parsing by template is supported. |
| parse_form | Gets the value that indicates whether form parsing is supported. |
| preview | Gets the value that indicates whether preview generation is supported. |
| page_preview | Gets the value that indicates whether the page preview generation is supported. |
| ocr | Gets the value that indicates whether OCR functionality is supported. |
| worksheet | Gets the value that indicates whether the worksheet extraction is supported. |

##### Methods
| Method | Description |
| :- | :- |
| is_feature_supported | Returns the value that indicates whether the feature is supported. |

##### Remarks

An instance of this class is used as `Parser.features` property.
See the usage examples there.

**Learn more:** |
|
 |

### barcodes property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/barcodes.md

#### barcodes property

Gets the value that indicates whether barcodes extraction is supported.
##### Definition:
```python
@property
def barcodes(self):
    ...
```

### container property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/container.md

#### container property

Gets the value that indicates whether container extraction is supported.
##### Definition:
```python
@property
def container(self):
    ...
```

### formatted_text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/formatted_text.md

#### formatted_text property

Gets the value that indicates whether formatted text extraction is supported.
##### Definition:
```python
@property
def formatted_text(self):
    ...
```

### formatted_text_page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/formatted_text_page.md

#### formatted_text_page property

Gets the value that indicates whether formatted text page extraction is supported.
##### Definition:
```python
@property
def formatted_text_page(self):
    ...
```

### highlight property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/highlight.md

#### highlight property

Gets the value that indicates whether highlight extraction is supported.
##### Definition:
```python
@property
def highlight(self):
    ...
```

### hyperlinks property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/hyperlinks.md

#### hyperlinks property

Gets the value that indicates whether hyperlinks extraction is supported.
##### Definition:
```python
@property
def hyperlinks(self):
    ...
```

### images property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/images.md

#### images property

Gets the value that indicates whether images extraction is supported.
##### Definition:
```python
@property
def images(self):
    ...
```

### is_feature_supported method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/is_feature_supported.md

#### is_feature_supported

Returns the value that indicates whether the feature is supported.

##### Returns

`true` if the feature is supported; otherwise, `false`.

```python
def is_feature_supported(self, feature_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| feature_name | System.String | The feature name. |

### metadata property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/metadata.md

#### metadata property

Gets the value that indicates whether metadata extraction is supported.
##### Definition:
```python
@property
def metadata(self):
    ...
```

### ocr property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/ocr.md

#### ocr property

Gets the value that indicates whether OCR functionality is supported.
##### Definition:
```python
@property
def ocr(self):
    ...
```

### page_preview property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/page_preview.md

#### page_preview property

Gets the value that indicates whether the page preview generation is supported.
##### Definition:
```python
@property
def page_preview(self):
    ...
```

### parse_by_template property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/parse_by_template.md

#### parse_by_template property

Gets the value that indicates whether parsing by template is supported.
##### Definition:
```python
@property
def parse_by_template(self):
    ...
```

### parse_form property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/parse_form.md

#### parse_form property

Gets the value that indicates whether form parsing is supported.
##### Definition:
```python
@property
def parse_form(self):
    ...
```

### preview property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/preview.md

#### preview property

Gets the value that indicates whether preview generation is supported.
##### Definition:
```python
@property
def preview(self):
    ...
```

### search property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/search.md

#### search property

Gets the value that indicates whether text search is supported.
##### Definition:
```python
@property
def search(self):
    ...
```

### structure property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/structure.md

#### structure property

Gets the value that indicates whether text structure extraction is supported.
##### Definition:
```python
@property
def structure(self):
    ...
```

### tables property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/tables.md

#### tables property

Gets the value that indicates whether tables extraction is supported.
##### Definition:
```python
@property
def tables(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/text.md

#### text property

Gets the value that indicates whether text extraction is supported.
##### Definition:
```python
@property
def text(self):
    ...
```

### text_areas property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/text_areas.md

#### text_areas property

Gets the value that indicates whether text areas extraction is supported.
##### Definition:
```python
@property
def text_areas(self):
    ...
```

### text_page property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/text_page.md

#### text_page property

Gets the value that indicates whether text page extraction is supported.
##### Definition:
```python
@property
def text_page(self):
    ...
```

### toc property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/toc.md

#### toc property

Gets the value that indicates whether table of contents extraction is supported.
##### Definition:
```python
@property
def toc(self):
    ...
```

### worksheet property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/features/worksheet.md

#### worksheet property

Gets the value that indicates whether the worksheet extraction is supported.
##### Definition:
```python
@property
def worksheet(self):
    ...
```

### FileFormat enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/fileformat.md

#### FileFormat enumeration

Defines a type of the file.

The FileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Default value. |
| WORD_PROCESSING | Word Processing document (DOC, DOCX, ODT, etc). |
| SPREADSHEET | Spreadsheet document (XLS, XLSX, ODS, etc). |
| PRESENTATION | Presentation document (PPT, PPTX, ODP, etc). |
| EMAIL | Email document (email messages or email message containers). |
| PDF | PDF document. |
| MARKUP | Markup document (HTML, XML, Markdown, etc). |
| EBOOK | Ebook document (ePUB, FictionBook, etc). |
| NOTE | Note document. |
| ARCHIVE | Archive file. |
| DATABASE | Database files (via ADO.NET). |
| IMAGE | Image file. |

##### Remarks

**Learn more:** |
|
 |

### FileInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/fileinfo.md

#### FileInfo class

Represents the file information.

The FileInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | Gets the document type. |
| size | Gets the size of the document in bytes. |
| is_encrypted | Gets a value that represents whether a file is password-protected. |

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/fileinfo/file_type.md

#### file_type property

Gets the document type.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/fileinfo/is_encrypted.md

#### is_encrypted property

Gets a value that represents whether a file is password-protected.
##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/fileinfo/size.md

#### size property

Gets the size of the document in bytes.
##### Definition:
```python
@property
def size(self):
    ...
```

### FileType class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype.md

#### FileType class

Represents the file type. Provides methods to obtain list of all file types supported by **GroupDocs.Parser** .

The FileType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_format | File type name e.g. "Microsoft Word Document". |
| extension | Filename suffix (including the period ".") e.g. ".doc". |
| format | Format of the file e.g. "WordProcessing". |
| UNKNOWN | Represents unknown file type. |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing
<br/>documents in binary file format. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/doc/). |
| DOT | Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings
<br/>for generation of further DOC or DOCX files. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/dot/). |
| DOCX | DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release
<br/>of Microsoft Office 2007, the structure of this new Document format was changed from plain binary
<br/>to a combination of XML and binary files. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/docx/). |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm/). |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings
<br/>for generation of further DOCX files. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/dotx/). |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm/). |
| TXT | A file with .TXT extension represents a text document that contains plain text in the form of lines.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/txt/). |
| TEXT | A file with .TEXT extension represents a text document that contains plain text in the form of lines.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/txt/). |
| ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument
<br/>Text File format. These are created with word processor applications such as free OpenOffice Writer and
<br/>can hold content such as text, images, objects and styles. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/odt/). |
| OTT | Files with OTT extension represent template documents generated by applications in compliance with
<br/>the OASIS' OpenDocument standard format. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/ott/). |
| RTF | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding
<br/>formatted text and graphics for use within applications. The format facilitates cross-platform document
<br/>exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/word-processing/rtf/). |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this
<br/>file format was to introduce a standard for representation of documents and other reference material in
<br/>a format that is independent of application software, hardware as well as Operating System. Learn more
<br/>about this file format [here](https://wiki.fileformat.com/view/pdf/). |
| HTM | Files with HTM extension represent Hypertext Markup Language for creating web pages
<br/>for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/htm/). |
| HTML | HTML (Hyper Text Markup Language) is the extension for web pages created for display in browsers.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/html/). |
| XHTML | The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/xhtml/). |
| MHT | Files with MHT extension represent a web page archive format that can be created
<br/>by a number of different applications. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/mhtml/). |
| MHTML | Files with MHTML extension represent a web page archive format that can be created
<br/>by a number of different applications. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/mhtml/). |
| XML | XML stands for Extensible Markup Language that is similar to HTML
<br/>but different in using tags for defining objects. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/xml/). |
| MD | Text files created with Markdown language dialects is saved with
<br/>.MD or .MARKDOWN file extension. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/word-processing/md/). |
| FB2 | Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/ebook/fb2/). |
| CHM | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/web/chm/). |
| EPUB | Files with .EPUB extension are an e-book file format that provide
<br/>a standard digital publication format for publishers and consumers.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/ebook/epub/). |
| 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.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/ebook/azw3/). |
| MOBI | The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/ebook/mobi/). |
| XLS | Files with XLS extension represent Excel Binary File Format. Such files can be created by Microsoft Excel
<br/>as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xls/). |
| XLSX | XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release
<br/>of Microsoft Office 2007. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xlsx/). |
| XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/). |
| XLSB | XLSB file format specifies the Excel Binary File Format, which is a collection of records and
<br/>structures that specify Excel workbook content. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xlsb/). |
| XLT | Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet
<br/>application which comes as part of Microsoft Office suite. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xlt/). |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML
<br/>file format specifications. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xltx/). |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled
<br/>template files. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/specification/spreadsheet/xltm/). |
| XLA | The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code.
<br/>Supports the use of VBA projects. |
| XLAM | The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007.
<br/>An Add-In is a supplemental program that is designed to run additional code.
<br/>Supports the use of VBA projects and Excel 4.0 macro sheets (.xlm). |
| CSV | Files with CSV (Comma Separated Values) extension represent plain text files
<br/>that contain records of data with comma separated values. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/spreadsheet/csv/). |
| TSV | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/spreadsheet/tsv/). |
| ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/spreadsheet/ods/). |
| OTS | The OTS files contain template files used by the OpenOffice spreadsheet application. |
| NUMBERS | Files that contain the .numbers file extension are files that are created by
<br/>the Apple iWork Numbers spreadsheet application. |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for
<br/>displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt/). |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
<br/>Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based
<br/>on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/pptx/). |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose.
<br/>PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/pps/). |
| PPSX | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for
<br/>Slide Show purpose. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/ppsx/). |
| ODP | Files with ODP extension represent presentation file format used by OpenOffice.org
<br/>in the OASISOpen standard. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/odp/). |
| POT | Files with .POT extension represent Microsoft PowerPoint template files created
<br/>by PowerPoint 97-2003 versions. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/pot/). |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with
<br/>Microsoft PowerPoint 2007 or higher versions. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/pptm/). |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with
<br/>Microsoft PowerPoint 2007 and above. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/potx/). |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files
<br/>are created with PowerPoint 2007 or above and contains default settings that can be used to create
<br/>further presentation files. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/potm/). |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft
<br/>PowerPoint 2007 or higher. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/ppsm/). |
| OTP | Files with .OTP extension represent presentation template files created by applications
<br/>in OASIS OpenDocument standard format. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/presentation/otp/). |
| MSG | MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact,
<br/>appointment, or other tasks. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/email/msg/). |
| EML | EML file format represents email messages saved using Outlook and other relevant applications.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/email/eml/). |
| EMLX | The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX
<br/>file format for exporting the emails. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/email/emlx/). |
| PST | Files with .PST extension represent Outlook Personal Storage Files (also called Personal Storage Table)
<br/>that store variety of user information. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/email/pst/) |
| OST | OST or Offline Storage Files represent user's mailbox data in offline mode on local machine upon registration
<br/>with Exchange Server using Microsoft Outlook. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/email/ost/) |
| ONE | File represented by .ONE extension are created by Microsoft OneNote application.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/note-taking/one/). |
| ZIP | ZIP file extension represents archives that can hold one or more files or directories.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/compression/zip/). |
| SEVENZ | 7z is an archiving format for compressing files and folders with a high compression ratio.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/compression/7z/). |
| RAR | Files with .rar extension represent archive files that are created for storing information in compressed or normal form.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/compression/rar/). |
| TAR | Files with .tar extension are archives created with Unix-based utility for collecting one or more files.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/compression/tar/). |
| GZ | Files with .gz extension are compressed files created with gzip compression application.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/compression/gz/). |
| BZ2 | Compressed file using Bzip2 algorithm. |
| TIF | TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety
<br/>of devices that comply with this file format standard. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/tiff/). |
| TIFF | TIFF, Tagged Image File Format, represents raster images that are meant for usage on a variety
<br/>of devices that comply with this file format standard. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/tiff/). |
| JPG | A JPG is a type of image format that is saved using the method of lossy compression.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| JPEG | A JPEG is a type of image format that is saved using the method of lossy compression.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| GIF | A GIF or Graphical Interchange Format is a type of highly compressed image.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| BMP | Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images.
<br/>These images are independent of graphics adapter and are also called device independent bitmap (DIB) file
<br/>format. Learn more about this file format [here](https://wiki.fileformat.com/image/bmp/). |
| ICO | Files with ICO extension are image file types used as icon for representation of an application on Microsoft Windows.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/ico/). |
| JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| J2C | JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| J2K | JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| JPC | JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard. Designed,
<br/>using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
<br/>this file format [here](https://wiki.fileformat.com/image/jp2/). |
| DIB | A DIB (Device Independent Bitmap) file is a raster image file that is similar in structure
<br/>to the standard Bitmap files (BMP) but has a different header. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/dib/). |
| WMF | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector
<br/>as well as bitmap-format images data. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/wmf/). |
| EMF | Enhanced metafile format (EMF) stores graphical images device-independently.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/emf/). |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and
<br/>lossy compression. It provides same image quality while considerably reducing the image size.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/webp/). |
| DJVU | DjVu, pronounced as “déjà vu”, is a graphics file format intended for scanned documents and
<br/>books especially those which contain the combination of text, drawings, images and photographs.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/djvu/). |
| CGM | Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile
<br/>format for storing and exchanging of vector graphics (2D), raster graphics, and text.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/page-description-language/cgm/). |
| PCL | PCL stands for Printer Command Language which is a Page Description Language
<br/>introduced by Hewlett Packard (HP). Learn more about this file format
<br/>[here](https://wiki.fileformat.com/page-description-language/pcl/). |
| PSD | PSD, Photoshop Document, represents Adobe Photoshop's native file format used
<br/>for graphics designing and development. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/psd/). |
| DCM | Files with .DCM extension represent digital image which stores medical
<br/>information of patients such as MRIs, CT scans and ultrasound images.
<br/>Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/dcm/). |
| PS | PostScript (PS) is a general-purpose page description language used
<br/>in the business of desktop and electronic publishing. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/page-description-language/ps/). |
| EPS | Files with EPS extension essentially describe an Encapsulated PostScript language program
<br/>that describes the appearance of a single page. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/page-description-language/eps/). |
| ODG | The ODG file format is used by Apache OpenOffice's Draw application to store
<br/>drawing elements as a vector image. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/image/odg/). |
| SVG | An SVG file is a Scalar Vector Graphics file that uses XML based text format
<br/>for describing the appearance of an image. Learn more about this file format
<br/>[here](https://wiki.fileformat.com/page-description-language/svg/). |
| SVGZ | An SVGZ file is a Scalar Vector Graphics file that uses XML based text format
<br/>for describing the appearance of an image and compressed with gzip compression. |
| PICT | The PICT file format is a meta-format that can be used for both bitmap images and vector images. |

##### Methods
| Method | Description |
| :- | :- |
| from_extension | Maps file extension to file type. |
| get_supported_file_types | Retrieves supported file types |
| equals | Determines whether the current `FileType` is the same as specified `FileType` object. |

##### Remarks

**Learn more:** |
|
 |
 |
 |

### AZW3 property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/azw3.md

#### AZW3 property

AZW3, also known as Kindle Format 8 (KF8), is the modified version of the AZW ebook digital file format developed for Amazon Kindle devices.
Learn more about this file format
[here](https://wiki.fileformat.com/ebook/azw3/).

### BMP property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/bmp.md

#### BMP property

Files having extension .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/).

### BZ2 property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/bz2.md

#### BZ2 property

Compressed file using Bzip2 algorithm.

### CGM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/cgm.md

#### CGM property

Computer Graphics Metafile (CGM) is free, platform-independent, international standard metafile
format for storing and exchanging of vector graphics (2D), raster graphics, and text.
Learn more about this file format
[here](https://wiki.fileformat.com/page-description-language/cgm/).

### CHM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/chm.md

#### CHM property

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
Learn more about this file format
[here](https://wiki.fileformat.com/web/chm/).

### CSV property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/csv.md

#### CSV property

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/).

### DCM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/dcm.md

#### DCM property

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/).

### DIB property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/dib.md

#### DIB property

A 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/).

### DJVU property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/djvu.md

#### DJVU property

DjVu, pronounced as “déjà vu”, 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/).

### DOC property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/doc.md

#### DOC property

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/).

### DOCM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/docm.md

#### DOCM property

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/).

### DOCX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/docx.md

#### DOCX property

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/).

### DOT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/dot.md

#### DOT property

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/).

### DOTM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/dotm.md

#### DOTM property

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/).

### DOTX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/dotx.md

#### DOTX property

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/).

### EMF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/emf.md

#### EMF property

Enhanced metafile format (EMF) stores graphical images device-independently.
Learn more about this file format
[here](https://wiki.fileformat.com/image/emf/).

### EML property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/eml.md

#### EML property

EML file format represents email messages saved using Outlook and other relevant applications.
Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).

### EMLX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/emlx.md

#### EMLX property

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/).

### EPS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/eps.md

#### EPS property

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/).

### EPUB property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/epub.md

#### EPUB property

Files with .EPUB extension are an e-book file format that provide
a standard digital publication format for publishers and consumers.
Learn more about this file format
[here](https://wiki.fileformat.com/ebook/epub/).

### equals method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/equals.md

#### equals

Determines whether the current `FileType` is the same as specified `FileType` object.

##### Returns

if both `FileType` objects are the same; otherwise,

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.parser.options.FileType | The object to compare with the current `FileType` object. |

### extension property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/extension.md

#### extension property

Filename suffix (including the period ".") e.g. ".doc".
##### Definition:
```python
@property
def extension(self):
    ...
@extension.setter
def extension(self, value):
    ...
```

### FB2 property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/fb2.md

#### FB2 property

Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
Learn more about this file format
[here](https://wiki.fileformat.com/ebook/fb2/).

### file_format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/file_format.md

#### file_format property

File type name e.g. "Microsoft Word Document".
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/format.md

#### format property

Format of the file e.g. "WordProcessing".
##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/from_extension.md

#### from_extension

Maps file extension to file type.

##### Returns

When file type is supported returns it, otherwise returns default `FileType.Unknown` file type.

```python
def from_extension(self, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | System.String | File extension (including the period "."). |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | Thrown when `extension` is null or empty string. |

### get_supported_file_types method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/get_supported_file_types.md

#### get_supported_file_types

Retrieves supported file types

##### Returns

Returns sequence of supported file types

```python
def get_supported_file_types(self):
    ...
```

### GIF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/gif.md

#### GIF property

A GIF or Graphical Interchange Format is a type of highly compressed image.
Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).

### GZ property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/gz.md

#### GZ property

Files with .gz extension are compressed files created with gzip compression application.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/gz/).

### HTM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/htm.md

#### HTM property

Files with HTM extension represent Hypertext Markup Language for creating web pages
for display in web browsers such as Google Chrome, Internet Explorer, Firefox and a number of others.
Learn more about this file format
[here](https://wiki.fileformat.com/web/htm/).

### HTML property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/html.md

#### HTML property

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/).

### ICO property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ico.md

#### ICO property

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/).

### J2C property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/j2c.md

#### J2C property

JPEG 2000 (J2C) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### J2K property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/j2k.md

#### J2K property

JPEG 2000 (J2K) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### JP2 property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jp2.md

#### JP2 property

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/).

### JPC property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpc.md

#### JPC property

JPEG 2000 (JPC) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### JPEG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpeg.md

#### JPEG property

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

### JPF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpf.md

#### JPF property

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### JPG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpg.md

#### JPG property

A JPG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

### JPM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpm.md

#### JPM property

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### JPX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/jpx.md

#### JPX property

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed,
using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about
this file format [here](https://wiki.fileformat.com/image/jp2/).

### MD property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/md.md

#### MD property

Text files created with Markdown language dialects is saved with
.MD or .MARKDOWN file extension. Learn more about this file format
[here](https://wiki.fileformat.com/word-processing/md/).

### MHT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/mht.md

#### MHT property

Files with MHT extension represent a web page archive format that can be created
by a number of different applications. Learn more about this file format
[here](https://wiki.fileformat.com/web/mhtml/).

### MHTML property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/mhtml.md

#### MHTML property

Files with MHTML extension represent a web page archive format that can be created
by a number of different applications. Learn more about this file format
[here](https://wiki.fileformat.com/web/mhtml/).

### MOBI property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/mobi.md

#### MOBI property

The Mobipocket file format (originally with extension .prc and later .mobi) is a proprietary, partially documented, binary format for ebooks.
Learn more about this file format
[here](https://wiki.fileformat.com/ebook/mobi/).

### MSG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/msg.md

#### MSG property

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/).

### NUMBERS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/numbers.md

#### NUMBERS property

Files that contain the .numbers file extension are files that are created by
the Apple iWork Numbers spreadsheet application.

### ODG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/odg.md

#### ODG property

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/).

### ODP property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/odp.md

#### ODP property

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/).

### ODS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ods.md

#### ODS property

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
Learn more about this file format
[here](https://wiki.fileformat.com/spreadsheet/ods/).

### ODT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/odt.md

#### ODT property

ODT files are type of documents created with word processing applications that are based on OpenDocument
Text File format. These are created with word processor applications such as free OpenOffice Writer and
can hold content such as text, images, objects and styles. Learn more about this file format
[here](https://wiki.fileformat.com/word-processing/odt/).

### ONE property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/one.md

#### ONE property

File represented by .ONE extension are created by Microsoft OneNote application.
Learn more about this file format
[here](https://wiki.fileformat.com/note-taking/one/).

### OST property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ost.md

#### OST property

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/)

### OTP property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/otp.md

#### OTP property

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/).

### OTS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ots.md

#### OTS property

The OTS files contain template files used by the OpenOffice spreadsheet application.

### OTT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ott.md

#### OTT property

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/).

### PCL property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pcl.md

#### PCL property

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/).

### PDF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pdf.md

#### PDF property

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/).

### PICT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pict.md

#### PICT property

The PICT file format is a meta-format that can be used for both bitmap images and vector images.

### PNG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/png.md

#### PNG property

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
Learn more about this file format [here](https://wiki.fileformat.com/image/png/).

### POT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pot.md

#### POT property

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/).

### POTM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/potm.md

#### POTM property

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/).

### POTX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/potx.md

#### POTX property

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/).

### PPS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pps.md

#### PPS property

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/).

### PPSM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ppsm.md

#### PPSM property

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/).

### PPSX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ppsx.md

#### PPSX property

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/).

### PPT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ppt.md

#### PPT property

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/).

### PPTM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pptm.md

#### PPTM property

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/).

### PPTX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pptx.md

#### PPTX property

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/).

### PS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/ps.md

#### PS property

PostScript (PS) is a general-purpose page description language used
in the business of desktop and electronic publishing. Learn more about this file format
[here](https://wiki.fileformat.com/page-description-language/ps/).

### PSD property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/psd.md

#### PSD property

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/).

### PST property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/pst.md

#### PST property

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/)

### RAR property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/rar.md

#### RAR property

Files with .rar extension represent archive files that are created for storing information in compressed or normal form.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/rar/).

### RTF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/rtf.md

#### RTF property

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding
formatted text and graphics for use within applications. The format facilitates cross-platform document
exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about
this file format [here](https://wiki.fileformat.com/word-processing/rtf/).

### SEVENZ property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/sevenz.md

#### SEVENZ property

7z is an archiving format for compressing files and folders with a high compression ratio.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/7z/).

### SVG property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/svg.md

#### SVG property

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/).

### SVGZ property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/svgz.md

#### SVGZ property

An SVGZ file is a Scalar Vector Graphics file that uses XML based text format
for describing the appearance of an image and compressed with gzip compression.

### TAR property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/tar.md

#### TAR property

Files with .tar extension are archives created with Unix-based utility for collecting one or more files.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/tar/).

### TEXT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/text.md

#### TEXT property

A file with .TEXT 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/).

### TIF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/tif.md

#### TIF property

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. Learn more about this file format
[here](https://wiki.fileformat.com/image/tiff/).

### TIFF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/tiff.md

#### TIFF property

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. Learn more about this file format
[here](https://wiki.fileformat.com/image/tiff/).

### TSV property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/tsv.md

#### TSV property

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/).

### TXT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/txt.md

#### TXT property

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/).

### UNKNOWN property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/unknown.md

#### UNKNOWN property

Represents unknown file type.

### WEBP property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/webp.md

#### WEBP property

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/).

### WMF property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/wmf.md

#### WMF property

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/).

### XHTML property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xhtml.md

#### XHTML property

The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0.
Learn more about this file format
[here](https://wiki.fileformat.com/web/xhtml/).

### XLA property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xla.md

#### XLA property

The Excel 97-2003 Add-In, a supplemental program that is designed to run additional code.
Supports the use of VBA projects.

### XLAM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xlam.md

#### XLAM property

The XML-based and macro-enabled Add-In format for Excel 2010 and Excel 2007.
An Add-In is a supplemental program that is designed to run additional code.
Supports the use of VBA projects and Excel 4.0 macro sheets (.xlm).

### XLS property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xls.md

#### XLS property

Files with XLS extension represent 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/specification/spreadsheet/xls/).

### XLSB property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xlsb.md

#### XLSB property

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/specification/spreadsheet/xlsb/).

### XLSM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xlsm.md

#### XLSM property

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).

### XLSX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xlsx.md

#### XLSX property

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/specification/spreadsheet/xlsx/).

### XLT property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xlt.md

#### XLT property

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet
application which comes as part of Microsoft Office suite. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).

### XLTM property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xltm.md

#### XLTM property

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled
template files. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).

### XLTX property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xltx.md

#### XLTX property

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML
file format specifications. Learn more about this file format
[here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).

### XML property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/xml.md

#### XML property

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/).

### ZIP property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetype/zip.md

#### ZIP property

ZIP file extension represents archives that can hold one or more files or directories.
Learn more about this file format
[here](https://wiki.fileformat.com/compression/zip/).

### FileTypeDetectionMode enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/filetypedetectionmode.md

#### FileTypeDetectionMode enumeration

Defines a mode of the file type detection.

The FileTypeDetectionMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | The file type is detected by the file extension; if the file extension isn't recognized,
<br/>the file type is detected by the file content. |
| EXTENSION | The file type is detected only by the file extension. |
| CONTENT | The file type is detected only by the file content. |

### FormattedTextMode enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/formattedtextmode.md

#### FormattedTextMode enumeration

Defines a formatted text mode.

The FormattedTextMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HTML | HTML format. |
| MARKDOWN | Markdown format. |
| PLAIN_TEXT | Plain text format. |

##### Remarks

**Learn more:** |
|
 |
 |
 |
 |

### FormattedTextOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/formattedtextoptions.md

#### FormattedTextOptions class

Provides the options which are used for formatted text extraction.

The FormattedTextOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `FormattedTextOptions` class. |
| __init__ | Initializes a new instance of the `FormattedTextOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| mode | Gets the formatted text extraction mode. |

##### Remarks

An instance of `FormattedTextOptions` class is used as parameter
in `Parser.get_formatted_text` and `Parser.get_formatted_text` methods.
See the usage examples there.

**Learn more:** |
|
 |
 |
 |
 |

### FormattedTextOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/formattedtextoptions/__init__.md

#### __init__

Initializes a new instance of the `FormattedTextOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `FormattedTextOptions` class.

```python
def __init__(self, mode):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mode | groupdocs.parser.options.FormattedTextMode | The mode of formatted text extraction. |

### mode property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/formattedtextoptions/mode.md

#### mode property

Gets the formatted text extraction mode.
##### Definition:
```python
@property
def mode(self):
    ...
@mode.setter
def mode(self, value):
    ...
```

### HighlightOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/highlightoptions.md

#### HighlightOptions class

Provides the options which are used to extract a highlight (a block of text aroud found text in search scenarios).

The HighlightOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight. |
| __init__ | Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight. |
| __init__ | Constructs a new instance of HighlightOptions |
| __init__ | Constructs a new instance of HighlightOptions |
| __init__ | Constructs a new instance of HighlightOptions |

##### Properties
| Property | Description |
| :- | :- |
| max_length | Gets a maximum text length. |
| word_count | Gets a maximum word count. |
| is_line_limited | Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line. |

##### Remarks

An instance of `HighlightOptions` class is used as parameter
in `Parser.get_highlight` method.
See the usage examples there.

### HighlightOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/highlightoptions/__init__.md

#### __init__

Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `HighlightOptions` class which is used to extract a fixed-length highlight.

```python
def __init__(self, max_length):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| max_length | int | The maximum text length. |

#### __init__

Constructs a new instance of HighlightOptions

```python
def __init__(self, max_length, is_line_limited):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| max_length | System.Nullable`1[[System.Int32]] |  |
| is_line_limited | bool |  |

#### __init__

Constructs a new instance of HighlightOptions

```python
def __init__(self, max_length, word_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| max_length | System.Nullable`1[[System.Int32]] |  |
| word_count | int |  |

#### __init__

Constructs a new instance of HighlightOptions

```python
def __init__(self, max_length, word_count, is_line_limited):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| max_length | System.Nullable`1[[System.Int32]] |  |
| word_count | System.Nullable`1[[System.Int32]] |  |
| is_line_limited | bool |  |

### is_line_limited property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/highlightoptions/is_line_limited.md

#### is_line_limited property

Gets value that indicates whether highlight extraction is limited by the start (or the end) of a text line.
##### Definition:
```python
@property
def is_line_limited(self):
    ...
@is_line_limited.setter
def is_line_limited(self, value):
    ...
```

### max_length property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/highlightoptions/max_length.md

#### max_length property

Gets a maximum text length.
##### Definition:
```python
@property
def max_length(self):
    ...
@max_length.setter
def max_length(self, value):
    ...
```

### word_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/highlightoptions/word_count.md

#### word_count property

Gets a maximum word count.
##### Definition:
```python
@property
def word_count(self):
    ...
@word_count.setter
def word_count(self, value):
    ...
```

### ICreatePageStream class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/icreatepagestream.md

#### ICreatePageStream class

Represents a delegate that returns a stream to write page preview data.

The ICreatePageStream type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_page_stream | Represents a method that returns a stream to write page preview data. |

### create_page_stream method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/icreatepagestream/create_page_stream.md

#### create_page_stream

Represents a method that returns a stream to write page preview data.

##### Returns

The stream to write the page preview.

```python
def create_page_stream(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | int | The page number of a page to generate a thumbnail. |

### IDocumentInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo.md

#### IDocumentInfo class

Represents the document information.

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | Gets the document type. |
| page_count | Gets the total number of document pages. |
| raw_page_count | Gets the total number of document raw pages. |
| size | Gets the size of the document in bytes. |
| pages | Gets the information about pages such as the index and page size. |

##### Remarks

The objects which implement this interface are returned by `Parser.get_document_info` method.
See the usage examples there.
**Learn more:** |
|
 |
 |

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo/file_type.md

#### file_type property

Gets the document type.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo/page_count.md

#### page_count property

Gets the total number of document pages.
##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo/pages.md

#### pages property

Gets the information about pages such as the index and page size.
##### Definition:
```python
@property
def pages(self):
    ...
```

### raw_page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo/raw_page_count.md

#### raw_page_count property

Gets the total number of document raw pages.

##### Remarks

Use `IDocumentInfo.raw_page_count` property instead of `IDocumentInfo.page_count` property for raw text extraction.
Some documents have different page numbers in accurate and raw text extraction modes.
`IDocumentInfo.page_count` property may perform extra calculations which impacts on text extraction speed in raw mode.
##### Definition:
```python
@property
def raw_page_count(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/idocumentinfo/size.md

#### size property

Gets the size of the document in bytes.
##### Definition:
```python
@property
def size(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ilogger.md

#### ILogger class

Defines the interface of a logger that is used for logging events and errors during data extraction.

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| warning | Logs a warning that occurred during data extraction. |
| trace | Logs an event occurred during data extraction. |

##### Remarks

**Learn more:** |
|
 |

### trace method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ilogger/trace.md

#### trace

Logs an event occurred during data extraction.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The event message. |

### warning method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ilogger/warning.md

#### warning

Logs a warning that occurred during data extraction.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The warning message. |

### ImageFormat enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/imageformat.md

#### ImageFormat enumeration

Defines a format of the image.

The ImageFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BMP | Bitmap image. |
| GIF | Graphical Interchange Format. |
| JPEG | JPEG image. |
| PNG | Portable Network Graphic. |
| WEB_P | WebP Image. |

### ImageOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/imageoptions.md

#### ImageOptions class

Provides the options which are used for image extraction.

The ImageOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| image_format | Gets the image format for image extraction. |

##### Remarks

An instance of `ImageOptions` class is used as parameter
in `PageImageArea.get_image_stream` and
`PageImageArea.save` methods. See the usage examples there.

It's used to specify the image format for image extraction.

**Learn more:** |
|
 |
 |

### ImageOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/imageoptions/__init__.md

#### __init__

Initializes a new instance of the `ImageOptions` class.

```python
def __init__(self, image_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_format | groupdocs.parser.options.ImageFormat | The format of the image. |

### image_format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/imageoptions/image_format.md

#### image_format property

Gets the image format for image extraction.
##### Definition:
```python
@property
def image_format(self):
    ...
```

### IPreviewPageRender class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ipreviewpagerender.md

#### IPreviewPageRender class

Represents a method which is called before a document page is rendered.

The IPreviewPageRender type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| preview_page_render | Represents a method which is called before a document page is rendered. |

### preview_page_render method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ipreviewpagerender/preview_page_render.md

#### preview_page_render

Represents a method which is called before a document page is rendered.

```python
def preview_page_render(self, info):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| info | groupdocs.parser.options.PageRenderInfo | The information of how a page is rendered. |

### IReleasePageStream class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ireleasepagestream.md

#### IReleasePageStream class

Represents a method which releases the stream created by the CreatePageStream delegate.

The IReleasePageStream type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| release_page_stream | Represents a method which releases the stream created by the CreatePageStream delegate. |

### release_page_stream method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ireleasepagestream/release_page_stream.md

#### release_page_stream

Represents a method which releases the stream created by the CreatePageStream delegate.

```python
def release_page_stream(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | int | The page number of a generated page preview. |
| page_stream | io.RawIOBase | The stream containing the generated page preview. |

### LoadOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions.md

#### LoadOptions class

Provides the options which are used to open a file.

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `LoadOptions` class
<br/>with empty `LoadOptions.password`, `LoadOptions.file_format` equal to `FileFormat.UNKNOWN`
<br/>and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class with `timeout`. |
| __init__ | Initializes a new instance of the `LoadOptions` class
<br/>with `LoadOptions.file_format` equal to `FileFormat.UNKNOWN`
<br/>and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class
<br/>with empty `LoadOptions.password` and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class with the password and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class with custom encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` fully customized class. |
| __init__ | Initializes a new instance of the `LoadOptions` class
<br/>with empty `LoadOptions.password` and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class with the password and default encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` class with custom encodings. |
| __init__ | Initializes a new instance of the `LoadOptions` fully customized class. |

##### Properties
| Property | Description |
| :- | :- |
| file_format | Gets the file format. |
| file_type | Gets the file type. |
| password | Gets the password. |
| encoding | Gets the encoding of the document. |
| default_ansi_encoding | Gets the default ANSI encoding which is used for encoding detection. |
| timeout | Gets the value that represents the number of milliseconds to wait. |

##### Remarks

An instance of this class is used as parameter in `Parser` class constructors:
|
|
 |
 |

See the usage examples there.

**Learn more:** |
|
 |
 |

### LoadOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/__init__.md

#### __init__

Initializes a new instance of the `LoadOptions` class
with empty `LoadOptions.password`, `LoadOptions.file_format` equal to `FileFormat.UNKNOWN`
and default encodings.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `LoadOptions` class with `timeout`.

```python
def __init__(self, timeout):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| timeout | System.TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

#### __init__

Initializes a new instance of the `LoadOptions` class
with `LoadOptions.file_format` equal to `FileFormat.UNKNOWN`
and default encodings.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | System.String | The password to open the password-protected file. |

#### __init__

Initializes a new instance of the `LoadOptions` class
with empty `LoadOptions.password` and default encodings.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.parser.options.FileFormat | The format of the file. |

#### __init__

Initializes a new instance of the `LoadOptions` class
with empty `LoadOptions.password` and default encodings.

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.parser.options.FileType | The type of the file. |

#### __init__

Initializes a new instance of the `LoadOptions` class with the password and default encodings.

```python
def __init__(self, file_format, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.parser.options.FileFormat | The format of the file. |
| password | System.String | The password to open the password-protected file. |

#### __init__

Initializes a new instance of the `LoadOptions` class with the password and default encodings.

```python
def __init__(self, file_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.parser.options.FileType | The type of the file. |
| password | System.String | The password to open the password-protected file. |

#### __init__

Initializes a new instance of the `LoadOptions` class with custom encodings.

```python
def __init__(self, file_format, password, encoding, default_ansi_encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.parser.options.FileFormat | The format of the file. |
| password | System.String | The password to open the password-protected file. |
| encoding | System.Text.Encoding | The encoding of the document. |
| default_ansi_encoding | System.Text.Encoding | The default ANSI encoding which is used for encoding detection. |

#### __init__

Initializes a new instance of the `LoadOptions` class with custom encodings.

```python
def __init__(self, file_type, password, encoding, default_ansi_encoding):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.parser.options.FileType | The type of the file. |
| password | System.String | The password to open the password-protected file. |
| encoding | System.Text.Encoding | The encoding of the document. |
| default_ansi_encoding | System.Text.Encoding | The default ANSI encoding which is used for encoding detection. |

#### __init__

Initializes a new instance of the `LoadOptions` fully customized class.

```python
def __init__(self, file_format, password, encoding, default_ansi_encoding, timeout):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.parser.options.FileFormat | The format of the file. |
| password | System.String | The password to open the password-protected file. |
| encoding | System.Text.Encoding | The encoding of the document. |
| default_ansi_encoding | System.Text.Encoding | The default ANSI encoding which is used for encoding detection. |
| timeout | System.TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

#### __init__

Initializes a new instance of the `LoadOptions` fully customized class.

```python
def __init__(self, file_type, password, encoding, default_ansi_encoding, timeout):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.parser.options.FileType | The type of the file. |
| password | System.String | The password to open the password-protected file. |
| encoding | System.Text.Encoding | The encoding of the document. |
| default_ansi_encoding | System.Text.Encoding | The default ANSI encoding which is used for encoding detection. |
| timeout | System.TimeSpan | The TimeSpan that represents the number of milliseconds to wait. |

### default_ansi_encoding property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/default_ansi_encoding.md

#### default_ansi_encoding property

Gets the default ANSI encoding which is used for encoding detection.
##### Definition:
```python
@property
def default_ansi_encoding(self):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/encoding.md

#### encoding property

Gets the encoding of the document.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/file_format.md

#### file_format property

Gets the file format.
##### Definition:
```python
@property
def file_format(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/file_type.md

#### file_type property

Gets the file type.
##### Definition:
```python
@property
def file_type(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/password.md

#### password property

Gets the password.
##### Definition:
```python
@property
def password(self):
    ...
```

### timeout property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/loadoptions/timeout.md

#### timeout property

Gets the value that represents the number of milliseconds to wait.
##### Definition:
```python
@property
def timeout(self):
    ...
```

### OcrConnectorBase class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase.md

#### OcrConnectorBase class

Provides the OCR functionality.

The OcrConnectorBase type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| is_text_supported | Gets the value that indicates whether the text extraction is supported. |
| is_text_page_supported | Gets the value that indicates whether the text page extraction is supported. |
| is_text_areas_supported | Gets the value that indicates whether the text areas extraction is supported. |

##### Methods
| Method | Description |
| :- | :- |
| recognize_text | Recognize a text from `image_stream` stream. |
| recognize_text | Recognize a text from `image_stream` stream. |
| recognize_text_areas | Recognize text areas from `image_stream` stream. |
| recognize_text_areas | Recognize text areas from `image_stream` stream. |
| recognize_text_areas | Recognize text areas from `image_stream` stream. |
| recognize_text_areas |  |

### is_text_areas_supported property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase/is_text_areas_supported.md

#### is_text_areas_supported property

Gets the value that indicates whether the text areas extraction is supported.
##### Definition:
```python
@property
def is_text_areas_supported(self):
    ...
```

### is_text_page_supported property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase/is_text_page_supported.md

#### is_text_page_supported property

Gets the value that indicates whether the text page extraction is supported.
##### Definition:
```python
@property
def is_text_page_supported(self):
    ...
```

### is_text_supported property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase/is_text_supported.md

#### is_text_supported property

Gets the value that indicates whether the text extraction is supported.
##### Definition:
```python
@property
def is_text_supported(self):
    ...
```

### recognize_text method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase/recognize_text.md

#### recognize_text

Recognize a text from `image_stream` stream.

##### Returns

A string that represents a recognized text; `null` if text recognizing isn't supported.

```python
def recognize_text(self, image_stream, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The image representation of the document page. |
| options | groupdocs.parser.options.OcrOptions | The OCR options. |

#### recognize_text

Recognize a text from `image_stream` stream.

##### Returns

A string that represents a recognized text; `null` if text recognizing isn't supported.

```python
def recognize_text(self, image_stream, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The image representation of the document page. |
| page_index | int | The page index of the document. |
| options | groupdocs.parser.options.OcrOptions | The OCR options. |

### recognize_text_areas method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocrconnectorbase/recognize_text_areas.md

#### recognize_text_areas

Recognize text areas from `image_stream` stream.

##### Returns

A collection of `PageTextArea` objects; `null` if text areas recognizing isn't supported.

```python
def recognize_text_areas(self, image_stream, page_size, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The image representation of the document page. |
| page_size | groupdocs.parser.data.Size | The size of the document page. |
| options | groupdocs.parser.options.OcrOptions | The OCR options. |

#### recognize_text_areas

Recognize text areas from `image_stream` stream.

##### Returns

A collection of `PageTextArea` objects; `null` if text areas recognizing isn't supported.

```python
def recognize_text_areas(self, image_stream, page, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The image representation of the document page. |
| page | groupdocs.parser.data.Page | The the document page. |
| options | groupdocs.parser.options.OcrOptions | The OCR options. |

#### recognize_text_areas

Recognize text areas from `image_stream` stream.

##### Returns

A collection of `PageTextArea` objects; `null` if text areas recognizing isn't supported.

```python
def recognize_text_areas(self, image_stream, page_index, page_size, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | The image representation of the document page. |
| page_index | int | The page index of the document. |
| page_size | groupdocs.parser.data.Size | The size of the document page. |
| options | groupdocs.parser.options.OcrOptions | The OCR options. |

#### recognize_text_areas

```python
def recognize_text_areas(self, image_stream, rectangles, allowed_symbols, page, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase |  |
| rectangles | list |  |
| allowed_symbols | System.String |  |
| page | groupdocs.parser.data.Page |  |
| options | groupdocs.parser.options.OcrOptions |  |

### OcrEventHandler class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler.md

#### OcrEventHandler class

Provides a handler for OCR events.

The OcrEventHandler type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `OcrEventHandler` class. |

##### Properties
| Property | Description |
| :- | :- |
| warnings | Gets a list of warning messages. |
| has_warnings | Gets the value that indicates whether the list of warnings isn't empty. |

##### Methods
| Method | Description |
| :- | :- |
| get_warnings | Returns a list of warning messages for the page with `page_index`. |
| on_warnings |  |

### OcrEventHandler constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler/__init__.md

#### __init__

Initializes a new instance of the `OcrEventHandler` class.

```python
def __init__(self):
    ...
```

### get_warnings method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler/get_warnings.md

#### get_warnings

Returns a list of warning messages for the page with `page_index`.

##### Returns

A list of warning messages for the page; empty list if no warning messages for the page.

```python
def get_warnings(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

### has_warnings property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler/has_warnings.md

#### has_warnings property

Gets the value that indicates whether the list of warnings isn't empty.
##### Definition:
```python
@property
def has_warnings(self):
    ...
```

### on_warnings method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler/on_warnings.md

#### on_warnings

```python
def on_warnings(self, page_index, warnings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int |  |
| warnings | list |  |

### warnings property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocreventhandler/warnings.md

#### warnings property

Gets a list of warning messages.
##### Definition:
```python
@property
def warnings(self):
    ...
```

### OcrOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions.md

#### OcrOptions class

Provides the options which are used for OCR Connector.

The OcrOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| __init__ | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| __init__ | Initializes a new instance of the `OcrOptions` class with rectangular area. |
| __init__ | Initializes a new instance of the `OcrOptions` class with `OcrEventHandler` object. |
| __init__ | Initializes a new instance of the `OcrOptions` class with rectangular area and `OcrEventHandler` object. |
| __init__ | Initializes a new instance of the `OcrOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that constraints the page area which is used for text recognizing. |
| handler | Gets the event handler to catch OCR events. |
| page_preview_options | Gets the document page preview options. |
| use_spell_checker | Gets the value that indicates whether the spell checker is used. |

### OcrOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions/__init__.md

#### __init__

Initializes a new instance of the `OcrOptions` class with rectangular area.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `OcrOptions` class with rectangular area.

```python
def __init__(self, page_preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_preview_options | groupdocs.parser.options.PagePreviewOptions | An instance of `OcrOptions.page_preview_options` class that sets properties for the document page preview generation. |

#### __init__

Initializes a new instance of the `OcrOptions` class with rectangular area.

```python
def __init__(self, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |

#### __init__

Initializes a new instance of the `OcrOptions` class with `OcrEventHandler` object.

```python
def __init__(self, handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| handler | groupdocs.parser.options.OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |

#### __init__

Initializes a new instance of the `OcrOptions` class with rectangular area and `OcrEventHandler` object.

```python
def __init__(self, rectangle, handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |
| handler | groupdocs.parser.options.OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |

#### __init__

Initializes a new instance of the `OcrOptions` class.

```python
def __init__(self, rectangle, handler, page_preview_options, use_spell_cheker):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that constraints the page area which is used for text recognizing. |
| handler | groupdocs.parser.options.OcrEventHandler | An instance of `OcrEventHandler` to catch OCR events. |
| page_preview_options | groupdocs.parser.options.PagePreviewOptions | An instance of `OcrOptions.page_preview_options` class that sets properties for the document page preview generation. |
| use_spell_cheker | bool | The value that indicates whether the spell checker is used. |

### handler property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions/handler.md

#### handler property

Gets the event handler to catch OCR events.
##### Definition:
```python
@property
def handler(self):
    ...
@handler.setter
def handler(self, value):
    ...
```

### page_preview_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions/page_preview_options.md

#### page_preview_options property

Gets the document page preview options.
##### Definition:
```python
@property
def page_preview_options(self):
    ...
@page_preview_options.setter
def page_preview_options(self, value):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions/rectangle.md

#### rectangle property

Gets the rectangular area that constraints the page area which is used for text recognizing.
##### Definition:
```python
@property
def rectangle(self):
    ...
@rectangle.setter
def rectangle(self, value):
    ...
```

### use_spell_checker property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/ocroptions/use_spell_checker.md

#### use_spell_checker property

Gets the value that indicates whether the spell checker is used.
##### Definition:
```python
@property
def use_spell_checker(self):
    ...
@use_spell_checker.setter
def use_spell_checker(self, value):
    ...
```

### PageAreaOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageareaoptions.md

#### PageAreaOptions class

Provides the options which are used for page areas extraction.

The PageAreaOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageAreaOptions` class. |
| __init__ | Initializes a new instance of the `PageAreaOptions` class. |
| __init__ | Initializes a new instance of the `PageAreaOptions` class with the size of the ignored border. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains page areas. |
| rectangle_tolerance | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

##### Remarks

An instance of `PageAreaOptions` class is used as parameter
in the following methods:

|
|
 |
 |
 |
 |
 |
 |

See the usage examples there.

### PageAreaOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageareaoptions/__init__.md

#### __init__

Initializes a new instance of the `PageAreaOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `PageAreaOptions` class.

```python
def __init__(self, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |

#### __init__

Initializes a new instance of the `PageAreaOptions` class with the size of the ignored border.

```python
def __init__(self, rectangle, rectangle_tolerance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |
| rectangle_tolerance | float | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageareaoptions/rectangle.md

#### rectangle property

Gets the rectangular area that contains page areas.
##### Definition:
```python
@property
def rectangle(self):
    ...
@rectangle.setter
def rectangle(self, value):
    ...
```

### rectangle_tolerance property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageareaoptions/rectangle_tolerance.md

#### rectangle_tolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
##### Definition:
```python
@property
def rectangle_tolerance(self):
    ...
@rectangle_tolerance.setter
def rectangle_tolerance(self, value):
    ...
```

### PageInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageinfo.md

#### PageInfo class

Represents the document page information.

The PageInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| width | Gets the page width. |
| height | Gets the page height. |
| page_number | Gets the page number. |

### height property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageinfo/height.md

#### height property

Gets the page height.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageinfo/page_number.md

#### page_number property

Gets the page number.
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pageinfo/width.md

#### width property

Gets the page width.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PagePreviewFormat enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewformat.md

#### PagePreviewFormat enumeration

Represents supported preview formats.

The PagePreviewFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO | PNG, JPEG and BMP images retain their format if no changes are required. For other cases, PNG format is used. |
| PNG | PNG image (Portable Network Graphics). |
| JPEG | JPEG image (Joint Photographic Experts Group Format). |
| BMP | Bitmap image (Bitmap Picture Format). |

### PagePreviewOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions.md

#### PagePreviewOptions class

Provides the options which are used to generate the document page preview.

The PagePreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PagePreviewOptions` class. |
| __init__ | Initializes a new instance of the `PagePreviewOptions` class with the preview format. |
| __init__ | Initializes a new instance of the `PagePreviewOptions` class with the preview dpi. |
| __init__ | Initializes a new instance of the `PagePreviewOptions` class the preview format and dpi. |

##### Properties
| Property | Description |
| :- | :- |
| format | Gets a format of the document page image. |
| dpi | Gets a DPI of the document page image. |
| scale_factor | Gets a scale factor. |
| DEFAULT_DPI | Defines a default value of `PagePreviewOptions.dpi` property. |

### PagePreviewOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions/__init__.md

#### __init__

Initializes a new instance of the `PagePreviewOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `PagePreviewOptions` class with the preview format.

```python
def __init__(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | groupdocs.parser.options.PagePreviewFormat | The format of the document page image. |

#### __init__

Initializes a new instance of the `PagePreviewOptions` class with the preview dpi.

```python
def __init__(self, dpi):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| dpi | int | The DPI of the document page image. |

#### __init__

Initializes a new instance of the `PagePreviewOptions` class the preview format and dpi.

```python
def __init__(self, format, dpi):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | groupdocs.parser.options.PagePreviewFormat | The format of the document page image. |
| dpi | int | The DPI of the document page image. |

### DEFAULT_DPI property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions/default_dpi.md

#### DEFAULT_DPI property

Defines a default value of `PagePreviewOptions.dpi` property.

### dpi property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions/dpi.md

#### dpi property

Gets a DPI of the document page image.
##### Definition:
```python
@property
def dpi(self):
    ...
@dpi.setter
def dpi(self, value):
    ...
```

### format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions/format.md

#### format property

Gets a format of the document page image.
##### Definition:
```python
@property
def format(self):
    ...
@format.setter
def format(self, value):
    ...
```

### scale_factor property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagepreviewoptions/scale_factor.md

#### scale_factor property

Gets a scale factor.
##### Definition:
```python
@property
def scale_factor(self):
    ...
```

### PageRenderInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo.md

#### PageRenderInfo class

Represents the information of how a page is rendered.

The PageRenderInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageRenderInfo` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets the page number. |
| row_count | Get the total number of tiles rows. |
| column_count | Get the total number of tiles columns. |

##### Methods
| Method | Description |
| :- | :- |
| get_column | Returns the index of column where the tile with `tile_index` is placed. |
| get_row | Returns the index of row where the tile with `tile_index` is placed. |

##### Remarks

Some documents (spreadsheets, for example) are not possible to render a page
as a single image. For those documents a page is rendered as a set of tiles.
These tiles are placed in the rectangular table.

`PageRenderInfo.row_count` and `PageRenderInfo.column_count`
represent the total number of rows and columns of this table. If document page is rendered
to the single image these properties are equal to 1.

### PageRenderInfo constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/__init__.md

#### __init__

Initializes a new instance of the `PageRenderInfo` class.

```python
def __init__(self, page_number, row_count, column_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | int | The number of the page (starts with 1). |
| row_count | int | The total number of tiles rows. |
| column_count | int | The total number of tiles columns. |

### column_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/column_count.md

#### column_count property

Get the total number of tiles columns.
##### Definition:
```python
@property
def column_count(self):
    ...
```

### get_column method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/get_column.md

#### get_column

Returns the index of column where the tile with `tile_index` is placed.

##### Returns

The zero-based integer value that represents the column index.

```python
def get_column(self, tile_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tile_index | int | The zero-based index of the tile. |

### get_row method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/get_row.md

#### get_row

Returns the index of row where the tile with `tile_index` is placed.

##### Returns

The zero-based integer value that represents the row index.

```python
def get_row(self, tile_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| tile_index | int | The zero-based index of the tile. |

### page_number property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/page_number.md

#### page_number property

Gets the page number.
##### Definition:
```python
@property
def page_number(self):
    ...
```

### row_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagerenderinfo/row_count.md

#### row_count property

Get the total number of tiles rows.
##### Definition:
```python
@property
def row_count(self):
    ...
```

### PageTableAreaOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetableareaoptions.md

#### PageTableAreaOptions class

Provides the options which are used for page table areas extraction.

**Inheritance:** `PageTableAreaOptions` →
`PageAreaOptions`

The PageTableAreaOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageAreaOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains page areas. |
| rectangle_tolerance | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |
| table_layout | Gets the table layout which defines the table on a page. |

##### Remarks

An instance of `PageTableAreaOptions` class is used as parameter
in `Parser.get_tables` and `Parser.get_tables` methods.
See the usage examples there.

### PageTableAreaOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetableareaoptions/__init__.md

#### __init__

Initializes a new instance of the `PageAreaOptions` class.

```python
def __init__(self, table_layout):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| table_layout | groupdocs.parser.templates.TemplateTableLayout | The table layout which defines the table on a page. |

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetableareaoptions/rectangle.md

#### rectangle property

Gets the rectangular area that contains page areas.

### rectangle_tolerance property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetableareaoptions/rectangle_tolerance.md

#### rectangle_tolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

### table_layout property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetableareaoptions/table_layout.md

#### table_layout property

Gets the table layout which defines the table on a page.
##### Definition:
```python
@property
def table_layout(self):
    ...
```

### PageTextAreaOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions.md

#### PageTextAreaOptions class

Provides the options which are used for page text areas extraction.

**Inheritance:** `PageTextAreaOptions` →
`PageAreaOptions`

The PageTextAreaOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option. |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option. |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class with the ability to set OCR options. |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class with the regular expression.
<br/>Other options are set by default (see remarks for details). |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class
<br/>with the regular expression and rectangular area.
<br/>Other options are set by default (see remarks for details). |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class
<br/>with the regular expression, rectangular area and the size of the ignored border.
<br/>Other options are set by default (see remarks for details). |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class. |
| __init__ | Initializes a new instance of the `PageTextAreaOptions` class
<br/>with the size of the ignored border. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains page areas. |
| rectangle_tolerance | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |
| expression | Gets the regular expression. |
| match_case | Gets the value that indicates whether a text case isn't ignored. |
| unite_segments | Gets the value that indicates whether segments are united. |
| ignore_formatting | Gets the value that indicates whether text formatting is ignored. |
| use_ocr | Gets the value that indicates whether OCR functionality is used to extract text areas. |
| ocr_options | Gets the additional options for OCR functionality. |

##### Remarks

An instance of `PageTextAreaOptions` class is used as parameter
in `Parser.get_text_areas` and `Parser.get_text_areas` methods.
See the usage examples there.
**Learn more:** |
|
 |

### PageTextAreaOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/__init__.md

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class with the OCR usage option.

```python
def __init__(self, use_ocr):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| use_ocr | bool | The value that indicates whether OCR functionality is used to extract text areas. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class with the regular expression.
Other options are set by default (see remarks for details).

```python
def __init__(self, expression):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class with the ability to set OCR options.

```python
def __init__(self, use_ocr, ocr_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| use_ocr | bool | The value that indicates whether OCR functionality is used to extract text areas. |
| ocr_options | groupdocs.parser.options.OcrOptions | The additional options for OCR functionality. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class
with the regular expression and rectangular area.
Other options are set by default (see remarks for details).

```python
def __init__(self, expression, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class
with the regular expression, rectangular area and the size of the ignored border.
Other options are set by default (see remarks for details).

```python
def __init__(self, expression, rectangle, rectangle_tolerance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |
| rectangle_tolerance | float | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class.

```python
def __init__(self, expression, match_case, unite_segments, ignore_formatting, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| unite_segments | bool | The value that indicates whether segments are united. |
| ignore_formatting | bool | The value that indicates whether text formatting is ignored. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |

#### __init__

Initializes a new instance of the `PageTextAreaOptions` class
with the size of the ignored border.

```python
def __init__(self, expression, match_case, unite_segments, ignore_formatting, rectangle, rectangle_tolerance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| unite_segments | bool | The value that indicates whether segments are united. |
| ignore_formatting | bool | The value that indicates whether text formatting is ignored. |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains page areas. |
| rectangle_tolerance | float | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### expression property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/expression.md

#### expression property

Gets the regular expression.
##### Definition:
```python
@property
def expression(self):
    ...
@expression.setter
def expression(self, value):
    ...
```

### ignore_formatting property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/ignore_formatting.md

#### ignore_formatting property

Gets the value that indicates whether text formatting is ignored.
##### Definition:
```python
@property
def ignore_formatting(self):
    ...
@ignore_formatting.setter
def ignore_formatting(self, value):
    ...
```

### match_case property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/match_case.md

#### match_case property

Gets the value that indicates whether a text case isn't ignored.
##### Definition:
```python
@property
def match_case(self):
    ...
@match_case.setter
def match_case(self, value):
    ...
```

### ocr_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/ocr_options.md

#### ocr_options property

Gets the additional options for OCR functionality.
##### Definition:
```python
@property
def ocr_options(self):
    ...
@ocr_options.setter
def ocr_options(self, value):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/rectangle.md

#### rectangle property

Gets the rectangular area that contains page areas.

### rectangle_tolerance property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/rectangle_tolerance.md

#### rectangle_tolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.

### unite_segments property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/unite_segments.md

#### unite_segments property

Gets the value that indicates whether segments are united.
##### Definition:
```python
@property
def unite_segments(self):
    ...
@unite_segments.setter
def unite_segments(self, value):
    ...
```

### use_ocr property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/pagetextareaoptions/use_ocr.md

#### use_ocr property

Gets the value that indicates whether OCR functionality is used to extract text areas.
##### Definition:
```python
@property
def use_ocr(self):
    ...
@use_ocr.setter
def use_ocr(self, value):
    ...
```

### ParseByTemplateOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsebytemplateoptions.md

#### ParseByTemplateOptions class

Provides the options which are used to parse by template.

The ParseByTemplateOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ParseByTemplateOptions` class. |
| __init__ | Initializes a new instance of the `ParseByTemplateOptions` class. |
| __init__ | Initializes a new instance of the `ParseByTemplateOptions` class with the OCR usage option. |
| __init__ | Initializes a new instance of the `ParseByTemplateOptions` class with the ability to set OCR options. |

##### Properties
| Property | Description |
| :- | :- |
| page_index | Gets or sets index of the page for which to perform a parsing by template.
<br/>The default value is `0`. |
| use_ocr | Gets the value that indicates whether the OCR Connector is used to parse by template. |
| ocr_options | Gets the additional options for OCR functionality. |

### ParseByTemplateOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsebytemplateoptions/__init__.md

#### __init__

Initializes a new instance of the `ParseByTemplateOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `ParseByTemplateOptions` class.

```python
def __init__(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The page index. |

#### __init__

Initializes a new instance of the `ParseByTemplateOptions` class with the OCR usage option.

```python
def __init__(self, page_index, use_ocr):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The page index. |
| use_ocr | bool | The value that indicates whether the OCR functionality is used to parse by template. |

#### __init__

Initializes a new instance of the `ParseByTemplateOptions` class with the ability to set OCR options.

```python
def __init__(self, page_index, use_ocr, ocr_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The page index. |
| use_ocr | bool | The value that indicates whether the OCR functionality is used to parse by template. |
| ocr_options | groupdocs.parser.options.OcrOptions | The additional options for OCR functionality. |

### ocr_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsebytemplateoptions/ocr_options.md

#### ocr_options property

Gets the additional options for OCR functionality.
##### Definition:
```python
@property
def ocr_options(self):
    ...
@ocr_options.setter
def ocr_options(self, value):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsebytemplateoptions/page_index.md

#### page_index property

Gets or sets index of the page for which to perform a parsing by template.
The default value is `0`.
##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### use_ocr property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsebytemplateoptions/use_ocr.md

#### use_ocr property

Gets the value that indicates whether the OCR Connector is used to parse by template.
##### Definition:
```python
@property
def use_ocr(self):
    ...
@use_ocr.setter
def use_ocr(self, value):
    ...
```

### ParserSettings class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsersettings.md

#### ParserSettings class

Provides the settings which are used to customize data extraction.

The ParserSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ParserSettings` class with the logger. |
| __init__ | Initializes a new instance of the `ParserSettings` class with the OCR Connector. |
| __init__ | Initializes a new instance of the `ParserSettings` class with the External Resource Handler. |
| __init__ | Initializes a new instance of the `ParserSettings` class with logger and OCR Connector. |
| __init__ | Initializes a new instance of the `ParserSettings` class with logger, OCR Connector and External Resource Handler. |

##### Properties
| Property | Description |
| :- | :- |
| logger | Gets the logger which is used for logging events and errors during data extraction. |
| ocr_connector | Gets the OCR Connector which is used to provide OCR functionality. |
| external_resource_handler | Gets the handler for external resources. |

##### Remarks

**Learn more:** |
|
 |

### ParserSettings constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsersettings/__init__.md

#### __init__

Initializes a new instance of the `ParserSettings` class with the logger.

```python
def __init__(self, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | groupdocs.parser.options.ILogger | An instance of class that implements `ILogger` interface. |

#### __init__

Initializes a new instance of the `ParserSettings` class with the OCR Connector.

```python
def __init__(self, ocr_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ocr_connector | groupdocs.parser.options.OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |

#### __init__

Initializes a new instance of the `ParserSettings` class with the External Resource Handler.

```python
def __init__(self, external_resource_handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| external_resource_handler | groupdocs.parser.options.ExternalResourceHandler | An instance of class that inherits `ExternalResourceHandler` class to provide the control of external resources loading. |

#### __init__

Initializes a new instance of the `ParserSettings` class with logger and OCR Connector.

```python
def __init__(self, logger, ocr_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | groupdocs.parser.options.ILogger | An instance of class that implements `ILogger` interface. |
| ocr_connector | groupdocs.parser.options.OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |

#### __init__

Initializes a new instance of the `ParserSettings` class with logger, OCR Connector and External Resource Handler.

```python
def __init__(self, logger, ocr_connector, external_resource_handler):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | groupdocs.parser.options.ILogger | An instance of class that implements `ILogger` interface. |
| ocr_connector | groupdocs.parser.options.OcrConnectorBase | An instance of class that inherits `OcrConnectorBase` class to provide OCR functionality. |
| external_resource_handler | groupdocs.parser.options.ExternalResourceHandler | An instance of class that inherits `ExternalResourceHandler` class to provide the control of external resource loading. |

### external_resource_handler property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsersettings/external_resource_handler.md

#### external_resource_handler property

Gets the handler for external resources.
##### Definition:
```python
@property
def external_resource_handler(self):
    ...
```

### logger property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsersettings/logger.md

#### logger property

Gets the logger which is used for logging events and errors during data extraction.
##### Definition:
```python
@property
def logger(self):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/parsersettings/ocr_connector.md

#### ocr_connector property

Gets the OCR Connector which is used to provide OCR functionality.
##### Definition:
```python
@property
def ocr_connector(self):
    ...
```

### PreviewOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions.md

#### PreviewOptions class

Provides options to sets requirements and stream delegates for preview generation.

The PreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed. |
| __init__ | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| width | Gets or sets the page preview width. |
| height | Gets or sets the page preview height. |
| page_numbers | Gets or sets an array of page numbers to generate previews. |
| preview_format | Gets or sets the preview image format. |
| create_page_stream | Gets or sets an instance of the page stream creation delegate. |
| release_page_stream | Gets or sets an instance of the page preview completion delegate. |
| dpi | Gets or sets a dpi. |
| preview_page_render | Gets or sets an instance of the page preview render info delegate. |

### PreviewOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/__init__.md

#### __init__

Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | groupdocs.parser.options.ICreatePageStream | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | groupdocs.parser.options.ICreatePageStream | Creates a stream for a specific page preview |
| release_page_stream | groupdocs.parser.options.IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### create_page_stream property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/create_page_stream.md

#### create_page_stream property

Gets or sets an instance of the page stream creation delegate.
##### Definition:
```python
@property
def create_page_stream(self):
    ...
@create_page_stream.setter
def create_page_stream(self, value):
    ...
```

### dpi property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/dpi.md

#### dpi property

Gets or sets a dpi.
##### Definition:
```python
@property
def dpi(self):
    ...
@dpi.setter
def dpi(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/height.md

#### height property

Gets or sets the page preview height.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.
##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.
##### Definition:
```python
@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...
```

### preview_page_render property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/preview_page_render.md

#### preview_page_render property

Gets or sets an instance of the page preview render info delegate.
##### Definition:
```python
@property
def preview_page_render(self):
    ...
@preview_page_render.setter
def preview_page_render(self, value):
    ...
```

### release_page_stream property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/release_page_stream.md

#### release_page_stream property

Gets or sets an instance of the page preview completion delegate.
##### Definition:
```python
@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/previewoptions/width.md

#### width property

Gets or sets the page preview width.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### QualityMode enumeration
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/qualitymode.md

#### QualityMode enumeration

Defines a level of the quality.

The QualityMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HIGH | Hight quality. Fast processing algorithms are used. |
| NORMAL | Normal quality. Default processing algorithms are used. |
| LOW | Low quality. Slow processing algorithms are used. |

### SearchOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions.md

#### SearchOptions class

Provides the options which are used for text search.

The SearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SearchOptions` class. |
| __init__ | Initializes a new instance of the `SearchOptions` class with the page limit. |
| __init__ | Initializes a new instance of the `SearchOptions` class which is used to search
<br/>with the highlight options for the left and the right highlight extraction. |
| __init__ | Initializes a new instance of the `SearchOptions` class which is used to search
<br/>with the same highlight options for the left and the right highlight extraction. |
| __init__ | Initializes a new instance of the `SearchOptions` class which is used to search
<br/>without highlight extraction. |
| __init__ | Initializes a new instance of the `SearchOptions` class which is used to search by pages and
<br/>without highlight extraction. |
| __init__ | Initializes a new instance of the `SearchOptions` class with default values. See remarks for details. |

##### Properties
| Property | Description |
| :- | :- |
| match_case | Gets the value that indicates whether a text case isn't ignored. |
| match_whole_word | Gets the value that indicates whether text search is limited by a whole word. |
| use_regular_expression | Gets the value that indicates whether a regular expression is used. |
| search_by_pages | Gets the value that indicates whether the search is performed by pages. |
| max_page_index | Gets the value that represents the max index of the page to search. |
| left_highlight_options | Gets the options for the left highlight. |
| right_highlight_options | Gets the options for the right highlight. |

##### Remarks

An instance of `SearchOptions` class is used as parameter
in `Parser.search` method. See the usage examples there.

### SearchOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/__init__.md

#### __init__

Initializes a new instance of the `SearchOptions` class with default values. See remarks for details.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `SearchOptions` class which is used to search
without highlight extraction.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |

#### __init__

Initializes a new instance of the `SearchOptions` class which is used to search
with the same highlight options for the left and the right highlight extraction.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression, highlight_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |
| highlight_options | groupdocs.parser.options.HighlightOptions | The options for both highlights. |

#### __init__

Initializes a new instance of the `SearchOptions` class which is used to search by pages and
without highlight extraction.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression, search_by_pages):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |
| search_by_pages | bool | The value that indicates whether the search is performed by pages. |

#### __init__

Initializes a new instance of the `SearchOptions` class which is used to search
with the highlight options for the left and the right highlight extraction.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression, left_highlight_options, right_highlight_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |
| left_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the left highlight. |
| right_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the right highlight. |

#### __init__

Initializes a new instance of the `SearchOptions` class.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression, search_by_pages, left_highlight_options, right_highlight_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |
| search_by_pages | bool | The value that indicates whether the search is performed by pages. |
| left_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the left highlight. |
| right_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the right highlight. |

#### __init__

Initializes a new instance of the `SearchOptions` class with the page limit.

```python
def __init__(self, match_case, match_whole_word, use_regular_expression, max_page_index, left_highlight_options, right_highlight_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| match_case | bool | The value that indicates whether a text case isn't ignored. |
| match_whole_word | bool | The value that indicates whether text search is limited by a whole word. |
| use_regular_expression | bool | The value that indicates whether a regular expression is used. |
| max_page_index | int | he value that indicates whether the search is performed by pages. |
| left_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the left highlight. |
| right_highlight_options | groupdocs.parser.options.HighlightOptions | The options for the right highlight. |

### left_highlight_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/left_highlight_options.md

#### left_highlight_options property

Gets the options for the left highlight.
##### Definition:
```python
@property
def left_highlight_options(self):
    ...
@left_highlight_options.setter
def left_highlight_options(self, value):
    ...
```

### match_case property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/match_case.md

#### match_case property

Gets the value that indicates whether a text case isn't ignored.
##### Definition:
```python
@property
def match_case(self):
    ...
@match_case.setter
def match_case(self, value):
    ...
```

### match_whole_word property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/match_whole_word.md

#### match_whole_word property

Gets the value that indicates whether text search is limited by a whole word.
##### Definition:
```python
@property
def match_whole_word(self):
    ...
@match_whole_word.setter
def match_whole_word(self, value):
    ...
```

### max_page_index property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/max_page_index.md

#### max_page_index property

Gets the value that represents the max index of the page to search.
##### Definition:
```python
@property
def max_page_index(self):
    ...
@max_page_index.setter
def max_page_index(self, value):
    ...
```

### right_highlight_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/right_highlight_options.md

#### right_highlight_options property

Gets the options for the right highlight.
##### Definition:
```python
@property
def right_highlight_options(self):
    ...
@right_highlight_options.setter
def right_highlight_options(self, value):
    ...
```

### search_by_pages property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/search_by_pages.md

#### search_by_pages property

Gets the value that indicates whether the search is performed by pages.
##### Definition:
```python
@property
def search_by_pages(self):
    ...
@search_by_pages.setter
def search_by_pages(self, value):
    ...
```

### use_regular_expression property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/searchoptions/use_regular_expression.md

#### use_regular_expression property

Gets the value that indicates whether a regular expression is used.
##### Definition:
```python
@property
def use_regular_expression(self):
    ...
@use_regular_expression.setter
def use_regular_expression(self, value):
    ...
```

### TextDocumentInfo class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo.md

#### TextDocumentInfo class

Represents the text document information.

**Inheritance:** `TextDocumentInfo` →
`DocumentInfo`

The TextDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | Gets the document type. |
| page_count | Gets the total number of document pages. |
| raw_page_count | Gets the total number of document raw pages. |
| size | Gets the size of the document in bytes. |
| pages | Gets the information about pages such as the index and page size. |
| encoding | Gets the detected encoding of the text document. |

##### Remarks

**Learn more:** |
|
 |
 |

### encoding property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/encoding.md

#### encoding property

Gets the detected encoding of the text document.
##### Definition:
```python
@property
def encoding(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/file_type.md

#### file_type property

Gets the document type.

### page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/page_count.md

#### page_count property

Gets the total number of document pages.

### pages property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/pages.md

#### pages property

Gets the information about pages such as the index and page size.

### raw_page_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/raw_page_count.md

#### raw_page_count property

Gets the total number of document raw pages.

##### Remarks

Use `DocumentInfo.raw_page_count` property instead of `DocumentInfo.page_count` property for raw text extraction.
Some documents have different page numbers in accurate and raw text extraction modes.
`DocumentInfo.page_count` property may perform extra calculations which impacts on text extraction speed in raw mode.

### size property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textdocumentinfo/size.md

#### size property

Gets the size of the document in bytes.

### TextOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textoptions.md

#### TextOptions class

Provides the options which are used for text extraction.

The TextOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextOptions` class. |
| __init__ | Initializes a new instance of the `TextOptions` class. |
| __init__ | Initializes a new instance of the `TextOptions` class with the OCR usage option. |
| __init__ | Initializes a new instance of the `TextOptions` class with the ability to set OCR options. |

##### Properties
| Property | Description |
| :- | :- |
| use_raw_mode_if_possible | Gets the value that indicates whether the raw mode is used. |
| use_ocr | Gets the value that indicates whether the OCR Connector is used to extract a text. |
| ocr_options | Gets the additional options for OCR functionality. |

##### Remarks

An instance of `TextOptions` class is used as parameter
in `Parser.get_text` and `Parser.get_text` methods. See the usage examples there.

It's used to specify the raw mode of text extraction.
A text in this mode is extracted in a non-accurate way but faster than in the standard mode.
If the raw mode doesn't support the document format, then this parameter is ignored and the standard mode is used.

**Learn more:** |
|
 |
 |

### TextOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textoptions/__init__.md

#### __init__

Initializes a new instance of the `TextOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `TextOptions` class.

```python
def __init__(self, use_raw_mode_if_possible):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| use_raw_mode_if_possible | bool | The value that indicates whether the raw mode is used. |

#### __init__

Initializes a new instance of the `TextOptions` class with the OCR usage option.

```python
def __init__(self, use_raw_mode_if_possible, use_ocr):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| use_raw_mode_if_possible | bool | The value that indicates whether the raw mode is used. |
| use_ocr | bool | The value that indicates whether the OCR functionality is used to extract a text. |

#### __init__

Initializes a new instance of the `TextOptions` class with the ability to set OCR options.

```python
def __init__(self, use_raw_mode_if_possible, use_ocr, ocr_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| use_raw_mode_if_possible | bool | The value that indicates whether the raw mode is used. |
| use_ocr | bool | The value that indicates whether the OCR functionality is used to extract a text. |
| ocr_options | groupdocs.parser.options.OcrOptions | The additional options for OCR functionality. |

### ocr_options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textoptions/ocr_options.md

#### ocr_options property

Gets the additional options for OCR functionality.
##### Definition:
```python
@property
def ocr_options(self):
    ...
@ocr_options.setter
def ocr_options(self, value):
    ...
```

### use_ocr property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textoptions/use_ocr.md

#### use_ocr property

Gets the value that indicates whether the OCR Connector is used to extract a text.
##### Definition:
```python
@property
def use_ocr(self):
    ...
@use_ocr.setter
def use_ocr(self, value):
    ...
```

### use_raw_mode_if_possible property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/textoptions/use_raw_mode_if_possible.md

#### use_raw_mode_if_possible property

Gets the value that indicates whether the raw mode is used.
##### Definition:
```python
@property
def use_raw_mode_if_possible(self):
    ...
@use_raw_mode_if_possible.setter
def use_raw_mode_if_possible(self, value):
    ...
```

### WorksheetOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/worksheetoptions.md

#### WorksheetOptions class

Provides the options which are used for the worksheet extraction.

The WorksheetOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WorksheetOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| ranges | Get a list of ranges. |

### WorksheetOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/worksheetoptions/__init__.md

#### __init__

Initializes a new instance of the `WorksheetOptions` class.

```python
def __init__(self, ranges):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ranges | list | The collection of ranges. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | The range collection or any of its elements cannot be null. |

### ranges property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.options/worksheetoptions/ranges.md

#### ranges property

Get a list of ranges.
##### Definition:
```python
@property
def ranges(self):
    ...
```

### groupdocs.parser.templates
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates.md

The namespace provides classes for creating templates for parsing document data.

##### Classes
| Class | Description |
| :- | :- |
| `Template` | Provides the document page template. It consists of `TemplateItem` objects
<br/>which represent the items of the template such as text field and table definitions. |
| `TemplateBarcode` | Provides the template barcode field. |
| `TemplateCollection` | Represents a collection of document parsing templates. |
| `TemplateField` | Provides the template text field. |
| `TemplateFixedPosition` | Provides a template field position which is defined by the rectangular area. |
| `TemplateItem` | Provides a base abstract class for template items. |
| `TemplateLinkedPosition` | Provides a template field position which uses the linked field. |
| `TemplateLinkedPositionEdges` | Provides the edges of the linked field where the text field is seached.
<br/>`TemplateLinkedPositionEdges` is used in `TemplateLinkedPosition` class. |
| `TemplateOptions` | Provides the options which are used for parsing by template functionality. |
| `TemplatePosition` | Provides a base abstract class for template positions. |
| `TemplateRegexPosition` | Provides a template field position which uses the regular expression. |
| `TemplateTable` | Provides the template table. |
| `TemplateTableLayout` | Provides the template table layout which is used by `TemplateTable` class to define table position. |
| `TemplateTableParameters` | Provides parameters for the table detection algorithms. |

### Template class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template.md

#### Template class

Provides the document page template. It consists of `TemplateItem` objects
which represent the items of the template such as text field and table definitions.

The Template type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Template |
| __init__ | Constructs a new instance of Template |

##### Properties
| Property | Description |
| :- | :- |
| is_ocr_compatible | Gets the value that indicates whether the template is compatible with OCR. |
| count | Gets the total number of template items. |
| options | Gets the template options. |

Gets the template item by an index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | The zero-based index of the template item. |

##### Methods
| Method | Description |
| :- | :- |
| load | Loads a template from a file. |
| load | Loads a template from a stream. |
| save | Saves a template to a file. |
| save | Saves a template to a stream. |

##### Remarks

**Learn more:** |
|
 |

### Template indexer
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/__getitem__.md

#### Template indexer

Gets the template item by an index.
##### Indexer
| Name | Description |
| :- | :- |
| index | The zero-based index of the template item. |

##### Returns

An instance of `TemplateItem` class.

### Template constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/__init__.md

#### __init__

Constructs a new instance of Template

```python
def __init__(self, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| items | list |  |

#### __init__

Constructs a new instance of Template

```python
def __init__(self, items, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| items | list |  |
| options | groupdocs.parser.templates.TemplateOptions |  |

### count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/count.md

#### count property

Gets the total number of template items.
##### Definition:
```python
@property
def count(self):
    ...
```

### is_ocr_compatible property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/is_ocr_compatible.md

#### is_ocr_compatible property

Gets the value that indicates whether the template is compatible with OCR.
##### Definition:
```python
@property
def is_ocr_compatible(self):
    ...
```

### load method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/load.md

#### load

Loads a template from a file.

##### Returns

An instance of `Template` class with loaded template.

```python
def load(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
##### Exceptions
| Exception | Description |
| :- | :- |
| `GroupDocsParserException` | The file does not represent the template in a valid format. |

#### load

Loads a template from a stream.

##### Returns

An instance of `Template` class with loaded template.

```python
def load(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The input stream. |
##### Exceptions
| Exception | Description |
| :- | :- |
| `GroupDocsParserException` | The stream does not represent the template in a valid format. |

### options property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/options.md

#### options property

Gets the template options.
##### Definition:
```python
@property
def options(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/template/save.md

#### save

Saves a template to a file.

```python
def save(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |

#### save

Saves a template to a stream.

```python
def save(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The output stream. |

### TemplateBarcode class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode.md

#### TemplateBarcode class

Provides the template barcode field.

**Inheritance:** `TemplateBarcode` →
`TemplateItem`

The TemplateBarcode type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateBarcode` class. |
| __init__ | Constructs a new instance of TemplateBarcode |
| __init__ | Constructs a new instance of TemplateBarcode |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the template item. |
| page_width | Gets the width of the page that was used to create the template item. |
| use_upper_case_name | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |
| rectangle | Gets the rectangular area that contains the template barcode field. |

##### Methods
| Method | Description |
| :- | :- |
| scale | Scales this template item by a given factor. |

### TemplateBarcode constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/__init__.md

#### __init__

Initializes a new instance of the `TemplateBarcode` class.

```python
def __init__(self, rectangle, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the template barcode field. |
| name | System.String | The barcode field name. |

#### __init__

Constructs a new instance of TemplateBarcode

```python
def __init__(self, rectangle, name, page_width):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |

#### __init__

Constructs a new instance of TemplateBarcode

```python
def __init__(self, rectangle, name, page_width, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |
| use_upper_case_name | bool |  |

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/name.md

#### name property

Gets the name of the template item.

### page_width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/page_width.md

#### page_width property

Gets the width of the page that was used to create the template item.

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/rectangle.md

#### rectangle property

Gets the rectangular area that contains the template barcode field.
##### Definition:
```python
@property
def rectangle(self):
    ...
```

### scale method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/scale.md

#### scale

Scales this template item by a given factor.

##### Returns

A new template item scaled by the given factor.

```python
def scale(self, factor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| factor | float | The scale factor. |

### use_upper_case_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatebarcode/use_upper_case_name.md

#### use_upper_case_name property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

### TemplateCollection class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection.md

#### TemplateCollection class

Represents a collection of document parsing templates.

The TemplateCollection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateCollection` class. |
| __init__ | Constructs a new instance of TemplateCollection |

##### Properties
| Property | Description |
| :- | :- |
| count | Gets the number of templates contained in the `TemplateCollection`. |

##### Methods
| Method | Description |
| :- | :- |
| get | Gets the template at the specified index. |
| add | Adds a template to the end of the `TemplateCollection`. |
| remove_at | Removes the template at the specified index of the `TemplateCollection`. |
| remove | Removes the first occurrence of a specific template from the `TemplateCollection`. |
| clear | Removes all elements from the `TemplateCollection`. |

### TemplateCollection constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/__init__.md

#### __init__

Initializes a new instance of the `TemplateCollection` class.

```python
def __init__(self):
    ...
```

#### __init__

Constructs a new instance of TemplateCollection

```python
def __init__(self, templates):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| templates | list |  |

### add method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/add.md

#### add

Adds a template to the end of the `TemplateCollection`.

```python
def add(self, template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The template to be added to the end of the `TemplateCollection`. |

### clear method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/clear.md

#### clear

Removes all elements from the `TemplateCollection`.

```python
def clear(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/count.md

#### count property

Gets the number of templates contained in the `TemplateCollection`.
##### Definition:
```python
@property
def count(self):
    ...
```

### get method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/get.md

#### get

Gets the template at the specified index.

##### Returns

The template at the specified index.

```python
def get(self, index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The zero-based index of the template to get. |

### remove method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/remove.md

#### remove

Removes the first occurrence of a specific template from the `TemplateCollection`.

##### Returns

`true` if template is successfully removed; otherwise, `false`.

```python
def remove(self, template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The template to remove from the `TemplateCollection`. |

### remove_at method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatecollection/remove_at.md

#### remove_at

Removes the template at the specified index of the `TemplateCollection`.

```python
def remove_at(self, index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The zero-based index of the element to remove. |

### TemplateField class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield.md

#### TemplateField class

Provides the template text field.

**Inheritance:** `TemplateField` →
`TemplateItem`

The TemplateField type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateField` class. |
| __init__ | Constructs a new instance of TemplateField |
| __init__ | Constructs a new instance of TemplateField |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the template item. |
| page_width | Gets the width of the page that was used to create the template item. |
| use_upper_case_name | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |
| position | Gets the value that describes how to find the template field on the document page. |
| is_hidden | Gets or sets the hidden template field flag. |
| value | Gets or sets the value of the template field. |

##### Methods
| Method | Description |
| :- | :- |
| scale | Scales this template item by a given factor. |

##### Remarks

Text fields are defined by its position on the page. There are three ways to define a text field:

|
|
 |
 |
 |

### TemplateField constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/__init__.md

#### __init__

Initializes a new instance of the `TemplateField` class.

```python
def __init__(self, position, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| position | groupdocs.parser.templates.TemplatePosition | The field position. |
| name | System.String | The field name. |

#### __init__

Constructs a new instance of TemplateField

```python
def __init__(self, position, name, page_width):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| position | groupdocs.parser.templates.TemplatePosition |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |

#### __init__

Constructs a new instance of TemplateField

```python
def __init__(self, position, name, page_width, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| position | groupdocs.parser.templates.TemplatePosition |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |
| use_upper_case_name | bool |  |

### is_hidden property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/is_hidden.md

#### is_hidden property

Gets or sets the hidden template field flag.
##### Definition:
```python
@property
def is_hidden(self):
    ...
@is_hidden.setter
def is_hidden(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/name.md

#### name property

Gets the name of the template item.

### page_width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/page_width.md

#### page_width property

Gets the width of the page that was used to create the template item.

### position property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/position.md

#### position property

Gets the value that describes how to find the template field on the document page.
##### Definition:
```python
@property
def position(self):
    ...
```

### scale method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/scale.md

#### scale

Scales this template item by a given factor.

##### Returns

A new template item scaled by the given factor.

```python
def scale(self, factor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| factor | float | The scale factor. |

### use_upper_case_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/use_upper_case_name.md

#### use_upper_case_name property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

### value property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefield/value.md

#### value property

Gets or sets the value of the template field.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### TemplateFixedPosition class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefixedposition.md

#### TemplateFixedPosition class

Provides a template field position which is defined by the rectangular area.

**Inheritance:** `TemplateFixedPosition` →
`TemplatePosition`

The TemplateFixedPosition type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateFixedPosition` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains the template field. |

##### Example

This is simplest way to define the field position.
It requires to set a rectangular area on the page that bounds the field value.
All the text that is contained (even partially) into the rectangular area will be extracted as a value:

### TemplateFixedPosition constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefixedposition/__init__.md

#### __init__

Initializes a new instance of the `TemplateFixedPosition` class.

```python
def __init__(self, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle | The rectangular area that contains the template field. |

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatefixedposition/rectangle.md

#### rectangle property

Gets the rectangular area that contains the template field.
##### Definition:
```python
@property
def rectangle(self):
    ...
```

### TemplateItem class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateitem.md

#### TemplateItem class

Provides a base abstract class for template items.

The TemplateItem type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the template item. |
| page_width | Gets the width of the page that was used to create the template item. |
| use_upper_case_name | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |

##### Methods
| Method | Description |
| :- | :- |
| scale | Scales this template item by a given factor. |

##### Remarks

The inheritors of `TemplateItem` class are used in `Template` collection.

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateitem/name.md

#### name property

Gets the name of the template item.
##### Definition:
```python
@property
def name(self):
    ...
```

### page_width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateitem/page_width.md

#### page_width property

Gets the width of the page that was used to create the template item.
##### Definition:
```python
@property
def page_width(self):
    ...
```

### scale method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateitem/scale.md

#### scale

Scales this template item by a given factor.

##### Returns

A new template item scaled by the given factor.

```python
def scale(self, factor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| factor | float | The scale factor. |

### use_upper_case_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateitem/use_upper_case_name.md

#### use_upper_case_name property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.
##### Definition:
```python
@property
def use_upper_case_name(self):
    ...
```

### TemplateLinkedPosition class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition.md

#### TemplateLinkedPosition class

Provides a template field position which uses the linked field.

**Inheritance:** `TemplateLinkedPosition` →
`TemplatePosition`

The TemplateLinkedPosition type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateLinkedPosition` class. |
| __init__ | Initializes a new instance of the `TemplateLinkedPosition` class with UPPER CASE linked field name. |
| __init__ | Initializes a new instance of the `TemplateLinkedPosition` class. |

##### Properties
| Property | Description |
| :- | :- |
| linked_field_name | Gets the linked field name. |
| search_area | Gets the size of the area where a field is searched. |
| edges | Gets the edges of the linked field where a field is searched. |
| auto_scale | Gets the value that indicates whether `TemplateLinkedPosition.search_area` is scaled by the linked field size. |

##### Example

The following example shows the code for the situation
if it's known that the field with an invoice number is placed on the right
of "Invoice number" string the following code is used:

### TemplateLinkedPosition constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition/__init__.md

#### __init__

Initializes a new instance of the `TemplateLinkedPosition` class.

```python
def __init__(self, linked_field_name, search_area, edges):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| linked_field_name | System.String | The name of the linked field. |
| search_area | groupdocs.parser.data.Size | The size of the area where a field is searched. |
| edges | groupdocs.parser.templates.TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |

#### __init__

Initializes a new instance of the `TemplateLinkedPosition` class with UPPER CASE linked field name.

```python
def __init__(self, linked_field_name, search_area, edges, auto_scale):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| linked_field_name | System.String | The name of the linked field. |
| search_area | groupdocs.parser.data.Size | The size of the area where a field is searched. |
| edges | groupdocs.parser.templates.TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |
| auto_scale | bool | The value that indicates whether `search_area` is scaled by the linked field size. |

#### __init__

Initializes a new instance of the `TemplateLinkedPosition` class.

```python
def __init__(self, linked_field_name, search_area, edges, auto_scale, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| linked_field_name | System.String | The name of the linked field. |
| search_area | groupdocs.parser.data.Size | The size of the area where a field is searched. |
| edges | groupdocs.parser.templates.TemplateLinkedPositionEdges | The edges of the linked field where a field is searched. |
| auto_scale | bool | The value that indicates whether `search_area` is scaled by the linked field size. |
| use_upper_case_name | bool | The value that indicates whether a `name` is converted to UPPER CASE. |

### auto_scale property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition/auto_scale.md

#### auto_scale property

Gets the value that indicates whether `TemplateLinkedPosition.search_area` is scaled by the linked field size.
##### Definition:
```python
@property
def auto_scale(self):
    ...
```

### edges property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition/edges.md

#### edges property

Gets the edges of the linked field where a field is searched.
##### Definition:
```python
@property
def edges(self):
    ...
```

### linked_field_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition/linked_field_name.md

#### linked_field_name property

Gets the linked field name.
##### Definition:
```python
@property
def linked_field_name(self):
    ...
```

### search_area property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedposition/search_area.md

#### search_area property

Gets the size of the area where a field is searched.
##### Definition:
```python
@property
def search_area(self):
    ...
```

### TemplateLinkedPositionEdges class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges.md

#### TemplateLinkedPositionEdges class

Provides the edges of the linked field where the text field is seached.
`TemplateLinkedPositionEdges` is used in `TemplateLinkedPosition` class.

The TemplateLinkedPositionEdges type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateLinkedPositionEdges` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_empty | Gets the value that indicates whether the instance is empty. |
| left | Gets the value that indicates whether a field is searched by the left from the linked field. |
| top | Gets the value that indicates whether a field is searched by the top from the linked field. |
| right | Gets the value that indicates whether a field is searched by the right from the linked field. |
| bottom | Gets the value that indicates whether a field is searched by the bottom from the linked field. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Converts the string representation of edges to its class equivalent. |
| try_parse | Converts the string representation of edges to its class equivalent.
<br/>A return value indicates whether the conversion is succeeded or failed. |

### TemplateLinkedPositionEdges constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/__init__.md

#### __init__

Initializes a new instance of the `TemplateLinkedPositionEdges` class.

```python
def __init__(self, left, top, right, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | bool | The value that indicates whether a field is searched by the left from the linked field. |
| top | bool | The value that indicates whether a field is searched by the top from the linked field. |
| right | bool | The value that indicates whether a field is searched by the right from the linked field. |
| bottom | bool | The value that indicates whether a field is searched by the bottom from the linked field. |

### bottom property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/bottom.md

#### bottom property

Gets the value that indicates whether a field is searched by the bottom from the linked field.
##### Definition:
```python
@property
def bottom(self):
    ...
```

### is_empty property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/is_empty.md

#### is_empty property

Gets the value that indicates whether the instance is empty.
##### Definition:
```python
@property
def is_empty(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/left.md

#### left property

Gets the value that indicates whether a field is searched by the left from the linked field.
##### Definition:
```python
@property
def left(self):
    ...
```

### parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/parse.md

#### parse

Converts the string representation of edges to its class equivalent.

##### Returns

An instance of `TemplateLinkedPositionEdges` class that is equivalent to the value specified in `s` parameter.

```python
def parse(self, s):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string that contains edges to convert. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | `s` does not represent edges in a valid format. |

### right property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/right.md

#### right property

Gets the value that indicates whether a field is searched by the right from the linked field.
##### Definition:
```python
@property
def right(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/top.md

#### top property

Gets the value that indicates whether a field is searched by the top from the linked field.
##### Definition:
```python
@property
def top(self):
    ...
```

### try_parse method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatelinkedpositionedges/try_parse.md

#### try_parse

Converts the string representation of edges to its class equivalent.
A return value indicates whether the conversion is succeeded or failed.

##### Returns

`true` if `s` is converted successfully; otherwise, `false`.

```python
def try_parse(self, s, edges):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| s | System.String | A string containing edges to convert. |
| edges | any | When the method returns, it contains the instance of `TemplateLinkedPositionEdges` class
<br/>that is equivalent to the value specified in `s` parameter, if the conversion is succeeded; otherwise, `null`. |

### TemplateOptions class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateoptions.md

#### TemplateOptions class

Provides the options which are used for parsing by template functionality.

The TemplateOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| rectangle_tolerance | Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### TemplateOptions constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateoptions/__init__.md

#### __init__

Initializes a new instance of the `TemplateOptions` class.

```python
def __init__(self, rectangle_tolerance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle_tolerance | float | The size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height. |

### rectangle_tolerance property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateoptions/rectangle_tolerance.md

#### rectangle_tolerance property

Gets the size of the border that is ignored when captured by the rectangular area. It's measured by the fraction of a text item height.
##### Definition:
```python
@property
def rectangle_tolerance(self):
    ...
```

### TemplatePosition class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateposition.md

#### TemplatePosition class

Provides a base abstract class for template positions.

The TemplatePosition type exposes the following members:

### TemplateRegexPosition class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateregexposition.md

#### TemplateRegexPosition class

Provides a template field position which uses the regular expression.

**Inheritance:** `TemplateRegexPosition` →
`TemplatePosition`

The TemplateRegexPosition type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateRegexPosition` class. |
| __init__ | Initializes a new instance of the `TemplateRegexPosition` class. |

##### Properties
| Property | Description |
| :- | :- |
| expression | Gets the regular expression. |
| match_case | Gets the value that indicates whether a text case isn't ignored. |

##### Example

The following example shows the situation
if the document contains "Invoice Number INV-12345" then template field can be defined in the following way:

In this case as a value the entire string is extracted.
To extract only a part of the string the regular expression group "value" is used:

In this case as a value "INV-3337" string is extracted.

### TemplateRegexPosition constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateregexposition/__init__.md

#### __init__

Initializes a new instance of the `TemplateRegexPosition` class.

```python
def __init__(self, expression):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |

#### __init__

Initializes a new instance of the `TemplateRegexPosition` class.

```python
def __init__(self, expression, match_case):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| expression | System.String | The regular expression. |
| match_case | bool | The value that indicates whether a text case isn't ignored. |

### expression property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateregexposition/expression.md

#### expression property

Gets the regular expression.
##### Definition:
```python
@property
def expression(self):
    ...
```

### match_case property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templateregexposition/match_case.md

#### match_case property

Gets the value that indicates whether a text case isn't ignored.
##### Definition:
```python
@property
def match_case(self):
    ...
```

### TemplateTable class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable.md

#### TemplateTable class

Provides the template table.

**Inheritance:** `TemplateTable` →
`TemplateItem`

The TemplateTable type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TemplateTable` class with the UPPER CASE name. |
| __init__ | Constructs a new instance of TemplateTable |
| __init__ | Constructs a new instance of TemplateTable |
| __init__ | Initializes a new instance of the `TemplateTable` class. |
| __init__ | Constructs a new instance of TemplateTable |
| __init__ | Constructs a new instance of TemplateTable |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets the name of the template item. |
| page_width | Gets the width of the page that was used to create the template item. |
| use_upper_case_name | Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE. |
| layout | Gets the table layout. |
| parameters | Gets the parameters to detect the table in the automatic mode. |

##### Methods
| Method | Description |
| :- | :- |
| scale | Scales this template item by a given factor. |

##### Remarks

There are two ways to define a table:

|
|
 |
 |

### TemplateTable constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/__init__.md

#### __init__

Initializes a new instance of the `TemplateTable` class with the UPPER CASE name.

```python
def __init__(self, layout, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| layout | groupdocs.parser.templates.TemplateTableLayout | The table layout. |
| name | System.String | The table name. |

##### Example

Template table is set by table layout if the table can't be detected automatically:

#### __init__

Initializes a new instance of the `TemplateTable` class.

```python
def __init__(self, parameters, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parameters | groupdocs.parser.templates.TemplateTableParameters | The parameters to detect the table in the automatic mode. |
| name | System.String | The table name. |

##### Example

If a template table is set by detector parameters, the table is detected automatically:

#### __init__

Constructs a new instance of TemplateTable

```python
def __init__(self, layout, name, page_width):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| layout | groupdocs.parser.templates.TemplateTableLayout |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |

#### __init__

Constructs a new instance of TemplateTable

```python
def __init__(self, parameters, name, page_width):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parameters | groupdocs.parser.templates.TemplateTableParameters |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |

#### __init__

Constructs a new instance of TemplateTable

```python
def __init__(self, layout, name, page_width, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| layout | groupdocs.parser.templates.TemplateTableLayout |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |
| use_upper_case_name | bool |  |

#### __init__

Constructs a new instance of TemplateTable

```python
def __init__(self, parameters, name, page_width, use_upper_case_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parameters | groupdocs.parser.templates.TemplateTableParameters |  |
| name | System.String |  |
| page_width | System.Nullable`1[[System.Double]] |  |
| use_upper_case_name | bool |  |

### layout property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/layout.md

#### layout property

Gets the table layout.
##### Definition:
```python
@property
def layout(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/name.md

#### name property

Gets the name of the template item.

### page_width property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/page_width.md

#### page_width property

Gets the width of the page that was used to create the template item.

### parameters property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/parameters.md

#### parameters property

Gets the parameters to detect the table in the automatic mode.
##### Definition:
```python
@property
def parameters(self):
    ...
```

### scale method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/scale.md

#### scale

Scales this template item by a given factor.

##### Returns

A new template item scaled by the given factor.

```python
def scale(self, factor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| factor | float | The scale factor. |

### use_upper_case_name property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetable/use_upper_case_name.md

#### use_upper_case_name property

Gets a boolean value that indicates whether a `Name` was converted to UPPER CASE.

### TemplateTableLayout class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout.md

#### TemplateTableLayout class

Provides the template table layout which is used by `TemplateTable` class to define table position.

The TemplateTableLayout type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of TemplateTableLayout |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains the table. |
| vertical_separators | Gets the table columns separators. |
| horizontal_separators | Gets the table rows separators. |

##### Methods
| Method | Description |
| :- | :- |
| move_to | Creates a new layout with the same size, separators and position in the `point`. |

### TemplateTableLayout constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout/__init__.md

#### __init__

Constructs a new instance of TemplateTableLayout

```python
def __init__(self, vertical_separators, horizontal_separators):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| vertical_separators | list |  |
| horizontal_separators | list |  |

### horizontal_separators property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout/horizontal_separators.md

#### horizontal_separators property

Gets the table rows separators.
##### Definition:
```python
@property
def horizontal_separators(self):
    ...
```

### move_to method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout/move_to.md

#### move_to

Creates a new layout with the same size, separators and position in the `point`.

##### Returns

A new layout with the same size, separators and position in the `point`.

```python
def move_to(self, point):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| point | groupdocs.parser.data.Point | The position of the new layout. |

##### Example

This functionality allows to move Table Layout.

For example, a document has tables on each page (or a set of documents with a table on the page).
These tables differ by position and content, but have the same columns and rows. In this case a user can define
`TemplateTableLayout` object at `(0, 0)` once and then move it to the location of the definite table.

If the table position depends on the other object of the page, a user can define `TemplateTableLayout` object based
on template document and then move it according to an anchor object. For example, if this is a summary table and
it is followed by details table (which can contain a different count of rows). In this case a user can define
`TemplateTableLayout` object on template document (with the known details table rectangle) and then move
`TemplateTableLayout` object according to the difference of details table rectangle of template and real document.

`TemplateTableLayout.move_to` method returns a copy of the current object.
A user can pass any coordinates (even negative - then layout will be moved to the left/top).

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout/rectangle.md

#### rectangle property

Gets the rectangular area that contains the table.
##### Definition:
```python
@property
def rectangle(self):
    ...
```

### vertical_separators property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetablelayout/vertical_separators.md

#### vertical_separators property

Gets the table columns separators.
##### Definition:
```python
@property
def vertical_separators(self):
    ...
```

### TemplateTableParameters class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters.md

#### TemplateTableParameters class

Provides parameters for the table detection algorithms.

The TemplateTableParameters type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of TemplateTableParameters |
| __init__ | Constructs a new instance of TemplateTableParameters |

##### Properties
| Property | Description |
| :- | :- |
| rectangle | Gets the rectangular area that contains the table. |
| has_merged_cells | Gets the value that indicates whether the table has merged cells. |
| min_row_count | Gets the minimum number of the table rows. |
| min_column_count | Gets the minimum number of the table columns. |
| min_vertical_space | Gets the minumum space between the table columns. |
| vertical_separators | Gets the table columns separators. |

##### Remarks

There are two algorithms to detect a table:

|
|
 |
 |

In some cases when algorithms can't detect a table or do it in non-accurate way
`TemplateTableLayout` class is used.

### TemplateTableParameters constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/__init__.md

#### __init__

Constructs a new instance of TemplateTableParameters

```python
def __init__(self, rectangle, vertical_separators):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle |  |
| vertical_separators | list |  |

#### __init__

Constructs a new instance of TemplateTableParameters

```python
def __init__(self, rectangle, vertical_separators, has_merged_cells, min_row_count, min_column_count, min_vertical_space):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rectangle | groupdocs.parser.data.Rectangle |  |
| vertical_separators | list |  |
| has_merged_cells | System.Nullable`1[[System.Boolean]] |  |
| min_row_count | System.Nullable`1[[System.Int32]] |  |
| min_column_count | System.Nullable`1[[System.Int32]] |  |
| min_vertical_space | System.Nullable`1[[System.Int32]] |  |

### has_merged_cells property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/has_merged_cells.md

#### has_merged_cells property

Gets the value that indicates whether the table has merged cells.
##### Definition:
```python
@property
def has_merged_cells(self):
    ...
```

### min_column_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/min_column_count.md

#### min_column_count property

Gets the minimum number of the table columns.
##### Definition:
```python
@property
def min_column_count(self):
    ...
```

### min_row_count property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/min_row_count.md

#### min_row_count property

Gets the minimum number of the table rows.
##### Definition:
```python
@property
def min_row_count(self):
    ...
```

### min_vertical_space property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/min_vertical_space.md

#### min_vertical_space property

Gets the minumum space between the table columns.
##### Definition:
```python
@property
def min_vertical_space(self):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/rectangle.md

#### rectangle property

Gets the rectangular area that contains the table.
##### Definition:
```python
@property
def rectangle(self):
    ...
```

### vertical_separators property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.templates/templatetableparameters/vertical_separators.md

#### vertical_separators property

Gets the table columns separators.
##### Definition:
```python
@property
def vertical_separators(self):
    ...
```

### groupdocs.parser
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser.md

The namespace provides classes for parsing data from documents.
With the main class `Parser` you may use all document data parsing and extraction features.

##### Classes
| Class | Description |
| :- | :- |
| `License` | Provides methods to license the component.
<br/>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. |
| `Parser` | Represents the main class that controls text, images, container extraction and parsing functionality. |

### License class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/license.md

#### License class

Provides methods to license the component.
Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing).

The License type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `License` class. |

##### Methods
| Method | Description |
| :- | :- |
| set_license | Licenses the component. |
| set_license | Licenses the component. |

### License constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/license/__init__.md

#### __init__

Initializes a new instance of the `License` class.

```python
def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/license/set_license.md

#### set_license

Licenses the component.

```python
def set_license(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Absolute path to license file. |

##### Example

The following example demonstrates how to set a license passing a path to the license file.

#### set_license

Licenses the component.

```python
def set_license(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | License stream. |

##### Example

The following example demonstrates how to set a license passing Stream of the license file.

### Metered class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/metered.md

#### Metered class

Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license.

The Metered type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Metered` class. |

##### Methods
| Method | Description |
| :- | :- |
| set_metered_key | Activates product with Metered keys. |
| get_consumption_quantity | Retrieves amount of MBs processed. |
| get_consumption_credit | Retrieves count of credits consumed. |

### Metered constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/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/parser/python-net/groupdocs.parser/metered/get_consumption_credit.md

#### get_consumption_credit

Retrieves count of credits consumed.

##### Returns

A decimal value that represents the consumption credit.

```python
def get_consumption_credit(self):
    ...
```

##### Example

Following example demonstrates how to retrieve count of credits consumed.

### get_consumption_quantity method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/metered/get_consumption_quantity.md

#### get_consumption_quantity

Retrieves amount of MBs processed.

##### Returns

A decimal value that represents the consumption quantity.

```python
def get_consumption_quantity(self):
    ...
```

##### Example

Following example demonstrates how to retrieve amount of MBs processed.

### set_metered_key method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/metered/set_metered_key.md

#### set_metered_key

Activates product with Metered keys.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key | System.String | A public key. |
| private_key | System.String | A private key |

##### Example

Following example demonstrates how to activate product with Metered keys.

### Parser class
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser.md

#### Parser class

Represents the main class that controls text, images, container extraction and parsing functionality.

The Parser type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Parser` class. |
| __init__ | Initializes a new instance of the `Parser` class with `LoadOptions`. |
| __init__ | Initializes a new instance of the `Parser` class with `ParserSettings`. |
| __init__ | Initializes a new instance of the `Parser` class with `LoadOptions`
<br/>and `ParserSettings`. |
| __init__ | Initializes a new instance of the `Parser` class. |
| __init__ | Initializes a new instance of the `Parser` class with `LoadOptions`. |
| __init__ | Initializes a new instance of the `Parser` class with `ParserSettings`. |
| __init__ | Initializes a new instance of the `Parser` class with `LoadOptions`
<br/>and `ParserSettings`. |

##### Properties
| Property | Description |
| :- | :- |
| features | Gets the supported features. |

##### Methods
| Method | Description |
| :- | :- |
| get_file_info | Returns the general information about a file. |
| get_file_info | Returns the general information about a file. |
| get_file_info | Returns the general information about a file. |
| get_file_info | Returns the general information about a file. |
| get_page_preview | Generates a document page preview. |
| get_page_preview | Generates a document page preview using customization options. |
| get_text | Extracts a text from the document. |
| get_text | Extracts a text page from the document using text options (to enable raw fast text extraction mode). |
| get_text | Extracts a text from the document page. |
| get_text | Extracts a text from the document page using text options (to enable raw fast text extraction mode). |
| get_formatted_text | Extracts a formatted text from the document. |
| get_formatted_text | Extracts a formatted text from the document page. |
| search | Searches a `keyword` in the document. |
| search | Searches a `keyword` in the document using search options (regular expression, match case, etc.). |
| get_text_areas | Extracts text areas from the document. |
| get_text_areas | Extracts text areas from the document using customization options (regular expression, match case, etc.). |
| get_text_areas | Extracts text areas from the document page. |
| get_text_areas | Extracts text areas from the document page using customization options (regular expression, match case, etc.). |
| get_images | Extracts images from the document. |
| get_images | Extracts images from the document using customization options
<br/>(to set the rectangular area that contains images). |
| get_images | Extracts images from the document page. |
| get_images | Extracts images from the document page using customization options
<br/>(to set the rectangular area that contains images). |
| get_hyperlinks | Extracts hyperlinks from the document. |
| get_hyperlinks | Extracts hyperlinks from the document page. |
| get_hyperlinks | Extracts hyperlinks from the document using customization options
<br/>(to set the rectangular area that contains hyperlinks). |
| get_hyperlinks | Extracts hyperlinks from the document page using customization options
<br/>(to set the rectangular area that contains hyperlinks). |
| get_barcodes | Extracts barcodes from the document. |
| get_barcodes | Extracts barcodes from the document page. |
| get_barcodes | Extracts barcodes from the document using customization options
<br/>(to set the rectangular area that contains barcodes). |
| get_barcodes | Extracts barcodes from the document using customization options. |
| get_barcodes | Extracts barcodes from the document page using customization options
<br/>(to set the rectangular area that contains barcodes). |
| get_barcodes | Extracts barcodes from the document page using customization options. |
| get_tables | Extracts tables from the document. |
| get_tables | Extracts tables from the document page. |
| get_tables | Extracts tables from the document. |
| get_tables | Extracts tables from the document page. |
| get_worksheet_info | Extracts the info about all worksheets in the spreadsheet. |
| get_worksheet_info | Extracts the info about the worksheet. |
| get_worksheet_cells | Extracts worksheet cells. |
| get_worksheet_cells | Extracts worksheet cells using customization options. |
| parse_by_template | Parses the document by the user-generated template. |
| parse_by_template | Parses the document by the user-generated template using customization options. |
| parse_by_template | Selects the most suitable template from the provided collection and then parses the document against the selected template. |
| parse_pages_by_template | Parses the document pages by the user-generated template. |
| parse_pages_by_template | Parses the document pages by the user-generated template using customization options. |
| generate_preview | Get pages preview. |
| get_document_info | Returns the general information about the document. |
| get_highlight | Extracts a highlight from the document. |
| get_toc | Extracts a table of contents from the document. |
| get_container | Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc. |
| get_metadata | Extracts metadata from the document. |
| generate_adjustment_fields | Generates fields for automatic adjustment of template position and scale. |
| parse_form | Parses the document form. |

### Parser constructor
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/__init__.md

#### __init__

Initializes a new instance of the `Parser` class.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |

##### Example

The following example shows how to load the document from the local disk:

#### __init__

Initializes a new instance of the `Parser` class.

```python
def __init__(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |

##### Example

The following example shows how to load the document from the stream:

#### __init__

Initializes a new instance of the `Parser` class with `LoadOptions`.

```python
def __init__(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |

##### Example

The document password is passed by LoadOptions class:

#### __init__

Initializes a new instance of the `Parser` class with `ParserSettings`.

```python
def __init__(self, file_path, parser_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
| parser_settings | groupdocs.parser.options.ParserSettings | The parser settings which are used to customize data extraction. |

#### __init__

Initializes a new instance of the `Parser` class with `LoadOptions`.

```python
def __init__(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |

##### Example

In some cases it's necessary to define `FileFormat`.
Both for special cases (databases, email server) and for detecting file types by the content:

The document password is passed by `LoadOptions` class:

#### __init__

Initializes a new instance of the `Parser` class with `ParserSettings`.

```python
def __init__(self, document, parser_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |
| parser_settings | groupdocs.parser.options.ParserSettings | The parser settings which are used to customize data extraction. |

#### __init__

Initializes a new instance of the `Parser` class with `LoadOptions`
and `ParserSettings`.

```python
def __init__(self, file_path, load_options, parser_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |
| parser_settings | groupdocs.parser.options.ParserSettings | The parser settings which are used to customize data extraction. |

##### Example

The following example shows how to receive the information via `ILogger` interface:

#### __init__

Initializes a new instance of the `Parser` class with `LoadOptions`
and `ParserSettings`.

```python
def __init__(self, document, load_options, parser_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |
| parser_settings | groupdocs.parser.options.ParserSettings | The parser settings which are used to customize data extraction. |

##### Example

The following example shows how to receive the information via `ILogger` interface:

### features property
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/features.md

#### features property

Gets the supported features.

##### Remarks

**Learn more:** |
|
 |

##### Example

If the feature isn't supported, the method returns `null` instead of the value.
Some operations may consume significant time. So it's not optimal to call the method to just check the support for the feature.
For this purpose Features property is used:
##### Definition:
```python
@property
def features(self):
    ...
```

### generate_adjustment_fields method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/generate_adjustment_fields.md

#### generate_adjustment_fields

Generates fields for automatic adjustment of template position and scale.

##### Returns

Generated auxiliary template fields for a document page.

```python
def generate_adjustment_fields(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.AdjustmentFieldsOptions | The generate fields options. |

### generate_preview method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/generate_preview.md

#### generate_preview

Get pages preview.

```python
def generate_preview(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | groupdocs.parser.options.PreviewOptions | The options to sets requirements and stream delegates for preview generation. |
##### Exceptions
| Exception | Description |
| :- | :- |
| NotSupportedException | Preview generation isn't supported for this document type. |

### get_barcodes method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_barcodes.md

#### get_barcodes

Extracts barcodes from the document.

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self):
    ...
```

##### Example

The following example shows how to extract barcodes from a document:

#### get_barcodes

Extracts barcodes from the document page.

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

The following example shows how to extract barcodes from a document page:

#### get_barcodes

Extracts barcodes from the document using customization options
(to set the rectangular area that contains barcodes).

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.PageAreaOptions | The options for barcodes extraction. |

##### Example

The following example shows how to extract barcodes from the upper-right corner.

#### get_barcodes

Extracts barcodes from the document using customization options.

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.BarcodeOptions | The options for barcodes extraction. |

##### Example

The following example shows how to extract barcodes from the upper-right corner.

#### get_barcodes

Extracts barcodes from the document page using customization options
(to set the rectangular area that contains barcodes).

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PageAreaOptions | The options for barcodes extraction. |

#### get_barcodes

Extracts barcodes from the document page using customization options.

##### Returns

A collection of `PageBarcodeArea` objects;
`null` if barcodes extraction isn't supported.

```python
def get_barcodes(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.BarcodeOptions | The options for barcodes extraction. |

### get_container method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_container.md

#### get_container

Extracts a container object from the document to work with formats that contain attachments, ZIP archives etc.

##### Returns

A collection of container items;
`null` if container extraction isn't supported.

```python
def get_container(self):
    ...
```

##### Example

The following example shows how to extract attachments from a container:

### get_document_info method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_document_info.md

#### get_document_info

Returns the general information about the document.

##### Returns

An instance of class that implements `IDocumentInfo` interface.

```python
def get_document_info(self):
    ...
```

##### Example

The following example shows how to get document info:

### get_file_info method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_file_info.md

#### get_file_info

Returns the general information about a file.

##### Returns

An instance of `FileInfo` class.

```python
def get_file_info(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |

##### Example

The following code shows how to check whether a file is password-protected:

#### get_file_info

Returns the general information about a file.

##### Returns

An instance of `FileInfo` class.

```python
def get_file_info(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |

##### Example

The following code shows how to check whether a file is password-protected:

#### get_file_info

Returns the general information about a file.

##### Returns

An instance of `FileInfo` class.

```python
def get_file_info(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The path to the file. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |

##### Example

The following code shows how to check a file type of the password-protected document:

#### get_file_info

Returns the general information about a file.

##### Returns

An instance of `FileInfo` class.

```python
def get_file_info(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The source input stream. |
| load_options | groupdocs.parser.options.LoadOptions | The options to open the file. |

##### Example

The following code shows how to check a file type of the password-protected document:

### get_formatted_text method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_formatted_text.md

#### get_formatted_text

Extracts a formatted text from the document.

##### Returns

An instance of TextReader class with the extracted text;
`null` if formatted text extraction isn't supported.

```python
def get_formatted_text(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.FormattedTextOptions | The formatted text extraction options. |

##### Example

The following example shows how to extract a document text as HTML text:

#### get_formatted_text

Extracts a formatted text from the document page.

##### Returns

An instance of TextReader class with the extracted text;
`null` if formatted text page extraction isn't supported.

```python
def get_formatted_text(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.FormattedTextOptions | The formatted text extraction options. |

##### Example

The following example shows how to extract a document page text as Markdown text:

### get_highlight method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_highlight.md

#### get_highlight

Extracts a highlight from the document.

##### Returns

An instance of `HighlightItem` class that represents the extracted highlight;
`null` if highlight extraction isn't supported.

```python
def get_highlight(self, position, is_direct, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| position | int | The start position of the highlight. |
| is_direct | bool | The value that indicates whether highlight extraction is direct.
<br/>`true` if the higlight is extracted by the right of `position`; otherwise, `false`. |
| options | groupdocs.parser.options.HighlightOptions | The highlight extraction options. |

##### Example

The following example shows how to extract a highlight that contains 3 words:

### get_hyperlinks method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_hyperlinks.md

#### get_hyperlinks

Extracts hyperlinks from the document.

##### Returns

A collection of `PageHyperlinkArea` objects;
`null` if hyperlinks extraction isn't supported.

```python
def get_hyperlinks(self):
    ...
```

##### Example

The following example shows how to extract all hyperlinks from the whole document:

#### get_hyperlinks

Extracts hyperlinks from the document page.

##### Returns

A collection of `PageHyperlinkArea` objects;
`null` if hyperlinks extraction isn't supported.

```python
def get_hyperlinks(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

The following example shows how to extract hyperlinks from the document page:

#### get_hyperlinks

Extracts hyperlinks from the document using customization options
(to set the rectangular area that contains hyperlinks).

##### Returns

A collection of `PageHyperlinkArea` objects;
`null` if hyperlinks extraction isn't supported.

```python
def get_hyperlinks(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.PageAreaOptions | The options for hyperlinks extraction. |

##### Example

The following example shows how to extract hyperlinks from the document page area:

#### get_hyperlinks

Extracts hyperlinks from the document page using customization options
(to set the rectangular area that contains hyperlinks).

##### Returns

A collection of `PageHyperlinkArea` objects;
`null` if hyperlinks extraction isn't supported.

```python
def get_hyperlinks(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PageAreaOptions | The options for hyperlinks extraction. |

##### Example

The following example shows how to extract hyperlinks from the document page area using customization options:

### get_images method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_images.md

#### get_images

Extracts images from the document.

##### Returns

A collection of `PageImageArea` objects;
`null` if images extraction isn't supported.

```python
def get_images(self):
    ...
```

##### Example

The following example shows how to extract all images from the whole document:

#### get_images

Extracts images from the document using customization options
(to set the rectangular area that contains images).

##### Returns

A collection of `PageImageArea` objects;
`null` if images extraction isn't supported.

```python
def get_images(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.PageAreaOptions | The options for images extraction. |

##### Example

The following example shows how to extract only images from the upper-left courner:

#### get_images

Extracts images from the document page.

##### Returns

A collection of `PageImageArea` objects;
`null` if images extraction isn't supported.

```python
def get_images(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

To extract images from a document page the following method is used:

#### get_images

Extracts images from the document page using customization options
(to set the rectangular area that contains images).

##### Returns

A collection of `PageImageArea` objects;
`null` if images extraction isn't supported.

```python
def get_images(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PageAreaOptions | The options for images extraction. |

### get_metadata method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_metadata.md

#### get_metadata

Extracts metadata from the document.

##### Returns

A collection of metadata items;
`null` if metadata extraction isn't supported.

```python
def get_metadata(self):
    ...
```

##### Example

The following example shows how to extract metadata from a document:

### get_page_preview method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_page_preview.md

#### get_page_preview

Generates a document page preview.

##### Returns

An instance of Stream containing an image of the document page; `null` if the page preview generation isn't supported.

```python
def get_page_preview(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

#### get_page_preview

Generates a document page preview using customization options.

##### Returns

An instance of Stream containing an image of the document page; `null` if the page preview generation isn't supported.

```python
def get_page_preview(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PagePreviewOptions | The options to customize the preview generation. |

### get_tables method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_tables.md

#### get_tables

Extracts tables from the document.

##### Returns

A collection of `PageTableArea` objects;
`null` if tables extraction isn't supported.

```python
def get_tables(self):
    ...
```

##### Example

The following example shows how to extract tables from the whole document:

#### get_tables

Extracts tables from the document.

##### Returns

A collection of `PageTableArea` objects;
`null` if tables extraction isn't supported.

```python
def get_tables(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.PageTableAreaOptions | The options for tables extraction. |

##### Example

The following example shows how to extract tables from the whole document:

#### get_tables

Extracts tables from the document page.

##### Returns

A collection of `PageTableArea` objects;
`null` if tables extraction isn't supported.

```python
def get_tables(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

The following example shows how to extract tables from the document page:

#### get_tables

Extracts tables from the document page.

##### Returns

A collection of `PageTableArea` objects;
`null` if tables extraction isn't supported.

```python
def get_tables(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PageTableAreaOptions | The options for tables extraction. |

##### Example

The following example shows how to extract tables from the document page:

### get_text method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_text.md

#### get_text

Extracts a text from the document.

##### Returns

An instance of TextReader class with the extracted text;
`null` if text extraction isn't supported.

```python
def get_text(self):
    ...
```

##### Example

The following example shows how to extract a text from a document:

#### get_text

Extracts a text page from the document using text options (to enable raw fast text extraction mode).

##### Returns

An instance of TextReader class with the extracted text;
`null` if text extraction isn't supported.

```python
def get_text(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.TextOptions | The text extraction options. |

##### Example

The following example shows how to extract a raw text from a document:

#### get_text

Extracts a text from the document page.

##### Returns

An instance of TextReader class with the extracted text;
`null` if text page extraction isn't supported.

```python
def get_text(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

The following example shows how to extract a text from the document page:

#### get_text

Extracts a text from the document page using text options (to enable raw fast text extraction mode).

##### Returns

An instance of TextReader class with the extracted text;
`null` if text page extraction isn't supported.

```python
def get_text(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.TextOptions | The text extraction options. |

##### Example

The following example shows how to extract a raw text from the document page:

### get_text_areas method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_text_areas.md

#### get_text_areas

Extracts text areas from the document.

##### Returns

A collection of `PageTextArea` objects;
`null` if text areas extraction isn't supported.

```python
def get_text_areas(self):
    ...
```

##### Example

The following example shows how to extract all text areas from the whole document:

#### get_text_areas

Extracts text areas from the document using customization options (regular expression, match case, etc.).

##### Returns

A collection of `PageTextArea` objects;
`null` if text areas extraction isn't supported.

```python
def get_text_areas(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | groupdocs.parser.options.PageTextAreaOptions | The options for text area extraction. |

##### Example

The following example shows how to extract only text areas with digits from the upper-left courner:

#### get_text_areas

Extracts text areas from the document page.

##### Returns

A collection of `PageTextArea` objects;
`null` if text areas extraction isn't supported.

```python
def get_text_areas(self, page_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |

##### Example

To extract text areas from a document page the following method is used:

#### get_text_areas

Extracts text areas from the document page using customization options (regular expression, match case, etc.).

##### Returns

A collection of `PageTextArea` objects;
`null` if text areas extraction isn't supported.

```python
def get_text_areas(self, page_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_index | int | The zero-based page index. |
| options | groupdocs.parser.options.PageTextAreaOptions | The options for text area extraction. |

### get_toc method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_toc.md

#### get_toc

Extracts a table of contents from the document.

##### Returns

A collection of table of contents items;
`null` if table of contents extraction isn't supported.

```python
def get_toc(self):
    ...
```

##### Example

The following example shows how to extract table of contents from CHM file:

### get_worksheet_cells method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_worksheet_cells.md

#### get_worksheet_cells

Extracts worksheet cells.

##### Returns

A collection of instances of `WorksheetCell` class that contains the cell data.

```python
def get_worksheet_cells(self, worksheet_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | int | The zero-based index of the worksheet. |

#### get_worksheet_cells

Extracts worksheet cells using customization options.

##### Returns

A collection of instances of `WorksheetCell` class that contains the cell data.

```python
def get_worksheet_cells(self, worksheet_index, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | int | The zero-based index of the worksheet. |
| options | groupdocs.parser.options.WorksheetOptions | The customization options. |

### get_worksheet_info method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/get_worksheet_info.md

#### get_worksheet_info

Extracts the info about all worksheets in the spreadsheet.

##### Returns

A collection of instances of `WorksheetInfo` class that contains the info about all worksheets in the spreadsheet.

```python
def get_worksheet_info(self):
    ...
```

#### get_worksheet_info

Extracts the info about the worksheet.

##### Returns

An instance of `WorksheetInfo` class that contains the info about all worksheets in the spreadsheet.

```python
def get_worksheet_info(self, worksheet_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| worksheet_index | int | The zero-based index of the worksheet. |

### parse_by_template method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/parse_by_template.md

#### parse_by_template

Parses the document by the user-generated template.

##### Returns

An instance of `DocumentData` class that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_by_template(self, template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The user-generated template. |

#### parse_by_template

Parses the document by the user-generated template using customization options.

##### Returns

An instance of `DocumentData` class that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_by_template(self, template, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The user-generated template. |
| options | groupdocs.parser.options.ParseByTemplateOptions | The customization options. |

#### parse_by_template

Selects the most suitable template from the provided collection and then parses the document against the selected template.

##### Returns

An instance of `DocumentData` class that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_by_template(self, template_collection, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template_collection | groupdocs.parser.templates.TemplateCollection | The template collection. |
| options | groupdocs.parser.options.ParseByTemplateOptions | The customization options. |

### parse_form method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/parse_form.md

#### parse_form

Parses the document form.

##### Returns

An instance of `DocumentData` class that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_form(self):
    ...
```

##### Example

The following example shows how to parse a form of the document:

### parse_pages_by_template method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/parse_pages_by_template.md

#### parse_pages_by_template

Parses the document pages by the user-generated template.

##### Returns

A collection of `DocumentPageData` objects that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_pages_by_template(self, template):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The user-generated template. |

#### parse_pages_by_template

Parses the document pages by the user-generated template using customization options.

##### Returns

A collection of `DocumentPageData` objects that contains the extracted data;
`null` if parsing by template isn't supported.

```python
def parse_pages_by_template(self, template, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| template | groupdocs.parser.templates.Template | The user-generated template. |
| options | groupdocs.parser.options.ParseByTemplateOptions | The customization options. |

### search method
Path: https://reference.groupdocs.com/parser/python-net/groupdocs.parser/parser/search.md

#### search

Searches a `keyword` in the document.

##### Returns

A collection of `SearchResult` objects;
`null` if search isn't supported.

```python
def search(self, keyword):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| keyword | System.String | The keyword to search. |

##### Example

The following example shows how to find a keyword in a document:

#### search

Searches a `keyword` in the document using search options (regular expression, match case, etc.).

##### Returns

A collection of `SearchResult` objects;
`null` if search isn't supported.

```python
def search(self, keyword, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| keyword | System.String | The keyword to search. |
| options | groupdocs.parser.options.SearchOptions | The search options. |

##### Example

The following example shows how to search with a regular expression in a document:

The following example shows how to search a text on pages:


# GroupDocs.Redaction

> Remove sensitive text, metadata, and annotations from documents.

## Java

### GroupDocs.Redaction for Java
Path: https://reference.groupdocs.com/redaction/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.redaction | The package provides classes for redacting sensitive information from documents in PDF, raster image and office document formats. |
| com.groupdocs.redaction.configuration | The package provides document format configuration classes. |
| com.groupdocs.redaction.exceptions | The package provides different exceptions classes. |
| com.groupdocs.redaction.integration | The package provides interfaces and classes, used to integrate documents of different formats with GroupDocs.Redactions. |
| com.groupdocs.redaction.licensing | The package provides classes to set license or use Metered billing. |
| com.groupdocs.redaction.options | The package provides load and save options classes. |
| com.groupdocs.redaction.redactions | The package provides classes for different types of redactions. |

### com.groupdocs.redaction.configuration
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.configuration.md

The package provides document format configuration classes.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatConfiguration | Represents a type reference for  DocumentFormatInstance -derived class and supported file extensions list for faster format detection. |
| RedactorConfiguration | Provides access to a list of supported formats, built-in and custom user formats. |

### DocumentFormatConfiguration
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.configuration/documentformatconfiguration.md

**Inheritance:**
java.lang.Object
```
public class DocumentFormatConfiguration
```

Represents a type reference for  DocumentFormatInstance -derived class and supported file extensions list for faster format detection.

The following example demonstrates how to set properties for a custom format configuration.

```

  DocumentFormatConfiguration adobePhotoshopSettings = new DocumentFormatConfiguration();
 adobePhotoshopSettings.setExtensionFilter(".psd");
 adobePhotoshopSettings.setDocumentType(MyAdobePhotoshopFormatInstance.class);
 
```

[Extend supported extensions list]: https://docs.groupdocs.com/redaction/java/extend-supported-extensions-list/
[Create custom format handler]: https://docs.groupdocs.com/redaction/java/create-custom-format-handler/
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentFormatConfiguration() | Initializes a new instance of DocumentFormatConfiguration class. |
#### Methods

| Method | Description |
| --- | --- |
| getExtensionFilter() | Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive. |
| setExtensionFilter(String value) | Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive. |
| getDocumentType() | Gets or sets the type of a class, inheriting from DocumentFormatInstance. |
| setDocumentType(Class value) | Gets or sets the type of a class, inheriting from DocumentFormatInstance. |
| getInitializationData() | Gets or sets data, required for DocumentFormatInstance initialization. |
| setInitializationData(System.Collections.Generic.Dictionary<String,String> value) | Gets or sets data, required for DocumentFormatInstance initialization. |
| supportsExtension(String fileExtension) | Checks if a given file extension can be handled as DocumentType. |
##### DocumentFormatConfiguration()
```
public DocumentFormatConfiguration()
```

Initializes a new instance of DocumentFormatConfiguration class.

##### getExtensionFilter()
```
public final String getExtensionFilter()
```

Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.

**Returns:**
java.lang.String
##### setExtensionFilter(String value)
```
public final void setExtensionFilter(String value)
```

Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDocumentType()
```
public final Class getDocumentType()
```

Gets or sets the type of a class, inheriting from DocumentFormatInstance.

**Returns:**
java.lang.Class
##### setDocumentType(Class value)
```
public final void setDocumentType(Class value)
```

Gets or sets the type of a class, inheriting from DocumentFormatInstance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Class |  |

##### getInitializationData()
```
public final System.Collections.Generic.Dictionary<String,String> getInitializationData()
```

Gets or sets data, required for DocumentFormatInstance initialization.

**Returns:**
com.aspose.ms.System.Collections.Generic.Dictionary<java.lang.String,java.lang.String>
##### setInitializationData(System.Collections.Generic.Dictionary<String,String> value)
```
public final void setInitializationData(System.Collections.Generic.Dictionary<String,String> value)
```

Gets or sets data, required for DocumentFormatInstance initialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Collections.Generic.Dictionary<java.lang.String,java.lang.String> |  |

##### supportsExtension(String fileExtension)
```
public final boolean supportsExtension(String fileExtension)
```

Checks if a given file extension can be handled as DocumentType.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | java.lang.String | File extension, format is ".ext" |

**Returns:**
boolean - True if the extension is listed in ExtensionFilter

### RedactorConfiguration
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.configuration/redactorconfiguration.md

**Inheritance:**
java.lang.Object
```
public class RedactorConfiguration
```

Provides access to a list of supported formats, built-in and custom user formats.

The following example demonstrates how to add a custom user format handler.

```

  DocumentFormatConfiguration adobePhotoshopSettings = new DocumentFormatConfiguration();
 adobePhotoshopSettings.setExtensionFilter(".psd");
 adobePhotoshopSettings.setDocumentType(MyAdobePhotoshopFormatInstance.class);
 RedactorConfiguration configuration = RedactorConfiguration.getInstance();
 configuration.getAvailableFormats().add(adobePhotoshopSettings);
 
```

[Extend supported extensions list]: https://docs.groupdocs.com/redaction/java/extend-supported-extensions-list/
[Create custom format handler]: https://docs.groupdocs.com/redaction/java/create-custom-format-handler/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactorConfiguration() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAvailableFormats() | Gets a list of recognized formats, see  DocumentFormatConfiguration . |
| findFormat(String fileExtension) | Finds format configurations for a given file extension. |
##### RedactorConfiguration()
```
public RedactorConfiguration()
```

##### getAvailableFormats()
```
public final List<DocumentFormatConfiguration> getAvailableFormats()
```

Gets a list of recognized formats, see  DocumentFormatConfiguration .

**Returns:**
java.util.List<com.groupdocs.redaction.configuration.DocumentFormatConfiguration> - A list of recognized formats, see  DocumentFormatConfiguration .
##### findFormat(String fileExtension)
```
public final DocumentFormatConfiguration findFormat(String fileExtension)
```

Finds format configurations for a given file extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | java.lang.String | File extension, format is ".ext" |

**Returns:**
DocumentFormatConfiguration - If found, instance of  DocumentFormatConfiguration , null otherwise

### com.groupdocs.redaction.exceptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions.md

The package provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatException | The exception that is thrown when document format is not recognized or is invalid. |
| GroupDocsRedactionException | Represents base exception for all GroupDocs.Redaction exceptions. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |
| TrialLimitationsException | The exception that is thrown when user violates trial mode limitations. |

### DocumentFormatException
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions/documentformatexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.redaction.exceptions.GroupDocsRedactionException
```
public class DocumentFormatException extends GroupDocsRedactionException
```

The exception that is thrown when document format is not recognized or is invalid.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentFormatException(String message) | Initializes a new instance of DocumentFormatException class. |
##### DocumentFormatException(String message)
```
public DocumentFormatException(String message)
```

Initializes a new instance of DocumentFormatException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Message, describing exception context |

### GroupDocsRedactionException
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions/groupdocsredactionexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class GroupDocsRedactionException extends Exception
```

Represents base exception for all GroupDocs.Redaction exceptions.
#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsRedactionException(String message) | Initializes a new instance of GroupDocsRedactionException class. |
##### GroupDocsRedactionException(String message)
```
public GroupDocsRedactionException(String message)
```

Initializes a new instance of GroupDocsRedactionException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Message, describing exception context |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.redaction.exceptions.GroupDocsRedactionException
```
public class IncorrectPasswordException extends GroupDocsRedactionException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() | Initializes a new instance of IncorrectPasswordException class. |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

Initializes a new instance of IncorrectPasswordException class.

### PasswordRequiredException
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.redaction.exceptions.GroupDocsRedactionException
```
public class PasswordRequiredException extends GroupDocsRedactionException
```

The exception that is thrown when password is required to load the document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() | Initializes a new instance of PasswordRequiredException class. |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

Initializes a new instance of PasswordRequiredException class.

### TrialLimitationsException
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.exceptions/triallimitationsexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.redaction.exceptions.GroupDocsRedactionException
```
public class TrialLimitationsException extends GroupDocsRedactionException
```

The exception that is thrown when user violates trial mode limitations.
#### Constructors

| Constructor | Description |
| --- | --- |
| TrialLimitationsException(String message) | Initializes a new instance of TrialLimitationsException class. |
##### TrialLimitationsException(String message)
```
public TrialLimitationsException(String message)
```

Initializes a new instance of TrialLimitationsException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | Message, describing violated limitation |

### com.groupdocs.redaction.integration
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration.md

The package provides interfaces and classes, used to integrate documents of different formats with GroupDocs.Redactions.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatInstance | Represents a specific format of a document. |
| MetadataCollection | Represents a dictionary of  MetadataItem  with its title as a key. |
| MetadataItem | Represents an item of metadata, common for all supported formats and used in metadata redactions. |
| RecognizedImage | Represents text, extracted from an image as a result of its recognition process. |
| RedactableImage | Provides facade to all raster image redaction operations. |
| TextFragment | Represents a part of recognized text (word, symbol, etc), extracted by OCR engine. |
| TextLine | Represents a line of text, extracted by OCR engine from an image. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IAnnotatedDocument | Defines methods that are required for access to annotations, such as comments. |
| ICellularFormatInstance | Defines methods that are required for access to spreadsheet formats, having one or many worksheets. |
| IFixedFormatDocument | Defines methods that are required for access formats of fixed structure, such as PDF or presentations. |
| IImageFormatInstance | Defines methods that are required for raster image format redactions. |
| IMetadataAccess | Defines methods that are required for access to metadata of a document, if format supports it. |
| IMultipleAreaRedactable | Defines methods that are required to redact multiple image areas at once with the same color. |
| IOcrConnector | Defines methods that are required to apply textual redactions to image documents and embedded images. |
| IPaginatedDocument | Defines methods that are required to manipulate a document's pages. |
| IPreviewable | Defines methods to create preview of the document. |
| IRasterizableDocument | Defines methods that are required for saving document in any binary form. |
| ITextualFormatInstance | Defines methods that are required for redacting textual data in any document, containing text. |

### DocumentFormatInstance
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/documentformatinstance.md

**Inheritance:**
java.lang.Object
```
public abstract class DocumentFormatInstance
```

Represents a specific format of a document. Implement this class to add your own document types.

The following example demonstrates how to create an empty stub for a custom format handler.

```

  public class DummyDocument extends DocumentFormatInstance
 {
     {@literal @}Override
     public void load(InputStream output) throws java.lang.Exception
     {
         // load file content
     }
     {@literal @}Override
     public void save(OutputStream output) throws java.lang.Exception
     {
         // save changes to file;
     }
 }
 
```

[Create custom format handler]: https://docs.groupdocs.com/redaction/java/create-custom-format-handler/
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentFormatInstance() |  |
#### Methods

| Method | Description |
| --- | --- |
| createInstance(Class docType) |  |
| getPassword() | Gets a password for password protected documents. |
| setPassword(String value) | Sets a password for password protected documents. |
| getRequiresRasterization() | Gets value, indicating if the format instance is read-only and cannot be saved in original format. |
| isAccessGranted() |  |
| initialize(DocumentFormatConfiguration config, RedactorSettings settings) | Performs initialization of the instance of document format handler. |
| load(InputStream input) | Loads the document from a stream. |
| save(OutputStream output) | Saves the document to a stream. |
| isRedactionAccepted(RedactionDescription description) | Checks for  IRedactionCallback  implementation and invokes it, if specified. |
| performBinaryCheck(InputStream input) | Checks if the given stream contains a document, supported by this format instance. |
| getDefaultConfiguration() | Provides a singleton instance with default configuration of built-in formats. |
##### DocumentFormatInstance()
```
public DocumentFormatInstance()
```

##### createInstance(Class docType)
```
public static DocumentFormatInstance createInstance(Class docType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| docType | java.lang.Class |  |

**Returns:**
DocumentFormatInstance
##### getPassword()
```
public final String getPassword()
```

Gets a password for password protected documents.

**Returns:**
java.lang.String - A password for password protected documents.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password for password protected documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A password for password protected documents. |

##### getRequiresRasterization()
```
public boolean getRequiresRasterization()
```

Gets value, indicating if the format instance is read-only and cannot be saved in original format.

**Returns:**
boolean - Value, indicating if the format instance is read-only and cannot be saved in original format.
##### isAccessGranted()
```
public final boolean isAccessGranted()
```

**Returns:**
boolean
##### initialize(DocumentFormatConfiguration config, RedactorSettings settings)
```
public void initialize(DocumentFormatConfiguration config, RedactorSettings settings)
```

Performs initialization of the instance of document format handler.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| config | DocumentFormatConfiguration | Format configuration |
| settings | RedactorSettings | Default settings for redaction process. |

##### load(InputStream input)
```
public void load(InputStream input)
```

Loads the document from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.io.InputStream | Stream to read from |

##### save(OutputStream output)
```
public abstract void save(OutputStream output)
```

Saves the document to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.OutputStream | Target stream to save the document |

##### isRedactionAccepted(RedactionDescription description)
```
public final boolean isRedactionAccepted(RedactionDescription description)
```

Checks for  IRedactionCallback  implementation and invokes it, if specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | RedactionDescription | Redaction description |

**Returns:**
boolean - True (by default) if redaction is accepted
##### performBinaryCheck(InputStream input)
```
public boolean performBinaryCheck(InputStream input)
```

Checks if the given stream contains a document, supported by this format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.io.InputStream | Document content stream |

**Returns:**
boolean - True, if the document can be loaded by this format instance and false otherwise
##### getDefaultConfiguration()
```
public static RedactorConfiguration getDefaultConfiguration()
```

Provides a singleton instance with default configuration of built-in formats.

**Returns:**
RedactorConfiguration - Configuration instance

### IAnnotatedDocument
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/iannotateddocument.md

### ICellularFormatInstance
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/icellularformatinstance.md

### IFixedFormatDocument
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/ifixedformatdocument.md

### IImageFormatInstance
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/iimageformatinstance.md

### IMetadataAccess
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/imetadataaccess.md

### IMultipleAreaRedactable
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/imultiplearearedactable.md

### IOcrConnector
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/iocrconnector.md

### IPaginatedDocument
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/ipaginateddocument.md

### IPreviewable
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/ipreviewable.md

### IRasterizableDocument
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/irasterizabledocument.md

### ITextualFormatInstance
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/itextualformatinstance.md

### MetadataCollection
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/metadatacollection.md

**Inheritance:**
java.lang.Object, java.util.AbstractMap, java.util.HashMap
```
public class MetadataCollection extends HashMap<String,MetadataItem>
```

Represents a dictionary of  MetadataItem  with its title as a key.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataCollection() | Initializes a new instance of MetadataCollection class. |
#### Methods

| Method | Description |
| --- | --- |
| addRange(MetadataCollection items) | Adds a specified collection of MetadataItem objects to this instance. |
##### MetadataCollection()
```
public MetadataCollection()
```

Initializes a new instance of MetadataCollection class.

##### addRange(MetadataCollection items)
```
public final void addRange(MetadataCollection items)
```

Adds a specified collection of MetadataItem objects to this instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| items | MetadataCollection | A collection of MetadataItem instances |

### MetadataItem
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/metadataitem.md

**Inheritance:**
java.lang.Object
```
public class MetadataItem
```

Represents an item of metadata, common for all supported formats and used in metadata redactions.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataItem() | Initializes a new instance. |
#### Methods

| Method | Description |
| --- | --- |
| getOriginalName() | Gets an original name of the metadata item, as it appears in the document. |
| setOriginalName(String value) | Sets an original name of the metadata item, as it appears in the document. |
| getCategory() | Gets a category of the metadata item, for example resource ID for an embedded resource metadata item. |
| setCategory(String value) | Sets a category of the metadata item, for example resource ID for an embedded resource metadata item. |
| getFilter() | Gets a value of  MetadataFilters , assigned to this metadata item which is used in item filtration. |
| setFilter(int value) | Sets a value of  MetadataFilters , assigned to this metadata item which is used in item filtration. |
| getValues() | Gets the metadata item value. |
| setValues(List<String> value) | Sets the metadata item value. |
| isCustom() | Gets a value indicating whether this item is custom (added by the authors of the document). |
| setCustom(boolean value) | Sets a value indicating whether this item is custom (added by the authors of the document). |
| getDictionaryKey() | Gets a dictionary key for , using its OriginalName and other data. |
| createClone() | Creates a deep clone of current instance. |
| getActualValue() | Gets the string representation of the metadata item value. |
##### MetadataItem()
```
public MetadataItem()
```

Initializes a new instance.

##### getOriginalName()
```
public final String getOriginalName()
```

Gets an original name of the metadata item, as it appears in the document.

**Returns:**
java.lang.String - An original name of the metadata item, as it appears in the document.
##### setOriginalName(String value)
```
public final void setOriginalName(String value)
```

Sets an original name of the metadata item, as it appears in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An original name of the metadata item, as it appears in the document. |

##### getCategory()
```
public final String getCategory()
```

Gets a category of the metadata item, for example resource ID for an embedded resource metadata item.

**Returns:**
java.lang.String - A category of the metadata item, for example resource ID for an embedded resource metadata item.
##### setCategory(String value)
```
public final void setCategory(String value)
```

Sets a category of the metadata item, for example resource ID for an embedded resource metadata item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A category of the metadata item, for example resource ID for an embedded resource metadata item. |

##### getFilter()
```
public final int getFilter()
```

Gets a value of  MetadataFilters , assigned to this metadata item which is used in item filtration.

**Returns:**
int - A value of  MetadataFilters , assigned to this metadata item which is used in item filtration.
##### setFilter(int value)
```
public final void setFilter(int value)
```

Sets a value of  MetadataFilters , assigned to this metadata item which is used in item filtration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A value of  MetadataFilters , assigned to this metadata item which is used in item filtration. |

##### getValues()
```
public final List<String> getValues()
```

Gets the metadata item value.

**Returns:**
java.util.List<java.lang.String> - The metadata item value.
##### setValues(List<String> value)
```
public final void setValues(List<String> value)
```

Sets the metadata item value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> | The metadata item value. |

##### isCustom()
```
public final boolean isCustom()
```

Gets a value indicating whether this item is custom (added by the authors of the document).

**Returns:**
boolean - A value indicating whether this item is custom (added by the authors of the document).
##### setCustom(boolean value)
```
public final void setCustom(boolean value)
```

Sets a value indicating whether this item is custom (added by the authors of the document).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether this item is custom (added by the authors of the document). |

##### getDictionaryKey()
```
public String getDictionaryKey()
```

Gets a dictionary key for , using its OriginalName and other data.

**Returns:**
java.lang.String - A dictionary key for , using its OriginalName and other data.
##### createClone()
```
public MetadataItem createClone()
```

Creates a deep clone of current instance.

**Returns:**
MetadataItem - Object clone
##### getActualValue()
```
public final String getActualValue()
```

Gets the string representation of the metadata item value.

**Returns:**
java.lang.String - The string representation of the metadata item value.

### RecognizedImage
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/recognizedimage.md

**Inheritance:**
java.lang.Object
```
public class RecognizedImage
```

Represents text, extracted from an image as a result of its recognition process.

[OCR Usage Basics]: https://docs.groupdocs.com/redaction/java/ocr-usage-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| RecognizedImage(TextLine[] lines) | Initializes a new instance of the class, using a set of recognized lines. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets textual equivalent of the structured text. |
| getLines() | Gets lines of text, with their fragments, recognized within the document. |
| toString() | Gets textual equivalent of the structured text. |
##### RecognizedImage(TextLine[] lines)
```
public RecognizedImage(TextLine[] lines)
```

Initializes a new instance of the class, using a set of recognized lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lines | TextLine\[\] | an IEnumerable (e.g. a list or an array) of recognized lines |

##### getText()
```
public final String getText()
```

Gets textual equivalent of the structured text.

**Returns:**
java.lang.String - Textual equivalent of the structured text.
##### getLines()
```
public final TextLine[] getLines()
```

Gets lines of text, with their fragments, recognized within the document.

**Returns:**
com.groupdocs.redaction.integration.TextLine[] - Lines of text, with their fragments, recognized within the document.
##### toString()
```
public String toString()
```

Gets textual equivalent of the structured text.

**Returns:**
java.lang.String - Recognized text

### RedactableImage
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/redactableimage.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.redaction.integration.IImageFormatInstance, com.groupdocs.redaction.integration.IMultipleAreaRedactable
```
public class RedactableImage implements IImageFormatInstance, IMultipleAreaRedactable
```

Provides facade to all raster image redaction operations.
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactableImage(IImageFormatInstance img) | Creates a new instace using an object, implementing  IImageFormatInstance  interface. |
| RedactableImage(IMultipleAreaRedactable img) | Creates a new instace using an object, implementing  IMultipleAreaRedactable  interface. |
#### Methods

| Method | Description |
| --- | --- |
| getRawStream() | Retrieves a stream with actual image content. |
| editAreas(Rectangle[] rectangles, Color boxColor) | Redacts multiple image areas at once with the same color. |
| editArea(Point topLeft, RegionReplacementOptions options) | Replaces the area at given point with a rectangle of specific color and size. |
##### RedactableImage(IImageFormatInstance img)
```
public RedactableImage(IImageFormatInstance img)
```

Creates a new instace using an object, implementing  IImageFormatInstance  interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| img | IImageFormatInstance | An instance, implementing IImageFormatInstance interface |

##### RedactableImage(IMultipleAreaRedactable img)
```
public RedactableImage(IMultipleAreaRedactable img)
```

Creates a new instace using an object, implementing  IMultipleAreaRedactable  interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| img | IMultipleAreaRedactable | An instance, implementing IMultipleAreaRedactable interface |

##### getRawStream()
```
public final InputStream getRawStream()
```

Retrieves a stream with actual image content.

**Returns:**
java.io.InputStream - Stream, containing image data
##### editAreas(Rectangle[] rectangles, Color boxColor)
```
public final RedactionResult editAreas(Rectangle[] rectangles, Color boxColor)
```

Redacts multiple image areas at once with the same color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangles | java.awt.Rectangle[] | An array of rectangle areas |
| boxColor | java.awt.Color | Color to fill the areas |

**Returns:**
RedactionResult - Image areas redaction result
##### editArea(Point topLeft, RegionReplacementOptions options)
```
public final RedactionResult editArea(Point topLeft, RegionReplacementOptions options)
```

Replaces the area at given point with a rectangle of specific color and size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | java.awt.Point | Top-left corner coordinates of filled area |
| options | RegionReplacementOptions | Color and size settings |

**Returns:**
RedactionResult - Image area redaction result

### TextFragment
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/textfragment.md

**Inheritance:**
java.lang.Object
```
public class TextFragment
```

Represents a part of recognized text (word, symbol, etc), extracted by OCR engine.

[OCR Usage Basics]: https://docs.groupdocs.com/redaction/java/ocr-usage-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFragment(String text, Rectangle rectangle) | Initializes a new instance of the recognised text fragment. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets a textual content of the recognised text fragment. |
| getRectangle() | Gets a bounding rectangle of the recognised text fragment. |
| toString() | Returns textual content of the recognised text fragment. |
##### TextFragment(String text, Rectangle rectangle)
```
public TextFragment(String text, Rectangle rectangle)
```

Initializes a new instance of the recognised text fragment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | textual content of the recognised text fragment |
| rectangle | java.awt.Rectangle | bounding rectangle of the recognised text fragment |

##### getText()
```
public final String getText()
```

Gets a textual content of the recognised text fragment.

**Returns:**
java.lang.String - A textual content of the recognised text fragment.
##### getRectangle()
```
public final Rectangle getRectangle()
```

Gets a bounding rectangle of the recognised text fragment.

**Returns:**
java.awt.Rectangle - A bounding rectangle of the recognised text fragment.
##### toString()
```
public String toString()
```

Returns textual content of the recognised text fragment.

**Returns:**
java.lang.String - textual content of the recognised text fragment

### TextLine
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.integration/textline.md

**Inheritance:**
java.lang.Object
```
public class TextLine
```

Represents a line of text, extracted by OCR engine from an image.

[OCR Usage Basics]: https://docs.groupdocs.com/redaction/java/ocr-usage-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| TextLine(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. |
| toString() | Returns textual content of the recognised line of text. |
##### TextLine(TextFragment[] fragments)
```
public TextLine(TextFragment[] fragments)
```

Initializes a new instance of a line of text, extracted by OCR engine from an image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fragments | TextFragment\[\] | initial set of text fragments |

##### getFragments()
```
public final TextFragment[] getFragments()
```

Gets an array of text fragments, such as symbols and words, recognized in the line.

**Returns:**
com.groupdocs.redaction.integration.TextFragment[] - An array of text fragments, such as symbols and words, recognized in the line.
##### toString()
```
public String toString()
```

Returns textual content of the recognised line of text.

**Returns:**
java.lang.String - textual content of the recognised line of text

### com.groupdocs.redaction.licensing
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.licensing.md

The package provides classes to set license or use Metered billing.

#### 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/redaction/java/com.groupdocs.redaction.licensing/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
#### Constructors

| Constructor | Description |
| --- | --- |
| License() | Instantiate the License |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(InputStream licenseStream) | Licenses the component. |
##### License()
```
public License()
```

Instantiate the License

##### 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.Signature.lic";
>  GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>  lic.SetLicense(licensePath);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path. |

##### 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 (FileStream licenseStream = new FileStream("GroupDocs.Signature.lic", FileMode.Open))
>  {
>      GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>      lic.SetLicense(licenseStream);
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

### Metered
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.licensing/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying  [Metered][]  license.

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/signaturejava/Evaluation+Limitations+and+Licensing+of+GroupDocs.Signature
#### 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);
>   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

### com.groupdocs.redaction.options
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options.md

The package provides load and save options classes.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Provides options that will be used to open a file. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| RasterizationOptions | Provides options for converting files into PDF. |
| RedactorSettings | Represents redaction settings, allowing to customize the redaction process. |
| SaveOptions | Provides options for changing an output file name and/or converting the document to image-based PDF (rasterization). |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICreatePageStream | Provides method that returns a stream to write page preview data. |
| ILogger | Defines interface of a logger that can be used for logging events and errors in process of redaction. |
| IReleasePageStream | Represents a method which releases stream created by  CreatePageStream  delegate. |

#### Enumerations

| Enum | Description |
| --- | --- |
| AdvancedRasterizationOptions | An enumeration to manage the advanced rasterization options to be applied. |
| PdfComplianceLevel | Represents a list of supported PDF compliance levels. |
| PreviewFormats | Represents supported preview formats. |

### AdvancedRasterizationOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/advancedrasterizationoptions.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum AdvancedRasterizationOptions extends Enum<AdvancedRasterizationOptions>
```

An enumeration to manage the advanced rasterization options to be applied.
#### Fields

| Field | Description |
| --- | --- |
| Tilt | Tilt to incline the rasterized image to a random angle. |
| Noise | Add random spots to rasterized page images. |
| Border | Add border line to imitate page scan effect. |
| Grayscale | Make page images grayscale to imitate grayscale scan. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Tilt
```
public static final AdvancedRasterizationOptions Tilt
```

Tilt to incline the rasterized image to a random angle.

##### Noise
```
public static final AdvancedRasterizationOptions Noise
```

Add random spots to rasterized page images.

##### Border
```
public static final AdvancedRasterizationOptions Border
```

Add border line to imitate page scan effect.

##### Grayscale
```
public static final AdvancedRasterizationOptions Grayscale
```

Make page images grayscale to imitate grayscale scan.

##### values()
```
public static AdvancedRasterizationOptions[] values()
```

**Returns:**
com.groupdocs.redaction.options.AdvancedRasterizationOptions[]
##### valueOf(String name)
```
public static AdvancedRasterizationOptions valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
AdvancedRasterizationOptions

### ICreatePageStream
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/icreatepagestream.md

### ILogger
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/ilogger.md

### IReleasePageStream
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/ireleasepagestream.md

### LoadOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Provides options that will be used to open a file.

The following example demonstrates how to open password-protected document.

```

  LoadOptions loadOptions = new LoadOptions("mysecretpassword");
 try (Redactor redactor = new Redactor("PasswordProtected.pdf", loadOptions))
 {
     // work with document
 }
 
```

[Loading documents]: https://docs.groupdocs.com/redaction/java/loading-documents/
[Load from local disk]: https://docs.groupdocs.com/redaction/java/load-from-local-disc/
[Load from stream]: https://docs.groupdocs.com/redaction/java/load-from-stream/
[Load password-protected document]: https://docs.groupdocs.com/redaction/java/load-password-protected-file/
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of LoadOptions class. |
| LoadOptions(String password) | Initializes a new instance of LoadOptions class with specified password. |
| LoadOptions(boolean preRasterize) | Initializes a new instance of LoadOptions class with specified pre-rasterization flag. |
| LoadOptions(String password, boolean preRasterize) | Initializes a new instance of LoadOptions class with specified password. |
| LoadOptions(String password, boolean preRasterize, DocumentFormatConfiguration documentFormatConfiguration) | Initializes a new instance of LoadOptions class with specified password. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets a password for password-protected documents. |
| setPassword(String value) | Sets a password for password-protected documents. |
| getDocumentFormatConfiguration() | Gets a document format configuration. |
| setDocumentFormatConfiguration(DocumentFormatConfiguration value) | Sets a document format configuration. |
| getPreRasterize() | Gets a value, indicating if the file is to be pre-rasterized. |
| setPreRasterize(boolean value) | Sets a value, indicating if the file is to be pre-rasterized. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of LoadOptions class.

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes a new instance of LoadOptions class with specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | Password for protected files |

##### LoadOptions(boolean preRasterize)
```
public LoadOptions(boolean preRasterize)
```

Initializes a new instance of LoadOptions class with specified pre-rasterization flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| preRasterize | boolean | If true, force rasteization on loading |

##### LoadOptions(String password, boolean preRasterize)
```
public LoadOptions(String password, boolean preRasterize)
```

Initializes a new instance of LoadOptions class with specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | Password for protected files |
| preRasterize | boolean | If true, force rasteization on loading |

##### LoadOptions(String password, boolean preRasterize, DocumentFormatConfiguration documentFormatConfiguration)
```
public LoadOptions(String password, boolean preRasterize, DocumentFormatConfiguration documentFormatConfiguration)
```

Initializes a new instance of LoadOptions class with specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | Password for protected files |
| preRasterize | boolean | If true, force rasteization on loading |
| documentFormatConfiguration | DocumentFormatConfiguration | document format configuration |

##### getPassword()
```
public final String getPassword()
```

Gets a password for password-protected documents.

**Returns:**
java.lang.String - A password for password-protected documents.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password for password-protected documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A password for password-protected documents. |

##### getDocumentFormatConfiguration()
```
public final DocumentFormatConfiguration getDocumentFormatConfiguration()
```

Gets a document format configuration.

**Returns:**
DocumentFormatConfiguration - A document format configuration.
##### setDocumentFormatConfiguration(DocumentFormatConfiguration value)
```
public final void setDocumentFormatConfiguration(DocumentFormatConfiguration value)
```

Sets a document format configuration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentFormatConfiguration | A document format configuration. |

##### getPreRasterize()
```
public final boolean getPreRasterize()
```

Gets a value, indicating if the file is to be pre-rasterized.

**Returns:**
boolean - A value, indicating if the file is to be pre-rasterized.
##### setPreRasterize(boolean value)
```
public final void setPreRasterize(boolean value)
```

Sets a value, indicating if the file is to be pre-rasterized.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value, indicating if the file is to be pre-rasterized. |

### PdfComplianceLevel
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/pdfcompliancelevel.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PdfComplianceLevel extends Enum<PdfComplianceLevel>
```

Represents a list of supported PDF compliance levels.
#### Fields

| Field | Description |
| --- | --- |
| Auto | The output file will comply with the PDF/A-1b standard by default. |
| PdfA1a | The output file will comply with the PDF/A-1a standard. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Auto
```
public static final PdfComplianceLevel Auto
```

The output file will comply with the PDF/A-1b standard by default.

##### PdfA1a
```
public static final PdfComplianceLevel PdfA1a
```

The output file will comply with the PDF/A-1a standard.

##### values()
```
public static PdfComplianceLevel[] values()
```

**Returns:**
com.groupdocs.redaction.options.PdfComplianceLevel[]
##### valueOf(String name)
```
public static PdfComplianceLevel valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PdfComplianceLevel

### PreviewFormats
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/previewformats.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PreviewFormats extends Enum<PreviewFormats>
```

Represents supported preview formats.
#### Fields

| Field | Description |
| --- | --- |
| Png | Portable Network Graphics Format. |
| Jpeg | Joint Photographic Experts Group Format. |
| Bmp | Bitmap Picture Format. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Png
```
public static final PreviewFormats Png
```

Portable Network Graphics Format.

##### Jpeg
```
public static final PreviewFormats Jpeg
```

Joint Photographic Experts Group Format.

##### Bmp
```
public static final PreviewFormats Bmp
```

Bitmap Picture Format.

##### values()
```
public static PreviewFormats[] values()
```

**Returns:**
com.groupdocs.redaction.options.PreviewFormats[]
##### valueOf(String name)
```
public static PreviewFormats valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PreviewFormats

### PreviewOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets or sets page preview width. |
| setWidth(int value) | Gets or sets page preview width. |
| getHeight() | Gets or sets page preview height. |
| setHeight(int value) | Gets or sets page preview height. |
| getPageNumbers() | Gets or sets an array of page numbers to generate preview. |
| setPageNumbers(int[] value) | Gets or sets an array of page numbers to generate preview. |
| getPreviewFormat() | Gets or sets preview image format. |
| setPreviewFormat(PreviewFormats value) | Gets or sets preview image format. |
| getCreatePageStream() | Gets or sets an instance of page stream creation delegate. |
| setCreatePageStream(ICreatePageStream value) | Gets or sets an instance of page stream creation delegate. |
| getReleasePageStream() | Gets or sets an instance of page preview completion delegate. |
| setReleasePageStream(IReleasePageStream value) | Gets or sets an instance of page preview completion delegate. |
##### PreviewOptions(ICreatePageStream createPageStream)
```
public PreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of PreviewOptions class, causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |

##### PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets output stream |

##### getWidth()
```
public final int getWidth()
```

Gets or sets page preview width.

**Returns:**
int - Page preview width.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Gets or sets page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | Page preview width. |

##### getHeight()
```
public final int getHeight()
```

Gets or sets page preview height.

**Returns:**
int - Page preview height.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Gets or sets page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | Page preview height. |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets or sets an array of page numbers to generate preview.

**Returns:**
int[] - An array of page numbers to generate preview.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Gets or sets an array of page numbers to generate preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | An array of page numbers to generate preview. |

##### getPreviewFormat()
```
public final PreviewFormats getPreviewFormat()
```

Gets or sets preview image format.

**Returns:**
PreviewFormats - Preview image format.
##### setPreviewFormat(PreviewFormats value)
```
public final void setPreviewFormat(PreviewFormats value)
```

Gets or sets preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PreviewFormats | Preview image format. |

##### getCreatePageStream()
```
public final ICreatePageStream getCreatePageStream()
```

Gets or sets an instance of page stream creation delegate.

**Returns:**
ICreatePageStream - An instance of page stream creation delegate.
##### setCreatePageStream(ICreatePageStream value)
```
public final void setCreatePageStream(ICreatePageStream value)
```

Gets or sets an instance of page stream creation delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICreatePageStream | An instance of page stream creation delegate. |

##### getReleasePageStream()
```
public final IReleasePageStream getReleasePageStream()
```

Gets or sets an instance of page preview completion delegate.

**Returns:**
IReleasePageStream - An instance of page preview completion delegate.
##### setReleasePageStream(IReleasePageStream value)
```
public final void setReleasePageStream(IReleasePageStream value)
```

Gets or sets an instance of page preview completion delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IReleasePageStream | An instance of page preview completion delegate. |

### RasterizationOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/rasterizationoptions.md

**Inheritance:**
java.lang.Object
```
public class RasterizationOptions
```

Provides options for converting files into PDF.

[Save in rasterized PDF]: https://docs.groupdocs.com/redaction/java/save-in-rasterized-pdf/
[Select specific pages for rasterized PDF]: https://docs.groupdocs.com/redaction/java/select-specific-pages-for-rasterized-pdf/
#### Constructors

| Constructor | Description |
| --- | --- |
| RasterizationOptions() | Initializes a new instance. |
#### Methods

| Method | Description |
| --- | --- |
| getEnabled() | Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| setEnabled(boolean value) | Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| getPageIndex() | Gets the index of the first page (0-based) to convert into PDF. |
| setPageIndex(int value) | Sets the index of the first page (0-based) to convert into PDF. |
| isStartPageIndexSet() | Gets a value indicating whether the PageIndex property was changed (set) after its initialization. |
| getPageCount() | Gets the number of pages to be converted into PDF. |
| setPageCount(int value) | Sets the number of pages to be converted into PDF. |
| isPageCountSet() | Gets a value indicating whether the PageCount property was changed (set) after its initialization. |
| getCompliance() | Gets the PDF Compliance level. |
| setCompliance(PdfComplianceLevel value) | Sets the PDF Compliance level. |
| hasAdvancedOptions() | Gets an indicator, which is true if advanced rasterization options are set. |
| addAdvancedOption(AdvancedRasterizationOptions optionType) | You can use this method to register an advanced rasterization option to apply. |
| addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters) | You can use this method to register an advanced rasterization option to apply. |
##### RasterizationOptions()
```
public RasterizationOptions()
```

Initializes a new instance.

##### getEnabled()
```
public final boolean getEnabled()
```

Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.

**Returns:**
boolean - A value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.
##### setEnabled(boolean value)
```
public final void setEnabled(boolean value)
```

Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization. |

##### getPageIndex()
```
public final int getPageIndex()
```

Gets the index of the first page (0-based) to convert into PDF.

**Returns:**
int - The index of the first page (0-based) to convert into PDF.
##### setPageIndex(int value)
```
public final void setPageIndex(int value)
```

Sets the index of the first page (0-based) to convert into PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of the first page (0-based) to convert into PDF. |

##### isStartPageIndexSet()
```
public final boolean isStartPageIndexSet()
```

Gets a value indicating whether the PageIndex property was changed (set) after its initialization.

**Returns:**
boolean - A value indicating whether the PageIndex property was changed (set) after its initialization.
##### getPageCount()
```
public final int getPageCount()
```

Gets the number of pages to be converted into PDF.

**Returns:**
int - The number of pages to be converted into PDF.
##### setPageCount(int value)
```
public final void setPageCount(int value)
```

Sets the number of pages to be converted into PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of pages to be converted into PDF. |

##### isPageCountSet()
```
public final boolean isPageCountSet()
```

Gets a value indicating whether the PageCount property was changed (set) after its initialization.

**Returns:**
boolean - A value indicating whether the PageCount property was changed (set) after its initialization.
##### getCompliance()
```
public final PdfComplianceLevel getCompliance()
```

Gets the PDF Compliance level.

**Returns:**
PdfComplianceLevel - The PDF Compliance level.
##### setCompliance(PdfComplianceLevel value)
```
public final void setCompliance(PdfComplianceLevel value)
```

Sets the PDF Compliance level.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfComplianceLevel | The PDF Compliance level. |

##### hasAdvancedOptions()
```
public final boolean hasAdvancedOptions()
```

Gets an indicator, which is true if advanced rasterization options are set.

**Returns:**
boolean - An indicator, which is true if advanced rasterization options are set.
##### addAdvancedOption(AdvancedRasterizationOptions optionType)
```
public final void addAdvancedOption(AdvancedRasterizationOptions optionType)
```

You can use this method to register an advanced rasterization option to apply.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |

##### addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters)
```
public final void addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters)
```

You can use this method to register an advanced rasterization option to apply.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |
| parameters | java.util.HashMap<java.lang.String,java.lang.String> | Parameters for the given effect, such as rotation angle |

### RedactorSettings
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/redactorsettings.md

**Inheritance:**
java.lang.Object
```
public class RedactorSettings
```

Represents redaction settings, allowing to customize the redaction process.

[Use advanced logging]: https://docs.groupdocs.com/redaction/java/use-advanced-logging/
[Use redaction callback]: https://docs.groupdocs.com/redaction/java/use-redaction-callback/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactorSettings() | Initializes a new instance of the RedactorSettings class. |
| RedactorSettings(ILogger logger) | Initializes a new instance of the RedactorSettings class with a given ILogger instance. |
| RedactorSettings(IRedactionCallback callback) | Initializes a new instance of the RedactorSettings class with a given IRedactionCallback instance. |
| RedactorSettings(IOcrConnector ocrConnector) | Initializes a new instance of the RedactorSettings class with a given IOcrConnector instance. |
| RedactorSettings(ILogger logger, IRedactionCallback callback) | Initializes a new instance of the RedactorSettings class with given ILogger and IRedactionCallback instances. |
| RedactorSettings(ILogger logger, IRedactionCallback callback, IOcrConnector ocrConnector) | Initializes a new instance of the RedactorSettings class with given ILogger, IRedactionCallback and IOcrConnector instances. |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Gets an instance of a class, implementing  ILogger , that is used for logging events and errors. |
| setLogger(ILogger value) | Sets an instance of a class, implementing  ILogger , that is used for logging events and errors. |
| getRedactionCallback() | Gets an instance of a class, implementing  IRedactionCallback . |
| setRedactionCallback(IRedactionCallback value) | Sets an instance of a class, implementing  IRedactionCallback . |
| getOcrConnector() | Gets an instance of a class, implementing  IOcrConnector  interface. |
| setOcrConnector(IOcrConnector value) | Sets an instance of a class, implementing  IOcrConnector  interface. |
##### RedactorSettings()
```
public RedactorSettings()
```

Initializes a new instance of the RedactorSettings class.

##### RedactorSettings(ILogger logger)
```
public RedactorSettings(ILogger logger)
```

Initializes a new instance of the RedactorSettings class with a given ILogger instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |

##### RedactorSettings(IRedactionCallback callback)
```
public RedactorSettings(IRedactionCallback callback)
```

Initializes a new instance of the RedactorSettings class with a given IRedactionCallback instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |

##### RedactorSettings(IOcrConnector ocrConnector)
```
public RedactorSettings(IOcrConnector ocrConnector)
```

Initializes a new instance of the RedactorSettings class with a given IOcrConnector instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | A valid implementation of IOcrConnector interface |

##### RedactorSettings(ILogger logger, IRedactionCallback callback)
```
public RedactorSettings(ILogger logger, IRedactionCallback callback)
```

Initializes a new instance of the RedactorSettings class with given ILogger and IRedactionCallback instances.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |

##### RedactorSettings(ILogger logger, IRedactionCallback callback, IOcrConnector ocrConnector)
```
public RedactorSettings(ILogger logger, IRedactionCallback callback, IOcrConnector ocrConnector)
```

Initializes a new instance of the RedactorSettings class with given ILogger, IRedactionCallback and IOcrConnector instances.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |
| ocrConnector | IOcrConnector | An instance of IOcrConnector interface implementation. Can be null |

##### getLogger()
```
public final ILogger getLogger()
```

Gets an instance of a class, implementing  ILogger , that is used for logging events and errors.

**Returns:**
ILogger - An instance of a class, implementing  ILogger , that is used for logging events and errors.
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

Sets an instance of a class, implementing  ILogger , that is used for logging events and errors.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ILogger | An instance of a class, implementing  ILogger , that is used for logging events and errors. |

##### getRedactionCallback()
```
public final IRedactionCallback getRedactionCallback()
```

Gets an instance of a class, implementing  IRedactionCallback .

**Returns:**
IRedactionCallback - An instance of a class, implementing  IRedactionCallback .
##### setRedactionCallback(IRedactionCallback value)
```
public final void setRedactionCallback(IRedactionCallback value)
```

Sets an instance of a class, implementing  IRedactionCallback .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IRedactionCallback | An instance of a class, implementing  IRedactionCallback . |

##### getOcrConnector()
```
public final IOcrConnector getOcrConnector()
```

Gets an instance of a class, implementing  IOcrConnector  interface.

**Returns:**
IOcrConnector - An instance of a class, implementing  IOcrConnector  interface.
##### setOcrConnector(IOcrConnector value)
```
public final void setOcrConnector(IOcrConnector value)
```

Sets an instance of a class, implementing  IOcrConnector  interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IOcrConnector | An instance of a class, implementing  IOcrConnector  interface. |

### SaveOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.options/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Provides options for changing an output file name and/or converting the document to image-based PDF (rasterization).

[Save with default options]: https://docs.groupdocs.com/redaction/java/save-with-default-options/
[Save in rasterized PDF]: https://docs.groupdocs.com/redaction/java/save-in-rasterized-pdf/
[Select specific pages for rasterized PDF]: https://docs.groupdocs.com/redaction/java/select-specific-pages-for-rasterized-pdf/
[Save in original format]: https://docs.groupdocs.com/redaction/java/save-in-original-format/
[Save overwriting original file]: https://docs.groupdocs.com/redaction/java/save-overwriting-original-file/
[Save to stream]: https://docs.groupdocs.com/redaction/java/save-to-stream/
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false. |
| SaveOptions(boolean rasterizeToPdf, String suffix) | Initializes a new instance with given parameters. |
#### Fields

| Field | Description |
| --- | --- |
| SaveSuffix | Represents default suffix value, which is "Redacted". |
#### Methods

| Method | Description |
| --- | --- |
| getAddSuffix() | Gets a value indicating whether the file name needs to be changed before saving. |
| setAddSuffix(boolean value) | Sets a value indicating whether the file name needs to be changed before saving. |
| getRedactedFileSuffix() | Gets a custom suffix for output file name. |
| setRedactedFileSuffix(String value) | Sets a custom suffix for output file name. |
| getRasterizeToPDF() | Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| setRasterizeToPDF(boolean value) | Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| getRasterization() | Gets the rasterization settings. |
##### SaveOptions()
```
public SaveOptions()
```

Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false.

##### SaveOptions(boolean rasterizeToPdf, String suffix)
```
public SaveOptions(boolean rasterizeToPdf, String suffix)
```

Initializes a new instance with given parameters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rasterizeToPdf | boolean | True, if all pages in the document need to be converted to images and put in a single PDF file |
| suffix | java.lang.String | This text will be added to the end of file name, if not empty also sets AddSuffix to true |

##### SaveSuffix
```
public static final String SaveSuffix
```

Represents default suffix value, which is "Redacted".

##### getAddSuffix()
```
public final boolean getAddSuffix()
```

Gets a value indicating whether the file name needs to be changed before saving. False by default.

**Returns:**
boolean - A value indicating whether the file name needs to be changed before saving. False by default.
##### setAddSuffix(boolean value)
```
public final void setAddSuffix(boolean value)
```

Sets a value indicating whether the file name needs to be changed before saving. False by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the file name needs to be changed before saving. False by default. |

##### getRedactedFileSuffix()
```
public final String getRedactedFileSuffix()
```

Gets a custom suffix for output file name. If it is not specified, the  SaveSuffix  constant will be used.

**Returns:**
java.lang.String - A custom suffix for output file name. If it is not specified, the  SaveSuffix  constant will be used.
##### setRedactedFileSuffix(String value)
```
public final void setRedactedFileSuffix(String value)
```

Sets a custom suffix for output file name. If it is not specified, the  SaveSuffix  constant will be used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A custom suffix for output file name. If it is not specified, the  SaveSuffix  constant will be used. |

##### getRasterizeToPDF()
```
public final boolean getRasterizeToPDF()
```

Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

**Returns:**
boolean - A value indicating whether all pages in the document need to be converted to images and put in a single PDF file.
##### setRasterizeToPDF(boolean value)
```
public final void setRasterizeToPDF(boolean value)
```

Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |

##### getRasterization()
```
public final RasterizationOptions getRasterization()
```

Gets the rasterization settings.

**Returns:**
RasterizationOptions - The rasterization settings.

### com.groupdocs.redaction.redactions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions.md

The package provides classes for different types of redactions.

#### Classes

| Class | Description |
| --- | --- |
| AnnotationRedaction | Represents a redaction that replaces annotation text (comments, etc.) matching a given regular expression. |
| CellColumnRedaction | Represents a text redaction that replaces text in a spreadsheet documents (CSV, Excel, etc.). |
| CellFilter | Provides an option to limit the scope of a  CellColumnRedaction  to a worksheet and a column. |
| DeleteAnnotationRedaction | Represents a text redaction that deletes annotations if text is matching given regular expression (optionally deletes all annotations). |
| EraseMetadataRedaction | Represents a metadata redaction that erases all metadata or metadata matching specific MetadataFilters from the document. |
| ExactPhraseRedaction | Represents a text redaction that replaces exact phrase in the document's text, case insensitive by default. |
| ImageAreaRedaction | Represents a redaction that places colored rectangle in given area of an image document. |
| MetadataFilters | Represents a list of the most common types of document metadata. |
| MetadataRedaction | Represents a base abstract class for document metadata redactions. |
| MetadataSearchRedaction | Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values. |
| PageAreaFilter | Represents redaction filter, setting an area within a page of a document to apply redaction. |
| PageAreaRedaction | Represents a complex textual redaction that affects text, images and annotations in an area of the page. |
| PageRangeFilter | Represents redaction filter, setting page range inside a document to apply redaction. |
| RedactionDescription | Represents a single change action info that performed during redaction process. |
| RedactionFilter | Represents redaction filter, setting scope inside a document to apply redactions. |
| RedactionType | Represents a type of document's data, affected by redaction. |
| RegexRedaction | Represents a text redaction that searches and replaces text in the document by matching provided regular expression. |
| RegionReplacementOptions | Represents color and area parameters for image region replacement. |
| RemovePageRedaction | Represents a redaction that removes a page (slide, worksheet, etc.) from a document. |
| ReplacementOptions | Represents options for matched text replacement. |
| TextRedaction | Represents a base abstract class for document text redactions. |
| TextReplacement | Represents a textual replacement information. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IRedactionCallback | Defines methods that are required for receiving information on each redaction change and optionally prevent it. |

#### Enumerations

| Enum | Description |
| --- | --- |
| PageSeekOrigin | Provides the fields that represent reference points in a document for seeking. |
| RedactionActionType | Represents actions that can be taken to perform redaction. |
| ReplacementType | Represents a type of replacement for the matched text. |

### AnnotationRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/annotationredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public class AnnotationRedaction extends Redaction
```

Represents a redaction that replaces annotation text (comments, etc.) matching a given regular expression.

The following example demonstrates how to replace the name "John" with "[redacted]" in all annotations.

```

  try (Redactor redactor = new Redactor("C:\\test.pdf"))
 {
    redactor.apply(new AnnotationRedaction("(?im:john)", "[redacted]"));
    redactor.save()
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Annotation redactions]: https://docs.groupdocs.com/redaction/java/annotation-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| AnnotationRedaction(String pattern, String replacement) | Initializes a new instance of AnnotationRedaction class. |
| AnnotationRedaction(Pattern regex, String replacement) | Initializes a new instance of AnnotationRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getExpression() | Gets the regular expression to match. |
| getReplacement() | Gets a textual replacement for matched text. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### AnnotationRedaction(String pattern, String replacement)
```
public AnnotationRedaction(String pattern, String replacement)
```

Initializes a new instance of AnnotationRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | Regular expression to match |
| replacement | java.lang.String | Textual replacement for matched text |

##### AnnotationRedaction(Pattern regex, String replacement)
```
public AnnotationRedaction(Pattern regex, String replacement)
```

Initializes a new instance of AnnotationRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| regex | java.util.regex.Pattern | Regular expression to match |
| replacement | java.lang.String | Textual replacement for matched text |

##### getExpression()
```
public final Pattern getExpression()
```

Gets the regular expression to match.

**Returns:**
java.util.regex.Pattern - The regular expression to match.
##### getReplacement()
```
public final String getReplacement()
```

Gets a textual replacement for matched text.

**Returns:**
java.lang.String - A textual replacement for matched text.
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### CellColumnRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/cellcolumnredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction
```
public class CellColumnRedaction extends TextRedaction
```

Represents a text redaction that replaces text in a spreadsheet documents (CSV, Excel, etc.).

The following example demonstrates removing user emails from a second column on "Customers" worksheet of a spreadsheet document.

```

  try (Redactor redactor = new Redactor("D:\\Sales in September.xslx"))
 {
    CellFilter filter = new CellFilter();
    filter.setColumnIndex(1); // zero-based 2nd column
    filter.setWorkSheetName("Customers");

    Pattern expression = Pattern.compile("^\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$");
    RedactorChangeLog changeLog = redactor.apply(new CellColumnRedaction(filter, expression, new ReplacementOptions("[customer email]")));
    if (result.Status != RedactionStatus.Failed)
    {
       SaveOptions opt = new SaveOptions();
       opt.setAddSuffix(true);
       doc.save(opt);
    };
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Spreadsheet redactions]: https://docs.groupdocs.com/redaction/java/spreadsheet-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| CellColumnRedaction(CellFilter filter, Pattern regEx, ReplacementOptions options) | Initializes a new instance of CellColumnRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getPattern() | Gets the regular expression to match. |
| getFilter() | Gets the column and worksheet filter. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### CellColumnRedaction(CellFilter filter, Pattern regEx, ReplacementOptions options)
```
public CellColumnRedaction(CellFilter filter, Pattern regEx, ReplacementOptions options)
```

Initializes a new instance of CellColumnRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | CellFilter | Column and worksheet filter |
| regEx | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options |

##### getPattern()
```
public final Pattern getPattern()
```

Gets the regular expression to match.

**Returns:**
java.util.regex.Pattern - The regular expression to match.
##### getFilter()
```
public final CellFilter getFilter()
```

Gets the column and worksheet filter.

**Returns:**
CellFilter - The column and worksheet filter.
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### CellFilter
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/cellfilter.md

**Inheritance:**
java.lang.Object
```
public class CellFilter
```

Provides an option to limit the scope of a  CellColumnRedaction  to a worksheet and a column.

[Spreadsheet redactions]: https://docs.groupdocs.com/redaction/java/spreadsheet-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| CellFilter() | Initializes a new instance. |
#### Fields

| Field | Description |
| --- | --- |
| NoIndex | Represents a default value for filter, which is -1. |
#### Methods

| Method | Description |
| --- | --- |
| getWorkSheetName() | Gets a worksheet name (if applicable). |
| setWorkSheetName(String value) | Sets a worksheet name (if applicable). |
| getWorkSheetIndex() | Gets a worksheet index (zero-based). |
| setWorkSheetIndex(int value) | Sets a worksheet index (zero-based). |
| hasWorkSheetIndex() | Gets a value indicating whether the  WorkSheetIndex  is set or not. |
| getColumnIndex() | Gets a column index (zero-based). |
| setColumnIndex(int value) | Sets a column index (zero-based). |
##### CellFilter()
```
public CellFilter()
```

Initializes a new instance.

##### NoIndex
```
public static final int NoIndex
```

Represents a default value for filter, which is -1.

##### getWorkSheetName()
```
public final String getWorkSheetName()
```

Gets a worksheet name (if applicable).

**Returns:**
java.lang.String - A worksheet name (if applicable).
##### setWorkSheetName(String value)
```
public final void setWorkSheetName(String value)
```

Sets a worksheet name (if applicable).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A worksheet name (if applicable). |

##### getWorkSheetIndex()
```
public final int getWorkSheetIndex()
```

Gets a worksheet index (zero-based).

**Returns:**
int - A worksheet index (zero-based).
##### setWorkSheetIndex(int value)
```
public final void setWorkSheetIndex(int value)
```

Sets a worksheet index (zero-based).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A worksheet index (zero-based). |

##### hasWorkSheetIndex()
```
public final boolean hasWorkSheetIndex()
```

Gets a value indicating whether the  WorkSheetIndex  is set or not.

**Returns:**
boolean - A value indicating whether the  WorkSheetIndex  is set or not.
##### getColumnIndex()
```
public final int getColumnIndex()
```

Gets a column index (zero-based).

**Returns:**
int - A column index (zero-based).
##### setColumnIndex(int value)
```
public final void setColumnIndex(int value)
```

Sets a column index (zero-based).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | A column index (zero-based). |

### DeleteAnnotationRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/deleteannotationredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public class DeleteAnnotationRedaction extends Redaction
```

Represents a text redaction that deletes annotations if text is matching given regular expression (optionally deletes all annotations).

The following example demonstrates how to remove all annotations containing words "use", "show" or "describe" from document (and leave others).

```

  try (Redactor redactor = new Redactor("D:\\test.docx"))
 {
    redactor.apply(new DeleteAnnotationRedaction("(?im:(use|show|describe))"));
    redactor.save()
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Annotation redactions]: https://docs.groupdocs.com/redaction/java/annotation-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| DeleteAnnotationRedaction() | Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything). |
| DeleteAnnotationRedaction(String pattern) | Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression. |
| DeleteAnnotationRedaction(Pattern regex) | Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression. |
#### Methods

| Method | Description |
| --- | --- |
| getExpression() | Gets the regular expression to match. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### DeleteAnnotationRedaction()
```
public DeleteAnnotationRedaction()
```

Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything).

##### DeleteAnnotationRedaction(String pattern)
```
public DeleteAnnotationRedaction(String pattern)
```

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | Regular expression |

##### DeleteAnnotationRedaction(Pattern regex)
```
public DeleteAnnotationRedaction(Pattern regex)
```

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| regex | java.util.regex.Pattern | Regular expression |

##### getExpression()
```
public final Pattern getExpression()
```

Gets the regular expression to match.

**Returns:**
java.util.regex.Pattern - The regular expression to match.
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### EraseMetadataRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/erasemetadataredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.MetadataRedaction
```
public class EraseMetadataRedaction extends MetadataRedaction
```

Represents a metadata redaction that erases all metadata or metadata matching specific MetadataFilters from the document.

The following example demonstrates how to erase (set equal to empty values) all or specific metadata.

```

  try (Redactor redactor = new Redactor("C:\\sample.docx"))
 {
    // Erase Author, Manager and Company
    redactor.apply(new EraseMetadataRedaction(MetadataFilters.Author | MetadataFilters.Manager | MetadataFilters.Company));
    // Erase all metadata
    redactor.apply(new EraseMetadataRedaction(MetadataFilters.All));
    redactor.save();
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Metadata redactions]: https://docs.groupdocs.com/redaction/java/metadata-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| EraseMetadataRedaction() | Initializes a new instance of EraseMetadataRedaction class, erasing all metadata. |
| EraseMetadataRedaction(int filter) | Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of  MetadataFilters . |
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Returns a string, describing the redaction and its parameters. |
##### EraseMetadataRedaction()
```
public EraseMetadataRedaction()
```

Initializes a new instance of EraseMetadataRedaction class, erasing all metadata.

##### EraseMetadataRedaction(int filter)
```
public EraseMetadataRedaction(int filter)
```

Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of  MetadataFilters .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | int | Filter for metadata to erase |

##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.

### ExactPhraseRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/exactphraseredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction
```
public class ExactPhraseRedaction extends TextRedaction
```

Represents a text redaction that replaces exact phrase in the document's text, case insensitive by default.

The following example demonstrates performing case-sensitive phrase search and replacement.

```

  try (Redactor redactor = new Redactor("C:\\sample.pdf"))
 {
   // By default, the second parameter, isCaseSensitive = false;
   doc.apply(new ExactPhraseRedaction("John Doe", true, new ReplacementOptions("[personal]")));
   doc.save();
 }
 
```

The following example demonstrates replacing phrase (case insensitive) with solid red rectangle.

```

  try (Redactor redactor = new Redactor("C:\\sample.pdf"))
 {
   // By default, isCaseSensitive = false;
   doc.apply(new ExactPhraseRedaction("John Doe", new ReplacementOptions(System.Drawing.Color.Red)));
   doc.save();
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Text redactions]: https://docs.groupdocs.com/redaction/java/text-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| ExactPhraseRedaction(String searchPhrase, ReplacementOptions options) | Initializes a new instance of ExactPhraseRedaction class in case insensitive mode. |
| ExactPhraseRedaction(String searchPhrase, boolean isCaseSensitive, ReplacementOptions options) | Initializes a new instance of ExactPhraseRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getSearchPhrase() | Gets the string to search and replace. |
| isCaseSensitive() | Gets a value indicating whether the search is case-sensitive or not. |
| isRightToLeft() | Gets a value indicating if this text is right-to-Left or not, false by default. |
| setRightToLeft(boolean value) | Sets a value indicating if this text is right-to-Left or not, false by default. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### ExactPhraseRedaction(String searchPhrase, ReplacementOptions options)
```
public ExactPhraseRedaction(String searchPhrase, ReplacementOptions options)
```

Initializes a new instance of ExactPhraseRedaction class in case insensitive mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchPhrase | java.lang.String | String to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

##### ExactPhraseRedaction(String searchPhrase, boolean isCaseSensitive, ReplacementOptions options)
```
public ExactPhraseRedaction(String searchPhrase, boolean isCaseSensitive, ReplacementOptions options)
```

Initializes a new instance of ExactPhraseRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchPhrase | java.lang.String | String to search and replace |
| isCaseSensitive | boolean | True if case sensitive search is required |
| options | ReplacementOptions | Replacement options (textual, color) |

##### getSearchPhrase()
```
public final String getSearchPhrase()
```

Gets the string to search and replace.

**Returns:**
java.lang.String - The string to search and replace.
##### isCaseSensitive()
```
public final boolean isCaseSensitive()
```

Gets a value indicating whether the search is case-sensitive or not.

**Returns:**
boolean - A value indicating whether the search is case-sensitive or not.
##### isRightToLeft()
```
public final boolean isRightToLeft()
```

Gets a value indicating if this text is right-to-Left or not, false by default.

**Returns:**
boolean - A value indicating if this text is right-to-Left or not, false by default.
##### setRightToLeft(boolean value)
```
public final void setRightToLeft(boolean value)
```

Sets a value indicating if this text is right-to-Left or not, false by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating if this text is right-to-Left or not, false by default. |

##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### ImageAreaRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/imagearearedaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public class ImageAreaRedaction extends Redaction
```

Represents a redaction that places colored rectangle in given area of an image document.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Image redactions]: https://docs.groupdocs.com/redaction/java/image-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageAreaRedaction(Point topLeft, RegionReplacementOptions options) | Initializes a new instance of ImageAreaRedaction class for redacting specific area size. |
#### Methods

| Method | Description |
| --- | --- |
| getOptions() | Gets the  RegionReplacementOptions  options with color and area parameters. |
| getTopLeft() | Gets the top-left position of the area to remove |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)
```
public ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)
```

Initializes a new instance of ImageAreaRedaction class for redacting specific area size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | java.awt.Point | Top-left area coordinates |
| options | RegionReplacementOptions | Area size and color |

##### getOptions()
```
public final RegionReplacementOptions getOptions()
```

Gets the  RegionReplacementOptions  options with color and area parameters.

**Returns:**
RegionReplacementOptions - The  RegionReplacementOptions  options with color and area parameters.
##### getTopLeft()
```
public final Point getTopLeft()
```

Gets the top-left position of the area to remove

**Returns:**
java.awt.Point - The top-left position of the area to remove
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### IRedactionCallback
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/iredactioncallback.md

### MetadataFilters
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/metadatafilters.md

**Inheritance:**
java.lang.Object
```
public final class MetadataFilters
```

Represents a list of the most common types of document metadata.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataFilters() |  |
#### Fields

| Field | Description |
| --- | --- |
| None | Empty filter setting, matches no metadata items. |
| Author | Author of the document. |
| Category | Category of the document. |
| Comments | Comment for the document. |
| Company | Company of the Author. |
| ContentStatus | Content status. |
| CreatedTime | Created time. |
| HyperlinkBase | Hyperlink base. |
| LastPrinted | Last printed date and time. |
| LastSavedBy | Last saved by user. |
| LastSavedTime | Last saved date and time. |
| NameOfApplication | Name of application where the document was created. |
| Manager | Author's manager name. |
| RevisionNumber | Revision number. |
| Subject | Subject of the document. |
| Template | Document template name. |
| Title | Document title. |
| TotalEditingTime | Total editing time. |
| Version | Document's version. |
| Description | Document's description. |
| Keywords | Document's keywords. |
| ContentType | Content type. |
| All | All types of the metadata items. |
#### Methods

| Method | Description |
| --- | --- |
| getNames() | Gets a set with all declared filter types. |
| getValueByName(String valueName) | Gets value of MetadataFiler by its name. |
| parse(String values) | Parses a string of comma-delimited MetadataFilers values into an int. |
| toString(int value) | Saves an integer as a string of comma-delimited MetadataFilers values. |
##### MetadataFilters()
```
public MetadataFilters()
```

##### None
```
public static final int None
```

Empty filter setting, matches no metadata items.

##### Author
```
public static final int Author
```

Author of the document.

##### Category
```
public static final int Category
```

Category of the document.

##### Comments
```
public static final int Comments
```

Comment for the document.

##### Company
```
public static final int Company
```

Company of the Author.

##### ContentStatus
```
public static final int ContentStatus
```

Content status.

##### CreatedTime
```
public static final int CreatedTime
```

Created time.

##### HyperlinkBase
```
public static final int HyperlinkBase
```

Hyperlink base.

##### LastPrinted
```
public static final int LastPrinted
```

Last printed date and time.

##### LastSavedBy
```
public static final int LastSavedBy
```

Last saved by user.

##### LastSavedTime
```
public static final int LastSavedTime
```

Last saved date and time.

##### NameOfApplication
```
public static final int NameOfApplication
```

Name of application where the document was created.

##### Manager
```
public static final int Manager
```

Author's manager name.

##### RevisionNumber
```
public static final int RevisionNumber
```

Revision number.

##### Subject
```
public static final int Subject
```

Subject of the document.

##### Template
```
public static final int Template
```

Document template name.

##### Title
```
public static final int Title
```

Document title.

##### TotalEditingTime
```
public static final int TotalEditingTime
```

Total editing time.

##### Version
```
public static final int Version
```

Document's version.

##### Description
```
public static final int Description
```

Document's description.

##### Keywords
```
public static final int Keywords
```

Document's keywords.

##### ContentType
```
public static final int ContentType
```

Content type.

##### All
```
public static final int All
```

All types of the metadata items.

##### getNames()
```
public static Set<String> getNames()
```

Gets a set with all declared filter types.

**Returns:**
java.util.Set<java.lang.String> - A set with all declared filter types.
##### getValueByName(String valueName)
```
public static int getValueByName(String valueName)
```

Gets value of MetadataFiler by its name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueName | java.lang.String | Name of MetadataFilter. |

**Returns:**
int - Value of MetadataFiler.
##### parse(String values)
```
public static int parse(String values)
```

Parses a string of comma-delimited MetadataFilers values into an int.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| values | java.lang.String | A string of comma-delimited MetadataFilers values. |

**Returns:**
int - Value of MetadataFilers.
##### toString(int value)
```
public static String toString(int value)
```

Saves an integer as a string of comma-delimited MetadataFilers values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | Value of MetadataFiler. |

**Returns:**
java.lang.String - A string of comma-delimited MetadataFiler values.

### MetadataRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/metadataredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public abstract class MetadataRedaction extends Redaction
```

Represents a base abstract class for document metadata redactions.

[Metadata redactions]: https://docs.groupdocs.com/redaction/java/metadata-redactions/
#### Methods

| Method | Description |
| --- | --- |
| getFilter() | Gets the filter, which is used to select all or specific metadata, for example Author or Company. |
| setFilter(int value) | Sets the filter, which is used to select all or specific metadata, for example Author or Company. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### getFilter()
```
public final int getFilter()
```

Gets the filter, which is used to select all or specific metadata, for example Author or Company.

**Returns:**
int - The filter, which is used to select all or specific metadata, for example Author or Company.
##### setFilter(int value)
```
public final void setFilter(int value)
```

Sets the filter, which is used to select all or specific metadata, for example Author or Company.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The filter, which is used to select all or specific metadata, for example Author or Company. |

##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### MetadataSearchRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/metadatasearchredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.MetadataRedaction
```
public class MetadataSearchRedaction extends MetadataRedaction
```

Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values.

The following example demonstrates how to search and redact certain text in specific metadata.

```

  try (Redactor redactor = new Redactor("C:\\sample.docx"))
 {
    MetadataSearchRedaction redaction = new MetadataSearchRedaction("Company Ltd.", "--company--");
    // If not set, applies to all metadata items
    redaction.setFilter( MetadataFilters.Company );
    redactor.apply(redaction);
    redactor.save();
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Metadata redactions]: https://docs.groupdocs.com/redaction/java/metadata-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSearchRedaction(String valuePattern, String replacement) | Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items. |
| MetadataSearchRedaction(String valuePattern, String replacement, String keyPattern) | Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items. |
| MetadataSearchRedaction(Pattern valueRegex, String replacement) | Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items. |
| MetadataSearchRedaction(Pattern valueRegex, String replacement, Pattern keyRegex) | Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items. |
#### Methods

| Method | Description |
| --- | --- |
| getValueExpression() | Gets the regular expression to match value text of a metadata item. |
| getReplacement() | Gets the textual replacement value. |
| getKeyExpression() | Gets the regular expression to match name (key) of metadata item. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
##### MetadataSearchRedaction(String valuePattern, String replacement)
```
public MetadataSearchRedaction(String valuePattern, String replacement)
```

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valuePattern | java.lang.String | Regular expression to search and replace |
| replacement | java.lang.String | Textual replacement |

##### MetadataSearchRedaction(String valuePattern, String replacement, String keyPattern)
```
public MetadataSearchRedaction(String valuePattern, String replacement, String keyPattern)
```

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valuePattern | java.lang.String | Regular expression to search and replace metadata item value |
| replacement | java.lang.String | Textual replacement |
| keyPattern | java.lang.String | Regular expression to search and replace metadata item name |

##### MetadataSearchRedaction(Pattern valueRegex, String replacement)
```
public MetadataSearchRedaction(Pattern valueRegex, String replacement)
```

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueRegex | java.util.regex.Pattern | Regular expression to search and replace |
| replacement | java.lang.String | Textual replacement |

##### MetadataSearchRedaction(Pattern valueRegex, String replacement, Pattern keyRegex)
```
public MetadataSearchRedaction(Pattern valueRegex, String replacement, Pattern keyRegex)
```

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueRegex | java.util.regex.Pattern | Regular expression to search and replace metadata item value |
| replacement | java.lang.String | Textual replacement |
| keyRegex | java.util.regex.Pattern | Regular expression to search and replace metadata item name |

##### getValueExpression()
```
public final Pattern getValueExpression()
```

Gets the regular expression to match value text of a metadata item.

**Returns:**
java.util.regex.Pattern - The regular expression to match value text of a metadata item.
##### getReplacement()
```
public final String getReplacement()
```

Gets the textual replacement value.

**Returns:**
java.lang.String - The textual replacement value.
##### getKeyExpression()
```
public final Pattern getKeyExpression()
```

Gets the regular expression to match name (key) of metadata item.

**Returns:**
java.util.regex.Pattern - The regular expression to match name (key) of metadata item.
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.

### PageAreaFilter
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/pageareafilter.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.redactions.RedactionFilter
```
public class PageAreaFilter extends RedactionFilter
```

Represents redaction filter, setting an area within a page of a document to apply redaction.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Use PDF redaction filters]: https://docs.groupdocs.com/redaction/java/use-pdf-redaction-filters/
#### Constructors

| Constructor | Description |
| --- | --- |
| PageAreaFilter(Point topLeft, Dimension size) | Initializes a new instance of PageAreaFilter class for redacting specific area. |
#### Methods

| Method | Description |
| --- | --- |
| getRectangle() | Gets the rectangle (top-left position and size of the area) on a page. |
| isInTheArea(Rectangle rectangle) | Checks if this filter area has intersection with given rectangle. |
##### PageAreaFilter(Point topLeft, Dimension size)
```
public PageAreaFilter(Point topLeft, Dimension size)
```

Initializes a new instance of PageAreaFilter class for redacting specific area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | java.awt.Point | Top-left area coordinates |
| size | java.awt.Dimension | Area size and color |

##### getRectangle()
```
public final Rectangle getRectangle()
```

Gets the rectangle (top-left position and size of the area) on a page.

**Returns:**
java.awt.Rectangle - The rectangle (top-left position and size of the area) on a page.
##### isInTheArea(Rectangle rectangle)
```
public final boolean isInTheArea(Rectangle rectangle)
```

Checks if this filter area has intersection with given rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rectangle | java.awt.Rectangle | Rectangle to check |

**Returns:**
boolean - true, if this filter area has intersection

### PageAreaRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/pagearearedaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction, com.groupdocs.redaction.redactions.RegexRedaction
```
public class PageAreaRedaction extends RegexRedaction
```

Represents a complex textual redaction that affects text, images and annotations in an area of the page.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Use PageAreaRedaction]: https://docs.groupdocs.com/redaction/java/use-page-area-redaction/
#### Constructors

| Constructor | Description |
| --- | --- |
| PageAreaRedaction(Pattern regex, ReplacementOptions options) | Initializes a new instance of PageAreaRedaction class. |
| PageAreaRedaction(Pattern regex, ReplacementOptions options, RegionReplacementOptions imageOptions) | Initializes a new instance of PageAreaRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getImageOptions() | Gets the  RegionReplacementOptions  options with color and area parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### PageAreaRedaction(Pattern regex, ReplacementOptions options)
```
public PageAreaRedaction(Pattern regex, ReplacementOptions options)
```

Initializes a new instance of PageAreaRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

##### PageAreaRedaction(Pattern regex, ReplacementOptions options, RegionReplacementOptions imageOptions)
```
public PageAreaRedaction(Pattern regex, ReplacementOptions options, RegionReplacementOptions imageOptions)
```

Initializes a new instance of PageAreaRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
| imageOptions | RegionReplacementOptions | Replacement options (image area) |

##### getImageOptions()
```
public final RegionReplacementOptions getImageOptions()
```

Gets the  RegionReplacementOptions  options with color and area parameters.

**Returns:**
RegionReplacementOptions - The  RegionReplacementOptions  options with color and area parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### PageRangeFilter
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/pagerangefilter.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.redactions.RedactionFilter
```
public class PageRangeFilter extends RedactionFilter
```

Represents redaction filter, setting page range inside a document to apply redaction.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Use PDF redaction filters]: https://docs.groupdocs.com/redaction/java/use-pdf-redaction-filters/
#### Constructors

| Constructor | Description |
| --- | --- |
| PageRangeFilter(PageSeekOrigin origin, int index, int count) | Initializes a new instance of RemovePageRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getOrigin() | Gets seek reference position, the beginning or the end of a document. |
| getIndex() | Gets start position index (0-based). |
| getCount() | Gets the count of pages to remove. |
| isPageInRange(int pageIndex, int pageCount) | Checks if this filter page range contains given page. |
##### PageRangeFilter(PageSeekOrigin origin, int index, int count)
```
public PageRangeFilter(PageSeekOrigin origin, int index, int count)
```

Initializes a new instance of RemovePageRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| origin | PageSeekOrigin | Seek reference position, the beginning or the end of a document |
| index | int | Start position index (0-based) |
| count | int | Count of pages to remove |

##### getOrigin()
```
public final PageSeekOrigin getOrigin()
```

Gets seek reference position, the beginning or the end of a document.

**Returns:**
PageSeekOrigin - Seek reference position, the beginning or the end of a document.
##### getIndex()
```
public final int getIndex()
```

Gets start position index (0-based).

**Returns:**
int - Start position index (0-based).
##### getCount()
```
public final int getCount()
```

Gets the count of pages to remove.

**Returns:**
int - The count of pages to remove.
##### isPageInRange(int pageIndex, int pageCount)
```
public final boolean isPageInRange(int pageIndex, int pageCount)
```

Checks if this filter page range contains given page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageIndex | int | index of the page (zero-bazed) |
| pageCount | int | total page count |

**Returns:**
boolean - true, if this filter range contains page

### PageSeekOrigin
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/pageseekorigin.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PageSeekOrigin extends Enum<PageSeekOrigin>
```

Provides the fields that represent reference points in a document for seeking.

[Remove page redaction]: https://docs.groupdocs.com/redaction/java/remove-page-redaction/
#### Fields

| Field | Description |
| --- | --- |
| Begin | Specifies the beginning of a document. |
| End | Specifies the end of a document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Begin
```
public static final PageSeekOrigin Begin
```

Specifies the beginning of a document.

##### End
```
public static final PageSeekOrigin End
```

Specifies the end of a document.

##### values()
```
public static PageSeekOrigin[] values()
```

**Returns:**
com.groupdocs.redaction.redactions.PageSeekOrigin[]
##### valueOf(String name)
```
public static PageSeekOrigin valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageSeekOrigin

### RedactionActionType
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/redactionactiontype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum RedactionActionType extends Enum<RedactionActionType>
```

Represents actions that can be taken to perform redaction.
#### Fields

| Field | Description |
| --- | --- |
| Replacement | Redacted text was replaced with another or covered with a block. |
| Cleanup | Data were removed, but an empty object remains in the document. |
| Deletion | Data and related structures were removed from the document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Replacement
```
public static final RedactionActionType Replacement
```

Redacted text was replaced with another or covered with a block.

##### Cleanup
```
public static final RedactionActionType Cleanup
```

Data were removed, but an empty object remains in the document.

##### Deletion
```
public static final RedactionActionType Deletion
```

Data and related structures were removed from the document.

##### values()
```
public static RedactionActionType[] values()
```

**Returns:**
com.groupdocs.redaction.redactions.RedactionActionType[]
##### valueOf(String name)
```
public static RedactionActionType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
RedactionActionType

### RedactionDescription
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/redactiondescription.md

**Inheritance:**
java.lang.Object
```
public class RedactionDescription
```

Represents a single change action info that performed during redaction process.

[Use redaction callback]: https://docs.groupdocs.com/redaction/java/use-redaction-callback/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactionDescription(int redactionType, RedactionActionType actionType, String originalText) | Initializes a new instance of RedactionDescription class without replacement information. |
| RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement) | Initializes a new instance of RedactionDescription class with replacement information. |
| RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails) | Initializes a new instance of RedactionDescription class with image area replacement information. |
#### Methods

| Method | Description |
| --- | --- |
| getRedactionType() | Gets the type of document's data - text, metadata or annotations. |
| getActionType() | Gets the redaction operation: replacement, cleanup or deletion. |
| getOriginalText() | Gets the matched text, if any expression is provided. |
| getReplacement() | Gets the replacement information, can be null. |
| getImageAreaReplacement() | Gets the replacement information for image area redactions, returns null for textual redactions. |
| getDetails() | Gets an optional details information for the item being redacted. |
| setDetails(String value) | Sets an optional details information for the item being redacted. |
##### RedactionDescription(int redactionType, RedactionActionType actionType, String originalText)
```
public RedactionDescription(int redactionType, RedactionActionType actionType, String originalText)
```

Initializes a new instance of RedactionDescription class without replacement information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | int | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| originalText | java.lang.String | Matched text, comment or annotation body |

##### RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement)
```
public RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement)
```

Initializes a new instance of RedactionDescription class with replacement information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | int | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| originalText | java.lang.String | Matched text, comment or annotation body |
| replacement | TextReplacement | Replacement text, matched text and its position within original string |

##### RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails)
```
public RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails)
```

Initializes a new instance of RedactionDescription class with image area replacement information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | int | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| imageAreaReplacement | RegionReplacementOptions | Image area replacement information |
| imageDetails | java.lang.String | Image textual description, by default it is String.Empty |

##### getRedactionType()
```
public final int getRedactionType()
```

Gets the type of document's data - text, metadata or annotations.

**Returns:**
int - The type of document's data - text, metadata or annotations.
##### getActionType()
```
public final RedactionActionType getActionType()
```

Gets the redaction operation: replacement, cleanup or deletion.

**Returns:**
RedactionActionType - The redaction operation: replacement, cleanup or deletion.
##### getOriginalText()
```
public final String getOriginalText()
```

Gets the matched text, if any expression is provided.

**Returns:**
java.lang.String - The matched text, if any expression is provided.
##### getReplacement()
```
public final TextReplacement getReplacement()
```

Gets the replacement information, can be null.

**Returns:**
TextReplacement - The replacement information, can be null.
##### getImageAreaReplacement()
```
public final RegionReplacementOptions getImageAreaReplacement()
```

Gets the replacement information for image area redactions, returns null for textual redactions.

**Returns:**
RegionReplacementOptions - The replacement information for image area redactions, returns null for textual redactions.
##### getDetails()
```
public final String getDetails()
```

Gets an optional details information for the item being redacted.

**Returns:**
java.lang.String - An optional details information for the item being redacted.
##### setDetails(String value)
```
public final void setDetails(String value)
```

Sets an optional details information for the item being redacted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | An optional details information for the item being redacted. |

### RedactionFilter
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/redactionfilter.md

**Inheritance:**
java.lang.Object
```
public abstract class RedactionFilter
```

Represents redaction filter, setting scope inside a document to apply redactions.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Use PDF redaction filters]: https://docs.groupdocs.com/redaction/java/use-pdf-redaction-filters/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactionFilter() |  |
##### RedactionFilter()
```
public RedactionFilter()
```

### RedactionType
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/redactiontype.md

**Inheritance:**
java.lang.Object
```
public final class RedactionType
```

Represents a type of document's data, affected by redaction.
#### Fields

| Field | Description |
| --- | --- |
| Text | The document's body text. |
| Metadata | The document's metadata. |
| Annotation | The annotations within document's text. |
| ImageArea | The area within an image. |
| Page | The page of a document. |
#### Methods

| Method | Description |
| --- | --- |
| values() | List of RedactionType values. |
##### Text
```
public static final int Text
```

The document's body text.

##### Metadata
```
public static final int Metadata
```

The document's metadata.

##### Annotation
```
public static final int Annotation
```

The annotations within document's text.

##### ImageArea
```
public static final int ImageArea
```

The area within an image.

##### Page
```
public static final int Page
```

The page of a document.

##### values()
```
public static List<String> values()
```

List of RedactionType values.

**Returns:**
java.util.List<java.lang.String>

### RegexRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/regexredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction
```
public class RegexRedaction extends TextRedaction
```

Represents a text redaction that searches and replaces text in the document by matching provided regular expression.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Text redactions]: https://docs.groupdocs.com/redaction/java/text-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| RegexRedaction(String pattern, ReplacementOptions options) | Initializes a new instance of RegexRedaction class. |
| RegexRedaction(Pattern regex, ReplacementOptions options) | Initializes a new instance of RegexRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getRegularExpression() | Gets the regular expression to match. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### RegexRedaction(String pattern, ReplacementOptions options)
```
public RegexRedaction(String pattern, ReplacementOptions options)
```

Initializes a new instance of RegexRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

##### RegexRedaction(Pattern regex, ReplacementOptions options)
```
public RegexRedaction(Pattern regex, ReplacementOptions options)
```

Initializes a new instance of RegexRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

##### getRegularExpression()
```
public final Pattern getRegularExpression()
```

Gets the regular expression to match.

**Returns:**
java.util.regex.Pattern - The regular expression to match.
##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### RegionReplacementOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/regionreplacementoptions.md

**Inheritance:**
java.lang.Object
```
public class RegionReplacementOptions
```

Represents color and area parameters for image region replacement. See  ImageAreaRedaction .

[Image redactions]: https://docs.groupdocs.com/redaction/java/image-redactions/
#### Constructors

| Constructor | Description |
| --- | --- |
| RegionReplacementOptions(Color fillColor, Dimension size) | Initializes a new instance of RegionReplacementOptions class. |
| RegionReplacementOptions(Color fillColor, Font font, String expectedText) | Initializes a new instance of RegionReplacementOptions class which size matches given text. |
#### Methods

| Method | Description |
| --- | --- |
| getFillColor() | Gets the color to fill the redacted area. |
| setFillColor(Color value) | Sets the color to fill the redacted area. |
| getSize() | Gets the rectangle with and height. |
| setSize(Dimension value) | Sets the rectangle with and height. |
##### RegionReplacementOptions(Color fillColor, Dimension size)
```
public RegionReplacementOptions(Color fillColor, Dimension size)
```

Initializes a new instance of RegionReplacementOptions class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fillColor | java.awt.Color | Color to fill the area |
| size | java.awt.Dimension | Filled area size |

##### RegionReplacementOptions(Color fillColor, Font font, String expectedText)
```
public RegionReplacementOptions(Color fillColor, Font font, String expectedText)
```

Initializes a new instance of RegionReplacementOptions class which size matches given text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fillColor | java.awt.Color | Color to fill the area |
| font | java.awt.Font | Expected text font |
| expectedText | java.lang.String | Expected text |

##### getFillColor()
```
public final Color getFillColor()
```

Gets the color to fill the redacted area.

**Returns:**
java.awt.Color - The color to fill the redacted area.
##### setFillColor(Color value)
```
public final void setFillColor(Color value)
```

Sets the color to fill the redacted area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The color to fill the redacted area. |

##### getSize()
```
public final Dimension getSize()
```

Gets the rectangle with and height.

**Returns:**
java.awt.Dimension - The rectangle with and height.
##### setSize(Dimension value)
```
public final void setSize(Dimension value)
```

Sets the rectangle with and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Dimension | The rectangle with and height. |

### RemovePageRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/removepageredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public class RemovePageRedaction extends Redaction
```

Represents a redaction that removes a page (slide, worksheet, etc.) from a document.

The following example demonstrates how to remove the last page of the document.

```

  try (Redactor redactor = new Redactor("C:\\test.pdf"))
 {
    redactor.apply(new RemovePageRedaction(PageSeekOrigin.END, 0, 1));
    redactor.save()
 }
 
```

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Remove page redaction]: https://docs.groupdocs.com/redaction/java/remove-page-redaction/
#### Constructors

| Constructor | Description |
| --- | --- |
| RemovePageRedaction(PageSeekOrigin origin, int index, int count) | Initializes a new instance of RemovePageRedaction class. |
#### Methods

| Method | Description |
| --- | --- |
| getOrigin() | Gets seek reference position, the beginning or the end of a document. |
| getIndex() | Gets start position index (0-based). |
| getCount() | Gets the count of pages to remove. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### RemovePageRedaction(PageSeekOrigin origin, int index, int count)
```
public RemovePageRedaction(PageSeekOrigin origin, int index, int count)
```

Initializes a new instance of RemovePageRedaction class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| origin | PageSeekOrigin | Seek reference position, the beginning or the end of a document |
| index | int | Start position index (0-based) |
| count | int | Count of pages to remove |

##### getOrigin()
```
public final PageSeekOrigin getOrigin()
```

Gets seek reference position, the beginning or the end of a document.

**Returns:**
PageSeekOrigin - Seek reference position, the beginning or the end of a document.
##### getIndex()
```
public final int getIndex()
```

Gets start position index (0-based).

**Returns:**
int - Start position index (0-based).
##### getCount()
```
public final int getCount()
```

Gets the count of pages to remove.

**Returns:**
int - The count of pages to remove.
##### applyTo(DocumentFormatInstance formatInstance)
```
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### ReplacementOptions
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/replacementoptions.md

**Inheritance:**
java.lang.Object
```
public class ReplacementOptions
```

Represents options for matched text replacement.

[Text redactions]: https://docs.groupdocs.com/redaction/java/text-redactions/
[Use PDF redaction filters]: https://docs.groupdocs.com/redaction/java/use-pdf-redaction-filters/
#### Constructors

| Constructor | Description |
| --- | --- |
| ReplacementOptions(String replacement) | Initializes a new instance of ReplacementOptions class with replacement text as an option. |
| ReplacementOptions(Color color) | Initializes a new instance of ReplacementOptions class with colored rectangle as an option. |
#### Methods

| Method | Description |
| --- | --- |
| getActionType() | Gets the replacement action: draw box or replace text. |
| getReplacement() | Gets the textual replacement value. |
| setReplacement(String value) | Sets the textual replacement value. |
| getBoxColor() | Gets the color for a  ReplacementType.DrawBox  option (ignored otherwise). |
| setBoxColor(Color value) | Sets the color for a  ReplacementType.DrawBox  option (ignored otherwise). |
| getFilters() | Gets an array of filters to apply with this redaction. |
| setFilters(RedactionFilter[] value) | Sets an array of filters to apply with this redaction. |
| fromFilters(RedactionFilter[] filters) |  |
##### ReplacementOptions(String replacement)
```
public ReplacementOptions(String replacement)
```

Initializes a new instance of ReplacementOptions class with replacement text as an option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| replacement | java.lang.String | Textual replacement |

##### ReplacementOptions(Color color)
```
public ReplacementOptions(Color color)
```

Initializes a new instance of ReplacementOptions class with colored rectangle as an option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.awt.Color | Rectangle color |

##### getActionType()
```
public final ReplacementType getActionType()
```

Gets the replacement action: draw box or replace text.

**Returns:**
ReplacementType - The replacement action: draw box or replace text.
##### getReplacement()
```
public final String getReplacement()
```

Gets the textual replacement value.

**Returns:**
java.lang.String - The textual replacement value.
##### setReplacement(String value)
```
public final void setReplacement(String value)
```

Sets the textual replacement value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The textual replacement value. |

##### getBoxColor()
```
public final Color getBoxColor()
```

Gets the color for a  ReplacementType.DrawBox  option (ignored otherwise).

**Returns:**
java.awt.Color - The color for a  ReplacementType.DrawBox  option (ignored otherwise).
##### setBoxColor(Color value)
```
public final void setBoxColor(Color value)
```

Sets the color for a  ReplacementType.DrawBox  option (ignored otherwise).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The color for a  ReplacementType.DrawBox  option (ignored otherwise). |

##### getFilters()
```
public final RedactionFilter[] getFilters()
```

Gets an array of filters to apply with this redaction.

**Returns:**
com.groupdocs.redaction.redactions.RedactionFilter[] - An array of filters to apply with this redaction.
##### setFilters(RedactionFilter[] value)
```
public final void setFilters(RedactionFilter[] value)
```

Sets an array of filters to apply with this redaction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | RedactionFilter\[\] | An array of filters to apply with this redaction. |

##### fromFilters(RedactionFilter[] filters)
```
public static ReplacementOptions fromFilters(RedactionFilter[] filters)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filters | RedactionFilter\[\] |  |

**Returns:**
ReplacementOptions

### ReplacementType
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/replacementtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ReplacementType extends Enum<ReplacementType>
```

Represents a type of replacement for the matched text.
#### Fields

| Field | Description |
| --- | --- |
| ReplaceString | Replaces matched text with another string, e.g. |
| DrawBox | Draws a rectangle of specific color (Black by default) instead of redacted text. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### ReplaceString
```
public static final ReplacementType ReplaceString
```

Replaces matched text with another string, e.g. exemption code.

##### DrawBox
```
public static final ReplacementType DrawBox
```

Draws a rectangle of specific color (Black by default) instead of redacted text.

##### values()
```
public static ReplacementType[] values()
```

**Returns:**
com.groupdocs.redaction.redactions.ReplacementType[]
##### valueOf(String name)
```
public static ReplacementType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ReplacementType

### TextRedaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/textredaction.md

**Inheritance:**
java.lang.Object, com.groupdocs.redaction.Redaction
```
public abstract class TextRedaction extends Redaction
```

Represents a base abstract class for document text redactions.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Text redactions]: https://docs.groupdocs.com/redaction/java/text-redactions/
#### Methods

| Method | Description |
| --- | --- |
| getActionOptions() | Gets the  ReplacementOptions  instance, specifying type of text replacement. |
| getOcrConnector() | Gets the  IOcrConnector  implementation, required to extract text from graphic content. |
| setOcrConnector(IOcrConnector value) | Sets the  IOcrConnector  implementation, required to extract text from graphic content. |
##### getActionOptions()
```
public final ReplacementOptions getActionOptions()
```

Gets the  ReplacementOptions  instance, specifying type of text replacement.

**Returns:**
ReplacementOptions - The  ReplacementOptions  instance, specifying type of text replacement.
##### getOcrConnector()
```
public final IOcrConnector getOcrConnector()
```

Gets the  IOcrConnector  implementation, required to extract text from graphic content.

**Returns:**
IOcrConnector - The  IOcrConnector  implementation, required to extract text from graphic content.
##### setOcrConnector(IOcrConnector value)
```
public final void setOcrConnector(IOcrConnector value)
```

Sets the  IOcrConnector  implementation, required to extract text from graphic content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IOcrConnector | The  IOcrConnector  implementation, required to extract text from graphic content. |

### TextReplacement
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.redactions/textreplacement.md

**Inheritance:**
java.lang.Object
```
public class TextReplacement
```

Represents a textual replacement information.

[Use redaction callback]: https://docs.groupdocs.com/redaction/java/use-redaction-callback/
#### Constructors

| Constructor | Description |
| --- | --- |
| TextReplacement(int index, String original, String replacement) | Initializes a new instance of TextReplacement class. |
#### Methods

| Method | Description |
| --- | --- |
| getIndex() | Gets an index of the matched text within source string. |
| getOriginalText() | Gets the original matched string. |
| getReplacement() | Gets the string, replacing OriginalText. |
| toString() | Provides text replacement description and its position. |
##### TextReplacement(int index, String original, String replacement)
```
public TextReplacement(int index, String original, String replacement)
```

Initializes a new instance of TextReplacement class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | Index of a matched text within source string |
| original | java.lang.String | Original matched string |
| replacement | java.lang.String | String, replacing OriginalText in source string |

##### getIndex()
```
public final int getIndex()
```

Gets an index of the matched text within source string.

**Returns:**
int - An index of the matched text within source string.
##### getOriginalText()
```
public final String getOriginalText()
```

Gets the original matched string.

**Returns:**
java.lang.String - The original matched string.
##### getReplacement()
```
public final String getReplacement()
```

Gets the string, replacing OriginalText.

**Returns:**
java.lang.String - The string, replacing OriginalText.
##### toString()
```
public String toString()
```

Provides text replacement description and its position.

**Returns:**
java.lang.String - Replacement description

### com.groupdocs.redaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction.md

The package provides classes for redacting sensitive information from documents in PDF, raster image and office document formats.

The main classes in this package are:

 *  Redactor is the entry point for redaction process.
 *  Redaction is abstract base class for all types of document redactions.
 *  RedactionPolicy is pre-configured in XML set of redaction rules.
 *  RedactorChangeLog provides information about redaction process results.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Represents an information about document. |
| FileType | Represents a file type. |
| PageInfo | Represents a brief page information. |
| Redaction | Represents a base abstract class for all redaction types. |
| RedactionPolicy | Represents a sanitization policy, containing a set of specific redactions to apply. |
| RedactionResult | Represents a result of the redaction operation. |
| Redactor | Represents a main class that controls document redaction process, allowing to open, redact and save documents. |
| RedactorChangeLog | Represents results for a list of redactions, passed to Apply() method of  Redactor  class. |
| RedactorLogEntry | Represents results of applying redaction. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines methods that are required for getting basic document information. |

#### Enumerations

| Enum | Description |
| --- | --- |
| RedactionStatus | Represents a redaction completion status. |

### DocumentInfo
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.redaction.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Represents an information about document. Implements IDocumentInfo interface. See  IDocumentInfo  for examples.

[Get file info]: https://docs.groupdocs.com/redaction/java/get-file-info/
#### Methods

| Method | Description |
| --- | --- |
| getFileType() | Gets the file format description. |
| getPageCount() | Gets the total page count. |
| getSize() | Gets the document size in bytes. |
| getPages() | Gets the list of page information. |
##### getFileType()
```
public final FileType getFileType()
```

Gets the file format description.

**Returns:**
FileType - The file format description.
##### getPageCount()
```
public final int getPageCount()
```

Gets the total page count.

**Returns:**
int - The total page count.
##### getSize()
```
public final long getSize()
```

Gets the document size in bytes.

**Returns:**
long - The document size in bytes.
##### getPages()
```
public final List<PageInfo> getPages()
```

Gets the list of page information.

**Returns:**
java.util.List<com.groupdocs.redaction.PageInfo> - The list of page information.

### FileType
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents a file type. Provides methods to obtain a list of all file types supported by GroupDocs.Redaction, detect file type by extension, etc.

[Supported Document Formats]: https://docs.groupdocs.com/redaction/java/supported-document-formats/
[Get supported file formats]: https://docs.groupdocs.com/redaction/java/get-supported-file-formats/
[Get file info]: https://docs.groupdocs.com/redaction/java/get-file-info/
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets file type name, for example "Microsoft Word Document". |
| getExtension() | Gets filename suffix (including the period "."), for instance ".doc". |
| getUnknown() | Represents unknown file type. |
| getTIF() | Tagged Image File (.tif) |
| getTIFF() | Tagged Image File Format (.tiff) |
| getJPG() | JPEG Image (.jpg) |
| getJPEG() | JPEG Image (.jpeg) |
| getPNG() | Portable Network Graphic (.png) |
| getGIF() | Graphical Interchange Format File (.gif) |
| getBMP() | Bitmap Image File (.bmp) |
| getJP2() | JPEG 2000 Core Image File (.jp2) |
| getHTM() | Hypertext Markup Language File (.htm) |
| getHTML() | Hypertext Markup Language File (.html) |
| getPDF() | Portable Document Format File (.pdf) |
| getPPT() | PowerPoint Presentation (.ppt) |
| getPPTX() | PowerPoint Open XML Presentation (.pptx) |
| getODP() | OpenDocument Presentation (.odp) |
| getXLS() | Excel Spreadsheet (.xls) |
| getXLSX() | Microsoft Excel Open XML Spreadsheet (.xlsx) |
| getXLSM() | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) |
| getXLSB() | Excel Binary Spreadsheet (.xlsb) |
| getCSV() | Comma Separated Values File (.csv) |
| getTSV() | Tab Separated Values File (.tsv) |
| getODS() | OpenDocument Spreadsheet (.ods) |
| getOTS() | OpenDocument Spreadsheet Template (.ots) |
| getNUMBERS() | Apple Numbers Spreadsheet (.numbers) |
| getMD() | Markdown Documentation File (.md) |
| getDOC() | Microsoft Word Document (.doc) |
| getDOCX() | Microsoft Word Open XML Document (.docx) |
| getDOCM() | Word Open XML Macro-Enabled Document (.docm) |
| getDOT() | Word Document Template (.dot) |
| getDOTX() | Word Open XML Document Template (.dotx) |
| getDOTM() | Word Open XML Macro-Enabled Document Template (.dotm) |
| getRTF() | Rich Text Format File (.rtf) |
| getTXT() | Plain Text File (.txt) |
| getODT() | OpenDocument Text Document (.odt) |
| getOTT() | OpenDocument Document Template (.ott) |
| fromExtension(String extension) | Maps file extension to file type. |
| getSupportedFileTypes() | Retrieves supported file types |
| equals(FileType other) | Determines whether the current  FileType  is the same as specified  FileType  object. |
| equals(Object obj) | Determines whether the current  FileType  is the same as specified object. |
| hashCode() | Returns the hash code for the current  FileType  object. |
| op_Equality(FileType left, FileType right) | Determines whether two  FileType  objects are the same. |
| op_Inequality(FileType left, FileType right) | Determines whether two  FileType  objects are not the same. |
| toString() | Returns a string that represents the current object. |
##### getFileFormat()
```
public final String getFileFormat()
```

Gets file type name, for example "Microsoft Word Document".

**Returns:**
java.lang.String - File type name, for example "Microsoft Word Document".
##### getExtension()
```
public final String getExtension()
```

Gets filename suffix (including the period "."), for instance ".doc".

**Returns:**
java.lang.String - Filename suffix (including the period "."), for instance ".doc".
##### getUnknown()
```
public static FileType getUnknown()
```

Represents unknown file type.

**Returns:**
FileType
##### getTIF()
```
public static FileType getTIF()
```

Tagged Image File (.tif)

**Returns:**
FileType
##### getTIFF()
```
public static FileType getTIFF()
```

Tagged Image File Format (.tiff)

**Returns:**
FileType
##### getJPG()
```
public static FileType getJPG()
```

JPEG Image (.jpg)

**Returns:**
FileType
##### getJPEG()
```
public static FileType getJPEG()
```

JPEG Image (.jpeg)

**Returns:**
FileType
##### getPNG()
```
public static FileType getPNG()
```

Portable Network Graphic (.png)

**Returns:**
FileType
##### getGIF()
```
public static FileType getGIF()
```

Graphical Interchange Format File (.gif)

**Returns:**
FileType
##### getBMP()
```
public static FileType getBMP()
```

Bitmap Image File (.bmp)

**Returns:**
FileType
##### getJP2()
```
public static FileType getJP2()
```

JPEG 2000 Core Image File (.jp2)

**Returns:**
FileType
##### getHTM()
```
public static FileType getHTM()
```

Hypertext Markup Language File (.htm)

**Returns:**
FileType
##### getHTML()
```
public static FileType getHTML()
```

Hypertext Markup Language File (.html)

**Returns:**
FileType
##### getPDF()
```
public static FileType getPDF()
```

Portable Document Format File (.pdf)

**Returns:**
FileType
##### getPPT()
```
public static FileType getPPT()
```

PowerPoint Presentation (.ppt)

**Returns:**
FileType
##### getPPTX()
```
public static FileType getPPTX()
```

PowerPoint Open XML Presentation (.pptx)

**Returns:**
FileType
##### getODP()
```
public static FileType getODP()
```

OpenDocument Presentation (.odp)

**Returns:**
FileType
##### getXLS()
```
public static FileType getXLS()
```

Excel Spreadsheet (.xls)

**Returns:**
FileType
##### getXLSX()
```
public static FileType getXLSX()
```

Microsoft Excel Open XML Spreadsheet (.xlsx)

**Returns:**
FileType
##### getXLSM()
```
public static FileType getXLSM()
```

Excel Open XML Macro-Enabled Spreadsheet (.xlsm)

**Returns:**
FileType
##### getXLSB()
```
public static FileType getXLSB()
```

Excel Binary Spreadsheet (.xlsb)

**Returns:**
FileType
##### getCSV()
```
public static FileType getCSV()
```

Comma Separated Values File (.csv)

**Returns:**
FileType
##### getTSV()
```
public static FileType getTSV()
```

Tab Separated Values File (.tsv)

**Returns:**
FileType
##### getODS()
```
public static FileType getODS()
```

OpenDocument Spreadsheet (.ods)

**Returns:**
FileType
##### getOTS()
```
public static FileType getOTS()
```

OpenDocument Spreadsheet Template (.ots)

**Returns:**
FileType
##### getNUMBERS()
```
public static FileType getNUMBERS()
```

Apple Numbers Spreadsheet (.numbers)

**Returns:**
FileType
##### getMD()
```
public static FileType getMD()
```

Markdown Documentation File (.md)

**Returns:**
FileType
##### getDOC()
```
public static FileType getDOC()
```

Microsoft Word Document (.doc)

**Returns:**
FileType
##### getDOCX()
```
public static FileType getDOCX()
```

Microsoft Word Open XML Document (.docx)

**Returns:**
FileType
##### getDOCM()
```
public static FileType getDOCM()
```

Word Open XML Macro-Enabled Document (.docm)

**Returns:**
FileType
##### getDOT()
```
public static FileType getDOT()
```

Word Document Template (.dot)

**Returns:**
FileType
##### getDOTX()
```
public static FileType getDOTX()
```

Word Open XML Document Template (.dotx)

**Returns:**
FileType
##### getDOTM()
```
public static FileType getDOTM()
```

Word Open XML Macro-Enabled Document Template (.dotm)

**Returns:**
FileType
##### getRTF()
```
public static FileType getRTF()
```

Rich Text Format File (.rtf)

**Returns:**
FileType
##### getTXT()
```
public static FileType getTXT()
```

Plain Text File (.txt)

**Returns:**
FileType
##### getODT()
```
public static FileType getODT()
```

OpenDocument Text Document (.odt)

**Returns:**
FileType
##### getOTT()
```
public static FileType getOTT()
```

OpenDocument Document Template (.ott)

**Returns:**
FileType
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period "."). |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default  Unknown  file type.
##### getSupportedFileTypes()
```
public static Iterable<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.lang.Iterable<com.groupdocs.redaction.FileType> - Returns sequence of supported file types
##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current  FileType  is the same as specified  FileType  object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current  FileType  object. |

**Returns:**
boolean - ```
true
```

if both  FileType  objects are the same; otherwise,

```
false
```
### equals(Object obj) {#equals-java.lang.Object-}
```
public boolean equals(Object obj)
```


Determines whether the current  FileType  is the same as specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current  FileType  object. |

**Returns:**
boolean - ```
true
```

if

```
obj
```

parameter is  FileType  and is the same as current  FileType  object; otherwise,

```
false
```
##### hashCode()
```
public int hashCode()
```

Returns the hash code for the current  FileType  object.

**Returns:**
int - A hash code for the current  FileType  object.
##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two  FileType  objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left  FileType  object. |
| right | FileType | Right  FileType  object. |

**Returns:**
boolean - ```
true
```

if both  FileType  objects are the same; otherwise,

```
false
```
### op_Inequality(FileType left, FileType right) {#op-Inequality-com.groupdocs.redaction.FileType-com.groupdocs.redaction.FileType-}
```
public static boolean op_Inequality(FileType left, FileType right)
```


Determines whether two  FileType  objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | [FileType](../../com.groupdocs.redaction/filetype) | Left  FileType  object. |
| right | [FileType](../../com.groupdocs.redaction/filetype) | Right  FileType  object. |

**Returns:**
boolean - ```
true
```

if both  FileType  objects are not the same; otherwise,

```
false
```
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### IDocumentInfo
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/idocumentinfo.md

### PageInfo
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Represents a brief page information.

[Get file info]: https://docs.groupdocs.com/redaction/java/get-file-info/
#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the page width. |
| setWidth(int value) | Sets the page width. |
| getHeight() | Gets the page height. |
| setHeight(int value) | Sets the page height. |
| getPageNumber() | Gets the page number. |
| setPageNumber(int value) | Sets the page number. |
##### PageInfo()
```
public PageInfo()
```

##### getWidth()
```
public final int getWidth()
```

Gets the page width.

**Returns:**
int - The page width.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the page width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page width. |

##### getHeight()
```
public final int getHeight()
```

Gets the page height.

**Returns:**
int - The page height.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the page height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page height. |

##### getPageNumber()
```
public final int getPageNumber()
```

Gets the page number.

**Returns:**
int - The page number.
##### setPageNumber(int value)
```
public final void setPageNumber(int value)
```

Sets the page number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page number. |

### Redaction
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redaction.md

**Inheritance:**
java.lang.Object
```
public abstract class Redaction
```

Represents a base abstract class for all redaction types.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Advanced usage]: https://docs.groupdocs.com/redaction/java/advanced-usage/
#### Constructors

| Constructor | Description |
| --- | --- |
| Redaction() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
##### Redaction()
```
public Redaction()
```

##### getDescription()
```
public String getDescription()
```

Returns a string, describing the redaction and its parameters.

**Returns:**
java.lang.String - Text, containing redaction name and parameters.
##### applyTo(DocumentFormatInstance formatInstance)
```
public abstract RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
```

Applies the redaction to a given format instance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

**Returns:**
RedactorLogEntry - Status of the redaction: success/failure and error message if any

### RedactionPolicy
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactionpolicy.md

**Inheritance:**
java.lang.Object
```
public class RedactionPolicy
```

Represents a sanitization policy, containing a set of specific redactions to apply.

[Use of redaction policies]: https://docs.groupdocs.com/redaction/java/use-redaction-policies/
[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactionPolicy() | Creates a new instance of Redaction policy. |
| RedactionPolicy(Redaction[] redactions) | Creates a new instance of Redaction policy with a specific list of redactions. |
#### Methods

| Method | Description |
| --- | --- |
| getRedactions() | Gets an array of fully configured  Redaction -derived classes. |
| load(String filePath) | Loads an instance of  RedactionPolicy  from a file path. |
| load(InputStream input) | Loads an instance of  RedactionPolicy  from a stream. |
| save(String filePath) | Saves the redaction policy to a file. |
| save(OutputStream output) | Saves the redaction policy to a stream. |
##### RedactionPolicy()
```
public RedactionPolicy()
```

Creates a new instance of Redaction policy.

##### RedactionPolicy(Redaction[] redactions)
```
public RedactionPolicy(Redaction[] redactions)
```

Creates a new instance of Redaction policy with a specific list of redactions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redactions | Redaction\[\] | An array of redactions for the policy |

##### getRedactions()
```
public final Redaction[] getRedactions()
```

Gets an array of fully configured  Redaction -derived classes.

**Returns:**
com.groupdocs.redaction.Redaction[] - An array of fully configured  Redaction -derived classes.
##### load(String filePath)
```
public static RedactionPolicy load(String filePath)
```

Loads an instance of  RedactionPolicy  from a file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to XML file |

**Returns:**
RedactionPolicy - Redaction policy
##### load(InputStream input)
```
public static RedactionPolicy load(InputStream input)
```

Loads an instance of  RedactionPolicy  from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| input | java.io.InputStream | Stream containing XML configuration |

**Returns:**
RedactionPolicy - Redaction policy
##### save(String filePath)
```
public final void save(String filePath)
```

Saves the redaction policy to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to file. |

##### save(OutputStream output)
```
public final void save(OutputStream output)
```

Saves the redaction policy to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.OutputStream | Target stream to save the policy |

### RedactionResult
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactionresult.md

**Inheritance:**
java.lang.Object
```
public class RedactionResult
```

Represents a result of the redaction operation.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
#### Methods

| Method | Description |
| --- | --- |
| getStatus() | Gets the execution status. |
| getErrorMessage() | Gets the error message for diagnostics. |
| skipped(String description) | Initializes a new instance of RedactionResult class with Skipped status. |
| partial(String description) | Initializes a new instance of RedactionResult class with PartiallyApplied status. |
| failed(String description) | Initializes a new instance of RedactionResult class with Failed status. |
| successful() | Initializes a new instance of RedactionResult class with Applied (successful) status. |
##### getStatus()
```
public final RedactionStatus getStatus()
```

Gets the execution status.

**Returns:**
RedactionStatus - The execution status.
##### getErrorMessage()
```
public final String getErrorMessage()
```

Gets the error message for diagnostics.

**Returns:**
java.lang.String - The error message for diagnostics.
##### skipped(String description)
```
public static RedactionResult skipped(String description)
```

Initializes a new instance of RedactionResult class with Skipped status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | Reason why the operation was skipped |

**Returns:**
RedactionResult - Sskipped redaction result
##### partial(String description)
```
public static RedactionResult partial(String description)
```

Initializes a new instance of RedactionResult class with PartiallyApplied status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | Reason why the operation was not fully applied |

**Returns:**
RedactionResult - Partially applied redaction result
##### failed(String description)
```
public static RedactionResult failed(String description)
```

Initializes a new instance of RedactionResult class with Failed status.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| description | java.lang.String | Failure or exception details |

**Returns:**
RedactionResult - Failed redaction result
##### successful()
```
public static RedactionResult successful()
```

Initializes a new instance of RedactionResult class with Applied (successful) status.

**Returns:**
RedactionResult - Successful redaction result

### RedactionStatus
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactionstatus.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum RedactionStatus extends Enum<RedactionStatus>
```

Represents a redaction completion status.
#### Fields

| Field | Description |
| --- | --- |
| Applied | Redaction was fully and successfully applied. |
| PartiallyApplied | Redaction was aplied only to a part of its matches. |
| Skipped | Redaction was skipped (not applied). |
| Failed | Redaction failed with exception. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Applied
```
public static final RedactionStatus Applied
```

Redaction was fully and successfully applied.

##### PartiallyApplied
```
public static final RedactionStatus PartiallyApplied
```

Redaction was aplied only to a part of its matches.

##### Skipped
```
public static final RedactionStatus Skipped
```

Redaction was skipped (not applied).

##### Failed
```
public static final RedactionStatus Failed
```

Redaction failed with exception.

##### values()
```
public static RedactionStatus[] values()
```

**Returns:**
com.groupdocs.redaction.RedactionStatus[]
##### valueOf(String name)
```
public static RedactionStatus valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
RedactionStatus

### Redactor
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactor.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable, com.groupdocs.redaction.integration.IPreviewable
```
public final class Redactor implements Closeable, IPreviewable
```

Represents a main class that controls document redaction process, allowing to open, redact and save documents.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
[Advanced usage]: https://docs.groupdocs.com/redaction/java/advanced-usage/
#### Constructors

| Constructor | Description |
| --- | --- |
| Redactor(String filePath) | Initializes a new instance of  Redactor  class using file path. |
| Redactor(InputStream document) | Initializes a new instance of  Redactor  class using stream. |
| Redactor(String filePath, LoadOptions loadOptions) | Initializes a new instance of  Redactor  class for a password-protected document using its path. |
| Redactor(String filePath, LoadOptions loadOptions, RedactorSettings settings) | Initializes a new instance of  Redactor  class for a password-protected document using its path and settings. |
| Redactor(InputStream document, LoadOptions loadOptions) | Initializes a new instance of  Redactor  class for a password-protected document using stream. |
| Redactor(InputStream document, LoadOptions loadOptions, RedactorSettings settings) | Initializes a new instance of  Redactor  class for a password-protected document using stream and settings. |
#### Methods

| Method | Description |
| --- | --- |
| close() | Releases resources. |
| apply(Redaction redaction) | Applies a redaction to the document. |
| apply(Redaction[] redactions) | Applies a set of redactions to the document. |
| apply(RedactionPolicy policy) | Applies a redaction policy to the document. |
| save() | Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true. |
| save(SaveOptions saveOptions) | Saves the document to a file. |
| save(OutputStream document) | Saves the document to a stream. |
| save(OutputStream document, RasterizationOptions rasterizationOptions) | Saves the document to a stream, including custom location. |
| generatePreview(PreviewOptions previewOptions) | Generates preview images of specific pages in a given image format. |
| getDocumentInfo() | Gets the general information about the document - size, page count, etc. |
##### Redactor(String filePath)
```
public Redactor(String filePath)
```

Initializes a new instance of  Redactor  class using file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to the file

The following example demonstrates how to open a document for redaction.

```

  try (Redactor redactor = new Redactor("C:\\sample.pdf"))
 {
     // Here we can use document instance to perform redactions
 }
 
``` |

### Redactor(InputStream document) {#Redactor-java.io.InputStream-}
```
public Redactor(InputStream document)
```


Initializes a new instance of  Redactor  class using stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Source stream of the document

The following example demonstrates how to open a document from stream.

```

  try (InputStream stream = new FileInputStream("C:\\sample.pdf"))
 {
     try (Redactor redactor = new Redactor(stream))
     {
         // Here we can use document instance to perform redactions
     }
 }

``` |

### Redactor(String filePath, LoadOptions loadOptions) {#Redactor-java.lang.String-com.groupdocs.redaction.options.LoadOptions-}
```
public Redactor(String filePath, LoadOptions loadOptions)
```


Initializes a new instance of  Redactor  class for a password-protected document using its path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to file. |
| loadOptions | [LoadOptions](../../com.groupdocs.redaction.options/loadoptions) | Options, including password. |

### Redactor(String filePath, LoadOptions loadOptions, RedactorSettings settings) {#Redactor-java.lang.String-com.groupdocs.redaction.options.LoadOptions-com.groupdocs.redaction.options.RedactorSettings-}
```
public Redactor(String filePath, LoadOptions loadOptions, RedactorSettings settings)
```


Initializes a new instance of  Redactor  class for a password-protected document using its path and settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Path to file. |
| loadOptions | [LoadOptions](../../com.groupdocs.redaction.options/loadoptions) | File-dependent options, including password. |
| settings | [RedactorSettings](../../com.groupdocs.redaction.options/redactorsettings) | Default settings for redaction process. |

### Redactor(InputStream document, LoadOptions loadOptions) {#Redactor-java.io.InputStream-com.groupdocs.redaction.options.LoadOptions-}
```
public Redactor(InputStream document, LoadOptions loadOptions)
```


Initializes a new instance of  Redactor  class for a password-protected document using stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Source input stream. |
| loadOptions | [LoadOptions](../../com.groupdocs.redaction.options/loadoptions) | Options, including password. |

### Redactor(InputStream document, LoadOptions loadOptions, RedactorSettings settings) {#Redactor-java.io.InputStream-com.groupdocs.redaction.options.LoadOptions-com.groupdocs.redaction.options.RedactorSettings-}
```
public Redactor(InputStream document, LoadOptions loadOptions, RedactorSettings settings)
```


Initializes a new instance of  Redactor  class for a password-protected document using stream and settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | Source input stream. |
| loadOptions | [LoadOptions](../../com.groupdocs.redaction.options/loadoptions) | Options, including password. |
| settings | [RedactorSettings](../../com.groupdocs.redaction.options/redactorsettings) | Default settings for redaction process. |

### close() {#close--}
```
public final void close()
```


Releases resources.

### apply(Redaction redaction) {#apply-com.groupdocs.redaction.Redaction-}
```
public final RedactorChangeLog apply(Redaction redaction)
```


Applies a redaction to the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redaction | [Redaction](../../com.groupdocs.redaction/redaction) | An instance of  Redaction  to apply |

**Returns:**
[RedactorChangeLog](../../com.groupdocs.redaction/redactorchangelog) - Success or failure and error message in this case
### apply(Redaction[] redactions) {#apply-com.groupdocs.redaction.Redaction---}
```
public final RedactorChangeLog apply(Redaction[] redactions)
```


Applies a set of redactions to the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redactions | [Redaction\[\]](../../com.groupdocs.redaction/redaction) | An array of redactions to apply |

**Returns:**
[RedactorChangeLog](../../com.groupdocs.redaction/redactorchangelog) - Success or failure and error message in this case
### apply(RedactionPolicy policy) {#apply-com.groupdocs.redaction.RedactionPolicy-}
```
public final RedactorChangeLog apply(RedactionPolicy policy)
```


Applies a redaction policy to the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| policy | [RedactionPolicy](../../com.groupdocs.redaction/redactionpolicy) | Redaction policy |

**Returns:**
[RedactorChangeLog](../../com.groupdocs.redaction/redactorchangelog) - Success or failure and error message in this case
### save() {#save--}
```
public final String save()
```


Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.

**Returns:**
java.lang.String - Path to redacted document
### save(SaveOptions saveOptions) {#save-com.groupdocs.redaction.options.SaveOptions-}
```
public final String save(SaveOptions saveOptions)
```


Saves the document to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | [SaveOptions](../../com.groupdocs.redaction.options/saveoptions) | Options to add suffix or rasterize |

**Returns:**
java.lang.String - Path to redacted document
### save(OutputStream document) {#save-java.io.OutputStream-}
```
public final void save(OutputStream document)
```


Saves the document to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | Target stream |

### save(OutputStream document, RasterizationOptions rasterizationOptions) {#save-java.io.OutputStream-com.groupdocs.redaction.options.RasterizationOptions-}
```
public final void save(OutputStream document, RasterizationOptions rasterizationOptions)
```


Saves the document to a stream, including custom location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | Target stream |
| rasterizationOptions | [RasterizationOptions](../../com.groupdocs.redaction.options/rasterizationoptions) | Options to rasterize or not and to specify pages for rasterization |

### generatePreview(PreviewOptions previewOptions) {#generatePreview-com.groupdocs.redaction.options.PreviewOptions-}
```
public final void generatePreview(PreviewOptions previewOptions)
```


Generates preview images of specific pages in a given image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | [PreviewOptions](../../com.groupdocs.redaction.options/previewoptions) | Image properties and page range settings |

### getDocumentInfo() {#getDocumentInfo--}
```
public final IDocumentInfo getDocumentInfo()
```


Gets the general information about the document - size, page count, etc.

**Returns:**
[IDocumentInfo](../../com.groupdocs.redaction/idocumentinfo) - An instance of IDocumentInfo

### RedactorChangeLog
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactorchangelog.md

**Inheritance:**
java.lang.Object
```
public class RedactorChangeLog
```

Represents results for a list of redactions, passed to Apply() method of  Redactor  class.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactorChangeLog() | Initializes a new instance of RedactorChangeLog class. |
#### Methods

| Method | Description |
| --- | --- |
| getStatus() | Gets the final status of all applied redactions. |
| getRedactionLog() | Gets the list of  RedactorLogEntry  instances. |
##### RedactorChangeLog()
```
public RedactorChangeLog()
```

Initializes a new instance of RedactorChangeLog class.

##### getStatus()
```
public final RedactionStatus getStatus()
```

Gets the final status of all applied redactions.

**Returns:**
RedactionStatus - The final status of all applied redactions.
##### getRedactionLog()
```
public final List<RedactorLogEntry> getRedactionLog()
```

Gets the list of  RedactorLogEntry  instances.

**Returns:**
java.util.List<com.groupdocs.redaction.RedactorLogEntry> - The list of  RedactorLogEntry  instances.

### RedactorLogEntry
Path: https://reference.groupdocs.com/redaction/java/com.groupdocs.redaction/redactorlogentry.md

**Inheritance:**
java.lang.Object
```
public class RedactorLogEntry
```

Represents results of applying redaction.

[Redaction basics]: https://docs.groupdocs.com/redaction/java/redaction-basics/
#### Constructors

| Constructor | Description |
| --- | --- |
| RedactorLogEntry(Redaction redaction, RedactionResult result) | Initializes a new instance of RedactorLogEntry class for redaction. |
#### Methods

| Method | Description |
| --- | --- |
| getResult() | Gets the result, returned by  GroupDocs.Redaction.Integration.DocumentFormatInstance . |
| getRedaction() | Gets the reference to redaction and its options. |
##### RedactorLogEntry(Redaction redaction, RedactionResult result)
```
public RedactorLogEntry(Redaction redaction, RedactionResult result)
```

Initializes a new instance of RedactorLogEntry class for redaction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| redaction | Redaction | Reference to redaction |
| result | RedactionResult | Redaction result, reported by format handler |

##### getResult()
```
public final RedactionResult getResult()
```

Gets the result, returned by  GroupDocs.Redaction.Integration.DocumentFormatInstance .

**Returns:**
RedactionResult - The result, returned by  GroupDocs.Redaction.Integration.DocumentFormatInstance .
##### getRedaction()
```
public final Redaction getRedaction()
```

Gets the reference to redaction and its options.

**Returns:**
Redaction - The reference to redaction and its options.

## .NET

### GroupDocs.Redaction for .NET
Path: https://reference.groupdocs.com/redaction/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Redaction | The Redaction namespace provides classes for redacting sensitive information from documents in PDF, raster image and office document formats. The main classes in this namespace are: |
| GroupDocs.Redaction.Configuration | The Configuration namespace provides document format configuration classes. |
| GroupDocs.Redaction.Exceptions | The Exceptions namespace provides different exceptions classes. |
| GroupDocs.Redaction.Integration | The Integration namespace provides interfaces and classes, used to integrate documents of different formats with GroupDocs.Redaction. |
| GroupDocs.Redaction.Integration.Ocr | The Ocr namespace provides interfaces and classes, required for Optical Character Recognition (OCR) support. |
| GroupDocs.Redaction.Options | The Options namespace provides load and save options classes. |
| GroupDocs.Redaction.Redactions | The Redactions namespace provides classes for different types of redactions. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### GroupDocs.Redaction.Configuration
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration.md

The Configuration namespace provides document format configuration classes.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatConfiguration | Represents a type reference for `DocumentFormatInstance`-derived class and supported file extensions list for faster format detection. |
| RedactorConfiguration | Provides access to a list of supported formats, built-in and custom user formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### DocumentFormatConfiguration
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration.md

#### DocumentFormatConfiguration class

Represents a type reference for `DocumentFormatInstance`-derived class and supported file extensions list for faster format detection.

```csharp
public class DocumentFormatConfiguration
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentFormatConfiguration() | Initializes a new instance of DocumentFormatConfiguration class. |

#### Properties

| Name | Description |
| --- | --- |
| DocumentType { get; set; } | Gets or sets the type of a class, inheriting from `DocumentFormatInstance`. |
| ExtensionFilter { get; set; } | Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive. |
| InitializationData { get; set; } | Gets or sets data, required for `DocumentFormatInstance` initialization. |

#### Methods

| Name | Description |
| --- | --- |
| SupportsExtension(string) | Checks if a given file extension can be handled as DocumentType. |

##### Examples

The following example demonstrates how to set properties for a custom format configuration.

```csharp
var adobePhotoshopSettings = new DocumentFormatConfiguration();
adobePhotoshopSettings.ExtensionFilter = ".psd";
adobePhotoshopSettings.DocumentType = typeof(MyAdobePhotoshopFormatInstance);
```

### DocumentFormatConfiguration
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration/documentformatconfiguration.md

#### DocumentFormatConfiguration constructor

Initializes a new instance of DocumentFormatConfiguration class.

```csharp
public DocumentFormatConfiguration()
```

### DocumentType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration/documenttype.md

#### DocumentFormatConfiguration.DocumentType property

Gets or sets the type of a class, inheriting from `DocumentFormatInstance`.

```csharp
public Type DocumentType { get; set; }
```

### ExtensionFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration/extensionfilter.md

#### DocumentFormatConfiguration.ExtensionFilter property

Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.

```csharp
public string ExtensionFilter { get; set; }
```

### InitializationData
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration/initializationdata.md

#### DocumentFormatConfiguration.InitializationData property

Gets or sets data, required for `DocumentFormatInstance` initialization.

```csharp
public Dictionary<string, string> InitializationData { get; set; }
```

### SupportsExtension
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/documentformatconfiguration/supportsextension.md

#### DocumentFormatConfiguration.SupportsExtension method

Checks if a given file extension can be handled as DocumentType.

```csharp
public bool SupportsExtension(string fileExtension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | String | File extension, format is ".ext" |

##### Return Value

True if the extension is listed in ExtensionFilter

### RedactorConfiguration
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/redactorconfiguration.md

#### RedactorConfiguration class

Provides access to a list of supported formats, built-in and custom user formats.

```csharp
public class RedactorConfiguration
```

#### Properties

| Name | Description |
| --- | --- |
| AvailableFormats { get; } | Gets a list of recognized formats, see `DocumentFormatConfiguration`. |

#### Methods

| Name | Description |
| --- | --- |
| static GetInstance() | Provides a singleton instance with default configuration of built-in formats. |
| FindFormat(string) | Finds format configurations for a given file extension. |

##### Examples

The following example demonstrates how to add a custom user format handler.

```csharp
var adobePhotoshopSettings = new DocumentFormatConfiguration();
adobePhotoshopSettings.ExtensionFilter = ".psd";
adobePhotoshopSettings.DocumentType = typeof(MyAdobePhotoshopFormatInstance);
var configuration = RedactorConfiguration.GetInstance();
configuration.AvailableFormats.Add(adobePhotoshopSettings);
```

The following example demonstrates how to get built-in or custom user format handlers.

```csharp
var configuration = RedactorConfiguration.GetInstance();
var formatSettings = configuration.FindFormat(".psd");
```

### AvailableFormats
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/redactorconfiguration/availableformats.md

#### RedactorConfiguration.AvailableFormats property

Gets a list of recognized formats, see `DocumentFormatConfiguration`.

```csharp
public List<DocumentFormatConfiguration> AvailableFormats { get; }
```

### FindFormat
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/redactorconfiguration/findformat.md

#### RedactorConfiguration.FindFormat method

Finds format configurations for a given file extension.

```csharp
public DocumentFormatConfiguration FindFormat(string fileExtension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileExtension | String | File extension, format is ".ext" |

##### Return Value

If found, instance of `DocumentFormatConfiguration`, null otherwise

##### Examples

The following example demonstrates how to get built-in or custom user format handlers.

```csharp
var configuration = RedactorConfiguration.GetInstance();
var formatSettings = configuration.FindFormat(".psd");
```

### GetInstance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.configuration/redactorconfiguration/getinstance.md

#### RedactorConfiguration.GetInstance method

Provides a singleton instance with default configuration of built-in formats.

```csharp
public static RedactorConfiguration GetInstance()
```

##### Return Value

Configuration instance

##### Examples

The following example demonstrates how to add a custom format handler.

```csharp
var adobePhotoshopSettings = new DocumentFormatConfiguration();
adobePhotoshopSettings.ExtensionFilter = ".psd";
adobePhotoshopSettings.DocumentType = typeof(MyAdobePhotoshopFormatInstance);
var configuration = RedactorConfiguration.GetInstance();
configuration.AvailableFormats.Add(adobePhotoshopSettings);
```

### GroupDocs.Redaction.Exceptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions.md

The Exceptions namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatException | The exception that is thrown when document format is not recognized or is invalid. |
| GroupDocsRedactionException | Represents base exception for all GroupDocs.Redaction exceptions. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |
| TrialLimitationsException | The exception that is thrown when user violates trial mode limitations. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### DocumentFormatException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/documentformatexception.md

#### DocumentFormatException class

The exception that is thrown when document format is not recognized or is invalid.

```csharp
public class DocumentFormatException : GroupDocsRedactionException
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentFormatException(string) | Initializes a new instance of DocumentFormatException class. |
| DocumentFormatException(string, Exception) | Initializes a new instance of DocumentFormatException class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### DocumentFormatException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/documentformatexception/documentformatexception.md

#### DocumentFormatException(string)

Initializes a new instance of DocumentFormatException class.

```csharp
public DocumentFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |

#### DocumentFormatException(string, Exception)

Initializes a new instance of DocumentFormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public DocumentFormatException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |
| innerException | Exception | Inner exception |

### GroupDocsRedactionException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/groupdocsredactionexception.md

#### GroupDocsRedactionException class

Represents base exception for all GroupDocs.Redaction exceptions.

```csharp
public class GroupDocsRedactionException : ApplicationException
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsRedactionException(string) | Initializes a new instance of GroupDocsRedactionException class. |
| GroupDocsRedactionException(string, Exception) | Initializes a new instance of GroupDocsRedactionException class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### GroupDocsRedactionException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/groupdocsredactionexception/groupdocsredactionexception.md

#### GroupDocsRedactionException(string)

Initializes a new instance of GroupDocsRedactionException class.

```csharp
public GroupDocsRedactionException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |

#### GroupDocsRedactionException(string, Exception)

Initializes a new instance of GroupDocsRedactionException class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public GroupDocsRedactionException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |
| innerException | Exception | Inner exception |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public class IncorrectPasswordException : GroupDocsRedactionException
```

#### Constructors

| Name | Description |
| --- | --- |
| IncorrectPasswordException() | Initializes a new instance of IncorrectPasswordException class. |
| IncorrectPasswordException(string, Exception) | Initializes a new instance of IncorrectPasswordException class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/incorrectpasswordexception/incorrectpasswordexception.md

#### IncorrectPasswordException()

Initializes a new instance of IncorrectPasswordException class.

```csharp
public IncorrectPasswordException()
```

#### IncorrectPasswordException(string, Exception)

Initializes a new instance of IncorrectPasswordException class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public IncorrectPasswordException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |
| innerException | Exception | Inner exception |

### PasswordRequiredException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

```csharp
public class PasswordRequiredException : GroupDocsRedactionException
```

#### Constructors

| Name | Description |
| --- | --- |
| PasswordRequiredException() | Initializes a new instance of PasswordRequiredException class. |
| PasswordRequiredException(string, Exception) | Initializes a new instance of PasswordRequiredException class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### PasswordRequiredException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/passwordrequiredexception/passwordrequiredexception.md

#### PasswordRequiredException()

Initializes a new instance of PasswordRequiredException class.

```csharp
public PasswordRequiredException()
```

#### PasswordRequiredException(string, Exception)

Initializes a new instance of PasswordRequiredException class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public PasswordRequiredException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |
| innerException | Exception | Inner exception |

### TrialLimitationsException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/triallimitationsexception.md

#### TrialLimitationsException class

The exception that is thrown when user violates trial mode limitations.

```csharp
public class TrialLimitationsException : GroupDocsRedactionException
```

#### Constructors

| Name | Description |
| --- | --- |
| TrialLimitationsException(string) | Initializes a new instance of TrialLimitationsException class. |
| TrialLimitationsException(string, Exception) | Initializes a new instance of TrialLimitationsException class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### TrialLimitationsException
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.exceptions/triallimitationsexception/triallimitationsexception.md

#### TrialLimitationsException(string)

Initializes a new instance of TrialLimitationsException class.

```csharp
public TrialLimitationsException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing violated limitation |

#### TrialLimitationsException(string, Exception)

Initializes a new instance of TrialLimitationsException class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public TrialLimitationsException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Message, describing exception context |
| innerException | Exception | Inner exception |

### GroupDocs.Redaction.Integration.Ocr
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr.md

The Ocr 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 a line of text, extracted by OCR engine from an image. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IOcrConnector | Defines methods that are required to apply textual redactions to image documents and embedded images. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### IOcrConnector
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr/iocrconnector.md

#### IOcrConnector interface

Defines methods that are required to apply textual redactions 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/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.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. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Gets textual equivalent of the structured text. |

### Lines
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.integration.ocr/recognizedimage/text.md

#### RecognizedImage.Text property

Gets textual equivalent of the structured text.

```csharp
public string Text { get; }
```

### ToString
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr/recognizedimage/tostring.md

#### RecognizedImage.ToString method

Gets textual equivalent of the structured text.

```csharp
public override string ToString()
```

##### Return Value

Recognized text

### TextFragment
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.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. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns textual content of the recognized text fragment. |

### Rectangle
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.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 |

### ToString
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr/textfragment/tostring.md

#### TextFragment.ToString method

Returns textual content of the recognized text fragment.

```csharp
public override string ToString()
```

##### Return Value

textual content of the recognized text fragment

### TextLine
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr/textline.md

#### TextLine class

Represents a line of text, extracted by OCR engine from an image.

```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. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns textual content of the recognized line of text. |

### Fragments
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.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/redaction/net/groupdocs.redaction.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 |

### ToString
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.ocr/textline/tostring.md

#### TextLine.ToString method

Returns textual content of the recognized line of text.

```csharp
public override string ToString()
```

##### Return Value

textual content of the recognized line of text

### GroupDocs.Redaction.Integration
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration.md

The Integration namespace provides interfaces and classes, used to integrate documents of different formats with GroupDocs.Redaction.

#### Classes

| Class | Description |
| --- | --- |
| DocumentFormatInstance | Represents a specific format of a document. Implement this class to add your own document types. |
| MetadataCollection | Represents a dictionary of `MetadataItem` with its title as a key. |
| MetadataItem | Represents an item of metadata, common for all supported formats and used in metadata redactions. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IAnnotatedDocument | Defines methods that are required for access to annotations, such as comments. Needs to be implemented by `DocumentFormatInstance`-derived class to perform annotation redactions. |
| ICellularFormatInstance | Defines methods that are required for access to spreadsheet formats, having one or many worksheets. |
| IFixedFormatDocument | Defines methods that are required for access formats of fixed structure, such as PDF or presentations. |
| IImageFormatInstance | Defines methods that are required for raster image format redactions. |
| IMetadataAccess | Defines methods that are required for access to metadata of a document, if format supports it. |
| IPaginatedDocument | Defines methods that are required to manipulate a document's pages. Needs to be implemented by `DocumentFormatInstance`-derived class to perform page redactions. |
| IPreviewable | Defines methods to create preview of the document. |
| IRasterizableDocument | Defines methods that are required for saving document in any binary form. Built-in types save a document as a PDF with images of its pages. |
| ITextualFormatInstance | Defines methods that are required for redacting textual data in any document, containing text. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### DocumentFormatInstance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance.md

#### DocumentFormatInstance class

Represents a specific format of a document. Implement this class to add your own document types.

```csharp
public abstract class DocumentFormatInstance
```

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Gets or sets a password for password protected documents. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Initialize(DocumentFormatConfiguration, RedactorSettings) | Performs initialization of the instance of document format handler. |
| IsRedactionAccepted(RedactionDescription) | Checks for `IRedactionCallback` implementation and invokes it, if specified. |
| virtual Load(Stream) | Loads the document from a stream. |
| virtual PerformBinaryCheck(Stream) | Checks if the given stream contains a document, supported by this format instance. |
| abstract Save(Stream) | Saves the document to a stream. |

##### Examples

The following example demonstrates how to create an empty stub for a custom format handler.

```csharp
public class DummyDocument : DocumentFormatInstance
{     
    public override void Load(Stream output)
    {
        // load file content
    }

    public override void Save(Stream output)
    {
        // save changes to file;
    }
}
```

The following example demonstrates how to use the initialization data.

```csharp
public class MyCustomHandler : DocumentFormatInstance
{
    private string MyProperty { get; set; }
    
    // Other custom code 
    ...

    public override void Initialize(DocumentFormatConfiguration config)
    {
        base.Initialize(config);
        if (config.InitializationData.ContainsKey("MyProperty"))
        {
            MyProperty = config.InitializationData["MyProperty"];
        }
    }
}

// Plugging custom format into GroupDocs.Redaction
var mySettings = new DocumentFormatConfiguration();
mySettings.ExtensionFilter = ".foo";
mySettings.DocumentType = typeof(MyCustomHandler);
mySettings.InitializationData.Add("MyProperty", "bar");
var configuration = RedactorConfiguration.GetInstance();
configuration.AvailableFormats.Add(mySettings);
```

### Initialize
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/initialize.md

#### DocumentFormatInstance.Initialize method

Performs initialization of the instance of document format handler.

```csharp
public virtual void Initialize(DocumentFormatConfiguration config, RedactorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| config | DocumentFormatConfiguration | Format configuration |
| settings | RedactorSettings | Default settings for redaction process. |

##### Examples

The following example demonstrates how to use the initialization data.

```csharp
public class MyCustomHandler : DocumentFormatInstance
{
    private string MyProperty { get; set; }
    
    // Other custom code 
    ...

    public override void Initialize(DocumentFormatConfiguration config)
    {
        base.Initialize(config);
        if (config.InitializationData.ContainsKey("MyProperty"))
        {
            MyProperty = config.InitializationData["MyProperty"];
        }
    }
}

// Plugging custom format into GroupDocs.Redaction
var mySettings = new DocumentFormatConfiguration();
mySettings.ExtensionFilter = ".foo";
mySettings.DocumentType = typeof(MyCustomHandler);
mySettings.InitializationData.Add("MyProperty", "bar");
var configuration = RedactorConfiguration.GetInstance();
configuration.AvailableFormats.Add(mySettings);
```

### IsRedactionAccepted
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/isredactionaccepted.md

#### DocumentFormatInstance.IsRedactionAccepted method

Checks for `IRedactionCallback` implementation and invokes it, if specified.

```csharp
public bool IsRedactionAccepted(RedactionDescription description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | RedactionDescription | Redaction description |

##### Return Value

True (by default) if redaction is accepted

### Load
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/load.md

#### DocumentFormatInstance.Load method

Loads the document from a stream.

```csharp
public virtual void Load(Stream input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | Stream | Stream to read from |

### Password
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/password.md

#### DocumentFormatInstance.Password property

Gets or sets a password for password protected documents.

```csharp
public string Password { get; set; }
```

### PerformBinaryCheck
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/performbinarycheck.md

#### DocumentFormatInstance.PerformBinaryCheck method

Checks if the given stream contains a document, supported by this format instance.

```csharp
public virtual bool PerformBinaryCheck(Stream input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | Stream | Document content stream |

##### Return Value

True, if the document can be loaded by this format instance and false otherwise

### Save
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/documentformatinstance/save.md

#### DocumentFormatInstance.Save method

Saves the document to a stream.

```csharp
public abstract void Save(Stream output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | Stream | Target stream to save the document |

### IAnnotatedDocument
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/iannotateddocument.md

#### IAnnotatedDocument interface

Defines methods that are required for access to annotations, such as comments. Needs to be implemented by `DocumentFormatInstance`-derived class to perform annotation redactions.

```csharp
public interface IAnnotatedDocument
```

#### Methods

| Name | Description |
| --- | --- |
| DeleteAnnotations(Regex) | Deletes all annotations, matching regular expression within the document. |
| RedactAnnotation(Regex, string) | Replaces the matching text in all annotations within the document. |

### DeleteAnnotations
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/iannotateddocument/deleteannotations.md

#### IAnnotatedDocument.DeleteAnnotations method

Deletes all annotations, matching regular expression within the document.

```csharp
public RedactionResult DeleteAnnotations(Regex regularExpression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to match |

##### Return Value

Deletion result

### RedactAnnotation
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/iannotateddocument/redactannotation.md

#### IAnnotatedDocument.RedactAnnotation method

Replaces the matching text in all annotations within the document.

```csharp
public RedactionResult RedactAnnotation(Regex regularExpression, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to search and replace |
| replacement | String | Textual replacement |

##### Return Value

Replacement result

### ICellularFormatInstance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/icellularformatinstance.md

#### ICellularFormatInstance interface

Defines methods that are required for access to spreadsheet formats, having one or many worksheets.

```csharp
public interface ICellularFormatInstance
```

#### Methods

| Name | Description |
| --- | --- |
| GetSheetIndex(string) | Gets the worksheet index by worksheet name, if possible. |
| ReplaceInColumn(Regex, string, int) | Replaces all matches with a given replacement in the specified column on all worksheets. |
| ReplaceInColumn(Regex, string, int, int) | Replaces all matches with a given replacement in the specified column and worksheet. |

### GetSheetIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/icellularformatinstance/getsheetindex.md

#### ICellularFormatInstance.GetSheetIndex method

Gets the worksheet index by worksheet name, if possible.

```csharp
public int GetSheetIndex(string sheetName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sheetName | String | Worksheet name |

##### Return Value

Worksheet index or -1 if not found

### ReplaceInColumn
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/icellularformatinstance/replaceincolumn.md

#### ReplaceInColumn(Regex, string, int, int)

Replaces all matches with a given replacement in the specified column and worksheet.

```csharp
public RedactionResult ReplaceInColumn(Regex regularExpression, string replacement, int column, 
    int sheet)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to search and replace |
| replacement | String | Textual replacement |
| column | Int32 | Zero-based column index |
| sheet | Int32 | Zero-based worksheet index |

##### Return Value

Replacement result

#### ReplaceInColumn(Regex, string, int)

Replaces all matches with a given replacement in the specified column on all worksheets.

```csharp
public RedactionResult ReplaceInColumn(Regex regularExpression, string replacement, int column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to search and replace |
| replacement | String | Textual replacement |
| column | Int32 | Zero-based column index |

##### Return Value

Replacement result

### IFixedFormatDocument
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ifixedformatdocument.md

#### IFixedFormatDocument interface

Defines methods that are required for access formats of fixed structure, such as PDF or presentations.

```csharp
public interface IFixedFormatDocument
```

#### Methods

| Name | Description |
| --- | --- |
| LoadImages(RedactionFilter[]) | Loads an array of raster image instances, contained within the document, matching `RedactionFilter` set. |
| RedactAnnotation(Regex, ReplacementOptions) | Replaces the matching text in all annotations within the document with given options. |

### LoadImages
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ifixedformatdocument/loadimages.md

#### IFixedFormatDocument.LoadImages method

Loads an array of raster image instances, contained within the document, matching `RedactionFilter` set.

```csharp
public IImageFormatInstance[] LoadImages(RedactionFilter[] filters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filters | RedactionFilter[] | An array of RedactionFilter instances to apply |

##### Return Value

An array of raster image instances

### RedactAnnotation
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ifixedformatdocument/redactannotation.md

#### IFixedFormatDocument.RedactAnnotation method

Replaces the matching text in all annotations within the document with given options.

```csharp
public RedactionResult RedactAnnotation(Regex regularExpression, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options |

##### Return Value

Replacement result

### IImageFormatInstance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/iimageformatinstance.md

#### IImageFormatInstance interface

Defines methods that are required for raster image format redactions.

```csharp
public interface IImageFormatInstance
```

#### Methods

| Name | Description |
| --- | --- |
| EditArea(Point, RegionReplacementOptions) | Replaces the area at given point with a rectangle of specific color and size. |

### EditArea
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/iimageformatinstance/editarea.md

#### IImageFormatInstance.EditArea method

Replaces the area at given point with a rectangle of specific color and size.

```csharp
public RedactionResult EditArea(Point topLeft, RegionReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | Point | Top-left corner coordinates of filled area |
| options | RegionReplacementOptions | Color and size settings |

##### Return Value

Image area redaction result

### IMetadataAccess
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/imetadataaccess.md

#### IMetadataAccess interface

Defines methods that are required for access to metadata of a document, if format supports it.

```csharp
public interface IMetadataAccess
```

#### Methods

| Name | Description |
| --- | --- |
| ChangeMetadata(MetadataItem) | Changes the specified item of metadata from `MetadataCollection` or adds a new one, if not present. |
| GetMetadata() | Retrieves a dictionary with document's metadata. |

### ChangeMetadata
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/imetadataaccess/changemetadata.md

#### IMetadataAccess.ChangeMetadata method

Changes the specified item of metadata from `MetadataCollection` or adds a new one, if not present.

```csharp
public RedactionResult ChangeMetadata(MetadataItem metadataItem)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadataItem | MetadataItem | Metadata item with a new value assigned to it |

##### Return Value

Metadata redaction result

### GetMetadata
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/imetadataaccess/getmetadata.md

#### IMetadataAccess.GetMetadata method

Retrieves a dictionary with document's metadata.

```csharp
public MetadataCollection GetMetadata()
```

##### Return Value

Plain dictionary with metadata

### IPaginatedDocument
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ipaginateddocument.md

#### IPaginatedDocument interface

Defines methods that are required to manipulate a document's pages. Needs to be implemented by `DocumentFormatInstance`-derived class to perform page redactions.

```csharp
public interface IPaginatedDocument
```

#### Methods

| Name | Description |
| --- | --- |
| RemovePages(PageSeekOrigin, int, int) | Removes one or multiple pages depending on its start position, offset and count. |

### RemovePages
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ipaginateddocument/removepages.md

#### IPaginatedDocument.RemovePages method

Removes one or multiple pages depending on its start position, offset and count.

```csharp
public RedactionResult RemovePages(PageSeekOrigin origin, int index, int count)
```

| Parameter | Type | Description |
| --- | --- | --- |
| origin | PageSeekOrigin | Search origin position, the beginning or the end of the document |
| index | Int32 | Start position index (0-based) |
| count | Int32 | Count of pages to remove |

##### Return Value

Pages removal redaction result

### IPreviewable
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ipreviewable.md

#### IPreviewable interface

Defines methods to create preview of the document.

```csharp
public interface IPreviewable
```

#### Methods

| Name | Description |
| --- | --- |
| GeneratePreview(PreviewOptions) | Generates preview images of specific pages in a given image format. |
| GetDocumentInfo() | Gets the general information about the document - size, page count, etc. |

### GeneratePreview
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ipreviewable/generatepreview.md

#### IPreviewable.GeneratePreview method

Generates preview images of specific pages in a given image format.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | Image properties and page range settings |

### GetDocumentInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/ipreviewable/getdocumentinfo.md

#### IPreviewable.GetDocumentInfo method

Gets the general information about the document - size, page count, etc.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

An instance of IDocumentInfo

### IRasterizableDocument
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/irasterizabledocument.md

#### IRasterizableDocument interface

Defines methods that are required for saving document in any binary form. Built-in types save a document as a PDF with images of its pages.

```csharp
public interface IRasterizableDocument
```

#### Methods

| Name | Description |
| --- | --- |
| Rasterize(Stream) | Saves the document to a stream as a PDF. |
| Rasterize(Stream, RasterizationOptions) | Saves the document to a stream as a PDF with page range and compliance options. |

### Rasterize
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/irasterizabledocument/rasterize.md

#### Rasterize(Stream)

Saves the document to a stream as a PDF.

```csharp
public void Rasterize(Stream output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | Stream | Target stream |

#### Rasterize(Stream, RasterizationOptions)

Saves the document to a stream as a PDF with page range and compliance options.

```csharp
public void Rasterize(Stream output, RasterizationOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | Stream | Target stream |
| options | RasterizationOptions | PDF conversion options |

### ITextualFormatInstance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/itextualformatinstance.md

#### ITextualFormatInstance interface

Defines methods that are required for redacting textual data in any document, containing text.

```csharp
public interface ITextualFormatInstance
```

#### Methods

| Name | Description |
| --- | --- |
| ReplaceText(Regex, ReplacementOptions) | Replaces all matches of the regular expression with a given replacement. |

### ReplaceText
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/itextualformatinstance/replacetext.md

#### ITextualFormatInstance.ReplaceText method

Replaces all matches of the regular expression with a given replacement.

```csharp
public RedactionResult ReplaceText(Regex regularExpression, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regularExpression | Regex | Regular expression to search and replace |
| options | ReplacementOptions | `ReplacementOptions` allow to set textual replacement or color for redaction block |

##### Return Value

Text replacement result

### MetadataCollection
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadatacollection.md

#### MetadataCollection class

Represents a dictionary of `MetadataItem` with its title as a key.

```csharp
public class MetadataCollection : Dictionary<string, MetadataItem>
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataCollection() | Initializes a new instance of MetadataCollection class. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(MetadataCollection) | Adds a specified collection of MetadataItem objects to this instance. |

### AddRange
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadatacollection/addrange.md

#### MetadataCollection.AddRange method

Adds a specified collection of MetadataItem objects to this instance.

```csharp
public void AddRange(MetadataCollection items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| items | MetadataCollection | A collection of MetadataItem instances |

### MetadataCollection
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadatacollection/metadatacollection.md

#### MetadataCollection constructor

Initializes a new instance of MetadataCollection class.

```csharp
public MetadataCollection()
```

### MetadataItem
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem.md

#### MetadataItem class

Represents an item of metadata, common for all supported formats and used in metadata redactions.

```csharp
public class MetadataItem : ISerializable
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataItem() | Initializes a new instance. |

#### Properties

| Name | Description |
| --- | --- |
| ActualValue { get; } | Gets the string representation of the metadata item value. |
| Category { get; set; } | Gets or sets a category of the metadata item, for example resource ID for an embedded resource metadata item. |
| virtual DictionaryKey { get; } | Gets a dictionary key for `MetadataCollection`, using its OriginalName and other data. |
| Filter { get; set; } | Gets or sets a value of `MetadataFilters`, assigned to this metadata item which is used in item filtration. |
| IsCustom { get; set; } | Gets or sets a value indicating whether this item is custom (added by the authors of the document). |
| OriginalName { get; set; } | Gets or sets an original name of the metadata item, as it appears in the document. |
| Values { get; set; } | Gets or sets the metadata item value. |

#### Methods

| Name | Description |
| --- | --- |
| virtual CreateClone() | Creates a deep clone of current instance. |
| virtual GetObjectData(SerializationInfo, StreamingContext) | Returns information about serializable properties. |

### ActualValue
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/actualvalue.md

#### MetadataItem.ActualValue property

Gets the string representation of the metadata item value.

```csharp
public string ActualValue { get; }
```

### Category
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/category.md

#### MetadataItem.Category property

Gets or sets a category of the metadata item, for example resource ID for an embedded resource metadata item.

```csharp
public string Category { get; set; }
```

### CreateClone
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/createclone.md

#### MetadataItem.CreateClone method

Creates a deep clone of current instance.

```csharp
public virtual MetadataItem CreateClone()
```

##### Return Value

Object clone

### DictionaryKey
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/dictionarykey.md

#### MetadataItem.DictionaryKey property

Gets a dictionary key for `MetadataCollection`, using its OriginalName and other data.

```csharp
public virtual string DictionaryKey { get; }
```

### Filter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/filter.md

#### MetadataItem.Filter property

Gets or sets a value of `MetadataFilters`, assigned to this metadata item which is used in item filtration.

```csharp
public MetadataFilters Filter { get; set; }
```

### GetObjectData
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/getobjectdata.md

#### MetadataItem.GetObjectData method

Returns information about serializable properties.

```csharp
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The object that holds the serialized object data |
| context | StreamingContext | The contextual information about the source or destination |

### IsCustom
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/iscustom.md

#### MetadataItem.IsCustom property

Gets or sets a value indicating whether this item is custom (added by the authors of the document).

```csharp
public bool IsCustom { get; set; }
```

### MetadataItem
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/metadataitem.md

#### MetadataItem constructor

Initializes a new instance.

```csharp
public MetadataItem()
```

### OriginalName
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/originalname.md

#### MetadataItem.OriginalName property

Gets or sets an original name of the metadata item, as it appears in the document.

```csharp
public string OriginalName { get; set; }
```

### Values
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.integration/metadataitem/values.md

#### MetadataItem.Values property

Gets or sets the metadata item value.

```csharp
public List<string> Values { get; set; }
```

### GroupDocs.Redaction.Options
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options.md

The Options namespace provides load and save options classes.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Represents method that returns a stream to write page preview data. |
| LoadOptions | Provides options that will be used to open a file. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| RasterizationOptions | Provides options for converting files into PDF. |
| RedactorSettings | Represents redaction settings, allowing to customize the redaction process. |
| ReleasePageStream | Represents a method which releases stream created by `CreatePageStream` delegate. |
| SaveOptions | Provides options for changing an output file name and/or converting the document to image-based PDF (rasterization). |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines interface of a logger that can be used for logging events and errors in process of redaction. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| AdvancedRasterizationOptions | Flags enumeration to manage the advanced rasterization options to be applied. |
| PdfComplianceLevel | Represents a list of supported PDF compliance levels. |
| PreviewOptions.PreviewFormats | Represents supported preview formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### AdvancedRasterizationOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/advancedrasterizationoptions.md

#### AdvancedRasterizationOptions enumeration

Flags enumeration to manage the advanced rasterization options to be applied.

```csharp
public enum AdvancedRasterizationOptions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No advanced options to apply. |
| Tilt | `1` | Tilt to incline the rasterized image to a random angle. |
| Noise | `2` | Add random spots to rasterized page images. |
| Border | `4` | Add border line to imitate page scan effect. |
| Grayscale | `8` | Make page images grayscale to imitate grayscale scan. |

##### Examples

The following example demonstrates how to apply the advanced rasterization options with default settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with default options (convert pages into images, save as PDF)
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Grayscale);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt);
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the border advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with a custom border
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border, new Dictionary<string, string>() { { "border", "10" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the noise advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom number and size of noise effects
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise, 
          new Dictionary<string, string>() { { "maxSpots", "150" }, { "spotMaxSize", "15" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the tilt advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom tilt effect
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt, 
          new Dictionary<string, string>() { { { "minAngle", "85" }, { "randomAngleMax", "5" } });
      redactor.Save(so);
    }
```

### CreatePageStream
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/createpagestream.md

#### CreatePageStream delegate

Represents method that returns a stream to write page preview data.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Page number of a page to generate thumbnail |

##### Return Value

Stream to write page preview

##### Examples

The following example demonstrates how get a document preview using `PreviewOptions` and `CreatePageStream` delegate.

```csharp
    CreatePageStream createDelegate = delegate (int pageNumber)
    {
        var pagePath = System.IO.Path.Combine(@"C:\Temp", string.Format("page_{0}.png", pageNumber));
        return System.IO.File.Create(pagePath);
    };
    var previewOptions = new PreviewOptions(createDelegate);
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.Height = 640;
    previewOptions.Width = 480;
    previewOptions.PageNumbers = new int[] { 1 };
    using (var redactor = new Redactor("C:\Temp\SourceFile.pdf"))
    {
        redactor.GeneratePreview(previewOptions);
    }
```

### ILogger
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/ilogger.md

#### ILogger interface

Defines interface of a logger that can be used for logging events and errors in process of redaction.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string) | Logs an error that occurred during redaction process. |
| Trace(string) | Logs an event that occurred during redaction process. |
| Warning(string) | Logs a warning that occurred during redaction process. |

### Error
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/ilogger/error.md

#### ILogger.Error method

Logs an error that occurred during redaction process.

```csharp
public void Error(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |

### Trace
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/ilogger/trace.md

#### ILogger.Trace method

Logs an event that occurred during redaction process.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The event message. |

### Warning
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/ilogger/warning.md

#### ILogger.Warning method

Logs a warning that occurred during redaction process.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

### LoadOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/loadoptions.md

#### LoadOptions class

Provides options that will be used to open a file.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of LoadOptions class. |
| LoadOptions(bool) | Initializes a new instance of LoadOptions class with specified pre-rasterization flag. |
| LoadOptions(string) | Initializes a new instance of LoadOptions class with specified password. |
| LoadOptions(string, bool) | Initializes a new instance of LoadOptions class with specified password. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Gets or sets a password for password-protected documents. |
| PreRasterize { get; set; } | Gets or sets a value, indicating if the file is to be pre-rasterized. |

##### Examples

The following example demonstrates how to open password-protected document.

```csharp
LoadOptions loadOptions = new LoadOptions("mysecretpassword");
using (var redactor = new Redactor("PasswordProtected.pdf", loadOptions))
{
    // work with document
}
```

### LoadOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of LoadOptions class.

```csharp
public LoadOptions()
```

#### LoadOptions(string)

Initializes a new instance of LoadOptions class with specified password.

```csharp
public LoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | Password for protected files |

#### LoadOptions(bool)

Initializes a new instance of LoadOptions class with specified pre-rasterization flag.

```csharp
public LoadOptions(bool preRasterize)
```

| Parameter | Type | Description |
| --- | --- | --- |
| preRasterize | Boolean | If true, force rasterization on loading |

#### LoadOptions(string, bool)

Initializes a new instance of LoadOptions class with specified password.

```csharp
public LoadOptions(string password, bool preRasterize)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | Password for protected files |
| preRasterize | Boolean | If true, force rasterization on loading |

### Password
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/loadoptions/password.md

#### LoadOptions.Password property

Gets or sets a password for password-protected documents.

```csharp
public string Password { get; set; }
```

### PreRasterize
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/loadoptions/prerasterize.md

#### LoadOptions.PreRasterize property

Gets or sets a value, indicating if the file is to be pre-rasterized.

```csharp
public bool PreRasterize { get; set; }
```

### PdfComplianceLevel
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/pdfcompliancelevel.md

#### PdfComplianceLevel enumeration

Represents a list of supported PDF compliance levels.

```csharp
public enum PdfComplianceLevel
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | The output file will comply with the PDF/A-1b standard by default. |
| PdfA1a | `1` | The output file will comply with the PDF/A-1a standard. |

### PreviewOptions.PreviewFormats
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions.previewformats.md

#### PreviewOptions.PreviewFormats enumeration

Represents supported preview formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | Portable Network Graphics Format. |
| JPEG | `1` | Joint Photographic Experts Group Format. |
| BMP | `2` | Bitmap Picture Format. |

### PreviewOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions.md

#### PreviewOptions class

Provides options to sets requirements and stream delegates for preview generation.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be closed. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of page stream creation delegate. |
| Height { get; set; } | Gets or sets page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate preview. |
| PreviewFormat { get; set; } | Gets or sets preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of page preview completion delegate. |
| Width { get; set; } | Gets or sets page preview width. |

##### Examples

The following example demonstrates how get a document preview using `PreviewOptions` and `CreatePageStream` delegate.

```csharp
    CreatePageStream createDelegate = delegate (int pageNumber)
    {
        var pagePath = System.IO.Path.Combine(@"C:\Temp", string.Format("page_{0}.png", pageNumber));
        return System.IO.File.Create(pagePath);
    };
    var previewOptions = new PreviewOptions(createDelegate);
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.Height = 640;
    previewOptions.Width = 480;
    previewOptions.PageNumbers = new int[] { 1 };
    using (var redactor = new Redactor("C:\Temp\SourceFile.pdf"))
    {
        redactor.GeneratePreview(previewOptions);
    }
```

The following example demonstrates how get a document preview using `PreviewOptions` and both delegates.

```csharp
    CreatePageStream createDelegate = delegate (int pageNumber)
    {
        var pagePath = System.IO.Path.Combine(@"C:\Temp", string.Format("page_{0}.png", pageNumber));
        return System.IO.File.Create(pagePath);
    };
    ReleasePageStream releaseDelegate = delegate (int pageNumber, System.IO.Stream pageStream)
    {
        // do anything with Stream, containing page preview
        pageStream.Close();
    };
    var previewOptions = new PreviewOptions(createDelegate, releaseDelegate);
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.Height = 640;
    previewOptions.Width = 480;
    previewOptions.PageNumbers = new int[] { 1 };
    using (var redactor = new Redactor("C:\Temp\SourceFile.pdf"))
    {
        redactor.GeneratePreview(previewOptions);
    }
```

### CreatePageStream
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Gets or sets an instance of page stream creation delegate.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

### Height
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/height.md

#### PreviewOptions.Height property

Gets or sets page preview height.

```csharp
public int Height { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Gets or sets an array of page numbers to generate preview.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Gets or sets preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of PreviewOptions class, causing the output stream to be closed.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets output stream |

### ReleasePageStream
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Gets or sets an instance of page preview completion delegate.

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

### Width
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/previewoptions/width.md

#### PreviewOptions.Width property

Gets or sets page preview width.

```csharp
public int Width { get; set; }
```

### RasterizationOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions.md

#### RasterizationOptions class

Provides options for converting files into PDF.

```csharp
public class RasterizationOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| RasterizationOptions() | Initializes a new instance. |

#### Properties

| Name | Description |
| --- | --- |
| Compliance { get; set; } | Gets or sets the PDF Compliance level. |
| Enabled { get; set; } | Gets or sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization. |
| HasAdvancedOptions { get; } | Gets an indicator, which is true if advanced rasterization options are set. |
| PageCount { get; set; } | Gets or sets the number of pages to be converted into PDF. |
| PageIndex { get; set; } | Gets or sets the index of the first page (0-based) to convert into PDF. |

#### Methods

| Name | Description |
| --- | --- |
| AddAdvancedOption(AdvancedRasterizationOptions) | You can use this method to register an advanced rasterization option to apply. |
| AddAdvancedOption(AdvancedRasterizationOptions, Dictionary&lt;string, string&gt;) | You can use this method to register an advanced rasterization option to apply. |

##### Examples

The following example demonstrates how to set options for the rasterization process.

```csharp
    using (var redactor = new Redactor("SomePresentation.pptx"))
    {
        // redact sensitive data on the first slide 
    
        var rasterizationOptions = new RasterizationOptions();
        rasterizationOptions.PageIndex = 0;
        rasterizationOptions.PageCount = 1;
        rasterizationOptions.Compliance = PdfComplianceLevel.PdfA1a;
        using (var stream = File.Open(Path.Combine(@"C:\Temp", "PresentationFirstSlide.pdf")))
        {
            redactor.Save(stream, rasterizationOptions);
        }
    }      
```

The following example demonstrates how to apply the advanced rasterization options with default settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with default options (convert pages into images, save as PDF)
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Grayscale);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt);
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the border advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with a custom border
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border, new Dictionary<string, string>() { { "border", "10" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the noise advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom number and size of noise effects
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise, 
          new Dictionary<string, string>() { { "maxSpots", "150" }, { "spotMaxSize", "15" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the tilt advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom tilt effect
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt, 
          new Dictionary<string, string>() { { { "minAngle", "85" }, { "randomAngleMax", "5" } });
      redactor.Save(so);
    }
```

### AddAdvancedOption
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/addadvancedoption.md

#### AddAdvancedOption(AdvancedRasterizationOptions)

You can use this method to register an advanced rasterization option to apply.

```csharp
public void AddAdvancedOption(AdvancedRasterizationOptions optionType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |

##### Examples

The following example demonstrates how to apply the advanced rasterization options with default settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with default options (convert pages into images, save as PDF)
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Grayscale);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt);
      redactor.Save(so);
    }
```

#### AddAdvancedOption(AdvancedRasterizationOptions, Dictionary&lt;string, string&gt;)

You can use this method to register an advanced rasterization option to apply.

```csharp
public void AddAdvancedOption(AdvancedRasterizationOptions optionType, 
    Dictionary<string, string> parameters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |
| parameters | Dictionary`2 | Parameters for the given effect, such as rotation angle |

##### Examples

The following example demonstrates how to apply the advanced rasterization options with default settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with default options (convert pages into images, save as PDF)
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Grayscale);
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt);
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the border advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with a custom border
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Border, new Dictionary<string, string>() { { "border", "10" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the noise advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom number and size of noise effects
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Noise, 
          new Dictionary<string, string>() { { "maxSpots", "150" }, { "spotMaxSize", "15" } });
      redactor.Save(so);
    }
```

The following example demonstrates how to apply the tilt advanced rasterization option with custom settings.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.docx"))
    {
      // Save the document with the custom tilt effect
      var so = new SaveOptions();
      so.Rasterization.Enabled = true;
      so.RedactedFileSuffix = "_scan";
      so.Rasterization.AddAdvancedOption(AdvancedRasterizationOptions.Tilt, 
          new Dictionary<string, string>() { { { "minAngle", "85" }, { "randomAngleMax", "5" } });
      redactor.Save(so);
    }
```

### Compliance
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/compliance.md

#### RasterizationOptions.Compliance property

Gets or sets the PDF Compliance level.

```csharp
public PdfComplianceLevel Compliance { get; set; }
```

### Enabled
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/enabled.md

#### RasterizationOptions.Enabled property

Gets or sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.

```csharp
public bool Enabled { get; set; }
```

### HasAdvancedOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/hasadvancedoptions.md

#### RasterizationOptions.HasAdvancedOptions property

Gets an indicator, which is true if advanced rasterization options are set.

```csharp
public bool HasAdvancedOptions { get; }
```

### PageCount
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/pagecount.md

#### RasterizationOptions.PageCount property

Gets or sets the number of pages to be converted into PDF.

```csharp
public int PageCount { get; set; }
```

### PageIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/pageindex.md

#### RasterizationOptions.PageIndex property

Gets or sets the index of the first page (0-based) to convert into PDF.

```csharp
public int PageIndex { get; set; }
```

### RasterizationOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/rasterizationoptions/rasterizationoptions.md

#### RasterizationOptions constructor

Initializes a new instance.

```csharp
public RasterizationOptions()
```

### RedactorSettings
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/redactorsettings.md

#### RedactorSettings class

Represents redaction settings, allowing to customize the redaction process.

```csharp
public class RedactorSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| RedactorSettings() | Initializes a new instance of the RedactorSettings class. |
| RedactorSettings(ILogger) | Initializes a new instance of the RedactorSettings class with a given ILogger instance. |
| RedactorSettings(IOcrConnector) | Initializes a new instance of the RedactorSettings class with a given IOcrConnector instance. |
| RedactorSettings(IRedactionCallback) | Initializes a new instance of the RedactorSettings class with a given IRedactionCallback instance. |
| RedactorSettings(ILogger, IRedactionCallback) | Initializes a new instance of the RedactorSettings class with given ILogger and IRedactionCallback instances. |
| RedactorSettings(ILogger, IRedactionCallback, IOcrConnector) | Initializes a new instance of the RedactorSettings class with given ILogger, IRedactionCallback and IOcrConnector instances. |

#### Properties

| Name | Description |
| --- | --- |
| Logger { get; set; } | Gets or sets an instance of a class, implementing `ILogger`, that is used for logging events and errors. |
| OcrConnector { get; set; } | Gets or sets an instance of a class, implementing `IOcrConnector` interface. |
| RedactionCallback { get; set; } | Gets or sets an instance of a class, implementing `IRedactionCallback`. |

### Logger
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/redactorsettings/logger.md

#### RedactorSettings.Logger property

Gets or sets an instance of a class, implementing `ILogger`, that is used for logging events and errors.

```csharp
public ILogger Logger { get; set; }
```

### OcrConnector
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/redactorsettings/ocrconnector.md

#### RedactorSettings.OcrConnector property

Gets or sets an instance of a class, implementing `IOcrConnector` interface.

```csharp
public IOcrConnector OcrConnector { get; set; }
```

### RedactionCallback
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/redactorsettings/redactioncallback.md

#### RedactorSettings.RedactionCallback property

Gets or sets an instance of a class, implementing `IRedactionCallback`.

```csharp
public IRedactionCallback RedactionCallback { get; set; }
```

### RedactorSettings
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/redactorsettings/redactorsettings.md

#### RedactorSettings()

Initializes a new instance of the RedactorSettings class.

```csharp
public RedactorSettings()
```

#### RedactorSettings(ILogger)

Initializes a new instance of the RedactorSettings class with a given ILogger instance.

```csharp
public RedactorSettings(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |

#### RedactorSettings(IRedactionCallback)

Initializes a new instance of the RedactorSettings class with a given IRedactionCallback instance.

```csharp
public RedactorSettings(IRedactionCallback callback)
```

| Parameter | Type | Description |
| --- | --- | --- |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |

#### RedactorSettings(IOcrConnector)

Initializes a new instance of the RedactorSettings class with a given IOcrConnector instance.

```csharp
public RedactorSettings(IOcrConnector ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | A valid implementation of IOcrConnector interface |

#### RedactorSettings(ILogger, IRedactionCallback)

Initializes a new instance of the RedactorSettings class with given ILogger and IRedactionCallback instances.

```csharp
public RedactorSettings(ILogger logger, IRedactionCallback callback)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |

#### RedactorSettings(ILogger, IRedactionCallback, IOcrConnector)

Initializes a new instance of the RedactorSettings class with given ILogger, IRedactionCallback and IOcrConnector instances.

```csharp
public RedactorSettings(ILogger logger, IRedactionCallback callback, IOcrConnector ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | An instance of a class, implementing ILogger interface |
| callback | IRedactionCallback | An instance of a class, implementing IRedactionCallbck interface |
| ocrConnector | IOcrConnector | An instance of IOcrConnector interface implementation. Can be null |

### ReleasePageStream
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/releasepagestream.md

#### ReleasePageStream delegate

Represents a method which releases stream created by `CreatePageStream` delegate.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Page number of the generated page preview |
| pageStream | Stream | Stream, containing the generated page preview |

##### Examples

The following example demonstrates how get a document preview using `PreviewOptions` and both delegates.

```csharp
    CreatePageStream createDelegate = delegate (int pageNumber)
    {
        var pagePath = System.IO.Path.Combine(@"C:\Temp", string.Format("page_{0}.png", pageNumber));
        return System.IO.File.Create(pagePath);
    };
    ReleasePageStream releaseDelegate = delegate (int pageNumber, System.IO.Stream pageStream)
    {
        // do anything with Stream, containing page preview
        pageStream.Close();
    };
    var previewOptions = new PreviewOptions(createDelegate, releaseDelegate);
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.Height = 640;
    previewOptions.Width = 480;
    previewOptions.PageNumbers = new int[] { 1 };
    using (var redactor = new Redactor("C:\Temp\SourceFile.pdf"))
    {
        redactor.GeneratePreview(previewOptions);
    }
```

### SaveOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions.md

#### SaveOptions class

Provides options for changing an output file name and/or converting the document to image-based PDF (rasterization).

```csharp
public class SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false. |
| SaveOptions(bool, string) | Initializes a new instance with given parameters. |

#### Properties

| Name | Description |
| --- | --- |
| AddSuffix { get; set; } | Gets or sets a value indicating whether the file name needs to be changed before saving. False by default. |
| Rasterization { get; } | Gets the rasterization settings. |
| RasterizeToPDF { get; set; } | Gets or sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| RedactedFileSuffix { get; set; } | Gets or sets a custom suffix for output file name. If it is not specified, the `SaveSuffix` constant will be used. |

#### Fields

| Name | Description |
| --- | --- |
| const SaveSuffix | Represents default suffix value, which is "Redacted". |

##### Examples

The following example demonstrates how to save a document using SaveOptions.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
    {
       // Document redaction goes here
       // ...
    
       // Save the document with default options (convert pages into images, save as PDF)
       redactor.Save();
    
       // Save the document in original format overwriting original file
       redactor.Save(new SaveOptions() { AddSuffix = false, RasterizeToPDF = false });
    
       // Save the document to "*_Redacted.*" file in original format
       redactor.Save(new SaveOptions() { AddSuffix = true, RasterizeToPDF = false });
    
       // Save the document to "*_AnyText.*" (e.g. timestamp instead of "AnyText") in its file name without rasterization
       redactor.Save(new SaveOptions(false, "AnyText"));
    }    
```

### AddSuffix
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/addsuffix.md

#### SaveOptions.AddSuffix property

Gets or sets a value indicating whether the file name needs to be changed before saving. False by default.

```csharp
public bool AddSuffix { get; set; }
```

### Rasterization
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/rasterization.md

#### SaveOptions.Rasterization property

Gets the rasterization settings.

```csharp
public RasterizationOptions Rasterization { get; }
```

### RasterizeToPDF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/rasterizetopdf.md

#### SaveOptions.RasterizeToPDF property

Gets or sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

```csharp
public bool RasterizeToPDF { get; set; }
```

### RedactedFileSuffix
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/redactedfilesuffix.md

#### SaveOptions.RedactedFileSuffix property

Gets or sets a custom suffix for output file name. If it is not specified, the `SaveSuffix` constant will be used.

```csharp
public string RedactedFileSuffix { get; set; }
```

### SaveOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/saveoptions.md

#### SaveOptions()

Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false.

```csharp
public SaveOptions()
```

#### SaveOptions(bool, string)

Initializes a new instance with given parameters.

```csharp
public SaveOptions(bool rasterizeToPdf, string suffix)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rasterizeToPdf | Boolean | True, if all pages in the document need to be converted to images and put in a single PDF file |
| suffix | String | This text will be added to the end of file name, if not empty also sets AddSuffix to true |

### SaveSuffix
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.options/saveoptions/savesuffix.md

#### SaveOptions.SaveSuffix field

Represents default suffix value, which is "Redacted".

```csharp
public const string SaveSuffix;
```

### GroupDocs.Redaction.Redactions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions.md

The Redactions namespace provides classes for different types of redactions.

#### Classes

| Class | Description |
| --- | --- |
| AnnotationRedaction | Represents a redaction that replaces annotation text (comments, etc.) matching a given regular expression. |
| CellColumnRedaction | Represents a text redaction that replaces text in a spreadsheet documents (CSV, Excel, etc.). |
| CellFilter | Provides an option to limit the scope of a `CellColumnRedaction` to a worksheet and a column. |
| CustomRedactionContext | Provides context for custom redaction processing. |
| CustomRedactionResult | Represents the result of a custom redaction operation. |
| DeleteAnnotationRedaction | Represents a text redaction that deletes annotations if text is matching given regular expression (optionally deletes all annotations). |
| EraseMetadataRedaction | Represents a metadata redaction that erases all metadata or metadata matching specific MetadataFilters from the document. |
| ExactPhraseRedaction | Represents a text redaction that replaces exact phrase in the document's text, case insensitive by default. |
| ImageAreaRedaction | Represents a redaction that places colored rectangle in given area of an image document. |
| MetadataRedaction | Represents a base abstract class for document metadata redactions. |
| MetadataSearchRedaction | Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values. |
| PageAreaFilter | Represents redaction filter, setting an area within a page of a document to apply redaction. |
| PageAreaRedaction | Represents a complex textual redaction that affects text, images and annotations in an area of the page. |
| PageRangeFilter | Represents redaction filter, setting page range inside a document to apply redaction. |
| RedactionDescription | Represents a single change action info that performed during redaction process. |
| RedactionFilter | Represents redaction filter, setting scope inside a document to apply redactions. |
| RegexRedaction | Represents a text redaction that searches and replaces text in the document by matching provided regular expression. |
| RegionReplacementOptions | Represents color and area parameters for image region replacement. See `ImageAreaRedaction`. |
| RemovePageRedaction | Represents a redaction that removes a page (slide, worksheet, etc.) from a document. |
| ReplacementOptions | Represents options for matched text replacement. |
| TextRedaction | Represents a base abstract class for document text redactions. |
| TextReplacement | Represents a textual replacement information. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICustomRedactionHandler | Provides an interface for implementing custom redaction logic. |
| IRedactionCallback | Defines methods that are required for receiving information on each redaction change and optionally prevent it. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| MetadataFilters | Represents a list of the most common types of document metadata. |
| PageSeekOrigin | Provides the fields that represent reference points in a document for seeking. |
| RedactionActionType | Represents actions that can be taken to perform redaction. |
| RedactionType | Represents a type of document's data, affected by redaction. |
| ReplacementType | Represents a type of replacement for the matched text. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### AnnotationRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction.md

#### AnnotationRedaction class

Represents a redaction that replaces annotation text (comments, etc.) matching a given regular expression.

```csharp
public class AnnotationRedaction : Redaction
```

#### Constructors

| Name | Description |
| --- | --- |
| AnnotationRedaction(Regex, string) | Initializes a new instance of AnnotationRedaction class. |
| AnnotationRedaction(string, string) | Initializes a new instance of AnnotationRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Expression { get; } | Gets the regular expression to match. |
| Replacement { get; } | Gets a textual replacement for matched text. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates how to replace the name "John" with "[redacted]" in all annotations.

```csharp
using (Redactor redactor = new Redactor(@"C:\test.pdf"))
{
   redactor.Apply(new AnnotationRedaction("(?im:john)", "[redacted]"));
   redactor.Save()
}
```

### AnnotationRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction/annotationredaction.md

#### AnnotationRedaction(string, string)

Initializes a new instance of AnnotationRedaction class.

```csharp
public AnnotationRedaction(string pattern, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | Regular expression to match |
| replacement | String | Textual replacement for matched text |

#### AnnotationRedaction(Regex, string)

Initializes a new instance of AnnotationRedaction class.

```csharp
public AnnotationRedaction(Regex regex, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regex | Regex | Regular expression to match |
| replacement | String | Textual replacement for matched text |

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction/applyto.md

#### AnnotationRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction/description.md

#### AnnotationRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### Expression
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction/expression.md

#### AnnotationRedaction.Expression property

Gets the regular expression to match.

```csharp
public Regex Expression { get; }
```

### Replacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/annotationredaction/replacement.md

#### AnnotationRedaction.Replacement property

Gets a textual replacement for matched text.

```csharp
public string Replacement { get; }
```

### CellColumnRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction.md

#### CellColumnRedaction class

Represents a text redaction that replaces text in a spreadsheet documents (CSV, Excel, etc.).

```csharp
public class CellColumnRedaction : TextRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| CellColumnRedaction(CellFilter, Regex, ReplacementOptions) | Initializes a new instance of CellColumnRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| ActionOptions { get; } | Gets the `ReplacementOptions` instance, specifying type of text replacement. |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Filter { get; } | Gets the column and worksheet filter. |
| OcrConnector { get; set; } | Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content. |
| Pattern { get; } | Gets the regular expression to match. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates removing user emails from a second column on "Customers" worksheet of a spreadsheet document.

```csharp
using (Redactor redactor = new Redactor("D:\\Sales in September.xslx"))
{
   var filter = new CellFilter()
   {
       ColumnIndex = 1, // zero-based 2nd column
       WorkSheetName = "Customers"
   };
   var expression = new Regex("^\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$");
   RedactorChangeLog changeLog = redactor.Apply(new CellColumnRedaction(filter, expression, new ReplacementOptions("[customer email]")));
   if (result.Status != RedactionStatus.Failed)
   {
      doc.Save(new SaveOptions() { AddSuffix = true });
   };
}
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction/applyto.md

#### CellColumnRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### CellColumnRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction/cellcolumnredaction.md

#### CellColumnRedaction constructor

Initializes a new instance of CellColumnRedaction class.

```csharp
public CellColumnRedaction(CellFilter filter, Regex regEx, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | CellFilter | Column and worksheet filter |
| regEx | Regex | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options |

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction/description.md

#### CellColumnRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### Filter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction/filter.md

#### CellColumnRedaction.Filter property

Gets the column and worksheet filter.

```csharp
public CellFilter Filter { get; }
```

### Pattern
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellcolumnredaction/pattern.md

#### CellColumnRedaction.Pattern property

Gets the regular expression to match.

```csharp
public Regex Pattern { get; }
```

### CellFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter.md

#### CellFilter class

Provides an option to limit the scope of a `CellColumnRedaction` to a worksheet and a column.

```csharp
public class CellFilter
```

#### Constructors

| Name | Description |
| --- | --- |
| CellFilter() | Initializes a new instance. |

#### Properties

| Name | Description |
| --- | --- |
| ColumnIndex { get; set; } | Gets or sets a column index (zero-based). |
| HasWorkSheetIndex { get; } | Gets a value indicating whether the `WorkSheetIndex` is set or not. |
| WorkSheetIndex { get; set; } | Gets or sets a worksheet index (zero-based). |
| WorkSheetName { get; set; } | Gets or sets a worksheet name (if applicable). |

#### Fields

| Name | Description |
| --- | --- |
| const NoIndex | Represents a default value for filter, which is -1. |

### CellFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/cellfilter.md

#### CellFilter constructor

Initializes a new instance.

```csharp
public CellFilter()
```

### ColumnIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/columnindex.md

#### CellFilter.ColumnIndex property

Gets or sets a column index (zero-based).

```csharp
public int ColumnIndex { get; set; }
```

### HasWorkSheetIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/hasworksheetindex.md

#### CellFilter.HasWorkSheetIndex property

Gets a value indicating whether the `WorkSheetIndex` is set or not.

```csharp
public bool HasWorkSheetIndex { get; }
```

### NoIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/noindex.md

#### CellFilter.NoIndex field

Represents a default value for filter, which is -1.

```csharp
public const int NoIndex;
```

### WorkSheetIndex
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/worksheetindex.md

#### CellFilter.WorkSheetIndex property

Gets or sets a worksheet index (zero-based).

```csharp
public int WorkSheetIndex { get; set; }
```

### WorkSheetName
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/cellfilter/worksheetname.md

#### CellFilter.WorkSheetName property

Gets or sets a worksheet name (if applicable).

```csharp
public string WorkSheetName { get; set; }
```

### CustomRedactionContext
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactioncontext.md

#### CustomRedactionContext class

Provides context for custom redaction processing.

```csharp
public class CustomRedactionContext
```

#### Constructors

| Name | Description |
| --- | --- |
| CustomRedactionContext() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| PageNumber { get; set; } | The page number of the document where the text appears. Note: Some document formats may not support page numbers. |
| Text { get; set; } | The original text to be redacted. |

### CustomRedactionContext
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactioncontext/customredactioncontext.md

#### CustomRedactionContext constructor

The default constructor.

```csharp
public CustomRedactionContext()
```

### PageNumber
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactioncontext/pagenumber.md

#### CustomRedactionContext.PageNumber property

The page number of the document where the text appears. Note: Some document formats may not support page numbers.

```csharp
public int PageNumber { get; set; }
```

### Text
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactioncontext/text.md

#### CustomRedactionContext.Text property

The original text to be redacted.

```csharp
public string Text { get; set; }
```

### CustomRedactionResult
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactionresult.md

#### CustomRedactionResult class

Represents the result of a custom redaction operation.

```csharp
public class CustomRedactionResult
```

#### Constructors

| Name | Description |
| --- | --- |
| CustomRedactionResult() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Apply { get; set; } | Indicates whether the redaction should be applied. If true, the redacted content will replace the original content. |
| Text { get; set; } | The redacted version of the text. This will replace the original content if Apply is true. |

### Apply
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactionresult/apply.md

#### CustomRedactionResult.Apply property

Indicates whether the redaction should be applied. If true, the redacted content will replace the original content.

```csharp
public bool Apply { get; set; }
```

### CustomRedactionResult
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactionresult/customredactionresult.md

#### CustomRedactionResult constructor

The default constructor.

```csharp
public CustomRedactionResult()
```

### Text
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/customredactionresult/text.md

#### CustomRedactionResult.Text property

The redacted version of the text. This will replace the original content if Apply is true.

```csharp
public string Text { get; set; }
```

### DeleteAnnotationRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/deleteannotationredaction.md

#### DeleteAnnotationRedaction class

Represents a text redaction that deletes annotations if text is matching given regular expression (optionally deletes all annotations).

```csharp
public class DeleteAnnotationRedaction : Redaction
```

#### Constructors

| Name | Description |
| --- | --- |
| DeleteAnnotationRedaction() | Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything). |
| DeleteAnnotationRedaction(Regex) | Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression. |
| DeleteAnnotationRedaction(string) | Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression. |

#### Properties

| Name | Description |
| --- | --- |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Expression { get; } | Gets the regular expression to match. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates how to remove all annotations containing words "use", "show" or "describe" from document (and leave others).

```csharp
using (Redactor redactor = new Redactor(@"D:\test.docx"))
{
   redactor.Apply(new DeleteAnnotationRedaction("(?im:(use|show|describe))"));
   redactor.Save()
}
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/deleteannotationredaction/applyto.md

#### DeleteAnnotationRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### DeleteAnnotationRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/deleteannotationredaction/deleteannotationredaction.md

#### DeleteAnnotationRedaction()

Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything).

```csharp
public DeleteAnnotationRedaction()
```

#### DeleteAnnotationRedaction(string)

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

```csharp
public DeleteAnnotationRedaction(string pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | Regular expression |

#### DeleteAnnotationRedaction(Regex)

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

```csharp
public DeleteAnnotationRedaction(Regex regex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regex | Regex | Regular expression |

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/deleteannotationredaction/description.md

#### DeleteAnnotationRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### Expression
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/deleteannotationredaction/expression.md

#### DeleteAnnotationRedaction.Expression property

Gets the regular expression to match.

```csharp
public Regex Expression { get; }
```

### EraseMetadataRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/erasemetadataredaction.md

#### EraseMetadataRedaction class

Represents a metadata redaction that erases all metadata or metadata matching specific MetadataFilters from the document.

```csharp
public class EraseMetadataRedaction : MetadataRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| EraseMetadataRedaction() | Initializes a new instance of EraseMetadataRedaction class, erasing all metadata. |
| EraseMetadataRedaction(MetadataFilters) | Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of `MetadataFilters`. |

#### Properties

| Name | Description |
| --- | --- |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Filter { get; set; } | Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates how to erase (set equal to empty values) all or specific metadata.

```csharp
using (Redactor redactor = new Redactor(@"C:\sample.docx"))
{
   // Erase Author, Manager and Company
   redactor.Apply(new EraseMetadataRedaction(MetadataFilters.Author | MetadataFilters.Manager | MetadataFilters.Company));
   // Erase all metadata
   redactor.Apply(new EraseMetadataRedaction(MetadataFilters.All));
   redactor.Save();
}
```

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/erasemetadataredaction/description.md

#### EraseMetadataRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### EraseMetadataRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/erasemetadataredaction/erasemetadataredaction.md

#### EraseMetadataRedaction()

Initializes a new instance of EraseMetadataRedaction class, erasing all metadata.

```csharp
public EraseMetadataRedaction()
```

#### EraseMetadataRedaction(MetadataFilters)

Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of `MetadataFilters`.

```csharp
public EraseMetadataRedaction(MetadataFilters filter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filter | MetadataFilters | Filter for metadata to erase |

### ExactPhraseRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction.md

#### ExactPhraseRedaction class

Represents a text redaction that replaces exact phrase in the document's text, case insensitive by default.

```csharp
public class ExactPhraseRedaction : TextRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| ExactPhraseRedaction(string, ReplacementOptions) | Initializes a new instance of ExactPhraseRedaction class in case insensitive mode. |
| ExactPhraseRedaction(string, bool, ReplacementOptions) | Initializes a new instance of ExactPhraseRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| ActionOptions { get; } | Gets the `ReplacementOptions` instance, specifying type of text replacement. |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| IsCaseSensitive { get; } | Gets a value indicating whether the search is case-sensitive or not. |
| IsRightToLeft { get; set; } | Gets or sets a value indicating if this text is right-to-Left or not, false by default. |
| OcrConnector { get; set; } | Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content. |
| SearchPhrase { get; } | Gets the string to search and replace. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates performing case-sensitive phrase search and replacement.

```csharp
using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
{
  // By default, isCaseSensitive = false;
  doc.Apply(new ExactPhraseRedaction("John Doe", true /*isCaseSensitive*/, new ReplacementOptions("[personal]")));
  doc.Save();
}
```

The following example demonstrates replacing phrase (case insensitive) with solid red rectangle.

```csharp
using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
{
  // By default, isCaseSensitive = false;
  doc.Apply(new ExactPhraseRedaction("John Doe", new ReplacementOptions(System.Drawing.Color.Red)));
  doc.Save();
}
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/applyto.md

#### ExactPhraseRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/description.md

#### ExactPhraseRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### ExactPhraseRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/exactphraseredaction.md

#### ExactPhraseRedaction(string, ReplacementOptions)

Initializes a new instance of ExactPhraseRedaction class in case insensitive mode.

```csharp
public ExactPhraseRedaction(string searchPhrase, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchPhrase | String | String to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

#### ExactPhraseRedaction(string, bool, ReplacementOptions)

Initializes a new instance of ExactPhraseRedaction class.

```csharp
public ExactPhraseRedaction(string searchPhrase, bool isCaseSensitive, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchPhrase | String | String to search and replace |
| isCaseSensitive | Boolean | True if case sensitive search is required |
| options | ReplacementOptions | Replacement options (textual, color) |

### IsCaseSensitive
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/iscasesensitive.md

#### ExactPhraseRedaction.IsCaseSensitive property

Gets a value indicating whether the search is case-sensitive or not.

```csharp
public bool IsCaseSensitive { get; }
```

### IsRightToLeft
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/isrighttoleft.md

#### ExactPhraseRedaction.IsRightToLeft property

Gets or sets a value indicating if this text is right-to-Left or not, false by default.

```csharp
public bool IsRightToLeft { get; set; }
```

### SearchPhrase
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/exactphraseredaction/searchphrase.md

#### ExactPhraseRedaction.SearchPhrase property

Gets the string to search and replace.

```csharp
public string SearchPhrase { get; }
```

### ICustomRedactionHandler
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/icustomredactionhandler.md

#### ICustomRedactionHandler interface

Provides an interface for implementing custom redaction logic.

```csharp
public interface ICustomRedactionHandler
```

#### Methods

| Name | Description |
| --- | --- |
| Redact(CustomRedactionContext) | Applies custom redaction to specific document content. Currently, this is supported only for PDF `PageAreaRedaction`. Users can define their own redaction logic, such as AI-based redaction, which may be more advanced than simple pattern-based methods. |

### Redact
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/icustomredactionhandler/redact.md

#### ICustomRedactionHandler.Redact method

Applies custom redaction to specific document content. Currently, this is supported only for PDF `PageAreaRedaction`. Users can define their own redaction logic, such as AI-based redaction, which may be more advanced than simple pattern-based methods.

```csharp
public CustomRedactionResult Redact(CustomRedactionContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | CustomRedactionContext | Contains the document content to be redacted along with related metadata. |

##### Return Value

A `CustomRedactionResult` indicating whether the redaction should be applied and the modified content.

### ImageAreaRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction.md

#### ImageAreaRedaction class

Represents a redaction that places colored rectangle in given area of an image document.

```csharp
public class ImageAreaRedaction : Redaction
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageAreaRedaction(Point, RegionReplacementOptions) | Initializes a new instance of ImageAreaRedaction class for redacting specific area size. |

#### Properties

| Name | Description |
| --- | --- |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Options { get; } | Gets the `RegionReplacementOptions` options with color and area parameters. |
| TopLeft { get; } | Gets the top-left position of the area to remove |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates replacing an area within the image with a solid color rectangle.

```csharp
    using (Redactor redactor = new Redactor("D:\\test.jpg"))
    {
       System.Drawing.Point samplePoint = new System.Drawing.Point(516, 311);
       System.Drawing.Size sampleSize = new System.Drawing.Size(170, 35);
       RedactorChangeLog result = redactor.Apply(new ImageAreaRedaction(samplePoint,
                     new RegionReplacementOptions(System.Drawing.Color.Blue, sampleSize)));
       if (result.Status != RedactionStatus.Failed)
       {
          redactor.Save();
       };
    } 
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction/applyto.md

#### ImageAreaRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction/description.md

#### ImageAreaRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### ImageAreaRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction/imagearearedaction.md

#### ImageAreaRedaction constructor

Initializes a new instance of ImageAreaRedaction class for redacting specific area size.

```csharp
public ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | Point | Top-left area coordinates |
| options | RegionReplacementOptions | Area size and color |

### Options
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction/options.md

#### ImageAreaRedaction.Options property

Gets the `RegionReplacementOptions` options with color and area parameters.

```csharp
public RegionReplacementOptions Options { get; }
```

### TopLeft
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/imagearearedaction/topleft.md

#### ImageAreaRedaction.TopLeft property

Gets the top-left position of the area to remove

```csharp
public Point TopLeft { get; }
```

### IRedactionCallback
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/iredactioncallback.md

#### IRedactionCallback interface

Defines methods that are required for receiving information on each redaction change and optionally prevent it.

```csharp
public interface IRedactionCallback
```

#### Methods

| Name | Description |
| --- | --- |
| AcceptRedaction(RedactionDescription) | This call is triggered right before applying any redaction to the document and allows to log or forbid it. |

##### Examples

The following example demonstrates how to implement detailed logging for redaction process.

```csharp
public class RedactionDump : IRedactionCallback
{
    public RedactionDump()
    {
    }

    public bool AcceptRedaction(RedactionDescription description)
    {
        Console.Write("{0} redaction, {1} action, item {2}. ", description.RedactionType, description.ActionType, description.OriginalText);
        if (description.Replacement != null)
        {
            Console.Write("Text {0} is replaced with {1}. ", description.Replacement.OriginalText, description.Replacement.Replacement);
        }
        Console.WriteLine();
        // you can return "false" here to prevent particular change during redaction process
        return true;
    }
}

...

// Assign an instance before using Redactor
Redactor.RedactionCallback = new RedactionDump();
```

### AcceptRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/iredactioncallback/acceptredaction.md

#### IRedactionCallback.AcceptRedaction method

This call is triggered right before applying any redaction to the document and allows to log or forbid it.

```csharp
public bool AcceptRedaction(RedactionDescription description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | RedactionDescription | Contains information about particular match type, criteria, text and position |

##### Return Value

Return true to accept or false to decline particular match redaction

### MetadataFilters
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatafilters.md

#### MetadataFilters enumeration

Represents a list of the most common types of document metadata.

```csharp
[Flags]
public enum MetadataFilters
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Empty filter setting, matches no metadata items. |
| Author | `1` | Author of the document. |
| Category | `2` | Category of the document. |
| Comments | `4` | Comment for the document. |
| Company | `8` | Company of the Author. |
| ContentStatus | `10` | Content status. |
| CreatedTime | `20` | Created time. |
| HyperlinkBase | `40` | Hyperlink base. |
| LastPrinted | `80` | Last printed date and time. |
| LastSavedBy | `100` | Last saved by user. |
| LastSavedTime | `400` | Last saved date and time. |
| NameOfApplication | `800` | Name of application where the document was created. |
| Manager | `1000` | Author's manager name. |
| RevisionNumber | `2000` | Revision number. |
| Subject | `4000` | Subject of the document. |
| Template | `8000` | Document template name. |
| Title | `10000` | Document title. |
| TotalEditingTime | `20000` | Total editing time. |
| Version | `40000` | Document's version. |
| Description | `80000` | Document's description. |
| Keywords | `100000` | Document's keywords. |
| ContentType | `200000` | Content type. |
| All | `7FFFFFFF` | All types of the metadata items. |

### MetadataRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadataredaction.md

#### MetadataRedaction class

Represents a base abstract class for document metadata redactions.

```csharp
public abstract class MetadataRedaction : Redaction
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Description { get; } | Returns a string, describing the redaction and its parameters. |
| Filter { get; set; } | Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadataredaction/applyto.md

#### MetadataRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Filter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadataredaction/filter.md

#### MetadataRedaction.Filter property

Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company.

```csharp
public MetadataFilters Filter { get; set; }
```

### MetadataSearchRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction.md

#### MetadataSearchRedaction class

Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values.

```csharp
public class MetadataSearchRedaction : MetadataRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataSearchRedaction(Regex, string) | Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items. |
| MetadataSearchRedaction(string, string) | Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items. |
| MetadataSearchRedaction(Regex, string, Regex) | Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items. |
| MetadataSearchRedaction(string, string, string) | Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items. |

#### Properties

| Name | Description |
| --- | --- |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| Filter { get; set; } | Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company. |
| KeyExpression { get; } | Gets the regular expression to match name (key) of metadata item. |
| Replacement { get; } | Gets the textual replacement value. |
| ValueExpression { get; } | Gets the regular expression to match value text of a metadata item. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates how to search and redact certain text in specific metadata.

```csharp
using (Redactor redactor = new Redactor(@"C:\sample.docx"))
{
   MetadataSearchRedaction redaction = new MetadataSearchRedaction("Company Ltd.", "--company--");
   // If not set, applies to all metadata items
   redaction.Filter = MetadataFilters.Company;
   redactor.Apply(redaction);
   redactor.Save();
}
```

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction/description.md

#### MetadataSearchRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### KeyExpression
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction/keyexpression.md

#### MetadataSearchRedaction.KeyExpression property

Gets the regular expression to match name (key) of metadata item.

```csharp
public Regex KeyExpression { get; }
```

### MetadataSearchRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction/metadatasearchredaction.md

#### MetadataSearchRedaction(string, string)

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

```csharp
public MetadataSearchRedaction(string valuePattern, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| valuePattern | String | Regular expression to search and replace |
| replacement | String | Textual replacement |

#### MetadataSearchRedaction(string, string, string)

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

```csharp
public MetadataSearchRedaction(string valuePattern, string replacement, string keyPattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| valuePattern | String | Regular expression to search and replace metadata item value |
| replacement | String | Textual replacement |
| keyPattern | String | Regular expression to search and replace metadata item name |

#### MetadataSearchRedaction(Regex, string)

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

```csharp
public MetadataSearchRedaction(Regex valueRegex, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| valueRegex | Regex | Regular expression to search and replace |
| replacement | String | Textual replacement |

#### MetadataSearchRedaction(Regex, string, Regex)

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

```csharp
public MetadataSearchRedaction(Regex valueRegex, string replacement, Regex keyRegex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| valueRegex | Regex | Regular expression to search and replace metadata item value |
| replacement | String | Textual replacement |
| keyRegex | Regex | Regular expression to search and replace metadata item name |

### Replacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction/replacement.md

#### MetadataSearchRedaction.Replacement property

Gets the textual replacement value.

```csharp
public string Replacement { get; }
```

### ValueExpression
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/metadatasearchredaction/valueexpression.md

#### MetadataSearchRedaction.ValueExpression property

Gets the regular expression to match value text of a metadata item.

```csharp
public Regex ValueExpression { get; }
```

### PageAreaFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pageareafilter.md

#### PageAreaFilter class

Represents redaction filter, setting an area within a page of a document to apply redaction.

```csharp
public class PageAreaFilter : RedactionFilter
```

#### Constructors

| Name | Description |
| --- | --- |
| PageAreaFilter(Point, Size) | Initializes a new instance of PageAreaFilter class for redacting specific area. |

#### Properties

| Name | Description |
| --- | --- |
| Rectangle { get; } | Gets the rectangle (top-left position and size of the area) on a page. |

### PageAreaFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pageareafilter/pageareafilter.md

#### PageAreaFilter constructor

Initializes a new instance of PageAreaFilter class for redacting specific area.

```csharp
public PageAreaFilter(Point topLeft, Size size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | Point | Top-left area coordinates |
| size | Size | Area size and color |

### Rectangle
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pageareafilter/rectangle.md

#### PageAreaFilter.Rectangle property

Gets the rectangle (top-left position and size of the area) on a page.

```csharp
public Rectangle Rectangle { get; }
```

### PageAreaRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagearearedaction.md

#### PageAreaRedaction class

Represents a complex textual redaction that affects text, images and annotations in an area of the page.

```csharp
public class PageAreaRedaction : RegexRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| PageAreaRedaction(Regex, ReplacementOptions) | Initializes a new instance of PageAreaRedaction class. |
| PageAreaRedaction(Regex, ReplacementOptions, RegionReplacementOptions) | Initializes a new instance of PageAreaRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| ActionOptions { get; } | Gets the `ReplacementOptions` instance, specifying type of text replacement. |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| ImageOptions { get; } | Gets the `RegionReplacementOptions` options with color and area parameters. |
| OcrConnector { get; set; } | Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content. |
| RegularExpression { get; } | Gets the regular expression to match. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagearearedaction/applyto.md

#### PageAreaRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### ImageOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagearearedaction/imageoptions.md

#### PageAreaRedaction.ImageOptions property

Gets the `RegionReplacementOptions` options with color and area parameters.

```csharp
public RegionReplacementOptions ImageOptions { get; }
```

### PageAreaRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagearearedaction/pagearearedaction.md

#### PageAreaRedaction(Regex, ReplacementOptions)

Initializes a new instance of PageAreaRedaction class.

```csharp
public PageAreaRedaction(Regex regex, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regex | Regex | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

#### PageAreaRedaction(Regex, ReplacementOptions, RegionReplacementOptions)

Initializes a new instance of PageAreaRedaction class.

```csharp
public PageAreaRedaction(Regex regex, ReplacementOptions options, 
    RegionReplacementOptions imageOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regex | Regex | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
| imageOptions | RegionReplacementOptions | Replacement options (image area) |

### PageRangeFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagerangefilter.md

#### PageRangeFilter class

Represents redaction filter, setting page range inside a document to apply redaction.

```csharp
public class PageRangeFilter : RedactionFilter
```

#### Constructors

| Name | Description |
| --- | --- |
| PageRangeFilter(PageSeekOrigin, int, int) | Initializes a new instance of RemovePageRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the count of pages to remove. |
| Index { get; } | Gets start position index (0-based). |
| Origin { get; } | Gets seek reference position, the beginning or the end of a document. |

### Count
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagerangefilter/count.md

#### PageRangeFilter.Count property

Gets the count of pages to remove.

```csharp
public int Count { get; }
```

### Index
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagerangefilter/index.md

#### PageRangeFilter.Index property

Gets start position index (0-based).

```csharp
public int Index { get; }
```

### Origin
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagerangefilter/origin.md

#### PageRangeFilter.Origin property

Gets seek reference position, the beginning or the end of a document.

```csharp
public PageSeekOrigin Origin { get; }
```

### PageRangeFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pagerangefilter/pagerangefilter.md

#### PageRangeFilter constructor

Initializes a new instance of RemovePageRedaction class.

```csharp
public PageRangeFilter(PageSeekOrigin origin, int index, int count)
```

| Parameter | Type | Description |
| --- | --- | --- |
| origin | PageSeekOrigin | Seek reference position, the beginning or the end of a document |
| index | Int32 | Start position index (0-based) |
| count | Int32 | Count of pages to remove |

### PageSeekOrigin
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/pageseekorigin.md

#### PageSeekOrigin enumeration

Provides the fields that represent reference points in a document for seeking.

```csharp
public enum PageSeekOrigin
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Begin | `0` | Specifies the beginning of a document. |
| End | `1` | Specifies the end of a document. |

### RedactionActionType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactionactiontype.md

#### RedactionActionType enumeration

Represents actions that can be taken to perform redaction.

```csharp
public enum RedactionActionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Replacement | `0` | Redacted text was replaced with another or covered with a block. |
| Cleanup | `1` | Data were removed, but an empty object remains in the document. |
| Deletion | `2` | Data and related structures were removed from the document. |

### RedactionDescription
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription.md

#### RedactionDescription class

Represents a single change action info that performed during redaction process.

```csharp
public class RedactionDescription
```

#### Constructors

| Name | Description |
| --- | --- |
| RedactionDescription(RedactionType, RedactionActionType, string) | Initializes a new instance of RedactionDescription class without replacement information. |
| RedactionDescription(RedactionType, RedactionActionType, RegionReplacementOptions, string) | Initializes a new instance of RedactionDescription class with image area replacement information. |
| RedactionDescription(RedactionType, RedactionActionType, string, TextReplacement) | Initializes a new instance of RedactionDescription class with replacement information. |

#### Properties

| Name | Description |
| --- | --- |
| ActionType { get; } | Gets the redaction operation: replacement, cleanup or deletion. |
| Details { get; set; } | Gets or sets an optional details information for the item being redacted. |
| ImageAreaReplacement { get; } | Gets the replacement information for image area redactions, returns null for textual redactions. |
| OriginalText { get; } | Gets the matched text, if any expression is provided. |
| RedactionType { get; } | Gets the type of document's data - text, metadata or annotations. |
| Replacement { get; } | Gets the replacement information, can be null. |

### ActionType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/actiontype.md

#### RedactionDescription.ActionType property

Gets the redaction operation: replacement, cleanup or deletion.

```csharp
public RedactionActionType ActionType { get; }
```

### Details
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/details.md

#### RedactionDescription.Details property

Gets or sets an optional details information for the item being redacted.

```csharp
public string Details { get; set; }
```

### ImageAreaReplacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/imageareareplacement.md

#### RedactionDescription.ImageAreaReplacement property

Gets the replacement information for image area redactions, returns null for textual redactions.

```csharp
public RegionReplacementOptions ImageAreaReplacement { get; }
```

### OriginalText
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/originaltext.md

#### RedactionDescription.OriginalText property

Gets the matched text, if any expression is provided.

```csharp
public string OriginalText { get; }
```

### RedactionDescription
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/redactiondescription.md

#### RedactionDescription(RedactionType, RedactionActionType, string)

Initializes a new instance of RedactionDescription class without replacement information.

```csharp
public RedactionDescription(RedactionType redactionType, RedactionActionType actionType, 
    string originalText)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | RedactionType | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| originalText | String | Matched text, comment or annotation body |

#### RedactionDescription(RedactionType, RedactionActionType, string, TextReplacement)

Initializes a new instance of RedactionDescription class with replacement information.

```csharp
public RedactionDescription(RedactionType redactionType, RedactionActionType actionType, 
    string originalText, TextReplacement replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | RedactionType | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| originalText | String | Matched text, comment or annotation body |
| replacement | TextReplacement | Replacement text, matched text and its position within original string |

#### RedactionDescription(RedactionType, RedactionActionType, RegionReplacementOptions, string)

Initializes a new instance of RedactionDescription class with image area replacement information.

```csharp
public RedactionDescription(RedactionType redactionType, RedactionActionType actionType, 
    RegionReplacementOptions imageAreaReplacement, string imageDetails)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redactionType | RedactionType | Type of data being redacted |
| actionType | RedactionActionType | Action to be performed on these data |
| imageAreaReplacement | RegionReplacementOptions | Image area replacement information |
| imageDetails | String | Image textual description, by default it is String.Empty |

### RedactionType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/redactiontype.md

#### RedactionDescription.RedactionType property

Gets the type of document's data - text, metadata or annotations.

```csharp
public RedactionType RedactionType { get; }
```

### Replacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiondescription/replacement.md

#### RedactionDescription.Replacement property

Gets the replacement information, can be null.

```csharp
public TextReplacement Replacement { get; }
```

### RedactionFilter
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactionfilter.md

#### RedactionFilter class

Represents redaction filter, setting scope inside a document to apply redactions.

```csharp
public abstract class RedactionFilter
```

### RedactionType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/redactiontype.md

#### RedactionType enumeration

Represents a type of document's data, affected by redaction.

```csharp
public enum RedactionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Text | `0` | The document's body text. |
| Metadata | `1` | The document's metadata. |
| Annotation | `2` | The annotations within document's text. |
| ImageArea | `3` | The area within an image. |
| Page | `4` | The page of a document. |

### RegexRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regexredaction.md

#### RegexRedaction class

Represents a text redaction that searches and replaces text in the document by matching provided regular expression.

```csharp
public class RegexRedaction : TextRedaction
```

#### Constructors

| Name | Description |
| --- | --- |
| RegexRedaction(Regex, ReplacementOptions) | Initializes a new instance of RegexRedaction class. |
| RegexRedaction(string, ReplacementOptions) | Initializes a new instance of RegexRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| ActionOptions { get; } | Gets the `ReplacementOptions` instance, specifying type of text replacement. |
| override Description { get; } | Returns a string, describing the redaction and its parameters. |
| OcrConnector { get; set; } | Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content. |
| RegularExpression { get; } | Gets the regular expression to match. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates replacing text using the regular expression.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
    {
      // replace with text
      redactor.Apply(new RegexRedaction("\\d{2}\\s*\\d{2}[^\\d]*\\d{6}", new ReplacementOptions("[removed]")));
      // replace with blue solid rectangle
      redactor.Apply(new RegexRedaction(@"^\d+[,\.]{1}\d+$", new ReplacementOptions(System.Drawing.Color.Blue)));
      redactor.Save();
    }
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regexredaction/applyto.md

#### RegexRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regexredaction/description.md

#### RegexRedaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public override string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### RegexRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regexredaction/regexredaction.md

#### RegexRedaction(string, ReplacementOptions)

Initializes a new instance of RegexRedaction class.

```csharp
public RegexRedaction(string pattern, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

#### RegexRedaction(Regex, ReplacementOptions)

Initializes a new instance of RegexRedaction class.

```csharp
public RegexRedaction(Regex regex, ReplacementOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| regex | Regex | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |

### RegularExpression
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regexredaction/regularexpression.md

#### RegexRedaction.RegularExpression property

Gets the regular expression to match.

```csharp
public Regex RegularExpression { get; }
```

### RegionReplacementOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regionreplacementoptions.md

#### RegionReplacementOptions class

Represents color and area parameters for image region replacement. See `ImageAreaRedaction`.

```csharp
public class RegionReplacementOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| RegionReplacementOptions(Color, Size) | Initializes a new instance of RegionReplacementOptions class. |
| RegionReplacementOptions(Color, Font, string) | Initializes a new instance of RegionReplacementOptions class which size matches given text. |

#### Properties

| Name | Description |
| --- | --- |
| FillColor { get; set; } | Gets or sets the color to fill the redacted area. |
| Size { get; set; } | Gets or sets the rectangle with and height. |

##### Examples

The following example demonstrates replacing an area within the image with a solid color rectangle.

```csharp
    using (Redactor redactor = new Redactor("D:\\test.jpg"))
    {
       System.Drawing.Point samplePoint = new System.Drawing.Point(516, 311);
       System.Drawing.Size sampleSize = new System.Drawing.Size(170, 35);
       RedactorChangeLog result = redactor.Apply(new ImageAreaRedaction(samplePoint,
                     new RegionReplacementOptions(System.Drawing.Color.Blue, sampleSize)));
       if (result.Status != RedactionStatus.Failed)
       {
          redactor.Save();
       };
    } 
```

### FillColor
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regionreplacementoptions/fillcolor.md

#### RegionReplacementOptions.FillColor property

Gets or sets the color to fill the redacted area.

```csharp
public Color FillColor { get; set; }
```

### RegionReplacementOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regionreplacementoptions/regionreplacementoptions.md

#### RegionReplacementOptions(Color, Size)

Initializes a new instance of RegionReplacementOptions class.

```csharp
public RegionReplacementOptions(Color fillColor, Size size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fillColor | Color | Color to fill the area |
| size | Size | Filled area size |

#### RegionReplacementOptions(Color, Font, string)

Initializes a new instance of RegionReplacementOptions class which size matches given text.

```csharp
public RegionReplacementOptions(Color fillColor, Font font, string expectedText)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fillColor | Color | Color to fill the area |
| font | Font | Expected text font |
| expectedText | String | Expected text |

### Size
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/regionreplacementoptions/size.md

#### RegionReplacementOptions.Size property

Gets or sets the rectangle with and height.

```csharp
public Size Size { get; set; }
```

### RemovePageRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction.md

#### RemovePageRedaction class

Represents a redaction that removes a page (slide, worksheet, etc.) from a document.

```csharp
public class RemovePageRedaction : Redaction
```

#### Constructors

| Name | Description |
| --- | --- |
| RemovePageRedaction(PageSeekOrigin, int, int) | Initializes a new instance of RemovePageRedaction class. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the count of pages to remove. |
| virtual Description { get; } | Returns a string, describing the redaction and its parameters. |
| Index { get; } | Gets start position index (0-based). |
| Origin { get; } | Gets seek reference position, the beginning or the end of a document. |

#### Methods

| Name | Description |
| --- | --- |
| override ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

##### Examples

The following example demonstrates how to remove the last page of the document.

```csharp
using (Redactor redactor = new Redactor(@"C:\test.pdf"))
{
   redactor.Apply(new RemovePageRedaction(PageSeekOrigin.End, 0, 1));
   redactor.Save()
}
```

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction/applyto.md

#### RemovePageRedaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public override RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Count
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction/count.md

#### RemovePageRedaction.Count property

Gets the count of pages to remove.

```csharp
public int Count { get; }
```

### Index
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction/index.md

#### RemovePageRedaction.Index property

Gets start position index (0-based).

```csharp
public int Index { get; }
```

### Origin
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction/origin.md

#### RemovePageRedaction.Origin property

Gets seek reference position, the beginning or the end of a document.

```csharp
public PageSeekOrigin Origin { get; }
```

### RemovePageRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/removepageredaction/removepageredaction.md

#### RemovePageRedaction constructor

Initializes a new instance of RemovePageRedaction class.

```csharp
public RemovePageRedaction(PageSeekOrigin origin, int index, int count)
```

| Parameter | Type | Description |
| --- | --- | --- |
| origin | PageSeekOrigin | Seek reference position, the beginning or the end of a document |
| index | Int32 | Start position index (0-based) |
| count | Int32 | Count of pages to remove |

### ReplacementOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions.md

#### ReplacementOptions class

Represents options for matched text replacement.

```csharp
public class ReplacementOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ReplacementOptions(Color) | Initializes a new instance of ReplacementOptions class with colored rectangle as an option. |
| ReplacementOptions(string) | Initializes a new instance of ReplacementOptions class with replacement text as an option. |

#### Properties

| Name | Description |
| --- | --- |
| ActionType { get; } | Gets the replacement action: draw box or replace text. |
| BoxColor { get; set; } | Gets or sets the color for a DrawBox option (ignored otherwise). |
| CustomRedaction { get; set; } | Gets or sets a custom redaction `ICustomRedactionHandler` handler that allows users to define their own redaction logic. |
| Filters { get; set; } | Gets or sets an array of filters to apply with this redaction. |
| Replacement { get; set; } | Gets or sets the textual replacement value. |

### ActionType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/actiontype.md

#### ReplacementOptions.ActionType property

Gets the replacement action: draw box or replace text.

```csharp
public ReplacementType ActionType { get; }
```

### BoxColor
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/boxcolor.md

#### ReplacementOptions.BoxColor property

Gets or sets the color for a DrawBox option (ignored otherwise).

```csharp
public Color BoxColor { get; set; }
```

### CustomRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/customredaction.md

#### ReplacementOptions.CustomRedaction property

Gets or sets a custom redaction `ICustomRedactionHandler` handler that allows users to define their own redaction logic.

```csharp
public ICustomRedactionHandler CustomRedaction { get; set; }
```

### Filters
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/filters.md

#### ReplacementOptions.Filters property

Gets or sets an array of filters to apply with this redaction.

```csharp
public RedactionFilter[] Filters { get; set; }
```

### Replacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/replacement.md

#### ReplacementOptions.Replacement property

Gets or sets the textual replacement value.

```csharp
public string Replacement { get; set; }
```

### ReplacementOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementoptions/replacementoptions.md

#### ReplacementOptions(string)

Initializes a new instance of ReplacementOptions class with replacement text as an option.

```csharp
public ReplacementOptions(string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| replacement | String | Textual replacement |

#### ReplacementOptions(Color)

Initializes a new instance of ReplacementOptions class with colored rectangle as an option.

```csharp
public ReplacementOptions(Color color)
```

| Parameter | Type | Description |
| --- | --- | --- |
| color | Color | Rectangle color |

### ReplacementType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/replacementtype.md

#### ReplacementType enumeration

Represents a type of replacement for the matched text.

```csharp
public enum ReplacementType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ReplaceString | `0` | Replaces matched text with another string, for instance exemption code. |
| DrawBox | `1` | Draws a rectangle of specific color (Black by default) instead of redacted text. |

### TextRedaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textredaction.md

#### TextRedaction class

Represents a base abstract class for document text redactions.

```csharp
public abstract class TextRedaction : Redaction
```

#### Properties

| Name | Description |
| --- | --- |
| ActionOptions { get; } | Gets the `ReplacementOptions` instance, specifying type of text replacement. |
| virtual Description { get; } | Returns a string, describing the redaction and its parameters. |
| OcrConnector { get; set; } | Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content. |

#### Methods

| Name | Description |
| --- | --- |
| abstract ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

### ActionOptions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textredaction/actionoptions.md

#### TextRedaction.ActionOptions property

Gets the `ReplacementOptions` instance, specifying type of text replacement.

```csharp
public ReplacementOptions ActionOptions { get; }
```

### OcrConnector
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textredaction/ocrconnector.md

#### TextRedaction.OcrConnector property

Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content.

```csharp
public IOcrConnector OcrConnector { get; set; }
```

### TextReplacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement.md

#### TextReplacement class

Represents a textual replacement information.

```csharp
public class TextReplacement
```

#### Constructors

| Name | Description |
| --- | --- |
| TextReplacement(int, string, string) | Initializes a new instance of TextReplacement class. |

#### Properties

| Name | Description |
| --- | --- |
| Index { get; } | Gets an index of the matched text within source string. |
| OriginalText { get; } | Gets the original matched string. |
| Replacement { get; } | Gets the string, replacing OriginalText. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Provides text replacement description and its position. |

### Index
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement/index.md

#### TextReplacement.Index property

Gets an index of the matched text within source string.

```csharp
public int Index { get; }
```

### OriginalText
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement/originaltext.md

#### TextReplacement.OriginalText property

Gets the original matched string.

```csharp
public string OriginalText { get; }
```

### Replacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement/replacement.md

#### TextReplacement.Replacement property

Gets the string, replacing OriginalText.

```csharp
public string Replacement { get; }
```

### TextReplacement
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement/textreplacement.md

#### TextReplacement constructor

Initializes a new instance of TextReplacement class.

```csharp
public TextReplacement(int index, string original, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | Index of a matched text within source string |
| original | String | Original matched string |
| replacement | String | String, replacing OriginalText in source string |

### ToString
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.redactions/textreplacement/tostring.md

#### TextReplacement.ToString method

Provides text replacement description and its position.

```csharp
public override string ToString()
```

##### Return Value

Replacement description

### GroupDocs.Redaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction.md

The Redaction namespace provides classes for redacting sensitive information from documents in PDF, raster image and office document formats. The main classes in this namespace are:

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Represents an information about document. Implements IDocumentInfo interface. See `IDocumentInfo` for examples. |
| FileType | Represents a file type. Provides methods to obtain a list of all file types supported by GroupDocs.Redaction, detect file type by extension, etc. |
| License | Provides methods for applying license. |
| Metered | Provides methods which allow to activate product with Metered license and retrieve amount of MBs processed. Learn more about Metered licenses [here](https://purchase.groupdocs.com/faqs/licensing/metered). |
| PageInfo | Represents a brief page information. |
| Redaction | Represents a base abstract class for all redaction types. |
| RedactionPolicy | Represents a sanitization policy, containing a set of specific redactions to apply. |
| RedactionResult | Represents a result of the redaction operation. |
| Redactor | Represents a main class that controls document redaction process, allowing to open, redact and save documents. |
| RedactorChangeLog | Represents results for a list of redactions, passed to Apply() method of `Redactor` class. |
| RedactorLogEntry | Represents results of applying redaction. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines methods that are required for getting basic document information. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| RedactionStatus | Represents a redaction completion status. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Redaction.dll -->

### DocumentInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/documentinfo.md

#### DocumentInfo class

Represents an information about document. Implements IDocumentInfo interface. See `IDocumentInfo` for examples.

```csharp
public class DocumentInfo : IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the file format description. |
| PageCount { get; } | Gets the total page count. |
| Pages { get; } | Gets the list of `PageInfo` page information. |
| Size { get; } | Gets the document size in bytes. |

### FileType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/documentinfo/filetype.md

#### DocumentInfo.FileType property

Gets the file format description.

```csharp
public FileType FileType { get; }
```

### PageCount
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

Gets the total page count.

```csharp
public int PageCount { get; }
```

### Pages
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/documentinfo/pages.md

#### DocumentInfo.Pages property

Gets the list of `PageInfo` page information.

```csharp
public IList<PageInfo> Pages { get; }
```

### Size
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/documentinfo/size.md

#### DocumentInfo.Size property

Gets the document size in bytes.

```csharp
public long Size { get; }
```

### FileType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype.md

#### FileType class

Represents a file type. Provides methods to obtain a list of all file types supported by GroupDocs.Redaction, detect file type by extension, etc.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| static BMP { get; } | Bitmap Image File (.bmp) |
| static CSV { get; } | Comma Separated Values File (.csv) |
| static DOC { get; } | Microsoft Word Document (.doc) |
| static DOCM { get; } | Word Open XML Macro-Enabled Document (.docm) |
| static DOCX { get; } | Microsoft Word Open XML Document (.docx) |
| static DOT { get; } | Word Document Template (.dot) |
| static DOTM { get; } | Word Open XML Macro-Enabled Document Template (.dotm) |
| static DOTX { get; } | Word Open XML Document Template (.dotx) |
| static GIF { get; } | Graphical Interchange Format File (.gif) |
| static HTM { get; } | Hypertext Markup Language File (.htm) |
| static HTML { get; } | Hypertext Markup Language File (.html) |
| static JP2 { get; } | JPEG 2000 Core Image File (.jp2) |
| static JPEG { get; } | JPEG Image (.jpeg) |
| static JPG { get; } | JPEG Image (.jpg) |
| static MD { get; } | Markdown Documentation File (.md) |
| static NUMBERS { get; } | Apple Numbers Spreadsheet (.numbers) |
| static ODP { get; } | OpenDocument Presentation (.odp) |
| static ODS { get; } | OpenDocument Spreadsheet (.ods) |
| static ODT { get; } | OpenDocument Text Document (.odt) |
| static OTS { get; } | OpenDocument Spreadsheet Template (.ots) |
| static OTT { get; } | OpenDocument Document Template (.ott) |
| static PDF { get; } | Portable Document Format File (.pdf) |
| static PNG { get; } | Portable Network Graphic (.png) |
| static PPT { get; } | PowerPoint Presentation (.ppt) |
| static PPTX { get; } | PowerPoint Open XML Presentation (.pptx) |
| static RTF { get; } | Rich Text Format File (.rtf) |
| static TIF { get; } | Tagged Image File (.tif) |
| static TIFF { get; } | Tagged Image File Format (.tiff) |
| static TSV { get; } | Tab Separated Values File (.tsv) |
| static TXT { get; } | Plain Text File (.txt) |
| static Unknown { get; } | Represents unknown file type. |
| static XLS { get; } | Excel Spreadsheet (.xls) |
| static XLSB { get; } | Excel Binary Spreadsheet (.xlsb) |
| static XLSM { get; } | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) |
| static XLSX { get; } | Microsoft Excel Open XML Spreadsheet (.xlsx) |
| Extension { get; } | Gets filename suffix (including the period "."), for instance ".doc". |
| FileFormat { get; } | Gets file type name, for example "Microsoft Word Document". |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps file extension to file type. |
| Equals(FileType) | Determines whether the current `FileType` is the same as specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static GetSupportedFileTypes() | Retrieves supported file types |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

### BMP
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/bmp.md

#### FileType.BMP property

Bitmap Image File (.bmp)

```csharp
public static FileType BMP { get; }
```

### CSV
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/csv.md

#### FileType.CSV property

Comma Separated Values File (.csv)

```csharp
public static FileType CSV { get; }
```

### DOC
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/doc.md

#### FileType.DOC property

Microsoft Word Document (.doc)

```csharp
public static FileType DOC { get; }
```

### DOCM
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/docm.md

#### FileType.DOCM property

Word Open XML Macro-Enabled Document (.docm)

```csharp
public static FileType DOCM { get; }
```

### DOCX
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/docx.md

#### FileType.DOCX property

Microsoft Word Open XML Document (.docx)

```csharp
public static FileType DOCX { get; }
```

### DOT
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/dot.md

#### FileType.DOT property

Word Document Template (.dot)

```csharp
public static FileType DOT { get; }
```

### DOTM
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/dotm.md

#### FileType.DOTM property

Word Open XML Macro-Enabled Document Template (.dotm)

```csharp
public static FileType DOTM { get; }
```

### DOTX
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/dotx.md

#### FileType.DOTX property

Word Open XML Document Template (.dotx)

```csharp
public static FileType DOTX { get; }
```

### Equals
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FileType` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

### Extension
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/extension.md

#### FileType.Extension property

Gets filename suffix (including the period "."), for instance ".doc".

```csharp
public string Extension { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/fileformat.md

#### FileType.FileFormat property

Gets file type name, for example "Microsoft Word Document".

```csharp
public string FileFormat { get; }
```

### FromExtension
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/fromextension.md

#### FileType.FromExtension method

Maps file extension to file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension (including the period "."). |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty string. |

### GetHashCode
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns the hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns sequence of supported file types

### GIF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/gif.md

#### FileType.GIF property

Graphical Interchange Format File (.gif)

```csharp
public static FileType GIF { get; }
```

### HTM
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/htm.md

#### FileType.HTM property

Hypertext Markup Language File (.htm)

```csharp
public static FileType HTM { get; }
```

### HTML
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/html.md

#### FileType.HTML property

Hypertext Markup Language File (.html)

```csharp
public static FileType HTML { get; }
```

### JP2
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/jp2.md

#### FileType.JP2 property

JPEG 2000 Core Image File (.jp2)

```csharp
public static FileType JP2 { get; }
```

### JPEG
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/jpeg.md

#### FileType.JPEG property

JPEG Image (.jpeg)

```csharp
public static FileType JPEG { get; }
```

### JPG
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/jpg.md

#### FileType.JPG property

JPEG Image (.jpg)

```csharp
public static FileType JPG { get; }
```

### MD
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/md.md

#### FileType.MD property

Markdown Documentation File (.md)

```csharp
public static FileType MD { get; }
```

### NUMBERS
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/numbers.md

#### FileType.NUMBERS property

Apple Numbers Spreadsheet (.numbers)

```csharp
public static FileType NUMBERS { get; }
```

### ODP
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/odp.md

#### FileType.ODP property

OpenDocument Presentation (.odp)

```csharp
public static FileType ODP { get; }
```

### ODS
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/ods.md

#### FileType.ODS property

OpenDocument Spreadsheet (.ods)

```csharp
public static FileType ODS { get; }
```

### ODT
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/odt.md

#### FileType.ODT property

OpenDocument Text Document (.odt)

```csharp
public static FileType ODT { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

### OTS
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/ots.md

#### FileType.OTS property

OpenDocument Spreadsheet Template (.ots)

```csharp
public static FileType OTS { get; }
```

### OTT
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/ott.md

#### FileType.OTT property

OpenDocument Document Template (.ott)

```csharp
public static FileType OTT { get; }
```

### PDF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/pdf.md

#### FileType.PDF property

Portable Document Format File (.pdf)

```csharp
public static FileType PDF { get; }
```

### PNG
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/png.md

#### FileType.PNG property

Portable Network Graphic (.png)

```csharp
public static FileType PNG { get; }
```

### PPT
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/ppt.md

#### FileType.PPT property

PowerPoint Presentation (.ppt)

```csharp
public static FileType PPT { get; }
```

### PPTX
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/pptx.md

#### FileType.PPTX property

PowerPoint Open XML Presentation (.pptx)

```csharp
public static FileType PPTX { get; }
```

### RTF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/rtf.md

#### FileType.RTF property

Rich Text Format File (.rtf)

```csharp
public static FileType RTF { get; }
```

### TIF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/tif.md

#### FileType.TIF property

Tagged Image File (.tif)

```csharp
public static FileType TIF { get; }
```

### TIFF
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/tiff.md

#### FileType.TIFF property

Tagged Image File Format (.tiff)

```csharp
public static FileType TIFF { get; }
```

### ToString
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TSV
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/tsv.md

#### FileType.TSV property

Tab Separated Values File (.tsv)

```csharp
public static FileType TSV { get; }
```

### TXT
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/txt.md

#### FileType.TXT property

Plain Text File (.txt)

```csharp
public static FileType TXT { get; }
```

### Unknown
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/unknown.md

#### FileType.Unknown property

Represents unknown file type.

```csharp
public static FileType Unknown { get; }
```

### XLS
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/xls.md

#### FileType.XLS property

Excel Spreadsheet (.xls)

```csharp
public static FileType XLS { get; }
```

### XLSB
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/xlsb.md

#### FileType.XLSB property

Excel Binary Spreadsheet (.xlsb)

```csharp
public static FileType XLSB { get; }
```

### XLSM
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/xlsm.md

#### FileType.XLSM property

Excel Open XML Macro-Enabled Spreadsheet (.xlsm)

```csharp
public static FileType XLSM { get; }
```

### XLSX
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/filetype/xlsx.md

#### FileType.XLSX property

Microsoft Excel Open XML Spreadsheet (.xlsx)

```csharp
public static FileType XLSX { get; }
```

### IDocumentInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/idocumentinfo.md

#### IDocumentInfo interface

Defines methods that are required for getting basic document information.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the file format description. |
| PageCount { get; } | Gets the total page count. |
| Pages { get; } | Gets the list of `PageInfo` page information. |
| Size { get; } | Gets the document size in bytes. |

##### Examples

The following example demonstrates how to retrieve the general document information using `IDocumentInfo`.

```csharp
    try
    {
        using (Redactor red = new Redactor(@"C:\Temp\testfile.doc"))
        {
            IDocumentInfo docInfo = red.GetDocumentInfo();
            Console.WriteLine("Document size: {0}", docInfo.Size);
            Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
            Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
            foreach (PageInfo page in docInfo.Pages)
            {
                Console.WriteLine("Page {0} size is {1}x{2}", page.PageNumber, page.Width, page.Height);
            }
        }
    }
    catch (GroupDocs.Redaction.Exceptions.PasswordRequiredException)
    {
        Console.WriteLine("You are trying to access document which is password protected. Please, set the password.");
    }
    catch (GroupDocs.Redaction.Exceptions.IncorrectPasswordException)
    {
        Console.WriteLine("The provided password is not valid.");
    }
```

### FileType
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Gets the file format description.

```csharp
public FileType FileType { get; }
```

### PageCount
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Gets the total page count.

```csharp
public int PageCount { get; }
```

### Pages
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Gets the list of `PageInfo` page information.

```csharp
public IList<PageInfo> Pages { get; }
```

### Size
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/idocumentinfo/size.md

#### IDocumentInfo.Size property

Gets the document size in bytes.

```csharp
public long Size { get; }
```

### License
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/license.md

#### License class

Provides methods for applying license.

```csharp
public class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initialize an instance of License class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Sets the GroupDocs.Redaction license from a stream. |
| SetLicense(string) | Sets the GroupDocs.Redaction license from a file path. |

##### Examples

The following example demonstrates how to set the license for GroupDocs.Redaction.

```csharp
GroupDocs.Redaction.License license = new GroupDocs.Redaction.License();
// as an alternative you can use a stream:
license.SetLicense(licensePath);
```

### License
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/license/license.md

#### License constructor

Initialize an instance of License class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/license/setlicense.md

#### SetLicense(string)

Sets the GroupDocs.Redaction license from a file path.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | License file path. |

#### SetLicense(Stream)

Sets the GroupDocs.Redaction license from a stream.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | License stream. |

### Metered
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/metered.md

#### Metered class

Provides methods which allow to activate product with Metered license and retrieve amount of MBs processed. Learn more about Metered licenses [here](https://purchase.groupdocs.com/faqs/licensing/metered).

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Initializes a new instance of Metered class. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Activates the product with Metered keys. |
| static GetConsumptionCredit() | Gets the consumption credit. |
| static GetConsumptionQuantity() | Retrieves the amount of MBs processed. |

##### Examples

The following example demonstrates how to activate the product with Metered keys.

```csharp
[C#]

Metered matered = new Metered();
matered.SetMeteredKey("PublicKey", "PrivateKey");


[Visual Basic]

Dim matered As Metered = New Metered
matered.SetMeteredKey("PublicKey", "PrivateKey")
```

the component jar file:

```csharp
Metered matered = new Metered();
matered.setMeteredKey("PublicKey", "PrivateKey");
```

### GetConsumptionCredit
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Gets the consumption credit.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

consumption quantity

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Retrieves the amount of MBs processed.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

consumption quantity

##### Examples

The following example demonstrates how to retrieve the 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/redaction/net/groupdocs.redaction/metered/metered.md

#### Metered constructor

Initializes a new instance of Metered class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/metered/setmeteredkey.md

#### Metered.SetMeteredKey method

Activates the 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

The following example demonstrates how to activate the product with Metered keys.

```csharp
string publicKey = "Public Key";
string privateKey = "Private Key";

Metered metered = new Metered();
metered.SetMeteredKey(publicKey, privateKey);
```

### PageInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/pageinfo.md

#### PageInfo class

Represents a brief page information.

```csharp
public class PageInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PageInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Gets or sets the page height. |
| PageNumber { get; set; } | Gets or sets the page number. |
| Width { get; set; } | Gets or sets the page width. |

##### Examples

The following example demonstrates how to retrieve the general document information using `IDocumentInfo`.

```csharp
    try
    {
        using (Redactor red = new Redactor(@"C:\Temp\testfile.doc"))
        {
            IDocumentInfo docInfo = red.GetDocumentInfo();
            Console.WriteLine("Document size: {0}", docInfo.Size);
            Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
            Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
            foreach (PageInfo page in docInfo.Pages)
            {
                Console.WriteLine("Page {0} size is {1}x{2}", page.PageNumber, page.Width, page.Height);
            }
        }
    }
    catch (GroupDocs.Redaction.Exceptions.PasswordRequiredException)
    {
        Console.WriteLine("You are trying to access document which is password protected. Please, set the password.");
    }
    catch (GroupDocs.Redaction.Exceptions.IncorrectPasswordException)
    {
        Console.WriteLine("The provided password is not valid.");
    }
```

### Height
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/pageinfo/height.md

#### PageInfo.Height property

Gets or sets the page height.

```csharp
public int Height { get; set; }
```

### PageInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/pageinfo/pageinfo.md

#### PageInfo constructor

The default constructor.

```csharp
public PageInfo()
```

### PageNumber
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Gets or sets the page number.

```csharp
public int PageNumber { get; set; }
```

### Width
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/pageinfo/width.md

#### PageInfo.Width property

Gets or sets the page width.

```csharp
public int Width { get; set; }
```

### Redaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redaction.md

#### Redaction class

Represents a base abstract class for all redaction types.

```csharp
public abstract class Redaction
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Description { get; } | Returns a string, describing the redaction and its parameters. |

#### Methods

| Name | Description |
| --- | --- |
| abstract ApplyTo(DocumentFormatInstance) | Applies the redaction to a given format instance. |

### ApplyTo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redaction/applyto.md

#### Redaction.ApplyTo method

Applies the redaction to a given format instance.

```csharp
public abstract RedactorLogEntry ApplyTo(DocumentFormatInstance formatInstance)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |

##### Return Value

Status of the redaction: success/failure and error message if any

### Description
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redaction/description.md

#### Redaction.Description property

Returns a string, describing the redaction and its parameters.

```csharp
public virtual string Description { get; }
```

##### Return Value

Text, containing redaction name and parameters.

### RedactionPolicy
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionpolicy.md

#### RedactionPolicy class

Represents a sanitization policy, containing a set of specific redactions to apply.

```csharp
public class RedactionPolicy
```

#### Constructors

| Name | Description |
| --- | --- |
| RedactionPolicy() | Creates a new instance of Redaction policy. |
| RedactionPolicy(Redaction[]) | Creates a new instance of Redaction policy with a specific list of redactions. |

#### Properties

| Name | Description |
| --- | --- |
| Redactions { get; } | Gets an array of fully configured `Redaction`-derived classes. |

#### Methods

| Name | Description |
| --- | --- |
| static Load(Stream) | Loads an instance of `RedactionPolicy` from a stream. |
| static Load(string) | Loads an instance of `RedactionPolicy` from a file path. |
| Save(Stream) | Saves the redaction policy to a stream. |
| Save(string) | Saves the redaction policy to a file. |

##### Examples

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

```csharp
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml");
foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) 
{
     using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry)))
     {
    	     RedactorChangeLog result = redactor.Apply(policy);
    	     String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\";
    	     using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite))
   	     {
               redactor.Save(fileStream, new RasterizationOptions() { Enabled = false });
   	     }        
     }
}   
```

The following example contains a sample XML policy file with sample configurations for all types of redactions.

```csharp
<?xml version="1.0" encoding="utf-8"?>  
<redactionPolicy xmlns = "http://www.groupdocs.com/redaction" >
  <regexRedaction regularExpression="(dolor)" actionType="ReplaceString" replacement="foobar" />  
  <exactPhraseRedaction searchPhrase = "dolor" caseSensitive="true" actionType="DrawBox" color="Red" />   
  
  <cellColumnRedaction regularExpression = "(foo)bar1" replacement="[red1]" columnIndex="1" worksheetIndex="2" /> 
  <cellColumnRedaction regularExpression = "(foo)bar2" replacement="[red2]" wokrsheetName="Sample" /> 
  
  <eraseMetadataRedaction filter = "All" />
  <metadataSearchRedaction filter="Title, Author" replacement="foobar" valueExpression="(metasearch)" keyExpression="" />  
  
 <annotationRedaction regularExpression = "(anno1)" replacement="foobar" />  
 <deleteAnnotationRedaction regularExpression = "(anno2)" />

 <imageAreaRedaction pointX="15" pointY="17" width="200" height="10" color="#AA50FC"  />  
 <imageAreaRedaction pointX = "110" pointY="120" width="60" height="20" color="Magenta"  />  
</redactionPolicy>
```

### Load
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionpolicy/load.md

#### Load(string)

Loads an instance of `RedactionPolicy` from a file path.

```csharp
public static RedactionPolicy Load(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Path to XML file |

##### Return Value

Redaction policy

##### Examples

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

```csharp
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml");
foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) 
{
     using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry)))
     {
    	     RedactorChangeLog result = redactor.Apply(policy);
    	     String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\";
    	     using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite))
   	     {
               redactor.Save(fileStream, new RasterizationOptions() { Enabled = false });
   	     }        
     }
}   
```

The following example contains a sample XML policy file with sample configurations for all types of redactions.

```csharp
<?xml version="1.0" encoding="utf-8"?>  
<redactionPolicy xmlns = "http://www.groupdocs.com/redaction" >
  <regexRedaction regularExpression="(dolor)" actionType="ReplaceString" replacement="foobar" />  
  <exactPhraseRedaction searchPhrase = "dolor" caseSensitive="true" actionType="DrawBox" color="Red" />   
  
  <cellColumnRedaction regularExpression = "(foo)bar1" replacement="[red1]" columnIndex="1" worksheetIndex="2" /> 
  <cellColumnRedaction regularExpression = "(foo)bar2" replacement="[red2]" wokrsheetName="Sample" /> 
  
  <eraseMetadataRedaction filter = "All" />
  <metadataSearchRedaction filter="Title, Author" replacement="foobar" valueExpression="(metasearch)" keyExpression="" />  
  
 <annotationRedaction regularExpression = "(anno1)" replacement="foobar" />  
 <deleteAnnotationRedaction regularExpression = "(anno2)" />

 <imageAreaRedaction pointX="15" pointY="17" width="200" height="10" color="#AA50FC"  />  
 <imageAreaRedaction pointX = "110" pointY="120" width="60" height="20" color="Magenta"  />  
</redactionPolicy>
```

#### Load(Stream)

Loads an instance of `RedactionPolicy` from a stream.

```csharp
public static RedactionPolicy Load(Stream input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | Stream | Stream containing XML configuration |

##### Return Value

Redaction policy

##### Examples

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

```csharp
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml");
foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) 
{
     using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry)))
     {
    	     RedactorChangeLog result = redactor.Apply(policy);
    	     String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\";
    	     using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite))
   	     {
               redactor.Save(fileStream, new RasterizationOptions() { Enabled = false });
   	     }        
     }
}   
```

The following example contains a sample XML policy file with sample configurations for all types of redactions.

```csharp
<?xml version="1.0" encoding="utf-8"?>  
<redactionPolicy xmlns = "http://www.groupdocs.com/redaction" >
  <regexRedaction regularExpression="(dolor)" actionType="ReplaceString" replacement="foobar" />  
  <exactPhraseRedaction searchPhrase = "dolor" caseSensitive="true" actionType="DrawBox" color="Red" />   
  
  <cellColumnRedaction regularExpression = "(foo)bar1" replacement="[red1]" columnIndex="1" worksheetIndex="2" /> 
  <cellColumnRedaction regularExpression = "(foo)bar2" replacement="[red2]" wokrsheetName="Sample" /> 
  
  <eraseMetadataRedaction filter = "All" />
  <metadataSearchRedaction filter="Title, Author" replacement="foobar" valueExpression="(metasearch)" keyExpression="" />  
  
 <annotationRedaction regularExpression = "(anno1)" replacement="foobar" />  
 <deleteAnnotationRedaction regularExpression = "(anno2)" />

 <imageAreaRedaction pointX="15" pointY="17" width="200" height="10" color="#AA50FC"  />  
 <imageAreaRedaction pointX = "110" pointY="120" width="60" height="20" color="Magenta"  />  
</redactionPolicy>
```

### RedactionPolicy
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionpolicy/redactionpolicy.md

#### RedactionPolicy()

Creates a new instance of Redaction policy.

```csharp
public RedactionPolicy()
```

#### RedactionPolicy(Redaction[])

Creates a new instance of Redaction policy with a specific list of redactions.

```csharp
public RedactionPolicy(Redaction[] redactions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redactions | Redaction[] | An array of redactions for the policy |

### Redactions
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionpolicy/redactions.md

#### RedactionPolicy.Redactions property

Gets an array of fully configured `Redaction`-derived classes.

```csharp
public Redaction[] Redactions { get; }
```

### Save
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionpolicy/save.md

#### Save(string)

Saves the redaction policy to a file.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Path to file. |

#### Save(Stream)

Saves the redaction policy to a stream.

```csharp
public void Save(Stream output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | Stream | Target stream to save the policy |

### RedactionResult
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult.md

#### RedactionResult class

Represents a result of the redaction operation.

```csharp
public class RedactionResult
```

#### Properties

| Name | Description |
| --- | --- |
| ErrorMessage { get; } | Gets the error message for diagnostics. |
| Status { get; } | Gets the execution status. |

#### Methods

| Name | Description |
| --- | --- |
| static Failed(string) | Initializes a new instance of RedactionResult class with Failed status. |
| static Partial(string) | Initializes a new instance of RedactionResult class with PartiallyApplied status. |
| static Skipped(string) | Initializes a new instance of RedactionResult class with Skipped status. |
| static Successful() | Initializes a new instance of RedactionResult class with Applied (successful) status. |

### ErrorMessage
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/errormessage.md

#### RedactionResult.ErrorMessage property

Gets the error message for diagnostics.

```csharp
public string ErrorMessage { get; }
```

### Failed
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/failed.md

#### RedactionResult.Failed method

Initializes a new instance of RedactionResult class with Failed status.

```csharp
public static RedactionResult Failed(string description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | Failure or exception details |

##### Return Value

Failed redaction result

### Partial
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/partial.md

#### RedactionResult.Partial method

Initializes a new instance of RedactionResult class with PartiallyApplied status.

```csharp
public static RedactionResult Partial(string description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | Reason why the operation was not fully applied |

##### Return Value

Partially applied redaction result

### Skipped
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/skipped.md

#### RedactionResult.Skipped method

Initializes a new instance of RedactionResult class with Skipped status.

```csharp
public static RedactionResult Skipped(string description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| description | String | Reason why the operation was skipped |

##### Return Value

Skipped redaction result

### Status
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/status.md

#### RedactionResult.Status property

Gets the execution status.

```csharp
public RedactionStatus Status { get; }
```

### Successful
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionresult/successful.md

#### RedactionResult.Successful method

Initializes a new instance of RedactionResult class with Applied (successful) status.

```csharp
public static RedactionResult Successful()
```

##### Return Value

Successful redaction result

### RedactionStatus
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactionstatus.md

#### RedactionStatus enumeration

Represents a redaction completion status.

```csharp
public enum RedactionStatus
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Applied | `0` | Redaction was fully and successfully applied. |
| PartiallyApplied | `1` | Redaction was applied only to a part of its matches. |
| Skipped | `2` | Redaction was skipped (not applied). |
| Failed | `3` | Redaction failed with exception. |

### Redactor
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor.md

#### Redactor class

Represents a main class that controls document redaction process, allowing to open, redact and save documents.

```csharp
public sealed class Redactor : IDisposable, IPreviewable
```

#### Constructors

| Name | Description |
| --- | --- |
| Redactor(Stream) | Initializes a new instance of `Redactor` class using stream. |
| Redactor(string) | Initializes a new instance of `Redactor` class using file path. |
| Redactor(Stream, LoadOptions) | Initializes a new instance of `Redactor` class for a password-protected document using stream. |
| Redactor(string, LoadOptions) | Initializes a new instance of `Redactor` class for a password-protected document using its path. |
| Redactor(Stream, LoadOptions, RedactorSettings) | Initializes a new instance of `Redactor` class for a password-protected document using stream and settings. |
| Redactor(string, LoadOptions, RedactorSettings) | Initializes a new instance of `Redactor` class for a password-protected document using its path and settings. |

#### Methods

| Name | Description |
| --- | --- |
| Apply(Redaction) | Applies a redaction to the document. |
| Apply(RedactionPolicy) | Applies a redaction policy to the document. |
| Apply(Redaction[]) | Applies a set of redactions to the document. |
| Dispose() | Releases resources. |
| GeneratePreview(PreviewOptions) | Generates preview images of specific pages in a given image format. |
| GetDocumentInfo() | Gets the general information about the document - size, page count, etc. |
| Save() | Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true. |
| Save(SaveOptions) | Saves the document to a file. |
| Save(Stream, RasterizationOptions) | Saves the document to a stream, including custom location. |

##### Examples

The following example demonstrates applying a single redaction to the document.

```csharp
using (Redactor redactor = new Redactor(@"D:\\test.docx"))
{
   RedactorChangeLog result = redactor.Apply(new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]")));
   if (result.Status != RedactionStatus.Failed)
   {
      redactor.Save();
   };
}
```

The following example demonstrates applying a list of redactions to the document.

```csharp
using (Redactor redactor = new Redactor(@"D:\\test.docx"))
{
   var redactionList = new Redaction[] 
   {
      new ExactPhraseRedaction(LookupStrings.ClientName, new ReplacementOptions("[client]")),
      new ExactPhraseRedaction(LookupStrings.ClientAddress, new ReplacementOptions(System.Drawing.Color.Red)),
      new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]")),
      new RegexRedaction(LookupStrings.BankCardRegexPattern, new ReplacementOptions(System.Drawing.Color.Blue)),
      // ... other redactions
      new DeleteAnnotationRedaction("(?im:(use|show|describe))"),
      new EraseMetadataRedaction(MetadataFilter.Author),
      new MetadataSearchRedaction(LookupStrings.CompanyName, "--company--") 
   }; 
   RedactorChangeLog result = redactor.Apply(redactionList);
   // false, if at least one redaction failed
   if (result.Status != RedactionStatus.Failed)
   {
      redactor.Save();
   };
}
```

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

```csharp
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml");
foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) 
{
     using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry)))
     {
    	     RedactorChangeLog result = redactor.Apply(policy);
    	     String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\";
    	     using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite))
   	     {
               redactor.Save(fileStream, new RasterizationOptions() { Enabled = false });
   	     }        
     }
}   
```

The following example demonstrates how to open a password-protected documents using LoadOptions.

```csharp
LoadOptions loadOptions = new LoadOptions("mypassword");
using (Redactor redactor = new Redactor(@"C:\sample.pdf", loadOptions))
{
    // Here we can use document instance to perform redactions
}
```

The following example demonstrates how to save a document using SaveOptions.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
    {
       // Document redaction goes here
       // ...
    
       // Save the document with default options (convert pages into images, save as PDF)
       redactor.Save();
    
       // Save the document in original format overwriting original file
       redactor.Save(new SaveOptions() { AddSuffix = false, RasterizeToPDF = false });
    
       // Save the document to "*_Redacted.*" file in original format
       redactor.Save(new SaveOptions() { AddSuffix = true, RasterizeToPDF = false });
    
       // Save the document to "*_AnyText.*" (e.g. timestamp instead of "AnyText") in its file name without rasterization
       redactor.Save(new SaveOptions(false, "AnyText"));
    }    
```

### Apply
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/apply.md

#### Apply(Redaction)

Applies a redaction to the document.

```csharp
public RedactorChangeLog Apply(Redaction redaction)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redaction | Redaction | An instance of `Redaction` to apply |

##### Return Value

Success or failure and error message in this case

##### Examples

The following example demonstrates applying a single redaction to the document.

```csharp
using (Redactor redactor = new Redactor(@"D:\\test.docx"))
{
   RedactorChangeLog result = redactor.Apply(new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]")));
   if (result.Status != RedactionStatus.Failed)
   {
      redactor.Save();
   };
}
```

#### Apply(Redaction[])

Applies a set of redactions to the document.

```csharp
public RedactorChangeLog Apply(Redaction[] redactions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redactions | Redaction[] | An array of redactions to apply |

##### Return Value

Success or failure and error message in this case

##### Examples

The following example demonstrates applying a list of redactions to the document.

```csharp
using (Redactor redactor = new Redactor(@"D:\\test.docx"))
{
   var redactionList = new Redaction[] 
   {
      new ExactPhraseRedaction(LookupStrings.ClientName, new ReplacementOptions("[client]")),
      new ExactPhraseRedaction(LookupStrings.ClientAddress, new ReplacementOptions(System.Drawing.Color.Red)),
      new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]")),
      new RegexRedaction(LookupStrings.BankCardRegexPattern, new ReplacementOptions(System.Drawing.Color.Blue)),
      // ... other redactions
      new DeleteAnnotationRedaction("(?im:(use|show|describe))"),
      new EraseMetadataRedaction(MetadataFilter.Author),
      new MetadataSearchRedaction(LookupStrings.CompanyName, "--company--") 
   }; 
   RedactorChangeLog result = redactor.Apply(redactionList);
   // false, if at least one redaction failed
   if (result.Status != RedactionStatus.Failed)
   {
      redactor.Save();
   };
}
```

#### Apply(RedactionPolicy)

Applies a redaction policy to the document.

```csharp
public RedactorChangeLog Apply(RedactionPolicy policy)
```

| Parameter | Type | Description |
| --- | --- | --- |
| policy | RedactionPolicy | Redaction policy |

##### Return Value

Success or failure and error message in this case

##### Examples

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

```csharp
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml");
foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) 
{
     using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry)))
     {
    	     RedactorChangeLog result = redactor.Apply(policy);
    	     String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\";
    	     using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite))
   	     {
               redactor.Save(fileStream, new RasterizationOptions() { Enabled = false });
   	     }        
     }
}   
```

### Dispose
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/dispose.md

#### Redactor.Dispose method

Releases resources.

```csharp
public void Dispose()
```

### GeneratePreview
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/generatepreview.md

#### Redactor.GeneratePreview method

Generates preview images of specific pages in a given image format.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | Image properties and page range settings |

##### Examples

The following example demonstrates how get a document preview using `PreviewOptions` and both delegates.

```csharp
    CreatePageStream createDelegate = delegate (int pageNumber)
    {
        var pagePath = System.IO.Path.Combine(@"C:\Temp", string.Format("page_{0}.png", pageNumber));
        return System.IO.File.Create(pagePath);
    };
    ReleasePageStream releaseDelegate = delegate (int pageNumber, System.IO.Stream pageStream)
    {
        // do anything with Stream, containing page preview
        pageStream.Close();
    };
    var previewOptions = new PreviewOptions(createDelegate, releaseDelegate);
    previewOptions.PreviewFormat = PreviewOptions.PreviewFormats.PNG;
    previewOptions.Height = 640;
    previewOptions.Width = 480;
    previewOptions.PageNumbers = new int[] { 1 };
    using (var redactor = new Redactor("C:\Temp\SourceFile.pdf"))
    {
        redactor.GeneratePreview(previewOptions);
    }
```

### GetDocumentInfo
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/getdocumentinfo.md

#### Redactor.GetDocumentInfo method

Gets the general information about the document - size, page count, etc.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

An instance of IDocumentInfo

##### Examples

The following example demonstrates how to retrieve the general document information using `IDocumentInfo`.

```csharp
    try
    {
        using (Redactor red = new Redactor(@"C:\Temp\testfile.doc"))
        {
            IDocumentInfo docInfo = red.GetDocumentInfo();
            Console.WriteLine("Document size: {0}", docInfo.Size);
            Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
            Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
            foreach (PageInfo page in docInfo.Pages)
            {
                Console.WriteLine("Page {0} size is {1}x{2}", page.PageNumber, page.Width, page.Height);
            }
        }
    }
    catch (GroupDocs.Redaction.Exceptions.PasswordRequiredException)
    {
        Console.WriteLine("You are trying to access document which is password protected. Please, set the password.");
    }
    catch (GroupDocs.Redaction.Exceptions.IncorrectPasswordException)
    {
        Console.WriteLine("The provided password is not valid.");
    }
```

### Redactor
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/redactor.md

#### Redactor(string)

Initializes a new instance of `Redactor` class using file path.

```csharp
public Redactor(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Path to the file |

##### Examples

The following example demonstrates how to open a document for redaction.

```csharp
using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
{
    // Here we can use document instance to perform redactions
}
```

#### Redactor(Stream)

Initializes a new instance of `Redactor` class using stream.

```csharp
public Redactor(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source stream of the document |

##### Examples

The following example demonstrates how to open a document from stream.

```csharp
using (Stream stream = File.Open(@"C:\\sample.pdf", FileMode.Open, FileAccess.ReadWrite))
{
    using (Redactor redactor = new Redactor(stream))
    {
        // Here we can use document instance to perform redactions
    }
}
```

#### Redactor(string, LoadOptions)

Initializes a new instance of `Redactor` class for a password-protected document using its path.

```csharp
public Redactor(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Path to file. |
| loadOptions | LoadOptions | Options, including password. |

#### Redactor(string, LoadOptions, RedactorSettings)

Initializes a new instance of `Redactor` class for a password-protected document using its path and settings.

```csharp
public Redactor(string filePath, LoadOptions loadOptions, RedactorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Path to file. |
| loadOptions | LoadOptions | File-dependent options, including password. |
| settings | RedactorSettings | Default settings for redaction process. |

#### Redactor(Stream, LoadOptions)

Initializes a new instance of `Redactor` class for a password-protected document using stream.

```csharp
public Redactor(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source input stream. |
| loadOptions | LoadOptions | Options, including password. |

##### Examples

The following example demonstrates how to open a password-protected documents using LoadOptions.

```csharp
LoadOptions loadOptions = new LoadOptions("mypassword");
using (Redactor redactor = new Redactor(@"C:\sample.pdf", loadOptions))
{
    // Here we can use document instance to perform redactions
}
```

#### Redactor(Stream, LoadOptions, RedactorSettings)

Initializes a new instance of `Redactor` class for a password-protected document using stream and settings.

```csharp
public Redactor(Stream document, LoadOptions loadOptions, RedactorSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Source input stream. |
| loadOptions | LoadOptions | Options, including password. |
| settings | RedactorSettings | Default settings for redaction process. |

##### Examples

The following example demonstrates how to open a password-protected documents using LoadOptions.

```csharp
LoadOptions loadOptions = new LoadOptions("mypassword");
using (Redactor redactor = new Redactor(@"C:\sample.pdf", loadOptions))
{
    // Here we can use document instance to perform redactions
}
```

### Save
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactor/save.md

#### Save()

Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.

```csharp
public string Save()
```

##### Return Value

Path to redacted document

#### Save(SaveOptions)

Saves the document to a file.

```csharp
public string Save(SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | SaveOptions | Options to add suffix or rasterize |

##### Return Value

Path to redacted document

##### Examples

The following example demonstrates how to save a document using SaveOptions.

```csharp
    using (Redactor redactor = new Redactor(@"C:\sample.pdf"))
    {
       // Document redaction goes here
       // ...
    
       // Save the document with default options (convert pages into images, save as PDF)
       redactor.Save();
    
       // Save the document in original format overwriting original file
       redactor.Save(new SaveOptions() { AddSuffix = false, RasterizeToPDF = false });
    
       // Save the document to "*_Redacted.*" file in original format
       redactor.Save(new SaveOptions() { AddSuffix = true, RasterizeToPDF = false });
    
       // Save the document to "*_AnyText.*" (e.g. timestamp instead of "AnyText") in its file name without rasterization
       redactor.Save(new SaveOptions(false, "AnyText"));
    }    
```

#### Save(Stream, RasterizationOptions)

Saves the document to a stream, including custom location.

```csharp
public void Save(Stream document, RasterizationOptions rasterizationOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | Target stream |
| rasterizationOptions | RasterizationOptions | Options to rasterize or not and to specify pages for rasterization |

##### Examples

The following example demonstrates how to set options for the rasterization process.

```csharp
    using (var redactor = new Redactor("SomePresentation.pptx"))
    {
        // redact sensitive data on the first slide 
    
        var rasterizationOptions = new RasterizationOptions();
        rasterizationOptions.PageIndex = 0;
        rasterizationOptions.PageCount = 1;
        rasterizationOptions.Compliance = PdfComplianceLevel.PdfA1a;
        using (var stream = File.Open(Path.Combine(@"C:\Temp", "PresentationFirstSlide.pdf")))
        {
            redactor.Save(stream, rasterizationOptions);
        }
    }      
```

### RedactorChangeLog
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorchangelog.md

#### RedactorChangeLog class

Represents results for a list of redactions, passed to Apply() method of `Redactor` class.

```csharp
public class RedactorChangeLog
```

#### Constructors

| Name | Description |
| --- | --- |
| RedactorChangeLog() | Initializes a new instance of RedactorChangeLog class. |

#### Properties

| Name | Description |
| --- | --- |
| RedactionLog { get; } | Gets the list of `RedactorLogEntry` instances. |
| Status { get; } | Gets the final status of all applied redactions. |

### RedactionLog
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorchangelog/redactionlog.md

#### RedactorChangeLog.RedactionLog property

Gets the list of `RedactorLogEntry` instances.

```csharp
public List<RedactorLogEntry> RedactionLog { get; }
```

### RedactorChangeLog
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorchangelog/redactorchangelog.md

#### RedactorChangeLog constructor

Initializes a new instance of RedactorChangeLog class.

```csharp
public RedactorChangeLog()
```

### Status
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorchangelog/status.md

#### RedactorChangeLog.Status property

Gets the final status of all applied redactions.

```csharp
public RedactionStatus Status { get; }
```

### RedactorLogEntry
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorlogentry.md

#### RedactorLogEntry class

Represents results of applying redaction.

```csharp
public class RedactorLogEntry
```

#### Constructors

| Name | Description |
| --- | --- |
| RedactorLogEntry(Redaction, RedactionResult) | Initializes a new instance of RedactorLogEntry class for redaction. |

#### Properties

| Name | Description |
| --- | --- |
| Redaction { get; } | Gets the reference to redaction and its options. |
| Result { get; } | Gets the result, returned by `DocumentFormatInstance`. |

### Redaction
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorlogentry/redaction.md

#### RedactorLogEntry.Redaction property

Gets the reference to redaction and its options.

```csharp
public Redaction Redaction { get; }
```

### RedactorLogEntry
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorlogentry/redactorlogentry.md

#### RedactorLogEntry constructor

Initializes a new instance of RedactorLogEntry class for redaction.

```csharp
public RedactorLogEntry(Redaction redaction, RedactionResult result)
```

| Parameter | Type | Description |
| --- | --- | --- |
| redaction | Redaction | Reference to redaction |
| result | RedactionResult | Redaction result, reported by format handler |

### Result
Path: https://reference.groupdocs.com/redaction/net/groupdocs.redaction/redactorlogentry/result.md

#### RedactorLogEntry.Result property

Gets the result, returned by `DocumentFormatInstance`.

```csharp
public RedactionResult Result { get; }
```

## Python

### GroupDocs.Redaction for Python via .NET
Path: https://reference.groupdocs.com/redaction/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.redaction` | Main GroupDocs.Redaction namespace with top-level API classes. |
| `groupdocs.redaction.configuration` | Types under `groupdocs.redaction.configuration`. |
| `groupdocs.redaction.integration` | Types under `groupdocs.redaction.integration`. |
| `groupdocs.redaction.integration.ocr` | Types under `groupdocs.redaction.integration.ocr`. |
| `groupdocs.redaction.options` | Option classes for configuring conversions and operations. |
| `groupdocs.redaction.redactions` | Types under `groupdocs.redaction.redactions`. |

### groupdocs.redaction.configuration
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration.md

Types under `groupdocs.redaction.configuration`.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentFormatConfiguration` |  |
| `RedactorConfiguration` |  |

### DocumentFormatConfiguration class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration.md

#### DocumentFormatConfiguration class

The DocumentFormatConfiguration type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _supports_extension_string |  |
| supports_extension |  |
| supports_extension_file |  |
| supports_extension_string |  |

##### Properties
| Property | Description |
| :- | :- |
| document_type |  |
| extension_filter |  |
| initialization_data |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _supports_extension_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/_supports_extension_string.md

#### _supports_extension_string

```python
def _supports_extension_string(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |

**Returns:** bool

### document_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/document_type.md

##### Definition:
```python
@property
def document_type(self):
    ...
@document_type.setter
def document_type(self, value):
    ...
```

### extension_filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/extension_filter.md

##### Definition:
```python
@property
def extension_filter(self):
    ...
@extension_filter.setter
def extension_filter(self, value):
    ...
```

### initialization_data property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/initialization_data.md

##### Definition:
```python
@property
def initialization_data(self):
    ...
@initialization_data.setter
def initialization_data(self, value):
    ...
```

### supports_extension method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/supports_extension.md

#### supports_extension

```python
def supports_extension(self):
    ...
```

### supports_extension_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/supports_extension_file.md

#### supports_extension_file

```python
def supports_extension_file(self):
    ...
```

### supports_extension_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/documentformatconfiguration/supports_extension_string.md

#### supports_extension_string

```python
def supports_extension_string(self):
    ...
```

### RedactorConfiguration class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration.md

#### RedactorConfiguration class

The RedactorConfiguration type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _find_format_string |  |
| find_format |  |
| find_format_file |  |
| find_format_string |  |
| get_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| available_formats |  |

### _find_format_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/_find_format_string.md

#### _find_format_string

```python
def _find_format_string(self, file_extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_extension | `str` |  |

**Returns:** DocumentFormatConfiguration

### available_formats property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/available_formats.md

##### Definition:
```python
@property
def available_formats(self):
    ...
```

### find_format method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/find_format.md

#### find_format

```python
def find_format(self):
    ...
```

### find_format_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/find_format_file.md

#### find_format_file

```python
def find_format_file(self):
    ...
```

### find_format_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/find_format_string.md

#### find_format_string

```python
def find_format_string(self):
    ...
```

### get_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.configuration/redactorconfiguration/get_instance.md

#### get_instance

```python
def get_instance(cls):
    ...
```

**Returns:** RedactorConfiguration

### groupdocs.redaction.exceptions
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions.md

The GroupDocs.Redaction namespace provides different exceptions classes.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentFormatException` | The exception that is thrown when document format is not recognized or is invalid. |
| `GroupDocsRedactionException` | Represents base exception for all GroupDocs.Redaction exceptions. |
| `IncorrectPasswordException` | The exception that is thrown when specified password is incorrect. |
| `PasswordRequiredException` | The exception that is thrown when password is required to load the document. |
| `TrialLimitationsException` | The exception that is thrown when user violates trial mode limitations. |

### DocumentFormatException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/documentformatexception.md

#### DocumentFormatException class

The exception that is thrown when document format is not recognized or is invalid.

**Inheritance:** `DocumentFormatException` →
`GroupDocsRedactionException`

The DocumentFormatException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, message)` | Initializes a new instance of DocumentFormatException class. |

### DocumentFormatException constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/documentformatexception/__init__.md

#### \_\_init\_\_(self, message)

Initializes a new instance of DocumentFormatException class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | str | Message, describing exception context |

### GroupDocsRedactionException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/groupdocsredactionexception.md

#### GroupDocsRedactionException class

Represents base exception for all GroupDocs.Redaction exceptions.

The GroupDocsRedactionException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, message)` | Initializes a new instance of GroupDocsRedactionException class. |

### GroupDocsRedactionException constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/groupdocsredactionexception/__init__.md

#### \_\_init\_\_(self, message)

Initializes a new instance of GroupDocsRedactionException class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | str | Message, describing exception context |

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

**Inheritance:** `IncorrectPasswordException` →
`GroupDocsRedactionException`

The IncorrectPasswordException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of IncorrectPasswordException class. |

### IncorrectPasswordException constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/incorrectpasswordexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of IncorrectPasswordException class.

```python

def __init__(self):
    ...
```

### PasswordRequiredException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

**Inheritance:** `PasswordRequiredException` →
`GroupDocsRedactionException`

The PasswordRequiredException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self)` | Initializes a new instance of PasswordRequiredException class. |

### PasswordRequiredException constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/passwordrequiredexception/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of PasswordRequiredException class.

```python

def __init__(self):
    ...
```

### TrialLimitationsException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/triallimitationsexception.md

#### TrialLimitationsException class

The exception that is thrown when user violates trial mode limitations.

**Inheritance:** `TrialLimitationsException` →
`GroupDocsRedactionException`

The TrialLimitationsException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| `__init__(self, message)` | Initializes a new instance of TrialLimitationsException class. |

### TrialLimitationsException constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.exceptions/triallimitationsexception/__init__.md

#### \_\_init\_\_(self, message)

Initializes a new instance of TrialLimitationsException class.

```python

def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | str | Message, describing violated limitation |

### groupdocs.redaction.integration.ocr
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr.md

Types under `groupdocs.redaction.integration.ocr`.

##### Classes
| Class | Description |
| :- | :- |
| `IOcrConnector` |  |
| `RecognizedImage` |  |
| `TextFragment` |  |
| `TextLine` |  |

### IOcrConnector class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/iocrconnector.md

#### IOcrConnector class

The IOcrConnector type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _recognize_stream |  |
| recognize |  |
| recognize_stream |  |
| recognize_streams |  |

### _recognize_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/iocrconnector/_recognize_stream.md

#### _recognize_stream

```python
def _recognize_stream(self, image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | `Stream` |  |

**Returns:** RecognizedImage

### recognize method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/iocrconnector/recognize.md

#### recognize

```python
def recognize(self):
    ...
```

### recognize_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/iocrconnector/recognize_stream.md

#### recognize_stream

```python
def recognize_stream(self):
    ...
```

### recognize_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/iocrconnector/recognize_streams.md

#### recognize_streams

```python
def recognize_streams(self):
    ...
```

### RecognizedImage class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage.md

#### RecognizedImage class

The RecognizedImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_ienumerable_1_bc85 |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| lines |  |
| text |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_ienumerable_1_bc85 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/_init_ienumerable_1_bc85.md

#### _init_ienumerable_1_bc85

```python
def _init_ienumerable_1_bc85(self, lines):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| lines | `List[Any]` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### lines property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/lines.md

##### Definition:
```python
@property
def lines(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/text.md

##### Definition:
```python
@property
def text(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/recognizedimage/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TextFragment class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment.md

#### TextFragment class

The TextFragment type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string_rectangle |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| rectangle |  |
| text |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string_rectangle method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/_init_string_rectangle.md

#### _init_string_rectangle

```python
def _init_string_rectangle(self, text, rectangle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` |  |
| rectangle | `Rectangle` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### rectangle property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/rectangle.md

##### Definition:
```python
@property
def rectangle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/text.md

##### Definition:
```python
@property
def text(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textfragment/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TextLine class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline.md

#### TextLine class

The TextLine type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_ienumerable_1_d_00d |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| fragments |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_ienumerable_1_d_00d method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline/_init_ienumerable_1_d_00d.md

#### _init_ienumerable_1_d_00d

```python
def _init_ienumerable_1_d_00d(self, fragments):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| fragments | `List[Any]` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### fragments property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline/fragments.md

##### Definition:
```python
@property
def fragments(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.ocr/textline/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### groupdocs.redaction.integration
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration.md

Types under `groupdocs.redaction.integration`.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentFormatInstance` |  |
| `IAnnotatedDocument` |  |
| `ICellularFormatInstance` |  |
| `IFixedFormatDocument` |  |
| `IImageFormatInstance` |  |
| `IMetadataAccess` |  |
| `IPaginatedDocument` |  |
| `IPreviewable` |  |
| `IRasterizableDocument` |  |
| `ITextualFormatInstance` |  |
| `MetadataCollection` |  |
| `MetadataItem` |  |

### DocumentFormatInstance class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance.md

#### DocumentFormatInstance class

The DocumentFormatInstance type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _initialize_document_format_configuration_redactor_settings |  |
| _is_redaction_accepted_redaction_description |  |
| _load_stream |  |
| _perform_binary_check_stream |  |
| _save_stream |  |
| initialize |  |
| initialize_document_format_configuration |  |
| is_redaction_accepted |  |
| is_redaction_accepted_redaction_description |  |
| load |  |
| load_stream |  |
| load_streams |  |
| perform_binary_check |  |
| perform_binary_check_stream |  |
| perform_binary_check_streams |  |
| save |  |
| save_stream |  |
| save_streams |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |

### _initialize_document_format_configuration_redactor_settings method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/_initialize_document_format_configuration_redactor_settings.md

#### _initialize_document_format_configuration_redactor_settings

```python
def _initialize_document_format_configuration_redactor_settings(self, config, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| config | `DocumentFormatConfiguration` |  |
| settings | `RedactorSettings` |  |

### _is_redaction_accepted_redaction_description method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/_is_redaction_accepted_redaction_description.md

#### _is_redaction_accepted_redaction_description

```python
def _is_redaction_accepted_redaction_description(self, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | `RedactionDescription` |  |

**Returns:** bool

### _load_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/_load_stream.md

#### _load_stream

```python
def _load_stream(self, input):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input | `Stream` |  |

### _perform_binary_check_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/_perform_binary_check_stream.md

#### _perform_binary_check_stream

```python
def _perform_binary_check_stream(self, input):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input | `Stream` |  |

**Returns:** bool

### _save_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/_save_stream.md

#### _save_stream

```python
def _save_stream(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `Stream` |  |

### initialize method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/initialize.md

#### initialize

```python
def initialize(self):
    ...
```

### initialize_document_format_configuration method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/initialize_document_format_configuration.md

#### initialize_document_format_configuration

```python
def initialize_document_format_configuration(self):
    ...
```

### is_redaction_accepted method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/is_redaction_accepted.md

#### is_redaction_accepted

```python
def is_redaction_accepted(self):
    ...
```

### is_redaction_accepted_redaction_description method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/is_redaction_accepted_redaction_description.md

#### is_redaction_accepted_redaction_description

```python
def is_redaction_accepted_redaction_description(self):
    ...
```

### load method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/load.md

#### load

```python
def load(self):
    ...
```

### load_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/load_stream.md

#### load_stream

```python
def load_stream(self):
    ...
```

### load_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/load_streams.md

#### load_streams

```python
def load_streams(self):
    ...
```

### password property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### perform_binary_check method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/perform_binary_check.md

#### perform_binary_check

```python
def perform_binary_check(self):
    ...
```

### perform_binary_check_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/perform_binary_check_stream.md

#### perform_binary_check_stream

```python
def perform_binary_check_stream(self):
    ...
```

### perform_binary_check_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/perform_binary_check_streams.md

#### perform_binary_check_streams

```python
def perform_binary_check_streams(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/save.md

#### save

```python
def save(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/documentformatinstance/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### IAnnotatedDocument class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument.md

#### IAnnotatedDocument class

The IAnnotatedDocument type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _delete_annotations_regex |  |
| _redact_annotation_regex_string |  |
| delete_annotations |  |
| delete_annotations_regex |  |
| redact_annotation |  |
| redact_annotation_file |  |
| redact_annotation_regex |  |
| redact_annotation_string |  |

### _delete_annotations_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/_delete_annotations_regex.md

#### _delete_annotations_regex

```python
def _delete_annotations_regex(self, regular_expression):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |

**Returns:** RedactionResult

### _redact_annotation_regex_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/_redact_annotation_regex_string.md

#### _redact_annotation_regex_string

```python
def _redact_annotation_regex_string(self, regular_expression, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |
| replacement | `str` |  |

**Returns:** RedactionResult

### delete_annotations method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/delete_annotations.md

#### delete_annotations

```python
def delete_annotations(self):
    ...
```

### delete_annotations_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/delete_annotations_regex.md

#### delete_annotations_regex

```python
def delete_annotations_regex(self):
    ...
```

### redact_annotation method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/redact_annotation.md

#### redact_annotation

```python
def redact_annotation(self):
    ...
```

### redact_annotation_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/redact_annotation_file.md

#### redact_annotation_file

```python
def redact_annotation_file(self):
    ...
```

### redact_annotation_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/redact_annotation_regex.md

#### redact_annotation_regex

```python
def redact_annotation_regex(self):
    ...
```

### redact_annotation_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iannotateddocument/redact_annotation_string.md

#### redact_annotation_string

```python
def redact_annotation_string(self):
    ...
```

### ICellularFormatInstance class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance.md

#### ICellularFormatInstance class

The ICellularFormatInstance type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _get_sheet_index_string |  |
| _replace_in_column_regex_string_int32 |  |
| _replace_in_column_regex_string_int32_int32 |  |
| get_sheet_index |  |
| get_sheet_index_file |  |
| get_sheet_index_string |  |
| replace_in_column |  |
| replace_in_column_file |  |
| replace_in_column_regex |  |
| replace_in_column_string |  |

### _get_sheet_index_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/_get_sheet_index_string.md

#### _get_sheet_index_string

```python
def _get_sheet_index_string(self, sheet_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| sheet_name | `str` |  |

**Returns:** int

### _replace_in_column_regex_string_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/_replace_in_column_regex_string_int32.md

#### _replace_in_column_regex_string_int32

```python
def _replace_in_column_regex_string_int32(self, regular_expression, replacement, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |
| replacement | `str` |  |
| column | `int` |  |

**Returns:** RedactionResult

### _replace_in_column_regex_string_int32_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/_replace_in_column_regex_string_int32_int32.md

#### _replace_in_column_regex_string_int32_int32

```python
def _replace_in_column_regex_string_int32_int32(self, regular_expression, replacement, column, sheet):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |
| replacement | `str` |  |
| column | `int` |  |
| sheet | `int` |  |

**Returns:** RedactionResult

### get_sheet_index method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/get_sheet_index.md

#### get_sheet_index

```python
def get_sheet_index(self):
    ...
```

### get_sheet_index_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/get_sheet_index_file.md

#### get_sheet_index_file

```python
def get_sheet_index_file(self):
    ...
```

### get_sheet_index_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/get_sheet_index_string.md

#### get_sheet_index_string

```python
def get_sheet_index_string(self):
    ...
```

### replace_in_column method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/replace_in_column.md

#### replace_in_column

```python
def replace_in_column(self):
    ...
```

### replace_in_column_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/replace_in_column_file.md

#### replace_in_column_file

```python
def replace_in_column_file(self):
    ...
```

### replace_in_column_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/replace_in_column_regex.md

#### replace_in_column_regex

```python
def replace_in_column_regex(self):
    ...
```

### replace_in_column_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/icellularformatinstance/replace_in_column_string.md

#### replace_in_column_string

```python
def replace_in_column_string(self):
    ...
```

### IFixedFormatDocument class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument.md

#### IFixedFormatDocument class

The IFixedFormatDocument type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _load_images_redaction_filter_array |  |
| _redact_annotation_regex_replacement_options |  |
| load_images |  |
| load_images_redaction_filter |  |
| redact_annotation |  |
| redact_annotation_regex |  |

### _load_images_redaction_filter_array method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/_load_images_redaction_filter_array.md

#### _load_images_redaction_filter_array

```python
def _load_images_redaction_filter_array(self, filters):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filters | `List[RedactionFilter]` |  |

**Returns:** List[IImageFormatInstance]

### _redact_annotation_regex_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/_redact_annotation_regex_replacement_options.md

#### _redact_annotation_regex_replacement_options

```python
def _redact_annotation_regex_replacement_options(self, regular_expression, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |
| options | `ReplacementOptions` |  |

**Returns:** RedactionResult

### load_images method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/load_images.md

#### load_images

```python
def load_images(self):
    ...
```

### load_images_redaction_filter method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/load_images_redaction_filter.md

#### load_images_redaction_filter

```python
def load_images_redaction_filter(self):
    ...
```

### redact_annotation method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/redact_annotation.md

#### redact_annotation

```python
def redact_annotation(self):
    ...
```

### redact_annotation_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ifixedformatdocument/redact_annotation_regex.md

#### redact_annotation_regex

```python
def redact_annotation_regex(self):
    ...
```

### IImageFormatInstance class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iimageformatinstance.md

#### IImageFormatInstance class

The IImageFormatInstance type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _edit_area_point_region_replacement_options |  |
| edit_area |  |
| edit_area_point |  |

### _edit_area_point_region_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iimageformatinstance/_edit_area_point_region_replacement_options.md

#### _edit_area_point_region_replacement_options

```python
def _edit_area_point_region_replacement_options(self, top_left, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| top_left | `Point` |  |
| options | `RegionReplacementOptions` |  |

**Returns:** RedactionResult

### edit_area method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iimageformatinstance/edit_area.md

#### edit_area

```python
def edit_area(self):
    ...
```

### edit_area_point method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/iimageformatinstance/edit_area_point.md

#### edit_area_point

```python
def edit_area_point(self):
    ...
```

### IMetadataAccess class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess.md

#### IMetadataAccess class

The IMetadataAccess type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _change_metadata_metadata_item |  |
| _get_metadata_noargs |  |
| change_metadata |  |
| change_metadata_metadata_item |  |
| get_metadata |  |

### _change_metadata_metadata_item method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess/_change_metadata_metadata_item.md

#### _change_metadata_metadata_item

```python
def _change_metadata_metadata_item(self, metadata_item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata_item | `MetadataItem` |  |

**Returns:** RedactionResult

### _get_metadata_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess/_get_metadata_noargs.md

#### _get_metadata_noargs

```python
def _get_metadata_noargs(self):
    ...
```

**Returns:** MetadataCollection

### change_metadata method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess/change_metadata.md

#### change_metadata

```python
def change_metadata(self):
    ...
```

### change_metadata_metadata_item method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess/change_metadata_metadata_item.md

#### change_metadata_metadata_item

```python
def change_metadata_metadata_item(self):
    ...
```

### get_metadata method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/imetadataaccess/get_metadata.md

#### get_metadata

```python
def get_metadata(self):
    ...
```

### IPaginatedDocument class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipaginateddocument.md

#### IPaginatedDocument class

The IPaginatedDocument type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _remove_pages_page_seek_origin_int32_int32 |  |
| remove_pages |  |
| remove_pages_page_seek_origin |  |

### _remove_pages_page_seek_origin_int32_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipaginateddocument/_remove_pages_page_seek_origin_int32_int32.md

#### _remove_pages_page_seek_origin_int32_int32

```python
def _remove_pages_page_seek_origin_int32_int32(self, origin, index, count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| origin | `PageSeekOrigin` |  |
| index | `int` |  |
| count | `int` |  |

**Returns:** RedactionResult

### remove_pages method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipaginateddocument/remove_pages.md

#### remove_pages

```python
def remove_pages(self):
    ...
```

### remove_pages_page_seek_origin method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipaginateddocument/remove_pages_page_seek_origin.md

#### remove_pages_page_seek_origin

```python
def remove_pages_page_seek_origin(self):
    ...
```

### IPreviewable class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipreviewable.md

#### IPreviewable class

The IPreviewable type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _generate_preview_preview_options |  |
| _get_document_info_noargs |  |
| generate_preview |  |
| generate_preview_preview_options |  |
| get_document_info |  |

### _generate_preview_preview_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipreviewable/_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/redaction/python-net/groupdocs.redaction.integration/ipreviewable/_get_document_info_noargs.md

#### _get_document_info_noargs

```python
def _get_document_info_noargs(self):
    ...
```

**Returns:** IDocumentInfo

### generate_preview method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipreviewable/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/ipreviewable/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/redaction/python-net/groupdocs.redaction.integration/ipreviewable/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### IRasterizableDocument class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument.md

#### IRasterizableDocument class

The IRasterizableDocument type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _rasterize_stream |  |
| _rasterize_stream_rasterization_options |  |
| rasterize |  |
| rasterize_stream |  |
| rasterize_streams |  |

### _rasterize_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument/_rasterize_stream.md

#### _rasterize_stream

```python
def _rasterize_stream(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `Stream` |  |

### _rasterize_stream_rasterization_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument/_rasterize_stream_rasterization_options.md

#### _rasterize_stream_rasterization_options

```python
def _rasterize_stream_rasterization_options(self, output, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `Stream` |  |
| options | `RasterizationOptions` |  |

### rasterize method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument/rasterize.md

#### rasterize

```python
def rasterize(self):
    ...
```

### rasterize_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument/rasterize_stream.md

#### rasterize_stream

```python
def rasterize_stream(self):
    ...
```

### rasterize_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/irasterizabledocument/rasterize_streams.md

#### rasterize_streams

```python
def rasterize_streams(self):
    ...
```

### ITextualFormatInstance class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/itextualformatinstance.md

#### ITextualFormatInstance class

The ITextualFormatInstance type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _replace_text_regex_replacement_options |  |
| replace_text |  |
| replace_text_regex |  |

### _replace_text_regex_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/itextualformatinstance/_replace_text_regex_replacement_options.md

#### _replace_text_regex_replacement_options

```python
def _replace_text_regex_replacement_options(self, regular_expression, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regular_expression | `Any` |  |
| options | `ReplacementOptions` |  |

**Returns:** RedactionResult

### replace_text method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/itextualformatinstance/replace_text.md

#### replace_text

```python
def replace_text(self):
    ...
```

### replace_text_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/itextualformatinstance/replace_text_regex.md

#### replace_text_regex

```python
def replace_text_regex(self):
    ...
```

### MetadataCollection class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection.md

#### MetadataCollection class

The MetadataCollection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_range_metadata_collection |  |
| _init_noargs |  |
| add_range |  |
| add_range_metadata_collection |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_range_metadata_collection method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection/_add_range_metadata_collection.md

#### _add_range_metadata_collection

```python
def _add_range_metadata_collection(self, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| items | `MetadataCollection` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### add_range method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection/add_range.md

#### add_range

```python
def add_range(self):
    ...
```

### add_range_metadata_collection method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadatacollection/add_range_metadata_collection.md

#### add_range_metadata_collection

```python
def add_range_metadata_collection(self):
    ...
```

### MetadataItem class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem.md

#### MetadataItem class

The MetadataItem type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _create_clone_noargs |  |
| _get_object_data_serialization_info_streaming_context |  |
| _init_noargs |  |
| create_clone |  |
| get_object_data |  |
| get_object_data_serialization_info |  |

##### Properties
| Property | Description |
| :- | :- |
| actual_value |  |
| category |  |
| dictionary_key |  |
| filter |  |
| is_custom |  |
| original_name |  |
| values |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _create_clone_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/_create_clone_noargs.md

#### _create_clone_noargs

```python
def _create_clone_noargs(self):
    ...
```

**Returns:** MetadataItem

### _get_object_data_serialization_info_streaming_context method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/_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_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### actual_value property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/actual_value.md

##### Definition:
```python
@property
def actual_value(self):
    ...
```

### category property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/category.md

##### Definition:
```python
@property
def category(self):
    ...
@category.setter
def category(self, value):
    ...
```

### create_clone method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/create_clone.md

#### create_clone

```python
def create_clone(self):
    ...
```

### dictionary_key property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/dictionary_key.md

##### Definition:
```python
@property
def dictionary_key(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/filter.md

##### Definition:
```python
@property
def filter(self):
    ...
@filter.setter
def filter(self, value):
    ...
```

### get_object_data method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/get_object_data.md

#### get_object_data

```python
def get_object_data(self):
    ...
```

### get_object_data_serialization_info method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/get_object_data_serialization_info.md

#### get_object_data_serialization_info

```python
def get_object_data_serialization_info(self):
    ...
```

### is_custom property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/is_custom.md

##### Definition:
```python
@property
def is_custom(self):
    ...
@is_custom.setter
def is_custom(self, value):
    ...
```

### original_name property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/original_name.md

##### Definition:
```python
@property
def original_name(self):
    ...
@original_name.setter
def original_name(self, value):
    ...
```

### values property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.integration/metadataitem/values.md

##### Definition:
```python
@property
def values(self):
    ...
@values.setter
def values(self, value):
    ...
```

### groupdocs.redaction.options
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `CreatePageStream` |  |
| `ILogger` |  |
| `LoadOptions` |  |
| `PreviewOptions` |  |
| `RasterizationOptions` |  |
| `RedactorSettings` |  |
| `ReleasePageStream` |  |
| `SaveOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `AdvancedRasterizationOptions` |  |
| `PdfComplianceLevel` |  |
| `PreviewFormats` |  |

### AdvancedRasterizationOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions.md

#### AdvancedRasterizationOptions class

The AdvancedRasterizationOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| TILT |  |
| NOISE |  |
| BORDER |  |
| GRAYSCALE |  |

### BORDER field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions/border.md

##### Value
`4`

### GRAYSCALE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions/grayscale.md

##### Value
`8`

### NOISE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions/noise.md

##### Value
`2`

### NONE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions/none.md

##### Value
`0`

### TILT field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/advancedrasterizationoptions/tilt.md

##### Value
`1`

### CreatePageStream class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream.md

#### CreatePageStream class

The CreatePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32 |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_async_callback_object method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/_begin_invoke_int32_async_callback_object.md

#### _begin_invoke_int32_async_callback_object

```python
def _begin_invoke_int32_async_callback_object(self, page_number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/_invoke_int32.md

#### _invoke_int32

```python
def _invoke_int32(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.options/createpagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger.md

#### ILogger class

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _error_string |  |
| _trace_string |  |
| _warning_string |  |
| error |  |
| error_file |  |
| error_string |  |
| trace |  |
| trace_file |  |
| trace_string |  |
| warning |  |
| warning_file |  |
| warning_string |  |

### _error_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/_error_string.md

#### _error_string

```python
def _error_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _trace_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/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/redaction/python-net/groupdocs.redaction.options/ilogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean |  |
| _init_noargs |  |
| _init_string |  |
| _init_string_boolean |  |

##### Properties
| Property | Description |
| :- | :- |
| password |  |
| pre_rasterize |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/_init_boolean.md

#### _init_boolean

```python
def _init_boolean(self, pre_rasterize):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pre_rasterize | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/_init_string.md

#### _init_string

```python
def _init_string(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |

### _init_string_boolean method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/_init_string_boolean.md

#### _init_string_boolean

```python
def _init_string_boolean(self, password, pre_rasterize):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` |  |
| pre_rasterize | `bool` |  |

### password property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### pre_rasterize property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/loadoptions/pre_rasterize.md

##### Definition:
```python
@property
def pre_rasterize(self):
    ...
@pre_rasterize.setter
def pre_rasterize(self, value):
    ...
```

### PdfComplianceLevel class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/pdfcompliancelevel.md

#### PdfComplianceLevel class

The PdfComplianceLevel type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO |  |
| PDF_A1A |  |

### AUTO field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/pdfcompliancelevel/auto.md

##### Value
`0`

### PDF_A1A field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/pdfcompliancelevel/pdf_a1a.md

##### Value
`1`

### PreviewFormats class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.options/previewformats/bmp.md

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/previewformats/jpeg.md

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/previewformats/png.md

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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 |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/previewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_page_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.options/previewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.options/previewoptions/release_page_stream.md

##### Definition:
```python
@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/previewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### RasterizationOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions.md

#### RasterizationOptions class

The RasterizationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _add_advanced_option_advanced_rasterization_options |  |
| _add_advanced_option_advanced_rasterization_options_dictionary_2_9bbf |  |
| _init_noargs |  |
| add_advanced_option |  |
| add_advanced_option_advanced_rasterization_options |  |

##### Properties
| Property | Description |
| :- | :- |
| compliance |  |
| enabled |  |
| has_advanced_options |  |
| page_count |  |
| page_index |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _add_advanced_option_advanced_rasterization_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/_add_advanced_option_advanced_rasterization_options.md

#### _add_advanced_option_advanced_rasterization_options

```python
def _add_advanced_option_advanced_rasterization_options(self, option_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| option_type | `AdvancedRasterizationOptions` |  |

### _add_advanced_option_advanced_rasterization_options_dictionary_2_9bbf method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/_add_advanced_option_advanced_rasterization_options_dictionary_2_9bbf.md

#### _add_advanced_option_advanced_rasterization_options_dictionary_2_9bbf

```python
def _add_advanced_option_advanced_rasterization_options_dictionary_2_9bbf(self, option_type, parameters):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| option_type | `AdvancedRasterizationOptions` |  |
| parameters | `Any` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### add_advanced_option method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/add_advanced_option.md

#### add_advanced_option

```python
def add_advanced_option(self):
    ...
```

### add_advanced_option_advanced_rasterization_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/add_advanced_option_advanced_rasterization_options.md

#### add_advanced_option_advanced_rasterization_options

```python
def add_advanced_option_advanced_rasterization_options(self):
    ...
```

### compliance property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/compliance.md

##### Definition:
```python
@property
def compliance(self):
    ...
@compliance.setter
def compliance(self, value):
    ...
```

### enabled property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/enabled.md

##### Definition:
```python
@property
def enabled(self):
    ...
@enabled.setter
def enabled(self, value):
    ...
```

### has_advanced_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/has_advanced_options.md

##### Definition:
```python
@property
def has_advanced_options(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
@page_count.setter
def page_count(self, value):
    ...
```

### page_index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/rasterizationoptions/page_index.md

##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### RedactorSettings class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings.md

#### RedactorSettings class

The RedactorSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_ilogger |  |
| _init_ilogger_iredaction_callback |  |
| _init_ilogger_iredaction_callback_iocr_connector |  |
| _init_iocr_connector |  |
| _init_iredaction_callback |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| logger |  |
| ocr_connector |  |
| redaction_callback |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_ilogger method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_ilogger.md

#### _init_ilogger

```python
def _init_ilogger(self, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |

### _init_ilogger_iredaction_callback method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_ilogger_iredaction_callback.md

#### _init_ilogger_iredaction_callback

```python
def _init_ilogger_iredaction_callback(self, logger, callback):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |
| callback | `IRedactionCallback` |  |

### _init_ilogger_iredaction_callback_iocr_connector method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_ilogger_iredaction_callback_iocr_connector.md

#### _init_ilogger_iredaction_callback_iocr_connector

```python
def _init_ilogger_iredaction_callback_iocr_connector(self, logger, callback, ocr_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |
| callback | `IRedactionCallback` |  |
| ocr_connector | `IOcrConnector` |  |

### _init_iocr_connector method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_iocr_connector.md

#### _init_iocr_connector

```python
def _init_iocr_connector(self, ocr_connector):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| ocr_connector | `IOcrConnector` |  |

### _init_iredaction_callback method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_iredaction_callback.md

#### _init_iredaction_callback

```python
def _init_iredaction_callback(self, callback):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| callback | `IRedactionCallback` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### logger property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/logger.md

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/ocr_connector.md

##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### redaction_callback property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/redactorsettings/redaction_callback.md

##### Definition:
```python
@property
def redaction_callback(self):
    ...
@redaction_callback.setter
def redaction_callback(self, value):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream.md

#### ReleasePageStream class

The ReleasePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_stream |  |
| 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/redaction/python-net/groupdocs.redaction.options/releasepagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_stream_async_callback_object method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/_begin_invoke_int32_stream_async_callback_object.md

#### _begin_invoke_int32_stream_async_callback_object

```python
def _begin_invoke_int32_stream_async_callback_object(self, page_number, page_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/_invoke_int32_stream.md

#### _invoke_int32_stream

```python
def _invoke_int32_stream(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.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/redaction/python-net/groupdocs.redaction.options/releasepagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### SaveOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions.md

#### SaveOptions class

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_boolean_string |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| add_suffix |  |
| rasterization |  |
| rasterize_to_pdf |  |
| redacted_file_suffix |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_boolean_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/_init_boolean_string.md

#### _init_boolean_string

```python
def _init_boolean_string(self, rasterize_to_pdf, suffix):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| rasterize_to_pdf | `bool` |  |
| suffix | `str` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### add_suffix property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/add_suffix.md

##### Definition:
```python
@property
def add_suffix(self):
    ...
@add_suffix.setter
def add_suffix(self, value):
    ...
```

### rasterization property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/rasterization.md

##### Definition:
```python
@property
def rasterization(self):
    ...
```

### rasterize_to_pdf property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/rasterize_to_pdf.md

##### Definition:
```python
@property
def rasterize_to_pdf(self):
    ...
@rasterize_to_pdf.setter
def rasterize_to_pdf(self, value):
    ...
```

### redacted_file_suffix property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/redacted_file_suffix.md

##### Definition:
```python
@property
def redacted_file_suffix(self):
    ...
@redacted_file_suffix.setter
def redacted_file_suffix(self, value):
    ...
```

### SAVE_SUFFIX property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.options/saveoptions/save_suffix.md

#### SAVE_SUFFIX property

Represents default suffix value, which is "Redacted".
##### Definition:
```python
f SAVE_SUFFIX 
```

### groupdocs.redaction.redactions
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions.md

Types under `groupdocs.redaction.redactions`.

##### Classes
| Class | Description |
| :- | :- |
| `AnnotationRedaction` |  |
| `CellColumnRedaction` |  |
| `CellFilter` |  |
| `CustomRedactionContext` |  |
| `CustomRedactionResult` |  |
| `DeleteAnnotationRedaction` |  |
| `EraseMetadataRedaction` |  |
| `ExactPhraseRedaction` |  |
| `ICustomRedactionHandler` |  |
| `IRedactionCallback` |  |
| `ImageAreaRedaction` |  |
| `MetadataRedaction` |  |
| `MetadataSearchRedaction` |  |
| `PageAreaFilter` |  |
| `PageAreaRedaction` |  |
| `PageRangeFilter` |  |
| `RedactionDescription` |  |
| `RegexRedaction` |  |
| `RegionReplacementOptions` |  |
| `RemovePageRedaction` |  |
| `ReplacementOptions` |  |
| `TextRedaction` |  |
| `TextReplacement` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `MetadataFilters` |  |
| `PageSeekOrigin` |  |
| `RedactionActionType` |  |
| `RedactionFilter` |  |
| `RedactionType` |  |
| `ReplacementType` |  |

### AnnotationRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction.md

#### AnnotationRedaction class

The AnnotationRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_regex_string |  |
| _init_string_string |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| expression |  |
| replacement |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_regex_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/_init_regex_string.md

#### _init_regex_string

```python
def _init_regex_string(self, regex, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regex | `Any` |  |
| replacement | `str` |  |

### _init_string_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, pattern, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pattern | `str` |  |
| replacement | `str` |  |

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### expression property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/expression.md

##### Definition:
```python
@property
def expression(self):
    ...
```

### replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/annotationredaction/replacement.md

##### Definition:
```python
@property
def replacement(self):
    ...
```

### CellColumnRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction.md

#### CellColumnRedaction class

The CellColumnRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_cell_filter_regex_replacement_options |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| filter |  |
| pattern |  |
| action_options |  (inherited from `TextRedaction`) |
| ocr_connector |  (inherited from `TextRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_cell_filter_regex_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/_init_cell_filter_regex_replacement_options.md

#### _init_cell_filter_regex_replacement_options

```python
def _init_cell_filter_regex_replacement_options(self, filter, reg_ex, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `CellFilter` |  |
| reg_ex | `Any` |  |
| options | `ReplacementOptions` |  |

### action_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/action_options.md

#### action_options property

Gets the `ReplacementOptions` instance, specifying type of text replacement.
##### Definition:
```python
@property
def action_options(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/filter.md

##### Definition:
```python
@property
def filter(self):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/ocr_connector.md

#### ocr_connector property

Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content.
##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### pattern property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellcolumnredaction/pattern.md

##### Definition:
```python
@property
def pattern(self):
    ...
```

### CellFilter class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter.md

#### CellFilter class

The CellFilter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| column_index |  |
| has_work_sheet_index |  |
| work_sheet_index |  |
| work_sheet_name |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### column_index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/column_index.md

##### Definition:
```python
@property
def column_index(self):
    ...
@column_index.setter
def column_index(self, value):
    ...
```

### has_work_sheet_index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/has_work_sheet_index.md

##### Definition:
```python
@property
def has_work_sheet_index(self):
    ...
```

### NO_INDEX property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/no_index.md

#### NO_INDEX property

Represents a default value for filter, which is -1.
##### Definition:
```python
f NO_INDEX 
```

### work_sheet_index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/work_sheet_index.md

##### Definition:
```python
@property
def work_sheet_index(self):
    ...
@work_sheet_index.setter
def work_sheet_index(self, value):
    ...
```

### work_sheet_name property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/cellfilter/work_sheet_name.md

##### Definition:
```python
@property
def work_sheet_name(self):
    ...
@work_sheet_name.setter
def work_sheet_name(self, value):
    ...
```

### CustomRedactionContext class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactioncontext.md

#### CustomRedactionContext class

The CustomRedactionContext type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| page_number |  |
| text |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactioncontext/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactioncontext/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactioncontext/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactioncontext/text.md

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### CustomRedactionResult class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactionresult.md

#### CustomRedactionResult class

The CustomRedactionResult type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| apply |  |
| text |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactionresult/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactionresult/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### apply property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactionresult/apply.md

##### Definition:
```python
@property
def apply(self):
    ...
@apply.setter
def apply(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/customredactionresult/text.md

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### DeleteAnnotationRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction.md

#### DeleteAnnotationRedaction class

The DeleteAnnotationRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_noargs |  |
| _init_regex |  |
| _init_string |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| expression |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/_init_regex.md

#### _init_regex

```python
def _init_regex(self, regex):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regex | `Any` |  |

### _init_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/_init_string.md

#### _init_string

```python
def _init_string(self, pattern):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pattern | `str` |  |

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### expression property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/deleteannotationredaction/expression.md

##### Definition:
```python
@property
def expression(self):
    ...
```

### EraseMetadataRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction.md

#### EraseMetadataRedaction class

The EraseMetadataRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_metadata_filters |  |
| _init_noargs |  |
| _apply_to_document_format_instance |  (inherited from `MetadataRedaction`) |
| apply_to |  (inherited from `MetadataRedaction`) |
| apply_to_document_format_instance |  (inherited from `MetadataRedaction`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| filter |  (inherited from `MetadataRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_metadata_filters method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/_init_metadata_filters.md

#### _init_metadata_filters

```python
def _init_metadata_filters(self, filter):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filter | `MetadataFilters` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/apply_to.md

#### apply_to(self, format_instance)

Applies the redaction to a given format instance.

##### Returns

Status of the redaction: success/failure and error message if any

```python

def apply_to(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | groupdocs.redaction.integration.DocumentFormatInstance | An instance of a document to apply redaction |

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/erasemetadataredaction/filter.md

#### filter property

Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company.
##### Definition:
```python
@property
def filter(self):
    ...
@filter.setter
def filter(self, value):
    ...
```

### ExactPhraseRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction.md

#### ExactPhraseRedaction class

The ExactPhraseRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_string_boolean_replacement_options |  |
| _init_string_replacement_options |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| is_case_sensitive |  |
| is_right_to_left |  |
| search_phrase |  |
| action_options |  (inherited from `TextRedaction`) |
| ocr_connector |  (inherited from `TextRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_string_boolean_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/_init_string_boolean_replacement_options.md

#### _init_string_boolean_replacement_options

```python
def _init_string_boolean_replacement_options(self, search_phrase, is_case_sensitive, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_phrase | `str` |  |
| is_case_sensitive | `bool` |  |
| options | `ReplacementOptions` |  |

### _init_string_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/_init_string_replacement_options.md

#### _init_string_replacement_options

```python
def _init_string_replacement_options(self, search_phrase, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_phrase | `str` |  |
| options | `ReplacementOptions` |  |

### action_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/action_options.md

#### action_options property

Gets the `ReplacementOptions` instance, specifying type of text replacement.
##### Definition:
```python
@property
def action_options(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### is_case_sensitive property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/is_case_sensitive.md

##### Definition:
```python
@property
def is_case_sensitive(self):
    ...
```

### is_right_to_left property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/is_right_to_left.md

##### Definition:
```python
@property
def is_right_to_left(self):
    ...
@is_right_to_left.setter
def is_right_to_left(self, value):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/ocr_connector.md

#### ocr_connector property

Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content.
##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### search_phrase property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/exactphraseredaction/search_phrase.md

##### Definition:
```python
@property
def search_phrase(self):
    ...
```

### ICustomRedactionHandler class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/icustomredactionhandler.md

#### ICustomRedactionHandler class

The ICustomRedactionHandler type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _redact_custom_redaction_context |  |
| redact |  |
| redact_custom_redaction_context |  |

### _redact_custom_redaction_context method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/icustomredactionhandler/_redact_custom_redaction_context.md

#### _redact_custom_redaction_context

```python
def _redact_custom_redaction_context(self, context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| context | `CustomRedactionContext` |  |

**Returns:** CustomRedactionResult

### redact method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/icustomredactionhandler/redact.md

#### redact

```python
def redact(self):
    ...
```

### redact_custom_redaction_context method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/icustomredactionhandler/redact_custom_redaction_context.md

#### redact_custom_redaction_context

```python
def redact_custom_redaction_context(self):
    ...
```

### ImageAreaRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction.md

#### ImageAreaRedaction class

The ImageAreaRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_point_region_replacement_options |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| options |  |
| top_left |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_point_region_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/_init_point_region_replacement_options.md

#### _init_point_region_replacement_options

```python
def _init_point_region_replacement_options(self, top_left, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| top_left | `Point` |  |
| options | `RegionReplacementOptions` |  |

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/options.md

##### Definition:
```python
@property
def options(self):
    ...
```

### top_left property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/imagearearedaction/top_left.md

##### Definition:
```python
@property
def top_left(self):
    ...
```

### IRedactionCallback class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/iredactioncallback.md

#### IRedactionCallback class

The IRedactionCallback type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _accept_redaction_redaction_description |  |
| accept_redaction |  |
| accept_redaction_redaction_description |  |

### _accept_redaction_redaction_description method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/iredactioncallback/_accept_redaction_redaction_description.md

#### _accept_redaction_redaction_description

```python
def _accept_redaction_redaction_description(self, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | `RedactionDescription` |  |

**Returns:** bool

### accept_redaction method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/iredactioncallback/accept_redaction.md

#### accept_redaction

```python
def accept_redaction(self):
    ...
```

### accept_redaction_redaction_description method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/iredactioncallback/accept_redaction_redaction_description.md

#### accept_redaction_redaction_description

```python
def accept_redaction_redaction_description(self):
    ...
```

### MetadataFilters class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters.md

#### MetadataFilters class

The MetadataFilters type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE |  |
| AUTHOR |  |
| CATEGORY |  |
| COMMENTS |  |
| COMPANY |  |
| CONTENT_STATUS |  |
| CREATED_TIME |  |
| HYPERLINK_BASE |  |
| LAST_PRINTED |  |
| LAST_SAVED_BY |  |
| LAST_SAVED_TIME |  |
| NAME_OF_APPLICATION |  |
| MANAGER |  |
| REVISION_NUMBER |  |
| SUBJECT |  |
| TEMPLATE |  |
| TITLE |  |
| TOTAL_EDITING_TIME |  |
| VERSION |  |
| DESCRIPTION |  |
| KEYWORDS |  |
| CONTENT_TYPE |  |
| ALL |  |

### ALL field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/all.md

##### Value
`2147483647`

### AUTHOR field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/author.md

##### Value
`1`

### CATEGORY field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/category.md

##### Value
`2`

### COMMENTS field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/comments.md

##### Value
`4`

### COMPANY field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/company.md

##### Value
`8`

### CONTENT_STATUS field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/content_status.md

##### Value
`16`

### CONTENT_TYPE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/content_type.md

##### Value
`2097152`

### CREATED_TIME field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/created_time.md

##### Value
`32`

### DESCRIPTION field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/description.md

##### Value
`524288`

### HYPERLINK_BASE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/hyperlink_base.md

##### Value
`64`

### KEYWORDS field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/keywords.md

##### Value
`1048576`

### LAST_PRINTED field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/last_printed.md

##### Value
`128`

### LAST_SAVED_BY field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/last_saved_by.md

##### Value
`256`

### LAST_SAVED_TIME field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/last_saved_time.md

##### Value
`1024`

### MANAGER field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/manager.md

##### Value
`4096`

### NAME_OF_APPLICATION field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/name_of_application.md

##### Value
`2048`

### NONE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/none.md

##### Value
`0`

### REVISION_NUMBER field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/revision_number.md

##### Value
`8192`

### SUBJECT field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/subject.md

##### Value
`16384`

### TEMPLATE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/template.md

##### Value
`32768`

### TITLE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/title.md

##### Value
`65536`

### TOTAL_EDITING_TIME field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/total_editing_time.md

##### Value
`131072`

### VERSION field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatafilters/version.md

##### Value
`262144`

### MetadataRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction.md

#### MetadataRedaction class

The MetadataRedaction type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| filter |  |
| description |  (inherited from `Redaction`) |

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction/description.md

#### description property

Returns a string, describing the redaction and its parameters.
##### Definition:
```python
@property
def description(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadataredaction/filter.md

##### Definition:
```python
@property
def filter(self):
    ...
@filter.setter
def filter(self, value):
    ...
```

### MetadataSearchRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction.md

#### MetadataSearchRedaction class

The MetadataSearchRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_regex_string |  |
| _init_regex_string_regex |  |
| _init_string_string |  |
| _init_string_string_string |  |
| _apply_to_document_format_instance |  (inherited from `MetadataRedaction`) |
| apply_to |  (inherited from `MetadataRedaction`) |
| apply_to_document_format_instance |  (inherited from `MetadataRedaction`) |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| key_expression |  |
| replacement |  |
| value_expression |  |
| filter |  (inherited from `MetadataRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_regex_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/_init_regex_string.md

#### _init_regex_string

```python
def _init_regex_string(self, value_regex, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_regex | `Any` |  |
| replacement | `str` |  |

### _init_regex_string_regex method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/_init_regex_string_regex.md

#### _init_regex_string_regex

```python
def _init_regex_string_regex(self, value_regex, replacement, key_regex):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_regex | `Any` |  |
| replacement | `str` |  |
| key_regex | `Any` |  |

### _init_string_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, value_pattern, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_pattern | `str` |  |
| replacement | `str` |  |

### _init_string_string_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/_init_string_string_string.md

#### _init_string_string_string

```python
def _init_string_string_string(self, value_pattern, replacement, key_pattern):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value_pattern | `str` |  |
| replacement | `str` |  |
| key_pattern | `str` |  |

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/apply_to.md

#### apply_to(self, format_instance)

Applies the redaction to a given format instance.

##### Returns

Status of the redaction: success/failure and error message if any

```python

def apply_to(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | groupdocs.redaction.integration.DocumentFormatInstance | An instance of a document to apply redaction |

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### filter property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/filter.md

#### filter property

Gets or sets the filter, which is used to select all or specific metadata, for example Author or Company.
##### Definition:
```python
@property
def filter(self):
    ...
@filter.setter
def filter(self, value):
    ...
```

### key_expression property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/key_expression.md

##### Definition:
```python
@property
def key_expression(self):
    ...
```

### replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/replacement.md

##### Definition:
```python
@property
def replacement(self):
    ...
```

### value_expression property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/metadatasearchredaction/value_expression.md

##### Definition:
```python
@property
def value_expression(self):
    ...
```

### PageAreaFilter class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageareafilter.md

#### PageAreaFilter class

The PageAreaFilter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_point_size |  |

##### Properties
| Property | Description |
| :- | :- |
| rectangle |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageareafilter/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_point_size method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageareafilter/_init_point_size.md

#### _init_point_size

```python
def _init_point_size(self, top_left, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| top_left | `Point` |  |
| size | `Size` |  |

### rectangle property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageareafilter/rectangle.md

##### Definition:
```python
@property
def rectangle(self):
    ...
```

### PageAreaRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction.md

#### PageAreaRedaction class

The PageAreaRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_regex_replacement_options |  |
| _init_regex_replacement_options_region_replacement_options |  |
| apply_to |  |
| apply_to_document_format_instance |  |
| _init_string_replacement_options |  (inherited from `RegexRedaction`) |

##### Properties
| Property | Description |
| :- | :- |
| image_options |  |
| action_options |  (inherited from `TextRedaction`) |
| description |  (inherited from `RegexRedaction`) |
| ocr_connector |  (inherited from `TextRedaction`) |
| regular_expression |  (inherited from `RegexRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_regex_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/_init_regex_replacement_options.md

#### _init_regex_replacement_options

```python
def _init_regex_replacement_options(self, regex, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regex | `Any` |  |
| options | `ReplacementOptions` |  |

### _init_regex_replacement_options_region_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/_init_regex_replacement_options_region_replacement_options.md

#### _init_regex_replacement_options_region_replacement_options

```python
def _init_regex_replacement_options_region_replacement_options(self, regex, options, image_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regex | `Any` |  |
| options | `ReplacementOptions` |  |
| image_options | `RegionReplacementOptions` |  |

### action_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/action_options.md

#### action_options property

Gets the `ReplacementOptions` instance, specifying type of text replacement.
##### Definition:
```python
@property
def action_options(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/description.md

#### description property

Returns a string, describing the redaction and its parameters.
##### Definition:
```python
@property
def description(self):
    ...
```

### image_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/image_options.md

##### Definition:
```python
@property
def image_options(self):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagearearedaction/ocr_connector.md

#### ocr_connector property

Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content.
##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### PageRangeFilter class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter.md

#### PageRangeFilter class

The PageRangeFilter type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_page_seek_origin_int32_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| index |  |
| origin |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_page_seek_origin_int32_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter/_init_page_seek_origin_int32_int32.md

#### _init_page_seek_origin_int32_int32

```python
def _init_page_seek_origin_int32_int32(self, origin, index, count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| origin | `PageSeekOrigin` |  |
| index | `int` |  |
| count | `int` |  |

### count property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter/index.md

##### Definition:
```python
@property
def index(self):
    ...
```

### origin property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pagerangefilter/origin.md

##### Definition:
```python
@property
def origin(self):
    ...
```

### PageSeekOrigin class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageseekorigin.md

#### PageSeekOrigin class

The PageSeekOrigin type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BEGIN |  |
| END |  |

### BEGIN field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageseekorigin/begin.md

##### Value
`0`

### END field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/pageseekorigin/end.md

##### Value
`1`

### RedactionActionType class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactionactiontype.md

#### RedactionActionType class

The RedactionActionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| REPLACEMENT |  |
| CLEANUP |  |
| DELETION |  |

### CLEANUP field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactionactiontype/cleanup.md

##### Value
`1`

### DELETION field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactionactiontype/deletion.md

##### Value
`2`

### REPLACEMENT field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactionactiontype/replacement.md

##### Value
`0`

### RedactionDescription class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription.md

#### RedactionDescription class

The RedactionDescription type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_redaction_type_redaction_action_type_region_replacement_options_string |  |
| _init_redaction_type_redaction_action_type_string |  |
| _init_redaction_type_redaction_action_type_string_text_replacement |  |

##### Properties
| Property | Description |
| :- | :- |
| action_type |  |
| details |  |
| image_area_replacement |  |
| original_text |  |
| redaction_type |  |
| replacement |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_redaction_type_redaction_action_type_region_replacement_options_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/_init_redaction_type_redaction_action_type_region_replacement_options_string.md

#### _init_redaction_type_redaction_action_type_region_replacement_options_string

```python
def _init_redaction_type_redaction_action_type_region_replacement_options_string(self, redaction_type, action_type, image_area_replacement, image_details):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redaction_type | `RedactionType` |  |
| action_type | `RedactionActionType` |  |
| image_area_replacement | `RegionReplacementOptions` |  |
| image_details | `str` |  |

### _init_redaction_type_redaction_action_type_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/_init_redaction_type_redaction_action_type_string.md

#### _init_redaction_type_redaction_action_type_string

```python
def _init_redaction_type_redaction_action_type_string(self, redaction_type, action_type, original_text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redaction_type | `RedactionType` |  |
| action_type | `RedactionActionType` |  |
| original_text | `str` |  |

### _init_redaction_type_redaction_action_type_string_text_replacement method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/_init_redaction_type_redaction_action_type_string_text_replacement.md

#### _init_redaction_type_redaction_action_type_string_text_replacement

```python
def _init_redaction_type_redaction_action_type_string_text_replacement(self, redaction_type, action_type, original_text, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redaction_type | `RedactionType` |  |
| action_type | `RedactionActionType` |  |
| original_text | `str` |  |
| replacement | `TextReplacement` |  |

### action_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/action_type.md

##### Definition:
```python
@property
def action_type(self):
    ...
```

### details property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/details.md

##### Definition:
```python
@property
def details(self):
    ...
@details.setter
def details(self, value):
    ...
```

### image_area_replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/image_area_replacement.md

##### Definition:
```python
@property
def image_area_replacement(self):
    ...
```

### original_text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/original_text.md

##### Definition:
```python
@property
def original_text(self):
    ...
```

### redaction_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/redaction_type.md

##### Definition:
```python
@property
def redaction_type(self):
    ...
```

### replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiondescription/replacement.md

##### Definition:
```python
@property
def replacement(self):
    ...
```

### RedactionFilter class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactionfilter.md

#### RedactionFilter class

The RedactionFilter type exposes the following members:

### RedactionType class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype.md

#### RedactionType class

The RedactionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TEXT |  |
| METADATA |  |
| ANNOTATION |  |
| IMAGE_AREA |  |
| PAGE |  |

### ANNOTATION field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype/annotation.md

##### Value
`2`

### IMAGE_AREA field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype/image_area.md

##### Value
`3`

### METADATA field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype/metadata.md

##### Value
`1`

### PAGE field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype/page.md

##### Value
`4`

### TEXT field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/redactiontype/text.md

##### Value
`0`

### RegexRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction.md

#### RegexRedaction class

The RegexRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_regex_replacement_options |  |
| _init_string_replacement_options |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |
| regular_expression |  |
| action_options |  (inherited from `TextRedaction`) |
| ocr_connector |  (inherited from `TextRedaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_regex_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/_init_regex_replacement_options.md

#### _init_regex_replacement_options

```python
def _init_regex_replacement_options(self, regex, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| regex | `Any` |  |
| options | `ReplacementOptions` |  |

### _init_string_replacement_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/_init_string_replacement_options.md

#### _init_string_replacement_options

```python
def _init_string_replacement_options(self, pattern, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pattern | `str` |  |
| options | `ReplacementOptions` |  |

### action_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/action_options.md

#### action_options property

Gets the `ReplacementOptions` instance, specifying type of text replacement.
##### Definition:
```python
@property
def action_options(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/ocr_connector.md

#### ocr_connector property

Gets or sets the `IOcrConnector` implementation, required to extract text from graphic content.
##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### regular_expression property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regexredaction/regular_expression.md

##### Definition:
```python
@property
def regular_expression(self):
    ...
```

### RegionReplacementOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions.md

#### RegionReplacementOptions class

The RegionReplacementOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_color_font_string |  |
| _init_color_size |  |

##### Properties
| Property | Description |
| :- | :- |
| fill_color |  |
| size |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_color_font_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions/_init_color_font_string.md

#### _init_color_font_string

```python
def _init_color_font_string(self, fill_color, font, expected_text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| fill_color | `Color` |  |
| font | `Font` |  |
| expected_text | `str` |  |

### _init_color_size method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions/_init_color_size.md

#### _init_color_size

```python
def _init_color_size(self, fill_color, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| fill_color | `Color` |  |
| size | `Size` |  |

### fill_color property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions/fill_color.md

##### Definition:
```python
@property
def fill_color(self):
    ...
@fill_color.setter
def fill_color(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/regionreplacementoptions/size.md

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### RemovePageRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction.md

#### RemovePageRedaction class

The RemovePageRedaction type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| _init_page_seek_origin_int32_int32 |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| index |  |
| origin |  |
| description |  (inherited from `Redaction`) |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### _init_page_seek_origin_int32_int32 method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/_init_page_seek_origin_int32_int32.md

#### _init_page_seek_origin_int32_int32

```python
def _init_page_seek_origin_int32_int32(self, origin, index, count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| origin | `PageSeekOrigin` |  |
| index | `int` |  |
| count | `int` |  |

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### count property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/description.md

#### description property

Returns a string, describing the redaction and its parameters.
##### Definition:
```python
@property
def description(self):
    ...
```

### index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/index.md

##### Definition:
```python
@property
def index(self):
    ...
```

### origin property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/removepageredaction/origin.md

##### Definition:
```python
@property
def origin(self):
    ...
```

### ReplacementOptions class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions.md

#### ReplacementOptions class

The ReplacementOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_color |  |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| action_type |  |
| box_color |  |
| custom_redaction |  |
| filters |  |
| replacement |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_color method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/_init_color.md

#### _init_color

```python
def _init_color(self, color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| color | `Color` |  |

### _init_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/_init_string.md

#### _init_string

```python
def _init_string(self, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| replacement | `str` |  |

### action_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/action_type.md

##### Definition:
```python
@property
def action_type(self):
    ...
```

### box_color property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/box_color.md

##### Definition:
```python
@property
def box_color(self):
    ...
@box_color.setter
def box_color(self, value):
    ...
```

### custom_redaction property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/custom_redaction.md

##### Definition:
```python
@property
def custom_redaction(self):
    ...
@custom_redaction.setter
def custom_redaction(self, value):
    ...
```

### filters property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/filters.md

##### Definition:
```python
@property
def filters(self):
    ...
@filters.setter
def filters(self, value):
    ...
```

### replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementoptions/replacement.md

##### Definition:
```python
@property
def replacement(self):
    ...
@replacement.setter
def replacement(self, value):
    ...
```

### ReplacementType class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementtype.md

#### ReplacementType class

The ReplacementType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| REPLACE_STRING |  |
| DRAW_BOX |  |

### DRAW_BOX field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementtype/draw_box.md

##### Value
`1`

### REPLACE_STRING field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/replacementtype/replace_string.md

##### Value
`0`

### TextRedaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textredaction.md

#### TextRedaction class

The TextRedaction type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  (inherited from `Redaction`) |
| apply_to |  (inherited from `Redaction`) |
| apply_to_document_format_instance |  (inherited from `Redaction`) |

##### Properties
| Property | Description |
| :- | :- |
| action_options |  |
| ocr_connector |  |
| description |  (inherited from `Redaction`) |

### action_options property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textredaction/action_options.md

##### Definition:
```python
@property
def action_options(self):
    ...
```

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textredaction/apply_to.md

#### apply_to(self, format_instance)

Applies the redaction to a given format instance.

##### Returns

Status of the redaction: success/failure and error message if any

```python

def apply_to(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | groupdocs.redaction.integration.DocumentFormatInstance | An instance of a document to apply redaction |

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textredaction/description.md

#### description property

Returns a string, describing the redaction and its parameters.
##### Definition:
```python
@property
def description(self):
    ...
```

### ocr_connector property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textredaction/ocr_connector.md

##### Definition:
```python
@property
def ocr_connector(self):
    ...
@ocr_connector.setter
def ocr_connector(self, value):
    ...
```

### TextReplacement class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement.md

#### TextReplacement class

The TextReplacement type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_string_string |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| index |  |
| original_text |  |
| replacement |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_string_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/_init_int32_string_string.md

#### _init_int32_string_string

```python
def _init_int32_string_string(self, index, original, replacement):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |
| original | `str` |  |
| replacement | `str` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### index property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/index.md

##### Definition:
```python
@property
def index(self):
    ...
```

### original_text property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/original_text.md

##### Definition:
```python
@property
def original_text(self):
    ...
```

### replacement property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/replacement.md

##### Definition:
```python
@property
def replacement(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.redactions/textreplacement/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### groupdocs.redaction
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction.md

Main GroupDocs.Redaction namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `DocumentInfo` |  |
| `FileType` |  |
| `IDocumentInfo` |  |
| `License` | Manages GroupDocs.Redaction licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |
| `PageInfo` |  |
| `Redaction` |  |
| `RedactionPolicy` |  |
| `RedactionResult` |  |
| `Redactor` |  |
| `RedactorChangeLog` |  |
| `RedactorLogEntry` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `RedactionStatus` |  |

##### Exceptions
| Exception | Description |
| :- | :- |
| `DocumentFormatException` |  |
| `GroupDocsRedactionException` |  |
| `IncorrectPasswordException` |  |
| `PasswordRequiredException` |  |
| `TrialLimitationsException` |  |

### DocumentFormatException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentformatexception.md

#### DocumentFormatException class

The DocumentFormatException type exposes the following members:

### DocumentInfo class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentinfo.md

#### DocumentInfo class

The DocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| page_count |  |
| pages |  |
| size |  |

### file_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/documentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### FileType class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/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_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/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### bmp property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/bmp.md

#### bmp property

Bitmap Image File (.bmp)
##### Definition:
```python
@property
def bmp(self):
    ...
```

### csv property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/csv.md

#### csv property

Comma Separated Values File (.csv)
##### Definition:
```python
@property
def csv(self):
    ...
```

### doc property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/doc.md

#### doc property

Microsoft Word Document (.doc)
##### Definition:
```python
@property
def doc(self):
    ...
```

### docm property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/docm.md

#### docm property

Word Open XML Macro-Enabled Document (.docm)
##### Definition:
```python
@property
def docm(self):
    ...
```

### docx property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/docx.md

#### docx property

Microsoft Word Open XML Document (.docx)
##### Definition:
```python
@property
def docx(self):
    ...
```

### dot property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/dot.md

#### dot property

Word Document Template (.dot)
##### Definition:
```python
@property
def dot(self):
    ...
```

### dotm property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/dotm.md

#### dotm property

Word Open XML Macro-Enabled Document Template (.dotm)
##### Definition:
```python
@property
def dotm(self):
    ...
```

### dotx property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/dotx.md

#### dotx property

Word Open XML Document Template (.dotx)
##### Definition:
```python
@property
def dotx(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_file_type method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** FileType

### get_hash_code method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_supported_file_types method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/filetype/gif.md

#### gif property

Graphical Interchange Format File (.gif)
##### Definition:
```python
@property
def gif(self):
    ...
```

### htm property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/htm.md

#### htm property

Hypertext Markup Language File (.htm)
##### Definition:
```python
@property
def htm(self):
    ...
```

### html property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/html.md

#### html property

Hypertext Markup Language File (.html)
##### Definition:
```python
@property
def html(self):
    ...
```

### jp2 property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/jp2.md

#### jp2 property

JPEG 2000 Core Image File (.jp2)
##### Definition:
```python
@property
def jp2(self):
    ...
```

### jpeg property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/jpeg.md

#### jpeg property

JPEG Image (.jpeg)
##### Definition:
```python
@property
def jpeg(self):
    ...
```

### jpg property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/jpg.md

#### jpg property

JPEG Image (.jpg)
##### Definition:
```python
@property
def jpg(self):
    ...
```

### md property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/md.md

#### md property

Markdown Documentation File (.md)
##### Definition:
```python
@property
def md(self):
    ...
```

### numbers property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/numbers.md

#### numbers property

Apple Numbers Spreadsheet (.numbers)
##### Definition:
```python
@property
def numbers(self):
    ...
```

### odp property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/odp.md

#### odp property

OpenDocument Presentation (.odp)
##### Definition:
```python
@property
def odp(self):
    ...
```

### ods property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/ods.md

#### ods property

OpenDocument Spreadsheet (.ods)
##### Definition:
```python
@property
def ods(self):
    ...
```

### odt property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/odt.md

#### odt property

OpenDocument Text Document (.odt)
##### Definition:
```python
@property
def odt(self):
    ...
```

### ots property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/ots.md

#### ots property

OpenDocument Spreadsheet Template (.ots)
##### Definition:
```python
@property
def ots(self):
    ...
```

### ott property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/ott.md

#### ott property

OpenDocument Document Template (.ott)
##### Definition:
```python
@property
def ott(self):
    ...
```

### pdf property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/pdf.md

#### pdf property

Portable Document Format File (.pdf)
##### Definition:
```python
@property
def pdf(self):
    ...
```

### png property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/png.md

#### png property

Portable Network Graphic (.png)
##### Definition:
```python
@property
def png(self):
    ...
```

### ppt property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/ppt.md

#### ppt property

PowerPoint Presentation (.ppt)
##### Definition:
```python
@property
def ppt(self):
    ...
```

### pptx property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/pptx.md

#### pptx property

PowerPoint Open XML Presentation (.pptx)
##### Definition:
```python
@property
def pptx(self):
    ...
```

### rtf property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/rtf.md

#### rtf property

Rich Text Format File (.rtf)
##### Definition:
```python
@property
def rtf(self):
    ...
```

### tif property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/tif.md

#### tif property

Tagged Image File (.tif)
##### Definition:
```python
@property
def tif(self):
    ...
```

### tiff property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/tiff.md

#### tiff property

Tagged Image File Format (.tiff)
##### Definition:
```python
@property
def tiff(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### tsv property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/tsv.md

#### tsv property

Tab Separated Values File (.tsv)
##### Definition:
```python
@property
def tsv(self):
    ...
```

### txt property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/txt.md

#### txt property

Plain Text File (.txt)
##### Definition:
```python
@property
def txt(self):
    ...
```

### unknown property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/unknown.md

#### unknown property

Represents unknown file type.
##### Definition:
```python
@property
def unknown(self):
    ...
```

### xls property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/xls.md

#### xls property

Excel Spreadsheet (.xls)
##### Definition:
```python
@property
def xls(self):
    ...
```

### xlsb property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/xlsb.md

#### xlsb property

Excel Binary Spreadsheet (.xlsb)
##### Definition:
```python
@property
def xlsb(self):
    ...
```

### xlsm property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/xlsm.md

#### xlsm property

Excel Open XML Macro-Enabled Spreadsheet (.xlsm)
##### Definition:
```python
@property
def xlsm(self):
    ...
```

### xlsx property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/filetype/xlsx.md

#### xlsx property

Microsoft Excel Open XML Spreadsheet (.xlsx)
##### Definition:
```python
@property
def xlsx(self):
    ...
```

### GroupDocsRedactionException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/groupdocsredactionexception.md

#### GroupDocsRedactionException class

The GroupDocsRedactionException type exposes the following members:

### IDocumentInfo class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/idocumentinfo.md

#### IDocumentInfo class

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| page_count |  |
| pages |  |
| size |  |

### file_type property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/idocumentinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/idocumentinfo/page_count.md

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/idocumentinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/idocumentinfo/size.md

##### Definition:
```python
@property
def size(self):
    ...
```

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/incorrectpasswordexception.md

#### IncorrectPasswordException class

The IncorrectPasswordException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/license.md

#### License class

Manages GroupDocs.Redaction 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/redaction/python-net/groupdocs.redaction/license/__init__.md

#### \_\_init\_\_(self)

Initialize an instance of License class.

```python

def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/metered/__init__.md

#### \_\_init\_\_(self)

Initializes a new instance of Metered class.

```python

def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/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. |

### PageInfo class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/pageinfo.md

#### PageInfo class

The PageInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| page_number |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/pageinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/pageinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/pageinfo/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/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/redaction/python-net/groupdocs.redaction/pageinfo/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PasswordRequiredException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/passwordrequiredexception.md

#### PasswordRequiredException class

The PasswordRequiredException type exposes the following members:

### Redaction class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redaction.md

#### Redaction class

The Redaction type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _apply_to_document_format_instance |  |
| apply_to |  |
| apply_to_document_format_instance |  |

##### Properties
| Property | Description |
| :- | :- |
| description |  |

### _apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redaction/_apply_to_document_format_instance.md

#### _apply_to_document_format_instance

```python
def _apply_to_document_format_instance(self, format_instance):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format_instance | `DocumentFormatInstance` |  |

**Returns:** RedactorLogEntry

### apply_to method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redaction/apply_to.md

#### apply_to

```python
def apply_to(self):
    ...
```

### apply_to_document_format_instance method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redaction/apply_to_document_format_instance.md

#### apply_to_document_format_instance

```python
def apply_to_document_format_instance(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redaction/description.md

##### Definition:
```python
@property
def description(self):
    ...
```

### RedactionPolicy class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy.md

#### RedactionPolicy class

The RedactionPolicy type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_redaction_array |  |
| _load_stream |  |
| _load_string |  |
| _save_stream |  |
| _save_string |  |
| load |  |
| load_file |  |
| load_stream |  |
| load_streams |  |
| load_string |  |
| save |  |
| save_file |  |
| save_stream |  |
| save_streams |  |
| save_string |  |

##### Properties
| Property | Description |
| :- | :- |
| redactions |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_redaction_array method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_init_redaction_array.md

#### _init_redaction_array

```python
def _init_redaction_array(self, redactions):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redactions | `List[Redaction]` |  |

### _load_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_load_stream.md

#### _load_stream

```python
def _load_stream(cls, input):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| input | `Stream` |  |

**Returns:** RedactionPolicy

### _load_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_load_string.md

#### _load_string

```python
def _load_string(cls, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** RedactionPolicy

### _save_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_save_stream.md

#### _save_stream

```python
def _save_stream(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `Stream` |  |

### _save_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/_save_string.md

#### _save_string

```python
def _save_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### load method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/load.md

#### load

```python
def load(cls):
    ...
```

### load_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/load_file.md

#### load_file

```python
def load_file(cls):
    ...
```

### load_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/load_stream.md

#### load_stream

```python
def load_stream(cls):
    ...
```

### load_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/load_streams.md

#### load_streams

```python
def load_streams(cls):
    ...
```

### load_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/load_string.md

#### load_string

```python
def load_string(cls):
    ...
```

### redactions property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/redactions.md

##### Definition:
```python
@property
def redactions(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/save.md

#### save

```python
def save(self):
    ...
```

### save_file method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionpolicy/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### RedactionResult class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult.md

#### RedactionResult class

The RedactionResult type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| failed |  |
| partial |  |
| skipped |  |
| successful |  |

##### Properties
| Property | Description |
| :- | :- |
| error_message |  |
| status |  |

### error_message property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/error_message.md

##### Definition:
```python
@property
def error_message(self):
    ...
```

### failed method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/failed.md

#### failed

```python
def failed(cls, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | `str` |  |

**Returns:** RedactionResult

### partial method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/partial.md

#### partial

```python
def partial(cls, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | `str` |  |

**Returns:** RedactionResult

### skipped method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/skipped.md

#### skipped

```python
def skipped(cls, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| description | `str` |  |

**Returns:** RedactionResult

### status property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/status.md

##### Definition:
```python
@property
def status(self):
    ...
```

### successful method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionresult/successful.md

#### successful

```python
def successful(cls):
    ...
```

**Returns:** RedactionResult

### RedactionStatus class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionstatus.md

#### RedactionStatus class

The RedactionStatus type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| APPLIED |  |
| PARTIALLY_APPLIED |  |
| SKIPPED |  |
| FAILED |  |

### APPLIED field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionstatus/applied.md

##### Value
`0`

### FAILED field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionstatus/failed.md

##### Value
`3`

### PARTIALLY_APPLIED field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionstatus/partially_applied.md

##### Value
`1`

### SKIPPED field
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactionstatus/skipped.md

##### Value
`2`

### Redactor class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor.md

#### Redactor class

The Redactor type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _apply_redaction |  |
| _apply_redaction_array |  |
| _apply_redaction_policy |  |
| _dispose_noargs |  |
| _generate_preview_preview_options |  |
| _get_document_info_noargs |  |
| _init_stream |  |
| _init_stream_load_options |  |
| _init_stream_load_options_redactor_settings |  |
| _init_string |  |
| _init_string_load_options |  |
| _init_string_load_options_redactor_settings |  |
| _save_noargs |  |
| _save_save_options |  |
| _save_stream_rasterization_options |  |
| apply |  |
| apply_redaction |  |
| apply_redaction_policy |  |
| dispose |  |
| generate_preview |  |
| generate_preview_preview_options |  |
| get_document_info |  |
| save |  |
| save_save_options |  |
| save_stream |  |
| save_streams |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _apply_redaction method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_apply_redaction.md

#### _apply_redaction

```python
def _apply_redaction(self, redaction):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redaction | `Redaction` |  |

**Returns:** RedactorChangeLog

### _apply_redaction_array method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_apply_redaction_array.md

#### _apply_redaction_array

```python
def _apply_redaction_array(self, redactions):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redactions | `List[Redaction]` |  |

**Returns:** RedactorChangeLog

### _apply_redaction_policy method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_apply_redaction_policy.md

#### _apply_redaction_policy

```python
def _apply_redaction_policy(self, policy):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| policy | `RedactionPolicy` |  |

**Returns:** RedactorChangeLog

### _dispose_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _generate_preview_preview_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_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/redaction/python-net/groupdocs.redaction/redactor/_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/redaction/python-net/groupdocs.redaction/redactor/_init_stream.md

#### _init_stream

```python
def _init_stream(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |

### _init_stream_load_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_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_redactor_settings method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_init_stream_load_options_redactor_settings.md

#### _init_stream_load_options_redactor_settings

```python
def _init_stream_load_options_redactor_settings(self, document, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| load_options | `LoadOptions` |  |
| settings | `RedactorSettings` |  |

### _init_string method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_load_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_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_redactor_settings method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_init_string_load_options_redactor_settings.md

#### _init_string_load_options_redactor_settings

```python
def _init_string_load_options_redactor_settings(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |
| settings | `RedactorSettings` |  |

### _save_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_save_noargs.md

#### _save_noargs

```python
def _save_noargs(self):
    ...
```

**Returns:** str

### _save_save_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_save_save_options.md

#### _save_save_options

```python
def _save_save_options(self, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| save_options | `SaveOptions` |  |

**Returns:** str

### _save_stream_rasterization_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/_save_stream_rasterization_options.md

#### _save_stream_rasterization_options

```python
def _save_stream_rasterization_options(self, document, rasterization_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `Stream` |  |
| rasterization_options | `RasterizationOptions` |  |

### apply method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/apply.md

#### apply

```python
def apply(self):
    ...
```

### apply_redaction method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/apply_redaction.md

#### apply_redaction

```python
def apply_redaction(self):
    ...
```

### apply_redaction_policy method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/apply_redaction_policy.md

#### apply_redaction_policy

```python
def apply_redaction_policy(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/generate_preview.md

#### generate_preview

```python
def generate_preview(self):
    ...
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/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/redaction/python-net/groupdocs.redaction/redactor/get_document_info.md

#### get_document_info

```python
def get_document_info(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/save.md

#### save

```python
def save(self):
    ...
```

### save_save_options method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/save_save_options.md

#### save_save_options

```python
def save_save_options(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactor/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### RedactorChangeLog class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorchangelog.md

#### RedactorChangeLog class

The RedactorChangeLog type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| redaction_log |  |
| status |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorchangelog/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorchangelog/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### redaction_log property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorchangelog/redaction_log.md

##### Definition:
```python
@property
def redaction_log(self):
    ...
```

### status property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorchangelog/status.md

##### Definition:
```python
@property
def status(self):
    ...
```

### RedactorLogEntry class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorlogentry.md

#### RedactorLogEntry class

The RedactorLogEntry type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_redaction_redaction_result |  |

##### Properties
| Property | Description |
| :- | :- |
| redaction |  |
| result |  |

### __init__ constructor
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorlogentry/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_redaction_redaction_result method
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorlogentry/_init_redaction_redaction_result.md

#### _init_redaction_redaction_result

```python
def _init_redaction_redaction_result(self, redaction, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| redaction | `Redaction` |  |
| result | `RedactionResult` |  |

### redaction property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorlogentry/redaction.md

##### Definition:
```python
@property
def redaction(self):
    ...
```

### result property
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/redactorlogentry/result.md

##### Definition:
```python
@property
def result(self):
    ...
```

### TrialLimitationsException class
Path: https://reference.groupdocs.com/redaction/python-net/groupdocs.redaction/triallimitationsexception.md

#### TrialLimitationsException class

The TrialLimitationsException type exposes the following members:


# GroupDocs.Search

> Index and full-text search with fuzzy, synonym, regex, and faceted queries.

## Java

### GroupDocs.Search for Java
Path: https://reference.groupdocs.com/search/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.search | The package provides classes for indexing and searching text data in documents of different formats.
 |
| com.groupdocs.search.common | The package provides common classes of the library.
 |
| com.groupdocs.search.dictionaries | The package provides classes of various dictionaries.
 |
| com.groupdocs.search.events | The package provides classes of event arguments.
 |
| com.groupdocs.search.exceptions |  |
| com.groupdocs.search.helpers |  |
| com.groupdocs.search.highlighters | The package provides highlighters for highlighting search results in text.
 |
| com.groupdocs.search.licenses |  |
| com.groupdocs.search.logging |  |
| com.groupdocs.search.options | The package provides classes to specify additional options of various operations.
 |
| com.groupdocs.search.results | The package provides search result classes.
 |
| com.groupdocs.search.scaling | The namespace provides classes of scaling functionality.
 |
| com.groupdocs.search.scaling.configuring | The namespace provides classes for configuring the search network.
 |
| com.groupdocs.search.scaling.events | The namespace provides classes of event arguments in the search network.
 |
| com.groupdocs.search.scaling.results | The namespace provides the search result classes in the search network.
 |

### com.groupdocs.search.common
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common.md

The package provides common classes of the library.

#### Classes

| Class | Description |
| --- | --- |
| AttributeChangeBatch | Represents a container for attribute changes. |
| Cancellation | Represents an object for requesting cancellation of an operation. |
| ChunkSearchToken | Represents a token for the continuation of the chunk search (search by pages). |
| CustomExtractorCollection | Contains a collection of custom extractors. |
| Delegate | Represents a delegate, which refers to a class instance that has a method to be invoked. |
| DocumentField | Represents a document field data. |
| DocumentImage | Represents a document image data. |
| Encodings | Contains names of possible encodings. |
| ExtractedItemInfo | Represents a container item information. |
| ExtractorSettings | Contains settings for the document data extractor. |
| FileLogger | Represents a logger that logs events and errors to a local file. |
| FileOutputAdapter | Represents an output adapter that collects output into a file. |
| FragmentContainer | Represents a container for text fragments with highlighted found terms of one document field. |
| ImageFrame | Represents an image frame. |
| IndexInfo | Contains basic information on an  Index . |
| IndexingReport | Represents a detailed information on an indexing operation. |
| MulticastDelegate | Represents a delegate, which refers to class instances that have method to be invoked. |
| OutputAdapter | Represents the base class of an output adapter that is used to collect an output in a generalized form. |
| ResultBuilderFactory | Represents the base class of a result builder factory. |
| SearchImage | Represents an image to search. |
| SearchReport | Represents a detailed information on a search operation. |
| StreamOutputAdapter | Represents an output adapter that collects output into a  java.io.OutputStream . |
| StringOutputAdapter | Represents an output adapter that collects output as a  System.String . |
| StructureOutputAdapter | Represents an output adapter that collects output as a structure containing each field separately. |
| WordPattern | Represents a word pattern to use in word wildcard search. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IContainerItemExtractor | Provides methods for extracting items from container documents. |
| IDocumentLoader | Defines the document loader interface that is used to load lazy documents. |
| IFieldExtractor | Provides methods for extracting fields from a document. |
| ILogger | Defines interface of a logger that is used for logging events and errors in an index. |

#### Enumerations

| Enum | Description |
| --- | --- |
| DocumentSourceKind | Defines the kinds of document sources. |
| DocumentStatus | Represents a document processing status. |
| IndexStatus | Specifies an index status. |
| VersionUpdateResult | Represents the result of an index version update operation. |

### AttributeChangeBatch
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/attributechangebatch.md

**Inheritance:**
java.lang.Object
```
public class AttributeChangeBatch
```

Represents a container for attribute changes.

#### Constructors

| Constructor | Description |
| --- | --- |
| AttributeChangeBatch() | Initializes a new instance of the  AttributeChangeBatch  class.
 |
| AttributeChangeBatch(Object data) | Initializes a new instance of the  AttributeChangeBatch  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| add(String path, String[] attributes) | Adds the specified attributes to the specified indexed document.
 |
| add(String[] paths, String[] attributes) | Adds the specified attributes to the specified indexed documents.
 |
| addToAll(String[] attributes) | Adds the specified attributes to all documents in the index.
 |
| remove(String path, String[] attributes) | Removes the specified attributes from the specified indexed document.
 |
| remove(String[] paths, String[] attributes) | Removes the specified attributes from the specified indexed documents.
 |
| removeAll(String path) | Removes all attributes from the specified indexed document.
 |
| removeAll(String[] paths) | Removes all attributes from the specified indexed documents.
 |
| removeFromAll(String[] attributes) | Removes the specified attributes from all documents in the index.
 |
| clear() | Removes all attributes from all documents in the index.
 |
| getCore() |  |
##### AttributeChangeBatch()
```
public AttributeChangeBatch()
```

Initializes a new instance of the  AttributeChangeBatch  class.

##### AttributeChangeBatch(Object data)
```
public AttributeChangeBatch(Object data)
```

Initializes a new instance of the  AttributeChangeBatch  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### add(String path, String[] attributes)
```
public void add(String path, String[] attributes)
```

Adds the specified attributes to the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The document path.
 |
| attributes | java.lang.String[] | The attributes to add.
 |

##### add(String[] paths, String[] attributes)
```
public void add(String[] paths, String[] attributes)
```

Adds the specified attributes to the specified indexed documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The documents paths.
 |
| attributes | java.lang.String[] | The attributes to add.
 |

##### addToAll(String[] attributes)
```
public void addToAll(String[] attributes)
```

Adds the specified attributes to all documents in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attributes | java.lang.String[] | The attributes to add.
 |

##### remove(String path, String[] attributes)
```
public void remove(String path, String[] attributes)
```

Removes the specified attributes from the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The document path.
 |
| attributes | java.lang.String[] | The attributes to remove.
 |

##### remove(String[] paths, String[] attributes)
```
public void remove(String[] paths, String[] attributes)
```

Removes the specified attributes from the specified indexed documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The documents paths.
 |
| attributes | java.lang.String[] | The attributes to remove.
 |

##### removeAll(String path)
```
public void removeAll(String path)
```

Removes all attributes from the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The document path.
 |

##### removeAll(String[] paths)
```
public void removeAll(String[] paths)
```

Removes all attributes from the specified indexed documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The documents paths.
 |

##### removeFromAll(String[] attributes)
```
public void removeFromAll(String[] attributes)
```

Removes the specified attributes from all documents in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attributes | java.lang.String[] | The attributes to remove.
 |

##### clear()
```
public void clear()
```

Removes all attributes from all documents in the index.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### Cancellation
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/cancellation.md

**Inheritance:**
java.lang.Object
```
public class Cancellation
```

Represents an object for requesting cancellation of an operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| Cancellation() | Initializes a new instance of the
Cancellation
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isCancelled() | Gets a value indicating that cancellation has been requested.
 |
| cancel() | Makes a request for cancellation.
 |
| cancelAfter(int milliseconds) | Makes a request for cancellation after the expiration of specified number of milliseconds.
 |
##### Cancellation()
```
public Cancellation()
```

Initializes a new instance of the
Cancellation
 class.

##### isCancelled()
```
public final boolean isCancelled()
```

Gets a value indicating that cancellation has been requested.

**Returns:**
boolean - A value indicating that cancellation has been requested.

##### cancel()
```
public final void cancel()
```

Makes a request for cancellation.

##### cancelAfter(int milliseconds)
```
public final void cancelAfter(int milliseconds)
```

Makes a request for cancellation after the expiration of specified number of milliseconds.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| milliseconds | int | The number of milliseconds after which an operation will be cancelled.
 |

### ChunkSearchToken
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/chunksearchtoken.md

**Inheritance:**
java.lang.Object
```
public abstract class ChunkSearchToken
```

Represents a token for the continuation of the chunk search (search by pages).

#### Constructors

| Constructor | Description |
| --- | --- |
| ChunkSearchToken() |  |
##### ChunkSearchToken()
```
public ChunkSearchToken()
```

### CustomExtractorCollection
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/customextractorcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class CustomExtractorCollection implements Iterable
```

Contains a collection of custom extractors. If the collection contains an extractor for some file extension that is covered by build-in extractors, then this extractor will be used instead of built-in one.

#### Constructors

| Constructor | Description |
| --- | --- |
| CustomExtractorCollection() |  |
#### Methods

| Method | Description |
| --- | --- |
| size() | Gets the number of extractors contained in the collection.
 |
| isReadOnly() | Gets a value indicating whether the collection is read-only.
 |
| iterator() | Returns an iterator for this collection.
 |
| addItem(IFieldExtractor extractor) | Adds an extractor to the collection.
 |
| clear() | Removes all extractors from the collection.
 |
| containsItem(IFieldExtractor item) | Determines whether the collection contains a specific extractor.
 |
| copyToTArray(IFieldExtractor[] array, int arrayIndex) | Copies the elements of the collection to an array, starting at a particular array index.
 |
| removeItem(IFieldExtractor extractor) | Removes an extractor from the collection.
 |
##### CustomExtractorCollection()
```
public CustomExtractorCollection()
```

##### size()
```
public abstract int size()
```

Gets the number of extractors contained in the collection.

**Returns:**
int - The number of extractors contained in the collection.

##### isReadOnly()
```
public abstract boolean isReadOnly()
```

Gets a value indicating whether the collection is read-only.

**Returns:**
boolean - A value indicating whether the collection is read-only.

##### iterator()
```
public abstract Iterator<IFieldExtractor> iterator()
```

Returns an iterator for this collection.

**Returns:**
java.util.Iterator<com.groupdocs.search.common.IFieldExtractor> - An iterator object that can be used to iterate through the collection.

##### addItem(IFieldExtractor extractor)
```
public abstract void addItem(IFieldExtractor extractor)
```

Adds an extractor to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractor | IFieldExtractor | The extractor to add to the collection.
 |

##### clear()
```
public abstract void clear()
```

Removes all extractors from the collection.

##### containsItem(IFieldExtractor item)
```
public abstract boolean containsItem(IFieldExtractor item)
```

Determines whether the collection contains a specific extractor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | IFieldExtractor | The extractor to locate in the collection.
 |

**Returns:**
boolean -  true  if  item  is found in the collection; otherwise,  false .

##### copyToTArray(IFieldExtractor[] array, int arrayIndex)
```
public abstract void copyToTArray(IFieldExtractor[] array, int arrayIndex)
```

Copies the elements of the collection to an array, starting at a particular array index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | IFieldExtractor\[\] | The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing.
 |
| arrayIndex | int | The zero-based index in array at which copying begins.
 |

##### removeItem(IFieldExtractor extractor)
```
public abstract boolean removeItem(IFieldExtractor extractor)
```

Removes an extractor from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractor | IFieldExtractor | The extractor to remove from the collection.
 |

**Returns:**
boolean -  true  if  extractor  was successfully removed from the collection; otherwise,  false . This method also returns  false  if  extractor  is not found in the original collection.

### Delegate
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/delegate.md

**Inheritance:**
java.lang.Object
```
public abstract class Delegate
```

Represents a delegate, which refers to a class instance that has a method to be invoked.

#### Constructors

| Constructor | Description |
| --- | --- |
| Delegate() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInvocationList() | Returns an invocation list.
 |
| combine(Delegate a, Delegate b) | Combines two delegates into one.
 |
| combine(Delegate[] delegates) | Combines several delegates into one.
 |
| remove(Delegate source, Delegate value) | Removes the value delegate from the source delegate.
 |
| removeAll(Delegate source, Delegate value) | Removes the value delegate from the source delegate.
 |
| op_Equality(Delegate d1, Delegate d2) | Checks two delegates for equality.
 |
| op_Inequality(Delegate d1, Delegate d2) | Checks two delegates for inequality.
 |
##### Delegate()
```
public Delegate()
```

##### getInvocationList()
```
public Delegate[] getInvocationList()
```

Returns an invocation list.

**Returns:**
com.groupdocs.search.common.Delegate[] - An invocation list.

##### combine(Delegate a, Delegate b)
```
public static Delegate combine(Delegate a, Delegate b)
```

Combines two delegates into one.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| a | Delegate | The first delegate to combine.
 |
| b | Delegate | The second delegate to combine.
 |

**Returns:**
Delegate - A new combined delegate.

##### combine(Delegate[] delegates)
```
public static Delegate combine(Delegate[] delegates)
```

Combines several delegates into one.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| delegates | Delegate\[\] | The delegates to combine.
 |

**Returns:**
Delegate - A new combined delegate.

##### remove(Delegate source, Delegate value)
```
public static Delegate remove(Delegate source, Delegate value)
```

Removes the value delegate from the source delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | Delegate | The source delegate.
 |
| value | Delegate | The value delegate.
 |

**Returns:**
Delegate - A new delegate that is a result of removing.

##### removeAll(Delegate source, Delegate value)
```
public static Delegate removeAll(Delegate source, Delegate value)
```

Removes the value delegate from the source delegate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | Delegate | The source delegate.
 |
| value | Delegate | The value delegate.
 |

**Returns:**
Delegate - A new delegate that is a result of removing.

##### op_Equality(Delegate d1, Delegate d2)
```
public static boolean op_Equality(Delegate d1, Delegate d2)
```

Checks two delegates for equality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| d1 | Delegate | The first delegate.
 |
| d2 | Delegate | The second delegate.
 |

**Returns:**
boolean - The result of checking two delegates for equality.

##### op_Inequality(Delegate d1, Delegate d2)
```
public static boolean op_Inequality(Delegate d1, Delegate d2)
```

Checks two delegates for inequality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| d1 | Delegate | The first delegate.
 |
| d2 | Delegate | The second delegate.
 |

**Returns:**
boolean - The result of checking two delegates for inequality.

### DocumentField
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/documentfield.md

**Inheritance:**
java.lang.Object
```
public class DocumentField
```

Represents a document field data.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentField(String name, String value) | Initializes a new instance of the  DocumentField  class.
 |
| DocumentField(Object data) | Initializes a new instance of the  DocumentField  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets a field name.
 |
| getValue() | Gets a field value.
 |
| getCore() |  |
##### DocumentField(String name, String value)
```
public DocumentField(String name, String value)
```

Initializes a new instance of the  DocumentField  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The field name.
 |
| value | java.lang.String | The field value.
 |

##### DocumentField(Object data)
```
public DocumentField(Object data)
```

Initializes a new instance of the  DocumentField  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getName()
```
public String getName()
```

Gets a field name.

**Returns:**
java.lang.String - The field name.

##### getValue()
```
public String getValue()
```

Gets a field value.

**Returns:**
java.lang.String - The field value.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### DocumentImage
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/documentimage.md

**Inheritance:**
java.lang.Object
```
public abstract class DocumentImage
```

Represents a document image data.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentImage() |  |
#### Methods

| Method | Description |
| --- | --- |
| getImageIndex() | Gets the ordinal number of the image in the document.
 |
| getFields() | Gets the extracted fields.
 |
| getFrames() | Gets the image frames.
 |
##### DocumentImage()
```
public DocumentImage()
```

##### getImageIndex()
```
public abstract int getImageIndex()
```

Gets the ordinal number of the image in the document.

**Returns:**
int - The ordinal number of the image in the document.

##### getFields()
```
public abstract DocumentField[] getFields()
```

Gets the extracted fields.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The extracted fields.

##### getFrames()
```
public abstract ImageFrame[] getFrames()
```

Gets the image frames.

**Returns:**
com.groupdocs.search.common.ImageFrame[] - The image frames.

### DocumentSourceKind
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/documentsourcekind.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum DocumentSourceKind extends Enum<DocumentSourceKind>
```

Defines the kinds of document sources.

#### Fields

| Field | Description |
| --- | --- |
| File | The file document source.
 |
| Stream | The stream document source.
 |
| Structure | The structure document source.
 |
| ExtractedData | The document source of previously extracted data.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### File
```
public static final DocumentSourceKind File
```

The file document source.

##### Stream
```
public static final DocumentSourceKind Stream
```

The stream document source.

##### Structure
```
public static final DocumentSourceKind Structure
```

The structure document source.

##### ExtractedData
```
public static final DocumentSourceKind ExtractedData
```

The document source of previously extracted data.

##### values()
```
public static DocumentSourceKind[] values()
```

**Returns:**
com.groupdocs.search.common.DocumentSourceKind[]
##### valueOf(String name)
```
public static DocumentSourceKind valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DocumentSourceKind

### DocumentStatus
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/documentstatus.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum DocumentStatus extends Enum<DocumentStatus>
```

Represents a document processing status.

#### Fields

| Field | Description |
| --- | --- |
| SuccessfullyProcessed | Document successfully indexed.
 |
| Skipped | Document skipped.
 |
| ProcessedWithError | Error occurred during document indexing.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### SuccessfullyProcessed
```
public static final DocumentStatus SuccessfullyProcessed
```

Document successfully indexed.

##### Skipped
```
public static final DocumentStatus Skipped
```

Document skipped.

##### ProcessedWithError
```
public static final DocumentStatus ProcessedWithError
```

Error occurred during document indexing.

##### values()
```
public static DocumentStatus[] values()
```

**Returns:**
com.groupdocs.search.common.DocumentStatus[]
##### valueOf(String name)
```
public static DocumentStatus valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DocumentStatus

### Encodings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/encodings.md

**Inheritance:**
java.lang.Object
```
public class Encodings
```

Contains names of possible encodings.

#### Constructors

| Constructor | Description |
| --- | --- |
| Encodings() |  |
#### Fields

| Field | Description |
| --- | --- |
| IBM037 | The IBM037 encoding.
 |
| IBM437 | The IBM437 encoding.
 |
| IBM500 | The IBM500 encoding.
 |
| ASMO_708 | The ASMO-708 encoding.
 |
| DOS_720 | The DOS-720 encoding.
 |
| ibm737 | The ibm737 encoding.
 |
| ibm775 | The ibm775 encoding.
 |
| ibm850 | The ibm850 encoding.
 |
| ibm852 | The ibm852 encoding.
 |
| IBM855 | The IBM855 encoding.
 |
| ibm857 | The ibm857 encoding.
 |
| IBM00858 | The IBM00858 encoding.
 |
| IBM860 | The IBM860 encoding.
 |
| ibm861 | The ibm861 encoding.
 |
| DOS_862 | The DOS-862 encoding.
 |
| IBM863 | The IBM863 encoding.
 |
| IBM864 | The IBM864 encoding.
 |
| IBM865 | The IBM865 encoding.
 |
| cp866 | The cp866 encoding.
 |
| ibm869 | The ibm869 encoding.
 |
| IBM870 | The IBM870 encoding.
 |
| windows_874 | The windows-874 encoding.
 |
| cp875 | The cp875 encoding.
 |
| shift_jis | The shift_jis encoding.
 |
| gb2312 | The gb2312 encoding.
 |
| ks_c_5601_1987 | The ks_c_5601-1987 encoding.
 |
| big5 | The big5 encoding.
 |
| IBM1026 | The IBM1026 encoding.
 |
| IBM01047 | The IBM01047 encoding.
 |
| IBM01140 | The IBM01140 encoding.
 |
| IBM01141 | The IBM01141 encoding.
 |
| IBM01142 | The IBM01142 encoding.
 |
| IBM01143 | The IBM01143 encoding.
 |
| IBM01144 | The IBM01144 encoding.
 |
| IBM01145 | The IBM01145 encoding.
 |
| IBM01146 | The IBM01146 encoding.
 |
| IBM01147 | The IBM01147 encoding.
 |
| IBM01148 | The IBM01148 encoding.
 |
| IBM01149 | The IBM01149 encoding.
 |
| utf_16 | The utf-16 encoding.
 |
| utf_16BE | The utf-16BE encoding.
 |
| Windows_1250 | The Windows-1250 encoding.
 |
| Windows_1251 | The Windows-1251 encoding.
 |
| Windows_1252 | The Windows-1252 encoding.
 |
| Windows_1253 | The Windows-1253 encoding.
 |
| Windows_1254 | The Windows-1254 encoding.
 |
| Windows_1255 | The Windows-1255 encoding.
 |
| Windows_1256 | The Windows-1256 encoding.
 |
| Windows_1257 | The Windows-1257 encoding.
 |
| Windows_1258 | The Windows-1258 encoding.
 |
| Johab | The Johab encoding.
 |
| macintosh | The macintosh encoding.
 |
| x_mac_japanese | The x-mac-japanese encoding.
 |
| x_mac_chinesetrad | The x-mac-chinesetrad encoding.
 |
| x_mac_korean | The x-mac-korean encoding.
 |
| x_mac_arabic | The x-mac-arabic encoding.
 |
| x_mac_hebrew | The x-mac-hebrew encoding.
 |
| x_mac_greek | The x-mac-greek encoding.
 |
| x_mac_cyrillic | The x-mac-cyrillic encoding.
 |
| x_mac_chinesesimp | The x-mac-chinesesimp encoding.
 |
| x_mac_romanian | The x-mac-romanian encoding.
 |
| x_mac_ukrainian | The x-mac-ukrainian encoding.
 |
| x_mac_thai | The x-mac-thai encoding.
 |
| x_mac_ce | The x-mac-ce encoding.
 |
| x_mac_icelandic | The x-mac-icelandic encoding.
 |
| x_mac_turkish | The x-mac-turkish encoding.
 |
| x_mac_croatian | The x-mac-croatian encoding.
 |
| utf_32 | The utf-32 encoding.
 |
| utf_32BE | The utf-32BE encoding.
 |
| x_Chinese_CNS | The x-Chinese-CNS encoding.
 |
| x_cp20001 | The x-cp20001 encoding.
 |
| x_Chinese_Eten | The x-Chinese-Eten encoding.
 |
| x_cp20003 | The x-cp20003 encoding.
 |
| x_cp20004 | The x-cp20004 encoding.
 |
| x_cp20005 | The x-cp20005 encoding.
 |
| x_IA5 | The x-IA5 encoding.
 |
| x_IA5_German | The x-IA5-German encoding.
 |
| x_IA5_Swedish | The x-IA5-Swedish encoding.
 |
| x_IA5_Norwegian | The x-IA5-Norwegian encoding.
 |
| us_ascii | The us-ascii encoding.
 |
| x_cp20261 | The x-cp20261 encoding.
 |
| x_cp20269 | The x-cp20269 encoding.
 |
| IBM273 | The IBM273 encoding.
 |
| IBM277 | The IBM277 encoding.
 |
| IBM278 | The IBM278 encoding.
 |
| IBM280 | The IBM280 encoding.
 |
| IBM284 | The IBM284 encoding.
 |
| IBM285 | The IBM285 encoding.
 |
| IBM290 | The IBM290 encoding.
 |
| IBM297 | The IBM297 encoding.
 |
| IBM420 | The IBM420 encoding.
 |
| IBM423 | The IBM423 encoding.
 |
| IBM424 | The IBM424 encoding.
 |
| x_EBCDIC_KoreanExtended | The x-EBCDIC-KoreanExtended encoding.
 |
| IBM_Thai | The IBM-Thai encoding.
 |
| koi8_r | The koi8-r encoding.
 |
| IBM871 | The IBM871 encoding.
 |
| IBM880 | The IBM880 encoding.
 |
| IBM905 | The IBM905 encoding.
 |
| IBM00924 | The IBM00924 encoding.
 |
| EUC_JP | The EUC-JP encoding.
 |
| x_cp20936 | The x-cp20936 encoding.
 |
| x_cp20949 | The x-cp20949 encoding.
 |
| cp1025 | The cp1025 encoding.
 |
| koi8_u | The koi8-u encoding.
 |
| iso_8859_1 | The iso-8859-1 encoding.
 |
| iso_8859_2 | The iso-8859-2 encoding.
 |
| iso_8859_3 | The iso-8859-3 encoding.
 |
| iso_8859_4 | The iso-8859-4 encoding.
 |
| iso_8859_5 | The iso-8859-5 encoding.
 |
| iso_8859_6 | The iso-8859-6 encoding.
 |
| iso_8859_7 | The iso-8859-7 encoding.
 |
| iso_8859_8 | The iso-8859-8 encoding.
 |
| iso_8859_9 | The iso-8859-9 encoding.
 |
| iso_8859_13 | The iso-8859-13 encoding.
 |
| iso_8859_15 | The iso-8859-15 encoding.
 |
| x_Europa | The x-Europa encoding.
 |
| iso_8859_8_i | The iso-8859-8-i encoding.
 |
| iso_2022_jp | The iso-2022-jp encoding.
 |
| csISO2022JP | The csISO2022JP encoding.
 |
| iso_2022_kr | The iso-2022-kr encoding.
 |
| x_cp50227 | The x-cp50227 encoding.
 |
| euc_jp | The euc-jp encoding.
 |
| EUC_CN | The EUC-CN encoding.
 |
| euc_kr | The euc-kr encoding.
 |
| hz_gb_2312 | The hz-gb-2312 encoding.
 |
| GB18030 | The GB18030 encoding.
 |
| x_iscii_de | The x-iscii-de encoding.
 |
| x_iscii_be | The x-iscii-be encoding.
 |
| x_iscii_ta | The x-iscii-ta encoding.
 |
| x_iscii_te | The x-iscii-te encoding.
 |
| x_iscii_as | The x-iscii-as encoding.
 |
| x_iscii_or | The x-iscii-or encoding.
 |
| x_iscii_ka | The x-iscii-ka encoding.
 |
| x_iscii_ma | The x-iscii-ma encoding.
 |
| x_iscii_gu | The x-iscii-gu encoding.
 |
| x_iscii_pa | The x-iscii-pa encoding.
 |
| utf_7 | The utf-7 encoding.
 |
| utf_8 | The utf-8 encoding.
 |
##### Encodings()
```
public Encodings()
```

##### IBM037
```
public static final String IBM037
```

The IBM037 encoding.

##### IBM437
```
public static final String IBM437
```

The IBM437 encoding.

##### IBM500
```
public static final String IBM500
```

The IBM500 encoding.

##### ASMO_708
```
public static final String ASMO_708
```

The ASMO-708 encoding.

##### DOS_720
```
public static final String DOS_720
```

The DOS-720 encoding.

##### ibm737
```
public static final String ibm737
```

The ibm737 encoding.

##### ibm775
```
public static final String ibm775
```

The ibm775 encoding.

##### ibm850
```
public static final String ibm850
```

The ibm850 encoding.

##### ibm852
```
public static final String ibm852
```

The ibm852 encoding.

##### IBM855
```
public static final String IBM855
```

The IBM855 encoding.

##### ibm857
```
public static final String ibm857
```

The ibm857 encoding.

##### IBM00858
```
public static final String IBM00858
```

The IBM00858 encoding.

##### IBM860
```
public static final String IBM860
```

The IBM860 encoding.

##### ibm861
```
public static final String ibm861
```

The ibm861 encoding.

##### DOS_862
```
public static final String DOS_862
```

The DOS-862 encoding.

##### IBM863
```
public static final String IBM863
```

The IBM863 encoding.

##### IBM864
```
public static final String IBM864
```

The IBM864 encoding.

##### IBM865
```
public static final String IBM865
```

The IBM865 encoding.

##### cp866
```
public static final String cp866
```

The cp866 encoding.

##### ibm869
```
public static final String ibm869
```

The ibm869 encoding.

##### IBM870
```
public static final String IBM870
```

The IBM870 encoding.

##### windows_874
```
public static final String windows_874
```

The windows-874 encoding.

##### cp875
```
public static final String cp875
```

The cp875 encoding.

##### shift_jis
```
public static final String shift_jis
```

The shift_jis encoding.

##### gb2312
```
public static final String gb2312
```

The gb2312 encoding.

##### ks_c_5601_1987
```
public static final String ks_c_5601_1987
```

The ks_c_5601-1987 encoding.

##### big5
```
public static final String big5
```

The big5 encoding.

##### IBM1026
```
public static final String IBM1026
```

The IBM1026 encoding.

##### IBM01047
```
public static final String IBM01047
```

The IBM01047 encoding.

##### IBM01140
```
public static final String IBM01140
```

The IBM01140 encoding.

##### IBM01141
```
public static final String IBM01141
```

The IBM01141 encoding.

##### IBM01142
```
public static final String IBM01142
```

The IBM01142 encoding.

##### IBM01143
```
public static final String IBM01143
```

The IBM01143 encoding.

##### IBM01144
```
public static final String IBM01144
```

The IBM01144 encoding.

##### IBM01145
```
public static final String IBM01145
```

The IBM01145 encoding.

##### IBM01146
```
public static final String IBM01146
```

The IBM01146 encoding.

##### IBM01147
```
public static final String IBM01147
```

The IBM01147 encoding.

##### IBM01148
```
public static final String IBM01148
```

The IBM01148 encoding.

##### IBM01149
```
public static final String IBM01149
```

The IBM01149 encoding.

##### utf_16
```
public static final String utf_16
```

The utf-16 encoding.

##### utf_16BE
```
public static final String utf_16BE
```

The utf-16BE encoding.

##### Windows_1250
```
public static final String Windows_1250
```

The Windows-1250 encoding.

##### Windows_1251
```
public static final String Windows_1251
```

The Windows-1251 encoding.

##### Windows_1252
```
public static final String Windows_1252
```

The Windows-1252 encoding.

##### Windows_1253
```
public static final String Windows_1253
```

The Windows-1253 encoding.

##### Windows_1254
```
public static final String Windows_1254
```

The Windows-1254 encoding.

##### Windows_1255
```
public static final String Windows_1255
```

The Windows-1255 encoding.

##### Windows_1256
```
public static final String Windows_1256
```

The Windows-1256 encoding.

##### Windows_1257
```
public static final String Windows_1257
```

The Windows-1257 encoding.

##### Windows_1258
```
public static final String Windows_1258
```

The Windows-1258 encoding.

##### Johab
```
public static final String Johab
```

The Johab encoding.

##### macintosh
```
public static final String macintosh
```

The macintosh encoding.

##### x_mac_japanese
```
public static final String x_mac_japanese
```

The x-mac-japanese encoding.

##### x_mac_chinesetrad
```
public static final String x_mac_chinesetrad
```

The x-mac-chinesetrad encoding.

##### x_mac_korean
```
public static final String x_mac_korean
```

The x-mac-korean encoding.

##### x_mac_arabic
```
public static final String x_mac_arabic
```

The x-mac-arabic encoding.

##### x_mac_hebrew
```
public static final String x_mac_hebrew
```

The x-mac-hebrew encoding.

##### x_mac_greek
```
public static final String x_mac_greek
```

The x-mac-greek encoding.

##### x_mac_cyrillic
```
public static final String x_mac_cyrillic
```

The x-mac-cyrillic encoding.

##### x_mac_chinesesimp
```
public static final String x_mac_chinesesimp
```

The x-mac-chinesesimp encoding.

##### x_mac_romanian
```
public static final String x_mac_romanian
```

The x-mac-romanian encoding.

##### x_mac_ukrainian
```
public static final String x_mac_ukrainian
```

The x-mac-ukrainian encoding.

##### x_mac_thai
```
public static final String x_mac_thai
```

The x-mac-thai encoding.

##### x_mac_ce
```
public static final String x_mac_ce
```

The x-mac-ce encoding.

##### x_mac_icelandic
```
public static final String x_mac_icelandic
```

The x-mac-icelandic encoding.

##### x_mac_turkish
```
public static final String x_mac_turkish
```

The x-mac-turkish encoding.

##### x_mac_croatian
```
public static final String x_mac_croatian
```

The x-mac-croatian encoding.

##### utf_32
```
public static final String utf_32
```

The utf-32 encoding.

##### utf_32BE
```
public static final String utf_32BE
```

The utf-32BE encoding.

##### x_Chinese_CNS
```
public static final String x_Chinese_CNS
```

The x-Chinese-CNS encoding.

##### x_cp20001
```
public static final String x_cp20001
```

The x-cp20001 encoding.

##### x_Chinese_Eten
```
public static final String x_Chinese_Eten
```

The x-Chinese-Eten encoding.

##### x_cp20003
```
public static final String x_cp20003
```

The x-cp20003 encoding.

##### x_cp20004
```
public static final String x_cp20004
```

The x-cp20004 encoding.

##### x_cp20005
```
public static final String x_cp20005
```

The x-cp20005 encoding.

##### x_IA5
```
public static final String x_IA5
```

The x-IA5 encoding.

##### x_IA5_German
```
public static final String x_IA5_German
```

The x-IA5-German encoding.

##### x_IA5_Swedish
```
public static final String x_IA5_Swedish
```

The x-IA5-Swedish encoding.

##### x_IA5_Norwegian
```
public static final String x_IA5_Norwegian
```

The x-IA5-Norwegian encoding.

##### us_ascii
```
public static final String us_ascii
```

The us-ascii encoding.

##### x_cp20261
```
public static final String x_cp20261
```

The x-cp20261 encoding.

##### x_cp20269
```
public static final String x_cp20269
```

The x-cp20269 encoding.

##### IBM273
```
public static final String IBM273
```

The IBM273 encoding.

##### IBM277
```
public static final String IBM277
```

The IBM277 encoding.

##### IBM278
```
public static final String IBM278
```

The IBM278 encoding.

##### IBM280
```
public static final String IBM280
```

The IBM280 encoding.

##### IBM284
```
public static final String IBM284
```

The IBM284 encoding.

##### IBM285
```
public static final String IBM285
```

The IBM285 encoding.

##### IBM290
```
public static final String IBM290
```

The IBM290 encoding.

##### IBM297
```
public static final String IBM297
```

The IBM297 encoding.

##### IBM420
```
public static final String IBM420
```

The IBM420 encoding.

##### IBM423
```
public static final String IBM423
```

The IBM423 encoding.

##### IBM424
```
public static final String IBM424
```

The IBM424 encoding.

##### x_EBCDIC_KoreanExtended
```
public static final String x_EBCDIC_KoreanExtended
```

The x-EBCDIC-KoreanExtended encoding.

##### IBM_Thai
```
public static final String IBM_Thai
```

The IBM-Thai encoding.

##### koi8_r
```
public static final String koi8_r
```

The koi8-r encoding.

##### IBM871
```
public static final String IBM871
```

The IBM871 encoding.

##### IBM880
```
public static final String IBM880
```

The IBM880 encoding.

##### IBM905
```
public static final String IBM905
```

The IBM905 encoding.

##### IBM00924
```
public static final String IBM00924
```

The IBM00924 encoding.

##### EUC_JP
```
public static final String EUC_JP
```

The EUC-JP encoding.

##### x_cp20936
```
public static final String x_cp20936
```

The x-cp20936 encoding.

##### x_cp20949
```
public static final String x_cp20949
```

The x-cp20949 encoding.

##### cp1025
```
public static final String cp1025
```

The cp1025 encoding.

##### koi8_u
```
public static final String koi8_u
```

The koi8-u encoding.

##### iso_8859_1
```
public static final String iso_8859_1
```

The iso-8859-1 encoding.

##### iso_8859_2
```
public static final String iso_8859_2
```

The iso-8859-2 encoding.

##### iso_8859_3
```
public static final String iso_8859_3
```

The iso-8859-3 encoding.

##### iso_8859_4
```
public static final String iso_8859_4
```

The iso-8859-4 encoding.

##### iso_8859_5
```
public static final String iso_8859_5
```

The iso-8859-5 encoding.

##### iso_8859_6
```
public static final String iso_8859_6
```

The iso-8859-6 encoding.

##### iso_8859_7
```
public static final String iso_8859_7
```

The iso-8859-7 encoding.

##### iso_8859_8
```
public static final String iso_8859_8
```

The iso-8859-8 encoding.

##### iso_8859_9
```
public static final String iso_8859_9
```

The iso-8859-9 encoding.

##### iso_8859_13
```
public static final String iso_8859_13
```

The iso-8859-13 encoding.

##### iso_8859_15
```
public static final String iso_8859_15
```

The iso-8859-15 encoding.

##### x_Europa
```
public static final String x_Europa
```

The x-Europa encoding.

##### iso_8859_8_i
```
public static final String iso_8859_8_i
```

The iso-8859-8-i encoding.

##### iso_2022_jp
```
public static final String iso_2022_jp
```

The iso-2022-jp encoding.

##### csISO2022JP
```
public static final String csISO2022JP
```

The csISO2022JP encoding.

##### iso_2022_kr
```
public static final String iso_2022_kr
```

The iso-2022-kr encoding.

##### x_cp50227
```
public static final String x_cp50227
```

The x-cp50227 encoding.

##### euc_jp
```
public static final String euc_jp
```

The euc-jp encoding.

##### EUC_CN
```
public static final String EUC_CN
```

The EUC-CN encoding.

##### euc_kr
```
public static final String euc_kr
```

The euc-kr encoding.

##### hz_gb_2312
```
public static final String hz_gb_2312
```

The hz-gb-2312 encoding.

##### GB18030
```
public static final String GB18030
```

The GB18030 encoding.

##### x_iscii_de
```
public static final String x_iscii_de
```

The x-iscii-de encoding.

##### x_iscii_be
```
public static final String x_iscii_be
```

The x-iscii-be encoding.

##### x_iscii_ta
```
public static final String x_iscii_ta
```

The x-iscii-ta encoding.

##### x_iscii_te
```
public static final String x_iscii_te
```

The x-iscii-te encoding.

##### x_iscii_as
```
public static final String x_iscii_as
```

The x-iscii-as encoding.

##### x_iscii_or
```
public static final String x_iscii_or
```

The x-iscii-or encoding.

##### x_iscii_ka
```
public static final String x_iscii_ka
```

The x-iscii-ka encoding.

##### x_iscii_ma
```
public static final String x_iscii_ma
```

The x-iscii-ma encoding.

##### x_iscii_gu
```
public static final String x_iscii_gu
```

The x-iscii-gu encoding.

##### x_iscii_pa
```
public static final String x_iscii_pa
```

The x-iscii-pa encoding.

##### utf_7
```
public static final String utf_7
```

The utf-7 encoding.

##### utf_8
```
public static final String utf_8
```

The utf-8 encoding.

### ExtractedItemInfo
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/extractediteminfo.md

**Inheritance:**
java.lang.Object
```
public class ExtractedItemInfo
```

Represents a container item information.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExtractedItemInfo(FormatFamily formatFamily, DocumentField[] fields, String itemInfo, String innerPath) | Initializes a new instance of the  ExtractedItemInfo  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFormatFamily() | Gets a document type.
 |
| getFields() | Gets an extracted fields.
 |
| getItemInfo() | Gets an item information.
 |
| getInnerPath() | Gets an inner path.
 |
##### ExtractedItemInfo(FormatFamily formatFamily, DocumentField[] fields, String itemInfo, String innerPath)
```
public ExtractedItemInfo(FormatFamily formatFamily, DocumentField[] fields, String itemInfo, String innerPath)
```

Initializes a new instance of the  ExtractedItemInfo  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatFamily | FormatFamily | The document format family.
 |
| fields | DocumentField\[\] | The extracted fields.
 |
| itemInfo | java.lang.String | The item information.
 |
| innerPath | java.lang.String | The path to the item in the container.
 |

##### getFormatFamily()
```
public final FormatFamily getFormatFamily()
```

Gets a document type.

**Returns:**
FormatFamily - The document type.

##### getFields()
```
public final DocumentField[] getFields()
```

Gets an extracted fields.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The extracted fields.

##### getItemInfo()
```
public final String getItemInfo()
```

Gets an item information.

**Returns:**
java.lang.String - The item information.

##### getInnerPath()
```
public final String getInnerPath()
```

Gets an inner path.

**Returns:**
java.lang.String - The inner path.

### ExtractorSettings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/extractorsettings.md

**Inheritance:**
java.lang.Object
```
public abstract class ExtractorSettings
```

Contains settings for the document data extractor.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExtractorSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| getIndexType() | Gets the index type the extractor is used for.
 |
| setIndexType(IndexType value) | Sets the index type the extractor is used for.
 |
##### ExtractorSettings()
```
public ExtractorSettings()
```

##### getIndexType()
```
public abstract IndexType getIndexType()
```

Gets the index type the extractor is used for. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Returns:**
IndexType - The index type the extractor is used for.

##### setIndexType(IndexType value)
```
public abstract void setIndexType(IndexType value)
```

Sets the index type the extractor is used for. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IndexType | The index type the extractor is used for.
 |

### FileLogger
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.search.common.ILogger
```
public class FileLogger implements ILogger
```

Represents a logger that logs events and errors to a local file.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 String logPath = "c:\\Log.txt";
 IndexSettings settings = new IndexSettings();
 settings.setLogger(new FileLogger(logPath, 4.0)); // Specifying the path to the log file and a maximum length of 4 MB
 Index index = new Index(indexFolder, settings); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchResult result = index.search(query); // Search in index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String filePath, double maxSize) | Initializes a new instance of the  FileLogger  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| error(String message) | Logs an error that occurred in the index.
 |
| trace(String message) | Logs an event that occurred in the index.
 |
| getFilePath() | Gets the log file path.
 |
| getMaxSize() | Gets the maximum size of log file in megabytes.
 |
##### FileLogger(String filePath, double maxSize)
```
public FileLogger(String filePath, double maxSize)
```

Initializes a new instance of the  FileLogger  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The log file path.
 |
| maxSize | double | The maximum size of the log file in megabytes. The value must be in the range from 0.1 to 1000.
 |

##### error(String message)
```
public final void error(String message)
```

Logs an error that occurred in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message.
 |

##### trace(String message)
```
public final void trace(String message)
```

Logs an event that occurred in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The event message.
 |

##### getFilePath()
```
public final String getFilePath()
```

Gets the log file path.

**Returns:**
java.lang.String - The log file path.

##### getMaxSize()
```
public final double getMaxSize()
```

Gets the maximum size of log file in megabytes.

**Returns:**
double - The maximum size of log file in megabytes.

### FileOutputAdapter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/fileoutputadapter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.common.OutputAdapter

**All Implemented Interfaces:**
com.groupdocs.search.common.IFileOutputAdapter
```
public class FileOutputAdapter extends OutputAdapter implements IFileOutputAdapter
```

Represents an output adapter that collects output into a file.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 DocumentInfo[] documents = index.getIndexedDocuments(); // Getting information on indexed documents
 FileOutputAdapter adapter = new FileOutputAdapter("c:\\DocumentText.htm"); // Creating a file output adapter
 index.getDocumentText(documents[0], adapter); // Generating a document text into the output file
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| FileOutputAdapter(OutputFormat outputFormat, String filePath) | Initializes a new instance of the  FileOutputAdapter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFilePath() | Gets an output file path.
 |
##### FileOutputAdapter(OutputFormat outputFormat, String filePath)
```
public FileOutputAdapter(OutputFormat outputFormat, String filePath)
```

Initializes a new instance of the  FileOutputAdapter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format.
 |
| filePath | java.lang.String | The output file path.
 |

##### getFilePath()
```
public final String getFilePath()
```

Gets an output file path.

**Returns:**
java.lang.String - The output file path.

### FragmentContainer
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/fragmentcontainer.md

**Inheritance:**
java.lang.Object
```
public abstract class FragmentContainer
```

Represents a container for text fragments with highlighted found terms of one document field.

#### Constructors

| Constructor | Description |
| --- | --- |
| FragmentContainer() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFieldName() | Gets the document field name.
 |
| getCount() | Gets the number of contained text fragments.
 |
| getFragments() | Gets an array of contained text fragments.
 |
##### FragmentContainer()
```
public FragmentContainer()
```

##### getFieldName()
```
public abstract String getFieldName()
```

Gets the document field name.

**Returns:**
java.lang.String - The document field name.

##### getCount()
```
public abstract int getCount()
```

Gets the number of contained text fragments.

**Returns:**
int - The number of contained text fragments.

##### getFragments()
```
public abstract String[] getFragments()
```

Gets an array of contained text fragments.

**Returns:**
java.lang.String[] - An array of contained text fragments.

### IContainerItemExtractor
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/icontaineritemextractor.md

**All Implemented Interfaces:**
com.groupdocs.search.common.IFieldExtractor
```
public interface IContainerItemExtractor extends IFieldExtractor
```

Provides methods for extracting items from container documents.

#### Methods

| Method | Description |
| --- | --- |
| getFormatFamily() | Gets the document format family.
 |
| getContainerItems(String filePath) | Extracts items from container document.
 |
| getContainerItems(InputStream stream) | Extracts items from container document.
 |
##### getFormatFamily()
```
public abstract FormatFamily getFormatFamily()
```

Gets the document format family.

**Returns:**
FormatFamily - The document format family.

##### getContainerItems(String filePath)
```
public abstract ExtractedItemInfo[] getContainerItems(String filePath)
```

Extracts items from container document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path.
 |

**Returns:**
com.groupdocs.search.common.ExtractedItemInfo[] - An array of extracted items.

##### getContainerItems(InputStream stream)
```
public abstract ExtractedItemInfo[] getContainerItems(InputStream stream)
```

Extracts items from container document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The document stream.
 |

**Returns:**
com.groupdocs.search.common.ExtractedItemInfo[] - An array of extracted items.

### IDocumentLoader
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/idocumentloader.md

### IFieldExtractor
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/ifieldextractor.md

### ILogger
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/ilogger.md

### ImageFrame
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/imageframe.md

**Inheritance:**
java.lang.Object
```
public abstract class ImageFrame
```

Represents an image frame.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageFrame() |  |
#### Methods

| Method | Description |
| --- | --- |
| getIndex() | Gets the index of the frame in the image.
 |
##### ImageFrame()
```
public ImageFrame()
```

##### getIndex()
```
public abstract int getIndex()
```

Gets the index of the frame in the image.

**Returns:**
int - The index of the frame in the image.

### IndexInfo
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/indexinfo.md

**Inheritance:**
java.lang.Object
```
public abstract class IndexInfo
```

Contains basic information on an  Index .

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getIndexId() | Gets the index unique identifier.
 |
| getIndexFolder() | Gets the full folder name where index is located.
 |
| getIndexStatus() | Gets the index status.
 |
| getVersion() | Gets the index version.
 |
| getSegmentCount() | Gets the number of index segments.
 |
| getTermCount() | Gets the number of words in the index.
 |
##### IndexInfo()
```
public IndexInfo()
```

##### getIndexId()
```
public abstract UUID getIndexId()
```

Gets the index unique identifier.

**Returns:**
java.util.UUID - The index unique identifier.

##### getIndexFolder()
```
public abstract String getIndexFolder()
```

Gets the full folder name where index is located.

**Returns:**
java.lang.String - The full folder name where index is located.

##### getIndexStatus()
```
public abstract IndexStatus getIndexStatus()
```

Gets the index status.

**Returns:**
IndexStatus - The index status.

##### getVersion()
```
public abstract String getVersion()
```

Gets the index version.

**Returns:**
java.lang.String - The index version.

##### getSegmentCount()
```
public abstract int getSegmentCount()
```

Gets the number of index segments.

**Returns:**
int - The number of index segments.

##### getTermCount()
```
public abstract int getTermCount()
```

Gets the number of words in the index.

**Returns:**
int - The number of words in the index.

### IndexingReport
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/indexingreport.md

**Inheritance:**
java.lang.Object
```
public abstract class IndexingReport
```

Represents a detailed information on an indexing operation.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder1);
 index.add(documentsFolder2);
 // Getting indexing reports
 IndexingReport[] reports = index.getIndexingReports();
 // Printing reports to the console
 for (IndexingReport report : reports) {
     DateFormat df = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
     System.out.println("Time: " + df.format(report.getStartTime()));
     System.out.println("Duration: " + report.getIndexingTime());
     System.out.println("Documents total: " + report.getTotalDocumentsInIndex());
     System.out.println("Terms total: " + report.getTotalTermCount());
     System.out.println("Indexed documents size (MB): " + report.getIndexedDocumentsSize());
     System.out.println("Index size (MB): " + (report.getTotalIndexSize() / 1024.0 / 1024.0));
     System.out.println();
 }
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexingReport() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTotalDocumentsInIndex() | Gets the total number of documents in the index.
 |
| getTotalTermCount() | Gets the total number of terms in index.
 |
| getIndexedDocumentsSize() | Gets the total length of indexed documents in MB.
 |
| getSegmentCount() | Gets the number of index segments.
 |
| getTotalIndexSize() | Gets the total index size in bytes.
 |
| getStartTime() | Gets the indexing start time.
 |
| getEndTime() | Gets the indexing end time.
 |
| getIndexingTime() | Gets the indexing duration in seconds.
 |
| getErrors() | Gets the list of errors.
 |
| getIndexedDocuments() | Gets the list of indexed documents.
 |
| getUpdatedDocuments() | Gets the list of updated documents.
 |
| getRemovedDocuments() | Gets the list of removed from index documents.
 |
##### IndexingReport()
```
public IndexingReport()
```

##### getTotalDocumentsInIndex()
```
public abstract int getTotalDocumentsInIndex()
```

Gets the total number of documents in the index.

**Returns:**
int - The total number of documents in the index.

##### getTotalTermCount()
```
public abstract int getTotalTermCount()
```

Gets the total number of terms in index.

**Returns:**
int - The total number of terms in index.

##### getIndexedDocumentsSize()
```
public abstract double getIndexedDocumentsSize()
```

Gets the total length of indexed documents in MB.

**Returns:**
double - The total length of indexed documents in MB.

##### getSegmentCount()
```
public abstract int getSegmentCount()
```

Gets the number of index segments.

**Returns:**
int - The number of index segments.

##### getTotalIndexSize()
```
public abstract long getTotalIndexSize()
```

Gets the total index size in bytes.

**Returns:**
long - The total index size in bytes.

##### getStartTime()
```
public abstract Date getStartTime()
```

Gets the indexing start time.

**Returns:**
java.util.Date - The indexing start time.

##### getEndTime()
```
public abstract Date getEndTime()
```

Gets the indexing end time.

**Returns:**
java.util.Date - The indexing end time.

##### getIndexingTime()
```
public abstract double getIndexingTime()
```

Gets the indexing duration in seconds.

**Returns:**
double - The indexing duration in seconds.

##### getErrors()
```
public abstract String[] getErrors()
```

Gets the list of errors.

**Returns:**
java.lang.String[] - The list of errors.

##### getIndexedDocuments()
```
public abstract String[] getIndexedDocuments()
```

Gets the list of indexed documents.

**Returns:**
java.lang.String[] - The list of indexed documents.

##### getUpdatedDocuments()
```
public abstract String[] getUpdatedDocuments()
```

Gets the list of updated documents.

**Returns:**
java.lang.String[] - The list of updated documents.

##### getRemovedDocuments()
```
public abstract String[] getRemovedDocuments()
```

Gets the list of removed from index documents.

**Returns:**
java.lang.String[] - The list of removed from index documents.

### IndexStatus
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/indexstatus.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum IndexStatus extends Enum<IndexStatus>
```

Specifies an index status.

#### Fields

| Field | Description |
| --- | --- |
| Ready | Index is free and ready to change.
 |
| Failed | Index needs to be reloaded due to an error.
 |
| Indexing | Index performs an indexing operation.
 |
| Updating | Index performs an updating operation.
 |
| Merging | Index performs a merging operation.
 |
| Optimizing | Index performs an optimizing operation.
 |
| Deleting | Index performs a deleting operation.
 |
| Renaming | Index performs a renaming operation.
 |
| ChangingAttributes | Index changes attributes.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Ready
```
public static final IndexStatus Ready
```

Index is free and ready to change.

##### Failed
```
public static final IndexStatus Failed
```

Index needs to be reloaded due to an error.

##### Indexing
```
public static final IndexStatus Indexing
```

Index performs an indexing operation.

##### Updating
```
public static final IndexStatus Updating
```

Index performs an updating operation.

##### Merging
```
public static final IndexStatus Merging
```

Index performs a merging operation.

##### Optimizing
```
public static final IndexStatus Optimizing
```

Index performs an optimizing operation.

##### Deleting
```
public static final IndexStatus Deleting
```

Index performs a deleting operation.

##### Renaming
```
public static final IndexStatus Renaming
```

Index performs a renaming operation.

##### ChangingAttributes
```
public static final IndexStatus ChangingAttributes
```

Index changes attributes.

##### values()
```
public static IndexStatus[] values()
```

**Returns:**
com.groupdocs.search.common.IndexStatus[]
##### valueOf(String name)
```
public static IndexStatus valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IndexStatus

### MulticastDelegate
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/multicastdelegate.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.Delegate
```
public abstract class MulticastDelegate extends Delegate
```

Represents a delegate, which refers to class instances that have method to be invoked.

#### Constructors

| Constructor | Description |
| --- | --- |
| MulticastDelegate() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInvocationList() | Returns an invocation list.
 |
| getDelegateId() | Returns a delegate ID.
 |
| op_Equality(MulticastDelegate d1, MulticastDelegate d2) | Checks two delegates for equality.
 |
| op_Inequality(MulticastDelegate d1, MulticastDelegate d2) | Checks two delegates for inequality.
 |
##### MulticastDelegate()
```
public MulticastDelegate()
```

##### getInvocationList()
```
public final Delegate[] getInvocationList()
```

Returns an invocation list.

**Returns:**
com.groupdocs.search.common.Delegate[] - An invocation list.

##### getDelegateId()
```
public String getDelegateId()
```

Returns a delegate ID.

**Returns:**
java.lang.String - A delegate ID.

##### op_Equality(MulticastDelegate d1, MulticastDelegate d2)
```
public static boolean op_Equality(MulticastDelegate d1, MulticastDelegate d2)
```

Checks two delegates for equality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| d1 | MulticastDelegate | The first delegate.
 |
| d2 | MulticastDelegate | The second delegate.
 |

**Returns:**
boolean - The result of checking two delegates for equality.

##### op_Inequality(MulticastDelegate d1, MulticastDelegate d2)
```
public static boolean op_Inequality(MulticastDelegate d1, MulticastDelegate d2)
```

Checks two delegates for inequality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| d1 | MulticastDelegate | The first delegate.
 |
| d2 | MulticastDelegate | The second delegate.
 |

**Returns:**
boolean - The result of checking two delegates for inequality.

### OutputAdapter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/outputadapter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory

**All Implemented Interfaces:**
com.groupdocs.search.common.IOutputAdapter
```
public abstract class OutputAdapter extends ResultBuilderFactory implements IOutputAdapter
```

Represents the base class of an output adapter that is used to collect an output in a generalized form. The currently available adapters are  FileOutputAdapter ,  StreamOutputAdapter ,  StructureOutputAdapter , and  StringOutputAdapter .

### ResultBuilderFactory
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/resultbuilderfactory.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.search.common.IResultBuilderFactory
```
public abstract class ResultBuilderFactory implements IResultBuilderFactory
```

Represents the base class of a result builder factory.

#### Methods

| Method | Description |
| --- | --- |
| getOutputFormat() | Gets the output format.
 |
| getCore() |  |
##### getOutputFormat()
```
public OutputFormat getOutputFormat()
```

Gets the output format.

**Returns:**
OutputFormat - The output format.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### SearchImage
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/searchimage.md

**Inheritance:**
java.lang.Object
```
public abstract class SearchImage
```

Represents an image to search.

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchImage() |  |
#### Methods

| Method | Description |
| --- | --- |
| create(String filePath) | Creates an image from a file to search.
 |
| create(String filePath, int imageIndex) | Creates an image from a file to search.
 |
| create(InputStream stream) | Creates an image from a stream to search.
 |
| create(InputStream stream, int imageIndex) | Creates an image from a stream to search.
 |
##### SearchImage()
```
public SearchImage()
```

##### create(String filePath)
```
public static SearchImage create(String filePath)
```

Creates an image from a file to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The image file path.
 |

**Returns:**
SearchImage - An image to search.

##### create(String filePath, int imageIndex)
```
public static SearchImage create(String filePath, int imageIndex)
```

Creates an image from a file to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The image file path.
 |
| imageIndex | int | The image index in multipage images.
 |

**Returns:**
SearchImage - An image to search.

##### create(InputStream stream)
```
public static SearchImage create(InputStream stream)
```

Creates an image from a stream to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The image stream.
 |

**Returns:**
SearchImage - An image to search.

##### create(InputStream stream, int imageIndex)
```
public static SearchImage create(InputStream stream, int imageIndex)
```

Creates an image from a stream to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The image stream.
 |
| imageIndex | int | The image index in multipage images.
 |

**Returns:**
SearchImage - An image to search.

### SearchReport
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/searchreport.md

**Inheritance:**
java.lang.Object
```
public abstract class SearchReport
```

Represents a detailed information on a search operation.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Searching in index
 SearchResult result1 = index.search("Einstein");
 SearchResult result2 = index.search("\"Theory of Relativity\"");
 // Getting search reports
 SearchReport[] reports = index.getSearchReports();
 // Printing reports to the console
 for (SearchReport report : reports) {
     System.out.println("Query: " + report.getTextQuery());
     DateFormat df = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
     System.out.println("Time: " + df.format(report.getStartTime()));
     System.out.println("Duration: " + report.getSearchDuration());
     System.out.println("Documents: " + report.getDocumentCount());
     System.out.println("Occurrences: " + report.getOccurrenceCount());
     System.out.println();
 }
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchReport() |  |
#### Methods

| Method | Description |
| --- | --- |
| getStartTime() | Gets the start time of the search.
 |
| getEndTime() | Gets the end time of the search.
 |
| getSearchDuration() | Gets the search duration in seconds.
 |
| getDocumentCount() | Gets the number of documents found.
 |
| getOccurrenceCount() | Gets the total number of occurrences found.
 |
| getTextQuery() | Gets the search query in text form.
 |
| getObjectQuery() | Gets the search query in object form.
 |
| getSearchOptions() | Gets the search options.
 |
| toString() | Returns a String that represents the current  SearchReport .
 |
##### SearchReport()
```
public SearchReport()
```

##### getStartTime()
```
public abstract Date getStartTime()
```

Gets the start time of the search.

**Returns:**
java.util.Date - The start time of the search.

##### getEndTime()
```
public abstract Date getEndTime()
```

Gets the end time of the search.

**Returns:**
java.util.Date - The end time of the search.

##### getSearchDuration()
```
public abstract double getSearchDuration()
```

Gets the search duration in seconds.

**Returns:**
double - The search duration in seconds.

##### getDocumentCount()
```
public abstract int getDocumentCount()
```

Gets the number of documents found.

**Returns:**
int - The number of documents found.

##### getOccurrenceCount()
```
public abstract int getOccurrenceCount()
```

Gets the total number of occurrences found.

**Returns:**
int - The total number of occurrences found.

##### getTextQuery()
```
public abstract String getTextQuery()
```

Gets the search query in text form.

**Returns:**
java.lang.String - The search query in text form.

##### getObjectQuery()
```
public abstract SearchQuery getObjectQuery()
```

Gets the search query in object form.

**Returns:**
SearchQuery - The search query in object form.

##### getSearchOptions()
```
public abstract SearchOptions getSearchOptions()
```

Gets the search options.

**Returns:**
SearchOptions - The search options.

##### toString()
```
public abstract String toString()
```

Returns a String that represents the current  SearchReport .

**Returns:**
java.lang.String - A String that represents the current  SearchReport .

### StreamOutputAdapter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/streamoutputadapter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.common.OutputAdapter

**All Implemented Interfaces:**
com.groupdocs.search.common.IStreamOutputAdapter
```
public class StreamOutputAdapter extends OutputAdapter implements IStreamOutputAdapter
```

Represents an output adapter that collects output into a  java.io.OutputStream .

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 DocumentInfo[] documents = index.getIndexedDocuments(); // Getting information on indexed documents
 final ByteArrayOutputStream stream = new ByteArrayOutputStream(); // Creating an output stream
 StreamOutputAdapter adapter = new StreamOutputAdapter(stream); // Creating a stream output adapter
 index.getDocumentText(documents[0], adapter); // Generating a document text into the stream
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| StreamOutputAdapter(OutputFormat outputFormat, OutputStream stream) | Initializes a new instance of the  StreamOutputAdapter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getStream() | Gets an output stream.
 |
##### StreamOutputAdapter(OutputFormat outputFormat, OutputStream stream)
```
public StreamOutputAdapter(OutputFormat outputFormat, OutputStream stream)
```

Initializes a new instance of the  StreamOutputAdapter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format.
 |
| stream | java.io.OutputStream | The output stream.
 |

##### getStream()
```
public final OutputStream getStream()
```

Gets an output stream.

**Returns:**
java.io.OutputStream - The output stream.

### StringOutputAdapter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/stringoutputadapter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.common.OutputAdapter

**All Implemented Interfaces:**
com.groupdocs.search.common.IStringOutputAdapter
```
public class StringOutputAdapter extends OutputAdapter implements IStringOutputAdapter
```

Represents an output adapter that collects output as a  System.String .

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 DocumentInfo[] documents = index.getIndexedDocuments(); // Getting information on indexed documents
 StringOutputAdapter adapter = new StringOutputAdapter(); // Creating a string output adapter
 index.getDocumentText(documents[0], adapter); // Generating a document text into the adapter
 String result = adapter.getResult(); // Getting a result
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| StringOutputAdapter(OutputFormat outputFormat) | Initializes a new instance of the  StringOutputAdapter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getResult() | Gets the resulting string.
 |
##### StringOutputAdapter(OutputFormat outputFormat)
```
public StringOutputAdapter(OutputFormat outputFormat)
```

Initializes a new instance of the  StringOutputAdapter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format.
 |

##### getResult()
```
public final String getResult()
```

Gets the resulting string.

**Returns:**
java.lang.String - The resulting string.

### StructureOutputAdapter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/structureoutputadapter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.common.OutputAdapter

**All Implemented Interfaces:**
com.groupdocs.search.common.IStructureOutputAdapter
```
public class StructureOutputAdapter extends OutputAdapter implements IStructureOutputAdapter
```

Represents an output adapter that collects output as a structure containing each field separately.

#### Constructors

| Constructor | Description |
| --- | --- |
| StructureOutputAdapter(OutputFormat outputFormat) | Initializes a new instance of the  StructureOutputAdapter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getResult() | Gets the resulting array of fields.
 |
##### StructureOutputAdapter(OutputFormat outputFormat)
```
public StructureOutputAdapter(OutputFormat outputFormat)
```

Initializes a new instance of the  StructureOutputAdapter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format.
 |

##### getResult()
```
public final DocumentField[] getResult()
```

Gets the resulting array of fields.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The resulting array of fields.

### VersionUpdateResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/versionupdateresult.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum VersionUpdateResult extends Enum<VersionUpdateResult>
```

Represents the result of an index version update operation.

#### Fields

| Field | Description |
| --- | --- |
| Updated | Index version updated.
 |
| AlreadyUpToDate | Index version is already up-to-date.
 |
| Unsupported | Index version is not supported or directory does not contain valid index data.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Updated
```
public static final VersionUpdateResult Updated
```

Index version updated.

##### AlreadyUpToDate
```
public static final VersionUpdateResult AlreadyUpToDate
```

Index version is already up-to-date.

##### Unsupported
```
public static final VersionUpdateResult Unsupported
```

Index version is not supported or directory does not contain valid index data.

##### values()
```
public static VersionUpdateResult[] values()
```

**Returns:**
com.groupdocs.search.common.VersionUpdateResult[]
##### valueOf(String name)
```
public static VersionUpdateResult valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
VersionUpdateResult

### WordPattern
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.common/wordpattern.md

**Inheritance:**
java.lang.Object
```
public class WordPattern
```

Represents a word pattern to use in word wildcard search.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordPattern() | Initializes a new instance of the  WordPattern  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| appendString(String text) | Appends a string to the word pattern.
 |
| appendCharacter(char character) | Appends a character to the word pattern.
 |
| appendOneCharacterWildcard() | Appends one character wildcard to the word pattern.
 |
| appendZeroOrOneCharacterWildcard() | Appends zero or one character wildcard to the word pattern.
 |
| appendZeroOrMoreCharactersWildcard() | Appends zero or more characters wildcard to the word pattern.
 |
| appendOneOrMoreCharactersWildcard() | Appends one or more characters wildcard to the word pattern.
 |
| appendWildcard(int min, int max) | Appends a wildcard to the word pattern.
 |
| toString() | Returns a  System.String  that represents the current  WordPattern .
 |
| getCore() |  |
##### WordPattern()
```
public WordPattern()
```

Initializes a new instance of the  WordPattern  class.

##### appendString(String text)
```
public void appendString(String text)
```

Appends a string to the word pattern.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The string to append.
 |

##### appendCharacter(char character)
```
public void appendCharacter(char character)
```

Appends a character to the word pattern.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character to append.
 |

##### appendOneCharacterWildcard()
```
public void appendOneCharacterWildcard()
```

Appends one character wildcard to the word pattern.

##### appendZeroOrOneCharacterWildcard()
```
public void appendZeroOrOneCharacterWildcard()
```

Appends zero or one character wildcard to the word pattern.

##### appendZeroOrMoreCharactersWildcard()
```
public void appendZeroOrMoreCharactersWildcard()
```

Appends zero or more characters wildcard to the word pattern.

##### appendOneOrMoreCharactersWildcard()
```
public void appendOneOrMoreCharactersWildcard()
```

Appends one or more characters wildcard to the word pattern.

##### appendWildcard(int min, int max)
```
public void appendWildcard(int min, int max)
```

Appends a wildcard to the word pattern.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| min | int | The minimum number of characters.
 |
| max | int | The maximum number of characters.
 |

##### toString()
```
public String toString()
```

Returns a  System.String  that represents the current  WordPattern .

**Returns:**
java.lang.String - A  System.String  that represents the current  WordPattern .

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### com.groupdocs.search.dictionaries
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries.md

The package provides classes of various dictionaries.

#### Classes

| Class | Description |
| --- | --- |
| AliasReplacementPair | Represents an alias/replacement pair. |
| CharacterReplacementPair | Represents a character/replacement pair. |
| DictionaryRepository | Represents a repository of all dictionaries in the  Index . |
| EnglishWordFormsProvider | Represents an English word forms provider. |

#### Interfaces

| Interface | Description |
| --- | --- |
| AliasDictionary | Defines interface of a dictionary of aliases. |
| Alphabet | Defines interface of a dictionary of characters that is used during indexing to detect character type. |
| CharacterReplacementDictionary | Defines interface of a character replacement dictionary that is used during the indexing process. |
| DictionaryBase | Defines interface of a dictionary. |
| HomophoneDictionary | Defines interface of a dictionary of heterographic homophones. |
| IWordFormsProvider | Defines interface of a word forms provider. |
| PasswordDictionary | Defines interface of a dictionary of document passwords. |
| SpellingCorrector | Defines interface of a spelling corrector for terms in a query. |
| StopWordDictionary | Defines interface of a dictionary of stop words. |
| SynonymDictionary | Defines interface of a dictionary of synonyms. |

#### Enumerations

| Enum | Description |
| --- | --- |
| CharacterType | Represents a type of a character, depending on how it should be indexed. |
| DictionaryType | Represents a type of a dictionary. |

### AliasDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/aliasdictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface AliasDictionary extends DictionaryBase, Iterable<String>
```

Defines interface of a dictionary of aliases.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of aliases contained in the  AliasDictionary .
 |
| addRange(Iterable<AliasReplacementPair> pairs) | Adds the specified collection of alias/replacement pairs to this instance of the  AliasDictionary .
 |
| addRange(AliasReplacementPair[] pairs) | Adds the specified collection of alias/replacement pairs to this instance of the  AliasDictionary .
 |
| add(String alias, String text) | Adds the specified pair of alias and associated text to this instance of the  AliasDictionary .
 |
| remove(String alias) | Removes the specified alias from an  AliasDictionary  object.
 |
| contains(String alias) | Determines whether an  AliasDictionary  object contains the specified alias.
 |
| getText(String alias) | Gets a text that is associated with the specified alias.
 |
| clear() | Removes all aliases from a  AliasDictionary  object.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of aliases contained in the  AliasDictionary .

**Returns:**
int - The number of aliases contained in the  AliasDictionary .

##### addRange(Iterable<AliasReplacementPair> pairs)
```
public abstract void addRange(Iterable<AliasReplacementPair> pairs)
```

Adds the specified collection of alias/replacement pairs to this instance of the  AliasDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pairs | java.lang.Iterable<com.groupdocs.search.dictionaries.AliasReplacementPair> | The collection of alias/replacement pairs to add to the dictionary.
 |

##### addRange(AliasReplacementPair[] pairs)
```
public abstract void addRange(AliasReplacementPair[] pairs)
```

Adds the specified collection of alias/replacement pairs to this instance of the  AliasDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pairs | AliasReplacementPair\[\] | The collection of alias/replacement pairs to add to the dictionary.
 |

##### add(String alias, String text)
```
public abstract void add(String alias, String text)
```

Adds the specified pair of alias and associated text to this instance of the  AliasDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alias | java.lang.String | The alias to add to the dictionary.
 |
| text | java.lang.String | The text to be associated with the alias.
 |

##### remove(String alias)
```
public abstract boolean remove(String alias)
```

Removes the specified alias from an  AliasDictionary  object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alias | java.lang.String | The alias to remove.
 |

**Returns:**
boolean - This method returns  true  if the alias is successfully found and removed. This method returns  false  if the alias is not found in the  AliasDictionary  object.

##### contains(String alias)
```
public abstract boolean contains(String alias)
```

Determines whether an  AliasDictionary  object contains the specified alias.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alias | java.lang.String | The alias to locate in the  AliasDictionary  object.
 |

**Returns:**
boolean -  true  if the  AliasDictionary  object contains the specified alias; otherwise,  false .

##### getText(String alias)
```
public abstract String getText(String alias)
```

Gets a text that is associated with the specified alias.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alias | java.lang.String | The alias to locate in the  AliasDictionary  object.
 |

**Returns:**
java.lang.String - A text associated with the specified alias or  null .

##### clear()
```
public abstract void clear()
```

Removes all aliases from a  AliasDictionary  object.

##### iterator()
```
public abstract Iterator<String> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.

### AliasReplacementPair
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/aliasreplacementpair.md

**Inheritance:**
java.lang.Object
```
public class AliasReplacementPair
```

Represents an alias/replacement pair.

#### Constructors

| Constructor | Description |
| --- | --- |
| AliasReplacementPair(String alias, String replacement) | Initializes a new instance of the
AliasReplacementPair
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAlias() | Gets the alias.
 |
| getReplacement() | Gets the replacement.
 |
##### AliasReplacementPair(String alias, String replacement)
```
public AliasReplacementPair(String alias, String replacement)
```

Initializes a new instance of the
AliasReplacementPair
 class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alias | java.lang.String | The alias to be replaced.
 |
| replacement | java.lang.String | The replacement.
 |

##### getAlias()
```
public final String getAlias()
```

Gets the alias.

**Returns:**
java.lang.String - The alias.

##### getReplacement()
```
public final String getReplacement()
```

Gets the replacement.

**Returns:**
java.lang.String - The replacement.

### Alphabet
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/alphabet.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface Alphabet extends DictionaryBase, Iterable<Character>
```

Defines interface of a dictionary of characters that is used during indexing to detect character type. Each character can be handled as separator, as letter, or both.

#### Methods

| Method | Description |
| --- | --- |
| getCharacterType(char character) | Gets a type of a character.
 |
| getCount() | Gets the number of characters contained in the  Alphabet .
 |
| setRange(char[] characters, CharacterType type) | Sets the type for each character of the specified collection in this instance of the  Alphabet .
 |
| clear() | Sets the  CharacterType.Separator  type for all characters in this  Alphabet .
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCharacterType(char character)
```
public abstract CharacterType getCharacterType(char character)
```

Gets a type of a character.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character to get a type.
 |

**Returns:**
CharacterType - A type of the character.

##### getCount()
```
public abstract int getCount()
```

Gets the number of characters contained in the  Alphabet .

**Returns:**
int - The number of characters in the dictionary.

##### setRange(char[] characters, CharacterType type)
```
public abstract void setRange(char[] characters, CharacterType type)
```

Sets the type for each character of the specified collection in this instance of the  Alphabet .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characters | char[] | The collection of characters to set the type.
 |
| type | CharacterType | The character type.
 |

##### clear()
```
public abstract void clear()
```

Sets the  CharacterType.Separator  type for all characters in this  Alphabet .

##### iterator()
```
public abstract Iterator<Character> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.Character> - An iterator that can be used to iterate through the collection.

### CharacterReplacementDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/characterreplacementdictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface CharacterReplacementDictionary extends DictionaryBase, Iterable<Character>
```

Defines interface of a character replacement dictionary that is used during the indexing process. Character replacement can be used, for example, to remove accents from accented characters or to make case-insensitive index.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of characters contained in this  CharacterReplacementDictionary .
 |
| addRange(Iterable<CharacterReplacementPair> characterReplacements) | Adds the specified collection of character replacements to this instance of the  CharacterReplacementDictionary .
 |
| addRange(CharacterReplacementPair[] characterReplacements) | Adds the specified collection of character replacements to this instance of the  CharacterReplacementDictionary .
 |
| removeRange(char[] characters) | Removes the specified collection of character replacements from this instance of the  CharacterReplacementDictionary .
 |
| contains(char character) | Determines whether a  CharacterReplacementDictionary  object contains a replacement for the specified character.
 |
| getReplacement(char character) | Gets a replacement for the specified character.
 |
| clear() | Removes all character replacements from a  CharacterReplacementDictionary  object.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of characters contained in this  CharacterReplacementDictionary .

**Returns:**
int - The number of characters in the dictionary.

##### addRange(Iterable<CharacterReplacementPair> characterReplacements)
```
public abstract void addRange(Iterable<CharacterReplacementPair> characterReplacements)
```

Adds the specified collection of character replacements to this instance of the  CharacterReplacementDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | java.lang.Iterable<com.groupdocs.search.dictionaries.CharacterReplacementPair> | The collection of character replacements to add to the dictionary.
 |

##### addRange(CharacterReplacementPair[] characterReplacements)
```
public abstract void addRange(CharacterReplacementPair[] characterReplacements)
```

Adds the specified collection of character replacements to this instance of the  CharacterReplacementDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | CharacterReplacementPair\[\] | The collection of character replacements to add to the dictionary.
 |

##### removeRange(char[] characters)
```
public abstract void removeRange(char[] characters)
```

Removes the specified collection of character replacements from this instance of the  CharacterReplacementDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characters | char[] | The collection of characters to remove.
 |

##### contains(char character)
```
public abstract boolean contains(char character)
```

Determines whether a  CharacterReplacementDictionary  object contains a replacement for the specified character.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character to locate in the  CharacterReplacementDictionary  object.
 |

**Returns:**
boolean -  true  if the  CharacterReplacementDictionary  object contains the specified character; otherwise,  false .

##### getReplacement(char character)
```
public abstract char getReplacement(char character)
```

Gets a replacement for the specified character.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character to get a replacement for.
 |

**Returns:**
char - The replacement for the specified character.

##### clear()
```
public abstract void clear()
```

Removes all character replacements from a  CharacterReplacementDictionary  object.

##### iterator()
```
public abstract Iterator<Character> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.Character> - An iterator that can be used to iterate through the collection.

### CharacterReplacementPair
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/characterreplacementpair.md

**Inheritance:**
java.lang.Object
```
public class CharacterReplacementPair
```

Represents a character/replacement pair.

#### Constructors

| Constructor | Description |
| --- | --- |
| CharacterReplacementPair(char character, char replacement) | Initializes a new instance of the  CharacterReplacementPair  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCharacter() | Gets the character.
 |
| getReplacement() | Gets the replacement.
 |
##### CharacterReplacementPair(char character, char replacement)
```
public CharacterReplacementPair(char character, char replacement)
```

Initializes a new instance of the  CharacterReplacementPair  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character to be replaced.
 |
| replacement | char | The replacement.
 |

##### getCharacter()
```
public final char getCharacter()
```

Gets the character.

**Returns:**
char - The character.

##### getReplacement()
```
public final char getReplacement()
```

Gets the replacement.

**Returns:**
char - The replacement.

### CharacterType
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/charactertype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum CharacterType extends Enum<CharacterType>
```

Represents a type of a character, depending on how it should be indexed.

#### Fields

| Field | Description |
| --- | --- |
| Separator | The separator character.
 |
| Letter | The valid character.
 |
| Blended | Both the separator and the valid character.
 |
| SeparateWord | The character that represents a whole word.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Separator
```
public static final CharacterType Separator
```

The separator character.

##### Letter
```
public static final CharacterType Letter
```

The valid character.

##### Blended
```
public static final CharacterType Blended
```

Both the separator and the valid character.

##### SeparateWord
```
public static final CharacterType SeparateWord
```

The character that represents a whole word.

##### values()
```
public static CharacterType[] values()
```

**Returns:**
com.groupdocs.search.dictionaries.CharacterType[]
##### valueOf(String name)
```
public static CharacterType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
CharacterType

### DictionaryBase
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/dictionarybase.md

### DictionaryRepository
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/dictionaryrepository.md

**Inheritance:**
java.lang.Object
```
public abstract class DictionaryRepository
```

Represents a repository of all dictionaries in the  Index .

#### Constructors

| Constructor | Description |
| --- | --- |
| DictionaryRepository() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAliasDictionary() | Gets a dictionary of aliases.
 |
| getStopWordDictionary() | Gets a dictionary of stop words.
 |
| getSynonymDictionary() | Gets a dictionary of synonyms.
 |
| getDocumentPasswords() | Gets a dictionary of document passwords.
 |
| getSpellingCorrector() | Gets a spelling corrector.
 |
| getHomophoneDictionary() | Gets a dictionary of homophones.
 |
| getAlphabet() | Gets a dictionary of characters.
 |
| getCharacterReplacements() | Gets a dictionary of character replacements.
 |
| getWordFormsProvider() | Gets a word forms provider.
 |
| setWordFormsProvider(IWordFormsProvider value) | Sets a word forms provider.
 |
##### DictionaryRepository()
```
public DictionaryRepository()
```

##### getAliasDictionary()
```
public abstract AliasDictionary getAliasDictionary()
```

Gets a dictionary of aliases.

**Returns:**
AliasDictionary - The dictionary of aliases.

##### getStopWordDictionary()
```
public abstract StopWordDictionary getStopWordDictionary()
```

Gets a dictionary of stop words.

**Returns:**
StopWordDictionary - The dictionary of stop words.

##### getSynonymDictionary()
```
public abstract SynonymDictionary getSynonymDictionary()
```

Gets a dictionary of synonyms.

**Returns:**
SynonymDictionary - The dictionary of synonyms.

##### getDocumentPasswords()
```
public abstract PasswordDictionary getDocumentPasswords()
```

Gets a dictionary of document passwords.

**Returns:**
PasswordDictionary - The dictionary of document passwords.

##### getSpellingCorrector()
```
public abstract SpellingCorrector getSpellingCorrector()
```

Gets a spelling corrector.

**Returns:**
SpellingCorrector - The spelling corrector.

##### getHomophoneDictionary()
```
public abstract HomophoneDictionary getHomophoneDictionary()
```

Gets a dictionary of homophones.

**Returns:**
HomophoneDictionary - The dictionary of homophones.

##### getAlphabet()
```
public abstract Alphabet getAlphabet()
```

Gets a dictionary of characters.

**Returns:**
Alphabet - The dictionary of characters.

##### getCharacterReplacements()
```
public abstract CharacterReplacementDictionary getCharacterReplacements()
```

Gets a dictionary of character replacements.

**Returns:**
CharacterReplacementDictionary - The dictionary of character replacements.

##### getWordFormsProvider()
```
public abstract IWordFormsProvider getWordFormsProvider()
```

Gets a word forms provider.

**Returns:**
IWordFormsProvider - The word forms provider.

##### setWordFormsProvider(IWordFormsProvider value)
```
public abstract void setWordFormsProvider(IWordFormsProvider value)
```

Sets a word forms provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IWordFormsProvider | A word forms provider.
 |

### DictionaryType
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/dictionarytype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum DictionaryType extends Enum<DictionaryType>
```

Represents a type of a dictionary.

#### Fields

| Field | Description |
| --- | --- |
| Alphabet | The alphabet.
 |
| AliasDictionary | The alias dictionary.
 |
| CharacterReplacementDictionary | The character replacement dictionary.
 |
| SynonymDictionary | The synonym dictionary.
 |
| HomophoneDictionary | The homophone dictionary.
 |
| SpellingCorrector | The spelling corrector.
 |
| StopWordDictionary | The stop word dictionary.
 |
| PasswordDictionary | The password dictionary.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Alphabet
```
public static final DictionaryType Alphabet
```

The alphabet.

##### AliasDictionary
```
public static final DictionaryType AliasDictionary
```

The alias dictionary.

##### CharacterReplacementDictionary
```
public static final DictionaryType CharacterReplacementDictionary
```

The character replacement dictionary.

##### SynonymDictionary
```
public static final DictionaryType SynonymDictionary
```

The synonym dictionary.

##### HomophoneDictionary
```
public static final DictionaryType HomophoneDictionary
```

The homophone dictionary.

##### SpellingCorrector
```
public static final DictionaryType SpellingCorrector
```

The spelling corrector.

##### StopWordDictionary
```
public static final DictionaryType StopWordDictionary
```

The stop word dictionary.

##### PasswordDictionary
```
public static final DictionaryType PasswordDictionary
```

The password dictionary.

##### values()
```
public static DictionaryType[] values()
```

**Returns:**
com.groupdocs.search.dictionaries.DictionaryType[]
##### valueOf(String name)
```
public static DictionaryType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
DictionaryType

### EnglishWordFormsProvider
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/englishwordformsprovider.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.IWordFormsProvider
```
public class EnglishWordFormsProvider implements IWordFormsProvider
```

Represents an English word forms provider.

#### Constructors

| Constructor | Description |
| --- | --- |
| EnglishWordFormsProvider() | Initializes a new instance of the
EnglishWordFormsProvider
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWordForms(String word) | Gets the word forms for the specified word.
 |
##### EnglishWordFormsProvider()
```
public EnglishWordFormsProvider()
```

Initializes a new instance of the
EnglishWordFormsProvider
 class.

##### getWordForms(String word)
```
public final String[] getWordForms(String word)
```

Gets the word forms for the specified word.
The resulting array does not contain the original word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word to suggest the word forms.
 |

**Returns:**
java.lang.String[] - The word forms for the specified word or empty array if the  IWordFormsProvider  does not provide word forms for the specified word.

### HomophoneDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/homophonedictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface HomophoneDictionary extends DictionaryBase, Iterable<String>
```

Defines interface of a dictionary of heterographic homophones.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of words contained in this  HomophoneDictionary .
 |
| addRange(Iterable<String[]> homophones) | Adds the specified collection of homophone groups to this instance of the  HomophoneDictionary .
 |
| addRange(String[][] homophones) | Adds the specified collection of homophone groups to this instance of the  HomophoneDictionary .
 |
| clear() | Removes all words from a  HomophoneDictionary  object.
 |
| getHomophones(String word) | Gets the homophones for the specified word.
 |
| getHomophoneGroups(String word) | Gets all groups of homophones to which the specified word belongs.
 |
| getAllHomophoneGroups() | Gets all groups of homophones contained in this dictionary.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of words contained in this  HomophoneDictionary .

**Returns:**
int - The number of words.

##### addRange(Iterable<String[]> homophones)
```
public abstract void addRange(Iterable<String[]> homophones)
```

Adds the specified collection of homophone groups to this instance of the  HomophoneDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| homophones | java.lang.Iterable<java.lang.String[]> | The collection of homophone groups to add to the dictionary.
 |

##### addRange(String[][] homophones)
```
public abstract void addRange(String[][] homophones)
```

Adds the specified collection of homophone groups to this instance of the  HomophoneDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| homophones | java.lang.String[][] | The collection of homophone groups to add to the dictionary.
 |

##### clear()
```
public abstract void clear()
```

Removes all words from a  HomophoneDictionary  object.

##### getHomophones(String word)
```
public abstract String[] getHomophones(String word)
```

Gets the homophones for the specified word. The resulting array does not contain the original word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word to suggest the homophones.
 |

**Returns:**
java.lang.String[] - The homophones for the specified word or empty array if the  HomophoneDictionary  object does not contain the specified word.

##### getHomophoneGroups(String word)
```
public abstract String[][] getHomophoneGroups(String word)
```

Gets all groups of homophones to which the specified word belongs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word for getting groups of homophones.
 |

**Returns:**
java.lang.String[][] - All groups of homophones to which the specified word belongs.

##### getAllHomophoneGroups()
```
public abstract String[][] getAllHomophoneGroups()
```

Gets all groups of homophones contained in this dictionary.

**Returns:**
java.lang.String[][] - All groups of homophones.

##### iterator()
```
public abstract Iterator<String> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.

### IWordFormsProvider
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/iwordformsprovider.md

### PasswordDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/passworddictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface PasswordDictionary extends DictionaryBase, Iterable<String>
```

Defines interface of a dictionary of document passwords.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the dictionary.
 |
| getPassword(String filePath) | Gets the password for the file.
 |
| clear() | Removes all passwords from this  PasswordDictionary  object.
 |
| contains(String filePath) | Determines whether the dictionary contains a password for the specified document.
 |
| add(String filePath, String password) | Adds a password for a document to the dictionary.
 |
| remove(String filePath) | Removes a password of the specified document from the dictionary.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of elements contained in the dictionary.

**Returns:**
int - The number of elements contained in the dictionary.

##### getPassword(String filePath)
```
public abstract String getPassword(String filePath)
```

Gets the password for the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path.
 |

**Returns:**
java.lang.String - The password for the file.

##### clear()
```
public abstract void clear()
```

Removes all passwords from this  PasswordDictionary  object.

##### contains(String filePath)
```
public abstract boolean contains(String filePath)
```

Determines whether the dictionary contains a password for the specified document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The document file path.
 |

**Returns:**
boolean -  true  if the dictionary contains a password for the document; otherwise,  false .

##### add(String filePath, String password)
```
public abstract void add(String filePath, String password)
```

Adds a password for a document to the dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The document file path.
 |
| password | java.lang.String | The document password.
 |

##### remove(String filePath)
```
public abstract boolean remove(String filePath)
```

Removes a password of the specified document from the dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The document file path.
 |

**Returns:**
boolean -  true  if the password was successfully removed; otherwise,  false . This method also returns  false  if  filePath  was not found in the dictionary.

##### iterator()
```
public abstract Iterator<String> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.

### SpellingCorrector
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/spellingcorrector.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase
```
public interface SpellingCorrector extends DictionaryBase
```

Defines interface of a spelling corrector for terms in a query.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of words contained in this  SpellingCorrector .
 |
| getWords() | Gets the collection of words that is currently contained in this  SpellingCorrector .
 |
| addRange(Iterable<String> words) | Adds the specified collection of words to this instance of the  SpellingCorrector .
 |
| addRange(String[] words) | Adds the specified collection of words to this instance of the  SpellingCorrector .
 |
| clear() | Removes all words from a  SpellingCorrector  object.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of words contained in this  SpellingCorrector .

**Returns:**
int - The number of words contained in this  SpellingCorrector .

##### getWords()
```
public abstract String[] getWords()
```

Gets the collection of words that is currently contained in this  SpellingCorrector .

**Returns:**
java.lang.String[] - The collection of words.

##### addRange(Iterable<String> words)
```
public abstract void addRange(Iterable<String> words)
```

Adds the specified collection of words to this instance of the  SpellingCorrector .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.Iterable<java.lang.String> | The collection of words to add to the dictionary.
 |

##### addRange(String[] words)
```
public abstract void addRange(String[] words)
```

Adds the specified collection of words to this instance of the  SpellingCorrector .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.String[] | The collection of words to add to the dictionary.
 |

##### clear()
```
public abstract void clear()
```

Removes all words from a  SpellingCorrector  object.

### StopWordDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/stopworddictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface StopWordDictionary extends DictionaryBase, Iterable<String>
```

Defines interface of a dictionary of stop words.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of stop words contained in the  StopWordDictionary .
 |
| addRange(Iterable<String> words) | Adds the specified collection of words to this instance of the  StopWordDictionary .
 |
| addRange(String[] words) | Adds the specified collection of words to this instance of the  StopWordDictionary .
 |
| removeRange(Iterable<String> words) | Removes the specified collection of words from this instance of the  StopWordDictionary .
 |
| removeRange(String[] words) | Removes the specified collection of words from this instance of the  StopWordDictionary .
 |
| contains(String word) | Determines whether a  StopWordDictionary  object contains the specified word.
 |
| clear() | Removes all words from a  StopWordDictionary  object.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of stop words contained in the  StopWordDictionary .

**Returns:**
int - The number of stop words in the dictionary.

##### addRange(Iterable<String> words)
```
public abstract void addRange(Iterable<String> words)
```

Adds the specified collection of words to this instance of the  StopWordDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.Iterable<java.lang.String> | The collection of words to add to the dictionary.
 |

##### addRange(String[] words)
```
public abstract void addRange(String[] words)
```

Adds the specified collection of words to this instance of the  StopWordDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.String[] | The collection of words to add to the dictionary.
 |

##### removeRange(Iterable<String> words)
```
public abstract void removeRange(Iterable<String> words)
```

Removes the specified collection of words from this instance of the  StopWordDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.Iterable<java.lang.String> | The collection of words to remove.
 |

##### removeRange(String[] words)
```
public abstract void removeRange(String[] words)
```

Removes the specified collection of words from this instance of the  StopWordDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| words | java.lang.String[] | The collection of words to remove.
 |

##### contains(String word)
```
public abstract boolean contains(String word)
```

Determines whether a  StopWordDictionary  object contains the specified word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word to locate in the  StopWordDictionary  object.
 |

**Returns:**
boolean -  true  if the  StopWordDictionary  object contains the specified word; otherwise,  false .

##### clear()
```
public abstract void clear()
```

Removes all words from a  StopWordDictionary  object.

##### iterator()
```
public abstract Iterator<String> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.

### SynonymDictionary
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.dictionaries/synonymdictionary.md

**All Implemented Interfaces:**
com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
```
public interface SynonymDictionary extends DictionaryBase, Iterable<String>
```

Defines interface of a dictionary of synonyms.

#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of words contained in this  SynonymDictionary .
 |
| addRange(Iterable<String[]> synonyms) | Adds the specified collection of synonym groups to this instance of the  SynonymDictionary .
 |
| addRange(String[][] synonyms) | Adds the specified collection of synonym groups to this instance of the  SynonymDictionary .
 |
| clear() | Removes all words from this  SynonymDictionary  object.
 |
| getSynonyms(String word) | Gets the synonyms for the specified word.
 |
| getSynonymGroups(String word) | Gets all groups of synonyms to which the specified word belongs.
 |
| getAllSynonymGroups() | Gets all groups of synonyms contained in this dictionary.
 |
| iterator() | Returns an iterator that iterates through the collection.
 |
##### getCount()
```
public abstract int getCount()
```

Gets the number of words contained in this  SynonymDictionary .

**Returns:**
int - The number of words contained in this  SynonymDictionary .

##### addRange(Iterable<String[]> synonyms)
```
public abstract void addRange(Iterable<String[]> synonyms)
```

Adds the specified collection of synonym groups to this instance of the  SynonymDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| synonyms | java.lang.Iterable<java.lang.String[]> | The collection of synonym groups to add to the dictionary.
 |

##### addRange(String[][] synonyms)
```
public abstract void addRange(String[][] synonyms)
```

Adds the specified collection of synonym groups to this instance of the  SynonymDictionary .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| synonyms | java.lang.String[][] | The collection of synonym groups to add to the dictionary.
 |

##### clear()
```
public abstract void clear()
```

Removes all words from this  SynonymDictionary  object.

##### getSynonyms(String word)
```
public abstract String[] getSynonyms(String word)
```

Gets the synonyms for the specified word. The resulting array does not contain the original word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word to suggest the synonyms.
 |

**Returns:**
java.lang.String[] - The synonyms for the specified word or empty array if the  SynonymDictionary  object does not contain the specified word.

##### getSynonymGroups(String word)
```
public abstract String[][] getSynonymGroups(String word)
```

Gets all groups of synonyms to which the specified word belongs.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word for getting groups of synonyms.
 |

**Returns:**
java.lang.String[][] - All groups of synonyms to which the specified word belongs.

##### getAllSynonymGroups()
```
public abstract String[][] getAllSynonymGroups()
```

Gets all groups of synonyms contained in this dictionary.

**Returns:**
java.lang.String[][] - All groups of synonyms.

##### iterator()
```
public abstract Iterator<String> iterator()
```

Returns an iterator that iterates through the collection.

**Returns:**
java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.

### com.groupdocs.search.events
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events.md

The package provides classes of event arguments.

#### Classes

| Class | Description |
| --- | --- |
| BaseIndexEventArgs | Represents the base class of event arguments. |
| Event<T> | This class is intended to be inherited when subscribing to events. |
| EventHub | Provides index events for subscribing. |
| EventHubBase | The base abstract class for event hubs. |
| FileIndexingEventArgs | Represents arguments for the event of a document indexing start. |
| ImagePreparingEventArgs | Represents arguments for the event of an image preparing start. |
| IndexErrorEventArgs | Represents arguments for the event of index error occurred. |
| OperationFinishedEventArgs | Represents arguments for the event of the indexing operation is finished. |
| OperationProgressEventArgs | Represents arguments for the event of the indexing operation progress is updated. |
| OptimizationProgressEventArgs | Represents arguments for the event of the indexing operation progress is updated. |
| PasswordRequiredEventArgs | Represents arguments for the event that occurs when document protected by a password is indexing. |
| SearchPhaseEventArgs | Represents arguments for the search phase changing events. |

#### Interfaces

| Interface | Description |
| --- | --- |
| EventHandler<T> | Defines interface of an event handler. |

#### Enumerations

| Enum | Description |
| --- | --- |
| OperationType | Represents an index operation type. |
| SearchPhase | Represents the search phases. |

### BaseIndexEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/baseindexeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class BaseIndexEventArgs extends EventArgs
```

Represents the base class of event arguments.

#### Methods

| Method | Description |
| --- | --- |
| getTime() | Gets the time of an event.
 |
| getIndexId() | Gets the index ID.
 |
| getIndexFolder() | Gets the index folder.
 |
| getStatus() | Gets the index status.
 |
##### getTime()
```
public final Date getTime()
```

Gets the time of an event.

**Returns:**
java.util.Date - The time of an event.

##### getIndexId()
```
public final UUID getIndexId()
```

Gets the index ID.

**Returns:**
java.util.UUID - The index ID.

##### getIndexFolder()
```
public final String getIndexFolder()
```

Gets the index folder.

**Returns:**
java.lang.String - The index folder.

##### getStatus()
```
public final IndexStatus getStatus()
```

Gets the index status.

**Returns:**
IndexStatus - The index status.

### Event
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/event.md

**Inheritance:**
java.lang.Object
```
public abstract class Event<T>
```

This class is intended to be inherited when subscribing to events.

#### Constructors

| Constructor | Description |
| --- | --- |
| Event() | Initializes a new instance of the  Event  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| add(T delegate) | Adds a listener for the event.
 |
| remove(T delegate) | Removes a listener for the event.
 |
| isEmpty() | Checks for presence of at least one listener.
 |
##### Event()
```
public Event()
```

Initializes a new instance of the  Event  class.

##### add(T delegate)
```
public final synchronized void add(T delegate)
```

Adds a listener for the event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| delegate | T | A listener for the event to add.
 |

##### remove(T delegate)
```
public final synchronized void remove(T delegate)
```

Removes a listener for the event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| delegate | T | A listener for the event to remove.
 |

##### isEmpty()
```
public synchronized boolean isEmpty()
```

Checks for presence of at least one listener.

**Returns:**
boolean - A value indicating that at least one listener added for the event.

### EventHandler
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/eventhandler.md

### EventHub
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/eventhub.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventHubBase
```
public abstract class EventHub extends EventHubBase
```

Provides index events for subscribing.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().ErrorOccurred.add(new EventHandler() {
     public void invoke(Object sender, IndexErrorEventArgs args) {
         System.out.println(args.getMessage());
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Searching in the index
 SearchResult result = index.search(query);
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| EventHub() |  |
#### Fields

| Field | Description |
| --- | --- |
| OperationFinished | Occurs when an index operation is finished.
 |
| ErrorOccurred | Occurs when an error occurs during an index operation.
 |
| OperationProgressChanged | Occurs when the progress of the indexing or update operation changes.
 |
| OptimizationProgressChanged | Occurs when the progress of the optimization operation changes.
 |
| PasswordRequired | Occurs when a document requires password for opening.
 |
| FileIndexing | Occurs when a document is going to be indexed.
 |
| ImagePreparing | Occurs when an image is going to be prepared for indexing.
 |
| StatusChanged | Occurs when the index status changes.
 |
| SearchPhaseCompleted | Occurs when the search phase is completed.
 |
##### EventHub()
```
public EventHub()
```

##### OperationFinished
```
public final Event<EventHandler<OperationFinishedEventArgs>> OperationFinished
```

Occurs when an index operation is finished.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().OperationFinished.add(new EventHandler() {
     public void invoke(Object sender, OperationFinishedEventArgs args) {
         System.out.println("Operation finished: " + args.getOperationType());
         System.out.println("Message: " + args.getMessage());
         System.out.println("Index folder: " + args.getIndexFolder());
         DateFormat df = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
         System.out.println("Time: " + df.format(args.getTime()));
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 
```
 
````

##### ErrorOccurred
```
public final Event<EventHandler<IndexErrorEventArgs>> ErrorOccurred
```

Occurs when an error occurs during an index operation.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().ErrorOccurred.add(new EventHandler() {
     public void invoke(Object sender, IndexErrorEventArgs args) {
         System.out.println(args.getMessage());
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Searching in the index
 SearchResult result = index.search(query);
 
```
 
````

##### OperationProgressChanged
```
public final Event<EventHandler<OperationProgressEventArgs>> OperationProgressChanged
```

Occurs when the progress of the indexing or update operation changes.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().OperationProgressChanged.add(new EventHandler() {
     public void invoke(Object sender, OperationProgressEventArgs args) {
         System.out.println("Last processed: " + args.getLastDocumentPath());
         System.out.println("Result: " + args.getLastDocumentStatus());
         System.out.println("Processed documents: " + args.getTotalDocuments());
         System.out.println("Progress percentage: " + args.getProgressPercentage());
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 
```
 
````

##### OptimizationProgressChanged
```
public final Event<EventHandler<OptimizationProgressEventArgs>> OptimizationProgressChanged
```

Occurs when the progress of the optimization operation changes.

##### PasswordRequired
```
public final Event<EventHandler<PasswordRequiredEventArgs>> PasswordRequired
```

Occurs when a document requires password for opening.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().PasswordRequired.add(new EventHandler() {
     public void invoke(Object sender, PasswordRequiredEventArgs args) {
         if (args.getDocumentFullPath().endsWith("ProtectedDocument.pdf")) {
             args.setPassword("123456");
         }
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 
```
 
````

##### FileIndexing
```
public final Event<EventHandler<FileIndexingEventArgs>> FileIndexing
```

Occurs when a document is going to be indexed.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().FileIndexing.add(new EventHandler() {
     public void invoke(Object sender, FileIndexingEventArgs args) {
         if (args.getDocumentFullPath().endsWith("Protected.pdf")) {
             args.setAdditionalFields(new DocumentField[] {
                 new DocumentField("Tags", "Protected")
             });
         }
         if (!args.getDocumentFullPath().toLowerCase().contains("important")) {
             args.setSkipIndexing(true);
         }
     }
 });
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 
```
 
````

##### ImagePreparing
```
public final Event<EventHandler<ImagePreparingEventArgs>> ImagePreparing
```

Occurs when an image is going to be prepared for indexing.

##### StatusChanged
```
public final Event<EventHandler<BaseIndexEventArgs>> StatusChanged
```

Occurs when the index status changes.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Subscribing to the event
 index.getEvents().StatusChanged.add(new EventHandler() {
     public void invoke(Object sender, BaseIndexEventArgs args) {
         if (args.getStatus() != IndexStatus.InProgress) {
             // A notification of the operation completion should be here
         }
     }
 });
 // Setting the flag for asynchronous indexing
 IndexingOptions options = new IndexingOptions();
 options.setAsync(true);
 // Asynchronous indexing documents from the specified folder
 // The method terminates before the operation completes
 index.add(documentsFolder, options);
 
```
 
````

##### SearchPhaseCompleted
```
public final Event<EventHandler<SearchPhaseEventArgs>> SearchPhaseCompleted
```

Occurs when the search phase is completed.

The example demonstrates how to use the event.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Subscribing to the event
 index.getEvents().SearchPhaseCompleted.add(new EventHandler() {
     public void invoke(Object sender, SearchPhaseEventArgs args) {
         System.out.println("Search phase: " + args.getSearchPhase());
         System.out.println("Words: " + args.getWords().length);
     }
 });
 SearchOptions options = new SearchOptions();
 options.setUseSynonymSearch(true);
 options.setUseWordFormsSearch(true);
 options.getFuzzySearch().setEnabled(true);
 options.setUseHomophoneSearch(true);
 SearchResult result = index.search("Einstein", options);
 
```
 
````

### EventHubBase
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/eventhubbase.md

**Inheritance:**
java.lang.Object
```
public abstract class EventHubBase
```

The base abstract class for event hubs.

#### Constructors

| Constructor | Description |
| --- | --- |
| EventHubBase() |  |
#### Methods

| Method | Description |
| --- | --- |
| raiseErrorOccurredPublic(String message, boolean isCritical) |  |
| raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream) |  |
| raisePasswordRequiredPublic(String filePath) |  |
##### EventHubBase()
```
public EventHubBase()
```

##### raiseErrorOccurredPublic(String message, boolean isCritical)
```
public abstract void raiseErrorOccurredPublic(String message, boolean isCritical)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| isCritical | boolean |  |

##### raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
```
public abstract void raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String |  |
| innerPath | java.lang.String[] |  |
| imageIndex | int |  |
| frames | ImageFrame\[\] |  |
| stream | java.io.InputStream |  |

##### raisePasswordRequiredPublic(String filePath)
```
public abstract String raisePasswordRequiredPublic(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

**Returns:**
java.lang.String

### FileIndexingEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/fileindexingeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class FileIndexingEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of a document indexing start.

#### Methods

| Method | Description |
| --- | --- |
| getDocument() | Gets the document.
 |
| getDocumentFullPath() | Gets the document full path.
 |
| getDocumentKey() | Gets the document key.
 |
| getSkipIndexing() | Gets a value indicating that indexing of the document should be skipped.
 |
| setSkipIndexing(boolean value) | Sets a value indicating that indexing of the document should be skipped.
 |
| getEncoding() | Gets the encoding of the document.
 |
| setEncoding(String value) | Sets the encoding of the document.
 |
| getCustomExtractor() | Gets the custom text extractor.
 |
| setCustomExtractor(IFieldExtractor value) | Sets the custom text extractor.
 |
| getAdditionalFields() | Gets the additional fields for the document.
 |
| setAdditionalFields(DocumentField[] value) | Sets the additional fields for the document.
 |
| getAttributes() | Gets the attributes of the document.
 |
| setAttributes(String[] value) | Set the attributes of the document.
 |
##### getDocument()
```
public final Document getDocument()
```

Gets the document.

**Returns:**
Document - The document.

##### getDocumentFullPath()
```
public final String getDocumentFullPath()
```

Gets the document full path.

**Returns:**
java.lang.String - The document full path.

##### getDocumentKey()
```
public final String getDocumentKey()
```

Gets the document key.

**Returns:**
java.lang.String - The document key.

##### getSkipIndexing()
```
public final boolean getSkipIndexing()
```

Gets a value indicating that indexing of the document should be skipped.

**Returns:**
boolean - A value indicating that indexing of the document should be skipped.

##### setSkipIndexing(boolean value)
```
public final void setSkipIndexing(boolean value)
```

Sets a value indicating that indexing of the document should be skipped.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating that indexing of the document should be skipped.
 |

##### getEncoding()
```
public final String getEncoding()
```

Gets the encoding of the document.

**Returns:**
java.lang.String - The encoding of the document.

##### setEncoding(String value)
```
public final void setEncoding(String value)
```

Sets the encoding of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The encoding of the document.
 |

##### getCustomExtractor()
```
public final IFieldExtractor getCustomExtractor()
```

Gets the custom text extractor.

**Returns:**
IFieldExtractor - The custom text extractor.

##### setCustomExtractor(IFieldExtractor value)
```
public final void setCustomExtractor(IFieldExtractor value)
```

Sets the custom text extractor.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IFieldExtractor | The custom text extractor.
 |

##### getAdditionalFields()
```
public final DocumentField[] getAdditionalFields()
```

Gets the additional fields for the document.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The additional fields for the document.

##### setAdditionalFields(DocumentField[] value)
```
public final void setAdditionalFields(DocumentField[] value)
```

Sets the additional fields for the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentField\[\] | The additional fields for the document.
 |

##### getAttributes()
```
public final String[] getAttributes()
```

Gets the attributes of the document.

**Returns:**
java.lang.String[] - The attributes of the document.

##### setAttributes(String[] value)
```
public final void setAttributes(String[] value)
```

Set the attributes of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The attributes of the document.
 |

### ImagePreparingEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/imagepreparingeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class ImagePreparingEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of an image preparing start.

#### Methods

| Method | Description |
| --- | --- |
| getDocumentKey() | Gets the document key.
 |
| getInnerPath() | Gets the inner path of a nested document.
 |
| getImageIndex() | Gets the ordinal number of the image in the document.
 |
| getImageFrames() | Gets the image frames.
 |
| getImageStream() | Gets the image stream.
 |
##### getDocumentKey()
```
public final String getDocumentKey()
```

Gets the document key.

**Returns:**
java.lang.String - The document key.

##### getInnerPath()
```
public final String[] getInnerPath()
```

Gets the inner path of a nested document.

**Returns:**
java.lang.String[] - The inner path of a nested document.

##### getImageIndex()
```
public final int getImageIndex()
```

Gets the ordinal number of the image in the document.

**Returns:**
int - The ordinal number of the image in the document.

##### getImageFrames()
```
public final ImageFrame[] getImageFrames()
```

Gets the image frames.

**Returns:**
com.groupdocs.search.common.ImageFrame[] - The image frames.

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets the image stream.

**Returns:**
java.io.InputStream - The image stream.

### IndexErrorEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/indexerroreventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class IndexErrorEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of index error occurred.

#### Methods

| Method | Description |
| --- | --- |
| getMessage() | Gets the error message.
 |
| isCritical() | Gets a flag indicating that the error occurred is critical and the index should be restarted.
 |
##### getMessage()
```
public final String getMessage()
```

Gets the error message.

**Returns:**
java.lang.String - The error message.

##### isCritical()
```
public final boolean isCritical()
```

Gets a flag indicating that the error occurred is critical and the index should be restarted.

**Returns:**
boolean - The flag indicating that the error occurred is critical and the index should be restarted.

### OperationFinishedEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/operationfinishedeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class OperationFinishedEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of the indexing operation is finished.

#### Methods

| Method | Description |
| --- | --- |
| getMessage() | Gets the message.
 |
| getOperationType() | Gets the operation type.
 |
##### getMessage()
```
public final String getMessage()
```

Gets the message.

**Returns:**
java.lang.String - The message.

##### getOperationType()
```
public final OperationType getOperationType()
```

Gets the operation type.

**Returns:**
OperationType - The operation type.

### OperationProgressEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/operationprogresseventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class OperationProgressEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of the indexing operation progress is updated.

#### Methods

| Method | Description |
| --- | --- |
| getTotalDocuments() | Gets the total number of documents for processing.
 |
| getProcessedDocuments() | Gets the number of successfully processed documents.
 |
| getSkippedDocuments() | Gets the number of skipped documents.
 |
| getProgressPercentage() | Gets the percentage of the progress.
 |
| getLastDocumentKey() | Gets the key of the last processed document.
 |
| getLastDocumentPath() | Gets the path of the last processed document.
 |
| getLastDocumentStatus() | Gets the status of the last processed document.
 |
##### getTotalDocuments()
```
public final int getTotalDocuments()
```

Gets the total number of documents for processing.

**Returns:**
int - The total number of documents for processing.

##### getProcessedDocuments()
```
public final int getProcessedDocuments()
```

Gets the number of successfully processed documents.

**Returns:**
int - The number of successfully processed documents.

##### getSkippedDocuments()
```
public final int getSkippedDocuments()
```

Gets the number of skipped documents.

**Returns:**
int - The number of skipped documents.

##### getProgressPercentage()
```
public final double getProgressPercentage()
```

Gets the percentage of the progress.

**Returns:**
double - The percentage of the progress.

##### getLastDocumentKey()
```
public final String getLastDocumentKey()
```

Gets the key of the last processed document.

**Returns:**
java.lang.String - The last processed document key.

##### getLastDocumentPath()
```
public final String getLastDocumentPath()
```

Gets the path of the last processed document.

**Returns:**
java.lang.String - The last processed document path.

##### getLastDocumentStatus()
```
public final DocumentStatus getLastDocumentStatus()
```

Gets the status of the last processed document.

**Returns:**
DocumentStatus - The last processed document status.

### OperationType
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/operationtype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum OperationType extends Enum<OperationType>
```

Represents an index operation type.

#### Fields

| Field | Description |
| --- | --- |
| Indexing | Adding documents to an index.
 |
| Updating | Updating documents in an index.
 |
| Merging | Merging indexes.
 |
| Optimizing | Optimizing an index.
 |
| Deleting | Deleting paths from an index.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Indexing
```
public static final OperationType Indexing
```

Adding documents to an index.

##### Updating
```
public static final OperationType Updating
```

Updating documents in an index.

##### Merging
```
public static final OperationType Merging
```

Merging indexes.

##### Optimizing
```
public static final OperationType Optimizing
```

Optimizing an index.

##### Deleting
```
public static final OperationType Deleting
```

Deleting paths from an index.

##### values()
```
public static OperationType[] values()
```

**Returns:**
com.groupdocs.search.events.OperationType[]
##### valueOf(String name)
```
public static OperationType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OperationType

### OptimizationProgressEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/optimizationprogresseventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class OptimizationProgressEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event of the indexing operation progress is updated.

#### Methods

| Method | Description |
| --- | --- |
| getTotalSegments() | Gets the total number of segments for processing.
 |
| getProcessedSegments() | Gets the number of processed segments.
 |
| getProgressPercentage() | Gets the percentage of the progress.
 |
##### getTotalSegments()
```
public final int getTotalSegments()
```

Gets the total number of segments for processing.

**Returns:**
int - The total number of segments for processing.

##### getProcessedSegments()
```
public final int getProcessedSegments()
```

Gets the number of processed segments.

**Returns:**
int - The number of processed segments.

##### getProgressPercentage()
```
public final double getProgressPercentage()
```

Gets the percentage of the progress.

**Returns:**
double - The percentage of the progress.

### PasswordRequiredEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/passwordrequiredeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class PasswordRequiredEventArgs extends BaseIndexEventArgs
```

Represents arguments for the event that occurs when document protected by a password is indexing.

#### Methods

| Method | Description |
| --- | --- |
| getDocumentFullPath() | Gets the document full path.
 |
| getPassword() | Gets the password for opening the document.
 |
| setPassword(String value) | Sets the password for opening the document.
 |
##### getDocumentFullPath()
```
public final String getDocumentFullPath()
```

Gets the document full path.

**Returns:**
java.lang.String - The document full path.

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening the document.

**Returns:**
java.lang.String - The password for opening the document.

##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password for opening the document.
 |

### SearchPhase
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/searchphase.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum SearchPhase extends Enum<SearchPhase>
```

Represents the search phases.

#### Fields

| Field | Description |
| --- | --- |
| AliasSubstitution | The alias substitution.
 |
| KeyboardLayoutCorrection | The keyboard layout correction.
 |
| SpellingCorrection | The spelling correction.
 |
| HomophoneSearch | The homophone search.
 |
| SynonymSearch | The synonym search.
 |
| WordFormsSearch | The word forms search.
 |
| FuzzySearch | The fuzzy search.
 |
| WildcardMatching | The wildcard matching.
 |
| RegexMatching | The regex matching.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### AliasSubstitution
```
public static final SearchPhase AliasSubstitution
```

The alias substitution.

##### KeyboardLayoutCorrection
```
public static final SearchPhase KeyboardLayoutCorrection
```

The keyboard layout correction.

##### SpellingCorrection
```
public static final SearchPhase SpellingCorrection
```

The spelling correction.

##### HomophoneSearch
```
public static final SearchPhase HomophoneSearch
```

The homophone search.

##### SynonymSearch
```
public static final SearchPhase SynonymSearch
```

The synonym search.

##### WordFormsSearch
```
public static final SearchPhase WordFormsSearch
```

The word forms search.

##### FuzzySearch
```
public static final SearchPhase FuzzySearch
```

The fuzzy search.

##### WildcardMatching
```
public static final SearchPhase WildcardMatching
```

The wildcard matching.

##### RegexMatching
```
public static final SearchPhase RegexMatching
```

The regex matching.

##### values()
```
public static SearchPhase[] values()
```

**Returns:**
com.groupdocs.search.events.SearchPhase[]
##### valueOf(String name)
```
public static SearchPhase valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
SearchPhase

### SearchPhaseEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.events/searchphaseeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs, com.groupdocs.search.events.BaseIndexEventArgs
```
public class SearchPhaseEventArgs extends BaseIndexEventArgs
```

Represents arguments for the search phase changing events.

#### Methods

| Method | Description |
| --- | --- |
| getSearchPhase() | Gets the search phase.
 |
| getQuery() | Gets the initial query of the current search.
 |
| getWords() | Gets the words obtained in the current phase.
 |
##### getSearchPhase()
```
public final SearchPhase getSearchPhase()
```

Gets the search phase.

**Returns:**
SearchPhase - The search phase.

##### getQuery()
```
public final String getQuery()
```

Gets the initial query of the current search.

**Returns:**
java.lang.String - The initial query of the current search.

##### getWords()
```
public final String[] getWords()
```

Gets the words obtained in the current phase.

**Returns:**
java.lang.String[] - The words obtained in the current phase.

### com.groupdocs.search.exceptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.exceptions.md

### com.groupdocs.search.helpers
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.helpers.md

### com.groupdocs.search.highlighters
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.highlighters.md

The package provides highlighters for highlighting search results in text.

#### Classes

| Class | Description |
| --- | --- |
| DocumentHighlighter | Represents a search result highlighter that highlights search results in an entire document text. |
| FragmentHighlighter | Represents a search result highlighter that highlights search results in text fragments. |
| Highlighter | Represents the base class of a search result highlighter. |

### DocumentHighlighter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.highlighters/documenthighlighter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.highlighters.Highlighter

**All Implemented Interfaces:**
com.groupdocs.search.highlighters.IDocumentHighlighter
```
public class DocumentHighlighter extends Highlighter implements IDocumentHighlighter
```

Represents a search result highlighter that highlights search results in an entire document text.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Search for the phase 'Theory of Relativity'
 SearchResult result = index.search("\"Theory of Relativity\"");
 // Highlighting found words in the text of a document
 FoundDocument document = result.getFoundDocument(0);
 OutputAdapter outputAdapter = new FileOutputAdapter(OutputFormat.Html, "Highlighted.html");
 Highlighter highlighter = new DocumentHighlighter(outputAdapter);
 index.highlight(document, highlighter);
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentHighlighter(OutputAdapter outputAdapter) | Initializes a new instance of the  DocumentHighlighter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getOutputAdapter() | Gets the output adapter passed in the constructor.
 |
##### DocumentHighlighter(OutputAdapter outputAdapter)
```
public DocumentHighlighter(OutputAdapter outputAdapter)
```

Initializes a new instance of the  DocumentHighlighter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputAdapter | OutputAdapter | The output adapter transferring a result of the highlighting.
 |

##### getOutputAdapter()
```
public final OutputAdapter getOutputAdapter()
```

Gets the output adapter passed in the constructor.

**Returns:**
OutputAdapter - The output adapter passed in the constructor.

### FragmentHighlighter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.highlighters/fragmenthighlighter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory, com.groupdocs.search.highlighters.Highlighter

**All Implemented Interfaces:**
com.groupdocs.search.highlighters.IFragmentHighlighter
```
public class FragmentHighlighter extends Highlighter implements IFragmentHighlighter
```

Represents a search result highlighter that highlights search results in text fragments.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Search for the word 'Einstein'
 SearchResult result = index.search("Einstein");
 // Assigning highlight options
 HighlightOptions options = new HighlightOptions();
 options.setTermsBefore(5);
 options.setTermsAfter(5);
 options.setTermsTotal(15);
 // Highlighting found words in the text of a document
 FoundDocument document = result.getFoundDocument(0);
 FragmentHighlighter highlighter = new FragmentHighlighter(OutputFormat.Html);
 index.highlight(document, highlighter, options);
 // Getting the result
 FragmentContainer[] fragmentContainers = highlighter.getResult();
 for (int i = 0; i < fragmentContainers.length; i++) {
     FragmentContainer container = fragmentContainers[i];
     String[] fragments = container.getFragments();
     if (fragments.length > 0) {
         System.out.println(container.getFieldName());
         System.out.println();
         for (int j = 0; j < fragments.length; j++) {
             // Printing HTML markup to console
             System.out.println(fragments[j]);
             System.out.println();
         }
     }
 }
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| FragmentHighlighter(OutputFormat outputFormat) | Initializes a new instance of the  FragmentHighlighter  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getResult() | Gets an array of resulting fragment containers.
 |
##### FragmentHighlighter(OutputFormat outputFormat)
```
public FragmentHighlighter(OutputFormat outputFormat)
```

Initializes a new instance of the  FragmentHighlighter  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format.
 |

##### getResult()
```
public final FragmentContainer[] getResult()
```

Gets an array of resulting fragment containers.

**Returns:**
com.groupdocs.search.common.FragmentContainer[] - An array of resulting fragment containers.

### Highlighter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.highlighters/highlighter.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.ResultBuilderFactory

**All Implemented Interfaces:**
com.groupdocs.search.highlighters.IHighlighter
```
public abstract class Highlighter extends ResultBuilderFactory implements IHighlighter
```

Represents the base class of a search result highlighter.

### com.groupdocs.search.licenses
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.licenses.md

#### Classes

| Class | Description |
| --- | --- |
| License |  |
| Metered |  |

### License
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.licenses/license.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.LicenseAssistant
```
public class License extends LicenseAssistant
```
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| isValidMeteredLicense() |  |
| isValidLicense() |  |
| setLicense(InputStream licenseStream) |  |
| setLicenseInternal(System.IO.Stream licenseStream) |  |
| setMeteredLicense() |  |
| setLicense(Path licensePath) |  |
| setLicense(String licensePath) |  |
| resetLicense() |  |
##### License()
```
public License()
```

##### isValidMeteredLicense()
```
public static boolean isValidMeteredLicense()
```

**Returns:**
boolean
##### isValidLicense()
```
public static boolean isValidLicense()
```

**Returns:**
boolean
##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream |  |

##### 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)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.nio.file.Path |  |

##### setLicense(String licensePath)
```
public final void setLicense(String licensePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String |  |

##### resetLicense()
```
public static void resetLicense()
```

### Metered
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.licenses/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```
#### 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.search.logging
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.logging.md

### com.groupdocs.search.options
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options.md

The package provides classes to specify additional options of various operations.

#### Classes

| Class | Description |
| --- | --- |
| ChangeAttributesOptions | Provides options for the change attributes operation. |
| Color | Represents an ARGB (alpha, red, green, blue) color. |
| CommonFieldNames | Represents a list of field names for the faceted search. |
| DateFormat | Represents a date format. |
| DateFormatCollection | Represents a collection of  DateFormat  objects. |
| DateFormatElement | Represents a date format element. |
| DeleteOptions | Provides options for the delete operation. |
| EpubFieldNames | Represents a list of field names for the faceted search. |
| ExtractionOptions | Provides options for extracting data from documents. |
| FictionBookFieldNames | Represents a list of field names for the faceted search. |
| FuzzyAlgorithm | Represents the base class for fuzzy search algorithms. |
| FuzzySearchOptions | Provides options of the fuzzy search. |
| HighlightOptions | Provides options for highlighting found terms. |
| ImageIndexingOptions | Provides image indexing options for reverse image search. |
| ImageSearchOptions | Provides options for reverse image search operation. |
| IndexingOptions | Provides options for indexing operation. |
| KeyboardLayoutCorrectorOptions | Provides options for the keyboard layout corrector. |
| MailFieldNames | Represents a list of field names for the faceted search. |
| MergeOptions | Provides options for merge operation. |
| MetadataIndexingOptions | Provides options for indexing metadata fields. |
| OcrContext | Represents the OCR processing context. |
| OcrIndexingOptions | Provides options for OCR processing and indexing recognized text. |
| OptimizeOptions | Provides options for the optimize operation. |
| PresentationFieldNames | Represents a list of field names for the faceted search. |
| SearchOptions | Provides options for search operation. |
| SimilarityLevel | Represents an algorithm of the fuzzy search that specifies the similarity level. |
| SpellingCorrectorOptions | Provides options for the spelling corrector. |
| SpreadsheetFieldNames | Represents a list of field names for the faceted search. |
| Step | Represents a step of a step function. |
| SynchronizeOptions | Provides options for the synchronize operation. |
| TableDiscreteFunction | Represents the fuzzy search algorithm that contains correspondences between word lengths and the number of allowed mistakes. |
| TextOptions | Provides options for retrieving document text from an index. |
| TextStorageSettings | Represents the text storage settings. |
| UpdateOptions | Provides options for update operation. |
| WordsFieldNames | Represents a list of field names for the faceted search. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IOcrConnector | Defines methods that are required to recognize text on image documents and embedded images. |
| ISearchDocumentFilter | Represents search document filter. |

#### Enumerations

| Enum | Description |
| --- | --- |
| Compression | Specifies a compression level. |
| ImageLocation | Specifies an image location. |
| IndexType | Specifies an index type. |
| NumberOfThreads | Specifies the number of threads. |
| OutputFormat | The output format of a data. |

### ChangeAttributesOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/changeattributesoptions.md

**Inheritance:**
java.lang.Object
```
public class ChangeAttributesOptions
```

Provides options for the change attributes operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| ChangeAttributesOptions() | Initializes a new instance of the  ChangeAttributesOptions  class.
 |
| ChangeAttributesOptions(Object data) | Initializes a new instance of the  ChangeAttributesOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCore() |  |
##### ChangeAttributesOptions()
```
public ChangeAttributesOptions()
```

Initializes a new instance of the  ChangeAttributesOptions  class.

##### ChangeAttributesOptions(Object data)
```
public ChangeAttributesOptions(Object data)
```

Initializes a new instance of the  ChangeAttributesOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### Color
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/color.md

**Inheritance:**
java.lang.Object
```
public class Color
```

Represents an ARGB (alpha, red, green, blue) color.

#### Constructors

| Constructor | Description |
| --- | --- |
| Color(int alpha, int red, int green, int blue) | Initializes a new instance of the  Color  class.
 |
| Color(int red, int green, int blue) | Initializes a new instance of the  Color  class.
 |
| Color(Object data) | Initializes a new instance of the  Color  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAlpha() | Gets the alpha component value of this instance.
 |
| getRed() | Gets the red component value of this instance.
 |
| getGreen() | Gets the green component value of this instance.
 |
| getBlue() | Gets the blue component value of this instance.
 |
| toString() | Returns a  String  that represents the current  Color .
 |
| getCore() |  |
##### Color(int alpha, int red, int green, int blue)
```
public Color(int alpha, int red, int green, int blue)
```

Initializes a new instance of the  Color  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alpha | int | The alpha component from 0 to 255.
 |
| red | int | The red component from 0 to 255.
 |
| green | int | The green component from 0 to 255.
 |
| blue | int | The blue component from 0 to 255.
 |

##### Color(int red, int green, int blue)
```
public Color(int red, int green, int blue)
```

Initializes a new instance of the  Color  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | The red component from 0 to 255.
 |
| green | int | The green component from 0 to 255.
 |
| blue | int | The blue component from 0 to 255.
 |

##### Color(Object data)
```
public Color(Object data)
```

Initializes a new instance of the  Color  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getAlpha()
```
public int getAlpha()
```

Gets the alpha component value of this instance.

**Returns:**
int - The alpha component value of this instance.

##### getRed()
```
public int getRed()
```

Gets the red component value of this instance.

**Returns:**
int - The red component value of this instance.

##### getGreen()
```
public int getGreen()
```

Gets the green component value of this instance.

**Returns:**
int - The green component value of this instance.

##### getBlue()
```
public int getBlue()
```

Gets the blue component value of this instance.

**Returns:**
int - The blue component value of this instance.

##### toString()
```
public String toString()
```

Returns a  String  that represents the current  Color .

**Returns:**
java.lang.String - A  String  that represents the current  Color .

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### CommonFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/commonfieldnames.md

**Inheritance:**
java.lang.Object
```
public class CommonFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| CommonFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Content | The content field name.
 |
| FileName | The file name field name.
 |
| FormatFamily | The format family field name.
 |
| CreationDate | The creation date field name.
 |
| ModificationDate | The modification date field name.
 |
| EmbeddedImageOcr | The embedded image OCR field name.
 |
##### CommonFieldNames()
```
public CommonFieldNames()
```

##### Content
```
public static final String Content
```

The content field name.

##### FileName
```
public static final String FileName
```

The file name field name.

##### FormatFamily
```
public static final String FormatFamily
```

The format family field name.

##### CreationDate
```
public static final String CreationDate
```

The creation date field name.

##### ModificationDate
```
public static final String ModificationDate
```

The modification date field name.

##### EmbeddedImageOcr
```
public static final String EmbeddedImageOcr
```

The embedded image OCR field name.

### Compression
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/compression.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Compression extends Enum<Compression>
```

Specifies a compression level.

#### Fields

| Field | Description |
| --- | --- |
| None | Compression is disabled.
 |
| Normal | Normal compression level.
 |
| High | High compression level.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### None
```
public static final Compression None
```

Compression is disabled.

##### Normal
```
public static final Compression Normal
```

Normal compression level.

##### High
```
public static final Compression High
```

High compression level.

##### values()
```
public static Compression[] values()
```

**Returns:**
com.groupdocs.search.options.Compression[]
##### valueOf(String name)
```
public static Compression valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Compression

### DateFormat
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/dateformat.md

**Inheritance:**
java.lang.Object
```
public class DateFormat
```

Represents a date format.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "daterange(2017-01-01 ~~ 2019-12-31)";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getDateFormats().clear(); // Removing default date formats
 DateFormatElement[] elements = new DateFormatElement[] {
     DateFormatElement.getMonthTwoDigits(),
     DateFormatElement.getDateSeparator(),
     DateFormatElement.getDayOfMonthTwoDigits(),
     DateFormatElement.getDateSeparator(),
     DateFormatElement.getYearFourDigits(),
 };
 // Creating a date format pattern 'MM/dd/yyyy'
 com.groupdocs.search.DateFormat dateFormat = new com.groupdocs.search.DateFormat(elements, "/");
 options.getDateFormats().addItem(dateFormat);
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| DateFormat(String cultureName, DateFormatElement[] formatElements) | Initializes a new instance of the  DateFormat  class.
 |
| DateFormat(DateFormatElement[] formatElements, String dateSeparator) | Initializes a new instance of the  DateFormat  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDateSeparator() | Gets the date separator.
 |
| toString() | Returns a String that represents the current  DateFormat .
 |
| getCore() |  |
##### DateFormat(String cultureName, DateFormatElement[] formatElements)
```
public DateFormat(String cultureName, DateFormatElement[] formatElements)
```

Initializes a new instance of the  DateFormat  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cultureName | java.lang.String | The culture name.
 |
| formatElements | DateFormatElement\[\] | The format elements.
 |

##### DateFormat(DateFormatElement[] formatElements, String dateSeparator)
```
public DateFormat(DateFormatElement[] formatElements, String dateSeparator)
```

Initializes a new instance of the  DateFormat  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatElements | DateFormatElement\[\] | The format elements.
 |
| dateSeparator | java.lang.String | The date separator.
 |

##### getDateSeparator()
```
public String getDateSeparator()
```

Gets the date separator.

**Returns:**
java.lang.String - The date separator.

##### toString()
```
public String toString()
```

Returns a String that represents the current  DateFormat .

**Returns:**
java.lang.String - A String that represents the current  DateFormat .

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### DateFormatCollection
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/dateformatcollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class DateFormatCollection implements Iterable<DateFormat>
```

Represents a collection of  DateFormat  objects.

#### Constructors

| Constructor | Description |
| --- | --- |
| DateFormatCollection() |  |
#### Methods

| Method | Description |
| --- | --- |
| addItem(DateFormat item) | Adds an date format object to the collection.
 |
| clear() | Removes all elements from the collection.
 |
| containsItem(DateFormat item) | Determines whether the collection contains a specific item.
 |
| copyToTArray(DateFormat[] array, int arrayIndex) | Copies the elements of the collection to an  Array , starting at a particular  Array  index.
 |
| size() | Gets the number of elements contained in the collection.
 |
| isReadOnly() | Gets a value indicating whether the collection is read-only.
 |
| removeItem(DateFormat item) | Removes the first occurrence of a specific element from the collection.
 |
| iterator() | Returns an enumerator that iterates through the collection.
 |
##### DateFormatCollection()
```
public DateFormatCollection()
```

##### addItem(DateFormat item)
```
public abstract void addItem(DateFormat item)
```

Adds an date format object to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The date format object to add to the collection.
 |

##### clear()
```
public abstract void clear()
```

Removes all elements from the collection.

##### containsItem(DateFormat item)
```
public abstract boolean containsItem(DateFormat item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The item to locate in the collection.
 |

**Returns:**
boolean -  true  if item is found in the collection; otherwise,  false .

##### copyToTArray(DateFormat[] array, int arrayIndex)
```
public abstract void copyToTArray(DateFormat[] array, int arrayIndex)
```

Copies the elements of the collection to an  Array , starting at a particular  Array  index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | DateFormat\[\] | The one-dimensional  Array  that is the destination of the elements copied from the collection.
 |
| arrayIndex | int | The zero-based index in array at which copying begins.
 |

##### size()
```
public abstract int size()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.

##### isReadOnly()
```
public abstract boolean isReadOnly()
```

Gets a value indicating whether the collection is read-only.

**Returns:**
boolean -  true  if the collection is read-only; otherwise,  false .

##### removeItem(DateFormat item)
```
public abstract boolean removeItem(DateFormat item)
```

Removes the first occurrence of a specific element from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The item to remove from the collection.
 |

**Returns:**
boolean -  true  if item was successfully removed from the collection; otherwise,  false . This method also returns  false  if item is not found in the collection.

##### iterator()
```
public abstract Iterator<DateFormat> iterator()
```

Returns an enumerator that iterates through the collection.

**Returns:**
java.util.Iterator<com.groupdocs.search.options.DateFormat> - An enumerator that can be used to iterate through the collection.

### DateFormatElement
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/dateformatelement.md

**Inheritance:**
java.lang.Object
```
public abstract class DateFormatElement
```

Represents a date format element.

#### Constructors

| Constructor | Description |
| --- | --- |
| DateFormatElement() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFormat() | Gets the format string.
 |
| getSingleFormat() | Gets the single format string.
 |
| toString() | Returns a String that represents the current  DateFormatElement .
 |
| getDayOfMonth() | Gets the day of month element, represented by one or two digits.
 |
| getDayOfMonthTwoDigits() | Gets the day of month element, represented by two digits.
 |
| getMonth() | Gets the month element, represented by one or two digits.
 |
| getMonthTwoDigits() | Gets the month element, represented by two digits.
 |
| getMonthAbbreviatedName() | Gets the month element, represented by abbreviated name.
 |
| getMonthFullName() | Gets the month element, represented by full name.
 |
| getYear() | Gets the year element, represented by one, two, three, or four digits.
 |
| getYearTwoDigits() | Gets the year element, represented by two digits.
 |
| getYearFourDigits() | Gets the year element, represented by four digits.
 |
| getDateSeparator() | Gets the date separator element.
 |
##### DateFormatElement()
```
public DateFormatElement()
```

##### getFormat()
```
public abstract String getFormat()
```

Gets the format string.

**Returns:**
java.lang.String - The format string.

##### getSingleFormat()
```
public abstract String getSingleFormat()
```

Gets the single format string.

**Returns:**
java.lang.String - The single format string.

##### toString()
```
public abstract String toString()
```

Returns a String that represents the current  DateFormatElement .

**Returns:**
java.lang.String - A String that represents the current  DateFormatElement .

##### getDayOfMonth()
```
public static DateFormatElement getDayOfMonth()
```

Gets the day of month element, represented by one or two digits.

**Returns:**
DateFormatElement - The day of month element, represented by one or two digits.

##### getDayOfMonthTwoDigits()
```
public static DateFormatElement getDayOfMonthTwoDigits()
```

Gets the day of month element, represented by two digits.

**Returns:**
DateFormatElement - The day of month element, represented by two digits.

##### getMonth()
```
public static DateFormatElement getMonth()
```

Gets the month element, represented by one or two digits.

**Returns:**
DateFormatElement - The month element, represented by one or two digits.

##### getMonthTwoDigits()
```
public static DateFormatElement getMonthTwoDigits()
```

Gets the month element, represented by two digits.

**Returns:**
DateFormatElement - The month element, represented by two digits.

##### getMonthAbbreviatedName()
```
public static DateFormatElement getMonthAbbreviatedName()
```

Gets the month element, represented by abbreviated name.

**Returns:**
DateFormatElement - The month element, represented by abbreviated name.

##### getMonthFullName()
```
public static DateFormatElement getMonthFullName()
```

Gets the month element, represented by full name.

**Returns:**
DateFormatElement - The month element, represented by full name.

##### getYear()
```
public static DateFormatElement getYear()
```

Gets the year element, represented by one, two, three, or four digits.

**Returns:**
DateFormatElement - The year element, represented by one, two, three, or four digits.

##### getYearTwoDigits()
```
public static DateFormatElement getYearTwoDigits()
```

Gets the year element, represented by two digits.

**Returns:**
DateFormatElement - The year element, represented by two digits.

##### getYearFourDigits()
```
public static DateFormatElement getYearFourDigits()
```

Gets the year element, represented by four digits.

**Returns:**
DateFormatElement - The year element, represented by four digits.

##### getDateSeparator()
```
public static DateFormatElement getDateSeparator()
```

Gets the date separator element.

**Returns:**
DateFormatElement - The date separator element.

### DeleteOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/deleteoptions.md

**Inheritance:**
java.lang.Object
```
public class DeleteOptions
```

Provides options for the delete operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| DeleteOptions() | Initializes a new instance of the  DeleteOptions  class.
 |
| DeleteOptions(Object data) | Initializes a new instance of the  DeleteOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCore() |  |
##### DeleteOptions()
```
public DeleteOptions()
```

Initializes a new instance of the  DeleteOptions  class.

##### DeleteOptions(Object data)
```
public DeleteOptions(Object data)
```

Initializes a new instance of the  DeleteOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### EpubFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/epubfieldnames.md

**Inheritance:**
java.lang.Object
```
public class EpubFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| EpubFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Title | The title field name.
 |
| Subject | The subject field name.
 |
| Author | The author field name.
 |
| Description | The description field name.
 |
| Language | The language field name.
 |
| Copyrights | The copyrights field name.
 |
| Publisher | The publisher field name.
 |
| PublishedDate | The published date field name.
 |
##### EpubFieldNames()
```
public EpubFieldNames()
```

##### Title
```
public static final String Title
```

The title field name.

##### Subject
```
public static final String Subject
```

The subject field name.

##### Author
```
public static final String Author
```

The author field name.

##### Description
```
public static final String Description
```

The description field name.

##### Language
```
public static final String Language
```

The language field name.

##### Copyrights
```
public static final String Copyrights
```

The copyrights field name.

##### Publisher
```
public static final String Publisher
```

The publisher field name.

##### PublishedDate
```
public static final String PublishedDate
```

The published date field name.

### ExtractionOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/extractionoptions.md

**Inheritance:**
java.lang.Object
```
public class ExtractionOptions
```

Provides options for extracting data from documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExtractionOptions() | Initializes a new instance of the  ExtractionOptions  class.
 |
| ExtractionOptions(Object data) | Initializes a new instance of the  ExtractionOptions  class.
 |
| ExtractionOptions(IndexingOptions options, IFieldExtractor customExtractor, IOcrConnector ocrConnector) | Initializes a new instance of the  ExtractionOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCustomExtractor() | Gets the custom text extractor.
 |
| setCustomExtractor(IFieldExtractor value) | Sets or sets the custom text extractor.
 |
| getAutoDetectEncoding() | Gets a value indicating whether to detect encoding automatically or not.
 |
| setAutoDetectEncoding(boolean value) | Sets a value indicating whether to detect encoding automatically or not.
 |
| getEncoding() | Gets the encoding used to extract text from text documents.
 |
| setEncoding(String value) | Sets the encoding used to extract text from text documents.
 |
| getUseRawTextExtraction() | Gets a value indicating whether the raw mode is used for text extraction if possible.
 |
| setUseRawTextExtraction(boolean value) | Sets a value indicating whether the raw mode is used for text extraction if possible.
 |
| getMetadataIndexingOptions() | Gets the options for indexing metadata fields.
 |
| getOcrIndexingOptions() | Gets the options for OCR processing and indexing recognized text.
 |
| getImageIndexingOptions() | Gets the image indexing options for reverse image search.
 |
| getCore() |  |
##### ExtractionOptions()
```
public ExtractionOptions()
```

Initializes a new instance of the  ExtractionOptions  class.

##### ExtractionOptions(Object data)
```
public ExtractionOptions(Object data)
```

Initializes a new instance of the  ExtractionOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### ExtractionOptions(IndexingOptions options, IFieldExtractor customExtractor, IOcrConnector ocrConnector)
```
public ExtractionOptions(IndexingOptions options, IFieldExtractor customExtractor, IOcrConnector ocrConnector)
```

Initializes a new instance of the  ExtractionOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | IndexingOptions | The options.
 |
| customExtractor | IFieldExtractor | The custom extractor.
 |
| ocrConnector | IOcrConnector | The ocr connector.
 |

##### getCustomExtractor()
```
public IFieldExtractor getCustomExtractor()
```

Gets the custom text extractor. The default value is  null .

**Returns:**
IFieldExtractor - The custom text extractor.

##### setCustomExtractor(IFieldExtractor value)
```
public void setCustomExtractor(IFieldExtractor value)
```

Sets or sets the custom text extractor. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IFieldExtractor | The custom text extractor.
 |

##### getAutoDetectEncoding()
```
public boolean getAutoDetectEncoding()
```

Gets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Returns:**
boolean - A value indicating whether to detect encoding automatically or not.

##### setAutoDetectEncoding(boolean value)
```
public void setAutoDetectEncoding(boolean value)
```

Sets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to detect encoding automatically or not.
 |

##### getEncoding()
```
public String getEncoding()
```

Gets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Returns:**
java.lang.String - The encoding used to extract text from text documents.

##### setEncoding(String value)
```
public void setEncoding(String value)
```

Sets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The encoding used to extract text from text documents.
 |

##### getUseRawTextExtraction()
```
public boolean getUseRawTextExtraction()
```

Gets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Returns:**
boolean - A value indicating whether the raw mode is used for text extraction if possible.

##### setUseRawTextExtraction(boolean value)
```
public void setUseRawTextExtraction(boolean value)
```

Sets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the raw mode is used for text extraction if possible.
 |

##### getMetadataIndexingOptions()
```
public MetadataIndexingOptions getMetadataIndexingOptions()
```

Gets the options for indexing metadata fields.

**Returns:**
MetadataIndexingOptions - The options for indexing metadata fields.

##### getOcrIndexingOptions()
```
public OcrIndexingOptions getOcrIndexingOptions()
```

Gets the options for OCR processing and indexing recognized text.

**Returns:**
OcrIndexingOptions - The options for OCR processing and indexing recognized text.

##### getImageIndexingOptions()
```
public ImageIndexingOptions getImageIndexingOptions()
```

Gets the image indexing options for reverse image search.

**Returns:**
ImageIndexingOptions - The image indexing options for reverse image search.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### FictionBookFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/fictionbookfieldnames.md

**Inheritance:**
java.lang.Object
```
public class FictionBookFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| FictionBookFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Title | The title field name.
 |
| Subject | The subject field name.
 |
| Keywords | The keywords field name.
 |
| Author | The author field name.
 |
| Description | The description field name.
 |
| Language | The language field name.
 |
| Publisher | The publisher field name.
 |
| PublishedDate | The published date field name.
 |
##### FictionBookFieldNames()
```
public FictionBookFieldNames()
```

##### Title
```
public static final String Title
```

The title field name.

##### Subject
```
public static final String Subject
```

The subject field name.

##### Keywords
```
public static final String Keywords
```

The keywords field name.

##### Author
```
public static final String Author
```

The author field name.

##### Description
```
public static final String Description
```

The description field name.

##### Language
```
public static final String Language
```

The language field name.

##### Publisher
```
public static final String Publisher
```

The publisher field name.

##### PublishedDate
```
public static final String PublishedDate
```

The published date field name.

### FuzzyAlgorithm
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/fuzzyalgorithm.md

**Inheritance:**
java.lang.Object
```
public abstract class FuzzyAlgorithm
```

Represents the base class for fuzzy search algorithms.

#### Methods

| Method | Description |
| --- | --- |
| getSimilarityLevel(int termLength) | Gets the similarity level for the specified term length.
 |
| getMaxMistakeCount(int termLength) | Gets the maximum allowed number of mistakes for the specified term length.
 |
| getCore() |  |
##### getSimilarityLevel(int termLength)
```
public abstract double getSimilarityLevel(int termLength)
```

Gets the similarity level for the specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
double - The similarity level.

##### getMaxMistakeCount(int termLength)
```
public abstract int getMaxMistakeCount(int termLength)
```

Gets the maximum allowed number of mistakes for the specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
int - The maximum allowed number of mistakes.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### FuzzySearchOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/fuzzysearchoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class FuzzySearchOptions
```

Provides options of the fuzzy search.

#### Constructors

| Constructor | Description |
| --- | --- |
| FuzzySearchOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEnabled() | Gets a value indicating whether fuzzy search feature is enabled.
 |
| setEnabled(boolean value) | Sets a value indicating whether fuzzy search feature is enabled.
 |
| getFuzzyAlgorithm() | Gets the fuzzy search algorithm.
 |
| setFuzzyAlgorithm(FuzzyAlgorithm value) | Sets the fuzzy search algorithm.
 |
| getOnlyBestResults() | Gets a value indicating whether only the best results will be returned.
 |
| setOnlyBestResults(boolean value) | Sets a value indicating whether only the best results will be returned.
 |
| getOnlyBestResultsRange() | Gets the maximum exceeding of the minimum number of mistakes that are found.
 |
| setOnlyBestResultsRange(byte value) | Sets the maximum exceeding of the minimum number of mistakes that are found.
 |
| getConsiderTranspositions() | Gets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake.
 |
| setConsiderTranspositions(boolean value) | Sets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake.
 |
##### FuzzySearchOptions()
```
public FuzzySearchOptions()
```

##### getEnabled()
```
public abstract boolean getEnabled()
```

Gets a value indicating whether fuzzy search feature is enabled. The default value is  false .

**Returns:**
boolean - A value indicating whether fuzzy search feature is enabled.

##### setEnabled(boolean value)
```
public abstract void setEnabled(boolean value)
```

Sets a value indicating whether fuzzy search feature is enabled. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether fuzzy search feature is enabled.
 |

##### getFuzzyAlgorithm()
```
public abstract FuzzyAlgorithm getFuzzyAlgorithm()
```

Gets the fuzzy search algorithm. The currently available fuzzy search algorithms are  SimilarityLevel  and  TableDiscreteFunction . The default value is an instance of  SimilarityLevel  with a similarity level value of  0.5 .

**Returns:**
FuzzyAlgorithm - The fuzzy search algorithm.

The example demonstrates how to set the fuzzy search algorithm.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1, new Step(5, 2), new Step(8, 3))); // Creating the fuzzy search algorithm
 // This function specifies 1 as the maximum number of mistakes for words from 1 to 4 characters.
 // It specifies 2 as the maximum number of mistakes for words from 5 to 7 characters.
 // It specifies 3 as the maximum number of mistakes for words from 8 and more characters.
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

##### setFuzzyAlgorithm(FuzzyAlgorithm value)
```
public abstract void setFuzzyAlgorithm(FuzzyAlgorithm value)
```

Sets the fuzzy search algorithm. The currently available fuzzy search algorithms are  SimilarityLevel  and  TableDiscreteFunction . The default value is an instance of  SimilarityLevel  with a similarity level value of  0.5 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FuzzyAlgorithm | The fuzzy search algorithm.

The example demonstrates how to set the fuzzy search algorithm.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1, new Step(5, 2), new Step(8, 3))); // Creating the fuzzy search algorithm
 // This function specifies 1 as the maximum number of mistakes for words from 1 to 4 characters.
 // It specifies 2 as the maximum number of mistakes for words from 5 to 7 characters.
 // It specifies 3 as the maximum number of mistakes for words from 8 and more characters.
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

 |

##### getOnlyBestResults()
```
public abstract boolean getOnlyBestResults()
```

Gets a value indicating whether only the best results will be returned. The default value is  false .

**Returns:**
boolean -  true  if only the best results will be returned; otherwise  false .

##### setOnlyBestResults(boolean value)
```
public abstract void setOnlyBestResults(boolean value)
```

Sets a value indicating whether only the best results will be returned. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if only the best results will be returned; otherwise  false .
 |

##### getOnlyBestResultsRange()
```
public abstract byte getOnlyBestResultsRange()
```

Gets the maximum exceeding of the minimum number of mistakes that are found. The default value is  0 .

**Returns:**
byte - The maximum exceeding of the minimum number of mistakes found.

##### setOnlyBestResultsRange(byte value)
```
public abstract void setOnlyBestResultsRange(byte value)
```

Sets the maximum exceeding of the minimum number of mistakes that are found. The default value is  0 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | The maximum exceeding of the minimum number of mistakes found.
 |

##### getConsiderTranspositions()
```
public abstract boolean getConsiderTranspositions()
```

Gets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake. The default value is  true .

**Returns:**
boolean -  true  if the fuzzy search algorithm considers transpositions; otherwise  false .

##### setConsiderTranspositions(boolean value)
```
public abstract void setConsiderTranspositions(boolean value)
```

Sets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | :  true  if the fuzzy search algorithm considers transpositions; otherwise  false .
 |

### HighlightOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/highlightoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.options.TextOptions

**All Implemented Interfaces:**
com.groupdocs.search.options.IHighlightOptions
```
public class HighlightOptions extends TextOptions implements IHighlightOptions
```

Provides options for highlighting found terms.

#### Constructors

| Constructor | Description |
| --- | --- |
| HighlightOptions() | Initializes a new instance of the  HighlightOptions  class.
 |
| HighlightOptions(Object data) | Initializes a new instance of the  TextOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTermsBefore() | Gets the maximum number of words in a text snippet before highlighted word.
 |
| setTermsBefore(int value) | Sets the maximum number of words in a text snippet before highlighted word.
 |
| getTermsAfter() | Gets the maximum number of words in a text snippet after highlighted word.
 |
| setTermsAfter(int value) | Sets the maximum number of words in a text snippet after highlighted word.
 |
| getTermsTotal() | Gets the maximum number of words in a text snippet.
 |
| setTermsTotal(int value) | Sets the maximum number of words in a text snippet.
 |
| getUseInlineStyles() | Gets a value indicating whether inline styles are used to highlight occurrences.
 |
| setUseInlineStyles(boolean value) | Sets a value indicating whether inline styles are used to highlight occurrences.
 |
| getHighlightColor() | Gets a color that is used to highlight occurrences.
 |
| setHighlightColor(Color value) | Sets a color that is used to highlight occurrences.
 |
| getTermHighlightStartTag() | Gets the start tag of the highlighting of the found word.
 |
| setTermHighlightStartTag(String value) | Sets the start tag of the highlighting of the found word.
 |
| getTermHighlightEndTag() | Gets the end tag of the highlighting of the found word.
 |
| setTermHighlightEndTag(String value) | Sets the end tag of the highlighting of the found word.
 |
##### HighlightOptions()
```
public HighlightOptions()
```

Initializes a new instance of the  HighlightOptions  class.

##### HighlightOptions(Object data)
```
public HighlightOptions(Object data)
```

Initializes a new instance of the  TextOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getTermsBefore()
```
public int getTermsBefore()
```

Gets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is  7 .

**Returns:**
int - The maximum number of words in a text snippet before highlighted word.

##### setTermsBefore(int value)
```
public void setTermsBefore(int value)
```

Sets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is  7 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of words in a text snippet before highlighted word.
 |

##### getTermsAfter()
```
public int getTermsAfter()
```

Gets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is  7 .

**Returns:**
int - The maximum number of words in a text snippet after highlighted word.

##### setTermsAfter(int value)
```
public void setTermsAfter(int value)
```

Sets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is  7 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of words in a text snippet after highlighted word.
 |

##### getTermsTotal()
```
public int getTermsTotal()
```

Gets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is  21 .

**Returns:**
int - The maximum number of words in a text snippet.

##### setTermsTotal(int value)
```
public void setTermsTotal(int value)
```

Sets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is  21 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of words in a text snippet.
 |

##### getUseInlineStyles()
```
public boolean getUseInlineStyles()
```

Gets a value indicating whether inline styles are used to highlight occurrences. The default value is  true .

**Returns:**
boolean - A value indicating whether inline styles are used to highlight occurrences.

##### setUseInlineStyles(boolean value)
```
public void setUseInlineStyles(boolean value)
```

Sets a value indicating whether inline styles are used to highlight occurrences. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether inline styles are used to highlight occurrences.
 |

##### getHighlightColor()
```
public Color getHighlightColor()
```

Gets a color that is used to highlight occurrences. The default value is #FFD800.

**Returns:**
Color - A color that is used to highlight occurrences.

##### setHighlightColor(Color value)
```
public void setHighlightColor(Color value)
```

Sets a color that is used to highlight occurrences. The default value is #FFD800.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | A color that is used to highlight occurrences.
 |

##### getTermHighlightStartTag()
```
public String getTermHighlightStartTag()
```

Gets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

**Returns:**
java.lang.String - The start tag of the highlighting of the found word.

##### setTermHighlightStartTag(String value)
```
public void setTermHighlightStartTag(String value)
```

Sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The start tag of the highlighting of the found word.
 |

##### getTermHighlightEndTag()
```
public String getTermHighlightEndTag()
```

Gets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

**Returns:**
java.lang.String - The end tag of the highlighting of the found word.

##### setTermHighlightEndTag(String value)
```
public void setTermHighlightEndTag(String value)
```

Sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The end tag of the highlighting of the found word.
 |

### ImageIndexingOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/imageindexingoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class ImageIndexingOptions
```

Provides image indexing options for reverse image search.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageIndexingOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEnabledForSeparateImages() | Gets a value indicating whether to index separate image files.
 |
| setEnabledForSeparateImages(boolean value) | Sets a value indicating whether to index separate image files.
 |
| getEnabledForContainerItemImages() | Gets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive).
 |
| setEnabledForContainerItemImages(boolean value) | Sets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive).
 |
| getEnabledForEmbeddedImages() | Gets a value indicating whether to index embedded images (for example, images in a DOCX document).
 |
| setEnabledForEmbeddedImages(boolean value) | Sets a value indicating whether to index embedded images (for example, images in a DOCX document).
 |
##### ImageIndexingOptions()
```
public ImageIndexingOptions()
```

##### getEnabledForSeparateImages()
```
public abstract boolean getEnabledForSeparateImages()
```

Gets a value indicating whether to index separate image files. The default value is  false .

**Returns:**
boolean - A value indicating whether to index separate image files.

##### setEnabledForSeparateImages(boolean value)
```
public abstract void setEnabledForSeparateImages(boolean value)
```

Sets a value indicating whether to index separate image files. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to index separate image files.
 |

##### getEnabledForContainerItemImages()
```
public abstract boolean getEnabledForContainerItemImages()
```

Gets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive). The default value is  false .

**Returns:**
boolean - A value indicating whether to index images that are items in a container.

##### setEnabledForContainerItemImages(boolean value)
```
public abstract void setEnabledForContainerItemImages(boolean value)
```

Sets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive). The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to index images that are items in a container.
 |

##### getEnabledForEmbeddedImages()
```
public abstract boolean getEnabledForEmbeddedImages()
```

Gets a value indicating whether to index embedded images (for example, images in a DOCX document). The default value is  false .

**Returns:**
boolean - A value indicating whether to index embedded images.

##### setEnabledForEmbeddedImages(boolean value)
```
public abstract void setEnabledForEmbeddedImages(boolean value)
```

Sets a value indicating whether to index embedded images (for example, images in a DOCX document). The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to index embedded images.
 |

### ImageLocation
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/imagelocation.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ImageLocation extends Enum<ImageLocation>
```

Specifies an image location.

#### Fields

| Field | Description |
| --- | --- |
| Separate | An image in separate file.
 |
| Embedded | An image embedded in another document.
 |
| ContainerItem | An image that is an element in a container file.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Separate
```
public static final ImageLocation Separate
```

An image in separate file.

##### Embedded
```
public static final ImageLocation Embedded
```

An image embedded in another document.

##### ContainerItem
```
public static final ImageLocation ContainerItem
```

An image that is an element in a container file.

##### values()
```
public static ImageLocation[] values()
```

**Returns:**
com.groupdocs.search.options.ImageLocation[]
##### valueOf(String name)
```
public static ImageLocation valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ImageLocation

### ImageSearchOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/imagesearchoptions.md

**Inheritance:**
java.lang.Object
```
public class ImageSearchOptions
```

Provides options for reverse image search operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSearchOptions() | Initializes a new instance of the  ImageSearchOptions  class.
 |
| ImageSearchOptions(Object data) | Initializes a new instance of the  ImageSearchOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getHashDifferences() | Gets the maximum number of mismatched bits in the image hash.
 |
| setHashDifferences(int value) | Sets the maximum number of mismatched bits in the image hash.
 |
| getMaxResultCount() | Gets the maximum number of found images for an image reverse search request.
 |
| setMaxResultCount(int value) | Sets the maximum number of found images for an image reverse search request.
 |
| getSearchDocumentFilter() | Gets the search document filter.
 |
| setSearchDocumentFilter(ISearchDocumentFilter value) | Gets or sets the search document filter.
 |
| getCore() |  |
##### ImageSearchOptions()
```
public ImageSearchOptions()
```

Initializes a new instance of the  ImageSearchOptions  class.

##### ImageSearchOptions(Object data)
```
public ImageSearchOptions(Object data)
```

Initializes a new instance of the  ImageSearchOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getHashDifferences()
```
public int getHashDifferences()
```

Gets the maximum number of mismatched bits in the image hash. The default value is  5 .

**Returns:**
int - The maximum number of mismatched bits in the image hash.

##### setHashDifferences(int value)
```
public void setHashDifferences(int value)
```

Sets the maximum number of mismatched bits in the image hash. The default value is  5 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of mismatched bits in the image hash.
 |

##### getMaxResultCount()
```
public int getMaxResultCount()
```

Gets the maximum number of found images for an image reverse search request. The default value is  1000 .

**Returns:**
int - The maximum number of found images for an image reverse search request.

##### setMaxResultCount(int value)
```
public void setMaxResultCount(int value)
```

Sets the maximum number of found images for an image reverse search request. The default value is  1000 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of found images for an image reverse search request.
 |

##### getSearchDocumentFilter()
```
public ISearchDocumentFilter getSearchDocumentFilter()
```

Gets the search document filter.  SearchDocumentFilter  works on the inclusion logic. Use  GroupDocs.Search.Options.SearchDocumentFilter  class for creation of a search document filter instances. The default value is  null , which means that all found documents will be returned.

**Returns:**
ISearchDocumentFilter - The search document filter.

##### setSearchDocumentFilter(ISearchDocumentFilter value)
```
public void setSearchDocumentFilter(ISearchDocumentFilter value)
```

Gets or sets the search document filter.  SearchDocumentFilter  works on the inclusion logic. Use  GroupDocs.Search.Options.SearchDocumentFilter  class for creation of a search document filter instances. The default value is  null , which means that all found documents will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ISearchDocumentFilter | The search document filter.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### IndexingOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/indexingoptions.md

**Inheritance:**
java.lang.Object
```
public class IndexingOptions
```

Provides options for indexing operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexingOptions() | Initializes a new instance of the  IndexingOptions  class.
 |
| IndexingOptions(Object data) | Initializes a new instance of the  IndexingOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getThreads() | Gets the number of threads used for indexing.
 |
| setThreads(int value) | Sets the number of threads used for indexing.
 |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCancellation() | Gets the operation cancellation object.
 |
| setCancellation(Cancellation value) | Sets the operation cancellation object.
 |
| getAutoDetectEncoding() | Gets a value indicating whether to detect encoding automatically or not.
 |
| setAutoDetectEncoding(boolean value) | Sets a value indicating whether to detect encoding automatically or not.
 |
| getEncoding() | Gets the encoding used to extract text from text documents.
 |
| setEncoding(String value) | Sets the encoding used to extract text from text documents.
 |
| getUseRawTextExtraction() | Gets a value indicating whether the raw mode is used for text extraction if possible.
 |
| setUseRawTextExtraction(boolean value) | Sets a value indicating whether the raw mode is used for text extraction if possible.
 |
| getMetadataIndexingOptions() | Gets the options for indexing metadata fields.
 |
| getOcrIndexingOptions() | Gets the options for OCR processing and indexing recognized text.
 |
| getImageIndexingOptions() | Gets the image indexing options for reverse image search.
 |
| getCore() |  |
##### IndexingOptions()
```
public IndexingOptions()
```

Initializes a new instance of the  IndexingOptions  class.

##### IndexingOptions(Object data)
```
public IndexingOptions(Object data)
```

Initializes a new instance of the  IndexingOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getThreads()
```
public int getThreads()
```

Gets the number of threads used for indexing. The default value is  1 .

**Returns:**
int - The number of threads used for indexing.

##### setThreads(int value)
```
public void setThreads(int value)
```

Sets the number of threads used for indexing. The default value is  1 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of threads used for indexing.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCancellation()
```
public Cancellation getCancellation()
```

Gets the operation cancellation object. The default value is  null .

**Returns:**
Cancellation - The operation cancellation object.

##### setCancellation(Cancellation value)
```
public void setCancellation(Cancellation value)
```

Sets the operation cancellation object. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cancellation | The operation cancellation object.
 |

##### getAutoDetectEncoding()
```
public boolean getAutoDetectEncoding()
```

Gets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Returns:**
boolean - A value indicating whether to detect encoding automatically or not.

##### setAutoDetectEncoding(boolean value)
```
public void setAutoDetectEncoding(boolean value)
```

Sets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to detect encoding automatically or not.
 |

##### getEncoding()
```
public String getEncoding()
```

Gets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Returns:**
java.lang.String - The encoding used to extract text from text documents.

##### setEncoding(String value)
```
public void setEncoding(String value)
```

Sets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The encoding used to extract text from text documents.
 |

##### getUseRawTextExtraction()
```
public boolean getUseRawTextExtraction()
```

Gets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Returns:**
boolean - A value indicating whether the raw mode is used for text extraction if possible.

##### setUseRawTextExtraction(boolean value)
```
public void setUseRawTextExtraction(boolean value)
```

Sets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the raw mode is used for text extraction if possible.
 |

##### getMetadataIndexingOptions()
```
public MetadataIndexingOptions getMetadataIndexingOptions()
```

Gets the options for indexing metadata fields.

**Returns:**
MetadataIndexingOptions - The options for indexing metadata fields.

##### getOcrIndexingOptions()
```
public OcrIndexingOptions getOcrIndexingOptions()
```

Gets the options for OCR processing and indexing recognized text.

**Returns:**
OcrIndexingOptions - The options for OCR processing and indexing recognized text.

##### getImageIndexingOptions()
```
public ImageIndexingOptions getImageIndexingOptions()
```

Gets the image indexing options for reverse image search.

**Returns:**
ImageIndexingOptions - The image indexing options for reverse image search.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### IndexType
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/indextype.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum IndexType extends Enum<IndexType>
```

Specifies an index type.

#### Fields

| Field | Description |
| --- | --- |
| NormalIndex | Normal index with documents metadata and documents content which supports all search features.
 |
| MetadataIndex | Index that contains only metadata of documents, without content.
 |
| CompactIndex | Index type that takes much less disk space but does not support phrase search and date range search features.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### NormalIndex
```
public static final IndexType NormalIndex
```

Normal index with documents metadata and documents content which supports all search features.

##### MetadataIndex
```
public static final IndexType MetadataIndex
```

Index that contains only metadata of documents, without content.

##### CompactIndex
```
public static final IndexType CompactIndex
```

Index type that takes much less disk space but does not support phrase search and date range search features.

##### values()
```
public static IndexType[] values()
```

**Returns:**
com.groupdocs.search.options.IndexType[]
##### valueOf(String name)
```
public static IndexType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
IndexType

### IOcrConnector
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/iocrconnector.md

### ISearchDocumentFilter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/isearchdocumentfilter.md

### KeyboardLayoutCorrectorOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/keyboardlayoutcorrectoroptions.md

**Inheritance:**
java.lang.Object
```
public abstract class KeyboardLayoutCorrectorOptions
```

Provides options for the keyboard layout corrector.

#### Constructors

| Constructor | Description |
| --- | --- |
| KeyboardLayoutCorrectorOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEnabled() | Gets a value indicating whether the keyboard layout corrector is enabled.
 |
| setEnabled(boolean value) | Sets a value indicating whether the keyboard layout corrector is enabled.
 |
##### KeyboardLayoutCorrectorOptions()
```
public KeyboardLayoutCorrectorOptions()
```

##### getEnabled()
```
public abstract boolean getEnabled()
```

Gets a value indicating whether the keyboard layout corrector is enabled. The default value is  false .

**Returns:**
boolean - A value indicating whether the keyboard layout corrector is enabled.

##### setEnabled(boolean value)
```
public abstract void setEnabled(boolean value)
```

Sets a value indicating whether the keyboard layout corrector is enabled. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the keyboard layout corrector is enabled.
 |

### MailFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/mailfieldnames.md

**Inheritance:**
java.lang.Object
```
public class MailFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| MailFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| MailMessageBody | The mail message body field name.
 |
| MailSenderName | The mail sender name field name.
 |
| MailDisplayTo | The mail display to field name.
 |
| MailSubject | The mail subject field name.
 |
##### MailFieldNames()
```
public MailFieldNames()
```

##### MailMessageBody
```
public static final String MailMessageBody
```

The mail message body field name.

##### MailSenderName
```
public static final String MailSenderName
```

The mail sender name field name.

##### MailDisplayTo
```
public static final String MailDisplayTo
```

The mail display to field name.

##### MailSubject
```
public static final String MailSubject
```

The mail subject field name.

### MergeOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/mergeoptions.md

**Inheritance:**
java.lang.Object
```
public class MergeOptions
```

Provides options for merge operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| MergeOptions() | Initializes a new instance of the  MergeOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCancellation() | Gets the operation cancellation object.
 |
| setCancellation(Cancellation value) | Sets the operation cancellation object.
 |
##### MergeOptions()
```
public MergeOptions()
```

Initializes a new instance of the  MergeOptions  class.

##### isAsync()
```
public final boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public final void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCancellation()
```
public final Cancellation getCancellation()
```

Gets the operation cancellation object. The default value is  null .

**Returns:**
Cancellation - The operation cancellation object.

##### setCancellation(Cancellation value)
```
public final void setCancellation(Cancellation value)
```

Sets the operation cancellation object. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cancellation | The operation cancellation object.
 |

### MetadataIndexingOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/metadataindexingoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class MetadataIndexingOptions
```

Provides options for indexing metadata fields.

#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataIndexingOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getIndexingEmptyValues() | Gets a value indicating whether to index empty field values or not.
 |
| setIndexingEmptyValues(boolean value) | Sets a value indicating whether to index empty field values or not.
 |
| getIndexingEmptyNames() | Gets a value indicating whether to index empty field names or not.
 |
| setIndexingEmptyNames(boolean value) | Sets a value indicating whether to index empty field names or not.
 |
| getDefaultFieldName() | Gets the default field name used to index empty field names.
 |
| setDefaultFieldName(String value) | Sets the default field name used to index empty field names.
 |
| getSeparatorInCompoundName() | Gets the separator in the compound name of a field.
 |
| setSeparatorInCompoundName(String value) | Sets the separator in the compound name of a field.
 |
| getMaxBytesToIndexField() | Gets the maximum number of values in an array of type byte to index the field.
 |
| setMaxBytesToIndexField(int value) | Sets the maximum number of values in an array of type byte to index the field.
 |
| getMaxIntsToIndexField() | Gets the maximum number of values in an array of type int to index the field.
 |
| setMaxIntsToIndexField(int value) | Sets the maximum number of values in an array of type int to index the field.
 |
| getMaxLongsToIndexField() | Gets the maximum number of values in an array of type long to index the field.
 |
| setMaxLongsToIndexField(int value) | Sets the maximum number of values in an array of type long to index the field.
 |
| getMaxDoublesToIndexField() | Gets the maximum number of values in an array of type double to index the field.
 |
| setMaxDoublesToIndexField(int value) | Sets the maximum number of values in an array of type double to index the field.
 |
| getSeparatorBetweenValues() | Gets the separator between values in a field of type array.
 |
| setSeparatorBetweenValues(String value) | Sets the separator between values in a field of type array.
 |
##### MetadataIndexingOptions()
```
public MetadataIndexingOptions()
```

##### getIndexingEmptyValues()
```
public abstract boolean getIndexingEmptyValues()
```

Gets a value indicating whether to index empty field values or not. The default value is  true .

**Returns:**
boolean - A value indicating whether to index empty field values or not.

##### setIndexingEmptyValues(boolean value)
```
public abstract void setIndexingEmptyValues(boolean value)
```

Sets a value indicating whether to index empty field values or not. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to index empty field values or not.
 |

##### getIndexingEmptyNames()
```
public abstract boolean getIndexingEmptyNames()
```

Gets a value indicating whether to index empty field names or not. The default value is  true .

**Returns:**
boolean - A value indicating whether to index empty field names or not.

##### setIndexingEmptyNames(boolean value)
```
public abstract void setIndexingEmptyNames(boolean value)
```

Sets a value indicating whether to index empty field names or not. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to index empty field names or not.
 |

##### getDefaultFieldName()
```
public abstract String getDefaultFieldName()
```

Gets the default field name used to index empty field names. The default value is  "unknown" .

**Returns:**
java.lang.String - The default field name used to index empty field names.

##### setDefaultFieldName(String value)
```
public abstract void setDefaultFieldName(String value)
```

Sets the default field name used to index empty field names. The default value is  "unknown" .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The default field name used to index empty field names.
 |

##### getSeparatorInCompoundName()
```
public abstract String getSeparatorInCompoundName()
```

Gets the separator in the compound name of a field. The default value is  "." .

**Returns:**
java.lang.String - The separator in the compound name of a field.

##### setSeparatorInCompoundName(String value)
```
public abstract void setSeparatorInCompoundName(String value)
```

Sets the separator in the compound name of a field. The default value is  "." .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The separator in the compound name of a field.
 |

##### getMaxBytesToIndexField()
```
public abstract int getMaxBytesToIndexField()
```

Gets the maximum number of values in an array of type byte to index the field. The default value is  Integer.MAX_VALUE .

**Returns:**
int - The maximum number of values in an array of type byte to index the field.

##### setMaxBytesToIndexField(int value)
```
public abstract void setMaxBytesToIndexField(int value)
```

Sets the maximum number of values in an array of type byte to index the field. The default value is  Integer.MAX_VALUE .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of values in an array of type byte to index the field.
 |

##### getMaxIntsToIndexField()
```
public abstract int getMaxIntsToIndexField()
```

Gets the maximum number of values in an array of type int to index the field. The default value is  Integer.MAX_VALUE .

**Returns:**
int - The maximum number of values in an array of type int to index the field.

##### setMaxIntsToIndexField(int value)
```
public abstract void setMaxIntsToIndexField(int value)
```

Sets the maximum number of values in an array of type int to index the field. The default value is  Integer.MAX_VALUE .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of values in an array of type int to index the field.
 |

##### getMaxLongsToIndexField()
```
public abstract int getMaxLongsToIndexField()
```

Gets the maximum number of values in an array of type long to index the field. The default value is  Integer.MAX_VALUE .

**Returns:**
int - The maximum number of values in an array of type long to index the field.

##### setMaxLongsToIndexField(int value)
```
public abstract void setMaxLongsToIndexField(int value)
```

Sets the maximum number of values in an array of type long to index the field. The default value is  Integer.MAX_VALUE .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of values in an array of type long to index the field.
 |

##### getMaxDoublesToIndexField()
```
public abstract int getMaxDoublesToIndexField()
```

Gets the maximum number of values in an array of type double to index the field. The default value is  Integer.MAX_VALUE .

**Returns:**
int - The maximum number of values in an array of type double to index the field.

##### setMaxDoublesToIndexField(int value)
```
public abstract void setMaxDoublesToIndexField(int value)
```

Sets the maximum number of values in an array of type double to index the field. The default value is  Integer.MAX_VALUE .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of values in an array of type double to index the field.
 |

##### getSeparatorBetweenValues()
```
public abstract String getSeparatorBetweenValues()
```

Gets the separator between values in a field of type array. The default value is the space sign.

**Returns:**
java.lang.String - The separator between values in a field of type array.

##### setSeparatorBetweenValues(String value)
```
public abstract void setSeparatorBetweenValues(String value)
```

Sets the separator between values in a field of type array. The default value is the space sign.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The separator between values in a field of type array.
 |

### NumberOfThreads
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/numberofthreads.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum NumberOfThreads extends Enum<NumberOfThreads>
```

Specifies the number of threads.

#### Fields

| Field | Description |
| --- | --- |
| Default | The default value.
 |
| One | One thread.
 |
| Two | Two threads.
 |
| Three | Three threads.
 |
| Four | Four threads.
 |
| Five | Five threads.
 |
| Six | Six threads.
 |
| Seven | Seven threads.
 |
| Eight | Eight threads.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Default
```
public static final NumberOfThreads Default
```

The default value.

##### One
```
public static final NumberOfThreads One
```

One thread.

##### Two
```
public static final NumberOfThreads Two
```

Two threads.

##### Three
```
public static final NumberOfThreads Three
```

Three threads.

##### Four
```
public static final NumberOfThreads Four
```

Four threads.

##### Five
```
public static final NumberOfThreads Five
```

Five threads.

##### Six
```
public static final NumberOfThreads Six
```

Six threads.

##### Seven
```
public static final NumberOfThreads Seven
```

Seven threads.

##### Eight
```
public static final NumberOfThreads Eight
```

Eight threads.

##### values()
```
public static NumberOfThreads[] values()
```

**Returns:**
com.groupdocs.search.options.NumberOfThreads[]
##### valueOf(String name)
```
public static NumberOfThreads valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
NumberOfThreads

### OcrContext
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/ocrcontext.md

**Inheritance:**
java.lang.Object
```
public class OcrContext
```

Represents the OCR processing context.

#### Constructors

| Constructor | Description |
| --- | --- |
| OcrContext(InputStream imageStream, ImageLocation imageLocation, String imageFileExtension) | Initializes a new instance of the
OcrContext
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getImageStream() | Gets the stream containing the image to be processed.
 |
| getImageLocation() | Gets the location of the image.
 |
| getImageFileExtension() | Gets the file extension of the image.
 |
##### OcrContext(InputStream imageStream, ImageLocation imageLocation, String imageFileExtension)
```
public OcrContext(InputStream imageStream, ImageLocation imageLocation, String imageFileExtension)
```

Initializes a new instance of the
OcrContext
 class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | The stream containing the image to be processed.
 |
| imageLocation | ImageLocation | The location of the image.
 |
| imageFileExtension | java.lang.String | The file extension of the image.
 |

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets the stream containing the image to be processed.

**Returns:**
java.io.InputStream - The stream containing the image to be processed.

##### getImageLocation()
```
public final ImageLocation getImageLocation()
```

Gets the location of the image.

**Returns:**
ImageLocation - The location of the image.

##### getImageFileExtension()
```
public final String getImageFileExtension()
```

Gets the file extension of the image.
This value can be used to determine the type of the image.

**Returns:**
java.lang.String - The file extension of the image.

### OcrIndexingOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/ocrindexingoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class OcrIndexingOptions
```

Provides options for OCR processing and indexing recognized text.

#### Constructors

| Constructor | Description |
| --- | --- |
| OcrIndexingOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEnabledForSeparateImages() | Gets a value indicating whether to recognize text in separate image files.
 |
| setEnabledForSeparateImages(boolean value) | Sets a value indicating whether to recognize text in separate image files.
 |
| getEnabledForContainerItemImages() | Gets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive).
 |
| setEnabledForContainerItemImages(boolean value) | Sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive).
 |
| getEnabledForEmbeddedImages() | Gets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document).
 |
| setEnabledForEmbeddedImages(boolean value) | Sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document).
 |
| getOcrConnector() | Gets an OCR connector that is used for OCR processing.
 |
| setOcrConnector(IOcrConnector value) | Sets an OCR connector that is used for OCR processing.
 |
##### OcrIndexingOptions()
```
public OcrIndexingOptions()
```

##### getEnabledForSeparateImages()
```
public abstract boolean getEnabledForSeparateImages()
```

Gets a value indicating whether to recognize text in separate image files. The default value is  false .

**Returns:**
boolean - A value indicating whether to recognize text in separate image files.

##### setEnabledForSeparateImages(boolean value)
```
public abstract void setEnabledForSeparateImages(boolean value)
```

Sets a value indicating whether to recognize text in separate image files. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to recognize text in separate image files.
 |

##### getEnabledForContainerItemImages()
```
public abstract boolean getEnabledForContainerItemImages()
```

Gets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is  false .

**Returns:**
boolean - A value indicating whether to recognize text in images that are items in a container.

##### setEnabledForContainerItemImages(boolean value)
```
public abstract void setEnabledForContainerItemImages(boolean value)
```

Sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to recognize text in images that are items in a container.
 |

##### getEnabledForEmbeddedImages()
```
public abstract boolean getEnabledForEmbeddedImages()
```

Gets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is  false .

**Returns:**
boolean - A value indicating whether to recognize text in embedded images.

##### setEnabledForEmbeddedImages(boolean value)
```
public abstract void setEnabledForEmbeddedImages(boolean value)
```

Sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to recognize text in embedded images.
 |

##### getOcrConnector()
```
public abstract IOcrConnector getOcrConnector()
```

Gets an OCR connector that is used for OCR processing. The default value is  null , which means no OCR is used.

**Returns:**
IOcrConnector - An OCR connector that is used for OCR processing.

##### setOcrConnector(IOcrConnector value)
```
public abstract void setOcrConnector(IOcrConnector value)
```

Sets an OCR connector that is used for OCR processing. The default value is  null , which means no OCR is used.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IOcrConnector | An OCR connector that is used for OCR processing.
 |

### OptimizeOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/optimizeoptions.md

**Inheritance:**
java.lang.Object
```
public class OptimizeOptions
```

Provides options for the optimize operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| OptimizeOptions() | Initializes a new instance of the  OptimizeOptions  class.
 |
| OptimizeOptions(Object data) | Initializes a new instance of the  OptimizeOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCore() |  |
##### OptimizeOptions()
```
public OptimizeOptions()
```

Initializes a new instance of the  OptimizeOptions  class.

##### OptimizeOptions(Object data)
```
public OptimizeOptions(Object data)
```

Initializes a new instance of the  OptimizeOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### OutputFormat
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/outputformat.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum OutputFormat extends Enum<OutputFormat>
```

The output format of a data.

#### Fields

| Field | Description |
| --- | --- |
| Html | The HTML format.
 |
| PlainText | The plain text format.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Html
```
public static final OutputFormat Html
```

The HTML format.

##### PlainText
```
public static final OutputFormat PlainText
```

The plain text format.

##### values()
```
public static OutputFormat[] values()
```

**Returns:**
com.groupdocs.search.options.OutputFormat[]
##### valueOf(String name)
```
public static OutputFormat valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
OutputFormat

### PresentationFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/presentationfieldnames.md

**Inheritance:**
java.lang.Object
```
public class PresentationFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Application | The application field name.
 |
| ApplicationVersion | The application version field name.
 |
| Title | The title field name.
 |
| Subject | The subject field name.
 |
| Comments | The comments field name.
 |
| Keywords | The keywords field name.
 |
| ContentStatus | The content status field name.
 |
| Category | The category field name.
 |
| Manager | The manager field name.
 |
| Author | The author field name.
 |
| LastAuthor | The last author field name.
 |
| Company | The company field name.
 |
| HyperlinkBase | The hyperlink base field name.
 |
| CreatedTime | The created time field name.
 |
| LastSavedTime | The last saved time field name.
 |
| LastPrintedTime | The last printed time field name.
 |
| RevisionNumber | The revision number field name.
 |
| TotalEditingTime | The total editing time field name.
 |
##### PresentationFieldNames()
```
public PresentationFieldNames()
```

##### Application
```
public static final String Application
```

The application field name.

##### ApplicationVersion
```
public static final String ApplicationVersion
```

The application version field name.

##### Title
```
public static final String Title
```

The title field name.

##### Subject
```
public static final String Subject
```

The subject field name.

##### Comments
```
public static final String Comments
```

The comments field name.

##### Keywords
```
public static final String Keywords
```

The keywords field name.

##### ContentStatus
```
public static final String ContentStatus
```

The content status field name.

##### Category
```
public static final String Category
```

The category field name.

##### Manager
```
public static final String Manager
```

The manager field name.

##### Author
```
public static final String Author
```

The author field name.

##### LastAuthor
```
public static final String LastAuthor
```

The last author field name.

##### Company
```
public static final String Company
```

The company field name.

##### HyperlinkBase
```
public static final String HyperlinkBase
```

The hyperlink base field name.

##### CreatedTime
```
public static final String CreatedTime
```

The created time field name.

##### LastSavedTime
```
public static final String LastSavedTime
```

The last saved time field name.

##### LastPrintedTime
```
public static final String LastPrintedTime
```

The last printed time field name.

##### RevisionNumber
```
public static final String RevisionNumber
```

The revision number field name.

##### TotalEditingTime
```
public static final String TotalEditingTime
```

The total editing time field name.

### SearchOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/searchoptions.md

**Inheritance:**
java.lang.Object
```
public class SearchOptions
```

Provides options for search operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchOptions() | Initializes a new instance of the  SearchOptions  class.
 |
| SearchOptions(Object data) | Initializes a new instance of the  SearchOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getUseSynonymSearch() | Gets the flag of use synonyms in search.
 |
| setUseSynonymSearch(boolean value) | Sets the flag of use synonyms in search.
 |
| getUseHomophoneSearch() | Gets the flag of use homophones in search.
 |
| setUseHomophoneSearch(boolean value) | Sets the flag of use homophones in search.
 |
| getUseWordFormsSearch() | Gets the flag of use different word forms in search.
 |
| setUseWordFormsSearch(boolean value) | Sets the flag of use different word forms in search.
 |
| getRetrieveAttributes() | Gets the flag of retrieving attributes associated with found documents.
 |
| setRetrieveAttributes(boolean value) | Sets the flag of retrieving attributes associated with found documents.
 |
| getFuzzySearch() | Gets the fuzzy search options.
 |
| getSpellingCorrector() | Gets the spelling corrector options.
 |
| getKeyboardLayoutCorrector() | Gets the keyboard layout corrector options.
 |
| getUseCaseSensitiveSearch() | Gets the flag of case sensitive search.
 |
| setUseCaseSensitiveSearch(boolean value) | Sets the flag of case sensitive search.
 |
| getMaxTotalOccurrenceCount() | Gets the maximum total number of occurrences of all terms in a search query.
 |
| setMaxTotalOccurrenceCount(int value) | Sets the maximum total number of occurrences of all terms in a search query.
 |
| getMaxOccurrenceCountPerTerm() | Gets the maximum number of occurrences of each term in a search query.
 |
| setMaxOccurrenceCountPerTerm(int value) | Sets the maximum number of occurrences of each term in a search query.
 |
| getDateFormats() | Gets the collection of date formats for date range search.
 |
| isChunkSearch() | Gets the flag of search by chunks.
 |
| setChunkSearch(boolean value) | Sets the flag of search by chunks.
 |
| getSearchDocumentFilter() | Gets the search document filter.
 |
| setSearchDocumentFilter(ISearchDocumentFilter value) | Sets the search document filter.
 |
| getCancellation() | Gets the operation cancellation object.
 |
| setCancellation(Cancellation value) | Sets the operation cancellation object.
 |
| getCore() |  |
##### SearchOptions()
```
public SearchOptions()
```

Initializes a new instance of the  SearchOptions  class.

##### SearchOptions(Object data)
```
public SearchOptions(Object data)
```

Initializes a new instance of the  SearchOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getUseSynonymSearch()
```
public boolean getUseSynonymSearch()
```

Gets the flag of use synonyms in search. The default value is  false .

**Returns:**
boolean - The flag of use synonyms in search.

##### setUseSynonymSearch(boolean value)
```
public void setUseSynonymSearch(boolean value)
```

Sets the flag of use synonyms in search. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of use synonyms in search.
 |

##### getUseHomophoneSearch()
```
public boolean getUseHomophoneSearch()
```

Gets the flag of use homophones in search. The default value is  false .

**Returns:**
boolean - The flag of use homophones in search.

##### setUseHomophoneSearch(boolean value)
```
public void setUseHomophoneSearch(boolean value)
```

Sets the flag of use homophones in search. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of use homophones in search.
 |

##### getUseWordFormsSearch()
```
public boolean getUseWordFormsSearch()
```

Gets the flag of use different word forms in search. The default value is  false .

**Returns:**
boolean - The flag of use different word forms in search.

##### setUseWordFormsSearch(boolean value)
```
public void setUseWordFormsSearch(boolean value)
```

Sets the flag of use different word forms in search. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of use different word forms in search.
 |

##### getRetrieveAttributes()
```
public boolean getRetrieveAttributes()
```

Gets the flag of retrieving attributes associated with found documents. The default value is  false .

**Returns:**
boolean - The flag of retrieving attributes associated with found documents.

##### setRetrieveAttributes(boolean value)
```
public void setRetrieveAttributes(boolean value)
```

Sets the flag of retrieving attributes associated with found documents. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of retrieving attributes associated with found documents.
 |

##### getFuzzySearch()
```
public FuzzySearchOptions getFuzzySearch()
```

Gets the fuzzy search options.

**Returns:**
FuzzySearchOptions - The fuzzy search options.

##### getSpellingCorrector()
```
public SpellingCorrectorOptions getSpellingCorrector()
```

Gets the spelling corrector options.

**Returns:**
SpellingCorrectorOptions - The spelling corrector options.

##### getKeyboardLayoutCorrector()
```
public KeyboardLayoutCorrectorOptions getKeyboardLayoutCorrector()
```

Gets the keyboard layout corrector options.

**Returns:**
KeyboardLayoutCorrectorOptions - The keyboard layout corrector options.

##### getUseCaseSensitiveSearch()
```
public boolean getUseCaseSensitiveSearch()
```

Gets the flag of case sensitive search. The default value is  false .

**Returns:**
boolean - The flag of case sensitive search.

##### setUseCaseSensitiveSearch(boolean value)
```
public void setUseCaseSensitiveSearch(boolean value)
```

Sets the flag of case sensitive search. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of case sensitive search.
 |

##### getMaxTotalOccurrenceCount()
```
public int getMaxTotalOccurrenceCount()
```

Gets the maximum total number of occurrences of all terms in a search query. The default value is  500000 .

**Returns:**
int - The maximum total number of occurrences.

##### setMaxTotalOccurrenceCount(int value)
```
public void setMaxTotalOccurrenceCount(int value)
```

Sets the maximum total number of occurrences of all terms in a search query. The default value is  500000 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum total number of occurrences.
 |

##### getMaxOccurrenceCountPerTerm()
```
public int getMaxOccurrenceCountPerTerm()
```

Gets the maximum number of occurrences of each term in a search query. The default value is  100000 .

**Returns:**
int - The maximum number of occurrences of each term in a search query.

##### setMaxOccurrenceCountPerTerm(int value)
```
public void setMaxOccurrenceCountPerTerm(int value)
```

Sets the maximum number of occurrences of each term in a search query. The default value is  100000 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of occurrences of each term in a search query.
 |

##### getDateFormats()
```
public DateFormatCollection getDateFormats()
```

Gets the collection of date formats for date range search. The default date formats are 'dd.MM.yyyy', 'MM/dd/yyyy', and 'yyyy-MM-dd'.

**Returns:**
DateFormatCollection - The collection of date formats for date range search.

The example demonstrates how to set the date formats for the search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getDateFormats().clear(); // Removing default date formats
 DateFormatElement[] elements = new DateFormatElement[] {
     DateFormatElement.getMonthTwoDigits(),
     DateFormatElement.getDayOfMonthTwoDigits(),
     DateFormatElement.getYearFourDigits(),
 };
 // Creating a date format pattern 'MM/dd/yyyy'
 com.groupdocs.search.DateFormat dateFormat = new com.groupdocs.search.DateFormat(elements, "/");
 options.getDateFormats().addItem(dateFormat);
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

##### isChunkSearch()
```
public boolean isChunkSearch()
```

Gets the flag of search by chunks. The default value is  false .

**Returns:**
boolean - The flag of search by chunks.

##### setChunkSearch(boolean value)
```
public void setChunkSearch(boolean value)
```

Sets the flag of search by chunks. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of search by chunks.
 |

##### getSearchDocumentFilter()
```
public ISearchDocumentFilter getSearchDocumentFilter()
```

Gets the search document filter.  SearchDocumentFilter  works on the inclusion logic. Use  SearchDocumentFilter  class for creation of a search document filter instances. The default value is  null , which means that all found documents will be returned.

**Returns:**
ISearchDocumentFilter - The search document filter.

The example demonstrates how to set the document filter.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments1\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder);
 // Creating a search document filter that skips documents with extensions '.doc', '.docx', '.rtf'
 SearchOptions options = new SearchOptions();
 ISearchDocumentFilter fileExtensionFilter = SearchDocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 ISearchDocumentFilter invertedFilter = SearchDocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 options.setSearchDocumentFilter(invertedFilter);
 // Search in index
 SearchResult result = index.search("Einstein", options);
 
```
 
````

##### setSearchDocumentFilter(ISearchDocumentFilter value)
```
public void setSearchDocumentFilter(ISearchDocumentFilter value)
```

Sets the search document filter.  SearchDocumentFilter  works on the inclusion logic. Use  SearchDocumentFilter  class for creation of a search document filter instances. The default value is  null , which means that all found documents will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ISearchDocumentFilter | The search document filter.

The example demonstrates how to set the document filter.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments1\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder);
 // Creating a search document filter that skips documents with extensions '.doc', '.docx', '.rtf'
 SearchOptions options = new SearchOptions();
 ISearchDocumentFilter fileExtensionFilter = SearchDocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 ISearchDocumentFilter invertedFilter = SearchDocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 options.setSearchDocumentFilter(invertedFilter);
 // Search in index
 SearchResult result = index.search("Einstein", options);
 
```
 
````

 |

##### getCancellation()
```
public Cancellation getCancellation()
```

Gets the operation cancellation object. The default value is  null .

**Returns:**
Cancellation - The operation cancellation object.

##### setCancellation(Cancellation value)
```
public void setCancellation(Cancellation value)
```

Sets the operation cancellation object. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cancellation | The operation cancellation object.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### SimilarityLevel
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/similaritylevel.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.options.FuzzyAlgorithm
```
public class SimilarityLevel extends FuzzyAlgorithm
```

Represents an algorithm of the fuzzy search that specifies the similarity level. The similarity level algorithm calculates the maximum number of mistakes for a word as inversely proportional to the word length.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new SimilarityLevel(0.8)); // Creating the fuzzy search algorithm
 // This function specifies 0 as the maximum number of mistakes for words from 1 to 4 characters.
 // It specifies 1 as the maximum number of mistakes for words from 5 to 9 characters.
 // It specifies 2 as the maximum number of mistakes for words from 10 to 14 characters. And so on.
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| SimilarityLevel(double value) | Initializes a new instance of the  SimilarityLevel  class.
 |
| SimilarityLevel(Object data) | Initializes a new instance of the  SimilarityLevel  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSimilarityLevel(int termLength) | Gets the similarity level value for the specified term length.
 |
| getMaxMistakeCount(int termLength) | Gets the maximum allowed number of mistakes for the specified term length.
 |
##### SimilarityLevel(double value)
```
public SimilarityLevel(double value)
```

Initializes a new instance of the  SimilarityLevel  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The similarity level value.
 |

##### SimilarityLevel(Object data)
```
public SimilarityLevel(Object data)
```

Initializes a new instance of the  SimilarityLevel  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getSimilarityLevel(int termLength)
```
public double getSimilarityLevel(int termLength)
```

Gets the similarity level value for the specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
double - The similarity level value.

##### getMaxMistakeCount(int termLength)
```
public int getMaxMistakeCount(int termLength)
```

Gets the maximum allowed number of mistakes for the specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
int - The maximum allowed number of mistakes.

### SpellingCorrectorOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/spellingcorrectoroptions.md

**Inheritance:**
java.lang.Object
```
public abstract class SpellingCorrectorOptions
```

Provides options for the spelling corrector.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpellingCorrectorOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEnabled() | Gets a value indicating whether the spelling corrector is enabled.
 |
| setEnabled(boolean value) | Sets a value indicating whether the spelling corrector is enabled.
 |
| getMaxMistakeCount() | Gets the maximum number of mistakes.
 |
| setMaxMistakeCount(int value) | Sets the maximum number of mistakes.
 |
| getOnlyBestResults() | Gets a value indicating whether only the best results will be returned.
 |
| setOnlyBestResults(boolean value) | Sets a value indicating whether only the best results will be returned.
 |
| getOnlyBestResultsRange() | Gets the maximum exceeding of the minimum number of mistakes that are found.
 |
| setOnlyBestResultsRange(byte value) | Sets the maximum exceeding of the minimum number of mistakes that are found.
 |
| getConsiderTranspositions() | Gets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake.
 |
| setConsiderTranspositions(boolean value) | Sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake.
 |
##### SpellingCorrectorOptions()
```
public SpellingCorrectorOptions()
```

##### getEnabled()
```
public abstract boolean getEnabled()
```

Gets a value indicating whether the spelling corrector is enabled. The default value is  false .

**Returns:**
boolean - A value indicating whether the spelling corrector is enabled.

##### setEnabled(boolean value)
```
public abstract void setEnabled(boolean value)
```

Sets a value indicating whether the spelling corrector is enabled. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the spelling corrector is enabled.
 |

##### getMaxMistakeCount()
```
public abstract int getMaxMistakeCount()
```

Gets the maximum number of mistakes. The default value is  2 .

**Returns:**
int - The maximum number of mistakes.

##### setMaxMistakeCount(int value)
```
public abstract void setMaxMistakeCount(int value)
```

Sets the maximum number of mistakes. The default value is  2 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of mistakes.
 |

##### getOnlyBestResults()
```
public abstract boolean getOnlyBestResults()
```

Gets a value indicating whether only the best results will be returned. The default value is  false .

**Returns:**
boolean -  true  if only the best results will be returned; otherwise  false .

##### setOnlyBestResults(boolean value)
```
public abstract void setOnlyBestResults(boolean value)
```

Sets a value indicating whether only the best results will be returned. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if only the best results will be returned; otherwise  false .
 |

##### getOnlyBestResultsRange()
```
public abstract byte getOnlyBestResultsRange()
```

Gets the maximum exceeding of the minimum number of mistakes that are found. The default value is  0 .

**Returns:**
byte - The maximum exceeding of the minimum number of mistakes found.

##### setOnlyBestResultsRange(byte value)
```
public abstract void setOnlyBestResultsRange(byte value)
```

Sets the maximum exceeding of the minimum number of mistakes that are found. The default value is  0 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | The maximum exceeding of the minimum number of mistakes found.
 |

##### getConsiderTranspositions()
```
public abstract boolean getConsiderTranspositions()
```

Gets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is  true .

**Returns:**
boolean -  true  if the spelling corrector algorithm considers transpositions; otherwise  false .

##### setConsiderTranspositions(boolean value)
```
public abstract void setConsiderTranspositions(boolean value)
```

Sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if the spelling corrector algorithm considers transpositions; otherwise  false .
 |

### SpreadsheetFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/spreadsheetfieldnames.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Application | The application field name.
 |
| ApplicationVersion | The application version field name.
 |
| Title | The title field name.
 |
| Subject | The subject field name.
 |
| Comments | The comments field name.
 |
| Keywords | The keywords field name.
 |
| ContentStatus | The content status field name.
 |
| Category | The category field name.
 |
| Manager | The manager field name.
 |
| Author | Author field name.
 |
| LastAuthor | The last author field name.
 |
| Company | The company field name.
 |
| HyperlinkBase | The hyperlink base field name.
 |
| CreatedTime | The created time field name.
 |
| LastSavedTime | The last saved time field name.
 |
| LastPrintedTime | The last printed time field name.
 |
##### SpreadsheetFieldNames()
```
public SpreadsheetFieldNames()
```

##### Application
```
public static final String Application
```

The application field name.

##### ApplicationVersion
```
public static final String ApplicationVersion
```

The application version field name.

##### Title
```
public static final String Title
```

The title field name.

##### Subject
```
public static final String Subject
```

The subject field name.

##### Comments
```
public static final String Comments
```

The comments field name.

##### Keywords
```
public static final String Keywords
```

The keywords field name.

##### ContentStatus
```
public static final String ContentStatus
```

The content status field name.

##### Category
```
public static final String Category
```

The category field name.

##### Manager
```
public static final String Manager
```

The manager field name.

##### Author
```
public static final String Author
```

Author field name.

##### LastAuthor
```
public static final String LastAuthor
```

The last author field name.

##### Company
```
public static final String Company
```

The company field name.

##### HyperlinkBase
```
public static final String HyperlinkBase
```

The hyperlink base field name.

##### CreatedTime
```
public static final String CreatedTime
```

The created time field name.

##### LastSavedTime
```
public static final String LastSavedTime
```

The last saved time field name.

##### LastPrintedTime
```
public static final String LastPrintedTime
```

The last printed time field name.

### Step
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/step.md

**Inheritance:**
java.lang.Object
```
public class Step
```

Represents a step of a step function.

#### Constructors

| Constructor | Description |
| --- | --- |
| Step(int lowerLimit, int level) | Initializes a new instance of the  Step  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getLowerLimit() | Gets the lower limit.
 |
| getLevel() | Gets the level.
 |
##### Step(int lowerLimit, int level)
```
public Step(int lowerLimit, int level)
```

Initializes a new instance of the  Step  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerLimit | int | The lower limit.
 |
| level | int | The level.
 |

##### getLowerLimit()
```
public final int getLowerLimit()
```

Gets the lower limit.

**Returns:**
int - The lower limit.

##### getLevel()
```
public final int getLevel()
```

Gets the level.

**Returns:**
int - The level.

### SynchronizeOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/synchronizeoptions.md

**Inheritance:**
java.lang.Object
```
public class SynchronizeOptions
```

Provides options for the synchronize operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| SynchronizeOptions() | Initializes a new instance of the  SynchronizeOptions  class.
 |
| SynchronizeOptions(Object data) | Initializes a new instance of the  SynchronizeOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCore() |  |
##### SynchronizeOptions()
```
public SynchronizeOptions()
```

Initializes a new instance of the  SynchronizeOptions  class.

##### SynchronizeOptions(Object data)
```
public SynchronizeOptions(Object data)
```

Initializes a new instance of the  SynchronizeOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### TableDiscreteFunction
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/tablediscretefunction.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.options.FuzzyAlgorithm
```
public class TableDiscreteFunction extends FuzzyAlgorithm
```

Represents the fuzzy search algorithm that contains correspondences between word lengths and the number of allowed mistakes. This algorithm can be specified by a table of output values or by a step function.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1, new Step(5, 2), new Step(8, 3))); // Creating the fuzzy search algorithm
 // This function specifies 1 as the maximum number of mistakes for words from 1 to 4 characters.
 // It specifies 2 as the maximum number of mistakes for words from 5 to 7 characters.
 // It specifies 3 as the maximum number of mistakes for words from 8 and more characters.
 SearchResult result = index.search(query, options); // Search in index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| TableDiscreteFunction(int offsetOfInputs, int[] tableOfOutputs) | Initializes a new instance of the  TableDiscreteFunction  class.
 |
| TableDiscreteFunction(int firstStepLevel, Step[] steps) | Initializes a new instance of the  TableDiscreteFunction  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSimilarityLevel(int termLength) | Gets a similarity level for specified term length.
 |
| getMaxMistakeCount(int termLength) | Gets a maximum allowed number of mistakes for specified term length.
 |
##### TableDiscreteFunction(int offsetOfInputs, int[] tableOfOutputs)
```
public TableDiscreteFunction(int offsetOfInputs, int[] tableOfOutputs)
```

Initializes a new instance of the  TableDiscreteFunction  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| offsetOfInputs | int | The offset of the table indeces relative to the input values.
 |
| tableOfOutputs | int[] | The table of output values.
 |

##### TableDiscreteFunction(int firstStepLevel, Step[] steps)
```
public TableDiscreteFunction(int firstStepLevel, Step[] steps)
```

Initializes a new instance of the  TableDiscreteFunction  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| firstStepLevel | int | The level of the first step of the step function.
 |
| steps | Step\[\] | The next steps of the step function.
 |

##### getSimilarityLevel(int termLength)
```
public double getSimilarityLevel(int termLength)
```

Gets a similarity level for specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
double - A similarity level.

##### getMaxMistakeCount(int termLength)
```
public int getMaxMistakeCount(int termLength)
```

Gets a maximum allowed number of mistakes for specified term length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| termLength | int | The term length.
 |

**Returns:**
int - A maximum allowed number of mistakes.

### TextOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/textoptions.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.search.options.ITextOptions
```
public class TextOptions implements ITextOptions
```

Provides options for retrieving document text from an index.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextOptions() | Initializes a new instance of the  TextOptions  class.
 |
| TextOptions(Object data) | Initializes a new instance of the  TextOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCustomExtractor() | Gets the custom text extractor that was used for indexing.
 |
| setCustomExtractor(IFieldExtractor value) | Sets the custom text extractor that was used for indexing.
 |
| getAdditionalFields() | Gets the additional document fields that was used for indexing.
 |
| setAdditionalFields(DocumentField[] value) | Sets the additional document fields that was used for indexing.
 |
| getCancellation() | Gets the cancellation object.
 |
| setCancellation(Cancellation value) | Sets the cancellation object.
 |
| getGenerateHead() | Gets a value indicating whether the Head tag is generated in the output HTML.
 |
| setGenerateHead(boolean value) | Sets a value indicating whether the Head tag is generated in the output HTML.
 |
| getUseRawTextExtraction() | Gets a value indicating whether the raw mode is used for text extraction if possible.
 |
| setUseRawTextExtraction(boolean value) | Sets a value indicating whether the raw mode is used for text extraction if possible.
 |
| getMetadataIndexingOptions() | Gets the options for indexing metadata fields.
 |
| getOcrIndexingOptions() | Gets the options for OCR processing and indexing recognized text.
 |
| getImageIndexingOptions() | Gets the image indexing options for reverse image search.
 |
| getCore() |  |
##### TextOptions()
```
public TextOptions()
```

Initializes a new instance of the  TextOptions  class.

##### TextOptions(Object data)
```
public TextOptions(Object data)
```

Initializes a new instance of the  TextOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getCustomExtractor()
```
public IFieldExtractor getCustomExtractor()
```

Gets the custom text extractor that was used for indexing. The default value is  null . Note that this value is used only if document text was not saved into the index.

**Returns:**
IFieldExtractor - The custom text extractor that was used for indexing.

##### setCustomExtractor(IFieldExtractor value)
```
public void setCustomExtractor(IFieldExtractor value)
```

Sets the custom text extractor that was used for indexing. The default value is  null . Note that this value is used only if document text was not saved into the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IFieldExtractor | The custom text extractor that was used for indexing.
 |

##### getAdditionalFields()
```
public DocumentField[] getAdditionalFields()
```

Gets the additional document fields that was used for indexing. The default value is  null . Note that this value is used only if document text was not saved into the index.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The additional document fields that was used for indexing.

##### setAdditionalFields(DocumentField[] value)
```
public void setAdditionalFields(DocumentField[] value)
```

Sets the additional document fields that was used for indexing. The default value is  null . Note that this value is used only if document text was not saved into the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentField\[\] | The additional document fields that was used for indexing.
 |

##### getCancellation()
```
public Cancellation getCancellation()
```

Gets the cancellation object. The default value is  null .

**Returns:**
Cancellation - The cancellation object.

##### setCancellation(Cancellation value)
```
public void setCancellation(Cancellation value)
```

Sets the cancellation object. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cancellation | The cancellation object.
 |

##### getGenerateHead()
```
public boolean getGenerateHead()
```

Gets a value indicating whether the Head tag is generated in the output HTML. The default value is  true .

**Returns:**
boolean - A value indicating whether the Head tag is generated in the output HTML.

##### setGenerateHead(boolean value)
```
public void setGenerateHead(boolean value)
```

Sets a value indicating whether the Head tag is generated in the output HTML. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the Head tag is generated in the output HTML.
 |

##### getUseRawTextExtraction()
```
public boolean getUseRawTextExtraction()
```

Gets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Returns:**
boolean - A value indicating whether the raw mode is used for text extraction if possible.

##### setUseRawTextExtraction(boolean value)
```
public void setUseRawTextExtraction(boolean value)
```

Sets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the raw mode is used for text extraction if possible.
 |

##### getMetadataIndexingOptions()
```
public MetadataIndexingOptions getMetadataIndexingOptions()
```

Gets the options for indexing metadata fields.

**Returns:**
MetadataIndexingOptions - The options for indexing metadata fields.

##### getOcrIndexingOptions()
```
public OcrIndexingOptions getOcrIndexingOptions()
```

Gets the options for OCR processing and indexing recognized text.

**Returns:**
OcrIndexingOptions - The options for OCR processing and indexing recognized text.

##### getImageIndexingOptions()
```
public ImageIndexingOptions getImageIndexingOptions()
```

Gets the image indexing options for reverse image search.

**Returns:**
ImageIndexingOptions - The image indexing options for reverse image search.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### TextStorageSettings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/textstoragesettings.md

**Inheritance:**
java.lang.Object
```
public class TextStorageSettings
```

Represents the text storage settings.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextStorageSettings(Compression compression) | Initializes a new instance of the  TextStorageSettings  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCompression() | Gets the compression of text storage.
 |
| setCompression(Compression value) | Sets the compression of text storage.
 |
##### TextStorageSettings(Compression compression)
```
public TextStorageSettings(Compression compression)
```

Initializes a new instance of the  TextStorageSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| compression | Compression | The compression of text storage.
 |

##### getCompression()
```
public final Compression getCompression()
```

Gets the compression of text storage. The default value is Compression.Normal.

**Returns:**
Compression - The compression of text storage.

##### setCompression(Compression value)
```
public final void setCompression(Compression value)
```

Sets the compression of text storage. The default value is Compression.Normal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Compression | The compression of text storage.
 |

### UpdateOptions
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/updateoptions.md

**Inheritance:**
java.lang.Object
```
public class UpdateOptions
```

Provides options for update operation.

#### Constructors

| Constructor | Description |
| --- | --- |
| UpdateOptions() | Initializes a new instance of the  UpdateOptions  class.
 |
| UpdateOptions(Object data) | Initializes a new instance of the  UpdateOptions  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getThreads() | Gets the number of threads used for indexing.
 |
| setThreads(int value) | Sets the number of threads used for indexing.
 |
| isAsync() | Gets the flag of asynchronous performing the operation.
 |
| setAsync(boolean value) | Sets the flag of asynchronous performing the operation.
 |
| getCancellation() | Gets the operation cancellation object.
 |
| setCancellation(Cancellation value) | Sets the operation cancellation object.
 |
| getAutoDetectEncoding() | Gets a value indicating whether to detect encoding automatically or not.
 |
| setAutoDetectEncoding(boolean value) | Sets a value indicating whether to detect encoding automatically or not.
 |
| getEncoding() | Gets the encoding used to extract text from text documents.
 |
| setEncoding(String value) | Sets the encoding used to extract text from text documents.
 |
| getUseRawTextExtraction() | Gets a value indicating whether the raw mode is used for text extraction if possible.
 |
| setUseRawTextExtraction(boolean value) | Sets a value indicating whether the raw mode is used for text extraction if possible.
 |
| getMetadataIndexingOptions() | Gets the options for indexing metadata fields.
 |
| getOcrIndexingOptions() | Gets the options for OCR processing and indexing recognized text.
 |
| getImageIndexingOptions() | Gets the image indexing options for reverse image search.
 |
| getCore() |  |
##### UpdateOptions()
```
public UpdateOptions()
```

Initializes a new instance of the  UpdateOptions  class.

##### UpdateOptions(Object data)
```
public UpdateOptions(Object data)
```

Initializes a new instance of the  UpdateOptions  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | java.lang.Object | The serialized data.
 |

##### getThreads()
```
public int getThreads()
```

Gets the number of threads used for indexing. The default value is  1 .

**Returns:**
int - The number of threads used for indexing.

##### setThreads(int value)
```
public void setThreads(int value)
```

Sets the number of threads used for indexing. The default value is  1 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The number of threads used for indexing.
 |

##### isAsync()
```
public boolean isAsync()
```

Gets the flag of asynchronous performing the operation. The default value is  false .

**Returns:**
boolean - The flag of asynchronous performing the operation.

##### setAsync(boolean value)
```
public void setAsync(boolean value)
```

Sets the flag of asynchronous performing the operation. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag of asynchronous performing the operation.
 |

##### getCancellation()
```
public Cancellation getCancellation()
```

Gets the operation cancellation object. The default value is  null .

**Returns:**
Cancellation - The operation cancellation object.

##### setCancellation(Cancellation value)
```
public void setCancellation(Cancellation value)
```

Sets the operation cancellation object. The default value is  null .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Cancellation | The operation cancellation object.
 |

##### getAutoDetectEncoding()
```
public boolean getAutoDetectEncoding()
```

Gets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Returns:**
boolean - A value indicating whether to detect encoding automatically or not.

##### setAutoDetectEncoding(boolean value)
```
public void setAutoDetectEncoding(boolean value)
```

Sets a value indicating whether to detect encoding automatically or not. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to detect encoding automatically or not.
 |

##### getEncoding()
```
public String getEncoding()
```

Gets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Returns:**
java.lang.String - The encoding used to extract text from text documents.

##### setEncoding(String value)
```
public void setEncoding(String value)
```

Sets the encoding used to extract text from text documents. The default value is  null , which means that the default encoding UTF-8 is used. If AutoDetectEncoding is  true  then this value is used as the default encoding.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The encoding used to extract text from text documents.
 |

##### getUseRawTextExtraction()
```
public boolean getUseRawTextExtraction()
```

Gets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Returns:**
boolean - A value indicating whether the raw mode is used for text extraction if possible.

##### setUseRawTextExtraction(boolean value)
```
public void setUseRawTextExtraction(boolean value)
```

Sets a value indicating whether the raw mode is used for text extraction if possible. The default value is  true . The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the raw mode is used for text extraction if possible.
 |

##### getMetadataIndexingOptions()
```
public MetadataIndexingOptions getMetadataIndexingOptions()
```

Gets the options for indexing metadata fields.

**Returns:**
MetadataIndexingOptions - The options for indexing metadata fields.

##### getOcrIndexingOptions()
```
public OcrIndexingOptions getOcrIndexingOptions()
```

Gets the options for OCR processing and indexing recognized text.

**Returns:**
OcrIndexingOptions - The options for OCR processing and indexing recognized text.

##### getImageIndexingOptions()
```
public ImageIndexingOptions getImageIndexingOptions()
```

Gets the image indexing options for reverse image search.

**Returns:**
ImageIndexingOptions - The image indexing options for reverse image search.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### WordsFieldNames
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.options/wordsfieldnames.md

**Inheritance:**
java.lang.Object
```
public class WordsFieldNames
```

Represents a list of field names for the faceted search.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordsFieldNames() |  |
#### Fields

| Field | Description |
| --- | --- |
| Application | The application field name.
 |
| ApplicationVersion | The application version field name.
 |
| Template | The template field name.
 |
| Title | The title field name.
 |
| Subject | The subject field name.
 |
| Comments | The comments field name.
 |
| Keywords | The keywords field name.
 |
| ContentStatus | The content status field name.
 |
| Category | The category field name.
 |
| Manager | The manager field name.
 |
| Author | The author field name.
 |
| LastAuthor | The last author field name.
 |
| Company | The company field name.
 |
| HyperlinkBase | The hyperlink base field name.
 |
| CreatedTime | The created time field name.
 |
| LastSavedTime | The last saved time field name.
 |
| LastPrintedTime | The last printed time field name.
 |
| RevisionNumber | The revision number field name.
 |
| TotalEditingTime | The total editing time field name.
 |
##### WordsFieldNames()
```
public WordsFieldNames()
```

##### Application
```
public static final String Application
```

The application field name.

##### ApplicationVersion
```
public static final String ApplicationVersion
```

The application version field name.

##### Template
```
public static final String Template
```

The template field name.

##### Title
```
public static final String Title
```

The title field name.

##### Subject
```
public static final String Subject
```

The subject field name.

##### Comments
```
public static final String Comments
```

The comments field name.

##### Keywords
```
public static final String Keywords
```

The keywords field name.

##### ContentStatus
```
public static final String ContentStatus
```

The content status field name.

##### Category
```
public static final String Category
```

The category field name.

##### Manager
```
public static final String Manager
```

The manager field name.

##### Author
```
public static final String Author
```

The author field name.

##### LastAuthor
```
public static final String LastAuthor
```

The last author field name.

##### Company
```
public static final String Company
```

The company field name.

##### HyperlinkBase
```
public static final String HyperlinkBase
```

The hyperlink base field name.

##### CreatedTime
```
public static final String CreatedTime
```

The created time field name.

##### LastSavedTime
```
public static final String LastSavedTime
```

The last saved time field name.

##### LastPrintedTime
```
public static final String LastPrintedTime
```

The last printed time field name.

##### RevisionNumber
```
public static final String RevisionNumber
```

The revision number field name.

##### TotalEditingTime
```
public static final String TotalEditingTime
```

The total editing time field name.

### com.groupdocs.search.results
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results.md

The package provides search result classes.

#### Classes

| Class | Description |
| --- | --- |
| DeleteResult | Represents the result of the operation to delete indexed files or folders from an index. |
| DocumentInfo | Represents a descriptor for an indexed document. |
| FileType | Represents the file type. |
| FormatFamily | Specifies a format family that unites several similar formats. |
| FoundDocument | Represents a found document. |
| FoundDocumentField | Represents a found document field. |
| FoundImageFrame | Represents a found image frame. |
| ImageSearchResult | Represents the result of a reverse image search. |
| PathDeleteResult | Represents the result of the operation to delete an indexed file or folder from an index. |
| SearchResult | Represents a search result matching a search query. |

### DeleteResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/deleteresult.md

**Inheritance:**
java.lang.Object
```
public class DeleteResult
```

Represents the result of the operation to delete indexed files or folders from an index.

#### Methods

| Method | Description |
| --- | --- |
| getItemResults() | Returns the results of deleting each path.
 |
| getTotalCount() | Returns the total number of paths to delete.
 |
| getSuccessCount() | Returns the number of successfully deleted paths.
 |
| getFailedCount() | Returns the number of paths not deleted due to errors.
 |
| getErrors() | Returns descriptions of deletion errors.
 |
##### getItemResults()
```
public final PathDeleteResult[] getItemResults()
```

Returns the results of deleting each path.

**Returns:**
com.groupdocs.search.results.PathDeleteResult[] - The results of deleting each path.

##### getTotalCount()
```
public final int getTotalCount()
```

Returns the total number of paths to delete.

**Returns:**
int - The total number of paths to delete.

##### getSuccessCount()
```
public final int getSuccessCount()
```

Returns the number of successfully deleted paths.

**Returns:**
int - The number of successfully deleted paths.

##### getFailedCount()
```
public final int getFailedCount()
```

Returns the number of paths not deleted due to errors.

**Returns:**
int - The number of paths not deleted due to errors.

##### getErrors()
```
public final String[] getErrors()
```

Returns descriptions of deletion errors.

**Returns:**
java.lang.String[] - Descriptions of deletion errors.

### DocumentInfo
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/documentinfo.md

**Inheritance:**
java.lang.Object
```
public abstract class DocumentInfo
```

Represents a descriptor for an indexed document.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns a  System.String  that represents the current  DocumentInfo .
 |
| getFilePath() | Gets the file path for indexed from file or the document key for indexed from stream or structure.
 |
| getFileType() | Gets the file type.
 |
| getFormatFamily() | Gets the document format family.
 |
| getInnerPath() | Gets the inner path for the container document item.
 |
| getInnerPathParts() | Gets the inner path parts for the container document item.
 |
| getDocumentSourceKind() | Gets the document source kind.
 |
| getIndexedWithError() | Gets the indicator of indexing error.
 |
| serialize() | Serializes the current instance to a byte array.
 |
| deserialize(byte[] array) | Deserializes an instance from a byte array.
 |
##### DocumentInfo()
```
public DocumentInfo()
```

##### toString()
```
public abstract String toString()
```

Returns a  System.String  that represents the current  DocumentInfo .

**Returns:**
java.lang.String - A  System.String  that represents the current  DocumentInfo .

##### getFilePath()
```
public abstract String getFilePath()
```

Gets the file path for indexed from file or the document key for indexed from stream or structure.

**Returns:**
java.lang.String - The file path or document key.

##### getFileType()
```
public abstract FileType getFileType()
```

Gets the file type.

**Returns:**
FileType - The file type.

##### getFormatFamily()
```
public abstract FormatFamily getFormatFamily()
```

Gets the document format family.

**Returns:**
FormatFamily - The document format family.

##### getInnerPath()
```
public abstract String getInnerPath()
```

Gets the inner path for the container document item.

**Returns:**
java.lang.String - The inner path.

##### getInnerPathParts()
```
public abstract String[] getInnerPathParts()
```

Gets the inner path parts for the container document item.

**Returns:**
java.lang.String[] - The inner path parts.

##### getDocumentSourceKind()
```
public abstract DocumentSourceKind getDocumentSourceKind()
```

Gets the document source kind.

**Returns:**
DocumentSourceKind - The document source kind.

##### getIndexedWithError()
```
public abstract boolean getIndexedWithError()
```

Gets the indicator of indexing error.

**Returns:**
boolean - The indicator of indexing error.

##### serialize()
```
public abstract byte[] serialize()
```

Serializes the current instance to a byte array.

**Returns:**
byte[] - A byte array representing the current instance.

##### deserialize(byte[] array)
```
public static DocumentInfo deserialize(byte[] array)
```

Deserializes an instance from a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | byte[] | A byte array to deserialize from.
 |

**Returns:**
DocumentInfo - An instance deserialized from a byte array.

### FileType
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/filetype.md

**Inheritance:**
java.lang.Object
```
public class FileType
```

Represents the file type.

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type.
 |
| FB2 | Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
 |
| TXT | A file with .TXT extension represents a text document that contains plain text in the form of lines.
 |
| LOG | A file with .LOG extension is typically a text document containing plain text in the form of lines.
 |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for
displaying as SlideShow.
 |
| 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.
 |
| 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.
 |
| POT | Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions.
 |
| 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.
 |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing
documents in binary file format.
 |
| DOCX | DOCX is a well-known format for Microsoft Word documents.
 |
| XLSX | XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release
of Microsoft Office 2007.
 |
| PPSX | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for
Slide Show purpose.
 |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
 |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML
file format specifications.
 |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings
for generation of further DOCX files.
 |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with
Microsoft PowerPoint 2007 and above.
 |
| XLS | Files with XLS extension represent Excel Binary File Format.
 |
| 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.
 |
| ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
 |
| OTS | Represents OpenDocument Spreadsheet Template file format.
 |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose.
 |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s.
 |
| RTF | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding
formatted text and graphics for use within applications.
 |
| XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros.
 |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft
PowerPoint 2007 or higher.
 |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled
template files.
 |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
 |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with
Microsoft PowerPoint 2007 or higher versions.
 |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
 |
| XLSB | XLSB file format specifies the Excel Binary File Format, which is a collection of records and
structures that specify Excel workbook content.
 |
| EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers.
 |
| ODP | Files with ODP extension represent presentation file format used by OpenOffice.org in the OASIS Open standard.
 |
| ONE | File represented by .ONE extension are created by Microsoft OneNote application.
 |
| ZIP | ZIP file extension represents archives that can hold one or more files or directories.
 |
| CHM | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
 |
| 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.
 |
| MD | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension.
 |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros.
 |
| CSV | Files with CSV (Comma Separated Values) extension represent plain text files that contain records of data with comma separated values.
 |
| XML | XML stands for Extensible Markup Language that is similar to HTML but different in using tags for defining objects.
 |
| TSV | A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
 |
| HTM | Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers.
 |
| HTML | HTML (Hyper Text Markup Language) is the extension for web pages created for display in web browsers.
 |
| XHTML | The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0.
 |
| MHT | Files with MHT 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.
 |
| 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.
 |
| 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.
 |
| BMP | Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images.
 |
| 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.
 |
| DJV | DjVu is a graphics file format intended for scanned documents and books especially those which contain
the combination of text, drawings, images and photographs.
 |
| GIF | A GIF or Graphical Interchange Format is a type of highly compressed image.
 |
| JPG | A JPEG is a type of image format that is saved using the method of lossy compression.
 |
| JPE | A JPEG 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.
 |
| JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
 |
| PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
 |
| TIFF | TIFF or 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.
 |
| TIF | TIFF or 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.
 |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and
lossy compression.
 |
| EMF | Enhanced metafile format (EMF) stores graphical images device-independently.
 |
| WMF | Files with WMF extension represent Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data.
 |
| PSD | PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development.
 |
| MPP | MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software.
 |
| TORRENT | Represents TORRENT file type.
 |
| VSD | VSD files are drawings created with Microsoft Visio application to represent variety of graphical
objects and the interconnection between these.
 |
| VSS | VSS are stencil files created with Microsoft Visio 2007 and earlier.
 |
| DCM | Files with .DCM extension represent digital image which stores medical information of patients
such as MRIs, CT scans and ultrasound images.
 |
| DC3 | Represents DC3 file type.
 |
| DIC | Represents DIC file type.
 |
| DICOM | Represents DICOM file type.
 |
| AVI | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft.
 |
| MOV | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks,
each track holds a particular type of data i.e.
 |
| QT | MOV or QuickTime File format is multimedia container which is developed by Apple: contains one or more tracks,
each track holds a particular type of data i.e.
 |
| FLV | Represents FLV file type.
 |
| ASF | The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams.
 |
| XLA | Represents XLA file type.
 |
| XLAM | Represents XLAM file type.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDescription() | Gets the file type description.
 |
| getExtension() | Gets the file extension.
 |
| getFormatFamily() | Gets the format family.
 |
| toString() | Returns a String that represents the current
FileType
.
 |
| getSupportedFileTypes() | Retrieves supported file types.
 |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### FB2
```
public static final FileType FB2
```

Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook.
It is based on XML format and contains special tags for describing each element of the book.
Learn more about this file format
here.

##### TXT
```
public static final FileType 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.

##### LOG
```
public static final FileType LOG
```

A file with .LOG extension is typically a text document containing plain text in the form of lines.

##### PPT
```
public static final FileType 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.

##### ODT
```
public static final FileType ODT
```

ODT files are type of documents created with word processing applications that are based on OpenDocument
Text File format. These are created with word processor applications such as free OpenOffice Writer and
can hold content such as text, images, objects and styles.
Learn more about this file format
here.

##### OTT
```
public static final FileType OTT
```

Files with OTT extension represent template documents generated by applications in compliance with
the OASIS' OpenDocument standard format. These are created with word processor applications such as
free OpenOffice Writer and can hold settings that can be used to generate new documents from these template files.
Learn more about this file format
here.

##### DOT
```
public static final FileType 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.

##### POT
```
public static final FileType POT
```

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions.
Learn more about this file format
here.

##### PST
```
public static final FileType 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 FileType 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.

##### DOC
```
public static final FileType 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.

##### DOCX
```
public static final FileType 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.

##### XLSX
```
public static final FileType 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.

##### PPSX
```
public static final FileType 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.

##### PPTX
```
public static final FileType 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.

##### XLTX
```
public static final FileType XLTX
```

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML
file format specifications. Learn more about this file format
here.

##### DOTX
```
public static final FileType 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.

##### POTX
```
public static final FileType 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.

##### XLS
```
public static final FileType XLS
```

Files with XLS extension represent 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.

##### XLT
```
public static final FileType 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.
Learn more about this file format
here.

##### ODS
```
public static final FileType ODS
```

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user.
Learn more about this file format
here.

##### OTS
```
public static final FileType OTS
```

Represents OpenDocument Spreadsheet Template file format.
Learn more about spreadsheet file formats
here.

##### PPS
```
public static final FileType 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.

##### PDF
```
public static final FileType 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.

##### RTF
```
public static final FileType RTF
```

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding
formatted text and graphics for use within applications. The format facilitates cross-platform document
exchange with other Microsoft Products, thus serving the purpose of interoperability.
Learn more about this file format
here.

##### XLSM
```
public static final FileType XLSM
```

Files with XLSM extension is a type of Spreasheet files that support Macros.
Learn more about this file format
here.

##### PPSM
```
public static final FileType 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.

##### XLTM
```
public static final FileType XLTM
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled
template files.
Learn more about this file format
here.

##### DOTM
```
public static final FileType DOTM
```

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
Learn more about this file format
here.

##### PPTM
```
public static final FileType 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.

##### DOCM
```
public static final FileType DOCM
```

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
Learn more about this file format
here.

##### XLSB
```
public static final FileType 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.

##### EPUB
```
public static final FileType EPUB
```

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers.
Learn more about this file format
here.

##### ODP
```
public static final FileType ODP
```

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASIS Open standard.
Learn more about this file format
here.

##### ONE
```
public static final FileType ONE
```

File represented by .ONE extension are created by Microsoft OneNote application.
Learn more about this file format
here.

##### ZIP
```
public static final FileType ZIP
```

ZIP file extension represents archives that can hold one or more files or directories.
Learn more about this file format
here.

##### CHM
```
public static final FileType CHM
```

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages.
Learn more about this file format
here.

##### EML
```
public static final FileType EML
```

EML file format represents email messages saved using Outlook and other relevant applications.
Learn more about this file format
here.

##### EMLX
```
public static final FileType 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.

##### MSG
```
public static final FileType 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.

##### MD
```
public static final FileType MD
```

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension.
Learn more about this file format
here.

##### POTM
```
public static final FileType 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.

##### CSV
```
public static final FileType 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.

##### XML
```
public static final FileType 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.

##### TSV
```
public static final FileType TSV
```

A Tab-Separated Values (TSV) file format represents data separated with tabs in plain text format.
Learn more about this file format
here.

##### HTM
```
public static final FileType HTM
```

Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers.
Learn more about this file format
here.

##### HTML
```
public static final FileType HTML
```

HTML (Hyper Text Markup Language) is the extension for web pages created for display in web browsers.
Learn more about this file format
here.

##### XHTML
```
public static final FileType XHTML
```

The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0.
Learn more about this file format
here.

##### MHT
```
public static final FileType MHT
```

Files with MHT extension represent a web page archive format that can be created by a number of different applications.
Learn more about this file format
here.

##### MHTML
```
public static final FileType MHTML
```

Files with MHTML extension represent a web page archive format that can be created by a number of different applications.
Learn more about this file format
here.

##### MP3
```
public static final FileType 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.

##### WAV
```
public static final FileType 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.

##### BMP
```
public static final FileType BMP
```

Files having extension .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.

##### DJVU
```
public static final FileType 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.

##### DJV
```
public static final FileType DJV
```

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.

##### GIF
```
public static final FileType GIF
```

A GIF or Graphical Interchange Format is a type of highly compressed image.
Learn more about this file format
here.

##### JPG
```
public static final FileType JPG
```

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format
here.

##### JPE
```
public static final FileType JPE
```

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format
here.

##### JPEG
```
public static final FileType JPEG
```

A JPEG is a type of image format that is saved using the method of lossy compression.
Learn more about this file format
here.

##### JP2
```
public static final FileType JP2
```

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard.
Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once.
Learn more about this file format
here.

##### PNG
```
public static final FileType PNG
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
Learn more about this file format
here.

##### TIFF
```
public static final FileType TIFF
```

TIFF or 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.
Learn more about this file format
here.

##### TIF
```
public static final FileType TIF
```

TIFF or 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.
Learn more about this file format
here.

##### WEBP
```
public static final FileType 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.

##### EMF
```
public static final FileType EMF
```

Enhanced metafile format (EMF) stores graphical images device-independently.
Learn more about this file format
here.

##### WMF
```
public static final FileType 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.

##### PSD
```
public static final FileType PSD
```

PSD, Photoshop Document, represents Adobe Photoshop's native file format used for graphics designing and development.
Learn more about this file format
here.

##### MPP
```
public static final FileType MPP
```

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software.
Learn more about this file format
here.

##### TORRENT
```
public static final FileType TORRENT
```

Represents TORRENT file type.

##### VSD
```
public static final FileType 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.

##### VSS
```
public static final FileType 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.

##### DCM
```
public static final FileType 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.

##### DC3
```
public static final FileType DC3
```

Represents DC3 file type.

##### DIC
```
public static final FileType DIC
```

Represents DIC file type.

##### DICOM
```
public static final FileType DICOM
```

Represents DICOM file type.

##### AVI
```
public static final FileType AVI
```

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft.
Learn more about this file format
here.

##### MOV
```
public static final FileType MOV
```

MOV or QuickTime File format is 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.

##### QT
```
public static final FileType QT
```

MOV or QuickTime File format is 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.

##### FLV
```
public static final FileType FLV
```

Represents FLV file type.

##### ASF
```
public static final FileType ASF
```

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams.
Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA)
is the compressed audio format along with additional metadata in the ASF container developed by Microsoft.
Learn more about this file format
here.

##### XLA
```
public static final FileType XLA
```

Represents XLA file type.

##### XLAM
```
public static final FileType XLAM
```

Represents XLAM file type.

##### getDescription()
```
public final String getDescription()
```

Gets the file type description.

**Returns:**
java.lang.String - The file type description.

##### getExtension()
```
public final String getExtension()
```

Gets the file extension.

**Returns:**
java.lang.String - The file extension.

##### getFormatFamily()
```
public final FormatFamily getFormatFamily()
```

Gets the format family.

**Returns:**
FormatFamily - The format family.

##### toString()
```
public String toString()
```

Returns a String that represents the current
FileType
.

**Returns:**
java.lang.String - A String that represents the current  FileType .

##### getSupportedFileTypes()
```
public static Iterable<FileType> getSupportedFileTypes()
```

Retrieves supported file types.

**Returns:**
java.lang.Iterable<com.groupdocs.search.results.FileType> - A collection of supported file types.

### FormatFamily
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/formatfamily.md

**Inheritance:**
java.lang.Object
```
public class FormatFamily
```

Specifies a format family that unites several similar formats.

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown format family.
 |
| WordProcessing | Represents word processing formats.
 |
| Spreadsheet | Represents spreadsheet formats.
 |
| Presentation | Represents presentation formats.
 |
| ProjectManagement | Represents project management formats.
 |
| Note | Represents note formats.
 |
| Diagram | Represents diagram formats.
 |
| Email | Represents electronic mail formats.
 |
| Archive | Represents archive formats.
 |
| Pdf | Represents portable document formats.
 |
| Ebook | Represents electronic book formats.
 |
| Database | Represents database formats.
 |
| Markup | Represents markup formats.
 |
| Audio | Represents audio formats.
 |
| Video | Represents video formats.
 |
| Image | Represents image formats.
 |
| ScientificFormat | Represents scientific formats.
 |
| SourceCode | Represents source code formats.
 |
| Executable | Represents executable formats.
 |
| Cad | Represents computer-aided design formats.
 |
| Font | Represents font formats.
 |
| Calendar | Represents calendar formats.
 |
| Torrent | Represents torrent formats.
 |
| Medicine | Represents medicine formats.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the format family name.
 |
| toString() | Returns a String that represents the current
FormatFamily
.
 |
##### Unknown
```
public static final FormatFamily Unknown
```

Represents unknown format family.

##### WordProcessing
```
public static final FormatFamily WordProcessing
```

Represents word processing formats.

##### Spreadsheet
```
public static final FormatFamily Spreadsheet
```

Represents spreadsheet formats.

##### Presentation
```
public static final FormatFamily Presentation
```

Represents presentation formats.

##### ProjectManagement
```
public static final FormatFamily ProjectManagement
```

Represents project management formats.

##### Note
```
public static final FormatFamily Note
```

Represents note formats.

##### Diagram
```
public static final FormatFamily Diagram
```

Represents diagram formats.

##### Email
```
public static final FormatFamily Email
```

Represents electronic mail formats.

##### Archive
```
public static final FormatFamily Archive
```

Represents archive formats.

##### Pdf
```
public static final FormatFamily Pdf
```

Represents portable document formats.

##### Ebook
```
public static final FormatFamily Ebook
```

Represents electronic book formats.

##### Database
```
public static final FormatFamily Database
```

Represents database formats.

##### Markup
```
public static final FormatFamily Markup
```

Represents markup formats.

##### Audio
```
public static final FormatFamily Audio
```

Represents audio formats.

##### Video
```
public static final FormatFamily Video
```

Represents video formats.

##### Image
```
public static final FormatFamily Image
```

Represents image formats.

##### ScientificFormat
```
public static final FormatFamily ScientificFormat
```

Represents scientific formats.

##### SourceCode
```
public static final FormatFamily SourceCode
```

Represents source code formats.

##### Executable
```
public static final FormatFamily Executable
```

Represents executable formats.

##### Cad
```
public static final FormatFamily Cad
```

Represents computer-aided design formats.

##### Font
```
public static final FormatFamily Font
```

Represents font formats.

##### Calendar
```
public static final FormatFamily Calendar
```

Represents calendar formats.

##### Torrent
```
public static final FormatFamily Torrent
```

Represents torrent formats.

##### Medicine
```
public static final FormatFamily Medicine
```

Represents medicine formats.

##### getName()
```
public final String getName()
```

Gets the format family name.

**Returns:**
java.lang.String - The format family name.

##### toString()
```
public String toString()
```

Returns a String that represents the current
FormatFamily
.

**Returns:**
java.lang.String - A String that represents the current  FormatFamily .

### FoundDocument
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/founddocument.md

**Inheritance:**
java.lang.Object
```
public abstract class FoundDocument
```

Represents a found document.

#### Constructors

| Constructor | Description |
| --- | --- |
| FoundDocument() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentInfo() | Gets the document info.
 |
| getRelevance() | Gets the relevance of search result.
 |
| getOccurrenceCount() | Gets the number of occurrences found.
 |
| getFoundFields() | Gets the document fields found.
 |
| getTerms() | Gets the terms found.
 |
| getTermSequences() | Gets the term sequences found.
 |
| getAttributes() | Gets the attributes associated with the found document.
 |
| toString() | Returns string representation of the found document.
 |
| serialize() | Serializes the current instance to a byte array.
 |
| deserialize(byte[] array) | Deserializes an instance from a byte array.
 |
##### FoundDocument()
```
public FoundDocument()
```

##### getDocumentInfo()
```
public abstract DocumentInfo getDocumentInfo()
```

Gets the document info.

**Returns:**
DocumentInfo - The document info.

##### getRelevance()
```
public abstract double getRelevance()
```

Gets the relevance of search result.

**Returns:**
double - The relevance of search result.

##### getOccurrenceCount()
```
public abstract int getOccurrenceCount()
```

Gets the number of occurrences found.

**Returns:**
int - The number of occurrences found.

##### getFoundFields()
```
public abstract FoundDocumentField[] getFoundFields()
```

Gets the document fields found.

**Returns:**
com.groupdocs.search.results.FoundDocumentField[] - The document fields found.

##### getTerms()
```
public abstract String[] getTerms()
```

Gets the terms found. The value is evaluated each time the property is accessed.

**Returns:**
java.lang.String[] - The terms found.

##### getTermSequences()
```
public abstract String[][] getTermSequences()
```

Gets the term sequences found.

**Returns:**
java.lang.String[][] - The term sequences found.

##### getAttributes()
```
public abstract String[] getAttributes()
```

Gets the attributes associated with the found document. The corresponding option must be enabled in the search options to retrieve attributes.

**Returns:**
java.lang.String[] - The attributes associated with the found document.

##### toString()
```
public abstract String toString()
```

Returns string representation of the found document.

**Returns:**
java.lang.String - A string that represents the found document.

##### serialize()
```
public abstract byte[] serialize()
```

Serializes the current instance to a byte array.

**Returns:**
byte[] - A byte array representing the current instance.

##### deserialize(byte[] array)
```
public static FoundDocument deserialize(byte[] array)
```

Deserializes an instance from a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | byte[] | A byte array to deserialize from.
 |

**Returns:**
FoundDocument - An instance deserialized from a byte array.

### FoundDocumentField
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/founddocumentfield.md

**Inheritance:**
java.lang.Object
```
public abstract class FoundDocumentField
```

Represents a found document field.

#### Constructors

| Constructor | Description |
| --- | --- |
| FoundDocumentField() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFieldName() | Gets the field name.
 |
| getOccurrenceCount() | Gets the number of occurrences found.
 |
| getTerms() | Gets the terms found.
 |
| getTermsOccurrences() | Gets the occurrences of the found terms.
 |
| getTermSequences() | Gets the term sequences found.
 |
| getTermSequencesOccurrences() | Gets the occurrences of the found term sequences.
 |
| toString() | Returns string representation of the found document field.
 |
| serialize() | Serializes the current instance to a byte array.
 |
| deserialize(byte[] array) | Deserializes an instance from a byte array.
 |
##### FoundDocumentField()
```
public FoundDocumentField()
```

##### getFieldName()
```
public abstract String getFieldName()
```

Gets the field name.

**Returns:**
java.lang.String - The field name.

##### getOccurrenceCount()
```
public abstract int getOccurrenceCount()
```

Gets the number of occurrences found.

**Returns:**
int - The number of occurrences found.

##### getTerms()
```
public abstract String[] getTerms()
```

Gets the terms found.

**Returns:**
java.lang.String[] - The terms found.

##### getTermsOccurrences()
```
public abstract int[] getTermsOccurrences()
```

Gets the occurrences of the found terms.

**Returns:**
int[] - The occurrences of the found terms.

##### getTermSequences()
```
public abstract String[][] getTermSequences()
```

Gets the term sequences found.

**Returns:**
java.lang.String[][] - The term sequences found.

##### getTermSequencesOccurrences()
```
public abstract int[] getTermSequencesOccurrences()
```

Gets the occurrences of the found term sequences.

**Returns:**
int[] - The occurrences of the found term sequences.

##### toString()
```
public abstract String toString()
```

Returns string representation of the found document field.

**Returns:**
java.lang.String - A string that represents the found document field.

##### serialize()
```
public abstract byte[] serialize()
```

Serializes the current instance to a byte array.

**Returns:**
byte[] - A byte array representing the current instance.

##### deserialize(byte[] array)
```
public static FoundDocumentField deserialize(byte[] array)
```

Deserializes an instance from a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | byte[] | A byte array to deserialize from.
 |

**Returns:**
FoundDocumentField - An instance deserialized from a byte array.

### FoundImageFrame
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/foundimageframe.md

**Inheritance:**
java.lang.Object
```
public abstract class FoundImageFrame
```

Represents a found image frame.

#### Constructors

| Constructor | Description |
| --- | --- |
| FoundImageFrame() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentInfo() | Gets the document info.
 |
| getImageIndex() | Gets the ordinal number of the image in the document.
 |
| getFrameIndex() | Gets the index of the frame in the image.
 |
| getHashDifferences() | Gets the number of mismatched bits in the image hash.
 |
| toString() | Returns a  System.String  that represents the current  FoundImageFrame .
 |
##### FoundImageFrame()
```
public FoundImageFrame()
```

##### getDocumentInfo()
```
public abstract DocumentInfo getDocumentInfo()
```

Gets the document info.

**Returns:**
DocumentInfo - The document info.

##### getImageIndex()
```
public abstract int getImageIndex()
```

Gets the ordinal number of the image in the document.

**Returns:**
int - The ordinal number of the image in the document.

##### getFrameIndex()
```
public abstract int getFrameIndex()
```

Gets the index of the frame in the image.

**Returns:**
int - The index of the frame in the image.

##### getHashDifferences()
```
public abstract int getHashDifferences()
```

Gets the number of mismatched bits in the image hash.

**Returns:**
int - The number of mismatched bits in the image hash.

##### toString()
```
public abstract String toString()
```

Returns a  System.String  that represents the current  FoundImageFrame .

**Returns:**
java.lang.String - A  System.String  that represents the current  FoundImageFrame .

### ImageSearchResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/imagesearchresult.md

**Inheritance:**
java.lang.Object
```
public abstract class ImageSearchResult
```

Represents the result of a reverse image search.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSearchResult() |  |
#### Methods

| Method | Description |
| --- | --- |
| getImageCount() | Gets the number of images found.
 |
| getFoundImage(int index) | Gets the found image by index.
 |
##### ImageSearchResult()
```
public ImageSearchResult()
```

##### getImageCount()
```
public abstract int getImageCount()
```

Gets the number of images found.

**Returns:**
int - The number of images found.

##### getFoundImage(int index)
```
public abstract FoundImageFrame getFoundImage(int index)
```

Gets the found image by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of a found image.
 |

**Returns:**
FoundImageFrame - The found image.

### PathDeleteResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/pathdeleteresult.md

**Inheritance:**
java.lang.Object
```
public class PathDeleteResult
```

Represents the result of the operation to delete an indexed file or folder from an index.

#### Methods

| Method | Description |
| --- | --- |
| isSuccess() | Returns the success indicator of the delete operation.
 |
| getError() | Returns a description of deletion error.
 |
| getPath() | Returns the path to the file or folder to delete.
 |
##### isSuccess()
```
public final boolean isSuccess()
```

Returns the success indicator of the delete operation.

**Returns:**
boolean -  true  if the delete operation was successful; otherwise, returns  false .

##### getError()
```
public final String getError()
```

Returns a description of deletion error.

**Returns:**
java.lang.String - A description of deletion error.

##### getPath()
```
public final String getPath()
```

Returns the path to the file or folder to delete.

**Returns:**
java.lang.String - The path to the file or folder to delete.

### SearchResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.results/searchresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class SearchResult implements Iterable<FoundDocument>
```

Represents a search result matching a search query.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentFolder);
 // Setting search options
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(3)); // Setting the maximum number of differences to 3
 // Search for documents containing the word 'Einstein' or the phrase 'Theory of Relativity'
 SearchResult result = index.search("Einstein OR \"Theory of Relativity\"", options);
 // Printing the result
 System.out.println("Documents: " + result.getDocumentCount());
 System.out.println("Total occurrences: " + result.getOccurrenceCount());
 for (int i = 0; i < result.getDocumentCount(); i++) {
     FoundDocument document = result.getFoundDocument(i);
     System.out.println("\tDocument: " + document.getDocumentInfo().getFilePath());
     System.out.println("\tOccurrences: " + document.getOccurrenceCount());
     for (int j = 0; j < document.getFoundFields().length; j++) {
         FoundDocumentField field = document.getFoundFields()[j];
         System.out.println("\t\tField: " + field.getFieldName());
         System.out.println("\t\tOccurrences: " + document.getOccurrenceCount());
         // Printing found terms
         if (field.getTerms() != null) {
             for (int k = 0; k < field.getTerms().length; k++) {
                 System.out.println("\t\t\t" + field.getTerms()[k] + " - " + field.getTermsOccurrences()[k]);
             }
         }
         // Printing found phrases
         if (field.getTermSequences() != null) {
             for (int k = 0; k < field.getTermSequences().length; k++) {
                 String[] terms = field.getTermSequences()[k];
                 String sequence = "";
                 for (int m = 0; m < terms.length; m++) {
                     sequence += terms[m] + " ";
                 }
                 System.out.println("\t\t\t" + sequence + " - " + field.getTermSequencesOccurrences()[k]);
             }
         }
     }
 }
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchResult() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentCount() | Gets the number of documents found.
 |
| getOccurrenceCount() | Gets the total number of occurrences found.
 |
| getTruncated() | Gets a value indicating that the result is truncated.
 |
| getWarnings() | Gets a warnings describing the result.
 |
| getNextChunkSearchToken() | Gets a chunk search token for searching the next chunk.
 |
| getStartTime() | Gets the start time of the search.
 |
| getEndTime() | Gets the end time of the search.
 |
| getSearchDuration() | Gets the search duration in seconds.
 |
| getFoundDocument(int index) | Gets the found document by index.
 |
| iterator() | Returns an iterator that iterates through the collection of the documents found.
 |
##### SearchResult()
```
public SearchResult()
```

##### getDocumentCount()
```
public abstract int getDocumentCount()
```

Gets the number of documents found.

**Returns:**
int - The number of documents found.

##### getOccurrenceCount()
```
public abstract int getOccurrenceCount()
```

Gets the total number of occurrences found.

**Returns:**
int - The total number of occurrences found.

##### getTruncated()
```
public abstract boolean getTruncated()
```

Gets a value indicating that the result is truncated.

**Returns:**
boolean - A value indicating that the result is truncated.

##### getWarnings()
```
public abstract String getWarnings()
```

Gets a warnings describing the result.

**Returns:**
java.lang.String - A warnings describing the result.

##### getNextChunkSearchToken()
```
public abstract ChunkSearchToken getNextChunkSearchToken()
```

Gets a chunk search token for searching the next chunk.

**Returns:**
ChunkSearchToken - A chunk search token for searching the next chunk.

##### getStartTime()
```
public abstract Date getStartTime()
```

Gets the start time of the search.

**Returns:**
java.util.Date - The start time of the search.

##### getEndTime()
```
public abstract Date getEndTime()
```

Gets the end time of the search.

**Returns:**
java.util.Date - The end time of the search.

##### getSearchDuration()
```
public abstract double getSearchDuration()
```

Gets the search duration in seconds.

**Returns:**
double - The search duration in seconds.

##### getFoundDocument(int index)
```
public abstract FoundDocument getFoundDocument(int index)
```

Gets the found document by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of a found document.
 |

**Returns:**
FoundDocument - The found document.

##### iterator()
```
public abstract Iterator<FoundDocument> iterator()
```

Returns an iterator that iterates through the collection of the documents found.

**Returns:**
java.util.Iterator<com.groupdocs.search.results.FoundDocument> - An iterator that can be used to iterate through the collection of the found documents.

### com.groupdocs.search.scaling.configuring
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring.md

The namespace provides classes for configuring the search network.

#### Classes

| Class | Description |
| --- | --- |
| Configuration | Represents a search network configuration. |
| Configurator | Represents the search network configurator. |
| IndexSettingsConfigurator | Represents the index settings configurator for each shard in the search network. |
| NodeConfigurator | Represents the search network node configurator. |
| TcpSettings | Represents a TCP network settings. |

#### Interfaces

| Interface | Description |
| --- | --- |
| INetworkSettings | Represents a network settings. |

### Configuration
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/configuration.md

**Inheritance:**
java.lang.Object
```
public abstract class Configuration
```

Represents a search network configuration.

#### Constructors

| Constructor | Description |
| --- | --- |
| Configuration() |  |
#### Methods

| Method | Description |
| --- | --- |
| save(String filePath) | Saves this configuration to a file.
 |
| save(OutputStream stream) | Saves this configuration to a stream.
 |
| load(String filePath) | Loads a search network configuration from a file.
 |
| load(InputStream stream) | Loads a search network configuration from a stream.
 |
##### Configuration()
```
public Configuration()
```

##### save(String filePath)
```
public abstract void save(String filePath)
```

Saves this configuration to a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file to save to.
 |

##### save(OutputStream stream)
```
public abstract void save(OutputStream stream)
```

Saves this configuration to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | The stream to save to.
 |

##### load(String filePath)
```
public static Configuration load(String filePath)
```

Loads a search network configuration from a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file to load from.
 |

**Returns:**
Configuration - The configuration.

##### load(InputStream stream)
```
public static Configuration load(InputStream stream)
```

Loads a search network configuration from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The stream to load from.
 |

**Returns:**
Configuration - The configuration.

### Configurator
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/configurator.md

**Inheritance:**
java.lang.Object
```
public class Configurator
```

Represents the search network configurator.

#### Constructors

| Constructor | Description |
| --- | --- |
| Configurator() | Initializes a new instance of the  Configurator  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| setIndexSettings() | Starts configuring the index settings for each shard in the search network.
 |
| addNode(int nodeIndex) | Adds a node to the search network configuration.
 |
| completeConfiguration() | Completes the configuration process and returns an instance of the search network configuration.
 |
| getCore() |  |
##### Configurator()
```
public Configurator()
```

Initializes a new instance of the  Configurator  class.

##### setIndexSettings()
```
public IndexSettingsConfigurator setIndexSettings()
```

Starts configuring the index settings for each shard in the search network.

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### addNode(int nodeIndex)
```
public NodeConfigurator addNode(int nodeIndex)
```

Adds a node to the search network configuration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | int | The node index.
 |

**Returns:**
NodeConfigurator - The node configurator.

##### completeConfiguration()
```
public Configuration completeConfiguration()
```

Completes the configuration process and returns an instance of the search network configuration.

**Returns:**
Configuration - The configuration.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### IndexSettingsConfigurator
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/indexsettingsconfigurator.md

**Inheritance:**
java.lang.Object
```
public abstract class IndexSettingsConfigurator
```

Represents the index settings configurator for each shard in the search network.

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexSettingsConfigurator() |  |
#### Methods

| Method | Description |
| --- | --- |
| setUseStopWords(boolean value) | Sets the use stop words flag.
 |
| setUseCharacterReplacements(boolean value) | Sets the use character replacements flag.
 |
| setTextStorageSettings(boolean isUsed, Compression compression) | Sets the text storage settings.
 |
| setIndexType(IndexType indexType) | Sets the index type.
 |
| setSearchThreads(NumberOfThreads numberOfThreads) | Sets the number of search threads.
 |
| completeIndexSettings() | Completes the configuration of the index settings.
 |
##### IndexSettingsConfigurator()
```
public IndexSettingsConfigurator()
```

##### setUseStopWords(boolean value)
```
public abstract IndexSettingsConfigurator setUseStopWords(boolean value)
```

Sets the use stop words flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag value.
 |

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### setUseCharacterReplacements(boolean value)
```
public abstract IndexSettingsConfigurator setUseCharacterReplacements(boolean value)
```

Sets the use character replacements flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag value.
 |

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### setTextStorageSettings(boolean isUsed, Compression compression)
```
public abstract IndexSettingsConfigurator setTextStorageSettings(boolean isUsed, Compression compression)
```

Sets the text storage settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isUsed | boolean | The flag of using the text storage in index.
 |
| compression | Compression | The compression level.
 |

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### setIndexType(IndexType indexType)
```
public abstract IndexSettingsConfigurator setIndexType(IndexType indexType)
```

Sets the index type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexType | IndexType | The index type.
 |

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### setSearchThreads(NumberOfThreads numberOfThreads)
```
public abstract IndexSettingsConfigurator setSearchThreads(NumberOfThreads numberOfThreads)
```

Sets the number of search threads.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| numberOfThreads | NumberOfThreads | The number of search threads.
 |

**Returns:**
IndexSettingsConfigurator - The index settings configurator.

##### completeIndexSettings()
```
public abstract Configurator completeIndexSettings()
```

Completes the configuration of the index settings.

**Returns:**
Configurator - The configurator.

### INetworkSettings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/inetworksettings.md

### NodeConfigurator
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/nodeconfigurator.md

**Inheritance:**
java.lang.Object
```
public abstract class NodeConfigurator
```

Represents the search network node configurator.

#### Constructors

| Constructor | Description |
| --- | --- |
| NodeConfigurator() |  |
#### Methods

| Method | Description |
| --- | --- |
| setTcpEndpoint(String hostNameOrAddress, int port) | Sets the TCP endpoint.
 |
| addLogSink() | Adds a log sink to the search network node.
 |
| addSearcher(String storagePath) | Adds a searcher service to the search network node.
 |
| addIndexer(String storagePath) | Adds an indexer service to the search network node.
 |
| addExtractor(String storagePath) | Adds an extractor service to the search network node.
 |
| addShard(String storagePath) | Adds a shard service to the search network node.
 |
| completeNode() | Completes the configuration of the search network node.
 |
##### NodeConfigurator()
```
public NodeConfigurator()
```

##### setTcpEndpoint(String hostNameOrAddress, int port)
```
public abstract NodeConfigurator setTcpEndpoint(String hostNameOrAddress, int port)
```

Sets the TCP endpoint.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| hostNameOrAddress | java.lang.String | The host name or address.
 |
| port | int | The port number.
 |

**Returns:**
NodeConfigurator - This search network node configurator.

##### addLogSink()
```
public abstract NodeConfigurator addLogSink()
```

Adds a log sink to the search network node.

**Returns:**
NodeConfigurator - This search network node configurator.

##### addSearcher(String storagePath)
```
public abstract NodeConfigurator addSearcher(String storagePath)
```

Adds a searcher service to the search network node.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | java.lang.String | The storage path of the adding service.
 |

**Returns:**
NodeConfigurator - This search network node configurator.

##### addIndexer(String storagePath)
```
public abstract NodeConfigurator addIndexer(String storagePath)
```

Adds an indexer service to the search network node.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | java.lang.String | The storage path of the adding service.
 |

**Returns:**
NodeConfigurator - This search network node configurator.

##### addExtractor(String storagePath)
```
public abstract NodeConfigurator addExtractor(String storagePath)
```

Adds an extractor service to the search network node.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | java.lang.String | The storage path of the adding service.
 |

**Returns:**
NodeConfigurator - This search network node configurator.

##### addShard(String storagePath)
```
public abstract NodeConfigurator addShard(String storagePath)
```

Adds a shard service to the search network node.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | java.lang.String | The storage path of the adding service.
 |

**Returns:**
NodeConfigurator - This search network node configurator.

##### completeNode()
```
public abstract Configurator completeNode()
```

Completes the configuration of the search network node.

**Returns:**
Configurator - The configurator.

### TcpSettings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.configuring/tcpsettings.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.search.scaling.configuring.INetworkSettings
```
public class TcpSettings implements INetworkSettings
```

Represents a TCP network settings.

#### Constructors

| Constructor | Description |
| --- | --- |
| TcpSettings(int listeningPort, int sendTimeout, int receiveTimeout) | Initializes a new instance of the  TcpSettings  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getListeningPort() | Gets the listening port.
 |
| getSendTimeout() | Gets the send timeout in milliseconds.
 |
| getReceiveTimeout() | Gets the receive timeout in milliseconds.
 |
##### TcpSettings(int listeningPort, int sendTimeout, int receiveTimeout)
```
public TcpSettings(int listeningPort, int sendTimeout, int receiveTimeout)
```

Initializes a new instance of the  TcpSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| listeningPort | int | The listening port.
 |
| sendTimeout | int | The send timeout in milliseconds.
 |
| receiveTimeout | int | The receive timeout in milliseconds.
 |

##### getListeningPort()
```
public final int getListeningPort()
```

Gets the listening port.

**Returns:**
int - The listening port.

##### getSendTimeout()
```
public final int getSendTimeout()
```

Gets the send timeout in milliseconds.

**Returns:**
int - The send timeout in milliseconds.

##### getReceiveTimeout()
```
public final int getReceiveTimeout()
```

Gets the receive timeout in milliseconds.

**Returns:**
int - The receive timeout in milliseconds.

### com.groupdocs.search.scaling.events
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events.md

The namespace provides classes of event arguments in the search network.

#### Classes

| Class | Description |
| --- | --- |
| DataExtractedEventArgs | Represents arguments for the event of a document data extraction is finished. |
| DocumentDeletedEventArgs | Represents arguments for the event of a document deletion is finished. |
| DocumentIndexedEventArgs | Represents arguments for the event of a document indexing is finished. |
| ErrorOccurredEventArgs | Represents arguments for the event of an error occurs in one of the nodes of the search network. |
| NetworkIndexingProgressEventArgs | Represents the arguments for the progress change event of the indexing operation. |
| NetworkOptimizationProgressEventArgs | Represents the arguments for the progress change event of the optimization operation. |
| NodeEventHub | Provides node events for subscribing. |
| StatusChangedEventArgs | Represents arguments for a search network status change event. |

### DataExtractedEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/dataextractedeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class DataExtractedEventArgs extends EventArgs
```

Represents arguments for the event of a document data extraction is finished.

#### Methods

| Method | Description |
| --- | --- |
| getExtractorIndex() | Gets the extractor index.
 |
| getDocumentKey() | Gets the document key.
 |
##### getExtractorIndex()
```
public final int getExtractorIndex()
```

Gets the extractor index.

**Returns:**
int - The extractor index.

##### getDocumentKey()
```
public final String getDocumentKey()
```

Gets the document key.

**Returns:**
java.lang.String - The document key.

### DocumentDeletedEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/documentdeletedeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class DocumentDeletedEventArgs extends EventArgs
```

Represents arguments for the event of a document deletion is finished.

#### Methods

| Method | Description |
| --- | --- |
| getShardIndex() | Gets the shard index.
 |
| getDocumentKey() | Gets the document key.
 |
##### getShardIndex()
```
public final int getShardIndex()
```

Gets the shard index.

**Returns:**
int - The shard index.

##### getDocumentKey()
```
public final String getDocumentKey()
```

Gets the document key.

**Returns:**
java.lang.String - The document key.

### DocumentIndexedEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/documentindexedeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class DocumentIndexedEventArgs extends EventArgs
```

Represents arguments for the event of a document indexing is finished.

#### Methods

| Method | Description |
| --- | --- |
| getShardIndex() | Gets the shard index.
 |
| getDocumentKey() | Gets the document key.
 |
##### getShardIndex()
```
public final int getShardIndex()
```

Gets the shard index.

**Returns:**
int - The shard index.

##### getDocumentKey()
```
public final String getDocumentKey()
```

Gets the document key.

**Returns:**
java.lang.String - The document key.

### ErrorOccurredEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/erroroccurredeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class ErrorOccurredEventArgs extends EventArgs
```

Represents arguments for the event of an error occurs in one of the nodes of the search network.

#### Methods

| Method | Description |
| --- | --- |
| getNodeIndex() | Gets the index of the search network node.
 |
| getServiceIndex() | Gets the index of the search network node service.
 |
| getMessage() | Gets the error message.
 |
##### getNodeIndex()
```
public final int getNodeIndex()
```

Gets the index of the search network node.

**Returns:**
int - The index of the search network node.

##### getServiceIndex()
```
public final int getServiceIndex()
```

Gets the index of the search network node service.

**Returns:**
int - The index of the search network node service.

##### getMessage()
```
public final String getMessage()
```

Gets the error message.

**Returns:**
java.lang.String - The error message.

### NetworkIndexingProgressEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/networkindexingprogresseventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class NetworkIndexingProgressEventArgs extends EventArgs
```

Represents the arguments for the progress change event of the indexing operation.

#### Methods

| Method | Description |
| --- | --- |
| getNodeIndex() | Gets the index of the search network node.
 |
| getServiceIndex() | Gets the index of the search network node service.
 |
| getProcessedDocuments() | Gets the number of processed documents.
 |
| getTotalDocuments() | Gets the total number of documents for processing.
 |
| getProgressPercentage() | Gets the percentage of the progress.
 |
##### getNodeIndex()
```
public final int getNodeIndex()
```

Gets the index of the search network node.

**Returns:**
int - The index of the search network node.

##### getServiceIndex()
```
public final int getServiceIndex()
```

Gets the index of the search network node service.

**Returns:**
int - The index of the search network node service.

##### getProcessedDocuments()
```
public final int getProcessedDocuments()
```

Gets the number of processed documents.

**Returns:**
int - The number of processed documents.

##### getTotalDocuments()
```
public final int getTotalDocuments()
```

Gets the total number of documents for processing.

**Returns:**
int - The total number of documents for processing.

##### getProgressPercentage()
```
public final double getProgressPercentage()
```

Gets the percentage of the progress.

**Returns:**
double - The percentage of the progress.

### NetworkOptimizationProgressEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/networkoptimizationprogresseventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class NetworkOptimizationProgressEventArgs extends EventArgs
```

Represents the arguments for the progress change event of the optimization operation.

#### Methods

| Method | Description |
| --- | --- |
| getNodeIndex() | Gets the index of the search network node.
 |
| getServiceIndex() | Gets the index of the search network node service.
 |
| getProcessedSegments() | Gets the number of processed segments.
 |
| getTotalSegments() | Gets the total number of segments for processing.
 |
| getProgressPercentage() | Gets the percentage of the progress.
 |
##### getNodeIndex()
```
public final int getNodeIndex()
```

Gets the index of the search network node.

**Returns:**
int - The index of the search network node.

##### getServiceIndex()
```
public final int getServiceIndex()
```

Gets the index of the search network node service.

**Returns:**
int - The index of the search network node service.

##### getProcessedSegments()
```
public final int getProcessedSegments()
```

Gets the number of processed segments.

**Returns:**
int - The number of processed segments.

##### getTotalSegments()
```
public final int getTotalSegments()
```

Gets the total number of segments for processing.

**Returns:**
int - The total number of segments for processing.

##### getProgressPercentage()
```
public final double getProgressPercentage()
```

Gets the percentage of the progress.

**Returns:**
double - The percentage of the progress.

### NodeEventHub
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/nodeeventhub.md

**Inheritance:**
java.lang.Object
```
public abstract class NodeEventHub
```

Provides node events for subscribing.

#### Constructors

| Constructor | Description |
| --- | --- |
| NodeEventHub() |  |
#### Fields

| Field | Description |
| --- | --- |
| ConfigurationCompleted | Occurs when the search network configuration process is finished.
 |
| IndexingCompleted | Occurs when indexing of all enqueued documents is finished.
 |
| DeletionCompleted | Occurs when all enqueued deletions of documents are finished.
 |
| OptimizationCompleted | Occurs when optimization of all nodes is finished.
 |
| SynchronizationCompleted | Occurs when synchronization with all nodes is finished.
 |
| AttributeChangesCompleted | Occurs when all enqueued attribute changes are finished.
 |
| StatusChanged | Occurs when the search network status changes.
 |
| DataExtracted | Occurs when the data has been extracted from a document.
 |
| DocumentIndexed | Occurs when a document has been indexed.
 |
| DocumentDeleted | Occurs when a document has been deleted.
 |
| ErrorOccurred | Occurs when an error occurs in one of the nodes of the search network.
 |
| IndexingProgressChanged | Occurs when the progress of the indexing operation has changed.
 |
| OptimizationProgressChanged | Occurs when the progress of the optimization operation has changed.
 |
##### NodeEventHub()
```
public NodeEventHub()
```

##### ConfigurationCompleted
```
public final Event<EventHandler> ConfigurationCompleted
```

Occurs when the search network configuration process is finished.

##### IndexingCompleted
```
public final Event<EventHandler> IndexingCompleted
```

Occurs when indexing of all enqueued documents is finished.

##### DeletionCompleted
```
public final Event<EventHandler> DeletionCompleted
```

Occurs when all enqueued deletions of documents are finished.

##### OptimizationCompleted
```
public final Event<EventHandler> OptimizationCompleted
```

Occurs when optimization of all nodes is finished.

##### SynchronizationCompleted
```
public final Event<EventHandler> SynchronizationCompleted
```

Occurs when synchronization with all nodes is finished.

##### AttributeChangesCompleted
```
public final Event<EventHandler> AttributeChangesCompleted
```

Occurs when all enqueued attribute changes are finished.

##### StatusChanged
```
public final Event<EventHandler<StatusChangedEventArgs>> StatusChanged
```

Occurs when the search network status changes.

##### DataExtracted
```
public final Event<EventHandler<DataExtractedEventArgs>> DataExtracted
```

Occurs when the data has been extracted from a document.

##### DocumentIndexed
```
public final Event<EventHandler<DocumentIndexedEventArgs>> DocumentIndexed
```

Occurs when a document has been indexed.

##### DocumentDeleted
```
public final Event<EventHandler<DocumentDeletedEventArgs>> DocumentDeleted
```

Occurs when a document has been deleted.

##### ErrorOccurred
```
public final Event<EventHandler<ErrorOccurredEventArgs>> ErrorOccurred
```

Occurs when an error occurs in one of the nodes of the search network.

##### IndexingProgressChanged
```
public final Event<EventHandler<NetworkIndexingProgressEventArgs>> IndexingProgressChanged
```

Occurs when the progress of the indexing operation has changed.

##### OptimizationProgressChanged
```
public final Event<EventHandler<NetworkOptimizationProgressEventArgs>> OptimizationProgressChanged
```

Occurs when the progress of the optimization operation has changed.

### StatusChangedEventArgs
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.events/statuschangedeventargs.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventArgs
```
public class StatusChangedEventArgs extends EventArgs
```

Represents arguments for a search network status change event.

#### Methods

| Method | Description |
| --- | --- |
| getOldStatus() | Gets the old search network status.
 |
| getNewStatus() | Gets the new search network status.
 |
##### getOldStatus()
```
public final SearchNetworkStatus getOldStatus()
```

Gets the old search network status.

**Returns:**
SearchNetworkStatus - The old search network status.

##### getNewStatus()
```
public final SearchNetworkStatus getNewStatus()
```

Gets the new search network status.

**Returns:**
SearchNetworkStatus - The new search network status.

### com.groupdocs.search.scaling.results
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results.md

The namespace provides the search result classes in the search network.

#### Classes

| Class | Description |
| --- | --- |
| NetworkDocumentInfo | Represents a descriptor for an indexed document in the search network. |
| NetworkFoundDocument | Represents a found document in the search network. |
| NetworkImageSearchResult | Represents an image search result matching a search image. |
| NetworkImageSearchToken | Represents a token for the continuation of the network chunk image search (search by pages). |
| NetworkSearchResult | Represents a search result matching a search query. |
| NetworkSearchToken | Represents a token for the continuation of the network chunk search (search by pages). |

### NetworkDocumentInfo
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networkdocumentinfo.md

**Inheritance:**
java.lang.Object
```
public abstract class NetworkDocumentInfo
```

Represents a descriptor for an indexed document in the search network.

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkDocumentInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentInfo() | Gets the descriptor for an indexed document.
 |
| getShardIndex() | Gets the shard index.
 |
##### NetworkDocumentInfo()
```
public NetworkDocumentInfo()
```

##### getDocumentInfo()
```
public abstract DocumentInfo getDocumentInfo()
```

Gets the descriptor for an indexed document.

**Returns:**
DocumentInfo - The descriptor for an indexed document.

##### getShardIndex()
```
public abstract int getShardIndex()
```

Gets the shard index.

**Returns:**
int - The shard index.

### NetworkFoundDocument
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networkfounddocument.md

**Inheritance:**
java.lang.Object
```
public abstract class NetworkFoundDocument
```

Represents a found document in the search network.

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkFoundDocument() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFoundDocument() | Gets the found document.
 |
| getShardIndex() | Gets the shard index.
 |
##### NetworkFoundDocument()
```
public NetworkFoundDocument()
```

##### getFoundDocument()
```
public abstract FoundDocument getFoundDocument()
```

Gets the found document.

**Returns:**
FoundDocument - The found document.

##### getShardIndex()
```
public abstract int getShardIndex()
```

Gets the shard index.

**Returns:**
int - The shard index.

### NetworkImageSearchResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networkimagesearchresult.md

**Inheritance:**
java.lang.Object
```
public abstract class NetworkImageSearchResult
```

Represents an image search result matching a search image.

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkImageSearchResult() |  |
#### Methods

| Method | Description |
| --- | --- |
| getImageCount() | Gets the number of images found.
 |
| getFoundImage(int index) | Gets the found image by index.
 |
| getNetworkImageSearchToken() | Gets a chunk image search token for searching the next chunk.
 |
| getNodeIndex() | Gets the index of the node from which the result was received.
 |
| getShardIndex() | Gets the index of the shard from which the result was received.
 |
##### NetworkImageSearchResult()
```
public NetworkImageSearchResult()
```

##### getImageCount()
```
public abstract int getImageCount()
```

Gets the number of images found.

**Returns:**
int - The number of images found.

##### getFoundImage(int index)
```
public abstract FoundImageFrame getFoundImage(int index)
```

Gets the found image by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of a found image.
 |

**Returns:**
FoundImageFrame - The found image.

##### getNetworkImageSearchToken()
```
public abstract NetworkImageSearchToken getNetworkImageSearchToken()
```

Gets a chunk image search token for searching the next chunk.

**Returns:**
NetworkImageSearchToken - A chunk image search token for searching the next chunk.

##### getNodeIndex()
```
public abstract int getNodeIndex()
```

Gets the index of the node from which the result was received.

**Returns:**
int - The index of the node from which the result was received.

##### getShardIndex()
```
public abstract int getShardIndex()
```

Gets the index of the shard from which the result was received.

**Returns:**
int - The index of the shard from which the result was received.

### NetworkImageSearchToken
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networkimagesearchtoken.md

**Inheritance:**
java.lang.Object
```
public abstract class NetworkImageSearchToken
```

Represents a token for the continuation of the network chunk image search (search by pages).

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkImageSearchToken() |  |
##### NetworkImageSearchToken()
```
public NetworkImageSearchToken()
```

### NetworkSearchResult
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networksearchresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public abstract class NetworkSearchResult implements Iterable<NetworkFoundDocument>
```

Represents a search result matching a search query.

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkSearchResult() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentCount() | Gets the number of documents found.
 |
| getOccurrenceCount() | Gets the total number of occurrences found.
 |
| getTruncated() | Gets a value indicating that the result is truncated.
 |
| getWarnings() | Gets a warnings describing the result.
 |
| getStartTime() | Gets the start time of the search.
 |
| getEndTime() | Gets the end time of the search.
 |
| getSearchDuration() | Gets the search duration in seconds.
 |
| getFoundDocument(int index) | Gets the found document by index.
 |
| iterator() | Returns an iterator that iterates through the collection of the documents found.
 |
| getNextChunkSearchToken() | Gets a chunk search token for searching the next chunk.
 |
| getNodeIndex() | Gets the index of the node from which the result was received.
 |
##### NetworkSearchResult()
```
public NetworkSearchResult()
```

##### getDocumentCount()
```
public abstract int getDocumentCount()
```

Gets the number of documents found.

**Returns:**
int - The number of documents found.

##### getOccurrenceCount()
```
public abstract int getOccurrenceCount()
```

Gets the total number of occurrences found.

**Returns:**
int - The total number of occurrences found.

##### getTruncated()
```
public abstract boolean getTruncated()
```

Gets a value indicating that the result is truncated.

**Returns:**
boolean - A value indicating that the result is truncated.

##### getWarnings()
```
public abstract String getWarnings()
```

Gets a warnings describing the result.

**Returns:**
java.lang.String - A warnings describing the result.

##### getStartTime()
```
public abstract Date getStartTime()
```

Gets the start time of the search.

**Returns:**
java.util.Date - The start time of the search.

##### getEndTime()
```
public abstract Date getEndTime()
```

Gets the end time of the search.

**Returns:**
java.util.Date - The end time of the search.

##### getSearchDuration()
```
public abstract double getSearchDuration()
```

Gets the search duration in seconds.

**Returns:**
double - The search duration in seconds.

##### getFoundDocument(int index)
```
public abstract NetworkFoundDocument getFoundDocument(int index)
```

Gets the found document by index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index of a found document.
 |

**Returns:**
NetworkFoundDocument - The found document.

##### iterator()
```
public abstract Iterator<NetworkFoundDocument> iterator()
```

Returns an iterator that iterates through the collection of the documents found.

**Returns:**
java.util.Iterator<com.groupdocs.search.scaling.results.NetworkFoundDocument> - An iterator that can be used to iterate through the collection of the found documents.

##### getNextChunkSearchToken()
```
public abstract NetworkSearchToken getNextChunkSearchToken()
```

Gets a chunk search token for searching the next chunk.

**Returns:**
NetworkSearchToken - A chunk search token for searching the next chunk.

##### getNodeIndex()
```
public abstract int getNodeIndex()
```

Gets the index of the node from which the result was received.

**Returns:**
int - The index of the node from which the result was received.

### NetworkSearchToken
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.results/networksearchtoken.md

**Inheritance:**
java.lang.Object
```
public abstract class NetworkSearchToken
```

Represents a token for the continuation of the network chunk search (search by pages).

#### Constructors

| Constructor | Description |
| --- | --- |
| NetworkSearchToken() |  |
##### NetworkSearchToken()
```
public NetworkSearchToken()
```

### com.groupdocs.search.scaling
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling.md

The namespace provides classes of scaling functionality.

#### Classes

| Class | Description |
| --- | --- |
| Indexer | Represents a service that manages the distribution of indexed documents across shards of the search network. |
| SearchNetworkNode | Represents a search network node that can contain services such as extractor, indexer, searcher, shard. |
| Searcher | Represents a service that manages search queries to shards of the search network. |

#### Enumerations

| Enum | Description |
| --- | --- |
| SearchNetworkStatus | Specifies a search network status. |

### Indexer
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling/indexer.md

**Inheritance:**
java.lang.Object
```
public abstract class Indexer
```

Represents a service that manages the distribution of indexed documents across shards of the search network.

#### Constructors

| Constructor | Description |
| --- | --- |
| Indexer() |  |
#### Methods

| Method | Description |
| --- | --- |
| add(Document[] documents, String[] passwords, IndexingOptions options) | Performs indexing operation.
 |
| add(ExtractedData[] data, IndexingOptions options) | Performs indexing operation.
 |
| delete(String[] documentKeys, DeleteOptions options) | Deletes indexed documents.
 |
| optimize(OptimizeOptions options) | Minimizes the number of index segments by merging them one with another.
 |
| synchronize(SynchronizeOptions options) | Synchronizes the list of indexed documents with those on shards.
 |
| changeAttributes(AttributeChangeBatch batch, ChangeAttributesOptions options) | Applies the specified batch of attribute changes to indexed documents without reindexing.
 |
| getAttributes(String documentKey) | Gets all the attributes associated with the specified indexed document.
 |
| getDictionary(DictionaryType dictionaryType, int shardIndex) | Gets a dictionary from the specified shard.
 |
| getAlphabet(int shardIndex) | Gets the alphabet dictionary.
 |
| getAliasDictionary(int shardIndex) | Gets the alias dictionary.
 |
| getCharacterReplacementDictionary(int shardIndex) | Gets the character replacement dictionary.
 |
| getSynonymDictionary(int shardIndex) | Gets the synonym dictionary.
 |
| getHomophoneDictionary(int shardIndex) | Gets the homophone dictionary.
 |
| getSpellingCorrector(int shardIndex) | Gets the spelling corrector dictionary.
 |
| getStopWordDictionary(int shardIndex) | Gets the stop word dictionary.
 |
| getPasswordDictionary(int shardIndex) | Gets the password dictionary.
 |
| setDictionary(DictionaryBase dictionary, int shardIndex) | Sets a dictionary in the specified shard.
 |
| setDictionary(DictionaryBase dictionary) | Sets a dictionary in all shards.
 |
| deleteAllData() | Deletes all indexed data from all shards of the search network.
 |
##### Indexer()
```
public Indexer()
```

##### add(Document[] documents, String[] passwords, IndexingOptions options)
```
public abstract void add(Document[] documents, String[] passwords, IndexingOptions options)
```

Performs indexing operation. Indexing only from stream and structure is supported.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documents | Document\[\] | The documents from file system, stream, or structure.
 |
| passwords | java.lang.String[] | The document passwords.
 |
| options | IndexingOptions | The add options.
 |

##### add(ExtractedData[] data, IndexingOptions options)
```
public abstract void add(ExtractedData[] data, IndexingOptions options)
```

Performs indexing operation. Adds the extracted data to the search network.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | ExtractedData\[\] | The extracted data.
 |
| options | IndexingOptions | The indexing options.
 |

##### delete(String[] documentKeys, DeleteOptions options)
```
public abstract void delete(String[] documentKeys, DeleteOptions options)
```

Deletes indexed documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKeys | java.lang.String[] | The keys of documents added from streams or structures.
 |
| options | DeleteOptions | The delete options.
 |

##### optimize(OptimizeOptions options)
```
public abstract void optimize(OptimizeOptions options)
```

Minimizes the number of index segments by merging them one with another. This operation improves search performance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | OptimizeOptions | The optimize options.
 |

##### synchronize(SynchronizeOptions options)
```
public abstract void synchronize(SynchronizeOptions options)
```

Synchronizes the list of indexed documents with those on shards. This operation fixes issues with indexing and deletion of documents that resulted from communication problems with the search network nodes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | SynchronizeOptions | The synchronize options.
 |

##### changeAttributes(AttributeChangeBatch batch, ChangeAttributesOptions options)
```
public abstract void changeAttributes(AttributeChangeBatch batch, ChangeAttributesOptions options)
```

Applies the specified batch of attribute changes to indexed documents without reindexing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| batch | AttributeChangeBatch | The attribute change batch.
 |
| options | ChangeAttributesOptions | The change attributes options.
 |

##### getAttributes(String documentKey)
```
public abstract String[] getAttributes(String documentKey)
```

Gets all the attributes associated with the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String | The document key.
 |

**Returns:**
java.lang.String[] - The attributes associated with the specified indexed document.

##### getDictionary(DictionaryType dictionaryType, int shardIndex)
```
public abstract DictionaryBase getDictionary(DictionaryType dictionaryType, int shardIndex)
```

Gets a dictionary from the specified shard.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dictionaryType | DictionaryType | The dictionary type.
 |
| shardIndex | int | The shard index.
 |

**Returns:**
DictionaryBase - The dictionary.

##### getAlphabet(int shardIndex)
```
public abstract Alphabet getAlphabet(int shardIndex)
```

Gets the alphabet dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
Alphabet - The dictionary.

##### getAliasDictionary(int shardIndex)
```
public abstract AliasDictionary getAliasDictionary(int shardIndex)
```

Gets the alias dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
AliasDictionary - The dictionary.

##### getCharacterReplacementDictionary(int shardIndex)
```
public abstract CharacterReplacementDictionary getCharacterReplacementDictionary(int shardIndex)
```

Gets the character replacement dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
CharacterReplacementDictionary - The dictionary.

##### getSynonymDictionary(int shardIndex)
```
public abstract SynonymDictionary getSynonymDictionary(int shardIndex)
```

Gets the synonym dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
SynonymDictionary - The dictionary.

##### getHomophoneDictionary(int shardIndex)
```
public abstract HomophoneDictionary getHomophoneDictionary(int shardIndex)
```

Gets the homophone dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
HomophoneDictionary - The dictionary.

##### getSpellingCorrector(int shardIndex)
```
public abstract SpellingCorrector getSpellingCorrector(int shardIndex)
```

Gets the spelling corrector dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
SpellingCorrector - The dictionary.

##### getStopWordDictionary(int shardIndex)
```
public abstract StopWordDictionary getStopWordDictionary(int shardIndex)
```

Gets the stop word dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
StopWordDictionary - The dictionary.

##### getPasswordDictionary(int shardIndex)
```
public abstract PasswordDictionary getPasswordDictionary(int shardIndex)
```

Gets the password dictionary.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
PasswordDictionary - The dictionary.

##### setDictionary(DictionaryBase dictionary, int shardIndex)
```
public abstract void setDictionary(DictionaryBase dictionary, int shardIndex)
```

Sets a dictionary in the specified shard.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | DictionaryBase | The dictionary.
 |
| shardIndex | int | The shard index.
 |

##### setDictionary(DictionaryBase dictionary)
```
public abstract void setDictionary(DictionaryBase dictionary)
```

Sets a dictionary in all shards.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | DictionaryBase | The dictionary.
 |

##### deleteAllData()
```
public abstract void deleteAllData()
```

Deletes all indexed data from all shards of the search network.

### Searcher
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling/searcher.md

**Inheritance:**
java.lang.Object
```
public abstract class Searcher
```

Represents a service that manages search queries to shards of the search network.

#### Constructors

| Constructor | Description |
| --- | --- |
| Searcher() |  |
#### Methods

| Method | Description |
| --- | --- |
| searchFirst(String query, SearchOptions options) | Starts a search with a query in text form in the distributed search index.
 |
| searchFirst(SearchQuery query, SearchOptions options) | Starts a search in the distributed search index.
 |
| searchFirst(SearchImage image, ImageSearchOptions options) | Performs a reverse image search in the distributed search index.
 |
| searchNext(NetworkSearchToken networkSearchToken) | Continues a search in the distributed search index.
 |
| searchNext(NetworkImageSearchToken networkImageSearchToken) | Continues a reverse image search in the distributed search index.
 |
| highlight(NetworkFoundDocument document, Highlighter highlighter, HighlightOptions options) | Generates HTML formatted text with highlighted found terms.
 |
| getIndexedDocuments(int shardIndex) | Gets an array of all indexed documents.
 |
| getIndexedDocumentItems(NetworkDocumentInfo documentInfo) | Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).
 |
| getDocumentText(NetworkDocumentInfo documentInfo, OutputAdapter adapter) | Generates the text of an indexed document and passes it through an output adapter.
 |
##### Searcher()
```
public Searcher()
```

##### searchFirst(String query, SearchOptions options)
```
public abstract NetworkSearchResult searchFirst(String query, SearchOptions options)
```

Starts a search with a query in text form in the distributed search index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.
 |
| options | SearchOptions | The search options.
 |

**Returns:**
NetworkSearchResult - The search result.

##### searchFirst(SearchQuery query, SearchOptions options)
```
public abstract NetworkSearchResult searchFirst(SearchQuery query, SearchOptions options)
```

Starts a search in the distributed search index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query.
 |
| options | SearchOptions | The search options.
 |

**Returns:**
NetworkSearchResult - The search result.

##### searchFirst(SearchImage image, ImageSearchOptions options)
```
public abstract NetworkImageSearchResult searchFirst(SearchImage image, ImageSearchOptions options)
```

Performs a reverse image search in the distributed search index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | SearchImage | The image to search.
 |
| options | ImageSearchOptions | The image search options.
 |

**Returns:**
NetworkImageSearchResult - The reverse image search result.

##### searchNext(NetworkSearchToken networkSearchToken)
```
public abstract NetworkSearchResult searchNext(NetworkSearchToken networkSearchToken)
```

Continues a search in the distributed search index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| networkSearchToken | NetworkSearchToken | The network search token.
 |

**Returns:**
NetworkSearchResult - The search result.

##### searchNext(NetworkImageSearchToken networkImageSearchToken)
```
public abstract NetworkImageSearchResult searchNext(NetworkImageSearchToken networkImageSearchToken)
```

Continues a reverse image search in the distributed search index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| networkImageSearchToken | NetworkImageSearchToken | The network image search token.
 |

**Returns:**
NetworkImageSearchResult - The reverse image search result.

##### highlight(NetworkFoundDocument document, Highlighter highlighter, HighlightOptions options)
```
public abstract void highlight(NetworkFoundDocument document, Highlighter highlighter, HighlightOptions options)
```

Generates HTML formatted text with highlighted found terms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | NetworkFoundDocument | The found document.
 |
| highlighter | Highlighter | The search result highlighter.
 |
| options | HighlightOptions | The highlight options.
 |

##### getIndexedDocuments(int shardIndex)
```
public abstract NetworkDocumentInfo[] getIndexedDocuments(int shardIndex)
```

Gets an array of all indexed documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | int | The shard index.
 |

**Returns:**
com.groupdocs.search.scaling.results.NetworkDocumentInfo[] - An array of all indexed documents.

##### getIndexedDocumentItems(NetworkDocumentInfo documentInfo)
```
public abstract NetworkDocumentInfo[] getIndexedDocumentItems(NetworkDocumentInfo documentInfo)
```

Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | NetworkDocumentInfo | The document info.
 |

**Returns:**
com.groupdocs.search.scaling.results.NetworkDocumentInfo[] - An array of a document items.

##### getDocumentText(NetworkDocumentInfo documentInfo, OutputAdapter adapter)
```
public abstract void getDocumentText(NetworkDocumentInfo documentInfo, OutputAdapter adapter)
```

Generates the text of an indexed document and passes it through an output adapter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | NetworkDocumentInfo | The indexed document info.
 |
| adapter | OutputAdapter | The output adapter.
 |

### SearchNetworkNode
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling/searchnetworknode.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class SearchNetworkNode implements Closeable
```

Represents a search network node that can contain services such as extractor, indexer, searcher, shard.

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings) | Initializes a new instance of the  SearchNetworkNode  class.
 |
| SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger) | Initializes a new instance of the  SearchNetworkNode  class.
 |
| SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger, Configuration configuration) | Initializes a new instance of the  SearchNetworkNode  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| start() | Starts the functioning of the search network node.
 |
| configureAllNodes() | Configures all nodes in the search network.
 |
| configureNode(int nodeIndex) | Configures the specified node in the search network.
 |
| getCustomExtractors() | Gets the custom extractor collection.
 |
| setOcrConnector(IOcrConnector ocrConnector) | Sets an OCR connector that is used for OCR processing.
 |
| setWordFormsProvider(IWordFormsProvider wordFormsProvider) | Sets a word forms provider.
 |
| close() | Releases all resources used by the  SearchNetworkNode .
 |
| getNodeIndex() | Gets the index of the search network node.
 |
| getEvents() | Gets the event hub for subscribing to events.
 |
| getIndexer() | Gets the indexer.
 |
| getSearcher() | Gets the searcher.
 |
| getShardIndices() | Gets an array of all shard indices in the search network.
 |
| getNodeIndex(int serviceIndex) | Gets the index of the node where the service is located.
 |
| getCore() |  |
##### SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings)
```
public SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings)
```

Initializes a new instance of the  SearchNetworkNode  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | int | The node index.
 |
| storagePath | java.lang.String | The storage path.
 |
| networkSettings | INetworkSettings | The network settings.
 |

##### SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger)
```
public SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger)
```

Initializes a new instance of the  SearchNetworkNode  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | int | The node index.
 |
| storagePath | java.lang.String | The storage path.
 |
| networkSettings | INetworkSettings | The network settings.
 |
| logger | ILogger | The logger.
 |

##### SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger, Configuration configuration)
```
public SearchNetworkNode(int nodeIndex, String storagePath, INetworkSettings networkSettings, ILogger logger, Configuration configuration)
```

Initializes a new instance of the  SearchNetworkNode  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | int | The node index.
 |
| storagePath | java.lang.String | The storage path.
 |
| networkSettings | INetworkSettings | The network settings.
 |
| logger | ILogger | The logger.
 |
| configuration | Configuration | The configuration.
 |

##### start()
```
public void start()
```

Starts the functioning of the search network node.

##### configureAllNodes()
```
public void configureAllNodes()
```

Configures all nodes in the search network.

##### configureNode(int nodeIndex)
```
public void configureNode(int nodeIndex)
```

Configures the specified node in the search network.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | int | The node index.
 |

##### getCustomExtractors()
```
public CustomExtractorCollection getCustomExtractors()
```

Gets the custom extractor collection. The full example of implementing a custom extractor is presented in documentation for  GroupDocs.Search.Common.IFieldExtractor  interface.

**Returns:**
CustomExtractorCollection - The custom extractor collection.

##### setOcrConnector(IOcrConnector ocrConnector)
```
public void setOcrConnector(IOcrConnector ocrConnector)
```

Sets an OCR connector that is used for OCR processing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | The OCR connector.
 |

##### setWordFormsProvider(IWordFormsProvider wordFormsProvider)
```
public void setWordFormsProvider(IWordFormsProvider wordFormsProvider)
```

Sets a word forms provider.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordFormsProvider | IWordFormsProvider | The word forms provider.
 |

##### close()
```
public void close()
```

Releases all resources used by the  SearchNetworkNode .

##### getNodeIndex()
```
public int getNodeIndex()
```

Gets the index of the search network node.

**Returns:**
int - The index of the search network node.

##### getEvents()
```
public NodeEventHub getEvents()
```

Gets the event hub for subscribing to events.

**Returns:**
NodeEventHub - The event hub for subscribing to events.

##### getIndexer()
```
public Indexer getIndexer()
```

Gets the indexer.

**Returns:**
Indexer - The indexer.

##### getSearcher()
```
public Searcher getSearcher()
```

Gets the searcher.

**Returns:**
Searcher - The searcher.

##### getShardIndices()
```
public int[] getShardIndices()
```

Gets an array of all shard indices in the search network.

**Returns:**
int[] - An array of all shard indices in the search network.

##### getNodeIndex(int serviceIndex)
```
public int getNodeIndex(int serviceIndex)
```

Gets the index of the node where the service is located.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| serviceIndex | int | The service index.
 |

**Returns:**
int - The index of the node where the service is located. If the service index is incorrect, when -1 is returned.

##### getCore()
```
public Object getCore()
```

**Returns:**
java.lang.Object

### SearchNetworkStatus
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.scaling/searchnetworkstatus.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum SearchNetworkStatus extends Enum<SearchNetworkStatus>
```

Specifies a search network status.

#### Fields

| Field | Description |
| --- | --- |
| Ready | The search network is free and ready for changes.
 |
| Configuring | The search network performs a configuring operation.
 |
| Indexing | The search network performs an indexing operation.
 |
| Optimizing | The search network performs an optimizing operation.
 |
| Deleting | The search network performs a deleting operation.
 |
| ChangingAttributes | The search network changes attributes.
 |
| Synchronizing | The search network performs a synchronizing operation.
 |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### Ready
```
public static final SearchNetworkStatus Ready
```

The search network is free and ready for changes.

##### Configuring
```
public static final SearchNetworkStatus Configuring
```

The search network performs a configuring operation.

##### Indexing
```
public static final SearchNetworkStatus Indexing
```

The search network performs an indexing operation.

##### Optimizing
```
public static final SearchNetworkStatus Optimizing
```

The search network performs an optimizing operation.

##### Deleting
```
public static final SearchNetworkStatus Deleting
```

The search network performs a deleting operation.

##### ChangingAttributes
```
public static final SearchNetworkStatus ChangingAttributes
```

The search network changes attributes.

##### Synchronizing
```
public static final SearchNetworkStatus Synchronizing
```

The search network performs a synchronizing operation.

##### values()
```
public static SearchNetworkStatus[] values()
```

**Returns:**
com.groupdocs.search.scaling.SearchNetworkStatus[]
##### valueOf(String name)
```
public static SearchNetworkStatus valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
SearchNetworkStatus

### com.groupdocs.search
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search.md

The package provides classes for indexing and searching text data in documents of different formats. The main classes in this package are:

Index is the entry point for indexing and search operations.

SearchQuery is the base class and the factory for all types of search queries in object form.

IndexRepository is a container class for combining multiple indexes and performing common operations on them.

#### Classes

| Class | Description |
| --- | --- |
| Action | Encapsulates a method that has no parameters and does not return a value. |
| Action1<T> | Encapsulates a method that has a single parameter and does not return a value. |
| Action2<T1,T2> | Encapsulates a method that has two parameters and does not return a value. |
| Document | Represents the base class for documents added to an index from file system, stream, or structure. |
| DocumentFilter | Represents the base class for document filters. |
| ExtractedData | Represents data retrieved from a document and prepared for indexing. |
| Extractor | Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing. |
| Index | Represents the main class for indexing documents and search through them. |
| IndexRepository | Represents a container for combining multiple indexes and performing common operations on them. |
| IndexSettings | Represents the index settings that allow to customize the indexing operations. |
| IndexUpdater | Represents an index updater. |
| LicenseRestrictionException | The exception that is thrown when a license restriction is triggered. |
| Notification | The base class for all notifications to the index. |
| PleaseReportException | Represents the exception that is thrown when an error occurred in the library. |
| SearchDocumentFilter | Contains methods for creating search document filters. |
| SearchQuery | Represents a search query in object form. |

### Action
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/action.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate
```
public abstract class Action extends MulticastDelegate
```

Encapsulates a method that has no parameters and does not return a value.

#### Constructors

| Constructor | Description |
| --- | --- |
| Action() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke() | The method to be invoked.
 |
##### Action()
```
public Action()
```

##### invoke()
```
public abstract void invoke()
```

The method to be invoked.

### Action1
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/action1.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate
```
public abstract class Action1<T> extends MulticastDelegate
```

Encapsulates a method that has a single parameter and does not return a value.

#### Constructors

| Constructor | Description |
| --- | --- |
| Action1() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(T arg) | The method to be invoked.
 |
##### Action1()
```
public Action1()
```

##### invoke(T arg)
```
public abstract void invoke(T arg)
```

The method to be invoked.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg | T | The parameter.
 |

### Action2
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/action2.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.common.Delegate, com.groupdocs.search.common.MulticastDelegate
```
public abstract class Action2<T1,T2> extends MulticastDelegate
```

Encapsulates a method that has two parameters and does not return a value.

#### Constructors

| Constructor | Description |
| --- | --- |
| Action2() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(T1 arg1, T2 arg2) | The method to be invoked.
 |
##### Action2()
```
public Action2()
```

##### invoke(T1 arg1, T2 arg2)
```
public abstract void invoke(T1 arg1, T2 arg2)
```

The method to be invoked.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg1 | T1 | The first parameter.
 |
| arg2 | T2 | The second parameter.
 |

### Document
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/document.md

**Inheritance:**
java.lang.Object
```
public abstract class Document
```

Represents the base class for documents added to an index from file system, stream, or structure. Contains static methods for creating documents from different types of sources.

#### Methods

| Method | Description |
| --- | --- |
| getDocumentSourceKind() | Gets the document source kind.
 |
| getDocumentKey() | Gets the document key that is used to identify the document within an index.
 |
| isLazy() | Gets a value indicating whether the document is loaded as needed or not.
 |
| getModificationDate() | Gets the last modification date of the document.
 |
| getExtension() | Gets the extension used for this document type.
 |
| getAdditionalFields() | Gets the additional fields for the document.
 |
| setAdditionalFields(DocumentField[] value) | Sets the additional fields for the document.
 |
| getAttributes() | Gets the attributes of the document.
 |
| setAttributes(String[] value) | Sets the attributes of the document.
 |
| createFromFile(String filePath) | Creates a document from a file.
 |
| createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream) | Creates a document from a stream.
 |
| createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields) | Creates a document from a structure that is an array of text fields.
 |
| createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader) | Creates a lazy-loaded document.
 |
| toString() | Returns a  java.lang.String  that represents the current  Document .
 |
##### getDocumentSourceKind()
```
public abstract DocumentSourceKind getDocumentSourceKind()
```

Gets the document source kind.

**Returns:**
DocumentSourceKind - The document source kind.

##### getDocumentKey()
```
public abstract String getDocumentKey()
```

Gets the document key that is used to identify the document within an index.

**Returns:**
java.lang.String - The document key that is used to identify the document within an index.

##### isLazy()
```
public abstract boolean isLazy()
```

Gets a value indicating whether the document is loaded as needed or not.

**Returns:**
boolean - A value indicating whether the document is loaded as needed or not.

##### getModificationDate()
```
public abstract Date getModificationDate()
```

Gets the last modification date of the document.

**Returns:**
java.util.Date - The last modification date of the document.

##### getExtension()
```
public abstract String getExtension()
```

Gets the extension used for this document type.

**Returns:**
java.lang.String - The extension used for this document type.

##### getAdditionalFields()
```
public DocumentField[] getAdditionalFields()
```

Gets the additional fields for the document.

**Returns:**
com.groupdocs.search.common.DocumentField[] - The additional fields for the document.

##### setAdditionalFields(DocumentField[] value)
```
public void setAdditionalFields(DocumentField[] value)
```

Sets the additional fields for the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentField\[\] | The additional fields for the document.
 |

##### getAttributes()
```
public String[] getAttributes()
```

Gets the attributes of the document.

**Returns:**
java.lang.String[] - The attributes of the document.

##### setAttributes(String[] value)
```
public void setAttributes(String[] value)
```

Sets the attributes of the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String[] | The attributes of the document.
 |

##### createFromFile(String filePath)
```
public static Document createFromFile(String filePath)
```

Creates a document from a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The document file path.
 |

**Returns:**
Document - The created document.

##### createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream)
```
public static Document createFromStream(String documentKey, Date modificationDate, String extension, InputStream stream)
```

Creates a document from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String | The document key.
 |
| modificationDate | java.util.Date | The document modification date.
 |
| extension | java.lang.String | The document extension.
 |
| stream | java.io.InputStream | The document stream.
 |

**Returns:**
Document - The created document.

##### createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields)
```
public static Document createFromStructure(String documentKey, Date modificationDate, DocumentField[] fields)
```

Creates a document from a structure that is an array of text fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String | The document key.
 |
| modificationDate | java.util.Date | The document modification date.
 |
| fields | DocumentField\[\] | The document fields.
 |

**Returns:**
Document - The created document.

##### createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader)
```
public static Document createLazy(DocumentSourceKind documentSourceKind, String documentKey, IDocumentLoader documentLoader)
```

Creates a lazy-loaded document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSourceKind | DocumentSourceKind | The document source kind. This value must match the kind of the loaded document.
 |
| documentKey | java.lang.String | The document key. This value must match the key of the loaded document.
 |
| documentLoader | IDocumentLoader | The document loader.
 |

**Returns:**
Document - The created document.

##### toString()
```
public String toString()
```

Returns a  java.lang.String  that represents the current  Document .

**Returns:**
java.lang.String - A  java.lang.String  that represents the current  Document .

### DocumentFilter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/documentfilter.md

**Inheritance:**
java.lang.Object
```
public abstract class DocumentFilter
```

Represents the base class for document filters. Contains methods for creation document filter instances.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentFilter() |  |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Returns string representation of a document filter.
 |
| createCreationTimeLowerBound(Date lowerBound) | Creates a filter for skipping documents with creation date earlier than the lower bound.
 |
| createCreationTimeUpperBound(Date upperBound) | Creates a filter for skipping documents with creation date later than the upper bound.
 |
| createCreationTimeRange(Date lowerBound, Date upperBound) | Creates a filter for skipping documents with creation date out of the specified range.
 |
| createModificationTimeLowerBound(Date lowerBound) | Creates a filter for skipping documents with modification date earlier than the lower bound.
 |
| createModificationTimeUpperBound(Date upperBound) | Creates a filter for skipping documents with modification date later than the upper bound.
 |
| createModificationTimeRange(Date lowerBound, Date upperBound) | Creates a filter for skipping documents with modification date out of the specified range.
 |
| createFilePathRegularExpression(String pattern) | Creates a filter for skipping documents that are not match a regular expression.
 |
| createFilePathRegularExpression(String pattern, int options) | Creates a filter for skipping documents that are not match a regular expression.
 |
| createFileLengthLowerBound(long lowerBound) | Creates a filter for skipping documents with the length less than the lower bound.
 |
| createFileLengthUpperBound(long upperBound) | Creates a filter for skipping documents with the length greater than the upper bound.
 |
| createFileLengthRange(long lowerBound, long upperBound) | Creates a filter for skipping documents out of the specified document length range.
 |
| createFileExtension(String[] extensions) | Creates a filter for skipping documents that do not have allowable extension.
 |
| createNot(DocumentFilter innerFilter) | Creates a filter that has inverse logic in relation to the specified inner filter.
 |
| createAnd(DocumentFilter[] filters) | Creates a logical conjunction of the specified filters.
 |
| createOr(DocumentFilter[] filters) | Creates a logical disjunction of the specified filters.
 |
##### DocumentFilter()
```
public DocumentFilter()
```

##### toString()
```
public abstract String toString()
```

Returns string representation of a document filter.

**Returns:**
java.lang.String - String representation of a document filter.

##### createCreationTimeLowerBound(Date lowerBound)
```
public static DocumentFilter createCreationTimeLowerBound(Date lowerBound)
```

Creates a filter for skipping documents with creation date earlier than the lower bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | java.util.Date | The lower bound of the document creation time.
 |

**Returns:**
DocumentFilter - A document filter by document creation time.

##### createCreationTimeUpperBound(Date upperBound)
```
public static DocumentFilter createCreationTimeUpperBound(Date upperBound)
```

Creates a filter for skipping documents with creation date later than the upper bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | java.util.Date | The upper bound of the document creation time.
 |

**Returns:**
DocumentFilter - A document filter by document creation time.

##### createCreationTimeRange(Date lowerBound, Date upperBound)
```
public static DocumentFilter createCreationTimeRange(Date lowerBound, Date upperBound)
```

Creates a filter for skipping documents with creation date out of the specified range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | java.util.Date | The lower bound of the document creation time.
 |
| upperBound | java.util.Date | The upper bound of the document creation time.
 |

**Returns:**
DocumentFilter - A document filter by document creation time.

##### createModificationTimeLowerBound(Date lowerBound)
```
public static DocumentFilter createModificationTimeLowerBound(Date lowerBound)
```

Creates a filter for skipping documents with modification date earlier than the lower bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | java.util.Date | The lower bound of the document modification time.
 |

**Returns:**
DocumentFilter - A document filter by document modification time.

##### createModificationTimeUpperBound(Date upperBound)
```
public static DocumentFilter createModificationTimeUpperBound(Date upperBound)
```

Creates a filter for skipping documents with modification date later than the upper bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | java.util.Date | The upper bound of the document modification time.
 |

**Returns:**
DocumentFilter - A document filter by document modification time.

##### createModificationTimeRange(Date lowerBound, Date upperBound)
```
public static DocumentFilter createModificationTimeRange(Date lowerBound, Date upperBound)
```

Creates a filter for skipping documents with modification date out of the specified range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | java.util.Date | The lower bound of the document modification time.
 |
| upperBound | java.util.Date | The upper bound of the document modification time.
 |

**Returns:**
DocumentFilter - A document filter by document modification time.

##### createFilePathRegularExpression(String pattern)
```
public static DocumentFilter createFilePathRegularExpression(String pattern)
```

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern.
 |

**Returns:**
DocumentFilter - A document filter by file name.

##### createFilePathRegularExpression(String pattern, int options)
```
public static DocumentFilter createFilePathRegularExpression(String pattern, int options)
```

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern.
 |
| options | int | The regular expression options.
 |

**Returns:**
DocumentFilter - A document filter by file name.

##### createFileLengthLowerBound(long lowerBound)
```
public static DocumentFilter createFileLengthLowerBound(long lowerBound)
```

Creates a filter for skipping documents with the length less than the lower bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | long | The lower bound of the document length.
 |

**Returns:**
DocumentFilter - A document filter by document length.

##### createFileLengthUpperBound(long upperBound)
```
public static DocumentFilter createFileLengthUpperBound(long upperBound)
```

Creates a filter for skipping documents with the length greater than the upper bound.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | long | The upper bound of the document length.
 |

**Returns:**
DocumentFilter - A document filter by document length.

##### createFileLengthRange(long lowerBound, long upperBound)
```
public static DocumentFilter createFileLengthRange(long lowerBound, long upperBound)
```

Creates a filter for skipping documents out of the specified document length range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | long | The lower bound of the document length.
 |
| upperBound | long | The upper bound of the document length.
 |

**Returns:**
DocumentFilter - A document filter by document length.

##### createFileExtension(String[] extensions)
```
public static DocumentFilter createFileExtension(String[] extensions)
```

Creates a filter for skipping documents that do not have allowable extension.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extensions | java.lang.String[] | The list of allowable extensions.
 |

**Returns:**
DocumentFilter - A document filter by document extension.

##### createNot(DocumentFilter innerFilter)
```
public static DocumentFilter createNot(DocumentFilter innerFilter)
```

Creates a filter that has inverse logic in relation to the specified inner filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerFilter | DocumentFilter | The inner document filter.
 |

**Returns:**
DocumentFilter - An inverted document filter.

##### createAnd(DocumentFilter[] filters)
```
public static DocumentFilter createAnd(DocumentFilter[] filters)
```

Creates a logical conjunction of the specified filters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filters | DocumentFilter\[\] | The document filters.
 |

**Returns:**
DocumentFilter - A document filter that represents result of conjunction of the specified filters.

##### createOr(DocumentFilter[] filters)
```
public static DocumentFilter createOr(DocumentFilter[] filters)
```

Creates a logical disjunction of the specified filters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filters | DocumentFilter\[\] | The document filters.
 |

**Returns:**
DocumentFilter - A document filter that represents result of disjunction of the specified filters.

### ExtractedData
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/extracteddata.md

**Inheritance:**
java.lang.Object
```
public class ExtractedData
```

Represents data retrieved from a document and prepared for indexing.

#### Methods

| Method | Description |
| --- | --- |
| serialize() | Serializes the current instance to a byte array.
 |
| deserialize(byte[] array) | Deserializes an instance from a byte array.
 |
##### serialize()
```
public final byte[] serialize()
```

Serializes the current instance to a byte array.

**Returns:**
byte[] - A byte array representing the current instance.

##### deserialize(byte[] array)
```
public static ExtractedData deserialize(byte[] array)
```

Deserializes an instance from a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| array | byte[] | A byte array to deserialize from.
 |

**Returns:**
ExtractedData - An instance deserialized from a byte array.

### Extractor
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/extractor.md

**Inheritance:**
java.lang.Object, com.groupdocs.search.events.EventHubBase
```
public class Extractor extends EventHubBase
```

Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing.

#### Constructors

| Constructor | Description |
| --- | --- |
| Extractor() | Initializes a new instance of the  Extractor  class.
 |
#### Fields

| Field | Description |
| --- | --- |
| ErrorOccurred | Occurs when an error happens during an extractor operation.
 |
| ImagePreparing | Occurs when an image is going to be prepared for indexing.
 |
| PasswordRequired | Occurs when a document requires password for opening.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSettings() | Gets the extractor settings.
 |
| extract(Document document, ExtractionOptions extractionOptions) | Extracts data from a document.
 |
| raiseErrorOccurredPublic(String message, boolean isCritical) |  |
| raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream) |  |
| raisePasswordRequiredPublic(String filePath) |  |
##### Extractor()
```
public Extractor()
```

Initializes a new instance of the  Extractor  class.

##### ErrorOccurred
```
public final Event<EventHandler<IndexErrorEventArgs>> ErrorOccurred
```

Occurs when an error happens during an extractor operation.

##### ImagePreparing
```
public final Event<EventHandler<ImagePreparingEventArgs>> ImagePreparing
```

Occurs when an image is going to be prepared for indexing.

##### PasswordRequired
```
public final Event<EventHandler<PasswordRequiredEventArgs>> PasswordRequired
```

Occurs when a document requires password for opening.

##### getSettings()
```
public final ExtractorSettings getSettings()
```

Gets the extractor settings.

**Returns:**
ExtractorSettings - The extractor settings.

##### extract(Document document, ExtractionOptions extractionOptions)
```
public final ExtractedData extract(Document document, ExtractionOptions extractionOptions)
```

Extracts data from a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | Document | The document from file system, stream or structure.
 |
| extractionOptions | ExtractionOptions | The extraction options.
 |

**Returns:**
ExtractedData - The extracted data of the document.

##### raiseErrorOccurredPublic(String message, boolean isCritical)
```
public final void raiseErrorOccurredPublic(String message, boolean isCritical)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |
| isCritical | boolean |  |

##### raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
```
public final void raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String |  |
| innerPath | java.lang.String[] |  |
| imageIndex | int |  |
| frames | ImageFrame\[\] |  |
| stream | java.io.InputStream |  |

##### raisePasswordRequiredPublic(String filePath)
```
public final String raisePasswordRequiredPublic(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

**Returns:**
java.lang.String

### Index
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/index.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Index implements Closeable
```

Represents the main class for indexing documents and search through them.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchResult result = index.search(query); // Searching in index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| Index() | Initializes a new instance of the  Index  class in memory.
 |
| Index(IndexSettings settings) | Initializes a new instance of the  Index  class in memory with particular index settings.
 |
| Index(String indexFolder) | Initializes a new instance of the  Index  class.
 |
| Index(String indexFolder, IndexSettings settings) | Initializes a new instance of the
Index
 class.
 |
| Index(String indexFolder, boolean overwriteIfExists) | Initializes a new instance of the
Index
 class.
 |
| Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists) | Initializes a new instance of the
Index
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEvents() | Gets the event hub for subscribing to events.
 |
| getIndexInfo() | Gets the basic information on the index.
 |
| getRepository() | Gets the index repository object if the index is contained in it.
 |
| getIndexSettings() | Gets the index settings.
 |
| getDictionaries() | Gets the dictionary repository.
 |
| close() | Releases all resources used by the
Index
.
 |
| add(String path) | Performs indexing operation.
 |
| add(String path, IndexingOptions options) | Performs indexing operation.
 |
| add(String[] paths) | Performs indexing operation.
 |
| add(String[] paths, IndexingOptions options) | Performs indexing operation.
 |
| add(Document[] documents, IndexingOptions options) | Performs indexing operation.
 |
| add(ExtractedData[] data, IndexingOptions options) | Performs indexing operation.
 |
| update() | Re-indexes documents that have been changed or deleted since last update.
 |
| update(UpdateOptions options) | Re-indexes documents that have been changed or deleted since last update.
 |
| getIndexingReports() | Gets the reports on indexing operations.
 |
| getSearchReports() | Gets the reports on search operations.
 |
| search(String query) | Searches in index.
 |
| search(String query, SearchOptions options) | Searches in index.
 |
| search(SearchQuery query) | Searches in index.
 |
| search(SearchQuery query, SearchOptions options) | Searches in index.
 |
| search(SearchImage image, ImageSearchOptions options) | Performs a reverse image search in the index.
 |
| searchNext(ChunkSearchToken chunkSearchToken) | Continues the chunk search started with method Search.
 |
| searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation) | Continues the chunk search started with method Search.
 |
| optimize() | Minimizes the number of index segments by merging them one with another.
 |
| optimize(MergeOptions options) | Minimizes the number of index segments by merging them one with another.
 |
| merge(Index index, MergeOptions options) | Merges the specified index into the current index.
 |
| merge(IndexRepository repository, MergeOptions options) | Merges indexes from the specified index repository into the current index.
 |
| highlight(FoundDocument document, Highlighter highlighter) | Generates HTML formatted text with highlighted found terms.
 |
| highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options) | Generates HTML formatted text with highlighted found terms.
 |
| getIndexedDocuments() | Gets an array of all indexed documents.
 |
| getIndexedDocumentItems(DocumentInfo documentInfo) | Gets an array of a document items.
 |
| GetIndexedDocument(String documentKey) | Gets an indexed document by document key.
 |
| getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter) | Generates the text of an indexed document and passes it through an output adapter.
 |
| getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options) | Generates HTML formatted text for indexed document and transfers it through the output adapter.
 |
| getIndexedPaths() | Gets an array of indexed paths - documents or folders.
 |
| delete(String[] paths, UpdateOptions options) | Deletes indexed files or folders from the index.
 |
| delete(UpdateOptions options, String[] documentKeys) | Deletes documents indexed from streams or structures.
 |
| notifyIndex(Notification notification) | Passes the specified notification object to the index to perform the notification.
 |
| changeAttributes(AttributeChangeBatch batch) | Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.
 |
| getAttributes(String path) | Gets all the attributes associated with the specified indexed document.
 |
| loadIntoMemoryCompletely(String indexFolder) | Loads the entire index into memory.
 |
| loadIntoMemoryCompletely(String indexFolder, IndexSettings settings) | Loads the entire index into memory.
 |
##### Index()
```
public Index()
```

Initializes a new instance of the  Index  class in memory.

The example demonstrates how to create index in memory without saving files to disk.

````
 ```

 Index index = new Index();
 
```
 
````

##### Index(IndexSettings settings)
```
public Index(IndexSettings settings)
```

Initializes a new instance of the  Index  class in memory with particular index settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| settings | IndexSettings | The index settings object.

The example demonstrates how to create index in memory without saving files to disk with particular index settings.

````
 ```

 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex);
 Index index = new Index(settings);
 
```
 
````

 |

##### Index(String indexFolder)
```
public Index(String indexFolder)
```

Initializes a new instance of the  Index  class. Creates a new or opens an existing index on disk.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.

The example demonstrates how to create an index on a disk or open an existing index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 Index index = new Index(indexFolder);
 
```
 
````

 |

##### Index(String indexFolder, IndexSettings settings)
```
public Index(String indexFolder, IndexSettings settings)
```

Initializes a new instance of the
Index
 class.
Creates a new index with particular settings or opens an existing index on disk.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.
 |
| settings | IndexSettings | The index settings object.

The example demonstrates how to create an index on a disk with particular index settings.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex);
 Index index = new Index(indexFolder, settings);
 
```
 
````

 |

##### Index(String indexFolder, boolean overwriteIfExists)
```
public Index(String indexFolder, boolean overwriteIfExists)
```

Initializes a new instance of the
Index
 class.
Loads an existing index from disk if
overwriteIfExists
 is
false
;
creates a new index on disk otherwise.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.
 |
| overwriteIfExists | boolean | The flag of overwriting the index folder.

The example demonstrates how to create a new index in a folder that already contains another index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 Index index = new Index(indexFolder, true);
 
```
 
````

 |

##### Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists)
```
public Index(String indexFolder, IndexSettings settings, boolean overwriteIfExists)
```

Initializes a new instance of the
Index
 class.
Loads an existing index from disk if
overwriteIfExists
 is
false
;
creates a new index on disk with particular index settings otherwise.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.
 |
| settings | IndexSettings | The index settings object.
 |
| overwriteIfExists | boolean | The flag of overwriting the index folder.

The example demonstrates how to create an index on a disk with particular index settings.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex);
 Index index = new Index(indexFolder, settings, true);
 
```
 
````

 |

##### getEvents()
```
public final EventHub getEvents()
```

Gets the event hub for subscribing to events.

**Returns:**
EventHub - The event hub for subscribing to events.

##### getIndexInfo()
```
public final IndexInfo getIndexInfo()
```

Gets the basic information on the index.

**Returns:**
IndexInfo - The basic information on the index.

##### getRepository()
```
public final IndexRepository getRepository()
```

Gets the index repository object if the index is contained in it.

**Returns:**
IndexRepository - The index repository object.

##### getIndexSettings()
```
public final IndexSettings getIndexSettings()
```

Gets the index settings.

**Returns:**
IndexSettings - The index settings.

##### getDictionaries()
```
public final DictionaryRepository getDictionaries()
```

Gets the dictionary repository.

**Returns:**
DictionaryRepository - The dictionary repository.

##### close()
```
public final void close()
```

Releases all resources used by the
Index
.

##### add(String path)
```
public final void add(String path)
```

Performs indexing operation.
Adds a file or folder by an absolute or relative path.
Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The path to a file or folder to be indexed.

The example demonstrates how to add documents to an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String folderPath = "c:\\MyDocuments\\";
 String filePath = "c:\\Documents\\MyFile.txt";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(folderPath); // Indexing documents in the specified folder
 index.add(filePath); // Indexing the specified document
 
```
 
````

 |

##### add(String path, IndexingOptions options)
```
public final void add(String path, IndexingOptions options)
```

Performs indexing operation.
Adds a file or folder by an absolute or relative path.
Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The path to a file or folder to be indexed.
 |
| options | IndexingOptions | The indexing options.

The example demonstrates how to add documents to an index with particular indexing options.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String folderPath = "c:\\MyDocuments\\";
 String filePath = "c:\\Documents\\MyFile.txt";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 IndexingOptions options = new IndexingOptions();
 options.setThreads(2); // Setting the number of indexing threads
 index.add(folderPath, options); // Indexing documents in the specified folder
 index.add(filePath, options); // Indexing the specified document
 
```
 
````

 |

##### add(String[] paths)
```
public final void add(String[] paths)
```

Performs indexing operation.
Adds files or folders by an absolute or relative path.
Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to a files or folders to be indexed.

The example demonstrates how to add documents to an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String folderPath = "c:\\MyDocuments\\";
 String filePath = "c:\\Documents\\MyFile.txt";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 String[] paths = new String[] { folderPath, filePath };
 index.add(paths); // Indexing documents at the specified paths
 
```
 
````

 |

##### add(String[] paths, IndexingOptions options)
```
public final void add(String[] paths, IndexingOptions options)
```

Performs indexing operation.
Adds files or folders by an absolute or relative path.
Documents from all subfolders will be indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to a files or folders to be indexed.
 |
| options | IndexingOptions | The indexing options.

The example demonstrates how to add documents to an index with particular indexing options.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String folderPath = "c:\\MyDocuments\\";
 String filePath = "c:\\Documents\\MyFile.txt";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 IndexingOptions options = new IndexingOptions();
 options.setThreads(2); // Setting the number of indexing threads
 String[] paths = new String[] { folderPath, filePath };
 index.add(paths, options); // Indexing documents at the specified paths
 
```
 
````

 |

##### add(Document[] documents, IndexingOptions options)
```
public final void add(Document[] documents, IndexingOptions options)
```

Performs indexing operation.
Adds documents from file system, stream or structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documents | Document\[\] | The documents from file system, stream or structure.
 |
| options | IndexingOptions | The indexing options.
 |

##### add(ExtractedData[] data, IndexingOptions options)
```
public final void add(ExtractedData[] data, IndexingOptions options)
```

Performs indexing operation.
Adds the extracted data to the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | ExtractedData\[\] | The extracted data.
 |
| options | IndexingOptions | The indexing options.
 |

##### update()
```
public final void update()
```

Re-indexes documents that have been changed or deleted since last update.
Adds new files that have been added to the indexed folders.

The example demonstrates how to update an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 // Delete documents from the documents folder or modify them or add new documents to the folder
 index.update(); // Updating the index
 
```
 
````

##### update(UpdateOptions options)
```
public final void update(UpdateOptions options)
```

Re-indexes documents that have been changed or deleted since last update.
Adds new files that have been added to the indexed folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options.

The example demonstrates how to update an index with particular update options.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 // Delete documents from the documents folder or modify them or add new documents to the folder
 UpdateOptions options = new UpdateOptions();
 options.setThreads(2); // Setting the number of indexing threads
 index.update(options); // Updating the index
 
```
 
````

 |

##### getIndexingReports()
```
public final IndexingReport[] getIndexingReports()
```

Gets the reports on indexing operations.

**Returns:**
com.groupdocs.search.common.IndexingReport[] - The indexing reports.

The example demonstrates how to get indexing reports.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 IndexingReport[] reports = index.getIndexingReports(); // Getting indexing reports
 
```
 
````

##### getSearchReports()
```
public final SearchReport[] getSearchReports()
```

Gets the reports on search operations.

**Returns:**
com.groupdocs.search.common.SearchReport[] - The search reports.

The example demonstrates how to get search reports.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query1 = "Einstein";
 String query2 = "Newton";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchResult result1 = index.search(query1); // Searching
 SearchResult result2 = index.search(query2);
 SearchResult result3 = index.search(query1 + " & " + query2);
 SearchReport[] reports = index.getSearchReports(); // Getting search reports
 
```
 
````

##### search(String query)
```
public final SearchResult search(String query)
```

Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.

The following example demonstrates how to perform simple search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchResult result = index.search(query); // Searching
 
```
 
````

The following example demonstrates how to perform Regex search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 String query = "^[0-9]{3,}"; // The caret symbol at the beginning of the search query tells the index that it is a Regex query
 SearchResult result = index.search(query); // Searching
 
```
 
````

The following example demonstrates how to perform faceted search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 String query = "content:Newton"; // The word before the colon in the query means the document field name to search
 SearchResult result = index.search(query); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(String query, SearchOptions options)
```
public final SearchResult search(String query, SearchOptions options)
```

Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.
 |
| options | SearchOptions | The search options.

The following example demonstrates how to perform fuzzy search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 options.getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1)); // Setting the number of possible differences for each word
 // Double quotes at the beginning and end tells the index that it is phrase search query
 String query = "\"The Pursuit of Happiness\"";
 SearchResult result = index.search(query, options); // Searching
 
```
 
````

The following example demonstrates how to perform synonym search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.setUseSynonymSearch(true); // Enabling the synonym search
 String query = "cry";
 SearchResult result = index.search(query, options); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(SearchQuery query)
```
public final SearchResult search(SearchQuery query)
```

Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query.

The following example demonstrates how to perform search using query in object form.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 // Creating subquery 1
 SearchQuery subquery1 = SearchQuery.createWordQuery("accommodation");
 subquery1.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 1
 subquery1.getSearchOptions().getFuzzySearch().setEnabled(true); // Enabling the fuzzy search
 subquery1.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(3)); // Setting maximum number of differences
 // Creating subquery 2
 SearchQuery subquery2 = SearchQuery.createNumericRangeQuery(1, 1000000);
 // Creating subquery 3
 SearchQuery subquery3 = SearchQuery.createRegexQuery("(.)\\1");
 // Combining subqueries into one query
 SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3);
 SearchResult result = index.search(query); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(SearchQuery query, SearchOptions options)
```
public final SearchResult search(SearchQuery query, SearchOptions options)
```

Searches in index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query.
 |
| options | SearchOptions | The search options.

The following example demonstrates how to perform search using query in object form.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 // Creating subquery of date range search
 SearchQuery subquery1 = SearchQuery.createDateRangeQuery(new Date(2011, 6, 17), new Date(2013, 1, 1));
 // Creating subquery of wildcard with number of missed words from 0 to 2
 SearchQuery subquery2 = SearchQuery.createWildcardQuery(0, 2);
 // Creating subquery of simple word
 SearchQuery subquery3 = SearchQuery.createWordQuery("birth");
 subquery3.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 3
 subquery3.getSearchOptions().getFuzzySearch().setEnabled(true);
 subquery3.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1));
 // Combining subqueries into one query
 SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3);
 // Creating search options object with increased capacity of found occurrences
 SearchOptions options = new SearchOptions(); // Overall search options
 options.setMaxOccurrenceCountPerTerm(1000000);
 options.setMaxTotalOccurrenceCount(10000000);
 SearchResult result = index.search(query, options); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(SearchImage image, ImageSearchOptions options)
```
public final ImageSearchResult search(SearchImage image, ImageSearchOptions options)
```

Performs a reverse image search in the index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | SearchImage | The image to search.
 |
| options | ImageSearchOptions | The image search options.
 |

**Returns:**
ImageSearchResult - The result of a reverse image search.

##### searchNext(ChunkSearchToken chunkSearchToken)
```
public final SearchResult searchNext(ChunkSearchToken chunkSearchToken)
```

Continues the chunk search started with method Search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | ChunkSearchToken | The chunk search token.

The example demonstrates how to perform chunk search.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.setChunkSearch(true); // Enabling chunk search
 SearchResult result = index.search(query, options); // Starting chunk search
 System.out.println("Document count: " + result.getDocumentCount());
 System.out.println("Occurrence count: " + result.getOccurrenceCount());
 while (result.getNextChunkSearchToken() != null) {
     result = index.searchNext(result.getNextChunkSearchToken()); // Continuing chunk search
     System.out.println("Document count: " + result.getDocumentCount());
     System.out.println("Occurrence count: " + result.getOccurrenceCount());
 }
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation)
```
public final SearchResult searchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation)
```

Continues the chunk search started with method Search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | ChunkSearchToken | The chunk search token.
 |
| cancellation | Cancellation | The cancellation object.

The example demonstrates how to perform search using query in object form.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 Cancellation cancellation = new Cancellation(); // This cancellation object aborts all search continuations if canceled
 SearchOptions options = new SearchOptions();
 options.setChunkSearch(true); // Enabling chunk search
 options.setCancellation(cancellation);
 SearchResult result = index.search(query, options); // Starting chunk search
 System.out.println("Document count: " + result.getDocumentCount());
 System.out.println("Occurrence count: " + result.getOccurrenceCount());
 while (result.getNextChunkSearchToken() != null) {
     result = index.searchNext(result.getNextChunkSearchToken(), cancellation); // Continuing chunk search
     System.out.println("Document count: " + result.getDocumentCount());
     System.out.println("Occurrence count: " + result.getOccurrenceCount());
 }
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### optimize()
```
public final void optimize()
```

Minimizes the number of index segments by merging them one with another.
This operation improves search performance.

The example demonstrates how to merge segments of an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 String documentsFolder3 = "c:\\MyDocuments3\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder1); // Indexing documents from the specified folder
 index.add(documentsFolder2); // Each call to AddToIndex creates at least one new segment in the index
 index.add(documentsFolder3);
 // Merging segments of the index
 index.optimize();
 
```
 
````

##### optimize(MergeOptions options)
```
public final void optimize(MergeOptions options)
```

Minimizes the number of index segments by merging them one with another.
This operation improves search performance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | MergeOptions | The merge options.

The example demonstrates how to merge segments of an index with particular merge options.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 String documentsFolder3 = "c:\\MyDocuments3\\";
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder1); // Indexing documents from the specified folder
 index.add(documentsFolder2); // Each call to AddToIndex creates at least one new segment in the index
 index.add(documentsFolder3);
 MergeOptions options = new MergeOptions();
 options.setAsync(true); // Asynchronous operation
 options.setCancellation(new Cancellation()); // Creating cancellation object
 // Merging segments of the index
 index.optimize(options); // This method will return before the operation is completed
 options.getCancellation().cancelAfter(10000); // Setting maximum duration of the operation to 10 seconds
 
```
 
````

 |

##### merge(Index index, MergeOptions options)
```
public final void merge(Index index, MergeOptions options)
```

Merges the specified index into the current index.
Note that the other index will not be changed.

If the other index has a previous version, it must be updated before merging with
IndexUpdater
.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | Index | The index to merge into.
 |
| options | MergeOptions | The merge options.

The example demonstrates how to merge an index into the current index.

````
 ```

 String indexFolder1 = "c:\\MyIndex1\\";
 String indexFolder2 = "c:\\MyIndex2\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 Index index1 = new Index(indexFolder1); // Creating index1
 index1.add(documentsFolder1); // Indexing documents
 Index index2 = new Index(indexFolder2); // Creating index2
 index2.add(documentsFolder2); // Indexing documents
 MergeOptions options = new MergeOptions();
 options.setCancellation(new Cancellation()); // Creating cancellation object
 // Merging index2 into index1. Note that index2 files will not be changed.
 index1.merge(index2, options);
 
```
 
````

 |

##### merge(IndexRepository repository, MergeOptions options)
```
public final void merge(IndexRepository repository, MergeOptions options)
```

Merges indexes from the specified index repository into the current index.
Note that indexes in the repository will not be changed.

If other indexes have a previous version, they must be updated before merging with
IndexUpdater
.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| repository | IndexRepository | The index repository to merge into.
 |
| options | MergeOptions | The merge options.

The example demonstrates how to merge an index repository into the current index.

````
 ```

 String indexFolder1 = "c:\\MyIndex1\\";
 String indexFolder2 = "c:\\MyIndex2\\";
 String indexFolder3 = "c:\\MyIndex3\\";
 String documentsFolder1 = "c:\\MyDocuments1\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 String documentsFolder3 = "c:\\MyDocuments3\\";
 Index index1 = new Index(indexFolder1); // Creating index1
 index1.add(documentsFolder1); // Indexing documents
 IndexRepository repository = new IndexRepository(); // Creating index repository
 Index index2 = repository.create(indexFolder2); // Creating index2
 index2.add(documentsFolder2); // Indexing documents
 Index index3 = repository.create(indexFolder3); // Creating index3
 index3.add(documentsFolder3); // Indexing documents
 MergeOptions options = new MergeOptions();
 options.setCancellation(new Cancellation()); // Creating cancellation object
 // Merging all indexes in the index repository into index1. Note that index2 and index3 will not be changed.
 index1.merge(repository, options);
 
```
 
````

 |

##### highlight(FoundDocument document, Highlighter highlighter)
```
public final void highlight(FoundDocument document, Highlighter highlighter)
```

Generates HTML formatted text with highlighted found terms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | FoundDocument | The found document.
 |
| highlighter | Highlighter | The search result highlighter.

The example demonstrates how to highlight occurrences in HTML formatted text.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentFolder);
 // Search for the word 'eternity'
 SearchResult result = index.search("eternity");
 // Highlighting occurrences in text
 if (result.getDocumentCount() > 0) {
     FoundDocument document = result.getFoundDocument(0); // Getting the first found document
     OutputAdapter outputAdapter = new FileOutputAdapter("c:\\Highlighted.html"); // Creating an output adapter to the file
     Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object
     index.highlight(document, highlighter); // Generating HTML formatted text with highlighted occurrences
 }
 
```
 
````

 |

##### highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options)
```
public final void highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options)
```

Generates HTML formatted text with highlighted found terms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | FoundDocument | The found document.
 |
| highlighter | Highlighter | The search result highlighter.
 |
| options | HighlightOptions | The highlight options.

The example demonstrates how to highlight occurrences in HTML formatted text.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentFolder = "c:\\MyDocuments\\";
 // Creating an index
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentFolder);
 // Search for the word 'eternity'
 SearchResult result = index.search("eternity");
 // Highlighting occurrences in text
 if (result.getDocumentCount() > 0) {
     FoundDocument document = result.getFoundDocument(0); // Getting the first found document
     OutputAdapter outputAdapter = new FileOutputAdapter("c:\\Highlighted.html"); // Creating an output adapter to the file
     Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object
     HighlightOptions options = new HighlightOptions(); // Creating the highlight options object
     options.setTermsBefore(5);
     options.setTermsAfter(5);
     options.setTermsTotal(15);
     index.highlight(document, highlighter, options); // Generating HTML formatted text with highlighted occurrences
 }
 
```
 
````

 |

##### getIndexedDocuments()
```
public final DocumentInfo[] getIndexedDocuments()
```

Gets an array of all indexed documents.

**Returns:**
com.groupdocs.search.results.DocumentInfo[] - An array of all indexed documents.

The example demonstrates how to get a list of indexed documents from an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Getting list of indexed documents
 DocumentInfo[] documents = index.getIndexedDocuments();
 
```
 
````

##### getIndexedDocumentItems(DocumentInfo documentInfo)
```
public final DocumentInfo[] getIndexedDocumentItems(DocumentInfo documentInfo)
```

Gets an array of a document items.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | A document info.

The example demonstrates how to get a list of items of an indexed document from an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Getting list of indexed documents
 DocumentInfo[] documents = index.getIndexedDocuments();
 for (int i = 0; i < documents.length; i++) {
     DocumentInfo document = documents[i];
     System.out.println(document.getFilePath());
     DocumentInfo[] items = index.getIndexedDocumentItems(document); // Getting list of document items
     for (int j = 0; j < items.length; j++) {
         DocumentInfo item = items[j];
         System.out.println("\t" + item.getInnerPath());
     }
 }
 
```
 
````

 |

**Returns:**
com.groupdocs.search.results.DocumentInfo[] - An array of a document items.

##### GetIndexedDocument(String documentKey)
```
public DocumentInfo GetIndexedDocument(String documentKey)
```

Gets an indexed document by document key.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | java.lang.String | The document key.
 |

**Returns:**
DocumentInfo - The indexed document.

##### getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter)
```
public final void getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter)
```

Generates the text of an indexed document and passes it through an output adapter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | The indexed document info.
 |
| adapter | OutputAdapter | The output adapter.

The example demonstrates how to get the text of an indexed document from an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folder
 index.add(documentsFolder);
 // Getting list of indexed documents
 DocumentInfo[] documents = index.getIndexedDocuments();
 // Getting a document text
 if (documents.length > 0) {
     FileOutputAdapter outputAdapter = new FileOutputAdapter("C:\\Text.html");
     index.getDocumentText(documents[0], outputAdapter);
 }
 
```
 
````

 |

##### getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options)
```
public final void getDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options)
```

Generates HTML formatted text for indexed document and transfers it through the output adapter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | The indexed document info.
 |
| adapter | OutputAdapter | The output adapter.
 |
| options | TextOptions | The text retrieving options.
 |

##### getIndexedPaths()
```
public final String[] getIndexedPaths()
```

Gets an array of indexed paths - documents or folders.

**Returns:**
java.lang.String[] - An array of indexed paths.

##### delete(String[] paths, UpdateOptions options)
```
public final DeleteResult delete(String[] paths, UpdateOptions options)
```

Deletes indexed files or folders from the index. Then updates the index without deleted paths.
Note that an individual document cannot be deleted from the index if it was added to the index as part of a folder.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| paths | java.lang.String[] | The paths to files or folders to delete.
 |
| options | UpdateOptions | The update options.

The example demonstrates how to delete indexed paths from an index.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder1 = "c:\\MyDocuments\\";
 String documentsFolder2 = "c:\\MyDocuments2\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents from the specified folders
 index.add(documentsFolder1);
 index.add(documentsFolder2);
 // Getting indexed paths from the index
 String[] indexedPaths1 = index.getIndexedPaths();
 // Writing indexed paths to the console
 System.out.println("Indexed paths:");
 for (String path : indexedPaths1) {
     System.out.println("\t" + path);
 }
 // Deleting index path from the index
 DeleteResult deleteResult = index.delete(new String[] { documentsFolder1 }, new UpdateOptions());
 // Getting indexed paths after deletion
 String[] indexedPaths2 = index.getIndexedPaths();
 System.out.println("\nDeleted paths: " + deleteResult.getSuccessCount());
 System.out.println("\nIndexed paths:");
 for (String path : indexedPaths2) {
     System.out.println("\t" + path);
 }
 
```
 
````

 |

**Returns:**
DeleteResult - An object describing the result of deleting files or folders from the index.

##### delete(UpdateOptions options, String[] documentKeys)
```
public final DeleteResult delete(UpdateOptions options, String[] documentKeys)
```

Deletes documents indexed from streams or structures. Then updates the index without deleted documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options.
 |
| documentKeys | java.lang.String[] | The keys of documents added from streams or structures.
 |

**Returns:**
DeleteResult - An object describing the result of deleting documents from the index.

##### notifyIndex(Notification notification)
```
public final boolean notifyIndex(Notification notification)
```

Passes the specified notification object to the index to perform the notification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| notification | Notification | The notification object.
 |

**Returns:**
boolean - Returns  true  if the notification was successfully performed; otherwise  false .

##### changeAttributes(AttributeChangeBatch batch)
```
public final void changeAttributes(AttributeChangeBatch batch)
```

Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| batch | AttributeChangeBatch | The attribute change batch.
 |

##### getAttributes(String path)
```
public final String[] getAttributes(String path)
```

Gets all the attributes associated with the specified indexed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | The document path.
 |

**Returns:**
java.lang.String[] - Attributes associated with the document.

##### loadIntoMemoryCompletely(String indexFolder)
```
public static Index loadIntoMemoryCompletely(String indexFolder)
```

Loads the entire index into memory.
Any changes to the index are not automatically saved to the original folder.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.
 |

**Returns:**
Index - The loaded in-memory index.

##### loadIntoMemoryCompletely(String indexFolder, IndexSettings settings)
```
public static Index loadIntoMemoryCompletely(String indexFolder, IndexSettings settings)
```

Loads the entire index into memory.
Any changes to the index are not automatically saved to the original folder.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder path.
 |
| settings | IndexSettings | The index settings object.
 |

**Returns:**
Index - The loaded in-memory index.

### IndexRepository
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/indexrepository.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class IndexRepository implements Closeable
```

Represents a container for combining multiple indexes and performing common operations on them.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder1 = "c:\\MyIndex\\";
 String indexFolder2 = "c:\\MyIndex\\";
 String query = "Einstein";
 IndexRepository repository = new IndexRepository();
 repository.addToRepository(indexFolder1); // Loading an existing index
 repository.addToRepository(indexFolder2); // Loading another existing index
 SearchResult result = repository.search(query); // Searching in indexes of the repository
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexRepository() | Initializes a new instance of the
IndexRepository
 class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEvents() | Gets the event hub for subscribing to events.
 |
| getIndexes() | Gets the indexes contained in this
IndexRepository
.
 |
| close() | Releases all resources used by the
IndexRepository
.
 |
| create() | Creates a new index in memory.
 |
| create(IndexSettings settings) | Creates a new index in memory.
 |
| create(String indexFolder) | Creates a new index on disk.
 |
| create(String indexFolder, IndexSettings settings) | Creates a new index on disk.
 |
| addToRepository(Index index) | Adds an index to the index repository.
 |
| addToRepository(String indexFolder) | Opens and adds an index to the index repository.
 |
| update() | Updates all indexes in the repository.
 |
| update(UpdateOptions options) | Updates all indexes in the repository.
 |
| search(String query) | Searches in all indexes of the repository.
 |
| search(String query, SearchOptions options) | Searches in all indexes of the repository.
 |
| search(SearchQuery query) | Searches in all indexes of the repository.
 |
| search(SearchQuery query, SearchOptions options) | Searches in all indexes of the repository.
 |
##### IndexRepository()
```
public IndexRepository()
```

Initializes a new instance of the
IndexRepository
 class.

##### getEvents()
```
public final EventHub getEvents()
```

Gets the event hub for subscribing to events.

**Returns:**
EventHub - The event hub for subscribing to events.

##### getIndexes()
```
public final Index[] getIndexes()
```

Gets the indexes contained in this
IndexRepository
.

**Returns:**
com.groupdocs.search.Index[] - The indexes.

##### close()
```
public final void close()
```

Releases all resources used by the
IndexRepository
.

##### create()
```
public final Index create()
```

Creates a new index in memory.

**Returns:**
Index - The created index.

The example demonstrates how to create an index in memory through the index repository.

````
 ```

 IndexRepository indexRepository = new IndexRepository();
 Index index = indexRepository.create();
 
```
 
````

##### create(IndexSettings settings)
```
public final Index create(IndexSettings settings)
```

Creates a new index in memory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| settings | IndexSettings | The index settings.

The example demonstrates how to create an index in memory through the index repository.

````
 ```

 IndexRepository indexRepository = new IndexRepository();
 IndexSettings settings = new IndexSettings();
 settings.setUseStopWords(false); // Disabling use of stop words during indexing
 Index index = indexRepository.create(settings);
 
```
 
````

 |

**Returns:**
Index - The created index.

##### create(String indexFolder)
```
public final Index create(String indexFolder)
```

Creates a new index on disk.
The index folder will be cleaned before the index creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder.

The example demonstrates how to create an index on disk through the index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexRepository indexRepository = new IndexRepository();
 Index index = indexRepository.create(indexFolder);
 
```
 
````

 |

**Returns:**
Index - The created index.

##### create(String indexFolder, IndexSettings settings)
```
public final Index create(String indexFolder, IndexSettings settings)
```

Creates a new index on disk.
The index folder will be cleaned before the index creation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder.
 |
| settings | IndexSettings | The index settings.

The example demonstrates how to create an index on disk through the index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexRepository indexRepository = new IndexRepository();
 IndexSettings settings = new IndexSettings();
 settings.setUseStopWords(false); // Disabling use of stop words during indexing
 Index index = indexRepository.create(indexFolder, settings);
 
```
 
````

 |

**Returns:**
Index - The created index.

##### addToRepository(Index index)
```
public final void addToRepository(Index index)
```

Adds an index to the index repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | Index | The index to add.

The example demonstrates how to add an index to the index repository.

````
 ```

 Index index = new Index();
 IndexRepository indexRepository = new IndexRepository();
 indexRepository.addToRepository(index);
 
```
 
````

 |

##### addToRepository(String indexFolder)
```
public final void addToRepository(String indexFolder)
```

Opens and adds an index to the index repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | java.lang.String | The index folder.

The example demonstrates how to add an index to the index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexRepository indexRepository = new IndexRepository();
 indexRepository.addToRepository(indexFolder);
 
```
 
````

 |

##### update()
```
public final void update()
```

Updates all indexes in the repository.

The example demonstrates how to update indexes in the repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 // Delete documents from the documents folder or modify them or add new documents to the folder
 repository.update();
 
```
 
````

##### update(UpdateOptions options)
```
public final void update(UpdateOptions options)
```

Updates all indexes in the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options.

The example demonstrates how to update indexes in the repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 // Delete documents from the documents folder or modify them or add new documents to the folder
 UpdateOptions options = new UpdateOptions();
 options.setThreads(2); // Setting the number of indexing threads
 repository.update(options);
 
```
 
````

 |

##### search(String query)
```
public final SearchResult search(String query)
```

Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.

The example demonstrates how to perform search in index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 SearchResult result = repository.search(query); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(String query, SearchOptions options)
```
public final SearchResult search(String query, SearchOptions options)
```

Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | java.lang.String | The search query.
 |
| options | SearchOptions | The search options.

The example demonstrates how to perform search in index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 SearchOptions options = new SearchOptions();
 options.setUseCaseSensitiveSearch(true); // Setting flag of case sensitive search
 SearchResult result = repository.search(query, options); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(SearchQuery query)
```
public final SearchResult search(SearchQuery query)
```

Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query.

The example demonstrates how to perform search in index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 SearchQuery query = SearchQuery.createWordQuery("Einstein"); // Creating search query in object form
 SearchResult result = repository.search(query); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

##### search(SearchQuery query, SearchOptions options)
```
public final SearchResult search(SearchQuery query, SearchOptions options)
```

Searches in all indexes of the repository.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query.
 |
| options | SearchOptions | The search options.

The example demonstrates how to perform search in index repository.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 IndexRepository repository = new IndexRepository();
 Index index = repository.create(indexFolder); // Creating index
 index.add(documentsFolder); // Indexing documents
 SearchOptions options = new SearchOptions();
 options.setUseCaseSensitiveSearch(true); // Setting flag of case sensitive search
 SearchQuery query = SearchQuery.createWordQuery("Einstein"); // Creating search query in object form
 SearchResult result = repository.search(query, options); // Searching
 
```
 
````

 |

**Returns:**
SearchResult - The search result.

### IndexSettings
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/indexsettings.md

**Inheritance:**
java.lang.Object
```
public class IndexSettings
```

Represents the index settings that allow to customize the indexing operations.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 IndexSettings settings = new IndexSettings();
 settings.setIndexType(IndexType.CompactIndex); // Setting the index type
 Index index = new Index(indexFolder, settings); // Creating an index
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexSettings() | Initializes a new instance of the  IndexSettings  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getInMemoryIndex() | Gets a value indicating whether the index is stored in memory or on disk.
 |
| getUseStopWords() | Gets a value indicating whether to use stop words or not.
 |
| setUseStopWords(boolean value) | Sets a value indicating whether to use stop words or not.
 |
| getMaxIndexingReportCount() | Gets the maximum number of indexing reports.
 |
| setMaxIndexingReportCount(int value) | Sets the maximum number of indexing reports.
 |
| getMaxSearchReportCount() | Gets the maximum number of search reports.
 |
| setMaxSearchReportCount(int value) | Sets the maximum number of search reports.
 |
| getUseCharacterReplacements() | Gets a value indicating whether to use character replacements or not.
 |
| setUseCharacterReplacements(boolean value) | Sets a value indicating whether to use character replacements or not.
 |
| getDocumentFilter() | Gets a document filter.
 |
| setDocumentFilter(DocumentFilter value) | Sets a document filter.
 |
| getTextStorageSettings() | Gets the text storage settings.
 |
| setTextStorageSettings(TextStorageSettings value) | Sets the text storage settings.
 |
| getIndexType() | Gets the index type.
 |
| setIndexType(IndexType value) | Sets the index type.
 |
| getSearchThreads() | Gets the number of threads used for the search.
 |
| setSearchThreads(NumberOfThreads value) | Sets the number of threads used for the search.
 |
| getCustomExtractors() | Gets the custom extractor collection.
 |
| getLogger() | Gets a logger that is used for logging events and errors in the index.
 |
| setLogger(ILogger value) | Sets a logger that is used for logging events and errors in the index.
 |
##### IndexSettings()
```
public IndexSettings()
```

Initializes a new instance of the  IndexSettings  class.

##### getInMemoryIndex()
```
public final boolean getInMemoryIndex()
```

Gets a value indicating whether the index is stored in memory or on disk.

**Returns:**
boolean - A value indicating whether the index is stored in memory or on disk.

##### getUseStopWords()
```
public final boolean getUseStopWords()
```

Gets a value indicating whether to use stop words or not. The default value is  true .

**Returns:**
boolean - A value indicating whether to use stop words or not.

##### setUseStopWords(boolean value)
```
public final void setUseStopWords(boolean value)
```

Sets a value indicating whether to use stop words or not. The default value is  true .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to use stop words or not.
 |

##### getMaxIndexingReportCount()
```
public final int getMaxIndexingReportCount()
```

Gets the maximum number of indexing reports. The default value is  5 .

**Returns:**
int - The maximum number of indexing reports.

##### setMaxIndexingReportCount(int value)
```
public final void setMaxIndexingReportCount(int value)
```

Sets the maximum number of indexing reports. The default value is  5 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of indexing reports.
 |

##### getMaxSearchReportCount()
```
public final int getMaxSearchReportCount()
```

Gets the maximum number of search reports. The default value is  10 .

**Returns:**
int - The maximum number of search reports.

##### setMaxSearchReportCount(int value)
```
public final void setMaxSearchReportCount(int value)
```

Sets the maximum number of search reports. The default value is  10 .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of search reports.
 |

##### getUseCharacterReplacements()
```
public final boolean getUseCharacterReplacements()
```

Gets a value indicating whether to use character replacements or not. The default value is  false .

**Returns:**
boolean - A value indicating whether to use character replacements or not.

##### setUseCharacterReplacements(boolean value)
```
public final void setUseCharacterReplacements(boolean value)
```

Sets a value indicating whether to use character replacements or not. The default value is  false .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether to use character replacements or not.
 |

##### getDocumentFilter()
```
public final DocumentFilter getDocumentFilter()
```

Gets a document filter. The  DocumentFilter  works on the inclusion logic. Use the  DocumentFilter  class for creation a document filter instance. The default value is  null , which means that all added documents are indexed.

**Returns:**
DocumentFilter - The document filter.

The example demonstrates how to set the document filter.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating a filter that skips documents with extensions '.doc', '.docx', '.rtf'
 IndexSettings settings = new IndexSettings();
 DocumentFilter fileExtensionFilter = DocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 DocumentFilter invertedFilter = DocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 settings.setDocumentFilter(invertedFilter);
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");
 
```
 
````

##### setDocumentFilter(DocumentFilter value)
```
public final void setDocumentFilter(DocumentFilter value)
```

Sets a document filter. The  DocumentFilter  works on the inclusion logic. Use the  GroupDocs.Search.Options.DocumentFilter  class for creation of a document filter instances. The default value is  null , which means that all added documents are indexed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DocumentFilter | The document filter.

The example demonstrates how to set the document filter.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating a filter that skips documents with extensions '.doc', '.docx', '.rtf'
 IndexSettings settings = new IndexSettings();
 DocumentFilter fileExtensionFilter = DocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 DocumentFilter invertedFilter = DocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 settings.setDocumentFilter(invertedFilter);
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");
 
```
 
````

 |

##### getTextStorageSettings()
```
public final TextStorageSettings getTextStorageSettings()
```

Gets the text storage settings. The default value is  null , which means that document texts are not stored.

**Returns:**
TextStorageSettings - The text storage settings.

The example demonstrates how to set the text storage settings.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating index settings instance
 IndexSettings settings = new IndexSettings();
 settings.setTextStorageSettings(new TextStorageSettings(Compression.High)); // Setting high compression level for the index text storage
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");
 
```
 
````

##### setTextStorageSettings(TextStorageSettings value)
```
public final void setTextStorageSettings(TextStorageSettings value)
```

Sets the text storage settings. The default value is  null , which means that document texts are not stored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TextStorageSettings | The text storage settings.

The example demonstrates how to set the text storage settings.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 // Creating index settings instance
 IndexSettings settings = new IndexSettings();
 settings.setTextStorageSettings(new TextStorageSettings(Compression.High)); // Setting high compression level for the index text storage
 // Creating an index in the specified folder
 Index index = new Index(indexFolder, settings);
 // Indexing documents
 index.add(documentsFolder);
 // Searching
 SearchResult result = index.search("Einstein");
 
```
 
````

 |

##### getIndexType()
```
public final IndexType getIndexType()
```

Gets the index type. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Returns:**
IndexType - The index type.

##### setIndexType(IndexType value)
```
public final void setIndexType(IndexType value)
```

Sets the index type. The default value is  GroupDocs.Search.Options.IndexType.NormalIndex .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IndexType | The index type.
 |

##### getSearchThreads()
```
public final NumberOfThreads getSearchThreads()
```

Gets the number of threads used for the search. The default value is  GroupDocs.Search.Options.NumberOfThreads.Default , which means that the search will be performed using the number of threads equal to the number of processor cores.

**Returns:**
NumberOfThreads - The number of threads used for the search.

##### setSearchThreads(NumberOfThreads value)
```
public final void setSearchThreads(NumberOfThreads value)
```

Sets the number of threads used for the search. The default value is  GroupDocs.Search.Options.NumberOfThreads.Default , which means that the search will be performed using the number of threads equal to the number of processor cores.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | NumberOfThreads | The number of threads used for the search.
 |

##### getCustomExtractors()
```
public final CustomExtractorCollection getCustomExtractors()
```

Gets the custom extractor collection. The full example of implementing a custom extractor is presented in documentation for  GroupDocs.Search.Common.IFieldExtractor  interface.

**Returns:**
CustomExtractorCollection - The custom extractor collection.

##### getLogger()
```
public final ILogger getLogger()
```

Gets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.

**Returns:**
ILogger - A logger that is used for logging events and errors in the index.

##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

Sets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ILogger | A logger that is used for logging events and errors in the index.
 |

### IndexUpdater
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/indexupdater.md

**Inheritance:**
java.lang.Object
```
public class IndexUpdater
```

Represents an index updater. This class performs reindexing documents in an index of an old version.

The example demonstrates a typical usage of the class.

````
 ```

 String sourceIndexFolder = "c:\\MyOldIndex\\";
 String targetIndexFolder = "c:\\MyNewIndex\\";
 IndexUpdater updater = new IndexUpdater();
 if (updater.canUpdateVersion(sourceIndexFolder)) {
     int result = updater.updateVersion(sourceIndexFolder, targetIndexFolder);
 }
 
```
 
````

#### Constructors

| Constructor | Description |
| --- | --- |
| IndexUpdater() | Initializes a new instance of the  IndexUpdater  class.
 |
#### Methods

| Method | Description |
| --- | --- |
| isLatestVersion(String indexPath) | Checks whether the specified directory contains an index of the latest version.
 |
| canUpdateVersion(String indexPath) | Checks whether an index in the specified directory can be updated to the latest version.
 |
| updateVersion(String indexPath, String newIndexPath) | Performs reindexing documents in an index of an old version.
 |
##### IndexUpdater()
```
public IndexUpdater()
```

Initializes a new instance of the  IndexUpdater  class.

##### isLatestVersion(String indexPath)
```
public final boolean isLatestVersion(String indexPath)
```

Checks whether the specified directory contains an index of the latest version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | java.lang.String | The index directory path.
 |

**Returns:**
boolean -  true  if the specified directory contains an index of the latest version; otherwise  false .

##### canUpdateVersion(String indexPath)
```
public final boolean canUpdateVersion(String indexPath)
```

Checks whether an index in the specified directory can be updated to the latest version.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | java.lang.String | The index directory path.
 |

**Returns:**
boolean -  true  if an index in the specified directory can be updated to the latest version; otherwise  false .

##### updateVersion(String indexPath, String newIndexPath)
```
public final VersionUpdateResult updateVersion(String indexPath, String newIndexPath)
```

Performs reindexing documents in an index of an old version. The updated index will be placed in the  newIndexPath  directory. The index in the  indexPath  directory will not be changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | java.lang.String | The index directory path.
 |
| newIndexPath | java.lang.String | The directory for the updated index.
 |

**Returns:**
VersionUpdateResult - The result of the index version update operation.

### LicenseRestrictionException
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/licenserestrictionexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.aspose.ms.System.ApplicationException
```
public class LicenseRestrictionException extends System.ApplicationException
```

The exception that is thrown when a license restriction is triggered.

#### Constructors

| Constructor | Description |
| --- | --- |
| LicenseRestrictionException(String message) | Initializes a new instance of the
LicenseRestrictionException
 class.
 |
##### LicenseRestrictionException(String message)
```
public LicenseRestrictionException(String message)
```

Initializes a new instance of the
LicenseRestrictionException
 class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The exception message.
 |

### Notification
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/notification.md

**Inheritance:**
java.lang.Object
```
public abstract class Notification
```

The base class for all notifications to the index. This class also contains methods for creating notification objects.

#### Constructors

| Constructor | Description |
| --- | --- |
| Notification() |  |
#### Methods

| Method | Description |
| --- | --- |
| createRenameNotification(String oldPath, String newPath) | Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed.
 |
##### Notification()
```
public Notification()
```

##### createRenameNotification(String oldPath, String newPath)
```
public static Notification createRenameNotification(String oldPath, String newPath)
```

Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed. The renamed document will not be reindexed during the next update operation, even if its contents have been changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| oldPath | java.lang.String | The old path to the indexed document.
 |
| newPath | java.lang.String | The new path to the indexed document.
 |

**Returns:**
Notification - A new rename notification object.

### PleaseReportException
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/pleasereportexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public class PleaseReportException extends RuntimeException
```

Represents the exception that is thrown when an error occurred in the library.

#### Constructors

| Constructor | Description |
| --- | --- |
| PleaseReportException(String message) | Initializes a new instance of the
PleaseReportException
 class.
 |
| PleaseReportException() | Initializes a new instance of the
PleaseReportException
 class.
 |
##### PleaseReportException(String message)
```
public PleaseReportException(String message)
```

Initializes a new instance of the
PleaseReportException
 class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message.
 |

##### PleaseReportException()
```
public PleaseReportException()
```

Initializes a new instance of the
PleaseReportException
 class.

### SearchDocumentFilter
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/searchdocumentfilter.md

**Inheritance:**
java.lang.Object
```
public class SearchDocumentFilter
```

Contains methods for creating search document filters.

#### Constructors

| Constructor | Description |
| --- | --- |
| SearchDocumentFilter() |  |
#### Methods

| Method | Description |
| --- | --- |
| createFilePathRegularExpression(String pattern) | Creates a filter for skipping documents that are not match a regular expression.
 |
| createFilePathRegularExpression(String pattern, int options) | Creates a filter for skipping documents that are not match a regular expression.
 |
| createFileExtension(String[] extensions) | Creates a filter for skipping documents that are not in the specified list of possible extensions.
 |
| createNot(ISearchDocumentFilter innerFilter) | Creates a filter that has inverse logic in relation to the specified inner filter.
 |
| createAnd(ISearchDocumentFilter[] filters) | Creates a logical conjunction of the specified filters.
 |
| createOr(ISearchDocumentFilter[] filters) | Creates a logical disjunction of the specified filters.
 |
| createAttribute(String[] attributes) | Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes.
 |
##### SearchDocumentFilter()
```
public SearchDocumentFilter()
```

##### createFilePathRegularExpression(String pattern)
```
public static ISearchDocumentFilter createFilePathRegularExpression(String pattern)
```

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern.
 |

**Returns:**
ISearchDocumentFilter - A search document filter by file name.

##### createFilePathRegularExpression(String pattern, int options)
```
public static ISearchDocumentFilter createFilePathRegularExpression(String pattern, int options)
```

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern.
 |
| options | int | The regular expression options.
 |

**Returns:**
ISearchDocumentFilter - A search document filter by file name.

##### createFileExtension(String[] extensions)
```
public static ISearchDocumentFilter createFileExtension(String[] extensions)
```

Creates a filter for skipping documents that are not in the specified list of possible extensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extensions | java.lang.String[] | The list of possible extensions.
 |

**Returns:**
ISearchDocumentFilter - A search document filter by document extension.

##### createNot(ISearchDocumentFilter innerFilter)
```
public static ISearchDocumentFilter createNot(ISearchDocumentFilter innerFilter)
```

Creates a filter that has inverse logic in relation to the specified inner filter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerFilter | ISearchDocumentFilter | The inner search document filter.
 |

**Returns:**
ISearchDocumentFilter - An inverted search document filter.

##### createAnd(ISearchDocumentFilter[] filters)
```
public static ISearchDocumentFilter createAnd(ISearchDocumentFilter[] filters)
```

Creates a logical conjunction of the specified filters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filters | ISearchDocumentFilter\[\] | The search document filters.
 |

**Returns:**
ISearchDocumentFilter - A search document filter that represents result of conjunction of the specified filters.

##### createOr(ISearchDocumentFilter[] filters)
```
public static ISearchDocumentFilter createOr(ISearchDocumentFilter[] filters)
```

Creates a logical disjunction of the specified filters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filters | ISearchDocumentFilter\[\] | The search document filters.
 |

**Returns:**
ISearchDocumentFilter - A search document filter that represents result of disjunction of the specified filters.

##### createAttribute(String[] attributes)
```
public static ISearchDocumentFilter createAttribute(String[] attributes)
```

Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attributes | java.lang.String[] | The list of allowable attributes.
 |

**Returns:**
ISearchDocumentFilter - A search document filter by document attribute.

### SearchQuery
Path: https://reference.groupdocs.com/search/java/com.groupdocs.search/searchquery.md

**Inheritance:**
java.lang.Object
```
public abstract class SearchQuery
```

Represents a search query in object form.

The example demonstrates a typical usage of the class.

````
 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 
 Index index = new Index(indexFolder); // Creating index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 
 // Creating subquery of date range search
 SearchQuery subquery1 = SearchQuery.createDateRangeQuery(new Date(2011, 6, 17), new Date(2013, 1, 1));
 
 // Creating subquery of wildcard with number of missed words from 0 to 2
 SearchQuery subquery2 = SearchQuery.createWildcardQuery(0, 2);
 
 // Creating subquery of simple word
 SearchQuery subquery3 = SearchQuery.createWordQuery("birth");
 subquery3.setSearchOptions(new SearchOptions()); // Setting search options only for subquery 3
 subquery3.getSearchOptions().getFuzzySearch().setEnabled(true);
 subquery3.getSearchOptions().getFuzzySearch().setFuzzyAlgorithm(new TableDiscreteFunction(1));
 
 // Combining subqueries into one query
 SearchQuery query = SearchQuery.createPhraseSearchQuery(subquery1, subquery2, subquery3);
 
 // Creating search options object with increased capacity of found occurrences
 SearchOptions options = new SearchOptions(); // Overall search options
 options.setMaxOccurrenceCountPerTerm(1000000);
 options.setMaxTotalOccurrenceCount(10000000);
 
 SearchResult result = index.search(query, options); // Searching
 
```
 
````

#### Methods

| Method | Description |
| --- | --- |
| getFieldName() | Gets the field name.
 |
| getChildCount() | Gets the number of child queries.
 |
| getFirstChild() | Gets the first child query.
 |
| getSecondChild() | Gets the second child query.
 |
| getChild(int index) | Gets a child query by an index.
 |
| getSearchOptions() | Gets or sets the search options of this seach query.
 |
| setSearchOptions(SearchOptions value) | Gets or sets the search options of this seach query.
 |
| toString() | Returns a  System.String  that represents the current  SearchQuery  instance.
 |
| createWordQuery(String term) | Creates a simple word query.
 |
| createWordPatternQuery(WordPattern pattern) | Creates a word pattern query.
 |
| createRegexQuery(String pattern) | Creates a regular expression query.
 |
| createRegexQuery(String pattern, int options) | Creates a regular expression query.
 |
| createNumericRangeQuery(long start, long end) | Creates a numeric range query.
 |
| createDateRangeQuery(Date start, Date end) | Creates a date range query.
 |
| createPhraseSearchQuery(SearchQuery[] queries) | Creates a phrase search query.
 |
| createAndQuery(SearchQuery[] queries) | Creates a combined query that will find only documents which will be found for each original query.
 |
| createFieldQuery(String fieldName, SearchQuery query) | Adds a field to the specified query.
 |
| createNotQuery(SearchQuery query) | Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query.
 |
| createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery) | Creates a combined query that will find only documents which will be found for each original query.
 |
| createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery) | Creates a combined query that will find all the documents which will be found at least for one of the original queries.
 |
| createOrQuery(SearchQuery[] queries) | Creates a combined query that will find all the documents which will be found at least for one of the original queries.
 |
| createWildcardQuery(int count) | Creates a wildcard for the phrase search.
 |
| createWildcardQuery(int minCount, int maxCount) | Creates a wildcard for the phrase search.
 |
##### getFieldName()
```
public String getFieldName()
```

Gets the field name.

**Returns:**
java.lang.String - The field name.

##### getChildCount()
```
public int getChildCount()
```

Gets the number of child queries.

**Returns:**
int - The number of child queries.

##### getFirstChild()
```
public SearchQuery getFirstChild()
```

Gets the first child query.

**Returns:**
SearchQuery - The first child query.

##### getSecondChild()
```
public SearchQuery getSecondChild()
```

Gets the second child query.

**Returns:**
SearchQuery - The second child query.

##### getChild(int index)
```
public abstract SearchQuery getChild(int index)
```

Gets a child query by an index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The index.
 |

**Returns:**
SearchQuery - A child query corresponding the specified index.

##### getSearchOptions()
```
public final SearchOptions getSearchOptions()
```

Gets or sets the search options of this seach query.

**Returns:**
SearchOptions - The search options.

##### setSearchOptions(SearchOptions value)
```
public final void setSearchOptions(SearchOptions value)
```

Gets or sets the search options of this seach query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SearchOptions | The search options.
 |

##### toString()
```
public abstract String toString()
```

Returns a  System.String  that represents the current  SearchQuery  instance.

**Returns:**
java.lang.String - A  System.String  that represents the current  SearchQuery  instance.

##### createWordQuery(String term)
```
public static SearchQuery createWordQuery(String term)
```

Creates a simple word query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| term | java.lang.String | The term to search for.
 |

**Returns:**
SearchQuery - A simple word query.

##### createWordPatternQuery(WordPattern pattern)
```
public static SearchQuery createWordPatternQuery(WordPattern pattern)
```

Creates a word pattern query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | WordPattern | The word pattern.
 |

**Returns:**
SearchQuery - A word pattern query.

##### createRegexQuery(String pattern)
```
public static SearchQuery createRegexQuery(String pattern)
```

Creates a regular expression query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern to match.
 |

**Returns:**
SearchQuery - A regular expression query.

##### createRegexQuery(String pattern, int options)
```
public static SearchQuery createRegexQuery(String pattern, int options)
```

Creates a regular expression query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.lang.String | The regular expression pattern to match.
 |
| options | int | A bitwise combination of the enumeration values that modify the regular expression. This value must contain  RegexOptions.IgnoreCase  flag.
 |

**Returns:**
SearchQuery - A regular expression query.

##### createNumericRangeQuery(long start, long end)
```
public static SearchQuery createNumericRangeQuery(long start, long end)
```

Creates a numeric range query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| start | long | The start value of a range.
 |
| end | long | The end value of a range.
 |

**Returns:**
SearchQuery - A numeric range query.

##### createDateRangeQuery(Date start, Date end)
```
public static SearchQuery createDateRangeQuery(Date start, Date end)
```

Creates a date range query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| start | java.util.Date | The start value of a range.
 |
| end | java.util.Date | The end value of a range.
 |

**Returns:**
SearchQuery - A date range query.

##### createPhraseSearchQuery(SearchQuery[] queries)
```
public static SearchQuery createPhraseSearchQuery(SearchQuery[] queries)
```

Creates a phrase search query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery\[\] | The child queries.
 |

**Returns:**
SearchQuery - A phrase search query.

##### createAndQuery(SearchQuery[] queries)
```
public static SearchQuery createAndQuery(SearchQuery[] queries)
```

Creates a combined query that will find only documents which will be found for each original query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery\[\] | The field name to search in.
 |

**Returns:**
SearchQuery - A combined AND query.

##### createFieldQuery(String fieldName, SearchQuery query)
```
public static SearchQuery createFieldQuery(String fieldName, SearchQuery query)
```

Adds a field to the specified query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fieldName | java.lang.String | The field name to search in.
 |
| query | SearchQuery | The query to add the field.
 |

**Returns:**
SearchQuery - A query with the field to search in.

##### createNotQuery(SearchQuery query)
```
public static SearchQuery createNotQuery(SearchQuery query)
```

Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The query to invert.
 |

**Returns:**
SearchQuery - A combined NOT query.

##### createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```
public static SearchQuery createAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```

Creates a combined query that will find only documents which will be found for each original query.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftQuery | SearchQuery | The left child query.
 |
| rightQuery | SearchQuery | The right child query.
 |

**Returns:**
SearchQuery - A combined AND query.

##### createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```
public static SearchQuery createOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```

Creates a combined query that will find all the documents which will be found at least for one of the original queries.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftQuery | SearchQuery | The left child query.
 |
| rightQuery | SearchQuery | The right child query.
 |

**Returns:**
SearchQuery - A combined OR query.

##### createOrQuery(SearchQuery[] queries)
```
public static SearchQuery createOrQuery(SearchQuery[] queries)
```

Creates a combined query that will find all the documents which will be found at least for one of the original queries.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery\[\] | The child queries.
 |

**Returns:**
SearchQuery - A combined OR query.

##### createWildcardQuery(int count)
```
public static SearchQuery createWildcardQuery(int count)
```

Creates a wildcard for the phrase search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| count | int | The number of words in the wildcard.
 |

**Returns:**
SearchQuery - A wildcard for the phrase search.

##### createWildcardQuery(int minCount, int maxCount)
```
public static SearchQuery createWildcardQuery(int minCount, int maxCount)
```

Creates a wildcard for the phrase search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| minCount | int | The minimum number of words in the wildcard.
 |
| maxCount | int | The maximum number of words in the wildcard.
 |

**Returns:**
SearchQuery - A wildcard for the phrase search.

## .NET

### GroupDocs.Search for .NET
Path: https://reference.groupdocs.com/search/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Search | The namespace provides classes for indexing and searching text data in documents of different formats. The main classes in this namespace are: |
| GroupDocs.Search.Common | The namespace provides common classes of the library. |
| GroupDocs.Search.Dictionaries | The namespace provides classes of various dictionaries. |
| GroupDocs.Search.Events | The namespace provides classes of event arguments. |
| GroupDocs.Search.Exceptions | The namespace provides exception classes. |
| GroupDocs.Search.Highlighters | The namespace provides highlighters for highlighting search results in text. |
| GroupDocs.Search.Options | The namespace provides classes to specify additional options of various operations. |
| GroupDocs.Search.Results | The namespace provides search result classes. |
| GroupDocs.Search.Scaling | The namespace provides classes of scaling functionality. |
| GroupDocs.Search.Scaling.Configuring | The namespace provides classes for configuring the search network. |
| GroupDocs.Search.Scaling.Events | The namespace provides classes of event arguments in the search network. |
| GroupDocs.Search.Scaling.Results | The namespace provides the search result classes in the search network. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### GroupDocs.Search.Common
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common.md

The namespace provides common classes of the library.

#### Classes

| Class | Description |
| --- | --- |
| AttributeChangeBatch | Represents a container for attribute changes. |
| Cancellation | Represents an object for requesting cancellation of an operation. |
| ChunkSearchToken | Represents a token for the continuation of the chunk search (search by pages). |
| CustomExtractorCollection | Contains a collection of custom extractors. If the collection contains an extractor for some file extension that is covered by build-in extractors, then this extractor will be used instead of built-in one. |
| Document | Represents the base class for documents added to an index from file system, stream, or structure. Contains static methods for creating documents from different types of sources. |
| DocumentField | Represents a document field data. |
| DocumentImage | Represents a document image data. |
| Encodings | Contains names of possible encodings. |
| ExtractedData | Represents data retrieved from a document and prepared for indexing. |
| ExtractedItemInfo | Represents a container item information. |
| ExtractorSettings | Contains settings for the document data extractor. |
| FileLogger | Represents a logger that logs events and errors to a local file. |
| FileOutputAdapter | Represents an output adapter that collects output into a file. |
| FragmentContainer | Represents a container for text fragments with highlighted found terms of one document field. |
| ImageFrame | Represents an image frame. |
| IndexInfo | Contains basic information on an Index. |
| IndexingReport | Represents a detailed information on an indexing operation. |
| Notification | The base class for all notifications to the index. This class also contains methods for creating notification objects. |
| OutputAdapter | Represents the base class of an output adapter that is used to collect an output in a generalized form. The currently available adapters are `FileOutputAdapter`, `StreamOutputAdapter`, `StructureOutputAdapter`, and `StringOutputAdapter`. |
| ResultBuilderFactory | Represents the base class of a result builder factory. |
| SearchImage | Represents an image to search. |
| SearchReport | Represents a detailed information on a search operation. |
| StreamOutputAdapter | Represents an output adapter that collects output into a Stream. |
| StringOutputAdapter | Represents an output adapter that collects output as a String. |
| StructureOutputAdapter | Represents an output adapter that collects output as a structure containing each field separately. |
| WordPattern | Represents a word pattern to use in word wildcard search. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IContainerItemExtractor | Provides methods for extracting items from container documents. |
| IDocumentLoader | Defines the document loader interface that is used to load lazy documents. |
| IFieldExtractor | Provides methods for extracting fields from a document. |
| ILogger | Defines interface of a logger that is used for logging events and errors in an index. |
| IWordSplitter | Defines a method for splitting text into individual words. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| DocumentSourceKind | Defines the kinds of document sources. |
| DocumentStatus | Represents a document processing status. |
| IndexStatus | Specifies an index status. |
| VersionUpdateResult | Represents the result of an index version update operation. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### AttributeChangeBatch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch.md

#### AttributeChangeBatch class

Represents a container for attribute changes.

```csharp
public class AttributeChangeBatch
```

#### Constructors

| Name | Description |
| --- | --- |
| AttributeChangeBatch() | Initializes a new instance of the `AttributeChangeBatch` class. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string, params string[]) | Adds the specified attributes to the specified indexed document. |
| Add(string[], params string[]) | Adds the specified attributes to the specified indexed documents. |
| AddToAll(params string[]) | Adds the specified attributes to all documents in the index. |
| Clear() | Removes all attributes from all documents in the index. |
| Remove(string, params string[]) | Removes the specified attributes from the specified indexed document. |
| Remove(string[], params string[]) | Removes the specified attributes from the specified indexed documents. |
| RemoveAll(string) | Removes all attributes from the specified indexed document. |
| RemoveAll(string[]) | Removes all attributes from the specified indexed documents. |
| RemoveFromAll(params string[]) | Removes the specified attributes from all documents in the index. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/add.md

#### Add(string, params string[])

Adds the specified attributes to the specified indexed document.

```csharp
public void Add(string path, params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The document path. |
| attributes | String[] | The attributes to add. |

#### Add(string[], params string[])

Adds the specified attributes to the specified indexed documents.

```csharp
public void Add(string[] paths, params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The documents paths. |
| attributes | String[] | The attributes to add. |

### AddToAll
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/addtoall.md

#### AttributeChangeBatch.AddToAll method

Adds the specified attributes to all documents in the index.

```csharp
public void AddToAll(params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attributes | String[] | The attributes to add. |

### AttributeChangeBatch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/attributechangebatch.md

#### AttributeChangeBatch constructor

Initializes a new instance of the `AttributeChangeBatch` class.

```csharp
public AttributeChangeBatch()
```

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/clear.md

#### AttributeChangeBatch.Clear method

Removes all attributes from all documents in the index.

```csharp
public void Clear()
```

### Remove
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/remove.md

#### Remove(string, params string[])

Removes the specified attributes from the specified indexed document.

```csharp
public void Remove(string path, params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The document path. |
| attributes | String[] | The attributes to remove. |

#### Remove(string[], params string[])

Removes the specified attributes from the specified indexed documents.

```csharp
public void Remove(string[] paths, params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The documents paths. |
| attributes | String[] | The attributes to remove. |

### RemoveAll
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/removeall.md

#### RemoveAll(string)

Removes all attributes from the specified indexed document.

```csharp
public void RemoveAll(string path)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The document path. |

#### RemoveAll(string[])

Removes all attributes from the specified indexed documents.

```csharp
public void RemoveAll(string[] paths)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The documents paths. |

### RemoveFromAll
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/attributechangebatch/removefromall.md

#### AttributeChangeBatch.RemoveFromAll method

Removes the specified attributes from all documents in the index.

```csharp
public void RemoveFromAll(params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attributes | String[] | The attributes to remove. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/cancellation.md

#### Cancellation class

Represents an object for requesting cancellation of an operation.

```csharp
public class Cancellation
```

#### Constructors

| Name | Description |
| --- | --- |
| Cancellation() | Initializes a new instance of the `Cancellation` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsCancelled { get; } | Gets a value indicating that cancellation has been requested. |

#### Methods

| Name | Description |
| --- | --- |
| Cancel() | Makes a request for cancellation. |
| CancelAfter(int) | Makes a request for cancellation after the expiration of specified number of milliseconds. |

### Cancel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/cancellation/cancel.md

#### Cancellation.Cancel method

Makes a request for cancellation.

```csharp
public void Cancel()
```

### CancelAfter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/cancellation/cancelafter.md

#### Cancellation.CancelAfter method

Makes a request for cancellation after the expiration of specified number of milliseconds.

```csharp
public void CancelAfter(int milliseconds)
```

| Parameter | Type | Description |
| --- | --- | --- |
| milliseconds | Int32 | The number of milliseconds after which an operation will be cancelled. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/cancellation/cancellation.md

#### Cancellation constructor

Initializes a new instance of the `Cancellation` class.

```csharp
public Cancellation()
```

### IsCancelled
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/cancellation/iscancelled.md

#### Cancellation.IsCancelled property

Gets a value indicating that cancellation has been requested.

```csharp
public bool IsCancelled { get; }
```

##### Property Value

A value indicating that cancellation has been requested.

### ChunkSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/chunksearchtoken.md

#### ChunkSearchToken class

Represents a token for the continuation of the chunk search (search by pages).

```csharp
public class ChunkSearchToken
```

### CustomExtractorCollection
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection.md

#### CustomExtractorCollection class

Contains a collection of custom extractors. If the collection contains an extractor for some file extension that is covered by build-in extractors, then this extractor will be used instead of built-in one.

```csharp
public class CustomExtractorCollection : ICollection<IFieldExtractor>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of extractors contained in the collection. |
| IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |

#### Methods

| Name | Description |
| --- | --- |
| Add(IFieldExtractor) | Adds an extractor to the collection. |
| Clear() | Removes all extractors from the collection. |
| Contains(IFieldExtractor) | Determines whether the collection contains a specific extractor. |
| CopyTo(IFieldExtractor[], int) | Copies the elements of the collection to an array, starting at a particular array index. |
| GetEnumerator() | Returns an enumerator for this collection. |
| Remove(IFieldExtractor) | Removes an extractor from the collection. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/add.md

#### CustomExtractorCollection.Add method

Adds an extractor to the collection.

```csharp
public void Add(IFieldExtractor extractor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extractor | IFieldExtractor | The extractor to add to the collection. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/clear.md

#### CustomExtractorCollection.Clear method

Removes all extractors from the collection.

```csharp
public void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/contains.md

#### CustomExtractorCollection.Contains method

Determines whether the collection contains a specific extractor.

```csharp
public bool Contains(IFieldExtractor item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | IFieldExtractor | The extractor to locate in the collection. |

##### Return Value

`true` if *item* is found in the collection; otherwise, `false`.

### CopyTo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/copyto.md

#### CustomExtractorCollection.CopyTo method

Copies the elements of the collection to an array, starting at a particular array index.

```csharp
public void CopyTo(IFieldExtractor[] array, int arrayIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | IFieldExtractor[] | The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing. |
| arrayIndex | Int32 | The zero-based index in array at which copying begins. |

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/count.md

#### CustomExtractorCollection.Count property

Gets the number of extractors contained in the collection.

```csharp
public int Count { get; }
```

##### Property Value

The number of extractors contained in the collection.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/getenumerator.md

#### CustomExtractorCollection.GetEnumerator method

Returns an enumerator for this collection.

```csharp
public IEnumerator<IFieldExtractor> GetEnumerator()
```

##### Return Value

An IEnumerator object that can be used to iterate through the collection.

### IsReadOnly
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/isreadonly.md

#### CustomExtractorCollection.IsReadOnly property

Gets a value indicating whether the collection is read-only.

```csharp
public bool IsReadOnly { get; }
```

##### Property Value

A value indicating whether the collection is read-only.

### Remove
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/customextractorcollection/remove.md

#### CustomExtractorCollection.Remove method

Removes an extractor from the collection.

```csharp
public bool Remove(IFieldExtractor extractor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extractor | IFieldExtractor | The extractor to remove from the collection. |

##### Return Value

`true` if *extractor* was successfully removed from the collection; otherwise, `false`. This method also returns `false` if *extractor* is not found in the original collection.

### Document
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document.md

#### Document class

Represents the base class for documents added to an index from file system, stream, or structure. Contains static methods for creating documents from different types of sources.

```csharp
public abstract class Document
```

#### Properties

| Name | Description |
| --- | --- |
| virtual AdditionalFields { get; set; } | Gets or sets the additional fields for the document. |
| virtual Attributes { get; set; } | Gets or sets the attributes of the document. |
| abstract DocumentKey { get; } | Gets the document key that is used to identify the document within an index. |
| abstract DocumentSourceKind { get; } | Gets the document source kind. |
| abstract Extension { get; } | Gets the extension used for this document type. |
| abstract IsLazy { get; } | Gets a value indicating whether the document is loaded as needed or not. |
| abstract ModificationDate { get; } | Gets the last modification date of the document. |

#### Methods

| Name | Description |
| --- | --- |
| static CreateFromFile(string) | Creates a document from a file. |
| static CreateFromStream(string, DateTime, string, Stream) | Creates a document from a stream. |
| static CreateFromStructure(string, DateTime, DocumentField[]) | Creates a document from a structure that is an array of text fields. |
| static CreateLazy(DocumentSourceKind, string, IDocumentLoader) | Creates a lazy-loaded document. |
| override ToString() | Returns a String that represents the current `Document`. |

### AdditionalFields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/additionalfields.md

#### Document.AdditionalFields property

Gets or sets the additional fields for the document.

```csharp
public virtual DocumentField[] AdditionalFields { get; set; }
```

##### Property Value

The additional fields for the document.

### Attributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/attributes.md

#### Document.Attributes property

Gets or sets the attributes of the document.

```csharp
public virtual string[] Attributes { get; set; }
```

##### Property Value

The attributes of the document.

### CreateFromFile
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/createfromfile.md

#### Document.CreateFromFile method

Creates a document from a file.

```csharp
public static Document CreateFromFile(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The document file path. |

##### Return Value

The created document.

### CreateFromStream
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/createfromstream.md

#### Document.CreateFromStream method

Creates a document from a stream.

```csharp
public static Document CreateFromStream(string documentKey, DateTime modificationDate, 
    string extension, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | String | The document key. |
| modificationDate | DateTime | The document modification date. |
| extension | String | The document extension. The extension must start with the period character '.'. |
| stream | Stream | The document stream. |

##### Return Value

The created document.

### CreateFromStructure
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/createfromstructure.md

#### Document.CreateFromStructure method

Creates a document from a structure that is an array of text fields.

```csharp
public static Document CreateFromStructure(string documentKey, DateTime modificationDate, 
    DocumentField[] fields)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | String | The document key. |
| modificationDate | DateTime | The document modification date. |
| fields | DocumentField[] | The document fields. |

##### Return Value

The created document.

### CreateLazy
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/createlazy.md

#### Document.CreateLazy method

Creates a lazy-loaded document.

```csharp
public static Document CreateLazy(DocumentSourceKind documentSourceKind, string documentKey, 
    IDocumentLoader documentLoader)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentSourceKind | DocumentSourceKind | The document source kind. This value must match the kind of the loaded document. |
| documentKey | String | The document key. This value must match the key of the loaded document. |
| documentLoader | IDocumentLoader | The document loader. |

##### Return Value

The created document.

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/documentkey.md

#### Document.DocumentKey property

Gets the document key that is used to identify the document within an index.

```csharp
public abstract string DocumentKey { get; }
```

##### Property Value

The document key that is used to identify the document within an index.

### DocumentSourceKind
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/documentsourcekind.md

#### Document.DocumentSourceKind property

Gets the document source kind.

```csharp
public abstract DocumentSourceKind DocumentSourceKind { get; }
```

##### Property Value

The document source kind.

### Extension
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/extension.md

#### Document.Extension property

Gets the extension used for this document type.

```csharp
public abstract string Extension { get; }
```

##### Property Value

The extension used for this document type.

### IsLazy
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/islazy.md

#### Document.IsLazy property

Gets a value indicating whether the document is loaded as needed or not.

```csharp
public abstract bool IsLazy { get; }
```

##### Property Value

A value indicating whether the document is loaded as needed or not.

### ModificationDate
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/modificationdate.md

#### Document.ModificationDate property

Gets the last modification date of the document.

```csharp
public abstract DateTime ModificationDate { get; }
```

##### Property Value

The last modification date of the document.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/document/tostring.md

#### Document.ToString method

Returns a String that represents the current `Document`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `Document`.

### DocumentField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentfield.md

#### DocumentField class

Represents a document field data.

```csharp
public class DocumentField
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentField(string, string) | Initializes a new instance of the `DocumentField` class. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Gets a field name. |
| Value { get; } | Gets a field value. |

### DocumentField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentfield/documentfield.md

#### DocumentField constructor

Initializes a new instance of the `DocumentField` class.

```csharp
public DocumentField(string name, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The field name. |
| value | String | The field value. |

### Name
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentfield/name.md

#### DocumentField.Name property

Gets a field name.

```csharp
public string Name { get; }
```

##### Property Value

The field name.

### Value
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentfield/value.md

#### DocumentField.Value property

Gets a field value.

```csharp
public string Value { get; }
```

##### Property Value

The field value.

### DocumentImage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentimage.md

#### DocumentImage class

Represents a document image data.

```csharp
public class DocumentImage
```

#### Properties

| Name | Description |
| --- | --- |
| Fields { get; } | Gets the extracted fields. |
| Frames { get; } | Gets the image frames. |
| ImageIndex { get; } | Gets the ordinal number of the image in the document. |

### Fields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentimage/fields.md

#### DocumentImage.Fields property

Gets the extracted fields.

```csharp
public DocumentField[] Fields { get; }
```

##### Property Value

The extracted fields.

### Frames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentimage/frames.md

#### DocumentImage.Frames property

Gets the image frames.

```csharp
public ImageFrame[] Frames { get; }
```

##### Property Value

The image frames.

### ImageIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentimage/imageindex.md

#### DocumentImage.ImageIndex property

Gets the ordinal number of the image in the document.

```csharp
public int ImageIndex { get; }
```

##### Property Value

The ordinal number of the image in the document.

### DocumentSourceKind
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentsourcekind.md

#### DocumentSourceKind enumeration

Defines the kinds of document sources.

```csharp
public enum DocumentSourceKind
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| File | `0` | The file document source. |
| Stream | `1` | The stream document source. |
| Structure | `2` | The structure document source. |
| ExtractedData | `3` | The document source of previously extracted data. |
| TempFile | `4` | The temp file document source. |

### DocumentStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/documentstatus.md

#### DocumentStatus enumeration

Represents a document processing status.

```csharp
public enum DocumentStatus
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| SuccessfullyProcessed | `0` | Document successfully indexed. |
| Skipped | `1` | Document skipped. |
| ProcessedWithError | `2` | Error occurred during document indexing. |

### Encodings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings.md

#### Encodings class

Contains names of possible encodings.

```csharp
public static class Encodings
```

#### Fields

| Name | Description |
| --- | --- |
| const ASMO_708 | The ASMO-708 encoding. |
| const big5 | The big5 encoding. |
| const cp1025 | The cp1025 encoding. |
| const cp866 | The cp866 encoding. |
| const cp875 | The cp875 encoding. |
| const csISO2022JP | The csISO2022JP encoding. |
| const DOS_720 | The DOS-720 encoding. |
| const DOS_862 | The DOS-862 encoding. |
| const EUC_CN | The EUC-CN encoding. |
| const EUC_JP | The EUC-JP encoding. |
| const euc_jp | The euc-jp encoding. |
| const euc_kr | The euc-kr encoding. |
| const GB18030 | The GB18030 encoding. |
| const gb2312 | The gb2312 encoding. |
| const hz_gb_2312 | The hz-gb-2312 encoding. |
| const IBM00858 | The IBM00858 encoding. |
| const IBM00924 | The IBM00924 encoding. |
| const IBM01047 | The IBM01047 encoding. |
| const IBM01140 | The IBM01140 encoding. |
| const IBM01141 | The IBM01141 encoding. |
| const IBM01142 | The IBM01142 encoding. |
| const IBM01143 | The IBM01143 encoding. |
| const IBM01144 | The IBM01144 encoding. |
| const IBM01145 | The IBM01145 encoding. |
| const IBM01146 | The IBM01146 encoding. |
| const IBM01147 | The IBM01147 encoding. |
| const IBM01148 | The IBM01148 encoding. |
| const IBM01149 | The IBM01149 encoding. |
| const IBM037 | The IBM037 encoding. |
| const IBM1026 | The IBM1026 encoding. |
| const IBM273 | The IBM273 encoding. |
| const IBM277 | The IBM277 encoding. |
| const IBM278 | The IBM278 encoding. |
| const IBM280 | The IBM280 encoding. |
| const IBM284 | The IBM284 encoding. |
| const IBM285 | The IBM285 encoding. |
| const IBM290 | The IBM290 encoding. |
| const IBM297 | The IBM297 encoding. |
| const IBM420 | The IBM420 encoding. |
| const IBM423 | The IBM423 encoding. |
| const IBM424 | The IBM424 encoding. |
| const IBM437 | The IBM437 encoding. |
| const IBM500 | The IBM500 encoding. |
| const ibm737 | The ibm737 encoding. |
| const ibm775 | The ibm775 encoding. |
| const ibm850 | The ibm850 encoding. |
| const ibm852 | The ibm852 encoding. |
| const IBM855 | The IBM855 encoding. |
| const ibm857 | The ibm857 encoding. |
| const IBM860 | The IBM860 encoding. |
| const ibm861 | The ibm861 encoding. |
| const IBM863 | The IBM863 encoding. |
| const IBM864 | The IBM864 encoding. |
| const IBM865 | The IBM865 encoding. |
| const ibm869 | The ibm869 encoding. |
| const IBM870 | The IBM870 encoding. |
| const IBM871 | The IBM871 encoding. |
| const IBM880 | The IBM880 encoding. |
| const IBM905 | The IBM905 encoding. |
| const IBM_Thai | The IBM-Thai encoding. |
| const iso_2022_jp | The iso-2022-jp encoding. |
| const iso_2022_kr | The iso-2022-kr encoding. |
| const iso_8859_1 | The iso-8859-1 encoding. |
| const iso_8859_13 | The iso-8859-13 encoding. |
| const iso_8859_15 | The iso-8859-15 encoding. |
| const iso_8859_2 | The iso-8859-2 encoding. |
| const iso_8859_3 | The iso-8859-3 encoding. |
| const iso_8859_4 | The iso-8859-4 encoding. |
| const iso_8859_5 | The iso-8859-5 encoding. |
| const iso_8859_6 | The iso-8859-6 encoding. |
| const iso_8859_7 | The iso-8859-7 encoding. |
| const iso_8859_8 | The iso-8859-8 encoding. |
| const iso_8859_8_i | The iso-8859-8-i encoding. |
| const iso_8859_9 | The iso-8859-9 encoding. |
| const Johab | The Johab encoding. |
| const koi8_r | The koi8-r encoding. |
| const koi8_u | The koi8-u encoding. |
| const ks_c_5601_1987 | The ks_c_5601-1987 encoding. |
| const macintosh | The macintosh encoding. |
| const shift_jis | The shift_jis encoding. |
| const us_ascii | The us-ascii encoding. |
| const utf_16 | The utf-16 encoding. |
| const utf_16BE | The utf-16BE encoding. |
| const utf_32 | The utf-32 encoding. |
| const utf_32BE | The utf-32BE encoding. |
| const utf_7 | The utf-7 encoding. |
| const utf_8 | The utf-8 encoding. |
| const Windows_1250 | The Windows-1250 encoding. |
| const Windows_1251 | The Windows-1251 encoding. |
| const Windows_1252 | The Windows-1252 encoding. |
| const Windows_1253 | The Windows-1253 encoding. |
| const Windows_1254 | The Windows-1254 encoding. |
| const Windows_1255 | The Windows-1255 encoding. |
| const Windows_1256 | The Windows-1256 encoding. |
| const Windows_1257 | The Windows-1257 encoding. |
| const Windows_1258 | The Windows-1258 encoding. |
| const windows_874 | The windows-874 encoding. |
| const x_Chinese_CNS | The x-Chinese-CNS encoding. |
| const x_Chinese_Eten | The x-Chinese-Eten encoding. |
| const x_cp20001 | The x-cp20001 encoding. |
| const x_cp20003 | The x-cp20003 encoding. |
| const x_cp20004 | The x-cp20004 encoding. |
| const x_cp20005 | The x-cp20005 encoding. |
| const x_cp20261 | The x-cp20261 encoding. |
| const x_cp20269 | The x-cp20269 encoding. |
| const x_cp20936 | The x-cp20936 encoding. |
| const x_cp20949 | The x-cp20949 encoding. |
| const x_cp50227 | The x-cp50227 encoding. |
| const x_EBCDIC_KoreanExtended | The x-EBCDIC-KoreanExtended encoding. |
| const x_Europa | The x-Europa encoding. |
| const x_IA5 | The x-IA5 encoding. |
| const x_IA5_German | The x-IA5-German encoding. |
| const x_IA5_Norwegian | The x-IA5-Norwegian encoding. |
| const x_IA5_Swedish | The x-IA5-Swedish encoding. |
| const x_iscii_as | The x-iscii-as encoding. |
| const x_iscii_be | The x-iscii-be encoding. |
| const x_iscii_de | The x-iscii-de encoding. |
| const x_iscii_gu | The x-iscii-gu encoding. |
| const x_iscii_ka | The x-iscii-ka encoding. |
| const x_iscii_ma | The x-iscii-ma encoding. |
| const x_iscii_or | The x-iscii-or encoding. |
| const x_iscii_pa | The x-iscii-pa encoding. |
| const x_iscii_ta | The x-iscii-ta encoding. |
| const x_iscii_te | The x-iscii-te encoding. |
| const x_mac_arabic | The x-mac-arabic encoding. |
| const x_mac_ce | The x-mac-ce encoding. |
| const x_mac_chinesesimp | The x-mac-chinesesimp encoding. |
| const x_mac_chinesetrad | The x-mac-chinesetrad encoding. |
| const x_mac_croatian | The x-mac-croatian encoding. |
| const x_mac_cyrillic | The x-mac-cyrillic encoding. |
| const x_mac_greek | The x-mac-greek encoding. |
| const x_mac_hebrew | The x-mac-hebrew encoding. |
| const x_mac_icelandic | The x-mac-icelandic encoding. |
| const x_mac_japanese | The x-mac-japanese encoding. |
| const x_mac_korean | The x-mac-korean encoding. |
| const x_mac_romanian | The x-mac-romanian encoding. |
| const x_mac_thai | The x-mac-thai encoding. |
| const x_mac_turkish | The x-mac-turkish encoding. |
| const x_mac_ukrainian | The x-mac-ukrainian encoding. |

### ASMO_708
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/asmo_708.md

#### Encodings.ASMO_708 field

The ASMO-708 encoding.

```csharp
public const string ASMO_708;
```

### big5
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/big5.md

#### Encodings.big5 field

The big5 encoding.

```csharp
public const string big5;
```

### cp1025
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/cp1025.md

#### Encodings.cp1025 field

The cp1025 encoding.

```csharp
public const string cp1025;
```

### cp866
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/cp866.md

#### Encodings.cp866 field

The cp866 encoding.

```csharp
public const string cp866;
```

### cp875
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/cp875.md

#### Encodings.cp875 field

The cp875 encoding.

```csharp
public const string cp875;
```

### csISO2022JP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/csiso2022jp.md

#### Encodings.csISO2022JP field

The csISO2022JP encoding.

```csharp
public const string csISO2022JP;
```

### DOS_720
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/dos_720.md

#### Encodings.DOS_720 field

The DOS-720 encoding.

```csharp
public const string DOS_720;
```

### DOS_862
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/dos_862.md

#### Encodings.DOS_862 field

The DOS-862 encoding.

```csharp
public const string DOS_862;
```

### EUC_CN
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/euc_cn.md

#### Encodings.EUC_CN field

The EUC-CN encoding.

```csharp
public const string EUC_CN;
```

### euc_jp
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/euc_jp.md

#### Encodings.euc_jp field

The euc-jp encoding.

```csharp
public const string euc_jp;
```

### euc_kr
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/euc_kr.md

#### Encodings.euc_kr field

The euc-kr encoding.

```csharp
public const string euc_kr;
```

### GB18030
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/gb18030.md

#### Encodings.GB18030 field

The GB18030 encoding.

```csharp
public const string GB18030;
```

### gb2312
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/gb2312.md

#### Encodings.gb2312 field

The gb2312 encoding.

```csharp
public const string gb2312;
```

### hz_gb_2312
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/hz_gb_2312.md

#### Encodings.hz_gb_2312 field

The hz-gb-2312 encoding.

```csharp
public const string hz_gb_2312;
```

### IBM00858
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm00858.md

#### Encodings.IBM00858 field

The IBM00858 encoding.

```csharp
public const string IBM00858;
```

### IBM00924
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm00924.md

#### Encodings.IBM00924 field

The IBM00924 encoding.

```csharp
public const string IBM00924;
```

### IBM01047
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01047.md

#### Encodings.IBM01047 field

The IBM01047 encoding.

```csharp
public const string IBM01047;
```

### IBM01140
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01140.md

#### Encodings.IBM01140 field

The IBM01140 encoding.

```csharp
public const string IBM01140;
```

### IBM01141
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01141.md

#### Encodings.IBM01141 field

The IBM01141 encoding.

```csharp
public const string IBM01141;
```

### IBM01142
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01142.md

#### Encodings.IBM01142 field

The IBM01142 encoding.

```csharp
public const string IBM01142;
```

### IBM01143
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01143.md

#### Encodings.IBM01143 field

The IBM01143 encoding.

```csharp
public const string IBM01143;
```

### IBM01144
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01144.md

#### Encodings.IBM01144 field

The IBM01144 encoding.

```csharp
public const string IBM01144;
```

### IBM01145
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01145.md

#### Encodings.IBM01145 field

The IBM01145 encoding.

```csharp
public const string IBM01145;
```

### IBM01146
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01146.md

#### Encodings.IBM01146 field

The IBM01146 encoding.

```csharp
public const string IBM01146;
```

### IBM01147
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01147.md

#### Encodings.IBM01147 field

The IBM01147 encoding.

```csharp
public const string IBM01147;
```

### IBM01148
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01148.md

#### Encodings.IBM01148 field

The IBM01148 encoding.

```csharp
public const string IBM01148;
```

### IBM01149
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm01149.md

#### Encodings.IBM01149 field

The IBM01149 encoding.

```csharp
public const string IBM01149;
```

### IBM037
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm037.md

#### Encodings.IBM037 field

The IBM037 encoding.

```csharp
public const string IBM037;
```

### IBM1026
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm1026.md

#### Encodings.IBM1026 field

The IBM1026 encoding.

```csharp
public const string IBM1026;
```

### IBM273
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm273.md

#### Encodings.IBM273 field

The IBM273 encoding.

```csharp
public const string IBM273;
```

### IBM277
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm277.md

#### Encodings.IBM277 field

The IBM277 encoding.

```csharp
public const string IBM277;
```

### IBM278
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm278.md

#### Encodings.IBM278 field

The IBM278 encoding.

```csharp
public const string IBM278;
```

### IBM280
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm280.md

#### Encodings.IBM280 field

The IBM280 encoding.

```csharp
public const string IBM280;
```

### IBM284
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm284.md

#### Encodings.IBM284 field

The IBM284 encoding.

```csharp
public const string IBM284;
```

### IBM285
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm285.md

#### Encodings.IBM285 field

The IBM285 encoding.

```csharp
public const string IBM285;
```

### IBM290
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm290.md

#### Encodings.IBM290 field

The IBM290 encoding.

```csharp
public const string IBM290;
```

### IBM297
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm297.md

#### Encodings.IBM297 field

The IBM297 encoding.

```csharp
public const string IBM297;
```

### IBM420
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm420.md

#### Encodings.IBM420 field

The IBM420 encoding.

```csharp
public const string IBM420;
```

### IBM423
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm423.md

#### Encodings.IBM423 field

The IBM423 encoding.

```csharp
public const string IBM423;
```

### IBM424
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm424.md

#### Encodings.IBM424 field

The IBM424 encoding.

```csharp
public const string IBM424;
```

### IBM437
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm437.md

#### Encodings.IBM437 field

The IBM437 encoding.

```csharp
public const string IBM437;
```

### IBM500
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm500.md

#### Encodings.IBM500 field

The IBM500 encoding.

```csharp
public const string IBM500;
```

### ibm737
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm737.md

#### Encodings.ibm737 field

The ibm737 encoding.

```csharp
public const string ibm737;
```

### ibm775
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm775.md

#### Encodings.ibm775 field

The ibm775 encoding.

```csharp
public const string ibm775;
```

### ibm850
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm850.md

#### Encodings.ibm850 field

The ibm850 encoding.

```csharp
public const string ibm850;
```

### ibm852
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm852.md

#### Encodings.ibm852 field

The ibm852 encoding.

```csharp
public const string ibm852;
```

### IBM855
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm855.md

#### Encodings.IBM855 field

The IBM855 encoding.

```csharp
public const string IBM855;
```

### ibm857
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm857.md

#### Encodings.ibm857 field

The ibm857 encoding.

```csharp
public const string ibm857;
```

### IBM860
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm860.md

#### Encodings.IBM860 field

The IBM860 encoding.

```csharp
public const string IBM860;
```

### ibm861
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm861.md

#### Encodings.ibm861 field

The ibm861 encoding.

```csharp
public const string ibm861;
```

### IBM863
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm863.md

#### Encodings.IBM863 field

The IBM863 encoding.

```csharp
public const string IBM863;
```

### IBM864
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm864.md

#### Encodings.IBM864 field

The IBM864 encoding.

```csharp
public const string IBM864;
```

### IBM865
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm865.md

#### Encodings.IBM865 field

The IBM865 encoding.

```csharp
public const string IBM865;
```

### ibm869
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm869.md

#### Encodings.ibm869 field

The ibm869 encoding.

```csharp
public const string ibm869;
```

### IBM870
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm870.md

#### Encodings.IBM870 field

The IBM870 encoding.

```csharp
public const string IBM870;
```

### IBM871
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm871.md

#### Encodings.IBM871 field

The IBM871 encoding.

```csharp
public const string IBM871;
```

### IBM880
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm880.md

#### Encodings.IBM880 field

The IBM880 encoding.

```csharp
public const string IBM880;
```

### IBM905
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm905.md

#### Encodings.IBM905 field

The IBM905 encoding.

```csharp
public const string IBM905;
```

### IBM_Thai
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ibm_thai.md

#### Encodings.IBM_Thai field

The IBM-Thai encoding.

```csharp
public const string IBM_Thai;
```

### iso_2022_jp
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_2022_jp.md

#### Encodings.iso_2022_jp field

The iso-2022-jp encoding.

```csharp
public const string iso_2022_jp;
```

### iso_2022_kr
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_2022_kr.md

#### Encodings.iso_2022_kr field

The iso-2022-kr encoding.

```csharp
public const string iso_2022_kr;
```

### iso_8859_1
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_1.md

#### Encodings.iso_8859_1 field

The iso-8859-1 encoding.

```csharp
public const string iso_8859_1;
```

### iso_8859_13
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_13.md

#### Encodings.iso_8859_13 field

The iso-8859-13 encoding.

```csharp
public const string iso_8859_13;
```

### iso_8859_15
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_15.md

#### Encodings.iso_8859_15 field

The iso-8859-15 encoding.

```csharp
public const string iso_8859_15;
```

### iso_8859_2
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_2.md

#### Encodings.iso_8859_2 field

The iso-8859-2 encoding.

```csharp
public const string iso_8859_2;
```

### iso_8859_3
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_3.md

#### Encodings.iso_8859_3 field

The iso-8859-3 encoding.

```csharp
public const string iso_8859_3;
```

### iso_8859_4
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_4.md

#### Encodings.iso_8859_4 field

The iso-8859-4 encoding.

```csharp
public const string iso_8859_4;
```

### iso_8859_5
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_5.md

#### Encodings.iso_8859_5 field

The iso-8859-5 encoding.

```csharp
public const string iso_8859_5;
```

### iso_8859_6
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_6.md

#### Encodings.iso_8859_6 field

The iso-8859-6 encoding.

```csharp
public const string iso_8859_6;
```

### iso_8859_7
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_7.md

#### Encodings.iso_8859_7 field

The iso-8859-7 encoding.

```csharp
public const string iso_8859_7;
```

### iso_8859_8
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_8.md

#### Encodings.iso_8859_8 field

The iso-8859-8 encoding.

```csharp
public const string iso_8859_8;
```

### iso_8859_8_i
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_8_i.md

#### Encodings.iso_8859_8_i field

The iso-8859-8-i encoding.

```csharp
public const string iso_8859_8_i;
```

### iso_8859_9
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/iso_8859_9.md

#### Encodings.iso_8859_9 field

The iso-8859-9 encoding.

```csharp
public const string iso_8859_9;
```

### Johab
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/johab.md

#### Encodings.Johab field

The Johab encoding.

```csharp
public const string Johab;
```

### koi8_r
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/koi8_r.md

#### Encodings.koi8_r field

The koi8-r encoding.

```csharp
public const string koi8_r;
```

### koi8_u
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/koi8_u.md

#### Encodings.koi8_u field

The koi8-u encoding.

```csharp
public const string koi8_u;
```

### ks_c_5601_1987
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/ks_c_5601_1987.md

#### Encodings.ks_c_5601_1987 field

The ks_c_5601-1987 encoding.

```csharp
public const string ks_c_5601_1987;
```

### macintosh
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/macintosh.md

#### Encodings.macintosh field

The macintosh encoding.

```csharp
public const string macintosh;
```

### shift_jis
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/shift_jis.md

#### Encodings.shift_jis field

The shift_jis encoding.

```csharp
public const string shift_jis;
```

### us_ascii
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/us_ascii.md

#### Encodings.us_ascii field

The us-ascii encoding.

```csharp
public const string us_ascii;
```

### utf_16
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_16.md

#### Encodings.utf_16 field

The utf-16 encoding.

```csharp
public const string utf_16;
```

### utf_16BE
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_16be.md

#### Encodings.utf_16BE field

The utf-16BE encoding.

```csharp
public const string utf_16BE;
```

### utf_32
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_32.md

#### Encodings.utf_32 field

The utf-32 encoding.

```csharp
public const string utf_32;
```

### utf_32BE
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_32be.md

#### Encodings.utf_32BE field

The utf-32BE encoding.

```csharp
public const string utf_32BE;
```

### utf_7
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_7.md

#### Encodings.utf_7 field

The utf-7 encoding.

```csharp
public const string utf_7;
```

### utf_8
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/utf_8.md

#### Encodings.utf_8 field

The utf-8 encoding.

```csharp
public const string utf_8;
```

### Windows_1250
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1250.md

#### Encodings.Windows_1250 field

The Windows-1250 encoding.

```csharp
public const string Windows_1250;
```

### Windows_1251
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1251.md

#### Encodings.Windows_1251 field

The Windows-1251 encoding.

```csharp
public const string Windows_1251;
```

### Windows_1252
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1252.md

#### Encodings.Windows_1252 field

The Windows-1252 encoding.

```csharp
public const string Windows_1252;
```

### Windows_1253
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1253.md

#### Encodings.Windows_1253 field

The Windows-1253 encoding.

```csharp
public const string Windows_1253;
```

### Windows_1254
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1254.md

#### Encodings.Windows_1254 field

The Windows-1254 encoding.

```csharp
public const string Windows_1254;
```

### Windows_1255
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1255.md

#### Encodings.Windows_1255 field

The Windows-1255 encoding.

```csharp
public const string Windows_1255;
```

### Windows_1256
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1256.md

#### Encodings.Windows_1256 field

The Windows-1256 encoding.

```csharp
public const string Windows_1256;
```

### Windows_1257
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1257.md

#### Encodings.Windows_1257 field

The Windows-1257 encoding.

```csharp
public const string Windows_1257;
```

### Windows_1258
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_1258.md

#### Encodings.Windows_1258 field

The Windows-1258 encoding.

```csharp
public const string Windows_1258;
```

### windows_874
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/windows_874.md

#### Encodings.windows_874 field

The windows-874 encoding.

```csharp
public const string windows_874;
```

### x_Chinese_CNS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_chinese_cns.md

#### Encodings.x_Chinese_CNS field

The x-Chinese-CNS encoding.

```csharp
public const string x_Chinese_CNS;
```

### x_Chinese_Eten
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_chinese_eten.md

#### Encodings.x_Chinese_Eten field

The x-Chinese-Eten encoding.

```csharp
public const string x_Chinese_Eten;
```

### x_cp20001
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20001.md

#### Encodings.x_cp20001 field

The x-cp20001 encoding.

```csharp
public const string x_cp20001;
```

### x_cp20003
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20003.md

#### Encodings.x_cp20003 field

The x-cp20003 encoding.

```csharp
public const string x_cp20003;
```

### x_cp20004
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20004.md

#### Encodings.x_cp20004 field

The x-cp20004 encoding.

```csharp
public const string x_cp20004;
```

### x_cp20005
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20005.md

#### Encodings.x_cp20005 field

The x-cp20005 encoding.

```csharp
public const string x_cp20005;
```

### x_cp20261
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20261.md

#### Encodings.x_cp20261 field

The x-cp20261 encoding.

```csharp
public const string x_cp20261;
```

### x_cp20269
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20269.md

#### Encodings.x_cp20269 field

The x-cp20269 encoding.

```csharp
public const string x_cp20269;
```

### x_cp20936
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20936.md

#### Encodings.x_cp20936 field

The x-cp20936 encoding.

```csharp
public const string x_cp20936;
```

### x_cp20949
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp20949.md

#### Encodings.x_cp20949 field

The x-cp20949 encoding.

```csharp
public const string x_cp20949;
```

### x_cp50227
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_cp50227.md

#### Encodings.x_cp50227 field

The x-cp50227 encoding.

```csharp
public const string x_cp50227;
```

### x_EBCDIC_KoreanExtended
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_ebcdic_koreanextended.md

#### Encodings.x_EBCDIC_KoreanExtended field

The x-EBCDIC-KoreanExtended encoding.

```csharp
public const string x_EBCDIC_KoreanExtended;
```

### x_Europa
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_europa.md

#### Encodings.x_Europa field

The x-Europa encoding.

```csharp
public const string x_Europa;
```

### x_IA5
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_ia5.md

#### Encodings.x_IA5 field

The x-IA5 encoding.

```csharp
public const string x_IA5;
```

### x_IA5_German
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_ia5_german.md

#### Encodings.x_IA5_German field

The x-IA5-German encoding.

```csharp
public const string x_IA5_German;
```

### x_IA5_Norwegian
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_ia5_norwegian.md

#### Encodings.x_IA5_Norwegian field

The x-IA5-Norwegian encoding.

```csharp
public const string x_IA5_Norwegian;
```

### x_IA5_Swedish
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_ia5_swedish.md

#### Encodings.x_IA5_Swedish field

The x-IA5-Swedish encoding.

```csharp
public const string x_IA5_Swedish;
```

### x_iscii_as
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_as.md

#### Encodings.x_iscii_as field

The x-iscii-as encoding.

```csharp
public const string x_iscii_as;
```

### x_iscii_be
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_be.md

#### Encodings.x_iscii_be field

The x-iscii-be encoding.

```csharp
public const string x_iscii_be;
```

### x_iscii_de
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_de.md

#### Encodings.x_iscii_de field

The x-iscii-de encoding.

```csharp
public const string x_iscii_de;
```

### x_iscii_gu
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_gu.md

#### Encodings.x_iscii_gu field

The x-iscii-gu encoding.

```csharp
public const string x_iscii_gu;
```

### x_iscii_ka
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_ka.md

#### Encodings.x_iscii_ka field

The x-iscii-ka encoding.

```csharp
public const string x_iscii_ka;
```

### x_iscii_ma
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_ma.md

#### Encodings.x_iscii_ma field

The x-iscii-ma encoding.

```csharp
public const string x_iscii_ma;
```

### x_iscii_or
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_or.md

#### Encodings.x_iscii_or field

The x-iscii-or encoding.

```csharp
public const string x_iscii_or;
```

### x_iscii_pa
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_pa.md

#### Encodings.x_iscii_pa field

The x-iscii-pa encoding.

```csharp
public const string x_iscii_pa;
```

### x_iscii_ta
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_ta.md

#### Encodings.x_iscii_ta field

The x-iscii-ta encoding.

```csharp
public const string x_iscii_ta;
```

### x_iscii_te
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_iscii_te.md

#### Encodings.x_iscii_te field

The x-iscii-te encoding.

```csharp
public const string x_iscii_te;
```

### x_mac_arabic
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_arabic.md

#### Encodings.x_mac_arabic field

The x-mac-arabic encoding.

```csharp
public const string x_mac_arabic;
```

### x_mac_ce
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_ce.md

#### Encodings.x_mac_ce field

The x-mac-ce encoding.

```csharp
public const string x_mac_ce;
```

### x_mac_chinesesimp
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_chinesesimp.md

#### Encodings.x_mac_chinesesimp field

The x-mac-chinesesimp encoding.

```csharp
public const string x_mac_chinesesimp;
```

### x_mac_chinesetrad
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_chinesetrad.md

#### Encodings.x_mac_chinesetrad field

The x-mac-chinesetrad encoding.

```csharp
public const string x_mac_chinesetrad;
```

### x_mac_croatian
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_croatian.md

#### Encodings.x_mac_croatian field

The x-mac-croatian encoding.

```csharp
public const string x_mac_croatian;
```

### x_mac_cyrillic
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_cyrillic.md

#### Encodings.x_mac_cyrillic field

The x-mac-cyrillic encoding.

```csharp
public const string x_mac_cyrillic;
```

### x_mac_greek
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_greek.md

#### Encodings.x_mac_greek field

The x-mac-greek encoding.

```csharp
public const string x_mac_greek;
```

### x_mac_hebrew
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_hebrew.md

#### Encodings.x_mac_hebrew field

The x-mac-hebrew encoding.

```csharp
public const string x_mac_hebrew;
```

### x_mac_icelandic
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_icelandic.md

#### Encodings.x_mac_icelandic field

The x-mac-icelandic encoding.

```csharp
public const string x_mac_icelandic;
```

### x_mac_japanese
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_japanese.md

#### Encodings.x_mac_japanese field

The x-mac-japanese encoding.

```csharp
public const string x_mac_japanese;
```

### x_mac_korean
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_korean.md

#### Encodings.x_mac_korean field

The x-mac-korean encoding.

```csharp
public const string x_mac_korean;
```

### x_mac_romanian
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_romanian.md

#### Encodings.x_mac_romanian field

The x-mac-romanian encoding.

```csharp
public const string x_mac_romanian;
```

### x_mac_thai
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_thai.md

#### Encodings.x_mac_thai field

The x-mac-thai encoding.

```csharp
public const string x_mac_thai;
```

### x_mac_turkish
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_turkish.md

#### Encodings.x_mac_turkish field

The x-mac-turkish encoding.

```csharp
public const string x_mac_turkish;
```

### x_mac_ukrainian
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/encodings/x_mac_ukrainian.md

#### Encodings.x_mac_ukrainian field

The x-mac-ukrainian encoding.

```csharp
public const string x_mac_ukrainian;
```

### ExtractedData
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extracteddata.md

#### ExtractedData class

Represents data retrieved from a document and prepared for indexing.

```csharp
public class ExtractedData
```

#### Properties

| Name | Description |
| --- | --- |
| IsExtractionSuccessful { get; } | Gets a value indicating whether the data extraction process completed successfully. |

#### Methods

| Name | Description |
| --- | --- |
| static Deserialize(byte[]) | Deserializes an instance from a byte array. |
| Serialize() | Serializes the current instance to a byte array. |

### Deserialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extracteddata/deserialize.md

#### ExtractedData.Deserialize method

Deserializes an instance from a byte array.

```csharp
public static ExtractedData Deserialize(byte[] array)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Byte[] | A byte array to deserialize from. |

##### Return Value

An instance deserialized from a byte array.

### IsExtractionSuccessful
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extracteddata/isextractionsuccessful.md

#### ExtractedData.IsExtractionSuccessful property

Gets a value indicating whether the data extraction process completed successfully.

```csharp
public bool IsExtractionSuccessful { get; }
```

##### Return Value

A value indicating whether the data extraction process completed successfully.

### Serialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extracteddata/serialize.md

#### ExtractedData.Serialize method

Serializes the current instance to a byte array.

```csharp
public byte[] Serialize()
```

##### Return Value

A byte array representing the current instance.

### ExtractedItemInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo.md

#### ExtractedItemInfo class

Represents a container item information.

```csharp
public class ExtractedItemInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| ExtractedItemInfo(FormatFamily, DocumentField[], string, string) | Initializes a new instance of the `ExtractedItemInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| Fields { get; } | Gets an extracted fields. |
| FormatFamily { get; } | Gets a document type. |
| InnerPath { get; } | Gets an inner path. |
| ItemInfo { get; } | Gets an item information. |

### ExtractedItemInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo/extractediteminfo.md

#### ExtractedItemInfo constructor

Initializes a new instance of the `ExtractedItemInfo` class.

```csharp
public ExtractedItemInfo(FormatFamily formatFamily, DocumentField[] fields, string itemInfo, 
    string innerPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatFamily | FormatFamily | The document format family. |
| fields | DocumentField[] | The extracted fields. |
| itemInfo | String | The item information. |
| innerPath | String | The path to the item in the container. |

### Fields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo/fields.md

#### ExtractedItemInfo.Fields property

Gets an extracted fields.

```csharp
public DocumentField[] Fields { get; }
```

##### Property Value

The extracted fields.

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo/formatfamily.md

#### ExtractedItemInfo.FormatFamily property

Gets a document type.

```csharp
public FormatFamily FormatFamily { get; }
```

##### Property Value

The document type.

### InnerPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo/innerpath.md

#### ExtractedItemInfo.InnerPath property

Gets an inner path.

```csharp
public string InnerPath { get; }
```

##### Property Value

The inner path.

### ItemInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractediteminfo/iteminfo.md

#### ExtractedItemInfo.ItemInfo property

Gets an item information.

```csharp
public string ItemInfo { get; }
```

##### Property Value

The item information.

### ExtractorSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractorsettings.md

#### ExtractorSettings class

Contains settings for the document data extractor.

```csharp
public class ExtractorSettings
```

#### Properties

| Name | Description |
| --- | --- |
| IndexType { get; set; } | Gets or sets the index type the extractor is used for. The default value is NormalIndex. |

### IndexType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/extractorsettings/indextype.md

#### ExtractorSettings.IndexType property

Gets or sets the index type the extractor is used for. The default value is NormalIndex.

```csharp
public IndexType IndexType { get; set; }
```

##### Property Value

The index type the extractor is used for.

### FileLogger
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger.md

#### FileLogger class

Represents a logger that logs events and errors to a local file.

```csharp
public class FileLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| FileLogger(string, double) | Initializes a new instance of the `FileLogger` class. |

#### Properties

| Name | Description |
| --- | --- |
| FilePath { get; } | Gets the log file path. |
| MaxSize { get; } | Gets the maximum size of log file in megabytes. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string) | Logs an error that occurred in the index. |
| Trace(string) | Logs an event that occurred in the index. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";
string logPath = @"c:\Log.txt";

IndexSettings settings = new IndexSettings();
settings.Logger = new FileLogger(logPath, 4.0); // Specifying the path to the log file and a maximum length of 4 MB

Index index = new Index(indexFolder, settings); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result = index.Search(query); // Search in index
```

### Error
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger/error.md

#### FileLogger.Error method

Logs an error that occurred in the index.

```csharp
public void Error(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |

### FileLogger
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger/filelogger.md

#### FileLogger constructor

Initializes a new instance of the `FileLogger` class.

```csharp
public FileLogger(string filePath, double maxSize)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The log file path. |
| maxSize | Double | The maximum size of the log file in megabytes. The value must be in the range from 0.1 to 1000. |

### FilePath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger/filepath.md

#### FileLogger.FilePath property

Gets the log file path.

```csharp
public string FilePath { get; }
```

##### Property Value

The log file path.

### MaxSize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger/maxsize.md

#### FileLogger.MaxSize property

Gets the maximum size of log file in megabytes.

```csharp
public double MaxSize { get; }
```

##### Property Value

The maximum size of log file in megabytes.

### Trace
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/filelogger/trace.md

#### FileLogger.Trace method

Logs an event that occurred in the index.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The event message. |

### FileOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fileoutputadapter.md

#### FileOutputAdapter class

Represents an output adapter that collects output into a file.

```csharp
public class FileOutputAdapter : OutputAdapter
```

#### Constructors

| Name | Description |
| --- | --- |
| FileOutputAdapter(OutputFormat, string) | Initializes a new instance of the `FileOutputAdapter` class. |

#### Properties

| Name | Description |
| --- | --- |
| FilePath { get; } | Gets an output file path. |
| OutputFormat { get; } | Gets the output format. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

FileOutputAdapter adapter = new FileOutputAdapter(@"c:\DocumentText.htm"); // Creating a file output adapter
index.GetDocumentText(documents[0], adapter); // Generating a document text into the output file
```

### FileOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fileoutputadapter/fileoutputadapter.md

#### FileOutputAdapter constructor

Initializes a new instance of the `FileOutputAdapter` class.

```csharp
public FileOutputAdapter(OutputFormat outputFormat, string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format. |
| filePath | String | The output file path. |

### FilePath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fileoutputadapter/filepath.md

#### FileOutputAdapter.FilePath property

Gets an output file path.

```csharp
public string FilePath { get; }
```

##### Property Value

The output file path.

### FragmentContainer
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fragmentcontainer.md

#### FragmentContainer class

Represents a container for text fragments with highlighted found terms of one document field.

```csharp
public class FragmentContainer
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of contained text fragments. |
| FieldName { get; } | Gets the document field name. |

#### Methods

| Name | Description |
| --- | --- |
| GetFragments() | Gets an array of contained text fragments. |

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fragmentcontainer/count.md

#### FragmentContainer.Count property

Gets the number of contained text fragments.

```csharp
public int Count { get; }
```

##### Property Value

The number of contained text fragments.

### FieldName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fragmentcontainer/fieldname.md

#### FragmentContainer.FieldName property

Gets the document field name.

```csharp
public string FieldName { get; }
```

##### Property Value

The document field name.

### GetFragments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/fragmentcontainer/getfragments.md

#### FragmentContainer.GetFragments method

Gets an array of contained text fragments.

```csharp
public string[] GetFragments()
```

##### Return Value

An array of contained text fragments.

### IContainerItemExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/icontaineritemextractor.md

#### IContainerItemExtractor interface

Provides methods for extracting items from container documents.

```csharp
public interface IContainerItemExtractor : IFieldExtractor
```

#### Properties

| Name | Description |
| --- | --- |
| FormatFamily { get; } | Gets the document format family. |

#### Methods

| Name | Description |
| --- | --- |
| GetContainerItems(Stream) | Extracts items from container document. |
| GetContainerItems(string) | Extracts items from container document. |

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/icontaineritemextractor/formatfamily.md

#### IContainerItemExtractor.FormatFamily property

Gets the document format family.

```csharp
public FormatFamily FormatFamily { get; }
```

##### Property Value

The document format family.

### GetContainerItems
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/icontaineritemextractor/getcontaineritems.md

#### GetContainerItems(string)

Extracts items from container document.

```csharp
public ExtractedItemInfo[] GetContainerItems(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The document file path. |

##### Return Value

An array of extracted items.

#### GetContainerItems(Stream)

Extracts items from container document.

```csharp
public ExtractedItemInfo[] GetContainerItems(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The document stream. |

##### Return Value

An array of extracted items.

### IDocumentLoader
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/idocumentloader.md

#### IDocumentLoader interface

Defines the document loader interface that is used to load lazy documents.

```csharp
public interface IDocumentLoader
```

#### Methods

| Name | Description |
| --- | --- |
| CloseDocument() | Closes the loaded document. This method is called by the index when it has finished processing the document. |
| LoadDocument() | Loads a document. This method is called by the index when it is ready for processing the document. |

### CloseDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/idocumentloader/closedocument.md

#### IDocumentLoader.CloseDocument method

Closes the loaded document. This method is called by the index when it has finished processing the document.

```csharp
public void CloseDocument()
```

### LoadDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/idocumentloader/loaddocument.md

#### IDocumentLoader.LoadDocument method

Loads a document. This method is called by the index when it is ready for processing the document.

```csharp
public Document LoadDocument()
```

##### Return Value

The loaded document.

### IFieldExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ifieldextractor.md

#### IFieldExtractor interface

Provides methods for extracting fields from a document.

```csharp
public interface IFieldExtractor
```

#### Properties

| Name | Description |
| --- | --- |
| Extensions { get; } | Gets the supported extensions. |

#### Methods

| Name | Description |
| --- | --- |
| GetFields(Stream) | Extracts all fields from the specified document. |
| GetFields(string) | Extracts all fields from the specified document. |

##### Examples

The example demonstrates how to implement the interface `IFieldExtractor`.

```csharp
public class LogExtractor : IFieldExtractor
{
    private readonly string[] extensions = new string[] { ".log" };

    public string[] Extensions
    {
        get { return extensions; }
    }

    public DocumentField[] GetFields(string filePath)
    {
        FileInfo fileInfo = new FileInfo(filePath);
        DocumentField[] fields = new DocumentField[]
        {
            new DocumentField("FileName", fileInfo.FullName),
            new DocumentField("CreationDate", fileInfo.CreationTime.ToString(CultureInfo.InvariantCulture)),
            new DocumentField("Content", ExtractContent(filePath)),
        };
        return fields;
    }

    private string ExtractContent(string filePath)
    {
        StringBuilder result = new StringBuilder();
        using (StreamReader streamReader = File.OpenText(filePath))
        {
            string line = streamReader.ReadLine();
            string processedLine = line.Remove(0, 12);
            result.AppendLine(processedLine);
        }
        return result.ToString();
    }
}
```

The example demonstrates how to use the custorm extractor for indexing.

```csharp
string indexFolder = @"c:\MyIndex\"; // Specify path to the index folder
string documentsFolder = @"c:\MyDocuments\"; // Specify path to a folder containing documents to search

Index index = new Index(indexFolder); // Creating or loading an index

index.IndexSettings.CustomExtractors.Add(new LogExtractor()); // Adding custom text extractor to index settings

index.Add(documentsFolder); // Indexing documents from the specified folder
```

### Extensions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ifieldextractor/extensions.md

#### IFieldExtractor.Extensions property

Gets the supported extensions.

```csharp
public string[] Extensions { get; }
```

##### Property Value

The supported extensions.

### GetFields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ifieldextractor/getfields.md

#### GetFields(string)

Extracts all fields from the specified document.

```csharp
public DocumentField[] GetFields(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The document file path. |

##### Return Value

The extracted fields.

#### GetFields(Stream)

Extracts all fields from the specified document.

```csharp
public DocumentField[] GetFields(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The document stream. |

##### Return Value

The extracted fields.

### ILogger
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ilogger.md

#### ILogger interface

Defines interface of a logger that is used for logging events and errors in an index.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string) | Logs an error that occurred in the index. |
| Trace(string) | Logs an event that occurred in the index. |

### Error
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ilogger/error.md

#### ILogger.Error method

Logs an error that occurred in the index.

```csharp
public void Error(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |

### Trace
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/ilogger/trace.md

#### ILogger.Trace method

Logs an event that occurred in the index.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The event message. |

### ImageFrame
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/imageframe.md

#### ImageFrame class

Represents an image frame.

```csharp
public class ImageFrame
```

#### Properties

| Name | Description |
| --- | --- |
| Index { get; } | Gets the index of the frame in the image. |

### Index
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/imageframe/index.md

#### ImageFrame.Index property

Gets the index of the frame in the image.

```csharp
public int Index { get; }
```

##### Property Value

The index of the frame in the image.

### IndexInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo.md

#### IndexInfo class

Contains basic information on an Index.

```csharp
public class IndexInfo
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the full folder name where index is located. |
| IndexId { get; } | Gets the index unique identifier. |
| IndexStatus { get; } | Gets the index status. |
| SegmentCount { get; } | Gets the number of index segments. |
| TermCount { get; } | Gets the number of words in the index. |
| Version { get; } | Gets the index version. |

### IndexFolder
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/indexfolder.md

#### IndexInfo.IndexFolder property

Gets the full folder name where index is located.

```csharp
public string IndexFolder { get; }
```

##### Property Value

The full folder name where index is located.

### IndexId
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/indexid.md

#### IndexInfo.IndexId property

Gets the index unique identifier.

```csharp
public Guid IndexId { get; }
```

##### Property Value

The index unique identifier.

### IndexStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/indexstatus.md

#### IndexInfo.IndexStatus property

Gets the index status.

```csharp
public IndexStatus IndexStatus { get; }
```

##### Property Value

The index status.

### SegmentCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/segmentcount.md

#### IndexInfo.SegmentCount property

Gets the number of index segments.

```csharp
public int SegmentCount { get; }
```

##### Property Value

The number of index segments.

### TermCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/termcount.md

#### IndexInfo.TermCount property

Gets the number of words in the index.

```csharp
public int TermCount { get; }
```

##### Property Value

The number of words in the index.

### Version
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexinfo/version.md

#### IndexInfo.Version property

Gets the index version.

```csharp
public string Version { get; }
```

##### Property Value

The index version.

### IndexingReport
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport.md

#### IndexingReport class

Represents a detailed information on an indexing operation.

```csharp
public class IndexingReport
```

#### Properties

| Name | Description |
| --- | --- |
| EndTime { get; } | Gets the indexing end time. |
| Errors { get; } | Gets the list of errors. |
| IndexedDocuments { get; } | Gets the list of indexed documents. |
| IndexedDocumentsSize { get; } | Gets the total length of indexed documents in MB. |
| IndexingTime { get; } | Gets the indexing duration. |
| RemovedDocuments { get; } | Gets the list of removed from index documents. |
| SegmentCount { get; } | Gets the number of index segments. |
| StartTime { get; } | Gets the indexing start time. |
| TotalDocumentsInIndex { get; } | Gets the total number of documents in the index. |
| TotalIndexSize { get; } | Gets the total index size in bytes. |
| TotalTermCount { get; } | Gets the total number of terms in index. |
| UpdatedDocuments { get; } | Gets the list of updated documents. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents
index.Add(documentsFolder1);
index.Add(documentsFolder2);

// Getting indexing reports
IndexingReport[] reports = index.GetIndexingReports();

// Printing reports to the console
foreach (IndexingReport report in reports)
{
    Console.WriteLine("Time: " + report.StartTime);
    Console.WriteLine("Duration: " + report.IndexingTime);
    Console.WriteLine("Documents total: " + report.TotalDocumentsInIndex);
    Console.WriteLine("Terms total: " + report.TotalTermCount);
    Console.WriteLine("Indexed documents size (MB): " + report.IndexedDocumentsSize);
    Console.WriteLine("Index size (MB): " + (report.TotalIndexSize / 1024.0 / 1024.0));
    Console.WriteLine();
}
```

### EndTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/endtime.md

#### IndexingReport.EndTime property

Gets the indexing end time.

```csharp
public DateTime EndTime { get; }
```

##### Property Value

The indexing end time.

### Errors
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/errors.md

#### IndexingReport.Errors property

Gets the list of errors.

```csharp
public string[] Errors { get; }
```

##### Property Value

The list of errors.

### IndexedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/indexeddocuments.md

#### IndexingReport.IndexedDocuments property

Gets the list of indexed documents.

```csharp
public string[] IndexedDocuments { get; }
```

##### Property Value

The list of indexed documents.

### IndexedDocumentsSize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/indexeddocumentssize.md

#### IndexingReport.IndexedDocumentsSize property

Gets the total length of indexed documents in MB.

```csharp
public double IndexedDocumentsSize { get; }
```

##### Property Value

The total length of indexed documents in MB.

### IndexingTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/indexingtime.md

#### IndexingReport.IndexingTime property

Gets the indexing duration.

```csharp
public TimeSpan IndexingTime { get; }
```

##### Property Value

The indexing duration.

### RemovedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/removeddocuments.md

#### IndexingReport.RemovedDocuments property

Gets the list of removed from index documents.

```csharp
public string[] RemovedDocuments { get; }
```

##### Property Value

The list of removed from index documents.

### SegmentCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/segmentcount.md

#### IndexingReport.SegmentCount property

Gets the number of index segments.

```csharp
public int SegmentCount { get; }
```

##### Property Value

The number of index segments.

### StartTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/starttime.md

#### IndexingReport.StartTime property

Gets the indexing start time.

```csharp
public DateTime StartTime { get; }
```

##### Property Value

The indexing start time.

### TotalDocumentsInIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/totaldocumentsinindex.md

#### IndexingReport.TotalDocumentsInIndex property

Gets the total number of documents in the index.

```csharp
public int TotalDocumentsInIndex { get; }
```

##### Property Value

The total number of documents in the index.

### TotalIndexSize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/totalindexsize.md

#### IndexingReport.TotalIndexSize property

Gets the total index size in bytes.

```csharp
public long TotalIndexSize { get; }
```

##### Property Value

The total index size in bytes.

### TotalTermCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/totaltermcount.md

#### IndexingReport.TotalTermCount property

Gets the total number of terms in index.

```csharp
public int TotalTermCount { get; }
```

##### Property Value

The total number of terms in index.

### UpdatedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexingreport/updateddocuments.md

#### IndexingReport.UpdatedDocuments property

Gets the list of updated documents.

```csharp
public string[] UpdatedDocuments { get; }
```

##### Property Value

The list of updated documents.

### IndexStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/indexstatus.md

#### IndexStatus enumeration

Specifies an index status.

```csharp
public enum IndexStatus
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Ready | `0` | The index is free and ready for changes. |
| Failed | `1` | The index needs to be reloaded due to an error. |
| Indexing | `2` | The index performs an indexing operation. |
| Updating | `3` | The index performs an updating operation. |
| Merging | `4` | The index performs a merging operation. |
| Optimizing | `5` | The index performs an optimizing operation. |
| Deleting | `6` | The index performs a deleting operation. |
| Renaming | `7` | The index performs a renaming operation. |
| ChangingAttributes | `8` | The index changes attributes. |
| CheckingSegments | `9` | The index checks segments. |
| SavingTheIndex | `10` | The index is saved to another folder. |

### IWordSplitter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/iwordsplitter.md

#### IWordSplitter interface

Defines a method for splitting text into individual words.

```csharp
public interface IWordSplitter
```

#### Methods

| Name | Description |
| --- | --- |
| Split(string) | Splits the input string into individual words. |

### Split
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/iwordsplitter/split.md

#### IWordSplitter.Split method

Splits the input string into individual words.

```csharp
public IEnumerable<string> Split(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The input text to be split. |

##### Return Value

An enumeration of words extracted from the input text.

### Notification
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/notification.md

#### Notification class

The base class for all notifications to the index. This class also contains methods for creating notification objects.

```csharp
public abstract class Notification
```

#### Methods

| Name | Description |
| --- | --- |
| static CreateRenameNotification(string, string) | Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed. The renamed document will not be reindexed during the next update operation, even if its contents have been changed. |

### CreateRenameNotification
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/notification/createrenamenotification.md

#### Notification.CreateRenameNotification method

Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed. The renamed document will not be reindexed during the next update operation, even if its contents have been changed.

```csharp
public static Notification CreateRenameNotification(string oldPath, string newPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| oldPath | String | The old path to the indexed document. |
| newPath | String | The new path to the indexed document. |

##### Return Value

A new rename notification object.

### OutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/outputadapter.md

#### OutputAdapter class

Represents the base class of an output adapter that is used to collect an output in a generalized form. The currently available adapters are `FileOutputAdapter`, `StreamOutputAdapter`, `StructureOutputAdapter`, and `StringOutputAdapter`.

```csharp
public abstract class OutputAdapter : ResultBuilderFactory
```

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

### ResultBuilderFactory
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/resultbuilderfactory.md

#### ResultBuilderFactory class

Represents the base class of a result builder factory.

```csharp
public abstract class ResultBuilderFactory
```

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

### OutputFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/resultbuilderfactory/outputformat.md

#### ResultBuilderFactory.OutputFormat property

Gets the output format.

```csharp
public OutputFormat OutputFormat { get; }
```

##### Property Value

The output format.

### SearchImage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchimage.md

#### SearchImage class

Represents an image to search.

```csharp
public class SearchImage
```

#### Methods

| Name | Description |
| --- | --- |
| static Create(Stream) | Creates an image from a stream to search. |
| static Create(string) | Creates an image from a file to search. |
| static Create(Stream, int) | Creates an image from a stream to search. |
| static Create(string, int) | Creates an image from a file to search. |

### Create
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchimage/create.md

#### Create(string)

Creates an image from a file to search.

```csharp
public static SearchImage Create(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The image file path. |

##### Return Value

An image to search.

#### Create(string, int)

Creates an image from a file to search.

```csharp
public static SearchImage Create(string filePath, int imageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The image file path. |
| imageIndex | Int32 | The image index in multipage images. |

##### Return Value

An image to search.

#### Create(Stream)

Creates an image from a stream to search.

```csharp
public static SearchImage Create(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The image stream. |

##### Return Value

An image to search.

#### Create(Stream, int)

Creates an image from a stream to search.

```csharp
public static SearchImage Create(Stream stream, int imageIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The image stream. |
| imageIndex | Int32 | The image index in multipage images. |

##### Return Value

An image to search.

### SearchReport
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport.md

#### SearchReport class

Represents a detailed information on a search operation.

```csharp
public class SearchReport
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentCount { get; } | Gets the number of documents found. |
| EndTime { get; } | Gets the end time of the search. |
| ObjectQuery { get; } | Gets the search query in object form. |
| OccurrenceCount { get; } | Gets the total number of occurrences found. |
| SearchDuration { get; } | Gets the search duration. |
| SearchOptions { get; } | Gets the search options. |
| StartTime { get; } | Gets the start time of the search. |
| TextQuery { get; } | Gets the search query in text form. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `SearchReport`. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Searching in index
SearchResult result1 = index.Search("Einstein");
SearchResult result2 = index.Search("\"Theory of Relativity\"");

// Getting search reports
SearchReport[] reports = index.GetSearchReports();

// Printing reports to the console
foreach (SearchReport report in reports)
{
    Console.WriteLine("Query: " + report.TextQuery);
    Console.WriteLine("Time: " + report.StartTime);
    Console.WriteLine("Duration: " + report.SearchDuration);
    Console.WriteLine("Documents: " + report.DocumentCount);
    Console.WriteLine("Occurrences: " + report.OccurrenceCount);
    Console.WriteLine();
}
```

### DocumentCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/documentcount.md

#### SearchReport.DocumentCount property

Gets the number of documents found.

```csharp
public int DocumentCount { get; }
```

##### Property Value

The number of documents found.

### EndTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/endtime.md

#### SearchReport.EndTime property

Gets the end time of the search.

```csharp
public DateTime EndTime { get; }
```

##### Property Value

The end time of the search.

### ObjectQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/objectquery.md

#### SearchReport.ObjectQuery property

Gets the search query in object form.

```csharp
public SearchQuery ObjectQuery { get; }
```

##### Property Value

The search query in object form.

### OccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/occurrencecount.md

#### SearchReport.OccurrenceCount property

Gets the total number of occurrences found.

```csharp
public int OccurrenceCount { get; }
```

##### Property Value

The total number of occurrences found.

### SearchDuration
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/searchduration.md

#### SearchReport.SearchDuration property

Gets the search duration.

```csharp
public TimeSpan SearchDuration { get; }
```

##### Property Value

The search duration.

### SearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/searchoptions.md

#### SearchReport.SearchOptions property

Gets the search options.

```csharp
public SearchOptions SearchOptions { get; }
```

##### Property Value

The search options.

### StartTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/starttime.md

#### SearchReport.StartTime property

Gets the start time of the search.

```csharp
public DateTime StartTime { get; }
```

##### Property Value

The start time of the search.

### TextQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/textquery.md

#### SearchReport.TextQuery property

Gets the search query in text form.

```csharp
public string TextQuery { get; }
```

##### Property Value

The search query in text form.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/searchreport/tostring.md

#### SearchReport.ToString method

Returns a String that represents the current `SearchReport`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `SearchReport`.

### StreamOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/streamoutputadapter.md

#### StreamOutputAdapter class

Represents an output adapter that collects output into a Stream.

```csharp
public class StreamOutputAdapter : OutputAdapter
```

#### Constructors

| Name | Description |
| --- | --- |
| StreamOutputAdapter(OutputFormat, Stream) | Initializes a new instance of the `StreamOutputAdapter` class. |

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |
| Stream { get; } | Gets an output stream. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

using (Stream stream = new MemoryStream()) // Creating a stream
{
    StreamOutputAdapter adapter = new StreamOutputAdapter(stream); // Creating a stream output adapter
    index.GetDocumentText(documents[0], adapter); // Generating a document text into the stream
}
```

### Stream
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/streamoutputadapter/stream.md

#### StreamOutputAdapter.Stream property

Gets an output stream.

```csharp
public Stream Stream { get; }
```

##### Property Value

The output stream.

### StreamOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/streamoutputadapter/streamoutputadapter.md

#### StreamOutputAdapter constructor

Initializes a new instance of the `StreamOutputAdapter` class.

```csharp
public StreamOutputAdapter(OutputFormat outputFormat, Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format. |
| stream | Stream | The output stream. |

### StringOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/stringoutputadapter.md

#### StringOutputAdapter class

Represents an output adapter that collects output as a String.

```csharp
public class StringOutputAdapter : OutputAdapter
```

#### Constructors

| Name | Description |
| --- | --- |
| StringOutputAdapter(OutputFormat) | Initializes a new instance of the `StringOutputAdapter` class. |

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

#### Methods

| Name | Description |
| --- | --- |
| GetResult() | Gets the resulting string. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

StringOutputAdapter adapter = new StringOutputAdapter(OutputFormat.Html); // Creating a string output adapter
index.GetDocumentText(documents[0], adapter); // Generating a document text into the adapter
String result = adapter.GetResult(); // Getting a result
```

### GetResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/stringoutputadapter/getresult.md

#### StringOutputAdapter.GetResult method

Gets the resulting string.

```csharp
public string GetResult()
```

##### Return Value

The resulting string.

### StringOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/stringoutputadapter/stringoutputadapter.md

#### StringOutputAdapter constructor

Initializes a new instance of the `StringOutputAdapter` class.

```csharp
public StringOutputAdapter(OutputFormat outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format. |

### StructureOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/structureoutputadapter.md

#### StructureOutputAdapter class

Represents an output adapter that collects output as a structure containing each field separately.

```csharp
public class StructureOutputAdapter : OutputAdapter
```

#### Constructors

| Name | Description |
| --- | --- |
| StructureOutputAdapter(OutputFormat) | Initializes a new instance of the `StructureOutputAdapter` class. |

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

#### Methods

| Name | Description |
| --- | --- |
| GetResult() | Gets the resulting array of fields. |

### GetResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/structureoutputadapter/getresult.md

#### StructureOutputAdapter.GetResult method

Gets the resulting array of fields.

```csharp
public DocumentField[] GetResult()
```

##### Return Value

The resulting array of fields.

### StructureOutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/structureoutputadapter/structureoutputadapter.md

#### StructureOutputAdapter constructor

Initializes a new instance of the `StructureOutputAdapter` class.

```csharp
public StructureOutputAdapter(OutputFormat outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format. |

### VersionUpdateResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/versionupdateresult.md

#### VersionUpdateResult enumeration

Represents the result of an index version update operation.

```csharp
public enum VersionUpdateResult
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Updated | `0` | Index version updated. |
| AlreadyUpToDate | `1` | Index version is already up-to-date. |
| Unsupported | `2` | Index version is not supported or directory does not contain valid index data. |

### WordPattern
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern.md

#### WordPattern class

Represents a word pattern to use in word wildcard search.

```csharp
public class WordPattern
```

#### Constructors

| Name | Description |
| --- | --- |
| WordPattern() | Initializes a new instance of the `WordPattern` class. |

#### Methods

| Name | Description |
| --- | --- |
| AppendCharacter(char) | Appends a character to the word pattern. |
| AppendOneCharacterWildcard() | Appends one character wildcard to the word pattern. |
| AppendOneOrMoreCharactersWildcard() | Appends one or more characters wildcard to the word pattern. |
| AppendString(string) | Appends a string to the word pattern. |
| AppendWildcard(int, int) | Appends a wildcard to the word pattern. |
| AppendZeroOrMoreCharactersWildcard() | Appends zero or more characters wildcard to the word pattern. |
| AppendZeroOrOneCharacterWildcard() | Appends zero or one character wildcard to the word pattern. |
| override ToString() | Returns a String that represents the current `WordPattern`. |

### AppendCharacter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendcharacter.md

#### WordPattern.AppendCharacter method

Appends a character to the word pattern.

```csharp
public void AppendCharacter(char character)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | Char | The character to append. |

### AppendOneCharacterWildcard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendonecharacterwildcard.md

#### WordPattern.AppendOneCharacterWildcard method

Appends one character wildcard to the word pattern.

```csharp
public void AppendOneCharacterWildcard()
```

### AppendOneOrMoreCharactersWildcard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendoneormorecharacterswildcard.md

#### WordPattern.AppendOneOrMoreCharactersWildcard method

Appends one or more characters wildcard to the word pattern.

```csharp
public void AppendOneOrMoreCharactersWildcard()
```

### AppendString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendstring.md

#### WordPattern.AppendString method

Appends a string to the word pattern.

```csharp
public void AppendString(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The string to append. |

### AppendWildcard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendwildcard.md

#### WordPattern.AppendWildcard method

Appends a wildcard to the word pattern.

```csharp
public void AppendWildcard(int min, int max)
```

| Parameter | Type | Description |
| --- | --- | --- |
| min | Int32 | The minimum number of characters. |
| max | Int32 | The maximum number of characters. |

### AppendZeroOrMoreCharactersWildcard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendzeroormorecharacterswildcard.md

#### WordPattern.AppendZeroOrMoreCharactersWildcard method

Appends zero or more characters wildcard to the word pattern.

```csharp
public void AppendZeroOrMoreCharactersWildcard()
```

### AppendZeroOrOneCharacterWildcard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/appendzerooronecharacterwildcard.md

#### WordPattern.AppendZeroOrOneCharacterWildcard method

Appends zero or one character wildcard to the word pattern.

```csharp
public void AppendZeroOrOneCharacterWildcard()
```

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/tostring.md

#### WordPattern.ToString method

Returns a String that represents the current `WordPattern`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `WordPattern`.

### WordPattern
Path: https://reference.groupdocs.com/search/net/groupdocs.search.common/wordpattern/wordpattern.md

#### WordPattern constructor

Initializes a new instance of the `WordPattern` class.

```csharp
public WordPattern()
```

### GroupDocs.Search.Dictionaries
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries.md

The namespace provides classes of various dictionaries.

#### Classes

| Class | Description |
| --- | --- |
| AliasDictionary | Represents a dictionary of aliases. |
| AliasReplacementPair | Represents an alias/replacement pair. |
| Alphabet | Represents a dictionary of characters that is used during indexing to detect character type. Each character can be handled as separator, as letter, or both. |
| CharacterReplacementDictionary | Represents a character replacement dictionary that is used during the indexing process. Character replacement can be used, for example, to remove accents from accented characters or to make case-insensitive index. |
| CharacterReplacementPair | Represents a character/replacement pair. |
| DictionaryBase | Represents the base class for a dictionary. |
| DictionaryRepository | Represents a repository of all dictionaries in the Index. |
| EnglishWordFormsProvider | Represents an English word forms provider. |
| HomophoneDictionary | Represents a dictionary of heterographic homophones. |
| PasswordDictionary | Represents a dictionary of document passwords. |
| SpellingCorrector | Represents a spelling corrector for terms in a query. |
| StopWordDictionary | Represents a dictionary of stop words. |
| SynonymDictionary | Represents a dictionary of synonyms. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IWordFormsProvider | Defines interface of a word forms provider. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| CharacterType | Represents a type of a character, depending on how it should be indexed. |
| DictionaryType | Represents a type of a dictionary. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### AliasDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary.md

#### AliasDictionary class

Represents a dictionary of aliases.

```csharp
public class AliasDictionary : DictionaryBase, IEnumerable<string>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of aliases contained in the `AliasDictionary`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string, string) | Adds the specified pair of alias and associated text to this instance of the `AliasDictionary`. |
| AddRange(AliasReplacementPair[]) | Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`. |
| AddRange(IEnumerable&lt;AliasReplacementPair&gt;) | Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`. |
| AddRange(IEnumerable&lt;KeyValuePair&lt;string, string&gt;&gt;) | Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`. |
| override Clear() | Removes all aliases from a `AliasDictionary` object. |
| Contains(string) | Determines whether an `AliasDictionary` object contains the specified alias. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetText(string) | Gets a text that is associated with the specified alias. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |
| Remove(string) | Removes the specified alias from an `AliasDictionary` object. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/add.md

#### AliasDictionary.Add method

Adds the specified pair of alias and associated text to this instance of the `AliasDictionary`.

```csharp
public void Add(string alias, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alias | String | The alias to add to the dictionary. |
| text | String | The text to be associated with the alias. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *alias* or *text* is `null`. |
| ArgumentException | Alias contains character that is not from the ranges a-b and 0-9. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/addrange.md

#### AddRange(IEnumerable&lt;KeyValuePair&lt;string, string&gt;&gt;)

Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`.

```csharp
public void AddRange(IEnumerable<KeyValuePair<string, string>> pairs)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pairs | IEnumerable`1 | The collection of alias/replacement pairs to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pairs* is `null`. |

#### AddRange(IEnumerable&lt;AliasReplacementPair&gt;)

Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`.

```csharp
public void AddRange(IEnumerable<AliasReplacementPair> pairs)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pairs | IEnumerable`1 | The collection of alias/replacement pairs to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pairs* is `null`. |

#### AddRange(AliasReplacementPair[])

Adds the specified collection of alias/replacement pairs to this instance of the `AliasDictionary`.

```csharp
public void AddRange(AliasReplacementPair[] pairs)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pairs | AliasReplacementPair[] | The collection of alias/replacement pairs to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pairs* is `null`. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/clear.md

#### AliasDictionary.Clear method

Removes all aliases from a `AliasDictionary` object.

```csharp
public override void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/contains.md

#### AliasDictionary.Contains method

Determines whether an `AliasDictionary` object contains the specified alias.

```csharp
public bool Contains(string alias)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alias | String | The alias to locate in the `AliasDictionary` object. |

##### Return Value

`true` if the `AliasDictionary` object contains the specified alias; otherwise, `false`.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *alias* is `null`. |

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/count.md

#### AliasDictionary.Count property

Gets the number of aliases contained in the `AliasDictionary`.

```csharp
public int Count { get; }
```

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/dictionarytype.md

#### AliasDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/getenumerator.md

#### AliasDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<string> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetText
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/gettext.md

#### AliasDictionary.GetText method

Gets a text that is associated with the specified alias.

```csharp
public string GetText(string alias)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alias | String | The alias to locate in the `AliasDictionary` object. |

##### Return Value

A text associated with the specified alias or `null`.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *alias* is `null`. |

### Remove
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasdictionary/remove.md

#### AliasDictionary.Remove method

Removes the specified alias from an `AliasDictionary` object.

```csharp
public bool Remove(string alias)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alias | String | The alias to remove. |

##### Return Value

This method returns `true` if the alias is successfully found and removed. This method returns `false` if the alias is not found in the `AliasDictionary` object.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *alias* is `null`. |

### AliasReplacementPair
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasreplacementpair.md

#### AliasReplacementPair class

Represents an alias/replacement pair.

```csharp
public class AliasReplacementPair
```

#### Constructors

| Name | Description |
| --- | --- |
| AliasReplacementPair(string, string) | Initializes a new instance of the `AliasReplacementPair` class. |

#### Properties

| Name | Description |
| --- | --- |
| Alias { get; } | Gets the alias. |
| Replacement { get; } | Gets the replacement. |

### Alias
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasreplacementpair/alias.md

#### AliasReplacementPair.Alias property

Gets the alias.

```csharp
public string Alias { get; }
```

### AliasReplacementPair
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasreplacementpair/aliasreplacementpair.md

#### AliasReplacementPair constructor

Initializes a new instance of the `AliasReplacementPair` class.

```csharp
public AliasReplacementPair(string alias, string replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alias | String | The alias to be replaced. |
| replacement | String | The replacement. |

### Replacement
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/aliasreplacementpair/replacement.md

#### AliasReplacementPair.Replacement property

Gets the replacement.

```csharp
public string Replacement { get; }
```

### Alphabet
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet.md

#### Alphabet class

Represents a dictionary of characters that is used during indexing to detect character type. Each character can be handled as separator, as letter, or both.

```csharp
public class Alphabet : DictionaryBase, IEnumerable<int>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of characters contained in the `Alphabet`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| override Clear() | Sets the Separator type for all characters in this `Alphabet`. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetCharacterType(char) | Gets a type of a character. |
| GetCharacterType(int) | Gets a type of a Unicode code point. |
| GetCharacterType(string) | Gets a type of a character. This method can be used to obtain the type of surrogate pair. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |
| SetRange(char[], CharacterType) | Sets the type for each character of the specified collection in this instance of the `Alphabet`. |
| SetRange(int[], CharacterType) | Sets the type for each character of the specified collection in this instance of the `Alphabet`. |
| SetRange(string[], CharacterType) | Sets the type for each character of the specified collection in this instance of the `Alphabet`. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/clear.md

#### Alphabet.Clear method

Sets the Separator type for all characters in this `Alphabet`.

```csharp
public override void Clear()
```

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/count.md

#### Alphabet.Count property

Gets the number of characters contained in the `Alphabet`.

```csharp
public int Count { get; }
```

##### Property Value

The number of characters in the dictionary.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/dictionarytype.md

#### Alphabet.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetCharacterType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/getcharactertype.md

#### GetCharacterType(char)

Gets a type of a character.

```csharp
public CharacterType GetCharacterType(char character)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | Char | The character to get a type. |

##### Return Value

A type of the character.

#### GetCharacterType(int)

Gets a type of a Unicode code point.

```csharp
public CharacterType GetCharacterType(int codePoint)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoint | Int32 | The Unicode code point to get a type. |

##### Return Value

A type of the Unicode code point.

#### GetCharacterType(string)

Gets a type of a character. This method can be used to obtain the type of surrogate pair.

```csharp
public CharacterType GetCharacterType(string character)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | String | The character or surrogate pair to get a type. |

##### Return Value

A type of the character.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/getenumerator.md

#### Alphabet.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<int> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### SetRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/alphabet/setrange.md

#### SetRange(char[], CharacterType)

Sets the type for each character of the specified collection in this instance of the `Alphabet`.

```csharp
public void SetRange(char[] characters, CharacterType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characters | Char[] | The collection of characters to set the type. |
| type | CharacterType | The character type. |

#### SetRange(string[], CharacterType)

Sets the type for each character of the specified collection in this instance of the `Alphabet`.

```csharp
public void SetRange(string[] characters, CharacterType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characters | String[] | The collection of characters and surrogate pairs to set the type. |
| type | CharacterType | The character type. |

#### SetRange(int[], CharacterType)

Sets the type for each character of the specified collection in this instance of the `Alphabet`.

```csharp
public void SetRange(int[] codePoints, CharacterType type)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoints | Int32[] | The collection of Unicode code points to set the type. |
| type | CharacterType | The character type. |

### CharacterReplacementDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary.md

#### CharacterReplacementDictionary class

Represents a character replacement dictionary that is used during the indexing process. Character replacement can be used, for example, to remove accents from accented characters or to make case-insensitive index.

```csharp
public class CharacterReplacementDictionary : DictionaryBase, IEnumerable<int>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of Unicode code points contained in this `CharacterReplacementDictionary`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(CharacterReplacementPair[]) | Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`. |
| AddRange(IEnumerable&lt;CharacterReplacementPair&gt;) | Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`. |
| AddRange(IEnumerable&lt;KeyValuePair&lt;char, char&gt;&gt;) | Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`. |
| AddRange(IEnumerable&lt;KeyValuePair&lt;int, int&gt;&gt;) | Adds the specified collection of Unicode code point replacements to this instance of the `CharacterReplacementDictionary`. |
| override Clear() | Removes all character replacements from a `CharacterReplacementDictionary` object. |
| Contains(int) | Determines whether a `CharacterReplacementDictionary` object contains a replacement for the specified Unicode code point. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetReplacement(int) | Gets a replacement for the specified Unicode code point. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |
| RemoveRange(char[]) | Removes the specified collection of character replacements from this instance of the `CharacterReplacementDictionary`. |
| RemoveRange(IEnumerable&lt;char&gt;) | Removes the specified collection of character replacements from this instance of the `CharacterReplacementDictionary`. |
| RemoveRange(IEnumerable&lt;int&gt;) | Removes the specified collection of Unicode code points replacements from this instance of the `CharacterReplacementDictionary`. |
| RemoveRange(int[]) | Removes the specified collection of Unicode code points replacements from this instance of the `CharacterReplacementDictionary`. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/addrange.md

#### AddRange(IEnumerable&lt;KeyValuePair&lt;char, char&gt;&gt;)

Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`.

```csharp
public void AddRange(IEnumerable<KeyValuePair<char, char>> characterReplacements)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | IEnumerable`1 | The collection of character replacements to add to the dictionary. |

#### AddRange(IEnumerable&lt;KeyValuePair&lt;int, int&gt;&gt;)

Adds the specified collection of Unicode code point replacements to this instance of the `CharacterReplacementDictionary`.

```csharp
public void AddRange(IEnumerable<KeyValuePair<int, int>> characterReplacements)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | IEnumerable`1 | The collection of Unicode code point replacements to add to the dictionary. |

#### AddRange(IEnumerable&lt;CharacterReplacementPair&gt;)

Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`.

```csharp
public void AddRange(IEnumerable<CharacterReplacementPair> characterReplacements)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | IEnumerable`1 | The collection of character replacements to add to the dictionary. |

#### AddRange(CharacterReplacementPair[])

Adds the specified collection of character replacements to this instance of the `CharacterReplacementDictionary`.

```csharp
public void AddRange(CharacterReplacementPair[] characterReplacements)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characterReplacements | CharacterReplacementPair[] | The collection of character replacements to add to the dictionary. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/clear.md

#### CharacterReplacementDictionary.Clear method

Removes all character replacements from a `CharacterReplacementDictionary` object.

```csharp
public override void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/contains.md

#### CharacterReplacementDictionary.Contains method

Determines whether a `CharacterReplacementDictionary` object contains a replacement for the specified Unicode code point.

```csharp
public bool Contains(int codePoint)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoint | Int32 | The Unicode code point to locate in the `CharacterReplacementDictionary` object. |

##### Return Value

`true` if the `CharacterReplacementDictionary` object contains the specified Unicode code point; otherwise, `false`.

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/count.md

#### CharacterReplacementDictionary.Count property

Gets the number of Unicode code points contained in this `CharacterReplacementDictionary`.

```csharp
public int Count { get; }
```

##### Property Value

The number of Unicode code points in the dictionary.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/dictionarytype.md

#### CharacterReplacementDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/getenumerator.md

#### CharacterReplacementDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<int> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetReplacement
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/getreplacement.md

#### CharacterReplacementDictionary.GetReplacement method

Gets a replacement for the specified Unicode code point.

```csharp
public int GetReplacement(int codePoint)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoint | Int32 | The character to get a replacement for. |

##### Return Value

The replacement for the specified Unicode code point.

### RemoveRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementdictionary/removerange.md

#### RemoveRange(IEnumerable&lt;char&gt;)

Removes the specified collection of character replacements from this instance of the `CharacterReplacementDictionary`.

```csharp
public void RemoveRange(IEnumerable<char> characters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characters | IEnumerable`1 | The collection of characters to remove. |

#### RemoveRange(IEnumerable&lt;int&gt;)

Removes the specified collection of Unicode code points replacements from this instance of the `CharacterReplacementDictionary`.

```csharp
public void RemoveRange(IEnumerable<int> codePoints)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoints | IEnumerable`1 | The collection of Unicode code points to remove. |

#### RemoveRange(char[])

Removes the specified collection of character replacements from this instance of the `CharacterReplacementDictionary`.

```csharp
public void RemoveRange(char[] characters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| characters | Char[] | The collection of characters to remove. |

#### RemoveRange(int[])

Removes the specified collection of Unicode code points replacements from this instance of the `CharacterReplacementDictionary`.

```csharp
public void RemoveRange(int[] codePoints)
```

| Parameter | Type | Description |
| --- | --- | --- |
| codePoints | Int32[] | The collection of Unicode code points to remove. |

### CharacterReplacementPair
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementpair.md

#### CharacterReplacementPair class

Represents a character/replacement pair.

```csharp
public class CharacterReplacementPair
```

#### Constructors

| Name | Description |
| --- | --- |
| CharacterReplacementPair(char, char) | Initializes a new instance of the `CharacterReplacementPair` class. |
| CharacterReplacementPair(int, int) | Initializes a new instance of the `CharacterReplacementPair` class. |

#### Properties

| Name | Description |
| --- | --- |
| Character { get; } | Gets the Unicode code point to be replaced. |
| Replacement { get; } | Gets the replacement Unicode code point. |

### Character
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementpair/character.md

#### CharacterReplacementPair.Character property

Gets the Unicode code point to be replaced.

```csharp
public int Character { get; }
```

### CharacterReplacementPair
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementpair/characterreplacementpair.md

#### CharacterReplacementPair(char, char)

Initializes a new instance of the `CharacterReplacementPair` class.

```csharp
public CharacterReplacementPair(char character, char replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | Char | The character to be replaced. |
| replacement | Char | The replacement. |

#### CharacterReplacementPair(int, int)

Initializes a new instance of the `CharacterReplacementPair` class.

```csharp
public CharacterReplacementPair(int character, int replacement)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | Int32 | The Unicode code point to be replaced. |
| replacement | Int32 | The replacement Unicode code point. |

### Replacement
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/characterreplacementpair/replacement.md

#### CharacterReplacementPair.Replacement property

Gets the replacement Unicode code point.

```csharp
public int Replacement { get; }
```

### CharacterType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/charactertype.md

#### CharacterType enumeration

Represents a type of a character, depending on how it should be indexed.

```csharp
public enum CharacterType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Separator | `0` | The separator character. |
| Letter | `1` | The valid character. |
| Blended | `2` | Both the separator and the valid character. |
| SeparateWord | `3` | The character that represents a whole word. |

### DictionaryBase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarybase.md

#### DictionaryBase class

Represents the base class for a dictionary.

```csharp
public abstract class DictionaryBase
```

#### Properties

| Name | Description |
| --- | --- |
| abstract DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| abstract Clear() | Clears the dictionary. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarybase/clear.md

#### DictionaryBase.Clear method

Clears the dictionary.

```csharp
public abstract void Clear()
```

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarybase/dictionarytype.md

#### DictionaryBase.DictionaryType property

Gets the dictionary type.

```csharp
public abstract DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### ExportDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarybase/exportdictionary.md

#### DictionaryBase.ExportDictionary method

Exports the dictionary to a file with the specified name.

```csharp
public void ExportDictionary(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file to export to. |

### ImportDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarybase/importdictionary.md

#### DictionaryBase.ImportDictionary method

Imports a dictionary from the specified file.

```csharp
public void ImportDictionary(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file to import from. |

### DictionaryRepository
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository.md

#### DictionaryRepository class

Represents a repository of all dictionaries in the Index.

```csharp
public class DictionaryRepository
```

#### Properties

| Name | Description |
| --- | --- |
| AliasDictionary { get; } | Gets a dictionary of aliases. |
| Alphabet { get; } | Gets the dictionary of characters used by the internal tokenization mechanism to split text into words. |
| CharacterReplacements { get; } | Gets a dictionary of character replacements. |
| DocumentPasswords { get; } | Gets a dictionary of document passwords. |
| HomophoneDictionary { get; } | Gets a dictionary of homophones. |
| SpellingCorrector { get; } | Gets a spelling corrector. |
| StopWordDictionary { get; } | Gets a dictionary of stop words. |
| SynonymDictionary { get; } | Gets a dictionary of synonyms. |
| TokenizationDictionary { get; } | Gets the dictionary of characters that defines whether a token is considered as a valid word or a separator when using external tokenization tools. |
| WordFormsProvider { get; set; } | Gets or sets a word forms provider. |

### AliasDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/aliasdictionary.md

#### DictionaryRepository.AliasDictionary property

Gets a dictionary of aliases.

```csharp
public AliasDictionary AliasDictionary { get; }
```

##### Property Value

The dictionary of aliases.

### Alphabet
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/alphabet.md

#### DictionaryRepository.Alphabet property

Gets the dictionary of characters used by the internal tokenization mechanism to split text into words.

```csharp
public Alphabet Alphabet { get; }
```

##### Property Value

The dictionary of characters.

### CharacterReplacements
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/characterreplacements.md

#### DictionaryRepository.CharacterReplacements property

Gets a dictionary of character replacements.

```csharp
public CharacterReplacementDictionary CharacterReplacements { get; }
```

##### Property Value

The dictionary of character replacements.

### DocumentPasswords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/documentpasswords.md

#### DictionaryRepository.DocumentPasswords property

Gets a dictionary of document passwords.

```csharp
public PasswordDictionary DocumentPasswords { get; }
```

##### Property Value

The dictionary of document passwords.

### HomophoneDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/homophonedictionary.md

#### DictionaryRepository.HomophoneDictionary property

Gets a dictionary of homophones.

```csharp
public HomophoneDictionary HomophoneDictionary { get; }
```

##### Property Value

The dictionary of homophones.

### SpellingCorrector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/spellingcorrector.md

#### DictionaryRepository.SpellingCorrector property

Gets a spelling corrector.

```csharp
public SpellingCorrector SpellingCorrector { get; }
```

##### Property Value

The spelling corrector.

### StopWordDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/stopworddictionary.md

#### DictionaryRepository.StopWordDictionary property

Gets a dictionary of stop words.

```csharp
public StopWordDictionary StopWordDictionary { get; }
```

##### Property Value

The dictionary of stop words.

### SynonymDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/synonymdictionary.md

#### DictionaryRepository.SynonymDictionary property

Gets a dictionary of synonyms.

```csharp
public SynonymDictionary SynonymDictionary { get; }
```

##### Property Value

The dictionary of synonyms.

### TokenizationDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/tokenizationdictionary.md

#### DictionaryRepository.TokenizationDictionary property

Gets the dictionary of characters that defines whether a token is considered as a valid word or a separator when using external tokenization tools.

```csharp
public Alphabet TokenizationDictionary { get; }
```

##### Property Value

The dictionary of characters.

### WordFormsProvider
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionaryrepository/wordformsprovider.md

#### DictionaryRepository.WordFormsProvider property

Gets or sets a word forms provider.

```csharp
public IWordFormsProvider WordFormsProvider { get; set; }
```

##### Property Value

The word forms provider.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/dictionarytype.md

#### DictionaryType enumeration

Represents a type of a dictionary.

```csharp
public enum DictionaryType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Alphabet | `0` | The alphabet. |
| AliasDictionary | `1` | The alias dictionary. |
| CharacterReplacementDictionary | `2` | The character replacement dictionary. |
| SynonymDictionary | `3` | The synonym dictionary. |
| HomophoneDictionary | `4` | The homophone dictionary. |
| SpellingCorrector | `5` | The spelling corrector. |
| StopWordDictionary | `6` | The stop word dictionary. |
| PasswordDictionary | `7` | The password dictionary. |
| TokenizationDictionary | `8` | The tokenization dictionary. |

### EnglishWordFormsProvider
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/englishwordformsprovider.md

#### EnglishWordFormsProvider class

Represents an English word forms provider.

```csharp
public class EnglishWordFormsProvider : IWordFormsProvider
```

#### Constructors

| Name | Description |
| --- | --- |
| EnglishWordFormsProvider() | Initializes a new instance of the `EnglishWordFormsProvider` class. |

#### Methods

| Name | Description |
| --- | --- |
| GetWordForms(string) | Gets the word forms for the specified word. The resulting array does not contain the original word. |

### EnglishWordFormsProvider
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/englishwordformsprovider/englishwordformsprovider.md

#### EnglishWordFormsProvider constructor

Initializes a new instance of the `EnglishWordFormsProvider` class.

```csharp
public EnglishWordFormsProvider()
```

### GetWordForms
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/englishwordformsprovider/getwordforms.md

#### EnglishWordFormsProvider.GetWordForms method

Gets the word forms for the specified word. The resulting array does not contain the original word.

```csharp
public string[] GetWordForms(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word to suggest the word forms. |

##### Return Value

The word forms for the specified word or empty array if the `IWordFormsProvider` does not provide word forms for the specified word.

### HomophoneDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary.md

#### HomophoneDictionary class

Represents a dictionary of heterographic homophones.

```csharp
public class HomophoneDictionary : DictionaryBase, IEnumerable<string>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of words contained in this `HomophoneDictionary`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(IEnumerable&lt;string[]&gt;) | Adds the specified collection of homophone groups to this instance of the `HomophoneDictionary`. |
| AddRange(string[][]) | Adds the specified collection of homophone groups to this instance of the `HomophoneDictionary`. |
| override Clear() | Removes all words from a `HomophoneDictionary` object. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetAllHomophoneGroups() | Gets all groups of homophones contained in this dictionary. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetHomophoneGroups(string) | Gets all groups of homophones to which the specified word belongs. |
| GetHomophones(string) | Gets the homophones for the specified word. The resulting array does not contain the original word. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/addrange.md

#### AddRange(IEnumerable&lt;string[]&gt;)

Adds the specified collection of homophone groups to this instance of the `HomophoneDictionary`.

```csharp
public void AddRange(IEnumerable<string[]> homophones)
```

| Parameter | Type | Description |
| --- | --- | --- |
| homophones | IEnumerable`1 | The collection of homophone groups to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *homophones* is `null`. |
| ArgumentException | Thrown when number of homophones in a group is less than 2. |

#### AddRange(string[][])

Adds the specified collection of homophone groups to this instance of the `HomophoneDictionary`.

```csharp
public void AddRange(string[][] homophones)
```

| Parameter | Type | Description |
| --- | --- | --- |
| homophones | String[][] | The collection of homophone groups to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *homophones* is `null`. |
| ArgumentException | Thrown when number of homophones in a group is less than 2. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/clear.md

#### HomophoneDictionary.Clear method

Removes all words from a `HomophoneDictionary` object.

```csharp
public override void Clear()
```

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/count.md

#### HomophoneDictionary.Count property

Gets the number of words contained in this `HomophoneDictionary`.

```csharp
public int Count { get; }
```

##### Property Value

The number of words.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/dictionarytype.md

#### HomophoneDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetAllHomophoneGroups
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/getallhomophonegroups.md

#### HomophoneDictionary.GetAllHomophoneGroups method

Gets all groups of homophones contained in this dictionary.

```csharp
public string[][] GetAllHomophoneGroups()
```

##### Return Value

All groups of homophones.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/getenumerator.md

#### HomophoneDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<string> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetHomophoneGroups
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/gethomophonegroups.md

#### HomophoneDictionary.GetHomophoneGroups method

Gets all groups of homophones to which the specified word belongs.

```csharp
public string[][] GetHomophoneGroups(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word for getting groups of homophones. |

##### Return Value

All groups of homophones to which the specified word belongs.

### GetHomophones
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/homophonedictionary/gethomophones.md

#### HomophoneDictionary.GetHomophones method

Gets the homophones for the specified word. The resulting array does not contain the original word.

```csharp
public string[] GetHomophones(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word to suggest the homophones. |

##### Return Value

The homophones for the specified word or empty array if the `HomophoneDictionary` object does not contain the specified word.

### IWordFormsProvider
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/iwordformsprovider.md

#### IWordFormsProvider interface

Defines interface of a word forms provider.

```csharp
public interface IWordFormsProvider
```

#### Methods

| Name | Description |
| --- | --- |
| GetWordForms(string) | Gets the word forms for the specified word. The resulting array does not contain the original word. |

##### Examples

The following example demonstrates how to implement a custom word forms provider.

```csharp
public class SimpleWordFormsProvider : IWordFormsProvider
{
    public string[] GetWordForms(string word)
    {
        List<string> result = new List<string>();

        // Assume that the input word is in the plural, then we add the singular
        if (word.Length > 2 &&
            word.EndsWith("es", StringComparison.InvariantCultureIgnoreCase))
        {
            result.Add(word.Substring(0, word.Length - 2));
        }
        if (word.Length > 1 &&
            word.EndsWith("s", StringComparison.InvariantCultureIgnoreCase))
        {
            result.Add(word.Substring(0, word.Length - 1));
        }

        // Then assume that the input word is in the singular, we add the plural
        if (word.Length > 1 &&
            word.EndsWith("y", StringComparison.InvariantCultureIgnoreCase))
        {
            result.Add(word.Substring(0, word.Length - 1) + "is");
        }
        result.Add(word + "s");
        result.Add(word + "es");
        // All rules are implemented in the EnglishWordFormsProvider class

        return result.ToArray();
    }
}
```

The next example demonstrates how to set a custom word forms provider for using.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
  
// Creating an index in the specified folder
Index index = new Index(indexFolder);
  
// Indexing documents from the specified folder
index.Add(documentsFolder);
 
// Setting the custom word forms provider instance
index.Dictionaries.WordFormsProvider = new SimpleWordFormsProvider();
 
// Creating a search options instance
SearchOptions options = new SearchOptions();
options.UseWordFormsSearch = true; // Enabling search for word forms
  
// Searching in the index
SearchResult result = index.Search("relative", options);
  
// The following words can be found:
// relative
// relatives
```

### GetWordForms
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/iwordformsprovider/getwordforms.md

#### IWordFormsProvider.GetWordForms method

Gets the word forms for the specified word. The resulting array does not contain the original word.

```csharp
public string[] GetWordForms(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word to suggest the word forms. |

##### Return Value

The word forms for the specified word or empty array if the `IWordFormsProvider` does not provide word forms for the specified word.

### PasswordDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary.md

#### PasswordDictionary class

Represents a dictionary of document passwords.

```csharp
public class PasswordDictionary : DictionaryBase, IEnumerable<string>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of elements contained in the dictionary. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string, string) | Adds a password for a document to the dictionary. |
| override Clear() | Removes all passwords from this `PasswordDictionary` object. |
| Contains(string) | Determines whether the dictionary contains a password for the specified document. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetPassword(string) | Gets the password for the file. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |
| Remove(string) | Removes a password of the specified document from the dictionary. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/add.md

#### PasswordDictionary.Add method

Adds a password for a document to the dictionary.

```csharp
public void Add(string key, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | The full file path or a document key. |
| password | String | The document password. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/clear.md

#### PasswordDictionary.Clear method

Removes all passwords from this `PasswordDictionary` object.

```csharp
public override void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/contains.md

#### PasswordDictionary.Contains method

Determines whether the dictionary contains a password for the specified document.

```csharp
public bool Contains(string key)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | The full file path or a document key. |

##### Return Value

`true` if the dictionary contains a password for the document; otherwise, `false`.

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/count.md

#### PasswordDictionary.Count property

Gets the number of elements contained in the dictionary.

```csharp
public int Count { get; }
```

##### Property Value

The number of elements contained in the dictionary.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/dictionarytype.md

#### PasswordDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/getenumerator.md

#### PasswordDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<string> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetPassword
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/getpassword.md

#### PasswordDictionary.GetPassword method

Gets the password for the file.

```csharp
public string GetPassword(string key)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | The full file path or a document key. |

##### Return Value

The password for the document.

### Remove
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/passworddictionary/remove.md

#### PasswordDictionary.Remove method

Removes a password of the specified document from the dictionary.

```csharp
public bool Remove(string key)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | The full file path or a document key. |

##### Return Value

`true` if the password was successfully removed; otherwise, `false`. This method also returns `false` if *key* was not found in the dictionary.

### SpellingCorrector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector.md

#### SpellingCorrector class

Represents a spelling corrector for terms in a query.

```csharp
public class SpellingCorrector : DictionaryBase
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of words contained in this `SpellingCorrector`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(IEnumerable&lt;string&gt;) | Adds the specified collection of words to this instance of the `SpellingCorrector`. |
| AddRange(string[]) | Adds the specified collection of words to this instance of the `SpellingCorrector`. |
| override Clear() | Removes all words from a `SpellingCorrector` object. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetWords() | Gets the collection of words that is currently contained in this `SpellingCorrector`. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector/addrange.md

#### AddRange(IEnumerable&lt;string&gt;)

Adds the specified collection of words to this instance of the `SpellingCorrector`.

```csharp
public void AddRange(IEnumerable<string> words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | IEnumerable`1 | The collection of words to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *words* is `null`. |

#### AddRange(string[])

Adds the specified collection of words to this instance of the `SpellingCorrector`.

```csharp
public void AddRange(string[] words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | String[] | The collection of words to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *words* is `null`. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector/clear.md

#### SpellingCorrector.Clear method

Removes all words from a `SpellingCorrector` object.

```csharp
public override void Clear()
```

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector/count.md

#### SpellingCorrector.Count property

Gets the number of words contained in this `SpellingCorrector`.

```csharp
public int Count { get; }
```

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector/dictionarytype.md

#### SpellingCorrector.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetWords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/spellingcorrector/getwords.md

#### SpellingCorrector.GetWords method

Gets the collection of words that is currently contained in this `SpellingCorrector`.

```csharp
public string[] GetWords()
```

##### Return Value

The collection of words.

### StopWordDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary.md

#### StopWordDictionary class

Represents a dictionary of stop words.

```csharp
public class StopWordDictionary : DictionaryBase, IEnumerable<string>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of stop words contained in the `StopWordDictionary`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(IEnumerable&lt;string&gt;) | Adds the specified collection of words to this instance of the `StopWordDictionary`. |
| AddRange(string[]) | Adds the specified collection of words to this instance of the `StopWordDictionary`. |
| override Clear() | Removes all words from a `StopWordDictionary` object. |
| Contains(string) | Determines whether a `StopWordDictionary` object contains the specified word. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |
| RemoveRange(IEnumerable&lt;string&gt;) | Removes the specified collection of words from this instance of the `StopWordDictionary`. |
| RemoveRange(string[]) | Removes the specified collection of words from this instance of the `StopWordDictionary`. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/addrange.md

#### AddRange(IEnumerable&lt;string&gt;)

Adds the specified collection of words to this instance of the `StopWordDictionary`.

```csharp
public void AddRange(IEnumerable<string> words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | IEnumerable`1 | The collection of words to add to the dictionary. |

#### AddRange(string[])

Adds the specified collection of words to this instance of the `StopWordDictionary`.

```csharp
public void AddRange(string[] words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | String[] | The collection of words to add to the dictionary. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/clear.md

#### StopWordDictionary.Clear method

Removes all words from a `StopWordDictionary` object.

```csharp
public override void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/contains.md

#### StopWordDictionary.Contains method

Determines whether a `StopWordDictionary` object contains the specified word.

```csharp
public bool Contains(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word to locate in the `StopWordDictionary` object. |

##### Return Value

`true` if the `StopWordDictionary` object contains the specified word; otherwise, `false`.

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/count.md

#### StopWordDictionary.Count property

Gets the number of stop words contained in the `StopWordDictionary`.

```csharp
public int Count { get; }
```

##### Property Value

The number of stop words in the dictionary.

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/dictionarytype.md

#### StopWordDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/getenumerator.md

#### StopWordDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<string> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### RemoveRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/stopworddictionary/removerange.md

#### RemoveRange(IEnumerable&lt;string&gt;)

Removes the specified collection of words from this instance of the `StopWordDictionary`.

```csharp
public void RemoveRange(IEnumerable<string> words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | IEnumerable`1 | The collection of words to remove. |

#### RemoveRange(string[])

Removes the specified collection of words from this instance of the `StopWordDictionary`.

```csharp
public void RemoveRange(string[] words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| words | String[] | The collection of words to remove. |

### SynonymDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary.md

#### SynonymDictionary class

Represents a dictionary of synonyms.

```csharp
public class SynonymDictionary : DictionaryBase, IEnumerable<string>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of words contained in this `SynonymDictionary`. |
| override DictionaryType { get; } | Gets the dictionary type. |

#### Methods

| Name | Description |
| --- | --- |
| AddRange(IEnumerable&lt;string[]&gt;) | Adds the specified collection of synonym groups to this instance of the `SynonymDictionary`. |
| AddRange(string[][]) | Adds the specified collection of synonym groups to this instance of the `SynonymDictionary`. |
| override Clear() | Removes all words from this `SynonymDictionary` object. |
| ExportDictionary(string) | Exports the dictionary to a file with the specified name. |
| GetAllSynonymGroups() | Gets all groups of synonyms contained in this dictionary. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| GetSynonymGroups(string) | Gets all groups of synonyms to which the specified word belongs. |
| GetSynonyms(string) | Gets the synonyms for the specified word. The resulting array does not contain the original word. |
| ImportDictionary(string) | Imports a dictionary from the specified file. |

### AddRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/addrange.md

#### AddRange(IEnumerable&lt;string[]&gt;)

Adds the specified collection of synonym groups to this instance of the `SynonymDictionary`.

```csharp
public void AddRange(IEnumerable<string[]> synonyms)
```

| Parameter | Type | Description |
| --- | --- | --- |
| synonyms | IEnumerable`1 | The collection of synonym groups to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *synonyms* is `null`. |
| ArgumentException | Thrown when number of synonyms in a group is less than 2. |

#### AddRange(string[][])

Adds the specified collection of synonym groups to this instance of the `SynonymDictionary`.

```csharp
public void AddRange(string[][] synonyms)
```

| Parameter | Type | Description |
| --- | --- | --- |
| synonyms | String[][] | The collection of synonym groups to add to the dictionary. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *synonyms* is `null`. |
| ArgumentException | Thrown when number of synonyms in a group is less than 2. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/clear.md

#### SynonymDictionary.Clear method

Removes all words from this `SynonymDictionary` object.

```csharp
public override void Clear()
```

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/count.md

#### SynonymDictionary.Count property

Gets the number of words contained in this `SynonymDictionary`.

```csharp
public int Count { get; }
```

### DictionaryType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/dictionarytype.md

#### SynonymDictionary.DictionaryType property

Gets the dictionary type.

```csharp
public override DictionaryType DictionaryType { get; }
```

##### Property Value

The dictionary type.

### GetAllSynonymGroups
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/getallsynonymgroups.md

#### SynonymDictionary.GetAllSynonymGroups method

Gets all groups of synonyms contained in this dictionary.

```csharp
public string[][] GetAllSynonymGroups()
```

##### Return Value

All groups of synonyms.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/getenumerator.md

#### SynonymDictionary.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<string> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### GetSynonymGroups
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/getsynonymgroups.md

#### SynonymDictionary.GetSynonymGroups method

Gets all groups of synonyms to which the specified word belongs.

```csharp
public string[][] GetSynonymGroups(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word for getting groups of synonyms. |

##### Return Value

All groups of synonyms to which the specified word belongs.

### GetSynonyms
Path: https://reference.groupdocs.com/search/net/groupdocs.search.dictionaries/synonymdictionary/getsynonyms.md

#### SynonymDictionary.GetSynonyms method

Gets the synonyms for the specified word. The resulting array does not contain the original word.

```csharp
public string[] GetSynonyms(string word)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word to suggest the synonyms. |

##### Return Value

The synonyms for the specified word or empty array if the `SynonymDictionary` object does not contain the specified word.

### GroupDocs.Search.Events
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events.md

The namespace provides classes of event arguments.

#### Classes

| Class | Description |
| --- | --- |
| BaseIndexEventArgs | Represents the base class of event arguments. |
| EventHub | Provides index events for subscribing. |
| FileIndexingEventArgs | Represents arguments for the event of a document indexing start. |
| ImagePreparingEventArgs | Represents arguments for the event of an image preparing start. |
| IndexErrorEventArgs | Represents arguments for the event of index error occurred. |
| OperationFinishedEventArgs | Represents arguments for the event of the indexing operation is finished. |
| OperationProgressEventArgs | Represents the arguments for the progress change event of the indexing operation. |
| OptimizationProgressEventArgs | Represents the arguments for the progress change event of the optimization operation. |
| PasswordRequiredEventArgs | Represents arguments for the event that occurs when document protected by a password is indexing. |
| SearchPhaseEventArgs | Represents arguments for the search phase changing events. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| OperationType | Represents an index operation type. |
| SearchPhase | Represents the search phases. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### BaseIndexEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/baseindexeventargs.md

#### BaseIndexEventArgs class

Represents the base class of event arguments.

```csharp
public class BaseIndexEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |

### IndexFolder
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/baseindexeventargs/indexfolder.md

#### BaseIndexEventArgs.IndexFolder property

Gets the index folder.

```csharp
public string IndexFolder { get; }
```

##### Property Value

The index folder.

### IndexId
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/baseindexeventargs/indexid.md

#### BaseIndexEventArgs.IndexId property

Gets the index ID.

```csharp
public Guid IndexId { get; }
```

##### Property Value

The index ID.

### Status
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/baseindexeventargs/status.md

#### BaseIndexEventArgs.Status property

Gets the index status.

```csharp
public IndexStatus Status { get; }
```

##### Property Value

The index status.

### Time
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/baseindexeventargs/time.md

#### BaseIndexEventArgs.Time property

Gets the time of an event.

```csharp
public DateTime Time { get; }
```

##### Property Value

The time of an event.

### EventHub
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub.md

#### EventHub class

Provides index events for subscribing.

```csharp
public class EventHub
```

#### Events

| Name | Description |
| --- | --- |
| event ErrorOccurred | Occurs when an error occurs during an index operation. |
| event FileIndexing | Occurs when a document is going to be indexed. |
| event ImagePreparing | Occurs when an image is going to be prepared for indexing. |
| event OperationFinished | Occurs when an index operation is finished. |
| event OperationProgressChanged | Occurs when the progress of the indexing or update operation changes. |
| event OptimizationProgressChanged | Occurs when the progress of the optimization operation changes. |
| event PasswordRequired | Occurs when a document requires password for opening. |
| event SearchPhaseCompleted | Occurs when the search phase is completed. |
| event StatusChanged | Occurs when the index status changes. |

##### Examples

The example demonstrates a typical usage of the interface.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.ErrorOccurred += (sender, args) =>
{
    Console.WriteLine(args.Message);
};

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Searching in the index
SearchResult result = index.Search(query);
```

### ErrorOccurred
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/erroroccurred.md

#### EventHub.ErrorOccurred event

Occurs when an error occurs during an index operation.

```csharp
public event EventHandler<IndexErrorEventArgs> ErrorOccurred;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.ErrorOccurred += (sender, args) =>
{
    Console.WriteLine(args.Message);
};

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Searching in the index
SearchResult result = index.Search(query);
```

### FileIndexing
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/fileindexing.md

#### EventHub.FileIndexing event

Occurs when a document is going to be indexed.

```csharp
public event EventHandler<FileIndexingEventArgs> FileIndexing;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.FileIndexing += (sender, args) =>
{
    if (args.DocumentFullPath.EndsWith("Protected.pdf", StringComparison.InvariantCultureIgnoreCase))
    {
        args.AdditionalFields = new DocumentField[]
        {
            new DocumentField("Tags", "Protected")
        };
    }
    if (!args.DocumentFullPath.ToLowerInvariant().Contains("important"))
    {
        args.SkipIndexing = true;
    }
};

// Indexing documents from the specified folder
index.Add(documentsFolder);
```

### ImagePreparing
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/imagepreparing.md

#### EventHub.ImagePreparing event

Occurs when an image is going to be prepared for indexing.

```csharp
public event EventHandler<ImagePreparingEventArgs> ImagePreparing;
```

### OperationFinished
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/operationfinished.md

#### EventHub.OperationFinished event

Occurs when an index operation is finished.

```csharp
public event EventHandler<OperationFinishedEventArgs> OperationFinished;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.OperationFinished += (sender, args) =>
{
    Console.WriteLine("Operation finished: " + args.OperationType);
    Console.WriteLine("Message: " + args.Message);
    Console.WriteLine("Index folder: " + args.IndexFolder);
    Console.WriteLine("Time: " + args.Time);
};

// Indexing documents from the specified folder
index.Add(documentsFolder);
```

### OperationProgressChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/operationprogresschanged.md

#### EventHub.OperationProgressChanged event

Occurs when the progress of the indexing or update operation changes.

```csharp
public event EventHandler<OperationProgressEventArgs> OperationProgressChanged;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.OperationProgressChanged += (sender, args) =>
{
    Console.WriteLine("Last processed: " + args.LastDocumentPath);
    Console.WriteLine("Result: " + args.LastDocumentStatus);
    Console.WriteLine("Processed documents: " + args.TotalDocuments);
    Console.WriteLine("Progress percentage: " + args.ProgressPercentage);
};

// Indexing documents from the specified folder
index.Add(documentsFolder);
```

### OptimizationProgressChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/optimizationprogresschanged.md

#### EventHub.OptimizationProgressChanged event

Occurs when the progress of the optimization operation changes.

```csharp
public event EventHandler<OptimizationProgressEventArgs> OptimizationProgressChanged;
```

### PasswordRequired
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/passwordrequired.md

#### EventHub.PasswordRequired event

Occurs when a document requires password for opening.

```csharp
public event EventHandler<PasswordRequiredEventArgs> PasswordRequired;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.PasswordRequired += (sender, args) =>
{
    if (args.DocumentFullPath.EndsWith("ProtectedDocument.pdf", StringComparison.InvariantCultureIgnoreCase))
    {
        args.Password = "123456";
    }
};

// Indexing documents from the specified folder
index.Add(documentsFolder);
```

### SearchPhaseCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/searchphasecompleted.md

#### EventHub.SearchPhaseCompleted event

Occurs when the search phase is completed.

```csharp
public event EventHandler<SearchPhaseEventArgs> SearchPhaseCompleted;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Subscribing to the event
index.Events.SearchPhaseCompleted += (sender, args) =>
{
    Console.WriteLine("Search phase: " + args.SearchPhase);
    Console.WriteLine("Words: " + args.Words.Length);
};

SearchOptions options = new SearchOptions();
options.UseSynonymSearch = true;
options.UseWordFormsSearch = true;
options.FuzzySearch.Enabled = true;
options.UseHomophoneSearch = true;
SearchResult result = index.Search("Einstein", options);
```

### StatusChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/eventhub/statuschanged.md

#### EventHub.StatusChanged event

Occurs when the index status changes.

```csharp
public event EventHandler<BaseIndexEventArgs> StatusChanged;
```

##### Examples

The example demonstrates how to use the event.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Subscribing to the event
index.Events.StatusChanged += (sender, args) =>
{
    if (args.Status != IndexStatus.InProgress)
    {
        // A notification of the operation completion should be here
    }
};

// Setting the flag for asynchronous indexing
IndexingOptions options = new IndexingOptions();
options.IsAsync = true;

// Asynchronous indexing documents from the specified folder
// The method terminates before the operation completes
index.Add(documentsFolder, options);
```

### FileIndexingEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs.md

#### FileIndexingEventArgs class

Represents arguments for the event of a document indexing start.

```csharp
public class FileIndexingEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| AdditionalFields { get; set; } | Gets or set the additional fields for the document. |
| Attributes { get; set; } | Gets or set the attributes of the document. |
| CustomExtractor { get; set; } | Gets or set the custom text extractor. |
| Document { get; } | Gets the document. |
| DocumentFullPath { get; } | Gets the document full path. |
| DocumentKey { get; } | Gets the document key. |
| Encoding { get; set; } | Gets or sets the encoding of the document. |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| SkipIndexing { get; set; } | Gets or sets a value indicating that indexing of the document should be skipped. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |
| WordSplitter { get; set; } | Gets or sets the custom word splitter used to split text into words. |

### AdditionalFields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/additionalfields.md

#### FileIndexingEventArgs.AdditionalFields property

Gets or set the additional fields for the document.

```csharp
public DocumentField[] AdditionalFields { get; set; }
```

##### Property Value

The additional fields for the document.

### Attributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/attributes.md

#### FileIndexingEventArgs.Attributes property

Gets or set the attributes of the document.

```csharp
public string[] Attributes { get; set; }
```

##### Property Value

The attributes of the document.

### CustomExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/customextractor.md

#### FileIndexingEventArgs.CustomExtractor property

Gets or set the custom text extractor.

```csharp
public IFieldExtractor CustomExtractor { get; set; }
```

##### Property Value

The custom text extractor.

### Document
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/document.md

#### FileIndexingEventArgs.Document property

Gets the document.

```csharp
public Document Document { get; }
```

##### Property Value

The document.

### DocumentFullPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/documentfullpath.md

#### FileIndexingEventArgs.DocumentFullPath property

Gets the document full path.

```csharp
public string DocumentFullPath { get; }
```

##### Property Value

The document full path.

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/documentkey.md

#### FileIndexingEventArgs.DocumentKey property

Gets the document key.

```csharp
public string DocumentKey { get; }
```

##### Property Value

The document key.

### Encoding
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/encoding.md

#### FileIndexingEventArgs.Encoding property

Gets or sets the encoding of the document.

```csharp
public string Encoding { get; set; }
```

##### Property Value

The encoding of the document.

### SkipIndexing
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/skipindexing.md

#### FileIndexingEventArgs.SkipIndexing property

Gets or sets a value indicating that indexing of the document should be skipped.

```csharp
public bool SkipIndexing { get; set; }
```

##### Property Value

A value indicating that indexing of the document should be skipped.

### WordSplitter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/fileindexingeventargs/wordsplitter.md

#### FileIndexingEventArgs.WordSplitter property

Gets or sets the custom word splitter used to split text into words.

```csharp
public IWordSplitter WordSplitter { get; set; }
```

##### Property Value

The custom word splitter used to split text into words. A `null` value means that the built-in word splitter will be used.

### ImagePreparingEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs.md

#### ImagePreparingEventArgs class

Represents arguments for the event of an image preparing start.

```csharp
public class ImagePreparingEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentKey { get; } | Gets the document key. |
| ImageFrames { get; } | Gets the image frames. |
| ImageIndex { get; } | Gets the ordinal number of the image in the document. |
| ImageStream { get; } | Gets the image stream. |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| InnerPath { get; } | Gets the inner path of a nested document. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs/documentkey.md

#### ImagePreparingEventArgs.DocumentKey property

Gets the document key.

```csharp
public string DocumentKey { get; }
```

##### Property Value

The document key.

### ImageFrames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs/imageframes.md

#### ImagePreparingEventArgs.ImageFrames property

Gets the image frames.

```csharp
public ImageFrame[] ImageFrames { get; }
```

##### Property Value

The image frames.

### ImageIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs/imageindex.md

#### ImagePreparingEventArgs.ImageIndex property

Gets the ordinal number of the image in the document.

```csharp
public int ImageIndex { get; }
```

##### Property Value

The ordinal number of the image in the document.

### ImageStream
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs/imagestream.md

#### ImagePreparingEventArgs.ImageStream property

Gets the image stream.

```csharp
public Stream ImageStream { get; }
```

##### Property Value

The image stream.

### InnerPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/imagepreparingeventargs/innerpath.md

#### ImagePreparingEventArgs.InnerPath property

Gets the inner path of a nested document.

```csharp
public string[] InnerPath { get; }
```

##### Property Value

The inner path of a nested document.

### IndexErrorEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/indexerroreventargs.md

#### IndexErrorEventArgs class

Represents arguments for the event of index error occurred.

```csharp
public class IndexErrorEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| IsCritical { get; } | Gets a flag indicating that the error occurred is critical and the index should be restarted. |
| Message { get; } | Gets the error message. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |

### IsCritical
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/indexerroreventargs/iscritical.md

#### IndexErrorEventArgs.IsCritical property

Gets a flag indicating that the error occurred is critical and the index should be restarted.

```csharp
public bool IsCritical { get; }
```

##### Property Value

The flag indicating that the error occurred is critical and the index should be restarted.

### Message
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/indexerroreventargs/message.md

#### IndexErrorEventArgs.Message property

Gets the error message.

```csharp
public string Message { get; }
```

##### Property Value

The error message.

### OperationFinishedEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationfinishedeventargs.md

#### OperationFinishedEventArgs class

Represents arguments for the event of the indexing operation is finished.

```csharp
public class OperationFinishedEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| Message { get; } | Gets the message. |
| OperationType { get; } | Gets the operation type. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |

### Message
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationfinishedeventargs/message.md

#### OperationFinishedEventArgs.Message property

Gets the message.

```csharp
public string Message { get; }
```

##### Property Value

The message.

### OperationType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationfinishedeventargs/operationtype.md

#### OperationFinishedEventArgs.OperationType property

Gets the operation type.

```csharp
public OperationType OperationType { get; }
```

##### Property Value

The operation type.

### OperationProgressEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs.md

#### OperationProgressEventArgs class

Represents the arguments for the progress change event of the indexing operation.

```csharp
public class OperationProgressEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| LastDocumentKey { get; } | Gets the key of the last processed document. |
| LastDocumentPath { get; } | Gets the path of the last processed document. |
| LastDocumentStatus { get; } | Gets the status of the last processed document. |
| ProcessedDocuments { get; } | Gets the number of successfully processed documents. |
| ProgressPercentage { get; } | Gets the percentage of the progress. |
| SkippedDocuments { get; } | Gets the number of skipped documents. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |
| TotalDocuments { get; } | Gets the total number of documents for processing. |

### LastDocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/lastdocumentkey.md

#### OperationProgressEventArgs.LastDocumentKey property

Gets the key of the last processed document.

```csharp
public string LastDocumentKey { get; }
```

##### Property Value

The last processed document key.

### LastDocumentPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/lastdocumentpath.md

#### OperationProgressEventArgs.LastDocumentPath property

Gets the path of the last processed document.

```csharp
public string LastDocumentPath { get; }
```

##### Property Value

The last processed document path.

### LastDocumentStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/lastdocumentstatus.md

#### OperationProgressEventArgs.LastDocumentStatus property

Gets the status of the last processed document.

```csharp
public DocumentStatus LastDocumentStatus { get; }
```

##### Property Value

The last processed document status.

### ProcessedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/processeddocuments.md

#### OperationProgressEventArgs.ProcessedDocuments property

Gets the number of successfully processed documents.

```csharp
public int ProcessedDocuments { get; }
```

##### Property Value

The number of successfully processed documents.

### ProgressPercentage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/progresspercentage.md

#### OperationProgressEventArgs.ProgressPercentage property

Gets the percentage of the progress.

```csharp
public double ProgressPercentage { get; }
```

##### Property Value

The percentage of the progress.

### SkippedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/skippeddocuments.md

#### OperationProgressEventArgs.SkippedDocuments property

Gets the number of skipped documents.

```csharp
public int SkippedDocuments { get; }
```

##### Property Value

The number of skipped documents.

### TotalDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationprogresseventargs/totaldocuments.md

#### OperationProgressEventArgs.TotalDocuments property

Gets the total number of documents for processing.

```csharp
public int TotalDocuments { get; }
```

##### Property Value

The total number of documents for processing.

### OperationType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/operationtype.md

#### OperationType enumeration

Represents an index operation type.

```csharp
public enum OperationType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Indexing | `0` | Adding documents to an index. |
| Updating | `1` | Updating documents in an index. |
| Merging | `2` | Merging indexes. |
| Optimizing | `3` | Optimizing an index. |
| Deleting | `4` | Deleting paths from an index. |

### OptimizationProgressEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/optimizationprogresseventargs.md

#### OptimizationProgressEventArgs class

Represents the arguments for the progress change event of the optimization operation.

```csharp
public class OptimizationProgressEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| ProcessedSegments { get; } | Gets the number of processed segments. |
| ProgressPercentage { get; } | Gets the percentage of the progress. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |
| TotalSegments { get; } | Gets the total number of segments for processing. |

### ProcessedSegments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/optimizationprogresseventargs/processedsegments.md

#### OptimizationProgressEventArgs.ProcessedSegments property

Gets the number of processed segments.

```csharp
public int ProcessedSegments { get; }
```

##### Property Value

The number of processed segments.

### ProgressPercentage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/optimizationprogresseventargs/progresspercentage.md

#### OptimizationProgressEventArgs.ProgressPercentage property

Gets the percentage of the progress.

```csharp
public double ProgressPercentage { get; }
```

##### Property Value

The percentage of the progress.

### TotalSegments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/optimizationprogresseventargs/totalsegments.md

#### OptimizationProgressEventArgs.TotalSegments property

Gets the total number of segments for processing.

```csharp
public int TotalSegments { get; }
```

##### Property Value

The total number of segments for processing.

### PasswordRequiredEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/passwordrequiredeventargs.md

#### PasswordRequiredEventArgs class

Represents arguments for the event that occurs when document protected by a password is indexing.

```csharp
public class PasswordRequiredEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentFullPath { get; } | Gets the document full path. |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| Password { get; set; } | Gets or sets the password for opening the document. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |

### DocumentFullPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/passwordrequiredeventargs/documentfullpath.md

#### PasswordRequiredEventArgs.DocumentFullPath property

Gets the document full path.

```csharp
public string DocumentFullPath { get; }
```

##### Property Value

The document full path.

### Password
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/passwordrequiredeventargs/password.md

#### PasswordRequiredEventArgs.Password property

Gets or sets the password for opening the document.

```csharp
public string Password { get; set; }
```

##### Property Value

The password for opening the document.

### SearchPhase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/searchphase.md

#### SearchPhase enumeration

Represents the search phases.

```csharp
public enum SearchPhase
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AliasSubstitution | `0` | The alias substitution. |
| KeyboardLayoutCorrection | `1` | The keyboard layout correction. |
| SpellingCorrection | `2` | The spelling correction. |
| HomophoneSearch | `3` | The homophone search. |
| SynonymSearch | `4` | The synonym search. |
| WordFormsSearch | `5` | The word forms search. |
| FuzzySearch | `6` | The fuzzy search. |
| WildcardMatching | `7` | The wildcard matching. |
| RegexMatching | `8` | The regex matching. |

### SearchPhaseEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/searchphaseeventargs.md

#### SearchPhaseEventArgs class

Represents arguments for the search phase changing events.

```csharp
public class SearchPhaseEventArgs : BaseIndexEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| IndexFolder { get; } | Gets the index folder. |
| IndexId { get; } | Gets the index ID. |
| Query { get; } | Gets the initial query of the current search. |
| SearchPhase { get; } | Gets the search phase. |
| Status { get; } | Gets the index status. |
| Time { get; } | Gets the time of an event. |
| Words { get; } | Gets the words obtained in the current phase. |

### Query
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/searchphaseeventargs/query.md

#### SearchPhaseEventArgs.Query property

Gets the initial query of the current search.

```csharp
public string Query { get; }
```

##### Property Value

The initial query of the current search.

### SearchPhase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/searchphaseeventargs/searchphase.md

#### SearchPhaseEventArgs.SearchPhase property

Gets the search phase.

```csharp
public SearchPhase SearchPhase { get; }
```

##### Property Value

The search phase.

### Words
Path: https://reference.groupdocs.com/search/net/groupdocs.search.events/searchphaseeventargs/words.md

#### SearchPhaseEventArgs.Words property

Gets the words obtained in the current phase.

```csharp
public string[] Words { get; }
```

##### Property Value

The words obtained in the current phase.

### GroupDocs.Search.Exceptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.exceptions.md

The namespace provides exception classes.

#### Classes

| Class | Description |
| --- | --- |
| LicenseRestrictionException | The exception that is thrown when a license restriction is triggered. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### LicenseRestrictionException
Path: https://reference.groupdocs.com/search/net/groupdocs.search.exceptions/licenserestrictionexception.md

#### LicenseRestrictionException class

The exception that is thrown when a license restriction is triggered.

```csharp
public class LicenseRestrictionException : ApplicationException
```

### GroupDocs.Search.Highlighters
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters.md

The namespace provides highlighters for highlighting search results in text.

#### Classes

| Class | Description |
| --- | --- |
| DocumentHighlighter | Represents a search result highlighter that highlights search results in an entire document text. |
| FragmentHighlighter | Represents a search result highlighter that highlights search results in text fragments. |
| Highlighter | Represents the base class of a search result highlighter. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### DocumentHighlighter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/documenthighlighter.md

#### DocumentHighlighter class

Represents a search result highlighter that highlights search results in an entire document text.

```csharp
public class DocumentHighlighter : Highlighter
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentHighlighter(OutputAdapter) | Initializes a new instance of the `DocumentHighlighter` class. |

#### Properties

| Name | Description |
| --- | --- |
| OutputAdapter { get; } | Gets the output adapter passed in the constructor. |
| OutputFormat { get; } | Gets the output format. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Search for the phase 'Theory of Relativity'
SearchResult result = index.Search("\"Theory of Relativity\"");

// Highlighting found words in the text of a document
FoundDocument document = result.GetFoundDocument(0);
OutputAdapter outputAdapter = new FileOutputAdapter(OutputFormat.Html, "Highlighted.html");
Highlighter highlighter = new DocumentHighlighter(outputAdapter);
index.Highlight(document, highlighter);
```

### DocumentHighlighter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/documenthighlighter/documenthighlighter.md

#### DocumentHighlighter constructor

Initializes a new instance of the `DocumentHighlighter` class.

```csharp
public DocumentHighlighter(OutputAdapter outputAdapter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputAdapter | OutputAdapter | The output adapter transferring a result of the highlighting. |

### OutputAdapter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/documenthighlighter/outputadapter.md

#### DocumentHighlighter.OutputAdapter property

Gets the output adapter passed in the constructor.

```csharp
public OutputAdapter OutputAdapter { get; }
```

##### Return Value

The output adapter passed in the constructor.

### FragmentHighlighter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/fragmenthighlighter.md

#### FragmentHighlighter class

Represents a search result highlighter that highlights search results in text fragments.

```csharp
public class FragmentHighlighter : Highlighter
```

#### Constructors

| Name | Description |
| --- | --- |
| FragmentHighlighter(OutputFormat) | Initializes a new instance of the `FragmentHighlighter` class. |

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

#### Methods

| Name | Description |
| --- | --- |
| GetResult() | Gets an array of resulting fragment containers. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Search for the word 'Einstein'
SearchResult result = index.Search("Einstein");

// Assigning highlight options
HighlightOptions options = new HighlightOptions();
options.TermsBefore = 5;
options.TermsAfter = 5;
options.TermsTotal = 15;

// Highlighting found words in the text of a document
FoundDocument document = result.GetFoundDocument(0);
FragmentHighlighter highlighter = new FragmentHighlighter(OutputFormat.Html);
index.Highlight(document, highlighter, options);

// Getting the result
FragmentContainer[] fragmentContainers = highlighter.GetResult();
for (int i = 0; i < fragmentContainers.Length; i++)
{
    FragmentContainer container = fragmentContainers[i];
    string[] fragments = container.GetFragments();
    if (fragments.Length > 0)
    {
        Console.WriteLine(container.FieldName);
        Console.WriteLine();
        for (int j = 0; j < fragments.Length; j++)
        {
            // Printing HTML markup to console
            Console.WriteLine(fragments[j]);
            Console.WriteLine();
        }
    }
}
```

### FragmentHighlighter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/fragmenthighlighter/fragmenthighlighter.md

#### FragmentHighlighter constructor

Initializes a new instance of the `FragmentHighlighter` class.

```csharp
public FragmentHighlighter(OutputFormat outputFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFormat | OutputFormat | The output format. |

### GetResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/fragmenthighlighter/getresult.md

#### FragmentHighlighter.GetResult method

Gets an array of resulting fragment containers.

```csharp
public FragmentContainer[] GetResult()
```

##### Return Value

An array of resulting fragment containers.

### Highlighter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.highlighters/highlighter.md

#### Highlighter class

Represents the base class of a search result highlighter.

```csharp
public abstract class Highlighter : ResultBuilderFactory
```

#### Properties

| Name | Description |
| --- | --- |
| OutputFormat { get; } | Gets the output format. |

### GroupDocs.Search.Options
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options.md

The namespace provides classes to specify additional options of various operations.

#### Classes

| Class | Description |
| --- | --- |
| BaseOptions | Provides base options for index operations. |
| ChangeAttributesOptions | Provides options for the change attributes operation. |
| Color | Represents an ARGB (alpha, red, green, blue) color. |
| CommonFieldNames | Represents a list of field names for the faceted search. |
| DateFormat | Represents a date format. |
| DateFormatCollection | Represents a collection of `DateFormat` objects. |
| DateFormatElement | Represents a date format element. |
| DeleteOptions | Provides options for the delete operation. |
| DocumentFilter | Represents the base class for document filters. Contains methods for creation document filter instances. |
| EpubFieldNames | Represents a list of field names for the faceted search. |
| ExtractionOptions | Provides options for extracting data from documents. |
| FictionBookFieldNames | Represents a list of field names for the faceted search. |
| FuzzyAlgorithm | Represents the base class for fuzzy search algorithms. |
| FuzzySearchOptions | Provides options of the fuzzy search. |
| HighlightOptions | Provides options for highlighting found terms. |
| ImageIndexingOptions | Provides image indexing options for reverse image search. |
| ImageSearchOptions | Provides options for reverse image search operation. |
| IndexingOptions | Provides options for the indexing operation. |
| KeyboardLayoutCorrectorOptions | Provides options for the keyboard layout corrector. |
| MailFieldNames | Represents a list of field names for the faceted search. |
| MergeOptions | Provides options for merge operation. |
| MetadataIndexingOptions | Provides options for indexing metadata fields. |
| OcrContext | Represents the OCR processing context. |
| OcrIndexingOptions | Provides options for OCR processing and indexing recognized text. |
| OptimizeOptions | Provides options for the optimize operation. |
| PresentationFieldNames | Represents a list of field names for the faceted search. |
| SearchDocumentFilter | Contains methods for creating search document filters. |
| SearchOptions | Provides options for search operation. |
| SeparateProcessOptions | Provides options for extracting data from documents in a separate process. |
| SimilarityLevel | Represents an algorithm of the fuzzy search that specifies the similarity level. The similarity level algorithm calculates the maximum number of mistakes for a word as inversely proportional to the word length. |
| SpellingCorrectorOptions | Provides options for the spelling corrector. |
| SpreadsheetFieldNames | Represents a list of field names for the faceted search. |
| Step | Represents a step of a step function. |
| SynchronizeOptions | Provides options for the synchronize operation. |
| TableDiscreteFunction | Represents the fuzzy search algorithm that contains correspondences between word lengths and the number of allowed mistakes. This algorithm can be specified by a table of output values or by a step function. |
| TextOptions | Provides options for retrieving document text from an index. |
| TextStorageSettings | Represents the text storage settings. |
| UpdateOptions | Provides options for update operation. |
| WordsFieldNames | Represents a list of field names for the faceted search. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IOcrConnector | Defines methods that are required to recognize text on image documents and embedded images. |
| ISearchDocumentFilter | Represents search document filter. Use `SearchDocumentFilter` class for creation of a filter instances. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| Compression | Specifies a compression level. |
| ImageLocation | Specifies an image location. |
| IndexType | Specifies an index type. |
| NumberOfThreads | Specifies the number of threads. |
| OutputFormat | The output format of a data. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### BaseOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions.md

#### BaseOptions class

Provides base options for index operations.

```csharp
public abstract class BaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BaseOptions() | Initializes a new instance of the `BaseOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### AutoDetectEncoding
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/autodetectencoding.md

#### BaseOptions.AutoDetectEncoding property

Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`.

```csharp
public bool AutoDetectEncoding { get; set; }
```

##### Property Value

A value indicating whether to detect encoding automatically or not.

### BaseOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/baseoptions.md

#### BaseOptions constructor

Initializes a new instance of the `BaseOptions` class.

```csharp
public BaseOptions()
```

### Encoding
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/encoding.md

#### BaseOptions.Encoding property

Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding.

```csharp
public string Encoding { get; set; }
```

##### Property Value

The encoding used to extract text from text documents.

### ImageIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/imageindexingoptions.md

#### BaseOptions.ImageIndexingOptions property

Gets the image indexing options for reverse image search.

```csharp
public ImageIndexingOptions ImageIndexingOptions { get; }
```

##### Property Value

The image indexing options for reverse image search.

### MetadataIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/metadataindexingoptions.md

#### BaseOptions.MetadataIndexingOptions property

Gets the options for indexing metadata fields.

```csharp
public MetadataIndexingOptions MetadataIndexingOptions { get; }
```

##### Property Value

The options for indexing metadata fields.

### OcrIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/ocrindexingoptions.md

#### BaseOptions.OcrIndexingOptions property

Gets the options for OCR processing and indexing recognized text.

```csharp
public OcrIndexingOptions OcrIndexingOptions { get; }
```

##### Property Value

The options for OCR processing and indexing recognized text.

### UseBackupPrivilege
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/usebackupprivilege.md

#### BaseOptions.UseBackupPrivilege property

Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`.

```csharp
public bool UseBackupPrivilege { get; set; }
```

##### Property Value

`true` to enable privileged access using SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS; otherwise, `false`.

##### Remarks

When enabled, this allows the process to bypass file and directory security checks, permitting access to protected resources typically restricted by ACLs — as long as the process has the proper privileges. This feature is only supported on Windows operating systems. On non-Windows platforms, enabling this property has no effect. Note that this requires the process to be running with administrative rights. Use with caution, as it may allow access to sensitive system files and user data.

### UseRawTextExtraction
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/baseoptions/userawtextextraction.md

#### BaseOptions.UseRawTextExtraction property

Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

```csharp
public bool UseRawTextExtraction { get; set; }
```

##### Property Value

A value indicating whether the raw mode is used for text extraction if possible.

### ChangeAttributesOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/changeattributesoptions.md

#### ChangeAttributesOptions class

Provides options for the change attributes operation.

```csharp
public class ChangeAttributesOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ChangeAttributesOptions() | Initializes a new instance of the `ChangeAttributesOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |

### ChangeAttributesOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/changeattributesoptions/changeattributesoptions.md

#### ChangeAttributesOptions constructor

Initializes a new instance of the `ChangeAttributesOptions` class.

```csharp
public ChangeAttributesOptions()
```

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/changeattributesoptions/isasync.md

#### ChangeAttributesOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### Color
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color.md

#### Color class

Represents an ARGB (alpha, red, green, blue) color.

```csharp
public class Color
```

#### Constructors

| Name | Description |
| --- | --- |
| Color(int, int, int) | Initializes a new instance of the `Color` class. |
| Color(int, int, int, int) | Initializes a new instance of the `Color` class. |

#### Properties

| Name | Description |
| --- | --- |
| Alpha { get; } | Gets the alpha component value of this instance. |
| Blue { get; } | Gets the blue component value of this instance. |
| Green { get; } | Gets the green component value of this instance. |
| Red { get; } | Gets the red component value of this instance. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `Color`. |

### Alpha
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/alpha.md

#### Color.Alpha property

Gets the alpha component value of this instance.

```csharp
public int Alpha { get; }
```

##### Property Value

The alpha component value of this instance.

### Blue
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/blue.md

#### Color.Blue property

Gets the blue component value of this instance.

```csharp
public int Blue { get; }
```

##### Property Value

The blue component value of this instance.

### Color
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/color.md

#### Color(int, int, int, int)

Initializes a new instance of the `Color` class.

```csharp
public Color(int alpha, int red, int green, int blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alpha | Int32 | The alpha component from 0 to 255. |
| red | Int32 | The red component from 0 to 255. |
| green | Int32 | The green component from 0 to 255. |
| blue | Int32 | The blue component from 0 to 255. |

#### Color(int, int, int)

Initializes a new instance of the `Color` class.

```csharp
public Color(int red, int green, int blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Int32 | The red component from 0 to 255. |
| green | Int32 | The green component from 0 to 255. |
| blue | Int32 | The blue component from 0 to 255. |

### Green
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/green.md

#### Color.Green property

Gets the green component value of this instance.

```csharp
public int Green { get; }
```

##### Property Value

The green component value of this instance.

### Red
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/red.md

#### Color.Red property

Gets the red component value of this instance.

```csharp
public int Red { get; }
```

##### Property Value

The red component value of this instance.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/color/tostring.md

#### Color.ToString method

Returns a String that represents the current `Color`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `Color`.

### CommonFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames.md

#### CommonFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class CommonFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Content | The content field name. |
| const CreationDate | The creation date field name. |
| const EmbeddedImageOcr | The embedded image OCR field name. |
| const FileName | The file name field name. |
| const FormatFamily | The format family field name. |
| const ModificationDate | The modification date field name. |

### Content
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/content.md

#### CommonFieldNames.Content field

The content field name.

```csharp
public const string Content;
```

### CreationDate
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/creationdate.md

#### CommonFieldNames.CreationDate field

The creation date field name.

```csharp
public const string CreationDate;
```

### EmbeddedImageOcr
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/embeddedimageocr.md

#### CommonFieldNames.EmbeddedImageOcr field

The embedded image OCR field name.

```csharp
public const string EmbeddedImageOcr;
```

### FileName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/filename.md

#### CommonFieldNames.FileName field

The file name field name.

```csharp
public const string FileName;
```

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/formatfamily.md

#### CommonFieldNames.FormatFamily field

The format family field name.

```csharp
public const string FormatFamily;
```

### ModificationDate
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/commonfieldnames/modificationdate.md

#### CommonFieldNames.ModificationDate field

The modification date field name.

```csharp
public const string ModificationDate;
```

### Compression
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/compression.md

#### Compression enumeration

Specifies a compression level.

```csharp
public enum Compression
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Compression is disabled. |
| Normal | `1` | Normal compression level. |
| High | `2` | High compression level. |

### DateFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformat.md

#### DateFormat class

Represents a date format.

```csharp
public class DateFormat
```

#### Constructors

| Name | Description |
| --- | --- |
| DateFormat(DateFormatElement[], string) | Initializes a new instance of the `DateFormat` class. |
| DateFormat(string, DateFormatElement[]) | Initializes a new instance of the `DateFormat` class. |

#### Properties

| Name | Description |
| --- | --- |
| DateSeparator { get; } | Gets the date separator. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `DateFormat`. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "daterange(2017-01-01 ~~ 2019-12-31)";

Index index = new Index(indexFolder); // Creating an index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.DateFormats.Clear(); // Removing default date formats
DateFormatElement[] elements = new DateFormatElement[]
{
    DateFormatElement.MonthTwoDigits,
    DateFormatElement.DateSeparator,
    DateFormatElement.DayOfMonthTwoDigits,
    DateFormatElement.DateSeparator,
    DateFormatElement.YearFourDigits,
};
// Creating a date format pattern 'MM/dd/yyyy'
DateFormat dateFormat = new DateFormat(elements, "/");
options.DateFormats.Add(dateFormat);

SearchResult result = index.Search(query, options); // Search in index
```

### DateFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformat/dateformat.md

#### DateFormat(string, DateFormatElement[])

Initializes a new instance of the `DateFormat` class.

```csharp
public DateFormat(string cultureName, DateFormatElement[] formatElements)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cultureName | String | The culture name. |
| formatElements | DateFormatElement[] | The format elements. |

#### DateFormat(DateFormatElement[], string)

Initializes a new instance of the `DateFormat` class.

```csharp
public DateFormat(DateFormatElement[] formatElements, string dateSeparator)
```

| Parameter | Type | Description |
| --- | --- | --- |
| formatElements | DateFormatElement[] | The format elements. |
| dateSeparator | String | The date separator. |

### DateSeparator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformat/dateseparator.md

#### DateFormat.DateSeparator property

Gets the date separator.

```csharp
public string DateSeparator { get; }
```

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformat/tostring.md

#### DateFormat.ToString method

Returns a String that represents the current `DateFormat`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `DateFormat`.

### DateFormatCollection
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection.md

#### DateFormatCollection class

Represents a collection of `DateFormat` objects.

```csharp
public class DateFormatCollection : ICollection<DateFormat>
```

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets the number of elements contained in the collection. |
| IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |

#### Methods

| Name | Description |
| --- | --- |
| Add(DateFormat) | Adds an date format object to the collection. |
| Clear() | Removes all elements from the collection. |
| Contains(DateFormat) | Determines whether the collection contains a specific item. |
| CopyTo(DateFormat[], int) | Copies the elements of the collection to an Array, starting at a particular Array index. |
| GetEnumerator() | Returns an enumerator that iterates through the collection. |
| Remove(DateFormat) | Removes the first occurrence of a specific element from the collection. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/add.md

#### DateFormatCollection.Add method

Adds an date format object to the collection.

```csharp
public void Add(DateFormat item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The date format object to add to the collection. |

### Clear
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/clear.md

#### DateFormatCollection.Clear method

Removes all elements from the collection.

```csharp
public void Clear()
```

### Contains
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/contains.md

#### DateFormatCollection.Contains method

Determines whether the collection contains a specific item.

```csharp
public bool Contains(DateFormat item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The item to locate in the collection. |

##### Return Value

`true` if item is found in the collection; otherwise, `false`.

### CopyTo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/copyto.md

#### DateFormatCollection.CopyTo method

Copies the elements of the collection to an Array, starting at a particular Array index.

```csharp
public void CopyTo(DateFormat[] array, int arrayIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | DateFormat[] | The one-dimensional Array that is the destination of the elements copied from the collection. |
| arrayIndex | Int32 | The zero-based index in array at which copying begins. |

### Count
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/count.md

#### DateFormatCollection.Count property

Gets the number of elements contained in the collection.

```csharp
public int Count { get; }
```

##### Property Value

The number of elements contained in the collection.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/getenumerator.md

#### DateFormatCollection.GetEnumerator method

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<DateFormat> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection.

### IsReadOnly
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/isreadonly.md

#### DateFormatCollection.IsReadOnly property

Gets a value indicating whether the collection is read-only.

```csharp
public bool IsReadOnly { get; }
```

##### Property Value

`true` if the collection is read-only; otherwise, `false`.

### Remove
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatcollection/remove.md

#### DateFormatCollection.Remove method

Removes the first occurrence of a specific element from the collection.

```csharp
public bool Remove(DateFormat item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | DateFormat | The item to remove from the collection. |

##### Return Value

`true` if item was successfully removed from the collection; otherwise, `false`. This method also returns `false` if item is not found in the collection.

### DateFormatElement
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement.md

#### DateFormatElement class

Represents a date format element.

```csharp
public class DateFormatElement
```

#### Properties

| Name | Description |
| --- | --- |
| static DateSeparator { get; } | Gets the date separator element. |
| static DayOfMonth { get; } | Gets the day of month element, represented by one or two digits. |
| static DayOfMonthTwoDigits { get; } | Gets the day of month element, represented by two digits. |
| static Month { get; } | Gets the month element, represented by one or two digits. |
| static MonthAbbreviatedName { get; } | Gets the month element, represented by abbreviated name. |
| static MonthFullName { get; } | Gets the month element, represented by full name. |
| static MonthTwoDigits { get; } | Gets the month element, represented by two digits. |
| static Year { get; } | Gets the year element, represented by one, two, three, or four digits. |
| static YearFourDigits { get; } | Gets the year element, represented by four digits. |
| static YearTwoDigits { get; } | Gets the year element, represented by two digits. |
| Format { get; } | Gets the format string. |
| SingleFormat { get; } | Gets the single format string. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `DateFormatElement`. |

### DateSeparator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/dateseparator.md

#### DateFormatElement.DateSeparator property

Gets the date separator element.

```csharp
public static DateFormatElement DateSeparator { get; }
```

### DayOfMonth
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/dayofmonth.md

#### DateFormatElement.DayOfMonth property

Gets the day of month element, represented by one or two digits.

```csharp
public static DateFormatElement DayOfMonth { get; }
```

### DayOfMonthTwoDigits
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/dayofmonthtwodigits.md

#### DateFormatElement.DayOfMonthTwoDigits property

Gets the day of month element, represented by two digits.

```csharp
public static DateFormatElement DayOfMonthTwoDigits { get; }
```

### Format
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/format.md

#### DateFormatElement.Format property

Gets the format string.

```csharp
public string Format { get; }
```

### Month
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/month.md

#### DateFormatElement.Month property

Gets the month element, represented by one or two digits.

```csharp
public static DateFormatElement Month { get; }
```

### MonthAbbreviatedName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/monthabbreviatedname.md

#### DateFormatElement.MonthAbbreviatedName property

Gets the month element, represented by abbreviated name.

```csharp
public static DateFormatElement MonthAbbreviatedName { get; }
```

### MonthFullName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/monthfullname.md

#### DateFormatElement.MonthFullName property

Gets the month element, represented by full name.

```csharp
public static DateFormatElement MonthFullName { get; }
```

### MonthTwoDigits
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/monthtwodigits.md

#### DateFormatElement.MonthTwoDigits property

Gets the month element, represented by two digits.

```csharp
public static DateFormatElement MonthTwoDigits { get; }
```

### SingleFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/singleformat.md

#### DateFormatElement.SingleFormat property

Gets the single format string.

```csharp
public string SingleFormat { get; }
```

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/tostring.md

#### DateFormatElement.ToString method

Returns a String that represents the current `DateFormatElement`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `DateFormatElement`.

### Year
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/year.md

#### DateFormatElement.Year property

Gets the year element, represented by one, two, three, or four digits.

```csharp
public static DateFormatElement Year { get; }
```

### YearFourDigits
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/yearfourdigits.md

#### DateFormatElement.YearFourDigits property

Gets the year element, represented by four digits.

```csharp
public static DateFormatElement YearFourDigits { get; }
```

### YearTwoDigits
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/dateformatelement/yeartwodigits.md

#### DateFormatElement.YearTwoDigits property

Gets the year element, represented by two digits.

```csharp
public static DateFormatElement YearTwoDigits { get; }
```

### DeleteOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/deleteoptions.md

#### DeleteOptions class

Provides options for the delete operation.

```csharp
public class DeleteOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DeleteOptions() | Initializes a new instance of the `DeleteOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |

### DeleteOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/deleteoptions/deleteoptions.md

#### DeleteOptions constructor

Initializes a new instance of the `DeleteOptions` class.

```csharp
public DeleteOptions()
```

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/deleteoptions/isasync.md

#### DeleteOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### DocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter.md

#### DocumentFilter class

Represents the base class for document filters. Contains methods for creation document filter instances.

```csharp
public abstract class DocumentFilter
```

#### Methods

| Name | Description |
| --- | --- |
| static CreateAnd(params DocumentFilter[]) | Creates a logical conjunction of the specified filters. |
| static CreateCreationTimeLowerBound(DateTime) | Creates a filter for skipping documents with creation date earlier than the lower bound. |
| static CreateCreationTimeRange(DateTime, DateTime) | Creates a filter for skipping documents with creation date out of the specified range. |
| static CreateCreationTimeUpperBound(DateTime) | Creates a filter for skipping documents with creation date later than the upper bound. |
| static CreateFileExtension(params string[]) | Creates a filter for skipping documents that do not have allowable extension. |
| static CreateFileLengthLowerBound(long) | Creates a filter for skipping documents with the length less than the lower bound. |
| static CreateFileLengthRange(long, long) | Creates a filter for skipping documents out of the specified document length range. |
| static CreateFileLengthUpperBound(long) | Creates a filter for skipping documents with the length greater than the upper bound. |
| static CreateFilePathRegularExpression(string) | Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document. |
| static CreateFilePathRegularExpression(string, RegexOptions) | Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document. |
| static CreateModificationTimeLowerBound(DateTime) | Creates a filter for skipping documents with modification date earlier than the lower bound. |
| static CreateModificationTimeRange(DateTime, DateTime) | Creates a filter for skipping documents with modification date out of the specified range. |
| static CreateModificationTimeUpperBound(DateTime) | Creates a filter for skipping documents with modification date later than the upper bound. |
| static CreateNot(DocumentFilter) | Creates a filter that has inverse logic in relation to the specified inner filter. |
| static CreateOr(params DocumentFilter[]) | Creates a logical disjunction of the specified filters. |
| abstract ToString() | Returns string representation of a document filter. |

### CreateAnd
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createand.md

#### DocumentFilter.CreateAnd method

Creates a logical conjunction of the specified filters.

```csharp
public static DocumentFilter CreateAnd(params DocumentFilter[] filters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filters | DocumentFilter[] | The document filters. |

##### Return Value

A document filter that represents result of conjunction of the specified filters.

### CreateCreationTimeLowerBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createcreationtimelowerbound.md

#### DocumentFilter.CreateCreationTimeLowerBound method

Creates a filter for skipping documents with creation date earlier than the lower bound.

```csharp
public static DocumentFilter CreateCreationTimeLowerBound(DateTime lowerBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | DateTime | The lower bound of the document creation time. |

##### Return Value

A document filter by document creation time.

### CreateCreationTimeRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createcreationtimerange.md

#### DocumentFilter.CreateCreationTimeRange method

Creates a filter for skipping documents with creation date out of the specified range.

```csharp
public static DocumentFilter CreateCreationTimeRange(DateTime lowerBound, DateTime upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | DateTime | The lower bound of the document creation time. |
| upperBound | DateTime | The upper bound of the document creation time. |

##### Return Value

A document filter by document creation time.

### CreateCreationTimeUpperBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createcreationtimeupperbound.md

#### DocumentFilter.CreateCreationTimeUpperBound method

Creates a filter for skipping documents with creation date later than the upper bound.

```csharp
public static DocumentFilter CreateCreationTimeUpperBound(DateTime upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | DateTime | The upper bound of the document creation time. |

##### Return Value

A document filter by document creation time.

### CreateFileExtension
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createfileextension.md

#### DocumentFilter.CreateFileExtension method

Creates a filter for skipping documents that do not have allowable extension.

```csharp
public static DocumentFilter CreateFileExtension(params string[] extensions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extensions | String[] | The list of allowable extensions. |

##### Return Value

A document filter by document extension.

### CreateFileLengthLowerBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createfilelengthlowerbound.md

#### DocumentFilter.CreateFileLengthLowerBound method

Creates a filter for skipping documents with the length less than the lower bound.

```csharp
public static DocumentFilter CreateFileLengthLowerBound(long lowerBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | Int64 | The lower bound of the document length. |

##### Return Value

A document filter by document length.

### CreateFileLengthRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createfilelengthrange.md

#### DocumentFilter.CreateFileLengthRange method

Creates a filter for skipping documents out of the specified document length range.

```csharp
public static DocumentFilter CreateFileLengthRange(long lowerBound, long upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | Int64 | The lower bound of the document length. |
| upperBound | Int64 | The upper bound of the document length. |

##### Return Value

A document filter by document length.

### CreateFileLengthUpperBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createfilelengthupperbound.md

#### DocumentFilter.CreateFileLengthUpperBound method

Creates a filter for skipping documents with the length greater than the upper bound.

```csharp
public static DocumentFilter CreateFileLengthUpperBound(long upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | Int64 | The upper bound of the document length. |

##### Return Value

A document filter by document length.

### CreateFilePathRegularExpression
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createfilepathregularexpression.md

#### CreateFilePathRegularExpression(string)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

```csharp
public static DocumentFilter CreateFilePathRegularExpression(string pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern. |

##### Return Value

A document filter by file name.

#### CreateFilePathRegularExpression(string, RegexOptions)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

```csharp
public static DocumentFilter CreateFilePathRegularExpression(string pattern, RegexOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern. |
| options | RegexOptions | The regular expression options. |

##### Return Value

A document filter by file name.

### CreateModificationTimeLowerBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createmodificationtimelowerbound.md

#### DocumentFilter.CreateModificationTimeLowerBound method

Creates a filter for skipping documents with modification date earlier than the lower bound.

```csharp
public static DocumentFilter CreateModificationTimeLowerBound(DateTime lowerBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | DateTime | The lower bound of the document modification time. |

##### Return Value

A document filter by document modification time.

### CreateModificationTimeRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createmodificationtimerange.md

#### DocumentFilter.CreateModificationTimeRange method

Creates a filter for skipping documents with modification date out of the specified range.

```csharp
public static DocumentFilter CreateModificationTimeRange(DateTime lowerBound, DateTime upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerBound | DateTime | The lower bound of the document modification time. |
| upperBound | DateTime | The upper bound of the document modification time. |

##### Return Value

A document filter by document modification time.

### CreateModificationTimeUpperBound
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createmodificationtimeupperbound.md

#### DocumentFilter.CreateModificationTimeUpperBound method

Creates a filter for skipping documents with modification date later than the upper bound.

```csharp
public static DocumentFilter CreateModificationTimeUpperBound(DateTime upperBound)
```

| Parameter | Type | Description |
| --- | --- | --- |
| upperBound | DateTime | The upper bound of the document modification time. |

##### Return Value

A document filter by document modification time.

### CreateNot
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createnot.md

#### DocumentFilter.CreateNot method

Creates a filter that has inverse logic in relation to the specified inner filter.

```csharp
public static DocumentFilter CreateNot(DocumentFilter innerFilter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| innerFilter | DocumentFilter | The inner document filter. |

##### Return Value

An inverted document filter.

### CreateOr
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/createor.md

#### DocumentFilter.CreateOr method

Creates a logical disjunction of the specified filters.

```csharp
public static DocumentFilter CreateOr(params DocumentFilter[] filters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filters | DocumentFilter[] | The document filters. |

##### Return Value

A document filter that represents result of disjunction of the specified filters.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/documentfilter/tostring.md

#### DocumentFilter.ToString method

Returns string representation of a document filter.

```csharp
public abstract string ToString()
```

##### Return Value

String representation of a document filter.

### EpubFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames.md

#### EpubFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class EpubFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Author | The author field name. |
| const Copyrights | The copyrights field name. |
| const Description | The description field name. |
| const Language | The language field name. |
| const PublishedDate | The published date field name. |
| const Publisher | The publisher field name. |
| const Subject | The subject field name. |
| const Title | The title field name. |

### Author
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/author.md

#### EpubFieldNames.Author field

The author field name.

```csharp
public const string Author;
```

### Copyrights
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/copyrights.md

#### EpubFieldNames.Copyrights field

The copyrights field name.

```csharp
public const string Copyrights;
```

### Description
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/description.md

#### EpubFieldNames.Description field

The description field name.

```csharp
public const string Description;
```

### Language
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/language.md

#### EpubFieldNames.Language field

The language field name.

```csharp
public const string Language;
```

### PublishedDate
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/publisheddate.md

#### EpubFieldNames.PublishedDate field

The published date field name.

```csharp
public const string PublishedDate;
```

### Publisher
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/publisher.md

#### EpubFieldNames.Publisher field

The publisher field name.

```csharp
public const string Publisher;
```

### Subject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/subject.md

#### EpubFieldNames.Subject field

The subject field name.

```csharp
public const string Subject;
```

### Title
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/epubfieldnames/title.md

#### EpubFieldNames.Title field

The title field name.

```csharp
public const string Title;
```

### ExtractionOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/extractionoptions.md

#### ExtractionOptions class

Provides options for extracting data from documents.

```csharp
public class ExtractionOptions : BaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExtractionOptions() | Initializes a new instance of the `ExtractionOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| CustomExtractor { get; set; } | Gets or sets the custom text extractor. The default value is `null`. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### CustomExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/extractionoptions/customextractor.md

#### ExtractionOptions.CustomExtractor property

Gets or sets the custom text extractor. The default value is `null`.

```csharp
public IFieldExtractor CustomExtractor { get; set; }
```

##### Property Value

The custom text extractor.

### ExtractionOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/extractionoptions/extractionoptions.md

#### ExtractionOptions constructor

Initializes a new instance of the `ExtractionOptions` class.

```csharp
public ExtractionOptions()
```

### FictionBookFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames.md

#### FictionBookFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class FictionBookFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Author | The author field name. |
| const Description | The description field name. |
| const Keywords | The keywords field name. |
| const Language | The language field name. |
| const PublishedDate | The published date field name. |
| const Publisher | The publisher field name. |
| const Subject | The subject field name. |
| const Title | The title field name. |

### Author
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/author.md

#### FictionBookFieldNames.Author field

The author field name.

```csharp
public const string Author;
```

### Description
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/description.md

#### FictionBookFieldNames.Description field

The description field name.

```csharp
public const string Description;
```

### Keywords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/keywords.md

#### FictionBookFieldNames.Keywords field

The keywords field name.

```csharp
public const string Keywords;
```

### Language
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/language.md

#### FictionBookFieldNames.Language field

The language field name.

```csharp
public const string Language;
```

### PublishedDate
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/publisheddate.md

#### FictionBookFieldNames.PublishedDate field

The published date field name.

```csharp
public const string PublishedDate;
```

### Publisher
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/publisher.md

#### FictionBookFieldNames.Publisher field

The publisher field name.

```csharp
public const string Publisher;
```

### Subject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/subject.md

#### FictionBookFieldNames.Subject field

The subject field name.

```csharp
public const string Subject;
```

### Title
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fictionbookfieldnames/title.md

#### FictionBookFieldNames.Title field

The title field name.

```csharp
public const string Title;
```

### FuzzyAlgorithm
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzyalgorithm.md

#### FuzzyAlgorithm class

Represents the base class for fuzzy search algorithms.

```csharp
public abstract class FuzzyAlgorithm
```

#### Methods

| Name | Description |
| --- | --- |
| abstract GetMaxMistakeCount(int) | Gets the maximum allowed number of mistakes for the specified term length. |
| abstract GetSimilarityLevel(int) | Gets the similarity level for the specified term length. |

### GetMaxMistakeCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzyalgorithm/getmaxmistakecount.md

#### FuzzyAlgorithm.GetMaxMistakeCount method

Gets the maximum allowed number of mistakes for the specified term length.

```csharp
public abstract int GetMaxMistakeCount(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

The maximum allowed number of mistakes.

### GetSimilarityLevel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzyalgorithm/getsimilaritylevel.md

#### FuzzyAlgorithm.GetSimilarityLevel method

Gets the similarity level for the specified term length.

```csharp
public abstract double GetSimilarityLevel(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

The similarity level.

### FuzzySearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions.md

#### FuzzySearchOptions class

Provides options of the fuzzy search.

```csharp
public class FuzzySearchOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ConsiderTranspositions { get; set; } | Gets or sets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake. The default value is `true`. |
| Enabled { get; set; } | Gets or sets a value indicating whether fuzzy search feature is enabled. The default value is `false`. |
| FuzzyAlgorithm { get; set; } | Gets or sets the fuzzy search algorithm. The currently available fuzzy search algorithms are `SimilarityLevel` and `TableDiscreteFunction`. The default value is an instance of `SimilarityLevel` with a similarity level value of `0.5`. |
| OnlyBestResults { get; set; } | Gets or sets a value indicating whether only the best results will be returned. The default value is `false`. |
| OnlyBestResultsRange { get; set; } | Gets or sets the maximum exceeding of the minimum number of mistakes that are found. The default value is `0`. |

### ConsiderTranspositions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions/considertranspositions.md

#### FuzzySearchOptions.ConsiderTranspositions property

Gets or sets a value indicating whether the fuzzy search algorithm must consider transposition of two adjacent characters as a single mistake. The default value is `true`.

```csharp
public bool ConsiderTranspositions { get; set; }
```

##### Property Value

`true` if the fuzzy search algorithm considers transpositions; otherwise `false`.

### Enabled
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions/enabled.md

#### FuzzySearchOptions.Enabled property

Gets or sets a value indicating whether fuzzy search feature is enabled. The default value is `false`.

```csharp
public bool Enabled { get; set; }
```

##### Property Value

A value indicating whether fuzzy search feature is enabled.

### FuzzyAlgorithm
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions/fuzzyalgorithm.md

#### FuzzySearchOptions.FuzzyAlgorithm property

Gets or sets the fuzzy search algorithm. The currently available fuzzy search algorithms are `SimilarityLevel` and `TableDiscreteFunction`. The default value is an instance of `SimilarityLevel` with a similarity level value of `0.5`.

```csharp
public FuzzyAlgorithm FuzzyAlgorithm { get; set; }
```

##### Property Value

The fuzzy search algorithm.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *value* is `null`. |

##### Examples

The example demonstrates how to set the fuzzy search algorithm.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating an index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.FuzzySearch.Enabled = true; // Enabling the fuzzy search
options.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1, new Step(5, 2), new Step(8, 3)); // Creating the fuzzy search algorithm
// This function specifies 1 as the maximum number of mistakes for words from 1 to 4 characters.
// It specifies 2 as the maximum number of mistakes for words from 5 to 7 characters.
// It specifies 3 as the maximum number of mistakes for words from 8 and more characters.

SearchResult result = index.Search(query, options); // Search in index
```

### OnlyBestResults
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions/onlybestresults.md

#### FuzzySearchOptions.OnlyBestResults property

Gets or sets a value indicating whether only the best results will be returned. The default value is `false`.

```csharp
public bool OnlyBestResults { get; set; }
```

##### Property Value

`true` if only the best results will be returned; otherwise `false`.

### OnlyBestResultsRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/fuzzysearchoptions/onlybestresultsrange.md

#### FuzzySearchOptions.OnlyBestResultsRange property

Gets or sets the maximum exceeding of the minimum number of mistakes that are found. The default value is `0`.

```csharp
public byte OnlyBestResultsRange { get; set; }
```

##### Property Value

The maximum exceeding of the minimum number of mistakes found.

### HighlightOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions.md

#### HighlightOptions class

Provides options for highlighting found terms.

```csharp
public class HighlightOptions : TextOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| HighlightOptions() | Initializes a new instance of the `HighlightOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AdditionalFields { get; set; } | Gets or sets the additional document fields that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index. |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| Cancellation { get; set; } | Gets or sets the cancellation object. The default value is `null`. |
| CustomExtractor { get; set; } | Gets or sets the custom text extractor that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| GenerateHead { get; set; } | Gets or sets a value indicating whether the Head tag is generated in the output HTML. The default value is `true`. |
| HighlightColor { get; set; } | Gets or sets a color that is used to highlight occurrences. The default value is #FFD800. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| TermHighlightEndTag { get; set; } | Gets of sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string. |
| TermHighlightStartTag { get; set; } | Gets of sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string. |
| TermsAfter { get; set; } | Gets or sets the maximum number of words in a text fragment after highlighted word. The value must be in the range from 0 to 10000. The default value is `7`. |
| TermsBefore { get; set; } | Gets or sets the maximum number of words in a text fragment before highlighted word. The value must be in the range from 0 to 10000. The default value is `7`. |
| TermsTotal { get; set; } | Gets or sets the maximum number of words in a text fragment. The value must be in the range from 0 to 10000. The default value is `21`. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseInlineStyles { get; set; } | Gets or sets a value indicating whether inline styles are used to highlight occurrences. The default value is `true`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### HighlightColor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/highlightcolor.md

#### HighlightOptions.HighlightColor property

Gets or sets a color that is used to highlight occurrences. The default value is #FFD800.

```csharp
public Color HighlightColor { get; set; }
```

##### Property Value

A color that is used to highlight occurrences.

### HighlightOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/highlightoptions.md

#### HighlightOptions constructor

Initializes a new instance of the `HighlightOptions` class.

```csharp
public HighlightOptions()
```

### TermHighlightEndTag
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/termhighlightendtag.md

#### HighlightOptions.TermHighlightEndTag property

Gets of sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

```csharp
public string TermHighlightEndTag { get; set; }
```

##### Property Value

The end tag of the highlighting of the found word.

### TermHighlightStartTag
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/termhighlightstarttag.md

#### HighlightOptions.TermHighlightStartTag property

Gets of sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

```csharp
public string TermHighlightStartTag { get; set; }
```

##### Property Value

The start tag of the highlighting of the found word.

### TermsAfter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/termsafter.md

#### HighlightOptions.TermsAfter property

Gets or sets the maximum number of words in a text fragment after highlighted word. The value must be in the range from 0 to 10000. The default value is `7`.

```csharp
public int TermsAfter { get; set; }
```

##### Property Value

The maximum number of words in a text fragment after highlighted word.

### TermsBefore
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/termsbefore.md

#### HighlightOptions.TermsBefore property

Gets or sets the maximum number of words in a text fragment before highlighted word. The value must be in the range from 0 to 10000. The default value is `7`.

```csharp
public int TermsBefore { get; set; }
```

##### Property Value

The maximum number of words in a text fragment before highlighted word.

### TermsTotal
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/termstotal.md

#### HighlightOptions.TermsTotal property

Gets or sets the maximum number of words in a text fragment. The value must be in the range from 0 to 10000. The default value is `21`.

```csharp
public int TermsTotal { get; set; }
```

##### Property Value

The maximum number of words in a text fragment.

### UseInlineStyles
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/highlightoptions/useinlinestyles.md

#### HighlightOptions.UseInlineStyles property

Gets or sets a value indicating whether inline styles are used to highlight occurrences. The default value is `true`.

```csharp
public bool UseInlineStyles { get; set; }
```

##### Property Value

A value indicating whether inline styles are used to highlight occurrences.

### ImageIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imageindexingoptions.md

#### ImageIndexingOptions class

Provides image indexing options for reverse image search.

```csharp
public class ImageIndexingOptions
```

#### Properties

| Name | Description |
| --- | --- |
| EnabledForContainerItemImages { get; set; } | Gets or sets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive). The default value is `false`. |
| EnabledForEmbeddedImages { get; set; } | Gets or sets a value indicating whether to index embedded images (for example, images in a DOCX document). The default value is `false`. |
| EnabledForSeparateImages { get; set; } | Gets or sets a value indicating whether to index separate image files. The default value is `false`. |

### EnabledForContainerItemImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imageindexingoptions/enabledforcontaineritemimages.md

#### ImageIndexingOptions.EnabledForContainerItemImages property

Gets or sets a value indicating whether to index images that are items in a container (for example, images in a ZIP archive). The default value is `false`.

```csharp
public bool EnabledForContainerItemImages { get; set; }
```

##### Property Value

A value indicating whether to index images that are items in a container.

### EnabledForEmbeddedImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imageindexingoptions/enabledforembeddedimages.md

#### ImageIndexingOptions.EnabledForEmbeddedImages property

Gets or sets a value indicating whether to index embedded images (for example, images in a DOCX document). The default value is `false`.

```csharp
public bool EnabledForEmbeddedImages { get; set; }
```

##### Property Value

A value indicating whether to index embedded images.

### EnabledForSeparateImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imageindexingoptions/enabledforseparateimages.md

#### ImageIndexingOptions.EnabledForSeparateImages property

Gets or sets a value indicating whether to index separate image files. The default value is `false`.

```csharp
public bool EnabledForSeparateImages { get; set; }
```

##### Property Value

A value indicating whether to index separate image files.

### ImageLocation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagelocation.md

#### ImageLocation enumeration

Specifies an image location.

```csharp
public enum ImageLocation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Separate | `0` | An image in separate file. |
| Embedded | `1` | An image embedded in another document. |
| ContainerItem | `2` | An image that is an element in a container file. |

### ImageSearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagesearchoptions.md

#### ImageSearchOptions class

Provides options for reverse image search operation.

```csharp
public class ImageSearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSearchOptions() | Initializes a new instance of the `ImageSearchOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| HashDifferences { get; set; } | Gets or sets the maximum number of mismatched bits in the image hash. The default value is `5`. |
| MaxResultCount { get; set; } | Gets or sets the maximum number of found images for an image reverse search request. The default value is `1000`. |
| SearchDocumentFilter { get; set; } | Gets or sets the search document filter. `SearchDocumentFilter` works on the inclusion logic. Use `SearchDocumentFilter` class for creation of a search document filter instances. The default value is `null`, which means that all found documents will be returned. |

### HashDifferences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagesearchoptions/hashdifferences.md

#### ImageSearchOptions.HashDifferences property

Gets or sets the maximum number of mismatched bits in the image hash. The default value is `5`.

```csharp
public int HashDifferences { get; set; }
```

##### Property Value

The maximum number of mismatched bits in the image hash.

### ImageSearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagesearchoptions/imagesearchoptions.md

#### ImageSearchOptions constructor

Initializes a new instance of the `ImageSearchOptions` class.

```csharp
public ImageSearchOptions()
```

### MaxResultCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagesearchoptions/maxresultcount.md

#### ImageSearchOptions.MaxResultCount property

Gets or sets the maximum number of found images for an image reverse search request. The default value is `1000`.

```csharp
public int MaxResultCount { get; set; }
```

##### Property Value

The maximum number of found images for an image reverse search request.

### SearchDocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/imagesearchoptions/searchdocumentfilter.md

#### ImageSearchOptions.SearchDocumentFilter property

Gets or sets the search document filter. `SearchDocumentFilter` works on the inclusion logic. Use `SearchDocumentFilter` class for creation of a search document filter instances. The default value is `null`, which means that all found documents will be returned.

```csharp
public ISearchDocumentFilter SearchDocumentFilter { get; set; }
```

##### Property Value

The search document filter.

### IndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions.md

#### IndexingOptions class

Provides options for the indexing operation.

```csharp
public class IndexingOptions : BaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| IndexingOptions() | Initializes a new instance of the `IndexingOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| Cancellation { get; set; } | Gets or sets the operation cancellation object. The default value is `null`. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| SeparateProcessOptions { get; } | Gets the options for extracting data in a separate process. |
| Threads { get; set; } | Gets or sets the number of threads used for indexing. The parameter must be in the range from `1` to `4`. The default value is `1`. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions/cancellation.md

#### IndexingOptions.Cancellation property

Gets or sets the operation cancellation object. The default value is `null`.

```csharp
public Cancellation Cancellation { get; set; }
```

##### Property Value

The operation cancellation object.

### IndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions/indexingoptions.md

#### IndexingOptions constructor

Initializes a new instance of the `IndexingOptions` class.

```csharp
public IndexingOptions()
```

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions/isasync.md

#### IndexingOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### SeparateProcessOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions/separateprocessoptions.md

#### IndexingOptions.SeparateProcessOptions property

Gets the options for extracting data in a separate process.

```csharp
public SeparateProcessOptions SeparateProcessOptions { get; }
```

##### Property Value

The options for extracting data in a separate process.

### Threads
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indexingoptions/threads.md

#### IndexingOptions.Threads property

Gets or sets the number of threads used for indexing. The parameter must be in the range from `1` to `4`. The default value is `1`.

```csharp
public int Threads { get; set; }
```

##### Property Value

The number of threads used for indexing.

### IndexType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/indextype.md

#### IndexType enumeration

Specifies an index type.

```csharp
public enum IndexType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NormalIndex | `0` | Normal index with documents metadata and documents content which supports all search features. |
| MetadataIndex | `1` | Index that contains only metadata of documents, without content. |
| CompactIndex | `2` | Index type that takes much less disk space but does not support phrase search and date range search features. |

### IOcrConnector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/iocrconnector.md

#### IOcrConnector interface

Defines methods that are required to recognize text on image documents and embedded images.

```csharp
public interface IOcrConnector
```

#### Methods

| Name | Description |
| --- | --- |
| Recognize(OcrContext) | Performs OCR processing on an image. |

### Recognize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/iocrconnector/recognize.md

#### IOcrConnector.Recognize method

Performs OCR processing on an image.

```csharp
public string Recognize(OcrContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| context | OcrContext | The OCR processing context. |

##### Return Value

The recognized text.

### ISearchDocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/isearchdocumentfilter.md

#### ISearchDocumentFilter interface

Represents search document filter. Use `SearchDocumentFilter` class for creation of a filter instances.

```csharp
public interface ISearchDocumentFilter
```

### KeyboardLayoutCorrectorOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/keyboardlayoutcorrectoroptions.md

#### KeyboardLayoutCorrectorOptions class

Provides options for the keyboard layout corrector.

```csharp
public class KeyboardLayoutCorrectorOptions
```

#### Properties

| Name | Description |
| --- | --- |
| Enabled { get; set; } | Gets or sets a value indicating whether the keyboard layout corrector is enabled. The default value is `false`. |

### Enabled
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/keyboardlayoutcorrectoroptions/enabled.md

#### KeyboardLayoutCorrectorOptions.Enabled property

Gets or sets a value indicating whether the keyboard layout corrector is enabled. The default value is `false`.

```csharp
public bool Enabled { get; set; }
```

##### Property Value

A value indicating whether the keyboard layout corrector is enabled.

### MailFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mailfieldnames.md

#### MailFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class MailFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const MailDisplayTo | The mail display to field name. |
| const MailMessageBody | The mail message body field name. |
| const MailSenderName | The mail sender name field name. |
| const MailSubject | The mail subject field name. |

### MailDisplayTo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mailfieldnames/maildisplayto.md

#### MailFieldNames.MailDisplayTo field

The mail display to field name.

```csharp
public const string MailDisplayTo;
```

### MailMessageBody
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mailfieldnames/mailmessagebody.md

#### MailFieldNames.MailMessageBody field

The mail message body field name.

```csharp
public const string MailMessageBody;
```

### MailSenderName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mailfieldnames/mailsendername.md

#### MailFieldNames.MailSenderName field

The mail sender name field name.

```csharp
public const string MailSenderName;
```

### MailSubject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mailfieldnames/mailsubject.md

#### MailFieldNames.MailSubject field

The mail subject field name.

```csharp
public const string MailSubject;
```

### MergeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mergeoptions.md

#### MergeOptions class

Provides options for merge operation.

```csharp
public class MergeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MergeOptions() | Initializes a new instance of the `MergeOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Cancellation { get; set; } | Gets or sets the operation cancellation object. The default value is `null`. |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mergeoptions/cancellation.md

#### MergeOptions.Cancellation property

Gets or sets the operation cancellation object. The default value is `null`.

```csharp
public Cancellation Cancellation { get; set; }
```

##### Property Value

The operation cancellation object.

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mergeoptions/isasync.md

#### MergeOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### MergeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/mergeoptions/mergeoptions.md

#### MergeOptions constructor

Initializes a new instance of the `MergeOptions` class.

```csharp
public MergeOptions()
```

### MetadataIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions.md

#### MetadataIndexingOptions class

Provides options for indexing metadata fields.

```csharp
public class MetadataIndexingOptions
```

#### Properties

| Name | Description |
| --- | --- |
| DefaultFieldName { get; set; } | Gets or sets the default field name used to index empty field names. The default value is `"unknown"`. |
| IndexingEmptyNames { get; set; } | Gets or sets a value indicating whether to index empty field names ​​or not. The default value is `true`. |
| IndexingEmptyValues { get; set; } | Gets or sets a value indicating whether to index empty field values ​​or not. The default value is `true`. |
| MaxBytesToIndexField { get; set; } | Gets or sets the maximum number of values in an array of type byte to index the field. The default value is `int.MaxValue`. |
| MaxDoublesToIndexField { get; set; } | Gets or sets the maximum number of values in an array of type double to index the field. The default value is `int.MaxValue`. |
| MaxIntsToIndexField { get; set; } | Gets or sets the maximum number of values in an array of type int to index the field. The default value is `int.MaxValue`. |
| MaxLongsToIndexField { get; set; } | Gets or sets the maximum number of values in an array of type long to index the field. The default value is `int.MaxValue`. |
| SeparatorBetweenValues { get; set; } | Gets or sets the separator between values ​​in a field of type array. The default value is the space sign. |
| SeparatorInCompoundName { get; set; } | Gets or sets the separator in the compound name of a field. The default value is `"."`. |

### DefaultFieldName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/defaultfieldname.md

#### MetadataIndexingOptions.DefaultFieldName property

Gets or sets the default field name used to index empty field names. The default value is `"unknown"`.

```csharp
public string DefaultFieldName { get; set; }
```

##### Property Value

The default field name used to index empty field names.

### IndexingEmptyNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/indexingemptynames.md

#### MetadataIndexingOptions.IndexingEmptyNames property

Gets or sets a value indicating whether to index empty field names ​​or not. The default value is `true`.

```csharp
public bool IndexingEmptyNames { get; set; }
```

##### Property Value

A value indicating whether to index empty field names ​​or not.

### IndexingEmptyValues
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/indexingemptyvalues.md

#### MetadataIndexingOptions.IndexingEmptyValues property

Gets or sets a value indicating whether to index empty field values ​​or not. The default value is `true`.

```csharp
public bool IndexingEmptyValues { get; set; }
```

##### Property Value

A value indicating whether to index empty field values ​​or not.

### MaxBytesToIndexField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/maxbytestoindexfield.md

#### MetadataIndexingOptions.MaxBytesToIndexField property

Gets or sets the maximum number of values in an array of type byte to index the field. The default value is `int.MaxValue`.

```csharp
public int MaxBytesToIndexField { get; set; }
```

##### Property Value

The maximum number of values in an array of type byte to index the field.

### MaxDoublesToIndexField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/maxdoublestoindexfield.md

#### MetadataIndexingOptions.MaxDoublesToIndexField property

Gets or sets the maximum number of values in an array of type double to index the field. The default value is `int.MaxValue`.

```csharp
public int MaxDoublesToIndexField { get; set; }
```

##### Property Value

The maximum number of values in an array of type double to index the field.

### MaxIntsToIndexField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/maxintstoindexfield.md

#### MetadataIndexingOptions.MaxIntsToIndexField property

Gets or sets the maximum number of values in an array of type int to index the field. The default value is `int.MaxValue`.

```csharp
public int MaxIntsToIndexField { get; set; }
```

##### Property Value

The maximum number of values in an array of type int to index the field.

### MaxLongsToIndexField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/maxlongstoindexfield.md

#### MetadataIndexingOptions.MaxLongsToIndexField property

Gets or sets the maximum number of values in an array of type long to index the field. The default value is `int.MaxValue`.

```csharp
public int MaxLongsToIndexField { get; set; }
```

##### Property Value

The maximum number of values in an array of type long to index the field.

### SeparatorBetweenValues
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/separatorbetweenvalues.md

#### MetadataIndexingOptions.SeparatorBetweenValues property

Gets or sets the separator between values ​​in a field of type array. The default value is the space sign.

```csharp
public string SeparatorBetweenValues { get; set; }
```

##### Property Value

The separator between values ​​in a field of type array.

### SeparatorInCompoundName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/metadataindexingoptions/separatorincompoundname.md

#### MetadataIndexingOptions.SeparatorInCompoundName property

Gets or sets the separator in the compound name of a field. The default value is `"."`.

```csharp
public string SeparatorInCompoundName { get; set; }
```

##### Property Value

The separator in the compound name of a field.

### NumberOfThreads
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/numberofthreads.md

#### NumberOfThreads enumeration

Specifies the number of threads.

```csharp
public enum NumberOfThreads
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | The default value. |
| One | `1` | One thread. |
| Two | `2` | Two threads. |
| Three | `3` | Three threads. |
| Four | `4` | Four threads. |
| Five | `5` | Five threads. |
| Six | `6` | Six threads. |
| Seven | `7` | Seven threads. |
| Eight | `8` | Eight threads. |

### OcrContext
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrcontext.md

#### OcrContext class

Represents the OCR processing context.

```csharp
public class OcrContext
```

#### Properties

| Name | Description |
| --- | --- |
| ImageFileExtension { get; } | Gets the file extension of the image. This value can be used to determine the type of the image. |
| ImageLocation { get; } | Gets the location of the image. |
| ImageStream { get; } | Gets the stream containing the image to be processed. |

### ImageFileExtension
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrcontext/imagefileextension.md

#### OcrContext.ImageFileExtension property

Gets the file extension of the image. This value can be used to determine the type of the image.

```csharp
public string ImageFileExtension { get; }
```

##### Property Value

The file extension of the image.

### ImageLocation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrcontext/imagelocation.md

#### OcrContext.ImageLocation property

Gets the location of the image.

```csharp
public ImageLocation ImageLocation { get; }
```

##### Property Value

The location of the image.

### ImageStream
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrcontext/imagestream.md

#### OcrContext.ImageStream property

Gets the stream containing the image to be processed.

```csharp
public Stream ImageStream { get; }
```

##### Property Value

The stream containing the image to be processed.

### OcrIndexingOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrindexingoptions.md

#### OcrIndexingOptions class

Provides options for OCR processing and indexing recognized text.

```csharp
public class OcrIndexingOptions
```

#### Properties

| Name | Description |
| --- | --- |
| EnabledForContainerItemImages { get; set; } | Gets or sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is `false`. |
| EnabledForEmbeddedImages { get; set; } | Gets or sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is `false`. |
| EnabledForSeparateImages { get; set; } | Gets or sets a value indicating whether to recognize text in separate image files. The default value is `false`. |
| OcrConnector { get; set; } | Gets or sets an OCR connector that is used for OCR processing. The default value is `null`, which means no OCR is used. |

### EnabledForContainerItemImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrindexingoptions/enabledforcontaineritemimages.md

#### OcrIndexingOptions.EnabledForContainerItemImages property

Gets or sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is `false`.

```csharp
public bool EnabledForContainerItemImages { get; set; }
```

##### Property Value

A value indicating whether to recognize text in images that are items in a container.

### EnabledForEmbeddedImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrindexingoptions/enabledforembeddedimages.md

#### OcrIndexingOptions.EnabledForEmbeddedImages property

Gets or sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is `false`.

```csharp
public bool EnabledForEmbeddedImages { get; set; }
```

##### Property Value

A value indicating whether to recognize text in embedded images.

### EnabledForSeparateImages
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrindexingoptions/enabledforseparateimages.md

#### OcrIndexingOptions.EnabledForSeparateImages property

Gets or sets a value indicating whether to recognize text in separate image files. The default value is `false`.

```csharp
public bool EnabledForSeparateImages { get; set; }
```

##### Property Value

A value indicating whether to recognize text in separate image files.

### OcrConnector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/ocrindexingoptions/ocrconnector.md

#### OcrIndexingOptions.OcrConnector property

Gets or sets an OCR connector that is used for OCR processing. The default value is `null`, which means no OCR is used.

```csharp
public IOcrConnector OcrConnector { get; set; }
```

##### Property Value

An OCR connector that is used for OCR processing.

### OptimizeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/optimizeoptions.md

#### OptimizeOptions class

Provides options for the optimize operation.

```csharp
public class OptimizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OptimizeOptions() | Initializes a new instance of the `OptimizeOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/optimizeoptions/isasync.md

#### OptimizeOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### OptimizeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/optimizeoptions/optimizeoptions.md

#### OptimizeOptions constructor

Initializes a new instance of the `OptimizeOptions` class.

```csharp
public OptimizeOptions()
```

### OutputFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/outputformat.md

#### OutputFormat enumeration

The output format of a data.

```csharp
public enum OutputFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Html | `0` | The HTML format. |
| PlainText | `1` | The plain text format. |

### PresentationFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames.md

#### PresentationFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class PresentationFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Application | The application field name. |
| const ApplicationVersion | The application version field name. |
| const Author | The author field name. |
| const Category | The category field name. |
| const Comments | The comments field name. |
| const Company | The company field name. |
| const ContentStatus | The content status field name. |
| const CreatedTime | The created time field name. |
| const HyperlinkBase | The hyperlink base field name. |
| const Keywords | The keywords field name. |
| const LastAuthor | The last author field name. |
| const LastPrintedTime | The last printed time field name. |
| const LastSavedTime | The last saved time field name. |
| const Manager | The manager field name. |
| const RevisionNumber | The revision number field name. |
| const Subject | The subject field name. |
| const Title | The title field name. |
| const TotalEditingTime | The total editing time field name. |

### Application
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/application.md

#### PresentationFieldNames.Application field

The application field name.

```csharp
public const string Application;
```

### ApplicationVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/applicationversion.md

#### PresentationFieldNames.ApplicationVersion field

The application version field name.

```csharp
public const string ApplicationVersion;
```

### Author
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/author.md

#### PresentationFieldNames.Author field

The author field name.

```csharp
public const string Author;
```

### Category
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/category.md

#### PresentationFieldNames.Category field

The category field name.

```csharp
public const string Category;
```

### Comments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/comments.md

#### PresentationFieldNames.Comments field

The comments field name.

```csharp
public const string Comments;
```

### Company
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/company.md

#### PresentationFieldNames.Company field

The company field name.

```csharp
public const string Company;
```

### ContentStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/contentstatus.md

#### PresentationFieldNames.ContentStatus field

The content status field name.

```csharp
public const string ContentStatus;
```

### CreatedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/createdtime.md

#### PresentationFieldNames.CreatedTime field

The created time field name.

```csharp
public const string CreatedTime;
```

### HyperlinkBase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/hyperlinkbase.md

#### PresentationFieldNames.HyperlinkBase field

The hyperlink base field name.

```csharp
public const string HyperlinkBase;
```

### Keywords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/keywords.md

#### PresentationFieldNames.Keywords field

The keywords field name.

```csharp
public const string Keywords;
```

### LastAuthor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/lastauthor.md

#### PresentationFieldNames.LastAuthor field

The last author field name.

```csharp
public const string LastAuthor;
```

### LastPrintedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/lastprintedtime.md

#### PresentationFieldNames.LastPrintedTime field

The last printed time field name.

```csharp
public const string LastPrintedTime;
```

### LastSavedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/lastsavedtime.md

#### PresentationFieldNames.LastSavedTime field

The last saved time field name.

```csharp
public const string LastSavedTime;
```

### Manager
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/manager.md

#### PresentationFieldNames.Manager field

The manager field name.

```csharp
public const string Manager;
```

### RevisionNumber
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/revisionnumber.md

#### PresentationFieldNames.RevisionNumber field

The revision number field name.

```csharp
public const string RevisionNumber;
```

### Subject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/subject.md

#### PresentationFieldNames.Subject field

The subject field name.

```csharp
public const string Subject;
```

### Title
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/title.md

#### PresentationFieldNames.Title field

The title field name.

```csharp
public const string Title;
```

### TotalEditingTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/presentationfieldnames/totaleditingtime.md

#### PresentationFieldNames.TotalEditingTime field

The total editing time field name.

```csharp
public const string TotalEditingTime;
```

### SearchDocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter.md

#### SearchDocumentFilter class

Contains methods for creating search document filters.

```csharp
public static class SearchDocumentFilter
```

#### Methods

| Name | Description |
| --- | --- |
| static CreateAnd(params ISearchDocumentFilter[]) | Creates a logical conjunction of the specified filters. |
| static CreateAttribute(params string[]) | Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes. |
| static CreateFileExtension(params string[]) | Creates a filter for skipping documents that are not in the specified list of possible extensions. |
| static CreateFilePathRegularExpression(string) | Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document. |
| static CreateFilePathRegularExpression(string, RegexOptions) | Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document. |
| static CreateNot(ISearchDocumentFilter) | Creates a filter that has inverse logic in relation to the specified inner filter. |
| static CreateOr(params ISearchDocumentFilter[]) | Creates a logical disjunction of the specified filters. |

### CreateAnd
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createand.md

#### SearchDocumentFilter.CreateAnd method

Creates a logical conjunction of the specified filters.

```csharp
public static ISearchDocumentFilter CreateAnd(params ISearchDocumentFilter[] filters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filters | ISearchDocumentFilter[] | The search document filters. |

##### Return Value

A search document filter that represents result of conjunction of the specified filters.

### CreateAttribute
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createattribute.md

#### SearchDocumentFilter.CreateAttribute method

Creates a filter for skipping documents that do not have any value from the specified list of allowable attributes.

```csharp
public static ISearchDocumentFilter CreateAttribute(params string[] attributes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attributes | String[] | The list of allowable attributes. |

##### Return Value

A search document filter by document attribute.

### CreateFileExtension
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createfileextension.md

#### SearchDocumentFilter.CreateFileExtension method

Creates a filter for skipping documents that are not in the specified list of possible extensions.

```csharp
public static ISearchDocumentFilter CreateFileExtension(params string[] extensions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extensions | String[] | The list of possible extensions. |

##### Return Value

A search document filter by document extension.

### CreateFilePathRegularExpression
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createfilepathregularexpression.md

#### CreateFilePathRegularExpression(string)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

```csharp
public static ISearchDocumentFilter CreateFilePathRegularExpression(string pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern. |

##### Return Value

A search document filter by file name.

#### CreateFilePathRegularExpression(string, RegexOptions)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

```csharp
public static ISearchDocumentFilter CreateFilePathRegularExpression(string pattern, 
    RegexOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern. |
| options | RegexOptions | The regular expression options. |

##### Return Value

A search document filter by file name.

### CreateNot
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createnot.md

#### SearchDocumentFilter.CreateNot method

Creates a filter that has inverse logic in relation to the specified inner filter.

```csharp
public static ISearchDocumentFilter CreateNot(ISearchDocumentFilter innerFilter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| innerFilter | ISearchDocumentFilter | The inner search document filter. |

##### Return Value

An inverted search document filter.

### CreateOr
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchdocumentfilter/createor.md

#### SearchDocumentFilter.CreateOr method

Creates a logical disjunction of the specified filters.

```csharp
public static ISearchDocumentFilter CreateOr(params ISearchDocumentFilter[] filters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filters | ISearchDocumentFilter[] | The search document filters. |

##### Return Value

A search document filter that represents result of disjunction of the specified filters.

### SearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions.md

#### SearchOptions class

Provides options for search operation.

```csharp
public class SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SearchOptions() | Initializes a new instance of the `SearchOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| Cancellation { get; set; } | Gets or sets the operation cancellation object. The default value is `null`. |
| DateFormats { get; } | Gets the collection of date formats for date range search. The default date formats are 'dd.MM.yyyy', 'MM/dd/yyyy', and 'yyyy-MM-dd'. |
| FuzzySearch { get; } | Gets the fuzzy search options. |
| IsChunkSearch { get; set; } | Gets or sets the flag of search by chunks. The default value is `false`. |
| KeyboardLayoutCorrector { get; } | Gets the keyboard layout corrector options. |
| MaxOccurrenceCountPerTerm { get; set; } | Gets or sets the maximum number of occurrences of each term in a search query. The default value is `2000000000`. |
| MaxTotalOccurrenceCount { get; set; } | Gets or sets the maximum total number of occurrences of all terms in a search query. The default value is `2000000000`. |
| RetrieveAttributes { get; set; } | Gets or sets the flag of retrieving attributes associated with found documents. The default value is `false`. |
| SearchDocumentFilter { get; set; } | Gets or sets the search document filter. `SearchDocumentFilter` works on the inclusion logic. Use `SearchDocumentFilter` class for creation of a search document filter instances. The default value is `null`, which means that all found documents will be returned. |
| SpellingCorrector { get; } | Gets the spelling corrector options. |
| UseCaseSensitiveSearch { get; set; } | Gets or sets the flag of case sensitive search. The default value is `false`. |
| UseHomophoneSearch { get; set; } | Gets or sets the flag of use homophones in search. The default value is `false`. |
| UseSynonymSearch { get; set; } | Gets or sets the flag of use synonyms in search. The default value is `false`. |
| UseWordFormsSearch { get; set; } | Gets or sets the flag of use different word forms in search. The default value is `false`. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/cancellation.md

#### SearchOptions.Cancellation property

Gets or sets the operation cancellation object. The default value is `null`.

```csharp
public Cancellation Cancellation { get; set; }
```

##### Property Value

The operation cancellation object.

### DateFormats
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/dateformats.md

#### SearchOptions.DateFormats property

Gets the collection of date formats for date range search. The default date formats are 'dd.MM.yyyy', 'MM/dd/yyyy', and 'yyyy-MM-dd'.

```csharp
public DateFormatCollection DateFormats { get; }
```

##### Property Value

The collection of date formats for date range search.

##### Examples

The example demonstrates how to set the date formats for the search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating an index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.DateFormats.Clear(); // Removing default date formats
DateFormatElement[] elements = new DateFormatElement[]
{
    DateFormatElement.MonthTwoDigits,
    DateFormatElement.DayOfMonthTwoDigits,
    DateFormatElement.YearFourDigits,
};
// Creating a date format pattern 'MM/dd/yyyy'
DateFormat dateFormat = new DateFormat(elements, "/");
options.DateFormats.Add(dateFormat);

SearchResult result = index.Search(query, options); // Search in index
```

### FuzzySearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/fuzzysearch.md

#### SearchOptions.FuzzySearch property

Gets the fuzzy search options.

```csharp
public FuzzySearchOptions FuzzySearch { get; }
```

##### Property Value

The fuzzy search options.

### IsChunkSearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/ischunksearch.md

#### SearchOptions.IsChunkSearch property

Gets or sets the flag of search by chunks. The default value is `false`.

```csharp
public bool IsChunkSearch { get; set; }
```

##### Property Value

The flag of search by chunks.

### KeyboardLayoutCorrector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/keyboardlayoutcorrector.md

#### SearchOptions.KeyboardLayoutCorrector property

Gets the keyboard layout corrector options.

```csharp
public KeyboardLayoutCorrectorOptions KeyboardLayoutCorrector { get; }
```

##### Property Value

The keyboard layout corrector options.

### MaxOccurrenceCountPerTerm
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/maxoccurrencecountperterm.md

#### SearchOptions.MaxOccurrenceCountPerTerm property

Gets or sets the maximum number of occurrences of each term in a search query. The default value is `2000000000`.

```csharp
public int MaxOccurrenceCountPerTerm { get; set; }
```

##### Property Value

The maximum number of occurrences of each term in a search query.

### MaxTotalOccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/maxtotaloccurrencecount.md

#### SearchOptions.MaxTotalOccurrenceCount property

Gets or sets the maximum total number of occurrences of all terms in a search query. The default value is `2000000000`.

```csharp
public int MaxTotalOccurrenceCount { get; set; }
```

##### Property Value

The maximum total number of occurrences.

### RetrieveAttributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/retrieveattributes.md

#### SearchOptions.RetrieveAttributes property

Gets or sets the flag of retrieving attributes associated with found documents. The default value is `false`.

```csharp
public bool RetrieveAttributes { get; set; }
```

##### Property Value

The flag of retrieving attributes associated with found documents.

### SearchDocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/searchdocumentfilter.md

#### SearchOptions.SearchDocumentFilter property

Gets or sets the search document filter. `SearchDocumentFilter` works on the inclusion logic. Use `SearchDocumentFilter` class for creation of a search document filter instances. The default value is `null`, which means that all found documents will be returned.

```csharp
public ISearchDocumentFilter SearchDocumentFilter { get; set; }
```

##### Property Value

The search document filter.

##### Examples

The example demonstrates how to set the document filter.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments1\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents
index.Add(documentsFolder);

// Creating a search document filter that skips documents with extensions '.doc', '.docx', '.rtf'
SearchOptions options = new SearchOptions();
ISearchDocumentFilter fileExtensionFilter = SearchDocumentFilter.CreateFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
ISearchDocumentFilter invertedFilter = SearchDocumentFilter.CreateNot(fileExtensionFilter); // Inverting file extension filter
options.SearchDocumentFilter = invertedFilter;

// Search in index
SearchResult result = index.Search("Einstein", options);
```

### SearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/searchoptions.md

#### SearchOptions constructor

Initializes a new instance of the `SearchOptions` class.

```csharp
public SearchOptions()
```

### SpellingCorrector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/spellingcorrector.md

#### SearchOptions.SpellingCorrector property

Gets the spelling corrector options.

```csharp
public SpellingCorrectorOptions SpellingCorrector { get; }
```

##### Property Value

The spelling corrector options.

### UseCaseSensitiveSearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/usecasesensitivesearch.md

#### SearchOptions.UseCaseSensitiveSearch property

Gets or sets the flag of case sensitive search. The default value is `false`.

```csharp
public bool UseCaseSensitiveSearch { get; set; }
```

##### Property Value

The flag of case sensitive search.

### UseHomophoneSearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/usehomophonesearch.md

#### SearchOptions.UseHomophoneSearch property

Gets or sets the flag of use homophones in search. The default value is `false`.

```csharp
public bool UseHomophoneSearch { get; set; }
```

##### Property Value

The flag of use homophones in search.

### UseSynonymSearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/usesynonymsearch.md

#### SearchOptions.UseSynonymSearch property

Gets or sets the flag of use synonyms in search. The default value is `false`.

```csharp
public bool UseSynonymSearch { get; set; }
```

##### Property Value

The flag of use synonyms in search.

### UseWordFormsSearch
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/searchoptions/usewordformssearch.md

#### SearchOptions.UseWordFormsSearch property

Gets or sets the flag of use different word forms in search. The default value is `false`.

```csharp
public bool UseWordFormsSearch { get; set; }
```

##### Property Value

The flag of use different word forms in search.

### SeparateProcessOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/separateprocessoptions.md

#### SeparateProcessOptions class

Provides options for extracting data from documents in a separate process.

```csharp
public class SeparateProcessOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AssemblyPath { get; set; } | Gets or sets the path to the separate process assembly. |
| ExtractInSeparateProcess { get; set; } | Gets or sets a value indicating whether a separate process is used to extract data from documents. The default value is `false`. When this option is enabled, data extraction is performed in a separate process in only one thread. The specified number of threads is ignored when extracting in a separate process. |
| Timeout { get; set; } | Gets or sets the maximum time to wait for the result of data extraction in a separate process. The default value is 10 minutes. |
| UseDotnetToStartProcess { get; set; } | Gets or sets the flag for using `dotnet` to start the process. The default value is `true`. Set the value to `false` if you want to start a self-contained application. Note that `dotnet` is never used to start on the old .NET Framework. |

### AssemblyPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/separateprocessoptions/assemblypath.md

#### SeparateProcessOptions.AssemblyPath property

Gets or sets the path to the separate process assembly.

```csharp
public string AssemblyPath { get; set; }
```

##### Property Value

The path to the separate process assembly.

### ExtractInSeparateProcess
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/separateprocessoptions/extractinseparateprocess.md

#### SeparateProcessOptions.ExtractInSeparateProcess property

Gets or sets a value indicating whether a separate process is used to extract data from documents. The default value is `false`. When this option is enabled, data extraction is performed in a separate process in only one thread. The specified number of threads is ignored when extracting in a separate process.

```csharp
public bool ExtractInSeparateProcess { get; set; }
```

##### Property Value

A value indicating whether a separate process is used to extract data from documents.

### Timeout
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/separateprocessoptions/timeout.md

#### SeparateProcessOptions.Timeout property

Gets or sets the maximum time to wait for the result of data extraction in a separate process. The default value is 10 minutes.

```csharp
public TimeSpan Timeout { get; set; }
```

##### Property Value

The timeout for data extraction in a separate process.

### UseDotnetToStartProcess
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/separateprocessoptions/usedotnettostartprocess.md

#### SeparateProcessOptions.UseDotnetToStartProcess property

Gets or sets the flag for using `dotnet` to start the process. The default value is `true`. Set the value to `false` if you want to start a self-contained application. Note that `dotnet` is never used to start on the old .NET Framework.

```csharp
public bool UseDotnetToStartProcess { get; set; }
```

##### Property Value

The flag for using `dotnet` to start the process.

### SimilarityLevel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/similaritylevel.md

#### SimilarityLevel class

Represents an algorithm of the fuzzy search that specifies the similarity level. The similarity level algorithm calculates the maximum number of mistakes for a word as inversely proportional to the word length.

```csharp
public class SimilarityLevel : FuzzyAlgorithm
```

#### Constructors

| Name | Description |
| --- | --- |
| SimilarityLevel(double) | Initializes a new instance of the `SimilarityLevel` class. |

#### Methods

| Name | Description |
| --- | --- |
| override GetMaxMistakeCount(int) | Gets the maximum allowed number of mistakes for the specified term length. |
| override GetSimilarityLevel(int) | Gets the similarity level value for the specified term length. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating an index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.FuzzySearch.Enabled = true; // Enabling the fuzzy search
options.FuzzySearch.FuzzyAlgorithm = new SimilarityLevel(0.8); // Creating the fuzzy search algorithm
// This function specifies 0 as the maximum number of mistakes for words from 1 to 4 characters.
// It specifies 1 as the maximum number of mistakes for words from 5 to 9 characters.
// It specifies 2 as the maximum number of mistakes for words from 10 to 14 characters. And so on.

SearchResult result = index.Search(query, options); // Search in index
```

### GetMaxMistakeCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/similaritylevel/getmaxmistakecount.md

#### SimilarityLevel.GetMaxMistakeCount method

Gets the maximum allowed number of mistakes for the specified term length.

```csharp
public override int GetMaxMistakeCount(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

The maximum allowed number of mistakes.

### GetSimilarityLevel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/similaritylevel/getsimilaritylevel.md

#### SimilarityLevel.GetSimilarityLevel method

Gets the similarity level value for the specified term length.

```csharp
public override double GetSimilarityLevel(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

The similarity level value.

### SimilarityLevel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/similaritylevel/similaritylevel.md

#### SimilarityLevel constructor

Initializes a new instance of the `SimilarityLevel` class.

```csharp
public SimilarityLevel(double value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Double | The similarity level value. |

### SpellingCorrectorOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions.md

#### SpellingCorrectorOptions class

Provides options for the spelling corrector.

```csharp
public class SpellingCorrectorOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ConsiderTranspositions { get; set; } | Gets or sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is `true`. |
| Enabled { get; set; } | Gets or sets a value indicating whether the spelling corrector is enabled. The default value is `false`. |
| MaxMistakeCount { get; set; } | Gets or sets the maximum number of mistakes. The default value is `2`. |
| OnlyBestResults { get; set; } | Gets or sets a value indicating whether only the best results will be returned. The default value is `false`. |
| OnlyBestResultsRange { get; set; } | Gets or sets the maximum exceeding of the minimum number of mistakes that are found. The default value is `0`. |

### ConsiderTranspositions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions/considertranspositions.md

#### SpellingCorrectorOptions.ConsiderTranspositions property

Gets or sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is `true`.

```csharp
public bool ConsiderTranspositions { get; set; }
```

##### Property Value

`true` if the spelling corrector algorithm considers transpositions; otherwise `false`.

### Enabled
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions/enabled.md

#### SpellingCorrectorOptions.Enabled property

Gets or sets a value indicating whether the spelling corrector is enabled. The default value is `false`.

```csharp
public bool Enabled { get; set; }
```

##### Property Value

A value indicating whether the spelling corrector is enabled.

### MaxMistakeCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions/maxmistakecount.md

#### SpellingCorrectorOptions.MaxMistakeCount property

Gets or sets the maximum number of mistakes. The default value is `2`.

```csharp
public int MaxMistakeCount { get; set; }
```

##### Property Value

The maximum number of mistakes.

### OnlyBestResults
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions/onlybestresults.md

#### SpellingCorrectorOptions.OnlyBestResults property

Gets or sets a value indicating whether only the best results will be returned. The default value is `false`.

```csharp
public bool OnlyBestResults { get; set; }
```

##### Property Value

`true` if only the best results will be returned; otherwise `false`.

### OnlyBestResultsRange
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spellingcorrectoroptions/onlybestresultsrange.md

#### SpellingCorrectorOptions.OnlyBestResultsRange property

Gets or sets the maximum exceeding of the minimum number of mistakes that are found. The default value is `0`.

```csharp
public byte OnlyBestResultsRange { get; set; }
```

##### Property Value

The maximum exceeding of the minimum number of mistakes found.

### SpreadsheetFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames.md

#### SpreadsheetFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class SpreadsheetFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Application | The application field name. |
| const ApplicationVersion | The application version field name. |
| const Author | Author field name. |
| const Category | The category field name. |
| const Comments | The comments field name. |
| const Company | The company field name. |
| const ContentStatus | The content status field name. |
| const CreatedTime | The created time field name. |
| const HyperlinkBase | The hyperlink base field name. |
| const Keywords | The keywords field name. |
| const LastAuthor | The last author field name. |
| const LastPrintedTime | The last printed time field name. |
| const LastSavedTime | The last saved time field name. |
| const Manager | The manager field name. |
| const Subject | The subject field name. |
| const Title | The title field name. |

### Application
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/application.md

#### SpreadsheetFieldNames.Application field

The application field name.

```csharp
public const string Application;
```

### ApplicationVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/applicationversion.md

#### SpreadsheetFieldNames.ApplicationVersion field

The application version field name.

```csharp
public const string ApplicationVersion;
```

### Author
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/author.md

#### SpreadsheetFieldNames.Author field

Author field name.

```csharp
public const string Author;
```

### Category
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/category.md

#### SpreadsheetFieldNames.Category field

The category field name.

```csharp
public const string Category;
```

### Comments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/comments.md

#### SpreadsheetFieldNames.Comments field

The comments field name.

```csharp
public const string Comments;
```

### Company
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/company.md

#### SpreadsheetFieldNames.Company field

The company field name.

```csharp
public const string Company;
```

### ContentStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/contentstatus.md

#### SpreadsheetFieldNames.ContentStatus field

The content status field name.

```csharp
public const string ContentStatus;
```

### CreatedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/createdtime.md

#### SpreadsheetFieldNames.CreatedTime field

The created time field name.

```csharp
public const string CreatedTime;
```

### HyperlinkBase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/hyperlinkbase.md

#### SpreadsheetFieldNames.HyperlinkBase field

The hyperlink base field name.

```csharp
public const string HyperlinkBase;
```

### Keywords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/keywords.md

#### SpreadsheetFieldNames.Keywords field

The keywords field name.

```csharp
public const string Keywords;
```

### LastAuthor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/lastauthor.md

#### SpreadsheetFieldNames.LastAuthor field

The last author field name.

```csharp
public const string LastAuthor;
```

### LastPrintedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/lastprintedtime.md

#### SpreadsheetFieldNames.LastPrintedTime field

The last printed time field name.

```csharp
public const string LastPrintedTime;
```

### LastSavedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/lastsavedtime.md

#### SpreadsheetFieldNames.LastSavedTime field

The last saved time field name.

```csharp
public const string LastSavedTime;
```

### Manager
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/manager.md

#### SpreadsheetFieldNames.Manager field

The manager field name.

```csharp
public const string Manager;
```

### Subject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/subject.md

#### SpreadsheetFieldNames.Subject field

The subject field name.

```csharp
public const string Subject;
```

### Title
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/spreadsheetfieldnames/title.md

#### SpreadsheetFieldNames.Title field

The title field name.

```csharp
public const string Title;
```

### Step
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/step.md

#### Step class

Represents a step of a step function.

```csharp
public class Step
```

#### Constructors

| Name | Description |
| --- | --- |
| Step(int, int) | Initializes a new instance of the `Step` class. |

#### Properties

| Name | Description |
| --- | --- |
| Level { get; } | Gets the level. |
| LowerLimit { get; } | Gets the lower limit. |

### Level
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/step/level.md

#### Step.Level property

Gets the level.

```csharp
public int Level { get; }
```

##### Property Value

The level.

### LowerLimit
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/step/lowerlimit.md

#### Step.LowerLimit property

Gets the lower limit.

```csharp
public int LowerLimit { get; }
```

##### Property Value

The lower limit.

### Step
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/step/step.md

#### Step constructor

Initializes a new instance of the `Step` class.

```csharp
public Step(int lowerLimit, int level)
```

| Parameter | Type | Description |
| --- | --- | --- |
| lowerLimit | Int32 | The lower limit. |
| level | Int32 | The level. |

### SynchronizeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/synchronizeoptions.md

#### SynchronizeOptions class

Provides options for the synchronize operation.

```csharp
public class SynchronizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SynchronizeOptions() | Initializes a new instance of the `SynchronizeOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/synchronizeoptions/isasync.md

#### SynchronizeOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### SynchronizeOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/synchronizeoptions/synchronizeoptions.md

#### SynchronizeOptions constructor

Initializes a new instance of the `SynchronizeOptions` class.

```csharp
public SynchronizeOptions()
```

### TableDiscreteFunction
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/tablediscretefunction.md

#### TableDiscreteFunction class

Represents the fuzzy search algorithm that contains correspondences between word lengths and the number of allowed mistakes. This algorithm can be specified by a table of output values or by a step function.

```csharp
public class TableDiscreteFunction : FuzzyAlgorithm
```

#### Constructors

| Name | Description |
| --- | --- |
| TableDiscreteFunction(int, int[]) | Initializes a new instance of the `TableDiscreteFunction` class. |
| TableDiscreteFunction(int, params Step[]) | Initializes a new instance of the `TableDiscreteFunction` class. |

#### Methods

| Name | Description |
| --- | --- |
| override GetMaxMistakeCount(int) | Gets a maximum allowed number of mistakes for specified term length. |
| override GetSimilarityLevel(int) | Gets a similarity level for specified term length. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating an index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.FuzzySearch.Enabled = true; // Enabling the fuzzy search
options.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1, new Step(5, 2), new Step(8, 3)); // Creating the fuzzy search algorithm
// This function specifies 1 as the maximum number of mistakes for words from 1 to 4 characters.
// It specifies 2 as the maximum number of mistakes for words from 5 to 7 characters.
// It specifies 3 as the maximum number of mistakes for words from 8 and more characters.

SearchResult result = index.Search(query, options); // Search in index
```

### GetMaxMistakeCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/tablediscretefunction/getmaxmistakecount.md

#### TableDiscreteFunction.GetMaxMistakeCount method

Gets a maximum allowed number of mistakes for specified term length.

```csharp
public override int GetMaxMistakeCount(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

A maximum allowed number of mistakes.

### GetSimilarityLevel
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/tablediscretefunction/getsimilaritylevel.md

#### TableDiscreteFunction.GetSimilarityLevel method

Gets a similarity level for specified term length.

```csharp
public override double GetSimilarityLevel(int termLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| termLength | Int32 | The term length. |

##### Return Value

A similarity level.

### TableDiscreteFunction
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/tablediscretefunction/tablediscretefunction.md

#### TableDiscreteFunction(int, int[])

Initializes a new instance of the `TableDiscreteFunction` class.

```csharp
public TableDiscreteFunction(int offsetOfInputs, int[] tableOfOutputs)
```

| Parameter | Type | Description |
| --- | --- | --- |
| offsetOfInputs | Int32 | The offset of the table indeces relative to the input values. |
| tableOfOutputs | Int32[] | The table of output values. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *tableOfOutputs* is `null`. |
| ArgumentException | Thrown when number of table elements is 0. |

#### TableDiscreteFunction(int, params Step[])

Initializes a new instance of the `TableDiscreteFunction` class.

```csharp
public TableDiscreteFunction(int firstStepLevel, params Step[] steps)
```

| Parameter | Type | Description |
| --- | --- | --- |
| firstStepLevel | Int32 | The level of the first step of the step function. |
| steps | Step[] | The next steps of the step function. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *steps* is `null`. |
| ArgumentException | Thrown when limits of steps are not strictly increasing. |

### TextOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions.md

#### TextOptions class

Provides options for retrieving document text from an index.

```csharp
public class TextOptions : BaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextOptions() | Initializes a new instance of the `TextOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AdditionalFields { get; set; } | Gets or sets the additional document fields that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index. |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| Cancellation { get; set; } | Gets or sets the cancellation object. The default value is `null`. |
| CustomExtractor { get; set; } | Gets or sets the custom text extractor that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| GenerateHead { get; set; } | Gets or sets a value indicating whether the Head tag is generated in the output HTML. The default value is `true`. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### AdditionalFields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions/additionalfields.md

#### TextOptions.AdditionalFields property

Gets or sets the additional document fields that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index.

```csharp
public DocumentField[] AdditionalFields { get; set; }
```

##### Property Value

The additional document fields that was used for indexing.

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions/cancellation.md

#### TextOptions.Cancellation property

Gets or sets the cancellation object. The default value is `null`.

```csharp
public Cancellation Cancellation { get; set; }
```

##### Property Value

The cancellation object.

### CustomExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions/customextractor.md

#### TextOptions.CustomExtractor property

Gets or sets the custom text extractor that was used for indexing. The default value is `null`. Note that this value is used only if document text was not saved into the index.

```csharp
public IFieldExtractor CustomExtractor { get; set; }
```

##### Property Value

The custom text extractor that was used for indexing.

### GenerateHead
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions/generatehead.md

#### TextOptions.GenerateHead property

Gets or sets a value indicating whether the Head tag is generated in the output HTML. The default value is `true`.

```csharp
public bool GenerateHead { get; set; }
```

##### Property Value

A value indicating whether the Head tag is generated in the output HTML.

### TextOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textoptions/textoptions.md

#### TextOptions constructor

Initializes a new instance of the `TextOptions` class.

```csharp
public TextOptions()
```

### TextStorageSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textstoragesettings.md

#### TextStorageSettings class

Represents the text storage settings.

```csharp
public class TextStorageSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| TextStorageSettings(Compression) | Initializes a new instance of the `TextStorageSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| Compression { get; set; } | Gets or sets the compression of text storage. The default value is Normal. |

### Compression
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textstoragesettings/compression.md

#### TextStorageSettings.Compression property

Gets or sets the compression of text storage. The default value is Normal.

```csharp
public Compression Compression { get; set; }
```

##### Property Value

The compression of text storage.

### TextStorageSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/textstoragesettings/textstoragesettings.md

#### TextStorageSettings constructor

Initializes a new instance of the `TextStorageSettings` class.

```csharp
public TextStorageSettings(Compression compression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| compression | Compression | The compression of text storage. |

### UpdateOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions.md

#### UpdateOptions class

Provides options for update operation.

```csharp
public class UpdateOptions : BaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| UpdateOptions() | Initializes a new instance of the `UpdateOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AutoDetectEncoding { get; set; } | Gets or sets a value indicating whether to detect encoding automatically or not. The default value is `false`. |
| Cancellation { get; set; } | Gets or sets the operation cancellation object. The default value is `null`. |
| Encoding { get; set; } | Gets or sets the encoding used to extract text from text documents. The default value is `null`, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is `true` then this value is used as the default encoding. |
| ImageIndexingOptions { get; } | Gets the image indexing options for reverse image search. |
| IsAsync { get; set; } | Gets or sets the flag of asynchronous performing the operation. The default value is `false`. |
| MetadataIndexingOptions { get; } | Gets the options for indexing metadata fields. |
| OcrIndexingOptions { get; } | Gets the options for OCR processing and indexing recognized text. |
| SeparateProcessOptions { get; } | Gets the options for extracting data in a separate process. |
| Threads { get; set; } | Gets or sets the number of threads used for indexing. The default value is `1`. |
| UseBackupPrivilege { get; set; } | Gets or sets a value indicating whether the process should use the SeBackupPrivilege and FILE_FLAG_BACKUP_SEMANTICS to access files and directories. The default value is `false`. |
| UseRawTextExtraction { get; set; } | Gets or sets a value indicating whether the raw mode is used for text extraction if possible. The default value is `false`. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text. |

### Cancellation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions/cancellation.md

#### UpdateOptions.Cancellation property

Gets or sets the operation cancellation object. The default value is `null`.

```csharp
public Cancellation Cancellation { get; set; }
```

##### Property Value

The operation cancellation object.

### IsAsync
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions/isasync.md

#### UpdateOptions.IsAsync property

Gets or sets the flag of asynchronous performing the operation. The default value is `false`.

```csharp
public bool IsAsync { get; set; }
```

##### Property Value

The flag of asynchronous performing the operation.

### SeparateProcessOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions/separateprocessoptions.md

#### UpdateOptions.SeparateProcessOptions property

Gets the options for extracting data in a separate process.

```csharp
public SeparateProcessOptions SeparateProcessOptions { get; }
```

##### Property Value

The options for extracting data in a separate process.

### Threads
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions/threads.md

#### UpdateOptions.Threads property

Gets or sets the number of threads used for indexing. The default value is `1`.

```csharp
public int Threads { get; set; }
```

##### Property Value

The number of threads used for indexing.

### UpdateOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/updateoptions/updateoptions.md

#### UpdateOptions constructor

Initializes a new instance of the `UpdateOptions` class.

```csharp
public UpdateOptions()
```

### WordsFieldNames
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames.md

#### WordsFieldNames class

Represents a list of field names for the faceted search.

```csharp
public static class WordsFieldNames
```

#### Fields

| Name | Description |
| --- | --- |
| const Application | The application field name. |
| const ApplicationVersion | The application version field name. |
| const Author | The author field name. |
| const Category | The category field name. |
| const Comments | The comments field name. |
| const Company | The company field name. |
| const ContentStatus | The content status field name. |
| const CreatedTime | The created time field name. |
| const HyperlinkBase | The hyperlink base field name. |
| const Keywords | The keywords field name. |
| const LastAuthor | The last author field name. |
| const LastPrintedTime | The last printed time field name. |
| const LastSavedTime | The last saved time field name. |
| const Manager | The manager field name. |
| const RevisionNumber | The revision number field name. |
| const Subject | The subject field name. |
| const Template | The template field name. |
| const Title | The title field name. |
| const TotalEditingTime | The total editing time field name. |

### Application
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/application.md

#### WordsFieldNames.Application field

The application field name.

```csharp
public const string Application;
```

### ApplicationVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/applicationversion.md

#### WordsFieldNames.ApplicationVersion field

The application version field name.

```csharp
public const string ApplicationVersion;
```

### Author
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/author.md

#### WordsFieldNames.Author field

The author field name.

```csharp
public const string Author;
```

### Category
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/category.md

#### WordsFieldNames.Category field

The category field name.

```csharp
public const string Category;
```

### Comments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/comments.md

#### WordsFieldNames.Comments field

The comments field name.

```csharp
public const string Comments;
```

### Company
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/company.md

#### WordsFieldNames.Company field

The company field name.

```csharp
public const string Company;
```

### ContentStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/contentstatus.md

#### WordsFieldNames.ContentStatus field

The content status field name.

```csharp
public const string ContentStatus;
```

### CreatedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/createdtime.md

#### WordsFieldNames.CreatedTime field

The created time field name.

```csharp
public const string CreatedTime;
```

### HyperlinkBase
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/hyperlinkbase.md

#### WordsFieldNames.HyperlinkBase field

The hyperlink base field name.

```csharp
public const string HyperlinkBase;
```

### Keywords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/keywords.md

#### WordsFieldNames.Keywords field

The keywords field name.

```csharp
public const string Keywords;
```

### LastAuthor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/lastauthor.md

#### WordsFieldNames.LastAuthor field

The last author field name.

```csharp
public const string LastAuthor;
```

### LastPrintedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/lastprintedtime.md

#### WordsFieldNames.LastPrintedTime field

The last printed time field name.

```csharp
public const string LastPrintedTime;
```

### LastSavedTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/lastsavedtime.md

#### WordsFieldNames.LastSavedTime field

The last saved time field name.

```csharp
public const string LastSavedTime;
```

### Manager
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/manager.md

#### WordsFieldNames.Manager field

The manager field name.

```csharp
public const string Manager;
```

### RevisionNumber
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/revisionnumber.md

#### WordsFieldNames.RevisionNumber field

The revision number field name.

```csharp
public const string RevisionNumber;
```

### Subject
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/subject.md

#### WordsFieldNames.Subject field

The subject field name.

```csharp
public const string Subject;
```

### Template
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/template.md

#### WordsFieldNames.Template field

The template field name.

```csharp
public const string Template;
```

### Title
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/title.md

#### WordsFieldNames.Title field

The title field name.

```csharp
public const string Title;
```

### TotalEditingTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.options/wordsfieldnames/totaleditingtime.md

#### WordsFieldNames.TotalEditingTime field

The total editing time field name.

```csharp
public const string TotalEditingTime;
```

### GroupDocs.Search.Results
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results.md

The namespace provides search result classes.

#### Classes

| Class | Description |
| --- | --- |
| DeleteResult | Represents the result of the operation to delete indexed files or folders from an index. |
| DocumentInfo | Represents a descriptor for an indexed document. |
| FileType | Represents the file type. |
| FormatFamily | Specifies a format family that unites several similar formats. |
| FoundDocument | Represents a found document. |
| FoundDocumentField | Represents a found document field. |
| FoundImageFrame | Represents a found image frame. |
| ImageSearchResult | Represents the result of a reverse image search. |
| PathDeleteResult | Represents the result of the operation to delete an indexed file or folder from an index. |
| SearchResult | Represents a search result matching a search query. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### DeleteResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult.md

#### DeleteResult class

Represents the result of the operation to delete indexed files or folders from an index.

```csharp
public class DeleteResult
```

#### Properties

| Name | Description |
| --- | --- |
| Errors { get; } | Returns descriptions of deletion errors. |
| FailedCount { get; } | Returns the number of paths not deleted due to errors. |
| ItemResults { get; } | Returns the result of deleting each path. |
| SuccessCount { get; } | Returns the number of successfully deleted paths. |
| TotalCount { get; } | Returns the total number of paths to delete. |

### Errors
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult/errors.md

#### DeleteResult.Errors property

Returns descriptions of deletion errors.

```csharp
public string[] Errors { get; }
```

##### Property Value

Descriptions of deletion errors.

### FailedCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult/failedcount.md

#### DeleteResult.FailedCount property

Returns the number of paths not deleted due to errors.

```csharp
public int FailedCount { get; }
```

##### Property Value

The number of paths not deleted due to errors.

### ItemResults
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult/itemresults.md

#### DeleteResult.ItemResults property

Returns the result of deleting each path.

```csharp
public PathDeleteResult[] ItemResults { get; }
```

##### Property Value

The result of deleting each path.

### SuccessCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult/successcount.md

#### DeleteResult.SuccessCount property

Returns the number of successfully deleted paths.

```csharp
public int SuccessCount { get; }
```

##### Property Value

The number of successfully deleted paths.

### TotalCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/deleteresult/totalcount.md

#### DeleteResult.TotalCount property

Returns the total number of paths to delete.

```csharp
public int TotalCount { get; }
```

##### Property Value

The total number of paths to delete.

### DocumentInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo.md

#### DocumentInfo class

Represents a descriptor for an indexed document.

```csharp
public class DocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentSourceKind { get; } | Gets the document source kind. |
| FilePath { get; } | Gets the file path for indexed from file or the document key for indexed from stream or structure. |
| FileType { get; } | Gets the file type. |
| FormatFamily { get; } | Gets the document format family. |
| IndexedWithError { get; } | Gets the indicator of indexing error. |
| InnerPath { get; } | Gets the inner path for the container document item. |
| InnerPathParts { get; } | Gets the inner path parts for the container document item. |
| ModificationTime { get; } | Gets the modification time. |

#### Methods

| Name | Description |
| --- | --- |
| static Deserialize(byte[]) | Deserializes an instance from a byte array. |
| Serialize() | Serializes the current instance to a byte array. |
| override ToString() | Returns a String that represents the current `DocumentInfo`. |

### Deserialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/deserialize.md

#### DocumentInfo.Deserialize method

Deserializes an instance from a byte array.

```csharp
public static DocumentInfo Deserialize(byte[] array)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Byte[] | A byte array to deserialize from. |

##### Return Value

An instance deserialized from a byte array.

### DocumentSourceKind
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/documentsourcekind.md

#### DocumentInfo.DocumentSourceKind property

Gets the document source kind.

```csharp
public DocumentSourceKind DocumentSourceKind { get; }
```

##### Property Value

The document source kind.

### FilePath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/filepath.md

#### DocumentInfo.FilePath property

Gets the file path for indexed from file or the document key for indexed from stream or structure.

```csharp
public string FilePath { get; }
```

##### Property Value

The file path or document key.

### FileType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/filetype.md

#### DocumentInfo.FileType property

Gets the file type.

```csharp
public FileType FileType { get; }
```

##### Property Value

The file type.

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/formatfamily.md

#### DocumentInfo.FormatFamily property

Gets the document format family.

```csharp
public FormatFamily FormatFamily { get; }
```

##### Property Value

The document format family.

### IndexedWithError
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/indexedwitherror.md

#### DocumentInfo.IndexedWithError property

Gets the indicator of indexing error.

```csharp
public bool IndexedWithError { get; }
```

##### Property Value

The indicator of indexing error.

### InnerPath
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/innerpath.md

#### DocumentInfo.InnerPath property

Gets the inner path for the container document item.

```csharp
public string InnerPath { get; }
```

##### Property Value

The inner path.

### InnerPathParts
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/innerpathparts.md

#### DocumentInfo.InnerPathParts property

Gets the inner path parts for the container document item.

```csharp
public string[] InnerPathParts { get; }
```

##### Property Value

The inner path parts.

### ModificationTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/modificationtime.md

#### DocumentInfo.ModificationTime property

Gets the modification time.

```csharp
public DateTime ModificationTime { get; }
```

##### Property Value

The modification time.

### Serialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/serialize.md

#### DocumentInfo.Serialize method

Serializes the current instance to a byte array.

```csharp
public byte[] Serialize()
```

##### Return Value

A byte array representing the current instance.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/documentinfo/tostring.md

#### DocumentInfo.ToString method

Returns a String that represents the current `DocumentInfo`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `DocumentInfo`.

### FileType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype.md

#### FileType class

Represents the file type.

```csharp
public class FileType
```

#### Properties

| Name | Description |
| --- | --- |
| Description { get; } | Gets the file type description. |
| Extension { get; } | Gets the file extension. |
| FormatFamily { get; } | Gets the format family. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `FileType`. |
| static GetSupportedFileTypes() | Retrieves supported file types. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly ASF | The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/wmv/). |
| static readonly AVI | The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/avi/). |
| static readonly BMP | Files having extension .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 CHM | The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. Learn more about this file format [here](https://wiki.fileformat.com/web/chm/). |
| 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 DC3 | Represents DC3 file type. |
| 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 DIC | Represents DIC file type. |
| static readonly DICOM | Represents DICOM file type. |
| static readonly DJV | 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 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 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 EMF | Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/). |
| static readonly EML | EML file format represents email messages saved using Outlook and other relevant applications. 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 EPUB | Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/). |
| static readonly FB2 | Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. It is based on XML format and contains special tags for describing each element of the book. Learn more about this file format [here](https://wiki.fileformat.com/ebook/fb2/). |
| static readonly FLV | Represents FLV file type. |
| static readonly GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| static readonly HTM | Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/htm/). |
| static readonly HTML | HTML (Hyper Text Markup Language) is the extension for web pages created for display in web browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html/). |
| static readonly JP2 | JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPE | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPEG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly MD | Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md/). |
| static readonly MHT | Files with MHT extension represent a web page archive format that can be created by a number of different applications. 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. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/). |
| static readonly MOV | MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/). |
| 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://wiki.fileformat.com/audio/mp3/). |
| static readonly MPP | MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp/). |
| 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 ODP | Files with ODP extension represent presentation file format used by OpenOffice.org in the OASIS Open standard. Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp/). |
| static readonly ODS | Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/). |
| static readonly ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |
| static readonly ONE | File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/). |
| 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 OTS | Represents OpenDocument Spreadsheet Template file format. Learn more about spreadsheet file formats [here](https://wiki.fileformat.com/spreadsheet/). |
| static readonly OTT | Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. These are created with word processor applications such as free OpenOffice Writer and can hold settings that can be used to generate new documents from these template files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/ott/). |
| 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/). |
| static readonly PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| static readonly POT | Files with .POT extension represent Microsoft PowerPoint template files in binary format 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/). |
| 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 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 QT | MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/). |
| 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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/). |
| static readonly TIF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly TIFF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly TORRENT | Represents TORRENT file type. |
| 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 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/). |
| static readonly Unknown | Represents unknown file type. |
| 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 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 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://wiki.fileformat.com/audio/wav/). |
| 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 XHTML | The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0. Learn more about this file format [here](https://wiki.fileformat.com/web/xhtml/). |
| static readonly XLA | Represents XLA file type. |
| static readonly XLAM | Represents XLAM file type. |
| static readonly XLS | Files with XLS extension represent 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/specification/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/specification/spreadsheet/xlsb/). |
| static readonly XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/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/specification/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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/). |
| static readonly XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/). |
| static readonly XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/). |
| 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/). |
| static readonly ZIP | ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/). |

### ASF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/asf.md

#### FileType.ASF field

The Advanced Systems Format (ASF) is a digital multimedia container designed primarily for storing and transmitting media streams. Microsoft Windows Media Video (WMV) is the compressed video format and Microsoft Windows Media Audio (WMA) is the compressed audio format along with additional metadata in the ASF container developed by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/wmv/).

```csharp
public static readonly FileType ASF;
```

### AVI
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/avi.md

#### FileType.AVI field

The AVI file format is an Audio Video multimedia container file format that was introduced by Microsoft. Learn more about this file format [here](https://wiki.fileformat.com/video/avi/).

```csharp
public static readonly FileType AVI;
```

### BMP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/bmp.md

#### FileType.BMP field

Files having extension .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 FileType BMP;
```

### CHM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/chm.md

#### FileType.CHM field

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. Learn more about this file format [here](https://wiki.fileformat.com/web/chm/).

```csharp
public static readonly FileType CHM;
```

### CSV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/csv.md

#### FileType.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 FileType CSV;
```

### DC3
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dc3.md

#### FileType.DC3 field

Represents DC3 file type.

```csharp
public static readonly FileType DC3;
```

### DCM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dcm.md

#### FileType.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 FileType DCM;
```

### Description
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/description.md

#### FileType.Description property

Gets the file type description.

```csharp
public string Description { get; }
```

##### Property Value

The file type description.

### DIC
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dic.md

#### FileType.DIC field

Represents DIC file type.

```csharp
public static readonly FileType DIC;
```

### DICOM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dicom.md

#### FileType.DICOM field

Represents DICOM file type.

```csharp
public static readonly FileType DICOM;
```

### DJV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/djv.md

#### FileType.DJV 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 FileType DJV;
```

### DJVU
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/djvu.md

#### FileType.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 FileType DJVU;
```

### DOC
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/doc.md

#### FileType.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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/docm.md

#### FileType.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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/docx.md

#### FileType.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dot.md

#### FileType.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 FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dotm.md

#### FileType.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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/dotx.md

#### FileType.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 FileType DOTX;
```

### EMF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/emf.md

#### FileType.EMF field

Enhanced metafile format (EMF) stores graphical images device-independently. Learn more about this file format [here](https://wiki.fileformat.com/image/emf/).

```csharp
public static readonly FileType EMF;
```

### EML
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/eml.md

#### FileType.EML field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).

```csharp
public static readonly FileType EML;
```

### EMLX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/emlx.md

#### FileType.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 FileType EMLX;
```

### EPUB
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/epub.md

#### FileType.EPUB field

Files with .EPUB extension are an e-book file format that provide a standard digital publication format for publishers and consumers. Learn more about this file format [here](https://wiki.fileformat.com/ebook/epub/).

```csharp
public static readonly FileType EPUB;
```

### Extension
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/extension.md

#### FileType.Extension property

Gets the file extension.

```csharp
public string Extension { get; }
```

##### Property Value

The file extension.

### FB2
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/fb2.md

#### FileType.FB2 field

Files with FB2 extension are FictionBook 2.0 eBook files that contains the structure of the eBook. It is based on XML format and contains special tags for describing each element of the book. Learn more about this file format [here](https://wiki.fileformat.com/ebook/fb2/).

```csharp
public static readonly FileType FB2;
```

### FLV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/flv.md

#### FileType.FLV field

Represents FLV file type.

```csharp
public static readonly FileType FLV;
```

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/formatfamily.md

#### FileType.FormatFamily property

Gets the format family.

```csharp
public FormatFamily FormatFamily { get; }
```

##### Property Value

The format family.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types.

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

A collection of supported file types.

### GIF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/gif.md

#### FileType.GIF field

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).

```csharp
public static readonly FileType GIF;
```

### HTM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/htm.md

#### FileType.HTM field

Files with HTM extension represent Hypertext Markup Language for creating web pages for display in web browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/htm/).

```csharp
public static readonly FileType HTM;
```

### HTML
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/html.md

#### FileType.HTML field

HTML (Hyper Text Markup Language) is the extension for web pages created for display in web browsers. Learn more about this file format [here](https://wiki.fileformat.com/web/html/).

```csharp
public static readonly FileType HTML;
```

### JP2
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/jp2.md

#### FileType.JP2 field

JPEG 2000 (JP2) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JP2;
```

### JPE
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/jpe.md

#### FileType.JPE field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPE;
```

### JPEG
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/jpeg.md

#### FileType.JPEG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPEG;
```

### JPG
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/jpg.md

#### FileType.JPG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPG;
```

### MD
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/md.md

#### FileType.MD field

Text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/md/).

```csharp
public static readonly FileType MD;
```

### MHT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/mht.md

#### FileType.MHT field

Files with MHT extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/).

```csharp
public static readonly FileType MHT;
```

### MHTML
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/mhtml.md

#### FileType.MHTML field

Files with MHTML extension represent a web page archive format that can be created by a number of different applications. Learn more about this file format [here](https://wiki.fileformat.com/web/mhtml/).

```csharp
public static readonly FileType MHTML;
```

### MOV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/mov.md

#### FileType.MOV field

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).

```csharp
public static readonly FileType MOV;
```

### MP3
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/mp3.md

#### FileType.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://wiki.fileformat.com/audio/mp3/).

```csharp
public static readonly FileType MP3;
```

### MPP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/mpp.md

#### FileType.MPP field

MPP is proprietary file format developed by Microsoft as file format for Microsoft Project (MSP) which is a project management application software. Learn more about this file format [here](https://wiki.fileformat.com/project-management/mpp/).

```csharp
public static readonly FileType MPP;
```

### MSG
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/msg.md

#### FileType.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 FileType MSG;
```

### ODP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/odp.md

#### FileType.ODP field

Files with ODP extension represent presentation file format used by OpenOffice.org in the OASIS Open standard. Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp/).

```csharp
public static readonly FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ods.md

#### FileType.ODS field

Files with ODS extension stand for OpenDocument Spreadsheet Document format that are editable by user. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods/).

```csharp
public static readonly FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/odt.md

#### FileType.ODT field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/).

```csharp
public static readonly FileType ODT;
```

### ONE
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/one.md

#### FileType.ONE field

File represented by .ONE extension are created by Microsoft OneNote application. Learn more about this file format [here](https://wiki.fileformat.com/note-taking/one/).

```csharp
public static readonly FileType ONE;
```

### OST
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ost.md

#### FileType.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 FileType OST;
```

### OTS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ots.md

#### FileType.OTS field

Represents OpenDocument Spreadsheet Template file format. Learn more about spreadsheet file formats [here](https://wiki.fileformat.com/spreadsheet/).

```csharp
public static readonly FileType OTS;
```

### OTT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ott.md

#### FileType.OTT field

Files with OTT extension represent template documents generated by applications in compliance with the OASIS' OpenDocument standard format. These are created with word processor applications such as free OpenOffice Writer and can hold settings that can be used to generate new documents from these template files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/ott/).

```csharp
public static readonly FileType OTT;
```

### PDF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pdf.md

#### FileType.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 FileType PDF;
```

### PNG
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/png.md

#### FileType.PNG field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/).

```csharp
public static readonly FileType PNG;
```

### POT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pot.md

#### FileType.POT field

Files with .POT extension represent Microsoft PowerPoint template files in binary format created by PowerPoint 97-2003 versions. Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot/).

```csharp
public static readonly FileType POT;
```

### POTM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/potm.md

#### FileType.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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/potx.md

#### FileType.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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pps.md

#### FileType.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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ppsm.md

#### FileType.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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ppsx.md

#### FileType.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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/ppt.md

#### FileType.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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pptm.md

#### FileType.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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pptx.md

#### FileType.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 FileType PPTX;
```

### PSD
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/psd.md

#### FileType.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 FileType PSD;
```

### PST
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/pst.md

#### FileType.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 FileType PST;
```

### QT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/qt.md

#### FileType.QT field

MOV or QuickTime File format is 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://wiki.fileformat.com/video/mov/).

```csharp
public static readonly FileType QT;
```

### RTF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/rtf.md

#### FileType.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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/).

```csharp
public static readonly FileType RTF;
```

### TIF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/tif.md

#### FileType.TIF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/tiff.md

#### FileType.TIFF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIFF;
```

### TORRENT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/torrent.md

#### FileType.TORRENT field

Represents TORRENT file type.

```csharp
public static readonly FileType TORRENT;
```

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/tostring.md

#### FileType.ToString method

Returns a String that represents the current `FileType`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `FileType`.

### TSV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/tsv.md

#### FileType.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 FileType TSV;
```

### TXT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/txt.md

#### FileType.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 FileType TXT;
```

### Unknown
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VSD
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/vsd.md

#### FileType.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 FileType VSD;
```

### VSS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/vss.md

#### FileType.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 FileType VSS;
```

### WAV
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/wav.md

#### FileType.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://wiki.fileformat.com/audio/wav/).

```csharp
public static readonly FileType WAV;
```

### WEBP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/webp.md

#### FileType.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 FileType WEBP;
```

### WMF
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/wmf.md

#### FileType.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 FileType WMF;
```

### XHTML
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xhtml.md

#### FileType.XHTML field

The XHTML is a text based file format with markup in the XML, using a reformulation of HTML 4.0. Learn more about this file format [here](https://wiki.fileformat.com/web/xhtml/).

```csharp
public static readonly FileType XHTML;
```

### XLA
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xla.md

#### FileType.XLA field

Represents XLA file type.

```csharp
public static readonly FileType XLA;
```

### XLAM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xlam.md

#### FileType.XLAM field

Represents XLAM file type.

```csharp
public static readonly FileType XLAM;
```

### XLS
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xls.md

#### FileType.XLS field

Files with XLS extension represent 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/specification/spreadsheet/xls/).

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xlsb.md

#### FileType.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/specification/spreadsheet/xlsb/).

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xlsm.md

#### FileType.XLSM field

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xlsx.md

#### FileType.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/specification/spreadsheet/xlsx/).

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xlt.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xltm.md

#### FileType.XLTM field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).

```csharp
public static readonly FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xltx.md

#### FileType.XLTX field

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).

```csharp
public static readonly FileType XLTX;
```

### XML
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/xml.md

#### FileType.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 FileType XML;
```

### ZIP
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/filetype/zip.md

#### FileType.ZIP field

ZIP file extension represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip/).

```csharp
public static readonly FileType ZIP;
```

### FormatFamily
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily.md

#### FormatFamily class

Specifies a format family that unites several similar formats.

```csharp
public class FormatFamily
```

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Gets the format family name. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `FormatFamily`. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Archive | Represents archive formats. |
| static readonly Audio | Represents audio formats. |
| static readonly Cad | Represents computer-aided design formats. |
| static readonly Calendar | Represents calendar formats. |
| static readonly Database | Represents database formats. |
| static readonly Diagram | Represents diagram formats. |
| static readonly Ebook | Represents electronic book formats. |
| static readonly Email | Represents electronic mail formats. |
| static readonly Executable | Represents executable formats. |
| static readonly Font | Represents font formats. |
| static readonly Image | Represents image formats. |
| static readonly Markup | Represents markup formats. |
| static readonly Medicine | Represents medicine formats. |
| static readonly Note | Represents note formats. |
| static readonly Pdf | Represents portable document formats. |
| static readonly Presentation | Represents presentation formats. |
| static readonly ProjectManagement | Represents project management formats. |
| static readonly ScientificFormat | Represents scientific formats. |
| static readonly SourceCode | Represents source code formats. |
| static readonly Spreadsheet | Represents spreadsheet formats. |
| static readonly Torrent | Represents torrent formats. |
| static readonly Unknown | Represents unknown format family. |
| static readonly Video | Represents video formats. |
| static readonly WordProcessing | Represents word processing formats. |

### Archive
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/archive.md

#### FormatFamily.Archive field

Represents archive formats.

```csharp
public static readonly FormatFamily Archive;
```

### Audio
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/audio.md

#### FormatFamily.Audio field

Represents audio formats.

```csharp
public static readonly FormatFamily Audio;
```

### Cad
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/cad.md

#### FormatFamily.Cad field

Represents computer-aided design formats.

```csharp
public static readonly FormatFamily Cad;
```

### Calendar
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/calendar.md

#### FormatFamily.Calendar field

Represents calendar formats.

```csharp
public static readonly FormatFamily Calendar;
```

### Database
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/database.md

#### FormatFamily.Database field

Represents database formats.

```csharp
public static readonly FormatFamily Database;
```

### Diagram
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/diagram.md

#### FormatFamily.Diagram field

Represents diagram formats.

```csharp
public static readonly FormatFamily Diagram;
```

### Ebook
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/ebook.md

#### FormatFamily.Ebook field

Represents electronic book formats.

```csharp
public static readonly FormatFamily Ebook;
```

### Email
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/email.md

#### FormatFamily.Email field

Represents electronic mail formats.

```csharp
public static readonly FormatFamily Email;
```

### Executable
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/executable.md

#### FormatFamily.Executable field

Represents executable formats.

```csharp
public static readonly FormatFamily Executable;
```

### Font
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/font.md

#### FormatFamily.Font field

Represents font formats.

```csharp
public static readonly FormatFamily Font;
```

### Image
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/image.md

#### FormatFamily.Image field

Represents image formats.

```csharp
public static readonly FormatFamily Image;
```

### Markup
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/markup.md

#### FormatFamily.Markup field

Represents markup formats.

```csharp
public static readonly FormatFamily Markup;
```

### Medicine
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/medicine.md

#### FormatFamily.Medicine field

Represents medicine formats.

```csharp
public static readonly FormatFamily Medicine;
```

### Name
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/name.md

#### FormatFamily.Name property

Gets the format family name.

```csharp
public string Name { get; }
```

##### Property Value

The format family name.

### Note
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/note.md

#### FormatFamily.Note field

Represents note formats.

```csharp
public static readonly FormatFamily Note;
```

### Pdf
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/pdf.md

#### FormatFamily.Pdf field

Represents portable document formats.

```csharp
public static readonly FormatFamily Pdf;
```

### Presentation
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/presentation.md

#### FormatFamily.Presentation field

Represents presentation formats.

```csharp
public static readonly FormatFamily Presentation;
```

### ProjectManagement
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/projectmanagement.md

#### FormatFamily.ProjectManagement field

Represents project management formats.

```csharp
public static readonly FormatFamily ProjectManagement;
```

### ScientificFormat
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/scientificformat.md

#### FormatFamily.ScientificFormat field

Represents scientific formats.

```csharp
public static readonly FormatFamily ScientificFormat;
```

### SourceCode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/sourcecode.md

#### FormatFamily.SourceCode field

Represents source code formats.

```csharp
public static readonly FormatFamily SourceCode;
```

### Spreadsheet
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/spreadsheet.md

#### FormatFamily.Spreadsheet field

Represents spreadsheet formats.

```csharp
public static readonly FormatFamily Spreadsheet;
```

### Torrent
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/torrent.md

#### FormatFamily.Torrent field

Represents torrent formats.

```csharp
public static readonly FormatFamily Torrent;
```

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/tostring.md

#### FormatFamily.ToString method

Returns a String that represents the current `FormatFamily`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `FormatFamily`.

### Unknown
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/unknown.md

#### FormatFamily.Unknown field

Represents unknown format family.

```csharp
public static readonly FormatFamily Unknown;
```

### Video
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/video.md

#### FormatFamily.Video field

Represents video formats.

```csharp
public static readonly FormatFamily Video;
```

### WordProcessing
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/formatfamily/wordprocessing.md

#### FormatFamily.WordProcessing field

Represents word processing formats.

```csharp
public static readonly FormatFamily WordProcessing;
```

### FoundDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument.md

#### FoundDocument class

Represents a found document.

```csharp
public class FoundDocument
```

#### Properties

| Name | Description |
| --- | --- |
| Attributes { get; } | Gets the attributes associated with the found document. The corresponding option must be enabled in the search options to retrieve attributes. |
| DocumentInfo { get; } | Gets the document info. |
| FoundFields { get; } | Gets the document fields found. |
| OccurrenceCount { get; } | Gets the number of occurrences found. |
| Relevance { get; } | Gets the relevance of search result. |
| Terms { get; } | Gets the terms found. The value is evaluated each time the property is accessed. |
| TermSequences { get; } | Gets the term sequences found. |

#### Methods

| Name | Description |
| --- | --- |
| static Deserialize(byte[]) | Deserializes an instance from a byte array. |
| Serialize() | Serializes the current instance to a byte array. |
| override ToString() | Returns string representation of the found document. |

### Attributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/attributes.md

#### FoundDocument.Attributes property

Gets the attributes associated with the found document. The corresponding option must be enabled in the search options to retrieve attributes.

```csharp
public string[] Attributes { get; }
```

##### Property Value

The attributes associated with the found document.

### Deserialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/deserialize.md

#### FoundDocument.Deserialize method

Deserializes an instance from a byte array.

```csharp
public static FoundDocument Deserialize(byte[] array)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Byte[] | A byte array to deserialize from. |

##### Return Value

An instance deserialized from a byte array.

### DocumentInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/documentinfo.md

#### FoundDocument.DocumentInfo property

Gets the document info.

```csharp
public DocumentInfo DocumentInfo { get; }
```

##### Property Value

The document info.

### FoundFields
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/foundfields.md

#### FoundDocument.FoundFields property

Gets the document fields found.

```csharp
public FoundDocumentField[] FoundFields { get; }
```

##### Property Value

The document fields found.

### OccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/occurrencecount.md

#### FoundDocument.OccurrenceCount property

Gets the number of occurrences found.

```csharp
public int OccurrenceCount { get; }
```

##### Property Value

The number of occurrences found.

### Relevance
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/relevance.md

#### FoundDocument.Relevance property

Gets the relevance of search result.

```csharp
public double Relevance { get; }
```

##### Property Value

The relevance of search result.

### Serialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/serialize.md

#### FoundDocument.Serialize method

Serializes the current instance to a byte array.

```csharp
public byte[] Serialize()
```

##### Return Value

A byte array representing the current instance.

### Terms
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/terms.md

#### FoundDocument.Terms property

Gets the terms found. The value is evaluated each time the property is accessed.

```csharp
public string[] Terms { get; }
```

##### Property Value

The terms found.

### TermSequences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/termsequences.md

#### FoundDocument.TermSequences property

Gets the term sequences found.

```csharp
public string[][] TermSequences { get; }
```

##### Property Value

The term sequences found.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocument/tostring.md

#### FoundDocument.ToString method

Returns string representation of the found document.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the found document.

### FoundDocumentField
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield.md

#### FoundDocumentField class

Represents a found document field.

```csharp
public class FoundDocumentField
```

#### Properties

| Name | Description |
| --- | --- |
| FieldName { get; } | Gets the field name. |
| OccurrenceCount { get; } | Gets the number of occurrences found. |
| Terms { get; } | Gets the terms found. |
| TermSequences { get; } | Gets the term sequences found. |
| TermSequencesOccurrences { get; } | Gets the occurrences of the found term sequences. |
| TermsOccurrences { get; } | Gets the occurrences of the found terms. |

#### Methods

| Name | Description |
| --- | --- |
| static Deserialize(byte[]) | Deserializes an instance from a byte array. |
| Serialize() | Serializes the current instance to a byte array. |
| override ToString() | Returns string representation of the found document field. |

### Deserialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/deserialize.md

#### FoundDocumentField.Deserialize method

Deserializes an instance from a byte array.

```csharp
public static FoundDocumentField Deserialize(byte[] array)
```

| Parameter | Type | Description |
| --- | --- | --- |
| array | Byte[] | A byte array to deserialize from. |

##### Return Value

An instance deserialized from a byte array.

### FieldName
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/fieldname.md

#### FoundDocumentField.FieldName property

Gets the field name.

```csharp
public string FieldName { get; }
```

##### Property Value

The field name.

### OccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/occurrencecount.md

#### FoundDocumentField.OccurrenceCount property

Gets the number of occurrences found.

```csharp
public int OccurrenceCount { get; }
```

##### Property Value

The number of occurrences found.

### Serialize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/serialize.md

#### FoundDocumentField.Serialize method

Serializes the current instance to a byte array.

```csharp
public byte[] Serialize()
```

##### Return Value

A byte array representing the current instance.

### Terms
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/terms.md

#### FoundDocumentField.Terms property

Gets the terms found.

```csharp
public string[] Terms { get; }
```

##### Property Value

The terms found.

### TermSequences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/termsequences.md

#### FoundDocumentField.TermSequences property

Gets the term sequences found.

```csharp
public string[][] TermSequences { get; }
```

##### Property Value

The term sequences found.

### TermSequencesOccurrences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/termsequencesoccurrences.md

#### FoundDocumentField.TermSequencesOccurrences property

Gets the occurrences of the found term sequences.

```csharp
public int[] TermSequencesOccurrences { get; }
```

##### Property Value

The occurrences of the found term sequences.

### TermsOccurrences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/termsoccurrences.md

#### FoundDocumentField.TermsOccurrences property

Gets the occurrences of the found terms.

```csharp
public int[] TermsOccurrences { get; }
```

##### Property Value

The occurrences of the found terms.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/founddocumentfield/tostring.md

#### FoundDocumentField.ToString method

Returns string representation of the found document field.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the found document field.

### FoundImageFrame
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe.md

#### FoundImageFrame class

Represents a found image frame.

```csharp
public class FoundImageFrame
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentInfo { get; } | Gets the document info. |
| FrameIndex { get; } | Gets the index of the frame in the image. |
| HashDifferences { get; } | Gets the number of mismatched bits in the image hash. |
| ImageIndex { get; } | Gets the ordinal number of the image in the document. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a String that represents the current `FoundImageFrame`. |

### DocumentInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe/documentinfo.md

#### FoundImageFrame.DocumentInfo property

Gets the document info.

```csharp
public DocumentInfo DocumentInfo { get; }
```

##### Property Value

The document info.

### FrameIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe/frameindex.md

#### FoundImageFrame.FrameIndex property

Gets the index of the frame in the image.

```csharp
public int FrameIndex { get; }
```

##### Property Value

The index of the frame in the image.

### HashDifferences
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe/hashdifferences.md

#### FoundImageFrame.HashDifferences property

Gets the number of mismatched bits in the image hash.

```csharp
public int HashDifferences { get; }
```

##### Property Value

The number of mismatched bits in the image hash.

### ImageIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe/imageindex.md

#### FoundImageFrame.ImageIndex property

Gets the ordinal number of the image in the document.

```csharp
public int ImageIndex { get; }
```

##### Property Value

The ordinal number of the image in the document.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/foundimageframe/tostring.md

#### FoundImageFrame.ToString method

Returns a String that represents the current `FoundImageFrame`.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the current `FoundImageFrame`.

### ImageSearchResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/imagesearchresult.md

#### ImageSearchResult class

Represents the result of a reverse image search.

```csharp
public class ImageSearchResult
```

#### Properties

| Name | Description |
| --- | --- |
| ImageCount { get; } | Gets the number of images found. |

#### Methods

| Name | Description |
| --- | --- |
| GetFoundImage(int) | Gets the found image by index. |

### GetFoundImage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/imagesearchresult/getfoundimage.md

#### ImageSearchResult.GetFoundImage method

Gets the found image by index.

```csharp
public FoundImageFrame GetFoundImage(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index of a found image. |

##### Return Value

The found image.

### ImageCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/imagesearchresult/imagecount.md

#### ImageSearchResult.ImageCount property

Gets the number of images found.

```csharp
public int ImageCount { get; }
```

##### Property Value

The number of images found.

### PathDeleteResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/pathdeleteresult.md

#### PathDeleteResult class

Represents the result of the operation to delete an indexed file or folder from an index.

```csharp
public class PathDeleteResult
```

#### Properties

| Name | Description |
| --- | --- |
| Error { get; } | Returns a description of deletion error. |
| IsSuccess { get; } | Returns the success indicator of the delete operation. |
| Path { get; } | Returns the path to the file or folder to delete. |

### Error
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/pathdeleteresult/error.md

#### PathDeleteResult.Error property

Returns a description of deletion error.

```csharp
public string Error { get; }
```

##### Property Value

A description of deletion error.

### IsSuccess
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/pathdeleteresult/issuccess.md

#### PathDeleteResult.IsSuccess property

Returns the success indicator of the delete operation.

```csharp
public bool IsSuccess { get; }
```

##### Property Value

`true` if the delete operation was successful; otherwise, returns `false`.

### Path
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/pathdeleteresult/path.md

#### PathDeleteResult.Path property

Returns the path to the file or folder to delete.

```csharp
public string Path { get; }
```

##### Property Value

The path to the file or folder to delete.

### SearchResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult.md

#### SearchResult class

Represents a search result matching a search query.

```csharp
public class SearchResult : IEnumerable<FoundDocument>
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentCount { get; } | Gets the number of documents found. |
| EndTime { get; } | Gets the end time of the search. |
| NextChunkSearchToken { get; } | Gets a chunk search token for searching the next chunk. |
| OccurrenceCount { get; } | Gets the total number of occurrences found. |
| SearchDuration { get; } | Gets the search duration. |
| StartTime { get; } | Gets the start time of the search. |
| Truncated { get; } | Gets a value indicating that the result is truncated. |
| Warnings { get; } | Gets a warnings describing the result. |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns an enumerator that iterates through the collection of the documents found. |
| GetFoundDocument(int) | Gets the found document by index. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentFolder);

// Setting search options
SearchOptions options = new SearchOptions();
options.FuzzySearch.Enabled = true; // Enabling the fuzzy search
options.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(3); // Setting the maximum number of differences to 3

// Search for documents containing the word 'Einstein' or the phrase 'Theory of Relativity'
SearchResult result = index.Search("Einstein OR \"Theory of Relativity\"", options);

// Printing the result
Console.WriteLine("Documents: " + result.DocumentCount);
Console.WriteLine("Total occurrences: " + result.OccurrenceCount);
for (int i = 0; i < result.DocumentCount; i++)
{
    FoundDocument document = result.GetFoundDocument(i);
    Console.WriteLine("\tDocument: " + document.DocumentInfo.FilePath);
    Console.WriteLine("\tOccurrences: " + document.OccurrenceCount);
    for (int j = 0; j < document.FoundFields.Length; j++)
    {
        FoundDocumentField field = document.FoundFields[j];
        Console.WriteLine("\t\tField: " + field.FieldName);
        Console.WriteLine("\t\tOccurrences: " + document.OccurrenceCount);
        // Printing found terms
        if (field.Terms != null)
        {
            for (int k = 0; k < field.Terms.Length; k++)
            {
                Console.WriteLine("\t\t\t" + field.Terms[k].PadRight(20) + field.TermsOccurrences[k]);
            }
        }
        // Printing found phrases
        if (field.TermSequences != null)
        {
            for (int k = 0; k < field.TermSequences.Length; k++)
            {
                string sequence = string.Join(" ", field.TermSequences[k]);
                Console.WriteLine("\t\t\t" + sequence.PadRight(30) + field.TermSequencesOccurrences[k]);
            }
        }
    }
}
```

### DocumentCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/documentcount.md

#### SearchResult.DocumentCount property

Gets the number of documents found.

```csharp
public int DocumentCount { get; }
```

##### Property Value

The number of documents found.

### EndTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/endtime.md

#### SearchResult.EndTime property

Gets the end time of the search.

```csharp
public DateTime EndTime { get; }
```

##### Property Value

The end time of the search.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/getenumerator.md

#### SearchResult.GetEnumerator method

Returns an enumerator that iterates through the collection of the documents found.

```csharp
public IEnumerator<FoundDocument> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection of the found documents.

### GetFoundDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/getfounddocument.md

#### SearchResult.GetFoundDocument method

Gets the found document by index.

```csharp
public FoundDocument GetFoundDocument(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index of a found document. |

##### Return Value

The found document.

### NextChunkSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/nextchunksearchtoken.md

#### SearchResult.NextChunkSearchToken property

Gets a chunk search token for searching the next chunk.

```csharp
public ChunkSearchToken NextChunkSearchToken { get; }
```

##### Property Value

A chunk search token for searching the next chunk.

### OccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/occurrencecount.md

#### SearchResult.OccurrenceCount property

Gets the total number of occurrences found.

```csharp
public int OccurrenceCount { get; }
```

##### Property Value

The total number of occurrences found.

### SearchDuration
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/searchduration.md

#### SearchResult.SearchDuration property

Gets the search duration.

```csharp
public TimeSpan SearchDuration { get; }
```

##### Property Value

The search duration.

### StartTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/starttime.md

#### SearchResult.StartTime property

Gets the start time of the search.

```csharp
public DateTime StartTime { get; }
```

##### Property Value

The start time of the search.

### Truncated
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/truncated.md

#### SearchResult.Truncated property

Gets a value indicating that the result is truncated.

```csharp
public bool Truncated { get; }
```

##### Property Value

A value indicating that the result is truncated.

### Warnings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.results/searchresult/warnings.md

#### SearchResult.Warnings property

Gets a warnings describing the result.

```csharp
public string Warnings { get; }
```

##### Property Value

A warnings describing the result.

### GroupDocs.Search.Scaling.Configuring
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring.md

The namespace provides classes for configuring the search network.

#### Classes

| Class | Description |
| --- | --- |
| Configuration | Represents a search network configuration. |
| Configurator | Represents the search network configurator. |
| IndexSettingsConfigurator | Represents the index settings configurator for each shard in the search network. |
| MasterNodeConfigurator | Represents the master node configurator. |
| NodeConfigurator | Represents the search network node configurator. |
| SlaveNodeConfigurator | Represents the slave node configurator. |
| TcpSettings | Represents a TCP network settings. |
#### Interfaces

| Interface | Description |
| --- | --- |
| INetworkSettings | Represents a network settings. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### Configuration
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configuration.md

#### Configuration class

Represents a search network configuration.

```csharp
public class Configuration
```

#### Methods

| Name | Description |
| --- | --- |
| static Load(Stream) | Loads a search network configuration from a stream. |
| static Load(string) | Loads a search network configuration from a file. |
| Save(Stream) | Saves this configuration to a stream. |
| Save(string) | Saves this configuration to a file. |

### Load
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configuration/load.md

#### Load(string)

Loads a search network configuration from a file.

```csharp
public static Configuration Load(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file to load from. |

##### Return Value

The configuration.

#### Load(Stream)

Loads a search network configuration from a stream.

```csharp
public static Configuration Load(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream to load from. |

##### Return Value

The configuration.

### Save
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configuration/save.md

#### Save(string)

Saves this configuration to a file.

```csharp
public void Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file to save to. |

#### Save(Stream)

Saves this configuration to a stream.

```csharp
public void Save(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream to save to. |

### Configurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator.md

#### Configurator class

Represents the search network configurator.

```csharp
public class Configurator
```

#### Constructors

| Name | Description |
| --- | --- |
| Configurator() | Initializes a new instance of the `Configurator` class. |

#### Methods

| Name | Description |
| --- | --- |
| AddMasterNode(int) | Adds a node to the search network configuration. |
| AddSlaveNode(int) | Adds a node to the search network configuration. |
| CompleteConfiguration() | Completes the configuration process and returns an instance of the search network configuration. |
| SetIndexSettings() | Starts configuring the index settings for each shard in the search network. |

### AddMasterNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator/addmasternode.md

#### Configurator.AddMasterNode method

Adds a node to the search network configuration.

```csharp
public MasterNodeConfigurator AddMasterNode(int nodeIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |

##### Return Value

The node configurator.

### AddSlaveNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator/addslavenode.md

#### Configurator.AddSlaveNode method

Adds a node to the search network configuration.

```csharp
public SlaveNodeConfigurator AddSlaveNode(int nodeIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |

##### Return Value

The node configurator.

### CompleteConfiguration
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator/completeconfiguration.md

#### Configurator.CompleteConfiguration method

Completes the configuration process and returns an instance of the search network configuration.

```csharp
public Configuration CompleteConfiguration()
```

##### Return Value

The configuration.

### Configurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator/configurator.md

#### Configurator constructor

Initializes a new instance of the `Configurator` class.

```csharp
public Configurator()
```

### SetIndexSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/configurator/setindexsettings.md

#### Configurator.SetIndexSettings method

Starts configuring the index settings for each shard in the search network.

```csharp
public IndexSettingsConfigurator SetIndexSettings()
```

##### Return Value

The index settings configurator.

### IndexSettingsConfigurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator.md

#### IndexSettingsConfigurator class

Represents the index settings configurator for each shard in the search network.

```csharp
public class IndexSettingsConfigurator
```

#### Methods

| Name | Description |
| --- | --- |
| CompleteIndexSettings() | Completes the configuration of the index settings. |
| SetIndexType(IndexType) | Sets the index type. |
| SetSearchThreads(NumberOfThreads) | Sets the number of search threads. |
| SetTextStorageSettings(bool, Compression) | Sets the text storage settings. |
| SetUseCharacterReplacements(bool) | Sets the use character replacements flag. |
| SetUseStopWords(bool) | Sets the use stop words flag. |

### CompleteIndexSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/completeindexsettings.md

#### IndexSettingsConfigurator.CompleteIndexSettings method

Completes the configuration of the index settings.

```csharp
public Configurator CompleteIndexSettings()
```

##### Return Value

The configurator.

### SetIndexType
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/setindextype.md

#### IndexSettingsConfigurator.SetIndexType method

Sets the index type.

```csharp
public IndexSettingsConfigurator SetIndexType(IndexType indexType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexType | IndexType | The index type. |

##### Return Value

The index settings configurator.

### SetSearchThreads
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/setsearchthreads.md

#### IndexSettingsConfigurator.SetSearchThreads method

Sets the number of search threads.

```csharp
public IndexSettingsConfigurator SetSearchThreads(NumberOfThreads numberOfThreads)
```

| Parameter | Type | Description |
| --- | --- | --- |
| numberOfThreads | NumberOfThreads | The number of search threads. |

##### Return Value

The index settings configurator.

### SetTextStorageSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/settextstoragesettings.md

#### IndexSettingsConfigurator.SetTextStorageSettings method

Sets the text storage settings.

```csharp
public IndexSettingsConfigurator SetTextStorageSettings(bool isUsed, Compression compression)
```

| Parameter | Type | Description |
| --- | --- | --- |
| isUsed | Boolean | The flag of using the text storage in index. |
| compression | Compression | The compression level. |

##### Return Value

The index settings configurator.

### SetUseCharacterReplacements
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/setusecharacterreplacements.md

#### IndexSettingsConfigurator.SetUseCharacterReplacements method

Sets the use character replacements flag.

```csharp
public IndexSettingsConfigurator SetUseCharacterReplacements(bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Boolean | The flag value. |

##### Return Value

The index settings configurator.

### SetUseStopWords
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/indexsettingsconfigurator/setusestopwords.md

#### IndexSettingsConfigurator.SetUseStopWords method

Sets the use stop words flag.

```csharp
public IndexSettingsConfigurator SetUseStopWords(bool value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Boolean | The flag value. |

##### Return Value

The index settings configurator.

### INetworkSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/inetworksettings.md

#### INetworkSettings interface

Represents a network settings.

```csharp
public interface INetworkSettings
```

### MasterNodeConfigurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/masternodeconfigurator.md

#### MasterNodeConfigurator class

Represents the master node configurator.

```csharp
public class MasterNodeConfigurator : NodeConfigurator
```

#### Methods

| Name | Description |
| --- | --- |
| AddIndexer(string) | Adds an indexer service to the search network node. |
| AddSearcher(string) | Adds a searcher service to the search network node. |
| CompleteNode() | Completes the configuration of the search network node. |

### AddIndexer
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/masternodeconfigurator/addindexer.md

#### MasterNodeConfigurator.AddIndexer method

Adds an indexer service to the search network node.

```csharp
public MasterNodeConfigurator AddIndexer(string storagePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | String | The storage path of the adding service. |

##### Return Value

This search network node configurator.

### AddSearcher
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/masternodeconfigurator/addsearcher.md

#### MasterNodeConfigurator.AddSearcher method

Adds a searcher service to the search network node.

```csharp
public MasterNodeConfigurator AddSearcher(string storagePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | String | The storage path of the adding service. |

##### Return Value

This search network node configurator.

### NodeConfigurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/nodeconfigurator.md

#### NodeConfigurator class

Represents the search network node configurator.

```csharp
public abstract class NodeConfigurator
```

#### Methods

| Name | Description |
| --- | --- |
| CompleteNode() | Completes the configuration of the search network node. |

### CompleteNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/nodeconfigurator/completenode.md

#### NodeConfigurator.CompleteNode method

Completes the configuration of the search network node.

```csharp
public Configurator CompleteNode()
```

##### Return Value

The configurator.

### SlaveNodeConfigurator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/slavenodeconfigurator.md

#### SlaveNodeConfigurator class

Represents the slave node configurator.

```csharp
public class SlaveNodeConfigurator : NodeConfigurator
```

#### Methods

| Name | Description |
| --- | --- |
| AddExtractor(string) | Adds an extractor service to the search network node. |
| AddShard(string) | Adds a shard service to the search network node. |
| CompleteNode() | Completes the configuration of the search network node. |
| SetTcpEndpoint(string, int) | Sets the TCP endpoint. |

### AddExtractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/slavenodeconfigurator/addextractor.md

#### SlaveNodeConfigurator.AddExtractor method

Adds an extractor service to the search network node.

```csharp
public SlaveNodeConfigurator AddExtractor(string storagePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | String | The storage path of the adding service. |

##### Return Value

This search network node configurator.

### AddShard
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/slavenodeconfigurator/addshard.md

#### SlaveNodeConfigurator.AddShard method

Adds a shard service to the search network node.

```csharp
public SlaveNodeConfigurator AddShard(string storagePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storagePath | String | The storage path of the adding service. |

##### Return Value

This search network node configurator.

### SetTcpEndpoint
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/slavenodeconfigurator/settcpendpoint.md

#### SlaveNodeConfigurator.SetTcpEndpoint method

Sets the TCP endpoint.

```csharp
public SlaveNodeConfigurator SetTcpEndpoint(string hostNameOrAddress, int port)
```

| Parameter | Type | Description |
| --- | --- | --- |
| hostNameOrAddress | String | The host name or address. |
| port | Int32 | The port number. |

##### Return Value

This search network node configurator.

### TcpSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings.md

#### TcpSettings class

Represents a TCP network settings.

```csharp
public class TcpSettings : INetworkSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| TcpSettings(int, int, int, int, int) | Initializes a new instance of the `TcpSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| ConnectTimeout { get; } | Gets the connect timeout in milliseconds. |
| ListeningPort { get; } | Gets the listening port. |
| ReceiveTimeout { get; } | Gets the receive timeout in milliseconds. |
| RetryTimeout { get; } | Gets the retry timeout in milliseconds. |
| SendTimeout { get; } | Gets the send timeout in milliseconds. |

### ConnectTimeout
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/connecttimeout.md

#### TcpSettings.ConnectTimeout property

Gets the connect timeout in milliseconds.

```csharp
public int ConnectTimeout { get; }
```

##### Property Value

The connect timeout in milliseconds.

### ListeningPort
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/listeningport.md

#### TcpSettings.ListeningPort property

Gets the listening port.

```csharp
public int ListeningPort { get; }
```

##### Property Value

The listening port.

### ReceiveTimeout
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/receivetimeout.md

#### TcpSettings.ReceiveTimeout property

Gets the receive timeout in milliseconds.

```csharp
public int ReceiveTimeout { get; }
```

##### Property Value

The receive timeout in milliseconds.

### RetryTimeout
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/retrytimeout.md

#### TcpSettings.RetryTimeout property

Gets the retry timeout in milliseconds.

```csharp
public int RetryTimeout { get; }
```

##### Property Value

The retry timeout in milliseconds.

### SendTimeout
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/sendtimeout.md

#### TcpSettings.SendTimeout property

Gets the send timeout in milliseconds.

```csharp
public int SendTimeout { get; }
```

##### Property Value

The send timeout in milliseconds.

### TcpSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.configuring/tcpsettings/tcpsettings.md

#### TcpSettings constructor

Initializes a new instance of the `TcpSettings` class.

```csharp
public TcpSettings(int listeningPort, int sendTimeout, int receiveTimeout, int connectTimeout, 
    int retryTimeout)
```

| Parameter | Type | Description |
| --- | --- | --- |
| listeningPort | Int32 | The listening port. |
| sendTimeout | Int32 | The send timeout in milliseconds. |
| receiveTimeout | Int32 | The receive timeout in milliseconds. |
| connectTimeout | Int32 | The connect timeout in milliseconds. |
| retryTimeout | Int32 | The retry timeout in milliseconds. |

### GroupDocs.Search.Scaling.Events
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events.md

The namespace provides classes of event arguments in the search network.

#### Classes

| Class | Description |
| --- | --- |
| DataExtractedEventArgs | Represents arguments for the event of a document data extraction is finished. |
| DocumentDeletedEventArgs | Represents arguments for the event of a document deletion is finished. |
| DocumentIndexedEventArgs | Represents arguments for the event of a document indexing is finished. |
| ErrorOccurredEventArgs | Represents arguments for the event of an error occurs in one of the nodes of the search network. |
| NetworkIndexingProgressEventArgs | Represents the arguments for the progress change event of the indexing operation. |
| NetworkOptimizationProgressEventArgs | Represents the arguments for the progress change event of the optimization operation. |
| NodeEventHub | Provides node events for subscribing. |
| StatusChangedEventArgs | Represents arguments for a search network status change event. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### DataExtractedEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/dataextractedeventargs.md

#### DataExtractedEventArgs class

Represents arguments for the event of a document data extraction is finished.

```csharp
public class DataExtractedEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| Data { get; } | Gets the extracted document data. |
| DocumentKey { get; } | Gets the document key. |
| ExtractorIndex { get; } | Gets the extractor index. |

### Data
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/dataextractedeventargs/data.md

#### DataExtractedEventArgs.Data property

Gets the extracted document data.

```csharp
public ExtractedData Data { get; }
```

##### Property Value

The extracted document data.

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/dataextractedeventargs/documentkey.md

#### DataExtractedEventArgs.DocumentKey property

Gets the document key.

```csharp
public string DocumentKey { get; }
```

##### Property Value

The document key.

### ExtractorIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/dataextractedeventargs/extractorindex.md

#### DataExtractedEventArgs.ExtractorIndex property

Gets the extractor index.

```csharp
public int ExtractorIndex { get; }
```

##### Property Value

The extractor index.

### DocumentDeletedEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentdeletedeventargs.md

#### DocumentDeletedEventArgs class

Represents arguments for the event of a document deletion is finished.

```csharp
public class DocumentDeletedEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentKey { get; } | Gets the document key. |
| ShardIndex { get; } | Gets the shard index. |

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentdeletedeventargs/documentkey.md

#### DocumentDeletedEventArgs.DocumentKey property

Gets the document key.

```csharp
public string DocumentKey { get; }
```

##### Property Value

The document key.

### ShardIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentdeletedeventargs/shardindex.md

#### DocumentDeletedEventArgs.ShardIndex property

Gets the shard index.

```csharp
public int ShardIndex { get; }
```

##### Property Value

The shard index.

### DocumentIndexedEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentindexedeventargs.md

#### DocumentIndexedEventArgs class

Represents arguments for the event of a document indexing is finished.

```csharp
public class DocumentIndexedEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentKey { get; } | Gets the document key. |
| ShardIndex { get; } | Gets the shard index. |

### DocumentKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentindexedeventargs/documentkey.md

#### DocumentIndexedEventArgs.DocumentKey property

Gets the document key.

```csharp
public string DocumentKey { get; }
```

##### Property Value

The document key.

### ShardIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/documentindexedeventargs/shardindex.md

#### DocumentIndexedEventArgs.ShardIndex property

Gets the shard index.

```csharp
public int ShardIndex { get; }
```

##### Property Value

The shard index.

### ErrorOccurredEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/erroroccurredeventargs.md

#### ErrorOccurredEventArgs class

Represents arguments for the event of an error occurs in one of the nodes of the search network.

```csharp
public class ErrorOccurredEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| Message { get; } | Gets the error message. |
| NodeIndex { get; } | Gets the index of the search network node. |
| ServiceIndex { get; } | Gets the index of the search network node service. |

### Message
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/erroroccurredeventargs/message.md

#### ErrorOccurredEventArgs.Message property

Gets the error message.

```csharp
public string Message { get; }
```

##### Property Value

The error message.

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/erroroccurredeventargs/nodeindex.md

#### ErrorOccurredEventArgs.NodeIndex property

Gets the index of the search network node.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the search network node.

### ServiceIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/erroroccurredeventargs/serviceindex.md

#### ErrorOccurredEventArgs.ServiceIndex property

Gets the index of the search network node service.

```csharp
public int ServiceIndex { get; }
```

##### Property Value

The index of the search network node service.

### NetworkIndexingProgressEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs.md

#### NetworkIndexingProgressEventArgs class

Represents the arguments for the progress change event of the indexing operation.

```csharp
public class NetworkIndexingProgressEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| NodeIndex { get; } | Gets the index of the search network node. |
| ProcessedDocuments { get; } | Gets the number of processed documents. |
| ProgressPercentage { get; } | Gets the percentage of the progress. |
| ServiceIndex { get; } | Gets the index of the search network node service. |
| TotalDocuments { get; } | Gets the total number of documents for processing. |

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs/nodeindex.md

#### NetworkIndexingProgressEventArgs.NodeIndex property

Gets the index of the search network node.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the search network node.

### ProcessedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs/processeddocuments.md

#### NetworkIndexingProgressEventArgs.ProcessedDocuments property

Gets the number of processed documents.

```csharp
public int ProcessedDocuments { get; }
```

##### Property Value

The number of processed documents.

### ProgressPercentage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs/progresspercentage.md

#### NetworkIndexingProgressEventArgs.ProgressPercentage property

Gets the percentage of the progress.

```csharp
public double ProgressPercentage { get; }
```

##### Property Value

The percentage of the progress.

### ServiceIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs/serviceindex.md

#### NetworkIndexingProgressEventArgs.ServiceIndex property

Gets the index of the search network node service.

```csharp
public int ServiceIndex { get; }
```

##### Property Value

The index of the search network node service.

### TotalDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkindexingprogresseventargs/totaldocuments.md

#### NetworkIndexingProgressEventArgs.TotalDocuments property

Gets the total number of documents for processing.

```csharp
public int TotalDocuments { get; }
```

##### Property Value

The total number of documents for processing.

### NetworkOptimizationProgressEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs.md

#### NetworkOptimizationProgressEventArgs class

Represents the arguments for the progress change event of the optimization operation.

```csharp
public class NetworkOptimizationProgressEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| NodeIndex { get; } | Gets the index of the search network node. |
| ProcessedSegments { get; } | Gets the number of processed segments. |
| ProgressPercentage { get; } | Gets the percentage of the progress. |
| ServiceIndex { get; } | Gets the index of the search network node service. |
| TotalSegments { get; } | Gets the total number of segments for processing. |

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs/nodeindex.md

#### NetworkOptimizationProgressEventArgs.NodeIndex property

Gets the index of the search network node.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the search network node.

### ProcessedSegments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs/processedsegments.md

#### NetworkOptimizationProgressEventArgs.ProcessedSegments property

Gets the number of processed segments.

```csharp
public int ProcessedSegments { get; }
```

##### Property Value

The number of processed segments.

### ProgressPercentage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs/progresspercentage.md

#### NetworkOptimizationProgressEventArgs.ProgressPercentage property

Gets the percentage of the progress.

```csharp
public double ProgressPercentage { get; }
```

##### Property Value

The percentage of the progress.

### ServiceIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs/serviceindex.md

#### NetworkOptimizationProgressEventArgs.ServiceIndex property

Gets the index of the search network node service.

```csharp
public int ServiceIndex { get; }
```

##### Property Value

The index of the search network node service.

### TotalSegments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/networkoptimizationprogresseventargs/totalsegments.md

#### NetworkOptimizationProgressEventArgs.TotalSegments property

Gets the total number of segments for processing.

```csharp
public int TotalSegments { get; }
```

##### Property Value

The total number of segments for processing.

### NodeEventHub
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub.md

#### NodeEventHub class

Provides node events for subscribing.

```csharp
public class NodeEventHub
```

#### Events

| Name | Description |
| --- | --- |
| event AttributeChangesCompleted | Occurs when all enqueued attribute changes are finished. |
| event ConfigurationCompleted | Occurs when the search network configuration process is finished. |
| event DataExtracted | Occurs when the data has been extracted from a document. |
| event DeletionCompleted | Occurs when all enqueued deletions of documents are finished. |
| event DocumentDeleted | Occurs when a document has been deleted. |
| event DocumentIndexed | Occurs when a document has been indexed. |
| event ErrorOccurred | Occurs when an error occurs in one of the nodes of the search network. |
| event ExtractionCompleted | Occurs when a separate task to extract all enqueued documents is finished. |
| event IndexingCompleted | Occurs when indexing of all enqueued documents is finished. |
| event IndexingProgressChanged | Occurs when the progress of the indexing operation has changed. |
| event OptimizationCompleted | Occurs when optimization of all nodes is finished. |
| event OptimizationProgressChanged | Occurs when the progress of the optimization operation has changed. |
| event StatusChanged | Occurs when the search network status changes. |
| event SynchronizationCompleted | Occurs when synchronization with all nodes is finished. |

### AttributeChangesCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/attributechangescompleted.md

#### NodeEventHub.AttributeChangesCompleted event

Occurs when all enqueued attribute changes are finished.

```csharp
public event EventHandler AttributeChangesCompleted;
```

### ConfigurationCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/configurationcompleted.md

#### NodeEventHub.ConfigurationCompleted event

Occurs when the search network configuration process is finished.

```csharp
public event EventHandler ConfigurationCompleted;
```

### DataExtracted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/dataextracted.md

#### NodeEventHub.DataExtracted event

Occurs when the data has been extracted from a document.

```csharp
public event EventHandler<DataExtractedEventArgs> DataExtracted;
```

### DeletionCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/deletioncompleted.md

#### NodeEventHub.DeletionCompleted event

Occurs when all enqueued deletions of documents are finished.

```csharp
public event EventHandler DeletionCompleted;
```

### DocumentDeleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/documentdeleted.md

#### NodeEventHub.DocumentDeleted event

Occurs when a document has been deleted.

```csharp
public event EventHandler<DocumentDeletedEventArgs> DocumentDeleted;
```

### DocumentIndexed
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/documentindexed.md

#### NodeEventHub.DocumentIndexed event

Occurs when a document has been indexed.

```csharp
public event EventHandler<DocumentIndexedEventArgs> DocumentIndexed;
```

### ErrorOccurred
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/erroroccurred.md

#### NodeEventHub.ErrorOccurred event

Occurs when an error occurs in one of the nodes of the search network.

```csharp
public event EventHandler<ErrorOccurredEventArgs> ErrorOccurred;
```

### ExtractionCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/extractioncompleted.md

#### NodeEventHub.ExtractionCompleted event

Occurs when a separate task to extract all enqueued documents is finished.

```csharp
public event EventHandler ExtractionCompleted;
```

### IndexingCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/indexingcompleted.md

#### NodeEventHub.IndexingCompleted event

Occurs when indexing of all enqueued documents is finished.

```csharp
public event EventHandler IndexingCompleted;
```

### IndexingProgressChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/indexingprogresschanged.md

#### NodeEventHub.IndexingProgressChanged event

Occurs when the progress of the indexing operation has changed.

```csharp
public event EventHandler<NetworkIndexingProgressEventArgs> IndexingProgressChanged;
```

### OptimizationCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/optimizationcompleted.md

#### NodeEventHub.OptimizationCompleted event

Occurs when optimization of all nodes is finished.

```csharp
public event EventHandler OptimizationCompleted;
```

### OptimizationProgressChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/optimizationprogresschanged.md

#### NodeEventHub.OptimizationProgressChanged event

Occurs when the progress of the optimization operation has changed.

```csharp
public event EventHandler<NetworkOptimizationProgressEventArgs> OptimizationProgressChanged;
```

### StatusChanged
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/statuschanged.md

#### NodeEventHub.StatusChanged event

Occurs when the search network status changes.

```csharp
public event EventHandler<StatusChangedEventArgs> StatusChanged;
```

### SynchronizationCompleted
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/nodeeventhub/synchronizationcompleted.md

#### NodeEventHub.SynchronizationCompleted event

Occurs when synchronization with all nodes is finished.

```csharp
public event EventHandler SynchronizationCompleted;
```

### StatusChangedEventArgs
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/statuschangedeventargs.md

#### StatusChangedEventArgs class

Represents arguments for a search network status change event.

```csharp
public class StatusChangedEventArgs : EventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| NewStatus { get; } | Gets the new search network status. |
| OldStatus { get; } | Gets the old search network status. |

### NewStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/statuschangedeventargs/newstatus.md

#### StatusChangedEventArgs.NewStatus property

Gets the new search network status.

```csharp
public SearchNetworkStatus NewStatus { get; }
```

##### Property Value

The new search network status.

### OldStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.events/statuschangedeventargs/oldstatus.md

#### StatusChangedEventArgs.OldStatus property

Gets the old search network status.

```csharp
public SearchNetworkStatus OldStatus { get; }
```

##### Property Value

The old search network status.

### GroupDocs.Search.Scaling.Results
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results.md

The namespace provides the search result classes in the search network.

#### Classes

| Class | Description |
| --- | --- |
| NetworkDocumentInfo | Represents a descriptor for an indexed document in the search network. |
| NetworkFoundDocument | Represents a found document in the search network. |
| NetworkImageSearchResult | Represents an image search result matching a search image. |
| NetworkImageSearchToken | Represents a token for the continuation of the network chunk image search (search by pages). |
| NetworkSearchResult | Represents a search result matching a search query. |
| NetworkSearchToken | Represents a token for the continuation of the network chunk search (search by pages). |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### NetworkDocumentInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkdocumentinfo.md

#### NetworkDocumentInfo class

Represents a descriptor for an indexed document in the search network.

```csharp
public class NetworkDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentInfo { get; } | Gets the descriptor for an indexed document. |
| ShardIndex { get; } | Gets the shard index. |

### DocumentInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkdocumentinfo/documentinfo.md

#### NetworkDocumentInfo.DocumentInfo property

Gets the descriptor for an indexed document.

```csharp
public DocumentInfo DocumentInfo { get; }
```

##### Property Value

The descriptor for an indexed document.

### ShardIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkdocumentinfo/shardindex.md

#### NetworkDocumentInfo.ShardIndex property

Gets the shard index.

```csharp
public int ShardIndex { get; }
```

##### Property Value

The shard index.

### NetworkFoundDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkfounddocument.md

#### NetworkFoundDocument class

Represents a found document in the search network.

```csharp
public class NetworkFoundDocument
```

#### Properties

| Name | Description |
| --- | --- |
| FoundDocument { get; } | Gets the found document. |
| ShardIndex { get; } | Gets the shard index. |

### FoundDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkfounddocument/founddocument.md

#### NetworkFoundDocument.FoundDocument property

Gets the found document.

```csharp
public FoundDocument FoundDocument { get; }
```

##### Property Value

The found document.

### ShardIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkfounddocument/shardindex.md

#### NetworkFoundDocument.ShardIndex property

Gets the shard index.

```csharp
public int ShardIndex { get; }
```

##### Property Value

The shard index.

### NetworkImageSearchResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult.md

#### NetworkImageSearchResult class

Represents an image search result matching a search image.

```csharp
public class NetworkImageSearchResult
```

#### Properties

| Name | Description |
| --- | --- |
| ImageCount { get; } | Gets the number of images found. |
| NetworkImageSearchToken { get; } | Gets a chunk image search token for searching the next chunk. |
| NodeIndex { get; } | Gets the index of the node from which the result was received. |
| ShardIndex { get; } | Gets the index of the shard from which the result was received. |

#### Methods

| Name | Description |
| --- | --- |
| GetFoundImage(int) | Gets the found image by index. |

### GetFoundImage
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult/getfoundimage.md

#### NetworkImageSearchResult.GetFoundImage method

Gets the found image by index.

```csharp
public FoundImageFrame GetFoundImage(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index of a found image. |

##### Return Value

The found image.

### ImageCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult/imagecount.md

#### NetworkImageSearchResult.ImageCount property

Gets the number of images found.

```csharp
public int ImageCount { get; }
```

##### Property Value

The number of images found.

### NetworkImageSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult/networkimagesearchtoken.md

#### NetworkImageSearchResult.NetworkImageSearchToken property

Gets a chunk image search token for searching the next chunk.

```csharp
public NetworkImageSearchToken NetworkImageSearchToken { get; }
```

##### Property Value

A chunk image search token for searching the next chunk.

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult/nodeindex.md

#### NetworkImageSearchResult.NodeIndex property

Gets the index of the node from which the result was received.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the node from which the result was received.

### ShardIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchresult/shardindex.md

#### NetworkImageSearchResult.ShardIndex property

Gets the index of the shard from which the result was received.

```csharp
public int ShardIndex { get; }
```

##### Property Value

The index of the shard from which the result was received.

### NetworkImageSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networkimagesearchtoken.md

#### NetworkImageSearchToken class

Represents a token for the continuation of the network chunk image search (search by pages).

```csharp
public class NetworkImageSearchToken
```

### NetworkSearchResult
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult.md

#### NetworkSearchResult class

Represents a search result matching a search query.

```csharp
public class NetworkSearchResult : IEnumerable<NetworkFoundDocument>
```

#### Properties

| Name | Description |
| --- | --- |
| DocumentCount { get; } | Gets the number of documents found. |
| EndTime { get; } | Gets the end time of the search. |
| NextChunkSearchToken { get; } | Gets a chunk search token for searching the next chunk. |
| NodeIndex { get; } | Gets the index of the node from which the result was received. |
| OccurrenceCount { get; } | Gets the total number of occurrences found. |
| SearchDuration { get; } | Gets the search duration. |
| StartTime { get; } | Gets the start time of the search. |
| Truncated { get; } | Gets a value indicating that the result is truncated. |
| Warnings { get; } | Gets a warnings describing the result. |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns an enumerator that iterates through the collection of the documents found. |
| GetFoundDocument(int) | Gets the found document by index. |

### DocumentCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/documentcount.md

#### NetworkSearchResult.DocumentCount property

Gets the number of documents found.

```csharp
public int DocumentCount { get; }
```

##### Property Value

The number of documents found.

### EndTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/endtime.md

#### NetworkSearchResult.EndTime property

Gets the end time of the search.

```csharp
public DateTime EndTime { get; }
```

##### Property Value

The end time of the search.

### GetEnumerator
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/getenumerator.md

#### NetworkSearchResult.GetEnumerator method

Returns an enumerator that iterates through the collection of the documents found.

```csharp
public IEnumerator<NetworkFoundDocument> GetEnumerator()
```

##### Return Value

An enumerator that can be used to iterate through the collection of the found documents.

### GetFoundDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/getfounddocument.md

#### NetworkSearchResult.GetFoundDocument method

Gets the found document by index.

```csharp
public NetworkFoundDocument GetFoundDocument(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index of a found document. |

##### Return Value

The found document.

### NextChunkSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/nextchunksearchtoken.md

#### NetworkSearchResult.NextChunkSearchToken property

Gets a chunk search token for searching the next chunk.

```csharp
public NetworkSearchToken NextChunkSearchToken { get; }
```

##### Property Value

A chunk search token for searching the next chunk.

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/nodeindex.md

#### NetworkSearchResult.NodeIndex property

Gets the index of the node from which the result was received.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the node from which the result was received.

### OccurrenceCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/occurrencecount.md

#### NetworkSearchResult.OccurrenceCount property

Gets the total number of occurrences found.

```csharp
public int OccurrenceCount { get; }
```

##### Property Value

The total number of occurrences found.

### SearchDuration
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/searchduration.md

#### NetworkSearchResult.SearchDuration property

Gets the search duration.

```csharp
public TimeSpan SearchDuration { get; }
```

##### Property Value

The search duration.

### StartTime
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/starttime.md

#### NetworkSearchResult.StartTime property

Gets the start time of the search.

```csharp
public DateTime StartTime { get; }
```

##### Property Value

The start time of the search.

### Truncated
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/truncated.md

#### NetworkSearchResult.Truncated property

Gets a value indicating that the result is truncated.

```csharp
public bool Truncated { get; }
```

##### Property Value

A value indicating that the result is truncated.

### Warnings
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchresult/warnings.md

#### NetworkSearchResult.Warnings property

Gets a warnings describing the result.

```csharp
public string Warnings { get; }
```

##### Property Value

A warnings describing the result.

### NetworkSearchToken
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.results/networksearchtoken.md

#### NetworkSearchToken class

Represents a token for the continuation of the network chunk search (search by pages).

```csharp
public class NetworkSearchToken
```

### GroupDocs.Search.Scaling
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling.md

The namespace provides classes of scaling functionality.

#### Classes

| Class | Description |
| --- | --- |
| Indexer | Represents a service that manages the distribution of indexed documents across shards of the search network. |
| Searcher | Represents a service that manages search queries to shards of the search network. |
| SearchNetworkNode | Represents a search network node that can contain services such as extractor, indexer, searcher, shard. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| SearchNetworkStatus | Specifies a search network status. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### Indexer
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer.md

#### Indexer class

Represents a service that manages the distribution of indexed documents across shards of the search network.

```csharp
public sealed class Indexer
```

#### Properties

| Name | Description |
| --- | --- |
| Status { get; } | Gets the current search network status. |

#### Methods

| Name | Description |
| --- | --- |
| Add(IList&lt;ExtractedData&gt;, IndexingOptions) | Performs indexing operation. Adds the extracted data to the search network. |
| Add(IList&lt;Document&gt;, IList&lt;string&gt;, IndexingOptions) | Performs indexing operation. Indexing only from stream and structure is supported. |
| ChangeAttributes(AttributeChangeBatch, ChangeAttributesOptions) | Applies the specified batch of attribute changes to indexed documents without reindexing. |
| Delete(string[], DeleteOptions) | Deletes indexed documents. |
| DeleteAllData() | Deletes all indexed data from all shards of the search network. |
| Extract(IList&lt;Document&gt;, IList&lt;string&gt;, IndexingOptions) | Extracts data from documents. |
| GetAliasDictionary(int) | Gets the alias dictionary. |
| GetAlphabet(int) | Gets the alphabet dictionary. |
| GetAttributes(string) | Gets all the attributes associated with the specified indexed document. |
| GetCharacterReplacementDictionary(int) | Gets the character replacement dictionary. |
| GetDictionary(DictionaryType, int) | Gets a dictionary from the specified shard. |
| GetHomophoneDictionary(int) | Gets the homophone dictionary. |
| GetPasswordDictionary(int) | Gets the password dictionary. |
| GetSpellingCorrector(int) | Gets the spelling corrector dictionary. |
| GetStopWordDictionary(int) | Gets the stop word dictionary. |
| GetSynonymDictionary(int) | Gets the synonym dictionary. |
| GetTokenizationDictionary(int) | Gets the tokenization dictionary. |
| Optimize(OptimizeOptions) | Minimizes the number of index segments by merging them one with another. This operation improves search performance. |
| SetDictionary(DictionaryBase) | Sets a dictionary in all shards. |
| SetDictionary(DictionaryBase, int) | Sets a dictionary in the specified shard. |
| Synchronize(SynchronizeOptions) | Synchronizes the list of indexed documents with those on shards. This operation fixes issues with indexing and deletion of documents that resulted from communication problems with the search network nodes. |

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/add.md

#### Add(IList&lt;Document&gt;, IList&lt;string&gt;, IndexingOptions)

Performs indexing operation. Indexing only from stream and structure is supported.

```csharp
public void Add(IList<Document> documents, IList<string> passwords, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documents | IList`1 | The documents from stream or structure. |
| passwords | IList`1 | The document passwords. |
| options | IndexingOptions | The add options. |

#### Add(IList&lt;ExtractedData&gt;, IndexingOptions)

Performs indexing operation. Adds the extracted data to the search network.

```csharp
public void Add(IList<ExtractedData> data, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| data | IList`1 | The extracted data. |
| options | IndexingOptions | The indexing options. |

### ChangeAttributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/changeattributes.md

#### Indexer.ChangeAttributes method

Applies the specified batch of attribute changes to indexed documents without reindexing.

```csharp
public void ChangeAttributes(AttributeChangeBatch batch, ChangeAttributesOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| batch | AttributeChangeBatch | The attribute change batch. |
| options | ChangeAttributesOptions | The change attributes options. |

### Delete
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/delete.md

#### Indexer.Delete method

Deletes indexed documents.

```csharp
public void Delete(string[] documentKeys, DeleteOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentKeys | String[] | The keys of documents added from streams or structures. |
| options | DeleteOptions | The delete options. |

### DeleteAllData
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/deletealldata.md

#### Indexer.DeleteAllData method

Deletes all indexed data from all shards of the search network.

```csharp
public void DeleteAllData()
```

### Extract
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/extract.md

#### Indexer.Extract method

Extracts data from documents.

```csharp
public void Extract(IList<Document> documents, IList<string> passwords, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documents | IList`1 | The documents to be extracted. |
| passwords | IList`1 | The document passwords. |
| options | IndexingOptions | The extraction options. |

### GetAliasDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getaliasdictionary.md

#### Indexer.GetAliasDictionary method

Gets the alias dictionary.

```csharp
public AliasDictionary GetAliasDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetAlphabet
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getalphabet.md

#### Indexer.GetAlphabet method

Gets the alphabet dictionary.

```csharp
public Alphabet GetAlphabet(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetAttributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getattributes.md

#### Indexer.GetAttributes method

Gets all the attributes associated with the specified indexed document.

```csharp
public string[] GetAttributes(string documentKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | String | The document key. |

##### Return Value

The attributes associated with the specified indexed document.

### GetCharacterReplacementDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getcharacterreplacementdictionary.md

#### Indexer.GetCharacterReplacementDictionary method

Gets the character replacement dictionary.

```csharp
public CharacterReplacementDictionary GetCharacterReplacementDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getdictionary.md

#### Indexer.GetDictionary method

Gets a dictionary from the specified shard.

```csharp
public DictionaryBase GetDictionary(DictionaryType dictionaryType, int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dictionaryType | DictionaryType | The dictionary type. |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetHomophoneDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/gethomophonedictionary.md

#### Indexer.GetHomophoneDictionary method

Gets the homophone dictionary.

```csharp
public HomophoneDictionary GetHomophoneDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetPasswordDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getpassworddictionary.md

#### Indexer.GetPasswordDictionary method

Gets the password dictionary.

```csharp
public PasswordDictionary GetPasswordDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetSpellingCorrector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getspellingcorrector.md

#### Indexer.GetSpellingCorrector method

Gets the spelling corrector dictionary.

```csharp
public SpellingCorrector GetSpellingCorrector(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetStopWordDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getstopworddictionary.md

#### Indexer.GetStopWordDictionary method

Gets the stop word dictionary.

```csharp
public StopWordDictionary GetStopWordDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetSynonymDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/getsynonymdictionary.md

#### Indexer.GetSynonymDictionary method

Gets the synonym dictionary.

```csharp
public SynonymDictionary GetSynonymDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### GetTokenizationDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/gettokenizationdictionary.md

#### Indexer.GetTokenizationDictionary method

Gets the tokenization dictionary.

```csharp
public Alphabet GetTokenizationDictionary(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

The dictionary.

### Optimize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/optimize.md

#### Indexer.Optimize method

Minimizes the number of index segments by merging them one with another. This operation improves search performance.

```csharp
public void Optimize(OptimizeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | OptimizeOptions | The optimize options. |

### SetDictionary
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/setdictionary.md

#### SetDictionary(DictionaryBase, int)

Sets a dictionary in the specified shard.

```csharp
public void SetDictionary(DictionaryBase dictionary, int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | DictionaryBase | The dictionary. |
| shardIndex | Int32 | The shard index. |

#### SetDictionary(DictionaryBase)

Sets a dictionary in all shards.

```csharp
public void SetDictionary(DictionaryBase dictionary)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dictionary | DictionaryBase | The dictionary. |

### Status
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/status.md

#### Indexer.Status property

Gets the current search network status.

```csharp
public SearchNetworkStatus Status { get; }
```

##### Property Value

The current search network status.

### Synchronize
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/indexer/synchronize.md

#### Indexer.Synchronize method

Synchronizes the list of indexed documents with those on shards. This operation fixes issues with indexing and deletion of documents that resulted from communication problems with the search network nodes.

```csharp
public void Synchronize(SynchronizeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | SynchronizeOptions | The synchronize options. |

### Searcher
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher.md

#### Searcher class

Represents a service that manages search queries to shards of the search network.

```csharp
public sealed class Searcher
```

#### Methods

| Name | Description |
| --- | --- |
| GetDocumentText(NetworkDocumentInfo, OutputAdapter) | Generates the text of an indexed document and passes it through an output adapter. |
| GetIndexedDocumentItems(NetworkDocumentInfo) | Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST). |
| GetIndexedDocuments(int) | Gets an array of all indexed documents. |
| Highlight(NetworkFoundDocument, Highlighter, HighlightOptions) | Generates HTML formatted text with highlighted found terms. |
| SearchFirst(SearchImage, ImageSearchOptions) | Starts a reverse image search in the distributed search index. |
| SearchFirst(SearchQuery, SearchOptions) | Starts a search with a query in object form in the distributed search index. |
| SearchFirst(string, SearchOptions) | Starts a search with a query in text form in the distributed search index. |
| SearchNext(NetworkImageSearchToken) | Continues a reverse image search in the distributed search index. |
| SearchNext(NetworkSearchToken) | Continues a search in the distributed search index. |

### GetDocumentText
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/getdocumenttext.md

#### Searcher.GetDocumentText method

Generates the text of an indexed document and passes it through an output adapter.

```csharp
public void GetDocumentText(NetworkDocumentInfo documentInfo, OutputAdapter adapter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | NetworkDocumentInfo | The indexed document info. |
| adapter | OutputAdapter | The output adapter. |

### GetIndexedDocumentItems
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/getindexeddocumentitems.md

#### Searcher.GetIndexedDocumentItems method

Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).

```csharp
public NetworkDocumentInfo[] GetIndexedDocumentItems(NetworkDocumentInfo documentInfo)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | NetworkDocumentInfo | The document info. |

##### Return Value

An array of a document items.

### GetIndexedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/getindexeddocuments.md

#### Searcher.GetIndexedDocuments method

Gets an array of all indexed documents.

```csharp
public NetworkDocumentInfo[] GetIndexedDocuments(int shardIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| shardIndex | Int32 | The shard index. |

##### Return Value

An array of all indexed documents.

### Highlight
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/highlight.md

#### Searcher.Highlight method

Generates HTML formatted text with highlighted found terms.

```csharp
public void Highlight(NetworkFoundDocument document, Highlighter highlighter, 
    HighlightOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | NetworkFoundDocument | The found document. |
| highlighter | Highlighter | The search result highlighter. |
| options | HighlightOptions | The highlight options. |

### SearchFirst
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/searchfirst.md

#### SearchFirst(string, SearchOptions)

Starts a search with a query in text form in the distributed search index.

```csharp
public NetworkSearchResult SearchFirst(string query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | String | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

#### SearchFirst(SearchQuery, SearchOptions)

Starts a search with a query in object form in the distributed search index.

```csharp
public NetworkSearchResult SearchFirst(SearchQuery query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

#### SearchFirst(SearchImage, ImageSearchOptions)

Starts a reverse image search in the distributed search index.

```csharp
public NetworkImageSearchResult SearchFirst(SearchImage image, ImageSearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| image | SearchImage | The image to search. |
| options | ImageSearchOptions | The image search options. |

##### Return Value

The reverse image search result.

### SearchNext
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searcher/searchnext.md

#### SearchNext(NetworkSearchToken)

Continues a search in the distributed search index.

```csharp
public NetworkSearchResult SearchNext(NetworkSearchToken networkSearchToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| networkSearchToken | NetworkSearchToken | The network search token. |

##### Return Value

The search result.

#### SearchNext(NetworkImageSearchToken)

Continues a reverse image search in the distributed search index.

```csharp
public NetworkImageSearchResult SearchNext(NetworkImageSearchToken networkImageSearchToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| networkImageSearchToken | NetworkImageSearchToken | The network image search token. |

##### Return Value

The reverse image search result.

### SearchNetworkNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode.md

#### SearchNetworkNode class

Represents a search network node that can contain services such as extractor, indexer, searcher, shard.

```csharp
public class SearchNetworkNode : IDisposable
```

#### Properties

| Name | Description |
| --- | --- |
| CustomExtractors { get; } | Gets the custom extractor collection. |
| Events { get; } | Gets the event hub for subscribing to events. |
| Indexer { get; } | Gets the indexer. |
| NodeIndex { get; } | Gets the index of the search network node. |
| Searcher { get; } | Gets the searcher. |

#### Methods

| Name | Description |
| --- | --- |
| static CreateMasterNode(int, string, INetworkSettings, ILogger, Configuration) | Creates a master node of the search network. |
| static CreateSlaveNode(int, string, INetworkSettings) | Creates a slave node of the search network. |
| static CreateSlaveNode(int, string, INetworkSettings, ILogger) | Creates a slave node of the search network. |
| ConfigureAllNodes() | Configures all nodes in the search network. |
| ConfigureNode(int) | Configures the specified node in the search network. |
| Dispose() | Releases all resources used by the `SearchNetworkNode`. |
| GetNodeIndex(int) | Gets the index of the node where the service is located. |
| GetShardIndices() | Gets an array of all shard indices in the search network. |
| SetOcrConnector(IOcrConnector) | Sets an OCR connector that is used for OCR processing. |
| SetWordFormsProvider(IWordFormsProvider) | Sets a word forms provider. |
| Start() | Starts the functioning of the search network node. |

### ConfigureAllNodes
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/configureallnodes.md

#### SearchNetworkNode.ConfigureAllNodes method

Configures all nodes in the search network.

```csharp
public void ConfigureAllNodes()
```

### ConfigureNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/configurenode.md

#### SearchNetworkNode.ConfigureNode method

Configures the specified node in the search network.

```csharp
public void ConfigureNode(int nodeIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |

### CreateMasterNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/createmasternode.md

#### SearchNetworkNode.CreateMasterNode method

Creates a master node of the search network.

```csharp
public static SearchNetworkNode CreateMasterNode(int nodeIndex, string storagePath, 
    INetworkSettings networkSettings, ILogger logger, Configuration configuration)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |
| storagePath | String | The storage path. |
| networkSettings | INetworkSettings | The network settings. |
| logger | ILogger | The logger. |
| configuration | Configuration | The configuration. |

##### Return Value

The master node.

### CreateSlaveNode
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/createslavenode.md

#### CreateSlaveNode(int, string, INetworkSettings)

Creates a slave node of the search network.

```csharp
public static SearchNetworkNode CreateSlaveNode(int nodeIndex, string storagePath, 
    INetworkSettings networkSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |
| storagePath | String | The storage path. |
| networkSettings | INetworkSettings | The network settings. |

##### Return Value

The slave node.

#### CreateSlaveNode(int, string, INetworkSettings, ILogger)

Creates a slave node of the search network.

```csharp
public static SearchNetworkNode CreateSlaveNode(int nodeIndex, string storagePath, 
    INetworkSettings networkSettings, ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| nodeIndex | Int32 | The node index. |
| storagePath | String | The storage path. |
| networkSettings | INetworkSettings | The network settings. |
| logger | ILogger | The logger. |

##### Return Value

The slave node.

### CustomExtractors
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/customextractors.md

#### SearchNetworkNode.CustomExtractors property

Gets the custom extractor collection.

```csharp
public CustomExtractorCollection CustomExtractors { get; }
```

##### Property Value

The custom extractor collection.

##### Remarks

The full example of implementing a custom extractor is presented in documentation for `IFieldExtractor` interface.

### Dispose
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/dispose.md

#### SearchNetworkNode.Dispose method

Releases all resources used by the `SearchNetworkNode`.

```csharp
public void Dispose()
```

### Events
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/events.md

#### SearchNetworkNode.Events property

Gets the event hub for subscribing to events.

```csharp
public NodeEventHub Events { get; }
```

##### Property Value

The event hub for subscribing to events.

### GetNodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/getnodeindex.md

#### SearchNetworkNode.GetNodeIndex method

Gets the index of the node where the service is located.

```csharp
public int GetNodeIndex(int serviceIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| serviceIndex | Int32 | The service index. |

##### Return Value

The index of the node where the service is located. If the service index is incorrect, when -1 is returned.

### GetShardIndices
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/getshardindices.md

#### SearchNetworkNode.GetShardIndices method

Gets an array of all shard indices in the search network.

```csharp
public int[] GetShardIndices()
```

##### Return Value

An array of all shard indices in the search network.

### Indexer
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/indexer.md

#### SearchNetworkNode.Indexer property

Gets the indexer.

```csharp
public Indexer Indexer { get; }
```

##### Property Value

The indexer.

### NodeIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/nodeindex.md

#### SearchNetworkNode.NodeIndex property

Gets the index of the search network node.

```csharp
public int NodeIndex { get; }
```

##### Property Value

The index of the search network node.

### Searcher
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/searcher.md

#### SearchNetworkNode.Searcher property

Gets the searcher.

```csharp
public Searcher Searcher { get; }
```

##### Property Value

The searcher.

### SetOcrConnector
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/setocrconnector.md

#### SearchNetworkNode.SetOcrConnector method

Sets an OCR connector that is used for OCR processing.

```csharp
public void SetOcrConnector(IOcrConnector ocrConnector)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ocrConnector | IOcrConnector | The OCR connector. |

### SetWordFormsProvider
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/setwordformsprovider.md

#### SearchNetworkNode.SetWordFormsProvider method

Sets a word forms provider.

```csharp
public void SetWordFormsProvider(IWordFormsProvider wordFormsProvider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| wordFormsProvider | IWordFormsProvider | The word forms provider. |

### Start
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworknode/start.md

#### SearchNetworkNode.Start method

Starts the functioning of the search network node.

```csharp
public void Start()
```

### SearchNetworkStatus
Path: https://reference.groupdocs.com/search/net/groupdocs.search.scaling/searchnetworkstatus.md

#### SearchNetworkStatus enumeration

Specifies a search network status.

```csharp
public enum SearchNetworkStatus
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Ready | `0` | The search network is free and ready for changes. |
| Configuring | `1` | The search network performs a configuring operation. |
| Extracting | `2` | The search network performs an extracting operation. |
| Indexing | `3` | The search network performs an indexing operation. |
| Optimizing | `4` | The search network performs an optimizing operation. |
| Deleting | `5` | The search network performs a deleting operation. |
| ChangingAttributes | `6` | The search network changes attributes. |
| Synchronizing | `7` | The search network performs a synchronizing operation. |

### GroupDocs.Search
Path: https://reference.groupdocs.com/search/net/groupdocs.search.md

The namespace provides classes for indexing and searching text data in documents of different formats. The main classes in this namespace are:

#### Classes

| Class | Description |
| --- | --- |
| ExtractionHost | Represents a service for extracting data from documents in a separate process. |
| Extractor | Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing. |
| Index | Represents the main class for indexing documents and search through them. |
| IndexRepository | Represents a container for combining multiple indexes and performing common operations on them. |
| IndexSettings | Represents the index settings that allow to customize the indexing operations. |
| IndexUpdater | Represents an index updater. This class performs reindexing documents in an index of an old version. |
| License | Provides methods for applying license. |
| Metered | Provides methods which allow to activate product with Metered license and retrieve amount of MBs processed. Learn more about Metered licenses [here](https://purchase.groupdocs.com/faqs/licensing/metered). |
| SearchQuery | Represents a search query in object form. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.search.dll -->

### ExtractionHost
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractionhost.md

#### ExtractionHost class

Represents a service for extracting data from documents in a separate process.

```csharp
public class ExtractionHost : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| ExtractionHost(string[]) | Initializes a new instance of the `ExtractionHost` class. |

#### Properties

| Name | Description |
| --- | --- |
| CustomExtractors { get; } | Gets the custom extractor collection. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Releases all resources used by the `ExtractionHost`. |
| Run() | Starts the service for extracting data from documents. |

### CustomExtractors
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractionhost/customextractors.md

#### ExtractionHost.CustomExtractors property

Gets the custom extractor collection.

```csharp
public CustomExtractorCollection CustomExtractors { get; }
```

##### Property Value

The custom extractor collection.

##### Remarks

The full example of implementing a custom extractor is presented in documentation for `IFieldExtractor` interface.

### Dispose
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractionhost/dispose.md

#### ExtractionHost.Dispose method

Releases all resources used by the `ExtractionHost`.

```csharp
public void Dispose()
```

### ExtractionHost
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractionhost/extractionhost.md

#### ExtractionHost constructor

Initializes a new instance of the `ExtractionHost` class.

```csharp
public ExtractionHost(string[] args)
```

### Run
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractionhost/run.md

#### ExtractionHost.Run method

Starts the service for extracting data from documents.

```csharp
public void Run()
```

### Extractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor.md

#### Extractor class

Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing.

```csharp
public class Extractor
```

#### Constructors

| Name | Description |
| --- | --- |
| Extractor() | Initializes a new instance of the `Extractor` class. |

#### Properties

| Name | Description |
| --- | --- |
| Settings { get; } | Gets the extractor settings. |

#### Methods

| Name | Description |
| --- | --- |
| Extract(Document, ExtractionOptions) | Extracts data from a document. |

#### Events

| Name | Description |
| --- | --- |
| event ErrorOccurred | Occurs when an error happens during an extractor operation. |
| event ImagePreparing | Occurs when an image is going to be prepared for indexing. |
| event PasswordRequired | Occurs when a document requires password for opening. |

### ErrorOccurred
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/erroroccurred.md

#### Extractor.ErrorOccurred event

Occurs when an error happens during an extractor operation.

```csharp
public event EventHandler<IndexErrorEventArgs> ErrorOccurred;
```

### Extract
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/extract.md

#### Extractor.Extract method

Extracts data from a document.

```csharp
public ExtractedData Extract(Document document, ExtractionOptions extractionOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Document | The document from file system, stream or structure. |
| extractionOptions | ExtractionOptions | The extraction options. |

##### Return Value

The extracted data of the document.

### Extractor
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/extractor.md

#### Extractor constructor

Initializes a new instance of the `Extractor` class.

```csharp
public Extractor()
```

### ImagePreparing
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/imagepreparing.md

#### Extractor.ImagePreparing event

Occurs when an image is going to be prepared for indexing.

```csharp
public event EventHandler<ImagePreparingEventArgs> ImagePreparing;
```

### PasswordRequired
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/passwordrequired.md

#### Extractor.PasswordRequired event

Occurs when a document requires password for opening.

```csharp
public event EventHandler<PasswordRequiredEventArgs> PasswordRequired;
```

### Settings
Path: https://reference.groupdocs.com/search/net/groupdocs.search/extractor/settings.md

#### Extractor.Settings property

Gets the extractor settings.

```csharp
public ExtractorSettings Settings { get; }
```

##### Property Value

The extractor settings.

### Index
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index.md

#### Index class

Represents the main class for indexing documents and search through them.

```csharp
public class Index : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Index() | Initializes a new instance of the `Index` class in memory. |
| Index(IndexSettings) | Initializes a new instance of the `Index` class in memory with particular index settings. |
| Index(string) | Initializes a new instance of the `Index` class. Creates a new or opens an existing index on disk. |
| Index(string, bool) | Initializes a new instance of the `Index` class. Loads an existing index from disk if *overwriteIfExists* is `false`; creates a new index on disk otherwise. |
| Index(string, IndexSettings) | Initializes a new instance of the `Index` class. Creates a new index with particular settings or opens an existing index on disk. |
| Index(string, IndexSettings, bool) | Initializes a new instance of the `Index` class. Loads an existing index from disk if *overwriteIfExists* is `false`; creates a new index on disk with particular index settings otherwise. |

#### Properties

| Name | Description |
| --- | --- |
| Dictionaries { get; } | Gets the dictionary repository. |
| Events { get; } | Gets the event hub for subscribing to events. |
| IndexInfo { get; } | Gets the basic information on the index. |
| IndexSettings { get; } | Gets the index settings. |
| Repository { get; } | Gets the index repository object if the index is contained in it. |

#### Methods

| Name | Description |
| --- | --- |
| static LoadIntoMemoryCompletely(string) | Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder. |
| static LoadIntoMemoryCompletely(string, IndexSettings) | Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder. |
| Add(string) | Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed. |
| Add(string[]) | Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed. |
| Add(Document[], IndexingOptions) | Performs indexing operation. Adds documents from file system, stream or structure. |
| Add(ExtractedData[], IndexingOptions) | Performs indexing operation. Adds the extracted data to the index. |
| Add(string, IndexingOptions) | Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed. |
| Add(string[], IndexingOptions) | Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed. |
| ChangeAttributes(AttributeChangeBatch) | Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation. |
| CheckSegments(bool) | Checks the index for damaged segment files on the disk. The method fixes index functionality in the presence of damaged segments, if *fixIndexFunctionality* is true; does not fix - otherwise. |
| Delete(string[], UpdateOptions) | Deletes indexed files or folders from the index. Then updates the index without deleted paths. Note that an individual document cannot be deleted from the index if it was added to the index as part of a folder. |
| Delete(UpdateOptions, string[]) | Deletes documents indexed from streams or structures. Then updates the index without deleted documents. |
| Dispose() | Releases all resources used by the `Index`. |
| GetAttributes(string) | Gets all the attributes associated with the specified indexed document. |
| GetDocumentText(DocumentInfo, OutputAdapter) | Generates the text of an indexed document and passes it through an output adapter. |
| GetDocumentText(DocumentInfo, OutputAdapter, TextOptions) | Generates HTML formatted text for indexed document and transfers it through the output adapter. |
| GetIndexedDocument(string) | Gets an indexed document by document key. |
| GetIndexedDocumentItems(DocumentInfo) | Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST). |
| GetIndexedDocuments() | Gets an array of all indexed documents. |
| GetIndexedPaths() | Gets an array of indexed paths - documents or folders. |
| GetIndexingReports() | Gets the reports on indexing operations. |
| GetSearchReports() | Gets the reports on search operations. |
| Highlight(FoundDocument, Highlighter) | Generates HTML formatted text with highlighted found terms. |
| Highlight(FoundDocument, Highlighter, HighlightOptions) | Generates HTML formatted text with highlighted found terms. |
| Merge(Index, MergeOptions) | Merges the specified index into the current index. Note that the other index will not be changed. |
| Merge(IndexRepository, MergeOptions) | Merges indexes from the specified index repository into the current index. Note that indexes in the repository will not be changed. |
| Notify(Notification) | Passes the specified notification object to the index to perform the notification. |
| Optimize() | Minimizes the number of index segments by merging them one with another. This operation improves search performance. |
| Optimize(MergeOptions) | Minimizes the number of index segments by merging them one with another. This operation improves search performance. |
| SaveTo(string) | Saves the in-memory index to disk. Also saves the regular index to another folder. Does not change the settings of this index. |
| Search(SearchQuery) | Searches in index. |
| Search(string) | Searches in index. |
| Search(SearchImage, ImageSearchOptions) | Performs a reverse image search in the index. |
| Search(SearchQuery, SearchOptions) | Searches in index. |
| Search(string, SearchOptions) | Searches in index. |
| SearchNext(ChunkSearchToken) | Continues the chunk search started with method Search. |
| SearchNext(ChunkSearchToken, Cancellation) | Continues the chunk search started with method Search. |
| Update() | Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders. |
| Update(UpdateOptions) | Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result = index.Search(query); // Searching in index
```

### Add
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/add.md

#### Add(string)

Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.

```csharp
public void Add(string path)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The path to a file or folder to be indexed. |

##### Examples

The example demonstrates how to add documents to an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string folderPath = @"c:\MyDocuments\";
string filePath = @"c:\Documents\MyFile.txt";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(folderPath); // Indexing documents in the specified folder
index.Add(filePath); // Indexing the specified document
```

#### Add(string, IndexingOptions)

Performs indexing operation. Adds a file or folder by an absolute or relative path. Documents from all subfolders will be indexed.

```csharp
public void Add(string path, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The path to a file or folder to be indexed. |
| options | IndexingOptions | The indexing options. |

##### Examples

The example demonstrates how to add documents to an index with particular indexing options.

```csharp
string indexFolder = @"c:\MyIndex\";
string folderPath = @"c:\MyDocuments\";
string filePath = @"c:\Documents\MyFile.txt";

Index index = new Index(indexFolder); // Creating index in the specified folder

IndexingOptions options = new IndexingOptions();
options.Threads = 2; // Setting the number of indexing threads
index.Add(folderPath, options); // Indexing documents in the specified folder
index.Add(filePath, options); // Indexing the specified document
```

#### Add(string[])

Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.

```csharp
public void Add(string[] paths)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The paths to a files or folders to be indexed. |

##### Examples

The example demonstrates how to add documents to an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string folderPath = @"c:\MyDocuments\";
string filePath = @"c:\Documents\MyFile.txt";

Index index = new Index(indexFolder); // Creating index in the specified folder

string[] paths = new string[] { folderPath, filePath };
index.Add(paths); // Indexing documents at the specified paths
```

#### Add(string[], IndexingOptions)

Performs indexing operation. Adds files or folders by an absolute or relative path. Documents from all subfolders will be indexed.

```csharp
public void Add(string[] paths, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The paths to a files or folders to be indexed. |
| options | IndexingOptions | The indexing options. |

##### Examples

The example demonstrates how to add documents to an index with particular indexing options.

```csharp
string indexFolder = @"c:\MyIndex\";
string folderPath = @"c:\MyDocuments\";
string filePath = @"c:\Documents\MyFile.txt";

Index index = new Index(indexFolder); // Creating index in the specified folder

IndexingOptions options = new IndexingOptions();
options.Threads = 2; // Setting the number of indexing threads
string[] paths = new string[] { folderPath, filePath };
index.Add(paths, options); // Indexing documents at the specified paths
```

#### Add(Document[], IndexingOptions)

Performs indexing operation. Adds documents from file system, stream or structure.

```csharp
public void Add(Document[] documents, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documents | Document[] | The documents from file system, stream or structure. |
| options | IndexingOptions | The indexing options. |

#### Add(ExtractedData[], IndexingOptions)

Performs indexing operation. Adds the extracted data to the index.

```csharp
public void Add(ExtractedData[] data, IndexingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| data | ExtractedData[] | The extracted data. |
| options | IndexingOptions | The indexing options. |

### ChangeAttributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/changeattributes.md

#### Index.ChangeAttributes method

Applies the specified batch of attribute changes to indexed documents without reindexing during the update operation.

```csharp
public void ChangeAttributes(AttributeChangeBatch batch)
```

| Parameter | Type | Description |
| --- | --- | --- |
| batch | AttributeChangeBatch | The attribute change batch. |

### CheckSegments
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/checksegments.md

#### Index.CheckSegments method

Checks the index for damaged segment files on the disk. The method fixes index functionality in the presence of damaged segments, if *fixIndexFunctionality* is true; does not fix - otherwise.

```csharp
public void CheckSegments(bool fixIndexFunctionality)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fixIndexFunctionality | Boolean | The index functionality fix flag. |

### Delete
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/delete.md

#### Delete(string[], UpdateOptions)

Deletes indexed files or folders from the index. Then updates the index without deleted paths. Note that an individual document cannot be deleted from the index if it was added to the index as part of a folder.

```csharp
public DeleteResult Delete(string[] paths, UpdateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| paths | String[] | The paths to files or folders to delete. |
| options | UpdateOptions | The update options. |

##### Return Value

An object describing the result of deleting files or folders from the index.

##### Examples

The example demonstrates how to delete indexed paths from an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder1 = @"c:\MyDocuments\";
string documentsFolder2 = @"c:\MyDocuments2\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents from the specified folders
index.Add(documentsFolder1);
index.Add(documentsFolder2);

// Getting indexed paths from the index
string[] indexedPaths1 = index.GetIndexedPaths();

// Writing indexed paths to the console
Console.WriteLine("Indexed paths:");
foreach (string path in indexedPaths1)
{
    Console.WriteLine("\t" + path);
}

// Deleting index path from the index
DeleteResult deleteResult = index.Delete(new string[] { documentsFolder1 }, new UpdateOptions());

// Getting indexed paths after deletion
string[] indexedPaths2 = index.GetIndexedPaths();
Console.WriteLine("\nDeleted paths: " + deleteResult.SuccessCount);

Console.WriteLine("\nIndexed paths:");
foreach (string path in indexedPaths2)
{
    Console.WriteLine("\t" + path);
}
```

#### Delete(UpdateOptions, string[])

Deletes documents indexed from streams or structures. Then updates the index without deleted documents.

```csharp
public DeleteResult Delete(UpdateOptions options, string[] documentKeys)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options. |
| documentKeys | String[] | The keys of documents added from streams or structures. |

##### Return Value

An object describing the result of deleting documents from the index.

### Dictionaries
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/dictionaries.md

#### Index.Dictionaries property

Gets the dictionary repository.

```csharp
public DictionaryRepository Dictionaries { get; }
```

##### Property Value

The dictionary repository.

### Dispose
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/dispose.md

#### Index.Dispose method

Releases all resources used by the `Index`.

```csharp
public void Dispose()
```

### Events
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/events.md

#### Index.Events property

Gets the event hub for subscribing to events.

```csharp
public EventHub Events { get; }
```

##### Property Value

The event hub for subscribing to events.

### GetAttributes
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getattributes.md

#### Index.GetAttributes method

Gets all the attributes associated with the specified indexed document.

```csharp
public string[] GetAttributes(string path)
```

| Parameter | Type | Description |
| --- | --- | --- |
| path | String | The document path. |

##### Return Value

Attributes associated with the document.

### GetDocumentText
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getdocumenttext.md

#### GetDocumentText(DocumentInfo, OutputAdapter)

Generates the text of an indexed document and passes it through an output adapter.

```csharp
public void GetDocumentText(DocumentInfo documentInfo, OutputAdapter adapter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | The indexed document info. |
| adapter | OutputAdapter | The output adapter. |

##### Examples

The example demonstrates how to get the text of an indexed document from an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
 
// Creating an index in the specified folder
Index index = new Index(indexFolder);
 
// Indexing documents from the specified folder
index.Add(documentsFolder);
 
// Getting list of indexed documents
DocumentInfo[] documents = index.GetIndexedDocuments();
 
// Getting a document text
if (documents.Length > 0)
{
    FileOutputAdapter outputAdapter = new FileOutputAdapter(@"C:\Text.html");
    index.GetDocumentText(documents[0], outputAdapter);
}
```

#### GetDocumentText(DocumentInfo, OutputAdapter, TextOptions)

Generates HTML formatted text for indexed document and transfers it through the output adapter.

```csharp
public void GetDocumentText(DocumentInfo documentInfo, OutputAdapter adapter, TextOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | The indexed document info. |
| adapter | OutputAdapter | The output adapter. |
| options | TextOptions | The text retrieving options. |

### GetIndexedDocument
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getindexeddocument.md

#### Index.GetIndexedDocument method

Gets an indexed document by document key.

```csharp
public DocumentInfo GetIndexedDocument(string documentKey)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentKey | String | The document key. |

##### Return Value

The indexed document.

### GetIndexedDocumentItems
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getindexeddocumentitems.md

#### Index.GetIndexedDocumentItems method

Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).

```csharp
public DocumentInfo[] GetIndexedDocumentItems(DocumentInfo documentInfo)
```

| Parameter | Type | Description |
| --- | --- | --- |
| documentInfo | DocumentInfo | The document info. |

##### Return Value

An array of a document items.

##### Examples

The example demonstrates how to get a list of items of an indexed document from an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
 
// Creating an index in the specified folder
Index index = new Index(indexFolder);
 
// Indexing documents from the specified folder
index.Add(documentsFolder);
 
// Getting list of indexed documents
DocumentInfo[] documents = index.GetIndexedDocuments();
for (int i = 0; i < documents.Length; i++)
{
    DocumentInfo document = documents[i];
    Console.WriteLine(document.FilePath);
    DocumentInfo[] items = index.GetIndexedDocumentItems(document); // Getting list of document items
    for (int j = 0; j < items.Length; j++)
    {
        DocumentInfo item = items[j];
        Console.WriteLine("\t" + item.InnerPath);
    }
}
```

### GetIndexedDocuments
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getindexeddocuments.md

#### Index.GetIndexedDocuments method

Gets an array of all indexed documents.

```csharp
public DocumentInfo[] GetIndexedDocuments()
```

##### Return Value

An array of all indexed documents.

##### Examples

The example demonstrates how to get a list of indexed documents from an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
 
// Creating an index in the specified folder
Index index = new Index(indexFolder);
 
// Indexing documents from the specified folder
index.Add(documentsFolder);
 
// Getting list of indexed documents
DocumentInfo[] documents = index.GetIndexedDocuments();
```

### GetIndexedPaths
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getindexedpaths.md

#### Index.GetIndexedPaths method

Gets an array of indexed paths - documents or folders.

```csharp
public string[] GetIndexedPaths()
```

##### Return Value

An array of indexed paths.

### GetIndexingReports
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getindexingreports.md

#### Index.GetIndexingReports method

Gets the reports on indexing operations.

```csharp
public IndexingReport[] GetIndexingReports()
```

##### Return Value

The indexing reports.

##### Examples

The example demonstrates how to get indexing reports.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

IndexingReport[] reports = index.GetIndexingReports(); // Getting indexing reports
```

### GetSearchReports
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/getsearchreports.md

#### Index.GetSearchReports method

Gets the reports on search operations.

```csharp
public SearchReport[] GetSearchReports()
```

##### Return Value

The search reports.

##### Examples

The example demonstrates how to get search reports.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query1 = "Einstein";
string query2 = "Newton";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result1 = index.Search(query1); // Searching
SearchResult result2 = index.Search(query2);
SearchResult result3 = index.Search(query1 + " & " + query2);

SearchReport[] reports = index.GetSearchReports(); // Getting search reports
```

### Highlight
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/highlight.md

#### Highlight(FoundDocument, Highlighter)

Generates HTML formatted text with highlighted found terms.

```csharp
public void Highlight(FoundDocument document, Highlighter highlighter)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | FoundDocument | The found document. |
| highlighter | Highlighter | The search result highlighter. |

##### Examples

The example demonstrates how to highlight occurrences in HTML formatted text.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentFolder);

// Search for the word 'eternity'
SearchResult result = index.Search("eternity");

// Highlighting occurrences in text
if (result.DocumentCount > 0)
{
    FoundDocument document = result.GetFoundDocument(0); // Getting the first found document
    OutputAdapter outputAdapter = new FileOutputAdapter(@"c:\Highlighted.html"); // Creating an output adapter to the file
    Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object
    index.Highlight(document, highlighter); // Generating HTML formatted text with highlighted occurrences
}
```

#### Highlight(FoundDocument, Highlighter, HighlightOptions)

Generates HTML formatted text with highlighted found terms.

```csharp
public void Highlight(FoundDocument document, Highlighter highlighter, HighlightOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | FoundDocument | The found document. |
| highlighter | Highlighter | The search result highlighter. |
| options | HighlightOptions | The highlight options. |

##### Examples

The example demonstrates how to highlight occurrences in HTML formatted text.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentFolder = @"c:\MyDocuments\";

// Creating an index
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentFolder);

// Search for the word 'eternity'
SearchResult result = index.Search("eternity");

// Highlighting occurrences in text
if (result.DocumentCount > 0)
{
    FoundDocument document = result.GetFoundDocument(0); // Getting the first found document
    OutputAdapter outputAdapter = new FileOutputAdapter(@"c:\Highlighted.html"); // Creating an output adapter to the file
    Highlighter highlighter = new HtmlHighlighter(outputAdapter); // Creating the highlighter object
    HighlightOptions options = new HighlightOptions(); // Creating the highlight options object
    options.TermsBefore = 5;
    options.TermsAfter = 5;
    options.TermsTotal = 15;
    index.Highlight(document, highlighter, options); // Generating HTML formatted text with highlighted occurrences
}
```

### Index
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/index.md

#### Index()

Initializes a new instance of the `Index` class in memory.

```csharp
public Index()
```

##### Examples

The example demonstrates how to create index in memory without saving files to disk.

```csharp
Index index = new Index(); 
```

#### Index(IndexSettings)

Initializes a new instance of the `Index` class in memory with particular index settings.

```csharp
public Index(IndexSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| settings | IndexSettings | The index settings object. |

##### Examples

The example demonstrates how to create index in memory without saving files to disk with particular index settings.

```csharp
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex;
Index index = new Index(settings);
```

#### Index(string)

Initializes a new instance of the `Index` class. Creates a new or opens an existing index on disk.

```csharp
public Index(string indexFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |

##### Examples

The example demonstrates how to create an index on a disk or open an existing index.

```csharp
string indexFolder = @"c:\MyIndex\";
Index index = new Index(indexFolder); 
```

#### Index(string, IndexSettings)

Initializes a new instance of the `Index` class. Creates a new index with particular settings or opens an existing index on disk.

```csharp
public Index(string indexFolder, IndexSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |
| settings | IndexSettings | The index settings object. |

##### Examples

The example demonstrates how to create an index on a disk with particular index settings.

```csharp
string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex;
Index index = new Index(indexFolder, settings);
```

#### Index(string, bool)

Initializes a new instance of the `Index` class. Loads an existing index from disk if *overwriteIfExists* is `false`; creates a new index on disk otherwise.

```csharp
public Index(string indexFolder, bool overwriteIfExists)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |
| overwriteIfExists | Boolean | The flag of overwriting the index folder. |

##### Examples

The example demonstrates how to create a new index in a folder that already contains another index.

```csharp
string indexFolder = @"c:\MyIndex\";
Index index = new Index(indexFolder, true);
```

#### Index(string, IndexSettings, bool)

Initializes a new instance of the `Index` class. Loads an existing index from disk if *overwriteIfExists* is `false`; creates a new index on disk with particular index settings otherwise.

```csharp
public Index(string indexFolder, IndexSettings settings, bool overwriteIfExists)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |
| settings | IndexSettings | The index settings object. |
| overwriteIfExists | Boolean | The flag of overwriting the index folder. |

##### Examples

The example demonstrates how to create an index on a disk with particular index settings.

```csharp
string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex;
Index index = new Index(indexFolder, settings, true);
```

### IndexInfo
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/indexinfo.md

#### Index.IndexInfo property

Gets the basic information on the index.

```csharp
public IndexInfo IndexInfo { get; }
```

##### Property Value

The basic information on the index.

### IndexSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/indexsettings.md

#### Index.IndexSettings property

Gets the index settings.

```csharp
public IndexSettings IndexSettings { get; }
```

##### Property Value

The index settings.

### LoadIntoMemoryCompletely
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/loadintomemorycompletely.md

#### LoadIntoMemoryCompletely(string)

Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder.

```csharp
public static Index LoadIntoMemoryCompletely(string indexFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |

##### Return Value

The loaded in-memory index.

#### LoadIntoMemoryCompletely(string, IndexSettings)

Loads the entire index into memory. Any changes to the index are not automatically saved to the original folder.

```csharp
public static Index LoadIntoMemoryCompletely(string indexFolder, IndexSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder path. |
| settings | IndexSettings | The index settings object. |

##### Return Value

The loaded in-memory index.

### Merge
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/merge.md

#### Merge(Index, MergeOptions)

Merges the specified index into the current index. Note that the other index will not be changed.

```csharp
public void Merge(Index index, MergeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Index | The index to merge into. |
| options | MergeOptions | The merge options. |

##### Remarks

If the other index has a previous version, it must be updated before merging with `IndexUpdater`.

##### Examples

The example demonstrates how to merge an index into the current index.

```csharp
string indexFolder1 = @"c:\MyIndex1\";
string indexFolder2 = @"c:\MyIndex2\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";

Index index1 = new Index(indexFolder1); // Creating index1
index1.Add(documentsFolder1); // Indexing documents

Index index2 = new Index(indexFolder2); // Creating index2
index2.Add(documentsFolder2); // Indexing documents

MergeOptions options = new MergeOptions();
options.Cancellation = new Cancellation(); // Creating cancellation object

// Merging index2 into index1. Note that index2 files will not be changed.
index1.Merge(index2, options);
```

#### Merge(IndexRepository, MergeOptions)

Merges indexes from the specified index repository into the current index. Note that indexes in the repository will not be changed.

```csharp
public void Merge(IndexRepository repository, MergeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| repository | IndexRepository | The index repository to merge into. |
| options | MergeOptions | The merge options. |

##### Remarks

If other indexes have a previous version, they must be updated before merging with `IndexUpdater`.

##### Examples

The example demonstrates how to merge an index repository into the current index.

```csharp
string indexFolder1 = @"c:\MyIndex1\";
string indexFolder2 = @"c:\MyIndex2\";
string indexFolder3 = @"c:\MyIndex3\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";
string documentsFolder3 = @"c:\MyDocuments3\";

Index index1 = new Index(indexFolder1); // Creating index1
index1.Add(documentsFolder1); // Indexing documents

IndexRepository repository = new IndexRepository(); // Creating index repository

Index index2 = repository.Create(indexFolder2); // Creating index2
index2.Add(documentsFolder2); // Indexing documents

Index index3 = repository.Create(indexFolder3); // Creating index3
index3.Add(documentsFolder3); // Indexing documents

MergeOptions options = new MergeOptions();
options.Cancellation = new Cancellation(); // Creating cancellation object

// Merging all indexes in the index repository into index1. Note that index2 and index3 will not be changed.
index1.Merge(repository, options);
```

### Notify
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/notify.md

#### Index.Notify method

Passes the specified notification object to the index to perform the notification.

```csharp
public bool Notify(Notification notification)
```

| Parameter | Type | Description |
| --- | --- | --- |
| notification | Notification | The notification object. |

##### Return Value

Returns `true` if the notification was successfully performed; otherwise `false`.

### Optimize
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/optimize.md

#### Optimize()

Minimizes the number of index segments by merging them one with another. This operation improves search performance.

```csharp
public void Optimize()
```

##### Examples

The example demonstrates how to merge segments of an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";
string documentsFolder3 = @"c:\MyDocuments3\";

Index index = new Index(indexFolder); // Creating index in the specified folder

index.Add(documentsFolder1); // Indexing documents from the specified folder
index.Add(documentsFolder2); // Each call to Add creates at least one new segment in the index
index.Add(documentsFolder3);

// Merging segments of the index
index.Optimize();
```

#### Optimize(MergeOptions)

Minimizes the number of index segments by merging them one with another. This operation improves search performance.

```csharp
public void Optimize(MergeOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | MergeOptions | The merge options. |

##### Examples

The example demonstrates how to merge segments of an index with particular merge options.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";
string documentsFolder3 = @"c:\MyDocuments3\";

Index index = new Index(indexFolder); // Creating index in the specified folder

index.Add(documentsFolder1); // Indexing documents from the specified folder
index.Add(documentsFolder2); // Each call to Add creates at least one new segment in the index
index.Add(documentsFolder3);

MergeOptions options = new MergeOptions();
options.IsAsync = true; // Asynchronous operation
options.Cancellation = new Cancellation(); // Creating cancellation object

// Merging segments of the index
index.Optimize(options); // This method will return before the operation is completed

options.Cancellation.CancelAfter(10000); // Setting maximum duration of the operation to 10 seconds
```

### Repository
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/repository.md

#### Index.Repository property

Gets the index repository object if the index is contained in it.

```csharp
public IndexRepository Repository { get; }
```

##### Property Value

The index repository object.

### SaveTo
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/saveto.md

#### Index.SaveTo method

Saves the in-memory index to disk. Also saves the regular index to another folder. Does not change the settings of this index.

```csharp
public void SaveTo(string indexFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The path to the index folder to save. |

### Search
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/search.md

#### Search(string)

Searches in index.

```csharp
public SearchResult Search(string query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | String | The search query. |

##### Return Value

The search result.

##### Examples

The following example demonstrates how to perform simple search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result = index.Search(query); // Searching
```

The following example demonstrates how to perform Regex search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

string query = "^[0-9]{3,}"; // The caret symbol at the beginning of the search query tells the index that it is a Regex query
SearchResult result = index.Search(query); // Searching
```

The following example demonstrates how to perform faceted search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

string query = "content:Newton"; // The word before the colon in the query means the document field name to search
SearchResult result = index.Search(query); // Searching
```

#### Search(string, SearchOptions)

Searches in index.

```csharp
public SearchResult Search(string query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | String | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

##### Examples

The following example demonstrates how to perform fuzzy search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.FuzzySearch.Enabled = true; // Enabling the fuzzy search
options.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1); // Setting the number of possible differences for each word

// Double quotes at the beginning and end tells the index that it is phrase search query
string query = "\"The Pursuit of Happiness\"";
SearchResult result = index.Search(query, options); // Searching
```

The following example demonstrates how to perform synonym search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.UseSynonymSearch = true; // Enabling the synonym search

string query = "cry";
SearchResult result = index.Search(query, options); // Searching
```

#### Search(SearchQuery)

Searches in index.

```csharp
public SearchResult Search(SearchQuery query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query. |

##### Return Value

The search result.

##### Examples

The following example demonstrates how to perform search using query in object form.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

// Creating subquery 1
SearchQuery subquery1 = SearchQuery.CreateWordQuery("accommodation");
subquery1.SearchOptions = new SearchOptions(); // Setting search options only for subquery 1
subquery1.SearchOptions.FuzzySearch.Enabled = true; // Enabling the fuzzy search
subquery1.SearchOptions.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(3); // Setting maximum number of differences

// Creating subquery 2
SearchQuery subquery2 = SearchQuery.CreateNumericRangeQuery(1, 1000000);

// Creating subquery 3
SearchQuery subquery3 = SearchQuery.CreateRegexQuery(@"(.)\1");

// Combining subqueries into one query
SearchQuery query = SearchQuery.CreatePhraseSearchQuery(subquery1, subquery2, subquery3);

SearchResult result = index.Search(query); // Searching
```

#### Search(SearchQuery, SearchOptions)

Searches in index.

```csharp
public SearchResult Search(SearchQuery query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

##### Examples

The following example demonstrates how to perform search using query in object form.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

// Creating subquery of date range search
SearchQuery subquery1 = SearchQuery.CreateDateRangeQuery(new DateTime(2011, 6, 17), new DateTime(2013, 1, 1));

// Creating subquery of wildcard with number of missed words from 0 to 2
SearchQuery subquery2 = SearchQuery.CreateWildcardQuery(0, 2);

// Creating subquery of simple word
SearchQuery subquery3 = SearchQuery.CreateWordQuery("birth");
subquery3.SearchOptions = new SearchOptions(); // Setting search options only for subquery 3
subquery3.SearchOptions.FuzzySearch.Enabled = true;
subquery3.SearchOptions.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1);

// Combining subqueries into one query
SearchQuery query = SearchQuery.CreatePhraseSearchQuery(subquery1, subquery2, subquery3);

// Creating search options object with increased capacity of found occurrences
SearchOptions options = new SearchOptions(); // Overall search options
options.MaxOccurrenceCountPerTerm = 1000000;
options.MaxTotalOccurrenceCount = 10000000;

SearchResult result = index.Search(query, options); // Searching
```

#### Search(SearchImage, ImageSearchOptions)

Performs a reverse image search in the index.

```csharp
public ImageSearchResult Search(SearchImage image, ImageSearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| image | SearchImage | The image to search. |
| options | ImageSearchOptions | The image search options. |

##### Return Value

The result of a reverse image search.

### SearchNext
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/searchnext.md

#### SearchNext(ChunkSearchToken)

Continues the chunk search started with method Search.

```csharp
public SearchResult SearchNext(ChunkSearchToken chunkSearchToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | ChunkSearchToken | The chunk search token. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform chunk search.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

SearchOptions options = new SearchOptions();
options.IsChunkSearch = true; // Enabling chunk search

SearchResult result = index.Search(query, options); // Starting chunk search
Console.WriteLine("Document count: " + result.DocumentCount);
Console.WriteLine("Occurrence count: " + result.OccurrenceCount);

while (result.NextChunkSearchToken != null)
{
    result = index.SearchNext(result.NextChunkSearchToken); // Continuing chunk search
    Console.WriteLine("Document count: " + result.DocumentCount);
    Console.WriteLine("Occurrence count: " + result.OccurrenceCount);
}
```

#### SearchNext(ChunkSearchToken, Cancellation)

Continues the chunk search started with method Search.

```csharp
public SearchResult SearchNext(ChunkSearchToken chunkSearchToken, Cancellation cancellation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| chunkSearchToken | ChunkSearchToken | The chunk search token. |
| cancellation | Cancellation | The cancellation object. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform search using query in object form.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

Cancellation cancellation = new Cancellation(); // This cancellation object aborts all search continuations if canceled
SearchOptions options = new SearchOptions();
options.IsChunkSearch = true; // Enabling chunk search
options.Cancellation = cancellation;

SearchResult result = index.Search(query, options); // Starting chunk search
Console.WriteLine("Document count: " + result.DocumentCount);
Console.WriteLine("Occurrence count: " + result.OccurrenceCount);

while (result.NextChunkSearchToken != null)
{
    result = index.SearchNext(result.NextChunkSearchToken, cancellation); // Continuing chunk search
    Console.WriteLine("Document count: " + result.DocumentCount);
    Console.WriteLine("Occurrence count: " + result.OccurrenceCount);
}
```

### Update
Path: https://reference.groupdocs.com/search/net/groupdocs.search/index/update.md

#### Update()

Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.

```csharp
public void Update()
```

##### Examples

The example demonstrates how to update an index.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

// Delete documents from the documents folder or modify them or add new documents to the folder

index.Update(); // Updating the index
```

#### Update(UpdateOptions)

Re-indexes documents that have been changed or deleted since last update. Adds new files that have been added to the indexed folders.

```csharp
public void Update(UpdateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options. |

##### Examples

The example demonstrates how to update an index with particular update options.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

// Delete documents from the documents folder or modify them or add new documents to the folder

UpdateOptions options = new UpdateOptions();
options.Threads = 2; // Setting the number of indexing threads
index.Update(options); // Updating the index
```

### IndexRepository
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository.md

#### IndexRepository class

Represents a container for combining multiple indexes and performing common operations on them.

```csharp
public class IndexRepository : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| IndexRepository() | Initializes a new instance of the `IndexRepository` class. |

#### Properties

| Name | Description |
| --- | --- |
| Events { get; } | Gets the event hub for subscribing to events. |
| Indexes { get; } | Gets the indexes contained in this `IndexRepository`. |

#### Methods

| Name | Description |
| --- | --- |
| AddToRepository(Index) | Adds an index to the index repository. |
| AddToRepository(string) | Opens and adds an index to the index repository. |
| Create() | Creates a new index in memory. |
| Create(IndexSettings) | Creates a new index in memory. |
| Create(string) | Creates a new index on disk. The index folder will be cleaned before the index creation. |
| Create(string, IndexSettings) | Creates a new index on disk. The index folder will be cleaned before the index creation. |
| Dispose() | Releases all resources used by the `IndexRepository`. |
| Search(SearchQuery) | Searches in all indexes of the repository. |
| Search(string) | Searches in all indexes of the repository. |
| Search(SearchQuery, SearchOptions) | Searches in all indexes of the repository. |
| Search(string, SearchOptions) | Searches in all indexes of the repository. |
| Update() | Updates all indexes in the repository. |
| Update(UpdateOptions) | Updates all indexes in the repository. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder1 = @"c:\MyIndex\";
string indexFolder2 = @"c:\MyIndex\";
string query = "Einstein";

IndexRepository repository = new IndexRepository();
repository.AddToRepository(indexFolder1); // Loading an existing index
repository.AddToRepository(indexFolder2); // Loading another existing index

SearchResult result = repository.Search(query); // Searching in indexes of the repository
```

### AddToRepository
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/addtorepository.md

#### AddToRepository(Index)

Adds an index to the index repository.

```csharp
public void AddToRepository(Index index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Index | The index to add. |

##### Examples

The example demonstrates how to add an index to the index repository.

```csharp
Index index = new Index();

IndexRepository indexRepository = new IndexRepository();

indexRepository.AddToRepository(index);
```

#### AddToRepository(string)

Opens and adds an index to the index repository.

```csharp
public void AddToRepository(string indexFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder. |

##### Examples

The example demonstrates how to add an index to the index repository.

```csharp
string indexFolder = @"c:\MyIndex\";

IndexRepository indexRepository = new IndexRepository();

indexRepository.AddToRepository(indexFolder);
```

### Create
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/create.md

#### Create()

Creates a new index in memory.

```csharp
public Index Create()
```

##### Return Value

The created index.

##### Examples

The example demonstrates how to create an index in memory through the index repository.

```csharp
IndexRepository indexRepository = new IndexRepository();
Index index = indexRepository.Create();
```

#### Create(IndexSettings)

Creates a new index in memory.

```csharp
public Index Create(IndexSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| settings | IndexSettings | The index settings. |

##### Return Value

The created index.

##### Examples

The example demonstrates how to create an index in memory through the index repository.

```csharp
IndexRepository indexRepository = new IndexRepository();

IndexSettings settings = new IndexSettings();
settings.UseStopWords = false; // Disabling use of stop words during indexing

Index index = indexRepository.Create(settings);
```

#### Create(string)

Creates a new index on disk. The index folder will be cleaned before the index creation.

```csharp
public Index Create(string indexFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder. |

##### Return Value

The created index.

##### Examples

The example demonstrates how to create an index on disk through the index repository.

```csharp
string indexFolder = @"c:\MyIndex\";

IndexRepository indexRepository = new IndexRepository();
Index index = indexRepository.Create(indexFolder);
```

#### Create(string, IndexSettings)

Creates a new index on disk. The index folder will be cleaned before the index creation.

```csharp
public Index Create(string indexFolder, IndexSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexFolder | String | The index folder. |
| settings | IndexSettings | The index settings. |

##### Return Value

The created index.

##### Examples

The example demonstrates how to create an index on disk through the index repository.

```csharp
string indexFolder = @"c:\MyIndex\";

IndexRepository indexRepository = new IndexRepository();

IndexSettings settings = new IndexSettings();
settings.UseStopWords = false; // Disabling use of stop words during indexing

Index index = indexRepository.Create(indexFolder, settings);
```

### Dispose
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/dispose.md

#### IndexRepository.Dispose method

Releases all resources used by the `IndexRepository`.

```csharp
public void Dispose()
```

### Events
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/events.md

#### IndexRepository.Events property

Gets the event hub for subscribing to events.

```csharp
public EventHub Events { get; }
```

##### Property Value

The event hub for subscribing to events.

### Indexes
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/indexes.md

#### IndexRepository.Indexes property

Gets the indexes contained in this `IndexRepository`.

```csharp
public Index[] Indexes { get; }
```

##### Property Value

The indexes.

### IndexRepository
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/indexrepository.md

#### IndexRepository constructor

Initializes a new instance of the `IndexRepository` class.

```csharp
public IndexRepository()
```

### Search
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/search.md

#### Search(string)

Searches in all indexes of the repository.

```csharp
public SearchResult Search(string query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | String | The search query. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform search in index repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

IndexRepository repository = new IndexRepository();
Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

SearchResult result = repository.Search(query); // Searching
```

#### Search(string, SearchOptions)

Searches in all indexes of the repository.

```csharp
public SearchResult Search(string query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | String | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform search in index repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

IndexRepository repository = new IndexRepository();
Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

SearchOptions options = new SearchOptions();
options.UseCaseSensitiveSearch = true; // Setting flag of case sensitive search

SearchResult result = repository.Search(query, options); // Searching
```

#### Search(SearchQuery)

Searches in all indexes of the repository.

```csharp
public SearchResult Search(SearchQuery query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform search in index repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

IndexRepository repository = new IndexRepository();
Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

SearchQuery query = SearchQuery.CreateWordQuery("Einstein"); // Creating search query in object form

SearchResult result = repository.Search(query); // Searching
```

#### Search(SearchQuery, SearchOptions)

Searches in all indexes of the repository.

```csharp
public SearchResult Search(SearchQuery query, SearchOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The search query. |
| options | SearchOptions | The search options. |

##### Return Value

The search result.

##### Examples

The example demonstrates how to perform search in index repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

IndexRepository repository = new IndexRepository();
Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

SearchOptions options = new SearchOptions();
options.UseCaseSensitiveSearch = true; // Setting flag of case sensitive search

SearchQuery query = SearchQuery.CreateWordQuery("Einstein"); // Creating search query in object form

SearchResult result = repository.Search(query, options); // Searching
```

### Update
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexrepository/update.md

#### Update()

Updates all indexes in the repository.

```csharp
public void Update()
```

##### Examples

The example demonstrates how to update indexes in the repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

IndexRepository repository = new IndexRepository();

Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

// Delete documents from the documents folder or modify them or add new documents to the folder

repository.Update();
```

#### Update(UpdateOptions)

Updates all indexes in the repository.

```csharp
public void Update(UpdateOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | UpdateOptions | The update options. |

##### Examples

The example demonstrates how to update indexes in the repository.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

IndexRepository repository = new IndexRepository();

Index index = repository.Create(indexFolder); // Creating index
index.Add(documentsFolder); // Indexing documents

// Delete documents from the documents folder or modify them or add new documents to the folder

UpdateOptions options = new UpdateOptions();
options.Threads = 2; // Setting the number of indexing threads
repository.Update(options);
```

### IndexSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings.md

#### IndexSettings class

Represents the index settings that allow to customize the indexing operations.

```csharp
public class IndexSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| IndexSettings() | Initializes a new instance of the `IndexSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| CustomExtractors { get; } | Gets the custom extractor collection. |
| DocumentFilter { get; set; } | Gets or sets a document filter. The `DocumentFilter` works on the inclusion logic. Use the `DocumentFilter` class for creation of a document filter instances. The default value is `null`, which means that all added documents are indexed. |
| IndexType { get; set; } | Gets or sets the index type. The default value is NormalIndex. |
| InMemoryIndex { get; } | Gets a value indicating whether the index is stored in memory or on disk. |
| Logger { get; set; } | Gets or sets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded. |
| MaxIndexingReportCount { get; set; } | Gets or sets the maximum number of indexing reports. The default value is `5`. |
| MaxSearchReportCount { get; set; } | Gets or sets the maximum number of search reports. The default value is `10`. |
| SearchThreads { get; set; } | Gets or sets the number of threads used for the search. The default value is Default, which means that the search will be performed using the number of threads equal to the number of processor cores. |
| TextStorageSettings { get; set; } | Gets or sets the text storage settings. The default value is `null`, which means that document texts are not stored. |
| UseCharacterReplacements { get; set; } | Gets or sets a value indicating whether to use character replacements or not. The default value is `false`. |
| UseStopWords { get; set; } | Gets or sets a value indicating whether to use stop words or not. The default value is `true`. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex; // Setting the index type

Index index = new Index(indexFolder, settings); // Creating an index
```

### CustomExtractors
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/customextractors.md

#### IndexSettings.CustomExtractors property

Gets the custom extractor collection.

```csharp
public CustomExtractorCollection CustomExtractors { get; }
```

##### Property Value

The custom extractor collection.

##### Remarks

The full example of implementing a custom extractor is presented in documentation for `IFieldExtractor` interface.

### DocumentFilter
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/documentfilter.md

#### IndexSettings.DocumentFilter property

Gets or sets a document filter. The `DocumentFilter` works on the inclusion logic. Use the `DocumentFilter` class for creation of a document filter instances. The default value is `null`, which means that all added documents are indexed.

```csharp
public DocumentFilter DocumentFilter { get; set; }
```

##### Property Value

The document filter.

##### Examples

The example demonstrates how to set the document filter.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating a filter that skips documents with extensions '.doc', '.docx', '.rtf'
IndexSettings settings = new IndexSettings();
DocumentFilter fileExtensionFilter = DocumentFilter.CreateFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
DocumentFilter invertedFilter = DocumentFilter.CreateNot(fileExtensionFilter); // Inverting file extension filter
settings.DocumentFilter = invertedFilter;

// Creating an index in the specified folder
Index index = new Index(indexFolder, settings);

// Indexing documents
index.Add(documentsFolder);

// Searching
SearchResult result = index.Search("Einstein");
```

### IndexSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/indexsettings.md

#### IndexSettings constructor

Initializes a new instance of the `IndexSettings` class.

```csharp
public IndexSettings()
```

### IndexType
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/indextype.md

#### IndexSettings.IndexType property

Gets or sets the index type. The default value is NormalIndex.

```csharp
public IndexType IndexType { get; set; }
```

##### Property Value

The index type.

### InMemoryIndex
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/inmemoryindex.md

#### IndexSettings.InMemoryIndex property

Gets a value indicating whether the index is stored in memory or on disk.

```csharp
public bool InMemoryIndex { get; }
```

##### Property Value

A value indicating whether the index is stored in memory or on disk.

### Logger
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/logger.md

#### IndexSettings.Logger property

Gets or sets a logger that is used for logging events and errors in the index. Note that the logger is not saved and must be created and assigned each time the index is created or loaded.

```csharp
public ILogger Logger { get; set; }
```

##### Property Value

A logger that is used for logging events and errors in the index.

### MaxIndexingReportCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/maxindexingreportcount.md

#### IndexSettings.MaxIndexingReportCount property

Gets or sets the maximum number of indexing reports. The default value is `5`.

```csharp
public int MaxIndexingReportCount { get; set; }
```

##### Property Value

The maximum number of indexing reports.

### MaxSearchReportCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/maxsearchreportcount.md

#### IndexSettings.MaxSearchReportCount property

Gets or sets the maximum number of search reports. The default value is `10`.

```csharp
public int MaxSearchReportCount { get; set; }
```

##### Property Value

The maximum number of search reports.

### SearchThreads
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/searchthreads.md

#### IndexSettings.SearchThreads property

Gets or sets the number of threads used for the search. The default value is Default, which means that the search will be performed using the number of threads equal to the number of processor cores.

```csharp
public NumberOfThreads SearchThreads { get; set; }
```

##### Property Value

The number of threads used for the search.

### TextStorageSettings
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/textstoragesettings.md

#### IndexSettings.TextStorageSettings property

Gets or sets the text storage settings. The default value is `null`, which means that document texts are not stored.

```csharp
public TextStorageSettings TextStorageSettings { get; set; }
```

##### Property Value

The text storage settings.

##### Examples

The example demonstrates how to set the text storage settings.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating index settings instance
IndexSettings settings = new IndexSettings();
settings.TextStorageSettings = new TextStorageSettings(Compression.High); // Setting high compression level for the index text storage

// Creating an index in the specified folder
Index index = new Index(indexFolder, settings);

// Indexing documents
index.Add(documentsFolder);

// Searching
SearchResult result = index.Search("Einstein");
```

### UseCharacterReplacements
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/usecharacterreplacements.md

#### IndexSettings.UseCharacterReplacements property

Gets or sets a value indicating whether to use character replacements or not. The default value is `false`.

```csharp
public bool UseCharacterReplacements { get; set; }
```

##### Property Value

A value indicating whether to use character replacements or not.

### UseStopWords
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexsettings/usestopwords.md

#### IndexSettings.UseStopWords property

Gets or sets a value indicating whether to use stop words or not. The default value is `true`.

```csharp
public bool UseStopWords { get; set; }
```

##### Property Value

A value indicating whether to use stop words or not.

### IndexUpdater
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexupdater.md

#### IndexUpdater class

Represents an index updater. This class performs reindexing documents in an index of an old version.

```csharp
public class IndexUpdater
```

#### Constructors

| Name | Description |
| --- | --- |
| IndexUpdater() | Initializes a new instance of the `IndexUpdater` class. |

#### Methods

| Name | Description |
| --- | --- |
| CanUpdateVersion(string) | Checks whether an index in the specified directory can be updated to the latest version. |
| IsLatestVersion(string) | Checks whether the specified directory contains an index of the latest version. |
| UpdateVersion(string, string) | Performs reindexing documents in an index of an old version. The updated index will be placed in the *newIndexPath* directory. The index in the *indexPath* directory will not be changed. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string sourceIndexFolder = @"c:\MyOldIndex\";
string targetIndexFolder = @"c:\MyNewIndex\";

IndexUpdater updater = new IndexUpdater();

if (updater.CanUpdateVersion(sourceIndexFolder))
{
    VersionUpdateResult result = updater.UpdateVersion(sourceIndexFolder, targetIndexFolder);
}
```

### CanUpdateVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexupdater/canupdateversion.md

#### IndexUpdater.CanUpdateVersion method

Checks whether an index in the specified directory can be updated to the latest version.

```csharp
public bool CanUpdateVersion(string indexPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | String | The index directory path. |

##### Return Value

`true` if an index in the specified directory can be updated to the latest version; otherwise `false`.

### IndexUpdater
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexupdater/indexupdater.md

#### IndexUpdater constructor

Initializes a new instance of the `IndexUpdater` class.

```csharp
public IndexUpdater()
```

### IsLatestVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexupdater/islatestversion.md

#### IndexUpdater.IsLatestVersion method

Checks whether the specified directory contains an index of the latest version.

```csharp
public bool IsLatestVersion(string indexPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | String | The index directory path. |

##### Return Value

`true` if the specified directory contains an index of the latest version; otherwise `false`.

### UpdateVersion
Path: https://reference.groupdocs.com/search/net/groupdocs.search/indexupdater/updateversion.md

#### IndexUpdater.UpdateVersion method

Performs reindexing documents in an index of an old version. The updated index will be placed in the *newIndexPath* directory. The index in the *indexPath* directory will not be changed.

```csharp
public VersionUpdateResult UpdateVersion(string indexPath, string newIndexPath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| indexPath | String | The index directory path. |
| newIndexPath | String | The directory for the updated index. |

##### Return Value

The result of the index version update operation.

### License
Path: https://reference.groupdocs.com/search/net/groupdocs.search/license.md

#### License class

Provides methods for applying license.

```csharp
public sealed class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initializes a new instance of the `License` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

##### Examples

The example demonstrates how to setup license.

```csharp
License license = new License();
license.SetLicense("C:\\GroupDocs.Search.lic");
```

### License
Path: https://reference.groupdocs.com/search/net/groupdocs.search/license/license.md

#### License constructor

Initializes a new instance of the `License` class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/search/net/groupdocs.search/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The absolute path to a license file. |

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The license stream. |

### Metered
Path: https://reference.groupdocs.com/search/net/groupdocs.search/metered.md

#### Metered class

Provides methods which allow to activate product with Metered license and retrieve amount of MBs processed. Learn more about Metered licenses [here](https://purchase.groupdocs.com/faqs/licensing/metered).

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Initializes a new instance of `Metered` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetMeteredKey(string, string) | Sets metered public and private key. |
| static GetConsumptionCredit() | Gets the consumption credit. |
| static GetConsumptionQuantity() | Gets the consumption quantity. |

##### Examples

The example demonstrates how to set metered public and private keys.

```csharp
Metered metered = new Metered();
metered.SetMeteredKey("PublicKey", "PrivateKey");
```

### GetConsumptionCredit
Path: https://reference.groupdocs.com/search/net/groupdocs.search/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Gets the consumption credit.

```csharp
public static decimal GetConsumptionCredit()
```

##### Return Value

The consumption credit.

### GetConsumptionQuantity
Path: https://reference.groupdocs.com/search/net/groupdocs.search/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Gets the consumption quantity.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

The consumption quantity.

### Metered
Path: https://reference.groupdocs.com/search/net/groupdocs.search/metered/metered.md

#### Metered constructor

Initializes a new instance of `Metered` class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/search/net/groupdocs.search/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 | The public key. |
| privateKey | String | The private key. |

### SearchQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery.md

#### SearchQuery class

Represents a search query in object form.

```csharp
public abstract class SearchQuery
```

#### Properties

| Name | Description |
| --- | --- |
| virtual ChildCount { get; } | Gets the number of child queries. |
| virtual FieldName { get; } | Gets the field name. |
| virtual FirstChild { get; } | Gets the first child query. |
| SearchOptions { get; set; } | Gets or sets the search options of this seach query. |
| virtual SecondChild { get; } | Gets the second child query. |

#### Methods

| Name | Description |
| --- | --- |
| static CreateAndQuery(params SearchQuery[]) | Creates a combined query that will find only documents which will be found for each original query. |
| static CreateAndQuery(SearchQuery, SearchQuery) | Creates a combined query that will find only documents which will be found for each original query. |
| static CreateDateRangeQuery(DateTime, DateTime) | Creates a date range query. |
| static CreateFieldQuery(string, SearchQuery) | Adds a field to the specified query. |
| static CreateNotQuery(SearchQuery) | Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query. |
| static CreateNumericRangeQuery(long, long) | Creates a numeric range query. |
| static CreateOrQuery(params SearchQuery[]) | Creates a combined query that will find all the documents which will be found at least for one of the original queries. |
| static CreateOrQuery(SearchQuery, SearchQuery) | Creates a combined query that will find all the documents which will be found at least for one of the original queries. |
| static CreatePhraseSearchQuery(params SearchQuery[]) | Creates a phrase search query. |
| static CreateRegexQuery(string) | Creates a regular expression query. |
| static CreateRegexQuery(string, RegexOptions) | Creates a regular expression query. |
| static CreateWildcardQuery(int) | Creates a wildcard for the phrase search. |
| static CreateWildcardQuery(int, int) | Creates a wildcard for the phrase search. |
| static CreateWordPatternQuery(WordPattern) | Creates a word pattern query. |
| static CreateWordQuery(string) | Creates a simple word query. |
| abstract GetChild(int) | Gets a child query by an index. |
| abstract ToString() | Returns a String that represents the current `SearchQuery` instance. |

##### Examples

The example demonstrates a typical usage of the class.

```csharp
string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating index in the specified folder
index.Add(documentsFolder); // Indexing documents from the specified folder

// Creating subquery of date range search
SearchQuery subquery1 = SearchQuery.CreateDateRangeQuery(new DateTime(2011, 6, 17), new DateTime(2013, 1, 1));

// Creating subquery of wildcard with number of missed words from 0 to 2
SearchQuery subquery2 = SearchQuery.CreateWildcardQuery(0, 2);

// Creating subquery of simple word
SearchQuery subquery3 = SearchQuery.CreateWordQuery("birth");
subquery3.SearchOptions = new SearchOptions(); // Setting search options only for subquery 3
subquery3.SearchOptions.FuzzySearch.Enabled = true;
subquery3.SearchOptions.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1);

// Combining subqueries into one query
SearchQuery query = SearchQuery.CreatePhraseSearchQuery(subquery1, subquery2, subquery3);

// Creating search options object with increased capacity of found occurrences
SearchOptions options = new SearchOptions(); // Overall search options
options.MaxOccurrenceCountPerTerm = 1000000;
options.MaxTotalOccurrenceCount = 10000000;

SearchResult result = index.Search(query, options); // Searching
```

### ChildCount
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/childcount.md

#### SearchQuery.ChildCount property

Gets the number of child queries.

```csharp
public virtual int ChildCount { get; }
```

##### Property Value

The number of child queries.

### CreateAndQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createandquery.md

#### CreateAndQuery(SearchQuery, SearchQuery)

Creates a combined query that will find only documents which will be found for each original query.

```csharp
public static SearchQuery CreateAndQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```

| Parameter | Type | Description |
| --- | --- | --- |
| leftQuery | SearchQuery | The left child query. |
| rightQuery | SearchQuery | The right child query. |

##### Return Value

A combined AND query.

#### CreateAndQuery(params SearchQuery[])

Creates a combined query that will find only documents which will be found for each original query.

```csharp
public static SearchQuery CreateAndQuery(params SearchQuery[] queries)
```

| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery[] | The child queries. |

##### Return Value

A combined AND query.

### CreateDateRangeQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createdaterangequery.md

#### SearchQuery.CreateDateRangeQuery method

Creates a date range query.

```csharp
public static SearchQuery CreateDateRangeQuery(DateTime start, DateTime end)
```

| Parameter | Type | Description |
| --- | --- | --- |
| start | DateTime | The start value of a range. |
| end | DateTime | The end value of a range. |

##### Return Value

A date range query.

### CreateFieldQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createfieldquery.md

#### SearchQuery.CreateFieldQuery method

Adds a field to the specified query.

```csharp
public static SearchQuery CreateFieldQuery(string fieldName, SearchQuery query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fieldName | String | The field name to search in. |
| query | SearchQuery | The query to add the field. |

##### Return Value

A query with the field to search in.

### CreateNotQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createnotquery.md

#### SearchQuery.CreateNotQuery method

Creates an inverted query that will find the rest documents in an index against ones which will be found for the original query.

```csharp
public static SearchQuery CreateNotQuery(SearchQuery query)
```

| Parameter | Type | Description |
| --- | --- | --- |
| query | SearchQuery | The query to invert. |

##### Return Value

A combined NOT query.

### CreateNumericRangeQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createnumericrangequery.md

#### SearchQuery.CreateNumericRangeQuery method

Creates a numeric range query.

```csharp
public static SearchQuery CreateNumericRangeQuery(long start, long end)
```

| Parameter | Type | Description |
| --- | --- | --- |
| start | Int64 | The start value of a range. |
| end | Int64 | The end value of a range. |

##### Return Value

A numeric range query.

### CreateOrQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createorquery.md

#### CreateOrQuery(SearchQuery, SearchQuery)

Creates a combined query that will find all the documents which will be found at least for one of the original queries.

```csharp
public static SearchQuery CreateOrQuery(SearchQuery leftQuery, SearchQuery rightQuery)
```

| Parameter | Type | Description |
| --- | --- | --- |
| leftQuery | SearchQuery | The left child query. |
| rightQuery | SearchQuery | The right child query. |

##### Return Value

A combined OR query.

#### CreateOrQuery(params SearchQuery[])

Creates a combined query that will find all the documents which will be found at least for one of the original queries.

```csharp
public static SearchQuery CreateOrQuery(params SearchQuery[] queries)
```

| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery[] | The child queries. |

##### Return Value

A combined OR query.

### CreatePhraseSearchQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createphrasesearchquery.md

#### SearchQuery.CreatePhraseSearchQuery method

Creates a phrase search query.

```csharp
public static SearchQuery CreatePhraseSearchQuery(params SearchQuery[] queries)
```

| Parameter | Type | Description |
| --- | --- | --- |
| queries | SearchQuery[] | The child queries. |

##### Return Value

A phrase search query.

### CreateRegexQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createregexquery.md

#### CreateRegexQuery(string)

Creates a regular expression query.

```csharp
public static SearchQuery CreateRegexQuery(string pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern to match. |

##### Return Value

A regular expression query.

#### CreateRegexQuery(string, RegexOptions)

Creates a regular expression query.

```csharp
public static SearchQuery CreateRegexQuery(string pattern, RegexOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | String | The regular expression pattern to match. |
| options | RegexOptions | A bitwise combination of the enumeration values that modify the regular expression. This value must contain IgnoreCase flag. |

##### Return Value

A regular expression query.

### CreateWildcardQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createwildcardquery.md

#### CreateWildcardQuery(int)

Creates a wildcard for the phrase search.

```csharp
public static SearchQuery CreateWildcardQuery(int count)
```

| Parameter | Type | Description |
| --- | --- | --- |
| count | Int32 | The number of words in the wildcard. |

##### Return Value

A wildcard for the phrase search.

#### CreateWildcardQuery(int, int)

Creates a wildcard for the phrase search.

```csharp
public static SearchQuery CreateWildcardQuery(int minCount, int maxCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| minCount | Int32 | The minimum number of words in the wildcard. |
| maxCount | Int32 | The maximum number of words in the wildcard. |

##### Return Value

A wildcard for the phrase search.

### CreateWordPatternQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createwordpatternquery.md

#### SearchQuery.CreateWordPatternQuery method

Creates a word pattern query.

```csharp
public static SearchQuery CreateWordPatternQuery(WordPattern pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | WordPattern | The word pattern. |

##### Return Value

A word pattern query.

### CreateWordQuery
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/createwordquery.md

#### SearchQuery.CreateWordQuery method

Creates a simple word query.

```csharp
public static SearchQuery CreateWordQuery(string term)
```

| Parameter | Type | Description |
| --- | --- | --- |
| term | String | The term to search for. |

##### Return Value

A simple word query.

### FieldName
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/fieldname.md

#### SearchQuery.FieldName property

Gets the field name.

```csharp
public virtual string FieldName { get; }
```

##### Property Value

The field name.

### FirstChild
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/firstchild.md

#### SearchQuery.FirstChild property

Gets the first child query.

```csharp
public virtual SearchQuery FirstChild { get; }
```

##### Property Value

The first child query.

### GetChild
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/getchild.md

#### SearchQuery.GetChild method

Gets a child query by an index.

```csharp
public abstract SearchQuery GetChild(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The index. |

##### Return Value

A child query corresponding the specified index.

### SearchOptions
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/searchoptions.md

#### SearchQuery.SearchOptions property

Gets or sets the search options of this seach query.

```csharp
public SearchOptions SearchOptions { get; set; }
```

##### Property Value

The search options.

### SecondChild
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/secondchild.md

#### SearchQuery.SecondChild property

Gets the second child query.

```csharp
public virtual SearchQuery SecondChild { get; }
```

##### Property Value

The second child query.

### ToString
Path: https://reference.groupdocs.com/search/net/groupdocs.search/searchquery/tostring.md

#### SearchQuery.ToString method

Returns a String that represents the current `SearchQuery` instance.

```csharp
public abstract string ToString()
```

##### Return Value

A String that represents the current `SearchQuery` instance.


# GroupDocs.Signature

> Sign and verify with digital, barcode, QR-code, text, image, and stamp signatures.

## Java

### GroupDocs.Signature for Java
Path: https://reference.groupdocs.com/signature/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.signature | The **GroupDocs.Signature** namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.
 |
| com.groupdocs.signature.domain | The **GroupDocs.Signature.Domain** namespace provides classes for working with document representation.
 |
| com.groupdocs.signature.domain.barcodes | The **GroupDocs.Signature.Domain.Barcodes** namespace provides classes for working with Barcodes
 |
| com.groupdocs.signature.domain.documentpreview | The **GroupDocs.Signature.Domain.DocumentPreview** namespace provides classes for working with document representation.
 |
| com.groupdocs.signature.domain.enums | The **GroupDocs.Signature.Domain.Enums** namespace provides classes for working with Enums
 |
| com.groupdocs.signature.domain.extensions | The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.
 |
| com.groupdocs.signature.domain.extensions.encryption | The **GroupDocs.Signature.Domain.Extensions.Encryption** namespace provides classes for working with Encryption
 |
| com.groupdocs.signature.domain.extensions.hibclic | The **GroupDocs.Signature.Domain.Extensions.HIBCLIC** namespace provides classes for working with HIBCLIC
 |
| com.groupdocs.signature.domain.extensions.mailmark2d | The **GroupDocs.Signature.Domain.Extensions.MailMark2D** namespace provides classes for working with MailMark2D
 |
| com.groupdocs.signature.domain.extensions.serialization | The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.
 |
| com.groupdocs.signature.domain.extensions.signoptions | The **GroupDocs.Signature.Domain.Extensions.SignOptions** namespace provides classes for working with SignOptions
 |
| com.groupdocs.signature.domain.extensions.swissqr | The **GroupDocs.Signature.Domain.Extensions.SwissQR** namespace provides classes for working with SwissQR
 |
| com.groupdocs.signature.domain.interfaces | The **GroupDocs.Signature.Domain.Interfaces** namespace provides classes for working with Interfaces
 |
| com.groupdocs.signature.domain.qrcodes | The **GroupDocs.Signature.Domain.QRCodes** namespace provides classes for working with QRCodes
 |
| com.groupdocs.signature.domain.signatures | The **GroupDocs.Signature.Domain.Signatures** namespace provides classes for working with Signatures
 |
| com.groupdocs.signature.domain.signatures.formfield | The **GroupDocs.Signature.Domain.Signatures.FormField** namespace provides classes for working with FormField signatures
 |
| com.groupdocs.signature.domain.signatures.metadata | The **GroupDocs.Signature.Domain.Signatures.Metadata** namespace provides classes for working with Metadata signatures
 |
| com.groupdocs.signature.domain.stamps | The **GroupDocs.Signature.Domain.Stamps** namespace provides classes for working with Stamps.
 |
| com.groupdocs.signature.domain.structs |  |
| com.groupdocs.signature.exception | The **GroupDocs.Signature.Exception** namespace provides classes to handle Signature exceptions.
 |
| com.groupdocs.signature.handler.events | The **GroupDocs.Signature.Handler.Events** namespace provides classes for input and output Data Handlers.
 |
| com.groupdocs.signature.licensing | The **GroupDocs.Signature.Licensing** namespace provides classes for licensing the Signature library.
 |
| com.groupdocs.signature.logging | The **GroupDocs.Signature.Logging** namespace provides classes for logging purposes.
 |
| com.groupdocs.signature.metered | Provides methods to set metered key.
 |
| com.groupdocs.signature.options | The **GroupDocs.Signature.Options** namespace provides classes to specify additional options when loading, signing, verifyin, searching and saving documents.
 |
| com.groupdocs.signature.options.appearances | The **GroupDocs.Signature.Options.Appearances** namespace provides classes for additional signature appearances.
 |
| com.groupdocs.signature.options.loadoptions | The **GroupDocs.Signature.Options.LoadOptions** namespace provides classes for working with LoadOptions options.
 |
| com.groupdocs.signature.options.preview |  |
| com.groupdocs.signature.options.saveoptions | The **GroupDocs.Signature.Options.SaveOptions** namespace provides classes for working with SaveOptions options.
 |
| com.groupdocs.signature.options.saveoptions.imagessaveoptions | The **GroupDocs.Signature.Options.SaveOptions.ImageSaveOptions** namespace provides classes for working with ImageSaveOptions options.
 |
| com.groupdocs.signature.options.search | The **GroupDocs.Signature.Options.Search** namespace provides classes for working with Search options.
 |
| com.groupdocs.signature.options.sign | The **GroupDocs.Signature.Options.Sign** namespace provides classes for working with Signature options
 |
| com.groupdocs.signature.options.verify | The **GroupDocs.Signature.Options.Verify** namespace provides classes for working with Verification options
 |
| com.groupdocs.signature.options.verifyextensions | The **GroupDocs.Signature.Options.VerifyExtensions** namespace provides classes for working with VerifyExtensions options.
 |

### com.groupdocs.signature.domain.barcodes
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.barcodes.md

The **GroupDocs.Signature.Domain.Barcodes** namespace provides classes for working with Barcodes

#### Classes

| Class | Description |
| --- | --- |
| BarcodeType | Specify Barcode type properties. |
| BarcodeTypes | Barcode Types container. |

### BarcodeType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.barcodes/barcodetype.md

**Inheritance:**
java.lang.Object
```
public final class BarcodeType
```

Specify Barcode type properties.

#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Get Index of object in collection of supported Barcode types.
 |
| getTypeName() | Name of Barcode Type.
 |
| equals(BarcodeType other) | Determines whether the specified BarcodeType is equal to the current object.
 |
| equals(Object obj) | Overridden method determines whether the specified System.Object is equal to the current System.Object.
 |
| hashCode() | Overridden method serves as a hash function for a particular type.
 |
| toString() | Overridden method serves as conversion to string type.
 |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Get Index of object in collection of supported Barcode types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Name of Barcode Type.

**Returns:**
java.lang.String
##### equals(BarcodeType other)
```
public final boolean equals(BarcodeType other)
```

Determines whether the specified BarcodeType is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | BarcodeType | Object for comparison.
 |

**Returns:**
boolean - Result of comparison.

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overridden method determines whether the specified System.Object is equal to the current System.Object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Object for comparison.
 |

**Returns:**
boolean - Result of comparison.

##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash code.

##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - Returns a string that represents the current object.

### BarcodeTypes
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.barcodes/barcodetypes.md

**Inheritance:**
java.lang.Object
```
public class BarcodeTypes
```

Barcode Types container.

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| AustralianPosteParcel | Australian Post eParcel Barcode Type object.
 |
| AustralianPost | Australian Post Barcode Type object.
 |
| Codabar | Codabar Barcode Type object.
 |
| CodablockF | CodablockF Barcode Type object.
 |
| Code11 | Code11 Barcode Type object.
 |
| Code128 | Code128 Barcode Type object.
 |
| Code16K | Code16K Barcode Type object.
 |
| Code32 | Code32 Barcode Type object.
 |
| Code39Extended | Code39Extended Barcode Type object.
 |
| Code39Standard | Code39Standard Barcode Type object.
 |
| Code93Extended | Code93Extended Barcode Type object.
 |
| Code93Standard | Code93Standard Barcode Type object.
 |
| DatabarExpanded | DatabarExpanded Barcode Type object.
 |
| DatabarExpandedStacked | DatabarExpandedStacked Barcode Type object.
 |
| DatabarLimited | DatabarLimited Barcode Type object.
 |
| DatabarOmniDirectional | DatabarOmniDirectional Barcode Type object.
 |
| DatabarStacked | DatabarStacked Barcode Type object.
 |
| DatabarStackedOmniDirectional | DatabarStackedOmniDirectional Barcode Type object.
 |
| DatabarTruncated | DatabarTruncated Barcode Type object.
 |
| DataLogic2of5 | DataLogic2of5 Barcode Type object.
 |
| DeutschePostIdentcode | DeutschePostIdentcode Barcode Type object.
 |
| DeutschePostLeitcode | DeutschePostLeitcode Barcode Type object.
 |
| DotCode | DotCode Barcode Type object.
 |
| DutchKIX | DutchKIX Barcode Type object.
 |
| EAN8 | EAN8 Barcode Type object.
 |
| EAN13 | EAN13 Barcode Type object.
 |
| EAN14 | EAN14 Barcode Type object.
 |
| GS1CodablockF | GS1CodablockF Barcode Type object.
 |
| GS1Code128 | GS1 Code128 Barcode Type object.
 |
| GS1CompositeBar | GS1 Composite Barcode Type object.
 |
| IATA2of5 | IATA2of5 Barcode Type object.
 |
| Interleaved2of5 | Interleaved2of5 Barcode Type object.
 |
| ISBN | ISBN Barcode Type object.
 |
| ISMN | ISMN Barcode Type object.
 |
| ISSN | ISSN Barcode Type object.
 |
| ItalianPost25 | ItalianPost25 Barcode Type object.
 |
| ITF14 | ITF14 Barcode Type object.
 |
| ITF6 | ITF6 Barcode Type object.
 |
| MacroPdf417 | MacroPdf417 Barcode Type object.
 |
| Mailmark | Royal Mail 2D Mailmark Barcode Type object.
 |
| Matrix2of5 | Matrix2of5 Barcode Type object.
 |
| MaxiCode | MaxiCode Barcode Type object.
 |
| MicroPdf417 | MicroPdf417 Barcode Type object.
 |
| MSI | MSI Barcode Type object.
 |
| OneCode | OneCode Barcode Type object.
 |
| OPC | OPC Barcode Type object.
 |
| PatchCode | Patch Code Barcode Type object.
 |
| Pdf417 | Pdf417 Barcode Type object.
 |
| Pharmacode | Pharma code Barcode Type object.
 |
| Planet | Planet Barcode Type object.
 |
| Postnet | Postnet Barcode Type object.
 |
| PZN | PZN Barcode Type object.
 |
| RM4SCC | RM4SCC Barcode Type object.
 |
| SCC14 | SCC14 Barcode Type object.
 |
| SingaporePost | SingaporePost Barcode Type object.
 |
| SSCC18 | SSCC18 Barcode Type object.
 |
| Standard2of5 | Standard2of5 Barcode Type object.
 |
| SwissPostParcel | SwissPostParcel Barcode Type object.
 |
| UPCA | UPCA Barcode Type object.
 |
| UpcaGs1Code128Coupon | UpcaGs1Code128Coupon Barcode Type object.
 |
| UpcaGs1DatabarCoupon | UpcaGs1DatabarCoupon Barcode Type object.
 |
| UPCE | UPCE Barcode Type object.
 |
| VIN | VIN Barcode Type object.
 |
| HIBCCode39LIC | HIBC LIC 39 Barcode Type object.
 |
| HIBCCode128LIC | HIBC LIC 128 Barcode Type object.
 |
| HIBCCode39PAS | HIBC PAS 39 Barcode Type object.
 |
| HIBCCode128PAS | HIBC PAS 128 Barcode Type object.
 |
| GS1DotCode | GS1 DotCode Barcode Type object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All barcode types.
 |
| parse(String parsingType) | Returns Barcode type with pasringType name.
 |
| tryParse(String parsingType) | Returns Barcode type with pasringType name.
 |
| getDecodeTypes() | Internal list of Decode Types for extraction
 |
| find(String encodeTypeName) |  |
| isBarcodeType(String encodeTypeName) |  |
##### BarcodeTypes()
```
public BarcodeTypes()
```

##### AustralianPosteParcel
```
public static final BarcodeType AustralianPosteParcel
```

Australian Post eParcel Barcode Type object.

##### AustralianPost
```
public static final BarcodeType AustralianPost
```

Australian Post Barcode Type object.

##### Codabar
```
public static final BarcodeType Codabar
```

Codabar Barcode Type object.

##### CodablockF
```
public static final BarcodeType CodablockF
```

CodablockF Barcode Type object.

##### Code11
```
public static final BarcodeType Code11
```

Code11 Barcode Type object.

##### Code128
```
public static final BarcodeType Code128
```

Code128 Barcode Type object.

##### Code16K
```
public static final BarcodeType Code16K
```

Code16K Barcode Type object.

##### Code32
```
public static final BarcodeType Code32
```

Code32 Barcode Type object.

##### Code39Extended
```
public static final BarcodeType Code39Extended
```

Code39Extended Barcode Type object.

##### Code39Standard
```
public static final BarcodeType Code39Standard
```

Code39Standard Barcode Type object.

##### Code93Extended
```
public static final BarcodeType Code93Extended
```

Code93Extended Barcode Type object.

##### Code93Standard
```
public static final BarcodeType Code93Standard
```

Code93Standard Barcode Type object.

##### DatabarExpanded
```
public static final BarcodeType DatabarExpanded
```

DatabarExpanded Barcode Type object.

##### DatabarExpandedStacked
```
public static final BarcodeType DatabarExpandedStacked
```

DatabarExpandedStacked Barcode Type object.

##### DatabarLimited
```
public static final BarcodeType DatabarLimited
```

DatabarLimited Barcode Type object.

##### DatabarOmniDirectional
```
public static final BarcodeType DatabarOmniDirectional
```

DatabarOmniDirectional Barcode Type object.

##### DatabarStacked
```
public static final BarcodeType DatabarStacked
```

DatabarStacked Barcode Type object.

##### DatabarStackedOmniDirectional
```
public static final BarcodeType DatabarStackedOmniDirectional
```

DatabarStackedOmniDirectional Barcode Type object.

##### DatabarTruncated
```
public static final BarcodeType DatabarTruncated
```

DatabarTruncated Barcode Type object.

##### DataLogic2of5
```
public static final BarcodeType DataLogic2of5
```

DataLogic2of5 Barcode Type object.

##### DeutschePostIdentcode
```
public static final BarcodeType DeutschePostIdentcode
```

DeutschePostIdentcode Barcode Type object.

##### DeutschePostLeitcode
```
public static final BarcodeType DeutschePostLeitcode
```

DeutschePostLeitcode Barcode Type object.

##### DotCode
```
public static final BarcodeType DotCode
```

DotCode Barcode Type object.

##### DutchKIX
```
public static final BarcodeType DutchKIX
```

DutchKIX Barcode Type object.

##### EAN8
```
public static final BarcodeType EAN8
```

EAN8 Barcode Type object.

##### EAN13
```
public static final BarcodeType EAN13
```

EAN13 Barcode Type object.

##### EAN14
```
public static final BarcodeType EAN14
```

EAN14 Barcode Type object.

##### GS1CodablockF
```
public static final BarcodeType GS1CodablockF
```

GS1CodablockF Barcode Type object.

##### GS1Code128
```
public static final BarcodeType GS1Code128
```

GS1 Code128 Barcode Type object.

##### GS1CompositeBar
```
public static final BarcodeType GS1CompositeBar
```

GS1 Composite Barcode Type object.

##### IATA2of5
```
public static final BarcodeType IATA2of5
```

IATA2of5 Barcode Type object.

##### Interleaved2of5
```
public static final BarcodeType Interleaved2of5
```

Interleaved2of5 Barcode Type object.

##### ISBN
```
public static final BarcodeType ISBN
```

ISBN Barcode Type object.

##### ISMN
```
public static final BarcodeType ISMN
```

ISMN Barcode Type object.

##### ISSN
```
public static final BarcodeType ISSN
```

ISSN Barcode Type object.

##### ItalianPost25
```
public static final BarcodeType ItalianPost25
```

ItalianPost25 Barcode Type object.

##### ITF14
```
public static final BarcodeType ITF14
```

ITF14 Barcode Type object.

##### ITF6
```
public static final BarcodeType ITF6
```

ITF6 Barcode Type object.

##### MacroPdf417
```
public static final BarcodeType MacroPdf417
```

MacroPdf417 Barcode Type object.

##### Mailmark
```
public static final BarcodeType Mailmark
```

Royal Mail 2D Mailmark Barcode Type object.

##### Matrix2of5
```
public static final BarcodeType Matrix2of5
```

Matrix2of5 Barcode Type object.

##### MaxiCode
```
public static final BarcodeType MaxiCode
```

MaxiCode Barcode Type object.

##### MicroPdf417
```
public static final BarcodeType MicroPdf417
```

MicroPdf417 Barcode Type object.

##### MSI
```
public static final BarcodeType MSI
```

MSI Barcode Type object.

##### OneCode
```
public static final BarcodeType OneCode
```

OneCode Barcode Type object.

##### OPC
```
public static final BarcodeType OPC
```

OPC Barcode Type object.

##### PatchCode
```
public static final BarcodeType PatchCode
```

Patch Code Barcode Type object.

##### Pdf417
```
public static final BarcodeType Pdf417
```

Pdf417 Barcode Type object.

##### Pharmacode
```
public static final BarcodeType Pharmacode
```

Pharma code Barcode Type object.

##### Planet
```
public static final BarcodeType Planet
```

Planet Barcode Type object.

##### Postnet
```
public static final BarcodeType Postnet
```

Postnet Barcode Type object.

##### PZN
```
public static final BarcodeType PZN
```

PZN Barcode Type object.

##### RM4SCC
```
public static final BarcodeType RM4SCC
```

RM4SCC Barcode Type object.

##### SCC14
```
public static final BarcodeType SCC14
```

SCC14 Barcode Type object.

##### SingaporePost
```
public static final BarcodeType SingaporePost
```

SingaporePost Barcode Type object.

##### SSCC18
```
public static final BarcodeType SSCC18
```

SSCC18 Barcode Type object.

##### Standard2of5
```
public static final BarcodeType Standard2of5
```

Standard2of5 Barcode Type object.

##### SwissPostParcel
```
public static final BarcodeType SwissPostParcel
```

SwissPostParcel Barcode Type object.

##### UPCA
```
public static final BarcodeType UPCA
```

UPCA Barcode Type object.

##### UpcaGs1Code128Coupon
```
public static final BarcodeType UpcaGs1Code128Coupon
```

UpcaGs1Code128Coupon Barcode Type object.

##### UpcaGs1DatabarCoupon
```
public static final BarcodeType UpcaGs1DatabarCoupon
```

UpcaGs1DatabarCoupon Barcode Type object.

##### UPCE
```
public static final BarcodeType UPCE
```

UPCE Barcode Type object.

##### VIN
```
public static final BarcodeType VIN
```

VIN Barcode Type object.

##### HIBCCode39LIC
```
public static final BarcodeType HIBCCode39LIC
```

HIBC LIC 39 Barcode Type object.

##### HIBCCode128LIC
```
public static final BarcodeType HIBCCode128LIC
```

HIBC LIC 128 Barcode Type object.

##### HIBCCode39PAS
```
public static final BarcodeType HIBCCode39PAS
```

HIBC PAS 39 Barcode Type object.

##### HIBCCode128PAS
```
public static final BarcodeType HIBCCode128PAS
```

HIBC PAS 128 Barcode Type object.

##### GS1DotCode
```
public static final BarcodeType GS1DotCode
```

GS1 DotCode Barcode Type object.

##### getAllTypes()
```
public static BarcodeType[] getAllTypes()
```

All barcode types.

**Returns:**
com.groupdocs.signature.domain.barcodes.BarcodeType[]
##### parse(String parsingType)
```
public static BarcodeType parse(String parsingType)
```

Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of barcode type name.
 |

**Returns:**
BarcodeType - BarcodeType instance.

##### tryParse(String parsingType)
```
public static BarcodeType tryParse(String parsingType)
```

Returns Barcode type with pasringType name. If name of Barcode is unknown -
no Exception will be thrown but method will return null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of barcode type name.
 |

**Returns:**
BarcodeType - BarcodeType instance.

##### getDecodeTypes()
```
public static System.Collections.Generic.List<BaseDecodeType> getDecodeTypes()
```

Internal list of Decode Types for extraction

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.aspose.barcode.barcoderecognition.BaseDecodeType>
##### find(String encodeTypeName)
```
public static BarcodeType find(String encodeTypeName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeTypeName | java.lang.String |  |

**Returns:**
BarcodeType
##### isBarcodeType(String encodeTypeName)
```
public static boolean isBarcodeType(String encodeTypeName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeTypeName | java.lang.String |  |

**Returns:**
boolean

### com.groupdocs.signature.domain.documentpreview
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.documentpreview.md

The **GroupDocs.Signature.Domain.DocumentPreview** namespace provides classes for working with document representation.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Defines document description properties. |
| FileType | Represents file type. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines document description properties. |

### DocumentInfo
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.documentpreview/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.documentpreview.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Defines document description properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo() | Initializes a new instance of the DocumentInfo class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageCount() | Document pages count.
 |
| setPageCount(int value) | Document pages count.
 |
| getPages() | Collection of document pages descriptions.
 |
| setPages(List<PageInfo> value) | Collection of document pages descriptions.
 |
| getWidthForMaxHeight() | Specifies width for max page height.
 |
| setWidthForMaxHeight(int value) | Specifies width for max page height.
 |
| getMaxPageHeight() | Specifies max page height.
 |
| setMaxPageHeight(int value) | Specifies max page height.
 |
| getFileType() | File format type.
 |
| setFileType(FileType value) | File format type.
 |
| getSize() | Document size in bytes.
 |
| setSize(long value) | Document size in bytes.
 |
| addPage(int pageWidth, int pageHeight, int pageIndex) |  |
| getTextSignatures() | Collection of document text signatures.
 |
| getImageSignatures() | Collection of document image signatures added or updated by Signature methods.
 |
| getDigitalSignatures() | Collection of document digital signatures added or updated by Signature methods.
 |
| getBarcodeSignatures() | Collection of document barcode signatures added or updated by Signature methods.
 |
| getQrCodeSignatures() | Collection of document QR-code signatures added or updated by Signature methods.
 |
| getFormFieldSignatures() | Collection of document Form Field signatures added or updated by Signature methods.
 |
| getFormFields() | Collection of all existing supported Form Fields in the document.
 |
| getMetadataSignatures() | Collection of document Metadata signatures.
 |
| getProcessLogs() | Collection of document history processes like Sign, Update, Delete.
 |
| getSignatures() | Collection of document all types signatures BaseSignature.
 |
##### DocumentInfo()
```
public DocumentInfo()
```

Initializes a new instance of the DocumentInfo class.

##### getPageCount()
```
public final int getPageCount()
```

Document pages count.

**Returns:**
int
##### setPageCount(int value)
```
public final void setPageCount(int value)
```

Document pages count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPages()
```
public final List<PageInfo> getPages()
```

Collection of document pages descriptions.

**Returns:**
java.util.List<com.groupdocs.signature.domain.PageInfo>
##### setPages(List<PageInfo> value)
```
public final void setPages(List<PageInfo> value)
```

Collection of document pages descriptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.domain.PageInfo> |  |

##### getWidthForMaxHeight()
```
public final int getWidthForMaxHeight()
```

Specifies width for max page height.

**Returns:**
int
##### setWidthForMaxHeight(int value)
```
public final void setWidthForMaxHeight(int value)
```

Specifies width for max page height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMaxPageHeight()
```
public final int getMaxPageHeight()
```

Specifies max page height.

**Returns:**
int
##### setMaxPageHeight(int value)
```
public final void setMaxPageHeight(int value)
```

Specifies max page height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileType()
```
public final FileType getFileType()
```

File format type.

**Returns:**
FileType
##### setFileType(FileType value)
```
public final void setFileType(FileType value)
```

File format type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### getSize()
```
public final long getSize()
```

Document size in bytes.

**Returns:**
long
##### setSize(long value)
```
public final void setSize(long value)
```

Document size in bytes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### addPage(int pageWidth, int pageHeight, int pageIndex)
```
public final PageInfo addPage(int pageWidth, int pageHeight, int pageIndex)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | int |  |
| pageHeight | int |  |
| pageIndex | int |  |

**Returns:**
PageInfo
##### getTextSignatures()
```
public final List<TextSignature> getTextSignatures()
```

Collection of document text signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.TextSignature>
##### getImageSignatures()
```
public final List<ImageSignature> getImageSignatures()
```

Collection of document image signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.ImageSignature>
##### getDigitalSignatures()
```
public final List<DigitalSignature> getDigitalSignatures()
```

Collection of document digital signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature>
##### getBarcodeSignatures()
```
public final List<BarcodeSignature> getBarcodeSignatures()
```

Collection of document barcode signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BarcodeSignature>
##### getQrCodeSignatures()
```
public final List<QrCodeSignature> getQrCodeSignatures()
```

Collection of document QR-code signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.QrCodeSignature>
##### getFormFieldSignatures()
```
public final List<FormFieldSignature> getFormFieldSignatures()
```

Collection of document Form Field signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
##### getFormFields()
```
public final List<FormFieldSignature> getFormFields()
```

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
##### getMetadataSignatures()
```
public final List<MetadataSignature> getMetadataSignatures()
```

Collection of document Metadata signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature>
##### getProcessLogs()
```
public final List<ProcessLog> getProcessLogs()
```

Collection of document history processes like Sign, Update, Delete.

**Returns:**
java.util.List<com.groupdocs.signature.domain.ProcessLog>
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

Collection of document all types signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### FileType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.documentpreview/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents file type.

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type.
 |
| TIF | Tagged Image File (.tif) represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
 |
| TIFF | Tagged Image File Format (.tiff) represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
 |
| JPG | JPEG Image (.jpg) is a type of image format that is saved using the method of lossy compression.
 |
| JPEG | JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression.
 |
| PNG | Portable Network Graphic (.png) is a type of raster image file format that use lossless compression.
 |
| GIF | Graphical Interchange Format File (.gif) is a type of highly compressed image.
 |
| BMP | Bitmap Image File (.bmp) is used to store bitmap digital images.
 |
| WMF | Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data.
 |
| EMF | Enhanced Windows Metafile (.emf) represents graphical images device-independently.
 |
| WEBP | WebP Image (.webp) is a modern raster web image file format that is based on lossless and lossy compression.
 |
| DJVU | DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs.
 |
| CGM | Computer Graphics Metafile (.cgm) is a free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text.
 |
| CDR | CorelDraw Vector Graphic Drawing (.cdr) is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed.
 |
| CMX | CorelDRAW Metafile Exchange Image File (.cmx)
 |
| PCL | Printer Command Language Document (.pcl)
 |
| PSD | Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development.
 |
| DCM | DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
 |
| PS | PostScript File (.ps)
 |
| EPS | Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page.
 |
| ODG | OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
 |
| SVG | Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image.
 |
| PDF | Portable Document Format File (.pdf) is a type of document created by Adobe back in 1990s.
 |
| PPT | PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow.
 |
| PPTX | PowerPoint Open XML Presentation (.pptx) are presentation files created with popular Microsoft PowerPoint application.
 |
| PPS | PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose.
 |
| PPSX | PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
 |
| ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard.
 |
| POT | PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
 |
| PPTM | PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
 |
| POTX | PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
 |
| POTM | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) are Microsoft PowerPoint template files with support for Macros.
 |
| PPSM | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
 |
| OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format.
 |
| XLS | Excel Spreadsheet (.xls) represents Excel Binary File Format.
 |
| XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
 |
| XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros.
 |
| XLT | Excel binary Template (.xlt) represents Excel Template File Format.
 |
| XLTM | Excel Office OpenXML file Template (.xltm) represents Excel Template File Format.
 |
| XLSB | Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
 |
| CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values.
 |
| TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format.
 |
| ODS | OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user.
 |
| OTS | OpenDocument Spreadsheet Template (.ots)
 |
| DOC | Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format.
 |
| DOCX | Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents.
 |
| DOCM | Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros.
 |
| DOT | Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files.
 |
| DOTX | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files.
 |
| DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher.
 |
| RTF | Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications.
 |
| TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines.
 |
| ODT | OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format.
 |
| OTT | OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
 |
| VCF | vCard File (.vcf) is a digital file format for storing contact information.
 |
| WPD | WordPerfect Document (.wpd)
 |
| AZW3 | WordPerfect Document (.wpd)
 |
| PFX | Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application.
 |
| ZIP | Document ZIP archive (.zip) is an archive file format that supports lossless data compression.
 |
| TAR | Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | File type name e.g.
 |
| getExtension() | Filename suffix (including the period ".") e.g.
 |
| fromExtension(String extension) | Maps file extension to file type.
 |
| getSupportedFileTypes() | Retrieves supported file types
 |
| equals(FileType other) | Determines whether the current FileType is the same as specified FileType object.
 |
| equals(Object obj) | Determines whether the current FileType is the same as specified object.
 |
| op_Equality(FileType left, FileType right) | Determines whether two FileType objects are the same.
 |
| op_Inequality(FileType left, FileType right) | Determines whether two FileType objects are not the same.
 |
| toString() | Returns a string that represents the current object.
 |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### TIF
```
public static final FileType TIF
```

Tagged Image File (.tif) 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
.

##### TIFF
```
public static final FileType TIFF
```

Tagged Image File Format (.tiff) 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 FileType JPG
```

JPEG Image (.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 FileType JPEG
```

JPEG Image (.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 FileType PNG
```

Portable Network Graphic (.png) is a type of raster image file format that use lossless 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 FileType GIF
```

Graphical Interchange Format File (.gif) 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 FileType BMP
```

Bitmap Image File (.bmp) is 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
.

##### WMF
```
public static final FileType WMF
```

Windows Metafile (.wmf) represents 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 FileType EMF
```

Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files 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
.

##### WEBP
```
public static final FileType WEBP
```

WebP Image (.webp) 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
.

##### DJVU
```
public static final FileType DJVU
```

DjVu Image (.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
.

##### CGM
```
public static final FileType CGM
```

Computer Graphics Metafile (.cgm) is a 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
.

##### CDR
```
public static final FileType CDR
```

CorelDraw Vector Graphic Drawing (.cdr) 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 FileType CMX
```

CorelDRAW Metafile Exchange Image File (.cmx)

##### PCL
```
public static final FileType PCL
```

Printer Command Language Document (.pcl)

##### PSD
```
public static final FileType PSD
```

Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development.
Learn more about this file format
here
.

##### DCM
```
public static final FileType DCM
```

DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
Learn more about this file format
here
.

##### PS
```
public static final FileType PS
```

PostScript File (.ps)

##### EPS
```
public static final FileType EPS
```

Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page.
Learn more about this file format
here
.

##### ODG
```
public static final FileType ODG
```

OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
Learn more about this file format
here
.

##### SVG
```
public static final FileType SVG
```

Scalable Vector Graphics File (.svg) 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
.

##### PDF
```
public static final FileType PDF
```

Portable Document Format File (.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
.

##### PPT
```
public static final FileType PPT
```

PowerPoint Presentation (.ppt) 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
.

##### PPTX
```
public static final FileType PPTX
```

PowerPoint Open XML Presentation (.pptx) 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
.

##### PPS
```
public static final FileType PPS
```

PowerPoint Slide Show (.pps) 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
.

##### PPSX
```
public static final FileType PPSX
```

PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
Learn more about this file format
here
.

##### ODP
```
public static final FileType ODP
```

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard.
Learn more about this file format
here
.

##### POT
```
public static final FileType POT
```

PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
Learn more about this file format
here
.

##### PPTM
```
public static final FileType PPTM
```

PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
Learn more about this file format
here
.

##### POTX
```
public static final FileType POTX
```

PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
Learn more about this file format
here
.

##### POTM
```
public static final FileType POTM
```

PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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
.

##### PPSM
```
public static final FileType PPSM
```

PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
Learn more about this file format
here
.

##### OTP
```
public static final FileType OTP
```

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format.
Learn more about this file format
here
.

##### XLS
```
public static final FileType XLS
```

Excel Spreadsheet (.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 FileType XLSX
```

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 FileType XLSM
```

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros.
Learn more about this file format
here
.

##### XLT
```
public static final FileType XLT
```

Excel binary Template (.xlt) represents Excel Template File Format.
Learn more about this file format
here
.

##### XLTM
```
public static final FileType XLTM
```

Excel Office OpenXML file Template (.xltm) represents Excel Template File Format.
Learn more about this file format
here
.

##### XLSB
```
public static final FileType XLSB
```

Excel Binary Spreadsheet (.xlsb) 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
.

##### CSV
```
public static final FileType CSV
```

Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values.
Learn more about this file format
here
.

##### TSV
```
public static final FileType TSV
```

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format.
Learn more about this file format
here
.

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet (.ods) stands 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 FileType OTS
```

OpenDocument Spreadsheet Template (.ots)

##### DOC
```
public static final FileType DOC
```

Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format.
Learn more about this file format
here
.

##### DOCX
```
public static final FileType DOCX
```

Microsoft Word Open XML Document (.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
.

##### DOCM
```
public static final FileType DOCM
```

Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros.
Learn more about this file format
here
.

##### DOT
```
public static final FileType DOT
```

Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files.
Learn more about this file format
here
.

##### DOTX
```
public static final FileType DOTX
```

Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files.
Learn more about this file format
here
.

##### DOTM
```
public static final FileType DOTM
```

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher.
Learn more about this file format
here
.

##### RTF
```
public static final FileType RTF
```

Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications.
Learn more about this file format
here
.

##### TXT
```
public static final FileType TXT
```

Plain Text File (.txt) represents a text document that contains plain text in the form of lines.
Learn more about this file format
here
.

##### ODT
```
public static final FileType ODT
```

OpenDocument Text Document (.odt) 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 FileType OTT
```

OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
Learn more about this file format
here
.

##### VCF
```
public static final FileType VCF
```

vCard File (.vcf) 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
.

##### WPD
```
public static final FileType WPD
```

WordPerfect Document (.wpd)

##### AZW3
```
public static final FileType AZW3
```

WordPerfect Document (.wpd)

##### PFX
```
public static final FileType PFX
```

Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application.
Learn more about this file format
here
.

##### ZIP
```
public static final FileType ZIP
```

Document ZIP archive (.zip) is an archive file format that supports lossless data compression.
Can hold one or more files or directories.
Learn more about this file format
here
.

##### TAR
```
public static final FileType TAR
```

Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories.
Learn more about this file format
here
.

##### getFileFormat()
```
public final String getFileFormat()
```

File type name e.g. "Microsoft Word Document".

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

Filename suffix (including the period ".") e.g. ".doc".

**Returns:**
java.lang.String
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period ".").
 |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default #Unknown.Unknown file type.

##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.util.List<com.groupdocs.signature.domain.documentpreview.FileType> - Returns sequence of supported file types

##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current FileType is the same as specified FileType object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current FileType object.
 |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are the same; otherwise,

```
false
```


### equals(Object obj) {#equals-java.lang.Object-}
```
public boolean equals(Object obj)
```


Determines whether the current [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) is the same as specified object.


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object.
 |

**Returns:**
boolean - ```
true
```

if

```
obj
```

parameter is FileType and is the same as current FileType object; otherwise,

```
false
```

##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two FileType objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object.
 |
| right | FileType | Right FileType object.
 |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are the same; otherwise,

```
false
```


### op_Inequality(FileType left, FileType right) {#op-Inequality-com.groupdocs.signature.domain.documentpreview.FileType-com.groupdocs.signature.domain.documentpreview.FileType-}
```
public static boolean op_Inequality(FileType left, FileType right)
```


Determines whether two [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are not the same.


**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) | Left [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object.
 |
| right | [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) | Right [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object.
 |

**Returns:**
boolean - ```
true
```

if both FileType objects are not the same; otherwise,

```
false
```

##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### IDocumentInfo
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.documentpreview/idocumentinfo.md

### com.groupdocs.signature.domain.enums
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums.md

The **GroupDocs.Signature.Domain.Enums** namespace provides classes for working with Enums

#### Classes

| Class | Description |
| --- | --- |
| CodeTextAlignment | Alignment of code text for Bar-codes and QR-codes. |
| DashStyle | Represents style of dash drawing lines on documents. |
| DocumentType | Defines document type. |
| FormFieldType | Specifies Form Field type. |
| FormTextFieldType | Defines types of text for WordsProcessing document form fields. |
| HorizontalAlignment | Specifies horizontal alignment of element on Document Page. |
| MeasureType | Specifies measure units of signature on document page. |
| PdfDigitalSignatureType | Describes enumeration of PDF digital signature type. |
| PdfSaveFileFormat | Define different save file formats. |
| PdfTextAnnotationBorderEffect | Describes effect which should be applied to the border of the PDF Text Annotations. |
| PdfTextStickerIcon | Describes enumeration of PDF Text Annotation Sticker Icon appearance. |
| PdfTextStickerState | Describes enumeration of PDF Text Annotation Sticker States. |
| PresentationSaveFileFormat | Defines different save file formats. |
| ProcessStatus | Specifies status of signing and verification processes. |
| ProcessType | Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete |
| ShapePosition | Specifies shape position in the document layout |
| SignatureType | Signature Type define the method to sign. |
| SpreadsheetSaveFileFormat | Defines different save formats for Spreadsheet documents. |
| StretchMode | Represents Stretch Mode of Signature area on Document Page. |
| TextHorizontalAlignment | Specifies text horizontal alignment inside a Signature. |
| TextMatchType | Specifies Text Match type in string - Exact, StartsWith, EndsWith, Contains. |
| TextShapeType | Specifies types of text shapes. |
| TextSignatureImplementation | Specifies type of implementation for PDF text signature. |
| TextVerticalAlignment | Specifies text vertical alignment inside a Signature. |
| VerticalAlignment | Specifies vertical alignment of element on Document Page. |
| WordProcessingSaveFileFormat | Defines different save file formats for WordProcessing documents. |
| WordProcessingTextSignatureImplementation | Specifies type of text signature implementation for WordProcessing documents. |
| XAdESType | Type of XML Advanced Electronic Signature (XAdES). |

### CodeTextAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/codetextalignment.md

**Inheritance:**
java.lang.Object
```
public final class CodeTextAlignment
```

Alignment of code text for Bar-codes and QR-codes.

#### Fields

| Field | Description |
| --- | --- |
| None | Text is not visible.
 |
| Above | Text is above the code.
 |
| Below | Text is below the code.
 |
##### None
```
public static final int None
```

Text is not visible.

##### Above
```
public static final int Above
```

Text is above the code.

##### Below
```
public static final int Below
```

Text is below the code.

### DashStyle
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/dashstyle.md

**Inheritance:**
java.lang.Object
```
public final class DashStyle
```

Represents style of dash drawing lines on documents.

#### Fields

| Field | Description |
| --- | --- |
| Solid | Represent a solid line.
 |
| ShortDash | Represent a short dash line.
 |
| ShortDot | Represent a short dot line.
 |
| ShortDashDot | Represent a short dash-dot line.
 |
| ShortDashDotDot | Represent a short dash-dot-dot line.
 |
| Dot | Represent a square dot style.
 |
| Dash | Represent a dash line style.
 |
| LongDash | Represent a long dash style.
 |
| DashDot | Dash short dash.
 |
| LongDashDot | Long dash short dash.
 |
| LongDashDotDot | Long dash short dash short dash.
 |
| RoundDot | Represents a round-dot line.
 |
| SquareDot | Represents a square-dot line.
 |
| DashDotDot | Represents a dash-dot-dot line.
 |
| DashLongDash | Represents a long dash-short dash line.
 |
| DashLongDashDot | Represents a long dash-short dash-dot line.
 |
##### Solid
```
public static final int Solid
```

Represent a solid line.

##### ShortDash
```
public static final int ShortDash
```

Represent a short dash line.

##### ShortDot
```
public static final int ShortDot
```

Represent a short dot line.

##### ShortDashDot
```
public static final int ShortDashDot
```

Represent a short dash-dot line.

##### ShortDashDotDot
```
public static final int ShortDashDotDot
```

Represent a short dash-dot-dot line.

##### Dot
```
public static final int Dot
```

Represent a square dot style.

##### Dash
```
public static final int Dash
```

Represent a dash line style.

##### LongDash
```
public static final int LongDash
```

Represent a long dash style.

##### DashDot
```
public static final int DashDot
```

Dash short dash.

##### LongDashDot
```
public static final int LongDashDot
```

Long dash short dash.

##### LongDashDotDot
```
public static final int LongDashDotDot
```

Long dash short dash short dash.

##### RoundDot
```
public static final int RoundDot
```

Represents a round-dot line.

##### SquareDot
```
public static final int SquareDot
```

Represents a square-dot line.

##### DashDotDot
```
public static final int DashDotDot
```

Represents a dash-dot-dot line.

##### DashLongDash
```
public static final int DashLongDash
```

Represents a long dash-short dash line.

##### DashLongDashDot
```
public static final int DashLongDashDot
```

Represents a long dash-short dash-dot line.

### DocumentType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/documenttype.md

**Inheritance:**
java.lang.Object
```
public final class DocumentType
```

Defines document type.

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown document type.
 |
| Pdf | PDF Document Type.
 |
| WordProcessing | Word Processing Document Type.
 |
| Presentation | Presentation Document Type.
 |
| Spreadsheet | Spreadsheet Document Type.
 |
| Image | Image Document Type.
 |
| Certificate | Certificate file Type.
 |
| Archive | Archive file type.
 |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown document type.

##### Pdf
```
public static final int Pdf
```

PDF Document Type.

##### WordProcessing
```
public static final int WordProcessing
```

Word Processing Document Type.

##### Presentation
```
public static final int Presentation
```

Presentation Document Type.

##### Spreadsheet
```
public static final int Spreadsheet
```

Spreadsheet Document Type.

##### Image
```
public static final int Image
```

Image Document Type.

##### Certificate
```
public static final int Certificate
```

Certificate file Type.

##### Archive
```
public static final int Archive
```

Archive file type.

### FormFieldType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/formfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormFieldType
```

Specifies Form Field type.

#### Fields

| Field | Description |
| --- | --- |
| Text | Simple text input.
 |
| Checkbox |  |
| Combobox | Combo-box
 |
| DigitalSignature | Digital signature area.
 |
| Radio | Radio-button
 |
##### Text
```
public static final int Text
```

Simple text input.

##### Checkbox
```
public static final int Checkbox
```

##### Combobox
```
public static final int Combobox
```

Combo-box

##### DigitalSignature
```
public static final int DigitalSignature
```

Digital signature area.

##### Radio
```
public static final int Radio
```

Radio-button

### FormTextFieldType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/formtextfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormTextFieldType
```

Defines types of text for WordsProcessing document form fields.

#### Fields

| Field | Description |
| --- | --- |
| AllTextTypes | Form field with any type.
 |
| PlainText | Form field with plain text type.
 |
| RichText | Form field with rich text type.
 |
##### AllTextTypes
```
public static final int AllTextTypes
```

Form field with any type.

##### PlainText
```
public static final int PlainText
```

Form field with plain text type.

##### RichText
```
public static final int RichText
```

Form field with rich text type.

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/horizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class HorizontalAlignment
```

Specifies horizontal alignment of element on Document Page.

#### Fields

| Field | Description |
| --- | --- |
| None | The object is explicitly positioned, usually using its Left property.
 |
| Left | Specifies that the object shall be left aligned to the horizontal alignment base.
 |
| Center | Specifies that the object shall be centered with respect to the horizontal alignment base.
 |
| Right | Specifies that the object shall be right aligned to the horizontal alignment base.
 |
#### Methods

| Method | Description |
| --- | --- |
| getValues() |  |
##### None
```
public static final int None
```

The object is explicitly positioned, usually using its Left property.

##### Left
```
public static final int Left
```

Specifies that the object shall be left aligned to the horizontal alignment base.

##### Center
```
public static final int Center
```

Specifies that the object shall be centered with respect to the horizontal alignment base.

##### Right
```
public static final int Right
```

Specifies that the object shall be right aligned to the horizontal alignment base.

##### getValues()
```
public static int[] getValues()
```

**Returns:**
int[]

### MeasureType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/measuretype.md

**Inheritance:**
java.lang.Object
```
public final class MeasureType
```

Specifies measure units of signature on document page.

#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels.
 |
| Percents | Percents of page size.
 |
| Millimeters | Millimeters.
 |
##### Pixels
```
public static final int Pixels
```

Pixels.

##### Percents
```
public static final int Percents
```

Percents of page size.

##### Millimeters
```
public static final int Millimeters
```

Millimeters.

### PdfDigitalSignatureType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/pdfdigitalsignaturetype.md

**Inheritance:**
java.lang.Object
```
public final class PdfDigitalSignatureType
```

Describes enumeration of PDF digital signature type.

#### Fields

| Field | Description |
| --- | --- |
| Signature | Digital signature.
 |
| Certificate | Digital certificate.
 |
##### Signature
```
public static final int Signature
```

Digital signature.

##### Certificate
```
public static final int Certificate
```

Digital certificate. Each document could be certified only once.

### PdfSaveFileFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/pdfsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class PdfSaveFileFormat
```

Define different save file formats.

#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed.
 |
| Pdf | Saves the document as PDF (Adobe Portable Document) Format.
 |
| Doc | Saves the document in the Microsoft Word 97-2007 Document Format.
 |
| Xps | Saves the document in the XPS (XML Paper Specification) Format.
 |
| DocX | Saves the document in Microsoft Word Open XML File format.
 |
| Svg | Saves the document in the SVG (Scalable Vector Graphics) format.
 |
| Epub | Saves the document in the IDPF EPUB format.
 |
| Pptx | Saves the document in the PowerPoint Open XML Presentation File format
 |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Pdf
```
public static final int Pdf
```

Saves the document as PDF (Adobe Portable Document) Format.

##### Doc
```
public static final int Doc
```

Saves the document in the Microsoft Word 97-2007 Document Format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) Format.

##### DocX
```
public static final int DocX
```

Saves the document in Microsoft Word Open XML File format.

##### Svg
```
public static final int Svg
```

Saves the document in the SVG (Scalable Vector Graphics) format.

##### Epub
```
public static final int Epub
```

Saves the document in the IDPF EPUB format.

##### Pptx
```
public static final int Pptx
```

Saves the document in the PowerPoint Open XML Presentation File format

### PdfTextAnnotationBorderEffect
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/pdftextannotationbordereffect.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextAnnotationBorderEffect
```

Describes effect which should be applied to the border of the PDF Text Annotations.

#### Fields

| Field | Description |
| --- | --- |
| None | No effect.
 |
| Cloudy | The border will appear "cloudy".
 |
##### None
```
public static final int None
```

No effect.

##### Cloudy
```
public static final int Cloudy
```

The border will appear "cloudy".

### PdfTextStickerIcon
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/pdftextstickericon.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextStickerIcon
```

Describes enumeration of PDF Text Annotation Sticker Icon appearance.

#### Fields

| Field | Description |
| --- | --- |
| Note | Note icon.
 |
| Comment | Comment icon.
 |
| Key | Key icon.
 |
| Help | Help icon.
 |
| NewParagraph | New Paragraph icon
 |
| Paragraph | Paragraph icon
 |
| Insert | Insert icon
 |
| Check | Check icon
 |
| Cross | Cross icon
 |
| Circle | Circle icon
 |
| Star | Star icon
 |
##### Note
```
public static final int Note
```

Note icon.

##### Comment
```
public static final int Comment
```

Comment icon.

##### Key
```
public static final int Key
```

Key icon.

##### Help
```
public static final int Help
```

Help icon.

##### NewParagraph
```
public static final int NewParagraph
```

New Paragraph icon

##### Paragraph
```
public static final int Paragraph
```

Paragraph icon

##### Insert
```
public static final int Insert
```

Insert icon

##### Check
```
public static final int Check
```

Check icon

##### Cross
```
public static final int Cross
```

Cross icon

##### Circle
```
public static final int Circle
```

Circle icon

##### Star
```
public static final int Star
```

Star icon

### PdfTextStickerState
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/pdftextstickerstate.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextStickerState
```

Describes enumeration of PDF Text Annotation Sticker States.

#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined state.
 |
| Marked | Marked state.
 |
| Unmarked | Unmarked state.
 |
| Accepted | Accepted state.
 |
| Rejected | Rejected state.
 |
| Cancelled | Canceled state.
 |
| Completed | Completed state.
 |
| None | No state.
 |
##### Undefined
```
public static final int Undefined
```

Undefined state.

##### Marked
```
public static final int Marked
```

Marked state.

##### Unmarked
```
public static final int Unmarked
```

Unmarked state.

##### Accepted
```
public static final int Accepted
```

Accepted state.

##### Rejected
```
public static final int Rejected
```

Rejected state.

##### Cancelled
```
public static final int Cancelled
```

Canceled state.

##### Completed
```
public static final int Completed
```

Completed state.

##### None
```
public static final int None
```

No state.

### PresentationSaveFileFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/presentationsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class PresentationSaveFileFormat
```

Defines different save file formats.

#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed.
 |
| Pps | Saves the document as Microsoft Power Point 97-2003 slide show.
 |
| Ppt | Saves the document as Microsoft Power Point 97-2003 presentation.
 |
| Pdf | Saves the document in PDF format.
 |
| Xps | Saves the document in the XPS (XML Paper Specification) format.
 |
| Pptx | Saves the document in the Microsoft Power Point Open XML Presentation format.
 |
| Ppsx | Saves the document in the Microsoft Power Point Open XML Slide Show format.
 |
| Tiff | Renders a page or pages of the document and saves them into a single or multi-page TIFF file.
 |
| Odp | Saves the document as Open Office presentation.
 |
| Pptm | Saves the document as Microsoft Power Point Open XML macro-enabled presentation.
 |
| Ppsm | Saves the document as Microsoft Power Point Open XML macro-enabled slide show.
 |
| Potx | Saves the document as Microsoft Power Point template.
 |
| Potm | Saves the document as Microsoft Power Point macro-enabled template.
 |
| Html | Saves the document in the HTML Format.
 |
| Otp | Saves the document as Open Office presentation template.
 |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Pps
```
public static final int Pps
```

Saves the document as Microsoft Power Point 97-2003 slide show.

##### Ppt
```
public static final int Ppt
```

Saves the document as Microsoft Power Point 97-2003 presentation.

##### Pdf
```
public static final int Pdf
```

Saves the document in PDF format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) format.

##### Pptx
```
public static final int Pptx
```

Saves the document in the Microsoft Power Point Open XML Presentation format.

##### Ppsx
```
public static final int Ppsx
```

Saves the document in the Microsoft Power Point Open XML Slide Show format.

##### Tiff
```
public static final int Tiff
```

Renders a page or pages of the document and saves them into a single or multi-page TIFF file.

##### Odp
```
public static final int Odp
```

Saves the document as Open Office presentation.

##### Pptm
```
public static final int Pptm
```

Saves the document as Microsoft Power Point Open XML macro-enabled presentation.

##### Ppsm
```
public static final int Ppsm
```

Saves the document as Microsoft Power Point Open XML macro-enabled slide show.

##### Potx
```
public static final int Potx
```

Saves the document as Microsoft Power Point template.

##### Potm
```
public static final int Potm
```

Saves the document as Microsoft Power Point macro-enabled template.

##### Html
```
public static final int Html
```

Saves the document in the HTML Format.

##### Otp
```
public static final int Otp
```

Saves the document as Open Office presentation template.

### ProcessStatus
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/processstatus.md

**Inheritance:**
java.lang.Object
```
public final class ProcessStatus
```

Specifies status of signing and verification processes.

#### Fields

| Field | Description |
| --- | --- |
| None | Process is not started.
 |
| Started | Process was started.
 |
| InProgress | Process is in progress.
 |
| Completed | Process is completed.
 |
##### None
```
public static final int None
```

Process is not started.

##### Started
```
public static final int Started
```

Process was started.

##### InProgress
```
public static final int InProgress
```

Process is in progress.

##### Completed
```
public static final int Completed
```

Process is completed.

### ProcessType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/processtype.md

**Inheritance:**
java.lang.Object
```
public final class ProcessType
```

Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown process type.
 |
| Info | Obtain document information process.
 |
| Preview | Indicates method GeneratePreview().
 |
| Sign | Signing process type.
 |
| Verify | Document verification process.
 |
| Search | Signatures searching process.
 |
| Update | Update document signatures process.
 |
| Delete | Delete document signatures process
 |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown process type.

##### Info
```
public static final int Info
```

Obtain document information process.

##### Preview
```
public static final int Preview
```

Indicates method GeneratePreview().

##### Sign
```
public static final int Sign
```

Signing process type.

##### Verify
```
public static final int Verify
```

Document verification process.

##### Search
```
public static final int Search
```

Signatures searching process.

##### Update
```
public static final int Update
```

Update document signatures process.

##### Delete
```
public static final int Delete
```

Delete document signatures process

### ShapePosition
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/shapeposition.md

**Inheritance:**
java.lang.Object
```
public final class ShapePosition
```

Specifies shape position in the document layout

#### Fields

| Field | Description |
| --- | --- |
| Default | Shape presents in the document body
 |
| Header | Shape presents in the document header
 |
| Footer | Shape presents in the document footer
 |
##### Default
```
public static final int Default
```

Shape presents in the document body

##### Header
```
public static final int Header
```

Shape presents in the document header

##### Footer
```
public static final int Footer
```

Shape presents in the document footer

### SignatureType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/signaturetype.md

**Inheritance:**
java.lang.Object
```
public final class SignatureType
```

Signature Type define the method to sign.

#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown signature type.
 |
| Text | The Text Signature - put formatted string to document.
 |
| Image | The Image Signature - put image to specified document location.
 |
| Barcode | The Barcode Signature - sign document with Barcode.
 |
| QrCode | The QR-Code Signature - sign document with QRCode.
 |
| Stamp | The Stamp Signature - sign document with Stamp.
 |
| Metadata | The Metadata Signature - put metadata properties to Document.
 |
| FormField | The FormField Signature - put form-field objects to Document.
 |
| Digital | The Digital Signature - sign document with digital key.
 |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown signature type.

##### Text
```
public static final int Text
```

The Text Signature - put formatted string to document.

##### Image
```
public static final int Image
```

The Image Signature - put image to specified document location.

##### Barcode
```
public static final int Barcode
```

The Barcode Signature - sign document with Barcode.

##### QrCode
```
public static final int QrCode
```

The QR-Code Signature - sign document with QRCode.

##### Stamp
```
public static final int Stamp
```

The Stamp Signature - sign document with Stamp.

##### Metadata
```
public static final int Metadata
```

The Metadata Signature - put metadata properties to Document.

##### FormField
```
public static final int FormField
```

The FormField Signature - put form-field objects to Document.

##### Digital
```
public static final int Digital
```

The Digital Signature - sign document with digital key.

### SpreadsheetSaveFileFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/spreadsheetsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetSaveFileFormat
```

Defines different save formats for Spreadsheet documents.

#### Fields

| Field | Description |
| --- | --- |
| Default | File format will not be changed.
 |
| CSV | Saves the document as comma separated value file.
 |
| Excel97To2003 | Saves the document as Microsoft Excel 97-2003 workbook (.xls).
 |
| Xlsx | Saves the document an Microsoft Excel OpenXML workbook.
 |
| Xlsm | Saves the document as Microsoft Excel macro-enabled workbook.
 |
| Xltx | Saves the document as Microsoft Excel template.
 |
| Xltm | Saves the document as Microsoft Excel macro-enabled template.
 |
| Xlam | Saves the document as Microsoft Excel macro-enabled add-In.
 |
| Pdf | Saves the document as an PDF file.
 |
| ODS | Saves the document as Open Office workbook.
 |
| Xlsb | Saves the document as Microsoft Excel Binary workbook.
 |
| XPS | Saves the document as XML Paper Specification File.
 |
| TIFF | Saves the document in Tagged Image File Format.
 |
| SVG | Saves the document as Scalable Vector Graphics file.
 |
| Dif | Saves the document in Data Interchange Format.
 |
| Emf | Saves the document in Windows Enhanced Metafile format.
 |
| Jpg | Saves the document in Jpeg format.
 |
| Png | Saves the document in Portable Network Graphics format.
 |
##### Default
```
public static final int Default
```

File format will not be changed.

##### CSV
```
public static final int CSV
```

Saves the document as comma separated value file.

##### Excel97To2003
```
public static final int Excel97To2003
```

Saves the document as Microsoft Excel 97-2003 workbook (.xls).

##### Xlsx
```
public static final int Xlsx
```

Saves the document an Microsoft Excel OpenXML workbook.

##### Xlsm
```
public static final int Xlsm
```

Saves the document as Microsoft Excel macro-enabled workbook.

##### Xltx
```
public static final int Xltx
```

Saves the document as Microsoft Excel template.

##### Xltm
```
public static final int Xltm
```

Saves the document as Microsoft Excel macro-enabled template.

##### Xlam
```
public static final int Xlam
```

Saves the document as Microsoft Excel macro-enabled add-In.

##### Pdf
```
public static final int Pdf
```

Saves the document as an PDF file.

##### ODS
```
public static final int ODS
```

Saves the document as Open Office workbook.

##### Xlsb
```
public static final int Xlsb
```

Saves the document as Microsoft Excel Binary workbook.

##### XPS
```
public static final int XPS
```

Saves the document as XML Paper Specification File.

##### TIFF
```
public static final int TIFF
```

Saves the document in Tagged Image File Format.

##### SVG
```
public static final int SVG
```

Saves the document as Scalable Vector Graphics file.

##### Dif
```
public static final int Dif
```

Saves the document in Data Interchange Format.

##### Emf
```
public static final int Emf
```

Saves the document in Windows Enhanced Metafile format.

##### Jpg
```
public static final int Jpg
```

Saves the document in Jpeg format.

##### Png
```
public static final int Png
```

Saves the document in Portable Network Graphics format.

### StretchMode
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/stretchmode.md

**Inheritance:**
java.lang.Object
```
public final class StretchMode
```

Represents Stretch Mode of Signature area on Document Page.

#### Fields

| Field | Description |
| --- | --- |
| None | Default value.
 |
| PageWidth | Stretch Signature area along page Width.
 |
| PageHeight | Stretch Signature area along page Height.
 |
| PageArea | Stretch Signature area along page Height and Width.
 |
##### None
```
public static final int None
```

Default value. No stretch mode will be applied.

##### PageWidth
```
public static final int PageWidth
```

Stretch Signature area along page Width. Margin property will be used to apply required offset values

##### PageHeight
```
public static final int PageHeight
```

Stretch Signature area along page Height. Margin property will be used to apply required offset values.

##### PageArea
```
public static final int PageArea
```

Stretch Signature area along page Height and Width. Margin property will be used to apply required offset values.

### TextHorizontalAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/texthorizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class TextHorizontalAlignment
```

Specifies text horizontal alignment inside a Signature.

#### Fields

| Field | Description |
| --- | --- |
| Left | Specifies that the text is left aligned to the horizontal alignment base.
 |
| Center | Specifies that the text is centered to the horizontal alignment base.
 |
| Right | Specifies that the text is right aligned to the horizontal alignment base.
 |
##### Left
```
public static final int Left
```

Specifies that the text is left aligned to the horizontal alignment base.

##### Center
```
public static final int Center
```

Specifies that the text is centered to the horizontal alignment base.

##### Right
```
public static final int Right
```

Specifies that the text is right aligned to the horizontal alignment base.

### TextMatchType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/textmatchtype.md

**Inheritance:**
java.lang.Object
```
public final class TextMatchType
```

Specifies Text Match type in string - Exact, StartsWith, EndsWith, Contains.

#### Fields

| Field | Description |
| --- | --- |
| Exact | Text is fully match.
 |
| StartsWith | Text starts with value.
 |
| EndsWith | Text ends with value.
 |
| Contains | Text contains the value.
 |
##### Exact
```
public static final int Exact
```

Text is fully match.

##### StartsWith
```
public static final int StartsWith
```

Text starts with value.

##### EndsWith
```
public static final int EndsWith
```

Text ends with value.

##### Contains
```
public static final int Contains
```

Text contains the value.

### TextShapeType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/textshapetype.md

**Inheritance:**
java.lang.Object
```
public final class TextShapeType
```

Specifies types of text shapes.

#### Fields

| Field | Description |
| --- | --- |
| Rectangle | Rectangle.
 |
| RoundRectangle | RoundRectangle.
 |
| Ellipse | Ellipse.
 |
| Diamond | Diamond.
 |
| Triangle | Triangle.
 |
| RightTriangle | RightTriangle.
 |
| Parallelogram | Parallelogram.
 |
| Trapezoid | Trapezoid.
 |
| Hexagon | Hexagon.
 |
| Octagon | Octagon.
 |
| Plus | Plus.
 |
| Star | Star.
 |
| Arrow | Arrow.
 |
| ThickArrow | ThickArrow.
 |
| HomePlate | HomePlate.
 |
| Cube | Cube.
 |
| Balloon | Balloon.
 |
| Seal | Seal.
 |
| Arc | Arc.
 |
| Line | Line.
 |
| Plaque | Plaque.
 |
| Can | Can.
 |
| Donut | Donut.
 |
| TextSimple | TextSimple.
 |
| TextOctagon | TextOctagon.
 |
| TextHexagon | TextHexagon.
 |
| TextCurve | TextCurve.
 |
| TextWave | TextWave.
 |
| TextRing | TextRing.
 |
| TextOnCurve | TextOnCurve.
 |
| TextOnRing | TextOnRing.
 |
| StraightConnector1 | StraightConnector1.
 |
| BentConnector2 | BentConnector2.
 |
| BentConnector3 | BentConnector3.
 |
| BentConnector4 | BentConnector4.
 |
| BentConnector5 | BentConnector5.
 |
| CurvedConnector2 | CurvedConnector2.
 |
| CurvedConnector3 | CurvedConnector3.
 |
| CurvedConnector4 | CurvedConnector4.
 |
| CurvedConnector5 | CurvedConnector5.
 |
| Callout1 | Callout1.
 |
| Callout2 | Callout2.
 |
| Callout3 | Callout3.
 |
| AccentCallout1 | AccentCallout1.
 |
| AccentCallout2 | AccentCallout2.
 |
| AccentCallout3 | AccentCallout3.
 |
| BorderCallout1 | BorderCallout1.
 |
| BorderCallout2 | BorderCallout2.
 |
| BorderCallout3 | BorderCallout3.
 |
| AccentBorderCallout1 | AccentBorderCallout1.
 |
| AccentBorderCallout2 | AccentBorderCallout2.
 |
| AccentBorderCallout3 | AccentBorderCallout3.
 |
| Ribbon | Ribbon.
 |
| Ribbon2 | Ribbon2.
 |
| Chevron | Chevron.
 |
| Pentagon | Pentagon.
 |
| NoSmoking | NoSmoking.
 |
| Seal8 | Seal8.
 |
| Seal16 | Seal16.
 |
| Seal32 | Seal32.
 |
| WedgeRectCallout | WedgeRectCallout.
 |
| WedgeRRectCallout | WedgeRRectCallout.
 |
| WedgeEllipseCallout | WedgeEllipseCallout.
 |
| Wave | Wave.
 |
| FoldedCorner | FoldedCorner.
 |
| LeftArrow | LeftArrow.
 |
| DownArrow | DownArrow.
 |
| UpArrow | UpArrow.
 |
| LeftRightArrow | LeftRightArrow.
 |
| UpDownArrow | UpDownArrow.
 |
| IrregularSeal1 | IrregularSeal1.
 |
| IrregularSeal2 | IrregularSeal2.
 |
| LightningBolt | LightningBolt.
 |
| Heart | Heart.
 |
| Image | Image.
 |
| QuadArrow | QuadArrow.
 |
| LeftArrowCallout | LeftArrowCallout.
 |
| RightArrowCallout | RightArrowCallout.
 |
| UpArrowCallout | UpArrowCallout.
 |
| DownArrowCallout | DownArrowCallout.
 |
| LeftRightArrowCallout | LeftRightArrowCallout.
 |
| UpDownArrowCallout | UpDownArrowCallout.
 |
| QuadArrowCallout | QuadArrowCallout.
 |
| Bevel | Bevel.
 |
| LeftBracket | LeftBracket.
 |
| RightBracket | RightBracket.
 |
| LeftBrace | LeftBrace.
 |
| RightBrace | RightBrace.
 |
| LeftUpArrow | LeftUpArrow.
 |
| BentUpArrow | BentUpArrow.
 |
| BentArrow | BentArrow.
 |
| Seal24 | Seal24.
 |
| StripedRightArrow | StripedRightArrow.
 |
| NotchedRightArrow | NotchedRightArrow.
 |
| BlockArc | BlockArc.
 |
| SmileyFace | SmileyFace.
 |
| VerticalScroll | VerticalScroll.
 |
| HorizontalScroll | HorizontalScroll.
 |
| CircularArrow | CircularArrow.
 |
| UturnArrow | UturnArrow.
 |
| CurvedRightArrow | CurvedRightArrow.
 |
| CurvedLeftArrow | CurvedLeftArrow.
 |
| CurvedUpArrow | CurvedUpArrow.
 |
| CurvedDownArrow | CurvedDownArrow.
 |
| CloudCallout | CloudCallout.
 |
| EllipseRibbon | EllipseRibbon.
 |
| EllipseRibbon2 | EllipseRibbon2.
 |
| FlowChartProcess | FlowChartProcess.
 |
| FlowChartDecision | FlowChartDecision.
 |
| FlowChartInputOutput | FlowChartInputOutput.
 |
| FlowChartPredefinedProcess | FlowChartPredefinedProcess.
 |
| FlowChartInternalStorage | FlowChartInternalStorage.
 |
| FlowChartDocument | FlowChartDocument.
 |
| FlowChartMultidocument | FlowChartMultidocument.
 |
| FlowChartTerminator | FlowChartTerminator.
 |
| FlowChartPreparation | FlowChartPreparation.
 |
| FlowChartManualInput | FlowChartManualInput.
 |
| FlowChartManualOperation | FlowChartManualOperation.
 |
| FlowChartConnector | FlowChartConnector.
 |
| FlowChartPunchedCard | FlowChartPunchedCard.
 |
| FlowChartPunchedTape | FlowChartPunchedTape.
 |
| FlowChartSummingJunction | FlowChartSummingJunction.
 |
| FlowChartOr | FlowChartOr.
 |
| FlowChartCollate | FlowChartCollate.
 |
| FlowChartSort | FlowChartSort.
 |
| FlowChartExtract | FlowChartExtract.
 |
| FlowChartMerge | FlowChartOfflineStorage.
 |
| FlowChartOfflineStorage | FlowChartOfflineStorage.
 |
| FlowChartOnlineStorage | FlowChartOnlineStorage.
 |
| FlowChartMagneticTape | FlowChartMagneticTape.
 |
| FlowChartMagneticDisk | FlowChartMagneticDisk.
 |
| FlowChartMagneticDrum | FlowChartMagneticDrum.
 |
| FlowChartDisplay | FlowChartDisplay.
 |
| FlowChartDelay | FlowChartDelay.
 |
| TextPlainText | TextPlainText.
 |
| TextStop | TextStop.
 |
| TextTriangle | TextTriangle.
 |
| TextTriangleInverted | TextTriangleInverted.
 |
| TextChevron | TextChevron.
 |
| TextChevronInverted | TextChevronInverted.
 |
| TextRingInside | TextRingInside.
 |
| TextRingOutside | TextRingOutside.
 |
| TextArchUpCurve | TextArchUpCurve.
 |
| TextArchDownCurve | TextArchDownCurve.
 |
| TextCircleCurve | TextCircleCurve.
 |
| TextButtonCurve | TextButtonCurve.
 |
| TextArchUpPour | TextArchUpPour.
 |
| TextArchDownPour | TextArchDownPour.
 |
| TextCirclePour | TextCirclePour.
 |
| TextButtonPour | TextButtonPour.
 |
| TextCurveUp | TextCurveUp.
 |
| TextCurveDown | TextCurveDown.
 |
| TextCascadeUp | TextCascadeUp.
 |
| TextCascadeDown | TextCascadeDown.
 |
| TextWave1 | TextWave1.
 |
| TextWave2 | TextWave2.
 |
| TextWave3 | TextWave3.
 |
| TextWave4 | TextWave4.
 |
| TextInflate | TextInflate.
 |
| TextDeflate | TextDeflate.
 |
| TextInflateBottom | TextInflateBottom.
 |
| TextDeflateBottom | TextDeflateBottom.
 |
| TextInflateTop | TextInflateTop.
 |
| TextDeflateTop | TextDeflateTop.
 |
| TextDeflateInflate | TextDeflateInflate.
 |
| TextDeflateInflateDeflate | TextDeflateInflateDeflate.
 |
| TextFadeRight | TextFadeRight.
 |
| TextFadeLeft | TextFadeLeft.
 |
| TextFadeUp | TextFadeUp.
 |
| TextFadeDown | TextFadeDown.
 |
| TextSlantUp | TextSlantUp.
 |
| TextSlantDown | TextSlantDown.
 |
| TextCanUp | TextCanUp.
 |
| TextCanDown | TextCanDown.
 |
| FlowChartAlternateProcess | FlowChartAlternateProcess.
 |
| FlowChartOffpageConnector | FlowChartOffpageConnector.
 |
| Callout90 | Callout90.
 |
| AccentCallout90 | AccentCallout90.
 |
| BorderCallout90 | BorderCallout90.
 |
| AccentBorderCallout90 | AccentBorderCallout90.
 |
| LeftRightUpArrow | LeftRightUpArrow.
 |
| Sun | Sun.
 |
| Moon | Moon.
 |
| BracketPair | BracketPair.
 |
| BracePair | BracePair.
 |
| Seal4 | Seal4.
 |
| DoubleWave | DoubleWave.
 |
| ActionButtonBlank | ActionButtonBlank.
 |
| ActionButtonHome | ActionButtonHome.
 |
| ActionButtonHelp | ActionButtonHelp.
 |
| ActionButtonInformation | ActionButtonInformation.
 |
| ActionButtonForwardNext | ActionButtonForwardNext.
 |
| ActionButtonBackPrevious | ActionButtonBackPrevious.
 |
| ActionButtonEnd | ActionButtonEnd.
 |
| ActionButtonBeginning | ActionButtonBeginning.
 |
| ActionButtonReturn | ActionButtonReturn.
 |
| ActionButtonDocument | ActionButtonDocument.
 |
| ActionButtonSound | ActionButtonSound.
 |
| ActionButtonMovie | ActionButtonMovie.
 |
| TextBox | TextBox.
 |
##### Rectangle
```
public static final int Rectangle
```

Rectangle.

##### RoundRectangle
```
public static final int RoundRectangle
```

RoundRectangle.

##### Ellipse
```
public static final int Ellipse
```

Ellipse.

##### Diamond
```
public static final int Diamond
```

Diamond.

##### Triangle
```
public static final int Triangle
```

Triangle.

##### RightTriangle
```
public static final int RightTriangle
```

RightTriangle.

##### Parallelogram
```
public static final int Parallelogram
```

Parallelogram.

##### Trapezoid
```
public static final int Trapezoid
```

Trapezoid.

##### Hexagon
```
public static final int Hexagon
```

Hexagon.

##### Octagon
```
public static final int Octagon
```

Octagon.

##### Plus
```
public static final int Plus
```

Plus.

##### Star
```
public static final int Star
```

Star.

##### Arrow
```
public static final int Arrow
```

Arrow.

##### ThickArrow
```
public static final int ThickArrow
```

ThickArrow.

##### HomePlate
```
public static final int HomePlate
```

HomePlate.

##### Cube
```
public static final int Cube
```

Cube.

##### Balloon
```
public static final int Balloon
```

Balloon.

##### Seal
```
public static final int Seal
```

Seal.

##### Arc
```
public static final int Arc
```

Arc.

##### Line
```
public static final int Line
```

Line.

##### Plaque
```
public static final int Plaque
```

Plaque.

##### Can
```
public static final int Can
```

Can.

##### Donut
```
public static final int Donut
```

Donut.

##### TextSimple
```
public static final int TextSimple
```

TextSimple.

##### TextOctagon
```
public static final int TextOctagon
```

TextOctagon.

##### TextHexagon
```
public static final int TextHexagon
```

TextHexagon.

##### TextCurve
```
public static final int TextCurve
```

TextCurve.

##### TextWave
```
public static final int TextWave
```

TextWave.

##### TextRing
```
public static final int TextRing
```

TextRing.

##### TextOnCurve
```
public static final int TextOnCurve
```

TextOnCurve.

##### TextOnRing
```
public static final int TextOnRing
```

TextOnRing.

##### StraightConnector1
```
public static final int StraightConnector1
```

StraightConnector1.

##### BentConnector2
```
public static final int BentConnector2
```

BentConnector2.

##### BentConnector3
```
public static final int BentConnector3
```

BentConnector3.

##### BentConnector4
```
public static final int BentConnector4
```

BentConnector4.

##### BentConnector5
```
public static final int BentConnector5
```

BentConnector5.

##### CurvedConnector2
```
public static final int CurvedConnector2
```

CurvedConnector2.

##### CurvedConnector3
```
public static final int CurvedConnector3
```

CurvedConnector3.

##### CurvedConnector4
```
public static final int CurvedConnector4
```

CurvedConnector4.

##### CurvedConnector5
```
public static final int CurvedConnector5
```

CurvedConnector5.

##### Callout1
```
public static final int Callout1
```

Callout1.

##### Callout2
```
public static final int Callout2
```

Callout2.

##### Callout3
```
public static final int Callout3
```

Callout3.

##### AccentCallout1
```
public static final int AccentCallout1
```

AccentCallout1.

##### AccentCallout2
```
public static final int AccentCallout2
```

AccentCallout2.

##### AccentCallout3
```
public static final int AccentCallout3
```

AccentCallout3.

##### BorderCallout1
```
public static final int BorderCallout1
```

BorderCallout1.

##### BorderCallout2
```
public static final int BorderCallout2
```

BorderCallout2.

##### BorderCallout3
```
public static final int BorderCallout3
```

BorderCallout3.

##### AccentBorderCallout1
```
public static final int AccentBorderCallout1
```

AccentBorderCallout1.

##### AccentBorderCallout2
```
public static final int AccentBorderCallout2
```

AccentBorderCallout2.

##### AccentBorderCallout3
```
public static final int AccentBorderCallout3
```

AccentBorderCallout3.

##### Ribbon
```
public static final int Ribbon
```

Ribbon.

##### Ribbon2
```
public static final int Ribbon2
```

Ribbon2.

##### Chevron
```
public static final int Chevron
```

Chevron.

##### Pentagon
```
public static final int Pentagon
```

Pentagon.

##### NoSmoking
```
public static final int NoSmoking
```

NoSmoking.

##### Seal8
```
public static final int Seal8
```

Seal8.

##### Seal16
```
public static final int Seal16
```

Seal16.

##### Seal32
```
public static final int Seal32
```

Seal32.

##### WedgeRectCallout
```
public static final int WedgeRectCallout
```

WedgeRectCallout.

##### WedgeRRectCallout
```
public static final int WedgeRRectCallout
```

WedgeRRectCallout.

##### WedgeEllipseCallout
```
public static final int WedgeEllipseCallout
```

WedgeEllipseCallout.

##### Wave
```
public static final int Wave
```

Wave.

##### FoldedCorner
```
public static final int FoldedCorner
```

FoldedCorner.

##### LeftArrow
```
public static final int LeftArrow
```

LeftArrow.

##### DownArrow
```
public static final int DownArrow
```

DownArrow.

##### UpArrow
```
public static final int UpArrow
```

UpArrow.

##### LeftRightArrow
```
public static final int LeftRightArrow
```

LeftRightArrow.

##### UpDownArrow
```
public static final int UpDownArrow
```

UpDownArrow.

##### IrregularSeal1
```
public static final int IrregularSeal1
```

IrregularSeal1.

##### IrregularSeal2
```
public static final int IrregularSeal2
```

IrregularSeal2.

##### LightningBolt
```
public static final int LightningBolt
```

LightningBolt.

##### Heart
```
public static final int Heart
```

Heart.

##### Image
```
public static final int Image
```

Image.

##### QuadArrow
```
public static final int QuadArrow
```

QuadArrow.

##### LeftArrowCallout
```
public static final int LeftArrowCallout
```

LeftArrowCallout.

##### RightArrowCallout
```
public static final int RightArrowCallout
```

RightArrowCallout.

##### UpArrowCallout
```
public static final int UpArrowCallout
```

UpArrowCallout.

##### DownArrowCallout
```
public static final int DownArrowCallout
```

DownArrowCallout.

##### LeftRightArrowCallout
```
public static final int LeftRightArrowCallout
```

LeftRightArrowCallout.

##### UpDownArrowCallout
```
public static final int UpDownArrowCallout
```

UpDownArrowCallout.

##### QuadArrowCallout
```
public static final int QuadArrowCallout
```

QuadArrowCallout.

##### Bevel
```
public static final int Bevel
```

Bevel.

##### LeftBracket
```
public static final int LeftBracket
```

LeftBracket.

##### RightBracket
```
public static final int RightBracket
```

RightBracket.

##### LeftBrace
```
public static final int LeftBrace
```

LeftBrace.

##### RightBrace
```
public static final int RightBrace
```

RightBrace.

##### LeftUpArrow
```
public static final int LeftUpArrow
```

LeftUpArrow.

##### BentUpArrow
```
public static final int BentUpArrow
```

BentUpArrow.

##### BentArrow
```
public static final int BentArrow
```

BentArrow.

##### Seal24
```
public static final int Seal24
```

Seal24.

##### StripedRightArrow
```
public static final int StripedRightArrow
```

StripedRightArrow.

##### NotchedRightArrow
```
public static final int NotchedRightArrow
```

NotchedRightArrow.

##### BlockArc
```
public static final int BlockArc
```

BlockArc.

##### SmileyFace
```
public static final int SmileyFace
```

SmileyFace.

##### VerticalScroll
```
public static final int VerticalScroll
```

VerticalScroll.

##### HorizontalScroll
```
public static final int HorizontalScroll
```

HorizontalScroll.

##### CircularArrow
```
public static final int CircularArrow
```

CircularArrow.

##### UturnArrow
```
public static final int UturnArrow
```

UturnArrow.

##### CurvedRightArrow
```
public static final int CurvedRightArrow
```

CurvedRightArrow.

##### CurvedLeftArrow
```
public static final int CurvedLeftArrow
```

CurvedLeftArrow.

##### CurvedUpArrow
```
public static final int CurvedUpArrow
```

CurvedUpArrow.

##### CurvedDownArrow
```
public static final int CurvedDownArrow
```

CurvedDownArrow.

##### CloudCallout
```
public static final int CloudCallout
```

CloudCallout.

##### EllipseRibbon
```
public static final int EllipseRibbon
```

EllipseRibbon.

##### EllipseRibbon2
```
public static final int EllipseRibbon2
```

EllipseRibbon2.

##### FlowChartProcess
```
public static final int FlowChartProcess
```

FlowChartProcess.

##### FlowChartDecision
```
public static final int FlowChartDecision
```

FlowChartDecision.

##### FlowChartInputOutput
```
public static final int FlowChartInputOutput
```

FlowChartInputOutput.

##### FlowChartPredefinedProcess
```
public static final int FlowChartPredefinedProcess
```

FlowChartPredefinedProcess.

##### FlowChartInternalStorage
```
public static final int FlowChartInternalStorage
```

FlowChartInternalStorage.

##### FlowChartDocument
```
public static final int FlowChartDocument
```

FlowChartDocument.

##### FlowChartMultidocument
```
public static final int FlowChartMultidocument
```

FlowChartMultidocument.

##### FlowChartTerminator
```
public static final int FlowChartTerminator
```

FlowChartTerminator.

##### FlowChartPreparation
```
public static final int FlowChartPreparation
```

FlowChartPreparation.

##### FlowChartManualInput
```
public static final int FlowChartManualInput
```

FlowChartManualInput.

##### FlowChartManualOperation
```
public static final int FlowChartManualOperation
```

FlowChartManualOperation.

##### FlowChartConnector
```
public static final int FlowChartConnector
```

FlowChartConnector.

##### FlowChartPunchedCard
```
public static final int FlowChartPunchedCard
```

FlowChartPunchedCard.

##### FlowChartPunchedTape
```
public static final int FlowChartPunchedTape
```

FlowChartPunchedTape.

##### FlowChartSummingJunction
```
public static final int FlowChartSummingJunction
```

FlowChartSummingJunction.

##### FlowChartOr
```
public static final int FlowChartOr
```

FlowChartOr.

##### FlowChartCollate
```
public static final int FlowChartCollate
```

FlowChartCollate.

##### FlowChartSort
```
public static final int FlowChartSort
```

FlowChartSort.

##### FlowChartExtract
```
public static final int FlowChartExtract
```

FlowChartExtract.

##### FlowChartMerge
```
public static final int FlowChartMerge
```

FlowChartOfflineStorage.

##### FlowChartOfflineStorage
```
public static final int FlowChartOfflineStorage
```

FlowChartOfflineStorage.

##### FlowChartOnlineStorage
```
public static final int FlowChartOnlineStorage
```

FlowChartOnlineStorage.

##### FlowChartMagneticTape
```
public static final int FlowChartMagneticTape
```

FlowChartMagneticTape.

##### FlowChartMagneticDisk
```
public static final int FlowChartMagneticDisk
```

FlowChartMagneticDisk.

##### FlowChartMagneticDrum
```
public static final int FlowChartMagneticDrum
```

FlowChartMagneticDrum.

##### FlowChartDisplay
```
public static final int FlowChartDisplay
```

FlowChartDisplay.

##### FlowChartDelay
```
public static final int FlowChartDelay
```

FlowChartDelay.

##### TextPlainText
```
public static final int TextPlainText
```

TextPlainText.

##### TextStop
```
public static final int TextStop
```

TextStop.

##### TextTriangle
```
public static final int TextTriangle
```

TextTriangle.

##### TextTriangleInverted
```
public static final int TextTriangleInverted
```

TextTriangleInverted.

##### TextChevron
```
public static final int TextChevron
```

TextChevron.

##### TextChevronInverted
```
public static final int TextChevronInverted
```

TextChevronInverted.

##### TextRingInside
```
public static final int TextRingInside
```

TextRingInside.

##### TextRingOutside
```
public static final int TextRingOutside
```

TextRingOutside.

##### TextArchUpCurve
```
public static final int TextArchUpCurve
```

TextArchUpCurve.

##### TextArchDownCurve
```
public static final int TextArchDownCurve
```

TextArchDownCurve.

##### TextCircleCurve
```
public static final int TextCircleCurve
```

TextCircleCurve.

##### TextButtonCurve
```
public static final int TextButtonCurve
```

TextButtonCurve.

##### TextArchUpPour
```
public static final int TextArchUpPour
```

TextArchUpPour.

##### TextArchDownPour
```
public static final int TextArchDownPour
```

TextArchDownPour.

##### TextCirclePour
```
public static final int TextCirclePour
```

TextCirclePour.

##### TextButtonPour
```
public static final int TextButtonPour
```

TextButtonPour.

##### TextCurveUp
```
public static final int TextCurveUp
```

TextCurveUp.

##### TextCurveDown
```
public static final int TextCurveDown
```

TextCurveDown.

##### TextCascadeUp
```
public static final int TextCascadeUp
```

TextCascadeUp.

##### TextCascadeDown
```
public static final int TextCascadeDown
```

TextCascadeDown.

##### TextWave1
```
public static final int TextWave1
```

TextWave1.

##### TextWave2
```
public static final int TextWave2
```

TextWave2.

##### TextWave3
```
public static final int TextWave3
```

TextWave3.

##### TextWave4
```
public static final int TextWave4
```

TextWave4.

##### TextInflate
```
public static final int TextInflate
```

TextInflate.

##### TextDeflate
```
public static final int TextDeflate
```

TextDeflate.

##### TextInflateBottom
```
public static final int TextInflateBottom
```

TextInflateBottom.

##### TextDeflateBottom
```
public static final int TextDeflateBottom
```

TextDeflateBottom.

##### TextInflateTop
```
public static final int TextInflateTop
```

TextInflateTop.

##### TextDeflateTop
```
public static final int TextDeflateTop
```

TextDeflateTop.

##### TextDeflateInflate
```
public static final int TextDeflateInflate
```

TextDeflateInflate.

##### TextDeflateInflateDeflate
```
public static final int TextDeflateInflateDeflate
```

TextDeflateInflateDeflate.

##### TextFadeRight
```
public static final int TextFadeRight
```

TextFadeRight.

##### TextFadeLeft
```
public static final int TextFadeLeft
```

TextFadeLeft.

##### TextFadeUp
```
public static final int TextFadeUp
```

TextFadeUp.

##### TextFadeDown
```
public static final int TextFadeDown
```

TextFadeDown.

##### TextSlantUp
```
public static final int TextSlantUp
```

TextSlantUp.

##### TextSlantDown
```
public static final int TextSlantDown
```

TextSlantDown.

##### TextCanUp
```
public static final int TextCanUp
```

TextCanUp.

##### TextCanDown
```
public static final int TextCanDown
```

TextCanDown.

##### FlowChartAlternateProcess
```
public static final int FlowChartAlternateProcess
```

FlowChartAlternateProcess.

##### FlowChartOffpageConnector
```
public static final int FlowChartOffpageConnector
```

FlowChartOffpageConnector.

##### Callout90
```
public static final int Callout90
```

Callout90.

##### AccentCallout90
```
public static final int AccentCallout90
```

AccentCallout90.

##### BorderCallout90
```
public static final int BorderCallout90
```

BorderCallout90.

##### AccentBorderCallout90
```
public static final int AccentBorderCallout90
```

AccentBorderCallout90.

##### LeftRightUpArrow
```
public static final int LeftRightUpArrow
```

LeftRightUpArrow.

##### Sun
```
public static final int Sun
```

Sun.

##### Moon
```
public static final int Moon
```

Moon.

##### BracketPair
```
public static final int BracketPair
```

BracketPair.

##### BracePair
```
public static final int BracePair
```

BracePair.

##### Seal4
```
public static final int Seal4
```

Seal4.

##### DoubleWave
```
public static final int DoubleWave
```

DoubleWave.

##### ActionButtonBlank
```
public static final int ActionButtonBlank
```

ActionButtonBlank.

##### ActionButtonHome
```
public static final int ActionButtonHome
```

ActionButtonHome.

##### ActionButtonHelp
```
public static final int ActionButtonHelp
```

ActionButtonHelp.

##### ActionButtonInformation
```
public static final int ActionButtonInformation
```

ActionButtonInformation.

##### ActionButtonForwardNext
```
public static final int ActionButtonForwardNext
```

ActionButtonForwardNext.

##### ActionButtonBackPrevious
```
public static final int ActionButtonBackPrevious
```

ActionButtonBackPrevious.

##### ActionButtonEnd
```
public static final int ActionButtonEnd
```

ActionButtonEnd.

##### ActionButtonBeginning
```
public static final int ActionButtonBeginning
```

ActionButtonBeginning.

##### ActionButtonReturn
```
public static final int ActionButtonReturn
```

ActionButtonReturn.

##### ActionButtonDocument
```
public static final int ActionButtonDocument
```

ActionButtonDocument.

##### ActionButtonSound
```
public static final int ActionButtonSound
```

ActionButtonSound.

##### ActionButtonMovie
```
public static final int ActionButtonMovie
```

ActionButtonMovie.

##### TextBox
```
public static final int TextBox
```

TextBox.

### TextSignatureImplementation
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/textsignatureimplementation.md

**Inheritance:**
java.lang.Object
```
public final class TextSignatureImplementation
```

Specifies type of implementation for PDF text signature.

#### Fields

| Field | Description |
| --- | --- |
| Native | Text Signature as native text object on document page.
 |
| Image | Text Signature as Image object on document page.
 |
| Annotation | Text Signature as Text Annotation object on PDF page.
 |
| Sticker | Text Signature as Sticker object on PDF page.
 |
| FormField | Text Signature as text in specified form field.
 |
| Watermark | Text Signature as watermark on document page.
 |
##### Native
```
public static final int Native
```

Text Signature as native text object on document page.

##### Image
```
public static final int Image
```

Text Signature as Image object on document page.

##### Annotation
```
public static final int Annotation
```

Text Signature as Text Annotation object on PDF page.
Annotations are visible only for Licensed version.

##### Sticker
```
public static final int Sticker
```

Text Signature as Sticker object on PDF page.

##### FormField
```
public static final int FormField
```

Text Signature as text in specified form field.
With this type of implementation could be used only TextSignOptions.Text,
TextSignOptions.FormTextFieldType and TextSignOptions.FormTextFieldTitle options.

##### Watermark
```
public static final int Watermark
```

Text Signature as watermark on document page.

### TextVerticalAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/textverticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class TextVerticalAlignment
```

Specifies text vertical alignment inside a Signature.

#### Fields

| Field | Description |
| --- | --- |
| Top | Specifies that the text is top aligned to the vertical alignment base.
 |
| Center | Specifies that the text is centered to the vertical alignment base.
 |
| Bottom | Specifies that the text is bottom aligned to the vertical alignment base.
 |
##### Top
```
public static final int Top
```

Specifies that the text is top aligned to the vertical alignment base.

##### Center
```
public static final int Center
```

Specifies that the text is centered to the vertical alignment base.

##### Bottom
```
public static final int Bottom
```

Specifies that the text is bottom aligned to the vertical alignment base.

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/verticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class VerticalAlignment
```

Specifies vertical alignment of element on Document Page.

#### Fields

| Field | Description |
| --- | --- |
| None | The object is explicitly positioned, usually using its Top property.
 |
| Top | Specifies that the object shall be at the top of the vertical alignment base.
 |
| Center | Specifies that the object shall be centered with respect to the vertical alignment base.
 |
| Bottom | Specifies that the object shall be at the bottom of the vertical alignment base.
 |
##### None
```
public static final int None
```

The object is explicitly positioned, usually using its Top property.

##### Top
```
public static final int Top
```

Specifies that the object shall be at the top of the vertical alignment base.

##### Center
```
public static final int Center
```

Specifies that the object shall be centered with respect to the vertical alignment base.

##### Bottom
```
public static final int Bottom
```

Specifies that the object shall be at the bottom of the vertical alignment base.

### WordProcessingSaveFileFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/wordprocessingsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingSaveFileFormat
```

Defines different save file formats for WordProcessing documents.

#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed.
 |
| Doc | Saves the document as Microsoft Word 97-2003 document.
 |
| Dot | Saves the document as Microsoft Word 97-2003 template.
 |
| Docx | Saves the document as Microsoft Word OpenXML document.
 |
| Docm | Saves the document as Microsoft Word OpenXML macro-enabled document.
 |
| Dotx | Saves the document as Microsoft Word OpenXML template.
 |
| Dotm | Saves the document as Microsoft Word OpenXML macro-enabled template.
 |
| FlatOpc | Saves the document as an Office Open XML WordprocessingML
stored in a flat XML file instead of a ZIP package.
 |
| FlatOpcMacroEnabled | Saves the document as an Office Open XML WordprocessingML
Macro-Enabled Document stored in a flat XML file instead of a ZIP package.
 |
| FlatOpcTemplate | Saves the document as an Office Open XML WordprocessingML
Template (macro-free) stored in a flat XML file instead of a ZIP package.
 |
| FlatOpcTemplateMacroEnabled | Saves the document as an Office Open XML WordprocessingML
Macro-Enabled Template stored in a flat XML file instead of a ZIP package.
 |
| Rtf | Saves the document in the RTF Format.
 |
| WordML | Saves the document in the Microsoft Word 2003 WordprocessingML Format.
 |
| Pdf | Saves the document as PDF (Adobe Portable Document) Format.
 |
| Xps | Saves the document in the XPS (XML Paper Specification) Format.
 |
| Ps | Saves the document in the PS (PostScript) Format.
 |
| Mhtml | Saves the document in the MHTML (Web archive) Format.
 |
| Epub | Saves the document in the IDPF EPUB Format.
 |
| Odt | Saves the document as Open Office document.
 |
| Ott | Saves the document as Open Office document template.
 |
| Text | Saves the document in the plain text format.
 |
| Tiff | Renders a page or pages of the document and saves them into a single or multi-page TIFF file.
 |
| Png | Renders a page of the document and saves it as a PNG file.
 |
| Bmp | Renders a page of the document and saves it as a BMP file.
 |
| Emf | Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file.
 |
| Jpeg | Renders a page of the document and saves it as a JPEG file.
 |
| Azw3 | Renders a page of the document and saves it as a Azw3 file.
 |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Doc
```
public static final int Doc
```

Saves the document as Microsoft Word 97-2003 document.

##### Dot
```
public static final int Dot
```

Saves the document as Microsoft Word 97-2003 template.

##### Docx
```
public static final int Docx
```

Saves the document as Microsoft Word OpenXML document.

##### Docm
```
public static final int Docm
```

Saves the document as Microsoft Word OpenXML macro-enabled document.

##### Dotx
```
public static final int Dotx
```

Saves the document as Microsoft Word OpenXML template.

##### Dotm
```
public static final int Dotm
```

Saves the document as Microsoft Word OpenXML macro-enabled template.

##### FlatOpc
```
public static final int FlatOpc
```

Saves the document as an Office Open XML WordprocessingML
stored in a flat XML file instead of a ZIP package.

##### FlatOpcMacroEnabled
```
public static final int FlatOpcMacroEnabled
```

Saves the document as an Office Open XML WordprocessingML
Macro-Enabled Document stored in a flat XML file instead of a ZIP package.

##### FlatOpcTemplate
```
public static final int FlatOpcTemplate
```

Saves the document as an Office Open XML WordprocessingML
Template (macro-free) stored in a flat XML file instead of a ZIP package.

##### FlatOpcTemplateMacroEnabled
```
public static final int FlatOpcTemplateMacroEnabled
```

Saves the document as an Office Open XML WordprocessingML
Macro-Enabled Template stored in a flat XML file instead of a ZIP package.

##### Rtf
```
public static final int Rtf
```

Saves the document in the RTF Format. All characters above 7-bits are escaped as hexadecimal or Unicode characters.

##### WordML
```
public static final int WordML
```

Saves the document in the Microsoft Word 2003 WordprocessingML Format.

##### Pdf
```
public static final int Pdf
```

Saves the document as PDF (Adobe Portable Document) Format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) Format.

##### Ps
```
public static final int Ps
```

Saves the document in the PS (PostScript) Format.

##### Mhtml
```
public static final int Mhtml
```

Saves the document in the MHTML (Web archive) Format.

##### Epub
```
public static final int Epub
```

Saves the document in the IDPF EPUB Format.

##### Odt
```
public static final int Odt
```

Saves the document as Open Office document.

##### Ott
```
public static final int Ott
```

Saves the document as Open Office document template.

##### Text
```
public static final int Text
```

Saves the document in the plain text format.

##### Tiff
```
public static final int Tiff
```

Renders a page or pages of the document and saves them into a single or multi-page TIFF file.

##### Png
```
public static final int Png
```

Renders a page of the document and saves it as a PNG file.

##### Bmp
```
public static final int Bmp
```

Renders a page of the document and saves it as a BMP file.

##### Emf
```
public static final int Emf
```

Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file.

##### Jpeg
```
public static final int Jpeg
```

Renders a page of the document and saves it as a JPEG file.

##### Azw3
```
public static final int Azw3
```

Renders a page of the document and saves it as a Azw3 file.

### WordProcessingTextSignatureImplementation
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/wordprocessingtextsignatureimplementation.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingTextSignatureImplementation
```

Specifies type of text signature implementation for WordProcessing documents.

#### Fields

| Field | Description |
| --- | --- |
| TextStamp | Text Signature as Label object on Words page.
 |
| TextAsImage | Text Signature as Image object on Words page.
 |
| TextToFormField | Text Signature as text in specified form field.
 |
| Watermark | Text Signature as watermark on Words page.
 |
##### TextStamp
```
public static final int TextStamp
```

Text Signature as Label object on Words page.

##### TextAsImage
```
public static final int TextAsImage
```

Text Signature as Image object on Words page.

##### TextToFormField
```
public static final int TextToFormField
```

Text Signature as text in specified form field.
With this type of implementation could be used only TextSignOptions.Text,
TextSignOptions.FormTextFieldTitle and TextSignOptions.FormTextFieldType options.

##### Watermark
```
public static final int Watermark
```

Text Signature as watermark on Words page.

### XAdESType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.enums/xadestype.md

**Inheritance:**
java.lang.Object
```
public final class XAdESType
```

Type of XML Advanced Electronic Signature (XAdES).

#### Fields

| Field | Description |
| --- | --- |
| None | XAdES is off.
 |
| XAdES | Basic XAdES.
 |
##### None
```
public static final int None
```

XAdES is off.

##### XAdES
```
public static final int XAdES
```

Basic XAdES.

### com.groupdocs.signature.domain.extensions.encryption
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.encryption.md

The **GroupDocs.Signature.Domain.Extensions.Encryption** namespace provides classes for working with Encryption

#### Classes

| Class | Description |
| --- | --- |
| SymmetricAlgorithmType | Represents symmetric encryption algorithm type. |
| SymmetricEncryption | Implements standard symmetric algorithms for data encryption with single key and passphrase (salt). |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDataEncryption | Encryption interface to provide object encoding and decoding methods. |

### IDataEncryption
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.encryption/idataencryption.md

### SymmetricAlgorithmType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.encryption/symmetricalgorithmtype.md

**Inheritance:**
java.lang.Object
```
public final class SymmetricAlgorithmType
```

Represents symmetric encryption algorithm type.

#### Fields

| Field | Description |
| --- | --- |
| Rijndael | Represents Rijndael symmetric encryption algorithm.
 |
| AES | Represents AES (Advanced Encryption Standard) encryption algorithm.
 |
| AESNew | Represents improved AES (Advanced Encryption Standard) encryption algorithm.
 |
##### Rijndael
```
public static final int Rijndael
```

Represents Rijndael symmetric encryption algorithm.

##### AES
```
public static final int AES
```

Represents AES (Advanced Encryption Standard) encryption algorithm.

##### AESNew
```
public static final int AESNew
```

Represents improved AES (Advanced Encryption Standard) encryption algorithm.

### SymmetricEncryption
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.encryption/symmetricencryption.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.encryption.IDataEncryption
```
public final class SymmetricEncryption implements IDataEncryption
```

Implements standard symmetric algorithms for data encryption with single key and passphrase (salt).

#### Constructors

| Constructor | Description |
| --- | --- |
| SymmetricEncryption(int algorithmType, String key, String salt) | Creates symmetric encryption algorithm with parameters.
 |
| SymmetricEncryption(int algorithmType, String key) | Creates symmetric encryption algorithm with default passphrase
 |
#### Methods

| Method | Description |
| --- | --- |
| getAlgorithmType() | Gets or sets type of symmetric algorithm.
 |
| setAlgorithmType(int value) | Gets or sets type of symmetric algorithm.
 |
| getKey() | Gets or sets key of encryption algorithm.
 |
| setKey(String value) | Gets or sets key of encryption algorithm.
 |
| getSalt() | Gets or sets passphrase of encryption algorithm.
 |
| setSalt(String value) | Gets or sets passphrase of encryption algorithm.
 |
| encode(String source) | Encrypts string based on provided algorithm type, key and salt parameters
 |
| decode(String source) | Decrypts string based on provided algorithm type, key and salt parameters
 |
##### SymmetricEncryption(int algorithmType, String key, String salt)
```
public SymmetricEncryption(int algorithmType, String key, String salt)
```

Creates symmetric encryption algorithm with parameters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | int | Specify symmetric algorithm type
 |
| key | java.lang.String | Encryption key
 |
| salt | java.lang.String | Passphrase for encryption
 |

##### SymmetricEncryption(int algorithmType, String key)
```
public SymmetricEncryption(int algorithmType, String key)
```

Creates symmetric encryption algorithm with default passphrase

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | int | Specify symmetric algorithm type
 |
| key | java.lang.String | Encryption key
 |

##### getAlgorithmType()
```
public final int getAlgorithmType()
```

Gets or sets type of symmetric algorithm.

**Returns:**
int
##### setAlgorithmType(int value)
```
public final void setAlgorithmType(int value)
```

Gets or sets type of symmetric algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getKey()
```
public final String getKey()
```

Gets or sets key of encryption algorithm.

**Returns:**
java.lang.String
##### setKey(String value)
```
public final void setKey(String value)
```

Gets or sets key of encryption algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSalt()
```
public final String getSalt()
```

Gets or sets passphrase of encryption algorithm.

**Returns:**
java.lang.String
##### setSalt(String value)
```
public final void setSalt(String value)
```

Gets or sets passphrase of encryption algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### encode(String source)
```
public final String encode(String source)
```

Encrypts string based on provided algorithm type, key and salt parameters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.String | Source string to encode.
 |

**Returns:**
java.lang.String - Returns encrypted string.

##### decode(String source)
```
public final String decode(String source)
```

Decrypts string based on provided algorithm type, key and salt parameters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.String | Encrypted string to decode.
 |

**Returns:**
java.lang.String - Returns decrypted string.

### com.groupdocs.signature.domain.extensions.hibclic
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.hibclic.md

The **GroupDocs.Signature.Domain.Extensions.HIBCLIC** namespace provides classes for working with HIBCLIC

#### Classes

| Class | Description |
| --- | --- |
| HIBCLICCombinedData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities. |
| HIBCLICDateFormat | Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code). |
| HIBCLICPrimaryData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data. |
| HIBCLICSecondaryAdditionalData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data. |

### HIBCLICCombinedData
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.hibclic/hibcliccombineddata.md

**Inheritance:**
java.lang.Object
```
public class HIBCLICCombinedData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities.

#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICCombinedData() | Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPrimaryData() | HIBC LIC primary data structure
 |
| setPrimaryData(HIBCLICPrimaryData value) | HIBC LIC primary data structure
 |
| getSecondaryAdditionalData() | HIBC LIC secondary data structure
 |
| setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value) | HIBC LIC secondary data structure
 |
| deepClone() | Gets a copy of this object.
 |
| getCodetext() |  |
##### HIBCLICCombinedData()
```
public HIBCLICCombinedData()
```

Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values.

##### getPrimaryData()
```
public final HIBCLICPrimaryData getPrimaryData()
```

HIBC LIC primary data structure

**Returns:**
HIBCLICPrimaryData
##### setPrimaryData(HIBCLICPrimaryData value)
```
public final void setPrimaryData(HIBCLICPrimaryData value)
```

HIBC LIC primary data structure

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | HIBCLICPrimaryData |  |

##### getSecondaryAdditionalData()
```
public final HIBCLICSecondaryAdditionalData getSecondaryAdditionalData()
```

HIBC LIC secondary data structure

**Returns:**
HIBCLICSecondaryAdditionalData
##### setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value)
```
public final void setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value)
```

HIBC LIC secondary data structure

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | HIBCLICSecondaryAdditionalData |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### getCodetext()
```
public final IComplexCodetext getCodetext()
```

**Returns:**
com.aspose.barcode.complexbarcode.IComplexCodetext

### HIBCLICDateFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.hibclic/hibclicdateformat.md

**Inheritance:**
java.lang.Object
```
public final class HIBCLICDateFormat
```

Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code).

#### Fields

| Field | Description |
| --- | --- |
| YYYYMMDD | YYYYMMDD format.
 |
| MMYY | MMYY format.
 |
| MMDDYY | MMDDYY format.
 |
| YYMMDD | YYMMDD format.
 |
| YYMMDDHH | YYMMDDHH format.
 |
| YYJJJ | Julian date format.
 |
| YYJJJHH | Julian date format with hours.
 |
| None | Do not encode expiry date.
 |
##### YYYYMMDD
```
public static final int YYYYMMDD
```

YYYYMMDD format. Will be encoded in additional supplemental data.

##### MMYY
```
public static final int MMYY
```

MMYY format.

##### MMDDYY
```
public static final int MMDDYY
```

MMDDYY format.

##### YYMMDD
```
public static final int YYMMDD
```

YYMMDD format.

##### YYMMDDHH
```
public static final int YYMMDDHH
```

YYMMDDHH format.

##### YYJJJ
```
public static final int YYJJJ
```

Julian date format.

##### YYJJJHH
```
public static final int YYJJJHH
```

Julian date format with hours.

##### None
```
public static final int None
```

Do not encode expiry date.

### HIBCLICPrimaryData
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.hibclic/hibclicprimarydata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class HIBCLICPrimaryData implements IComplexData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data.

#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICPrimaryData() | Default ctor()
 |
#### Methods

| Method | Description |
| --- | --- |
| getLabelerIdentificationCode() | Identifies date of labeler identification code.
 |
| setLabelerIdentificationCode(String value) | Identifies date of labeler identification code.
 |
| getProductOrCatalogNumber() | Identifies product or catalog number.
 |
| setProductOrCatalogNumber(String value) | Identifies product or catalog number.
 |
| getUnitOfMeasureID() | Identifies unit of measure ID.
 |
| setUnitOfMeasureID(int value) | Identifies unit of measure ID.
 |
| deepClone() | Gets a copy of this object.
 |
| getCodetext() |  |
##### HIBCLICPrimaryData()
```
public HIBCLICPrimaryData()
```

Default ctor()

##### getLabelerIdentificationCode()
```
public final String getLabelerIdentificationCode()
```

Identifies date of labeler identification code. Labeler identification code must
be 4 symbols alphanumeric string, with first character always being alphabetic.

**Returns:**
java.lang.String
##### setLabelerIdentificationCode(String value)
```
public final void setLabelerIdentificationCode(String value)
```

Identifies date of labeler identification code. Labeler identification code must
be 4 symbols alphanumeric string, with first character always being alphabetic.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getProductOrCatalogNumber()
```
public final String getProductOrCatalogNumber()
```

Identifies product or catalog number. Product or catalog number must be alphanumeric
string up to 18 symbols length.

**Returns:**
java.lang.String
##### setProductOrCatalogNumber(String value)
```
public final void setProductOrCatalogNumber(String value)
```

Identifies product or catalog number. Product or catalog number must be alphanumeric
string up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUnitOfMeasureID()
```
public final int getUnitOfMeasureID()
```

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.

**Returns:**
int
##### setUnitOfMeasureID(int value)
```
public final void setUnitOfMeasureID(int value)
```

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### getCodetext()
```
public final IComplexCodetext getCodetext()
```

**Returns:**
com.aspose.barcode.complexbarcode.IComplexCodetext

### HIBCLICSecondaryAdditionalData
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.hibclic/hibclicsecondaryadditionaldata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class HIBCLICSecondaryAdditionalData implements IComplexData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data.

#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICSecondaryAdditionalData() | Default ctor()
 |
#### Methods

| Method | Description |
| --- | --- |
| getExpiryDateFormat() | Identifies expiry date format.
 |
| setExpiryDateFormat(int value) | Identifies expiry date format.
 |
| getExpiryDate() | Identifies expiry date.
 |
| setExpiryDate(Date value) | Identifies expiry date.
 |
| getLotNumber() | Identifies lot or batch number.
 |
| setLotNumber(String value) | Identifies lot or batch number.
 |
| getSerialNumber() | Identifies serial number.
 |
| setSerialNumber(String value) | Identifies serial number.
 |
| getDateOfManufacture() | Identifies date of manufacture.
 |
| setDateOfManufacture(Date value) | Identifies date of manufacture.
 |
| getQuantity() | Identifies quantity, must be integer value from 0 to 500.
 |
| setQuantity(int value) | Identifies quantity, must be integer value from 0 to 500.
 |
| getLinkCharacter() | Identifies link character in output string.
 |
| setLinkCharacter(char value) | Identifies link character in output string.
 |
| deepClone() | Gets a copy of this object.
 |
##### HIBCLICSecondaryAdditionalData()
```
public HIBCLICSecondaryAdditionalData()
```

Default ctor()

##### getExpiryDateFormat()
```
public final int getExpiryDateFormat()
```

Identifies expiry date format.

**Returns:**
int
##### setExpiryDateFormat(int value)
```
public final void setExpiryDateFormat(int value)
```

Identifies expiry date format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpiryDate()
```
public final Date getExpiryDate()
```

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.

**Returns:**
java.util.Date
##### setExpiryDate(Date value)
```
public final void setExpiryDate(Date value)
```

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getLotNumber()
```
public final String getLotNumber()
```

Identifies lot or batch number.
Lot/batch number must be alphanumeric string with up to 18 symbols length.

**Returns:**
java.lang.String
##### setLotNumber(String value)
```
public final void setLotNumber(String value)
```

Identifies lot or batch number.
Lot/batch number must be alphanumeric string with up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSerialNumber()
```
public final String getSerialNumber()
```

Identifies serial number.
Serial number must be alphanumeric string up to 18 symbols length.

**Returns:**
java.lang.String
##### setSerialNumber(String value)
```
public final void setSerialNumber(String value)
```

Identifies serial number.
Serial number must be alphanumeric string up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDateOfManufacture()
```
public final Date getDateOfManufacture()
```

Identifies date of manufacture.
Date of manufacture can be set to DateTime.MinValue in order not to use this field.
Default value: DateTime.MinValue

**Returns:**
java.util.Date
##### setDateOfManufacture(Date value)
```
public final void setDateOfManufacture(Date value)
```

Identifies date of manufacture.
Date of manufacture can be set to DateTime.MinValue in order not to use this field.
Default value: DateTime.MinValue

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getQuantity()
```
public final int getQuantity()
```

Identifies quantity, must be integer value from 0 to 500.
Quantity can be set to -1 in order not to use this field. Default value: -1

**Returns:**
int
##### setQuantity(int value)
```
public final void setQuantity(int value)
```

Identifies quantity, must be integer value from 0 to 500.
Quantity can be set to -1 in order not to use this field. Default value: -1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLinkCharacter()
```
public final char getLinkCharacter()
```

Identifies link character in output string.

**Returns:**
char
##### setLinkCharacter(char value)
```
public final void setLinkCharacter(char value)
```

Identifies link character in output string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object

### com.groupdocs.signature.domain.extensions.mailmark2d
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.mailmark2d.md

The **GroupDocs.Signature.Domain.Extensions.MailMark2D** namespace provides classes for working with MailMark2D

#### Classes

| Class | Description |
| --- | --- |
| Mailmark2D | Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark |
| Mailmark2DType | 2D Mailmark Type defines size of Data Matrix barcode |

### Mailmark2D
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.mailmark2d/mailmark2d.md

**Inheritance:**
java.lang.Object
```
public class Mailmark2D
```

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark

#### Constructors

| Constructor | Description |
| --- | --- |
| Mailmark2D() | Creates Royal Mail Mailmark combined data with default primary and secondary data values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getUPUCountryID() | Identifies the UPU Country ID.Max length: 4 characters.
 |
| setUPUCountryID(String value) | Identifies the UPU Country ID.Max length: 4 characters.
 |
| getInformationTypeID() | Identifies the Royal Mail Mailmark barcode payload for each product type.
 |
| setInformationTypeID(String value) | Identifies the Royal Mail Mailmark barcode payload for each product type.
 |
| getVersionID() | Identifies the barcode version as relevant to each Information Type ID.
 |
| getClass_() | Identifies the class of the item.
 |
| setClass(String value) | Identifies the class of the item.
 |
| getSupplyChainID() | Identifies the unique group of customers involved in the mailing.
 |
| setSupplyChainID(int value) | Identifies the unique group of customers involved in the mailing.
 |
| getItemID() | Identifies the unique item within the Supply Chain ID.
 |
| setItemID(int value) | Identifies the unique item within the Supply Chain ID.
 |
| getDestinationPostCodeAndDPS() | Contains the Postcode of the Delivery Address with DPS
If inland the Postcode/DP contains the following number of characters.
 |
| setDestinationPostCodeAndDPS(String value) | Contains the Postcode of the Delivery Address with DPS
If inland the Postcode/DP contains the following number of characters.
 |
| getRTSFlag() | Flag which indicates what level of Return to Sender service is being requested.
 |
| setRTSFlag(String value) | Flag which indicates what level of Return to Sender service is being requested.
 |
| getReturnToSenderPostCode() | Contains the Return to Sender Post Code but no DPS.
 |
| setReturnToSenderPostCode(String value) | Contains the Return to Sender Post Code but no DPS.
 |
| getCustomerContent() | Optional space for use by customer.
 |
| setCustomerContent(String value) | Optional space for use by customer.
 |
| getCustomerContentEncodeMode() | Encode mode of DataMatrix barcode.
 |
| setCustomerContentEncodeMode(int value) | Encode mode of DataMatrix barcode.
 |
| getDataMatrixType() | 2D Mailmark Type defines size of Data Matrix barcode.
 |
| setDataMatrixType(int value) | 2D Mailmark Type defines size of Data Matrix barcode.
 |
| deepClone() | Gets a copy of this object.
 |
##### Mailmark2D()
```
public Mailmark2D()
```

Creates Royal Mail Mailmark combined data with default primary and secondary data values.

##### getUPUCountryID()
```
public final String getUPUCountryID()
```

Identifies the UPU Country ID.Max length: 4 characters.

**Returns:**
java.lang.String
##### setUPUCountryID(String value)
```
public final void setUPUCountryID(String value)
```

Identifies the UPU Country ID.Max length: 4 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInformationTypeID()
```
public final String getInformationTypeID()
```

Identifies the Royal Mail Mailmark barcode payload for each product type.

<br />

*** ** * ** ***

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

<br />

**Returns:**
java.lang.String
##### setInformationTypeID(String value)
```
public final void setInformationTypeID(String value)
```

Identifies the Royal Mail Mailmark barcode payload for each product type.

<br />

*** ** * ** ***

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVersionID()
```
public final String getVersionID()
```

Identifies the barcode version as relevant to each Information Type ID.

<br />

*** ** * ** ***

Valid Values: "1" - currently used only this value (default) "0" and "2" to "9" and "A" to "Z" spare reserved for potential future use.

<br />

**Returns:**
java.lang.String
##### getClass_()
```
public final String getClass_()
```

Identifies the class of the item.

<br />

*** ** * ** ***

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

<br />

**Returns:**
java.lang.String
##### setClass(String value)
```
public final void setClass(String value)
```

Identifies the class of the item.

<br />

*** ** * ** ***

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSupplyChainID()
```
public final int getSupplyChainID()
```

Identifies the unique group of customers involved in the mailing.
Max value: 9999999.

**Returns:**
int
##### setSupplyChainID(int value)
```
public final void setSupplyChainID(int value)
```

Identifies the unique group of customers involved in the mailing.
Max value: 9999999.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getItemID()
```
public final int getItemID()
```

Identifies the unique item within the Supply Chain ID.
Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days.
Max value: 99999999.

**Returns:**
int
##### setItemID(int value)
```
public final void setItemID(int value)
```

Identifies the unique item within the Supply Chain ID.
Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days.
Max value: 99999999.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDestinationPostCodeAndDPS()
```
public final String getDestinationPostCodeAndDPS()
```

Contains the Postcode of the Delivery Address with DPS
If inland the Postcode/DP contains the following number of characters.
Area (1 or 2 characters)
District(1 or 2 characters)
Sector(1 character)
Unit(2 characters)
DPS (2 characters).
The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

**Returns:**
java.lang.String
##### setDestinationPostCodeAndDPS(String value)
```
public final void setDestinationPostCodeAndDPS(String value)
```

Contains the Postcode of the Delivery Address with DPS
If inland the Postcode/DP contains the following number of characters.
Area (1 or 2 characters)
District(1 or 2 characters)
Sector(1 character)
Unit(2 characters)
DPS (2 characters).
The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRTSFlag()
```
public final String getRTSFlag()
```

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

**Returns:**
java.lang.String
##### setRTSFlag(String value)
```
public final void setRTSFlag(String value)
```

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReturnToSenderPostCode()
```
public final String getReturnToSenderPostCode()
```

Contains the Return to Sender Post Code but no DPS.
The PC(without DPS) must comply with a PAF® format.

**Returns:**
java.lang.String
##### setReturnToSenderPostCode(String value)
```
public final void setReturnToSenderPostCode(String value)
```

Contains the Return to Sender Post Code but no DPS.
The PC(without DPS) must comply with a PAF® format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomerContent()
```
public final String getCustomerContent()
```

Optional space for use by customer.

<br />

*** ** * ** ***

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

<br />

**Returns:**
java.lang.String
##### setCustomerContent(String value)
```
public final void setCustomerContent(String value)
```

Optional space for use by customer.

<br />

*** ** * ** ***

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomerContentEncodeMode()
```
public final int getCustomerContentEncodeMode()
```

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

**Returns:**
int
##### setCustomerContentEncodeMode(int value)
```
public final void setCustomerContentEncodeMode(int value)
```

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataMatrixType()
```
public final int getDataMatrixType()
```

2D Mailmark Type defines size of Data Matrix barcode.

**Returns:**
int
##### setDataMatrixType(int value)
```
public final void setDataMatrixType(int value)
```

2D Mailmark Type defines size of Data Matrix barcode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object

### Mailmark2DType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.mailmark2d/mailmark2dtype.md

**Inheritance:**
java.lang.Object
```
public final class Mailmark2DType
```

2D Mailmark Type defines size of Data Matrix barcode

#### Fields

| Field | Description |
| --- | --- |
| Auto | Auto determine
 |
| Type_7 | 24 x 24 modules
 |
| Type_9 | 32 x 32 modules
 |
| Type_29 | 16 x 48 modules
 |
##### Auto
```
public static final int Auto
```

Auto determine

##### Type_7
```
public static final int Type_7
```

24 x 24 modules

##### Type_9
```
public static final int Type_9
```

32 x 32 modules

##### Type_29
```
public static final int Type_29
```

16 x 48 modules

### com.groupdocs.signature.domain.extensions.serialization
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization.md

The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.

#### Classes

| Class | Description |
| --- | --- |
| Address | Represents Address of VCard contact details. |
| CryptoCurrencyTransfer | Represents Crypto currency transfer (reciever or transfer) for QR-Code. |
| CryptoCurrencyType | Represents Crypto currency type. |
| DataMatrixEncodeMode | DataMatrix encoder's encoding mode, default to Auto |
| EPC | Represents European Payments Council Quick Response Code. |
| Email | Represents Email format for QR-Code. |
| Event | Represents standard QR-Code Event details. |
| MeCard | Represents MeCard standard contact details. |
| SMS | Represents SMS short message service details. |
| VCard | Represents VCard standard contact details. |
| WiFi | Represents WiFi network connection details. |
| WiFiEncryptionType | Represents WiFi Encryption type. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDataSerializer | Serialization interface to provide object serialization and deserialization methods. |

### Address
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/address.md

**Inheritance:**
java.lang.Object
```
public class Address
```

Represents Address of VCard contact details.

#### Constructors

| Constructor | Description |
| --- | --- |
| Address() |  |
#### Methods

| Method | Description |
| --- | --- |
| getStreet() | Get or set address street.
 |
| setStreet(String value) | Get or set address street.
 |
| getCity() | Get or set address city.
 |
| setCity(String value) | Get or set address city.
 |
| getState() | Get or set address state.
 |
| setState(String value) | Get or set address state.
 |
| getZIP() | Get or set address ZIP.
 |
| setZIP(String value) | Get or set address ZIP.
 |
| getCountry() | Get or set address country.
 |
| setCountry(String value) | Get or set address country.
 |
| equals(Object source) | Overwrites Equals method to compare Address properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### Address()
```
public Address()
```

##### getStreet()
```
public final String getStreet()
```

Get or set address street.

**Returns:**
java.lang.String
##### setStreet(String value)
```
public final void setStreet(String value)
```

Get or set address street.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCity()
```
public final String getCity()
```

Get or set address city.

**Returns:**
java.lang.String
##### setCity(String value)
```
public final void setCity(String value)
```

Get or set address city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getState()
```
public final String getState()
```

Get or set address state.

**Returns:**
java.lang.String
##### setState(String value)
```
public final void setState(String value)
```

Get or set address state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZIP()
```
public final String getZIP()
```

Get or set address ZIP.

**Returns:**
java.lang.String
##### setZIP(String value)
```
public final void setZIP(String value)
```

Get or set address ZIP.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCountry()
```
public final String getCountry()
```

Get or set address country.

**Returns:**
java.lang.String
##### setCountry(String value)
```
public final void setCountry(String value)
```

Get or set address country.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Address properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Address object to compare with.
 |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### CryptoCurrencyTransfer
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/cryptocurrencytransfer.md

**Inheritance:**
java.lang.Object
```
public class CryptoCurrencyTransfer
```

Represents Crypto currency transfer (reciever or transfer) for QR-Code.

#### Constructors

| Constructor | Description |
| --- | --- |
| CryptoCurrencyTransfer() |  |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Gets or sets one of supported crypto currency type.
 |
| setType(int value) | Gets or sets one of supported crypto currency type.
 |
| getAmount() | Gets or sets transfer amount.
 |
| setAmount(BigDecimal value) | Gets or sets transfer amount.
 |
| getAddress() | Gets or sets crypto currency public address.
 |
| setAddress(String value) | Gets or sets crypto currency public address.
 |
| getMessage() | Gets or sets optional transfer message.
 |
| setMessage(String value) | Gets or sets optional transfer message.
 |
| getCustomType() | Gets or sets optional transfer message.
 |
| setCustomType(String value) | Gets or sets optional transfer message.
 |
| equals(Object obj) | Overwrites Equals method to compare Crypto currency transfer properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### CryptoCurrencyTransfer()
```
public CryptoCurrencyTransfer()
```

##### getType()
```
public final int getType()
```

Gets or sets one of supported crypto currency type.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Gets or sets one of supported crypto currency type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAmount()
```
public final BigDecimal getAmount()
```

Gets or sets transfer amount.

**Returns:**
java.math.BigDecimal
##### setAmount(BigDecimal value)
```
public final void setAmount(BigDecimal value)
```

Gets or sets transfer amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.math.BigDecimal |  |

##### getAddress()
```
public final String getAddress()
```

Gets or sets crypto currency public address.

**Returns:**
java.lang.String
##### setAddress(String value)
```
public final void setAddress(String value)
```

Gets or sets crypto currency public address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMessage()
```
public final String getMessage()
```

Gets or sets optional transfer message.

**Returns:**
java.lang.String
##### setMessage(String value)
```
public final void setMessage(String value)
```

Gets or sets optional transfer message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomType()
```
public final String getCustomType()
```

Gets or sets optional transfer message.

**Returns:**
java.lang.String
##### setCustomType(String value)
```
public final void setCustomType(String value)
```

Gets or sets optional transfer message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare Crypto currency transfer properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Crypto currency transfer object to compare with.
 |

**Returns:**
boolean - Returns true if passed Crypto currency transfer object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Crypto currency transfer hash code

### CryptoCurrencyType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/cryptocurrencytype.md

**Inheritance:**
java.lang.Object
```
public final class CryptoCurrencyType
```

Represents Crypto currency type.

#### Fields

| Field | Description |
| --- | --- |
| Custom | Represents custom crypto currency type.
 |
| Bitcoin | Represents Bitcoin crypto currency type.
 |
| BitcoinCash | Represents Bitcoin Cash crypto currency type.
 |
| Litecoin | Represents Litecoin crypto currency type.
 |
| Ethereum | Represents Ethereum crypto currency type.
 |
| Dash | Represents Dash crypto currency type.
 |
##### Custom
```
public static final int Custom
```

Represents custom crypto currency type.

##### Bitcoin
```
public static final int Bitcoin
```

Represents Bitcoin crypto currency type.

##### BitcoinCash
```
public static final int BitcoinCash
```

Represents Bitcoin Cash crypto currency type.

##### Litecoin
```
public static final int Litecoin
```

Represents Litecoin crypto currency type.

##### Ethereum
```
public static final int Ethereum
```

Represents Ethereum crypto currency type.

##### Dash
```
public static final int Dash
```

Represents Dash crypto currency type.

### DataMatrixEncodeMode
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/datamatrixencodemode.md

**Inheritance:**
java.lang.Object
```
public final class DataMatrixEncodeMode
```

DataMatrix encoder's encoding mode, default to Auto

#### Fields

| Field | Description |
| --- | --- |
| Auto | Automatically pick up the best encode mode for DataMatrix encoding
 |
| ASCII | Encodes one alphanumeric or two numeric characters per byte
 |
| Full | Encode 8 bit values
 |
| Custom | Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding
 |
| C40 | Uses C40 encoding.
 |
| Text | Uses Text encoding.
 |
| EDIFACT | Uses EDIFACT encoding.
 |
| ANSIX12 | Uses ANSI X12 encoding.
 |
| ExtendedCodetext | ExtendedCodetext mode allows to manually switch encoding schemes in code-text.
 |
##### Auto
```
public static final int Auto
```

Automatically pick up the best encode mode for DataMatrix encoding

##### ASCII
```
public static final int ASCII
```

Encodes one alphanumeric or two numeric characters per byte

##### Full
```
public static final int Full
```

Encode 8 bit values

##### Custom
```
public static final int Custom
```

Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding

##### C40
```
public static final int C40
```

Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters

##### Text
```
public static final int Text
```

Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters.

##### EDIFACT
```
public static final int EDIFACT
```

Uses EDIFACT encoding. Uses six bits per character, encodes digits,
upper-case letters, and many punctuation marks, but has no support for lower-case letters.

##### ANSIX12
```
public static final int ANSIX12
```

Uses ANSI X12 encoding.

##### ExtendedCodetext
```
public static final int ExtendedCodetext
```

ExtendedCodetext mode allows to manually switch encoding schemes in code-text.
Format : "\\Encodation_scheme_name:text\\Encodation_scheme_name:text".
Allowed encoding schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto.
Extended code-text example: @"\\ansix12:ANSIX12TEXT\\ascii:backslash must be \\\\
doubled\\edifact:EdifactEncodedText"
All backslashes (\\) must be doubled in text.

### Email
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/email.md

**Inheritance:**
java.lang.Object
```
public class Email
```

Represents Email format for QR-Code.

#### Constructors

| Constructor | Description |
| --- | --- |
| Email() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAddress() | Get or set Email address.
 |
| setAddress(String value) | Get or set Email address.
 |
| getSubject() | Get or set email Subject.
 |
| setSubject(String value) | Get or set email Subject.
 |
| getBody() | Get or set Body of email message.
 |
| setBody(String value) | Get or set Body of email message.
 |
| equals(Object source) | Overwrites Equals method to compare Email properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### Email()
```
public Email()
```

##### getAddress()
```
public final String getAddress()
```

Get or set Email address.

**Returns:**
java.lang.String
##### setAddress(String value)
```
public final void setAddress(String value)
```

Get or set Email address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Get or set email Subject.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Get or set email Subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBody()
```
public final String getBody()
```

Get or set Body of email message.

**Returns:**
java.lang.String
##### setBody(String value)
```
public final void setBody(String value)
```

Get or set Body of email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Email properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Email object to compare with.
 |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### EPC
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/epc.md

**Inheritance:**
java.lang.Object
```
public final class EPC
```

Represents European Payments Council Quick Response Code.

#### Constructors

| Constructor | Description |
| --- | --- |
| EPC() | Instantiates new EPC object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets Beneficiary's Name.
 |
| setName(String value) | Gets or sets Beneficiary's Name.
 |
| getBIC() | Gets or sets Beneficiary's BIC with up to 11 characters length.
 |
| setBIC(String value) | Gets or sets Beneficiary's BIC with up to 11 characters length.
 |
| getIBAN() | Gets or sets Beneficiary's Account (IBAN).
 |
| setIBAN(String value) | Gets or sets Beneficiary's Account (IBAN).
 |
| getAmount() | Gets or sets amount.
 |
| setAmount(double value) | Gets or sets amount.
 |
| getCode() | Gets or sets Business Code up to 4 characters.
 |
| setCode(String value) | Gets or sets Business Code up to 4 characters.
 |
| getReference() | Gets or sets Payment Reference (maximum 35 characters).
 |
| setReference(String value) | Gets or sets Payment Reference (maximum 35 characters).
 |
| getRemittance() | Gets or sets Remittance Information (maximum 140 characters).
 |
| setRemittance(String value) | Gets or sets Remittance Information (maximum 140 characters).
 |
| getInformation() | Gets or sets hint information.
 |
| setInformation(String value) | Gets or sets hint information.
 |
| getVersion() | EPC / SEPA QR-Code version implementation.
 |
| setVersion(String value) | EPC / SEPA QR-Code version implementation.
 |
| getCharset() | EPC / SEPA QR-Code char set implementation.
 |
| setCharset(String value) | EPC / SEPA QR-Code char set implementation.
 |
| getIdentification() | EPC / SEPA QR-Code identification.
 |
| setIdentification(String value) | EPC / SEPA QR-Code identification.
 |
| equals(Object source) | Overwrites Equals method to compare EPC properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### EPC()
```
public EPC()
```

Instantiates new EPC object.

##### getName()
```
public final String getName()
```

Gets or sets Beneficiary's Name. Maximum length is 70 characters.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets Beneficiary's Name. Maximum length is 70 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBIC()
```
public final String getBIC()
```

Gets or sets Beneficiary's BIC with up to 11 characters length.

**Returns:**
java.lang.String
##### setBIC(String value)
```
public final void setBIC(String value)
```

Gets or sets Beneficiary's BIC with up to 11 characters length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIBAN()
```
public final String getIBAN()
```

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.

**Returns:**
java.lang.String
##### setIBAN(String value)
```
public final void setIBAN(String value)
```

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAmount()
```
public final double getAmount()
```

Gets or sets amount.

**Returns:**
double
##### setAmount(double value)
```
public final void setAmount(double value)
```

Gets or sets amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getCode()
```
public final String getCode()
```

Gets or sets Business Code up to 4 characters.

**Returns:**
java.lang.String
##### setCode(String value)
```
public final void setCode(String value)
```

Gets or sets Business Code up to 4 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReference()
```
public final String getReference()
```

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.

**Returns:**
java.lang.String
##### setReference(String value)
```
public final void setReference(String value)
```

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRemittance()
```
public final String getRemittance()
```

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.

**Returns:**
java.lang.String
##### setRemittance(String value)
```
public final void setRemittance(String value)
```

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInformation()
```
public final String getInformation()
```

Gets or sets hint information. Maximum 70 characters.

**Returns:**
java.lang.String
##### setInformation(String value)
```
public final void setInformation(String value)
```

Gets or sets hint information. Maximum 70 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVersion()
```
public final String getVersion()
```

EPC / SEPA QR-Code version implementation. By default this value set to 002.

**Returns:**
java.lang.String
##### setVersion(String value)
```
public final void setVersion(String value)
```

EPC / SEPA QR-Code version implementation. By default this value set to 002.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCharset()
```
public final String getCharset()
```

EPC / SEPA QR-Code char set implementation. By default this value set to 1

**Returns:**
java.lang.String
##### setCharset(String value)
```
public final void setCharset(String value)
```

EPC / SEPA QR-Code char set implementation. By default this value set to 1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIdentification()
```
public final String getIdentification()
```

EPC / SEPA QR-Code identification. By default this value set to SCT

**Returns:**
java.lang.String
##### setIdentification(String value)
```
public final void setIdentification(String value)
```

EPC / SEPA QR-Code identification. By default this value set to SCT

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare EPC properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | EPC object to compare with.
 |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### Event
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/event.md

**Inheritance:**
java.lang.Object
```
public final class Event
```

Represents standard QR-Code Event details.

#### Constructors

| Constructor | Description |
| --- | --- |
| Event() | Creates Event instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets or sets event title.
 |
| setTitle(String value) | Gets or sets event title.
 |
| getDescription() | Gets or sets description.
 |
| setDescription(String value) | Gets or sets description.
 |
| getLocation() | Gets or sets event location.
 |
| setLocation(String value) | Gets or sets event location.
 |
| getStartDate() | Gets or sets event start date and time.
 |
| setStartDate(Date value) | Gets or sets event start date and time.
 |
| getEndDate() | Gets or sets event end date and time.
 |
| setEndDate(Date value) | Gets or sets event end date and time.
 |
| equals(Object source) | Overwrites Equals method to compare Event properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### Event()
```
public Event()
```

Creates Event instance with default values.

##### getTitle()
```
public final String getTitle()
```

Gets or sets event title.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets event title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDescription()
```
public final String getDescription()
```

Gets or sets description.

**Returns:**
java.lang.String
##### setDescription(String value)
```
public final void setDescription(String value)
```

Gets or sets description.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Gets or sets event location.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Gets or sets event location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStartDate()
```
public final Date getStartDate()
```

Gets or sets event start date and time.

**Returns:**
java.util.Date
##### setStartDate(Date value)
```
public final void setStartDate(Date value)
```

Gets or sets event start date and time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getEndDate()
```
public final Date getEndDate()
```

Gets or sets event end date and time.

**Returns:**
java.util.Date
##### setEndDate(Date value)
```
public final void setEndDate(Date value)
```

Gets or sets event end date and time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Event properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Event object to compare with.
 |

**Returns:**
boolean - Returns true if passed Event object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Event hash code

### IDataSerializer
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/idataserializer.md

### MeCard
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/mecard.md

**Inheritance:**
java.lang.Object
```
public final class MeCard
```

Represents MeCard standard contact details.

#### Constructors

| Constructor | Description |
| --- | --- |
| MeCard() | Creates MeCard instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets contact Name.
 |
| setName(String value) | Gets or sets contact Name.
 |
| getNickname() | Gets or sets contact Nickname.
 |
| setNickname(String value) | Gets or sets contact Nickname.
 |
| getPhone() | Gets or sets phone number.
 |
| setPhone(String value) | Gets or sets phone number.
 |
| getAltPhone() | Gets or sets alternative phone number.
 |
| setAltPhone(String value) | Gets or sets alternative phone number.
 |
| getReading() | Gets or sets reading of name.
 |
| setReading(String value) | Gets or sets reading of name.
 |
| getEmail() | Gets or sets contact email.
 |
| setEmail(String value) | Gets or sets contact email.
 |
| getNote() | Gets or sets Note (Company) of contact.
 |
| setNote(String value) | Gets or sets Note (Company) of contact.
 |
| getUrl() | Gets or sets URL.
 |
| setUrl(String value) | Gets or sets URL.
 |
| getAddress() | Gets or sets Home Address properties.
 |
| setAddress(Address value) | Gets or sets Home Address properties.
 |
| getBirthDay() | Gets or sets contact birthday.
 |
| setBirthDay(Date value) | Gets or sets contact birthday.
 |
| equals(Object source) | Overwrites Equals method to compare MeCard properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### MeCard()
```
public MeCard()
```

Creates MeCard instance with default values.

##### getName()
```
public final String getName()
```

Gets or sets contact Name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets contact Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNickname()
```
public final String getNickname()
```

Gets or sets contact Nickname.

**Returns:**
java.lang.String
##### setNickname(String value)
```
public final void setNickname(String value)
```

Gets or sets contact Nickname.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPhone()
```
public final String getPhone()
```

Gets or sets phone number.

**Returns:**
java.lang.String
##### setPhone(String value)
```
public final void setPhone(String value)
```

Gets or sets phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAltPhone()
```
public final String getAltPhone()
```

Gets or sets alternative phone number.

**Returns:**
java.lang.String
##### setAltPhone(String value)
```
public final void setAltPhone(String value)
```

Gets or sets alternative phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReading()
```
public final String getReading()
```

Gets or sets reading of name.

**Returns:**
java.lang.String
##### setReading(String value)
```
public final void setReading(String value)
```

Gets or sets reading of name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets contact email.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets contact email.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNote()
```
public final String getNote()
```

Gets or sets Note (Company) of contact.

**Returns:**
java.lang.String
##### setNote(String value)
```
public final void setNote(String value)
```

Gets or sets Note (Company) of contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUrl()
```
public final String getUrl()
```

Gets or sets URL.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Gets or sets URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddress()
```
public final Address getAddress()
```

Gets or sets Home Address properties. This property is not initialized by default.

**Returns:**
Address
##### setAddress(Address value)
```
public final void setAddress(Address value)
```

Gets or sets Home Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getBirthDay()
```
public final Date getBirthDay()
```

Gets or sets contact birthday.

**Returns:**
java.util.Date
##### setBirthDay(Date value)
```
public final void setBirthDay(Date value)
```

Gets or sets contact birthday.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare MeCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | MeCard object to compare with.
 |

**Returns:**
boolean - Returns true if passed MeCard object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - MeCard hash code

### SMS
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/sms.md

**Inheritance:**
java.lang.Object
```
public class SMS
```

Represents SMS short message service details.

#### Constructors

| Constructor | Description |
| --- | --- |
| SMS() | Creates VCard instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getNumber() | Gets or sets SMS receipient phone number.
 |
| setNumber(String value) | Gets or sets SMS receipient phone number.
 |
| getMessage() | Gets or sets SMS message content.
 |
| setMessage(String value) | Gets or sets SMS message content.
 |
| equals(Object obj) | Overwrites Equals method to compare SMS properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### SMS()
```
public SMS()
```

Creates VCard instance with default values.

##### getNumber()
```
public final String getNumber()
```

Gets or sets SMS receipient phone number.

**Returns:**
java.lang.String
##### setNumber(String value)
```
public final void setNumber(String value)
```

Gets or sets SMS receipient phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMessage()
```
public final String getMessage()
```

Gets or sets SMS message content.

**Returns:**
java.lang.String
##### setMessage(String value)
```
public final void setMessage(String value)
```

Gets or sets SMS message content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare SMS properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | SMS object to compare with.
 |

**Returns:**
boolean - Returns true if passed SMS object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### VCard
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/vcard.md

**Inheritance:**
java.lang.Object
```
public class VCard
```

Represents VCard standard contact details.

#### Constructors

| Constructor | Description |
| --- | --- |
| VCard() | Creates VCard instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFirstName() | Get or set contact First Name.
 |
| setFirstName(String value) | Get or set contact First Name.
 |
| getMidddleName() | Get or set contact Middle Name.
 |
| setMidddleName(String value) | Get or set contact Middle Name.
 |
| getLastName() | Get or set contact Last Name.
 |
| setLastName(String value) | Get or set contact Last Name.
 |
| getInitials() | Get or set contact initials.
 |
| setInitials(String value) | Get or set contact initials.
 |
| getCompany() | Get or set Company of contact.
 |
| setCompany(String value) | Get or set Company of contact.
 |
| getJobTitle() | Get or set contact Job Title.
 |
| setJobTitle(String value) | Get or set contact Job Title.
 |
| getHomeAddress() | Gets or sets Home Address properties.
 |
| setHomeAddress(Address value) | Gets or sets Home Address properties.
 |
| getWorkAddress() | Gets or sets Work Address properties.
 |
| setWorkAddress(Address value) | Gets or sets Work Address properties.
 |
| getHomePhone() | Gets or sets home phone number.
 |
| setHomePhone(String value) | Gets or sets home phone number.
 |
| getWorkPhone() | Gets or sets work phone number.
 |
| setWorkPhone(String value) | Gets or sets work phone number.
 |
| getCellPhone() | Gets or sets cellular phone number.
 |
| setCellPhone(String value) | Gets or sets cellular phone number.
 |
| getEmail() | Gets or sets contact email.
 |
| setEmail(String value) | Gets or sets contact email.
 |
| getUrl() | Gets or sets contact URL.
 |
| setUrl(String value) | Gets or sets contact URL.
 |
| getBirthDay() | Gets or sets contact birthday.
 |
| setBirthDay(Date value) | Gets or sets contact birthday.
 |
| equals(Object source) | Overwrites Equals method to compare VCard properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### VCard()
```
public VCard()
```

Creates VCard instance with default values.

##### getFirstName()
```
public final String getFirstName()
```

Get or set contact First Name.

**Returns:**
java.lang.String
##### setFirstName(String value)
```
public final void setFirstName(String value)
```

Get or set contact First Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMidddleName()
```
public final String getMidddleName()
```

Get or set contact Middle Name.

**Returns:**
java.lang.String
##### setMidddleName(String value)
```
public final void setMidddleName(String value)
```

Get or set contact Middle Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLastName()
```
public final String getLastName()
```

Get or set contact Last Name.

**Returns:**
java.lang.String
##### setLastName(String value)
```
public final void setLastName(String value)
```

Get or set contact Last Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInitials()
```
public final String getInitials()
```

Get or set contact initials.

**Returns:**
java.lang.String
##### setInitials(String value)
```
public final void setInitials(String value)
```

Get or set contact initials.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCompany()
```
public final String getCompany()
```

Get or set Company of contact.

**Returns:**
java.lang.String
##### setCompany(String value)
```
public final void setCompany(String value)
```

Get or set Company of contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getJobTitle()
```
public final String getJobTitle()
```

Get or set contact Job Title.

**Returns:**
java.lang.String
##### setJobTitle(String value)
```
public final void setJobTitle(String value)
```

Get or set contact Job Title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHomeAddress()
```
public final Address getHomeAddress()
```

Gets or sets Home Address properties. This property is not initialized by default.

**Returns:**
Address
##### setHomeAddress(Address value)
```
public final void setHomeAddress(Address value)
```

Gets or sets Home Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getWorkAddress()
```
public final Address getWorkAddress()
```

Gets or sets Work Address properties. This property is not initialized by default.

**Returns:**
Address
##### setWorkAddress(Address value)
```
public final void setWorkAddress(Address value)
```

Gets or sets Work Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getHomePhone()
```
public final String getHomePhone()
```

Gets or sets home phone number.

**Returns:**
java.lang.String
##### setHomePhone(String value)
```
public final void setHomePhone(String value)
```

Gets or sets home phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getWorkPhone()
```
public final String getWorkPhone()
```

Gets or sets work phone number.

**Returns:**
java.lang.String
##### setWorkPhone(String value)
```
public final void setWorkPhone(String value)
```

Gets or sets work phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCellPhone()
```
public final String getCellPhone()
```

Gets or sets cellular phone number.

**Returns:**
java.lang.String
##### setCellPhone(String value)
```
public final void setCellPhone(String value)
```

Gets or sets cellular phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets contact email.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets contact email.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUrl()
```
public final String getUrl()
```

Gets or sets contact URL.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Gets or sets contact URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBirthDay()
```
public final Date getBirthDay()
```

Gets or sets contact birthday.

**Returns:**
java.util.Date
##### setBirthDay(Date value)
```
public final void setBirthDay(Date value)
```

Gets or sets contact birthday.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare VCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | VCard object to compare with.
 |

**Returns:**
boolean - Returns true if passed VCard object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### WiFi
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/wifi.md

**Inheritance:**
java.lang.Object
```
public class WiFi
```

Represents WiFi network connection details.

#### Constructors

| Constructor | Description |
| --- | --- |
| WiFi() | Creates VCard instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSSID() | Gets or sets WiFi SSID Name.
 |
| setSSID(String value) | Gets or sets WiFi SSID Name.
 |
| getPassword() | Gets or sets WiFi Password.
 |
| setPassword(String value) | Gets or sets WiFi Password.
 |
| getEncryption() | Gets or sets WiFi encryption WiFiEncryptionType.
 |
| setEncryption(int value) | Gets or sets WiFi encryption WiFiEncryptionType.
 |
| getHidden() | Gets or sets if WiFi is Hidden SSID.
 |
| setHidden(boolean value) | Gets or sets if WiFi is Hidden SSID.
 |
| equals(Object obj) | Overwrites Equals method to compare VCard properties
 |
| hashCode() | Overrides GetHashCode method
 |
##### WiFi()
```
public WiFi()
```

Creates VCard instance with default values.

##### getSSID()
```
public final String getSSID()
```

Gets or sets WiFi SSID Name.

**Returns:**
java.lang.String
##### setSSID(String value)
```
public final void setSSID(String value)
```

Gets or sets WiFi SSID Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets WiFi Password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets WiFi Password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEncryption()
```
public final int getEncryption()
```

Gets or sets WiFi encryption WiFiEncryptionType.

**Returns:**
int
##### setEncryption(int value)
```
public final void setEncryption(int value)
```

Gets or sets WiFi encryption WiFiEncryptionType.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHidden()
```
public final boolean getHidden()
```

Gets or sets if WiFi is Hidden SSID.

**Returns:**
boolean
##### setHidden(boolean value)
```
public final void setHidden(boolean value)
```

Gets or sets if WiFi is Hidden SSID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare VCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | VCard object to compare with.
 |

**Returns:**
boolean - Returns true if passed VCard object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### WiFiEncryptionType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.serialization/wifiencryptiontype.md

**Inheritance:**
java.lang.Object
```
public final class WiFiEncryptionType
```

Represents WiFi Encryption type.

#### Fields

| Field | Description |
| --- | --- |
| None | Represents no encryption WiFi type.
 |
| WPA | Represents WiFi with the WPA encryption type.
 |
| WPAEAP | Represents WiFi with the WPA-EAP encryption type.
 |
| WPAWPA2 | Represents WiFi with the WPA/WPA2 encryption type.
 |
| WEP | Represents WiFi with the WEP encryption type.
 |
##### None
```
public static final int None
```

Represents no encryption WiFi type.

##### WPA
```
public static final int WPA
```

Represents WiFi with the WPA encryption type.

##### WPAEAP
```
public static final int WPAEAP
```

Represents WiFi with the WPA-EAP encryption type.

##### WPAWPA2
```
public static final int WPAWPA2
```

Represents WiFi with the WPA/WPA2 encryption type.

##### WEP
```
public static final int WEP
```

Represents WiFi with the WEP encryption type.

### com.groupdocs.signature.domain.extensions.signoptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.signoptions.md

The **GroupDocs.Signature.Domain.Extensions.SignOptions** namespace provides classes for working with SignOptions

#### Classes

| Class | Description |
| --- | --- |
| DigitalVBA | Represents digital signature for Spreadsheets VBA projects. |
| SignatureExtension | Represents base class for signatures extensions. |
| SpreadsheetPosition | Defines signature position for Spreadsheet documents. |
| TextShadow | Represents text shadow properties for text signatures. |

### DigitalVBA
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.signoptions/digitalvba.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class DigitalVBA extends SignatureExtension
```

Represents digital signature for Spreadsheets VBA projects.
It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm.
If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing.

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalVBA(String certificateFilePath, String password) | Initializes a new instance of the DigitalVBA class with certificate file.
 |
| DigitalVBA(InputStream certificateStream, String password) | Initializes a new instance of the DigitalVBA class with certificate stream.
 |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets or sets the signature comments.
 |
| setComments(String value) | Gets or sets the signature comments.
 |
| getPassword() | Gets or sets the password of digital certificate.
 |
| setPassword(String value) | Gets or sets the password of digital certificate.
 |
| getSignOnlyVBAProject() | Gets or sets setting of only VBA project signing.
 |
| setSignOnlyVBAProject(boolean value) | Gets or sets setting of only VBA project signing.
 |
| getCertificateFilePath() | Gets digital certificate file path.
 |
| getCertificateStream() | Gets digital certificate stream.
 |
| release() | Override method to clean up resources after signing.
 |
##### DigitalVBA(String certificateFilePath, String password)
```
public DigitalVBA(String certificateFilePath, String password)
```

Initializes a new instance of the DigitalVBA class with certificate file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path
 |
| password | java.lang.String | Digital certificate password
 |

##### DigitalVBA(InputStream certificateStream, String password)
```
public DigitalVBA(InputStream certificateStream, String password)
```

Initializes a new instance of the DigitalVBA class with certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream
 |
| password | java.lang.String | Digital certificate password
 |

##### getComments()
```
public final String getComments()
```

Gets or sets the signature comments.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Gets or sets the signature comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets the password of digital certificate.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets the password of digital certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignOnlyVBAProject()
```
public final boolean getSignOnlyVBAProject()
```

Gets or sets setting of only VBA project signing.
If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.

**Returns:**
boolean
##### setSignOnlyVBAProject(boolean value)
```
public final void setSignOnlyVBAProject(boolean value)
```

Gets or sets setting of only VBA project signing.
If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

Gets digital certificate file path.
This property is used only if CertificateStream is not specified.

**Returns:**
java.lang.String
##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Gets digital certificate stream.
If this property is specified it is always used instead CertificateFilePath.

**Returns:**
java.io.InputStream
##### release()
```
public void release()
```

Override method to clean up resources after signing.

### SignatureExtension
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.signoptions/signatureextension.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Cloneable
```
public abstract class SignatureExtension implements Cloneable
```

Represents base class for signatures extensions.

#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureExtension() |  |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Gets a copy of this object.
 |
| release() | Releasing resources.
 |
##### SignatureExtension()
```
public SignatureExtension()
```

##### deepClone()
```
public Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### release()
```
public void release()
```

Releasing resources.

### SpreadsheetPosition
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.signoptions/spreadsheetposition.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class SpreadsheetPosition extends SignatureExtension
```

Defines signature position for Spreadsheet documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetPosition(int row, int column) | Creates Spreadsheer siganture position with predefined row and column.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRow() | Gets or sets the top row number of signature (min value is 0).
 |
| setRow(int value) | Gets or sets the top row number of signature (min value is 0).
 |
| getColumn() | Gets or sets the left column number of signature (min value is 0).
 |
| setColumn(int value) | Gets or sets the left column number of signature (min value is 0).
 |
##### SpreadsheetPosition(int row, int column)
```
public SpreadsheetPosition(int row, int column)
```

Creates Spreadsheer siganture position with predefined row and column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | int |  |
| column | int |  |

##### getRow()
```
public final int getRow()
```

Gets or sets the top row number of signature (min value is 0).

**Returns:**
int
##### setRow(int value)
```
public final void setRow(int value)
```

Gets or sets the top row number of signature (min value is 0).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getColumn()
```
public final int getColumn()
```

Gets or sets the left column number of signature (min value is 0).

**Returns:**
int
##### setColumn(int value)
```
public final void setColumn(int value)
```

Gets or sets the left column number of signature (min value is 0).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### TextShadow
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.signoptions/textshadow.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class TextShadow extends SignatureExtension
```

Represents text shadow properties for text signatures.
The result may vary depending on the signature type and document format.
TextShadow is recommended for using with TextAsImage signature for all supported document types,
also with simple TextSignature and TextSignature as watermark for Cells (.xslx) and Slides (.pptx).
Simple TextSignature for Words (.docx) is recommended too, but has limited functionality.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextShadow() | Creates TextShadow with default options.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDistance() | Gets or sets distance from text to shadow.
 |
| setDistance(double value) | Gets or sets distance from text to shadow.
 |
| getAngle() | Gets or sets angle for placing shadow relative to the text.
 |
| setAngle(double value) | Gets or sets angle for placing shadow relative to the text.
 |
| getColor() | Gets or sets color of the shadow.
 |
| setColor(Color value) | Gets or sets color of the shadow.
 |
| setColor(String value) | Gets or sets color of the shadow.
 |
| getTransparency() | Gets or sets transparency of the shadow.
 |
| setTransparency(double value) | Gets or sets transparency of the shadow.
 |
| getBlur() | Gets or sets blur of the shadow.
 |
| setBlur(double value) | Gets or sets blur of the shadow.
 |
##### TextShadow()
```
public TextShadow()
```

Creates TextShadow with default options.

##### getDistance()
```
public final double getDistance()
```

Gets or sets distance from text to shadow.
Default value is 1.

**Returns:**
double
##### setDistance(double value)
```
public final void setDistance(double value)
```

Gets or sets distance from text to shadow.
Default value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getAngle()
```
public final double getAngle()
```

Gets or sets angle for placing shadow relative to the text.
Default value is 0.

**Returns:**
double
##### setAngle(double value)
```
public final void setAngle(double value)
```

Gets or sets angle for placing shadow relative to the text.
Default value is 0.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getColor()
```
public final Color getColor()
```

Gets or sets color of the shadow.
Default value is Black.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets color of the shadow.
Default value is Black.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets color of the shadow.
Default value is Black.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets transparency of the shadow.
Default value is 0.

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets transparency of the shadow.
Default value is 0.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBlur()
```
public final double getBlur()
```

Gets or sets blur of the shadow.
Default value is 4.

**Returns:**
double
##### setBlur(double value)
```
public final void setBlur(double value)
```

Gets or sets blur of the shadow.
Default value is 4.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

### com.groupdocs.signature.domain.extensions.swissqr
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.swissqr.md

The **GroupDocs.Signature.Domain.Extensions.SwissQR** namespace provides classes for working with SwissQR

#### Classes

| Class | Description |
| --- | --- |
| SwissAddress | Represents the address of the creditor or debtor. |
| SwissQR | Class for encoding and decoding the text embedded in the SwissQR code. |

### SwissAddress
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.swissqr/swissaddress.md

**Inheritance:**
java.lang.Object
```
public class SwissAddress
```

Represents the address of the creditor or debtor.
You can either set street, house number, postal code, and town (structured address type)
or address line 1 and 2 (combined address elements type).

#### Constructors

| Constructor | Description |
| --- | --- |
| SwissAddress() |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets the name, either the first and last name of a natural person or
the company name of a legal person.
 |
| setName(String value) | Gets or sets the name, either the first and last name of a natural person or
the company name of a legal person.
 |
| getAddressLine1() | Gets or sets the address line 1.
 |
| setAddressLine1(String value) | Gets or sets the address line 1.
 |
| getAddressLine2() | Gets or sets the address line 2.
 |
| setAddressLine2(String value) | Gets or sets the address line 2.
 |
| getStreet() | Gets or sets the street.
 |
| setStreet(String value) | Gets or sets the street.
 |
| getHouseNo() | Gets or sets the house number.
 |
| setHouseNo(String value) | Gets or sets the house number.
 |
| getPostalCode() | Gets or sets the postal code.
 |
| setPostalCode(String value) | Gets or sets the postal code.
 |
| getTown() | Gets or sets the town or city.
 |
| setTown(String value) | Gets or sets the town or city.
 |
| getCountryCode() | Gets or sets the two-letter ISO country code.
 |
| setCountryCode(String value) | Gets or sets the two-letter ISO country code.
 |
##### SwissAddress()
```
public SwissAddress()
```

##### getName()
```
public final String getName()
```

Gets or sets the name, either the first and last name of a natural person or
the company name of a legal person.
Value: The name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets the name, either the first and last name of a natural person or
the company name of a legal person.
Value: The name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddressLine1()
```
public final String getAddressLine1()
```

Gets or sets the address line 1.
Address line 1 contains street name, house number or P.O. box.
This field is only used for combined elements addresses and is optional.
Value: The address line 1.

**Returns:**
java.lang.String
##### setAddressLine1(String value)
```
public final void setAddressLine1(String value)
```

Gets or sets the address line 1.
Address line 1 contains street name, house number or P.O. box.
This field is only used for combined elements addresses and is optional.
Value: The address line 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddressLine2()
```
public final String getAddressLine2()
```

Gets or sets the address line 2.
Address line 2 contains postal code and town.
This field is only used for combined elements addresses. For this type, it's mandatory.
Value: The address line 2.

**Returns:**
java.lang.String
##### setAddressLine2(String value)
```
public final void setAddressLine2(String value)
```

Gets or sets the address line 2.
Address line 2 contains postal code and town.
This field is only used for combined elements addresses. For this type, it's mandatory.
Value: The address line 2.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStreet()
```
public final String getStreet()
```

Gets or sets the street.
The street must be specified without a house number.
This field is only used for structured addresses and is optional.
Value: The street.

**Returns:**
java.lang.String
##### setStreet(String value)
```
public final void setStreet(String value)
```

Gets or sets the street.
The street must be specified without a house number.
This field is only used for structured addresses and is optional.
Value: The street.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHouseNo()
```
public final String getHouseNo()
```

Gets or sets the house number.
This field is only used for structured addresses and is optional.
Value: The house number.

**Returns:**
java.lang.String
##### setHouseNo(String value)
```
public final void setHouseNo(String value)
```

Gets or sets the house number.
This field is only used for structured addresses and is optional.
Value: The house number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPostalCode()
```
public final String getPostalCode()
```

Gets or sets the postal code.
This field is only used for structured addresses. For this type, it's mandatory.
Value: The postal code.

**Returns:**
java.lang.String
##### setPostalCode(String value)
```
public final void setPostalCode(String value)
```

Gets or sets the postal code.
This field is only used for structured addresses. For this type, it's mandatory.
Value: The postal code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTown()
```
public final String getTown()
```

Gets or sets the town or city.
This field is only used for structured addresses. For this type, it's mandatory.
Value: The town or city.

**Returns:**
java.lang.String
##### setTown(String value)
```
public final void setTown(String value)
```

Gets or sets the town or city.
This field is only used for structured addresses. For this type, it's mandatory.
Value: The town or city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCountryCode()
```
public final String getCountryCode()
```

Gets or sets the two-letter ISO country code.
The country code is mandatory unless the entire address contains null or empty values.
Value: The ISO country code.

**Returns:**
java.lang.String
##### setCountryCode(String value)
```
public final void setCountryCode(String value)
```

Gets or sets the two-letter ISO country code.
The country code is mandatory unless the entire address contains null or empty values.
Value: The ISO country code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### SwissQR
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.swissqr/swissqr.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class SwissQR implements IComplexData
```

Class for encoding and decoding the text embedded in the SwissQR code.

#### Constructors

| Constructor | Description |
| --- | --- |
| SwissQR() | Creates an instance of SwissQR.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAmount() | Gets or sets the payment amount.
 |
| setAmount(double value) | Gets or sets the payment amount.
 |
| getCurrency() | Gets or sets the payment currency.
 |
| setCurrency(String value) | Gets or sets the payment currency.
 |
| getAccount() | Gets or sets the creditor's account number.
 |
| setAccount(String value) | Gets or sets the creditor's account number.
 |
| getCreditor() | Gets or sets the creditor address.
 |
| setCreditor(SwissAddress value) | Gets or sets the creditor address.
 |
| getReference() | Gets or sets the creditor payment reference.
 |
| setReference(String value) | Gets or sets the creditor payment reference.
 |
| getDebtor() | Gets or sets the debtor address.
 |
| setDebtor(SwissAddress value) | Gets or sets the debtor address.
 |
| getUnstructuredMessage() | Gets or sets the additional unstructured message.
 |
| setUnstructuredMessage(String value) | Gets or sets the additional unstructured message.
 |
| getBillInformation() | Gets or sets the additional structured bill information.
 |
| setBillInformation(String value) | Gets or sets the additional structured bill information.
 |
##### SwissQR()
```
public SwissQR()
```

Creates an instance of SwissQR.

##### getAmount()
```
public final double getAmount()
```

Gets or sets the payment amount.
Valid values are between 0.01 and 999,999,999.99.
Value: The payment amount.

**Returns:**
double
##### setAmount(double value)
```
public final void setAmount(double value)
```

Gets or sets the payment amount.
Valid values are between 0.01 and 999,999,999.99.
Value: The payment amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getCurrency()
```
public final String getCurrency()
```

Gets or sets the payment currency.
Valid values are "CHF" and "EUR".
Value: The payment currency.

**Returns:**
java.lang.String
##### setCurrency(String value)
```
public final void setCurrency(String value)
```

Gets or sets the payment currency.
Valid values are "CHF" and "EUR".
Value: The payment currency.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAccount()
```
public final String getAccount()
```

Gets or sets the creditor's account number.
Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein.
Spaces are allowed in the account number.
Value: The creditor account number.

**Returns:**
java.lang.String
##### setAccount(String value)
```
public final void setAccount(String value)
```

Gets or sets the creditor's account number.
Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein.
Spaces are allowed in the account number.
Value: The creditor account number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCreditor()
```
public final SwissAddress getCreditor()
```

Gets or sets the creditor address.
Value: The creditor address.

**Returns:**
SwissAddress
##### setCreditor(SwissAddress value)
```
public final void setCreditor(SwissAddress value)
```

Gets or sets the creditor address.
Value: The creditor address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SwissAddress |  |

##### getReference()
```
public final String getReference()
```

Gets or sets the creditor payment reference.
The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx
through CHxx31999xxxxx.
If specified, the reference must be either a valid SwissQR reference (corresponding
to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx").
Both may contain spaces for formatting.
Value: The creditor payment reference.

**Returns:**
java.lang.String
##### setReference(String value)
```
public final void setReference(String value)
```

Gets or sets the creditor payment reference.
The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx
through CHxx31999xxxxx.
If specified, the reference must be either a valid SwissQR reference (corresponding
to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx").
Both may contain spaces for formatting.
Value: The creditor payment reference.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDebtor()
```
public final SwissAddress getDebtor()
```

Gets or sets the debtor address.
The debtor is optional. If it is omitted, both setting this field to null or
setting an address with all null or empty values is ok.
Value: The debtor address.

**Returns:**
SwissAddress
##### setDebtor(SwissAddress value)
```
public final void setDebtor(SwissAddress value)
```

Gets or sets the debtor address.
The debtor is optional. If it is omitted, both setting this field to null or
setting an address with all null or empty values is ok.
Value: The debtor address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SwissAddress |  |

##### getUnstructuredMessage()
```
public final String getUnstructuredMessage()
```

Gets or sets the additional unstructured message.
Value: The unstructured message.

**Returns:**
java.lang.String
##### setUnstructuredMessage(String value)
```
public final void setUnstructuredMessage(String value)
```

Gets or sets the additional unstructured message.
Value: The unstructured message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBillInformation()
```
public final String getBillInformation()
```

Gets or sets the additional structured bill information.
Value: The structured bill information.

**Returns:**
java.lang.String
##### setBillInformation(String value)
```
public final void setBillInformation(String value)
```

Gets or sets the additional structured bill information.
Value: The structured bill information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### com.groupdocs.signature.domain.extensions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions.md

The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.

#### Classes

| Class | Description |
| --- | --- |
| Brush | Represents base class for various brushes. |
| LinearGradientBrush | Represents linear gradient brush. |
| RadialGradientBrush | Represents radial gradient brush. |
| SolidBrush | Represents solid brush. |
| TextureBrush | Represents texture brush. |

### Brush
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions/brush.md

**Inheritance:**
java.lang.Object
```
public abstract class Brush
```

Represents base class for various brushes.

#### Constructors

| Constructor | Description |
| --- | --- |
| Brush() |  |
##### Brush()
```
public Brush()
```

### LinearGradientBrush
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions/lineargradientbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class LinearGradientBrush extends Brush
```

Represents linear gradient brush.

#### Constructors

| Constructor | Description |
| --- | --- |
| LinearGradientBrush() | Initializes a new instance of the LinearGradientBrush class with default values.
 |
| LinearGradientBrush(Color startColor, Color endColor, float angle) | Initializes a new instance of the LinearGradientBrush class.
 |
| LinearGradientBrush(String startColor, String endColor, float angle) | Initializes a new instance of the LinearGradientBrush class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getStartColor() | Gets or sets start gradient color.
 |
| setStartColor(Color value) | Gets or sets start gradient color.
 |
| setStartColor(String value) | Gets or sets start gradient color.
 |
| getEndColor() | Gets or sets finish gradient color.
 |
| setEndColor(Color value) | Gets or sets finish gradient color.
 |
| setEndColor(String value) | Gets or sets finish gradient color.
 |
| getAngle() | Gets or sets gradient angle.
 |
| setAngle(float value) | Gets or sets gradient angle.
 |
##### LinearGradientBrush()
```
public LinearGradientBrush()
```

Initializes a new instance of the LinearGradientBrush class with default values.

##### LinearGradientBrush(Color startColor, Color endColor, float angle)
```
public LinearGradientBrush(Color startColor, Color endColor, float angle)
```

Initializes a new instance of the LinearGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startColor | java.awt.Color | Start color.
 |
| endColor | java.awt.Color | End color.
 |
| angle | float | Angle. Default value is 0.
 |

##### LinearGradientBrush(String startColor, String endColor, float angle)
```
public LinearGradientBrush(String startColor, String endColor, float angle)
```

Initializes a new instance of the LinearGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startColor | java.lang.String | Start color.
 |
| endColor | java.lang.String | End color.
 |
| angle | float | Angle. Default value is 0.
 |

##### getStartColor()
```
public final Color getStartColor()
```

Gets or sets start gradient color.

**Returns:**
java.awt.Color
##### setStartColor(Color value)
```
public final void setStartColor(Color value)
```

Gets or sets start gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setStartColor(String value)
```
public final void setStartColor(String value)
```

Gets or sets start gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEndColor()
```
public final Color getEndColor()
```

Gets or sets finish gradient color.

**Returns:**
java.awt.Color
##### setEndColor(Color value)
```
public final void setEndColor(Color value)
```

Gets or sets finish gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setEndColor(String value)
```
public final void setEndColor(String value)
```

Gets or sets finish gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAngle()
```
public final float getAngle()
```

Gets or sets gradient angle.

**Returns:**
float
##### setAngle(float value)
```
public final void setAngle(float value)
```

Gets or sets gradient angle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

### RadialGradientBrush
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions/radialgradientbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class RadialGradientBrush extends Brush
```

Represents radial gradient brush.

#### Constructors

| Constructor | Description |
| --- | --- |
| RadialGradientBrush() | Initializes a new instance of the RadialGradientBrush class with default values.
 |
| RadialGradientBrush(Color innerColor, Color outerColor) | Initializes a new instance of the RadialGradientBrush class.
 |
| RadialGradientBrush(String innerColor, String outerColor) | Initializes a new instance of the RadialGradientBrush class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getInnerColor() | Gets or sets inner gradient color.
 |
| setInnerColor(Color value) | Gets or sets inner gradient color.
 |
| setInnerColor(String value) | Gets or sets inner gradient color.
 |
| getOuterColor() | Gets or sets outer gradient color.
 |
| setOuterColor(Color value) | Gets or sets outer gradient color.
 |
| setOuterColor(String value) | Gets or sets outer gradient color.
 |
##### RadialGradientBrush()
```
public RadialGradientBrush()
```

Initializes a new instance of the RadialGradientBrush class with default values.

##### RadialGradientBrush(Color innerColor, Color outerColor)
```
public RadialGradientBrush(Color innerColor, Color outerColor)
```

Initializes a new instance of the RadialGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerColor | java.awt.Color | Inner color.
 |
| outerColor | java.awt.Color | Outer color.
 |

##### RadialGradientBrush(String innerColor, String outerColor)
```
public RadialGradientBrush(String innerColor, String outerColor)
```

Initializes a new instance of the RadialGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerColor | java.lang.String | Inner color.
 |
| outerColor | java.lang.String | Outer color.
 |

##### getInnerColor()
```
public final Color getInnerColor()
```

Gets or sets inner gradient color.

**Returns:**
java.awt.Color
##### setInnerColor(Color value)
```
public final void setInnerColor(Color value)
```

Gets or sets inner gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setInnerColor(String value)
```
public final void setInnerColor(String value)
```

Gets or sets inner gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOuterColor()
```
public final Color getOuterColor()
```

Gets or sets outer gradient color.

**Returns:**
java.awt.Color
##### setOuterColor(Color value)
```
public final void setOuterColor(Color value)
```

Gets or sets outer gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setOuterColor(String value)
```
public final void setOuterColor(String value)
```

Gets or sets outer gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### SolidBrush
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions/solidbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class SolidBrush extends Brush
```

Represents solid brush.
It could be used instead background color property.

#### Constructors

| Constructor | Description |
| --- | --- |
| SolidBrush() | Initializes a new instance of the SolidBrush class with default values.
 |
| SolidBrush(Color color) | Initializes a new instance of the SolidBrush class.
 |
| SolidBrush(String color) | Initializes a new instance of the SolidBrush class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getColor() | Gets or sets color of solid brush.
 |
| setColor(Color value) | Gets or sets color of solid brush.
 |
| setColor(String value) | Gets or sets color of solid brush.
 |
##### SolidBrush()
```
public SolidBrush()
```

Initializes a new instance of the SolidBrush class with default values.

##### SolidBrush(Color color)
```
public SolidBrush(Color color)
```

Initializes a new instance of the SolidBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.awt.Color | Color of solid brush.
 |

##### SolidBrush(String color)
```
public SolidBrush(String color)
```

Initializes a new instance of the SolidBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.lang.String | Color of solid brush.
 |

##### getColor()
```
public final Color getColor()
```

Gets or sets color of solid brush.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets color of solid brush.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets color of solid brush.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### TextureBrush
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.extensions/texturebrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class TextureBrush extends Brush
```

Represents texture brush.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextureBrush() | Initializes a new instance of the TextureBrush class with default values.
 |
| TextureBrush(String imageFilePath) | Initializes a new instance of the TextureBrush class with image file.
 |
| TextureBrush(InputStream imageStream) | Initializes a new instance of the TextureBrush class with image stream option.
 |
#### Methods

| Method | Description |
| --- | --- |
| getImageFilePath() | Gets or sets the texture image file path.
 |
| setImageFilePath(String value) | Gets or sets the texture image file path.
 |
| getImageStream() | Gets or sets the texture image stream.
 |
| setImageStream(InputStream value) | Gets or sets the texture image stream.
 |
##### TextureBrush()
```
public TextureBrush()
```

Initializes a new instance of the TextureBrush class with default values.

##### TextureBrush(String imageFilePath)
```
public TextureBrush(String imageFilePath)
```

Initializes a new instance of the TextureBrush class with image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | java.lang.String | Image file path.
 |

##### TextureBrush(InputStream imageStream)
```
public TextureBrush(InputStream imageStream)
```

Initializes a new instance of the TextureBrush class with image stream option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | Image stream.
 |

##### getImageFilePath()
```
public final String getImageFilePath()
```

Gets or sets the texture image file path.
This property is used only if ImageStream is not specified.

**Returns:**
java.lang.String
##### setImageFilePath(String value)
```
public final void setImageFilePath(String value)
```

Gets or sets the texture image file path.
This property is used only if ImageStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets or sets the texture image stream.
If this property is specified it is always used instead ImageFilePath.

**Returns:**
java.io.InputStream
##### setImageStream(InputStream value)
```
public final void setImageStream(InputStream value)
```

Gets or sets the texture image stream.
If this property is specified it is always used instead ImageFilePath.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

### com.groupdocs.signature.domain.interfaces
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces.md

The **GroupDocs.Signature.Domain.Interfaces** namespace provides classes for working with Interfaces

#### Interfaces

| Interface | Description |
| --- | --- |
| IAlignment | Interface describes alignment of Signature area on document page. |
| IRectangle | Interface defines properties for Signature area on Document Page. |
| IRotation | Interface defines properties for Signature Rotation. |
| ITextAlignment | Interface defines Alignment properties for text on Text Signatures. |
| ITransparency | Define Transparency property for different objects appearances |

### IAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces/ialignment.md

### IRectangle
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces/irectangle.md

### IRotation
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces/irotation.md

### ITextAlignment
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces/itextalignment.md

### ITransparency
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.interfaces/itransparency.md

### com.groupdocs.signature.domain.qrcodes
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.qrcodes.md

The **GroupDocs.Signature.Domain.QRCodes** namespace provides classes for working with QRCodes

#### Classes

| Class | Description |
| --- | --- |
| QrCodeType | Specify QRCode type properties. |
| QrCodeTypes | QRCode Types container. |

### QrCodeType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.qrcodes/qrcodetype.md

**Inheritance:**
java.lang.Object
```
public final class QrCodeType
```

Specify QRCode type properties.

#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Gets index of object in collection of supported QRCode types.
 |
| getTypeName() | Gets name of QRCode Type.
 |
| equals(QrCodeType other) | Determines whether the specified QRCode is equal to the current object.
 |
| equals(Object obj) | Overridden method determines whether the specified System.Object is equal to the current System.Object.
 |
| hashCode() | Overridden method serves as a hash function for a particular type.
 |
| toString() | Overridden method serves as conversion to string type.
 |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Gets index of object in collection of supported QRCode types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Gets name of QRCode Type.

**Returns:**
java.lang.String
##### equals(QrCodeType other)
```
public final boolean equals(QrCodeType other)
```

Determines whether the specified QRCode is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | QrCodeType | Object for comparison.
 |

**Returns:**
boolean - Result of comparison.

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overridden method determines whether the specified System.Object is equal to the current System.Object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Object for comparison.
 |

**Returns:**
boolean - Result of comparison.

##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash code.

##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - Returns a string that represents the current object.

### QrCodeTypes
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.qrcodes/qrcodetypes.md

**Inheritance:**
java.lang.Object
```
public class QrCodeTypes
```

QRCode Types container.

#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| Aztec | Aztec Barcode Type object.
 |
| DataMatrix | DataMatrix Barcode Type object.
 |
| QR | QR Barcode Type object.
 |
| GS1DataMatrix | GS1 DataMatrix Barcode Type object.
 |
| GS1QR | GS1 QR Barcode Type object.
 |
| HIBCLICQR | HIBC LIC QR-Code Type object.
 |
| HIBCLICDataMatrix | HIBC LIC Data Matrix QR-Code Type object.
 |
| HIBCLICAztec | HIBC LIC Aztec QR-Code Type object.
 |
| HIBCPASQR | HIBC PAS QR-Code Type object.
 |
| HIBCPASDataMatrix | HIBC PAS Data Matrix QR-Code Type object.
 |
| HIBCPASAztec | HIBC PAS Aztec QR-Code Type object.
 |
| HanXin | Han Xin QR-Code Type object.
 |
| GS1HanXin | GS1 Han Xin QR-Code Type object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All QRCode types.
 |
| parse(String parsingType) | Returns QRCode type with pasringType name.
 |
| tryParse(String parsingType) | Returns QRCode type with pasringType name.
 |
| getDecodeTypes() | Internal list of Decode Types for extraction
 |
| isComplexType(System.Type type, QrCodeType qrCodeType) |  |
| getDataEncoding(System.Type type, QrCodeType qrCodeType) |  |
##### QrCodeTypes()
```
public QrCodeTypes()
```

##### Aztec
```
public static final QrCodeType Aztec
```

Aztec Barcode Type object.

##### DataMatrix
```
public static final QrCodeType DataMatrix
```

DataMatrix Barcode Type object.

##### QR
```
public static final QrCodeType QR
```

QR Barcode Type object.

##### GS1DataMatrix
```
public static final QrCodeType GS1DataMatrix
```

GS1 DataMatrix Barcode Type object.

##### GS1QR
```
public static final QrCodeType GS1QR
```

GS1 QR Barcode Type object.

##### HIBCLICQR
```
public static final QrCodeType HIBCLICQR
```

HIBC LIC QR-Code Type object.

##### HIBCLICDataMatrix
```
public static final QrCodeType HIBCLICDataMatrix
```

HIBC LIC Data Matrix QR-Code Type object.

##### HIBCLICAztec
```
public static final QrCodeType HIBCLICAztec
```

HIBC LIC Aztec QR-Code Type object.

##### HIBCPASQR
```
public static final QrCodeType HIBCPASQR
```

HIBC PAS QR-Code Type object.

##### HIBCPASDataMatrix
```
public static final QrCodeType HIBCPASDataMatrix
```

HIBC PAS Data Matrix QR-Code Type object.

##### HIBCPASAztec
```
public static final QrCodeType HIBCPASAztec
```

HIBC PAS Aztec QR-Code Type object.

##### HanXin
```
public static final QrCodeType HanXin
```

Han Xin QR-Code Type object.

##### GS1HanXin
```
public static final QrCodeType GS1HanXin
```

GS1 Han Xin QR-Code Type object.

##### getAllTypes()
```
public static QrCodeType[] getAllTypes()
```

All QRCode types.

**Returns:**
com.groupdocs.signature.domain.qrcodes.QrCodeType[]
##### parse(String parsingType)
```
public static QrCodeType parse(String parsingType)
```

Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of QRCode type name.
 |

**Returns:**
QrCodeType - QRCodeType instance.

##### tryParse(String parsingType)
```
public static QrCodeType tryParse(String parsingType)
```

Returns QRCode type with pasringType name.
If name of QRCode is unknown - no Exception will be throw but method will return null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of QRCode type name.
 |

**Returns:**
QrCodeType - QRCodeType instance.

##### getDecodeTypes()
```
public static System.Collections.Generic.List<BaseDecodeType> getDecodeTypes()
```

Internal list of Decode Types for extraction

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.aspose.barcode.barcoderecognition.BaseDecodeType>
##### isComplexType(System.Type type, QrCodeType qrCodeType)
```
public static boolean isComplexType(System.Type type, QrCodeType qrCodeType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | com.aspose.ms.System.Type |  |
| qrCodeType | QrCodeType |  |

**Returns:**
boolean
##### getDataEncoding(System.Type type, QrCodeType qrCodeType)
```
public static IComplexCodeDataEncoding getDataEncoding(System.Type type, QrCodeType qrCodeType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | com.aspose.ms.System.Type |  |
| qrCodeType | QrCodeType |  |

**Returns:**
IComplexCodeDataEncoding

### com.groupdocs.signature.domain.signatures.formfield
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield.md

The **GroupDocs.Signature.Domain.Signatures.FormField** namespace provides classes for working with FormField signatures

#### Classes

| Class | Description |
| --- | --- |
| CheckboxFormFieldSignature | Contains check-box input form field signature properties. |
| ComboboxFormFieldSignature | Contains combo-box input form field signature properties. |
| DigitalFormFieldSignature | Contains digital signature input form field properties for Pdf Documents. |
| FormFieldSignature | Contains Form field signature properties. |
| RadioButtonFormFieldSignature | Contains radio-button input form field signature properties. |
| TextFormFieldSignature | Contains text input form field signature properties for Pdf Document |

### CheckboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/checkboxformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class CheckboxFormFieldSignature extends FormFieldSignature
```

Contains check-box input form field signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| CheckboxFormFieldSignature(String name) | Creates PdfCheckboxFormFieldSignature with predefined name.
 |
| CheckboxFormFieldSignature(String name, boolean isChecked) | Creates PdfCheckboxFormFieldSignature with predefined name and value
 |
#### Methods

| Method | Description |
| --- | --- |
| getChecked() | Gets or sets checked value of form field check-box input.
 |
| setChecked(boolean value) | Gets or sets checked value of form field check-box input.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### CheckboxFormFieldSignature(String name)
```
public CheckboxFormFieldSignature(String name)
```

Creates PdfCheckboxFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |

##### CheckboxFormFieldSignature(String name, boolean isChecked)
```
public CheckboxFormFieldSignature(String name, boolean isChecked)
```

Creates PdfCheckboxFormFieldSignature with predefined name and value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| isChecked | boolean | Value if check box is checked
 |

##### getChecked()
```
public final boolean getChecked()
```

Gets or sets checked value of form field check-box input.

**Returns:**
boolean
##### setChecked(boolean value)
```
public final void setChecked(boolean value)
```

Gets or sets checked value of form field check-box input.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### ComboboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/comboboxformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class ComboboxFormFieldSignature extends FormFieldSignature
```

Contains combo-box input form field signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| ComboboxFormFieldSignature(String name) | Creates ComboboxFormFieldSignature with predefined name.
 |
| ComboboxFormFieldSignature(String name, List<String> items) | Creates ComboboxFormFieldSignature with predefined name and options list.
 |
| ComboboxFormFieldSignature(String name, List<String> items, Object selected) | Creates ComboboxFormFieldSignature with predefined name, options list and selected value.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSelected() | Get or set selected value.
 |
| setSelected(String value) | Get or set selected value.
 |
| getItems() | Get or set combo-box options list.
 |
| setItems(List<String> value) | Get or set combo-box options list.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### ComboboxFormFieldSignature(String name)
```
public ComboboxFormFieldSignature(String name)
```

Creates ComboboxFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |

##### ComboboxFormFieldSignature(String name, List<String> items)
```
public ComboboxFormFieldSignature(String name, List<String> items)
```

Creates ComboboxFormFieldSignature with predefined name and options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| items | java.util.List<java.lang.String> | Values of combo-box list.
 |

##### ComboboxFormFieldSignature(String name, List<String> items, Object selected)
```
public ComboboxFormFieldSignature(String name, List<String> items, Object selected)
```

Creates ComboboxFormFieldSignature with predefined name, options list and selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| items | java.util.List<java.lang.String> | Values of combo-box list.
 |
| selected | java.lang.Object | Selected value.
 |

##### getSelected()
```
public final String getSelected()
```

Get or set selected value.

**Returns:**
java.lang.String
##### setSelected(String value)
```
public final void setSelected(String value)
```

Get or set selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getItems()
```
public final List<String> getItems()
```

Get or set combo-box options list.

**Returns:**
java.util.List<java.lang.String>
##### setItems(List<String> value)
```
public final void setItems(List<String> value)
```

Get or set combo-box options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### DigitalFormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/digitalformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class DigitalFormFieldSignature extends FormFieldSignature
```

Contains digital signature input form field properties for Pdf Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalFormFieldSignature(String name) | Creates PdfDigitalFormFieldSignature with predefined name.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSigned() | Read-only property that shows if Form-field Signature was signed with digital certificate.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### DigitalFormFieldSignature(String name)
```
public DigitalFormFieldSignature(String name)
```

Creates PdfDigitalFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |

##### getSigned()
```
public final boolean getSigned()
```

Read-only property that shows if Form-field Signature was signed with digital certificate.

**Returns:**
boolean
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### FormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/formfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public abstract class FormFieldSignature extends BaseSignature
```

Contains Form field signature properties.

#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies unique form field name.
 |
| setName(String value) | Specifies unique form field name.
 |
| getType() | Specifies Form field type.
 |
| getValue() | Specifies Form field data object.
 |
| setValue(Object value) | Specifies Form field data object.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### getName()
```
public final String getName()
```

Specifies unique form field name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies unique form field name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getType()
```
public final int getType()
```

Specifies Form field type.

**Returns:**
int
##### getValue()
```
public final Object getValue()
```

Specifies Form field data object.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies Form field data object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### RadioButtonFormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/radiobuttonformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class RadioButtonFormFieldSignature extends FormFieldSignature
```

Contains radio-button input form field signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| RadioButtonFormFieldSignature(String name) | Creates RadioButtonFieldSignature with predefined name.
 |
| RadioButtonFormFieldSignature(String name, List<String> items) | Creates RadioButtonFieldSignature with predefined name and items list.
 |
| RadioButtonFormFieldSignature(String name, List<String> items, Object selected) | Creates RadioButtonFieldSignature with predefined name, items list and selected value.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSelected() | Contains selected value.
 |
| setSelected(String value) | Contains selected value.
 |
| getItems() | Get or set Radio buttons options list.
 |
| setItems(List<String> value) | Get or set Radio buttons options list.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### RadioButtonFormFieldSignature(String name)
```
public RadioButtonFormFieldSignature(String name)
```

Creates RadioButtonFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |

##### RadioButtonFormFieldSignature(String name, List<String> items)
```
public RadioButtonFormFieldSignature(String name, List<String> items)
```

Creates RadioButtonFieldSignature with predefined name and items list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| items | java.util.List<java.lang.String> | Values of radio-button list.
 |

##### RadioButtonFormFieldSignature(String name, List<String> items, Object selected)
```
public RadioButtonFormFieldSignature(String name, List<String> items, Object selected)
```

Creates RadioButtonFieldSignature with predefined name, items list and selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| items | java.util.List<java.lang.String> | Values of radio-button list.
 |
| selected | java.lang.Object | Selected value.
 |

##### getSelected()
```
public final String getSelected()
```

Contains selected value.

**Returns:**
java.lang.String
##### setSelected(String value)
```
public final void setSelected(String value)
```

Contains selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getItems()
```
public final List<String> getItems()
```

Get or set Radio buttons options list.

**Returns:**
java.util.List<java.lang.String>
##### setItems(List<String> value)
```
public final void setItems(List<String> value)
```

Get or set Radio buttons options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### TextFormFieldSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.formfield/textformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class TextFormFieldSignature extends FormFieldSignature
```

Contains text input form field signature properties for Pdf Document

#### Constructors

| Constructor | Description |
| --- | --- |
| TextFormFieldSignature(String name) | Creates PdfTextFormFieldSignature with predefined name.
 |
| TextFormFieldSignature(String name, String text) | Creates PdfTextFormFieldSignature with predefined name.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets or sets text of form field text input.
 |
| setText(String value) | Gets or sets text of form field text input.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone FormField Signature instance.
 |
##### TextFormFieldSignature(String name)
```
public TextFormFieldSignature(String name)
```

Creates PdfTextFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |

##### TextFormFieldSignature(String name, String text)
```
public TextFormFieldSignature(String name, String text)
```

Creates PdfTextFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object.
 |
| text | java.lang.String | Text of form field object.
 |

##### getText()
```
public final String getText()
```

Gets or sets text of form field text input.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets text of form field text input.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### com.groupdocs.signature.domain.signatures.metadata
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata.md

The **GroupDocs.Signature.Domain.Signatures.Metadata** namespace provides classes for working with Metadata signatures

#### Classes

| Class | Description |
| --- | --- |
| CertificateMetadataSignature | Contains Certificate Metadata Signature properties. |
| ImageMetadataSignature | Contains Image Metadata signature properties. |
| MetadataSignature | Contains Metadata signature properties. |
| MetadataSignatureCollection | Collection of Metadata signature objects. |
| PdfMetadataSignature | Contains Pdf Metadata signature properties. |
| PdfMetadataSignatures | Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options. |
| PresentationMetadataSignature | Contains Presentation metadata signature properties. |
| SpreadsheetMetadataSignature | Contains Spreadsheet Metadata Signature properties. |
| WordProcessingMetadataSignature | Contains WordProcessing Metadata Signature properties. |

### CertificateMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/certificatemetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class CertificateMetadataSignature extends MetadataSignature
```

Contains Certificate Metadata Signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateMetadataSignature(String name) | Creates Certificate Metadata Signature with predefined name and empty value.
 |
| CertificateMetadataSignature(String name, Object value) | Creates Certificate Metadata Signature with predefined values.
 |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Certificate Metadata Signature instance with given value.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format
 |
##### CertificateMetadataSignature(String name)
```
public CertificateMetadataSignature(String name)
```

Creates Certificate Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Certificate Metadata Signature name.
 |

##### CertificateMetadataSignature(String name, Object value)
```
public CertificateMetadataSignature(String name, Object value)
```

Creates Certificate Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object.
 |
| value | java.lang.Object | Value of Metadata signature.
 |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Certificate Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

<br />

##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### ImageMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/imagemetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class ImageMetadataSignature extends MetadataSignature
```

Contains Image Metadata signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageMetadataSignature(int id, Object value) | Creates Image Metadata Signature with Id and value
 |
#### Methods

| Method | Description |
| --- | --- |
| getId() | The identifier of Image Metadata signature.
 |
| setId(int value) | The identifier of Image Metadata signature.
 |
| getSize() | Read-only value to get size of Metadata value
 |
| setSize(int value) | Read-only value to get size of Metadata value
 |
| getDescription() | Read-only value to get description for standard Image Metadata signature
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Image Metadata Signature instance with given value.
 |
| toBoolean() | Converts to boolean.
 |
| toInteger() | Converts to integer.
 |
| toLong() | Converts to long.
 |
| toSingle() | Converts to float.
 |
| toSingle(Locale provider) | Converts to float.
 |
| toDouble() | Converts to Double.
 |
| toDouble(Locale provider) | Converts to Double.
 |
| toDecimal() | Converts to Decimal.
 |
| toDecimal(Locale provider) | Converts to Decimal.
 |
| toDateTime() | Converts to DateTime.
 |
| toDateTime(Locale provider) | Converts to DateTime.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format) | Converts to String with specified format
 |
| toString(String format, Locale provider) | Converts to String with specified format
 |
| setAsBool(Object value) |  |
| setAsByte(Object value) |  |
| setAsShrt(Object value) |  |
| setAsWord(Object value) |  |
| setAsSInt(Object value) |  |
| setAsUInt(Object value) |  |
| setAsSLng(Object value) |  |
| setAsULng(Object value) |  |
| setAsSngl(Object value) |  |
| setAsDbls(Object value) |  |
| setAsDcml(Object value) |  |
| setAsDate(Object value) |  |
| setAsStrn(Object value) |  |
| setAsObjc(Object value) |  |
| setString(Object value) |  |
##### ImageMetadataSignature(int id, Object value)
```
public ImageMetadataSignature(int id, Object value)
```

Creates Image Metadata Signature with Id and value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values
 |
| value | java.lang.Object | Metadata value
 |

##### getId()
```
public final int getId()
```

The identifier of Image Metadata signature.
See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

**Returns:**
int
##### setId(int value)
```
public final void setId(int value)
```

The identifier of Image Metadata signature.
See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSize()
```
public final int getSize()
```

Read-only value to get size of Metadata value

**Returns:**
int
##### setSize(int value)
```
public final void setSize(int value)
```

Read-only value to get size of Metadata value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDescription()
```
public final String getDescription()
```

Read-only value to get description for standard Image Metadata signature

**Returns:**
java.lang.String
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Image Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

##### toBoolean()
```
public boolean toBoolean()
```

Converts to boolean.

**Returns:**
boolean - Returns the Metadata signature value as boolean.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted.

<br />

##### toInteger()
```
public int toInteger()
```

Converts to integer.

**Returns:**
int - Returns the Metadata Signature value as integer.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted.

<br />

##### toLong()
```
public final long toLong()
```

Converts to long.

**Returns:**
long - Returns the Metadata Signature value as long.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted.

<br />

##### toSingle()
```
public final float toSingle()
```

Converts to float.

**Returns:**
float - Returns the Image Metadata Signature value as float.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toSingle(Locale provider)
```
public final float toSingle(Locale provider)
```

Converts to float.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
float - Returns the Metadata Signature value as float.

##### toDouble()
```
public double toDouble()
```

Converts to Double.

**Returns:**
double - Returns the Image Metadata Signature value as Double.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toDouble(Locale provider)
```
public double toDouble(Locale provider)
```

Converts to Double.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
double - Returns the Metadata Signature value as Double.

##### toDecimal()
```
public final BigDecimal toDecimal()
```

Converts to Decimal.

**Returns:**
java.math.BigDecimal - Returns the Image Metadata Signature value as Decimal.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toDecimal(Locale provider)
```
public final BigDecimal toDecimal(Locale provider)
```

Converts to Decimal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
java.math.BigDecimal - Returns the Metadata Signature value as Decimal.

##### toDateTime()
```
public Date toDateTime()
```

Converts to DateTime.

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toDateTime(Locale provider)
```
public Date toDateTime(Locale provider)
```

Converts to DateTime.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

##### toString(String format)
```
public String toString(String format)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

##### toString(String format, Locale provider)
```
public String toString(String format, Locale provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

##### setAsBool(Object value)
```
public final boolean setAsBool(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsByte(Object value)
```
public final boolean setAsByte(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsShrt(Object value)
```
public final boolean setAsShrt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsWord(Object value)
```
public final boolean setAsWord(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSInt(Object value)
```
public final boolean setAsSInt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsUInt(Object value)
```
public final boolean setAsUInt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSLng(Object value)
```
public final boolean setAsSLng(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsULng(Object value)
```
public final boolean setAsULng(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSngl(Object value)
```
public final boolean setAsSngl(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDbls(Object value)
```
public final boolean setAsDbls(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDcml(Object value)
```
public final boolean setAsDcml(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDate(Object value)
```
public final boolean setAsDate(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsStrn(Object value)
```
public final boolean setAsStrn(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsObjc(Object value)
```
public final boolean setAsObjc(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setString(Object value)
```
public final void setString(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

### MetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/metadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public abstract class MetadataSignature extends BaseSignature
```

Contains Metadata signature properties.

#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies unique metadata name.
 |
| setName(String value) | Specifies unique metadata name.
 |
| getValue() | Specifies metadata object.
 |
| setValue(Object value) | Specifies metadata object.
 |
| getType() | Specifies metadata value type.
 |
| setType(int value) | Specifies metadata value type.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.
 |
| <T>getData(Class<T> typeOfT) | Obtain object from Metadata Signature Value over deserialization.
 |
| <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption) | Obtain object from Metadata Signature Text over deserialization.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| toBoolean() | Converts to boolean.
 |
| toInteger() | Converts to integer.
 |
| toDouble() | Converts to Double.
 |
| toDouble(Locale provider) | Converts to Double.
 |
| toSingle() | Converts to float.
 |
| toSingle(Locale provider) | Converts to float.
 |
| toDateTime() | Converts to DateTime.
 |
| toDateTime(Locale provider) | Converts to DateTime.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format) | Converts to String with specified format
 |
| toString(String format, Locale provider) | Converts to String with specified format
 |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Metadata Signature instance with given value.
 |
##### getName()
```
public final String getName()
```

Specifies unique metadata name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies unique metadata name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getValue()
```
public final Object getValue()
```

Specifies metadata object.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies metadata object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getType()
```
public final int getType()
```

Specifies metadata value type.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Specifies metadata value type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### <T>getData(Class<T> typeOfT)
```
public final T <T>getData(Class<T> typeOfT)
```

Obtain object from Metadata Signature Value over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
T - Instance of T object

T
: Type of object to deserialize from Metadata value

##### <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption)
```
public final T <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption)
```

Obtain object from Metadata Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| dataEncryption | IDataEncryption | Set custom data encryption implementation

T
: Type of object to deserialize from Metadata Value
 |

**Returns:**
T -
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### toBoolean()
```
public boolean toBoolean()
```

Converts to boolean.

**Returns:**
boolean - Returns the Metadata signature value as boolean.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted.

<br />

##### toInteger()
```
public int toInteger()
```

Converts to integer.

**Returns:**
int - Returns the Metadata Signature value as integer.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted.

<br />

##### toDouble()
```
public double toDouble()
```

Converts to Double.

**Returns:**
double - Returns the Metadata Signature value as Double.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toDouble(Locale provider)
```
public double toDouble(Locale provider)
```

Converts to Double.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
double - Returns the Metadata Signature value as Double.

##### toSingle()
```
public float toSingle()
```

Converts to float.

**Returns:**
float - Returns the Metadata Signature value as float.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture ()

<br />

##### toSingle(Locale provider)
```
public float toSingle(Locale provider)
```

Converts to float.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
float - Returns the Metadata Signature value as float.

##### toDateTime()
```
public Date toDateTime()
```

Converts to DateTime.

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

##### toDateTime(Locale provider)
```
public Date toDateTime(Locale provider)
```

Converts to DateTime.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Throws an exception if the Metadata value could not be converted

<br />

 |

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

<br />

##### toString(String format)
```
public String toString(String format)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

##### toString(String format, Locale provider)
```
public String toString(String format, Locale provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance with given value.

### MetadataSignatureCollection
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/metadatasignaturecollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class MetadataSignatureCollection implements Iterable<MetadataSignature>
```

Collection of Metadata signature objects.

#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSignatureCollection() | Creates Collection of Metadata signature.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets number of items in the collection.
 |
| clear() | Removes all items from the collection.
 |
| contains(String name) | Returns true if a Metadata with the specified name exists in the collection.
 |
| indexOf(String name) | Gets the index of a property by name.
 |
| remove(String name) | Removes a Metadata Signature with the specified name from the collection.
 |
| removeAt(int index) | Removes a Metadata Signature at the specified index.
 |
| add(MetadataSignature signature) | Add Metadata Signature object to collection.
 |
| addRange(MetadataSignature[] signatures) | Add Metadata Signature collection.
 |
| deepClone() | Clone Metadata Signature Collection class with Metadata Signature Items.
 |
##### MetadataSignatureCollection()
```
public MetadataSignatureCollection()
```

Creates Collection of Metadata signature.

##### getCount()
```
public final int getCount()
```

Gets number of items in the collection.

**Returns:**
int
##### clear()
```
public final void clear()
```

Removes all items from the collection.

##### contains(String name)
```
public final boolean contains(String name)
```

Returns true if a Metadata with the specified name exists in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the property.
 |

**Returns:**
boolean - True if the Metadata exists in the collection; false otherwise.

##### indexOf(String name)
```
public final int indexOf(String name)
```

Gets the index of a property by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the MetadataSignature.
 |

**Returns:**
int - The zero based index. Negative value if not found.

##### remove(String name)
```
public final boolean remove(String name)
```

Removes a Metadata Signature with the specified name from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the Metadata Signature.
 |

**Returns:**
boolean -
##### removeAt(int index)
```
public final boolean removeAt(int index)
```

Removes a Metadata Signature at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero based index.
 |

**Returns:**
boolean
##### add(MetadataSignature signature)
```
public final void add(MetadataSignature signature)
```

Add Metadata Signature object to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | MetadataSignature | Metadata signature to be added to collection.

<br />

*** ** * ** ***

Throws an exception if name value is not unique entire existing collection

<br />

 |

##### addRange(MetadataSignature[] signatures)
```
public final void addRange(MetadataSignature[] signatures)
```

Add Metadata Signature collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatures | MetadataSignature\[\] | Collection of signatures to add.

<br />

*** ** * ** ***

Throws an exception if name value is not unique entire existing collection

<br />

 |

##### deepClone()
```
public final Object deepClone()
```

Clone Metadata Signature Collection class with Metadata Signature Items.

**Returns:**
java.lang.Object - Returns copied instance with cloned Signature Items

### PdfMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/pdfmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class PdfMetadataSignature extends MetadataSignature
```

Contains Pdf Metadata signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfMetadataSignature(String name) | Creates Pdf Metadata signature with predefined name and empty value
 |
| PdfMetadataSignature(String name, Object value) | Creates Pdf Metadata signature with predefined values
 |
| PdfMetadataSignature(String name, Object value, String tag) | Creates Pdf Metadata signature with predefined values
 |
#### Methods

| Method | Description |
| --- | --- |
| getTagPrefix() | The prefix tag of Pdf Metadata signature name.
 |
| setTagPrefix(String value) | The prefix tag of Pdf Metadata signature name.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Pdf Metadata Signature instance with given value.
 |
##### PdfMetadataSignature(String name)
```
public PdfMetadataSignature(String name)
```

Creates Pdf Metadata signature with predefined name and empty value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Pdf Metadata Signature name
 |

##### PdfMetadataSignature(String name, Object value)
```
public PdfMetadataSignature(String name, Object value)
```

Creates Pdf Metadata signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object
 |
| value | java.lang.Object | Value of Metadata signature
 |

##### PdfMetadataSignature(String name, Object value, String tag)
```
public PdfMetadataSignature(String name, Object value, String tag)
```

Creates Pdf Metadata signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object
 |
| value | java.lang.Object | Value of Metadata signature
 |
| tag | java.lang.String | Prefix tag of Metadata signature
 |

##### getTagPrefix()
```
public final String getTagPrefix()
```

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp".
Possible values are

**Returns:**
java.lang.String
##### setTagPrefix(String value)
```
public final void setTagPrefix(String value)
```

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp".
Possible values are

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Pdf Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

### PdfMetadataSignatures
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/pdfmetadatasignatures.md

**Inheritance:**
java.lang.Object
```
public class PdfMetadataSignatures
```

Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfMetadataSignatures() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Pdf Document Author metadata.
 |
| getCreateDate() | Pdf Document creation date metadata signature.
 |
| getMetadataDate() | Pdf Document metadata date information.
 |
| getCreatorTool() | Pdf Document creation tool metadata signature.
 |
| getModifyDate() | Pdf Document modified date metadata property.
 |
| getProducer() | Pdf Document Producer metadata property.
 |
| getEntry() | Pdf Document Entry metadata property.
 |
| getKeywords() | Pdf Document creator metadata property
 |
| getTitle() | Pdf Document Title metadata property
 |
| getSubject() | Pdf Document Subject metadata property.
 |
| getDescription() | Pdf Document Description metadata property.
 |
| getCreator() | Pdf Document creator metadata property.
 |
##### PdfMetadataSignatures()
```
public PdfMetadataSignatures()
```

##### getAuthor()
```
public static PdfMetadataSignature getAuthor()
```

Pdf Document Author metadata.

**Returns:**
PdfMetadataSignature
##### getCreateDate()
```
public static PdfMetadataSignature getCreateDate()
```

Pdf Document creation date metadata signature.

**Returns:**
PdfMetadataSignature
##### getMetadataDate()
```
public static PdfMetadataSignature getMetadataDate()
```

Pdf Document metadata date information.

**Returns:**
PdfMetadataSignature
##### getCreatorTool()
```
public static PdfMetadataSignature getCreatorTool()
```

Pdf Document creation tool metadata signature.

**Returns:**
PdfMetadataSignature
##### getModifyDate()
```
public static PdfMetadataSignature getModifyDate()
```

Pdf Document modified date metadata property.

**Returns:**
PdfMetadataSignature
##### getProducer()
```
public static PdfMetadataSignature getProducer()
```

Pdf Document Producer metadata property.

**Returns:**
PdfMetadataSignature
##### getEntry()
```
public static PdfMetadataSignature getEntry()
```

Pdf Document Entry metadata property.

**Returns:**
PdfMetadataSignature
##### getKeywords()
```
public static PdfMetadataSignature getKeywords()
```

Pdf Document creator metadata property

**Returns:**
PdfMetadataSignature
##### getTitle()
```
public static PdfMetadataSignature getTitle()
```

Pdf Document Title metadata property

**Returns:**
PdfMetadataSignature
##### getSubject()
```
public static PdfMetadataSignature getSubject()
```

Pdf Document Subject metadata property.

**Returns:**
PdfMetadataSignature
##### getDescription()
```
public static PdfMetadataSignature getDescription()
```

Pdf Document Description metadata property.

**Returns:**
PdfMetadataSignature
##### getCreator()
```
public static PdfMetadataSignature getCreator()
```

Pdf Document creator metadata property.

**Returns:**
PdfMetadataSignature

### PresentationMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/presentationmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class PresentationMetadataSignature extends MetadataSignature
```

Contains Presentation metadata signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationMetadataSignature(String name) | Creates Presentation Metadata Signature with predefined name and empty value
 |
| PresentationMetadataSignature(String name, Object value) | Creates Presentation Metadata Signature with predefined values
 |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Slides Metadata Signature instance with given value.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format
 |
##### PresentationMetadataSignature(String name)
```
public PresentationMetadataSignature(String name)
```

Creates Presentation Metadata Signature with predefined name and empty value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Presentation Metadata Signature name
 |

##### PresentationMetadataSignature(String name, Object value)
```
public PresentationMetadataSignature(String name, Object value)
```

Creates Presentation Metadata Signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object
 |
| value | java.lang.Object | Value of Metadata signature
 |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Slides Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

<br />

##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### SpreadsheetMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/spreadsheetmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class SpreadsheetMetadataSignature extends MetadataSignature
```

Contains Spreadsheet Metadata Signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetMetadataSignature(String name) | Creates Spreadsheet Metadata Signature with predefined name and empty value.
 |
| SpreadsheetMetadataSignature(String name, Object value) | Creates Spreadsheet Metadata Signature with predefined values.
 |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Spreadsheet Metadata Signature instance with given value.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format
 |
##### SpreadsheetMetadataSignature(String name)
```
public SpreadsheetMetadataSignature(String name)
```

Creates Spreadsheet Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Spreadsheet Metadata Signature name.
 |

##### SpreadsheetMetadataSignature(String name, Object value)
```
public SpreadsheetMetadataSignature(String name, Object value)
```

Creates Spreadsheet Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object.
 |
| value | java.lang.Object | Value of Metadata signature.
 |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Spreadsheet Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

<br />

##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### WordProcessingMetadataSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.metadata/wordprocessingmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class WordProcessingMetadataSignature extends MetadataSignature
```

Contains WordProcessing Metadata Signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingMetadataSignature(String name) | Creates WordProcessing Metadata Signature with predefined name and empty value.
 |
| WordProcessingMetadataSignature(String name, Object value) | Creates WordProcessing Metadata Signature with predefined values.
 |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance.
 |
| deepClone(Object value) | Clone Words Metadata Signature instance with given value.
 |
| toString() | Converts to String with override ToString() method
 |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format
 |
##### WordProcessingMetadataSignature(String name)
```
public WordProcessingMetadataSignature(String name)
```

Creates WordProcessing Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | WordProcessing Metadata Signature name.
 |

##### WordProcessingMetadataSignature(String name, Object value)
```
public WordProcessingMetadataSignature(String name, Object value)
```

Creates WordProcessing Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object.
 |
| value | java.lang.Object | Value of Metadata signature.
 |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance

##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Words Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object.
 |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

<br />

##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.
 |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

<br />

*** ** * ** ***

Converts a boolean property into "True" or "False".

<br />

 |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### com.groupdocs.signature.domain.signatures
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures.md

The **GroupDocs.Signature.Domain.Signatures** namespace provides classes for working with Signatures

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSignature | Contains Barcode Signature properties. |
| BaseSignature | Describes base class for signatures. |
| DigitalSignature | Contains Digital signature properties. |
| DocumentResultSignature | Result of processing archive document signing process for document with newly created signatures. |
| ImageSignature | Contains Image signature properties. |
| PdfDigitalSignature | Contains Pdf Digital signature properties. |
| QrCodeSignature | Contains QR-code signature properties. |
| StoreName |  |
| TextSignature | Contains Text signature properties. |

### BarcodeSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/barcodesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class BarcodeSignature extends BaseSignature
```

Contains Barcode Signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSignature(String signatureId) | Initialize BarcodeSignature object with signature identifier that was obtained after search process.
 |
| BarcodeSignature() | Initialize BarcodeSignature with default parameters.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies the Barcode Encode Type.
 |
| getText() | Specifies text of Barcode.
 |
| getFormat() | Specifies the format of Barcode signature image.
 |
| getContent() | Specifies Barcode binary data image content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Barcode Signature instance.
 |
| setContent(SignOptions signOptions, BufferedImage image) |  |
##### BarcodeSignature(String signatureId)
```
public BarcodeSignature(String signatureId)
```

Initialize BarcodeSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by Sign or Search method of Signature class Signature.
 |

##### BarcodeSignature()
```
public BarcodeSignature()
```

Initialize BarcodeSignature with default parameters.

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Specifies the Barcode Encode Type.

**Returns:**
BarcodeType
##### getText()
```
public final String getText()
```

Specifies text of Barcode.

**Returns:**
java.lang.String
##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of Barcode signature image.

**Returns:**
FileType
##### getContent()
```
public final byte[] getContent()
```

Specifies Barcode binary data image content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
By default this property will not be set.
Use property
BarcodeSearchOptions.ReturnContent
(BarcodeSearchOptions.getReturnContent/BarcodeSearchOptions.setReturnContent(boolean)) to enable this feature.

**Returns:**
byte[]
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

##### setContent(SignOptions signOptions, BufferedImage image)
```
public final void setContent(SignOptions signOptions, BufferedImage image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions |  |
| image | java.awt.image.BufferedImage |  |

### BaseSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/basesignature.md

**Inheritance:**
java.lang.Object
```
public abstract class BaseSignature
```

Describes base class for signatures.

#### Methods

| Method | Description |
| --- | --- |
| getSignatureType() | Specifies the type of signature.
 |
| getPageNumber() | Specifies the page signature was found on.
 |
| setPageNumber(Integer value) | Specifies the page signature was found on.
 |
| getSignatureId() | Unique signature identifier to modify signature in the document over Update or Delete methods.
 |
| isSignature() | Get or set flag to indicate if this component is Signature or document content.
 |
| setSignature(boolean value) | Get or set flag to indicate if this component is Signature or document content.
 |
| getDeleted() | Get or set flag to indicate if this signature was deleted from the document.
 |
| getCreatedOn() | Get or set the signature creation date.
 |
| setCreatedOn(Date value) | Get or set the signature creation date.
 |
| getModifiedOn() | Get or set the signature modification date.
 |
| setModifiedOn(Date value) | Get or set the signature modification date.
 |
| getTop() | Specifies top position of signature.
 |
| setTop(int value) | Specifies top position of signature.
 |
| getLeft() | Specifies left position of signature.
 |
| setLeft(int value) | Specifies left position of signature.
 |
| getWidth() | Specifies width of signature.
 |
| setWidth(int value) | Specifies width of signature.
 |
| getHeight() | Specifies height of signature.
 |
| setHeight(int value) | Specifies height of signature.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| supportMetaInfoLayer() |  |
| toString() | <br />

 |
##### getSignatureType()
```
public final int getSignatureType()
```

Specifies the type of signature. Digital signature will have this property.

**Returns:**
int
##### getPageNumber()
```
public final Integer getPageNumber()
```

Specifies the page signature was found on.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Specifies the page signature was found on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getSignatureId()
```
public final String getSignatureId()
```

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

**Returns:**
java.lang.String
##### isSignature()
```
public final boolean isSignature()
```

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

**Returns:**
boolean
##### setSignature(boolean value)
```
public final void setSignature(boolean value)
```

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDeleted()
```
public final boolean getDeleted()
```

Get or set flag to indicate if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

**Returns:**
boolean
##### getCreatedOn()
```
public final Date getCreatedOn()
```

Get or set the signature creation date.

**Returns:**
java.util.Date
##### setCreatedOn(Date value)
```
public final void setCreatedOn(Date value)
```

Get or set the signature creation date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getModifiedOn()
```
public final Date getModifiedOn()
```

Get or set the signature modification date.

**Returns:**
java.util.Date
##### setModifiedOn(Date value)
```
public final void setModifiedOn(Date value)
```

Get or set the signature modification date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTop()
```
public final int getTop()
```

Specifies top position of signature.

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Specifies top position of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Specifies left position of signature.

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Specifies left position of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Specifies width of signature.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Specifies width of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Specifies height of signature.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Specifies height of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int -
##### supportMetaInfoLayer()
```
public boolean supportMetaInfoLayer()
```

**Returns:**
boolean
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String -

### DigitalSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/digitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class DigitalSignature extends BaseSignature
```

Contains Digital signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignature() | Initialize Digital signature with default parameters.
 |
| DigitalSignature(String signatureId) | Initialize Digital signature with known SignatureId.
 |
| DigitalSignature(KeyStore certificate) | Create Digital signature with specified certificate.
 |
| DigitalSignature(X509Certificate cert, PrivateKey key) | Create Digital signature based on X509Certificate certificate and PrivateKey.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Gets or sets the KeyStore certificate.
 |
| setCertificate(KeyStore value) | Gets or sets the KeyStore certificate.
 |
| getX509Certificate() | Gets or sets the X509 certificate.
 |
| setX509Certificate(X509Certificate value) | Gets or sets the X509 certificate.
 |
| getPrivateKey() | Gets or sets the PrivateKey of certificate.
 |
| setPrivateKey(PrivateKey value) | Gets or sets the PrivateKey of certificate.
 |
| getCertificateName() | Gets or sets the X509 certificate name.
 |
| setCertificateName(String value) | Gets or sets the X509 certificate name.
 |
| getComments() | Gets or sets the signing purpose comment.
 |
| setComments(String value) | Gets or sets the signing purpose comment.
 |
| isValid() | Keeps true if this digital signature is valid and the document has not been tampered with.
 |
| setValid(boolean value) | Keeps true if this digital signature is valid and the document has not been tampered with.
 |
| getSignTime() | Gets or sets the time the document was signed.
 |
| setSignTime(Date value) | Gets or sets the time the document was signed.
 |
| getXAdESType() | XAdES type
XAdESType
.
 |
| setXAdESType(int value) | XAdES type
XAdESType
.
 |
| getThumbprint() | Gets the thumbprint of a certificate.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Barcode Signature instance.
 |
| loadDigitalSignatures() | Load Digital signature from all system X509 Certificates Stores.
 |
| loadDigitalSignatures(StoreName storeName) | Load Digital signature from passed X509 Certificates Store.
 |
##### DigitalSignature()
```
public DigitalSignature()
```

Initialize Digital signature with default parameters.

##### DigitalSignature(String signatureId)
```
public DigitalSignature(String signatureId)
```

Initialize Digital signature with known SignatureId.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String |  |

##### DigitalSignature(KeyStore certificate)
```
public DigitalSignature(KeyStore certificate)
```

Create Digital signature with specified certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificate | java.security.KeyStore | X509 certificate.
 |

##### DigitalSignature(X509Certificate cert, PrivateKey key)
```
public DigitalSignature(X509Certificate cert, PrivateKey key)
```

Create Digital signature based on X509Certificate certificate and PrivateKey.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cert | java.security.cert.X509Certificate | X509Certificate certificate.
 |
| key | java.security.PrivateKey | PrivateKey of certificate.
 |

##### getCertificate()
```
public final KeyStore getCertificate()
```

Gets or sets the KeyStore certificate.

**Returns:**
java.security.KeyStore
##### setCertificate(KeyStore value)
```
public final void setCertificate(KeyStore value)
```

Gets or sets the KeyStore certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.KeyStore |  |

##### getX509Certificate()
```
public final X509Certificate getX509Certificate()
```

Gets or sets the X509 certificate.

**Returns:**
java.security.cert.X509Certificate
##### setX509Certificate(X509Certificate value)
```
public final void setX509Certificate(X509Certificate value)
```

Gets or sets the X509 certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.cert.X509Certificate |  |

##### getPrivateKey()
```
public final PrivateKey getPrivateKey()
```

Gets or sets the PrivateKey of certificate.

**Returns:**
java.security.PrivateKey
##### setPrivateKey(PrivateKey value)
```
public final void setPrivateKey(PrivateKey value)
```

Gets or sets the PrivateKey of certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.PrivateKey |  |

##### getCertificateName()
```
public final String getCertificateName()
```

Gets or sets the X509 certificate name.

**Returns:**
java.lang.String
##### setCertificateName(String value)
```
public final void setCertificateName(String value)
```

Gets or sets the X509 certificate name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getComments()
```
public final String getComments()
```

Gets or sets the signing purpose comment.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Gets or sets the signing purpose comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### isValid()
```
public final boolean isValid()
```

Keeps true if this digital signature is valid and the document has not been tampered with.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Keeps true if this digital signature is valid and the document has not been tampered with.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSignTime()
```
public final Date getSignTime()
```

Gets or sets the time the document was signed.

**Returns:**
java.util.Date
##### setSignTime(Date value)
```
public final void setSignTime(Date value)
```

Gets or sets the time the document was signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getXAdESType()
```
public final int getXAdESType()
```

XAdES type
XAdESType
. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.

**Returns:**
int
##### setXAdESType(int value)
```
public final void setXAdESType(int value)
```

XAdES type
XAdESType
. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getThumbprint()
```
public final String getThumbprint()
```

Gets the thumbprint of a certificate.

**Returns:**
java.lang.String
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

##### loadDigitalSignatures()
```
public static List<DigitalSignature> loadDigitalSignatures()
```

Load Digital signature from all system X509 Certificates Stores.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature> - Returns list of DigitalSignature Digital Signatures.

##### loadDigitalSignatures(StoreName storeName)
```
public static List<DigitalSignature> loadDigitalSignatures(StoreName storeName)
```

Load Digital signature from passed X509 Certificates Store.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storeName | StoreName |  |

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature> - Returns list of DigitalSignature Digital Signatures.

### DocumentResultSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/documentresultsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class DocumentResultSignature extends BaseSignature
```

Result of processing archive document signing process for document with newly created signatures.

#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Document file name
 |
| getProcessingTime() | Returns the execution time of the process in milliseconds
 |
| getTotalSignatures() | Returns the total processed signatures
 |
| getSourceDocumentSize() | Returns source document size
 |
| getDestinDocumentSize() | Returns destination document size
 |
| getSucceeded() | List of successfully processed signatures BaseSignature.
 |
| getFailed() | List of the signatures that failed during the process BaseSignature.
 |
| getErrorMessage() | if document was processed with error this property will contain the error message
 |
##### getFileName()
```
public final String getFileName()
```

Document file name

**Returns:**
java.lang.String
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully processed signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of the signatures that failed during the process BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getErrorMessage()
```
public final String getErrorMessage()
```

if document was processed with error this property will contain the error message

**Returns:**
java.lang.String

### ImageSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/imagesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class ImageSignature extends BaseSignature
```

Contains Image signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSignature(String signatureId) | Initialize ImageSignature object with signature identifier that was obtained after search process.
 |
| ImageSignature() | Initialize ImageSignature with default parameters.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Specifies the size in bytes of signature image.
 |
| setSize(int value) | Specifies the size in bytes of signature image.
 |
| getFormat() | Specifies the format of signature image.
 |
| setFormat(FileType value) | Specifies the format of signature image.
 |
| getContent() | Specifies image binary data content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Barcode Signature instance.
 |
##### ImageSignature(String signatureId)
```
public ImageSignature(String signatureId)
```

Initialize ImageSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by Sign or Search method of Signature class Signature.
 |

##### ImageSignature()
```
public ImageSignature()
```

Initialize ImageSignature with default parameters.

##### getSize()
```
public final int getSize()
```

Specifies the size in bytes of signature image.

**Returns:**
int
##### setSize(int value)
```
public final void setSize(int value)
```

Specifies the size in bytes of signature image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of signature image.

**Returns:**
FileType
##### setFormat(FileType value)
```
public final void setFormat(FileType value)
```

Specifies the format of signature image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### getContent()
```
public final byte[] getContent()
```

Specifies image binary data content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
By default this property will not be set.
Use property
ImageSearchOptions.ReturnContent
({ ImageSearchOptions#getReturnContent}/{ ImageSearchOptions#setReturnContent(boolean)}) to enable this feature.

**Returns:**
byte[]
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

### PdfDigitalSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/pdfdigitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.DigitalSignature
```
public class PdfDigitalSignature extends DigitalSignature
```

Contains Pdf Digital signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDigitalSignature() | Initialize Pdf Digital Signature with no certificate.
 |
| PdfDigitalSignature(KeyStore certificate) | Create Pdf Digital signature with specified certificate.
 |
#### Methods

| Method | Description |
| --- | --- |
| getContactInfo() | Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g.
 |
| setContactInfo(String value) | Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g.
 |
| getLocation() | The CPU host name or physical location of the signing.
 |
| setLocation(String value) | The CPU host name or physical location of the signing.
 |
| getReason() | The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).
 |
| setReason(String value) | The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).
 |
| getType() | Type of Pdf digital signature.
 |
| setType(int value) | Type of Pdf digital signature.
 |
| getTimeStamp() | Time stamp for Pdf digital signature.
 |
| setTimeStamp(TimeStamp value) | Time stamp for Pdf digital signature.
 |
| getShowProperties() | Force to show/hide signature properties.
 |
| setShowProperties(boolean value) | Force to show/hide signature properties.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Barcode Signature instance.
 |
##### PdfDigitalSignature()
```
public PdfDigitalSignature()
```

Initialize Pdf Digital Signature with no certificate.

##### PdfDigitalSignature(KeyStore certificate)
```
public PdfDigitalSignature(KeyStore certificate)
```

Create Pdf Digital signature with specified certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificate | java.security.KeyStore | X509 certificate.
 |

##### getContactInfo()
```
public final String getContactInfo()
```

Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g. a phone number.

**Returns:**
java.lang.String
##### setContactInfo(String value)
```
public final void setContactInfo(String value)
```

Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g. a phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

The CPU host name or physical location of the signing.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

The CPU host name or physical location of the signing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReason()
```
public final String getReason()
```

The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getType()
```
public final int getType()
```

Type of Pdf digital signature.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Type of Pdf digital signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTimeStamp()
```
public final TimeStamp getTimeStamp()
```

Time stamp for Pdf digital signature.
Default value is null.

**Returns:**
TimeStamp
##### setTimeStamp(TimeStamp value)
```
public final void setTimeStamp(TimeStamp value)
```

Time stamp for Pdf digital signature.
Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TimeStamp |  |

##### getShowProperties()
```
public final boolean getShowProperties()
```

Force to show/hide signature properties. In case ShowProperties is true signature
field has predefined format of appearance
Digitally signed by {
ContactInfo
(#getContactInfo.getContactInfo/#setContactInfo(String).setContactInfo(String))} Date: {Date} Reason: {
Reason
(#getReason.getReason/#setReason(String).setReason(String))}
Location: {
Location
(#getLocation.getLocation/#setLocation(String).setLocation(String))}
ShowProperties is true by default.

**Returns:**
boolean
##### setShowProperties(boolean value)
```
public final void setShowProperties(boolean value)
```

Force to show/hide signature properties. In case ShowProperties is true signature
field has predefined format of appearance
Digitally signed by {
ContactInfo
(#getContactInfo.getContactInfo/#setContactInfo(String).setContactInfo(String))} Date: {Date} Reason: {
Reason
(#getReason.getReason/#setReason(String).setReason(String))}
Location: {
Location
(#getLocation.getLocation/#setLocation(String).setLocation(String))}
ShowProperties is true by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

### QrCodeSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/qrcodesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class QrCodeSignature extends BaseSignature
```

Contains QR-code signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSignature(String signatureId) | Initialize QrCodeSignature object with signature identifier that was obtained after search process.
 |
| QrCodeSignature() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies the QR-code Encode Type.
 |
| getText() | Specifies text of QR-code.
 |
| getFormat() | Specifies the format of QR-code signature image.
 |
| getContent() | Specifies QR-code binary data image content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
 |
| <T>getData(Class<T> type) | Obtain object from QR-Code Signature Text over deserialization.
 |
| <T>getData(IDataEncryption dataEncryption, Class<T> type) | Obtain object from QR-Code Signature Text over deserialization.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone QR-Code Signature instance.
 |
| setContent(SignOptions signOptions, BufferedImage image) |  |
##### QrCodeSignature(String signatureId)
```
public QrCodeSignature(String signatureId)
```

Initialize QrCodeSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by sign or search method.
 |

##### QrCodeSignature()
```
public QrCodeSignature()
```

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Specifies the QR-code Encode Type.

**Returns:**
QrCodeType
##### getText()
```
public final String getText()
```

Specifies text of QR-code.

**Returns:**
java.lang.String
##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of QR-code signature image.

**Returns:**
FileType
##### getContent()
```
public final byte[] getContent()
```

Specifies QR-code binary data image content of type
Format
(#getFormat.getFormat/#setFormat(FileType).setFormat(FileType)).
By default this property will not be set.
Use property
QrCodeSearchOptions.ReturnContent
(QrCodeSearchOptions.getReturnContent/QrCodeSearchOptions.setReturnContent(boolean)) to enable this feature.

**Returns:**
byte[]
##### <T>getData(Class<T> type)
```
public final T <T>getData(Class<T> type)
```

Obtain object from QR-Code Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T -
T
: Type of object to deserialize from QR-Code Text

##### <T>getData(IDataEncryption dataEncryption, Class<T> type)
```
public final T <T>getData(IDataEncryption dataEncryption, Class<T> type)
```

Obtain object from QR-Code Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataEncryption | IDataEncryption | Set custom data encryption implementation

T
: Type of object to deserialize from QR-Code Text
 |
| type | java.lang.Class<T> |  |

**Returns:**
T -
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone QR-Code Signature instance.

**Returns:**
java.lang.Object - Returns cloned QR-code Signature instance.

##### setContent(SignOptions signOptions, BufferedImage image)
```
public final void setContent(SignOptions signOptions, BufferedImage image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions |  |
| image | java.awt.image.BufferedImage |  |

### StoreName
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/storename.md

**Inheritance:**
java.lang.Object
```
public class StoreName
```
#### Fields

| Field | Description |
| --- | --- |
| My | Represents "Windows-My" java.security.KeyStore type.
 |
| Root | Represents "Windows-Root" java.security.KeyStore type.
 |
#### Methods

| Method | Description |
| --- | --- |
| getStoreName() | Store name e.g.
 |
##### My
```
public static final StoreName My
```

Represents "Windows-My" java.security.KeyStore type.

##### Root
```
public static final StoreName Root
```

Represents "Windows-Root" java.security.KeyStore type.

##### getStoreName()
```
public final String getStoreName()
```

Store name e.g. "Windows-My".

**Returns:**
java.lang.String

### TextSignature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.signatures/textsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class TextSignature extends BaseSignature
```

Contains Text signature properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextSignature(String signatureId) | Initialize TextSignature object with signature identifier that was obtained after search process.
 |
| TextSignature() |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies text in signature.
 |
| setText(String value) | Specifies text in signature.
 |
| getSignatureImplementation() | Specifies text signature implementation.
 |
| getNative() | Specifies the native attribute.
 |
| setNative(boolean value) | Specifies the native attribute.
 |
| equals(Object signature) | Overwrites Equals method to compare signature properties
 |
| hashCode() | Overrides GetHashCode method
 |
| deepClone() | Clone Text Signature instance.
 |
##### TextSignature(String signatureId)
```
public TextSignature(String signatureId)
```

Initialize TextSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by sign or search method.
 |

##### TextSignature()
```
public TextSignature()
```

##### getText()
```
public final String getText()
```

Specifies text in signature.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies text in signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Specifies text signature implementation.

**Returns:**
int
##### getNative()
```
public final boolean getNative()
```

Specifies the native attribute. It is true if signature is document-specific.

**Returns:**
boolean
##### setNative(boolean value)
```
public final void setNative(boolean value)
```

Specifies the native attribute. It is true if signature is document-specific.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with.
 |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.

##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code

##### deepClone()
```
public Object deepClone()
```

Clone Text Signature instance.

**Returns:**
java.lang.Object - Returns cloned Text Signature instance.

### com.groupdocs.signature.domain.stamps
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps.md

The **GroupDocs.Signature.Domain.Stamps** namespace provides classes for working with Stamps.

#### Classes

| Class | Description |
| --- | --- |
| Corners | Represents corners of a square graphical object. |
| SquareBorder | Instance to keep Border line properties for square stamp line. |
| StampBackgroundCropType | Specifies crop type of background layer on Stamp elements. |
| StampLine | Specify Stamp line properties. |
| StampTextRepeatType | Specifies type of text repeat for stamp lines. |
| StampType | Specify stamp type properties. |
| StampTypes | Stamp types container. |

### Corners
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/corners.md

**Inheritance:**
java.lang.Object
```
public class Corners
```

Represents corners of a square graphical object.

#### Constructors

| Constructor | Description |
| --- | --- |
| Corners() | Initializes a new instance of Corners class using zero values.
 |
| Corners(double all) | Initializes a new instance of the Corners class using the supplied value for all corners.
 |
| Corners(double topLeft, double topRight, double bottomLeft, double bottomRight) | Initializes a new instance of the Corners class using the supplied values.
 |
#### Fields

| Field | Description |
| --- | --- |
| Empty | Provides a Corners object with no data.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets or sets the value for all corners.
 |
| setAll(double value) | Gets or sets the value for all corners.
 |
| getTopLeft() | Gets or sets top left corner value.
 |
| setTopLeft(double value) | Gets or sets top left corner value.
 |
| getTopRight() | Gets or sets top right corner value.
 |
| setTopRight(double value) | Gets or sets top right corner value.
 |
| getBottomLeft() | Gets or sets bottom left corner value.
 |
| setBottomLeft(double value) | Gets or sets bottom left corner value.
 |
| getBottomRight() | Gets or sets bottom right corner value.
 |
| setBottomRight(double value) | Gets or sets bottom right corner value.
 |
| deepClone() | Gets a copy of this object.
 |
| equals(Object obj) | Override equals method
 |
| hashCode() | Overrides obtaining unique hash code value
 |
| toString() | Overrides conversion to string.
 |
##### Corners()
```
public Corners()
```

Initializes a new instance of Corners class using zero values.

##### Corners(double all)
```
public Corners(double all)
```

Initializes a new instance of the Corners class using the supplied value for all corners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| all | double | The value to be used for padding for all corners.
 |

##### Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)
```
public Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)
```

Initializes a new instance of the Corners class using the supplied values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | double | Top left corner value.
 |
| topRight | double | Top right corner value.
 |
| bottomLeft | double | Bottom left corner value.
 |
| bottomRight | double | Bottom right corner value.
 |

##### Empty
```
public static final Corners Empty
```

Provides a Corners object with no data.

##### getAll()
```
public final double getAll()
```

Gets or sets the value for all corners.
Changing of any partial corner like top right makes this property equal 0;

**Returns:**
double
##### setAll(double value)
```
public final void setAll(double value)
```

Gets or sets the value for all corners.
Changing of any partial corner like top right makes this property equal 0;

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getTopLeft()
```
public final double getTopLeft()
```

Gets or sets top left corner value.

**Returns:**
double
##### setTopLeft(double value)
```
public final void setTopLeft(double value)
```

Gets or sets top left corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getTopRight()
```
public final double getTopRight()
```

Gets or sets top right corner value.

**Returns:**
double
##### setTopRight(double value)
```
public final void setTopRight(double value)
```

Gets or sets top right corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBottomLeft()
```
public final double getBottomLeft()
```

Gets or sets bottom left corner value.

**Returns:**
double
##### setBottomLeft(double value)
```
public final void setBottomLeft(double value)
```

Gets or sets bottom left corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBottomRight()
```
public final double getBottomRight()
```

Gets or sets bottom right corner value.

**Returns:**
double
##### setBottomRight(double value)
```
public final void setBottomRight(double value)
```

Gets or sets bottom right corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Override equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Instance to compare with.
 |

**Returns:**
boolean - Returns true if properties of objects are equal.

##### hashCode()
```
public int hashCode()
```

Overrides obtaining unique hash code value

**Returns:**
int -
##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### SquareBorder
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/squareborder.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.Border
```
public class SquareBorder extends Border
```

Instance to keep Border line properties for square stamp line.

#### Constructors

| Constructor | Description |
| --- | --- |
| SquareBorder(double radius) | Creates SquareBorderLine with rounded corner radius.
 |
| SquareBorder(Corners corners) | Creates SquareBorderLine with corner radius values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getRadius() | Gets or sets the radius of square corners.
 |
| setRadius(Corners value) | Gets or sets the radius of square corners.
 |
##### SquareBorder(double radius)
```
public SquareBorder(double radius)
```

Creates SquareBorderLine with rounded corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| radius | double | Radius of square corners.
 |

##### SquareBorder(Corners corners)
```
public SquareBorder(Corners corners)
```

Creates SquareBorderLine with corner radius values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| corners | Corners | Radius of square corners.
 |

##### getRadius()
```
public final Corners getRadius()
```

Gets or sets the radius of square corners.

**Returns:**
Corners
##### setRadius(Corners value)
```
public final void setRadius(Corners value)
```

Gets or sets the radius of square corners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Corners |  |

### StampBackgroundCropType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/stampbackgroundcroptype.md

**Inheritance:**
java.lang.Object
```
public final class StampBackgroundCropType
```

Specifies crop type of background layer on Stamp elements.

#### Fields

| Field | Description |
| --- | --- |
| None | No crop - all Signature area rectangle will be filled with background.
 |
| OuterArea | Crop background by external outer line.
 |
| MiddleArea | Crop background between external and inner lines.
 |
| InnerArea | Crop background by internal line.
 |
##### None
```
public static final int None
```

No crop - all Signature area rectangle will be filled with background.

##### OuterArea
```
public static final int OuterArea
```

Crop background by external outer line.

##### MiddleArea
```
public static final int MiddleArea
```

Crop background between external and inner lines.

##### InnerArea
```
public static final int InnerArea
```

Crop background by internal line.

### StampLine
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/stampline.md

**Inheritance:**
java.lang.Object
```
public class StampLine
```

Specify Stamp line properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| StampLine() | Create StampLine with default values.
 |
| StampLine(String text) | Create StampLine with text.
 |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets or sets the line height on Stamp.
 |
| setHeight(int value) | Gets or sets the line height on Stamp.
 |
| getBackgroundColor() | Gets or sets the background color of signature.
 |
| setBackgroundColor(Color value) | Gets or sets the background color of signature.
 |
| setBackgroundColor(String value) | Gets or sets the background color of signature.
 |
| getText() | Gets or sets the text of stamp line.
 |
| setText(String value) | Gets or sets the text of stamp line.
 |
| getFont() | Get or set Font of Stamp Line text.
 |
| setFont(SignatureFont value) | Get or set Font of Stamp Line text.
 |
| getTextColor() | Gets or sets the text color of signature.
 |
| setTextColor(Color value) | Gets or sets the text color of signature.
 |
| setTextColor(String value) | Gets or sets the text color of signature.
 |
| getTextBottomIntent() | Gets or sets the bottom intent of text.
 |
| setTextBottomIntent(int value) | Gets or sets the bottom intent of text.
 |
| getTextRepeatType() | Gets or sets text repeat type.
 |
| setTextRepeatType(int value) | Gets or sets text repeat type.
 |
| getOuterBorder() | Setup Outer Border.
 |
| setOuterBorder(Border value) | Setup Outer Border.
 |
| getInnerBorder() | Setup Internal Border.
 |
| setInnerBorder(Border value) | Setup Internal Border.
 |
| getVisible() | Get and set visibility of Stamp Line.
 |
| setVisible(boolean value) | Get and set visibility of Stamp Line.
 |
##### StampLine()
```
public StampLine()
```

Create StampLine with default values.

##### StampLine(String text)
```
public StampLine(String text)
```

Create StampLine with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text of Stamp Line.
 |

##### getHeight()
```
public final int getHeight()
```

Gets or sets the line height on Stamp.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Gets or sets the line height on Stamp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBackgroundColor()
```
public final Color getBackgroundColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setBackgroundColor(Color value)
```
public final void setBackgroundColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setBackgroundColor(String value)
```
public final void setBackgroundColor(String value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getText()
```
public final String getText()
```

Gets or sets the text of stamp line.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets the text of stamp line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFont()
```
public final SignatureFont getFont()
```

Get or set Font of Stamp Line text.

**Returns:**
SignatureFont
##### setFont(SignatureFont value)
```
public final void setFont(SignatureFont value)
```

Get or set Font of Stamp Line text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureFont |  |

##### getTextColor()
```
public final Color getTextColor()
```

Gets or sets the text color of signature.

**Returns:**
java.awt.Color
##### setTextColor(Color value)
```
public final void setTextColor(Color value)
```

Gets or sets the text color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setTextColor(String value)
```
public final void setTextColor(String value)
```

Gets or sets the text color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTextBottomIntent()
```
public final int getTextBottomIntent()
```

Gets or sets the bottom intent of text.

**Returns:**
int
##### setTextBottomIntent(int value)
```
public final void setTextBottomIntent(int value)
```

Gets or sets the bottom intent of text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextRepeatType()
```
public final int getTextRepeatType()
```

Gets or sets text repeat type.

**Returns:**
int
##### setTextRepeatType(int value)
```
public final void setTextRepeatType(int value)
```

Gets or sets text repeat type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getOuterBorder()
```
public final Border getOuterBorder()
```

Setup Outer Border.

**Returns:**
Border
##### setOuterBorder(Border value)
```
public final void setOuterBorder(Border value)
```

Setup Outer Border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getInnerBorder()
```
public final Border getInnerBorder()
```

Setup Internal Border.

**Returns:**
Border
##### setInnerBorder(Border value)
```
public final void setInnerBorder(Border value)
```

Setup Internal Border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getVisible()
```
public final boolean getVisible()
```

Get and set visibility of Stamp Line.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

Get and set visibility of Stamp Line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### StampTextRepeatType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/stamptextrepeattype.md

**Inheritance:**
java.lang.Object
```
public final class StampTextRepeatType
```

Specifies type of text repeat for stamp lines.

#### Fields

| Field | Description |
| --- | --- |
| None | No repeat.
 |
| FullTextRepeat | Text will be repeated to fit full length without truncation.
 |
| RepeatWithTruncation | Text will be repeated to fit full length with word truncation at the end.
 |
##### None
```
public static final int None
```

No repeat.

##### FullTextRepeat
```
public static final int FullTextRepeat
```

Text will be repeated to fit full length without truncation.

##### RepeatWithTruncation
```
public static final int RepeatWithTruncation
```

Text will be repeated to fit full length with word truncation at the end.

### StampType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/stamptype.md

**Inheritance:**
java.lang.Object
```
public final class StampType
```

Specify stamp type properties.

#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Get Index of object in collection of supported stamp types.
 |
| getTypeName() | Name of stamp type.
 |
| equals(StampType other) | Determines whether the specified stamp type is equal to the current object.
 |
| hashCode() | Overridden method serves as a hash function for a particular type.
 |
| toString() | Overridden method serves as conversion to string type.
 |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Get Index of object in collection of supported stamp types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Name of stamp type.

**Returns:**
java.lang.String
##### equals(StampType other)
```
public final boolean equals(StampType other)
```

Determines whether the specified stamp type is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | StampType | Object for comparison.
 |

**Returns:**
boolean - Result of comparison.

##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash.

##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - String.

### StampTypes
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.stamps/stamptypes.md

**Inheritance:**
java.lang.Object
```
public class StampTypes
```

Stamp types container.

#### Constructors

| Constructor | Description |
| --- | --- |
| StampTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| Round | Round stamp type object.
 |
| Square | Square stamp type object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All stamp types.
 |
| parse(String parsingType) | Returns stamp type with pasringType name.
 |
| tryParse(String parsingType) | Returns stamp type with pasringType name.
 |
##### StampTypes()
```
public StampTypes()
```

##### Round
```
public static final StampType Round
```

Round stamp type object.

##### Square
```
public static final StampType Square
```

Square stamp type object.

##### getAllTypes()
```
public static StampType[] getAllTypes()
```

All stamp types.

**Returns:**
com.groupdocs.signature.domain.stamps.StampType[]
##### parse(String parsingType)
```
public static StampType parse(String parsingType)
```

Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of stamp type name.
 |

**Returns:**
StampType - StampType instance.

##### tryParse(String parsingType)
```
public static StampType tryParse(String parsingType)
```

Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of stamp type name.
 |

**Returns:**
StampType - StampType instance.

### com.groupdocs.signature.domain.structs
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.structs.md

#### Classes

| Class | Description |
| --- | --- |
| TimeStamp | Represents data to get time stamp from third-party site. |

### TimeStamp
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.structs/timestamp.md

**Inheritance:**
java.lang.Object
```
public class TimeStamp
```

Represents data to get time stamp from third-party site.

#### Constructors

| Constructor | Description |
| --- | --- |
| TimeStamp() |  |
| TimeStamp(String url, String user, String password) | Instantiates new time stamp structure.
 |
#### Methods

| Method | Description |
| --- | --- |
| getUrl() | Url of third-party site.
 |
| setUrl(String value) | Url of third-party site.
 |
| getUser() | User.
 |
| setUser(String value) | User.
 |
| getPassword() | Password.
 |
| setPassword(String value) | Password.
 |
| CloneTo(TimeStamp that) |  |
| Clone() |  |
| clone() |  |
| equals(Object obj) |  |
| hashCode() |  |
| equals(TimeStamp obj1, TimeStamp obj2) |  |
##### TimeStamp()
```
public TimeStamp()
```

##### TimeStamp(String url, String user, String password)
```
public TimeStamp(String url, String user, String password)
```

Instantiates new time stamp structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.lang.String | Url of third-party site.
 |
| user | java.lang.String | User.
 |
| password | java.lang.String | Password.
 |

##### getUrl()
```
public final String getUrl()
```

Url of third-party site.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Url of third-party site.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUser()
```
public final String getUser()
```

User.

**Returns:**
java.lang.String
##### setUser(String value)
```
public final void setUser(String value)
```

User.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### CloneTo(TimeStamp that)
```
public void CloneTo(TimeStamp that)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| that | TimeStamp |  |

##### Clone()
```
public TimeStamp Clone()
```

**Returns:**
TimeStamp
##### clone()
```
public Object clone()
```

**Returns:**
java.lang.Object
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(TimeStamp obj1, TimeStamp obj2)
```
public static boolean equals(TimeStamp obj1, TimeStamp obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | TimeStamp |  |
| obj2 | TimeStamp |  |

**Returns:**
boolean

### com.groupdocs.signature.domain
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain.md

The **GroupDocs.Signature.Domain** namespace provides classes for working with document representation.

#### Classes

| Class | Description |
| --- | --- |
| Background | Represents background appearance |
| Border | Instance to keep Border line properties. |
| DeleteResult | Result of signature(s) deletion from the document. |
| Padding | Represents padding or margin information associated with element. |
| PageInfo | Document page description class |
| ProcessLog | Represents document process details. |
| SearchResult | Result of searching for signatures in specified document. |
| SignResult | Result of signing process for document with newly created signatures. |
| SignatureFont | Create instance of SignatureFont class to specify Font properties. |
| UpdateResult | Result of modification of signatures in the document. |
| VerificationResult | Instance to keep results of verification process. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IResult | Common interface for signature process result. |

### Background
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/background.md

**Inheritance:**
java.lang.Object
```
public class Background
```

Represents background appearance

#### Constructors

| Constructor | Description |
| --- | --- |
| Background() |  |
#### Methods

| Method | Description |
| --- | --- |
| getColor() | Gets or sets the background color of signature.
 |
| setColor(Color value) | Gets or sets the background color of signature.
 |
| setColor(String value) | Gets or sets the background color of signature.
 |
| getTransparency() | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| setTransparency(double value) | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| getBrush() | Gets or sets the background brush.
 |
| setBrush(Brush value) | Gets or sets the background brush.
 |
##### Background()
```
public Background()
```

##### getColor()
```
public final Color getColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBrush()
```
public final Brush getBrush()
```

Gets or sets the background brush. Value by default is null.
This property expects instance of Brush objects implementations
See different Brush classes

**Returns:**
Brush
##### setBrush(Brush value)
```
public final void setBrush(Brush value)
```

Gets or sets the background brush. Value by default is null.
This property expects instance of Brush objects implementations
See different Brush classes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Brush |  |

### Border
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/border.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.ITransparency
```
public class Border implements ITransparency
```

Instance to keep Border line properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| Border() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDashStyle() | Gets or sets the signature border style.
 |
| setDashStyle(int value) | Gets or sets the signature border style.
 |
| getTransparency() | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| setTransparency(double value) | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| getWeight() | Gets or sets the weight of the signature border.
 |
| setWeight(double value) | Gets or sets the weight of the signature border.
 |
| getColor() | Gets or sets the border color of signature.
 |
| setColor(Color value) | Gets or sets the border color of signature.
 |
| setColor(String value) | Gets or sets the border color of signature.
 |
| getVisible() | Gets or sets the border visibility.
 |
| setVisible(boolean value) |  |
| deepClone() | Implement IClonable interface
 |
##### Border()
```
public Border()
```

##### getDashStyle()
```
public final int getDashStyle()
```

Gets or sets the signature border style.

**Returns:**
int
##### setDashStyle(int value)
```
public final void setDashStyle(int value)
```

Gets or sets the signature border style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getWeight()
```
public final double getWeight()
```

Gets or sets the weight of the signature border.

**Returns:**
double
##### setWeight(double value)
```
public final void setWeight(double value)
```

Gets or sets the weight of the signature border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getColor()
```
public final Color getColor()
```

Gets or sets the border color of signature.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets the border color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets the border color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVisible()
```
public boolean getVisible()
```

Gets or sets the border visibility.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Implement IClonable interface

**Returns:**
java.lang.Object - Newly created Border instance with same properties

### DeleteResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/deleteresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class DeleteResult implements IResult
```

Result of signature(s) deletion from the document.

#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds.
 |
| getTotalSignatures() | Returns the total processed signatures.
 |
| getSourceDocumentSize() | Returns source document size.
 |
| getDestinDocumentSize() | Returns updated document size.
 |
| getSucceeded() | List of successfully deleted signatures BaseSignature.
 |
| getFailed() | List of signatures that were not deleted BaseSignature.
 |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures.

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size.

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns updated document size.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully deleted signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were not deleted BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### IResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/iresult.md

### Padding
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/padding.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Cloneable
```
public class Padding implements Cloneable
```

Represents padding or margin information associated with element.

#### Constructors

| Constructor | Description |
| --- | --- |
| Padding() | Initializes a new instance of Padding class using zero values.
 |
| Padding(int all) | Initializes a new instance of the Padding class using the supplied padding size for all edges.
 |
| Padding(int left, int right, int top, int bottom) | Initializes a new instance of the Padding class using the supplied padding sizes.
 |
#### Fields

| Field | Description |
| --- | --- |
| Empty | Provides a Padding object with no padding.
 |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets or sets the padding value for all the edges.
 |
| setAll(int value) | Gets or sets the padding value for all the edges.
 |
| getLeft() | Gets or sets the padding value for the left edge.
 |
| setLeft(int value) | Gets or sets the padding value for the left edge.
 |
| getRight() | Gets or sets the padding value for the right edge.
 |
| setRight(int value) | Gets or sets the padding value for the right edge.
 |
| getTop() | Gets or sets the padding value for the top edge.
 |
| setTop(int value) | Gets or sets the padding value for the top edge.
 |
| getBottom() | Gets or sets the padding value for the bottom edge.
 |
| setBottom(int value) | Gets or sets the padding value for the bottom edge.
 |
| getHorizontal() | Gets the combined padding for the right and left edges.
 |
| getVertical() | Gets the combined padding for the top and bottom edges.
 |
| deepClone() | Gets a copy of this object.
 |
| toString() | Overrides conversion to string
 |
##### Padding()
```
public Padding()
```

Initializes a new instance of Padding class using zero values.

##### Padding(int all)
```
public Padding(int all)
```

Initializes a new instance of the Padding class using the supplied padding size for all edges.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| all | int | The number of measure units to be used for padding for all edges.
 |

##### Padding(int left, int right, int top, int bottom)
```
public Padding(int left, int right, int top, int bottom)
```

Initializes a new instance of the Padding class using the supplied padding sizes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | int | The left padding size.
 |
| right | int | The right padding size.
 |
| top | int | The top padding size.
 |
| bottom | int | The bottom padding size.
 |

##### Empty
```
public static final Padding Empty
```

Provides a Padding object with no padding.

##### getAll()
```
public final int getAll()
```

Gets or sets the padding value for all the edges.
Changing of any partial edge like left or top makes this property equal 0;

**Returns:**
int
##### setAll(int value)
```
public final void setAll(int value)
```

Gets or sets the padding value for all the edges.
Changing of any partial edge like left or top makes this property equal 0;

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Gets or sets the padding value for the left edge.

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Gets or sets the padding value for the left edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRight()
```
public final int getRight()
```

Gets or sets the padding value for the right edge.

**Returns:**
int
##### setRight(int value)
```
public final void setRight(int value)
```

Gets or sets the padding value for the right edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Gets or sets the padding value for the top edge.

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Gets or sets the padding value for the top edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBottom()
```
public final int getBottom()
```

Gets or sets the padding value for the bottom edge.

**Returns:**
int
##### setBottom(int value)
```
public final void setBottom(int value)
```

Gets or sets the padding value for the bottom edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontal()
```
public final int getHorizontal()
```

Gets the combined padding for the right and left edges.

**Returns:**
int
##### getVertical()
```
public final int getVertical()
```

Gets the combined padding for the top and bottom edges.

**Returns:**
int
##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

Overrides conversion to string

**Returns:**
java.lang.String -

### PageInfo
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Document page description class

#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Specifies page width
 |
| setWidth(int value) | Specifies page width
 |
| getHeight() | Specifies page height
 |
| setHeight(int value) | Specifies page height
 |
| getPageNumber() | Specifies page number
 |
| setPageNumber(int value) | Specifies page number
 |
##### PageInfo()
```
public PageInfo()
```

##### getWidth()
```
public final int getWidth()
```

Specifies page width

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Specifies page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Specifies page height

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Specifies page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumber()
```
public final int getPageNumber()
```

Specifies page number

**Returns:**
int
##### setPageNumber(int value)
```
public final void setPageNumber(int value)
```

Specifies page number

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessLog
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/processlog.md

**Inheritance:**
java.lang.Object
```
public final class ProcessLog
```

Represents document process details.

#### Methods

| Method | Description |
| --- | --- |
| getDate() | Get the process date and time.
 |
| getType() | Get the process type.
 |
| getMessage() | Get the process description.
 |
| getSucceeded() | Quantity of successfully processed signatures.
 |
| getFailed() | Quantity of signatures that failed during processing.
 |
| getSignatures() | The list of successfully processed signatures.
 |
##### getDate()
```
public final Date getDate()
```

Get the process date and time.

**Returns:**
java.util.Date
##### getType()
```
public final int getType()
```

Get the process type.

**Returns:**
int
##### getMessage()
```
public final String getMessage()
```

Get the process description.

**Returns:**
java.lang.String
##### getSucceeded()
```
public final int getSucceeded()
```

Quantity of successfully processed signatures.

**Returns:**
int
##### getFailed()
```
public final int getFailed()
```

Quantity of signatures that failed during processing.

**Returns:**
int
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

The list of successfully processed signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### SearchResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/searchresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class SearchResult implements Iterable<BaseSignature>
```

Result of searching for signatures in specified document.

#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the search process in milliseconds.
 |
| getTotalSignatures() | Returns the total processed signatures by the search process
 |
| getSourceDocumentSize() | Returns source document size
 |
| getDestinDocumentSize() | Returns destination document size.
 |
| getSucceeded() | List of found signatures BaseSignature.
 |
| getFailed() | List of signatures BaseSignature that failed Search process by search criteria.
 |
| getSignatures() | List of detected signatures BaseSignature.
 |
| <T>toList(Class<T> typeOfT) | Provides conversion to strongly typed list of signatures.
 |
| updateContextData(SearchContext context, int documentType) |  |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the search process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures by the search process

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size. For Search method it always returns 0.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of found signatures BaseSignature. This list will be always equal to
Signatures
(#getSignatures.getSignatures/#setSignatures(List).setSignatures(List)) property.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures BaseSignature that failed Search process by search criteria.
Not supported in current version.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

List of detected signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### <T>toList(Class<T> typeOfT)
```
public final List<T> <T>toList(Class<T> typeOfT)
```

Provides conversion to strongly typed list of signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List<T> - Returns list of given signature type.

T
: The type of signatures in the list.

##### updateContextData(SearchContext context, int documentType)
```
public final void updateContextData(SearchContext context, int documentType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| context | SearchContext |  |
| documentType | int |  |

### SignatureFont
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/signaturefont.md

**Inheritance:**
java.lang.Object
```
public class SignatureFont
```

Create instance of SignatureFont class to specify Font properties.

#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureFont() | Create SignatureFont with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Font Family Name.
 |
| setFamilyName(String value) | Font Family Name.
 |
| getSize() | Font Size.
 |
| setSize(float value) | Font Size.
 |
| getBold() | Apply Font Bold Style.
 |
| setBold(boolean value) | Apply Font Bold Style.
 |
| getItalic() | Apply Font Italic Style.
 |
| setItalic(boolean value) | Apply Font Italic Style.
 |
| getUnderline() | Apply Underline Style.
 |
| setUnderline(boolean value) | Apply Underline Style.
 |
| getStrikeout() | Apply Strikeout Style.
 |
| setStrikeout(boolean value) | Apply Strikeout Style.
 |
| to_SignatureFont(System.Drawing.Font font) | Convert System.Drawing.Font to SignatureFont.
 |
| toString() | Override conversion to string
 |
##### SignatureFont()
```
public SignatureFont()
```

Create SignatureFont with default values.

##### getFamilyName()
```
public final String getFamilyName()
```

Font Family Name.

**Returns:**
java.lang.String
##### setFamilyName(String value)
```
public final void setFamilyName(String value)
```

Font Family Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSize()
```
public final float getSize()
```

Font Size.

**Returns:**
float
##### setSize(float value)
```
public final void setSize(float value)
```

Font Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getBold()
```
public final boolean getBold()
```

Apply Font Bold Style.

**Returns:**
boolean
##### setBold(boolean value)
```
public final void setBold(boolean value)
```

Apply Font Bold Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getItalic()
```
public final boolean getItalic()
```

Apply Font Italic Style.

**Returns:**
boolean
##### setItalic(boolean value)
```
public final void setItalic(boolean value)
```

Apply Font Italic Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getUnderline()
```
public final boolean getUnderline()
```

Apply Underline Style.

**Returns:**
boolean
##### setUnderline(boolean value)
```
public final void setUnderline(boolean value)
```

Apply Underline Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getStrikeout()
```
public final boolean getStrikeout()
```

Apply Strikeout Style.

**Returns:**
boolean
##### setStrikeout(boolean value)
```
public final void setStrikeout(boolean value)
```

Apply Strikeout Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### to_SignatureFont(System.Drawing.Font font)
```
public static SignatureFont to_SignatureFont(System.Drawing.Font font)
```

Convert System.Drawing.Font to SignatureFont.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| font | com.aspose.ms.System.Drawing.Font | Font.
 |

**Returns:**
SignatureFont - SignatureFont.

##### toString()
```
public String toString()
```

Override conversion to string

**Returns:**
java.lang.String -

### SignResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/signresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class SignResult implements IResult
```

Result of signing process for document with newly created signatures.

#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds
 |
| getTotalSignatures() | Returns the total processed signatures
 |
| getSourceDocumentSize() | Returns source document size
 |
| getDestinDocumentSize() | Returns destination document size
 |
| getSucceeded() | List of newly created signatures BaseSignature.
 |
| getFailed() | List of signatures that were failed to create.
 |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of newly created signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were failed to create.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### UpdateResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/updateresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class UpdateResult implements IResult
```

Result of modification of signatures in the document.

#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds
 |
| getTotalSignatures() | Returns the total processed signatures
 |
| getSourceDocumentSize() | Returns source document size
 |
| getDestinDocumentSize() | Returns destination document size
 |
| getSucceeded() | List of successfully modified signatures BaseSignature.
 |
| getFailed() | List of signatures that were not updated BaseSignature.
 |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully modified signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were not updated BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### VerificationResult
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.domain/verificationresult.md

**Inheritance:**
java.lang.Object
```
public class VerificationResult
```

Instance to keep results of verification process.

#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds.
 |
| getTotalSignatures() | Returns the total processed signatures
 |
| getSourceDocumentSize() | Returns source document size in bytes
 |
| getDestinDocumentSize() | Returns the destination document size.
 |
| getSucceeded() | List of successfully verified signatures BaseSignature.
 |
| isValid() | Returns true if Verification process was successful otherwise false.
 |
| setValid(boolean value) | Returns true if Verification process was successful otherwise false.
 |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size in bytes

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns the destination document size. For verification this variable always contains zero.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully verified signatures BaseSignature.
Currently this property is not supported.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### isValid()
```
public final boolean isValid()
```

Returns true if Verification process was successful otherwise false.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Returns true if Verification process was successful otherwise false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### com.groupdocs.signature.exception
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.exception.md

The **GroupDocs.Signature.Exception** namespace provides classes to handle Signature exceptions.

#### Classes

| Class | Description |
| --- | --- |
| GroupDocsSignatureException | Represents errors that occur during document signing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

### GroupDocsSignatureException
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.exception/groupdocssignatureexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class GroupDocsSignatureException extends Exception
```

Represents errors that occur during document signing.

#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsSignatureException() | Initializes a new instance of the GroupDocsSignatureException class.
 |
| GroupDocsSignatureException(String message) | Initializes a new instance of the GroupDocsSignatureException class with a specified error message.
 |
| GroupDocsSignatureException(Exception ex, String message) | Initializes a new instance of the GroupDocsSignatureException class with a specified error message and original exception.
 |
##### GroupDocsSignatureException()
```
public GroupDocsSignatureException()
```

Initializes a new instance of the GroupDocsSignatureException class.

##### GroupDocsSignatureException(String message)
```
public GroupDocsSignatureException(String message)
```

Initializes a new instance of the GroupDocsSignatureException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error.
 |

##### GroupDocsSignatureException(Exception ex, String message)
```
public GroupDocsSignatureException(Exception ex, String message)
```

Initializes a new instance of the GroupDocsSignatureException class with a specified error message and original exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ex | java.lang.Exception | The original exception.
 |
| message | java.lang.String | The message that describes the error.
 |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.exception/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.signature.exception.GroupDocsSignatureException
```
public class IncorrectPasswordException extends GroupDocsSignatureException
```

The exception that is thrown when specified password is incorrect.

#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() |  |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

### PasswordRequiredException
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.exception/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.signature.exception.GroupDocsSignatureException
```
public class PasswordRequiredException extends GroupDocsSignatureException
```

The exception that is thrown when password is required to load the document.

#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() |  |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

### com.groupdocs.signature.handler.events
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events.md

The **GroupDocs.Signature.Handler.Events** namespace provides classes for input and output Data Handlers.

#### Classes

| Class | Description |
| --- | --- |
| ProcessCompleteEventArgs | Provides data on complete event of signing, verification and search processes. |
| ProcessCompleteEventHandler | Represents a method delegate which will handle processes on complete events for signing, verification and search. |
| ProcessEventArgs | Provides data for different events of signature, verification and search processes. |
| ProcessProgressEventArgs | Provides data for OnProgress event of signing, verification and search processes. |
| ProcessProgressEventHandler | Represents a method delegate which will handle processes on progress events for signing, verification and search. |
| ProcessStartEventArgs | Provides data for Start event of signing, verification and search process |
| ProcessStartEventHandler | Represents a method delegate which will handle processes on start events for signing, verification and search. |

### ProcessCompleteEventArgs
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processcompleteeventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessCompleteEventArgs extends ProcessEventArgs
```

Provides data on complete event of signing, verification and search processes.

#### Methods

| Method | Description |
| --- | --- |
| getCompleted() | Represents time mark of process completion.
 |
| setCompleted(Date value) | Represents time mark of process completion.
 |
| getTicks() | Represents time in milliseconds spent since process Start event.
 |
| setTicks(long value) | Represents time in milliseconds spent since process Start event.
 |
| getTotalSignatures() | Represents total quantity of processed signatures.
 |
| setTotalSignatures(int value) | Represents total quantity of processed signatures.
 |
| getCanceled() | Indicates whether process was canceled.
 |
##### getCompleted()
```
public final Date getCompleted()
```

Represents time mark of process completion.

**Returns:**
java.util.Date
##### setCompleted(Date value)
```
public final void setCompleted(Date value)
```

Represents time mark of process completion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTicks()
```
public final long getTicks()
```

Represents time in milliseconds spent since process Start event.

**Returns:**
long
##### setTicks(long value)
```
public final void setTicks(long value)
```

Represents time in milliseconds spent since process Start event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Represents total quantity of processed signatures.

**Returns:**
int
##### setTotalSignatures(int value)
```
public final void setTotalSignatures(int value)
```

Represents total quantity of processed signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCanceled()
```
public final boolean getCanceled()
```

Indicates whether process was canceled.

**Returns:**
boolean

### ProcessCompleteEventHandler
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processcompleteeventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessCompleteEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on complete events for signing, verification and search.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessCompleteEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessCompleteEventArgs args) |  |
##### ProcessCompleteEventHandler()
```
public ProcessCompleteEventHandler()
```

##### invoke(Signature signature, ProcessCompleteEventArgs args)
```
public abstract void invoke(Signature signature, ProcessCompleteEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessCompleteEventArgs |  |

### ProcessEventArgs
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processeventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs
```
public class ProcessEventArgs extends System.EventArgs
```

Provides data for different events of signature, verification and search processes.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFilePath() | Represents document processing file name.
 |
| setFilePath(String value) | Represents document processing file name.
 |
| getStatus() | Indicates current process state.
 |
| setStatus(int value) | Indicates current process state.
 |
##### ProcessEventArgs()
```
public ProcessEventArgs()
```

##### getFilePath()
```
public final String getFilePath()
```

Represents document processing file name.

**Returns:**
java.lang.String
##### setFilePath(String value)
```
public final void setFilePath(String value)
```

Represents document processing file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStatus()
```
public final int getStatus()
```

Indicates current process state.

**Returns:**
int
##### setStatus(int value)
```
public final void setStatus(int value)
```

Indicates current process state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessProgressEventArgs
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processprogresseventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessProgressEventArgs extends ProcessEventArgs
```

Provides data for OnProgress event of signing, verification and search processes.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessProgressEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getProgress() | Represents progress in percents.
 |
| setProgress(int value) | Represents progress in percents.
 |
| getTicks() | Represents time spent in milliseconds since process Start event.
 |
| setTicks(long value) | Represents time spent in milliseconds since process Start event.
 |
| getProcessedSignatures() | Represents quantity of processed signatures.
 |
| setProcessedSignatures(int value) | Represents quantity of processed signatures.
 |
| getCancel() | Indicates whether process should be canceled.
 |
| setCancel(boolean value) | Indicates whether process should be canceled.
 |
##### ProcessProgressEventArgs()
```
public ProcessProgressEventArgs()
```

##### getProgress()
```
public final int getProgress()
```

Represents progress in percents. Value range is from 0 to 100.

**Returns:**
int
##### setProgress(int value)
```
public final void setProgress(int value)
```

Represents progress in percents. Value range is from 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTicks()
```
public final long getTicks()
```

Represents time spent in milliseconds since process Start event.

**Returns:**
long
##### setTicks(long value)
```
public final void setTicks(long value)
```

Represents time spent in milliseconds since process Start event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getProcessedSignatures()
```
public final int getProcessedSignatures()
```

Represents quantity of processed signatures.

**Returns:**
int
##### setProcessedSignatures(int value)
```
public final void setProcessedSignatures(int value)
```

Represents quantity of processed signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCancel()
```
public final boolean getCancel()
```

Indicates whether process should be canceled.

**Returns:**
boolean
##### setCancel(boolean value)
```
public final void setCancel(boolean value)
```

Indicates whether process should be canceled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### ProcessProgressEventHandler
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processprogresseventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessProgressEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on progress events for signing, verification and search.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessProgressEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessProgressEventArgs args) |  |
##### ProcessProgressEventHandler()
```
public ProcessProgressEventHandler()
```

##### invoke(Signature signature, ProcessProgressEventArgs args)
```
public abstract void invoke(Signature signature, ProcessProgressEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessProgressEventArgs |  |

### ProcessStartEventArgs
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processstarteventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessStartEventArgs extends ProcessEventArgs
```

Provides data for Start event of signing, verification and search process

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessStartEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getStarted() | Represents time mark of process start.
 |
| setStarted(Date value) | Represents time mark of process start.
 |
| getTotalSignatures() | Represents total quantity of signatures to be processed.
 |
| setTotalSignatures(int value) | Represents total quantity of signatures to be processed.
 |
##### ProcessStartEventArgs()
```
public ProcessStartEventArgs()
```

##### getStarted()
```
public final Date getStarted()
```

Represents time mark of process start.

**Returns:**
java.util.Date
##### setStarted(Date value)
```
public final void setStarted(Date value)
```

Represents time mark of process start.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Represents total quantity of signatures to be processed.

**Returns:**
int
##### setTotalSignatures(int value)
```
public final void setTotalSignatures(int value)
```

Represents total quantity of signatures to be processed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessStartEventHandler
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.handler.events/processstarteventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessStartEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on start events for signing, verification and search.

#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessStartEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessStartEventArgs args) |  |
##### ProcessStartEventHandler()
```
public ProcessStartEventHandler()
```

##### invoke(Signature signature, ProcessStartEventArgs args)
```
public abstract void invoke(Signature signature, ProcessStartEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessStartEventArgs |  |

### com.groupdocs.signature.licensing
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.licensing.md

The **GroupDocs.Signature.Licensing** namespace provides classes for licensing the Signature library.

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |

### License
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Provides methods to license the component. Learn more about licensing
here
.

#### Constructors

| Constructor | Description |
| --- | --- |
| License() | Instantiate the License
 |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licensePath) | Licenses the component.
 |
| setLicense(InputStream licenseStream) | Licenses the component.
 |
##### License()
```
public License()
```

Instantiate the License

##### setLicense(String licensePath)
```
public final 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.Signature.lic";
>  GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>  lic.SetLicense(licensePath);
>
>
> ```

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path.
 |

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream 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("GroupDocs.Signature.lic", FileMode.Open))
>  {
>      GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>      lic.SetLicense(licenseStream);
>  }
>
>
> ```

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream.
 |

### com.groupdocs.signature.logging
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.logging.md

The **GroupDocs.Signature.Logging** namespace provides classes for logging purposes.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the file. |
| FileLogger | Writes log messages to the file. |
| LogLevel | Specifies the available Log Level types. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

### ConsoleLogger
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.logging.ILogger
```
public class ConsoleLogger implements ILogger
```

Writes log messages to the file.

#### Constructors

| Constructor | Description |
| --- | --- |
| ConsoleLogger() | Create logger to console.
 |
#### Methods

| Method | Description |
| --- | --- |
| error(String message, Exception exception) | Writes an error message to the console.
 |
| trace(String message) | Writes trace message to the console.
 |
| warning(String message) | Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.
 |
##### ConsoleLogger()
```
public ConsoleLogger()
```

Create logger to console.

##### error(String message, Exception exception)
```
public final void error(String message, Exception exception)
```

Writes an error message to the console.
Error log messages provide information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message.
 |
| exception | java.lang.Exception | The exception.
 |

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console.
Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message.
 |

##### warning(String message)
```
public final void warning(String message)
```

Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message.
 |

### FileLogger
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.logging/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.logging.ILogger
```
public class FileLogger implements ILogger
```

Writes log messages to the file.

#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String fileName) | Create logger to file.
 |
#### Methods

| Method | Description |
| --- | --- |
| error(String message, Exception exception) | Writes an error message to the console.
 |
| trace(String message) | Writes trace message to the console.
 |
| warning(String message) | Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.
 |
##### FileLogger(String fileName)
```
public FileLogger(String fileName)
```

Create logger to file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | Full file name with path
 |

##### error(String message, Exception exception)
```
public final void error(String message, Exception exception)
```

Writes an error message to the console.
Error log messages provide information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message.
 |
| exception | java.lang.Exception | The exception.
 |

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console.
Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message.
 |

##### warning(String message)
```
public final void warning(String message)
```

Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message.
 |

### ILogger
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.logging/ilogger.md

### LogLevel
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.logging/loglevel.md

**Inheritance:**
java.lang.Object
```
public final class LogLevel
```

Specifies the available Log Level types.
This enumeration can be used as flags to set several possible values as enabled bits
Example: LogLevel.Error \| LogLevel.Warning or LogLevel.Error \| LogLevel.Trace

#### Fields

| Field | Description |
| --- | --- |
| None | No logging limitation all information will be logged from trace, warning to errors
 |
| Error | No logging limitation all information will be logged from trace, warning to errors
 |
| Warning | Same as All level, all messages including the Trace level will be logged
 |
| Trace | The logging level to include messages from the Warning to Error level
 |
| All | All Log level events (Error, Warning, Trace) will be included into the logging
 |
##### None
```
public static final int None
```

No logging limitation all information will be logged from trace, warning to errors

##### Error
```
public static final int Error
```

No logging limitation all information will be logged from trace, warning to errors

##### Warning
```
public static final int Warning
```

Same as All level, all messages including the Trace level will be logged

##### Trace
```
public static final int Trace
```

The logging level to include messages from the Warning to Error level

##### All
```
public static final int All
```

All Log level events (Error, Warning, Trace) will be included into the logging

### com.groupdocs.signature.metered
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.metered.md

Provides methods to set metered key.

#### Classes

| Class | Description |
| --- | --- |
| Metered | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |

### Metered
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.metered/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying
Metered
 license.

<br />

*** ** * ** ***

<br />

#### 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.

<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 double 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:**
double
##### getConsumptionCredit()
```
public static double 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:**
double

### com.groupdocs.signature.options.appearances
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances.md

The **GroupDocs.Signature.Options.Appearances** namespace provides classes for additional signature appearances.

#### Classes

| Class | Description |
| --- | --- |
| DigitalSignatureAppearance | Describes appearance of Signature Line for Digital Signature. |
| ImageAppearance | Describes extended appearance features for Image Signature. |
| PdfDigitalSignatureAppearance | Describes appearance of Digital Signature are on PDF documents. |
| PdfTextAnnotationAppearance | Describes appearance of PDF text annotation object (Title, Subject, Content). |
| PdfTextStickerAppearance | Describes appearance of PDF text annotation sticker object and pop-up window of sticker. |
| SignatureAppearance | Represents the signature appearance - additional options for alternative implementations of sign on document page. |

### DigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/digitalsignatureappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class DigitalSignatureAppearance extends SignatureAppearance
```

Describes appearance of Signature Line for Digital Signature.
One Signature Line could be applied for only one Digital Signature.
Signature Line always is on the first page.
This feature may be useful for .docx, .doc, .odt and .xlsx file formats.

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignatureAppearance() | Creates Signature Line Appearance object.
 |
| DigitalSignatureAppearance(String signer, String title, String email) | Creates Signature Line Appearance with specified values (signer, title, email).
 |
#### Methods

| Method | Description |
| --- | --- |
| getSigner() | Gets or sets signer name for signature line.
 |
| setSigner(String value) | Gets or sets signer name for signature line.
 |
| getTitle() | Gets or sets a title for signature line.
 |
| setTitle(String value) | Gets or sets a title for signature line.
 |
| getEmail() | Gets or sets a email that will be displayed in signature line.
 |
| setEmail(String value) | Gets or sets a email that will be displayed in signature line.
 |
| toString() | Override string conversion.
 |
##### DigitalSignatureAppearance()
```
public DigitalSignatureAppearance()
```

Creates Signature Line Appearance object.

##### DigitalSignatureAppearance(String signer, String title, String email)
```
public DigitalSignatureAppearance(String signer, String title, String email)
```

Creates Signature Line Appearance with specified values (signer, title, email).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signer | java.lang.String | Signer name.
 |
| title | java.lang.String | Signature title.
 |
| email | java.lang.String | Author' email.
 |

##### getSigner()
```
public final String getSigner()
```

Gets or sets signer name for signature line.

**Returns:**
java.lang.String
##### setSigner(String value)
```
public final void setSigner(String value)
```

Gets or sets signer name for signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTitle()
```
public final String getTitle()
```

Gets or sets a title for signature line.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets a title for signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets a email that will be displayed in signature line.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets a email that will be displayed in signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### ImageAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/imageappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public class ImageAppearance extends SignatureAppearance
```

Describes extended appearance features for Image Signature.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageAppearance() | Create instance with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getGrayscale() | Setup this flag to true if gray-scale filter is required.
 |
| setGrayscale(boolean value) | Setup this flag to true if gray-scale filter is required.
 |
| getBrightness() | Gets or sets image brightness.
 |
| setBrightness(float value) | Gets or sets image brightness.
 |
| getContrast() | Gets or sets image contrast.
 |
| setContrast(float value) | Gets or sets image contrast.
 |
| getGammaCorrection() | Gets or sets image gamma.
 |
| setGammaCorrection(float value) | Gets or sets image gamma.
 |
##### ImageAppearance()
```
public ImageAppearance()
```

Create instance with default values.

##### getGrayscale()
```
public final boolean getGrayscale()
```

Setup this flag to true if gray-scale filter is required.

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Setup this flag to true if gray-scale filter is required.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getBrightness()
```
public final float getBrightness()
```

Gets or sets image brightness.
Default value is 1 it corresponds to original brightness of image.

**Returns:**
float
##### setBrightness(float value)
```
public final void setBrightness(float value)
```

Gets or sets image brightness.
Default value is 1 it corresponds to original brightness of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getContrast()
```
public final float getContrast()
```

Gets or sets image contrast.
Default value is 1 it corresponds to original contrast of image.

**Returns:**
float
##### setContrast(float value)
```
public final void setContrast(float value)
```

Gets or sets image contrast.
Default value is 1 it corresponds to original contrast of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getGammaCorrection()
```
public final float getGammaCorrection()
```

Gets or sets image gamma.
Default value is 1 it corresponds to original gamma of image.

**Returns:**
float
##### setGammaCorrection(float value)
```
public final void setGammaCorrection(float value)
```

Gets or sets image gamma.
Default value is 1 it corresponds to original gamma of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

### PdfDigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/pdfdigitalsignatureappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class PdfDigitalSignatureAppearance extends SignatureAppearance
```

Describes appearance of Digital Signature are on PDF documents.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDigitalSignatureAppearance() | Creates signature appearance object with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getContactInfoLabel() | Gets or sets contact info label.
 |
| setContactInfoLabel(String value) | Gets or sets contact info label.
 |
| getReasonLabel() | Gets or sets reason label.
 |
| setReasonLabel(String value) | Gets or sets reason label.
 |
| getLocationLabel() | Gets or sets location label.
 |
| setLocationLabel(String value) | Gets or sets location label.
 |
| getDigitalSignedLabel() | Gets or sets digital signed label.
 |
| setDigitalSignedLabel(String value) | Gets or sets digital signed label.
 |
| getDateSignedAtLabel() | Gets or sets date signed label.
 |
| setDateSignedAtLabel(String value) | Gets or sets date signed label.
 |
| getBackground() | Get or set background color of signature appearance.
 |
| setBackground(Color value) | Get or set background color of signature appearance.
 |
| setBackground(String value) | Get or set background color of signature appearance.
 |
| getFontFamilyName() | Gets or sets the Font family name to display the labels.
 |
| setFontFamilyName(String value) | Gets or sets the Font family name to display the labels.
 |
| getFontSize() | Gets or sets the Font size to display the labels.
 |
| setFontSize(double value) | Gets or sets the Font size to display the labels.
 |
| getForeground() | Get or set foreground text color of signature appearance.
 |
| setForeground(Color value) | Get or set foreground text color of signature appearance.
 |
| setForeground(String value) | Get or set foreground text color of signature appearance.
 |
##### PdfDigitalSignatureAppearance()
```
public PdfDigitalSignatureAppearance()
```

Creates signature appearance object with default values.

##### getContactInfoLabel()
```
public final String getContactInfoLabel()
```

Gets or sets contact info label. Default value: "Contact".
if this value is empty then no contact label will appear on digital signature area.

**Returns:**
java.lang.String
##### setContactInfoLabel(String value)
```
public final void setContactInfoLabel(String value)
```

Gets or sets contact info label. Default value: "Contact".
if this value is empty then no contact label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReasonLabel()
```
public final String getReasonLabel()
```

Gets or sets reason label. Default value: "Reason".
if this value is empty then no reason label will appear on digital signature area.

**Returns:**
java.lang.String
##### setReasonLabel(String value)
```
public final void setReasonLabel(String value)
```

Gets or sets reason label. Default value: "Reason".
if this value is empty then no reason label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocationLabel()
```
public final String getLocationLabel()
```

Gets or sets location label. Default value: "Location".
if this value is empty then no location label will appear on digital signature area.

**Returns:**
java.lang.String
##### setLocationLabel(String value)
```
public final void setLocationLabel(String value)
```

Gets or sets location label. Default value: "Location".
if this value is empty then no location label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDigitalSignedLabel()
```
public final String getDigitalSignedLabel()
```

Gets or sets digital signed label. Default value: "Digitally signed by".

**Returns:**
java.lang.String
##### setDigitalSignedLabel(String value)
```
public final void setDigitalSignedLabel(String value)
```

Gets or sets digital signed label. Default value: "Digitally signed by".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDateSignedAtLabel()
```
public final String getDateSignedAtLabel()
```

Gets or sets date signed label. Default value: "Date".

**Returns:**
java.lang.String
##### setDateSignedAtLabel(String value)
```
public final void setDateSignedAtLabel(String value)
```

Gets or sets date signed label. Default value: "Date".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBackground()
```
public final Color getBackground()
```

Get or set background color of signature appearance.
By default the value is SystemColors.Windows

**Returns:**
java.awt.Color
##### setBackground(Color value)
```
public final void setBackground(Color value)
```

Get or set background color of signature appearance.
By default the value is SystemColors.Windows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setBackground(String value)
```
public final void setBackground(String value)
```

Get or set background color of signature appearance.
By default the value is SystemColors.Windows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontFamilyName()
```
public final String getFontFamilyName()
```

Gets or sets the Font family name to display the labels. Default value is "Arial".

**Returns:**
java.lang.String
##### setFontFamilyName(String value)
```
public final void setFontFamilyName(String value)
```

Gets or sets the Font family name to display the labels. Default value is "Arial".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSize()
```
public final double getFontSize()
```

Gets or sets the Font size to display the labels. Default value is 10.

**Returns:**
double
##### setFontSize(double value)
```
public final void setFontSize(double value)
```

Gets or sets the Font size to display the labels. Default value is 10.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getForeground()
```
public final Color getForeground()
```

Get or set foreground text color of signature appearance.
By default the value is Color.FromArgb(76, 100, 255)

**Returns:**
java.awt.Color
##### setForeground(Color value)
```
public final void setForeground(Color value)
```

Get or set foreground text color of signature appearance.
By default the value is Color.FromArgb(76, 100, 255)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeground(String value)
```
public final void setForeground(String value)
```

Get or set foreground text color of signature appearance.
By default the value is Color.FromArgb(76, 100, 255)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### PdfTextAnnotationAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/pdftextannotationappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public class PdfTextAnnotationAppearance extends SignatureAppearance
```

Describes appearance of PDF text annotation object (Title, Subject, Content).

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextAnnotationAppearance() | Creates PDF signature txt annotation appearance object.
 |
| PdfTextAnnotationAppearance(String title, String subject, String contents) | Creates PDF signature txt annotation with specified values (title, subject, contents).
 |
#### Methods

| Method | Description |
| --- | --- |
| getContents() | Gets or sets content of annotation object.
 |
| setContents(String value) | Gets or sets content of annotation object.
 |
| getSubject() | Gets or sets Subject representing description of the object.
 |
| setSubject(String value) | Gets or sets Subject representing description of the object.
 |
| getTitle() | Gets or sets a Title that will be displayed in title bar of annotation object.
 |
| setTitle(String value) | Gets or sets a Title that will be displayed in title bar of annotation object.
 |
| getBorder() | Gets or sets different border settings
 |
| setBorder(Border value) | Gets or sets different border settings
 |
| getBorderEffect() | Gets or sets border effect.
 |
| setBorderEffect(int value) | Gets or sets border effect.
 |
| getBorderEffectIntensity() | Gets or sets border effect intensity.
 |
| setBorderEffectIntensity(int value) | Gets or sets border effect intensity.
 |
| getHCornerRadius() | Gets or sets horizontal corner radius.
 |
| setHCornerRadius(int value) | Gets or sets horizontal corner radius.
 |
| getVCornerRadius() | Gets or sets vertical corner radius.
 |
| setVCornerRadius(int value) | Gets or sets vertical corner radius.
 |
| toString() | Override string conversion.
 |
##### PdfTextAnnotationAppearance()
```
public PdfTextAnnotationAppearance()
```

Creates PDF signature txt annotation appearance object.

##### PdfTextAnnotationAppearance(String title, String subject, String contents)
```
public PdfTextAnnotationAppearance(String title, String subject, String contents)
```

Creates PDF signature txt annotation with specified values (title, subject, contents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | Title.
 |
| subject | java.lang.String | Subject.
 |
| contents | java.lang.String | Contents.
 |

##### getContents()
```
public final String getContents()
```

Gets or sets content of annotation object.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Gets or sets content of annotation object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Gets or sets Subject representing description of the object.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Gets or sets Subject representing description of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTitle()
```
public final String getTitle()
```

Gets or sets a Title that will be displayed in title bar of annotation object.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets a Title that will be displayed in title bar of annotation object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBorder()
```
public final Border getBorder()
```

Gets or sets different border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Gets or sets different border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getBorderEffect()
```
public final int getBorderEffect()
```

Gets or sets border effect.

**Returns:**
int
##### setBorderEffect(int value)
```
public final void setBorderEffect(int value)
```

Gets or sets border effect.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorderEffectIntensity()
```
public final int getBorderEffectIntensity()
```

Gets or sets border effect intensity. Valid range of value is [0..2].

**Returns:**
int
##### setBorderEffectIntensity(int value)
```
public final void setBorderEffectIntensity(int value)
```

Gets or sets border effect intensity. Valid range of value is [0..2].

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHCornerRadius()
```
public final int getHCornerRadius()
```

Gets or sets horizontal corner radius.

**Returns:**
int
##### setHCornerRadius(int value)
```
public final void setHCornerRadius(int value)
```

Gets or sets horizontal corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVCornerRadius()
```
public final int getVCornerRadius()
```

Gets or sets vertical corner radius.

**Returns:**
int
##### setVCornerRadius(int value)
```
public final void setVCornerRadius(int value)
```

Gets or sets vertical corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfTextStickerAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/pdftextstickerappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class PdfTextStickerAppearance extends SignatureAppearance
```

Describes appearance of PDF text annotation sticker object and pop-up window of sticker.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextStickerAppearance() | Creates PDF signature text annotation appearance object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets or sets title of pop-up window.
 |
| setTitle(String value) | Gets or sets title of pop-up window.
 |
| getSubject() | Gets or sets subject.
 |
| setSubject(String value) | Gets or sets subject.
 |
| getContents() | Gets or sets the contents of pop-up window.
 |
| setContents(String value) | Gets or sets the contents of pop-up window.
 |
| getOpened() | Setup if sticker pop-up window will be opened by default.
 |
| setOpened(boolean value) | Setup if sticker pop-up window will be opened by default.
 |
| getIcon() | Gets or sets the icon of sticker.
 |
| setIcon(int value) | Gets or sets the icon of sticker.
 |
| getDefaultAppearance() | Gets default appearance for sticker.
 |
| resetDefaultAppearance() | Clears values of default appearance for sticker.
 |
| toString() | Override string conversion.
 |
##### PdfTextStickerAppearance()
```
public PdfTextStickerAppearance()
```

Creates PDF signature text annotation appearance object.

##### getTitle()
```
public final String getTitle()
```

Gets or sets title of pop-up window.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets title of pop-up window.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Gets or sets subject.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Gets or sets subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Gets or sets the contents of pop-up window.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Gets or sets the contents of pop-up window.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOpened()
```
public final boolean getOpened()
```

Setup if sticker pop-up window will be opened by default.

**Returns:**
boolean
##### setOpened(boolean value)
```
public final void setOpened(boolean value)
```

Setup if sticker pop-up window will be opened by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getIcon()
```
public final int getIcon()
```

Gets or sets the icon of sticker.

**Returns:**
int
##### setIcon(int value)
```
public final void setIcon(int value)
```

Gets or sets the icon of sticker.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDefaultAppearance()
```
public static PdfTextStickerAppearance getDefaultAppearance()
```

Gets default appearance for sticker. These properties are applied as default if
Options.SignatureAppearance property is not specified.
The properties could be changed by user any time.

**Returns:**
PdfTextStickerAppearance
##### resetDefaultAppearance()
```
public static void resetDefaultAppearance()
```

Clears values of default appearance for sticker.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### SignatureAppearance
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.appearances/signatureappearance.md

**Inheritance:**
java.lang.Object
```
public abstract class SignatureAppearance
```

Represents the signature appearance - additional options for alternative implementations of sign on document page.

#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureAppearance() | Initializes a new instance of the SignatureAppearance class.
 |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Override string conversion.
 |
##### SignatureAppearance()
```
public SignatureAppearance()
```

Initializes a new instance of the SignatureAppearance class.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.loadoptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.loadoptions.md

The **GroupDocs.Signature.Options.LoadOptions** namespace provides classes for working with LoadOptions options.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows to specify additional options (such as password) when opening a document to sign. |

### LoadOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.loadoptions/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows to specify additional options (such as password) when opening a document to sign.

#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of LoadOptions class.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets or sets password to open a protected document.
 |
| setPassword(String value) | Gets or sets password to open a protected document.
 |
| getLoadExternalResources() | Gets or sets options that specifies if external document resources should be loaded.
 |
| setLoadExternalResources(boolean value) | Gets or sets options that specifies if external document resources should be loaded.
 |
| getPermissions() | The PDF document permissions such as printing, modification and data extraction.
 |
| setPermissions(Integer value) | Internal setter, used by document load processors to record permissions parsed from the file.
 |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of LoadOptions class.

##### getPassword()
```
public final String getPassword()
```

Gets or sets password to open a protected document.
It will be also used to save signed document as protected.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets password to open a protected document.
It will be also used to save signed document as protected.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLoadExternalResources()
```
public final boolean getLoadExternalResources()
```

Gets or sets options that specifies if external document resources should be loaded.
This option with disabled value (false) allows to save loading time for the documents with many or large external resource links.
By default value is enabled (true).

**Returns:**
boolean
##### setLoadExternalResources(boolean value)
```
public final void setLoadExternalResources(boolean value)
```

Gets or sets options that specifies if external document resources should be loaded.
This option with disabled value (false) allows to save loading time for the documents with many or large external resource links.
By default value is enabled (true).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPermissions()
```
public final Integer getPermissions()
```

The PDF document permissions such as printing, modification and data extraction.
Only for PDF documents. Read-only \\u2014 populated automatically while loading the document.
The value is a flags combination from Permissions.

**Returns:**
java.lang.Integer
##### setPermissions(Integer value)
```
public final void setPermissions(Integer value)
```

Internal setter, used by document load processors to record permissions parsed from the file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

### com.groupdocs.signature.options.preview
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.preview.md

#### Classes

| Class | Description |
| --- | --- |
| PreviewFormats | Document preview supported formats |
| PreviewOptions | Represents document preview options. |
| PreviewPageData | Contains data about document page to be saved as preview image. |

### PreviewFormats
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.preview/previewformats.md

**Inheritance:**
java.lang.Object
```
public class PreviewFormats
```

Document preview supported formats

#### Fields

| Field | Description |
| --- | --- |
| PNG | PNG
 |
| JPEG | JPEG
 |
| BMP | BMP
 |
#### Methods

| Method | Description |
| --- | --- |
| toExtension(int id) | To extension string.
 |
##### PNG
```
public static final int PNG
```

PNG

##### JPEG
```
public static final int JPEG
```

JPEG

##### BMP
```
public static final int BMP
```

BMP

##### toExtension(int id)
```
public static String toExtension(int id)
```

To extension string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int |  |

**Returns:**
java.lang.String - the string

### PreviewOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.preview/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Represents document preview options.

#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers) | Initializes PreviewOptions object.
 |
| PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers) | Initializes PreviewOptions object.
 |
| PreviewOptions(String filePathFormat, int[] pageNumbers) | Initializes PreviewOptions object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets or sets preview images width.
 |
| setWidth(int value) | Gets or sets preview images width.
 |
| getHeight() | Gets or sets preview images height.
 |
| setHeight(int value) | Gets or sets preview images height.
 |
| getPageNumbers() | Gets or sets preview images page numbers.
 |
| setPageNumbers(int[] value) | Gets or sets preview images page numbers.
 |
| getPreviewFormat() | Gets or sets preview images format.
 |
| setPreviewFormat(int value) | Gets or sets preview images format.
 |
| getHideSignatures() | Gets or sets flag to hide signatures from page preview image.
 |
| setHideSignatures(boolean value) | Gets or sets flag to hide signatures from page preview image.
 |
| getResolution() | Gets the resolution of the preview images in DPI (dots per inch).
 |
| setResolution(int value) | Sets the resolution of the preview images in DPI (dots per inch).
 |
##### PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | Interface which defines method to create output page preview stream.
 |
| pageNumbers | int[] | Desired page numbers
 |

##### PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)
```
public PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageDataStreamFactory | PageDataStreamFactory | Interface which defines method to create output page preview stream.
 |
| pageNumbers | int[] |  |

##### PreviewOptions(String filePathFormat, int[] pageNumbers)
```
public PreviewOptions(String filePathFormat, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | Path to output file.
 |
| pageNumbers | int[] | Desired page numbers
 |

##### getWidth()
```
public final int getWidth()
```

Gets or sets preview images width.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Gets or sets preview images width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Gets or sets preview images height.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Gets or sets preview images height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets or sets preview images page numbers.

**Returns:**
int[]
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Gets or sets preview images page numbers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] |  |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Gets or sets preview images format.

**Returns:**
int
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Gets or sets preview images format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHideSignatures()
```
public final boolean getHideSignatures()
```

Gets or sets flag to hide signatures from page preview image.
Only signatures are marked as IsSignature will be hidden from generated document page image.

**Returns:**
boolean
##### setHideSignatures(boolean value)
```
public final void setHideSignatures(boolean value)
```

Gets or sets flag to hide signatures from page preview image.
Only signatures are marked as IsSignature will be hidden from generated document page image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getResolution()
```
public final int getResolution()
```

Gets the resolution of the preview images in DPI (dots per inch).

**Returns:**
int
##### setResolution(int value)
```
public final void setResolution(int value)
```

Sets the resolution of the preview images in DPI (dots per inch).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### PreviewPageData
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.preview/previewpagedata.md

**Inheritance:**
java.lang.Object
```
public final class PreviewPageData
```

Contains data about document page to be saved as preview image.

#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewPageData() | Creates PreviewPageData with default parameters.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Name of a file which is being processed in order to get page previews.
 |
| getPageNumber() | Document page number of current preview.
 |
| getPreviewFormat() | Selected preview format.
 |
| toString() | Textual representation of PreviewPageData instance.
 |
##### PreviewPageData()
```
public PreviewPageData()
```

Creates PreviewPageData with default parameters.

##### getFileName()
```
public final String getFileName()
```

Name of a file which is being processed in order to get page previews.

**Returns:**
java.lang.String
##### getPageNumber()
```
public final int getPageNumber()
```

Document page number of current preview.

**Returns:**
int
##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Selected preview format.

**Returns:**
int
##### toString()
```
public String toString()
```

Textual representation of PreviewPageData instance.

**Returns:**
java.lang.String - Returns textual representation of PreviewPageData instance.

### com.groupdocs.signature.options.saveoptions.imagessaveoptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions.md

The **GroupDocs.Signature.Options.SaveOptions.ImageSaveOptions** namespace provides classes for working with ImageSaveOptions options.

#### Classes

| Class | Description |
| --- | --- |
| BitmapCompression | Specifies different bitmap compression methods. |
| BmpSaveOptions | Bmp Save options for image documents. |
| DicomSaveOptions | Save options for DICOM image documents. |
| DicomXmpEntry | Entry of XMP data for DICOM images (.dcm). |
| DicomXmpType | Supported types of XMP data for DICOM images (.dcm). |
| GifSaveOptions | Gif format save options for Image Documents. |
| JpegCompressionColorMode | Specifies JPEG color compression modes. |
| JpegCompressionMode | Specifies JPEG compression modes. |
| JpegRoundingMode | Specifies different JPEG rounding modes. |
| JpegSaveOptions | Jpeg Save options for Image Documents. |
| PngColorType | Represents the PNG image color type. |
| PngFilterType | Represents PNG image filter type. |
| PngSaveOptions | Png Save options for Image Documents. |
| TiffFormat | Specifies different tiff formats. |
| TiffSaveOptions | Tiff Save options for Image Documents. |

### BitmapCompression
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/bitmapcompression.md

**Inheritance:**
java.lang.Object
```
public final class BitmapCompression
```

Specifies different bitmap compression methods.

#### Fields

| Field | Description |
| --- | --- |
| Rgb | No compression.
 |
| Rle8 | RLE 8-bit/pixel compression.
 |
| Rle4 | RLE 4-bit/pixel compression.
 |
| Bitfields | Bit fields.
 |
| Jpeg | JPEG compression.
 |
| Png | PNG compression.
 |
##### Rgb
```
public static final int Rgb
```

No compression.

##### Rle8
```
public static final int Rle8
```

RLE 8-bit/pixel compression. Can be used only with 8-bit/pixel bitmaps.

##### Rle4
```
public static final int Rle4
```

RLE 4-bit/pixel compression. Can be used only with 4-bit/pixel bitmaps.

##### Bitfields
```
public static final int Bitfields
```

Bit fields. Can be used only with 16 and 32-bit/pixel bitmaps.

##### Jpeg
```
public static final int Jpeg
```

JPEG compression. The bitmap contains a JPEG image.

##### Png
```
public static final int Png
```

PNG compression. The bitmap contains a PNG image.

### BmpSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/bmpsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public final class BmpSaveOptions extends ImageSaveOptions
```

Bmp Save options for image documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| BmpSaveOptions() | Creates BmpSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets or sets the image bits per pixel count.
 |
| setBitsPerPixel(int value) | Gets or sets the image bits per pixel count.
 |
| getCompression() | Gets or sets the compression.
 |
| setCompression(int value) | Gets or sets the compression.
 |
| getHorizontalResolution() | Gets or sets the horizontal resolution.
 |
| setHorizontalResolution(double value) | Gets or sets the horizontal resolution.
 |
| getVerticalResolution() | Gets or sets the vertical resolution.
 |
| setVerticalResolution(double value) | Gets or sets the vertical resolution.
 |
##### BmpSaveOptions()
```
public BmpSaveOptions()
```

Creates BmpSaveOptions with default values.

##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets or sets the image bits per pixel count.

**Returns:**
int
##### setBitsPerPixel(int value)
```
public final void setBitsPerPixel(int value)
```

Gets or sets the image bits per pixel count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCompression()
```
public final int getCompression()
```

Gets or sets the compression. See BitmapCompression.

**Returns:**
int
##### setCompression(int value)
```
public final void setCompression(int value)
```

Gets or sets the compression. See BitmapCompression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalResolution()
```
public final double getHorizontalResolution()
```

Gets or sets the horizontal resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.

**Returns:**
double
##### setHorizontalResolution(double value)
```
public final void setHorizontalResolution(double value)
```

Gets or sets the horizontal resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getVerticalResolution()
```
public final double getVerticalResolution()
```

Gets or sets the vertical resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.

**Returns:**
double
##### setVerticalResolution(double value)
```
public final void setVerticalResolution(double value)
```

Gets or sets the vertical resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

### DicomSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public final class DicomSaveOptions extends ImageSaveOptions
```

Save options for DICOM image documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| DicomSaveOptions() | Creates DicomSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getXmpEntries() | XMP data for DICOM.
 |
| setXmpEntries(List<DicomXmpEntry> value) | XMP data for DICOM.
 |
##### DicomSaveOptions()
```
public DicomSaveOptions()
```

Creates DicomSaveOptions with default values.

##### getXmpEntries()
```
public final List<DicomXmpEntry> getXmpEntries()
```

XMP data for DICOM. Use it for setting image metadata.

**Returns:**
java.util.List<com.groupdocs.signature.options.saveoptions.imagessaveoptions.DicomXmpEntry>
##### setXmpEntries(List<DicomXmpEntry> value)
```
public final void setXmpEntries(List<DicomXmpEntry> value)
```

XMP data for DICOM. Use it for setting image metadata.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.options.saveoptions.imagessaveoptions.DicomXmpEntry> |  |

### DicomXmpEntry
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomxmpentry.md

**Inheritance:**
java.lang.Object
```
public final class DicomXmpEntry
```

Entry of XMP data for DICOM images (.dcm).

#### Constructors

| Constructor | Description |
| --- | --- |
| DicomXmpEntry(int type, String value) | Creates Xmp entry for DICOM image.
 |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Entry type.
 |
| getValue() | Entry value.
 |
| toString() | Get Xmp entry textual representation.
 |
##### DicomXmpEntry(int type, String value)
```
public DicomXmpEntry(int type, String value)
```

Creates Xmp entry for DICOM image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | int | Entry type
 |
| value | java.lang.String | Entry value
 |

##### getType()
```
public final int getType()
```

Entry type.

**Returns:**
int
##### getValue()
```
public final String getValue()
```

Entry value.

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Get Xmp entry textual representation.

**Returns:**
java.lang.String - Xmp entry textual representation.

### DicomXmpType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomxmptype.md

**Inheritance:**
java.lang.Object
```
public final class DicomXmpType
```

Supported types of XMP data for DICOM images (.dcm).

#### Fields

| Field | Description |
| --- | --- |
| EquipmentInstitution | Institution of equipment.
 |
| EquipmentManufacturer | Manufacturer of equipment.
 |
| PatientBirthDate | Patient's birthday.
 |
| PatientId | Patient's Id.
 |
| PatientName | Patient's name.
 |
| PatientSex | Patient's sex.
 |
| SeriesDateTime | Series date and time.
 |
| SeriesDescription | Series description.
 |
| SeriesModality | Series modality.
 |
| SeriesNumber | Series number.
 |
| StudyDateTime | Study date and time.
 |
| StudyDescription | Study description.
 |
| StudyId | Study Id.
 |
| StudyPhysician | Study physician.
 |
##### EquipmentInstitution
```
public static final int EquipmentInstitution
```

Institution of equipment.

##### EquipmentManufacturer
```
public static final int EquipmentManufacturer
```

Manufacturer of equipment.

##### PatientBirthDate
```
public static final int PatientBirthDate
```

Patient's birthday.

##### PatientId
```
public static final int PatientId
```

Patient's Id.

##### PatientName
```
public static final int PatientName
```

Patient's name.

##### PatientSex
```
public static final int PatientSex
```

Patient's sex.

##### SeriesDateTime
```
public static final int SeriesDateTime
```

Series date and time.

##### SeriesDescription
```
public static final int SeriesDescription
```

Series description.

##### SeriesModality
```
public static final int SeriesModality
```

Series modality.

##### SeriesNumber
```
public static final int SeriesNumber
```

Series number.

##### StudyDateTime
```
public static final int StudyDateTime
```

Study date and time.

##### StudyDescription
```
public static final int StudyDescription
```

Study description.

##### StudyId
```
public static final int StudyId
```

Study Id.

##### StudyPhysician
```
public static final int StudyPhysician
```

Study physician.

### GifSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/gifsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class GifSaveOptions extends ImageSaveOptions
```

Gif format save options for Image Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| GifSaveOptions() | Creates GifSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getBackgroundColorIndex() | Gets or sets the GIF background color index.
 |
| setBackgroundColorIndex(byte value) | Gets or sets the GIF background color index.
 |
| getColorResolution() | Gets or sets the GIF color resolution.
 |
| setColorResolution(byte value) | Gets or sets the GIF color resolution.
 |
| getDoPaletteCorrection() | Gets or sets a value indicating whether palette correction is applied.
 |
| setDoPaletteCorrection(boolean value) | Gets or sets a value indicating whether palette correction is applied.
 |
| hasTrailer() | Gets or sets a value indicating whether GIF has trailer.
 |
| setTrailer(boolean value) | Gets or sets a value indicating whether GIF has trailer.
 |
| getInterlaced() | True if image should be interlaced.
 |
| setInterlaced(boolean value) | True if image should be interlaced.
 |
| isPaletteSorted() | Gets or sets a value indicating whether palette entries are sorted.
 |
| setPaletteSorted(boolean value) | Gets or sets a value indicating whether palette entries are sorted.
 |
| getPixelAspectRatio() | Gets or sets the GIF pixel aspect ratio.
 |
| setPixelAspectRatio(byte value) | Gets or sets the GIF pixel aspect ratio.
 |
##### GifSaveOptions()
```
public GifSaveOptions()
```

Creates GifSaveOptions with default values.

##### getBackgroundColorIndex()
```
public byte getBackgroundColorIndex()
```

Gets or sets the GIF background color index.

**Returns:**
byte
##### setBackgroundColorIndex(byte value)
```
public void setBackgroundColorIndex(byte value)
```

Gets or sets the GIF background color index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorResolution()
```
public byte getColorResolution()
```

Gets or sets the GIF color resolution.

<br />

*** ** * ** ***

Color Resolution - Number of bits per primary color available to the original image, minus 1. This value represents the size of the entire palette from which the colors in the graphic were selected, not the number of colors actually used in the graphic. For example, if the value in this field is 3, then the palette of the original image had 4 bits per primary color available to create the image. This value should be set to indicate the richness of the original palette, even if not every color from the whole palette is available on the source machine.

<br />

**Returns:**
byte
##### setColorResolution(byte value)
```
public void setColorResolution(byte value)
```

Gets or sets the GIF color resolution.

<br />

*** ** * ** ***

Color Resolution - Number of bits per primary color available to the original image, minus 1. This value represents the size of the entire palette from which the colors in the graphic were selected, not the number of colors actually used in the graphic. For example, if the value in this field is 3, then the palette of the original image had 4 bits per primary color available to create the image. This value should be set to indicate the richness of the original palette, even if not every color from the whole palette is available on the source machine.

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getDoPaletteCorrection()
```
public boolean getDoPaletteCorrection()
```

Gets or sets a value indicating whether palette correction is applied.

<br />

*** ** * ** ***

Palette correction means that whenever image is exported to GIF the source image colors will be analyzed in order to build the best matching palette (in case image Palette does not exist or not specified in the options). The analyze process takes some time however the output image will have the best matching color palette and result is visually better.

<br />

**Returns:**
boolean
##### setDoPaletteCorrection(boolean value)
```
public void setDoPaletteCorrection(boolean value)
```

Gets or sets a value indicating whether palette correction is applied.

<br />

*** ** * ** ***

Palette correction means that whenever image is exported to GIF the source image colors will be analyzed in order to build the best matching palette (in case image Palette does not exist or not specified in the options). The analyze process takes some time however the output image will have the best matching color palette and result is visually better.

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### hasTrailer()
```
public boolean hasTrailer()
```

Gets or sets a value indicating whether GIF has trailer.

**Returns:**
boolean
##### setTrailer(boolean value)
```
public void setTrailer(boolean value)
```

Gets or sets a value indicating whether GIF has trailer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getInterlaced()
```
public boolean getInterlaced()
```

True if image should be interlaced.

**Returns:**
boolean
##### setInterlaced(boolean value)
```
public void setInterlaced(boolean value)
```

True if image should be interlaced.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isPaletteSorted()
```
public boolean isPaletteSorted()
```

Gets or sets a value indicating whether palette entries are sorted.

**Returns:**
boolean
##### setPaletteSorted(boolean value)
```
public void setPaletteSorted(boolean value)
```

Gets or sets a value indicating whether palette entries are sorted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPixelAspectRatio()
```
public byte getPixelAspectRatio()
```

Gets or sets the GIF pixel aspect ratio.

<br />

*** ** * ** ***

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect ratio of the pixel in the original image. If the value of the field is not 0, this approximation of the aspect ratio is computed based on the formula: Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined to be the quotient of the pixel's width over its height. The value range in this field allows specification of the widest pixel of 4:1 to the tallest pixel of 1:4 in increments of 1/64th. Values : 0 - No aspect ratio information is given. 1..255 - Value used in the computation.

<br />

**Returns:**
byte
##### setPixelAspectRatio(byte value)
```
public void setPixelAspectRatio(byte value)
```

Gets or sets the GIF pixel aspect ratio.

<br />

*** ** * ** ***

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect ratio of the pixel in the original image. If the value of the field is not 0, this approximation of the aspect ratio is computed based on the formula: Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined to be the quotient of the pixel's width over its height. The value range in this field allows specification of the widest pixel of 4:1 to the tallest pixel of 1:4 in increments of 1/64th. Values : 0 - No aspect ratio information is given. 1..255 - Value used in the computation.

<br />

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

### JpegCompressionColorMode
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegcompressioncolormode.md

**Inheritance:**
java.lang.Object
```
public final class JpegCompressionColorMode
```

Specifies JPEG color compression modes.

#### Fields

| Field | Description |
| --- | --- |
| Grayscale | The Grayscale image.
 |
| YCbCr | YCbCr image, standard option for jpeg images.
 |
| Cmyk | 4-component CMYK image.
 |
| Ycck | The ycck color jpeg image.
 |
| Rgb | The RGB Color mode.
 |
##### Grayscale
```
public static final int Grayscale
```

The Grayscale image.

##### YCbCr
```
public static final int YCbCr
```

YCbCr image, standard option for jpeg images.

##### Cmyk
```
public static final int Cmyk
```

4-component CMYK image.

##### Ycck
```
public static final int Ycck
```

The ycck color jpeg image. Needs icc profile for saving.

##### Rgb
```
public static final int Rgb
```

The RGB Color mode.

### JpegCompressionMode
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegcompressionmode.md

**Inheritance:**
java.lang.Object
```
public final class JpegCompressionMode
```

Specifies JPEG compression modes.

#### Fields

| Field | Description |
| --- | --- |
| Baseline | The baseline compression.
 |
| Progressive | The progressive compression.
 |
| Lossless | The lossless compression.
 |
| JpegLs | The JPEG-LS compression.
 |
##### Baseline
```
public static final int Baseline
```

The baseline compression.

##### Progressive
```
public static final int Progressive
```

The progressive compression.

##### Lossless
```
public static final int Lossless
```

The lossless compression. Use this compression type carefully because
many image viewers do not support it. If you use it try assign the

JpegSaveOptions.ColorType
(JpegSaveOptions.getColorType/JpegSaveOptions.setColorType(int)) property to JpegCompressionColorMode.Grayscale
or JpegCompressionColorMode.Rgb values.

##### JpegLs
```
public static final int JpegLs
```

The JPEG-LS compression. Use this compression type carefully because
many image viewers do not support it. If you use it try to assign the

JpegSaveOptions.ColorType
(JpegSaveOptions.getColorType/JpegSaveOptions.setColorType(int)) property to JpegCompressionColorMode.Grayscale
value.

### JpegRoundingMode
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegroundingmode.md

**Inheritance:**
java.lang.Object
```
public final class JpegRoundingMode
```

Specifies different JPEG rounding modes.

#### Fields

| Field | Description |
| --- | --- |
| Extrapolate | Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8.
 |
| Truncate | Truncate an 8-bit value to fit it into n bits, where n more than 1 and less 8.
 |
##### Extrapolate
```
public static final int Extrapolate
```

Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8.

##### Truncate
```
public static final int Truncate
```

Truncate an 8-bit value to fit it into n bits, where n more than 1 and less 8.

### JpegSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class JpegSaveOptions extends ImageSaveOptions
```

Jpeg Save options for Image Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| JpegSaveOptions() | Creates JpegSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerChannel() | Gets or sets bits per channel for lossless jpeg image.
 |
| setBitsPerChannel(byte value) | Gets or sets bits per channel for lossless jpeg image.
 |
| getColorType() | Gets or sets the color type for jpeg image.
 |
| setColorType(int value) | Gets or sets the color type for jpeg image.
 |
| getComment() | Gets or sets the jpeg file comment.
 |
| setComment(String value) | Gets or sets the jpeg file comment.
 |
| getCompressionType() | Gets or sets the compression type.
 |
| setCompressionType(int value) | Gets or sets the compression type.
 |
| getQuality() | Gets or sets image quality.
 |
| setQuality(int value) | Gets or sets image quality.
 |
| getSampleRoundingMode() | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
JpegOptions.BitsPerChannel.
 |
| setSampleRoundingMode(int value) | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
JpegOptions.BitsPerChannel.
 |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
##### JpegSaveOptions()
```
public JpegSaveOptions()
```

Creates JpegSaveOptions with default values.

##### getBitsPerChannel()
```
public byte getBitsPerChannel()
```

Gets or sets bits per channel for lossless jpeg image.
Now we support from 2 to 8 bits per channel.

**Returns:**
byte
##### setBitsPerChannel(byte value)
```
public void setBitsPerChannel(byte value)
```

Gets or sets bits per channel for lossless jpeg image.
Now we support from 2 to 8 bits per channel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorType()
```
public int getColorType()
```

Gets or sets the color type for jpeg image.

**Returns:**
int
##### setColorType(int value)
```
public void setColorType(int value)
```

Gets or sets the color type for jpeg image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getComment()
```
public String getComment()
```

Gets or sets the jpeg file comment.

**Returns:**
java.lang.String
##### setComment(String value)
```
public void setComment(String value)
```

Gets or sets the jpeg file comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCompressionType()
```
public int getCompressionType()
```

Gets or sets the compression type.

**Returns:**
int
##### setCompressionType(int value)
```
public void setCompressionType(int value)
```

Gets or sets the compression type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getQuality()
```
public int getQuality()
```

Gets or sets image quality.

**Returns:**
int
##### setQuality(int value)
```
public void setQuality(int value)
```

Gets or sets image quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSampleRoundingMode()
```
public int getSampleRoundingMode()
```

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
JpegOptions.BitsPerChannel.

**Returns:**
int
##### setSampleRoundingMode(int value)
```
public void setSampleRoundingMode(int value)
```

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
JpegOptions.BitsPerChannel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### PngColorType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngcolortype.md

**Inheritance:**
java.lang.Object
```
public final class PngColorType
```

Represents the PNG image color type.

#### Fields

| Field | Description |
| --- | --- |
| Grayscale | Represents the color type where each pixel is a grayscale sample.
 |
| Truecolor | Represents the color type where each pixel is an R,G,B triple.
 |
| IndexedColor | Represents the color type where each pixel is a palette index; a PLTE chunk
shall appear.
 |
| GrayscaleWithAlpha | Represents the color type where each pixel is a grayscale sample followed
by an alpha sample.
 |
| TruecolorWithAlpha | Represents the color type where each pixel is an R,G,B triple followed by
an alpha sample.
 |
##### Grayscale
```
public static final int Grayscale
```

Represents the color type where each pixel is a grayscale sample.

##### Truecolor
```
public static final int Truecolor
```

Represents the color type where each pixel is an R,G,B triple.

##### IndexedColor
```
public static final int IndexedColor
```

Represents the color type where each pixel is a palette index; a PLTE chunk
shall appear.

##### GrayscaleWithAlpha
```
public static final int GrayscaleWithAlpha
```

Represents the color type where each pixel is a grayscale sample followed
by an alpha sample.

##### TruecolorWithAlpha
```
public static final int TruecolorWithAlpha
```

Represents the color type where each pixel is an R,G,B triple followed by
an alpha sample.

### PngFilterType
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngfiltertype.md

**Inheritance:**
java.lang.Object
```
public final class PngFilterType
```

Represents PNG image filter type.

#### Fields

| Field | Description |
| --- | --- |
| None | The null-filter, means no filtering for image data rows.
 |
| Sub | The sub filter, means subtractive filtering will be applied to image data.
 |
| Up | The up filter, means row-by-row subtraction filter will be applied.
 |
| Avg | The avg filter, means, that average filter will be applied to image data.
 |
| Paeth | The path predictor filter.
 |
| Adaptive | Adaptive filtering, means that saving process will choose most suitable filter
for each data row.
 |
##### None
```
public static final int None
```

The null-filter, means no filtering for image data rows.

##### Sub
```
public static final int Sub
```

The sub filter, means subtractive filtering will be applied to image data.

##### Up
```
public static final int Up
```

The up filter, means row-by-row subtraction filter will be applied.

##### Avg
```
public static final int Avg
```

The avg filter, means, that average filter will be applied to image data.

##### Paeth
```
public static final int Paeth
```

The path predictor filter.

##### Adaptive
```
public static final int Adaptive
```

Adaptive filtering, means that saving process will choose most suitable filter
for each data row. Best compression, slowest execution time.

### PngSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class PngSaveOptions extends ImageSaveOptions
```

Png Save options for Image Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PngSaveOptions() | Creates PngSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getBitDepth() | The bit depth.
 |
| setBitDepth(byte value) | The bit depth.
 |
| getColorType() | Gets or sets the type of the
PngColorType
.
 |
| setColorType(int value) | Gets or sets the type of the
PngColorType
.
 |
| getCompressionLevel() | The png image compression level in the 0-9 range, where 9 is maximum compression
and 0 is store mode.
 |
| setCompressionLevel(int value) | The png image compression level in the 0-9 range, where 9 is maximum compression
and 0 is store mode.
 |
| getFilterType() | Gets or sets the filter type
PngFilterType
 used during png file save process.
 |
| setFilterType(int value) | Gets or sets the filter type
PngFilterType
 used during png file save process.
 |
| getProgressive() | Gets or sets a value indicating whether this PngSaveOptions is progressive.
 |
| setProgressive(boolean value) | Gets or sets a value indicating whether this PngSaveOptions is progressive.
 |
##### PngSaveOptions()
```
public PngSaveOptions()
```

Creates PngSaveOptions with default values.

##### getBitDepth()
```
public byte getBitDepth()
```

The bit depth.

**Returns:**
byte
##### setBitDepth(byte value)
```
public void setBitDepth(byte value)
```

The bit depth.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorType()
```
public int getColorType()
```

Gets or sets the type of the
PngColorType
.

**Returns:**
int
##### setColorType(int value)
```
public void setColorType(int value)
```

Gets or sets the type of the
PngColorType
.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCompressionLevel()
```
public int getCompressionLevel()
```

The png image compression level in the 0-9 range, where 9 is maximum compression
and 0 is store mode.

**Returns:**
int
##### setCompressionLevel(int value)
```
public void setCompressionLevel(int value)
```

The png image compression level in the 0-9 range, where 9 is maximum compression
and 0 is store mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFilterType()
```
public int getFilterType()
```

Gets or sets the filter type
PngFilterType
 used during png file save process.

**Returns:**
int
##### setFilterType(int value)
```
public void setFilterType(int value)
```

Gets or sets the filter type
PngFilterType
 used during png file save process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getProgressive()
```
public boolean getProgressive()
```

Gets or sets a value indicating whether this PngSaveOptions is progressive.

**Returns:**
boolean
##### setProgressive(boolean value)
```
public void setProgressive(boolean value)
```

Gets or sets a value indicating whether this PngSaveOptions is progressive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### TiffFormat
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/tiffformat.md

**Inheritance:**
java.lang.Object
```
public final class TiffFormat
```

Specifies different tiff formats.

#### Fields

| Field | Description |
| --- | --- |
| Default | Default.
 |
| TiffLzwBw | LzwBw.
 |
| TiffLzwRgb | LzwRgb.
 |
| TiffLzwRgba | LzwRgba.
 |
| TiffCcittFax3 | CcittFax3.
 |
| TiffCcittFax4 | CcittFax4.
 |
| TiffDeflateBw | DeflateBw.
 |
| TiffDeflateRgb | DeflateRgb.
 |
| TiffCcitRle | CcitRle.
 |
| TiffJpegRgb | JpegRgb.
 |
| TiffJpegYCbCr | JpegYCbCr.
 |
| TiffNoCompressionBw | NoCompressionBw.
 |
| TiffNoCompressionRgb | NoCompressionRgb.
 |
| TiffNoCompressionRgba | NoCompressionRgba.
 |
##### Default
```
public static final int Default
```

Default.

##### TiffLzwBw
```
public static final int TiffLzwBw
```

LzwBw.

##### TiffLzwRgb
```
public static final int TiffLzwRgb
```

LzwRgb.

##### TiffLzwRgba
```
public static final int TiffLzwRgba
```

LzwRgba.

##### TiffCcittFax3
```
public static final int TiffCcittFax3
```

CcittFax3.

##### TiffCcittFax4
```
public static final int TiffCcittFax4
```

CcittFax4.

##### TiffDeflateBw
```
public static final int TiffDeflateBw
```

DeflateBw.

##### TiffDeflateRgb
```
public static final int TiffDeflateRgb
```

DeflateRgb.

##### TiffCcitRle
```
public static final int TiffCcitRle
```

CcitRle.

##### TiffJpegRgb
```
public static final int TiffJpegRgb
```

JpegRgb.

##### TiffJpegYCbCr
```
public static final int TiffJpegYCbCr
```

JpegYCbCr.

##### TiffNoCompressionBw
```
public static final int TiffNoCompressionBw
```

NoCompressionBw.

##### TiffNoCompressionRgb
```
public static final int TiffNoCompressionRgb
```

NoCompressionRgb.

##### TiffNoCompressionRgba
```
public static final int TiffNoCompressionRgba
```

NoCompressionRgba.

### TiffSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/tiffsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class TiffSaveOptions extends ImageSaveOptions
```

Tiff Save options for Image Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSaveOptions() | Creates TiffSaveOptions with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getExpectedTiffFormat() | Gets or sets TIFF format of signed document.
 |
| setExpectedTiffFormat(int value) | Gets or sets TIFF format of signed document.
 |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
##### TiffSaveOptions()
```
public TiffSaveOptions()
```

Creates TiffSaveOptions with default values.

##### getExpectedTiffFormat()
```
public int getExpectedTiffFormat()
```

Gets or sets TIFF format of signed document.

**Returns:**
int
##### setExpectedTiffFormat(int value)
```
public void setExpectedTiffFormat(int value)
```

Gets or sets TIFF format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.signature.options.saveoptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions.md

The **GroupDocs.Signature.Options.SaveOptions** namespace provides classes for working with SaveOptions options.

#### Classes

| Class | Description |
| --- | --- |
| ExportImageSaveOptions | Save options for exporting documents to image. |
| PdfSaveOptions | Save options for PDF documents. |
| PresentationSaveOptions | Save options for Presentation documents. |
| SaveOptions | Allows to specify additional options (such as password) when saving a document to sign. |
| SpreadsheetSaveOptions | Save options for Spreadsheet Documents. |
| WordProcessingSaveOptions | Save options for WordProcessing documents. |

### ExportImageSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/exportimagesaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class ExportImageSaveOptions extends ImageSaveOptions
```

Save options for exporting documents to image.

#### Constructors

| Constructor | Description |
| --- | --- |
| ExportImageSaveOptions() | Initializes a new instance of ExportAsImageSaveOptions class with default values.
 |
| ExportImageSaveOptions(int fileFormat) | Initializes a new instance of ExportAsImageSaveOptions class with specified file format.
 |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets document page number for export.
 |
| setPageNumber(Integer value) | Gets or sets document page number for export.
 |
| getExportAllPages() | Flag to export each page.
 |
| setExportAllPages(boolean value) | Flag to export each page.
 |
| getPagesSetup() | Options to specify pages to be signed.
 |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed.
 |
| getPageColumns() | Gets or sets number of columns for exported images.
 |
| setPageColumns(int value) | Gets or sets number of columns for exported images.
 |
| getBorder() | Gets or sets the image border settings.
 |
| setBorder(Border value) | Gets or sets the image border settings.
 |
| getTiffMultipage() | Put document pages on different frames in Tiff image.
 |
| setTiffMultipage(boolean value) | Put document pages on different frames in Tiff image.
 |
| toString() | Override string conversion.
 |
##### ExportImageSaveOptions()
```
public ExportImageSaveOptions()
```

Initializes a new instance of ExportAsImageSaveOptions class with default values.

##### ExportImageSaveOptions(int fileFormat)
```
public ExportImageSaveOptions(int fileFormat)
```

Initializes a new instance of ExportAsImageSaveOptions class with specified file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output image file format.
 |

##### getPageNumber()
```
public final Integer getPageNumber()
```

Gets or sets document page number for export.
Minimal value is 1.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Gets or sets document page number for export.
Minimal value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getExportAllPages()
```
public final boolean getExportAllPages()
```

Flag to export each page.

**Returns:**
boolean
##### setExportAllPages(boolean value)
```
public final void setExportAllPages(boolean value)
```

Flag to export each page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPagesSetup()
```
public final PagesSetup getPagesSetup()
```

Options to specify pages to be signed.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public final void setPagesSetup(PagesSetup value)
```

Options to specify pages to be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getPageColumns()
```
public final int getPageColumns()
```

Gets or sets number of columns for exported images.
Use this property if you need put images in a row.

**Returns:**
int
##### setPageColumns(int value)
```
public final void setPageColumns(int value)
```

Gets or sets number of columns for exported images.
Use this property if you need put images in a row.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorder()
```
public final Border getBorder()
```

Gets or sets the image border settings. By default this value is not set.

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Gets or sets the image border settings. By default this value is not set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getTiffMultipage()
```
public final boolean getTiffMultipage()
```

Put document pages on different frames in Tiff image.

**Returns:**
boolean
##### setTiffMultipage(boolean value)
```
public final void setTiffMultipage(boolean value)
```

Put document pages on different frames in Tiff image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/pdfsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class PdfSaveOptions extends SaveOptions
```

Save options for PDF documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of PdfSaveOptions class with default values.
 |
| PdfSaveOptions(int fileFormat) | Initializes a new instance of PdfSaveOptions class with specified output file format.
 |
| PdfSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with overwrite flag.
 |
| PdfSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
| getPermissionsPassword() | A permissions password (the primary password) requires a password to change permission settings.
 |
| setPermissionsPassword(String value) | A permissions password (the primary password) requires a password to change permission settings.
 |
| getPermissions() | The PDF document permissions such as printing, modification and data extraction.
 |
| setPermissions(Integer value) | The PDF document permissions such as printing, modification and data extraction.
 |
| toString() | Override string conversion.
 |
##### PdfSaveOptions()
```
public PdfSaveOptions()
```

Initializes a new instance of PdfSaveOptions class with default values.

##### PdfSaveOptions(int fileFormat)
```
public PdfSaveOptions(int fileFormat)
```

Initializes a new instance of PdfSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PdfSaveFileFormat.
 |

##### PdfSaveOptions(boolean overwriteExistingFile)
```
public PdfSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of PdfSaveOptions class with overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PdfSaveFileFormat.
 |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPermissionsPassword()
```
public final String getPermissionsPassword()
```

A permissions password (the primary password) requires a password to change permission settings.

**Returns:**
java.lang.String
##### setPermissionsPassword(String value)
```
public final void setPermissionsPassword(String value)
```

A permissions password (the primary password) requires a password to change permission settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPermissions()
```
public final Integer getPermissions()
```

The PDF document permissions such as printing, modification and data extraction.

To modify these permissions, the
PermissionsPassword
 must be set.
The value is a flags combination from Permissions.
A
null
 value means no explicit permissions are applied.

**Returns:**
java.lang.Integer
##### setPermissions(Integer value)
```
public final void setPermissions(Integer value)
```

The PDF document permissions such as printing, modification and data extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PresentationSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/presentationsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class PresentationSaveOptions extends SaveOptions
```

Save options for Presentation documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationSaveOptions() | Initializes a new instance of PresentationSaveOptions class with default values.
 |
| PresentationSaveOptions(int fileFormat) | Initializes a new instance of PresentationSaveOptions class with specified output file format.
 |
| PresentationSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag.
 |
| PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
| toString() | Override string conversion.
 |
##### PresentationSaveOptions()
```
public PresentationSaveOptions()
```

Initializes a new instance of PresentationSaveOptions class with default values.

##### PresentationSaveOptions(int fileFormat)
```
public PresentationSaveOptions(int fileFormat)
```

Initializes a new instance of PresentationSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PresentationSaveFileFormat.
 |

##### PresentationSaveOptions(boolean overwriteExistingFile)
```
public PresentationSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PresentationSaveFileFormat.
 |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### SaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Allows to specify additional options (such as password) when saving a document to sign.

#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of SaveOptions class with default values.
 |
| SaveOptions(boolean overwriteExistingFile) | Initializes a new instance of SaveOptions class with specified output type and overwrite flag.
 |
#### Methods

| Method | Description |
| --- | --- |
| getOverwriteExistingFiles() | Gets or sets whether to overwrite existing file with new output file.
 |
| setOverwriteExistingFiles(boolean value) | Gets or sets whether to overwrite existing file with new output file.
 |
| getPassword() | Gets or sets password to save signed document with password protection.
 |
| setPassword(String value) | Gets or sets password to save signed document with password protection.
 |
| getUseOriginalPassword() | Gets or sets whether to use password from LoadOptions to save signed document as protected.
 |
| setUseOriginalPassword(boolean value) | Gets or sets whether to use password from LoadOptions to save signed document as protected.
 |
| getAddMissingExtenstion() | Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.
 |
| setAddMissingExtenstion(boolean value) | Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.
 |
##### SaveOptions()
```
public SaveOptions()
```

Initializes a new instance of SaveOptions class with default values.

##### SaveOptions(boolean overwriteExistingFile)
```
public SaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### getOverwriteExistingFiles()
```
public final boolean getOverwriteExistingFiles()
```

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.

**Returns:**
boolean
##### setOverwriteExistingFiles(boolean value)
```
public final void setOverwriteExistingFiles(boolean value)
```

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUseOriginalPassword()
```
public final boolean getUseOriginalPassword()
```

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

**Returns:**
boolean
##### setUseOriginalPassword(boolean value)
```
public final void setUseOriginalPassword(boolean value)
```

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAddMissingExtenstion()
```
public final boolean getAddMissingExtenstion()
```

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

**Returns:**
boolean
##### setAddMissingExtenstion(boolean value)
```
public final void setAddMissingExtenstion(boolean value)
```

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/spreadsheetsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class SpreadsheetSaveOptions extends SaveOptions
```

Save options for Spreadsheet Documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetSaveOptions() | Initializes a new instance of SpreadsheetSaveOptions class with default values.
 |
| SpreadsheetSaveOptions(int fileFormat) | Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format.
 |
| SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
| toString() | Override string conversion.
 |
##### SpreadsheetSaveOptions()
```
public SpreadsheetSaveOptions()
```

Initializes a new instance of SpreadsheetSaveOptions class with default values.

##### SpreadsheetSaveOptions(int fileFormat)
```
public SpreadsheetSaveOptions(int fileFormat)
```

Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Specifies output file format.
 |

##### SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Specifies output file format.
 |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.saveoptions/wordprocessingsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class WordProcessingSaveOptions extends SaveOptions
```

Save options for WordProcessing documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSaveOptions() | Initializes a new instance of WordProcessingSaveOptions class with default values.
 |
| WordProcessingSaveOptions(int fileFormat) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format.
 |
| WordProcessingSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag.
 |
| WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document.
 |
| setFileFormat(int value) | Gets or sets file format of signed document.
 |
| toString() | Override string conversion
 |
##### WordProcessingSaveOptions()
```
public WordProcessingSaveOptions()
```

Initializes a new instance of WordProcessingSaveOptions class with default values.

##### WordProcessingSaveOptions(int fileFormat)
```
public WordProcessingSaveOptions(int fileFormat)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type WordProcessingSaveFileFormat.
 |

##### WordProcessingSaveOptions(boolean overwriteExistingFile)
```
public WordProcessingSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type WordProcessingSaveFileFormat.
 |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file.
 |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.search
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search.md

The **GroupDocs.Signature.Options.Search** namespace provides classes for working with Search options.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSearchOptions | Represents abstract search Options for Barcode signatures. |
| CertificateSearchOptions | Represents search options for Certificate metadata signatures. |
| DigitalSearchOptions | Represents base options for Digital signatures search |
| FormFieldSearchOptions | Represents abstract search Options for Form-field signatures. |
| ImageSearchOptions | Represents search options for Image signatures. |
| MetadataSearchOptions | Represents abstract search Options for Metadata signatures. |
| QrCodeSearchOptions | Represents abstract search Options for QR-Code signatures. |
| SearchOptions | Represents the extract signatures from document options. |
| TextSearchOptions | Represents search options for Text signatures. |

### BarcodeSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/barcodesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class BarcodeSearchOptions extends SearchOptions
```

Represents abstract search Options for Barcode signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSearchOptions() | Initializes a new instance of the SearchBarcodeOptions class with default values.
 |
| BarcodeSearchOptions(BarcodeType encodeType) | Initializes a new instance of the SearchBarcodeOptions class with encode type value.
 |
| BarcodeSearchOptions(BarcodeType encodeType, String text) | Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies Encode Type property to search Barcodes.
 |
| setEncodeType(BarcodeType value) | Specifies Encode Type property to search Barcodes.
 |
| getText() | Specifies Barcode Signature text if it should be searched and matched.
 |
| setText(String value) | Specifies Barcode Signature text if it should be searched and matched.
 |
| getMatchType() | Gets or sets Barcode text Match Type search.
 |
| setMatchType(int value) | Gets or sets Barcode text Match Type search.
 |
| getReturnContent() | Gets or sets flag to grab Barcode image content of signature on document page.
 |
| setReturnContent(boolean value) | Gets or sets flag to grab Barcode image content of signature on document page.
 |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
 |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
 |
##### BarcodeSearchOptions()
```
public BarcodeSearchOptions()
```

Initializes a new instance of the SearchBarcodeOptions class with default values.

##### BarcodeSearchOptions(BarcodeType encodeType)
```
public BarcodeSearchOptions(BarcodeType encodeType)
```

Initializes a new instance of the SearchBarcodeOptions class with encode type value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type.
 |

##### BarcodeSearchOptions(BarcodeType encodeType, String text)
```
public BarcodeSearchOptions(BarcodeType encodeType, String text)
```

Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type.
 |
| text | java.lang.String | Set Text of Barcode signature.
 |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Specifies Encode Type property to search Barcodes.
If this value is not set, search is processed for all supported Barcode Types

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Specifies Encode Type property to search Barcodes.
If this value is not set, search is processed for all supported Barcode Types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### getText()
```
public final String getText()
```

Specifies Barcode Signature text if it should be searched and matched.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies Barcode Signature text if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab Barcode image content of signature on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab Barcode image content of signature on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at
BarcodeSignature.Format
(BarcodeSignature.getFormat})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at
BarcodeSignature.Format
(BarcodeSignature.getFormat})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### CertificateSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/certificatesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class CertificateSearchOptions extends SearchOptions
```

Represents search options for Certificate metadata signatures.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values.
 |
| CertificateSearchOptions(String text) | Initializes a new instance of the TextSearchOptions class with text value.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies certificate property text to match on searching.
 |
| setText(String value) | Specifies certificate property text to match on searching.
 |
| getMatchType() | Gets or sets text match type search.
 |
| setMatchType(int value) | Gets or sets text match type search.
 |
##### CertificateSearchOptions()
```
public CertificateSearchOptions()
```

Initializes a new instance of the TextSearchOptions class with default values.

##### CertificateSearchOptions(String text)
```
public CertificateSearchOptions(String text)
```

Initializes a new instance of the TextSearchOptions class with text value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Set Text of Text signature.
 |

##### getText()
```
public final String getText()
```

Specifies certificate property text to match on searching.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies certificate property text to match on searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets text match type search.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets text match type search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### DigitalSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/digitalsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class DigitalSearchOptions extends SearchOptions
```

Represents base options for Digital signatures search

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSearchOptions() | Initializes a new instance of the DigitalSearchOptions class with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Comments of Digital signature to search.
 |
| setComments(String value) | Comments of Digital signature to search.
 |
| getSignDateTimeFrom() | Date and time range of Digital signature to search.
 |
| setSignDateTimeFrom(Date value) | Date and time range of Digital signature to search.
 |
| getSignDateTimeTo() | Date and time range of Digital Signature to search.
 |
| setSignDateTimeTo(Date value) | Date and time range of Digital Signature to search.
 |
| getSubjectName() | For non empty values specifies distinguished subject name of the certificate to search.
 |
| setSubjectName(String value) | For non empty values specifies distinguished subject name of the certificate to search.
 |
| getIssuerName() | For non empty values specifies distinguished name of the certificate issuer to search.
 |
| setIssuerName(String value) | For non empty values specifies distinguished name of the certificate issuer to search.
 |
##### DigitalSearchOptions()
```
public DigitalSearchOptions()
```

Initializes a new instance of the DigitalSearchOptions class with default values.

##### getComments()
```
public final String getComments()
```

Comments of Digital signature to search.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Comments of Digital signature to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignDateTimeFrom()
```
public final Date getSignDateTimeFrom()
```

Date and time range of Digital signature to search. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeFrom(Date value)
```
public final void setSignDateTimeFrom(Date value)
```

Date and time range of Digital signature to search. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSignDateTimeTo()
```
public final Date getSignDateTimeTo()
```

Date and time range of Digital Signature to search. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeTo(Date value)
```
public final void setSignDateTimeTo(Date value)
```

Date and time range of Digital Signature to search. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSubjectName()
```
public final String getSubjectName()
```

For non empty values specifies distinguished subject name of the certificate to search.

**Returns:**
java.lang.String
##### setSubjectName(String value)
```
public final void setSubjectName(String value)
```

For non empty values specifies distinguished subject name of the certificate to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIssuerName()
```
public final String getIssuerName()
```

For non empty values specifies distinguished name of the certificate issuer to search.

**Returns:**
java.lang.String
##### setIssuerName(String value)
```
public final void setIssuerName(String value)
```

For non empty values specifies distinguished name of the certificate issuer to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### FormFieldSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/formfieldsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class FormFieldSearchOptions extends SearchOptions
```

Represents abstract search Options for Form-field signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldSearchOptions() | Initializes a new instance of the SearchFormFieldOptions class with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Specifies type of form field signature if it should be searched.
 |
| setType(Integer value) | Specifies type of form field signature if it should be searched.
 |
| getName() | Specifies regular expression pattern of form field signature name if it should be searched.
 |
| setName(String value) | Specifies regular expression pattern of form field signature name if it should be searched.
 |
| getValue() | Specifies value of form field signature if it should be searched.
 |
| setValue(Object value) | Specifies value of form field signature if it should be searched.
 |
##### FormFieldSearchOptions()
```
public FormFieldSearchOptions()
```

Initializes a new instance of the SearchFormFieldOptions class with default values.

##### getType()
```
public final Integer getType()
```

Specifies type of form field signature if it should be searched. Default value is null.

**Returns:**
java.lang.Integer
##### setType(Integer value)
```
public final void setType(Integer value)
```

Specifies type of form field signature if it should be searched. Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getName()
```
public final String getName()
```

Specifies regular expression pattern of form field signature name if it should be searched.
You can use it simple as "text" or regular expression like "abc\\d+". Default value is empty string.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies regular expression pattern of form field signature name if it should be searched.
You can use it simple as "text" or regular expression like "abc\\d+". Default value is empty string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getValue()
```
public final Object getValue()
```

Specifies value of form field signature if it should be searched. Default value is null.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies value of form field signature if it should be searched. Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

### ImageSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/imagesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class ImageSearchOptions extends SearchOptions
```

Represents search options for Image signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSearchOptions() | Initializes a new instance of the ImageSearchOptions class with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getReturnContent() | Gets or sets flag to grab image content of signature on document page.
 |
| setReturnContent(boolean value) | Gets or sets flag to grab image content of signature on document page.
 |
| getMinContentSize() | For non zero value this flag specifies minimal size of images for search criteria.
 |
| setMinContentSize(long value) | For non zero value this flag specifies minimal size of images for search criteria.
 |
| getMaxContentSize() | For non zero value this flag specifies maximum size of images for search criteria.
 |
| setMaxContentSize(long value) | For non zero value this flag specifies maximum size of images for search criteria.
 |
| getReturnContentType() | Specifies file type of returned content of the image signature when ReturnContent property is enabled.
 |
| setReturnContentType(FileType value) | Specifies file type of returned content of the image signature when ReturnContent property is enabled.
 |
##### ImageSearchOptions()
```
public ImageSearchOptions()
```

Initializes a new instance of the ImageSearchOptions class with default values.

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab image content of signature on document page.
If this flag is set true, image signature content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab image content of signature on document page.
If this flag is set true, image signature content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getMinContentSize()
```
public final long getMinContentSize()
```

For non zero value this flag specifies minimal size of images for search criteria.
By default this flag is set to zero and does not affect search result.

**Returns:**
long
##### setMinContentSize(long value)
```
public final void setMinContentSize(long value)
```

For non zero value this flag specifies minimal size of images for search criteria.
By default this flag is set to zero and does not affect search result.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getMaxContentSize()
```
public final long getMaxContentSize()
```

For non zero value this flag specifies maximum size of images for search criteria.
By default this flag is set to zero and does not affect search result.

**Returns:**
long
##### setMaxContentSize(long value)
```
public final void setMaxContentSize(long value)
```

For non zero value this flag specifies maximum size of images for search criteria.
By default this flag is set to zero and does not affect search result.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned content of the image signature when ReturnContent property is enabled.
By default it set to Null. That means to return image content in original format.
This image format is specified at
ImageSignature.Format

Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than image content in original format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned content of the image signature when ReturnContent property is enabled.
By default it set to Null. That means to return image content in original format.
This image format is specified at
ImageSignature.Format

Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than image content in original format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### MetadataSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/metadatasearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class MetadataSearchOptions extends SearchOptions
```

Represents abstract search Options for Metadata signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSearchOptions() | Initializes a new instance of the SearchMetadataOptions class with default values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies Metadata Signature name if it should be searched and matched.
 |
| setName(String value) | Specifies Metadata Signature name if it should be searched and matched.
 |
| getNameMatchType() | Gets or sets Metadata name Match Type search.
 |
| setNameMatchType(int value) | Gets or sets Metadata name Match Type search.
 |
| getIncludeBuiltinProperties() | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
 |
| setIncludeBuiltinProperties(boolean value) | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
##### MetadataSearchOptions()
```
public MetadataSearchOptions()
```

Initializes a new instance of the SearchMetadataOptions class with default values.

##### getName()
```
public final String getName()
```

Specifies Metadata Signature name if it should be searched and matched.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies Metadata Signature name if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNameMatchType()
```
public final int getNameMatchType()
```

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

**Returns:**
int
##### setNameMatchType(int value)
```
public final void setNameMatchType(int value)
```

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getIncludeBuiltinProperties()
```
public final boolean getIncludeBuiltinProperties()
```

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
This flag has sense for Presentation, Spreadhsheet and Word Processing document file types.

**Returns:**
boolean
##### setIncludeBuiltinProperties(boolean value)
```
public final void setIncludeBuiltinProperties(boolean value)
```

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
This flag has sense for Presentation, Spreadhsheet and Word Processing document file types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

### QrCodeSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/qrcodesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class QrCodeSearchOptions extends SearchOptions
```

Represents abstract search Options for QR-Code signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSearchOptions() | Initializes a new instance of the QRCodeSearchOptions class with default values.
 |
| QrCodeSearchOptions(QrCodeType encodeType) | Initializes a new instance of the QRCodeSearchOptions class with encode type value.
 |
| QrCodeSearchOptions(QrCodeType encodeType, String text) | Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies Encode Type property to search QR-Codes.
 |
| setEncodeType(QrCodeType value) | Specifies Encode Type property to search QR-Codes.
 |
| getText() | Specifies QR-Code Signature Text if it should be searched and matched.
 |
| setText(String value) | Specifies QR-Code Signature Text if it should be searched and matched.
 |
| getMatchType() | Gets or sets QR-Code Text Match Type search.
 |
| setMatchType(int value) | Gets or sets QR-Code Text Match Type search.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| getReturnContent() | Gets or sets flag to grab QR-Code image content of signature on document page.
 |
| setReturnContent(boolean value) | Gets or sets flag to grab QR-Code image content of signature on document page.
 |
| getReturnContentType() | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
 |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
 |
##### QrCodeSearchOptions()
```
public QrCodeSearchOptions()
```

Initializes a new instance of the QRCodeSearchOptions class with default values.

##### QrCodeSearchOptions(QrCodeType encodeType)
```
public QrCodeSearchOptions(QrCodeType encodeType)
```

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type.
 |

##### QrCodeSearchOptions(QrCodeType encodeType, String text)
```
public QrCodeSearchOptions(QrCodeType encodeType, String text)
```

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type.
 |
| text | java.lang.String | Set Text of QR-Code signature.
 |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Specifies Encode Type property to search QR-Codes.
If this value is not set, search is processed for all supported QR-Code Types.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Specifies Encode Type property to search QR-Codes.
If this value is not set, search is processed for all supported QR-Code Types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getText()
```
public final String getText()
```

Specifies QR-Code Signature Text if it should be searched and matched.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies QR-Code Signature Text if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab QR-Code image content of signature on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab QR-Code image content of signature on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at
QrCodeSignature.Format
()
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in original .png will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at
QrCodeSignature.Format
()
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in original .png will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### SearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/searchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions
```
public abstract class SearchOptions extends OptionsExtensions
```

Represents the extract signatures from document options.

#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets Document page number for searching.
 |
| setPageNumber(Integer value) | Gets or sets Document page number for searching.
 |
| getPagesSetup() | Options to specify pages for Signature searching.
 |
| setPagesSetup(PagesSetup value) | Options to specify pages for Signature searching.
 |
| getAllPages() | Flag to search on each Document page.
 |
| setAllPages(boolean value) | Flag to search on each Document page.
 |
| getSkipExternal() | Flag to return only signatures marked as IsSignature.
 |
| setSkipExternal(boolean value) | Flag to return only signatures marked as IsSignature.
 |
| getSearchPages(int totalPages) | Virtual method to get list of pages for Signature extraction.
 |
| toString() | Override string conversion.
 |
##### getPageNumber()
```
public final Integer getPageNumber()
```

Gets or sets Document page number for searching.
Value is optional.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Gets or sets Document page number for searching.
Value is optional.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPagesSetup()
```
public final PagesSetup getPagesSetup()
```

Options to specify pages for Signature searching.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public final void setPagesSetup(PagesSetup value)
```

Options to specify pages for Signature searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getAllPages()
```
public final boolean getAllPages()
```

Flag to search on each Document page. By default this value is set to true.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public final void setAllPages(boolean value)
```

Flag to search on each Document page. By default this value is set to true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSkipExternal()
```
public final boolean getSkipExternal()
```

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

**Returns:**
boolean
##### setSkipExternal(boolean value)
```
public final void setSkipExternal(boolean value)
```

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSearchPages(int totalPages)
```
public System.Collections.Generic.List<Integer> getSearchPages(int totalPages)
```

Virtual method to get list of pages for Signature extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| totalPages | int | Total count of pages
 |

**Returns:**
com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> - List of page numbers

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### TextSearchOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.search/textsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class TextSearchOptions extends SearchOptions
```

Represents search options for Text signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values.
 |
| TextSearchOptions(String text) | Initializes a new instance of the TextSearchOptions class with text value.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies signature text to match on searching.
 |
| setText(String value) | Specifies signature text to match on searching.
 |
| getMatchType() | Gets or sets text match type search.
 |
| setMatchType(int value) | Gets or sets text match type search.
 |
| getSignatureImplementation() | Specifies text signature implementation to search.
 |
| setSignatureImplementation(Integer value) | Specifies text signature implementation to search.
 |
##### TextSearchOptions()
```
public TextSearchOptions()
```

Initializes a new instance of the TextSearchOptions class with default values.

##### TextSearchOptions(String text)
```
public TextSearchOptions(String text)
```

Initializes a new instance of the TextSearchOptions class with text value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Set Text of Text signature.
 |

##### getText()
```
public final String getText()
```

Specifies signature text to match on searching.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies signature text to match on searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets text match type search.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets text match type search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureImplementation()
```
public final Integer getSignatureImplementation()
```

Specifies text signature implementation to search.

**Returns:**
java.lang.Integer
##### setSignatureImplementation(Integer value)
```
public final void setSignatureImplementation(Integer value)
```

Specifies text signature implementation to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

### com.groupdocs.signature.options.sign
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign.md

The **GroupDocs.Signature.Options.Sign** namespace provides classes for working with Signature options

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSignOptions | Represents the Barcode signature options. |
| DigitalSignOptions | Represents the Digital signature options. |
| FormFieldSignOptions | Represents class of the FormField signature options for Pdf documents. |
| ImageSignOptions | Represents the Image signature options. |
| MetadataSignOptions | Represents Metadata signature options. |
| QrCodeSignOptions | Represents the QR-Code signature options. |
| SignOptions | Represents the signature options. |
| StampSignOptions | Represents the Stamp signature options. |
| TextSignOptions | Represents the Text signature options. |

### BarcodeSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/barcodesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public class BarcodeSignOptions extends TextSignOptions
```

Represents the Barcode signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSignOptions() | Initializes a new instance of the BarcodeSignOptions class with default values.
 |
| BarcodeSignOptions(String text) | Initializes a new instance of the BarcodeSignOptions class with text.
 |
| BarcodeSignOptions(String text, BarcodeType encodeType) | Initializes a new instance of the BarcodeSignOptions class with text.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets Barcode type.
 |
| setEncodeType(BarcodeType value) | Gets or sets Barcode type.
 |
| getForeColor() | Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification.
 |
| setForeColor(Color value) | Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification.
 |
| setForeColor(String value) | Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification.
 |
| getInnerMargins() | Gets or sets the space between Barcode elements and result image borders.
 |
| setInnerMargins(Padding value) | Gets or sets the space between Barcode elements and result image borders.
 |
| getCodeTextAlignment() | Gets or sets the alignment of text in the result Barcode image.
 |
| setCodeTextAlignment(int value) | Gets or sets the alignment of text in the result Barcode image.
 |
| getReturnContent() | Gets or sets flag to get Barcode image content of a signature which was put on document page.
 |
| setReturnContent(boolean value) | Gets or sets flag to get Barcode image content of a signature which was put on document page.
 |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
 |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
 |
| validate() | Internal method to validate the Barcode options parameters.
 |
| toString() | Override string conversion.
 |
##### BarcodeSignOptions()
```
public BarcodeSignOptions()
```

Initializes a new instance of the BarcodeSignOptions class with default values.

##### BarcodeSignOptions(String text)
```
public BarcodeSignOptions(String text)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text
 |

##### BarcodeSignOptions(String text, BarcodeType encodeType)
```
public BarcodeSignOptions(String text, BarcodeType encodeType)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text
 |
| encodeType | BarcodeType | Barcode encode type see BarcodeType
 |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Gets or sets Barcode type.

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Gets or sets Barcode type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeColor(String value)
```
public void setForeColor(String value)
```

Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInnerMargins()
```
public final Padding getInnerMargins()
```

Gets or sets the space between Barcode elements and result image borders.

**Returns:**
Padding
##### setInnerMargins(Padding value)
```
public final void setInnerMargins(Padding value)
```

Gets or sets the space between Barcode elements and result image borders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getCodeTextAlignment()
```
public final int getCodeTextAlignment()
```

Gets or sets the alignment of text in the result Barcode image.
Default value is None.

**Returns:**
int
##### setCodeTextAlignment(int value)
```
public final void setCodeTextAlignment(int value)
```

Gets or sets the alignment of text in the result Barcode image.
Default value is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at
BarcodeSignature.Format
(BarcodeSignature.getFormat})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at
BarcodeSignature.Format
(BarcodeSignature.getFormat)
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### validate()
```
public void validate()
```

Internal method to validate the Barcode options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### DigitalSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/digitalsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions
```
public class DigitalSignOptions extends ImageSignOptions
```

Represents the Digital signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignOptions() | Initializes a new instance of the DigitalSignOptions class with default values.
 |
| DigitalSignOptions(String certificateFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file.
 |
| DigitalSignOptions(InputStream certificateStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream.
 |
| DigitalSignOptions(String certificateFilePath, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file and image file.
 |
| DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.
 |
| DigitalSignOptions(InputStream certificateStream, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.
 |
| DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.
 |
#### Methods

| Method | Description |
| --- | --- |
| getReason() | Gets or sets the reason of signature.
 |
| setReason(String value) | Gets or sets the reason of signature.
 |
| getContact() | Gets or sets the signature contact.
 |
| setContact(String value) | Gets or sets the signature contact.
 |
| getLocation() | Gets or sets the signature location.
 |
| setLocation(String value) | Gets or sets the signature location.
 |
| getPassword() | Gets or sets the password of digital certificate.
 |
| setPassword(String value) | Gets or sets the password of digital certificate.
 |
| getSignature() | Gets or sets properties of document digital signature.
 |
| setSignature(DigitalSignature value) | Gets or sets properties of document digital signature.
 |
| getCertificateFilePath() | Gets or sets the digital certificate file path.
 |
| setCertificateFilePath(String value) | Gets or sets the digital certificate file GUID.
 |
| getCertificateStream() | Gets or sets digital certificate stream.
 |
| setCertificateStream(InputStream value) | Gets or sets digital certificate stream.
 |
| getVisible() | Gets or sets the visibility of signature.
 |
| setVisible(boolean value) | Gets or sets the visibility of signature.
 |
| getUseLtv() | Gets/sets LTV (Long Term Validation) validation flag.
 |
| setUseLtv(boolean value) | Gets/sets LTV (Long Term Validation) validation flag.
 |
| getCustomSignHash() | Gets or sets a custom hash-signing implementation, allowing callers to plug in their own
digital signing logic (HSM, remote signer, software keystore, etc.).
 |
| setCustomSignHash(ICustomSignHash value) | Sets a custom hash-signing implementation, allowing callers to plug in their own
digital signing logic.
 |
| getXAdESType() | XAdES type
XAdESType
.
 |
| setXAdESType(int value) | XAdES type
XAdESType
.
 |
| getSignatureLineId() |  |
| setSignatureLineId(UUID value) |  |
| toString() | Override string conversion.
 |
##### DigitalSignOptions()
```
public DigitalSignOptions()
```

Initializes a new instance of the DigitalSignOptions class with default values.

##### DigitalSignOptions(String certificateFilePath)
```
public DigitalSignOptions(String certificateFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path
 |

##### DigitalSignOptions(InputStream certificateStream)
```
public DigitalSignOptions(InputStream certificateStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream
 |

##### DigitalSignOptions(String certificateFilePath, String imageFilePath)
```
public DigitalSignOptions(String certificateFilePath, String imageFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate file and image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path
 |
| imageFilePath | java.lang.String | Signature Appearance image file path
 |

##### DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)
```
public DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path
 |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream
 |

##### DigitalSignOptions(InputStream certificateStream, String imageFilePath)
```
public DigitalSignOptions(InputStream certificateStream, String imageFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream
 |
| imageFilePath | java.lang.String | Signature Appearance image file path
 |

##### DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)
```
public DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream
 |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream
 |

##### getReason()
```
public final String getReason()
```

Gets or sets the reason of signature.

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

Gets or sets the reason of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContact()
```
public final String getContact()
```

Gets or sets the signature contact.

**Returns:**
java.lang.String
##### setContact(String value)
```
public final void setContact(String value)
```

Gets or sets the signature contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Gets or sets the signature location.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Gets or sets the signature location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets the password of digital certificate.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets the password of digital certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignature()
```
public final DigitalSignature getSignature()
```

Gets or sets properties of document digital signature.

**Returns:**
DigitalSignature
##### setSignature(DigitalSignature value)
```
public final void setSignature(DigitalSignature value)
```

Gets or sets properties of document digital signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DigitalSignature |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

Gets or sets the digital certificate file path.
This property is used only if CertificateStream is not specified.

**Returns:**
java.lang.String
##### setCertificateFilePath(String value)
```
public void setCertificateFilePath(String value)
```

Gets or sets the digital certificate file GUID.
This property is used only if CertificateStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Gets or sets digital certificate stream.
If this property is specified it is always used instead CertificateGuid.

**Returns:**
java.io.InputStream
##### setCertificateStream(InputStream value)
```
public final void setCertificateStream(InputStream value)
```

Gets or sets digital certificate stream.
If this property is specified it is always used instead CertificateGuid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getVisible()
```
public final boolean getVisible()
```

Gets or sets the visibility of signature.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

Gets or sets the visibility of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getUseLtv()
```
public final boolean getUseLtv()
```

Gets/sets LTV (Long Term Validation) validation flag.

**Returns:**
boolean
##### setUseLtv(boolean value)
```
public final void setUseLtv(boolean value)
```

Gets/sets LTV (Long Term Validation) validation flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getCustomSignHash()
```
public final ICustomSignHash getCustomSignHash()
```

Gets or sets a custom hash-signing implementation, allowing callers to plug in their own
digital signing logic (HSM, remote signer, software keystore, etc.).

**Returns:**
ICustomSignHash
##### setCustomSignHash(ICustomSignHash value)
```
public final void setCustomSignHash(ICustomSignHash value)
```

Sets a custom hash-signing implementation, allowing callers to plug in their own
digital signing logic.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICustomSignHash |  |

##### getXAdESType()
```
public final int getXAdESType()
```

XAdES type
XAdESType
. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

**Returns:**
int
##### setXAdESType(int value)
```
public final void setXAdESType(int value)
```

XAdES type
XAdESType
. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureLineId()
```
public final UUID getSignatureLineId()
```

**Returns:**
java.util.UUID
##### setSignatureLineId(UUID value)
```
public final void setSignatureLineId(UUID value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.UUID |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### FormFieldSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/formfieldsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public final class FormFieldSignOptions extends TextSignOptions
```

Represents class of the FormField signature options for Pdf documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldSignOptions() | Initializes a new instance of the PdfFormFieldSignOptions class with default values.
 |
| FormFieldSignOptions(FormFieldSignature signature) | Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSignature() | Gets or sets the FormField of signature.
 |
| setSignature(FormFieldSignature value) | Gets or sets the FormField of signature.
 |
##### FormFieldSignOptions()
```
public FormFieldSignOptions()
```

Initializes a new instance of the PdfFormFieldSignOptions class with default values.

##### FormFieldSignOptions(FormFieldSignature signature)
```
public FormFieldSignOptions(FormFieldSignature signature)
```

Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | FormFieldSignature |  |

##### getSignature()
```
public final FormFieldSignature getSignature()
```

Gets or sets the FormField of signature.

**Returns:**
FormFieldSignature
##### setSignature(FormFieldSignature value)
```
public final void setSignature(FormFieldSignature value)
```

Gets or sets the FormField of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FormFieldSignature |  |

### ImageSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/imagesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.IRectangle, com.groupdocs.signature.domain.interfaces.IAlignment, com.groupdocs.signature.domain.interfaces.IRotation, com.groupdocs.signature.domain.interfaces.ITransparency, com.aspose.ms.System.IDisposable
```
public class ImageSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency, System.IDisposable
```

Represents the Image signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSignOptions() | Initializes a new instance of the ImageSignOptions class with default values.
 |
| ImageSignOptions(String imageFilePath) | Initializes a new instance of the ImageSignOptions class with image file.
 |
| ImageSignOptions(InputStream imageStream) | Initializes a new instance of the ImageSignOptions class with image stream.
 |
#### Methods

| Method | Description |
| --- | --- |
| getImageFilePath() | Gets or sets the signature image file path.
 |
| setImageFilePath(String value) | Gets or sets the signature image file path.
 |
| getImageStream() | Gets or sets the signature image stream.
 |
| setImageStream(InputStream value) | Gets or sets the signature image stream.
 |
| getLeft() | Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
 |
| setLeft(int value) | Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
 |
| getTop() | Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
 |
| setTop(int value) | Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
 |
| getWidth() | Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType).
 |
| setWidth(int value) | Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType).
 |
| getHeight() | Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType).
 |
| setHeight(int value) | Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType).
 |
| getLocationMeasureType() | Measure type (pixels, percents or millimeters) for Left and Top properties.
 |
| setLocationMeasureType(int value) | Measure type (pixels, percents or millimeters) for Left and Top properties.
 |
| getSizeMeasureType() | Measure type (pixels, percents or millimeters) for Width and Height properties.
 |
| setSizeMeasureType(int value) | Measure type (pixels, percents or millimeters) for Width and Height properties.
 |
| getStretch() | Stretch mode on Document Page.
 |
| setStretch(int value) | Stretch mode on Document Page.
 |
| getRotationAngle() | Rotation angle of signature on document page (clockwise).
 |
| setRotationAngle(int value) | Rotation angle of signature on document page (clockwise).
 |
| getHorizontalAlignment() | Horizontal alignment of signature on document page.
 |
| setHorizontalAlignment(int value) | Horizontal alignment of signature on document page.
 |
| getVerticalAlignment() | Vertical alignment of signature on document page.
 |
| setVerticalAlignment(int value) | Vertical alignment of signature on document page.
 |
| getMargin() | Gets or sets the space between Sign and Document edges.
 |
| setMargin(Padding value) | Gets or sets the space between Sign and Document edges.
 |
| getMarginMeasureType() | Gets or sets the measure type (pixels, percents or millimeters) for Margin.
 |
| setMarginMeasureType(int value) | Gets or sets the measure type (pixels, percents or millimeters) for Margin.
 |
| getTransparency() | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| setTransparency(double value) | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| getShapePosition() | Defines where shape should be presented in the document layout
 |
| setShapePosition(int value) | Defines where shape should be presented in the document layout
 |
| getRectangle() | Rectangle of area to put the image on document.
 |
| getBorder() | Specify border settings
 |
| setBorder(Border value) | Specify border settings
 |
| toString() | Override string conversion.
 |
| fromBase64(String base64Content) | Creates a new instance of the ImageSignOptions class with predefined Image from Base64.
 |
| dispose() | Clears internal resources
 |
##### ImageSignOptions()
```
public ImageSignOptions()
```

Initializes a new instance of the ImageSignOptions class with default values.

##### ImageSignOptions(String imageFilePath)
```
public ImageSignOptions(String imageFilePath)
```

Initializes a new instance of the ImageSignOptions class with image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | java.lang.String | Image file path
 |

##### ImageSignOptions(InputStream imageStream)
```
public ImageSignOptions(InputStream imageStream)
```

Initializes a new instance of the ImageSignOptions class with image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | Image stream
 |

##### getImageFilePath()
```
public final String getImageFilePath()
```

Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.

**Returns:**
java.lang.String
##### setImageFilePath(String value)
```
public final void setImageFilePath(String value)
```

Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets or sets the signature image stream.
If this property is specified it is always used instead ImageGuid.

**Returns:**
java.io.InputStream
##### setImageStream(InputStream value)
```
public final void setImageStream(InputStream value)
```

Gets or sets the signature image stream.
If this property is specified it is always used instead ImageGuid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getLeft()
```
public int getLeft()
```

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if horizontal alignment is not specified).

**Returns:**
int
##### setLeft(int value)
```
public void setLeft(int value)
```

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if horizontal alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public int getTop()
```

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if vertical alignment is not specified).

**Returns:**
int
##### setTop(int value)
```
public void setTop(int value)
```

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType).
(works if vertical alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType).

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters MeasureType SizeMeasureType).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType).

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLocationMeasureType()
```
public int getLocationMeasureType()
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Returns:**
int
##### setLocationMeasureType(int value)
```
public void setLocationMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSizeMeasureType()
```
public int getSizeMeasureType()
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Returns:**
int
##### setSizeMeasureType(int value)
```
public void setSizeMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getStretch()
```
public final int getStretch()
```

Stretch mode on Document Page.

**Returns:**
int
##### setStretch(int value)
```
public final void setStretch(int value)
```

Stretch mode on Document Page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Rotation angle of signature on document page (clockwise).

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Rotation angle of signature on document page (clockwise).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Horizontal alignment of signature on document page.

**Returns:**
int
##### setHorizontalAlignment(int value)
```
public final void setHorizontalAlignment(int value)
```

Horizontal alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Vertical alignment of signature on document page.

**Returns:**
int
##### setVerticalAlignment(int value)
```
public final void setVerticalAlignment(int value)
```

Vertical alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMargin()
```
public Padding getMargin()
```

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

**Returns:**
Padding
##### setMargin(Padding value)
```
public void setMargin(Padding value)
```

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getMarginMeasureType()
```
public int getMarginMeasureType()
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Returns:**
int
##### setMarginMeasureType(int value)
```
public void setMarginMeasureType(int value)
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getShapePosition()
```
public final int getShapePosition()
```

Defines where shape should be presented in the document layout

**Returns:**
int
##### setShapePosition(int value)
```
public final void setShapePosition(int value)
```

Defines where shape should be presented in the document layout

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRectangle()
```
public final Rectangle getRectangle()
```

Rectangle of area to put the image on document.

**Returns:**
java.awt.Rectangle
##### getBorder()
```
public final Border getBorder()
```

Specify border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Specify border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### fromBase64(String base64Content)
```
public static ImageSignOptions fromBase64(String base64Content)
```

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| base64Content | java.lang.String | Image content in Base64 string format
 |

**Returns:**
ImageSignOptions -
##### dispose()
```
public final void dispose()
```

Clears internal resources

### MetadataSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/metadatasignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions
```
public class MetadataSignOptions extends SignOptions
```

Represents Metadata signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSignOptions() | Initializes a new instance of the SignMetadataOptions class with default values.
 |
| MetadataSignOptions(ArrayList<MetadataSignature> signatures) | Initializes a new instance of the SignMetadataOptions class with Metadata.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSignatures() | Gets or sets the Metadata of signature.
 |
| setSignatures(MetadataSignatureCollection value) | Gets or sets the Metadata of signature.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| addPdfSignature(String name, Object value, String tag) | Creates new PdfMetadataSignature with passed arguments and adds it to collection.
 |
| addImageSignature(int id, Object value) | Creates new ImageMetadataSignature with passed arguments and adds it to collection.
 |
| add(MetadataSignature metadataSignature) | Add existing MetadataSignature instance to collection.
 |
| validate() | Internal method to validate the options parameters.
 |
| toString() | Override string conversion.
 |
| signature() |  |
##### MetadataSignOptions()
```
public MetadataSignOptions()
```

Initializes a new instance of the SignMetadataOptions class with default values.

##### MetadataSignOptions(ArrayList<MetadataSignature> signatures)
```
public MetadataSignOptions(ArrayList<MetadataSignature> signatures)
```

Initializes a new instance of the SignMetadataOptions class with Metadata.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatures | java.util.ArrayList<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature> | Collection of Metadata Signatures MetadataSignature.
 |

##### getSignatures()
```
public final MetadataSignatureCollection getSignatures()
```

Gets or sets the Metadata of signature.

**Returns:**
MetadataSignatureCollection
##### setSignatures(MetadataSignatureCollection value)
```
public final void setSignatures(MetadataSignatureCollection value)
```

Gets or sets the Metadata of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | MetadataSignatureCollection |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### addPdfSignature(String name, Object value, String tag)
```
public final PdfMetadataSignature addPdfSignature(String name, Object value, String tag)
```

Creates new PdfMetadataSignature with passed arguments and adds it to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object
 |
| value | java.lang.Object | Value of Metadata signature
 |
| tag | java.lang.String | Prefix tag of Metadata signature
 |

**Returns:**
PdfMetadataSignature - Newly created signature that was added to MetadataSignatures collection

##### addImageSignature(int id, Object value)
```
public final ImageMetadataSignature addImageSignature(int id, Object value)
```

Creates new ImageMetadataSignature with passed arguments and adds it to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values
 |
| value | java.lang.Object | Metadata value
 |

**Returns:**
ImageMetadataSignature - Newly created signature that was added to MetadataSignatures collection

##### add(MetadataSignature metadataSignature)
```
public final MetadataSignOptions add(MetadataSignature metadataSignature)
```

Add existing MetadataSignature instance to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataSignature | MetadataSignature | The existing MetadataSignature instance to be added
 |

**Returns:**
MetadataSignOptions - Instance itself

##### validate()
```
public void validate()
```

Internal method to validate the options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### signature()
```
public BaseSignature signature()
```

**Returns:**
BaseSignature

### QrCodeSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/qrcodesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public class QrCodeSignOptions extends TextSignOptions
```

Represents the QR-Code signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSignOptions() | Initializes a new instance of the QRCodeSignOptions class with default values.
 |
| QrCodeSignOptions(String text) | Initializes a new instance of the QRCodeSignOptions class with text.
 |
| QrCodeSignOptions(String text, QrCodeType encodeType) | Initializes a new instance of the BarcodeSignOptions class with text.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets QRCode type.
 |
| setEncodeType(QrCodeType value) | Gets or sets QRCode type.
 |
| getForeColor() | Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification.
 |
| setForeColor(Color value) | Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification.
 |
| setForeColor(String value) | Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification.
 |
| getInnerMargins() | Gets or sets the space between QRCode elements and result image borders.
 |
| setInnerMargins(Padding value) | Gets or sets the space between QRCode elements and result image borders.
 |
| getCodeTextAlignment() | Gets or sets the alignment of text in the result QR-code image.
 |
| setCodeTextAlignment(int value) | Gets or sets the alignment of text in the result QR-code image.
 |
| getLogoFilePath() | Gets or sets the QR-code logo image file name.
 |
| setLogoFilePath(String value) | Gets or sets the QR-code logo image file name.
 |
| getLogoStream() | Gets or sets the QR-code logo image stream.
 |
| setLogoStream(InputStream value) | Gets or sets the QR-code logo image stream.
 |
| getData() | Gets or sets custom object to serialize to QR-Code content.
 |
| setData(Object value) | Gets or sets custom object to serialize to QR-Code content.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
 |
| getReturnContent() | Gets or sets flag to get QR-Code image content of a signature which was put on document page.
 |
| setReturnContent(boolean value) | Gets or sets flag to get QR-Code image content of a signature which was put on document page.
 |
| getReturnContentType() | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
 |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
 |
| toString() | Override string conversion.
 |
| signature() |  |
##### QrCodeSignOptions()
```
public QrCodeSignOptions()
```

Initializes a new instance of the QRCodeSignOptions class with default values.

##### QrCodeSignOptions(String text)
```
public QrCodeSignOptions(String text)
```

Initializes a new instance of the QRCodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Signature text.
 |

##### QrCodeSignOptions(String text, QrCodeType encodeType)
```
public QrCodeSignOptions(String text, QrCodeType encodeType)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | QRCode text
 |
| encodeType | QrCodeType | QRCode encode type see QrCodeType
 |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Gets or sets QRCode type.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Gets or sets QRCode type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeColor(String value)
```
public void setForeColor(String value)
```

Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInnerMargins()
```
public final Padding getInnerMargins()
```

Gets or sets the space between QRCode elements and result image borders.

**Returns:**
Padding
##### setInnerMargins(Padding value)
```
public final void setInnerMargins(Padding value)
```

Gets or sets the space between QRCode elements and result image borders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getCodeTextAlignment()
```
public final int getCodeTextAlignment()
```

Gets or sets the alignment of text in the result QR-code image.
Default value is None.

**Returns:**
int
##### setCodeTextAlignment(int value)
```
public final void setCodeTextAlignment(int value)
```

Gets or sets the alignment of text in the result QR-code image.
Default value is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLogoFilePath()
```
public final String getLogoFilePath()
```

Gets or sets the QR-code logo image file name.
This property in use only if LogoStream is not specified.
Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.lang.String
##### setLogoFilePath(String value)
```
public final void setLogoFilePath(String value)
```

Gets or sets the QR-code logo image file name.
This property in use only if LogoStream is not specified.
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLogoStream()
```
public final InputStream getLogoStream()
```

Gets or sets the QR-code logo image stream.
If this property is specified it is always used instead LogoGuid.
Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.io.InputStream
##### setLogoStream(InputStream value)
```
public final void setLogoStream(InputStream value)
```

Gets or sets the QR-code logo image stream.
If this property is specified it is always used instead LogoGuid.
Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getData()
```
public final Object getData()
```

Gets or sets custom object to serialize to QR-Code content.

**Returns:**
java.lang.Object
##### setData(Object value)
```
public final void setData(Object value)
```

Gets or sets custom object to serialize to QR-Code content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to get QR-Code image content of a signature which was put on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to get QR-Code image content of a signature which was put on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format
ReturnContentType
(#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)).
By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at
QrCodeSignature.Format
(QrCodeSignature.getFormat/{@link QrCodeSignature#(FileType)})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at
QrCodeSignature.Format
(QrCodeSignature.getFormat/{@link QrCodeSignature#(FileType)})
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### signature()
```
public BaseSignature signature()
```

**Returns:**
BaseSignature

### SignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/signoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class SignOptions
```

Represents the signature options.

#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets document page number for signing.
 |
| setPageNumber(int value) | Gets or sets document page number for signing.
 |
| getAllPages() | Put signature on all document pages.
 |
| setAllPages(boolean value) | Put signature on all document pages.
 |
| getAppearance() | Additional signature appearance.
 |
| setAppearance(SignatureAppearance value) | Additional signature appearance.
 |
| getExtensions() | Signature Extensions.
 |
| setExtensions(List<SignatureExtension> value) | Signature Extensions.
 |
| getPagesSetup() | Options to specify pages to be signed.
 |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed.
 |
| getSignatureType() | Get the Signature Type SignatureType
 |
| getDocumentType() | Get or set the Document Type of the Signature Options DocumentType
 |
| setDocumentType(int value) | Get or set the Document Type of the Signature Options DocumentType
 |
| getZOrder() | Gets or sets the Z-order position of text signature.
 |
| setZOrder(int value) | Gets or sets the Z-order position of text signature.
 |
| getHashAlgorithm() | Gets or sets the hash algorithm to be used for cryptographic operations.
 |
| setHashAlgorithm(int value) | Gets or sets the hash algorithm to be used for cryptographic operations.
 |
| toString() | Override string conversion.
 |
| addSignature(Object[] args) |  |
##### getPageNumber()
```
public int getPageNumber()
```

Gets or sets document page number for signing.
Minimal and default value is 1.

**Returns:**
int
##### setPageNumber(int value)
```
public void setPageNumber(int value)
```

Gets or sets document page number for signing.
Minimal and default value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAllPages()
```
public boolean getAllPages()
```

Put signature on all document pages.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public void setAllPages(boolean value)
```

Put signature on all document pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAppearance()
```
public final SignatureAppearance getAppearance()
```

Additional signature appearance.

**Returns:**
SignatureAppearance
##### setAppearance(SignatureAppearance value)
```
public final void setAppearance(SignatureAppearance value)
```

Additional signature appearance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureAppearance |  |

##### getExtensions()
```
public final List<SignatureExtension> getExtensions()
```

Signature Extensions.

**Returns:**
java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension>
##### setExtensions(List<SignatureExtension> value)
```
public void setExtensions(List<SignatureExtension> value)
```

Signature Extensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension> |  |

##### getPagesSetup()
```
public PagesSetup getPagesSetup()
```

Options to specify pages to be signed.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public void setPagesSetup(PagesSetup value)
```

Options to specify pages to be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getSignatureType()
```
public final int getSignatureType()
```

Get the Signature Type SignatureType

**Returns:**
int
##### getDocumentType()
```
public final int getDocumentType()
```

Get or set the Document Type of the Signature Options DocumentType

**Returns:**
int
##### setDocumentType(int value)
```
public final void setDocumentType(int value)
```

Get or set the Document Type of the Signature Options DocumentType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getZOrder()
```
public final int getZOrder()
```

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

**Returns:**
int
##### setZOrder(int value)
```
public final void setZOrder(int value)
```

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHashAlgorithm()
```
public final int getHashAlgorithm()
```

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.
Value is one of the constants on HashAlgorithm.

**Returns:**
int
##### setHashAlgorithm(int value)
```
public final void setHashAlgorithm(int value)
```

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### addSignature(Object[] args)
```
public BaseSignature addSignature(Object[] args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| args | java.lang.Object[] |  |

**Returns:**
BaseSignature

### StampSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/stampsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions
```
public class StampSignOptions extends ImageSignOptions
```

Represents the Stamp signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| StampSignOptions() | Initializes a new instance of the StampSignOptions class with default values.
 |
| StampSignOptions(int left, int top, int width, int height) | Initializes a new instance of the StampSignOptions class with alignment options.
 |
#### Methods

| Method | Description |
| --- | --- |
| getStampType() | Gets or sets stamp type.
 |
| setStampType(StampType value) | Gets or sets stamp type.
 |
| getOuterLines() | List of Outer Lines rendered as concentric circles.
 |
| getInnerLines() | List of Inner Lines rendered as set of rectangles.
 |
| getBackground() | Gets or sets the Stamp background.
 |
| setBackground(Background value) | Gets or sets the Stamp background.
 |
| getBackgroundColor() | Gets or sets the background color of signature.
 |
| setBackgroundColor(Color value) | Gets or sets the background color of signature.
 |
| getBackgroundBrush() | Gets or sets the signature background brush.
 |
| setBackgroundBrush(Brush value) | Gets or sets the signature background brush.
 |
| getBackgroundColorCropType() | Gets or sets the background color crop type of signature.
 |
| setBackgroundColorCropType(int value) | Gets or sets the background color crop type of signature.
 |
| getBackgroundImageCropType() | Gets or sets the background image crop type of signature.
 |
| setBackgroundImageCropType(int value) | Gets or sets the background image crop type of signature.
 |
| toString() | Override string conversion
 |
##### StampSignOptions()
```
public StampSignOptions()
```

Initializes a new instance of the StampSignOptions class with default values.

##### StampSignOptions(int left, int top, int width, int height)
```
public StampSignOptions(int left, int top, int width, int height)
```

Initializes a new instance of the StampSignOptions class with alignment options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | int | The x-coordinate of the left top edge of Stamp Signature
 |
| top | int | The y-coordinate of the left top edge of Stamp Signature
 |
| width | int | The width of Stamp Signature
 |
| height | int | The height of Stamp Signature
 |

##### getStampType()
```
public final StampType getStampType()
```

Gets or sets stamp type.
Value by default is Round.

**Returns:**
StampType
##### setStampType(StampType value)
```
public final void setStampType(StampType value)
```

Gets or sets stamp type.
Value by default is Round.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | StampType |  |

##### getOuterLines()
```
public final List<StampLine> getOuterLines()
```

List of Outer Lines rendered as concentric circles.

**Returns:**
java.util.List<com.groupdocs.signature.domain.stamps.StampLine>
##### getInnerLines()
```
public final List<StampLine> getInnerLines()
```

List of Inner Lines rendered as set of rectangles.

**Returns:**
java.util.List<com.groupdocs.signature.domain.stamps.StampLine>
##### getBackground()
```
public final Background getBackground()
```

Gets or sets the Stamp background.

**Returns:**
Background
##### setBackground(Background value)
```
public final void setBackground(Background value)
```

Gets or sets the Stamp background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Background |  |

##### getBackgroundColor()
```
public final Color getBackgroundColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setBackgroundColor(Color value)
```
public final void setBackgroundColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getBackgroundBrush()
```
public final Brush getBackgroundBrush()
```

Gets or sets the signature background brush. Value by default is null.

**Returns:**
Brush
##### setBackgroundBrush(Brush value)
```
public final void setBackgroundBrush(Brush value)
```

Gets or sets the signature background brush. Value by default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Brush |  |

##### getBackgroundColorCropType()
```
public final int getBackgroundColorCropType()
```

Gets or sets the background color crop type of signature.

**Returns:**
int
##### setBackgroundColorCropType(int value)
```
public final void setBackgroundColorCropType(int value)
```

Gets or sets the background color crop type of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBackgroundImageCropType()
```
public final int getBackgroundImageCropType()
```

Gets or sets the background image crop type of signature.

**Returns:**
int
##### setBackgroundImageCropType(int value)
```
public final void setBackgroundImageCropType(int value)
```

Gets or sets the background image crop type of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### TextSignOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.sign/textsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.IRectangle, com.groupdocs.signature.domain.interfaces.IAlignment, com.groupdocs.signature.domain.interfaces.IRotation, com.groupdocs.signature.domain.interfaces.ITransparency
```
public class TextSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency
```

Represents the Text signature options.

#### Constructors

| Constructor | Description |
| --- | --- |
| TextSignOptions() | Initializes a new instance of the SignTextOptions class with default values.
 |
| TextSignOptions(String text) | Initializes a new instance of the SignTextOptions class with text.
 |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_TRANSPARENCY |  |
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
 |
| setLeft(int value) | Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
 |
| getTop() | Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
 |
| setTop(int value) | Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
 |
| getWidth() | Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
 |
| setWidth(int value) | Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
 |
| getHeight() | Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
 |
| setHeight(int value) | Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).
 |
| getLocationMeasureType() | Measure type (pixels, percents or millimeters) for Left and Top properties.
 |
| setLocationMeasureType(int value) | Measure type (pixels, percents or millimeters) for Left and Top properties.
 |
| getSizeMeasureType() | Measure type (pixels, percents or millimeters) for Width and Height properties.
 |
| setSizeMeasureType(int value) | Measure type (pixels, percents or millimeters) for Width and Height properties.
 |
| getStretch() | Stretch mode on Document Page.
 |
| setStretch(int value) | Stretch mode on Document Page.
 |
| getRotationAngle() | Rotation angle of signature on document page (clockwise).
 |
| setRotationAngle(int value) | Rotation angle of signature on document page (clockwise).
 |
| getHorizontalAlignment() | Horizontal alignment of signature on document page.
 |
| setHorizontalAlignment(int value) | Horizontal alignment of signature on document page.
 |
| getVerticalAlignment() | Vertical alignment of signature on document page.
 |
| setVerticalAlignment(int value) | Vertical alignment of signature on document page.
 |
| getMargin() | Gets or sets the space between Sign and Document edges.
 |
| setMargin(Padding value) | Gets or sets the space between Sign and Document edges.
 |
| getMarginMeasureType() | Gets or sets the measure type (pixels, percents or millimeters) for Margin.
 |
| setMarginMeasureType(int value) | Gets or sets the measure type (pixels, percents or millimeters) for Margin.
 |
| getTransparency() | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| setTransparency(double value) | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
 |
| getText() | Gets or sets the text of signature.
 |
| setText(String value) | Gets or sets the text of signature.
 |
| getFont() | Gets or sets the font of signature.
 |
| setFont(SignatureFont value) | Gets or sets the font of signature.
 |
| getForeColor() | Gets or sets the fore color of signature.
 |
| setForeColor(Color value) | Gets or sets the fore color of signature.
 |
| getSignatureImplementation() | Gets or sets the type of text signature implementation.
 |
| setSignatureImplementation(int value) | Gets or sets the type of text signature implementation.
 |
| getTextHorizontalAlignment() | Horizontal alignment of text inside a signature.
 |
| setTextHorizontalAlignment(int value) | Horizontal alignment of text inside a signature.
 |
| getTextVerticalAlignment() | Vertical alignment of text inside a signature.
 |
| setTextVerticalAlignment(int value) | Vertical alignment of text inside a signature.
 |
| getFormTextFieldTitle() | Gets or sets the title of text form field to put text signature into it.
 |
| setFormTextFieldTitle(String value) | Gets or sets the title of text form field to put text signature into it.
 |
| getFormTextFieldType() | Gets or sets the type of form field to put text signature into it.
 |
| setFormTextFieldType(int value) | Gets or sets the type of form field to put text signature into it.
 |
| getShapeType() | Gets or sets the type of shape to put text.
 |
| setShapeType(int value) | Gets or sets the type of shape to put text.
 |
| getSignatureID() | Gets or sets the unique ID of signature.
 |
| setSignatureID(int value) | Gets or sets the unique ID of signature.
 |
| getBorder() | Specify border settings
 |
| setBorder(Border value) | Specify border settings
 |
| getBackground() | Gets or sets the signature background settings.
 |
| setBackground(Background value) | Gets or sets the signature background settings.
 |
| getNative() | Gets or sets the native attribute.
 |
| setNative(boolean value) | Gets or sets the native attribute.
 |
| getShapePosition() | Defines where shape should be presented in the document layout
 |
| setShapePosition(int value) | Defines where shape should be presented in the document layout
 |
| validate() | Internal method to validate the options parameters.
 |
| toString() | Override string conversion.
 |
##### TextSignOptions()
```
public TextSignOptions()
```

Initializes a new instance of the SignTextOptions class with default values.

##### TextSignOptions(String text)
```
public TextSignOptions(String text)
```

Initializes a new instance of the SignTextOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Signature text.
 |

##### DEFAULT_TRANSPARENCY
```
public static final double DEFAULT_TRANSPARENCY
```

##### getLeft()
```
public final int getLeft()
```

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if horizontal alignment is not specified).

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if horizontal alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if vertical alignment is not specified).

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType LocationMeasureType property).
(works if vertical alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLocationMeasureType()
```
public int getLocationMeasureType()
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Returns:**
int
##### setLocationMeasureType(int value)
```
public void setLocationMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSizeMeasureType()
```
public int getSizeMeasureType()
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Returns:**
int
##### setSizeMeasureType(int value)
```
public void setSizeMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getStretch()
```
public final int getStretch()
```

Stretch mode on Document Page.

**Returns:**
int
##### setStretch(int value)
```
public final void setStretch(int value)
```

Stretch mode on Document Page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Rotation angle of signature on document page (clockwise).

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Rotation angle of signature on document page (clockwise).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Horizontal alignment of signature on document page.

**Returns:**
int
##### setHorizontalAlignment(int value)
```
public final void setHorizontalAlignment(int value)
```

Horizontal alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Vertical alignment of signature on document page.

**Returns:**
int
##### setVerticalAlignment(int value)
```
public final void setVerticalAlignment(int value)
```

Vertical alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMargin()
```
public Padding getMargin()
```

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

**Returns:**
Padding
##### setMargin(Padding value)
```
public void setMargin(Padding value)
```

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getMarginMeasureType()
```
public int getMarginMeasureType()
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Returns:**
int
##### setMarginMeasureType(int value)
```
public void setMarginMeasureType(int value)
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getText()
```
public final String getText()
```

Gets or sets the text of signature.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets the text of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFont()
```
public final SignatureFont getFont()
```

Gets or sets the font of signature.

**Returns:**
SignatureFont
##### setFont(SignatureFont value)
```
public final void setFont(SignatureFont value)
```

Gets or sets the font of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureFont |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the fore color of signature.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the fore color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Gets or sets the type of text signature implementation.

**Returns:**
int
##### setSignatureImplementation(int value)
```
public final void setSignatureImplementation(int value)
```

Gets or sets the type of text signature implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextHorizontalAlignment()
```
public final int getTextHorizontalAlignment()
```

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see TextSignatureImplementation SignatureImplementation property).

**Returns:**
int
##### setTextHorizontalAlignment(int value)
```
public final void setTextHorizontalAlignment(int value)
```

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see TextSignatureImplementation SignatureImplementation property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextVerticalAlignment()
```
public final int getTextVerticalAlignment()
```

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see TextSignatureImplementation SignatureImplementation property).

**Returns:**
int
##### setTextVerticalAlignment(int value)
```
public final void setTextVerticalAlignment(int value)
```

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see TextSignatureImplementation SignatureImplementation property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormTextFieldTitle()
```
public final String getFormTextFieldTitle()
```

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.

**Returns:**
java.lang.String
##### setFormTextFieldTitle(String value)
```
public final void setFormTextFieldTitle(String value)
```

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFormTextFieldType()
```
public final int getFormTextFieldType()
```

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.

**Returns:**
int
##### setFormTextFieldType(int value)
```
public final void setFormTextFieldType(int value)
```

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getShapeType()
```
public final int getShapeType()
```

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.

**Returns:**
int
##### setShapeType(int value)
```
public final void setShapeType(int value)
```

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureID()
```
public final int getSignatureID()
```

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

**Returns:**
int
##### setSignatureID(int value)
```
public final void setSignatureID(int value)
```

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorder()
```
public final Border getBorder()
```

Specify border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Specify border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getBackground()
```
public final Background getBackground()
```

Gets or sets the signature background settings.

**Returns:**
Background
##### setBackground(Background value)
```
public final void setBackground(Background value)
```

Gets or sets the signature background settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Background |  |

##### getNative()
```
public final boolean getNative()
```

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.

**Returns:**
boolean
##### setNative(boolean value)
```
public final void setNative(boolean value)
```

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShapePosition()
```
public final int getShapePosition()
```

Defines where shape should be presented in the document layout

**Returns:**
int
##### setShapePosition(int value)
```
public final void setShapePosition(int value)
```

Defines where shape should be presented in the document layout

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### validate()
```
public void validate()
```

Internal method to validate the options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.verify
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify.md

The **GroupDocs.Signature.Options.Verify** namespace provides classes for working with Verification options

#### Classes

| Class | Description |
| --- | --- |
| BarcodeVerifyOptions | Represents the Barcode verify options. |
| CertificateVerifyOptions | Keeps options to verify certificate documents. |
| DigitalVerifyOptions | Keeps options to verify document Digital signature. |
| QrCodeVerifyOptions | Keeps options to verify document QR-code signature. |
| TextVerifyOptions | Keeps options to verify document Text signature. |
| VerifyOptions | Keeps options to verify document. |

### BarcodeVerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/barcodeverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions
```
public class BarcodeVerifyOptions extends TextVerifyOptions
```

Represents the Barcode verify options.

<br />

*** ** * ** ***

 **Learn more**  **Learn more**

* Basic usage of verification for Barcode electronic signature by GroupDocs.Signature: How to eVerification Barcode signatures in a document
* Advanced usage of settings of verification for Barcode electronic signature with GroupDocs.Signature: Advanced usage of eVerification Barcode signatures in a document and additional settings

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeVerifyOptions() | Creates default Verification Option for Barcode Signature.
 |
| BarcodeVerifyOptions(String text) | Creates default Verification Option with verification text
 |
| BarcodeVerifyOptions(BarcodeType encodeType) | Creates default Verification Option with Barcode Type verification
 |
| BarcodeVerifyOptions(String text, BarcodeType encodeType) | Creates default Verification Option with Barcode Type verification and text
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets Barcode Type verification.
 |
| setEncodeType(BarcodeType value) | Gets or sets Barcode Type verification.
 |
| toString() | Overrides conversion to string.
 |
##### BarcodeVerifyOptions()
```
public BarcodeVerifyOptions()
```

Creates default Verification Option for Barcode Signature.

##### BarcodeVerifyOptions(String text)
```
public BarcodeVerifyOptions(String text)
```

Creates default Verification Option with verification text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text to verify
 |

##### BarcodeVerifyOptions(BarcodeType encodeType)
```
public BarcodeVerifyOptions(BarcodeType encodeType)
```

Creates default Verification Option with Barcode Type verification

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Barcode Type verification
 |

##### BarcodeVerifyOptions(String text, BarcodeType encodeType)
```
public BarcodeVerifyOptions(String text, BarcodeType encodeType)
```

Creates default Verification Option with Barcode Type verification and text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text to verify
 |
| encodeType | BarcodeType | Barcode Type verification
 |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Gets or sets Barcode Type verification.

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Gets or sets Barcode Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### CertificateVerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/certificateverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class CertificateVerifyOptions extends VerifyOptions
```

Keeps options to verify certificate documents.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values.
 |
| CertificateVerifyOptions(String subject) | Initializes a new instance of the CertificateVerifyOptions with subject to verify.
 |
#### Methods

| Method | Description |
| --- | --- |
| getIssuer() | Specify Certificate Issuer if it should be verified.
 |
| setIssuer(String value) | Specify Certificate Issuer if it should be verified.
 |
| getSerialNumber() | Specify Certificate Serial Number if it should be verified.
 |
| setSerialNumber(String value) | Specify Certificate Serial Number if it should be verified.
 |
| getSubject() | Specify Certificate subject if it should be verified.
 |
| setSubject(String value) | Specify Certificate subject if it should be verified.
 |
| getThumbprint() | Specify Certificate Thumbprint if it should be verified.
 |
| setThumbprint(String value) | Specify Certificate Thumbprint if it should be verified.
 |
| getMatchType() | Gets or sets Text Match Type verification.
 |
| setMatchType(int value) | Gets or sets Text Match Type verification.
 |
| getExpired() | Indicates if certificate is expired date due validation result.
 |
| setExpired(boolean value) | Indicates if certificate is expired date due validation result.
 |
| getPerformChainValidation() | Get or set if verification process should provide X.509 chain validation using basic validation policy.
 |
| setPerformChainValidation(boolean value) | Get or set if verification process should provide X.509 chain validation using basic validation policy.
 |
| toString() | Overrides conversion to string.
 |
##### CertificateVerifyOptions()
```
public CertificateVerifyOptions()
```

Initializes a new instance of the TextVerifyOptions with default values.

##### CertificateVerifyOptions(String subject)
```
public CertificateVerifyOptions(String subject)
```

Initializes a new instance of the CertificateVerifyOptions with subject to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subject | java.lang.String | Subject to be verified
 |

##### getIssuer()
```
public final String getIssuer()
```

Specify Certificate Issuer if it should be verified.

**Returns:**
java.lang.String
##### setIssuer(String value)
```
public final void setIssuer(String value)
```

Specify Certificate Issuer if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSerialNumber()
```
public final String getSerialNumber()
```

Specify Certificate Serial Number if it should be verified.

**Returns:**
java.lang.String
##### setSerialNumber(String value)
```
public final void setSerialNumber(String value)
```

Specify Certificate Serial Number if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Specify Certificate subject if it should be verified.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Specify Certificate subject if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getThumbprint()
```
public final String getThumbprint()
```

Specify Certificate Thumbprint if it should be verified.

**Returns:**
java.lang.String
##### setThumbprint(String value)
```
public final void setThumbprint(String value)
```

Specify Certificate Thumbprint if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Text Match Type verification.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Text Match Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpired()
```
public final boolean getExpired()
```

Indicates if certificate is expired date due validation result.
Property is read-only.

**Returns:**
boolean
##### setExpired(boolean value)
```
public final void setExpired(boolean value)
```

Indicates if certificate is expired date due validation result.
Property is read-only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPerformChainValidation()
```
public final boolean getPerformChainValidation()
```

Get or set if verification process should provide X.509 chain validation using basic validation policy.
By default this value is true.

**Returns:**
boolean
##### setPerformChainValidation(boolean value)
```
public final void setPerformChainValidation(boolean value)
```

Get or set if verification process should provide X.509 chain validation using basic validation policy.
By default this value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### DigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/digitalverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class DigitalVerifyOptions extends VerifyOptions
```

Keeps options to verify document Digital signature.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalVerifyOptions() | Creates Digital Verification Option with default values.
 |
| DigitalVerifyOptions(String certificateGuid) | Creates Digital Verification Option with given digital certificate guid.
 |
| DigitalVerifyOptions(InputStream certificateStream) | Creates Digital Verification Option with given certificate stream.
 |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Get X509Certificate2 Certificate from Certificate Guid or Stream.
 |
| getPassword() | Password of Digital Certificate if required.
 |
| setPassword(String value) | Password of Digital Certificate if required.
 |
| getCertificateFilePath() | File Guid of Digital Certificate.
 |
| setCertificateFilePath(String value) | File Guid of Digital Certificate.
 |
| getCertificateStream() | Stream of Digital Certificate.
 |
| setCertificateStream(InputStream value) | Stream of Digital Certificate.
 |
| getComments() | Comments of Digital Signature to validate.
 |
| setComments(String value) | Comments of Digital Signature to validate.
 |
| getSignDateTimeFrom() | Date and time range of Digital Signature to validate.
 |
| setSignDateTimeFrom(Date value) | Date and time range of Digital Signature to validate.
 |
| getSignDateTimeTo() | Date and time range of Digital Signature to validate.
 |
| setSignDateTimeTo(Date value) | Date and time range of Digital Signature to validate.
 |
| getReason() | Reason of Digital Signature to validate.
 |
| setReason(String value) | Reason of Digital Signature to validate.
 |
| getContact() | Signature Contact to validate.
 |
| setContact(String value) | Signature Contact to validate.
 |
| getLocation() | Signature Location to validate.
 |
| setLocation(String value) | Signature Location to validate.
 |
| getSubjectName() | Subject distinguished name of the certificate to validate.
 |
| setSubjectName(String value) | Subject distinguished name of the certificate to validate.
 |
| getIssuerName() | Issuer name of the certificate to validate.
 |
| setIssuerName(String value) | Issuer name of the certificate to validate.
 |
##### DigitalVerifyOptions()
```
public DigitalVerifyOptions()
```

Creates Digital Verification Option with default values.

##### DigitalVerifyOptions(String certificateGuid)
```
public DigitalVerifyOptions(String certificateGuid)
```

Creates Digital Verification Option with given digital certificate guid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateGuid | java.lang.String | File path to digital certificate.
 |

##### DigitalVerifyOptions(InputStream certificateStream)
```
public DigitalVerifyOptions(InputStream certificateStream)
```

Creates Digital Verification Option with given certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Certificate's stream.
 |

##### getCertificate()
```
public KeyStore getCertificate()
```

Get X509Certificate2 Certificate from Certificate Guid or Stream.

**Returns:**
java.security.KeyStore
##### getPassword()
```
public final String getPassword()
```

Password of Digital Certificate if required.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password of Digital Certificate if required.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

File Guid of Digital Certificate.

**Returns:**
java.lang.String
##### setCertificateFilePath(String value)
```
public final void setCertificateFilePath(String value)
```

File Guid of Digital Certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Stream of Digital Certificate.

**Returns:**
java.io.InputStream
##### setCertificateStream(InputStream value)
```
public final void setCertificateStream(InputStream value)
```

Stream of Digital Certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getComments()
```
public final String getComments()
```

Comments of Digital Signature to validate.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Comments of Digital Signature to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignDateTimeFrom()
```
public Date getSignDateTimeFrom()
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeFrom(Date value)
```
public void setSignDateTimeFrom(Date value)
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSignDateTimeTo()
```
public Date getSignDateTimeTo()
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeTo(Date value)
```
public void setSignDateTimeTo(Date value)
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getReason()
```
public final String getReason()
```

Reason of Digital Signature to validate.

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

Reason of Digital Signature to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContact()
```
public final String getContact()
```

Signature Contact to validate.

**Returns:**
java.lang.String
##### setContact(String value)
```
public final void setContact(String value)
```

Signature Contact to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Signature Location to validate.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Signature Location to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubjectName()
```
public final String getSubjectName()
```

Subject distinguished name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature subject name contains or equals passed value

**Returns:**
java.lang.String
##### setSubjectName(String value)
```
public final void setSubjectName(String value)
```

Subject distinguished name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature subject name contains or equals passed value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIssuerName()
```
public final String getIssuerName()
```

Issuer name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature's issuer name contains or equals passed value

**Returns:**
java.lang.String
##### setIssuerName(String value)
```
public final void setIssuerName(String value)
```

Issuer name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature's issuer name contains or equals passed value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### QrCodeVerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/qrcodeverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions
```
public class QrCodeVerifyOptions extends TextVerifyOptions
```

Keeps options to verify document QR-code signature.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeVerifyOptions() | Creates verification option QRCodeVerifyOptions for QR-Code Signatures.
 |
| QrCodeVerifyOptions(String text) | Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.
 |
| QrCodeVerifyOptions(String text, QrCodeType encodeType) | Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.
 |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets QR-code Type verification.
 |
| setEncodeType(QrCodeType value) | Gets or sets QR-code Type verification.
 |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.
 |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.
 |
| toString() | Overrides conversion to string.
 |
##### QrCodeVerifyOptions()
```
public QrCodeVerifyOptions()
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures.

##### QrCodeVerifyOptions(String text)
```
public QrCodeVerifyOptions(String text)
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | QR-code Text to verify
 |

##### QrCodeVerifyOptions(String text, QrCodeType encodeType)
```
public QrCodeVerifyOptions(String text, QrCodeType encodeType)
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified
 |
| encodeType | QrCodeType | Type of encoding
 |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Gets or sets QR-code Type verification. This property is optional.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Gets or sets QR-code Type verification. This property is optional.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### TextVerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/textverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class TextVerifyOptions extends VerifyOptions
```

Keeps options to verify document Text signature.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| TextVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values.
 |
| TextVerifyOptions(String text) | Initializes a new instance of the TextVerifyOptions with verification text.
 |
| TextVerifyOptions(String text, int implementation) | Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.
 |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specify Signature Text if it should be verified.
 |
| setText(String value) | Specify Signature Text if it should be verified.
 |
| getMatchType() | Gets or sets Text Match Type verification.
 |
| setMatchType(int value) | Gets or sets Text Match Type verification.
 |
| getSignatureImplementation() | Type of Signature to be verified.
 |
| setSignatureImplementation(int value) | Type of Signature to be verified.
 |
| getFormTextFieldTitle() | Gets or sets the title of form field to verify it.
 |
| setFormTextFieldTitle(String value) | Gets or sets the title of form field to verify it.
 |
| getFormTextFieldType() | Gets or sets the type of form field to verify it.
 |
| setFormTextFieldType(Integer value) | Gets or sets the type of form field to verify it.
 |
| getSignatureID() | Specify Text Signature ID more than zero if it should be verified.
 |
| setSignatureID(int value) | Specify Text Signature ID more than zero if it should be verified.
 |
| toString() | Overrides conversion to string.
 |
##### TextVerifyOptions()
```
public TextVerifyOptions()
```

Initializes a new instance of the TextVerifyOptions with default values.

##### TextVerifyOptions(String text)
```
public TextVerifyOptions(String text)
```

Initializes a new instance of the TextVerifyOptions with verification text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified
 |

##### TextVerifyOptions(String text, int implementation)
```
public TextVerifyOptions(String text, int implementation)
```

Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified.
 |
| implementation | int | Signature Implementation type.
 |

##### getText()
```
public final String getText()
```

Specify Signature Text if it should be verified.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specify Signature Text if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Text Match Type verification.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Text Match Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Type of Signature to be verified.

**Returns:**
int
##### setSignatureImplementation(int value)
```
public final void setSignatureImplementation(int value)
```

Type of Signature to be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormTextFieldTitle()
```
public final String getFormTextFieldTitle()
```

Gets or sets the title of form field to verify it.
If this property set text will be found only in text form fields.

**Returns:**
java.lang.String
##### setFormTextFieldTitle(String value)
```
public final void setFormTextFieldTitle(String value)
```

Gets or sets the title of form field to verify it.
If this property set text will be found only in text form fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFormTextFieldType()
```
public final Integer getFormTextFieldType()
```

Gets or sets the type of form field to verify it.
If this property set text will be found only in text form fields.

**Returns:**
java.lang.Integer
##### setFormTextFieldType(Integer value)
```
public final void setFormTextFieldType(Integer value)
```

Gets or sets the type of form field to verify it.
If this property set text will be found only in text form fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getSignatureID()
```
public final int getSignatureID()
```

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

**Returns:**
int
##### setSignatureID(int value)
```
public final void setSignatureID(int value)
```

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### VerifyOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verify/verifyoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class VerifyOptions
```

Keeps options to verify document.

#### Methods

| Method | Description |
| --- | --- |
| isValid() | Valid property flag.
 |
| setValid(boolean value) | Valid property flag.
 |
| getPageNumber() | Document Page Number to be verified.
 |
| setPageNumber(Integer value) | Document Page Number to be verified.
 |
| getPagesSetup() | Page Options to specify pages to be verified.
 |
| setPagesSetup(PagesSetup value) | Page Options to specify pages to be verified.
 |
| getAllPages() | Flag to verify each document page.
 |
| setAllPages(boolean value) | Flag to verify each document page.
 |
| getExtensions() | Additional extensions for alternative signature options verification.
 |
| setExtensions(VerifyExtensions value) | Additional extensions for alternative signature options verification.
 |
| toString() | Override string conversion.
 |
##### isValid()
```
public final boolean isValid()
```

Valid property flag.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Valid property flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPageNumber()
```
public Integer getPageNumber()
```

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public void setPageNumber(Integer value)
```

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPagesSetup()
```
public PagesSetup getPagesSetup()
```

Page Options to specify pages to be verified.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public void setPagesSetup(PagesSetup value)
```

Page Options to specify pages to be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getAllPages()
```
public final boolean getAllPages()
```

Flag to verify each document page. By default value is true.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public final void setAllPages(boolean value)
```

Flag to verify each document page. By default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getExtensions()
```
public final VerifyExtensions getExtensions()
```

Additional extensions for alternative signature options verification.

**Returns:**
VerifyExtensions
##### setExtensions(VerifyExtensions value)
```
public final void setExtensions(VerifyExtensions value)
```

Additional extensions for alternative signature options verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | VerifyExtensions |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.verifyextensions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verifyextensions.md

The **GroupDocs.Signature.Options.VerifyExtensions** namespace provides classes for working with VerifyExtensions options.

#### Classes

| Class | Description |
| --- | --- |
| PdfTextAnnotationVerifyExtensions | Describes extensions of verification of PDF text annotation object |
| PdfTextStickerVerifyExtensions | Describes extensions of verification of PDF sticker object. |
| VerifyExtensions | Keeps additional verification options for alternative implementations of signature on a document page. |

### PdfTextAnnotationVerifyExtensions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verifyextensions/pdftextannotationverifyextensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verifyextensions.VerifyExtensions
```
public class PdfTextAnnotationVerifyExtensions extends VerifyExtensions
```

Describes extensions of verification of PDF text annotation object

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextAnnotationVerifyExtensions() | Creates PDF text annotation signature verification extensions with empty values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Title of text annotation to be verified.
 |
| setTitle(String value) | Title of text annotation to be verified.
 |
| getSubject() | Subject of text annotation to be verified.
 |
| setSubject(String value) | Subject of text annotation to be verified.
 |
| getContents() | Contents of text annotationn to be verified.
 |
| setContents(String value) | Contents of text annotationn to be verified.
 |
| toString() | Override string conversion.
 |
##### PdfTextAnnotationVerifyExtensions()
```
public PdfTextAnnotationVerifyExtensions()
```

Creates PDF text annotation signature verification extensions with empty values.

##### getTitle()
```
public final String getTitle()
```

Title of text annotation to be verified.
Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Title of text annotation to be verified.
Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Subject of text annotation to be verified.
Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Subject of text annotation to be verified.
Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Contents of text annotationn to be verified.
Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Contents of text annotationn to be verified.
Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfTextStickerVerifyExtensions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verifyextensions/pdftextstickerverifyextensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verifyextensions.VerifyExtensions
```
public final class PdfTextStickerVerifyExtensions extends VerifyExtensions
```

Describes extensions of verification of PDF sticker object.

#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextStickerVerifyExtensions() | Creates PDF text sticker signature verification extensions with empty values.
 |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Title of sticker to be verified.
 |
| setTitle(String value) | Title of sticker to be verified.
 |
| getSubject() | Subject of sticker to be verified.
 |
| setSubject(String value) | Subject of sticker to be verified.
 |
| getContents() | Contents of sticker to be verified.
 |
| setContents(String value) | Contents of sticker to be verified.
 |
| getIcon() | Icon of sticker to be verified.
 |
| setIcon(Integer value) | Icon of sticker to be verified.
 |
| toString() | Override string conversion
 |
##### PdfTextStickerVerifyExtensions()
```
public PdfTextStickerVerifyExtensions()
```

Creates PDF text sticker signature verification extensions with empty values.

##### getTitle()
```
public final String getTitle()
```

Title of sticker to be verified.
Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Title of sticker to be verified.
Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Subject of sticker to be verified.
Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Subject of sticker to be verified.
Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Contents of sticker to be verified.
Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Contents of sticker to be verified.
Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIcon()
```
public final Integer getIcon()
```

Icon of sticker to be verified.
Value will not be verified if equals null.

**Returns:**
java.lang.Integer
##### setIcon(Integer value)
```
public final void setIcon(Integer value)
```

Icon of sticker to be verified.
Value will not be verified if equals null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### VerifyExtensions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.verifyextensions/verifyextensions.md

**Inheritance:**
java.lang.Object
```
public abstract class VerifyExtensions
```

Keeps additional verification options for alternative implementations of signature on a document page.

#### Constructors

| Constructor | Description |
| --- | --- |
| VerifyExtensions() | Creates default Verify Extensions.
 |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Override string conversion.
 |
##### VerifyExtensions()
```
public VerifyExtensions()
```

Creates default Verify Extensions.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options.md

The **GroupDocs.Signature.Options** namespace provides classes to specify additional options when loading, signing, verifyin, searching and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| PagesSetup | Describes special document pages to work with. |
| PreviewSignatureFormats |  |
| PreviewSignatureOptions | Represents signature preview options. |

#### Interfaces

| Interface | Description |
| --- | --- |
| PageSignatureStreamFactory |  |
| PageStreamFactory |  |

### PageSignatureStreamFactory
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options/pagesignaturestreamfactory.md

### PagesSetup
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options/pagessetup.md

**Inheritance:**
java.lang.Object
```
public class PagesSetup
```

Describes special document pages to work with.

#### Constructors

| Constructor | Description |
| --- | --- |
| PagesSetup() | Creates PagesSetup with default options.
 |
#### Methods

| Method | Description |
| --- | --- |
| getFirstPage() | Gets or sets flag to use first document page.
 |
| setFirstPage(boolean value) | Gets or sets flag to use first document page.
 |
| getLastPage() | Gets or sets flag to use last document page.
 |
| setLastPage(boolean value) | Gets or sets flag to use last document page.
 |
| getOddPages() | Gets or sets flag to use odd pages of document.
 |
| setOddPages(boolean value) | Gets or sets flag to use odd pages of document.
 |
| getEvenPages() | Gets or sets flag to use even pages of document.
 |
| setEvenPages(boolean value) | Gets or sets flag to use even pages of document.
 |
| getPageNumbers() | Set arbitrary pages of document to use.
 |
| setPageNumbers(List<Integer> value) | Set arbitrary pages of document to use.
 |
| toString() | Overrides conversion to string.
 |
##### PagesSetup()
```
public PagesSetup()
```

Creates PagesSetup with default options.

##### getFirstPage()
```
public final boolean getFirstPage()
```

Gets or sets flag to use first document page.

**Returns:**
boolean
##### setFirstPage(boolean value)
```
public final void setFirstPage(boolean value)
```

Gets or sets flag to use first document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLastPage()
```
public final boolean getLastPage()
```

Gets or sets flag to use last document page.

**Returns:**
boolean
##### setLastPage(boolean value)
```
public final void setLastPage(boolean value)
```

Gets or sets flag to use last document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOddPages()
```
public final boolean getOddPages()
```

Gets or sets flag to use odd pages of document.

**Returns:**
boolean
##### setOddPages(boolean value)
```
public final void setOddPages(boolean value)
```

Gets or sets flag to use odd pages of document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEvenPages()
```
public final boolean getEvenPages()
```

Gets or sets flag to use even pages of document.

**Returns:**
boolean
##### setEvenPages(boolean value)
```
public final void setEvenPages(boolean value)
```

Gets or sets flag to use even pages of document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPageNumbers()
```
public final List<Integer> getPageNumbers()
```

Set arbitrary pages of document to use.

**Returns:**
java.util.List<java.lang.Integer>
##### setPageNumbers(List<Integer> value)
```
public final void setPageNumbers(List<Integer> value)
```

Set arbitrary pages of document to use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.Integer> |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### PageStreamFactory
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options/pagestreamfactory.md

### PreviewSignatureFormats
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options/previewsignatureformats.md

**Inheritance:**
java.lang.Object
```
public class PreviewSignatureFormats
```
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewSignatureFormats() |  |
#### Fields

| Field | Description |
| --- | --- |
| PNG | PNG
 |
| JPEG | JPEG
 |
| BMP | BMP
 |
| GIF | GIF
 |
| SVG | SVG
 |
#### Methods

| Method | Description |
| --- | --- |
| toExtension(int id) | To extension string.
 |
##### PreviewSignatureFormats()
```
public PreviewSignatureFormats()
```

##### PNG
```
public static final int PNG
```

PNG

##### JPEG
```
public static final int JPEG
```

JPEG

##### BMP
```
public static final int BMP
```

BMP

##### GIF
```
public static final int GIF
```

GIF

##### SVG
```
public static final int SVG
```

SVG

##### toExtension(int id)
```
public static String toExtension(int id)
```

To extension string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int |  |

**Returns:**
java.lang.String - the string

### PreviewSignatureOptions
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.options/previewsignatureoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewSignatureOptions
```

Represents signature preview options.

#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory) | Initializes PreviewSignatureOptions object.
 |
#### Methods

| Method | Description |
| --- | --- |
| getSignatureId() | Unique value to distinct the signature.
 |
| setSignatureId(String value) | Unique value to distinct the signature.
 |
| getSignOptions() | Signature Options for generate preview.
 |
| setSignOptions(SignOptions value) | Signature Options for generate preview.
 |
| getPreviewFormat() | Gets or sets preview images format.
 |
| setPreviewFormat(int value) | Gets or sets preview images format.
 |
##### PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
```
public PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
```

Initializes PreviewSignatureOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions | The signature options to generate preview for.
 |
| pageStreamFactory | PageSignatureStreamFactory | Interface which defines method to create output page preview stream.
 |

##### getSignatureId()
```
public final String getSignatureId()
```

Unique value to distinct the signature.
Use SignatureId to identify the preview options.

**Returns:**
java.lang.String
##### setSignatureId(String value)
```
public final void setSignatureId(String value)
```

Unique value to distinct the signature.
Use SignatureId to identify the preview options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignOptions()
```
public final SignOptions getSignOptions()
```

Signature Options for generate preview.

**Returns:**
SignOptions
##### setSignOptions(SignOptions value)
```
public final void setSignOptions(SignOptions value)
```

Signature Options for generate preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignOptions |  |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Gets or sets preview images format.
Default value is PNG

**Returns:**
int
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Gets or sets preview images format.
Default value is PNG

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.signature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature.md

The **GroupDocs.Signature** namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.

#### Classes

| Class | Description |
| --- | --- |
| Signature | Represents main class that controls document signing process. |
| SignatureSettings | Defines settings for customizing Signature behavior. |

### Signature
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature/signature.md

**Inheritance:**
java.lang.Object
```
public class Signature
```

Represents main class that controls document signing process.

<br />

*** ** * ** ***

<br />

#### Constructors

| Constructor | Description |
| --- | --- |
| Signature(InputStream document) | Initializes new instance of Signature class with document provided by stream.
 |
| Signature(InputStream document, LoadOptions loadOptions) | Initializes new instance of Signature class with document provided by stream and load options
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).
 |
| Signature(InputStream document, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by stream and SignatureSettings.
 |
| Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by stream, load options
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and settings SignatureSettings.
 |
| Signature(String filePath) | Initializes new instance of Signature class instance with document provided by file path.
 |
| Signature(String filePath, LoadOptions loadOptions) | Initializes new instance of Signature class instance with document provided by file path and
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).
 |
| Signature(String filePath, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by file path and SignatureSettings.
 |
| Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by file path,
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and SignatureSettings.
 |
#### Methods

| Method | Description |
| --- | --- |
| sign(OutputStream document, SignOptions signOptions) | Signs document with SignOptions and saves result to a stream.
 |
| sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions) | Signs document with SignOptions and saves result to a stream with predefined SaveOptions.
 |
| sign(OutputStream document, List<SignOptions> signOptionsList) | Signs document with collection of SignOptions and saves result to a stream.
 |
| sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions) | Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions.
 |
| sign(String filePath, SignOptions signOptions) | Signs document with SignOptions and saves result to specified file path.
 |
| sign(String filePath, SignOptions signOptions, SaveOptions saveOptions) | Signs document with SignOptions and saves result to specified file path with predefined SaveOptions.
 |
| sign(String filePath, List<SignOptions> signOptionsList) | Signs document with collection of SignOptions and saves result to specified file path.
 |
| sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions) | Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions.
 |
| verify(VerifyOptions verifyOptions) | Verifies the document signatures with given VerifyOptions data.
 |
| verify(List<VerifyOptions> verifyOptionsList) | Verifies the document signatures with list of VerifyOptions data.
 |
| verify(VerifyOptions verifyOptions, Predicate<BaseSignature> predicate) | Verifies the document signatures using the provided verification options and filters
the succeeded results by the specified predicate.
 |
| verify(List<VerifyOptions> verifyOptionsList, Predicate<BaseSignature> predicate) | Verifies the document signatures using a list of verification options and filters the
succeeded results by the specified predicate.
 |
| getDocumentInfo() | Gets information about document pages: their sizes,
maximum page height, the width of a page with the maximum height.
 |
| generatePreview(PreviewOptions previewOptions) | Generates document pages preview.
 |
| search(List<SearchOptions> searchOptionsList) | Searches for signatures in a document by SearchOptions list.
 |
| search(List<SearchOptions> searchOptionsList, Predicate<BaseSignature> predicate) | Searches for signatures by a list of options and filters the result by a predicate.
 |
| <T>search(Class<T> typeOfT, SearchOptions searchOptions) | Searches for signatures in a document by SearchOptions options.
 |
| <T>search(Class<T> typeOfT, SearchOptions searchOptions, Predicate<T> predicate) | Searches for signatures of the specified type in the document, optionally filtered by a predicate.
 |
| <T>search(Class<T> typeOfT, int signatureType) | Searches for exact type of signatures in the document by SignatureType value.
 |
| search(int[] signatureTypes) | Searches for specified signature types in the document by SignatureType value.
 |
| update(OutputStream document, BaseSignature signature) | Updates passed signature BaseSignature in the document.
 |
| update(OutputStream document, List<BaseSignature> signatures) | Updates passed signatures BaseSignature in the document.
 |
| update(String filePath, List<BaseSignature> signatures) | Updates passed signatures BaseSignature in the document.
 |
| update(String filePath, BaseSignature signature) | Updates passed signatures BaseSignature in the document.
 |
| delete(OutputStream document, BaseSignature signature) | Deletes passed signature BaseSignature from the document.
 |
| delete(OutputStream document, List<BaseSignature> signatures) | Deletes passed list of signatures BaseSignature from the document.
 |
| delete(String filePath, BaseSignature signature) | Deletes passed signature BaseSignature from the document.
 |
| delete(String filePath, List<BaseSignature> signatures) | Deletes passed list of signatures BaseSignature from the document.
 |
| delete(OutputStream document, int signatureType) | Deletes signatures of the certain type SignatureType from the document.
 |
| deleteByTypes(OutputStream document, List<Integer> signatureTypes) | Deletes the signatures of the certain types list SignatureType from the document.
 |
| delete(String filePath, int signatureType) | Deletes signatures of the certain type SignatureType from the document.
 |
| deleteByTypes(String filePath, List<Integer> signatureTypes) | Deletes the signatures of the certain types list SignatureType from the document.
 |
| delete(String signatureId) | Deletes signature by its specific signature Id from the document.
 |
| delete(List<String> signatureIds) | Deletes passed list of signatures BaseSignature from the document.
 |
| generateSignaturePreview(PreviewSignatureOptions previewOptions) | Generates Signature preview based on given SignOptions.
 |
| dispose() | Implement IDisposable interface to clean up internal resources
 |
##### Signature(InputStream document)
```
public Signature(InputStream document)
```

Initializes new instance of Signature class with document provided by stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream.

<br />

*** ** * ** ***

<br />

 |

##### Signature(InputStream document, LoadOptions loadOptions)
```
public Signature(InputStream document, LoadOptions loadOptions)
```

Initializes new instance of Signature class with document provided by stream and load options
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream.
 |
| loadOptions | LoadOptions | The document load options.

<br />

*** ** * ** ***

<br />

 |

##### Signature(InputStream document, SignatureSettings settings)
```
public Signature(InputStream document, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by stream and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream.
 |
| settings | SignatureSettings | The signature settings.

<br />

*** ** * ** ***

<br />

 |

##### Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings)
```
public Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by stream, load options
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and settings SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream.
 |
| loadOptions | LoadOptions | The document load options.
 |
| settings | SignatureSettings | The signature settings.

<br />

*** ** * ** ***

<br />

 |

##### Signature(String filePath)
```
public Signature(String filePath)
```

Initializes new instance of Signature class instance with document provided by file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path.

<br />

*** ** * ** ***

<br />

 |

##### Signature(String filePath, LoadOptions loadOptions)
```
public Signature(String filePath, LoadOptions loadOptions)
```

Initializes new instance of Signature class instance with document provided by file path and
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path.
 |
| loadOptions | LoadOptions | The document load options.

<br />

*** ** * ** ***

<br />

 |

##### Signature(String filePath, SignatureSettings settings)
```
public Signature(String filePath, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by file path and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path.
 |
| settings | SignatureSettings | The signature settings.

<br />

*** ** * ** ***

<br />

 |

##### Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings)
```
public Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by file path,
LoadOptions
(#getLoadOptions.getLoadOptions/#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path.
 |
| loadOptions | LoadOptions | The document load options.
 |
| settings | SignatureSettings | The signature settings.

<br />

*** ** * ** ***

<br />

 |

##### sign(OutputStream document, SignOptions signOptions)
```
public final SignResult sign(OutputStream document, SignOptions signOptions)
```

Signs document with SignOptions and saves result to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signOptions | SignOptions | The signature options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions)
```
public final SignResult sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions)
```

Signs document with SignOptions and saves result to a stream with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signOptions | SignOptions | The signature options.
 |
| saveOptions | SaveOptions | The save options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(OutputStream document, List<SignOptions> signOptionsList)
```
public final SignResult sign(OutputStream document, List<SignOptions> signOptionsList)
```

Signs document with collection of SignOptions and saves result to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```
public final SignResult sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.
 |
| saveOptions | SaveOptions | The save options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(String filePath, SignOptions signOptions)
```
public final SignResult sign(String filePath, SignOptions signOptions)
```

Signs document with SignOptions and saves result to specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signOptions | SignOptions | The signature options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(String filePath, SignOptions signOptions, SaveOptions saveOptions)
```
public final SignResult sign(String filePath, SignOptions signOptions, SaveOptions saveOptions)
```

Signs document with SignOptions and saves result to specified file path with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signOptions | SignOptions | The signature options.
 |
| saveOptions | SaveOptions | The save options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### sign(String filePath, List<SignOptions> signOptionsList)
```
public final SignResult sign(String filePath, List<SignOptions> signOptionsList)
```

Signs document with collection of SignOptions and saves result to specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult -
##### sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```
public final SignResult sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.
 |
| saveOptions | SaveOptions | The save options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.

##### verify(VerifyOptions verifyOptions)
```
public final VerificationResult verify(VerifyOptions verifyOptions)
```

Verifies the document signatures with given VerifyOptions data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptions | VerifyOptions | The signature verification options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
VerificationResult - Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.

##### verify(List<VerifyOptions> verifyOptionsList)
```
public final VerificationResult verify(List<VerifyOptions> verifyOptionsList)
```

Verifies the document signatures with list of VerifyOptions data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptionsList | java.util.List<com.groupdocs.signature.options.verify.VerifyOptions> | The signature verification options collection. Instance of VerifyOptionsCollection.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
VerificationResult - Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.

##### verify(VerifyOptions verifyOptions, Predicate<BaseSignature> predicate)
```
public final List<BaseSignature> verify(VerifyOptions verifyOptions, Predicate<BaseSignature> predicate)
```

Verifies the document signatures using the provided verification options and filters
the succeeded results by the specified predicate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptions | VerifyOptions | The signature verification options.
 |
| predicate | java.util.function.Predicate<com.groupdocs.signature.domain.signatures.BaseSignature> | Filter predicate applied on the list of verified signatures.
 |

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> - List of signatures that succeeded verification and satisfied the predicate.

##### verify(List<VerifyOptions> verifyOptionsList, Predicate<BaseSignature> predicate)
```
public final List<BaseSignature> verify(List<VerifyOptions> verifyOptionsList, Predicate<BaseSignature> predicate)
```

Verifies the document signatures using a list of verification options and filters the
succeeded results by the specified predicate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptionsList | java.util.List<com.groupdocs.signature.options.verify.VerifyOptions> | The signature verification options list.
 |
| predicate | java.util.function.Predicate<com.groupdocs.signature.domain.signatures.BaseSignature> | Filter predicate applied on the list of verified signatures.
 |

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> - List of signatures that succeeded verification and satisfied the predicate.

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about document pages: their sizes,
maximum page height, the width of a page with the maximum height.

**Returns:**
IDocumentInfo - Information about document.

<br />

*** ** * ** ***

<br />

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Generates document pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The preview options.

<br />

*** ** * ** ***

<br />

 |

##### search(List<SearchOptions> searchOptionsList)
```
public final SearchResult search(List<SearchOptions> searchOptionsList)
```

Searches for signatures in a document by SearchOptions list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchOptionsList | java.util.List<com.groupdocs.signature.options.search.SearchOptions> | The search options collection.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SearchResult - Returns instance of SearchResult with list of found Signatures.

##### search(List<SearchOptions> searchOptionsList, Predicate<BaseSignature> predicate)
```
public final SearchResult search(List<SearchOptions> searchOptionsList, Predicate<BaseSignature> predicate)
```

Searches for signatures by a list of options and filters the result by a predicate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchOptionsList | java.util.List<com.groupdocs.signature.options.search.SearchOptions> | The list of search options.
 |
| predicate | java.util.function.Predicate<com.groupdocs.signature.domain.signatures.BaseSignature> | Predicate used to filter the resulting signatures.
 |

**Returns:**
SearchResult - SearchResult containing only signatures that match the predicate.

##### <T>search(Class<T> typeOfT, SearchOptions searchOptions)
```
public final List<T> <T>search(Class<T> typeOfT, SearchOptions searchOptions)
```

Searches for signatures in a document by SearchOptions options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| searchOptions | SearchOptions | The search options.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
java.util.List<T> - Returns the list of signatures found.

##### <T>search(Class<T> typeOfT, SearchOptions searchOptions, Predicate<T> predicate)
```
public final List<T> <T>search(Class<T> typeOfT, SearchOptions searchOptions, Predicate<T> predicate)
```

Searches for signatures of the specified type in the document, optionally filtered by a predicate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> | Generic type parameter of BaseSignature.
 |
| searchOptions | SearchOptions | Options for signature search.
 |
| predicate | java.util.function.Predicate<T> | Optional predicate filter applied after the search. May be  null .
 |

**Returns:**
java.util.List<T> - List of found signatures, optionally filtered by the predicate.

##### <T>search(Class<T> typeOfT, int signatureType)
```
public final List<T> <T>search(Class<T> typeOfT, int signatureType)
```

Searches for exact type of signatures in the document by SignatureType value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| signatureType | int | The type of signatures to search.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
java.util.List<T> - Returns the list of found signatures with exact type.

##### search(int[] signatureTypes)
```
public final SearchResult search(int[] signatureTypes)
```

Searches for specified signature types in the document by SignatureType value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureTypes | int[] | One or several types of signatures to find.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
SearchResult - Returns instance of SearchResult with list of found signatures.

##### update(OutputStream document, BaseSignature signature)
```
public final boolean update(OutputStream document, BaseSignature signature)
```

Updates passed signature BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signature | BaseSignature | Signature object to be updated in the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
boolean - Returns true if operation was successful.

##### update(OutputStream document, List<BaseSignature> signatures)
```
public final UpdateResult update(OutputStream document, List<BaseSignature> signatures)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to update in the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
UpdateResult - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.

##### update(String filePath, List<BaseSignature> signatures)
```
public final UpdateResult update(String filePath, List<BaseSignature> signatures)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to update in the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
UpdateResult - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.

##### update(String filePath, BaseSignature signature)
```
public final boolean update(String filePath, BaseSignature signature)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signature | BaseSignature | Signature object to be updated in the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
boolean - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.

##### delete(OutputStream document, BaseSignature signature)
```
public final boolean delete(OutputStream document, BaseSignature signature)
```

Deletes passed signature BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signature | BaseSignature | Signature object to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
boolean - Returns true if operation was successful.

##### delete(OutputStream document, List<BaseSignature> signatures)
```
public final DeleteResult delete(OutputStream document, List<BaseSignature> signatures)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to remove from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### delete(String filePath, BaseSignature signature)
```
public final boolean delete(String filePath, BaseSignature signature)
```

Deletes passed signature BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signature | BaseSignature | Signature object to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
boolean - Returns true if operation was successful.

##### delete(String filePath, List<BaseSignature> signatures)
```
public final DeleteResult delete(String filePath, List<BaseSignature> signatures)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to remove from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### delete(OutputStream document, int signatureType)
```
public final DeleteResult delete(OutputStream document, int signatureType)
```

Deletes signatures of the certain type SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures
BaseSignature.isSignature()
(BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signatureType | int | The type of signatures to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### deleteByTypes(OutputStream document, List<Integer> signatureTypes)
```
public final DeleteResult deleteByTypes(OutputStream document, List<Integer> signatureTypes)
```

Deletes the signatures of the certain types list SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures
BaseSignature.isSignature()
(BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream.
 |
| signatureTypes | java.util.List<java.lang.Integer> | The list of signatures types to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### delete(String filePath, int signatureType)
```
public final DeleteResult delete(String filePath, int signatureType)
```

Deletes signatures of the certain type SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures
BaseSignature.isSignature()
(BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signatureType | int | The type of signatures to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### deleteByTypes(String filePath, List<Integer> signatureTypes)
```
public final DeleteResult deleteByTypes(String filePath, List<Integer> signatureTypes)
```

Deletes the signatures of the certain types list SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures
BaseSignature.isSignature()
(BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path.
 |
| signatureTypes | java.util.List<java.lang.Integer> | The list of signatures types to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### delete(String signatureId)
```
public final boolean delete(String signatureId)
```

Deletes signature by its specific signature Id from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | The Id of the signature to be removed from the document.

<br />

*** ** * ** ***

<br />

 |

**Returns:**
boolean - Returns true if operation was successful.

##### delete(List<String> signatureIds)
```
public final DeleteResult delete(List<String> signatureIds)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureIds | java.util.List<java.lang.String> | List of the identifiers of the signatures to be removed from the document.

<br />

*** ** * ** ***

**Learn more** /// /// /// More about how to delete electronic signature from document in Java: /// How to delete eSignature from document with GroupDocs.Signature /// /// /// Advanced use cases of deleting document eSignatures: /// How to delete different types of eSignatures from document in C# /// /// ///
 |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.

##### generateSignaturePreview(PreviewSignatureOptions previewOptions)
```
public static void generateSignaturePreview(PreviewSignatureOptions previewOptions)
```

Generates Signature preview based on given SignOptions. SignOptions

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewSignatureOptions | The preview signature with given SignOptions. PreviewSignatureOptions

<br />

*** ** * ** ***

 |

##### dispose()
```
public final void dispose()
```

Implement IDisposable interface to clean up internal resources

### SignatureSettings
Path: https://reference.groupdocs.com/signature/java/com.groupdocs.signature/signaturesettings.md

**Inheritance:**
java.lang.Object
```
public class SignatureSettings
```

Defines settings for customizing Signature behavior.

#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureSettings() | Creates default SignatureSettings instance with default values.
 |
| SignatureSettings(ILogger logger) | Creates default SignatureSettings instance with the Logger implementation.
 |
#### Methods

| Method | Description |
| --- | --- |
| getDefaultCulture() | Gets or sets default culture to be used during document processing.
 |
| setDefaultCulture(Locale value) | Gets or sets default culture to be used during document processing.
 |
| getShowDeletedSiganturesInfo() | Gets or sets flag that includes deleted signatures into Document Info result.
 |
| setShowDeletedSiganturesInfo(boolean value) | Gets or sets flag that includes deleted signatures into Document Info result.
 |
| getSaveDocumentOnEmptyUpdate() | Gets or sets flag to resave source document when Update method has no signatures to update.
 |
| setSaveDocumentOnEmptyUpdate(boolean value) | Gets or sets flag to resave source document when Update method has no signatures to update.
 |
| getSaveDocumentOnEmptyDelete() | Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
 |
| setSaveDocumentOnEmptyDelete(boolean value) | Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
 |
| getIncludeStandardMetadataSignatures() | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
 |
| setIncludeStandardMetadataSignatures(boolean value) | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
 |
| getLogger() | The logger implementation used for logging (Errors, Warnings, Traces).
 |
| getLogLevel() | The level of the logging to limit the messages (All, Traces, Warnings, Errors).
 |
| setLogLevel(int value) | The level of the logging to limit the messages (All, Traces, Warnings, Errors).
 |
##### SignatureSettings()
```
public SignatureSettings()
```

Creates default SignatureSettings instance with default values.

##### SignatureSettings(ILogger logger)
```
public SignatureSettings(ILogger logger)
```

Creates default SignatureSettings instance with the Logger implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger |  |

##### getDefaultCulture()
```
public static Locale getDefaultCulture()
```

Gets or sets default culture to be used during document processing. Default value is "en-US".

**Returns:**
java.util.Locale
##### setDefaultCulture(Locale value)
```
public final void setDefaultCulture(Locale value)
```

Gets or sets default culture to be used during document processing. Default value is "en-US".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Locale |  |

##### getShowDeletedSiganturesInfo()
```
public final boolean getShowDeletedSiganturesInfo()
```

Gets or sets flag that includes deleted signatures into Document Info result.
Each Signature BaseSignature has Deleted flag
BaseSignature.Deleted
(BaseSignature.getDeleted/BaseSignature.setDeleted(boolean)) to detect if it was deleted.

**Returns:**
boolean
##### setShowDeletedSiganturesInfo(boolean value)
```
public final void setShowDeletedSiganturesInfo(boolean value)
```

Gets or sets flag that includes deleted signatures into Document Info result.
Each Signature BaseSignature has Deleted flag
BaseSignature.Deleted
(BaseSignature.getDeleted/BaseSignature.setDeleted(boolean)) to detect if it was deleted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSaveDocumentOnEmptyUpdate()
```
public final boolean getSaveDocumentOnEmptyUpdate()
```

Gets or sets flag to resave source document when Update method has no signatures to update.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update.
When this flat is set to false source document will not be modified at all.

**Returns:**
boolean
##### setSaveDocumentOnEmptyUpdate(boolean value)
```
public final void setSaveDocumentOnEmptyUpdate(boolean value)
```

Gets or sets flag to resave source document when Update method has no signatures to update.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update.
When this flat is set to false source document will not be modified at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSaveDocumentOnEmptyDelete()
```
public final boolean getSaveDocumentOnEmptyDelete()
```

Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove.
When this flat is set to false source document will not be modified at all.

**Returns:**
boolean
##### setSaveDocumentOnEmptyDelete(boolean value)
```
public final void setSaveDocumentOnEmptyDelete(boolean value)
```

Gets or sets flag to resave source document when Delete method has no affected signatures to remove.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove.
When this flat is set to false source document will not be modified at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getIncludeStandardMetadataSignatures()
```
public final boolean getIncludeStandardMetadataSignatures()
```

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures.
When this flag is set to true the document information will include these standard metadata signatures.

**Returns:**
boolean
##### setIncludeStandardMetadataSignatures(boolean value)
```
public final void setIncludeStandardMetadataSignatures(boolean value)
```

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures.
When this flag is set to true the document information will include these standard metadata signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for logging (Errors, Warnings, Traces). ILogger.

**Returns:**
ILogger
##### getLogLevel()
```
public final int getLogLevel()
```

The level of the logging to limit the messages (All, Traces, Warnings, Errors).
LogLevel
.
BY default the All level type is set.

**Returns:**
int
##### setLogLevel(int value)
```
public final void setLogLevel(int value)
```

The level of the logging to limit the messages (All, Traces, Warnings, Errors).
LogLevel
.
BY default the All level type is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

## .NET

### GroupDocs.Signature for .NET
Path: https://reference.groupdocs.com/signature/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Signature | The namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures. |
| GroupDocs.Signature.Domain | The namespace provides classes for working with document representation. |
| GroupDocs.Signature.Domain.Extensions | The namespace provides extensions for signature appearances and additional functionality. |
| GroupDocs.Signature.Logging | The namespace provides classes for logging purposes. |
| GroupDocs.Signature.Options | The namespace provides classes to specify additional options when loading, signing, verifying, searching and saving documents. |
| GroupDocs.Signature.Options.Appearances | The namespace provides classes for additional signature appearances. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### GroupDocs.Signature.Domain.Extensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions.md

The namespace provides extensions for signature appearances and additional functionality.

#### Classes

| Class | Description |
| --- | --- |
| Address | Represents address for contact. |
| Brush | Represents base class for various brushes. |
| CryptoCurrencyTransfer | Represents Cryptocurrency transfer (receive or send) for QR-Code. |
| DigitalVBA | Represents digital signature for Spreadsheets VBA projects. It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm. If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing. |
| Email | Represents Email format for QR-Code. |
| EPC | Represents European Payments Council Quick Response Code. |
| Event | Represents standard QR-Code Event details. |
| FormatAttribute | Instructs objects serialization to serialize the member with the specified name and format |
| HIBCLICCombinedData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities. |
| HIBCLICPrimaryData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data. |
| HIBCLICSecondaryAdditionalData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data. |
| HIBCPASData | Class for encoding and decoding the text embedded in the HIBC PAS code. |
| HIBCPASRecord | Class for storing HIBC (Healthcare Industry Bar Code Council) PAS (Provider Applications Standard) Record |
| LinearGradientBrush | Represents linear gradient brush. |
| Mailmark2D | Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark |
| MaxiCodeMode2 | Class for encoding and decoding the text embedded in the MaxiCode code for modes |
| MaxiCodeSecondMessage | Class for encoding and decoding standart second message for MaxiCode barcode. |
| MeCard | Represents MeCard standard contact details. |
| RadialGradientBrush | Represents radial gradient brush. |
| SignatureExtension | Represents base class for signatures extensions. |
| SkipSerializationAttribute | Instructs the serialization to skip the member. |
| SMS | Represents SMS short message service details. |
| SolidBrush | Represents solid brush. It could be used instead background color property. |
| SpreadsheetPosition | Defines signature position for Spreadsheet documents. |
| SwissAddress | Represents the address of the creditor or debtor. You can either set street, house number, postal code, and town (structured address type) or address line 1 and 2 (combined address elements type). |
| SwissQR | Class for encoding and decoding the text embedded in the SwissQR code. |
| SymmetricEncryption | Implements standard symmetric algorithms for data encryption with single key and passphrase (salt). |
| SymmetricEncryptionAttribute | Instructs instances serialization to encrypt / decrypt object serialization string. |
| TextShadow | Represents text shadow properties for text signatures. The result may vary depending on the signature type and document format. TextShadow is recommended for using with TextAsImage signature for all supported document types, also with simple TextSignature and TextSignature as watermark for Spreadsheets (.xslx) and Presentations (.pptx). Simple TextSignature for Words (.docx) is recommended too, but has limited functionality. |
| TextureBrush | Represents texture brush. |
| VCard | Represents Electronic Business Card standard contact details. |
| WiFi | Represents WiFi network connection details. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDataEncryption | Encryption interface to provide object encoding and decoding methods. |
| IDataSerializer | Serialization interface to provide object serialization and deserialization methods. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| CryptoCurrencyType | Represents Cryptocurrency type. |
| DataMatrixEncodeMode | DataMatrix encoder's encoding mode, default to Auto |
| HIBCLICDateFormat | Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code). |
| HIBCPASDataLocation | Specifies HIBC PAS data location types. HIBC - Healthcare Industry Bar Code PAS - Provider Applications Standard |
| HIBCPASDataType | Specifies the different data types of HIBC PAS record. HIBC - Healthcare Industry Bar Code PAS - Provider Applications Standard |
| Mailmark2DType | 2D Mailmark Type defines size of Data Matrix barcode |
| SymmetricAlgorithmType | Represents symmetric encryption algorithm type. |
| WiFiEncryptionType | Represents WiFi Encryption type. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### Address
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address.md

#### Address class

Represents address for contact.

```csharp
public sealed class Address
```

#### Constructors

| Name | Description |
| --- | --- |
| Address() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| City { get; set; } | Gets or sets address city. |
| Country { get; set; } | Gets or sets address country. |
| State { get; set; } | Gets or sets address state. |
| Street { get; set; } | Gets or sets address street. |
| ZIP { get; set; } | Gets or sets address ZIP. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare Address properties |
| override GetHashCode() | Overrides GetHashCode method |

### Address
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/address.md

#### Address constructor

The default constructor.

```csharp
public Address()
```

### City
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/city.md

#### Address.City property

Gets or sets address city.

```csharp
public string City { get; set; }
```

### Country
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/country.md

#### Address.Country property

Gets or sets address country.

```csharp
public string Country { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/equals.md

#### Address.Equals method

Overwrites Equals method to compare Address properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Address object to compare with. |

##### Return Value

Returns true if passed address object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/gethashcode.md

#### Address.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Email hash code

### State
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/state.md

#### Address.State property

Gets or sets address state.

```csharp
public string State { get; set; }
```

### Street
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/street.md

#### Address.Street property

Gets or sets address street.

```csharp
public string Street { get; set; }
```

### ZIP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/address/zip.md

#### Address.ZIP property

Gets or sets address ZIP.

```csharp
public string ZIP { get; set; }
```

### Brush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/brush.md

#### Brush class

Represents base class for various brushes.

```csharp
public abstract class Brush
```

### CryptoCurrencyTransfer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer.md

#### CryptoCurrencyTransfer class

Represents Cryptocurrency transfer (receive or send) for QR-Code.

```csharp
public class CryptoCurrencyTransfer
```

#### Constructors

| Name | Description |
| --- | --- |
| CryptoCurrencyTransfer() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Address { get; set; } | Gets or sets cryptocurrency public address. |
| Amount { get; set; } | Gets or sets transfer amount. |
| CustomType { get; set; } | Gets or sets optional transfer message. |
| Message { get; set; } | Gets or sets optional transfer message. |
| Type { get; set; } | Gets or sets one of supported cryptocurrency type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare Cryptocurrency transfer properties |
| override GetHashCode() | Overrides GetHashCode method |

### Address
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/address.md

#### CryptoCurrencyTransfer.Address property

Gets or sets cryptocurrency public address.

```csharp
public string Address { get; set; }
```

### Amount
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/amount.md

#### CryptoCurrencyTransfer.Amount property

Gets or sets transfer amount.

```csharp
public decimal Amount { get; set; }
```

### CryptoCurrencyTransfer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/cryptocurrencytransfer.md

#### CryptoCurrencyTransfer constructor

The default constructor.

```csharp
public CryptoCurrencyTransfer()
```

### CustomType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/customtype.md

#### CryptoCurrencyTransfer.CustomType property

Gets or sets optional transfer message.

```csharp
public string CustomType { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/equals.md

#### CryptoCurrencyTransfer.Equals method

Overwrites Equals method to compare Cryptocurrency transfer properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Cryptocurrency transfer object to compare with. |

##### Return Value

Returns true if passed Cryptocurrency transfer object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/gethashcode.md

#### CryptoCurrencyTransfer.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Cryptocurrency transfer hash code

### Message
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/message.md

#### CryptoCurrencyTransfer.Message property

Gets or sets optional transfer message.

```csharp
public string Message { get; set; }
```

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/type.md

#### CryptoCurrencyTransfer.Type property

Gets or sets one of supported cryptocurrency type.

```csharp
public CryptoCurrencyType Type { get; set; }
```

### CryptoCurrencyType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/cryptocurrencytype.md

#### CryptoCurrencyType enumeration

Represents Cryptocurrency type.

```csharp
public enum CryptoCurrencyType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Custom | `0` | Represents custom cryptocurrency type. |
| Bitcoin | `1` | Represents Bitcoin cryptocurrency type. |
| BitcoinCash | `2` | Represents Bitcoin Cash cryptocurrency type. |
| Litecoin | `3` | Represents Litecoin cryptocurrency type. |
| Ethereum | `4` | Represents Ethereum cryptocurrency type. |
| Dash | `5` | Represents Dash cryptocurrency type. |

### DataMatrixEncodeMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/datamatrixencodemode.md

#### DataMatrixEncodeMode enumeration

DataMatrix encoder's encoding mode, default to Auto

```csharp
public enum DataMatrixEncodeMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | Automatically pick up the best encode mode for DataMatrix encoding |
| ASCII | `1` | Encodes one alphanumeric or two numeric characters per byte |
| Full | `6` | Encode 8 bit values |
| Custom | `7` | Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding |
| C40 | `8` | Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters |
| Text | `9` | Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters. |
| EDIFACT | `10` | Uses EDIFACT encoding. Uses six bits per character, encodes digits, upper-case letters, and many punctuation marks, but has no support for lower-case letters. |
| ANSIX12 | `11` | Uses ANSI X12 encoding. |
| ExtendedCodetext | `12` | ExtendedCodetext mode allows to manually switch encoding schemes in code-text. Format : "\Encodation_scheme_name:text\Encodation_scheme_name:text". Allowed encoding schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto. Extended code-text example: @"\ansix12:ANSIX12TEXT\ascii:backslash must be \\ doubled\edifact:EdifactEncodedText" All backslashes (\) must be doubled in text. |

### DigitalVBA
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba.md

#### DigitalVBA class

Represents digital signature for Spreadsheets VBA projects. It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm. If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing.

```csharp
public class DigitalVBA : SignatureExtension
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalVBA(Stream, string) | Initializes a new instance of the DigitalVBA class with certificate stream. |
| DigitalVBA(string, string) | Initializes a new instance of the DigitalVBA class with certificate file. |

#### Properties

| Name | Description |
| --- | --- |
| CertificateFilePath { get; } | Gets digital certificate file path. This property is used only if CertificateStream is not specified. |
| CertificateStream { get; } | Gets digital certificate stream. If this property is specified it is always used instead CertificateFilePath. |
| Comments { get; set; } | Gets or sets the signature comments. |
| Password { get; set; } | Gets or sets the password of digital certificate. |
| SignOnlyVBAProject { get; set; } | Gets or sets setting of only VBA project signing. If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Gets a copy of this object. |

### CertificateFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/certificatefilepath.md

#### DigitalVBA.CertificateFilePath property

Gets digital certificate file path. This property is used only if CertificateStream is not specified.

```csharp
public string CertificateFilePath { get; }
```

### CertificateStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/certificatestream.md

#### DigitalVBA.CertificateStream property

Gets digital certificate stream. If this property is specified it is always used instead CertificateFilePath.

```csharp
public Stream CertificateStream { get; }
```

### Comments
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/comments.md

#### DigitalVBA.Comments property

Gets or sets the signature comments.

```csharp
public string Comments { get; set; }
```

### DigitalVBA
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/digitalvba.md

#### DigitalVBA(string, string)

Initializes a new instance of the DigitalVBA class with certificate file.

```csharp
public DigitalVBA(string certificateFilePath, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | String | Digital certificate file path |
| password | String | Digital certificate password |

#### DigitalVBA(Stream, string)

Initializes a new instance of the DigitalVBA class with certificate stream.

```csharp
public DigitalVBA(Stream certificateStream, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | Stream | Digital Certificate stream |
| password | String | Digital certificate password |

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/password.md

#### DigitalVBA.Password property

Gets or sets the password of digital certificate.

```csharp
public string Password { get; set; }
```

### SignOnlyVBAProject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/digitalvba/signonlyvbaproject.md

#### DigitalVBA.SignOnlyVBAProject property

Gets or sets setting of only VBA project signing. If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.

```csharp
public bool SignOnlyVBAProject { get; set; }
```

### Email
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email.md

#### Email class

Represents Email format for QR-Code.

```csharp
public class Email
```

#### Constructors

| Name | Description |
| --- | --- |
| Email() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Address { get; set; } | Gets or sets Email address. |
| Body { get; set; } | Gets or sets Body of email message. |
| Subject { get; set; } | Gets or sets email Subject. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare Email properties |
| override GetHashCode() | Overrides GetHashCode method |

### Address
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/address.md

#### Email.Address property

Gets or sets Email address.

```csharp
public string Address { get; set; }
```

### Body
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/body.md

#### Email.Body property

Gets or sets Body of email message.

```csharp
public string Body { get; set; }
```

### Email
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/email.md

#### Email constructor

The default constructor.

```csharp
public Email()
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/equals.md

#### Email.Equals method

Overwrites Equals method to compare Email properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Email object to compare with. |

##### Return Value

Returns true if passed email object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/gethashcode.md

#### Email.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Email hash code

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/email/subject.md

#### Email.Subject property

Gets or sets email Subject.

```csharp
public string Subject { get; set; }
```

### EPC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc.md

#### EPC class

Represents European Payments Council Quick Response Code.

```csharp
public sealed class EPC
```

#### Constructors

| Name | Description |
| --- | --- |
| EPC() | Instantiates new EPC object. |

#### Properties

| Name | Description |
| --- | --- |
| Amount { get; set; } | Gets or sets amount. |
| BIC { get; set; } | Gets or sets Beneficiary's BIC with up to 11 characters length. |
| Charset { get; } | EPC / SEPA QR-Code char set implementation. By default this value set to 1 |
| Code { get; set; } | Gets or sets Business Code up to 4 characters. |
| IBAN { get; set; } | Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters. |
| Identification { get; } | EPC / SEPA QR-Code identification. By default this value set to SCT |
| Information { get; set; } | Gets or sets hint information. Maximum 70 characters. |
| Name { get; set; } | Gets or sets Beneficiary's Name. Maximum length is 70 characters. |
| Reference { get; set; } | Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive. |
| Remittance { get; set; } | Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive. |
| Version { get; } | EPC / SEPA QR-Code version implementation. By default this value set to 002. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare EPC properties |
| override GetHashCode() | Overrides GetHashCode method |

### Amount
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/amount.md

#### EPC.Amount property

Gets or sets amount.

```csharp
public double Amount { get; set; }
```

### BIC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/bic.md

#### EPC.BIC property

Gets or sets Beneficiary's BIC with up to 11 characters length.

```csharp
public string BIC { get; set; }
```

### Charset
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/charset.md

#### EPC.Charset property

EPC / SEPA QR-Code char set implementation. By default this value set to 1

```csharp
public string Charset { get; }
```

### Code
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/code.md

#### EPC.Code property

Gets or sets Business Code up to 4 characters.

```csharp
public string Code { get; set; }
```

### EPC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/epc.md

#### EPC constructor

Instantiates new EPC object.

```csharp
public EPC()
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/equals.md

#### EPC.Equals method

Overwrites Equals method to compare EPC properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | EPC object to compare with. |

##### Return Value

Returns true if passed address object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/gethashcode.md

#### EPC.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Email hash code

### IBAN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/iban.md

#### EPC.IBAN property

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.

```csharp
public string IBAN { get; set; }
```

### Identification
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/identification.md

#### EPC.Identification property

EPC / SEPA QR-Code identification. By default this value set to SCT

```csharp
public string Identification { get; }
```

### Information
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/information.md

#### EPC.Information property

Gets or sets hint information. Maximum 70 characters.

```csharp
public string Information { get; set; }
```

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/name.md

#### EPC.Name property

Gets or sets Beneficiary's Name. Maximum length is 70 characters.

```csharp
public string Name { get; set; }
```

### Reference
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/reference.md

#### EPC.Reference property

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.

```csharp
public string Reference { get; set; }
```

### Remittance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/remittance.md

#### EPC.Remittance property

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.

```csharp
public string Remittance { get; set; }
```

### Version
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/epc/version.md

#### EPC.Version property

EPC / SEPA QR-Code version implementation. By default this value set to 002.

```csharp
public string Version { get; }
```

### Event
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event.md

#### Event class

Represents standard QR-Code Event details.

```csharp
public sealed class Event
```

#### Constructors

| Name | Description |
| --- | --- |
| Event() | Creates Event instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Description { get; set; } | Gets or sets description. |
| EndDate { get; set; } | Gets or sets event end date and time. |
| Location { get; set; } | Gets or sets event location. |
| StartDate { get; set; } | Gets or sets event start date and time. |
| Title { get; set; } | Gets or sets event title. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare Event properties |
| override GetHashCode() | Overrides GetHashCode method |

### Description
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/description.md

#### Event.Description property

Gets or sets description.

```csharp
public string Description { get; set; }
```

### EndDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/enddate.md

#### Event.EndDate property

Gets or sets event end date and time.

```csharp
public DateTime? EndDate { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/equals.md

#### Event.Equals method

Overwrites Equals method to compare Event properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Event object to compare with. |

##### Return Value

Returns true if passed Event object has same type and all its properties are equal to this instance properties.

### Event
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/event.md

#### Event constructor

Creates Event instance with default values.

```csharp
public Event()
```

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/gethashcode.md

#### Event.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Event hash code

### Location
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/location.md

#### Event.Location property

Gets or sets event location.

```csharp
public string Location { get; set; }
```

### StartDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/startdate.md

#### Event.StartDate property

Gets or sets event start date and time.

```csharp
public DateTime StartDate { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/event/title.md

#### Event.Title property

Gets or sets event title.

```csharp
public string Title { get; set; }
```

### FormatAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/formatattribute.md

#### FormatAttribute class

Instructs objects serialization to serialize the member with the specified name and format

```csharp
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter)]
public sealed class FormatAttribute : Attribute
```

#### Constructors

| Name | Description |
| --- | --- |
| FormatAttribute(string) | Creates Format attribute with given property Name |
| FormatAttribute(string, string) | Creates Format attribute with given property Name |

#### Properties

| Name | Description |
| --- | --- |
| PropertyFormat { get; set; } | Gets or sets the serialization format of the property. |
| PropertyName { get; set; } | Gets or sets the name of the property. |

### FormatAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/formatattribute/formatattribute.md

#### FormatAttribute(string)

Creates Format attribute with given property Name

```csharp
public FormatAttribute(string propertyName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The name of property |

#### FormatAttribute(string, string)

Creates Format attribute with given property Name

```csharp
public FormatAttribute(string propertyName, string propertyFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| propertyName | String | The name of property |
| propertyFormat | String | The format of property |

### PropertyFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/formatattribute/propertyformat.md

#### FormatAttribute.PropertyFormat property

Gets or sets the serialization format of the property.

```csharp
public string PropertyFormat { get; set; }
```

##### Property Value

The format of the property.

### PropertyName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/formatattribute/propertyname.md

#### FormatAttribute.PropertyName property

Gets or sets the name of the property.

```csharp
public string PropertyName { get; set; }
```

##### Property Value

The name of the property.

### HIBCLICCombinedData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcliccombineddata.md

#### HIBCLICCombinedData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities.

```csharp
public class HIBCLICCombinedData : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| HIBCLICCombinedData() | Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values. |

#### Properties

| Name | Description |
| --- | --- |
| PrimaryData { get; set; } | HIBC LIC primary data structure |
| SecondaryAdditionalData { get; set; } | HIBC LIC secondary data structure |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcliccombineddata/clone.md

#### HIBCLICCombinedData.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### HIBCLICCombinedData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcliccombineddata/hibcliccombineddata.md

#### HIBCLICCombinedData constructor

Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values.

```csharp
public HIBCLICCombinedData()
```

### PrimaryData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcliccombineddata/primarydata.md

#### HIBCLICCombinedData.PrimaryData property

HIBC LIC primary data structure

```csharp
public HIBCLICPrimaryData PrimaryData { get; set; }
```

### SecondaryAdditionalData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcliccombineddata/secondaryadditionaldata.md

#### HIBCLICCombinedData.SecondaryAdditionalData property

HIBC LIC secondary data structure

```csharp
public HIBCLICSecondaryAdditionalData SecondaryAdditionalData { get; set; }
```

### HIBCLICDateFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicdateformat.md

#### HIBCLICDateFormat enumeration

Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code).

```csharp
public enum HIBCLICDateFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| YYYYMMDD | `0` | YYYYMMDD format. Will be encoded in additional supplemental data. |
| MMYY | `1` | MMYY format. |
| MMDDYY | `2` | MMDDYY format. |
| YYMMDD | `3` | YYMMDD format. |
| YYMMDDHH | `4` | YYMMDDHH format. |
| YYJJJ | `5` | Julian date format. |
| YYJJJHH | `6` | Julian date format with hours. |
| None | `7` | Do not encode expiry date. |

### HIBCLICPrimaryData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata.md

#### HIBCLICPrimaryData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data.

```csharp
public class HIBCLICPrimaryData : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| HIBCLICPrimaryData() | Default ctor() |

#### Properties

| Name | Description |
| --- | --- |
| LabelerIdentificationCode { get; set; } | Identifies date of labeler identification code. Labeler identification code must be 4 symbols alphanumeric string, with first character always being alphabetic. |
| ProductOrCatalogNumber { get; set; } | Identifies product or catalog number. Product or catalog number must be alphanumeric string up to 18 symbols length. |
| UnitOfMeasureID { get; set; } | Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata/clone.md

#### HIBCLICPrimaryData.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### HIBCLICPrimaryData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata/hibclicprimarydata.md

#### HIBCLICPrimaryData constructor

Default ctor()

```csharp
public HIBCLICPrimaryData()
```

### LabelerIdentificationCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata/labeleridentificationcode.md

#### HIBCLICPrimaryData.LabelerIdentificationCode property

Identifies date of labeler identification code. Labeler identification code must be 4 symbols alphanumeric string, with first character always being alphabetic.

```csharp
public string LabelerIdentificationCode { get; set; }
```

### ProductOrCatalogNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata/productorcatalognumber.md

#### HIBCLICPrimaryData.ProductOrCatalogNumber property

Identifies product or catalog number. Product or catalog number must be alphanumeric string up to 18 symbols length.

```csharp
public string ProductOrCatalogNumber { get; set; }
```

### UnitOfMeasureID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicprimarydata/unitofmeasureid.md

#### HIBCLICPrimaryData.UnitOfMeasureID property

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.

```csharp
public int UnitOfMeasureID { get; set; }
```

### HIBCLICSecondaryAdditionalData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata.md

#### HIBCLICSecondaryAdditionalData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data.

```csharp
public class HIBCLICSecondaryAdditionalData : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| HIBCLICSecondaryAdditionalData() | Default ctor() |

#### Properties

| Name | Description |
| --- | --- |
| DateOfManufacture { get; set; } | Identifies date of manufacture. Date of manufacture can be set to DateTime.MinValue in order not to use this field. Default value: DateTime.MinValue |
| ExpiryDate { get; set; } | Identifies expiry date. Will be used if ExpiryDateFormat is not set to None. |
| ExpiryDateFormat { get; set; } | Identifies expiry date format. |
| LinkCharacter { get; set; } | Identifies link character in output string. |
| LotNumber { get; set; } | Identifies lot or batch number. Lot/batch number must be alphanumeric string with up to 18 symbols length. |
| Quantity { get; set; } | Identifies quantity, must be integer value from 0 to 500. Quantity can be set to -1 in order not to use this field. Default value: -1 |
| SerialNumber { get; set; } | Identifies serial number. Serial number must be alphanumeric string up to 18 symbols length. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/clone.md

#### HIBCLICSecondaryAdditionalData.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### DateOfManufacture
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/dateofmanufacture.md

#### HIBCLICSecondaryAdditionalData.DateOfManufacture property

Identifies date of manufacture. Date of manufacture can be set to DateTime.MinValue in order not to use this field. Default value: DateTime.MinValue

```csharp
public DateTime DateOfManufacture { get; set; }
```

### ExpiryDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/expirydate.md

#### HIBCLICSecondaryAdditionalData.ExpiryDate property

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.

```csharp
public DateTime ExpiryDate { get; set; }
```

### ExpiryDateFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/expirydateformat.md

#### HIBCLICSecondaryAdditionalData.ExpiryDateFormat property

Identifies expiry date format.

```csharp
public HIBCLICDateFormat ExpiryDateFormat { get; set; }
```

### HIBCLICSecondaryAdditionalData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/hibclicsecondaryadditionaldata.md

#### HIBCLICSecondaryAdditionalData constructor

Default ctor()

```csharp
public HIBCLICSecondaryAdditionalData()
```

### LinkCharacter
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/linkcharacter.md

#### HIBCLICSecondaryAdditionalData.LinkCharacter property

Identifies link character in output string.

```csharp
public char LinkCharacter { get; set; }
```

### LotNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/lotnumber.md

#### HIBCLICSecondaryAdditionalData.LotNumber property

Identifies lot or batch number. Lot/batch number must be alphanumeric string with up to 18 symbols length.

```csharp
public string LotNumber { get; set; }
```

### Quantity
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/quantity.md

#### HIBCLICSecondaryAdditionalData.Quantity property

Identifies quantity, must be integer value from 0 to 500. Quantity can be set to -1 in order not to use this field. Default value: -1

```csharp
public int Quantity { get; set; }
```

### SerialNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/serialnumber.md

#### HIBCLICSecondaryAdditionalData.SerialNumber property

Identifies serial number. Serial number must be alphanumeric string up to 18 symbols length.

```csharp
public string SerialNumber { get; set; }
```

### HIBCPASData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata.md

#### HIBCPASData class

Class for encoding and decoding the text embedded in the HIBC PAS code.

```csharp
public class HIBCPASData
```

#### Constructors

| Name | Description |
| --- | --- |
| HIBCPASData() | Default ctor(). |

#### Properties

| Name | Description |
| --- | --- |
| DataLocation { get; set; } | Identifies data location. |
| Records { get; set; } | List of HIBCPASRecord records |

#### Methods

| Name | Description |
| --- | --- |
| AddRecord(HIBCPASRecord) | Adds new record |
| AddRecord(HIBCPASDataType, string) | Adds new record `HIBCPASRecord` with given data type and data |
| Clear() | Clears records list |

### AddRecord
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata/addrecord.md

#### AddRecord(HIBCPASDataType, string)

Adds new record `HIBCPASRecord` with given data type and data

```csharp
public HIBCPASData AddRecord(HIBCPASDataType dataType, string data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataType | HIBCPASDataType | Record data type |
| data | String | Record data |

#### AddRecord(HIBCPASRecord)

Adds new record

```csharp
public HIBCPASData AddRecord(HIBCPASRecord record)
```

| Parameter | Type | Description |
| --- | --- | --- |
| record | HIBCPASRecord | Record to be added |

##### Return Value

Return reference on itself

### Clear
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata/clear.md

#### HIBCPASData.Clear method

Clears records list

```csharp
public HIBCPASData Clear()
```

##### Return Value

Returns reference on itself

### DataLocation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata/datalocation.md

#### HIBCPASData.DataLocation property

Identifies data location.

```csharp
public HIBCPASDataLocation DataLocation { get; set; }
```

### HIBCPASData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata/hibcpasdata.md

#### HIBCPASData constructor

Default ctor().

```csharp
public HIBCPASData()
```

### Records
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdata/records.md

#### HIBCPASData.Records property

List of HIBCPASRecord records

```csharp
public List<HIBCPASRecord> Records { get; set; }
```

### HIBCPASDataLocation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdatalocation.md

#### HIBCPASDataLocation enumeration

Specifies HIBC PAS data location types. HIBC - Healthcare Industry Bar Code PAS - Provider Applications Standard

```csharp
public enum HIBCPASDataLocation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Patient | `0` | A - Patient |
| PatientCareRecord | `1` | B - Patient Care Record |
| SpecimenContainer | `2` | C - Specimen Container |
| DirectPatientImageItem | `3` | D - Direct Patient Image Item |
| BusinessRecord | `4` | E - Business Record |
| MedicalAdministrationRecord | `5` | F - Medical Administration Record |
| LibraryReferenceMaterial | `6` | G - Library Reference Material |
| DevicesAndMaterials | `7` | H - Devices and Materials |
| IdentificationCard | `8` | I - Identification Card |
| ProductContainer | `9` | J - Product Container |
| Asset | `10` | K - Asset data type |
| SurgicalInstrument | `11` | L - Surgical Instrument |
| UserDefined | `25` | Z - User Defined |

### HIBCPASDataType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasdatatype.md

#### HIBCPASDataType enumeration

Specifies the different data types of HIBC PAS record. HIBC - Healthcare Industry Bar Code PAS - Provider Applications Standard

```csharp
public enum HIBCPASDataType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| LabelerIdentificationCode | `0` | A - Labeler Identification Code |
| ServiceIdentification | `1` | B - Service Identification |
| PatientIdentification | `2` | C - Patient Identification |
| SpecimenIdentification | `3` | D - Specimen Identification |
| PersonnelIdentification | `4` | E - Personnel Identification |
| AdministrableProductIdentification | `5` | F - Administrable Product Identification |
| ImplantableProductInformation | `6` | G - Implantable Product Information |
| HospitalItemIdentification | `7` | H - Hospital Item Identification |
| MedicalProcedureIdentification | `8` | I - Medical Procedure Identification |
| ReimbursementCategory | `9` | J - Reimbursement Category |
| BloodProductIdentification | `10` | K - Blood Product Identification |
| DemographicData | `11` | L - Demographic Data |
| DateTime | `12` | M - DateTime in YYYDDDHHMMG format |
| AssetIdentification | `13` | N - Asset Identification |
| PurchaseOrderNumber | `14` | O - Purchase Order Number |
| DietaryItemIdentification | `15` | P - Dietary Item Identification |
| ManufacturerSerialNumber | `16` | Q - Manufacturer Serial Number |
| LibraryMaterialsIdentification | `17` | R - Library Materials Identification |
| BusinessControlNumber | `18` | S - Business Control Number |
| EpisodeOfCareIdentification | `19` | T - Episode of Care Identification |
| HealthIndustryNumber | `20` | U - Health Industry Number |
| PatientVisitID | `21` | V - Patient Visit ID |
| XMLDocument | `22` | X - XML Document |
| UserDefined | `25` | Z - User Defined |

### HIBCPASRecord
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasrecord.md

#### HIBCPASRecord class

Class for storing HIBC (Healthcare Industry Bar Code Council) PAS (Provider Applications Standard) Record

```csharp
public class HIBCPASRecord
```

#### Constructors

| Name | Description |
| --- | --- |
| HIBCPASRecord() | Default ctor() |
| HIBCPASRecord(HIBCPASDataType, string) | Creates HIBCPASRecord with data and type. |

#### Properties

| Name | Description |
| --- | --- |
| Data { get; set; } | Identifies data. |
| DataType { get; set; } | HIBC PAS record's data type. |

### Data
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasrecord/data.md

#### HIBCPASRecord.Data property

Identifies data.

```csharp
public string Data { get; set; }
```

### DataType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasrecord/datatype.md

#### HIBCPASRecord.DataType property

HIBC PAS record's data type.

```csharp
public HIBCPASDataType DataType { get; set; }
```

### HIBCPASRecord
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/hibcpasrecord/hibcpasrecord.md

#### HIBCPASRecord()

Default ctor()

```csharp
public HIBCPASRecord()
```

#### HIBCPASRecord(HIBCPASDataType, string)

Creates HIBCPASRecord with data and type.

```csharp
public HIBCPASRecord(HIBCPASDataType dataType, string data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dataType | HIBCPASDataType | HIBC PAS record's data type. |
| data | String | HIBC PAS record's data. |

### IDataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataencryption.md

#### IDataEncryption interface

Encryption interface to provide object encoding and decoding methods.

```csharp
public interface IDataEncryption
```

#### Methods

| Name | Description |
| --- | --- |
| Decode(string) | Decode method to obtain decrypted string. |
| Encode(string) | Encode method to encrypt string. |

### Decode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataencryption/decode.md

#### IDataEncryption.Decode method

Decode method to obtain decrypted string.

```csharp
public string Decode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Encrypted string to decode. |

##### Return Value

Returns decrypted string

### Encode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataencryption/encode.md

#### IDataEncryption.Encode method

Encode method to encrypt string.

```csharp
public string Encode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Source string to encode. |

##### Return Value

Returns encrypted string

### IDataSerializer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataserializer.md

#### IDataSerializer interface

Serialization interface to provide object serialization and deserialization methods.

```csharp
public interface IDataSerializer
```

#### Methods

| Name | Description |
| --- | --- |
| Deserialize&lt;T&gt;(string) | Deserialize method to obtain required object from string. |
| Serialize(object) | Serialize method to format object to string representing. |

### Deserialize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataserializer/deserialize.md

#### IDataSerializer.Deserialize&lt;T&gt; method

Deserialize method to obtain required object from string.

```csharp
public T Deserialize<T>(string source)
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | Type of return object |
| source | Source serialized string that contains object |

### Serialize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/idataserializer/serialize.md

#### IDataSerializer.Serialize method

Serialize method to format object to string representing.

```csharp
public string Serialize(object data)
```

| Parameter | Type | Description |
| --- | --- | --- |
| data | Object | Source object to serialize |

### LinearGradientBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/lineargradientbrush.md

#### LinearGradientBrush class

Represents linear gradient brush.

```csharp
public class LinearGradientBrush : Brush
```

#### Constructors

| Name | Description |
| --- | --- |
| LinearGradientBrush() | Initializes a new instance of the LinearGradientBrush class with default values. |
| LinearGradientBrush(Color, Color, float) | Initializes a new instance of the LinearGradientBrush class. |

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; set; } | Gets or sets gradient angle. |
| EndColor { get; set; } | Gets or sets finish gradient color. |
| StartColor { get; set; } | Gets or sets start gradient color. |

### Angle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/lineargradientbrush/angle.md

#### LinearGradientBrush.Angle property

Gets or sets gradient angle.

```csharp
public float Angle { get; set; }
```

### EndColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/lineargradientbrush/endcolor.md

#### LinearGradientBrush.EndColor property

Gets or sets finish gradient color.

```csharp
public Color EndColor { get; set; }
```

### LinearGradientBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/lineargradientbrush/lineargradientbrush.md

#### LinearGradientBrush()

Initializes a new instance of the LinearGradientBrush class with default values.

```csharp
public LinearGradientBrush()
```

#### LinearGradientBrush(Color, Color, float)

Initializes a new instance of the LinearGradientBrush class.

```csharp
public LinearGradientBrush(Color startColor, Color endColor, float angle = 0)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startColor | Color | Start color. |
| endColor | Color | End color. |
| angle | Single | Angle. Default value is 0. |

### StartColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/lineargradientbrush/startcolor.md

#### LinearGradientBrush.StartColor property

Gets or sets start gradient color.

```csharp
public Color StartColor { get; set; }
```

### Mailmark2D
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d.md

#### Mailmark2D class

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark

```csharp
public class Mailmark2D : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| Mailmark2D() | Creates Royal Mail Mailmark combined data with default primary and secondary data values. |

#### Properties

| Name | Description |
| --- | --- |
| Class { get; set; } | Identifies the class of the item. |
| CustomerContent { get; set; } | Optional space for use by customer. |
| CustomerContentEncodeMode { get; set; } | Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. `DataMatrixEncodeMode` |
| DataMatrixType { get; set; } | 2D Mailmark Type defines size of Data Matrix barcode. |
| DestinationPostCodeAndDPS { get; set; } | Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9. |
| InformationTypeID { get; set; } | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| ItemID { get; set; } | Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999. |
| ReturnToSenderPostCode { get; set; } | Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format. |
| RTSFlag { get; set; } | Flag which indicates what level of Return to Sender service is being requested. Max length is 1 |
| SupplyChainID { get; set; } | Identifies the unique group of customers involved in the mailing. Max value: 9999999. |
| UPUCountryID { get; set; } | Identifies the UPU Country ID.Max length: 4 characters. |
| VersionID { get; } | Identifies the barcode version as relevant to each Information Type ID. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |

### Class
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/class.md

#### Mailmark2D.Class property

Identifies the class of the item.

```csharp
public string Class { get; set; }
```

##### Remarks

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/clone.md

#### Mailmark2D.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### CustomerContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/customercontent.md

#### Mailmark2D.CustomerContent property

Optional space for use by customer.

```csharp
public string CustomerContent { get; set; }
```

##### Remarks

Max length by Type `Mailmark2DType`: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

### CustomerContentEncodeMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/customercontentencodemode.md

#### Mailmark2D.CustomerContentEncodeMode property

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. `DataMatrixEncodeMode`

```csharp
public DataMatrixEncodeMode CustomerContentEncodeMode { get; set; }
```

### DataMatrixType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/datamatrixtype.md

#### Mailmark2D.DataMatrixType property

2D Mailmark Type defines size of Data Matrix barcode.

```csharp
public Mailmark2DType DataMatrixType { get; set; }
```

### DestinationPostCodeAndDPS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/destinationpostcodeanddps.md

#### Mailmark2D.DestinationPostCodeAndDPS property

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

```csharp
public string DestinationPostCodeAndDPS { get; set; }
```

### InformationTypeID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/informationtypeid.md

#### Mailmark2D.InformationTypeID property

Identifies the Royal Mail Mailmark barcode payload for each product type.

```csharp
public string InformationTypeID { get; set; }
```

##### Remarks

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

### ItemID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/itemid.md

#### Mailmark2D.ItemID property

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

```csharp
public int ItemID { get; set; }
```

### Mailmark2D
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/mailmark2d.md

#### Mailmark2D constructor

Creates Royal Mail Mailmark combined data with default primary and secondary data values.

```csharp
public Mailmark2D()
```

### ReturnToSenderPostCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/returntosenderpostcode.md

#### Mailmark2D.ReturnToSenderPostCode property

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

```csharp
public string ReturnToSenderPostCode { get; set; }
```

### RTSFlag
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/rtsflag.md

#### Mailmark2D.RTSFlag property

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

```csharp
public string RTSFlag { get; set; }
```

### SupplyChainID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/supplychainid.md

#### Mailmark2D.SupplyChainID property

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

```csharp
public int SupplyChainID { get; set; }
```

### UPUCountryID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/upucountryid.md

#### Mailmark2D.UPUCountryID property

Identifies the UPU Country ID.Max length: 4 characters.

```csharp
public string UPUCountryID { get; set; }
```

### VersionID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2d/versionid.md

#### Mailmark2D.VersionID property

Identifies the barcode version as relevant to each Information Type ID.

```csharp
public string VersionID { get; }
```

##### Remarks

Valid Values: "1" - currently used only this value (default) "0" and "2" to "9" and "A" to "Z" spare reserved for potential future use.

### Mailmark2DType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mailmark2dtype.md

#### Mailmark2DType enumeration

2D Mailmark Type defines size of Data Matrix barcode

```csharp
public enum Mailmark2DType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | Auto determine |
| Type_7 | `1` | 24 x 24 modules |
| Type_9 | `2` | 32 x 32 modules |
| Type_29 | `3` | 16 x 48 modules |

### MaxiCodeMode2
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2.md

#### MaxiCodeMode2 class

Class for encoding and decoding the text embedded in the MaxiCode code for modes

```csharp
public class MaxiCodeMode2
```

#### Constructors

| Name | Description |
| --- | --- |
| MaxiCodeMode2() | Creates MaxiCode data |

#### Properties

| Name | Description |
| --- | --- |
| CountryCode { get; set; } | Identifies the 3-digit country code. |
| PostalCode { get; set; } | Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3. |
| SecondMessage { get; set; } | Identifies the second message of the barcode. |
| ServiceCategory { get; set; } | Identifies the 3-digit service category. |

### CountryCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2/countrycode.md

#### MaxiCodeMode2.CountryCode property

Identifies the 3-digit country code.

```csharp
public int CountryCode { get; set; }
```

### MaxiCodeMode2
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2/maxicodemode2.md

#### MaxiCodeMode2 constructor

Creates MaxiCode data

```csharp
public MaxiCodeMode2()
```

### PostalCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2/postalcode.md

#### MaxiCodeMode2.PostalCode property

Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3.

```csharp
public string PostalCode { get; set; }
```

### SecondMessage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2/secondmessage.md

#### MaxiCodeMode2.SecondMessage property

Identifies the second message of the barcode.

```csharp
public MaxiCodeSecondMessage SecondMessage { get; set; }
```

### ServiceCategory
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodemode2/servicecategory.md

#### MaxiCodeMode2.ServiceCategory property

Identifies the 3-digit service category.

```csharp
public int ServiceCategory { get; set; }
```

### MaxiCodeSecondMessage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodesecondmessage.md

#### MaxiCodeSecondMessage class

Class for encoding and decoding standart second message for MaxiCode barcode.

```csharp
public class MaxiCodeSecondMessage
```

#### Constructors

| Name | Description |
| --- | --- |
| MaxiCodeSecondMessage() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Message { get; set; } | Gets or sets the second message. |

### MaxiCodeSecondMessage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodesecondmessage/maxicodesecondmessage.md

#### MaxiCodeSecondMessage constructor

The default constructor.

```csharp
public MaxiCodeSecondMessage()
```

### Message
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/maxicodesecondmessage/message.md

#### MaxiCodeSecondMessage.Message property

Gets or sets the second message.

```csharp
public string Message { get; set; }
```

### MeCard
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard.md

#### MeCard class

Represents MeCard standard contact details.

```csharp
public sealed class MeCard
```

#### Constructors

| Name | Description |
| --- | --- |
| MeCard() | Creates MeCard instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Address { get; set; } | Gets or sets Home Address properties. This property is not initialized by default. |
| AltPhone { get; set; } | Gets or sets alternative phone number. |
| BirthDay { get; set; } | Gets or sets contact birthday. |
| Email { get; set; } | Gets or sets contact email. |
| Name { get; set; } | Gets or sets contact Name. |
| Nickname { get; set; } | Gets or sets contact Nickname. |
| Note { get; set; } | Gets or sets Note (Company) of contact. |
| Phone { get; set; } | Gets or sets phone number. |
| Reading { get; set; } | Gets or sets reading of name. |
| Url { get; set; } | Gets or sets URL. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare MeCard properties |
| override GetHashCode() | Overrides GetHashCode method |

### Address
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/address.md

#### MeCard.Address property

Gets or sets Home Address properties. This property is not initialized by default.

```csharp
public Address Address { get; set; }
```

### AltPhone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/altphone.md

#### MeCard.AltPhone property

Gets or sets alternative phone number.

```csharp
public string AltPhone { get; set; }
```

### BirthDay
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/birthday.md

#### MeCard.BirthDay property

Gets or sets contact birthday.

```csharp
public DateTime? BirthDay { get; set; }
```

### Email
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/email.md

#### MeCard.Email property

Gets or sets contact email.

```csharp
public string Email { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/equals.md

#### MeCard.Equals method

Overwrites Equals method to compare MeCard properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | MeCard object to compare with. |

##### Return Value

Returns true if passed MeCard object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/gethashcode.md

#### MeCard.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

MeCard hash code

### MeCard
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/mecard.md

#### MeCard constructor

Creates MeCard instance with default values.

```csharp
public MeCard()
```

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/name.md

#### MeCard.Name property

Gets or sets contact Name.

```csharp
public string Name { get; set; }
```

### Nickname
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/nickname.md

#### MeCard.Nickname property

Gets or sets contact Nickname.

```csharp
public string Nickname { get; set; }
```

### Note
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/note.md

#### MeCard.Note property

Gets or sets Note (Company) of contact.

```csharp
public string Note { get; set; }
```

### Phone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/phone.md

#### MeCard.Phone property

Gets or sets phone number.

```csharp
public string Phone { get; set; }
```

### Reading
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/reading.md

#### MeCard.Reading property

Gets or sets reading of name.

```csharp
public string Reading { get; set; }
```

### Url
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/mecard/url.md

#### MeCard.Url property

Gets or sets URL.

```csharp
public string Url { get; set; }
```

### RadialGradientBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/radialgradientbrush.md

#### RadialGradientBrush class

Represents radial gradient brush.

```csharp
public class RadialGradientBrush : Brush
```

#### Constructors

| Name | Description |
| --- | --- |
| RadialGradientBrush() | Initializes a new instance of the RadialGradientBrush class with default values. |
| RadialGradientBrush(Color, Color) | Initializes a new instance of the RadialGradientBrush class. |

#### Properties

| Name | Description |
| --- | --- |
| InnerColor { get; set; } | Gets or sets inner gradient color. |
| OuterColor { get; set; } | Gets or sets outer gradient color. |

### InnerColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/radialgradientbrush/innercolor.md

#### RadialGradientBrush.InnerColor property

Gets or sets inner gradient color.

```csharp
public Color InnerColor { get; set; }
```

### OuterColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/radialgradientbrush/outercolor.md

#### RadialGradientBrush.OuterColor property

Gets or sets outer gradient color.

```csharp
public Color OuterColor { get; set; }
```

### RadialGradientBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/radialgradientbrush/radialgradientbrush.md

#### RadialGradientBrush()

Initializes a new instance of the RadialGradientBrush class with default values.

```csharp
public RadialGradientBrush()
```

#### RadialGradientBrush(Color, Color)

Initializes a new instance of the RadialGradientBrush class.

```csharp
public RadialGradientBrush(Color innerColor, Color outerColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| innerColor | Color | Inner color. |
| outerColor | Color | Outer color. |

### SignatureExtension
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/signatureextension.md

#### SignatureExtension class

Represents base class for signatures extensions.

```csharp
public abstract class SignatureExtension : ICloneable
```

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Gets a copy of this object. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/signatureextension/clone.md

#### SignatureExtension.Clone method

Gets a copy of this object.

```csharp
public virtual object Clone()
```

### SkipSerializationAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/skipserializationattribute.md

#### SkipSerializationAttribute class

Instructs the serialization to skip the member.

```csharp
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter)]
public sealed class SkipSerializationAttribute : Attribute
```

#### Constructors

| Name | Description |
| --- | --- |
| SkipSerializationAttribute() | Creates Format attribute with given property Name. |

### SkipSerializationAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/skipserializationattribute/skipserializationattribute.md

#### SkipSerializationAttribute constructor

Creates Format attribute with given property Name.

```csharp
public SkipSerializationAttribute()
```

### SMS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms.md

#### SMS class

Represents SMS short message service details.

```csharp
public class SMS
```

#### Constructors

| Name | Description |
| --- | --- |
| SMS() | Creates VCard instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Message { get; set; } | Gets or sets SMS message content. |
| Number { get; set; } | Gets or sets SMS recipient phone number. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare SMS properties |
| override GetHashCode() | Overrides GetHashCode method |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms/equals.md

#### SMS.Equals method

Overwrites Equals method to compare SMS properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | SMS object to compare with. |

##### Return Value

Returns true if passed SMS object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms/gethashcode.md

#### SMS.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

VCard hash code

### Message
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms/message.md

#### SMS.Message property

Gets or sets SMS message content.

```csharp
public string Message { get; set; }
```

### Number
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms/number.md

#### SMS.Number property

Gets or sets SMS recipient phone number.

```csharp
public string Number { get; set; }
```

### SMS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/sms/sms.md

#### SMS constructor

Creates VCard instance with default values.

```csharp
public SMS()
```

### SolidBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/solidbrush.md

#### SolidBrush class

Represents solid brush. It could be used instead background color property.

```csharp
public class SolidBrush : Brush
```

#### Constructors

| Name | Description |
| --- | --- |
| SolidBrush() | Initializes a new instance of the SolidBrush class with default values. |
| SolidBrush(Color) | Initializes a new instance of the SolidBrush class. |

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | Gets or sets color of solid brush. |

### Color
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/solidbrush/color.md

#### SolidBrush.Color property

Gets or sets color of solid brush.

```csharp
public Color Color { get; set; }
```

### SolidBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/solidbrush/solidbrush.md

#### SolidBrush()

Initializes a new instance of the SolidBrush class with default values.

```csharp
public SolidBrush()
```

#### SolidBrush(Color)

Initializes a new instance of the SolidBrush class.

```csharp
public SolidBrush(Color color)
```

| Parameter | Type | Description |
| --- | --- | --- |
| color | Color | Color of solid brush. |

### SpreadsheetPosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/spreadsheetposition.md

#### SpreadsheetPosition class

Defines signature position for Spreadsheet documents.

```csharp
public class SpreadsheetPosition : SignatureExtension
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetPosition(int, int) | Creates Spreadsheet signature position with predefined row and column. |

#### Properties

| Name | Description |
| --- | --- |
| Column { get; set; } | Gets or sets the left column number of signature (min value is 0). |
| Row { get; set; } | Gets or sets the top row number of signature (min value is 0). |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Gets a copy of this object. |

### Column
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/spreadsheetposition/column.md

#### SpreadsheetPosition.Column property

Gets or sets the left column number of signature (min value is 0).

```csharp
public int Column { get; set; }
```

### Row
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/spreadsheetposition/row.md

#### SpreadsheetPosition.Row property

Gets or sets the top row number of signature (min value is 0).

```csharp
public int Row { get; set; }
```

### SpreadsheetPosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/spreadsheetposition/spreadsheetposition.md

#### SpreadsheetPosition constructor

Creates Spreadsheet signature position with predefined row and column.

```csharp
public SpreadsheetPosition(int row, int column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| row | Int32 | Row position |
| column | Int32 | Column position |

### SwissAddress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress.md

#### SwissAddress class

Represents the address of the creditor or debtor. You can either set street, house number, postal code, and town (structured address type) or address line 1 and 2 (combined address elements type).

```csharp
public class SwissAddress
```

#### Constructors

| Name | Description |
| --- | --- |
| SwissAddress() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AddressLine1 { get; set; } | Gets or sets the address line 1. Address line 1 contains street name, house number or P.O. box. This field is only used for combined elements addresses and is optional. |
| AddressLine2 { get; set; } | Gets or sets the address line 2. Address line 2 contains postal code and town. This field is only used for combined elements addresses. For this type, it's mandatory. |
| CountryCode { get; set; } | Gets or sets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or empty values. |
| HouseNo { get; set; } | Gets or sets the house number. This field is only used for structured addresses and is optional. |
| Name { get; set; } | Gets or sets the name, either the first and last name of a natural person or the company name of a legal person. |
| PostalCode { get; set; } | Gets or sets the postal code. This field is only used for structured addresses. For this type, it's mandatory. |
| Street { get; set; } | Gets or sets the street. The street must be specified without a house number. This field is only used for structured addresses and is optional. |
| Town { get; set; } | Gets or sets the town or city. This field is only used for structured addresses. For this type, it's mandatory. |

### AddressLine1
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/addressline1.md

#### SwissAddress.AddressLine1 property

Gets or sets the address line 1. Address line 1 contains street name, house number or P.O. box. This field is only used for combined elements addresses and is optional.

```csharp
public string AddressLine1 { get; set; }
```

##### Property Value

The address line 1.

### AddressLine2
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/addressline2.md

#### SwissAddress.AddressLine2 property

Gets or sets the address line 2. Address line 2 contains postal code and town. This field is only used for combined elements addresses. For this type, it's mandatory.

```csharp
public string AddressLine2 { get; set; }
```

##### Property Value

The address line 2.

### CountryCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/countrycode.md

#### SwissAddress.CountryCode property

Gets or sets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or empty values.

```csharp
public string CountryCode { get; set; }
```

##### Property Value

The ISO country code.

### HouseNo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/houseno.md

#### SwissAddress.HouseNo property

Gets or sets the house number. This field is only used for structured addresses and is optional.

```csharp
public string HouseNo { get; set; }
```

##### Property Value

The house number.

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/name.md

#### SwissAddress.Name property

Gets or sets the name, either the first and last name of a natural person or the company name of a legal person.

```csharp
public string Name { get; set; }
```

##### Property Value

The name.

### PostalCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/postalcode.md

#### SwissAddress.PostalCode property

Gets or sets the postal code. This field is only used for structured addresses. For this type, it's mandatory.

```csharp
public string PostalCode { get; set; }
```

##### Property Value

The postal code.

### Street
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/street.md

#### SwissAddress.Street property

Gets or sets the street. The street must be specified without a house number. This field is only used for structured addresses and is optional.

```csharp
public string Street { get; set; }
```

##### Property Value

The street.

### SwissAddress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/swissaddress.md

#### SwissAddress constructor

The default constructor.

```csharp
public SwissAddress()
```

### Town
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissaddress/town.md

#### SwissAddress.Town property

Gets or sets the town or city. This field is only used for structured addresses. For this type, it's mandatory.

```csharp
public string Town { get; set; }
```

##### Property Value

The town or city.

### SwissQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr.md

#### SwissQR class

Class for encoding and decoding the text embedded in the SwissQR code.

```csharp
public class SwissQR
```

#### Constructors

| Name | Description |
| --- | --- |
| SwissQR() | Creates an instance of SwissQR. |

#### Properties

| Name | Description |
| --- | --- |
| Account { get; set; } | Gets or sets the creditor's account number. Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number. |
| Amount { get; set; } | Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99. |
| BillInformation { get; set; } | Gets or sets the additional structured bill information. |
| Creditor { get; set; } | Gets or sets the creditor address. |
| Currency { get; set; } | Gets or sets the payment currency. Valid values are "CHF" and "EUR". |
| Debtor { get; set; } | Gets or sets the debtor address. The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok. |
| Reference { get; set; } | Gets or sets the creditor payment reference. The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting. |
| UnstructuredMessage { get; set; } | Gets or sets the additional unstructured message. |

### Account
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/account.md

#### SwissQR.Account property

Gets or sets the creditor's account number. Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number.

```csharp
public string Account { get; set; }
```

##### Property Value

The creditor account number.

### Amount
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/amount.md

#### SwissQR.Amount property

Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99.

```csharp
public decimal Amount { get; set; }
```

##### Property Value

The payment amount.

### BillInformation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/billinformation.md

#### SwissQR.BillInformation property

Gets or sets the additional structured bill information.

```csharp
public string BillInformation { get; set; }
```

##### Property Value

The structured bill information.

### Creditor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/creditor.md

#### SwissQR.Creditor property

Gets or sets the creditor address.

```csharp
public SwissAddress Creditor { get; set; }
```

##### Property Value

The creditor address.

### Currency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/currency.md

#### SwissQR.Currency property

Gets or sets the payment currency. Valid values are "CHF" and "EUR".

```csharp
public string Currency { get; set; }
```

##### Property Value

The payment currency.

### Debtor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/debtor.md

#### SwissQR.Debtor property

Gets or sets the debtor address. The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok.

```csharp
public SwissAddress Debtor { get; set; }
```

##### Property Value

The debtor address.

### Reference
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/reference.md

#### SwissQR.Reference property

Gets or sets the creditor payment reference. The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.

```csharp
public string Reference { get; set; }
```

##### Property Value

The creditor payment reference.

### SwissQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/swissqr.md

#### SwissQR constructor

Creates an instance of SwissQR.

```csharp
public SwissQR()
```

### UnstructuredMessage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/swissqr/unstructuredmessage.md

#### SwissQR.UnstructuredMessage property

Gets or sets the additional unstructured message.

```csharp
public string UnstructuredMessage { get; set; }
```

##### Property Value

The unstructured message.

### SymmetricAlgorithmType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricalgorithmtype.md

#### SymmetricAlgorithmType enumeration

Represents symmetric encryption algorithm type.

```csharp
public enum SymmetricAlgorithmType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Rijndael | `3` | Represents Rijndael symmetric encryption algorithm. |
| AESNew | `5` | Represents improved AES (Advanced Encryption Standard) encryption algorithm. |

### SymmetricEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption.md

#### SymmetricEncryption class

Implements standard symmetric algorithms for data encryption with single key and passphrase (salt).

```csharp
public sealed class SymmetricEncryption : IDataEncryption
```

#### Constructors

| Name | Description |
| --- | --- |
| SymmetricEncryption(SymmetricAlgorithmType, string) | Creates symmetric encryption algorithm with default passphrase |
| SymmetricEncryption(SymmetricAlgorithmType, string, string) | Creates symmetric encryption algorithm with parameters. |

#### Properties

| Name | Description |
| --- | --- |
| AlgorithmType { get; set; } | Gets or sets type of symmetric algorithm. |
| Key { get; set; } | Gets or sets key of encryption algorithm. |
| Salt { get; set; } | Gets or sets passphrase of encryption algorithm. |

#### Methods

| Name | Description |
| --- | --- |
| Decode(string) | Decrypts string based on provided algorithm type, key and salt parameters |
| Encode(string) | Encrypts string based on provided algorithm type, key and salt parameters |

### AlgorithmType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/algorithmtype.md

#### SymmetricEncryption.AlgorithmType property

Gets or sets type of symmetric algorithm.

```csharp
public SymmetricAlgorithmType AlgorithmType { get; set; }
```

### Decode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/decode.md

#### SymmetricEncryption.Decode method

Decrypts string based on provided algorithm type, key and salt parameters

```csharp
public string Decode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Encrypted string to decode. |

##### Return Value

Returns decrypted string.

### Encode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/encode.md

#### SymmetricEncryption.Encode method

Encrypts string based on provided algorithm type, key and salt parameters

```csharp
public string Encode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Source string to encode. |

##### Return Value

Returns encrypted string.

### Key
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/key.md

#### SymmetricEncryption.Key property

Gets or sets key of encryption algorithm.

```csharp
public string Key { get; set; }
```

### Salt
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/salt.md

#### SymmetricEncryption.Salt property

Gets or sets passphrase of encryption algorithm.

```csharp
public string Salt { get; set; }
```

### SymmetricEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryption/symmetricencryption.md

#### SymmetricEncryption(SymmetricAlgorithmType, string, string)

Creates symmetric encryption algorithm with parameters.

```csharp
public SymmetricEncryption(SymmetricAlgorithmType algorithmType, string key, string salt)
```

| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | String | Encryption key |
| salt | String | Passphrase for encryption |

#### SymmetricEncryption(SymmetricAlgorithmType, string)

Creates symmetric encryption algorithm with default passphrase

```csharp
public SymmetricEncryption(SymmetricAlgorithmType algorithmType, string key)
```

| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | String | Encryption key |

### SymmetricEncryptionAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryptionattribute.md

#### SymmetricEncryptionAttribute class

Instructs instances serialization to encrypt / decrypt object serialization string.

```csharp
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
public sealed class SymmetricEncryptionAttribute : Attribute, IDataEncryption
```

#### Constructors

| Name | Description |
| --- | --- |
| SymmetricEncryptionAttribute(SymmetricAlgorithmType, string) | Creates symmetric algorithm with parameters and default passphrase. |
| SymmetricEncryptionAttribute(SymmetricAlgorithmType, string, string) | Creates symmetric algorithm with parameters. |

#### Methods

| Name | Description |
| --- | --- |
| Decode(string) | Decrypts passed string based on algorithm type, key and salt parameters |
| Encode(string) | Encrypts string based on provided algorithm type, key and salt parameters |

### Decode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/decode.md

#### SymmetricEncryptionAttribute.Decode method

Decrypts passed string based on algorithm type, key and salt parameters

```csharp
public string Decode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Encrypted string to decode. |

##### Return Value

Returns decoded string.

### Encode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/encode.md

#### SymmetricEncryptionAttribute.Encode method

Encrypts string based on provided algorithm type, key and salt parameters

```csharp
public string Encode(string source)
```

| Parameter | Type | Description |
| --- | --- | --- |
| source | String | Source string to encode |

##### Return Value

Returns encoded string.

### SymmetricEncryptionAttribute
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/symmetricencryptionattribute.md

#### SymmetricEncryptionAttribute(SymmetricAlgorithmType, string, string)

Creates symmetric algorithm with parameters.

```csharp
public SymmetricEncryptionAttribute(SymmetricAlgorithmType algorithmType, string key, string salt)
```

| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | String | Encryption key |
| salt | String | Passphrase for encryption |

#### SymmetricEncryptionAttribute(SymmetricAlgorithmType, string)

Creates symmetric algorithm with parameters and default passphrase.

```csharp
public SymmetricEncryptionAttribute(SymmetricAlgorithmType algorithmType, string key)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | SymmetricAlgorithmType | Encryption key |
| algorithmType | String | Encryption algorithm type |

### TextShadow
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow.md

#### TextShadow class

Represents text shadow properties for text signatures. The result may vary depending on the signature type and document format. TextShadow is recommended for using with TextAsImage signature for all supported document types, also with simple TextSignature and TextSignature as watermark for Spreadsheets (.xslx) and Presentations (.pptx). Simple TextSignature for Words (.docx) is recommended too, but has limited functionality.

```csharp
public class TextShadow : SignatureExtension
```

#### Constructors

| Name | Description |
| --- | --- |
| TextShadow() | Creates TextShadow with default options. |

#### Properties

| Name | Description |
| --- | --- |
| Angle { get; set; } | Gets or sets angle for placing shadow relative to the text. Default value is 0. |
| Blur { get; set; } | Gets or sets blur of the shadow. Default value is 4. |
| Color { get; set; } | Gets or sets color of the shadow. Default value is Black. |
| Distance { get; set; } | Gets or sets distance from text to shadow. Default value is 1. |
| Transparency { get; set; } | Gets or sets transparency of the shadow. Default value is 0. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Gets a copy of this object. |

### Angle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/angle.md

#### TextShadow.Angle property

Gets or sets angle for placing shadow relative to the text. Default value is 0.

```csharp
public double Angle { get; set; }
```

### Blur
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/blur.md

#### TextShadow.Blur property

Gets or sets blur of the shadow. Default value is 4.

```csharp
public double Blur { get; set; }
```

### Color
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/color.md

#### TextShadow.Color property

Gets or sets color of the shadow. Default value is Black.

```csharp
public Color Color { get; set; }
```

### Distance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/distance.md

#### TextShadow.Distance property

Gets or sets distance from text to shadow. Default value is 1.

```csharp
public double Distance { get; set; }
```

### TextShadow
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/textshadow.md

#### TextShadow constructor

Creates TextShadow with default options.

```csharp
public TextShadow()
```

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/textshadow/transparency.md

#### TextShadow.Transparency property

Gets or sets transparency of the shadow. Default value is 0.

```csharp
public double Transparency { get; set; }
```

### TextureBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/texturebrush.md

#### TextureBrush class

Represents texture brush.

```csharp
public class TextureBrush : Brush
```

#### Constructors

| Name | Description |
| --- | --- |
| TextureBrush() | Initializes a new instance of the TextureBrush class with default values. |
| TextureBrush(Stream) | Initializes a new instance of the TextureBrush class with image stream option. |
| TextureBrush(string) | Initializes a new instance of the TextureBrush class with image file. |

#### Properties

| Name | Description |
| --- | --- |
| ImageFilePath { get; set; } | Gets or sets the texture image file path. This property is used only if ImageStream is not specified. |
| ImageStream { get; set; } | Gets or sets the texture image stream. If this property is specified it is always used instead ImageFilePath. |

### ImageFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/texturebrush/imagefilepath.md

#### TextureBrush.ImageFilePath property

Gets or sets the texture image file path. This property is used only if ImageStream is not specified.

```csharp
public string ImageFilePath { get; set; }
```

### ImageStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/texturebrush/imagestream.md

#### TextureBrush.ImageStream property

Gets or sets the texture image stream. If this property is specified it is always used instead ImageFilePath.

```csharp
public Stream ImageStream { get; set; }
```

### TextureBrush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/texturebrush/texturebrush.md

#### TextureBrush()

Initializes a new instance of the TextureBrush class with default values.

```csharp
public TextureBrush()
```

#### TextureBrush(string)

Initializes a new instance of the TextureBrush class with image file.

```csharp
public TextureBrush(string imageFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | String | Image file path. |

#### TextureBrush(Stream)

Initializes a new instance of the TextureBrush class with image stream option.

```csharp
public TextureBrush(Stream imageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | Image stream. |

### VCard
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard.md

#### VCard class

Represents Electronic Business Card standard contact details.

```csharp
public class VCard
```

#### Constructors

| Name | Description |
| --- | --- |
| VCard() | Creates VCard instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| BirthDay { get; set; } | Gets or sets contact birthday. |
| CellPhone { get; set; } | Gets or sets cellular phone number. |
| Company { get; set; } | Gets or sets Company of contact. |
| Email { get; set; } | Gets or sets contact email. |
| FirstName { get; set; } | Gets or sets contact First Name. |
| HomeAddress { get; set; } | Gets or sets Home Address properties. This property is not initialized by default. |
| HomePhone { get; set; } | Gets or sets home phone number. |
| Initials { get; set; } | Gets or sets contact initials. |
| JobTitle { get; set; } | Gets or sets contact Job Title. |
| LastName { get; set; } | Gets or sets contact Last Name. |
| MidddleName { get; set; } | Gets or sets contact Middle Name. |
| Url { get; set; } | Gets or sets contact URL. |
| WorkAddress { get; set; } | Gets or sets Work Address properties. This property is not initialized by default. |
| WorkPhone { get; set; } | Gets or sets work phone number. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare VCard properties |
| override GetHashCode() | Overrides GetHashCode method |

### BirthDay
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/birthday.md

#### VCard.BirthDay property

Gets or sets contact birthday.

```csharp
public DateTime? BirthDay { get; set; }
```

### CellPhone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/cellphone.md

#### VCard.CellPhone property

Gets or sets cellular phone number.

```csharp
public string CellPhone { get; set; }
```

### Company
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/company.md

#### VCard.Company property

Gets or sets Company of contact.

```csharp
public string Company { get; set; }
```

### Email
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/email.md

#### VCard.Email property

Gets or sets contact email.

```csharp
public string Email { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/equals.md

#### VCard.Equals method

Overwrites Equals method to compare VCard properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | VCard object to compare with. |

##### Return Value

Returns true if passed VCard object has same type and all its properties are equal to this instance properties.

### FirstName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/firstname.md

#### VCard.FirstName property

Gets or sets contact First Name.

```csharp
public string FirstName { get; set; }
```

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/gethashcode.md

#### VCard.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

VCard hash code

### HomeAddress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/homeaddress.md

#### VCard.HomeAddress property

Gets or sets Home Address properties. This property is not initialized by default.

```csharp
public Address HomeAddress { get; set; }
```

### HomePhone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/homephone.md

#### VCard.HomePhone property

Gets or sets home phone number.

```csharp
public string HomePhone { get; set; }
```

### Initials
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/initials.md

#### VCard.Initials property

Gets or sets contact initials.

```csharp
public string Initials { get; set; }
```

### JobTitle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/jobtitle.md

#### VCard.JobTitle property

Gets or sets contact Job Title.

```csharp
public string JobTitle { get; set; }
```

### LastName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/lastname.md

#### VCard.LastName property

Gets or sets contact Last Name.

```csharp
public string LastName { get; set; }
```

### MidddleName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/midddlename.md

#### VCard.MidddleName property

Gets or sets contact Middle Name.

```csharp
public string MidddleName { get; set; }
```

### Url
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/url.md

#### VCard.Url property

Gets or sets contact URL.

```csharp
public string Url { get; set; }
```

### VCard
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/vcard.md

#### VCard constructor

Creates VCard instance with default values.

```csharp
public VCard()
```

### WorkAddress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/workaddress.md

#### VCard.WorkAddress property

Gets or sets Work Address properties. This property is not initialized by default.

```csharp
public Address WorkAddress { get; set; }
```

### WorkPhone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/vcard/workphone.md

#### VCard.WorkPhone property

Gets or sets work phone number.

```csharp
public string WorkPhone { get; set; }
```

### WiFi
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi.md

#### WiFi class

Represents WiFi network connection details.

```csharp
public class WiFi
```

#### Constructors

| Name | Description |
| --- | --- |
| WiFi() | Creates WiFi instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Encryption { get; set; } | Gets or sets WiFi encryption `WiFiEncryptionType`. |
| Hidden { get; set; } | Gets or sets if WiFi is Hidden SSID. |
| Password { get; set; } | Gets or sets WiFi Password. |
| SSID { get; set; } | Gets or sets WiFi SSID Name. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overwrites Equals method to compare WiFi properties |
| override GetHashCode() | Overrides GetHashCode method |

### Encryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/encryption.md

#### WiFi.Encryption property

Gets or sets WiFi encryption `WiFiEncryptionType`.

```csharp
public WiFiEncryptionType Encryption { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/equals.md

#### WiFi.Equals method

Overwrites Equals method to compare WiFi properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | WiFi object to compare with. |

##### Return Value

Returns true if passed WiFi object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/gethashcode.md

#### WiFi.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

WiFi hash code

### Hidden
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/hidden.md

#### WiFi.Hidden property

Gets or sets if WiFi is Hidden SSID.

```csharp
public bool Hidden { get; set; }
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/password.md

#### WiFi.Password property

Gets or sets WiFi Password.

```csharp
public string Password { get; set; }
```

### SSID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/ssid.md

#### WiFi.SSID property

Gets or sets WiFi SSID Name.

```csharp
public string SSID { get; set; }
```

### WiFi
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifi/wifi.md

#### WiFi constructor

Creates WiFi instance with default values.

```csharp
public WiFi()
```

### WiFiEncryptionType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.extensions/wifiencryptiontype.md

#### WiFiEncryptionType enumeration

Represents WiFi Encryption type.

```csharp
public enum WiFiEncryptionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Represents no encryption WiFi type. |
| WPA | `1` | Represents WiFi with the WPA encryption type. |
| WPAEAP | `2` | Represents WiFi with the WPA-EAP encryption type. |
| WPAWPA2 | `3` | Represents WiFi with the WPA/WPA2 encryption type. |
| WEP | `4` | Represents WiFi with the WEP encryption type. |

### GroupDocs.Signature.Domain
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain.md

The namespace provides classes for working with document representation.

#### Classes

| Class | Description |
| --- | --- |
| Background | Represents background appearance |
| BarcodeSignature | Contains Barcode Signature properties. |
| BarcodeType | Specifies Barcode type properties. |
| BarcodeTypes | Barcode Types container. |
| BaseSignature | Describes base class for signatures. |
| Border | Represents border appearance |
| CertificateMetadataSignature | Contains Certificate Metadata Signature properties. |
| CheckboxFormFieldSignature | Contains check-box input form field signature properties. |
| ComboboxFormFieldSignature | Contains combo-box input form field signature properties. |
| Corners | Represents corners of a square graphical object. |
| DeleteResult | Result of signature(s) deletion from the document. |
| DigitalFormFieldSignature | Contains digital signature input form field properties for Pdf Documents. |
| DigitalSignature | Contains Digital signature properties. |
| DocumentInfo | Defines document description properties. |
| DocumentResultSignature | Result of processing archive document signing process for document with newly created signatures. |
| FileType | Represents file type. |
| FormFieldSignature | Contains Form field signature properties. |
| ImageMetadataSignature | Contains Image Metadata signature properties. |
| ImageSignature | Contains Image signature properties. |
| MetadataSignature | Contains Metadata signature properties. |
| MetadataSignatureCollection | Collection of Metadata signature objects. |
| Padding | Represents padding or margin information associated with element. |
| PageInfo | Document page description class |
| PdfDigitalSignature | Contains Pdf Digital signature properties. |
| PdfMetadataSignature | Contains Pdf Metadata signature properties. |
| PdfMetadataSignatures | Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options. |
| PresentationMetadataSignature | Contains Presentation metadata signature properties. |
| ProcessLog | Represents document process details. |
| QrCodeSignature | Contains QR-code signature properties. |
| QrCodeType | Specify QRCode type properties. |
| QrCodeTypes | QRCode Types container. |
| RadioButtonFormFieldSignature | Contains radio-button input form field signature properties. |
| SearchResult | Result of searching for signatures in specified document. |
| SignatureFont | Creates instance of SignatureFont class to specify Font properties. |
| SignResult | Result of signing process for document with newly created signatures. |
| SpreadsheetMetadataSignature | Contains Spreadsheet Metadata Signature properties. |
| SquareBorder | Instance to keep Border line properties for square stamp line. |
| StampLine | Specify Stamp line properties. |
| StampType | Specify stamp type properties. |
| StampTypes | Stamp types container. |
| TextFormFieldSignature | Contains text input form field signature properties for Pdf Document |
| TextSignature | Contains Text signature properties. |
| UpdateResult | Result of modification of signatures in the document. |
| VerificationResult | Instance to keep results of verification process. |
| WordProcessingMetadataSignature | Contains WordProcessing Metadata Signature properties. |
#### Structures

| Structure | Description |
| --- | --- |
| TimeStamp | Represents data to get time stamp from third-party site. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IAlignment | Describes signature area alignment on a document page. |
| IDocumentInfo | Defines document description properties. |
| IRectangle | Defines interface properties for signature area on a document page. |
| IResult | Common interface for signature process result. |
| IRotation | Defines properties for signature rotation. |
| ITextAlignment | Defines alignment properties for text on text signatures. |
| ITransparency | Define Transparency property for different objects appearances |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| CodeTextAlignment | Alignment of code text for Barcodes and QR-codes. |
| DashStyle | Represents style of dash drawing lines on documents. |
| DocumentType | Defines the Document type. |
| FormFieldType | Specifies Form Field type. |
| FormTextFieldType | Defines types of text for WordsProcessing document form fields. |
| HashAlgorithm | Specifies the hash algorithm used for cryptographic signing. |
| HorizontalAlignment | Specifies horizontal alignment of element on a document page. |
| ImageSaveFileFormat | Defines different save file formats. |
| MeasureType | Specifies measure units of signature on a document page. |
| MetadataType | Specifies the supported Metadata signature data type of the value. |
| PdfDigitalSignatureType | Describes enumeration of PDF digital signature type. |
| PdfSaveFileFormat | Defines different save file formats. |
| PdfTextAnnotationBorderEffect | Describes effect which should be applied to the border of the PDF text annotations. |
| PdfTextStickerIcon | Describes enumeration of PDF Text annotation sticker icon appearance. |
| PdfTextStickerState | Describes enumeration of PDF text annotation sticker states. |
| PresentationSaveFileFormat | Defines different save file formats. |
| ProcessStatus | Specifies status of signing and verification processes. |
| ProcessType | Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete |
| ShapePosition | Specifies shape position in the document layout |
| SignatureType | Defines supported types of signatures for various processes like Sign, Verify, Search, Update, Delete |
| SpreadsheetSaveFileFormat | Defines different save formats for Spreadsheet documents. |
| StampBackgroundCropType | Specifies crop type of background layer on Stamp elements. |
| StampTextRepeatType | Specifies type of text repeat for stamp lines. |
| StretchMode | Represents stretch mode of signature area on a document page. |
| TextHorizontalAlignment | Specifies text horizontal alignment inside a signature. |
| TextMatchType | Specifies text match type in string. |
| TextShapeType | Specifies types of text shapes. |
| TextSignatureImplementation | Specifies type of implementation for PDF text signature. |
| TextVerticalAlignment | Specifies text vertical alignment inside a signature. |
| VerticalAlignment | Specifies vertical alignment of element on a document page. |
| WordProcessingSaveFileFormat | Defines different save file formats for WordProcessing documents. |
| WordProcessingTextSignatureImplementation | Specifies type of text signature implementation for WordProcessing documents. |
| XAdESType | Type of XML Advanced Electronic Signature (XAdES). |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### Background
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background.md

#### Background class

Represents background appearance

```csharp
public class Background : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| Background() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Brush { get; set; } | Gets or sets the background brush. Value by default is null. This property expects instance of Brush objects implementations See different Brush classes |
| Color { get; set; } | Gets or sets the background color of signature. |
| Transparency { get; set; } | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)). |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Implement IClonable interface |

### Background
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background/background.md

#### Background constructor

The default constructor.

```csharp
public Background()
```

### Brush
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background/brush.md

#### Background.Brush property

Gets or sets the background brush. Value by default is null. This property expects instance of Brush objects implementations See different Brush classes

```csharp
public Brush Brush { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background/clone.md

#### Background.Clone method

Implement IClonable interface

```csharp
public object Clone()
```

##### Return Value

Newly created Border instance with same properties

### Color
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background/color.md

#### Background.Color property

Gets or sets the background color of signature.

```csharp
public Color Color { get; set; }
```

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/background/transparency.md

#### Background.Transparency property

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

```csharp
public double Transparency { get; set; }
```

### BarcodeSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature.md

#### BarcodeSignature class

Contains Barcode Signature properties.

```csharp
public class BarcodeSignature : BaseSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| BarcodeSignature(string) | Initialize BarcodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer. |

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Specifies Barcode binary data image content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| EncodeType { get; } | Specifies the Barcode Encode Type. |
| Format { get; } | Specifies the format of Barcode signature image. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Text { get; } | Specifies text of Barcode. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Barcode Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### BarcodeSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/barcodesignature.md

#### BarcodeSignature constructor

Initialize BarcodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

```csharp
public BarcodeSignature(string signatureId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | String | Unique signature identifier obtained by Sign or Search method of Signature class `Signature`. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/clone.md

#### BarcodeSignature.Clone method

Clone Barcode Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Barcode Signature instance.

### Content
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/content.md

#### BarcodeSignature.Content property

Specifies Barcode binary data image content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature.

```csharp
public byte[] Content { get; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/encodetype.md

#### BarcodeSignature.EncodeType property

Specifies the Barcode Encode Type.

```csharp
public BarcodeType EncodeType { get; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/equals.md

#### BarcodeSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### Format
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/format.md

#### BarcodeSignature.Format property

Specifies the format of Barcode signature image.

```csharp
public FileType Format { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/gethashcode.md

#### BarcodeSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodesignature/text.md

#### BarcodeSignature.Text property

Specifies text of Barcode.

```csharp
public string Text { get; }
```

### BarcodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetype.md

#### BarcodeType class

Specifies Barcode type properties.

```csharp
public sealed class BarcodeType : IEquatable<BarcodeType>
```

#### Properties

| Name | Description |
| --- | --- |
| TypeIndex { get; } | Gets object index in a collection of supported Barcode types. |
| TypeName { get; } | Name of Barcode Type. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(BarcodeType) | Determines whether the specified BarcodeType is equal to the current object. |
| override Equals(object) | Overridden method determines whether the specified System.Object is equal to the current System.Object. |
| override GetHashCode() | Overridden method serves as a hash function for a particular type. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetype/equals.md

#### Equals(BarcodeType)

Determines whether the specified BarcodeType is equal to the current object.

```csharp
public bool Equals(BarcodeType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | BarcodeType | Object for comparison. |

##### Return Value

Result of comparison.

#### Equals(object)

Overridden method determines whether the specified System.Object is equal to the current System.Object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Object for comparison. |

##### Return Value

Result of comparison.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetype/gethashcode.md

#### BarcodeType.GetHashCode method

Overridden method serves as a hash function for a particular type.

```csharp
public override int GetHashCode()
```

##### Return Value

Hash code.

### TypeIndex
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetype/typeindex.md

#### BarcodeType.TypeIndex property

Gets object index in a collection of supported Barcode types.

```csharp
public int TypeIndex { get; }
```

### TypeName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetype/typename.md

#### BarcodeType.TypeName property

Name of Barcode Type.

```csharp
public string TypeName { get; }
```

### BarcodeTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes.md

#### BarcodeTypes class

Barcode Types container.

```csharp
public static class BarcodeTypes
```

#### Properties

| Name | Description |
| --- | --- |
| static AllTypes { get; } | All barcode types. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown. |
| static TryParse(string) | Returns Barcode type with pasringType name. If name of Barcode is unknown - no Exception will be thrown but method will return null value. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly AustralianPost | Australian Post Barcode Type object. |
| static readonly AustralianPosteParcel | Australian Post eParcel Barcode Type object. |
| static readonly Codabar | Codabar Barcode Type object. |
| static readonly CodablockF | CodablockF Barcode Type object. |
| static readonly Code11 | Code11 Barcode Type object. |
| static readonly Code128 | Code128 Barcode Type object. |
| static readonly Code16K | Code16K Barcode Type object. |
| static readonly Code32 | Code32 Barcode Type object. |
| static readonly Code39 | Code39 Barcode Type object. |
| static readonly Code39FullASCII | Code39FullASCII Barcode Type object. |
| static readonly Code93 | Code93 Barcode Type object. |
| static readonly Code93Standard | Code93Standard Barcode Type object. |
| static readonly DatabarExpanded | DatabarExpanded Barcode Type object. |
| static readonly DatabarExpandedStacked | DatabarExpandedStacked Barcode Type object. |
| static readonly DatabarLimited | DatabarLimited Barcode Type object. |
| static readonly DatabarOmniDirectional | DatabarOmniDirectional Barcode Type object. |
| static readonly DatabarStacked | DatabarStacked Barcode Type object. |
| static readonly DatabarStackedOmniDirectional | DatabarStackedOmniDirectional Barcode Type object. |
| static readonly DatabarTruncated | DatabarTruncated Barcode Type object. |
| static readonly DataLogic2of5 | DataLogic2of5 Barcode Type object. |
| static readonly DeutschePostIdentcode | DeutschePostIdentcode Barcode Type object. |
| static readonly DeutschePostLeitcode | DeutschePostLeitcode Barcode Type object. |
| static readonly DotCode | DotCode Barcode Type object. |
| static readonly DutchKIX | DutchKIX Barcode Type object. |
| static readonly EAN13 | EAN13 Barcode Type object. |
| static readonly EAN14 | EAN14 Barcode Type object. |
| static readonly EAN8 | EAN8 Barcode Type object. |
| static readonly GS1Aztec | GS1Aztec Barcode Type object. |
| static readonly GS1CodablockF | GS1CodablockF Barcode Type object. |
| static readonly GS1Code128 | GS1 Code128 Barcode Type object. |
| static readonly GS1CompositeBar | GS1 Composite Barcode Type object. |
| static readonly GS1DotCode | GS1 DotCode Barcode Type object. |
| static readonly GS1MicroPdf417 | GS1MicroPdf417 Barcode Type object. |
| static readonly HIBCCode128LIC | HIBC LIC 128 Barcode Type object. |
| static readonly HIBCCode128PAS | HIBC PAS 128 Barcode Type object. |
| static readonly HIBCCode39LIC | HIBC LIC 39 Barcode Type object. |
| static readonly HIBCCode39PAS | HIBC PAS 39 Barcode Type object. |
| static readonly IATA2of5 | IATA2of5 Barcode Type object. |
| static readonly Interleaved2of5 | Interleaved2of5 Barcode Type object. |
| static readonly ISBN | ISBN Barcode Type object. |
| static readonly ISMN | ISMN Barcode Type object. |
| static readonly ISSN | ISSN Barcode Type object. |
| static readonly ItalianPost25 | ItalianPost25 Barcode Type object. |
| static readonly ITF14 | ITF14 Barcode Type object. |
| static readonly ITF6 | ITF6 Barcode Type object. |
| static readonly MacroPdf417 | MacroPdf417 Barcode Type object. |
| static readonly Mailmark | Royal Mail 2D Mailmark Barcode Type object. |
| static readonly Matrix2of5 | Matrix2of5 Barcode Type object. |
| static readonly MaxiCode | MaxiCode Barcode Type object. |
| static readonly MicroPdf417 | MicroPdf417 Barcode Type object. |
| static readonly MSI | MSI Barcode Type object. |
| static readonly OneCode | OneCode Barcode Type object. |
| static readonly OPC | OPC Barcode Type object. |
| static readonly PatchCode | Patch Code Barcode Type object. |
| static readonly Pdf417 | Pdf417 Barcode Type object. |
| static readonly Pharmacode | Pharma code Barcode Type object. |
| static readonly Planet | Planet Barcode Type object. |
| static readonly Postnet | Postnet Barcode Type object. |
| static readonly PZN | PZN Barcode Type object. |
| static readonly RM4SCC | RM4SCC Barcode Type object. |
| static readonly SCC14 | SCC14 Barcode Type object. |
| static readonly SingaporePost | SingaporePost Barcode Type object. |
| static readonly SSCC18 | SSCC18 Barcode Type object. |
| static readonly Standard2of5 | Standard2of5 Barcode Type object. |
| static readonly SwissPostParcel | SwissPostParcel Barcode Type object. |
| static readonly UPCA | UPCA Barcode Type object. |
| static readonly UpcaGs1Code128Coupon | UpcaGs1Code128Coupon Barcode Type object. |
| static readonly UpcaGs1DatabarCoupon | UpcaGs1DatabarCoupon Barcode Type object. |
| static readonly UPCE | UPCE Barcode Type object. |
| static readonly VIN | VIN Barcode Type object. |

### AllTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/alltypes.md

#### BarcodeTypes.AllTypes property

All barcode types.

```csharp
public static BarcodeType[] AllTypes { get; }
```

### AustralianPost
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/australianpost.md

#### BarcodeTypes.AustralianPost field

Australian Post Barcode Type object.

```csharp
public static readonly BarcodeType AustralianPost;
```

### AustralianPosteParcel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/australianposteparcel.md

#### BarcodeTypes.AustralianPosteParcel field

Australian Post eParcel Barcode Type object.

```csharp
public static readonly BarcodeType AustralianPosteParcel;
```

### Codabar
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/codabar.md

#### BarcodeTypes.Codabar field

Codabar Barcode Type object.

```csharp
public static readonly BarcodeType Codabar;
```

### CodablockF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/codablockf.md

#### BarcodeTypes.CodablockF field

CodablockF Barcode Type object.

```csharp
public static readonly BarcodeType CodablockF;
```

### Code11
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code11.md

#### BarcodeTypes.Code11 field

Code11 Barcode Type object.

```csharp
public static readonly BarcodeType Code11;
```

### Code128
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code128.md

#### BarcodeTypes.Code128 field

Code128 Barcode Type object.

```csharp
public static readonly BarcodeType Code128;
```

### Code16K
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code16k.md

#### BarcodeTypes.Code16K field

Code16K Barcode Type object.

```csharp
public static readonly BarcodeType Code16K;
```

### Code32
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code32.md

#### BarcodeTypes.Code32 field

Code32 Barcode Type object.

```csharp
public static readonly BarcodeType Code32;
```

### Code39
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code39.md

#### BarcodeTypes.Code39 field

Code39 Barcode Type object.

```csharp
public static readonly BarcodeType Code39;
```

### Code39FullASCII
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code39fullascii.md

#### BarcodeTypes.Code39FullASCII field

Code39FullASCII Barcode Type object.

```csharp
public static readonly BarcodeType Code39FullASCII;
```

### Code93
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code93.md

#### BarcodeTypes.Code93 field

Code93 Barcode Type object.

```csharp
public static readonly BarcodeType Code93;
```

### Code93Standard
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/code93standard.md

#### BarcodeTypes.Code93Standard field

Code93Standard Barcode Type object.

```csharp
public static readonly BarcodeType Code93Standard;
```

### DatabarExpanded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databarexpanded.md

#### BarcodeTypes.DatabarExpanded field

DatabarExpanded Barcode Type object.

```csharp
public static readonly BarcodeType DatabarExpanded;
```

### DatabarExpandedStacked
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databarexpandedstacked.md

#### BarcodeTypes.DatabarExpandedStacked field

DatabarExpandedStacked Barcode Type object.

```csharp
public static readonly BarcodeType DatabarExpandedStacked;
```

### DatabarLimited
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databarlimited.md

#### BarcodeTypes.DatabarLimited field

DatabarLimited Barcode Type object.

```csharp
public static readonly BarcodeType DatabarLimited;
```

### DatabarOmniDirectional
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databaromnidirectional.md

#### BarcodeTypes.DatabarOmniDirectional field

DatabarOmniDirectional Barcode Type object.

```csharp
public static readonly BarcodeType DatabarOmniDirectional;
```

### DatabarStacked
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databarstacked.md

#### BarcodeTypes.DatabarStacked field

DatabarStacked Barcode Type object.

```csharp
public static readonly BarcodeType DatabarStacked;
```

### DatabarStackedOmniDirectional
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databarstackedomnidirectional.md

#### BarcodeTypes.DatabarStackedOmniDirectional field

DatabarStackedOmniDirectional Barcode Type object.

```csharp
public static readonly BarcodeType DatabarStackedOmniDirectional;
```

### DatabarTruncated
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/databartruncated.md

#### BarcodeTypes.DatabarTruncated field

DatabarTruncated Barcode Type object.

```csharp
public static readonly BarcodeType DatabarTruncated;
```

### DataLogic2of5
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/datalogic2of5.md

#### BarcodeTypes.DataLogic2of5 field

DataLogic2of5 Barcode Type object.

```csharp
public static readonly BarcodeType DataLogic2of5;
```

### DeutschePostIdentcode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/deutschepostidentcode.md

#### BarcodeTypes.DeutschePostIdentcode field

DeutschePostIdentcode Barcode Type object.

```csharp
public static readonly BarcodeType DeutschePostIdentcode;
```

### DeutschePostLeitcode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/deutschepostleitcode.md

#### BarcodeTypes.DeutschePostLeitcode field

DeutschePostLeitcode Barcode Type object.

```csharp
public static readonly BarcodeType DeutschePostLeitcode;
```

### DotCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/dotcode.md

#### BarcodeTypes.DotCode field

DotCode Barcode Type object.

```csharp
public static readonly BarcodeType DotCode;
```

### DutchKIX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/dutchkix.md

#### BarcodeTypes.DutchKIX field

DutchKIX Barcode Type object.

```csharp
public static readonly BarcodeType DutchKIX;
```

### EAN13
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/ean13.md

#### BarcodeTypes.EAN13 field

EAN13 Barcode Type object.

```csharp
public static readonly BarcodeType EAN13;
```

### EAN14
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/ean14.md

#### BarcodeTypes.EAN14 field

EAN14 Barcode Type object.

```csharp
public static readonly BarcodeType EAN14;
```

### EAN8
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/ean8.md

#### BarcodeTypes.EAN8 field

EAN8 Barcode Type object.

```csharp
public static readonly BarcodeType EAN8;
```

### GS1Aztec
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1aztec.md

#### BarcodeTypes.GS1Aztec field

GS1Aztec Barcode Type object.

```csharp
public static readonly BarcodeType GS1Aztec;
```

### GS1CodablockF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1codablockf.md

#### BarcodeTypes.GS1CodablockF field

GS1CodablockF Barcode Type object.

```csharp
public static readonly BarcodeType GS1CodablockF;
```

### GS1Code128
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1code128.md

#### BarcodeTypes.GS1Code128 field

GS1 Code128 Barcode Type object.

```csharp
public static readonly BarcodeType GS1Code128;
```

### GS1CompositeBar
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1compositebar.md

#### BarcodeTypes.GS1CompositeBar field

GS1 Composite Barcode Type object.

```csharp
public static readonly BarcodeType GS1CompositeBar;
```

### GS1DotCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1dotcode.md

#### BarcodeTypes.GS1DotCode field

GS1 DotCode Barcode Type object.

```csharp
public static readonly BarcodeType GS1DotCode;
```

### GS1MicroPdf417
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/gs1micropdf417.md

#### BarcodeTypes.GS1MicroPdf417 field

GS1MicroPdf417 Barcode Type object.

```csharp
public static readonly BarcodeType GS1MicroPdf417;
```

### HIBCCode128LIC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/hibccode128lic.md

#### BarcodeTypes.HIBCCode128LIC field

HIBC LIC 128 Barcode Type object.

```csharp
public static readonly BarcodeType HIBCCode128LIC;
```

### HIBCCode128PAS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/hibccode128pas.md

#### BarcodeTypes.HIBCCode128PAS field

HIBC PAS 128 Barcode Type object.

```csharp
public static readonly BarcodeType HIBCCode128PAS;
```

### HIBCCode39LIC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/hibccode39lic.md

#### BarcodeTypes.HIBCCode39LIC field

HIBC LIC 39 Barcode Type object.

```csharp
public static readonly BarcodeType HIBCCode39LIC;
```

### HIBCCode39PAS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/hibccode39pas.md

#### BarcodeTypes.HIBCCode39PAS field

HIBC PAS 39 Barcode Type object.

```csharp
public static readonly BarcodeType HIBCCode39PAS;
```

### IATA2of5
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/iata2of5.md

#### BarcodeTypes.IATA2of5 field

IATA2of5 Barcode Type object.

```csharp
public static readonly BarcodeType IATA2of5;
```

### Interleaved2of5
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/interleaved2of5.md

#### BarcodeTypes.Interleaved2of5 field

Interleaved2of5 Barcode Type object.

```csharp
public static readonly BarcodeType Interleaved2of5;
```

### ISBN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/isbn.md

#### BarcodeTypes.ISBN field

ISBN Barcode Type object.

```csharp
public static readonly BarcodeType ISBN;
```

### ISMN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/ismn.md

#### BarcodeTypes.ISMN field

ISMN Barcode Type object.

```csharp
public static readonly BarcodeType ISMN;
```

### ISSN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/issn.md

#### BarcodeTypes.ISSN field

ISSN Barcode Type object.

```csharp
public static readonly BarcodeType ISSN;
```

### ItalianPost25
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/italianpost25.md

#### BarcodeTypes.ItalianPost25 field

ItalianPost25 Barcode Type object.

```csharp
public static readonly BarcodeType ItalianPost25;
```

### ITF14
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/itf14.md

#### BarcodeTypes.ITF14 field

ITF14 Barcode Type object.

```csharp
public static readonly BarcodeType ITF14;
```

### ITF6
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/itf6.md

#### BarcodeTypes.ITF6 field

ITF6 Barcode Type object.

```csharp
public static readonly BarcodeType ITF6;
```

### MacroPdf417
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/macropdf417.md

#### BarcodeTypes.MacroPdf417 field

MacroPdf417 Barcode Type object.

```csharp
public static readonly BarcodeType MacroPdf417;
```

### Mailmark
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/mailmark.md

#### BarcodeTypes.Mailmark field

Royal Mail 2D Mailmark Barcode Type object.

```csharp
public static readonly BarcodeType Mailmark;
```

### Matrix2of5
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/matrix2of5.md

#### BarcodeTypes.Matrix2of5 field

Matrix2of5 Barcode Type object.

```csharp
public static readonly BarcodeType Matrix2of5;
```

### MaxiCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/maxicode.md

#### BarcodeTypes.MaxiCode field

MaxiCode Barcode Type object.

```csharp
public static readonly BarcodeType MaxiCode;
```

### MicroPdf417
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/micropdf417.md

#### BarcodeTypes.MicroPdf417 field

MicroPdf417 Barcode Type object.

```csharp
public static readonly BarcodeType MicroPdf417;
```

### MSI
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/msi.md

#### BarcodeTypes.MSI field

MSI Barcode Type object.

```csharp
public static readonly BarcodeType MSI;
```

### OneCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/onecode.md

#### BarcodeTypes.OneCode field

OneCode Barcode Type object.

```csharp
public static readonly BarcodeType OneCode;
```

### OPC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/opc.md

#### BarcodeTypes.OPC field

OPC Barcode Type object.

```csharp
public static readonly BarcodeType OPC;
```

### Parse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/parse.md

#### BarcodeTypes.Parse method

Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown.

```csharp
public static BarcodeType Parse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of barcode type name. |

##### Return Value

BarcodeType instance.

### PatchCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/patchcode.md

#### BarcodeTypes.PatchCode field

Patch Code Barcode Type object.

```csharp
public static readonly BarcodeType PatchCode;
```

### Pdf417
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/pdf417.md

#### BarcodeTypes.Pdf417 field

Pdf417 Barcode Type object.

```csharp
public static readonly BarcodeType Pdf417;
```

### Pharmacode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/pharmacode.md

#### BarcodeTypes.Pharmacode field

Pharma code Barcode Type object.

```csharp
public static readonly BarcodeType Pharmacode;
```

### Planet
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/planet.md

#### BarcodeTypes.Planet field

Planet Barcode Type object.

```csharp
public static readonly BarcodeType Planet;
```

### Postnet
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/postnet.md

#### BarcodeTypes.Postnet field

Postnet Barcode Type object.

```csharp
public static readonly BarcodeType Postnet;
```

### PZN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/pzn.md

#### BarcodeTypes.PZN field

PZN Barcode Type object.

```csharp
public static readonly BarcodeType PZN;
```

### RM4SCC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/rm4scc.md

#### BarcodeTypes.RM4SCC field

RM4SCC Barcode Type object.

```csharp
public static readonly BarcodeType RM4SCC;
```

### SCC14
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/scc14.md

#### BarcodeTypes.SCC14 field

SCC14 Barcode Type object.

```csharp
public static readonly BarcodeType SCC14;
```

### SingaporePost
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/singaporepost.md

#### BarcodeTypes.SingaporePost field

SingaporePost Barcode Type object.

```csharp
public static readonly BarcodeType SingaporePost;
```

### SSCC18
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/sscc18.md

#### BarcodeTypes.SSCC18 field

SSCC18 Barcode Type object.

```csharp
public static readonly BarcodeType SSCC18;
```

### Standard2of5
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/standard2of5.md

#### BarcodeTypes.Standard2of5 field

Standard2of5 Barcode Type object.

```csharp
public static readonly BarcodeType Standard2of5;
```

### SwissPostParcel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/swisspostparcel.md

#### BarcodeTypes.SwissPostParcel field

SwissPostParcel Barcode Type object.

```csharp
public static readonly BarcodeType SwissPostParcel;
```

### TryParse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/tryparse.md

#### BarcodeTypes.TryParse method

Returns Barcode type with pasringType name. If name of Barcode is unknown - no Exception will be thrown but method will return null value.

```csharp
public static BarcodeType TryParse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of barcode type name. |

##### Return Value

BarcodeType instance.

### UPCA
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/upca.md

#### BarcodeTypes.UPCA field

UPCA Barcode Type object.

```csharp
public static readonly BarcodeType UPCA;
```

### UpcaGs1Code128Coupon
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/upcags1code128coupon.md

#### BarcodeTypes.UpcaGs1Code128Coupon field

UpcaGs1Code128Coupon Barcode Type object.

```csharp
public static readonly BarcodeType UpcaGs1Code128Coupon;
```

### UpcaGs1DatabarCoupon
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/upcags1databarcoupon.md

#### BarcodeTypes.UpcaGs1DatabarCoupon field

UpcaGs1DatabarCoupon Barcode Type object.

```csharp
public static readonly BarcodeType UpcaGs1DatabarCoupon;
```

### UPCE
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/upce.md

#### BarcodeTypes.UPCE field

UPCE Barcode Type object.

```csharp
public static readonly BarcodeType UPCE;
```

### VIN
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/barcodetypes/vin.md

#### BarcodeTypes.VIN field

VIN Barcode Type object.

```csharp
public static readonly BarcodeType VIN;
```

### BaseSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature.md

#### BaseSignature class

Describes base class for signatures.

```csharp
public abstract class BaseSignature : ICloneable
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Clone signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/clone.md

#### BaseSignature.Clone method

Clone signature instance.

```csharp
public virtual object Clone()
```

##### Return Value

Returns cloned Signature instance

### CreatedOn
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/createdon.md

#### BaseSignature.CreatedOn property

Get or set the signature creation date.

```csharp
public DateTime CreatedOn { get; set; }
```

### Deleted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/deleted.md

#### BaseSignature.Deleted property

Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.

```csharp
public bool Deleted { get; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/equals.md

#### BaseSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/gethashcode.md

#### BaseSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/height.md

#### BaseSignature.Height property

Specifies height of signature.

```csharp
public int Height { get; set; }
```

### IsSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/issignature.md

#### BaseSignature.IsSignature property

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).

```csharp
public bool IsSignature { get; set; }
```

### Left
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/left.md

#### BaseSignature.Left property

Specifies left position of signature.

```csharp
public int Left { get; set; }
```

### ModifiedOn
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/modifiedon.md

#### BaseSignature.ModifiedOn property

Get or set the signature modification date.

```csharp
public DateTime ModifiedOn { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/pagenumber.md

#### BaseSignature.PageNumber property

Specifies the page signature was found on.

```csharp
public int? PageNumber { get; }
```

### SignatureId
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/signatureid.md

#### BaseSignature.SignatureId property

Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.

```csharp
public string SignatureId { get; }
```

### SignatureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/signaturetype.md

#### BaseSignature.SignatureType property

Specifies the type of signature.

```csharp
public SignatureType SignatureType { get; }
```

### Top
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/top.md

#### BaseSignature.Top property

Specifies top position of signature.

```csharp
public int Top { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/basesignature/width.md

#### BaseSignature.Width property

Specifies width of signature.

```csharp
public int Width { get; set; }
```

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border.md

#### Border class

Represents border appearance

```csharp
public class Border : ICloneable, ITransparency
```

#### Constructors

| Name | Description |
| --- | --- |
| Border() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | Gets or sets the border color of signature. |
| DashStyle { get; set; } | Gets or sets the signature border style. |
| Transparency { get; set; } | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| Visible { get; set; } | Gets or sets the border visibility. |
| Weight { get; set; } | Gets or sets the weight of the signature border. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Implement IClonable interface |

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/border.md

#### Border constructor

The default constructor.

```csharp
public Border()
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/clone.md

#### Border.Clone method

Implement IClonable interface

```csharp
public object Clone()
```

##### Return Value

Newly created Border instance with same properties

### Color
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/color.md

#### Border.Color property

Gets or sets the border color of signature.

```csharp
public Color Color { get; set; }
```

### DashStyle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/dashstyle.md

#### Border.DashStyle property

Gets or sets the signature border style.

```csharp
public DashStyle DashStyle { get; set; }
```

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/transparency.md

#### Border.Transparency property

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

```csharp
public double Transparency { get; set; }
```

### Visible
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/visible.md

#### Border.Visible property

Gets or sets the border visibility.

```csharp
public bool Visible { get; set; }
```

### Weight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/border/weight.md

#### Border.Weight property

Gets or sets the weight of the signature border.

```csharp
public double Weight { get; set; }
```

### CertificateMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/certificatemetadatasignature.md

#### CertificateMetadataSignature class

Contains Certificate Metadata Signature properties.

```csharp
public sealed class CertificateMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| CertificateMetadataSignature(string) | Creates Certificate Metadata Signature with predefined name and empty value. |
| CertificateMetadataSignature(string, object) | Creates Certificate Metadata Signature with predefined values. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Certificate Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| override ToString(string, IFormatProvider) | Converts to String with specified format |

### CertificateMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/certificatemetadatasignature/certificatemetadatasignature.md

#### CertificateMetadataSignature(string)

Creates Certificate Metadata Signature with predefined name and empty value.

```csharp
public CertificateMetadataSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Certificate Metadata Signature name. |

#### CertificateMetadataSignature(string, object)

Creates Certificate Metadata Signature with predefined values.

```csharp
public CertificateMetadataSignature(string name, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object. |
| value | Object | Value of Metadata signature. |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/certificatemetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Certificate Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/certificatemetadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public override string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

### CheckboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature.md

#### CheckboxFormFieldSignature class

Contains check-box input form field signature properties.

```csharp
public sealed class CheckboxFormFieldSignature : FormFieldSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| CheckboxFormFieldSignature(string) | Creates CheckboxFormFieldSignature with predefined name. |
| CheckboxFormFieldSignature(string, bool) | Creates CheckboxFormFieldSignature with predefined name and value |

#### Properties

| Name | Description |
| --- | --- |
| Checked { get; set; } | Gets or sets checked value of form field check-box input. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### CheckboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature/checkboxformfieldsignature.md

#### CheckboxFormFieldSignature(string)

Creates CheckboxFormFieldSignature with predefined name.

```csharp
public CheckboxFormFieldSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |

#### CheckboxFormFieldSignature(string, bool)

Creates CheckboxFormFieldSignature with predefined name and value

```csharp
public CheckboxFormFieldSignature(string name, bool isChecked)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| isChecked | Boolean | Value if check box is checked |

### Checked
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature/checked.md

#### CheckboxFormFieldSignature.Checked property

Gets or sets checked value of form field check-box input.

```csharp
public bool Checked { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature/clone.md

#### CheckboxFormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature/equals.md

#### CheckboxFormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/checkboxformfieldsignature/gethashcode.md

#### CheckboxFormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### CodeTextAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/codetextalignment.md

#### CodeTextAlignment enumeration

Alignment of code text for Barcodes and QR-codes.

```csharp
public enum CodeTextAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Text is not visible. |
| Above | `1` | Text is above the code. |
| Below | `2` | Text is below the code. |

### ComboboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature.md

#### ComboboxFormFieldSignature class

Contains combo-box input form field signature properties.

```csharp
public sealed class ComboboxFormFieldSignature : FormFieldSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| ComboboxFormFieldSignature(string) | Creates ComboboxFormFieldSignature with predefined name. |
| ComboboxFormFieldSignature(string, List&lt;string&gt;) | Creates ComboboxFormFieldSignature with predefined name and options list. |
| ComboboxFormFieldSignature(string, List&lt;string&gt;, object) | Creates ComboboxFormFieldSignature with predefined name, options list and selected value. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Items { get; set; } | Get or set combo-box options list. |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| Selected { get; set; } | Get or set selected value. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/clone.md

#### ComboboxFormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### ComboboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/comboboxformfieldsignature.md

#### ComboboxFormFieldSignature(string)

Creates ComboboxFormFieldSignature with predefined name.

```csharp
public ComboboxFormFieldSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |

#### ComboboxFormFieldSignature(string, List&lt;string&gt;)

Creates ComboboxFormFieldSignature with predefined name and options list.

```csharp
public ComboboxFormFieldSignature(string name, List<string> items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| items | List`1 | Values of combo-box list. |

#### ComboboxFormFieldSignature(string, List&lt;string&gt;, object)

Creates ComboboxFormFieldSignature with predefined name, options list and selected value.

```csharp
public ComboboxFormFieldSignature(string name, List<string> items, object selected)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| items | List`1 | Values of combo-box list. |
| selected | Object | Selected value. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/equals.md

#### ComboboxFormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/gethashcode.md

#### ComboboxFormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Items
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/items.md

#### ComboboxFormFieldSignature.Items property

Get or set combo-box options list.

```csharp
public List<string> Items { get; set; }
```

### Selected
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/comboboxformfieldsignature/selected.md

#### ComboboxFormFieldSignature.Selected property

Get or set selected value.

```csharp
public string Selected { get; set; }
```

### Corners
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners.md

#### Corners class

Represents corners of a square graphical object.

```csharp
public class Corners : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| Corners() | Initializes a new instance of Corners class using zero values. |
| Corners(double) | Initializes a new instance of the Corners class using the supplied value for all corners. |
| Corners(double, double, double, double) | Initializes a new instance of the Corners class using the supplied values. |

#### Properties

| Name | Description |
| --- | --- |
| All { get; set; } | Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0; |
| BottomLeft { get; set; } | Gets or sets bottom left corner value. |
| BottomRight { get; set; } | Gets or sets bottom right corner value. |
| TopLeft { get; set; } | Gets or sets top left corner value. |
| TopRight { get; set; } | Gets or sets top right corner value. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |
| override Equals(object) | Override equals method |
| override GetHashCode() | Overrides obtaining unique hash code value |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | Provides a Corners object with no data. |

### All
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/all.md

#### Corners.All property

Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;

```csharp
public double All { get; set; }
```

### BottomLeft
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/bottomleft.md

#### Corners.BottomLeft property

Gets or sets bottom left corner value.

```csharp
public double BottomLeft { get; set; }
```

### BottomRight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/bottomright.md

#### Corners.BottomRight property

Gets or sets bottom right corner value.

```csharp
public double BottomRight { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/clone.md

#### Corners.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### Corners
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/corners.md

#### Corners()

Initializes a new instance of Corners class using zero values.

```csharp
public Corners()
```

#### Corners(double)

Initializes a new instance of the Corners class using the supplied value for all corners.

```csharp
public Corners(double all)
```

| Parameter | Type | Description |
| --- | --- | --- |
| all | Double | The value to be used for padding for all corners. |

#### Corners(double, double, double, double)

Initializes a new instance of the Corners class using the supplied values.

```csharp
public Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)
```

| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | Double | Top left corner value. |
| topRight | Double | Top right corner value. |
| bottomLeft | Double | Bottom left corner value. |
| bottomRight | Double | Bottom right corner value. |

### Empty
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/empty.md

#### Corners.Empty field

Provides a Corners object with no data.

```csharp
public static readonly Corners Empty;
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/equals.md

#### Corners.Equals method

Override equals method

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Instance to compare with. |

##### Return Value

Returns true if properties of objects are equal.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/gethashcode.md

#### Corners.GetHashCode method

Overrides obtaining unique hash code value

```csharp
public override int GetHashCode()
```

### TopLeft
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/topleft.md

#### Corners.TopLeft property

Gets or sets top left corner value.

```csharp
public double TopLeft { get; set; }
```

### TopRight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/corners/topright.md

#### Corners.TopRight property

Gets or sets top right corner value.

```csharp
public double TopRight { get; set; }
```

### DashStyle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/dashstyle.md

#### DashStyle enumeration

Represents style of dash drawing lines on documents.

```csharp
public enum DashStyle
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Solid | `0` | Represent a solid line. |
| ShortDash | `1` | Represent a short dash line. |
| ShortDot | `2` | Represent a short dot line. |
| ShortDashDot | `3` | Represent a short dash-dot line. |
| ShortDashDotDot | `4` | Represent a short dash-dot-dot line. |
| Dot | `5` | Represent a square dot style. |
| Dash | `6` | Represent a dash line style. |
| LongDash | `7` | Represent a long dash style. |
| DashDot | `8` | Dash short dash. |
| LongDashDot | `9` | Long dash short dash. |
| LongDashDotDot | `10` | Long dash short dash short dash. |
| RoundDot | `11` | Represents a round-dot line. |
| SquareDot | `12` | Represents a square-dot line. |
| DashDotDot | `13` | Represents a dash-dot-dot line. |
| DashLongDash | `14` | Represents a long dash-short dash line. |
| DashLongDashDot | `15` | Represents a long dash-short dash-dot line. |

### DeleteResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult.md

#### DeleteResult class

Result of signature(s) deletion from the document.

```csharp
public class DeleteResult : IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns updated document size. |
| Failed { get; } | List of signatures that were not deleted `BaseSignature`. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds. |
| SourceDocumentSize { get; } | Returns source document size. |
| Succeeded { get; } | List of successfully deleted signatures `BaseSignature`. |
| TotalSignatures { get; } | Returns the total processed signatures. |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/destindocumentsize.md

#### DeleteResult.DestinDocumentSize property

Returns updated document size.

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/failed.md

#### DeleteResult.Failed property

List of signatures that were not deleted `BaseSignature`.

```csharp
public List<BaseSignature> Failed { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/processingtime.md

#### DeleteResult.ProcessingTime property

Returns the execution time of the process in milliseconds.

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/sourcedocumentsize.md

#### DeleteResult.SourceDocumentSize property

Returns source document size.

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/succeeded.md

#### DeleteResult.Succeeded property

List of successfully deleted signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/deleteresult/totalsignatures.md

#### DeleteResult.TotalSignatures property

Returns the total processed signatures.

```csharp
public int TotalSignatures { get; }
```

### DigitalFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature.md

#### DigitalFormFieldSignature class

Contains digital signature input form field properties for Pdf Documents.

```csharp
public sealed class DigitalFormFieldSignature : FormFieldSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalFormFieldSignature(string) | Creates PdfDigitalFormFieldSignature with predefined name. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Signed { get; } | Read-only property that shows if Form-field Signature was signed with digital certificate. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature/clone.md

#### DigitalFormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### DigitalFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature/digitalformfieldsignature.md

#### DigitalFormFieldSignature constructor

Creates PdfDigitalFormFieldSignature with predefined name.

```csharp
public DigitalFormFieldSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature/equals.md

#### DigitalFormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature/gethashcode.md

#### DigitalFormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Signed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalformfieldsignature/signed.md

#### DigitalFormFieldSignature.Signed property

Read-only property that shows if Form-field Signature was signed with digital certificate.

```csharp
public bool Signed { get; }
```

### DigitalSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature.md

#### DigitalSignature class

Contains Digital signature properties.

```csharp
public class DigitalSignature : BaseSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalSignature() | Initialize Digital signature with default parameters. |
| DigitalSignature(string) | Initialize Digital signature with known SignatureId. |
| DigitalSignature(X509Certificate2) | Create Digital signature with specified certificate. |
| DigitalSignature(X509Store) | Create Digital signature based on specified X509 store. First certificate from specified store will be used. |
| DigitalSignature(X509Store, int) | Create Digital signature based on specified X509 Store and index of certificate. |

#### Properties

| Name | Description |
| --- | --- |
| Certificate { get; set; } | Gets or sets the X509 certificate. |
| CertificateCustomStoreName { get; set; } | Specifies the custom store name of the certificate. |
| CertificateStoreLocation { get; set; } | Specifies the store location of the certificate |
| CertificateStoreName { get; set; } | Specifies the store name of the certificate. |
| Comments { get; set; } | Gets or sets the signing purpose comment. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| IsValid { get; set; } | Keeps true if this digital signature is valid and the document has not been tampered with. |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| SignTime { get; set; } | Gets or sets the time the document was signed. |
| Thumbprint { get; } | Gets the thumbprint of a certificate. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |
| XAdESType { get; } | XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Barcode Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |
| static LoadDigitalSignatures() | Load Digital signatures from all system X509 Certificates Stores. |
| static LoadDigitalSignatures(StoreName) | Load Digital signatures from a certificate storage. |
| static LoadDigitalSignatures(string) | Load Digital signatures from a certificate storage. |
| static LoadDigitalSignatures(StoreName, StoreLocation) | Load Digital signatures from a digital certificate storage placed in specific location. |
| static LoadDigitalSignatures(string, StoreLocation) | Load Digital signatures from a digital certificate storage placed in specific location. |

### Certificate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/certificate.md

#### DigitalSignature.Certificate property

Gets or sets the X509 certificate.

```csharp
public X509Certificate2 Certificate { get; set; }
```

### CertificateCustomStoreName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/certificatecustomstorename.md

#### DigitalSignature.CertificateCustomStoreName property

Specifies the custom store name of the certificate.

```csharp
public string CertificateCustomStoreName { get; set; }
```

### CertificateStoreLocation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/certificatestorelocation.md

#### DigitalSignature.CertificateStoreLocation property

Specifies the store location of the certificate

```csharp
public StoreLocation CertificateStoreLocation { get; set; }
```

### CertificateStoreName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/certificatestorename.md

#### DigitalSignature.CertificateStoreName property

Specifies the store name of the certificate.

```csharp
public StoreName CertificateStoreName { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/clone.md

#### DigitalSignature.Clone method

Clone Barcode Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Barcode Signature instance.

### Comments
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/comments.md

#### DigitalSignature.Comments property

Gets or sets the signing purpose comment.

```csharp
public string Comments { get; set; }
```

### DigitalSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/digitalsignature.md

#### DigitalSignature()

Initialize Digital signature with default parameters.

```csharp
public DigitalSignature()
```

#### DigitalSignature(string)

Initialize Digital signature with known SignatureId.

```csharp
public DigitalSignature(string signatureId)
```

#### DigitalSignature(X509Store)

Create Digital signature based on specified X509 store. First certificate from specified store will be used.

```csharp
public DigitalSignature(X509Store store)
```

| Parameter | Type | Description |
| --- | --- | --- |
| store | X509Store | X509 store. |

#### DigitalSignature(X509Store, int)

Create Digital signature based on specified X509 Store and index of certificate.

```csharp
public DigitalSignature(X509Store store, int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| store | X509Store | X509 store. |
| index | Int32 | Index of certificate. |

#### DigitalSignature(X509Certificate2)

Create Digital signature with specified certificate.

```csharp
public DigitalSignature(X509Certificate2 certificate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificate | X509Certificate2 | X509 certificate. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/equals.md

#### DigitalSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/gethashcode.md

#### DigitalSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### IsValid
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/isvalid.md

#### DigitalSignature.IsValid property

Keeps true if this digital signature is valid and the document has not been tampered with.

```csharp
public bool IsValid { get; set; }
```

### LoadDigitalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/loaddigitalsignatures.md

#### LoadDigitalSignatures()

Load Digital signatures from all system X509 Certificates Stores.

```csharp
public static List<DigitalSignature> LoadDigitalSignatures()
```

##### Return Value

Returns list of `DigitalSignature` Digital Signatures.

#### LoadDigitalSignatures(StoreName)

Load Digital signatures from a certificate storage.

```csharp
public static List<DigitalSignature> LoadDigitalSignatures(StoreName storeName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storeName | StoreName | Name of a digital storage containing certificates. |

##### Return Value

Returns list of `DigitalSignature` Digital Signatures.

#### LoadDigitalSignatures(string)

Load Digital signatures from a certificate storage.

```csharp
public static List<DigitalSignature> LoadDigitalSignatures(string storeName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storeName | String | Custom name of a digital storage containing certificates. |

##### Return Value

Returns list of `DigitalSignature` Digital Signatures.

#### LoadDigitalSignatures(StoreName, StoreLocation)

Load Digital signatures from a digital certificate storage placed in specific location.

```csharp
public static List<DigitalSignature> LoadDigitalSignatures(StoreName storeName, 
    StoreLocation storeLocation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storeName | StoreName | Name of a digital storage containing certificates. |
| storeLocation | StoreLocation | Location of a digital certificate storage. |

##### Return Value

Returns list of `DigitalSignature` Digital Signatures.

#### LoadDigitalSignatures(string, StoreLocation)

Load Digital signatures from a digital certificate storage placed in specific location.

```csharp
public static List<DigitalSignature> LoadDigitalSignatures(string storeName, 
    StoreLocation storeLocation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| storeName | String | Custom name of a digital storage containing certificates. |
| storeLocation | StoreLocation | Location of a digital certificate storage. |

##### Return Value

Returns list of `DigitalSignature` Digital Signatures.

### SignTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/signtime.md

#### DigitalSignature.SignTime property

Gets or sets the time the document was signed.

```csharp
public DateTime SignTime { get; set; }
```

### Thumbprint
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/thumbprint.md

#### DigitalSignature.Thumbprint property

Gets the thumbprint of a certificate.

```csharp
public string Thumbprint { get; }
```

### XAdESType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/digitalsignature/xadestype.md

#### DigitalSignature.XAdESType property

XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

```csharp
public XAdESType XAdESType { get; }
```

### DocumentInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo.md

#### DocumentInfo class

Defines document description properties.

```csharp
public class DocumentInfo : IDocumentInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| DocumentInfo() | Initializes a new instance of the `DocumentInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| BarcodeSignatures { get; } | Collection of document barcode signatures added or updated by `Signature` methods. |
| DigitalSignatures { get; } | Collection of document digital signatures added or updated by `Signature` methods. |
| Documents { get; } | Collection of all existing documents within the archive files. This property is supported only for Archive document types. |
| FileType { get; set; } | File format type. |
| FormFields { get; } | Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types. |
| FormFieldSignatures { get; } | Collection of document Form Field signatures added or updated by `Signature` methods. |
| ImageSignatures { get; } | Collection of document image signatures added or updated by `Signature` methods. |
| MaxPageHeight { get; set; } | Specifies max page height. |
| MetadataSignatures { get; } | Collection of document Metadata signatures. |
| PageCount { get; set; } | Document pages count. |
| Pages { get; set; } | Collection of document pages descriptions. |
| ProcessLogs { get; } | Collection of document history processes like Sign, Update, Delete. |
| QrCodeSignatures { get; } | Collection of document QR-code signatures added or updated by `Signature` methods. |
| Signatures { get; } | Collection of document all types signatures `BaseSignature`. |
| Size { get; set; } | Document size in bytes. |
| TextSignatures { get; } | Collection of document text signatures. |
| WidthForMaxHeight { get; set; } | Specifies width for max page height. |

### BarcodeSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/barcodesignatures.md

#### DocumentInfo.BarcodeSignatures property

Collection of document barcode signatures added or updated by `Signature` methods.

```csharp
public IList<BarcodeSignature> BarcodeSignatures { get; }
```

### DigitalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/digitalsignatures.md

#### DocumentInfo.DigitalSignatures property

Collection of document digital signatures added or updated by `Signature` methods.

```csharp
public IList<DigitalSignature> DigitalSignatures { get; }
```

### DocumentInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/documentinfo.md

#### DocumentInfo constructor

Initializes a new instance of the `DocumentInfo` class.

```csharp
public DocumentInfo()
```

### Documents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/documents.md

#### DocumentInfo.Documents property

Collection of all existing documents within the archive files. This property is supported only for Archive document types.

```csharp
public IList<DocumentResultSignature> Documents { get; }
```

### FileType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/filetype.md

#### DocumentInfo.FileType property

File format type.

```csharp
public FileType FileType { get; set; }
```

### FormFields
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/formfields.md

#### DocumentInfo.FormFields property

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.

```csharp
public IList<FormFieldSignature> FormFields { get; }
```

### FormFieldSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/formfieldsignatures.md

#### DocumentInfo.FormFieldSignatures property

Collection of document Form Field signatures added or updated by `Signature` methods.

```csharp
public IList<FormFieldSignature> FormFieldSignatures { get; }
```

### ImageSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/imagesignatures.md

#### DocumentInfo.ImageSignatures property

Collection of document image signatures added or updated by `Signature` methods.

```csharp
public IList<ImageSignature> ImageSignatures { get; }
```

### MaxPageHeight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/maxpageheight.md

#### DocumentInfo.MaxPageHeight property

Specifies max page height.

```csharp
public int MaxPageHeight { get; set; }
```

### MetadataSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/metadatasignatures.md

#### DocumentInfo.MetadataSignatures property

Collection of document Metadata signatures.

```csharp
public IList<MetadataSignature> MetadataSignatures { get; }
```

### PageCount
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/pagecount.md

#### DocumentInfo.PageCount property

Document pages count.

```csharp
public int PageCount { get; set; }
```

### Pages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/pages.md

#### DocumentInfo.Pages property

Collection of document pages descriptions.

```csharp
public IList<PageInfo> Pages { get; set; }
```

### ProcessLogs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/processlogs.md

#### DocumentInfo.ProcessLogs property

Collection of document history processes like Sign, Update, Delete.

```csharp
public IList<ProcessLog> ProcessLogs { get; }
```

### QrCodeSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/qrcodesignatures.md

#### DocumentInfo.QrCodeSignatures property

Collection of document QR-code signatures added or updated by `Signature` methods.

```csharp
public IList<QrCodeSignature> QrCodeSignatures { get; }
```

### Signatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/signatures.md

#### DocumentInfo.Signatures property

Collection of document all types signatures `BaseSignature`.

```csharp
public IList<BaseSignature> Signatures { get; }
```

### Size
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/size.md

#### DocumentInfo.Size property

Document size in bytes.

```csharp
public long Size { get; set; }
```

### TextSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/textsignatures.md

#### DocumentInfo.TextSignatures property

Collection of document text signatures.

```csharp
public IList<TextSignature> TextSignatures { get; }
```

### WidthForMaxHeight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentinfo/widthformaxheight.md

#### DocumentInfo.WidthForMaxHeight property

Specifies width for max page height.

```csharp
public int WidthForMaxHeight { get; set; }
```

### DocumentResultSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature.md

#### DocumentResultSignature class

Result of processing archive document signing process for document with newly created signatures.

```csharp
public class DocumentResultSignature : BaseSignature, IResult
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| DestinDocumentSize { get; } | Returns destination document size |
| ErrorMessage { get; } | if document was processed with error this property will contain the error message |
| Failed { get; } | List of the signatures that failed during the process `BaseSignature`. |
| FileName { get; } | Document file name |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| SourceDocumentSize { get; } | Returns source document size |
| Succeeded { get; } | List of successfully processed signatures `BaseSignature`. |
| Top { get; set; } | Specifies top position of signature. |
| TotalSignatures { get; } | Returns the total processed signatures |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Clone() | Clone signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/destindocumentsize.md

#### DocumentResultSignature.DestinDocumentSize property

Returns destination document size

```csharp
public long DestinDocumentSize { get; }
```

### ErrorMessage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/errormessage.md

#### DocumentResultSignature.ErrorMessage property

if document was processed with error this property will contain the error message

```csharp
public string ErrorMessage { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/failed.md

#### DocumentResultSignature.Failed property

List of the signatures that failed during the process `BaseSignature`.

```csharp
public List<BaseSignature> Failed { get; }
```

### FileName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/filename.md

#### DocumentResultSignature.FileName property

Document file name

```csharp
public string FileName { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/processingtime.md

#### DocumentResultSignature.ProcessingTime property

Returns the execution time of the process in milliseconds

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/sourcedocumentsize.md

#### DocumentResultSignature.SourceDocumentSize property

Returns source document size

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/succeeded.md

#### DocumentResultSignature.Succeeded property

List of successfully processed signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documentresultsignature/totalsignatures.md

#### DocumentResultSignature.TotalSignatures property

Returns the total processed signatures

```csharp
public int TotalSignatures { get; }
```

### DocumentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/documenttype.md

#### DocumentType enumeration

Defines the Document type.

```csharp
public enum DocumentType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Indicates an error, unknown document type. |
| Pdf | `1` | PDF Document Type. |
| WordProcessing | `2` | Word Processing Document Type. |
| Presentation | `3` | Presentation Document Type. |
| Spreadsheet | `4` | Spreadsheet Document Type. |
| Image | `5` | Image Document Type. |
| Certificate | `6` | Certificate file Type. |
| Archive | `7` | Archive file type |

### FileType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype.md

#### FileType class

Represents file type.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Filename suffix (including the period ".") e.g. ".doc". |
| FileFormat { get; } | File type name e.g. "Microsoft Word Document". |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps file extension to file type. |
| Equals(FileType) | Determines whether the current `FileType` is the same as specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static GetSupportedFileTypes() | Retrieves supported file types |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly APNG | Animated Portable Network Graphics (.png) is a raster image file format that uses lossless compression. It was developed as an extension of PNG to support animation, serving as an alternative to the GIF format without copyright limitations. Learn more about this file format [here](https://wiki.fileformat.com/image/apng). |
| static readonly AZW3 | WordPerfect Document (.wpd) |
| static readonly BMP | Bitmap Image File (.bmp) is 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 | CorelDraw Vector Graphic Drawing (.cdr) 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 CGM | Computer Graphics Metafile (.cgm) is a 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 CMX | CorelDRAW Metafile Exchange Image File (.cmx) |
| static readonly CSV | Comma Separated Values File (.csv) represents 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 DCM | DICOM Image (.dcm) represents 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 DJVU | DjVu Image (.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 DOC | Microsoft Word Document (.doc) represents 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 | Word Open XML Macro-Enabled Document (.docm) is a 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 | Microsoft Word Open XML Document (.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 | Word Document Template (.dot) are template files created by Microsoft Word to have preformatted 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 | Word Open XML Macro-Enabled Document Template (.dotm) 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 | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx). |
| static readonly EMF | Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files 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 EPS | Encapsulated PostScript File (.eps) describes 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 GIF | Graphical Interchange Format File (.gif) 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 GZip | GZip compressed archive (.gz) compressing files with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz). |
| static readonly JPEG | JPEG Image (.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 JPG | JPEG Image (.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 LZip | LZip compressed archive (.lz) compressing files with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/lz). |
| static readonly ODG | OpenDocument Graphic File (.odg) 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 ODP | OpenDocument Presentation (.odp) represents 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 ODS | OpenDocument Spreadsheet (.ods) stands 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 ODT | OpenDocument Text Document (.odt) 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 OTP | OpenDocument Presentation Template (.otp) represents 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 OTS | OpenDocument Spreadsheet Template (.ots) |
| static readonly OTT | OpenDocument Document Template (.ott) represents 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 PCL | Printer Command Language Document (.pcl) |
| static readonly PDF | Portable Document Format File (.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). |
| static readonly PFX | Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application. Learn more about this file format [here](https://fileinfo.com/extension/pfx). |
| static readonly PNG | Portable Network Graphic (.png) is a type of raster image file format that use lossless 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 POT | PowerPoint Template (.pot) represents 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 | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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 | PowerPoint Open XML Presentation Template (.potx) represents 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 | PowerPoint Slide Show (.pps) 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 | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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 | PowerPoint Open XML Slide Show (.ppsx) files 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 | PowerPoint Presentation (.ppt) 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 | PowerPoint Open XML Macro-Enabled Presentation 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 | PowerPoint Open XML Presentation (.pptx) 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). |
| static readonly PS | PostScript File (.ps) |
| static readonly PSD | Adobe Photoshop Document (.psd) 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 RTF | Rich Text Format File (.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 SevenZip | High compressed archive (.7z) compressing files and folders with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/7z). |
| static readonly SVG | Scalable Vector Graphics File (.svg) 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 TAR | Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories. Learn more about this file format [here](https://docs.fileformat.com/compression/tar/). |
| static readonly TGA | Truevision TGA (.tga), also known as TARGA, is a raster image file format developed by Truevision Inc. It supports various color depths and optional RLE compression. TGA files are commonly used in video games, animation pipelines, and graphics applications for high-quality image rendering with optional alpha channel support. Learn more about this file format [here](https://wiki.fileformat.com/image/tga). |
| static readonly TIF | Tagged Image File (.tif) 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 | Tagged Image File Format (.tiff) 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 TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv). |
| static readonly TXT | Plain Text File (.txt) 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). |
| static readonly Unknown | Represents unknown file type. |
| static readonly VCF | vCard File (.vcf) 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). |
| static readonly WEBP | WebP Image (.webp) 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 | Windows Metafile (.wmf) represents 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 WPD | WordPerfect Document (.wpd) |
| static readonly XLS | Excel Spreadsheet (.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 | Excel Binary Spreadsheet (.xlsb) 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 | Excel Open XML Macro-Enabled Spreadsheet (.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 | Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 | Excel binary Template (.xlt) represents Excel Template File Format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt). |
| static readonly XLTM | Excel Office OpenXML file Template (.xltm) represents Excel Template File Format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm). |
| static readonly ZIP | Document ZIP archive (.zip) is an archive file format that supports lossless data compression. Can hold one or more files or directories. Learn more about this file format [here](https://docs.fileformat.com/compression/zip/). |

### APNG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/apng.md

#### FileType.APNG field

Animated Portable Network Graphics (.png) is a raster image file format that uses lossless compression. It was developed as an extension of PNG to support animation, serving as an alternative to the GIF format without copyright limitations. Learn more about this file format [here](https://wiki.fileformat.com/image/apng).

```csharp
public static readonly FileType APNG;
```

### AZW3
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/azw3.md

#### FileType.AZW3 field

WordPerfect Document (.wpd)

```csharp
public static readonly FileType AZW3;
```

### BMP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/bmp.md

#### FileType.BMP field

Bitmap Image File (.bmp) is 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 FileType BMP;
```

### CDR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/cdr.md

#### FileType.CDR field

CorelDraw Vector Graphic Drawing (.cdr) 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 FileType CDR;
```

### CGM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/cgm.md

#### FileType.CGM field

Computer Graphics Metafile (.cgm) is a 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 FileType CGM;
```

### CMX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/cmx.md

#### FileType.CMX field

CorelDRAW Metafile Exchange Image File (.cmx)

```csharp
public static readonly FileType CMX;
```

### CSV
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/csv.md

#### FileType.CSV field

Comma Separated Values File (.csv) represents 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 FileType CSV;
```

### DCM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/dcm.md

#### FileType.DCM field

DICOM Image (.dcm) represents 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 FileType DCM;
```

### DJVU
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/djvu.md

#### FileType.DJVU field

DjVu Image (.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 FileType DJVU;
```

### DOC
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/doc.md

#### FileType.DOC field

Microsoft Word Document (.doc) represents 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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/docm.md

#### FileType.DOCM field

Word Open XML Macro-Enabled Document (.docm) is a 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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/docx.md

#### FileType.DOCX field

Microsoft Word Open XML Document (.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/dot.md

#### FileType.DOT field

Word Document Template (.dot) are template files created by Microsoft Word to have preformatted 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 FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/dotm.md

#### FileType.DOTM field

Word Open XML Macro-Enabled Document Template (.dotm) 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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/dotx.md

#### FileType.DOTX field

Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted 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 FileType DOTX;
```

### EMF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/emf.md

#### FileType.EMF field

Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files 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 FileType EMF;
```

### EPS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/eps.md

#### FileType.EPS field

Encapsulated PostScript File (.eps) describes 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 FileType EPS;
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FileType` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

### Extension
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/extension.md

#### FileType.Extension property

Filename suffix (including the period ".") e.g. ".doc".

```csharp
public string Extension { get; }
```

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/fileformat.md

#### FileType.FileFormat property

File type name e.g. "Microsoft Word Document".

```csharp
public string FileFormat { get; }
```

### FromExtension
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/fromextension.md

#### FileType.FromExtension method

Maps file extension to file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension (including the period "."). |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty string. |

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns the hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns sequence of supported file types

### GIF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/gif.md

#### FileType.GIF field

Graphical Interchange Format File (.gif) 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 FileType GIF;
```

### GZip
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/gzip.md

#### FileType.GZip field

GZip compressed archive (.gz) compressing files with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz).

```csharp
public static readonly FileType GZip;
```

### JPEG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/jpeg.md

#### FileType.JPEG field

JPEG Image (.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 FileType JPEG;
```

### JPG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/jpg.md

#### FileType.JPG field

JPEG Image (.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 FileType JPG;
```

### LZip
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/lzip.md

#### FileType.LZip field

LZip compressed archive (.lz) compressing files with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/compression/lz).

```csharp
public static readonly FileType LZip;
```

### ODG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/odg.md

#### FileType.ODG field

OpenDocument Graphic File (.odg) 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 FileType ODG;
```

### ODP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/odp.md

#### FileType.ODP field

OpenDocument Presentation (.odp) represents 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 FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ods.md

#### FileType.ODS field

OpenDocument Spreadsheet (.ods) stands 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 FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/odt.md

#### FileType.ODT field

OpenDocument Text Document (.odt) 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 FileType ODT;
```

### op_Equality
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

### OTP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/otp.md

#### FileType.OTP field

OpenDocument Presentation Template (.otp) represents 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 FileType OTP;
```

### OTS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ots.md

#### FileType.OTS field

OpenDocument Spreadsheet Template (.ots)

```csharp
public static readonly FileType OTS;
```

### OTT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ott.md

#### FileType.OTT field

OpenDocument Document Template (.ott) represents 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 FileType OTT;
```

### PCL
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pcl.md

#### FileType.PCL field

Printer Command Language Document (.pcl)

```csharp
public static readonly FileType PCL;
```

### PDF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pdf.md

#### FileType.PDF field

Portable Document Format File (.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 FileType PDF;
```

### PFX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pfx.md

#### FileType.PFX field

Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application. Learn more about this file format [here](https://fileinfo.com/extension/pfx).

```csharp
public static readonly FileType PFX;
```

### PNG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/png.md

#### FileType.PNG field

Portable Network Graphic (.png) is a type of raster image file format that use lossless 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 FileType PNG;
```

### POT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pot.md

#### FileType.POT field

PowerPoint Template (.pot) represents 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 FileType POT;
```

### POTM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/potm.md

#### FileType.POTM field

PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/potx.md

#### FileType.POTX field

PowerPoint Open XML Presentation Template (.potx) represents 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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pps.md

#### FileType.PPS field

PowerPoint Slide Show (.pps) 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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ppsm.md

#### FileType.PPSM field

PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ppsx.md

#### FileType.PPSX field

PowerPoint Open XML Slide Show (.ppsx) files 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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ppt.md

#### FileType.PPT field

PowerPoint Presentation (.ppt) 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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pptm.md

#### FileType.PPTM field

PowerPoint Open XML Macro-Enabled Presentation 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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/pptx.md

#### FileType.PPTX field

PowerPoint Open XML Presentation (.pptx) 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 FileType PPTX;
```

### PS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/ps.md

#### FileType.PS field

PostScript File (.ps)

```csharp
public static readonly FileType PS;
```

### PSD
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/psd.md

#### FileType.PSD field

Adobe Photoshop Document (.psd) 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 FileType PSD;
```

### RTF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/rtf.md

#### FileType.RTF field

Rich Text Format File (.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 FileType RTF;
```

### SevenZip
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/sevenzip.md

#### FileType.SevenZip field

High compressed archive (.7z) compressing files and folders with a high compression ratio. Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/7z).

```csharp
public static readonly FileType SevenZip;
```

### SVG
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/svg.md

#### FileType.SVG field

Scalable Vector Graphics File (.svg) 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 FileType SVG;
```

### TAR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tar.md

#### FileType.TAR field

Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories. Learn more about this file format [here](https://docs.fileformat.com/compression/tar/).

```csharp
public static readonly FileType TAR;
```

### TGA
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tga.md

#### FileType.TGA field

Truevision TGA (.tga), also known as TARGA, is a raster image file format developed by Truevision Inc. It supports various color depths and optional RLE compression. TGA files are commonly used in video games, animation pipelines, and graphics applications for high-quality image rendering with optional alpha channel support. Learn more about this file format [here](https://wiki.fileformat.com/image/tga).

```csharp
public static readonly FileType TGA;
```

### TIF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tif.md

#### FileType.TIF field

Tagged Image File (.tif) 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 FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tiff.md

#### FileType.TIFF field

Tagged Image File Format (.tiff) 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 FileType TIFF;
```

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TSV
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/tsv.md

#### FileType.TSV field

Tab Separated Values File (.tsv) 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 FileType TSV;
```

### TXT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/txt.md

#### FileType.TXT field

Plain Text File (.txt) 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 FileType TXT;
```

### Unknown
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VCF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/vcf.md

#### FileType.VCF field

vCard File (.vcf) 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 FileType VCF;
```

### WEBP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/webp.md

#### FileType.WEBP field

WebP Image (.webp) 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 FileType WEBP;
```

### WMF
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/wmf.md

#### FileType.WMF field

Windows Metafile (.wmf) represents 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 FileType WMF;
```

### WPD
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/wpd.md

#### FileType.WPD field

WordPerfect Document (.wpd)

```csharp
public static readonly FileType WPD;
```

### XLS
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xls.md

#### FileType.XLS field

Excel Spreadsheet (.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 FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xlsb.md

#### FileType.XLSB field

Excel Binary Spreadsheet (.xlsb) 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 FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xlsm.md

#### FileType.XLSM field

Excel Open XML Macro-Enabled Spreadsheet (.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 FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xlsx.md

#### FileType.XLSX field

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xlt.md

#### FileType.XLT field

Excel binary Template (.xlt) represents Excel Template File Format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/xltm.md

#### FileType.XLTM field

Excel Office OpenXML file Template (.xltm) represents Excel Template File Format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm).

```csharp
public static readonly FileType XLTM;
```

### ZIP
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/filetype/zip.md

#### FileType.ZIP field

Document ZIP archive (.zip) is an archive file format that supports lossless data compression. Can hold one or more files or directories. Learn more about this file format [here](https://docs.fileformat.com/compression/zip/).

```csharp
public static readonly FileType ZIP;
```

### FormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature.md

#### FormFieldSignature class

Contains Form field signature properties.

```csharp
public abstract class FormFieldSignature : BaseSignature
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/clone.md

#### FormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/equals.md

#### FormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/gethashcode.md

#### FormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/name.md

#### FormFieldSignature.Name property

Specifies unique form field name.

```csharp
public string Name { get; set; }
```

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/type.md

#### FormFieldSignature.Type property

Specifies Form field type.

```csharp
public FormFieldType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldsignature/value.md

#### FormFieldSignature.Value property

Specifies Form field data object.

```csharp
public object Value { get; set; }
```

### FormFieldType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formfieldtype.md

#### FormFieldType enumeration

Specifies Form Field type.

```csharp
public enum FormFieldType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Text | `0` | Simple text input. |
| Checkbox | `1` | Check-box. |
| Combobox | `2` | Combo-box |
| DigitalSignature | `3` | Digital signature area. |
| Radio | `4` | Radio-button |

### FormTextFieldType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/formtextfieldtype.md

#### FormTextFieldType enumeration

Defines types of text for WordsProcessing document form fields.

```csharp
public enum FormTextFieldType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllTextTypes | `0` | Form field with any type. |
| PlainText | `1` | Form field with plain text type. |
| RichText | `2` | Form field with rich text type. |

### HashAlgorithm
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/hashalgorithm.md

#### HashAlgorithm enumeration

Specifies the hash algorithm used for cryptographic signing.

```csharp
public enum HashAlgorithm
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | Automatically selects the hash algorithm based on context. |
| Sha1 | `1` | The SHA-1 hash algorithm, producing a 160-bit hash value. |
| Sha256 | `2` | The SHA-256 hash algorithm, producing a 256-bit hash value. |
| Sha384 | `3` | The SHA-384 hash algorithm, producing a 384-bit hash value. |
| Sha512 | `4` | The SHA-512 hash algorithm, producing a 512-bit hash value. |

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/horizontalalignment.md

#### HorizontalAlignment enumeration

Specifies horizontal alignment of element on a document page.

```csharp
public enum HorizontalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | The object is explicitly positioned, usually using its Left property. |
| Left | `1` | Specifies that the object shall be left aligned to the horizontal alignment base. |
| Center | `2` | Specifies that the object shall be centered with respect to the horizontal alignment base. |
| Right | `3` | Specifies that the object shall be right aligned to the horizontal alignment base. |

### IAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/ialignment.md

#### IAlignment interface

Describes signature area alignment on a document page.

```csharp
public interface IAlignment
```

#### Properties

| Name | Description |
| --- | --- |
| HorizontalAlignment { get; set; } | Horizontal alignment of Image on a document page. |
| Margin { get; set; } | Gets the space that is specified by default between Image and Document edges (works if horizontal or vertical alignment is specified). |
| MarginMeasureType { get; set; } | Margin measurement type (pixels, percents or millimeters). |
| VerticalAlignment { get; set; } | Vertical alignment of Image on a document page. |

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/ialignment/horizontalalignment.md

#### IAlignment.HorizontalAlignment property

Horizontal alignment of Image on a document page.

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

### Margin
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/ialignment/margin.md

#### IAlignment.Margin property

Gets the space that is specified by default between Image and Document edges (works if horizontal or vertical alignment is specified).

```csharp
public Padding Margin { get; set; }
```

### MarginMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/ialignment/marginmeasuretype.md

#### IAlignment.MarginMeasureType property

Margin measurement type (pixels, percents or millimeters).

```csharp
public MeasureType MarginMeasureType { get; set; }
```

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/ialignment/verticalalignment.md

#### IAlignment.VerticalAlignment property

Vertical alignment of Image on a document page.

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

### IDocumentInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo.md

#### IDocumentInfo interface

Defines document description properties.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| BarcodeSignatures { get; } | Collection of document barcode signatures added or updated by `Signature` methods. |
| DigitalSignatures { get; } | Collection of document digital signatures added or updated by `Signature` methods. |
| Documents { get; } | Collection of all existing documents within the archive files. This property is supported only for Archive document types. |
| FileType { get; set; } | File format type |
| FormFields { get; } | Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types. |
| FormFieldSignatures { get; } | Collection of document Form Field signatures added or updated by `Signature` methods. |
| ImageSignatures { get; } | Collection of document image signatures added or updated by `Signature` methods. |
| MaxPageHeight { get; set; } | Specifies max page height. |
| MetadataSignatures { get; } | Collection of document Metadata signatures. |
| PageCount { get; set; } | Document pages count. |
| Pages { get; set; } | Collection of document pages descriptions. |
| ProcessLogs { get; } | Collection of document history process logs. |
| QrCodeSignatures { get; } | Collection of document QR-code signatures added or updated by `Signature` methods. |
| Signatures { get; } | Collection of document all types signatures `BaseSignature`. |
| Size { get; set; } | Document size in bytes. |
| TextSignatures { get; } | Collection of document text signatures added or updated by `Signature` methods. |
| WidthForMaxHeight { get; set; } | Specifies width for max page height. |

### BarcodeSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/barcodesignatures.md

#### IDocumentInfo.BarcodeSignatures property

Collection of document barcode signatures added or updated by `Signature` methods.

```csharp
public IList<BarcodeSignature> BarcodeSignatures { get; }
```

### DigitalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/digitalsignatures.md

#### IDocumentInfo.DigitalSignatures property

Collection of document digital signatures added or updated by `Signature` methods.

```csharp
public IList<DigitalSignature> DigitalSignatures { get; }
```

### Documents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/documents.md

#### IDocumentInfo.Documents property

Collection of all existing documents within the archive files. This property is supported only for Archive document types.

```csharp
public IList<DocumentResultSignature> Documents { get; }
```

### FileType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

File format type

```csharp
public FileType FileType { get; set; }
```

### FormFields
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/formfields.md

#### IDocumentInfo.FormFields property

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.

```csharp
public IList<FormFieldSignature> FormFields { get; }
```

### FormFieldSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/formfieldsignatures.md

#### IDocumentInfo.FormFieldSignatures property

Collection of document Form Field signatures added or updated by `Signature` methods.

```csharp
public IList<FormFieldSignature> FormFieldSignatures { get; }
```

### ImageSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/imagesignatures.md

#### IDocumentInfo.ImageSignatures property

Collection of document image signatures added or updated by `Signature` methods.

```csharp
public IList<ImageSignature> ImageSignatures { get; }
```

### MaxPageHeight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/maxpageheight.md

#### IDocumentInfo.MaxPageHeight property

Specifies max page height.

```csharp
public int MaxPageHeight { get; set; }
```

### MetadataSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/metadatasignatures.md

#### IDocumentInfo.MetadataSignatures property

Collection of document Metadata signatures.

```csharp
public IList<MetadataSignature> MetadataSignatures { get; }
```

### PageCount
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Document pages count.

```csharp
public int PageCount { get; set; }
```

### Pages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Collection of document pages descriptions.

```csharp
public IList<PageInfo> Pages { get; set; }
```

### ProcessLogs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/processlogs.md

#### IDocumentInfo.ProcessLogs property

Collection of document history process logs.

```csharp
public IList<ProcessLog> ProcessLogs { get; }
```

### QrCodeSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/qrcodesignatures.md

#### IDocumentInfo.QrCodeSignatures property

Collection of document QR-code signatures added or updated by `Signature` methods.

```csharp
public IList<QrCodeSignature> QrCodeSignatures { get; }
```

### Signatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/signatures.md

#### IDocumentInfo.Signatures property

Collection of document all types signatures `BaseSignature`.

```csharp
public IList<BaseSignature> Signatures { get; }
```

### Size
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/size.md

#### IDocumentInfo.Size property

Document size in bytes.

```csharp
public long Size { get; set; }
```

### TextSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/textsignatures.md

#### IDocumentInfo.TextSignatures property

Collection of document text signatures added or updated by `Signature` methods.

```csharp
public IList<TextSignature> TextSignatures { get; }
```

### WidthForMaxHeight
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/idocumentinfo/widthformaxheight.md

#### IDocumentInfo.WidthForMaxHeight property

Specifies width for max page height.

```csharp
public int WidthForMaxHeight { get; set; }
```

### ImageMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature.md

#### ImageMetadataSignature class

Contains Image Metadata signature properties.

```csharp
public sealed class ImageMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageMetadataSignature(ushort, object) | Creates Image Metadata Signature with Id and value |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Description { get; } | Read-only value to get description for standard Image Metadata signature |
| Height { get; set; } | Specifies height of signature. |
| Id { get; set; } | The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Size { get; } | Read-only value to get size of Metadata value |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Image Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| override ToBoolean() | Converts to boolean. |
| override ToDateTime() | Converts to DateTime. |
| override ToDateTime(IFormatProvider) | Converts to DateTime. |
| override ToDecimal() | Converts to Decimal. |
| override ToDecimal(IFormatProvider) | Converts to Decimal. |
| override ToDouble() | Converts to Double. |
| override ToDouble(IFormatProvider) | Converts to Double. |
| override ToInteger() | Converts to integer. |
| ToLong() | Converts to long. |
| override ToSingle() | Converts to float. |
| override ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| override ToString(string) | Converts to String with specified format |
| override ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Image Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### Description
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/description.md

#### ImageMetadataSignature.Description property

Read-only value to get description for standard Image Metadata signature

```csharp
public string Description { get; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/equals.md

#### ImageMetadataSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/gethashcode.md

#### ImageMetadataSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Id
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/id.md

#### ImageMetadataSignature.Id property

The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

```csharp
public ushort Id { get; set; }
```

### ImageMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/imagemetadatasignature.md

#### ImageMetadataSignature constructor

Creates Image Metadata Signature with Id and value

```csharp
public ImageMetadataSignature(ushort id, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | UInt16 | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | Object | Metadata value |

### Size
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/size.md

#### ImageMetadataSignature.Size property

Read-only value to get size of Metadata value

```csharp
public int Size { get; }
```

### ToBoolean
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/toboolean.md

#### ImageMetadataSignature.ToBoolean method

Converts to boolean.

```csharp
public override bool ToBoolean()
```

##### Return Value

Returns the Metadata signature value as boolean.

##### Remarks

Throws an exception if the Metadata value could not be converted.

### ToDateTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/todatetime.md

#### ToDateTime()

Converts to DateTime.

```csharp
public override DateTime ToDateTime()
```

##### Return Value

Returns the Metadata Signature value as DateTime.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDateTime(IFormatProvider)

Converts to DateTime.

```csharp
public override DateTime ToDateTime(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as DateTime.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToDecimal
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/todecimal.md

#### ToDecimal()

Converts to Decimal.

```csharp
public override decimal ToDecimal()
```

##### Return Value

Returns the Image Metadata Signature value as Decimal.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDecimal(IFormatProvider)

Converts to Decimal.

```csharp
public override decimal ToDecimal(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as Decimal.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToDouble
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/todouble.md

#### ToDouble()

Converts to Double.

```csharp
public override double ToDouble()
```

##### Return Value

Returns the Image Metadata Signature value as Double.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDouble(IFormatProvider)

Converts to Double.

```csharp
public override double ToDouble(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as Double.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToInteger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/tointeger.md

#### ImageMetadataSignature.ToInteger method

Converts to integer.

```csharp
public override int ToInteger()
```

##### Return Value

Returns the Metadata Signature value as integer.

##### Remarks

Throws an exception if the Metadata value could not be converted.

### ToLong
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/tolong.md

#### ImageMetadataSignature.ToLong method

Converts to long.

```csharp
public long ToLong()
```

##### Return Value

Returns the Metadata Signature value as long.

##### Remarks

Throws an exception if the Metadata value could not be converted.

### ToSingle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/tosingle.md

#### ToSingle()

Converts to float.

```csharp
public override float ToSingle()
```

##### Return Value

Returns the Image Metadata Signature value as float.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToSingle(IFormatProvider)

Converts to float.

```csharp
public override float ToSingle(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as float.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagemetadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

#### ToString(string)

Converts to String with specified format

```csharp
public override string ToString(string format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public override string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

### ImageSaveFileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesavefileformat.md

#### ImageSaveFileFormat enumeration

Defines different save file formats.

```csharp
public enum ImageSaveFileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | File Format will not be changed. |
| Bmp | `1` | Saves the document in the Bmp format. |
| Gif | `2` | Saves the document in the Gif format. |
| Jpg | `3` | Saves the document in the Jpg format. |
| Png | `4` | Saves the document in the Png format. |
| Psd | `5` | Saves the document in the Psd format. |
| Svg | `6` | Saves the document in the Svg format. |
| Tiff | `7` | Saves the document in the Tiff format. |
| Webp | `8` | Saves the document in the Webp format. |
| Pdf | `9` | Saves the document to the Pdf format. |

### ImageSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature.md

#### ImageSignature class

Contains Image signature properties.

```csharp
public class ImageSignature : BaseSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSignature(string) | Initialize ImageSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer. |

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Specifies image binary data content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Format { get; } | Specifies the format of signature image. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Size { get; } | Specifies the size in bytes of signature image. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Barcode Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/clone.md

#### ImageSignature.Clone method

Clone Barcode Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Barcode Signature instance.

### Content
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/content.md

#### ImageSignature.Content property

Specifies image binary data content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature.

```csharp
public byte[] Content { get; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/equals.md

#### ImageSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### Format
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/format.md

#### ImageSignature.Format property

Specifies the format of signature image.

```csharp
public FileType Format { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/gethashcode.md

#### ImageSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### ImageSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/imagesignature.md

#### ImageSignature constructor

Initialize ImageSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

```csharp
public ImageSignature(string signatureId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | String | Unique signature identifier obtained by Sign or Search method of Signature class `Signature`. |

### Size
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/imagesignature/size.md

#### ImageSignature.Size property

Specifies the size in bytes of signature image.

```csharp
public int Size { get; }
```

### IRectangle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle.md

#### IRectangle interface

Defines interface properties for signature area on a document page.

```csharp
public interface IRectangle
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Height of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| Left { get; set; } | Left X position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType). |
| LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| Top { get; set; } | Top Y Position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType). |
| Width { get; set; } | Width of Signature area on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType). |

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/height.md

#### IRectangle.Height property

Height of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` SizeMeasureType).

```csharp
public int Height { get; set; }
```

### Left
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/left.md

#### IRectangle.Left property

Left X position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType).

```csharp
public int Left { get; set; }
```

### LocationMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/locationmeasuretype.md

#### IRectangle.LocationMeasureType property

Measure type (pixels, percents or millimeters) for Left and Top properties.

```csharp
public MeasureType LocationMeasureType { get; set; }
```

### SizeMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/sizemeasuretype.md

#### IRectangle.SizeMeasureType property

Measure type (pixels, percents or millimeters) for Width and Height properties.

```csharp
public MeasureType SizeMeasureType { get; set; }
```

### Stretch
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/stretch.md

#### IRectangle.Stretch property

Stretch mode on Document Page.

```csharp
public StretchMode Stretch { get; set; }
```

### Top
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/top.md

#### IRectangle.Top property

Top Y Position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType).

```csharp
public int Top { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irectangle/width.md

#### IRectangle.Width property

Width of Signature area on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType).

```csharp
public int Width { get; set; }
```

### IResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult.md

#### IResult interface

Common interface for signature process result.

```csharp
public interface IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns destination document size |
| Failed { get; } | List of signatures that were not processed `BaseSignature`. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds |
| SourceDocumentSize { get; } | Returns source document size |
| Succeeded { get; } | List of successfully processed signatures `BaseSignature`. |
| TotalSignatures { get; } | Returns the total processed signatures |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/destindocumentsize.md

#### IResult.DestinDocumentSize property

Returns destination document size

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/failed.md

#### IResult.Failed property

List of signatures that were not processed `BaseSignature`.

```csharp
public List<BaseSignature> Failed { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/processingtime.md

#### IResult.ProcessingTime property

Returns the execution time of the process in milliseconds

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/sourcedocumentsize.md

#### IResult.SourceDocumentSize property

Returns source document size

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/succeeded.md

#### IResult.Succeeded property

List of successfully processed signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/iresult/totalsignatures.md

#### IResult.TotalSignatures property

Returns the total processed signatures

```csharp
public int TotalSignatures { get; }
```

### IRotation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irotation.md

#### IRotation interface

Defines properties for signature rotation.

```csharp
public interface IRotation
```

#### Properties

| Name | Description |
| --- | --- |
| RotationAngle { get; set; } | Rotation angle clockwise. |

### RotationAngle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/irotation/rotationangle.md

#### IRotation.RotationAngle property

Rotation angle clockwise.

```csharp
public int RotationAngle { get; set; }
```

### ITextAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/itextalignment.md

#### ITextAlignment interface

Defines alignment properties for text on text signatures.

```csharp
public interface ITextAlignment
```

#### Properties

| Name | Description |
| --- | --- |
| TextHorizontalAlignment { get; set; } | Horizontal alignment of text inside a signature. |
| TextVerticalAlignment { get; set; } | Vertical alignment of text inside a signature. |

### TextHorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/itextalignment/texthorizontalalignment.md

#### ITextAlignment.TextHorizontalAlignment property

Horizontal alignment of text inside a signature.

```csharp
public TextHorizontalAlignment TextHorizontalAlignment { get; set; }
```

### TextVerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/itextalignment/textverticalalignment.md

#### ITextAlignment.TextVerticalAlignment property

Vertical alignment of text inside a signature.

```csharp
public TextVerticalAlignment TextVerticalAlignment { get; set; }
```

### ITransparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/itransparency.md

#### ITransparency interface

Define Transparency property for different objects appearances

```csharp
public interface ITransparency
```

#### Properties

| Name | Description |
| --- | --- |
| Transparency { get; set; } | Gets or sets a value to indicate the object Transparency. The value is from 0.0 to 1.0. By default the value is 0 |

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/itransparency/transparency.md

#### ITransparency.Transparency property

Gets or sets a value to indicate the object Transparency. The value is from 0.0 to 1.0. By default the value is 0

```csharp
public double Transparency { get; set; }
```

### MeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/measuretype.md

#### MeasureType enumeration

Specifies measure units of signature on a document page.

```csharp
public enum MeasureType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pixels | `0` | Pixels. |
| Percents | `1` | Percents of page size. |
| Millimeters | `2` | Millimeters. |

### MetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature.md

#### MetadataSignature class

Contains Metadata signature properties.

```csharp
public abstract class MetadataSignature : BaseSignature
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| virtual Clone(object) | Clone Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| virtual ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Metadata Signature instance with given value.

```csharp
public virtual MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance with given value.

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/dataencryption.md

#### MetadataSignature.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/equals.md

#### MetadataSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/getdata.md

#### GetData&lt;T&gt;()

Obtain object from Metadata Signature Value over deserialization.

```csharp
public T GetData<T>()
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | Type of object to deserialize from Metadata value |

##### Return Value

Instance of T object

#### GetData&lt;T&gt;(IDataEncryption)

Obtain object from Metadata Signature Text over deserialization.

```csharp
public T GetData<T>(IDataEncryption dataEncryption)
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | Type of object to deserialize from Metadata Value |
| dataEncryption | Set custom data encryption implementation |

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/gethashcode.md

#### MetadataSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/name.md

#### MetadataSignature.Name property

Specifies unique metadata name.

```csharp
public string Name { get; set; }
```

### ToBoolean
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/toboolean.md

#### MetadataSignature.ToBoolean method

Converts to boolean.

```csharp
public virtual bool ToBoolean()
```

##### Return Value

Returns the Metadata signature value as boolean.

##### Remarks

Throws an exception if the Metadata value could not be converted.

### ToDateTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/todatetime.md

#### ToDateTime()

Converts to DateTime.

```csharp
public virtual DateTime ToDateTime()
```

##### Return Value

Returns the Metadata Signature value as DateTime.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDateTime(IFormatProvider)

Converts to DateTime.

```csharp
public virtual DateTime ToDateTime(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as DateTime.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToDecimal
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/todecimal.md

#### ToDecimal()

Converts to Decimal.

```csharp
public virtual decimal ToDecimal()
```

##### Return Value

Returns the Metadata Signature value as Decimal.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDecimal(IFormatProvider)

Converts to Decimal.

```csharp
public virtual decimal ToDecimal(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as Decimal.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToDouble
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/todouble.md

#### ToDouble()

Converts to Double.

```csharp
public virtual double ToDouble()
```

##### Return Value

Returns the Metadata Signature value as Double.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToDouble(IFormatProvider)

Converts to Double.

```csharp
public virtual double ToDouble(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as Double.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToInteger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/tointeger.md

#### MetadataSignature.ToInteger method

Converts to integer.

```csharp
public virtual int ToInteger()
```

##### Return Value

Returns the Metadata Signature value as integer.

##### Remarks

Throws an exception if the Metadata value could not be converted.

### ToSingle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/tosingle.md

#### ToSingle()

Converts to float.

```csharp
public virtual float ToSingle()
```

##### Return Value

Returns the Metadata Signature value as float.

##### Remarks

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties `DefaultCulture`

#### ToSingle(IFormatProvider)

Converts to float.

```csharp
public virtual float ToSingle(IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as float.

##### Remarks

Throws an exception if the Metadata value could not be converted

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public virtual string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

#### ToString(string)

Converts to String with specified format

```csharp
public virtual string ToString(string format)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties `DefaultCulture`

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/type.md

#### MetadataSignature.Type property

Specifies metadata value type.

```csharp
public MetadataType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignature/value.md

#### MetadataSignature.Value property

Specifies metadata object.

```csharp
public object Value { get; set; }
```

### MetadataSignatureCollection
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection.md

#### MetadataSignatureCollection class

Collection of Metadata signature objects.

```csharp
public class MetadataSignatureCollection : ICloneable, IEnumerable<MetadataSignature>
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataSignatureCollection() | Creates Collection of Metadata signature. |

#### Properties

| Name | Description |
| --- | --- |
| Count { get; } | Gets number of items in the collection. |
| Item { get; } | Returns a MetadataSignature object by the name of the property. (2 indexers) |

#### Methods

| Name | Description |
| --- | --- |
| Add(MetadataSignature) | Add Metadata Signature object to collection. |
| AddRange(IEnumerable&lt;MetadataSignature&gt;) | Add Metadata Signature collection. |
| Clear() | Removes all items from the collection. |
| Clone() | Clone Metadata Signature Collection class with Metadata Signature Items. |
| Contains(string) | Returns true if a Metadata with the specified name exists in the collection. |
| GetEnumerator() | Returns enumerator. |
| IndexOf(string) | Gets the index of a property by name. |
| Remove(string) | Removes a Metadata Signature with the specified name from the collection. |
| RemoveAt(int) | Removes a Metadata Signature at the specified index. |

### Add
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/add.md

#### MetadataSignatureCollection.Add method

Add Metadata Signature object to collection.

```csharp
public void Add(MetadataSignature signature)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | MetadataSignature | Metadata signature to be added to collection. |

##### Remarks

Throws an exception if name value is not unique entire existing collection

### AddRange
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/addrange.md

#### MetadataSignatureCollection.AddRange method

Add Metadata Signature collection.

```csharp
public void AddRange(IEnumerable<MetadataSignature> signatures)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatures | IEnumerable`1 | Collection of signatures to add. |

##### Remarks

Throws an exception if name value is not unique entire existing collection

### Clear
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/clear.md

#### MetadataSignatureCollection.Clear method

Removes all items from the collection.

```csharp
public void Clear()
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/clone.md

#### MetadataSignatureCollection.Clone method

Clone Metadata Signature Collection class with Metadata Signature Items.

```csharp
public object Clone()
```

##### Return Value

Returns copied instance with cloned Signature Items

### Contains
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/contains.md

#### MetadataSignatureCollection.Contains method

Returns true if a Metadata with the specified name exists in the collection.

```csharp
public bool Contains(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of the property. |

##### Return Value

True if the Metadata exists in the collection; false otherwise.

### Count
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/count.md

#### MetadataSignatureCollection.Count property

Gets number of items in the collection.

```csharp
public int Count { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/getenumerator.md

#### MetadataSignatureCollection.GetEnumerator method

Returns enumerator.

```csharp
public IEnumerator<MetadataSignature> GetEnumerator()
```

##### Return Value

Returns instance of IEnumerator.

### IndexOf
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/indexof.md

#### MetadataSignatureCollection.IndexOf method

Gets the index of a property by name.

```csharp
public int IndexOf(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of the MetadataSignature. |

##### Return Value

The zero based index. Negative value if not found.

### Item
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/item.md

#### MetadataSignatureCollection indexer (1 of 2)

Returns a MetadataSignature object by the name of the property.

```csharp
public MetadataSignature this[string name] { get; }
```

| Parameter | Description |
| --- | --- |
| name | The case-insensitive name of the property to retrieve. |

##### Return Value

Returns a MetadataSignature `MetadataSignature` object by the name of the property.

##### Remarks

Returns null if a property with the specified name is not found.

#### MetadataSignatureCollection indexer (2 of 2)

Returns a MetadataSignature object by index.

```csharp
public MetadataSignature this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | Zero-based index of the MetadataSignature to retrieve. |

##### Return Value

Returns a MetadataSignature `MetadataSignature` object by the index of collection.

##### Remarks

Returns null if a property with the specified index does not exist.

### MetadataSignatureCollection
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/metadatasignaturecollection.md

#### MetadataSignatureCollection constructor

Creates Collection of Metadata signature.

```csharp
public MetadataSignatureCollection()
```

### Remove
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/remove.md

#### MetadataSignatureCollection.Remove method

Removes a Metadata Signature with the specified name from the collection.

```csharp
public bool Remove(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The case-insensitive name of the Metadata Signature. |

### RemoveAt
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatasignaturecollection/removeat.md

#### MetadataSignatureCollection.RemoveAt method

Removes a Metadata Signature at the specified index.

```csharp
public bool RemoveAt(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero based index. |

### MetadataType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/metadatatype.md

#### MetadataType enumeration

Specifies the supported Metadata signature data type of the value.

```csharp
public enum MetadataType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Value type is undefined. |
| Boolean | `1` | Value is Boolean type. |
| Integer | `2` | Value is integer type. |
| Double | `3` | Value is Double type. |
| DateTime | `4` | Value is DateTime type. |
| String | `5` | Value is string type. |

### Padding
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding.md

#### Padding class

Represents padding or margin information associated with element.

```csharp
public class Padding : ICloneable
```

#### Constructors

| Name | Description |
| --- | --- |
| Padding() | Initializes a new instance of Padding class using zero values. |
| Padding(int) | Initializes a new instance of the Padding class using the supplied padding size for all edges. |
| Padding(int, int, int, int) | Initializes a new instance of the Padding class using the supplied padding sizes. |

#### Properties

| Name | Description |
| --- | --- |
| All { get; set; } | Gets or sets the padding value for all the edges. Changing of any partial edge like left or top makes this property equal 0; |
| Bottom { get; set; } | Gets or sets the padding value for the bottom edge. |
| Horizontal { get; } | Gets the combined padding for the right and left edges. |
| Left { get; set; } | Gets or sets the padding value for the left edge. |
| Right { get; set; } | Gets or sets the padding value for the right edge. |
| Top { get; set; } | Gets or sets the padding value for the top edge. |
| Vertical { get; } | Gets the combined padding for the top and bottom edges. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Gets a copy of this object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | Provides a Padding object with no padding. |

### All
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/all.md

#### Padding.All property

Gets or sets the padding value for all the edges. Changing of any partial edge like left or top makes this property equal 0;

```csharp
public int All { get; set; }
```

### Bottom
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/bottom.md

#### Padding.Bottom property

Gets or sets the padding value for the bottom edge.

```csharp
public int Bottom { get; set; }
```

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/clone.md

#### Padding.Clone method

Gets a copy of this object.

```csharp
public object Clone()
```

### Empty
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/empty.md

#### Padding.Empty field

Provides a Padding object with no padding.

```csharp
public static readonly Padding Empty;
```

### Horizontal
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/horizontal.md

#### Padding.Horizontal property

Gets the combined padding for the right and left edges.

```csharp
public int Horizontal { get; }
```

### Left
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/left.md

#### Padding.Left property

Gets or sets the padding value for the left edge.

```csharp
public int Left { get; set; }
```

### Padding
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/padding.md

#### Padding()

Initializes a new instance of Padding class using zero values.

```csharp
public Padding()
```

#### Padding(int)

Initializes a new instance of the Padding class using the supplied padding size for all edges.

```csharp
public Padding(int all)
```

| Parameter | Type | Description |
| --- | --- | --- |
| all | Int32 | The number of measure units to be used for padding for all edges. |

#### Padding(int, int, int, int)

Initializes a new instance of the Padding class using the supplied padding sizes.

```csharp
public Padding(int left, int right, int top, int bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Int32 | The left padding size. |
| right | Int32 | The right padding size. |
| top | Int32 | The top padding size. |
| bottom | Int32 | The bottom padding size. |

### Right
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/right.md

#### Padding.Right property

Gets or sets the padding value for the right edge.

```csharp
public int Right { get; set; }
```

### Top
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/top.md

#### Padding.Top property

Gets or sets the padding value for the top edge.

```csharp
public int Top { get; set; }
```

### Vertical
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/padding/vertical.md

#### Padding.Vertical property

Gets the combined padding for the top and bottom edges.

```csharp
public int Vertical { get; }
```

### PageInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pageinfo.md

#### PageInfo class

Document page description class

```csharp
public class PageInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PageInfo() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Specifies page height |
| PageNumber { get; set; } | Specifies page number |
| Width { get; set; } | Specifies page width |

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pageinfo/height.md

#### PageInfo.Height property

Specifies page height

```csharp
public int Height { get; set; }
```

### PageInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pageinfo/pageinfo.md

#### PageInfo constructor

The default constructor.

```csharp
public PageInfo()
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Specifies page number

```csharp
public int PageNumber { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pageinfo/width.md

#### PageInfo.Width property

Specifies page width

```csharp
public int Width { get; set; }
```

### PdfDigitalSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature.md

#### PdfDigitalSignature class

Contains Pdf Digital signature properties.

```csharp
public class PdfDigitalSignature : DigitalSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfDigitalSignature() | Initialize Pdf Digital Signature with no certificate. |
| PdfDigitalSignature(X509Certificate2) | Create Pdf Digital signature with specified certificate. |
| PdfDigitalSignature(X509Store) | Initialize Pdf Digital Signature based on specified X509 store. First certificate from specified store will be used. |
| PdfDigitalSignature(X509Store, int) | Create Pdf Digital signature based on specified X509 Store and index of certificate. |

#### Properties

| Name | Description |
| --- | --- |
| Certificate { get; set; } | Gets or sets the X509 certificate. |
| CertificateCustomStoreName { get; set; } | Specifies the custom store name of the certificate. |
| CertificateStoreLocation { get; set; } | Specifies the store location of the certificate |
| CertificateStoreName { get; set; } | Specifies the store name of the certificate. |
| Comments { get; set; } | Gets or sets the signing purpose comment. |
| ContactInfo { get; set; } | Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| IsValid { get; set; } | Keeps true if this digital signature is valid and the document has not been tampered with. |
| Left { get; set; } | Specifies left position of signature. |
| Location { get; set; } | The CPU host name or physical location of the signing. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| Reason { get; set; } | The reason for the signing, such as (I agree…). |
| ShowProperties { get; set; } | Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance Digitally signed by {`ContactInfo`} Date: {Date} Reason: {`Reason`} Location: {`Location`} ShowProperties is true by default. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| SignTime { get; set; } | Gets or sets the time the document was signed. |
| Thumbprint { get; } | Gets the thumbprint of a certificate. |
| TimeStamp { get; set; } | Time stamp for Pdf digital signature. Default value is null. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; set; } | Type of Pdf digital signature. |
| Width { get; set; } | Specifies width of signature. |
| XAdESType { get; } | XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Barcode Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/clone.md

#### PdfDigitalSignature.Clone method

Clone Barcode Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Barcode Signature instance.

### ContactInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/contactinfo.md

#### PdfDigitalSignature.ContactInfo property

Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.

```csharp
public string ContactInfo { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/equals.md

#### PdfDigitalSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/gethashcode.md

#### PdfDigitalSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Location
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/location.md

#### PdfDigitalSignature.Location property

The CPU host name or physical location of the signing.

```csharp
public string Location { get; set; }
```

### PdfDigitalSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/pdfdigitalsignature.md

#### PdfDigitalSignature()

Initialize Pdf Digital Signature with no certificate.

```csharp
public PdfDigitalSignature()
```

#### PdfDigitalSignature(X509Store)

Initialize Pdf Digital Signature based on specified X509 store. First certificate from specified store will be used.

```csharp
public PdfDigitalSignature(X509Store store)
```

| Parameter | Type | Description |
| --- | --- | --- |
| store | X509Store | X509 store. |

#### PdfDigitalSignature(X509Store, int)

Create Pdf Digital signature based on specified X509 Store and index of certificate.

```csharp
public PdfDigitalSignature(X509Store store, int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| store | X509Store | X509 store. |
| index | Int32 | Index of certificate. |

#### PdfDigitalSignature(X509Certificate2)

Create Pdf Digital signature with specified certificate.

```csharp
public PdfDigitalSignature(X509Certificate2 certificate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificate | X509Certificate2 | X509 certificate. |

### Reason
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/reason.md

#### PdfDigitalSignature.Reason property

The reason for the signing, such as (I agree…).

```csharp
public string Reason { get; set; }
```

### ShowProperties
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/showproperties.md

#### PdfDigitalSignature.ShowProperties property

Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance Digitally signed by {`ContactInfo`} Date: {Date} Reason: {`Reason`} Location: {`Location`} ShowProperties is true by default.

```csharp
public bool ShowProperties { get; set; }
```

### TimeStamp
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/timestamp.md

#### PdfDigitalSignature.TimeStamp property

Time stamp for Pdf digital signature. Default value is null.

```csharp
public TimeStamp TimeStamp { get; set; }
```

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignature/type.md

#### PdfDigitalSignature.Type property

Type of Pdf digital signature.

```csharp
public PdfDigitalSignatureType Type { get; set; }
```

### PdfDigitalSignatureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfdigitalsignaturetype.md

#### PdfDigitalSignatureType enumeration

Describes enumeration of PDF digital signature type.

```csharp
public enum PdfDigitalSignatureType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Signature | `0` | Digital signature. |
| Certificate | `1` | Digital certificate. Each document could be certified only once. |

### PdfMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature.md

#### PdfMetadataSignature class

Contains Pdf Metadata signature properties.

```csharp
public sealed class PdfMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfMetadataSignature(string) | Creates Pdf Metadata signature with predefined name and empty value |
| PdfMetadataSignature(string, object) | Creates Pdf Metadata signature with predefined values |
| PdfMetadataSignature(string, object, string) | Creates Pdf Metadata signature with predefined values |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| TagPrefix { get; set; } | The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp". Possible values are |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Pdf Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| virtual ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Pdf Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature/equals.md

#### PdfMetadataSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature/gethashcode.md

#### PdfMetadataSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### PdfMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature/pdfmetadatasignature.md

#### PdfMetadataSignature(string)

Creates Pdf Metadata signature with predefined name and empty value

```csharp
public PdfMetadataSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Pdf Metadata Signature name |

#### PdfMetadataSignature(string, object)

Creates Pdf Metadata signature with predefined values

```csharp
public PdfMetadataSignature(string name, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object |
| value | Object | Value of Metadata signature |

#### PdfMetadataSignature(string, object, string)

Creates Pdf Metadata signature with predefined values

```csharp
public PdfMetadataSignature(string name, object value, string tag)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object |
| value | Object | Value of Metadata signature |
| tag | String | Prefix tag of Metadata signature |

### TagPrefix
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignature/tagprefix.md

#### PdfMetadataSignature.TagPrefix property

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp". Possible values are

```csharp
public string TagPrefix { get; set; }
```

### PdfMetadataSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures.md

#### PdfMetadataSignatures class

Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options.

```csharp
public static class PdfMetadataSignatures
```

#### Properties

| Name | Description |
| --- | --- |
| static Author { get; } | Pdf Document Author metadata. |
| static CreateDate { get; } | Pdf Document creation date metadata signature. |
| static Creator { get; } | Pdf Document creator metadata property. |
| static CreatorTool { get; } | Pdf Document creation tool metadata signature. |
| static Description { get; } | Pdf Document Description metadata property. |
| static Entry { get; } | Pdf Document Entry metadata property. |
| static Keywords { get; } | Pdf Document creator metadata property |
| static MetadataDate { get; } | Pdf Document metadata date information. |
| static ModifyDate { get; } | Pdf Document modified date metadata property. |
| static Producer { get; } | Pdf Document Producer metadata property. |
| static Subject { get; } | Pdf Document Subject metadata property. |
| static Title { get; } | Pdf Document Title metadata property |

### Author
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/author.md

#### PdfMetadataSignatures.Author property

Pdf Document Author metadata.

```csharp
public static PdfMetadataSignature Author { get; }
```

### CreateDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/createdate.md

#### PdfMetadataSignatures.CreateDate property

Pdf Document creation date metadata signature.

```csharp
public static PdfMetadataSignature CreateDate { get; }
```

### Creator
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/creator.md

#### PdfMetadataSignatures.Creator property

Pdf Document creator metadata property.

```csharp
public static PdfMetadataSignature Creator { get; }
```

### CreatorTool
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/creatortool.md

#### PdfMetadataSignatures.CreatorTool property

Pdf Document creation tool metadata signature.

```csharp
public static PdfMetadataSignature CreatorTool { get; }
```

### Description
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/description.md

#### PdfMetadataSignatures.Description property

Pdf Document Description metadata property.

```csharp
public static PdfMetadataSignature Description { get; }
```

### Entry
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/entry.md

#### PdfMetadataSignatures.Entry property

Pdf Document Entry metadata property.

```csharp
public static PdfMetadataSignature Entry { get; }
```

### Keywords
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/keywords.md

#### PdfMetadataSignatures.Keywords property

Pdf Document creator metadata property

```csharp
public static PdfMetadataSignature Keywords { get; }
```

### MetadataDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/metadatadate.md

#### PdfMetadataSignatures.MetadataDate property

Pdf Document metadata date information.

```csharp
public static PdfMetadataSignature MetadataDate { get; }
```

### ModifyDate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/modifydate.md

#### PdfMetadataSignatures.ModifyDate property

Pdf Document modified date metadata property.

```csharp
public static PdfMetadataSignature ModifyDate { get; }
```

### Producer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/producer.md

#### PdfMetadataSignatures.Producer property

Pdf Document Producer metadata property.

```csharp
public static PdfMetadataSignature Producer { get; }
```

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/subject.md

#### PdfMetadataSignatures.Subject property

Pdf Document Subject metadata property.

```csharp
public static PdfMetadataSignature Subject { get; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfmetadatasignatures/title.md

#### PdfMetadataSignatures.Title property

Pdf Document Title metadata property

```csharp
public static PdfMetadataSignature Title { get; }
```

### PdfSaveFileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdfsavefileformat.md

#### PdfSaveFileFormat enumeration

Defines different save file formats.

```csharp
public enum PdfSaveFileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | File Format will not be changed. |
| Pdf | `1` | Saves the document as Pdf (Adobe Portable Document) Format. |
| Doc | `2` | Saves the document in the Microsoft Word 97-2007 Document Format. |
| Xps | `3` | Saves the document in the XPS (XML Paper Specification) Format. |
| DocX | `7` | Saves the document in Microsoft Word Open XML File format. |
| Svg | `8` | Saves the document in the SVG (Scalable Vector Graphics) format. |
| Epub | `11` | Saves the document in the IDPF EPUB format. |
| Pptx | `12` | Saves the document in the PowerPoint Open XML Presentation File format |

### PdfTextAnnotationBorderEffect
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdftextannotationbordereffect.md

#### PdfTextAnnotationBorderEffect enumeration

Describes effect which should be applied to the border of the PDF text annotations.

```csharp
public enum PdfTextAnnotationBorderEffect
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No effect. |
| Cloudy | `1` | The border will appear "cloudy". |

### PdfTextStickerIcon
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdftextstickericon.md

#### PdfTextStickerIcon enumeration

Describes enumeration of PDF Text annotation sticker icon appearance.

```csharp
public enum PdfTextStickerIcon
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Note | `0` | Note icon. |
| Comment | `1` | Comment icon. |
| Key | `2` | Key icon. |
| Help | `3` | Help icon. |
| NewParagraph | `4` | New Paragraph icon |
| Paragraph | `5` | Paragraph icon |
| Insert | `6` | Insert icon |
| Check | `7` | Check icon |
| Cross | `8` | Cross icon |
| Circle | `9` | Circle icon |
| Star | `10` | Star icon |

### PdfTextStickerState
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/pdftextstickerstate.md

#### PdfTextStickerState enumeration

Describes enumeration of PDF text annotation sticker states.

```csharp
public enum PdfTextStickerState
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Undefined | `0` | Undefined state. |
| Marked | `1` | Marked state. |
| Unmarked | `2` | Unmarked state. |
| Accepted | `3` | Accepted state. |
| Rejected | `4` | Rejected state. |
| Cancelled | `5` | Canceled state. |
| Completed | `6` | Completed state. |
| None | `7` | No state. |

### PresentationMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/presentationmetadatasignature.md

#### PresentationMetadataSignature class

Contains Presentation metadata signature properties.

```csharp
public sealed class PresentationMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationMetadataSignature(string) | Creates Presentation Metadata Signature with predefined name and empty value |
| PresentationMetadataSignature(string, object) | Creates Presentation Metadata Signature with predefined values |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Slides Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| override ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/presentationmetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Slides Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### PresentationMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/presentationmetadatasignature/presentationmetadatasignature.md

#### PresentationMetadataSignature(string)

Creates Presentation Metadata Signature with predefined name and empty value

```csharp
public PresentationMetadataSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Presentation Metadata Signature name |

#### PresentationMetadataSignature(string, object)

Creates Presentation Metadata Signature with predefined values

```csharp
public PresentationMetadataSignature(string name, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object |
| value | Object | Value of Metadata signature |

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/presentationmetadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public override string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

### PresentationSaveFileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/presentationsavefileformat.md

#### PresentationSaveFileFormat enumeration

Defines different save file formats.

```csharp
public enum PresentationSaveFileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | File Format will not be changed. |
| Pps | `1` | Saves the document as Microsoft Power Point 97-2003 slide show. |
| Ppt | `2` | Saves the document as Microsoft Power Point 97-2003 presentation. |
| Pdf | `3` | Saves the document in PDF format. |
| Xps | `4` | Saves the document in the XPS (XML Paper Specification) format. |
| Pptx | `5` | Saves the document in the Microsoft Power Point Open XML Presentation format. |
| Ppsx | `6` | Saves the document in the Microsoft Power Point Open XML Slide Show format. |
| Tiff | `7` | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| Odp | `8` | Saves the document as Open Office presentation. |
| Pptm | `9` | Saves the document as Microsoft Power Point Open XML macro-enabled presentation. |
| Ppsm | `10` | Saves the document as Microsoft Power Point Open XML macro-enabled slide show. |
| Potx | `11` | Saves the document as Microsoft Power Point template. |
| Potm | `12` | Saves the document as Microsoft Power Point macro-enabled template. |
| Html | `14` | Saves the document in the HTML Format. |
| Otp | `17` | Saves the document as Open Office presentation template. |

### ProcessLog
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog.md

#### ProcessLog class

Represents document process details.

```csharp
public sealed class ProcessLog
```

#### Properties

| Name | Description |
| --- | --- |
| Date { get; } | Get the process date and time. |
| Failed { get; } | Quantity of signatures that failed during processing. |
| Message { get; } | Get the process description. |
| Signatures { get; } | The list of successfully processed signatures. |
| Succeeded { get; } | Quantity of successfully processed signatures. |
| Type { get; } | Get the process type. |

### Date
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/date.md

#### ProcessLog.Date property

Get the process date and time.

```csharp
public DateTime Date { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/failed.md

#### ProcessLog.Failed property

Quantity of signatures that failed during processing.

```csharp
public int Failed { get; }
```

### Message
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/message.md

#### ProcessLog.Message property

Get the process description.

```csharp
public string Message { get; }
```

### Signatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/signatures.md

#### ProcessLog.Signatures property

The list of successfully processed signatures.

```csharp
public List<BaseSignature> Signatures { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/succeeded.md

#### ProcessLog.Succeeded property

Quantity of successfully processed signatures.

```csharp
public int Succeeded { get; }
```

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processlog/type.md

#### ProcessLog.Type property

Get the process type.

```csharp
public ProcessType Type { get; }
```

### ProcessStatus
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processstatus.md

#### ProcessStatus enumeration

Specifies status of signing and verification processes.

```csharp
public enum ProcessStatus
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Started | `0` | Process was started. |
| InProgress | `1` | Process is in progress. |
| Completed | `2` | Process is completed. |

### ProcessType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/processtype.md

#### ProcessType enumeration

Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete

```csharp
public enum ProcessType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Indicates an error, unknown process type. |
| Info | `1` | Obtain document information process. |
| Preview | `2` | Indicates method GeneratePreview(). |
| Sign | `3` | Signing process type. |
| Verify | `4` | Document verification process. |
| Search | `5` | Signatures searching process. |
| Update | `6` | Update document signatures process. |
| Delete | `7` | Delete document signatures process |

### QrCodeSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature.md

#### QrCodeSignature class

Contains QR-code signature properties.

```csharp
public class QrCodeSignature : BaseSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| QrCodeSignature(string) | Initialize QrCodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer. |

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Specifies QR-code binary data image content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature. |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| EncodeType { get; } | Specifies the QR-code Encode Type. |
| Format { get; } | Specifies the format of QR-code signature image. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Text { get; } | Specifies text of QR-code. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone QR-Code Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from QR-Code Signature Text over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from QR-Code Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/clone.md

#### QrCodeSignature.Clone method

Clone QR-Code Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned QR-code Signature instance.

### Content
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/content.md

#### QrCodeSignature.Content property

Specifies QR-code binary data image content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature.

```csharp
public byte[] Content { get; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/encodetype.md

#### QrCodeSignature.EncodeType property

Specifies the QR-code Encode Type.

```csharp
public QrCodeType EncodeType { get; }
```

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/equals.md

#### QrCodeSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### Format
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/format.md

#### QrCodeSignature.Format property

Specifies the format of QR-code signature image.

```csharp
public FileType Format { get; }
```

### GetData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/getdata.md

#### GetData&lt;T&gt;()

Obtain object from QR-Code Signature Text over deserialization.

```csharp
public T GetData<T>()
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | Type of object to deserialize from QR-Code Text |

#### GetData&lt;T&gt;(IDataEncryption)

Obtain object from QR-Code Signature Text over deserialization.

```csharp
public T GetData<T>(IDataEncryption dataEncryption)
    where T : class
```

| Parameter | Description |
| --- | --- |
| T | Type of object to deserialize from QR-Code Text |
| dataEncryption | Set custom data encryption implementation |

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/gethashcode.md

#### QrCodeSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### QrCodeSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/qrcodesignature.md

#### QrCodeSignature constructor

Initialize QrCodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

```csharp
public QrCodeSignature(string signatureId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | String | Unique signature identifier obtained by sign or search method. |

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodesignature/text.md

#### QrCodeSignature.Text property

Specifies text of QR-code.

```csharp
public string Text { get; }
```

### QrCodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetype.md

#### QrCodeType class

Specify QRCode type properties.

```csharp
public sealed class QrCodeType : IEquatable<QrCodeType>
```

#### Properties

| Name | Description |
| --- | --- |
| TypeIndex { get; } | Gets index of object in collection of supported QRCode types. |
| TypeName { get; } | Gets name of QRCode Type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overridden method determines whether the specified System.Object is equal to the current System.Object. |
| Equals(QrCodeType) | Determines whether the specified QRCode is equal to the current object. |
| override GetHashCode() | Overridden method serves as a hash function for a particular type. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetype/equals.md

#### Equals(QrCodeType)

Determines whether the specified QRCode is equal to the current object.

```csharp
public bool Equals(QrCodeType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | QrCodeType | Object for comparison. |

##### Return Value

Result of comparison.

#### Equals(object)

Overridden method determines whether the specified System.Object is equal to the current System.Object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Object for comparison. |

##### Return Value

Result of comparison.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetype/gethashcode.md

#### QrCodeType.GetHashCode method

Overridden method serves as a hash function for a particular type.

```csharp
public override int GetHashCode()
```

##### Return Value

Hash code.

### TypeIndex
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetype/typeindex.md

#### QrCodeType.TypeIndex property

Gets index of object in collection of supported QRCode types.

```csharp
public int TypeIndex { get; }
```

### TypeName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetype/typename.md

#### QrCodeType.TypeName property

Gets name of QRCode Type.

```csharp
public string TypeName { get; }
```

### QrCodeTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes.md

#### QrCodeTypes class

QRCode Types container.

```csharp
public static class QrCodeTypes
```

#### Properties

| Name | Description |
| --- | --- |
| static AllTypes { get; } | All QRCode types. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw |
| static TryParse(string) | Returns QRCode type with pasringType name. If name of QRCode is unknown - no Exception will be throw but method will return null value. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aztec | Aztec QR-Code Type object. |
| static readonly DataMatrix | DataMatrix QR-Code Type object. |
| static readonly GS1DataMatrix | GS1 DataMatrix QR-Code Type object. |
| static readonly GS1HanXin | GS1 Han Xin QR-Code Type object. |
| static readonly GS1QR | GS1 QR-Code Type object. |
| static readonly HanXin | Han Xin QR-Code Type object. |
| static readonly HIBCLICAztec | HIBC LIC Aztec QR-Code Type object. |
| static readonly HIBCLICDataMatrix | HIBC LIC Data Matrix QR-Code Type object. |
| static readonly HIBCLICQR | HIBC LIC QR-Code Type object. |
| static readonly HIBCPASAztec | HIBC PAS Aztec QR-Code Type object. |
| static readonly HIBCPASDataMatrix | HIBC PAS Data Matrix QR-Code Type object. |
| static readonly HIBCPASQR | HIBC PAS QR-Code Type object. |
| static readonly MicroQR | MicroQR Type object. |
| static readonly QR | QR QR-Code Type object. |
| static readonly RectMicroQR | RectMicroQR Type object. |

### AllTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/alltypes.md

#### QrCodeTypes.AllTypes property

All QRCode types.

```csharp
public static QrCodeType[] AllTypes { get; }
```

### Aztec
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/aztec.md

#### QrCodeTypes.Aztec field

Aztec QR-Code Type object.

```csharp
public static readonly QrCodeType Aztec;
```

### DataMatrix
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/datamatrix.md

#### QrCodeTypes.DataMatrix field

DataMatrix QR-Code Type object.

```csharp
public static readonly QrCodeType DataMatrix;
```

### GS1DataMatrix
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/gs1datamatrix.md

#### QrCodeTypes.GS1DataMatrix field

GS1 DataMatrix QR-Code Type object.

```csharp
public static readonly QrCodeType GS1DataMatrix;
```

### GS1HanXin
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/gs1hanxin.md

#### QrCodeTypes.GS1HanXin field

GS1 Han Xin QR-Code Type object.

```csharp
public static readonly QrCodeType GS1HanXin;
```

### GS1QR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/gs1qr.md

#### QrCodeTypes.GS1QR field

GS1 QR-Code Type object.

```csharp
public static readonly QrCodeType GS1QR;
```

### HanXin
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hanxin.md

#### QrCodeTypes.HanXin field

Han Xin QR-Code Type object.

```csharp
public static readonly QrCodeType HanXin;
```

### HIBCLICAztec
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibclicaztec.md

#### QrCodeTypes.HIBCLICAztec field

HIBC LIC Aztec QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCLICAztec;
```

### HIBCLICDataMatrix
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibclicdatamatrix.md

#### QrCodeTypes.HIBCLICDataMatrix field

HIBC LIC Data Matrix QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCLICDataMatrix;
```

### HIBCLICQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibclicqr.md

#### QrCodeTypes.HIBCLICQR field

HIBC LIC QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCLICQR;
```

### HIBCPASAztec
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibcpasaztec.md

#### QrCodeTypes.HIBCPASAztec field

HIBC PAS Aztec QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCPASAztec;
```

### HIBCPASDataMatrix
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibcpasdatamatrix.md

#### QrCodeTypes.HIBCPASDataMatrix field

HIBC PAS Data Matrix QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCPASDataMatrix;
```

### HIBCPASQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/hibcpasqr.md

#### QrCodeTypes.HIBCPASQR field

HIBC PAS QR-Code Type object.

```csharp
public static readonly QrCodeType HIBCPASQR;
```

### MicroQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/microqr.md

#### QrCodeTypes.MicroQR field

MicroQR Type object.

```csharp
public static readonly QrCodeType MicroQR;
```

### Parse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/parse.md

#### QrCodeTypes.Parse method

Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw

```csharp
public static QrCodeType Parse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of QRCode type name. |

##### Return Value

QRCodeType instance.

### QR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/qr.md

#### QrCodeTypes.QR field

QR QR-Code Type object.

```csharp
public static readonly QrCodeType QR;
```

### RectMicroQR
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/rectmicroqr.md

#### QrCodeTypes.RectMicroQR field

RectMicroQR Type object.

```csharp
public static readonly QrCodeType RectMicroQR;
```

### TryParse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/qrcodetypes/tryparse.md

#### QrCodeTypes.TryParse method

Returns QRCode type with pasringType name. If name of QRCode is unknown - no Exception will be throw but method will return null value.

```csharp
public static QrCodeType TryParse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of QRCode type name. |

##### Return Value

QRCodeType instance.

### RadioButtonFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature.md

#### RadioButtonFormFieldSignature class

Contains radio-button input form field signature properties.

```csharp
public sealed class RadioButtonFormFieldSignature : FormFieldSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| RadioButtonFormFieldSignature(string) | Creates RadioButtonFieldSignature with predefined name. |
| RadioButtonFormFieldSignature(string, List&lt;string&gt;) | Creates RadioButtonFieldSignature with predefined name and items list. |
| RadioButtonFormFieldSignature(string, List&lt;string&gt;, object) | Creates RadioButtonFieldSignature with predefined name, items list and selected value. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Items { get; set; } | Get or set Radio buttons options list. |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| Selected { get; set; } | Contains selected value. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/clone.md

#### RadioButtonFormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/equals.md

#### RadioButtonFormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/gethashcode.md

#### RadioButtonFormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Items
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/items.md

#### RadioButtonFormFieldSignature.Items property

Get or set Radio buttons options list.

```csharp
public List<string> Items { get; set; }
```

### RadioButtonFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/radiobuttonformfieldsignature.md

#### RadioButtonFormFieldSignature(string)

Creates RadioButtonFieldSignature with predefined name.

```csharp
public RadioButtonFormFieldSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |

#### RadioButtonFormFieldSignature(string, List&lt;string&gt;)

Creates RadioButtonFieldSignature with predefined name and items list.

```csharp
public RadioButtonFormFieldSignature(string name, List<string> items)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| items | List`1 | Values of radio-button list. |

#### RadioButtonFormFieldSignature(string, List&lt;string&gt;, object)

Creates RadioButtonFieldSignature with predefined name, items list and selected value.

```csharp
public RadioButtonFormFieldSignature(string name, List<string> items, object selected)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| items | List`1 | Values of radio-button list. |
| selected | Object | Selected value. |

### Selected
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/radiobuttonformfieldsignature/selected.md

#### RadioButtonFormFieldSignature.Selected property

Contains selected value.

```csharp
public string Selected { get; set; }
```

### SearchResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult.md

#### SearchResult class

Result of searching for signatures in specified document.

```csharp
public class SearchResult : IEnumerable<BaseSignature>, IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns destination document size. For Search method it always returns 0. |
| Failed { get; } | List of signatures `BaseSignature` that failed Search process by search criteria. Supported only for failed Archive documents on Search method. |
| ProcessingTime { get; } | Returns the execution time of the search process in milliseconds. |
| Signatures { get; } | List of found signatures `BaseSignature`. |
| SourceDocumentSize { get; } | Returns source document size |
| Succeeded { get; } | List of found signatures `BaseSignature`. This list will be always equal to `Signatures` property. |
| TotalSignatures { get; } | Returns the total processed signatures by the search process |

#### Methods

| Name | Description |
| --- | --- |
| GetEnumerator() | Returns enumerator. |
| ToList&lt;T&gt;() | Provides conversion to strongly typed list of signatures. |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/destindocumentsize.md

#### SearchResult.DestinDocumentSize property

Returns destination document size. For Search method it always returns 0.

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/failed.md

#### SearchResult.Failed property

List of signatures `BaseSignature` that failed Search process by search criteria. Supported only for failed Archive documents on Search method.

```csharp
public List<BaseSignature> Failed { get; }
```

### GetEnumerator
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/getenumerator.md

#### SearchResult.GetEnumerator method

Returns enumerator.

```csharp
public IEnumerator<BaseSignature> GetEnumerator()
```

##### Return Value

Returns instance of IEnumerator.

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/processingtime.md

#### SearchResult.ProcessingTime property

Returns the execution time of the search process in milliseconds.

```csharp
public long ProcessingTime { get; }
```

### Signatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/signatures.md

#### SearchResult.Signatures property

List of found signatures `BaseSignature`.

```csharp
public List<BaseSignature> Signatures { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/sourcedocumentsize.md

#### SearchResult.SourceDocumentSize property

Returns source document size

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/succeeded.md

#### SearchResult.Succeeded property

List of found signatures `BaseSignature`. This list will be always equal to `Signatures` property.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### ToList
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/tolist.md

#### SearchResult.ToList&lt;T&gt; method

Provides conversion to strongly typed list of signatures.

```csharp
public List<T> ToList<T>()
    where T : BaseSignature
```

| Parameter | Description |
| --- | --- |
| T | The type of signatures in the list. |

##### Return Value

Returns list of given signature type.

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/searchresult/totalsignatures.md

#### SearchResult.TotalSignatures property

Returns the total processed signatures by the search process

```csharp
public int TotalSignatures { get; }
```

### ShapePosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/shapeposition.md

#### ShapePosition enumeration

Specifies shape position in the document layout

```csharp
public enum ShapePosition
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Shape presents in the document body |
| Header | `1` | Shape presents in the document header |
| Footer | `2` | Shape presents in the document footer |

### SignatureFont
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont.md

#### SignatureFont class

Creates instance of SignatureFont class to specify Font properties.

```csharp
public class SignatureFont
```

#### Constructors

| Name | Description |
| --- | --- |
| SignatureFont() | Create SignatureFont with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Bold { get; set; } | Gets or sets font bold style |
| FamilyName { get; set; } | Gets or sets font family name |
| Italic { get; set; } | Gets or sets font italic style |
| Size { get; set; } | Gets or sets font size |
| Strikeout { get; set; } | Gets or sets font strikeout style |
| Underline { get; set; } | Gets or sets font underline style |

#### Methods

| Name | Description |
| --- | --- |
| implicit operator | Convert System.Drawing.Font to SignatureFont. |

### Bold
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/bold.md

#### SignatureFont.Bold property

Gets or sets font bold style

```csharp
public bool Bold { get; set; }
```

### FamilyName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/familyname.md

#### SignatureFont.FamilyName property

Gets or sets font family name

```csharp
public string FamilyName { get; set; }
```

### Italic
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/italic.md

#### SignatureFont.Italic property

Gets or sets font italic style

```csharp
public bool Italic { get; set; }
```

### op_Implicit
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/op_implicit.md

#### SignatureFont Implicit operator

Convert System.Drawing.Font to SignatureFont.

```csharp
public static implicit operator SignatureFont(Font font)
```

| Parameter | Type | Description |
| --- | --- | --- |
| font | Font | Standard system Font property to make a copy from. |

##### Return Value

SignatureFont instance

### SignatureFont
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/signaturefont.md

#### SignatureFont constructor

Create SignatureFont with default values.

```csharp
public SignatureFont()
```

### Size
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/size.md

#### SignatureFont.Size property

Gets or sets font size

```csharp
public float Size { get; set; }
```

### Strikeout
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/strikeout.md

#### SignatureFont.Strikeout property

Gets or sets font strikeout style

```csharp
public bool Strikeout { get; set; }
```

### Underline
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturefont/underline.md

#### SignatureFont.Underline property

Gets or sets font underline style

```csharp
public bool Underline { get; set; }
```

### SignatureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signaturetype.md

#### SignatureType enumeration

Defines supported types of signatures for various processes like Sign, Verify, Search, Update, Delete

```csharp
public enum SignatureType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Indicates an error, unknown signature type. |
| Text | `1` | The Text Signature type |
| Image | `2` | The Image Signature type |
| Barcode | `3` | The Barcode Signature type |
| QrCode | `4` | The QR-Code Signature type |
| Stamp | `5` | The Stamp Signature type |
| Metadata | `6` | The Metadata Signature type |
| FormField | `7` | The FormField Signature type |
| Digital | `8` | The Digital Signature type |

### SignResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult.md

#### SignResult class

Result of signing process for document with newly created signatures.

```csharp
public class SignResult : IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns destination document size |
| Failed { get; } | List of signatures that were failed to create. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds |
| SourceDocumentSize { get; } | Returns source document size |
| Succeeded { get; } | List of newly created signatures `BaseSignature`. |
| TotalSignatures { get; } | Returns the total processed signatures |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/destindocumentsize.md

#### SignResult.DestinDocumentSize property

Returns destination document size

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/failed.md

#### SignResult.Failed property

List of signatures that were failed to create.

```csharp
public List<BaseSignature> Failed { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/processingtime.md

#### SignResult.ProcessingTime property

Returns the execution time of the process in milliseconds

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/sourcedocumentsize.md

#### SignResult.SourceDocumentSize property

Returns source document size

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/succeeded.md

#### SignResult.Succeeded property

List of newly created signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/signresult/totalsignatures.md

#### SignResult.TotalSignatures property

Returns the total processed signatures

```csharp
public int TotalSignatures { get; }
```

### SpreadsheetMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/spreadsheetmetadatasignature.md

#### SpreadsheetMetadataSignature class

Contains Spreadsheet Metadata Signature properties.

```csharp
public sealed class SpreadsheetMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetMetadataSignature(string) | Creates Spreadsheet Metadata Signature with predefined name and empty value. |
| SpreadsheetMetadataSignature(string, object) | Creates Spreadsheet Metadata Signature with predefined values. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Spreadsheet Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| override ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/spreadsheetmetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Spreadsheet Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### SpreadsheetMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/spreadsheetmetadatasignature/spreadsheetmetadatasignature.md

#### SpreadsheetMetadataSignature(string)

Creates Spreadsheet Metadata Signature with predefined name and empty value.

```csharp
public SpreadsheetMetadataSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Spreadsheet Metadata Signature name. |

#### SpreadsheetMetadataSignature(string, object)

Creates Spreadsheet Metadata Signature with predefined values.

```csharp
public SpreadsheetMetadataSignature(string name, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object. |
| value | Object | Value of Metadata signature. |

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/spreadsheetmetadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public override string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

### SpreadsheetSaveFileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/spreadsheetsavefileformat.md

#### SpreadsheetSaveFileFormat enumeration

Defines different save formats for Spreadsheet documents.

```csharp
public enum SpreadsheetSaveFileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | File format will not be changed. |
| CSV | `1` | Saves the document as comma separated value file. |
| Excel97To2003 | `5` | Saves the document as Microsoft Excel 97-2003 workbook (.xls). |
| Xlsx | `6` | Saves the document an Microsoft Excel OpenXML workbook. |
| Xlsm | `7` | Saves the document as Microsoft Excel macro-enabled workbook. |
| Xltx | `8` | Saves the document as Microsoft Excel template. |
| Xltm | `9` | Saves the document as Microsoft Excel macro-enabled template. |
| Xlam | `10` | Saves the document as Microsoft Excel macro-enabled add-In. |
| Pdf | `13` | Saves the document as an PDF file. |
| ODS | `14` | Saves the document as Open Office workbook. |
| Xlsb | `16` | Saves the document as Microsoft Excel Binary workbook. |
| XPS | `20` | Saves the document as XML Paper Specification File. |
| TIFF | `21` | Saves the document in Tagged Image File Format. |
| SVG | `22` | Saves the document as Scalable Vector Graphics file. |
| Dif | `30` | Saves the document in Data Interchange Format. |
| Emf | `31` | Saves the document in Windows Enhanced Metafile format. |
| Jpg | `33` | Saves the document in Jpeg format. |
| Png | `34` | Saves the document in Portable Network Graphics format. |

### SquareBorder
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/squareborder.md

#### SquareBorder class

Instance to keep Border line properties for square stamp line.

```csharp
public class SquareBorder : Border
```

#### Constructors

| Name | Description |
| --- | --- |
| SquareBorder(Corners) | Creates SquareBorderLine with corner radius values. |
| SquareBorder(double) | Creates SquareBorderLine with rounded corner radius. |

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | Gets or sets the border color of signature. |
| DashStyle { get; set; } | Gets or sets the signature border style. |
| Radius { get; set; } | Gets or sets the radius of square corners. |
| Transparency { get; set; } | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| Visible { get; set; } | Gets or sets the border visibility. |
| Weight { get; set; } | Gets or sets the weight of the signature border. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Implement IClonable interface |

### Radius
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/squareborder/radius.md

#### SquareBorder.Radius property

Gets or sets the radius of square corners.

```csharp
public Corners Radius { get; set; }
```

### SquareBorder
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/squareborder/squareborder.md

#### SquareBorder(double)

Creates SquareBorderLine with rounded corner radius.

```csharp
public SquareBorder(double radius)
```

| Parameter | Type | Description |
| --- | --- | --- |
| radius | Double | Radius of square corners. |

#### SquareBorder(Corners)

Creates SquareBorderLine with corner radius values.

```csharp
public SquareBorder(Corners corners)
```

| Parameter | Type | Description |
| --- | --- | --- |
| corners | Corners | Radius of square corners. |

### StampBackgroundCropType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampbackgroundcroptype.md

#### StampBackgroundCropType enumeration

Specifies crop type of background layer on Stamp elements.

```csharp
public enum StampBackgroundCropType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No crop - all Signature area rectangle will be filled with background. |
| OuterArea | `1` | Crop background by external outer line. |
| MiddleArea | `2` | Crop background between external and inner lines. |
| InnerArea | `3` | Crop background by internal line. |

### StampLine
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline.md

#### StampLine class

Specify Stamp line properties.

```csharp
public class StampLine
```

#### Constructors

| Name | Description |
| --- | --- |
| StampLine() | Create StampLine with default values. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets the background color of signature. |
| Font { get; set; } | Gets or sets Font of Stamp Line text. |
| Height { get; set; } | Gets or sets the line height on Stamp. |
| InnerBorder { get; set; } | Setup Internal Border. |
| OuterBorder { get; set; } | Setup Outer Border. |
| Text { get; set; } | Gets or sets the text of stamp line. |
| TextBottomIntent { get; set; } | Gets or sets the bottom intent of text. |
| TextColor { get; set; } | Gets or sets the text color of signature. |
| TextRepeatType { get; set; } | Gets or sets text repeat type. |
| Visible { get; set; } | Get and set visibility of Stamp Line. |

### BackgroundColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/backgroundcolor.md

#### StampLine.BackgroundColor property

Gets or sets the background color of signature.

```csharp
public Color BackgroundColor { get; set; }
```

### Font
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/font.md

#### StampLine.Font property

Gets or sets Font of Stamp Line text.

```csharp
public SignatureFont Font { get; set; }
```

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/height.md

#### StampLine.Height property

Gets or sets the line height on Stamp.

```csharp
public int Height { get; set; }
```

### InnerBorder
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/innerborder.md

#### StampLine.InnerBorder property

Setup Internal Border.

```csharp
public Border InnerBorder { get; set; }
```

### OuterBorder
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/outerborder.md

#### StampLine.OuterBorder property

Setup Outer Border.

```csharp
public Border OuterBorder { get; set; }
```

### StampLine
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/stampline.md

#### StampLine constructor

Create StampLine with default values.

```csharp
public StampLine()
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/text.md

#### StampLine.Text property

Gets or sets the text of stamp line.

```csharp
public string Text { get; set; }
```

### TextBottomIntent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/textbottomintent.md

#### StampLine.TextBottomIntent property

Gets or sets the bottom intent of text.

```csharp
public int TextBottomIntent { get; set; }
```

### TextColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/textcolor.md

#### StampLine.TextColor property

Gets or sets the text color of signature.

```csharp
public Color TextColor { get; set; }
```

### TextRepeatType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/textrepeattype.md

#### StampLine.TextRepeatType property

Gets or sets text repeat type.

```csharp
public StampTextRepeatType TextRepeatType { get; set; }
```

### Visible
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stampline/visible.md

#### StampLine.Visible property

Get and set visibility of Stamp Line.

```csharp
public bool Visible { get; set; }
```

### StampTextRepeatType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptextrepeattype.md

#### StampTextRepeatType enumeration

Specifies type of text repeat for stamp lines.

```csharp
public enum StampTextRepeatType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No repeat. |
| FullTextRepeat | `1` | Text will be repeated to fit full length without truncation. |
| RepeatWithTruncation | `2` | Text will be repeated to fit full length with word truncation at the end. |

### StampType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype.md

#### StampType class

Specify stamp type properties.

```csharp
public sealed class StampType : IEquatable<StampType>
```

#### Properties

| Name | Description |
| --- | --- |
| TypeIndex { get; } | Get Index of object in collection of supported stamp types. |
| TypeName { get; } | Name of stamp type. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Overridden method determines whether the specified System.Object is equal to the current System.Object. |
| Equals(StampType) | Determines whether the specified stamp type is equal to the current object. |
| override GetHashCode() | Overridden method serves as a hash function for a particular type. |
| override ToString() | Overridden method serves as conversion to string type. |

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype/equals.md

#### Equals(StampType)

Determines whether the specified stamp type is equal to the current object.

```csharp
public bool Equals(StampType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | StampType | Object for comparison. |

##### Return Value

Result of comparison.

#### Equals(object)

Overridden method determines whether the specified System.Object is equal to the current System.Object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Object for comparison. |

##### Return Value

Result of comparison.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype/gethashcode.md

#### StampType.GetHashCode method

Overridden method serves as a hash function for a particular type.

```csharp
public override int GetHashCode()
```

##### Return Value

Hash.

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype/tostring.md

#### StampType.ToString method

Overridden method serves as conversion to string type.

```csharp
public override string ToString()
```

##### Return Value

String.

### TypeIndex
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype/typeindex.md

#### StampType.TypeIndex property

Get Index of object in collection of supported stamp types.

```csharp
public int TypeIndex { get; }
```

### TypeName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptype/typename.md

#### StampType.TypeName property

Name of stamp type.

```csharp
public string TypeName { get; }
```

### StampTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes.md

#### StampTypes class

Stamp types container.

```csharp
public static class StampTypes
```

#### Properties

| Name | Description |
| --- | --- |
| static AllTypes { get; } | All stamp types. |

#### Methods

| Name | Description |
| --- | --- |
| static Parse(string) | Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown. |
| static TryParse(string) | Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Round | Round stamp type object. |
| static readonly Square | Square stamp type object. |

### AllTypes
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes/alltypes.md

#### StampTypes.AllTypes property

All stamp types.

```csharp
public static StampType[] AllTypes { get; }
```

### Parse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes/parse.md

#### StampTypes.Parse method

Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown.

```csharp
public static StampType Parse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of stamp type name. |

##### Return Value

StampType instance.

### Round
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes/round.md

#### StampTypes.Round field

Round stamp type object.

```csharp
public static readonly StampType Round;
```

### Square
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes/square.md

#### StampTypes.Square field

Square stamp type object.

```csharp
public static readonly StampType Square;
```

### TryParse
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stamptypes/tryparse.md

#### StampTypes.TryParse method

Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value.

```csharp
public static StampType TryParse(string parsingType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | String | Source string of stamp type name. |

##### Return Value

StampType instance.

### StretchMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/stretchmode.md

#### StretchMode enumeration

Represents stretch mode of signature area on a document page.

```csharp
public enum StretchMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Default value. No stretch mode will be applied. |
| PageWidth | `1` | Stretch Signature area along page Width. Margin property will be used to apply required offset values |
| PageHeight | `2` | Stretch Signature area along page Height. Margin property will be used to apply required offset values. |
| PageArea | `3` | Stretch Signature area along page Height and Width. Margin property will be used to apply required offset values. |

### TextFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature.md

#### TextFormFieldSignature class

Contains text input form field signature properties for Pdf Document

```csharp
public sealed class TextFormFieldSignature : FormFieldSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| TextFormFieldSignature(string) | Creates PdfTextFormFieldSignature with predefined name. |
| TextFormFieldSignature(string, string) | Creates PdfTextFormFieldSignature with predefined name. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique form field name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Text { get; set; } | Gets or sets text of form field text input. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies Form field type. |
| Value { get; set; } | Specifies Form field data object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone FormField Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature/clone.md

#### TextFormFieldSignature.Clone method

Clone FormField Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned FormField Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature/equals.md

#### TextFormFieldSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature/gethashcode.md

#### TextFormFieldSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature/text.md

#### TextFormFieldSignature.Text property

Gets or sets text of form field text input.

```csharp
public string Text { get; set; }
```

### TextFormFieldSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textformfieldsignature/textformfieldsignature.md

#### TextFormFieldSignature(string)

Creates PdfTextFormFieldSignature with predefined name.

```csharp
public TextFormFieldSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |

#### TextFormFieldSignature(string, string)

Creates PdfTextFormFieldSignature with predefined name.

```csharp
public TextFormFieldSignature(string name, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of form field object. |
| text | String | Text of form field object. |

### TextHorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/texthorizontalalignment.md

#### TextHorizontalAlignment enumeration

Specifies text horizontal alignment inside a signature.

```csharp
public enum TextHorizontalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Left | `1` | Specifies that the text is left aligned to the horizontal alignment base. |
| Center | `2` | Specifies that the text is centered to the horizontal alignment base. |
| Right | `3` | Specifies that the text is right aligned to the horizontal alignment base. |

### TextMatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textmatchtype.md

#### TextMatchType enumeration

Specifies text match type in string.

```csharp
public enum TextMatchType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Exact | `0` | Text fully matches value. |
| StartsWith | `1` | Text starts with value. |
| EndsWith | `2` | Text ends with value. |
| Contains | `3` | Text contains the value. |

### TextShapeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textshapetype.md

#### TextShapeType enumeration

Specifies types of text shapes.

```csharp
public enum TextShapeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Rectangle | `1` | Rectangle. |
| RoundRectangle | `2` | RoundRectangle. |
| Ellipse | `3` | Ellipse. |
| Diamond | `4` | Diamond. |
| Triangle | `5` | Triangle. |
| RightTriangle | `6` | RightTriangle. |
| Parallelogram | `7` | Parallelogram. |
| Trapezoid | `8` | Trapezoid. |
| Hexagon | `9` | Hexagon. |
| Octagon | `10` | Octagon. |
| Plus | `11` | Plus. |
| Star | `12` | Star. |
| Arrow | `13` | Arrow. |
| ThickArrow | `14` | ThickArrow. |
| HomePlate | `15` | HomePlate. |
| Cube | `16` | Cube. |
| Balloon | `17` | Balloon. |
| Seal | `18` | Seal. |
| Arc | `19` | Arc. |
| Line | `20` | Line. |
| Plaque | `21` | Plaque. |
| Can | `22` | Can. |
| Donut | `23` | Donut. |
| TextSimple | `24` | TextSimple. |
| TextOctagon | `25` | TextOctagon. |
| TextHexagon | `26` | TextHexagon. |
| TextCurve | `27` | TextCurve. |
| TextWave | `28` | TextWave. |
| TextRing | `29` | TextRing. |
| TextOnCurve | `30` | TextOnCurve. |
| TextOnRing | `31` | TextOnRing. |
| StraightConnector1 | `32` | StraightConnector1. |
| BentConnector2 | `33` | BentConnector2. |
| BentConnector3 | `34` | BentConnector3. |
| BentConnector4 | `35` | BentConnector4. |
| BentConnector5 | `36` | BentConnector5. |
| CurvedConnector2 | `37` | CurvedConnector2. |
| CurvedConnector3 | `38` | CurvedConnector3. |
| CurvedConnector4 | `39` | CurvedConnector4. |
| CurvedConnector5 | `40` | CurvedConnector5. |
| Callout1 | `41` | Callout1. |
| Callout2 | `42` | Callout2. |
| Callout3 | `43` | Callout3. |
| AccentCallout1 | `44` | AccentCallout1. |
| AccentCallout2 | `45` | AccentCallout2. |
| AccentCallout3 | `46` | AccentCallout3. |
| BorderCallout1 | `47` | BorderCallout1. |
| BorderCallout2 | `48` | BorderCallout2. |
| BorderCallout3 | `49` | BorderCallout3. |
| AccentBorderCallout1 | `50` | AccentBorderCallout1. |
| AccentBorderCallout2 | `51` | AccentBorderCallout2. |
| AccentBorderCallout3 | `52` | AccentBorderCallout3. |
| Ribbon | `53` | Ribbon. |
| Ribbon2 | `54` | Ribbon2. |
| Chevron | `55` | Chevron. |
| Pentagon | `56` | Pentagon. |
| NoSmoking | `57` | NoSmoking. |
| Seal8 | `58` | Seal8. |
| Seal16 | `59` | Seal16. |
| Seal32 | `60` | Seal32. |
| WedgeRectCallout | `61` | WedgeRectCallout. |
| WedgeRRectCallout | `62` | WedgeRRectCallout. |
| WedgeEllipseCallout | `63` | WedgeEllipseCallout. |
| Wave | `64` | Wave. |
| FoldedCorner | `65` | FoldedCorner. |
| LeftArrow | `66` | LeftArrow. |
| DownArrow | `67` | DownArrow. |
| UpArrow | `68` | UpArrow. |
| LeftRightArrow | `69` | LeftRightArrow. |
| UpDownArrow | `70` | UpDownArrow. |
| IrregularSeal1 | `71` | IrregularSeal1. |
| IrregularSeal2 | `72` | IrregularSeal2. |
| LightningBolt | `73` | LightningBolt. |
| Heart | `74` | Heart. |
| Image | `75` | Image. |
| QuadArrow | `76` | QuadArrow. |
| LeftArrowCallout | `77` | LeftArrowCallout. |
| RightArrowCallout | `78` | RightArrowCallout. |
| UpArrowCallout | `79` | UpArrowCallout. |
| DownArrowCallout | `80` | DownArrowCallout. |
| LeftRightArrowCallout | `81` | LeftRightArrowCallout. |
| UpDownArrowCallout | `82` | UpDownArrowCallout. |
| QuadArrowCallout | `83` | QuadArrowCallout. |
| Bevel | `84` | Bevel. |
| LeftBracket | `85` | LeftBracket. |
| RightBracket | `86` | RightBracket. |
| LeftBrace | `87` | LeftBrace. |
| RightBrace | `88` | RightBrace. |
| LeftUpArrow | `89` | LeftUpArrow. |
| BentUpArrow | `90` | BentUpArrow. |
| BentArrow | `91` | BentArrow. |
| Seal24 | `92` | Seal24. |
| StripedRightArrow | `93` | StripedRightArrow. |
| NotchedRightArrow | `94` | NotchedRightArrow. |
| BlockArc | `95` | BlockArc. |
| SmileyFace | `96` | SmileyFace. |
| VerticalScroll | `97` | VerticalScroll. |
| HorizontalScroll | `98` | HorizontalScroll. |
| CircularArrow | `99` | CircularArrow. |
| UturnArrow | `101` | UturnArrow. |
| CurvedRightArrow | `102` | CurvedRightArrow. |
| CurvedLeftArrow | `103` | CurvedLeftArrow. |
| CurvedUpArrow | `104` | CurvedUpArrow. |
| CurvedDownArrow | `105` | CurvedDownArrow. |
| CloudCallout | `106` | CloudCallout. |
| EllipseRibbon | `107` | EllipseRibbon. |
| EllipseRibbon2 | `108` | EllipseRibbon2. |
| FlowChartProcess | `109` | FlowChartProcess. |
| FlowChartDecision | `110` | FlowChartDecision. |
| FlowChartInputOutput | `111` | FlowChartInputOutput. |
| FlowChartPredefinedProcess | `112` | FlowChartPredefinedProcess. |
| FlowChartInternalStorage | `113` | FlowChartInternalStorage. |
| FlowChartDocument | `114` | FlowChartDocument. |
| FlowChartMultidocument | `115` | FlowChartMultidocument. |
| FlowChartTerminator | `116` | FlowChartTerminator. |
| FlowChartPreparation | `117` | FlowChartPreparation. |
| FlowChartManualInput | `118` | FlowChartManualInput. |
| FlowChartManualOperation | `119` | FlowChartManualOperation. |
| FlowChartConnector | `120` | FlowChartConnector. |
| FlowChartPunchedCard | `121` | FlowChartPunchedCard. |
| FlowChartPunchedTape | `122` | FlowChartPunchedTape. |
| FlowChartSummingJunction | `123` | FlowChartSummingJunction. |
| FlowChartOr | `124` | FlowChartOr. |
| FlowChartCollate | `125` | FlowChartCollate. |
| FlowChartSort | `126` | FlowChartSort. |
| FlowChartExtract | `127` | FlowChartExtract. |
| FlowChartMerge | `128` | FlowChartOfflineStorage. |
| FlowChartOfflineStorage | `129` | FlowChartOfflineStorage. |
| FlowChartOnlineStorage | `130` | FlowChartOnlineStorage. |
| FlowChartMagneticTape | `131` | FlowChartMagneticTape. |
| FlowChartMagneticDisk | `132` | FlowChartMagneticDisk. |
| FlowChartMagneticDrum | `133` | FlowChartMagneticDrum. |
| FlowChartDisplay | `134` | FlowChartDisplay. |
| FlowChartDelay | `135` | FlowChartDelay. |
| TextPlainText | `136` | TextPlainText. |
| TextStop | `137` | TextStop. |
| TextTriangle | `138` | TextTriangle. |
| TextTriangleInverted | `139` | TextTriangleInverted. |
| TextChevron | `140` | TextChevron. |
| TextChevronInverted | `141` | TextChevronInverted. |
| TextRingInside | `142` | TextRingInside. |
| TextRingOutside | `143` | TextRingOutside. |
| TextArchUpCurve | `144` | TextArchUpCurve. |
| TextArchDownCurve | `145` | TextArchDownCurve. |
| TextCircleCurve | `146` | TextCircleCurve. |
| TextButtonCurve | `147` | TextButtonCurve. |
| TextArchUpPour | `148` | TextArchUpPour. |
| TextArchDownPour | `149` | TextArchDownPour. |
| TextCirclePour | `150` | TextCirclePour. |
| TextButtonPour | `151` | TextButtonPour. |
| TextCurveUp | `152` | TextCurveUp. |
| TextCurveDown | `153` | TextCurveDown. |
| TextCascadeUp | `154` | TextCascadeUp. |
| TextCascadeDown | `155` | TextCascadeDown. |
| TextWave1 | `156` | TextWave1. |
| TextWave2 | `157` | TextWave2. |
| TextWave3 | `158` | TextWave3. |
| TextWave4 | `159` | TextWave4. |
| TextInflate | `160` | TextInflate. |
| TextDeflate | `161` | TextDeflate. |
| TextInflateBottom | `162` | TextInflateBottom. |
| TextDeflateBottom | `163` | TextDeflateBottom. |
| TextInflateTop | `164` | TextInflateTop. |
| TextDeflateTop | `165` | TextDeflateTop. |
| TextDeflateInflate | `166` | TextDeflateInflate. |
| TextDeflateInflateDeflate | `167` | TextDeflateInflateDeflate. |
| TextFadeRight | `168` | TextFadeRight. |
| TextFadeLeft | `169` | TextFadeLeft. |
| TextFadeUp | `170` | TextFadeUp. |
| TextFadeDown | `171` | TextFadeDown. |
| TextSlantUp | `172` | TextSlantUp. |
| TextSlantDown | `173` | TextSlantDown. |
| TextCanUp | `174` | TextCanUp. |
| TextCanDown | `175` | TextCanDown. |
| FlowChartAlternateProcess | `176` | FlowChartAlternateProcess. |
| FlowChartOffpageConnector | `177` | FlowChartOffpageConnector. |
| Callout90 | `178` | Callout90. |
| AccentCallout90 | `179` | AccentCallout90. |
| BorderCallout90 | `180` | BorderCallout90. |
| AccentBorderCallout90 | `181` | AccentBorderCallout90. |
| LeftRightUpArrow | `182` | LeftRightUpArrow. |
| Sun | `183` | Sun. |
| Moon | `184` | Moon. |
| BracketPair | `185` | BracketPair. |
| BracePair | `186` | BracePair. |
| Seal4 | `187` | Seal4. |
| DoubleWave | `188` | DoubleWave. |
| ActionButtonBlank | `189` | ActionButtonBlank. |
| ActionButtonHome | `190` | ActionButtonHome. |
| ActionButtonHelp | `191` | ActionButtonHelp. |
| ActionButtonInformation | `192` | ActionButtonInformation. |
| ActionButtonForwardNext | `193` | ActionButtonForwardNext. |
| ActionButtonBackPrevious | `194` | ActionButtonBackPrevious. |
| ActionButtonEnd | `195` | ActionButtonEnd. |
| ActionButtonBeginning | `196` | ActionButtonBeginning. |
| ActionButtonReturn | `197` | ActionButtonReturn. |
| ActionButtonDocument | `198` | ActionButtonDocument. |
| ActionButtonSound | `199` | ActionButtonSound. |
| ActionButtonMovie | `200` | ActionButtonMovie. |
| TextBox | `202` | TextBox. |

### TextSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature.md

#### TextSignature class

Contains Text signature properties.

```csharp
public class TextSignature : BaseSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSignature(string) | Initialize TextSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Native { get; set; } | Specifies the native attribute. It is true if signature is document-specific. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureImplementation { get; } | Specifies text signature implementation. |
| SignatureType { get; } | Specifies the type of signature. |
| Text { get; set; } | Specifies text in signature. |
| Top { get; set; } | Specifies top position of signature. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Text Signature instance. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| override GetHashCode() | Overrides GetHashCode method |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/clone.md

#### TextSignature.Clone method

Clone Text Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Text Signature instance.

### Equals
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/equals.md

#### TextSignature.Equals method

Overwrites Equals method to compare signature properties

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Signature object to compare with. |

##### Return Value

Returns true if passed signature object has same type and all its properties are equal to this instance properties.

### GetHashCode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/gethashcode.md

#### TextSignature.GetHashCode method

Overrides GetHashCode method

```csharp
public override int GetHashCode()
```

##### Return Value

Signature hash code

### Native
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/native.md

#### TextSignature.Native property

Specifies the native attribute. It is true if signature is document-specific.

```csharp
public bool Native { get; set; }
```

### SignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/signatureimplementation.md

#### TextSignature.SignatureImplementation property

Specifies text signature implementation.

```csharp
public TextSignatureImplementation SignatureImplementation { get; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/text.md

#### TextSignature.Text property

Specifies text in signature.

```csharp
public string Text { get; set; }
```

### TextSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignature/textsignature.md

#### TextSignature constructor

Initialize TextSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

```csharp
public TextSignature(string signatureId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | String | Unique signature identifier obtained by sign or search method. |

### TextSignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textsignatureimplementation.md

#### TextSignatureImplementation enumeration

Specifies type of implementation for PDF text signature.

```csharp
public enum TextSignatureImplementation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Native | `1` | Text Signature as native text object on document page. |
| Image | `2` | Text Signature as Image object on document page. |
| Annotation | `3` | Text Signature as Text Annotation object on PDF page. Annotations are visible only for Licensed version. |
| Sticker | `4` | Text Signature as Sticker object on PDF page. |
| FormField | `5` | Text Signature as text in specified form field. With this type of implementation could be used only TextSignOptions.Text, TextSignOptions.FormTextFieldType and TextSignOptions.FormTextFieldTitle options. |
| Watermark | `6` | Text Signature as watermark on document page. |

### TextVerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/textverticalalignment.md

#### TextVerticalAlignment enumeration

Specifies text vertical alignment inside a signature.

```csharp
public enum TextVerticalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Top | `1` | Specifies that the text is top aligned to the vertical alignment base. |
| Center | `2` | Specifies that the text is centered to the vertical alignment base. |
| Bottom | `3` | Specifies that the text is bottom aligned to the vertical alignment base. |

### TimeStamp
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/timestamp.md

#### TimeStamp structure

Represents data to get time stamp from third-party site.

```csharp
public struct TimeStamp
```

#### Constructors

| Name | Description |
| --- | --- |
| TimeStamp(string, string, string) | Instantiates new time stamp structure. |

#### Properties

| Name | Description |
| --- | --- |
| Password { get; set; } | Password. |
| Url { get; set; } | Url of third-party site. |
| User { get; set; } | User. |

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/timestamp/password.md

#### TimeStamp.Password property

Password.

```csharp
public string Password { get; set; }
```

### TimeStamp
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/timestamp/timestamp.md

#### TimeStamp constructor

Instantiates new time stamp structure.

```csharp
public TimeStamp(string url, string user, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| url | String | Url of third-party site. |
| user | String | User. |
| password | String | Password. |

### Url
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/timestamp/url.md

#### TimeStamp.Url property

Url of third-party site.

```csharp
public string Url { get; set; }
```

### User
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/timestamp/user.md

#### TimeStamp.User property

User.

```csharp
public string User { get; set; }
```

### UpdateResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult.md

#### UpdateResult class

Result of modification of signatures in the document.

```csharp
public class UpdateResult : IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns destination document size |
| Failed { get; } | List of signatures that were not updated `BaseSignature`. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds |
| SourceDocumentSize { get; } | Returns source document size |
| Succeeded { get; } | List of successfully modified signatures `BaseSignature`. |
| TotalSignatures { get; } | Returns the total processed signatures |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/destindocumentsize.md

#### UpdateResult.DestinDocumentSize property

Returns destination document size

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/failed.md

#### UpdateResult.Failed property

List of signatures that were not updated `BaseSignature`.

```csharp
public List<BaseSignature> Failed { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/processingtime.md

#### UpdateResult.ProcessingTime property

Returns the execution time of the process in milliseconds

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/sourcedocumentsize.md

#### UpdateResult.SourceDocumentSize property

Returns source document size

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/succeeded.md

#### UpdateResult.Succeeded property

List of successfully modified signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/updateresult/totalsignatures.md

#### UpdateResult.TotalSignatures property

Returns the total processed signatures

```csharp
public int TotalSignatures { get; }
```

### VerificationResult
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult.md

#### VerificationResult class

Instance to keep results of verification process.

```csharp
public class VerificationResult : IResult
```

#### Properties

| Name | Description |
| --- | --- |
| DestinDocumentSize { get; } | Returns the destination document size. For verification this variable always contains zero. |
| Failed { get; } | List of signatures that failed verification process. Currently this property is not supported. |
| IsValid { get; } | Returns true if Verification process was successful otherwise false. |
| ProcessingTime { get; } | Returns the execution time of the process in milliseconds. |
| SourceDocumentSize { get; } | Returns source document size in bytes |
| Succeeded { get; } | List of successfully verified signatures `BaseSignature`. |
| TotalSignatures { get; } | Returns the total processed signatures |

### DestinDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/destindocumentsize.md

#### VerificationResult.DestinDocumentSize property

Returns the destination document size. For verification this variable always contains zero.

```csharp
public long DestinDocumentSize { get; }
```

### Failed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/failed.md

#### VerificationResult.Failed property

List of signatures that failed verification process. Currently this property is not supported.

```csharp
public List<BaseSignature> Failed { get; }
```

### IsValid
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/isvalid.md

#### VerificationResult.IsValid property

Returns true if Verification process was successful otherwise false.

```csharp
public bool IsValid { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/processingtime.md

#### VerificationResult.ProcessingTime property

Returns the execution time of the process in milliseconds.

```csharp
public long ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/sourcedocumentsize.md

#### VerificationResult.SourceDocumentSize property

Returns source document size in bytes

```csharp
public long SourceDocumentSize { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/succeeded.md

#### VerificationResult.Succeeded property

List of successfully verified signatures `BaseSignature`.

```csharp
public List<BaseSignature> Succeeded { get; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verificationresult/totalsignatures.md

#### VerificationResult.TotalSignatures property

Returns the total processed signatures

```csharp
public int TotalSignatures { get; }
```

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/verticalalignment.md

#### VerticalAlignment enumeration

Specifies vertical alignment of element on a document page.

```csharp
public enum VerticalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | The object is explicitly positioned, usually using its Top property. |
| Top | `1` | Specifies that the object shall be at the top of the vertical alignment base. |
| Center | `2` | Specifies that the object shall be centered with respect to the vertical alignment base. |
| Bottom | `3` | Specifies that the object shall be at the bottom of the vertical alignment base. |

### WordProcessingMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingmetadatasignature.md

#### WordProcessingMetadataSignature class

Contains WordProcessing Metadata Signature properties.

```csharp
public sealed class WordProcessingMetadataSignature : MetadataSignature
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingMetadataSignature(string) | Creates WordProcessing Metadata Signature with predefined name and empty value. |
| WordProcessingMetadataSignature(string, object) | Creates WordProcessing Metadata Signature with predefined values. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the signature creation date. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| Deleted { get; } | Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures. |
| Height { get; set; } | Specifies height of signature. |
| IsSignature { get; set; } | Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false). |
| Left { get; set; } | Specifies left position of signature. |
| ModifiedOn { get; set; } | Get or set the signature modification date. |
| Name { get; set; } | Specifies unique metadata name. |
| PageNumber { get; } | Specifies the page signature was found on. |
| SignatureId { get; } | Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature. |
| SignatureType { get; } | Specifies the type of signature. |
| Top { get; set; } | Specifies top position of signature. |
| Type { get; } | Specifies metadata value type. |
| Value { get; set; } | Specifies metadata object. |
| Width { get; set; } | Specifies width of signature. |

#### Methods

| Name | Description |
| --- | --- |
| override Clone() | Clone Metadata Signature instance. |
| override Clone(object) | Clone Words Metadata Signature instance with given value. |
| override Equals(object) | Overwrites Equals method to compare signature properties |
| GetData&lt;T&gt;() | Obtain object from Metadata Signature Value over deserialization. |
| GetData&lt;T&gt;(IDataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| override GetHashCode() | Overrides GetHashCode method |
| virtual ToBoolean() | Converts to boolean. |
| virtual ToDateTime() | Converts to DateTime. |
| virtual ToDateTime(IFormatProvider) | Converts to DateTime. |
| virtual ToDecimal() | Converts to Decimal. |
| virtual ToDecimal(IFormatProvider) | Converts to Decimal. |
| virtual ToDouble() | Converts to Double. |
| virtual ToDouble(IFormatProvider) | Converts to Double. |
| virtual ToInteger() | Converts to integer. |
| virtual ToSingle() | Converts to float. |
| virtual ToSingle(IFormatProvider) | Converts to float. |
| override ToString() | Converts to String with override ToString() method |
| virtual ToString(string) | Converts to String with specified format |
| override ToString(string, IFormatProvider) | Converts to String with specified format |

### Clone
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingmetadatasignature/clone.md

#### Clone()

Clone Metadata Signature instance.

```csharp
public override object Clone()
```

##### Return Value

Returns cloned Metadata Signature instance

#### Clone(object)

Clone Words Metadata Signature instance with given value.

```csharp
public override MetadataSignature Clone(object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Object | Value for new cloned object. |

##### Return Value

Returns cloned Metadata Signature instance.

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingmetadatasignature/tostring.md

#### ToString()

Converts to String with override ToString() method

```csharp
public override string ToString()
```

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.

#### ToString(string, IFormatProvider)

Converts to String with specified format

```csharp
public override string ToString(string format, IFormatProvider provider)
```

| Parameter | Type | Description |
| --- | --- | --- |
| format | String | Data format string. |
| provider | IFormatProvider | Format data provider to use with data conversion operations. |

##### Return Value

Returns the Metadata Signature value as String.

##### Remarks

Converts a boolean property into "True" or "False".

### WordProcessingMetadataSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingmetadatasignature/wordprocessingmetadatasignature.md

#### WordProcessingMetadataSignature(string)

Creates WordProcessing Metadata Signature with predefined name and empty value.

```csharp
public WordProcessingMetadataSignature(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | WordProcessing Metadata Signature name. |

#### WordProcessingMetadataSignature(string, object)

Creates WordProcessing Metadata Signature with predefined values.

```csharp
public WordProcessingMetadataSignature(string name, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object. |
| value | Object | Value of Metadata signature. |

### WordProcessingSaveFileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingsavefileformat.md

#### WordProcessingSaveFileFormat enumeration

Defines different save file formats for WordProcessing documents.

```csharp
public enum WordProcessingSaveFileFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | File Format will not be changed. |
| Doc | `1` | Saves the document as Microsoft Word 97-2003 document. |
| Dot | `2` | Saves the document as Microsoft Word 97-2003 template. |
| Docx | `3` | Saves the document as Microsoft Word OpenXML document. |
| Docm | `4` | Saves the document as Microsoft Word OpenXML macro-enabled document. |
| Dotx | `5` | Saves the document as Microsoft Word OpenXML template. |
| Dotm | `6` | Saves the document as Microsoft Word OpenXML macro-enabled template. |
| FlatOpc | `24` | Saves the document as an Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package. |
| FlatOpcMacroEnabled | `25` | Saves the document as an Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplate | `26` | Saves the document as an Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplateMacroEnabled | `27` | Saves the document as an Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package. |
| Rtf | `30` | Saves the document in the RTF Format. All characters above 7-bits are escaped as hexadecimal or Unicode characters. |
| WordML | `31` | Saves the document in the Microsoft Word 2003 WordprocessingML Format. |
| Pdf | `40` | Saves the document as PDF (Adobe Portable Document) Format. |
| Xps | `41` | Saves the document in the XPS (XML Paper Specification) Format. |
| Ps | `47` | Saves the document in the PS (PostScript) Format. |
| Mhtml | `51` | Saves the document in the MHTML (Web archive) Format. |
| Epub | `52` | Saves the document in the IDPF EPUB Format. |
| Odt | `60` | Saves the document as Open Office document. |
| Ott | `61` | Saves the document as Open Office document template. |
| Text | `70` | Saves the document in the plain text format. |
| Tiff | `100` | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| Png | `101` | Renders a page of the document and saves it as a PNG file. |
| Bmp | `102` | Renders a page of the document and saves it as a BMP file. |
| Emf | `103` | Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file. |
| Jpeg | `104` | Renders a page of the document and saves it as a JPEG file. |
| Azw3 | `105` | Renders a page of the document and saves it as a Azw3 file. |

### WordProcessingTextSignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/wordprocessingtextsignatureimplementation.md

#### WordProcessingTextSignatureImplementation enumeration

Specifies type of text signature implementation for WordProcessing documents.

```csharp
public enum WordProcessingTextSignatureImplementation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| TextStamp | `0` | Text Signature as Label object on Words page. |
| TextAsImage | `1` | Text Signature as Image object on Words page. |
| TextToFormField | `2` | Text Signature as text in specified form field. With this type of implementation could be used only TextSignOptions.Text, TextSignOptions.FormTextFieldTitle and TextSignOptions.FormTextFieldType options. |
| Watermark | `3` | Text Signature as watermark on Words page. |

### XAdESType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.domain/xadestype.md

#### XAdESType enumeration

Type of XML Advanced Electronic Signature (XAdES).

```csharp
public enum XAdESType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | XAdES is off. |
| XAdES | `1` | Basic XAdES. |

### GroupDocs.Signature.Logging
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging.md

The namespace provides classes for logging purposes.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the file. |
| FileLogger | Writes log messages to the file. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| LogLevel | Specifies the available Log Level types. This enumeration can be used as flags to set several possible values as enabled bits Example: LogLevel.Error &#x7C; LogLevel.Warning or LogLevel.Error &#x7C; LogLevel.Trace |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/consolelogger.md

#### ConsoleLogger class

Writes log messages to the file.

```csharp
public class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | Create logger to console. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. |
| Trace(string) | Writes trace message to the console. Trace log messages provide generally useful information about application flow. |
| Warning(string) | Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow. |

### ConsoleLogger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

Create logger to console.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow.

```csharp
public void Error(string message, Exception ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| ex | Exception | The exception. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *ex* is null. |

### Trace
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Writes trace message to the console. Trace log messages provide generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### FileLogger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/filelogger.md

#### FileLogger class

Writes log messages to the file.

```csharp
public class FileLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| FileLogger(string) | Create logger to file. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. |
| Trace(string) | Writes trace message to the console. Trace log messages provide generally useful information about application flow. |
| Warning(string) | Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow. |

### Error
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/filelogger/error.md

#### FileLogger.Error method

Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow.

```csharp
public void Error(string message, Exception ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| ex | Exception | The exception. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *ex* is null. |

### FileLogger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/filelogger/filelogger.md

#### FileLogger constructor

Create logger to file.

```csharp
public FileLogger(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Full file name with path |

### Trace
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/filelogger/trace.md

#### FileLogger.Trace method

Writes trace message to the console. Trace log messages provide generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/filelogger/warning.md

#### FileLogger.Warning method

Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### ILogger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.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 a trace message. Trace log messages provide 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/signature/net/groupdocs.signature.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 ex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| ex | Exception | The exception. |

### Trace
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/ilogger/trace.md

#### ILogger.Trace method

Writes a trace message. Trace log messages provide 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/signature/net/groupdocs.signature.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. |

### LogLevel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.logging/loglevel.md

#### LogLevel enumeration

Specifies the available Log Level types. This enumeration can be used as flags to set several possible values as enabled bits Example: LogLevel.Error &#x7C; LogLevel.Warning or LogLevel.Error &#x7C; LogLevel.Trace

```csharp
[Flags]
public enum LogLevel
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No logging limitation all information will be logged from trace, warning to errors |
| Error | `1` | No logging limitation all information will be logged from trace, warning to errors |
| Warning | `2` | Same as All level, all messages including the Trace level will be logged |
| Trace | `4` | The logging level to include messages from the Warning to Error level |
| All | `7` | All Log level events (Error, Warning, Trace) will be included into the logging |

### GroupDocs.Signature.Options.Appearances
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances.md

The namespace provides classes for additional signature appearances.

#### Classes

| Class | Description |
| --- | --- |
| DigitalSignatureAppearance | Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats. |
| ImageAppearance | Describes extended appearance features for Image Signature. |
| PdfDigitalSignatureAppearance | Describes appearance of Digital Signature are on PDF documents. |
| PdfTextAnnotationAppearance | Describes appearance of PDF text annotation object (Title, Subject, Content). |
| PdfTextStickerAppearance | Describes appearance of PDF text annotation sticker object and pop-up window of sticker. |
| SignatureAppearance | Represents the signature appearance - additional options for alternative implementations of sign on document page. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### DigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/digitalsignatureappearance.md

#### DigitalSignatureAppearance class

Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats.

```csharp
public sealed class DigitalSignatureAppearance : SignatureAppearance
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalSignatureAppearance() | Creates Signature Line Appearance object. |
| DigitalSignatureAppearance(string, string, string) | Creates Signature Line Appearance with specified values (signer, title, email). |

#### Properties

| Name | Description |
| --- | --- |
| Email { get; set; } | Gets or sets a email that will be displayed in signature line. |
| Signer { get; set; } | Gets or sets signer name for signature line. |
| Title { get; set; } | Gets or sets a title for signature line. |

### DigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/digitalsignatureappearance/digitalsignatureappearance.md

#### DigitalSignatureAppearance()

Creates Signature Line Appearance object.

```csharp
public DigitalSignatureAppearance()
```

#### DigitalSignatureAppearance(string, string, string)

Creates Signature Line Appearance with specified values (signer, title, email).

```csharp
public DigitalSignatureAppearance(string signer, string title, string email)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signer | String | Signer name. |
| title | String | Signature title. |
| email | String | Author' email. |

### Email
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/digitalsignatureappearance/email.md

#### DigitalSignatureAppearance.Email property

Gets or sets a email that will be displayed in signature line.

```csharp
public string Email { get; set; }
```

### Signer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/digitalsignatureappearance/signer.md

#### DigitalSignatureAppearance.Signer property

Gets or sets signer name for signature line.

```csharp
public string Signer { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/digitalsignatureappearance/title.md

#### DigitalSignatureAppearance.Title property

Gets or sets a title for signature line.

```csharp
public string Title { get; set; }
```

### ImageAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance.md

#### ImageAppearance class

Describes extended appearance features for Image Signature.

```csharp
public class ImageAppearance : SignatureAppearance
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageAppearance() | Create instance with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Brightness { get; set; } | Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image. |
| Contrast { get; set; } | Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image. |
| GammaCorrection { get; set; } | Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image. |
| Grayscale { get; set; } | Setup this flag to true if gray-scale filter is required. |

### Brightness
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance/brightness.md

#### ImageAppearance.Brightness property

Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.

```csharp
public float Brightness { get; set; }
```

### Contrast
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance/contrast.md

#### ImageAppearance.Contrast property

Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.

```csharp
public float Contrast { get; set; }
```

### GammaCorrection
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance/gammacorrection.md

#### ImageAppearance.GammaCorrection property

Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.

```csharp
public float GammaCorrection { get; set; }
```

### Grayscale
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance/grayscale.md

#### ImageAppearance.Grayscale property

Setup this flag to true if gray-scale filter is required.

```csharp
public bool Grayscale { get; set; }
```

### ImageAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/imageappearance/imageappearance.md

#### ImageAppearance constructor

Create instance with default values.

```csharp
public ImageAppearance()
```

### PdfDigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance.md

#### PdfDigitalSignatureAppearance class

Describes appearance of Digital Signature are on PDF documents.

```csharp
public sealed class PdfDigitalSignatureAppearance : SignatureAppearance
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfDigitalSignatureAppearance() | Creates signature appearance object with default values. |

#### Properties

| Name | Description |
| --- | --- |
| Background { get; set; } | Get or set background color of signature appearance. By default the value is SystemColors.Windows |
| ContactInfoLabel { get; set; } | Gets or sets contact info label. Default value: "Contact". if this value is empty then no contact label will appear on digital signature area. |
| DateSignedAtLabel { get; set; } | Gets or sets date signed label. Default value: "Date". |
| DigitalSignedLabel { get; set; } | Gets or sets digital signed label. Default value: "Digitally signed by". |
| FontFamilyName { get; set; } | Gets or sets the Font family name to display the labels. Default value is "Arial". |
| FontSize { get; set; } | Gets or sets the Font size to display the labels. Default value is 10. |
| Foreground { get; set; } | Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255) |
| IsForegroundImage { get; set; } | Gets or sets a value indicating whether the image in the signature appearance is drawn as a foreground image. Default value: false. |
| LocationLabel { get; set; } | Gets or sets location label. Default value: "Location". if this value is empty then no location label will appear on digital signature area. |
| ReasonLabel { get; set; } | Gets or sets reason label. Default value: "Reason". if this value is empty then no reason label will appear on digital signature area. |

### Background
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/background.md

#### PdfDigitalSignatureAppearance.Background property

Get or set background color of signature appearance. By default the value is SystemColors.Windows

```csharp
public Color Background { get; set; }
```

### ContactInfoLabel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/contactinfolabel.md

#### PdfDigitalSignatureAppearance.ContactInfoLabel property

Gets or sets contact info label. Default value: "Contact". if this value is empty then no contact label will appear on digital signature area.

```csharp
public string ContactInfoLabel { get; set; }
```

### DateSignedAtLabel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/datesignedatlabel.md

#### PdfDigitalSignatureAppearance.DateSignedAtLabel property

Gets or sets date signed label. Default value: "Date".

```csharp
public string DateSignedAtLabel { get; set; }
```

### DigitalSignedLabel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/digitalsignedlabel.md

#### PdfDigitalSignatureAppearance.DigitalSignedLabel property

Gets or sets digital signed label. Default value: "Digitally signed by".

```csharp
public string DigitalSignedLabel { get; set; }
```

### FontFamilyName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/fontfamilyname.md

#### PdfDigitalSignatureAppearance.FontFamilyName property

Gets or sets the Font family name to display the labels. Default value is "Arial".

```csharp
public string FontFamilyName { get; set; }
```

### FontSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/fontsize.md

#### PdfDigitalSignatureAppearance.FontSize property

Gets or sets the Font size to display the labels. Default value is 10.

```csharp
public double FontSize { get; set; }
```

### Foreground
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/foreground.md

#### PdfDigitalSignatureAppearance.Foreground property

Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)

```csharp
public Color Foreground { get; set; }
```

### IsForegroundImage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/isforegroundimage.md

#### PdfDigitalSignatureAppearance.IsForegroundImage property

Gets or sets a value indicating whether the image in the signature appearance is drawn as a foreground image. Default value: false.

```csharp
public bool IsForegroundImage { get; set; }
```

### LocationLabel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/locationlabel.md

#### PdfDigitalSignatureAppearance.LocationLabel property

Gets or sets location label. Default value: "Location". if this value is empty then no location label will appear on digital signature area.

```csharp
public string LocationLabel { get; set; }
```

### PdfDigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/pdfdigitalsignatureappearance.md

#### PdfDigitalSignatureAppearance constructor

Creates signature appearance object with default values.

```csharp
public PdfDigitalSignatureAppearance()
```

### ReasonLabel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/reasonlabel.md

#### PdfDigitalSignatureAppearance.ReasonLabel property

Gets or sets reason label. Default value: "Reason". if this value is empty then no reason label will appear on digital signature area.

```csharp
public string ReasonLabel { get; set; }
```

### PdfTextAnnotationAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance.md

#### PdfTextAnnotationAppearance class

Describes appearance of PDF text annotation object (Title, Subject, Content).

```csharp
public class PdfTextAnnotationAppearance : SignatureAppearance
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfTextAnnotationAppearance() | Creates PDF signature text annotation appearance object. |
| PdfTextAnnotationAppearance(string, string, string) | Creates PDF signature text annotation with specified values (title, subject, contents). |

#### Properties

| Name | Description |
| --- | --- |
| Border { get; set; } | Gets or sets different border settings |
| BorderEffect { get; set; } | Gets or sets border effect. |
| BorderEffectIntensity { get; set; } | Gets or sets border effect intensity. Valid range of value is [0..2]. |
| Contents { get; set; } | Gets or sets content of annotation object. |
| HCornerRadius { get; set; } | Gets or sets horizontal corner radius. |
| Subject { get; set; } | Gets or sets Subject representing description of the object. |
| Title { get; set; } | Gets or sets a Title that will be displayed in title bar of annotation object. |
| VCornerRadius { get; set; } | Gets or sets vertical corner radius. |

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/border.md

#### PdfTextAnnotationAppearance.Border property

Gets or sets different border settings

```csharp
public Border Border { get; set; }
```

### BorderEffect
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/bordereffect.md

#### PdfTextAnnotationAppearance.BorderEffect property

Gets or sets border effect.

```csharp
public PdfTextAnnotationBorderEffect BorderEffect { get; set; }
```

### BorderEffectIntensity
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/bordereffectintensity.md

#### PdfTextAnnotationAppearance.BorderEffectIntensity property

Gets or sets border effect intensity. Valid range of value is [0..2].

```csharp
public int BorderEffectIntensity { get; set; }
```

### Contents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/contents.md

#### PdfTextAnnotationAppearance.Contents property

Gets or sets content of annotation object.

```csharp
public string Contents { get; set; }
```

### HCornerRadius
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/hcornerradius.md

#### PdfTextAnnotationAppearance.HCornerRadius property

Gets or sets horizontal corner radius.

```csharp
public int HCornerRadius { get; set; }
```

### PdfTextAnnotationAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/pdftextannotationappearance.md

#### PdfTextAnnotationAppearance()

Creates PDF signature text annotation appearance object.

```csharp
public PdfTextAnnotationAppearance()
```

#### PdfTextAnnotationAppearance(string, string, string)

Creates PDF signature text annotation with specified values (title, subject, contents).

```csharp
public PdfTextAnnotationAppearance(string title, string subject, string contents)
```

| Parameter | Type | Description |
| --- | --- | --- |
| title | String | Title. |
| subject | String | Subject. |
| contents | String | Contents. |

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/subject.md

#### PdfTextAnnotationAppearance.Subject property

Gets or sets Subject representing description of the object.

```csharp
public string Subject { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/title.md

#### PdfTextAnnotationAppearance.Title property

Gets or sets a Title that will be displayed in title bar of annotation object.

```csharp
public string Title { get; set; }
```

### VCornerRadius
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextannotationappearance/vcornerradius.md

#### PdfTextAnnotationAppearance.VCornerRadius property

Gets or sets vertical corner radius.

```csharp
public int VCornerRadius { get; set; }
```

### PdfTextStickerAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance.md

#### PdfTextStickerAppearance class

Describes appearance of PDF text annotation sticker object and pop-up window of sticker.

```csharp
public sealed class PdfTextStickerAppearance : SignatureAppearance
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfTextStickerAppearance() | Creates PDF signature text annotation appearance object. |

#### Properties

| Name | Description |
| --- | --- |
| static DefaultAppearance { get; } | Gets default appearance for sticker. These properties are applied as default if Options.SignatureAppearance property is not specified. The properties could be changed by user any time. |
| Contents { get; set; } | Gets or sets the contents of pop-up window. |
| Icon { get; set; } | Gets or sets the icon of sticker. |
| Opened { get; set; } | Setup if sticker pop-up window will be opened by default. |
| Subject { get; set; } | Gets or sets subject. |
| Title { get; set; } | Gets or sets title of pop-up window. |

#### Methods

| Name | Description |
| --- | --- |
| static ResetDefaultAppearance() | Clears values of default appearance for sticker. |

### Contents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/contents.md

#### PdfTextStickerAppearance.Contents property

Gets or sets the contents of pop-up window.

```csharp
public string Contents { get; set; }
```

### DefaultAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/defaultappearance.md

#### PdfTextStickerAppearance.DefaultAppearance property

Gets default appearance for sticker. These properties are applied as default if Options.SignatureAppearance property is not specified. The properties could be changed by user any time.

```csharp
public static PdfTextStickerAppearance DefaultAppearance { get; }
```

### Icon
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/icon.md

#### PdfTextStickerAppearance.Icon property

Gets or sets the icon of sticker.

```csharp
public PdfTextStickerIcon Icon { get; set; }
```

### Opened
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/opened.md

#### PdfTextStickerAppearance.Opened property

Setup if sticker pop-up window will be opened by default.

```csharp
public bool Opened { get; set; }
```

### PdfTextStickerAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/pdftextstickerappearance.md

#### PdfTextStickerAppearance constructor

Creates PDF signature text annotation appearance object.

```csharp
public PdfTextStickerAppearance()
```

### ResetDefaultAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/resetdefaultappearance.md

#### PdfTextStickerAppearance.ResetDefaultAppearance method

Clears values of default appearance for sticker.

```csharp
public static void ResetDefaultAppearance()
```

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/subject.md

#### PdfTextStickerAppearance.Subject property

Gets or sets subject.

```csharp
public string Subject { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/pdftextstickerappearance/title.md

#### PdfTextStickerAppearance.Title property

Gets or sets title of pop-up window.

```csharp
public string Title { get; set; }
```

### SignatureAppearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.appearances/signatureappearance.md

#### SignatureAppearance class

Represents the signature appearance - additional options for alternative implementations of sign on document page.

```csharp
public abstract class SignatureAppearance
```

### GroupDocs.Signature.Options
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options.md

The namespace provides classes to specify additional options when loading, signing, verifying, searching and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSearchOptions | Represents search options for Barcode signatures. |
| BarcodeSignOptions | Represents the Barcode signature options. |
| BarcodeVerifyOptions | Represents the Barcode verify options. |
| BmpSaveOptions | Bmp Save options for image documents. |
| CertificateSearchOptions | Represents search options for Certificate metadata signatures. |
| CertificateVerifyOptions | Keeps options to verify certificate documents. |
| PreviewOptions.CreateDocPageStream | Delegate that defines method to create output document page preview stream. |
| CreateSignatureStream | Delegate that defines method to create output signature preview stream. |
| DicomSaveOptions | Save options for DICOM image documents. |
| DicomXmpEntry | Entry of XMP data for DICOM images (.dcm). |
| DigitalSearchOptions | Represents search options for Digital signatures. |
| DigitalSignOptions | Represents the Digital signature options. |
| DigitalVerifyOptions | Keeps options to verify document Digital signature. |
| ExportImageSaveOptions | Save options for exporting documents to image. |
| FormFieldSearchOptions | Represents search options for Form-field signatures. |
| FormFieldSignOptions | Represents class of the FormField signature options for Pdf documents. |
| GifSaveOptions | Gif format save options for image documents. |
| ImageDigitalSignOptions | Represents options to embed Aspose.Imaging digital (steganography) signature into raster images. |
| ImageDigitalVerifyOptions | Keeps options to verify digital signatures in raster images. |
| ImageSaveOptions | Save options for image documents. |
| ImageSearchOptions | Represents search options for Image signatures. |
| ImageSignOptions | Represents the Image signature options. |
| JpegSaveOptions | Jpeg Save options for image documents. |
| LoadOptions | Allows to specify additional options (such as password) when opening a document to sign. |
| MetadataSearchOptions | Represents search options for Metadata signatures. |
| MetadataSignOptions | Represents Metadata signature options. |
| PagesSetup | Describes special document pages to work with. |
| PdfSaveOptions | Save options for PDF documents. |
| PdfTextAnnotationVerifyExtensions | Describes extensions of verification of PDF text annotation object |
| PdfTextStickerVerifyExtensions | Describes extensions of verification of PDF sticker object. |
| PngSaveOptions | Png Save options for image documents. |
| PresentationSaveOptions | Save options for Presentation documents. |
| PreviewOptions | Represents document preview options. |
| PreviewPageData | Contains data about document page to be saved as preview image. |
| PreviewSignatureOptions | Represents signature preview options. |
| QrCodeSearchOptions | Represents search options for QR-Code signatures. |
| QrCodeSignOptions | Represents the QR-Code signature options. |
| QrCodeVerifyOptions | Keeps options to verify document QR-code signature. |
| PreviewOptions.ReleaseDocPageStream | Delegate that defines method to release output document page preview stream. |
| ReleaseSignatureStream | Delegate that defines method to release output signature preview stream. |
| SaveOptions | Allows to specify additional options (such as password) when saving a document to sign. |
| SearchOptions | Represents the extract signatures from document options. |
| SignatureContext | Represents the context for a document signature process, encapsulating the signing options. |
| SignOptions | Represents the signature options. |
| SpreadsheetSaveOptions | Save options for Spreadsheet Documents. |
| StampSignOptions | Represents the Stamp signature options. |
| TextSearchOptions | Represents search options for Text signatures. |
| TextSignOptions | Represents the Text signature options. |
| TextVerifyOptions | Keeps options to verify document Text signature. |
| TiffSaveOptions | Tiff Save options for image documents. |
| VerifyExtensions | Keeps additional verification options for alternative implementations of signature on a document page. |
| VerifyOptions | Keeps options to verify document. |
| WordProcessingSaveOptions | Save options for WordProcessing documents. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICustomSignHash | Defines a contract for custom hash signing operations. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| BitmapCompression | Specifies different bitmap compression methods. |
| DicomXmpType | Supported types of XMP data for DICOM images (.dcm). |
| JpegCompressionColorMode | Specifies JPEG color compression modes. |
| JpegCompressionMode | Specifies JPEG compression modes. |
| JpegRoundingMode | Specifies different JPEG rounding modes. |
| Permissions | Specifies configurable permissions for PDF documents, such as printing, content modification, and data extraction. These settings are applicable to PDF format only and control user access and interaction capabilities. |
| PngColorType | Represents the PNG image color type. |
| PngFilterType | Represents PNG image filter type. |
| PreviewOptions.PreviewFormats | Document preview supported formats |
| PreviewSignatureOptions.PreviewFormats | Signature preview supported formats |
| TiffFormat | Specifies different tiff formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### BarcodeSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions.md

#### BarcodeSearchOptions class

Represents search options for Barcode signatures.

```csharp
public class BarcodeSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BarcodeSearchOptions() | Initializes a new instance of the BarcodeSearchOptions class with default values. |
| BarcodeSearchOptions(BarcodeType) | Initializes a new instance of the BarcodeSearchOptions class with encode type value. |
| BarcodeSearchOptions(BarcodeType, string) | Initializes a new instance of the BarcodeSearchOptions class with encode type and text values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| EncodeType { get; set; } | Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types |
| MatchType { get; set; } | Gets or sets Barcode text Match Type search. It is used only when Text property is set. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ReturnContent { get; set; } | Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled. |
| ReturnContentType { get; set; } | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Text { get; set; } | Specifies Barcode Signature text if it should be searched and matched. |

### BarcodeSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/barcodesearchoptions.md

#### BarcodeSearchOptions()

Initializes a new instance of the BarcodeSearchOptions class with default values.

```csharp
public BarcodeSearchOptions()
```

#### BarcodeSearchOptions(BarcodeType)

Initializes a new instance of the BarcodeSearchOptions class with encode type value.

```csharp
public BarcodeSearchOptions(BarcodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type. |

#### BarcodeSearchOptions(BarcodeType, string)

Initializes a new instance of the BarcodeSearchOptions class with encode type and text values.

```csharp
public BarcodeSearchOptions(BarcodeType encodeType, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type. |
| text | String | Set Text of Barcode signature. |

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/encodetype.md

#### BarcodeSearchOptions.EncodeType property

Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types

```csharp
public BarcodeType EncodeType { get; set; }
```

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/matchtype.md

#### BarcodeSearchOptions.MatchType property

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

```csharp
public TextMatchType MatchType { get; set; }
```

### ReturnContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/returncontent.md

#### BarcodeSearchOptions.ReturnContent property

Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled.

```csharp
public bool ReturnContent { get; set; }
```

### ReturnContentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/returncontenttype.md

#### BarcodeSearchOptions.ReturnContentType property

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

```csharp
public FileType ReturnContentType { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesearchoptions/text.md

#### BarcodeSearchOptions.Text property

Specifies Barcode Signature text if it should be searched and matched.

```csharp
public string Text { get; set; }
```

### BarcodeSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions.md

#### BarcodeSignOptions class

Represents the Barcode signature options.

```csharp
public class BarcodeSignOptions : TextSignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BarcodeSignOptions() | Initializes a new instance of the BarcodeSignOptions class with default values. |
| BarcodeSignOptions(string) | Initializes a new instance of the BarcodeSignOptions class with text. |
| BarcodeSignOptions(string, BarcodeType) | Initializes a new instance of the BarcodeSignOptions class with text. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Background { get; set; } | Gets or sets the signature background settings. |
| Border { get; set; } | Specify border settings |
| CodeTextAlignment { get; set; } | Gets or sets the alignment of text in the result Barcode image. Default value is None. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| EncodeType { get; set; } | Gets or sets Barcode type. |
| Extensions { get; } | Signature Extensions. |
| Font { get; set; } | Gets or sets the font of signature. |
| override ForeColor { get; set; } | Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| InnerMargins { get; set; } | Gets or sets the space between Barcode elements and result image borders. |
| Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| Native { get; set; } | Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| ReturnContent { get; set; } | Gets or sets flag to get Barcode image content of a signature which was put on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled. |
| ReturnContentType { get; set; } | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| ShapeType { get; set; } | Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle. |
| SignatureID { get; set; } | Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only. |
| SignatureImplementation { get; set; } | Gets or sets the type of text signature implementation. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| Text { get; set; } | Gets or sets the text of signature. |
| TextHorizontalAlignment { get; set; } | Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see `TextSignatureImplementation` SignatureImplementation property). |
| TextVerticalAlignment { get; set; } | Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see `TextSignatureImplementation` SignatureImplementation property). |
| Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### BarcodeSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/barcodesignoptions.md

#### BarcodeSignOptions()

Initializes a new instance of the BarcodeSignOptions class with default values.

```csharp
public BarcodeSignOptions()
```

#### BarcodeSignOptions(string)

Initializes a new instance of the BarcodeSignOptions class with text.

```csharp
public BarcodeSignOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Barcode text |

#### BarcodeSignOptions(string, BarcodeType)

Initializes a new instance of the BarcodeSignOptions class with text.

```csharp
public BarcodeSignOptions(string text, BarcodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Barcode text |
| encodeType | BarcodeType | Barcode encode type see `BarcodeType` |

### CodeTextAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/codetextalignment.md

#### BarcodeSignOptions.CodeTextAlignment property

Gets or sets the alignment of text in the result Barcode image. Default value is None.

```csharp
public CodeTextAlignment CodeTextAlignment { get; set; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/encodetype.md

#### BarcodeSignOptions.EncodeType property

Gets or sets Barcode type.

```csharp
public BarcodeType EncodeType { get; set; }
```

### ForeColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/forecolor.md

#### BarcodeSignOptions.ForeColor property

Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.

```csharp
public override Color ForeColor { get; set; }
```

### InnerMargins
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/innermargins.md

#### BarcodeSignOptions.InnerMargins property

Gets or sets the space between Barcode elements and result image borders.

```csharp
public Padding InnerMargins { get; set; }
```

### ReturnContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/returncontent.md

#### BarcodeSignOptions.ReturnContent property

Gets or sets flag to get Barcode image content of a signature which was put on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled.

```csharp
public bool ReturnContent { get; set; }
```

### ReturnContentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodesignoptions/returncontenttype.md

#### BarcodeSignOptions.ReturnContentType property

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

```csharp
public FileType ReturnContentType { get; set; }
```

### BarcodeVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodeverifyoptions.md

#### BarcodeVerifyOptions class

Represents the Barcode verify options.

```csharp
public class BarcodeVerifyOptions : TextVerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BarcodeVerifyOptions() | Creates default Verification Option for Barcode Signature. |
| BarcodeVerifyOptions(BarcodeType) | Creates default Verification Option with Barcode Type verification |
| BarcodeVerifyOptions(string) | Creates default Verification Option with verification text |
| BarcodeVerifyOptions(string, BarcodeType) | Creates default Verification Option with Barcode Type verification and text |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| EncodeType { get; set; } | Gets or sets Barcode Type verification. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields. |
| IsValid { get; } | Valid property flag. |
| MatchType { get; set; } | Gets or sets Text Match Type verification. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| SignatureID { get; set; } | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |
| SignatureImplementation { get; set; } | Type of Signature to be verified. |
| Text { get; set; } | Specify Signature Text if it should be verified. |

### BarcodeVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodeverifyoptions/barcodeverifyoptions.md

#### BarcodeVerifyOptions()

Creates default Verification Option for Barcode Signature.

```csharp
public BarcodeVerifyOptions()
```

#### BarcodeVerifyOptions(string)

Creates default Verification Option with verification text

```csharp
public BarcodeVerifyOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Barcode text to verify |

#### BarcodeVerifyOptions(BarcodeType)

Creates default Verification Option with Barcode Type verification

```csharp
public BarcodeVerifyOptions(BarcodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Barcode Type verification |

#### BarcodeVerifyOptions(string, BarcodeType)

Creates default Verification Option with Barcode Type verification and text

```csharp
public BarcodeVerifyOptions(string text, BarcodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Barcode text to verify |
| encodeType | BarcodeType | Barcode Type verification |

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/barcodeverifyoptions/encodetype.md

#### BarcodeVerifyOptions.EncodeType property

Gets or sets Barcode Type verification.

```csharp
public BarcodeType EncodeType { get; set; }
```

### BitmapCompression
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bitmapcompression.md

#### BitmapCompression enumeration

Specifies different bitmap compression methods.

```csharp
public enum BitmapCompression
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Rgb | `0` | No compression. |
| Rle8 | `1` | RLE 8-bit/pixel compression. Can be used only with 8-bit/pixel bitmaps. |
| Rle4 | `2` | RLE 4-bit/pixel compression. Can be used only with 4-bit/pixel bitmaps. |
| Bitfields | `3` | Bit fields. Can be used only with 16 and 32-bit/pixel bitmaps. |
| Jpeg | `4` | JPEG compression. The bitmap contains a JPEG image. |
| Png | `5` | PNG compression. The bitmap contains a PNG image. |

### BmpSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions.md

#### BmpSaveOptions class

Bmp Save options for image documents.

```csharp
public sealed class BmpSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| BmpSaveOptions() | Creates BmpSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| BitsPerPixel { get; set; } | Gets or sets the image bits per pixel count. |
| Compression { get; set; } | Gets or sets the compression. See `BitmapCompression`. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| HorizontalResolution { get; set; } | Gets or sets the horizontal resolution. Note due to the rounding the resulting resolution may slightly differ from the passed. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |
| VerticalResolution { get; set; } | Gets or sets the vertical resolution. Note due to the rounding the resulting resolution may slightly differ from the passed. |

### BitsPerPixel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions/bitsperpixel.md

#### BmpSaveOptions.BitsPerPixel property

Gets or sets the image bits per pixel count.

```csharp
public int BitsPerPixel { get; set; }
```

### BmpSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions/bmpsaveoptions.md

#### BmpSaveOptions constructor

Creates BmpSaveOptions with default values.

```csharp
public BmpSaveOptions()
```

### Compression
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions/compression.md

#### BmpSaveOptions.Compression property

Gets or sets the compression. See `BitmapCompression`.

```csharp
public BitmapCompression Compression { get; set; }
```

### HorizontalResolution
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions/horizontalresolution.md

#### BmpSaveOptions.HorizontalResolution property

Gets or sets the horizontal resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

```csharp
public double HorizontalResolution { get; set; }
```

### VerticalResolution
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/bmpsaveoptions/verticalresolution.md

#### BmpSaveOptions.VerticalResolution property

Gets or sets the vertical resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

```csharp
public double VerticalResolution { get; set; }
```

### CertificateSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificatesearchoptions.md

#### CertificateSearchOptions class

Represents search options for Certificate metadata signatures.

```csharp
public class CertificateSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CertificateSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values. |
| CertificateSearchOptions(string) | Initializes a new instance of the TextSearchOptions class with text value. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| MatchType { get; set; } | Gets or sets text match type search. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Text { get; set; } | Specifies certificate property text to match on searching. |

### CertificateSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificatesearchoptions/certificatesearchoptions.md

#### CertificateSearchOptions()

Initializes a new instance of the TextSearchOptions class with default values.

```csharp
public CertificateSearchOptions()
```

#### CertificateSearchOptions(string)

Initializes a new instance of the TextSearchOptions class with text value.

```csharp
public CertificateSearchOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Set Text of Text signature. |

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificatesearchoptions/matchtype.md

#### CertificateSearchOptions.MatchType property

Gets or sets text match type search.

```csharp
public TextMatchType MatchType { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificatesearchoptions/text.md

#### CertificateSearchOptions.Text property

Specifies certificate property text to match on searching.

```csharp
public string Text { get; set; }
```

### CertificateVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions.md

#### CertificateVerifyOptions class

Keeps options to verify certificate documents.

```csharp
public class CertificateVerifyOptions : VerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| CertificateVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values. |
| CertificateVerifyOptions(string) | Initializes a new instance of the CertificateVerifyOptions with subject to verify. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| Expired { get; } | Indicates if certificate is expired date due validation result. Property is read-only. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| Issuer { get; set; } | Specify Certificate Issuer if it should be verified. |
| IsValid { get; } | Valid property flag. |
| MatchType { get; set; } | Gets or sets Text Match Type verification. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| PerformChainValidation { get; set; } | Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true. |
| SerialNumber { get; set; } | Specify Certificate Serial Number if it should be verified. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| Subject { get; set; } | Specify Certificate subject if it should be verified. |
| Thumbprint { get; set; } | Specify Certificate Thumbprint if it should be verified. |

### CertificateVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/certificateverifyoptions.md

#### CertificateVerifyOptions()

Initializes a new instance of the TextVerifyOptions with default values.

```csharp
public CertificateVerifyOptions()
```

#### CertificateVerifyOptions(string)

Initializes a new instance of the CertificateVerifyOptions with subject to verify.

```csharp
public CertificateVerifyOptions(string subject)
```

| Parameter | Type | Description |
| --- | --- | --- |
| subject | String | Subject to be verified |

### Expired
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/expired.md

#### CertificateVerifyOptions.Expired property

Indicates if certificate is expired date due validation result. Property is read-only.

```csharp
public bool Expired { get; }
```

### Issuer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/issuer.md

#### CertificateVerifyOptions.Issuer property

Specify Certificate Issuer if it should be verified.

```csharp
public string Issuer { get; set; }
```

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/matchtype.md

#### CertificateVerifyOptions.MatchType property

Gets or sets Text Match Type verification.

```csharp
public TextMatchType MatchType { get; set; }
```

### PerformChainValidation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/performchainvalidation.md

#### CertificateVerifyOptions.PerformChainValidation property

Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true.

```csharp
public bool PerformChainValidation { get; set; }
```

### SerialNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/serialnumber.md

#### CertificateVerifyOptions.SerialNumber property

Specify Certificate Serial Number if it should be verified.

```csharp
public string SerialNumber { get; set; }
```

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/subject.md

#### CertificateVerifyOptions.Subject property

Specify Certificate subject if it should be verified.

```csharp
public string Subject { get; set; }
```

### Thumbprint
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/certificateverifyoptions/thumbprint.md

#### CertificateVerifyOptions.Thumbprint property

Specify Certificate Thumbprint if it should be verified.

```csharp
public string Thumbprint { get; set; }
```

### CreateSignatureStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/createsignaturestream.md

#### CreateSignatureStream delegate

Delegate that defines method to create output signature preview stream.

```csharp
public delegate Stream CreateSignatureStream(PreviewSignatureOptions previewOptions);
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewSignatureOptions | The number of previewed signature image. |

### DicomSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomsaveoptions.md

#### DicomSaveOptions class

Save options for DICOM image documents.

```csharp
public sealed class DicomSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DicomSaveOptions() | Creates DicomSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |
| XmpEntries { get; set; } | XMP data for DICOM. Use it for setting image metadata. |

### DicomSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomsaveoptions/dicomsaveoptions.md

#### DicomSaveOptions constructor

Creates DicomSaveOptions with default values.

```csharp
public DicomSaveOptions()
```

### XmpEntries
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomsaveoptions/xmpentries.md

#### DicomSaveOptions.XmpEntries property

XMP data for DICOM. Use it for setting image metadata.

```csharp
public List<DicomXmpEntry> XmpEntries { get; set; }
```

### DicomXmpEntry
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmpentry.md

#### DicomXmpEntry class

Entry of XMP data for DICOM images (.dcm).

```csharp
public sealed class DicomXmpEntry
```

#### Constructors

| Name | Description |
| --- | --- |
| DicomXmpEntry(DicomXmpType, string) | Creates Xmp entry for DICOM image. |

#### Properties

| Name | Description |
| --- | --- |
| Type { get; } | Entry type. |
| Value { get; } | Entry value. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Get Xmp entry textual representation. |

### DicomXmpEntry
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmpentry/dicomxmpentry.md

#### DicomXmpEntry constructor

Creates Xmp entry for DICOM image.

```csharp
public DicomXmpEntry(DicomXmpType type, string value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| type | DicomXmpType | Entry type |
| value | String | Entry value |

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmpentry/tostring.md

#### DicomXmpEntry.ToString method

Get Xmp entry textual representation.

```csharp
public override string ToString()
```

##### Return Value

Xmp entry textual representation.

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmpentry/type.md

#### DicomXmpEntry.Type property

Entry type.

```csharp
public DicomXmpType Type { get; }
```

### Value
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmpentry/value.md

#### DicomXmpEntry.Value property

Entry value.

```csharp
public string Value { get; }
```

### DicomXmpType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/dicomxmptype.md

#### DicomXmpType enumeration

Supported types of XMP data for DICOM images (.dcm).

```csharp
public enum DicomXmpType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| EquipmentInstitution | `0` | Institution of equipment. |
| EquipmentManufacturer | `1` | Manufacturer of equipment. |
| PatientBirthDate | `2` | Patient's birthday. |
| PatientId | `3` | Patient's Id. |
| PatientName | `4` | Patient's name. |
| PatientSex | `5` | Patient's sex. |
| SeriesDateTime | `6` | Series date and time. |
| SeriesDescription | `7` | Series description. |
| SeriesModality | `8` | Series modality. |
| SeriesNumber | `9` | Series number. |
| StudyDateTime | `10` | Study date and time. |
| StudyDescription | `11` | Study description. |
| StudyId | `12` | Study Id. |
| StudyPhysician | `13` | Study physician. |

### DigitalSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions.md

#### DigitalSearchOptions class

Represents search options for Digital signatures.

```csharp
public class DigitalSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalSearchOptions() | Initializes a new instance of the DigitalSearchOptions class with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| Comments { get; set; } | Comments of Digital signature to search. |
| IssuerName { get; set; } | For non empty values specifies distinguished name of the certificate issuer to search. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SignDateTimeFrom { get; set; } | Date and time range of Digital signature to search. Nullable value will be ignored. |
| SignDateTimeTo { get; set; } | Date and time range of Digital signature to search. Nullable value will be ignored. |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| SubjectName { get; set; } | For non empty values specifies distinguished subject name of the certificate to search. |

### Comments
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/comments.md

#### DigitalSearchOptions.Comments property

Comments of Digital signature to search.

```csharp
public string Comments { get; set; }
```

### DigitalSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/digitalsearchoptions.md

#### DigitalSearchOptions constructor

Initializes a new instance of the DigitalSearchOptions class with default values.

```csharp
public DigitalSearchOptions()
```

### IssuerName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/issuername.md

#### DigitalSearchOptions.IssuerName property

For non empty values specifies distinguished name of the certificate issuer to search.

```csharp
public string IssuerName { get; set; }
```

### SignDateTimeFrom
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/signdatetimefrom.md

#### DigitalSearchOptions.SignDateTimeFrom property

Date and time range of Digital signature to search. Nullable value will be ignored.

```csharp
public DateTime? SignDateTimeFrom { get; set; }
```

### SignDateTimeTo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/signdatetimeto.md

#### DigitalSearchOptions.SignDateTimeTo property

Date and time range of Digital signature to search. Nullable value will be ignored.

```csharp
public DateTime? SignDateTimeTo { get; set; }
```

### SubjectName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsearchoptions/subjectname.md

#### DigitalSearchOptions.SubjectName property

For non empty values specifies distinguished subject name of the certificate to search.

```csharp
public string SubjectName { get; set; }
```

### DigitalSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions.md

#### DigitalSignOptions class

Represents the Digital signature options.

```csharp
public class DigitalSignOptions : ImageSignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalSignOptions() | Initializes a new instance of the DigitalSignOptions class with default values. |
| DigitalSignOptions(Stream) | Initializes a new instance of the DigitalSignOptions class with certificate stream. |
| DigitalSignOptions(string) | Initializes a new instance of the DigitalSignOptions class with certificate file. |
| DigitalSignOptions(Stream, Stream) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream. |
| DigitalSignOptions(Stream, string) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file. |
| DigitalSignOptions(string, Stream) | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream. |
| DigitalSignOptions(string, string) | Initializes a new instance of the DigitalSignOptions class with certificate file and image file. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Border { get; set; } | Specify border settings |
| CertificateFilePath { get; set; } | Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified. |
| CertificateStream { get; set; } | Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateFilePath. |
| Contact { get; set; } | Gets or sets the signature contact. |
| CustomSignHash { get; set; } | Gets or sets a custom hash signing function, allowing users to implement their own digital signing logic. This enables signing with external certificates and supports different hash algorithms. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| ImageFilePath { get; set; } | Gets or sets the signature image file path. This property is used only if ImageStream is not specified. |
| ImageStream { get; set; } | Gets or sets the signature image stream. If this property is specified it is always used instead ImageFilePath. |
| virtual Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if horizontal alignment is not specified). |
| Location { get; set; } | Gets or sets the signature location. |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Password { get; set; } | Gets or sets the password of digital certificate. |
| Reason { get; set; } | Gets or sets the reason of signature. |
| Rectangle { get; } | Rectangle of area to put the image on document. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| Signature { get; set; } | Gets or sets properties of document digital signature. For signing Pdf documents it is possible to set advanced properties by using instance of `PdfDigitalSignature` |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| virtual Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| UseLtv { get; set; } | Gets/sets ltv(Long Term Validation) validation flag. |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Visible { get; set; } | Gets or sets the visibility of signature. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| XAdESType { get; set; } | XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents. |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Clears internal resources |

### CertificateFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/certificatefilepath.md

#### DigitalSignOptions.CertificateFilePath property

Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified.

```csharp
public string CertificateFilePath { get; set; }
```

### CertificateStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/certificatestream.md

#### DigitalSignOptions.CertificateStream property

Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateFilePath.

```csharp
public Stream CertificateStream { get; set; }
```

### Contact
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/contact.md

#### DigitalSignOptions.Contact property

Gets or sets the signature contact.

```csharp
public string Contact { get; set; }
```

### CustomSignHash
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/customsignhash.md

#### DigitalSignOptions.CustomSignHash property

Gets or sets a custom hash signing function, allowing users to implement their own digital signing logic. This enables signing with external certificates and supports different hash algorithms.

```csharp
public ICustomSignHash CustomSignHash { get; set; }
```

### DigitalSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/digitalsignoptions.md

#### DigitalSignOptions()

Initializes a new instance of the DigitalSignOptions class with default values.

```csharp
public DigitalSignOptions()
```

#### DigitalSignOptions(string)

Initializes a new instance of the DigitalSignOptions class with certificate file.

```csharp
public DigitalSignOptions(string certificateFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | String | Digital certificate file path |

#### DigitalSignOptions(Stream)

Initializes a new instance of the DigitalSignOptions class with certificate stream.

```csharp
public DigitalSignOptions(Stream certificateStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | Stream | Digital Certificate stream |

#### DigitalSignOptions(string, string)

Initializes a new instance of the DigitalSignOptions class with certificate file and image file.

```csharp
public DigitalSignOptions(string certificateFilePath, string imageFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | String | Digital certificate file path |
| imageFilePath | String | Signature Appearance image file path |

#### DigitalSignOptions(string, Stream)

Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.

```csharp
public DigitalSignOptions(string certificateFilePath, Stream appearenceImageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | String | Digital certificate file path |
| appearenceImageStream | Stream | Signature Appearance image stream |

#### DigitalSignOptions(Stream, string)

Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.

```csharp
public DigitalSignOptions(Stream certificateStream, string imageFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | Stream | Digital Certificate stream |
| imageFilePath | String | Signature Appearance image file path |

#### DigitalSignOptions(Stream, Stream)

Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

```csharp
public DigitalSignOptions(Stream certificateStream, Stream appearenceImageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | Stream | Digital Certificate stream |
| appearenceImageStream | Stream | Signature Appearance image stream |

### Location
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/location.md

#### DigitalSignOptions.Location property

Gets or sets the signature location.

```csharp
public string Location { get; set; }
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/password.md

#### DigitalSignOptions.Password property

Gets or sets the password of digital certificate.

```csharp
public string Password { get; set; }
```

### Reason
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/reason.md

#### DigitalSignOptions.Reason property

Gets or sets the reason of signature.

```csharp
public string Reason { get; set; }
```

### Signature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/signature.md

#### DigitalSignOptions.Signature property

Gets or sets properties of document digital signature. For signing Pdf documents it is possible to set advanced properties by using instance of `PdfDigitalSignature`

```csharp
public DigitalSignature Signature { get; set; }
```

### UseLtv
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/useltv.md

#### DigitalSignOptions.UseLtv property

Gets/sets ltv(Long Term Validation) validation flag.

```csharp
public bool UseLtv { get; set; }
```

### Visible
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/visible.md

#### DigitalSignOptions.Visible property

Gets or sets the visibility of signature.

```csharp
public bool Visible { get; set; }
```

### XAdESType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalsignoptions/xadestype.md

#### DigitalSignOptions.XAdESType property

XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

```csharp
public XAdESType XAdESType { get; set; }
```

### DigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions.md

#### DigitalVerifyOptions class

Keeps options to verify document Digital signature.

```csharp
public class DigitalVerifyOptions : VerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DigitalVerifyOptions() | Creates Digital Verification Option with default values. |
| DigitalVerifyOptions(Stream) | Creates Digital Verification Option with given certificate stream. |
| DigitalVerifyOptions(string) | Creates Digital Verification Option with given digital certificate file path. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| Certificate { get; } | Get X509Certificate2 Certificate from Certificate FilePath or Stream. |
| CertificateFilePath { get; set; } | File path of Digital Certificate. |
| CertificateStream { get; set; } | Stream of Digital Certificate. |
| Comments { get; set; } | Comments of Digital Signature to validate. |
| Contact { get; set; } | Signature Contact to validate. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| IssuerName { get; set; } | Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature's issuer name contains or equals passed value |
| IsValid { get; } | Valid property flag. |
| Location { get; set; } | Signature Location to validate. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| Password { get; set; } | Password of Digital Certificate if required. |
| Reason { get; set; } | Reason of Digital Signature to validate. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| SignDateTimeFrom { get; set; } | Date and time range of Digital Signature to validate. Nullable value will be ignored. |
| SignDateTimeTo { get; set; } | Date and time range of Digital Signature to validate. Nullable value will be ignored. |
| SubjectName { get; set; } | Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value |

### Certificate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/certificate.md

#### DigitalVerifyOptions.Certificate property

Get X509Certificate2 Certificate from Certificate FilePath or Stream.

```csharp
public X509Certificate2 Certificate { get; }
```

### CertificateFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/certificatefilepath.md

#### DigitalVerifyOptions.CertificateFilePath property

File path of Digital Certificate.

```csharp
public string CertificateFilePath { get; set; }
```

### CertificateStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/certificatestream.md

#### DigitalVerifyOptions.CertificateStream property

Stream of Digital Certificate.

```csharp
public Stream CertificateStream { get; set; }
```

### Comments
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/comments.md

#### DigitalVerifyOptions.Comments property

Comments of Digital Signature to validate.

```csharp
public string Comments { get; set; }
```

### Contact
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/contact.md

#### DigitalVerifyOptions.Contact property

Signature Contact to validate.

```csharp
public string Contact { get; set; }
```

### DigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/digitalverifyoptions.md

#### DigitalVerifyOptions()

Creates Digital Verification Option with default values.

```csharp
public DigitalVerifyOptions()
```

#### DigitalVerifyOptions(string)

Creates Digital Verification Option with given digital certificate file path.

```csharp
public DigitalVerifyOptions(string certificateFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | String | File path to digital certificate. |

#### DigitalVerifyOptions(Stream)

Creates Digital Verification Option with given certificate stream.

```csharp
public DigitalVerifyOptions(Stream certificateStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | Stream | Certificate's stream. |

### IssuerName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/issuername.md

#### DigitalVerifyOptions.IssuerName property

Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature's issuer name contains or equals passed value

```csharp
public string IssuerName { get; set; }
```

### Location
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/location.md

#### DigitalVerifyOptions.Location property

Signature Location to validate.

```csharp
public string Location { get; set; }
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/password.md

#### DigitalVerifyOptions.Password property

Password of Digital Certificate if required.

```csharp
public string Password { get; set; }
```

### Reason
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/reason.md

#### DigitalVerifyOptions.Reason property

Reason of Digital Signature to validate.

```csharp
public string Reason { get; set; }
```

### SignDateTimeFrom
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/signdatetimefrom.md

#### DigitalVerifyOptions.SignDateTimeFrom property

Date and time range of Digital Signature to validate. Nullable value will be ignored.

```csharp
public DateTime? SignDateTimeFrom { get; set; }
```

### SignDateTimeTo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/signdatetimeto.md

#### DigitalVerifyOptions.SignDateTimeTo property

Date and time range of Digital Signature to validate. Nullable value will be ignored.

```csharp
public DateTime? SignDateTimeTo { get; set; }
```

### SubjectName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/digitalverifyoptions/subjectname.md

#### DigitalVerifyOptions.SubjectName property

Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value

```csharp
public string SubjectName { get; set; }
```

### ExportImageSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions.md

#### ExportImageSaveOptions class

Save options for exporting documents to image.

```csharp
public class ExportImageSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ExportImageSaveOptions() | Initializes a new instance of ExportAsImageSaveOptions class with default values. |
| ExportImageSaveOptions(ImageSaveFileFormat) | Initializes a new instance of ExportAsImageSaveOptions class with specified file format. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| Border { get; set; } | Gets or sets the image border settings. By default this value is not set. |
| ExportAllPages { get; set; } | Flag to export each page. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| PageColumns { get; set; } | Gets or sets number of columns for exported images. Use this property if you need put images in a row. |
| PageNumber { get; set; } | Gets or sets document page number for export. Minimal value is 1. |
| PagesSetup { get; set; } | Options to specify pages to be signed. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| TiffMultipage { get; set; } | Put document pages on different frames in Tiff image. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/border.md

#### ExportImageSaveOptions.Border property

Gets or sets the image border settings. By default this value is not set.

```csharp
public Border Border { get; set; }
```

### ExportAllPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/exportallpages.md

#### ExportImageSaveOptions.ExportAllPages property

Flag to export each page.

```csharp
public bool ExportAllPages { get; set; }
```

### ExportImageSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/exportimagesaveoptions.md

#### ExportImageSaveOptions()

Initializes a new instance of ExportAsImageSaveOptions class with default values.

```csharp
public ExportImageSaveOptions()
```

#### ExportImageSaveOptions(ImageSaveFileFormat)

Initializes a new instance of ExportAsImageSaveOptions class with specified file format.

```csharp
public ExportImageSaveOptions(ImageSaveFileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | ImageSaveFileFormat | Output image file format. |

### PageColumns
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/pagecolumns.md

#### ExportImageSaveOptions.PageColumns property

Gets or sets number of columns for exported images. Use this property if you need put images in a row.

```csharp
public int PageColumns { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/pagenumber.md

#### ExportImageSaveOptions.PageNumber property

Gets or sets document page number for export. Minimal value is 1.

```csharp
public int? PageNumber { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/pagessetup.md

#### ExportImageSaveOptions.PagesSetup property

Options to specify pages to be signed.

```csharp
public PagesSetup PagesSetup { get; set; }
```

### TiffMultipage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/exportimagesaveoptions/tiffmultipage.md

#### ExportImageSaveOptions.TiffMultipage property

Put document pages on different frames in Tiff image.

```csharp
public bool TiffMultipage { get; set; }
```

### FormFieldSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsearchoptions.md

#### FormFieldSearchOptions class

Represents search options for Form-field signatures.

```csharp
public class FormFieldSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FormFieldSearchOptions() | Initializes a new instance of the FormFieldSearchOptions class with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| Name { get; set; } | Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as "text" or regular expression like "abc\d+". Default value is empty string. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Type { get; set; } | Specifies type of form field signature if it should be searched. Default value is null. |
| Value { get; set; } | Specifies value of form field signature if it should be searched. Default value is null. |

### FormFieldSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsearchoptions/formfieldsearchoptions.md

#### FormFieldSearchOptions constructor

Initializes a new instance of the FormFieldSearchOptions class with default values.

```csharp
public FormFieldSearchOptions()
```

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsearchoptions/name.md

#### FormFieldSearchOptions.Name property

Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as "text" or regular expression like "abc\d+". Default value is empty string.

```csharp
public string Name { get; set; }
```

### Type
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsearchoptions/type.md

#### FormFieldSearchOptions.Type property

Specifies type of form field signature if it should be searched. Default value is null.

```csharp
public FormFieldType? Type { get; set; }
```

### Value
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsearchoptions/value.md

#### FormFieldSearchOptions.Value property

Specifies value of form field signature if it should be searched. Default value is null.

```csharp
public object Value { get; set; }
```

### FormFieldSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsignoptions.md

#### FormFieldSignOptions class

Represents class of the FormField signature options for Pdf documents.

```csharp
public sealed class FormFieldSignOptions : TextSignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| FormFieldSignOptions() | Initializes a new instance of the PdfFormFieldSignOptions class with default values. |
| FormFieldSignOptions(FormFieldSignature) | Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Background { get; set; } | Gets or sets the signature background settings. |
| Border { get; set; } | Specify border settings |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| Font { get; set; } | Gets or sets the font of signature. |
| virtual ForeColor { get; set; } | Gets or sets the fore color of signature. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| Native { get; set; } | Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| ShapeType { get; set; } | Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle. |
| Signature { get; set; } | Gets or sets the FormField of signature. |
| SignatureID { get; set; } | Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only. |
| SignatureImplementation { get; set; } | Gets or sets the type of text signature implementation. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| Text { get; set; } | Gets or sets the text of signature. |
| TextHorizontalAlignment { get; set; } | Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see `TextSignatureImplementation` SignatureImplementation property). |
| TextVerticalAlignment { get; set; } | Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see `TextSignatureImplementation` SignatureImplementation property). |
| Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### FormFieldSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsignoptions/formfieldsignoptions.md

#### FormFieldSignOptions()

Initializes a new instance of the PdfFormFieldSignOptions class with default values.

```csharp
public FormFieldSignOptions()
```

#### FormFieldSignOptions(FormFieldSignature)

Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature.

```csharp
public FormFieldSignOptions(FormFieldSignature signature)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | FormFieldSignature | Form Field signature object |

### Signature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/formfieldsignoptions/signature.md

#### FormFieldSignOptions.Signature property

Gets or sets the FormField of signature.

```csharp
public FormFieldSignature Signature { get; set; }
```

### GifSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions.md

#### GifSaveOptions class

Gif format save options for image documents.

```csharp
public sealed class GifSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GifSaveOptions() | Creates GifSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| BackgroundColorIndex { get; set; } | Gets or sets the GIF background color index. |
| ColorResolution { get; set; } | Gets or sets the GIF color resolution. |
| DoPaletteCorrection { get; set; } | Gets or sets a value indicating whether palette correction is applied. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| HasTrailer { get; set; } | Gets or sets a value indicating whether GIF has trailer. |
| Interlaced { get; set; } | True if image should be interlaced. |
| IsPaletteSorted { get; set; } | Gets or sets a value indicating whether palette entries are sorted. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| PixelAspectRatio { get; set; } | Gets or sets the GIF pixel aspect ratio. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### BackgroundColorIndex
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/backgroundcolorindex.md

#### GifSaveOptions.BackgroundColorIndex property

Gets or sets the GIF background color index.

```csharp
public byte BackgroundColorIndex { get; set; }
```

### ColorResolution
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/colorresolution.md

#### GifSaveOptions.ColorResolution property

Gets or sets the GIF color resolution.

```csharp
public byte ColorResolution { get; set; }
```

##### Remarks

Color Resolution - Number of bits per primary color available to the original image, minus 1. This value represents the size of the entire palette from which the colors in the graphic were selected, not the number of colors actually used in the graphic. For example, if the value in this field is 3, then the palette of the original image had 4 bits per primary color available to create the image. This value should be set to indicate the richness of the original palette, even if not every color from the whole palette is available on the source machine.

### DoPaletteCorrection
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/dopalettecorrection.md

#### GifSaveOptions.DoPaletteCorrection property

Gets or sets a value indicating whether palette correction is applied.

```csharp
public bool DoPaletteCorrection { get; set; }
```

##### Remarks

Palette correction means that whenever image is exported to GIF the source image colors will be analyzed in order to build the best matching palette (in case image Palette does not exist or not specified in the options). The analyze process takes some time however the output image will have the best matching color palette and result is visually better.

### GifSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/gifsaveoptions.md

#### GifSaveOptions constructor

Creates GifSaveOptions with default values.

```csharp
public GifSaveOptions()
```

### HasTrailer
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/hastrailer.md

#### GifSaveOptions.HasTrailer property

Gets or sets a value indicating whether GIF has trailer.

```csharp
public bool HasTrailer { get; set; }
```

### Interlaced
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/interlaced.md

#### GifSaveOptions.Interlaced property

True if image should be interlaced.

```csharp
public bool Interlaced { get; set; }
```

### IsPaletteSorted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/ispalettesorted.md

#### GifSaveOptions.IsPaletteSorted property

Gets or sets a value indicating whether palette entries are sorted.

```csharp
public bool IsPaletteSorted { get; set; }
```

### PixelAspectRatio
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/gifsaveoptions/pixelaspectratio.md

#### GifSaveOptions.PixelAspectRatio property

Gets or sets the GIF pixel aspect ratio.

```csharp
public byte PixelAspectRatio { get; set; }
```

##### Remarks

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect ratio of the pixel in the original image. If the value of the field is not 0, this approximation of the aspect ratio is computed based on the formula: Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined to be the quotient of the pixel's width over its height. The value range in this field allows specification of the widest pixel of 4:1 to the tallest pixel of 1:4 in increments of 1/64th. Values : 0 - No aspect ratio information is given. 1..255 - Value used in the computation.

### ICustomSignHash
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/icustomsignhash.md

#### ICustomSignHash interface

Defines a contract for custom hash signing operations.

```csharp
public interface ICustomSignHash
```

#### Methods

| Name | Description |
| --- | --- |
| CustomSignHash(byte[], HashAlgorithm, SignatureContext) | Signs the given hash using a custom signing implementation. |

### CustomSignHash
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/icustomsignhash/customsignhash.md

#### ICustomSignHash.CustomSignHash method

Signs the given hash using a custom signing implementation.

```csharp
public byte[] CustomSignHash(byte[] signableHash, HashAlgorithm hashAlgorithm, 
    SignatureContext signatureContext)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signableHash | Byte[] | The hash value to be signed. |
| hashAlgorithm | HashAlgorithm | The hash algorithm used to generate the hash. |
| signatureContext | SignatureContext | The context providing additional signature-related options. |

##### Return Value

The signed hash as a byte array.

### ImageDigitalSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalsignoptions.md

#### ImageDigitalSignOptions class

Represents options to embed Aspose.Imaging digital (steganography) signature into raster images.

```csharp
public class ImageDigitalSignOptions : SignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageDigitalSignOptions() | Initializes a new instance of the ImageDigitalSignOptions class with default values. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Password { get; set; } | Password used for embedding the digital signature. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### ImageDigitalSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalsignoptions/imagedigitalsignoptions.md

#### ImageDigitalSignOptions constructor

Initializes a new instance of the ImageDigitalSignOptions class with default values.

```csharp
public ImageDigitalSignOptions()
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalsignoptions/password.md

#### ImageDigitalSignOptions.Password property

Password used for embedding the digital signature.

```csharp
public string Password { get; set; }
```

### ImageDigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions.md

#### ImageDigitalVerifyOptions class

Keeps options to verify digital signatures in raster images.

```csharp
public class ImageDigitalVerifyOptions : VerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageDigitalVerifyOptions() | Initializes a new instance of the ImageDigitalVerifyOptions class for verifying digital (steganography) signatures in raster images. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| DetectedProbability { get; } | Stores the probability returned by AnalyzePercentageDigitalSignature (0-100). |
| DetectionThresholdPercent { get; set; } | Detection threshold percentage for partial extraction (0-100). Default is 75. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| IsValid { get; } | Valid property flag. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| Password { get; set; } | Password that was used to embed the signature. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| UseFullDataExtraction { get; set; } | When true, performs full data extraction (AnalyzePercentageDigitalSignature) for maximum accuracy. |

### DetectedProbability
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions/detectedprobability.md

#### ImageDigitalVerifyOptions.DetectedProbability property

Stores the probability returned by AnalyzePercentageDigitalSignature (0-100).

```csharp
public int? DetectedProbability { get; }
```

### DetectionThresholdPercent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions/detectionthresholdpercent.md

#### ImageDigitalVerifyOptions.DetectionThresholdPercent property

Detection threshold percentage for partial extraction (0-100). Default is 75.

```csharp
public int DetectionThresholdPercent { get; set; }
```

### ImageDigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions/imagedigitalverifyoptions.md

#### ImageDigitalVerifyOptions constructor

Initializes a new instance of the ImageDigitalVerifyOptions class for verifying digital (steganography) signatures in raster images.

```csharp
public ImageDigitalVerifyOptions()
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions/password.md

#### ImageDigitalVerifyOptions.Password property

Password that was used to embed the signature.

```csharp
public string Password { get; set; }
```

### UseFullDataExtraction
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagedigitalverifyoptions/usefulldataextraction.md

#### ImageDigitalVerifyOptions.UseFullDataExtraction property

When true, performs full data extraction (AnalyzePercentageDigitalSignature) for maximum accuracy.

```csharp
public bool UseFullDataExtraction { get; set; }
```

### ImageSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesaveoptions.md

#### ImageSaveOptions class

Save options for image documents.

```csharp
public class ImageSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSaveOptions() | Initializes a new instance of ImagesSaveOptions class with default values. |
| ImageSaveOptions(bool) | Initializes a new instance of ImagesSaveOptions class with overwrite flag. |
| ImageSaveOptions(ImageSaveFileFormat, bool) | Initializes a new instance of ImagesSaveOptions class with specified output type and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesaveoptions/fileformat.md

#### ImageSaveOptions.FileFormat property

Gets or sets file format of signed document.

```csharp
public ImageSaveFileFormat FileFormat { get; set; }
```

### ImageSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesaveoptions/imagesaveoptions.md

#### ImageSaveOptions()

Initializes a new instance of ImagesSaveOptions class with default values.

```csharp
public ImageSaveOptions()
```

#### ImageSaveOptions(bool)

Initializes a new instance of ImagesSaveOptions class with overwrite flag.

```csharp
public ImageSaveOptions(bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

#### ImageSaveOptions(ImageSaveFileFormat, bool)

Initializes a new instance of ImagesSaveOptions class with specified output type and overwrite flag.

```csharp
public ImageSaveOptions(ImageSaveFileFormat fileFormat, bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | ImageSaveFileFormat | Output file type `ImageSaveFileFormat`. |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### ImageSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions.md

#### ImageSearchOptions class

Represents search options for Image signatures.

```csharp
public class ImageSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSearchOptions() | Initializes a new instance of the ImageSearchOptions class with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| MaxContentSize { get; set; } | For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result. |
| MinContentSize { get; set; } | For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ReturnContent { get; set; } | Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format `ReturnContentType`. By default this option is disabled. |
| ReturnContentType { get; set; } | Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |

### ImageSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions/imagesearchoptions.md

#### ImageSearchOptions constructor

Initializes a new instance of the ImageSearchOptions class with default values.

```csharp
public ImageSearchOptions()
```

### MaxContentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions/maxcontentsize.md

#### ImageSearchOptions.MaxContentSize property

For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result.

```csharp
public long MaxContentSize { get; set; }
```

### MinContentSize
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions/mincontentsize.md

#### ImageSearchOptions.MinContentSize property

For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result.

```csharp
public long MinContentSize { get; set; }
```

### ReturnContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions/returncontent.md

#### ImageSearchOptions.ReturnContent property

Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format `ReturnContentType`. By default this option is disabled.

```csharp
public bool ReturnContent { get; set; }
```

### ReturnContentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesearchoptions/returncontenttype.md

#### ImageSearchOptions.ReturnContentType property

Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned.

```csharp
public FileType ReturnContentType { get; set; }
```

### ImageSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions.md

#### ImageSignOptions class

Represents the Image signature options.

```csharp
public class ImageSignOptions : SignOptions, IAlignment, IDisposable, IRectangle, IRotation, 
    ITransparency
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSignOptions() | Initializes a new instance of the ImageSignOptions class with default values. |
| ImageSignOptions(Stream) | Initializes a new instance of the ImageSignOptions class with image stream. |
| ImageSignOptions(string) | Initializes a new instance of the ImageSignOptions class with image file. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Border { get; set; } | Specify border settings |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| ImageFilePath { get; set; } | Gets or sets the signature image file path. This property is used only if ImageStream is not specified. |
| ImageStream { get; set; } | Gets or sets the signature image stream. If this property is specified it is always used instead ImageFilePath. |
| virtual Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Rectangle { get; } | Rectangle of area to put the image on document. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| virtual Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

#### Methods

| Name | Description |
| --- | --- |
| static FromBase64(string) | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |
| Dispose() | Clears internal resources |

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/border.md

#### ImageSignOptions.Border property

Specify border settings

```csharp
public Border Border { get; set; }
```

### Dispose
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/dispose.md

#### ImageSignOptions.Dispose method

Clears internal resources

```csharp
public void Dispose()
```

### FromBase64
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/frombase64.md

#### ImageSignOptions.FromBase64 method

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

```csharp
public static ImageSignOptions FromBase64(string base64Content)
```

| Parameter | Type | Description |
| --- | --- | --- |
| base64Content | String | Image content in Base64 string format |

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/height.md

#### ImageSignOptions.Height property

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType).

```csharp
public int Height { get; set; }
```

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/horizontalalignment.md

#### ImageSignOptions.HorizontalAlignment property

Horizontal alignment of signature on document page.

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

### ImageFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/imagefilepath.md

#### ImageSignOptions.ImageFilePath property

Gets or sets the signature image file path. This property is used only if ImageStream is not specified.

```csharp
public string ImageFilePath { get; set; }
```

### ImageSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/imagesignoptions.md

#### ImageSignOptions()

Initializes a new instance of the ImageSignOptions class with default values.

```csharp
public ImageSignOptions()
```

#### ImageSignOptions(string)

Initializes a new instance of the ImageSignOptions class with image file.

```csharp
public ImageSignOptions(string imageFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | String | Image file path |

#### ImageSignOptions(Stream)

Initializes a new instance of the ImageSignOptions class with image stream.

```csharp
public ImageSignOptions(Stream imageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | Stream | Image stream |

### ImageStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/imagestream.md

#### ImageSignOptions.ImageStream property

Gets or sets the signature image stream. If this property is specified it is always used instead ImageFilePath.

```csharp
public Stream ImageStream { get; set; }
```

### Left
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/left.md

#### ImageSignOptions.Left property

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if horizontal alignment is not specified).

```csharp
public virtual int Left { get; set; }
```

### LocationMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/locationmeasuretype.md

#### ImageSignOptions.LocationMeasureType property

Measure type (pixels, percents or millimeters) for Left and Top properties.

```csharp
public virtual MeasureType LocationMeasureType { get; set; }
```

### Margin
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/margin.md

#### ImageSignOptions.Margin property

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

```csharp
public virtual Padding Margin { get; set; }
```

### MarginMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/marginmeasuretype.md

#### ImageSignOptions.MarginMeasureType property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

```csharp
public virtual MeasureType MarginMeasureType { get; set; }
```

### Rectangle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/rectangle.md

#### ImageSignOptions.Rectangle property

Rectangle of area to put the image on document.

```csharp
public Rectangle Rectangle { get; }
```

### RotationAngle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/rotationangle.md

#### ImageSignOptions.RotationAngle property

Rotation angle of signature on document page (clockwise).

```csharp
public int RotationAngle { get; set; }
```

### ShapePosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/shapeposition.md

#### ImageSignOptions.ShapePosition property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

```csharp
public ShapePosition ShapePosition { get; set; }
```

### SizeMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/sizemeasuretype.md

#### ImageSignOptions.SizeMeasureType property

Measure type (pixels, percents or millimeters) for Width and Height properties.

```csharp
public virtual MeasureType SizeMeasureType { get; set; }
```

### Stretch
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/stretch.md

#### ImageSignOptions.Stretch property

Stretch mode on Document Page.

```csharp
public StretchMode Stretch { get; set; }
```

### Top
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/top.md

#### ImageSignOptions.Top property

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if vertical alignment is not specified).

```csharp
public virtual int Top { get; set; }
```

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/transparency.md

#### ImageSignOptions.Transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

```csharp
public double Transparency { get; set; }
```

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/verticalalignment.md

#### ImageSignOptions.VerticalAlignment property

Vertical alignment of signature on document page.

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/imagesignoptions/width.md

#### ImageSignOptions.Width property

Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType).

```csharp
public int Width { get; set; }
```

### JpegCompressionColorMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegcompressioncolormode.md

#### JpegCompressionColorMode enumeration

Specifies JPEG color compression modes.

```csharp
public enum JpegCompressionColorMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Grayscale | `0` | The Grayscale image. |
| YCbCr | `1` | YCbCr image, standard option for jpeg images. |
| Cmyk | `2` | 4-component CMYK image. |
| Ycck | `3` | The ycck color jpeg image. Needs icc profile for saving. |
| Rgb | `4` | The RGB Color mode. |

### JpegCompressionMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegcompressionmode.md

#### JpegCompressionMode enumeration

Specifies JPEG compression modes.

```csharp
public enum JpegCompressionMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Baseline | `0` | The baseline compression. |
| Progressive | `1` | The progressive compression. |
| Lossless | `2` | The lossless compression. Use this compression type carefully because many image viewers do not support it. If you use it try assign the `ColorType` property to Grayscale or Rgb values. |
| JpegLs | `3` | The JPEG-LS compression. Use this compression type carefully because many image viewers do not support it. If you use it try to assign the `ColorType` property to Grayscale value. |

### JpegRoundingMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegroundingmode.md

#### JpegRoundingMode enumeration

Specifies different JPEG rounding modes.

```csharp
public enum JpegRoundingMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Extrapolate | `0` | Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8. |
| Truncate | `1` | Truncate an 8-bit value to fit it into n bits, where n more than 1 and less 8. |

### JpegSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions.md

#### JpegSaveOptions class

Jpeg Save options for image documents.

```csharp
public sealed class JpegSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JpegSaveOptions() | Creates JpegSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| BitsPerChannel { get; set; } | Gets or sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel. |
| ColorType { get; set; } | Gets or sets the color type for jpeg image. |
| Comment { get; set; } | Gets or sets the jpeg file comment. |
| CompressionType { get; set; } | Gets or sets the compression type. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| Quality { get; set; } | Gets or sets image quality. |
| SampleRoundingMode { get; set; } | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### BitsPerChannel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/bitsperchannel.md

#### JpegSaveOptions.BitsPerChannel property

Gets or sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.

```csharp
public byte BitsPerChannel { get; set; }
```

### ColorType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/colortype.md

#### JpegSaveOptions.ColorType property

Gets or sets the color type for jpeg image.

```csharp
public JpegCompressionColorMode ColorType { get; set; }
```

### Comment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/comment.md

#### JpegSaveOptions.Comment property

Gets or sets the jpeg file comment.

```csharp
public string Comment { get; set; }
```

### CompressionType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/compressiontype.md

#### JpegSaveOptions.CompressionType property

Gets or sets the compression type.

```csharp
public JpegCompressionMode CompressionType { get; set; }
```

### JpegSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/jpegsaveoptions.md

#### JpegSaveOptions constructor

Creates JpegSaveOptions with default values.

```csharp
public JpegSaveOptions()
```

### Quality
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/quality.md

#### JpegSaveOptions.Quality property

Gets or sets image quality.

```csharp
public int Quality { get; set; }
```

### SampleRoundingMode
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/jpegsaveoptions/sampleroundingmode.md

#### JpegSaveOptions.SampleRoundingMode property

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel.

```csharp
public JpegRoundingMode SampleRoundingMode { get; set; }
```

### LoadOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions.md

#### LoadOptions class

Allows to specify additional options (such as password) when opening a document to sign.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of LoadOptions class. |
| LoadOptions(FileType) | Initializes a new instance of the `LoadOptions` class with a specified file type. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | Gets or sets the file type associated with the load options. |
| LoadExternalResources { get; set; } | Gets or sets options that specifies if external document resources should be loaded. This option with disabled value (false) allows to save loading time for the documents with many or large external resource links. By default value is enabled (true). |
| Password { get; set; } | Gets or sets password to open a protected document. It will be also used to save signed document as protected. |
| Permissions { get; } | The PDF document permissions such as printing, modification and data extraction.Only for PDF documents. |

### FileType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions/filetype.md

#### LoadOptions.FileType property

Gets or sets the file type associated with the load options.

```csharp
public FileType FileType { get; set; }
```

##### Property Value

The file type, defaulting to `Unknown`.

### LoadExternalResources
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions/loadexternalresources.md

#### LoadOptions.LoadExternalResources property

Gets or sets options that specifies if external document resources should be loaded. This option with disabled value (false) allows to save loading time for the documents with many or large external resource links. By default value is enabled (true).

```csharp
public bool LoadExternalResources { get; set; }
```

### LoadOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of LoadOptions class.

```csharp
public LoadOptions()
```

#### LoadOptions(FileType)

Initializes a new instance of the `LoadOptions` class with a specified file type.

```csharp
public LoadOptions(FileType fileType)
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions/password.md

#### LoadOptions.Password property

Gets or sets password to open a protected document. It will be also used to save signed document as protected.

```csharp
public string Password { get; set; }
```

### Permissions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/loadoptions/permissions.md

#### LoadOptions.Permissions property

The PDF document permissions such as printing, modification and data extraction.Only for PDF documents.

```csharp
public Permissions? Permissions { get; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/signature/net/protect-pdf-documents/).

### MetadataSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions.md

#### MetadataSearchOptions class

Represents search options for Metadata signatures.

```csharp
public class MetadataSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataSearchOptions() | Initializes a new instance of the MetadataSearchOptions class with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to decrypt all Metadata signatures withing this options collection. If this value is set all found signatures will use this encryption by default or its own DataEncryption if it was assigned. |
| IncludeBuiltinProperties { get; set; } | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadsheet and Word Processing document file types. |
| Name { get; set; } | Specifies Metadata Signature name if it should be searched and matched. |
| NameMatchType { get; set; } | Gets or sets Metadata name Match Type search. It is used only when Name property is set. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions/dataencryption.md

#### MetadataSearchOptions.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to decrypt all Metadata signatures withing this options collection. If this value is set all found signatures will use this encryption by default or its own DataEncryption if it was assigned.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### IncludeBuiltinProperties
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions/includebuiltinproperties.md

#### MetadataSearchOptions.IncludeBuiltinProperties property

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadsheet and Word Processing document file types.

```csharp
public bool IncludeBuiltinProperties { get; set; }
```

### MetadataSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions/metadatasearchoptions.md

#### MetadataSearchOptions constructor

Initializes a new instance of the MetadataSearchOptions class with default values.

```csharp
public MetadataSearchOptions()
```

### Name
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions/name.md

#### MetadataSearchOptions.Name property

Specifies Metadata Signature name if it should be searched and matched.

```csharp
public string Name { get; set; }
```

### NameMatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasearchoptions/namematchtype.md

#### MetadataSearchOptions.NameMatchType property

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

```csharp
public TextMatchType NameMatchType { get; set; }
```

### MetadataSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions.md

#### MetadataSignOptions class

Represents Metadata signature options.

```csharp
public class MetadataSignOptions : SignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MetadataSignOptions() | Initializes a new instance of the MetadataSignOptions class with default values. |
| MetadataSignOptions(IEnumerable&lt;MetadataSignature&gt;) | Initializes a new instance of the MetadataSignOptions class with Metadata. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encrypt all Metadata signatures withing this options collection. If this value is set all added signatures will use this encryption by default or its own DataEncryption if it was assigned. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Signatures { get; set; } | Gets or sets the Metadata of signature. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

#### Methods

| Name | Description |
| --- | --- |
| Add(MetadataSignature) | Add existing MetadataSignature instance to collection. |
| AddImageSignature(ushort, object) | Creates new ImageMetadataSignature with passed arguments and adds it to collection. |
| AddPdfSignature(string, object, string) | Creates new PdfMetadataSignature with passed arguments and adds it to collection. |

### Add
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/add.md

#### MetadataSignOptions.Add method

Add existing MetadataSignature instance to collection.

```csharp
public MetadataSignOptions Add(MetadataSignature metadataSignature)
```

| Parameter | Type | Description |
| --- | --- | --- |
| metadataSignature | MetadataSignature | The existing MetadataSignature instance to be added |

##### Return Value

Instance itself

### AddImageSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/addimagesignature.md

#### MetadataSignOptions.AddImageSignature method

Creates new ImageMetadataSignature with passed arguments and adds it to collection.

```csharp
public ImageMetadataSignature AddImageSignature(ushort id, object value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | UInt16 | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | Object | Metadata value |

##### Return Value

Newly created signature that was added to MetadataSignatures collection

### AddPdfSignature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/addpdfsignature.md

#### MetadataSignOptions.AddPdfSignature method

Creates new PdfMetadataSignature with passed arguments and adds it to collection.

```csharp
public PdfMetadataSignature AddPdfSignature(string name, object value, string tag = "xmp")
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | Name of Metadata signature object |
| value | Object | Value of Metadata signature |
| tag | String | Prefix tag of Metadata signature |

##### Return Value

Newly created signature that was added to MetadataSignatures collection

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/dataencryption.md

#### MetadataSignOptions.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to encrypt all Metadata signatures withing this options collection. If this value is set all added signatures will use this encryption by default or its own DataEncryption if it was assigned.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### MetadataSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/metadatasignoptions.md

#### MetadataSignOptions()

Initializes a new instance of the MetadataSignOptions class with default values.

```csharp
public MetadataSignOptions()
```

#### MetadataSignOptions(IEnumerable&lt;MetadataSignature&gt;)

Initializes a new instance of the MetadataSignOptions class with Metadata.

```csharp
public MetadataSignOptions(IEnumerable<MetadataSignature> signatures)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatures | IEnumerable`1 | Collection of Metadata Signatures `MetadataSignature`. |

### Signatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/metadatasignoptions/signatures.md

#### MetadataSignOptions.Signatures property

Gets or sets the Metadata of signature.

```csharp
public MetadataSignatureCollection Signatures { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup.md

#### PagesSetup class

Describes special document pages to work with.

```csharp
public class PagesSetup
```

#### Constructors

| Name | Description |
| --- | --- |
| PagesSetup() | Creates PagesSetup with default options. |

#### Properties

| Name | Description |
| --- | --- |
| EvenPages { get; set; } | Gets or sets flag to use even pages of document. |
| FirstPage { get; set; } | Gets or sets flag to use first document page. |
| LastPage { get; set; } | Gets or sets flag to use last document page. |
| OddPages { get; set; } | Gets or sets flag to use odd pages of document. |
| PageNumbers { get; set; } | Set arbitrary pages of document to use. |

### EvenPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/evenpages.md

#### PagesSetup.EvenPages property

Gets or sets flag to use even pages of document.

```csharp
public bool EvenPages { get; set; }
```

### FirstPage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/firstpage.md

#### PagesSetup.FirstPage property

Gets or sets flag to use first document page.

```csharp
public bool FirstPage { get; set; }
```

### LastPage
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/lastpage.md

#### PagesSetup.LastPage property

Gets or sets flag to use last document page.

```csharp
public bool LastPage { get; set; }
```

### OddPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/oddpages.md

#### PagesSetup.OddPages property

Gets or sets flag to use odd pages of document.

```csharp
public bool OddPages { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/pagenumbers.md

#### PagesSetup.PageNumbers property

Set arbitrary pages of document to use.

```csharp
public List<int> PageNumbers { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pagessetup/pagessetup.md

#### PagesSetup constructor

Creates PagesSetup with default options.

```csharp
public PagesSetup()
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdfsaveoptions.md

#### PdfSaveOptions class

Save options for PDF documents.

```csharp
public class PdfSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of PdfSaveOptions class with default values. |
| PdfSaveOptions(bool) | Initializes a new instance of PdfSaveOptions class with overwrite flag. |
| PdfSaveOptions(PdfSaveFileFormat) | Initializes a new instance of PdfSaveOptions class with specified output file format. |
| PdfSaveOptions(PdfSaveFileFormat, bool) | Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| Permissions { get; set; } | The PDF document permissions such as printing, modification and data extraction. |
| PermissionsPassword { get; set; } | A permissions password (the primary password) requires a password to change permission settings. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdfsaveoptions/fileformat.md

#### PdfSaveOptions.FileFormat property

Gets or sets file format of signed document.

```csharp
public PdfSaveFileFormat FileFormat { get; set; }
```

### PdfSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdfsaveoptions/pdfsaveoptions.md

#### PdfSaveOptions()

Initializes a new instance of PdfSaveOptions class with default values.

```csharp
public PdfSaveOptions()
```

#### PdfSaveOptions(PdfSaveFileFormat)

Initializes a new instance of PdfSaveOptions class with specified output file format.

```csharp
public PdfSaveOptions(PdfSaveFileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | PdfSaveFileFormat | Output file type `PdfSaveFileFormat`. |

#### PdfSaveOptions(bool)

Initializes a new instance of PdfSaveOptions class with overwrite flag.

```csharp
public PdfSaveOptions(bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

#### PdfSaveOptions(PdfSaveFileFormat, bool)

Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.

```csharp
public PdfSaveOptions(PdfSaveFileFormat fileFormat, bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | PdfSaveFileFormat | Output file type `PdfSaveFileFormat`. |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### Permissions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdfsaveoptions/permissions.md

#### PdfSaveOptions.Permissions property

The PDF document permissions such as printing, modification and data extraction.

```csharp
public Permissions? Permissions { get; set; }
```

##### Remarks

To modify these permissions, the PermissionsPassword must be set. For a code sample, see the [documentation](https://docs.groupdocs.com/signature/net/protect-pdf-documents/).

### PermissionsPassword
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdfsaveoptions/permissionspassword.md

#### PdfSaveOptions.PermissionsPassword property

A permissions password (the primary password) requires a password to change permission settings.

```csharp
public string PermissionsPassword { get; set; }
```

### PdfTextAnnotationVerifyExtensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextannotationverifyextensions.md

#### PdfTextAnnotationVerifyExtensions class

Describes extensions of verification of PDF text annotation object

```csharp
public class PdfTextAnnotationVerifyExtensions : VerifyExtensions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfTextAnnotationVerifyExtensions() | Creates PDF text annotation signature verification extensions with empty values. |

#### Properties

| Name | Description |
| --- | --- |
| Contents { get; set; } | Contents of text annotation to be verified. Not be verified if equals empty string or null. |
| Subject { get; set; } | Subject of text annotation to be verified. Not be verified if equals empty string or null. |
| Title { get; set; } | Title of text annotation to be verified. Not be verified if equals empty string or null. |

### Contents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextannotationverifyextensions/contents.md

#### PdfTextAnnotationVerifyExtensions.Contents property

Contents of text annotation to be verified. Not be verified if equals empty string or null.

```csharp
public string Contents { get; set; }
```

### PdfTextAnnotationVerifyExtensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextannotationverifyextensions/pdftextannotationverifyextensions.md

#### PdfTextAnnotationVerifyExtensions constructor

Creates PDF text annotation signature verification extensions with empty values.

```csharp
public PdfTextAnnotationVerifyExtensions()
```

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextannotationverifyextensions/subject.md

#### PdfTextAnnotationVerifyExtensions.Subject property

Subject of text annotation to be verified. Not be verified if equals empty string or null.

```csharp
public string Subject { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextannotationverifyextensions/title.md

#### PdfTextAnnotationVerifyExtensions.Title property

Title of text annotation to be verified. Not be verified if equals empty string or null.

```csharp
public string Title { get; set; }
```

### PdfTextStickerVerifyExtensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions.md

#### PdfTextStickerVerifyExtensions class

Describes extensions of verification of PDF sticker object.

```csharp
public sealed class PdfTextStickerVerifyExtensions : VerifyExtensions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfTextStickerVerifyExtensions() | Creates PDF text sticker signature verification extensions with empty values. |

#### Properties

| Name | Description |
| --- | --- |
| Contents { get; set; } | Contents of sticker to be verified. Value will not be verified if equals empty string or null. |
| Icon { get; set; } | Icon of sticker to be verified. Value will not be verified if equals null. |
| Subject { get; set; } | Subject of sticker to be verified. Value will not be verified if equals empty string or null. |
| Title { get; set; } | Title of sticker to be verified. Value will not be verified if equals empty string or null. |

### Contents
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions/contents.md

#### PdfTextStickerVerifyExtensions.Contents property

Contents of sticker to be verified. Value will not be verified if equals empty string or null.

```csharp
public string Contents { get; set; }
```

### Icon
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions/icon.md

#### PdfTextStickerVerifyExtensions.Icon property

Icon of sticker to be verified. Value will not be verified if equals null.

```csharp
public PdfTextStickerIcon? Icon { get; set; }
```

### PdfTextStickerVerifyExtensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions/pdftextstickerverifyextensions.md

#### PdfTextStickerVerifyExtensions constructor

Creates PDF text sticker signature verification extensions with empty values.

```csharp
public PdfTextStickerVerifyExtensions()
```

### Subject
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions/subject.md

#### PdfTextStickerVerifyExtensions.Subject property

Subject of sticker to be verified. Value will not be verified if equals empty string or null.

```csharp
public string Subject { get; set; }
```

### Title
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pdftextstickerverifyextensions/title.md

#### PdfTextStickerVerifyExtensions.Title property

Title of sticker to be verified. Value will not be verified if equals empty string or null.

```csharp
public string Title { get; set; }
```

### Permissions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/permissions.md

#### Permissions enumeration

Specifies configurable permissions for PDF documents, such as printing, content modification, and data extraction. These settings are applicable to PDF format only and control user access and interaction capabilities.

```csharp
[Flags]
public enum Permissions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Allow all actions, including printing, modification, and data extraction. |
| DenyPrinting | `1` | Deny printing of the document. |
| DenyModification | `2` | Deny content modification, including filling forms and adding or modifying annotations. |
| DenyDataExtraction | `4` | Deny extraction of text and graphics from the document. |
| DenyAll | `7` | Deny all actions, including printing, modification, and data extraction. |

### PngColorType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngcolortype.md

#### PngColorType enumeration

Represents the PNG image color type.

```csharp
[Flags]
public enum PngColorType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Grayscale | `0` | Represents the color type where each pixel is a grayscale sample. |
| Truecolor | `2` | Represents the color type where each pixel is an R,G,B triple. |
| IndexedColor | `3` | Represents the color type where each pixel is a palette index; a PLTE chunk shall appear. |
| GrayscaleWithAlpha | `4` | Represents the color type where each pixel is a grayscale sample followed by an alpha sample. |
| TruecolorWithAlpha | `6` | Represents the color type where each pixel is an R,G,B triple followed by an alpha sample. |

### PngFilterType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngfiltertype.md

#### PngFilterType enumeration

Represents PNG image filter type.

```csharp
public enum PngFilterType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | The null-filter, means no filtering for image data rows. |
| Sub | `1` | The sub filter, means subtractive filtering will be applied to image data. |
| Up | `2` | The up filter, means row-by-row subtraction filter will be applied. |
| Avg | `3` | The avg filter, means, that average filter will be applied to image data. |
| Paeth | `4` | The path predictor filter. |
| Adaptive | `5` | Adaptive filtering, means that saving process will choose most suitable filter for each data row. Best compression, slowest execution time. |

### PngSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions.md

#### PngSaveOptions class

Png Save options for image documents.

```csharp
public sealed class PngSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PngSaveOptions() | Creates PngSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| BitDepth { get; set; } | The bit depth. |
| ColorType { get; set; } | Gets or sets the type of the `PngColorType`. |
| CompressionLevel { get; set; } | The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| FilterType { get; set; } | Gets or sets the filter type `PngFilterType` used during png file save process. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| Progressive { get; set; } | Gets or sets a value indicating whether this PngSaveOptions is progressive. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### BitDepth
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/bitdepth.md

#### PngSaveOptions.BitDepth property

The bit depth.

```csharp
public byte BitDepth { get; set; }
```

### ColorType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/colortype.md

#### PngSaveOptions.ColorType property

Gets or sets the type of the `PngColorType`.

```csharp
public PngColorType ColorType { get; set; }
```

### CompressionLevel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/compressionlevel.md

#### PngSaveOptions.CompressionLevel property

The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.

```csharp
public int CompressionLevel { get; set; }
```

### FilterType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/filtertype.md

#### PngSaveOptions.FilterType property

Gets or sets the filter type `PngFilterType` used during png file save process.

```csharp
public PngFilterType FilterType { get; set; }
```

### PngSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/pngsaveoptions.md

#### PngSaveOptions constructor

Creates PngSaveOptions with default values.

```csharp
public PngSaveOptions()
```

### Progressive
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/pngsaveoptions/progressive.md

#### PngSaveOptions.Progressive property

Gets or sets a value indicating whether this PngSaveOptions is progressive.

```csharp
public bool Progressive { get; set; }
```

### PresentationSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/presentationsaveoptions.md

#### PresentationSaveOptions class

Save options for Presentation documents.

```csharp
public class PresentationSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationSaveOptions() | Initializes a new instance of PresentationSaveOptions class with default values. |
| PresentationSaveOptions(bool) | Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag. |
| PresentationSaveOptions(PresentationSaveFileFormat) | Initializes a new instance of PresentationSaveOptions class with specified output file format. |
| PresentationSaveOptions(PresentationSaveFileFormat, bool) | Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/presentationsaveoptions/fileformat.md

#### PresentationSaveOptions.FileFormat property

Gets or sets file format of signed document.

```csharp
public PresentationSaveFileFormat FileFormat { get; set; }
```

### PresentationSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/presentationsaveoptions/presentationsaveoptions.md

#### PresentationSaveOptions()

Initializes a new instance of PresentationSaveOptions class with default values.

```csharp
public PresentationSaveOptions()
```

#### PresentationSaveOptions(PresentationSaveFileFormat)

Initializes a new instance of PresentationSaveOptions class with specified output file format.

```csharp
public PresentationSaveOptions(PresentationSaveFileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | PresentationSaveFileFormat | Output file type `PresentationSaveFileFormat`. |

#### PresentationSaveOptions(bool)

Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag.

```csharp
public PresentationSaveOptions(bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

#### PresentationSaveOptions(PresentationSaveFileFormat, bool)

Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag.

```csharp
public PresentationSaveOptions(PresentationSaveFileFormat fileFormat, bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | PresentationSaveFileFormat | Output file type `PresentationSaveFileFormat`. |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### PreviewOptions.CreateDocPageStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions.createdocpagestream.md

#### PreviewOptions.CreateDocPageStream delegate

Delegate that defines method to create output document page preview stream.

```csharp
public delegate Stream CreateDocPageStream(PreviewPageData pageData);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageData | PreviewPageData | Page previewed data. |

### PreviewOptions.PreviewFormats
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions.previewformats.md

#### PreviewOptions.PreviewFormats enumeration

Document preview supported formats

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | PNG |
| JPEG | `1` | JPEG |
| BMP | `2` | BMP |

### PreviewOptions.ReleaseDocPageStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions.releasedocpagestream.md

#### PreviewOptions.ReleaseDocPageStream delegate

Delegate that defines method to release output document page preview stream.

```csharp
public delegate void ReleaseDocPageStream(PreviewPageData pageData, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageData | PreviewPageData | Page previewed data. |
| pageStream | Stream | The page stream to release. |

### PreviewOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions.md

#### PreviewOptions class

Represents document preview options.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreateDocPageStream, int, params int[]) | Initializes PreviewOptions object. |
| PreviewOptions(CreateDocPageStream, ReleaseDocPageStream, int, params int[]) | Initializes PreviewOptions object. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | Gets or sets preview images height. |
| HideSignatures { get; set; } | Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image. |
| PageNumbers { get; set; } | Gets or sets preview images page numbers. |
| PreviewFormat { get; set; } | Gets or sets preview images format. |
| Resolution { get; set; } | Gets or sets the resolution of the preview images in DPI (dots per inch). |
| Width { get; set; } | Gets or sets preview images width. |

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/height.md

#### PreviewOptions.Height property

Gets or sets preview images height.

```csharp
public int Height { get; set; }
```

### HideSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/hidesignatures.md

#### PreviewOptions.HideSignatures property

Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

```csharp
public bool HideSignatures { get; set; }
```

### PageNumbers
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Gets or sets preview images page numbers.

```csharp
public int[] PageNumbers { get; set; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Gets or sets preview images format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/previewoptions.md

#### PreviewOptions(CreateDocPageStream, int, params int[])

Initializes PreviewOptions object.

```csharp
public PreviewOptions(CreateDocPageStream createPageStream, int resolution = 96, 
    params int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreateDocPageStream | Delegate which defines method to create output document page preview stream. |
| resolution | Int32 | Resolution of the preview images in DPI (optional). |
| pageNumbers | Int32[] | Desired page numbers |

#### PreviewOptions(CreateDocPageStream, ReleaseDocPageStream, int, params int[])

Initializes PreviewOptions object.

```csharp
public PreviewOptions(CreateDocPageStream createPageStream, ReleaseDocPageStream releasePageStream, 
    int resolution = 96, params int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreateDocPageStream | Delegate which defines method to create output document page preview stream. |
| releasePageStream | ReleaseDocPageStream | Delegate which defines method to release output document page preview stream. |
| resolution | Int32 | Resolution of the preview images in DPI (optional). |
| pageNumbers | Int32[] | Desired page numbers |

### Resolution
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/resolution.md

#### PreviewOptions.Resolution property

Gets or sets the resolution of the preview images in DPI (dots per inch).

```csharp
public int Resolution { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewoptions/width.md

#### PreviewOptions.Width property

Gets or sets preview images width.

```csharp
public int Width { get; set; }
```

### PreviewPageData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata.md

#### PreviewPageData class

Contains data about document page to be saved as preview image.

```csharp
public sealed class PreviewPageData
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewPageData() | Creates PreviewPageData with default parameters. |

#### Properties

| Name | Description |
| --- | --- |
| FileName { get; } | Name of a file which is being processed in order to get page previews. In case of nameless stream processing it equals 'fromstream'. |
| PageNumber { get; } | Document page number of current preview. |
| PreviewFormat { get; } | Selected preview format. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Textual representation of PreviewPageData instance. |

### FileName
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata/filename.md

#### PreviewPageData.FileName property

Name of a file which is being processed in order to get page previews. In case of nameless stream processing it equals 'fromstream'.

```csharp
public string FileName { get; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata/pagenumber.md

#### PreviewPageData.PageNumber property

Document page number of current preview.

```csharp
public int PageNumber { get; }
```

### PreviewFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata/previewformat.md

#### PreviewPageData.PreviewFormat property

Selected preview format.

```csharp
public PreviewFormats PreviewFormat { get; }
```

### PreviewPageData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata/previewpagedata.md

#### PreviewPageData constructor

Creates PreviewPageData with default parameters.

```csharp
public PreviewPageData()
```

### ToString
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewpagedata/tostring.md

#### PreviewPageData.ToString method

Textual representation of PreviewPageData instance.

```csharp
public override string ToString()
```

##### Return Value

Returns textual representation of PreviewPageData instance.

### PreviewSignatureOptions.PreviewFormats
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions.previewformats.md

#### PreviewSignatureOptions.PreviewFormats enumeration

Signature preview supported formats

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` | PNG |
| JPEG | `1` | JPEG |
| BMP | `2` | BMP |
| GIF | `3` | GIF |
| SVG | `4` | SVG |

### PreviewSignatureOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions.md

#### PreviewSignatureOptions class

Represents signature preview options.

```csharp
public class PreviewSignatureOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewSignatureOptions(SignOptions, CreateSignatureStream) | Initializes PreviewSignatureOptions object. |
| PreviewSignatureOptions(SignOptions, CreateSignatureStream, ReleaseSignatureStream) | Initializes PreviewSignatureOptions object. |

#### Properties

| Name | Description |
| --- | --- |
| PreviewFormat { get; set; } | Gets or sets preview images format. Default value is PNG |
| SignatureId { get; set; } | Unique value to distinct the signature. Use SignatureId to identify the preview options. |
| SignOptions { get; set; } | Signature Options for generate preview. |

### PreviewFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions/previewformat.md

#### PreviewSignatureOptions.PreviewFormat property

Gets or sets preview images format. Default value is PNG

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

### PreviewSignatureOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions/previewsignatureoptions.md

#### PreviewSignatureOptions(SignOptions, CreateSignatureStream)

Initializes PreviewSignatureOptions object.

```csharp
public PreviewSignatureOptions(SignOptions signOptions, CreateSignatureStream createSignatureStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions | The signature options to generate preview for. |
| createSignatureStream | CreateSignatureStream | Delegate which defines method to create output signature preview stream. |

#### PreviewSignatureOptions(SignOptions, CreateSignatureStream, ReleaseSignatureStream)

Initializes PreviewSignatureOptions object.

```csharp
public PreviewSignatureOptions(SignOptions signOptions, 
    CreateSignatureStream createSignatureStream, ReleaseSignatureStream releaseSignatureStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions | The signature options to generate preview for. |
| createSignatureStream | CreateSignatureStream | Delegate which defines method to create output signature preview stream. |
| releaseSignatureStream | ReleaseSignatureStream | Delegate which defines method to release output signature preview stream. |

### SignatureId
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions/signatureid.md

#### PreviewSignatureOptions.SignatureId property

Unique value to distinct the signature. Use SignatureId to identify the preview options.

```csharp
public string SignatureId { get; set; }
```

### SignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/previewsignatureoptions/signoptions.md

#### PreviewSignatureOptions.SignOptions property

Signature Options for generate preview.

```csharp
public SignOptions SignOptions { get; set; }
```

### QrCodeSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions.md

#### QrCodeSearchOptions class

Represents search options for QR-Code signatures.

```csharp
public class QrCodeSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| QrCodeSearchOptions() | Initializes a new instance of the QRCodeSearchOptions class with default values. |
| QrCodeSearchOptions(QrCodeType) | Initializes a new instance of the QRCodeSearchOptions class with encode type value. |
| QrCodeSearchOptions(QrCodeType, string) | Initializes a new instance of the QRCodeSearchOptions class with encode type and text values. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties. |
| EncodeType { get; set; } | Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types. |
| MatchType { get; set; } | Gets or sets QR-Code Text Match Type search. It is used only when Text property is set. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ReturnContent { get; set; } | Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled. |
| ReturnContentType { get; set; } | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Text { get; set; } | Specifies QR-Code Signature Text if it should be searched and matched. |

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/dataencryption.md

#### QrCodeSearchOptions.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/encodetype.md

#### QrCodeSearchOptions.EncodeType property

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

```csharp
public QrCodeType EncodeType { get; set; }
```

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/matchtype.md

#### QrCodeSearchOptions.MatchType property

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

```csharp
public TextMatchType MatchType { get; set; }
```

### QrCodeSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/qrcodesearchoptions.md

#### QrCodeSearchOptions()

Initializes a new instance of the QRCodeSearchOptions class with default values.

```csharp
public QrCodeSearchOptions()
```

#### QrCodeSearchOptions(QrCodeType)

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

```csharp
public QrCodeSearchOptions(QrCodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type. |

#### QrCodeSearchOptions(QrCodeType, string)

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

```csharp
public QrCodeSearchOptions(QrCodeType encodeType, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type. |
| text | String | Set Text of QR-Code signature. |

### ReturnContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/returncontent.md

#### QrCodeSearchOptions.ReturnContent property

Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled.

```csharp
public bool ReturnContent { get; set; }
```

### ReturnContentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/returncontenttype.md

#### QrCodeSearchOptions.ReturnContentType property

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

```csharp
public FileType ReturnContentType { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesearchoptions/text.md

#### QrCodeSearchOptions.Text property

Specifies QR-Code Signature Text if it should be searched and matched.

```csharp
public string Text { get; set; }
```

### QrCodeSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions.md

#### QrCodeSignOptions class

Represents the QR-Code signature options.

```csharp
public class QrCodeSignOptions : TextSignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| QrCodeSignOptions() | Initializes a new instance of the QRCodeSignOptions class with default values. |
| QrCodeSignOptions(string) | Initializes a new instance of the QRCodeSignOptions class with text. |
| QrCodeSignOptions(string, QrCodeType) | Initializes a new instance of the BarcodeSignOptions class with text. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Background { get; set; } | Gets or sets the signature background settings. |
| Border { get; set; } | Specify border settings |
| CodeTextAlignment { get; set; } | Gets or sets the alignment of text in the result QR-code image. Default value is None. |
| Data { get; set; } | Gets or sets custom object to serialize to QR-Code content. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| EncodeType { get; set; } | Gets or sets QR-Code type. |
| Extensions { get; } | Signature Extensions. |
| Font { get; set; } | Gets or sets the font of signature. |
| override ForeColor { get; set; } | Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| InnerMargins { get; set; } | Gets or sets the space between QR-Code elements and result image borders. |
| Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| LogoFilePath { get; set; } | Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully. |
| LogoStream { get; set; } | Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoFilePath. Using of this property could cause problems with verification. Use it carefully. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| Native { get; set; } | Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| ReturnContent { get; set; } | Gets or sets flag to get QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled. |
| ReturnContentType { get; set; } | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in .png format will be returned. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| ShapeType { get; set; } | Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle. |
| SignatureID { get; set; } | Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only. |
| SignatureImplementation { get; set; } | Gets or sets the type of text signature implementation. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| Text { get; set; } | Gets or sets the text of signature. |
| TextHorizontalAlignment { get; set; } | Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see `TextSignatureImplementation` SignatureImplementation property). |
| TextVerticalAlignment { get; set; } | Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see `TextSignatureImplementation` SignatureImplementation property). |
| Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### CodeTextAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/codetextalignment.md

#### QrCodeSignOptions.CodeTextAlignment property

Gets or sets the alignment of text in the result QR-code image. Default value is None.

```csharp
public CodeTextAlignment CodeTextAlignment { get; set; }
```

### Data
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/data.md

#### QrCodeSignOptions.Data property

Gets or sets custom object to serialize to QR-Code content.

```csharp
public object Data { get; set; }
```

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/dataencryption.md

#### QrCodeSignOptions.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/encodetype.md

#### QrCodeSignOptions.EncodeType property

Gets or sets QR-Code type.

```csharp
public QrCodeType EncodeType { get; set; }
```

### ForeColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/forecolor.md

#### QrCodeSignOptions.ForeColor property

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

```csharp
public override Color ForeColor { get; set; }
```

### InnerMargins
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/innermargins.md

#### QrCodeSignOptions.InnerMargins property

Gets or sets the space between QR-Code elements and result image borders.

```csharp
public Padding InnerMargins { get; set; }
```

### LogoFilePath
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/logofilepath.md

#### QrCodeSignOptions.LogoFilePath property

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

```csharp
public string LogoFilePath { get; set; }
```

### LogoStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/logostream.md

#### QrCodeSignOptions.LogoStream property

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoFilePath. Using of this property could cause problems with verification. Use it carefully.

```csharp
public Stream LogoStream { get; set; }
```

### QrCodeSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/qrcodesignoptions.md

#### QrCodeSignOptions()

Initializes a new instance of the QRCodeSignOptions class with default values.

```csharp
public QrCodeSignOptions()
```

#### QrCodeSignOptions(string)

Initializes a new instance of the QRCodeSignOptions class with text.

```csharp
public QrCodeSignOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Signature text. |

#### QrCodeSignOptions(string, QrCodeType)

Initializes a new instance of the BarcodeSignOptions class with text.

```csharp
public QrCodeSignOptions(string text, QrCodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | QRCode text |
| encodeType | QrCodeType | QRCode encode type see `QrCodeType` |

### ReturnContent
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/returncontent.md

#### QrCodeSignOptions.ReturnContent property

Gets or sets flag to get QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format `ReturnContentType`. By default this option is disabled.

```csharp
public bool ReturnContent { get; set; }
```

### ReturnContentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodesignoptions/returncontenttype.md

#### QrCodeSignOptions.ReturnContentType property

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at `Format` Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in .png format will be returned.

```csharp
public FileType ReturnContentType { get; set; }
```

### QrCodeVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodeverifyoptions.md

#### QrCodeVerifyOptions class

Keeps options to verify document QR-code signature.

```csharp
public class QrCodeVerifyOptions : TextVerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| QrCodeVerifyOptions() | Creates verification option QrCodeVerifyOptions for QR-Code Signatures. |
| QrCodeVerifyOptions(string) | Creates verification option QrCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify. |
| QrCodeVerifyOptions(string, QrCodeType) | Creates verification option QrCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| DataEncryption { get; set; } | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text properties. |
| EncodeType { get; set; } | Gets or sets QR-code Type verification. This property is optional. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields. |
| IsValid { get; } | Valid property flag. |
| MatchType { get; set; } | Gets or sets Text Match Type verification. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| SignatureID { get; set; } | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |
| SignatureImplementation { get; set; } | Type of Signature to be verified. |
| Text { get; set; } | Specify Signature Text if it should be verified. |

### DataEncryption
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodeverifyoptions/dataencryption.md

#### QrCodeVerifyOptions.DataEncryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text properties.

```csharp
public IDataEncryption DataEncryption { get; set; }
```

### EncodeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodeverifyoptions/encodetype.md

#### QrCodeVerifyOptions.EncodeType property

Gets or sets QR-code Type verification. This property is optional.

```csharp
public QrCodeType EncodeType { get; set; }
```

### QrCodeVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/qrcodeverifyoptions/qrcodeverifyoptions.md

#### QrCodeVerifyOptions()

Creates verification option QrCodeVerifyOptions for QR-Code Signatures.

```csharp
public QrCodeVerifyOptions()
```

#### QrCodeVerifyOptions(string)

Creates verification option QrCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.

```csharp
public QrCodeVerifyOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | QR-code Text to verify |

#### QrCodeVerifyOptions(string, QrCodeType)

Creates verification option QrCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

```csharp
public QrCodeVerifyOptions(string text, QrCodeType encodeType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Text to be verified |
| encodeType | QrCodeType | Type of encoding |

### ReleaseSignatureStream
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/releasesignaturestream.md

#### ReleaseSignatureStream delegate

Delegate that defines method to release output signature preview stream.

```csharp
public delegate void ReleaseSignatureStream(PreviewSignatureOptions previewOptions, 
    Stream signatureStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewSignatureOptions | The options of previewed signature. |
| signatureStream | Stream | The signature image stream to release. |

### SaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions.md

#### SaveOptions class

Allows to specify additional options (such as password) when saving a document to sign.

```csharp
public class SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of SaveOptions class with default values. |
| SaveOptions(bool) | Initializes a new instance of SaveOptions class with specified output type and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### AddMissingExtenstion
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions/addmissingextenstion.md

#### SaveOptions.AddMissingExtenstion property

Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.

```csharp
public bool AddMissingExtenstion { get; set; }
```

### OverwriteExistingFiles
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions/overwriteexistingfiles.md

#### SaveOptions.OverwriteExistingFiles property

Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten.

```csharp
public bool OverwriteExistingFiles { get; set; }
```

### Password
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions/password.md

#### SaveOptions.Password property

Gets or sets password to save signed document with password protection. This property is not supported for Image documents.

```csharp
public string Password { get; set; }
```

### SaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions/saveoptions.md

#### SaveOptions()

Initializes a new instance of SaveOptions class with default values.

```csharp
public SaveOptions()
```

#### SaveOptions(bool)

Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

```csharp
public SaveOptions(bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### UseOriginalPassword
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/saveoptions/useoriginalpassword.md

#### SaveOptions.UseOriginalPassword property

Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents.

```csharp
public bool UseOriginalPassword { get; set; }
```

### SearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions.md

#### SearchOptions class

Represents the extract signatures from document options.

```csharp
public abstract class SearchOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |

### AllPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions/allpages.md

#### SearchOptions.AllPages property

Flag to search on each Document page. By default this value is set to true.

```csharp
public bool AllPages { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions/pagenumber.md

#### SearchOptions.PageNumber property

Gets or sets Document page number for searching. Value is optional.

```csharp
public int? PageNumber { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions/pagessetup.md

#### SearchOptions.PagesSetup property

Options to specify pages for Signature searching.

```csharp
public PagesSetup PagesSetup { get; set; }
```

### ShapePosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions/shapeposition.md

#### SearchOptions.ShapePosition property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

```csharp
public ShapePosition ShapePosition { get; set; }
```

### SkipExternal
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/searchoptions/skipexternal.md

#### SearchOptions.SkipExternal property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

```csharp
public bool SkipExternal { get; set; }
```

### SignatureContext
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signaturecontext.md

#### SignatureContext class

Represents the context for a document signature process, encapsulating the signing options.

```csharp
public class SignatureContext
```

#### Properties

| Name | Description |
| --- | --- |
| SignOptions { get; set; } | Gets or sets the options used for signing a document. |

### SignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signaturecontext/signoptions.md

#### SignatureContext.SignOptions property

Gets or sets the options used for signing a document.

```csharp
public SignOptions SignOptions { get; set; }
```

### SignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions.md

#### SignOptions class

Represents the signature options.

```csharp
public abstract class SignOptions
```

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### AllPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/allpages.md

#### SignOptions.AllPages property

Put signature on all document pages.

```csharp
public virtual bool AllPages { get; set; }
```

### Appearance
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/appearance.md

#### SignOptions.Appearance property

Additional signature appearance.

```csharp
public SignatureAppearance Appearance { get; set; }
```

### DocumentType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/documenttype.md

#### SignOptions.DocumentType property

Get or set the Document Type of the Signature Options `DocumentType`

```csharp
public DocumentType DocumentType { get; set; }
```

### Extensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/extensions.md

#### SignOptions.Extensions property

Signature Extensions.

```csharp
public List<SignatureExtension> Extensions { get; }
```

### HashAlgorithm
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/hashalgorithm.md

#### SignOptions.HashAlgorithm property

Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files.

```csharp
public HashAlgorithm HashAlgorithm { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/pagenumber.md

#### SignOptions.PageNumber property

Gets or sets document page number for signing. Minimal and default value is 1.

```csharp
public virtual int PageNumber { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/pagessetup.md

#### SignOptions.PagesSetup property

Options to specify pages to be signed.

```csharp
public virtual PagesSetup PagesSetup { get; set; }
```

### SignatureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/signaturetype.md

#### SignOptions.SignatureType property

Get the Signature Type `SignatureType`

```csharp
public SignatureType SignatureType { get; }
```

### ZOrder
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/signoptions/zorder.md

#### SignOptions.ZOrder property

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

```csharp
public int ZOrder { get; set; }
```

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

Save options for Spreadsheet Documents.

```csharp
public class SpreadsheetSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetSaveOptions() | Initializes a new instance of SpreadsheetSaveOptions class with default values. |
| SpreadsheetSaveOptions(SpreadsheetSaveFileFormat) | Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format. |
| SpreadsheetSaveOptions(SpreadsheetSaveFileFormat, bool) | Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/spreadsheetsaveoptions/fileformat.md

#### SpreadsheetSaveOptions.FileFormat property

Gets or sets file format of signed document.

```csharp
public SpreadsheetSaveFileFormat FileFormat { get; set; }
```

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/spreadsheetsaveoptions/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions()

Initializes a new instance of SpreadsheetSaveOptions class with default values.

```csharp
public SpreadsheetSaveOptions()
```

#### SpreadsheetSaveOptions(SpreadsheetSaveFileFormat)

Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format.

```csharp
public SpreadsheetSaveOptions(SpreadsheetSaveFileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | SpreadsheetSaveFileFormat | Specifies output file format. |

#### SpreadsheetSaveOptions(SpreadsheetSaveFileFormat, bool)

Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag.

```csharp
public SpreadsheetSaveOptions(SpreadsheetSaveFileFormat fileFormat, bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | SpreadsheetSaveFileFormat | Specifies output file format. |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### StampSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions.md

#### StampSignOptions class

Represents the Stamp signature options.

```csharp
public class StampSignOptions : ImageSignOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| StampSignOptions() | Initializes a new instance of the StampSignOptions class with default values. |
| StampSignOptions(int, int, int, int) | Initializes a new instance of the StampSignOptions class with alignment options. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Background { get; set; } | Gets or sets the Stamp background. |
| BackgroundColorCropType { get; set; } | Gets or sets the background color crop type of signature. |
| BackgroundImageCropType { get; set; } | Gets or sets the background image crop type of signature. |
| Border { get; set; } | Specify border settings |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| ImageFilePath { get; set; } | Gets or sets the signature image file path. This property is used only if ImageStream is not specified. |
| ImageStream { get; set; } | Gets or sets the signature image stream. If this property is specified it is always used instead ImageFilePath. |
| InnerLines { get; } | List of Inner Lines rendered as set of rectangles. |
| virtual Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| OuterLines { get; } | List of Outer Lines rendered as concentric circles. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| Rectangle { get; } | Rectangle of area to put the image on document. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| StampType { get; set; } | Gets or sets stamp type. Value by default is Round. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| virtual Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Clears internal resources |

### Background
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/background.md

#### StampSignOptions.Background property

Gets or sets the Stamp background.

```csharp
public Background Background { get; set; }
```

### BackgroundColorCropType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/backgroundcolorcroptype.md

#### StampSignOptions.BackgroundColorCropType property

Gets or sets the background color crop type of signature.

```csharp
public StampBackgroundCropType BackgroundColorCropType { get; set; }
```

### BackgroundImageCropType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/backgroundimagecroptype.md

#### StampSignOptions.BackgroundImageCropType property

Gets or sets the background image crop type of signature.

```csharp
public StampBackgroundCropType BackgroundImageCropType { get; set; }
```

### InnerLines
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/innerlines.md

#### StampSignOptions.InnerLines property

List of Inner Lines rendered as set of rectangles.

```csharp
public List<StampLine> InnerLines { get; }
```

### OuterLines
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/outerlines.md

#### StampSignOptions.OuterLines property

List of Outer Lines rendered as concentric circles.

```csharp
public List<StampLine> OuterLines { get; }
```

### StampSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/stampsignoptions.md

#### StampSignOptions()

Initializes a new instance of the StampSignOptions class with default values.

```csharp
public StampSignOptions()
```

#### StampSignOptions(int, int, int, int)

Initializes a new instance of the StampSignOptions class with alignment options.

```csharp
public StampSignOptions(int left, int top, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Int32 | The x-coordinate of the left top edge of Stamp Signature |
| top | Int32 | The y-coordinate of the left top edge of Stamp Signature |
| width | Int32 | The width of Stamp Signature |
| height | Int32 | The height of Stamp Signature |

### StampType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/stampsignoptions/stamptype.md

#### StampSignOptions.StampType property

Gets or sets stamp type. Value by default is Round.

```csharp
public StampType StampType { get; set; }
```

### TextSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsearchoptions.md

#### TextSearchOptions class

Represents search options for Text signatures.

```csharp
public class TextSearchOptions : SearchOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values. |
| TextSearchOptions(string) | Initializes a new instance of the TextSearchOptions class with text value. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to search on each Document page. By default this value is set to true. |
| MatchType { get; set; } | Gets or sets text match type search. |
| PageNumber { get; set; } | Gets or sets Document page number for searching. Value is optional. |
| PagesSetup { get; set; } | Options to specify pages for Signature searching. |
| ShapePosition { get; set; } | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| SignatureImplementation { get; set; } | Specifies text signature implementation to search. |
| SkipExternal { get; set; } | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| Text { get; set; } | Specifies signature text to match on searching. |

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsearchoptions/matchtype.md

#### TextSearchOptions.MatchType property

Gets or sets text match type search.

```csharp
public TextMatchType MatchType { get; set; }
```

### SignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsearchoptions/signatureimplementation.md

#### TextSearchOptions.SignatureImplementation property

Specifies text signature implementation to search.

```csharp
public TextSignatureImplementation? SignatureImplementation { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsearchoptions/text.md

#### TextSearchOptions.Text property

Specifies signature text to match on searching.

```csharp
public string Text { get; set; }
```

### TextSearchOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsearchoptions/textsearchoptions.md

#### TextSearchOptions()

Initializes a new instance of the TextSearchOptions class with default values.

```csharp
public TextSearchOptions()
```

#### TextSearchOptions(string)

Initializes a new instance of the TextSearchOptions class with text value.

```csharp
public TextSearchOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Set Text of Text signature. |

### TextSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions.md

#### TextSignOptions class

Represents the Text signature options.

```csharp
public class TextSignOptions : SignOptions, IAlignment, IRectangle, IRotation, ITransparency
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSignOptions() | Initializes a new instance of the TextSignOptions class with default values. |
| TextSignOptions(string) | Initializes a new instance of the TextSignOptions class with text. |

#### Properties

| Name | Description |
| --- | --- |
| virtual AllPages { get; set; } | Put signature on all document pages. |
| Appearance { get; set; } | Additional signature appearance. |
| Background { get; set; } | Gets or sets the signature background settings. |
| Border { get; set; } | Specify border settings |
| DocumentType { get; set; } | Get or set the Document Type of the Signature Options `DocumentType` |
| Extensions { get; } | Signature Extensions. |
| Font { get; set; } | Gets or sets the font of signature. |
| virtual ForeColor { get; set; } | Gets or sets the fore color of signature. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes. |
| HashAlgorithm { get; set; } | Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. |
| Height { get; set; } | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| HorizontalAlignment { get; set; } | Horizontal alignment of signature on document page. |
| Left { get; set; } | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if horizontal alignment is not specified). |
| virtual LocationMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| virtual Margin { get; set; } | Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified). |
| virtual MarginMeasureType { get; set; } | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| Native { get; set; } | Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example. |
| virtual PageNumber { get; set; } | Gets or sets document page number for signing. Minimal and default value is 1. |
| virtual PagesSetup { get; set; } | Options to specify pages to be signed. |
| RotationAngle { get; set; } | Rotation angle of signature on document page (clockwise). |
| ShapePosition { get; set; } | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| ShapeType { get; set; } | Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle. |
| SignatureID { get; set; } | Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only. |
| SignatureImplementation { get; set; } | Gets or sets the type of text signature implementation. |
| SignatureType { get; } | Get the Signature Type `SignatureType` |
| virtual SizeMeasureType { get; set; } | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| Stretch { get; set; } | Stretch mode on Document Page. |
| Text { get; set; } | Gets or sets the text of signature. |
| TextHorizontalAlignment { get; set; } | Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see `TextSignatureImplementation` SignatureImplementation property). |
| TextVerticalAlignment { get; set; } | Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see `TextSignatureImplementation` SignatureImplementation property). |
| Top { get; set; } | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if vertical alignment is not specified). |
| Transparency { get; set; } | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| VerticalAlignment { get; set; } | Vertical alignment of signature on document page. |
| Width { get; set; } | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| ZOrder { get; set; } | Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures. |

### Background
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/background.md

#### TextSignOptions.Background property

Gets or sets the signature background settings.

```csharp
public Background Background { get; set; }
```

### Border
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/border.md

#### TextSignOptions.Border property

Specify border settings

```csharp
public Border Border { get; set; }
```

### Font
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/font.md

#### TextSignOptions.Font property

Gets or sets the font of signature.

```csharp
public SignatureFont Font { get; set; }
```

### ForeColor
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/forecolor.md

#### TextSignOptions.ForeColor property

Gets or sets the fore color of signature.

```csharp
public virtual Color ForeColor { get; set; }
```

### FormTextFieldTitle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/formtextfieldtitle.md

#### TextSignOptions.FormTextFieldTitle property

Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.

```csharp
public string FormTextFieldTitle { get; set; }
```

### FormTextFieldType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/formtextfieldtype.md

#### TextSignOptions.FormTextFieldType property

Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

```csharp
public FormTextFieldType FormTextFieldType { get; set; }
```

### Height
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/height.md

#### TextSignOptions.Height property

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

```csharp
public int Height { get; set; }
```

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/horizontalalignment.md

#### TextSignOptions.HorizontalAlignment property

Horizontal alignment of signature on document page.

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

### Left
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/left.md

#### TextSignOptions.Left property

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if horizontal alignment is not specified).

```csharp
public int Left { get; set; }
```

### LocationMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/locationmeasuretype.md

#### TextSignOptions.LocationMeasureType property

Measure type (pixels, percents or millimeters) for Left and Top properties.

```csharp
public virtual MeasureType LocationMeasureType { get; set; }
```

### Margin
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/margin.md

#### TextSignOptions.Margin property

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

```csharp
public virtual Padding Margin { get; set; }
```

### MarginMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/marginmeasuretype.md

#### TextSignOptions.MarginMeasureType property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

```csharp
public virtual MeasureType MarginMeasureType { get; set; }
```

### Native
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/native.md

#### TextSignOptions.Native property

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

```csharp
public bool Native { get; set; }
```

### RotationAngle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/rotationangle.md

#### TextSignOptions.RotationAngle property

Rotation angle of signature on document page (clockwise).

```csharp
public int RotationAngle { get; set; }
```

### ShapePosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/shapeposition.md

#### TextSignOptions.ShapePosition property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

```csharp
public ShapePosition ShapePosition { get; set; }
```

### ShapeType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/shapetype.md

#### TextSignOptions.ShapeType property

Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

```csharp
public TextShapeType ShapeType { get; set; }
```

### SignatureID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/signatureid.md

#### TextSignOptions.SignatureID property

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only.

```csharp
public int SignatureID { get; set; }
```

### SignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/signatureimplementation.md

#### TextSignOptions.SignatureImplementation property

Gets or sets the type of text signature implementation.

```csharp
public TextSignatureImplementation SignatureImplementation { get; set; }
```

### SizeMeasureType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/sizemeasuretype.md

#### TextSignOptions.SizeMeasureType property

Measure type (pixels, percents or millimeters) for Width and Height properties.

```csharp
public virtual MeasureType SizeMeasureType { get; set; }
```

### Stretch
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/stretch.md

#### TextSignOptions.Stretch property

Stretch mode on Document Page.

```csharp
public StretchMode Stretch { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/text.md

#### TextSignOptions.Text property

Gets or sets the text of signature.

```csharp
public string Text { get; set; }
```

### TextHorizontalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/texthorizontalalignment.md

#### TextSignOptions.TextHorizontalAlignment property

Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see `TextSignatureImplementation` SignatureImplementation property).

```csharp
public TextHorizontalAlignment TextHorizontalAlignment { get; set; }
```

### TextSignOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/textsignoptions.md

#### TextSignOptions()

Initializes a new instance of the TextSignOptions class with default values.

```csharp
public TextSignOptions()
```

#### TextSignOptions(string)

Initializes a new instance of the TextSignOptions class with text.

```csharp
public TextSignOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Signature text. |

### TextVerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/textverticalalignment.md

#### TextSignOptions.TextVerticalAlignment property

Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see `TextSignatureImplementation` SignatureImplementation property).

```csharp
public TextVerticalAlignment TextVerticalAlignment { get; set; }
```

### Top
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/top.md

#### TextSignOptions.Top property

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType property). (works if vertical alignment is not specified).

```csharp
public int Top { get; set; }
```

### Transparency
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/transparency.md

#### TextSignOptions.Transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

```csharp
public double Transparency { get; set; }
```

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/verticalalignment.md

#### TextSignOptions.VerticalAlignment property

Vertical alignment of signature on document page.

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

### Width
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textsignoptions/width.md

#### TextSignOptions.Width property

Width of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

```csharp
public int Width { get; set; }
```

### TextVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions.md

#### TextVerifyOptions class

Keeps options to verify document Text signature.

```csharp
public class TextVerifyOptions : VerifyOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values. |
| TextVerifyOptions(string) | Initializes a new instance of the TextVerifyOptions with verification text. |
| TextVerifyOptions(string, TextSignatureImplementation) | Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| FormTextFieldTitle { get; set; } | Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields. |
| FormTextFieldType { get; set; } | Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields. |
| IsValid { get; } | Valid property flag. |
| MatchType { get; set; } | Gets or sets Text Match Type verification. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| SignatureID { get; set; } | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |
| SignatureImplementation { get; set; } | Type of Signature to be verified. |
| Text { get; set; } | Specify Signature Text if it should be verified. |

### FormTextFieldTitle
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/formtextfieldtitle.md

#### TextVerifyOptions.FormTextFieldTitle property

Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields.

```csharp
public string FormTextFieldTitle { get; set; }
```

### FormTextFieldType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/formtextfieldtype.md

#### TextVerifyOptions.FormTextFieldType property

Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields.

```csharp
public FormTextFieldType? FormTextFieldType { get; set; }
```

### MatchType
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/matchtype.md

#### TextVerifyOptions.MatchType property

Gets or sets Text Match Type verification.

```csharp
public TextMatchType MatchType { get; set; }
```

### SignatureID
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/signatureid.md

#### TextVerifyOptions.SignatureID property

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

```csharp
public int SignatureID { get; set; }
```

### SignatureImplementation
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/signatureimplementation.md

#### TextVerifyOptions.SignatureImplementation property

Type of Signature to be verified.

```csharp
public TextSignatureImplementation SignatureImplementation { get; set; }
```

### Text
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/text.md

#### TextVerifyOptions.Text property

Specify Signature Text if it should be verified.

```csharp
public string Text { get; set; }
```

### TextVerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/textverifyoptions/textverifyoptions.md

#### TextVerifyOptions()

Initializes a new instance of the TextVerifyOptions with default values.

```csharp
public TextVerifyOptions()
```

#### TextVerifyOptions(string)

Initializes a new instance of the TextVerifyOptions with verification text.

```csharp
public TextVerifyOptions(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Text to be verified |

#### TextVerifyOptions(string, TextSignatureImplementation)

Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

```csharp
public TextVerifyOptions(string text, TextSignatureImplementation implementation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Text to be verified. |
| implementation | TextSignatureImplementation | Signature Implementation type. |

### TiffFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/tiffformat.md

#### TiffFormat enumeration

Specifies different tiff formats.

```csharp
public enum TiffFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `0` | Default. |
| TiffLzwBw | `1` | LzwBw. |
| TiffLzwRgb | `2` | LzwRgb. |
| TiffLzwRgba | `3` | LzwRgba. |
| TiffCcittFax3 | `4` | CcittFax3. |
| TiffCcittFax4 | `5` | CcittFax4. |
| TiffDeflateBw | `6` | DeflateBw. |
| TiffDeflateRgb | `7` | DeflateRgb. |
| TiffCcitRle | `8` | CcitRle. |
| TiffJpegRgb | `9` | JpegRgb. |
| TiffJpegYCbCr | `10` | JpegYCbCr. |
| TiffNoCompressionBw | `11` | NoCompressionBw. |
| TiffNoCompressionRgb | `12` | NoCompressionRgb. |
| TiffNoCompressionRgba | `13` | NoCompressionRgba. |

### TiffSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/tiffsaveoptions.md

#### TiffSaveOptions class

Tiff Save options for image documents.

```csharp
public sealed class TiffSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffSaveOptions() | Creates TiffSaveOptions with default values. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| ExpectedTiffFormat { get; set; } | Gets or sets TIFF format of signed document. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### ExpectedTiffFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/tiffsaveoptions/expectedtiffformat.md

#### TiffSaveOptions.ExpectedTiffFormat property

Gets or sets TIFF format of signed document.

```csharp
public TiffFormat ExpectedTiffFormat { get; set; }
```

### TiffSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/tiffsaveoptions/tiffsaveoptions.md

#### TiffSaveOptions constructor

Creates TiffSaveOptions with default values.

```csharp
public TiffSaveOptions()
```

### VerifyExtensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyextensions.md

#### VerifyExtensions class

Keeps additional verification options for alternative implementations of signature on a document page.

```csharp
public abstract class VerifyExtensions
```

### VerifyOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions.md

#### VerifyOptions class

Keeps options to verify document.

```csharp
public abstract class VerifyOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Flag to verify each document page. By default value is true. |
| Extensions { get; set; } | Additional extensions for alternative signature options verification. |
| IsValid { get; } | Valid property flag. |
| virtual PageNumber { get; set; } | Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1. |
| virtual PagesSetup { get; set; } | Page Options to specify pages to be verified. |
| ShapePosition { get; set; } | Specifies shape position in the document layout. For verifing signatures in headers/footers |

### AllPages
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/allpages.md

#### VerifyOptions.AllPages property

Flag to verify each document page. By default value is true.

```csharp
public bool AllPages { get; set; }
```

### Extensions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/extensions.md

#### VerifyOptions.Extensions property

Additional extensions for alternative signature options verification.

```csharp
public VerifyExtensions Extensions { get; set; }
```

### IsValid
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/isvalid.md

#### VerifyOptions.IsValid property

Valid property flag.

```csharp
public bool IsValid { get; }
```

### PageNumber
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/pagenumber.md

#### VerifyOptions.PageNumber property

Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1.

```csharp
public virtual int? PageNumber { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/pagessetup.md

#### VerifyOptions.PagesSetup property

Page Options to specify pages to be verified.

```csharp
public virtual PagesSetup PagesSetup { get; set; }
```

### ShapePosition
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/verifyoptions/shapeposition.md

#### VerifyOptions.ShapePosition property

Specifies shape position in the document layout. For verifing signatures in headers/footers

```csharp
public ShapePosition ShapePosition { get; set; }
```

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Save options for WordProcessing documents.

```csharp
public class WordProcessingSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingSaveOptions() | Initializes a new instance of WordProcessingSaveOptions class with default values. |
| WordProcessingSaveOptions(bool) | Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag. |
| WordProcessingSaveOptions(WordProcessingSaveFileFormat) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format. |
| WordProcessingSaveOptions(WordProcessingSaveFileFormat, bool) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag. |

#### Properties

| Name | Description |
| --- | --- |
| AddMissingExtenstion { get; set; } | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| FileFormat { get; set; } | Gets or sets file format of signed document. |
| OverwriteExistingFiles { get; set; } | Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix. By default this value set to true that means file will be overwritten. |
| Password { get; set; } | Gets or sets password to save signed document with password protection. This property is not supported for Image documents. |
| UseOriginalPassword { get; set; } | Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents. |

### FileFormat
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/wordprocessingsaveoptions/fileformat.md

#### WordProcessingSaveOptions.FileFormat property

Gets or sets file format of signed document.

```csharp
public WordProcessingSaveFileFormat FileFormat { get; set; }
```

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.options/wordprocessingsaveoptions/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions()

Initializes a new instance of WordProcessingSaveOptions class with default values.

```csharp
public WordProcessingSaveOptions()
```

#### WordProcessingSaveOptions(WordProcessingSaveFileFormat)

Initializes a new instance of WordProcessingSaveOptions class with specified output file format.

```csharp
public WordProcessingSaveOptions(WordProcessingSaveFileFormat fileFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | WordProcessingSaveFileFormat | Output file type `WordProcessingSaveFileFormat`. |

#### WordProcessingSaveOptions(bool)

Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag.

```csharp
public WordProcessingSaveOptions(bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

#### WordProcessingSaveOptions(WordProcessingSaveFileFormat, bool)

Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag.

```csharp
public WordProcessingSaveOptions(WordProcessingSaveFileFormat fileFormat, 
    bool overwriteExistingFile)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | WordProcessingSaveFileFormat | Output file type `WordProcessingSaveFileFormat`. |
| overwriteExistingFile | Boolean | Flag whether to overwrite signed file with same file. |

### GroupDocs.Signature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature.md

The namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.

#### Classes

| Class | Description |
| --- | --- |
| GroupDocsSignatureException | Represents the generic errors that occur during document processing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| 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. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |
| ProcessCompleteEventArgs | Provides data on complete event of signing, verification and search processes. |
| ProcessCompleteEventHandler | Represents a method delegate which will handle processes on complete events for signing, verification and search. |
| ProcessEventArgs | Provides data for different events of signature, verification and search processes. |
| ProcessProgressEventArgs | Provides data for OnProgress event of signing, verification and search processes. |
| ProcessProgressEventHandler | Represents a method delegate which will handle processes on progress events for signing, verification and search. |
| ProcessStartEventArgs | Provides data for Start event of signing, verification and search process |
| ProcessStartEventHandler | Represents a method delegate which will handle processes on start events for signing, verification and search. |
| Signature | Represents main class that controls document signing process. |
| SignatureSettings | Defines settings for customizing `Signature` behavior. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.signature.dll -->

### GroupDocsSignatureException
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/groupdocssignatureexception.md

#### GroupDocsSignatureException class

Represents the generic errors that occur during document processing.

```csharp
public class GroupDocsSignatureException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsSignatureException() | Initializes a new instance of the `GroupDocsSignatureException` class. |
| GroupDocsSignatureException(string) | Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message. |
| GroupDocsSignatureException(Exception, string) | Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message and original exception. |

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | Sets the SerializationInfo with information about the exception. |

### GetObjectData
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/groupdocssignatureexception/getobjectdata.md

#### GroupDocsSignatureException.GetObjectData method

Sets the SerializationInfo with information about the exception.

```csharp
public override void GetObjectData(SerializationInfo info, StreamingContext context)
```

| Parameter | Type | Description |
| --- | --- | --- |
| info | SerializationInfo | The SerializationInfo that holds the serialized object data about the exception being thrown. |
| context | StreamingContext | The StreamingContext that contains contextual information about the source or destination. |

### GroupDocsSignatureException
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/groupdocssignatureexception/groupdocssignatureexception.md

#### GroupDocsSignatureException()

Initializes a new instance of the `GroupDocsSignatureException` class.

```csharp
public GroupDocsSignatureException()
```

#### GroupDocsSignatureException(string)

Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message.

```csharp
public GroupDocsSignatureException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### GroupDocsSignatureException(Exception, string)

Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message and original exception.

```csharp
public GroupDocsSignatureException(Exception ex, string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| ex | Exception | The original exception. |
| message | String | The message that describes the error. |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public class IncorrectPasswordException : GroupDocsSignatureException
```

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | Sets the SerializationInfo with information about the exception. |

### License
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/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() | Instantiate the License |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

### License
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/license/license.md

#### License constructor

Instantiate the License

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/license/setlicense.md

#### 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.Signature.lic";
GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
lic.SetLicense(licensePath);
```

#### 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("GroupDocs.Signature.lic", FileMode.Open))
{
    GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
    lic.SetLicense(licenseStream);
}
```

### Metered
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/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. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/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/signature/net/groupdocs.signature/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/signature/net/groupdocs.signature/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/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);
```

### PasswordRequiredException
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

```csharp
public class PasswordRequiredException : GroupDocsSignatureException
```

#### Methods

| Name | Description |
| --- | --- |
| override GetObjectData(SerializationInfo, StreamingContext) | Sets the SerializationInfo with information about the exception. |

### ProcessCompleteEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventargs.md

#### ProcessCompleteEventArgs class

Provides data on complete event of signing, verification and search processes.

```csharp
public class ProcessCompleteEventArgs : ProcessEventArgs
```

#### Properties

| Name | Description |
| --- | --- |
| Canceled { get; } | Indicates whether process was canceled. |
| Completed { get; set; } | Represents the time mark of process completion. |
| Status { get; set; } | Indicates current process state. |
| Ticks { get; set; } | Represents the time in milliseconds spent since process Start event. |
| TotalSignatures { get; set; } | Represents the total quantity of processed signatures. |

### Canceled
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventargs/canceled.md

#### ProcessCompleteEventArgs.Canceled property

Indicates whether process was canceled.

```csharp
public bool Canceled { get; }
```

### Completed
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventargs/completed.md

#### ProcessCompleteEventArgs.Completed property

Represents the time mark of process completion.

```csharp
public DateTime Completed { get; set; }
```

### Ticks
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventargs/ticks.md

#### ProcessCompleteEventArgs.Ticks property

Represents the time in milliseconds spent since process Start event.

```csharp
public long Ticks { get; set; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventargs/totalsignatures.md

#### ProcessCompleteEventArgs.TotalSignatures property

Represents the total quantity of processed signatures.

```csharp
public int TotalSignatures { get; set; }
```

### ProcessCompleteEventHandler
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processcompleteeventhandler.md

#### ProcessCompleteEventHandler delegate

Represents a method delegate which will handle processes on complete events for signing, verification and search.

```csharp
public delegate void ProcessCompleteEventHandler(Signature signature, 
    ProcessCompleteEventArgs args);
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature | Signature object |
| args | ProcessCompleteEventArgs | Arguments `ProcessCompleteEventArgs`that specify properties of Completed event. |

### ProcessEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processeventargs.md

#### ProcessEventArgs class

Provides data for different events of signature, verification and search processes.

```csharp
public class ProcessEventArgs : EventArgs
```

#### Constructors

| Name | Description |
| --- | --- |
| ProcessEventArgs() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Status { get; set; } | Indicates current process state. |

### ProcessEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processeventargs/processeventargs.md

#### ProcessEventArgs constructor

The default constructor.

```csharp
public ProcessEventArgs()
```

### Status
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processeventargs/status.md

#### ProcessEventArgs.Status property

Indicates current process state.

```csharp
public ProcessStatus Status { get; set; }
```

### ProcessProgressEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs.md

#### ProcessProgressEventArgs class

Provides data for OnProgress event of signing, verification and search processes.

```csharp
public class ProcessProgressEventArgs : ProcessEventArgs
```

#### Constructors

| Name | Description |
| --- | --- |
| ProcessProgressEventArgs() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Cancel { get; set; } | Indicates whether process should be canceled. |
| ProcessedSignatures { get; set; } | Represents the quantity of processed signatures. |
| Progress { get; set; } | Represents the progress in percents. Value range is from 0 to 100. |
| Status { get; set; } | Indicates current process state. |
| Ticks { get; set; } | Represents the time spent in milliseconds since process Start event. |

### Cancel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs/cancel.md

#### ProcessProgressEventArgs.Cancel property

Indicates whether process should be canceled.

```csharp
public bool Cancel { get; set; }
```

### ProcessedSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs/processedsignatures.md

#### ProcessProgressEventArgs.ProcessedSignatures property

Represents the quantity of processed signatures.

```csharp
public int ProcessedSignatures { get; set; }
```

### ProcessProgressEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs/processprogresseventargs.md

#### ProcessProgressEventArgs constructor

The default constructor.

```csharp
public ProcessProgressEventArgs()
```

### Progress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs/progress.md

#### ProcessProgressEventArgs.Progress property

Represents the progress in percents. Value range is from 0 to 100.

```csharp
public int Progress { get; set; }
```

### Ticks
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventargs/ticks.md

#### ProcessProgressEventArgs.Ticks property

Represents the time spent in milliseconds since process Start event.

```csharp
public long Ticks { get; set; }
```

### ProcessProgressEventHandler
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processprogresseventhandler.md

#### ProcessProgressEventHandler delegate

Represents a method delegate which will handle processes on progress events for signing, verification and search.

```csharp
public delegate void ProcessProgressEventHandler(Signature signature, 
    ProcessProgressEventArgs args);
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature | Signature object |
| args | ProcessProgressEventArgs | Arguments `ProcessProgressEventArgs`that specify properties of Progress event. |

### ProcessStartEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processstarteventargs.md

#### ProcessStartEventArgs class

Provides data for Start event of signing, verification and search process

```csharp
public class ProcessStartEventArgs : ProcessEventArgs
```

#### Constructors

| Name | Description |
| --- | --- |
| ProcessStartEventArgs() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| Started { get; set; } | Represents the time mark of process start. |
| Status { get; set; } | Indicates current process state. |
| TotalSignatures { get; set; } | Represents the total quantity of signatures to be processed. |

### ProcessStartEventArgs
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processstarteventargs/processstarteventargs.md

#### ProcessStartEventArgs constructor

The default constructor.

```csharp
public ProcessStartEventArgs()
```

### Started
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processstarteventargs/started.md

#### ProcessStartEventArgs.Started property

Represents the time mark of process start.

```csharp
public DateTime Started { get; set; }
```

### TotalSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processstarteventargs/totalsignatures.md

#### ProcessStartEventArgs.TotalSignatures property

Represents the total quantity of signatures to be processed.

```csharp
public int TotalSignatures { get; set; }
```

### ProcessStartEventHandler
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/processstarteventhandler.md

#### ProcessStartEventHandler delegate

Represents a method delegate which will handle processes on start events for signing, verification and search.

```csharp
public delegate void ProcessStartEventHandler(Signature signature, ProcessStartEventArgs args);
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature | Signature object |
| args | ProcessStartEventArgs | Arguments `ProcessStartEventArgs`that specify properties of Start event. |

### Signature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature.md

#### Signature class

Represents main class that controls document signing process.

```csharp
public class Signature : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Signature(Stream) | Initializes new instance of `Signature` class with document provided by stream. |
| Signature(string) | Initializes new instance of `Signature` class instance with document provided by file path. |
| Signature(Stream, LoadOptions) | Initializes new instance of `Signature` class with document provided by stream and load options LoadOptions. |
| Signature(Stream, SignatureSettings) | Initializes new instance of `Signature` class instance with document provided by stream and `SignatureSettings`. |
| Signature(string, LoadOptions) | Initializes new instance of `Signature` class instance with document provided by file path and LoadOptions. |
| Signature(string, SignatureSettings) | Initializes new instance of `Signature` class instance with document provided by file path and `SignatureSettings`. |
| Signature(Stream, LoadOptions, SignatureSettings) | Initializes new instance of `Signature` class instance with document provided by stream, load options LoadOptions and settings `SignatureSettings`. |
| Signature(string, LoadOptions, SignatureSettings) | Initializes new instance of `Signature` class instance with document provided by file path, LoadOptions and `SignatureSettings`. |

#### Methods

| Name | Description |
| --- | --- |
| Delete(BaseSignature) | Deletes passed signature `BaseSignature` from the document. |
| Delete(List&lt;BaseSignature&gt;) | Deletes passed list of signatures `BaseSignature` from the document. |
| Delete(List&lt;SignatureType&gt;) | Deletes the signatures of the certain types list `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `IsSignature` will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code |
| Delete(List&lt;string&gt;) | Deletes passed list of signatures `BaseSignature` from the document. |
| Delete(SignatureType) | Deletes signatures of the certain type `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `IsSignature` will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code |
| Delete(string) | Deletes signature by its specific signature Id from the document. |
| Dispose() | Implement IDisposable interface to clean up internal resources |
| GeneratePreview(PreviewOptions) | Generates document pages preview. |
| GetDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| Search(Func&lt;BaseSignature, bool&gt;) | Searches for signatures in the document using all available search options and filters the results based on the specified predicate. |
| Search(List&lt;SearchOptions&gt;) | Searches for signatures in a document by `SearchOptions` list. |
| Search(params SignatureType[]) | Searches for specified signature types in the document by `SignatureType` value. |
| Search(List&lt;SearchOptions&gt;, Func&lt;BaseSignature, bool&gt;) | Searches for signatures in the document using the provided search options and filters the results based on the specified predicate. |
| Search&lt;T&gt;(SearchOptions) | Searches for signatures in a document by `SearchOptions` options. |
| Search&lt;T&gt;(SignatureType) | Searches for exact type of signatures in the document by `SignatureType` value. |
| Sign(Stream, List&lt;SignOptions&gt;) | Signs document with collection of `SignOptions` and saves result to a stream. |
| Sign(Stream, SignOptions) | Signs document with `SignOptions` and saves result to a stream. |
| Sign(string, List&lt;SignOptions&gt;) | Signs document with collection of `SignOptions` and saves result to specified file path. |
| Sign(string, SignOptions) | Signs document with `SignOptions` and saves result to specified file path. |
| Sign(Stream, List&lt;SignOptions&gt;, SaveOptions) | Signs document with collection of `SignOptions` and saves result to a stream with predefined `SaveOptions`. |
| Sign(Stream, SignOptions, SaveOptions) | Signs document with `SignOptions` and saves result to a stream with predefined `SaveOptions`. |
| Sign(string, List&lt;SignOptions&gt;, SaveOptions) | Signs document with collection of `SignOptions` and saves result to specified file path with predefined `SaveOptions`. |
| Sign(string, SignOptions, SaveOptions) | Signs document with `SignOptions` and saves result to specified file path with predefined `SaveOptions`. |
| Update(BaseSignature) | Updates passed signature `BaseSignature` in the document. |
| Update(List&lt;BaseSignature&gt;) | Updates passed signatures `BaseSignature` in the document. |
| Verify(List&lt;VerifyOptions&gt;) | Verifies the document signatures with list of VerifyOptions data. |
| Verify(VerifyOptions) | Verifies the document signatures with given VerifyOptions data. |
| Verify(List&lt;VerifyOptions&gt;, Func&lt;BaseSignature, bool&gt;) | Verifies the document signatures using all available verification options and filters the results based on the specified predicate. This method first searches for signatures matching the verification options, filters them using the predicate, and then verifies only those filtered signatures. |
| Verify(VerifyOptions, Func&lt;BaseSignature, bool&gt;) | Verifies the document signatures using the provided verification options and filters the results based on the specified predicate. This method first searches for signatures matching the verification options, filters them using the predicate, and then verifies only those filtered signatures. |
| static GenerateSignaturePreview(PreviewSignatureOptions) | Generates Signature preview based on given SignOptions. `SignOptions` |

#### Events

| Name | Description |
| --- | --- |
| event SearchCompleted | Occurs when signature search process completed. |
| event SearchProgress | Occurs when signature search process progress changed. |
| event SearchStarted | Occurs when signature search process started. |
| event SignCompleted | Occurs when document signing process completed. |
| event SignProgress | Occurs when document signing process progress changed. |
| event SignStarted | Occurs when document signing process started. |
| event VerifyCompleted | Occurs when signature verification process completed. |
| event VerifyProgress | Occurs when signature verification process progress changed. |
| event VerifyStarted | Occurs when signature verification process started. |

##### Remarks

More about GroupDocs.Signature features: [GroupDocs.Signature Developer Guide](https://docs.groupdocs.com/display/signaturenet/Developer+Guide)

### Delete
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/delete.md

#### Delete(BaseSignature)

Deletes passed signature `BaseSignature` from the document.

```csharp
public bool Delete(BaseSignature signature)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | BaseSignature | Signature object to be removed from the document. |

##### Return Value

Returns true if operation was successful.

#### Delete(List&lt;BaseSignature&gt;)

Deletes passed list of signatures `BaseSignature` from the document.

```csharp
public DeleteResult Delete(List<BaseSignature> signatures)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatures | List`1 | List of signatures to remove from the document. |

##### Return Value

Returns DeleteResult `DeleteResult` with list of successfully deleted signatures and failed ones.

#### Delete(SignatureType)

Deletes signatures of the certain type `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `IsSignature` will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

```csharp
public DeleteResult Delete(SignatureType signatureType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureType | SignatureType | The type of signatures to be removed from the document. |

##### Return Value

Returns DeleteResult `DeleteResult` with list of successfully deleted signatures and failed ones.

#### Delete(List&lt;SignatureType&gt;)

Deletes the signatures of the certain types list `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `IsSignature` will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

```csharp
public DeleteResult Delete(List<SignatureType> signatureTypes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureTypes | List`1 | The list of signatures types to be removed from the document. |

##### Return Value

Returns DeleteResult `DeleteResult` with list of successfully deleted signatures and failed ones.

#### Delete(string)

Deletes signature by its specific signature Id from the document.

```csharp
public bool Delete(string signatureId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | String | The Id of the signature to be removed from the document. |

##### Return Value

Returns true if operation was successful.

#### Delete(List&lt;string&gt;)

Deletes passed list of signatures `BaseSignature` from the document.

```csharp
public DeleteResult Delete(List<string> signatureIds)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureIds | List`1 | List of the identifiers of the signatures to be removed from the document. |

##### Return Value

Returns DeleteResult `DeleteResult` with list of successfully deleted signatures and failed ones.

### Dispose
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/dispose.md

#### Signature.Dispose method

Implement IDisposable interface to clean up internal resources

```csharp
public void Dispose()
```

### GeneratePreview
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/generatepreview.md

#### Signature.GeneratePreview method

Generates document pages preview.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The preview options. |

### GenerateSignaturePreview
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/generatesignaturepreview.md

#### Signature.GenerateSignaturePreview method

Generates Signature preview based on given SignOptions. `SignOptions`

```csharp
public static void GenerateSignaturePreview(PreviewSignatureOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewSignatureOptions | The preview signature with given SignOptions. `PreviewSignatureOptions` |

### GetDocumentInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/getdocumentinfo.md

#### Signature.GetDocumentInfo method

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

Information about document.

### Search
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/search.md

#### Search(List&lt;SearchOptions&gt;)

Searches for signatures in a document by `SearchOptions` list.

```csharp
public SearchResult Search(List<SearchOptions> searchOptionsList)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchOptionsList | List`1 | The search options collection. |

##### Return Value

Returns instance of `SearchResult` with list of found Signatures.

#### Search(List&lt;SearchOptions&gt;, Func&lt;BaseSignature, bool&gt;)

Searches for signatures in the document using the provided search options and filters the results based on the specified predicate.

```csharp
public SearchResult Search(List<SearchOptions> searchOptionsList, 
    Func<BaseSignature, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchOptionsList | List`1 | A list of `SearchOptions` instances defining the criteria for searching signatures. |
| predicate | Func`2 | The filter predicate to apply on the list of found signatures. |

##### Return Value

Returns a `SearchResult` containing the signatures that match the specified search options and satisfy the predicate.

#### Search&lt;T&gt;(SearchOptions)

Searches for signatures in a document by `SearchOptions` options.

```csharp
public List<T> Search<T>(SearchOptions searchOptions)
    where T : BaseSignature
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchOptions | SearchOptions | The search options. |

##### Return Value

Returns the list of signatures found.

#### Search&lt;T&gt;(SignatureType)

Searches for exact type of signatures in the document by `SignatureType` value.

```csharp
public List<T> Search<T>(SignatureType signatureType)
    where T : BaseSignature
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureType | SignatureType | The type of signatures to search. |

##### Return Value

Returns the list of found signatures with exact type.

#### Search(params SignatureType[])

Searches for specified signature types in the document by `SignatureType` value.

```csharp
public SearchResult Search(params SignatureType[] signatureTypes)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatureTypes | SignatureType[] | One or several types of signatures to find. |

##### Return Value

Returns instance of `SearchResult` with list of found signatures.

#### Search(Func&lt;BaseSignature, bool&gt;)

Searches for signatures in the document using all available search options and filters the results based on the specified predicate.

```csharp
public List<BaseSignature> Search(Func<BaseSignature, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| predicate | Func`2 | The filter predicate to apply on the list of found signatures. |

##### Return Value

Returns a list of `BaseSignature` instances that satisfy the provided predicate.

### SearchCompleted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/searchcompleted.md

#### Signature.SearchCompleted event

Occurs when signature search process completed.

```csharp
public event ProcessCompleteEventHandler SearchCompleted;
```

### SearchProgress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/searchprogress.md

#### Signature.SearchProgress event

Occurs when signature search process progress changed.

```csharp
public event ProcessProgressEventHandler SearchProgress;
```

### SearchStarted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/searchstarted.md

#### Signature.SearchStarted event

Occurs when signature search process started.

```csharp
public event ProcessStartEventHandler SearchStarted;
```

### Sign
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/sign.md

#### Sign(Stream, SignOptions)

Signs document with `SignOptions` and saves result to a stream.

```csharp
public SignResult Sign(Stream document, SignOptions signOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output document stream. |
| signOptions | SignOptions | The signature options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(Stream, SignOptions, SaveOptions)

Signs document with `SignOptions` and saves result to a stream with predefined `SaveOptions`.

```csharp
public SignResult Sign(Stream document, SignOptions signOptions, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output document stream. |
| signOptions | SignOptions | The signature options. |
| saveOptions | SaveOptions | The save options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(Stream, List&lt;SignOptions&gt;)

Signs document with collection of `SignOptions` and saves result to a stream.

```csharp
public SignResult Sign(Stream document, List<SignOptions> signOptionsList)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output document stream. |
| signOptionsList | List`1 | The list of signature options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(Stream, List&lt;SignOptions&gt;, SaveOptions)

Signs document with collection of `SignOptions` and saves result to a stream with predefined `SaveOptions`.

```csharp
public SignResult Sign(Stream document, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The output document stream. |
| signOptionsList | List`1 | The list of signature options. |
| saveOptions | SaveOptions | The save options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(string, SignOptions)

Signs document with `SignOptions` and saves result to specified file path.

```csharp
public SignResult Sign(string filePath, SignOptions signOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |
| signOptions | SignOptions | The signature options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(string, SignOptions, SaveOptions)

Signs document with `SignOptions` and saves result to specified file path with predefined `SaveOptions`.

```csharp
public SignResult Sign(string filePath, SignOptions signOptions, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |
| signOptions | SignOptions | The signature options. |
| saveOptions | SaveOptions | The save options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(string, List&lt;SignOptions&gt;)

Signs document with collection of `SignOptions` and saves result to specified file path.

```csharp
public SignResult Sign(string filePath, List<SignOptions> signOptionsList)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |
| signOptionsList | List`1 | The list of signature options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

#### Sign(string, List&lt;SignOptions&gt;, SaveOptions)

Signs document with collection of `SignOptions` and saves result to specified file path with predefined `SaveOptions`.

```csharp
public SignResult Sign(string filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The output file path. |
| signOptionsList | List`1 | The list of signature options. |
| saveOptions | SaveOptions | The save options. |

##### Return Value

Returns instance of `SignResult` with list of newly created signatures.

### Signature
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/signature.md

#### Signature(Stream)

Initializes new instance of `Signature` class with document provided by stream.

```csharp
public Signature(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The document content stream. |

#### Signature(Stream, LoadOptions)

Initializes new instance of `Signature` class with document provided by stream and load options LoadOptions.

```csharp
public Signature(Stream document, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The document content stream. |
| loadOptions | LoadOptions | The document load options. |

#### Signature(Stream, SignatureSettings)

Initializes new instance of `Signature` class instance with document provided by stream and `SignatureSettings`.

```csharp
public Signature(Stream document, SignatureSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The document content stream. |
| settings | SignatureSettings | The signature settings. |

#### Signature(Stream, LoadOptions, SignatureSettings)

Initializes new instance of `Signature` class instance with document provided by stream, load options LoadOptions and settings `SignatureSettings`.

```csharp
public Signature(Stream document, LoadOptions loadOptions, SignatureSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The document content stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | SignatureSettings | The signature settings. |

#### Signature(string)

Initializes new instance of `Signature` class instance with document provided by file path.

```csharp
public Signature(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute or relative file path. |

#### Signature(string, LoadOptions)

Initializes new instance of `Signature` class instance with document provided by file path and LoadOptions.

```csharp
public Signature(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute or relative file path. |
| loadOptions | LoadOptions | The document load options. |

#### Signature(string, SignatureSettings)

Initializes new instance of `Signature` class instance with document provided by file path and `SignatureSettings`.

```csharp
public Signature(string filePath, SignatureSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute or relative file path. |
| settings | SignatureSettings | The signature settings. |

#### Signature(string, LoadOptions, SignatureSettings)

Initializes new instance of `Signature` class instance with document provided by file path, LoadOptions and `SignatureSettings`.

```csharp
public Signature(string filePath, LoadOptions loadOptions, SignatureSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute or relative file path. |
| loadOptions | LoadOptions | The document load options. |
| settings | SignatureSettings | The signature settings. |

### SignCompleted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/signcompleted.md

#### Signature.SignCompleted event

Occurs when document signing process completed.

```csharp
public event ProcessCompleteEventHandler SignCompleted;
```

### SignProgress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/signprogress.md

#### Signature.SignProgress event

Occurs when document signing process progress changed.

```csharp
public event ProcessProgressEventHandler SignProgress;
```

### SignStarted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/signstarted.md

#### Signature.SignStarted event

Occurs when document signing process started.

```csharp
public event ProcessStartEventHandler SignStarted;
```

### Update
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/update.md

#### Update(BaseSignature)

Updates passed signature `BaseSignature` in the document.

```csharp
public bool Update(BaseSignature signature)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signature | BaseSignature | Signature object to be updated in the document. |

##### Return Value

Returns true if operation was successful.

#### Update(List&lt;BaseSignature&gt;)

Updates passed signatures `BaseSignature` in the document.

```csharp
public UpdateResult Update(List<BaseSignature> signatures)
```

| Parameter | Type | Description |
| --- | --- | --- |
| signatures | List`1 | List of signatures to update in the document. |

##### Return Value

Returns UpdateResult `UpdateResult` with list of successfully updated signatures and failed ones.

### Verify
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/verify.md

#### Verify(VerifyOptions)

Verifies the document signatures with given VerifyOptions data.

```csharp
public VerificationResult Verify(VerifyOptions verifyOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptions | VerifyOptions | The signature verification options. |

##### Return Value

Returns instance of `VerificationResult`. Property VerificationResult.IsValid returns true if verification process was successful.

#### Verify(VerifyOptions, Func&lt;BaseSignature, bool&gt;)

Verifies the document signatures using the provided verification options and filters the results based on the specified predicate. This method first searches for signatures matching the verification options, filters them using the predicate, and then verifies only those filtered signatures.

```csharp
public List<BaseSignature> Verify(VerifyOptions verifyOptions, Func<BaseSignature, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptions | VerifyOptions | The signature verification options. |
| predicate | Func`2 | The filter predicate to determine which signatures should be verified. |

##### Return Value

Returns a list of `BaseSignature` instances that satisfy the provided predicate.

#### Verify(List&lt;VerifyOptions&gt;)

Verifies the document signatures with list of VerifyOptions data.

```csharp
public VerificationResult Verify(List<VerifyOptions> verifyOptionsList)
```

| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptionsList | List`1 | The signature verification options collection. Instance of VerifyOptionsCollection. |

##### Return Value

Returns instance of `VerificationResult`. Property VerificationResult.IsValid returns true if verification process was successful.

#### Verify(List&lt;VerifyOptions&gt;, Func&lt;BaseSignature, bool&gt;)

Verifies the document signatures using all available verification options and filters the results based on the specified predicate. This method first searches for signatures matching the verification options, filters them using the predicate, and then verifies only those filtered signatures.

```csharp
public List<BaseSignature> Verify(List<VerifyOptions> verifyOptionsList, 
    Func<BaseSignature, bool> predicate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptionsList | List`1 | The signature verification options collection. Instance of VerifyOptionsCollection. |
| predicate | Func`2 | The filter predicate to determine which signatures should be verified. |

##### Return Value

Returns a list of `BaseSignature` instances that satisfy the provided predicate.

### VerifyCompleted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/verifycompleted.md

#### Signature.VerifyCompleted event

Occurs when signature verification process completed.

```csharp
public event ProcessCompleteEventHandler VerifyCompleted;
```

### VerifyProgress
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/verifyprogress.md

#### Signature.VerifyProgress event

Occurs when signature verification process progress changed.

```csharp
public event ProcessProgressEventHandler VerifyProgress;
```

### VerifyStarted
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signature/verifystarted.md

#### Signature.VerifyStarted event

Occurs when signature verification process started.

```csharp
public event ProcessStartEventHandler VerifyStarted;
```

### SignatureSettings
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings.md

#### SignatureSettings class

Defines settings for customizing `Signature` behavior.

```csharp
public class SignatureSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| SignatureSettings() | Creates default SignatureSettings instance with default values. |
| SignatureSettings(ILogger) | Creates default SignatureSettings instance with the Logger implementation. |

#### Properties

| Name | Description |
| --- | --- |
| DefaultCulture { get; set; } | Gets or sets default culture to be used during document processing. Default value is "en-US". |
| IncludeStandardMetadataSignatures { get; set; } | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures. |
| Logger { get; } | The logger implementation used for logging (Errors, Warnings, Traces). `ILogger`. |
| LogLevel { get; set; } | The level of the logging to limit the messages (All, Traces, Warnings, Errors). `LogLevel`. BY default the All level type is set. |
| SaveDocumentOnEmptyDelete { get; set; } | Gets or sets flag to re-save source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all. |
| SaveDocumentOnEmptyUpdate { get; set; } | Gets or sets flag to re-save source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all. |
| ShowDeletedSignaturesInfo { get; set; } | Gets or sets flag that includes deleted signatures into Document Info result. Each Signature `BaseSignature` has Deleted flag `Deleted` to detect if it was deleted. |

### DefaultCulture
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/defaultculture.md

#### SignatureSettings.DefaultCulture property

Gets or sets default culture to be used during document processing. Default value is "en-US".

```csharp
public CultureInfo DefaultCulture { get; set; }
```

### IncludeStandardMetadataSignatures
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/includestandardmetadatasignatures.md

#### SignatureSettings.IncludeStandardMetadataSignatures property

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures.

```csharp
public bool IncludeStandardMetadataSignatures { get; set; }
```

### Logger
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/logger.md

#### SignatureSettings.Logger property

The logger implementation used for logging (Errors, Warnings, Traces). `ILogger`.

```csharp
public ILogger Logger { get; }
```

### LogLevel
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/loglevel.md

#### SignatureSettings.LogLevel property

The level of the logging to limit the messages (All, Traces, Warnings, Errors). `LogLevel`. BY default the All level type is set.

```csharp
public LogLevel LogLevel { get; set; }
```

### SaveDocumentOnEmptyDelete
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/savedocumentonemptydelete.md

#### SignatureSettings.SaveDocumentOnEmptyDelete property

Gets or sets flag to re-save source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all.

```csharp
public bool SaveDocumentOnEmptyDelete { get; set; }
```

### SaveDocumentOnEmptyUpdate
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/savedocumentonemptyupdate.md

#### SignatureSettings.SaveDocumentOnEmptyUpdate property

Gets or sets flag to re-save source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all.

```csharp
public bool SaveDocumentOnEmptyUpdate { get; set; }
```

### ShowDeletedSignaturesInfo
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/showdeletedsignaturesinfo.md

#### SignatureSettings.ShowDeletedSignaturesInfo property

Gets or sets flag that includes deleted signatures into Document Info result. Each Signature `BaseSignature` has Deleted flag `Deleted` to detect if it was deleted.

```csharp
public bool ShowDeletedSignaturesInfo { get; set; }
```

### SignatureSettings
Path: https://reference.groupdocs.com/signature/net/groupdocs.signature/signaturesettings/signaturesettings.md

#### SignatureSettings()

Creates default SignatureSettings instance with default values.

```csharp
public SignatureSettings()
```

#### SignatureSettings(ILogger)

Creates default SignatureSettings instance with the Logger implementation.

```csharp
public SignatureSettings(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger |  |

## Node.js

### GroupDocs.Signature for Node.js via Java
Path: https://reference.groupdocs.com/signature/nodejs-java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.signature | The **GroupDocs.Signature** namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures. |
| com.groupdocs.signature.domain | The **GroupDocs.Signature.Domain** namespace provides classes for working with document representation. |
| com.groupdocs.signature.domain.barcodes | The **GroupDocs.Signature.Domain.Barcodes** namespace provides classes for working with Barcodes |
| com.groupdocs.signature.domain.documentpreview | The **GroupDocs.Signature.Domain.DocumentPreview** namespace provides classes for working with document representation. |
| com.groupdocs.signature.domain.enums | The **GroupDocs.Signature.Domain.Enums** namespace provides classes for working with Enums |
| com.groupdocs.signature.domain.extensions | The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality. |
| com.groupdocs.signature.domain.extensions.encryption | The **GroupDocs.Signature.Domain.Extensions.Encryption** namespace provides classes for working with Encryption |
| com.groupdocs.signature.domain.extensions.hibclic | The **GroupDocs.Signature.Domain.Extensions.HIBCLIC** namespace provides classes for working with HIBCLIC |
| com.groupdocs.signature.domain.extensions.mailmark2d | The **GroupDocs.Signature.Domain.Extensions.MailMark2D** namespace provides classes for working with MailMark2D |
| com.groupdocs.signature.domain.extensions.serialization | The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality. |
| com.groupdocs.signature.domain.extensions.signoptions | The **GroupDocs.Signature.Domain.Extensions.SignOptions** namespace provides classes for working with SignOptions |
| com.groupdocs.signature.domain.extensions.swissqr | The **GroupDocs.Signature.Domain.Extensions.SwissQR** namespace provides classes for working with SwissQR |
| com.groupdocs.signature.domain.interfaces | The **GroupDocs.Signature.Domain.Interfaces** namespace provides classes for working with Interfaces |
| com.groupdocs.signature.domain.qrcodes | The **GroupDocs.Signature.Domain.QRCodes** namespace provides classes for working with QRCodes |
| com.groupdocs.signature.domain.signatures | The **GroupDocs.Signature.Domain.Signatures** namespace provides classes for working with Signatures |
| com.groupdocs.signature.domain.signatures.formfield | The **GroupDocs.Signature.Domain.Signatures.FormField** namespace provides classes for working with FormField signatures |
| com.groupdocs.signature.domain.signatures.metadata | The **GroupDocs.Signature.Domain.Signatures.Metadata** namespace provides classes for working with Metadata signatures |
| com.groupdocs.signature.domain.stamps | The **GroupDocs.Signature.Domain.Stamps** namespace provides classes for working with Stamps. |
| com.groupdocs.signature.domain.structs |  |
| com.groupdocs.signature.exception | The **GroupDocs.Signature.Exception** namespace provides classes to handle Signature exceptions. |
| com.groupdocs.signature.handler.events | The **GroupDocs.Signature.Handler.Events** namespace provides classes for input and output Data Handlers. |
| com.groupdocs.signature.licensing | The **GroupDocs.Signature.Licensing** namespace provides classes for licensing the Signature library. |
| com.groupdocs.signature.logging | The **GroupDocs.Signature.Logging** namespace provides classes for logging purposes. |
| com.groupdocs.signature.metered | Provides methods to set metered key. |
| com.groupdocs.signature.options | The **GroupDocs.Signature.Options** namespace provides classes to specify additional options when loading, signing, verifyin, searching and saving documents. |
| com.groupdocs.signature.options.appearances | The **GroupDocs.Signature.Options.Appearances** namespace provides classes for additional signature appearances. |
| com.groupdocs.signature.options.loadoptions | The **GroupDocs.Signature.Options.LoadOptions** namespace provides classes for working with LoadOptions options. |
| com.groupdocs.signature.options.preview |  |
| com.groupdocs.signature.options.saveoptions | The **GroupDocs.Signature.Options.SaveOptions** namespace provides classes for working with SaveOptions options. |
| com.groupdocs.signature.options.saveoptions.imagessaveoptions | The **GroupDocs.Signature.Options.SaveOptions.ImageSaveOptions** namespace provides classes for working with ImageSaveOptions options. |
| com.groupdocs.signature.options.search | The **GroupDocs.Signature.Options.Search** namespace provides classes for working with Search options. |
| com.groupdocs.signature.options.sign | The **GroupDocs.Signature.Options.Sign** namespace provides classes for working with Signature options |
| com.groupdocs.signature.options.verify | The **GroupDocs.Signature.Options.Verify** namespace provides classes for working with Verification options |
| com.groupdocs.signature.options.verifyextensions | The **GroupDocs.Signature.Options.VerifyExtensions** namespace provides classes for working with VerifyExtensions options. |

### com.groupdocs.signature.domain.barcodes
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.barcodes.md

The **GroupDocs.Signature.Domain.Barcodes** namespace provides classes for working with Barcodes

#### Classes

| Class | Description |
| --- | --- |
| BarcodeType | Specify Barcode type properties. |
| BarcodeTypes | Barcode Types container. |

### BarcodeType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.barcodes/barcodetype.md

**Inheritance:**
java.lang.Object
```
public final class BarcodeType
```

Specify Barcode type properties.
#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Get Index of object in collection of supported Barcode types. |
| getTypeName() | Name of Barcode Type. |
| equals(BarcodeType other) | Determines whether the specified BarcodeType is equal to the current object. |
| equals(Object obj) | Overridden method determines whether the specified System.Object is equal to the current System.Object. |
| hashCode() | Overridden method serves as a hash function for a particular type. |
| toString() | Overridden method serves as conversion to string type. |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Get Index of object in collection of supported Barcode types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Name of Barcode Type.

**Returns:**
java.lang.String
##### equals(BarcodeType other)
```
public final boolean equals(BarcodeType other)
```

Determines whether the specified BarcodeType is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | BarcodeType | Object for comparison. |

**Returns:**
boolean - Result of comparison.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overridden method determines whether the specified System.Object is equal to the current System.Object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Object for comparison. |

**Returns:**
boolean - Result of comparison.
##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash code.
##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - Returns a string that represents the current object.

### BarcodeTypes
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.barcodes/barcodetypes.md

**Inheritance:**
java.lang.Object
```
public class BarcodeTypes
```

Barcode Types container.
#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| AustralianPosteParcel | Australian Post eParcel Barcode Type object. |
| AustralianPost | Australian Post Barcode Type object. |
| Codabar | Codabar Barcode Type object. |
| CodablockF | CodablockF Barcode Type object. |
| Code11 | Code11 Barcode Type object. |
| Code128 | Code128 Barcode Type object. |
| Code16K | Code16K Barcode Type object. |
| Code32 | Code32 Barcode Type object. |
| Code39Extended | Code39Extended Barcode Type object. |
| Code39Standard | Code39Standard Barcode Type object. |
| Code93Extended | Code93Extended Barcode Type object. |
| Code93Standard | Code93Standard Barcode Type object. |
| DatabarExpanded | DatabarExpanded Barcode Type object. |
| DatabarExpandedStacked | DatabarExpandedStacked Barcode Type object. |
| DatabarLimited | DatabarLimited Barcode Type object. |
| DatabarOmniDirectional | DatabarOmniDirectional Barcode Type object. |
| DatabarStacked | DatabarStacked Barcode Type object. |
| DatabarStackedOmniDirectional | DatabarStackedOmniDirectional Barcode Type object. |
| DatabarTruncated | DatabarTruncated Barcode Type object. |
| DataLogic2of5 | DataLogic2of5 Barcode Type object. |
| DeutschePostIdentcode | DeutschePostIdentcode Barcode Type object. |
| DeutschePostLeitcode | DeutschePostLeitcode Barcode Type object. |
| DotCode | DotCode Barcode Type object. |
| DutchKIX | DutchKIX Barcode Type object. |
| EAN8 | EAN8 Barcode Type object. |
| EAN13 | EAN13 Barcode Type object. |
| EAN14 | EAN14 Barcode Type object. |
| GS1CodablockF | GS1CodablockF Barcode Type object. |
| GS1Code128 | GS1 Code128 Barcode Type object. |
| GS1CompositeBar | GS1 Composite Barcode Type object. |
| IATA2of5 | IATA2of5 Barcode Type object. |
| Interleaved2of5 | Interleaved2of5 Barcode Type object. |
| ISBN | ISBN Barcode Type object. |
| ISMN | ISMN Barcode Type object. |
| ISSN | ISSN Barcode Type object. |
| ItalianPost25 | ItalianPost25 Barcode Type object. |
| ITF14 | ITF14 Barcode Type object. |
| ITF6 | ITF6 Barcode Type object. |
| MacroPdf417 | MacroPdf417 Barcode Type object. |
| Mailmark | Royal Mail 2D Mailmark Barcode Type object. |
| Matrix2of5 | Matrix2of5 Barcode Type object. |
| MaxiCode | MaxiCode Barcode Type object. |
| MicroPdf417 | MicroPdf417 Barcode Type object. |
| MSI | MSI Barcode Type object. |
| OneCode | OneCode Barcode Type object. |
| OPC | OPC Barcode Type object. |
| PatchCode | Patch Code Barcode Type object. |
| Pdf417 | Pdf417 Barcode Type object. |
| Pharmacode | Pharma code Barcode Type object. |
| Planet | Planet Barcode Type object. |
| Postnet | Postnet Barcode Type object. |
| PZN | PZN Barcode Type object. |
| RM4SCC | RM4SCC Barcode Type object. |
| SCC14 | SCC14 Barcode Type object. |
| SingaporePost | SingaporePost Barcode Type object. |
| SSCC18 | SSCC18 Barcode Type object. |
| Standard2of5 | Standard2of5 Barcode Type object. |
| SwissPostParcel | SwissPostParcel Barcode Type object. |
| UPCA | UPCA Barcode Type object. |
| UpcaGs1Code128Coupon | UpcaGs1Code128Coupon Barcode Type object. |
| UpcaGs1DatabarCoupon | UpcaGs1DatabarCoupon Barcode Type object. |
| UPCE | UPCE Barcode Type object. |
| VIN | VIN Barcode Type object. |
| HIBCCode39LIC | HIBC LIC 39 Barcode Type object. |
| HIBCCode128LIC | HIBC LIC 128 Barcode Type object. |
| HIBCCode39PAS | HIBC PAS 39 Barcode Type object. |
| HIBCCode128PAS | HIBC PAS 128 Barcode Type object. |
| GS1DotCode | GS1 DotCode Barcode Type object. |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All barcode types. |
| parse(String parsingType) | Returns Barcode type with pasringType name. |
| tryParse(String parsingType) | Returns Barcode type with pasringType name. |
| getDecodeTypes() | Internal list of Decode Types for extraction |
| find(String encodeTypeName) |  |
| isBarcodeType(String encodeTypeName) |  |
##### BarcodeTypes()
```
public BarcodeTypes()
```

##### AustralianPosteParcel
```
public static final BarcodeType AustralianPosteParcel
```

Australian Post eParcel Barcode Type object.

##### AustralianPost
```
public static final BarcodeType AustralianPost
```

Australian Post Barcode Type object.

##### Codabar
```
public static final BarcodeType Codabar
```

Codabar Barcode Type object.

##### CodablockF
```
public static final BarcodeType CodablockF
```

CodablockF Barcode Type object.

##### Code11
```
public static final BarcodeType Code11
```

Code11 Barcode Type object.

##### Code128
```
public static final BarcodeType Code128
```

Code128 Barcode Type object.

##### Code16K
```
public static final BarcodeType Code16K
```

Code16K Barcode Type object.

##### Code32
```
public static final BarcodeType Code32
```

Code32 Barcode Type object.

##### Code39Extended
```
public static final BarcodeType Code39Extended
```

Code39Extended Barcode Type object.

##### Code39Standard
```
public static final BarcodeType Code39Standard
```

Code39Standard Barcode Type object.

##### Code93Extended
```
public static final BarcodeType Code93Extended
```

Code93Extended Barcode Type object.

##### Code93Standard
```
public static final BarcodeType Code93Standard
```

Code93Standard Barcode Type object.

##### DatabarExpanded
```
public static final BarcodeType DatabarExpanded
```

DatabarExpanded Barcode Type object.

##### DatabarExpandedStacked
```
public static final BarcodeType DatabarExpandedStacked
```

DatabarExpandedStacked Barcode Type object.

##### DatabarLimited
```
public static final BarcodeType DatabarLimited
```

DatabarLimited Barcode Type object.

##### DatabarOmniDirectional
```
public static final BarcodeType DatabarOmniDirectional
```

DatabarOmniDirectional Barcode Type object.

##### DatabarStacked
```
public static final BarcodeType DatabarStacked
```

DatabarStacked Barcode Type object.

##### DatabarStackedOmniDirectional
```
public static final BarcodeType DatabarStackedOmniDirectional
```

DatabarStackedOmniDirectional Barcode Type object.

##### DatabarTruncated
```
public static final BarcodeType DatabarTruncated
```

DatabarTruncated Barcode Type object.

##### DataLogic2of5
```
public static final BarcodeType DataLogic2of5
```

DataLogic2of5 Barcode Type object.

##### DeutschePostIdentcode
```
public static final BarcodeType DeutschePostIdentcode
```

DeutschePostIdentcode Barcode Type object.

##### DeutschePostLeitcode
```
public static final BarcodeType DeutschePostLeitcode
```

DeutschePostLeitcode Barcode Type object.

##### DotCode
```
public static final BarcodeType DotCode
```

DotCode Barcode Type object.

##### DutchKIX
```
public static final BarcodeType DutchKIX
```

DutchKIX Barcode Type object.

##### EAN8
```
public static final BarcodeType EAN8
```

EAN8 Barcode Type object.

##### EAN13
```
public static final BarcodeType EAN13
```

EAN13 Barcode Type object.

##### EAN14
```
public static final BarcodeType EAN14
```

EAN14 Barcode Type object.

##### GS1CodablockF
```
public static final BarcodeType GS1CodablockF
```

GS1CodablockF Barcode Type object.

##### GS1Code128
```
public static final BarcodeType GS1Code128
```

GS1 Code128 Barcode Type object.

##### GS1CompositeBar
```
public static final BarcodeType GS1CompositeBar
```

GS1 Composite Barcode Type object.

##### IATA2of5
```
public static final BarcodeType IATA2of5
```

IATA2of5 Barcode Type object.

##### Interleaved2of5
```
public static final BarcodeType Interleaved2of5
```

Interleaved2of5 Barcode Type object.

##### ISBN
```
public static final BarcodeType ISBN
```

ISBN Barcode Type object.

##### ISMN
```
public static final BarcodeType ISMN
```

ISMN Barcode Type object.

##### ISSN
```
public static final BarcodeType ISSN
```

ISSN Barcode Type object.

##### ItalianPost25
```
public static final BarcodeType ItalianPost25
```

ItalianPost25 Barcode Type object.

##### ITF14
```
public static final BarcodeType ITF14
```

ITF14 Barcode Type object.

##### ITF6
```
public static final BarcodeType ITF6
```

ITF6 Barcode Type object.

##### MacroPdf417
```
public static final BarcodeType MacroPdf417
```

MacroPdf417 Barcode Type object.

##### Mailmark
```
public static final BarcodeType Mailmark
```

Royal Mail 2D Mailmark Barcode Type object.

##### Matrix2of5
```
public static final BarcodeType Matrix2of5
```

Matrix2of5 Barcode Type object.

##### MaxiCode
```
public static final BarcodeType MaxiCode
```

MaxiCode Barcode Type object.

##### MicroPdf417
```
public static final BarcodeType MicroPdf417
```

MicroPdf417 Barcode Type object.

##### MSI
```
public static final BarcodeType MSI
```

MSI Barcode Type object.

##### OneCode
```
public static final BarcodeType OneCode
```

OneCode Barcode Type object.

##### OPC
```
public static final BarcodeType OPC
```

OPC Barcode Type object.

##### PatchCode
```
public static final BarcodeType PatchCode
```

Patch Code Barcode Type object.

##### Pdf417
```
public static final BarcodeType Pdf417
```

Pdf417 Barcode Type object.

##### Pharmacode
```
public static final BarcodeType Pharmacode
```

Pharma code Barcode Type object.

##### Planet
```
public static final BarcodeType Planet
```

Planet Barcode Type object.

##### Postnet
```
public static final BarcodeType Postnet
```

Postnet Barcode Type object.

##### PZN
```
public static final BarcodeType PZN
```

PZN Barcode Type object.

##### RM4SCC
```
public static final BarcodeType RM4SCC
```

RM4SCC Barcode Type object.

##### SCC14
```
public static final BarcodeType SCC14
```

SCC14 Barcode Type object.

##### SingaporePost
```
public static final BarcodeType SingaporePost
```

SingaporePost Barcode Type object.

##### SSCC18
```
public static final BarcodeType SSCC18
```

SSCC18 Barcode Type object.

##### Standard2of5
```
public static final BarcodeType Standard2of5
```

Standard2of5 Barcode Type object.

##### SwissPostParcel
```
public static final BarcodeType SwissPostParcel
```

SwissPostParcel Barcode Type object.

##### UPCA
```
public static final BarcodeType UPCA
```

UPCA Barcode Type object.

##### UpcaGs1Code128Coupon
```
public static final BarcodeType UpcaGs1Code128Coupon
```

UpcaGs1Code128Coupon Barcode Type object.

##### UpcaGs1DatabarCoupon
```
public static final BarcodeType UpcaGs1DatabarCoupon
```

UpcaGs1DatabarCoupon Barcode Type object.

##### UPCE
```
public static final BarcodeType UPCE
```

UPCE Barcode Type object.

##### VIN
```
public static final BarcodeType VIN
```

VIN Barcode Type object.

##### HIBCCode39LIC
```
public static final BarcodeType HIBCCode39LIC
```

HIBC LIC 39 Barcode Type object.

##### HIBCCode128LIC
```
public static final BarcodeType HIBCCode128LIC
```

HIBC LIC 128 Barcode Type object.

##### HIBCCode39PAS
```
public static final BarcodeType HIBCCode39PAS
```

HIBC PAS 39 Barcode Type object.

##### HIBCCode128PAS
```
public static final BarcodeType HIBCCode128PAS
```

HIBC PAS 128 Barcode Type object.

##### GS1DotCode
```
public static final BarcodeType GS1DotCode
```

GS1 DotCode Barcode Type object.

##### getAllTypes()
```
public static BarcodeType[] getAllTypes()
```

All barcode types.

**Returns:**
com.groupdocs.signature.domain.barcodes.BarcodeType[]
##### parse(String parsingType)
```
public static BarcodeType parse(String parsingType)
```

Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of barcode type name. |

**Returns:**
BarcodeType - BarcodeType instance.
##### tryParse(String parsingType)
```
public static BarcodeType tryParse(String parsingType)
```

Returns Barcode type with pasringType name. If name of Barcode is unknown - no Exception will be thrown but method will return null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of barcode type name. |

**Returns:**
BarcodeType - BarcodeType instance.
##### getDecodeTypes()
```
public static System.Collections.Generic.List<BaseDecodeType> getDecodeTypes()
```

Internal list of Decode Types for extraction

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.aspose.barcode.barcoderecognition.BaseDecodeType>
##### find(String encodeTypeName)
```
public static BarcodeType find(String encodeTypeName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeTypeName | java.lang.String |  |

**Returns:**
BarcodeType
##### isBarcodeType(String encodeTypeName)
```
public static boolean isBarcodeType(String encodeTypeName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeTypeName | java.lang.String |  |

**Returns:**
boolean

### com.groupdocs.signature.domain.documentpreview
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.documentpreview.md

The **GroupDocs.Signature.Domain.DocumentPreview** namespace provides classes for working with document representation.

#### Classes

| Class | Description |
| --- | --- |
| DocumentInfo | Defines document description properties. |
| FileType | Represents file type. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines document description properties. |

### DocumentInfo
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.documentpreview/documentinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.documentpreview.IDocumentInfo
```
public class DocumentInfo implements IDocumentInfo
```

Defines document description properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| DocumentInfo() | Initializes a new instance of the DocumentInfo class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageCount() | Document pages count. |
| setPageCount(int value) | Document pages count. |
| getPages() | Collection of document pages descriptions. |
| setPages(List<PageInfo> value) | Collection of document pages descriptions. |
| getWidthForMaxHeight() | Specifies width for max page height. |
| setWidthForMaxHeight(int value) | Specifies width for max page height. |
| getMaxPageHeight() | Specifies max page height. |
| setMaxPageHeight(int value) | Specifies max page height. |
| getFileType() | File format type. |
| setFileType(FileType value) | File format type. |
| getSize() | Document size in bytes. |
| setSize(long value) | Document size in bytes. |
| addPage(int pageWidth, int pageHeight, int pageIndex) |  |
| getTextSignatures() | Collection of document text signatures. |
| getImageSignatures() | Collection of document image signatures added or updated by Signature methods. |
| getDigitalSignatures() | Collection of document digital signatures added or updated by Signature methods. |
| getBarcodeSignatures() | Collection of document barcode signatures added or updated by Signature methods. |
| getQrCodeSignatures() | Collection of document QR-code signatures added or updated by Signature methods. |
| getFormFieldSignatures() | Collection of document Form Field signatures added or updated by Signature methods. |
| getFormFields() | Collection of all existing supported Form Fields in the document. |
| getMetadataSignatures() | Collection of document Metadata signatures. |
| getProcessLogs() | Collection of document history processes like Sign, Update, Delete. |
| getSignatures() | Collection of document all types signatures BaseSignature. |
##### DocumentInfo()
```
public DocumentInfo()
```

Initializes a new instance of the DocumentInfo class.

##### getPageCount()
```
public final int getPageCount()
```

Document pages count.

**Returns:**
int
##### setPageCount(int value)
```
public final void setPageCount(int value)
```

Document pages count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPages()
```
public final List<PageInfo> getPages()
```

Collection of document pages descriptions.

**Returns:**
java.util.List<com.groupdocs.signature.domain.PageInfo>
##### setPages(List<PageInfo> value)
```
public final void setPages(List<PageInfo> value)
```

Collection of document pages descriptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.domain.PageInfo> |  |

##### getWidthForMaxHeight()
```
public final int getWidthForMaxHeight()
```

Specifies width for max page height.

**Returns:**
int
##### setWidthForMaxHeight(int value)
```
public final void setWidthForMaxHeight(int value)
```

Specifies width for max page height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMaxPageHeight()
```
public final int getMaxPageHeight()
```

Specifies max page height.

**Returns:**
int
##### setMaxPageHeight(int value)
```
public final void setMaxPageHeight(int value)
```

Specifies max page height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileType()
```
public final FileType getFileType()
```

File format type.

**Returns:**
FileType
##### setFileType(FileType value)
```
public final void setFileType(FileType value)
```

File format type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### getSize()
```
public final long getSize()
```

Document size in bytes.

**Returns:**
long
##### setSize(long value)
```
public final void setSize(long value)
```

Document size in bytes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### addPage(int pageWidth, int pageHeight, int pageIndex)
```
public final PageInfo addPage(int pageWidth, int pageHeight, int pageIndex)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageWidth | int |  |
| pageHeight | int |  |
| pageIndex | int |  |

**Returns:**
PageInfo
##### getTextSignatures()
```
public final List<TextSignature> getTextSignatures()
```

Collection of document text signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.TextSignature>
##### getImageSignatures()
```
public final List<ImageSignature> getImageSignatures()
```

Collection of document image signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.ImageSignature>
##### getDigitalSignatures()
```
public final List<DigitalSignature> getDigitalSignatures()
```

Collection of document digital signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature>
##### getBarcodeSignatures()
```
public final List<BarcodeSignature> getBarcodeSignatures()
```

Collection of document barcode signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BarcodeSignature>
##### getQrCodeSignatures()
```
public final List<QrCodeSignature> getQrCodeSignatures()
```

Collection of document QR-code signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.QrCodeSignature>
##### getFormFieldSignatures()
```
public final List<FormFieldSignature> getFormFieldSignatures()
```

Collection of document Form Field signatures added or updated by Signature methods.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
##### getFormFields()
```
public final List<FormFieldSignature> getFormFields()
```

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature>
##### getMetadataSignatures()
```
public final List<MetadataSignature> getMetadataSignatures()
```

Collection of document Metadata signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature>
##### getProcessLogs()
```
public final List<ProcessLog> getProcessLogs()
```

Collection of document history processes like Sign, Update, Delete.

**Returns:**
java.util.List<com.groupdocs.signature.domain.ProcessLog>
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

Collection of document all types signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### FileType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.documentpreview/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents file type.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| TIF | Tagged Image File (.tif) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| TIFF | Tagged Image File Format (.tiff) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| JPG | JPEG Image (.jpg) is a type of image format that is saved using the method of lossy compression. |
| JPEG | JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. |
| PNG | Portable Network Graphic (.png) is a type of raster image file format that use lossless compression. |
| GIF | Graphical Interchange Format File (.gif) is a type of highly compressed image. |
| BMP | Bitmap Image File (.bmp) is used to store bitmap digital images. |
| WMF | Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. |
| EMF | Enhanced Windows Metafile (.emf) represents graphical images device-independently. |
| WEBP | WebP Image (.webp) is a modern raster web image file format that is based on lossless and lossy compression. |
| DJVU | DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. |
| CGM | Computer Graphics Metafile (.cgm) is a free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. |
| CDR | CorelDraw Vector Graphic Drawing (.cdr) is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. |
| CMX | CorelDRAW Metafile Exchange Image File (.cmx) |
| PCL | Printer Command Language Document (.pcl) |
| PSD | Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development. |
| DCM | DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. |
| PS | PostScript File (.ps) |
| EPS | Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page. |
| ODG | OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| SVG | Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. |
| PDF | Portable Document Format File (.pdf) is a type of document created by Adobe back in 1990s. |
| PPT | PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | PowerPoint Open XML Presentation (.pptx) are presentation files created with popular Microsoft PowerPoint application. |
| PPS | PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. |
| POT | PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. |
| PPTM | PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. |
| POTX | PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. |
| POTM | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) are Microsoft PowerPoint template files with support for Macros. |
| PPSM | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. |
| OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. |
| XLS | Excel Spreadsheet (.xls) represents Excel Binary File Format. |
| XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros. |
| XLT | Excel binary Template (.xlt) represents Excel Template File Format. |
| XLTM | Excel Office OpenXML file Template (.xltm) represents Excel Template File Format. |
| XLSB | Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. |
| TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. |
| ODS | OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user. |
| OTS | OpenDocument Spreadsheet Template (.ots) |
| DOC | Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. |
| DOCM | Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| DOT | Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files. |
| DOTX | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files. |
| DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. |
| RTF | Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications. |
| TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines. |
| ODT | OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| OTT | OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format. |
| VCF | vCard File (.vcf) is a digital file format for storing contact information. |
| WPD | WordPerfect Document (.wpd) |
| AZW3 | WordPerfect Document (.wpd) |
| PFX | Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application. |
| ZIP | Document ZIP archive (.zip) is an archive file format that supports lossless data compression. |
| TAR | Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | File type name e.g. |
| getExtension() | Filename suffix (including the period ".") e.g. |
| fromExtension(String extension) | Maps file extension to file type. |
| getSupportedFileTypes() | Retrieves supported file types |
| equals(FileType other) | Determines whether the current FileType is the same as specified FileType object. |
| equals(Object obj) | Determines whether the current FileType is the same as specified object. |
| op_Equality(FileType left, FileType right) | Determines whether two FileType objects are the same. |
| op_Inequality(FileType left, FileType right) | Determines whether two FileType objects are not the same. |
| toString() | Returns a string that represents the current object. |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### TIF
```
public static final FileType TIF
```

Tagged Image File (.tif) 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

##### TIFF
```
public static final FileType TIFF
```

Tagged Image File Format (.tiff) 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 FileType JPG
```

JPEG Image (.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 FileType JPEG
```

JPEG Image (.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 FileType PNG
```

Portable Network Graphic (.png) is a type of raster image file format that use lossless 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 FileType GIF
```

Graphical Interchange Format File (.gif) 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 FileType BMP
```

Bitmap Image File (.bmp) is 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

##### WMF
```
public static final FileType WMF
```

Windows Metafile (.wmf) represents 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 FileType EMF
```

Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files 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

##### WEBP
```
public static final FileType WEBP
```

WebP Image (.webp) 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

##### DJVU
```
public static final FileType DJVU
```

DjVu Image (.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

##### CGM
```
public static final FileType CGM
```

Computer Graphics Metafile (.cgm) is a 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

##### CDR
```
public static final FileType CDR
```

CorelDraw Vector Graphic Drawing (.cdr) 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 FileType CMX
```

CorelDRAW Metafile Exchange Image File (.cmx)

##### PCL
```
public static final FileType PCL
```

Printer Command Language Document (.pcl)

##### PSD
```
public static final FileType PSD
```

Adobe Photoshop Document (.psd) 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

##### DCM
```
public static final FileType DCM
```

DICOM Image (.dcm) represents 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

##### PS
```
public static final FileType PS
```

PostScript File (.ps)

##### EPS
```
public static final FileType EPS
```

Encapsulated PostScript File (.eps) describes 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

##### ODG
```
public static final FileType ODG
```

OpenDocument Graphic File (.odg) 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

##### SVG
```
public static final FileType SVG
```

Scalable Vector Graphics File (.svg) 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

##### PDF
```
public static final FileType PDF
```

Portable Document Format File (.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

##### PPT
```
public static final FileType PPT
```

PowerPoint Presentation (.ppt) 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

##### PPTX
```
public static final FileType PPTX
```

PowerPoint Open XML Presentation (.pptx) 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

##### PPS
```
public static final FileType PPS
```

PowerPoint Slide Show (.pps) 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

##### PPSX
```
public static final FileType PPSX
```

PowerPoint Open XML Slide Show (.ppsx) files 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 FileType ODP
```

OpenDocument Presentation (.odp) represents 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

##### POT
```
public static final FileType POT
```

PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/presentation/pot

##### PPTM
```
public static final FileType PPTM
```

PowerPoint Open XML Macro-Enabled Presentation 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

##### POTX
```
public static final FileType POTX
```

PowerPoint Open XML Presentation Template (.potx) represents 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

##### POTM
```
public static final FileType POTM
```

PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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

##### PPSM
```
public static final FileType PPSM
```

PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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

##### OTP
```
public static final FileType OTP
```

OpenDocument Presentation Template (.otp) represents 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

##### XLS
```
public static final FileType XLS
```

Excel Spreadsheet (.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 FileType XLSX
```

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 FileType XLSM
```

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlsm

##### XLT
```
public static final FileType XLT
```

Excel binary Template (.xlt) represents Excel Template File Format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xlt

##### XLTM
```
public static final FileType XLTM
```

Excel Office OpenXML file Template (.xltm) represents Excel Template File Format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/xltm

##### XLSB
```
public static final FileType XLSB
```

Excel Binary Spreadsheet (.xlsb) 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

##### CSV
```
public static final FileType CSV
```

Comma Separated Values File (.csv) represents 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

##### TSV
```
public static final FileType TSV
```

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/spreadsheet/tsv

##### ODS
```
public static final FileType ODS
```

OpenDocument Spreadsheet (.ods) stands 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 FileType OTS
```

OpenDocument Spreadsheet Template (.ots)

##### DOC
```
public static final FileType DOC
```

Microsoft Word Document (.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 FileType DOCX
```

Microsoft Word Open XML Document (.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

##### DOCM
```
public static final FileType DOCM
```

Word Open XML Macro-Enabled Document (.docm) is a 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

##### DOT
```
public static final FileType DOT
```

Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files. Learn more about this file format  [here][] .

[here]: https://wiki.fileformat.com/word-processing/dot

##### DOTX
```
public static final FileType DOTX
```

Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted 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 FileType DOTM
```

Word Open XML Macro-Enabled Document Template (.dotm) 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

##### RTF
```
public static final FileType RTF
```

Rich Text Format File (.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

##### TXT
```
public static final FileType TXT
```

Plain Text File (.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

##### ODT
```
public static final FileType ODT
```

OpenDocument Text Document (.odt) 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 FileType OTT
```

OpenDocument Document Template (.ott) represents 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

##### VCF
```
public static final FileType VCF
```

vCard File (.vcf) 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

##### WPD
```
public static final FileType WPD
```

WordPerfect Document (.wpd)

##### AZW3
```
public static final FileType AZW3
```

WordPerfect Document (.wpd)

##### PFX
```
public static final FileType PFX
```

Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application. Learn more about this file format  [here][] .

[here]: https://fileinfo.com/extension/pfx

##### ZIP
```
public static final FileType ZIP
```

Document ZIP archive (.zip) is an archive file format that supports lossless data compression. Can hold one or more files or directories. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/compression/zip/

##### TAR
```
public static final FileType TAR
```

Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories. Learn more about this file format  [here][] .

[here]: https://docs.fileformat.com/compression/tar/

##### getFileFormat()
```
public final String getFileFormat()
```

File type name e.g. "Microsoft Word Document".

**Returns:**
java.lang.String
##### getExtension()
```
public final String getExtension()
```

Filename suffix (including the period ".") e.g. ".doc".

**Returns:**
java.lang.String
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps file extension to file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | File extension (including the period "."). |

**Returns:**
FileType - When file type is supported returns it, otherwise returns default \#Unknown.Unknown file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves supported file types

**Returns:**
java.util.List<com.groupdocs.signature.domain.documentpreview.FileType> - Returns sequence of supported file types
##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current FileType is the same as specified FileType object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current FileType object. |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are the same; otherwise,

```
false
```
### equals(Object obj) {#equals-java.lang.Object-}
```
public boolean equals(Object obj)
```


Determines whether the current [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) is the same as specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object. |

**Returns:**
boolean - ```
true
```

if

```
obj
```

parameter is FileType and is the same as current FileType object; otherwise,

```
false
```
##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two FileType objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left FileType object. |
| right | FileType | Right FileType object. |

**Returns:**
boolean - ```
true
```

if both [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are the same; otherwise,

```
false
```
### op_Inequality(FileType left, FileType right) {#op-Inequality-com.groupdocs.signature.domain.documentpreview.FileType-com.groupdocs.signature.domain.documentpreview.FileType-}
```
public static boolean op_Inequality(FileType left, FileType right)
```


Determines whether two [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) | Left [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object. |
| right | [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) | Right [FileType](../../com.groupdocs.signature.domain.documentpreview/filetype) object. |

**Returns:**
boolean - ```
true
```

if both FileType objects are not the same; otherwise,

```
false
```
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.

### IDocumentInfo
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.documentpreview/idocumentinfo.md

### com.groupdocs.signature.domain.enums
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums.md

The **GroupDocs.Signature.Domain.Enums** namespace provides classes for working with Enums

#### Classes

| Class | Description |
| --- | --- |
| CodeTextAlignment | Alignment of code text for Bar-codes and QR-codes. |
| DashStyle | Represents style of dash drawing lines on documents. |
| DocumentType | Defines document type. |
| FormFieldType | Specifies Form Field type. |
| FormTextFieldType | Defines types of text for WordsProcessing document form fields. |
| HorizontalAlignment | Specifies horizontal alignment of element on Document Page. |
| MeasureType | Specifies measure units of signature on document page. |
| PdfDigitalSignatureType | Describes enumeration of PDF digital signature type. |
| PdfSaveFileFormat | Define different save file formats. |
| PdfTextAnnotationBorderEffect | Describes effect which should be applied to the border of the PDF Text Annotations. |
| PdfTextStickerIcon | Describes enumeration of PDF Text Annotation Sticker Icon appearance. |
| PdfTextStickerState | Describes enumeration of PDF Text Annotation Sticker States. |
| PresentationSaveFileFormat | Defines different save file formats. |
| ProcessStatus | Specifies status of signing and verification processes. |
| ProcessType | Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete |
| ShapePosition | Specifies shape position in the document layout |
| SignatureType | Signature Type define the method to sign. |
| SpreadsheetSaveFileFormat | Defines different save formats for Spreadsheet documents. |
| StretchMode | Represents Stretch Mode of Signature area on Document Page. |
| TextHorizontalAlignment | Specifies text horizontal alignment inside a Signature. |
| TextMatchType | Specifies Text Match type in string - Exact, StartsWith, EndsWith, Contains. |
| TextShapeType | Specifies types of text shapes. |
| TextSignatureImplementation | Specifies type of implementation for PDF text signature. |
| TextVerticalAlignment | Specifies text vertical alignment inside a Signature. |
| VerticalAlignment | Specifies vertical alignment of element on Document Page. |
| WordProcessingSaveFileFormat | Defines different save file formats for WordProcessing documents. |
| WordProcessingTextSignatureImplementation | Specifies type of text signature implementation for WordProcessing documents. |
| XAdESType | Type of XML Advanced Electronic Signature (XAdES). |

### CodeTextAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/codetextalignment.md

**Inheritance:**
java.lang.Object
```
public final class CodeTextAlignment
```

Alignment of code text for Bar-codes and QR-codes.
#### Fields

| Field | Description |
| --- | --- |
| None | Text is not visible. |
| Above | Text is above the code. |
| Below | Text is below the code. |
##### None
```
public static final int None
```

Text is not visible.

##### Above
```
public static final int Above
```

Text is above the code.

##### Below
```
public static final int Below
```

Text is below the code.

### DashStyle
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/dashstyle.md

**Inheritance:**
java.lang.Object
```
public final class DashStyle
```

Represents style of dash drawing lines on documents.
#### Fields

| Field | Description |
| --- | --- |
| Solid | Represent a solid line. |
| ShortDash | Represent a short dash line. |
| ShortDot | Represent a short dot line. |
| ShortDashDot | Represent a short dash-dot line. |
| ShortDashDotDot | Represent a short dash-dot-dot line. |
| Dot | Represent a square dot style. |
| Dash | Represent a dash line style. |
| LongDash | Represent a long dash style. |
| DashDot | Dash short dash. |
| LongDashDot | Long dash short dash. |
| LongDashDotDot | Long dash short dash short dash. |
| RoundDot | Represents a round-dot line. |
| SquareDot | Represents a square-dot line. |
| DashDotDot | Represents a dash-dot-dot line. |
| DashLongDash | Represents a long dash-short dash line. |
| DashLongDashDot | Represents a long dash-short dash-dot line. |
##### Solid
```
public static final int Solid
```

Represent a solid line.

##### ShortDash
```
public static final int ShortDash
```

Represent a short dash line.

##### ShortDot
```
public static final int ShortDot
```

Represent a short dot line.

##### ShortDashDot
```
public static final int ShortDashDot
```

Represent a short dash-dot line.

##### ShortDashDotDot
```
public static final int ShortDashDotDot
```

Represent a short dash-dot-dot line.

##### Dot
```
public static final int Dot
```

Represent a square dot style.

##### Dash
```
public static final int Dash
```

Represent a dash line style.

##### LongDash
```
public static final int LongDash
```

Represent a long dash style.

##### DashDot
```
public static final int DashDot
```

Dash short dash.

##### LongDashDot
```
public static final int LongDashDot
```

Long dash short dash.

##### LongDashDotDot
```
public static final int LongDashDotDot
```

Long dash short dash short dash.

##### RoundDot
```
public static final int RoundDot
```

Represents a round-dot line.

##### SquareDot
```
public static final int SquareDot
```

Represents a square-dot line.

##### DashDotDot
```
public static final int DashDotDot
```

Represents a dash-dot-dot line.

##### DashLongDash
```
public static final int DashLongDash
```

Represents a long dash-short dash line.

##### DashLongDashDot
```
public static final int DashLongDashDot
```

Represents a long dash-short dash-dot line.

### DocumentType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/documenttype.md

**Inheritance:**
java.lang.Object
```
public final class DocumentType
```

Defines document type.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown document type. |
| Pdf | PDF Document Type. |
| WordProcessing | Word Processing Document Type. |
| Presentation | Presentation Document Type. |
| Spreadsheet | Spreadsheet Document Type. |
| Image | Image Document Type. |
| Certificate | Certificate file Type. |
| Archive | Archive file type. |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown document type.

##### Pdf
```
public static final int Pdf
```

PDF Document Type.

##### WordProcessing
```
public static final int WordProcessing
```

Word Processing Document Type.

##### Presentation
```
public static final int Presentation
```

Presentation Document Type.

##### Spreadsheet
```
public static final int Spreadsheet
```

Spreadsheet Document Type.

##### Image
```
public static final int Image
```

Image Document Type.

##### Certificate
```
public static final int Certificate
```

Certificate file Type.

##### Archive
```
public static final int Archive
```

Archive file type.

### FormFieldType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/formfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormFieldType
```

Specifies Form Field type.
#### Fields

| Field | Description |
| --- | --- |
| Text | Simple text input. |
| Checkbox |  |
| Combobox | Combo-box |
| DigitalSignature | Digital signature area. |
| Radio | Radio-button |
##### Text
```
public static final int Text
```

Simple text input.

##### Checkbox
```
public static final int Checkbox
```

##### Combobox
```
public static final int Combobox
```

Combo-box

##### DigitalSignature
```
public static final int DigitalSignature
```

Digital signature area.

##### Radio
```
public static final int Radio
```

Radio-button

### FormTextFieldType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/formtextfieldtype.md

**Inheritance:**
java.lang.Object
```
public final class FormTextFieldType
```

Defines types of text for WordsProcessing document form fields.
#### Fields

| Field | Description |
| --- | --- |
| AllTextTypes | Form field with any type. |
| PlainText | Form field with plain text type. |
| RichText | Form field with rich text type. |
##### AllTextTypes
```
public static final int AllTextTypes
```

Form field with any type.

##### PlainText
```
public static final int PlainText
```

Form field with plain text type.

##### RichText
```
public static final int RichText
```

Form field with rich text type.

### HorizontalAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/horizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class HorizontalAlignment
```

Specifies horizontal alignment of element on Document Page.
#### Fields

| Field | Description |
| --- | --- |
| None | The object is explicitly positioned, usually using its Left property. |
| Left | Specifies that the object shall be left aligned to the horizontal alignment base. |
| Center | Specifies that the object shall be centered with respect to the horizontal alignment base. |
| Right | Specifies that the object shall be right aligned to the horizontal alignment base. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() |  |
##### None
```
public static final int None
```

The object is explicitly positioned, usually using its Left property.

##### Left
```
public static final int Left
```

Specifies that the object shall be left aligned to the horizontal alignment base.

##### Center
```
public static final int Center
```

Specifies that the object shall be centered with respect to the horizontal alignment base.

##### Right
```
public static final int Right
```

Specifies that the object shall be right aligned to the horizontal alignment base.

##### getValues()
```
public static int[] getValues()
```

**Returns:**
int[]

### MeasureType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/measuretype.md

**Inheritance:**
java.lang.Object
```
public final class MeasureType
```

Specifies measure units of signature on document page.
#### Fields

| Field | Description |
| --- | --- |
| Pixels | Pixels. |
| Percents | Percents of page size. |
| Millimeters | Millimeters. |
##### Pixels
```
public static final int Pixels
```

Pixels.

##### Percents
```
public static final int Percents
```

Percents of page size.

##### Millimeters
```
public static final int Millimeters
```

Millimeters.

### PdfDigitalSignatureType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/pdfdigitalsignaturetype.md

**Inheritance:**
java.lang.Object
```
public final class PdfDigitalSignatureType
```

Describes enumeration of PDF digital signature type.
#### Fields

| Field | Description |
| --- | --- |
| Signature | Digital signature. |
| Certificate | Digital certificate. |
##### Signature
```
public static final int Signature
```

Digital signature.

##### Certificate
```
public static final int Certificate
```

Digital certificate. Each document could be certified only once.

### PdfSaveFileFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/pdfsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class PdfSaveFileFormat
```

Define different save file formats.
#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed. |
| Pdf | Saves the document as PDF (Adobe Portable Document) Format. |
| Doc | Saves the document in the Microsoft Word 97-2007 Document Format. |
| Xps | Saves the document in the XPS (XML Paper Specification) Format. |
| DocX | Saves the document in Microsoft Word Open XML File format. |
| Svg | Saves the document in the SVG (Scalable Vector Graphics) format. |
| Epub | Saves the document in the IDPF EPUB format. |
| Pptx | Saves the document in the PowerPoint Open XML Presentation File format |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Pdf
```
public static final int Pdf
```

Saves the document as PDF (Adobe Portable Document) Format.

##### Doc
```
public static final int Doc
```

Saves the document in the Microsoft Word 97-2007 Document Format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) Format.

##### DocX
```
public static final int DocX
```

Saves the document in Microsoft Word Open XML File format.

##### Svg
```
public static final int Svg
```

Saves the document in the SVG (Scalable Vector Graphics) format.

##### Epub
```
public static final int Epub
```

Saves the document in the IDPF EPUB format.

##### Pptx
```
public static final int Pptx
```

Saves the document in the PowerPoint Open XML Presentation File format

### PdfTextAnnotationBorderEffect
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/pdftextannotationbordereffect.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextAnnotationBorderEffect
```

Describes effect which should be applied to the border of the PDF Text Annotations.
#### Fields

| Field | Description |
| --- | --- |
| None | No effect. |
| Cloudy | The border will appear "cloudy". |
##### None
```
public static final int None
```

No effect.

##### Cloudy
```
public static final int Cloudy
```

The border will appear "cloudy".

### PdfTextStickerIcon
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/pdftextstickericon.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextStickerIcon
```

Describes enumeration of PDF Text Annotation Sticker Icon appearance.
#### Fields

| Field | Description |
| --- | --- |
| Note | Note icon. |
| Comment | Comment icon. |
| Key | Key icon. |
| Help | Help icon. |
| NewParagraph | New Paragraph icon |
| Paragraph | Paragraph icon |
| Insert | Insert icon |
| Check | Check icon |
| Cross | Cross icon |
| Circle | Circle icon |
| Star | Star icon |
##### Note
```
public static final int Note
```

Note icon.

##### Comment
```
public static final int Comment
```

Comment icon.

##### Key
```
public static final int Key
```

Key icon.

##### Help
```
public static final int Help
```

Help icon.

##### NewParagraph
```
public static final int NewParagraph
```

New Paragraph icon

##### Paragraph
```
public static final int Paragraph
```

Paragraph icon

##### Insert
```
public static final int Insert
```

Insert icon

##### Check
```
public static final int Check
```

Check icon

##### Cross
```
public static final int Cross
```

Cross icon

##### Circle
```
public static final int Circle
```

Circle icon

##### Star
```
public static final int Star
```

Star icon

### PdfTextStickerState
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/pdftextstickerstate.md

**Inheritance:**
java.lang.Object
```
public final class PdfTextStickerState
```

Describes enumeration of PDF Text Annotation Sticker States.
#### Fields

| Field | Description |
| --- | --- |
| Undefined | Undefined state. |
| Marked | Marked state. |
| Unmarked | Unmarked state. |
| Accepted | Accepted state. |
| Rejected | Rejected state. |
| Cancelled | Canceled state. |
| Completed | Completed state. |
| None | No state. |
##### Undefined
```
public static final int Undefined
```

Undefined state.

##### Marked
```
public static final int Marked
```

Marked state.

##### Unmarked
```
public static final int Unmarked
```

Unmarked state.

##### Accepted
```
public static final int Accepted
```

Accepted state.

##### Rejected
```
public static final int Rejected
```

Rejected state.

##### Cancelled
```
public static final int Cancelled
```

Canceled state.

##### Completed
```
public static final int Completed
```

Completed state.

##### None
```
public static final int None
```

No state.

### PresentationSaveFileFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/presentationsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class PresentationSaveFileFormat
```

Defines different save file formats.
#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed. |
| Pps | Saves the document as Microsoft Power Point 97-2003 slide show. |
| Ppt | Saves the document as Microsoft Power Point 97-2003 presentation. |
| Pdf | Saves the document in PDF format. |
| Xps | Saves the document in the XPS (XML Paper Specification) format. |
| Pptx | Saves the document in the Microsoft Power Point Open XML Presentation format. |
| Ppsx | Saves the document in the Microsoft Power Point Open XML Slide Show format. |
| Tiff | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| Odp | Saves the document as Open Office presentation. |
| Pptm | Saves the document as Microsoft Power Point Open XML macro-enabled presentation. |
| Ppsm | Saves the document as Microsoft Power Point Open XML macro-enabled slide show. |
| Potx | Saves the document as Microsoft Power Point template. |
| Potm | Saves the document as Microsoft Power Point macro-enabled template. |
| Html | Saves the document in the HTML Format. |
| Otp | Saves the document as Open Office presentation template. |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Pps
```
public static final int Pps
```

Saves the document as Microsoft Power Point 97-2003 slide show.

##### Ppt
```
public static final int Ppt
```

Saves the document as Microsoft Power Point 97-2003 presentation.

##### Pdf
```
public static final int Pdf
```

Saves the document in PDF format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) format.

##### Pptx
```
public static final int Pptx
```

Saves the document in the Microsoft Power Point Open XML Presentation format.

##### Ppsx
```
public static final int Ppsx
```

Saves the document in the Microsoft Power Point Open XML Slide Show format.

##### Tiff
```
public static final int Tiff
```

Renders a page or pages of the document and saves them into a single or multi-page TIFF file.

##### Odp
```
public static final int Odp
```

Saves the document as Open Office presentation.

##### Pptm
```
public static final int Pptm
```

Saves the document as Microsoft Power Point Open XML macro-enabled presentation.

##### Ppsm
```
public static final int Ppsm
```

Saves the document as Microsoft Power Point Open XML macro-enabled slide show.

##### Potx
```
public static final int Potx
```

Saves the document as Microsoft Power Point template.

##### Potm
```
public static final int Potm
```

Saves the document as Microsoft Power Point macro-enabled template.

##### Html
```
public static final int Html
```

Saves the document in the HTML Format.

##### Otp
```
public static final int Otp
```

Saves the document as Open Office presentation template.

### ProcessStatus
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/processstatus.md

**Inheritance:**
java.lang.Object
```
public final class ProcessStatus
```

Specifies status of signing and verification processes.
#### Fields

| Field | Description |
| --- | --- |
| None | Process is not started. |
| Started | Process was started. |
| InProgress | Process is in progress. |
| Completed | Process is completed. |
##### None
```
public static final int None
```

Process is not started.

##### Started
```
public static final int Started
```

Process was started.

##### InProgress
```
public static final int InProgress
```

Process is in progress.

##### Completed
```
public static final int Completed
```

Process is completed.

### ProcessType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/processtype.md

**Inheritance:**
java.lang.Object
```
public final class ProcessType
```

Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown process type. |
| Info | Obtain document information process. |
| Preview | Indicates method GeneratePreview(). |
| Sign | Signing process type. |
| Verify | Document verification process. |
| Search | Signatures searching process. |
| Update | Update document signatures process. |
| Delete | Delete document signatures process |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown process type.

##### Info
```
public static final int Info
```

Obtain document information process.

##### Preview
```
public static final int Preview
```

Indicates method GeneratePreview().

##### Sign
```
public static final int Sign
```

Signing process type.

##### Verify
```
public static final int Verify
```

Document verification process.

##### Search
```
public static final int Search
```

Signatures searching process.

##### Update
```
public static final int Update
```

Update document signatures process.

##### Delete
```
public static final int Delete
```

Delete document signatures process

### ShapePosition
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/shapeposition.md

**Inheritance:**
java.lang.Object
```
public final class ShapePosition
```

Specifies shape position in the document layout
#### Fields

| Field | Description |
| --- | --- |
| Default | Shape presents in the document body |
| Header | Shape presents in the document header |
| Footer | Shape presents in the document footer |
##### Default
```
public static final int Default
```

Shape presents in the document body

##### Header
```
public static final int Header
```

Shape presents in the document header

##### Footer
```
public static final int Footer
```

Shape presents in the document footer

### SignatureType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/signaturetype.md

**Inheritance:**
java.lang.Object
```
public final class SignatureType
```

Signature Type define the method to sign.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Indicates an error, unknown signature type. |
| Text | The Text Signature - put formatted string to document. |
| Image | The Image Signature - put image to specified document location. |
| Barcode | The Barcode Signature - sign document with Barcode. |
| QrCode | The QR-Code Signature - sign document with QRCode. |
| Stamp | The Stamp Signature - sign document with Stamp. |
| Metadata | The Metadata Signature - put metadata properties to Document. |
| FormField | The FormField Signature - put form-field objects to Document. |
| Digital | The Digital Signature - sign document with digital key. |
##### Unknown
```
public static final int Unknown
```

Indicates an error, unknown signature type.

##### Text
```
public static final int Text
```

The Text Signature - put formatted string to document.

##### Image
```
public static final int Image
```

The Image Signature - put image to specified document location.

##### Barcode
```
public static final int Barcode
```

The Barcode Signature - sign document with Barcode.

##### QrCode
```
public static final int QrCode
```

The QR-Code Signature - sign document with QRCode.

##### Stamp
```
public static final int Stamp
```

The Stamp Signature - sign document with Stamp.

##### Metadata
```
public static final int Metadata
```

The Metadata Signature - put metadata properties to Document.

##### FormField
```
public static final int FormField
```

The FormField Signature - put form-field objects to Document.

##### Digital
```
public static final int Digital
```

The Digital Signature - sign document with digital key.

### SpreadsheetSaveFileFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/spreadsheetsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetSaveFileFormat
```

Defines different save formats for Spreadsheet documents.
#### Fields

| Field | Description |
| --- | --- |
| Default | File format will not be changed. |
| CSV | Saves the document as comma separated value file. |
| Excel97To2003 | Saves the document as Microsoft Excel 97-2003 workbook (.xls). |
| Xlsx | Saves the document an Microsoft Excel OpenXML workbook. |
| Xlsm | Saves the document as Microsoft Excel macro-enabled workbook. |
| Xltx | Saves the document as Microsoft Excel template. |
| Xltm | Saves the document as Microsoft Excel macro-enabled template. |
| Xlam | Saves the document as Microsoft Excel macro-enabled add-In. |
| Pdf | Saves the document as an PDF file. |
| ODS | Saves the document as Open Office workbook. |
| Xlsb | Saves the document as Microsoft Excel Binary workbook. |
| XPS | Saves the document as XML Paper Specification File. |
| TIFF | Saves the document in Tagged Image File Format. |
| SVG | Saves the document as Scalable Vector Graphics file. |
| Dif | Saves the document in Data Interchange Format. |
| Emf | Saves the document in Windows Enhanced Metafile format. |
| Jpg | Saves the document in Jpeg format. |
| Png | Saves the document in Portable Network Graphics format. |
##### Default
```
public static final int Default
```

File format will not be changed.

##### CSV
```
public static final int CSV
```

Saves the document as comma separated value file.

##### Excel97To2003
```
public static final int Excel97To2003
```

Saves the document as Microsoft Excel 97-2003 workbook (.xls).

##### Xlsx
```
public static final int Xlsx
```

Saves the document an Microsoft Excel OpenXML workbook.

##### Xlsm
```
public static final int Xlsm
```

Saves the document as Microsoft Excel macro-enabled workbook.

##### Xltx
```
public static final int Xltx
```

Saves the document as Microsoft Excel template.

##### Xltm
```
public static final int Xltm
```

Saves the document as Microsoft Excel macro-enabled template.

##### Xlam
```
public static final int Xlam
```

Saves the document as Microsoft Excel macro-enabled add-In.

##### Pdf
```
public static final int Pdf
```

Saves the document as an PDF file.

##### ODS
```
public static final int ODS
```

Saves the document as Open Office workbook.

##### Xlsb
```
public static final int Xlsb
```

Saves the document as Microsoft Excel Binary workbook.

##### XPS
```
public static final int XPS
```

Saves the document as XML Paper Specification File.

##### TIFF
```
public static final int TIFF
```

Saves the document in Tagged Image File Format.

##### SVG
```
public static final int SVG
```

Saves the document as Scalable Vector Graphics file.

##### Dif
```
public static final int Dif
```

Saves the document in Data Interchange Format.

##### Emf
```
public static final int Emf
```

Saves the document in Windows Enhanced Metafile format.

##### Jpg
```
public static final int Jpg
```

Saves the document in Jpeg format.

##### Png
```
public static final int Png
```

Saves the document in Portable Network Graphics format.

### StretchMode
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/stretchmode.md

**Inheritance:**
java.lang.Object
```
public final class StretchMode
```

Represents Stretch Mode of Signature area on Document Page.
#### Fields

| Field | Description |
| --- | --- |
| None | Default value. |
| PageWidth | Stretch Signature area along page Width. |
| PageHeight | Stretch Signature area along page Height. |
| PageArea | Stretch Signature area along page Height and Width. |
##### None
```
public static final int None
```

Default value. No stretch mode will be applied.

##### PageWidth
```
public static final int PageWidth
```

Stretch Signature area along page Width. Margin property will be used to apply required offset values

##### PageHeight
```
public static final int PageHeight
```

Stretch Signature area along page Height. Margin property will be used to apply required offset values.

##### PageArea
```
public static final int PageArea
```

Stretch Signature area along page Height and Width. Margin property will be used to apply required offset values.

### TextHorizontalAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/texthorizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class TextHorizontalAlignment
```

Specifies text horizontal alignment inside a Signature.
#### Fields

| Field | Description |
| --- | --- |
| Left | Specifies that the text is left aligned to the horizontal alignment base. |
| Center | Specifies that the text is centered to the horizontal alignment base. |
| Right | Specifies that the text is right aligned to the horizontal alignment base. |
##### Left
```
public static final int Left
```

Specifies that the text is left aligned to the horizontal alignment base.

##### Center
```
public static final int Center
```

Specifies that the text is centered to the horizontal alignment base.

##### Right
```
public static final int Right
```

Specifies that the text is right aligned to the horizontal alignment base.

### TextMatchType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/textmatchtype.md

**Inheritance:**
java.lang.Object
```
public final class TextMatchType
```

Specifies Text Match type in string - Exact, StartsWith, EndsWith, Contains.
#### Fields

| Field | Description |
| --- | --- |
| Exact | Text is fully match. |
| StartsWith | Text starts with value. |
| EndsWith | Text ends with value. |
| Contains | Text contains the value. |
##### Exact
```
public static final int Exact
```

Text is fully match.

##### StartsWith
```
public static final int StartsWith
```

Text starts with value.

##### EndsWith
```
public static final int EndsWith
```

Text ends with value.

##### Contains
```
public static final int Contains
```

Text contains the value.

### TextShapeType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/textshapetype.md

**Inheritance:**
java.lang.Object
```
public final class TextShapeType
```

Specifies types of text shapes.
#### Fields

| Field | Description |
| --- | --- |
| Rectangle | Rectangle. |
| RoundRectangle | RoundRectangle. |
| Ellipse | Ellipse. |
| Diamond | Diamond. |
| Triangle | Triangle. |
| RightTriangle | RightTriangle. |
| Parallelogram | Parallelogram. |
| Trapezoid | Trapezoid. |
| Hexagon | Hexagon. |
| Octagon | Octagon. |
| Plus | Plus. |
| Star | Star. |
| Arrow | Arrow. |
| ThickArrow | ThickArrow. |
| HomePlate | HomePlate. |
| Cube | Cube. |
| Balloon | Balloon. |
| Seal | Seal. |
| Arc | Arc. |
| Line | Line. |
| Plaque | Plaque. |
| Can | Can. |
| Donut | Donut. |
| TextSimple | TextSimple. |
| TextOctagon | TextOctagon. |
| TextHexagon | TextHexagon. |
| TextCurve | TextCurve. |
| TextWave | TextWave. |
| TextRing | TextRing. |
| TextOnCurve | TextOnCurve. |
| TextOnRing | TextOnRing. |
| StraightConnector1 | StraightConnector1. |
| BentConnector2 | BentConnector2. |
| BentConnector3 | BentConnector3. |
| BentConnector4 | BentConnector4. |
| BentConnector5 | BentConnector5. |
| CurvedConnector2 | CurvedConnector2. |
| CurvedConnector3 | CurvedConnector3. |
| CurvedConnector4 | CurvedConnector4. |
| CurvedConnector5 | CurvedConnector5. |
| Callout1 | Callout1. |
| Callout2 | Callout2. |
| Callout3 | Callout3. |
| AccentCallout1 | AccentCallout1. |
| AccentCallout2 | AccentCallout2. |
| AccentCallout3 | AccentCallout3. |
| BorderCallout1 | BorderCallout1. |
| BorderCallout2 | BorderCallout2. |
| BorderCallout3 | BorderCallout3. |
| AccentBorderCallout1 | AccentBorderCallout1. |
| AccentBorderCallout2 | AccentBorderCallout2. |
| AccentBorderCallout3 | AccentBorderCallout3. |
| Ribbon | Ribbon. |
| Ribbon2 | Ribbon2. |
| Chevron | Chevron. |
| Pentagon | Pentagon. |
| NoSmoking | NoSmoking. |
| Seal8 | Seal8. |
| Seal16 | Seal16. |
| Seal32 | Seal32. |
| WedgeRectCallout | WedgeRectCallout. |
| WedgeRRectCallout | WedgeRRectCallout. |
| WedgeEllipseCallout | WedgeEllipseCallout. |
| Wave | Wave. |
| FoldedCorner | FoldedCorner. |
| LeftArrow | LeftArrow. |
| DownArrow | DownArrow. |
| UpArrow | UpArrow. |
| LeftRightArrow | LeftRightArrow. |
| UpDownArrow | UpDownArrow. |
| IrregularSeal1 | IrregularSeal1. |
| IrregularSeal2 | IrregularSeal2. |
| LightningBolt | LightningBolt. |
| Heart | Heart. |
| Image | Image. |
| QuadArrow | QuadArrow. |
| LeftArrowCallout | LeftArrowCallout. |
| RightArrowCallout | RightArrowCallout. |
| UpArrowCallout | UpArrowCallout. |
| DownArrowCallout | DownArrowCallout. |
| LeftRightArrowCallout | LeftRightArrowCallout. |
| UpDownArrowCallout | UpDownArrowCallout. |
| QuadArrowCallout | QuadArrowCallout. |
| Bevel | Bevel. |
| LeftBracket | LeftBracket. |
| RightBracket | RightBracket. |
| LeftBrace | LeftBrace. |
| RightBrace | RightBrace. |
| LeftUpArrow | LeftUpArrow. |
| BentUpArrow | BentUpArrow. |
| BentArrow | BentArrow. |
| Seal24 | Seal24. |
| StripedRightArrow | StripedRightArrow. |
| NotchedRightArrow | NotchedRightArrow. |
| BlockArc | BlockArc. |
| SmileyFace | SmileyFace. |
| VerticalScroll | VerticalScroll. |
| HorizontalScroll | HorizontalScroll. |
| CircularArrow | CircularArrow. |
| UturnArrow | UturnArrow. |
| CurvedRightArrow | CurvedRightArrow. |
| CurvedLeftArrow | CurvedLeftArrow. |
| CurvedUpArrow | CurvedUpArrow. |
| CurvedDownArrow | CurvedDownArrow. |
| CloudCallout | CloudCallout. |
| EllipseRibbon | EllipseRibbon. |
| EllipseRibbon2 | EllipseRibbon2. |
| FlowChartProcess | FlowChartProcess. |
| FlowChartDecision | FlowChartDecision. |
| FlowChartInputOutput | FlowChartInputOutput. |
| FlowChartPredefinedProcess | FlowChartPredefinedProcess. |
| FlowChartInternalStorage | FlowChartInternalStorage. |
| FlowChartDocument | FlowChartDocument. |
| FlowChartMultidocument | FlowChartMultidocument. |
| FlowChartTerminator | FlowChartTerminator. |
| FlowChartPreparation | FlowChartPreparation. |
| FlowChartManualInput | FlowChartManualInput. |
| FlowChartManualOperation | FlowChartManualOperation. |
| FlowChartConnector | FlowChartConnector. |
| FlowChartPunchedCard | FlowChartPunchedCard. |
| FlowChartPunchedTape | FlowChartPunchedTape. |
| FlowChartSummingJunction | FlowChartSummingJunction. |
| FlowChartOr | FlowChartOr. |
| FlowChartCollate | FlowChartCollate. |
| FlowChartSort | FlowChartSort. |
| FlowChartExtract | FlowChartExtract. |
| FlowChartMerge | FlowChartOfflineStorage. |
| FlowChartOfflineStorage | FlowChartOfflineStorage. |
| FlowChartOnlineStorage | FlowChartOnlineStorage. |
| FlowChartMagneticTape | FlowChartMagneticTape. |
| FlowChartMagneticDisk | FlowChartMagneticDisk. |
| FlowChartMagneticDrum | FlowChartMagneticDrum. |
| FlowChartDisplay | FlowChartDisplay. |
| FlowChartDelay | FlowChartDelay. |
| TextPlainText | TextPlainText. |
| TextStop | TextStop. |
| TextTriangle | TextTriangle. |
| TextTriangleInverted | TextTriangleInverted. |
| TextChevron | TextChevron. |
| TextChevronInverted | TextChevronInverted. |
| TextRingInside | TextRingInside. |
| TextRingOutside | TextRingOutside. |
| TextArchUpCurve | TextArchUpCurve. |
| TextArchDownCurve | TextArchDownCurve. |
| TextCircleCurve | TextCircleCurve. |
| TextButtonCurve | TextButtonCurve. |
| TextArchUpPour | TextArchUpPour. |
| TextArchDownPour | TextArchDownPour. |
| TextCirclePour | TextCirclePour. |
| TextButtonPour | TextButtonPour. |
| TextCurveUp | TextCurveUp. |
| TextCurveDown | TextCurveDown. |
| TextCascadeUp | TextCascadeUp. |
| TextCascadeDown | TextCascadeDown. |
| TextWave1 | TextWave1. |
| TextWave2 | TextWave2. |
| TextWave3 | TextWave3. |
| TextWave4 | TextWave4. |
| TextInflate | TextInflate. |
| TextDeflate | TextDeflate. |
| TextInflateBottom | TextInflateBottom. |
| TextDeflateBottom | TextDeflateBottom. |
| TextInflateTop | TextInflateTop. |
| TextDeflateTop | TextDeflateTop. |
| TextDeflateInflate | TextDeflateInflate. |
| TextDeflateInflateDeflate | TextDeflateInflateDeflate. |
| TextFadeRight | TextFadeRight. |
| TextFadeLeft | TextFadeLeft. |
| TextFadeUp | TextFadeUp. |
| TextFadeDown | TextFadeDown. |
| TextSlantUp | TextSlantUp. |
| TextSlantDown | TextSlantDown. |
| TextCanUp | TextCanUp. |
| TextCanDown | TextCanDown. |
| FlowChartAlternateProcess | FlowChartAlternateProcess. |
| FlowChartOffpageConnector | FlowChartOffpageConnector. |
| Callout90 | Callout90. |
| AccentCallout90 | AccentCallout90. |
| BorderCallout90 | BorderCallout90. |
| AccentBorderCallout90 | AccentBorderCallout90. |
| LeftRightUpArrow | LeftRightUpArrow. |
| Sun | Sun. |
| Moon | Moon. |
| BracketPair | BracketPair. |
| BracePair | BracePair. |
| Seal4 | Seal4. |
| DoubleWave | DoubleWave. |
| ActionButtonBlank | ActionButtonBlank. |
| ActionButtonHome | ActionButtonHome. |
| ActionButtonHelp | ActionButtonHelp. |
| ActionButtonInformation | ActionButtonInformation. |
| ActionButtonForwardNext | ActionButtonForwardNext. |
| ActionButtonBackPrevious | ActionButtonBackPrevious. |
| ActionButtonEnd | ActionButtonEnd. |
| ActionButtonBeginning | ActionButtonBeginning. |
| ActionButtonReturn | ActionButtonReturn. |
| ActionButtonDocument | ActionButtonDocument. |
| ActionButtonSound | ActionButtonSound. |
| ActionButtonMovie | ActionButtonMovie. |
| TextBox | TextBox. |
##### Rectangle
```
public static final int Rectangle
```

Rectangle.

##### RoundRectangle
```
public static final int RoundRectangle
```

RoundRectangle.

##### Ellipse
```
public static final int Ellipse
```

Ellipse.

##### Diamond
```
public static final int Diamond
```

Diamond.

##### Triangle
```
public static final int Triangle
```

Triangle.

##### RightTriangle
```
public static final int RightTriangle
```

RightTriangle.

##### Parallelogram
```
public static final int Parallelogram
```

Parallelogram.

##### Trapezoid
```
public static final int Trapezoid
```

Trapezoid.

##### Hexagon
```
public static final int Hexagon
```

Hexagon.

##### Octagon
```
public static final int Octagon
```

Octagon.

##### Plus
```
public static final int Plus
```

Plus.

##### Star
```
public static final int Star
```

Star.

##### Arrow
```
public static final int Arrow
```

Arrow.

##### ThickArrow
```
public static final int ThickArrow
```

ThickArrow.

##### HomePlate
```
public static final int HomePlate
```

HomePlate.

##### Cube
```
public static final int Cube
```

Cube.

##### Balloon
```
public static final int Balloon
```

Balloon.

##### Seal
```
public static final int Seal
```

Seal.

##### Arc
```
public static final int Arc
```

Arc.

##### Line
```
public static final int Line
```

Line.

##### Plaque
```
public static final int Plaque
```

Plaque.

##### Can
```
public static final int Can
```

Can.

##### Donut
```
public static final int Donut
```

Donut.

##### TextSimple
```
public static final int TextSimple
```

TextSimple.

##### TextOctagon
```
public static final int TextOctagon
```

TextOctagon.

##### TextHexagon
```
public static final int TextHexagon
```

TextHexagon.

##### TextCurve
```
public static final int TextCurve
```

TextCurve.

##### TextWave
```
public static final int TextWave
```

TextWave.

##### TextRing
```
public static final int TextRing
```

TextRing.

##### TextOnCurve
```
public static final int TextOnCurve
```

TextOnCurve.

##### TextOnRing
```
public static final int TextOnRing
```

TextOnRing.

##### StraightConnector1
```
public static final int StraightConnector1
```

StraightConnector1.

##### BentConnector2
```
public static final int BentConnector2
```

BentConnector2.

##### BentConnector3
```
public static final int BentConnector3
```

BentConnector3.

##### BentConnector4
```
public static final int BentConnector4
```

BentConnector4.

##### BentConnector5
```
public static final int BentConnector5
```

BentConnector5.

##### CurvedConnector2
```
public static final int CurvedConnector2
```

CurvedConnector2.

##### CurvedConnector3
```
public static final int CurvedConnector3
```

CurvedConnector3.

##### CurvedConnector4
```
public static final int CurvedConnector4
```

CurvedConnector4.

##### CurvedConnector5
```
public static final int CurvedConnector5
```

CurvedConnector5.

##### Callout1
```
public static final int Callout1
```

Callout1.

##### Callout2
```
public static final int Callout2
```

Callout2.

##### Callout3
```
public static final int Callout3
```

Callout3.

##### AccentCallout1
```
public static final int AccentCallout1
```

AccentCallout1.

##### AccentCallout2
```
public static final int AccentCallout2
```

AccentCallout2.

##### AccentCallout3
```
public static final int AccentCallout3
```

AccentCallout3.

##### BorderCallout1
```
public static final int BorderCallout1
```

BorderCallout1.

##### BorderCallout2
```
public static final int BorderCallout2
```

BorderCallout2.

##### BorderCallout3
```
public static final int BorderCallout3
```

BorderCallout3.

##### AccentBorderCallout1
```
public static final int AccentBorderCallout1
```

AccentBorderCallout1.

##### AccentBorderCallout2
```
public static final int AccentBorderCallout2
```

AccentBorderCallout2.

##### AccentBorderCallout3
```
public static final int AccentBorderCallout3
```

AccentBorderCallout3.

##### Ribbon
```
public static final int Ribbon
```

Ribbon.

##### Ribbon2
```
public static final int Ribbon2
```

Ribbon2.

##### Chevron
```
public static final int Chevron
```

Chevron.

##### Pentagon
```
public static final int Pentagon
```

Pentagon.

##### NoSmoking
```
public static final int NoSmoking
```

NoSmoking.

##### Seal8
```
public static final int Seal8
```

Seal8.

##### Seal16
```
public static final int Seal16
```

Seal16.

##### Seal32
```
public static final int Seal32
```

Seal32.

##### WedgeRectCallout
```
public static final int WedgeRectCallout
```

WedgeRectCallout.

##### WedgeRRectCallout
```
public static final int WedgeRRectCallout
```

WedgeRRectCallout.

##### WedgeEllipseCallout
```
public static final int WedgeEllipseCallout
```

WedgeEllipseCallout.

##### Wave
```
public static final int Wave
```

Wave.

##### FoldedCorner
```
public static final int FoldedCorner
```

FoldedCorner.

##### LeftArrow
```
public static final int LeftArrow
```

LeftArrow.

##### DownArrow
```
public static final int DownArrow
```

DownArrow.

##### UpArrow
```
public static final int UpArrow
```

UpArrow.

##### LeftRightArrow
```
public static final int LeftRightArrow
```

LeftRightArrow.

##### UpDownArrow
```
public static final int UpDownArrow
```

UpDownArrow.

##### IrregularSeal1
```
public static final int IrregularSeal1
```

IrregularSeal1.

##### IrregularSeal2
```
public static final int IrregularSeal2
```

IrregularSeal2.

##### LightningBolt
```
public static final int LightningBolt
```

LightningBolt.

##### Heart
```
public static final int Heart
```

Heart.

##### Image
```
public static final int Image
```

Image.

##### QuadArrow
```
public static final int QuadArrow
```

QuadArrow.

##### LeftArrowCallout
```
public static final int LeftArrowCallout
```

LeftArrowCallout.

##### RightArrowCallout
```
public static final int RightArrowCallout
```

RightArrowCallout.

##### UpArrowCallout
```
public static final int UpArrowCallout
```

UpArrowCallout.

##### DownArrowCallout
```
public static final int DownArrowCallout
```

DownArrowCallout.

##### LeftRightArrowCallout
```
public static final int LeftRightArrowCallout
```

LeftRightArrowCallout.

##### UpDownArrowCallout
```
public static final int UpDownArrowCallout
```

UpDownArrowCallout.

##### QuadArrowCallout
```
public static final int QuadArrowCallout
```

QuadArrowCallout.

##### Bevel
```
public static final int Bevel
```

Bevel.

##### LeftBracket
```
public static final int LeftBracket
```

LeftBracket.

##### RightBracket
```
public static final int RightBracket
```

RightBracket.

##### LeftBrace
```
public static final int LeftBrace
```

LeftBrace.

##### RightBrace
```
public static final int RightBrace
```

RightBrace.

##### LeftUpArrow
```
public static final int LeftUpArrow
```

LeftUpArrow.

##### BentUpArrow
```
public static final int BentUpArrow
```

BentUpArrow.

##### BentArrow
```
public static final int BentArrow
```

BentArrow.

##### Seal24
```
public static final int Seal24
```

Seal24.

##### StripedRightArrow
```
public static final int StripedRightArrow
```

StripedRightArrow.

##### NotchedRightArrow
```
public static final int NotchedRightArrow
```

NotchedRightArrow.

##### BlockArc
```
public static final int BlockArc
```

BlockArc.

##### SmileyFace
```
public static final int SmileyFace
```

SmileyFace.

##### VerticalScroll
```
public static final int VerticalScroll
```

VerticalScroll.

##### HorizontalScroll
```
public static final int HorizontalScroll
```

HorizontalScroll.

##### CircularArrow
```
public static final int CircularArrow
```

CircularArrow.

##### UturnArrow
```
public static final int UturnArrow
```

UturnArrow.

##### CurvedRightArrow
```
public static final int CurvedRightArrow
```

CurvedRightArrow.

##### CurvedLeftArrow
```
public static final int CurvedLeftArrow
```

CurvedLeftArrow.

##### CurvedUpArrow
```
public static final int CurvedUpArrow
```

CurvedUpArrow.

##### CurvedDownArrow
```
public static final int CurvedDownArrow
```

CurvedDownArrow.

##### CloudCallout
```
public static final int CloudCallout
```

CloudCallout.

##### EllipseRibbon
```
public static final int EllipseRibbon
```

EllipseRibbon.

##### EllipseRibbon2
```
public static final int EllipseRibbon2
```

EllipseRibbon2.

##### FlowChartProcess
```
public static final int FlowChartProcess
```

FlowChartProcess.

##### FlowChartDecision
```
public static final int FlowChartDecision
```

FlowChartDecision.

##### FlowChartInputOutput
```
public static final int FlowChartInputOutput
```

FlowChartInputOutput.

##### FlowChartPredefinedProcess
```
public static final int FlowChartPredefinedProcess
```

FlowChartPredefinedProcess.

##### FlowChartInternalStorage
```
public static final int FlowChartInternalStorage
```

FlowChartInternalStorage.

##### FlowChartDocument
```
public static final int FlowChartDocument
```

FlowChartDocument.

##### FlowChartMultidocument
```
public static final int FlowChartMultidocument
```

FlowChartMultidocument.

##### FlowChartTerminator
```
public static final int FlowChartTerminator
```

FlowChartTerminator.

##### FlowChartPreparation
```
public static final int FlowChartPreparation
```

FlowChartPreparation.

##### FlowChartManualInput
```
public static final int FlowChartManualInput
```

FlowChartManualInput.

##### FlowChartManualOperation
```
public static final int FlowChartManualOperation
```

FlowChartManualOperation.

##### FlowChartConnector
```
public static final int FlowChartConnector
```

FlowChartConnector.

##### FlowChartPunchedCard
```
public static final int FlowChartPunchedCard
```

FlowChartPunchedCard.

##### FlowChartPunchedTape
```
public static final int FlowChartPunchedTape
```

FlowChartPunchedTape.

##### FlowChartSummingJunction
```
public static final int FlowChartSummingJunction
```

FlowChartSummingJunction.

##### FlowChartOr
```
public static final int FlowChartOr
```

FlowChartOr.

##### FlowChartCollate
```
public static final int FlowChartCollate
```

FlowChartCollate.

##### FlowChartSort
```
public static final int FlowChartSort
```

FlowChartSort.

##### FlowChartExtract
```
public static final int FlowChartExtract
```

FlowChartExtract.

##### FlowChartMerge
```
public static final int FlowChartMerge
```

FlowChartOfflineStorage.

##### FlowChartOfflineStorage
```
public static final int FlowChartOfflineStorage
```

FlowChartOfflineStorage.

##### FlowChartOnlineStorage
```
public static final int FlowChartOnlineStorage
```

FlowChartOnlineStorage.

##### FlowChartMagneticTape
```
public static final int FlowChartMagneticTape
```

FlowChartMagneticTape.

##### FlowChartMagneticDisk
```
public static final int FlowChartMagneticDisk
```

FlowChartMagneticDisk.

##### FlowChartMagneticDrum
```
public static final int FlowChartMagneticDrum
```

FlowChartMagneticDrum.

##### FlowChartDisplay
```
public static final int FlowChartDisplay
```

FlowChartDisplay.

##### FlowChartDelay
```
public static final int FlowChartDelay
```

FlowChartDelay.

##### TextPlainText
```
public static final int TextPlainText
```

TextPlainText.

##### TextStop
```
public static final int TextStop
```

TextStop.

##### TextTriangle
```
public static final int TextTriangle
```

TextTriangle.

##### TextTriangleInverted
```
public static final int TextTriangleInverted
```

TextTriangleInverted.

##### TextChevron
```
public static final int TextChevron
```

TextChevron.

##### TextChevronInverted
```
public static final int TextChevronInverted
```

TextChevronInverted.

##### TextRingInside
```
public static final int TextRingInside
```

TextRingInside.

##### TextRingOutside
```
public static final int TextRingOutside
```

TextRingOutside.

##### TextArchUpCurve
```
public static final int TextArchUpCurve
```

TextArchUpCurve.

##### TextArchDownCurve
```
public static final int TextArchDownCurve
```

TextArchDownCurve.

##### TextCircleCurve
```
public static final int TextCircleCurve
```

TextCircleCurve.

##### TextButtonCurve
```
public static final int TextButtonCurve
```

TextButtonCurve.

##### TextArchUpPour
```
public static final int TextArchUpPour
```

TextArchUpPour.

##### TextArchDownPour
```
public static final int TextArchDownPour
```

TextArchDownPour.

##### TextCirclePour
```
public static final int TextCirclePour
```

TextCirclePour.

##### TextButtonPour
```
public static final int TextButtonPour
```

TextButtonPour.

##### TextCurveUp
```
public static final int TextCurveUp
```

TextCurveUp.

##### TextCurveDown
```
public static final int TextCurveDown
```

TextCurveDown.

##### TextCascadeUp
```
public static final int TextCascadeUp
```

TextCascadeUp.

##### TextCascadeDown
```
public static final int TextCascadeDown
```

TextCascadeDown.

##### TextWave1
```
public static final int TextWave1
```

TextWave1.

##### TextWave2
```
public static final int TextWave2
```

TextWave2.

##### TextWave3
```
public static final int TextWave3
```

TextWave3.

##### TextWave4
```
public static final int TextWave4
```

TextWave4.

##### TextInflate
```
public static final int TextInflate
```

TextInflate.

##### TextDeflate
```
public static final int TextDeflate
```

TextDeflate.

##### TextInflateBottom
```
public static final int TextInflateBottom
```

TextInflateBottom.

##### TextDeflateBottom
```
public static final int TextDeflateBottom
```

TextDeflateBottom.

##### TextInflateTop
```
public static final int TextInflateTop
```

TextInflateTop.

##### TextDeflateTop
```
public static final int TextDeflateTop
```

TextDeflateTop.

##### TextDeflateInflate
```
public static final int TextDeflateInflate
```

TextDeflateInflate.

##### TextDeflateInflateDeflate
```
public static final int TextDeflateInflateDeflate
```

TextDeflateInflateDeflate.

##### TextFadeRight
```
public static final int TextFadeRight
```

TextFadeRight.

##### TextFadeLeft
```
public static final int TextFadeLeft
```

TextFadeLeft.

##### TextFadeUp
```
public static final int TextFadeUp
```

TextFadeUp.

##### TextFadeDown
```
public static final int TextFadeDown
```

TextFadeDown.

##### TextSlantUp
```
public static final int TextSlantUp
```

TextSlantUp.

##### TextSlantDown
```
public static final int TextSlantDown
```

TextSlantDown.

##### TextCanUp
```
public static final int TextCanUp
```

TextCanUp.

##### TextCanDown
```
public static final int TextCanDown
```

TextCanDown.

##### FlowChartAlternateProcess
```
public static final int FlowChartAlternateProcess
```

FlowChartAlternateProcess.

##### FlowChartOffpageConnector
```
public static final int FlowChartOffpageConnector
```

FlowChartOffpageConnector.

##### Callout90
```
public static final int Callout90
```

Callout90.

##### AccentCallout90
```
public static final int AccentCallout90
```

AccentCallout90.

##### BorderCallout90
```
public static final int BorderCallout90
```

BorderCallout90.

##### AccentBorderCallout90
```
public static final int AccentBorderCallout90
```

AccentBorderCallout90.

##### LeftRightUpArrow
```
public static final int LeftRightUpArrow
```

LeftRightUpArrow.

##### Sun
```
public static final int Sun
```

Sun.

##### Moon
```
public static final int Moon
```

Moon.

##### BracketPair
```
public static final int BracketPair
```

BracketPair.

##### BracePair
```
public static final int BracePair
```

BracePair.

##### Seal4
```
public static final int Seal4
```

Seal4.

##### DoubleWave
```
public static final int DoubleWave
```

DoubleWave.

##### ActionButtonBlank
```
public static final int ActionButtonBlank
```

ActionButtonBlank.

##### ActionButtonHome
```
public static final int ActionButtonHome
```

ActionButtonHome.

##### ActionButtonHelp
```
public static final int ActionButtonHelp
```

ActionButtonHelp.

##### ActionButtonInformation
```
public static final int ActionButtonInformation
```

ActionButtonInformation.

##### ActionButtonForwardNext
```
public static final int ActionButtonForwardNext
```

ActionButtonForwardNext.

##### ActionButtonBackPrevious
```
public static final int ActionButtonBackPrevious
```

ActionButtonBackPrevious.

##### ActionButtonEnd
```
public static final int ActionButtonEnd
```

ActionButtonEnd.

##### ActionButtonBeginning
```
public static final int ActionButtonBeginning
```

ActionButtonBeginning.

##### ActionButtonReturn
```
public static final int ActionButtonReturn
```

ActionButtonReturn.

##### ActionButtonDocument
```
public static final int ActionButtonDocument
```

ActionButtonDocument.

##### ActionButtonSound
```
public static final int ActionButtonSound
```

ActionButtonSound.

##### ActionButtonMovie
```
public static final int ActionButtonMovie
```

ActionButtonMovie.

##### TextBox
```
public static final int TextBox
```

TextBox.

### TextSignatureImplementation
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/textsignatureimplementation.md

**Inheritance:**
java.lang.Object
```
public final class TextSignatureImplementation
```

Specifies type of implementation for PDF text signature.
#### Fields

| Field | Description |
| --- | --- |
| Native | Text Signature as native text object on document page. |
| Image | Text Signature as Image object on document page. |
| Annotation | Text Signature as Text Annotation object on PDF page. |
| Sticker | Text Signature as Sticker object on PDF page. |
| FormField | Text Signature as text in specified form field. |
| Watermark | Text Signature as watermark on document page. |
##### Native
```
public static final int Native
```

Text Signature as native text object on document page.

##### Image
```
public static final int Image
```

Text Signature as Image object on document page.

##### Annotation
```
public static final int Annotation
```

Text Signature as Text Annotation object on PDF page. Annotations are visible only for Licensed version.

##### Sticker
```
public static final int Sticker
```

Text Signature as Sticker object on PDF page.

##### FormField
```
public static final int FormField
```

Text Signature as text in specified form field. With this type of implementation could be used only TextSignOptions.Text, TextSignOptions.FormTextFieldType and TextSignOptions.FormTextFieldTitle options.

##### Watermark
```
public static final int Watermark
```

Text Signature as watermark on document page.

### TextVerticalAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/textverticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class TextVerticalAlignment
```

Specifies text vertical alignment inside a Signature.
#### Fields

| Field | Description |
| --- | --- |
| Top | Specifies that the text is top aligned to the vertical alignment base. |
| Center | Specifies that the text is centered to the vertical alignment base. |
| Bottom | Specifies that the text is bottom aligned to the vertical alignment base. |
##### Top
```
public static final int Top
```

Specifies that the text is top aligned to the vertical alignment base.

##### Center
```
public static final int Center
```

Specifies that the text is centered to the vertical alignment base.

##### Bottom
```
public static final int Bottom
```

Specifies that the text is bottom aligned to the vertical alignment base.

### VerticalAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/verticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class VerticalAlignment
```

Specifies vertical alignment of element on Document Page.
#### Fields

| Field | Description |
| --- | --- |
| None | The object is explicitly positioned, usually using its Top property. |
| Top | Specifies that the object shall be at the top of the vertical alignment base. |
| Center | Specifies that the object shall be centered with respect to the vertical alignment base. |
| Bottom | Specifies that the object shall be at the bottom of the vertical alignment base. |
##### None
```
public static final int None
```

The object is explicitly positioned, usually using its Top property.

##### Top
```
public static final int Top
```

Specifies that the object shall be at the top of the vertical alignment base.

##### Center
```
public static final int Center
```

Specifies that the object shall be centered with respect to the vertical alignment base.

##### Bottom
```
public static final int Bottom
```

Specifies that the object shall be at the bottom of the vertical alignment base.

### WordProcessingSaveFileFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/wordprocessingsavefileformat.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingSaveFileFormat
```

Defines different save file formats for WordProcessing documents.
#### Fields

| Field | Description |
| --- | --- |
| Default | File Format will not be changed. |
| Doc | Saves the document as Microsoft Word 97-2003 document. |
| Dot | Saves the document as Microsoft Word 97-2003 template. |
| Docx | Saves the document as Microsoft Word OpenXML document. |
| Docm | Saves the document as Microsoft Word OpenXML macro-enabled document. |
| Dotx | Saves the document as Microsoft Word OpenXML template. |
| Dotm | Saves the document as Microsoft Word OpenXML macro-enabled template. |
| FlatOpc | Saves the document as an Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package. |
| FlatOpcMacroEnabled | Saves the document as an Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplate | Saves the document as an Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package. |
| FlatOpcTemplateMacroEnabled | Saves the document as an Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package. |
| Rtf | Saves the document in the RTF Format. |
| WordML | Saves the document in the Microsoft Word 2003 WordprocessingML Format. |
| Pdf | Saves the document as PDF (Adobe Portable Document) Format. |
| Xps | Saves the document in the XPS (XML Paper Specification) Format. |
| Ps | Saves the document in the PS (PostScript) Format. |
| Mhtml | Saves the document in the MHTML (Web archive) Format. |
| Epub | Saves the document in the IDPF EPUB Format. |
| Odt | Saves the document as Open Office document. |
| Ott | Saves the document as Open Office document template. |
| Text | Saves the document in the plain text format. |
| Tiff | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| Png | Renders a page of the document and saves it as a PNG file. |
| Bmp | Renders a page of the document and saves it as a BMP file. |
| Emf | Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file. |
| Jpeg | Renders a page of the document and saves it as a JPEG file. |
| Azw3 | Renders a page of the document and saves it as a Azw3 file. |
##### Default
```
public static final int Default
```

File Format will not be changed.

##### Doc
```
public static final int Doc
```

Saves the document as Microsoft Word 97-2003 document.

##### Dot
```
public static final int Dot
```

Saves the document as Microsoft Word 97-2003 template.

##### Docx
```
public static final int Docx
```

Saves the document as Microsoft Word OpenXML document.

##### Docm
```
public static final int Docm
```

Saves the document as Microsoft Word OpenXML macro-enabled document.

##### Dotx
```
public static final int Dotx
```

Saves the document as Microsoft Word OpenXML template.

##### Dotm
```
public static final int Dotm
```

Saves the document as Microsoft Word OpenXML macro-enabled template.

##### FlatOpc
```
public static final int FlatOpc
```

Saves the document as an Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.

##### FlatOpcMacroEnabled
```
public static final int FlatOpcMacroEnabled
```

Saves the document as an Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package.

##### FlatOpcTemplate
```
public static final int FlatOpcTemplate
```

Saves the document as an Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package.

##### FlatOpcTemplateMacroEnabled
```
public static final int FlatOpcTemplateMacroEnabled
```

Saves the document as an Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package.

##### Rtf
```
public static final int Rtf
```

Saves the document in the RTF Format. All characters above 7-bits are escaped as hexadecimal or Unicode characters.

##### WordML
```
public static final int WordML
```

Saves the document in the Microsoft Word 2003 WordprocessingML Format.

##### Pdf
```
public static final int Pdf
```

Saves the document as PDF (Adobe Portable Document) Format.

##### Xps
```
public static final int Xps
```

Saves the document in the XPS (XML Paper Specification) Format.

##### Ps
```
public static final int Ps
```

Saves the document in the PS (PostScript) Format.

##### Mhtml
```
public static final int Mhtml
```

Saves the document in the MHTML (Web archive) Format.

##### Epub
```
public static final int Epub
```

Saves the document in the IDPF EPUB Format.

##### Odt
```
public static final int Odt
```

Saves the document as Open Office document.

##### Ott
```
public static final int Ott
```

Saves the document as Open Office document template.

##### Text
```
public static final int Text
```

Saves the document in the plain text format.

##### Tiff
```
public static final int Tiff
```

Renders a page or pages of the document and saves them into a single or multi-page TIFF file.

##### Png
```
public static final int Png
```

Renders a page of the document and saves it as a PNG file.

##### Bmp
```
public static final int Bmp
```

Renders a page of the document and saves it as a BMP file.

##### Emf
```
public static final int Emf
```

Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file.

##### Jpeg
```
public static final int Jpeg
```

Renders a page of the document and saves it as a JPEG file.

##### Azw3
```
public static final int Azw3
```

Renders a page of the document and saves it as a Azw3 file.

### WordProcessingTextSignatureImplementation
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/wordprocessingtextsignatureimplementation.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingTextSignatureImplementation
```

Specifies type of text signature implementation for WordProcessing documents.
#### Fields

| Field | Description |
| --- | --- |
| TextStamp | Text Signature as Label object on Words page. |
| TextAsImage | Text Signature as Image object on Words page. |
| TextToFormField | Text Signature as text in specified form field. |
| Watermark | Text Signature as watermark on Words page. |
##### TextStamp
```
public static final int TextStamp
```

Text Signature as Label object on Words page.

##### TextAsImage
```
public static final int TextAsImage
```

Text Signature as Image object on Words page.

##### TextToFormField
```
public static final int TextToFormField
```

Text Signature as text in specified form field. With this type of implementation could be used only TextSignOptions.Text, TextSignOptions.FormTextFieldTitle and TextSignOptions.FormTextFieldType options.

##### Watermark
```
public static final int Watermark
```

Text Signature as watermark on Words page.

### XAdESType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.enums/xadestype.md

**Inheritance:**
java.lang.Object
```
public final class XAdESType
```

Type of XML Advanced Electronic Signature (XAdES).
#### Fields

| Field | Description |
| --- | --- |
| None | XAdES is off. |
| XAdES | Basic XAdES. |
##### None
```
public static final int None
```

XAdES is off.

##### XAdES
```
public static final int XAdES
```

Basic XAdES.

### com.groupdocs.signature.domain.extensions.encryption
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.encryption.md

The **GroupDocs.Signature.Domain.Extensions.Encryption** namespace provides classes for working with Encryption

#### Classes

| Class | Description |
| --- | --- |
| SymmetricAlgorithmType | Represents symmetric encryption algorithm type. |
| SymmetricEncryption | Implements standard symmetric algorithms for data encryption with single key and passphrase (salt). |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDataEncryption | Encryption interface to provide object encoding and decoding methods. |

### IDataEncryption
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.encryption/idataencryption.md

### SymmetricAlgorithmType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.encryption/symmetricalgorithmtype.md

**Inheritance:**
java.lang.Object
```
public final class SymmetricAlgorithmType
```

Represents symmetric encryption algorithm type.
#### Fields

| Field | Description |
| --- | --- |
| Rijndael | Represents Rijndael symmetric encryption algorithm. |
| AES | Represents AES (Advanced Encryption Standard) encryption algorithm. |
| AESNew | Represents improved AES (Advanced Encryption Standard) encryption algorithm. |
##### Rijndael
```
public static final int Rijndael
```

Represents Rijndael symmetric encryption algorithm.

##### AES
```
public static final int AES
```

Represents AES (Advanced Encryption Standard) encryption algorithm.

##### AESNew
```
public static final int AESNew
```

Represents improved AES (Advanced Encryption Standard) encryption algorithm.

### SymmetricEncryption
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.encryption/symmetricencryption.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.encryption.IDataEncryption
```
public final class SymmetricEncryption implements IDataEncryption
```

Implements standard symmetric algorithms for data encryption with single key and passphrase (salt).
#### Constructors

| Constructor | Description |
| --- | --- |
| SymmetricEncryption(int algorithmType, String key, String salt) | Creates symmetric encryption algorithm with parameters. |
| SymmetricEncryption(int algorithmType, String key) | Creates symmetric encryption algorithm with default passphrase |
#### Methods

| Method | Description |
| --- | --- |
| getAlgorithmType() | Gets or sets type of symmetric algorithm. |
| setAlgorithmType(int value) | Gets or sets type of symmetric algorithm. |
| getKey() | Gets or sets key of encryption algorithm. |
| setKey(String value) | Gets or sets key of encryption algorithm. |
| getSalt() | Gets or sets passphrase of encryption algorithm. |
| setSalt(String value) | Gets or sets passphrase of encryption algorithm. |
| encode(String source) | Encrypts string based on provided algorithm type, key and salt parameters |
| decode(String source) | Decrypts string based on provided algorithm type, key and salt parameters |
##### SymmetricEncryption(int algorithmType, String key, String salt)
```
public SymmetricEncryption(int algorithmType, String key, String salt)
```

Creates symmetric encryption algorithm with parameters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | int | Specify symmetric algorithm type |
| key | java.lang.String | Encryption key |
| salt | java.lang.String | Passphrase for encryption |

##### SymmetricEncryption(int algorithmType, String key)
```
public SymmetricEncryption(int algorithmType, String key)
```

Creates symmetric encryption algorithm with default passphrase

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| algorithmType | int | Specify symmetric algorithm type |
| key | java.lang.String | Encryption key |

##### getAlgorithmType()
```
public final int getAlgorithmType()
```

Gets or sets type of symmetric algorithm.

**Returns:**
int
##### setAlgorithmType(int value)
```
public final void setAlgorithmType(int value)
```

Gets or sets type of symmetric algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getKey()
```
public final String getKey()
```

Gets or sets key of encryption algorithm.

**Returns:**
java.lang.String
##### setKey(String value)
```
public final void setKey(String value)
```

Gets or sets key of encryption algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSalt()
```
public final String getSalt()
```

Gets or sets passphrase of encryption algorithm.

**Returns:**
java.lang.String
##### setSalt(String value)
```
public final void setSalt(String value)
```

Gets or sets passphrase of encryption algorithm.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### encode(String source)
```
public final String encode(String source)
```

Encrypts string based on provided algorithm type, key and salt parameters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.String | Source string to encode. |

**Returns:**
java.lang.String - Returns encrypted string.
##### decode(String source)
```
public final String decode(String source)
```

Decrypts string based on provided algorithm type, key and salt parameters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.String | Encrypted string to decode. |

**Returns:**
java.lang.String - Returns decrypted string.

### com.groupdocs.signature.domain.extensions.hibclic
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.hibclic.md

The **GroupDocs.Signature.Domain.Extensions.HIBCLIC** namespace provides classes for working with HIBCLIC

#### Classes

| Class | Description |
| --- | --- |
| HIBCLICCombinedData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities. |
| HIBCLICDateFormat | Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code). |
| HIBCLICPrimaryData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data. |
| HIBCLICSecondaryAdditionalData | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data. |

### HIBCLICCombinedData
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.hibclic/hibcliccombineddata.md

**Inheritance:**
java.lang.Object
```
public class HIBCLICCombinedData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities.
#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICCombinedData() | Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values. |
#### Methods

| Method | Description |
| --- | --- |
| getPrimaryData() | HIBC LIC primary data structure |
| setPrimaryData(HIBCLICPrimaryData value) | HIBC LIC primary data structure |
| getSecondaryAdditionalData() | HIBC LIC secondary data structure |
| setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value) | HIBC LIC secondary data structure |
| deepClone() | Gets a copy of this object. |
| getCodetext() |  |
##### HIBCLICCombinedData()
```
public HIBCLICCombinedData()
```

Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values.

##### getPrimaryData()
```
public final HIBCLICPrimaryData getPrimaryData()
```

HIBC LIC primary data structure

**Returns:**
HIBCLICPrimaryData
##### setPrimaryData(HIBCLICPrimaryData value)
```
public final void setPrimaryData(HIBCLICPrimaryData value)
```

HIBC LIC primary data structure

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | HIBCLICPrimaryData |  |

##### getSecondaryAdditionalData()
```
public final HIBCLICSecondaryAdditionalData getSecondaryAdditionalData()
```

HIBC LIC secondary data structure

**Returns:**
HIBCLICSecondaryAdditionalData
##### setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value)
```
public final void setSecondaryAdditionalData(HIBCLICSecondaryAdditionalData value)
```

HIBC LIC secondary data structure

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | HIBCLICSecondaryAdditionalData |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### getCodetext()
```
public final IComplexCodetext getCodetext()
```

**Returns:**
com.aspose.barcode.complexbarcode.IComplexCodetext

### HIBCLICDateFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.hibclic/hibclicdateformat.md

**Inheritance:**
java.lang.Object
```
public final class HIBCLICDateFormat
```

Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code).
#### Fields

| Field | Description |
| --- | --- |
| YYYYMMDD | YYYYMMDD format. |
| MMYY | MMYY format. |
| MMDDYY | MMDDYY format. |
| YYMMDD | YYMMDD format. |
| YYMMDDHH | YYMMDDHH format. |
| YYJJJ | Julian date format. |
| YYJJJHH | Julian date format with hours. |
| None | Do not encode expiry date. |
##### YYYYMMDD
```
public static final int YYYYMMDD
```

YYYYMMDD format. Will be encoded in additional supplemental data.

##### MMYY
```
public static final int MMYY
```

MMYY format.

##### MMDDYY
```
public static final int MMDDYY
```

MMDDYY format.

##### YYMMDD
```
public static final int YYMMDD
```

YYMMDD format.

##### YYMMDDHH
```
public static final int YYMMDDHH
```

YYMMDDHH format.

##### YYJJJ
```
public static final int YYJJJ
```

Julian date format.

##### YYJJJHH
```
public static final int YYJJJHH
```

Julian date format with hours.

##### None
```
public static final int None
```

Do not encode expiry date.

### HIBCLICPrimaryData
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.hibclic/hibclicprimarydata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class HIBCLICPrimaryData implements IComplexData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data.
#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICPrimaryData() | Default ctor() |
#### Methods

| Method | Description |
| --- | --- |
| getLabelerIdentificationCode() | Identifies date of labeler identification code. |
| setLabelerIdentificationCode(String value) | Identifies date of labeler identification code. |
| getProductOrCatalogNumber() | Identifies product or catalog number. |
| setProductOrCatalogNumber(String value) | Identifies product or catalog number. |
| getUnitOfMeasureID() | Identifies unit of measure ID. |
| setUnitOfMeasureID(int value) | Identifies unit of measure ID. |
| deepClone() | Gets a copy of this object. |
| getCodetext() |  |
##### HIBCLICPrimaryData()
```
public HIBCLICPrimaryData()
```

Default ctor()

##### getLabelerIdentificationCode()
```
public final String getLabelerIdentificationCode()
```

Identifies date of labeler identification code. Labeler identification code must be 4 symbols alphanumeric string, with first character always being alphabetic.

**Returns:**
java.lang.String
##### setLabelerIdentificationCode(String value)
```
public final void setLabelerIdentificationCode(String value)
```

Identifies date of labeler identification code. Labeler identification code must be 4 symbols alphanumeric string, with first character always being alphabetic.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getProductOrCatalogNumber()
```
public final String getProductOrCatalogNumber()
```

Identifies product or catalog number. Product or catalog number must be alphanumeric string up to 18 symbols length.

**Returns:**
java.lang.String
##### setProductOrCatalogNumber(String value)
```
public final void setProductOrCatalogNumber(String value)
```

Identifies product or catalog number. Product or catalog number must be alphanumeric string up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUnitOfMeasureID()
```
public final int getUnitOfMeasureID()
```

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.

**Returns:**
int
##### setUnitOfMeasureID(int value)
```
public final void setUnitOfMeasureID(int value)
```

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### getCodetext()
```
public final IComplexCodetext getCodetext()
```

**Returns:**
com.aspose.barcode.complexbarcode.IComplexCodetext

### HIBCLICSecondaryAdditionalData
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.hibclic/hibclicsecondaryadditionaldata.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class HIBCLICSecondaryAdditionalData implements IComplexData
```

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data.
#### Constructors

| Constructor | Description |
| --- | --- |
| HIBCLICSecondaryAdditionalData() | Default ctor() |
#### Methods

| Method | Description |
| --- | --- |
| getExpiryDateFormat() | Identifies expiry date format. |
| setExpiryDateFormat(int value) | Identifies expiry date format. |
| getExpiryDate() | Identifies expiry date. |
| setExpiryDate(Date value) | Identifies expiry date. |
| getLotNumber() | Identifies lot or batch number. |
| setLotNumber(String value) | Identifies lot or batch number. |
| getSerialNumber() | Identifies serial number. |
| setSerialNumber(String value) | Identifies serial number. |
| getDateOfManufacture() | Identifies date of manufacture. |
| setDateOfManufacture(Date value) | Identifies date of manufacture. |
| getQuantity() | Identifies quantity, must be integer value from 0 to 500. |
| setQuantity(int value) | Identifies quantity, must be integer value from 0 to 500. |
| getLinkCharacter() | Identifies link character in output string. |
| setLinkCharacter(char value) | Identifies link character in output string. |
| deepClone() | Gets a copy of this object. |
##### HIBCLICSecondaryAdditionalData()
```
public HIBCLICSecondaryAdditionalData()
```

Default ctor()

##### getExpiryDateFormat()
```
public final int getExpiryDateFormat()
```

Identifies expiry date format.

**Returns:**
int
##### setExpiryDateFormat(int value)
```
public final void setExpiryDateFormat(int value)
```

Identifies expiry date format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpiryDate()
```
public final Date getExpiryDate()
```

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.

**Returns:**
java.util.Date
##### setExpiryDate(Date value)
```
public final void setExpiryDate(Date value)
```

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getLotNumber()
```
public final String getLotNumber()
```

Identifies lot or batch number. Lot/batch number must be alphanumeric string with up to 18 symbols length.

**Returns:**
java.lang.String
##### setLotNumber(String value)
```
public final void setLotNumber(String value)
```

Identifies lot or batch number. Lot/batch number must be alphanumeric string with up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSerialNumber()
```
public final String getSerialNumber()
```

Identifies serial number. Serial number must be alphanumeric string up to 18 symbols length.

**Returns:**
java.lang.String
##### setSerialNumber(String value)
```
public final void setSerialNumber(String value)
```

Identifies serial number. Serial number must be alphanumeric string up to 18 symbols length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDateOfManufacture()
```
public final Date getDateOfManufacture()
```

Identifies date of manufacture. Date of manufacture can be set to DateTime.MinValue in order not to use this field. Default value: DateTime.MinValue

**Returns:**
java.util.Date
##### setDateOfManufacture(Date value)
```
public final void setDateOfManufacture(Date value)
```

Identifies date of manufacture. Date of manufacture can be set to DateTime.MinValue in order not to use this field. Default value: DateTime.MinValue

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getQuantity()
```
public final int getQuantity()
```

Identifies quantity, must be integer value from 0 to 500. Quantity can be set to -1 in order not to use this field. Default value: -1

**Returns:**
int
##### setQuantity(int value)
```
public final void setQuantity(int value)
```

Identifies quantity, must be integer value from 0 to 500. Quantity can be set to -1 in order not to use this field. Default value: -1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLinkCharacter()
```
public final char getLinkCharacter()
```

Identifies link character in output string.

**Returns:**
char
##### setLinkCharacter(char value)
```
public final void setLinkCharacter(char value)
```

Identifies link character in output string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | char |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object

### com.groupdocs.signature.domain.extensions.mailmark2d
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.mailmark2d.md

The **GroupDocs.Signature.Domain.Extensions.MailMark2D** namespace provides classes for working with MailMark2D

#### Classes

| Class | Description |
| --- | --- |
| Mailmark2D | Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark |
| Mailmark2DType | 2D Mailmark Type defines size of Data Matrix barcode |

### Mailmark2D
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.mailmark2d/mailmark2d.md

**Inheritance:**
java.lang.Object
```
public class Mailmark2D
```

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark
#### Constructors

| Constructor | Description |
| --- | --- |
| Mailmark2D() | Creates Royal Mail Mailmark combined data with default primary and secondary data values. |
#### Methods

| Method | Description |
| --- | --- |
| getUPUCountryID() | Identifies the UPU Country ID.Max length: 4 characters. |
| setUPUCountryID(String value) | Identifies the UPU Country ID.Max length: 4 characters. |
| getInformationTypeID() | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| setInformationTypeID(String value) | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| getVersionID() | Identifies the barcode version as relevant to each Information Type ID. |
| getClass_() | Identifies the class of the item. |
| setClass(String value) | Identifies the class of the item. |
| getSupplyChainID() | Identifies the unique group of customers involved in the mailing. |
| setSupplyChainID(int value) | Identifies the unique group of customers involved in the mailing. |
| getItemID() | Identifies the unique item within the Supply Chain ID. |
| setItemID(int value) | Identifies the unique item within the Supply Chain ID. |
| getDestinationPostCodeAndDPS() | Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. |
| setDestinationPostCodeAndDPS(String value) | Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. |
| getRTSFlag() | Flag which indicates what level of Return to Sender service is being requested. |
| setRTSFlag(String value) | Flag which indicates what level of Return to Sender service is being requested. |
| getReturnToSenderPostCode() | Contains the Return to Sender Post Code but no DPS. |
| setReturnToSenderPostCode(String value) | Contains the Return to Sender Post Code but no DPS. |
| getCustomerContent() | Optional space for use by customer. |
| setCustomerContent(String value) | Optional space for use by customer. |
| getCustomerContentEncodeMode() | Encode mode of DataMatrix barcode. |
| setCustomerContentEncodeMode(int value) | Encode mode of DataMatrix barcode. |
| getDataMatrixType() | 2D Mailmark Type defines size of Data Matrix barcode. |
| setDataMatrixType(int value) | 2D Mailmark Type defines size of Data Matrix barcode. |
| deepClone() | Gets a copy of this object. |
##### Mailmark2D()
```
public Mailmark2D()
```

Creates Royal Mail Mailmark combined data with default primary and secondary data values.

##### getUPUCountryID()
```
public final String getUPUCountryID()
```

Identifies the UPU Country ID.Max length: 4 characters.

**Returns:**
java.lang.String
##### setUPUCountryID(String value)
```
public final void setUPUCountryID(String value)
```

Identifies the UPU Country ID.Max length: 4 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInformationTypeID()
```
public final String getInformationTypeID()
```

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

**Returns:**
java.lang.String
##### setInformationTypeID(String value)
```
public final void setInformationTypeID(String value)
```

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVersionID()
```
public final String getVersionID()
```

Identifies the barcode version as relevant to each Information Type ID.

Valid Values: "1" - currently used only this value (default) "0" and "2" to "9" and "A" to "Z" spare reserved for potential future use.

**Returns:**
java.lang.String
##### getClass_()
```
public final String getClass_()
```

Identifies the class of the item.

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

**Returns:**
java.lang.String
##### setClass(String value)
```
public final void setClass(String value)
```

Identifies the class of the item.

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSupplyChainID()
```
public final int getSupplyChainID()
```

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

**Returns:**
int
##### setSupplyChainID(int value)
```
public final void setSupplyChainID(int value)
```

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getItemID()
```
public final int getItemID()
```

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

**Returns:**
int
##### setItemID(int value)
```
public final void setItemID(int value)
```

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDestinationPostCodeAndDPS()
```
public final String getDestinationPostCodeAndDPS()
```

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

**Returns:**
java.lang.String
##### setDestinationPostCodeAndDPS(String value)
```
public final void setDestinationPostCodeAndDPS(String value)
```

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRTSFlag()
```
public final String getRTSFlag()
```

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

**Returns:**
java.lang.String
##### setRTSFlag(String value)
```
public final void setRTSFlag(String value)
```

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReturnToSenderPostCode()
```
public final String getReturnToSenderPostCode()
```

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

**Returns:**
java.lang.String
##### setReturnToSenderPostCode(String value)
```
public final void setReturnToSenderPostCode(String value)
```

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomerContent()
```
public final String getCustomerContent()
```

Optional space for use by customer.

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

**Returns:**
java.lang.String
##### setCustomerContent(String value)
```
public final void setCustomerContent(String value)
```

Optional space for use by customer.

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomerContentEncodeMode()
```
public final int getCustomerContentEncodeMode()
```

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

**Returns:**
int
##### setCustomerContentEncodeMode(int value)
```
public final void setCustomerContentEncodeMode(int value)
```

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataMatrixType()
```
public final int getDataMatrixType()
```

2D Mailmark Type defines size of Data Matrix barcode.

**Returns:**
int
##### setDataMatrixType(int value)
```
public final void setDataMatrixType(int value)
```

2D Mailmark Type defines size of Data Matrix barcode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object

### Mailmark2DType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.mailmark2d/mailmark2dtype.md

**Inheritance:**
java.lang.Object
```
public final class Mailmark2DType
```

2D Mailmark Type defines size of Data Matrix barcode
#### Fields

| Field | Description |
| --- | --- |
| Auto | Auto determine |
| Type_7 | 24 x 24 modules |
| Type_9 | 32 x 32 modules |
| Type_29 | 16 x 48 modules |
##### Auto
```
public static final int Auto
```

Auto determine

##### Type_7
```
public static final int Type_7
```

24 x 24 modules

##### Type_9
```
public static final int Type_9
```

32 x 32 modules

##### Type_29
```
public static final int Type_29
```

16 x 48 modules

### com.groupdocs.signature.domain.extensions.serialization
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization.md

The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.

#### Classes

| Class | Description |
| --- | --- |
| Address | Represents Address of VCard contact details. |
| CryptoCurrencyTransfer | Represents Crypto currency transfer (reciever or transfer) for QR-Code. |
| CryptoCurrencyType | Represents Crypto currency type. |
| DataMatrixEncodeMode | DataMatrix encoder's encoding mode, default to Auto |
| EPC | Represents European Payments Council Quick Response Code. |
| Email | Represents Email format for QR-Code. |
| Event | Represents standard QR-Code Event details. |
| MeCard | Represents MeCard standard contact details. |
| SMS | Represents SMS short message service details. |
| VCard | Represents VCard standard contact details. |
| WiFi | Represents WiFi network connection details. |
| WiFiEncryptionType | Represents WiFi Encryption type. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDataSerializer | Serialization interface to provide object serialization and deserialization methods. |

### Address
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/address.md

**Inheritance:**
java.lang.Object
```
public class Address
```

Represents Address of VCard contact details.
#### Constructors

| Constructor | Description |
| --- | --- |
| Address() |  |
#### Methods

| Method | Description |
| --- | --- |
| getStreet() | Get or set address street. |
| setStreet(String value) | Get or set address street. |
| getCity() | Get or set address city. |
| setCity(String value) | Get or set address city. |
| getState() | Get or set address state. |
| setState(String value) | Get or set address state. |
| getZIP() | Get or set address ZIP. |
| setZIP(String value) | Get or set address ZIP. |
| getCountry() | Get or set address country. |
| setCountry(String value) | Get or set address country. |
| equals(Object source) | Overwrites Equals method to compare Address properties |
| hashCode() | Overrides GetHashCode method |
##### Address()
```
public Address()
```

##### getStreet()
```
public final String getStreet()
```

Get or set address street.

**Returns:**
java.lang.String
##### setStreet(String value)
```
public final void setStreet(String value)
```

Get or set address street.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCity()
```
public final String getCity()
```

Get or set address city.

**Returns:**
java.lang.String
##### setCity(String value)
```
public final void setCity(String value)
```

Get or set address city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getState()
```
public final String getState()
```

Get or set address state.

**Returns:**
java.lang.String
##### setState(String value)
```
public final void setState(String value)
```

Get or set address state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getZIP()
```
public final String getZIP()
```

Get or set address ZIP.

**Returns:**
java.lang.String
##### setZIP(String value)
```
public final void setZIP(String value)
```

Get or set address ZIP.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCountry()
```
public final String getCountry()
```

Get or set address country.

**Returns:**
java.lang.String
##### setCountry(String value)
```
public final void setCountry(String value)
```

Get or set address country.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Address properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Address object to compare with. |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### CryptoCurrencyTransfer
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/cryptocurrencytransfer.md

**Inheritance:**
java.lang.Object
```
public class CryptoCurrencyTransfer
```

Represents Crypto currency transfer (reciever or transfer) for QR-Code.
#### Constructors

| Constructor | Description |
| --- | --- |
| CryptoCurrencyTransfer() |  |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Gets or sets one of supported crypto currency type. |
| setType(int value) | Gets or sets one of supported crypto currency type. |
| getAmount() | Gets or sets transfer amount. |
| setAmount(BigDecimal value) | Gets or sets transfer amount. |
| getAddress() | Gets or sets crypto currency public address. |
| setAddress(String value) | Gets or sets crypto currency public address. |
| getMessage() | Gets or sets optional transfer message. |
| setMessage(String value) | Gets or sets optional transfer message. |
| getCustomType() | Gets or sets optional transfer message. |
| setCustomType(String value) | Gets or sets optional transfer message. |
| equals(Object obj) | Overwrites Equals method to compare Crypto currency transfer properties |
| hashCode() | Overrides GetHashCode method |
##### CryptoCurrencyTransfer()
```
public CryptoCurrencyTransfer()
```

##### getType()
```
public final int getType()
```

Gets or sets one of supported crypto currency type.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Gets or sets one of supported crypto currency type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAmount()
```
public final BigDecimal getAmount()
```

Gets or sets transfer amount.

**Returns:**
java.math.BigDecimal
##### setAmount(BigDecimal value)
```
public final void setAmount(BigDecimal value)
```

Gets or sets transfer amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.math.BigDecimal |  |

##### getAddress()
```
public final String getAddress()
```

Gets or sets crypto currency public address.

**Returns:**
java.lang.String
##### setAddress(String value)
```
public final void setAddress(String value)
```

Gets or sets crypto currency public address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMessage()
```
public final String getMessage()
```

Gets or sets optional transfer message.

**Returns:**
java.lang.String
##### setMessage(String value)
```
public final void setMessage(String value)
```

Gets or sets optional transfer message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCustomType()
```
public final String getCustomType()
```

Gets or sets optional transfer message.

**Returns:**
java.lang.String
##### setCustomType(String value)
```
public final void setCustomType(String value)
```

Gets or sets optional transfer message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare Crypto currency transfer properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Crypto currency transfer object to compare with. |

**Returns:**
boolean - Returns true if passed Crypto currency transfer object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Crypto currency transfer hash code

### CryptoCurrencyType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/cryptocurrencytype.md

**Inheritance:**
java.lang.Object
```
public final class CryptoCurrencyType
```

Represents Crypto currency type.
#### Fields

| Field | Description |
| --- | --- |
| Custom | Represents custom crypto currency type. |
| Bitcoin | Represents Bitcoin crypto currency type. |
| BitcoinCash | Represents Bitcoin Cash crypto currency type. |
| Litecoin | Represents Litecoin crypto currency type. |
| Ethereum | Represents Ethereum crypto currency type. |
| Dash | Represents Dash crypto currency type. |
##### Custom
```
public static final int Custom
```

Represents custom crypto currency type.

##### Bitcoin
```
public static final int Bitcoin
```

Represents Bitcoin crypto currency type.

##### BitcoinCash
```
public static final int BitcoinCash
```

Represents Bitcoin Cash crypto currency type.

##### Litecoin
```
public static final int Litecoin
```

Represents Litecoin crypto currency type.

##### Ethereum
```
public static final int Ethereum
```

Represents Ethereum crypto currency type.

##### Dash
```
public static final int Dash
```

Represents Dash crypto currency type.

### DataMatrixEncodeMode
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/datamatrixencodemode.md

**Inheritance:**
java.lang.Object
```
public final class DataMatrixEncodeMode
```

DataMatrix encoder's encoding mode, default to Auto
#### Fields

| Field | Description |
| --- | --- |
| Auto | Automatically pick up the best encode mode for DataMatrix encoding |
| ASCII | Encodes one alphanumeric or two numeric characters per byte |
| Full | Encode 8 bit values |
| Custom | Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding |
| C40 | Uses C40 encoding. |
| Text | Uses Text encoding. |
| EDIFACT | Uses EDIFACT encoding. |
| ANSIX12 | Uses ANSI X12 encoding. |
| ExtendedCodetext | ExtendedCodetext mode allows to manually switch encoding schemes in code-text. |
##### Auto
```
public static final int Auto
```

Automatically pick up the best encode mode for DataMatrix encoding

##### ASCII
```
public static final int ASCII
```

Encodes one alphanumeric or two numeric characters per byte

##### Full
```
public static final int Full
```

Encode 8 bit values

##### Custom
```
public static final int Custom
```

Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding

##### C40
```
public static final int C40
```

Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters

##### Text
```
public static final int Text
```

Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters.

##### EDIFACT
```
public static final int EDIFACT
```

Uses EDIFACT encoding. Uses six bits per character, encodes digits, upper-case letters, and many punctuation marks, but has no support for lower-case letters.

##### ANSIX12
```
public static final int ANSIX12
```

Uses ANSI X12 encoding.

##### ExtendedCodetext
```
public static final int ExtendedCodetext
```

ExtendedCodetext mode allows to manually switch encoding schemes in code-text. Format : "\\Encodation\_scheme\_name:text\\Encodation\_scheme\_name:text". Allowed encoding schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto. Extended code-text example: @"\\ansix12:ANSIX12TEXT\\ascii:backslash must be \\\\ doubled\\edifact:EdifactEncodedText" All backslashes (\\) must be doubled in text.

### Email
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/email.md

**Inheritance:**
java.lang.Object
```
public class Email
```

Represents Email format for QR-Code.
#### Constructors

| Constructor | Description |
| --- | --- |
| Email() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAddress() | Get or set Email address. |
| setAddress(String value) | Get or set Email address. |
| getSubject() | Get or set email Subject. |
| setSubject(String value) | Get or set email Subject. |
| getBody() | Get or set Body of email message. |
| setBody(String value) | Get or set Body of email message. |
| equals(Object source) | Overwrites Equals method to compare Email properties |
| hashCode() | Overrides GetHashCode method |
##### Email()
```
public Email()
```

##### getAddress()
```
public final String getAddress()
```

Get or set Email address.

**Returns:**
java.lang.String
##### setAddress(String value)
```
public final void setAddress(String value)
```

Get or set Email address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Get or set email Subject.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Get or set email Subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBody()
```
public final String getBody()
```

Get or set Body of email message.

**Returns:**
java.lang.String
##### setBody(String value)
```
public final void setBody(String value)
```

Get or set Body of email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Email properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Email object to compare with. |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### EPC
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/epc.md

**Inheritance:**
java.lang.Object
```
public final class EPC
```

Represents European Payments Council Quick Response Code.
#### Constructors

| Constructor | Description |
| --- | --- |
| EPC() | Instantiates new EPC object. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets Beneficiary's Name. |
| setName(String value) | Gets or sets Beneficiary's Name. |
| getBIC() | Gets or sets Beneficiary's BIC with up to 11 characters length. |
| setBIC(String value) | Gets or sets Beneficiary's BIC with up to 11 characters length. |
| getIBAN() | Gets or sets Beneficiary's Account (IBAN). |
| setIBAN(String value) | Gets or sets Beneficiary's Account (IBAN). |
| getAmount() | Gets or sets amount. |
| setAmount(double value) | Gets or sets amount. |
| getCode() | Gets or sets Business Code up to 4 characters. |
| setCode(String value) | Gets or sets Business Code up to 4 characters. |
| getReference() | Gets or sets Payment Reference (maximum 35 characters). |
| setReference(String value) | Gets or sets Payment Reference (maximum 35 characters). |
| getRemittance() | Gets or sets Remittance Information (maximum 140 characters). |
| setRemittance(String value) | Gets or sets Remittance Information (maximum 140 characters). |
| getInformation() | Gets or sets hint information. |
| setInformation(String value) | Gets or sets hint information. |
| getVersion() | EPC / SEPA QR-Code version implementation. |
| setVersion(String value) | EPC / SEPA QR-Code version implementation. |
| getCharset() | EPC / SEPA QR-Code char set implementation. |
| setCharset(String value) | EPC / SEPA QR-Code char set implementation. |
| getIdentification() | EPC / SEPA QR-Code identification. |
| setIdentification(String value) | EPC / SEPA QR-Code identification. |
| equals(Object source) | Overwrites Equals method to compare EPC properties |
| hashCode() | Overrides GetHashCode method |
##### EPC()
```
public EPC()
```

Instantiates new EPC object.

##### getName()
```
public final String getName()
```

Gets or sets Beneficiary's Name. Maximum length is 70 characters.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets Beneficiary's Name. Maximum length is 70 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBIC()
```
public final String getBIC()
```

Gets or sets Beneficiary's BIC with up to 11 characters length.

**Returns:**
java.lang.String
##### setBIC(String value)
```
public final void setBIC(String value)
```

Gets or sets Beneficiary's BIC with up to 11 characters length.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIBAN()
```
public final String getIBAN()
```

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.

**Returns:**
java.lang.String
##### setIBAN(String value)
```
public final void setIBAN(String value)
```

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAmount()
```
public final double getAmount()
```

Gets or sets amount.

**Returns:**
double
##### setAmount(double value)
```
public final void setAmount(double value)
```

Gets or sets amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getCode()
```
public final String getCode()
```

Gets or sets Business Code up to 4 characters.

**Returns:**
java.lang.String
##### setCode(String value)
```
public final void setCode(String value)
```

Gets or sets Business Code up to 4 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReference()
```
public final String getReference()
```

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.

**Returns:**
java.lang.String
##### setReference(String value)
```
public final void setReference(String value)
```

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getRemittance()
```
public final String getRemittance()
```

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.

**Returns:**
java.lang.String
##### setRemittance(String value)
```
public final void setRemittance(String value)
```

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInformation()
```
public final String getInformation()
```

Gets or sets hint information. Maximum 70 characters.

**Returns:**
java.lang.String
##### setInformation(String value)
```
public final void setInformation(String value)
```

Gets or sets hint information. Maximum 70 characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVersion()
```
public final String getVersion()
```

EPC / SEPA QR-Code version implementation. By default this value set to 002.

**Returns:**
java.lang.String
##### setVersion(String value)
```
public final void setVersion(String value)
```

EPC / SEPA QR-Code version implementation. By default this value set to 002.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCharset()
```
public final String getCharset()
```

EPC / SEPA QR-Code char set implementation. By default this value set to 1

**Returns:**
java.lang.String
##### setCharset(String value)
```
public final void setCharset(String value)
```

EPC / SEPA QR-Code char set implementation. By default this value set to 1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIdentification()
```
public final String getIdentification()
```

EPC / SEPA QR-Code identification. By default this value set to SCT

**Returns:**
java.lang.String
##### setIdentification(String value)
```
public final void setIdentification(String value)
```

EPC / SEPA QR-Code identification. By default this value set to SCT

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare EPC properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | EPC object to compare with. |

**Returns:**
boolean - Returns true if passed address object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Email hash code

### Event
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/event.md

**Inheritance:**
java.lang.Object
```
public final class Event
```

Represents standard QR-Code Event details.
#### Constructors

| Constructor | Description |
| --- | --- |
| Event() | Creates Event instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets or sets event title. |
| setTitle(String value) | Gets or sets event title. |
| getDescription() | Gets or sets description. |
| setDescription(String value) | Gets or sets description. |
| getLocation() | Gets or sets event location. |
| setLocation(String value) | Gets or sets event location. |
| getStartDate() | Gets or sets event start date and time. |
| setStartDate(Date value) | Gets or sets event start date and time. |
| getEndDate() | Gets or sets event end date and time. |
| setEndDate(Date value) | Gets or sets event end date and time. |
| equals(Object source) | Overwrites Equals method to compare Event properties |
| hashCode() | Overrides GetHashCode method |
##### Event()
```
public Event()
```

Creates Event instance with default values.

##### getTitle()
```
public final String getTitle()
```

Gets or sets event title.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets event title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDescription()
```
public final String getDescription()
```

Gets or sets description.

**Returns:**
java.lang.String
##### setDescription(String value)
```
public final void setDescription(String value)
```

Gets or sets description.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Gets or sets event location.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Gets or sets event location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStartDate()
```
public final Date getStartDate()
```

Gets or sets event start date and time.

**Returns:**
java.util.Date
##### setStartDate(Date value)
```
public final void setStartDate(Date value)
```

Gets or sets event start date and time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getEndDate()
```
public final Date getEndDate()
```

Gets or sets event end date and time.

**Returns:**
java.util.Date
##### setEndDate(Date value)
```
public final void setEndDate(Date value)
```

Gets or sets event end date and time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare Event properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | Event object to compare with. |

**Returns:**
boolean - Returns true if passed Event object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Event hash code

### IDataSerializer
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/idataserializer.md

### MeCard
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/mecard.md

**Inheritance:**
java.lang.Object
```
public final class MeCard
```

Represents MeCard standard contact details.
#### Constructors

| Constructor | Description |
| --- | --- |
| MeCard() | Creates MeCard instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets contact Name. |
| setName(String value) | Gets or sets contact Name. |
| getNickname() | Gets or sets contact Nickname. |
| setNickname(String value) | Gets or sets contact Nickname. |
| getPhone() | Gets or sets phone number. |
| setPhone(String value) | Gets or sets phone number. |
| getAltPhone() | Gets or sets alternative phone number. |
| setAltPhone(String value) | Gets or sets alternative phone number. |
| getReading() | Gets or sets reading of name. |
| setReading(String value) | Gets or sets reading of name. |
| getEmail() | Gets or sets contact email. |
| setEmail(String value) | Gets or sets contact email. |
| getNote() | Gets or sets Note (Company) of contact. |
| setNote(String value) | Gets or sets Note (Company) of contact. |
| getUrl() | Gets or sets URL. |
| setUrl(String value) | Gets or sets URL. |
| getAddress() | Gets or sets Home Address properties. |
| setAddress(Address value) | Gets or sets Home Address properties. |
| getBirthDay() | Gets or sets contact birthday. |
| setBirthDay(Date value) | Gets or sets contact birthday. |
| equals(Object source) | Overwrites Equals method to compare MeCard properties |
| hashCode() | Overrides GetHashCode method |
##### MeCard()
```
public MeCard()
```

Creates MeCard instance with default values.

##### getName()
```
public final String getName()
```

Gets or sets contact Name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets contact Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNickname()
```
public final String getNickname()
```

Gets or sets contact Nickname.

**Returns:**
java.lang.String
##### setNickname(String value)
```
public final void setNickname(String value)
```

Gets or sets contact Nickname.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPhone()
```
public final String getPhone()
```

Gets or sets phone number.

**Returns:**
java.lang.String
##### setPhone(String value)
```
public final void setPhone(String value)
```

Gets or sets phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAltPhone()
```
public final String getAltPhone()
```

Gets or sets alternative phone number.

**Returns:**
java.lang.String
##### setAltPhone(String value)
```
public final void setAltPhone(String value)
```

Gets or sets alternative phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReading()
```
public final String getReading()
```

Gets or sets reading of name.

**Returns:**
java.lang.String
##### setReading(String value)
```
public final void setReading(String value)
```

Gets or sets reading of name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets contact email.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets contact email.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNote()
```
public final String getNote()
```

Gets or sets Note (Company) of contact.

**Returns:**
java.lang.String
##### setNote(String value)
```
public final void setNote(String value)
```

Gets or sets Note (Company) of contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUrl()
```
public final String getUrl()
```

Gets or sets URL.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Gets or sets URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddress()
```
public final Address getAddress()
```

Gets or sets Home Address properties. This property is not initialized by default.

**Returns:**
Address
##### setAddress(Address value)
```
public final void setAddress(Address value)
```

Gets or sets Home Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getBirthDay()
```
public final Date getBirthDay()
```

Gets or sets contact birthday.

**Returns:**
java.util.Date
##### setBirthDay(Date value)
```
public final void setBirthDay(Date value)
```

Gets or sets contact birthday.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare MeCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | MeCard object to compare with. |

**Returns:**
boolean - Returns true if passed MeCard object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - MeCard hash code

### SMS
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/sms.md

**Inheritance:**
java.lang.Object
```
public class SMS
```

Represents SMS short message service details.
#### Constructors

| Constructor | Description |
| --- | --- |
| SMS() | Creates VCard instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getNumber() | Gets or sets SMS receipient phone number. |
| setNumber(String value) | Gets or sets SMS receipient phone number. |
| getMessage() | Gets or sets SMS message content. |
| setMessage(String value) | Gets or sets SMS message content. |
| equals(Object obj) | Overwrites Equals method to compare SMS properties |
| hashCode() | Overrides GetHashCode method |
##### SMS()
```
public SMS()
```

Creates VCard instance with default values.

##### getNumber()
```
public final String getNumber()
```

Gets or sets SMS receipient phone number.

**Returns:**
java.lang.String
##### setNumber(String value)
```
public final void setNumber(String value)
```

Gets or sets SMS receipient phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMessage()
```
public final String getMessage()
```

Gets or sets SMS message content.

**Returns:**
java.lang.String
##### setMessage(String value)
```
public final void setMessage(String value)
```

Gets or sets SMS message content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare SMS properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | SMS object to compare with. |

**Returns:**
boolean - Returns true if passed SMS object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### VCard
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/vcard.md

**Inheritance:**
java.lang.Object
```
public class VCard
```

Represents VCard standard contact details.
#### Constructors

| Constructor | Description |
| --- | --- |
| VCard() | Creates VCard instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getFirstName() | Get or set contact First Name. |
| setFirstName(String value) | Get or set contact First Name. |
| getMidddleName() | Get or set contact Middle Name. |
| setMidddleName(String value) | Get or set contact Middle Name. |
| getLastName() | Get or set contact Last Name. |
| setLastName(String value) | Get or set contact Last Name. |
| getInitials() | Get or set contact initials. |
| setInitials(String value) | Get or set contact initials. |
| getCompany() | Get or set Company of contact. |
| setCompany(String value) | Get or set Company of contact. |
| getJobTitle() | Get or set contact Job Title. |
| setJobTitle(String value) | Get or set contact Job Title. |
| getHomeAddress() | Gets or sets Home Address properties. |
| setHomeAddress(Address value) | Gets or sets Home Address properties. |
| getWorkAddress() | Gets or sets Work Address properties. |
| setWorkAddress(Address value) | Gets or sets Work Address properties. |
| getHomePhone() | Gets or sets home phone number. |
| setHomePhone(String value) | Gets or sets home phone number. |
| getWorkPhone() | Gets or sets work phone number. |
| setWorkPhone(String value) | Gets or sets work phone number. |
| getCellPhone() | Gets or sets cellular phone number. |
| setCellPhone(String value) | Gets or sets cellular phone number. |
| getEmail() | Gets or sets contact email. |
| setEmail(String value) | Gets or sets contact email. |
| getUrl() | Gets or sets contact URL. |
| setUrl(String value) | Gets or sets contact URL. |
| getBirthDay() | Gets or sets contact birthday. |
| setBirthDay(Date value) | Gets or sets contact birthday. |
| equals(Object source) | Overwrites Equals method to compare VCard properties |
| hashCode() | Overrides GetHashCode method |
##### VCard()
```
public VCard()
```

Creates VCard instance with default values.

##### getFirstName()
```
public final String getFirstName()
```

Get or set contact First Name.

**Returns:**
java.lang.String
##### setFirstName(String value)
```
public final void setFirstName(String value)
```

Get or set contact First Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMidddleName()
```
public final String getMidddleName()
```

Get or set contact Middle Name.

**Returns:**
java.lang.String
##### setMidddleName(String value)
```
public final void setMidddleName(String value)
```

Get or set contact Middle Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLastName()
```
public final String getLastName()
```

Get or set contact Last Name.

**Returns:**
java.lang.String
##### setLastName(String value)
```
public final void setLastName(String value)
```

Get or set contact Last Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInitials()
```
public final String getInitials()
```

Get or set contact initials.

**Returns:**
java.lang.String
##### setInitials(String value)
```
public final void setInitials(String value)
```

Get or set contact initials.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCompany()
```
public final String getCompany()
```

Get or set Company of contact.

**Returns:**
java.lang.String
##### setCompany(String value)
```
public final void setCompany(String value)
```

Get or set Company of contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getJobTitle()
```
public final String getJobTitle()
```

Get or set contact Job Title.

**Returns:**
java.lang.String
##### setJobTitle(String value)
```
public final void setJobTitle(String value)
```

Get or set contact Job Title.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHomeAddress()
```
public final Address getHomeAddress()
```

Gets or sets Home Address properties. This property is not initialized by default.

**Returns:**
Address
##### setHomeAddress(Address value)
```
public final void setHomeAddress(Address value)
```

Gets or sets Home Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getWorkAddress()
```
public final Address getWorkAddress()
```

Gets or sets Work Address properties. This property is not initialized by default.

**Returns:**
Address
##### setWorkAddress(Address value)
```
public final void setWorkAddress(Address value)
```

Gets or sets Work Address properties. This property is not initialized by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Address |  |

##### getHomePhone()
```
public final String getHomePhone()
```

Gets or sets home phone number.

**Returns:**
java.lang.String
##### setHomePhone(String value)
```
public final void setHomePhone(String value)
```

Gets or sets home phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getWorkPhone()
```
public final String getWorkPhone()
```

Gets or sets work phone number.

**Returns:**
java.lang.String
##### setWorkPhone(String value)
```
public final void setWorkPhone(String value)
```

Gets or sets work phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCellPhone()
```
public final String getCellPhone()
```

Gets or sets cellular phone number.

**Returns:**
java.lang.String
##### setCellPhone(String value)
```
public final void setCellPhone(String value)
```

Gets or sets cellular phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets contact email.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets contact email.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUrl()
```
public final String getUrl()
```

Gets or sets contact URL.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Gets or sets contact URL.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBirthDay()
```
public final Date getBirthDay()
```

Gets or sets contact birthday.

**Returns:**
java.util.Date
##### setBirthDay(Date value)
```
public final void setBirthDay(Date value)
```

Gets or sets contact birthday.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### equals(Object source)
```
public boolean equals(Object source)
```

Overwrites Equals method to compare VCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.lang.Object | VCard object to compare with. |

**Returns:**
boolean - Returns true if passed VCard object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### WiFi
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/wifi.md

**Inheritance:**
java.lang.Object
```
public class WiFi
```

Represents WiFi network connection details.
#### Constructors

| Constructor | Description |
| --- | --- |
| WiFi() | Creates VCard instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getSSID() | Gets or sets WiFi SSID Name. |
| setSSID(String value) | Gets or sets WiFi SSID Name. |
| getPassword() | Gets or sets WiFi Password. |
| setPassword(String value) | Gets or sets WiFi Password. |
| getEncryption() | Gets or sets WiFi encryption WiFiEncryptionType. |
| setEncryption(int value) | Gets or sets WiFi encryption WiFiEncryptionType. |
| getHidden() | Gets or sets if WiFi is Hidden SSID. |
| setHidden(boolean value) | Gets or sets if WiFi is Hidden SSID. |
| equals(Object obj) | Overwrites Equals method to compare VCard properties |
| hashCode() | Overrides GetHashCode method |
##### WiFi()
```
public WiFi()
```

Creates VCard instance with default values.

##### getSSID()
```
public final String getSSID()
```

Gets or sets WiFi SSID Name.

**Returns:**
java.lang.String
##### setSSID(String value)
```
public final void setSSID(String value)
```

Gets or sets WiFi SSID Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets WiFi Password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets WiFi Password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEncryption()
```
public final int getEncryption()
```

Gets or sets WiFi encryption WiFiEncryptionType.

**Returns:**
int
##### setEncryption(int value)
```
public final void setEncryption(int value)
```

Gets or sets WiFi encryption WiFiEncryptionType.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHidden()
```
public final boolean getHidden()
```

Gets or sets if WiFi is Hidden SSID.

**Returns:**
boolean
##### setHidden(boolean value)
```
public final void setHidden(boolean value)
```

Gets or sets if WiFi is Hidden SSID.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overwrites Equals method to compare VCard properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | VCard object to compare with. |

**Returns:**
boolean - Returns true if passed VCard object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - VCard hash code

### WiFiEncryptionType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.serialization/wifiencryptiontype.md

**Inheritance:**
java.lang.Object
```
public final class WiFiEncryptionType
```

Represents WiFi Encryption type.
#### Fields

| Field | Description |
| --- | --- |
| None | Represents no encryption WiFi type. |
| WPA | Represents WiFi with the WPA encryption type. |
| WPAEAP | Represents WiFi with the WPA-EAP encryption type. |
| WPAWPA2 | Represents WiFi with the WPA/WPA2 encryption type. |
| WEP | Represents WiFi with the WEP encryption type. |
##### None
```
public static final int None
```

Represents no encryption WiFi type.

##### WPA
```
public static final int WPA
```

Represents WiFi with the WPA encryption type.

##### WPAEAP
```
public static final int WPAEAP
```

Represents WiFi with the WPA-EAP encryption type.

##### WPAWPA2
```
public static final int WPAWPA2
```

Represents WiFi with the WPA/WPA2 encryption type.

##### WEP
```
public static final int WEP
```

Represents WiFi with the WEP encryption type.

### com.groupdocs.signature.domain.extensions.signoptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.signoptions.md

The **GroupDocs.Signature.Domain.Extensions.SignOptions** namespace provides classes for working with SignOptions

#### Classes

| Class | Description |
| --- | --- |
| DigitalVBA | Represents digital signature for Spreadsheets VBA projects. |
| SignatureExtension | Represents base class for signatures extensions. |
| SpreadsheetPosition | Defines signature position for Spreadsheet documents. |
| TextShadow | Represents text shadow properties for text signatures. |

### DigitalVBA
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.signoptions/digitalvba.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class DigitalVBA extends SignatureExtension
```

Represents digital signature for Spreadsheets VBA projects. It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm. If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing.
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalVBA(String certificateFilePath, String password) | Initializes a new instance of the DigitalVBA class with certificate file. |
| DigitalVBA(InputStream certificateStream, String password) | Initializes a new instance of the DigitalVBA class with certificate stream. |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Gets or sets the signature comments. |
| setComments(String value) | Gets or sets the signature comments. |
| getPassword() | Gets or sets the password of digital certificate. |
| setPassword(String value) | Gets or sets the password of digital certificate. |
| getSignOnlyVBAProject() | Gets or sets setting of only VBA project signing. |
| setSignOnlyVBAProject(boolean value) | Gets or sets setting of only VBA project signing. |
| getCertificateFilePath() | Gets digital certificate file path. |
| getCertificateStream() | Gets digital certificate stream. |
| release() | Override method to clean up resources after signing. |
##### DigitalVBA(String certificateFilePath, String password)
```
public DigitalVBA(String certificateFilePath, String password)
```

Initializes a new instance of the DigitalVBA class with certificate file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path |
| password | java.lang.String | Digital certificate password |

##### DigitalVBA(InputStream certificateStream, String password)
```
public DigitalVBA(InputStream certificateStream, String password)
```

Initializes a new instance of the DigitalVBA class with certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream |
| password | java.lang.String | Digital certificate password |

##### getComments()
```
public final String getComments()
```

Gets or sets the signature comments.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Gets or sets the signature comments.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets the password of digital certificate.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets the password of digital certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignOnlyVBAProject()
```
public final boolean getSignOnlyVBAProject()
```

Gets or sets setting of only VBA project signing. If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.

**Returns:**
boolean
##### setSignOnlyVBAProject(boolean value)
```
public final void setSignOnlyVBAProject(boolean value)
```

Gets or sets setting of only VBA project signing. If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

Gets digital certificate file path. This property is used only if CertificateStream is not specified.

**Returns:**
java.lang.String
##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Gets digital certificate stream. If this property is specified it is always used instead CertificateFilePath.

**Returns:**
java.io.InputStream
##### release()
```
public void release()
```

Override method to clean up resources after signing.

### SignatureExtension
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.signoptions/signatureextension.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Cloneable
```
public abstract class SignatureExtension implements Cloneable
```

Represents base class for signatures extensions.
#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureExtension() |  |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Gets a copy of this object. |
| release() | Releasing resources. |
##### SignatureExtension()
```
public SignatureExtension()
```

##### deepClone()
```
public Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### release()
```
public void release()
```

Releasing resources.

### SpreadsheetPosition
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.signoptions/spreadsheetposition.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class SpreadsheetPosition extends SignatureExtension
```

Defines signature position for Spreadsheet documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetPosition(int row, int column) | Creates Spreadsheer siganture position with predefined row and column. |
#### Methods

| Method | Description |
| --- | --- |
| getRow() | Gets or sets the top row number of signature (min value is 0). |
| setRow(int value) | Gets or sets the top row number of signature (min value is 0). |
| getColumn() | Gets or sets the left column number of signature (min value is 0). |
| setColumn(int value) | Gets or sets the left column number of signature (min value is 0). |
##### SpreadsheetPosition(int row, int column)
```
public SpreadsheetPosition(int row, int column)
```

Creates Spreadsheer siganture position with predefined row and column.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | int |  |
| column | int |  |

##### getRow()
```
public final int getRow()
```

Gets or sets the top row number of signature (min value is 0).

**Returns:**
int
##### setRow(int value)
```
public final void setRow(int value)
```

Gets or sets the top row number of signature (min value is 0).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getColumn()
```
public final int getColumn()
```

Gets or sets the left column number of signature (min value is 0).

**Returns:**
int
##### setColumn(int value)
```
public final void setColumn(int value)
```

Gets or sets the left column number of signature (min value is 0).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### TextShadow
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.signoptions/textshadow.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension
```
public class TextShadow extends SignatureExtension
```

Represents text shadow properties for text signatures. The result may vary depending on the signature type and document format. TextShadow is recommended for using with TextAsImage signature for all supported document types, also with simple TextSignature and TextSignature as watermark for Cells (.xslx) and Slides (.pptx). Simple TextSignature for Words (.docx) is recommended too, but has limited functionality.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextShadow() | Creates TextShadow with default options. |
#### Methods

| Method | Description |
| --- | --- |
| getDistance() | Gets or sets distance from text to shadow. |
| setDistance(double value) | Gets or sets distance from text to shadow. |
| getAngle() | Gets or sets angle for placing shadow relative to the text. |
| setAngle(double value) | Gets or sets angle for placing shadow relative to the text. |
| getColor() | Gets or sets color of the shadow. |
| setColor(Color value) | Gets or sets color of the shadow. |
| setColor(String value) | Gets or sets color of the shadow. |
| getTransparency() | Gets or sets transparency of the shadow. |
| setTransparency(double value) | Gets or sets transparency of the shadow. |
| getBlur() | Gets or sets blur of the shadow. |
| setBlur(double value) | Gets or sets blur of the shadow. |
##### TextShadow()
```
public TextShadow()
```

Creates TextShadow with default options.

##### getDistance()
```
public final double getDistance()
```

Gets or sets distance from text to shadow. Default value is 1.

**Returns:**
double
##### setDistance(double value)
```
public final void setDistance(double value)
```

Gets or sets distance from text to shadow. Default value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getAngle()
```
public final double getAngle()
```

Gets or sets angle for placing shadow relative to the text. Default value is 0.

**Returns:**
double
##### setAngle(double value)
```
public final void setAngle(double value)
```

Gets or sets angle for placing shadow relative to the text. Default value is 0.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getColor()
```
public final Color getColor()
```

Gets or sets color of the shadow. Default value is Black.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets color of the shadow. Default value is Black.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets color of the shadow. Default value is Black.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets transparency of the shadow. Default value is 0.

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets transparency of the shadow. Default value is 0.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBlur()
```
public final double getBlur()
```

Gets or sets blur of the shadow. Default value is 4.

**Returns:**
double
##### setBlur(double value)
```
public final void setBlur(double value)
```

Gets or sets blur of the shadow. Default value is 4.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

### com.groupdocs.signature.domain.extensions.swissqr
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.swissqr.md

The **GroupDocs.Signature.Domain.Extensions.SwissQR** namespace provides classes for working with SwissQR

#### Classes

| Class | Description |
| --- | --- |
| SwissAddress | Represents the address of the creditor or debtor. |
| SwissQR | Class for encoding and decoding the text embedded in the SwissQR code. |

### SwissAddress
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.swissqr/swissaddress.md

**Inheritance:**
java.lang.Object
```
public class SwissAddress
```

Represents the address of the creditor or debtor. You can either set street, house number, postal code, and town (structured address type) or address line 1 and 2 (combined address elements type).
#### Constructors

| Constructor | Description |
| --- | --- |
| SwissAddress() |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets or sets the name, either the first and last name of a natural person or the company name of a legal person. |
| setName(String value) | Gets or sets the name, either the first and last name of a natural person or the company name of a legal person. |
| getAddressLine1() | Gets or sets the address line 1. |
| setAddressLine1(String value) | Gets or sets the address line 1. |
| getAddressLine2() | Gets or sets the address line 2. |
| setAddressLine2(String value) | Gets or sets the address line 2. |
| getStreet() | Gets or sets the street. |
| setStreet(String value) | Gets or sets the street. |
| getHouseNo() | Gets or sets the house number. |
| setHouseNo(String value) | Gets or sets the house number. |
| getPostalCode() | Gets or sets the postal code. |
| setPostalCode(String value) | Gets or sets the postal code. |
| getTown() | Gets or sets the town or city. |
| setTown(String value) | Gets or sets the town or city. |
| getCountryCode() | Gets or sets the two-letter ISO country code. |
| setCountryCode(String value) | Gets or sets the two-letter ISO country code. |
##### SwissAddress()
```
public SwissAddress()
```

##### getName()
```
public final String getName()
```

Gets or sets the name, either the first and last name of a natural person or the company name of a legal person.

Value: The name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Gets or sets the name, either the first and last name of a natural person or the company name of a legal person.

Value: The name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddressLine1()
```
public final String getAddressLine1()
```

Gets or sets the address line 1. Address line 1 contains street name, house number or P.O. box. This field is only used for combined elements addresses and is optional.

Value: The address line 1.

**Returns:**
java.lang.String
##### setAddressLine1(String value)
```
public final void setAddressLine1(String value)
```

Gets or sets the address line 1. Address line 1 contains street name, house number or P.O. box. This field is only used for combined elements addresses and is optional.

Value: The address line 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAddressLine2()
```
public final String getAddressLine2()
```

Gets or sets the address line 2. Address line 2 contains postal code and town. This field is only used for combined elements addresses. For this type, it's mandatory.

Value: The address line 2.

**Returns:**
java.lang.String
##### setAddressLine2(String value)
```
public final void setAddressLine2(String value)
```

Gets or sets the address line 2. Address line 2 contains postal code and town. This field is only used for combined elements addresses. For this type, it's mandatory.

Value: The address line 2.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStreet()
```
public final String getStreet()
```

Gets or sets the street. The street must be specified without a house number. This field is only used for structured addresses and is optional.

Value: The street.

**Returns:**
java.lang.String
##### setStreet(String value)
```
public final void setStreet(String value)
```

Gets or sets the street. The street must be specified without a house number. This field is only used for structured addresses and is optional.

Value: The street.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getHouseNo()
```
public final String getHouseNo()
```

Gets or sets the house number. This field is only used for structured addresses and is optional.

Value: The house number.

**Returns:**
java.lang.String
##### setHouseNo(String value)
```
public final void setHouseNo(String value)
```

Gets or sets the house number. This field is only used for structured addresses and is optional.

Value: The house number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPostalCode()
```
public final String getPostalCode()
```

Gets or sets the postal code. This field is only used for structured addresses. For this type, it's mandatory.

Value: The postal code.

**Returns:**
java.lang.String
##### setPostalCode(String value)
```
public final void setPostalCode(String value)
```

Gets or sets the postal code. This field is only used for structured addresses. For this type, it's mandatory.

Value: The postal code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTown()
```
public final String getTown()
```

Gets or sets the town or city. This field is only used for structured addresses. For this type, it's mandatory.

Value: The town or city.

**Returns:**
java.lang.String
##### setTown(String value)
```
public final void setTown(String value)
```

Gets or sets the town or city. This field is only used for structured addresses. For this type, it's mandatory.

Value: The town or city.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCountryCode()
```
public final String getCountryCode()
```

Gets or sets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or empty values.

Value: The ISO country code.

**Returns:**
java.lang.String
##### setCountryCode(String value)
```
public final void setCountryCode(String value)
```

Gets or sets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or empty values.

Value: The ISO country code.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### SwissQR
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.swissqr/swissqr.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.extensions.interfaces.IComplexData
```
public class SwissQR implements IComplexData
```

Class for encoding and decoding the text embedded in the SwissQR code.
#### Constructors

| Constructor | Description |
| --- | --- |
| SwissQR() | Creates an instance of SwissQR. |
#### Methods

| Method | Description |
| --- | --- |
| getAmount() | Gets or sets the payment amount. |
| setAmount(double value) | Gets or sets the payment amount. |
| getCurrency() | Gets or sets the payment currency. |
| setCurrency(String value) | Gets or sets the payment currency. |
| getAccount() | Gets or sets the creditor's account number. |
| setAccount(String value) | Gets or sets the creditor's account number. |
| getCreditor() | Gets or sets the creditor address. |
| setCreditor(SwissAddress value) | Gets or sets the creditor address. |
| getReference() | Gets or sets the creditor payment reference. |
| setReference(String value) | Gets or sets the creditor payment reference. |
| getDebtor() | Gets or sets the debtor address. |
| setDebtor(SwissAddress value) | Gets or sets the debtor address. |
| getUnstructuredMessage() | Gets or sets the additional unstructured message. |
| setUnstructuredMessage(String value) | Gets or sets the additional unstructured message. |
| getBillInformation() | Gets or sets the additional structured bill information. |
| setBillInformation(String value) | Gets or sets the additional structured bill information. |
##### SwissQR()
```
public SwissQR()
```

Creates an instance of SwissQR.

##### getAmount()
```
public final double getAmount()
```

Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99.

Value: The payment amount.

**Returns:**
double
##### setAmount(double value)
```
public final void setAmount(double value)
```

Gets or sets the payment amount. Valid values are between 0.01 and 999,999,999.99.

Value: The payment amount.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getCurrency()
```
public final String getCurrency()
```

Gets or sets the payment currency. Valid values are "CHF" and "EUR".

Value: The payment currency.

**Returns:**
java.lang.String
##### setCurrency(String value)
```
public final void setCurrency(String value)
```

Gets or sets the payment currency. Valid values are "CHF" and "EUR".

Value: The payment currency.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAccount()
```
public final String getAccount()
```

Gets or sets the creditor's account number. Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number.

Value: The creditor account number.

**Returns:**
java.lang.String
##### setAccount(String value)
```
public final void setAccount(String value)
```

Gets or sets the creditor's account number. Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number.

Value: The creditor account number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCreditor()
```
public final SwissAddress getCreditor()
```

Gets or sets the creditor address.

Value: The creditor address.

**Returns:**
SwissAddress
##### setCreditor(SwissAddress value)
```
public final void setCreditor(SwissAddress value)
```

Gets or sets the creditor address.

Value: The creditor address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SwissAddress |  |

##### getReference()
```
public final String getReference()
```

Gets or sets the creditor payment reference. The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.

Value: The creditor payment reference.

**Returns:**
java.lang.String
##### setReference(String value)
```
public final void setReference(String value)
```

Gets or sets the creditor payment reference. The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx. If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.

Value: The creditor payment reference.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDebtor()
```
public final SwissAddress getDebtor()
```

Gets or sets the debtor address. The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok.

Value: The debtor address.

**Returns:**
SwissAddress
##### setDebtor(SwissAddress value)
```
public final void setDebtor(SwissAddress value)
```

Gets or sets the debtor address. The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok.

Value: The debtor address.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SwissAddress |  |

##### getUnstructuredMessage()
```
public final String getUnstructuredMessage()
```

Gets or sets the additional unstructured message.

Value: The unstructured message.

**Returns:**
java.lang.String
##### setUnstructuredMessage(String value)
```
public final void setUnstructuredMessage(String value)
```

Gets or sets the additional unstructured message.

Value: The unstructured message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBillInformation()
```
public final String getBillInformation()
```

Gets or sets the additional structured bill information.

Value: The structured bill information.

**Returns:**
java.lang.String
##### setBillInformation(String value)
```
public final void setBillInformation(String value)
```

Gets or sets the additional structured bill information.

Value: The structured bill information.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### com.groupdocs.signature.domain.extensions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions.md

The **GroupDocs.Signature.Domain.Extensions** namespace provides extensions for signature appearances and additional functionality.

#### Classes

| Class | Description |
| --- | --- |
| Brush | Represents base class for various brushes. |
| LinearGradientBrush | Represents linear gradient brush. |
| RadialGradientBrush | Represents radial gradient brush. |
| SolidBrush | Represents solid brush. |
| TextureBrush | Represents texture brush. |

### Brush
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions/brush.md

**Inheritance:**
java.lang.Object
```
public abstract class Brush
```

Represents base class for various brushes.
#### Constructors

| Constructor | Description |
| --- | --- |
| Brush() |  |
##### Brush()
```
public Brush()
```

### LinearGradientBrush
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions/lineargradientbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class LinearGradientBrush extends Brush
```

Represents linear gradient brush.
#### Constructors

| Constructor | Description |
| --- | --- |
| LinearGradientBrush() | Initializes a new instance of the LinearGradientBrush class with default values. |
| LinearGradientBrush(Color startColor, Color endColor, float angle) | Initializes a new instance of the LinearGradientBrush class. |
| LinearGradientBrush(String startColor, String endColor, float angle) | Initializes a new instance of the LinearGradientBrush class. |
#### Methods

| Method | Description |
| --- | --- |
| getStartColor() | Gets or sets start gradient color. |
| setStartColor(Color value) | Gets or sets start gradient color. |
| setStartColor(String value) | Gets or sets start gradient color. |
| getEndColor() | Gets or sets finish gradient color. |
| setEndColor(Color value) | Gets or sets finish gradient color. |
| setEndColor(String value) | Gets or sets finish gradient color. |
| getAngle() | Gets or sets gradient angle. |
| setAngle(float value) | Gets or sets gradient angle. |
##### LinearGradientBrush()
```
public LinearGradientBrush()
```

Initializes a new instance of the LinearGradientBrush class with default values.

##### LinearGradientBrush(Color startColor, Color endColor, float angle)
```
public LinearGradientBrush(Color startColor, Color endColor, float angle)
```

Initializes a new instance of the LinearGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startColor | java.awt.Color | Start color. |
| endColor | java.awt.Color | End color. |
| angle | float | Angle. Default value is 0. |

##### LinearGradientBrush(String startColor, String endColor, float angle)
```
public LinearGradientBrush(String startColor, String endColor, float angle)
```

Initializes a new instance of the LinearGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startColor | java.lang.String | Start color. |
| endColor | java.lang.String | End color. |
| angle | float | Angle. Default value is 0. |

##### getStartColor()
```
public final Color getStartColor()
```

Gets or sets start gradient color.

**Returns:**
java.awt.Color
##### setStartColor(Color value)
```
public final void setStartColor(Color value)
```

Gets or sets start gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setStartColor(String value)
```
public final void setStartColor(String value)
```

Gets or sets start gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEndColor()
```
public final Color getEndColor()
```

Gets or sets finish gradient color.

**Returns:**
java.awt.Color
##### setEndColor(Color value)
```
public final void setEndColor(Color value)
```

Gets or sets finish gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setEndColor(String value)
```
public final void setEndColor(String value)
```

Gets or sets finish gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getAngle()
```
public final float getAngle()
```

Gets or sets gradient angle.

**Returns:**
float
##### setAngle(float value)
```
public final void setAngle(float value)
```

Gets or sets gradient angle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

### RadialGradientBrush
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions/radialgradientbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class RadialGradientBrush extends Brush
```

Represents radial gradient brush.
#### Constructors

| Constructor | Description |
| --- | --- |
| RadialGradientBrush() | Initializes a new instance of the RadialGradientBrush class with default values. |
| RadialGradientBrush(Color innerColor, Color outerColor) | Initializes a new instance of the RadialGradientBrush class. |
| RadialGradientBrush(String innerColor, String outerColor) | Initializes a new instance of the RadialGradientBrush class. |
#### Methods

| Method | Description |
| --- | --- |
| getInnerColor() | Gets or sets inner gradient color. |
| setInnerColor(Color value) | Gets or sets inner gradient color. |
| setInnerColor(String value) | Gets or sets inner gradient color. |
| getOuterColor() | Gets or sets outer gradient color. |
| setOuterColor(Color value) | Gets or sets outer gradient color. |
| setOuterColor(String value) | Gets or sets outer gradient color. |
##### RadialGradientBrush()
```
public RadialGradientBrush()
```

Initializes a new instance of the RadialGradientBrush class with default values.

##### RadialGradientBrush(Color innerColor, Color outerColor)
```
public RadialGradientBrush(Color innerColor, Color outerColor)
```

Initializes a new instance of the RadialGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerColor | java.awt.Color | Inner color. |
| outerColor | java.awt.Color | Outer color. |

##### RadialGradientBrush(String innerColor, String outerColor)
```
public RadialGradientBrush(String innerColor, String outerColor)
```

Initializes a new instance of the RadialGradientBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| innerColor | java.lang.String | Inner color. |
| outerColor | java.lang.String | Outer color. |

##### getInnerColor()
```
public final Color getInnerColor()
```

Gets or sets inner gradient color.

**Returns:**
java.awt.Color
##### setInnerColor(Color value)
```
public final void setInnerColor(Color value)
```

Gets or sets inner gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setInnerColor(String value)
```
public final void setInnerColor(String value)
```

Gets or sets inner gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOuterColor()
```
public final Color getOuterColor()
```

Gets or sets outer gradient color.

**Returns:**
java.awt.Color
##### setOuterColor(Color value)
```
public final void setOuterColor(Color value)
```

Gets or sets outer gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setOuterColor(String value)
```
public final void setOuterColor(String value)
```

Gets or sets outer gradient color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### SolidBrush
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions/solidbrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class SolidBrush extends Brush
```

Represents solid brush. It could be used instead background color property.
#### Constructors

| Constructor | Description |
| --- | --- |
| SolidBrush() | Initializes a new instance of the SolidBrush class with default values. |
| SolidBrush(Color color) | Initializes a new instance of the SolidBrush class. |
| SolidBrush(String color) | Initializes a new instance of the SolidBrush class. |
#### Methods

| Method | Description |
| --- | --- |
| getColor() | Gets or sets color of solid brush. |
| setColor(Color value) | Gets or sets color of solid brush. |
| setColor(String value) | Gets or sets color of solid brush. |
##### SolidBrush()
```
public SolidBrush()
```

Initializes a new instance of the SolidBrush class with default values.

##### SolidBrush(Color color)
```
public SolidBrush(Color color)
```

Initializes a new instance of the SolidBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.awt.Color | Color of solid brush. |

##### SolidBrush(String color)
```
public SolidBrush(String color)
```

Initializes a new instance of the SolidBrush class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | java.lang.String | Color of solid brush. |

##### getColor()
```
public final Color getColor()
```

Gets or sets color of solid brush.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets color of solid brush.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets color of solid brush.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### TextureBrush
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.extensions/texturebrush.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.extensions.Brush
```
public class TextureBrush extends Brush
```

Represents texture brush.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextureBrush() | Initializes a new instance of the TextureBrush class with default values. |
| TextureBrush(String imageFilePath) | Initializes a new instance of the TextureBrush class with image file. |
| TextureBrush(InputStream imageStream) | Initializes a new instance of the TextureBrush class with image stream option. |
#### Methods

| Method | Description |
| --- | --- |
| getImageFilePath() | Gets or sets the texture image file path. |
| setImageFilePath(String value) | Gets or sets the texture image file path. |
| getImageStream() | Gets or sets the texture image stream. |
| setImageStream(InputStream value) | Gets or sets the texture image stream. |
##### TextureBrush()
```
public TextureBrush()
```

Initializes a new instance of the TextureBrush class with default values.

##### TextureBrush(String imageFilePath)
```
public TextureBrush(String imageFilePath)
```

Initializes a new instance of the TextureBrush class with image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | java.lang.String | Image file path. |

##### TextureBrush(InputStream imageStream)
```
public TextureBrush(InputStream imageStream)
```

Initializes a new instance of the TextureBrush class with image stream option.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | Image stream. |

##### getImageFilePath()
```
public final String getImageFilePath()
```

Gets or sets the texture image file path. This property is used only if ImageStream is not specified.

**Returns:**
java.lang.String
##### setImageFilePath(String value)
```
public final void setImageFilePath(String value)
```

Gets or sets the texture image file path. This property is used only if ImageStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets or sets the texture image stream. If this property is specified it is always used instead ImageFilePath.

**Returns:**
java.io.InputStream
##### setImageStream(InputStream value)
```
public final void setImageStream(InputStream value)
```

Gets or sets the texture image stream. If this property is specified it is always used instead ImageFilePath.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

### com.groupdocs.signature.domain.interfaces
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces.md

The **GroupDocs.Signature.Domain.Interfaces** namespace provides classes for working with Interfaces

#### Interfaces

| Interface | Description |
| --- | --- |
| IAlignment | Interface describes alignment of Signature area on document page. |
| IRectangle | Interface defines properties for Signature area on Document Page. |
| IRotation | Interface defines properties for Signature Rotation. |
| ITextAlignment | Interface defines Alignment properties for text on Text Signatures. |
| ITransparency | Define Transparency property for different objects appearances |

### IAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces/ialignment.md

### IRectangle
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces/irectangle.md

### IRotation
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces/irotation.md

### ITextAlignment
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces/itextalignment.md

### ITransparency
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.interfaces/itransparency.md

### com.groupdocs.signature.domain.qrcodes
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.qrcodes.md

The **GroupDocs.Signature.Domain.QRCodes** namespace provides classes for working with QRCodes

#### Classes

| Class | Description |
| --- | --- |
| QrCodeType | Specify QRCode type properties. |
| QrCodeTypes | QRCode Types container. |

### QrCodeType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.qrcodes/qrcodetype.md

**Inheritance:**
java.lang.Object
```
public final class QrCodeType
```

Specify QRCode type properties.
#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Gets index of object in collection of supported QRCode types. |
| getTypeName() | Gets name of QRCode Type. |
| equals(QrCodeType other) | Determines whether the specified QRCode is equal to the current object. |
| equals(Object obj) | Overridden method determines whether the specified System.Object is equal to the current System.Object. |
| hashCode() | Overridden method serves as a hash function for a particular type. |
| toString() | Overridden method serves as conversion to string type. |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Gets index of object in collection of supported QRCode types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Gets name of QRCode Type.

**Returns:**
java.lang.String
##### equals(QrCodeType other)
```
public final boolean equals(QrCodeType other)
```

Determines whether the specified QRCode is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | QrCodeType | Object for comparison. |

**Returns:**
boolean - Result of comparison.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Overridden method determines whether the specified System.Object is equal to the current System.Object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Object for comparison. |

**Returns:**
boolean - Result of comparison.
##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash code.
##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - Returns a string that represents the current object.

### QrCodeTypes
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.qrcodes/qrcodetypes.md

**Inheritance:**
java.lang.Object
```
public class QrCodeTypes
```

QRCode Types container.
#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| Aztec | Aztec Barcode Type object. |
| DataMatrix | DataMatrix Barcode Type object. |
| QR | QR Barcode Type object. |
| GS1DataMatrix | GS1 DataMatrix Barcode Type object. |
| GS1QR | GS1 QR Barcode Type object. |
| HIBCLICQR | HIBC LIC QR-Code Type object. |
| HIBCLICDataMatrix | HIBC LIC Data Matrix QR-Code Type object. |
| HIBCLICAztec | HIBC LIC Aztec QR-Code Type object. |
| HIBCPASQR | HIBC PAS QR-Code Type object. |
| HIBCPASDataMatrix | HIBC PAS Data Matrix QR-Code Type object. |
| HIBCPASAztec | HIBC PAS Aztec QR-Code Type object. |
| HanXin | Han Xin QR-Code Type object. |
| GS1HanXin | GS1 Han Xin QR-Code Type object. |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All QRCode types. |
| parse(String parsingType) | Returns QRCode type with pasringType name. |
| tryParse(String parsingType) | Returns QRCode type with pasringType name. |
| getDecodeTypes() | Internal list of Decode Types for extraction |
| isComplexType(System.Type type, QrCodeType qrCodeType) |  |
| getDataEncoding(System.Type type, QrCodeType qrCodeType) |  |
##### QrCodeTypes()
```
public QrCodeTypes()
```

##### Aztec
```
public static final QrCodeType Aztec
```

Aztec Barcode Type object.

##### DataMatrix
```
public static final QrCodeType DataMatrix
```

DataMatrix Barcode Type object.

##### QR
```
public static final QrCodeType QR
```

QR Barcode Type object.

##### GS1DataMatrix
```
public static final QrCodeType GS1DataMatrix
```

GS1 DataMatrix Barcode Type object.

##### GS1QR
```
public static final QrCodeType GS1QR
```

GS1 QR Barcode Type object.

##### HIBCLICQR
```
public static final QrCodeType HIBCLICQR
```

HIBC LIC QR-Code Type object.

##### HIBCLICDataMatrix
```
public static final QrCodeType HIBCLICDataMatrix
```

HIBC LIC Data Matrix QR-Code Type object.

##### HIBCLICAztec
```
public static final QrCodeType HIBCLICAztec
```

HIBC LIC Aztec QR-Code Type object.

##### HIBCPASQR
```
public static final QrCodeType HIBCPASQR
```

HIBC PAS QR-Code Type object.

##### HIBCPASDataMatrix
```
public static final QrCodeType HIBCPASDataMatrix
```

HIBC PAS Data Matrix QR-Code Type object.

##### HIBCPASAztec
```
public static final QrCodeType HIBCPASAztec
```

HIBC PAS Aztec QR-Code Type object.

##### HanXin
```
public static final QrCodeType HanXin
```

Han Xin QR-Code Type object.

##### GS1HanXin
```
public static final QrCodeType GS1HanXin
```

GS1 Han Xin QR-Code Type object.

##### getAllTypes()
```
public static QrCodeType[] getAllTypes()
```

All QRCode types.

**Returns:**
com.groupdocs.signature.domain.qrcodes.QrCodeType[]
##### parse(String parsingType)
```
public static QrCodeType parse(String parsingType)
```

Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of QRCode type name. |

**Returns:**
QrCodeType - QRCodeType instance.
##### tryParse(String parsingType)
```
public static QrCodeType tryParse(String parsingType)
```

Returns QRCode type with pasringType name. If name of QRCode is unknown - no Exception will be throw but method will return null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of QRCode type name. |

**Returns:**
QrCodeType - QRCodeType instance.
##### getDecodeTypes()
```
public static System.Collections.Generic.List<BaseDecodeType> getDecodeTypes()
```

Internal list of Decode Types for extraction

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.aspose.barcode.barcoderecognition.BaseDecodeType>
##### isComplexType(System.Type type, QrCodeType qrCodeType)
```
public static boolean isComplexType(System.Type type, QrCodeType qrCodeType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | com.aspose.ms.System.Type |  |
| qrCodeType | QrCodeType |  |

**Returns:**
boolean
##### getDataEncoding(System.Type type, QrCodeType qrCodeType)
```
public static IComplexCodeDataEncoding getDataEncoding(System.Type type, QrCodeType qrCodeType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | com.aspose.ms.System.Type |  |
| qrCodeType | QrCodeType |  |

**Returns:**
IComplexCodeDataEncoding

### com.groupdocs.signature.domain.signatures.formfield
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield.md

The **GroupDocs.Signature.Domain.Signatures.FormField** namespace provides classes for working with FormField signatures

#### Classes

| Class | Description |
| --- | --- |
| CheckboxFormFieldSignature | Contains check-box input form field signature properties. |
| ComboboxFormFieldSignature | Contains combo-box input form field signature properties. |
| DigitalFormFieldSignature | Contains digital signature input form field properties for Pdf Documents. |
| FormFieldSignature | Contains Form field signature properties. |
| RadioButtonFormFieldSignature | Contains radio-button input form field signature properties. |
| TextFormFieldSignature | Contains text input form field signature properties for Pdf Document |

### CheckboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/checkboxformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class CheckboxFormFieldSignature extends FormFieldSignature
```

Contains check-box input form field signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| CheckboxFormFieldSignature(String name) | Creates PdfCheckboxFormFieldSignature with predefined name. |
| CheckboxFormFieldSignature(String name, boolean isChecked) | Creates PdfCheckboxFormFieldSignature with predefined name and value |
#### Methods

| Method | Description |
| --- | --- |
| getChecked() | Gets or sets checked value of form field check-box input. |
| setChecked(boolean value) | Gets or sets checked value of form field check-box input. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### CheckboxFormFieldSignature(String name)
```
public CheckboxFormFieldSignature(String name)
```

Creates PdfCheckboxFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |

##### CheckboxFormFieldSignature(String name, boolean isChecked)
```
public CheckboxFormFieldSignature(String name, boolean isChecked)
```

Creates PdfCheckboxFormFieldSignature with predefined name and value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| isChecked | boolean | Value if check box is checked |

##### getChecked()
```
public final boolean getChecked()
```

Gets or sets checked value of form field check-box input.

**Returns:**
boolean
##### setChecked(boolean value)
```
public final void setChecked(boolean value)
```

Gets or sets checked value of form field check-box input.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### ComboboxFormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/comboboxformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class ComboboxFormFieldSignature extends FormFieldSignature
```

Contains combo-box input form field signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| ComboboxFormFieldSignature(String name) | Creates ComboboxFormFieldSignature with predefined name. |
| ComboboxFormFieldSignature(String name, List<String> items) | Creates ComboboxFormFieldSignature with predefined name and options list. |
| ComboboxFormFieldSignature(String name, List<String> items, Object selected) | Creates ComboboxFormFieldSignature with predefined name, options list and selected value. |
#### Methods

| Method | Description |
| --- | --- |
| getSelected() | Get or set selected value. |
| setSelected(String value) | Get or set selected value. |
| getItems() | Get or set combo-box options list. |
| setItems(List<String> value) | Get or set combo-box options list. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### ComboboxFormFieldSignature(String name)
```
public ComboboxFormFieldSignature(String name)
```

Creates ComboboxFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |

##### ComboboxFormFieldSignature(String name, List<String> items)
```
public ComboboxFormFieldSignature(String name, List<String> items)
```

Creates ComboboxFormFieldSignature with predefined name and options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| items | java.util.List<java.lang.String> | Values of combo-box list. |

##### ComboboxFormFieldSignature(String name, List<String> items, Object selected)
```
public ComboboxFormFieldSignature(String name, List<String> items, Object selected)
```

Creates ComboboxFormFieldSignature with predefined name, options list and selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| items | java.util.List<java.lang.String> | Values of combo-box list. |
| selected | java.lang.Object | Selected value. |

##### getSelected()
```
public final String getSelected()
```

Get or set selected value.

**Returns:**
java.lang.String
##### setSelected(String value)
```
public final void setSelected(String value)
```

Get or set selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getItems()
```
public final List<String> getItems()
```

Get or set combo-box options list.

**Returns:**
java.util.List<java.lang.String>
##### setItems(List<String> value)
```
public final void setItems(List<String> value)
```

Get or set combo-box options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### DigitalFormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/digitalformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class DigitalFormFieldSignature extends FormFieldSignature
```

Contains digital signature input form field properties for Pdf Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalFormFieldSignature(String name) | Creates PdfDigitalFormFieldSignature with predefined name. |
#### Methods

| Method | Description |
| --- | --- |
| getSigned() | Read-only property that shows if Form-field Signature was signed with digital certificate. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### DigitalFormFieldSignature(String name)
```
public DigitalFormFieldSignature(String name)
```

Creates PdfDigitalFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |

##### getSigned()
```
public final boolean getSigned()
```

Read-only property that shows if Form-field Signature was signed with digital certificate.

**Returns:**
boolean
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### FormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/formfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public abstract class FormFieldSignature extends BaseSignature
```

Contains Form field signature properties.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies unique form field name. |
| setName(String value) | Specifies unique form field name. |
| getType() | Specifies Form field type. |
| getValue() | Specifies Form field data object. |
| setValue(Object value) | Specifies Form field data object. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### getName()
```
public final String getName()
```

Specifies unique form field name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies unique form field name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getType()
```
public final int getType()
```

Specifies Form field type.

**Returns:**
int
##### getValue()
```
public final Object getValue()
```

Specifies Form field data object.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies Form field data object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### RadioButtonFormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/radiobuttonformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class RadioButtonFormFieldSignature extends FormFieldSignature
```

Contains radio-button input form field signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| RadioButtonFormFieldSignature(String name) | Creates RadioButtonFieldSignature with predefined name. |
| RadioButtonFormFieldSignature(String name, List<String> items) | Creates RadioButtonFieldSignature with predefined name and items list. |
| RadioButtonFormFieldSignature(String name, List<String> items, Object selected) | Creates RadioButtonFieldSignature with predefined name, items list and selected value. |
#### Methods

| Method | Description |
| --- | --- |
| getSelected() | Contains selected value. |
| setSelected(String value) | Contains selected value. |
| getItems() | Get or set Radio buttons options list. |
| setItems(List<String> value) | Get or set Radio buttons options list. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### RadioButtonFormFieldSignature(String name)
```
public RadioButtonFormFieldSignature(String name)
```

Creates RadioButtonFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |

##### RadioButtonFormFieldSignature(String name, List<String> items)
```
public RadioButtonFormFieldSignature(String name, List<String> items)
```

Creates RadioButtonFieldSignature with predefined name and items list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| items | java.util.List<java.lang.String> | Values of radio-button list. |

##### RadioButtonFormFieldSignature(String name, List<String> items, Object selected)
```
public RadioButtonFormFieldSignature(String name, List<String> items, Object selected)
```

Creates RadioButtonFieldSignature with predefined name, items list and selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| items | java.util.List<java.lang.String> | Values of radio-button list. |
| selected | java.lang.Object | Selected value. |

##### getSelected()
```
public final String getSelected()
```

Contains selected value.

**Returns:**
java.lang.String
##### setSelected(String value)
```
public final void setSelected(String value)
```

Contains selected value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getItems()
```
public final List<String> getItems()
```

Get or set Radio buttons options list.

**Returns:**
java.util.List<java.lang.String>
##### setItems(List<String> value)
```
public final void setItems(List<String> value)
```

Get or set Radio buttons options list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### TextFormFieldSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.formfield/textformfieldsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.formfield.FormFieldSignature
```
public final class TextFormFieldSignature extends FormFieldSignature
```

Contains text input form field signature properties for Pdf Document
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFormFieldSignature(String name) | Creates PdfTextFormFieldSignature with predefined name. |
| TextFormFieldSignature(String name, String text) | Creates PdfTextFormFieldSignature with predefined name. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets or sets text of form field text input. |
| setText(String value) | Gets or sets text of form field text input. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone FormField Signature instance. |
##### TextFormFieldSignature(String name)
```
public TextFormFieldSignature(String name)
```

Creates PdfTextFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |

##### TextFormFieldSignature(String name, String text)
```
public TextFormFieldSignature(String name, String text)
```

Creates PdfTextFormFieldSignature with predefined name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of form field object. |
| text | java.lang.String | Text of form field object. |

##### getText()
```
public final String getText()
```

Gets or sets text of form field text input.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets text of form field text input.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone FormField Signature instance.

**Returns:**
java.lang.Object - Returns cloned FormField Signature instance.

### com.groupdocs.signature.domain.signatures.metadata
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata.md

The **GroupDocs.Signature.Domain.Signatures.Metadata** namespace provides classes for working with Metadata signatures

#### Classes

| Class | Description |
| --- | --- |
| CertificateMetadataSignature | Contains Certificate Metadata Signature properties. |
| ImageMetadataSignature | Contains Image Metadata signature properties. |
| MetadataSignature | Contains Metadata signature properties. |
| MetadataSignatureCollection | Collection of Metadata signature objects. |
| PdfMetadataSignature | Contains Pdf Metadata signature properties. |
| PdfMetadataSignatures | Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options. |
| PresentationMetadataSignature | Contains Presentation metadata signature properties. |
| SpreadsheetMetadataSignature | Contains Spreadsheet Metadata Signature properties. |
| WordProcessingMetadataSignature | Contains WordProcessing Metadata Signature properties. |

### CertificateMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/certificatemetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class CertificateMetadataSignature extends MetadataSignature
```

Contains Certificate Metadata Signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateMetadataSignature(String name) | Creates Certificate Metadata Signature with predefined name and empty value. |
| CertificateMetadataSignature(String name, Object value) | Creates Certificate Metadata Signature with predefined values. |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Certificate Metadata Signature instance with given value. |
| toString() | Converts to String with override ToString() method |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format |
##### CertificateMetadataSignature(String name)
```
public CertificateMetadataSignature(String name)
```

Creates Certificate Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Certificate Metadata Signature name. |

##### CertificateMetadataSignature(String name, Object value)
```
public CertificateMetadataSignature(String name, Object value)
```

Creates Certificate Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object. |
| value | java.lang.Object | Value of Metadata signature. |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Certificate Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.
##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### ImageMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/imagemetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class ImageMetadataSignature extends MetadataSignature
```

Contains Image Metadata signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageMetadataSignature(int id, Object value) | Creates Image Metadata Signature with Id and value |
#### Methods

| Method | Description |
| --- | --- |
| getId() | The identifier of Image Metadata signature. |
| setId(int value) | The identifier of Image Metadata signature. |
| getSize() | Read-only value to get size of Metadata value |
| setSize(int value) | Read-only value to get size of Metadata value |
| getDescription() | Read-only value to get description for standard Image Metadata signature |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Image Metadata Signature instance with given value. |
| toBoolean() | Converts to boolean. |
| toInteger() | Converts to integer. |
| toLong() | Converts to long. |
| toSingle() | Converts to float. |
| toSingle(Locale provider) | Converts to float. |
| toDouble() | Converts to Double. |
| toDouble(Locale provider) | Converts to Double. |
| toDecimal() | Converts to Decimal. |
| toDecimal(Locale provider) | Converts to Decimal. |
| toDateTime() | Converts to DateTime. |
| toDateTime(Locale provider) | Converts to DateTime. |
| toString() | Converts to String with override ToString() method |
| toString(String format) | Converts to String with specified format |
| toString(String format, Locale provider) | Converts to String with specified format |
| setAsBool(Object value) |  |
| setAsByte(Object value) |  |
| setAsShrt(Object value) |  |
| setAsWord(Object value) |  |
| setAsSInt(Object value) |  |
| setAsUInt(Object value) |  |
| setAsSLng(Object value) |  |
| setAsULng(Object value) |  |
| setAsSngl(Object value) |  |
| setAsDbls(Object value) |  |
| setAsDcml(Object value) |  |
| setAsDate(Object value) |  |
| setAsStrn(Object value) |  |
| setAsObjc(Object value) |  |
| setString(Object value) |  |
##### ImageMetadataSignature(int id, Object value)
```
public ImageMetadataSignature(int id, Object value)
```

Creates Image Metadata Signature with Id and value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | java.lang.Object | Metadata value |

##### getId()
```
public final int getId()
```

The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

**Returns:**
int
##### setId(int value)
```
public final void setId(int value)
```

The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSize()
```
public final int getSize()
```

Read-only value to get size of Metadata value

**Returns:**
int
##### setSize(int value)
```
public final void setSize(int value)
```

Read-only value to get size of Metadata value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDescription()
```
public final String getDescription()
```

Read-only value to get description for standard Image Metadata signature

**Returns:**
java.lang.String
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Image Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.
##### toBoolean()
```
public boolean toBoolean()
```

Converts to boolean.

**Returns:**
boolean - Returns the Metadata signature value as boolean.

Throws an exception if the Metadata value could not be converted.
##### toInteger()
```
public int toInteger()
```

Converts to integer.

**Returns:**
int - Returns the Metadata Signature value as integer.

Throws an exception if the Metadata value could not be converted.
##### toLong()
```
public final long toLong()
```

Converts to long.

**Returns:**
long - Returns the Metadata Signature value as long.

Throws an exception if the Metadata value could not be converted.
##### toSingle()
```
public final float toSingle()
```

Converts to float.

**Returns:**
float - Returns the Image Metadata Signature value as float.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toSingle(Locale provider)
```
public final float toSingle(Locale provider)
```

Converts to float.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
float - Returns the Metadata Signature value as float.
##### toDouble()
```
public double toDouble()
```

Converts to Double.

**Returns:**
double - Returns the Image Metadata Signature value as Double.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toDouble(Locale provider)
```
public double toDouble(Locale provider)
```

Converts to Double.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
double - Returns the Metadata Signature value as Double.
##### toDecimal()
```
public final BigDecimal toDecimal()
```

Converts to Decimal.

**Returns:**
java.math.BigDecimal - Returns the Image Metadata Signature value as Decimal.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toDecimal(Locale provider)
```
public final BigDecimal toDecimal(Locale provider)
```

Converts to Decimal.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
java.math.BigDecimal - Returns the Metadata Signature value as Decimal.
##### toDateTime()
```
public Date toDateTime()
```

Converts to DateTime.

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toDateTime(Locale provider)
```
public Date toDateTime(Locale provider)
```

Converts to DateTime.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.
##### toString(String format)
```
public String toString(String format)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture  |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.
##### toString(String format, Locale provider)
```
public String toString(String format, Locale provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.
##### setAsBool(Object value)
```
public final boolean setAsBool(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsByte(Object value)
```
public final boolean setAsByte(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsShrt(Object value)
```
public final boolean setAsShrt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsWord(Object value)
```
public final boolean setAsWord(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSInt(Object value)
```
public final boolean setAsSInt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsUInt(Object value)
```
public final boolean setAsUInt(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSLng(Object value)
```
public final boolean setAsSLng(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsULng(Object value)
```
public final boolean setAsULng(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsSngl(Object value)
```
public final boolean setAsSngl(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDbls(Object value)
```
public final boolean setAsDbls(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDcml(Object value)
```
public final boolean setAsDcml(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsDate(Object value)
```
public final boolean setAsDate(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsStrn(Object value)
```
public final boolean setAsStrn(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setAsObjc(Object value)
```
public final boolean setAsObjc(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

**Returns:**
boolean
##### setString(Object value)
```
public final void setString(Object value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

### MetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/metadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public abstract class MetadataSignature extends BaseSignature
```

Contains Metadata signature properties.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies unique metadata name. |
| setName(String value) | Specifies unique metadata name. |
| getValue() | Specifies metadata object. |
| setValue(Object value) | Specifies metadata object. |
| getType() | Specifies metadata value type. |
| setType(int value) | Specifies metadata value type. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties. |
| <T>getData(Class<T> typeOfT) | Obtain object from Metadata Signature Value over deserialization. |
| <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption) | Obtain object from Metadata Signature Text over deserialization. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| toBoolean() | Converts to boolean. |
| toInteger() | Converts to integer. |
| toDouble() | Converts to Double. |
| toDouble(Locale provider) | Converts to Double. |
| toSingle() | Converts to float. |
| toSingle(Locale provider) | Converts to float. |
| toDateTime() | Converts to DateTime. |
| toDateTime(Locale provider) | Converts to DateTime. |
| toString() | Converts to String with override ToString() method |
| toString(String format) | Converts to String with specified format |
| toString(String format, Locale provider) | Converts to String with specified format |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Metadata Signature instance with given value. |
##### getName()
```
public final String getName()
```

Specifies unique metadata name.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies unique metadata name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getValue()
```
public final Object getValue()
```

Specifies metadata object.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies metadata object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getType()
```
public final int getType()
```

Specifies metadata value type.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Specifies metadata value type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode signature Value properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### <T>getData(Class<T> typeOfT)
```
public final T <T>getData(Class<T> typeOfT)
```

Obtain object from Metadata Signature Value over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
T - Instance of T object

 T : Type of object to deserialize from Metadata value
##### <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption)
```
public final T <T>getData(Class<T> typeOfT, IDataEncryption dataEncryption)
```

Obtain object from Metadata Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| dataEncryption | IDataEncryption | Set custom data encryption implementation

 T : Type of object to deserialize from Metadata Value |

**Returns:**
T -
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### toBoolean()
```
public boolean toBoolean()
```

Converts to boolean.

**Returns:**
boolean - Returns the Metadata signature value as boolean.

Throws an exception if the Metadata value could not be converted.
##### toInteger()
```
public int toInteger()
```

Converts to integer.

**Returns:**
int - Returns the Metadata Signature value as integer.

Throws an exception if the Metadata value could not be converted.
##### toDouble()
```
public double toDouble()
```

Converts to Double.

**Returns:**
double - Returns the Metadata Signature value as Double.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toDouble(Locale provider)
```
public double toDouble(Locale provider)
```

Converts to Double.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
double - Returns the Metadata Signature value as Double.
##### toSingle()
```
public float toSingle()
```

Converts to float.

**Returns:**
float - Returns the Metadata Signature value as float.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture ()
##### toSingle(Locale provider)
```
public float toSingle(Locale provider)
```

Converts to float.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
float - Returns the Metadata Signature value as float.
##### toDateTime()
```
public Date toDateTime()
```

Converts to DateTime.

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.

Throws an exception if the Metadata value could not be converted. If original value is string based the default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture
##### toDateTime(Locale provider)
```
public Date toDateTime(Locale provider)
```

Converts to DateTime.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Throws an exception if the Metadata value could not be converted |

**Returns:**
java.util.Date - Returns the Metadata Signature value as DateTime.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.
##### toString(String format)
```
public String toString(String format)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string.

Converts a boolean property into "True" or "False". Default culture property info will be used from SignatureSettings properties  SignatureSettings.DefaultCulture  |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.
##### toString(String format, Locale provider)
```
public String toString(String format, Locale provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | java.util.Locale | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.
##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance with given value.

### MetadataSignatureCollection
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/metadatasignaturecollection.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class MetadataSignatureCollection implements Iterable<MetadataSignature>
```

Collection of Metadata signature objects.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSignatureCollection() | Creates Collection of Metadata signature. |
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets number of items in the collection. |
| clear() | Removes all items from the collection. |
| contains(String name) | Returns true if a Metadata with the specified name exists in the collection. |
| indexOf(String name) | Gets the index of a property by name. |
| remove(String name) | Removes a Metadata Signature with the specified name from the collection. |
| removeAt(int index) | Removes a Metadata Signature at the specified index. |
| add(MetadataSignature signature) | Add Metadata Signature object to collection. |
| addRange(MetadataSignature[] signatures) | Add Metadata Signature collection. |
| deepClone() | Clone Metadata Signature Collection class with Metadata Signature Items. |
##### MetadataSignatureCollection()
```
public MetadataSignatureCollection()
```

Creates Collection of Metadata signature.

##### getCount()
```
public final int getCount()
```

Gets number of items in the collection.

**Returns:**
int
##### clear()
```
public final void clear()
```

Removes all items from the collection.

##### contains(String name)
```
public final boolean contains(String name)
```

Returns true if a Metadata with the specified name exists in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the property. |

**Returns:**
boolean - True if the Metadata exists in the collection; false otherwise.
##### indexOf(String name)
```
public final int indexOf(String name)
```

Gets the index of a property by name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the MetadataSignature. |

**Returns:**
int - The zero based index. Negative value if not found.
##### remove(String name)
```
public final boolean remove(String name)
```

Removes a Metadata Signature with the specified name from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The case-insensitive name of the Metadata Signature. |

**Returns:**
boolean -
##### removeAt(int index)
```
public final boolean removeAt(int index)
```

Removes a Metadata Signature at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero based index. |

**Returns:**
boolean
##### add(MetadataSignature signature)
```
public final void add(MetadataSignature signature)
```

Add Metadata Signature object to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | MetadataSignature | Metadata signature to be added to collection.

Throws an exception if name value is not unique entire existing collection |

##### addRange(MetadataSignature[] signatures)
```
public final void addRange(MetadataSignature[] signatures)
```

Add Metadata Signature collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatures | MetadataSignature\[\] | Collection of signatures to add.

Throws an exception if name value is not unique entire existing collection |

##### deepClone()
```
public final Object deepClone()
```

Clone Metadata Signature Collection class with Metadata Signature Items.

**Returns:**
java.lang.Object - Returns copied instance with cloned Signature Items

### PdfMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/pdfmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class PdfMetadataSignature extends MetadataSignature
```

Contains Pdf Metadata signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfMetadataSignature(String name) | Creates Pdf Metadata signature with predefined name and empty value |
| PdfMetadataSignature(String name, Object value) | Creates Pdf Metadata signature with predefined values |
| PdfMetadataSignature(String name, Object value, String tag) | Creates Pdf Metadata signature with predefined values |
#### Methods

| Method | Description |
| --- | --- |
| getTagPrefix() | The prefix tag of Pdf Metadata signature name. |
| setTagPrefix(String value) | The prefix tag of Pdf Metadata signature name. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Pdf Metadata Signature instance with given value. |
##### PdfMetadataSignature(String name)
```
public PdfMetadataSignature(String name)
```

Creates Pdf Metadata signature with predefined name and empty value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Pdf Metadata Signature name |

##### PdfMetadataSignature(String name, Object value)
```
public PdfMetadataSignature(String name, Object value)
```

Creates Pdf Metadata signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object |
| value | java.lang.Object | Value of Metadata signature |

##### PdfMetadataSignature(String name, Object value, String tag)
```
public PdfMetadataSignature(String name, Object value, String tag)
```

Creates Pdf Metadata signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object |
| value | java.lang.Object | Value of Metadata signature |
| tag | java.lang.String | Prefix tag of Metadata signature |

##### getTagPrefix()
```
public final String getTagPrefix()
```

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp". Possible values are

**Returns:**
java.lang.String
##### setTagPrefix(String value)
```
public final void setTagPrefix(String value)
```

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp". Possible values are

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Pdf Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.

### PdfMetadataSignatures
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/pdfmetadatasignatures.md

**Inheritance:**
java.lang.Object
```
public class PdfMetadataSignatures
```

Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfMetadataSignatures() |  |
#### Methods

| Method | Description |
| --- | --- |
| getAuthor() | Pdf Document Author metadata. |
| getCreateDate() | Pdf Document creation date metadata signature. |
| getMetadataDate() | Pdf Document metadata date information. |
| getCreatorTool() | Pdf Document creation tool metadata signature. |
| getModifyDate() | Pdf Document modified date metadata property. |
| getProducer() | Pdf Document Producer metadata property. |
| getEntry() | Pdf Document Entry metadata property. |
| getKeywords() | Pdf Document creator metadata property |
| getTitle() | Pdf Document Title metadata property |
| getSubject() | Pdf Document Subject metadata property. |
| getDescription() | Pdf Document Description metadata property. |
| getCreator() | Pdf Document creator metadata property. |
##### PdfMetadataSignatures()
```
public PdfMetadataSignatures()
```

##### getAuthor()
```
public static PdfMetadataSignature getAuthor()
```

Pdf Document Author metadata.

**Returns:**
PdfMetadataSignature
##### getCreateDate()
```
public static PdfMetadataSignature getCreateDate()
```

Pdf Document creation date metadata signature.

**Returns:**
PdfMetadataSignature
##### getMetadataDate()
```
public static PdfMetadataSignature getMetadataDate()
```

Pdf Document metadata date information.

**Returns:**
PdfMetadataSignature
##### getCreatorTool()
```
public static PdfMetadataSignature getCreatorTool()
```

Pdf Document creation tool metadata signature.

**Returns:**
PdfMetadataSignature
##### getModifyDate()
```
public static PdfMetadataSignature getModifyDate()
```

Pdf Document modified date metadata property.

**Returns:**
PdfMetadataSignature
##### getProducer()
```
public static PdfMetadataSignature getProducer()
```

Pdf Document Producer metadata property.

**Returns:**
PdfMetadataSignature
##### getEntry()
```
public static PdfMetadataSignature getEntry()
```

Pdf Document Entry metadata property.

**Returns:**
PdfMetadataSignature
##### getKeywords()
```
public static PdfMetadataSignature getKeywords()
```

Pdf Document creator metadata property

**Returns:**
PdfMetadataSignature
##### getTitle()
```
public static PdfMetadataSignature getTitle()
```

Pdf Document Title metadata property

**Returns:**
PdfMetadataSignature
##### getSubject()
```
public static PdfMetadataSignature getSubject()
```

Pdf Document Subject metadata property.

**Returns:**
PdfMetadataSignature
##### getDescription()
```
public static PdfMetadataSignature getDescription()
```

Pdf Document Description metadata property.

**Returns:**
PdfMetadataSignature
##### getCreator()
```
public static PdfMetadataSignature getCreator()
```

Pdf Document creator metadata property.

**Returns:**
PdfMetadataSignature

### PresentationMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/presentationmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class PresentationMetadataSignature extends MetadataSignature
```

Contains Presentation metadata signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationMetadataSignature(String name) | Creates Presentation Metadata Signature with predefined name and empty value |
| PresentationMetadataSignature(String name, Object value) | Creates Presentation Metadata Signature with predefined values |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Slides Metadata Signature instance with given value. |
| toString() | Converts to String with override ToString() method |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format |
##### PresentationMetadataSignature(String name)
```
public PresentationMetadataSignature(String name)
```

Creates Presentation Metadata Signature with predefined name and empty value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Presentation Metadata Signature name |

##### PresentationMetadataSignature(String name, Object value)
```
public PresentationMetadataSignature(String name, Object value)
```

Creates Presentation Metadata Signature with predefined values

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object |
| value | java.lang.Object | Value of Metadata signature |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Slides Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.
##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### SpreadsheetMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/spreadsheetmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class SpreadsheetMetadataSignature extends MetadataSignature
```

Contains Spreadsheet Metadata Signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetMetadataSignature(String name) | Creates Spreadsheet Metadata Signature with predefined name and empty value. |
| SpreadsheetMetadataSignature(String name, Object value) | Creates Spreadsheet Metadata Signature with predefined values. |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Spreadsheet Metadata Signature instance with given value. |
| toString() | Converts to String with override ToString() method |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format |
##### SpreadsheetMetadataSignature(String name)
```
public SpreadsheetMetadataSignature(String name)
```

Creates Spreadsheet Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Spreadsheet Metadata Signature name. |

##### SpreadsheetMetadataSignature(String name, Object value)
```
public SpreadsheetMetadataSignature(String name, Object value)
```

Creates Spreadsheet Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object. |
| value | java.lang.Object | Value of Metadata signature. |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Spreadsheet Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.
##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### WordProcessingMetadataSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.metadata/wordprocessingmetadatasignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.metadata.MetadataSignature
```
public final class WordProcessingMetadataSignature extends MetadataSignature
```

Contains WordProcessing Metadata Signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingMetadataSignature(String name) | Creates WordProcessing Metadata Signature with predefined name and empty value. |
| WordProcessingMetadataSignature(String name, Object value) | Creates WordProcessing Metadata Signature with predefined values. |
#### Methods

| Method | Description |
| --- | --- |
| deepClone() | Clone Metadata Signature instance. |
| deepClone(Object value) | Clone Words Metadata Signature instance with given value. |
| toString() | Converts to String with override ToString() method |
| toString(String format, System.IFormatProvider provider) | Converts to String with specified format |
##### WordProcessingMetadataSignature(String name)
```
public WordProcessingMetadataSignature(String name)
```

Creates WordProcessing Metadata Signature with predefined name and empty value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | WordProcessing Metadata Signature name. |

##### WordProcessingMetadataSignature(String name, Object value)
```
public WordProcessingMetadataSignature(String name, Object value)
```

Creates WordProcessing Metadata Signature with predefined values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object. |
| value | java.lang.Object | Value of Metadata signature. |

##### deepClone()
```
public Object deepClone()
```

Clone Metadata Signature instance.

**Returns:**
java.lang.Object - Returns cloned Metadata Signature instance
##### deepClone(Object value)
```
public MetadataSignature deepClone(Object value)
```

Clone Words Metadata Signature instance with given value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object | Value for new cloned object. |

**Returns:**
MetadataSignature - Returns cloned Metadata Signature instance.
##### toString()
```
public String toString()
```

Converts to String with override ToString() method

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

Converts a boolean property into "True" or "False". For another data type the default data format provider will be used.
##### toString(String format, System.IFormatProvider provider)
```
public String toString(String format, System.IFormatProvider provider)
```

Converts to String with specified format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String | Data format string. |
| provider | com.aspose.ms.System.IFormatProvider | Format data provider to use with data conversion operations.

Converts a boolean property into "True" or "False". |

**Returns:**
java.lang.String - Returns the Metadata Signature value as String.

### com.groupdocs.signature.domain.signatures
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures.md

The **GroupDocs.Signature.Domain.Signatures** namespace provides classes for working with Signatures

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSignature | Contains Barcode Signature properties. |
| BaseSignature | Describes base class for signatures. |
| DigitalSignature | Contains Digital signature properties. |
| DocumentResultSignature | Result of processing archive document signing process for document with newly created signatures. |
| ImageSignature | Contains Image signature properties. |
| PdfDigitalSignature | Contains Pdf Digital signature properties. |
| QrCodeSignature | Contains QR-code signature properties. |
| StoreName |  |
| TextSignature | Contains Text signature properties. |

### BarcodeSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/barcodesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class BarcodeSignature extends BaseSignature
```

Contains Barcode Signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSignature(String signatureId) | Initialize BarcodeSignature object with signature identifier that was obtained after search process. |
| BarcodeSignature() | Initialize BarcodeSignature with default parameters. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies the Barcode Encode Type. |
| getText() | Specifies text of Barcode. |
| getFormat() | Specifies the format of Barcode signature image. |
| getContent() | Specifies Barcode binary data image content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Barcode Signature instance. |
| setContent(SignOptions signOptions, BufferedImage image) |  |
##### BarcodeSignature(String signatureId)
```
public BarcodeSignature(String signatureId)
```

Initialize BarcodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by Sign or Search method of Signature class Signature. |

##### BarcodeSignature()
```
public BarcodeSignature()
```

Initialize BarcodeSignature with default parameters.

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Specifies the Barcode Encode Type.

**Returns:**
BarcodeType
##### getText()
```
public final String getText()
```

Specifies text of Barcode.

**Returns:**
java.lang.String
##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of Barcode signature image.

**Returns:**
FileType
##### getContent()
```
public final byte[] getContent()
```

Specifies Barcode binary data image content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). By default this property will not be set. Use property  BarcodeSearchOptions.ReturnContent (BarcodeSearchOptions.getReturnContent/BarcodeSearchOptions.setReturnContent(boolean)) to enable this feature.

**Returns:**
byte[]
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.
##### setContent(SignOptions signOptions, BufferedImage image)
```
public final void setContent(SignOptions signOptions, BufferedImage image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions |  |
| image | java.awt.image.BufferedImage |  |

### BaseSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/basesignature.md

**Inheritance:**
java.lang.Object
```
public abstract class BaseSignature
```

Describes base class for signatures.
#### Methods

| Method | Description |
| --- | --- |
| getSignatureType() | Specifies the type of signature. |
| getPageNumber() | Specifies the page signature was found on. |
| setPageNumber(Integer value) | Specifies the page signature was found on. |
| getSignatureId() | Unique signature identifier to modify signature in the document over Update or Delete methods. |
| isSignature() | Get or set flag to indicate if this component is Signature or document content. |
| setSignature(boolean value) | Get or set flag to indicate if this component is Signature or document content. |
| getDeleted() | Get or set flag to indicate if this signature was deleted from the document. |
| getCreatedOn() | Get or set the signature creation date. |
| setCreatedOn(Date value) | Get or set the signature creation date. |
| getModifiedOn() | Get or set the signature modification date. |
| setModifiedOn(Date value) | Get or set the signature modification date. |
| getTop() | Specifies top position of signature. |
| setTop(int value) | Specifies top position of signature. |
| getLeft() | Specifies left position of signature. |
| setLeft(int value) | Specifies left position of signature. |
| getWidth() | Specifies width of signature. |
| setWidth(int value) | Specifies width of signature. |
| getHeight() | Specifies height of signature. |
| setHeight(int value) | Specifies height of signature. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| supportMetaInfoLayer() |  |
| toString() |  |
##### getSignatureType()
```
public final int getSignatureType()
```

Specifies the type of signature. Digital signature will have this property.

**Returns:**
int
##### getPageNumber()
```
public final Integer getPageNumber()
```

Specifies the page signature was found on.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Specifies the page signature was found on.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getSignatureId()
```
public final String getSignatureId()
```

Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.

**Returns:**
java.lang.String
##### isSignature()
```
public final boolean isSignature()
```

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).

**Returns:**
boolean
##### setSignature(boolean value)
```
public final void setSignature(boolean value)
```

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDeleted()
```
public final boolean getDeleted()
```

Get or set flag to indicate if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.

**Returns:**
boolean
##### getCreatedOn()
```
public final Date getCreatedOn()
```

Get or set the signature creation date.

**Returns:**
java.util.Date
##### setCreatedOn(Date value)
```
public final void setCreatedOn(Date value)
```

Get or set the signature creation date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getModifiedOn()
```
public final Date getModifiedOn()
```

Get or set the signature modification date.

**Returns:**
java.util.Date
##### setModifiedOn(Date value)
```
public final void setModifiedOn(Date value)
```

Get or set the signature modification date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTop()
```
public final int getTop()
```

Specifies top position of signature.

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Specifies top position of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Specifies left position of signature.

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Specifies left position of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Specifies width of signature.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Specifies width of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Specifies height of signature.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Specifies height of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int -
##### supportMetaInfoLayer()
```
public boolean supportMetaInfoLayer()
```

**Returns:**
boolean
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String -

### DigitalSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/digitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class DigitalSignature extends BaseSignature
```

Contains Digital signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignature() | Initialize Digital signature with default parameters. |
| DigitalSignature(String signatureId) | Initialize Digital signature with known SignatureId. |
| DigitalSignature(KeyStore certificate) | Create Digital signature with specified certificate. |
| DigitalSignature(X509Certificate cert, PrivateKey key) | Create Digital signature based on X509Certificate certificate and PrivateKey. |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Gets or sets the KeyStore certificate. |
| setCertificate(KeyStore value) | Gets or sets the KeyStore certificate. |
| getX509Certificate() | Gets or sets the X509 certificate. |
| setX509Certificate(X509Certificate value) | Gets or sets the X509 certificate. |
| getPrivateKey() | Gets or sets the PrivateKey of certificate. |
| setPrivateKey(PrivateKey value) | Gets or sets the PrivateKey of certificate. |
| getCertificateName() | Gets or sets the X509 certificate name. |
| setCertificateName(String value) | Gets or sets the X509 certificate name. |
| getComments() | Gets or sets the signing purpose comment. |
| setComments(String value) | Gets or sets the signing purpose comment. |
| isValid() | Keeps true if this digital signature is valid and the document has not been tampered with. |
| setValid(boolean value) | Keeps true if this digital signature is valid and the document has not been tampered with. |
| getSignTime() | Gets or sets the time the document was signed. |
| setSignTime(Date value) | Gets or sets the time the document was signed. |
| getXAdESType() | XAdES type  XAdESType . |
| setXAdESType(int value) | XAdES type  XAdESType . |
| getThumbprint() | Gets the thumbprint of a certificate. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Barcode Signature instance. |
| loadDigitalSignatures() | Load Digital signature from all system X509 Certificates Stores. |
| loadDigitalSignatures(StoreName storeName) | Load Digital signature from passed X509 Certificates Store. |
##### DigitalSignature()
```
public DigitalSignature()
```

Initialize Digital signature with default parameters.

##### DigitalSignature(String signatureId)
```
public DigitalSignature(String signatureId)
```

Initialize Digital signature with known SignatureId.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String |  |

##### DigitalSignature(KeyStore certificate)
```
public DigitalSignature(KeyStore certificate)
```

Create Digital signature with specified certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificate | java.security.KeyStore | X509 certificate. |

##### DigitalSignature(X509Certificate cert, PrivateKey key)
```
public DigitalSignature(X509Certificate cert, PrivateKey key)
```

Create Digital signature based on X509Certificate certificate and PrivateKey.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cert | java.security.cert.X509Certificate | X509Certificate certificate. |
| key | java.security.PrivateKey | PrivateKey of certificate. |

##### getCertificate()
```
public final KeyStore getCertificate()
```

Gets or sets the KeyStore certificate.

**Returns:**
java.security.KeyStore
##### setCertificate(KeyStore value)
```
public final void setCertificate(KeyStore value)
```

Gets or sets the KeyStore certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.KeyStore |  |

##### getX509Certificate()
```
public final X509Certificate getX509Certificate()
```

Gets or sets the X509 certificate.

**Returns:**
java.security.cert.X509Certificate
##### setX509Certificate(X509Certificate value)
```
public final void setX509Certificate(X509Certificate value)
```

Gets or sets the X509 certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.cert.X509Certificate |  |

##### getPrivateKey()
```
public final PrivateKey getPrivateKey()
```

Gets or sets the PrivateKey of certificate.

**Returns:**
java.security.PrivateKey
##### setPrivateKey(PrivateKey value)
```
public final void setPrivateKey(PrivateKey value)
```

Gets or sets the PrivateKey of certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.security.PrivateKey |  |

##### getCertificateName()
```
public final String getCertificateName()
```

Gets or sets the X509 certificate name.

**Returns:**
java.lang.String
##### setCertificateName(String value)
```
public final void setCertificateName(String value)
```

Gets or sets the X509 certificate name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getComments()
```
public final String getComments()
```

Gets or sets the signing purpose comment.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Gets or sets the signing purpose comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### isValid()
```
public final boolean isValid()
```

Keeps true if this digital signature is valid and the document has not been tampered with.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Keeps true if this digital signature is valid and the document has not been tampered with.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSignTime()
```
public final Date getSignTime()
```

Gets or sets the time the document was signed.

**Returns:**
java.util.Date
##### setSignTime(Date value)
```
public final void setSignTime(Date value)
```

Gets or sets the time the document was signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getXAdESType()
```
public final int getXAdESType()
```

XAdES type  XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

**Returns:**
int
##### setXAdESType(int value)
```
public final void setXAdESType(int value)
```

XAdES type  XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getThumbprint()
```
public final String getThumbprint()
```

Gets the thumbprint of a certificate.

**Returns:**
java.lang.String
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.
##### loadDigitalSignatures()
```
public static List<DigitalSignature> loadDigitalSignatures()
```

Load Digital signature from all system X509 Certificates Stores.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature> - Returns list of DigitalSignature Digital Signatures.
##### loadDigitalSignatures(StoreName storeName)
```
public static List<DigitalSignature> loadDigitalSignatures(StoreName storeName)
```

Load Digital signature from passed X509 Certificates Store.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| storeName | StoreName |  |

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.DigitalSignature> - Returns list of DigitalSignature Digital Signatures.

### DocumentResultSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/documentresultsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class DocumentResultSignature extends BaseSignature
```

Result of processing archive document signing process for document with newly created signatures.
#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Document file name |
| getProcessingTime() | Returns the execution time of the process in milliseconds |
| getTotalSignatures() | Returns the total processed signatures |
| getSourceDocumentSize() | Returns source document size |
| getDestinDocumentSize() | Returns destination document size |
| getSucceeded() | List of successfully processed signatures BaseSignature. |
| getFailed() | List of the signatures that failed during the process BaseSignature. |
| getErrorMessage() | if document was processed with error this property will contain the error message |
##### getFileName()
```
public final String getFileName()
```

Document file name

**Returns:**
java.lang.String
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully processed signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of the signatures that failed during the process BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getErrorMessage()
```
public final String getErrorMessage()
```

if document was processed with error this property will contain the error message

**Returns:**
java.lang.String

### ImageSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/imagesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class ImageSignature extends BaseSignature
```

Contains Image signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSignature(String signatureId) | Initialize ImageSignature object with signature identifier that was obtained after search process. |
| ImageSignature() | Initialize ImageSignature with default parameters. |
#### Methods

| Method | Description |
| --- | --- |
| getSize() | Specifies the size in bytes of signature image. |
| setSize(int value) | Specifies the size in bytes of signature image. |
| getFormat() | Specifies the format of signature image. |
| setFormat(FileType value) | Specifies the format of signature image. |
| getContent() | Specifies image binary data content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Barcode Signature instance. |
##### ImageSignature(String signatureId)
```
public ImageSignature(String signatureId)
```

Initialize ImageSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by Sign or Search method of Signature class Signature. |

##### ImageSignature()
```
public ImageSignature()
```

Initialize ImageSignature with default parameters.

##### getSize()
```
public final int getSize()
```

Specifies the size in bytes of signature image.

**Returns:**
int
##### setSize(int value)
```
public final void setSize(int value)
```

Specifies the size in bytes of signature image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of signature image.

**Returns:**
FileType
##### setFormat(FileType value)
```
public final void setFormat(FileType value)
```

Specifies the format of signature image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### getContent()
```
public final byte[] getContent()
```

Specifies image binary data content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). By default this property will not be set. Use property  ImageSearchOptions.ReturnContent (\{ ImageSearchOptions\#getReturnContent\}/\{ ImageSearchOptions\#setReturnContent(boolean)\}) to enable this feature.

**Returns:**
byte[]
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

### PdfDigitalSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/pdfdigitalsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature, com.groupdocs.signature.domain.signatures.DigitalSignature
```
public class PdfDigitalSignature extends DigitalSignature
```

Contains Pdf Digital signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDigitalSignature() | Initialize Pdf Digital Signature with no certificate. |
| PdfDigitalSignature(KeyStore certificate) | Create Pdf Digital signature with specified certificate. |
#### Methods

| Method | Description |
| --- | --- |
| getContactInfo() | Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. |
| setContactInfo(String value) | Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. |
| getLocation() | The CPU host name or physical location of the signing. |
| setLocation(String value) | The CPU host name or physical location of the signing. |
| getReason() | The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦). |
| setReason(String value) | The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦). |
| getType() | Type of Pdf digital signature. |
| setType(int value) | Type of Pdf digital signature. |
| getTimeStamp() | Time stamp for Pdf digital signature. |
| setTimeStamp(TimeStamp value) | Time stamp for Pdf digital signature. |
| getShowProperties() | Force to show/hide signature properties. |
| setShowProperties(boolean value) | Force to show/hide signature properties. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Barcode Signature instance. |
##### PdfDigitalSignature()
```
public PdfDigitalSignature()
```

Initialize Pdf Digital Signature with no certificate.

##### PdfDigitalSignature(KeyStore certificate)
```
public PdfDigitalSignature(KeyStore certificate)
```

Create Pdf Digital signature with specified certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificate | java.security.KeyStore | X509 certificate. |

##### getContactInfo()
```
public final String getContactInfo()
```

Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.

**Returns:**
java.lang.String
##### setContactInfo(String value)
```
public final void setContactInfo(String value)
```

Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

The CPU host name or physical location of the signing.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

The CPU host name or physical location of the signing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReason()
```
public final String getReason()
```

The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

The reason for the signing, such as (I agree\\u0420\\u0406\\u0420\\u201a\\u0412¦).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getType()
```
public final int getType()
```

Type of Pdf digital signature.

**Returns:**
int
##### setType(int value)
```
public final void setType(int value)
```

Type of Pdf digital signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTimeStamp()
```
public final TimeStamp getTimeStamp()
```

Time stamp for Pdf digital signature. Default value is null.

**Returns:**
TimeStamp
##### setTimeStamp(TimeStamp value)
```
public final void setTimeStamp(TimeStamp value)
```

Time stamp for Pdf digital signature. Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TimeStamp |  |

##### getShowProperties()
```
public final boolean getShowProperties()
```

Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance Digitally signed by \{ ContactInfo (\#getContactInfo.getContactInfo/\#setContactInfo(String).setContactInfo(String))\} Date: \{Date\} Reason: \{ Reason (\#getReason.getReason/\#setReason(String).setReason(String))\} Location: \{ Location (\#getLocation.getLocation/\#setLocation(String).setLocation(String))\} ShowProperties is true by default.

**Returns:**
boolean
##### setShowProperties(boolean value)
```
public final void setShowProperties(boolean value)
```

Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance Digitally signed by \{ ContactInfo (\#getContactInfo.getContactInfo/\#setContactInfo(String).setContactInfo(String))\} Date: \{Date\} Reason: \{ Reason (\#getReason.getReason/\#setReason(String).setReason(String))\} Location: \{ Location (\#getLocation.getLocation/\#setLocation(String).setLocation(String))\} ShowProperties is true by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Barcode Signature instance.

**Returns:**
java.lang.Object - Returns cloned Barcode Signature instance.

### QrCodeSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/qrcodesignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class QrCodeSignature extends BaseSignature
```

Contains QR-code signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSignature(String signatureId) | Initialize QrCodeSignature object with signature identifier that was obtained after search process. |
| QrCodeSignature() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies the QR-code Encode Type. |
| getText() | Specifies text of QR-code. |
| getFormat() | Specifies the format of QR-code signature image. |
| getContent() | Specifies QR-code binary data image content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). |
| <T>getData(Class<T> type) | Obtain object from QR-Code Signature Text over deserialization. |
| <T>getData(IDataEncryption dataEncryption, Class<T> type) | Obtain object from QR-Code Signature Text over deserialization. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone QR-Code Signature instance. |
| setContent(SignOptions signOptions, BufferedImage image) |  |
##### QrCodeSignature(String signatureId)
```
public QrCodeSignature(String signatureId)
```

Initialize QrCodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by sign or search method. |

##### QrCodeSignature()
```
public QrCodeSignature()
```

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Specifies the QR-code Encode Type.

**Returns:**
QrCodeType
##### getText()
```
public final String getText()
```

Specifies text of QR-code.

**Returns:**
java.lang.String
##### getFormat()
```
public final FileType getFormat()
```

Specifies the format of QR-code signature image.

**Returns:**
FileType
##### getContent()
```
public final byte[] getContent()
```

Specifies QR-code binary data image content of type  Format (\#getFormat.getFormat/\#setFormat(FileType).setFormat(FileType)). By default this property will not be set. Use property  QrCodeSearchOptions.ReturnContent (QrCodeSearchOptions.getReturnContent/QrCodeSearchOptions.setReturnContent(boolean)) to enable this feature.

**Returns:**
byte[]
##### <T>getData(Class<T> type)
```
public final T <T>getData(Class<T> type)
```

Obtain object from QR-Code Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |

**Returns:**
T -  T : Type of object to deserialize from QR-Code Text
##### <T>getData(IDataEncryption dataEncryption, Class<T> type)
```
public final T <T>getData(IDataEncryption dataEncryption, Class<T> type)
```

Obtain object from QR-Code Signature Text over deserialization.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dataEncryption | IDataEncryption | Set custom data encryption implementation

 T : Type of object to deserialize from QR-Code Text |
| type | java.lang.Class<T> |  |

**Returns:**
T -
##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone QR-Code Signature instance.

**Returns:**
java.lang.Object - Returns cloned QR-code Signature instance.
##### setContent(SignOptions signOptions, BufferedImage image)
```
public final void setContent(SignOptions signOptions, BufferedImage image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions |  |
| image | java.awt.image.BufferedImage |  |

### StoreName
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/storename.md

**Inheritance:**
java.lang.Object
```
public class StoreName
```
#### Fields

| Field | Description |
| --- | --- |
| My | Represents "Windows-My" java.security.KeyStore type. |
| Root | Represents "Windows-Root" java.security.KeyStore type. |
#### Methods

| Method | Description |
| --- | --- |
| getStoreName() | Store name e.g. |
##### My
```
public static final StoreName My
```

Represents "Windows-My" java.security.KeyStore type.

##### Root
```
public static final StoreName Root
```

Represents "Windows-Root" java.security.KeyStore type.

##### getStoreName()
```
public final String getStoreName()
```

Store name e.g. "Windows-My".

**Returns:**
java.lang.String

### TextSignature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.signatures/textsignature.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.signatures.BaseSignature
```
public class TextSignature extends BaseSignature
```

Contains Text signature properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSignature(String signatureId) | Initialize TextSignature object with signature identifier that was obtained after search process. |
| TextSignature() |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies text in signature. |
| setText(String value) | Specifies text in signature. |
| getSignatureImplementation() | Specifies text signature implementation. |
| getNative() | Specifies the native attribute. |
| setNative(boolean value) | Specifies the native attribute. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| deepClone() | Clone Text Signature instance. |
##### TextSignature(String signatureId)
```
public TextSignature(String signatureId)
```

Initialize TextSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | Unique signature identifier obtained by sign or search method. |

##### TextSignature()
```
public TextSignature()
```

##### getText()
```
public final String getText()
```

Specifies text in signature.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies text in signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Specifies text signature implementation.

**Returns:**
int
##### getNative()
```
public final boolean getNative()
```

Specifies the native attribute. It is true if signature is document-specific.

**Returns:**
boolean
##### setNative(boolean value)
```
public final void setNative(boolean value)
```

Specifies the native attribute. It is true if signature is document-specific.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### equals(Object signature)
```
public boolean equals(Object signature)
```

Overwrites Equals method to compare signature properties

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | java.lang.Object | Signature object to compare with. |

**Returns:**
boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
##### hashCode()
```
public int hashCode()
```

Overrides GetHashCode method

**Returns:**
int - Signature hash code
##### deepClone()
```
public Object deepClone()
```

Clone Text Signature instance.

**Returns:**
java.lang.Object - Returns cloned Text Signature instance.

### com.groupdocs.signature.domain.stamps
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps.md

The **GroupDocs.Signature.Domain.Stamps** namespace provides classes for working with Stamps.

#### Classes

| Class | Description |
| --- | --- |
| Corners | Represents corners of a square graphical object. |
| SquareBorder | Instance to keep Border line properties for square stamp line. |
| StampBackgroundCropType | Specifies crop type of background layer on Stamp elements. |
| StampLine | Specify Stamp line properties. |
| StampTextRepeatType | Specifies type of text repeat for stamp lines. |
| StampType | Specify stamp type properties. |
| StampTypes | Stamp types container. |

### Corners
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/corners.md

**Inheritance:**
java.lang.Object
```
public class Corners
```

Represents corners of a square graphical object.
#### Constructors

| Constructor | Description |
| --- | --- |
| Corners() | Initializes a new instance of Corners class using zero values. |
| Corners(double all) | Initializes a new instance of the Corners class using the supplied value for all corners. |
| Corners(double topLeft, double topRight, double bottomLeft, double bottomRight) | Initializes a new instance of the Corners class using the supplied values. |
#### Fields

| Field | Description |
| --- | --- |
| Empty | Provides a Corners object with no data. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets or sets the value for all corners. |
| setAll(double value) | Gets or sets the value for all corners. |
| getTopLeft() | Gets or sets top left corner value. |
| setTopLeft(double value) | Gets or sets top left corner value. |
| getTopRight() | Gets or sets top right corner value. |
| setTopRight(double value) | Gets or sets top right corner value. |
| getBottomLeft() | Gets or sets bottom left corner value. |
| setBottomLeft(double value) | Gets or sets bottom left corner value. |
| getBottomRight() | Gets or sets bottom right corner value. |
| setBottomRight(double value) | Gets or sets bottom right corner value. |
| deepClone() | Gets a copy of this object. |
| equals(Object obj) | Override equals method |
| hashCode() | Overrides obtaining unique hash code value |
| toString() | Overrides conversion to string. |
##### Corners()
```
public Corners()
```

Initializes a new instance of Corners class using zero values.

##### Corners(double all)
```
public Corners(double all)
```

Initializes a new instance of the Corners class using the supplied value for all corners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| all | double | The value to be used for padding for all corners. |

##### Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)
```
public Corners(double topLeft, double topRight, double bottomLeft, double bottomRight)
```

Initializes a new instance of the Corners class using the supplied values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topLeft | double | Top left corner value. |
| topRight | double | Top right corner value. |
| bottomLeft | double | Bottom left corner value. |
| bottomRight | double | Bottom right corner value. |

##### Empty
```
public static final Corners Empty
```

Provides a Corners object with no data.

##### getAll()
```
public final double getAll()
```

Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;

**Returns:**
double
##### setAll(double value)
```
public final void setAll(double value)
```

Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getTopLeft()
```
public final double getTopLeft()
```

Gets or sets top left corner value.

**Returns:**
double
##### setTopLeft(double value)
```
public final void setTopLeft(double value)
```

Gets or sets top left corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getTopRight()
```
public final double getTopRight()
```

Gets or sets top right corner value.

**Returns:**
double
##### setTopRight(double value)
```
public final void setTopRight(double value)
```

Gets or sets top right corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBottomLeft()
```
public final double getBottomLeft()
```

Gets or sets bottom left corner value.

**Returns:**
double
##### setBottomLeft(double value)
```
public final void setBottomLeft(double value)
```

Gets or sets bottom left corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBottomRight()
```
public final double getBottomRight()
```

Gets or sets bottom right corner value.

**Returns:**
double
##### setBottomRight(double value)
```
public final void setBottomRight(double value)
```

Gets or sets bottom right corner value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Override equals method

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | Instance to compare with. |

**Returns:**
boolean - Returns true if properties of objects are equal.
##### hashCode()
```
public int hashCode()
```

Overrides obtaining unique hash code value

**Returns:**
int -
##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### SquareBorder
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/squareborder.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.domain.Border
```
public class SquareBorder extends Border
```

Instance to keep Border line properties for square stamp line.
#### Constructors

| Constructor | Description |
| --- | --- |
| SquareBorder(double radius) | Creates SquareBorderLine with rounded corner radius. |
| SquareBorder(Corners corners) | Creates SquareBorderLine with corner radius values. |
#### Methods

| Method | Description |
| --- | --- |
| getRadius() | Gets or sets the radius of square corners. |
| setRadius(Corners value) | Gets or sets the radius of square corners. |
##### SquareBorder(double radius)
```
public SquareBorder(double radius)
```

Creates SquareBorderLine with rounded corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| radius | double | Radius of square corners. |

##### SquareBorder(Corners corners)
```
public SquareBorder(Corners corners)
```

Creates SquareBorderLine with corner radius values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| corners | Corners | Radius of square corners. |

##### getRadius()
```
public final Corners getRadius()
```

Gets or sets the radius of square corners.

**Returns:**
Corners
##### setRadius(Corners value)
```
public final void setRadius(Corners value)
```

Gets or sets the radius of square corners.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Corners |  |

### StampBackgroundCropType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/stampbackgroundcroptype.md

**Inheritance:**
java.lang.Object
```
public final class StampBackgroundCropType
```

Specifies crop type of background layer on Stamp elements.
#### Fields

| Field | Description |
| --- | --- |
| None | No crop - all Signature area rectangle will be filled with background. |
| OuterArea | Crop background by external outer line. |
| MiddleArea | Crop background between external and inner lines. |
| InnerArea | Crop background by internal line. |
##### None
```
public static final int None
```

No crop - all Signature area rectangle will be filled with background.

##### OuterArea
```
public static final int OuterArea
```

Crop background by external outer line.

##### MiddleArea
```
public static final int MiddleArea
```

Crop background between external and inner lines.

##### InnerArea
```
public static final int InnerArea
```

Crop background by internal line.

### StampLine
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/stampline.md

**Inheritance:**
java.lang.Object
```
public class StampLine
```

Specify Stamp line properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| StampLine() | Create StampLine with default values. |
| StampLine(String text) | Create StampLine with text. |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets or sets the line height on Stamp. |
| setHeight(int value) | Gets or sets the line height on Stamp. |
| getBackgroundColor() | Gets or sets the background color of signature. |
| setBackgroundColor(Color value) | Gets or sets the background color of signature. |
| setBackgroundColor(String value) | Gets or sets the background color of signature. |
| getText() | Gets or sets the text of stamp line. |
| setText(String value) | Gets or sets the text of stamp line. |
| getFont() | Get or set Font of Stamp Line text. |
| setFont(SignatureFont value) | Get or set Font of Stamp Line text. |
| getTextColor() | Gets or sets the text color of signature. |
| setTextColor(Color value) | Gets or sets the text color of signature. |
| setTextColor(String value) | Gets or sets the text color of signature. |
| getTextBottomIntent() | Gets or sets the bottom intent of text. |
| setTextBottomIntent(int value) | Gets or sets the bottom intent of text. |
| getTextRepeatType() | Gets or sets text repeat type. |
| setTextRepeatType(int value) | Gets or sets text repeat type. |
| getOuterBorder() | Setup Outer Border. |
| setOuterBorder(Border value) | Setup Outer Border. |
| getInnerBorder() | Setup Internal Border. |
| setInnerBorder(Border value) | Setup Internal Border. |
| getVisible() | Get and set visibility of Stamp Line. |
| setVisible(boolean value) | Get and set visibility of Stamp Line. |
##### StampLine()
```
public StampLine()
```

Create StampLine with default values.

##### StampLine(String text)
```
public StampLine(String text)
```

Create StampLine with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text of Stamp Line. |

##### getHeight()
```
public final int getHeight()
```

Gets or sets the line height on Stamp.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Gets or sets the line height on Stamp.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBackgroundColor()
```
public final Color getBackgroundColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setBackgroundColor(Color value)
```
public final void setBackgroundColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setBackgroundColor(String value)
```
public final void setBackgroundColor(String value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getText()
```
public final String getText()
```

Gets or sets the text of stamp line.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets the text of stamp line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFont()
```
public final SignatureFont getFont()
```

Get or set Font of Stamp Line text.

**Returns:**
SignatureFont
##### setFont(SignatureFont value)
```
public final void setFont(SignatureFont value)
```

Get or set Font of Stamp Line text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureFont |  |

##### getTextColor()
```
public final Color getTextColor()
```

Gets or sets the text color of signature.

**Returns:**
java.awt.Color
##### setTextColor(Color value)
```
public final void setTextColor(Color value)
```

Gets or sets the text color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setTextColor(String value)
```
public final void setTextColor(String value)
```

Gets or sets the text color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTextBottomIntent()
```
public final int getTextBottomIntent()
```

Gets or sets the bottom intent of text.

**Returns:**
int
##### setTextBottomIntent(int value)
```
public final void setTextBottomIntent(int value)
```

Gets or sets the bottom intent of text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextRepeatType()
```
public final int getTextRepeatType()
```

Gets or sets text repeat type.

**Returns:**
int
##### setTextRepeatType(int value)
```
public final void setTextRepeatType(int value)
```

Gets or sets text repeat type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getOuterBorder()
```
public final Border getOuterBorder()
```

Setup Outer Border.

**Returns:**
Border
##### setOuterBorder(Border value)
```
public final void setOuterBorder(Border value)
```

Setup Outer Border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getInnerBorder()
```
public final Border getInnerBorder()
```

Setup Internal Border.

**Returns:**
Border
##### setInnerBorder(Border value)
```
public final void setInnerBorder(Border value)
```

Setup Internal Border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getVisible()
```
public final boolean getVisible()
```

Get and set visibility of Stamp Line.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

Get and set visibility of Stamp Line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### StampTextRepeatType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/stamptextrepeattype.md

**Inheritance:**
java.lang.Object
```
public final class StampTextRepeatType
```

Specifies type of text repeat for stamp lines.
#### Fields

| Field | Description |
| --- | --- |
| None | No repeat. |
| FullTextRepeat | Text will be repeated to fit full length without truncation. |
| RepeatWithTruncation | Text will be repeated to fit full length with word truncation at the end. |
##### None
```
public static final int None
```

No repeat.

##### FullTextRepeat
```
public static final int FullTextRepeat
```

Text will be repeated to fit full length without truncation.

##### RepeatWithTruncation
```
public static final int RepeatWithTruncation
```

Text will be repeated to fit full length with word truncation at the end.

### StampType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/stamptype.md

**Inheritance:**
java.lang.Object
```
public final class StampType
```

Specify stamp type properties.
#### Methods

| Method | Description |
| --- | --- |
| getTypeIndex() | Get Index of object in collection of supported stamp types. |
| getTypeName() | Name of stamp type. |
| equals(StampType other) | Determines whether the specified stamp type is equal to the current object. |
| hashCode() | Overridden method serves as a hash function for a particular type. |
| toString() | Overridden method serves as conversion to string type. |
##### getTypeIndex()
```
public final int getTypeIndex()
```

Get Index of object in collection of supported stamp types.

**Returns:**
int
##### getTypeName()
```
public final String getTypeName()
```

Name of stamp type.

**Returns:**
java.lang.String
##### equals(StampType other)
```
public final boolean equals(StampType other)
```

Determines whether the specified stamp type is equal to the current object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | StampType | Object for comparison. |

**Returns:**
boolean - Result of comparison.
##### hashCode()
```
public int hashCode()
```

Overridden method serves as a hash function for a particular type.

**Returns:**
int - Hash.
##### toString()
```
public String toString()
```

Overridden method serves as conversion to string type.

**Returns:**
java.lang.String - String.

### StampTypes
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.stamps/stamptypes.md

**Inheritance:**
java.lang.Object
```
public class StampTypes
```

Stamp types container.
#### Constructors

| Constructor | Description |
| --- | --- |
| StampTypes() |  |
#### Fields

| Field | Description |
| --- | --- |
| Round | Round stamp type object. |
| Square | Square stamp type object. |
#### Methods

| Method | Description |
| --- | --- |
| getAllTypes() | All stamp types. |
| parse(String parsingType) | Returns stamp type with pasringType name. |
| tryParse(String parsingType) | Returns stamp type with pasringType name. |
##### StampTypes()
```
public StampTypes()
```

##### Round
```
public static final StampType Round
```

Round stamp type object.

##### Square
```
public static final StampType Square
```

Square stamp type object.

##### getAllTypes()
```
public static StampType[] getAllTypes()
```

All stamp types.

**Returns:**
com.groupdocs.signature.domain.stamps.StampType[]
##### parse(String parsingType)
```
public static StampType parse(String parsingType)
```

Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of stamp type name. |

**Returns:**
StampType - StampType instance.
##### tryParse(String parsingType)
```
public static StampType tryParse(String parsingType)
```

Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parsingType | java.lang.String | Source string of stamp type name. |

**Returns:**
StampType - StampType instance.

### com.groupdocs.signature.domain.structs
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.structs.md

#### Classes

| Class | Description |
| --- | --- |
| TimeStamp | Represents data to get time stamp from third-party site. |

### TimeStamp
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.structs/timestamp.md

**Inheritance:**
java.lang.Object
```
public class TimeStamp
```

Represents data to get time stamp from third-party site.
#### Constructors

| Constructor | Description |
| --- | --- |
| TimeStamp() |  |
| TimeStamp(String url, String user, String password) | Instantiates new time stamp structure. |
#### Methods

| Method | Description |
| --- | --- |
| getUrl() | Url of third-party site. |
| setUrl(String value) | Url of third-party site. |
| getUser() | User. |
| setUser(String value) | User. |
| getPassword() | Password. |
| setPassword(String value) | Password. |
| CloneTo(TimeStamp that) |  |
| Clone() |  |
| clone() |  |
| equals(Object obj) |  |
| hashCode() |  |
| equals(TimeStamp obj1, TimeStamp obj2) |  |
##### TimeStamp()
```
public TimeStamp()
```

##### TimeStamp(String url, String user, String password)
```
public TimeStamp(String url, String user, String password)
```

Instantiates new time stamp structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.lang.String | Url of third-party site. |
| user | java.lang.String | User. |
| password | java.lang.String | Password. |

##### getUrl()
```
public final String getUrl()
```

Url of third-party site.

**Returns:**
java.lang.String
##### setUrl(String value)
```
public final void setUrl(String value)
```

Url of third-party site.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUser()
```
public final String getUser()
```

User.

**Returns:**
java.lang.String
##### setUser(String value)
```
public final void setUser(String value)
```

User.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Password.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### CloneTo(TimeStamp that)
```
public void CloneTo(TimeStamp that)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| that | TimeStamp |  |

##### Clone()
```
public TimeStamp Clone()
```

**Returns:**
TimeStamp
##### clone()
```
public Object clone()
```

**Returns:**
java.lang.Object
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(TimeStamp obj1, TimeStamp obj2)
```
public static boolean equals(TimeStamp obj1, TimeStamp obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | TimeStamp |  |
| obj2 | TimeStamp |  |

**Returns:**
boolean

### com.groupdocs.signature.domain
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain.md

The **GroupDocs.Signature.Domain** namespace provides classes for working with document representation.

#### Classes

| Class | Description |
| --- | --- |
| Background | Represents background appearance |
| Border | Instance to keep Border line properties. |
| DeleteResult | Result of signature(s) deletion from the document. |
| Padding | Represents padding or margin information associated with element. |
| PageInfo | Document page description class |
| ProcessLog | Represents document process details. |
| SearchResult | Result of searching for signatures in specified document. |
| SignResult | Result of signing process for document with newly created signatures. |
| SignatureFont | Create instance of SignatureFont class to specify Font properties. |
| UpdateResult | Result of modification of signatures in the document. |
| VerificationResult | Instance to keep results of verification process. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IResult | Common interface for signature process result. |

### Background
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/background.md

**Inheritance:**
java.lang.Object
```
public class Background
```

Represents background appearance
#### Constructors

| Constructor | Description |
| --- | --- |
| Background() |  |
#### Methods

| Method | Description |
| --- | --- |
| getColor() | Gets or sets the background color of signature. |
| setColor(Color value) | Gets or sets the background color of signature. |
| setColor(String value) | Gets or sets the background color of signature. |
| getTransparency() | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| setTransparency(double value) | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| getBrush() | Gets or sets the background brush. |
| setBrush(Brush value) | Gets or sets the background brush. |
##### Background()
```
public Background()
```

##### getColor()
```
public final Color getColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getBrush()
```
public final Brush getBrush()
```

Gets or sets the background brush. Value by default is null. This property expects instance of Brush objects implementations See different Brush classes

**Returns:**
Brush
##### setBrush(Brush value)
```
public final void setBrush(Brush value)
```

Gets or sets the background brush. Value by default is null. This property expects instance of Brush objects implementations See different Brush classes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Brush |  |

### Border
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/border.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.ITransparency
```
public class Border implements ITransparency
```

Instance to keep Border line properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| Border() |  |
#### Methods

| Method | Description |
| --- | --- |
| getDashStyle() | Gets or sets the signature border style. |
| setDashStyle(int value) | Gets or sets the signature border style. |
| getTransparency() | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| setTransparency(double value) | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| getWeight() | Gets or sets the weight of the signature border. |
| setWeight(double value) | Gets or sets the weight of the signature border. |
| getColor() | Gets or sets the border color of signature. |
| setColor(Color value) | Gets or sets the border color of signature. |
| setColor(String value) | Gets or sets the border color of signature. |
| getVisible() | Gets or sets the border visibility. |
| setVisible(boolean value) |  |
| deepClone() | Implement IClonable interface |
##### Border()
```
public Border()
```

##### getDashStyle()
```
public final int getDashStyle()
```

Gets or sets the signature border style.

**Returns:**
int
##### setDashStyle(int value)
```
public final void setDashStyle(int value)
```

Gets or sets the signature border style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getWeight()
```
public final double getWeight()
```

Gets or sets the weight of the signature border.

**Returns:**
double
##### setWeight(double value)
```
public final void setWeight(double value)
```

Gets or sets the weight of the signature border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getColor()
```
public final Color getColor()
```

Gets or sets the border color of signature.

**Returns:**
java.awt.Color
##### setColor(Color value)
```
public final void setColor(Color value)
```

Gets or sets the border color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setColor(String value)
```
public final void setColor(String value)
```

Gets or sets the border color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getVisible()
```
public boolean getVisible()
```

Gets or sets the border visibility.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### deepClone()
```
public final Object deepClone()
```

Implement IClonable interface

**Returns:**
java.lang.Object - Newly created Border instance with same properties

### DeleteResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/deleteresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class DeleteResult implements IResult
```

Result of signature(s) deletion from the document.
#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds. |
| getTotalSignatures() | Returns the total processed signatures. |
| getSourceDocumentSize() | Returns source document size. |
| getDestinDocumentSize() | Returns updated document size. |
| getSucceeded() | List of successfully deleted signatures BaseSignature. |
| getFailed() | List of signatures that were not deleted BaseSignature. |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures.

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size.

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns updated document size.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully deleted signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were not deleted BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### IResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/iresult.md

### Padding
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/padding.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Cloneable
```
public class Padding implements Cloneable
```

Represents padding or margin information associated with element.
#### Constructors

| Constructor | Description |
| --- | --- |
| Padding() | Initializes a new instance of Padding class using zero values. |
| Padding(int all) | Initializes a new instance of the Padding class using the supplied padding size for all edges. |
| Padding(int left, int right, int top, int bottom) | Initializes a new instance of the Padding class using the supplied padding sizes. |
#### Fields

| Field | Description |
| --- | --- |
| Empty | Provides a Padding object with no padding. |
#### Methods

| Method | Description |
| --- | --- |
| getAll() | Gets or sets the padding value for all the edges. |
| setAll(int value) | Gets or sets the padding value for all the edges. |
| getLeft() | Gets or sets the padding value for the left edge. |
| setLeft(int value) | Gets or sets the padding value for the left edge. |
| getRight() | Gets or sets the padding value for the right edge. |
| setRight(int value) | Gets or sets the padding value for the right edge. |
| getTop() | Gets or sets the padding value for the top edge. |
| setTop(int value) | Gets or sets the padding value for the top edge. |
| getBottom() | Gets or sets the padding value for the bottom edge. |
| setBottom(int value) | Gets or sets the padding value for the bottom edge. |
| getHorizontal() | Gets the combined padding for the right and left edges. |
| getVertical() | Gets the combined padding for the top and bottom edges. |
| deepClone() | Gets a copy of this object. |
| toString() | Overrides conversion to string |
##### Padding()
```
public Padding()
```

Initializes a new instance of Padding class using zero values.

##### Padding(int all)
```
public Padding(int all)
```

Initializes a new instance of the Padding class using the supplied padding size for all edges.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| all | int | The number of measure units to be used for padding for all edges. |

##### Padding(int left, int right, int top, int bottom)
```
public Padding(int left, int right, int top, int bottom)
```

Initializes a new instance of the Padding class using the supplied padding sizes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | int | The left padding size. |
| right | int | The right padding size. |
| top | int | The top padding size. |
| bottom | int | The bottom padding size. |

##### Empty
```
public static final Padding Empty
```

Provides a Padding object with no padding.

##### getAll()
```
public final int getAll()
```

Gets or sets the padding value for all the edges. Changing of any partial edge like left or top makes this property equal 0;

**Returns:**
int
##### setAll(int value)
```
public final void setAll(int value)
```

Gets or sets the padding value for all the edges. Changing of any partial edge like left or top makes this property equal 0;

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLeft()
```
public final int getLeft()
```

Gets or sets the padding value for the left edge.

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Gets or sets the padding value for the left edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRight()
```
public final int getRight()
```

Gets or sets the padding value for the right edge.

**Returns:**
int
##### setRight(int value)
```
public final void setRight(int value)
```

Gets or sets the padding value for the right edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Gets or sets the padding value for the top edge.

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Gets or sets the padding value for the top edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBottom()
```
public final int getBottom()
```

Gets or sets the padding value for the bottom edge.

**Returns:**
int
##### setBottom(int value)
```
public final void setBottom(int value)
```

Gets or sets the padding value for the bottom edge.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontal()
```
public final int getHorizontal()
```

Gets the combined padding for the right and left edges.

**Returns:**
int
##### getVertical()
```
public final int getVertical()
```

Gets the combined padding for the top and bottom edges.

**Returns:**
int
##### deepClone()
```
public final Object deepClone()
```

Gets a copy of this object.

**Returns:**
java.lang.Object
##### toString()
```
public String toString()
```

Overrides conversion to string

**Returns:**
java.lang.String -

### PageInfo
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/pageinfo.md

**Inheritance:**
java.lang.Object
```
public class PageInfo
```

Document page description class
#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Specifies page width |
| setWidth(int value) | Specifies page width |
| getHeight() | Specifies page height |
| setHeight(int value) | Specifies page height |
| getPageNumber() | Specifies page number |
| setPageNumber(int value) | Specifies page number |
##### PageInfo()
```
public PageInfo()
```

##### getWidth()
```
public final int getWidth()
```

Specifies page width

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Specifies page width

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Specifies page height

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Specifies page height

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumber()
```
public final int getPageNumber()
```

Specifies page number

**Returns:**
int
##### setPageNumber(int value)
```
public final void setPageNumber(int value)
```

Specifies page number

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessLog
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/processlog.md

**Inheritance:**
java.lang.Object
```
public final class ProcessLog
```

Represents document process details.
#### Methods

| Method | Description |
| --- | --- |
| getDate() | Get the process date and time. |
| getType() | Get the process type. |
| getMessage() | Get the process description. |
| getSucceeded() | Quantity of successfully processed signatures. |
| getFailed() | Quantity of signatures that failed during processing. |
| getSignatures() | The list of successfully processed signatures. |
##### getDate()
```
public final Date getDate()
```

Get the process date and time.

**Returns:**
java.util.Date
##### getType()
```
public final int getType()
```

Get the process type.

**Returns:**
int
##### getMessage()
```
public final String getMessage()
```

Get the process description.

**Returns:**
java.lang.String
##### getSucceeded()
```
public final int getSucceeded()
```

Quantity of successfully processed signatures.

**Returns:**
int
##### getFailed()
```
public final int getFailed()
```

Quantity of signatures that failed during processing.

**Returns:**
int
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

The list of successfully processed signatures.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### SearchResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/searchresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.lang.Iterable
```
public class SearchResult implements Iterable<BaseSignature>
```

Result of searching for signatures in specified document.
#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the search process in milliseconds. |
| getTotalSignatures() | Returns the total processed signatures by the search process |
| getSourceDocumentSize() | Returns source document size |
| getDestinDocumentSize() | Returns destination document size. |
| getSucceeded() | List of found signatures BaseSignature. |
| getFailed() | List of signatures BaseSignature that failed Search process by search criteria. |
| getSignatures() | List of detected signatures BaseSignature. |
| <T>toList(Class<T> typeOfT) | Provides conversion to strongly typed list of signatures. |
| updateContextData(SearchContext context, int documentType) |  |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the search process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures by the search process

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size. For Search method it always returns 0.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of found signatures BaseSignature. This list will be always equal to  Signatures (\#getSignatures.getSignatures/\#setSignatures(List).setSignatures(List)) property.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures BaseSignature that failed Search process by search criteria. Not supported in current version.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getSignatures()
```
public final List<BaseSignature> getSignatures()
```

List of detected signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### <T>toList(Class<T> typeOfT)
```
public final List<T> <T>toList(Class<T> typeOfT)
```

Provides conversion to strongly typed list of signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |

**Returns:**
java.util.List<T> - Returns list of given signature type.

 T : The type of signatures in the list.
##### updateContextData(SearchContext context, int documentType)
```
public final void updateContextData(SearchContext context, int documentType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| context | SearchContext |  |
| documentType | int |  |

### SignatureFont
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/signaturefont.md

**Inheritance:**
java.lang.Object
```
public class SignatureFont
```

Create instance of SignatureFont class to specify Font properties.
#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureFont() | Create SignatureFont with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Font Family Name. |
| setFamilyName(String value) | Font Family Name. |
| getSize() | Font Size. |
| setSize(float value) | Font Size. |
| getBold() | Apply Font Bold Style. |
| setBold(boolean value) | Apply Font Bold Style. |
| getItalic() | Apply Font Italic Style. |
| setItalic(boolean value) | Apply Font Italic Style. |
| getUnderline() | Apply Underline Style. |
| setUnderline(boolean value) | Apply Underline Style. |
| getStrikeout() | Apply Strikeout Style. |
| setStrikeout(boolean value) | Apply Strikeout Style. |
| to_SignatureFont(System.Drawing.Font font) | Convert System.Drawing.Font to SignatureFont. |
| toString() | Override conversion to string |
##### SignatureFont()
```
public SignatureFont()
```

Create SignatureFont with default values.

##### getFamilyName()
```
public final String getFamilyName()
```

Font Family Name.

**Returns:**
java.lang.String
##### setFamilyName(String value)
```
public final void setFamilyName(String value)
```

Font Family Name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSize()
```
public final float getSize()
```

Font Size.

**Returns:**
float
##### setSize(float value)
```
public final void setSize(float value)
```

Font Size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getBold()
```
public final boolean getBold()
```

Apply Font Bold Style.

**Returns:**
boolean
##### setBold(boolean value)
```
public final void setBold(boolean value)
```

Apply Font Bold Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getItalic()
```
public final boolean getItalic()
```

Apply Font Italic Style.

**Returns:**
boolean
##### setItalic(boolean value)
```
public final void setItalic(boolean value)
```

Apply Font Italic Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getUnderline()
```
public final boolean getUnderline()
```

Apply Underline Style.

**Returns:**
boolean
##### setUnderline(boolean value)
```
public final void setUnderline(boolean value)
```

Apply Underline Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getStrikeout()
```
public final boolean getStrikeout()
```

Apply Strikeout Style.

**Returns:**
boolean
##### setStrikeout(boolean value)
```
public final void setStrikeout(boolean value)
```

Apply Strikeout Style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### to_SignatureFont(System.Drawing.Font font)
```
public static SignatureFont to_SignatureFont(System.Drawing.Font font)
```

Convert System.Drawing.Font to SignatureFont.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| font | com.aspose.ms.System.Drawing.Font | Font. |

**Returns:**
SignatureFont - SignatureFont.
##### toString()
```
public String toString()
```

Override conversion to string

**Returns:**
java.lang.String -

### SignResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/signresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class SignResult implements IResult
```

Result of signing process for document with newly created signatures.
#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds |
| getTotalSignatures() | Returns the total processed signatures |
| getSourceDocumentSize() | Returns source document size |
| getDestinDocumentSize() | Returns destination document size |
| getSucceeded() | List of newly created signatures BaseSignature. |
| getFailed() | List of signatures that were failed to create. |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of newly created signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were failed to create.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### UpdateResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/updateresult.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.domain.IResult
```
public class UpdateResult implements IResult
```

Result of modification of signatures in the document.
#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds |
| getTotalSignatures() | Returns the total processed signatures |
| getSourceDocumentSize() | Returns source document size |
| getDestinDocumentSize() | Returns destination document size |
| getSucceeded() | List of successfully modified signatures BaseSignature. |
| getFailed() | List of signatures that were not updated BaseSignature. |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns destination document size

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully modified signatures BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### getFailed()
```
public final List<BaseSignature> getFailed()
```

List of signatures that were not updated BaseSignature.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>

### VerificationResult
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.domain/verificationresult.md

**Inheritance:**
java.lang.Object
```
public class VerificationResult
```

Instance to keep results of verification process.
#### Methods

| Method | Description |
| --- | --- |
| getProcessingTime() | Returns the execution time of the process in milliseconds. |
| getTotalSignatures() | Returns the total processed signatures |
| getSourceDocumentSize() | Returns source document size in bytes |
| getDestinDocumentSize() | Returns the destination document size. |
| getSucceeded() | List of successfully verified signatures BaseSignature. |
| isValid() | Returns true if Verification process was successful otherwise false. |
| setValid(boolean value) | Returns true if Verification process was successful otherwise false. |
##### getProcessingTime()
```
public final long getProcessingTime()
```

Returns the execution time of the process in milliseconds.

**Returns:**
long
##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Returns the total processed signatures

**Returns:**
int
##### getSourceDocumentSize()
```
public final long getSourceDocumentSize()
```

Returns source document size in bytes

**Returns:**
long
##### getDestinDocumentSize()
```
public final long getDestinDocumentSize()
```

Returns the destination document size. For verification this variable always contains zero.

**Returns:**
long
##### getSucceeded()
```
public final List<BaseSignature> getSucceeded()
```

List of successfully verified signatures BaseSignature. Currently this property is not supported.

**Returns:**
java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
##### isValid()
```
public final boolean isValid()
```

Returns true if Verification process was successful otherwise false.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Returns true if Verification process was successful otherwise false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### com.groupdocs.signature.exception
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.exception.md

The **GroupDocs.Signature.Exception** namespace provides classes to handle Signature exceptions.

#### Classes

| Class | Description |
| --- | --- |
| GroupDocsSignatureException | Represents errors that occur during document signing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

### GroupDocsSignatureException
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.exception/groupdocssignatureexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception
```
public class GroupDocsSignatureException extends Exception
```

Represents errors that occur during document signing.
#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsSignatureException() | Initializes a new instance of the GroupDocsSignatureException class. |
| GroupDocsSignatureException(String message) | Initializes a new instance of the GroupDocsSignatureException class with a specified error message. |
| GroupDocsSignatureException(Exception ex, String message) | Initializes a new instance of the GroupDocsSignatureException class with a specified error message and original exception. |
##### GroupDocsSignatureException()
```
public GroupDocsSignatureException()
```

Initializes a new instance of the GroupDocsSignatureException class.

##### GroupDocsSignatureException(String message)
```
public GroupDocsSignatureException(String message)
```

Initializes a new instance of the GroupDocsSignatureException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### GroupDocsSignatureException(Exception ex, String message)
```
public GroupDocsSignatureException(Exception ex, String message)
```

Initializes a new instance of the GroupDocsSignatureException class with a specified error message and original exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ex | java.lang.Exception | The original exception. |
| message | java.lang.String | The message that describes the error. |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.exception/incorrectpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.signature.exception.GroupDocsSignatureException
```
public class IncorrectPasswordException extends GroupDocsSignatureException
```

The exception that is thrown when specified password is incorrect.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() |  |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

### PasswordRequiredException
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.exception/passwordrequiredexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, com.groupdocs.signature.exception.GroupDocsSignatureException
```
public class PasswordRequiredException extends GroupDocsSignatureException
```

The exception that is thrown when password is required to load the document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() |  |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

### com.groupdocs.signature.handler.events
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events.md

The **GroupDocs.Signature.Handler.Events** namespace provides classes for input and output Data Handlers.

#### Classes

| Class | Description |
| --- | --- |
| ProcessCompleteEventArgs | Provides data on complete event of signing, verification and search processes. |
| ProcessCompleteEventHandler | Represents a method delegate which will handle processes on complete events for signing, verification and search. |
| ProcessEventArgs | Provides data for different events of signature, verification and search processes. |
| ProcessProgressEventArgs | Provides data for OnProgress event of signing, verification and search processes. |
| ProcessProgressEventHandler | Represents a method delegate which will handle processes on progress events for signing, verification and search. |
| ProcessStartEventArgs | Provides data for Start event of signing, verification and search process |
| ProcessStartEventHandler | Represents a method delegate which will handle processes on start events for signing, verification and search. |

### ProcessCompleteEventArgs
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processcompleteeventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessCompleteEventArgs extends ProcessEventArgs
```

Provides data on complete event of signing, verification and search processes.
#### Methods

| Method | Description |
| --- | --- |
| getCompleted() | Represents time mark of process completion. |
| setCompleted(Date value) | Represents time mark of process completion. |
| getTicks() | Represents time in milliseconds spent since process Start event. |
| setTicks(long value) | Represents time in milliseconds spent since process Start event. |
| getTotalSignatures() | Represents total quantity of processed signatures. |
| setTotalSignatures(int value) | Represents total quantity of processed signatures. |
| getCanceled() | Indicates whether process was canceled. |
##### getCompleted()
```
public final Date getCompleted()
```

Represents time mark of process completion.

**Returns:**
java.util.Date
##### setCompleted(Date value)
```
public final void setCompleted(Date value)
```

Represents time mark of process completion.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTicks()
```
public final long getTicks()
```

Represents time in milliseconds spent since process Start event.

**Returns:**
long
##### setTicks(long value)
```
public final void setTicks(long value)
```

Represents time in milliseconds spent since process Start event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Represents total quantity of processed signatures.

**Returns:**
int
##### setTotalSignatures(int value)
```
public final void setTotalSignatures(int value)
```

Represents total quantity of processed signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCanceled()
```
public final boolean getCanceled()
```

Indicates whether process was canceled.

**Returns:**
boolean

### ProcessCompleteEventHandler
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processcompleteeventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessCompleteEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on complete events for signing, verification and search.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessCompleteEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessCompleteEventArgs args) |  |
##### ProcessCompleteEventHandler()
```
public ProcessCompleteEventHandler()
```

##### invoke(Signature signature, ProcessCompleteEventArgs args)
```
public abstract void invoke(Signature signature, ProcessCompleteEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessCompleteEventArgs |  |

### ProcessEventArgs
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processeventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs
```
public class ProcessEventArgs extends System.EventArgs
```

Provides data for different events of signature, verification and search processes.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFilePath() | Represents document processing file name. |
| setFilePath(String value) | Represents document processing file name. |
| getStatus() | Indicates current process state. |
| setStatus(int value) | Indicates current process state. |
##### ProcessEventArgs()
```
public ProcessEventArgs()
```

##### getFilePath()
```
public final String getFilePath()
```

Represents document processing file name.

**Returns:**
java.lang.String
##### setFilePath(String value)
```
public final void setFilePath(String value)
```

Represents document processing file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getStatus()
```
public final int getStatus()
```

Indicates current process state.

**Returns:**
int
##### setStatus(int value)
```
public final void setStatus(int value)
```

Indicates current process state.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessProgressEventArgs
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processprogresseventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessProgressEventArgs extends ProcessEventArgs
```

Provides data for OnProgress event of signing, verification and search processes.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessProgressEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getProgress() | Represents progress in percents. |
| setProgress(int value) | Represents progress in percents. |
| getTicks() | Represents time spent in milliseconds since process Start event. |
| setTicks(long value) | Represents time spent in milliseconds since process Start event. |
| getProcessedSignatures() | Represents quantity of processed signatures. |
| setProcessedSignatures(int value) | Represents quantity of processed signatures. |
| getCancel() | Indicates whether process should be canceled. |
| setCancel(boolean value) | Indicates whether process should be canceled. |
##### ProcessProgressEventArgs()
```
public ProcessProgressEventArgs()
```

##### getProgress()
```
public final int getProgress()
```

Represents progress in percents. Value range is from 0 to 100.

**Returns:**
int
##### setProgress(int value)
```
public final void setProgress(int value)
```

Represents progress in percents. Value range is from 0 to 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTicks()
```
public final long getTicks()
```

Represents time spent in milliseconds since process Start event.

**Returns:**
long
##### setTicks(long value)
```
public final void setTicks(long value)
```

Represents time spent in milliseconds since process Start event.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getProcessedSignatures()
```
public final int getProcessedSignatures()
```

Represents quantity of processed signatures.

**Returns:**
int
##### setProcessedSignatures(int value)
```
public final void setProcessedSignatures(int value)
```

Represents quantity of processed signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCancel()
```
public final boolean getCancel()
```

Indicates whether process should be canceled.

**Returns:**
boolean
##### setCancel(boolean value)
```
public final void setCancel(boolean value)
```

Indicates whether process should be canceled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### ProcessProgressEventHandler
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processprogresseventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessProgressEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on progress events for signing, verification and search.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessProgressEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessProgressEventArgs args) |  |
##### ProcessProgressEventHandler()
```
public ProcessProgressEventHandler()
```

##### invoke(Signature signature, ProcessProgressEventArgs args)
```
public abstract void invoke(Signature signature, ProcessProgressEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessProgressEventArgs |  |

### ProcessStartEventArgs
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processstarteventargs.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.EventArgs, com.groupdocs.signature.handler.events.ProcessEventArgs
```
public class ProcessStartEventArgs extends ProcessEventArgs
```

Provides data for Start event of signing, verification and search process
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessStartEventArgs() |  |
#### Methods

| Method | Description |
| --- | --- |
| getStarted() | Represents time mark of process start. |
| setStarted(Date value) | Represents time mark of process start. |
| getTotalSignatures() | Represents total quantity of signatures to be processed. |
| setTotalSignatures(int value) | Represents total quantity of signatures to be processed. |
##### ProcessStartEventArgs()
```
public ProcessStartEventArgs()
```

##### getStarted()
```
public final Date getStarted()
```

Represents time mark of process start.

**Returns:**
java.util.Date
##### setStarted(Date value)
```
public final void setStarted(Date value)
```

Represents time mark of process start.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getTotalSignatures()
```
public final int getTotalSignatures()
```

Represents total quantity of signatures to be processed.

**Returns:**
int
##### setTotalSignatures(int value)
```
public final void setTotalSignatures(int value)
```

Represents total quantity of signatures to be processed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### ProcessStartEventHandler
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.handler.events/processstarteventhandler.md

**Inheritance:**
java.lang.Object, com.aspose.ms.System.Delegate, com.aspose.ms.System.MulticastDelegate
```
public abstract class ProcessStartEventHandler extends System.MulticastDelegate
```

Represents a method delegate which will handle processes on start events for signing, verification and search.
#### Constructors

| Constructor | Description |
| --- | --- |
| ProcessStartEventHandler() |  |
#### Methods

| Method | Description |
| --- | --- |
| invoke(Signature signature, ProcessStartEventArgs args) |  |
##### ProcessStartEventHandler()
```
public ProcessStartEventHandler()
```

##### invoke(Signature signature, ProcessStartEventArgs args)
```
public abstract void invoke(Signature signature, ProcessStartEventArgs args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | Signature |  |
| args | ProcessStartEventArgs |  |

### com.groupdocs.signature.licensing
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.licensing.md

The **GroupDocs.Signature.Licensing** namespace provides classes for licensing the Signature library.

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |

### License
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.licensing/license.md

**Inheritance:**
java.lang.Object
```
public final class License
```

Provides methods to license the component. Learn more about licensing  [here][] .

[here]: https://purchase.groupdocs.com/faqs/licensing
#### Constructors

| Constructor | Description |
| --- | --- |
| License() | Instantiate the License |
#### Methods

| Method | Description |
| --- | --- |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(InputStream licenseStream) | Licenses the component. |
##### License()
```
public License()
```

Instantiate the License

##### 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.Signature.lic";
>  GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>  lic.SetLicense(licensePath);
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path. |

##### 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 (FileStream licenseStream = new FileStream("GroupDocs.Signature.lic", FileMode.Open))
>  {
>      GroupDocs.Signature.License lic = new GroupDocs.Signature.License();
>      lic.SetLicense(licenseStream);
>  }
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

### com.groupdocs.signature.logging
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.logging.md

The **GroupDocs.Signature.Logging** namespace provides classes for logging purposes.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the file. |
| FileLogger | Writes log messages to the file. |
| LogLevel | Specifies the available Log Level types. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

### ConsoleLogger
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.logging/consolelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.logging.ILogger
```
public class ConsoleLogger implements ILogger
```

Writes log messages to the file.
#### Constructors

| Constructor | Description |
| --- | --- |
| ConsoleLogger() | Create logger to console. |
#### Methods

| Method | Description |
| --- | --- |
| error(String message, Exception exception) | Writes an error message to the console. |
| trace(String message) | Writes trace message to the console. |
| warning(String message) | Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow. |
##### ConsoleLogger()
```
public ConsoleLogger()
```

Create logger to console.

##### error(String message, Exception exception)
```
public final void error(String message, Exception exception)
```

Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message. |
| exception | java.lang.Exception | The exception. |

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |

##### warning(String message)
```
public final void warning(String message)
```

Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message. |

### FileLogger
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.logging/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.signature.logging.ILogger
```
public class FileLogger implements ILogger
```

Writes log messages to the file.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String fileName) | Create logger to file. |
#### Methods

| Method | Description |
| --- | --- |
| error(String message, Exception exception) | Writes an error message to the console. |
| trace(String message) | Writes trace message to the console. |
| warning(String message) | Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow. |
##### FileLogger(String fileName)
```
public FileLogger(String fileName)
```

Create logger to file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | Full file name with path |

##### error(String message, Exception exception)
```
public final void error(String message, Exception exception)
```

Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error message. |
| exception | java.lang.Exception | The exception. |

##### trace(String message)
```
public final void trace(String message)
```

Writes trace message to the console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |

##### warning(String message)
```
public final void warning(String message)
```

Writes warning message to the console; Warning log messages provide information about the unexpected and recoverable event in application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning message. |

### ILogger
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.logging/ilogger.md

### LogLevel
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.logging/loglevel.md

**Inheritance:**
java.lang.Object
```
public final class LogLevel
```

Specifies the available Log Level types. This enumeration can be used as flags to set several possible values as enabled bits Example: LogLevel.Error | LogLevel.Warning or LogLevel.Error | LogLevel.Trace
#### Fields

| Field | Description |
| --- | --- |
| None | No logging limitation all information will be logged from trace, warning to errors |
| Error | No logging limitation all information will be logged from trace, warning to errors |
| Warning | Same as All level, all messages including the Trace level will be logged |
| Trace | The logging level to include messages from the Warning to Error level |
| All | All Log level events (Error, Warning, Trace) will be included into the logging |
##### None
```
public static final int None
```

No logging limitation all information will be logged from trace, warning to errors

##### Error
```
public static final int Error
```

No logging limitation all information will be logged from trace, warning to errors

##### Warning
```
public static final int Warning
```

Same as All level, all messages including the Trace level will be logged

##### Trace
```
public static final int Trace
```

The logging level to include messages from the Warning to Error level

##### All
```
public static final int All
```

All Log level events (Error, Warning, Trace) will be included into the logging

### com.groupdocs.signature.metered
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.metered.md

Provides methods to set metered key.

#### Classes

| Class | Description |
| --- | --- |
| Metered | Provides methods for applying  [Metered][]  license.[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered |

### Metered
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.metered/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying  [Metered][]  license.

[Metered]: https://purchase.groupdocs.com/faqs/licensing/metered
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/signaturejava/Evaluation+Limitations+and+Licensing+of+GroupDocs.Signature
#### 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 double 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:**
double
##### getConsumptionCredit()
```
public static double 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:**
double

### com.groupdocs.signature.options.appearances
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances.md

The **GroupDocs.Signature.Options.Appearances** namespace provides classes for additional signature appearances.

#### Classes

| Class | Description |
| --- | --- |
| DigitalSignatureAppearance | Describes appearance of Signature Line for Digital Signature. |
| ImageAppearance | Describes extended appearance features for Image Signature. |
| PdfDigitalSignatureAppearance | Describes appearance of Digital Signature are on PDF documents. |
| PdfTextAnnotationAppearance | Describes appearance of PDF text annotation object (Title, Subject, Content). |
| PdfTextStickerAppearance | Describes appearance of PDF text annotation sticker object and pop-up window of sticker. |
| SignatureAppearance | Represents the signature appearance - additional options for alternative implementations of sign on document page. |

### DigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/digitalsignatureappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class DigitalSignatureAppearance extends SignatureAppearance
```

Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats.
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignatureAppearance() | Creates Signature Line Appearance object. |
| DigitalSignatureAppearance(String signer, String title, String email) | Creates Signature Line Appearance with specified values (signer, title, email). |
#### Methods

| Method | Description |
| --- | --- |
| getSigner() | Gets or sets signer name for signature line. |
| setSigner(String value) | Gets or sets signer name for signature line. |
| getTitle() | Gets or sets a title for signature line. |
| setTitle(String value) | Gets or sets a title for signature line. |
| getEmail() | Gets or sets a email that will be displayed in signature line. |
| setEmail(String value) | Gets or sets a email that will be displayed in signature line. |
| toString() | Override string conversion. |
##### DigitalSignatureAppearance()
```
public DigitalSignatureAppearance()
```

Creates Signature Line Appearance object.

##### DigitalSignatureAppearance(String signer, String title, String email)
```
public DigitalSignatureAppearance(String signer, String title, String email)
```

Creates Signature Line Appearance with specified values (signer, title, email).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signer | java.lang.String | Signer name. |
| title | java.lang.String | Signature title. |
| email | java.lang.String | Author' email. |

##### getSigner()
```
public final String getSigner()
```

Gets or sets signer name for signature line.

**Returns:**
java.lang.String
##### setSigner(String value)
```
public final void setSigner(String value)
```

Gets or sets signer name for signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTitle()
```
public final String getTitle()
```

Gets or sets a title for signature line.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets a title for signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getEmail()
```
public final String getEmail()
```

Gets or sets a email that will be displayed in signature line.

**Returns:**
java.lang.String
##### setEmail(String value)
```
public final void setEmail(String value)
```

Gets or sets a email that will be displayed in signature line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### ImageAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/imageappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public class ImageAppearance extends SignatureAppearance
```

Describes extended appearance features for Image Signature.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageAppearance() | Create instance with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getGrayscale() | Setup this flag to true if gray-scale filter is required. |
| setGrayscale(boolean value) | Setup this flag to true if gray-scale filter is required. |
| getBrightness() | Gets or sets image brightness. |
| setBrightness(float value) | Gets or sets image brightness. |
| getContrast() | Gets or sets image contrast. |
| setContrast(float value) | Gets or sets image contrast. |
| getGammaCorrection() | Gets or sets image gamma. |
| setGammaCorrection(float value) | Gets or sets image gamma. |
##### ImageAppearance()
```
public ImageAppearance()
```

Create instance with default values.

##### getGrayscale()
```
public final boolean getGrayscale()
```

Setup this flag to true if gray-scale filter is required.

**Returns:**
boolean
##### setGrayscale(boolean value)
```
public final void setGrayscale(boolean value)
```

Setup this flag to true if gray-scale filter is required.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getBrightness()
```
public final float getBrightness()
```

Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.

**Returns:**
float
##### setBrightness(float value)
```
public final void setBrightness(float value)
```

Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getContrast()
```
public final float getContrast()
```

Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.

**Returns:**
float
##### setContrast(float value)
```
public final void setContrast(float value)
```

Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

##### getGammaCorrection()
```
public final float getGammaCorrection()
```

Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.

**Returns:**
float
##### setGammaCorrection(float value)
```
public final void setGammaCorrection(float value)
```

Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float |  |

### PdfDigitalSignatureAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/pdfdigitalsignatureappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class PdfDigitalSignatureAppearance extends SignatureAppearance
```

Describes appearance of Digital Signature are on PDF documents.

[Advanced signing document with Digital electronic signatures]: https://docs.groupdocs.com/signature/java/sign-document-with-digital-signature-advanced/
[Advanced electronic signatures properties]: https://docs.groupdocs.com/signature/java/sign-documents-with-extra-digital-signature-properties/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfDigitalSignatureAppearance() | Creates signature appearance object with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getContactInfoLabel() | Gets or sets contact info label. |
| setContactInfoLabel(String value) | Gets or sets contact info label. |
| getReasonLabel() | Gets or sets reason label. |
| setReasonLabel(String value) | Gets or sets reason label. |
| getLocationLabel() | Gets or sets location label. |
| setLocationLabel(String value) | Gets or sets location label. |
| getDigitalSignedLabel() | Gets or sets digital signed label. |
| setDigitalSignedLabel(String value) | Gets or sets digital signed label. |
| getDateSignedAtLabel() | Gets or sets date signed label. |
| setDateSignedAtLabel(String value) | Gets or sets date signed label. |
| getBackground() | Get or set background color of signature appearance. |
| setBackground(Color value) | Get or set background color of signature appearance. |
| setBackground(String value) | Get or set background color of signature appearance. |
| getFontFamilyName() | Gets or sets the Font family name to display the labels. |
| setFontFamilyName(String value) | Gets or sets the Font family name to display the labels. |
| getFontSize() | Gets or sets the Font size to display the labels. |
| setFontSize(double value) | Gets or sets the Font size to display the labels. |
| getForeground() | Get or set foreground text color of signature appearance. |
| setForeground(Color value) | Get or set foreground text color of signature appearance. |
| setForeground(String value) | Get or set foreground text color of signature appearance. |
##### PdfDigitalSignatureAppearance()
```
public PdfDigitalSignatureAppearance()
```

Creates signature appearance object with default values.

##### getContactInfoLabel()
```
public final String getContactInfoLabel()
```

Gets or sets contact info label. Default value: "Contact". if this value is empty then no contact label will appear on digital signature area.

**Returns:**
java.lang.String
##### setContactInfoLabel(String value)
```
public final void setContactInfoLabel(String value)
```

Gets or sets contact info label. Default value: "Contact". if this value is empty then no contact label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getReasonLabel()
```
public final String getReasonLabel()
```

Gets or sets reason label. Default value: "Reason". if this value is empty then no reason label will appear on digital signature area.

**Returns:**
java.lang.String
##### setReasonLabel(String value)
```
public final void setReasonLabel(String value)
```

Gets or sets reason label. Default value: "Reason". if this value is empty then no reason label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocationLabel()
```
public final String getLocationLabel()
```

Gets or sets location label. Default value: "Location". if this value is empty then no location label will appear on digital signature area.

**Returns:**
java.lang.String
##### setLocationLabel(String value)
```
public final void setLocationLabel(String value)
```

Gets or sets location label. Default value: "Location". if this value is empty then no location label will appear on digital signature area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDigitalSignedLabel()
```
public final String getDigitalSignedLabel()
```

Gets or sets digital signed label. Default value: "Digitally signed by".

**Returns:**
java.lang.String
##### setDigitalSignedLabel(String value)
```
public final void setDigitalSignedLabel(String value)
```

Gets or sets digital signed label. Default value: "Digitally signed by".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getDateSignedAtLabel()
```
public final String getDateSignedAtLabel()
```

Gets or sets date signed label. Default value: "Date".

**Returns:**
java.lang.String
##### setDateSignedAtLabel(String value)
```
public final void setDateSignedAtLabel(String value)
```

Gets or sets date signed label. Default value: "Date".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBackground()
```
public final Color getBackground()
```

Get or set background color of signature appearance. By default the value is SystemColors.Windows

**Returns:**
java.awt.Color
##### setBackground(Color value)
```
public final void setBackground(Color value)
```

Get or set background color of signature appearance. By default the value is SystemColors.Windows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setBackground(String value)
```
public final void setBackground(String value)
```

Get or set background color of signature appearance. By default the value is SystemColors.Windows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontFamilyName()
```
public final String getFontFamilyName()
```

Gets or sets the Font family name to display the labels. Default value is "Arial".

**Returns:**
java.lang.String
##### setFontFamilyName(String value)
```
public final void setFontFamilyName(String value)
```

Gets or sets the Font family name to display the labels. Default value is "Arial".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFontSize()
```
public final double getFontSize()
```

Gets or sets the Font size to display the labels. Default value is 10.

**Returns:**
double
##### setFontSize(double value)
```
public final void setFontSize(double value)
```

Gets or sets the Font size to display the labels. Default value is 10.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getForeground()
```
public final Color getForeground()
```

Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)

**Returns:**
java.awt.Color
##### setForeground(Color value)
```
public final void setForeground(Color value)
```

Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeground(String value)
```
public final void setForeground(String value)
```

Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### PdfTextAnnotationAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/pdftextannotationappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public class PdfTextAnnotationAppearance extends SignatureAppearance
```

Describes appearance of PDF text annotation object (Title, Subject, Content).
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextAnnotationAppearance() | Creates PDF signature txt annotation appearance object. |
| PdfTextAnnotationAppearance(String title, String subject, String contents) | Creates PDF signature txt annotation with specified values (title, subject, contents). |
#### Methods

| Method | Description |
| --- | --- |
| getContents() | Gets or sets content of annotation object. |
| setContents(String value) | Gets or sets content of annotation object. |
| getSubject() | Gets or sets Subject representing description of the object. |
| setSubject(String value) | Gets or sets Subject representing description of the object. |
| getTitle() | Gets or sets a Title that will be displayed in title bar of annotation object. |
| setTitle(String value) | Gets or sets a Title that will be displayed in title bar of annotation object. |
| getBorder() | Gets or sets different border settings |
| setBorder(Border value) | Gets or sets different border settings |
| getBorderEffect() | Gets or sets border effect. |
| setBorderEffect(int value) | Gets or sets border effect. |
| getBorderEffectIntensity() | Gets or sets border effect intensity. |
| setBorderEffectIntensity(int value) | Gets or sets border effect intensity. |
| getHCornerRadius() | Gets or sets horizontal corner radius. |
| setHCornerRadius(int value) | Gets or sets horizontal corner radius. |
| getVCornerRadius() | Gets or sets vertical corner radius. |
| setVCornerRadius(int value) | Gets or sets vertical corner radius. |
| toString() | Override string conversion. |
##### PdfTextAnnotationAppearance()
```
public PdfTextAnnotationAppearance()
```

Creates PDF signature txt annotation appearance object.

##### PdfTextAnnotationAppearance(String title, String subject, String contents)
```
public PdfTextAnnotationAppearance(String title, String subject, String contents)
```

Creates PDF signature txt annotation with specified values (title, subject, contents).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| title | java.lang.String | Title. |
| subject | java.lang.String | Subject. |
| contents | java.lang.String | Contents. |

##### getContents()
```
public final String getContents()
```

Gets or sets content of annotation object.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Gets or sets content of annotation object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Gets or sets Subject representing description of the object.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Gets or sets Subject representing description of the object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getTitle()
```
public final String getTitle()
```

Gets or sets a Title that will be displayed in title bar of annotation object.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets a Title that will be displayed in title bar of annotation object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getBorder()
```
public final Border getBorder()
```

Gets or sets different border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Gets or sets different border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getBorderEffect()
```
public final int getBorderEffect()
```

Gets or sets border effect.

**Returns:**
int
##### setBorderEffect(int value)
```
public final void setBorderEffect(int value)
```

Gets or sets border effect.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorderEffectIntensity()
```
public final int getBorderEffectIntensity()
```

Gets or sets border effect intensity. Valid range of value is [0..2].

**Returns:**
int
##### setBorderEffectIntensity(int value)
```
public final void setBorderEffectIntensity(int value)
```

Gets or sets border effect intensity. Valid range of value is [0..2].

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHCornerRadius()
```
public final int getHCornerRadius()
```

Gets or sets horizontal corner radius.

**Returns:**
int
##### setHCornerRadius(int value)
```
public final void setHCornerRadius(int value)
```

Gets or sets horizontal corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVCornerRadius()
```
public final int getVCornerRadius()
```

Gets or sets vertical corner radius.

**Returns:**
int
##### setVCornerRadius(int value)
```
public final void setVCornerRadius(int value)
```

Gets or sets vertical corner radius.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfTextStickerAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/pdftextstickerappearance.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.appearances.SignatureAppearance
```
public final class PdfTextStickerAppearance extends SignatureAppearance
```

Describes appearance of PDF text annotation sticker object and pop-up window of sticker.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextStickerAppearance() | Creates PDF signature text annotation appearance object. |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Gets or sets title of pop-up window. |
| setTitle(String value) | Gets or sets title of pop-up window. |
| getSubject() | Gets or sets subject. |
| setSubject(String value) | Gets or sets subject. |
| getContents() | Gets or sets the contents of pop-up window. |
| setContents(String value) | Gets or sets the contents of pop-up window. |
| getOpened() | Setup if sticker pop-up window will be opened by default. |
| setOpened(boolean value) | Setup if sticker pop-up window will be opened by default. |
| getIcon() | Gets or sets the icon of sticker. |
| setIcon(int value) | Gets or sets the icon of sticker. |
| getDefaultAppearance() | Gets default appearance for sticker. |
| resetDefaultAppearance() | Clears values of default appearance for sticker. |
| toString() | Override string conversion. |
##### PdfTextStickerAppearance()
```
public PdfTextStickerAppearance()
```

Creates PDF signature text annotation appearance object.

##### getTitle()
```
public final String getTitle()
```

Gets or sets title of pop-up window.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Gets or sets title of pop-up window.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Gets or sets subject.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Gets or sets subject.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Gets or sets the contents of pop-up window.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Gets or sets the contents of pop-up window.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getOpened()
```
public final boolean getOpened()
```

Setup if sticker pop-up window will be opened by default.

**Returns:**
boolean
##### setOpened(boolean value)
```
public final void setOpened(boolean value)
```

Setup if sticker pop-up window will be opened by default.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getIcon()
```
public final int getIcon()
```

Gets or sets the icon of sticker.

**Returns:**
int
##### setIcon(int value)
```
public final void setIcon(int value)
```

Gets or sets the icon of sticker.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDefaultAppearance()
```
public static PdfTextStickerAppearance getDefaultAppearance()
```

Gets default appearance for sticker. These properties are applied as default if Options.SignatureAppearance property is not specified. The properties could be changed by user any time.

**Returns:**
PdfTextStickerAppearance
##### resetDefaultAppearance()
```
public static void resetDefaultAppearance()
```

Clears values of default appearance for sticker.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### SignatureAppearance
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.appearances/signatureappearance.md

**Inheritance:**
java.lang.Object
```
public abstract class SignatureAppearance
```

Represents the signature appearance - additional options for alternative implementations of sign on document page.
#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureAppearance() | Initializes a new instance of the SignatureAppearance class. |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Override string conversion. |
##### SignatureAppearance()
```
public SignatureAppearance()
```

Initializes a new instance of the SignatureAppearance class.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.loadoptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.loadoptions.md

The **GroupDocs.Signature.Options.LoadOptions** namespace provides classes for working with LoadOptions options.

#### Classes

| Class | Description |
| --- | --- |
| LoadOptions | Allows to specify additional options (such as password) when opening a document to sign. |

### LoadOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.loadoptions/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Allows to specify additional options (such as password) when opening a document to sign.
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of LoadOptions class. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets or sets password to open a protected document. |
| setPassword(String value) | Gets or sets password to open a protected document. |
| getLoadExternalResources() | Gets or sets options that specifies if external document resources should be loaded. |
| setLoadExternalResources(boolean value) | Gets or sets options that specifies if external document resources should be loaded. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of LoadOptions class.

##### getPassword()
```
public final String getPassword()
```

Gets or sets password to open a protected document. It will be also used to save signed document as protected.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets password to open a protected document. It will be also used to save signed document as protected.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLoadExternalResources()
```
public final boolean getLoadExternalResources()
```

Gets or sets options that specifies if external document resources should be loaded. This option with disabled value (false) allows to save loading time for the documents with many or large external resource links. By default value is enabled (true).

**Returns:**
boolean
##### setLoadExternalResources(boolean value)
```
public final void setLoadExternalResources(boolean value)
```

Gets or sets options that specifies if external document resources should be loaded. This option with disabled value (false) allows to save loading time for the documents with many or large external resource links. By default value is enabled (true).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### com.groupdocs.signature.options.preview
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.preview.md

#### Classes

| Class | Description |
| --- | --- |
| PreviewFormats | Document preview supported formats |
| PreviewOptions | Represents document preview options. |
| PreviewPageData | Contains data about document page to be saved as preview image. |

### PreviewFormats
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.preview/previewformats.md

**Inheritance:**
java.lang.Object
```
public class PreviewFormats
```

Document preview supported formats
#### Fields

| Field | Description |
| --- | --- |
| PNG | PNG |
| JPEG | JPEG |
| BMP | BMP |
#### Methods

| Method | Description |
| --- | --- |
| toExtension(int id) | To extension string. |
##### PNG
```
public static final int PNG
```

PNG

##### JPEG
```
public static final int JPEG
```

JPEG

##### BMP
```
public static final int BMP
```

BMP

##### toExtension(int id)
```
public static String toExtension(int id)
```

To extension string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int |  |

**Returns:**
java.lang.String - the string

### PreviewOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.preview/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Represents document preview options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers) | Initializes PreviewOptions object. |
| PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers) | Initializes PreviewOptions object. |
| PreviewOptions(String filePathFormat, int[] pageNumbers) | Initializes PreviewOptions object. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets or sets preview images width. |
| setWidth(int value) | Gets or sets preview images width. |
| getHeight() | Gets or sets preview images height. |
| setHeight(int value) | Gets or sets preview images height. |
| getPageNumbers() | Gets or sets preview images page numbers. |
| setPageNumbers(int[] value) | Gets or sets preview images page numbers. |
| getPreviewFormat() | Gets or sets preview images format. |
| setPreviewFormat(int value) | Gets or sets preview images format. |
| getHideSignatures() | Gets or sets flag to hide signatures from page preview image. |
| setHideSignatures(boolean value) | Gets or sets flag to hide signatures from page preview image. |
##### PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)
```
public PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | Interface which defines method to create output page preview stream. |
| pageNumbers | int[] | Desired page numbers |

##### PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)
```
public PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageDataStreamFactory | PageDataStreamFactory | Interface which defines method to create output page preview stream. |
| pageNumbers | int[] |  |

##### PreviewOptions(String filePathFormat, int[] pageNumbers)
```
public PreviewOptions(String filePathFormat, int[] pageNumbers)
```

Initializes PreviewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | Path to output file. |
| pageNumbers | int[] | Desired page numbers |

##### getWidth()
```
public final int getWidth()
```

Gets or sets preview images width.

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Gets or sets preview images width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Gets or sets preview images height.

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Gets or sets preview images height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets or sets preview images page numbers.

**Returns:**
int[]
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Gets or sets preview images page numbers.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] |  |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Gets or sets preview images format.

**Returns:**
int
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Gets or sets preview images format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHideSignatures()
```
public final boolean getHideSignatures()
```

Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

**Returns:**
boolean
##### setHideSignatures(boolean value)
```
public final void setHideSignatures(boolean value)
```

Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### PreviewPageData
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.preview/previewpagedata.md

**Inheritance:**
java.lang.Object
```
public final class PreviewPageData
```

Contains data about document page to be saved as preview image.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewPageData() | Creates PreviewPageData with default parameters. |
#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Name of a file which is being processed in order to get page previews. |
| getPageNumber() | Document page number of current preview. |
| getPreviewFormat() | Selected preview format. |
| toString() | Textual representation of PreviewPageData instance. |
##### PreviewPageData()
```
public PreviewPageData()
```

Creates PreviewPageData with default parameters.

##### getFileName()
```
public final String getFileName()
```

Name of a file which is being processed in order to get page previews.

**Returns:**
java.lang.String
##### getPageNumber()
```
public final int getPageNumber()
```

Document page number of current preview.

**Returns:**
int
##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Selected preview format.

**Returns:**
int
##### toString()
```
public String toString()
```

Textual representation of PreviewPageData instance.

**Returns:**
java.lang.String - Returns textual representation of PreviewPageData instance.

### com.groupdocs.signature.options.saveoptions.imagessaveoptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions.md

The **GroupDocs.Signature.Options.SaveOptions.ImageSaveOptions** namespace provides classes for working with ImageSaveOptions options.

#### Classes

| Class | Description |
| --- | --- |
| BitmapCompression | Specifies different bitmap compression methods. |
| BmpSaveOptions | Bmp Save options for image documents. |
| DicomSaveOptions | Save options for DICOM image documents. |
| DicomXmpEntry | Entry of XMP data for DICOM images (.dcm). |
| DicomXmpType | Supported types of XMP data for DICOM images (.dcm). |
| GifSaveOptions | Gif format save options for Image Documents. |
| JpegCompressionColorMode | Specifies JPEG color compression modes. |
| JpegCompressionMode | Specifies JPEG compression modes. |
| JpegRoundingMode | Specifies different JPEG rounding modes. |
| JpegSaveOptions | Jpeg Save options for Image Documents. |
| PngColorType | Represents the PNG image color type. |
| PngFilterType | Represents PNG image filter type. |
| PngSaveOptions | Png Save options for Image Documents. |
| TiffFormat | Specifies different tiff formats. |
| TiffSaveOptions | Tiff Save options for Image Documents. |

### BitmapCompression
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/bitmapcompression.md

**Inheritance:**
java.lang.Object
```
public final class BitmapCompression
```

Specifies different bitmap compression methods.
#### Fields

| Field | Description |
| --- | --- |
| Rgb | No compression. |
| Rle8 | RLE 8-bit/pixel compression. |
| Rle4 | RLE 4-bit/pixel compression. |
| Bitfields | Bit fields. |
| Jpeg | JPEG compression. |
| Png | PNG compression. |
##### Rgb
```
public static final int Rgb
```

No compression.

##### Rle8
```
public static final int Rle8
```

RLE 8-bit/pixel compression. Can be used only with 8-bit/pixel bitmaps.

##### Rle4
```
public static final int Rle4
```

RLE 4-bit/pixel compression. Can be used only with 4-bit/pixel bitmaps.

##### Bitfields
```
public static final int Bitfields
```

Bit fields. Can be used only with 16 and 32-bit/pixel bitmaps.

##### Jpeg
```
public static final int Jpeg
```

JPEG compression. The bitmap contains a JPEG image.

##### Png
```
public static final int Png
```

PNG compression. The bitmap contains a PNG image.

### BmpSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/bmpsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public final class BmpSaveOptions extends ImageSaveOptions
```

Bmp Save options for image documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| BmpSaveOptions() | Creates BmpSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerPixel() | Gets or sets the image bits per pixel count. |
| setBitsPerPixel(int value) | Gets or sets the image bits per pixel count. |
| getCompression() | Gets or sets the compression. |
| setCompression(int value) | Gets or sets the compression. |
| getHorizontalResolution() | Gets or sets the horizontal resolution. |
| setHorizontalResolution(double value) | Gets or sets the horizontal resolution. |
| getVerticalResolution() | Gets or sets the vertical resolution. |
| setVerticalResolution(double value) | Gets or sets the vertical resolution. |
##### BmpSaveOptions()
```
public BmpSaveOptions()
```

Creates BmpSaveOptions with default values.

##### getBitsPerPixel()
```
public final int getBitsPerPixel()
```

Gets or sets the image bits per pixel count.

**Returns:**
int
##### setBitsPerPixel(int value)
```
public final void setBitsPerPixel(int value)
```

Gets or sets the image bits per pixel count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCompression()
```
public final int getCompression()
```

Gets or sets the compression. See BitmapCompression.

**Returns:**
int
##### setCompression(int value)
```
public final void setCompression(int value)
```

Gets or sets the compression. See BitmapCompression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalResolution()
```
public final double getHorizontalResolution()
```

Gets or sets the horizontal resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

**Returns:**
double
##### setHorizontalResolution(double value)
```
public final void setHorizontalResolution(double value)
```

Gets or sets the horizontal resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getVerticalResolution()
```
public final double getVerticalResolution()
```

Gets or sets the vertical resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

**Returns:**
double
##### setVerticalResolution(double value)
```
public final void setVerticalResolution(double value)
```

Gets or sets the vertical resolution. Note due to the rounding the resulting resolution may slightly differ from the passed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

### DicomSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public final class DicomSaveOptions extends ImageSaveOptions
```

Save options for DICOM image documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| DicomSaveOptions() | Creates DicomSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getXmpEntries() | XMP data for DICOM. |
| setXmpEntries(List<DicomXmpEntry> value) | XMP data for DICOM. |
##### DicomSaveOptions()
```
public DicomSaveOptions()
```

Creates DicomSaveOptions with default values.

##### getXmpEntries()
```
public final List<DicomXmpEntry> getXmpEntries()
```

XMP data for DICOM. Use it for setting image metadata.

**Returns:**
java.util.List<com.groupdocs.signature.options.saveoptions.imagessaveoptions.DicomXmpEntry>
##### setXmpEntries(List<DicomXmpEntry> value)
```
public final void setXmpEntries(List<DicomXmpEntry> value)
```

XMP data for DICOM. Use it for setting image metadata.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.options.saveoptions.imagessaveoptions.DicomXmpEntry> |  |

### DicomXmpEntry
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomxmpentry.md

**Inheritance:**
java.lang.Object
```
public final class DicomXmpEntry
```

Entry of XMP data for DICOM images (.dcm).
#### Constructors

| Constructor | Description |
| --- | --- |
| DicomXmpEntry(int type, String value) | Creates Xmp entry for DICOM image. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Entry type. |
| getValue() | Entry value. |
| toString() | Get Xmp entry textual representation. |
##### DicomXmpEntry(int type, String value)
```
public DicomXmpEntry(int type, String value)
```

Creates Xmp entry for DICOM image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | int | Entry type |
| value | java.lang.String | Entry value |

##### getType()
```
public final int getType()
```

Entry type.

**Returns:**
int
##### getValue()
```
public final String getValue()
```

Entry value.

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Get Xmp entry textual representation.

**Returns:**
java.lang.String - Xmp entry textual representation.

### DicomXmpType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/dicomxmptype.md

**Inheritance:**
java.lang.Object
```
public final class DicomXmpType
```

Supported types of XMP data for DICOM images (.dcm).
#### Fields

| Field | Description |
| --- | --- |
| EquipmentInstitution | Institution of equipment. |
| EquipmentManufacturer | Manufacturer of equipment. |
| PatientBirthDate | Patient's birthday. |
| PatientId | Patient's Id. |
| PatientName | Patient's name. |
| PatientSex | Patient's sex. |
| SeriesDateTime | Series date and time. |
| SeriesDescription | Series description. |
| SeriesModality | Series modality. |
| SeriesNumber | Series number. |
| StudyDateTime | Study date and time. |
| StudyDescription | Study description. |
| StudyId | Study Id. |
| StudyPhysician | Study physician. |
##### EquipmentInstitution
```
public static final int EquipmentInstitution
```

Institution of equipment.

##### EquipmentManufacturer
```
public static final int EquipmentManufacturer
```

Manufacturer of equipment.

##### PatientBirthDate
```
public static final int PatientBirthDate
```

Patient's birthday.

##### PatientId
```
public static final int PatientId
```

Patient's Id.

##### PatientName
```
public static final int PatientName
```

Patient's name.

##### PatientSex
```
public static final int PatientSex
```

Patient's sex.

##### SeriesDateTime
```
public static final int SeriesDateTime
```

Series date and time.

##### SeriesDescription
```
public static final int SeriesDescription
```

Series description.

##### SeriesModality
```
public static final int SeriesModality
```

Series modality.

##### SeriesNumber
```
public static final int SeriesNumber
```

Series number.

##### StudyDateTime
```
public static final int StudyDateTime
```

Study date and time.

##### StudyDescription
```
public static final int StudyDescription
```

Study description.

##### StudyId
```
public static final int StudyId
```

Study Id.

##### StudyPhysician
```
public static final int StudyPhysician
```

Study physician.

### GifSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/gifsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class GifSaveOptions extends ImageSaveOptions
```

Gif format save options for Image Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| GifSaveOptions() | Creates GifSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getBackgroundColorIndex() | Gets or sets the GIF background color index. |
| setBackgroundColorIndex(byte value) | Gets or sets the GIF background color index. |
| getColorResolution() | Gets or sets the GIF color resolution. |
| setColorResolution(byte value) | Gets or sets the GIF color resolution. |
| getDoPaletteCorrection() | Gets or sets a value indicating whether palette correction is applied. |
| setDoPaletteCorrection(boolean value) | Gets or sets a value indicating whether palette correction is applied. |
| hasTrailer() | Gets or sets a value indicating whether GIF has trailer. |
| setTrailer(boolean value) | Gets or sets a value indicating whether GIF has trailer. |
| getInterlaced() | True if image should be interlaced. |
| setInterlaced(boolean value) | True if image should be interlaced. |
| isPaletteSorted() | Gets or sets a value indicating whether palette entries are sorted. |
| setPaletteSorted(boolean value) | Gets or sets a value indicating whether palette entries are sorted. |
| getPixelAspectRatio() | Gets or sets the GIF pixel aspect ratio. |
| setPixelAspectRatio(byte value) | Gets or sets the GIF pixel aspect ratio. |
##### GifSaveOptions()
```
public GifSaveOptions()
```

Creates GifSaveOptions with default values.

##### getBackgroundColorIndex()
```
public byte getBackgroundColorIndex()
```

Gets or sets the GIF background color index.

**Returns:**
byte
##### setBackgroundColorIndex(byte value)
```
public void setBackgroundColorIndex(byte value)
```

Gets or sets the GIF background color index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorResolution()
```
public byte getColorResolution()
```

Gets or sets the GIF color resolution.

Color Resolution - Number of bits per primary color available to the original image, minus 1. This value represents the size of the entire palette from which the colors in the graphic were selected, not the number of colors actually used in the graphic. For example, if the value in this field is 3, then the palette of the original image had 4 bits per primary color available to create the image. This value should be set to indicate the richness of the original palette, even if not every color from the whole palette is available on the source machine.

**Returns:**
byte
##### setColorResolution(byte value)
```
public void setColorResolution(byte value)
```

Gets or sets the GIF color resolution.

Color Resolution - Number of bits per primary color available to the original image, minus 1. This value represents the size of the entire palette from which the colors in the graphic were selected, not the number of colors actually used in the graphic. For example, if the value in this field is 3, then the palette of the original image had 4 bits per primary color available to create the image. This value should be set to indicate the richness of the original palette, even if not every color from the whole palette is available on the source machine.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getDoPaletteCorrection()
```
public boolean getDoPaletteCorrection()
```

Gets or sets a value indicating whether palette correction is applied.

Palette correction means that whenever image is exported to GIF the source image colors will be analyzed in order to build the best matching palette (in case image Palette does not exist or not specified in the options). The analyze process takes some time however the output image will have the best matching color palette and result is visually better.

**Returns:**
boolean
##### setDoPaletteCorrection(boolean value)
```
public void setDoPaletteCorrection(boolean value)
```

Gets or sets a value indicating whether palette correction is applied.

Palette correction means that whenever image is exported to GIF the source image colors will be analyzed in order to build the best matching palette (in case image Palette does not exist or not specified in the options). The analyze process takes some time however the output image will have the best matching color palette and result is visually better.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### hasTrailer()
```
public boolean hasTrailer()
```

Gets or sets a value indicating whether GIF has trailer.

**Returns:**
boolean
##### setTrailer(boolean value)
```
public void setTrailer(boolean value)
```

Gets or sets a value indicating whether GIF has trailer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getInterlaced()
```
public boolean getInterlaced()
```

True if image should be interlaced.

**Returns:**
boolean
##### setInterlaced(boolean value)
```
public void setInterlaced(boolean value)
```

True if image should be interlaced.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### isPaletteSorted()
```
public boolean isPaletteSorted()
```

Gets or sets a value indicating whether palette entries are sorted.

**Returns:**
boolean
##### setPaletteSorted(boolean value)
```
public void setPaletteSorted(boolean value)
```

Gets or sets a value indicating whether palette entries are sorted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPixelAspectRatio()
```
public byte getPixelAspectRatio()
```

Gets or sets the GIF pixel aspect ratio.

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect ratio of the pixel in the original image. If the value of the field is not 0, this approximation of the aspect ratio is computed based on the formula: Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined to be the quotient of the pixel's width over its height. The value range in this field allows specification of the widest pixel of 4:1 to the tallest pixel of 1:4 in increments of 1/64th. Values : 0 - No aspect ratio information is given. 1..255 - Value used in the computation.

**Returns:**
byte
##### setPixelAspectRatio(byte value)
```
public void setPixelAspectRatio(byte value)
```

Gets or sets the GIF pixel aspect ratio.

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect ratio of the pixel in the original image. If the value of the field is not 0, this approximation of the aspect ratio is computed based on the formula: Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined to be the quotient of the pixel's width over its height. The value range in this field allows specification of the widest pixel of 4:1 to the tallest pixel of 1:4 in increments of 1/64th. Values : 0 - No aspect ratio information is given. 1..255 - Value used in the computation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

### JpegCompressionColorMode
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegcompressioncolormode.md

**Inheritance:**
java.lang.Object
```
public final class JpegCompressionColorMode
```

Specifies JPEG color compression modes.
#### Fields

| Field | Description |
| --- | --- |
| Grayscale | The Grayscale image. |
| YCbCr | YCbCr image, standard option for jpeg images. |
| Cmyk | 4-component CMYK image. |
| Ycck | The ycck color jpeg image. |
| Rgb | The RGB Color mode. |
##### Grayscale
```
public static final int Grayscale
```

The Grayscale image.

##### YCbCr
```
public static final int YCbCr
```

YCbCr image, standard option for jpeg images.

##### Cmyk
```
public static final int Cmyk
```

4-component CMYK image.

##### Ycck
```
public static final int Ycck
```

The ycck color jpeg image. Needs icc profile for saving.

##### Rgb
```
public static final int Rgb
```

The RGB Color mode.

### JpegCompressionMode
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegcompressionmode.md

**Inheritance:**
java.lang.Object
```
public final class JpegCompressionMode
```

Specifies JPEG compression modes.
#### Fields

| Field | Description |
| --- | --- |
| Baseline | The baseline compression. |
| Progressive | The progressive compression. |
| Lossless | The lossless compression. |
| JpegLs | The JPEG-LS compression. |
##### Baseline
```
public static final int Baseline
```

The baseline compression.

##### Progressive
```
public static final int Progressive
```

The progressive compression.

##### Lossless
```
public static final int Lossless
```

The lossless compression. Use this compression type carefully because many image viewers do not support it. If you use it try assign the  JpegSaveOptions.ColorType (JpegSaveOptions.getColorType/JpegSaveOptions.setColorType(int)) property to JpegCompressionColorMode.Grayscale or JpegCompressionColorMode.Rgb values.

##### JpegLs
```
public static final int JpegLs
```

The JPEG-LS compression. Use this compression type carefully because many image viewers do not support it. If you use it try to assign the  JpegSaveOptions.ColorType (JpegSaveOptions.getColorType/JpegSaveOptions.setColorType(int)) property to JpegCompressionColorMode.Grayscale value.

### JpegRoundingMode
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegroundingmode.md

**Inheritance:**
java.lang.Object
```
public final class JpegRoundingMode
```

Specifies different JPEG rounding modes.
#### Fields

| Field | Description |
| --- | --- |
| Extrapolate | Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8. |
| Truncate | Truncate an 8-bit value to fit it into n bits, where n more than 1 and less 8. |
##### Extrapolate
```
public static final int Extrapolate
```

Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8.

##### Truncate
```
public static final int Truncate
```

Truncate an 8-bit value to fit it into n bits, where n more than 1 and less 8.

### JpegSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/jpegsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class JpegSaveOptions extends ImageSaveOptions
```

Jpeg Save options for Image Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| JpegSaveOptions() | Creates JpegSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getBitsPerChannel() | Gets or sets bits per channel for lossless jpeg image. |
| setBitsPerChannel(byte value) | Gets or sets bits per channel for lossless jpeg image. |
| getColorType() | Gets or sets the color type for jpeg image. |
| setColorType(int value) | Gets or sets the color type for jpeg image. |
| getComment() | Gets or sets the jpeg file comment. |
| setComment(String value) | Gets or sets the jpeg file comment. |
| getCompressionType() | Gets or sets the compression type. |
| setCompressionType(int value) | Gets or sets the compression type. |
| getQuality() | Gets or sets image quality. |
| setQuality(int value) | Gets or sets image quality. |
| getSampleRoundingMode() | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel. |
| setSampleRoundingMode(int value) | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel. |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
##### JpegSaveOptions()
```
public JpegSaveOptions()
```

Creates JpegSaveOptions with default values.

##### getBitsPerChannel()
```
public byte getBitsPerChannel()
```

Gets or sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.

**Returns:**
byte
##### setBitsPerChannel(byte value)
```
public void setBitsPerChannel(byte value)
```

Gets or sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorType()
```
public int getColorType()
```

Gets or sets the color type for jpeg image.

**Returns:**
int
##### setColorType(int value)
```
public void setColorType(int value)
```

Gets or sets the color type for jpeg image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getComment()
```
public String getComment()
```

Gets or sets the jpeg file comment.

**Returns:**
java.lang.String
##### setComment(String value)
```
public void setComment(String value)
```

Gets or sets the jpeg file comment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCompressionType()
```
public int getCompressionType()
```

Gets or sets the compression type.

**Returns:**
int
##### setCompressionType(int value)
```
public void setCompressionType(int value)
```

Gets or sets the compression type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getQuality()
```
public int getQuality()
```

Gets or sets image quality.

**Returns:**
int
##### setQuality(int value)
```
public void setQuality(int value)
```

Gets or sets image quality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSampleRoundingMode()
```
public int getSampleRoundingMode()
```

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel.

**Returns:**
int
##### setSampleRoundingMode(int value)
```
public void setSampleRoundingMode(int value)
```

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value JpegOptions.BitsPerChannel.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### PngColorType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngcolortype.md

**Inheritance:**
java.lang.Object
```
public final class PngColorType
```

Represents the PNG image color type.
#### Fields

| Field | Description |
| --- | --- |
| Grayscale | Represents the color type where each pixel is a grayscale sample. |
| Truecolor | Represents the color type where each pixel is an R,G,B triple. |
| IndexedColor | Represents the color type where each pixel is a palette index; a PLTE chunk shall appear. |
| GrayscaleWithAlpha | Represents the color type where each pixel is a grayscale sample followed by an alpha sample. |
| TruecolorWithAlpha | Represents the color type where each pixel is an R,G,B triple followed by an alpha sample. |
##### Grayscale
```
public static final int Grayscale
```

Represents the color type where each pixel is a grayscale sample.

##### Truecolor
```
public static final int Truecolor
```

Represents the color type where each pixel is an R,G,B triple.

##### IndexedColor
```
public static final int IndexedColor
```

Represents the color type where each pixel is a palette index; a PLTE chunk shall appear.

##### GrayscaleWithAlpha
```
public static final int GrayscaleWithAlpha
```

Represents the color type where each pixel is a grayscale sample followed by an alpha sample.

##### TruecolorWithAlpha
```
public static final int TruecolorWithAlpha
```

Represents the color type where each pixel is an R,G,B triple followed by an alpha sample.

### PngFilterType
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngfiltertype.md

**Inheritance:**
java.lang.Object
```
public final class PngFilterType
```

Represents PNG image filter type.
#### Fields

| Field | Description |
| --- | --- |
| None | The null-filter, means no filtering for image data rows. |
| Sub | The sub filter, means subtractive filtering will be applied to image data. |
| Up | The up filter, means row-by-row subtraction filter will be applied. |
| Avg | The avg filter, means, that average filter will be applied to image data. |
| Paeth | The path predictor filter. |
| Adaptive | Adaptive filtering, means that saving process will choose most suitable filter for each data row. |
##### None
```
public static final int None
```

The null-filter, means no filtering for image data rows.

##### Sub
```
public static final int Sub
```

The sub filter, means subtractive filtering will be applied to image data.

##### Up
```
public static final int Up
```

The up filter, means row-by-row subtraction filter will be applied.

##### Avg
```
public static final int Avg
```

The avg filter, means, that average filter will be applied to image data.

##### Paeth
```
public static final int Paeth
```

The path predictor filter.

##### Adaptive
```
public static final int Adaptive
```

Adaptive filtering, means that saving process will choose most suitable filter for each data row. Best compression, slowest execution time.

### PngSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/pngsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class PngSaveOptions extends ImageSaveOptions
```

Png Save options for Image Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PngSaveOptions() | Creates PngSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getBitDepth() | The bit depth. |
| setBitDepth(byte value) | The bit depth. |
| getColorType() | Gets or sets the type of the  PngColorType . |
| setColorType(int value) | Gets or sets the type of the  PngColorType . |
| getCompressionLevel() | The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
| setCompressionLevel(int value) | The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
| getFilterType() | Gets or sets the filter type  PngFilterType  used during png file save process. |
| setFilterType(int value) | Gets or sets the filter type  PngFilterType  used during png file save process. |
| getProgressive() | Gets or sets a value indicating whether this PngSaveOptions is progressive. |
| setProgressive(boolean value) | Gets or sets a value indicating whether this PngSaveOptions is progressive. |
##### PngSaveOptions()
```
public PngSaveOptions()
```

Creates PngSaveOptions with default values.

##### getBitDepth()
```
public byte getBitDepth()
```

The bit depth.

**Returns:**
byte
##### setBitDepth(byte value)
```
public void setBitDepth(byte value)
```

The bit depth.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte |  |

##### getColorType()
```
public int getColorType()
```

Gets or sets the type of the  PngColorType .

**Returns:**
int
##### setColorType(int value)
```
public void setColorType(int value)
```

Gets or sets the type of the  PngColorType .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getCompressionLevel()
```
public int getCompressionLevel()
```

The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.

**Returns:**
int
##### setCompressionLevel(int value)
```
public void setCompressionLevel(int value)
```

The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFilterType()
```
public int getFilterType()
```

Gets or sets the filter type  PngFilterType  used during png file save process.

**Returns:**
int
##### setFilterType(int value)
```
public void setFilterType(int value)
```

Gets or sets the filter type  PngFilterType  used during png file save process.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getProgressive()
```
public boolean getProgressive()
```

Gets or sets a value indicating whether this PngSaveOptions is progressive.

**Returns:**
boolean
##### setProgressive(boolean value)
```
public void setProgressive(boolean value)
```

Gets or sets a value indicating whether this PngSaveOptions is progressive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### TiffFormat
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/tiffformat.md

**Inheritance:**
java.lang.Object
```
public final class TiffFormat
```

Specifies different tiff formats.
#### Fields

| Field | Description |
| --- | --- |
| Default | Default. |
| TiffLzwBw | LzwBw. |
| TiffLzwRgb | LzwRgb. |
| TiffLzwRgba | LzwRgba. |
| TiffCcittFax3 | CcittFax3. |
| TiffCcittFax4 | CcittFax4. |
| TiffDeflateBw | DeflateBw. |
| TiffDeflateRgb | DeflateRgb. |
| TiffCcitRle | CcitRle. |
| TiffJpegRgb | JpegRgb. |
| TiffJpegYCbCr | JpegYCbCr. |
| TiffNoCompressionBw | NoCompressionBw. |
| TiffNoCompressionRgb | NoCompressionRgb. |
| TiffNoCompressionRgba | NoCompressionRgba. |
##### Default
```
public static final int Default
```

Default.

##### TiffLzwBw
```
public static final int TiffLzwBw
```

LzwBw.

##### TiffLzwRgb
```
public static final int TiffLzwRgb
```

LzwRgb.

##### TiffLzwRgba
```
public static final int TiffLzwRgba
```

LzwRgba.

##### TiffCcittFax3
```
public static final int TiffCcittFax3
```

CcittFax3.

##### TiffCcittFax4
```
public static final int TiffCcittFax4
```

CcittFax4.

##### TiffDeflateBw
```
public static final int TiffDeflateBw
```

DeflateBw.

##### TiffDeflateRgb
```
public static final int TiffDeflateRgb
```

DeflateRgb.

##### TiffCcitRle
```
public static final int TiffCcitRle
```

CcitRle.

##### TiffJpegRgb
```
public static final int TiffJpegRgb
```

JpegRgb.

##### TiffJpegYCbCr
```
public static final int TiffJpegYCbCr
```

JpegYCbCr.

##### TiffNoCompressionBw
```
public static final int TiffNoCompressionBw
```

NoCompressionBw.

##### TiffNoCompressionRgb
```
public static final int TiffNoCompressionRgb
```

NoCompressionRgb.

##### TiffNoCompressionRgba
```
public static final int TiffNoCompressionRgba
```

NoCompressionRgba.

### TiffSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.imagessaveoptions/tiffsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class TiffSaveOptions extends ImageSaveOptions
```

Tiff Save options for Image Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffSaveOptions() | Creates TiffSaveOptions with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getExpectedTiffFormat() | Gets or sets TIFF format of signed document. |
| setExpectedTiffFormat(int value) | Gets or sets TIFF format of signed document. |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
##### TiffSaveOptions()
```
public TiffSaveOptions()
```

Creates TiffSaveOptions with default values.

##### getExpectedTiffFormat()
```
public int getExpectedTiffFormat()
```

Gets or sets TIFF format of signed document.

**Returns:**
int
##### setExpectedTiffFormat(int value)
```
public void setExpectedTiffFormat(int value)
```

Gets or sets TIFF format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document. Hidden because not in use for this options class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.signature.options.saveoptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions.md

The **GroupDocs.Signature.Options.SaveOptions** namespace provides classes for working with SaveOptions options.

#### Classes

| Class | Description |
| --- | --- |
| ExportImageSaveOptions | Save options for exporting documents to image. |
| PdfSaveOptions | Save options for PDF documents. |
| PresentationSaveOptions | Save options for Presentation documents. |
| SaveOptions | Allows to specify additional options (such as password) when saving a document to sign. |
| SpreadsheetSaveOptions | Save options for Spreadsheet Documents. |
| WordProcessingSaveOptions | Save options for WordProcessing documents. |

### ExportImageSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/exportimagesaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
```
public class ExportImageSaveOptions extends ImageSaveOptions
```

Save options for exporting documents to image.
#### Constructors

| Constructor | Description |
| --- | --- |
| ExportImageSaveOptions() | Initializes a new instance of ExportAsImageSaveOptions class with default values. |
| ExportImageSaveOptions(int fileFormat) | Initializes a new instance of ExportAsImageSaveOptions class with specified file format. |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets document page number for export. |
| setPageNumber(Integer value) | Gets or sets document page number for export. |
| getExportAllPages() | Flag to export each page. |
| setExportAllPages(boolean value) | Flag to export each page. |
| getPagesSetup() | Options to specify pages to be signed. |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed. |
| getPageColumns() | Gets or sets number of columns for exported images. |
| setPageColumns(int value) | Gets or sets number of columns for exported images. |
| getBorder() | Gets or sets the image border settings. |
| setBorder(Border value) | Gets or sets the image border settings. |
| getTiffMultipage() | Put document pages on different frames in Tiff image. |
| setTiffMultipage(boolean value) | Put document pages on different frames in Tiff image. |
| toString() | Override string conversion. |
##### ExportImageSaveOptions()
```
public ExportImageSaveOptions()
```

Initializes a new instance of ExportAsImageSaveOptions class with default values.

##### ExportImageSaveOptions(int fileFormat)
```
public ExportImageSaveOptions(int fileFormat)
```

Initializes a new instance of ExportAsImageSaveOptions class with specified file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output image file format. |

##### getPageNumber()
```
public final Integer getPageNumber()
```

Gets or sets document page number for export. Minimal value is 1.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Gets or sets document page number for export. Minimal value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getExportAllPages()
```
public final boolean getExportAllPages()
```

Flag to export each page.

**Returns:**
boolean
##### setExportAllPages(boolean value)
```
public final void setExportAllPages(boolean value)
```

Flag to export each page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPagesSetup()
```
public final PagesSetup getPagesSetup()
```

Options to specify pages to be signed.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public final void setPagesSetup(PagesSetup value)
```

Options to specify pages to be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getPageColumns()
```
public final int getPageColumns()
```

Gets or sets number of columns for exported images. Use this property if you need put images in a row.

**Returns:**
int
##### setPageColumns(int value)
```
public final void setPageColumns(int value)
```

Gets or sets number of columns for exported images. Use this property if you need put images in a row.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorder()
```
public final Border getBorder()
```

Gets or sets the image border settings. By default this value is not set.

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Gets or sets the image border settings. By default this value is not set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getTiffMultipage()
```
public final boolean getTiffMultipage()
```

Put document pages on different frames in Tiff image.

**Returns:**
boolean
##### setTiffMultipage(boolean value)
```
public final void setTiffMultipage(boolean value)
```

Put document pages on different frames in Tiff image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/pdfsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class PdfSaveOptions extends SaveOptions
```

Save options for PDF documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of PdfSaveOptions class with default values. |
| PdfSaveOptions(int fileFormat) | Initializes a new instance of PdfSaveOptions class with specified output file format. |
| PdfSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with overwrite flag. |
| PdfSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
| toString() | Override string conversion. |
##### PdfSaveOptions()
```
public PdfSaveOptions()
```

Initializes a new instance of PdfSaveOptions class with default values.

##### PdfSaveOptions(int fileFormat)
```
public PdfSaveOptions(int fileFormat)
```

Initializes a new instance of PdfSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PdfSaveFileFormat. |

##### PdfSaveOptions(boolean overwriteExistingFile)
```
public PdfSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of PdfSaveOptions class with overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PdfSaveFileFormat. |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PresentationSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/presentationsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class PresentationSaveOptions extends SaveOptions
```

Save options for Presentation documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationSaveOptions() | Initializes a new instance of PresentationSaveOptions class with default values. |
| PresentationSaveOptions(int fileFormat) | Initializes a new instance of PresentationSaveOptions class with specified output file format. |
| PresentationSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag. |
| PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
| toString() | Override string conversion. |
##### PresentationSaveOptions()
```
public PresentationSaveOptions()
```

Initializes a new instance of PresentationSaveOptions class with default values.

##### PresentationSaveOptions(int fileFormat)
```
public PresentationSaveOptions(int fileFormat)
```

Initializes a new instance of PresentationSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PresentationSaveFileFormat. |

##### PresentationSaveOptions(boolean overwriteExistingFile)
```
public PresentationSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public PresentationSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type PresentationSaveFileFormat. |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### SaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Allows to specify additional options (such as password) when saving a document to sign.
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of SaveOptions class with default values. |
| SaveOptions(boolean overwriteExistingFile) | Initializes a new instance of SaveOptions class with specified output type and overwrite flag. |
#### Methods

| Method | Description |
| --- | --- |
| getOverwriteExistingFiles() | Gets or sets whether to overwrite existing file with new output file. |
| setOverwriteExistingFiles(boolean value) | Gets or sets whether to overwrite existing file with new output file. |
| getPassword() | Gets or sets password to save signed document with password protection. |
| setPassword(String value) | Gets or sets password to save signed document with password protection. |
| getUseOriginalPassword() | Gets or sets whether to use password from LoadOptions to save signed document as protected. |
| setUseOriginalPassword(boolean value) | Gets or sets whether to use password from LoadOptions to save signed document as protected. |
| getAddMissingExtenstion() | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| setAddMissingExtenstion(boolean value) | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
##### SaveOptions()
```
public SaveOptions()
```

Initializes a new instance of SaveOptions class with default values.

##### SaveOptions(boolean overwriteExistingFile)
```
public SaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### getOverwriteExistingFiles()
```
public final boolean getOverwriteExistingFiles()
```

Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix.

**Returns:**
boolean
##### setOverwriteExistingFiles(boolean value)
```
public final void setOverwriteExistingFiles(boolean value)
```

Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets password to save signed document with password protection. This property is not supported for Image documents.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets password to save signed document with password protection. This property is not supported for Image documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getUseOriginalPassword()
```
public final boolean getUseOriginalPassword()
```

Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents.

**Returns:**
boolean
##### setUseOriginalPassword(boolean value)
```
public final void setUseOriginalPassword(boolean value)
```

Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAddMissingExtenstion()
```
public final boolean getAddMissingExtenstion()
```

Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.

**Returns:**
boolean
##### setAddMissingExtenstion(boolean value)
```
public final void setAddMissingExtenstion(boolean value)
```

Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/spreadsheetsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class SpreadsheetSaveOptions extends SaveOptions
```

Save options for Spreadsheet Documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetSaveOptions() | Initializes a new instance of SpreadsheetSaveOptions class with default values. |
| SpreadsheetSaveOptions(int fileFormat) | Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format. |
| SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
| toString() | Override string conversion. |
##### SpreadsheetSaveOptions()
```
public SpreadsheetSaveOptions()
```

Initializes a new instance of SpreadsheetSaveOptions class with default values.

##### SpreadsheetSaveOptions(int fileFormat)
```
public SpreadsheetSaveOptions(int fileFormat)
```

Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Specifies output file format. |

##### SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public SpreadsheetSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Specifies output file format. |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.saveoptions/wordprocessingsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
```
public class WordProcessingSaveOptions extends SaveOptions
```

Save options for WordProcessing documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSaveOptions() | Initializes a new instance of WordProcessingSaveOptions class with default values. |
| WordProcessingSaveOptions(int fileFormat) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format. |
| WordProcessingSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag. |
| WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag. |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
| toString() | Override string conversion |
##### WordProcessingSaveOptions()
```
public WordProcessingSaveOptions()
```

Initializes a new instance of WordProcessingSaveOptions class with default values.

##### WordProcessingSaveOptions(int fileFormat)
```
public WordProcessingSaveOptions(int fileFormat)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output file format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type WordProcessingSaveFileFormat. |

##### WordProcessingSaveOptions(boolean overwriteExistingFile)
```
public WordProcessingSaveOptions(boolean overwriteExistingFile)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile)
```
public WordProcessingSaveOptions(int fileFormat, boolean overwriteExistingFile)
```

Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | int | Output file type WordProcessingSaveFileFormat. |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |

##### getFileFormat()
```
public final int getFileFormat()
```

Gets or sets file format of signed document.

**Returns:**
int
##### setFileFormat(int value)
```
public final void setFileFormat(int value)
```

Gets or sets file format of signed document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.search
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search.md

The **GroupDocs.Signature.Options.Search** namespace provides classes for working with Search options.

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSearchOptions | Represents abstract search Options for Barcode signatures. |
| CertificateSearchOptions | Represents search options for Certificate metadata signatures. |
| DigitalSearchOptions | Represents base options for Digital signatures search |
| FormFieldSearchOptions | Represents abstract search Options for Form-field signatures. |
| ImageSearchOptions | Represents search options for Image signatures. |
| MetadataSearchOptions | Represents abstract search Options for Metadata signatures. |
| QrCodeSearchOptions | Represents abstract search Options for QR-Code signatures. |
| SearchOptions | Represents the extract signatures from document options. |
| TextSearchOptions | Represents search options for Text signatures. |

### BarcodeSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/barcodesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class BarcodeSearchOptions extends SearchOptions
```

Represents abstract search Options for Barcode signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSearchOptions() | Initializes a new instance of the SearchBarcodeOptions class with default values. |
| BarcodeSearchOptions(BarcodeType encodeType) | Initializes a new instance of the SearchBarcodeOptions class with encode type value. |
| BarcodeSearchOptions(BarcodeType encodeType, String text) | Initializes a new instance of the SearchBarcodeOptions class with encode type and text values. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies Encode Type property to search Barcodes. |
| setEncodeType(BarcodeType value) | Specifies Encode Type property to search Barcodes. |
| getText() | Specifies Barcode Signature text if it should be searched and matched. |
| setText(String value) | Specifies Barcode Signature text if it should be searched and matched. |
| getMatchType() | Gets or sets Barcode text Match Type search. |
| setMatchType(int value) | Gets or sets Barcode text Match Type search. |
| getReturnContent() | Gets or sets flag to grab Barcode image content of signature on document page. |
| setReturnContent(boolean value) | Gets or sets flag to grab Barcode image content of signature on document page. |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
##### BarcodeSearchOptions()
```
public BarcodeSearchOptions()
```

Initializes a new instance of the SearchBarcodeOptions class with default values.

##### BarcodeSearchOptions(BarcodeType encodeType)
```
public BarcodeSearchOptions(BarcodeType encodeType)
```

Initializes a new instance of the SearchBarcodeOptions class with encode type value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type. |

##### BarcodeSearchOptions(BarcodeType encodeType, String text)
```
public BarcodeSearchOptions(BarcodeType encodeType, String text)
```

Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Specifies Barcode encode type. |
| text | java.lang.String | Set Text of Barcode signature. |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### getText()
```
public final String getText()
```

Specifies Barcode Signature text if it should be searched and matched.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies Barcode Signature text if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at  BarcodeSignature.Format (BarcodeSignature.getFormat\}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at  BarcodeSignature.Format (BarcodeSignature.getFormat\}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### CertificateSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/certificatesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class CertificateSearchOptions extends SearchOptions
```

Represents search options for Certificate metadata signatures.

#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values. |
| CertificateSearchOptions(String text) | Initializes a new instance of the TextSearchOptions class with text value. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies certificate property text to match on searching. |
| setText(String value) | Specifies certificate property text to match on searching. |
| getMatchType() | Gets or sets text match type search. |
| setMatchType(int value) | Gets or sets text match type search. |
##### CertificateSearchOptions()
```
public CertificateSearchOptions()
```

Initializes a new instance of the TextSearchOptions class with default values.

##### CertificateSearchOptions(String text)
```
public CertificateSearchOptions(String text)
```

Initializes a new instance of the TextSearchOptions class with text value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Set Text of Text signature. |

##### getText()
```
public final String getText()
```

Specifies certificate property text to match on searching.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies certificate property text to match on searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets text match type search.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets text match type search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### DigitalSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/digitalsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class DigitalSearchOptions extends SearchOptions
```

Represents base options for Digital signatures search
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSearchOptions() | Initializes a new instance of the DigitalSearchOptions class with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getComments() | Comments of Digital signature to search. |
| setComments(String value) | Comments of Digital signature to search. |
| getSignDateTimeFrom() | Date and time range of Digital signature to search. |
| setSignDateTimeFrom(Date value) | Date and time range of Digital signature to search. |
| getSignDateTimeTo() | Date and time range of Digital Signature to search. |
| setSignDateTimeTo(Date value) | Date and time range of Digital Signature to search. |
| getSubjectName() | For non empty values specifies distinguished subject name of the certificate to search. |
| setSubjectName(String value) | For non empty values specifies distinguished subject name of the certificate to search. |
| getIssuerName() | For non empty values specifies distinguished name of the certificate issuer to search. |
| setIssuerName(String value) | For non empty values specifies distinguished name of the certificate issuer to search. |
##### DigitalSearchOptions()
```
public DigitalSearchOptions()
```

Initializes a new instance of the DigitalSearchOptions class with default values.

##### getComments()
```
public final String getComments()
```

Comments of Digital signature to search.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Comments of Digital signature to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignDateTimeFrom()
```
public final Date getSignDateTimeFrom()
```

Date and time range of Digital signature to search. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeFrom(Date value)
```
public final void setSignDateTimeFrom(Date value)
```

Date and time range of Digital signature to search. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSignDateTimeTo()
```
public final Date getSignDateTimeTo()
```

Date and time range of Digital Signature to search. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeTo(Date value)
```
public final void setSignDateTimeTo(Date value)
```

Date and time range of Digital Signature to search. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSubjectName()
```
public final String getSubjectName()
```

For non empty values specifies distinguished subject name of the certificate to search.

**Returns:**
java.lang.String
##### setSubjectName(String value)
```
public final void setSubjectName(String value)
```

For non empty values specifies distinguished subject name of the certificate to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIssuerName()
```
public final String getIssuerName()
```

For non empty values specifies distinguished name of the certificate issuer to search.

**Returns:**
java.lang.String
##### setIssuerName(String value)
```
public final void setIssuerName(String value)
```

For non empty values specifies distinguished name of the certificate issuer to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### FormFieldSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/formfieldsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class FormFieldSearchOptions extends SearchOptions
```

Represents abstract search Options for Form-field signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldSearchOptions() | Initializes a new instance of the SearchFormFieldOptions class with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getType() | Specifies type of form field signature if it should be searched. |
| setType(Integer value) | Specifies type of form field signature if it should be searched. |
| getName() | Specifies regular expression pattern of form field signature name if it should be searched. |
| setName(String value) | Specifies regular expression pattern of form field signature name if it should be searched. |
| getValue() | Specifies value of form field signature if it should be searched. |
| setValue(Object value) | Specifies value of form field signature if it should be searched. |
##### FormFieldSearchOptions()
```
public FormFieldSearchOptions()
```

Initializes a new instance of the SearchFormFieldOptions class with default values.

##### getType()
```
public final Integer getType()
```

Specifies type of form field signature if it should be searched. Default value is null.

**Returns:**
java.lang.Integer
##### setType(Integer value)
```
public final void setType(Integer value)
```

Specifies type of form field signature if it should be searched. Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getName()
```
public final String getName()
```

Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as "text" or regular expression like "abc\\d+". Default value is empty string.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies regular expression pattern of form field signature name if it should be searched. You can use it simple as "text" or regular expression like "abc\\d+". Default value is empty string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getValue()
```
public final Object getValue()
```

Specifies value of form field signature if it should be searched. Default value is null.

**Returns:**
java.lang.Object
##### setValue(Object value)
```
public final void setValue(Object value)
```

Specifies value of form field signature if it should be searched. Default value is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

### ImageSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/imagesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class ImageSearchOptions extends SearchOptions
```

Represents search options for Image signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSearchOptions() | Initializes a new instance of the ImageSearchOptions class with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getReturnContent() | Gets or sets flag to grab image content of signature on document page. |
| setReturnContent(boolean value) | Gets or sets flag to grab image content of signature on document page. |
| getMinContentSize() | For non zero value this flag specifies minimal size of images for search criteria. |
| setMinContentSize(long value) | For non zero value this flag specifies minimal size of images for search criteria. |
| getMaxContentSize() | For non zero value this flag specifies maximum size of images for search criteria. |
| setMaxContentSize(long value) | For non zero value this flag specifies maximum size of images for search criteria. |
| getReturnContentType() | Specifies file type of returned content of the image signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned content of the image signature when ReturnContent property is enabled. |
##### ImageSearchOptions()
```
public ImageSearchOptions()
```

Initializes a new instance of the ImageSearchOptions class with default values.

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getMinContentSize()
```
public final long getMinContentSize()
```

For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result.

**Returns:**
long
##### setMinContentSize(long value)
```
public final void setMinContentSize(long value)
```

For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getMaxContentSize()
```
public final long getMaxContentSize()
```

For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result.

**Returns:**
long
##### setMaxContentSize(long value)
```
public final void setMaxContentSize(long value)
```

For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at  ImageSignature.Format  Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at  ImageSignature.Format  Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### MetadataSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/metadatasearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class MetadataSearchOptions extends SearchOptions
```

Represents abstract search Options for Metadata signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSearchOptions() | Initializes a new instance of the SearchMetadataOptions class with default values. |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Specifies Metadata Signature name if it should be searched and matched. |
| setName(String value) | Specifies Metadata Signature name if it should be searched and matched. |
| getNameMatchType() | Gets or sets Metadata name Match Type search. |
| setNameMatchType(int value) | Gets or sets Metadata name Match Type search. |
| getIncludeBuiltinProperties() | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. |
| setIncludeBuiltinProperties(boolean value) | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
##### MetadataSearchOptions()
```
public MetadataSearchOptions()
```

Initializes a new instance of the SearchMetadataOptions class with default values.

##### getName()
```
public final String getName()
```

Specifies Metadata Signature name if it should be searched and matched.

**Returns:**
java.lang.String
##### setName(String value)
```
public final void setName(String value)
```

Specifies Metadata Signature name if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getNameMatchType()
```
public final int getNameMatchType()
```

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

**Returns:**
int
##### setNameMatchType(int value)
```
public final void setNameMatchType(int value)
```

Gets or sets Metadata name Match Type search. It is used only when Name property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getIncludeBuiltinProperties()
```
public final boolean getIncludeBuiltinProperties()
```

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadhsheet and Word Processing document file types.

**Returns:**
boolean
##### setIncludeBuiltinProperties(boolean value)
```
public final void setIncludeBuiltinProperties(boolean value)
```

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result. This flag has sense for Presentation, Spreadhsheet and Word Processing document file types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

### QrCodeSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/qrcodesearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class QrCodeSearchOptions extends SearchOptions
```

Represents abstract search Options for QR-Code signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSearchOptions() | Initializes a new instance of the QRCodeSearchOptions class with default values. |
| QrCodeSearchOptions(QrCodeType encodeType) | Initializes a new instance of the QRCodeSearchOptions class with encode type value. |
| QrCodeSearchOptions(QrCodeType encodeType, String text) | Initializes a new instance of the QRCodeSearchOptions class with encode type and text values. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Specifies Encode Type property to search QR-Codes. |
| setEncodeType(QrCodeType value) | Specifies Encode Type property to search QR-Codes. |
| getText() | Specifies QR-Code Signature Text if it should be searched and matched. |
| setText(String value) | Specifies QR-Code Signature Text if it should be searched and matched. |
| getMatchType() | Gets or sets QR-Code Text Match Type search. |
| setMatchType(int value) | Gets or sets QR-Code Text Match Type search. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| getReturnContent() | Gets or sets flag to grab QR-Code image content of signature on document page. |
| setReturnContent(boolean value) | Gets or sets flag to grab QR-Code image content of signature on document page. |
| getReturnContentType() | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. |
##### QrCodeSearchOptions()
```
public QrCodeSearchOptions()
```

Initializes a new instance of the QRCodeSearchOptions class with default values.

##### QrCodeSearchOptions(QrCodeType encodeType)
```
public QrCodeSearchOptions(QrCodeType encodeType)
```

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type. |

##### QrCodeSearchOptions(QrCodeType encodeType, String text)
```
public QrCodeSearchOptions(QrCodeType encodeType, String text)
```

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | QrCodeType | Specifies QR-Code encode type. |
| text | java.lang.String | Set Text of QR-Code signature. |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getText()
```
public final String getText()
```

Specifies QR-Code Signature Text if it should be searched and matched.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies QR-Code Signature Text if it should be searched and matched.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at  QrCodeSignature.Format () Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at  QrCodeSignature.Format () Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

### SearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/searchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions
```
public abstract class SearchOptions extends OptionsExtensions
```

Represents the extract signatures from document options.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets Document page number for searching. |
| setPageNumber(Integer value) | Gets or sets Document page number for searching. |
| getPagesSetup() | Options to specify pages for Signature searching. |
| setPagesSetup(PagesSetup value) | Options to specify pages for Signature searching. |
| getAllPages() | Flag to search on each Document page. |
| setAllPages(boolean value) | Flag to search on each Document page. |
| getSkipExternal() | Flag to return only signatures marked as IsSignature. |
| setSkipExternal(boolean value) | Flag to return only signatures marked as IsSignature. |
| getSearchPages(int totalPages) | Virtual method to get list of pages for Signature extraction. |
| toString() | Override string conversion. |
##### getPageNumber()
```
public final Integer getPageNumber()
```

Gets or sets Document page number for searching. Value is optional.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public final void setPageNumber(Integer value)
```

Gets or sets Document page number for searching. Value is optional.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPagesSetup()
```
public final PagesSetup getPagesSetup()
```

Options to specify pages for Signature searching.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public final void setPagesSetup(PagesSetup value)
```

Options to specify pages for Signature searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getAllPages()
```
public final boolean getAllPages()
```

Flag to search on each Document page. By default this value is set to true.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public final void setAllPages(boolean value)
```

Flag to search on each Document page. By default this value is set to true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSkipExternal()
```
public final boolean getSkipExternal()
```

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

**Returns:**
boolean
##### setSkipExternal(boolean value)
```
public final void setSkipExternal(boolean value)
```

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSearchPages(int totalPages)
```
public System.Collections.Generic.List<Integer> getSearchPages(int totalPages)
```

Virtual method to get list of pages for Signature extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| totalPages | int | Total count of pages |

**Returns:**
com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> - List of page numbers
##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### TextSearchOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.search/textsearchoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
```
public class TextSearchOptions extends SearchOptions
```

Represents search options for Text signatures.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSearchOptions() | Initializes a new instance of the TextSearchOptions class with default values. |
| TextSearchOptions(String text) | Initializes a new instance of the TextSearchOptions class with text value. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specifies signature text to match on searching. |
| setText(String value) | Specifies signature text to match on searching. |
| getMatchType() | Gets or sets text match type search. |
| setMatchType(int value) | Gets or sets text match type search. |
| getSignatureImplementation() | Specifies text signature implementation to search. |
| setSignatureImplementation(Integer value) | Specifies text signature implementation to search. |
##### TextSearchOptions()
```
public TextSearchOptions()
```

Initializes a new instance of the TextSearchOptions class with default values.

##### TextSearchOptions(String text)
```
public TextSearchOptions(String text)
```

Initializes a new instance of the TextSearchOptions class with text value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Set Text of Text signature. |

##### getText()
```
public final String getText()
```

Specifies signature text to match on searching.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specifies signature text to match on searching.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets text match type search.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets text match type search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureImplementation()
```
public final Integer getSignatureImplementation()
```

Specifies text signature implementation to search.

**Returns:**
java.lang.Integer
##### setSignatureImplementation(Integer value)
```
public final void setSignatureImplementation(Integer value)
```

Specifies text signature implementation to search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

### com.groupdocs.signature.options.sign
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign.md

The **GroupDocs.Signature.Options.Sign** namespace provides classes for working with Signature options

#### Classes

| Class | Description |
| --- | --- |
| BarcodeSignOptions | Represents the Barcode signature options. |
| DigitalSignOptions | Represents the Digital signature options. |
| FormFieldSignOptions | Represents class of the FormField signature options for Pdf documents. |
| ImageSignOptions | Represents the Image signature options. |
| MetadataSignOptions | Represents Metadata signature options. |
| QrCodeSignOptions | Represents the QR-Code signature options. |
| SignOptions | Represents the signature options. |
| StampSignOptions | Represents the Stamp signature options. |
| TextSignOptions | Represents the Text signature options. |

### BarcodeSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/barcodesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public class BarcodeSignOptions extends TextSignOptions
```

Represents the Barcode signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeSignOptions() | Initializes a new instance of the BarcodeSignOptions class with default values. |
| BarcodeSignOptions(String text) | Initializes a new instance of the BarcodeSignOptions class with text. |
| BarcodeSignOptions(String text, BarcodeType encodeType) | Initializes a new instance of the BarcodeSignOptions class with text. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets Barcode type. |
| setEncodeType(BarcodeType value) | Gets or sets Barcode type. |
| getForeColor() | Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. |
| setForeColor(Color value) | Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. |
| setForeColor(String value) | Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. |
| getInnerMargins() | Gets or sets the space between Barcode elements and result image borders. |
| setInnerMargins(Padding value) | Gets or sets the space between Barcode elements and result image borders. |
| getCodeTextAlignment() | Gets or sets the alignment of text in the result Barcode image. |
| setCodeTextAlignment(int value) | Gets or sets the alignment of text in the result Barcode image. |
| getReturnContent() | Gets or sets flag to get Barcode image content of a signature which was put on document page. |
| setReturnContent(boolean value) | Gets or sets flag to get Barcode image content of a signature which was put on document page. |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| validate() | Internal method to validate the Barcode options parameters. |
| toString() | Override string conversion. |
##### BarcodeSignOptions()
```
public BarcodeSignOptions()
```

Initializes a new instance of the BarcodeSignOptions class with default values.

##### BarcodeSignOptions(String text)
```
public BarcodeSignOptions(String text)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text |

##### BarcodeSignOptions(String text, BarcodeType encodeType)
```
public BarcodeSignOptions(String text, BarcodeType encodeType)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text |
| encodeType | BarcodeType | Barcode encode type see BarcodeType |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Gets or sets Barcode type.

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Gets or sets Barcode type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeColor(String value)
```
public void setForeColor(String value)
```

Gets or sets the Fore color of Barcode bars Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInnerMargins()
```
public final Padding getInnerMargins()
```

Gets or sets the space between Barcode elements and result image borders.

**Returns:**
Padding
##### setInnerMargins(Padding value)
```
public final void setInnerMargins(Padding value)
```

Gets or sets the space between Barcode elements and result image borders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getCodeTextAlignment()
```
public final int getCodeTextAlignment()
```

Gets or sets the alignment of text in the result Barcode image. Default value is None.

**Returns:**
int
##### setCodeTextAlignment(int value)
```
public final void setCodeTextAlignment(int value)
```

Gets or sets the alignment of text in the result Barcode image. Default value is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to get Barcode image content of a signature which was put on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to get Barcode image content of a signature which was put on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at  BarcodeSignature.Format (BarcodeSignature.getFormat\}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at  BarcodeSignature.Format (BarcodeSignature.getFormat) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### validate()
```
public void validate()
```

Internal method to validate the Barcode options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### DigitalSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/digitalsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions
```
public class DigitalSignOptions extends ImageSignOptions
```

Represents the Digital signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalSignOptions() | Initializes a new instance of the DigitalSignOptions class with default values. |
| DigitalSignOptions(String certificateFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file. |
| DigitalSignOptions(InputStream certificateStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream. |
| DigitalSignOptions(String certificateFilePath, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate file and image file. |
| DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream. |
| DigitalSignOptions(InputStream certificateStream, String imageFilePath) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file. |
| DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream) | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream. |
#### Methods

| Method | Description |
| --- | --- |
| getReason() | Gets or sets the reason of signature. |
| setReason(String value) | Gets or sets the reason of signature. |
| getContact() | Gets or sets the signature contact. |
| setContact(String value) | Gets or sets the signature contact. |
| getLocation() | Gets or sets the signature location. |
| setLocation(String value) | Gets or sets the signature location. |
| getPassword() | Gets or sets the password of digital certificate. |
| setPassword(String value) | Gets or sets the password of digital certificate. |
| getSignature() | Gets or sets properties of document digital signature. |
| setSignature(DigitalSignature value) | Gets or sets properties of document digital signature. |
| getCertificateFilePath() | Gets or sets the digital certificate file path. |
| setCertificateFilePath(String value) | Gets or sets the digital certificate file GUID. |
| getCertificateStream() | Gets or sets digital certificate stream. |
| setCertificateStream(InputStream value) | Gets or sets digital certificate stream. |
| getVisible() | Gets or sets the visibility of signature. |
| setVisible(boolean value) | Gets or sets the visibility of signature. |
| getXAdESType() | XAdES type  XAdESType . |
| setXAdESType(int value) | XAdES type  XAdESType . |
| getSignatureLineId() |  |
| setSignatureLineId(UUID value) |  |
| toString() | Override string conversion. |
##### DigitalSignOptions()
```
public DigitalSignOptions()
```

Initializes a new instance of the DigitalSignOptions class with default values.

##### DigitalSignOptions(String certificateFilePath)
```
public DigitalSignOptions(String certificateFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path |

##### DigitalSignOptions(InputStream certificateStream)
```
public DigitalSignOptions(InputStream certificateStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream |

##### DigitalSignOptions(String certificateFilePath, String imageFilePath)
```
public DigitalSignOptions(String certificateFilePath, String imageFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate file and image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path |
| imageFilePath | java.lang.String | Signature Appearance image file path |

##### DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)
```
public DigitalSignOptions(String certificateFilePath, InputStream appearenceImageStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateFilePath | java.lang.String | Digital certificate file path |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream |

##### DigitalSignOptions(InputStream certificateStream, String imageFilePath)
```
public DigitalSignOptions(InputStream certificateStream, String imageFilePath)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream |
| imageFilePath | java.lang.String | Signature Appearance image file path |

##### DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)
```
public DigitalSignOptions(InputStream certificateStream, InputStream appearenceImageStream)
```

Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Digital Certificate stream |
| appearenceImageStream | java.io.InputStream | Signature Appearance image stream |

##### getReason()
```
public final String getReason()
```

Gets or sets the reason of signature.

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

Gets or sets the reason of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContact()
```
public final String getContact()
```

Gets or sets the signature contact.

**Returns:**
java.lang.String
##### setContact(String value)
```
public final void setContact(String value)
```

Gets or sets the signature contact.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Gets or sets the signature location.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Gets or sets the signature location.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getPassword()
```
public final String getPassword()
```

Gets or sets the password of digital certificate.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Gets or sets the password of digital certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignature()
```
public final DigitalSignature getSignature()
```

Gets or sets properties of document digital signature.

**Returns:**
DigitalSignature
##### setSignature(DigitalSignature value)
```
public final void setSignature(DigitalSignature value)
```

Gets or sets properties of document digital signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DigitalSignature |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

Gets or sets the digital certificate file path. This property is used only if CertificateStream is not specified.

**Returns:**
java.lang.String
##### setCertificateFilePath(String value)
```
public void setCertificateFilePath(String value)
```

Gets or sets the digital certificate file GUID. This property is used only if CertificateStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.

**Returns:**
java.io.InputStream
##### setCertificateStream(InputStream value)
```
public final void setCertificateStream(InputStream value)
```

Gets or sets digital certificate stream. If this property is specified it is always used instead CertificateGuid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getVisible()
```
public final boolean getVisible()
```

Gets or sets the visibility of signature.

**Returns:**
boolean
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

Gets or sets the visibility of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getXAdESType()
```
public final int getXAdESType()
```

XAdES type  XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

**Returns:**
int
##### setXAdESType(int value)
```
public final void setXAdESType(int value)
```

XAdES type  XAdESType . Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents under .NET Framework only (not under .NET Standard)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureLineId()
```
public final UUID getSignatureLineId()
```

**Returns:**
java.util.UUID
##### setSignatureLineId(UUID value)
```
public final void setSignatureLineId(UUID value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.UUID |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### FormFieldSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/formfieldsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public final class FormFieldSignOptions extends TextSignOptions
```

Represents class of the FormField signature options for Pdf documents.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormFieldSignOptions() | Initializes a new instance of the PdfFormFieldSignOptions class with default values. |
| FormFieldSignOptions(FormFieldSignature signature) | Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature. |
#### Methods

| Method | Description |
| --- | --- |
| getSignature() | Gets or sets the FormField of signature. |
| setSignature(FormFieldSignature value) | Gets or sets the FormField of signature. |
##### FormFieldSignOptions()
```
public FormFieldSignOptions()
```

Initializes a new instance of the PdfFormFieldSignOptions class with default values.

##### FormFieldSignOptions(FormFieldSignature signature)
```
public FormFieldSignOptions(FormFieldSignature signature)
```

Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signature | FormFieldSignature |  |

##### getSignature()
```
public final FormFieldSignature getSignature()
```

Gets or sets the FormField of signature.

**Returns:**
FormFieldSignature
##### setSignature(FormFieldSignature value)
```
public final void setSignature(FormFieldSignature value)
```

Gets or sets the FormField of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FormFieldSignature |  |

### ImageSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/imagesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.IRectangle, com.groupdocs.signature.domain.interfaces.IAlignment, com.groupdocs.signature.domain.interfaces.IRotation, com.groupdocs.signature.domain.interfaces.ITransparency, com.aspose.ms.System.IDisposable
```
public class ImageSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency, System.IDisposable
```

Represents the Image signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSignOptions() | Initializes a new instance of the ImageSignOptions class with default values. |
| ImageSignOptions(String imageFilePath) | Initializes a new instance of the ImageSignOptions class with image file. |
| ImageSignOptions(InputStream imageStream) | Initializes a new instance of the ImageSignOptions class with image stream. |
#### Methods

| Method | Description |
| --- | --- |
| getImageFilePath() | Gets or sets the signature image file path. |
| setImageFilePath(String value) | Gets or sets the signature image file path. |
| getImageStream() | Gets or sets the signature image stream. |
| setImageStream(InputStream value) | Gets or sets the signature image stream. |
| getLeft() | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). |
| setLeft(int value) | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). |
| getTop() | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). |
| setTop(int value) | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). |
| getWidth() | Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType). |
| setWidth(int value) | Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType). |
| getHeight() | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType). |
| setHeight(int value) | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType). |
| getLocationMeasureType() | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| setLocationMeasureType(int value) | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| getSizeMeasureType() | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| setSizeMeasureType(int value) | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| getStretch() | Stretch mode on Document Page. |
| setStretch(int value) | Stretch mode on Document Page. |
| getRotationAngle() | Rotation angle of signature on document page (clockwise). |
| setRotationAngle(int value) | Rotation angle of signature on document page (clockwise). |
| getHorizontalAlignment() | Horizontal alignment of signature on document page. |
| setHorizontalAlignment(int value) | Horizontal alignment of signature on document page. |
| getVerticalAlignment() | Vertical alignment of signature on document page. |
| setVerticalAlignment(int value) | Vertical alignment of signature on document page. |
| getMargin() | Gets or sets the space between Sign and Document edges. |
| setMargin(Padding value) | Gets or sets the space between Sign and Document edges. |
| getMarginMeasureType() | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| setMarginMeasureType(int value) | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| getTransparency() | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| setTransparency(double value) | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| getShapePosition() | Defines where shape should be presented in the document layout |
| setShapePosition(int value) | Defines where shape should be presented in the document layout |
| getRectangle() | Rectangle of area to put the image on document. |
| getBorder() | Specify border settings |
| setBorder(Border value) | Specify border settings |
| toString() | Override string conversion. |
| fromBase64(String base64Content) | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |
| dispose() | Clears internal resources |
##### ImageSignOptions()
```
public ImageSignOptions()
```

Initializes a new instance of the ImageSignOptions class with default values.

##### ImageSignOptions(String imageFilePath)
```
public ImageSignOptions(String imageFilePath)
```

Initializes a new instance of the ImageSignOptions class with image file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageFilePath | java.lang.String | Image file path |

##### ImageSignOptions(InputStream imageStream)
```
public ImageSignOptions(InputStream imageStream)
```

Initializes a new instance of the ImageSignOptions class with image stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageStream | java.io.InputStream | Image stream |

##### getImageFilePath()
```
public final String getImageFilePath()
```

Gets or sets the signature image file path. This property is used only if ImageStream is not specified.

**Returns:**
java.lang.String
##### setImageFilePath(String value)
```
public final void setImageFilePath(String value)
```

Gets or sets the signature image file path. This property is used only if ImageStream is not specified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageStream()
```
public final InputStream getImageStream()
```

Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.

**Returns:**
java.io.InputStream
##### setImageStream(InputStream value)
```
public final void setImageStream(InputStream value)
```

Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getLeft()
```
public int getLeft()
```

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). (works if horizontal alignment is not specified).

**Returns:**
int
##### setLeft(int value)
```
public void setLeft(int value)
```

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). (works if horizontal alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public int getTop()
```

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). (works if vertical alignment is not specified).

**Returns:**
int
##### setTop(int value)
```
public void setTop(int value)
```

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). (works if vertical alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType).

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType).

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLocationMeasureType()
```
public int getLocationMeasureType()
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Returns:**
int
##### setLocationMeasureType(int value)
```
public void setLocationMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSizeMeasureType()
```
public int getSizeMeasureType()
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Returns:**
int
##### setSizeMeasureType(int value)
```
public void setSizeMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getStretch()
```
public final int getStretch()
```

Stretch mode on Document Page.

**Returns:**
int
##### setStretch(int value)
```
public final void setStretch(int value)
```

Stretch mode on Document Page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Rotation angle of signature on document page (clockwise).

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Rotation angle of signature on document page (clockwise).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Horizontal alignment of signature on document page.

**Returns:**
int
##### setHorizontalAlignment(int value)
```
public final void setHorizontalAlignment(int value)
```

Horizontal alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Vertical alignment of signature on document page.

**Returns:**
int
##### setVerticalAlignment(int value)
```
public final void setVerticalAlignment(int value)
```

Vertical alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMargin()
```
public Padding getMargin()
```

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

**Returns:**
Padding
##### setMargin(Padding value)
```
public void setMargin(Padding value)
```

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getMarginMeasureType()
```
public int getMarginMeasureType()
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Returns:**
int
##### setMarginMeasureType(int value)
```
public void setMarginMeasureType(int value)
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getShapePosition()
```
public final int getShapePosition()
```

Defines where shape should be presented in the document layout

**Returns:**
int
##### setShapePosition(int value)
```
public final void setShapePosition(int value)
```

Defines where shape should be presented in the document layout

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRectangle()
```
public final Rectangle getRectangle()
```

Rectangle of area to put the image on document.

**Returns:**
java.awt.Rectangle
##### getBorder()
```
public final Border getBorder()
```

Specify border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Specify border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### fromBase64(String base64Content)
```
public static ImageSignOptions fromBase64(String base64Content)
```

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| base64Content | java.lang.String | Image content in Base64 string format |

**Returns:**
ImageSignOptions -
##### dispose()
```
public final void dispose()
```

Clears internal resources

### MetadataSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/metadatasignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions
```
public class MetadataSignOptions extends SignOptions
```

Represents Metadata signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| MetadataSignOptions() | Initializes a new instance of the SignMetadataOptions class with default values. |
| MetadataSignOptions(ArrayList<MetadataSignature> signatures) | Initializes a new instance of the SignMetadataOptions class with Metadata. |
#### Methods

| Method | Description |
| --- | --- |
| getSignatures() | Gets or sets the Metadata of signature. |
| setSignatures(MetadataSignatureCollection value) | Gets or sets the Metadata of signature. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| addPdfSignature(String name, Object value, String tag) | Creates new PdfMetadataSignature with passed arguments and adds it to collection. |
| addImageSignature(int id, Object value) | Creates new ImageMetadataSignature with passed arguments and adds it to collection. |
| add(MetadataSignature metadataSignature) | Add existing MetadataSignature instance to collection. |
| validate() | Internal method to validate the options parameters. |
| toString() | Override string conversion. |
| signature() |  |
##### MetadataSignOptions()
```
public MetadataSignOptions()
```

Initializes a new instance of the SignMetadataOptions class with default values.

##### MetadataSignOptions(ArrayList<MetadataSignature> signatures)
```
public MetadataSignOptions(ArrayList<MetadataSignature> signatures)
```

Initializes a new instance of the SignMetadataOptions class with Metadata.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatures | java.util.ArrayList<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature> | Collection of Metadata Signatures MetadataSignature. |

##### getSignatures()
```
public final MetadataSignatureCollection getSignatures()
```

Gets or sets the Metadata of signature.

**Returns:**
MetadataSignatureCollection
##### setSignatures(MetadataSignatureCollection value)
```
public final void setSignatures(MetadataSignatureCollection value)
```

Gets or sets the Metadata of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | MetadataSignatureCollection |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### addPdfSignature(String name, Object value, String tag)
```
public final PdfMetadataSignature addPdfSignature(String name, Object value, String tag)
```

Creates new PdfMetadataSignature with passed arguments and adds it to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | Name of Metadata signature object |
| value | java.lang.Object | Value of Metadata signature |
| tag | java.lang.String | Prefix tag of Metadata signature |

**Returns:**
PdfMetadataSignature - Newly created signature that was added to MetadataSignatures collection
##### addImageSignature(int id, Object value)
```
public final ImageMetadataSignature addImageSignature(int id, Object value)
```

Creates new ImageMetadataSignature with passed arguments and adds it to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | java.lang.Object | Metadata value |

**Returns:**
ImageMetadataSignature - Newly created signature that was added to MetadataSignatures collection
##### add(MetadataSignature metadataSignature)
```
public final MetadataSignOptions add(MetadataSignature metadataSignature)
```

Add existing MetadataSignature instance to collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| metadataSignature | MetadataSignature | The existing MetadataSignature instance to be added |

**Returns:**
MetadataSignOptions - Instance itself
##### validate()
```
public void validate()
```

Internal method to validate the options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### signature()
```
public BaseSignature signature()
```

**Returns:**
BaseSignature

### QrCodeSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/qrcodesignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.TextSignOptions
```
public class QrCodeSignOptions extends TextSignOptions
```

Represents the QR-Code signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeSignOptions() | Initializes a new instance of the QRCodeSignOptions class with default values. |
| QrCodeSignOptions(String text) | Initializes a new instance of the QRCodeSignOptions class with text. |
| QrCodeSignOptions(String text, QrCodeType encodeType) | Initializes a new instance of the BarcodeSignOptions class with text. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets QRCode type. |
| setEncodeType(QrCodeType value) | Gets or sets QRCode type. |
| getForeColor() | Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. |
| setForeColor(Color value) | Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. |
| setForeColor(String value) | Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. |
| getInnerMargins() | Gets or sets the space between QRCode elements and result image borders. |
| setInnerMargins(Padding value) | Gets or sets the space between QRCode elements and result image borders. |
| getCodeTextAlignment() | Gets or sets the alignment of text in the result QR-code image. |
| setCodeTextAlignment(int value) | Gets or sets the alignment of text in the result QR-code image. |
| getLogoFilePath() | Gets or sets the QR-code logo image file name. |
| setLogoFilePath(String value) | Gets or sets the QR-code logo image file name. |
| getLogoStream() | Gets or sets the QR-code logo image stream. |
| setLogoStream(InputStream value) | Gets or sets the QR-code logo image stream. |
| getData() | Gets or sets custom object to serialize to QR-Code content. |
| setData(Object value) | Gets or sets custom object to serialize to QR-Code content. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| getReturnContent() | Gets or sets flag to get QR-Code image content of a signature which was put on document page. |
| setReturnContent(boolean value) | Gets or sets flag to get QR-Code image content of a signature which was put on document page. |
| getReturnContentType() | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. |
| toString() | Override string conversion. |
| signature() |  |
##### QrCodeSignOptions()
```
public QrCodeSignOptions()
```

Initializes a new instance of the QRCodeSignOptions class with default values.

##### QrCodeSignOptions(String text)
```
public QrCodeSignOptions(String text)
```

Initializes a new instance of the QRCodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Signature text. |

##### QrCodeSignOptions(String text, QrCodeType encodeType)
```
public QrCodeSignOptions(String text, QrCodeType encodeType)
```

Initializes a new instance of the BarcodeSignOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | QRCode text |
| encodeType | QrCodeType | QRCode encode type see QrCodeType |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Gets or sets QRCode type.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Gets or sets QRCode type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### setForeColor(String value)
```
public void setForeColor(String value)
```

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getInnerMargins()
```
public final Padding getInnerMargins()
```

Gets or sets the space between QRCode elements and result image borders.

**Returns:**
Padding
##### setInnerMargins(Padding value)
```
public final void setInnerMargins(Padding value)
```

Gets or sets the space between QRCode elements and result image borders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getCodeTextAlignment()
```
public final int getCodeTextAlignment()
```

Gets or sets the alignment of text in the result QR-code image. Default value is None.

**Returns:**
int
##### setCodeTextAlignment(int value)
```
public final void setCodeTextAlignment(int value)
```

Gets or sets the alignment of text in the result QR-code image. Default value is None.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLogoFilePath()
```
public final String getLogoFilePath()
```

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.lang.String
##### setLogoFilePath(String value)
```
public final void setLogoFilePath(String value)
```

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLogoStream()
```
public final InputStream getLogoStream()
```

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

**Returns:**
java.io.InputStream
##### setLogoStream(InputStream value)
```
public final void setLogoStream(InputStream value)
```

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getData()
```
public final Object getData()
```

Gets or sets custom object to serialize to QR-Code content.

**Returns:**
java.lang.Object
##### setData(Object value)
```
public final void setData(Object value)
```

Gets or sets custom object to serialize to QR-Code content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Object |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### getReturnContent()
```
public final boolean getReturnContent()
```

Gets or sets flag to get QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Returns:**
boolean
##### setReturnContent(boolean value)
```
public final void setReturnContent(boolean value)
```

Gets or sets flag to get QR-Code image content of a signature which was put on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format  ReturnContentType (\#getReturnContentType.getReturnContentType/\#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getReturnContentType()
```
public final FileType getReturnContentType()
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at  QrCodeSignature.Format (QrCodeSignature.getFormat/\{@link QrCodeSignature\#(FileType)\}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in .png format will be returned.

**Returns:**
FileType
##### setReturnContentType(FileType value)
```
public final void setReturnContentType(FileType value)
```

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at  QrCodeSignature.Format (QrCodeSignature.getFormat/\{@link QrCodeSignature\#(FileType)\}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in .png format will be returned.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### signature()
```
public BaseSignature signature()
```

**Returns:**
BaseSignature

### SignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/signoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class SignOptions
```

Represents the signature options.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() | Gets or sets document page number for signing. |
| setPageNumber(int value) | Gets or sets document page number for signing. |
| getAllPages() | Put signature on all document pages. |
| setAllPages(boolean value) | Put signature on all document pages. |
| getAppearance() | Additional signature appearance. |
| setAppearance(SignatureAppearance value) | Additional signature appearance. |
| getExtensions() | Signature Extensions. |
| setExtensions(List<SignatureExtension> value) | Signature Extensions. |
| getPagesSetup() | Options to specify pages to be signed. |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed. |
| getSignatureType() | Get the Signature Type SignatureType |
| getDocumentType() | Get or set the Document Type of the Signature Options DocumentType |
| setDocumentType(int value) | Get or set the Document Type of the Signature Options DocumentType |
| getZOrder() | Gets or sets the Z-order position of text signature. |
| setZOrder(int value) | Gets or sets the Z-order position of text signature. |
| toString() | Override string conversion. |
| addSignature(Object[] args) |  |
##### getPageNumber()
```
public int getPageNumber()
```

Gets or sets document page number for signing. Minimal and default value is 1.

**Returns:**
int
##### setPageNumber(int value)
```
public void setPageNumber(int value)
```

Gets or sets document page number for signing. Minimal and default value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAllPages()
```
public boolean getAllPages()
```

Put signature on all document pages.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public void setAllPages(boolean value)
```

Put signature on all document pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getAppearance()
```
public final SignatureAppearance getAppearance()
```

Additional signature appearance.

**Returns:**
SignatureAppearance
##### setAppearance(SignatureAppearance value)
```
public final void setAppearance(SignatureAppearance value)
```

Additional signature appearance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureAppearance |  |

##### getExtensions()
```
public final List<SignatureExtension> getExtensions()
```

Signature Extensions.

**Returns:**
java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension>
##### setExtensions(List<SignatureExtension> value)
```
public void setExtensions(List<SignatureExtension> value)
```

Signature Extensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension> |  |

##### getPagesSetup()
```
public PagesSetup getPagesSetup()
```

Options to specify pages to be signed.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public void setPagesSetup(PagesSetup value)
```

Options to specify pages to be signed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getSignatureType()
```
public final int getSignatureType()
```

Get the Signature Type SignatureType

**Returns:**
int
##### getDocumentType()
```
public final int getDocumentType()
```

Get or set the Document Type of the Signature Options DocumentType

**Returns:**
int
##### setDocumentType(int value)
```
public final void setDocumentType(int value)
```

Get or set the Document Type of the Signature Options DocumentType

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getZOrder()
```
public final int getZOrder()
```

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

**Returns:**
int
##### setZOrder(int value)
```
public final void setZOrder(int value)
```

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -
##### addSignature(Object[] args)
```
public BaseSignature addSignature(Object[] args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| args | java.lang.Object[] |  |

**Returns:**
BaseSignature

### StampSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/stampsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions, com.groupdocs.signature.options.sign.ImageSignOptions
```
public class StampSignOptions extends ImageSignOptions
```

Represents the Stamp signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| StampSignOptions() | Initializes a new instance of the StampSignOptions class with default values. |
| StampSignOptions(int left, int top, int width, int height) | Initializes a new instance of the StampSignOptions class with alignment options. |
#### Methods

| Method | Description |
| --- | --- |
| getStampType() | Gets or sets stamp type. |
| setStampType(StampType value) | Gets or sets stamp type. |
| getOuterLines() | List of Outer Lines rendered as concentric circles. |
| getInnerLines() | List of Inner Lines rendered as set of rectangles. |
| getBackground() | Gets or sets the Stamp background. |
| setBackground(Background value) | Gets or sets the Stamp background. |
| getBackgroundColor() | Gets or sets the background color of signature. |
| setBackgroundColor(Color value) | Gets or sets the background color of signature. |
| getBackgroundBrush() | Gets or sets the signature background brush. |
| setBackgroundBrush(Brush value) | Gets or sets the signature background brush. |
| getBackgroundColorCropType() | Gets or sets the background color crop type of signature. |
| setBackgroundColorCropType(int value) | Gets or sets the background color crop type of signature. |
| getBackgroundImageCropType() | Gets or sets the background image crop type of signature. |
| setBackgroundImageCropType(int value) | Gets or sets the background image crop type of signature. |
| toString() | Override string conversion |
##### StampSignOptions()
```
public StampSignOptions()
```

Initializes a new instance of the StampSignOptions class with default values.

##### StampSignOptions(int left, int top, int width, int height)
```
public StampSignOptions(int left, int top, int width, int height)
```

Initializes a new instance of the StampSignOptions class with alignment options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | int | The x-coordinate of the left top edge of Stamp Signature |
| top | int | The y-coordinate of the left top edge of Stamp Signature |
| width | int | The width of Stamp Signature |
| height | int | The height of Stamp Signature |

##### getStampType()
```
public final StampType getStampType()
```

Gets or sets stamp type. Value by default is Round.

**Returns:**
StampType
##### setStampType(StampType value)
```
public final void setStampType(StampType value)
```

Gets or sets stamp type. Value by default is Round.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | StampType |  |

##### getOuterLines()
```
public final List<StampLine> getOuterLines()
```

List of Outer Lines rendered as concentric circles.

**Returns:**
java.util.List<com.groupdocs.signature.domain.stamps.StampLine>
##### getInnerLines()
```
public final List<StampLine> getInnerLines()
```

List of Inner Lines rendered as set of rectangles.

**Returns:**
java.util.List<com.groupdocs.signature.domain.stamps.StampLine>
##### getBackground()
```
public final Background getBackground()
```

Gets or sets the Stamp background.

**Returns:**
Background
##### setBackground(Background value)
```
public final void setBackground(Background value)
```

Gets or sets the Stamp background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Background |  |

##### getBackgroundColor()
```
public final Color getBackgroundColor()
```

Gets or sets the background color of signature.

**Returns:**
java.awt.Color
##### setBackgroundColor(Color value)
```
public final void setBackgroundColor(Color value)
```

Gets or sets the background color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getBackgroundBrush()
```
public final Brush getBackgroundBrush()
```

Gets or sets the signature background brush. Value by default is null.

**Returns:**
Brush
##### setBackgroundBrush(Brush value)
```
public final void setBackgroundBrush(Brush value)
```

Gets or sets the signature background brush. Value by default is null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Brush |  |

##### getBackgroundColorCropType()
```
public final int getBackgroundColorCropType()
```

Gets or sets the background color crop type of signature.

**Returns:**
int
##### setBackgroundColorCropType(int value)
```
public final void setBackgroundColorCropType(int value)
```

Gets or sets the background color crop type of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBackgroundImageCropType()
```
public final int getBackgroundImageCropType()
```

Gets or sets the background image crop type of signature.

**Returns:**
int
##### setBackgroundImageCropType(int value)
```
public final void setBackgroundImageCropType(int value)
```

Gets or sets the background image crop type of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### TextSignOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.sign/textsignoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.sign.SignOptions

**All Implemented Interfaces:**
com.groupdocs.signature.domain.interfaces.IRectangle, com.groupdocs.signature.domain.interfaces.IAlignment, com.groupdocs.signature.domain.interfaces.IRotation, com.groupdocs.signature.domain.interfaces.ITransparency
```
public class TextSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency
```

Represents the Text signature options.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSignOptions() | Initializes a new instance of the SignTextOptions class with default values. |
| TextSignOptions(String text) | Initializes a new instance of the SignTextOptions class with text. |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_TRANSPARENCY |  |
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). |
| setLeft(int value) | Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). |
| getTop() | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). |
| setTop(int value) | Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). |
| getWidth() | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property). |
| setWidth(int value) | Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property). |
| getHeight() | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property). |
| setHeight(int value) | Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property). |
| getLocationMeasureType() | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| setLocationMeasureType(int value) | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| getSizeMeasureType() | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| setSizeMeasureType(int value) | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| getStretch() | Stretch mode on Document Page. |
| setStretch(int value) | Stretch mode on Document Page. |
| getRotationAngle() | Rotation angle of signature on document page (clockwise). |
| setRotationAngle(int value) | Rotation angle of signature on document page (clockwise). |
| getHorizontalAlignment() | Horizontal alignment of signature on document page. |
| setHorizontalAlignment(int value) | Horizontal alignment of signature on document page. |
| getVerticalAlignment() | Vertical alignment of signature on document page. |
| setVerticalAlignment(int value) | Vertical alignment of signature on document page. |
| getMargin() | Gets or sets the space between Sign and Document edges. |
| setMargin(Padding value) | Gets or sets the space between Sign and Document edges. |
| getMarginMeasureType() | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| setMarginMeasureType(int value) | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| getTransparency() | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| setTransparency(double value) | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| getText() | Gets or sets the text of signature. |
| setText(String value) | Gets or sets the text of signature. |
| getFont() | Gets or sets the font of signature. |
| setFont(SignatureFont value) | Gets or sets the font of signature. |
| getForeColor() | Gets or sets the fore color of signature. |
| setForeColor(Color value) | Gets or sets the fore color of signature. |
| getSignatureImplementation() | Gets or sets the type of text signature implementation. |
| setSignatureImplementation(int value) | Gets or sets the type of text signature implementation. |
| getTextHorizontalAlignment() | Horizontal alignment of text inside a signature. |
| setTextHorizontalAlignment(int value) | Horizontal alignment of text inside a signature. |
| getTextVerticalAlignment() | Vertical alignment of text inside a signature. |
| setTextVerticalAlignment(int value) | Vertical alignment of text inside a signature. |
| getFormTextFieldTitle() | Gets or sets the title of text form field to put text signature into it. |
| setFormTextFieldTitle(String value) | Gets or sets the title of text form field to put text signature into it. |
| getFormTextFieldType() | Gets or sets the type of form field to put text signature into it. |
| setFormTextFieldType(int value) | Gets or sets the type of form field to put text signature into it. |
| getShapeType() | Gets or sets the type of shape to put text. |
| setShapeType(int value) | Gets or sets the type of shape to put text. |
| getSignatureID() | Gets or sets the unique ID of signature. |
| setSignatureID(int value) | Gets or sets the unique ID of signature. |
| getBorder() | Specify border settings |
| setBorder(Border value) | Specify border settings |
| getBackground() | Gets or sets the signature background settings. |
| setBackground(Background value) | Gets or sets the signature background settings. |
| getNative() | Gets or sets the native attribute. |
| setNative(boolean value) | Gets or sets the native attribute. |
| getShapePosition() | Defines where shape should be presented in the document layout |
| setShapePosition(int value) | Defines where shape should be presented in the document layout |
| validate() | Internal method to validate the options parameters. |
| toString() | Override string conversion. |
##### TextSignOptions()
```
public TextSignOptions()
```

Initializes a new instance of the SignTextOptions class with default values.

##### TextSignOptions(String text)
```
public TextSignOptions(String text)
```

Initializes a new instance of the SignTextOptions class with text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Signature text. |

##### DEFAULT_TRANSPARENCY
```
public static final double DEFAULT_TRANSPARENCY
```

##### getLeft()
```
public final int getLeft()
```

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

**Returns:**
int
##### setLeft(int value)
```
public final void setLeft(int value)
```

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTop()
```
public final int getTop()
```

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

**Returns:**
int
##### setTop(int value)
```
public final void setTop(int value)
```

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getWidth()
```
public final int getWidth()
```

Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Returns:**
int
##### setWidth(int value)
```
public final void setWidth(int value)
```

Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHeight()
```
public final int getHeight()
```

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Returns:**
int
##### setHeight(int value)
```
public final void setHeight(int value)
```

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLocationMeasureType()
```
public int getLocationMeasureType()
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Returns:**
int
##### setLocationMeasureType(int value)
```
public void setLocationMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Left and Top properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSizeMeasureType()
```
public int getSizeMeasureType()
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Returns:**
int
##### setSizeMeasureType(int value)
```
public void setSizeMeasureType(int value)
```

Measure type (pixels, percents or millimeters) for Width and Height properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getStretch()
```
public final int getStretch()
```

Stretch mode on Document Page.

**Returns:**
int
##### setStretch(int value)
```
public final void setStretch(int value)
```

Stretch mode on Document Page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getRotationAngle()
```
public final int getRotationAngle()
```

Rotation angle of signature on document page (clockwise).

**Returns:**
int
##### setRotationAngle(int value)
```
public final void setRotationAngle(int value)
```

Rotation angle of signature on document page (clockwise).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Horizontal alignment of signature on document page.

**Returns:**
int
##### setHorizontalAlignment(int value)
```
public final void setHorizontalAlignment(int value)
```

Horizontal alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Vertical alignment of signature on document page.

**Returns:**
int
##### setVerticalAlignment(int value)
```
public final void setVerticalAlignment(int value)
```

Vertical alignment of signature on document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getMargin()
```
public Padding getMargin()
```

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

**Returns:**
Padding
##### setMargin(Padding value)
```
public void setMargin(Padding value)
```

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Padding |  |

##### getMarginMeasureType()
```
public int getMarginMeasureType()
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Returns:**
int
##### setMarginMeasureType(int value)
```
public void setMarginMeasureType(int value)
```

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTransparency()
```
public final double getTransparency()
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Returns:**
double
##### setTransparency(double value)
```
public final void setTransparency(double value)
```

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double |  |

##### getText()
```
public final String getText()
```

Gets or sets the text of signature.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets the text of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFont()
```
public final SignatureFont getFont()
```

Gets or sets the font of signature.

**Returns:**
SignatureFont
##### setFont(SignatureFont value)
```
public final void setFont(SignatureFont value)
```

Gets or sets the font of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignatureFont |  |

##### getForeColor()
```
public Color getForeColor()
```

Gets or sets the fore color of signature.

**Returns:**
java.awt.Color
##### setForeColor(Color value)
```
public void setForeColor(Color value)
```

Gets or sets the fore color of signature.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Gets or sets the type of text signature implementation.

**Returns:**
int
##### setSignatureImplementation(int value)
```
public final void setSignatureImplementation(int value)
```

Gets or sets the type of text signature implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextHorizontalAlignment()
```
public final int getTextHorizontalAlignment()
```

Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see TextSignatureImplementation SignatureImplementation property).

**Returns:**
int
##### setTextHorizontalAlignment(int value)
```
public final void setTextHorizontalAlignment(int value)
```

Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see TextSignatureImplementation SignatureImplementation property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getTextVerticalAlignment()
```
public final int getTextVerticalAlignment()
```

Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

**Returns:**
int
##### setTextVerticalAlignment(int value)
```
public final void setTextVerticalAlignment(int value)
```

Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormTextFieldTitle()
```
public final String getFormTextFieldTitle()
```

Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.

**Returns:**
java.lang.String
##### setFormTextFieldTitle(String value)
```
public final void setFormTextFieldTitle(String value)
```

Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFormTextFieldType()
```
public final int getFormTextFieldType()
```

Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

**Returns:**
int
##### setFormTextFieldType(int value)
```
public final void setFormTextFieldType(int value)
```

Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getShapeType()
```
public final int getShapeType()
```

Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

**Returns:**
int
##### setShapeType(int value)
```
public final void setShapeType(int value)
```

Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureID()
```
public final int getSignatureID()
```

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

**Returns:**
int
##### setSignatureID(int value)
```
public final void setSignatureID(int value)
```

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getBorder()
```
public final Border getBorder()
```

Specify border settings

**Returns:**
Border
##### setBorder(Border value)
```
public final void setBorder(Border value)
```

Specify border settings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Border |  |

##### getBackground()
```
public final Background getBackground()
```

Gets or sets the signature background settings.

**Returns:**
Background
##### setBackground(Background value)
```
public final void setBackground(Background value)
```

Gets or sets the signature background settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Background |  |

##### getNative()
```
public final boolean getNative()
```

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

**Returns:**
boolean
##### setNative(boolean value)
```
public final void setNative(boolean value)
```

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getShapePosition()
```
public final int getShapePosition()
```

Defines where shape should be presented in the document layout

**Returns:**
int
##### setShapePosition(int value)
```
public final void setShapePosition(int value)
```

Defines where shape should be presented in the document layout

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### validate()
```
public void validate()
```

Internal method to validate the options parameters.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.verify
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify.md

The **GroupDocs.Signature.Options.Verify** namespace provides classes for working with Verification options

#### Classes

| Class | Description |
| --- | --- |
| BarcodeVerifyOptions | Represents the Barcode verify options. |
| CertificateVerifyOptions | Keeps options to verify certificate documents. |
| DigitalVerifyOptions | Keeps options to verify document Digital signature. |
| QrCodeVerifyOptions | Keeps options to verify document QR-code signature. |
| TextVerifyOptions | Keeps options to verify document Text signature. |
| VerifyOptions | Keeps options to verify document. |

### BarcodeVerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/barcodeverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions
```
public class BarcodeVerifyOptions extends TextVerifyOptions
```

Represents the Barcode verify options.

 **Learn more**  **Learn more**

 *  Basic usage of verification for Barcode electronic signature by GroupDocs.Signature: [How to eVerification Barcode signatures in a document ][How to eVerification Barcode signatures in a document]
 *  Advanced usage of settings of verification for Barcode electronic signature with GroupDocs.Signature: Advanced usage of eVerification Barcode signatures in a document and additional settings

[How to eVerification Barcode signatures in a document]: https://docs.groupdocs.com/signature/java/verify-barcode-signatures-in-the-document
#### Constructors

| Constructor | Description |
| --- | --- |
| BarcodeVerifyOptions() | Creates default Verification Option for Barcode Signature. |
| BarcodeVerifyOptions(String text) | Creates default Verification Option with verification text |
| BarcodeVerifyOptions(BarcodeType encodeType) | Creates default Verification Option with Barcode Type verification |
| BarcodeVerifyOptions(String text, BarcodeType encodeType) | Creates default Verification Option with Barcode Type verification and text |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets Barcode Type verification. |
| setEncodeType(BarcodeType value) | Gets or sets Barcode Type verification. |
| toString() | Overrides conversion to string. |
##### BarcodeVerifyOptions()
```
public BarcodeVerifyOptions()
```

Creates default Verification Option for Barcode Signature.

##### BarcodeVerifyOptions(String text)
```
public BarcodeVerifyOptions(String text)
```

Creates default Verification Option with verification text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text to verify |

##### BarcodeVerifyOptions(BarcodeType encodeType)
```
public BarcodeVerifyOptions(BarcodeType encodeType)
```

Creates default Verification Option with Barcode Type verification

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encodeType | BarcodeType | Barcode Type verification |

##### BarcodeVerifyOptions(String text, BarcodeType encodeType)
```
public BarcodeVerifyOptions(String text, BarcodeType encodeType)
```

Creates default Verification Option with Barcode Type verification and text

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Barcode text to verify |
| encodeType | BarcodeType | Barcode Type verification |

##### getEncodeType()
```
public final BarcodeType getEncodeType()
```

Gets or sets Barcode Type verification.

**Returns:**
BarcodeType
##### setEncodeType(BarcodeType value)
```
public final void setEncodeType(BarcodeType value)
```

Gets or sets Barcode Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | BarcodeType |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### CertificateVerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/certificateverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class CertificateVerifyOptions extends VerifyOptions
```

Keeps options to verify certificate documents.

#### Constructors

| Constructor | Description |
| --- | --- |
| CertificateVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values. |
| CertificateVerifyOptions(String subject) | Initializes a new instance of the CertificateVerifyOptions with subject to verify. |
#### Methods

| Method | Description |
| --- | --- |
| getIssuer() | Specify Certificate Issuer if it should be verified. |
| setIssuer(String value) | Specify Certificate Issuer if it should be verified. |
| getSerialNumber() | Specify Certificate Serial Number if it should be verified. |
| setSerialNumber(String value) | Specify Certificate Serial Number if it should be verified. |
| getSubject() | Specify Certificate subject if it should be verified. |
| setSubject(String value) | Specify Certificate subject if it should be verified. |
| getThumbprint() | Specify Certificate Thumbprint if it should be verified. |
| setThumbprint(String value) | Specify Certificate Thumbprint if it should be verified. |
| getMatchType() | Gets or sets Text Match Type verification. |
| setMatchType(int value) | Gets or sets Text Match Type verification. |
| getExpired() | Indicates if certificate is expired date due validation result. |
| setExpired(boolean value) | Indicates if certificate is expired date due validation result. |
| getPerformChainValidation() | Get or set if verification process should provide X.509 chain validation using basic validation policy. |
| setPerformChainValidation(boolean value) | Get or set if verification process should provide X.509 chain validation using basic validation policy. |
| toString() | Overrides conversion to string. |
##### CertificateVerifyOptions()
```
public CertificateVerifyOptions()
```

Initializes a new instance of the TextVerifyOptions with default values.

##### CertificateVerifyOptions(String subject)
```
public CertificateVerifyOptions(String subject)
```

Initializes a new instance of the CertificateVerifyOptions with subject to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subject | java.lang.String | Subject to be verified |

##### getIssuer()
```
public final String getIssuer()
```

Specify Certificate Issuer if it should be verified.

**Returns:**
java.lang.String
##### setIssuer(String value)
```
public final void setIssuer(String value)
```

Specify Certificate Issuer if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSerialNumber()
```
public final String getSerialNumber()
```

Specify Certificate Serial Number if it should be verified.

**Returns:**
java.lang.String
##### setSerialNumber(String value)
```
public final void setSerialNumber(String value)
```

Specify Certificate Serial Number if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Specify Certificate subject if it should be verified.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Specify Certificate subject if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getThumbprint()
```
public final String getThumbprint()
```

Specify Certificate Thumbprint if it should be verified.

**Returns:**
java.lang.String
##### setThumbprint(String value)
```
public final void setThumbprint(String value)
```

Specify Certificate Thumbprint if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Text Match Type verification.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Text Match Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getExpired()
```
public final boolean getExpired()
```

Indicates if certificate is expired date due validation result. Property is read-only.

**Returns:**
boolean
##### setExpired(boolean value)
```
public final void setExpired(boolean value)
```

Indicates if certificate is expired date due validation result. Property is read-only.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPerformChainValidation()
```
public final boolean getPerformChainValidation()
```

Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true.

**Returns:**
boolean
##### setPerformChainValidation(boolean value)
```
public final void setPerformChainValidation(boolean value)
```

Get or set if verification process should provide X.509 chain validation using basic validation policy. By default this value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### DigitalVerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/digitalverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class DigitalVerifyOptions extends VerifyOptions
```

Keeps options to verify document Digital signature.

[How to eVerification Digital signatures in a document]: https://docs.groupdocs.com/signature/java/verify-digital-signatures-in-the-document/
#### Constructors

| Constructor | Description |
| --- | --- |
| DigitalVerifyOptions() | Creates Digital Verification Option with default values. |
| DigitalVerifyOptions(String certificateGuid) | Creates Digital Verification Option with given digital certificate guid. |
| DigitalVerifyOptions(InputStream certificateStream) | Creates Digital Verification Option with given certificate stream. |
#### Methods

| Method | Description |
| --- | --- |
| getCertificate() | Get X509Certificate2 Certificate from Certificate Guid or Stream. |
| getPassword() | Password of Digital Certificate if required. |
| setPassword(String value) | Password of Digital Certificate if required. |
| getCertificateFilePath() | File Guid of Digital Certificate. |
| setCertificateFilePath(String value) | File Guid of Digital Certificate. |
| getCertificateStream() | Stream of Digital Certificate. |
| setCertificateStream(InputStream value) | Stream of Digital Certificate. |
| getComments() | Comments of Digital Signature to validate. |
| setComments(String value) | Comments of Digital Signature to validate. |
| getSignDateTimeFrom() | Date and time range of Digital Signature to validate. |
| setSignDateTimeFrom(Date value) | Date and time range of Digital Signature to validate. |
| getSignDateTimeTo() | Date and time range of Digital Signature to validate. |
| setSignDateTimeTo(Date value) | Date and time range of Digital Signature to validate. |
| getReason() | Reason of Digital Signature to validate. |
| setReason(String value) | Reason of Digital Signature to validate. |
| getContact() | Signature Contact to validate. |
| setContact(String value) | Signature Contact to validate. |
| getLocation() | Signature Location to validate. |
| setLocation(String value) | Signature Location to validate. |
| getSubjectName() | Subject distinguished name of the certificate to validate. |
| setSubjectName(String value) | Subject distinguished name of the certificate to validate. |
| getIssuerName() | Issuer name of the certificate to validate. |
| setIssuerName(String value) | Issuer name of the certificate to validate. |
##### DigitalVerifyOptions()
```
public DigitalVerifyOptions()
```

Creates Digital Verification Option with default values.

##### DigitalVerifyOptions(String certificateGuid)
```
public DigitalVerifyOptions(String certificateGuid)
```

Creates Digital Verification Option with given digital certificate guid.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateGuid | java.lang.String | File path to digital certificate. |

##### DigitalVerifyOptions(InputStream certificateStream)
```
public DigitalVerifyOptions(InputStream certificateStream)
```

Creates Digital Verification Option with given certificate stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| certificateStream | java.io.InputStream | Certificate's stream. |

##### getCertificate()
```
public KeyStore getCertificate()
```

Get X509Certificate2 Certificate from Certificate Guid or Stream.

**Returns:**
java.security.KeyStore
##### getPassword()
```
public final String getPassword()
```

Password of Digital Certificate if required.

**Returns:**
java.lang.String
##### setPassword(String value)
```
public final void setPassword(String value)
```

Password of Digital Certificate if required.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateFilePath()
```
public final String getCertificateFilePath()
```

File Guid of Digital Certificate.

**Returns:**
java.lang.String
##### setCertificateFilePath(String value)
```
public final void setCertificateFilePath(String value)
```

File Guid of Digital Certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getCertificateStream()
```
public final InputStream getCertificateStream()
```

Stream of Digital Certificate.

**Returns:**
java.io.InputStream
##### setCertificateStream(InputStream value)
```
public final void setCertificateStream(InputStream value)
```

Stream of Digital Certificate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.io.InputStream |  |

##### getComments()
```
public final String getComments()
```

Comments of Digital Signature to validate.

**Returns:**
java.lang.String
##### setComments(String value)
```
public final void setComments(String value)
```

Comments of Digital Signature to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignDateTimeFrom()
```
public Date getSignDateTimeFrom()
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeFrom(Date value)
```
public void setSignDateTimeFrom(Date value)
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getSignDateTimeTo()
```
public Date getSignDateTimeTo()
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Returns:**
java.util.Date
##### setSignDateTimeTo(Date value)
```
public void setSignDateTimeTo(Date value)
```

Date and time range of Digital Signature to validate. Nullable value will be ignored.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date |  |

##### getReason()
```
public final String getReason()
```

Reason of Digital Signature to validate.

**Returns:**
java.lang.String
##### setReason(String value)
```
public final void setReason(String value)
```

Reason of Digital Signature to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContact()
```
public final String getContact()
```

Signature Contact to validate.

**Returns:**
java.lang.String
##### setContact(String value)
```
public final void setContact(String value)
```

Signature Contact to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getLocation()
```
public final String getLocation()
```

Signature Location to validate.

**Returns:**
java.lang.String
##### setLocation(String value)
```
public final void setLocation(String value)
```

Signature Location to validate.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubjectName()
```
public final String getSubjectName()
```

Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value

**Returns:**
java.lang.String
##### setSubjectName(String value)
```
public final void setSubjectName(String value)
```

Subject distinguished name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature subject name contains or equals passed value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIssuerName()
```
public final String getIssuerName()
```

Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature's issuer name contains or equals passed value

**Returns:**
java.lang.String
##### setIssuerName(String value)
```
public final void setIssuerName(String value)
```

Issuer name of the certificate to validate. Value is case sensitive. If this property is set verification will check if Signature's issuer name contains or equals passed value

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### QrCodeVerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/qrcodeverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions, com.groupdocs.signature.options.verify.TextVerifyOptions
```
public class QrCodeVerifyOptions extends TextVerifyOptions
```

Keeps options to verify document QR-code signature.

[How to eVerification QR-code signatures in a document]: https://docs.groupdocs.com/signature/java/verify-qr-code-signatures-in-the-document/
[Advanced usage of eVerification QR-code signatures in a document and additional settings]: https://docs.groupdocs.com/signature/java/verify-qr-code-signatures/
#### Constructors

| Constructor | Description |
| --- | --- |
| QrCodeVerifyOptions() | Creates verification option QRCodeVerifyOptions for QR-Code Signatures. |
| QrCodeVerifyOptions(String text) | Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify. |
| QrCodeVerifyOptions(String text, QrCodeType encodeType) | Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify. |
#### Methods

| Method | Description |
| --- | --- |
| getEncodeType() | Gets or sets QR-code Type verification. |
| setEncodeType(QrCodeType value) | Gets or sets QR-code Type verification. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties. |
| toString() | Overrides conversion to string. |
##### QrCodeVerifyOptions()
```
public QrCodeVerifyOptions()
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures.

##### QrCodeVerifyOptions(String text)
```
public QrCodeVerifyOptions(String text)
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with QR-Code text to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | QR-code Text to verify |

##### QrCodeVerifyOptions(String text, QrCodeType encodeType)
```
public QrCodeVerifyOptions(String text, QrCodeType encodeType)
```

Creates verification option QRCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified |
| encodeType | QrCodeType | Type of encoding |

##### getEncodeType()
```
public final QrCodeType getEncodeType()
```

Gets or sets QR-code Type verification. This property is optional.

**Returns:**
QrCodeType
##### setEncodeType(QrCodeType value)
```
public final void setEncodeType(QrCodeType value)
```

Gets or sets QR-code Type verification. This property is optional.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | QrCodeType |  |

##### getDataEncryption()
```
public final IDataEncryption getDataEncryption()
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

**Returns:**
IDataEncryption
##### setDataEncryption(IDataEncryption value)
```
public final void setDataEncryption(IDataEncryption value)
```

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text properties.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IDataEncryption |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### TextVerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/textverifyoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verify.VerifyOptions
```
public class TextVerifyOptions extends VerifyOptions
```

Keeps options to verify document Text signature.

[How to eVerification QR-code signatures in a document]: https://docs.groupdocs.com/signature/java/verify-text-signatures-in-the-document/
[Advanced usage of eVerification Barcode signatures in a document and additional settings]: https://docs.groupdocs.com/signature/java/verify-text-signatures/
#### Constructors

| Constructor | Description |
| --- | --- |
| TextVerifyOptions() | Initializes a new instance of the TextVerifyOptions with default values. |
| TextVerifyOptions(String text) | Initializes a new instance of the TextVerifyOptions with verification text. |
| TextVerifyOptions(String text, int implementation) | Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Specify Signature Text if it should be verified. |
| setText(String value) | Specify Signature Text if it should be verified. |
| getMatchType() | Gets or sets Text Match Type verification. |
| setMatchType(int value) | Gets or sets Text Match Type verification. |
| getSignatureImplementation() | Type of Signature to be verified. |
| setSignatureImplementation(int value) | Type of Signature to be verified. |
| getFormTextFieldTitle() | Gets or sets the title of form field to verify it. |
| setFormTextFieldTitle(String value) | Gets or sets the title of form field to verify it. |
| getFormTextFieldType() | Gets or sets the type of form field to verify it. |
| setFormTextFieldType(Integer value) | Gets or sets the type of form field to verify it. |
| getSignatureID() | Specify Text Signature ID more than zero if it should be verified. |
| setSignatureID(int value) | Specify Text Signature ID more than zero if it should be verified. |
| toString() | Overrides conversion to string. |
##### TextVerifyOptions()
```
public TextVerifyOptions()
```

Initializes a new instance of the TextVerifyOptions with default values.

##### TextVerifyOptions(String text)
```
public TextVerifyOptions(String text)
```

Initializes a new instance of the TextVerifyOptions with verification text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified |

##### TextVerifyOptions(String text, int implementation)
```
public TextVerifyOptions(String text, int implementation)
```

Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | Text to be verified. |
| implementation | int | Signature Implementation type. |

##### getText()
```
public final String getText()
```

Specify Signature Text if it should be verified.

**Returns:**
java.lang.String
##### setText(String value)
```
public final void setText(String value)
```

Specify Signature Text if it should be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getMatchType()
```
public final int getMatchType()
```

Gets or sets Text Match Type verification.

**Returns:**
int
##### setMatchType(int value)
```
public final void setMatchType(int value)
```

Gets or sets Text Match Type verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getSignatureImplementation()
```
public final int getSignatureImplementation()
```

Type of Signature to be verified.

**Returns:**
int
##### setSignatureImplementation(int value)
```
public final void setSignatureImplementation(int value)
```

Type of Signature to be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getFormTextFieldTitle()
```
public final String getFormTextFieldTitle()
```

Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields.

**Returns:**
java.lang.String
##### setFormTextFieldTitle(String value)
```
public final void setFormTextFieldTitle(String value)
```

Gets or sets the title of form field to verify it. If this property set text will be found only in text form fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFormTextFieldType()
```
public final Integer getFormTextFieldType()
```

Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields.

**Returns:**
java.lang.Integer
##### setFormTextFieldType(Integer value)
```
public final void setFormTextFieldType(Integer value)
```

Gets or sets the type of form field to verify it. If this property set text will be found only in text form fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getSignatureID()
```
public final int getSignatureID()
```

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

**Returns:**
int
##### setSignatureID(int value)
```
public final void setSignatureID(int value)
```

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### VerifyOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verify/verifyoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class VerifyOptions
```

Keeps options to verify document.
#### Methods

| Method | Description |
| --- | --- |
| isValid() | Valid property flag. |
| setValid(boolean value) | Valid property flag. |
| getPageNumber() | Document Page Number to be verified. |
| setPageNumber(Integer value) | Document Page Number to be verified. |
| getPagesSetup() | Page Options to specify pages to be verified. |
| setPagesSetup(PagesSetup value) | Page Options to specify pages to be verified. |
| getAllPages() | Flag to verify each document page. |
| setAllPages(boolean value) | Flag to verify each document page. |
| getExtensions() | Additional extensions for alternative signature options verification. |
| setExtensions(VerifyExtensions value) | Additional extensions for alternative signature options verification. |
| toString() | Override string conversion. |
##### isValid()
```
public final boolean isValid()
```

Valid property flag.

**Returns:**
boolean
##### setValid(boolean value)
```
public final void setValid(boolean value)
```

Valid property flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPageNumber()
```
public Integer getPageNumber()
```

Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1.

**Returns:**
java.lang.Integer
##### setPageNumber(Integer value)
```
public void setPageNumber(Integer value)
```

Document Page Number to be verified. If property is not set - all Pages of Document will be verified for first occurrence. Minimal value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### getPagesSetup()
```
public PagesSetup getPagesSetup()
```

Page Options to specify pages to be verified.

**Returns:**
PagesSetup
##### setPagesSetup(PagesSetup value)
```
public void setPagesSetup(PagesSetup value)
```

Page Options to specify pages to be verified.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup |  |

##### getAllPages()
```
public final boolean getAllPages()
```

Flag to verify each document page. By default value is true.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public final void setAllPages(boolean value)
```

Flag to verify each document page. By default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getExtensions()
```
public final VerifyExtensions getExtensions()
```

Additional extensions for alternative signature options verification.

**Returns:**
VerifyExtensions
##### setExtensions(VerifyExtensions value)
```
public final void setExtensions(VerifyExtensions value)
```

Additional extensions for alternative signature options verification.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | VerifyExtensions |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options.verifyextensions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verifyextensions.md

The **GroupDocs.Signature.Options.VerifyExtensions** namespace provides classes for working with VerifyExtensions options.

#### Classes

| Class | Description |
| --- | --- |
| PdfTextAnnotationVerifyExtensions | Describes extensions of verification of PDF text annotation object |
| PdfTextStickerVerifyExtensions | Describes extensions of verification of PDF sticker object. |
| VerifyExtensions | Keeps additional verification options for alternative implementations of signature on a document page. |

### PdfTextAnnotationVerifyExtensions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verifyextensions/pdftextannotationverifyextensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verifyextensions.VerifyExtensions
```
public class PdfTextAnnotationVerifyExtensions extends VerifyExtensions
```

Describes extensions of verification of PDF text annotation object
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextAnnotationVerifyExtensions() | Creates PDF text annotation signature verification extensions with empty values. |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Title of text annotation to be verified. |
| setTitle(String value) | Title of text annotation to be verified. |
| getSubject() | Subject of text annotation to be verified. |
| setSubject(String value) | Subject of text annotation to be verified. |
| getContents() | Contents of text annotationn to be verified. |
| setContents(String value) | Contents of text annotationn to be verified. |
| toString() | Override string conversion. |
##### PdfTextAnnotationVerifyExtensions()
```
public PdfTextAnnotationVerifyExtensions()
```

Creates PDF text annotation signature verification extensions with empty values.

##### getTitle()
```
public final String getTitle()
```

Title of text annotation to be verified. Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Title of text annotation to be verified. Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Subject of text annotation to be verified. Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Subject of text annotation to be verified. Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Contents of text annotationn to be verified. Not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Contents of text annotationn to be verified. Not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### PdfTextStickerVerifyExtensions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verifyextensions/pdftextstickerverifyextensions.md

**Inheritance:**
java.lang.Object, com.groupdocs.signature.options.verifyextensions.VerifyExtensions
```
public final class PdfTextStickerVerifyExtensions extends VerifyExtensions
```

Describes extensions of verification of PDF sticker object.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextStickerVerifyExtensions() | Creates PDF text sticker signature verification extensions with empty values. |
#### Methods

| Method | Description |
| --- | --- |
| getTitle() | Title of sticker to be verified. |
| setTitle(String value) | Title of sticker to be verified. |
| getSubject() | Subject of sticker to be verified. |
| setSubject(String value) | Subject of sticker to be verified. |
| getContents() | Contents of sticker to be verified. |
| setContents(String value) | Contents of sticker to be verified. |
| getIcon() | Icon of sticker to be verified. |
| setIcon(Integer value) | Icon of sticker to be verified. |
| toString() | Override string conversion |
##### PdfTextStickerVerifyExtensions()
```
public PdfTextStickerVerifyExtensions()
```

Creates PDF text sticker signature verification extensions with empty values.

##### getTitle()
```
public final String getTitle()
```

Title of sticker to be verified. Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setTitle(String value)
```
public final void setTitle(String value)
```

Title of sticker to be verified. Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSubject()
```
public final String getSubject()
```

Subject of sticker to be verified. Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setSubject(String value)
```
public final void setSubject(String value)
```

Subject of sticker to be verified. Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getContents()
```
public final String getContents()
```

Contents of sticker to be verified. Value will not be verified if equals empty string or null.

**Returns:**
java.lang.String
##### setContents(String value)
```
public final void setContents(String value)
```

Contents of sticker to be verified. Value will not be verified if equals empty string or null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getIcon()
```
public final Integer getIcon()
```

Icon of sticker to be verified. Value will not be verified if equals null.

**Returns:**
java.lang.Integer
##### setIcon(Integer value)
```
public final void setIcon(Integer value)
```

Icon of sticker to be verified. Value will not be verified if equals null.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Integer |  |

##### toString()
```
public String toString()
```

Override string conversion

**Returns:**
java.lang.String -

### VerifyExtensions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.verifyextensions/verifyextensions.md

**Inheritance:**
java.lang.Object
```
public abstract class VerifyExtensions
```

Keeps additional verification options for alternative implementations of signature on a document page.
#### Constructors

| Constructor | Description |
| --- | --- |
| VerifyExtensions() | Creates default Verify Extensions. |
#### Methods

| Method | Description |
| --- | --- |
| toString() | Override string conversion. |
##### VerifyExtensions()
```
public VerifyExtensions()
```

Creates default Verify Extensions.

##### toString()
```
public String toString()
```

Override string conversion.

**Returns:**
java.lang.String -

### com.groupdocs.signature.options
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options.md

The **GroupDocs.Signature.Options** namespace provides classes to specify additional options when loading, signing, verifyin, searching and saving documents.

#### Classes

| Class | Description |
| --- | --- |
| PagesSetup | Describes special document pages to work with. |
| PreviewSignatureFormats |  |
| PreviewSignatureOptions | Represents signature preview options. |

#### Interfaces

| Interface | Description |
| --- | --- |
| PageSignatureStreamFactory |  |
| PageStreamFactory |  |

### PageSignatureStreamFactory
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options/pagesignaturestreamfactory.md

### PagesSetup
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options/pagessetup.md

**Inheritance:**
java.lang.Object
```
public class PagesSetup
```

Describes special document pages to work with.
#### Constructors

| Constructor | Description |
| --- | --- |
| PagesSetup() | Creates PagesSetup with default options. |
#### Methods

| Method | Description |
| --- | --- |
| getFirstPage() | Gets or sets flag to use first document page. |
| setFirstPage(boolean value) | Gets or sets flag to use first document page. |
| getLastPage() | Gets or sets flag to use last document page. |
| setLastPage(boolean value) | Gets or sets flag to use last document page. |
| getOddPages() | Gets or sets flag to use odd pages of document. |
| setOddPages(boolean value) | Gets or sets flag to use odd pages of document. |
| getEvenPages() | Gets or sets flag to use even pages of document. |
| setEvenPages(boolean value) | Gets or sets flag to use even pages of document. |
| getPageNumbers() | Set arbitrary pages of document to use. |
| setPageNumbers(List<Integer> value) | Set arbitrary pages of document to use. |
| toString() | Overrides conversion to string. |
##### PagesSetup()
```
public PagesSetup()
```

Creates PagesSetup with default options.

##### getFirstPage()
```
public final boolean getFirstPage()
```

Gets or sets flag to use first document page.

**Returns:**
boolean
##### setFirstPage(boolean value)
```
public final void setFirstPage(boolean value)
```

Gets or sets flag to use first document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLastPage()
```
public final boolean getLastPage()
```

Gets or sets flag to use last document page.

**Returns:**
boolean
##### setLastPage(boolean value)
```
public final void setLastPage(boolean value)
```

Gets or sets flag to use last document page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOddPages()
```
public final boolean getOddPages()
```

Gets or sets flag to use odd pages of document.

**Returns:**
boolean
##### setOddPages(boolean value)
```
public final void setOddPages(boolean value)
```

Gets or sets flag to use odd pages of document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEvenPages()
```
public final boolean getEvenPages()
```

Gets or sets flag to use even pages of document.

**Returns:**
boolean
##### setEvenPages(boolean value)
```
public final void setEvenPages(boolean value)
```

Gets or sets flag to use even pages of document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPageNumbers()
```
public final List<Integer> getPageNumbers()
```

Set arbitrary pages of document to use.

**Returns:**
java.util.List<java.lang.Integer>
##### setPageNumbers(List<Integer> value)
```
public final void setPageNumbers(List<Integer> value)
```

Set arbitrary pages of document to use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.Integer> |  |

##### toString()
```
public String toString()
```

Overrides conversion to string.

**Returns:**
java.lang.String -

### PageStreamFactory
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options/pagestreamfactory.md

### PreviewSignatureFormats
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options/previewsignatureformats.md

**Inheritance:**
java.lang.Object
```
public class PreviewSignatureFormats
```
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewSignatureFormats() |  |
#### Fields

| Field | Description |
| --- | --- |
| PNG | PNG |
| JPEG | JPEG |
| BMP | BMP |
| GIF | GIF |
| SVG | SVG |
#### Methods

| Method | Description |
| --- | --- |
| toExtension(int id) | To extension string. |
##### PreviewSignatureFormats()
```
public PreviewSignatureFormats()
```

##### PNG
```
public static final int PNG
```

PNG

##### JPEG
```
public static final int JPEG
```

JPEG

##### BMP
```
public static final int BMP
```

BMP

##### GIF
```
public static final int GIF
```

GIF

##### SVG
```
public static final int SVG
```

SVG

##### toExtension(int id)
```
public static String toExtension(int id)
```

To extension string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | int |  |

**Returns:**
java.lang.String - the string

### PreviewSignatureOptions
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.options/previewsignatureoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewSignatureOptions
```

Represents signature preview options.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory) | Initializes PreviewSignatureOptions object. |
#### Methods

| Method | Description |
| --- | --- |
| getSignatureId() | Unique value to distinct the signature. |
| setSignatureId(String value) | Unique value to distinct the signature. |
| getSignOptions() | Signature Options for generate preview. |
| setSignOptions(SignOptions value) | Signature Options for generate preview. |
| getPreviewFormat() | Gets or sets preview images format. |
| setPreviewFormat(int value) | Gets or sets preview images format. |
##### PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
```
public PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
```

Initializes PreviewSignatureOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signOptions | SignOptions | The signature options to generate preview for. |
| pageStreamFactory | PageSignatureStreamFactory | Interface which defines method to create output page preview stream. |

##### getSignatureId()
```
public final String getSignatureId()
```

Unique value to distinct the signature. Use SignatureId to identify the preview options.

**Returns:**
java.lang.String
##### setSignatureId(String value)
```
public final void setSignatureId(String value)
```

Unique value to distinct the signature. Use SignatureId to identify the preview options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getSignOptions()
```
public final SignOptions getSignOptions()
```

Signature Options for generate preview.

**Returns:**
SignOptions
##### setSignOptions(SignOptions value)
```
public final void setSignOptions(SignOptions value)
```

Signature Options for generate preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SignOptions |  |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Gets or sets preview images format. Default value is PNG

**Returns:**
int
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Gets or sets preview images format. Default value is PNG

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

### com.groupdocs.signature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature.md

The **GroupDocs.Signature** namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.

#### Classes

| Class | Description |
| --- | --- |
| Signature | Represents main class that controls document signing process. |
| SignatureSettings | Defines settings for customizing Signature behavior. |

### Signature
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature/signature.md

**Inheritance:**
java.lang.Object
```
public class Signature
```

Represents main class that controls document signing process.

[GroupDocs.Signature Developer Guide]: https://docs.groupdocs.com/display/signaturenet/Developer+Guide
#### Constructors

| Constructor | Description |
| --- | --- |
| Signature(InputStream document) | Initializes new instance of Signature class with document provided by stream. |
| Signature(InputStream document, LoadOptions loadOptions) | Initializes new instance of Signature class with document provided by stream and load options  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)). |
| Signature(InputStream document, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by stream and SignatureSettings. |
| Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by stream, load options  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and settings SignatureSettings. |
| Signature(String filePath) | Initializes new instance of Signature class instance with document provided by file path. |
| Signature(String filePath, LoadOptions loadOptions) | Initializes new instance of Signature class instance with document provided by file path and  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)). |
| Signature(String filePath, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by file path and SignatureSettings. |
| Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings) | Initializes new instance of Signature class instance with document provided by file path,  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and SignatureSettings. |
#### Methods

| Method | Description |
| --- | --- |
| sign(OutputStream document, SignOptions signOptions) | Signs document with SignOptions and saves result to a stream. |
| sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions) | Signs document with SignOptions and saves result to a stream with predefined SaveOptions. |
| sign(OutputStream document, List<SignOptions> signOptionsList) | Signs document with collection of SignOptions and saves result to a stream. |
| sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions) | Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions. |
| sign(String filePath, SignOptions signOptions) | Signs document with SignOptions and saves result to specified file path. |
| sign(String filePath, SignOptions signOptions, SaveOptions saveOptions) | Signs document with SignOptions and saves result to specified file path with predefined SaveOptions. |
| sign(String filePath, List<SignOptions> signOptionsList) | Signs document with collection of SignOptions and saves result to specified file path. |
| sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions) | Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions. |
| verify(VerifyOptions verifyOptions) | Verifies the document signatures with given VerifyOptions data. |
| verify(List<VerifyOptions> verifyOptionsList) | Verifies the document signatures with list of VerifyOptions data. |
| getDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| generatePreview(PreviewOptions previewOptions) | Generates document pages preview. |
| search(List<SearchOptions> searchOptionsList) | Searches for signatures in a document by SearchOptions list. |
| <T>search(Class<T> typeOfT, SearchOptions searchOptions) | Searches for signatures in a document by SearchOptions options. |
| <T>search(Class<T> typeOfT, int signatureType) | Searches for exact type of signatures in the document by SignatureType value. |
| search(int[] signatureTypes) | Searches for specified signature types in the document by SignatureType value. |
| update(OutputStream document, BaseSignature signature) | Updates passed signature BaseSignature in the document. |
| update(OutputStream document, List<BaseSignature> signatures) | Updates passed signatures BaseSignature in the document. |
| update(String filePath, List<BaseSignature> signatures) | Updates passed signatures BaseSignature in the document. |
| update(String filePath, BaseSignature signature) | Updates passed signatures BaseSignature in the document. |
| delete(OutputStream document, BaseSignature signature) | Deletes passed signature BaseSignature from the document. |
| delete(OutputStream document, List<BaseSignature> signatures) | Deletes passed list of signatures BaseSignature from the document. |
| delete(String filePath, BaseSignature signature) | Deletes passed signature BaseSignature from the document. |
| delete(String filePath, List<BaseSignature> signatures) | Deletes passed list of signatures BaseSignature from the document. |
| delete(OutputStream document, int signatureType) | Deletes signatures of the certain type SignatureType from the document. |
| deleteByTypes(OutputStream document, List<Integer> signatureTypes) | Deletes the signatures of the certain types list SignatureType from the document. |
| delete(String filePath, int signatureType) | Deletes signatures of the certain type SignatureType from the document. |
| deleteByTypes(String filePath, List<Integer> signatureTypes) | Deletes the signatures of the certain types list SignatureType from the document. |
| delete(String signatureId) | Deletes signature by its specific signature Id from the document. |
| delete(List<String> signatureIds) | Deletes passed list of signatures BaseSignature from the document. |
| generateSignaturePreview(PreviewSignatureOptions previewOptions) | Generates Signature preview based on given SignOptions. |
| dispose() | Implement IDisposable interface to clean up internal resources |
##### Signature(InputStream document)
```
public Signature(InputStream document)
```

Initializes new instance of Signature class with document provided by stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/ |

##### Signature(InputStream document, LoadOptions loadOptions)
```
public Signature(InputStream document, LoadOptions loadOptions)
```

Initializes new instance of Signature class with document provided by stream and load options  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream. |
| loadOptions | LoadOptions | The document load options.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/
[Load and eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/loading/ |

##### Signature(InputStream document, SignatureSettings settings)
```
public Signature(InputStream document, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by stream and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream. |
| settings | SignatureSettings | The signature settings.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/ |

##### Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings)
```
public Signature(InputStream document, LoadOptions loadOptions, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by stream, load options  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and settings SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The document content stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | SignatureSettings | The signature settings.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/
[Load and eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/loading/ |

##### Signature(String filePath)
```
public Signature(String filePath)
```

Initializes new instance of Signature class instance with document provided by file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/ |

##### Signature(String filePath, LoadOptions loadOptions)
```
public Signature(String filePath, LoadOptions loadOptions)
```

Initializes new instance of Signature class instance with document provided by file path and  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path. |
| loadOptions | LoadOptions | The document load options.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/
[Load and eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/loading/ |

##### Signature(String filePath, SignatureSettings settings)
```
public Signature(String filePath, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by file path and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path. |
| settings | SignatureSettings | The signature settings.

##### Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings)
```
public Signature(String filePath, LoadOptions loadOptions, SignatureSettings settings)
```

Initializes new instance of Signature class instance with document provided by file path,  LoadOptions (\#getLoadOptions.getLoadOptions/\#setLoadOptions(LoadOptions).setLoadOptions(LoadOptions)) and SignatureSettings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | Absolute or relative file path. |
| loadOptions | LoadOptions | The document load options. |
| settings | SignatureSettings | The signature settings.

[Document formats supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/supported-document-formats/
[Developer Guide]: https://docs.groupdocs.com/signature/java/developer-guide/ |

##### sign(OutputStream document, SignOptions signOptions)
```
public final SignResult sign(OutputStream document, SignOptions signOptions)
```

Signs document with SignOptions and saves result to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signOptions | SignOptions | The signature options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions)
```
public final SignResult sign(OutputStream document, SignOptions signOptions, SaveOptions saveOptions)
```

Signs document with SignOptions and saves result to a stream with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signOptions | SignOptions | The signature options. |
| saveOptions | SaveOptions | The save options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/
[How to customize electronically signed documents on save using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/saving/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(OutputStream document, List<SignOptions> signOptionsList)
```
public final SignResult sign(OutputStream document, List<SignOptions> signOptionsList)
```

Signs document with collection of SignOptions and saves result to a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```
public final SignResult sign(OutputStream document, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options. |
| saveOptions | SaveOptions | The save options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/
[How to customize electronically signed documents on save using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/saving/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(String filePath, SignOptions signOptions)
```
public final SignResult sign(String filePath, SignOptions signOptions)
```

Signs document with SignOptions and saves result to specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signOptions | SignOptions | The signature options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(String filePath, SignOptions signOptions, SaveOptions saveOptions)
```
public final SignResult sign(String filePath, SignOptions signOptions, SaveOptions saveOptions)
```

Signs document with SignOptions and saves result to specified file path with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signOptions | SignOptions | The signature options. |
| saveOptions | SaveOptions | The save options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/
[How to customize electronically signed documents on save using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/saving/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### sign(String filePath, List<SignOptions> signOptionsList)
```
public final SignResult sign(String filePath, List<SignOptions> signOptionsList)
```

Signs document with collection of SignOptions and saves result to specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/ |

**Returns:**
SignResult -
##### sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```
public final SignResult sign(String filePath, List<SignOptions> signOptionsList, SaveOptions saveOptions)
```

Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signOptionsList | java.util.List<com.groupdocs.signature.options.sign.SignOptions> | The list of signature options. |
| saveOptions | SaveOptions | The save options.

[Electronic signature types supported by GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/electronic-signature-types/
[How to eSign documents using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/signing/
[How to customize electronically signed documents on save using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/saving/ |

**Returns:**
SignResult - Returns instance of SignResult with list of newly created signatures.
##### verify(VerifyOptions verifyOptions)
```
public final VerificationResult verify(VerifyOptions verifyOptions)
```

Verifies the document signatures with given VerifyOptions data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptions | VerifyOptions | The signature verification options.

[How to verify document is electronically signed in Java]: https://docs.groupdocs.com/signature/java/verify-document-for-signatures/ |

**Returns:**
VerificationResult - Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.
##### verify(List<VerifyOptions> verifyOptionsList)
```
public final VerificationResult verify(List<VerifyOptions> verifyOptionsList)
```

Verifies the document signatures with list of VerifyOptions data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verifyOptionsList | java.util.List<com.groupdocs.signature.options.verify.VerifyOptions> | The signature verification options collection. Instance of VerifyOptionsCollection.

[How to verify document is electronically signed in Java]: https://docs.groupdocs.com/signature/java/verify-document-for-signatures/ |

**Returns:**
VerificationResult - Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.
##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

**Returns:**
IDocumentInfo - Information about document.

[How to get document properties in Java]: https://docs.groupdocs.com/signature/java/get-document-information/
##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Generates document pages preview.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | The preview options.

[How to generate document pages preview using GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/generate-document-pages-preview/ |

##### search(List<SearchOptions> searchOptionsList)
```
public final SearchResult search(List<SearchOptions> searchOptionsList)
```

Searches for signatures in a document by SearchOptions list.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchOptionsList | java.util.List<com.groupdocs.signature.options.search.SearchOptions> | The search options collection.

[How to search for electronic signatures inside document using Java]: https://docs.groupdocs.com/signature/java/search-for-electronic-signatures-in-document/
[Advanced use cases of electronic signatures search with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/searching/ |

**Returns:**
SearchResult - Returns instance of SearchResult with list of found Signatures.
##### <T>search(Class<T> typeOfT, SearchOptions searchOptions)
```
public final List<T> <T>search(Class<T> typeOfT, SearchOptions searchOptions)
```

Searches for signatures in a document by SearchOptions options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| searchOptions | SearchOptions | The search options.

[How to search for electronic signatures inside document using Java]: https://docs.groupdocs.com/signature/java/search-for-electronic-signatures-in-document/
[Advanced use cases of electronic signatures search with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/searching/ |

**Returns:**
java.util.List<T> - Returns the list of signatures found.
##### <T>search(Class<T> typeOfT, int signatureType)
```
public final List<T> <T>search(Class<T> typeOfT, int signatureType)
```

Searches for exact type of signatures in the document by SignatureType value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| typeOfT | java.lang.Class<T> |  |
| signatureType | int | The type of signatures to search.

[How to search for electronic signatures inside document using Java]: https://docs.groupdocs.com/signature/java/search-for-electronic-signatures-in-document/
[Advanced use cases of electronic signatures search with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/searching/ |

**Returns:**
java.util.List<T> - Returns the list of found signatures with exact type.
##### search(int[] signatureTypes)
```
public final SearchResult search(int[] signatureTypes)
```

Searches for specified signature types in the document by SignatureType value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureTypes | int[] | One or several types of signatures to find.

[How to search for electronic signatures inside document using Java]: https://docs.groupdocs.com/signature/java/search-for-electronic-signatures-in-document/
[Advanced use cases of electronic signatures search with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/searching/ |

**Returns:**
SearchResult - Returns instance of SearchResult with list of found signatures.
##### update(OutputStream document, BaseSignature signature)
```
public final boolean update(OutputStream document, BaseSignature signature)
```

Updates passed signature BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signature | BaseSignature | Signature object to be updated in the document.

[How to update document eSignatures in Java]: https://docs.groupdocs.com/signature/java/update-signatures-in-documents/
[Advanced use cases of electronic signatures update with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/updating/ |

**Returns:**
boolean - Returns true if operation was successful.
##### update(OutputStream document, List<BaseSignature> signatures)
```
public final UpdateResult update(OutputStream document, List<BaseSignature> signatures)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to update in the document.

[How to update document eSignatures in Java]: https://docs.groupdocs.com/signature/java/update-signatures-in-documents/
[Advanced use cases of electronic signatures update with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/updating/ |

**Returns:**
UpdateResult - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.
##### update(String filePath, List<BaseSignature> signatures)
```
public final UpdateResult update(String filePath, List<BaseSignature> signatures)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to update in the document.

[How to update document eSignatures in Java]: https://docs.groupdocs.com/signature/java/update-signatures-in-documents/
[Advanced use cases of electronic signatures update with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/updating/ |

**Returns:**
UpdateResult - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.
##### update(String filePath, BaseSignature signature)
```
public final boolean update(String filePath, BaseSignature signature)
```

Updates passed signatures BaseSignature in the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signature | BaseSignature | Signature object to be updated in the document.

[How to update document eSignatures in Java]: https://docs.groupdocs.com/signature/java/update-signatures-in-documents/
[Advanced use cases of electronic signatures update with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/updating/ |

**Returns:**
boolean - Returns UpdateResult UpdateResult with list of successfully updated signatures and failed ones.
##### delete(OutputStream document, BaseSignature signature)
```
public final boolean delete(OutputStream document, BaseSignature signature)
```

Deletes passed signature BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signature | BaseSignature | Signature object to be removed from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
boolean - Returns true if operation was successful.
##### delete(OutputStream document, List<BaseSignature> signatures)
```
public final DeleteResult delete(OutputStream document, List<BaseSignature> signatures)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to remove from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### delete(String filePath, BaseSignature signature)
```
public final boolean delete(String filePath, BaseSignature signature)
```

Deletes passed signature BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signature | BaseSignature | Signature object to be removed from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
boolean - Returns true if operation was successful.
##### delete(String filePath, List<BaseSignature> signatures)
```
public final DeleteResult delete(String filePath, List<BaseSignature> signatures)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signatures | java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature> | List of signatures to remove from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### delete(OutputStream document, int signatureType)
```
public final DeleteResult delete(OutputStream document, int signatureType)
```

Deletes signatures of the certain type SignatureType from the document. Only signatures that were added by Sign method and marked as Signatures  BaseSignature.isSignature() (BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signatureType | int | The type of signatures to be removed from the document.

[How to delete eSignatures with specific type from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete+signatures+of+the+certain+type/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### deleteByTypes(OutputStream document, List<Integer> signatureTypes)
```
public final DeleteResult deleteByTypes(OutputStream document, List<Integer> signatureTypes)
```

Deletes the signatures of the certain types list SignatureType from the document. Only signatures that were added by Sign method and marked as Signatures  BaseSignature.isSignature() (BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The output document stream. |
| signatureTypes | java.util.List<java.lang.Integer> | The list of signatures types to be removed from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### delete(String filePath, int signatureType)
```
public final DeleteResult delete(String filePath, int signatureType)
```

Deletes signatures of the certain type SignatureType from the document. Only signatures that were added by Sign method and marked as Signatures  BaseSignature.isSignature() (BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signatureType | int | The type of signatures to be removed from the document.

[How to delete eSignatures with specific type from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/net/delete+signatures+of+the+certain+types/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### deleteByTypes(String filePath, List<Integer> signatureTypes)
```
public final DeleteResult deleteByTypes(String filePath, List<Integer> signatureTypes)
```

Deletes the signatures of the certain types list SignatureType from the document. Only signatures that were added by Sign method and marked as Signatures  BaseSignature.isSignature() (BaseSignature.isSignature/BaseSignature.setSignature(boolean)) will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The output file path. |
| signatureTypes | java.util.List<java.lang.Integer> | The list of signatures types to be removed from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/delete-signatures-from-documents/
[How to delete different types of eSignatures from document in Java]: https://docs.groupdocs.com/signature/java/deleting/ |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### delete(String signatureId)
```
public final boolean delete(String signatureId)
```

Deletes signature by its specific signature Id from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureId | java.lang.String | The Id of the signature to be removed from the document.

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/Delete+signatures+from+documents
[How to delete different types of eSignatures from document in C]: https://docs.groupdocs.com/signature/java/Deleting |

**Returns:**
boolean - Returns true if operation was successful.
##### delete(List<String> signatureIds)
```
public final DeleteResult delete(List<String> signatureIds)
```

Deletes passed list of signatures BaseSignature from the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| signatureIds | java.util.List<java.lang.String> | List of the identifiers of the signatures to be removed from the document.

**Learn more** ///  ///  /// More about how to delete electronic signature from document in Java: /// [How to delete eSignature from document with GroupDocs.Signature][] ///  ///  /// Advanced use cases of deleting document eSignatures: /// [How to delete different types of eSignatures from document in C\#][How to delete different types of eSignatures from document in C] ///  ///  ///

[How to delete eSignature from document with GroupDocs.Signature]: https://docs.groupdocs.com/signature/java/Delete+signatures+from+documents
[How to delete different types of eSignatures from document in C]: https://docs.groupdocs.com/signature/java/Deleting |

**Returns:**
DeleteResult - Returns DeleteResult DeleteResult with list of successfully deleted signatures and failed ones.
##### generateSignaturePreview(PreviewSignatureOptions previewOptions)
```
public static void generateSignaturePreview(PreviewSignatureOptions previewOptions)
```

Generates Signature preview based on given SignOptions. SignOptions

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewSignatureOptions | The preview signature with given SignOptions. PreviewSignatureOptions

##### dispose()
```
public final void dispose()
```

Implement IDisposable interface to clean up internal resources

### SignatureSettings
Path: https://reference.groupdocs.com/signature/nodejs-java/com.groupdocs.signature/signaturesettings.md

**Inheritance:**
java.lang.Object
```
public class SignatureSettings
```

Defines settings for customizing Signature behavior.
#### Constructors

| Constructor | Description |
| --- | --- |
| SignatureSettings() | Creates default SignatureSettings instance with default values. |
| SignatureSettings(ILogger logger) | Creates default SignatureSettings instance with the Logger implementation. |
#### Methods

| Method | Description |
| --- | --- |
| getDefaultCulture() | Gets or sets default culture to be used during document processing. |
| setDefaultCulture(Locale value) | Gets or sets default culture to be used during document processing. |
| getShowDeletedSiganturesInfo() | Gets or sets flag that includes deleted signatures into Document Info result. |
| setShowDeletedSiganturesInfo(boolean value) | Gets or sets flag that includes deleted signatures into Document Info result. |
| getSaveDocumentOnEmptyUpdate() | Gets or sets flag to resave source document when Update method has no signatures to update. |
| setSaveDocumentOnEmptyUpdate(boolean value) | Gets or sets flag to resave source document when Update method has no signatures to update. |
| getSaveDocumentOnEmptyDelete() | Gets or sets flag to resave source document when Delete method has no affected signatures to remove. |
| setSaveDocumentOnEmptyDelete(boolean value) | Gets or sets flag to resave source document when Delete method has no affected signatures to remove. |
| getIncludeStandardMetadataSignatures() | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. |
| setIncludeStandardMetadataSignatures(boolean value) | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. |
| getLogger() | The logger implementation used for logging (Errors, Warnings, Traces). |
| getLogLevel() | The level of the logging to limit the messages (All, Traces, Warnings, Errors). |
| setLogLevel(int value) | The level of the logging to limit the messages (All, Traces, Warnings, Errors). |
##### SignatureSettings()
```
public SignatureSettings()
```

Creates default SignatureSettings instance with default values.

##### SignatureSettings(ILogger logger)
```
public SignatureSettings(ILogger logger)
```

Creates default SignatureSettings instance with the Logger implementation.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger |  |

##### getDefaultCulture()
```
public static Locale getDefaultCulture()
```

Gets or sets default culture to be used during document processing. Default value is "en-US".

**Returns:**
java.util.Locale
##### setDefaultCulture(Locale value)
```
public final void setDefaultCulture(Locale value)
```

Gets or sets default culture to be used during document processing. Default value is "en-US".

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Locale |  |

##### getShowDeletedSiganturesInfo()
```
public final boolean getShowDeletedSiganturesInfo()
```

Gets or sets flag that includes deleted signatures into Document Info result. Each Signature BaseSignature has Deleted flag  BaseSignature.Deleted (BaseSignature.getDeleted/BaseSignature.setDeleted(boolean)) to detect if it was deleted.

**Returns:**
boolean
##### setShowDeletedSiganturesInfo(boolean value)
```
public final void setShowDeletedSiganturesInfo(boolean value)
```

Gets or sets flag that includes deleted signatures into Document Info result. Each Signature BaseSignature has Deleted flag  BaseSignature.Deleted (BaseSignature.getDeleted/BaseSignature.setDeleted(boolean)) to detect if it was deleted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSaveDocumentOnEmptyUpdate()
```
public final boolean getSaveDocumentOnEmptyUpdate()
```

Gets or sets flag to resave source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all.

**Returns:**
boolean
##### setSaveDocumentOnEmptyUpdate(boolean value)
```
public final void setSaveDocumentOnEmptyUpdate(boolean value)
```

Gets or sets flag to resave source document when Update method has no signatures to update. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update. When this flat is set to false source document will not be modified at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getSaveDocumentOnEmptyDelete()
```
public final boolean getSaveDocumentOnEmptyDelete()
```

Gets or sets flag to resave source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all.

**Returns:**
boolean
##### setSaveDocumentOnEmptyDelete(boolean value)
```
public final void setSaveDocumentOnEmptyDelete(boolean value)
```

Gets or sets flag to resave source document when Delete method has no affected signatures to remove. If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove. When this flat is set to false source document will not be modified at all.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getIncludeStandardMetadataSignatures()
```
public final boolean getIncludeStandardMetadataSignatures()
```

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures.

**Returns:**
boolean
##### setIncludeStandardMetadataSignatures(boolean value)
```
public final void setIncludeStandardMetadataSignatures(boolean value)
```

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc. If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures. When this flag is set to true the document information will include these standard metadata signatures.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLogger()
```
public final ILogger getLogger()
```

The logger implementation used for logging (Errors, Warnings, Traces). ILogger.

**Returns:**
ILogger
##### getLogLevel()
```
public final int getLogLevel()
```

The level of the logging to limit the messages (All, Traces, Warnings, Errors).  LogLevel . BY default the All level type is set.

**Returns:**
int
##### setLogLevel(int value)
```
public final void setLogLevel(int value)
```

The level of the logging to limit the messages (All, Traces, Warnings, Errors).  LogLevel . BY default the All level type is set.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

## Python

### GroupDocs.Signature for Python via .NET
Path: https://reference.groupdocs.com/signature/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.signature` | The namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.
<br/><br/><br/><br/><br/><br/><br/>
<br/>The main classes in this namespace are:
<br/>\|<br/>\|<br/> \|<br/> \| |
| `groupdocs.signature.domain` | The namespace provides classes for working with document representation. |
| `groupdocs.signature.domain.extensions` | The namespace provides extensions for signature appearances and additional functionality. |
| `groupdocs.signature.logging` | The namespace provides classes for logging purposes. |
| `groupdocs.signature.options` | The namespace provides classes to specify additional options when loading, signing, verifying, searching and saving documents. |
| `groupdocs.signature.options.appearances` | The namespace provides classes for additional signature appearances. |

### groupdocs.signature.domain.extensions
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions.md

The namespace provides extensions for signature appearances and additional functionality.

##### Classes
| Class | Description |
| :- | :- |
| `Address` | Represents address for contact. |
| `Brush` | Represents base class for various brushes. |
| `CryptoCurrencyTransfer` | Represents Cryptocurrency transfer (receive or send) for QR-Code. |
| `DigitalVBA` | Represents digital signature for Spreadsheets VBA projects.
<br/>It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm.
<br/>If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing. |
| `EPC` | Represents European Payments Council Quick Response Code. |
| `Email` | Represents Email format for QR-Code. |
| `Event` | Represents standard QR-Code Event details. |
| `FormatAttribute` | Instructs objects serialization to serialize the member with the specified name and format |
| `HIBCLICCombinedData` | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities. |
| `HIBCLICPrimaryData` | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data. |
| `HIBCLICSecondaryAdditionalData` | Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data. |
| `HIBCPASData` | Class for encoding and decoding the text embedded in the HIBC PAS code. |
| `HIBCPASRecord` | Class for storing HIBC (Healthcare Industry Bar Code Council) PAS (Provider Applications Standard) Record |
| `IDataEncryption` | Encryption interface to provide object encoding and decoding methods. |
| `IDataSerializer` | Serialization interface to provide object serialization and deserialization methods. |
| `LinearGradientBrush` | Represents linear gradient brush. |
| `Mailmark2D` | Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark |
| `MaxiCodeMode2` | Class for encoding and decoding the text embedded in the MaxiCode code for modes |
| `MaxiCodeSecondMessage` | Class for encoding and decoding standart second message for MaxiCode barcode. |
| `MeCard` | Represents MeCard standard contact details. |
| `RadialGradientBrush` | Represents radial gradient brush. |
| `SMS` | Represents SMS short message service details. |
| `SignatureExtension` | Represents base class for signatures extensions. |
| `SkipSerializationAttribute` | Instructs the serialization to skip the member. |
| `SolidBrush` | Represents solid brush.
<br/>It could be used instead background color property. |
| `SpreadsheetPosition` | Defines signature position for Spreadsheet documents. |
| `SwissAddress` | Represents the address of the creditor or debtor.
<br/>You can either set street, house number, postal code, and town (structured address type)
<br/>or address line 1 and 2 (combined address elements type). |
| `SwissQR` | Class for encoding and decoding the text embedded in the SwissQR code. |
| `SymmetricEncryption` | Implements standard symmetric algorithms for data encryption with single key and passphrase (salt). |
| `SymmetricEncryptionAttribute` | Instructs instances serialization to encrypt / decrypt object serialization string. |
| `TextShadow` | Represents text shadow properties for text signatures.
<br/>The result may vary depending on the signature type and document format.
<br/>TextShadow is recommended for using with TextAsImage signature for all supported document types,
<br/>also with simple TextSignature and TextSignature as watermark for Spreadsheets (.xslx) and Presentations (.pptx).
<br/>Simple TextSignature for Words (.docx) is recommended too, but has limited functionality. |
| `TextureBrush` | Represents texture brush. |
| `VCard` | Represents Electronic Business Card standard contact details. |
| `WiFi` | Represents WiFi network connection details. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `CryptoCurrencyType` | Represents Cryptocurrency type. |
| `DataMatrixEncodeMode` | DataMatrix encoder's encoding mode, default to Auto |
| `HIBCLICDateFormat` | Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code). |
| `HIBCPASDataLocation` | Specifies HIBC PAS data location types.
<br/>HIBC - Healthcare Industry Bar Code
<br/>PAS - Provider Applications Standard |
| `HIBCPASDataType` | Specifies the different data types of HIBC PAS record.
<br/>HIBC - Healthcare Industry Bar Code
<br/>PAS - Provider Applications Standard |
| `Mailmark2DType` | 2D Mailmark Type defines size of Data Matrix barcode |
| `SymmetricAlgorithmType` | Represents symmetric encryption algorithm type. |
| `WiFiEncryptionType` | Represents WiFi Encryption type. |

### Address class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address.md

#### Address class

Represents address for contact.

The Address type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Address |

##### Properties
| Property | Description |
| :- | :- |
| street | Gets or sets address street. |
| city | Gets or sets address city. |
| state | Gets or sets address state. |
| zip | Gets or sets address ZIP. |
| country | Gets or sets address country. |

### Address constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/__init__.md

#### __init__

Constructs a new instance of Address

```python
def __init__(self):
    ...
```

### city property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/city.md

#### city property

Gets or sets address city.
##### Definition:
```python
@property
def city(self):
    ...
@city.setter
def city(self, value):
    ...
```

### country property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/country.md

#### country property

Gets or sets address country.
##### Definition:
```python
@property
def country(self):
    ...
@country.setter
def country(self, value):
    ...
```

### state property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/state.md

#### state property

Gets or sets address state.
##### Definition:
```python
@property
def state(self):
    ...
@state.setter
def state(self, value):
    ...
```

### street property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/street.md

#### street property

Gets or sets address street.
##### Definition:
```python
@property
def street(self):
    ...
@street.setter
def street(self, value):
    ...
```

### zip property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/address/zip.md

#### zip property

Gets or sets address ZIP.
##### Definition:
```python
@property
def zip(self):
    ...
@zip.setter
def zip(self, value):
    ...
```

### Brush class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/brush.md

#### Brush class

Represents base class for various brushes.

The Brush type exposes the following members:

### CryptoCurrencyTransfer class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer.md

#### CryptoCurrencyTransfer class

Represents Cryptocurrency transfer (receive or send) for QR-Code.

The CryptoCurrencyTransfer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of CryptoCurrencyTransfer |

##### Properties
| Property | Description |
| :- | :- |
| type | Gets or sets one of supported cryptocurrency type. |
| amount | Gets or sets transfer amount. |
| address | Gets or sets cryptocurrency public address. |
| message | Gets or sets optional transfer message. |
| custom_type | Gets or sets optional transfer message. |

### CryptoCurrencyTransfer constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/__init__.md

#### __init__

Constructs a new instance of CryptoCurrencyTransfer

```python
def __init__(self):
    ...
```

### address property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/address.md

#### address property

Gets or sets cryptocurrency public address.
##### Definition:
```python
@property
def address(self):
    ...
@address.setter
def address(self, value):
    ...
```

### amount property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/amount.md

#### amount property

Gets or sets transfer amount.
##### Definition:
```python
@property
def amount(self):
    ...
@amount.setter
def amount(self, value):
    ...
```

### custom_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/custom_type.md

#### custom_type property

Gets or sets optional transfer message.
##### Definition:
```python
@property
def custom_type(self):
    ...
@custom_type.setter
def custom_type(self, value):
    ...
```

### message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/message.md

#### message property

Gets or sets optional transfer message.
##### Definition:
```python
@property
def message(self):
    ...
@message.setter
def message(self, value):
    ...
```

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytransfer/type.md

#### type property

Gets or sets one of supported cryptocurrency type.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### CryptoCurrencyType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/cryptocurrencytype.md

#### CryptoCurrencyType enumeration

Represents Cryptocurrency type.

The CryptoCurrencyType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CUSTOM | Represents custom cryptocurrency type. |
| BITCOIN | Represents Bitcoin cryptocurrency type. |
| BITCOIN_CASH | Represents Bitcoin Cash cryptocurrency type. |
| LITECOIN | Represents Litecoin cryptocurrency type. |
| ETHEREUM | Represents Ethereum cryptocurrency type. |
| DASH | Represents Dash cryptocurrency type. |

### DataMatrixEncodeMode enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/datamatrixencodemode.md

#### DataMatrixEncodeMode enumeration

DataMatrix encoder's encoding mode, default to Auto

The DataMatrixEncodeMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO | Automatically pick up the best encode mode for DataMatrix encoding |
| ASCII | Encodes one alphanumeric or two numeric characters per byte |
| FULL | Encode 8 bit values |
| CUSTOM | Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding |
| C40 | Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters |
| TEXT | Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters. |
| EDIFACT | Uses EDIFACT encoding. Uses six bits per character, encodes digits,
<br/>upper-case letters, and many punctuation marks, but has no support for lower-case letters. |
| ANSIX12 | Uses ANSI X12 encoding. |
| EXTENDED_CODETEXT | ExtendedCodetext mode allows to manually switch encoding schemes in code-text.
<br/>Format : "\Encodation_scheme_name:text\Encodation_scheme_name:text".
<br/>Allowed encoding schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto.
<br/>Extended code-text example: @"\ansix12:ANSIX12TEXT\ascii:backslash must be \\
<br/>doubled\edifact:EdifactEncodedText"
<br/>All backslashes (\) must be doubled in text. |

### DigitalVBA class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba.md

#### DigitalVBA class

Represents digital signature for Spreadsheets VBA projects.
It provides ability to sign VBA project at specific Spreadsheets document formats like Xlsm or Xltm.
If several DigitalVBA extensions are added to DigitalSignOptions.Extensions only first is involved in document signing.

**Inheritance:** `DigitalVBA` →
`SignatureExtension`

The DigitalVBA type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the DigitalVBA class with certificate file. |
| __init__ | Initializes a new instance of the DigitalVBA class with certificate stream. |

##### Properties
| Property | Description |
| :- | :- |
| comments | Gets or sets the signature comments. |
| password | Gets or sets the password of digital certificate. |
| sign_only_vba_project | Gets or sets setting of only VBA project signing.
<br/>If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed. |
| certificate_file_path | Gets digital certificate file path.
<br/>This property is used only if CertificateStream is not specified. |
| certificate_stream | Gets digital certificate stream.
<br/>If this property is specified it is always used instead CertificateFilePath. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### DigitalVBA constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/__init__.md

#### __init__

Initializes a new instance of the DigitalVBA class with certificate file.

```python
def __init__(self, certificate_file_path, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_file_path | System.String | Digital certificate file path |
| password | System.String | Digital certificate password |

#### __init__

Initializes a new instance of the DigitalVBA class with certificate stream.

```python
def __init__(self, certificate_stream, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_stream | io.RawIOBase | Digital Certificate stream |
| password | System.String | Digital certificate password |

### certificate_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/certificate_file_path.md

#### certificate_file_path property

Gets digital certificate file path.
This property is used only if CertificateStream is not specified.
##### Definition:
```python
@property
def certificate_file_path(self):
    ...
```

### certificate_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/certificate_stream.md

#### certificate_stream property

Gets digital certificate stream.
If this property is specified it is always used instead CertificateFilePath.
##### Definition:
```python
@property
def certificate_stream(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/comments.md

#### comments property

Gets or sets the signature comments.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/password.md

#### password property

Gets or sets the password of digital certificate.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### sign_only_vba_project property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/digitalvba/sign_only_vba_project.md

#### sign_only_vba_project property

Gets or sets setting of only VBA project signing.
If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.
##### Definition:
```python
@property
def sign_only_vba_project(self):
    ...
@sign_only_vba_project.setter
def sign_only_vba_project(self, value):
    ...
```

### Email class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/email.md

#### Email class

Represents Email format for QR-Code.

The Email type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Email |

##### Properties
| Property | Description |
| :- | :- |
| address | Gets or sets Email address. |
| subject | Gets or sets email Subject. |
| body | Gets or sets Body of email message. |

### Email constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/email/__init__.md

#### __init__

Constructs a new instance of Email

```python
def __init__(self):
    ...
```

### address property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/email/address.md

#### address property

Gets or sets Email address.
##### Definition:
```python
@property
def address(self):
    ...
@address.setter
def address(self, value):
    ...
```

### body property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/email/body.md

#### body property

Gets or sets Body of email message.
##### Definition:
```python
@property
def body(self):
    ...
@body.setter
def body(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/email/subject.md

#### subject property

Gets or sets email Subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### EPC class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc.md

#### EPC class

Represents European Payments Council Quick Response Code.

The EPC type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Instantiates new EPC object. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets or sets Beneficiary's Name. Maximum length is 70 characters. |
| bic | Gets or sets Beneficiary's BIC with up to 11 characters length. |
| iban | Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters. |
| amount | Gets or sets amount. |
| code | Gets or sets Business Code up to 4 characters. |
| reference | Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive. |
| remittance | Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive. |
| information | Gets or sets hint information. Maximum 70 characters. |
| version | EPC / SEPA QR-Code version implementation. By default this value set to 002. |
| charset | EPC / SEPA QR-Code char set implementation. By default this value set to 1 |
| identification | EPC / SEPA QR-Code identification. By default this value set to SCT |

### EPC constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/__init__.md

#### __init__

Instantiates new EPC object.

```python
def __init__(self):
    ...
```

### amount property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/amount.md

#### amount property

Gets or sets amount.
##### Definition:
```python
@property
def amount(self):
    ...
@amount.setter
def amount(self, value):
    ...
```

### bic property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/bic.md

#### bic property

Gets or sets Beneficiary's BIC with up to 11 characters length.
##### Definition:
```python
@property
def bic(self):
    ...
@bic.setter
def bic(self, value):
    ...
```

### charset property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/charset.md

#### charset property

EPC / SEPA QR-Code char set implementation. By default this value set to 1
##### Definition:
```python
@property
def charset(self):
    ...
```

### code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/code.md

#### code property

Gets or sets Business Code up to 4 characters.
##### Definition:
```python
@property
def code(self):
    ...
@code.setter
def code(self, value):
    ...
```

### iban property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/iban.md

#### iban property

Gets or sets Beneficiary's Account (IBAN). The IBAN consists of up to 34 alphanumeric characters.
##### Definition:
```python
@property
def iban(self):
    ...
@iban.setter
def iban(self, value):
    ...
```

### identification property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/identification.md

#### identification property

EPC / SEPA QR-Code identification. By default this value set to SCT
##### Definition:
```python
@property
def identification(self):
    ...
```

### information property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/information.md

#### information property

Gets or sets hint information. Maximum 70 characters.
##### Definition:
```python
@property
def information(self):
    ...
@information.setter
def information(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/name.md

#### name property

Gets or sets Beneficiary's Name. Maximum length is 70 characters.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### reference property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/reference.md

#### reference property

Gets or sets Payment Reference (maximum 35 characters). This field and the Remittance Information field are mutually exclusive.
##### Definition:
```python
@property
def reference(self):
    ...
@reference.setter
def reference(self, value):
    ...
```

### remittance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/remittance.md

#### remittance property

Gets or sets Remittance Information (maximum 140 characters). This field and the Payment Reference field are mutually exclusive.
##### Definition:
```python
@property
def remittance(self):
    ...
@remittance.setter
def remittance(self, value):
    ...
```

### version property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/epc/version.md

#### version property

EPC / SEPA QR-Code version implementation. By default this value set to 002.
##### Definition:
```python
@property
def version(self):
    ...
```

### Event class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event.md

#### Event class

Represents standard QR-Code Event details.

The Event type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Event instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| title | Gets or sets event title. |
| description | Gets or sets description. |
| location | Gets or sets event location. |
| start_date | Gets or sets event start date and time. |
| end_date | Gets or sets event end date and time. |

### Event constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/__init__.md

#### __init__

Creates Event instance with default values.

```python
def __init__(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/description.md

#### description property

Gets or sets description.
##### Definition:
```python
@property
def description(self):
    ...
@description.setter
def description(self, value):
    ...
```

### end_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/end_date.md

#### end_date property

Gets or sets event end date and time.
##### Definition:
```python
@property
def end_date(self):
    ...
@end_date.setter
def end_date(self, value):
    ...
```

### location property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/location.md

#### location property

Gets or sets event location.
##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### start_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/start_date.md

#### start_date property

Gets or sets event start date and time.
##### Definition:
```python
@property
def start_date(self):
    ...
@start_date.setter
def start_date(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/event/title.md

#### title property

Gets or sets event title.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### FormatAttribute class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/formatattribute.md

#### FormatAttribute class

Instructs objects serialization to serialize the member with the specified name and format

The FormatAttribute type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Format attribute with given property Name |
| __init__ | Creates Format attribute with given property Name |

##### Properties
| Property | Description |
| :- | :- |
| property_name | Gets or sets the name of the property. |
| property_format | Gets or sets the serialization format of the property. |

### FormatAttribute constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/formatattribute/__init__.md

#### __init__

Creates Format attribute with given property Name

```python
def __init__(self, property_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of property |

#### __init__

Creates Format attribute with given property Name

```python
def __init__(self, property_name, property_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| property_name | System.String | The name of property |
| property_format | System.String | The format of property |

### property_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/formatattribute/property_format.md

#### property_format property

Gets or sets the serialization format of the property.
##### Definition:
```python
@property
def property_format(self):
    ...
@property_format.setter
def property_format(self, value):
    ...
```

### property_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/formatattribute/property_name.md

#### property_name property

Gets or sets the name of the property.
##### Definition:
```python
@property
def property_name(self):
    ...
@property_name.setter
def property_name(self, value):
    ...
```

### HIBCLICCombinedData class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcliccombineddata.md

#### HIBCLICCombinedData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with primary and secondary data entities.

The HIBCLICCombinedData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values. |

##### Properties
| Property | Description |
| :- | :- |
| primary_data | HIBC LIC primary data structure |
| secondary_additional_data | HIBC LIC secondary data structure |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### HIBCLICCombinedData constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcliccombineddata/__init__.md

#### __init__

Creates HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) combined data with default primary and secondary data values.

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcliccombineddata/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### primary_data property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcliccombineddata/primary_data.md

#### primary_data property

HIBC LIC primary data structure
##### Definition:
```python
@property
def primary_data(self):
    ...
@primary_data.setter
def primary_data(self, value):
    ...
```

### secondary_additional_data property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcliccombineddata/secondary_additional_data.md

#### secondary_additional_data property

HIBC LIC secondary data structure
##### Definition:
```python
@property
def secondary_additional_data(self):
    ...
@secondary_additional_data.setter
def secondary_additional_data(self, value):
    ...
```

### HIBCLICDateFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicdateformat.md

#### HIBCLICDateFormat enumeration

Specifies the different types of date formats for HIBC (Healthcare Industry Bar Code) LIC (Licensed Identification Code).

The HIBCLICDateFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| YYYYMMDD | YYYYMMDD format. Will be encoded in additional supplemental data. |
| MMYY | MMYY format. |
| MMDDYY | MMDDYY format. |
| YYMMDD | YYMMDD format. |
| YYMMDDHH | YYMMDDHH format. |
| YYJJJ | Julian date format. |
| YYJJJHH | Julian date format with hours. |
| NONE | Do not encode expiry date. |

### HIBCLICPrimaryData class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata.md

#### HIBCLICPrimaryData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) primary data.

The HIBCLICPrimaryData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default ctor() |

##### Properties
| Property | Description |
| :- | :- |
| labeler_identification_code | Identifies date of labeler identification code. Labeler identification code must
<br/>be 4 symbols alphanumeric string, with first character always being alphabetic. |
| product_or_catalog_number | Identifies product or catalog number. Product or catalog number must be alphanumeric
<br/>string up to 18 symbols length. |
| unit_of_measure_id | Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### HIBCLICPrimaryData constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata/__init__.md

#### __init__

Default ctor()

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### labeler_identification_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata/labeler_identification_code.md

#### labeler_identification_code property

Identifies date of labeler identification code. Labeler identification code must
be 4 symbols alphanumeric string, with first character always being alphabetic.
##### Definition:
```python
@property
def labeler_identification_code(self):
    ...
@labeler_identification_code.setter
def labeler_identification_code(self, value):
    ...
```

### product_or_catalog_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata/product_or_catalog_number.md

#### product_or_catalog_number property

Identifies product or catalog number. Product or catalog number must be alphanumeric
string up to 18 symbols length.
##### Definition:
```python
@property
def product_or_catalog_number(self):
    ...
@product_or_catalog_number.setter
def product_or_catalog_number(self, value):
    ...
```

### unit_of_measure_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicprimarydata/unit_of_measure_id.md

#### unit_of_measure_id property

Identifies unit of measure ID. Unit of measure ID must be integer value from 0 to 9.
##### Definition:
```python
@property
def unit_of_measure_id(self):
    ...
@unit_of_measure_id.setter
def unit_of_measure_id(self, value):
    ...
```

### HIBCLICSecondaryAdditionalData class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata.md

#### HIBCLICSecondaryAdditionalData class

Class for storing HIBC (Healthcare Industry Bar Code Council) LIC (Licensed Identification Code) secondary and additional data.

The HIBCLICSecondaryAdditionalData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default ctor() |

##### Properties
| Property | Description |
| :- | :- |
| expiry_date_format | Identifies expiry date format. |
| expiry_date | Identifies expiry date. Will be used if ExpiryDateFormat is not set to None. |
| lot_number | Identifies lot or batch number.
<br/>Lot/batch number must be alphanumeric string with up to 18 symbols length. |
| serial_number | Identifies serial number.
<br/>Serial number must be alphanumeric string up to 18 symbols length. |
| date_of_manufacture | Identifies date of manufacture.
<br/>Date of manufacture can be set to DateTime.MinValue in order not to use this field.
<br/>Default value: DateTime.MinValue |
| quantity | Identifies quantity, must be integer value from 0 to 500.
<br/>Quantity can be set to -1 in order not to use this field. Default value: -1 |
| link_character | Identifies link character in output string. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### HIBCLICSecondaryAdditionalData constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/__init__.md

#### __init__

Default ctor()

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### date_of_manufacture property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/date_of_manufacture.md

#### date_of_manufacture property

Identifies date of manufacture.
Date of manufacture can be set to DateTime.MinValue in order not to use this field.
Default value: DateTime.MinValue
##### Definition:
```python
@property
def date_of_manufacture(self):
    ...
@date_of_manufacture.setter
def date_of_manufacture(self, value):
    ...
```

### expiry_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/expiry_date.md

#### expiry_date property

Identifies expiry date. Will be used if ExpiryDateFormat is not set to None.
##### Definition:
```python
@property
def expiry_date(self):
    ...
@expiry_date.setter
def expiry_date(self, value):
    ...
```

### expiry_date_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/expiry_date_format.md

#### expiry_date_format property

Identifies expiry date format.
##### Definition:
```python
@property
def expiry_date_format(self):
    ...
@expiry_date_format.setter
def expiry_date_format(self, value):
    ...
```

### link_character property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/link_character.md

#### link_character property

Identifies link character in output string.
##### Definition:
```python
@property
def link_character(self):
    ...
@link_character.setter
def link_character(self, value):
    ...
```

### lot_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/lot_number.md

#### lot_number property

Identifies lot or batch number.
Lot/batch number must be alphanumeric string with up to 18 symbols length.
##### Definition:
```python
@property
def lot_number(self):
    ...
@lot_number.setter
def lot_number(self, value):
    ...
```

### quantity property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/quantity.md

#### quantity property

Identifies quantity, must be integer value from 0 to 500.
Quantity can be set to -1 in order not to use this field. Default value: -1
##### Definition:
```python
@property
def quantity(self):
    ...
@quantity.setter
def quantity(self, value):
    ...
```

### serial_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibclicsecondaryadditionaldata/serial_number.md

#### serial_number property

Identifies serial number.
Serial number must be alphanumeric string up to 18 symbols length.
##### Definition:
```python
@property
def serial_number(self):
    ...
@serial_number.setter
def serial_number(self, value):
    ...
```

### HIBCPASData class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata.md

#### HIBCPASData class

Class for encoding and decoding the text embedded in the HIBC PAS code.

The HIBCPASData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default ctor(). |

##### Properties
| Property | Description |
| :- | :- |
| data_location | Identifies data location. |
| records | List of HIBCPASRecord records |

##### Methods
| Method | Description |
| :- | :- |
| add_record | Adds new record `HIBCPASRecord` with given data type and data |
| add_record | Adds new record |
| clear | Clears records list |

### HIBCPASData constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata/__init__.md

#### __init__

Default ctor().

```python
def __init__(self):
    ...
```

### add_record method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata/add_record.md

#### add_record

Adds new record

##### Returns

Return reference on itself

```python
def add_record(self, record):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| record | groupdocs.signature.domain.extensions.HIBCPASRecord | Record to be added |

#### add_record

Adds new record `HIBCPASRecord` with given data type and data

##### Returns

```python
def add_record(self, data_type, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_type | groupdocs.signature.domain.extensions.HIBCPASDataType | Record data type |
| data | System.String | Record data |

### clear method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata/clear.md

#### clear

Clears records list

##### Returns

Returns reference on itself

```python
def clear(self):
    ...
```

### data_location property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata/data_location.md

#### data_location property

Identifies data location.
##### Definition:
```python
@property
def data_location(self):
    ...
@data_location.setter
def data_location(self, value):
    ...
```

### records property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdata/records.md

#### records property

List of HIBCPASRecord records
##### Definition:
```python
@property
def records(self):
    ...
@records.setter
def records(self, value):
    ...
```

### HIBCPASDataLocation enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdatalocation.md

#### HIBCPASDataLocation enumeration

Specifies HIBC PAS data location types.
HIBC - Healthcare Industry Bar Code
PAS - Provider Applications Standard

The HIBCPASDataLocation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PATIENT | A - Patient |
| PATIENT_CARE_RECORD | B - Patient Care Record |
| SPECIMEN_CONTAINER | C - Specimen Container |
| DIRECT_PATIENT_IMAGE_ITEM | D - Direct Patient Image Item |
| BUSINESS_RECORD | E - Business Record |
| MEDICAL_ADMINISTRATION_RECORD | F - Medical Administration Record |
| LIBRARY_REFERENCE_MATERIAL | G - Library Reference Material |
| DEVICES_AND_MATERIALS | H - Devices and Materials |
| IDENTIFICATION_CARD | I - Identification Card |
| PRODUCT_CONTAINER | J - Product Container |
| ASSET | K - Asset data type |
| SURGICAL_INSTRUMENT | L - Surgical Instrument |
| USER_DEFINED | Z - User Defined |

### HIBCPASDataType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasdatatype.md

#### HIBCPASDataType enumeration

Specifies the different data types of HIBC PAS record.
HIBC - Healthcare Industry Bar Code
PAS - Provider Applications Standard

The HIBCPASDataType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LABELER_IDENTIFICATION_CODE | A - Labeler Identification Code |
| SERVICE_IDENTIFICATION | B - Service Identification |
| PATIENT_IDENTIFICATION | C - Patient Identification |
| SPECIMEN_IDENTIFICATION | D - Specimen Identification |
| PERSONNEL_IDENTIFICATION | E - Personnel Identification |
| ADMINISTRABLE_PRODUCT_IDENTIFICATION | F - Administrable Product Identification |
| IMPLANTABLE_PRODUCT_INFORMATION | G - Implantable Product Information |
| HOSPITAL_ITEM_IDENTIFICATION | H - Hospital Item Identification |
| MEDICAL_PROCEDURE_IDENTIFICATION | I - Medical Procedure Identification |
| REIMBURSEMENT_CATEGORY | J - Reimbursement Category |
| BLOOD_PRODUCT_IDENTIFICATION | K - Blood Product Identification |
| DEMOGRAPHIC_DATA | L - Demographic Data |
| DATE_TIME | M - DateTime in YYYDDDHHMMG format |
| ASSET_IDENTIFICATION | N - Asset Identification |
| PURCHASE_ORDER_NUMBER | O - Purchase Order Number |
| DIETARY_ITEM_IDENTIFICATION | P - Dietary Item Identification |
| MANUFACTURER_SERIAL_NUMBER | Q - Manufacturer Serial Number |
| LIBRARY_MATERIALS_IDENTIFICATION | R - Library Materials Identification |
| BUSINESS_CONTROL_NUMBER | S - Business Control Number |
| EPISODE_OF_CARE_IDENTIFICATION | T - Episode of Care Identification |
| HEALTH_INDUSTRY_NUMBER | U - Health Industry Number |
| PATIENT_VISIT_ID | V - Patient Visit ID |
| XML_DOCUMENT | X - XML Document |
| USER_DEFINED | Z - User Defined |

### HIBCPASRecord class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasrecord.md

#### HIBCPASRecord class

Class for storing HIBC (Healthcare Industry Bar Code Council) PAS (Provider Applications Standard) Record

The HIBCPASRecord type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Default ctor() |
| __init__ | Creates HIBCPASRecord with data and type. |

##### Properties
| Property | Description |
| :- | :- |
| data_type | HIBC PAS record's data type. |
| data | Identifies data. |

### HIBCPASRecord constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasrecord/__init__.md

#### __init__

Default ctor()

```python
def __init__(self):
    ...
```

#### __init__

Creates HIBCPASRecord with data and type.

```python
def __init__(self, data_type, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data_type | groupdocs.signature.domain.extensions.HIBCPASDataType | HIBC PAS record's data type. |
| data | System.String | HIBC PAS record's data. |

### data property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasrecord/data.md

#### data property

Identifies data.
##### Definition:
```python
@property
def data(self):
    ...
@data.setter
def data(self, value):
    ...
```

### data_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/hibcpasrecord/data_type.md

#### data_type property

HIBC PAS record's data type.
##### Definition:
```python
@property
def data_type(self):
    ...
@data_type.setter
def data_type(self, value):
    ...
```

### IDataEncryption class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataencryption.md

#### IDataEncryption class

Encryption interface to provide object encoding and decoding methods.

The IDataEncryption type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| encode | Encode method to encrypt string. |
| decode | Decode method to obtain decrypted string. |

### decode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataencryption/decode.md

#### decode

Decode method to obtain decrypted string.

##### Returns

Returns decrypted string

```python
def decode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Encrypted string to decode. |

### encode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataencryption/encode.md

#### encode

Encode method to encrypt string.

##### Returns

Returns encrypted string

```python
def encode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Source string to encode. |

### IDataSerializer class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataserializer.md

#### IDataSerializer class

Serialization interface to provide object serialization and deserialization methods.

The IDataSerializer type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| serialize | Serialize method to format object to string representing. |
| deserialize | Deserialize method to obtain required object from string. |

### deserialize method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataserializer/deserialize.md

#### deserialize

Deserialize method to obtain required object from string.

##### Returns

```python
def deserialize(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Source serialized string that contains object |

### serialize method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/idataserializer/serialize.md

#### serialize

Serialize method to format object to string representing.

##### Returns

```python
def serialize(self, data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| data | System.Object | Source object to serialize |

### LinearGradientBrush class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/lineargradientbrush.md

#### LinearGradientBrush class

Represents linear gradient brush.

**Inheritance:** `LinearGradientBrush` →
`Brush`

The LinearGradientBrush type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the LinearGradientBrush class with default values. |
| __init__ | Initializes a new instance of the LinearGradientBrush class. |

##### Properties
| Property | Description |
| :- | :- |
| start_color | Gets or sets start gradient color. |
| end_color | Gets or sets finish gradient color. |
| angle | Gets or sets gradient angle. |

### LinearGradientBrush constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/lineargradientbrush/__init__.md

#### __init__

Initializes a new instance of the LinearGradientBrush class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the LinearGradientBrush class.

```python
def __init__(self, start_color, end_color, angle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_color | aspose.pydrawing.Color | Start color. |
| end_color | aspose.pydrawing.Color | End color. |
| angle | float | Angle. Default value is 0. |

### angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/lineargradientbrush/angle.md

#### angle property

Gets or sets gradient angle.
##### Definition:
```python
@property
def angle(self):
    ...
@angle.setter
def angle(self, value):
    ...
```

### end_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/lineargradientbrush/end_color.md

#### end_color property

Gets or sets finish gradient color.
##### Definition:
```python
@property
def end_color(self):
    ...
@end_color.setter
def end_color(self, value):
    ...
```

### start_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/lineargradientbrush/start_color.md

#### start_color property

Gets or sets start gradient color.
##### Definition:
```python
@property
def start_color(self):
    ...
@start_color.setter
def start_color(self, value):
    ...
```

### Mailmark2D class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d.md

#### Mailmark2D class

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark

The Mailmark2D type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Royal Mail Mailmark combined data with default primary and secondary data values. |

##### Properties
| Property | Description |
| :- | :- |
| upu_country_id | Identifies the UPU Country ID.Max length: 4 characters. |
| information_type_id | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| version_id | Identifies the barcode version as relevant to each Information Type ID. |
| supply_chain_id | Identifies the unique group of customers involved in the mailing.
<br/>Max value: 9999999. |
| item_id | Identifies the unique item within the Supply Chain ID.
<br/>Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days.
<br/>Max value: 99999999. |
| destination_post_code_and_dps | Contains the Postcode of the Delivery Address with DPS
<br/>If inland the Postcode/DP  contains the following number of characters.
<br/>Area (1 or 2 characters)
<br/>District(1 or 2 characters)
<br/>Sector(1 character)
<br/>Unit(2 characters)
<br/>DPS (2 characters).
<br/>The Postcode and DPS must comply with a valid PAF® format. Max length is 9. |
| rts_flag | Flag which indicates what level of Return to Sender service is being requested. Max length is 1 |
| return_to_sender_post_code | Contains the Return to Sender Post Code but no DPS.
<br/>The PC(without DPS) must comply with a PAF® format. |
| customer_content | Optional space for use by customer. |
| customer_content_encode_mode | Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. `DataMatrixEncodeMode` |
| data_matrix_type | 2D Mailmark Type defines size of Data Matrix barcode. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### Mailmark2D constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/__init__.md

#### __init__

Creates Royal Mail Mailmark combined data with default primary and secondary data values.

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### customer_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/customer_content.md

#### customer_content property

Optional space for use by customer.

##### Remarks

Max length by Type `Mailmark2DType`:
Type 7: 6 characters
Type 9: 45 characters
Type 29: 25 characters
##### Definition:
```python
@property
def customer_content(self):
    ...
@customer_content.setter
def customer_content(self, value):
    ...
```

### customer_content_encode_mode property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/customer_content_encode_mode.md

#### customer_content_encode_mode property

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. `DataMatrixEncodeMode`
##### Definition:
```python
@property
def customer_content_encode_mode(self):
    ...
@customer_content_encode_mode.setter
def customer_content_encode_mode(self, value):
    ...
```

### data_matrix_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/data_matrix_type.md

#### data_matrix_type property

2D Mailmark Type defines size of Data Matrix barcode.
##### Definition:
```python
@property
def data_matrix_type(self):
    ...
@data_matrix_type.setter
def data_matrix_type(self, value):
    ...
```

### destination_post_code_and_dps property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/destination_post_code_and_dps.md

#### destination_post_code_and_dps property

Contains the Postcode of the Delivery Address with DPS
If inland the Postcode/DP  contains the following number of characters.
Area (1 or 2 characters)
District(1 or 2 characters)
Sector(1 character)
Unit(2 characters)
DPS (2 characters).
The Postcode and DPS must comply with a valid PAF® format. Max length is 9.
##### Definition:
```python
@property
def destination_post_code_and_dps(self):
    ...
@destination_post_code_and_dps.setter
def destination_post_code_and_dps(self, value):
    ...
```

### information_type_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/information_type_id.md

#### information_type_id property

Identifies the Royal Mail Mailmark barcode payload for each product type.

##### Remarks

Valid Values:
"0" - Domestic Sorted and Unsorted
"A" - On-line Postage
"B" - Franking
"C" - Consolidation
##### Definition:
```python
@property
def information_type_id(self):
    ...
@information_type_id.setter
def information_type_id(self, value):
    ...
```

### item_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/item_id.md

#### item_id property

Identifies the unique item within the Supply Chain ID.
Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days.
Max value: 99999999.
##### Definition:
```python
@property
def item_id(self):
    ...
@item_id.setter
def item_id(self, value):
    ...
```

### return_to_sender_post_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/return_to_sender_post_code.md

#### return_to_sender_post_code property

Contains the Return to Sender Post Code but no DPS.
The PC(without DPS) must comply with a PAF® format.
##### Definition:
```python
@property
def return_to_sender_post_code(self):
    ...
@return_to_sender_post_code.setter
def return_to_sender_post_code(self, value):
    ...
```

### rts_flag property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/rts_flag.md

#### rts_flag property

Flag which indicates what level of Return to Sender service is being requested. Max length is 1
##### Definition:
```python
@property
def rts_flag(self):
    ...
@rts_flag.setter
def rts_flag(self, value):
    ...
```

### supply_chain_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/supply_chain_id.md

#### supply_chain_id property

Identifies the unique group of customers involved in the mailing.
Max value: 9999999.
##### Definition:
```python
@property
def supply_chain_id(self):
    ...
@supply_chain_id.setter
def supply_chain_id(self, value):
    ...
```

### upu_country_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/upu_country_id.md

#### upu_country_id property

Identifies the UPU Country ID.Max length: 4 characters.
##### Definition:
```python
@property
def upu_country_id(self):
    ...
@upu_country_id.setter
def upu_country_id(self, value):
    ...
```

### version_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2d/version_id.md

#### version_id property

Identifies the barcode version as relevant to each Information Type ID.

##### Remarks

Valid Values:
"1" - currently used only this value (default)
"0" and "2" to "9" and "A" to "Z" spare reserved for potential future use.
##### Definition:
```python
@property
def version_id(self):
    ...
```

### Mailmark2DType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mailmark2dtype.md

#### Mailmark2DType enumeration

2D Mailmark Type defines size of Data Matrix barcode

The Mailmark2DType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO | Auto determine |
| TYPE_7 | 24 x 24 modules |
| TYPE_9 | 32 x 32 modules |
| TYPE_29 | 16 x 48 modules |

### MaxiCodeMode2 class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2.md

#### MaxiCodeMode2 class

Class for encoding and decoding the text embedded in the MaxiCode code for modes

The MaxiCodeMode2 type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates MaxiCode data |

##### Properties
| Property | Description |
| :- | :- |
| postal_code | Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3. |
| country_code | Identifies the 3-digit country code. |
| service_category | Identifies the 3-digit service category. |
| second_message | Identifies the second message of the barcode. |

### MaxiCodeMode2 constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2/__init__.md

#### __init__

Creates MaxiCode data

```python
def __init__(self):
    ...
```

### country_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2/country_code.md

#### country_code property

Identifies the 3-digit country code.
##### Definition:
```python
@property
def country_code(self):
    ...
@country_code.setter
def country_code(self, value):
    ...
```

### postal_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2/postal_code.md

#### postal_code property

Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3.
##### Definition:
```python
@property
def postal_code(self):
    ...
@postal_code.setter
def postal_code(self, value):
    ...
```

### second_message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2/second_message.md

#### second_message property

Identifies the second message of the barcode.
##### Definition:
```python
@property
def second_message(self):
    ...
@second_message.setter
def second_message(self, value):
    ...
```

### service_category property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodemode2/service_category.md

#### service_category property

Identifies the 3-digit service category.
##### Definition:
```python
@property
def service_category(self):
    ...
@service_category.setter
def service_category(self, value):
    ...
```

### MaxiCodeSecondMessage class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodesecondmessage.md

#### MaxiCodeSecondMessage class

Class for encoding and decoding standart second message for MaxiCode barcode.

The MaxiCodeSecondMessage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of MaxiCodeSecondMessage |

##### Properties
| Property | Description |
| :- | :- |
| message | Gets or sets the second message. |

### MaxiCodeSecondMessage constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodesecondmessage/__init__.md

#### __init__

Constructs a new instance of MaxiCodeSecondMessage

```python
def __init__(self):
    ...
```

### message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/maxicodesecondmessage/message.md

#### message property

Gets or sets the second message.
##### Definition:
```python
@property
def message(self):
    ...
@message.setter
def message(self, value):
    ...
```

### MeCard class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard.md

#### MeCard class

Represents MeCard standard contact details.

The MeCard type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates MeCard instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets or sets contact Name. |
| nickname | Gets or sets contact Nickname. |
| phone | Gets or sets phone number. |
| alt_phone | Gets or sets alternative phone number. |
| reading | Gets or sets reading of name. |
| email | Gets or sets contact email. |
| note | Gets or sets Note (Company) of contact. |
| url | Gets or sets URL. |
| address | Gets or sets Home Address properties. This property is not initialized by default. |
| birth_day | Gets or sets contact birthday. |

### MeCard constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/__init__.md

#### __init__

Creates MeCard instance with default values.

```python
def __init__(self):
    ...
```

### address property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/address.md

#### address property

Gets or sets Home Address properties. This property is not initialized by default.
##### Definition:
```python
@property
def address(self):
    ...
@address.setter
def address(self, value):
    ...
```

### alt_phone property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/alt_phone.md

#### alt_phone property

Gets or sets alternative phone number.
##### Definition:
```python
@property
def alt_phone(self):
    ...
@alt_phone.setter
def alt_phone(self, value):
    ...
```

### birth_day property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/birth_day.md

#### birth_day property

Gets or sets contact birthday.
##### Definition:
```python
@property
def birth_day(self):
    ...
@birth_day.setter
def birth_day(self, value):
    ...
```

### email property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/email.md

#### email property

Gets or sets contact email.
##### Definition:
```python
@property
def email(self):
    ...
@email.setter
def email(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/name.md

#### name property

Gets or sets contact Name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### nickname property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/nickname.md

#### nickname property

Gets or sets contact Nickname.
##### Definition:
```python
@property
def nickname(self):
    ...
@nickname.setter
def nickname(self, value):
    ...
```

### note property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/note.md

#### note property

Gets or sets Note (Company) of contact.
##### Definition:
```python
@property
def note(self):
    ...
@note.setter
def note(self, value):
    ...
```

### phone property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/phone.md

#### phone property

Gets or sets phone number.
##### Definition:
```python
@property
def phone(self):
    ...
@phone.setter
def phone(self, value):
    ...
```

### reading property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/reading.md

#### reading property

Gets or sets reading of name.
##### Definition:
```python
@property
def reading(self):
    ...
@reading.setter
def reading(self, value):
    ...
```

### url property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/mecard/url.md

#### url property

Gets or sets URL.
##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### RadialGradientBrush class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/radialgradientbrush.md

#### RadialGradientBrush class

Represents radial gradient brush.

**Inheritance:** `RadialGradientBrush` →
`Brush`

The RadialGradientBrush type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the RadialGradientBrush class with default values. |
| __init__ | Initializes a new instance of the RadialGradientBrush class. |

##### Properties
| Property | Description |
| :- | :- |
| inner_color | Gets or sets inner gradient color. |
| outer_color | Gets or sets outer gradient color. |

### RadialGradientBrush constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/radialgradientbrush/__init__.md

#### __init__

Initializes a new instance of the RadialGradientBrush class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the RadialGradientBrush class.

```python
def __init__(self, inner_color, outer_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| inner_color | aspose.pydrawing.Color | Inner color. |
| outer_color | aspose.pydrawing.Color | Outer color. |

### inner_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/radialgradientbrush/inner_color.md

#### inner_color property

Gets or sets inner gradient color.
##### Definition:
```python
@property
def inner_color(self):
    ...
@inner_color.setter
def inner_color(self, value):
    ...
```

### outer_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/radialgradientbrush/outer_color.md

#### outer_color property

Gets or sets outer gradient color.
##### Definition:
```python
@property
def outer_color(self):
    ...
@outer_color.setter
def outer_color(self, value):
    ...
```

### SignatureExtension class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/signatureextension.md

#### SignatureExtension class

Represents base class for signatures extensions.

The SignatureExtension type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/signatureextension/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### SkipSerializationAttribute class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/skipserializationattribute.md

#### SkipSerializationAttribute class

Instructs the serialization to skip the member.

The SkipSerializationAttribute type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Format attribute with given property Name. |

### SkipSerializationAttribute constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/skipserializationattribute/__init__.md

#### __init__

Creates Format attribute with given property Name.

```python
def __init__(self):
    ...
```

### SMS class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/sms.md

#### SMS class

Represents SMS short message service details.

The SMS type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates VCard instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| number | Gets or sets SMS recipient phone number. |
| message | Gets or sets SMS message content. |

### SMS constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/sms/__init__.md

#### __init__

Creates VCard instance with default values.

```python
def __init__(self):
    ...
```

### message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/sms/message.md

#### message property

Gets or sets SMS message content.
##### Definition:
```python
@property
def message(self):
    ...
@message.setter
def message(self, value):
    ...
```

### number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/sms/number.md

#### number property

Gets or sets SMS recipient phone number.
##### Definition:
```python
@property
def number(self):
    ...
@number.setter
def number(self, value):
    ...
```

### SolidBrush class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/solidbrush.md

#### SolidBrush class

Represents solid brush.
It could be used instead background color property.

**Inheritance:** `SolidBrush` →
`Brush`

The SolidBrush type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the SolidBrush class with default values. |
| __init__ | Initializes a new instance of the SolidBrush class. |

##### Properties
| Property | Description |
| :- | :- |
| color | Gets or sets color of solid brush. |

### SolidBrush constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/solidbrush/__init__.md

#### __init__

Initializes a new instance of the SolidBrush class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the SolidBrush class.

```python
def __init__(self, color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| color | aspose.pydrawing.Color | Color of solid brush. |

### color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/solidbrush/color.md

#### color property

Gets or sets color of solid brush.
##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### SpreadsheetPosition class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/spreadsheetposition.md

#### SpreadsheetPosition class

Defines signature position for Spreadsheet documents.

**Inheritance:** `SpreadsheetPosition` →
`SignatureExtension`

The SpreadsheetPosition type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Spreadsheet signature position with predefined row and column. |

##### Properties
| Property | Description |
| :- | :- |
| row | Gets or sets the top row number of signature (min value is 0). |
| column | Gets or sets the left column number of signature (min value is 0). |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### SpreadsheetPosition constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/spreadsheetposition/__init__.md

#### __init__

Creates Spreadsheet signature position with predefined row and column.

```python
def __init__(self, row, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row | int | Row position |
| column | int | Column position |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/spreadsheetposition/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### column property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/spreadsheetposition/column.md

#### column property

Gets or sets the left column number of signature (min value is 0).
##### Definition:
```python
@property
def column(self):
    ...
@column.setter
def column(self, value):
    ...
```

### row property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/spreadsheetposition/row.md

#### row property

Gets or sets the top row number of signature (min value is 0).
##### Definition:
```python
@property
def row(self):
    ...
@row.setter
def row(self, value):
    ...
```

### SwissAddress class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress.md

#### SwissAddress class

Represents the address of the creditor or debtor.
You can either set street, house number, postal code, and town (structured address type)
or address line 1 and 2 (combined address elements type).

The SwissAddress type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of SwissAddress |

##### Properties
| Property | Description |
| :- | :- |
| name | Gets or sets the name, either the first and last name of a natural person or
<br/>the company name of a legal person. |
| address_line1 | Gets or sets the address line 1.
<br/>Address line 1 contains street name, house number or P.O. box.
<br/>This field is only used for combined elements addresses and is optional. |
| address_line2 | Gets or sets the address line 2.
<br/>Address line 2 contains postal code and town.
<br/>This field is only used for combined elements addresses. For this type, it's mandatory. |
| street | Gets or sets the street.
<br/>The street must be specified without a house number.
<br/>This field is only used for structured addresses and is optional. |
| house_no | Gets or sets the house number.
<br/>This field is only used for structured addresses and is optional. |
| postal_code | Gets or sets the postal code.
<br/>This field is only used for structured addresses. For this type, it's mandatory. |
| town | Gets or sets the town or city.
<br/>This field is only used for structured addresses. For this type, it's mandatory. |
| country_code | Gets or sets the two-letter ISO country code.
<br/>The country code is mandatory unless the entire address contains null or empty values. |

### SwissAddress constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/__init__.md

#### __init__

Constructs a new instance of SwissAddress

```python
def __init__(self):
    ...
```

### address_line1 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/address_line1.md

#### address_line1 property

Gets or sets the address line 1.
Address line 1 contains street name, house number or P.O. box.
This field is only used for combined elements addresses and is optional.
##### Definition:
```python
@property
def address_line1(self):
    ...
@address_line1.setter
def address_line1(self, value):
    ...
```

### address_line2 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/address_line2.md

#### address_line2 property

Gets or sets the address line 2.
Address line 2 contains postal code and town.
This field is only used for combined elements addresses. For this type, it's mandatory.
##### Definition:
```python
@property
def address_line2(self):
    ...
@address_line2.setter
def address_line2(self, value):
    ...
```

### country_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/country_code.md

#### country_code property

Gets or sets the two-letter ISO country code.
The country code is mandatory unless the entire address contains null or empty values.
##### Definition:
```python
@property
def country_code(self):
    ...
@country_code.setter
def country_code(self, value):
    ...
```

### house_no property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/house_no.md

#### house_no property

Gets or sets the house number.
This field is only used for structured addresses and is optional.
##### Definition:
```python
@property
def house_no(self):
    ...
@house_no.setter
def house_no(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/name.md

#### name property

Gets or sets the name, either the first and last name of a natural person or
the company name of a legal person.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### postal_code property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/postal_code.md

#### postal_code property

Gets or sets the postal code.
This field is only used for structured addresses. For this type, it's mandatory.
##### Definition:
```python
@property
def postal_code(self):
    ...
@postal_code.setter
def postal_code(self, value):
    ...
```

### street property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/street.md

#### street property

Gets or sets the street.
The street must be specified without a house number.
This field is only used for structured addresses and is optional.
##### Definition:
```python
@property
def street(self):
    ...
@street.setter
def street(self, value):
    ...
```

### town property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissaddress/town.md

#### town property

Gets or sets the town or city.
This field is only used for structured addresses. For this type, it's mandatory.
##### Definition:
```python
@property
def town(self):
    ...
@town.setter
def town(self, value):
    ...
```

### SwissQR class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr.md

#### SwissQR class

Class for encoding and decoding the text embedded in the SwissQR code.

The SwissQR type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates an instance of SwissQR. |

##### Properties
| Property | Description |
| :- | :- |
| amount | Gets or sets the payment amount.
<br/>Valid values are between 0.01 and 999,999,999.99. |
| currency | Gets or sets the payment currency.
<br/>Valid values are "CHF" and "EUR". |
| account | Gets or sets the creditor's account number.
<br/>Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein.
<br/>Spaces are allowed in the account number. |
| creditor | Gets or sets the creditor address. |
| reference | Gets or sets the creditor payment reference.
<br/>The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx
<br/>through CHxx31999xxxxx.
<br/>If specified, the reference must be either a valid SwissQR reference (corresponding
<br/>to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx").
<br/>Both may contain spaces for formatting. |
| debtor | Gets or sets the debtor address.
<br/>The debtor is optional. If it is omitted, both setting this field to null or
<br/>setting an address with all null or empty values is ok. |
| unstructured_message | Gets or sets the additional unstructured message. |
| bill_information | Gets or sets the additional structured bill information. |

### SwissQR constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/__init__.md

#### __init__

Creates an instance of SwissQR.

```python
def __init__(self):
    ...
```

### account property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/account.md

#### account property

Gets or sets the creditor's account number.
Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein.
Spaces are allowed in the account number.
##### Definition:
```python
@property
def account(self):
    ...
@account.setter
def account(self, value):
    ...
```

### amount property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/amount.md

#### amount property

Gets or sets the payment amount.
Valid values are between 0.01 and 999,999,999.99.
##### Definition:
```python
@property
def amount(self):
    ...
@amount.setter
def amount(self, value):
    ...
```

### bill_information property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/bill_information.md

#### bill_information property

Gets or sets the additional structured bill information.
##### Definition:
```python
@property
def bill_information(self):
    ...
@bill_information.setter
def bill_information(self, value):
    ...
```

### creditor property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/creditor.md

#### creditor property

Gets or sets the creditor address.
##### Definition:
```python
@property
def creditor(self):
    ...
@creditor.setter
def creditor(self, value):
    ...
```

### currency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/currency.md

#### currency property

Gets or sets the payment currency.
Valid values are "CHF" and "EUR".
##### Definition:
```python
@property
def currency(self):
    ...
@currency.setter
def currency(self, value):
    ...
```

### debtor property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/debtor.md

#### debtor property

Gets or sets the debtor address.
The debtor is optional. If it is omitted, both setting this field to null or
setting an address with all null or empty values is ok.
##### Definition:
```python
@property
def debtor(self):
    ...
@debtor.setter
def debtor(self, value):
    ...
```

### reference property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/reference.md

#### reference property

Gets or sets the creditor payment reference.
The reference is mandatory for SwissQR IBANs, i.e. IBANs in the range CHxx30000xxxxxx
through CHxx31999xxxxx.
If specified, the reference must be either a valid SwissQR reference (corresponding
to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx").
Both may contain spaces for formatting.
##### Definition:
```python
@property
def reference(self):
    ...
@reference.setter
def reference(self, value):
    ...
```

### unstructured_message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/swissqr/unstructured_message.md

#### unstructured_message property

Gets or sets the additional unstructured message.
##### Definition:
```python
@property
def unstructured_message(self):
    ...
@unstructured_message.setter
def unstructured_message(self, value):
    ...
```

### SymmetricAlgorithmType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricalgorithmtype.md

#### SymmetricAlgorithmType enumeration

Represents symmetric encryption algorithm type.

The SymmetricAlgorithmType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RIJNDAEL | Represents Rijndael symmetric encryption algorithm. |
| AES_NEW | Represents improved AES (Advanced Encryption Standard) encryption algorithm. |

### SymmetricEncryption class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption.md

#### SymmetricEncryption class

Implements standard symmetric algorithms for data encryption with single key and passphrase (salt).

The SymmetricEncryption type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates symmetric encryption algorithm with parameters. |
| __init__ | Creates symmetric encryption algorithm with default passphrase |

##### Properties
| Property | Description |
| :- | :- |
| algorithm_type | Gets or sets type of symmetric algorithm. |
| key | Gets or sets key of encryption algorithm. |
| salt | Gets or sets passphrase of encryption algorithm. |

##### Methods
| Method | Description |
| :- | :- |
| encode | Encrypts string based on provided algorithm type, key and salt parameters |
| decode | Decrypts string based on provided algorithm type, key and salt parameters |

### SymmetricEncryption constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/__init__.md

#### __init__

Creates symmetric encryption algorithm with default passphrase

```python
def __init__(self, algorithm_type, key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| algorithm_type | groupdocs.signature.domain.extensions.SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | System.String | Encryption key |

#### __init__

Creates symmetric encryption algorithm with parameters.

```python
def __init__(self, algorithm_type, key, salt):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| algorithm_type | groupdocs.signature.domain.extensions.SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | System.String | Encryption key |
| salt | System.String | Passphrase for encryption |

### algorithm_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/algorithm_type.md

#### algorithm_type property

Gets or sets type of symmetric algorithm.
##### Definition:
```python
@property
def algorithm_type(self):
    ...
@algorithm_type.setter
def algorithm_type(self, value):
    ...
```

### decode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/decode.md

#### decode

Decrypts string based on provided algorithm type, key and salt parameters

##### Returns

Returns decrypted string.

```python
def decode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Encrypted string to decode. |

### encode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/encode.md

#### encode

Encrypts string based on provided algorithm type, key and salt parameters

##### Returns

Returns encrypted string.

```python
def encode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Source string to encode. |

### key property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/key.md

#### key property

Gets or sets key of encryption algorithm.
##### Definition:
```python
@property
def key(self):
    ...
@key.setter
def key(self, value):
    ...
```

### salt property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryption/salt.md

#### salt property

Gets or sets passphrase of encryption algorithm.
##### Definition:
```python
@property
def salt(self):
    ...
@salt.setter
def salt(self, value):
    ...
```

### SymmetricEncryptionAttribute class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryptionattribute.md

#### SymmetricEncryptionAttribute class

Instructs instances serialization to encrypt / decrypt object serialization string.

The SymmetricEncryptionAttribute type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates symmetric algorithm with parameters. |
| __init__ | Creates symmetric algorithm with parameters and default passphrase. |

##### Methods
| Method | Description |
| :- | :- |
| encode | Encrypts string based on provided algorithm type, key and salt parameters |
| decode | Decrypts passed string based on algorithm type, key and salt parameters |

### SymmetricEncryptionAttribute constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/__init__.md

#### __init__

Creates symmetric algorithm with parameters and default passphrase.

```python
def __init__(self, algorithm_type, key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| algorithm_type | groupdocs.signature.domain.extensions.SymmetricAlgorithmType | Encryption algorithm type |
| key | System.String | Encryption key |

#### __init__

Creates symmetric algorithm with parameters.

```python
def __init__(self, algorithm_type, key, salt):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| algorithm_type | groupdocs.signature.domain.extensions.SymmetricAlgorithmType | Specify symmetric algorithm type |
| key | System.String | Encryption key |
| salt | System.String | Passphrase for encryption |

### decode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/decode.md

#### decode

Decrypts passed string based on algorithm type, key and salt parameters

##### Returns

Returns decoded string.

```python
def decode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Encrypted string to decode. |

### encode method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/symmetricencryptionattribute/encode.md

#### encode

Encrypts string based on provided algorithm type, key and salt parameters

##### Returns

Returns encoded string.

```python
def encode(self, source):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source | System.String | Source string to encode |

### TextShadow class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow.md

#### TextShadow class

Represents text shadow properties for text signatures.
The result may vary depending on the signature type and document format.
TextShadow is recommended for using with TextAsImage signature for all supported document types,
also with simple TextSignature and TextSignature as watermark for Spreadsheets (.xslx) and Presentations (.pptx).
Simple TextSignature for Words (.docx) is recommended too, but has limited functionality.

**Inheritance:** `TextShadow` →
`SignatureExtension`

The TextShadow type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates TextShadow with default options. |

##### Properties
| Property | Description |
| :- | :- |
| distance | Gets or sets distance from text to shadow.
<br/>Default value is 1. |
| angle | Gets or sets angle for placing shadow relative to the text.
<br/>Default value is 0. |
| color | Gets or sets color of the shadow.
<br/>Default value is Black. |
| transparency | Gets or sets transparency of the shadow.
<br/>Default value is 0. |
| blur | Gets or sets blur of the shadow.
<br/>Default value is 4. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### TextShadow constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/__init__.md

#### __init__

Creates TextShadow with default options.

```python
def __init__(self):
    ...
```

### angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/angle.md

#### angle property

Gets or sets angle for placing shadow relative to the text.
Default value is 0.
##### Definition:
```python
@property
def angle(self):
    ...
@angle.setter
def angle(self, value):
    ...
```

### blur property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/blur.md

#### blur property

Gets or sets blur of the shadow.
Default value is 4.
##### Definition:
```python
@property
def blur(self):
    ...
@blur.setter
def blur(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/color.md

#### color property

Gets or sets color of the shadow.
Default value is Black.
##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### distance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/distance.md

#### distance property

Gets or sets distance from text to shadow.
Default value is 1.
##### Definition:
```python
@property
def distance(self):
    ...
@distance.setter
def distance(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/textshadow/transparency.md

#### transparency property

Gets or sets transparency of the shadow.
Default value is 0.
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### TextureBrush class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/texturebrush.md

#### TextureBrush class

Represents texture brush.

**Inheritance:** `TextureBrush` →
`Brush`

The TextureBrush type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextureBrush class with default values. |
| __init__ | Initializes a new instance of the TextureBrush class with image file. |
| __init__ | Initializes a new instance of the TextureBrush class with image stream option. |

##### Properties
| Property | Description |
| :- | :- |
| image_file_path | Gets or sets the texture image file path.
<br/>This property is used only if ImageStream is not specified. |
| image_stream | Gets or sets the texture image stream.
<br/>If this property is specified it is always used instead ImageFilePath. |

### TextureBrush constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/texturebrush/__init__.md

#### __init__

Initializes a new instance of the TextureBrush class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the TextureBrush class with image file.

```python
def __init__(self, image_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_file_path | System.String | Image file path. |

#### __init__

Initializes a new instance of the TextureBrush class with image stream option.

```python
def __init__(self, image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | Image stream. |

### image_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/texturebrush/image_file_path.md

#### image_file_path property

Gets or sets the texture image file path.
This property is used only if ImageStream is not specified.
##### Definition:
```python
@property
def image_file_path(self):
    ...
@image_file_path.setter
def image_file_path(self, value):
    ...
```

### image_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/texturebrush/image_stream.md

#### image_stream property

Gets or sets the texture image stream.
If this property is specified it is always used instead ImageFilePath.
##### Definition:
```python
@property
def image_stream(self):
    ...
@image_stream.setter
def image_stream(self, value):
    ...
```

### VCard class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard.md

#### VCard class

Represents Electronic Business Card standard contact details.

The VCard type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates VCard instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| first_name | Gets or sets contact First Name. |
| midddle_name | Gets or sets contact Middle Name. |
| last_name | Gets or sets contact Last Name. |
| initials | Gets or sets contact initials. |
| company | Gets or sets Company of contact. |
| job_title | Gets or sets contact Job Title. |
| home_address | Gets or sets Home Address properties. This property is not initialized by default. |
| work_address | Gets or sets Work Address properties. This property is not initialized by default. |
| home_phone | Gets or sets home phone number. |
| work_phone | Gets or sets work phone number. |
| cell_phone | Gets or sets cellular phone number. |
| email | Gets or sets contact email. |
| url | Gets or sets contact URL. |
| birth_day | Gets or sets contact birthday. |

### VCard constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/__init__.md

#### __init__

Creates VCard instance with default values.

```python
def __init__(self):
    ...
```

### birth_day property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/birth_day.md

#### birth_day property

Gets or sets contact birthday.
##### Definition:
```python
@property
def birth_day(self):
    ...
@birth_day.setter
def birth_day(self, value):
    ...
```

### cell_phone property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/cell_phone.md

#### cell_phone property

Gets or sets cellular phone number.
##### Definition:
```python
@property
def cell_phone(self):
    ...
@cell_phone.setter
def cell_phone(self, value):
    ...
```

### company property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/company.md

#### company property

Gets or sets Company of contact.
##### Definition:
```python
@property
def company(self):
    ...
@company.setter
def company(self, value):
    ...
```

### email property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/email.md

#### email property

Gets or sets contact email.
##### Definition:
```python
@property
def email(self):
    ...
@email.setter
def email(self, value):
    ...
```

### first_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/first_name.md

#### first_name property

Gets or sets contact First Name.
##### Definition:
```python
@property
def first_name(self):
    ...
@first_name.setter
def first_name(self, value):
    ...
```

### home_address property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/home_address.md

#### home_address property

Gets or sets Home Address properties. This property is not initialized by default.
##### Definition:
```python
@property
def home_address(self):
    ...
@home_address.setter
def home_address(self, value):
    ...
```

### home_phone property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/home_phone.md

#### home_phone property

Gets or sets home phone number.
##### Definition:
```python
@property
def home_phone(self):
    ...
@home_phone.setter
def home_phone(self, value):
    ...
```

### initials property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/initials.md

#### initials property

Gets or sets contact initials.
##### Definition:
```python
@property
def initials(self):
    ...
@initials.setter
def initials(self, value):
    ...
```

### job_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/job_title.md

#### job_title property

Gets or sets contact Job Title.
##### Definition:
```python
@property
def job_title(self):
    ...
@job_title.setter
def job_title(self, value):
    ...
```

### last_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/last_name.md

#### last_name property

Gets or sets contact Last Name.
##### Definition:
```python
@property
def last_name(self):
    ...
@last_name.setter
def last_name(self, value):
    ...
```

### midddle_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/midddle_name.md

#### midddle_name property

Gets or sets contact Middle Name.
##### Definition:
```python
@property
def midddle_name(self):
    ...
@midddle_name.setter
def midddle_name(self, value):
    ...
```

### url property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/url.md

#### url property

Gets or sets contact URL.
##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### work_address property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/work_address.md

#### work_address property

Gets or sets Work Address properties. This property is not initialized by default.
##### Definition:
```python
@property
def work_address(self):
    ...
@work_address.setter
def work_address(self, value):
    ...
```

### work_phone property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/vcard/work_phone.md

#### work_phone property

Gets or sets work phone number.
##### Definition:
```python
@property
def work_phone(self):
    ...
@work_phone.setter
def work_phone(self, value):
    ...
```

### WiFi class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi.md

#### WiFi class

Represents WiFi network connection details.

The WiFi type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates WiFi instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| ssid | Gets or sets WiFi SSID Name. |
| password | Gets or sets WiFi Password. |
| encryption | Gets or sets WiFi encryption `WiFiEncryptionType`. |
| hidden | Gets or sets if WiFi is Hidden SSID. |

### WiFi constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi/__init__.md

#### __init__

Creates WiFi instance with default values.

```python
def __init__(self):
    ...
```

### encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi/encryption.md

#### encryption property

Gets or sets WiFi encryption `WiFiEncryptionType`.
##### Definition:
```python
@property
def encryption(self):
    ...
@encryption.setter
def encryption(self, value):
    ...
```

### hidden property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi/hidden.md

#### hidden property

Gets or sets if WiFi is Hidden SSID.
##### Definition:
```python
@property
def hidden(self):
    ...
@hidden.setter
def hidden(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi/password.md

#### password property

Gets or sets WiFi Password.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### ssid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifi/ssid.md

#### ssid property

Gets or sets WiFi SSID Name.
##### Definition:
```python
@property
def ssid(self):
    ...
@ssid.setter
def ssid(self, value):
    ...
```

### WiFiEncryptionType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.extensions/wifiencryptiontype.md

#### WiFiEncryptionType enumeration

Represents WiFi Encryption type.

The WiFiEncryptionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Represents no encryption WiFi type. |
| WPA | Represents WiFi with the WPA encryption type. |
| WPAEAP | Represents WiFi with the WPA-EAP encryption type. |
| WPAWPA2 | Represents WiFi with the WPA/WPA2 encryption type. |
| WEP | Represents WiFi with the WEP encryption type. |

### groupdocs.signature.domain
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain.md

The namespace provides classes for working with document representation.

##### Classes
| Class | Description |
| :- | :- |
| `Background` | Represents background appearance |
| `BarcodeSignature` | Contains Barcode Signature properties. |
| `BarcodeType` | Specifies Barcode type properties. |
| `BarcodeTypes` | Barcode Types container. |
| `BaseSignature` | Describes base class for signatures. |
| `Border` | Represents border appearance |
| `CertificateMetadataSignature` | Contains Certificate Metadata Signature properties. |
| `CheckboxFormFieldSignature` | Contains check-box input form field signature properties. |
| `ComboboxFormFieldSignature` | Contains combo-box input form field signature properties. |
| `Corners` | Represents corners of a square graphical object. |
| `DeleteResult` | Result of signature(s) deletion from the document. |
| `DigitalFormFieldSignature` | Contains digital signature input form field properties for Pdf Documents. |
| `DigitalSignature` | Contains Digital signature properties. |
| `DocumentInfo` | Defines document description properties. |
| `DocumentResultSignature` | Result of processing archive document signing process for document with newly created signatures. |
| `FileType` | Represents file type. |
| `FormFieldSignature` | Contains Form field signature properties. |
| `IAlignment` | Describes signature area alignment on a document page. |
| `IDocumentInfo` | Defines document description properties. |
| `IRectangle` | Defines interface properties for signature area on a document page. |
| `IResult` | Common interface for signature process result. |
| `IRotation` | Defines properties for signature rotation. |
| `ITextAlignment` | Defines alignment properties for text on text signatures. |
| `ITransparency` | Define Transparency property for different objects appearances |
| `ImageMetadataSignature` | Contains Image Metadata signature properties. |
| `ImageSignature` | Contains Image signature properties. |
| `MetadataSignature` | Contains Metadata signature properties. |
| `MetadataSignatureCollection` | Collection of Metadata signature objects. |
| `Padding` | Represents padding or margin information associated with element. |
| `PageInfo` | Document page description class |
| `PdfDigitalSignature` | Contains Pdf Digital signature properties. |
| `PdfMetadataSignature` | Contains Pdf Metadata signature properties. |
| `PdfMetadataSignatures` | Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options. |
| `PresentationMetadataSignature` | Contains Presentation metadata signature properties. |
| `ProcessLog` | Represents document process details. |
| `QrCodeSignature` | Contains QR-code signature properties. |
| `QrCodeType` | Specify QRCode type properties. |
| `QrCodeTypes` | QRCode Types container. |
| `RadioButtonFormFieldSignature` | Contains radio-button input form field signature properties. |
| `SearchResult` | Result of searching for signatures in specified document. |
| `SignResult` | Result of signing process for document with newly created signatures. |
| `SignatureFont` | Creates instance of SignatureFont class to specify Font properties. |
| `SpreadsheetMetadataSignature` | Contains Spreadsheet Metadata Signature properties. |
| `SquareBorder` | Instance to keep Border line properties for square stamp line. |
| `StampLine` | Specify Stamp line properties. |
| `StampType` | Specify stamp type properties. |
| `StampTypes` | Stamp types container. |
| `TextFormFieldSignature` | Contains text input form field signature properties for Pdf Document |
| `TextSignature` | Contains Text signature properties. |
| `TimeStamp` | Represents data to get time stamp from third-party site. |
| `UpdateResult` | Result of modification of signatures in the document. |
| `VerificationResult` | Instance to keep results of verification process. |
| `WordProcessingMetadataSignature` | Contains WordProcessing Metadata Signature properties. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `CodeTextAlignment` | Alignment of code text for Barcodes and QR-codes. |
| `DashStyle` | Represents style of dash drawing lines on documents. |
| `DocumentType` | Defines the Document type. |
| `FormFieldType` | Specifies Form Field type. |
| `FormTextFieldType` | Defines types of text for WordsProcessing document form fields. |
| `HashAlgorithm` | Specifies the hash algorithm used for cryptographic signing. |
| `HorizontalAlignment` | Specifies horizontal alignment of element on a document page. |
| `ImageSaveFileFormat` | Defines different save file formats. |
| `MeasureType` | Specifies measure units of signature on a document page. |
| `MetadataType` | Specifies the supported Metadata signature data type of the value. |
| `PdfDigitalSignatureType` | Describes enumeration of PDF digital signature type. |
| `PdfSaveFileFormat` | Defines different save file formats. |
| `PdfTextAnnotationBorderEffect` | Describes effect which should be applied to the border of the PDF text annotations. |
| `PdfTextStickerIcon` | Describes enumeration of PDF Text annotation sticker icon appearance. |
| `PdfTextStickerState` | Describes enumeration of PDF text annotation sticker states. |
| `PresentationSaveFileFormat` | Defines different save file formats. |
| `ProcessStatus` | Specifies status of signing and verification processes. |
| `ProcessType` | Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete |
| `ShapePosition` | Specifies shape position in the document layout |
| `SignatureType` | Defines supported types of signatures for various processes like Sign, Verify, Search, Update, Delete |
| `SpreadsheetSaveFileFormat` | Defines different save formats for Spreadsheet documents. |
| `StampBackgroundCropType` | Specifies crop type of background layer on Stamp elements. |
| `StampTextRepeatType` | Specifies type of text repeat for stamp lines. |
| `StretchMode` | Represents stretch mode of signature area on a document page. |
| `TextHorizontalAlignment` | Specifies text horizontal alignment inside a signature. |
| `TextMatchType` | Specifies text match type in string. |
| `TextShapeType` | Specifies types of text shapes. |
| `TextSignatureImplementation` | Specifies type of implementation for PDF text signature. |
| `TextVerticalAlignment` | Specifies text vertical alignment inside a signature. |
| `VerticalAlignment` | Specifies vertical alignment of element on a document page. |
| `WordProcessingSaveFileFormat` | Defines different save file formats for WordProcessing documents. |
| `WordProcessingTextSignatureImplementation` | Specifies type of text signature implementation for WordProcessing documents. |
| `XAdESType` | Type of XML Advanced Electronic Signature (XAdES). |

### Background class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background.md

#### Background class

Represents background appearance

The Background type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Background |

##### Properties
| Property | Description |
| :- | :- |
| color | Gets or sets the background color of signature. |
| transparency | Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)). |
| brush | Gets or sets the background brush. Value by default is null.
<br/>This property expects instance of Brush objects implementations
<br/>See different Brush classes |

##### Methods
| Method | Description |
| :- | :- |
| clone | Implement IClonable interface |

### Background constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background/__init__.md

#### __init__

Constructs a new instance of Background

```python
def __init__(self):
    ...
```

### brush property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background/brush.md

#### brush property

Gets or sets the background brush. Value by default is null.
This property expects instance of Brush objects implementations
See different Brush classes
##### Definition:
```python
@property
def brush(self):
    ...
@brush.setter
def brush(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background/clone.md

#### clone

Implement IClonable interface

##### Returns

Newly created Border instance with same properties

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background/color.md

#### color property

Gets or sets the background color of signature.
##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/background/transparency.md

#### transparency property

Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### BarcodeSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature.md

#### BarcodeSignature class

Contains Barcode Signature properties.

**Inheritance:** `BarcodeSignature` →
`BaseSignature`

The BarcodeSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize BarcodeSignature object with signature identifier that was obtained after search process.
<br/>This unique identifier is used to find additional properties for this signature from document signature information layer. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| encode_type | Specifies the Barcode Encode Type. |
| text | Specifies text of Barcode. |
| format | Specifies the format of Barcode signature image. |
| content | Specifies Barcode binary data image content of type `BarcodeSignature.format`.
<br/>By default this property will not be set.
<br/>Use property `BarcodeSearchOptions.return_content` to enable this feature. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Barcode Signature instance. |

### BarcodeSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/__init__.md

#### __init__

Initialize BarcodeSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

```python
def __init__(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String | Unique signature identifier obtained by Sign or Search method of Signature class `Signature`. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/clone.md

#### clone

Clone Barcode Signature instance.

##### Returns

Returns cloned Barcode Signature instance.

```python
def clone(self):
    ...
```

### content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/content.md

#### content property

Specifies Barcode binary data image content of type `BarcodeSignature.format`.
By default this property will not be set.
Use property `BarcodeSearchOptions.return_content` to enable this feature.
##### Definition:
```python
@property
def content(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/encode_type.md

#### encode_type property

Specifies the Barcode Encode Type.
##### Definition:
```python
@property
def encode_type(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/format.md

#### format property

Specifies the format of Barcode signature image.
##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/text.md

#### text property

Specifies text of Barcode.
##### Definition:
```python
@property
def text(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/top.md

#### top property

Specifies top position of signature.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodesignature/width.md

#### width property

Specifies width of signature.

### BarcodeType class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetype.md

#### BarcodeType class

Specifies Barcode type properties.

The BarcodeType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type_index | Gets object index in a collection of supported Barcode types. |
| type_name | Name of Barcode Type. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified BarcodeType is equal to the current object. |

### equals method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetype/equals.md

#### equals

Determines whether the specified BarcodeType is equal to the current object.

##### Returns

Result of comparison.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.signature.domain.BarcodeType | Object for comparison. |

### type_index property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetype/type_index.md

#### type_index property

Gets object index in a collection of supported Barcode types.
##### Definition:
```python
@property
def type_index(self):
    ...
```

### type_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetype/type_name.md

#### type_name property

Name of Barcode Type.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### BarcodeTypes class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes.md

#### BarcodeTypes class

Barcode Types container.

The BarcodeTypes type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| all_types | All barcode types. |
| AUSTRALIAN_POSTE_PARCEL | Australian Post eParcel Barcode Type object. |
| AUSTRALIAN_POST | Australian Post Barcode Type object. |
| CODABAR | Codabar Barcode Type object. |
| CODABLOCK_F | CodablockF Barcode Type object. |
| CODE11 | Code11 Barcode Type object. |
| CODE128 | Code128 Barcode Type object. |
| CODE_16K | Code16K Barcode Type object. |
| CODE32 | Code32 Barcode Type object. |
| CODE_39_FULL_ASCII | Code39FullASCII Barcode Type object. |
| CODE39 | Code39 Barcode Type object. |
| CODE_93_STANDARD | Code93Standard Barcode Type object. |
| DATABAR_EXPANDED | DatabarExpanded Barcode Type object. |
| DATABAR_EXPANDED_STACKED | DatabarExpandedStacked Barcode Type object. |
| DATABAR_LIMITED | DatabarLimited Barcode Type object. |
| DATABAR_OMNI_DIRECTIONAL | DatabarOmniDirectional Barcode Type object. |
| DATABAR_STACKED | DatabarStacked Barcode Type object. |
| DATABAR_STACKED_OMNI_DIRECTIONAL | DatabarStackedOmniDirectional Barcode Type object. |
| DATABAR_TRUNCATED | DatabarTruncated Barcode Type object. |
| DATA_LOGIC_2OF_5 | DataLogic2of5 Barcode Type object. |
| DEUTSCHE_POST_IDENTCODE | DeutschePostIdentcode Barcode Type object. |
| DEUTSCHE_POST_LEITCODE | DeutschePostLeitcode Barcode Type object. |
| DOT_CODE | DotCode Barcode Type object. |
| DUTCH_KIX | DutchKIX Barcode Type object. |
| EAN8 | EAN8 Barcode Type object. |
| EAN13 | EAN13 Barcode Type object. |
| EAN14 | EAN14 Barcode Type object. |
| GS1_CODABLOCK_F | GS1CodablockF Barcode Type object. |
| GS1_CODE_128 | GS1 Code128 Barcode Type object. |
| GS1_COMPOSITE_BAR | GS1 Composite Barcode Type object. |
| IATA2OF_5 | IATA2of5 Barcode Type object. |
| INTERLEAVED_2OF_5 | Interleaved2of5 Barcode Type object. |
| ISBN | ISBN Barcode Type object. |
| ISMN | ISMN Barcode Type object. |
| ISSN | ISSN Barcode Type object. |
| ITALIAN_POST25 | ItalianPost25 Barcode Type object. |
| ITF14 | ITF14 Barcode Type object. |
| ITF6 | ITF6 Barcode Type object. |
| MACRO_PDF417 | MacroPdf417 Barcode Type object. |
| MAILMARK | Royal Mail 2D Mailmark Barcode Type object. |
| MATRIX_2OF_5 | Matrix2of5 Barcode Type object. |
| MAXI_CODE | MaxiCode Barcode Type object. |
| MICRO_PDF417 | MicroPdf417 Barcode Type object. |
| MSI | MSI Barcode Type object. |
| ONE_CODE | OneCode Barcode Type object. |
| OPC | OPC Barcode Type object. |
| PATCH_CODE | Patch Code Barcode Type object. |
| PDF417 | Pdf417 Barcode Type object. |
| PHARMACODE | Pharma code Barcode Type object. |
| PLANET | Planet Barcode Type object. |
| POSTNET | Postnet Barcode Type object. |
| PZN | PZN Barcode Type object. |
| RM4SCC | RM4SCC Barcode Type object. |
| SCC14 | SCC14 Barcode Type object. |
| SINGAPORE_POST | SingaporePost Barcode Type object. |
| SSCC18 | SSCC18 Barcode Type object. |
| STANDARD_2OF_5 | Standard2of5 Barcode Type object. |
| SWISS_POST_PARCEL | SwissPostParcel Barcode Type object. |
| UPCA | UPCA Barcode Type object. |
| UPCA_GS_1_CODE_128_COUPON | UpcaGs1Code128Coupon Barcode Type object. |
| UPCA_GS_1_DATABAR_COUPON | UpcaGs1DatabarCoupon Barcode Type object. |
| UPCE | UPCE Barcode Type object. |
| VIN | VIN Barcode Type object. |
| HIBC_CODE_39LIC | HIBC LIC 39 Barcode Type object. |
| HIBC_CODE_128LIC | HIBC LIC 128 Barcode Type object. |
| HIBC_CODE_39PAS | HIBC PAS 39 Barcode Type object. |
| HIBC_CODE_128PAS | HIBC PAS 128 Barcode Type object. |
| GS1_DOT_CODE | GS1 DotCode Barcode Type object. |
| GS1_AZTEC | GS1Aztec Barcode Type object. |
| GS1_MICRO_PDF_417 | GS1MicroPdf417 Barcode Type object. |
| CODE93 | Code93 Barcode Type object. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown. |
| try_parse | Returns Barcode type with pasringType name. If name of Barcode is unknown -
<br/>no Exception will be thrown but method will return null value. |

### all_types property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/all_types.md

#### all_types property

All barcode types.

### AUSTRALIAN_POST property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/australian_post.md

#### AUSTRALIAN_POST property

Australian Post Barcode Type object.

### AUSTRALIAN_POSTE_PARCEL property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/australian_poste_parcel.md

#### AUSTRALIAN_POSTE_PARCEL property

Australian Post eParcel Barcode Type object.

### CODABAR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/codabar.md

#### CODABAR property

Codabar Barcode Type object.

### CODABLOCK_F property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/codablock_f.md

#### CODABLOCK_F property

CodablockF Barcode Type object.

### CODE11 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code11.md

#### CODE11 property

Code11 Barcode Type object.

### CODE128 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code128.md

#### CODE128 property

Code128 Barcode Type object.

### CODE32 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code32.md

#### CODE32 property

Code32 Barcode Type object.

### CODE39 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code39.md

#### CODE39 property

Code39 Barcode Type object.

### CODE93 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code93.md

#### CODE93 property

Code93 Barcode Type object.

### CODE_16K property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code_16k.md

#### CODE_16K property

Code16K Barcode Type object.

### CODE_39_FULL_ASCII property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code_39_full_ascii.md

#### CODE_39_FULL_ASCII property

Code39FullASCII Barcode Type object.

### CODE_93_STANDARD property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/code_93_standard.md

#### CODE_93_STANDARD property

Code93Standard Barcode Type object.

### DATA_LOGIC_2OF_5 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/data_logic_2of_5.md

#### DATA_LOGIC_2OF_5 property

DataLogic2of5 Barcode Type object.

### DATABAR_EXPANDED property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_expanded.md

#### DATABAR_EXPANDED property

DatabarExpanded Barcode Type object.

### DATABAR_EXPANDED_STACKED property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_expanded_stacked.md

#### DATABAR_EXPANDED_STACKED property

DatabarExpandedStacked Barcode Type object.

### DATABAR_LIMITED property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_limited.md

#### DATABAR_LIMITED property

DatabarLimited Barcode Type object.

### DATABAR_OMNI_DIRECTIONAL property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_omni_directional.md

#### DATABAR_OMNI_DIRECTIONAL property

DatabarOmniDirectional Barcode Type object.

### DATABAR_STACKED property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_stacked.md

#### DATABAR_STACKED property

DatabarStacked Barcode Type object.

### DATABAR_STACKED_OMNI_DIRECTIONAL property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_stacked_omni_directional.md

#### DATABAR_STACKED_OMNI_DIRECTIONAL property

DatabarStackedOmniDirectional Barcode Type object.

### DATABAR_TRUNCATED property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/databar_truncated.md

#### DATABAR_TRUNCATED property

DatabarTruncated Barcode Type object.

### DEUTSCHE_POST_IDENTCODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/deutsche_post_identcode.md

#### DEUTSCHE_POST_IDENTCODE property

DeutschePostIdentcode Barcode Type object.

### DEUTSCHE_POST_LEITCODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/deutsche_post_leitcode.md

#### DEUTSCHE_POST_LEITCODE property

DeutschePostLeitcode Barcode Type object.

### DOT_CODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/dot_code.md

#### DOT_CODE property

DotCode Barcode Type object.

### DUTCH_KIX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/dutch_kix.md

#### DUTCH_KIX property

DutchKIX Barcode Type object.

### EAN13 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/ean13.md

#### EAN13 property

EAN13 Barcode Type object.

### EAN14 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/ean14.md

#### EAN14 property

EAN14 Barcode Type object.

### EAN8 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/ean8.md

#### EAN8 property

EAN8 Barcode Type object.

### GS1_AZTEC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_aztec.md

#### GS1_AZTEC property

GS1Aztec Barcode Type object.

### GS1_CODABLOCK_F property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_codablock_f.md

#### GS1_CODABLOCK_F property

GS1CodablockF Barcode Type object.

### GS1_CODE_128 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_code_128.md

#### GS1_CODE_128 property

GS1 Code128 Barcode Type object.

### GS1_COMPOSITE_BAR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_composite_bar.md

#### GS1_COMPOSITE_BAR property

GS1 Composite Barcode Type object.

### GS1_DOT_CODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_dot_code.md

#### GS1_DOT_CODE property

GS1 DotCode Barcode Type object.

### GS1_MICRO_PDF_417 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/gs1_micro_pdf_417.md

#### GS1_MICRO_PDF_417 property

GS1MicroPdf417 Barcode Type object.

### HIBC_CODE_128LIC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/hibc_code_128lic.md

#### HIBC_CODE_128LIC property

HIBC LIC 128 Barcode Type object.

### HIBC_CODE_128PAS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/hibc_code_128pas.md

#### HIBC_CODE_128PAS property

HIBC PAS 128 Barcode Type object.

### HIBC_CODE_39LIC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/hibc_code_39lic.md

#### HIBC_CODE_39LIC property

HIBC LIC 39 Barcode Type object.

### HIBC_CODE_39PAS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/hibc_code_39pas.md

#### HIBC_CODE_39PAS property

HIBC PAS 39 Barcode Type object.

### IATA2OF_5 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/iata2of_5.md

#### IATA2OF_5 property

IATA2of5 Barcode Type object.

### INTERLEAVED_2OF_5 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/interleaved_2of_5.md

#### INTERLEAVED_2OF_5 property

Interleaved2of5 Barcode Type object.

### ISBN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/isbn.md

#### ISBN property

ISBN Barcode Type object.

### ISMN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/ismn.md

#### ISMN property

ISMN Barcode Type object.

### ISSN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/issn.md

#### ISSN property

ISSN Barcode Type object.

### ITALIAN_POST25 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/italian_post25.md

#### ITALIAN_POST25 property

ItalianPost25 Barcode Type object.

### ITF14 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/itf14.md

#### ITF14 property

ITF14 Barcode Type object.

### ITF6 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/itf6.md

#### ITF6 property

ITF6 Barcode Type object.

### MACRO_PDF417 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/macro_pdf417.md

#### MACRO_PDF417 property

MacroPdf417 Barcode Type object.

### MAILMARK property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/mailmark.md

#### MAILMARK property

Royal Mail 2D Mailmark Barcode Type object.

### MATRIX_2OF_5 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/matrix_2of_5.md

#### MATRIX_2OF_5 property

Matrix2of5 Barcode Type object.

### MAXI_CODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/maxi_code.md

#### MAXI_CODE property

MaxiCode Barcode Type object.

### MICRO_PDF417 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/micro_pdf417.md

#### MICRO_PDF417 property

MicroPdf417 Barcode Type object.

### MSI property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/msi.md

#### MSI property

MSI Barcode Type object.

### ONE_CODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/one_code.md

#### ONE_CODE property

OneCode Barcode Type object.

### OPC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/opc.md

#### OPC property

OPC Barcode Type object.

### parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/parse.md

#### parse

Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown.

##### Returns

BarcodeType instance.

```python
def parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of barcode type name. |

### PATCH_CODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/patch_code.md

#### PATCH_CODE property

Patch Code Barcode Type object.

### PDF417 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/pdf417.md

#### PDF417 property

Pdf417 Barcode Type object.

### PHARMACODE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/pharmacode.md

#### PHARMACODE property

Pharma code Barcode Type object.

### PLANET property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/planet.md

#### PLANET property

Planet Barcode Type object.

### POSTNET property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/postnet.md

#### POSTNET property

Postnet Barcode Type object.

### PZN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/pzn.md

#### PZN property

PZN Barcode Type object.

### RM4SCC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/rm4scc.md

#### RM4SCC property

RM4SCC Barcode Type object.

### SCC14 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/scc14.md

#### SCC14 property

SCC14 Barcode Type object.

### SINGAPORE_POST property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/singapore_post.md

#### SINGAPORE_POST property

SingaporePost Barcode Type object.

### SSCC18 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/sscc18.md

#### SSCC18 property

SSCC18 Barcode Type object.

### STANDARD_2OF_5 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/standard_2of_5.md

#### STANDARD_2OF_5 property

Standard2of5 Barcode Type object.

### SWISS_POST_PARCEL property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/swiss_post_parcel.md

#### SWISS_POST_PARCEL property

SwissPostParcel Barcode Type object.

### try_parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/try_parse.md

#### try_parse

Returns Barcode type with pasringType name. If name of Barcode is unknown -
no Exception will be thrown but method will return null value.

##### Returns

BarcodeType instance.

```python
def try_parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of barcode type name. |

### UPCA property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/upca.md

#### UPCA property

UPCA Barcode Type object.

### UPCA_GS_1_CODE_128_COUPON property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/upca_gs_1_code_128_coupon.md

#### UPCA_GS_1_CODE_128_COUPON property

UpcaGs1Code128Coupon Barcode Type object.

### UPCA_GS_1_DATABAR_COUPON property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/upca_gs_1_databar_coupon.md

#### UPCA_GS_1_DATABAR_COUPON property

UpcaGs1DatabarCoupon Barcode Type object.

### UPCE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/upce.md

#### UPCE property

UPCE Barcode Type object.

### VIN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/barcodetypes/vin.md

#### VIN property

VIN Barcode Type object.

### BaseSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature.md

#### BaseSignature class

Describes base class for signatures.

The BaseSignature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone signature instance. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/clone.md

#### clone

Clone signature instance.

##### Returns

Returns cloned Signature instance

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/created_on.md

#### created_on property

Get or set the signature creation date.
##### Definition:
```python
@property
def created_on(self):
    ...
@created_on.setter
def created_on(self, value):
    ...
```

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.
##### Definition:
```python
@property
def deleted(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/height.md

#### height property

Specifies height of signature.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).
##### Definition:
```python
@property
def is_signature(self):
    ...
@is_signature.setter
def is_signature(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/left.md

#### left property

Specifies left position of signature.
##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/modified_on.md

#### modified_on property

Get or set the signature modification date.
##### Definition:
```python
@property
def modified_on(self):
    ...
@modified_on.setter
def modified_on(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/page_number.md

#### page_number property

Specifies the page signature was found on.
##### Definition:
```python
@property
def page_number(self):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.
##### Definition:
```python
@property
def signature_id(self):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/signature_type.md

#### signature_type property

Specifies the type of signature.
##### Definition:
```python
@property
def signature_type(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/top.md

#### top property

Specifies top position of signature.
##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/basesignature/width.md

#### width property

Specifies width of signature.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### Border class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border.md

#### Border class

Represents border appearance

The Border type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Border |

##### Properties
| Property | Description |
| :- | :- |
| dash_style | Gets or sets the signature border style. |
| transparency | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| weight | Gets or sets the weight of the signature border. |
| color | Gets or sets the border color of signature. |
| visible | Gets or sets the border visibility. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Implement IClonable interface |

### Border constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/__init__.md

#### __init__

Constructs a new instance of Border

```python
def __init__(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/clone.md

#### clone

Implement IClonable interface

##### Returns

Newly created Border instance with same properties

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/color.md

#### color property

Gets or sets the border color of signature.
##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### dash_style property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/dash_style.md

#### dash_style property

Gets or sets the signature border style.
##### Definition:
```python
@property
def dash_style(self):
    ...
@dash_style.setter
def dash_style(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/transparency.md

#### transparency property

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### visible property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/visible.md

#### visible property

Gets or sets the border visibility.
##### Definition:
```python
@property
def visible(self):
    ...
@visible.setter
def visible(self, value):
    ...
```

### weight property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/border/weight.md

#### weight property

Gets or sets the weight of the signature border.
##### Definition:
```python
@property
def weight(self):
    ...
@weight.setter
def weight(self, value):
    ...
```

### CertificateMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature.md

#### CertificateMetadataSignature class

Contains Certificate Metadata Signature properties.

**Inheritance:** `CertificateMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The CertificateMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Certificate Metadata Signature with predefined name and empty value. |
| __init__ | Creates Certificate Metadata Signature with predefined values. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Certificate Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### CertificateMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/__init__.md

#### __init__

Creates Certificate Metadata Signature with predefined name and empty value.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Certificate Metadata Signature name. |

#### __init__

Creates Certificate Metadata Signature with predefined values.

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object. |
| value | System.Object | Value of Metadata signature. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Certificate Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/certificatemetadatasignature/width.md

#### width property

Specifies width of signature.

### CheckboxFormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature.md

#### CheckboxFormFieldSignature class

Contains check-box input form field signature properties.

**Inheritance:** `CheckboxFormFieldSignature` →
`FormFieldSignature` →
`BaseSignature`

The CheckboxFormFieldSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates CheckboxFormFieldSignature with predefined name. |
| __init__ | Creates CheckboxFormFieldSignature with predefined name and value |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |
| checked | Gets or sets checked value of form field check-box input. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### CheckboxFormFieldSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/__init__.md

#### __init__

Creates CheckboxFormFieldSignature with predefined name.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |

#### __init__

Creates CheckboxFormFieldSignature with predefined name and value

```python
def __init__(self, name, is_checked):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |
| is_checked | bool | Value if check box is checked |

### checked property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/checked.md

#### checked property

Gets or sets checked value of form field check-box input.
##### Definition:
```python
@property
def checked(self):
    ...
@checked.setter
def checked(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/name.md

#### name property

Specifies unique form field name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/type.md

#### type property

Specifies Form field type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/value.md

#### value property

Specifies Form field data object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/checkboxformfieldsignature/width.md

#### width property

Specifies width of signature.

### CodeTextAlignment enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/codetextalignment.md

#### CodeTextAlignment enumeration

Alignment of code text for Barcodes and QR-codes.

The CodeTextAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Text is not visible. |
| ABOVE | Text is above the code. |
| BELOW | Text is below the code. |

### ComboboxFormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature.md

#### ComboboxFormFieldSignature class

Contains combo-box input form field signature properties.

**Inheritance:** `ComboboxFormFieldSignature` →
`FormFieldSignature` →
`BaseSignature`

The ComboboxFormFieldSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates ComboboxFormFieldSignature with predefined name. |
| __init__ | Constructs a new instance of ComboboxFormFieldSignature |
| __init__ | Constructs a new instance of ComboboxFormFieldSignature |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |
| selected | Get or set selected value. |
| items | Get or set combo-box options list. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### ComboboxFormFieldSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/__init__.md

#### __init__

Creates ComboboxFormFieldSignature with predefined name.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |

#### __init__

Constructs a new instance of ComboboxFormFieldSignature

```python
def __init__(self, name, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String |  |
| items | System.Collections.Generic.List`1[[System.String]] |  |

#### __init__

Constructs a new instance of ComboboxFormFieldSignature

```python
def __init__(self, name, items, selected):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String |  |
| items | System.Collections.Generic.List`1[[System.String]] |  |
| selected | System.Object |  |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### items property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/items.md

#### items property

Get or set combo-box options list.
##### Definition:
```python
@property
def items(self):
    ...
@items.setter
def items(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/name.md

#### name property

Specifies unique form field name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### selected property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/selected.md

#### selected property

Get or set selected value.
##### Definition:
```python
@property
def selected(self):
    ...
@selected.setter
def selected(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/type.md

#### type property

Specifies Form field type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/value.md

#### value property

Specifies Form field data object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/comboboxformfieldsignature/width.md

#### width property

Specifies width of signature.

### Corners class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners.md

#### Corners class

Represents corners of a square graphical object.

The Corners type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of Corners class using zero values. |
| __init__ | Initializes a new instance of the Corners class using the supplied value for all corners. |
| __init__ | Initializes a new instance of the Corners class using the supplied values. |

##### Properties
| Property | Description |
| :- | :- |
| all | Gets or sets the value for all corners.
<br/>Changing of any partial corner like top right makes this property equal 0; |
| top_left | Gets or sets top left corner value. |
| top_right | Gets or sets top right corner value. |
| bottom_left | Gets or sets bottom left corner value. |
| bottom_right | Gets or sets bottom right corner value. |
| EMPTY | Provides a Corners object with no data. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### Corners constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/__init__.md

#### __init__

Initializes a new instance of Corners class using zero values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the Corners class using the supplied value for all corners.

```python
def __init__(self, all):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| all | float | The value to be used for padding for all corners. |

#### __init__

Initializes a new instance of the Corners class using the supplied values.

```python
def __init__(self, top_left, top_right, bottom_left, bottom_right):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| top_left | float | Top left corner value. |
| top_right | float | Top right corner value. |
| bottom_left | float | Bottom left corner value. |
| bottom_right | float | Bottom right corner value. |

### all property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/all.md

#### all property

Gets or sets the value for all corners.
Changing of any partial corner like top right makes this property equal 0;
##### Definition:
```python
@property
def all(self):
    ...
@all.setter
def all(self, value):
    ...
```

### bottom_left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/bottom_left.md

#### bottom_left property

Gets or sets bottom left corner value.
##### Definition:
```python
@property
def bottom_left(self):
    ...
@bottom_left.setter
def bottom_left(self, value):
    ...
```

### bottom_right property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/bottom_right.md

#### bottom_right property

Gets or sets bottom right corner value.
##### Definition:
```python
@property
def bottom_right(self):
    ...
@bottom_right.setter
def bottom_right(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### EMPTY property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/empty.md

#### EMPTY property

Provides a Corners object with no data.

### top_left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/top_left.md

#### top_left property

Gets or sets top left corner value.
##### Definition:
```python
@property
def top_left(self):
    ...
@top_left.setter
def top_left(self, value):
    ...
```

### top_right property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/corners/top_right.md

#### top_right property

Gets or sets top right corner value.
##### Definition:
```python
@property
def top_right(self):
    ...
@top_right.setter
def top_right(self, value):
    ...
```

### DashStyle enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/dashstyle.md

#### DashStyle enumeration

Represents style of dash drawing lines on documents.

The DashStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOLID | Represent a solid line. |
| SHORT_DASH | Represent a short dash line. |
| SHORT_DOT | Represent a short dot line. |
| SHORT_DASH_DOT | Represent a short dash-dot line. |
| SHORT_DASH_DOT_DOT | Represent a short dash-dot-dot line. |
| DOT | Represent a square dot style. |
| DASH | Represent a dash line style. |
| LONG_DASH | Represent a long dash style. |
| DASH_DOT | Dash short dash. |
| LONG_DASH_DOT | Long dash short dash. |
| LONG_DASH_DOT_DOT | Long dash short dash short dash. |
| ROUND_DOT | Represents a round-dot line. |
| SQUARE_DOT | Represents a square-dot line. |
| DASH_DOT_DOT | Represents a dash-dot-dot line. |
| DASH_LONG_DASH | Represents a long dash-short dash line. |
| DASH_LONG_DASH_DOT | Represents a long dash-short dash-dot line. |

### DeleteResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult.md

#### DeleteResult class

Result of signature(s) deletion from the document.

The DeleteResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the process in milliseconds. |
| total_signatures | Returns the total processed signatures. |
| source_document_size | Returns source document size. |
| destin_document_size | Returns updated document size. |
| succeeded | List of successfully deleted signatures `BaseSignature`. |
| failed | List of signatures that were not deleted `BaseSignature`. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/destin_document_size.md

#### destin_document_size property

Returns updated document size.
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/failed.md

#### failed property

List of signatures that were not deleted `BaseSignature`.
##### Definition:
```python
@property
def failed(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds.
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/source_document_size.md

#### source_document_size property

Returns source document size.
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/succeeded.md

#### succeeded property

List of successfully deleted signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/deleteresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures.
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### DigitalFormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature.md

#### DigitalFormFieldSignature class

Contains digital signature input form field properties for Pdf Documents.

**Inheritance:** `DigitalFormFieldSignature` →
`FormFieldSignature` →
`BaseSignature`

The DigitalFormFieldSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PdfDigitalFormFieldSignature with predefined name. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |
| signed | Read-only property that shows if Form-field Signature was signed with digital certificate. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### DigitalFormFieldSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/__init__.md

#### __init__

Creates PdfDigitalFormFieldSignature with predefined name.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/name.md

#### name property

Specifies unique form field name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### signed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/signed.md

#### signed property

Read-only property that shows if Form-field Signature was signed with digital certificate.
##### Definition:
```python
@property
def signed(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/type.md

#### type property

Specifies Form field type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/value.md

#### value property

Specifies Form field data object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalformfieldsignature/width.md

#### width property

Specifies width of signature.

### DigitalSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature.md

#### DigitalSignature class

Contains Digital signature properties.

**Inheritance:** `DigitalSignature` →
`BaseSignature`

The DigitalSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize Digital signature with default parameters. |
| __init__ | Initialize Digital signature with known SignatureId. |
| __init__ | Create Digital signature with specified certificate. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| certificate | Gets or sets the X509 certificate. |
| comments | Gets or sets the signing purpose comment. |
| is_valid | Keeps true if this digital signature is valid and the document has not been tampered with. |
| sign_time | Gets or sets the time the document was signed. |
| certificate_custom_store_name | Specifies the custom store name of the certificate. |
| x_ad_es_type | XAdES type `DigitalSignature.x_ad_es_type`. Default value is None (XAdES is off).
<br/>At this moment XAdES signature type is supported only for Spreadsheet documents. |
| thumbprint | Gets the thumbprint of a certificate. |

##### Methods
| Method | Description |
| :- | :- |
| load_digital_signatures | Load Digital signatures from all system X509 Certificates Stores. |
| load_digital_signatures | Load Digital signatures from a certificate storage. |
| clone | Clone Barcode Signature instance. |

### DigitalSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/__init__.md

#### __init__

Initialize Digital signature with default parameters.

```python
def __init__(self):
    ...
```

#### __init__

Initialize Digital signature with known SignatureId.

```python
def __init__(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String |  |

#### __init__

Create Digital signature with specified certificate.

```python
def __init__(self, certificate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate | System.Security.Cryptography.X509Certificates.X509Certificate2 | X509 certificate. |

### certificate property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/certificate.md

#### certificate property

Gets or sets the X509 certificate.
##### Definition:
```python
@property
def certificate(self):
    ...
@certificate.setter
def certificate(self, value):
    ...
```

### certificate_custom_store_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/certificate_custom_store_name.md

#### certificate_custom_store_name property

Specifies the custom store name of the certificate.
##### Definition:
```python
@property
def certificate_custom_store_name(self):
    ...
@certificate_custom_store_name.setter
def certificate_custom_store_name(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/clone.md

#### clone

Clone Barcode Signature instance.

##### Returns

Returns cloned Barcode Signature instance.

```python
def clone(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/comments.md

#### comments property

Gets or sets the signing purpose comment.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/is_valid.md

#### is_valid property

Keeps true if this digital signature is valid and the document has not been tampered with.
##### Definition:
```python
@property
def is_valid(self):
    ...
@is_valid.setter
def is_valid(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/left.md

#### left property

Specifies left position of signature.

### load_digital_signatures method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/load_digital_signatures.md

#### load_digital_signatures

Load Digital signatures from all system X509 Certificates Stores.

##### Returns

Returns list of `DigitalSignature` Digital Signatures.

```python
def load_digital_signatures(self):
    ...
```

#### load_digital_signatures

Load Digital signatures from a certificate storage.

##### Returns

Returns list of `DigitalSignature` Digital Signatures.

```python
def load_digital_signatures(self, store_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| store_name | System.String | Custom name of a digital storage containing certificates. |

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### sign_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/sign_time.md

#### sign_time property

Gets or sets the time the document was signed.
##### Definition:
```python
@property
def sign_time(self):
    ...
@sign_time.setter
def sign_time(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### thumbprint property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/thumbprint.md

#### thumbprint property

Gets the thumbprint of a certificate.
##### Definition:
```python
@property
def thumbprint(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/top.md

#### top property

Specifies top position of signature.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/width.md

#### width property

Specifies width of signature.

### x_ad_es_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/digitalsignature/x_ad_es_type.md

#### x_ad_es_type property

XAdES type `DigitalSignature.x_ad_es_type`. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.
##### Definition:
```python
@property
def x_ad_es_type(self):
    ...
```

### DocumentInfo class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo.md

#### DocumentInfo class

Defines document description properties.

The DocumentInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `DocumentInfo` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_count | Document pages count. |
| pages | Collection of document pages descriptions. |
| width_for_max_height | Specifies width for max page height. |
| max_page_height | Specifies max page height. |
| file_type | File format type. |
| size | Document size in bytes. |
| text_signatures | Collection of document text signatures. |
| image_signatures | Collection of document image signatures added or updated by `Signature` methods. |
| digital_signatures | Collection of document digital signatures added or updated by `Signature` methods. |
| barcode_signatures | Collection of document barcode signatures added or updated by `Signature` methods. |
| qr_code_signatures | Collection of document QR-code signatures added or updated by `Signature` methods. |
| form_field_signatures | Collection of document Form Field signatures added or updated by `Signature` methods. |
| form_fields | Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types. |
| metadata_signatures | Collection of document Metadata signatures. |
| documents | Collection of all existing documents within the archive files. This property is supported only for Archive document types. |
| process_logs | Collection of document history processes like Sign, Update, Delete. |
| signatures | Collection of document all types signatures `BaseSignature`. |

### DocumentInfo constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/__init__.md

#### __init__

Initializes a new instance of the `DocumentInfo` class.

```python
def __init__(self):
    ...
```

### barcode_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/barcode_signatures.md

#### barcode_signatures property

Collection of document barcode signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def barcode_signatures(self):
    ...
```

### digital_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/digital_signatures.md

#### digital_signatures property

Collection of document digital signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def digital_signatures(self):
    ...
```

### documents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/documents.md

#### documents property

Collection of all existing documents within the archive files. This property is supported only for Archive document types.
##### Definition:
```python
@property
def documents(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/file_type.md

#### file_type property

File format type.
##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### form_field_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/form_field_signatures.md

#### form_field_signatures property

Collection of document Form Field signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def form_field_signatures(self):
    ...
```

### form_fields property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/form_fields.md

#### form_fields property

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.
##### Definition:
```python
@property
def form_fields(self):
    ...
```

### image_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/image_signatures.md

#### image_signatures property

Collection of document image signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def image_signatures(self):
    ...
```

### max_page_height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/max_page_height.md

#### max_page_height property

Specifies max page height.
##### Definition:
```python
@property
def max_page_height(self):
    ...
@max_page_height.setter
def max_page_height(self, value):
    ...
```

### metadata_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/metadata_signatures.md

#### metadata_signatures property

Collection of document Metadata signatures.
##### Definition:
```python
@property
def metadata_signatures(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/page_count.md

#### page_count property

Document pages count.
##### Definition:
```python
@property
def page_count(self):
    ...
@page_count.setter
def page_count(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/pages.md

#### pages property

Collection of document pages descriptions.
##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### process_logs property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/process_logs.md

#### process_logs property

Collection of document history processes like Sign, Update, Delete.
##### Definition:
```python
@property
def process_logs(self):
    ...
```

### qr_code_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/qr_code_signatures.md

#### qr_code_signatures property

Collection of document QR-code signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def qr_code_signatures(self):
    ...
```

### signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/signatures.md

#### signatures property

Collection of document all types signatures `BaseSignature`.
##### Definition:
```python
@property
def signatures(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/size.md

#### size property

Document size in bytes.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### text_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/text_signatures.md

#### text_signatures property

Collection of document text signatures.
##### Definition:
```python
@property
def text_signatures(self):
    ...
```

### width_for_max_height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentinfo/width_for_max_height.md

#### width_for_max_height property

Specifies width for max page height.
##### Definition:
```python
@property
def width_for_max_height(self):
    ...
@width_for_max_height.setter
def width_for_max_height(self, value):
    ...
```

### DocumentResultSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature.md

#### DocumentResultSignature class

Result of processing archive document signing process for document with newly created signatures.

**Inheritance:** `DocumentResultSignature` →
`BaseSignature`

The DocumentResultSignature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| file_name | Document file name |
| processing_time | Returns the execution time of the process in milliseconds |
| total_signatures | Returns the total processed signatures |
| source_document_size | Returns source document size |
| destin_document_size | Returns destination document size |
| succeeded | List of successfully processed signatures `BaseSignature`. |
| failed | List of the signatures that failed during the process `BaseSignature`. |
| error_message | if document was processed with error this property will contain the error message |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone signature instance. |

##### Remarks

**Learn more** |
|
 |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/clone.md

#### clone

Clone signature instance.

##### Returns

Returns cloned Signature instance

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/destin_document_size.md

#### destin_document_size property

Returns destination document size
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### error_message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/error_message.md

#### error_message property

if document was processed with error this property will contain the error message
##### Definition:
```python
@property
def error_message(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/failed.md

#### failed property

List of the signatures that failed during the process `BaseSignature`.
##### Definition:
```python
@property
def failed(self):
    ...
```

### file_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/file_name.md

#### file_name property

Document file name
##### Definition:
```python
@property
def file_name(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/source_document_size.md

#### source_document_size property

Returns source document size
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/succeeded.md

#### succeeded property

List of successfully processed signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/top.md

#### top property

Specifies top position of signature.

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/total_signatures.md

#### total_signatures property

Returns the total processed signatures
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documentresultsignature/width.md

#### width property

Specifies width of signature.

### DocumentType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/documenttype.md

#### DocumentType enumeration

Defines the Document type.

The DocumentType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Indicates an error, unknown document type. |
| PDF | PDF Document Type. |
| WORD_PROCESSING | Word Processing Document Type. |
| PRESENTATION | Presentation Document Type. |
| SPREADSHEET | Spreadsheet Document Type. |
| IMAGE | Image Document Type. |
| CERTIFICATE | Certificate file Type. |
| ARCHIVE | Archive file type |

### FileType class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype.md

#### FileType class

Represents file type.

The FileType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_format | File type name e.g. "Microsoft Word Document". |
| extension | Filename suffix (including the period ".") e.g. ".doc". |
| UNKNOWN | Represents unknown file type. |
| TIF | Tagged Image File (.tif) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/tiff). |
| TIFF | Tagged Image File Format (.tiff) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/tiff). |
| JPG | JPEG Image (.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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg). |
| JPEG | JPEG Image (.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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg). |
| PNG | Portable Network Graphic (.png) is a type of raster image file format that use lossless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/png). |
| APNG | Animated Portable Network Graphics (.png) is a raster image file format that uses lossless compression.
<br/>It was developed as an extension of PNG to support animation, serving as an alternative to the GIF format without copyright limitations.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/apng). |
| TGA | Truevision TGA (.tga), also known as TARGA, is a raster image file format developed by Truevision Inc.
<br/>It supports various color depths and optional RLE compression. TGA files are commonly used in video games,
<br/>animation pipelines, and graphics applications for high-quality image rendering with optional alpha channel support.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/tga). |
| GIF | Graphical Interchange Format File (.gif) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/gif). |
| BMP | Bitmap Image File (.bmp) is used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/bmp). |
| WMF | Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/wmf). |
| EMF | Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/emf). |
| WEBP | WebP Image (.webp) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/webp). |
| DJVU | DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/djvu). |
| CGM | Computer Graphics Metafile (.cgm) is a 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/cgm). |
| CDR | CorelDraw Vector Graphic Drawing (.cdr) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/cdr). |
| CMX | CorelDRAW Metafile Exchange Image File (.cmx) |
| PCL | Printer Command Language Document (.pcl) |
| PSD | Adobe Photoshop Document (.psd) represents Adobe Photoshop's native file format used for graphics designing and development.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/psd). |
| DCM | DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/dcm). |
| PS | PostScript File (.ps) |
| EPS | Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/eps). |
| ODG | OpenDocument Graphic File (.odg) is used by Apache OpenOffice's Draw application to store drawing elements as a vector image.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/image/odg). |
| SVG | Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/svg). |
| PDF | Portable Document Format File (.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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/view/pdf). |
| PPT | PowerPoint Presentation (.ppt) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppt). |
| PPTX | PowerPoint Open XML Presentation (.pptx) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptx). |
| PPS | PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pps). |
| PPSX | PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsx). |
| ODP | OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp). |
| POT | PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot). |
| PPTM | PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/pptm). |
| POTX | PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/potx). |
| POTM | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/potm). |
| PPSM | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/ppsm). |
| OTP | OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp). |
| XLS | Excel Spreadsheet (.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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xls). |
| XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsx). |
| XLSM | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm). |
| XLT | Excel binary Template (.xlt) represents Excel Template File Format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt). |
| XLTM | Excel Office OpenXML file Template (.xltm) represents Excel Template File Format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm). |
| XLSB | Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsb). |
| CSV | Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/csv). |
| TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv). |
| ODS | OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/ods). |
| OTS | OpenDocument Spreadsheet Template (.ots) |
| DOC | Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/doc). |
| DOCX | Microsoft Word Open XML Document (.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.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docx). |
| DOCM | Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/docm). |
| DOT | Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot). |
| DOTX | Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx). |
| DOTM | Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm). |
| RTF | Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf). |
| TXT | Plain Text File (.txt) represents a text document that contains plain text in the form of lines.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/txt). |
| ODT | OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt). |
| OTT | OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS' OpenDocument standard format.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/word-processing/ott). |
| VCF | vCard File (.vcf) is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/email/vcf). |
| WPD | WordPerfect Document (.wpd) |
| AZW3 | WordPerfect Document (.wpd) |
| PFX | Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application.
<br/>Learn more about this file format [here](https://fileinfo.com/extension/pfx). |
| ZIP | Document ZIP archive (.zip) is an archive file format that supports lossless data compression.
<br/>Can hold one or more files or directories.
<br/>Learn more about this file format [here](https://docs.fileformat.com/compression/zip/). |
| TAR | Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories.
<br/>Learn more about this file format [here](https://docs.fileformat.com/compression/tar/). |
| SEVEN_ZIP | High compressed archive (.7z) compressing files and folders with a high compression ratio.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/7z). |
| G_ZIP | GZip compressed archive (.gz) compressing files with a high compression ratio.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/compression/gz). |
| L_ZIP | LZip compressed archive (.lz) compressing files with a high compression ratio.
<br/>Learn more about this file format [here](https://wiki.fileformat.com/compression/lz). |

##### Methods
| Method | Description |
| :- | :- |
| from_extension | Maps file extension to file type. |
| get_supported_file_types | Retrieves supported file types |
| equals | Determines whether the current `FileType` is the same as specified `FileType` object. |

##### Remarks

**Learn more** |
|
 |
 |

### APNG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/apng.md

#### APNG property

Animated Portable Network Graphics (.png) is a raster image file format that uses lossless compression.
It was developed as an extension of PNG to support animation, serving as an alternative to the GIF format without copyright limitations.
Learn more about this file format [here](https://wiki.fileformat.com/image/apng).

### AZW3 property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/azw3.md

#### AZW3 property

WordPerfect Document (.wpd)

### BMP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/bmp.md

#### BMP property

Bitmap Image File (.bmp) is 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).

### CDR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/cdr.md

#### CDR property

CorelDraw Vector Graphic Drawing (.cdr) 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).

### CGM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/cgm.md

#### CGM property

Computer Graphics Metafile (.cgm) is a 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).

### CMX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/cmx.md

#### CMX property

CorelDRAW Metafile Exchange Image File (.cmx)

### CSV property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/csv.md

#### CSV property

Comma Separated Values File (.csv) represents 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).

### DCM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/dcm.md

#### DCM property

DICOM Image (.dcm) represents 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).

### DJVU property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/djvu.md

#### DJVU property

DjVu Image (.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).

### DOC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/doc.md

#### DOC property

Microsoft Word Document (.doc) represents 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).

### DOCM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/docm.md

#### DOCM property

Word Open XML Macro-Enabled Document (.docm) is a 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).

### DOCX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/docx.md

#### DOCX property

Microsoft Word Open XML Document (.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).

### DOT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/dot.md

#### DOT property

Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files.
Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dot).

### DOTM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/dotm.md

#### DOTM property

Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher.
Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotm).

### DOTX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/dotx.md

#### DOTX property

Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files.
Learn more about this file format [here](https://wiki.fileformat.com/word-processing/dotx).

### EMF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/emf.md

#### EMF property

Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files 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).

### EPS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/eps.md

#### EPS property

Encapsulated PostScript File (.eps) describes 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).

### equals method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/equals.md

#### equals

Determines whether the current `FileType` is the same as specified `FileType` object.

##### Returns

if both `FileType` objects are the same; otherwise,

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.signature.domain.FileType | The object to compare with the current `FileType` object. |

### extension property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/extension.md

#### extension property

Filename suffix (including the period ".") e.g. ".doc".
##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/file_format.md

#### file_format property

File type name e.g. "Microsoft Word Document".
##### Definition:
```python
@property
def file_format(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/from_extension.md

#### from_extension

Maps file extension to file type.

##### Returns

When file type is supported returns it, otherwise returns default `FileType.Unknown` file type.

```python
def from_extension(self, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | System.String | File extension (including the period "."). |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentException | Thrown when `extension` is null or empty string. |

### G_ZIP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/g_zip.md

#### G_ZIP property

GZip compressed archive (.gz) compressing files with a high compression ratio.
Learn more about this file format [here](https://wiki.fileformat.com/compression/gz).

### get_supported_file_types method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/get_supported_file_types.md

#### get_supported_file_types

Retrieves supported file types

##### Returns

Returns sequence of supported file types

```python
def get_supported_file_types(self):
    ...
```

### GIF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/gif.md

#### GIF property

Graphical Interchange Format File (.gif) 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).

### JPEG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/jpeg.md

#### JPEG property

JPEG Image (.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).

### JPG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/jpg.md

#### JPG property

JPEG Image (.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).

### L_ZIP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/l_zip.md

#### L_ZIP property

LZip compressed archive (.lz) compressing files with a high compression ratio.
Learn more about this file format [here](https://wiki.fileformat.com/compression/lz).

### ODG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/odg.md

#### ODG property

OpenDocument Graphic File (.odg) 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).

### ODP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/odp.md

#### ODP property

OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard.
Learn more about this file format [here](https://wiki.fileformat.com/presentation/odp).

### ODS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ods.md

#### ODS property

OpenDocument Spreadsheet (.ods) stands 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).

### ODT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/odt.md

#### ODT property

OpenDocument Text Document (.odt) 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).

### OTP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/otp.md

#### OTP property

OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format.
Learn more about this file format [here](https://wiki.fileformat.com/presentation/otp).

### OTS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ots.md

#### OTS property

OpenDocument Spreadsheet Template (.ots)

### OTT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ott.md

#### OTT property

OpenDocument Document Template (.ott) represents 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).

### PCL property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pcl.md

#### PCL property

Printer Command Language Document (.pcl)

### PDF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pdf.md

#### PDF property

Portable Document Format File (.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).

### PFX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pfx.md

#### PFX property

Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application.
Learn more about this file format [here](https://fileinfo.com/extension/pfx).

### PNG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/png.md

#### PNG property

Portable Network Graphic (.png) is a type of raster image file format that use lossless 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).

### POT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pot.md

#### POT property

PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
Learn more about this file format [here](https://wiki.fileformat.com/presentation/pot).

### POTM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/potm.md

#### POTM property

PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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).

### POTX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/potx.md

#### POTX property

PowerPoint Open XML Presentation Template (.potx) represents 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).

### PPS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pps.md

#### PPS property

PowerPoint Slide Show (.pps) 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).

### PPSM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ppsm.md

#### PPSM property

PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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).

### PPSX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ppsx.md

#### PPSX property

PowerPoint Open XML Slide Show (.ppsx) files 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).

### PPT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ppt.md

#### PPT property

PowerPoint Presentation (.ppt) 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).

### PPTM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pptm.md

#### PPTM property

PowerPoint Open XML Macro-Enabled Presentation 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).

### PPTX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/pptx.md

#### PPTX property

PowerPoint Open XML Presentation (.pptx) 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).

### PS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/ps.md

#### PS property

PostScript File (.ps)

### PSD property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/psd.md

#### PSD property

Adobe Photoshop Document (.psd) 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).

### RTF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/rtf.md

#### RTF property

Rich Text Format File (.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).

### SEVEN_ZIP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/seven_zip.md

#### SEVEN_ZIP property

High compressed archive (.7z) compressing files and folders with a high compression ratio.
Learn more about this file format [here](https://wiki.fileformat.com/page-description-language/7z).

### SVG property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/svg.md

#### SVG property

Scalable Vector Graphics File (.svg) 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).

### TAR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/tar.md

#### TAR property

Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories.
Learn more about this file format [here](https://docs.fileformat.com/compression/tar/).

### TGA property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/tga.md

#### TGA property

Truevision TGA (.tga), also known as TARGA, is a raster image file format developed by Truevision Inc.
It supports various color depths and optional RLE compression. TGA files are commonly used in video games,
animation pipelines, and graphics applications for high-quality image rendering with optional alpha channel support.
Learn more about this file format [here](https://wiki.fileformat.com/image/tga).

### TIF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/tif.md

#### TIF property

Tagged Image File (.tif) 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).

### TIFF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/tiff.md

#### TIFF property

Tagged Image File Format (.tiff) 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).

### TSV property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/tsv.md

#### TSV property

Tab Separated Values File (.tsv) represents data separated with tabs in plain text format.
Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv).

### TXT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/txt.md

#### TXT property

Plain Text File (.txt) 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).

### UNKNOWN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/unknown.md

#### UNKNOWN property

Represents unknown file type.

### VCF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/vcf.md

#### VCF property

vCard File (.vcf) 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).

### WEBP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/webp.md

#### WEBP property

WebP Image (.webp) 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).

### WMF property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/wmf.md

#### WMF property

Windows Metafile (.wmf) represents 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).

### WPD property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/wpd.md

#### WPD property

WordPerfect Document (.wpd)

### XLS property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xls.md

#### XLS property

Excel Spreadsheet (.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).

### XLSB property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xlsb.md

#### XLSB property

Excel Binary Spreadsheet (.xlsb) 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).

### XLSM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xlsm.md

#### XLSM property

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros.
Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm).

### XLSX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xlsx.md

#### XLSX property

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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).

### XLT property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xlt.md

#### XLT property

Excel binary Template (.xlt) represents Excel Template File Format.
Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlt).

### XLTM property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/xltm.md

#### XLTM property

Excel Office OpenXML file Template (.xltm) represents Excel Template File Format.
Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xltm).

### ZIP property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/filetype/zip.md

#### ZIP property

Document ZIP archive (.zip) is an archive file format that supports lossless data compression.
Can hold one or more files or directories.
Learn more about this file format [here](https://docs.fileformat.com/compression/zip/).

### FormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature.md

#### FormFieldSignature class

Contains Form field signature properties.

**Inheritance:** `FormFieldSignature` →
`BaseSignature`

The FormFieldSignature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/name.md

#### name property

Specifies unique form field name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/type.md

#### type property

Specifies Form field type.
##### Definition:
```python
@property
def type(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/value.md

#### value property

Specifies Form field data object.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldsignature/width.md

#### width property

Specifies width of signature.

### FormFieldType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formfieldtype.md

#### FormFieldType enumeration

Specifies Form Field type.

The FormFieldType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TEXT | Simple text input. |
| CHECKBOX | Check-box. |
| COMBOBOX | Combo-box |
| DIGITAL_SIGNATURE | Digital signature area. |
| RADIO | Radio-button |

### FormTextFieldType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/formtextfieldtype.md

#### FormTextFieldType enumeration

Defines types of text for WordsProcessing document form fields.

The FormTextFieldType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALL_TEXT_TYPES | Form field with any type. |
| PLAIN_TEXT | Form field with plain text type. |
| RICH_TEXT | Form field with rich text type. |

### HashAlgorithm enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/hashalgorithm.md

#### HashAlgorithm enumeration

Specifies the hash algorithm used for cryptographic signing.

The HashAlgorithm type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO | Automatically selects the hash algorithm based on context. |
| SHA1 | The SHA-1 hash algorithm, producing a 160-bit hash value. |
| SHA256 | The SHA-256 hash algorithm, producing a 256-bit hash value. |
| SHA384 | The SHA-384 hash algorithm, producing a 384-bit hash value. |
| SHA512 | The SHA-512 hash algorithm, producing a 512-bit hash value. |

### HorizontalAlignment enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/horizontalalignment.md

#### HorizontalAlignment enumeration

Specifies horizontal alignment of element on a document page.

The HorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | The object is explicitly positioned, usually using its Left property. |
| LEFT | Specifies that the object shall be left aligned to the horizontal alignment base. |
| CENTER | Specifies that the object shall be centered with respect to the horizontal alignment base. |
| RIGHT | Specifies that the object shall be right aligned to the horizontal alignment base. |

### IAlignment class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/ialignment.md

#### IAlignment class

Describes signature area alignment on a document page.

The IAlignment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| horizontal_alignment | Horizontal alignment of Image on a document page. |
| vertical_alignment | Vertical alignment of Image on a document page. |
| margin | Gets the space that is specified by default between Image and Document edges
<br/>(works if horizontal or vertical alignment is specified). |
| margin_measure_type | Margin measurement type (pixels, percents or millimeters). |

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/ialignment/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of Image on a document page.
##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
@horizontal_alignment.setter
def horizontal_alignment(self, value):
    ...
```

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/ialignment/margin.md

#### margin property

Gets the space that is specified by default between Image and Document edges
(works if horizontal or vertical alignment is specified).
##### Definition:
```python
@property
def margin(self):
    ...
@margin.setter
def margin(self, value):
    ...
```

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/ialignment/margin_measure_type.md

#### margin_measure_type property

Margin measurement type (pixels, percents or millimeters).
##### Definition:
```python
@property
def margin_measure_type(self):
    ...
@margin_measure_type.setter
def margin_measure_type(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/ialignment/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of Image on a document page.
##### Definition:
```python
@property
def vertical_alignment(self):
    ...
@vertical_alignment.setter
def vertical_alignment(self, value):
    ...
```

### IDocumentInfo class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo.md

#### IDocumentInfo class

Defines document description properties.

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_count | Document pages count. |
| pages | Collection of document pages descriptions. |
| width_for_max_height | Specifies width for max page height. |
| max_page_height | Specifies max page height. |
| file_type | File format type |
| size | Document size in bytes. |
| text_signatures | Collection of document text signatures added or updated by `Signature` methods. |
| image_signatures | Collection of document image signatures added or updated by `Signature` methods. |
| digital_signatures | Collection of document digital signatures added or updated by `Signature` methods. |
| barcode_signatures | Collection of document barcode signatures added or updated by `Signature` methods. |
| qr_code_signatures | Collection of document QR-code signatures added or updated by `Signature` methods. |
| form_field_signatures | Collection of document Form Field signatures added or updated by `Signature` methods. |
| form_fields | Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types. |
| metadata_signatures | Collection of document Metadata signatures. |
| documents | Collection of all existing documents within the archive files. This property is supported only for Archive document types. |
| process_logs | Collection of document history process logs. |
| signatures | Collection of document all types signatures `BaseSignature`. |

### barcode_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/barcode_signatures.md

#### barcode_signatures property

Collection of document barcode signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def barcode_signatures(self):
    ...
```

### digital_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/digital_signatures.md

#### digital_signatures property

Collection of document digital signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def digital_signatures(self):
    ...
```

### documents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/documents.md

#### documents property

Collection of all existing documents within the archive files. This property is supported only for Archive document types.
##### Definition:
```python
@property
def documents(self):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/file_type.md

#### file_type property

File format type
##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### form_field_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/form_field_signatures.md

#### form_field_signatures property

Collection of document Form Field signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def form_field_signatures(self):
    ...
```

### form_fields property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/form_fields.md

#### form_fields property

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.
##### Definition:
```python
@property
def form_fields(self):
    ...
```

### image_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/image_signatures.md

#### image_signatures property

Collection of document image signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def image_signatures(self):
    ...
```

### max_page_height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/max_page_height.md

#### max_page_height property

Specifies max page height.
##### Definition:
```python
@property
def max_page_height(self):
    ...
@max_page_height.setter
def max_page_height(self, value):
    ...
```

### metadata_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/metadata_signatures.md

#### metadata_signatures property

Collection of document Metadata signatures.
##### Definition:
```python
@property
def metadata_signatures(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/page_count.md

#### page_count property

Document pages count.
##### Definition:
```python
@property
def page_count(self):
    ...
@page_count.setter
def page_count(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/pages.md

#### pages property

Collection of document pages descriptions.
##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### process_logs property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/process_logs.md

#### process_logs property

Collection of document history process logs.
##### Definition:
```python
@property
def process_logs(self):
    ...
```

### qr_code_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/qr_code_signatures.md

#### qr_code_signatures property

Collection of document QR-code signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def qr_code_signatures(self):
    ...
```

### signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/signatures.md

#### signatures property

Collection of document all types signatures `BaseSignature`.
##### Definition:
```python
@property
def signatures(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/size.md

#### size property

Document size in bytes.
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### text_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/text_signatures.md

#### text_signatures property

Collection of document text signatures added or updated by `Signature` methods.
##### Definition:
```python
@property
def text_signatures(self):
    ...
```

### width_for_max_height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/idocumentinfo/width_for_max_height.md

#### width_for_max_height property

Specifies width for max page height.
##### Definition:
```python
@property
def width_for_max_height(self):
    ...
@width_for_max_height.setter
def width_for_max_height(self, value):
    ...
```

### ImageMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature.md

#### ImageMetadataSignature class

Contains Image Metadata signature properties.

**Inheritance:** `ImageMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The ImageMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Image Metadata Signature with Id and value |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| id | The identifier of Image Metadata signature.
<br/>See ImageMetadataSignatures class that contains standard Signature with predefined Id value. |
| size | Read-only value to get size of Metadata value |
| description | Read-only value to get description for standard Image Metadata signature |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Image Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |
| to_long | Converts to long. |

### ImageMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/__init__.md

#### __init__

Creates Image Metadata Signature with Id and value

```python
def __init__(self, id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | System.Object | Metadata value |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Image Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### description property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/description.md

#### description property

Read-only value to get description for standard Image Metadata signature
##### Definition:
```python
@property
def description(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/height.md

#### height property

Specifies height of signature.

### id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/id.md

#### id property

The identifier of Image Metadata signature.
See ImageMetadataSignatures class that contains standard Signature with predefined Id value.
##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/size.md

#### size property

Read-only value to get size of Metadata value
##### Definition:
```python
@property
def size(self):
    ...
```

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Image Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Image Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_long method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_long.md

#### to_long

Converts to long.

##### Returns

Returns the Metadata Signature value as long.

```python
def to_long(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Image Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagemetadatasignature/width.md

#### width property

Specifies width of signature.

### ImageSaveFileFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesavefileformat.md

#### ImageSaveFileFormat enumeration

Defines different save file formats.

The ImageSaveFileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | File Format will not be changed. |
| BMP | Saves the document in the Bmp format. |
| GIF | Saves the document in the Gif format. |
| JPG | Saves the document in the Jpg format. |
| PNG | Saves the document in the Png format. |
| PSD | Saves the document in the Psd format. |
| SVG | Saves the document in the Svg format. |
| TIFF | Saves the document in the Tiff format. |
| WEBP | Saves the document in the Webp format. |
| PDF | Saves the document to the Pdf format. |

### ImageSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature.md

#### ImageSignature class

Contains Image signature properties.

**Inheritance:** `ImageSignature` →
`BaseSignature`

The ImageSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize ImageSignature object with signature identifier that was obtained after search process.
<br/>This unique identifier is used to find additional properties for this signature from document signature information layer. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| size | Specifies the size in bytes of signature image. |
| format | Specifies the format of signature image. |
| content | Specifies image binary data content of type `ImageSignature.format`.
<br/>By default this property will not be set.
<br/>Use property `ImageSearchOptions.return_content` to enable this feature. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Barcode Signature instance. |

### ImageSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/__init__.md

#### __init__

Initialize ImageSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

```python
def __init__(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String | Unique signature identifier obtained by Sign or Search method of Signature class `Signature`. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/clone.md

#### clone

Clone Barcode Signature instance.

##### Returns

Returns cloned Barcode Signature instance.

```python
def clone(self):
    ...
```

### content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/content.md

#### content property

Specifies image binary data content of type `ImageSignature.format`.
By default this property will not be set.
Use property `ImageSearchOptions.return_content` to enable this feature.
##### Definition:
```python
@property
def content(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/format.md

#### format property

Specifies the format of signature image.
##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/size.md

#### size property

Specifies the size in bytes of signature image.
##### Definition:
```python
@property
def size(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/top.md

#### top property

Specifies top position of signature.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/imagesignature/width.md

#### width property

Specifies width of signature.

### IRectangle class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle.md

#### IRectangle class

Defines interface properties for signature area on a document page.

The IRectangle type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| left | Left X position of Signature area on Document Page in Measure units
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType). |
| top | Top Y Position of Signature area on Document Page in Measure units
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType). |
| width | Width of Signature area on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| height | Height of Signature area on Document Page in Measure units
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/height.md

#### height property

Height of Signature area on Document Page in Measure units
(pixels, percents or millimeters see `MeasureType` SizeMeasureType).
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/left.md

#### left property

Left X position of Signature area on Document Page in Measure units
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.
##### Definition:
```python
@property
def location_measure_type(self):
    ...
@location_measure_type.setter
def location_measure_type(self, value):
    ...
```

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.
##### Definition:
```python
@property
def size_measure_type(self):
    ...
@size_measure_type.setter
def size_measure_type(self, value):
    ...
```

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/stretch.md

#### stretch property

Stretch mode on Document Page.
##### Definition:
```python
@property
def stretch(self):
    ...
@stretch.setter
def stretch(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/top.md

#### top property

Top Y Position of Signature area on Document Page in Measure units
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irectangle/width.md

#### width property

Width of Signature area on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType).
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### IResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult.md

#### IResult class

Common interface for signature process result.

The IResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the process in milliseconds |
| total_signatures | Returns the total processed signatures |
| source_document_size | Returns source document size |
| destin_document_size | Returns destination document size |
| succeeded | List of successfully processed signatures `BaseSignature`. |
| failed | List of signatures that were not processed `BaseSignature`. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/destin_document_size.md

#### destin_document_size property

Returns destination document size
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/failed.md

#### failed property

List of signatures that were not processed `BaseSignature`.
##### Definition:
```python
@property
def failed(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/source_document_size.md

#### source_document_size property

Returns source document size
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/succeeded.md

#### succeeded property

List of successfully processed signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/iresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### IRotation class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irotation.md

#### IRotation class

Defines properties for signature rotation.

The IRotation type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| rotation_angle | Rotation angle clockwise. |

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/irotation/rotation_angle.md

#### rotation_angle property

Rotation angle clockwise.
##### Definition:
```python
@property
def rotation_angle(self):
    ...
@rotation_angle.setter
def rotation_angle(self, value):
    ...
```

### ITextAlignment class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/itextalignment.md

#### ITextAlignment class

Defines alignment properties for text on text signatures.

The ITextAlignment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text_horizontal_alignment | Horizontal alignment of text inside a signature. |
| text_vertical_alignment | Vertical alignment of text inside a signature. |

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/itextalignment/text_horizontal_alignment.md

#### text_horizontal_alignment property

Horizontal alignment of text inside a signature.
##### Definition:
```python
@property
def text_horizontal_alignment(self):
    ...
@text_horizontal_alignment.setter
def text_horizontal_alignment(self, value):
    ...
```

### text_vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/itextalignment/text_vertical_alignment.md

#### text_vertical_alignment property

Vertical alignment of text inside a signature.
##### Definition:
```python
@property
def text_vertical_alignment(self):
    ...
@text_vertical_alignment.setter
def text_vertical_alignment(self, value):
    ...
```

### ITransparency class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/itransparency.md

#### ITransparency class

Define Transparency property for different objects appearances

The ITransparency type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| transparency | Gets or sets a value to indicate the object Transparency. The value is from 0.0 to 1.0.
<br/>By default the value is 0 |

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/itransparency/transparency.md

#### transparency property

Gets or sets a value to indicate the object Transparency. The value is from 0.0 to 1.0.
By default the value is 0
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### MeasureType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/measuretype.md

#### MeasureType enumeration

Specifies measure units of signature on a document page.

The MeasureType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PIXELS | Pixels. |
| PERCENTS | Percents of page size. |
| MILLIMETERS | Millimeters. |

### MetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature.md

#### MetadataSignature class

Contains Metadata signature properties.

**Inheritance:** `MetadataSignature` →
`BaseSignature`

The MetadataSignature type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance with given value.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/name.md

#### name property

Specifies unique metadata name.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/type.md

#### type property

Specifies metadata value type.
##### Definition:
```python
@property
def type(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/value.md

#### value property

Specifies metadata object.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignature/width.md

#### width property

Specifies width of signature.

### MetadataSignatureCollection class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection.md

#### MetadataSignatureCollection class

Collection of Metadata signature objects.

The MetadataSignatureCollection type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Collection of Metadata signature. |

##### Properties
| Property | Description |
| :- | :- |
| count | Gets number of items in the collection. |

Returns a MetadataSignature object by index.
##### Indexer
| Name | Description |
| :- | :- |
| [index] | Zero-based index of the MetadataSignature to retrieve. |

##### Methods
| Method | Description |
| :- | :- |
| clear | Removes all items from the collection. |
| contains | Returns true if a Metadata with the specified name exists in the collection. |
| index_of | Gets the index of a property by name. |
| remove | Removes a Metadata Signature with the specified name from the collection. |
| remove_at | Removes a Metadata Signature at the specified index. |
| add | Add Metadata Signature object to collection. |
| add_range |  |
| clone | Clone Metadata Signature Collection class with Metadata Signature Items. |

### MetadataSignatureCollection indexer
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/__getitem__.md

#### MetadataSignatureCollection indexer

Returns a MetadataSignature object by index.
##### Indexer
| Name | Description |
| :- | :- |
| index | Zero-based index of the MetadataSignature to retrieve. |

##### Returns

Returns a MetadataSignature `MetadataSignature` object by the index of collection.

##### Remarks

Returns null if a property with the specified index does not exist.

### MetadataSignatureCollection constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/__init__.md

#### __init__

Creates Collection of Metadata signature.

```python
def __init__(self):
    ...
```

### add method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/add.md

#### add

Add Metadata Signature object to collection.

```python
def add(self, signature):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature | groupdocs.signature.domain.MetadataSignature | Metadata signature to be added to collection. |

### add_range method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/add_range.md

#### add_range

```python
def add_range(self, signatures):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signatures | list |  |

### clear method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/clear.md

#### clear

Removes all items from the collection.

```python
def clear(self):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/clone.md

#### clone

Clone Metadata Signature Collection class with Metadata Signature Items.

##### Returns

Returns copied instance with cloned Signature Items

```python
def clone(self):
    ...
```

### contains method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/contains.md

#### contains

Returns true if a Metadata with the specified name exists in the collection.

##### Returns

True if the Metadata exists in the collection; false otherwise.

```python
def contains(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The case-insensitive name of the property. |

### count property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/count.md

#### count property

Gets number of items in the collection.
##### Definition:
```python
@property
def count(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/index_of.md

#### index_of

Gets the index of a property by name.

##### Returns

The zero based index. Negative value if not found.

```python
def index_of(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The case-insensitive name of the MetadataSignature. |

### remove method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/remove.md

#### remove

Removes a Metadata Signature with the specified name from the collection.

##### Returns

```python
def remove(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | The case-insensitive name of the Metadata Signature. |

### remove_at method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatasignaturecollection/remove_at.md

#### remove_at

Removes a Metadata Signature at the specified index.

```python
def remove_at(self, index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | int | The zero based index. |

### MetadataType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/metadatatype.md

#### MetadataType enumeration

Specifies the supported Metadata signature data type of the value.

The MetadataType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Value type is undefined. |
| BOOLEAN | Value is Boolean type. |
| INTEGER | Value is integer type. |
| DOUBLE | Value is Double type. |
| DATE_TIME | Value is DateTime type. |
| STRING | Value is string type. |

### Padding class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding.md

#### Padding class

Represents padding or margin information associated with element.

The Padding type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of Padding class using zero values. |
| __init__ | Initializes a new instance of the Padding class using the supplied padding size for all edges. |
| __init__ | Initializes a new instance of the Padding class using the supplied padding sizes. |

##### Properties
| Property | Description |
| :- | :- |
| all | Gets or sets the padding value for all the edges.
<br/>Changing of any partial edge like left or top makes this property equal 0; |
| left | Gets or sets the padding value for the left edge. |
| right | Gets or sets the padding value for the right edge. |
| top | Gets or sets the padding value for the top edge. |
| bottom | Gets or sets the padding value for the bottom edge. |
| horizontal | Gets the combined padding for the right and left edges. |
| vertical | Gets the combined padding for the top and bottom edges. |
| EMPTY | Provides a Padding object with no padding. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Gets a copy of this object. |

### Padding constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/__init__.md

#### __init__

Initializes a new instance of Padding class using zero values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the Padding class using the supplied padding size for all edges.

```python
def __init__(self, all):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| all | int | The number of measure units to be used for padding for all edges. |

#### __init__

Initializes a new instance of the Padding class using the supplied padding sizes.

```python
def __init__(self, left, right, top, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | int | The left padding size. |
| right | int | The right padding size. |
| top | int | The top padding size. |
| bottom | int | The bottom padding size. |

### all property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/all.md

#### all property

Gets or sets the padding value for all the edges.
Changing of any partial edge like left or top makes this property equal 0;
##### Definition:
```python
@property
def all(self):
    ...
@all.setter
def all(self, value):
    ...
```

### bottom property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/bottom.md

#### bottom property

Gets or sets the padding value for the bottom edge.
##### Definition:
```python
@property
def bottom(self):
    ...
@bottom.setter
def bottom(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/clone.md

#### clone

Gets a copy of this object.

```python
def clone(self):
    ...
```

### EMPTY property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/empty.md

#### EMPTY property

Provides a Padding object with no padding.

### horizontal property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/horizontal.md

#### horizontal property

Gets the combined padding for the right and left edges.
##### Definition:
```python
@property
def horizontal(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/left.md

#### left property

Gets or sets the padding value for the left edge.
##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### right property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/right.md

#### right property

Gets or sets the padding value for the right edge.
##### Definition:
```python
@property
def right(self):
    ...
@right.setter
def right(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/top.md

#### top property

Gets or sets the padding value for the top edge.
##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### vertical property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/padding/vertical.md

#### vertical property

Gets the combined padding for the top and bottom edges.
##### Definition:
```python
@property
def vertical(self):
    ...
```

### PageInfo class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pageinfo.md

#### PageInfo class

Document page description class

The PageInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of PageInfo |

##### Properties
| Property | Description |
| :- | :- |
| width | Specifies page width |
| height | Specifies page height |
| page_number | Specifies page number |

### PageInfo constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pageinfo/__init__.md

#### __init__

Constructs a new instance of PageInfo

```python
def __init__(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pageinfo/height.md

#### height property

Specifies page height
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pageinfo/page_number.md

#### page_number property

Specifies page number
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pageinfo/width.md

#### width property

Specifies page width
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PdfDigitalSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature.md

#### PdfDigitalSignature class

Contains Pdf Digital signature properties.

**Inheritance:** `PdfDigitalSignature` →
`DigitalSignature` →
`BaseSignature`

The PdfDigitalSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize Pdf Digital Signature with no certificate. |
| __init__ | Create Pdf Digital signature with specified certificate. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| certificate | Gets or sets the X509 certificate. |
| comments | Gets or sets the signing purpose comment. |
| is_valid | Keeps true if this digital signature is valid and the document has not been tampered with. |
| sign_time | Gets or sets the time the document was signed. |
| certificate_custom_store_name | Specifies the custom store name of the certificate. |
| x_ad_es_type | XAdES type `DigitalSignature.x_ad_es_type`. Default value is None (XAdES is off).
<br/>At this moment XAdES signature type is supported only for Spreadsheet documents. |
| thumbprint | Gets the thumbprint of a certificate. |
| contact_info | Information provided by the signer to enable a recipient to contact the signer
<br/>to verify the signature, e.g. a phone number. |
| location | The CPU host name or physical location of the signing. |
| reason | The reason for the signing, such as (I agree…). |
| type | Type of Pdf digital signature. |
| time_stamp | Time stamp for Pdf digital signature.
<br/>Default value is null. |
| show_properties | Force to show/hide signature properties. In case ShowProperties is true signature
<br/>field has predefined format of appearance
<br/>Digitally signed by {`PdfDigitalSignature.contact_info`} Date: {Date} Reason: {`PdfDigitalSignature.reason`}
<br/>Location: {`PdfDigitalSignature.location`}
<br/>ShowProperties is true by default. |

##### Methods
| Method | Description |
| :- | :- |
| load_digital_signatures | Load Digital signatures from all system X509 Certificates Stores. |
| load_digital_signatures | Load Digital signatures from a certificate storage. |
| clone | Clone Barcode Signature instance. |

### PdfDigitalSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/__init__.md

#### __init__

Initialize Pdf Digital Signature with no certificate.

```python
def __init__(self):
    ...
```

#### __init__

Create Pdf Digital signature with specified certificate.

```python
def __init__(self, certificate):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate | System.Security.Cryptography.X509Certificates.X509Certificate2 | X509 certificate. |

### certificate property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/certificate.md

#### certificate property

Gets or sets the X509 certificate.

### certificate_custom_store_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/certificate_custom_store_name.md

#### certificate_custom_store_name property

Specifies the custom store name of the certificate.

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/clone.md

#### clone

Clone Barcode Signature instance.

##### Returns

Returns cloned Barcode Signature instance.

```python
def clone(self):
    ...
```

### comments property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/comments.md

#### comments property

Gets or sets the signing purpose comment.

### contact_info property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/contact_info.md

#### contact_info property

Information provided by the signer to enable a recipient to contact the signer
to verify the signature, e.g. a phone number.
##### Definition:
```python
@property
def contact_info(self):
    ...
@contact_info.setter
def contact_info(self, value):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/is_valid.md

#### is_valid property

Keeps true if this digital signature is valid and the document has not been tampered with.

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/left.md

#### left property

Specifies left position of signature.

### load_digital_signatures method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/load_digital_signatures.md

#### load_digital_signatures

Load Digital signatures from all system X509 Certificates Stores.

##### Returns

Returns list of `DigitalSignature` Digital Signatures.

```python
def load_digital_signatures(self):
    ...
```

#### load_digital_signatures

Load Digital signatures from a certificate storage.

##### Returns

Returns list of `DigitalSignature` Digital Signatures.

```python
def load_digital_signatures(self, store_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| store_name | System.String | Custom name of a digital storage containing certificates. |

### location property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/location.md

#### location property

The CPU host name or physical location of the signing.
##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### reason property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/reason.md

#### reason property

The reason for the signing, such as (I agree…).
##### Definition:
```python
@property
def reason(self):
    ...
@reason.setter
def reason(self, value):
    ...
```

### show_properties property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/show_properties.md

#### show_properties property

Force to show/hide signature properties. In case ShowProperties is true signature
field has predefined format of appearance
Digitally signed by {`PdfDigitalSignature.contact_info`} Date: {Date} Reason: {`PdfDigitalSignature.reason`}
Location: {`PdfDigitalSignature.location`}
ShowProperties is true by default.
##### Definition:
```python
@property
def show_properties(self):
    ...
@show_properties.setter
def show_properties(self, value):
    ...
```

### sign_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/sign_time.md

#### sign_time property

Gets or sets the time the document was signed.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### thumbprint property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/thumbprint.md

#### thumbprint property

Gets the thumbprint of a certificate.

### time_stamp property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/time_stamp.md

#### time_stamp property

Time stamp for Pdf digital signature.
Default value is null.
##### Definition:
```python
@property
def time_stamp(self):
    ...
@time_stamp.setter
def time_stamp(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/type.md

#### type property

Type of Pdf digital signature.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/width.md

#### width property

Specifies width of signature.

### x_ad_es_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignature/x_ad_es_type.md

#### x_ad_es_type property

XAdES type `DigitalSignature.x_ad_es_type`. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.

### PdfDigitalSignatureType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfdigitalsignaturetype.md

#### PdfDigitalSignatureType enumeration

Describes enumeration of PDF digital signature type.

The PdfDigitalSignatureType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SIGNATURE | Digital signature. |
| CERTIFICATE | Digital certificate. Each document could be certified only once. |

### PdfMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature.md

#### PdfMetadataSignature class

Contains Pdf Metadata signature properties.

**Inheritance:** `PdfMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The PdfMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Pdf Metadata signature with predefined name and empty value |
| __init__ | Creates Pdf Metadata signature with predefined values |
| __init__ | Creates Pdf Metadata signature with predefined values |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |
| tag_prefix | The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp".
<br/>Possible values are |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Pdf Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### PdfMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/__init__.md

#### __init__

Creates Pdf Metadata signature with predefined name and empty value

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Pdf Metadata Signature name |

#### __init__

Creates Pdf Metadata signature with predefined values

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object |
| value | System.Object | Value of Metadata signature |

#### __init__

Creates Pdf Metadata signature with predefined values

```python
def __init__(self, name, value, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object |
| value | System.Object | Value of Metadata signature |
| tag | System.String | Prefix tag of Metadata signature |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Pdf Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### tag_prefix property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/tag_prefix.md

#### tag_prefix property

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp".
Possible values are
##### Definition:
```python
@property
def tag_prefix(self):
    ...
@tag_prefix.setter
def tag_prefix(self, value):
    ...
```

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignature/width.md

#### width property

Specifies width of signature.

### PdfMetadataSignatures class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures.md

#### PdfMetadataSignatures class

Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options.

The PdfMetadataSignatures type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| author | Pdf Document Author metadata. |
| create_date | Pdf Document creation date metadata signature. |
| metadata_date | Pdf Document metadata date information. |
| creator_tool | Pdf Document creation tool metadata signature. |
| modify_date | Pdf Document modified date metadata property. |
| producer | Pdf Document Producer metadata property. |
| entry | Pdf Document Entry metadata property. |
| keywords | Pdf Document creator metadata property |
| title | Pdf Document Title metadata property |
| subject | Pdf Document Subject metadata property. |
| description | Pdf Document Description metadata property. |
| creator | Pdf Document creator metadata property. |

### author property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/author.md

#### author property

Pdf Document Author metadata.

### create_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/create_date.md

#### create_date property

Pdf Document creation date metadata signature.

### creator property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/creator.md

#### creator property

Pdf Document creator metadata property.

### creator_tool property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/creator_tool.md

#### creator_tool property

Pdf Document creation tool metadata signature.

### description property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/description.md

#### description property

Pdf Document Description metadata property.

### entry property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/entry.md

#### entry property

Pdf Document Entry metadata property.

### keywords property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/keywords.md

#### keywords property

Pdf Document creator metadata property

### metadata_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/metadata_date.md

#### metadata_date property

Pdf Document metadata date information.

### modify_date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/modify_date.md

#### modify_date property

Pdf Document modified date metadata property.

### producer property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/producer.md

#### producer property

Pdf Document Producer metadata property.

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/subject.md

#### subject property

Pdf Document Subject metadata property.

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfmetadatasignatures/title.md

#### title property

Pdf Document Title metadata property

### PdfSaveFileFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdfsavefileformat.md

#### PdfSaveFileFormat enumeration

Defines different save file formats.

The PdfSaveFileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | File Format will not be changed. |
| PDF | Saves the document as Pdf (Adobe Portable Document) Format. |
| DOC | Saves the document in the Microsoft Word 97-2007 Document Format. |
| XPS | Saves the document in the XPS (XML Paper Specification) Format. |
| DOC_X | Saves the document in Microsoft Word Open XML File format. |
| SVG | Saves the document in the SVG (Scalable Vector Graphics) format. |
| EPUB | Saves the document in the IDPF EPUB format. |
| PPTX | Saves the document in the PowerPoint Open XML Presentation File format |

### PdfTextAnnotationBorderEffect enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdftextannotationbordereffect.md

#### PdfTextAnnotationBorderEffect enumeration

Describes effect which should be applied to the border of the PDF text annotations.

The PdfTextAnnotationBorderEffect type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No effect. |
| CLOUDY | The border will appear "cloudy". |

### PdfTextStickerIcon enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdftextstickericon.md

#### PdfTextStickerIcon enumeration

Describes enumeration of PDF Text annotation sticker icon appearance.

The PdfTextStickerIcon type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NOTE | Note icon. |
| COMMENT | Comment icon. |
| KEY | Key icon. |
| HELP | Help icon. |
| NEW_PARAGRAPH | New Paragraph icon |
| PARAGRAPH | Paragraph icon |
| INSERT | Insert icon |
| CHECK | Check icon |
| CROSS | Cross icon |
| CIRCLE | Circle icon |
| STAR | Star icon |

### PdfTextStickerState enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/pdftextstickerstate.md

#### PdfTextStickerState enumeration

Describes enumeration of PDF text annotation sticker states.

The PdfTextStickerState type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNDEFINED | Undefined state. |
| MARKED | Marked state. |
| UNMARKED | Unmarked state. |
| ACCEPTED | Accepted state. |
| REJECTED | Rejected state. |
| CANCELLED | Canceled state. |
| COMPLETED | Completed state. |
| NONE | No state. |

### PresentationMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature.md

#### PresentationMetadataSignature class

Contains Presentation metadata signature properties.

**Inheritance:** `PresentationMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The PresentationMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Presentation Metadata Signature with predefined name and empty value |
| __init__ | Creates Presentation Metadata Signature with predefined values |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Slides Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### PresentationMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/__init__.md

#### __init__

Creates Presentation Metadata Signature with predefined name and empty value

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Presentation Metadata Signature name |

#### __init__

Creates Presentation Metadata Signature with predefined values

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object |
| value | System.Object | Value of Metadata signature |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Slides Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationmetadatasignature/width.md

#### width property

Specifies width of signature.

### PresentationSaveFileFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/presentationsavefileformat.md

#### PresentationSaveFileFormat enumeration

Defines different save file formats.

The PresentationSaveFileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | File Format will not be changed. |
| PPS | Saves the document as Microsoft Power Point 97-2003 slide show. |
| PPT | Saves the document as Microsoft Power Point 97-2003 presentation. |
| PDF | Saves the document in PDF format. |
| XPS | Saves the document in the XPS (XML Paper Specification) format. |
| PPTX | Saves the document in the Microsoft Power Point Open XML Presentation format. |
| PPSX | Saves the document in the Microsoft Power Point Open XML Slide Show format. |
| TIFF | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| ODP | Saves the document as Open Office presentation. |
| PPTM | Saves the document as Microsoft Power Point Open XML macro-enabled presentation. |
| PPSM | Saves the document as Microsoft Power Point Open XML macro-enabled slide show. |
| POTX | Saves the document as Microsoft Power Point template. |
| POTM | Saves the document as Microsoft Power Point macro-enabled template. |
| HTML | Saves the document in the HTML Format. |
| OTP | Saves the document as Open Office presentation template. |

### ProcessLog class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog.md

#### ProcessLog class

Represents document process details.

The ProcessLog type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| date | Get the process date and time. |
| type | Get the process type. |
| message | Get the process description. |
| succeeded | Quantity of successfully processed signatures. |
| failed | Quantity of signatures that failed during processing. |
| signatures | The list of successfully processed signatures. |

### date property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/date.md

#### date property

Get the process date and time.
##### Definition:
```python
@property
def date(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/failed.md

#### failed property

Quantity of signatures that failed during processing.
##### Definition:
```python
@property
def failed(self):
    ...
```

### message property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/message.md

#### message property

Get the process description.
##### Definition:
```python
@property
def message(self):
    ...
```

### signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/signatures.md

#### signatures property

The list of successfully processed signatures.
##### Definition:
```python
@property
def signatures(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/succeeded.md

#### succeeded property

Quantity of successfully processed signatures.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processlog/type.md

#### type property

Get the process type.
##### Definition:
```python
@property
def type(self):
    ...
```

### ProcessStatus enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processstatus.md

#### ProcessStatus enumeration

Specifies status of signing and verification processes.

The ProcessStatus type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| STARTED | Process was started. |
| IN_PROGRESS | Process is in progress. |
| COMPLETED | Process is completed. |

### ProcessType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/processtype.md

#### ProcessType enumeration

Defines supported process with documents like Info, Preview, Sign, Verify, Search, Update, Delete

The ProcessType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Indicates an error, unknown process type. |
| INFO | Obtain document information process. |
| PREVIEW | Indicates method GeneratePreview(). |
| SIGN | Signing process type. |
| VERIFY | Document verification process. |
| SEARCH | Signatures searching process. |
| UPDATE | Update document signatures process. |
| DELETE | Delete document signatures process |

### QrCodeSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature.md

#### QrCodeSignature class

Contains QR-code signature properties.

**Inheritance:** `QrCodeSignature` →
`BaseSignature`

The QrCodeSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize QrCodeSignature object with signature identifier that was obtained after search process.
<br/>This unique identifier is used to find additional properties for this signature from document signature information layer. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| encode_type | Specifies the QR-code Encode Type. |
| text | Specifies text of QR-code. |
| format | Specifies the format of QR-code signature image. |
| content | Specifies QR-code binary data image content of type `QrCodeSignature.format`.
<br/>By default this property will not be set.
<br/>Use property `QrCodeSearchOptions.return_content` to enable this feature. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone QR-Code Signature instance. |

### QrCodeSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/__init__.md

#### __init__

Initialize QrCodeSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

```python
def __init__(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String | Unique signature identifier obtained by sign or search method. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/clone.md

#### clone

Clone QR-Code Signature instance.

##### Returns

Returns cloned QR-code Signature instance.

```python
def clone(self):
    ...
```

### content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/content.md

#### content property

Specifies QR-code binary data image content of type `QrCodeSignature.format`.
By default this property will not be set.
Use property `QrCodeSearchOptions.return_content` to enable this feature.
##### Definition:
```python
@property
def content(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/encode_type.md

#### encode_type property

Specifies the QR-code Encode Type.
##### Definition:
```python
@property
def encode_type(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/format.md

#### format property

Specifies the format of QR-code signature image.
##### Definition:
```python
@property
def format(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/text.md

#### text property

Specifies text of QR-code.
##### Definition:
```python
@property
def text(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/top.md

#### top property

Specifies top position of signature.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodesignature/width.md

#### width property

Specifies width of signature.

### QrCodeType class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetype.md

#### QrCodeType class

Specify QRCode type properties.

The QrCodeType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type_index | Gets index of object in collection of supported QRCode types. |
| type_name | Gets name of QRCode Type. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified QRCode is equal to the current object. |

### equals method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetype/equals.md

#### equals

Determines whether the specified QRCode is equal to the current object.

##### Returns

Result of comparison.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.signature.domain.QrCodeType | Object for comparison. |

### type_index property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetype/type_index.md

#### type_index property

Gets index of object in collection of supported QRCode types.
##### Definition:
```python
@property
def type_index(self):
    ...
```

### type_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetype/type_name.md

#### type_name property

Gets name of QRCode Type.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### QrCodeTypes class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes.md

#### QrCodeTypes class

QRCode Types container.

The QrCodeTypes type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| all_types | All QRCode types. |
| AZTEC | Aztec QR-Code Type object. |
| DATA_MATRIX | DataMatrix QR-Code Type object. |
| QR | QR QR-Code Type object. |
| GS1_DATA_MATRIX | GS1 DataMatrix QR-Code Type object. |
| GS1QR | GS1 QR-Code Type object. |
| HIBCLICQR | HIBC LIC QR-Code Type object. |
| HIBCLIC_DATA_MATRIX | HIBC LIC Data Matrix QR-Code Type object. |
| HIBCLIC_AZTEC | HIBC LIC Aztec QR-Code Type object. |
| HIBCPASQR | HIBC PAS QR-Code Type object. |
| HIBCPAS_DATA_MATRIX | HIBC PAS Data Matrix QR-Code Type object. |
| HIBCPAS_AZTEC | HIBC PAS Aztec QR-Code Type object. |
| HAN_XIN | Han Xin QR-Code Type object. |
| GS1_HAN_XIN | GS1 Han Xin QR-Code Type object. |
| RECT_MICRO_QR | RectMicroQR Type object. |
| MICRO_QR | MicroQR Type object. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw |
| try_parse | Returns QRCode type with pasringType name.
<br/>If name of QRCode is unknown - no Exception will be throw but method will return null value. |

### all_types property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/all_types.md

#### all_types property

All QRCode types.

### AZTEC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/aztec.md

#### AZTEC property

Aztec QR-Code Type object.

### DATA_MATRIX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/data_matrix.md

#### DATA_MATRIX property

DataMatrix QR-Code Type object.

### GS1_DATA_MATRIX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/gs1_data_matrix.md

#### GS1_DATA_MATRIX property

GS1 DataMatrix QR-Code Type object.

### GS1_HAN_XIN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/gs1_han_xin.md

#### GS1_HAN_XIN property

GS1 Han Xin QR-Code Type object.

### GS1QR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/gs1qr.md

#### GS1QR property

GS1 QR-Code Type object.

### HAN_XIN property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/han_xin.md

#### HAN_XIN property

Han Xin QR-Code Type object.

### HIBCLIC_AZTEC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibclic_aztec.md

#### HIBCLIC_AZTEC property

HIBC LIC Aztec QR-Code Type object.

### HIBCLIC_DATA_MATRIX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibclic_data_matrix.md

#### HIBCLIC_DATA_MATRIX property

HIBC LIC Data Matrix QR-Code Type object.

### HIBCLICQR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibclicqr.md

#### HIBCLICQR property

HIBC LIC QR-Code Type object.

### HIBCPAS_AZTEC property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibcpas_aztec.md

#### HIBCPAS_AZTEC property

HIBC PAS Aztec QR-Code Type object.

### HIBCPAS_DATA_MATRIX property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibcpas_data_matrix.md

#### HIBCPAS_DATA_MATRIX property

HIBC PAS Data Matrix QR-Code Type object.

### HIBCPASQR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/hibcpasqr.md

#### HIBCPASQR property

HIBC PAS QR-Code Type object.

### MICRO_QR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/micro_qr.md

#### MICRO_QR property

MicroQR Type object.

### parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/parse.md

#### parse

Returns QRCode type with pasringType name. If name of QRCode is unknown - Exception will be throw

##### Returns

QRCodeType instance.

```python
def parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of QRCode type name. |

### QR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/qr.md

#### QR property

QR QR-Code Type object.

### RECT_MICRO_QR property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/rect_micro_qr.md

#### RECT_MICRO_QR property

RectMicroQR Type object.

### try_parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/qrcodetypes/try_parse.md

#### try_parse

Returns QRCode type with pasringType name.
If name of QRCode is unknown - no Exception will be throw but method will return null value.

##### Returns

QRCodeType instance.

```python
def try_parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of QRCode type name. |

### RadioButtonFormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature.md

#### RadioButtonFormFieldSignature class

Contains radio-button input form field signature properties.

**Inheritance:** `RadioButtonFormFieldSignature` →
`FormFieldSignature` →
`BaseSignature`

The RadioButtonFormFieldSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates RadioButtonFieldSignature with predefined name. |
| __init__ | Constructs a new instance of RadioButtonFormFieldSignature |
| __init__ | Constructs a new instance of RadioButtonFormFieldSignature |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |
| selected | Contains selected value. |
| items | Get or set Radio buttons options list. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### RadioButtonFormFieldSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/__init__.md

#### __init__

Creates RadioButtonFieldSignature with predefined name.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |

#### __init__

Constructs a new instance of RadioButtonFormFieldSignature

```python
def __init__(self, name, items):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String |  |
| items | System.Collections.Generic.List`1[[System.String]] |  |

#### __init__

Constructs a new instance of RadioButtonFormFieldSignature

```python
def __init__(self, name, items, selected):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String |  |
| items | System.Collections.Generic.List`1[[System.String]] |  |
| selected | System.Object |  |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### items property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/items.md

#### items property

Get or set Radio buttons options list.
##### Definition:
```python
@property
def items(self):
    ...
@items.setter
def items(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/name.md

#### name property

Specifies unique form field name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### selected property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/selected.md

#### selected property

Contains selected value.
##### Definition:
```python
@property
def selected(self):
    ...
@selected.setter
def selected(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/type.md

#### type property

Specifies Form field type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/value.md

#### value property

Specifies Form field data object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/radiobuttonformfieldsignature/width.md

#### width property

Specifies width of signature.

### SearchResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult.md

#### SearchResult class

Result of searching for signatures in specified document.

The SearchResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the search process in milliseconds. |
| total_signatures | Returns the total processed signatures by the search process |
| source_document_size | Returns source document size |
| destin_document_size | Returns destination document size. For Search method it always returns 0. |
| succeeded | List of found signatures `BaseSignature`. This list will be always equal to `SearchResult.signatures` property. |
| failed | List of signatures `BaseSignature` that failed Search process by search criteria.
<br/>Supported only for failed Archive documents on Search method. |
| signatures | List of found signatures `BaseSignature`. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/destin_document_size.md

#### destin_document_size property

Returns destination document size. For Search method it always returns 0.
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/failed.md

#### failed property

List of signatures `BaseSignature` that failed Search process by search criteria.
Supported only for failed Archive documents on Search method.
##### Definition:
```python
@property
def failed(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/processing_time.md

#### processing_time property

Returns the execution time of the search process in milliseconds.
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/signatures.md

#### signatures property

List of found signatures `BaseSignature`.
##### Definition:
```python
@property
def signatures(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/source_document_size.md

#### source_document_size property

Returns source document size
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/succeeded.md

#### succeeded property

List of found signatures `BaseSignature`. This list will be always equal to `SearchResult.signatures` property.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/searchresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures by the search process
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### ShapePosition enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/shapeposition.md

#### ShapePosition enumeration

Specifies shape position in the document layout

The ShapePosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Shape presents in the document body |
| HEADER | Shape presents in the document header |
| FOOTER | Shape presents in the document footer |

### SignatureFont class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont.md

#### SignatureFont class

Creates instance of SignatureFont class to specify Font properties.

The SignatureFont type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Create SignatureFont with default values. |

##### Properties
| Property | Description |
| :- | :- |
| family_name | Gets or sets font family name |
| size | Gets or sets font size |
| bold | Gets or sets font bold style |
| italic | Gets or sets font italic style |
| underline | Gets or sets font underline style |
| strikeout | Gets or sets font strikeout style |

### SignatureFont constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/__init__.md

#### __init__

Create SignatureFont with default values.

```python
def __init__(self):
    ...
```

### bold property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/bold.md

#### bold property

Gets or sets font bold style
##### Definition:
```python
@property
def bold(self):
    ...
@bold.setter
def bold(self, value):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/family_name.md

#### family_name property

Gets or sets font family name
##### Definition:
```python
@property
def family_name(self):
    ...
@family_name.setter
def family_name(self, value):
    ...
```

### italic property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/italic.md

#### italic property

Gets or sets font italic style
##### Definition:
```python
@property
def italic(self):
    ...
@italic.setter
def italic(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/size.md

#### size property

Gets or sets font size
##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### strikeout property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/strikeout.md

#### strikeout property

Gets or sets font strikeout style
##### Definition:
```python
@property
def strikeout(self):
    ...
@strikeout.setter
def strikeout(self, value):
    ...
```

### underline property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturefont/underline.md

#### underline property

Gets or sets font underline style
##### Definition:
```python
@property
def underline(self):
    ...
@underline.setter
def underline(self, value):
    ...
```

### SignatureType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signaturetype.md

#### SignatureType enumeration

Defines supported types of signatures for various processes like Sign, Verify, Search, Update, Delete

The SignatureType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Indicates an error, unknown signature type. |
| TEXT | The Text Signature type |
| IMAGE | The Image Signature type |
| BARCODE | The Barcode Signature type |
| QR_CODE | The QR-Code Signature type |
| STAMP | The Stamp Signature type |
| METADATA | The Metadata Signature type |
| FORM_FIELD | The FormField Signature type |
| DIGITAL | The Digital Signature type |

### SignResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult.md

#### SignResult class

Result of signing process for document with newly created signatures.

The SignResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the process in milliseconds |
| total_signatures | Returns the total processed signatures |
| source_document_size | Returns source document size |
| destin_document_size | Returns destination document size |
| succeeded | List of newly created signatures `BaseSignature`. |
| failed | List of signatures that were failed to create. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/destin_document_size.md

#### destin_document_size property

Returns destination document size
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/failed.md

#### failed property

List of signatures that were failed to create.
##### Definition:
```python
@property
def failed(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/source_document_size.md

#### source_document_size property

Returns source document size
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/succeeded.md

#### succeeded property

List of newly created signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/signresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### SpreadsheetMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature.md

#### SpreadsheetMetadataSignature class

Contains Spreadsheet Metadata Signature properties.

**Inheritance:** `SpreadsheetMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The SpreadsheetMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Spreadsheet Metadata Signature with predefined name and empty value. |
| __init__ | Creates Spreadsheet Metadata Signature with predefined values. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Spreadsheet Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### SpreadsheetMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/__init__.md

#### __init__

Creates Spreadsheet Metadata Signature with predefined name and empty value.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Spreadsheet Metadata Signature name. |

#### __init__

Creates Spreadsheet Metadata Signature with predefined values.

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object. |
| value | System.Object | Value of Metadata signature. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Spreadsheet Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetmetadatasignature/width.md

#### width property

Specifies width of signature.

### SpreadsheetSaveFileFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/spreadsheetsavefileformat.md

#### SpreadsheetSaveFileFormat enumeration

Defines different save formats for Spreadsheet documents.

The SpreadsheetSaveFileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | File format will not be changed. |
| CSV | Saves the document as comma separated value file. |
| EXCEL_97_TO_2003 | Saves the document as Microsoft Excel 97-2003 workbook (.xls). |
| XLSX | Saves the document an Microsoft Excel OpenXML workbook. |
| XLSM | Saves the document as Microsoft Excel macro-enabled workbook. |
| XLTX | Saves the document as Microsoft Excel template. |
| XLTM | Saves the document as Microsoft Excel macro-enabled template. |
| XLAM | Saves the document as Microsoft Excel macro-enabled add-In. |
| PDF | Saves the document as an PDF file. |
| ODS | Saves the document as Open Office workbook. |
| XLSB | Saves the document as Microsoft Excel Binary workbook. |
| XPS | Saves the document as XML Paper Specification File. |
| TIFF | Saves the document in Tagged Image File Format. |
| SVG | Saves the document as  Scalable Vector Graphics file. |
| DIF | Saves the document in Data Interchange Format. |
| EMF | Saves the document in Windows Enhanced Metafile format. |
| JPG | Saves the document in Jpeg format. |
| PNG | Saves the document in Portable Network Graphics format. |

### SquareBorder class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder.md

#### SquareBorder class

Instance to keep Border line properties for square stamp line.

**Inheritance:** `SquareBorder` →
`Border`

The SquareBorder type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates SquareBorderLine with rounded corner radius. |
| __init__ | Creates SquareBorderLine with corner radius values. |

##### Properties
| Property | Description |
| :- | :- |
| dash_style | Gets or sets the signature border style. |
| transparency | Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| weight | Gets or sets the weight of the signature border. |
| color | Gets or sets the border color of signature. |
| visible | Gets or sets the border visibility. |
| radius | Gets or sets the radius of square corners. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Implement IClonable interface |

### SquareBorder constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/__init__.md

#### __init__

Creates SquareBorderLine with rounded corner radius.

```python
def __init__(self, radius):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| radius | float | Radius of square corners. |

#### __init__

Creates SquareBorderLine with corner radius values.

```python
def __init__(self, corners):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| corners | groupdocs.signature.domain.Corners | Radius of square corners. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/clone.md

#### clone

Implement IClonable interface

##### Returns

Newly created Border instance with same properties

```python
def clone(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/color.md

#### color property

Gets or sets the border color of signature.

### dash_style property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/dash_style.md

#### dash_style property

Gets or sets the signature border style.

### radius property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/radius.md

#### radius property

Gets or sets the radius of square corners.
##### Definition:
```python
@property
def radius(self):
    ...
@radius.setter
def radius(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/transparency.md

#### transparency property

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### visible property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/visible.md

#### visible property

Gets or sets the border visibility.

### weight property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/squareborder/weight.md

#### weight property

Gets or sets the weight of the signature border.

### StampBackgroundCropType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampbackgroundcroptype.md

#### StampBackgroundCropType enumeration

Specifies crop type of background layer on Stamp elements.

The StampBackgroundCropType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No crop - all Signature area rectangle will be filled with background. |
| OUTER_AREA | Crop background by external outer line. |
| MIDDLE_AREA | Crop background between external and inner lines. |
| INNER_AREA | Crop background by internal line. |

### StampLine class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline.md

#### StampLine class

Specify Stamp line properties.

The StampLine type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Create StampLine with default values. |

##### Properties
| Property | Description |
| :- | :- |
| height | Gets or sets the line height on Stamp. |
| background_color | Gets or sets the background color of signature. |
| text | Gets or sets the text of stamp line. |
| font | Gets or sets Font of Stamp Line text. |
| text_color | Gets or sets the text color of signature. |
| text_bottom_intent | Gets or sets the bottom intent of text. |
| text_repeat_type | Gets or sets text repeat type. |
| outer_border | Setup Outer Border. |
| inner_border | Setup Internal Border. |
| visible | Get and set visibility of Stamp Line. |

### StampLine constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/__init__.md

#### __init__

Create StampLine with default values.

```python
def __init__(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/background_color.md

#### background_color property

Gets or sets the background color of signature.
##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### font property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/font.md

#### font property

Gets or sets Font of Stamp Line text.
##### Definition:
```python
@property
def font(self):
    ...
@font.setter
def font(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/height.md

#### height property

Gets or sets the line height on Stamp.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### inner_border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/inner_border.md

#### inner_border property

Setup Internal Border.
##### Definition:
```python
@property
def inner_border(self):
    ...
@inner_border.setter
def inner_border(self, value):
    ...
```

### outer_border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/outer_border.md

#### outer_border property

Setup Outer Border.
##### Definition:
```python
@property
def outer_border(self):
    ...
@outer_border.setter
def outer_border(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/text.md

#### text property

Gets or sets the text of stamp line.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### text_bottom_intent property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/text_bottom_intent.md

#### text_bottom_intent property

Gets or sets the bottom intent of text.
##### Definition:
```python
@property
def text_bottom_intent(self):
    ...
@text_bottom_intent.setter
def text_bottom_intent(self, value):
    ...
```

### text_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/text_color.md

#### text_color property

Gets or sets the text color of signature.
##### Definition:
```python
@property
def text_color(self):
    ...
@text_color.setter
def text_color(self, value):
    ...
```

### text_repeat_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/text_repeat_type.md

#### text_repeat_type property

Gets or sets text repeat type.
##### Definition:
```python
@property
def text_repeat_type(self):
    ...
@text_repeat_type.setter
def text_repeat_type(self, value):
    ...
```

### visible property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stampline/visible.md

#### visible property

Get and set visibility of Stamp Line.
##### Definition:
```python
@property
def visible(self):
    ...
@visible.setter
def visible(self, value):
    ...
```

### StampTextRepeatType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptextrepeattype.md

#### StampTextRepeatType enumeration

Specifies type of text repeat for stamp lines.

The StampTextRepeatType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No repeat. |
| FULL_TEXT_REPEAT | Text will be repeated to fit full length without truncation. |
| REPEAT_WITH_TRUNCATION | Text will be repeated to fit full length with word truncation at the end. |

### StampType class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptype.md

#### StampType class

Specify stamp type properties.

The StampType type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| type_index | Get Index of object in collection of supported stamp types. |
| type_name | Name of stamp type. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified stamp type is equal to the current object. |

### equals method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptype/equals.md

#### equals

Determines whether the specified stamp type is equal to the current object.

##### Returns

Result of comparison.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.signature.domain.StampType | Object for comparison. |

### type_index property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptype/type_index.md

#### type_index property

Get Index of object in collection of supported stamp types.
##### Definition:
```python
@property
def type_index(self):
    ...
```

### type_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptype/type_name.md

#### type_name property

Name of stamp type.
##### Definition:
```python
@property
def type_name(self):
    ...
```

### StampTypes class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes.md

#### StampTypes class

Stamp types container.

The StampTypes type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| all_types | All stamp types. |
| ROUND | Round stamp type object. |
| SQUARE | Square stamp type object. |

##### Methods
| Method | Description |
| :- | :- |
| parse | Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown. |
| try_parse | Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value. |

### all_types property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes/all_types.md

#### all_types property

All stamp types.

### parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes/parse.md

#### parse

Returns stamp type with pasringType name. When name of stamp is unknown - exception is thrown.

##### Returns

StampType instance.

```python
def parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of stamp type name. |

### ROUND property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes/round.md

#### ROUND property

Round stamp type object.

### SQUARE property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes/square.md

#### SQUARE property

Square stamp type object.

### try_parse method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stamptypes/try_parse.md

#### try_parse

Returns stamp type with pasringType name. When name of stamp is unknown - no exception is thrown and method returns null value.

##### Returns

StampType instance.

```python
def try_parse(self, parsing_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| parsing_type | System.String | Source string of stamp type name. |

### StretchMode enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/stretchmode.md

#### StretchMode enumeration

Represents stretch mode of signature area on a document page.

The StretchMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Default value. No stretch mode will be applied. |
| PAGE_WIDTH | Stretch Signature area along page Width. Margin property will be used to apply required offset values |
| PAGE_HEIGHT | Stretch Signature area along page Height. Margin property will be used to apply required offset values. |
| PAGE_AREA | Stretch Signature area along page Height and Width. Margin property will be used to apply required offset values. |

### TextFormFieldSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature.md

#### TextFormFieldSignature class

Contains text input form field signature properties for Pdf Document

**Inheritance:** `TextFormFieldSignature` →
`FormFieldSignature` →
`BaseSignature`

The TextFormFieldSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PdfTextFormFieldSignature with predefined name. |
| __init__ | Creates PdfTextFormFieldSignature with predefined name. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique form field name. |
| type | Specifies Form field type. |
| value | Specifies Form field data object. |
| text | Gets or sets text of form field text input. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone FormField Signature instance. |

### TextFormFieldSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/__init__.md

#### __init__

Creates PdfTextFormFieldSignature with predefined name.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |

#### __init__

Creates PdfTextFormFieldSignature with predefined name.

```python
def __init__(self, name, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of form field object. |
| text | System.String | Text of form field object. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/clone.md

#### clone

Clone FormField Signature instance.

##### Returns

Returns cloned FormField Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/name.md

#### name property

Specifies unique form field name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/text.md

#### text property

Gets or sets text of form field text input.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/type.md

#### type property

Specifies Form field type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/value.md

#### value property

Specifies Form field data object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textformfieldsignature/width.md

#### width property

Specifies width of signature.

### TextHorizontalAlignment enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/texthorizontalalignment.md

#### TextHorizontalAlignment enumeration

Specifies text horizontal alignment inside a signature.

The TextHorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LEFT | Specifies that the text is left aligned to the horizontal alignment base. |
| CENTER | Specifies that the text is centered to the horizontal alignment base. |
| RIGHT | Specifies that the text is right aligned to the horizontal alignment base. |

### TextMatchType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textmatchtype.md

#### TextMatchType enumeration

Specifies text match type in string.

The TextMatchType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EXACT | Text fully matches value. |
| STARTS_WITH | Text starts with value. |
| ENDS_WITH | Text ends with value. |
| CONTAINS | Text contains the value. |

### TextShapeType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textshapetype.md

#### TextShapeType enumeration

Specifies types of text shapes.

The TextShapeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RECTANGLE | Rectangle. |
| ROUND_RECTANGLE | RoundRectangle. |
| ELLIPSE | Ellipse. |
| DIAMOND | Diamond. |
| TRIANGLE | Triangle. |
| RIGHT_TRIANGLE | RightTriangle. |
| PARALLELOGRAM | Parallelogram. |
| TRAPEZOID | Trapezoid. |
| HEXAGON | Hexagon. |
| OCTAGON | Octagon. |
| PLUS | Plus. |
| STAR | Star. |
| ARROW | Arrow. |
| THICK_ARROW | ThickArrow. |
| HOME_PLATE | HomePlate. |
| CUBE | Cube. |
| BALLOON | Balloon. |
| SEAL | Seal. |
| ARC | Arc. |
| LINE | Line. |
| PLAQUE | Plaque. |
| CAN | Can. |
| DONUT | Donut. |
| TEXT_SIMPLE | TextSimple. |
| TEXT_OCTAGON | TextOctagon. |
| TEXT_HEXAGON | TextHexagon. |
| TEXT_CURVE | TextCurve. |
| TEXT_WAVE | TextWave. |
| TEXT_RING | TextRing. |
| TEXT_ON_CURVE | TextOnCurve. |
| TEXT_ON_RING | TextOnRing. |
| STRAIGHT_CONNECTOR1 | StraightConnector1. |
| BENT_CONNECTOR2 | BentConnector2. |
| BENT_CONNECTOR3 | BentConnector3. |
| BENT_CONNECTOR4 | BentConnector4. |
| BENT_CONNECTOR5 | BentConnector5. |
| CURVED_CONNECTOR2 | CurvedConnector2. |
| CURVED_CONNECTOR3 | CurvedConnector3. |
| CURVED_CONNECTOR4 | CurvedConnector4. |
| CURVED_CONNECTOR5 | CurvedConnector5. |
| CALLOUT1 | Callout1. |
| CALLOUT2 | Callout2. |
| CALLOUT3 | Callout3. |
| ACCENT_CALLOUT1 | AccentCallout1. |
| ACCENT_CALLOUT2 | AccentCallout2. |
| ACCENT_CALLOUT3 | AccentCallout3. |
| BORDER_CALLOUT1 | BorderCallout1. |
| BORDER_CALLOUT2 | BorderCallout2. |
| BORDER_CALLOUT3 | BorderCallout3. |
| ACCENT_BORDER_CALLOUT1 | AccentBorderCallout1. |
| ACCENT_BORDER_CALLOUT2 | AccentBorderCallout2. |
| ACCENT_BORDER_CALLOUT3 | AccentBorderCallout3. |
| RIBBON | Ribbon. |
| RIBBON2 | Ribbon2. |
| CHEVRON | Chevron. |
| PENTAGON | Pentagon. |
| NO_SMOKING | NoSmoking. |
| SEAL8 | Seal8. |
| SEAL16 | Seal16. |
| SEAL32 | Seal32. |
| WEDGE_RECT_CALLOUT | WedgeRectCallout. |
| WEDGE_R_RECT_CALLOUT | WedgeRRectCallout. |
| WEDGE_ELLIPSE_CALLOUT | WedgeEllipseCallout. |
| WAVE | Wave. |
| FOLDED_CORNER | FoldedCorner. |
| LEFT_ARROW | LeftArrow. |
| DOWN_ARROW | DownArrow. |
| UP_ARROW | UpArrow. |
| LEFT_RIGHT_ARROW | LeftRightArrow. |
| UP_DOWN_ARROW | UpDownArrow. |
| IRREGULAR_SEAL1 | IrregularSeal1. |
| IRREGULAR_SEAL2 | IrregularSeal2. |
| LIGHTNING_BOLT | LightningBolt. |
| HEART | Heart. |
| IMAGE | Image. |
| QUAD_ARROW | QuadArrow. |
| LEFT_ARROW_CALLOUT | LeftArrowCallout. |
| RIGHT_ARROW_CALLOUT | RightArrowCallout. |
| UP_ARROW_CALLOUT | UpArrowCallout. |
| DOWN_ARROW_CALLOUT | DownArrowCallout. |
| LEFT_RIGHT_ARROW_CALLOUT | LeftRightArrowCallout. |
| UP_DOWN_ARROW_CALLOUT | UpDownArrowCallout. |
| QUAD_ARROW_CALLOUT | QuadArrowCallout. |
| BEVEL | Bevel. |
| LEFT_BRACKET | LeftBracket. |
| RIGHT_BRACKET | RightBracket. |
| LEFT_BRACE | LeftBrace. |
| RIGHT_BRACE | RightBrace. |
| LEFT_UP_ARROW | LeftUpArrow. |
| BENT_UP_ARROW | BentUpArrow. |
| BENT_ARROW | BentArrow. |
| SEAL24 | Seal24. |
| STRIPED_RIGHT_ARROW | StripedRightArrow. |
| NOTCHED_RIGHT_ARROW | NotchedRightArrow. |
| BLOCK_ARC | BlockArc. |
| SMILEY_FACE | SmileyFace. |
| VERTICAL_SCROLL | VerticalScroll. |
| HORIZONTAL_SCROLL | HorizontalScroll. |
| CIRCULAR_ARROW | CircularArrow. |
| UTURN_ARROW | UturnArrow. |
| CURVED_RIGHT_ARROW | CurvedRightArrow. |
| CURVED_LEFT_ARROW | CurvedLeftArrow. |
| CURVED_UP_ARROW | CurvedUpArrow. |
| CURVED_DOWN_ARROW | CurvedDownArrow. |
| CLOUD_CALLOUT | CloudCallout. |
| ELLIPSE_RIBBON | EllipseRibbon. |
| ELLIPSE_RIBBON2 | EllipseRibbon2. |
| FLOW_CHART_PROCESS | FlowChartProcess. |
| FLOW_CHART_DECISION | FlowChartDecision. |
| FLOW_CHART_INPUT_OUTPUT | FlowChartInputOutput. |
| FLOW_CHART_PREDEFINED_PROCESS | FlowChartPredefinedProcess. |
| FLOW_CHART_INTERNAL_STORAGE | FlowChartInternalStorage. |
| FLOW_CHART_DOCUMENT | FlowChartDocument. |
| FLOW_CHART_MULTIDOCUMENT | FlowChartMultidocument. |
| FLOW_CHART_TERMINATOR | FlowChartTerminator. |
| FLOW_CHART_PREPARATION | FlowChartPreparation. |
| FLOW_CHART_MANUAL_INPUT | FlowChartManualInput. |
| FLOW_CHART_MANUAL_OPERATION | FlowChartManualOperation. |
| FLOW_CHART_CONNECTOR | FlowChartConnector. |
| FLOW_CHART_PUNCHED_CARD | FlowChartPunchedCard. |
| FLOW_CHART_PUNCHED_TAPE | FlowChartPunchedTape. |
| FLOW_CHART_SUMMING_JUNCTION | FlowChartSummingJunction. |
| FLOW_CHART_OR | FlowChartOr. |
| FLOW_CHART_COLLATE | FlowChartCollate. |
| FLOW_CHART_SORT | FlowChartSort. |
| FLOW_CHART_EXTRACT | FlowChartExtract. |
| FLOW_CHART_MERGE | FlowChartOfflineStorage. |
| FLOW_CHART_OFFLINE_STORAGE | FlowChartOfflineStorage. |
| FLOW_CHART_ONLINE_STORAGE | FlowChartOnlineStorage. |
| FLOW_CHART_MAGNETIC_TAPE | FlowChartMagneticTape. |
| FLOW_CHART_MAGNETIC_DISK | FlowChartMagneticDisk. |
| FLOW_CHART_MAGNETIC_DRUM | FlowChartMagneticDrum. |
| FLOW_CHART_DISPLAY | FlowChartDisplay. |
| FLOW_CHART_DELAY | FlowChartDelay. |
| TEXT_PLAIN_TEXT | TextPlainText. |
| TEXT_STOP | TextStop. |
| TEXT_TRIANGLE | TextTriangle. |
| TEXT_TRIANGLE_INVERTED | TextTriangleInverted. |
| TEXT_CHEVRON | TextChevron. |
| TEXT_CHEVRON_INVERTED | TextChevronInverted. |
| TEXT_RING_INSIDE | TextRingInside. |
| TEXT_RING_OUTSIDE | TextRingOutside. |
| TEXT_ARCH_UP_CURVE | TextArchUpCurve. |
| TEXT_ARCH_DOWN_CURVE | TextArchDownCurve. |
| TEXT_CIRCLE_CURVE | TextCircleCurve. |
| TEXT_BUTTON_CURVE | TextButtonCurve. |
| TEXT_ARCH_UP_POUR | TextArchUpPour. |
| TEXT_ARCH_DOWN_POUR | TextArchDownPour. |
| TEXT_CIRCLE_POUR | TextCirclePour. |
| TEXT_BUTTON_POUR | TextButtonPour. |
| TEXT_CURVE_UP | TextCurveUp. |
| TEXT_CURVE_DOWN | TextCurveDown. |
| TEXT_CASCADE_UP | TextCascadeUp. |
| TEXT_CASCADE_DOWN | TextCascadeDown. |
| TEXT_WAVE1 | TextWave1. |
| TEXT_WAVE2 | TextWave2. |
| TEXT_WAVE3 | TextWave3. |
| TEXT_WAVE4 | TextWave4. |
| TEXT_INFLATE | TextInflate. |
| TEXT_DEFLATE | TextDeflate. |
| TEXT_INFLATE_BOTTOM | TextInflateBottom. |
| TEXT_DEFLATE_BOTTOM | TextDeflateBottom. |
| TEXT_INFLATE_TOP | TextInflateTop. |
| TEXT_DEFLATE_TOP | TextDeflateTop. |
| TEXT_DEFLATE_INFLATE | TextDeflateInflate. |
| TEXT_DEFLATE_INFLATE_DEFLATE | TextDeflateInflateDeflate. |
| TEXT_FADE_RIGHT | TextFadeRight. |
| TEXT_FADE_LEFT | TextFadeLeft. |
| TEXT_FADE_UP | TextFadeUp. |
| TEXT_FADE_DOWN | TextFadeDown. |
| TEXT_SLANT_UP | TextSlantUp. |
| TEXT_SLANT_DOWN | TextSlantDown. |
| TEXT_CAN_UP | TextCanUp. |
| TEXT_CAN_DOWN | TextCanDown. |
| FLOW_CHART_ALTERNATE_PROCESS | FlowChartAlternateProcess. |
| FLOW_CHART_OFFPAGE_CONNECTOR | FlowChartOffpageConnector. |
| CALLOUT90 | Callout90. |
| ACCENT_CALLOUT90 | AccentCallout90. |
| BORDER_CALLOUT90 | BorderCallout90. |
| ACCENT_BORDER_CALLOUT90 | AccentBorderCallout90. |
| LEFT_RIGHT_UP_ARROW | LeftRightUpArrow. |
| SUN | Sun. |
| MOON | Moon. |
| BRACKET_PAIR | BracketPair. |
| BRACE_PAIR | BracePair. |
| SEAL4 | Seal4. |
| DOUBLE_WAVE | DoubleWave. |
| ACTION_BUTTON_BLANK | ActionButtonBlank. |
| ACTION_BUTTON_HOME | ActionButtonHome. |
| ACTION_BUTTON_HELP | ActionButtonHelp. |
| ACTION_BUTTON_INFORMATION | ActionButtonInformation. |
| ACTION_BUTTON_FORWARD_NEXT | ActionButtonForwardNext. |
| ACTION_BUTTON_BACK_PREVIOUS | ActionButtonBackPrevious. |
| ACTION_BUTTON_END | ActionButtonEnd. |
| ACTION_BUTTON_BEGINNING | ActionButtonBeginning. |
| ACTION_BUTTON_RETURN | ActionButtonReturn. |
| ACTION_BUTTON_DOCUMENT | ActionButtonDocument. |
| ACTION_BUTTON_SOUND | ActionButtonSound. |
| ACTION_BUTTON_MOVIE | ActionButtonMovie. |
| TEXT_BOX | TextBox. |

### TextSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature.md

#### TextSignature class

Contains Text signature properties.

**Inheritance:** `TextSignature` →
`BaseSignature`

The TextSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initialize TextSignature object with signature identifier that was obtained after search process.
<br/>This unique identifier is used to find additional properties for this signature from document signature information layer. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| text | Specifies text in signature. |
| signature_implementation | Specifies text signature implementation. |
| native | Specifies the native attribute. It is true if signature is document-specific. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Text Signature instance. |

### TextSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/__init__.md

#### __init__

Initialize TextSignature object with signature identifier that was obtained after search process.
This unique identifier is used to find additional properties for this signature from document signature information layer.

```python
def __init__(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String | Unique signature identifier obtained by sign or search method. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/clone.md

#### clone

Clone Text Signature instance.

##### Returns

Returns cloned Text Signature instance.

```python
def clone(self):
    ...
```

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/created_on.md

#### created_on property

Get or set the signature creation date.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### native property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/native.md

#### native property

Specifies the native attribute. It is true if signature is document-specific.
##### Definition:
```python
@property
def native(self):
    ...
@native.setter
def native(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/signature_implementation.md

#### signature_implementation property

Specifies text signature implementation.
##### Definition:
```python
@property
def signature_implementation(self):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/text.md

#### text property

Specifies text in signature.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/top.md

#### top property

Specifies top position of signature.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignature/width.md

#### width property

Specifies width of signature.

### TextSignatureImplementation enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textsignatureimplementation.md

#### TextSignatureImplementation enumeration

Specifies type of implementation for PDF text signature.

The TextSignatureImplementation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NATIVE | Text Signature as native text object on document page. |
| IMAGE | Text Signature as Image object on document page. |
| ANNOTATION | Text Signature as Text Annotation object on PDF page.
<br/>Annotations are visible only for Licensed version. |
| STICKER | Text Signature as Sticker object on PDF page. |
| FORM_FIELD | Text Signature as text in specified form field.
<br/>With this type of implementation could be used only TextSignOptions.Text,
<br/>TextSignOptions.FormTextFieldType and TextSignOptions.FormTextFieldTitle options. |
| WATERMARK | Text Signature as watermark on document page. |

### TextVerticalAlignment enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/textverticalalignment.md

#### TextVerticalAlignment enumeration

Specifies text vertical alignment inside a signature.

The TextVerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TOP | Specifies that the text is top aligned to the vertical alignment base. |
| CENTER | Specifies that the text is centered to the vertical alignment base. |
| BOTTOM | Specifies that the text is bottom aligned to the vertical alignment base. |

### TimeStamp class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/timestamp.md

#### TimeStamp class

Represents data to get time stamp from third-party site.

The TimeStamp type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Instantiates new time stamp structure. |
| __init__ | Constructs a new instance of TimeStamp |

##### Properties
| Property | Description |
| :- | :- |
| url | Url of third-party site. |
| user | User. |
| password | Password. |

### TimeStamp constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/timestamp/__init__.md

#### __init__

Constructs a new instance of TimeStamp

```python
def __init__(self):
    ...
```

#### __init__

Instantiates new time stamp structure.

```python
def __init__(self, url, user, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| url | System.String | Url of third-party site. |
| user | System.String | User. |
| password | System.String | Password. |

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/timestamp/password.md

#### password property

Password.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### url property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/timestamp/url.md

#### url property

Url of third-party site.
##### Definition:
```python
@property
def url(self):
    ...
@url.setter
def url(self, value):
    ...
```

### user property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/timestamp/user.md

#### user property

User.
##### Definition:
```python
@property
def user(self):
    ...
@user.setter
def user(self, value):
    ...
```

### UpdateResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult.md

#### UpdateResult class

Result of modification of signatures in the document.

The UpdateResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the process in milliseconds |
| total_signatures | Returns the total processed signatures |
| source_document_size | Returns source document size |
| destin_document_size | Returns destination document size |
| succeeded | List of successfully modified signatures `BaseSignature`. |
| failed | List of signatures that were not updated `BaseSignature`. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/destin_document_size.md

#### destin_document_size property

Returns destination document size
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/failed.md

#### failed property

List of signatures that were not updated `BaseSignature`.
##### Definition:
```python
@property
def failed(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/source_document_size.md

#### source_document_size property

Returns source document size
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/succeeded.md

#### succeeded property

List of successfully modified signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/updateresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### VerificationResult class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult.md

#### VerificationResult class

Instance to keep results of verification process.

The VerificationResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| processing_time | Returns the execution time of the process in milliseconds. |
| total_signatures | Returns the total processed signatures |
| source_document_size | Returns source document size in bytes |
| destin_document_size | Returns the destination document size. For verification this variable always contains zero. |
| succeeded | List of successfully verified signatures `BaseSignature`. |
| failed | List of signatures that failed verification process.
<br/>Currently this property is not supported. |
| is_valid | Returns true if Verification process was successful otherwise false. |

### destin_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/destin_document_size.md

#### destin_document_size property

Returns the destination document size. For verification this variable always contains zero.
##### Definition:
```python
@property
def destin_document_size(self):
    ...
```

### failed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/failed.md

#### failed property

List of signatures that failed verification process.
Currently this property is not supported.
##### Definition:
```python
@property
def failed(self):
    ...
```

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/is_valid.md

#### is_valid property

Returns true if Verification process was successful otherwise false.
##### Definition:
```python
@property
def is_valid(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/processing_time.md

#### processing_time property

Returns the execution time of the process in milliseconds.
##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/source_document_size.md

#### source_document_size property

Returns source document size in bytes
##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/succeeded.md

#### succeeded property

List of successfully verified signatures `BaseSignature`.
##### Definition:
```python
@property
def succeeded(self):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verificationresult/total_signatures.md

#### total_signatures property

Returns the total processed signatures
##### Definition:
```python
@property
def total_signatures(self):
    ...
```

### VerticalAlignment enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/verticalalignment.md

#### VerticalAlignment enumeration

Specifies vertical alignment of element on a document page.

The VerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | The object is explicitly positioned, usually using its Top property. |
| TOP | Specifies that the object shall be at the top of the vertical alignment base. |
| CENTER | Specifies that the object shall be centered with respect to the vertical alignment base. |
| BOTTOM | Specifies that the object shall be at the bottom of the vertical alignment base. |

### WordProcessingMetadataSignature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature.md

#### WordProcessingMetadataSignature class

Contains WordProcessing Metadata Signature properties.

**Inheritance:** `WordProcessingMetadataSignature` →
`MetadataSignature` →
`BaseSignature`

The WordProcessingMetadataSignature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates WordProcessing Metadata Signature with predefined name and empty value. |
| __init__ | Creates WordProcessing Metadata Signature with predefined values. |

##### Properties
| Property | Description |
| :- | :- |
| signature_type | Specifies the type of signature. |
| page_number | Specifies the page signature was found on. |
| signature_id | Unique signature identifier to modify signature in the document over Update or Delete methods.
<br/>This property will be set automatically after Sign or Search method being called.
<br/>If this property was saved before it can be set manually to manipulate the signature. |
| is_signature | Get or set flag to indicate if this component is Signature or document content.
<br/>This property is being used with Update method to set element as signature (true) or document element (false). |
| deleted | Get the flag that indicates if this signature was deleted from the document.
<br/>This property is being used only for document history log records to keep the list of deleted signatures. |
| created_on | Get or set the signature creation date. |
| modified_on | Get or set the signature modification date. |
| top | Specifies top position of signature. |
| left | Specifies left position of signature. |
| width | Specifies width of signature. |
| height | Specifies height of signature. |
| name | Specifies unique metadata name. |
| value | Specifies metadata object. |
| type | Specifies metadata value type. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties. |

##### Methods
| Method | Description |
| :- | :- |
| clone | Clone Metadata Signature instance. |
| clone | Clone Words Metadata Signature instance with given value. |
| to_boolean | Converts to boolean. |
| to_integer | Converts to integer. |
| to_decimal | Converts to Decimal. |
| to_double | Converts to Double. |
| to_single | Converts to float. |
| to_date_time | Converts to DateTime. |
| to_string | Converts to String with specified format |

### WordProcessingMetadataSignature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/__init__.md

#### __init__

Creates WordProcessing Metadata Signature with predefined name and empty value.

```python
def __init__(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | WordProcessing Metadata Signature name. |

#### __init__

Creates WordProcessing Metadata Signature with predefined values.

```python
def __init__(self, name, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object. |
| value | System.Object | Value of Metadata signature. |

### clone method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/clone.md

#### clone

Clone Metadata Signature instance.

##### Returns

Returns cloned Metadata Signature instance

```python
def clone(self):
    ...
```

#### clone

Clone Words Metadata Signature instance with given value.

##### Returns

Returns cloned Metadata Signature instance.

```python
def clone(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | System.Object | Value for new cloned object. |

### created_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/created_on.md

#### created_on property

Get or set the signature creation date.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.

### deleted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/deleted.md

#### deleted property

Get the flag that indicates if this signature was deleted from the document.
This property is being used only for document history log records to keep the list of deleted signatures.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/height.md

#### height property

Specifies height of signature.

### is_signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/is_signature.md

#### is_signature property

Get or set flag to indicate if this component is Signature or document content.
This property is being used with Update method to set element as signature (true) or document element (false).

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/left.md

#### left property

Specifies left position of signature.

### modified_on property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/modified_on.md

#### modified_on property

Get or set the signature modification date.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/name.md

#### name property

Specifies unique metadata name.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/page_number.md

#### page_number property

Specifies the page signature was found on.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/signature_id.md

#### signature_id property

Unique signature identifier to modify signature in the document over Update or Delete methods.
This property will be set automatically after Sign or Search method being called.
If this property was saved before it can be set manually to manipulate the signature.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/signature_type.md

#### signature_type property

Specifies the type of signature.

### to_boolean method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_boolean.md

#### to_boolean

Converts to boolean.

##### Returns

Returns the Metadata signature value as boolean.

```python
def to_boolean(self):
    ...
```

### to_date_time method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_date_time.md

#### to_date_time

Converts to DateTime.

##### Returns

Returns the Metadata Signature value as DateTime.

```python
def to_date_time(self):
    ...
```

### to_decimal method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_decimal.md

#### to_decimal

Converts to Decimal.

##### Returns

Returns the Metadata Signature value as Decimal.

```python
def to_decimal(self):
    ...
```

### to_double method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_double.md

#### to_double

Converts to Double.

##### Returns

Returns the Metadata Signature value as Double.

```python
def to_double(self):
    ...
```

### to_integer method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_integer.md

#### to_integer

Converts to integer.

##### Returns

Returns the Metadata Signature value as integer.

```python
def to_integer(self):
    ...
```

### to_single method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_single.md

#### to_single

Converts to float.

##### Returns

Returns the Metadata Signature value as float.

```python
def to_single(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/to_string.md

#### to_string

Converts to String with specified format

##### Returns

Returns the Metadata Signature value as String.

```python
def to_string(self, format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| format | System.String | Data format string. |

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/top.md

#### top property

Specifies top position of signature.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/type.md

#### type property

Specifies metadata value type.

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/value.md

#### value property

Specifies metadata object.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingmetadatasignature/width.md

#### width property

Specifies width of signature.

### WordProcessingSaveFileFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingsavefileformat.md

#### WordProcessingSaveFileFormat enumeration

Defines different save file formats for WordProcessing documents.

The WordProcessingSaveFileFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | File Format will not be changed. |
| DOC | Saves the document as Microsoft Word 97-2003 document. |
| DOT | Saves the document as Microsoft Word 97-2003 template. |
| DOCX | Saves the document as Microsoft Word OpenXML document. |
| DOCM | Saves the document as Microsoft Word OpenXML macro-enabled document. |
| DOTX | Saves the document as Microsoft Word OpenXML template. |
| DOTM | Saves the document as Microsoft Word OpenXML macro-enabled template. |
| FLAT_OPC | Saves the document as an Office Open XML WordprocessingML
<br/>stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_MACRO_ENABLED | Saves the document as an Office Open XML WordprocessingML
<br/>Macro-Enabled Document stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_TEMPLATE | Saves the document as an Office Open XML WordprocessingML
<br/>Template (macro-free) stored in a flat XML file instead of a ZIP package. |
| FLAT_OPC_TEMPLATE_MACRO_ENABLED | Saves the document as an Office Open XML WordprocessingML
<br/>Macro-Enabled Template stored in a flat XML file instead of a ZIP package. |
| RTF | Saves the document in the RTF Format. All characters above 7-bits are escaped as hexadecimal or Unicode characters. |
| WORD_ML | Saves the document in the Microsoft Word 2003 WordprocessingML Format. |
| PDF | Saves the document as PDF (Adobe Portable Document) Format. |
| XPS | Saves the document in the XPS (XML Paper Specification) Format. |
| PS | Saves the document in the PS (PostScript) Format. |
| MHTML | Saves the document in the MHTML (Web archive) Format. |
| EPUB | Saves the document in the IDPF EPUB Format. |
| ODT | Saves the document as Open Office document. |
| OTT | Saves the document as Open Office document template. |
| TEXT | Saves the document in the plain text format. |
| TIFF | Renders a page or pages of the document and saves them into a single or multi-page TIFF file. |
| PNG | Renders a page of the document and saves it as a PNG file. |
| BMP | Renders a page of the document and saves it as a BMP file. |
| EMF | Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file. |
| JPEG | Renders a page of the document and saves it as a JPEG file. |
| AZW3 | Renders a page of the document and saves it as a Azw3 file. |

### WordProcessingTextSignatureImplementation enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/wordprocessingtextsignatureimplementation.md

#### WordProcessingTextSignatureImplementation enumeration

Specifies type of text signature implementation for WordProcessing documents.

The WordProcessingTextSignatureImplementation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TEXT_STAMP | Text Signature as Label object on Words page. |
| TEXT_AS_IMAGE | Text Signature as Image object on Words page. |
| TEXT_TO_FORM_FIELD | Text Signature as text in specified form field.
<br/>With this type of implementation could be used only TextSignOptions.Text,
<br/>TextSignOptions.FormTextFieldTitle and TextSignOptions.FormTextFieldType options. |
| WATERMARK | Text Signature as watermark on Words page. |

### XAdESType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.domain/xadestype.md

#### XAdESType enumeration

Type of XML Advanced Electronic Signature (XAdES).

The XAdESType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | XAdES is off. |
| X_AD_ES | Basic XAdES. |

### groupdocs.signature.logging
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging.md

The namespace provides classes for logging purposes.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` | Writes log messages to the file. |
| `FileLogger` | Writes log messages to the file. |
| `ILogger` | Defines the methods that are used to perform logging. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `LogLevel` | Specifies the available Log Level types.
<br/>This enumeration can be used as flags to set several possible values as enabled bits
<br/>Example: LogLevel.Error \| LogLevel.Warning or LogLevel.Error \| LogLevel.Trace |

### ConsoleLogger class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/consolelogger.md

#### ConsoleLogger class

Writes log messages to the file.

The ConsoleLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Create logger to console. |

##### Methods
| Method | Description |
| :- | :- |
| trace | Writes trace message to the console.
<br/>Trace log messages provide generally useful information about application flow. |
| warning | Writes warning message to the console;
<br/>Warning log messages provide information about the unexpected and recoverable event in application flow. |

### ConsoleLogger constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/consolelogger/__init__.md

#### __init__

Create logger to console.

```python
def __init__(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/consolelogger/trace.md

#### trace

Writes trace message to the console.
Trace log messages provide generally useful information about application flow.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The trace message. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Thrown when `message` is null. |

### warning method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/consolelogger/warning.md

#### warning

Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The warning message. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Thrown when `message` is null. |

### FileLogger class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/filelogger.md

#### FileLogger class

Writes log messages to the file.

The FileLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Create logger to file. |

##### Methods
| Method | Description |
| :- | :- |
| trace | Writes trace message to the console.
<br/>Trace log messages provide generally useful information about application flow. |
| warning | Writes warning message to the console;
<br/>Warning log messages provide information about the unexpected and recoverable event in application flow. |

### FileLogger constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/filelogger/__init__.md

#### __init__

Create logger to file.

```python
def __init__(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | System.String | Full file name with path |

### trace method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/filelogger/trace.md

#### trace

Writes trace message to the console.
Trace log messages provide generally useful information about application flow.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The trace message. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Thrown when `message` is null. |

### warning method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/filelogger/warning.md

#### warning

Writes warning message to the console;
Warning log messages provide information about the unexpected and recoverable event in application flow.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The warning message. |
##### Exceptions
| Exception | Description |
| :- | :- |
| ArgumentNullException | Thrown when `message` is null. |

### ILogger class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/ilogger.md

#### ILogger class

Defines the methods that are used to perform logging.

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| trace | Writes a trace message. Trace log messages provide generally useful information about application flow. |
| warning | Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow. |

### trace method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/ilogger/trace.md

#### trace

Writes a trace 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/signature/python-net/groupdocs.signature.logging/ilogger/warning.md

#### warning

Writes warning log message; Warning log messages provides information about unexpected and recoverable event in application flow.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The warning message. |

### LogLevel enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.logging/loglevel.md

#### LogLevel enumeration

Specifies the available Log Level types.
This enumeration can be used as flags to set several possible values as enabled bits
Example: LogLevel.Error | LogLevel.Warning or LogLevel.Error | LogLevel.Trace

The LogLevel type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No logging limitation all information will be logged from trace, warning to errors |
| ERROR | No logging limitation all information will be logged from trace, warning to errors |
| WARNING | Same as All level, all messages including the Trace level will be logged |
| TRACE | The logging level to include messages from the Warning to Error level |
| ALL | All Log level events (Error, Warning, Trace) will be included into the logging |

### groupdocs.signature.options.appearances
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances.md

The namespace provides classes for additional signature appearances.

##### Classes
| Class | Description |
| :- | :- |
| `DigitalSignatureAppearance` | Describes appearance of Signature Line for Digital Signature.
<br/>One Signature Line could be applied for only one Digital Signature.
<br/>Signature Line always is on the first page.
<br/>This feature may be useful for .docx, .doc, .odt and .xlsx file formats. |
| `ImageAppearance` | Describes extended appearance features for Image Signature. |
| `PdfDigitalSignatureAppearance` | Describes appearance of Digital Signature are on PDF documents. |
| `PdfTextAnnotationAppearance` | Describes appearance of PDF text annotation object (Title, Subject, Content). |
| `PdfTextStickerAppearance` | Describes appearance of PDF text annotation sticker object and pop-up window of sticker. |
| `SignatureAppearance` | Represents the signature appearance - additional options for alternative implementations of sign on document page. |

### DigitalSignatureAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/digitalsignatureappearance.md

#### DigitalSignatureAppearance class

Describes appearance of Signature Line for Digital Signature.
One Signature Line could be applied for only one Digital Signature.
Signature Line always is on the first page.
This feature may be useful for .docx, .doc, .odt and .xlsx file formats.

**Inheritance:** `DigitalSignatureAppearance` →
`SignatureAppearance`

The DigitalSignatureAppearance type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Signature Line Appearance object. |
| __init__ | Creates Signature Line Appearance with specified values (signer, title, email). |

##### Properties
| Property | Description |
| :- | :- |
| signer | Gets or sets signer name for signature line. |
| title | Gets or sets a title for signature line. |
| email | Gets or sets a email that will be displayed in signature line. |

### DigitalSignatureAppearance constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/digitalsignatureappearance/__init__.md

#### __init__

Creates Signature Line Appearance object.

```python
def __init__(self):
    ...
```

#### __init__

Creates Signature Line Appearance with specified values (signer, title, email).

```python
def __init__(self, signer, title, email):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signer | System.String | Signer name. |
| title | System.String | Signature title. |
| email | System.String | Author' email. |

### email property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/digitalsignatureappearance/email.md

#### email property

Gets or sets a email that will be displayed in signature line.
##### Definition:
```python
@property
def email(self):
    ...
@email.setter
def email(self, value):
    ...
```

### signer property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/digitalsignatureappearance/signer.md

#### signer property

Gets or sets signer name for signature line.
##### Definition:
```python
@property
def signer(self):
    ...
@signer.setter
def signer(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/digitalsignatureappearance/title.md

#### title property

Gets or sets a title for signature line.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### ImageAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance.md

#### ImageAppearance class

Describes extended appearance features for Image Signature.

**Inheritance:** `ImageAppearance` →
`SignatureAppearance`

The ImageAppearance type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Create instance with default values. |

##### Properties
| Property | Description |
| :- | :- |
| grayscale | Setup this flag to true if gray-scale filter is required. |
| brightness | Gets or sets image brightness.
<br/>Default value is 1 it corresponds to original brightness of image. |
| contrast | Gets or sets image contrast.
<br/>Default value is 1 it corresponds to original contrast of image. |
| gamma_correction | Gets or sets image gamma.
<br/>Default value is 1 it corresponds to original gamma of image. |

### ImageAppearance constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance/__init__.md

#### __init__

Create instance with default values.

```python
def __init__(self):
    ...
```

### brightness property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance/brightness.md

#### brightness property

Gets or sets image brightness.
Default value is 1 it corresponds to original brightness of image.
##### Definition:
```python
@property
def brightness(self):
    ...
@brightness.setter
def brightness(self, value):
    ...
```

### contrast property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance/contrast.md

#### contrast property

Gets or sets image contrast.
Default value is 1 it corresponds to original contrast of image.
##### Definition:
```python
@property
def contrast(self):
    ...
@contrast.setter
def contrast(self, value):
    ...
```

### gamma_correction property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance/gamma_correction.md

#### gamma_correction property

Gets or sets image gamma.
Default value is 1 it corresponds to original gamma of image.
##### Definition:
```python
@property
def gamma_correction(self):
    ...
@gamma_correction.setter
def gamma_correction(self, value):
    ...
```

### grayscale property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/imageappearance/grayscale.md

#### grayscale property

Setup this flag to true if gray-scale filter is required.
##### Definition:
```python
@property
def grayscale(self):
    ...
@grayscale.setter
def grayscale(self, value):
    ...
```

### PdfDigitalSignatureAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance.md

#### PdfDigitalSignatureAppearance class

Describes appearance of Digital Signature are on PDF documents.

**Inheritance:** `PdfDigitalSignatureAppearance` →
`SignatureAppearance`

The PdfDigitalSignatureAppearance type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates signature appearance object with default values. |

##### Properties
| Property | Description |
| :- | :- |
| contact_info_label | Gets or sets contact info label. Default value: "Contact".
<br/>if this value is empty then no contact label will appear on digital signature area. |
| reason_label | Gets or sets reason label. Default value: "Reason".
<br/>if this value is empty then no reason label will appear on digital signature area. |
| location_label | Gets or sets location label. Default value: "Location".
<br/>if this value is empty then no location label will appear on digital signature area. |
| digital_signed_label | Gets or sets digital signed label. Default value: "Digitally signed by". |
| date_signed_at_label | Gets or sets date signed label. Default value: "Date". |
| background | Get or set background color of signature appearance.
<br/>By default the value is SystemColors.Windows |
| font_family_name | Gets or sets the Font family name to display the labels. Default value is "Arial". |
| font_size | Gets or sets the Font size to display the labels. Default value is 10. |
| foreground | Get or set foreground text color of signature appearance.
<br/>By default the value is Color.FromArgb(76, 100, 255) |
| is_foreground_image | Gets or sets a value indicating whether the image in the signature appearance is drawn as a foreground image.
<br/>Default value: false. |

##### Remarks

**Learn more** |
|
 |
 |

### PdfDigitalSignatureAppearance constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/__init__.md

#### __init__

Creates signature appearance object with default values.

```python
def __init__(self):
    ...
```

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/background.md

#### background property

Get or set background color of signature appearance.
By default the value is SystemColors.Windows
##### Definition:
```python
@property
def background(self):
    ...
@background.setter
def background(self, value):
    ...
```

### contact_info_label property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/contact_info_label.md

#### contact_info_label property

Gets or sets contact info label. Default value: "Contact".
if this value is empty then no contact label will appear on digital signature area.
##### Definition:
```python
@property
def contact_info_label(self):
    ...
@contact_info_label.setter
def contact_info_label(self, value):
    ...
```

### date_signed_at_label property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/date_signed_at_label.md

#### date_signed_at_label property

Gets or sets date signed label. Default value: "Date".
##### Definition:
```python
@property
def date_signed_at_label(self):
    ...
@date_signed_at_label.setter
def date_signed_at_label(self, value):
    ...
```

### digital_signed_label property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/digital_signed_label.md

#### digital_signed_label property

Gets or sets digital signed label. Default value: "Digitally signed by".
##### Definition:
```python
@property
def digital_signed_label(self):
    ...
@digital_signed_label.setter
def digital_signed_label(self, value):
    ...
```

### font_family_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/font_family_name.md

#### font_family_name property

Gets or sets the Font family name to display the labels. Default value is "Arial".
##### Definition:
```python
@property
def font_family_name(self):
    ...
@font_family_name.setter
def font_family_name(self, value):
    ...
```

### font_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/font_size.md

#### font_size property

Gets or sets the Font size to display the labels. Default value is 10.
##### Definition:
```python
@property
def font_size(self):
    ...
@font_size.setter
def font_size(self, value):
    ...
```

### foreground property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/foreground.md

#### foreground property

Get or set foreground text color of signature appearance.
By default the value is Color.FromArgb(76, 100, 255)
##### Definition:
```python
@property
def foreground(self):
    ...
@foreground.setter
def foreground(self, value):
    ...
```

### is_foreground_image property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/is_foreground_image.md

#### is_foreground_image property

Gets or sets a value indicating whether the image in the signature appearance is drawn as a foreground image.
Default value: false.
##### Definition:
```python
@property
def is_foreground_image(self):
    ...
@is_foreground_image.setter
def is_foreground_image(self, value):
    ...
```

### location_label property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/location_label.md

#### location_label property

Gets or sets location label. Default value: "Location".
if this value is empty then no location label will appear on digital signature area.
##### Definition:
```python
@property
def location_label(self):
    ...
@location_label.setter
def location_label(self, value):
    ...
```

### reason_label property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdfdigitalsignatureappearance/reason_label.md

#### reason_label property

Gets or sets reason label. Default value: "Reason".
if this value is empty then no reason label will appear on digital signature area.
##### Definition:
```python
@property
def reason_label(self):
    ...
@reason_label.setter
def reason_label(self, value):
    ...
```

### PdfTextAnnotationAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance.md

#### PdfTextAnnotationAppearance class

Describes appearance of PDF text annotation object (Title, Subject, Content).

**Inheritance:** `PdfTextAnnotationAppearance` →
`SignatureAppearance`

The PdfTextAnnotationAppearance type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PDF signature text annotation appearance object. |
| __init__ | Creates  PDF signature text annotation with specified values (title, subject, contents). |

##### Properties
| Property | Description |
| :- | :- |
| contents | Gets or sets content of annotation object. |
| subject | Gets or sets Subject representing description of the object. |
| title | Gets or sets a Title that will be displayed in title bar of annotation object. |
| border | Gets or sets different border settings |
| border_effect | Gets or sets border effect. |
| border_effect_intensity | Gets or sets border effect intensity. Valid range of value is [0..2]. |
| h_corner_radius | Gets or sets horizontal corner radius. |
| v_corner_radius | Gets or sets vertical corner radius. |

### PdfTextAnnotationAppearance constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/__init__.md

#### __init__

Creates PDF signature text annotation appearance object.

```python
def __init__(self):
    ...
```

#### __init__

Creates  PDF signature text annotation with specified values (title, subject, contents).

```python
def __init__(self, title, subject, contents):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| title | System.String | Title. |
| subject | System.String | Subject. |
| contents | System.String | Contents. |

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/border.md

#### border property

Gets or sets different border settings
##### Definition:
```python
@property
def border(self):
    ...
@border.setter
def border(self, value):
    ...
```

### border_effect property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/border_effect.md

#### border_effect property

Gets or sets border effect.
##### Definition:
```python
@property
def border_effect(self):
    ...
@border_effect.setter
def border_effect(self, value):
    ...
```

### border_effect_intensity property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/border_effect_intensity.md

#### border_effect_intensity property

Gets or sets border effect intensity. Valid range of value is [0..2].
##### Definition:
```python
@property
def border_effect_intensity(self):
    ...
@border_effect_intensity.setter
def border_effect_intensity(self, value):
    ...
```

### contents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/contents.md

#### contents property

Gets or sets content of annotation object.
##### Definition:
```python
@property
def contents(self):
    ...
@contents.setter
def contents(self, value):
    ...
```

### h_corner_radius property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/h_corner_radius.md

#### h_corner_radius property

Gets or sets horizontal corner radius.
##### Definition:
```python
@property
def h_corner_radius(self):
    ...
@h_corner_radius.setter
def h_corner_radius(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/subject.md

#### subject property

Gets or sets Subject representing description of the object.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/title.md

#### title property

Gets or sets a Title that will be displayed in title bar of annotation object.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### v_corner_radius property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextannotationappearance/v_corner_radius.md

#### v_corner_radius property

Gets or sets vertical corner radius.
##### Definition:
```python
@property
def v_corner_radius(self):
    ...
@v_corner_radius.setter
def v_corner_radius(self, value):
    ...
```

### PdfTextStickerAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance.md

#### PdfTextStickerAppearance class

Describes appearance of PDF text annotation sticker object and pop-up window of sticker.

**Inheritance:** `PdfTextStickerAppearance` →
`SignatureAppearance`

The PdfTextStickerAppearance type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PDF signature text annotation appearance object. |

##### Properties
| Property | Description |
| :- | :- |
| title | Gets or sets title of pop-up window. |
| subject | Gets or sets subject. |
| contents | Gets or sets the contents of pop-up window. |
| opened | Setup if sticker pop-up window will be opened by default. |
| icon | Gets or sets the icon of sticker. |
| default_appearance | Gets default appearance for sticker. These properties are applied as default if
<br/>Options.SignatureAppearance property is not specified.
<br/>The properties could be changed by user any time. |

##### Methods
| Method | Description |
| :- | :- |
| reset_default_appearance | Clears values of default appearance for sticker. |

### PdfTextStickerAppearance constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/__init__.md

#### __init__

Creates PDF signature text annotation appearance object.

```python
def __init__(self):
    ...
```

### contents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/contents.md

#### contents property

Gets or sets the contents of pop-up window.
##### Definition:
```python
@property
def contents(self):
    ...
@contents.setter
def contents(self, value):
    ...
```

### default_appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/default_appearance.md

#### default_appearance property

Gets default appearance for sticker. These properties are applied as default if
Options.SignatureAppearance property is not specified.
The properties could be changed by user any time.

### icon property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/icon.md

#### icon property

Gets or sets the icon of sticker.
##### Definition:
```python
@property
def icon(self):
    ...
@icon.setter
def icon(self, value):
    ...
```

### opened property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/opened.md

#### opened property

Setup if sticker pop-up window will be opened by default.
##### Definition:
```python
@property
def opened(self):
    ...
@opened.setter
def opened(self, value):
    ...
```

### reset_default_appearance method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/reset_default_appearance.md

#### reset_default_appearance

Clears values of default appearance for sticker.

```python
def reset_default_appearance(self):
    ...
```

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/subject.md

#### subject property

Gets or sets subject.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/pdftextstickerappearance/title.md

#### title property

Gets or sets title of pop-up window.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### SignatureAppearance class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.appearances/signatureappearance.md

#### SignatureAppearance class

Represents the signature appearance - additional options for alternative implementations of sign on document page.

The SignatureAppearance type exposes the following members:

### groupdocs.signature.options
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options.md

The namespace provides classes to specify additional options when loading, signing, verifying, searching and saving documents.

##### Classes
| Class | Description |
| :- | :- |
| `BarcodeSearchOptions` | Represents search options for Barcode signatures. |
| `BarcodeSignOptions` | Represents the Barcode signature options. |
| `BarcodeVerifyOptions` | Represents the Barcode verify options. |
| `BmpSaveOptions` | Bmp Save options for image documents. |
| `CertificateSearchOptions` | Represents search options for Certificate metadata signatures. |
| `CertificateVerifyOptions` | Keeps options to verify certificate documents. |
| `DicomSaveOptions` | Save options for DICOM image documents. |
| `DicomXmpEntry` | Entry of XMP data for DICOM images (.dcm). |
| `DigitalSearchOptions` | Represents search options for Digital signatures. |
| `DigitalSignOptions` | Represents the Digital signature options. |
| `DigitalVerifyOptions` | Keeps options to verify document Digital signature. |
| `ExportImageSaveOptions` | Save options for exporting documents to image. |
| `FormFieldSearchOptions` | Represents search options for Form-field signatures. |
| `FormFieldSignOptions` | Represents class of the FormField signature options for Pdf documents. |
| `GifSaveOptions` | Gif format save options for image documents. |
| `ICustomSignHash` | Defines a contract for custom hash signing operations. |
| `ImageDigitalSignOptions` | Represents options to embed Aspose.Imaging digital (steganography) signature into raster images. |
| `ImageDigitalVerifyOptions` | Keeps options to verify digital signatures in raster images. |
| `ImageSaveOptions` | Save options for image documents. |
| `ImageSearchOptions` | Represents search options for Image signatures. |
| `ImageSignOptions` | Represents the Image signature options. |
| `JpegSaveOptions` | Jpeg Save options for image documents. |
| `LoadOptions` | Allows to specify additional options (such as password) when opening a document to sign. |
| `MetadataSearchOptions` | Represents search options for Metadata signatures. |
| `MetadataSignOptions` | Represents Metadata signature options. |
| `PagesSetup` | Describes special document pages to work with. |
| `PdfSaveOptions` | Save options for PDF documents. |
| `PdfTextAnnotationVerifyExtensions` | Describes extensions of verification of PDF text annotation object |
| `PdfTextStickerVerifyExtensions` | Describes extensions of verification of PDF sticker object. |
| `PngSaveOptions` | Png Save options for image documents. |
| `PresentationSaveOptions` | Save options for Presentation documents. |
| `PreviewOptions` | Represents document preview options. |
| `PreviewPageData` | Contains data about document page to be saved as preview image. |
| `PreviewSignatureOptions` | Represents signature preview options. |
| `QrCodeSearchOptions` | Represents search options for QR-Code signatures. |
| `QrCodeSignOptions` | Represents the QR-Code signature options. |
| `QrCodeVerifyOptions` | Keeps options to verify document QR-code signature. |
| `SaveOptions` | Allows to specify additional options (such as password) when saving a document to sign. |
| `SearchOptions` | Represents the extract signatures from document options. |
| `SignOptions` | Represents the signature options. |
| `SignatureContext` | Represents the context for a document signature process,
<br/>encapsulating the signing options. |
| `SpreadsheetSaveOptions` | Save options for Spreadsheet Documents. |
| `StampSignOptions` | Represents the Stamp signature options. |
| `TextSearchOptions` | Represents search options for Text signatures. |
| `TextSignOptions` | Represents the Text signature options. |
| `TextVerifyOptions` | Keeps options to verify document Text signature. |
| `TiffSaveOptions` | Tiff Save options for image documents. |
| `VerifyExtensions` | Keeps additional verification options for alternative implementations of signature on a document page. |
| `VerifyOptions` | Keeps options to verify document. |
| `WordProcessingSaveOptions` | Save options for WordProcessing documents. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `BitmapCompression` | Specifies different bitmap compression methods. |
| `DicomXmpType` | Supported types of XMP data for DICOM images (.dcm). |
| `JpegCompressionColorMode` | Specifies JPEG color compression modes. |
| `JpegCompressionMode` | Specifies JPEG compression modes. |
| `JpegRoundingMode` | Specifies different JPEG rounding modes. |
| `Permissions` | Specifies configurable permissions for PDF documents, such as printing, content modification, and data extraction.
<br/>These settings are applicable to PDF format only and control user access and interaction capabilities. |
| `PngColorType` | Represents the PNG image color type. |
| `PngFilterType` | Represents PNG image filter type. |
| `TiffFormat` | Specifies different tiff formats. |

### BarcodeSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions.md

#### BarcodeSearchOptions class

Represents search options for Barcode signatures.

**Inheritance:** `BarcodeSearchOptions` →
`SearchOptions`

The BarcodeSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the BarcodeSearchOptions class with default values. |
| __init__ | Initializes a new instance of the BarcodeSearchOptions class with encode type value. |
| __init__ | Initializes a new instance of the BarcodeSearchOptions class with encode type and text values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| encode_type | Specifies Encode Type property to search Barcodes.
<br/>If this value is not set, search is processed for all supported Barcode Types |
| text | Specifies Barcode Signature text if it should be searched and matched. |
| match_type | Gets or sets Barcode text Match Type search. It is used only when Text property is set. |
| return_content | Gets or sets flag to grab Barcode image content of signature on document page.
<br/>If this flag is set true, Barcode signature image content will keep raw image data by required format `BarcodeSearchOptions.return_content_type`.
<br/>By default this option is disabled. |
| return_content_type | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
<br/>By default it set to Null. That means to return Barcode image content in original format.
<br/>This image format is specified at `BarcodeSignature.format`
<br/>Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
<br/>If provided format is not supported than Barcode image content in .png format will be returned. |

##### Remarks

**Learn more** |
|
 |
 |

### BarcodeSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/__init__.md

#### __init__

Initializes a new instance of the BarcodeSearchOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the BarcodeSearchOptions class with encode type value.

```python
def __init__(self, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encode_type | groupdocs.signature.domain.BarcodeType | Specifies Barcode encode type. |

#### __init__

Initializes a new instance of the BarcodeSearchOptions class with encode type and text values.

```python
def __init__(self, encode_type, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encode_type | groupdocs.signature.domain.BarcodeType | Specifies Barcode encode type. |
| text | System.String | Set Text of Barcode signature. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/encode_type.md

#### encode_type property

Specifies Encode Type property to search Barcodes.
If this value is not set, search is processed for all supported Barcode Types
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/match_type.md

#### match_type property

Gets or sets Barcode text Match Type search. It is used only when Text property is set.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### return_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/return_content.md

#### return_content property

Gets or sets flag to grab Barcode image content of signature on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format `BarcodeSearchOptions.return_content_type`.
By default this option is disabled.
##### Definition:
```python
@property
def return_content(self):
    ...
@return_content.setter
def return_content(self, value):
    ...
```

### return_content_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/return_content_type.md

#### return_content_type property

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at `BarcodeSignature.format`
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.
##### Definition:
```python
@property
def return_content_type(self):
    ...
@return_content_type.setter
def return_content_type(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesearchoptions/text.md

#### text property

Specifies Barcode Signature text if it should be searched and matched.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### BarcodeSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions.md

#### BarcodeSignOptions class

Represents the Barcode signature options.

**Inheritance:** `BarcodeSignOptions` →
`TextSignOptions` →
`SignOptions`

The BarcodeSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the BarcodeSignOptions class with default values. |
| __init__ | Initializes a new instance of the BarcodeSignOptions class with text. |
| __init__ | Initializes a new instance of the BarcodeSignOptions class with text. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| text | Gets or sets the text of signature. |
| font | Gets or sets the font of signature. |
| fore_color | Gets or sets the Fore color of Barcode bars
<br/>Using of this property could cause problems with verification. Use it carefully. |
| signature_implementation | Gets or sets the type of text signature implementation. |
| text_horizontal_alignment | Horizontal alignment of text inside a signature.
<br/>This feature is supported only for Image and Annotation signature implementations
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| text_vertical_alignment | Vertical alignment of text inside a signature.
<br/>This feature is supported only for Image signature implementation
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| form_text_field_title | Gets or sets the title of text form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField. |
| form_text_field_type | Gets or sets the type of form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField.
<br/>Value by default is AllTextTypes. |
| shape_type | Gets or sets the type of shape to put text.
<br/>This property could be used only with SignatureImplementation = TextStamp.
<br/>Value by default is Rectangle. |
| signature_id | Gets or sets the unique ID of signature. It can be used in signature verification options.
<br/>Property is supported for Pdf documents only. |
| border | Specify border settings |
| background | Gets or sets the signature background settings. |
| native | Gets or sets the native attribute. If it is set document specific signatures could be used.
<br/>Native text watermark for WordProcessing documents is different than regular, for example. |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| encode_type | Gets or sets Barcode type. |
| inner_margins | Gets or sets the space between Barcode elements and result image borders. |
| code_text_alignment | Gets or sets the alignment of text in the result Barcode image.
<br/>Default value is None. |
| return_content | Gets or sets flag to get Barcode image content of a signature which was put on document page.
<br/>If this flag is set true, Barcode signature image content will keep raw image data by required format `BarcodeSignOptions.return_content_type`.
<br/>By default this option is disabled. |
| return_content_type | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
<br/>By default it set to Null. That means to return Barcode image content in original format.
<br/>This image format is specified at `BarcodeSignature.format`
<br/>Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
<br/>If provided format is not supported than Barcode image content in .png format will be returned. |

##### Remarks

**Learn more** |
|
 |
 |

### BarcodeSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/__init__.md

#### __init__

Initializes a new instance of the BarcodeSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the BarcodeSignOptions class with text.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Barcode text |

#### __init__

Initializes a new instance of the BarcodeSignOptions class with text.

```python
def __init__(self, text, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Barcode text |
| encode_type | groupdocs.signature.domain.BarcodeType | Barcode encode type see `BarcodeType` |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/appearance.md

#### appearance property

Additional signature appearance.

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/background.md

#### background property

Gets or sets the signature background settings.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/border.md

#### border property

Specify border settings

### code_text_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/code_text_alignment.md

#### code_text_alignment property

Gets or sets the alignment of text in the result Barcode image.
Default value is None.
##### Definition:
```python
@property
def code_text_alignment(self):
    ...
@code_text_alignment.setter
def code_text_alignment(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/encode_type.md

#### encode_type property

Gets or sets Barcode type.
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/extensions.md

#### extensions property

Signature Extensions.

### font property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/font.md

#### font property

Gets or sets the font of signature.

### fore_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/fore_color.md

#### fore_color property

Gets or sets the Fore color of Barcode bars
Using of this property could cause problems with verification. Use it carefully.
##### Definition:
```python
@property
def fore_color(self):
    ...
@fore_color.setter
def fore_color(self, value):
    ...
```

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.

### inner_margins property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/inner_margins.md

#### inner_margins property

Gets or sets the space between Barcode elements and result image borders.
##### Definition:
```python
@property
def inner_margins(self):
    ...
@inner_margins.setter
def inner_margins(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if horizontal alignment is not specified).

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

### native property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/native.md

#### native property

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### return_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/return_content.md

#### return_content property

Gets or sets flag to get Barcode image content of a signature which was put on document page.
If this flag is set true, Barcode signature image content will keep raw image data by required format `BarcodeSignOptions.return_content_type`.
By default this option is disabled.
##### Definition:
```python
@property
def return_content(self):
    ...
@return_content.setter
def return_content(self, value):
    ...
```

### return_content_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/return_content_type.md

#### return_content_type property

Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
By default it set to Null. That means to return Barcode image content in original format.
This image format is specified at `BarcodeSignature.format`
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than Barcode image content in .png format will be returned.
##### Definition:
```python
@property
def return_content_type(self):
    ...
@return_content_type.setter
def return_content_type(self, value):
    ...
```

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

### shape_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/shape_type.md

#### shape_type property

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/signature_id.md

#### signature_id property

Gets or sets the unique ID of signature. It can be used in signature verification options.
Property is supported for Pdf documents only.

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/signature_implementation.md

#### signature_implementation property

Gets or sets the type of text signature implementation.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/text.md

#### text property

Gets or sets the text of signature.

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/text_horizontal_alignment.md

#### text_horizontal_alignment property

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see `TextSignatureImplementation` SignatureImplementation property).

### text_vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/text_vertical_alignment.md

#### text_vertical_alignment property

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see `TextSignatureImplementation` SignatureImplementation property).

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if vertical alignment is not specified).

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodesignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### BarcodeVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions.md

#### BarcodeVerifyOptions class

Represents the Barcode verify options.

**Inheritance:** `BarcodeVerifyOptions` →
`TextVerifyOptions` →
`VerifyOptions`

The BarcodeVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates default Verification Option for Barcode Signature. |
| __init__ | Creates default Verification Option with verification text |
| __init__ | Creates default Verification Option with Barcode Type verification |
| __init__ | Creates default Verification Option with Barcode Type verification and text |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| text | Specify Signature Text if it should be verified. |
| match_type | Gets or sets Text Match Type verification. |
| signature_implementation | Type of Signature to be verified. |
| form_text_field_title | Gets or sets the title of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| form_text_field_type | Gets or sets the type of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| signature_id | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |
| encode_type | Gets or sets Barcode Type verification. |

##### Remarks

**Learn more** |
|
 |
 |

### BarcodeVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/__init__.md

#### __init__

Creates default Verification Option for Barcode Signature.

```python
def __init__(self):
    ...
```

#### __init__

Creates default Verification Option with verification text

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Barcode text to verify |

#### __init__

Creates default Verification Option with Barcode Type verification

```python
def __init__(self, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encode_type | groupdocs.signature.domain.BarcodeType | Barcode Type verification |

#### __init__

Creates default Verification Option with Barcode Type verification and text

```python
def __init__(self, text, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Barcode text to verify |
| encode_type | groupdocs.signature.domain.BarcodeType | Barcode Type verification |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/encode_type.md

#### encode_type property

Gets or sets Barcode Type verification.
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of form field to verify it.
If this property set text will be found only in text form fields.

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to verify it.
If this property set text will be found only in text form fields.

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/match_type.md

#### match_type property

Gets or sets Text Match Type verification.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/signature_id.md

#### signature_id property

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/signature_implementation.md

#### signature_implementation property

Type of Signature to be verified.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/barcodeverifyoptions/text.md

#### text property

Specify Signature Text if it should be verified.

### BitmapCompression enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bitmapcompression.md

#### BitmapCompression enumeration

Specifies different bitmap compression methods.

The BitmapCompression type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RGB | No compression. |
| RLE8 | RLE 8-bit/pixel compression. Can be used only with 8-bit/pixel bitmaps. |
| RLE4 | RLE 4-bit/pixel compression. Can be used only with 4-bit/pixel bitmaps. |
| BITFIELDS | Bit fields. Can be used only with 16 and 32-bit/pixel bitmaps. |
| JPEG | JPEG compression. The bitmap contains a JPEG image. |
| PNG | PNG compression. The bitmap contains a PNG image. |

### BmpSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions.md

#### BmpSaveOptions class

Bmp Save options for image documents.

**Inheritance:** `BmpSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The BmpSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates BmpSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| bits_per_pixel | Gets or sets the image bits per pixel count. |
| compression | Gets or sets the compression. See `BitmapCompression`. |
| horizontal_resolution | Gets or sets the horizontal resolution. Note due to the rounding the resulting
<br/>resolution may slightly differ from the passed. |
| vertical_resolution | Gets or sets the vertical resolution. Note due to the rounding the resulting
<br/>resolution may slightly differ from the passed. |

### BmpSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/__init__.md

#### __init__

Creates BmpSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### bits_per_pixel property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/bits_per_pixel.md

#### bits_per_pixel property

Gets or sets the image bits per pixel count.
##### Definition:
```python
@property
def bits_per_pixel(self):
    ...
@bits_per_pixel.setter
def bits_per_pixel(self, value):
    ...
```

### compression property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/compression.md

#### compression property

Gets or sets the compression. See `BitmapCompression`.
##### Definition:
```python
@property
def compression(self):
    ...
@compression.setter
def compression(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### horizontal_resolution property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/horizontal_resolution.md

#### horizontal_resolution property

Gets or sets the horizontal resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.
##### Definition:
```python
@property
def horizontal_resolution(self):
    ...
@horizontal_resolution.setter
def horizontal_resolution(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### vertical_resolution property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/bmpsaveoptions/vertical_resolution.md

#### vertical_resolution property

Gets or sets the vertical resolution. Note due to the rounding the resulting
resolution may slightly differ from the passed.
##### Definition:
```python
@property
def vertical_resolution(self):
    ...
@vertical_resolution.setter
def vertical_resolution(self, value):
    ...
```

### CertificateSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions.md

#### CertificateSearchOptions class

Represents search options for Certificate metadata signatures.

**Inheritance:** `CertificateSearchOptions` →
`SearchOptions`

The CertificateSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextSearchOptions class with default values. |
| __init__ | Initializes a new instance of the TextSearchOptions class with text value. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| text | Specifies certificate property text to match on searching. |
| match_type | Gets or sets text match type search. |

##### Remarks

**Learn more** |
|
 |

### CertificateSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/__init__.md

#### __init__

Initializes a new instance of the TextSearchOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the TextSearchOptions class with text value.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Set Text of Text signature. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/match_type.md

#### match_type property

Gets or sets text match type search.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificatesearchoptions/text.md

#### text property

Specifies certificate property text to match on searching.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### CertificateVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions.md

#### CertificateVerifyOptions class

Keeps options to verify certificate documents.

**Inheritance:** `CertificateVerifyOptions` →
`VerifyOptions`

The CertificateVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextVerifyOptions with default values. |
| __init__ | Initializes a new instance of the CertificateVerifyOptions with subject to verify. |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| issuer | Specify Certificate Issuer if it should be verified. |
| serial_number | Specify Certificate Serial Number if it should be verified. |
| subject | Specify Certificate subject if it should be verified. |
| thumbprint | Specify Certificate Thumbprint if it should be verified. |
| match_type | Gets or sets Text Match Type verification. |
| expired | Indicates if certificate is expired date due validation result.
<br/>Property is read-only. |
| perform_chain_validation | Get or set if verification process should provide X.509 chain validation using basic validation policy.
<br/>By default this value is true. |

##### Remarks

**Learn more** |
|
 |

### CertificateVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/__init__.md

#### __init__

Initializes a new instance of the TextVerifyOptions with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the CertificateVerifyOptions with subject to verify.

```python
def __init__(self, subject):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| subject | System.String | Subject to be verified |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### expired property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/expired.md

#### expired property

Indicates if certificate is expired date due validation result.
Property is read-only.
##### Definition:
```python
@property
def expired(self):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### issuer property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/issuer.md

#### issuer property

Specify Certificate Issuer if it should be verified.
##### Definition:
```python
@property
def issuer(self):
    ...
@issuer.setter
def issuer(self, value):
    ...
```

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/match_type.md

#### match_type property

Gets or sets Text Match Type verification.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### perform_chain_validation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/perform_chain_validation.md

#### perform_chain_validation property

Get or set if verification process should provide X.509 chain validation using basic validation policy.
By default this value is true.
##### Definition:
```python
@property
def perform_chain_validation(self):
    ...
@perform_chain_validation.setter
def perform_chain_validation(self, value):
    ...
```

### serial_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/serial_number.md

#### serial_number property

Specify Certificate Serial Number if it should be verified.
##### Definition:
```python
@property
def serial_number(self):
    ...
@serial_number.setter
def serial_number(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/subject.md

#### subject property

Specify Certificate subject if it should be verified.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### thumbprint property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/certificateverifyoptions/thumbprint.md

#### thumbprint property

Specify Certificate Thumbprint if it should be verified.
##### Definition:
```python
@property
def thumbprint(self):
    ...
@thumbprint.setter
def thumbprint(self, value):
    ...
```

### DicomSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions.md

#### DicomSaveOptions class

Save options for DICOM image documents.

**Inheritance:** `DicomSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The DicomSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates DicomSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| xmp_entries | XMP data for DICOM. Use it for setting image metadata. |

### DicomSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/__init__.md

#### __init__

Creates DicomSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### xmp_entries property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomsaveoptions/xmp_entries.md

#### xmp_entries property

XMP data for DICOM. Use it for setting image metadata.
##### Definition:
```python
@property
def xmp_entries(self):
    ...
@xmp_entries.setter
def xmp_entries(self, value):
    ...
```

### DicomXmpEntry class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomxmpentry.md

#### DicomXmpEntry class

Entry of XMP data for DICOM images (.dcm).

The DicomXmpEntry type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Xmp entry for DICOM image. |

##### Properties
| Property | Description |
| :- | :- |
| type | Entry type. |
| value | Entry value. |

### DicomXmpEntry constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomxmpentry/__init__.md

#### __init__

Creates Xmp entry for DICOM image.

```python
def __init__(self, type, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| type | groupdocs.signature.options.DicomXmpType | Entry type |
| value | System.String | Entry value |

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomxmpentry/type.md

#### type property

Entry type.
##### Definition:
```python
@property
def type(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomxmpentry/value.md

#### value property

Entry value.
##### Definition:
```python
@property
def value(self):
    ...
```

### DicomXmpType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/dicomxmptype.md

#### DicomXmpType enumeration

Supported types of XMP data for DICOM images (.dcm).

The DicomXmpType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EQUIPMENT_INSTITUTION | Institution of equipment. |
| EQUIPMENT_MANUFACTURER | Manufacturer of equipment. |
| PATIENT_BIRTH_DATE | Patient's birthday. |
| PATIENT_ID | Patient's Id. |
| PATIENT_NAME | Patient's name. |
| PATIENT_SEX | Patient's sex. |
| SERIES_DATE_TIME | Series date and time. |
| SERIES_DESCRIPTION | Series description. |
| SERIES_MODALITY | Series modality. |
| SERIES_NUMBER | Series number. |
| STUDY_DATE_TIME | Study date and time. |
| STUDY_DESCRIPTION | Study description. |
| STUDY_ID | Study Id. |
| STUDY_PHYSICIAN | Study physician. |

### DigitalSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions.md

#### DigitalSearchOptions class

Represents search options for Digital signatures.

**Inheritance:** `DigitalSearchOptions` →
`SearchOptions`

The DigitalSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the DigitalSearchOptions class with default values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| comments | Comments of Digital signature to search. |
| sign_date_time_from | Date and time range of Digital signature to search. Nullable value will be ignored. |
| sign_date_time_to | Date and time range of Digital signature to search. Nullable value will be ignored. |
| subject_name | For non empty values specifies distinguished subject name of the certificate to search. |
| issuer_name | For non empty values specifies distinguished name of the certificate issuer to search. |

##### Remarks

**Learn more** |
|
 |
 |

### DigitalSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/__init__.md

#### __init__

Initializes a new instance of the DigitalSearchOptions class with default values.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### comments property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/comments.md

#### comments property

Comments of Digital signature to search.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### issuer_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/issuer_name.md

#### issuer_name property

For non empty values specifies distinguished name of the certificate issuer to search.
##### Definition:
```python
@property
def issuer_name(self):
    ...
@issuer_name.setter
def issuer_name(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### sign_date_time_from property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/sign_date_time_from.md

#### sign_date_time_from property

Date and time range of Digital signature to search. Nullable value will be ignored.
##### Definition:
```python
@property
def sign_date_time_from(self):
    ...
@sign_date_time_from.setter
def sign_date_time_from(self, value):
    ...
```

### sign_date_time_to property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/sign_date_time_to.md

#### sign_date_time_to property

Date and time range of Digital signature to search. Nullable value will be ignored.
##### Definition:
```python
@property
def sign_date_time_to(self):
    ...
@sign_date_time_to.setter
def sign_date_time_to(self, value):
    ...
```

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### subject_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsearchoptions/subject_name.md

#### subject_name property

For non empty values specifies distinguished subject name of the certificate to search.
##### Definition:
```python
@property
def subject_name(self):
    ...
@subject_name.setter
def subject_name(self, value):
    ...
```

### DigitalSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions.md

#### DigitalSignOptions class

Represents the Digital signature options.

**Inheritance:** `DigitalSignOptions` →
`ImageSignOptions` →
`SignOptions`

The DigitalSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the DigitalSignOptions class with default values. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate file. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate stream. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate file and image file. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate file and image stream. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate stream and image file. |
| __init__ | Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| image_file_path | Gets or sets the signature image file path.
<br/>This property is used only if ImageStream is not specified. |
| image_stream | Gets or sets the signature image stream.
<br/>If this property is specified it is always used instead ImageFilePath. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| rectangle | Rectangle of area to put the image on document. |
| border | Specify border settings |
| reason | Gets or sets the reason of signature. |
| contact | Gets or sets the signature contact. |
| location | Gets or sets the signature location. |
| password | Gets or sets the password of digital certificate. |
| signature | Gets or sets properties of document digital signature.
<br/>For signing Pdf documents it is possible to set advanced properties by using instance of `PdfDigitalSignature` |
| certificate_file_path | Gets or sets the digital certificate file path.
<br/>This property is used only if CertificateStream is not specified. |
| certificate_stream | Gets or sets digital certificate stream.
<br/>If this property is specified it is always used instead CertificateFilePath. |
| visible | Gets or sets the visibility of signature. |
| use_ltv | Gets/sets ltv(Long Term Validation) validation flag. |
| custom_sign_hash | Gets or sets a custom hash signing function, allowing users to implement their own digital signing logic.
<br/>This enables signing with external certificates and supports different hash algorithms. |
| x_ad_es_type | XAdES type `DigitalSignOptions.x_ad_es_type`. Default value is None (XAdES is off).
<br/>At this moment XAdES signature type is supported only for Spreadsheet documents. |

##### Methods
| Method | Description |
| :- | :- |
| from_base64 | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |

##### Remarks

**Learn more** |
|
 |
 |

### DigitalSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/__init__.md

#### __init__

Initializes a new instance of the DigitalSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate file.

```python
def __init__(self, certificate_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_file_path | System.String | Digital certificate file path |

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate stream.

```python
def __init__(self, certificate_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_stream | io.RawIOBase | Digital Certificate stream |

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate file and image file.

```python
def __init__(self, certificate_file_path, image_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_file_path | System.String | Digital certificate file path |
| image_file_path | System.String | Signature Appearance image file path |

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate file and image stream.

```python
def __init__(self, certificate_file_path, appearence_image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_file_path | System.String | Digital certificate file path |
| appearence_image_stream | io.RawIOBase | Signature Appearance image stream |

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate stream and image file.

```python
def __init__(self, certificate_stream, image_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_stream | io.RawIOBase | Digital Certificate stream |
| image_file_path | System.String | Signature Appearance image file path |

#### __init__

Initializes a new instance of the DigitalSignOptions class with certificate stream and image stream.

```python
def __init__(self, certificate_stream, appearence_image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_stream | io.RawIOBase | Digital Certificate stream |
| appearence_image_stream | io.RawIOBase | Signature Appearance image stream |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/appearance.md

#### appearance property

Additional signature appearance.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/border.md

#### border property

Specify border settings

### certificate_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/certificate_file_path.md

#### certificate_file_path property

Gets or sets the digital certificate file path.
This property is used only if CertificateStream is not specified.
##### Definition:
```python
@property
def certificate_file_path(self):
    ...
@certificate_file_path.setter
def certificate_file_path(self, value):
    ...
```

### certificate_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/certificate_stream.md

#### certificate_stream property

Gets or sets digital certificate stream.
If this property is specified it is always used instead CertificateFilePath.
##### Definition:
```python
@property
def certificate_stream(self):
    ...
@certificate_stream.setter
def certificate_stream(self, value):
    ...
```

### contact property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/contact.md

#### contact property

Gets or sets the signature contact.
##### Definition:
```python
@property
def contact(self):
    ...
@contact.setter
def contact(self, value):
    ...
```

### custom_sign_hash property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/custom_sign_hash.md

#### custom_sign_hash property

Gets or sets a custom hash signing function, allowing users to implement their own digital signing logic.
This enables signing with external certificates and supports different hash algorithms.
##### Definition:
```python
@property
def custom_sign_hash(self):
    ...
@custom_sign_hash.setter
def custom_sign_hash(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/extensions.md

#### extensions property

Signature Extensions.

### from_base64 method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/from_base64.md

#### from_base64

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

##### Returns

```python
def from_base64(self, base_64_content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| base_64_content | System.String | Image content in Base64 string format |

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType).

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.

### image_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/image_file_path.md

#### image_file_path property

Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.

### image_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/image_stream.md

#### image_stream property

Gets or sets the signature image stream.
If this property is specified it is always used instead ImageFilePath.

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if horizontal alignment is not specified).

### location property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/location.md

#### location property

Gets or sets the signature location.
##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/password.md

#### password property

Gets or sets the password of digital certificate.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### reason property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/reason.md

#### reason property

Gets or sets the reason of signature.
##### Definition:
```python
@property
def reason(self):
    ...
@reason.setter
def reason(self, value):
    ...
```

### rectangle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/rectangle.md

#### rectangle property

Rectangle of area to put the image on document.

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

### signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/signature.md

#### signature property

Gets or sets properties of document digital signature.
For signing Pdf documents it is possible to set advanced properties by using instance of `PdfDigitalSignature`
##### Definition:
```python
@property
def signature(self):
    ...
@signature.setter
def signature(self, value):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if vertical alignment is not specified).

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### use_ltv property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/use_ltv.md

#### use_ltv property

Gets/sets ltv(Long Term Validation) validation flag.
##### Definition:
```python
@property
def use_ltv(self):
    ...
@use_ltv.setter
def use_ltv(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.

### visible property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/visible.md

#### visible property

Gets or sets the visibility of signature.
##### Definition:
```python
@property
def visible(self):
    ...
@visible.setter
def visible(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters `MeasureType` SizeMeasureType).

### x_ad_es_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/x_ad_es_type.md

#### x_ad_es_type property

XAdES type `DigitalSignOptions.x_ad_es_type`. Default value is None (XAdES is off).
At this moment XAdES signature type is supported only for Spreadsheet documents.
##### Definition:
```python
@property
def x_ad_es_type(self):
    ...
@x_ad_es_type.setter
def x_ad_es_type(self, value):
    ...
```

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalsignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### DigitalVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions.md

#### DigitalVerifyOptions class

Keeps options to verify document Digital signature.

**Inheritance:** `DigitalVerifyOptions` →
`VerifyOptions`

The DigitalVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates Digital Verification Option with default values. |
| __init__ | Creates Digital Verification Option with given digital certificate file path. |
| __init__ | Creates Digital Verification Option with given certificate stream. |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| certificate | Get X509Certificate2 Certificate from Certificate FilePath or Stream. |
| password | Password of Digital Certificate if required. |
| certificate_file_path | File path of Digital Certificate. |
| certificate_stream | Stream of Digital Certificate. |
| comments | Comments of Digital Signature to validate. |
| sign_date_time_from | Date and time range of Digital Signature to validate. Nullable value will be ignored. |
| sign_date_time_to | Date and time range of Digital Signature to validate. Nullable value will be ignored. |
| reason | Reason of Digital Signature to validate. |
| contact | Signature Contact to validate. |
| location | Signature Location to validate. |
| subject_name | Subject distinguished name of the certificate to validate. Value is case sensitive.
<br/>If this property is set verification will check if Signature subject name contains or equals passed value |
| issuer_name | Issuer name of the certificate to validate. Value is case sensitive.
<br/>If this property is set verification will check if Signature's issuer name contains or equals passed value |

##### Remarks

**Learn more** |
|
 |
 |

### DigitalVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/__init__.md

#### __init__

Creates Digital Verification Option with default values.

```python
def __init__(self):
    ...
```

#### __init__

Creates Digital Verification Option with given digital certificate file path.

```python
def __init__(self, certificate_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_file_path | System.String | File path to digital certificate. |

#### __init__

Creates Digital Verification Option with given certificate stream.

```python
def __init__(self, certificate_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| certificate_stream | io.RawIOBase | Certificate's stream. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### certificate property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/certificate.md

#### certificate property

Get X509Certificate2 Certificate from Certificate FilePath or Stream.
##### Definition:
```python
@property
def certificate(self):
    ...
```

### certificate_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/certificate_file_path.md

#### certificate_file_path property

File path of Digital Certificate.
##### Definition:
```python
@property
def certificate_file_path(self):
    ...
@certificate_file_path.setter
def certificate_file_path(self, value):
    ...
```

### certificate_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/certificate_stream.md

#### certificate_stream property

Stream of Digital Certificate.
##### Definition:
```python
@property
def certificate_stream(self):
    ...
@certificate_stream.setter
def certificate_stream(self, value):
    ...
```

### comments property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/comments.md

#### comments property

Comments of Digital Signature to validate.
##### Definition:
```python
@property
def comments(self):
    ...
@comments.setter
def comments(self, value):
    ...
```

### contact property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/contact.md

#### contact property

Signature Contact to validate.
##### Definition:
```python
@property
def contact(self):
    ...
@contact.setter
def contact(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### issuer_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/issuer_name.md

#### issuer_name property

Issuer name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature's issuer name contains or equals passed value
##### Definition:
```python
@property
def issuer_name(self):
    ...
@issuer_name.setter
def issuer_name(self, value):
    ...
```

### location property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/location.md

#### location property

Signature Location to validate.
##### Definition:
```python
@property
def location(self):
    ...
@location.setter
def location(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/password.md

#### password property

Password of Digital Certificate if required.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### reason property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/reason.md

#### reason property

Reason of Digital Signature to validate.
##### Definition:
```python
@property
def reason(self):
    ...
@reason.setter
def reason(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### sign_date_time_from property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/sign_date_time_from.md

#### sign_date_time_from property

Date and time range of Digital Signature to validate. Nullable value will be ignored.
##### Definition:
```python
@property
def sign_date_time_from(self):
    ...
@sign_date_time_from.setter
def sign_date_time_from(self, value):
    ...
```

### sign_date_time_to property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/sign_date_time_to.md

#### sign_date_time_to property

Date and time range of Digital Signature to validate. Nullable value will be ignored.
##### Definition:
```python
@property
def sign_date_time_to(self):
    ...
@sign_date_time_to.setter
def sign_date_time_to(self, value):
    ...
```

### subject_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/digitalverifyoptions/subject_name.md

#### subject_name property

Subject distinguished name of the certificate to validate. Value is case sensitive.
If this property is set verification will check if Signature subject name contains or equals passed value
##### Definition:
```python
@property
def subject_name(self):
    ...
@subject_name.setter
def subject_name(self, value):
    ...
```

### ExportImageSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions.md

#### ExportImageSaveOptions class

Save options for exporting documents to image.

**Inheritance:** `ExportImageSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The ExportImageSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of ExportAsImageSaveOptions class with default values. |
| __init__ | Initializes a new instance of ExportAsImageSaveOptions class with specified file format. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| page_number | Gets or sets document page number for export.
<br/>Minimal value is 1. |
| export_all_pages | Flag to export each page. |
| pages_setup | Options to specify pages to be signed. |
| page_columns | Gets or sets number of columns for exported images.
<br/>Use this property if you need put images in a row. |
| border | Gets or sets the image border settings. By default this value is not set. |
| tiff_multipage | Put document pages on different frames in Tiff image. |

### ExportImageSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/__init__.md

#### __init__

Initializes a new instance of ExportAsImageSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of ExportAsImageSaveOptions class with specified file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.ImageSaveFileFormat | Output image file format. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/border.md

#### border property

Gets or sets the image border settings. By default this value is not set.
##### Definition:
```python
@property
def border(self):
    ...
@border.setter
def border(self, value):
    ...
```

### export_all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/export_all_pages.md

#### export_all_pages property

Flag to export each page.
##### Definition:
```python
@property
def export_all_pages(self):
    ...
@export_all_pages.setter
def export_all_pages(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### page_columns property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/page_columns.md

#### page_columns property

Gets or sets number of columns for exported images.
Use this property if you need put images in a row.
##### Definition:
```python
@property
def page_columns(self):
    ...
@page_columns.setter
def page_columns(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/page_number.md

#### page_number property

Gets or sets document page number for export.
Minimal value is 1.
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.
##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### tiff_multipage property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/tiff_multipage.md

#### tiff_multipage property

Put document pages on different frames in Tiff image.
##### Definition:
```python
@property
def tiff_multipage(self):
    ...
@tiff_multipage.setter
def tiff_multipage(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/exportimagesaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### FormFieldSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions.md

#### FormFieldSearchOptions class

Represents search options for Form-field signatures.

**Inheritance:** `FormFieldSearchOptions` →
`SearchOptions`

The FormFieldSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the FormFieldSearchOptions class with default values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| type | Specifies type of form field signature if it should be searched. Default value is null. |
| name | Specifies regular expression pattern of form field signature name if it should be searched.
<br/>You can use it simple as "text" or regular expression like "abc\d+". Default value is empty string. |
| value | Specifies value of form field signature if it should be searched. Default value is null. |

##### Remarks

**Learn more** |
|
 |
 |

### FormFieldSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/__init__.md

#### __init__

Initializes a new instance of the FormFieldSearchOptions class with default values.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/name.md

#### name property

Specifies regular expression pattern of form field signature name if it should be searched.
You can use it simple as "text" or regular expression like "abc\d+". Default value is empty string.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/type.md

#### type property

Specifies type of form field signature if it should be searched. Default value is null.
##### Definition:
```python
@property
def type(self):
    ...
@type.setter
def type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsearchoptions/value.md

#### value property

Specifies value of form field signature if it should be searched. Default value is null.
##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### FormFieldSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions.md

#### FormFieldSignOptions class

Represents class of the FormField signature options for Pdf documents.

**Inheritance:** `FormFieldSignOptions` →
`TextSignOptions` →
`SignOptions`

The FormFieldSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the PdfFormFieldSignOptions class with default values. |
| __init__ | Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| text | Gets or sets the text of signature. |
| font | Gets or sets the font of signature. |
| fore_color | Gets or sets the fore color of signature. |
| signature_implementation | Gets or sets the type of text signature implementation. |
| text_horizontal_alignment | Horizontal alignment of text inside a signature.
<br/>This feature is supported only for Image and Annotation signature implementations
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| text_vertical_alignment | Vertical alignment of text inside a signature.
<br/>This feature is supported only for Image signature implementation
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| form_text_field_title | Gets or sets the title of text form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField. |
| form_text_field_type | Gets or sets the type of form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField.
<br/>Value by default is AllTextTypes. |
| shape_type | Gets or sets the type of shape to put text.
<br/>This property could be used only with SignatureImplementation = TextStamp.
<br/>Value by default is Rectangle. |
| signature_id | Gets or sets the unique ID of signature. It can be used in signature verification options.
<br/>Property is supported for Pdf documents only. |
| border | Specify border settings |
| background | Gets or sets the signature background settings. |
| native | Gets or sets the native attribute. If it is set document specific signatures could be used.
<br/>Native text watermark for WordProcessing documents is different than regular, for example. |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| signature | Gets or sets the FormField of signature. |

##### Remarks

**Learn more** |
|
 |
 |

### FormFieldSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/__init__.md

#### __init__

Initializes a new instance of the PdfFormFieldSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the PdfFormFieldSignOptions class with FormField signature.

```python
def __init__(self, signature):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature | groupdocs.signature.domain.FormFieldSignature | Form Field signature object |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/appearance.md

#### appearance property

Additional signature appearance.

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/background.md

#### background property

Gets or sets the signature background settings.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/border.md

#### border property

Specify border settings

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/extensions.md

#### extensions property

Signature Extensions.

### font property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/font.md

#### font property

Gets or sets the font of signature.

### fore_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/fore_color.md

#### fore_color property

Gets or sets the fore color of signature.

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if horizontal alignment is not specified).

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

### native property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/native.md

#### native property

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

### shape_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/shape_type.md

#### shape_type property

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.

### signature property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/signature.md

#### signature property

Gets or sets the FormField of signature.
##### Definition:
```python
@property
def signature(self):
    ...
@signature.setter
def signature(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/signature_id.md

#### signature_id property

Gets or sets the unique ID of signature. It can be used in signature verification options.
Property is supported for Pdf documents only.

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/signature_implementation.md

#### signature_implementation property

Gets or sets the type of text signature implementation.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/text.md

#### text property

Gets or sets the text of signature.

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/text_horizontal_alignment.md

#### text_horizontal_alignment property

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see `TextSignatureImplementation` SignatureImplementation property).

### text_vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/text_vertical_alignment.md

#### text_vertical_alignment property

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see `TextSignatureImplementation` SignatureImplementation property).

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if vertical alignment is not specified).

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/formfieldsignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### GifSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions.md

#### GifSaveOptions class

Gif format save options for image documents.

**Inheritance:** `GifSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The GifSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates GifSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| background_color_index | Gets or sets the GIF background color index. |
| color_resolution | Gets or sets the GIF color resolution. |
| do_palette_correction | Gets or sets a value indicating whether palette correction is applied. |
| has_trailer | Gets or sets a value indicating whether GIF has trailer. |
| interlaced | True if image should be interlaced. |
| is_palette_sorted | Gets or sets a value indicating whether palette entries are sorted. |
| pixel_aspect_ratio | Gets or sets the GIF pixel aspect ratio. |

### GifSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/__init__.md

#### __init__

Creates GifSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### background_color_index property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/background_color_index.md

#### background_color_index property

Gets or sets the GIF background color index.
##### Definition:
```python
@property
def background_color_index(self):
    ...
@background_color_index.setter
def background_color_index(self, value):
    ...
```

### color_resolution property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/color_resolution.md

#### color_resolution property

Gets or sets the GIF color resolution.

##### Remarks

Color Resolution - Number of bits per primary color available to the original
image, minus 1. This value represents the size of the entire palette from
which the colors in the graphic were selected, not the number of colors actually
used in the graphic.  For example, if the value in this field is 3, then
the palette of the original image had 4 bits per primary color available
to create the image. This value should be set to indicate the richness of
the original palette, even if not every color from the whole palette is available
on the source machine.
##### Definition:
```python
@property
def color_resolution(self):
    ...
@color_resolution.setter
def color_resolution(self, value):
    ...
```

### do_palette_correction property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/do_palette_correction.md

#### do_palette_correction property

Gets or sets a value indicating whether palette correction is applied.

##### Remarks

Palette correction means that whenever image is exported to GIF the source
image colors will be analyzed in order to build the best matching palette
(in case image Palette does not exist or not specified in the options).
The analyze process takes some time however the output image will have the
best matching color palette and result is visually better.
##### Definition:
```python
@property
def do_palette_correction(self):
    ...
@do_palette_correction.setter
def do_palette_correction(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### has_trailer property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/has_trailer.md

#### has_trailer property

Gets or sets a value indicating whether GIF has trailer.
##### Definition:
```python
@property
def has_trailer(self):
    ...
@has_trailer.setter
def has_trailer(self, value):
    ...
```

### interlaced property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/interlaced.md

#### interlaced property

True if image should be interlaced.
##### Definition:
```python
@property
def interlaced(self):
    ...
@interlaced.setter
def interlaced(self, value):
    ...
```

### is_palette_sorted property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/is_palette_sorted.md

#### is_palette_sorted property

Gets or sets a value indicating whether palette entries are sorted.
##### Definition:
```python
@property
def is_palette_sorted(self):
    ...
@is_palette_sorted.setter
def is_palette_sorted(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### pixel_aspect_ratio property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/pixel_aspect_ratio.md

#### pixel_aspect_ratio property

Gets or sets the GIF pixel aspect ratio.

##### Remarks

Pixel Aspect Ratio - Factor used to compute an approximation of the aspect
ratio of the pixel in the original image. If the value of the field is not
0, this approximation of the aspect ratio is computed based on the formula:
Aspect Ratio = (Pixel Aspect Ratio + 15) / 64 The Pixel Aspect Ratio is defined
to be the quotient of the pixel's width over its height. The value range
in this field allows specification of the widest pixel of 4:1 to the tallest
pixel of 1:4 in increments of 1/64th.  Values : 0 - No aspect ratio information
is given.  1..255 - Value used in the computation.
##### Definition:
```python
@property
def pixel_aspect_ratio(self):
    ...
@pixel_aspect_ratio.setter
def pixel_aspect_ratio(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/gifsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### ICustomSignHash class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/icustomsignhash.md

#### ICustomSignHash class

Defines a contract for custom hash signing operations.

The ICustomSignHash type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| custom_sign_hash | Signs the given hash using a custom signing implementation. |

### custom_sign_hash method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/icustomsignhash/custom_sign_hash.md

#### custom_sign_hash

Signs the given hash using a custom signing implementation.

##### Returns

The signed hash as a byte array.

```python
def custom_sign_hash(self, signable_hash, hash_algorithm, signature_context):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signable_hash | bytes | The hash value to be signed. |
| hash_algorithm | groupdocs.signature.domain.HashAlgorithm | The hash algorithm used to generate the hash. |
| signature_context | groupdocs.signature.options.SignatureContext | The context providing additional signature-related options. |

### ImageDigitalSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions.md

#### ImageDigitalSignOptions class

Represents options to embed Aspose.Imaging digital (steganography) signature into raster images.

**Inheritance:** `ImageDigitalSignOptions` →
`SignOptions`

The ImageDigitalSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ImageDigitalSignOptions class with default values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| password | Password used for embedding the digital signature. |

### ImageDigitalSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/__init__.md

#### __init__

Initializes a new instance of the ImageDigitalSignOptions class with default values.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/appearance.md

#### appearance property

Additional signature appearance.

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/extensions.md

#### extensions property

Signature Extensions.

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/password.md

#### password property

Password used for embedding the digital signature.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalsignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### ImageDigitalVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions.md

#### ImageDigitalVerifyOptions class

Keeps options to verify digital signatures in raster images.

**Inheritance:** `ImageDigitalVerifyOptions` →
`VerifyOptions`

The ImageDigitalVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ImageDigitalVerifyOptions class for verifying digital (steganography) signatures in raster images. |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| password | Password that was used to embed the signature. |
| detection_threshold_percent | Detection threshold percentage for partial extraction (0-100). Default is 75. |
| use_full_data_extraction | When true, performs full data extraction (AnalyzePercentageDigitalSignature) for maximum accuracy. |
| detected_probability | Stores the probability returned by AnalyzePercentageDigitalSignature (0-100). |

### ImageDigitalVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/__init__.md

#### __init__

Initializes a new instance of the ImageDigitalVerifyOptions class for verifying digital (steganography) signatures in raster images.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### detected_probability property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/detected_probability.md

#### detected_probability property

Stores the probability returned by AnalyzePercentageDigitalSignature (0-100).
##### Definition:
```python
@property
def detected_probability(self):
    ...
```

### detection_threshold_percent property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/detection_threshold_percent.md

#### detection_threshold_percent property

Detection threshold percentage for partial extraction (0-100). Default is 75.
##### Definition:
```python
@property
def detection_threshold_percent(self):
    ...
@detection_threshold_percent.setter
def detection_threshold_percent(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/password.md

#### password property

Password that was used to embed the signature.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### use_full_data_extraction property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagedigitalverifyoptions/use_full_data_extraction.md

#### use_full_data_extraction property

When true, performs full data extraction (AnalyzePercentageDigitalSignature) for maximum accuracy.
##### Definition:
```python
@property
def use_full_data_extraction(self):
    ...
@use_full_data_extraction.setter
def use_full_data_extraction(self, value):
    ...
```

### ImageSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions.md

#### ImageSaveOptions class

Save options for image documents.

**Inheritance:** `ImageSaveOptions` →
`SaveOptions`

The ImageSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of ImagesSaveOptions class with default values. |
| __init__ | Initializes a new instance of ImagesSaveOptions class with overwrite flag. |
| __init__ | Initializes a new instance of ImagesSaveOptions class with specified output type and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |

### ImageSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/__init__.md

#### __init__

Initializes a new instance of ImagesSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of ImagesSaveOptions class with overwrite flag.

```python
def __init__(self, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

#### __init__

Initializes a new instance of ImagesSaveOptions class with specified output type and overwrite flag.

```python
def __init__(self, file_format, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.ImageSaveFileFormat | Output file type `ImageSaveFileFormat`. |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### ImageSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions.md

#### ImageSearchOptions class

Represents search options for Image signatures.

**Inheritance:** `ImageSearchOptions` →
`SearchOptions`

The ImageSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ImageSearchOptions class with default values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| return_content | Gets or sets flag to grab image content of signature on document page.
<br/>If this flag is set true, image signature content will keep raw image data by required format `ImageSearchOptions.return_content_type`.
<br/>By default this option is disabled. |
| min_content_size | For non zero value this flag specifies minimal size of images for search criteria.
<br/>By default this flag is set to zero and does not affect search result. |
| max_content_size | For non zero value this flag specifies maximum size of images for search criteria.
<br/>By default this flag is set to zero and does not affect search result. |
| return_content_type | Specifies file type of returned content of the image signature when ReturnContent property is enabled.
<br/>By default it set to Null. That means to return image content in original format.
<br/>This image format is specified at `ImageSignature.format`
<br/>Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
<br/>If provided format is not supported than image content in original format will be returned. |

##### Remarks

**Learn more** |
|
 |
 |

### ImageSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/__init__.md

#### __init__

Initializes a new instance of the ImageSearchOptions class with default values.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### max_content_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/max_content_size.md

#### max_content_size property

For non zero value this flag specifies maximum size of images for search criteria.
By default this flag is set to zero and does not affect search result.
##### Definition:
```python
@property
def max_content_size(self):
    ...
@max_content_size.setter
def max_content_size(self, value):
    ...
```

### min_content_size property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/min_content_size.md

#### min_content_size property

For non zero value this flag specifies minimal size of images for search criteria.
By default this flag is set to zero and does not affect search result.
##### Definition:
```python
@property
def min_content_size(self):
    ...
@min_content_size.setter
def min_content_size(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### return_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/return_content.md

#### return_content property

Gets or sets flag to grab image content of signature on document page.
If this flag is set true, image signature content will keep raw image data by required format `ImageSearchOptions.return_content_type`.
By default this option is disabled.
##### Definition:
```python
@property
def return_content(self):
    ...
@return_content.setter
def return_content(self, value):
    ...
```

### return_content_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/return_content_type.md

#### return_content_type property

Specifies file type of returned content of the image signature when ReturnContent property is enabled.
By default it set to Null. That means to return image content in original format.
This image format is specified at `ImageSignature.format`
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than image content in original format will be returned.
##### Definition:
```python
@property
def return_content_type(self):
    ...
@return_content_type.setter
def return_content_type(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### ImageSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions.md

#### ImageSignOptions class

Represents the Image signature options.

**Inheritance:** `ImageSignOptions` →
`SignOptions`

The ImageSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ImageSignOptions class with default values. |
| __init__ | Initializes a new instance of the ImageSignOptions class with image file. |
| __init__ | Initializes a new instance of the ImageSignOptions class with image stream. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| image_file_path | Gets or sets the signature image file path.
<br/>This property is used only if ImageStream is not specified. |
| image_stream | Gets or sets the signature image stream.
<br/>If this property is specified it is always used instead ImageFilePath. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| rectangle | Rectangle of area to put the image on document. |
| border | Specify border settings |

##### Methods
| Method | Description |
| :- | :- |
| from_base64 | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |

##### Remarks

**Learn more** |
|
 |
 |

### ImageSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/__init__.md

#### __init__

Initializes a new instance of the ImageSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the ImageSignOptions class with image file.

```python
def __init__(self, image_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_file_path | System.String | Image file path |

#### __init__

Initializes a new instance of the ImageSignOptions class with image stream.

```python
def __init__(self, image_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_stream | io.RawIOBase | Image stream |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/appearance.md

#### appearance property

Additional signature appearance.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/border.md

#### border property

Specify border settings
##### Definition:
```python
@property
def border(self):
    ...
@border.setter
def border(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/extensions.md

#### extensions property

Signature Extensions.

### from_base64 method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/from_base64.md

#### from_base64

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

##### Returns

```python
def from_base64(self, base_64_content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| base_64_content | System.String | Image content in Base64 string format |

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType).
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.
##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
@horizontal_alignment.setter
def horizontal_alignment(self, value):
    ...
```

### image_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/image_file_path.md

#### image_file_path property

Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.
##### Definition:
```python
@property
def image_file_path(self):
    ...
@image_file_path.setter
def image_file_path(self, value):
    ...
```

### image_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/image_stream.md

#### image_stream property

Gets or sets the signature image stream.
If this property is specified it is always used instead ImageFilePath.
##### Definition:
```python
@property
def image_stream(self):
    ...
@image_stream.setter
def image_stream(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if horizontal alignment is not specified).
##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.
##### Definition:
```python
@property
def location_measure_type(self):
    ...
@location_measure_type.setter
def location_measure_type(self, value):
    ...
```

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).
##### Definition:
```python
@property
def margin(self):
    ...
@margin.setter
def margin(self, value):
    ...
```

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.
##### Definition:
```python
@property
def margin_measure_type(self):
    ...
@margin_measure_type.setter
def margin_measure_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### rectangle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/rectangle.md

#### rectangle property

Rectangle of area to put the image on document.
##### Definition:
```python
@property
def rectangle(self):
    ...
```

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).
##### Definition:
```python
@property
def rotation_angle(self):
    ...
@rotation_angle.setter
def rotation_angle(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents
##### Definition:
```python
@property
def shape_position(self):
    ...
@shape_position.setter
def shape_position(self, value):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.
##### Definition:
```python
@property
def size_measure_type(self):
    ...
@size_measure_type.setter
def size_measure_type(self, value):
    ...
```

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.
##### Definition:
```python
@property
def stretch(self):
    ...
@stretch.setter
def stretch(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if vertical alignment is not specified).
##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.
##### Definition:
```python
@property
def vertical_alignment(self):
    ...
@vertical_alignment.setter
def vertical_alignment(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters `MeasureType` SizeMeasureType).
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/imagesignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### JpegCompressionColorMode enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegcompressioncolormode.md

#### JpegCompressionColorMode enumeration

Specifies JPEG color compression modes.

The JpegCompressionColorMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GRAYSCALE | The Grayscale image. |
| Y_CB_CR | YCbCr image, standard option for jpeg images. |
| CMYK | 4-component CMYK image. |
| YCCK | The ycck color jpeg image. Needs icc profile for saving. |
| RGB | The RGB Color mode. |

### JpegCompressionMode enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegcompressionmode.md

#### JpegCompressionMode enumeration

Specifies JPEG compression modes.

The JpegCompressionMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BASELINE | The baseline compression. |
| PROGRESSIVE | The progressive compression. |
| LOSSLESS | The lossless compression. Use this compression type carefully because
<br/>many image viewers do not support it. If you use it try assign the
<br/>`JpegSaveOptions.color_type` property to `JpegCompressionColorMode.GRAYSCALE`
<br/>or `JpegCompressionColorMode.RGB` values. |
| JPEG_LS | The JPEG-LS compression. Use this compression type carefully because
<br/>many image viewers do not support it. If you use it try to assign the
<br/>`JpegSaveOptions.color_type` property to `JpegCompressionColorMode.GRAYSCALE`
<br/>value. |

### JpegRoundingMode enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegroundingmode.md

#### JpegRoundingMode enumeration

Specifies different JPEG rounding modes.

The JpegRoundingMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| EXTRAPOLATE | Extrapolate an 8-bit value to fit it into n bits, where n more than 1 and less 8. |
| TRUNCATE | Truncate an 8-bit value to fit it into n bits, where  n more than 1 and less 8. |

### JpegSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions.md

#### JpegSaveOptions class

Jpeg Save options for image documents.

**Inheritance:** `JpegSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The JpegSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates JpegSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| bits_per_channel | Gets or sets bits per channel for lossless jpeg image.
<br/>Now we support from 2 to 8 bits per channel. |
| color_type | Gets or sets the color type for jpeg image. |
| comment | Gets or sets the jpeg file comment. |
| compression_type | Gets or sets the compression type. |
| quality | Gets or sets image quality. |
| sample_rounding_mode | Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
<br/>JpegOptions.BitsPerChannel. |

### JpegSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/__init__.md

#### __init__

Creates JpegSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### bits_per_channel property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/bits_per_channel.md

#### bits_per_channel property

Gets or sets bits per channel for lossless jpeg image.
Now we support from 2 to 8 bits per channel.
##### Definition:
```python
@property
def bits_per_channel(self):
    ...
@bits_per_channel.setter
def bits_per_channel(self, value):
    ...
```

### color_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/color_type.md

#### color_type property

Gets or sets the color type for jpeg image.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### comment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/comment.md

#### comment property

Gets or sets the jpeg file comment.
##### Definition:
```python
@property
def comment(self):
    ...
@comment.setter
def comment(self, value):
    ...
```

### compression_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/compression_type.md

#### compression_type property

Gets or sets the compression type.
##### Definition:
```python
@property
def compression_type(self):
    ...
@compression_type.setter
def compression_type(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### quality property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/quality.md

#### quality property

Gets or sets image quality.
##### Definition:
```python
@property
def quality(self):
    ...
@quality.setter
def quality(self, value):
    ...
```

### sample_rounding_mode property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/sample_rounding_mode.md

#### sample_rounding_mode property

Gets or sets the sample rounding mode to fit an 8-bit value to an n-bit value
JpegOptions.BitsPerChannel.
##### Definition:
```python
@property
def sample_rounding_mode(self):
    ...
@sample_rounding_mode.setter
def sample_rounding_mode(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/jpegsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### LoadOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions.md

#### LoadOptions class

Allows to specify additional options (such as password) when opening a document to sign.

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of LoadOptions class. |
| __init__ | Initializes a new instance of the `LoadOptions` class with a specified file type. |

##### Properties
| Property | Description |
| :- | :- |
| password | Gets or sets password to open a protected document.
<br/>It will be also used to save signed document as protected. |
| load_external_resources | Gets or sets options that specifies if external document resources should be loaded.
<br/>This option with disabled value (false) allows to save loading time for the documents with many or large external resource links.
<br/>By default value is enabled (true). |
| permissions | The PDF document permissions such as printing, modification and data extraction.Only for PDF documents. |
| file_type | Gets or sets the file type associated with the load options. |

### LoadOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions/__init__.md

#### __init__

Initializes a new instance of LoadOptions class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `LoadOptions` class with a specified file type.

```python
def __init__(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | groupdocs.signature.domain.FileType |  |

### file_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions/file_type.md

#### file_type property

Gets or sets the file type associated with the load options.
##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### load_external_resources property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions/load_external_resources.md

#### load_external_resources property

Gets or sets options that specifies if external document resources should be loaded.
This option with disabled value (false) allows to save loading time for the documents with many or large external resource links.
By default value is enabled (true).
##### Definition:
```python
@property
def load_external_resources(self):
    ...
@load_external_resources.setter
def load_external_resources(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions/password.md

#### password property

Gets or sets password to open a protected document.
It will be also used to save signed document as protected.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### permissions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/loadoptions/permissions.md

#### permissions property

The PDF document permissions such as printing, modification and data extraction.Only for PDF documents.

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/signature/net/protect-pdf-documents/).
##### Definition:
```python
@property
def permissions(self):
    ...
```

### MetadataSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions.md

#### MetadataSearchOptions class

Represents search options for Metadata signatures.

**Inheritance:** `MetadataSearchOptions` →
`SearchOptions`

The MetadataSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the MetadataSearchOptions class with default values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| name | Specifies Metadata Signature name if it should be searched and matched. |
| name_match_type | Gets or sets Metadata name Match Type search. It is used only when Name property is set. |
| include_builtin_properties | Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
<br/>This flag has sense for Presentation, Spreadsheet and Word Processing document file types. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to decrypt all Metadata signatures withing this options collection.
<br/>If this value is set all found signatures will use this encryption by default or its own DataEncryption if it was assigned. |

##### Remarks

**Learn more** |
|
 |
 |

### MetadataSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/__init__.md

#### __init__

Initializes a new instance of the MetadataSearchOptions class with default values.

```python
def __init__(self):
    ...
```

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to decrypt all Metadata signatures withing this options collection.
If this value is set all found signatures will use this encryption by default or its own DataEncryption if it was assigned.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### include_builtin_properties property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/include_builtin_properties.md

#### include_builtin_properties property

Indicates if Built-in document properties like Document statistic, information etc should be included into Search result.
This flag has sense for Presentation, Spreadsheet and Word Processing document file types.
##### Definition:
```python
@property
def include_builtin_properties(self):
    ...
@include_builtin_properties.setter
def include_builtin_properties(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/name.md

#### name property

Specifies Metadata Signature name if it should be searched and matched.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### name_match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/name_match_type.md

#### name_match_type property

Gets or sets Metadata name Match Type search. It is used only when Name property is set.
##### Definition:
```python
@property
def name_match_type(self):
    ...
@name_match_type.setter
def name_match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### MetadataSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions.md

#### MetadataSignOptions class

Represents Metadata signature options.

**Inheritance:** `MetadataSignOptions` →
`SignOptions`

The MetadataSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the MetadataSignOptions class with default values. |
| __init__ | Constructs a new instance of MetadataSignOptions |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| signatures | Gets or sets the Metadata of signature. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encrypt all Metadata signatures withing this options collection.
<br/>If this value is set all added signatures will use this encryption by default or its own DataEncryption if it was assigned. |

##### Methods
| Method | Description |
| :- | :- |
| add_pdf_signature | Creates new PdfMetadataSignature with passed arguments and adds it to collection. |
| add_image_signature | Creates new ImageMetadataSignature with passed arguments and adds it to collection. |
| add | Add existing  MetadataSignature instance to collection. |

##### Remarks

**Learn more** |
|
 |
 |

### MetadataSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/__init__.md

#### __init__

Initializes a new instance of the MetadataSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Constructs a new instance of MetadataSignOptions

```python
def __init__(self, signatures):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signatures | list |  |

### add method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/add.md

#### add

Add existing  MetadataSignature instance to collection.

##### Returns

Instance itself

```python
def add(self, metadata_signature):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| metadata_signature | groupdocs.signature.domain.MetadataSignature | The existing MetadataSignature instance to be added |

### add_image_signature method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/add_image_signature.md

#### add_image_signature

Creates new ImageMetadataSignature with passed arguments and adds it to collection.

##### Returns

Newly created signature that was added to MetadataSignatures collection

```python
def add_image_signature(self, id, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | System.Object | Metadata value |

### add_pdf_signature method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/add_pdf_signature.md

#### add_pdf_signature

Creates new PdfMetadataSignature with passed arguments and adds it to collection.

##### Returns

Newly created signature that was added to MetadataSignatures collection

```python
def add_pdf_signature(self, name, value, tag):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | System.String | Name of Metadata signature object |
| value | System.Object | Value of Metadata signature |
| tag | System.String | Prefix tag of Metadata signature |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/appearance.md

#### appearance property

Additional signature appearance.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encrypt all Metadata signatures withing this options collection.
If this value is set all added signatures will use this encryption by default or its own DataEncryption if it was assigned.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/extensions.md

#### extensions property

Signature Extensions.

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/signatures.md

#### signatures property

Gets or sets the Metadata of signature.
##### Definition:
```python
@property
def signatures(self):
    ...
@signatures.setter
def signatures(self, value):
    ...
```

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/metadatasignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### PagesSetup class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup.md

#### PagesSetup class

Describes special document pages to work with.

The PagesSetup type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PagesSetup with default options. |

##### Properties
| Property | Description |
| :- | :- |
| first_page | Gets or sets flag to use first document page. |
| last_page | Gets or sets flag to use last document page. |
| odd_pages | Gets or sets flag to use odd pages of document. |
| even_pages | Gets or sets flag to use even pages of document. |
| page_numbers | Set arbitrary pages of document to use. |

### PagesSetup constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/__init__.md

#### __init__

Creates PagesSetup with default options.

```python
def __init__(self):
    ...
```

### even_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/even_pages.md

#### even_pages property

Gets or sets flag to use even pages of document.
##### Definition:
```python
@property
def even_pages(self):
    ...
@even_pages.setter
def even_pages(self, value):
    ...
```

### first_page property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/first_page.md

#### first_page property

Gets or sets flag to use first document page.
##### Definition:
```python
@property
def first_page(self):
    ...
@first_page.setter
def first_page(self, value):
    ...
```

### last_page property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/last_page.md

#### last_page property

Gets or sets flag to use last document page.
##### Definition:
```python
@property
def last_page(self):
    ...
@last_page.setter
def last_page(self, value):
    ...
```

### odd_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/odd_pages.md

#### odd_pages property

Gets or sets flag to use odd pages of document.
##### Definition:
```python
@property
def odd_pages(self):
    ...
@odd_pages.setter
def odd_pages(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pagessetup/page_numbers.md

#### page_numbers property

Set arbitrary pages of document to use.
##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### PdfSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions.md

#### PdfSaveOptions class

Save options for PDF documents.

**Inheritance:** `PdfSaveOptions` →
`SaveOptions`

The PdfSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of PdfSaveOptions class with default values. |
| __init__ | Initializes a new instance of PdfSaveOptions class with specified output file format. |
| __init__ | Initializes a new instance of PdfSaveOptions class with overwrite flag. |
| __init__ | Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| permissions_password | A permissions password (the primary password) requires a password to change permission settings. |
| permissions | The PDF document permissions such as printing, modification and data extraction. |

### PdfSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/__init__.md

#### __init__

Initializes a new instance of PdfSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of PdfSaveOptions class with specified output file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.PdfSaveFileFormat | Output file type `PdfSaveFileFormat`. |

#### __init__

Initializes a new instance of PdfSaveOptions class with overwrite flag.

```python
def __init__(self, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

#### __init__

Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.

```python
def __init__(self, file_format, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.PdfSaveFileFormat | Output file type `PdfSaveFileFormat`. |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### permissions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/permissions.md

#### permissions property

The PDF document permissions such as printing, modification and data extraction.

##### Remarks

To modify these permissions, the PermissionsPassword must be set.
For a code sample, see the [documentation](https://docs.groupdocs.com/signature/net/protect-pdf-documents/).
##### Definition:
```python
@property
def permissions(self):
    ...
@permissions.setter
def permissions(self, value):
    ...
```

### permissions_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/permissions_password.md

#### permissions_password property

A permissions password (the primary password) requires a password to change permission settings.
##### Definition:
```python
@property
def permissions_password(self):
    ...
@permissions_password.setter
def permissions_password(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdfsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### PdfTextAnnotationVerifyExtensions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextannotationverifyextensions.md

#### PdfTextAnnotationVerifyExtensions class

Describes extensions of verification of PDF text annotation object

**Inheritance:** `PdfTextAnnotationVerifyExtensions` →
`VerifyExtensions`

The PdfTextAnnotationVerifyExtensions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PDF text annotation signature verification extensions with empty values. |

##### Properties
| Property | Description |
| :- | :- |
| title | Title of text annotation to be verified.
<br/>Not be verified if equals empty string or null. |
| subject | Subject of text annotation to be verified.
<br/>Not be verified if equals empty string or null. |
| contents | Contents of text annotation to be verified.
<br/>Not be verified if equals empty string or null. |

### PdfTextAnnotationVerifyExtensions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextannotationverifyextensions/__init__.md

#### __init__

Creates PDF text annotation signature verification extensions with empty values.

```python
def __init__(self):
    ...
```

### contents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextannotationverifyextensions/contents.md

#### contents property

Contents of text annotation to be verified.
Not be verified if equals empty string or null.
##### Definition:
```python
@property
def contents(self):
    ...
@contents.setter
def contents(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextannotationverifyextensions/subject.md

#### subject property

Subject of text annotation to be verified.
Not be verified if equals empty string or null.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextannotationverifyextensions/title.md

#### title property

Title of text annotation to be verified.
Not be verified if equals empty string or null.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### PdfTextStickerVerifyExtensions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions.md

#### PdfTextStickerVerifyExtensions class

Describes extensions of verification of PDF sticker object.

**Inheritance:** `PdfTextStickerVerifyExtensions` →
`VerifyExtensions`

The PdfTextStickerVerifyExtensions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PDF text sticker signature verification extensions with empty values. |

##### Properties
| Property | Description |
| :- | :- |
| title | Title of sticker to be verified.
<br/>Value will not be verified if equals empty string or null. |
| subject | Subject of sticker to be verified.
<br/>Value will not be verified if equals empty string or null. |
| contents | Contents of sticker to be verified.
<br/>Value will not be verified if equals empty string or null. |
| icon | Icon of sticker to be verified.
<br/>Value will not be verified if equals null. |

### PdfTextStickerVerifyExtensions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions/__init__.md

#### __init__

Creates PDF text sticker signature verification extensions with empty values.

```python
def __init__(self):
    ...
```

### contents property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions/contents.md

#### contents property

Contents of sticker to be verified.
Value will not be verified if equals empty string or null.
##### Definition:
```python
@property
def contents(self):
    ...
@contents.setter
def contents(self, value):
    ...
```

### icon property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions/icon.md

#### icon property

Icon of sticker to be verified.
Value will not be verified if equals null.
##### Definition:
```python
@property
def icon(self):
    ...
@icon.setter
def icon(self, value):
    ...
```

### subject property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions/subject.md

#### subject property

Subject of sticker to be verified.
Value will not be verified if equals empty string or null.
##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pdftextstickerverifyextensions/title.md

#### title property

Title of sticker to be verified.
Value will not be verified if equals empty string or null.
##### Definition:
```python
@property
def title(self):
    ...
@title.setter
def title(self, value):
    ...
```

### Permissions enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/permissions.md

#### Permissions enumeration

Specifies configurable permissions for PDF documents, such as printing, content modification, and data extraction.
These settings are applicable to PDF format only and control user access and interaction capabilities.

The Permissions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Allow all actions, including printing, modification, and data extraction. |
| DENY_PRINTING | Deny printing of the document. |
| DENY_MODIFICATION | Deny content modification, including filling forms and adding or modifying annotations. |
| DENY_DATA_EXTRACTION | Deny extraction of text and graphics from the document. |
| DENY_ALL | Deny all actions, including printing, modification, and data extraction. |

### PngColorType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngcolortype.md

#### PngColorType enumeration

Represents the PNG image color type.

The PngColorType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GRAYSCALE | Represents the color type where each pixel is a grayscale sample. |
| TRUECOLOR | Represents the color type where each pixel is an R,G,B triple. |
| INDEXED_COLOR | Represents the color type where each pixel is a palette index; a PLTE chunk
<br/>shall appear. |
| GRAYSCALE_WITH_ALPHA | Represents the color type where each pixel is a grayscale sample followed
<br/>by an alpha sample. |
| TRUECOLOR_WITH_ALPHA | Represents the color type where each pixel is an R,G,B triple followed by
<br/>an alpha sample. |

### PngFilterType enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngfiltertype.md

#### PngFilterType enumeration

Represents PNG image filter type.

The PngFilterType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | The null-filter, means no filtering for image data rows. |
| SUB | The sub filter, means subtractive filtering will be applied to image data. |
| UP | The up filter, means row-by-row subtraction filter will be applied. |
| AVG | The avg filter, means, that average filter will be applied to image data. |
| PAETH | The path predictor filter. |
| ADAPTIVE | Adaptive filtering, means that saving process will choose most suitable filter
<br/>for each data row. Best compression, slowest execution time. |

### PngSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions.md

#### PngSaveOptions class

Png Save options for image documents.

**Inheritance:** `PngSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The PngSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PngSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| bit_depth | The bit depth. |
| color_type | Gets or sets the type of the `PngColorType`. |
| compression_level | The png image compression level in the 0-9 range, where 9 is maximum compression
<br/>and 0 is store mode. |
| filter_type | Gets or sets the filter type `PngFilterType` used during png file save process. |
| progressive | Gets or sets a value indicating whether this PngSaveOptions is progressive. |

### PngSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/__init__.md

#### __init__

Creates PngSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### bit_depth property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/bit_depth.md

#### bit_depth property

The bit depth.
##### Definition:
```python
@property
def bit_depth(self):
    ...
@bit_depth.setter
def bit_depth(self, value):
    ...
```

### color_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/color_type.md

#### color_type property

Gets or sets the type of the `PngColorType`.
##### Definition:
```python
@property
def color_type(self):
    ...
@color_type.setter
def color_type(self, value):
    ...
```

### compression_level property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/compression_level.md

#### compression_level property

The png image compression level in the 0-9 range, where 9 is maximum compression
and 0 is store mode.
##### Definition:
```python
@property
def compression_level(self):
    ...
@compression_level.setter
def compression_level(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### filter_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/filter_type.md

#### filter_type property

Gets or sets the filter type `PngFilterType` used during png file save process.
##### Definition:
```python
@property
def filter_type(self):
    ...
@filter_type.setter
def filter_type(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### progressive property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/progressive.md

#### progressive property

Gets or sets a value indicating whether this PngSaveOptions is progressive.
##### Definition:
```python
@property
def progressive(self):
    ...
@progressive.setter
def progressive(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/pngsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### PresentationSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions.md

#### PresentationSaveOptions class

Save options for Presentation documents.

**Inheritance:** `PresentationSaveOptions` →
`SaveOptions`

The PresentationSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of PresentationSaveOptions class with default values. |
| __init__ | Initializes a new instance of PresentationSaveOptions class with specified output file format. |
| __init__ | Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag. |
| __init__ | Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |

### PresentationSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/__init__.md

#### __init__

Initializes a new instance of PresentationSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of PresentationSaveOptions class with specified output file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.PresentationSaveFileFormat | Output file type `PresentationSaveFileFormat`. |

#### __init__

Initializes a new instance of PresentationSaveOptions class with specified output type and overwrite flag.

```python
def __init__(self, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

#### __init__

Initializes a new instance of PresentationSaveOptions class with specified output file format and overwrite flag.

```python
def __init__(self, file_format, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.PresentationSaveFileFormat | Output file type `PresentationSaveFileFormat`. |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/presentationsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### PreviewOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions.md

#### PreviewOptions class

Represents document preview options.

The PreviewOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| width | Gets or sets preview images width. |
| height | Gets or sets preview images height. |
| page_numbers | Gets or sets preview images page numbers. |
| preview_format | Gets or sets preview images format. |
| hide_signatures | Gets or sets flag to hide signatures from page preview image.
<br/>Only signatures are marked as IsSignature will be hidden from generated document page image. |
| resolution | Gets or sets the resolution of the preview images in DPI (dots per inch). |

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/height.md

#### height property

Gets or sets preview images height.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### hide_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/hide_signatures.md

#### hide_signatures property

Gets or sets flag to hide signatures from page preview image.
Only signatures are marked as IsSignature will be hidden from generated document page image.
##### Definition:
```python
@property
def hide_signatures(self):
    ...
@hide_signatures.setter
def hide_signatures(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/page_numbers.md

#### page_numbers property

Gets or sets preview images page numbers.
##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/preview_format.md

#### preview_format property

Gets or sets preview images format.
##### Definition:
```python
@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/resolution.md

#### resolution property

Gets or sets the resolution of the preview images in DPI (dots per inch).
##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewoptions/width.md

#### width property

Gets or sets preview images width.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PreviewPageData class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewpagedata.md

#### PreviewPageData class

Contains data about document page to be saved as preview image.

The PreviewPageData type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates PreviewPageData with default parameters. |

##### Properties
| Property | Description |
| :- | :- |
| file_name | Name of a file which is being processed in order to get page previews.
<br/>In case of nameless stream processing it equals 'fromstream'. |
| page_number | Document page number of current preview. |
| preview_format | Selected preview format. |

### PreviewPageData constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewpagedata/__init__.md

#### __init__

Creates PreviewPageData with default parameters.

```python
def __init__(self):
    ...
```

### file_name property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewpagedata/file_name.md

#### file_name property

Name of a file which is being processed in order to get page previews.
In case of nameless stream processing it equals 'fromstream'.
##### Definition:
```python
@property
def file_name(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewpagedata/page_number.md

#### page_number property

Document page number of current preview.
##### Definition:
```python
@property
def page_number(self):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewpagedata/preview_format.md

#### preview_format property

Selected preview format.
##### Definition:
```python
@property
def preview_format(self):
    ...
```

### PreviewSignatureOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewsignatureoptions.md

#### PreviewSignatureOptions class

Represents signature preview options.

The PreviewSignatureOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| signature_id | Unique value to distinct the signature.
<br/>Use SignatureId to identify the preview options. |
| sign_options | Signature Options for generate preview. |
| preview_format | Gets or sets preview images format.
<br/>Default value is PNG |

### preview_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewsignatureoptions/preview_format.md

#### preview_format property

Gets or sets preview images format.
Default value is PNG
##### Definition:
```python
@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...
```

### sign_options property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewsignatureoptions/sign_options.md

#### sign_options property

Signature Options for generate preview.
##### Definition:
```python
@property
def sign_options(self):
    ...
@sign_options.setter
def sign_options(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/previewsignatureoptions/signature_id.md

#### signature_id property

Unique value to distinct the signature.
Use SignatureId to identify the preview options.
##### Definition:
```python
@property
def signature_id(self):
    ...
@signature_id.setter
def signature_id(self, value):
    ...
```

### QrCodeSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions.md

#### QrCodeSearchOptions class

Represents search options for QR-Code signatures.

**Inheritance:** `QrCodeSearchOptions` →
`SearchOptions`

The QrCodeSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the QRCodeSearchOptions class with default values. |
| __init__ | Initializes a new instance of the QRCodeSearchOptions class with encode type value. |
| __init__ | Initializes a new instance of the QRCodeSearchOptions class with encode type and text values. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| encode_type | Specifies Encode Type property to search QR-Codes.
<br/>If this value is not set, search is processed for all supported QR-Code Types. |
| text | Specifies QR-Code Signature Text if it should be searched and matched. |
| match_type | Gets or sets QR-Code Text Match Type search. It is used only when Text property is set. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties. |
| return_content | Gets or sets flag to grab QR-Code image content of signature on document page.
<br/>If this flag is set true, QR-Code signature image content will keep raw image data by required format `QrCodeSearchOptions.return_content_type`.
<br/>By default this option is disabled. |
| return_content_type | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
<br/>By default it set to Null. That means to return QR-Code image content in original format.
<br/>This image format is specified at `QrCodeSignature.format`
<br/>Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
<br/>If provided format is not supported than QR-Code image content in original .png will be returned. |

##### Remarks

**Learn more** |
|
 |
 |

### QrCodeSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/__init__.md

#### __init__

Initializes a new instance of the QRCodeSearchOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

```python
def __init__(self, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encode_type | groupdocs.signature.domain.QrCodeType | Specifies QR-Code encode type. |

#### __init__

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

```python
def __init__(self, encode_type, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| encode_type | groupdocs.signature.domain.QrCodeType | Specifies QR-Code encode type. |
| text | System.String | Set Text of QR-Code signature. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/encode_type.md

#### encode_type property

Specifies Encode Type property to search QR-Codes.
If this value is not set, search is processed for all supported QR-Code Types.
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/match_type.md

#### match_type property

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### return_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/return_content.md

#### return_content property

Gets or sets flag to grab QR-Code image content of signature on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format `QrCodeSearchOptions.return_content_type`.
By default this option is disabled.
##### Definition:
```python
@property
def return_content(self):
    ...
@return_content.setter
def return_content(self, value):
    ...
```

### return_content_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/return_content_type.md

#### return_content_type property

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at `QrCodeSignature.format`
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in original .png will be returned.
##### Definition:
```python
@property
def return_content_type(self):
    ...
@return_content_type.setter
def return_content_type(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesearchoptions/text.md

#### text property

Specifies QR-Code Signature Text if it should be searched and matched.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### QrCodeSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions.md

#### QrCodeSignOptions class

Represents the QR-Code signature options.

**Inheritance:** `QrCodeSignOptions` →
`TextSignOptions` →
`SignOptions`

The QrCodeSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the QRCodeSignOptions class with default values. |
| __init__ | Initializes a new instance of the QRCodeSignOptions class with text. |
| __init__ | Initializes a new instance of the BarcodeSignOptions class with text. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| text | Gets or sets the text of signature. |
| font | Gets or sets the font of signature. |
| fore_color | Gets or sets the Fore color of QR-Code bars
<br/>Using of this property could cause problems with verification. Use it carefully. |
| signature_implementation | Gets or sets the type of text signature implementation. |
| text_horizontal_alignment | Horizontal alignment of text inside a signature.
<br/>This feature is supported only for Image and Annotation signature implementations
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| text_vertical_alignment | Vertical alignment of text inside a signature.
<br/>This feature is supported only for Image signature implementation
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| form_text_field_title | Gets or sets the title of text form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField. |
| form_text_field_type | Gets or sets the type of form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField.
<br/>Value by default is AllTextTypes. |
| shape_type | Gets or sets the type of shape to put text.
<br/>This property could be used only with SignatureImplementation = TextStamp.
<br/>Value by default is Rectangle. |
| signature_id | Gets or sets the unique ID of signature. It can be used in signature verification options.
<br/>Property is supported for Pdf documents only. |
| border | Specify border settings |
| background | Gets or sets the signature background settings. |
| native | Gets or sets the native attribute. If it is set document specific signatures could be used.
<br/>Native text watermark for WordProcessing documents is different than regular, for example. |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| encode_type | Gets or sets QR-Code type. |
| inner_margins | Gets or sets the space between QR-Code elements and result image borders. |
| code_text_alignment | Gets or sets the alignment of text in the result QR-code image.
<br/>Default value is None. |
| logo_file_path | Gets or sets the QR-code logo image file name.
<br/>This property in use only if LogoStream is not specified.
<br/>Using of this property could cause problems with verification. Use it carefully. |
| logo_stream | Gets or sets the QR-code logo image stream.
<br/>If this property is specified it is always used instead LogoFilePath.
<br/>Using of this property could cause problems with verification. Use it carefully. |
| data | Gets or sets custom object to serialize to QR-Code content. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties. |
| return_content | Gets or sets flag to get QR-Code image content of a signature which was put on document page.
<br/>If this flag is set true, QR-Code signature image content will keep raw image data by required format `QrCodeSignOptions.return_content_type`.
<br/>By default this option is disabled. |
| return_content_type | Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
<br/>By default it set to Null. That means to return QR-Code image content in original format.
<br/>This image format is specified at `QrCodeSignature.format`
<br/>Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
<br/>If provided format is not supported than QR-Code image content in .png format will be returned. |

##### Remarks

**Learn more** |
|
 |
 |

### QrCodeSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/__init__.md

#### __init__

Initializes a new instance of the QRCodeSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the QRCodeSignOptions class with text.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Signature text. |

#### __init__

Initializes a new instance of the BarcodeSignOptions class with text.

```python
def __init__(self, text, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | QRCode text |
| encode_type | groupdocs.signature.domain.QrCodeType | QRCode encode type see `QrCodeType` |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/appearance.md

#### appearance property

Additional signature appearance.

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/background.md

#### background property

Gets or sets the signature background settings.

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/border.md

#### border property

Specify border settings

### code_text_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/code_text_alignment.md

#### code_text_alignment property

Gets or sets the alignment of text in the result QR-code image.
Default value is None.
##### Definition:
```python
@property
def code_text_alignment(self):
    ...
@code_text_alignment.setter
def code_text_alignment(self, value):
    ...
```

### data property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/data.md

#### data property

Gets or sets custom object to serialize to QR-Code content.
##### Definition:
```python
@property
def data(self):
    ...
@data.setter
def data(self, value):
    ...
```

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text or Data properties.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/encode_type.md

#### encode_type property

Gets or sets QR-Code type.
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/extensions.md

#### extensions property

Signature Extensions.

### font property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/font.md

#### font property

Gets or sets the font of signature.

### fore_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/fore_color.md

#### fore_color property

Gets or sets the Fore color of QR-Code bars
Using of this property could cause problems with verification. Use it carefully.
##### Definition:
```python
@property
def fore_color(self):
    ...
@fore_color.setter
def fore_color(self, value):
    ...
```

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.

### inner_margins property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/inner_margins.md

#### inner_margins property

Gets or sets the space between QR-Code elements and result image borders.
##### Definition:
```python
@property
def inner_margins(self):
    ...
@inner_margins.setter
def inner_margins(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if horizontal alignment is not specified).

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.

### logo_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/logo_file_path.md

#### logo_file_path property

Gets or sets the QR-code logo image file name.
This property in use only if LogoStream is not specified.
Using of this property could cause problems with verification. Use it carefully.
##### Definition:
```python
@property
def logo_file_path(self):
    ...
@logo_file_path.setter
def logo_file_path(self, value):
    ...
```

### logo_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/logo_stream.md

#### logo_stream property

Gets or sets the QR-code logo image stream.
If this property is specified it is always used instead LogoFilePath.
Using of this property could cause problems with verification. Use it carefully.
##### Definition:
```python
@property
def logo_stream(self):
    ...
@logo_stream.setter
def logo_stream(self, value):
    ...
```

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

### native property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/native.md

#### native property

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### return_content property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/return_content.md

#### return_content property

Gets or sets flag to get QR-Code image content of a signature which was put on document page.
If this flag is set true, QR-Code signature image content will keep raw image data by required format `QrCodeSignOptions.return_content_type`.
By default this option is disabled.
##### Definition:
```python
@property
def return_content(self):
    ...
@return_content.setter
def return_content(self, value):
    ...
```

### return_content_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/return_content_type.md

#### return_content_type property

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
By default it set to Null. That means to return QR-Code image content in original format.
This image format is specified at `QrCodeSignature.format`
Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP.
If provided format is not supported than QR-Code image content in .png format will be returned.
##### Definition:
```python
@property
def return_content_type(self):
    ...
@return_content_type.setter
def return_content_type(self, value):
    ...
```

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

### shape_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/shape_type.md

#### shape_type property

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/signature_id.md

#### signature_id property

Gets or sets the unique ID of signature. It can be used in signature verification options.
Property is supported for Pdf documents only.

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/signature_implementation.md

#### signature_implementation property

Gets or sets the type of text signature implementation.

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/text.md

#### text property

Gets or sets the text of signature.

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/text_horizontal_alignment.md

#### text_horizontal_alignment property

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see `TextSignatureImplementation` SignatureImplementation property).

### text_vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/text_vertical_alignment.md

#### text_vertical_alignment property

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see `TextSignatureImplementation` SignatureImplementation property).

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if vertical alignment is not specified).

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodesignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### QrCodeVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions.md

#### QrCodeVerifyOptions class

Keeps options to verify document QR-code signature.

**Inheritance:** `QrCodeVerifyOptions` →
`TextVerifyOptions` →
`VerifyOptions`

The QrCodeVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates verification option QrCodeVerifyOptions for QR-Code Signatures. |
| __init__ | Creates verification option QrCodeVerifyOptions for QR-Code Signatures with QR-Code text  to verify. |
| __init__ | Creates verification option QrCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify. |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| text | Specify Signature Text if it should be verified. |
| match_type | Gets or sets Text Match Type verification. |
| signature_implementation | Type of Signature to be verified. |
| form_text_field_title | Gets or sets the title of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| form_text_field_type | Gets or sets the type of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| signature_id | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |
| encode_type | Gets or sets QR-code Type verification. This property is optional. |
| data_encryption | Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text properties. |

##### Remarks

**Learn more** |
|
 |
 |

### QrCodeVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/__init__.md

#### __init__

Creates verification option QrCodeVerifyOptions for QR-Code Signatures.

```python
def __init__(self):
    ...
```

#### __init__

Creates verification option QrCodeVerifyOptions for QR-Code Signatures with QR-Code text  to verify.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | QR-code Text to verify |

#### __init__

Creates verification option QrCodeVerifyOptions for QR-Code Signatures with text and QR-Code encode type to verify.

```python
def __init__(self, text, encode_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Text to be verified |
| encode_type | groupdocs.signature.domain.QrCodeType | Type of encoding |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### data_encryption property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/data_encryption.md

#### data_encryption property

Gets or sets implementation of `IDataEncryption` interface to encode and decode QR-Code Signature Text properties.
##### Definition:
```python
@property
def data_encryption(self):
    ...
@data_encryption.setter
def data_encryption(self, value):
    ...
```

### encode_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/encode_type.md

#### encode_type property

Gets or sets QR-code Type verification. This property is optional.
##### Definition:
```python
@property
def encode_type(self):
    ...
@encode_type.setter
def encode_type(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of form field to verify it.
If this property set text will be found only in text form fields.

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to verify it.
If this property set text will be found only in text form fields.

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/match_type.md

#### match_type property

Gets or sets Text Match Type verification.

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/signature_id.md

#### signature_id property

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/signature_implementation.md

#### signature_implementation property

Type of Signature to be verified.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/qrcodeverifyoptions/text.md

#### text property

Specify Signature Text if it should be verified.

### SaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions.md

#### SaveOptions class

Allows to specify additional options (such as password) when saving a document to sign.

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of SaveOptions class with default values. |
| __init__ | Initializes a new instance of SaveOptions class with specified output type and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |

### SaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions/__init__.md

#### __init__

Initializes a new instance of SaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

```python
def __init__(self, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.
##### Definition:
```python
@property
def add_missing_extenstion(self):
    ...
@add_missing_extenstion.setter
def add_missing_extenstion(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.
##### Definition:
```python
@property
def overwrite_existing_files(self):
    ...
@overwrite_existing_files.setter
def overwrite_existing_files(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/saveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.
##### Definition:
```python
@property
def use_original_password(self):
    ...
@use_original_password.setter
def use_original_password(self, value):
    ...
```

### SearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions.md

#### SearchOptions class

Represents the extract signatures from document options.

The SearchOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |

##### Remarks

**Learn more** |
|
 |
 |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.
##### Definition:
```python
@property
def all_pages(self):
    ...
@all_pages.setter
def all_pages(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.
##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents
##### Definition:
```python
@property
def shape_position(self):
    ...
@shape_position.setter
def shape_position(self, value):
    ...
```

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/searchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.
##### Definition:
```python
@property
def skip_external(self):
    ...
@skip_external.setter
def skip_external(self, value):
    ...
```

### SignatureContext class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signaturecontext.md

#### SignatureContext class

Represents the context for a document signature process,
encapsulating the signing options.

The SignatureContext type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| sign_options | Gets or sets the options used for signing a document. |

### sign_options property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signaturecontext/sign_options.md

#### sign_options property

Gets or sets the options used for signing a document.
##### Definition:
```python
@property
def sign_options(self):
    ...
@sign_options.setter
def sign_options(self, value):
    ...
```

### SignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions.md

#### SignOptions class

Represents the signature options.

The SignOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |

##### Remarks

**Learn more** |
|
 |
 |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/all_pages.md

#### all_pages property

Put signature on all document pages.
##### Definition:
```python
@property
def all_pages(self):
    ...
@all_pages.setter
def all_pages(self, value):
    ...
```

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/appearance.md

#### appearance property

Additional signature appearance.
##### Definition:
```python
@property
def appearance(self):
    ...
@appearance.setter
def appearance(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`
##### Definition:
```python
@property
def document_type(self):
    ...
@document_type.setter
def document_type(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/extensions.md

#### extensions property

Signature Extensions.
##### Definition:
```python
@property
def extensions(self):
    ...
```

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.
##### Definition:
```python
@property
def hash_algorithm(self):
    ...
@hash_algorithm.setter
def hash_algorithm(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.
##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`
##### Definition:
```python
@property
def signature_type(self):
    ...
```

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/signoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.
##### Definition:
```python
@property
def z_order(self):
    ...
@z_order.setter
def z_order(self, value):
    ...
```

### SpreadsheetSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

Save options for Spreadsheet Documents.

**Inheritance:** `SpreadsheetSaveOptions` →
`SaveOptions`

The SpreadsheetSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of SpreadsheetSaveOptions class with default values. |
| __init__ | Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format. |
| __init__ | Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |

### SpreadsheetSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/__init__.md

#### __init__

Initializes a new instance of SpreadsheetSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of SpreadsheetSaveOptions class with predefined output file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.SpreadsheetSaveFileFormat | Specifies output file format. |

#### __init__

Initializes a new instance of SpreadsheetSaveOptions class with specified output type and overwrite flag.

```python
def __init__(self, file_format, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.SpreadsheetSaveFileFormat | Specifies output file format. |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/spreadsheetsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### StampSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions.md

#### StampSignOptions class

Represents the Stamp signature options.

**Inheritance:** `StampSignOptions` →
`ImageSignOptions` →
`SignOptions`

The StampSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the StampSignOptions class with default values. |
| __init__ | Initializes a new instance of the StampSignOptions class with alignment options. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| image_file_path | Gets or sets the signature image file path.
<br/>This property is used only if ImageStream is not specified. |
| image_stream | Gets or sets the signature image stream.
<br/>If this property is specified it is always used instead ImageFilePath. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters `MeasureType` SizeMeasureType). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |
| rectangle | Rectangle of area to put the image on document. |
| border | Specify border settings |
| stamp_type | Gets or sets stamp type.
<br/>Value by default is Round. |
| outer_lines | List of Outer Lines rendered as concentric circles. |
| inner_lines | List of Inner Lines rendered as set of rectangles. |
| background | Gets or sets the Stamp background. |
| background_color_crop_type | Gets or sets the background color crop type of signature. |
| background_image_crop_type | Gets or sets the background image crop type of signature. |

##### Methods
| Method | Description |
| :- | :- |
| from_base64 | Creates a new instance of the ImageSignOptions class with predefined Image from Base64. |

##### Remarks

**Learn more** |
|
 |
 |

### StampSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/__init__.md

#### __init__

Initializes a new instance of the StampSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the StampSignOptions class with alignment options.

```python
def __init__(self, left, top, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | int | The x-coordinate of the left top edge of Stamp Signature |
| top | int | The y-coordinate of the left top edge of Stamp Signature |
| width | int | The width of Stamp Signature |
| height | int | The height of Stamp Signature |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/appearance.md

#### appearance property

Additional signature appearance.

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/background.md

#### background property

Gets or sets the Stamp background.
##### Definition:
```python
@property
def background(self):
    ...
@background.setter
def background(self, value):
    ...
```

### background_color_crop_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/background_color_crop_type.md

#### background_color_crop_type property

Gets or sets the background color crop type of signature.
##### Definition:
```python
@property
def background_color_crop_type(self):
    ...
@background_color_crop_type.setter
def background_color_crop_type(self, value):
    ...
```

### background_image_crop_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/background_image_crop_type.md

#### background_image_crop_type property

Gets or sets the background image crop type of signature.
##### Definition:
```python
@property
def background_image_crop_type(self):
    ...
@background_image_crop_type.setter
def background_image_crop_type(self, value):
    ...
```

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/border.md

#### border property

Specify border settings

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/extensions.md

#### extensions property

Signature Extensions.

### from_base64 method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/from_base64.md

#### from_base64

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

##### Returns

```python
def from_base64(self, base_64_content):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| base_64_content | System.String | Image content in Base64 string format |

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType).

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.

### image_file_path property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/image_file_path.md

#### image_file_path property

Gets or sets the signature image file path.
This property is used only if ImageStream is not specified.

### image_stream property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/image_stream.md

#### image_stream property

Gets or sets the signature image stream.
If this property is specified it is always used instead ImageFilePath.

### inner_lines property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/inner_lines.md

#### inner_lines property

List of Inner Lines rendered as set of rectangles.
##### Definition:
```python
@property
def inner_lines(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if horizontal alignment is not specified).

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

### outer_lines property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/outer_lines.md

#### outer_lines property

List of Outer Lines rendered as concentric circles.
##### Definition:
```python
@property
def outer_lines(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### rectangle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/rectangle.md

#### rectangle property

Rectangle of area to put the image on document.

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.

### stamp_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/stamp_type.md

#### stamp_type property

Gets or sets stamp type.
Value by default is Round.
##### Definition:
```python
@property
def stamp_type(self):
    ...
@stamp_type.setter
def stamp_type(self, value):
    ...
```

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType).
(works if vertical alignment is not specified).

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters `MeasureType` SizeMeasureType).

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/stampsignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### TextSearchOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions.md

#### TextSearchOptions class

Represents search options for Text signatures.

**Inheritance:** `TextSearchOptions` →
`SearchOptions`

The TextSearchOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextSearchOptions class with default values. |
| __init__ | Initializes a new instance of the TextSearchOptions class with text value. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets Document page number for searching.
<br/>Value is optional. |
| pages_setup | Options to specify pages for Signature searching. |
| all_pages | Flag to search on each Document page. By default this value is set to true. |
| skip_external | Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria. |
| shape_position | Flag to return specify shape position in the document layout. Avaliable only for Word documents |
| text | Specifies signature text to match on searching. |
| match_type | Gets or sets text match type search. |
| signature_implementation | Specifies text signature implementation to search. |

##### Remarks

**Learn more** |
|
 |
 |

### TextSearchOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/__init__.md

#### __init__

Initializes a new instance of the TextSearchOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the TextSearchOptions class with text value.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Set Text of Text signature. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/all_pages.md

#### all_pages property

Flag to search on each Document page. By default this value is set to true.

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/match_type.md

#### match_type property

Gets or sets text match type search.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/page_number.md

#### page_number property

Gets or sets Document page number for searching.
Value is optional.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/pages_setup.md

#### pages_setup property

Options to specify pages for Signature searching.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/shape_position.md

#### shape_position property

Flag to return specify shape position in the document layout. Avaliable only for Word documents

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/signature_implementation.md

#### signature_implementation property

Specifies text signature implementation to search.
##### Definition:
```python
@property
def signature_implementation(self):
    ...
@signature_implementation.setter
def signature_implementation(self, value):
    ...
```

### skip_external property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/skip_external.md

#### skip_external property

Flag to return only signatures marked as IsSignature. By default value is false that indicates to return all signatures that match specified criteria.

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsearchoptions/text.md

#### text property

Specifies signature text to match on searching.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### TextSignOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions.md

#### TextSignOptions class

Represents the Text signature options.

**Inheritance:** `TextSignOptions` →
`SignOptions`

The TextSignOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextSignOptions class with default values. |
| __init__ | Initializes a new instance of the TextSignOptions class with text. |

##### Properties
| Property | Description |
| :- | :- |
| page_number | Gets or sets document page number for signing.
<br/>Minimal and default value is 1. |
| all_pages | Put signature on all document pages. |
| appearance | Additional signature appearance. |
| extensions | Signature Extensions. |
| pages_setup | Options to specify pages to be signed. |
| signature_type | Get the Signature Type `SignatureType` |
| document_type | Get or set the Document Type of the Signature Options `DocumentType` |
| z_order | Gets or sets the Z-order position of text signature.
<br/>Determines the display order of overlapping signatures. |
| hash_algorithm | Gets or sets the hash algorithm to be used for cryptographic operations.
<br/>Supported exclusively for digital signatures in PDF files. |
| left | Left X position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if horizontal alignment is not specified). |
| top | Top Y Position of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
<br/>(works if vertical alignment is not specified). |
| width | Width of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| height | Height of Signature on Document Page in Measure values
<br/>(pixels, percents or millimeters see `MeasureType` SizeMeasureType property). |
| location_measure_type | Measure type (pixels, percents or millimeters) for Left and Top properties. |
| size_measure_type | Measure type (pixels, percents or millimeters) for Width and Height properties. |
| stretch | Stretch mode on Document Page. |
| rotation_angle | Rotation angle of signature on document page (clockwise). |
| horizontal_alignment | Horizontal alignment of signature on document page. |
| vertical_alignment | Vertical alignment of signature on document page. |
| margin | Gets or sets the space between Sign and Document edges.
<br/>(works ONLY if horizontal or vertical alignment are specified). |
| margin_measure_type | Gets or sets the measure type (pixels, percents or millimeters) for Margin. |
| transparency | Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque). |
| text | Gets or sets the text of signature. |
| font | Gets or sets the font of signature. |
| fore_color | Gets or sets the fore color of signature. |
| signature_implementation | Gets or sets the type of text signature implementation. |
| text_horizontal_alignment | Horizontal alignment of text inside a signature.
<br/>This feature is supported only for Image and Annotation signature implementations
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| text_vertical_alignment | Vertical alignment of text inside a signature.
<br/>This feature is supported only for Image signature implementation
<br/>(see `TextSignatureImplementation` SignatureImplementation property). |
| form_text_field_title | Gets or sets the title of text form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField. |
| form_text_field_type | Gets or sets the type of form field to put text signature into it.
<br/>This property could be used only with SignatureImplementation = TextToFormField.
<br/>Value by default is AllTextTypes. |
| shape_type | Gets or sets the type of shape to put text.
<br/>This property could be used only with SignatureImplementation = TextStamp.
<br/>Value by default is Rectangle. |
| signature_id | Gets or sets the unique ID of signature. It can be used in signature verification options.
<br/>Property is supported for Pdf documents only. |
| border | Specify border settings |
| background | Gets or sets the signature background settings. |
| native | Gets or sets the native attribute. If it is set document specific signatures could be used.
<br/>Native text watermark for WordProcessing documents is different than regular, for example. |
| shape_position | Defines where shape should be presented in the document layout. Avaliable only for Word documents |

##### Remarks

**Learn more** |
|
 |
 |

### TextSignOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/__init__.md

#### __init__

Initializes a new instance of the TextSignOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the TextSignOptions class with text.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Signature text. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/all_pages.md

#### all_pages property

Put signature on all document pages.

### appearance property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/appearance.md

#### appearance property

Additional signature appearance.

### background property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/background.md

#### background property

Gets or sets the signature background settings.
##### Definition:
```python
@property
def background(self):
    ...
@background.setter
def background(self, value):
    ...
```

### border property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/border.md

#### border property

Specify border settings
##### Definition:
```python
@property
def border(self):
    ...
@border.setter
def border(self, value):
    ...
```

### document_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/document_type.md

#### document_type property

Get or set the Document Type of the Signature Options `DocumentType`

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/extensions.md

#### extensions property

Signature Extensions.

### font property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/font.md

#### font property

Gets or sets the font of signature.
##### Definition:
```python
@property
def font(self):
    ...
@font.setter
def font(self, value):
    ...
```

### fore_color property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/fore_color.md

#### fore_color property

Gets or sets the fore color of signature.
##### Definition:
```python
@property
def fore_color(self):
    ...
@fore_color.setter
def fore_color(self, value):
    ...
```

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of text form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
##### Definition:
```python
@property
def form_text_field_title(self):
    ...
@form_text_field_title.setter
def form_text_field_title(self, value):
    ...
```

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to put text signature into it.
This property could be used only with SignatureImplementation = TextToFormField.
Value by default is AllTextTypes.
##### Definition:
```python
@property
def form_text_field_type(self):
    ...
@form_text_field_type.setter
def form_text_field_type(self, value):
    ...
```

### hash_algorithm property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/hash_algorithm.md

#### hash_algorithm property

Gets or sets the hash algorithm to be used for cryptographic operations.
Supported exclusively for digital signatures in PDF files.

### height property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/height.md

#### height property

Height of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/horizontal_alignment.md

#### horizontal_alignment property

Horizontal alignment of signature on document page.
##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
@horizontal_alignment.setter
def horizontal_alignment(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/left.md

#### left property

Left X position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if horizontal alignment is not specified).
##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### location_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/location_measure_type.md

#### location_measure_type property

Measure type (pixels, percents or millimeters) for Left and Top properties.
##### Definition:
```python
@property
def location_measure_type(self):
    ...
@location_measure_type.setter
def location_measure_type(self, value):
    ...
```

### margin property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/margin.md

#### margin property

Gets or sets the space between Sign and Document edges.
(works ONLY if horizontal or vertical alignment are specified).
##### Definition:
```python
@property
def margin(self):
    ...
@margin.setter
def margin(self, value):
    ...
```

### margin_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/margin_measure_type.md

#### margin_measure_type property

Gets or sets the measure type (pixels, percents or millimeters) for Margin.
##### Definition:
```python
@property
def margin_measure_type(self):
    ...
@margin_measure_type.setter
def margin_measure_type(self, value):
    ...
```

### native property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/native.md

#### native property

Gets or sets the native attribute. If it is set document specific signatures could be used.
Native text watermark for WordProcessing documents is different than regular, for example.
##### Definition:
```python
@property
def native(self):
    ...
@native.setter
def native(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/page_number.md

#### page_number property

Gets or sets document page number for signing.
Minimal and default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/pages_setup.md

#### pages_setup property

Options to specify pages to be signed.

### rotation_angle property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/rotation_angle.md

#### rotation_angle property

Rotation angle of signature on document page (clockwise).
##### Definition:
```python
@property
def rotation_angle(self):
    ...
@rotation_angle.setter
def rotation_angle(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/shape_position.md

#### shape_position property

Defines where shape should be presented in the document layout. Avaliable only for Word documents
##### Definition:
```python
@property
def shape_position(self):
    ...
@shape_position.setter
def shape_position(self, value):
    ...
```

### shape_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/shape_type.md

#### shape_type property

Gets or sets the type of shape to put text.
This property could be used only with SignatureImplementation = TextStamp.
Value by default is Rectangle.
##### Definition:
```python
@property
def shape_type(self):
    ...
@shape_type.setter
def shape_type(self, value):
    ...
```

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/signature_id.md

#### signature_id property

Gets or sets the unique ID of signature. It can be used in signature verification options.
Property is supported for Pdf documents only.
##### Definition:
```python
@property
def signature_id(self):
    ...
@signature_id.setter
def signature_id(self, value):
    ...
```

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/signature_implementation.md

#### signature_implementation property

Gets or sets the type of text signature implementation.
##### Definition:
```python
@property
def signature_implementation(self):
    ...
@signature_implementation.setter
def signature_implementation(self, value):
    ...
```

### signature_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/signature_type.md

#### signature_type property

Get the Signature Type `SignatureType`

### size_measure_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/size_measure_type.md

#### size_measure_type property

Measure type (pixels, percents or millimeters) for Width and Height properties.
##### Definition:
```python
@property
def size_measure_type(self):
    ...
@size_measure_type.setter
def size_measure_type(self, value):
    ...
```

### stretch property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/stretch.md

#### stretch property

Stretch mode on Document Page.
##### Definition:
```python
@property
def stretch(self):
    ...
@stretch.setter
def stretch(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/text.md

#### text property

Gets or sets the text of signature.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### text_horizontal_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/text_horizontal_alignment.md

#### text_horizontal_alignment property

Horizontal alignment of text inside a signature.
This feature is supported only for Image and Annotation signature implementations
(see `TextSignatureImplementation` SignatureImplementation property).
##### Definition:
```python
@property
def text_horizontal_alignment(self):
    ...
@text_horizontal_alignment.setter
def text_horizontal_alignment(self, value):
    ...
```

### text_vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/text_vertical_alignment.md

#### text_vertical_alignment property

Vertical alignment of text inside a signature.
This feature is supported only for Image signature implementation
(see `TextSignatureImplementation` SignatureImplementation property).
##### Definition:
```python
@property
def text_vertical_alignment(self):
    ...
@text_vertical_alignment.setter
def text_vertical_alignment(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/top.md

#### top property

Top Y Position of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` LocationMeasureType property).
(works if vertical alignment is not specified).
##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/transparency.md

#### transparency property

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/vertical_alignment.md

#### vertical_alignment property

Vertical alignment of signature on document page.
##### Definition:
```python
@property
def vertical_alignment(self):
    ...
@vertical_alignment.setter
def vertical_alignment(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/width.md

#### width property

Width of Signature on Document Page in Measure values
(pixels, percents or millimeters see `MeasureType` SizeMeasureType property).
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### z_order property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textsignoptions/z_order.md

#### z_order property

Gets or sets the Z-order position of text signature.
Determines the display order of overlapping signatures.

### TextVerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions.md

#### TextVerifyOptions class

Keeps options to verify document Text signature.

**Inheritance:** `TextVerifyOptions` →
`VerifyOptions`

The TextVerifyOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextVerifyOptions with default values. |
| __init__ | Initializes a new instance of the TextVerifyOptions with verification text. |
| __init__ | Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation. |

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |
| text | Specify Signature Text if it should be verified. |
| match_type | Gets or sets Text Match Type verification. |
| signature_implementation | Type of Signature to be verified. |
| form_text_field_title | Gets or sets the title of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| form_text_field_type | Gets or sets the type of form field to verify it.
<br/>If this property set text will be found only in text form fields. |
| signature_id | Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents |

##### Remarks

**Learn more** |
|
 |
 |

### TextVerifyOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/__init__.md

#### __init__

Initializes a new instance of the TextVerifyOptions with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the TextVerifyOptions with verification text.

```python
def __init__(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Text to be verified |

#### __init__

Initializes a new instance of the TextVerifyOptions with Text property to verify and signature implementation.

```python
def __init__(self, text, implementation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | Text to be verified. |
| implementation | groupdocs.signature.domain.TextSignatureImplementation | Signature Implementation type. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.

### form_text_field_title property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/form_text_field_title.md

#### form_text_field_title property

Gets or sets the title of form field to verify it.
If this property set text will be found only in text form fields.
##### Definition:
```python
@property
def form_text_field_title(self):
    ...
@form_text_field_title.setter
def form_text_field_title(self, value):
    ...
```

### form_text_field_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/form_text_field_type.md

#### form_text_field_type property

Gets or sets the type of form field to verify it.
If this property set text will be found only in text form fields.
##### Definition:
```python
@property
def form_text_field_type(self):
    ...
@form_text_field_type.setter
def form_text_field_type(self, value):
    ...
```

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/is_valid.md

#### is_valid property

Valid property flag.

### match_type property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/match_type.md

#### match_type property

Gets or sets Text Match Type verification.
##### Definition:
```python
@property
def match_type(self):
    ...
@match_type.setter
def match_type(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers

### signature_id property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/signature_id.md

#### signature_id property

Specify Text Signature ID more than zero if it should be verified. This property is supported only for Pdf documents
##### Definition:
```python
@property
def signature_id(self):
    ...
@signature_id.setter
def signature_id(self, value):
    ...
```

### signature_implementation property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/signature_implementation.md

#### signature_implementation property

Type of Signature to be verified.
##### Definition:
```python
@property
def signature_implementation(self):
    ...
@signature_implementation.setter
def signature_implementation(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/textverifyoptions/text.md

#### text property

Specify Signature Text if it should be verified.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### TiffFormat enumeration
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffformat.md

#### TiffFormat enumeration

Specifies different tiff formats.

The TiffFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Default. |
| TIFF_LZW_BW | LzwBw. |
| TIFF_LZW_RGB | LzwRgb. |
| TIFF_LZW_RGBA | LzwRgba. |
| TIFF_CCITT_FAX3 | CcittFax3. |
| TIFF_CCITT_FAX4 | CcittFax4. |
| TIFF_DEFLATE_BW | DeflateBw. |
| TIFF_DEFLATE_RGB | DeflateRgb. |
| TIFF_CCIT_RLE | CcitRle. |
| TIFF_JPEG_RGB | JpegRgb. |
| TIFF_JPEG_Y_CB_CR | JpegYCbCr. |
| TIFF_NO_COMPRESSION_BW | NoCompressionBw. |
| TIFF_NO_COMPRESSION_RGB | NoCompressionRgb. |
| TIFF_NO_COMPRESSION_RGBA | NoCompressionRgba. |

### TiffSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions.md

#### TiffSaveOptions class

Tiff Save options for image documents.

**Inheritance:** `TiffSaveOptions` →
`ImageSaveOptions` →
`SaveOptions`

The TiffSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates TiffSaveOptions with default values. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |
| expected_tiff_format | Gets or sets TIFF format of signed document. |

### TiffSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/__init__.md

#### __init__

Creates TiffSaveOptions with default values.

```python
def __init__(self):
    ...
```

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### expected_tiff_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/expected_tiff_format.md

#### expected_tiff_format property

Gets or sets TIFF format of signed document.
##### Definition:
```python
@property
def expected_tiff_format(self):
    ...
@expected_tiff_format.setter
def expected_tiff_format(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/tiffsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### VerifyExtensions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyextensions.md

#### VerifyExtensions class

Keeps additional verification options for alternative implementations of signature on a document page.

The VerifyExtensions type exposes the following members:

### VerifyOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions.md

#### VerifyOptions class

Keeps options to verify document.

The VerifyOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| is_valid | Valid property flag. |
| page_number | Document Page Number to be verified. If property is not set - all Pages of
<br/>Document will be verified for first occurrence.
<br/>Minimal value is 1. |
| pages_setup | Page Options to specify pages to be verified. |
| all_pages | Flag to verify each document page. By default value is true. |
| shape_position | Specifies shape position in the document layout. For verifing signatures in headers/footers |
| extensions | Additional extensions for alternative signature options verification. |

### all_pages property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/all_pages.md

#### all_pages property

Flag to verify each document page. By default value is true.
##### Definition:
```python
@property
def all_pages(self):
    ...
@all_pages.setter
def all_pages(self, value):
    ...
```

### extensions property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/extensions.md

#### extensions property

Additional extensions for alternative signature options verification.
##### Definition:
```python
@property
def extensions(self):
    ...
@extensions.setter
def extensions(self, value):
    ...
```

### is_valid property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/is_valid.md

#### is_valid property

Valid property flag.
##### Definition:
```python
@property
def is_valid(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/page_number.md

#### page_number property

Document Page Number to be verified. If property is not set - all Pages of
Document will be verified for first occurrence.
Minimal value is 1.
##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/pages_setup.md

#### pages_setup property

Page Options to specify pages to be verified.
##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### shape_position property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/verifyoptions/shape_position.md

#### shape_position property

Specifies shape position in the document layout. For verifing signatures in headers/footers
##### Definition:
```python
@property
def shape_position(self):
    ...
@shape_position.setter
def shape_position(self, value):
    ...
```

### WordProcessingSaveOptions class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Save options for WordProcessing documents.

**Inheritance:** `WordProcessingSaveOptions` →
`SaveOptions`

The WordProcessingSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of WordProcessingSaveOptions class with default values. |
| __init__ | Initializes a new instance of WordProcessingSaveOptions class with specified output file format. |
| __init__ | Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag. |
| __init__ | Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag. |

##### Properties
| Property | Description |
| :- | :- |
| overwrite_existing_files | Gets or sets whether to overwrite existing file with new output file.
<br/>Otherwise new file will be created with number as suffix.
<br/>By default this value set to true that means file will be overwritten. |
| password | Gets or sets password to save signed document with password protection.
<br/>This property is not supported for Image documents. |
| use_original_password | Gets or sets whether to use password from LoadOptions to save signed document as protected.
<br/>Default value is true.
<br/>This property is not supported for Image documents. |
| add_missing_extenstion | Gets or sets flag to automatically add extension when it was missing in output file path
<br/>Default value is false. |
| file_format | Gets or sets file format of signed document. |

### WordProcessingSaveOptions constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/__init__.md

#### __init__

Initializes a new instance of WordProcessingSaveOptions class with default values.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of WordProcessingSaveOptions class with specified output file format.

```python
def __init__(self, file_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.WordProcessingSaveFileFormat | Output file type `WordProcessingSaveFileFormat`. |

#### __init__

Initializes a new instance of WordProcessingSaveOptions class with specified output type and overwrite flag.

```python
def __init__(self, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

#### __init__

Initializes a new instance of WordProcessingSaveOptions class with specified output file format and overwrite flag.

```python
def __init__(self, file_format, overwrite_existing_file):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | groupdocs.signature.domain.WordProcessingSaveFileFormat | Output file type `WordProcessingSaveFileFormat`. |
| overwrite_existing_file | bool | Flag whether to overwrite signed file with same file. |

### add_missing_extenstion property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/add_missing_extenstion.md

#### add_missing_extenstion property

Gets or sets flag to automatically add extension when it was missing in output file path
Default value is false.

### file_format property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/file_format.md

#### file_format property

Gets or sets file format of signed document.
##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### overwrite_existing_files property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/overwrite_existing_files.md

#### overwrite_existing_files property

Gets or sets whether to overwrite existing file with new output file.
Otherwise new file will be created with number as suffix.
By default this value set to true that means file will be overwritten.

### password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/password.md

#### password property

Gets or sets password to save signed document with password protection.
This property is not supported for Image documents.

### use_original_password property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.options/wordprocessingsaveoptions/use_original_password.md

#### use_original_password property

Gets or sets whether to use password from LoadOptions to save signed document as protected.
Default value is true.
This property is not supported for Image documents.

### groupdocs.signature
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature.md

The namespace provides classes for signing documents of different formats with stamps, barcodes, QR-codes, text, image, metadata, form field and digital signatures.

The main classes in this namespace are:
|
|
 |
 |

##### Classes
| Class | Description |
| :- | :- |
| `GroupDocsSignatureException` | Represents the generic errors that occur during document processing. |
| `IncorrectPasswordException` | The exception that is thrown when specified password is incorrect. |
| `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. |
| `PasswordRequiredException` | The exception that is thrown when password is required to load the document. |
| `ProcessCompleteEventArgs` | Provides data on complete event of signing, verification and search processes. |
| `ProcessEventArgs` | Provides data for different events of signature, verification and search processes. |
| `ProcessProgressEventArgs` | Provides data for OnProgress event of signing, verification and search processes. |
| `ProcessStartEventArgs` | Provides data for Start event of signing, verification and search process |
| `Signature` | Represents main class that controls document signing process. |
| `SignatureSettings` | Defines settings for customizing `Signature` behavior. |

### GroupDocsSignatureException class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/groupdocssignatureexception.md

#### GroupDocsSignatureException class

Represents the generic errors that occur during document processing.

The GroupDocsSignatureException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `GroupDocsSignatureException` class. |
| __init__ | Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message. |

### GroupDocsSignatureException constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/groupdocssignatureexception/__init__.md

#### __init__

Initializes a new instance of the `GroupDocsSignatureException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `GroupDocsSignatureException` class with a specified error message.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

**Inheritance:** `IncorrectPasswordException` →
`GroupDocsSignatureException`

The IncorrectPasswordException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/license.md

#### License class

Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing).

The License type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Instantiate the License |

##### Methods
| Method | Description |
| :- | :- |
| set_license | Licenses the component. |
| set_license | Licenses the component. |

##### Remarks

**Learn more** |
|
 |
 |

### License constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/license/__init__.md

#### __init__

Instantiate the License

```python
def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/license/set_license.md

#### set_license

Licenses the component.

```python
def set_license(self, license_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_path | System.String | The license path. |

##### Example

The following example demonstrates how to set a license
passing a path to the license file.

#### set_license

Licenses the component.

```python
def set_license(self, license_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| license_stream | io.RawIOBase | The license stream. |

##### Example

The following example demonstrates how to set a license
passing Stream of the license file.

### Metered class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/metered.md

#### Metered class

Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license.

The Metered type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of Metered |

##### Methods
| Method | Description |
| :- | :- |
| set_metered_key | Activates product with Metered keys. |
| get_consumption_quantity | Retrieves amount of MBs processed. |
| get_consumption_credit | Retrieves count of credits consumed. |

##### Remarks

**Learn more** |
|
 |
 |

### Metered constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/metered/__init__.md

#### __init__

Constructs a new instance of Metered

```python
def __init__(self):
    ...
```

### get_consumption_credit method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/metered/get_consumption_credit.md

#### get_consumption_credit

Retrieves count of credits consumed.

```python
def get_consumption_credit(self):
    ...
```

##### Example

Following example demonstrates how to retrieve count of credits consumed.

### get_consumption_quantity method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/metered/get_consumption_quantity.md

#### get_consumption_quantity

Retrieves amount of MBs processed.

```python
def get_consumption_quantity(self):
    ...
```

##### Example

Following example demonstrates how to retrieve amount of MBs processed.

### set_metered_key method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/metered/set_metered_key.md

#### set_metered_key

Activates product with Metered keys.

```python
def set_metered_key(self, public_key, private_key):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| public_key | System.String | The public key. |
| private_key | System.String | The private key. |

##### Example

Following example demonstrates how to activate product with Metered keys.

### PasswordRequiredException class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

**Inheritance:** `PasswordRequiredException` →
`GroupDocsSignatureException`

The PasswordRequiredException type exposes the following members:

### ProcessCompleteEventArgs class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs.md

#### ProcessCompleteEventArgs class

Provides data on complete event of signing, verification and search processes.

**Inheritance:** `ProcessCompleteEventArgs` →
`ProcessEventArgs`

The ProcessCompleteEventArgs type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| status | Indicates current process state. |
| completed | Represents the time mark of process completion. |
| ticks | Represents the time in milliseconds spent since process Start event. |
| total_signatures | Represents the total quantity of processed signatures. |
| canceled | Indicates whether process was canceled. |

### canceled property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs/canceled.md

#### canceled property

Indicates whether process was canceled.
##### Definition:
```python
@property
def canceled(self):
    ...
```

### completed property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs/completed.md

#### completed property

Represents the time mark of process completion.
##### Definition:
```python
@property
def completed(self):
    ...
@completed.setter
def completed(self, value):
    ...
```

### status property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs/status.md

#### status property

Indicates current process state.

### ticks property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs/ticks.md

#### ticks property

Represents the time in milliseconds spent since process Start event.
##### Definition:
```python
@property
def ticks(self):
    ...
@ticks.setter
def ticks(self, value):
    ...
```

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processcompleteeventargs/total_signatures.md

#### total_signatures property

Represents the total quantity of processed signatures.
##### Definition:
```python
@property
def total_signatures(self):
    ...
@total_signatures.setter
def total_signatures(self, value):
    ...
```

### ProcessEventArgs class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processeventargs.md

#### ProcessEventArgs class

Provides data for different events of signature, verification and search processes.

The ProcessEventArgs type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of ProcessEventArgs |

##### Properties
| Property | Description |
| :- | :- |
| status | Indicates current process state. |

### ProcessEventArgs constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processeventargs/__init__.md

#### __init__

Constructs a new instance of ProcessEventArgs

```python
def __init__(self):
    ...
```

### status property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processeventargs/status.md

#### status property

Indicates current process state.
##### Definition:
```python
@property
def status(self):
    ...
@status.setter
def status(self, value):
    ...
```

### ProcessProgressEventArgs class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs.md

#### ProcessProgressEventArgs class

Provides data for OnProgress event of signing, verification and search processes.

**Inheritance:** `ProcessProgressEventArgs` →
`ProcessEventArgs`

The ProcessProgressEventArgs type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of ProcessProgressEventArgs |

##### Properties
| Property | Description |
| :- | :- |
| status | Indicates current process state. |
| progress | Represents the progress in percents. Value range is from 0 to 100. |
| ticks | Represents the time spent in milliseconds since process Start event. |
| processed_signatures | Represents the quantity of processed signatures. |
| cancel | Indicates whether process should be canceled. |

### ProcessProgressEventArgs constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/__init__.md

#### __init__

Constructs a new instance of ProcessProgressEventArgs

```python
def __init__(self):
    ...
```

### cancel property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/cancel.md

#### cancel property

Indicates whether process should be canceled.
##### Definition:
```python
@property
def cancel(self):
    ...
@cancel.setter
def cancel(self, value):
    ...
```

### processed_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/processed_signatures.md

#### processed_signatures property

Represents the quantity of processed signatures.
##### Definition:
```python
@property
def processed_signatures(self):
    ...
@processed_signatures.setter
def processed_signatures(self, value):
    ...
```

### progress property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/progress.md

#### progress property

Represents the progress in percents. Value range is from 0 to 100.
##### Definition:
```python
@property
def progress(self):
    ...
@progress.setter
def progress(self, value):
    ...
```

### status property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/status.md

#### status property

Indicates current process state.

### ticks property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processprogresseventargs/ticks.md

#### ticks property

Represents the time spent in milliseconds since process Start event.
##### Definition:
```python
@property
def ticks(self):
    ...
@ticks.setter
def ticks(self, value):
    ...
```

### ProcessStartEventArgs class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processstarteventargs.md

#### ProcessStartEventArgs class

Provides data for Start event of signing, verification and search process

**Inheritance:** `ProcessStartEventArgs` →
`ProcessEventArgs`

The ProcessStartEventArgs type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Constructs a new instance of ProcessStartEventArgs |

##### Properties
| Property | Description |
| :- | :- |
| status | Indicates current process state. |
| started | Represents the time mark of process start. |
| total_signatures | Represents the total quantity of signatures to be processed. |

### ProcessStartEventArgs constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processstarteventargs/__init__.md

#### __init__

Constructs a new instance of ProcessStartEventArgs

```python
def __init__(self):
    ...
```

### started property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processstarteventargs/started.md

#### started property

Represents the time mark of process start.
##### Definition:
```python
@property
def started(self):
    ...
@started.setter
def started(self, value):
    ...
```

### status property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processstarteventargs/status.md

#### status property

Indicates current process state.

### total_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/processstarteventargs/total_signatures.md

#### total_signatures property

Represents the total quantity of signatures to be processed.
##### Definition:
```python
@property
def total_signatures(self):
    ...
@total_signatures.setter
def total_signatures(self, value):
    ...
```

### Signature class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature.md

#### Signature class

Represents main class that controls document signing process.

The Signature type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes new instance of `Signature` class with document provided by stream. |
| __init__ | Initializes new instance of `Signature` class with document provided by stream and load options `Signature.LoadOptions`. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by stream and `SignatureSettings`. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by stream, load options `Signature.LoadOptions` and settings `SignatureSettings`. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by file path. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by file path and `Signature.LoadOptions`. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by file path and `SignatureSettings`. |
| __init__ | Initializes new instance of `Signature` class instance with document provided by file path, `Signature.LoadOptions` and `SignatureSettings`. |

##### Methods
| Method | Description |
| :- | :- |
| sign | Signs document with `SignOptions` and saves result to a stream. |
| sign | Signs document with `SignOptions` and saves result to a stream with predefined `SaveOptions`. |
| sign |  |
| sign |  |
| sign | Signs document with `SignOptions` and saves result to specified file path. |
| sign | Signs document with `SignOptions` and saves result to specified file path with predefined `SaveOptions`. |
| sign |  |
| sign |  |
| verify | Verifies the document signatures with given VerifyOptions data. |
| verify |  |
| search |  |
| search | Searches for specified signature types in the document by `SignatureType` value. |
| update | Updates passed signature `BaseSignature` in the document. |
| update |  |
| delete | Deletes passed signature `BaseSignature` from the document. |
| delete |  |
| delete | Deletes signatures of the certain type `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `BaseSignature.is_signature`  will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code |
| delete |  |
| delete | Deletes signature by its specific signature Id from the document. |
| delete |  |
| get_document_info | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| generate_preview | Generates document pages preview. |
| generate_signature_preview | Generates Signature preview based on given SignOptions. `SignOptions` |

##### Remarks

**Learn more** |
|
 |

### Signature constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/__init__.md

#### __init__

Initializes new instance of `Signature` class with document provided by stream.

```python
def __init__(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The document content stream. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Absolute or relative file path. |

#### __init__

Initializes new instance of `Signature` class with document provided by stream and load options `Signature.LoadOptions`.

```python
def __init__(self, document, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The document content stream. |
| load_options | groupdocs.signature.options.LoadOptions | The document load options. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by stream and `SignatureSettings`.

```python
def __init__(self, document, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The document content stream. |
| settings | groupdocs.signature.SignatureSettings | The signature settings. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by file path and `Signature.LoadOptions`.

```python
def __init__(self, file_path, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Absolute or relative file path. |
| load_options | groupdocs.signature.options.LoadOptions | The document load options. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by file path and `SignatureSettings`.

```python
def __init__(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Absolute or relative file path. |
| settings | groupdocs.signature.SignatureSettings | The signature settings. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by stream, load options `Signature.LoadOptions` and settings `SignatureSettings`.

```python
def __init__(self, document, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The document content stream. |
| load_options | groupdocs.signature.options.LoadOptions | The document load options. |
| settings | groupdocs.signature.SignatureSettings | The signature settings. |

#### __init__

Initializes new instance of `Signature` class instance with document provided by file path, `Signature.LoadOptions` and `SignatureSettings`.

```python
def __init__(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | Absolute or relative file path. |
| load_options | groupdocs.signature.options.LoadOptions | The document load options. |
| settings | groupdocs.signature.SignatureSettings | The signature settings. |

### delete method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/delete.md

#### delete

Deletes passed signature `BaseSignature` from the document.

##### Returns

Returns true if operation was successful.

```python
def delete(self, signature):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature | groupdocs.signature.domain.BaseSignature | Signature object to be removed from the document. |

#### delete

```python
def delete(self, signatures):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signatures | System.Collections.Generic.List`1[[GroupDocs.Signature.Domain.BaseSignature]] |  |

#### delete

Deletes signatures of the certain type `SignatureType` from the document. Only signatures that were added by Sign method and marked as Signatures `BaseSignature.is_signature`  will be removed. Following signature types are supported: Text, Image, Digital, Barcode, QR-Code

##### Returns

Returns DeleteResult `DeleteResult` with list of successfully deleted signatures and failed ones.

```python
def delete(self, signature_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_type | groupdocs.signature.domain.SignatureType | The type of signatures to be removed from the document. |

#### delete

```python
def delete(self, signature_types):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_types | System.Collections.Generic.List`1[[GroupDocs.Signature.Domain.SignatureType]] |  |

#### delete

Deletes signature by its specific signature Id from the document.

##### Returns

Returns true if operation was successful.

```python
def delete(self, signature_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_id | System.String | The Id of the signature to be removed from the document. |

#### delete

```python
def delete(self, signature_ids):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_ids | System.Collections.Generic.List`1[[System.String]] |  |

### generate_preview method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/generate_preview.md

#### generate_preview

Generates document pages preview.

```python
def generate_preview(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | groupdocs.signature.options.PreviewOptions | The preview options. |

### generate_signature_preview method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/generate_signature_preview.md

#### generate_signature_preview

Generates Signature preview based on given SignOptions. `SignOptions`

```python
def generate_signature_preview(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | groupdocs.signature.options.PreviewSignatureOptions | The preview signature with given SignOptions. `PreviewSignatureOptions` |

### get_document_info method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/get_document_info.md

#### get_document_info

Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

##### Returns

Information about document.

```python
def get_document_info(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/search.md

#### search

```python
def search(self, search_options_list):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.SearchOptions]] |  |

#### search

Searches for specified signature types in the document by `SignatureType` value.

##### Returns

Returns instance of `SearchResult` with list of found signatures.

```python
def search(self, signature_types):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature_types | list | One or several types of signatures to find. |

### sign method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/sign.md

#### sign

Signs document with `SignOptions` and saves result to a stream.

##### Returns

Returns instance of `SignResult` with list of newly created signatures.

```python
def sign(self, document, sign_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The output document stream. |
| sign_options | groupdocs.signature.options.SignOptions | The signature options. |

#### sign

```python
def sign(self, document, sign_options_list):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase |  |
| sign_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.SignOptions]] |  |

#### sign

Signs document with `SignOptions` and saves result to specified file path.

##### Returns

Returns instance of `SignResult` with list of newly created signatures.

```python
def sign(self, file_path, sign_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The output file path. |
| sign_options | groupdocs.signature.options.SignOptions | The signature options. |

#### sign

```python
def sign(self, file_path, sign_options_list):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String |  |
| sign_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.SignOptions]] |  |

#### sign

Signs document with `SignOptions` and saves result to a stream with predefined `SaveOptions`.

##### Returns

Returns instance of `SignResult` with list of newly created signatures.

```python
def sign(self, document, sign_options, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase | The output document stream. |
| sign_options | groupdocs.signature.options.SignOptions | The signature options. |
| save_options | groupdocs.signature.options.SaveOptions | The save options. |

#### sign

```python
def sign(self, document, sign_options_list, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | io.RawIOBase |  |
| sign_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.SignOptions]] |  |
| save_options | groupdocs.signature.options.SaveOptions |  |

#### sign

Signs document with `SignOptions` and saves result to specified file path with predefined `SaveOptions`.

##### Returns

Returns instance of `SignResult` with list of newly created signatures.

```python
def sign(self, file_path, sign_options, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The output file path. |
| sign_options | groupdocs.signature.options.SignOptions | The signature options. |
| save_options | groupdocs.signature.options.SaveOptions | The save options. |

#### sign

```python
def sign(self, file_path, sign_options_list, save_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String |  |
| sign_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.SignOptions]] |  |
| save_options | groupdocs.signature.options.SaveOptions |  |

### update method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/update.md

#### update

Updates passed signature `BaseSignature` in the document.

##### Returns

Returns true if operation was successful.

```python
def update(self, signature):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signature | groupdocs.signature.domain.BaseSignature | Signature object to be updated in the document. |

#### update

```python
def update(self, signatures):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| signatures | System.Collections.Generic.List`1[[GroupDocs.Signature.Domain.BaseSignature]] |  |

### verify method
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signature/verify.md

#### verify

Verifies the document signatures with given VerifyOptions data.

##### Returns

Returns instance of `VerificationResult`. Property VerificationResult.IsValid returns true if verification process was successful.

```python
def verify(self, verify_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| verify_options | groupdocs.signature.options.VerifyOptions | The signature verification options. |

#### verify

```python
def verify(self, verify_options_list):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| verify_options_list | System.Collections.Generic.List`1[[GroupDocs.Signature.Options.VerifyOptions]] |  |

### SignatureSettings class
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings.md

#### SignatureSettings class

Defines settings for customizing `Signature` behavior.

The SignatureSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Creates default SignatureSettings instance with default values. |
| __init__ | Creates default SignatureSettings instance with the Logger implementation. |

##### Properties
| Property | Description |
| :- | :- |
| show_deleted_signatures_info | Gets or sets flag that includes deleted signatures into Document Info result.
<br/>Each Signature `BaseSignature` has Deleted flag `BaseSignature.deleted` to detect if it was deleted. |
| save_document_on_empty_update | Gets or sets flag to re-save source document when Update method has no signatures to update.
<br/>If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update.
<br/>When this flat is set to false source document will not be modified at all. |
| save_document_on_empty_delete | Gets or sets flag to re-save source document when Delete method has no affected signatures to remove.
<br/>If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove.
<br/>When this flat is set to false source document will not be modified at all. |
| include_standard_metadata_signatures | Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
<br/>If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures.
<br/>When this flag is set to true the document information will include these standard metadata signatures. |
| logger | The logger implementation used for logging (Errors, Warnings, Traces). `ILogger`. |
| log_level | The level of the logging to limit the messages (All, Traces, Warnings, Errors). `SignatureSettings.log_level`.
<br/>BY default the All level type is set. |

### SignatureSettings constructor
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/__init__.md

#### __init__

Creates default SignatureSettings instance with default values.

```python
def __init__(self):
    ...
```

#### __init__

Creates default SignatureSettings instance with the Logger implementation.

```python
def __init__(self, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | groupdocs.signature.logging.ILogger |  |

### include_standard_metadata_signatures property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/include_standard_metadata_signatures.md

#### include_standard_metadata_signatures property

Gets or sets flag to include into the Metadata List the embedded standard document metadata signatures like Author, Owner, document creation date, modified date, etc.
If this flag is set to false (by default) the GetDocumentInfo will not include these metadata signatures.
When this flag is set to true the document information will include these standard metadata signatures.
##### Definition:
```python
@property
def include_standard_metadata_signatures(self):
    ...
@include_standard_metadata_signatures.setter
def include_standard_metadata_signatures(self, value):
    ...
```

### log_level property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/log_level.md

#### log_level property

The level of the logging to limit the messages (All, Traces, Warnings, Errors). `SignatureSettings.log_level`.
BY default the All level type is set.
##### Definition:
```python
@property
def log_level(self):
    ...
@log_level.setter
def log_level(self, value):
    ...
```

### logger property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/logger.md

#### logger property

The logger implementation used for logging (Errors, Warnings, Traces). `ILogger`.
##### Definition:
```python
@property
def logger(self):
    ...
```

### save_document_on_empty_delete property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/save_document_on_empty_delete.md

#### save_document_on_empty_delete property

Gets or sets flag to re-save source document when Delete method has no affected signatures to remove.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Delete method has no signatures to remove.
When this flat is set to false source document will not be modified at all.
##### Definition:
```python
@property
def save_document_on_empty_delete(self):
    ...
@save_document_on_empty_delete.setter
def save_document_on_empty_delete(self, value):
    ...
```

### save_document_on_empty_update property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/save_document_on_empty_update.md

#### save_document_on_empty_update property

Gets or sets flag to re-save source document when Update method has no signatures to update.
If this flag is set to true (by default) document will be saving with corresponding history process log (date and operation type) even if Update method has no signatures to update.
When this flat is set to false source document will not be modified at all.
##### Definition:
```python
@property
def save_document_on_empty_update(self):
    ...
@save_document_on_empty_update.setter
def save_document_on_empty_update(self, value):
    ...
```

### show_deleted_signatures_info property
Path: https://reference.groupdocs.com/signature/python-net/groupdocs.signature/signaturesettings/show_deleted_signatures_info.md

#### show_deleted_signatures_info property

Gets or sets flag that includes deleted signatures into Document Info result.
Each Signature `BaseSignature` has Deleted flag `BaseSignature.deleted` to detect if it was deleted.
##### Definition:
```python
@property
def show_deleted_signatures_info(self):
    ...
@show_deleted_signatures_info.setter
def show_deleted_signatures_info(self, value):
    ...
```


# GroupDocs.Viewer

> Render documents and images to HTML, image, or PDF across 170+ formats.

## Java

### GroupDocs.Viewer for Java
Path: https://reference.groupdocs.com/viewer/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.viewer | The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results. |
| com.groupdocs.viewer.caching | The package provides classes for customizing caching behavior. |
| com.groupdocs.viewer.caching.extra | The package provides functionality for using custom models in cache implementation. |
| com.groupdocs.viewer.drawing | The package provides types that replaces platform-specific graphics types like Color. |
| com.groupdocs.viewer.drawing.rgb24color | Contains all 'known colors', that have fixed unique name and value in CSS standard. |
| com.groupdocs.viewer.exception | The package provides classes for exceptions that can occur while working with a document. |
| com.groupdocs.viewer.fonts | The package provides classes and enumerations to manage fonts used during the rendering process. |
| com.groupdocs.viewer.interfaces | The package provides interfaces for instantiating and releasing the output document and its resources. |
| com.groupdocs.viewer.logging | The package provides classes for configuring the logging system in GroupDocs.Viewer. |
| com.groupdocs.viewer.options | The package provides classes to specify additional options when rendering documents. |
| com.groupdocs.viewer.results | The package provides classes and interfaces that represent document rendering results. |
| com.groupdocs.viewer.utils | The package provides helper and utility classes for various functionalities. |

### com.groupdocs.viewer.caching.extra
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching.extra.md

The package provides functionality for using custom models in cache implementation.

The main class in this package is CacheableFactory, which helps in customizing the cache by providing additional functionality.

For more details on using custom models in cache implementation in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| CacheableFactory | This class helps customize Cache. |

### CacheableFactory
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching.extra/cacheablefactory.md

**Inheritance:**
java.lang.Object
```
public class CacheableFactory
```

This class helps customize Cache.

Custom models for serialization can be implemented by overriding methods in this class to return them instead of the embedded ones. To achieve this, extend CacheableFactory and activate it passing new instance of custom factory to setInstance(CacheableFactory) method.

Example usage:

```

 CacheableFactory.setInstance(new YourCustomCacheableFactory());
 // Custom cacheable factory is now in use. You can start rendering documents.
 
```

For more details, guidelines, and examples on customizing the cache, please refer to the [GroupDocs.Viewer documentation][].

[GroupDocs.Viewer documentation]: https://docs.groupdocs.com/viewer/java/getting-started/
#### Constructors

| Constructor | Description |
| --- | --- |
| CacheableFactory() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInstance() | Gets an instance of  CacheableFactory  that can be used to create cacheable objects. |
| setInstance(CacheableFactory instance) | Sets the instance of  CacheableFactory  to be used. |
| newViewInfo(FileType fileType, List<Page> pages) | Creates an implementation of the ViewInfo interface for the specified file type and pages. |
| newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount) | Creates an implementation of the LotusNotesViewInfo interface for the specified file type, pages, and notes count. |
| newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders) | Creates an implementation of the ArchiveViewInfo interface for the specified file type, pages, and folders. |
| newCharacter(char character, double x, double y, double width, double height) | Creates an implementation of the Character interface for the specified character, position, and dimensions. |
| newFileInfo(FileType fileType) | Creates an implementation of the FileInfo interface for the specified file type. |
| newLayer(String name, boolean visible) | Creates an implementation of the Layer interface with the specified name and visibility. |
| newLayer(String name) | Creates an implementation of the Layer interface with the specified name. |
| newLayout(String name, double width, double height) | Creates an implementation of the Layout interface with the specified name, width, and height. |
| newLine(String line, double x, double y, double width, double height, List<Word> words) | Creates an implementation of the Line interface with the specified line, position, dimensions, and words. |
| newAttachment(String fileName, String filePath) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, String filePath, long size) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, Path filePath, long size) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, String filePath, FileType fileType, long size) | Creates an implementation of the Attachment interface. |
| newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders) | Creates an implementation of the OutlookViewInfo interface based on the specified file type, list of pages, and list of folders. |
| newPage(int number, boolean visible) | Creates an implementation of the Page interface representing a page with the specified number and visibility. |
| newPage(int number, String name, boolean visible) | Creates an implementation of the Page interface representing a page with the specified number, name, and visibility. |
| newPage(int number, String name, boolean visible, int width, int height) | Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, and height. |
| newPage(int number, boolean visible, int width, int height) | Creates an implementation of the Page interface representing a page with the specified number, visibility, width, and height. |
| newPage(int number, String name, boolean visible, int width, int height, List<Line> lines) | Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, height, and lines. |
| newPage(int number, boolean visible, int width, int height, List<Line> lines) | Creates an implementation of the Page interface representing a page with the specified number, visibility, width, height, and lines. |
| newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed) | Creates an implementation of the PdfViewInfo interface with the specified file type, pages, and printing allowed flag. |
| newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts) | Creates an implementation of the CadViewInfo interface with the specified file type, pages, layers, and layouts. |
| newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate) | Creates an implementation of the ProjectManagementViewInfo interface with the specified file type, pages, start date, and end date. |
| <T>newTextElement(T value, double x, double y, double width, double height) | Creates an implementation of the TextElement interface with the specified value, coordinates, and dimensions. |
| newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount) | Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count. |
| newWord(String word, double x, double y, double width, double height, List<Character> characters) | Creates an implementation of the Word interface with the specified word, coordinates, dimensions, and characters. |
##### CacheableFactory()
```
public CacheableFactory()
```

##### getInstance()
```
public static CacheableFactory getInstance()
```

Gets an instance of  CacheableFactory  that can be used to create cacheable objects.

**Returns:**
CacheableFactory - an instance of  CacheableFactory .
##### setInstance(CacheableFactory instance)
```
public static void setInstance(CacheableFactory instance)
```

Sets the instance of  CacheableFactory  to be used. This allows custom implementation of the cacheable factory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| instance | CacheableFactory | The instance of  CacheableFactory  to set. |

##### newViewInfo(FileType fileType, List<Page> pages)
```
public ViewInfo newViewInfo(FileType fileType, List<Page> pages)
```

Creates an implementation of the ViewInfo interface for the specified file type and pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |

**Returns:**
ViewInfo - a new instance of the ViewInfo implementation.
##### newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount)
```
public LotusNotesViewInfo newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

Creates an implementation of the LotusNotesViewInfo interface for the specified file type, pages, and notes count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |
| notesCount | int | The count of Lotus Notes in the document. |

**Returns:**
LotusNotesViewInfo - a new instance of the LotusNotesViewInfo implementation.
##### newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```
public ArchiveViewInfo newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```

Creates an implementation of the ArchiveViewInfo interface for the specified file type, pages, and folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |
| folders | java.util.List<java.lang.String> | The list of folders in the archive. |

**Returns:**
ArchiveViewInfo - a new instance of the ArchiveViewInfo implementation.
##### newCharacter(char character, double x, double y, double width, double height)
```
public Character newCharacter(char character, double x, double y, double width, double height)
```

Creates an implementation of the Character interface for the specified character, position, and dimensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character. |
| x | double | The x-coordinate of the character position. |
| y | double | The y-coordinate of the character position. |
| width | double | The width of the character. |
| height | double | The height of the character. |

**Returns:**
Character - a new instance of the Character implementation.
##### newFileInfo(FileType fileType)
```
public FileInfo newFileInfo(FileType fileType)
```

Creates an implementation of the FileInfo interface for the specified file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

**Returns:**
FileInfo - a new instance of the FileInfo implementation.
##### newLayer(String name, boolean visible)
```
public Layer newLayer(String name, boolean visible)
```

Creates an implementation of the Layer interface with the specified name and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layer. |
| visible | boolean | The visibility of the layer. |

**Returns:**
Layer - a new instance of the Layer implementation.
##### newLayer(String name)
```
public Layer newLayer(String name)
```

Creates an implementation of the Layer interface with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layer. |

**Returns:**
Layer - a new instance of the Layer implementation.
##### newLayout(String name, double width, double height)
```
public Layout newLayout(String name, double width, double height)
```

Creates an implementation of the Layout interface with the specified name, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layout. |
| width | double | The width of the layout. |
| height | double | The height of the layout. |

**Returns:**
Layout - a new instance of the Layout implementation.
##### newLine(String line, double x, double y, double width, double height, List<Word> words)
```
public Line newLine(String line, double x, double y, double width, double height, List<Word> words)
```

Creates an implementation of the Line interface with the specified line, position, dimensions, and words.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| line | java.lang.String | The line content. |
| x | double | The X coordinate of the top-left point of the rectangle that contains the line. |
| y | double | The Y coordinate of the top-left point of the rectangle that contains the line. |
| width | double | The width of the rectangle that contains the line (in pixels). |
| height | double | The height of the rectangle that contains the line (in pixels). |
| words | java.util.List<com.groupdocs.viewer.results.Word> | The words contained in the line. |

**Returns:**
Line - a new instance of the Line implementation.
##### newAttachment(String fileName, String filePath)
```
public Attachment newAttachment(String fileName, String filePath)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, String filePath, long size)
```
public Attachment newAttachment(String id, String fileName, String filePath, long size)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, Path filePath, long size)
```
public Attachment newAttachment(String id, String fileName, Path filePath, long size)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.nio.file.Path | The relative or absolute path of the attachment. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, String filePath, FileType fileType, long size)
```
public Attachment newAttachment(String id, String fileName, String filePath, FileType fileType, long size)
```

Creates an implementation of the Attachment interface. The attachment represents a file attached to a document or an email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative or absolute path of the attachment. It can be a file path within a folder or the filename itself if the file is located in the root of an archive, in an email message, or in a data file. |
| fileType | FileType | The type of the attachment file. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```
public OutlookViewInfo newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```

Creates an implementation of the OutlookViewInfo interface based on the specified file type, list of pages, and list of folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| folders | java.util.List<java.lang.String> | The list of folders. |

**Returns:**
OutlookViewInfo - a new instance of the OutlookViewInfo implementation.
##### newPage(int number, boolean visible)
```
public Page newPage(int number, boolean visible)
```

Creates an implementation of the Page interface representing a page with the specified number and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible)
```
public Page newPage(int number, String name, boolean visible)
```

Creates an implementation of the Page interface representing a page with the specified number, name, and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible, int width, int height)
```
public Page newPage(int number, String name, boolean visible, int width, int height)
```

Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, boolean visible, int width, int height)
```
public Page newPage(int number, boolean visible, int width, int height)
```

Creates an implementation of the Page interface representing a page with the specified number, visibility, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible, int width, int height, List<Line> lines)
```
public Page newPage(int number, String name, boolean visible, int width, int height, List<Line> lines)
```

Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, height, and lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | The lines contained in the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, boolean visible, int width, int height, List<Line> lines)
```
public Page newPage(int number, boolean visible, int width, int height, List<Line> lines)
```

Creates an implementation of the Page interface representing a page with the specified number, visibility, width, height, and lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | The lines contained in the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed)
```
public PdfViewInfo newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed)
```

Creates an implementation of the PdfViewInfo interface with the specified file type, pages, and printing allowed flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| printingAllowed | boolean | The flag indicating whether printing is allowed. |

**Returns:**
PdfViewInfo - a new instance of the PdfViewInfo implementation.
##### newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts)
```
public CadViewInfo newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts)
```

Creates an implementation of the CadViewInfo interface with the specified file type, pages, layers, and layouts.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| layers | java.util.List<com.groupdocs.viewer.results.Layer> | The list of layers. |
| layouts | java.util.List<com.groupdocs.viewer.results.Layout> | The list of layouts. |

**Returns:**
CadViewInfo - a new instance of the CadViewInfo implementation.
##### newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate)
```
public ProjectManagementViewInfo newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate)
```

Creates an implementation of the ProjectManagementViewInfo interface with the specified file type, pages, start date, and end date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| startDate | java.util.Date | The start date. |
| endDate | java.util.Date | The end date. |

**Returns:**
ProjectManagementViewInfo - a new instance of the ProjectManagementViewInfo implementation.
##### <T>newTextElement(T value, double x, double y, double width, double height)
```
public TextElement<T> <T>newTextElement(T value, double x, double y, double width, double height)
```

Creates an implementation of the TextElement interface with the specified value, coordinates, and dimensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | T | The value. |
| x | double | The X coordinate. |
| y | double | The Y coordinate. |
| width | double | The width. |
| height | double | The height. |

**Returns:**
TextElement - a new instance of the TextElement implementation.
##### newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount)
```
public MboxViewInfo newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages to view. |
| notesCount | int | The notes count contained by the Lotus database storage file. |

**Returns:**
com.groupdocs.viewer.results.MboxViewInfo - a new instance of the MboxViewInfo implementation.
##### newWord(String word, double x, double y, double width, double height, List<Character> characters)
```
public Word newWord(String word, double x, double y, double width, double height, List<Character> characters)
```

Creates an implementation of the Word interface with the specified word, coordinates, dimensions, and characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word. |
| x | double | The X coordinate of the highest left point on the page layout where the rectangle that contains the word begins. |
| y | double | The Y coordinate of the highest left point on the page layout where the rectangle that contains the word begins. |
| width | double | The width of the rectangle which contains the word (in pixels). |
| height | double | The height of the rectangle which contains the word (in pixels). |
| characters | java.util.List<com.groupdocs.viewer.results.Character> | The characters contained by the word. |

**Returns:**
Word - a new instance of the Word implementation.

### com.groupdocs.viewer.caching
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching.md

The package provides classes for customizing caching behavior.

The main classes and interfaces in this package are:

 *  CacheKeys - Provides methods to retrieve unique identifiers for the cache entry.
 *  FileCache - Represents a local on-disk cache.

The Cache interface defines methods required for storing rendered documents and document resources in the cache.

For more details on customizing caching behavior in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| CacheKeys | Provides methods to retrieve the unique identifier for a cache entry. |
| FileCache | Represents a local on-disk cache. |

#### Interfaces

| Interface | Description |
| --- | --- |
| Cache | Defines methods required for storing rendered documents and document resources cache. |

### Cache
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching/cache.md

### CacheKeys
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching/cachekeys.md

**Inheritance:**
java.lang.Object
```
public class CacheKeys
```

Provides methods to retrieve the unique identifier for a cache entry.

The class allows you to generate cache keys based on different parameters, such as the document path, rendering options, and resource name. These cache keys can be used to store and retrieve cached data for efficient document rendering.

Example usage:

```

 // Generate a cache key for a file
 String fileKey = CacheKeys.getFileKey("filename.pdf");

 // Generate a cache key for a page
 String pageKey = CacheKeys.getPageKey(pageNumber, FileType.HTML.getExtension());

 // Generate a cache key for a resource
 Resource resource = new Resource("styles.css", false);
 String pageKey = CacheKeys.getResourceKey(pageNumber, resource);
 
```
#### Fields

| Field | Description |
| --- | --- |
| PAGE_NUMBER |  |
#### Methods

| Method | Description |
| --- | --- |
| getAttachmentsKey() | Returns the unique identifier for the cache entry that represents a collection of Attachment objects. |
| getAttachmentKey(String attachmentId) | Retrieves the unique identifier for the cache entry representing an attachment file. |
| getViewInfoKey() | Retrieves the unique identifier for the cache entry that represents a ViewInfo object. |
| getFileInfoKey() | Retrieves the unique identifier for the cache entry that represents a ViewInfo object. |
| getFileKey(String extension) | Retrieves the unique identifier for the cache entry that represents a file. |
| getPageKey(int pageNumber, String extension) | Retrieves the unique identifier for the cache entry that represents a page file. |
| getResourceKey(int pageNumber, Resource resource) | Returns a unique identifier for the cache entry that represents a Resource object. |
| getResourceFilter(int pageNumber) | Returns a filter string to search for cache entries that represent Resource objects. |
##### PAGE_NUMBER
```
public static final String PAGE_NUMBER
```

##### getAttachmentsKey()
```
public static String getAttachmentsKey()
```

Returns the unique identifier for the cache entry that represents a collection of Attachment objects.

**Returns:**
java.lang.String - the unique identifier for the attachments cache entry.
##### getAttachmentKey(String attachmentId)
```
public static String getAttachmentKey(String attachmentId)
```

Retrieves the unique identifier for the cache entry representing an attachment file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attachmentId | java.lang.String | The unique identifier of the attachment (in the context of a single file). |

**Returns:**
java.lang.String - the unique identifier for the attachment file cache entry.
##### getViewInfoKey()
```
public static String getViewInfoKey()
```

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

**Returns:**
java.lang.String - the unique identifier for the cache entry.
##### getFileInfoKey()
```
public static String getFileInfoKey()
```

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a ViewInfo object.
##### getFileKey(String extension)
```
public static String getFileKey(String extension)
```

Retrieves the unique identifier for the cache entry that represents a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". |

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a file.
##### getPageKey(int pageNumber, String extension)
```
public static String getPageKey(int pageNumber, String extension)
```

Retrieves the unique identifier for the cache entry that represents a page file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |
| extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". |

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a page file.
##### getResourceKey(int pageNumber, Resource resource)
```
public static String getResourceKey(int pageNumber, Resource resource)
```

Returns a unique identifier for the cache entry that represents a Resource object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |
| resource | Resource | The HTML resource. |

**Returns:**
java.lang.String - the unique identifier for the cache entry.
##### getResourceFilter(int pageNumber)
```
public static String getResourceFilter(int pageNumber)
```

Returns a filter string to search for cache entries that represent Resource objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |

**Returns:**
java.lang.String - the filter string to search for cache entries.

### FileCache
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.caching/filecache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.caching.Cache
```
public class FileCache implements Cache
```

Represents a local on-disk cache.

The FileCache class represents a local on-disk cache in the GroupDocs.Viewer component. It provides functionality to store and retrieve cached data on the disk for efficient document rendering.

Example usage:

```

 FileCache fileCache = new FileCache(cachePath, cacheSubFolder);

 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setCache(fileCache);

 try (Viewer viewer = new Viewer(documentPath, viewerSettings)) {
     // Use the viewer object for document rendering
 }
 
```

To use the FileCache, you need to create an instance of this class and pass it to the ViewerSettings object. The Viewer object will then use the FileCache for caching purposes while rendering documents.

***Note:** The FileCache is just one of the cache implementations provided by GroupDocs.Viewer. You can also implement your own custom cache by implementing the Cache interface.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCache(String cachePath) | Creates a new instance of the  FileCache  class. |
| FileCache(Path cachePath) | Creates a new instance of the  FileCache  class. |
| FileCache(String cachePath, String cacheSubFolder) | Creates a new instance of the  FileCache  class. |
| FileCache(Path cachePath, String cacheSubFolder) | Creates a new instance of the  FileCache  class. |
#### Fields

| Field | Description |
| --- | --- |
| CACHE_PATH |  |
#### Methods

| Method | Description |
| --- | --- |
| getCachePath() | Gets the relative or absolute path to the cache folder. |
| getCacheSubFolder() | The sub-folder to append to the cache path. |
| set(String key, Object value) | Serializes data to the local disk. |
| <T>get(String key, Class<T> clazz) | Deserializes data associated with this key if present. |
| getKeys(String filter) | Returns all file names that contain the filter in the filename. |
##### FileCache(String cachePath)
```
public FileCache(String cachePath)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. |

##### FileCache(Path cachePath)
```
public FileCache(Path cachePath)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. |

##### FileCache(String cachePath, String cacheSubFolder)
```
public FileCache(String cachePath, String cacheSubFolder)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to  cachePath . |

##### FileCache(Path cachePath, String cacheSubFolder)
```
public FileCache(Path cachePath, String cacheSubFolder)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to  cachePath . |

##### CACHE_PATH
```
public static final String CACHE_PATH
```

##### getCachePath()
```
public final String getCachePath()
```

Gets the relative or absolute path to the cache folder.

**Returns:**
java.lang.String - Path to the cache folder.
##### getCacheSubFolder()
```
public final String getCacheSubFolder()
```

The sub-folder to append to the cache path.

**Returns:**
java.lang.String - the sub-folder to append.
##### 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 | The unique identifier for the cache entry. |
| value | java.lang.Object | The object to serialize. |

##### <T>get(String key, Class<T> clazz)
```
public final T <T>get(String key, Class<T> clazz)
```

Deserializes data associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |
| clazz | java.lang.Class<T> | The class of the expected value. |

**Returns:**
T - the located value or null.
##### getKeys(String filter)
```
public final List<String> getKeys(String filter)
```

Returns all file names that contain the filter in the filename.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | The filter to use. |

**Returns:**
java.util.List<java.lang.String> - File names that contain the filter in the filename.

### com.groupdocs.viewer.drawing.rgb24color
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing.rgb24color.md

Contains all 'known colors', that have fixed unique name and value in CSS standard.

#### Classes

| Class | Description |
| --- | --- |
| KnownColors |  |

### KnownColors
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing.rgb24color/knowncolors.md

**Inheritance:**
java.lang.Object
```
public class KnownColors
```
#### Methods

| Method | Description |
| --- | --- |
| tryFindColor(String keyword, Rgb24Color[] output) | Tries to find a color by its string name. |
| tryFindName(Rgb24Color color, String[] name) | Tries to find a color name by its RGB value. |
##### tryFindColor(String keyword, Rgb24Color[] output)
```
public static boolean tryFindColor(String keyword, Rgb24Color[] output)
```

Tries to find a color by its string name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| keyword | java.lang.String | A color name. |
| output | Rgb24Color\[\] | The result container for the found color, or CssLevel1.Black on failure. |

**Returns:**
boolean - True if the color was successfully found by name, false otherwise.
##### tryFindName(Rgb24Color color, String[] name)
```
public static boolean tryFindName(Rgb24Color color, String[] name)
```

Tries to find a color name by its RGB value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | Rgb24Color | A color instance. |
| name | java.lang.String[] | The result container for the found color name, or null on failure. |

**Returns:**
boolean - True if the name was successfully found for the given color, false otherwise.

### com.groupdocs.viewer.drawing
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing.md

The package provides types that replaces platform-specific graphics types like Color.

The main classes and interfaces in this package are:

 *  Argb32Color - Represents 32-bit color in ARGB format, with 8 bits per channel (Alpha, Red, Green, Blue).
 *  Image2DFormat - Represents a 2D image format \\u2014 raster or vector.
 *  Rgb24Color - Represents 24-bit color in RGB format, with 8 bits per every channel (Red, Green, Blue). Does not support transparency.

For more details on customizing caching behavior in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| Argb32Color | Represents 32-bit color in ARGB format, with 8 bits per channel (Alpha, Red, Green, Blue). |
| Image2DFormat | Represents a 2D image format \\u2014 raster or vector. |
| Rgb24Color |  |

### Argb32Color
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing/argb32color.md

**Inheritance:**
java.lang.Object
```
public class Argb32Color
```

Represents 32-bit color in ARGB format, with 8 bits per channel (Alpha, Red, Green, Blue). Supports transparency. 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 |
| --- | --- |
| Argb32Color(int alpha, int red, int green, int blue) | Private constructor, initializes ARGB channels. |
#### Fields

| Field | Description |
| --- | --- |
| EMPTY |  |
| TRANSPARENT |  |
#### Methods

| Method | Description |
| --- | --- |
| fromRgba(int red, int green, int blue, int alpha) | Create an Argb32Color from individual RGBA channels. |
| fromArgb(int argb) | Create an Argb32Color from a 32-bit ARGB int value (same as System.Drawing.Color.ToArgb()). |
| fromRgb(int red, int green, int blue) | Create an opaque Argb32Color from RGB channels (alpha = 255). |
| fromSingleValueRgb(int value) | Create a grayscale opaque Argb32Color from a single value applied to R, G, B. |
| getValue() | Gets the 32-bit signed integer representation of this color. |
| getAlpha() | Returns the alpha channel [0..255] |
| getAlphaFraction() | Returns the alpha channel as fraction [0..1] |
| getRed() | Returns the red channel [0..255] |
| getGreen() | Returns the green channel [0..255] |
| getBlue() | Returns the blue channel [0..255] |
| getArgbValue() | Returns the 32-bit ARGB integer value |
| isEmpty() | Indicates if this color is empty (all channels 0) |
| isDefault() | Indicates if instance is default (Transparent) - all 4 channels are set to 0. |
| isFullyTransparent() | Indicates if this color is fully transparent (alpha == 0) |
| isFullyOpaque() | Indicates if this color is fully opaque (alpha == 255) |
| isTranslucent() | Indicates if this color is translucent (alpha between 1 and 254) |
| getBrightness() | Calculates brightness/lightness of the color (HSL model). |
| getHue() | Calculates hue of the color in degrees [0..360]. |
| getSaturation() | Calculates saturation of the color (HSL model). |
| toArgb() | Returns the 32-bit ARGB value of this color instance, compatible with System.Drawing.Color.ToArgb() |
| toRGBA() | Serializes this Argb32Color instance to the 'rgba' CSS function notation. |
| toRGB() | Serializes this instance to CSS rgb() string notation (without alpha). |
| toHexRGBA() | Serializes this instance to hexadecimal \#RRGGBBAA notation. |
| toHexRGB() | Serializes this instance to hexadecimal \#RRGGBB notation (without alpha). |
| toString() | Returns the string representation using the most appropriate CSS notation. |
| equals(Object obj) | Equality comparison with another Argb32Color. |
| hashCode() |  |
| equals(Argb32Color other) | Compares this color with another Argb32Color. |
| equals(Rgb24Color other) | Compares this color with a Rgb24Color. |
| toRgb24Color() | Cast this Argb32Color to Rgb24Color, losing alpha channel. |
| fromRgb24Color(Rgb24Color rgbColor) | Create Argb32Color from Rgb24Color with alpha set to 255. |
##### Argb32Color(int alpha, int red, int green, int blue)
```
public Argb32Color(int alpha, int red, int green, int blue)
```

Private constructor, initializes ARGB channels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alpha | int | alpha channel (0-255) |
| red | int | red channel (0-255) |
| green | int | green channel (0-255) |
| blue | int | blue channel (0-255) |

##### EMPTY
```
public static final Argb32Color EMPTY
```

##### TRANSPARENT
```
public static final Argb32Color TRANSPARENT
```

##### fromRgba(int red, int green, int blue, int alpha)
```
public static Argb32Color fromRgba(int red, int green, int blue, int alpha)
```

Create an Argb32Color from individual RGBA channels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int |  |
| green | int |  |
| blue | int |  |
| alpha | int |  |

**Returns:**
Argb32Color
##### fromArgb(int argb)
```
public static Argb32Color fromArgb(int argb)
```

Create an Argb32Color from a 32-bit ARGB int value (same as System.Drawing.Color.ToArgb()).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| argb | int |  |

**Returns:**
Argb32Color
##### fromRgb(int red, int green, int blue)
```
public static Argb32Color fromRgb(int red, int green, int blue)
```

Create an opaque Argb32Color from RGB channels (alpha = 255).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int |  |
| green | int |  |
| blue | int |  |

**Returns:**
Argb32Color
##### fromSingleValueRgb(int value)
```
public static Argb32Color fromSingleValueRgb(int value)
```

Create a grayscale opaque Argb32Color from a single value applied to R, G, B.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

**Returns:**
Argb32Color
##### getValue()
```
public int getValue()
```

Gets the 32-bit signed integer representation of this color. This value is typically used as a packed ARGB value.

**Returns:**
int - The 32-bit integer value representing the color.
##### getAlpha()
```
public int getAlpha()
```

Returns the alpha channel [0..255]

**Returns:**
int
##### getAlphaFraction()
```
public double getAlphaFraction()
```

Returns the alpha channel as fraction [0..1]

**Returns:**
double
##### getRed()
```
public int getRed()
```

Returns the red channel [0..255]

**Returns:**
int
##### getGreen()
```
public int getGreen()
```

Returns the green channel [0..255]

**Returns:**
int
##### getBlue()
```
public int getBlue()
```

Returns the blue channel [0..255]

**Returns:**
int
##### getArgbValue()
```
public int getArgbValue()
```

Returns the 32-bit ARGB integer value

**Returns:**
int
##### isEmpty()
```
public boolean isEmpty()
```

Indicates if this color is empty (all channels 0)

**Returns:**
boolean
##### isDefault()
```
public boolean isDefault()
```

Indicates if instance is default (Transparent) - all 4 channels are set to 0.

**Returns:**
boolean
##### isFullyTransparent()
```
public boolean isFullyTransparent()
```

Indicates if this color is fully transparent (alpha == 0)

**Returns:**
boolean
##### isFullyOpaque()
```
public boolean isFullyOpaque()
```

Indicates if this color is fully opaque (alpha == 255)

**Returns:**
boolean
##### isTranslucent()
```
public boolean isTranslucent()
```

Indicates if this color is translucent (alpha between 1 and 254)

**Returns:**
boolean
##### getBrightness()
```
public float getBrightness()
```

Calculates brightness/lightness of the color (HSL model).

**Returns:**
float - float in [0..1]
##### getHue()
```
public float getHue()
```

Calculates hue of the color in degrees [0..360]. Returns 0 if color is grayscale (R=G=B).

**Returns:**
float
##### getSaturation()
```
public float getSaturation()
```

Calculates saturation of the color (HSL model).

**Returns:**
float - float in [0..1]
##### toArgb()
```
public int toArgb()
```

Returns the 32-bit ARGB value of this color instance, compatible with System.Drawing.Color.ToArgb()

**Returns:**
int
##### toRGBA()
```
public String toRGBA()
```

Serializes this Argb32Color instance to the 'rgba' CSS function notation.

**Returns:**
java.lang.String - A string formatted as 'rgba(r, g, b, a)'.
##### toRGB()
```
public String toRGB()
```

Serializes this instance to CSS rgb() string notation (without alpha).

**Returns:**
java.lang.String
##### toHexRGBA()
```
public String toHexRGBA()
```

Serializes this instance to hexadecimal \#RRGGBBAA notation.

**Returns:**
java.lang.String
##### toHexRGB()
```
public String toHexRGB()
```

Serializes this instance to hexadecimal \#RRGGBB notation (without alpha).

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns the string representation using the most appropriate CSS notation.

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Equality comparison with another Argb32Color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(Argb32Color other)
```
public boolean equals(Argb32Color other)
```

Compares this color with another Argb32Color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Argb32Color |  |

**Returns:**
boolean
##### equals(Rgb24Color other)
```
public boolean equals(Rgb24Color other)
```

Compares this color with a Rgb24Color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Rgb24Color |  |

**Returns:**
boolean
##### toRgb24Color()
```
public Rgb24Color toRgb24Color()
```

Cast this Argb32Color to Rgb24Color, losing alpha channel.

**Returns:**
Rgb24Color
##### fromRgb24Color(Rgb24Color rgbColor)
```
public static Argb32Color fromRgb24Color(Rgb24Color rgbColor)
```

Create Argb32Color from Rgb24Color with alpha set to 255.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rgbColor | Rgb24Color |  |

**Returns:**
Argb32Color

### Image2DFormat
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing/image2dformat.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.htmlcss.resources.IResourceType
```
public final class Image2DFormat implements IResourceType
```

Represents a 2D image format \\u2014 raster or vector.
#### Fields

| Field | Description |
| --- | --- |
| UNDEFINED |  |
| JPEG |  |
| PNG |  |
| BMP |  |
| GIF |  |
| TIFF |  |
| ICON |  |
| SVG |  |
| WMF |  |
| EMF |  |
#### Methods

| Method | Description |
| --- | --- |
| getName() | Returns a formal name of this image format. |
| getFormalName() | Returns a formal name of this image format. |
| isVector() | Indicates whether this format is vector (true) or raster (false). |
| getFileExtension() | Returns lowercase file extension (without dot) for this format. |
| getMimeCode() | MIME code of the image format. |
| toString() |  |
| equals(Object obj) |  |
| hashCode() |  |
| parseFromFilenameWithExtension(String filename) | Returns Image2DFormat based on file extension (with or without dot). |
| parseFromMime(String mimeCode) | Returns Image2DFormat based on MIME type string. |
##### UNDEFINED
```
public static final Image2DFormat UNDEFINED
```

##### JPEG
```
public static final Image2DFormat JPEG
```

##### PNG
```
public static final Image2DFormat PNG
```

##### BMP
```
public static final Image2DFormat BMP
```

##### GIF
```
public static final Image2DFormat GIF
```

##### TIFF
```
public static final Image2DFormat TIFF
```

##### ICON
```
public static final Image2DFormat ICON
```

##### SVG
```
public static final Image2DFormat SVG
```

##### WMF
```
public static final Image2DFormat WMF
```

##### EMF
```
public static final Image2DFormat EMF
```

##### getName()
```
public String getName()
```

Returns a formal name of this image format. Never returns null.

**Returns:**
java.lang.String
##### getFormalName()
```
public String getFormalName()
```

Returns a formal name of this image format. Never returns null.

**Returns:**
java.lang.String
##### isVector()
```
public boolean isVector()
```

Indicates whether this format is vector (true) or raster (false).

**Returns:**
boolean
##### getFileExtension()
```
public String getFileExtension()
```

Returns lowercase file extension (without dot) for this format.

**Returns:**
java.lang.String
##### getMimeCode()
```
public String getMimeCode()
```

MIME code of the image format.

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### parseFromFilenameWithExtension(String filename)
```
public static Image2DFormat parseFromFilenameWithExtension(String filename)
```

Returns Image2DFormat based on file extension (with or without dot).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filename | java.lang.String |  |

**Returns:**
Image2DFormat
##### parseFromMime(String mimeCode)
```
public static Image2DFormat parseFromMime(String mimeCode)
```

Returns Image2DFormat based on MIME type string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | java.lang.String |  |

**Returns:**
Image2DFormat

### Rgb24Color
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.drawing/rgb24color.md

**Inheritance:**
java.lang.Object
```
public class Rgb24Color
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Rgb24Color(int r, int g, int b) | Private constructor to create a color from red, green, and blue channels. |
#### Methods

| Method | Description |
| --- | --- |
| fromRgb(int red, int green, int blue) | Creates a new Rgb24Color from specified red, green, and blue channel values. |
| getR() | Gets the red channel value. |
| getG() | Gets the green channel value. |
| getB() | Gets the blue channel value. |
| isDefault() | Returns true if the color is the default black color (all channels are zero). |
| getBrightness() | Calculates the brightness (lightness) of this color in HSL color space. |
| getHue() | Calculates the hue of this color in degrees (HSL color space). |
| getSaturation() | Calculates the saturation of this color in HSL color space. |
| toArgb() | Returns the 32-bit ARGB representation of this color. |
| hashCode() |  |
| equals(Object obj) |  |
| toRGB() | Returns the CSS rgb() function string representation of the color. |
| toHex() | Returns the hexadecimal string representation of the color. |
| toString() |  |
##### Rgb24Color(int r, int g, int b)
```
public Rgb24Color(int r, int g, int b)
```

Private constructor to create a color from red, green, and blue channels. Values are clamped to the [0..255] range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| r | int |  |
| g | int |  |
| b | int |  |

##### fromRgb(int red, int green, int blue)
```
public static Rgb24Color fromRgb(int red, int green, int blue)
```

Creates a new Rgb24Color from specified red, green, and blue channel values. The input values are clamped to the valid range [0..255].

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | Red channel value |
| green | int | Green channel value |
| blue | int | Blue channel value |

**Returns:**
Rgb24Color - New Rgb24Color instance
##### getR()
```
public int getR()
```

Gets the red channel value.

**Returns:**
int - Red channel [0..255]
##### getG()
```
public int getG()
```

Gets the green channel value.

**Returns:**
int - Green channel [0..255]
##### getB()
```
public int getB()
```

Gets the blue channel value.

**Returns:**
int - Blue channel [0..255]
##### isDefault()
```
public boolean isDefault()
```

Returns true if the color is the default black color (all channels are zero).

**Returns:**
boolean - True if black, otherwise false
##### getBrightness()
```
public float getBrightness()
```

Calculates the brightness (lightness) of this color in HSL color space.

**Returns:**
float - Brightness as a float in range [0..1]
##### getHue()
```
public float getHue()
```

Calculates the hue of this color in degrees (HSL color space). Returns 0 if the color is grayscale (red = green = blue).

**Returns:**
float - Hue in degrees [0..360)
##### getSaturation()
```
public float getSaturation()
```

Calculates the saturation of this color in HSL color space.

**Returns:**
float - Saturation as a float in range [0..1]
##### toArgb()
```
public int toArgb()
```

Returns the 32-bit ARGB representation of this color. Alpha is always set to 255 (fully opaque).

**Returns:**
int - ARGB color as int
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### toRGB()
```
public String toRGB()
```

Returns the CSS rgb() function string representation of the color.

**Returns:**
java.lang.String - String in format "rgb(r, g, b)"
##### toHex()
```
public String toHex()
```

Returns the hexadecimal string representation of the color.

**Returns:**
java.lang.String - String in format "\#RRGGBB"
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### com.groupdocs.viewer.exception
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception.md

The package provides classes for exceptions that can occur while working with a document.

The main classes in this package are:

 *  com.groupdocs.viewer.exception.ArchiveSecurityException - Thrown when an archive being opened exceeds specified limits.
 *  FileNotFoundException - Represents an exception thrown when a file or directory is not found.
 *  GroupDocsViewerException - Represents generic errors that occur during document processing.

For more details on working with exceptions in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| ArchiveSecurityException | This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions. |
| FileNotFoundException | This exception is thrown when a file or directory is not found. |
| GroupDocsViewerException | This exception represents generic errors that can occur during document processing. |
| IncorrectPasswordException | This exception is thrown when the specified password is incorrect. |
| NotSupportedException | This exception is thrown when the requested operation is not supported. |
| PasswordRequiredException | This exception is thrown when a password is required to load the document. |

### ArchiveSecurityException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/archivesecurityexception.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.viewer.exception.GroupDocsViewerException
```
public class ArchiveSecurityException extends GroupDocsViewerException
```

This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions.
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveSecurityException(String message) | Creates an instance of the  ArchiveSecurityException  class with the specified message. |
##### ArchiveSecurityException(String message)
```
public ArchiveSecurityException(String message)
```

Creates an instance of the  ArchiveSecurityException  class with the specified message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

### FileNotFoundException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/filenotfoundexception.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.viewer.exception.GroupDocsViewerException
```
public class FileNotFoundException extends GroupDocsViewerException
```

This exception is thrown when a file or directory is not found. It indicates that the specified file or directory does not exist or cannot be accessed.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileNotFoundException(String message) | Creates an instance of the FileNotFoundException class with the specified message. |
| FileNotFoundException(Path path) | Initializes a new instance of the FileNotFoundException class with a specified file path. |
| FileNotFoundException(String messageTemplate, Object[] params) | Creates a new instance of the FileNotFoundException class with a specified error message. |
| FileNotFoundException(Throwable cause) | Instantiates a new instance of the FileNotFoundException class. |
| FileNotFoundException(String message, Throwable throwable) | Initializes a new instance of the FileNotFoundException class with a specified error message. |
##### FileNotFoundException(String message)
```
public FileNotFoundException(String message)
```

Creates an instance of the FileNotFoundException class with the specified message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### FileNotFoundException(Path path)
```
public FileNotFoundException(Path path)
```

Initializes a new instance of the FileNotFoundException class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.nio.file.Path | The path of the file that does not exist. |

##### FileNotFoundException(String messageTemplate, Object[] params)
```
public FileNotFoundException(String messageTemplate, Object[] params)
```

Creates a new instance of the FileNotFoundException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| messageTemplate | java.lang.String | The message that describes the error. |
| params | java.lang.Object[] | The parameters that will be set into the error message. |

##### FileNotFoundException(Throwable cause)
```
public FileNotFoundException(Throwable cause)
```

Instantiates a new instance of the FileNotFoundException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception. |

##### FileNotFoundException(String message, Throwable throwable)
```
public FileNotFoundException(String message, Throwable throwable)
```

Initializes a new instance of the FileNotFoundException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| throwable | java.lang.Throwable | The throwable that caused the exception. |

### GroupDocsViewerException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/groupdocsviewerexception.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 GroupDocsViewerException extends GroupDocsException
```

This exception represents generic errors that can occur during document processing. It is a broad exception that indicates an error or failure, but does not provide specific details about the nature of the error.
#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsViewerException(String message) | Initializes a new instance of the GroupDocsViewerException class with a specified error message. |
| GroupDocsViewerException(Throwable cause) | Initializes a new instance of the GroupDocsViewerException class with a cause of the exception. |
| GroupDocsViewerException(String message, Throwable throwable) | Initializes a new instance of the  GroupDocsViewerException  class with a specified error message. |
#### Methods

| Method | Description |
| --- | --- |
| toString() |  |
##### GroupDocsViewerException(String message)
```
public GroupDocsViewerException(String message)
```

Initializes a new instance of the GroupDocsViewerException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### GroupDocsViewerException(Throwable cause)
```
public GroupDocsViewerException(Throwable cause)
```

Initializes a new instance of the GroupDocsViewerException class with a cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception. |

##### GroupDocsViewerException(String message, Throwable throwable)
```
public GroupDocsViewerException(String message, Throwable throwable)
```

Initializes a new instance of the  GroupDocsViewerException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| throwable | java.lang.Throwable | The throwable that caused the exception. |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### IncorrectPasswordException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/incorrectpasswordexception.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.viewer.exception.GroupDocsViewerException
```
public class IncorrectPasswordException extends GroupDocsViewerException
```

This exception is thrown when the specified password is incorrect. This exception is typically thrown when attempting to access or decrypt a protected document with an invalid password.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() | Initializes a new instance of the  IncorrectPasswordException  class. |
| IncorrectPasswordException(String message, Throwable throwable) | Initializes a new instance of the  IncorrectPasswordException  class with a specified error message. |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

Initializes a new instance of the  IncorrectPasswordException  class.

##### IncorrectPasswordException(String message, Throwable throwable)
```
public IncorrectPasswordException(String message, Throwable throwable)
```

Initializes a new instance of the  IncorrectPasswordException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### NotSupportedException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/notsupportedexception.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.viewer.exception.GroupDocsViewerException
```
public class NotSupportedException extends GroupDocsViewerException
```

This exception is thrown when the requested operation is not supported. It indicates that the current operation is not supported by the underlying system or implementation.
#### Constructors

| Constructor | Description |
| --- | --- |
| NotSupportedException(String message) | Initializes a new instance of the  NotSupportedException  class with a specified error message. |
| NotSupportedException(String message, Throwable throwable) | Initializes a new instance of the  NotSupportedException  class with a specified error message and the cause of the exception. |
##### NotSupportedException(String message)
```
public NotSupportedException(String message)
```

Initializes a new instance of the  NotSupportedException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

##### NotSupportedException(String message, Throwable throwable)
```
public NotSupportedException(String message, Throwable throwable)
```

Initializes a new instance of the  NotSupportedException  class with a specified error message and the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### PasswordRequiredException
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.exception/passwordrequiredexception.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.viewer.exception.GroupDocsViewerException
```
public class PasswordRequiredException extends GroupDocsViewerException
```

This exception is thrown when a password is required to load the document. This exception typically occurs when attempting to load or open a document that is encrypted or password-protected without providing valid password.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() | Initializes a new instance of the  PasswordRequiredException  class. |
| PasswordRequiredException(String message) | Initializes a new instance of the  PasswordRequiredException  class with a custom exception message. |
| PasswordRequiredException(String message, Throwable throwable) | Initializes a new instance of the  PasswordRequiredException  class with a specified error message. |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

Initializes a new instance of the  PasswordRequiredException  class.

##### PasswordRequiredException(String message)
```
public PasswordRequiredException(String message)
```

Initializes a new instance of the  PasswordRequiredException  class with a custom exception message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |

##### PasswordRequiredException(String message, Throwable throwable)
```
public PasswordRequiredException(String message, Throwable throwable)
```

Initializes a new instance of the  PasswordRequiredException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### com.groupdocs.viewer.fonts
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts.md

The package provides classes and enumerations to manage fonts used during the rendering process.

The main classes and interfaces in this package are:

 *  FolderFontSource - Represents a folder that contains TrueType fonts.
 *  FontSettings - Provides methods for working with sources to look for TrueType fonts.
 *  FontSource - Marker interface for the font sources.

For more details on working with fonts in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| FolderFontSource | Represents a folder that contains TrueType fonts. |
| FontFormat | Represents all font formats, which may be present in the UsedFontInfo class. |
| FontSettings | Provides methods for working with sources to look for TrueType fonts. |
| FontStyles | Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic. |
| PdfFontInfo | Encapsulates meta-information and binary data of one font from a PDF document, loaded into the Viewer instance. |
| PresentationFontInfo | Encapsulates metadata and binary data of a font used in a Presentation document, loaded into the Viewer instance. |
| SpreadsheetFontInfo | Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the Viewer instance. |
| WordProcessingFontInfo | Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the Viewer instance. |
| WordProcessingSubstitutedFontInfo | Encapsulates metadata and binary data of one substituted font used in a WordProcessing document via GroupDocs.Viewer. |

#### Interfaces

| Interface | Description |
| --- | --- |
| FontSource | Marker interface for the font sources. |
| IFontInfo | Common interface for all fonts that can be extracted from document formats: PDF, WordProcessing, Spreadsheet, and Presentation. |

#### Enumerations

| Enum | Description |
| --- | --- |
| SearchOption | Specifies whether to search the current folder, or the current folder and all subfolders. |

### FolderFontSource
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/folderfontsource.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.FontSource, com.aspose.ms.System.IEquatable
```
public final class FolderFontSource implements FontSource, System.IEquatable<FolderFontSource>
```

Represents a folder that contains TrueType fonts.

The FolderFontSource class is used to specify a folder location that contains TrueType fonts. It allows the GroupDocs.Viewer API to access the fonts stored in the specified folder for document rendering purposes.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| FolderFontSource(String folderPath, SearchOption searchOption) | Initializes a new instance of the  FolderFontSource  class. |
#### Methods

| Method | Description |
| --- | --- |
| isEqualTo(FolderFontSource left, FolderFontSource right) | Determines whether two  FolderFontSource  objects are the same. |
| isNotEqualTo(FolderFontSource left, FolderFontSource right) | Determines whether two  FolderFontSource  objects are not the same. |
| getFolderPath() | Gets the path to the folder that contains TrueType fonts. |
| getSearchOption() | Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders. |
| isRecursive() | Checks if the fonts would be searched recursively. |
| equals(FolderFontSource other) | Determines whether the current  FolderFontSource  is the same as the specified  FolderFontSource  object. |
| equals(Object o) | Determines whether the current  FolderFontSource  is the same as the specified object. |
| hashCode() | Returns the hash code for the current  FolderFontSource  object. |
| toString() | Returns a string that represents the current object. |
##### FolderFontSource(String folderPath, SearchOption searchOption)
```
public FolderFontSource(String folderPath, SearchOption searchOption)
```

Initializes a new instance of the  FolderFontSource  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | java.lang.String | Path to the folder that contains TrueType fonts. |
| searchOption | SearchOption | Specifies whether to search the current folder, or the current folder and all sub-folders. |

##### isEqualTo(FolderFontSource left, FolderFontSource right)
```
public static boolean isEqualTo(FolderFontSource left, FolderFontSource right)
```

Determines whether two  FolderFontSource  objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | The left  FolderFontSource  object. |
| right | FolderFontSource | The right  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are the same; otherwise,  false .
##### isNotEqualTo(FolderFontSource left, FolderFontSource right)
```
public static boolean isNotEqualTo(FolderFontSource left, FolderFontSource right)
```

Determines whether two  FolderFontSource  objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | The left  FolderFontSource  object. |
| right | FolderFontSource | The right  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are not the same; otherwise,  false .
##### getFolderPath()
```
public String getFolderPath()
```

Gets the path to the folder that contains TrueType fonts.

**Returns:**
java.lang.String - the path to the folder that contains TrueType fonts.
##### getSearchOption()
```
public SearchOption getSearchOption()
```

Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders.

**Returns:**
SearchOption - the search option.
##### isRecursive()
```
public boolean isRecursive()
```

Checks if the fonts would be searched recursively.

**Returns:**
boolean -  true  if the fonts would be searched recursively,  false  otherwise.
##### equals(FolderFontSource other)
```
public boolean equals(FolderFontSource other)
```

Determines whether the current  FolderFontSource  is the same as the specified  FolderFontSource  object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FolderFontSource | The object to compare with the current  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are the same; otherwise,  false
##### equals(Object o)
```
public boolean equals(Object o)
```

Determines whether the current  FolderFontSource  is the same as the specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current  FolderFontSource  object. |

**Returns:**
boolean -  true  if the  obj  parameter is of type  FolderFontSource  and is the same as the current  FolderFontSource  object; otherwise,  false
##### hashCode()
```
public int hashCode()
```

Returns the hash code for the current  FolderFontSource  object.

**Returns:**
int - a hash code for the current  FolderFontSource  object.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - a string that represents the current object.

### FontFormat
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/fontformat.md

**Inheritance:**
java.lang.Object
```
public final class FontFormat
```

Represents all font formats, which may be present in the UsedFontInfo class.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Unknown or invalid font format. |
| TrueType | TrueType font format (TTF). |
| OpenType | OpenType font format (OTF). |
| TrueTypeCollection | TrueType Collection font format (TTC). |
| EmbeddedOpenType | Embedded OpenType font format (EOT). |
#### Methods

| Method | Description |
| --- | --- |
| toString(int format) | Converts a format value to a human-readable string. |
##### Unknown
```
public static final int Unknown
```

Unknown or invalid font format.

##### TrueType
```
public static final int TrueType
```

TrueType font format (TTF).

##### OpenType
```
public static final int OpenType
```

OpenType font format (OTF).

##### TrueTypeCollection
```
public static final int TrueTypeCollection
```

TrueType Collection font format (TTC).

##### EmbeddedOpenType
```
public static final int EmbeddedOpenType
```

Embedded OpenType font format (EOT).

##### toString(int format)
```
public static String toString(int format)
```

Converts a format value to a human-readable string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | int | the font format value |

**Returns:**
java.lang.String - a string representation of the font format

### FontSettings
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/fontsettings.md

**Inheritance:**
java.lang.Object
```
public class FontSettings
```

Provides methods for working with sources to look for TrueType fonts.

The FontSettings class is used to specify and manage sources for locating TrueType fonts. It provides methods to add and reset font sources for the GroupDocs.Viewer API.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| FontSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| setFontSources(FontSource[] fontSources) | Sets the sources to look for TrueType fonts when rendering documents. |
| resetFontSources() | Resets the font sources that have been set before. |
##### FontSettings()
```
public FontSettings()
```

##### setFontSources(FontSource[] fontSources)
```
public static void setFontSources(FontSource[] fontSources)
```

Sets the sources to look for TrueType fonts when rendering documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontSources | FontSource\[\] | The font sources to set. |

##### resetFontSources()
```
public static void resetFontSources()
```

Resets the font sources that have been set before.

### FontSource
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/fontsource.md

### FontStyles
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/fontstyles.md

**Inheritance:**
java.lang.Object
```
public final class FontStyles
```

Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontStyles(boolean isBold, boolean isItalic) | Creates a FontStyles instance from bold/italic flags. |
#### Fields

| Field | Description |
| --- | --- |
| Regular |  |
| Bold |  |
| Italic |  |
| BoldItalic |  |
| REGULAR |  |
| BOLD |  |
| ITALIC |  |
| BOLD_ITALIC |  |
#### Methods

| Method | Description |
| --- | --- |
| toString(int style) | Converts a style value to a human-readable string. |
| getName() | Returns readable name of this font style. |
| isBold() | Returns true if bold bit is set. |
| isItalic() | Returns true if italic bit is set. |
| toString() |  |
| equals(Object obj) |  |
| hashCode() |  |
| combine(FontStyles first, FontStyles second) | Union (C\# operator +) |
| subtract(FontStyles minuend, FontStyles subtrahend) | Difference (C\# operator -) |
| tryParse(String style, FontStyles[] parsed) | Parses a font style name to FontStyles. |
##### FontStyles(boolean isBold, boolean isItalic)
```
public FontStyles(boolean isBold, boolean isItalic)
```

Creates a FontStyles instance from bold/italic flags.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isBold | boolean |  |
| isItalic | boolean |  |

##### Regular
```
public static final int Regular
```

##### Bold
```
public static final int Bold
```

##### Italic
```
public static final int Italic
```

##### BoldItalic
```
public static final int BoldItalic
```

##### REGULAR
```
public static final FontStyles REGULAR
```

##### BOLD
```
public static final FontStyles BOLD
```

##### ITALIC
```
public static final FontStyles ITALIC
```

##### BOLD_ITALIC
```
public static final FontStyles BOLD_ITALIC
```

##### toString(int style)
```
public static String toString(int style)
```

Converts a style value to a human-readable string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | int | the font style value |

**Returns:**
java.lang.String - a string representation of the font style
##### getName()
```
public String getName()
```

Returns readable name of this font style.

**Returns:**
java.lang.String
##### isBold()
```
public boolean isBold()
```

Returns true if bold bit is set.

**Returns:**
boolean
##### isItalic()
```
public boolean isItalic()
```

Returns true if italic bit is set.

**Returns:**
boolean
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### combine(FontStyles first, FontStyles second)
```
public static FontStyles combine(FontStyles first, FontStyles second)
```

Union (C\# operator +)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | com.groupdocs.viewer.fonts.FontStyles |  |
| second | com.groupdocs.viewer.fonts.FontStyles |  |

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### subtract(FontStyles minuend, FontStyles subtrahend)
```
public static FontStyles subtract(FontStyles minuend, FontStyles subtrahend)
```

Difference (C\# operator -)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| minuend | com.groupdocs.viewer.fonts.FontStyles |  |
| subtrahend | com.groupdocs.viewer.fonts.FontStyles |  |

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### tryParse(String style, FontStyles[] parsed)
```
public static boolean tryParse(String style, FontStyles[] parsed)
```

Parses a font style name to FontStyles.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | java.lang.String |  |
| parsed | com.groupdocs.viewer.fonts.FontStyles[] |  |

**Returns:**
boolean - true on success, false otherwise.

### IFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/ifontinfo.md

### PdfFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/pdffontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public class PdfFontInfo implements IFontInfo
```

Encapsulates meta-information and binary data of one font from a PDF document, loaded into the Viewer instance.

This font is used in the document content and is either:

 *  embedded inside the PDF document
 *  or installed in the operating system where GroupDocs.Viewer is running
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format) | Internal constructor used by PDF font extraction. |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Gets the font family name. |
| getStyle() | Gets the style of this font. |
| isEmbedded() | Returns whether the font is embedded inside the PDF document. |
| isInstalled() | Returns whether the font is installed in the OS. |
| getFormat() | Returns the file format of the font. |
| getContent() | Returns the binary content of the font. |
| serializeToCss(Writer output) | Serializes this font as a CSS  @font-face  rule. |
##### PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format)
```
public PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format)
```

Internal constructor used by PDF font extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| familyName | java.lang.String | font family name |
| style | com.groupdocs.viewer.fonts.FontStyles | style (Regular, Bold, Italic, BoldItalic) |
| isEmbedded | boolean | true if the font is embedded in the PDF |
| isInstalled | boolean | true if the font is installed in the OS |
| content | byte[] | binary font data (nullable) |
| format | int | font file format |

##### getFamilyName()
```
public String getFamilyName()
```

Gets the font family name.

**Returns:**
java.lang.String - family name string (never null or empty)
##### getStyle()
```
public FontStyles getStyle()
```

Gets the style of this font.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles - the font style
##### isEmbedded()
```
public boolean isEmbedded()
```

Returns whether the font is embedded inside the PDF document.

**Returns:**
boolean - true if embedded
##### isInstalled()
```
public boolean isInstalled()
```

Returns whether the font is installed in the OS.

**Returns:**
boolean - true if installed
##### getFormat()
```
public int getFormat()
```

Returns the file format of the font.

**Returns:**
int - the font format enum
##### getContent()
```
public byte[] getContent()
```

Returns the binary content of the font.

**Returns:**
byte[] - byte array or null if not available
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font as a CSS  @font-face  rule.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | writer to which CSS will be written |

### PresentationFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/presentationfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class PresentationFontInfo implements IFontInfo
```

Encapsulates metadata and binary data of a font used in a Presentation document, loaded into the Viewer instance. This font is used in the document content and may be embedded inside the document itself or installed in the operating system where GroupDocs.Viewer is running.
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Gets the font family name (never null or empty). |
| getStyle() | Gets the style of the font: Regular, Bold, Italic, or BoldItalic. |
| isEmbedded() | Indicates whether this font is embedded inside the document loaded into the Viewer instance. |
| getFormat() | Gets the font format (TrueType, OpenType, etc.). |
| getContent() | Gets the binary font content, or null if font data is unavailable. |
| serializeToCss(Writer output) | Serializes this font info into CSS @font-face rule using the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Gets the font family name (never null or empty).

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Gets the style of the font: Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isEmbedded()
```
public boolean isEmbedded()
```

Indicates whether this font is embedded inside the document loaded into the Viewer instance. Note: Spreadsheet documents cannot contain embedded fonts, so for them this always returns false.

**Returns:**
boolean
##### getFormat()
```
public int getFormat()
```

Gets the font format (TrueType, OpenType, etc.). If only metadata is available, returns FontFormat.Unknown.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Gets the binary font content, or null if font data is unavailable.

**Returns:**
byte[]
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info into CSS @font-face rule using the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | writer to write CSS into (must not be null) |

### SearchOption
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/searchoption.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum SearchOption extends Enum<SearchOption>
```

Specifies whether to search the current folder, or the current folder and all subfolders.

The SearchOption enum is used to specify the scope of font search operation in the GroupDocs.Viewer API.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```

***Note:** This enum is typically used to specify strategy of searching fonts in provided directory.*
#### Fields

| Field | Description |
| --- | --- |
| TOP_FOLDER_ONLY | Includes only the current folder in a search. |
| ALL_FOLDERS | Includes the current folder and all the subfolders in a search. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### TOP_FOLDER_ONLY
```
public static final SearchOption TOP_FOLDER_ONLY
```

Includes only the current folder in a search.

##### ALL_FOLDERS
```
public static final SearchOption ALL_FOLDERS
```

Includes the current folder and all the subfolders in a search.

##### values()
```
public static SearchOption[] values()
```

**Returns:**
com.groupdocs.viewer.fonts.SearchOption[]
##### valueOf(String name)
```
public static SearchOption valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
SearchOption

### SpreadsheetFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/spreadsheetfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class SpreadsheetFontInfo implements IFontInfo
```

Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the Viewer instance. Spreadsheet documents cannot have embedded fonts, so this particular font, if returned by the Viewer.getAllFonts() method, is installed in the operating system where GroupDocs.Viewer is running.
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Family name of the font, without style, never null or empty. |
| getStyle() | Style of this font \\u2014 may be Regular, Bold, Italic, or BoldItalic. |
| isStrikeout() | Indicates whether the font is a single strikeout. |
| isUnderline() | Indicates whether the font has an underline. |
| getColor() | Color of this font. |
| getCharset() | Character set of this font. |
| getContent() | Content of this font as a byte array. |
| getFormat() | Format of this font. |
| serializeToCss(Writer output) | Serializes this font info as a @font-face at-rule and writes it to the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Family name of the font, without style, never null or empty.

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Style of this font \\u2014 may be Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isStrikeout()
```
public boolean isStrikeout()
```

Indicates whether the font is a single strikeout.

**Returns:**
boolean
##### isUnderline()
```
public boolean isUnderline()
```

Indicates whether the font has an underline.

**Returns:**
boolean
##### getColor()
```
public Argb32Color getColor()
```

Color of this font.

**Returns:**
Argb32Color
##### getCharset()
```
public int getCharset()
```

Character set of this font.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Content of this font as a byte array. May be null if only meta info is available.

**Returns:**
byte[]
##### getFormat()
```
public int getFormat()
```

Format of this font.

**Returns:**
int
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info as a @font-face at-rule and writes it to the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | Device to write serialized text data into. |

### WordProcessingFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/wordprocessingfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class WordProcessingFontInfo implements IFontInfo
```

Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the Viewer instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system where GroupDocs.Viewer is running.

Immutable class. Its instances are produced and returned by the GroupDocs.Viewer public API and normally should not be created by the user. For details, see the documentation: https://docs.groupdocs.com/viewer/net/getting-used-fonts/
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Family name of the font, without style, never null or empty. |
| getAltFamilyName() | Alternative family name of the font. |
| getStyle() | Style of the font \\u2014 may be Regular, Bold, Italic, or BoldItalic. |
| isEmbedded() | Indicates whether this font is embedded inside the document (true) or a system font (false). |
| getFormat() | Format of this font. |
| getContent() | Content of this font as a byte array, or null if unavailable. |
| getCharset() | Character set of this font. |
| toString() | Returns debug info about this font in the following template: "name style, embedded/system, format" |
| serializeToCss(Writer output) | Serializes this font info as a @font-face CSS rule and writes it to the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Family name of the font, without style, never null or empty.

**Returns:**
java.lang.String
##### getAltFamilyName()
```
public String getAltFamilyName()
```

Alternative family name of the font. If missing, returns empty string.

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Style of the font \\u2014 may be Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isEmbedded()
```
public boolean isEmbedded()
```

Indicates whether this font is embedded inside the document (true) or a system font (false).

**Returns:**
boolean
##### getFormat()
```
public int getFormat()
```

Format of this font. If there is only metainfo and binary content is missing, may return FontFormat.UNKNOWN.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Content of this font as a byte array, or null if unavailable.

**Returns:**
byte[]
##### getCharset()
```
public int getCharset()
```

Character set of this font.

**Returns:**
int
##### toString()
```
public String toString()
```

Returns debug info about this font in the following template: "name style, embedded/system, format"

**Returns:**
java.lang.String
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info as a @font-face CSS rule and writes it to the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | Writer to receive the serialized CSS. |

### WordProcessingSubstitutedFontInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class WordProcessingSubstitutedFontInfo implements IFontInfo
```

Encapsulates metadata and binary data of one substituted font used in a WordProcessing document via GroupDocs.Viewer. Immutable class.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format) | Constructor to initialize all fields. |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Returns the family name of the substituted font (never null). |
| getOriginalFamilyName() | Returns the family name of the original font (never null). |
| getStyle() | Returns the style of the original font. |
| getContent() | Returns the binary content of the substituted font (never null). |
| getFormat() | Returns the font format of the substituted font. |
| toString() | Returns a string describing this substituted font: "original-name -> substituted-name style, format" |
| equals(Object obj) | Equality based on original family, substituted family, and style. |
| hashCode() |  |
| serializeToCss(Writer output) | Serialize this font as a @font-face CSS rule using a utility method. |
##### WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format)
```
public WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format)
```

Constructor to initialize all fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalFamilyName | java.lang.String | The original font name (not found on system) |
| substitutedFamilyName | java.lang.String | The substituted font name (available) |
| style | com.groupdocs.viewer.fonts.FontStyles | Font style (Regular, Bold, Italic, BoldItalic) |
| content | byte[] | Binary content of substituted font (never null) |
| format | int | Font format (TrueType, OpenType, etc.) |

##### getFamilyName()
```
public String getFamilyName()
```

Returns the family name of the substituted font (never null).

**Returns:**
java.lang.String
##### getOriginalFamilyName()
```
public String getOriginalFamilyName()
```

Returns the family name of the original font (never null).

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Returns the style of the original font.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### getContent()
```
public byte[] getContent()
```

Returns the binary content of the substituted font (never null).

**Returns:**
byte[]
##### getFormat()
```
public int getFormat()
```

Returns the font format of the substituted font.

**Returns:**
int
##### toString()
```
public String toString()
```

Returns a string describing this substituted font: "original-name -> substituted-name style, format"

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Equality based on original family, substituted family, and style. Required for usage in HashSet or HashMap like C\# IEqualityComparer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serialize this font as a @font-face CSS rule using a utility method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer |  |

### com.groupdocs.viewer.interfaces
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces.md

The package provides interfaces for instantiating and releasing the output document and its resources.

These interfaces are used to manage the creation and release of streams and URLs associated with the output file, pages, and HTML resources.

The main interfaces in this package are:

 *  CreateFileStream - Represents an interface for instantiating a stream used to write output file data.
 *  FileStreamFactory - Defines methods for instantiating and releasing the output file stream.
 *  ReleasePageStream - Releases a stream that was instantiated by a method associated with the CreatePageStream interface.

For more details on working with these interfaces and customizing the output document and resource handling in GroupDocs.Viewer, lease refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Interfaces

| Interface | Description |
| --- | --- |
| CreateFileStream | Represents an interface that instantiates a stream used to write output file data. |
| CreatePageStream | Represents an interface that instantiates a stream used to write output page data. |
| CreateResourceStream | Represents an interface that instantiates a stream used to write output HTML resource data. |
| CreateResourceUrl | Represents an interface that creates a URL for an HTML resource. |
| FileReader | Declares an interface for reading a file stream. |
| FileStreamFactory | Defines methods that are required for instantiating and releasing an output file stream. |
| PageStreamFactory | Defines the methods that are required for instantiating and releasing an output page stream. |
| ReleaseFileStream | Releases an interface that was instantiated by the method associated with the CreateFileStream interface. |
| ReleasePageStream | Releases a stream that was instantiated by the method associated with the CreatePageStream interface. |
| ReleaseResourceStream | Releases a stream that was instantiated by the method associated with the CreateResourceStream interface. |
| ResourceStreamFactory | Defines the methods that are required for creating a resource URL, instantiating, and releasing an output HTML resource stream. |

### CreateFileStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/createfilestream.md

### CreatePageStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/createpagestream.md

### CreateResourceStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/createresourcestream.md

### CreateResourceUrl
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/createresourceurl.md

### FileReader
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/filereader.md

**All Implemented Interfaces:**
java.io.Closeable
```
public interface FileReader extends Closeable
```

Declares an interface for reading a file stream.

The FileReader interface provides a method for reading a file stream. It is used for accessing and reading the contents of a file in a sequential manner. Implementations of this interface should handle the necessary operations to read data from a file.

Example usage:

```

 FileReader fileReader = new FileReader() {
     @Override
     public InputStream read() {
         // Create document stream
     }

     @Override
     public void close() {
         // Close the stream
     }
 };
 try (Viewer viewer = new Viewer(fileReader, new ViewerSettings())){
     // Process document
 }
 
```
#### Methods

| Method | Description |
| --- | --- |
| read() | Returns an InputStream that represents a readable stream for the file. |
| close() | Disposes the object and releases any system resources associated with it. |
##### read()
```
public abstract InputStream read()
```

Returns an InputStream that represents a readable stream for the file.

**Returns:**
java.io.InputStream - the InputStream readable stream.
##### close()
```
public abstract void close()
```

Disposes the object and releases any system resources associated with it.

### FileStreamFactory
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/filestreamfactory.md

### PageStreamFactory
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/pagestreamfactory.md

### ReleaseFileStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/releasefilestream.md

### ReleasePageStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/releasepagestream.md

### ReleaseResourceStream
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/releaseresourcestream.md

### ResourceStreamFactory
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.interfaces/resourcestreamfactory.md

### com.groupdocs.viewer.logging
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.logging.md

The package provides classes for configuring the logging system in GroupDocs.Viewer.

By using these classes, you can control how log messages are handled, such as writing them to a file or directing them to a specific logger implementation.

The main classes in this package are:

 *  FileLogger - Writes log messages to a file.
 *  ViewerLogger - Implements logging messages to an integrated or user-defined logger.

For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| FileLogger | Writes log messages to a file. |
| ViewerLogger | Global viewer logger. |

### FileLogger
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.logging/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.foundation.logging.ILogger
```
public class FileLogger implements ILogger
```

Writes log messages to a file.

The  FileLogger  class provides functionality to write log messages to a file. It implements the ILogger interface and can be used to log various events and messages in an application. Log messages are written to the specified file.

Example usage:

```

 // Create a new instance of FileLogger with the specified log file path
 FileLogger fileLogger = new FileLogger("/path/to/logfile.txt");

 // Log an informational message
 fileLogger.debug("Debug message");

 // Log an error message
 fileLogger.error("Error message");

 // Check is logging warning messages enabled
 boolean warningEnabled = fileLogger.isWarningEnabled();
 
```

***Note:** The  FileLogger  class provides basic logging functionality. You can extend this class to add custom log levels or additional logging features as per your requirements.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String fileName) | Creates a logger that logs messages to a file specified by the provided file name. |
| FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) | Creates a logger that logs messages to a file with specified logging levels. |
#### Fields

| Field | Description |
| --- | --- |
| MESSAGE |  |
| EXCEPTION |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes a trace message to the console. |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace log message to the console. |
| isTraceEnabled() | Checks if the trace level is enabled for logging. |
| debug(String message, Object[] arguments) | Writes a debug log message to the console. |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug log message to the console. |
| isDebugEnabled() | Checks if the debug level is enabled for logging. |
| warning(String message, Object[] arguments) | Writes a warning log message to the console. |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning log message to the console. |
| isWarningEnabled() | Checks if the warning level is enabled for logging. |
| error(String message, Object[] arguments) | Writes an error log message to the console. |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error log message to the console. |
| isErrorEnabled() | Checks if error-level logging is enabled. |
##### FileLogger(String fileName)
```
public FileLogger(String fileName)
```

Creates a logger that logs messages to a file specified by the provided file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The full file name with path. |

##### FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```
public FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```

Creates a logger that logs messages to a file with specified logging levels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The full file name with path. |
| isTraceEnabled | boolean | Specifies whether trace level logging is enabled. |
| isDebugEnabled | boolean | Specifies whether debug level logging is enabled. |
| isWarningEnabled | boolean | Specifies whether warning level logging is enabled. |
| isErrorEnabled | boolean | Specifies whether error level logging is enabled. |

##### 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 console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public void trace(Throwable throwable, String message, Object[] arguments)
```

Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the trace log message. |
| message | java.lang.String | The trace log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isTraceEnabled()
```
public boolean isTraceEnabled()
```

Checks if the trace level is enabled for logging.

**Returns:**
boolean -  true  if the trace level is enabled,  false  otherwise.
##### debug(String message, Object[] arguments)
```
public void debug(String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public void debug(Throwable throwable, String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the debug log message. |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isDebugEnabled()
```
public boolean isDebugEnabled()
```

Checks if the debug level is enabled for logging.

**Returns:**
boolean -  true  if the debug level is enabled,  false  otherwise.
##### warning(String message, Object[] arguments)
```
public void warning(String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public void warning(Throwable throwable, String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the warning log message. |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isWarningEnabled()
```
public boolean isWarningEnabled()
```

Checks if the warning level is enabled for logging.

**Returns:**
boolean -  true  if the warning level is enabled,  false  otherwise.
##### error(String message, Object[] arguments)
```
public void error(String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### error(Throwable throwable, String message, Object[] arguments)
```
public void error(Throwable throwable, String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the error log message. |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isErrorEnabled()
```
public boolean isErrorEnabled()
```

Checks if error-level logging is enabled.

**Returns:**
boolean -  true  if error-level logging is enabled,  false  otherwise.

### ViewerLogger
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.logging/viewerlogger.md

**Inheritance:**
java.lang.Object
```
public class ViewerLogger
```

Global viewer logger.

The  ViewerLogger  class provides functionality to log messages to an integrated or user-defined logger. It serves as the global logger for the viewer module and can be used to log various events and messages.

Example usage:

```

 // Configure the viewer logger to use the default integrated logger
 ViewerLogger.setLogger(new FileLogger("/path/to/file.log"));

 // Log an debug message
 ViewerLogger.debug("Debug message");

 // Log an error message
 ViewerLogger.error("Error message");
 
```

***Note:** The  ViewerLogger  class can be configured to use a custom logger implementation by calling the setLogger(ILogger) method. By default, it uses the integrated logger provided by the viewer module.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewerLogger() |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes a trace message to the console. |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace log message to the console. |
| isTraceEnabled() | Checks if the trace level is enabled for logging. |
| debug(String message, Object[] arguments) | Writes a debug log message to the console. |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug log message to the console. |
| isDebugEnabled() | Checks if the debug level is enabled for logging. |
| warning(String message, Object[] arguments) | Writes a warning log message to the console. |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning log message to the console. |
| isWarningEnabled() | Checks if the warning level is enabled for logging. |
| error(String message, Object[] arguments) | Writes an error log message to the console. |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error log message to the console. |
| isErrorEnabled() | Checks if error-level logging is enabled. |
| getLogger() | Gets the logger instance that will be used for logging messages. |
| setLogger(ILogger logger) | Sets the logger instance that will be used for logging messages. |
##### ViewerLogger()
```
public ViewerLogger()
```

##### trace(String message, Object[] arguments)
```
public static void trace(String message, Object[] arguments)
```

Writes a trace message to the console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public static void trace(Throwable throwable, String message, Object[] arguments)
```

Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the trace log message. |
| message | java.lang.String | The trace log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isTraceEnabled()
```
public static boolean isTraceEnabled()
```

Checks if the trace level is enabled for logging.

**Returns:**
boolean -  true  if the trace level is enabled,  false  otherwise.
##### debug(String message, Object[] arguments)
```
public static void debug(String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public static void debug(Throwable throwable, String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the debug log message. |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isDebugEnabled()
```
public static boolean isDebugEnabled()
```

Checks if the debug level is enabled for logging.

**Returns:**
boolean -  true  if the debug level is enabled,  false  otherwise.
##### warning(String message, Object[] arguments)
```
public static void warning(String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public static void warning(Throwable throwable, String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the warning log message. |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isWarningEnabled()
```
public static boolean isWarningEnabled()
```

Checks if the warning level is enabled for logging.

**Returns:**
boolean -  true  if the warning level is enabled,  false  otherwise.
##### error(String message, Object[] arguments)
```
public static void error(String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### error(Throwable throwable, String message, Object[] arguments)
```
public static void error(Throwable throwable, String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the error log message. |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isErrorEnabled()
```
public static boolean isErrorEnabled()
```

Checks if error-level logging is enabled.

**Returns:**
boolean -  true  if error-level logging is enabled,  false  otherwise.
##### getLogger()
```
public static synchronized ILogger getLogger()
```

Gets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error.

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger instance.
##### setLogger(ILogger logger)
```
public static synchronized void setLogger(ILogger logger)
```

Sets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger instance to set. |

### com.groupdocs.viewer.options
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options.md

The package provides classes to specify additional options when rendering documents.

It includes options for rendering various document formats, defining permissions and security settings, specifying watermark properties, and retrieving information about views.

The main classes in this package are:

 *  ArchiveOptions - Provides options for rendering archive files.
 *  PdfOptions - Provides options for rendering PDF documents.
 *  WordProcessingOptions - Provides options for rendering word processing documents.

For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| ArchiveOptions | Provides options for rendering archive files. |
| ArchiveSecurityOptions | Class that can be used to limit the archives extraction process. |
| BaseViewOptions | Contains the base rendering options. |
| CadOptions | Provides options for rendering CAD drawings. |
| EmailOptions | Provides options for rendering email messages. |
| FileName | Represents the name of a file in an archive. |
| HtmlViewOptions | Provides options for rendering documents into HTML format. |
| JpgViewOptions | Provides options for rendering documents into JPG format. |
| LoadOptions | Provides options that are used to open a file. |
| MailStorageOptions | Provides options for rendering Mail storage (Lotus Notes, MBox) data files. |
| OutlookOptions | Provides options for rendering Outlook data files. |
| PdfOptimizationOptions | Use this class to specify PDF optimization options to apply to the output PDF file. |
| PdfOptions | Provides options for rendering PDF documents. |
| PdfViewOptions | Provides options for rendering documents into PDF format. |
| Permissions | Defines PDF document permissions. |
| PngViewOptions | Provides options for rendering documents into PNG format. |
| PresentationOptions | Provides options for rendering presentations options. |
| ProjectManagementOptions | Provides options for rendering project management files. |
| SearchHighlightOptions | Provides options for searching and highlighting text in the documents, loaded to the Viewer class. |
| Security | Provides PDF document security options. |
| Size | Contains the watermark size. |
| SpreadsheetOptions | Provides options for rendering spreadsheets. |
| TextOptions | Text files splitting to pages options. |
| Tile | Represents drawing region. |
| ViewInfoOptions | Provides options used for retrieving information about view. |
| ViewOptions | Contains the rendering options. |
| VisioRenderingOptions | Contains options for rendering Visio documents. |
| Watermark | Represents a text watermark. |
| WordProcessingOptions | Provides options for rendering word processing documents. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IMaxSizeOptions | Limits of image size options interface. |

#### Enumerations

| Enum | Description |
| --- | --- |
| Field | Represents email message fields e.g. From, To, Subject etc. |
| ImageQuality | The quality of images in the output HTML contained by the PDF documents. |
| PageSize | The size of the page. |
| Position | Defines watermark position. |
| Resolution | Provides option to set resolution for images : output document. |
| Rotation | Contains page rotation in degrees (clockwise). |
| TextOverflowMode | Defines text overflow mode for rendering spreadsheet documents into HTML. |
| TimeUnit | Time unit of the project duration. |

### ArchiveOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/archiveoptions.md

**Inheritance:**
java.lang.Object
```
public class ArchiveOptions
```

Provides options for rendering archive files.

The  ArchiveOptions  class represents a set of options that can be used to configure the rendering of archive files in the viewer module. It allows you to customize various aspects of the rendering process, such as the count of items on each page and so on.

Example usage:

```

 // Create an instance of ArchiveOptions
 ArchiveOptions options = new ArchiveOptions();

 // Set the count of items to be shown on each page
 options.setItemsPerPage(16);

 // Create a Viewer instance with the specified options
 try (final Viewer viewer = new Viewer(documentPath, options)) {
     // Use the viewer object for document rendering
 }
 
```

***Note:** The  ArchiveOptions  class provides a range of customization options for rendering archive files. You can configure these options based on your specific requirements to achieve the desired output.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveOptions() | Creates a new instance of the ArchiveOptions class with default settings. |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Gets the folder inside the archive that will be used for rendering. |
| setFolder(String value) | Sets the folder inside the archive that will be used for rendering. |
| getFileName() | Gets the filename to be displayed in the header. |
| setFileName(FileName fileName) | Sets the filename to be displayed in the header. |
##### ArchiveOptions()
```
public ArchiveOptions()
```

Creates a new instance of the ArchiveOptions class with default settings.

##### getFolder()
```
public final String getFolder()
```

Gets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-archive-files/#render-a-specific-folder

**Returns:**
java.lang.String - the folder to be rendered.
##### setFolder(String value)
```
public final void setFolder(String value)
```

Sets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#render-a-specific-folder

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The folder to be rendered. |

##### getFileName()
```
public FileName getFileName()
```

Gets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#specify-the-archive-file-name

**Returns:**
FileName - the filename to be displayed.
##### setFileName(FileName fileName)
```
public void setFileName(FileName fileName)
```

Sets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#specify-the-archive-file-name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | FileName | The filename to be displayed. |

### ArchiveSecurityOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/archivesecurityoptions.md

**Inheritance:**
java.lang.Object
```
public class ArchiveSecurityOptions
```

Class that can be used to limit the archives extraction process.

The ArchiveSecurityOptions class provides a way to limit the extraction of archives and enforce certain restrictions.

Example usage:

```

 ArchiveSecurityOptions securityOptions = new ArchiveSecurityOptions();
 securityOptions.setMaxAllowedEntryNameLength(255);
 securityOptions.setMaxAllowedEntrySize(10737418240L);
 securityOptions.setMaxAllowedEntriesCount(1000);
 securityOptions.setMaxAllowedEntryCompressionRatio(100);

 final LoadOptions loadOptions = new LoadOptions();
 loadOptions.setArchiveSecurityOptions(securityOptions);

 // Create a Viewer instance with the specified options
 try (final Viewer viewer = new Viewer(documentPath, loadOptions)) {
     // Use the viewer object for archive document rendering
 }
 
```

***Note:** Not each archive type supports all options.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveSecurityOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getMaxAllowedEntryNameLength() | This option specifies the maximum length that an archive entry name can have. |
| setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength) | Sets the maximum allowed length for the archive entry names. |
| getMaxAllowedEntrySize() | Retrieves the maximum allowed size for archive entries. |
| setMaxAllowedEntrySize(long maxAllowedEntrySize) | Sets the maximum allowed size for archive entries. |
| getMaxAllowedEntriesCount() | Retrieves the maximum allowed count of entries in an archive. |
| setMaxAllowedEntriesCount(long maxAllowedEntriesCount) | Sets the maximum allowed count of entries in an archive. |
| getMaxAllowedEntryCompressionRatio() | Specifies the maximum compression ratio allowed for extracting archive entries. |
| setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio) | Specifies the maximum compression ratio allowed for extracting archive entries. |
##### ArchiveSecurityOptions()
```
public ArchiveSecurityOptions()
```

##### getMaxAllowedEntryNameLength()
```
public int getMaxAllowedEntryNameLength()
```

This option specifies the maximum length that an archive entry name can have. If an entry name exceeds this limit, it will cause an error.

***Note:** The default value for this option is 255.*

**Returns:**
int - the maximum allowed length for the archive entry names.
##### setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)
```
public void setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)
```

Sets the maximum allowed length for the archive entry names. The maximum allowed length specifies the limit for the length of an archive entry name. If the length of an entry name exceeds this limit, it will cause an error.

***Note:** The default value for the maximum allowed entry name length is 255.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryNameLength | int | The maximum archive entry name length to be set. |

##### getMaxAllowedEntrySize()
```
public long getMaxAllowedEntrySize()
```

Retrieves the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error.

***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).*

**Returns:**
long - the maximum archive entry size.
##### setMaxAllowedEntrySize(long maxAllowedEntrySize)
```
public void setMaxAllowedEntrySize(long maxAllowedEntrySize)
```

Sets the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error.

***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntrySize | long | The maximum archive entry size. |

##### getMaxAllowedEntriesCount()
```
public long getMaxAllowedEntriesCount()
```

Retrieves the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted.

***Note:** The default value for the maximum allowed entries count is 1000.*

**Returns:**
long - the maximum count of entries in an archive.
##### setMaxAllowedEntriesCount(long maxAllowedEntriesCount)
```
public void setMaxAllowedEntriesCount(long maxAllowedEntriesCount)
```

Sets the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted.

***Note:** The default value for the maximum allowed entries count is 1000.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntriesCount | long | The maximum count of entries in an archive. |

##### getMaxAllowedEntryCompressionRatio()
```
public double getMaxAllowedEntryCompressionRatio()
```

Specifies the maximum compression ratio allowed for extracting archive entries.

***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.*

**Returns:**
double - the maximum allowed compression ratio for archive entries.
##### setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)
```
public void setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)
```

Specifies the maximum compression ratio allowed for extracting archive entries.

***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryCompressionRatio | double | The maximum allowed compression ratio for archive entries. |

### BaseViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/baseviewoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class BaseViewOptions
```

Contains the base rendering options.

The  BaseViewOptions  class serves as the base for rendering options in GroupDocs.Viewer. It allows you to customize the rendering behavior of the output HTML, PDF, PNG, and JPEG files when rendering specific document formats.

***Note:** For internal usage.*
#### Constructors

| Constructor | Description |
| --- | --- |
| BaseViewOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTextOptions() | Retrieves the options for splitting text files into pages. |
| setTextOptions(TextOptions textOptions) | Sets the options for splitting text files into pages. |
| isRenderComments() | Enables rendering comments. |
| setRenderComments(boolean value) | Enables rendering comments. |
| isRemoveComments() | Disables rendering comments when set to true. |
| setRemoveComments(boolean value) | Disables rendering comments when set to true. |
| isRenderNotes() | Enables rendering notes. |
| setRenderNotes(boolean value) | Enables rendering notes. |
| isRenderHiddenPages() | Enables rendering of hidden pages. |
| setRenderHiddenPages(boolean value) | Enables rendering of hidden pages. |
| getDefaultFontName() | Default font to be used when a particular font used in the document can't be found. |
| setDefaultFontName(String value) | Default font to be used when a particular font used in the document can't be found. |
| getArchiveOptions() | Retrieves the archive files view options. |
| setArchiveOptions(ArchiveOptions value) | Sets the archive files view options. |
| getCadOptions() | Retrieves the CAD drawing view options. |
| setCadOptions(CadOptions value) | Sets the CAD drawing view options. |
| isCadOptionsInitialized_Internal() |  |
| getEmailOptions() | Retrieves the email messages view options. |
| setEmailOptions(EmailOptions value) | Sets the email messages view options. |
| getOutlookOptions() | Retrieves the MS Outlook data files view options. |
| setOutlookOptions(OutlookOptions value) | Sets the MS Outlook data files view options. |
| getPdfOptions() | Retrieves the PDF documents view options. |
| setPdfOptions(PdfOptions value) | Retrieves the PDF documents view options. |
| getMailStorageOptions() | Retrieves the Lotus Notes storage data files view options. |
| setMailStorageOptions(MailStorageOptions mailStorageOptions) | Sets the Lotus Notes storage data files view options. |
| getProjectManagementOptions() | Retrieves the project management files view options. |
| setProjectManagementOptions(ProjectManagementOptions projectManagementOptions) | Sets the project management files view options. |
| getSpreadsheetOptions() | Retrieves the spreadsheet files view options. |
| setSpreadsheetOptions(SpreadsheetOptions value) | Sets the spreadsheet files view options. |
| getWordProcessingOptions() | The Word processing files view options. |
| setWordProcessingOptions(WordProcessingOptions wordProcessingOptions) | The Word processing files view options. |
| getVisioRenderingOptions() | Retrieves the rendering options for processing Visio files when viewing documents. |
| setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions) | Sets the rendering options for processing Visio files when viewing documents. |
| getPresentationOptions() | Retrieves the view options for processing presentation documents. |
| setPresentationOptions(PresentationOptions presentationOptions) | Sets the view options for processing presentation documents. |
| getWebDocumentOptions() | Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. |
| setWebDocumentOptions(WebDocumentOptions webDocumentOptions) | Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. |
##### BaseViewOptions()
```
public BaseViewOptions()
```

##### getTextOptions()
```
public TextOptions getTextOptions()
```

Retrieves the options for splitting text files into pages.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/

**Returns:**
TextOptions - the text file splitting options.
##### setTextOptions(TextOptions textOptions)
```
public void setTextOptions(TextOptions textOptions)
```

Sets the options for splitting text files into pages.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textOptions | TextOptions | The text file splitting options. |

##### isRenderComments()
```
public final boolean isRenderComments()
```

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/#render-comments

**Returns:**
boolean -  true  if comments should be rendered,  false  otherwise.
##### setRenderComments(boolean value)
```
public final void setRenderComments(boolean value)
```

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/#render-comments

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if comments should be rendered,  false  otherwise. |

##### isRemoveComments()
```
public final boolean isRemoveComments()
```

Disables rendering comments when set to true. By default is false \\u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete 'RenderComments' property.

**Returns:**
boolean -  true  if comments should be rendered,  false  otherwise.
##### setRemoveComments(boolean value)
```
public final void setRemoveComments(boolean value)
```

Disables rendering comments when set to true. By default is false \\u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete 'RenderComments' property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if comments should be rendered,  false  otherwise. |

##### isRenderNotes()
```
public final boolean isRenderNotes()
```

Enables rendering notes.

Some files, such as presentations or Microsoft project files, may contain notes. By default, GroupDocs.Viewer does not render notes. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-speaker-notes

**Returns:**
boolean -  true  if notes should be rendered,  false  otherwise.
##### setRenderNotes(boolean value)
```
public final void setRenderNotes(boolean value)
```

Enables rendering notes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if notes should be rendered,  false  otherwise. |

##### isRenderHiddenPages()
```
public final boolean isRenderHiddenPages()
```

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-hidden-slides

**Returns:**
boolean -  true  if hidden pages should be rendered,  false  otherwise.
##### setRenderHiddenPages(boolean value)
```
public final void setRenderHiddenPages(boolean value)
```

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-hidden-slides

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if hidden pages should be rendered,  false  otherwise. |

##### getDefaultFontName()
```
public final String getDefaultFontName()
```

Default font to be used when a particular font used in the document can't be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/replace-missing-font/

**Returns:**
java.lang.String - the name of the default font.
##### setDefaultFontName(String value)
```
public final void setDefaultFontName(String value)
```

Default font to be used when a particular font used in the document can't be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/replace-missing-font/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the default font. |

##### getArchiveOptions()
```
public final ArchiveOptions getArchiveOptions()
```

Retrieves the archive files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/

**Returns:**
ArchiveOptions - the archive files view options.
##### setArchiveOptions(ArchiveOptions value)
```
public final void setArchiveOptions(ArchiveOptions value)
```

Sets the archive files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ArchiveOptions | The archive files view options. |

##### getCadOptions()
```
public final CadOptions getCadOptions()
```

Retrieves the CAD drawing view options.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/

**Returns:**
CadOptions - the CAD drawing view options.
##### setCadOptions(CadOptions value)
```
public final void setCadOptions(CadOptions value)
```

Sets the CAD drawing view options.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | CadOptions | The CAD drawing view options. |

##### isCadOptionsInitialized_Internal()
```
public boolean isCadOptionsInitialized_Internal()
```

**Returns:**
boolean
##### getEmailOptions()
```
public final EmailOptions getEmailOptions()
```

Retrieves the email messages view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Returns:**
EmailOptions - Email messages view options.
##### setEmailOptions(EmailOptions value)
```
public final void setEmailOptions(EmailOptions value)
```

Sets the email messages view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | EmailOptions | Email messages view options. |

##### getOutlookOptions()
```
public final OutlookOptions getOutlookOptions()
```

Retrieves the MS Outlook data files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/

**Returns:**
OutlookOptions - MS Outlook data files view options.
##### setOutlookOptions(OutlookOptions value)
```
public final void setOutlookOptions(OutlookOptions value)
```

Sets the MS Outlook data files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | OutlookOptions | The MS Outlook data files view options to set. |

##### getPdfOptions()
```
public final PdfOptions getPdfOptions()
```

Retrieves the PDF documents view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/

**Returns:**
PdfOptions - the PDF documents view options.
##### setPdfOptions(PdfOptions value)
```
public final void setPdfOptions(PdfOptions value)
```

Retrieves the PDF documents view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptions | The PDF documents view options. |

##### getMailStorageOptions()
```
public MailStorageOptions getMailStorageOptions()
```

Retrieves the Lotus Notes storage data files view options.

**Returns:**
MailStorageOptions - the Lotus Notes storage data files view options.
##### setMailStorageOptions(MailStorageOptions mailStorageOptions)
```
public void setMailStorageOptions(MailStorageOptions mailStorageOptions)
```

Sets the Lotus Notes storage data files view options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailStorageOptions | MailStorageOptions | The Lotus Notes storage data files view options. |

##### getProjectManagementOptions()
```
public final ProjectManagementOptions getProjectManagementOptions()
```

Retrieves the project management files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/

**Returns:**
ProjectManagementOptions - the project management files view options.
##### setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
```
public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
```

Sets the project management files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| projectManagementOptions | ProjectManagementOptions | The project management files view options to be set. |

##### getSpreadsheetOptions()
```
public final SpreadsheetOptions getSpreadsheetOptions()
```

Retrieves the spreadsheet files view options.

For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files], [Split a worksheet into pages][], and [Specify spreadsheet rendering options][].

[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Split a worksheet into pages]: https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/
[Specify spreadsheet rendering options]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/

**Returns:**
SpreadsheetOptions - the spreadsheet files view options.
##### setSpreadsheetOptions(SpreadsheetOptions value)
```
public final void setSpreadsheetOptions(SpreadsheetOptions value)
```

Sets the spreadsheet files view options.

For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files], [Split a worksheet into pages][], and [Specify spreadsheet rendering options][].

[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Split a worksheet into pages]: https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/
[Specify spreadsheet rendering options]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetOptions | The spreadsheet files view options. |

##### getWordProcessingOptions()
```
public final WordProcessingOptions getWordProcessingOptions()
```

The Word processing files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/

**Returns:**
WordProcessingOptions - the Word processing options for rendering Word documents.
##### setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
```
public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
```

The Word processing files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordProcessingOptions | WordProcessingOptions | The Word processing options for rendering Word documents. |

##### getVisioRenderingOptions()
```
public VisioRenderingOptions getVisioRenderingOptions()
```

Retrieves the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/

**Returns:**
VisioRenderingOptions - the Visio rendering options for processing Visio files.
##### setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
```
public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
```

Sets the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visioRenderingOptions | VisioRenderingOptions | The Visio rendering options for processing Visio files. |

##### getPresentationOptions()
```
public PresentationOptions getPresentationOptions()
```

Retrieves the view options for processing presentation documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/

**Returns:**
com.groupdocs.viewer.options.PresentationOptions - the presentation view options for processing presentation documents.
##### setPresentationOptions(PresentationOptions presentationOptions)
```
public void setPresentationOptions(PresentationOptions presentationOptions)
```

Sets the view options for processing presentation documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| presentationOptions | com.groupdocs.viewer.options.PresentationOptions | The presentation view options for processing presentation documents. |

##### getWebDocumentOptions()
```
public WebDocumentOptions getWebDocumentOptions()
```

Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-web-documents/

**Returns:**
com.groupdocs.viewer.options.WebDocumentOptions - The WebDocumentOptions object for customizing the rendering options.
##### setWebDocumentOptions(WebDocumentOptions webDocumentOptions)
```
public void setWebDocumentOptions(WebDocumentOptions webDocumentOptions)
```

Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-web-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| webDocumentOptions | com.groupdocs.viewer.options.WebDocumentOptions | The WebDocumentOptions object for customizing the rendering options. |

### CadOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/cadoptions.md

**Inheritance:**
java.lang.Object
```
public class CadOptions
```

Provides options for rendering CAD drawings.

The CadOptions class encapsulates various settings and parameters that can be used to control the rendering of CAD drawings in the GroupDocs.Viewer component.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

Example usage:

```

 CadOptions options = CadOptions.forRenderingByWidth(256);
 options.setRenderLayouts(true);
 options.setBackgroundColor(Color.YELLOW);
 options.setLayers(Arrays.asList(
         CacheableFactory.getInstance().newLayer("Layer1"),
         CacheableFactory.getInstance().newLayer("Layer2")
 ));

 try (Viewer viewer = new Viewer("document.dwg")) {
     PdfViewOptions pdfViewOptions = new PdfViewOptions();
     pdfViewOptions.setCadOptions(options);
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/
#### Fields

| Field | Description |
| --- | --- |
| WIDTH |  |
| HEIGHT |  |
#### Methods

| Method | Description |
| --- | --- |
| getPc3File() | Retrieves the PC3 (Plotter Configuration) file associated with the plotter. |
| setPc3File(String pc3File) | Sets the PC3 (Plotter Configuration) file associated with the plotter. |
| forRenderingByScaleFactor(double scaleFactor) | Initializes a new instance of the  CadOptions  class for rendering by scale factor. |
| forRenderingByWidth(int width) | Initializes a new instance of the  CadOptions  class for rendering by width. |
| forRenderingByHeight(int height) | Initializes a new instance of the  CadOptions  class for rendering by height. |
| forRenderingByWidthAndHeight(int width, int height) | Initializes a new instance of the  CadOptions  class for rendering by width and height. |
| getScaleFactor() | Gets the scale factor for rendering. |
| getWidth() | Gets the width of the output result in pixels. |
| getHeight() | Gets the height of the output result in pixels. |
| getBackgroundColor() | Gets the background color of the image. |
| getBackgroundColorAsHex() | Gets the background color of the image. |
| setBackgroundColor(Color backgroundColor) | Sets the background color of the image. |
| setBackgroundColor(String colorName) | Sets the background color of the image. |
| getTiles() | Gets the drawing regions to render. |
| setTiles(List<Tile> value) | Sets the drawing regions to render. |
| isRenderLayouts() | Indicates whether layouts from the CAD document should be rendered. |
| setRenderLayouts(boolean value) | Sets whether layouts from the CAD document should be rendered. |
| getLayoutName() | Gets the name of the specific layout to render. |
| setLayoutName(String value) | Sets the name of the specific layout to render. |
| getLayers() | Gets the CAD drawing layers to render. |
| setLayers(List<Layer> value) | Gets the CAD drawing layers to render. |
| isEnablePerformanceConversionMode() | Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. |
| setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode) | Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. |
| equals(Object o) | Checks if this CadOptions object is equal to another object. |
| hashCode() | \{@inheritDoc\} |
| toString() | \{@inheritDoc\} |
| toString(ToStringStyle style) | \{@inheritDoc\} |
##### WIDTH
```
public static final String WIDTH
```

##### HEIGHT
```
public static final String HEIGHT
```

##### getPc3File()
```
public String getPc3File()
```

Retrieves the PC3 (Plotter Configuration) file associated with the plotter.

**Returns:**
java.lang.String - the PC3 file path.
##### setPc3File(String pc3File)
```
public void setPc3File(String pc3File)
```

Sets the PC3 (Plotter Configuration) file associated with the plotter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pc3File | java.lang.String | The PC3 file path. |

##### forRenderingByScaleFactor(double scaleFactor)
```
public static CadOptions forRenderingByScaleFactor(double scaleFactor)
```

Initializes a new instance of the  CadOptions  class for rendering by scale factor.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| scaleFactor | double | The scale factor for rendering. Values greater than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by scale factor.
##### forRenderingByWidth(int width)
```
public static CadOptions forRenderingByWidth(int width)
```

Initializes a new instance of the  CadOptions  class for rendering by width.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by width.
##### forRenderingByHeight(int height)
```
public static CadOptions forRenderingByHeight(int height)
```

Initializes a new instance of the  CadOptions  class for rendering by height.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | The height of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by height.
##### forRenderingByWidthAndHeight(int width, int height)
```
public static CadOptions forRenderingByWidthAndHeight(int width, int height)
```

Initializes a new instance of the  CadOptions  class for rendering by width and height.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the output result in pixels. |
| height | int | The height of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by width and height.
##### getScaleFactor()
```
public final double getScaleFactor()
```

Gets the scale factor for rendering. Values higher than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller.

**Returns:**
double - the scale factor for rendering.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the output result in pixels.

**Returns:**
int - the width of the output result.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the output result in pixels.

**Returns:**
int - the height of the output result.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the image.

**Returns:**
java.awt.Color - the background color of the image.
##### getBackgroundColorAsHex()
```
public String getBackgroundColorAsHex()
```

Gets the background color of the image.

**Returns:**
java.lang.String - the background color of the image in 0xFFFFFF format.
##### setBackgroundColor(Color backgroundColor)
```
public void setBackgroundColor(Color backgroundColor)
```

Sets the background color of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | java.awt.Color | The background color of the image. |

##### setBackgroundColor(String colorName)
```
public void setBackgroundColor(String colorName)
```

Sets the background color of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String | The background color name of the image. |

##### getTiles()
```
public final List<Tile> getTiles()
```

Gets the drawing regions to render.

**Note:** This option is supported only for FileType.DWG and FileType.DWT file types. The  RenderLayouts  (isRenderLayouts()/setRenderLayouts(boolean)) and  LayoutName  (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.

**Returns:**
java.util.List<com.groupdocs.viewer.options.Tile> - the list of drawing regions to render.
##### setTiles(List<Tile> value)
```
public final void setTiles(List<Tile> value)
```

Sets the drawing regions to render.

**Note:** This option is supported only for FileType.DWG and FileType.DWT file types. The  RenderLayouts  (isRenderLayouts()/setRenderLayouts(boolean)) and  LayoutName  (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.viewer.options.Tile> | The list of drawing regions to render. |

##### isRenderLayouts()
```
public final boolean isRenderLayouts()
```

Indicates whether layouts from the CAD document should be rendered.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Returns:**
boolean -  true  if layouts should be rendered,  false  otherwise.
##### setRenderLayouts(boolean value)
```
public final void setRenderLayouts(boolean value)
```

Sets whether layouts from the CAD document should be rendered.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to render layouts,  false  otherwise. |

##### getLayoutName()
```
public final String getLayoutName()
```

Gets the name of the specific layout to render. The layout name is case-sensitive.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Returns:**
java.lang.String - the name of the specific layout to render.
##### setLayoutName(String value)
```
public final void setLayoutName(String value)
```

Sets the name of the specific layout to render. The layout name is case-sensitive.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the specific layout to render. |

##### getLayers()
```
public final List<Layer> getLayers()
```

Gets the CAD drawing layers to render.

**Note:** By default, all layers are rendered. Layer names are case-sensitive.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layer> - the CAD drawing layers.
##### setLayers(List<Layer> value)
```
public final void setLayers(List<Layer> value)
```

Gets the CAD drawing layers to render.

**Note:** By default, all layers are rendered. Layer names are case-sensitive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.viewer.results.Layer> | The CAD drawing layers. |

##### isEnablePerformanceConversionMode()
```
public boolean isEnablePerformanceConversionMode()
```

Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.

**Returns:**
boolean -  true  if performance-oriented conversion mode is enabled,  false  otherwise.
##### setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)
```
public void setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)
```

Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enablePerformanceConversionMode | boolean |  true  to enable the performance-oriented conversion mode,  false  to disable it. |

##### equals(Object o)
```
public boolean equals(Object o)
```

Checks if this CadOptions object is equal to another object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.
##### toString()
```
public String toString()
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Returns:**
java.lang.String - a string representation of this object.
##### toString(ToStringStyle style)
```
public String toString(ToStringStyle style)
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. |

**Returns:**
java.lang.String - a string representation of this object using the specified ToStringStyle.

### EmailOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/emailoptions.md

**Inheritance:**
java.lang.Object
```
public class EmailOptions
```

Provides options for rendering email messages.

The EmailOptions class encapsulates various settings and parameters that can be used to control the rendering of email messages in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 EmailOptions options = new EmailOptions();
 options.setDateTimeFormat("MM d yyyy HH:mm tt");
 options.setPageSize(PageSize.A4);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setEmailOptions(options);

 try (Viewer viewer = new Viewer("email.msg")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailOptions() | Initializes a new instance of the  EmailOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDateTimeFormat() | Gets the time format for the date and time values. |
| setDateTimeFormat(String dateTimeFormat) | Gets the time format for the date and time values. |
| getTimeZoneOffset() | Gets the time zone offset for the message. |
| getTimeZoneOffsetMinutes() | Gets the time zone minutes offset minutes for the message. |
| setTimeZoneOffset(TimeZone timeZoneOffset) | Gets the time zone offset for the message. |
| setTimeZoneOffset(int offsetMinutes) | Gets the time zone offset minutes offset for the message. |
| getPageSize() | Gets the size of the output page. |
| setPageSize(PageSize value) | Gets the size of the output page. |
| getFieldTextMap() | Retrieves the mapping between email message fields and their text representations. |
| setFieldTextMap(Map<Field,String> value) | Sets the mapping between email message fields and their text representations. |
| equals(Object o) | Overrides the equals() method of the Object class. |
| hashCode() | \{@inheritDoc\} |
| toString() | Overrides the toString() method of the Object class. |
| toString(ToStringStyle style) | \{@inheritDoc\} |
##### EmailOptions()
```
public EmailOptions()
```

Initializes a new instance of the  EmailOptions  class. This constructor is used to create a new instance of the  EmailOptions  class with default settings.

##### getDateTimeFormat()
```
public String getDateTimeFormat()
```

Gets the time format for the date and time values.

**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
java.lang.String - the time format for date and time values.
##### setDateTimeFormat(String dateTimeFormat)
```
public void setDateTimeFormat(String dateTimeFormat)
```

Gets the time format for the date and time values.

**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateTimeFormat | java.lang.String | The time format for date and time values. |

##### getTimeZoneOffset()
```
public TimeZone getTimeZoneOffset()
```

Gets the time zone offset for the message.

**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC). For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
java.util.TimeZone - the time zone offset.
##### getTimeZoneOffsetMinutes()
```
public int getTimeZoneOffsetMinutes()
```

Gets the time zone minutes offset minutes for the message.

**Note:** The time zone offset minutes represents the minutes difference between the message's time and Coordinated Universal Time (UTC). For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
int - the time zone offset.
##### setTimeZoneOffset(TimeZone timeZoneOffset)
```
public void setTimeZoneOffset(TimeZone timeZoneOffset)
```

Gets the time zone offset for the message.

**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| timeZoneOffset | java.util.TimeZone | The time zone offset. |

##### setTimeZoneOffset(int offsetMinutes)
```
public void setTimeZoneOffset(int offsetMinutes)
```

Gets the time zone offset minutes offset for the message.

**Note:** The time zone minutes offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| offsetMinutes | int | The time zone offset. |

##### getPageSize()
```
public final PageSize getPageSize()
```

Gets the size of the output page.

**Returns:**
PageSize - the page size.
##### setPageSize(PageSize value)
```
public final void setPageSize(PageSize value)
```

Gets the size of the output page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageSize | The page size. |

##### getFieldTextMap()
```
public final Map<Field,String> getFieldTextMap()
```

Retrieves the mapping between email message fields and their text representations.

**Returns:**
java.util.Map<com.groupdocs.viewer.options.Field,java.lang.String> - the mapping between email message fields and their text representations.
##### setFieldTextMap(Map<Field,String> value)
```
public final void setFieldTextMap(Map<Field,String> value)
```

Sets the mapping between email message fields and their text representations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Map<com.groupdocs.viewer.options.Field,java.lang.String> | The mapping between email message fields and their text representations. |

##### equals(Object o)
```
public boolean equals(Object o)
```

Overrides the equals() method of the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with. |

**Returns:**
boolean - true if the objects are equal, false otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.
##### toString()
```
public String toString()
```

Overrides the toString() method of the Object class.

**Returns:**
java.lang.String - a string representation of the object.
##### toString(ToStringStyle style)
```
public String toString(ToStringStyle style)
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. |

**Returns:**
java.lang.String - a string representation of this object using the specified ToStringStyle.

### Field
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/field.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Field extends Enum<Field>
```

Represents email message fields e.g. From, To, Subject etc.

The Field enum represents common email message fields in the GroupDocs.Viewer component. It provides a set of predefined fields that can be used to identify and access specific information in email messages, such as the sender, recipient, subject, and more.

For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 EmailOptions emailOptions = htmlViewOptions.getEmailOptions();
 emailOptions.getFieldTextMap().put(Field.FROM, "Sender");

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#rename-fields-in-the-message-header
#### Fields

| Field | Description |
| --- | --- |
| ANNIVERSARY | Represents the "Anniversary" field. |
| ATTACHMENTS | Represents the "Attachments" field. |
| BCC | Represents the "Bcc" field. |
| BIRTHDAY | Represents the "Birthday" field. |
| BUSINESS | Represents the "Business" field. |
| BUSINESS_ADDRESS | Represents the "Business Address" field. |
| BUSINESS_FAX | Represents the "Business Fax" field. |
| BUSINESS_HOMEPAGE | Represents the "BusinessHomepage" field. |
| CC | Represents the "Cc" field. |
| COMPANY | Represents the "Company" field. |
| DEPARTMENT | Represents the "Department" field. |
| EMAIL | Represents the "Email" field. |
| EMAIL_DISPLAY_AS | Represents the "Email Display As" field. |
| EMAIL_2 | Represents the "Email2" field. |
| EMAIL_2_DISPLAY_AS | Represents the "Email2 Display As" field. |
| EMAIL_3 | Represents the "Email3" field. |
| EMAIL_3_DISPLAY_AS | Represents the "Email3 Display As" field. |
| END | Represents the "End" field. |
| FIRST_NAME | Represents the "First Name" field. |
| FROM | Represents the "From" field. |
| FULL_NAME | Represents the "Full Name" field. |
| GENDER | Represents the "Gender" field. |
| HOBBIES | Represents the "Hobbies" field. |
| HOME | Represents the "Home" field. |
| HOME_ADDRESS | Represents the "Home Address" field. |
| IMPORTANCE | Represents the "Importance" field. |
| JOB_TITLE | Represents the "Job Title" field. |
| LAST_NAME | Represents the "Last Name" field. |
| LOCATION | Represents the "Location" field. |
| MIDDLE_NAME | Represents the "Middle Name" field. |
| MOBILE | Represents the "Mobile" field. |
| ORGANIZER | Represents the "Organizer" field. |
| OTHER_ADDRESS | Represents the "Other Address" field. |
| PERSONAL_HOMEPAGE | Represents the "Personal Homepage" field. |
| PROFESSION | Represents the "Profession" field. |
| RECURRENCE | Represents the "Recurrence" field. |
| RECURRENCE_PATTERN | Represents the "Recurrence Pattern" field. |
| REQUIRED_ATTENDEES | Represents the "Required Attendees" field. |
| SENT | Represents the "Sent" field. |
| SHOW_TIME_AS | Represents the "Show Time As" field. |
| SPOUSE_PARTNER | Represents the "Spouse/Partner" field. |
| START | Represents the "Start" field. |
| SUBJECT | Represents the "Subject" field. |
| TO | Represents the "To" field. |
| USER_FIELD_1 | Represents the "User Field 1" field. |
| USER_FIELD_2 | Represents the "User Field 2" field. |
| USER_FIELD_3 | Represents the "User Field 3" field. |
| USER_FIELD_4 | Represents the "User Field 4" field. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getName() | Field name. |
| toString() | Returns a string that represents the current object. |
##### ANNIVERSARY
```
public static final Field ANNIVERSARY
```

Represents the "Anniversary" field.

##### ATTACHMENTS
```
public static final Field ATTACHMENTS
```

Represents the "Attachments" field.

##### BCC
```
public static final Field BCC
```

Represents the "Bcc" field.

##### BIRTHDAY
```
public static final Field BIRTHDAY
```

Represents the "Birthday" field.

##### BUSINESS
```
public static final Field BUSINESS
```

Represents the "Business" field.

##### BUSINESS_ADDRESS
```
public static final Field BUSINESS_ADDRESS
```

Represents the "Business Address" field.

##### BUSINESS_FAX
```
public static final Field BUSINESS_FAX
```

Represents the "Business Fax" field.

##### BUSINESS_HOMEPAGE
```
public static final Field BUSINESS_HOMEPAGE
```

Represents the "BusinessHomepage" field.

##### CC
```
public static final Field CC
```

Represents the "Cc" field.

##### COMPANY
```
public static final Field COMPANY
```

Represents the "Company" field.

##### DEPARTMENT
```
public static final Field DEPARTMENT
```

Represents the "Department" field.

##### EMAIL
```
public static final Field EMAIL
```

Represents the "Email" field.

##### EMAIL_DISPLAY_AS
```
public static final Field EMAIL_DISPLAY_AS
```

Represents the "Email Display As" field.

##### EMAIL_2
```
public static final Field EMAIL_2
```

Represents the "Email2" field.

##### EMAIL_2_DISPLAY_AS
```
public static final Field EMAIL_2_DISPLAY_AS
```

Represents the "Email2 Display As" field.

##### EMAIL_3
```
public static final Field EMAIL_3
```

Represents the "Email3" field.

##### EMAIL_3_DISPLAY_AS
```
public static final Field EMAIL_3_DISPLAY_AS
```

Represents the "Email3 Display As" field.

##### END
```
public static final Field END
```

Represents the "End" field.

##### FIRST_NAME
```
public static final Field FIRST_NAME
```

Represents the "First Name" field.

##### FROM
```
public static final Field FROM
```

Represents the "From" field.

##### FULL_NAME
```
public static final Field FULL_NAME
```

Represents the "Full Name" field.

##### GENDER
```
public static final Field GENDER
```

Represents the "Gender" field.

##### HOBBIES
```
public static final Field HOBBIES
```

Represents the "Hobbies" field.

##### HOME
```
public static final Field HOME
```

Represents the "Home" field.

##### HOME_ADDRESS
```
public static final Field HOME_ADDRESS
```

Represents the "Home Address" field.

##### IMPORTANCE
```
public static final Field IMPORTANCE
```

Represents the "Importance" field.

##### JOB_TITLE
```
public static final Field JOB_TITLE
```

Represents the "Job Title" field.

##### LAST_NAME
```
public static final Field LAST_NAME
```

Represents the "Last Name" field.

##### LOCATION
```
public static final Field LOCATION
```

Represents the "Location" field.

##### MIDDLE_NAME
```
public static final Field MIDDLE_NAME
```

Represents the "Middle Name" field.

##### MOBILE
```
public static final Field MOBILE
```

Represents the "Mobile" field.

##### ORGANIZER
```
public static final Field ORGANIZER
```

Represents the "Organizer" field.

##### OTHER_ADDRESS
```
public static final Field OTHER_ADDRESS
```

Represents the "Other Address" field.

##### PERSONAL_HOMEPAGE
```
public static final Field PERSONAL_HOMEPAGE
```

Represents the "Personal Homepage" field.

##### PROFESSION
```
public static final Field PROFESSION
```

Represents the "Profession" field.

##### RECURRENCE
```
public static final Field RECURRENCE
```

Represents the "Recurrence" field.

##### RECURRENCE_PATTERN
```
public static final Field RECURRENCE_PATTERN
```

Represents the "Recurrence Pattern" field.

##### REQUIRED_ATTENDEES
```
public static final Field REQUIRED_ATTENDEES
```

Represents the "Required Attendees" field.

##### SENT
```
public static final Field SENT
```

Represents the "Sent" field.

##### SHOW_TIME_AS
```
public static final Field SHOW_TIME_AS
```

Represents the "Show Time As" field.

##### SPOUSE_PARTNER
```
public static final Field SPOUSE_PARTNER
```

Represents the "Spouse/Partner" field.

##### START
```
public static final Field START
```

Represents the "Start" field.

##### SUBJECT
```
public static final Field SUBJECT
```

Represents the "Subject" field.

##### TO
```
public static final Field TO
```

Represents the "To" field.

##### USER_FIELD_1
```
public static final Field USER_FIELD_1
```

Represents the "User Field 1" field.

##### USER_FIELD_2
```
public static final Field USER_FIELD_2
```

Represents the "User Field 2" field.

##### USER_FIELD_3
```
public static final Field USER_FIELD_3
```

Represents the "User Field 3" field.

##### USER_FIELD_4
```
public static final Field USER_FIELD_4
```

Represents the "User Field 4" field.

##### values()
```
public static Field[] values()
```

**Returns:**
com.groupdocs.viewer.options.Field[]
##### valueOf(String name)
```
public static Field valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Field
##### getName()
```
public final String getName()
```

Field name.

This method retrieves the name of the field.

**Returns:**
java.lang.String - the name of the field.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - a string that represents the current object.

### FileName
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/filename.md

**Inheritance:**
java.lang.Object
```
public class FileName
```

Represents the name of a file in an archive.

The FileName class encapsulates the name of a file without any path or directory information. It provides methods to manipulate and retrieve information about the file name.

Example usage:

```

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.getArchiveOptions().setFileName(new FileName("my-file-name"));

 final LoadOptions loadOptions = new LoadOptions(FileType.ZIP);
 try (final Viewer viewer = new Viewer(documentPath, loadOptions)) {
     viewer.view(options);
     // Use the viewer object for archive document rendering
 }
 
```

***Note:** The FileName class is used to work with file names and does not handle file operations or manipulation.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileName(String fileName) | Initializes a new instance of the  FileName  class. |
#### Fields

| Field | Description |
| --- | --- |
| EMPTY | Represents an empty filename. |
| SOURCE | Represents the name of the source file. |
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| toString() | Returns a string representation of the current object. |
##### FileName(String fileName)
```
public FileName(String fileName)
```

Initializes a new instance of the  FileName  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The name of the file. |

##### EMPTY
```
public static final FileName EMPTY
```

Represents an empty filename.

##### SOURCE
```
public static final FileName SOURCE
```

Represents the name of the source file.

##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns a string representation of the current object.

**Returns:**
java.lang.String - a string representation of the current object.

### HtmlViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/htmlviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions
```
public class HtmlViewOptions extends ViewOptions
```

Provides options for rendering documents into HTML format.

The HtmlViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into HTML format in the GroupDocs.Viewer component.

For details, see the [topic][] and its children.

Example usage:

```

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.setExcludeFonts(true);
 options.setFontsToExclude(Arrays.asList("font-name"));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

[topic]: https://docs.groupdocs.com/viewer/java/rendering-to-html/
#### Fields

| Field | Description |
| --- | --- |
| CREATE_PAGE_STREAM |  |
| FILE_PATH_FORMAT |  |
#### Methods

| Method | Description |
| --- | --- |
| isRenderResponsive() | Determines whether responsive rendering is enabled. |
| setRenderResponsive(boolean value) | Sets whether responsive rendering is enabled. |
| isMinify() | Checks if HTML content and HTML resources minification is enabled. |
| setMinify(boolean value) | Sets whether HTML content and HTML resources minification is enabled. |
| isRenderToSinglePage() | Enables rendering an entire document to one HTML file. |
| setRenderToSinglePage(boolean renderSinglePage) | Enables rendering an entire document to one HTML file. |
| getImageMaxWidth() | Returns the maximum width of an output image in pixels. |
| setImageMaxWidth(int imageMaxWidth) | Sets the maximum width of an output image in pixels. |
| getImageMaxHeight() | Gets the maximum height of an output image in pixels. |
| setImageMaxHeight(int imageMaxHeight) | Sets the maximum height of an output image in pixels. |
| getImageWidth() | Gets the width of the output image in pixels. |
| setImageWidth(int imageWidth) | Sets the width of the output image in pixels. |
| getImageHeight() | Gets the height of the output image in pixels when converting a single image to HTML. |
| setImageHeight(int imageHeight) | Sets the height of the output image in pixels when converting a single image to HTML. |
| isForPrinting() | Checks if the output HTML should be optimized for printing. |
| setForPrinting(boolean value) | Sets whether the output HTML should be optimized for printing. |
| isExcludeFonts() | Determines whether to exclude fonts from the HTML document. |
| setExcludeFonts(boolean value) | Sets whether to exclude fonts from the HTML document. |
| getFontsToExclude() | Retrieves the list of font names to exclude from the HTML document. |
| setFontsToExclude(List<String> value) | Sets the list of font names to exclude from the HTML document. |
| isRemoveJavaScript() | Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. |
| setRemoveJavaScript(boolean value) | Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. |
| getDocumentSavingCallback() | Retrieves the callback used to estimate the saving progress of a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback used to estimate the saving progress of a Words or Email document. |
| forEmbeddedResources(CreatePageStream createPageStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources() | Initializes a new instance of the  HtmlViewOptions  class. |
| forEmbeddedResources(String filePathFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
| forEmbeddedResources(Path filePathFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
| forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources() | Initializes new instance of  HtmlViewOptions  class. |
| forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
##### CREATE_PAGE_STREAM
```
public static final String CREATE_PAGE_STREAM
```

##### FILE_PATH_FORMAT
```
public static final String FILE_PATH_FORMAT
```

##### isRenderResponsive()
```
public final boolean isRenderResponsive()
```

Determines whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-with-responsive-layout/

**Returns:**
boolean -  true  if responsive rendering is enabled,  false  otherwise.
##### setRenderResponsive(boolean value)
```
public final void setRenderResponsive(boolean value)
```

Sets whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-with-responsive-layout/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable responsive rendering,  false  to disable it. |

##### isMinify()
```
public final boolean isMinify()
```

Checks if HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/minify-html/

**Returns:**
boolean -  true  if minification is enabled,  false  otherwise.
##### setMinify(boolean value)
```
public final void setMinify(boolean value)
```

Sets whether HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/minify-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable minification,  false  to disable. |

##### isRenderToSinglePage()
```
public boolean isRenderToSinglePage()
```

Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

 *  [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
 *  [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }
```

[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/#create-a-single-html-page
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file
[Render web documents as PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Returns:**
boolean
##### setRenderToSinglePage(boolean renderSinglePage)
```
public void setRenderToSinglePage(boolean renderSinglePage)
```

Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

 *  [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
 *  [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }
```

[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/#create-a-single-html-page
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file
[Render web documents as PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | boolean |  |

##### getImageMaxWidth()
```
public int getImageMaxWidth()
```

Returns the maximum width of an output image in pixels.

**Note:** This value is used when converting a single image to HTML. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the maximum width of an output image.
##### setImageMaxWidth(int imageMaxWidth)
```
public void setImageMaxWidth(int imageMaxWidth)
```

Sets the maximum width of an output image in pixels.

**Note:** This value is used when converting a single image to HTML. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxWidth | int | The maximum width of an output image. |

##### getImageMaxHeight()
```
public int getImageMaxHeight()
```

Gets the maximum height of an output image in pixels.

**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the maximum height of an output image.
##### setImageMaxHeight(int imageMaxHeight)
```
public void setImageMaxHeight(int imageMaxHeight)
```

Sets the maximum height of an output image in pixels.

**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxHeight | int | The maximum height of an output image. |

##### getImageWidth()
```
public int getImageWidth()
```

Gets the width of the output image in pixels.

***Note:** This value is applicable only when converting a single image to HTML.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the width of the output image.
##### setImageWidth(int imageWidth)
```
public void setImageWidth(int imageWidth)
```

Sets the width of the output image in pixels.

***Note:** This value is applicable only when converting a single image to HTML.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageWidth | int | The width of the output image. |

##### getImageHeight()
```
public int getImageHeight()
```

Gets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the height of the output image in pixels.
##### setImageHeight(int imageHeight)
```
public void setImageHeight(int imageHeight)
```

Sets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageHeight | int | The height of the output image in pixels. |

##### isForPrinting()
```
public final boolean isForPrinting()
```

Checks if the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/how-to-optimize-output-html-for-printing/

**Returns:**
boolean -  true  if the output HTML should be optimized for printing,  false  otherwise.
##### setForPrinting(boolean value)
```
public final void setForPrinting(boolean value)
```

Sets whether the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/how-to-optimize-output-html-for-printing/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to optimize the output HTML for printing,  false  otherwise. |

##### isExcludeFonts()
```
public final boolean isExcludeFonts()
```

Determines whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Returns:**
boolean -  true  if fonts should be excluded,  false  otherwise.
##### setExcludeFonts(boolean value)
```
public final void setExcludeFonts(boolean value)
```

Sets whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to exclude fonts,  false  otherwise. |

##### getFontsToExclude()
```
public final List<String> getFontsToExclude()
```

Retrieves the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

***Note:** Please note that this property is active only when the  ExcludeFonts  (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Returns:**
java.util.List<java.lang.String> - the list of font names to exclude from the HTML document.
##### setFontsToExclude(List<String> value)
```
public final void setFontsToExclude(List<String> value)
```

Sets the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

***Note:** Please note that this property is active only when the  ExcludeFonts  (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> | The list of font names to exclude from the HTML document. |

##### isRemoveJavaScript()
```
public final boolean isRemoveJavaScript()
```

Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-html/#preserving-or-disabling-javascript-when-rendering-to-html

**Returns:**
boolean
##### setRemoveJavaScript(boolean value)
```
public void setRemoveJavaScript(boolean value)
```

Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-html/#preserving-or-disabling-javascript-when-rendering-to-html

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback used to estimate the saving progress of a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback used to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback used to estimate the saving progress of a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback used to estimate the document saving progress. |

##### forEmbeddedResources(CreatePageStream createPageStream)
```
public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

***Note:** The method takes a  CreatePageStream  parameter, which is a method used to instantiate a stream for writing output page data.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the  createPageStream  parameter. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources(PageStreamFactory pageStreamFactory)
```
public static HtmlViewOptions forEmbeddedResources(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources()
```
public static HtmlViewOptions forEmbeddedResources()
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forEmbeddedResources(String filePathFormat)
```
public static HtmlViewOptions forEmbeddedResources(String filePathFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forEmbeddedResources(Path filePathFormat)
```
public static HtmlViewOptions forEmbeddedResources(Path filePathFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.html'. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)
```
public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

***Note:** This method should be used when rendering HTML with external resources, such as CSS and JavaScript files.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that releases the stream created by the  createPageStream  method. |
| createResourceUrl | CreateResourceUrl | The method that creates the URL for the HTML resource. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)
```
public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that instantiates the stream used to write output HTML resource data. |
| createResourceUrl | CreateResourceUrl | The method that creates the URL for the HTML resource. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the  createPageStream  method. |
| releaseResourceStream | ReleaseResourceStream | The method that releases the stream created by the  createResourceStream  method. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)
```
public static HtmlViewOptions forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |
| resourceStreamFactory | ResourceStreamFactory | The factory that implements methods for creating resource URLs and instantiating/releasing the output HTML resource stream. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources()
```
public static HtmlViewOptions forExternalResources()
```

Initializes new instance of  HtmlViewOptions  class.

 *  \- with "p\_\{0\}.html" as file path format for the output HTML files;
 *  \- with "p\_\{0\}\_\{1\}" as file path format for the output HTML-resource files;
 *  \- with "p\_\{0\}\_\{1\}" as URL format for HTML-resources;

The output files will be placed into current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Returns:**
HtmlViewOptions
##### forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)
```
public static HtmlViewOptions forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. |
| resourceFilePathFormat | java.lang.String | The resource file path format, e.g., 'page\_\{0\}/resource\_\{1\}'. |
| resourceUrlFormat | java.lang.String | The resource URL format, e.g., 'page\_\{0\}/resource\_\{1\}'. |

**Returns:**
HtmlViewOptions

### ImageQuality
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/imagequality.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ImageQuality extends Enum<ImageQuality>
```

The quality of images in the output HTML contained by the PDF documents.

The ImageQuality enum represents the quality of images in the output HTML contained by the PDF documents in the GroupDocs.Viewer component. It provides different levels of image quality that can be used to control the rendering and compression of images in the generated HTML output.

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 PdfOptions pdfOptions = htmlViewOptions.getPdfOptions();
 pdfOptions.setImageQuality(ImageQuality.HIGH);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| LOW | The acceptable quality and best performance. |
| MEDIUM | Better quality and slower performance. |
| HIGH | The best quality but slow performance. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### LOW
```
public static final ImageQuality LOW
```

The acceptable quality and best performance. This setting prioritizes rendering speed over image quality.

##### MEDIUM
```
public static final ImageQuality MEDIUM
```

Better quality and slower performance. This setting provides a balance between image quality and rendering speed.

##### HIGH
```
public static final ImageQuality HIGH
```

The best quality but slow performance. This setting prioritizes image quality over rendering speed.

##### values()
```
public static ImageQuality[] values()
```

**Returns:**
com.groupdocs.viewer.options.ImageQuality[]
##### valueOf(String name)
```
public static ImageQuality valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ImageQuality

### IMaxSizeOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/imaxsizeoptions.md

### JpgViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/jpgviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class JpgViewOptions extends ViewOptions implements IMaxSizeOptions
```

Provides options for rendering documents into JPG format.

The JpgViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into JPG format in the GroupDocs.Viewer component.

Example usage:

```

 JpgViewOptions options = new JpgViewOptions();
 options.setMaxWidth(1920);
 options.setMaxHeight(1080);
 options.setQuality((byte) 96);
 options.setRenderComments(true);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

***Note:** The JpgViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output JPG images.*
#### Constructors

| Constructor | Description |
| --- | --- |
| JpgViewOptions(CreatePageStream createPageStream) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions() | Initializes a new instance of  JpgViewOptions  with "p\_\{0\}.jpg" as the file path format for the output files. |
| JpgViewOptions(String filePathFormat) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(Path filePathFormat) | Initializes a new instance of the  JpgViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxWidth() | Gets the maximum width of an output image in pixels. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image in pixels. |
| getMaxHeight() | Gets the maximum height of an output image in pixels. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image in pixels. |
| getQuality() | Gets the quality of the output image. |
| setQuality(byte value) | Sets the quality of the output image. |
| isExtractText() | Enables text extraction. |
| setExtractText(boolean value) | Enables or disables text extraction. |
| getWidth() | Gets the width of the output image in pixels. |
| setWidth(int value) | Sets the width of the output image in pixels. |
| getHeight() | Gets the height of the output image in pixels. |
| setHeight(int value) | Sets the height of the output image in pixels. |
| getPageStreamFactory() | Gets the factory that implements methods for creating and releasing the output page stream. |
| getDocumentSavingCallback() | Gets the callback to estimate the saving progress of a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback to estimate the saving progress of a Words or Email document. |
##### JpgViewOptions(CreatePageStream createPageStream)
```
public JpgViewOptions(CreatePageStream createPageStream)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |

##### JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the delegate passed to the  createPageStream  parameter. |

##### JpgViewOptions(PageStreamFactory pageStreamFactory)
```
public JpgViewOptions(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

##### JpgViewOptions()
```
public JpgViewOptions()
```

Initializes a new instance of  JpgViewOptions  with "p\_\{0\}.jpg" as the file path format for the output files. The output files will be placed into the current working directory of the application.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

##### JpgViewOptions(String filePathFormat)
```
public JpgViewOptions(String filePathFormat)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.jpg'. |

##### JpgViewOptions(Path filePathFormat)
```
public JpgViewOptions(Path filePathFormat)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.jpg'. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Gets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the \#setWidth(int).setWidth(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of an output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the \#setWidth(int).setWidth(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of an output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Gets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the \#setHeight(int).setHeight(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of an output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the \#setHeight(int).setHeight(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of an output image. |

##### getQuality()
```
public final byte getQuality()
```

Gets the quality of the output image.

***Note:** Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-quality-for-jpg/

**Returns:**
byte - the quality of the output image.
##### setQuality(byte value)
```
public final void setQuality(byte value)
```

Sets the quality of the output image.

***Note:** Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-quality-for-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | The quality of the output image. |

##### isExtractText()
```
public final boolean isExtractText()
```

Enables text extraction.

***Note:** Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Returns:**
boolean -  true  if text extraction is enabled,  false  otherwise.
##### setExtractText(boolean value)
```
public final void setExtractText(boolean value)
```

Enables or disables text extraction.

***Note:** Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable text extraction,  false  to disable it. |

##### getWidth()
```
public final int getWidth()
```

Gets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxWidth(int).setMaxWidth(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the width of the output image.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxWidth(int).setMaxWidth(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the output image. |

##### getHeight()
```
public final int getHeight()
```

Gets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxHeight(int).setMaxHeight(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the height of the output image.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxHeight(int).setMaxHeight(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the output image. |

##### getPageStreamFactory()
```
public final PageStreamFactory getPageStreamFactory()
```

Gets the factory that implements methods for creating and releasing the output page stream.

**Returns:**
PageStreamFactory - the factory for the output page stream.
##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Gets the callback to estimate the saving progress of a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback to estimate the saving progress of a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### LoadOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Provides options that are used to open a file.

The LoadOptions class encapsulates various settings and parameters that can be used to specify how a file should be opened and loaded in the GroupDocs.Viewer component. For details, see this [page][] and its children.

Example usage:

```

 LoadOptions options = new LoadOptions();
 options.setPassword("myPassword");
 options.setFileType(PDF);
 options.setCharset(Charset.forName("UTF-8"));

 try (Viewer viewer = new Viewer(pdfFileInputStream, options)) {
     // Use the viewer object for further operations
 }
 
```

[page]: https://docs.groupdocs.com/viewer/java/loading/
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the  LoadOptions  class. |
| LoadOptions(FileType fileType) | Initializes a new instance of the  LoadOptions  class. |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_URL_CONNECT_TIMEOUT |  |
| DEFAULT_URL_READ_TIMEOUT |  |
| _tryRepair |  |
#### Methods

| Method | Description |
| --- | --- |
| isTryRepair() | When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. |
| setTryRepair(boolean tryRepair) | When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. |
| getFileType() | Gets the type of the file to open. |
| setFileType(FileType value) | Sets the type of the file to open. |
| getPassword() | Gets the password for opening an encrypted file. |
| setPassword(String value) | Sets the password for opening an encrypted file. |
| getCharset() | The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG. |
| setCharset(Charset value) | The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG. |
| isDetectCharset() | This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. |
| setDetectCharset(boolean detectCharset) | This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. |
| getResourceLoadingTimeout() | Gets the timeout for loading external resources. |
| setResourceLoadingTimeout(int resourceLoadingTimeout) | Sets the timeout for loading external resources, such as graphics. |
| getUrlConnectTimeout() | Gets the connection timeout for creating a Viewer using java.net.URL to load a document. |
| setUrlConnectTimeout(int urlConnectTimeout) | Sets the connection timeout for creating a Viewer using java.net.URL to load a document. |
| getUrlReadTimeout() | Gets the read timeout for creating a Viewer using java.net.URL to load a document. |
| setUrlReadTimeout(int urlReadTimeout) | Sets the read timeout for creating a Viewer using java.net.URL to load a document. |
| getArchiveSecurityOptions() | Gets the security options to control the process of extracting archives. |
| setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions) | Sets the security options to control the process of extracting archives. |
| isSkipExternalResources() | When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources(). |
| setSkipExternalResources(boolean skipExternalResources) | When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources(). |
| getWhitelistedResources() | The list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`. |
| setWhitelistedResources(List<String> whitelistedResources) | Sets the list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the  LoadOptions  class.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes a new instance of the  LoadOptions  class.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to open. |

##### DEFAULT_URL_CONNECT_TIMEOUT
```
public static final int DEFAULT_URL_CONNECT_TIMEOUT
```

##### DEFAULT_URL_READ_TIMEOUT
```
public static final int DEFAULT_URL_READ_TIMEOUT
```

##### _tryRepair
```
public boolean _tryRepair
```

##### isTryRepair()
```
public boolean isTryRepair()
```

When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is false.

This feature addresses the following issues in a PDF document:

 *  Broken references within the document (incorrect object offsets in the Cross-reference list).
 *  Missing critical elements like root object, page object, or page content.
 *  Circular references (Form X-object referencing itself).

**Returns:**
boolean
##### setTryRepair(boolean tryRepair)
```
public void setTryRepair(boolean tryRepair)
```

When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is false.

This feature addresses the following issues in a PDF document:

 *  Broken references within the document (incorrect object offsets in the Cross-reference list).
 *  Missing critical elements like root object, page object, or page content.
 *  Circular references (Form X-object referencing itself).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tryRepair | boolean |  |

##### getFileType()
```
public final FileType getFileType()
```

Gets the type of the file to open.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Returns:**
FileType - the file type.
##### setFileType(FileType value)
```
public final void setFileType(FileType value)
```

Sets the type of the file to open.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType | The file type. |

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening an encrypted file.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/load-password-protected-document/

**Returns:**
java.lang.String - the password for opening the file.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening an encrypted file.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/load-password-protected-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password for opening the file. |

##### getCharset()
```
public final Charset getCharset()
```

The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.

Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-encoding-when-loading-documents/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Returns:**
java.nio.charset.Charset
##### setCharset(Charset value)
```
public final void setCharset(Charset value)
```

The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.

Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-encoding-when-loading-documents/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### isDetectCharset()
```
public boolean isDetectCharset()
```

This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.

**Learn more about rendering text and tab/comma delimited files**

 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

If the encoding cannot be detected, the default  is used. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents/

**Returns:**
boolean
##### setDetectCharset(boolean detectCharset)
```
public void setDetectCharset(boolean detectCharset)
```

This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.

**Learn more about rendering text and tab/comma delimited files**

 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

If the encoding cannot be detected, the default  is used. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| detectCharset | boolean |  |

##### getResourceLoadingTimeout()
```
public int getResourceLoadingTimeout()
```

Gets the timeout for loading external resources.

**Note:** The default value is 10 seconds.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

The default value is 30 seconds. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setResourceLoadingTimeout(5000); // Set resource loading timeout to 5 seconds

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents

**Returns:**
int
##### setResourceLoadingTimeout(int resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(int resourceLoadingTimeout)
```

Sets the timeout for loading external resources, such as graphics.

***Note:** The default value is 30 seconds.*

This option is supported for Word Processing documents that contain external resources. The default value is 30 seconds. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | int | The loading timeout, milliseconds. |

##### getUrlConnectTimeout()
```
public int getUrlConnectTimeout()
```

Gets the connection timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 5 seconds.*

**Returns:**
int - the connection timeout.
##### setUrlConnectTimeout(int urlConnectTimeout)
```
public void setUrlConnectTimeout(int urlConnectTimeout)
```

Sets the connection timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 5 seconds.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| urlConnectTimeout | int | The connection timeout. |

##### getUrlReadTimeout()
```
public int getUrlReadTimeout()
```

Gets the read timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 30 seconds.*

**Returns:**
int - the read timeout.
##### setUrlReadTimeout(int urlReadTimeout)
```
public void setUrlReadTimeout(int urlReadTimeout)
```

Sets the read timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 30 seconds.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| urlReadTimeout | int | The read timeout. |

##### getArchiveSecurityOptions()
```
public ArchiveSecurityOptions getArchiveSecurityOptions()
```

Gets the security options to control the process of extracting archives.

***Note:** Not each archive type supports all options.*

**Returns:**
com.groupdocs.viewer.options.ArchiveSecurityOptions - the options object to configure the process of extracting archives.
##### setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)
```
public void setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)
```

Sets the security options to control the process of extracting archives.

***Note:** Not each archive type supports all options.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| archiveSecurityOptions | com.groupdocs.viewer.options.ArchiveSecurityOptions | The options object to configure the process of extracting archives. |

##### isSkipExternalResources()
```
public boolean isSkipExternalResources()
```

When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources().

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Returns:**
boolean
##### setSkipExternalResources(boolean skipExternalResources)
```
public void setSkipExternalResources(boolean skipExternalResources)
```

When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources().

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skipExternalResources | boolean | The flag to enable or disable loading of external resources. |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

The list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.getWhitelistedResources().add("avatars.githubusercontent.com"); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whitelistedResources)
```
public void setWhitelistedResources(List<String> whitelistedResources)
```

Sets the list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.setWhitelistedResources(Arrays.asList("avatars.githubusercontent.com")); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whitelistedResources | java.util.List<java.lang.String> | The list of URL fragments corresponding to external resources that should be loaded. |

### MailStorageOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/mailstorageoptions.md

**Inheritance:**
java.lang.Object
```
public class MailStorageOptions
```

Provides options for rendering Mail storage (Lotus Notes, MBox) data files.

The MailStorageOptions class encapsulates various settings and parameters that can be used to control the rendering of Mail storage data files (such as Lotus Notes or MBox) in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 MailStorageOptions options = new MailStorageOptions();
 options.setAddressFilter("@gmail.com");
 options.setMaxItems(10);

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setMailStorageOptions(options);

 try (Viewer viewer = new Viewer("mail.msg")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#specify-rendering-options
#### Constructors

| Constructor | Description |
| --- | --- |
| MailStorageOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTextFilter() | Gets the keywords used to filter messages. |
| setTextFilter(String textFilter) | Sets the keywords used to filter messages. |
| getAddressFilter() | Gets the email address used to filter messages by sender or recipient. |
| setAddressFilter(String addressFilter) | Sets the email address used to filter messages by sender or recipient. |
| getMaxItems() | Gets the maximum number of messages or items to render. |
| setMaxItems(int maxItems) | Sets the maximum number of messages or items to render. |
##### MailStorageOptions()
```
public MailStorageOptions()
```

##### getTextFilter()
```
public String getTextFilter()
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Returns:**
java.lang.String - the keywords used for filtering messages.
##### setTextFilter(String textFilter)
```
public void setTextFilter(String textFilter)
```

Sets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textFilter | java.lang.String | The keywords used for filtering messages. |

##### getAddressFilter()
```
public String getAddressFilter()
```

Gets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\u2019s or recipient\\u2019s address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Returns:**
java.lang.String - the email address used for filtering messages.
##### setAddressFilter(String addressFilter)
```
public void setAddressFilter(String addressFilter)
```

Sets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\u2019s or recipient\\u2019s address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| addressFilter | java.lang.String | The email address used for filtering messages. |

##### getMaxItems()
```
public int getMaxItems()
```

Gets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

***Note:** The default value is 0, which means all messages will be rendered.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#limit-the-number-of-items-to-render

**Returns:**
int - the maximum number of messages or items to render.
##### setMaxItems(int maxItems)
```
public void setMaxItems(int maxItems)
```

Sets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

***Note:** The default value is 0, which means all messages will be rendered.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#limit-the-number-of-items-to-render

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxItems | int | The maximum number of messages or items to render. |

### OutlookOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/outlookoptions.md

**Inheritance:**
java.lang.Object
```
public class OutlookOptions
```

Provides options for rendering Outlook data files.

The OutlookOptions class encapsulates various settings and parameters that can be used to control the rendering of Outlook data files (such as PST or OST files) in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 OutlookOptions options = new OutlookOptions();
 options.setAddressFilter("@gmail.com");
 options.setFolder("folderName");

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setOutlookOptions(options);

 try (Viewer viewer = new Viewer("mail.pst")) {
   viewer.view(htmlViewOptions);
   // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#specify-rendering-options
#### Constructors

| Constructor | Description |
| --- | --- |
| OutlookOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Gets the name of the folder to render. |
| setFolder(String value) | Sets the name of the folder to render. |
| getTextFilter() | Gets the keywords used to filter messages. |
| setTextFilter(String value) | Gets the keywords used to filter messages. |
| getAddressFilter() | Gets the email address used to filter messages by sender or recipient. |
| setAddressFilter(String value) | Sets the email address used to filter messages by sender or recipient. |
| getMaxItemsInFolder() | Gets the maximum number of messages or items that can be rendered from one folder. |
| setMaxItemsInFolder(int value) | Sets the maximum number of messages or items that can be rendered from one folder. |
##### OutlookOptions()
```
public OutlookOptions()
```

##### getFolder()
```
public final String getFolder()
```

Gets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#render-a-specific-folder

**Returns:**
java.lang.String - the name of the folder to render.
##### setFolder(String value)
```
public final void setFolder(String value)
```

Sets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#render-a-specific-folder

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the folder to render. |

##### getTextFilter()
```
public final String getTextFilter()
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Returns:**
java.lang.String - the keywords.
##### setTextFilter(String value)
```
public final void setTextFilter(String value)
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getAddressFilter()
```
public final String getAddressFilter()
```

Gets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\ufffds or recipient\\ufffds address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Returns:**
java.lang.String - the email address used to filter messages.
##### setAddressFilter(String value)
```
public final void setAddressFilter(String value)
```

Sets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\ufffds or recipient\\ufffds address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The email address used to filter messages. |

##### getMaxItemsInFolder()
```
public final int getMaxItemsInFolder()
```

Gets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#limit-the-number-of-folder-items-to-render

**Returns:**
int - the maximum number of messages or items that can be rendered from one folder.
##### setMaxItemsInFolder(int value)
```
public final void setMaxItemsInFolder(int value)
```

Sets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#limit-the-number-of-folder-items-to-render

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of messages or items that can be rendered from one folder. |

### PageSize
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/pagesize.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PageSize extends Enum<PageSize>
```

The size of the page.

The PageSize enum represents different page sizes in the GroupDocs.Viewer component. It provides a set of predefined page sizes that can be used to specify the dimensions of a page in various document rendering scenarios.

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 ProjectManagementOptions projectManagementOptions = htmlViewOptions.getProjectManagementOptions();
 projectManagementOptions.setPageSize(PageSize.A4);

 try (Viewer viewer = new Viewer("document.mpp")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| UNSPECIFIED | The default, unspecified page size. |
| LETTER | The size of the Letter page in points is 792 x 612. |
| LEDGER | The size of the A0 page in points is 3371 x 2384. |
| A0 | The size of the A1 page in points is 2384 x 1685. |
| A1 | The size of the A2 page in points is 1684 x 1190. |
| A2 | The size of the A3 page in points is 1190 x 842. |
| A3 | The size of the A3 page in points is 1190 x 842. |
| A4 | The size of the A4 page in points is 842 x 595. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### UNSPECIFIED
```
public static final PageSize UNSPECIFIED
```

The default, unspecified page size. This size is used when no specific page size is specified.

##### LETTER
```
public static final PageSize LETTER
```

The size of the Letter page in points is 792 x 612. This page size is commonly used for letters and documents in North America.

##### LEDGER
```
public static final PageSize LEDGER
```

The size of the A0 page in points is 3371 x 2384. This large page size is part of the ISO 216 international standard.

##### A0
```
public static final PageSize A0
```

The size of the A1 page in points is 2384 x 1685. This page size is part of the ISO 216 international standard.

##### A1
```
public static final PageSize A1
```

The size of the A2 page in points is 1684 x 1190. This page size is part of the ISO 216 international standard.

##### A2
```
public static final PageSize A2
```

The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard.

##### A3
```
public static final PageSize A3
```

The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard.

##### A4
```
public static final PageSize A4
```

The size of the A4 page in points is 842 x 595. This page size is part of the ISO 216 international standard.

##### values()
```
public static PageSize[] values()
```

**Returns:**
com.groupdocs.viewer.options.PageSize[]
##### valueOf(String name)
```
public static PageSize valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageSize

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/pdfoptimizationoptions.md

**Inheritance:**
java.lang.Object
```
public class PdfOptimizationOptions
```

Use this class to specify PDF optimization options to apply to the output PDF file.

These optimization options are supported for any input file formats which are supported for export to PDF. For details and code samples, see this [page][] and its children.

Example usage:

```

 try (Viewer viewer = new Viewer("sample.docx")) {
     PdfViewOptions viewOptions = new PdfViewOptions();
     viewOptions.setPdfOptimizationOptions(new PdfOptimizationOptions());
     viewOptions.getPdfOptimizationOptions().setLinearize(true);
     viewOptions.getPdfOptimizationOptions().setRemoveAnnotations(true);
     viewOptions.getPdfOptimizationOptions().setRemoveFormFields(true);
     viewOptions.getPdfOptimizationOptions().setConvertToGrayScale(true);
     viewOptions.getPdfOptimizationOptions().setSubsetFonts(true);
     viewOptions.getPdfOptimizationOptions().setCompressImages(true);
     viewOptions.getPdfOptimizationOptions().setImageQuality(50);
     viewOptions.getPdfOptimizationOptions().setResizeImages(true);
     viewOptions.getPdfOptimizationOptions().setMaxResolution(50);
     viewOptions.getPdfOptimizationOptions().setRemovePrivateInfo(true);
     viewOptions.getPdfOptimizationOptions().setUnembedFonts(true);
     viewOptions.getPdfOptimizationOptions().setLinkDuplicateStreams(true);
     viewOptions.getPdfOptimizationOptions().setAllowReusePageContent(true);

     viewer.view(viewOptions);
 }
 
```

[page]: https://docs.groupdocs.com/viewer/java/optimization-pdf-options/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptimizationOptions() | Sets up default values of MaxResolution option to 300 and ImageQuality option to 100. |
#### Methods

| Method | Description |
| --- | --- |
| isLinearize() | Enables optimization the output PDF file for viewing online with a web browser. |
| setLinearize(boolean linearize) | Sets whether to optimize output PDF for online browsing with a web browser. |
| isRemoveAnnotations() | Annotations can be deleted when they are unnecessary. |
| setRemoveAnnotations(boolean removeAnnotations) | Sets whether to remove unnecessary annotations from the PDF. |
| isRemoveFormFields() | If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields. |
| setRemoveFormFields(boolean removeFormFields) | Sets whether to remove form fields from the PDF. |
| isConvertToGrayScale() | PDF file is composed of Text, Image, Attachment, Annotations, Graphs and other objects. |
| setConvertToGrayScale(boolean convertToGrayScale) | Sets whether to convert the PDF to grayscale. |
| isSubsetFonts() | Every font used to display text on the page contains set of glyphs for font characters. |
| setSubsetFonts(boolean subsetFonts) | Sets whether to subset the fonts in the PDF. |
| isCompressImages() | If the source PDF file contains images, consider compressing the images and setting their quality. |
| setCompressImages(boolean compressImages) | Sets whether to compress the images in the PDF. |
| getImageQuality() | If the source PDF file contains images, consider compressing the images and setting their quality. |
| setImageQuality(int imageQuality) | Sets the image quality for compressing the images in the PDF. |
| isResizeImages() | Can be used with CompressImages option to resize the images with a lower resolution. |
| setResizeImages(boolean resizeImages) | Sets whether to resize the images in the PDF. |
| getMaxResolution() | Can be used with CompressImages option to resize the images with a lower resolution. |
| setMaxResolution(int maxResolution) | Sets the maximum resolution for resizing the images in the PDF. |
| isOptimizeSpreadsheets() | Optimize Excel spreadsheets border lines and fonts for smaller output file size. |
| setOptimizeSpreadsheets(boolean optimizeSpreadsheets) | Sets whether to optimize the spreadsheets in the PDF. |
| isRemovePrivateInfo() | Remove private information (page piece info) if set to true. |
| setRemovePrivateInfo(boolean removePrivateInfo) | Sets whether to remove private information from the PDF. |
| isUnembedFonts() | If the document uses embedded fonts it means that all font data is placed in the document. |
| setUnembedFonts(boolean unembedFonts) | Sets whether to unembed the embedded fonts in the PDF. |
| isLinkDuplicateStreams() | Sometimes a document contains several identical resource streams (for example images). |
| setLinkDuplicateStreams(boolean linkDuplicateStreams) | Sets whether to link duplicate streams in the PDF. |
| isAllowReusePageContent() | If this property is set to true, the page content will be reused when optimizing the document for identical pages. |
| setAllowReusePageContent(boolean allowReusePageContent) | Sets whether to allow reusing page content in the PDF. |
| isRemoveUnusedStreams() | Sometimes a document contains unused resource streams. |
| setRemoveUnusedStreams(boolean removeUnusedStreams) | Sets whether to remove unused streams from the PDF. |
| isRemoveUnusedObjects() | A PDF document sometimes contains the PDF objects that are not referenced from any other object in the document. |
| setRemoveUnusedObjects(boolean removeUnusedObjects) | Sets whether to remove unused objects from the PDF. |
##### PdfOptimizationOptions()
```
public PdfOptimizationOptions()
```

Sets up default values of MaxResolution option to 300 and ImageQuality option to 100.

For details and code samples, see this [page][] and its children.

[page]: https://docs.groupdocs.com/viewer/java/optimization-pdf-options/

##### isLinearize()
```
public boolean isLinearize()
```

Enables optimization the output PDF file for viewing online with a web browser.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-for-web/

**Returns:**
boolean -  true  if the output PDF is optimized for online browsing,  false  otherwise.
##### setLinearize(boolean linearize)
```
public void setLinearize(boolean linearize)
```

Sets whether to optimize output PDF for online browsing with a web browser.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-for-web/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linearize | boolean |  true  to optimize the output PDF for online browsing,  false  otherwise. |

##### isRemoveAnnotations()
```
public boolean isRemoveAnnotations()
```

Annotations can be deleted when they are unnecessary. When they are needed but do not require additional editing, they can be flattened. It will reduce the file size.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-annotations/

**Returns:**
boolean -  true  if annotations are removed,  false  otherwise.
##### setRemoveAnnotations(boolean removeAnnotations)
```
public void setRemoveAnnotations(boolean removeAnnotations)
```

Sets whether to remove unnecessary annotations from the PDF.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-annotations/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeAnnotations | boolean |  true  to remove unnecessary annotations,  false  otherwise. |

##### isRemoveFormFields()
```
public boolean isRemoveFormFields()
```

If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-fields/

**Returns:**
boolean -  true  if form fields are removed,  false  otherwise.
##### setRemoveFormFields(boolean removeFormFields)
```
public void setRemoveFormFields(boolean removeFormFields)
```

Sets whether to remove form fields from the PDF.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-fields/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeFormFields | boolean |  true  to remove form fields,  false  otherwise. |

##### isConvertToGrayScale()
```
public boolean isConvertToGrayScale()
```

PDF file is composed of Text, Image, Attachment, Annotations, Graphs and other objects. You may come across a requirement to convert a PDF from RGB colorspace to grayscale so that it would be faster while printing those PDF files. Also when the file is converted to grayscale, the size of the document is also reduced but with this change, the quality of the document may drop. Currently, this feature is supported by the Pre-Flight feature of Adobe Acrobat.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-convert-grayscale/

**Returns:**
boolean -  true  if the PDF is converted to grayscale,  false  otherwise.
##### setConvertToGrayScale(boolean convertToGrayScale)
```
public void setConvertToGrayScale(boolean convertToGrayScale)
```

Sets whether to convert the PDF to grayscale.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-convert-grayscale/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertToGrayScale | boolean |  true  to convert the PDF to grayscale,  false  otherwise. |

##### isSubsetFonts()
```
public boolean isSubsetFonts()
```

Every font used to display text on the page contains set of glyphs for font characters. PDF specification supports "font subset" i.e. font with only those glyphs which are used. This may cause issues when text should be updated (since probably required glyphs are absent in the font), but for the document which is not planned to change this allows to decrease size.

***Note:** The default value is  false .* If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-subset-fonts/

**Returns:**
boolean -  true  if fonts are subsetted,  false  otherwise.
##### setSubsetFonts(boolean subsetFonts)
```
public void setSubsetFonts(boolean subsetFonts)
```

Sets whether to subset the fonts in the PDF.

***Note:** The default value is  false .* If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-subset-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subsetFonts | boolean |  true  to subset the fonts,  false  otherwise. |

##### isCompressImages()
```
public boolean isCompressImages()
```

If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set this option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the ImageQuality property less than 100.

***Note:** The default value is  false .* Use this option to allow other compressing options: \#setImageQuality(int).setImageQuality(int) and . For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Returns:**
boolean -  true  if images are compressed,  false  otherwise.
##### setCompressImages(boolean compressImages)
```
public void setCompressImages(boolean compressImages)
```

Sets whether to compress the images in the PDF.

***Note:** The default value is  false .* Use this option to allow other compressing options: \#setImageQuality(int).setImageQuality(int) and . For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| compressImages | boolean |  true  to compress the images,  false  otherwise. |

##### getImageQuality()
```
public int getImageQuality()
```

If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set CompressImages option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the CompressImages option to true and ImageQuality property less than 100.

***Note:** The default value is  100 .* To change the image quality, first set the \#setCompressImages(boolean).setCompressImages(boolean) property to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Returns:**
int - the image quality (value between 1 and 100).
##### setImageQuality(int imageQuality)
```
public void setImageQuality(int imageQuality)
```

Sets the image quality for compressing the images in the PDF.

***Note:** The default value is  100 .* To change the image quality, first set the \#setCompressImages(boolean).setCompressImages(boolean) property to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageQuality | int | the image quality (value between 1 and 100). |

##### isResizeImages()
```
public boolean isResizeImages()
```

Can be used with CompressImages option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value.

***Note:** The default value is  false .* To allow this option, set the  property to true. This option allows setting the  property. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Returns:**
boolean -  true  if images are resized,  false  otherwise.
##### setResizeImages(boolean resizeImages)
```
public void setResizeImages(boolean resizeImages)
```

Sets whether to resize the images in the PDF.

***Note:** The default value is  false .* To allow this option, set the  property to true. This option allows setting the  property. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resizeImages | boolean |  true  to resize the images,  false  otherwise. |

##### getMaxResolution()
```
public int getMaxResolution()
```

Can be used with CompressImages option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value.

***Note:** The default value is  300 .* To allow this option, set the \#setCompressImages(boolean).setCompressImages(boolean) and \#setMaxResolution(int).setMaxResolution(int) properties to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Returns:**
int - the maximum resolution for the images.
##### setMaxResolution(int maxResolution)
```
public void setMaxResolution(int maxResolution)
```

Sets the maximum resolution for resizing the images in the PDF.

***Note:** The default value is  300 .* To allow this option, set the \#setCompressImages(boolean).setCompressImages(boolean) and \#setMaxResolution(int).setMaxResolution(int) properties to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxResolution | int | the maximum resolution for the images. |

##### isOptimizeSpreadsheets()
```
public boolean isOptimizeSpreadsheets()
```

Optimize Excel spreadsheets border lines and fonts for smaller output file size.

*The output PDF will not include embedded Arial and Times New Roman fonts with characters 32-127.*

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-spreadsheets/

**Returns:**
boolean -  true  if spreadsheets are optimized,  false  otherwise.
##### setOptimizeSpreadsheets(boolean optimizeSpreadsheets)
```
public void setOptimizeSpreadsheets(boolean optimizeSpreadsheets)
```

Sets whether to optimize the spreadsheets in the PDF.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-spreadsheets/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| optimizeSpreadsheets | boolean |  true  to optimize the spreadsheets,  false  otherwise. |

##### isRemovePrivateInfo()
```
public boolean isRemovePrivateInfo()
```

Remove private information (page piece info) if set to true.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if private information is removed,  false  otherwise.
##### setRemovePrivateInfo(boolean removePrivateInfo)
```
public void setRemovePrivateInfo(boolean removePrivateInfo)
```

Sets whether to remove private information from the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removePrivateInfo | boolean |  true  to remove private information,  false  otherwise. |

##### isUnembedFonts()
```
public boolean isUnembedFonts()
```

If the document uses embedded fonts it means that all font data is placed in the document. The advantage is that the document is viewable regardless of whether the font is installed on the user\\u2019s machine or not. But embedding fonts makes the document larger. The unembed fonts method removes all embedded fonts. This decreases the document size but the document may become unreadable if the correct font is not installed.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if embedded fonts are unembedded,  false  otherwise.
##### setUnembedFonts(boolean unembedFonts)
```
public void setUnembedFonts(boolean unembedFonts)
```

Sets whether to unembed the embedded fonts in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unembedFonts | boolean |  true  to unembed the embedded fonts,  false  otherwise. |

##### isLinkDuplicateStreams()
```
public boolean isLinkDuplicateStreams()
```

Sometimes a document contains several identical resource streams (for example images). This may happen for example when a document is concatenated with itself. The output document contains two independent copies of the same resource stream. We analyze all resource streams and compare them. If streams are duplicated they are merged, that is, only one copy is left, references are changed appropriately and copies of the object are removed. Sometimes this decreases the document size.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if duplicate streams are linked,  false  otherwise.
##### setLinkDuplicateStreams(boolean linkDuplicateStreams)
```
public void setLinkDuplicateStreams(boolean linkDuplicateStreams)
```

Sets whether to link duplicate streams in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linkDuplicateStreams | boolean |  true  to link duplicate streams,  false  otherwise. |

##### isAllowReusePageContent()
```
public boolean isAllowReusePageContent()
```

If this property is set to true, the page content will be reused when optimizing the document for identical pages.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if page content is reused,  false  otherwise.
##### setAllowReusePageContent(boolean allowReusePageContent)
```
public void setAllowReusePageContent(boolean allowReusePageContent)
```

Sets whether to allow reusing page content in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allowReusePageContent | boolean |  true  to allow reusing page content,  false  otherwise. |

##### isRemoveUnusedStreams()
```
public boolean isRemoveUnusedStreams()
```

Sometimes a document contains unused resource streams. These streams are not \\u201cunused objects\\u201d because they are referenced from a page\\u2019s resource dictionary. This may happen in cases where an image has been removed from the page but not from the page resources. Also, this situation often occurs when pages are extracted from the document and document pages have \\u201ccommon\\u201d resources, that is, the same Resources object. Page contents are analyzed in order to determine if a resource stream is used or not. Unused streams are removed. Sometimes this decreases the document size.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if unused streams are removed,  false  otherwise.
##### setRemoveUnusedStreams(boolean removeUnusedStreams)
```
public void setRemoveUnusedStreams(boolean removeUnusedStreams)
```

Sets whether to remove unused streams from the PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeUnusedStreams | boolean |  true  to remove unused streams,  false  otherwise. |

##### isRemoveUnusedObjects()
```
public boolean isRemoveUnusedObjects()
```

A PDF document sometimes contains the PDF objects that are not referenced from any other object in the document. This may happen, for example, when a page is removed from the document page tree but the page object itself isn\\u2019t removed. Removing these objects doesn\\u2019t make the document invalid but rather shrinks it.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if unused objects are removed,  false  otherwise.
##### setRemoveUnusedObjects(boolean removeUnusedObjects)
```
public void setRemoveUnusedObjects(boolean removeUnusedObjects)
```

Sets whether to remove unused objects from the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeUnusedObjects | boolean |  true  to remove unused objects,  false  otherwise. |

### PdfOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/pdfoptions.md

**Inheritance:**
java.lang.Object
```
public class PdfOptions
```

Provides options for rendering PDF documents.

The PdfOptions class encapsulates various settings and parameters that can be used to control the rendering of PDF documents in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PdfOptions options = new PdfOptions();
 options.setDisableCharsGrouping(true);
 options.setRenderTextAsImage(true);
 options.setEnableFontHinting(true);

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setPdfOptions(options);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptions() | Initializes a new instance of  PdfOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| isDisableCopyProtection() | Turns off content copy protection when rendering to HTML. |
| setDisableCopyProtection(boolean disableCopyProtection) | Turns off content copy protection when rendering to HTML. |
| isRenderTextAsImage() | Determines whether the text from the source is rendered as an image in HTML. |
| setRenderTextAsImage(boolean renderTextAsImage) | Sets whether the text from the source is rendered as an image in HTML. |
| isDisableCharsGrouping() | Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. |
| setDisableCharsGrouping(boolean value) | Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. |
| isEnableLayeredRendering() | Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. |
| setEnableLayeredRendering(boolean value) | Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML. |
| isEnableFontHinting() | Determines whether font hinting is enabled. |
| setEnableFontHinting(boolean value) | Enables font hinting. |
| isRenderOriginalPageSize() | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. |
| setRenderOriginalPageSize(boolean renderOriginalPageSize) | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. |
| getImageQuality() | Retrieves the output image quality for image resources when rendering into HTML. |
| setImageQuality(ImageQuality value) | Sets the output image quality for image resources when rendering into HTML. |
| isFixedLayout() | PDF is a fixed format so all of the elements have a specific place on a page. |
| setFixedLayout(boolean fixedLayout) | PDF is a fixed format so all of the elements have a specific place on a page. |
| isWrapImagesInSvg() | Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. |
| setWrapImagesInSvg(boolean wrapImagesInSvg) | Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. |
| isFixLinkIssue() | Tries to fix the issue when whole HTML page content is a link. |
| setFixLinkIssue(boolean fixLinkIssue) | Tries to fix the issue when whole HTML page content is a link. |
| isAnalyzeFonts() | Replaces fonts as necessary to ensure all characters in the text can be displayed. |
| setAnalyzeFonts(boolean analyzeFonts) | Replaces fonts as necessary to ensure all characters in the text can be displayed. |
| isDisableFontLicenseVerifications() | Disable any license restrictions for all fonts in current XPS/OXPS document. |
| setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications) | Set the flag to disable any license restrictions for all fonts in current XPS/OXPS document. |
##### PdfOptions()
```
public PdfOptions()
```

Initializes a new instance of  PdfOptions  class.

##### isDisableCopyProtection()
```
public boolean isDisableCopyProtection()
```

Turns off content copy protection when rendering to HTML.

When rendering PDF files with protection against copying text and images to HTML, GroupDocs.Viewer adds an 'inert' HTML attribute to the HTML BODY tag. The default value of this option is  false .

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-copy-protection

**Returns:**
boolean
##### setDisableCopyProtection(boolean disableCopyProtection)
```
public void setDisableCopyProtection(boolean disableCopyProtection)
```

Turns off content copy protection when rendering to HTML.

When rendering PDF files with protection against copying text and images to HTML, GroupDocs.Viewer adds an 'inert' HTML attribute to the HTML BODY tag. The default value of this option is  false .

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-copy-protection

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| disableCopyProtection | boolean |  |

##### isRenderTextAsImage()
```
public boolean isRenderTextAsImage()
```

Determines whether the text from the source is rendered as an image in HTML.

When this option is set to  true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if the text is rendered as an image in HTML,  false  otherwise.
##### setRenderTextAsImage(boolean renderTextAsImage)
```
public void setRenderTextAsImage(boolean renderTextAsImage)
```

Sets whether the text from the source is rendered as an image in HTML.

When this option is set to  true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderTextAsImage | boolean |  true  to render the text as an image in HTML,  false  otherwise. |

##### isDisableCharsGrouping()
```
public final boolean isDisableCharsGrouping()
```

Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. When this option is enabled, the characters are rendered without any grouping, which ensures maximum precision.

***Note:** By default, character grouping is enabled.* When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#disable-character-grouping

**Returns:**
boolean -  true  if character grouping is disabled,  false  otherwise.
##### setDisableCharsGrouping(boolean value)
```
public final void setDisableCharsGrouping(boolean value)
```

Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. When this option is enabled by setting the value to  true , character grouping is disabled, which ensures maximum precision.

***Note:** Disabling character grouping can help preserve the exact positioning of characters on the rendered page.* When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#disable-character-grouping

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to disable character grouping,  false  to enable it. |

##### isEnableLayeredRendering()
```
public final boolean isEnableLayeredRendering()
```

Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. When this option is enabled by returning  true , text and graphics are rendered according to their z-order in the original PDF document.

***Note:** By default, text and graphics are rendered into HTML as a single layer.* By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-multi-layer-rendering

**Returns:**
boolean -  true  if layered rendering is enabled,  false  otherwise.
##### setEnableLayeredRendering(boolean value)
```
public final void setEnableLayeredRendering(boolean value)
```

Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML.

***Note:** By default, text and graphics are rendered into HTML as a single layer.* By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-multi-layer-rendering

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable layered rendering,  false  to disable it. |

##### isEnableFontHinting()
```
public final boolean isEnableFontHinting()
```

Determines whether font hinting is enabled. Font hinting adjusts the display of an outline font. This option is supported only for TrueType (TTF) fonts when used in the source document.

***Note:** This option is supported when rendering into PNG or JPG formats.* Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-font-hinting

**Returns:**
boolean -  true  if font hinting is enabled,  false  otherwise.
##### setEnableFontHinting(boolean value)
```
public final void setEnableFontHinting(boolean value)
```

Enables font hinting. Font hinting adjusts the display of an outline font and is supported only for TrueType (TTF) fonts when used in the source document.

***Note:** This option is supported when rendering into PNG or JPG formats.* Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-font-hinting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable font hinting,  false  to disable it. |

##### isRenderOriginalPageSize()
```
public boolean isRenderOriginalPageSize()
```

Enables rendering of pages with the same size in pixels as the page size in the source PDF document.

***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is false. This option is available for rendering to PNG or JPG formats. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#preserve-the-size-of-document-pages

**Returns:**
boolean -  true  if the option is enabled,  false  otherwise.
##### setRenderOriginalPageSize(boolean renderOriginalPageSize)
```
public void setRenderOriginalPageSize(boolean renderOriginalPageSize)
```

Enables rendering of pages with the same size in pixels as the page size in the source PDF document.

***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is false. This option is available for rendering to PNG or JPG formats. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#preserve-the-size-of-document-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderOriginalPageSize | boolean |  true  to enable rendering with the original page size,  false  otherwise. |

##### getImageQuality()
```
public final ImageQuality getImageQuality()
```

Retrieves the output image quality for image resources when rendering into HTML. The default value is Low.

When this option is set to true, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is false. This option is available for rendering to HTML. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#render-text-as-an-image

**Returns:**
ImageQuality - the output image quality for image resources when rendering into HTML.
##### setImageQuality(ImageQuality value)
```
public final void setImageQuality(ImageQuality value)
```

Sets the output image quality for image resources when rendering into HTML. The default value is Low.

When this option is set to true, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is false. This option is available for rendering to HTML. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#render-text-as-an-image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ImageQuality | The output image quality for image resources when rendering into HTML. |

##### isFixedLayout()
```
public boolean isFixedLayout()
```

PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to false.

***Note:** The default value is true. This option is supported when rendering into HTML. When rendering to fluid layout images are skipped. Use fluid layout when rendering PDF documents with textual content.* PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document. This option is only available when rendering to HTML. The default value is true. To render with a fluid layout, set this property to false.

Example usage:

```

 try (Viewer viewer = new Viewer("resume.pdf")) {
      HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources("page_{0}.html");
      viewOptions.setFixedLayout(false);
      viewer.view(viewOptions);
 }
 
```

**Returns:**
boolean - true if it is fixed layout
##### setFixedLayout(boolean fixedLayout)
```
public void setFixedLayout(boolean fixedLayout)
```

PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to false.

***Note:** The default value is true. This option is supported when rendering into HTML. When rendering to fluid layout images are skipped. Use fluid layout when rendering PDF documents with textual content.* PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document. This option is only available when rendering to HTML. The default value is true. To render with a fluid layout, set this property to false.

Example usage:

```

 try (Viewer viewer = new Viewer("resume.pdf")) {
      HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources("page_{0}.html");
      viewOptions.setFixedLayout(false);
      viewer.view(viewOptions);
 }
 
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayout | boolean | true if it is fixed layout |

##### isWrapImagesInSvg()
```
public boolean isWrapImagesInSvg()
```

Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.

This option is supported when rendering [PDF and Page Layout file formats][] to HTML with embedded and external resources.

By default, when rendering to PDF and Page Layout files, all the images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document.

Learn more:

 *  [Render PDF documents as HTML and image files][]
 *  [Render to HTML][]

[PDF and Page Layout file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#pdf-and-page-layout-file-formats
[Render PDF documents as HTML and image files]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
[Render to HTML]: https://docs.groupdocs.com/viewer/java/rendering-to-html/

**Returns:**
boolean -  true  if images are wrapped in SVG,  false  otherwise.
##### setWrapImagesInSvg(boolean wrapImagesInSvg)
```
public void setWrapImagesInSvg(boolean wrapImagesInSvg)
```

Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.

This option is supported when rendering [PDF and Page Layout file formats][] to HTML with embedded and external resources.

By default, when rendering to PDF and Page Layout files, all the images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document.

Learn more:

 *  [Render PDF documents as HTML and image files][]
 *  [Render to HTML][]

[PDF and Page Layout file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#pdf-and-page-layout-file-formats
[Render PDF documents as HTML and image files]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
[Render to HTML]: https://docs.groupdocs.com/viewer/java/rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wrapImagesInSvg | boolean |  true  if images should be wrapped in SVG,  false  otherwise. |

##### isFixLinkIssue()
```
public boolean isFixLinkIssue()
```

Tries to fix the issue when whole HTML page content is a link. Works only when input format is PDF and output format is HTML (with embedded or external resources). By default is disabled (false). Turn it on only when you know what and why you're doing. Turing this option on increases the document processing time.

**Returns:**
boolean
##### setFixLinkIssue(boolean fixLinkIssue)
```
public void setFixLinkIssue(boolean fixLinkIssue)
```

Tries to fix the issue when whole HTML page content is a link. Works only when input format is PDF and output format is HTML (with embedded or external resources). By default is disabled (false). Turn it on only when you know what and why you're doing. Turing this option on increases the document processing time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixLinkIssue | boolean | true if the issue should be fixed, false otherwise. |

##### isAnalyzeFonts()
```
public boolean isAnalyzeFonts()
```

Replaces fonts as necessary to ensure all characters in the text can be displayed.

**Returns:**
boolean
##### setAnalyzeFonts(boolean analyzeFonts)
```
public void setAnalyzeFonts(boolean analyzeFonts)
```

Replaces fonts as necessary to ensure all characters in the text can be displayed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| analyzeFonts | boolean | true if the fonts should be displayed, false otherwise. |

##### isDisableFontLicenseVerifications()
```
public boolean isDisableFontLicenseVerifications()
```

Disable any license restrictions for all fonts in current XPS/OXPS document.

Many operations with font can't be executed if these operations are prohibited by the license of this font. For example, some font can't be embedded into a PDF document if the license rules disable embedding for this font. Be careful when using this flag. When it is set, it means that the person who sets this flag takes all responsibility for possible license/law violations on themselves. So they take it on their own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. For code example, see the [documentation][].

Example usage:

```

 try (Viewer viewer = new Viewer("resume.oxps")) {
     HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources("result.html");
     options.getPdfOptions().setDisableFontLicenseVerifications(true);
     viewer.view(options);
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files

**Returns:**
boolean
##### setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications)
```
public void setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications)
```

Set the flag to disable any license restrictions for all fonts in current XPS/OXPS document.

Many operations with font can't be executed if these operations are prohibited by the license of this font. For example, some font can't be embedded into a PDF document if the license rules disable embedding for this font. Be careful when using this flag. When it is set, it means that the person who sets this flag takes all responsibility for possible license/law violations on themselves. So they take it on their own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. For code example, see the [documentation][].

Example usage:

```

 try (Viewer viewer = new Viewer("resume.oxps")) {
     HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources("result.html");
     options.getPdfOptions().setDisableFontLicenseVerifications(true);
     viewer.view(options);
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| disableFontLicenseVerifications | boolean |  |

### PdfViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/pdfviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions
```
public class PdfViewOptions extends ViewOptions
```

Provides options for rendering documents into PDF format.

The PdfViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PDF format in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setImageHeight(256);
 pdfViewOptions.setImageWidth(128);
 pdfViewOptions.setDefaultFontName("font-name");

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfViewOptions(CreateFileStream createFileStream) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(FileStreamFactory fileStreamFactory) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions() | Initializes a new instance of the  PdfViewOptions  class with default settings. |
| PdfViewOptions(String outputFilePath) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(Path outputFilePath) | Initializes a new instance of the  PdfViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPdfOptimizationOptions() | Reduce output PDF file size applying optimization techniques with different options. |
| setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions) | Reduce output PDF file size applying optimization techniques with different options. |
| getImageMaxWidth() | Retrieves the maximum width of an output image in pixels. |
| setImageMaxWidth(int imageMaxWidth) | Sets the maximum width of an output image in pixels. |
| getImageMaxHeight() | Retrieves the maximum height of an output image in pixels. |
| setImageMaxHeight(int imageMaxHeight) | Sets the maximum height of an output image in pixels. |
| getImageWidth() | Retrieves the width of the output image in pixels. |
| setImageWidth(int imageWidth) | Sets the width of the output image in pixels. |
| getImageHeight() | Retrieves the height of the output image in pixels. |
| setImageHeight(int imageHeight) | Sets the height of the output image in pixels. |
| getSecurity() | Retrieves the security options for the output PDF document. |
| setSecurity(Security value) | Sets the security options for the output PDF document. |
| getDocumentSavingCallback() | Retrieves the callback used to estimate the progress of saving a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback used to estimate the progress of saving a Words or Email document. |
##### PdfViewOptions(CreateFileStream createFileStream)
```
public PdfViewOptions(CreateFileStream createFileStream)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream |  |

##### PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)
```
public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream | The method used to instantiate the stream for writing the output file data. |
| releaseFileStream | ReleaseFileStream | The method used to release the stream created by the  createFileStream  method. |

##### PdfViewOptions(FileStreamFactory fileStreamFactory)
```
public PdfViewOptions(FileStreamFactory fileStreamFactory)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStreamFactory | FileStreamFactory | The factory that implements methods for creating and releasing the output file stream. |

##### PdfViewOptions()
```
public PdfViewOptions()
```

Initializes a new instance of the  PdfViewOptions  class with default settings.

This constructor creates a new  PdfViewOptions  object with "output.pdf" as the file path format for the output file. The output file will be placed into the current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

##### PdfViewOptions(String outputFilePath)
```
public PdfViewOptions(String outputFilePath)
```

Initializes a new instance of the  PdfViewOptions  class.

This constructor creates a new  PdfViewOptions  object with the specified  outputFilePath  parameter representing the path for the output PDF file. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | java.lang.String | The path for the output PDF file. |

##### PdfViewOptions(Path outputFilePath)
```
public PdfViewOptions(Path outputFilePath)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | java.nio.file.Path | The path for the output PDF file. |

##### getPdfOptimizationOptions()
```
public PdfOptimizationOptions getPdfOptimizationOptions()
```

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: [Supported document formats][] For details and code samples, see this [page][] and its children.

[Supported document formats]: https://docs.groupdocs.com/viewer/net/supported-document-formats/
[page]: https://docs.groupdocs.com/viewer/net/optimization-pdf-options/

**Returns:**
PdfOptimizationOptions - PdfOptimizationOptions object or null.
##### setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions)
```
public void setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions)
```

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: [Supported document formats][] For details and code samples, see this [page][] and its children.

[Supported document formats]: https://docs.groupdocs.com/viewer/net/supported-document-formats/
[page]: https://docs.groupdocs.com/viewer/net/optimization-pdf-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfOptimizationOptions | PdfOptimizationOptions | PdfOptimizationOptions object or null. |

##### getImageMaxWidth()
```
public int getImageMaxWidth()
```

Retrieves the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the maximum width of the output image in pixels.
##### setImageMaxWidth(int imageMaxWidth)
```
public void setImageMaxWidth(int imageMaxWidth)
```

Sets the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxWidth | int | The maximum width of the output image in pixels. |

##### getImageMaxHeight()
```
public int getImageMaxHeight()
```

Retrieves the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the maximum height of the output image in pixels.
##### setImageMaxHeight(int imageMaxHeight)
```
public void setImageMaxHeight(int imageMaxHeight)
```

Sets the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxHeight | int | The maximum height of the output image in pixels. |

##### getImageWidth()
```
public int getImageWidth()
```

Retrieves the width of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the width of the output image in pixels.
##### setImageWidth(int imageWidth)
```
public void setImageWidth(int imageWidth)
```

Sets the width of the output image in pixels. This parameter applies only when converting a single image PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageWidth | int | The width of the output image in pixels. |

##### getImageHeight()
```
public int getImageHeight()
```

Retrieves the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the height of the output image in pixels.
##### setImageHeight(int imageHeight)
```
public void setImageHeight(int imageHeight)
```

Sets the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageHeight | int | The height of the output image in pixels. |

##### getSecurity()
```
public final Security getSecurity()
```

Retrieves the security options for the output PDF document.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
Security - the security options for the output PDF document.
##### setSecurity(Security value)
```
public final void setSecurity(Security value)
```

Sets the security options for the output PDF document.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Security | The security options for the output PDF document. |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback used to estimate the progress of saving a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback used to estimate the progress of saving a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### Permissions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/permissions.md

**Inheritance:**
java.lang.Object
```
public class Permissions
```

Defines PDF document permissions.

The Permissions class provides constants that represent different permissions that can be applied to a PDF document in the GroupDocs.Viewer component. These permissions control the actions that can be performed on the PDF document, such as printing, copying text, modifying annotations, and more.

Example usage:

```

 int permissions = Permissions.DENY_PRINTING | Permissions.DENY_MODIFICATION;
 final Security security = new Security();
 security.setPermissions(permissions);
 final PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setSecurity(security);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Permissions() |  |
#### Fields

| Field | Description |
| --- | --- |
| ALLOW_ALL | Allow printing, modification, and data extraction. |
| DENY_PRINTING | Deny printing. |
| DENY_MODIFICATION | Deny content modification, filling in forms, adding or modifying annotations. |
| DENY_DATA_EXTRACTION | Deny text and graphics extraction. |
| DENY_ALL | Deny printing, modification, and data extraction. |
##### Permissions()
```
public Permissions()
```

##### ALLOW_ALL
```
public static final int ALLOW_ALL
```

Allow printing, modification, and data extraction.

##### DENY_PRINTING
```
public static final int DENY_PRINTING
```

Deny printing.

##### DENY_MODIFICATION
```
public static final int DENY_MODIFICATION
```

Deny content modification, filling in forms, adding or modifying annotations.

##### DENY_DATA_EXTRACTION
```
public static final int DENY_DATA_EXTRACTION
```

Deny text and graphics extraction.

##### DENY_ALL
```
public static final int DENY_ALL
```

Deny printing, modification, and data extraction.

### PngViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/pngviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class PngViewOptions extends ViewOptions implements IMaxSizeOptions
```

Provides options for rendering documents into PNG format.

The PngViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PNG format in the GroupDocs.Viewer component.

Example usage:

```

 PngViewOptions options = new PngViewOptions();
 options.setHeight(1080);
 options.setWidth(1920);
 options.setRenderComments(true);
 options.setRenderComments(true);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

***Note:** The PngViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output PNG images.* For details, see this [page][] and its children.

[page]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/
#### Constructors

| Constructor | Description |
| --- | --- |
| PngViewOptions(CreatePageStream createPageStream) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions() | Initializes new instance of  PngViewOptions  class. |
| PngViewOptions(String filePathFormat) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(Path filePathFormat) | Initializes a new instance of the  PngViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxWidth() | Returns the maximum width of an output image in pixels. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image in pixels. |
| getMaxHeight() | Returns the maximum height of an output image in pixels. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image in pixels. |
| isExtractText() | Determines whether text extraction is enabled. |
| setExtractText(boolean value) | Enables or disables text extraction. |
| getWidth() | Returns the width of the output image in pixels. |
| setWidth(int value) | Sets the width of the output image in pixels. |
| getHeight() | Returns the height of the output image in pixels. |
| setHeight(int value) | Sets the height of the output image in pixels. |
| getDocumentSavingCallback() | Retrieves the callback for estimating the saving progress of a document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback for estimating the saving progress of a document. |
##### PngViewOptions(CreatePageStream createPageStream)
```
public PngViewOptions(CreatePageStream createPageStream)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |

##### PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the createPageStream parameter. |

##### PngViewOptions(PageStreamFactory pageStreamFactory)
```
public PngViewOptions(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

##### PngViewOptions()
```
public PngViewOptions()
```

Initializes new instance of  PngViewOptions  class.

This constructor initializes new instance of  PngViewOptions  with "p\_\{0\}.png" as file path format for the output files. The output files will be placed into current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

##### PngViewOptions(String filePathFormat)
```
public PngViewOptions(String filePathFormat)
```

Initializes a new instance of the  PngViewOptions  class.

For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number.

***Note:** It is important to note that the output files will be placed into the current working directory of the application.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.png'. |

##### PngViewOptions(Path filePathFormat)
```
public PngViewOptions(Path filePathFormat)
```

Initializes a new instance of the  PngViewOptions  class.

For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.png'. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Returns the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of the output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of the output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Returns the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of the output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of the output image. |

##### isExtractText()
```
public final boolean isExtractText()
```

Determines whether text extraction is enabled.

This option might be useful when you want to add a selectable text layer over the image. Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Returns:**
boolean -  true  if text extraction is enabled,  false  otherwise.
##### setExtractText(boolean value)
```
public final void setExtractText(boolean value)
```

Enables or disables text extraction.

This option might be useful when you want to add a selectable text layer over the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable text extraction,  false  to disable it. |

##### getWidth()
```
public final int getWidth()
```

Returns the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the width of the output image.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the output image. |

##### getHeight()
```
public final int getHeight()
```

Returns the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the height of the output image.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the output image. |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback for estimating the saving progress of a document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback for estimating the saving progress of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### Position
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/position.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Position extends Enum<Position>
```

Defines watermark position.

The Position enum represents different positions for a watermark in the GroupDocs.Viewer component. It provides a set of predefined positions that can be used to specify the placement of a watermark on a document or image during the rendering process.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| DIAGONAL | The diagonal position. |
| TOP_LEFT | The top left position. |
| TOP_CENTER | The top center position. |
| TOP_RIGHT | The top right position. |
| BOTTOM_LEFT | The bottom left position. |
| BOTTOM_CENTER | The bottom center position. |
| BOTTOM_RIGHT | The bottom right position. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### DIAGONAL
```
public static final Position DIAGONAL
```

The diagonal position. This position represents a diagonal alignment or placement.

##### TOP_LEFT
```
public static final Position TOP_LEFT
```

The top left position. This position represents the top left corner alignment or placement.

##### TOP_CENTER
```
public static final Position TOP_CENTER
```

The top center position. This position represents the top center alignment or placement.

##### TOP_RIGHT
```
public static final Position TOP_RIGHT
```

The top right position. This position represents the top right corner alignment or placement.

##### BOTTOM_LEFT
```
public static final Position BOTTOM_LEFT
```

The bottom left position. This position represents the bottom left corner alignment or placement.

##### BOTTOM_CENTER
```
public static final Position BOTTOM_CENTER
```

The bottom center position. This position represents the bottom center alignment or placement.

##### BOTTOM_RIGHT
```
public static final Position BOTTOM_RIGHT
```

The bottom right position. This position represents the bottom right corner alignment or placement.

##### values()
```
public static Position[] values()
```

**Returns:**
com.groupdocs.viewer.options.Position[]
##### valueOf(String name)
```
public static Position valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Position

### PresentationOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/presentationoptions.md

**Inheritance:**
java.lang.Object
```
public class PresentationOptions
```

Provides options for rendering presentations options.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| isRenderToPureHtml() | Enables a new HTML rendering mode for Presentation documents. |
| setRenderToPureHtml(boolean renderToPureHtml) | Enables a new HTML rendering mode for Presentation documents. |
| isRenderHeaderFooterPlaceholders() | Enables rendering placeholders in the header and footer of a slide. |
| setRenderHeaderFooterPlaceholders(boolean renderHeaderFooterPlaceholders) | Enables rendering placeholders in the header and footer of a slide. |
| getResolution() | Resolution for images inside presentation (for to HTML/PDF rendering only). |
| setResolution(Resolution resolution) | Resolution for images inside presentation (for to HTML/PDF rendering only). |
##### PresentationOptions()
```
public PresentationOptions()
```

##### isRenderToPureHtml()
```
public boolean isRenderToPureHtml()
```

Enables a new HTML rendering mode for Presentation documents.

In this mode, the Presentation files are rendered to pure HTML/CSS markup, without SVG images. By default, this feature is disabled (false). Existing SVG-based HTML renderer is used if this option is not enabled.

**Returns:**
boolean
##### setRenderToPureHtml(boolean renderToPureHtml)
```
public void setRenderToPureHtml(boolean renderToPureHtml)
```

Enables a new HTML rendering mode for Presentation documents.

In this mode, the Presentation files are rendered to pure HTML/CSS markup, without SVG images. By default, this feature is disabled (false). Existing SVG-based HTML renderer is used if this option is not enabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderToPureHtml | boolean |  |

##### isRenderHeaderFooterPlaceholders()
```
public boolean isRenderHeaderFooterPlaceholders()
```

Enables rendering placeholders in the header and footer of a slide. Disabled by default (false). This option applies for all 4 rendering modes of presentations: HTML, PDF, PNG, and JPEG. Is not applicable when rendering presentation to pure HTML/CSS markup using .

**Returns:**
boolean
##### setRenderHeaderFooterPlaceholders(boolean renderHeaderFooterPlaceholders)
```
public void setRenderHeaderFooterPlaceholders(boolean renderHeaderFooterPlaceholders)
```

Enables rendering placeholders in the header and footer of a slide. Disabled by default (false). This option applies for all 4 rendering modes of presentations: HTML, PDF, PNG, and JPEG. Is not applicable when rendering presentation to pure HTML/CSS markup using .

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderHeaderFooterPlaceholders | boolean |  |

##### getResolution()
```
public Resolution getResolution()
```

Resolution for images inside presentation (for to HTML/PDF rendering only).

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#specify-image-resolution

**Returns:**
com.groupdocs.viewer.options.Resolution
##### setResolution(Resolution resolution)
```
public void setResolution(Resolution resolution)
```

Resolution for images inside presentation (for to HTML/PDF rendering only).

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#specify-image-resolution

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resolution | com.groupdocs.viewer.options.Resolution |  |

### ProjectManagementOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/projectmanagementoptions.md

**Inheritance:**
java.lang.Object
```
public class ProjectManagementOptions
```

Provides options for rendering project management files.

The ProjectManagementOptions class encapsulates various settings and parameters that can be used to control the rendering of project management files (such as Microsoft Project or similar) in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 ProjectManagementOptions projectManagementOptions = pngViewOptions.getProjectManagementOptions();
 projectManagementOptions.setPageSize(PageSize.A4);
 projectManagementOptions.setStartDate(new Date(2021, 11, 23));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/
#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementOptions() | Initializes a new instance of the  ProjectManagementOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() | Retrieves the output page size. |
| setPageSize(PageSize value) | Sets the output page size. |
| getTimeUnit() | Retrieves the time unit. |
| setTimeUnit(TimeUnit value) | Retrieves the time unit. |
| getStartDate() | Retrieves the start date of the Gantt Chart View to be included in the output. |
| setStartDate(Date value) | Sets the start date of the Gantt Chart View to be included in the output. |
| getEndDate() | Retrieves the end date of the Gantt Chart View to be included in the output. |
| setEndDate(Date value) | Sets the end date of the Gantt Chart View to be included in the output. |
##### ProjectManagementOptions()
```
public ProjectManagementOptions()
```

Initializes a new instance of the  ProjectManagementOptions  class.

##### getPageSize()
```
public final PageSize getPageSize()
```

Retrieves the output page size.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#specify-the-output-page-size

**Returns:**
PageSize - the output page size.
##### setPageSize(PageSize value)
```
public final void setPageSize(PageSize value)
```

Sets the output page size.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#specify-the-output-page-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageSize | The output page size. |

##### getTimeUnit()
```
public final TimeUnit getTimeUnit()
```

Retrieves the time unit.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

**Returns:**
TimeUnit - the time unit.
##### setTimeUnit(TimeUnit value)
```
public final void setTimeUnit(TimeUnit value)
```

Retrieves the time unit.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TimeUnit | The time unit. |

##### getStartDate()
```
public final Date getStartDate()
```

Retrieves the start date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Returns:**
java.util.Date - the start date of the Gantt Chart View.
##### setStartDate(Date value)
```
public final void setStartDate(Date value)
```

Sets the start date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The start date of the Gantt Chart View. |

##### getEndDate()
```
public final Date getEndDate()
```

Retrieves the end date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Returns:**
java.util.Date - the end date of the Gantt Chart View.
##### setEndDate(Date value)
```
public final void setEndDate(Date value)
```

Sets the end date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The end date of the Gantt Chart View. |

### Resolution
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/resolution.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Resolution extends Enum<Resolution>
```

Provides option to set resolution for images : output document.
#### Fields

| Field | Description |
| --- | --- |
| DPI_330 | Good quality for high-definition (HD) displays. |
| DPI_220 | Excellent quality on most printers and screens. |
| DPI_150 | Good for web pages and projectors. |
| DPI_96 | Good for web pages and projectors. |
| DPI_72 | Default compression level. |
| DOCUMENT_RESOLUTION | Default compression level - as the document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getValue() | Quality DPI. |
| getSlidesPicturesResolution() | Get Aspose.Slides pictures resolution from options Resolution class. |
##### DPI_330
```
public static final Resolution DPI_330
```

Good quality for high-definition (HD) displays.

##### DPI_220
```
public static final Resolution DPI_220
```

Excellent quality on most printers and screens.

##### DPI_150
```
public static final Resolution DPI_150
```

Good for web pages and projectors.

##### DPI_96
```
public static final Resolution DPI_96
```

Good for web pages and projectors.

##### DPI_72
```
public static final Resolution DPI_72
```

Default compression level.

##### DOCUMENT_RESOLUTION
```
public static final Resolution DOCUMENT_RESOLUTION
```

Default compression level - as the document.

##### values()
```
public static Resolution[] values()
```

**Returns:**
com.groupdocs.viewer.options.Resolution[]
##### valueOf(String name)
```
public static Resolution valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
com.groupdocs.viewer.options.Resolution
##### getValue()
```
public int getValue()
```

Quality DPI.

**Returns:**
int
##### getSlidesPicturesResolution()
```
public int getSlidesPicturesResolution()
```

Get Aspose.Slides pictures resolution from options Resolution class.

**Returns:**
int

### Rotation
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/rotation.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Rotation extends Enum<Rotation>
```

Contains page rotation in degrees (clockwise).

The Rotation enum represents different rotation angles for a page in the GroupDocs.Viewer component. It provides a set of predefined rotation options that can be used to specify the rotation angle for rendering a page in various document viewing or conversion scenarios.

Example usage:

```

 PdfViewOptions pdfViewOptions = new PdfViewOptions();

 pdfViewOptions.rotatePage(1, Rotation.ON_90_DEGREE);
 pdfViewOptions.rotatePage(2, Rotation.ON_180_DEGREE);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| ON_90_DEGREE | The 90 degree page rotation. |
| ON_180_DEGREE | The 180 degree page rotation. |
| ON_270_DEGREE | The 270 degree page rotation. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### ON_90_DEGREE
```
public static final Rotation ON_90_DEGREE
```

The 90 degree page rotation. This rotation represents a 90-degree clockwise rotation of the page.

##### ON_180_DEGREE
```
public static final Rotation ON_180_DEGREE
```

The 180 degree page rotation. This rotation represents a 180-degree clockwise rotation of the page.

##### ON_270_DEGREE
```
public static final Rotation ON_270_DEGREE
```

The 270 degree page rotation. This rotation represents a 270-degree clockwise rotation of the page.

##### values()
```
public static Rotation[] values()
```

**Returns:**
com.groupdocs.viewer.options.Rotation[]
##### valueOf(String name)
```
public static Rotation valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Rotation

### SearchHighlightOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/searchhighlightoptions.md

**Inheritance:**
java.lang.Object
```
public final class SearchHighlightOptions
```

Provides options for searching and highlighting text in the documents, loaded to the Viewer class.
#### Constructors

| Constructor | Description |
| --- | --- |
| SearchHighlightOptions() |  |
| SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor) |  |
#### Methods

| Method | Description |
| --- | --- |
| isSearchTermRegEx() |  |
| setSearchTermRegEx(boolean searchTermRegEx) |  |
| getSearchTerm() |  |
| setSearchTerm(String searchTerm) |  |
| getBackgroundColor() |  |
| setBackgroundColor(Argb32Color backgroundColor) |  |
| getForegroundColor() |  |
| setForegroundColor(Argb32Color foregroundColor) |  |
##### SearchHighlightOptions()
```
public SearchHighlightOptions()
```

##### SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
```
public SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTerm | java.lang.String |  |
| searchTermRegEx | boolean |  |
| backgroundColor | Argb32Color |  |
| foregroundColor | Argb32Color |  |

##### isSearchTermRegEx()
```
public boolean isSearchTermRegEx()
```

**Returns:**
boolean
##### setSearchTermRegEx(boolean searchTermRegEx)
```
public void setSearchTermRegEx(boolean searchTermRegEx)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTermRegEx | boolean |  |

##### getSearchTerm()
```
public String getSearchTerm()
```

**Returns:**
java.lang.String
##### setSearchTerm(String searchTerm)
```
public void setSearchTerm(String searchTerm)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTerm | java.lang.String |  |

##### getBackgroundColor()
```
public Argb32Color getBackgroundColor()
```

**Returns:**
Argb32Color
##### setBackgroundColor(Argb32Color backgroundColor)
```
public void setBackgroundColor(Argb32Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | Argb32Color |  |

##### getForegroundColor()
```
public Argb32Color getForegroundColor()
```

**Returns:**
Argb32Color
##### setForegroundColor(Argb32Color foregroundColor)
```
public void setForegroundColor(Argb32Color foregroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| foregroundColor | Argb32Color |  |

### Security
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/security.md

**Inheritance:**
java.lang.Object
```
public class Security
```

Provides PDF document security options.

The Security class encapsulates various settings and options that can be used to apply security measures to a PDF document in the GroupDocs.Viewer component. These options include password protection, permissions, and more. For details, see the [documentation][].

Example usage:

```

 Security security = new Security();
 security.setDocumentOpenPassword("myPassword");
 security.setPermissions(Permissions.DENY_MODIFICATION);

 final PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setSecurity(security);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| Security() | Initializes a new instance of the  Security  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentOpenPassword() | Gets the password required to open the PDF document. |
| setDocumentOpenPassword(String value) | Sets the password required to open the PDF document. |
| getPermissionsPassword() | Gets the password required to change permission settings. |
| setPermissionsPassword(String value) | Sets the password required to change permission settings. |
| getPermissions() | Gets the PDF document permissions such as printing, modification, and data extraction. |
| setPermissions(int value) | Sets the PDF document permissions such as printing, modification, and data extraction. |
##### Security()
```
public Security()
```

Initializes a new instance of the  Security  class.

##### getDocumentOpenPassword()
```
public final String getDocumentOpenPassword()
```

Gets the password required to open the PDF document.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
java.lang.String - the document open password.
##### setDocumentOpenPassword(String value)
```
public final void setDocumentOpenPassword(String value)
```

Sets the password required to open the PDF document.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document open password. |

##### getPermissionsPassword()
```
public final String getPermissionsPassword()
```

Gets the password required to change permission settings.

Using a permissions password, you can restrict printing, modification, and data extraction. Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
java.lang.String - the permissions password.
##### setPermissionsPassword(String value)
```
public final void setPermissionsPassword(String value)
```

Sets the password required to change permission settings.

Using a permissions password, you can restrict printing, modification, and data extraction. Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The permissions password. |

##### getPermissions()
```
public final int getPermissions()
```

Gets the PDF document permissions such as printing, modification, and data extraction.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
int - the PDF document permissions.
##### setPermissions(int value)
```
public final void setPermissions(int value)
```

Sets the PDF document permissions such as printing, modification, and data extraction.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The PDF document permissions. |

### Size
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/size.md

**Inheritance:**
java.lang.Object
```
public class Size
```

Contains the watermark size.

The Size class represents the size of a watermark in the GroupDocs.Viewer component. It provides options to specify the dimensions of the watermark, such as width and height.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Size(byte relativeSize) | Initializes a new instance of the  Size  class. |
#### Fields

| Field | Description |
| --- | --- |
| FULL_SIZE | Represents the maximum size of watermark text that fits the page. |
| HALF_SIZE | Represents half of the maximum size of watermark text that fits the page. |
| ONE_THIRD | Represents one third of the maximum size of watermark text that fits the page. |
#### Methods

| Method | Description |
| --- | --- |
| getRelativeSize() | Returns the watermark text size in percentages in relation to the page width. |
##### Size(byte relativeSize)
```
public Size(byte relativeSize)
```

Initializes a new instance of the  Size  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relativeSize | byte | The size in percentages in relation to the page size. |

##### FULL_SIZE
```
public static final Size FULL_SIZE
```

Represents the maximum size of watermark text that fits the page.

##### HALF_SIZE
```
public static final Size HALF_SIZE
```

Represents half of the maximum size of watermark text that fits the page.

##### ONE_THIRD
```
public static final Size ONE_THIRD
```

Represents one third of the maximum size of watermark text that fits the page.

##### getRelativeSize()
```
public final byte getRelativeSize()
```

Returns the watermark text size in percentages in relation to the page width.

**Returns:**
byte - the watermark text size in percentages.

### SpreadsheetOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/spreadsheetoptions.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetOptions
```

Provides options for rendering spreadsheets.

The SpreadsheetOptions class encapsulates various settings and parameters that can be used to control the rendering of spreadsheet files (such as Excel or CSV files) in the GroupDocs.Viewer component. For details, see children of the [Render spreadsheet files][] topic.

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 SpreadsheetOptions spreadsheetOptions = pngViewOptions.getSpreadsheetOptions();
 spreadsheetOptions.setRenderHeadings(true);
 spreadsheetOptions.setCountColumnsPerPage(24);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[Render spreadsheet files]: https://docs.groupdocs.com/viewer/java/render-spreadsheets/
#### Methods

| Method | Description |
| --- | --- |
| isRenderByPageBreaks() | Determines whether the worksheet should be rendered by page breaks. |
| setRenderByPageBreaks(boolean renderByPageBreaks) | Sets whether the worksheet should be rendered by page breaks. |
| isDetectSeparator() | Detects the separator for CSV/TSV files. |
| setDetectSeparator(boolean detectSeparator) | Sets whether to detect the separator for CSV/TSV files. |
| forOnePagePerSheet() | Creates a new instance of  SpreadsheetOptions  class for rendering one sheet into one page. |
| forSplitSheetIntoPages(int countRowsPerPage) | Creates a new instance of  SpreadsheetOptions  class for rendering a sheet into multiple pages. |
| forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage) | Initializes a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages. |
| forRenderingPrintArea() | Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. |
| isOnePagePerSheet() | Indicates whether one sheet is rendered into one page. |
| getCountRowsPerPage() | Gets the count of rows to include into each page when splitting the worksheet into pages. |
| getCountColumnsPerPage() | Gets the count of columns to include into each page when splitting the worksheet into pages. |
| setCountColumnsPerPage(int countColumnsPerPage) | Sets the count of columns to include into each page when splitting the worksheet into pages. |
| isRenderPrintAreaOnly() | Indicates whether only the print areas are rendered. |
| isRenderingPrintAreaAndPageBreaks() | When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area. |
| setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks) | Sets whether to render a worksheet by page breaks that fall within the print area. |
| isRenderGridLines() | Enables rendering of grid lines. |
| setRenderGridLines(boolean value) | Enables or disables the rendering of grid lines. |
| isSkipEmptyRows() | Indicates whether empty rows should be skipped during rendering. |
| setSkipEmptyRows(boolean value) | Sets whether empty rows should be skipped during rendering. |
| isSkipEmptyColumns() | Indicates whether empty columns should be skipped during rendering. |
| setSkipEmptyColumns(boolean value) | Sets whether empty columns should be skipped during rendering. |
| isRenderHiddenRows() | Determines whether hidden rows should be rendered. |
| setRenderHiddenRows(boolean value) | Sets whether hidden rows should be rendered. |
| isRenderHeadings() | Checks if headings rendering is enabled. |
| setRenderHeadings(boolean renderHeadings) | Enables headings rendering. |
| isRenderHiddenColumns() | Enables hidden columns rendering. |
| setRenderHiddenColumns(boolean value) | Enables hidden columns rendering. |
| getTextOverflowMode() | Returns the text overflow mode for rendering spreadsheet documents into HTML. |
| setTextOverflowMode(TextOverflowMode value) | Sets the text overflow mode for rendering spreadsheet documents into HTML. |
| getLeftMargin() | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| setLeftMargin(double leftMargin) | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| getRightMargin() | To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setRightMargin(double rightMargin) | To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| getTopMargin() | To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setTopMargin(double topMargin) | To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| getBottomMargin() | To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setBottomMargin(double bottomMargin) | To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| getHorizontalResolution() | Gets or sets the horizontal resolution for generated images in dots per inch. |
| setHorizontalResolution(int horizontalResolution) | Sets the horizontal resolution for generated images in dots per inch. |
| getVerticalResolution() | Gets or sets the vertical resolution for generated images in dots per inch. |
| setVerticalResolution(int verticalResolution) | Sets the vertical resolution for generated images in dots per inch. |
| getValidHorizontalDpi() |  |
| getValidVerticalDpi() |  |
| forRenderingPrintAreaAndPageBreaks() | Initializes a new instance of  SpreadsheetOptions  for rendering print areas and page breaks. |
| forRenderingByPageBreaks() | Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. |
##### isRenderByPageBreaks()
```
public boolean isRenderByPageBreaks()
```

Determines whether the worksheet should be rendered by page breaks.

***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.*

**Returns:**
boolean -  true  if the worksheet should be rendered by page breaks,  false  otherwise.
##### setRenderByPageBreaks(boolean renderByPageBreaks)
```
public void setRenderByPageBreaks(boolean renderByPageBreaks)
```

Sets whether the worksheet should be rendered by page breaks.

***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderByPageBreaks | boolean |  true  if the worksheet should be rendered by page breaks,  false  otherwise. |

##### isDetectSeparator()
```
public boolean isDetectSeparator()
```

Detects the separator for CSV/TSV files.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator

**Returns:**
boolean -  true  if the separator should be automatically detected,  false  otherwise.
##### setDetectSeparator(boolean detectSeparator)
```
public void setDetectSeparator(boolean detectSeparator)
```

Sets whether to detect the separator for CSV/TSV files.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| detectSeparator | boolean |  true  to automatically detect the separator,  false  otherwise. |

##### forOnePagePerSheet()
```
public static SpreadsheetOptions forOnePagePerSheet()
```

Creates a new instance of  SpreadsheetOptions  class for rendering one sheet into one page.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-a-worksheet-on-one-page

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  class for rendering one sheet into one page.
##### forSplitSheetIntoPages(int countRowsPerPage)
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage)
```

Creates a new instance of  SpreadsheetOptions  class for rendering a sheet into multiple pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | int | The number of rows to include in each page. |

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  for rendering a sheet into pages.
##### forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | int | The number of rows to include on each page. |
| countColumnsPerPage | int | The number of columns to include on each page. |

**Returns:**
SpreadsheetOptions - a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages.
##### forRenderingPrintArea()
```
public static SpreadsheetOptions forRenderingPrintArea()
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-a-print-area

**Returns:**
SpreadsheetOptions - a new instance of the  SpreadsheetOptions  class for rendering print areas only.
##### isOnePagePerSheet()
```
public final boolean isOnePagePerSheet()
```

Indicates whether one sheet is rendered into one page.

**Returns:**
boolean -  true  if one sheet is rendered into one page;  false  otherwise.
##### getCountRowsPerPage()
```
public final int getCountRowsPerPage()
```

Gets the count of rows to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Returns:**
int - the count of rows to include into each page.
##### getCountColumnsPerPage()
```
public int getCountColumnsPerPage()
```

Gets the count of columns to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns

**Returns:**
int - the count of columns to include into each page.
##### setCountColumnsPerPage(int countColumnsPerPage)
```
public void setCountColumnsPerPage(int countColumnsPerPage)
```

Sets the count of columns to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countColumnsPerPage | int | The count of columns to include into each page. |

##### isRenderPrintAreaOnly()
```
public final boolean isRenderPrintAreaOnly()
```

Indicates whether only the print areas are rendered.

**Returns:**
boolean -  true  if only the print areas are rendered,  false  otherwise.
##### isRenderingPrintAreaAndPageBreaks()
```
public boolean isRenderingPrintAreaAndPageBreaks()
```

When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.

**Returns:**
boolean
##### setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
```
public void setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
```

Sets whether to render a worksheet by page breaks that fall within the print area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderingPrintAreaAndPageBreaks | boolean | Set to true to enable, false to disable. |

##### isRenderGridLines()
```
public final boolean isRenderGridLines()
```

Enables rendering of grid lines.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-worksheet-gridlines

**Returns:**
boolean -  true  if grid lines are enabled,  false  otherwise.
##### setRenderGridLines(boolean value)
```
public final void setRenderGridLines(boolean value)
```

Enables or disables the rendering of grid lines.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-worksheet-gridlines

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable grid lines rendering,  false  to disable it. |

##### isSkipEmptyRows()
```
public final boolean isSkipEmptyRows()
```

Indicates whether empty rows should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Returns:**
boolean -  true  if empty rows should be skipped,  false  otherwise.
##### setSkipEmptyRows(boolean value)
```
public final void setSkipEmptyRows(boolean value)
```

Sets whether empty rows should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to skip empty rows,  false  otherwise. |

##### isSkipEmptyColumns()
```
public final boolean isSkipEmptyColumns()
```

Indicates whether empty columns should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Returns:**
boolean -  true  if empty columns are skipped,  false  otherwise.
##### setSkipEmptyColumns(boolean value)
```
public final void setSkipEmptyColumns(boolean value)
```

Sets whether empty columns should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to skip empty columns,  false  otherwise. |

##### isRenderHiddenRows()
```
public final boolean isRenderHiddenRows()
```

Determines whether hidden rows should be rendered.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Returns:**
boolean -  true  if hidden rows should be rendered,  false  otherwise.
##### setRenderHiddenRows(boolean value)
```
public final void setRenderHiddenRows(boolean value)
```

Sets whether hidden rows should be rendered.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable rendering of hidden rows,  false  to disable it. |

##### isRenderHeadings()
```
public boolean isRenderHeadings()
```

Checks if headings rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-row-and-column-headings

**Returns:**
boolean -  true  if headings rendering is enabled,  false  otherwise.
##### setRenderHeadings(boolean renderHeadings)
```
public void setRenderHeadings(boolean renderHeadings)
```

Enables headings rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-row-and-column-headings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderHeadings | boolean |  true  to enable headings rendering,  false  to disable. |

##### isRenderHiddenColumns()
```
public final boolean isRenderHiddenColumns()
```

Enables hidden columns rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Returns:**
boolean -  true  if hidden columns rendering is enabled,  false  otherwise.
##### setRenderHiddenColumns(boolean value)
```
public final void setRenderHiddenColumns(boolean value)
```

Enables hidden columns rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable hidden columns rendering,  false  to disable. |

##### getTextOverflowMode()
```
public final TextOverflowMode getTextOverflowMode()
```

Returns the text overflow mode for rendering spreadsheet documents into HTML.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

**Returns:**
TextOverflowMode - the text overflow mode.
##### setTextOverflowMode(TextOverflowMode value)
```
public final void setTextOverflowMode(TextOverflowMode value)
```

Sets the text overflow mode for rendering spreadsheet documents into HTML. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TextOverflowMode | The text overflow mode to be set. |

##### getLeftMargin()
```
public double getLeftMargin()
```

To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used

If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setLeftMargin(double leftMargin)
```
public void setLeftMargin(double leftMargin)
```

To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used

If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftMargin | double |  |

##### getRightMargin()
```
public double getRightMargin()
```

To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setRightMargin(double rightMargin)
```
public void setRightMargin(double rightMargin)
```

To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rightMargin | double |  |

##### getTopMargin()
```
public double getTopMargin()
```

To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setTopMargin(double topMargin)
```
public void setTopMargin(double topMargin)
```

To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topMargin | double |  |

##### getBottomMargin()
```
public double getBottomMargin()
```

To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setBottomMargin(double bottomMargin)
```
public void setBottomMargin(double bottomMargin)
```

To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bottomMargin | double |  |

##### getHorizontalResolution()
```
public int getHorizontalResolution()
```

Gets or sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

**Returns:**
int - the horizontal resolution in DPI.
##### setHorizontalResolution(int horizontalResolution)
```
public void setHorizontalResolution(int horizontalResolution)
```

Sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| horizontalResolution | int | the horizontal resolution in DPI. |

##### getVerticalResolution()
```
public int getVerticalResolution()
```

Gets or sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

**Returns:**
int - the vertical resolution in DPI.
##### setVerticalResolution(int verticalResolution)
```
public void setVerticalResolution(int verticalResolution)
```

Sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If the user-specified value is out of these limits, the min or max possible value will be applied.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| verticalResolution | int | the vertical resolution in DPI. |

##### getValidHorizontalDpi()
```
public int getValidHorizontalDpi()
```

**Returns:**
int
##### getValidVerticalDpi()
```
public int getValidVerticalDpi()
```

**Returns:**
int
##### forRenderingPrintAreaAndPageBreaks()
```
public static SpreadsheetOptions forRenderingPrintAreaAndPageBreaks()
```

Initializes a new instance of  SpreadsheetOptions  for rendering print areas and page breaks. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-worksheet-by-page-breaks-and-print-area

**Returns:**
SpreadsheetOptions - New instance of  SpreadsheetOptions  for rendering pages based on page breaks that are included into print area. The behavior is similar to printing in Excel.
##### forRenderingByPageBreaks()
```
public static SpreadsheetOptions forRenderingByPageBreaks()
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  for rendering print areas only. The behavior is similar to printing in Excel, where the worksheet is rendered by page breaks.

### TextOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/textoptions.md

**Inheritance:**
java.lang.Object
```
public class TextOptions
```

Text files splitting to pages options.

The TextOptions class provides options for splitting text files into pages in the GroupDocs.Viewer component. It allows you to control how text files are divided into individual pages for rendering and viewing purposes.

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 TextOptions options = pngViewOptions.getTextOptions();
 options.setMaxCharsPerRow(96);
 options.setMaxRowsPerPage(48);

 try (Viewer viewer = new Viewer("document.txt")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| TextOptions() | Initializes a new instance of the  TextOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxCharsPerRow() | Gets the maximum number of characters per row on a page. |
| setMaxCharsPerRow(int maxCharsPerRow) | Sets the maximum number of characters per row on a page. |
| getMaxRowsPerPage() | Gets the maximum number of rows per page. |
| setMaxRowsPerPage(int maxRowsPerPage) | Sets the maximum number of rows per page. |
##### TextOptions()
```
public TextOptions()
```

Initializes a new instance of the  TextOptions  class.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

##### getMaxCharsPerRow()
```
public int getMaxCharsPerRow()
```

Gets the maximum number of characters per row on a page.

***Note:** The default value is 85.* The default value is 85. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Returns:**
int - the maximum number of characters per row on a page.
##### setMaxCharsPerRow(int maxCharsPerRow)
```
public void setMaxCharsPerRow(int maxCharsPerRow)
```

Sets the maximum number of characters per row on a page.

***Note:** The default value is 85.* The default value is 85. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxCharsPerRow | int | The maximum number of characters per row on a page. |

##### getMaxRowsPerPage()
```
public int getMaxRowsPerPage()
```

Gets the maximum number of rows per page.

***Note:** The default value is 55.* The default value is 55. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Returns:**
int - the maximum number of rows.
##### setMaxRowsPerPage(int maxRowsPerPage)
```
public void setMaxRowsPerPage(int maxRowsPerPage)
```

Sets the maximum number of rows per page.

***Note:** The default value is 55.* The default value is 55. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxRowsPerPage | int | The maximum number of rows. |

### TextOverflowMode
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/textoverflowmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum TextOverflowMode extends Enum<TextOverflowMode>
```

Defines text overflow mode for rendering spreadsheet documents into HTML.

The TextOverflowMode enum represents different modes for handling text overflow in the GroupDocs.Viewer component. It provides a set of predefined options that can be used to control how text is displayed when it exceeds the available space in cells during the rendering of spreadsheet documents into HTML. For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();

 htmlViewOptions.setSpreadsheetOptions(SpreadsheetOptions.forOnePagePerSheet());
 htmlViewOptions.getSpreadsheetOptions().setTextOverflowMode(TextOverflowMode.HIDE_TEXT);

 try (Viewer viewer = new Viewer("document.xlsx")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow
#### Fields

| Field | Description |
| --- | --- |
| OVERLAY | Overlay next cells even if they are not empty. |
| OVERLAY_IF_NEXT_IS_EMPTY | Overlay next cells only if they are empty. |
| AUTO_FIT_COLUMN | Expand columns to fit the text. |
| HIDE_TEXT | Hide the overflow text. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### OVERLAY
```
public static final TextOverflowMode OVERLAY
```

Overlay next cells even if they are not empty. This mode allows the text to overflow into the adjacent cells, regardless of their content.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### OVERLAY_IF_NEXT_IS_EMPTY
```
public static final TextOverflowMode OVERLAY_IF_NEXT_IS_EMPTY
```

Overlay next cells only if they are empty. This mode allows the text to overflow into the adjacent cells only if those cells are empty.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### AUTO_FIT_COLUMN
```
public static final TextOverflowMode AUTO_FIT_COLUMN
```

Expand columns to fit the text. This mode automatically adjusts the width of the columns to accommodate the overflowing text.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### HIDE_TEXT
```
public static final TextOverflowMode HIDE_TEXT
```

Hide the overflow text. This mode hides the overflowing text, preventing it from being displayed.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### values()
```
public static TextOverflowMode[] values()
```

**Returns:**
com.groupdocs.viewer.options.TextOverflowMode[]
##### valueOf(String name)
```
public static TextOverflowMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TextOverflowMode

### Tile
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/tile.md

**Inheritance:**
java.lang.Object
```
public class Tile
```

Represents drawing region.

The Tile class represents a drawing region in the GroupDocs.Viewer component. It is used to define a specific area or region within a document that needs to be rendered or processed separately. For details, see the [documentation][].

Example usage:

```

 Tile tile = new Tile(100, 100, 200, 200);

 PngViewOptions pngViewOptions = new PngViewOptions();
 pngViewOptions.getCadOptions().setTiles(Arrays.asList(tile));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles
#### Constructors

| Constructor | Description |
| --- | --- |
| Tile(int startPointX, int startPointY, int width, int height) | Initializes a new instance of the  Tile  class. |
#### Methods

| Method | Description |
| --- | --- |
| getStartPointX() | Gets the X coordinate of the lowest left point on the drawing where the tile begins. |
| getStartPointY() | Gets the Y coordinate of the lowest left point on the drawing where the tile begins. |
| getWidth() | Gets the width of the tile in pixels. |
| getHeight() | Gets the height of the tile in pixels. |
| getEndPointX() | Returns the X coordinate of the highest right point on the drawing where the tile ends. |
| getEndPointY() | Returns the Y coordinate of the highest right point on the drawing where the tile ends. |
##### Tile(int startPointX, int startPointY, int width, int height)
```
public Tile(int startPointX, int startPointY, int width, int height)
```

Initializes a new instance of the  Tile  class.

This constructor creates a new tile object with the specified starting point, width, and height. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startPointX | int | The X coordinate of the lowest left point on the drawing where the tile begins. |
| startPointY | int | The Y coordinate of the lowest left point on the drawing where the tile begins. |
| width | int | The width of the tile in pixels. |
| height | int | The height of the tile in pixels. |

##### getStartPointX()
```
public final int getStartPointX()
```

Gets the X coordinate of the lowest left point on the drawing where the tile begins.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the X coordinate of the lowest left point.
##### getStartPointY()
```
public final int getStartPointY()
```

Gets the Y coordinate of the lowest left point on the drawing where the tile begins.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the Y coordinate of the lowest left point.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the tile in pixels.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the width of the tile.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the tile in pixels.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the height of the tile.
##### getEndPointX()
```
public final int getEndPointX()
```

Returns the X coordinate of the highest right point on the drawing where the tile ends.

**Returns:**
int - the X coordinate of the highest right point.
##### getEndPointY()
```
public final int getEndPointY()
```

Returns the Y coordinate of the highest right point on the drawing where the tile ends.

**Returns:**
int - the Y coordinate of the highest right point.

### TimeUnit
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/timeunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum TimeUnit extends Enum<TimeUnit>
```

Time unit of the project duration.

The TimeUnit enum represents different time units for specifying the duration of a project in the GroupDocs.Viewer component. It provides a set of predefined time units that can be used to represent and calculate the duration of a project, such as days, months and so on. For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions pdfViewOptions = HtmlViewOptions.forEmbeddedResources();
 ProjectManagementOptions projectManagementOptions = pdfViewOptions.getProjectManagementOptions();
 projectManagementOptions.setTimeUnit(TimeUnit.MONTHS);

 try (Viewer viewer = new Viewer("document.mpp")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit
#### Fields

| Field | Description |
| --- | --- |
| UNSPECIFIED | The unknown time scale. |
| DAYS | Days time scale. |
| THIRDS_OF_MONTHS | Thirds of months time scale. |
| MONTHS | Months time scale. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### UNSPECIFIED
```
public static final TimeUnit UNSPECIFIED
```

The unknown time scale. This time unit represents an unknown or unspecified time scale.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### DAYS
```
public static final TimeUnit DAYS
```

Days time scale. This time unit represents a one-day interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### THIRDS_OF_MONTHS
```
public static final TimeUnit THIRDS_OF_MONTHS
```

Thirds of months time scale. This time unit represents a one-third of the month interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### MONTHS
```
public static final TimeUnit MONTHS
```

Months time scale. This time unit represents a one-month interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### values()
```
public static TimeUnit[] values()
```

**Returns:**
com.groupdocs.viewer.options.TimeUnit[]
##### valueOf(String name)
```
public static TimeUnit valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TimeUnit

### ViewInfoOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/viewinfooptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class ViewInfoOptions extends BaseViewOptions implements IMaxSizeOptions
```

Provides options used for retrieving information about view.

The ViewInfoOptions class encapsulates additional settings and parameters that can be used to retrieve information about a view in the GroupDocs.Viewer component.

Example usage:

```

 ViewInfoOptions viewInfoOptions = ViewInfoOptions.forPngView(false);
 try (Viewer viewer = new Viewer("document.pdf")) {
     ViewInfo viewInfo = viewer.getViewInfo(viewInfoOptions);
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The ViewInfoOptions class implements the IMaxSizeOptions interface to provide additional settings and size constraints for view information retrieval.*
#### Methods

| Method | Description |
| --- | --- |
| isExtractText() | Indicates whether text extraction is enabled. |
| setExtractText(boolean extractText) | Sets the flag indicating whether text extraction is enabled. |
| getMaxWidth() | Returns the maximum width of the output image for rendering to PNG/JPG. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only). |
| getMaxHeight() | Returns the maximum height of the output image for rendering to PNG/JPG. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only). |
| getWidth() | The width of the output image (in pixels, for rendering to PNG/JPG only). |
| setWidth(int width) | The width of the output image (in pixels, for rendering to PNG/JPG only). |
| getHeight() | The height of the output image (in pixels, for rendering to PNG/JPG only). |
| setHeight(int height) | The height of the output image (in pixels, for rendering to PNG/JPG only). |
| forHtmlView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML. |
| forHtmlView(boolean renderSinglePage) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML. |
| forJpgView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG. |
| forJpgView(boolean extractText) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG. |
| forPngView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG. |
| forPngView(boolean extractText) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG. |
| forPdfView() | Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF. |
| fromHtmlViewOptions(HtmlViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the HtmlViewOptions object. |
| fromPngViewOptions(PngViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the PngViewOptions object. |
| fromJpgViewOptions(JpgViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the JpgViewOptions object. |
| fromPdfViewOptions(PdfViewOptions options) | Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object. |
##### isExtractText()
```
public boolean isExtractText()
```

Indicates whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/

**Returns:**
boolean - True if text extraction is enabled, false otherwise.
##### setExtractText(boolean extractText)
```
public void setExtractText(boolean extractText)
```

Sets the flag indicating whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | True to enable text extraction, false to disable. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Returns the maximum width of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of the output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of the output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Returns the maximum height of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of the output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of the output image. |

##### getWidth()
```
public int getWidth()
```

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Returns:**
int - the width of the image.
##### setWidth(int width)
```
public void setWidth(int width)
```

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the image. |

##### getHeight()
```
public int getHeight()
```

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Returns:**
int - the height of the image.
##### setHeight(int height)
```
public void setHeight(int height)
```

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | The height of the image. |

##### forHtmlView()
```
public static ViewInfoOptions forHtmlView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML.

**Returns:**
ViewInfoOptions - New instance of the  ViewInfoOptions  class.
##### forHtmlView(boolean renderSinglePage)
```
public static ViewInfoOptions forHtmlView(boolean renderSinglePage)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML.

***Note:** By default, HTML content will be rendered on multiple pages.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | boolean | Enables HTML content to be rendered on a single page. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forJpgView()
```
public static ViewInfoOptions forJpgView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG.

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forJpgView(boolean extractText)
```
public static ViewInfoOptions forJpgView(boolean extractText)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | Enables text extraction. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPngView()
```
public static ViewInfoOptions forPngView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG.

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPngView(boolean extractText)
```
public static ViewInfoOptions forPngView(boolean extractText)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | Enables text extraction. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPdfView()
```
public static ViewInfoOptions forPdfView()
```

Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF.

**Returns:**
ViewInfoOptions - A new instance of the ViewInfoOptions class.
##### fromHtmlViewOptions(HtmlViewOptions options)
```
public static ViewInfoOptions fromHtmlViewOptions(HtmlViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the HtmlViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | HtmlViewOptions | The HTML view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromPngViewOptions(PngViewOptions options)
```
public static ViewInfoOptions fromPngViewOptions(PngViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the PngViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PngViewOptions | The PNG view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromJpgViewOptions(JpgViewOptions options)
```
public static ViewInfoOptions fromJpgViewOptions(JpgViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the JpgViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | JpgViewOptions | The JPG view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromPdfViewOptions(PdfViewOptions options)
```
public static ViewInfoOptions fromPdfViewOptions(PdfViewOptions options)
```

Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PdfViewOptions | The PDF view options. |

**Returns:**
ViewInfoOptions - A new instance of the ViewInfoOptions class.

### ViewOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/viewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions
```
public abstract class ViewOptions extends BaseViewOptions
```

Contains the rendering options.

The ViewOptions class extends the BaseViewOptions class and serves as a base class for rendering options in the GroupDocs.Viewer component. It encapsulates common settings and parameters that can be used for rendering various types of documents into different formats.

***Note:** The ViewOptions class should not be used directly, use HtmlViewOptions, PdfViewOptions, PngViewOptions and so on instead.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWatermark() | Gets the text watermark applied to each page. |
| setWatermark(Watermark value) | Sets the text watermark to be applied to each page. |
| rotatePage(int pageNumber, Rotation rotation) | Applies a clockwise rotation to the specified page. |
| getPageRotations() | Retrieves the page rotations. |
| isPageRotationsInitialized_Internal() | To prevent creating the instance just to check that it is empty |
##### ViewOptions()
```
public ViewOptions()
```

##### getWatermark()
```
public final Watermark getWatermark()
```

Gets the text watermark applied to each page.

In case both \#setWatermark(Watermark).setWatermark(Watermark) and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/add-text-watermark/

**Returns:**
Watermark - the text watermark applied to each page.
##### setWatermark(Watermark value)
```
public final void setWatermark(Watermark value)
```

Sets the text watermark to be applied to each page.

In case both  ViewOptions.Watermark  and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/add-text-watermark/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Watermark | The text watermark to be set. |

##### rotatePage(int pageNumber, Rotation rotation)
```
public final void rotatePage(int pageNumber, Rotation rotation)
```

Applies a clockwise rotation to the specified page.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/flip-or-rotate-pages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The page number, must be strictly greater than 0. |
| rotation | Rotation | The rotation value. |

##### getPageRotations()
```
public Map<Integer,Rotation> getPageRotations()
```

Retrieves the page rotations.

If both setWatermark(Watermark) and  getPageRotations()  are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/flip-or-rotate-pages/

**Returns:**
java.util.Map<java.lang.Integer,com.groupdocs.viewer.options.Rotation> - a map containing the page numbers as keys and their corresponding rotations as values.
##### isPageRotationsInitialized_Internal()
```
public boolean isPageRotationsInitialized_Internal()
```

To prevent creating the instance just to check that it is empty

**Returns:**
boolean

### VisioRenderingOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/visiorenderingoptions.md

**Inheritance:**
java.lang.Object
```
public class VisioRenderingOptions
```

Contains options for rendering Visio documents.

The VisioRenderingOptions class provides options for processing and rendering Visio files in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for Visio documents. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 VisioRenderingOptions visioRenderingOptions = pngViewOptions.getVisioRenderingOptions();
 visioRenderingOptions.setRenderFiguresOnly(true);

 try (Viewer viewer = new Viewer(visioDocument)) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| VisioRenderingOptions() | Initializes a new instance of the  VisioRenderingOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| isRenderFiguresOnly() | Render only Visio figures, excluding the diagram. |
| setRenderFiguresOnly(boolean renderFiguresOnly) | Sets the flag to render only Visio figures, excluding the diagram. |
| getFigureWidth() | Retrieves the width of the figure. |
| setFigureWidth(int figureWidth) | Sets the width of the figure. |
##### VisioRenderingOptions()
```
public VisioRenderingOptions()
```

Initializes a new instance of the  VisioRenderingOptions  class.

##### isRenderFiguresOnly()
```
public boolean isRenderFiguresOnly()
```

Render only Visio figures, excluding the diagram.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/#render-only-diagram-shapes

**Returns:**
boolean -  true  if only Visio figures should be rendered,  false  otherwise.
##### setRenderFiguresOnly(boolean renderFiguresOnly)
```
public void setRenderFiguresOnly(boolean renderFiguresOnly)
```

Sets the flag to render only Visio figures, excluding the diagram.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/#render-only-diagram-shapes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderFiguresOnly | boolean |  true  to render only Visio figures,  false  to include the diagram. |

##### getFigureWidth()
```
public int getFigureWidth()
```

Retrieves the width of the figure. The height will be calculated automatically.

**Returns:**
int - the width of the figure.
##### setFigureWidth(int figureWidth)
```
public void setFigureWidth(int figureWidth)
```

Sets the width of the figure. The height will be calculated automatically.

***Note:** Default value is 100.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| figureWidth | int | The width of the figure. |

### Watermark
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/watermark.md

**Inheritance:**
java.lang.Object
```
public class Watermark
```

Represents a text watermark. For details, see the [documentation][].

The Watermark class represents a text watermark in the GroupDocs.Viewer component. It is used to define and apply a watermark to the rendered output of documents.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/add-text-watermark/
#### Constructors

| Constructor | Description |
| --- | --- |
| Watermark(String text) | Initializes a new instance of the  Watermark  class. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Returns the watermark text. |
| getColor() | Returns the watermark color. |
| getColorAsHex() | Returns the watermark color in hex format. |
| setColor(Color value) | Sets the watermark color. |
| setColor(String colorName) | Sets the watermark color. |
| getPosition() | Returns the watermark position. |
| setPosition(Position value) | Sets the watermark position. |
| getSize() | Returns the watermark size. |
| setSize(Size value) | Sets the watermark size. |
| getFontName() | Returns the font name used for the watermark. |
| setFontName(String value) | Sets the font name used for the watermark. |
##### Watermark(String text)
```
public Watermark(String text)
```

Initializes a new instance of the  Watermark  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The watermark text. |

##### getText()
```
public final String getText()
```

Returns the watermark text. This method retrieves the text of the watermark applied to the document.

**Returns:**
java.lang.String - the watermark text.
##### getColor()
```
public final Color getColor()
```

Returns the watermark color. This method retrieves the color of the watermark applied to the document.

***Note:** The default value is the red color obtained from Color\#getRed().getRed().*

**Returns:**
java.awt.Color - the watermark color.
##### getColorAsHex()
```
public final String getColorAsHex()
```

Returns the watermark color in hex format. This method retrieves the color of the watermark applied to the document.

***Note:** The default value is the red color obtained from Color\#getRed().getRed().*

**Returns:**
java.lang.String - the watermark color in hex format.
##### setColor(Color value)
```
public final void setColor(Color value)
```

Sets the watermark color. This method sets the color of the watermark applied to the document.

***Note:** The default value is obtained from Color\#getRed().getRed().*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The watermark color to set. |

##### setColor(String colorName)
```
public final void setColor(String colorName)
```

Sets the watermark color. This method sets the color of the watermark applied to the document.

***Note:** The default value is obtained from Color\#getRed().getRed().*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String | The watermark color to set. |

##### getPosition()
```
public final Position getPosition()
```

Returns the watermark position. This method returns the position of the watermark applied to the document.

***Note:** The default value is Position.DIAGONAL.*

**Returns:**
Position - the watermark position.
##### setPosition(Position value)
```
public final void setPosition(Position value)
```

Sets the watermark position. This method sets the position of the watermark applied to the document.

***Note:** The default value is Position.DIAGONAL.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Position | The watermark position. |

##### getSize()
```
public final Size getSize()
```

Returns the watermark size. This method retrieves the size of the watermark applied to the document.

***Note:** The default value is Size.FULL\_SIZE.*

**Returns:**
Size - the watermark size.
##### setSize(Size value)
```
public final void setSize(Size value)
```

Sets the watermark size. This method sets the size of the watermark to be applied to the document.

***Note:** The default value is Size.FULL\_SIZE.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Size | The watermark size. |

##### getFontName()
```
public final String getFontName()
```

Returns the font name used for the watermark.

**Returns:**
java.lang.String - the font name used for the watermark.
##### setFontName(String value)
```
public final void setFontName(String value)
```

Sets the font name used for the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font name used for the watermark. |

### WordProcessingOptions
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.options/wordprocessingoptions.md

**Inheritance:**
java.lang.Object
```
public class WordProcessingOptions
```

Provides options for rendering word processing documents.

The WordProcessingOptions class provides options for rendering word processing documents in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for word processing files. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 WordProcessingOptions wordProcessingOptions = pngViewOptions.getWordProcessingOptions();
 wordProcessingOptions.setRenderTrackedChanges(true);
 wordProcessingOptions.setLeftMargin(32f);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingOptions() | Initializes a new instance of the  WordProcessingOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() | Retrieves the page size for rendering HTM and HTML files. |
| setPageSize(PageSize pageSize) | Sets the page size for rendering HTM and HTML files. |
| isRenderTrackedChanges() | Indicates whether tracked changes (revisions) rendering is enabled. |
| setRenderTrackedChanges(boolean value) | Sets whether tracked changes (revisions) rendering is enabled. |
| getLeftMargin() | Retrieves the left page margin for HTML rendering. |
| setLeftMargin(Double leftMargin) | Sets the left page margin for HTML rendering. |
| getRightMargin() | Gets the right page margin for HTML rendering. |
| setRightMargin(Double rightMargin) | Sets the right page margin for HTML rendering. |
| getTopMargin() | Retrieves the top page margin for HTML rendering. |
| setTopMargin(Double topMargin) | Sets the top page margin for HTML rendering. |
| getBottomMargin() | Bottom page margin (for HTML rendering only) |
| setBottomMargin(Double bottomMargin) | Sets the bottom page margin for HTML rendering. |
| isEnableOpenTypeFeatures() | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. |
| setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures) | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. |
| isUnlinkTableOfContents() | Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF. |
| setUnlinkTableOfContents(boolean unlinkTableOfContents) | Sets whether table of contents navigation should be disabled when rendering to HTML or PDF. |
| isUpdateFields() | Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. |
| setUpdateFields(boolean updateFields) | Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. |
| equals(Object o) | Check if the options are changed. |
| hashCode() | \{@inheritDoc\} |
##### WordProcessingOptions()
```
public WordProcessingOptions()
```

Initializes a new instance of the  WordProcessingOptions  class. Contains options for rendering word processing documents. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

##### getPageSize()
```
public PageSize getPageSize()
```

Retrieves the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

***Note:** The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.*

**Returns:**
PageSize - The size of the output page.
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Sets the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

***Note:** The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize | The size of the output page. |

##### isRenderTrackedChanges()
```
public final boolean isRenderTrackedChanges()
```

Indicates whether tracked changes (revisions) rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

**Returns:**
boolean -  true  if tracked changes rendering is enabled,  false  otherwise.
##### setRenderTrackedChanges(boolean value)
```
public final void setRenderTrackedChanges(boolean value)
```

Sets whether tracked changes (revisions) rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable tracked changes rendering,  false  to disable it. |

##### getLeftMargin()
```
public Double getLeftMargin()
```

Retrieves the left page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the left page margin value.
##### setLeftMargin(Double leftMargin)
```
public void setLeftMargin(Double leftMargin)
```

Sets the left page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftMargin | java.lang.Double | The left page margin value to set. |

##### getRightMargin()
```
public Double getRightMargin()
```

Gets the right page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the right page margin value.
##### setRightMargin(Double rightMargin)
```
public void setRightMargin(Double rightMargin)
```

Sets the right page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rightMargin | java.lang.Double | The right page margin value to set. |

##### getTopMargin()
```
public Double getTopMargin()
```

Retrieves the top page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the top page margin.
##### setTopMargin(Double topMargin)
```
public void setTopMargin(Double topMargin)
```

Sets the top page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topMargin | java.lang.Double | The top page margin to set. |

##### getBottomMargin()
```
public Double getBottomMargin()
```

Bottom page margin (for HTML rendering only)

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the bottom page margin.
##### setBottomMargin(Double bottomMargin)
```
public void setBottomMargin(Double bottomMargin)
```

Sets the bottom page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bottomMargin | java.lang.Double | The bottom page margin to set. |

##### isEnableOpenTypeFeatures()
```
public boolean isEnableOpenTypeFeatures()
```

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

**Returns:**
boolean - True if OpenType features are enabled, false otherwise.
##### setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)
```
public void setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)
```

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enableOpenTypeFeatures | boolean | True to enable OpenType features, false otherwise. |

##### isUnlinkTableOfContents()
```
public boolean isUnlinkTableOfContents()
```

Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

**Returns:**
boolean - True if table of content navigation is disabled; otherwise, false.
##### setUnlinkTableOfContents(boolean unlinkTableOfContents)
```
public void setUnlinkTableOfContents(boolean unlinkTableOfContents)
```

Sets whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unlinkTableOfContents | boolean | Indicates whether table of content navigation should be disabled. |

##### isUpdateFields()
```
public boolean isUpdateFields()
```

Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true \\u2014 fields will be updated before saving.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#disable-updating-fields-when-saving

**Returns:**
boolean
##### setUpdateFields(boolean updateFields)
```
public void setUpdateFields(boolean updateFields)
```

Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true \\u2014 fields will be updated before saving.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#disable-updating-fields-when-saving

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateFields | boolean |  |

##### equals(Object o)
```
public boolean equals(Object o)
```

Check if the options are changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare for equality. |

**Returns:**
boolean -  true  if the options are equal to the specified object,  false  otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.

### com.groupdocs.viewer.results
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results.md

The package provides classes and interfaces that represent document rendering results.

These classes encapsulate information about various elements and components of the rendered document, such as pages, attachments, views, resources, and more.

The main classes in this package are:

 *  Page - Represents a single page that can be viewed.
 *  Attachment - Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file.
 *  PdfViewInfo - Represents view information for a PDF document.

For more details on working with document rendering results using GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| Resource | Represents HTML resource such as font, style, image or graphics. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ArchiveViewInfo | Represents view information for an archive file. |
| Attachment | Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file. |
| CadViewInfo | Represents view information for a CAD drawing. |
| Character | Represents a relatively positioned rectangle that contains a single character. |
| FileInfo | Contains information about a file. |
| Layer | Represents a layer contained by a CAD drawing. |
| Layout | Represents a layout contained by a CAD drawing. |
| Line | Represents a relatively positioned rectangle that contains a single line. |
| LotusNotesViewInfo | Represents view information for Lotus Notes database storage. |
| OutlookViewInfo | Represents view information for an Outlook Data file. |
| Page | Represents a single page that can be viewed. |
| PdfViewInfo | Represents view information for a PDF document. |
| ProjectManagementViewInfo | Represents view information for an MS Project document. |
| TextElement<T> | Represents a generic text element. |
| ViewInfo | Represents view information for a generic document. |
| Word | Represents a relatively positioned rectangle that contains a single word. |

### ArchiveViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/archiveviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface ArchiveViewInfo extends ViewInfo
```

Represents view information for an archive file.

The ArchiveViewInfo interface defines the contract for retrieving view information specific to an archive file in the GroupDocs.Viewer component. It provides methods to access details such as page count, dimensions, and rendering options specific to archive files.

Example usage:

```

 try (Viewer viewer = new Viewer("document.zip")) {
     ArchiveViewInfo viewInfo = (ArchiveViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());

     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is ArchiveViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getFolders() | Retrieves the list of folders contained within the archive file. |
| setFolders(List<String> folders) | Sets the list of folders contained within the archive file. |
##### getFolders()
```
public abstract List<String> getFolders()
```

Retrieves the list of folders contained within the archive file.

**Returns:**
java.util.List<java.lang.String> - the list of folders.
##### setFolders(List<String> folders)
```
public abstract void setFolders(List<String> folders)
```

Sets the list of folders contained within the archive file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folders | java.util.List<java.lang.String> | the list of folders. |

### Attachment
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/attachment.md

### CadViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/cadviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface CadViewInfo extends ViewInfo
```

Represents view information for a CAD drawing.

The CadViewInfo interface defines the contract for retrieving view information specific to a CAD drawing in the GroupDocs.Viewer component. It provides methods to access to CAD drawings layers.

Example usage:

```

 try (Viewer viewer = new Viewer("document.plt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());

     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is CadViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getLayers() | Retrieves the list of layers in the CAD drawing. |
| setLayers(List<Layer> layers) | Sets the list of layers in the CAD drawing. |
| getLayouts() | Retrieves the list of layouts contained within the CAD drawing. |
| setLayouts(List<Layout> layouts) | Sets the list of layouts contained within the CAD drawing. |
##### getLayers()
```
public abstract List<Layer> getLayers()
```

Retrieves the list of layers in the CAD drawing.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layer> - the layers in the CAD drawing.
##### setLayers(List<Layer> layers)
```
public abstract void setLayers(List<Layer> layers)
```

Sets the list of layers in the CAD drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layers | java.util.List<com.groupdocs.viewer.results.Layer> | the layers to set for the CAD drawing. |

##### getLayouts()
```
public abstract List<Layout> getLayouts()
```

Retrieves the list of layouts contained within the CAD drawing.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layout> - the layouts in the CAD drawing.
##### setLayouts(List<Layout> layouts)
```
public abstract void setLayouts(List<Layout> layouts)
```

Sets the list of layouts contained within the CAD drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layouts | java.util.List<com.groupdocs.viewer.results.Layout> | the layouts to set for the CAD drawing. |

### Character
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/character.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Character extends TextElement<Character>, Serializable
```

Represents a relatively positioned rectangle that contains a single character.

The Character interface defines the contract for accessing and manipulating a character represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the character itself, position, and size of the rectangle.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List characters = viewInfo.getPages().get(0).getLines().get(0).getWords().get(0).getCharacters();
     Character character = characters.get(0);

     // Use the character object for further operations
 }
 
```

***Note:** The default implementation of this interface is CharacterImpl.*

### FileInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/fileinfo.md

### Layer
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/layer.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Layer extends Serializable
```

Represents a layer contained by a CAD drawing.

The Layer interface defines the contract for accessing and manipulating a layer within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layer name, visibility, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List layers = viewInfo.getLayers();
     for (Layer layer : layers) {
         // Use the layer object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LayerImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the layer. |
| setName(String name) | Sets the name of the layer. |
| isVisible() | Checks the visibility of the layer. |
| setVisible(boolean isVisible) | Sets the visibility of the layer. |
| equals(Object other) | Checks if this object is equal to the provided object. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the layer.

**Note:** Layer names are case sensitive.

**Returns:**
java.lang.String - the name of the layer.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The new name for the layer. |

##### isVisible()
```
public abstract boolean isVisible()
```

Checks the visibility of the layer.

The CAD drawing layers that are switched off or frozen are invisible. To render layers that are invisible, use the CadOptions.setLayers(List) option.

**Returns:**
boolean -  true  if the layer is visible,  false  otherwise.
##### setVisible(boolean isVisible)
```
public abstract void setVisible(boolean isVisible)
```

Sets the visibility of the layer.

If  true , the layer will be visible; if  false , it will be hidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isVisible | boolean | Whether the layer should be visible or not. |

##### equals(Object other)
```
public abstract boolean equals(Object other)
```

Checks if this object is equal to the provided object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | The object to compare. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.

### Layout
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/layout.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Layout extends Serializable
```

Represents a layout contained by a CAD drawing.

The Layout interface defines the contract for accessing and manipulating a layout within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layout name, dimensions, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List layouts = viewInfo.getLayouts();
     for (Layout layout : layouts) {
         // Use the layout object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LayoutImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the layout. |
| setName(String name) | Sets the name of the layout. |
| getWidth() | Retrieves the width of the layout. |
| setWidth(double width) | Sets the width of the layout. |
| getHeight() | Retrieves the height of the layout. |
| setHeight(double height) | Sets the height of the layout. |
| equals(Object other) | Checks if this object is equal to the provided object. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the layout.

**Returns:**
java.lang.String - the name of the layout.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name to set for the layout. |

##### getWidth()
```
public abstract double getWidth()
```

Retrieves the width of the layout.

**Returns:**
double - the width of the layout.
##### setWidth(double width)
```
public abstract void setWidth(double width)
```

Sets the width of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | double | The width to set for the layout. |

##### getHeight()
```
public abstract double getHeight()
```

Retrieves the height of the layout.

**Returns:**
double - the height of the layout.
##### setHeight(double height)
```
public abstract void setHeight(double height)
```

Sets the height of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | double | The height to set for the layout. |

##### equals(Object other)
```
public abstract boolean equals(Object other)
```

Checks if this object is equal to the provided object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | The object to compare. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.

### Line
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/line.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Line extends TextElement<String>, Serializable
```

Represents a relatively positioned rectangle that contains a single line.

The Line interface defines the contract for accessing and manipulating a line represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the line text, position, and size of the rectangle.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List lines = viewInfo.getPages().get(0).getLines();
     for (Line line : lines) {
         // Use the line object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LineImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getWords() | Retrieves the words contained in the line. |
| setWords(List<Word> wordList) | Sets the words contained in the line. |
##### getWords()
```
public abstract List<Word> getWords()
```

Retrieves the words contained in the line.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Word> - the words contained in the line.
##### setWords(List<Word> wordList)
```
public abstract void setWords(List<Word> wordList)
```

Sets the words contained in the line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordList | java.util.List<com.groupdocs.viewer.results.Word> | the words contained in the line. |

### LotusNotesViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/lotusnotesviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface LotusNotesViewInfo extends ViewInfo
```

Represents view information for Lotus Notes database storage.

The LotusNotesViewInfo interface defines the contract for accessing and manipulating view information for Lotus Notes database storage in the GroupDocs.Viewer component. It provides methods to retrieve information such as notes count, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.nsf")) {
     final LotusNotesViewInfo viewInfo = (LotusNotesViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is LotusNotesViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getNotesCount() | Retrieves the count of notes in the storage. |
| setNotesCount(int count) | Sets the count of notes in the storage. |
##### getNotesCount()
```
public abstract int getNotesCount()
```

Retrieves the count of notes in the storage.

**Returns:**
int - the count of notes in the storage.
##### setNotesCount(int count)
```
public abstract void setNotesCount(int count)
```

Sets the count of notes in the storage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| count | int | the count of notes in the storage. |

### OutlookViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/outlookviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface OutlookViewInfo extends ViewInfo
```

Represents view information for an Outlook Data file.

The OutlookViewInfo interface defines the contract for accessing and manipulating view information for an Outlook Data file in the GroupDocs.Viewer component. It provides methods to retrieve information such as a list of folders, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pst")) {
     final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is OutlookViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getFolders() | Retrieves the list of folders contained in the Outlook Data file. |
| setFolders(List<String> list) | Sets the list of folders contained in the Outlook Data file. |
##### getFolders()
```
public abstract List<String> getFolders()
```

Retrieves the list of folders contained in the Outlook Data file.

**Returns:**
java.util.List<java.lang.String> - the list of folders.
##### setFolders(List<String> list)
```
public abstract void setFolders(List<String> list)
```

Sets the list of folders contained in the Outlook Data file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| list | java.util.List<java.lang.String> | the list of folders. |

### Page
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/page.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Page extends Serializable
```

Represents a single page that can be viewed.

The Page interface defines the contract for accessing and manipulating a single page that can be viewed in the GroupDocs.Viewer component. It provides methods to retrieve information such as the page number, size, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pst")) {
     final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List pages = viewInfo.getPages();
     for (Page page : pages) {
         // Use the page object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is PageImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the worksheet or page. |
| setName(String name) | Sets the name of the worksheet or page. |
| getNumber() | Retrieves the page number. |
| setNumber(int number) | Sets the page number. |
| isVisible() | Retrieves the page visibility indicator. |
| setVisible(boolean visible) | Sets the page visibility indicator. |
| getWidth() | Retrieves the width of the page in pixels when viewing as JPG or PNG. |
| setWidth(int width) | Sets the width of the page in pixels when viewing as JPG or PNG. |
| getHeight() | Retrieves the height of the page in pixels when viewing as JPG or PNG. |
| setHeight(int height) | Sets the height of the page in pixels when viewing as JPG or PNG. |
| getLines() | Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. |
| setLines(List<Line> lines) | Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the worksheet or page.

**Returns:**
java.lang.String - the name of the worksheet or page.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the worksheet or page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | the name to set for the worksheet or page. |

##### getNumber()
```
public abstract int getNumber()
```

Retrieves the page number.

**Returns:**
int - the page number.
##### setNumber(int number)
```
public abstract void setNumber(int number)
```

Sets the page number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | the page number to set. |

##### isVisible()
```
public abstract boolean isVisible()
```

Retrieves the page visibility indicator.

**Returns:**
boolean - the page visibility indicator.
##### setVisible(boolean visible)
```
public abstract void setVisible(boolean visible)
```

Sets the page visibility indicator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visible | boolean | true if the page is visible, false otherwise. |

##### getWidth()
```
public abstract int getWidth()
```

Retrieves the width of the page in pixels when viewing as JPG or PNG.

**Returns:**
int - the width of the page.
##### setWidth(int width)
```
public abstract void setWidth(int width)
```

Sets the width of the page in pixels when viewing as JPG or PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | the width to set for the page. |

##### getHeight()
```
public abstract int getHeight()
```

Retrieves the height of the page in pixels when viewing as JPG or PNG.

**Returns:**
int - the height of the page.
##### setHeight(int height)
```
public abstract void setHeight(int height)
```

Sets the height of the page in pixels when viewing as JPG or PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | the height to set for the page. |

##### getLines()
```
public abstract List<Line> getLines()
```

Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Line> - the lines contained in the page.
##### setLines(List<Line> lines)
```
public abstract void setLines(List<Line> lines)
```

Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | the list of lines to set for the page. |

### PdfViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/pdfviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface PdfViewInfo extends ViewInfo
```

Represents view information for a PDF document.

The PdfViewInfo interface defines the contract for accessing and manipulating view information for a PDF document in the GroupDocs.Viewer component. It provides methods to retrieve information such as allowing printing, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     final PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is PdfViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| isPrintingAllowed() | Checks if printing of the document is allowed. |
| setPrintingAllowed(boolean allowPrinting) | Sets whether printing of the document is allowed. |
##### isPrintingAllowed()
```
public abstract boolean isPrintingAllowed()
```

Checks if printing of the document is allowed.

**Returns:**
boolean -  true  if printing is allowed,  false  otherwise.
##### setPrintingAllowed(boolean allowPrinting)
```
public abstract void setPrintingAllowed(boolean allowPrinting)
```

Sets whether printing of the document is allowed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allowPrinting | boolean |  true  to allow printing,  false  otherwise. |

### ProjectManagementViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/projectmanagementviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface ProjectManagementViewInfo extends ViewInfo
```

Represents view information for an MS Project document.

The ProjectManagementViewInfo interface defines the contract for accessing and manipulating view information for an MS Project document in the GroupDocs.Viewer component. It provides methods to retrieve information such as the start and end dates, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpp")) {
     final ProjectManagementViewInfo viewInfo = (ProjectManagementViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is ProjectManagementViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getStartDate() | Retrieves the date and time from which the project started. |
| setStartDate(Date startDate) | Sets the start date and time for the project. |
| getEndDate() | Retrieves the date and time when the project is to be completed. |
| setEndDate(Date endDate) | Sets the end date and time for the project. |
##### getStartDate()
```
public abstract Date getStartDate()
```

Retrieves the date and time from which the project started.

**Returns:**
java.util.Date - the start date and time of the project.
##### setStartDate(Date startDate)
```
public abstract void setStartDate(Date startDate)
```

Sets the start date and time for the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startDate | java.util.Date | the new start date and time to be set. |

##### getEndDate()
```
public abstract Date getEndDate()
```

Retrieves the date and time when the project is to be completed.

**Returns:**
java.util.Date - the end date and time of the project.
##### setEndDate(Date endDate)
```
public abstract void setEndDate(Date endDate)
```

Sets the end date and time for the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| endDate | java.util.Date | the new end date and time to be set. |

### Resource
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/resource.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Serializable
```
public class Resource implements Serializable
```

Represents HTML resource such as font, style, image or graphics.

The Resource class represents a resource used in HTML rendering in the GroupDocs.Viewer component. It can represent various types of resources, such as fonts, styles, images, or graphics, that are included or referenced in the generated HTML output during the rendering process.

Example usage:

```

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageNumber -> , new ReleaseResourceStream() {
     @Override
     public void invoke(int pageNumber, Resource resource, OutputStream resourceStream) {
         // Handle resource
     }
 });
 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Resource(String fileName, boolean nested) | Creates a new instance of the  Resource  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Returns the file name of the resource. |
| setFileName(String fileName) | Sets the file name of the resource. |
| isNested() | Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource. |
| setNested(boolean nested) | Sets whether the resource resides inside another resource. |
| toString() | Returns a string that represents the current object. |
##### Resource(String fileName, boolean nested)
```
public Resource(String fileName, boolean nested)
```

Creates a new instance of the  Resource  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The resource file name. |
| nested | boolean | Indicates whether the resource resides inside another resource, e.g., a font resource that resides in a CSS or SVG resource. |

##### getFileName()
```
public final String getFileName()
```

Returns the file name of the resource.

**Returns:**
java.lang.String - the file name of the resource.
##### setFileName(String fileName)
```
public void setFileName(String fileName)
```

Sets the file name of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The new file name for the resource. |

##### isNested()
```
public final boolean isNested()
```

Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource.

**Returns:**
boolean - Whether the resource resides inside another resource.
##### setNested(boolean nested)
```
public void setNested(boolean nested)
```

Sets whether the resource resides inside another resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nested | boolean | Whether the resource should be set as nested. |

##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - the string representation of the current object.

### TextElement
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/textelement.md

### ViewInfo
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/viewinfo.md

### Word
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.results/word.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Word extends TextElement<String>, Serializable
```

Represents a relatively positioned rectangle that contains a single word.

The Word interface represents a word within a relatively positioned rectangle in the GroupDocs.Viewer component. It extends the TextElement interface and provides additional methods to access and manipulate the word content.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List words = viewInfo.getPages().get(0).getLines().get(0).getWords();
     for (Word word : words) {
         // Use the word object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is WordImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getCharacters() | Retrieves the characters contained by the word. |
| setCharacters(List<Character> characters) | Sets the characters contained by the word. |
##### getCharacters()
```
public abstract List<Character> getCharacters()
```

Retrieves the characters contained by the word.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Character> - the list of characters.
##### setCharacters(List<Character> characters)
```
public abstract void setCharacters(List<Character> characters)
```

Sets the characters contained by the word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characters | java.util.List<com.groupdocs.viewer.results.Character> | the list of characters to set. |

### com.groupdocs.viewer.utils
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.utils.md

The package provides helper and utility classes for various functionalities.

These classes offer convenient methods and functionalities to assist in different operations.

The main classes in this package are:

 *  MemoryCleaner - Provides methods to clean up resources and free memory.
 *  PathUtils - Represents the type for working with paths.

For more details on using the utility classes in the com.groupdocs.viewer.utils package, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| MemoryCleaner | Cleans different resources to free memory. |
| PathUtils | The PathUtils class provides utility methods for working with file paths. |

### MemoryCleaner
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.utils/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.Viewer 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.Viewer 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.

### PathUtils
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.utils/pathutils.md

**Inheritance:**
java.lang.Object
```
public class PathUtils
```

The PathUtils class provides utility methods for working with file paths.

The PathUtils class contains static methods that allow you to perform various operations on file paths in the GroupDocs.Viewer component.

Example usage:

```

 String combinedPath = PathUtils.combine("part", "of", "path");
 String fileName = PathUtils.getFileName("/path/to/file.txt");
 
```
#### Methods

| Method | Description |
| --- | --- |
| combine(String[] params) | Combine paths parts using separator. |
| getFileName(String path) | Gets file name. |
##### combine(String[] params)
```
public static String combine(String[] params)
```

Combine paths parts using separator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| params | java.lang.String[] | the paths parts |

**Returns:**
java.lang.String - the result path
##### getFileName(String path)
```
public static String getFileName(String path)
```

Gets file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path |

**Returns:**
java.lang.String - the file name

### com.groupdocs.viewer
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer.md

The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results.

The main classes in this package are:

 *  License - Provides methods for licensing Viewer.
 *  Viewer - Represents the main class that controls the document rendering process.
 *  ViewerSettings - Defines settings for customizing the behavior of the Viewer.

For more details on working with the document rendering process using GroupDocs.Viewer for Java, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component and unlock its full functionality. |
| Metered | Provides methods for applying metered license to the GroupDocs.Viewer component. |
| Viewer | Represents the main class that controls the document rendering process. |
| ViewerSettings | Defines settings for customizing the behavior of the Viewer component. |

#### Enumerations

| Enum | Description |
| --- | --- |
| FileType | Represents the file type. |

### FileType
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/filetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable, com.groupdocs.viewer.caching.Cacheable
```
public enum FileType extends Enum<FileType> implements System.IEquatable<FileType>, Cacheable
```

Represents the file type. Provides methods to obtain a list of all file types supported by the GroupDocs.Viewer component.

The FileType enum provides constants representing different file types that are supported by the GroupDocs.Viewer component. You can use the methods in this enum to obtain a list of all supported file types or check if a specific file type is supported.

Example usage:

```

 // Try to detect file type using stream
 final FileType fileTypeFromStream = FileType.fromStream(new FileInputStream("document.pdf"));
 // Detect file type by extension
 final FileType fileTypeFromExtension = FileType.fromExtension(".png");
 // Iterate all supported file types
 for (FileType supportedFileType : FileType.getSupportedFileTypes()) {
     System.out.println("File type: " + supportedFileType);
 }
 final LoadOptions loadOptions = new LoadOptions(fileTypeFromExtension);
 // Usage of loadOptions
 
```
#### Fields

| Field | Description |
| --- | --- |
| UNKNOWN | Represents an unknown file type. |
| ZIP | Represents a zipped file (.zip) that can hold one or more files or directories. |
| TAR | Represents a consolidated Unix file archive (.tar) created for collecting one or more files. |
| XZ | Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. |
| TXZ | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. |
| TARXZ | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. |
| TGZ | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. |
| TARGZ | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. |
| BZ_2 | Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. |
| RAR | Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. |
| GZ | Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. |
| GZIP | Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. |
| SEVEN_ZIP | Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. |
| CPIO | Cpio is a general file archiver utility and its associated file format. |
| ZSTANDARD | ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm. |
| TZST | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| TAR_ZST | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| ISO | ISO optical disc image 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. |
| LHA | LHA or LZH is a freeware compression utility and associated file format. |
| CAB | Cabinet (or CAB) is an archive-file format for Microsoft Windows. |
| DXF | Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. |
| DWG | Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. |
| DWT | Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files. |
| STL | Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. |
| IFC | Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. |
| DWF | Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. |
| FBX | Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. |
| DWFX | Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. |
| DGN | Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. |
| PLT | Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. |
| CF2 | Represents a Common File Format File (.cf2). |
| OBJ | Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. |
| HPG | Represents a PLT (HPGL) File (.hpg). |
| IGS | Represents an Initial Graphics Exchange Specification (IGES) File (.igs). |
| VSD | Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. |
| VSDX | Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. |
| VSS | Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier. |
| VSSX | Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above. |
| VSDM | Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros. |
| VST | Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. |
| VSTX | Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. |
| VSTM | Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. |
| VSSM | Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. |
| VSX | Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. |
| VTX | Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. |
| VDW | Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing. |
| VDX | Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. |
| EPUB | Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. |
| MOBI | Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. |
| AZW_3 | Amazon Kindle Format 8 (KF8) ebook is the digital file format developed for Amazon Kindle devices. |
| MSG | Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. |
| EML | Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. |
| EMLX | Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. |
| PST | Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. |
| OST | Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. |
| TIF | Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| TIFF | Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| JPG | Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. |
| JPEG | Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. |
| JFIF | JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. |
| PNG | Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. |
| GIF | Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. |
| APNG | Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. |
| BMP | Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. |
| ICO | Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. |
| TGA | Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. |
| JP_2 | Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard. |
| JPF | Represents a JPEG 2000 Image File (.jpf). |
| JPX | Represents a JPEG 2000 Image File (.jpx). |
| JPM | Represents a JPEG 2000 Image File (.jpm). |
| J2C | Represents a JPEG 2000 Code InputStream (.j2c). |
| J2K | Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. |
| JPC | Represents a JPEG 2000 Code Stream (.jpc). |
| JLS | Represents a JPEG-LS (JLS) file (.jls). |
| DIB | Represents a Device Independent Bitmap File (.dib). |
| WMF | Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. |
| WMZ | Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. |
| EMF | Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. |
| EMZ | Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. |
| WEBP | Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. |
| DNG | Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. |
| CDR | Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. |
| CMX | Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. |
| DJVU | Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. |
| CGM | Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. |
| PCL | Represents a Printer Command Language Document (.pcl). |
| PSD | Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop's native file format used for graphics designing and development. |
| PSB | Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. |
| DCM | Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images. |
| PS | Represents a PostScript File (.ps). |
| EPS | Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. |
| ODG | Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| FODG | Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| SVG | Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image. |
| SVGZ | Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. |
| OTG | Represents an OpenDocument Graphic Template (.otg). |
| HTM | Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers. |
| HTML | Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers. |
| MHT | Represents an MHTML Web Archive (.mht). |
| NSF | Represents a Lotus Notes Database (.nsf). |
| MBOX | Represents an Email Mailbox File (.mbox). |
| MHTML | Represents a MIME HTML File (.mhtml). |
| XML | Represents an XML File (.xml). |
| ONE | Represents a OneNote Document (.one) created by Microsoft OneNote application. |
| PDF | Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. |
| XPS | Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. |
| OXPS | Represents an OpenXPS File (.oxps). |
| TEX | Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents. |
| PPT | Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow. |
| PPTX | Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. |
| PPS | Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. |
| PPSX | Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. |
| ODP | Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard. |
| FODP | Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. |
| POT | Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. |
| PPTM | Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. |
| POTX | Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. |
| POTM | Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. |
| PPSM | Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher. |
| OTP | Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. |
| XLS | Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format. |
| EXCEL_2003_XML | Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format. |
| NUMBERS | Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. |
| XLSX | Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| XLSM | Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. |
| XLSB | Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. |
| CSV | Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values. |
| TSV | Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. |
| ODS | Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. |
| FODS | Represents an OpenDocument Flat XML Spreadsheet (.fods). |
| OTS | Represents an OpenDocument Spreadsheet Template (.ots). |
| XLAM | Represents a Microsoft Excel Add-in (.xlam). |
| XLTM | Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. |
| XLT | Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. |
| XLTX | Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications. |
| SXC | Represents a StarOffice Calc Spreadsheet (.sxc). |
| MPP | Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner. |
| MPT | Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files. |
| MPX | Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring 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. |
| AS | Represents an ActionScript File (.as). |
| AS_3 | Represents an ActionScript File (.as3). |
| ASM | Represents an Assembly Language Source Code File (.asm). |
| BAT | Represents a DOS Batch File (.bat). |
| C | Represents a C/C++ Source Code File (.c). |
| CC | Represents a C++ Source Code File (.cc). |
| CMAKE | Represents a CMake File (.cmake). |
| CPP | Represents a C++ Source Code File (.cpp). |
| CS | Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. |
| VB | Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. |
| CSS | Represents a Cascading Style Sheet (.css) file. |
| CXX | Represents a C++ Source Code File (.cxx). |
| DIFF | Represents a Patch File (.diff). |
| ERB | Represents a Ruby ERB Script (.erb). |
| GROOVY | Represents a Groovy Source Code File (.groovy). |
| H | Represents a C/C++/Objective-C Header File (.h). |
| HAML | Represents a Haml Source Code File (.haml). |
| HH | Represents a C++ Header File (.hh). |
| JAVA | Represents a Java Source Code File (.java). |
| JS | Represents a JavaScript File (.js). |
| JSON | Represents a JavaScript Object Notation File (.json). |
| LESS | Represents a LESS Style Sheet (.less) file. |
| LOG | Represents a Log File (.log). |
| M | Represents an Objective-C Implementation File (.m). |
| MAKE | Represents an Xcode Makefile Script (.make). |
| MD | Represents a Markdown Documentation File (.md). |
| ML | Represents an ML Source Code File (.ml). |
| MM | Represents an Objective-C++ Source File (.mm). |
| PHP | Represents a PHP Source Code File (.php). |
| PL | Represents a Perl Script (.pl). |
| PROPERTIES | Represents a Java Properties File (.properties). |
| PY | Represents a Python Script (.py). |
| RB | Represents a Ruby Source Code (.rb) file. |
| RST | Represents a reStructuredText File (.rst). |
| SASS | Represents a Syntactically Awesome StyleSheets File (.sass). |
| SCALA | Represents a Scala Source Code File (.scala). |
| SCM | Represents a Scheme Source Code File (.scm). |
| SCRIPT | Represents a Generic Script File (.script). |
| SH | Represents a Bash Shell Script (.sh). |
| SML | Represents a Standard ML Source Code File (.sml). |
| SQL | Represents a Structured Query Language Data File (.sql). |
| VIM | Represents a Vim Settings File (.vim). |
| YAML | Represents a YAML Document (.yaml). |
| DOC | Represents a Microsoft Word Document (.doc) file. |
| DOCX | Represents a Microsoft Word Open XML Document (.docx) file. |
| CHM | Represents a Microsoft Compiled HTML Help File (.chm). |
| DOCM | Represents a Word Open XML Macro-Enabled Document (.docm) file. |
| DOT | Represents a Word Document Template (.dot) file. |
| DOTX | Represents a Word Open XML Document Template (.dotx) file. |
| DOTM | Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. |
| RTF | Represents a Rich Text Format File (.rtf). |
| TXT | Represents a Plain Text File (.txt). |
| ODT | Represents an OpenDocument Text Document (.odt). |
| OTT | Represents an OpenDocument Document Template (.ott). |
| VCF | Represents a vCard File (.vcf), which is a digital file format for storing contact information. |
| AI | Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. |
| PSM1 | Represents a PowerShell script module file (.psm1). |
| PS1 | Represents a PowerShell script file (.ps1). |
| PSD1 | Represents a PowerShell script module manifest file (.psd1). |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromExtension(String extension) | Maps a file extension to a file type. |
| fromFilePath(String filePath) | Extracts the file extension from a file name or file path and maps it to a file type. |
| fromMediaType(String mediaType) | Maps a file media type to a file type. |
| fromStream(InputStream stream) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, String password) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, ILogger logger) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, String password, ILogger logger) | Detects the file type by reading the file signature. |
| getSupportedFileTypes() | Retrieves the supported file types. |
| detectCharset(String filePath) | Attempts to detect text TXT, TSV, and CSV files charset by path. |
| detectCharset(InputStream stream) | Attempts to detect text TXT, TSV, and CSV file charset by stream. |
| getFileFormat() | Gets the name of the file format, e.g., "Microsoft Word Document". |
| getExtension() | Gets the file extension suffix (including the period "."), e.g., ".doc". |
| toString() | Returns a string representation of the current object. |
##### UNKNOWN
```
public static final FileType UNKNOWN
```

Represents an unknown file type.

##### ZIP
```
public static final FileType ZIP
```

Represents a zipped file (.zip) that can hold one or more files or directories. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/zip

##### TAR
```
public static final FileType TAR
```

Represents a consolidated Unix file archive (.tar) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/tar

##### XZ
```
public static final FileType XZ
```

Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/xz

##### TXZ
```
public static final FileType TXZ
```

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/txz

##### TARXZ
```
public static final FileType TARXZ
```

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/txz

##### TGZ
```
public static final FileType TGZ
```

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/tgz

##### TARGZ
```
public static final FileType TARGZ
```

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/tgz

##### BZ_2
```
public static final FileType BZ_2
```

Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/bz2

##### RAR
```
public static final FileType RAR
```

Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/rar

##### GZ
```
public static final FileType GZ
```

Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/gz

##### GZIP
```
public static final FileType GZIP
```

Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/gz

##### SEVEN_ZIP
```
public static final FileType SEVEN_ZIP
```

Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/7z/

##### CPIO
```
public static final FileType CPIO
```

Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/cpio

##### ZSTANDARD
```
public static final FileType ZSTANDARD
```

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. ZST files can be used to compress different types of files such as databases, file systems, networks, and games. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/zst/

##### TZST
```
public static final FileType TZST
```

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

##### TAR_ZST
```
public static final FileType TAR_ZST
```

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

##### ISO
```
public static final FileType ISO
```

ISO optical disc image 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. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/iso/

##### LHA
```
public static final FileType LHA
```

LHA or LZH is a freeware compression utility and associated file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/lzh/

##### CAB
```
public static final FileType CAB
```

Cabinet (or CAB) is an archive-file format for Microsoft Windows. Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Cabinet_%28file_format%29

##### DXF
```
public static final FileType DXF
```

Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dxf

##### DWG
```
public static final FileType DWG
```

Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwg

##### DWT
```
public static final FileType DWT
```

Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a 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

##### STL
```
public static final FileType STL
```

Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. It is commonly used in 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 FileType IFC
```

Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. It enables interoperability between different software applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/ifc

##### DWF
```
public static final FileType DWF
```

Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwf

##### FBX
```
public static final FileType FBX
```

Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/fbx

##### DWFX
```
public static final FileType DWFX
```

Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwfx

##### DGN
```
public static final FileType DGN
```

Represents a MicroStation Design File (.dgn), which are drawings created 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

##### PLT
```
public static final FileType PLT
```

Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. It contains information for a certain CAD file, and all images are printed using lines instead of dots, ensuring accuracy and precision in production. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/plt

##### CF2
```
public static final FileType CF2
```

Represents a Common File Format File (.cf2). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/cf2

##### OBJ
```
public static final FileType OBJ
```

Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/3d/obj/

##### HPG
```
public static final FileType HPG
```

Represents a PLT (HPGL) File (.hpg). It is a file format used for plotter files in the HP Graphics Language (HPGL). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/hpg

##### IGS
```
public static final FileType IGS
```

Represents an Initial Graphics Exchange Specification (IGES) File (.igs).

##### VSD
```
public static final FileType VSD
```

Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsd

##### VSDX
```
public static final FileType VSDX
```

Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It replaced the binary file format (.VSD) 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 FileType VSS
```

Represents a Visio Stencil File (.vss), which 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

##### VSSX
```
public static final FileType VSSX
```

Represents a Visio Stencil File (.vssx), which 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 representing a variety of drawing elements such as shapes, connectors, flowcharts, network layout, UML diagrams, etc. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssx

##### VSDM
```
public static final FileType VSDM
```

Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support 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

##### VST
```
public static final FileType VST
```

Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. They act as templates for creating further files and contain the default layout and settings used for creating new Visio drawings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vst

##### VSTX
```
public static final FileType VSTX
```

Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide a 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

##### VSTM
```
public static final FileType VSTM
```

Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. Files created from VSTM templates can run macros developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstm

##### VSSM
```
public static final FileType VSSM
```

Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. When a VSSM file is opened, macros can be run 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

##### VSX
```
public static final FileType VSX
```

Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and were supported until Visio 2013. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsx

##### VTX
```
public static final FileType VTX
```

Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. The template provides basic settings for creating multiple Visio files with the same settings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vtx

##### VDW
```
public static final FileType VDW
```

Represents a Visio Web Drawing (.vdw), which 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 FileType VDX
```

Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. A Visio drawing XML file is created in the Visio software developed by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vdx

##### EPUB
```
public static final FileType EPUB
```

Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. The format 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 FileType MOBI
```

Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as a proprietary format for Mobipocket Reader. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/mobi

##### AZW_3
```
public static final FileType AZW_3
```

Amazon Kindle Format 8 (KF8) ebook is the 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://wiki.fileformat.com/ebook/azw3

##### MSG
```
public static final FileType MSG
```

Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/msg

##### EML
```
public static final FileType EML
```

Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. Almost all email clients support this file format due to its compliance with the RFC-822 Internet Message Format Standard. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml

##### EMLX
```
public static final FileType EMLX
```

Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting emails. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/emlx

##### PST
```
public static final FileType PST
```

Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/pst

##### OST
```
public static final FileType OST
```

Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/ost

##### TIF
```
public static final FileType TIF
```

Represents a Tagged Image File (.tif), which 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

##### TIFF
```
public static final FileType TIFF
```

Represents a Tagged Image File Format (.tiff), which 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 FileType JPG
```

Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. The output image, as a 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 FileType JPEG
```

Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. The output image, as a 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

##### JFIF
```
public static final FileType JFIF
```

JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. This format uses JPEG compression.Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jfif

##### PNG
```
public static final FileType PNG
```

Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. This file format was created as a replacement for the 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 FileType GIF
```

Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. For each image, GIF typically allows up to 8 bits per pixel, and up to 256 colors are allowed across the image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif

##### APNG
```
public static final FileType APNG
```

Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/apng

##### BMP
```
public static final FileType BMP
```

Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. These images are independent of the 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 FileType ICO
```

Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/ico

##### TGA
```
public static final FileType TGA
```

Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tga

##### JP_2
```
public static final FileType JP_2
```

Represents a JPEG 2000 Core Image File (.jp2), which 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

##### JPF
```
public static final FileType JPF
```

Represents a JPEG 2000 Image File (.jpf). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/jpf

##### JPX
```
public static final FileType JPX
```

Represents a JPEG 2000 Image File (.jpx). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpx

##### JPM
```
public static final FileType JPM
```

Represents a JPEG 2000 Image File (.jpm). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpm

##### J2C
```
public static final FileType J2C
```

Represents a JPEG 2000 Code InputStream (.j2c). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2c

##### J2K
```
public static final FileType J2K
```

Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2k

##### JPC
```
public static final FileType JPC
```

Represents a JPEG 2000 Code Stream (.jpc). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpc

##### JLS
```
public static final FileType JLS
```

Represents a JPEG-LS (JLS) file (.jls). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/jls

##### DIB
```
public static final FileType DIB
```

Represents a Device Independent Bitmap File (.dib). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dib

##### WMF
```
public static final FileType WMF
```

Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/wmf

##### WMZ
```
public static final FileType WMZ
```

Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/wmz#compressed_windows_metafile

##### EMF
```
public static final FileType EMF
```

Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. Metafiles of EMF comprise 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

##### EMZ
```
public static final FileType EMZ
```

Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprise 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/emz

##### WEBP
```
public static final FileType WEBP
```

Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. It provides the 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 FileType DNG
```

Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. It was developed by Adobe in September 2004 and is primarily used for digital photography. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dng

##### CDR
```
public static final FileType CDR
```

Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. A CDR drawing file contains text, lines, shapes, images, colors, 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 FileType CMX
```

Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/cmx

##### DJVU
```
public static final FileType DJVU
```

Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/djvu

##### CGM
```
public static final FileType CGM
```

Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. CGM uses an object-oriented approach and provides many functions for image production. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/cgm

##### PCL
```
public static final FileType PCL
```

Represents a Printer Command Language Document (.pcl). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/pcl

##### PSD
```
public static final FileType PSD
```

Represents an Adobe Photoshop Document (.psd), which is 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

##### PSB
```
public static final FileType PSB
```

Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/psb

##### DCM
```
public static final FileType DCM
```

Represents a DICOM Image (.dcm), which represents a digital image that 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

##### PS
```
public static final FileType PS
```

Represents a PostScript File (.ps). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/ps

##### EPS
```
public static final FileType EPS
```

Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/eps

##### ODG
```
public static final FileType ODG
```

Represents an OpenDocument Graphic File (.odg), which 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

##### FODG
```
public static final FileType FODG
```

Represents a Flat XML ODF Template (.fodg), which 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/fodg

##### SVG
```
public static final FileType SVG
```

Represents a Scalable Vector Graphics File (.svg), which 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

##### SVGZ
```
public static final FileType SVGZ
```

Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/svgz

##### OTG
```
public static final FileType OTG
```

Represents an OpenDocument Graphic Template (.otg). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/otg

##### HTM
```
public static final FileType HTM
```

Represents a Hypertext Markup Language File (.htm), which 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

##### HTML
```
public static final FileType HTML
```

Represents a Hypertext Markup Language File (.html), which 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 FileType MHT
```

Represents an MHTML Web Archive (.mht). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mht

##### NSF
```
public static final FileType NSF
```

Represents a Lotus Notes Database (.nsf). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/nsf

##### MBOX
```
public static final FileType MBOX
```

Represents an Email Mailbox File (.mbox). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/mbox

##### MHTML
```
public static final FileType MHTML
```

Represents a MIME HTML File (.mhtml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mhtml

##### XML
```
public static final FileType XML
```

Represents an XML File (.xml). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/xml

##### ONE
```
public static final FileType ONE
```

Represents a OneNote Document (.one) 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

##### PDF
```
public static final FileType PDF
```

Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. The purpose of this file format was to introduce a standard for the representation of documents and other reference material in a format that is independent of application software, hardware, and operating systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/view/pdf

##### XPS
```
public static final FileType XPS
```

Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement for the EMF file format and is similar to the PDF file format, but uses XML in the layout, appearance, and printing information of a document. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/xps

##### OXPS
```
public static final FileType OXPS
```

Represents an OpenXPS File (.oxps). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/oxps

##### TEX
```
public static final FileType TEX
```

Represents a LaTeX Source Document (.tex), which is a language that comprises 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

##### PPT
```
public static final FileType PPT
```

Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a 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

##### PPTX
```
public static final FileType PPTX
```

Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. Unlike the previous version of the 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

##### PPS
```
public static final FileType PPS
```

Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. PPS file reading and creation are supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pps

##### PPSX
```
public static final FileType PPSX
```

Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/ppsx

##### ODP
```
public static final FileType ODP
```

Represents an OpenDocument Presentation (.odp), which represents a 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

##### FODP
```
public static final FileType FODP
```

Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/fodp

##### POT
```
public static final FileType POT
```

Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pot

##### PPTM
```
public static final FileType PPTM
```

Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pptm

##### POTX
```
public static final FileType POTX
```

Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/potx

##### POTM
```
public static final FileType POTM
```

Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. POTM files are created with PowerPoint 2007 or above and contain 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

##### PPSM
```
public static final FileType PPSM
```

Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a 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

##### OTP
```
public static final FileType OTP
```

Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/otp

##### XLS
```
public static final FileType XLS
```

Represents an Excel Spreadsheet (.xls), which represents the 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

##### EXCEL_2003_XML
```
public static final FileType EXCEL_2003_XML
```

Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the 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

##### NUMBERS
```
public static final FileType NUMBERS
```

Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. Such files can be created by Apple Numbers application. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/numbers

##### XLSX
```
public static final FileType XLSX
```

Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a 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 FileType XLSM
```

Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlsm

##### XLSB
```
public static final FileType XLSB
```

Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. It 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

##### CSV
```
public static final FileType CSV
```

Represents a Comma Separated Values File (.csv), which represents 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

##### TSV
```
public static final FileType TSV
```

Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/tsv

##### ODS
```
public static final FileType ODS
```

Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. Data is stored inside ODF files in rows and columns. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ods

##### FODS
```
public static final FileType FODS
```

Represents an OpenDocument Flat XML Spreadsheet (.fods). It is a spreadsheet document format based on XML used by OpenOffice and LibreOffice. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/fods

##### OTS
```
public static final FileType OTS
```

Represents an OpenDocument Spreadsheet Template (.ots). It is a template document format used by OpenOffice and LibreOffice for spreadsheets. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ots

##### XLAM
```
public static final FileType XLAM
```

Represents a Microsoft Excel Add-in (.xlam). It is a file format used by Microsoft Excel to create add-ins with custom functionality. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/xlam

##### XLTM
```
public static final FileType XLTM
```

Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure except that the latter doesn't support creating template files with macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltm

##### XLT
```
public static final FileType XLT
```

Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening them. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlt

##### XLTX
```
public static final FileType XLTX
```

Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates 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 with the same settings specified in the XLTX file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltx

##### SXC
```
public static final FileType SXC
```

Represents a StarOffice Calc Spreadsheet (.sxc). It is a spreadsheet document created with StarOffice Calc, a spreadsheet program. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/sxc

##### MPP
```
public static final FileType MPP
```

Represents a Microsoft Project File (.mpp), which is a 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

##### MPT
```
public static final FileType MPT
```

Represents a Microsoft Project Template (.mpt), which contains 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

##### MPX
```
public static final FileType MPX
```

Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring 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

##### AS
```
public static final FileType AS
```

Represents an ActionScript File (.as). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/as

##### AS_3
```
public static final FileType AS_3
```

Represents an ActionScript File (.as3). Learn more about this file format [here][].

[here]: https://datatypes.net/open-as3-files

##### ASM
```
public static final FileType ASM
```

Represents an Assembly Language Source Code File (.asm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/cad/asm

##### BAT
```
public static final FileType BAT
```

Represents a DOS Batch File (.bat). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/executable/bat

##### C
```
public static final FileType C
```

Represents a C/C++ Source Code File (.c). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/c

##### CC
```
public static final FileType CC
```

Represents a C++ Source Code File (.cc). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/cc

##### CMAKE
```
public static final FileType CMAKE
```

Represents a CMake File (.cmake). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cmake

##### CPP
```
public static final FileType CPP
```

Represents a C++ Source Code File (.cpp). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cpp

##### CS
```
public static final FileType CS
```

Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. It was introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cs

##### VB
```
public static final FileType VB
```

Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. It was created by Microsoft for the development of .NET applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/vb

##### CSS
```
public static final FileType CSS
```

Represents a Cascading Style Sheet (.css) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/css

##### CXX
```
public static final FileType CXX
```

Represents a C++ Source Code File (.cxx). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/cxx

##### DIFF
```
public static final FileType DIFF
```

Represents a Patch File (.diff). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/diff

##### ERB
```
public static final FileType ERB
```

Represents a Ruby ERB Script (.erb). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/erb

##### GROOVY
```
public static final FileType GROOVY
```

Represents a Groovy Source Code File (.groovy). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/groovy

##### H
```
public static final FileType H
```

Represents a C/C++/Objective-C Header File (.h). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/h

##### HAML
```
public static final FileType HAML
```

Represents a Haml Source Code File (.haml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/haml

##### HH
```
public static final FileType HH
```

Represents a C++ Header File (.hh). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/hh

##### JAVA
```
public static final FileType JAVA
```

Represents a Java Source Code File (.java). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/java

##### JS
```
public static final FileType JS
```

Represents a JavaScript File (.js). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/js

##### JSON
```
public static final FileType JSON
```

Represents a JavaScript Object Notation File (.json). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/json

##### LESS
```
public static final FileType LESS
```

Represents a LESS Style Sheet (.less) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/less

##### LOG
```
public static final FileType LOG
```

Represents a Log File (.log). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/database/log

##### M
```
public static final FileType M
```

Represents an Objective-C Implementation File (.m). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/m

##### MAKE
```
public static final FileType MAKE
```

Represents an Xcode Makefile Script (.make). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/make

##### MD
```
public static final FileType MD
```

Represents a Markdown Documentation File (.md). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/md

##### ML
```
public static final FileType ML
```

Represents an ML Source Code File (.ml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/ml

##### MM
```
public static final FileType MM
```

Represents an Objective-C++ Source File (.mm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/mm

##### PHP
```
public static final FileType PHP
```

Represents a PHP Source Code File (.php). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/php

##### PL
```
public static final FileType PL
```

Represents a Perl Script (.pl). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/pl

##### PROPERTIES
```
public static final FileType PROPERTIES
```

Represents a Java Properties File (.properties). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/properties

##### PY
```
public static final FileType PY
```

Represents a Python Script (.py). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/py

##### RB
```
public static final FileType RB
```

Represents a Ruby Source Code (.rb) file. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/rb

##### RST
```
public static final FileType RST
```

Represents a reStructuredText File (.rst). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/rst

##### SASS
```
public static final FileType SASS
```

Represents a Syntactically Awesome StyleSheets File (.sass). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/sass

##### SCALA
```
public static final FileType SCALA
```

Represents a Scala Source Code File (.scala). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/scala

##### SCM
```
public static final FileType SCM
```

Represents a Scheme Source Code File (.scm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/scm

##### SCRIPT
```
public static final FileType SCRIPT
```

Represents a Generic Script File (.script). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/script

##### SH
```
public static final FileType SH
```

Represents a Bash Shell Script (.sh). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/cs/programming/sh

##### SML
```
public static final FileType SML
```

Represents a Standard ML Source Code File (.sml). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/sml

##### SQL
```
public static final FileType SQL
```

Represents a Structured Query Language Data File (.sql). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/database/sql

##### VIM
```
public static final FileType VIM
```

Represents a Vim Settings File (.vim). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/vim

##### YAML
```
public static final FileType YAML
```

Represents a YAML Document (.yaml). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/yaml

##### DOC
```
public static final FileType DOC
```

Represents a Microsoft Word Document (.doc) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/doc

##### DOCX
```
public static final FileType DOCX
```

Represents a Microsoft Word Open XML Document (.docx) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docx

##### CHM
```
public static final FileType CHM
```

Represents a Microsoft Compiled HTML Help File (.chm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/chm

##### DOCM
```
public static final FileType DOCM
```

Represents a Word Open XML Macro-Enabled Document (.docm) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docm

##### DOT
```
public static final FileType DOT
```

Represents a Word Document Template (.dot) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dot

##### DOTX
```
public static final FileType DOTX
```

Represents a Word Open XML Document Template (.dotx) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotx

##### DOTM
```
public static final FileType DOTM
```

Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotm

##### RTF
```
public static final FileType RTF
```

Represents a Rich Text Format File (.rtf). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/rtf

##### TXT
```
public static final FileType TXT
```

Represents a Plain Text File (.txt). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/txt

##### ODT
```
public static final FileType ODT
```

Represents an OpenDocument Text Document (.odt). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt

##### OTT
```
public static final FileType OTT
```

Represents an OpenDocument Document Template (.ott). It is a template document generated in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/ott

##### VCF
```
public static final FileType VCF
```

Represents a vCard File (.vcf), which is a digital file format for storing contact information. It 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

##### AI
```
public static final FileType AI
```

Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/ai

##### PSM1
```
public static final FileType PSM1
```

Represents a PowerShell script module file (.psm1). It is a file format for PowerShell module scripts. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/psm1

##### PS1
```
public static final FileType PS1
```

Represents a PowerShell script file (.ps1). It is a file format for Windows PowerShell Cmdlet files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/ps1

##### PSD1
```
public static final FileType PSD1
```

Represents a PowerShell script module manifest file (.psd1). It is a file format for PowerShell module manifest scripts. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/psd1

##### values()
```
public static FileType[] values()
```

**Returns:**
com.groupdocs.viewer.FileType[]
##### valueOf(String name)
```
public static FileType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileType
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps a file extension to a file type.

This method takes a file extension, with or without the period ".", and returns the corresponding file type if it is supported. If the file type is not supported, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension with or without the period ".". |

**Returns:**
FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.
##### fromFilePath(String filePath)
```
public static FileType fromFilePath(String filePath)
```

Extracts the file extension from a file name or file path and maps it to a file type.

If the file type is supported, the method returns the corresponding  FileType , otherwise it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or file path. |

**Returns:**
FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.
##### fromMediaType(String mediaType)
```
public static FileType fromMediaType(String mediaType)
```

Maps a file media type to a file type. For example, 'application/pdf' will be mapped to PDF.

This method takes a file media type as input and maps it to the corresponding  FileType . If the media type is supported, the method returns the corresponding file type. If the media type is not supported, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mediaType | java.lang.String | The file media type, e.g., 'application/pdf'. |

**Returns:**
FileType - the corresponding file type if found, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream)
```
public static FileType fromStream(InputStream stream)
```

Detects the file type by reading the file signature.

This method takes an input stream representing a file and tries to detect its file type by analyzing the file signature. The file signature is a unique sequence of bytes at the beginning of the file that indicates its file type. The method reads the file signature from the input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, String password)
```
public static FileType fromStream(InputStream stream, String password)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

If the file is encrypted and requires a password to open, the password should be provided as a parameter to this method. The password will be used to decrypt the file and analyze its signature for determining the file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| password | java.lang.String | The password to open the file. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, ILogger logger)
```
public static FileType fromStream(InputStream stream, ILogger logger)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, String password, ILogger logger)
```
public static FileType fromStream(InputStream stream, String password, ILogger logger)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

A password can be provided if the file is encrypted or protected. The password will be used to open the file before analyzing the file signature. If the file does not require a password, this parameter can be set to null.

A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| password | java.lang.String | The password to open the file. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves the supported file types.

This method returns a sequence of all the supported file types by the system. The file types represent various document formats that can be processed or recognized by the system.

[Full list of supported file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/

**Returns:**
java.util.List<com.groupdocs.viewer.FileType> - a sequence of supported file types.
##### detectCharset(String filePath)
```
public static Charset detectCharset(String filePath)
```

Attempts to detect text TXT, TSV, and CSV files charset by path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or file path. |

**Returns:**
java.nio.charset.Charset - Charset or null when fails to detect a file charset.

**Example:**

```
Charset charset = FileType.detectCharset("message.txt");
```
##### detectCharset(InputStream stream)
```
public static Charset detectCharset(InputStream stream)
```

Attempts to detect text TXT, TSV, and CSV file charset by stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The file stream. |

**Returns:**
java.nio.charset.Charset - Charset or null when fails to detect a file charset.

**Example:**

```
InputStream stream = new FileInputStream("message.txt");
 Charset charset = FileType.detectCharset(stream);
```
##### getFileFormat()
```
public final String getFileFormat()
```

Gets the name of the file format, e.g., "Microsoft Word Document".

**Returns:**
java.lang.String - the name of the file format.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension suffix (including the period "."), e.g., ".doc".

**Returns:**
java.lang.String - the file extension suffix.
##### toString()
```
public String toString()
```

Returns a string representation of the current object.

**Returns:**
java.lang.String - a string representation of the current object.

### License
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

Provides methods to license the component and unlock its full functionality.

The License class allows you to apply a valid license to the GroupDocs.Viewer component, enabling you to utilize all the features and remove any evaluation limitations.

Example usage:

```

 License license = new License();
 license.setLicense("path/to/license/file.lic");
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| resetLicense() |  |
| setLicense(InputStream licenseStream) | Licenses the component. |
| setLicense(Path licensePath) | Licenses the component. |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(URL licenseUri) | Licenses the component. |
| isLicensed() |  |
##### License()
```
public License()
```

##### resetLicense()
```
public static void resetLicense()
```

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

The following example demonstrates how to set a license passing InputStream of the license file.

For more information about licensing, please refer to the [GroupDocs Licensing FAQ][]. You can also find detailed information about GroupDocs.Viewer licensing in the [Evaluation Limitations and Licensing][] documentation.

**Example:**

```

 FileInputStream licenseStream = new FileInputStream("LicenseFile.lic");
 License license = new License();
 license.setLicense(licenseStream);
 
```

[GroupDocs Licensing FAQ]: https://purchase.groupdocs.com/faqs/licensing
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/viewernet/Evaluation+Limitations+and+Licensing+of+GroupDocs.Viewer

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

##### setLicense(Path licensePath)
```
public final void setLicense(Path licensePath)
```

Licenses the component.

Sets the license for the component using the specified license path.

**Note:** This method should be called before using any functionality of 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.

This method should be called before using any functionality.

Example usage:

```

 String licensePath = "GroupDocs.Viewer.lic";
 License license = new License();
 license.setLicense(licensePath);
 
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path or url. |

##### setLicense(URL licenseUri)
```
public void setLicense(URL licenseUri)
```

Licenses the component.

This method should be called before using any functionality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseUri | java.net.URL | The license URI. |

##### isLicensed()
```
public final boolean isLicensed()
```

**Returns:**
boolean

### Metered
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying metered license to the GroupDocs.Viewer component.

Metered licensing allows you to dynamically monitor and control the usage of GroupDocs.Viewer based on the number of document pages processed instead of a traditional per-server or per-developer license. This flexible licensing model is suitable for scenarios where the document processing requirements vary over time or when you want to pay only for what you use.

Example usage:

```

 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 // Perform document processing operations using GroupDocs.Viewer
 // ...
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() |  |
#### Methods

| Method | Description |
| --- | --- |
| getConsumptionQuantity() | Retrieves the amount of megabytes (MB) processed. |
| getConsumptionCredit() | Retrieves the count of credits consumed. |
| setMeteredKey(String publicKey, String privateKey) | Activates the product with Metered keys. |
##### Metered()
```
public Metered()
```

##### getConsumptionQuantity()
```
public static double getConsumptionQuantity()
```

Retrieves the amount of megabytes (MB) processed.

This method returns the total amount of MB processed by the component.

**Example:**

```

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double mbProcessed = Metered.getConsumptionQuantity();
 
```

**Returns:**
double - the amount of MB processed.
##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Retrieves the count of credits consumed.

This method returns the total count of credits consumed by the component.

**Example:**

```

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double creditsConsumed = Metered.getConsumptionCredit();
 
```

**Returns:**
double - the count of credits consumed.
##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates the product with Metered keys.

Following example demonstrates how to activate product with Metered keys.

**Example:**

```

 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. |

### Viewer
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/viewer.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Viewer implements Closeable
```

Represents the main class that controls the document rendering process.

The Viewer class is the entry point for rendering documents using the GroupDocs.Viewer component. It provides methods and options to load documents from various sources, customize the rendering process, and retrieve the rendered output in different formats.

Example usage:

```

 try (Viewer viewer = new Viewer("source.pdf")) {
     viewer.view(new PngViewOptions("result-page{0}.png"));
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Viewer(InputStream fileStream) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) | Initializes new instance of Viewer class. |
| Viewer(URL url) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(FileReader fileReader, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
#### Fields

| Field | Description |
| --- | --- |
| LOAD_OPTIONS |  |
| SETTINGS |  |
| FILE_READER |  |
| OPTIONS |  |
#### Methods

| Method | Description |
| --- | --- |
| getViewInfo(ViewInfoOptions options) | Returns information about the view and document specific information. |
| getAttachments() | Returns attachments contained by the document. |
| saveAttachment(Attachment attachment, OutputStream destination) | Saves an attachment file to the destination stream. |
| view(ViewOptions options) | Creates a view of all document pages. |
| view(ViewOptions options, int[] pageNumbers) | Creates a view of specific document pages. |
| getAllFonts() | Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document. |
| search(SearchHighlightOptions options) | Performs a text search and highlights matches (if found) in the loaded document according to the provided options. |
| getFileInfo() | Returns information about the file, such as file type and a flag that indicates if the file is encrypted. |
| close() | Releases the file stream and managed internal resources. |
##### Viewer(InputStream fileStream)
```
public Viewer(InputStream fileStream)
```

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The method that returns a readable stream. |

##### Viewer(InputStream fileStream, boolean leaveOpen)
```
public Viewer(InputStream fileStream, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The readable stream. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, ViewerSettings settings)
```
public Viewer(InputStream fileStream, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)
```
public Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)
```

Initializes new instance of Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(URL url)
```
public Viewer(URL url)
```

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |

##### Viewer(URL url, LoadOptions loadOptions)
```
public Viewer(URL url, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(URL url, ViewerSettings settings)
```
public Viewer(URL url, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(FileReader fileReader, ViewerSettings settings)
```
public Viewer(FileReader fileReader, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

This constructor allows you to create a Viewer object to view a document from a FileReader with the specified ViewerSettings.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileReader | FileReader | The FileReader containing the document to be loaded into the Viewer. |
| settings | ViewerSettings | The ViewerSettings to be applied to the Viewer. |

##### Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

Provides functionality to load and view documents using GroupDocs.Viewer.

**Note:** Ensure that the file reader, load options, and settings are properly configured for accurate document processing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileReader | FileReader | The file reader. |
| loadOptions | LoadOptions | The load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(String filePath)
```
public Viewer(String filePath)
```

Initializes a new instance of the Viewer class.

 **Learn more:**

 *  More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]
 *  More about GroupDocs.Viewer for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |

##### Viewer(Path filePath)
```
public Viewer(Path filePath)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |

##### Viewer(String filePath, LoadOptions loadOptions)
```
public Viewer(String filePath, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(Path filePath, LoadOptions loadOptions)
```
public Viewer(Path filePath, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view a document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(String filePath, ViewerSettings settings)
```
public Viewer(String filePath, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(Path filePath, ViewerSettings settings)
```
public Viewer(Path filePath, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### LOAD_OPTIONS
```
public static final String LOAD_OPTIONS
```

##### SETTINGS
```
public static final String SETTINGS
```

##### FILE_READER
```
public static final String FILE_READER
```

##### OPTIONS
```
public static final String OPTIONS
```

##### getViewInfo(ViewInfoOptions options)
```
public final ViewInfo getViewInfo(ViewInfoOptions options)
```

Returns information about the view and document specific information.

 **Learn more:**

 *  Learn more about the document - file type, page count, and other format specific properties: [How to get file information using GroupDocs.Viewer][]

[How to get file information using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+file+information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewInfoOptions | The view info options. |

**Returns:**
ViewInfo - Information about the view and document specific information.
##### getAttachments()
```
public final List<Attachment> getAttachments()
```

Returns attachments contained by the document.

 **Learn more:**

 *  Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][]
 *  Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][]

[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments
[How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments

**Returns:**
java.util.List<com.groupdocs.viewer.results.Attachment> - attachments contained by the document.
##### saveAttachment(Attachment attachment, OutputStream destination)
```
public void saveAttachment(Attachment attachment, OutputStream destination)
```

Saves an attachment file to the destination stream.

 **Learn more:**

 *  Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][]
 *  Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][]

[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments
[How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attachment | Attachment | The attachment. |
| destination | java.io.OutputStream | The writable stream. |

##### view(ViewOptions options)
```
public final void view(ViewOptions options)
```

Creates a view of all document pages.

[How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |

##### view(ViewOptions options, int[] pageNumbers)
```
public final void view(ViewOptions options, int[] pageNumbers)
```

Creates a view of specific document pages.

[How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |
| pageNumbers | int[] | The page numbers to view. |

##### getAllFonts()
```
public IFontInfo[] getAllFonts()
```

Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.

For details, see the [ documentation][documentation].

[documentation]: https://docs.groupdocs.com/viewer/net/getting-used-fonts/

**Returns:**
com.groupdocs.viewer.fonts.IFontInfo[] - Non-null list of all fonts used in the document loaded into this Viewer instance.
##### search(SearchHighlightOptions options)
```
public void search(SearchHighlightOptions options)
```

Performs a text search and highlights matches (if found) in the loaded document according to the provided options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | com.groupdocs.viewer.options.SearchHighlightOptions | Search and highlight options, including a text phrase to search. Cannot be  null . |

##### getFileInfo()
```
public FileInfo getFileInfo()
```

Returns information about the file, such as file type and a flag that indicates if the file is encrypted.

**Learn more:**

 *  Learn more about how to check if a file is encrypted: [How to check if a file is encrypted][]

[How to check if a file is encrypted]: https://docs.groupdocs.com/viewer/net/how-to-check-if-file-is-encrypted/

**Returns:**
FileInfo - the file information.
##### close()
```
public final void close()
```

Releases the file stream and managed internal resources.

### ViewerSettings
Path: https://reference.groupdocs.com/viewer/java/com.groupdocs.viewer/viewersettings.md

**Inheritance:**
java.lang.Object
```
public class ViewerSettings
```

Defines settings for customizing the behavior of the Viewer component.

The ViewerSettings class provides options and properties to customize the behavior of the GroupDocs.Viewer component during the document rendering process. You can use this class to specify various settings, such as logger, custom cache implementation, and more.

Example usage:

```

 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setLogger(new ConsoleLogger(false, true));

 try (Viewer viewer = new Viewer("source.pdf", viewerSettings)) {
     // Document processing
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewerSettings(Cache cache, ILogger logger) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings(ILogger logger) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings(Cache cache) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings() | Initializes a new instance of the  ViewerSettings  class. |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Gets the logger implementation used for logging (Errors, Warnings, Traces). |
| setLogger(ILogger logger) | Sets the logger implementation used for logging (Errors, Warnings, Traces). |
| getCache() | Gets the cache implementation used for storing rendering results. |
| setCache(Cache cache) | Sets the cache implementation used for storing rendering results. |
##### ViewerSettings(Cache cache, ILogger logger)
```
public ViewerSettings(Cache cache, ILogger logger)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger. |

##### ViewerSettings(ILogger logger)
```
public ViewerSettings(ILogger logger)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger. |

##### ViewerSettings(Cache cache)
```
public ViewerSettings(Cache cache)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache. |

##### ViewerSettings()
```
public ViewerSettings()
```

Initializes a new instance of the  ViewerSettings  class.

##### getLogger()
```
public ILogger getLogger()
```

Gets the logger implementation used for logging (Errors, Warnings, Traces).

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger implementation.
##### setLogger(ILogger logger)
```
public void setLogger(ILogger logger)
```

Sets the logger implementation used for logging (Errors, Warnings, Traces).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger implementation to set. |

##### getCache()
```
public final Cache getCache()
```

Gets the cache implementation used for storing rendering results.

**Returns:**
Cache - the cache implementation.
##### setCache(Cache cache)
```
public void setCache(Cache cache)
```

Sets the cache implementation used for storing rendering results.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache implementation. |

## .NET

### GroupDocs.Viewer for .NET
Path: https://reference.groupdocs.com/viewer/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Viewer | The namespace provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality. |
| GroupDocs.Viewer.Caching | The namespace provides classes for customizing caching behaviour. |
| GroupDocs.Viewer.Drawing | The namespace provides types that replaces platform-specific graphics types like Color. |
| GroupDocs.Viewer.Exceptions | The namespace provides different exceptions classes. |
| GroupDocs.Viewer.Fonts | The namespace provides classes and enumerations to manage fonts used during rendering process. |
| GroupDocs.Viewer.Interfaces | The namespace provides interfaces to instantiate and release output document and it's resources. |
| GroupDocs.Viewer.Logging | The namespace provides classes to customize logging behaviour. |
| GroupDocs.Viewer.Options | The namespace provides classes to specify additional options when rendering documents. |
| GroupDocs.Viewer.Results | The namespace provides classes which represent document rendering results. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### GroupDocs.Viewer.Caching
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching.md

The namespace provides classes for customizing caching behaviour.

#### Classes

| Class | Description |
| --- | --- |
| CacheKeys | Provides methods to retrieve unique identifier for the cache entry. |
| FileCache | Represents a local on-disk cache. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ICache | Defines methods required for storing rendered document and document resources сache. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### CacheKeys
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys.md

#### CacheKeys class

Provides methods to retrieve unique identifier for the cache entry.

```csharp
public static class CacheKeys
```

#### Methods

| Name | Description |
| --- | --- |
| static GetAttachmentKey(string) | Returns unique identifier for the cache entry that represents attachment file. |
| static GetAttachmentsKey() | Returns unique identifier for the cache entry that represents collection of `Attachment` objects. |
| static GetFileInfoKey() | Returns unique identifier for the cache entry that represents `ViewInfo` object. |
| static GetFileKey(string) | Returns unique identifier for the cache entry that represents file. |
| static GetPageKey(int, string) | Returns unique identifier for the cache entry that represents page file. |
| static GetResourceFilter(int) | Returns filter string to search for cache entries that represents `Resource` objects. |
| static GetResourceKey(int, Resource) | Returns unique identifier for the cache entry that represents `Resource` object. |
| static GetViewInfoKey() | Returns unique identifier for the cache entry that represents `ViewInfo` object. |

### GetAttachmentKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getattachmentkey.md

#### CacheKeys.GetAttachmentKey method

Returns unique identifier for the cache entry that represents attachment file.

```csharp
public static string GetAttachmentKey(string attachmentId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attachmentId | String | Unique (in context of single file) identifier of the attachment. |

##### Return Value

Unique identifier for the cache entry that represents attachment file.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *attachmentId* is null or empty. |

### GetAttachmentsKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getattachmentskey.md

#### CacheKeys.GetAttachmentsKey method

Returns unique identifier for the cache entry that represents collection of `Attachment` objects.

```csharp
public static string GetAttachmentsKey()
```

##### Return Value

Unique identifier for the cache entry that represents collection of `Attachment` objects.

### GetFileInfoKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getfileinfokey.md

#### CacheKeys.GetFileInfoKey method

Returns unique identifier for the cache entry that represents `ViewInfo` object.

```csharp
public static string GetFileInfoKey()
```

##### Return Value

Unique identifier for the cache entry that represents `ViewInfo` object.

### GetFileKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getfilekey.md

#### CacheKeys.GetFileKey method

Returns unique identifier for the cache entry that represents file.

```csharp
public static string GetFileKey(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The filename suffix (including the period ".") e.g. ".doc". |

##### Return Value

Unique identifier for the cache entry that represents file.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty. |

### GetPageKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getpagekey.md

#### CacheKeys.GetPageKey method

Returns unique identifier for the cache entry that represents page file.

```csharp
public static string GetPageKey(int pageNumber, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of the page. |
| extension | String | The filename suffix (including the period ".") e.g. ".doc". |

##### Return Value

Unique identifier for the cache entry that represents page file.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *pageNumber* is less or equal to zero. |
| ArgumentException | Thrown when *extension* is null or empty. |

### GetResourceFilter
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getresourcefilter.md

#### CacheKeys.GetResourceFilter method

Returns filter string to search for cache entries that represents `Resource` objects.

```csharp
public static string GetResourceFilter(int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of page. |

##### Return Value

Filter string to search for cache entries that represents `Resource` objects.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *pageNumber* is less or equal to zero. |

### GetResourceKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getresourcekey.md

#### CacheKeys.GetResourceKey method

Returns unique identifier for the cache entry that represents `Resource` object.

```csharp
public static string GetResourceKey(int pageNumber, Resource resource)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of the page. |
| resource | Resource | The HTML resource. |

##### Return Value

Unique identifier for the cache entry that represents `Resource` object.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *pageNumber* is less or equal to zero. |
| ArgumentNullException | Thrown when *resource* is null. |

### GetViewInfoKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/cachekeys/getviewinfokey.md

#### CacheKeys.GetViewInfoKey method

Returns unique identifier for the cache entry that represents `ViewInfo` object.

```csharp
public static string GetViewInfoKey()
```

##### Return Value

Unique identifier for the cache entry that represents `ViewInfo` object.

### FileCache
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/filecache.md

#### FileCache class

Represents a local on-disk cache.

```csharp
public class FileCache : ICache
```

#### Constructors

| Name | Description |
| --- | --- |
| FileCache(string) | Creates new instance of `FileCache` class. |
| FileCache(string, string) | Creates new instance of `FileCache` class. |

#### Properties

| Name | Description |
| --- | --- |
| CachePath { get; } | The Relative or absolute path to the cache folder. |
| CacheSubFolder { get; } | The sub-folder to append to the `CachePath`. |

#### Methods

| Name | Description |
| --- | --- |
| GetKeys(string) | Returns all file names that contains filter in filename. |
| Set(string, object) | Serializes data to the local disk. |
| TryGetValue&lt;T&gt;(string, out T) | Deserializes data associated with this key if present. |

### CachePath
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/filecache/cachepath.md

#### FileCache.CachePath property

The Relative or absolute path to the cache folder.

```csharp
public string CachePath { get; }
```

### CacheSubFolder
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/filecache/cachesubfolder.md

#### FileCache.CacheSubFolder property

The sub-folder to append to the `CachePath`.

```csharp
public string CacheSubFolder { get; }
```

### FileCache
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/filecache/filecache.md

#### FileCache(string)

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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *cachePath* is null. |

#### FileCache(string, string)

Creates new instance of `FileCache` class.

```csharp
public FileCache(string cachePath, string cacheSubFolder)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | String | Relative or absolute path where document cache will be stored. |
| cacheSubFolder | String | The sub-folder to append to *cachePath*. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *cachePath* is null. |
| ArgumentNullException | Thrown when *cacheSubFolder* is null. |

### GetKeys
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/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.

### Set
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/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. |

### TryGetValue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.caching/filecache/trygetvalue.md

#### FileCache.TryGetValue&lt;T&gt; method

Deserializes data associated with this key if present.

```csharp
public bool TryGetValue<T>(string key, out T value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| key | String | A key identifying the requested entry. |
| value | T& | The located value or null. |

##### Return Value

```csharp
True
```

if the key was found.

### ICache
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.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&lt;TEntry&gt;(string, out TEntry) | Gets the entry associated with this key if present. |

### GetKeys
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.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/viewer/net/groupdocs.viewer.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/viewer/net/groupdocs.viewer.caching/icache/trygetvalue.md

#### ICache.TryGetValue&lt;TEntry&gt; method

Gets the entry associated with this key if present.

```csharp
public bool TryGetValue<TEntry>(string key, out TEntry value)
```

| Parameter | Description |
| --- | --- |
| TEntry | Type of entry. |
| key | A key identifying the requested entry. |
| value | The located value or null. |

##### Return Value

```csharp
True
```

if the key was found.

### GroupDocs.Viewer.Drawing
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing.md

The namespace provides types that replaces platform-specific graphics types like Color.

#### Classes

| Class | Description |
| --- | --- |
| Rgb24Color.KnownColors | Contains all "known colors", that have fixed unique name and value in CSS standart |
#### Structures

| Structure | Description |
| --- | --- |
| Argb32Color | Represents 32-bit color in ARGB format, with 8 bits per every channel (Alpha, Red, Green, Blue). Supports transparency. |
| Image2DFormat | Represents most common 2D image formats, supports both raster and vector formats |
| Rgb24Color | Represents 24-bit color in RGB format, with 8 bits per every channel (Red, Green, Blue). Does not support transparency. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### Argb32Color
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color.md

#### Argb32Color structure

Represents 32-bit color in ARGB format, with 8 bits per every channel (Alpha, Red, Green, Blue). Supports transparency.

```csharp
public struct Argb32Color : IEquatable<Argb32Color>, IEquatable<Rgb24Color>
```

#### Properties

| Name | Description |
| --- | --- |
| A { get; } | Gets the alpha part of the color as 8-bit unsigned integer [0..255] |
| Alpha { get; } | Gets the alpha part of the color in percent in (0..1) range. |
| B { get; } | Gets the blue part of the color as 8-bit unsigned integer [0..255] |
| G { get; } | Gets the green part of the color as 8-bit unsigned integer [0..255] |
| IsDefault { get; } | Indicates whether this `Argb32Color` instance is default (Transparent) - all 4 channels are set to 0. Same as `IsEmpty` |
| IsEmpty { get; } | Indicates whether this `Argb32Color` color instance is uninitialized - all 4 channels are set to 0. Same as Default and Transparent. Same as `IsDefault` |
| IsFullyOpaque { get; } | Indicates whether this `Argb32Color` instance is fully opaque, without transparency (its Alpha channel has max value) |
| IsFullyTransparent { get; } | Indicates whether this `Argb32Color` instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect. |
| IsTranslucent { get; } | Indicates whether this `Argb32Color` instance is translucent (not fully transparent, but also not fully opaque) |
| R { get; } | Gets the red part of the color as 8-bit unsigned integer [0..255] |
| Value { get; } | Gets the Int32 value of the color as 32-bit signed integer |

#### Methods

| Name | Description |
| --- | --- |
| static FromArgb(int) | Creates a `Argb32Color` instance from its 32-bit component (alpha, red, green, and blue) values, compatible with value, produced by the `System.Drawing.Color.ToArgb()` method |
| static FromOtherWithAlpha(Argb32Color, byte) | Creates a new `Argb32Color` instance from specified, but with re-defined alpha (opacity) value |
| static FromOtherWithAlpha(Rgb24Color, byte) | Creates a new `Argb32Color` instance from specified `Rgb24Color`, but with specified alpha (opacity) value |
| static FromRgb(byte, byte, byte) | Creates one `Argb32Color` value from specified Red, Green, Blue channels, while Alpha channel is fully opaque |
| static FromRgba(byte, byte, byte, byte) | Creates one `Argb32Color` value from specified Red, Green, Blue, and Alpha channels |
| static FromSingleValueRgb(byte) | Creates a fully opaque (A=255) color from single value, which will be applied to all channels |
| Equals(Argb32Color) | Checks this color with specified `Argb32Color` color for equality |
| override Equals(object) | Checks this color with specified uncasted |
| Equals(Rgb24Color) | Checks this color with specified `Rgb24Color` color for equality |
| GetBrightness() | Returns the Hue-Saturation-Lightness (HSL) lightness/brightness for this `Argb32Color` instance. |
| override GetHashCode() | Returns a hash code that defines the current color. Not compatible with GetHashCode |
| GetHue() | Returns the Hue-Saturation-Lightness (HSL) hue value, in degrees, for this `Argb32Color` instance. If R == G == B, the hue is meaningless, and the return value is 0. |
| GetSaturation() | The Hue-Saturation-Lightness (HSL) saturation for this `Argb32Color` instance |
| ToArgb() | Returns the ARGB value of this `Argb32Color` instance, compatible with `System.Drawing.Color.ToArgb()` method |
| ToHexRGB() | Serializes this `Argb32Color` instance to the hexadecimal notation `##RRGGBB` as a string without alpha channel |
| ToHexRGBA() | Serializes this `Argb32Color` instance to the hexadecimal notation `##RRGGBBAA` as a string with alpha channel |
| ToRGB() | Serializes this `Argb32Color` instance to the 'rgb' CSS function notation. Alpha channel of this color will be omitted during serialization. |
| ToRGBA() | Serializes this `Argb32Color` instance to the 'rgba' CSS function notation |
| override ToString() | Serializes this `Argb32Color` instance to the most appropriate CSS function notation depending on translucency |
| operator == | Compares two `Argb32Color` colors and returns a boolean indicating if the two do match. (2 operators) |
| explicit operator | Explicitly casts the 32-bit `Argb32Color` to 24-bit `Rgb24Color`. Alpha channel of the source `Argb32Color` will be lost after casting, because `Rgb24Color` does not support transparency. |
| implicit operator | Implicitly casts the 24-bit `Rgb24Color` to 32-bit `Argb32Color`. Alpha channel of the output `Argb32Color` will be set to `255` - fully opaque. |
| operator != | Compares two `Argb32Color` colors and returns a boolean indicating if the two do not match. (2 operators) |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | Returns an empty color, which has no channels info and is fully transparent. Same as '`Transparent`'. Default value. |
| static readonly Transparent | Fully transparent empty color. The same as default '`Empty`' color value. |

##### Remarks

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

### A
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/a.md

#### Argb32Color.A property

Gets the alpha part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte A { get; }
```

### Alpha
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/alpha.md

#### Argb32Color.Alpha property

Gets the alpha part of the color in percent in (0..1) range.

```csharp
public double Alpha { get; }
```

### B
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/b.md

#### Argb32Color.B property

Gets the blue part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte B { get; }
```

### Empty
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/empty.md

#### Argb32Color.Empty field

Returns an empty color, which has no channels info and is fully transparent. Same as '`Transparent`'. Default value.

```csharp
public static readonly Argb32Color Empty;
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/equals.md

#### Equals(Argb32Color)

Checks this color with specified `Argb32Color` color for equality

```csharp
public bool Equals(Argb32Color other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Argb32Color | The other `Argb32Color` color |

##### Return Value

True if both colors or equal, otherwise false.

#### Equals(Rgb24Color)

Checks this color with specified `Rgb24Color` color for equality

```csharp
public bool Equals(Rgb24Color other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Rgb24Color | The other `Rgb24Color` color |

##### Return Value

True if both colors or equal, otherwise false.

#### Equals(object)

Checks this color with specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The other uncasted color |

##### Return Value

True if both colors or equal, otherwise false.

### FromArgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/fromargb.md

#### Argb32Color.FromArgb method

Creates a `Argb32Color` instance from its 32-bit component (alpha, red, green, and blue) values, compatible with value, produced by the `System.Drawing.Color.ToArgb()` method

```csharp
public static Argb32Color FromArgb(int argb)
```

| Parameter | Type | Description |
| --- | --- | --- |
| argb | Int32 | A value specifying the 32-bit ARGB value |

##### Return Value

New `Argb32Color` value

### FromOtherWithAlpha
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/fromotherwithalpha.md

#### FromOtherWithAlpha(Argb32Color, byte)

Creates a new `Argb32Color` instance from specified, but with re-defined alpha (opacity) value

```csharp
public static Argb32Color FromOtherWithAlpha(Argb32Color other, byte newAlpha)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Argb32Color | Other `Argb32Color` instance, from which the new one will be created |
| newAlpha | Byte | Re-defined alpha channel value (255 - fully opaque, 0 - fully transparent) |

##### Return Value

New `Argb32Color` instance

#### FromOtherWithAlpha(Rgb24Color, byte)

Creates a new `Argb32Color` instance from specified `Rgb24Color`, but with specified alpha (opacity) value

```csharp
public static Argb32Color FromOtherWithAlpha(Rgb24Color other, byte newAlpha)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Rgb24Color | Other `Rgb24Color` instance, from which the new one will be created |
| newAlpha | Byte | Alpha channel value (255 - fully opaque, 0 - fully transparent) |

##### Return Value

New `Argb32Color` instance

### FromRgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/fromrgb.md

#### Argb32Color.FromRgb method

Creates one `Argb32Color` value from specified Red, Green, Blue channels, while Alpha channel is fully opaque

```csharp
public static Argb32Color FromRgb(byte red, byte green, byte blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red channel value |
| green | Byte | Green channel value |
| blue | Byte | Blue channel value |

##### Return Value

New `Argb32Color` value

### FromRgba
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/fromrgba.md

#### Argb32Color.FromRgba method

Creates one `Argb32Color` value from specified Red, Green, Blue, and Alpha channels

```csharp
public static Argb32Color FromRgba(byte red, byte green, byte blue, byte alpha)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red channel value |
| green | Byte | Green channel value |
| blue | Byte | Blue channel value |
| alpha | Byte | Alpha channel value |

##### Return Value

New `Argb32Color` value

### FromSingleValueRgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/fromsinglevaluergb.md

#### Argb32Color.FromSingleValueRgb method

Creates a fully opaque (A=255) color from single value, which will be applied to all channels

```csharp
public static Argb32Color FromSingleValueRgb(byte value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Byte | A byte value, same for Red, Green, and Blue channels |

##### Return Value

New `Argb32Color` instance

### G
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/g.md

#### Argb32Color.G property

Gets the green part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte G { get; }
```

### GetBrightness
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/getbrightness.md

#### Argb32Color.GetBrightness method

Returns the Hue-Saturation-Lightness (HSL) lightness/brightness for this `Argb32Color` instance.

```csharp
public float GetBrightness()
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/gethashcode.md

#### Argb32Color.GetHashCode method

Returns a hash code that defines the current color. Not compatible with GetHashCode

```csharp
public override int GetHashCode()
```

##### Return Value

The integer value of the hashcode. Never throws an exception.

### GetHue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/gethue.md

#### Argb32Color.GetHue method

Returns the Hue-Saturation-Lightness (HSL) hue value, in degrees, for this `Argb32Color` instance. If R == G == B, the hue is meaningless, and the return value is 0.

```csharp
public float GetHue()
```

### GetSaturation
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/getsaturation.md

#### Argb32Color.GetSaturation method

The Hue-Saturation-Lightness (HSL) saturation for this `Argb32Color` instance

```csharp
public float GetSaturation()
```

### IsDefault
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/isdefault.md

#### Argb32Color.IsDefault property

Indicates whether this `Argb32Color` instance is default (Transparent) - all 4 channels are set to 0. Same as `IsEmpty`

```csharp
public bool IsDefault { get; }
```

### IsEmpty
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/isempty.md

#### Argb32Color.IsEmpty property

Indicates whether this `Argb32Color` color instance is uninitialized - all 4 channels are set to 0. Same as Default and Transparent. Same as `IsDefault`

```csharp
public bool IsEmpty { get; }
```

### IsFullyOpaque
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/isfullyopaque.md

#### Argb32Color.IsFullyOpaque property

Indicates whether this `Argb32Color` instance is fully opaque, without transparency (its Alpha channel has max value)

```csharp
public bool IsFullyOpaque { get; }
```

### IsFullyTransparent
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/isfullytransparent.md

#### Argb32Color.IsFullyTransparent property

Indicates whether this `Argb32Color` instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect.

```csharp
public bool IsFullyTransparent { get; }
```

### IsTranslucent
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/istranslucent.md

#### Argb32Color.IsTranslucent property

Indicates whether this `Argb32Color` instance is translucent (not fully transparent, but also not fully opaque)

```csharp
public bool IsTranslucent { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/op_equality.md

#### operator ==

Compares two `Argb32Color` colors and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(Argb32Color left, Argb32Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Argb32Color | The first `Argb32Color` to check |
| right | Argb32Color | The second `Argb32Color` to check |

##### Return Value

True if both colors are equal, otherwise false.

#### operator ==

Compares one `Argb32Color` color with another `Rgb24Color` color and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(Argb32Color left, Rgb24Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Argb32Color | The first `Argb32Color` to check |
| right | Rgb24Color | The second `Rgb24Color` to check |

##### Return Value

True if both colors are equal, otherwise false.

### op_Explicit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/op_explicit.md

#### Argb32Color Explicit operator

Explicitly casts the 32-bit `Argb32Color` to 24-bit `Rgb24Color`. Alpha channel of the source `Argb32Color` will be lost after casting, because `Rgb24Color` does not support transparency.

```csharp
public static explicit operator Rgb24Color(Argb32Color argbColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| argbColor | Argb32Color | Source `Argb32Color` to cast |

### op_Implicit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/op_implicit.md

#### Argb32Color Implicit operator

Implicitly casts the 24-bit `Rgb24Color` to 32-bit `Argb32Color`. Alpha channel of the output `Argb32Color` will be set to `255` - fully opaque.

```csharp
public static implicit operator Argb32Color(Rgb24Color rgbColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| rgbColor | Rgb24Color |  |

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/op_inequality.md

#### operator !=

Compares two `Argb32Color` colors and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(Argb32Color left, Argb32Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Argb32Color | The first `Argb32Color` to check |
| right | Argb32Color | The second `Argb32Color` color to check |

##### Return Value

True if both colors are not equal, otherwise false.

#### operator !=

Compares one `Argb32Color` color with another `Rgb24Color` color and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(Argb32Color left, Rgb24Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Argb32Color | The first `Argb32Color` to check |
| right | Rgb24Color | The second `Rgb24Color` color to check |

##### Return Value

True if both colors are not equal, otherwise false.

### R
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/r.md

#### Argb32Color.R property

Gets the red part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte R { get; }
```

### ToArgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/toargb.md

#### Argb32Color.ToArgb method

Returns the ARGB value of this `Argb32Color` instance, compatible with `System.Drawing.Color.ToArgb()` method

```csharp
public int ToArgb()
```

##### Return Value

32-bit ARGB value of this instance as Int32, identical to `System.Drawing.Color.ToArgb()` call for the same color. Never throws an exception.

### ToHexRGB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/tohexrgb.md

#### Argb32Color.ToHexRGB method

Serializes this `Argb32Color` instance to the hexadecimal notation `##RRGGBB` as a string without alpha channel

```csharp
public string ToHexRGB()
```

##### Return Value

A string in `##RRGGBB` format, 2 characters per channel, upper case. Exception-less method.

### ToHexRGBA
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/tohexrgba.md

#### Argb32Color.ToHexRGBA method

Serializes this `Argb32Color` instance to the hexadecimal notation `##RRGGBBAA` as a string with alpha channel

```csharp
public string ToHexRGBA()
```

##### Return Value

A string in `##RRGGBBAA` format, 2 characters per channel, upper case. Exception-less method.

### ToRGB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/torgb.md

#### Argb32Color.ToRGB method

Serializes this `Argb32Color` instance to the 'rgb' CSS function notation. Alpha channel of this color will be omitted during serialization.

```csharp
public string ToRGB()
```

##### Return Value

A string in 'rgb(r, g, b)' format

### ToRGBA
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/torgba.md

#### Argb32Color.ToRGBA method

Serializes this `Argb32Color` instance to the 'rgba' CSS function notation

```csharp
public string ToRGBA()
```

##### Return Value

A string with 'rgba(r, g, b, a)' format

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/tostring.md

#### Argb32Color.ToString method

Serializes this `Argb32Color` instance to the most appropriate CSS function notation depending on translucency

```csharp
public override string ToString()
```

##### Return Value

A string with 'rgba(r, g, b, a)' or 'rgb(r, g, b)' format

### Transparent
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/transparent.md

#### Argb32Color.Transparent field

Fully transparent empty color. The same as default '`Empty`' color value.

```csharp
public static readonly Argb32Color Transparent;
```

### Value
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/argb32color/value.md

#### Argb32Color.Value property

Gets the Int32 value of the color as 32-bit signed integer

```csharp
public int Value { get; }
```

### Image2DFormat
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat.md

#### Image2DFormat structure

Represents most common 2D image formats, supports both raster and vector formats

```csharp
public struct Image2DFormat : IEquatable<Image2DFormat>
```

#### Properties

| Name | Description |
| --- | --- |
| static Bmp { get; } | BMP image type |
| static Emf { get; } | EMF (Enhanced MetaFile) vector image type |
| static Gif { get; } | GIF image type |
| static Icon { get; } | ICON image type |
| static Jpeg { get; } | JPEG image type |
| static Png { get; } | PNG image type |
| static Svg { get; } | SVG vector image type |
| static Tiff { get; } | TIFF (Tagged Image File Format) raster image type |
| static Undefined { get; } | Undefined image type - special value, which should not normally occur |
| static Wmf { get; } | WMF (Windows MetaFile) vector image type |
| FileExtension { get; } | File extension (without leading dot character) of a particular image type in lower case. For the `Undefined` value returns a string 'undefined'. |
| IsVector { get; } | Indicates whether this particular format is vector (`true`) or raster (`false`) |
| MimeCode { get; } | MIME code of a particular image type as a string. For the Undefined type returns a string 'unsefined'. |
| Name { get; } | Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception. |

#### Methods

| Name | Description |
| --- | --- |
| static ParseFromFilenameWithExtension(string) | Returns ImageFormat value, which is equivalent of filename extension, which is extracted from specified filename |
| static ParseFromMime(string) | Returns `Image2DFormat` value, which is equivalent of specified MIME code |
| Equals(Image2DFormat) | Determines whether this instance is equal with specified "`Image2DFormat`" instance |
| override Equals(object) | Determines whether this instance is equal with specified uncasted object, which presumably is another "`Image2DFormat`" instance |
| override GetHashCode() | Returns a hash-code, which is an immutable number for this specific instance |
| override ToString() | Returns a `Name` property |
| operator == | Defines whether two specific `Image2DFormat` instances are equal |
| operator != | Defines whether two specific `Image2DFormat` instances are not equal |

### Bmp
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/bmp.md

#### Image2DFormat.Bmp property

BMP image type

```csharp
public static Image2DFormat Bmp { get; }
```

### Emf
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/emf.md

#### Image2DFormat.Emf property

EMF (Enhanced MetaFile) vector image type

```csharp
public static Image2DFormat Emf { get; }
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/equals.md

#### Equals(Image2DFormat)

Determines whether this instance is equal with specified "`Image2DFormat`" instance

```csharp
public bool Equals(Image2DFormat other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Image2DFormat | Other `Image2DFormat` instance to check on equality with this |

##### Return Value

True if are equal, false if are unequal

#### Equals(object)

Determines whether this instance is equal with specified uncasted object, which presumably is another "`Image2DFormat`" instance

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | Other System.Object instance, that is presumably of `Image2DFormat` type, to check on equality with this |

##### Return Value

True if are equal, false if are unequal

### FileExtension
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/fileextension.md

#### Image2DFormat.FileExtension property

File extension (without leading dot character) of a particular image type in lower case. For the `Undefined` value returns a string 'undefined'.

```csharp
public string FileExtension { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/gethashcode.md

#### Image2DFormat.GetHashCode method

Returns a hash-code, which is an immutable number for this specific instance

```csharp
public override int GetHashCode()
```

##### Return Value

Signed 4-byte integer

### Gif
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/gif.md

#### Image2DFormat.Gif property

GIF image type

```csharp
public static Image2DFormat Gif { get; }
```

### Icon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/icon.md

#### Image2DFormat.Icon property

ICON image type

```csharp
public static Image2DFormat Icon { get; }
```

### IsVector
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/isvector.md

#### Image2DFormat.IsVector property

Indicates whether this particular format is vector (`true`) or raster (`false`)

```csharp
public bool IsVector { get; }
```

### Jpeg
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/jpeg.md

#### Image2DFormat.Jpeg property

JPEG image type

```csharp
public static Image2DFormat Jpeg { get; }
```

### MimeCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/mimecode.md

#### Image2DFormat.MimeCode property

MIME code of a particular image type as a string. For the Undefined type returns a string 'unsefined'.

```csharp
public string MimeCode { get; }
```

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/name.md

#### Image2DFormat.Name property

Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception.

```csharp
public string Name { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/op_equality.md

#### Image2DFormat Equality operator

Defines whether two specific `Image2DFormat` instances are equal

```csharp
public static bool operator ==(Image2DFormat first, Image2DFormat second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | Image2DFormat | First `Image2DFormat` instance to check |
| second | Image2DFormat | Second `Image2DFormat` instance to check |

##### Return Value

True if are equal, false if are unequal

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/op_inequality.md

#### Image2DFormat Inequality operator

Defines whether two specific `Image2DFormat` instances are not equal

```csharp
public static bool operator !=(Image2DFormat first, Image2DFormat second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | Image2DFormat | First `Image2DFormat` instance to check |
| second | Image2DFormat | Second `Image2DFormat` instance to check |

##### Return Value

True if are unequal, false if are equal

### ParseFromFilenameWithExtension
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/parsefromfilenamewithextension.md

#### Image2DFormat.ParseFromFilenameWithExtension method

Returns ImageFormat value, which is equivalent of filename extension, which is extracted from specified filename

```csharp
public static Image2DFormat ParseFromFilenameWithExtension(string filename)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filename | String | Arbitrary filename, can be a relative or full path |

##### Return Value

ImageFormat value. Returns `Undefined`, if extension cannot be recognized.

### ParseFromMime
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/parsefrommime.md

#### Image2DFormat.ParseFromMime method

Returns `Image2DFormat` value, which is equivalent of specified MIME code

```csharp
public static Image2DFormat ParseFromMime(string mimeCode)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mimeCode | String | Arbitrary MIME-code |

##### Return Value

`Image2DFormat` value. Returns `Undefined`, if extension cannot be recognized.

### Png
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/png.md

#### Image2DFormat.Png property

PNG image type

```csharp
public static Image2DFormat Png { get; }
```

### Svg
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/svg.md

#### Image2DFormat.Svg property

SVG vector image type

```csharp
public static Image2DFormat Svg { get; }
```

### Tiff
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/tiff.md

#### Image2DFormat.Tiff property

TIFF (Tagged Image File Format) raster image type

```csharp
public static Image2DFormat Tiff { get; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/tostring.md

#### Image2DFormat.ToString method

Returns a `Name` property

```csharp
public override string ToString()
```

### Undefined
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/undefined.md

#### Image2DFormat.Undefined property

Undefined image type - special value, which should not normally occur

```csharp
public static Image2DFormat Undefined { get; }
```

### Wmf
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/image2dformat/wmf.md

#### Image2DFormat.Wmf property

WMF (Windows MetaFile) vector image type

```csharp
public static Image2DFormat Wmf { get; }
```

### Rgb24Color.KnownColors.CssLevel1
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1.md

#### Rgb24Color.KnownColors.CssLevel1 class

Named colors, specified in the CSS level 1. All are fully opaque.

```csharp
public static class CssLevel1
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aqua | Aqua color |
| static readonly Black | Black color, default |
| static readonly Blue | Blue color |
| static readonly Fuchsia | Fuchsia color, also known as Magenta |
| static readonly Gray | Gray color |
| static readonly Green | Green color |
| static readonly Lime | Lime color, also known as Pure Green |
| static readonly Maroon | Maroon color |
| static readonly Navy | Navy color |
| static readonly Olive | Olive color |
| static readonly Purple | Purple color |
| static readonly Red | Red color |
| static readonly Silver | Silver color |
| static readonly Teal | Teal color |
| static readonly White | White color |
| static readonly Yellow | Yellow color |

##### Remarks

https://www.w3.org/TR/CSS1/#color-units

### Aqua
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/aqua.md

#### Rgb24Color.KnownColors.CssLevel1.Aqua field

Aqua color

```csharp
public static readonly Rgb24Color Aqua;
```

### Black
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/black.md

#### Rgb24Color.KnownColors.CssLevel1.Black field

Black color, default

```csharp
public static readonly Rgb24Color Black;
```

### Blue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/blue.md

#### Rgb24Color.KnownColors.CssLevel1.Blue field

Blue color

```csharp
public static readonly Rgb24Color Blue;
```

### Fuchsia
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/fuchsia.md

#### Rgb24Color.KnownColors.CssLevel1.Fuchsia field

Fuchsia color, also known as Magenta

```csharp
public static readonly Rgb24Color Fuchsia;
```

### Gray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/gray.md

#### Rgb24Color.KnownColors.CssLevel1.Gray field

Gray color

```csharp
public static readonly Rgb24Color Gray;
```

### Green
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/green.md

#### Rgb24Color.KnownColors.CssLevel1.Green field

Green color

```csharp
public static readonly Rgb24Color Green;
```

### Lime
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/lime.md

#### Rgb24Color.KnownColors.CssLevel1.Lime field

Lime color, also known as Pure Green

```csharp
public static readonly Rgb24Color Lime;
```

### Maroon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/maroon.md

#### Rgb24Color.KnownColors.CssLevel1.Maroon field

Maroon color

```csharp
public static readonly Rgb24Color Maroon;
```

### Navy
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/navy.md

#### Rgb24Color.KnownColors.CssLevel1.Navy field

Navy color

```csharp
public static readonly Rgb24Color Navy;
```

### Olive
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/olive.md

#### Rgb24Color.KnownColors.CssLevel1.Olive field

Olive color

```csharp
public static readonly Rgb24Color Olive;
```

### Purple
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/purple.md

#### Rgb24Color.KnownColors.CssLevel1.Purple field

Purple color

```csharp
public static readonly Rgb24Color Purple;
```

### Red
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/red.md

#### Rgb24Color.KnownColors.CssLevel1.Red field

Red color

```csharp
public static readonly Rgb24Color Red;
```

### Silver
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/silver.md

#### Rgb24Color.KnownColors.CssLevel1.Silver field

Silver color

```csharp
public static readonly Rgb24Color Silver;
```

### Teal
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/teal.md

#### Rgb24Color.KnownColors.CssLevel1.Teal field

Teal color

```csharp
public static readonly Rgb24Color Teal;
```

### White
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/white.md

#### Rgb24Color.KnownColors.CssLevel1.White field

White color

```csharp
public static readonly Rgb24Color White;
```

### Yellow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel1/yellow.md

#### Rgb24Color.KnownColors.CssLevel1.Yellow field

Yellow color

```csharp
public static readonly Rgb24Color Yellow;
```

### Rgb24Color.KnownColors.CssLevel2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel2.md

#### Rgb24Color.KnownColors.CssLevel2 class

Named colors, specified in the CSS level 2. All are fully opaque.

```csharp
public static class CssLevel2
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Orange | Orange color |

##### Remarks

https://www.w3.org/TR/CSS2/syndata.html#color-units

### Orange
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel2/orange.md

#### Rgb24Color.KnownColors.CssLevel2.Orange field

Orange color

```csharp
public static readonly Rgb24Color Orange;
```

### Rgb24Color.KnownColors.CssLevel3
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3.md

#### Rgb24Color.KnownColors.CssLevel3 class

Named colors, specified in the CSS Colors level 3. All are fully opaque.

```csharp
public static class CssLevel3
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Aliceblue | Alice Blue color |
| static readonly Antiquewhite | Antique White color |
| static readonly Aquamarine | Aquamarine color |
| static readonly Azure | Azure color |
| static readonly Beige | Beige color |
| static readonly Bisque | Bisque color |
| static readonly Blanchedalmond | Blanched Almond color |
| static readonly Blueviolet | Blue Violet color |
| static readonly Brown | Brown color |
| static readonly Burlywood | Burly Wood color |
| static readonly Cadetblue | Cadet Blue color |
| static readonly Chartreuse | Chart Reuse color |
| static readonly Chocolate | Chocolate color |
| static readonly Coral | Coral color |
| static readonly Cornflowerblue | Corn flower blue color |
| static readonly Cornsilk | Corn silk color |
| static readonly Crimson | Crimson color |
| static readonly Cyan | Cyan color, also known as Aqua from CssLevel1 |
| static readonly Darkblue | Dark blue color |
| static readonly Darkcyan | Dark cyan color |
| static readonly Darkgoldenrod | Dark golden rod color |
| static readonly Darkgray | Dark gray color |
| static readonly Darkgreen | Dark green color |
| static readonly Darkgrey | Dark grey color - same as Dark gray |
| static readonly Darkkhaki | Dark khaki color |
| static readonly Darkmagenta | Dark magenta color |
| static readonly Darkolivegreen | Dark olive green color |
| static readonly Darkorange | Dark orange color |
| static readonly Darkorchid | Dark orchid color |
| static readonly Darkred | Dark red color |
| static readonly Darksalmon | Dark salmon color |
| static readonly Darkseagreen | Dark sea green color |
| static readonly Darkslateblue | Dark slate blue color |
| static readonly Darkslategray | Dark slate gray color |
| static readonly Darkslategrey | Dark slate grey color - same as Dark slate gray |
| static readonly Darkturquoise | Dark turquoise color |
| static readonly Darkviolet | Dark violet color |
| static readonly Deeppink | Deep pink color |
| static readonly Deepskyblue | Deep sky blue color |
| static readonly Dimgray | Dim gray color |
| static readonly Dimgrey | Dim grey color - same as Dim gray |
| static readonly Dodgerblue | Dodger blue color |
| static readonly Firebrick | Fire brick color |
| static readonly Floralwhite | Floral white color |
| static readonly Forestgreen | Forest green color |
| static readonly Gainsboro | Gains boro color |
| static readonly Ghostwhite | Ghost white color |
| static readonly Gold | Gold color |
| static readonly Goldenrod | Goldenrod color |
| static readonly Greenyellow | Green yellow color |
| static readonly Grey | Grey color - same as Gray from CSS Level 1 |
| static readonly Honeydew | Honey dew color |
| static readonly Hotpink | Hot pink color |
| static readonly Indianred | Indian red color |
| static readonly Indigo | Indigo color |
| static readonly Ivory | Ivory color |
| static readonly Khaki | Khaki color |
| static readonly Lavender | Lavender color |
| static readonly Lavenderblush | Lavender blush color |
| static readonly Lawngreen | Lawngreen color |
| static readonly Lemonchiffon | Lemonchiffon color |
| static readonly Lightblue | Lightblue color |
| static readonly Lightcoral | Lightcoral color |
| static readonly Lightcyan | Lightcyan color |
| static readonly Lightgoldenrodyellow | Lightgoldenrodyellow color |
| static readonly Lightgray | Lightgray color - same as Lightgrey |
| static readonly Lightgreen | Lightgreen color |
| static readonly Lightgrey | Lightgrey color - same as Lightgray |
| static readonly Lightpink | Lightpink color |
| static readonly Lightsalmon | Lightsalmon color |
| static readonly Lightseagreen | Lightseagreen color |
| static readonly Lightskyblue | Lightskyblue color |
| static readonly Lightslategray | Lightslategray color - same as Lightslategrey |
| static readonly Lightslategrey | Lightslategrey color - same as Lightslategray |
| static readonly Lightsteelblue | Lightsteelblue color |
| static readonly Lightyellow | Lightyellow color |
| static readonly Limegreen | Limegreen color |
| static readonly Linen | Linen color |
| static readonly Magenta | Magenta color, also known as Fuchsia from CssLevel1 |
| static readonly Mediumaquamarine | Mediumaquamarine color |
| static readonly Mediumblue | Mediumblue color |
| static readonly Mediumorchid | Mediumorchid color |
| static readonly Mediumpurple | Mediumpurple color |
| static readonly Mediumseagreen | Mediumseagreen color |
| static readonly Mediumslateblue | Mediumslateblue color |
| static readonly Mediumspringgreen | Mediumspringgreen color |
| static readonly Mediumturquoise | Mediumturquoise color |
| static readonly Mediumvioletred | Mediumvioletred color |
| static readonly Midnightblue | Midnightblue color |
| static readonly Mintcream | Mintcream color |
| static readonly Mistyrose | Mistyrose color |
| static readonly Moccasin | Moccasin color |
| static readonly Navajowhite | Navajowhite color |
| static readonly Oldlace | Oldlace color |
| static readonly Olivedrab | Olivedrab color |
| static readonly Orangered | Orangered color |
| static readonly Orchid | Orchid color |
| static readonly Palegoldenrod | Palegoldenrod color |
| static readonly Palegreen | Palegreen color |
| static readonly Paleturquoise | Paleturquoise color |
| static readonly Palevioletred | Palevioletred color |
| static readonly Papayawhip | Papayawhip color |
| static readonly Peachpuff | Peachpuff color |
| static readonly Peru | Peru color |
| static readonly Pink | Pink color |
| static readonly Plum | Plum color |
| static readonly Powderblue | Powderblue color |
| static readonly Rosybrown | Rosybrown color |
| static readonly Royalblue | Royalblue color |
| static readonly Saddlebrown | Saddlebrown color |
| static readonly Salmon | Salmon color |
| static readonly Sandybrown | Sandybrown color |
| static readonly Seagreen | Seagreen color |
| static readonly Seashell | Seashell color |
| static readonly Sienna | Sienna color |
| static readonly Skyblue | Skyblue color |
| static readonly Slateblue | Slateblue color |
| static readonly Slategray | Slategray color - same as Slategrey |
| static readonly Slategrey | Slategrey color - same as Slategray |
| static readonly Snow | Snow color |
| static readonly Springgreen | Springgreen color |
| static readonly Steelblue | Steelblue color |
| static readonly Tan | Tan color |
| static readonly Thistle | Thistle color |
| static readonly Tomato | Tomato color |
| static readonly Turquoise | Turquoise color |
| static readonly Violet | Violet color |
| static readonly Wheat | Wheat color |
| static readonly Whitesmoke | Whitesmoke color |
| static readonly Yellowgreen | Yellowgreen color |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color#css_level_3_values https://drafts.csswg.org/css-color-3/#svg-color

### Aliceblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/aliceblue.md

#### Rgb24Color.KnownColors.CssLevel3.Aliceblue field

Alice Blue color

```csharp
public static readonly Rgb24Color Aliceblue;
```

### Antiquewhite
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/antiquewhite.md

#### Rgb24Color.KnownColors.CssLevel3.Antiquewhite field

Antique White color

```csharp
public static readonly Rgb24Color Antiquewhite;
```

### Aquamarine
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/aquamarine.md

#### Rgb24Color.KnownColors.CssLevel3.Aquamarine field

Aquamarine color

```csharp
public static readonly Rgb24Color Aquamarine;
```

### Azure
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/azure.md

#### Rgb24Color.KnownColors.CssLevel3.Azure field

Azure color

```csharp
public static readonly Rgb24Color Azure;
```

### Beige
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/beige.md

#### Rgb24Color.KnownColors.CssLevel3.Beige field

Beige color

```csharp
public static readonly Rgb24Color Beige;
```

### Bisque
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/bisque.md

#### Rgb24Color.KnownColors.CssLevel3.Bisque field

Bisque color

```csharp
public static readonly Rgb24Color Bisque;
```

### Blanchedalmond
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/blanchedalmond.md

#### Rgb24Color.KnownColors.CssLevel3.Blanchedalmond field

Blanched Almond color

```csharp
public static readonly Rgb24Color Blanchedalmond;
```

### Blueviolet
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/blueviolet.md

#### Rgb24Color.KnownColors.CssLevel3.Blueviolet field

Blue Violet color

```csharp
public static readonly Rgb24Color Blueviolet;
```

### Brown
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/brown.md

#### Rgb24Color.KnownColors.CssLevel3.Brown field

Brown color

```csharp
public static readonly Rgb24Color Brown;
```

### Burlywood
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/burlywood.md

#### Rgb24Color.KnownColors.CssLevel3.Burlywood field

Burly Wood color

```csharp
public static readonly Rgb24Color Burlywood;
```

### Cadetblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/cadetblue.md

#### Rgb24Color.KnownColors.CssLevel3.Cadetblue field

Cadet Blue color

```csharp
public static readonly Rgb24Color Cadetblue;
```

### Chartreuse
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/chartreuse.md

#### Rgb24Color.KnownColors.CssLevel3.Chartreuse field

Chart Reuse color

```csharp
public static readonly Rgb24Color Chartreuse;
```

### Chocolate
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/chocolate.md

#### Rgb24Color.KnownColors.CssLevel3.Chocolate field

Chocolate color

```csharp
public static readonly Rgb24Color Chocolate;
```

### Coral
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/coral.md

#### Rgb24Color.KnownColors.CssLevel3.Coral field

Coral color

```csharp
public static readonly Rgb24Color Coral;
```

### Cornflowerblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/cornflowerblue.md

#### Rgb24Color.KnownColors.CssLevel3.Cornflowerblue field

Corn flower blue color

```csharp
public static readonly Rgb24Color Cornflowerblue;
```

### Cornsilk
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/cornsilk.md

#### Rgb24Color.KnownColors.CssLevel3.Cornsilk field

Corn silk color

```csharp
public static readonly Rgb24Color Cornsilk;
```

### Crimson
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/crimson.md

#### Rgb24Color.KnownColors.CssLevel3.Crimson field

Crimson color

```csharp
public static readonly Rgb24Color Crimson;
```

### Cyan
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/cyan.md

#### Rgb24Color.KnownColors.CssLevel3.Cyan field

Cyan color, also known as Aqua from CssLevel1

```csharp
public static readonly Rgb24Color Cyan;
```

### Darkblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkblue.md

#### Rgb24Color.KnownColors.CssLevel3.Darkblue field

Dark blue color

```csharp
public static readonly Rgb24Color Darkblue;
```

### Darkcyan
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkcyan.md

#### Rgb24Color.KnownColors.CssLevel3.Darkcyan field

Dark cyan color

```csharp
public static readonly Rgb24Color Darkcyan;
```

### Darkgoldenrod
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkgoldenrod.md

#### Rgb24Color.KnownColors.CssLevel3.Darkgoldenrod field

Dark golden rod color

```csharp
public static readonly Rgb24Color Darkgoldenrod;
```

### Darkgray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkgray.md

#### Rgb24Color.KnownColors.CssLevel3.Darkgray field

Dark gray color

```csharp
public static readonly Rgb24Color Darkgray;
```

### Darkgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Darkgreen field

Dark green color

```csharp
public static readonly Rgb24Color Darkgreen;
```

### Darkgrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkgrey.md

#### Rgb24Color.KnownColors.CssLevel3.Darkgrey field

Dark grey color - same as Dark gray

```csharp
public static readonly Rgb24Color Darkgrey;
```

### Darkkhaki
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkkhaki.md

#### Rgb24Color.KnownColors.CssLevel3.Darkkhaki field

Dark khaki color

```csharp
public static readonly Rgb24Color Darkkhaki;
```

### Darkmagenta
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkmagenta.md

#### Rgb24Color.KnownColors.CssLevel3.Darkmagenta field

Dark magenta color

```csharp
public static readonly Rgb24Color Darkmagenta;
```

### Darkolivegreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkolivegreen.md

#### Rgb24Color.KnownColors.CssLevel3.Darkolivegreen field

Dark olive green color

```csharp
public static readonly Rgb24Color Darkolivegreen;
```

### Darkorange
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkorange.md

#### Rgb24Color.KnownColors.CssLevel3.Darkorange field

Dark orange color

```csharp
public static readonly Rgb24Color Darkorange;
```

### Darkorchid
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkorchid.md

#### Rgb24Color.KnownColors.CssLevel3.Darkorchid field

Dark orchid color

```csharp
public static readonly Rgb24Color Darkorchid;
```

### Darkred
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkred.md

#### Rgb24Color.KnownColors.CssLevel3.Darkred field

Dark red color

```csharp
public static readonly Rgb24Color Darkred;
```

### Darksalmon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darksalmon.md

#### Rgb24Color.KnownColors.CssLevel3.Darksalmon field

Dark salmon color

```csharp
public static readonly Rgb24Color Darksalmon;
```

### Darkseagreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkseagreen.md

#### Rgb24Color.KnownColors.CssLevel3.Darkseagreen field

Dark sea green color

```csharp
public static readonly Rgb24Color Darkseagreen;
```

### Darkslateblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkslateblue.md

#### Rgb24Color.KnownColors.CssLevel3.Darkslateblue field

Dark slate blue color

```csharp
public static readonly Rgb24Color Darkslateblue;
```

### Darkslategray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkslategray.md

#### Rgb24Color.KnownColors.CssLevel3.Darkslategray field

Dark slate gray color

```csharp
public static readonly Rgb24Color Darkslategray;
```

### Darkslategrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkslategrey.md

#### Rgb24Color.KnownColors.CssLevel3.Darkslategrey field

Dark slate grey color - same as Dark slate gray

```csharp
public static readonly Rgb24Color Darkslategrey;
```

### Darkturquoise
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkturquoise.md

#### Rgb24Color.KnownColors.CssLevel3.Darkturquoise field

Dark turquoise color

```csharp
public static readonly Rgb24Color Darkturquoise;
```

### Darkviolet
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/darkviolet.md

#### Rgb24Color.KnownColors.CssLevel3.Darkviolet field

Dark violet color

```csharp
public static readonly Rgb24Color Darkviolet;
```

### Deeppink
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/deeppink.md

#### Rgb24Color.KnownColors.CssLevel3.Deeppink field

Deep pink color

```csharp
public static readonly Rgb24Color Deeppink;
```

### Deepskyblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/deepskyblue.md

#### Rgb24Color.KnownColors.CssLevel3.Deepskyblue field

Deep sky blue color

```csharp
public static readonly Rgb24Color Deepskyblue;
```

### Dimgray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/dimgray.md

#### Rgb24Color.KnownColors.CssLevel3.Dimgray field

Dim gray color

```csharp
public static readonly Rgb24Color Dimgray;
```

### Dimgrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/dimgrey.md

#### Rgb24Color.KnownColors.CssLevel3.Dimgrey field

Dim grey color - same as Dim gray

```csharp
public static readonly Rgb24Color Dimgrey;
```

### Dodgerblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/dodgerblue.md

#### Rgb24Color.KnownColors.CssLevel3.Dodgerblue field

Dodger blue color

```csharp
public static readonly Rgb24Color Dodgerblue;
```

### Firebrick
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/firebrick.md

#### Rgb24Color.KnownColors.CssLevel3.Firebrick field

Fire brick color

```csharp
public static readonly Rgb24Color Firebrick;
```

### Floralwhite
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/floralwhite.md

#### Rgb24Color.KnownColors.CssLevel3.Floralwhite field

Floral white color

```csharp
public static readonly Rgb24Color Floralwhite;
```

### Forestgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/forestgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Forestgreen field

Forest green color

```csharp
public static readonly Rgb24Color Forestgreen;
```

### Gainsboro
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/gainsboro.md

#### Rgb24Color.KnownColors.CssLevel3.Gainsboro field

Gains boro color

```csharp
public static readonly Rgb24Color Gainsboro;
```

### Ghostwhite
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/ghostwhite.md

#### Rgb24Color.KnownColors.CssLevel3.Ghostwhite field

Ghost white color

```csharp
public static readonly Rgb24Color Ghostwhite;
```

### Gold
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/gold.md

#### Rgb24Color.KnownColors.CssLevel3.Gold field

Gold color

```csharp
public static readonly Rgb24Color Gold;
```

### Goldenrod
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/goldenrod.md

#### Rgb24Color.KnownColors.CssLevel3.Goldenrod field

Goldenrod color

```csharp
public static readonly Rgb24Color Goldenrod;
```

### Greenyellow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/greenyellow.md

#### Rgb24Color.KnownColors.CssLevel3.Greenyellow field

Green yellow color

```csharp
public static readonly Rgb24Color Greenyellow;
```

### Grey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/grey.md

#### Rgb24Color.KnownColors.CssLevel3.Grey field

Grey color - same as Gray from CSS Level 1

```csharp
public static readonly Rgb24Color Grey;
```

### Honeydew
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/honeydew.md

#### Rgb24Color.KnownColors.CssLevel3.Honeydew field

Honey dew color

```csharp
public static readonly Rgb24Color Honeydew;
```

### Hotpink
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/hotpink.md

#### Rgb24Color.KnownColors.CssLevel3.Hotpink field

Hot pink color

```csharp
public static readonly Rgb24Color Hotpink;
```

### Indianred
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/indianred.md

#### Rgb24Color.KnownColors.CssLevel3.Indianred field

Indian red color

```csharp
public static readonly Rgb24Color Indianred;
```

### Indigo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/indigo.md

#### Rgb24Color.KnownColors.CssLevel3.Indigo field

Indigo color

```csharp
public static readonly Rgb24Color Indigo;
```

### Ivory
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/ivory.md

#### Rgb24Color.KnownColors.CssLevel3.Ivory field

Ivory color

```csharp
public static readonly Rgb24Color Ivory;
```

### Khaki
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/khaki.md

#### Rgb24Color.KnownColors.CssLevel3.Khaki field

Khaki color

```csharp
public static readonly Rgb24Color Khaki;
```

### Lavender
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lavender.md

#### Rgb24Color.KnownColors.CssLevel3.Lavender field

Lavender color

```csharp
public static readonly Rgb24Color Lavender;
```

### Lavenderblush
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lavenderblush.md

#### Rgb24Color.KnownColors.CssLevel3.Lavenderblush field

Lavender blush color

```csharp
public static readonly Rgb24Color Lavenderblush;
```

### Lawngreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lawngreen.md

#### Rgb24Color.KnownColors.CssLevel3.Lawngreen field

Lawngreen color

```csharp
public static readonly Rgb24Color Lawngreen;
```

### Lemonchiffon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lemonchiffon.md

#### Rgb24Color.KnownColors.CssLevel3.Lemonchiffon field

Lemonchiffon color

```csharp
public static readonly Rgb24Color Lemonchiffon;
```

### Lightblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightblue.md

#### Rgb24Color.KnownColors.CssLevel3.Lightblue field

Lightblue color

```csharp
public static readonly Rgb24Color Lightblue;
```

### Lightcoral
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightcoral.md

#### Rgb24Color.KnownColors.CssLevel3.Lightcoral field

Lightcoral color

```csharp
public static readonly Rgb24Color Lightcoral;
```

### Lightcyan
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightcyan.md

#### Rgb24Color.KnownColors.CssLevel3.Lightcyan field

Lightcyan color

```csharp
public static readonly Rgb24Color Lightcyan;
```

### Lightgoldenrodyellow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightgoldenrodyellow.md

#### Rgb24Color.KnownColors.CssLevel3.Lightgoldenrodyellow field

Lightgoldenrodyellow color

```csharp
public static readonly Rgb24Color Lightgoldenrodyellow;
```

### Lightgray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightgray.md

#### Rgb24Color.KnownColors.CssLevel3.Lightgray field

Lightgray color - same as Lightgrey

```csharp
public static readonly Rgb24Color Lightgray;
```

### Lightgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Lightgreen field

Lightgreen color

```csharp
public static readonly Rgb24Color Lightgreen;
```

### Lightgrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightgrey.md

#### Rgb24Color.KnownColors.CssLevel3.Lightgrey field

Lightgrey color - same as Lightgray

```csharp
public static readonly Rgb24Color Lightgrey;
```

### Lightpink
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightpink.md

#### Rgb24Color.KnownColors.CssLevel3.Lightpink field

Lightpink color

```csharp
public static readonly Rgb24Color Lightpink;
```

### Lightsalmon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightsalmon.md

#### Rgb24Color.KnownColors.CssLevel3.Lightsalmon field

Lightsalmon color

```csharp
public static readonly Rgb24Color Lightsalmon;
```

### Lightseagreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightseagreen.md

#### Rgb24Color.KnownColors.CssLevel3.Lightseagreen field

Lightseagreen color

```csharp
public static readonly Rgb24Color Lightseagreen;
```

### Lightskyblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightskyblue.md

#### Rgb24Color.KnownColors.CssLevel3.Lightskyblue field

Lightskyblue color

```csharp
public static readonly Rgb24Color Lightskyblue;
```

### Lightslategray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightslategray.md

#### Rgb24Color.KnownColors.CssLevel3.Lightslategray field

Lightslategray color - same as Lightslategrey

```csharp
public static readonly Rgb24Color Lightslategray;
```

### Lightslategrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightslategrey.md

#### Rgb24Color.KnownColors.CssLevel3.Lightslategrey field

Lightslategrey color - same as Lightslategray

```csharp
public static readonly Rgb24Color Lightslategrey;
```

### Lightsteelblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightsteelblue.md

#### Rgb24Color.KnownColors.CssLevel3.Lightsteelblue field

Lightsteelblue color

```csharp
public static readonly Rgb24Color Lightsteelblue;
```

### Lightyellow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/lightyellow.md

#### Rgb24Color.KnownColors.CssLevel3.Lightyellow field

Lightyellow color

```csharp
public static readonly Rgb24Color Lightyellow;
```

### Limegreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/limegreen.md

#### Rgb24Color.KnownColors.CssLevel3.Limegreen field

Limegreen color

```csharp
public static readonly Rgb24Color Limegreen;
```

### Linen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/linen.md

#### Rgb24Color.KnownColors.CssLevel3.Linen field

Linen color

```csharp
public static readonly Rgb24Color Linen;
```

### Magenta
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/magenta.md

#### Rgb24Color.KnownColors.CssLevel3.Magenta field

Magenta color, also known as Fuchsia from CssLevel1

```csharp
public static readonly Rgb24Color Magenta;
```

### Mediumaquamarine
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumaquamarine.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumaquamarine field

Mediumaquamarine color

```csharp
public static readonly Rgb24Color Mediumaquamarine;
```

### Mediumblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumblue.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumblue field

Mediumblue color

```csharp
public static readonly Rgb24Color Mediumblue;
```

### Mediumorchid
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumorchid.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumorchid field

Mediumorchid color

```csharp
public static readonly Rgb24Color Mediumorchid;
```

### Mediumpurple
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumpurple.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumpurple field

Mediumpurple color

```csharp
public static readonly Rgb24Color Mediumpurple;
```

### Mediumseagreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumseagreen.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumseagreen field

Mediumseagreen color

```csharp
public static readonly Rgb24Color Mediumseagreen;
```

### Mediumslateblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumslateblue.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumslateblue field

Mediumslateblue color

```csharp
public static readonly Rgb24Color Mediumslateblue;
```

### Mediumspringgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumspringgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumspringgreen field

Mediumspringgreen color

```csharp
public static readonly Rgb24Color Mediumspringgreen;
```

### Mediumturquoise
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumturquoise.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumturquoise field

Mediumturquoise color

```csharp
public static readonly Rgb24Color Mediumturquoise;
```

### Mediumvioletred
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mediumvioletred.md

#### Rgb24Color.KnownColors.CssLevel3.Mediumvioletred field

Mediumvioletred color

```csharp
public static readonly Rgb24Color Mediumvioletred;
```

### Midnightblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/midnightblue.md

#### Rgb24Color.KnownColors.CssLevel3.Midnightblue field

Midnightblue color

```csharp
public static readonly Rgb24Color Midnightblue;
```

### Mintcream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mintcream.md

#### Rgb24Color.KnownColors.CssLevel3.Mintcream field

Mintcream color

```csharp
public static readonly Rgb24Color Mintcream;
```

### Mistyrose
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/mistyrose.md

#### Rgb24Color.KnownColors.CssLevel3.Mistyrose field

Mistyrose color

```csharp
public static readonly Rgb24Color Mistyrose;
```

### Moccasin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/moccasin.md

#### Rgb24Color.KnownColors.CssLevel3.Moccasin field

Moccasin color

```csharp
public static readonly Rgb24Color Moccasin;
```

### Navajowhite
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/navajowhite.md

#### Rgb24Color.KnownColors.CssLevel3.Navajowhite field

Navajowhite color

```csharp
public static readonly Rgb24Color Navajowhite;
```

### Oldlace
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/oldlace.md

#### Rgb24Color.KnownColors.CssLevel3.Oldlace field

Oldlace color

```csharp
public static readonly Rgb24Color Oldlace;
```

### Olivedrab
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/olivedrab.md

#### Rgb24Color.KnownColors.CssLevel3.Olivedrab field

Olivedrab color

```csharp
public static readonly Rgb24Color Olivedrab;
```

### Orangered
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/orangered.md

#### Rgb24Color.KnownColors.CssLevel3.Orangered field

Orangered color

```csharp
public static readonly Rgb24Color Orangered;
```

### Orchid
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/orchid.md

#### Rgb24Color.KnownColors.CssLevel3.Orchid field

Orchid color

```csharp
public static readonly Rgb24Color Orchid;
```

### Palegoldenrod
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/palegoldenrod.md

#### Rgb24Color.KnownColors.CssLevel3.Palegoldenrod field

Palegoldenrod color

```csharp
public static readonly Rgb24Color Palegoldenrod;
```

### Palegreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/palegreen.md

#### Rgb24Color.KnownColors.CssLevel3.Palegreen field

Palegreen color

```csharp
public static readonly Rgb24Color Palegreen;
```

### Paleturquoise
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/paleturquoise.md

#### Rgb24Color.KnownColors.CssLevel3.Paleturquoise field

Paleturquoise color

```csharp
public static readonly Rgb24Color Paleturquoise;
```

### Palevioletred
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/palevioletred.md

#### Rgb24Color.KnownColors.CssLevel3.Palevioletred field

Palevioletred color

```csharp
public static readonly Rgb24Color Palevioletred;
```

### Papayawhip
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/papayawhip.md

#### Rgb24Color.KnownColors.CssLevel3.Papayawhip field

Papayawhip color

```csharp
public static readonly Rgb24Color Papayawhip;
```

### Peachpuff
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/peachpuff.md

#### Rgb24Color.KnownColors.CssLevel3.Peachpuff field

Peachpuff color

```csharp
public static readonly Rgb24Color Peachpuff;
```

### Peru
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/peru.md

#### Rgb24Color.KnownColors.CssLevel3.Peru field

Peru color

```csharp
public static readonly Rgb24Color Peru;
```

### Pink
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/pink.md

#### Rgb24Color.KnownColors.CssLevel3.Pink field

Pink color

```csharp
public static readonly Rgb24Color Pink;
```

### Plum
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/plum.md

#### Rgb24Color.KnownColors.CssLevel3.Plum field

Plum color

```csharp
public static readonly Rgb24Color Plum;
```

### Powderblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/powderblue.md

#### Rgb24Color.KnownColors.CssLevel3.Powderblue field

Powderblue color

```csharp
public static readonly Rgb24Color Powderblue;
```

### Rosybrown
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/rosybrown.md

#### Rgb24Color.KnownColors.CssLevel3.Rosybrown field

Rosybrown color

```csharp
public static readonly Rgb24Color Rosybrown;
```

### Royalblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/royalblue.md

#### Rgb24Color.KnownColors.CssLevel3.Royalblue field

Royalblue color

```csharp
public static readonly Rgb24Color Royalblue;
```

### Saddlebrown
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/saddlebrown.md

#### Rgb24Color.KnownColors.CssLevel3.Saddlebrown field

Saddlebrown color

```csharp
public static readonly Rgb24Color Saddlebrown;
```

### Salmon
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/salmon.md

#### Rgb24Color.KnownColors.CssLevel3.Salmon field

Salmon color

```csharp
public static readonly Rgb24Color Salmon;
```

### Sandybrown
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/sandybrown.md

#### Rgb24Color.KnownColors.CssLevel3.Sandybrown field

Sandybrown color

```csharp
public static readonly Rgb24Color Sandybrown;
```

### Seagreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/seagreen.md

#### Rgb24Color.KnownColors.CssLevel3.Seagreen field

Seagreen color

```csharp
public static readonly Rgb24Color Seagreen;
```

### Seashell
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/seashell.md

#### Rgb24Color.KnownColors.CssLevel3.Seashell field

Seashell color

```csharp
public static readonly Rgb24Color Seashell;
```

### Sienna
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/sienna.md

#### Rgb24Color.KnownColors.CssLevel3.Sienna field

Sienna color

```csharp
public static readonly Rgb24Color Sienna;
```

### Skyblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/skyblue.md

#### Rgb24Color.KnownColors.CssLevel3.Skyblue field

Skyblue color

```csharp
public static readonly Rgb24Color Skyblue;
```

### Slateblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/slateblue.md

#### Rgb24Color.KnownColors.CssLevel3.Slateblue field

Slateblue color

```csharp
public static readonly Rgb24Color Slateblue;
```

### Slategray
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/slategray.md

#### Rgb24Color.KnownColors.CssLevel3.Slategray field

Slategray color - same as Slategrey

```csharp
public static readonly Rgb24Color Slategray;
```

### Slategrey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/slategrey.md

#### Rgb24Color.KnownColors.CssLevel3.Slategrey field

Slategrey color - same as Slategray

```csharp
public static readonly Rgb24Color Slategrey;
```

### Snow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/snow.md

#### Rgb24Color.KnownColors.CssLevel3.Snow field

Snow color

```csharp
public static readonly Rgb24Color Snow;
```

### Springgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/springgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Springgreen field

Springgreen color

```csharp
public static readonly Rgb24Color Springgreen;
```

### Steelblue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/steelblue.md

#### Rgb24Color.KnownColors.CssLevel3.Steelblue field

Steelblue color

```csharp
public static readonly Rgb24Color Steelblue;
```

### Tan
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/tan.md

#### Rgb24Color.KnownColors.CssLevel3.Tan field

Tan color

```csharp
public static readonly Rgb24Color Tan;
```

### Thistle
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/thistle.md

#### Rgb24Color.KnownColors.CssLevel3.Thistle field

Thistle color

```csharp
public static readonly Rgb24Color Thistle;
```

### Tomato
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/tomato.md

#### Rgb24Color.KnownColors.CssLevel3.Tomato field

Tomato color

```csharp
public static readonly Rgb24Color Tomato;
```

### Turquoise
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/turquoise.md

#### Rgb24Color.KnownColors.CssLevel3.Turquoise field

Turquoise color

```csharp
public static readonly Rgb24Color Turquoise;
```

### Violet
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/violet.md

#### Rgb24Color.KnownColors.CssLevel3.Violet field

Violet color

```csharp
public static readonly Rgb24Color Violet;
```

### Wheat
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/wheat.md

#### Rgb24Color.KnownColors.CssLevel3.Wheat field

Wheat color

```csharp
public static readonly Rgb24Color Wheat;
```

### Whitesmoke
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/whitesmoke.md

#### Rgb24Color.KnownColors.CssLevel3.Whitesmoke field

Whitesmoke color

```csharp
public static readonly Rgb24Color Whitesmoke;
```

### Yellowgreen
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel3/yellowgreen.md

#### Rgb24Color.KnownColors.CssLevel3.Yellowgreen field

Yellowgreen color

```csharp
public static readonly Rgb24Color Yellowgreen;
```

### Rgb24Color.KnownColors.CssLevel4
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel4.md

#### Rgb24Color.KnownColors.CssLevel4 class

Named colors, specified in the CSS Colors level 4. All are fully opaque.

```csharp
public static class CssLevel4
```

#### Fields

| Name | Description |
| --- | --- |
| static readonly Rebeccapurple | Rebecca Purple color |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color#css_level_4_values https://drafts.csswg.org/css-color-4/#changes-from-3

### Rebeccapurple
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.csslevel4/rebeccapurple.md

#### Rgb24Color.KnownColors.CssLevel4.Rebeccapurple field

Rebecca Purple color

```csharp
public static readonly Rgb24Color Rebeccapurple;
```

##### Remarks

CSS Colors Level 4 added the '**rebeccapurple**' keyword to honor web pioneer Eric Meyer: https://codepen.io/trezy/post/honoring-a-great-man

### Rgb24Color.KnownColors
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors.md

#### Rgb24Color.KnownColors class

Contains all "known colors", that have fixed unique name and value in CSS standart

```csharp
public static class KnownColors
```

#### Methods

| Name | Description |
| --- | --- |
| static TryFindColor(string, out Rgb24Color) | Tries to find a color by its string name |
| static TryFindName(Rgb24Color, out string) | Tries to find a color name by specified color within a named colors collection |

#### Other Members

| Name | Description |
| --- | --- |
| static class CssLevel1 | Named colors, specified in the CSS level 1. All are fully opaque. |
| static class CssLevel2 | Named colors, specified in the CSS level 2. All are fully opaque. |
| static class CssLevel3 | Named colors, specified in the CSS Colors level 3. All are fully opaque. |
| static class CssLevel4 | Named colors, specified in the CSS Colors level 4. All are fully opaque. |

##### Remarks

See also: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color

### TryFindColor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors/tryfindcolor.md

#### Rgb24Color.KnownColors.TryFindColor method

Tries to find a color by its string name

```csharp
public static bool TryFindColor(string keyword, out Rgb24Color output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| keyword | String | A color name |
| output | Rgb24Color& | The resultant color value on success or `Black` value on failure |

##### Return Value

True if color was successfully found by its name, or false otherwise

### TryFindName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.knowncolors/tryfindname.md

#### Rgb24Color.KnownColors.TryFindName method

Tries to find a color name by specified color within a named colors collection

```csharp
public static bool TryFindName(Rgb24Color color, out string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| color | Rgb24Color | A color instance |
| name | String& | The resultant color name on success or `null` on failure |

##### Return Value

True if name was successfully found for the given color, or false otherwise

### Rgb24Color
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color.md

#### Rgb24Color structure

Represents 24-bit color in RGB format, with 8 bits per every channel (Red, Green, Blue). Does not support transparency.

```csharp
public struct Rgb24Color : IEquatable<Argb32Color>, IEquatable<Rgb24Color>
```

#### Properties

| Name | Description |
| --- | --- |
| B { get; } | Gets the blue part of the color as 8-bit unsigned integer [0..255] |
| G { get; } | Gets the green part of the color as 8-bit unsigned integer [0..255] |
| IsDefault { get; } | Indicates whether this `Rgb24Color` instance is default (Black) - all 3 channels are set to 0. |
| R { get; } | Gets the red part of the color as 8-bit unsigned integer [0..255] |

#### Methods

| Name | Description |
| --- | --- |
| static FromRgb(byte, byte, byte) | Creates one `Rgb24Color` value from specified Red, Green, Blue channels |
| Equals(Argb32Color) | Checks this color with specified `Argb32Color` color for equality |
| override Equals(object) | Checks this color with specified uncasted |
| Equals(Rgb24Color) | Checks this color with specified `Rgb24Color` color for equality |
| GetBrightness() | Returns the Hue-Saturation-Lightness (HSL) lightness/brightness for this `Rgb24Color` instance. |
| override GetHashCode() | Returns a hash code that defines the current color. Not compatible with GetHashCode |
| GetHue() | Returns the Hue-Saturation-Lightness (HSL) hue value, in degrees, for this `Rgb24Color` instance. If R == G == B, the hue is meaningless, and the return value is 0. |
| GetSaturation() | The Hue-Saturation-Lightness (HSL) saturation for this `Rgb24Color` instance |
| ToArgb() | Returns the ARGB value of this `Rgb24Color` instance, compatible with Color |
| ToHex() | Returns this color in hexadecimal string representation |
| ToRGB() | Serializes this `Rgb24Color` instance to the 'rgb' CSS function notation. |
| override ToString() | Serializes this `Rgb24Color` instance to 'rgb(r, g, b)' format |
| operator == | Compares two `Rgb24Color` colors and returns a boolean indicating if the two do match. (2 operators) |
| operator != | Compares two `Rgb24Color` colors and returns a boolean indicating if the two do not match. (2 operators) |

#### Other Members

| Name | Description |
| --- | --- |
| static class KnownColors | Contains all "known colors", that have fixed unique name and value in CSS standart |

##### Remarks

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

### B
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/b.md

#### Rgb24Color.B property

Gets the blue part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte B { get; }
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/equals.md

#### Equals(Argb32Color)

Checks this color with specified `Argb32Color` color for equality

```csharp
public bool Equals(Argb32Color other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Argb32Color | The other `Argb32Color` color |

##### Return Value

True if both colors or equal, otherwise false.

#### Equals(Rgb24Color)

Checks this color with specified `Rgb24Color` color for equality

```csharp
public bool Equals(Rgb24Color other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Rgb24Color | The other `Rgb24Color` color |

##### Return Value

True if both colors or equal, otherwise false.

#### Equals(object)

Checks this color with specified uncasted

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The other uncasted color |

##### Return Value

True if both colors or equal, otherwise false.

### FromRgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/fromrgb.md

#### Rgb24Color.FromRgb method

Creates one `Rgb24Color` value from specified Red, Green, Blue channels

```csharp
public static Rgb24Color FromRgb(byte red, byte green, byte blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Byte | Red channel value |
| green | Byte | Green channel value |
| blue | Byte | Blue channel value |

##### Return Value

New `Rgb24Color` value

### G
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/g.md

#### Rgb24Color.G property

Gets the green part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte G { get; }
```

### GetBrightness
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/getbrightness.md

#### Rgb24Color.GetBrightness method

Returns the Hue-Saturation-Lightness (HSL) lightness/brightness for this `Rgb24Color` instance.

```csharp
public float GetBrightness()
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/gethashcode.md

#### Rgb24Color.GetHashCode method

Returns a hash code that defines the current color. Not compatible with GetHashCode

```csharp
public override int GetHashCode()
```

##### Return Value

The integer value of the hashcode. Never throws an exception.

### GetHue
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/gethue.md

#### Rgb24Color.GetHue method

Returns the Hue-Saturation-Lightness (HSL) hue value, in degrees, for this `Rgb24Color` instance. If R == G == B, the hue is meaningless, and the return value is 0.

```csharp
public float GetHue()
```

### GetSaturation
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/getsaturation.md

#### Rgb24Color.GetSaturation method

The Hue-Saturation-Lightness (HSL) saturation for this `Rgb24Color` instance

```csharp
public float GetSaturation()
```

### IsDefault
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/isdefault.md

#### Rgb24Color.IsDefault property

Indicates whether this `Rgb24Color` instance is default (Black) - all 3 channels are set to 0.

```csharp
public bool IsDefault { get; }
```

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/op_equality.md

#### operator ==

Compares two `Rgb24Color` colors and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(Rgb24Color left, Rgb24Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rgb24Color | The first `Rgb24Color` to check |
| right | Rgb24Color | The second `Rgb24Color` to check |

##### Return Value

True if both colors are equal, otherwise false.

#### operator ==

Compares one `Rgb24Color` color with another `Argb32Color` color and returns a boolean indicating if the two do match.

```csharp
public static bool operator ==(Rgb24Color left, Argb32Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rgb24Color | The first `Rgb24Color` to check |
| right | Argb32Color | The second `Argb32Color` to check |

##### Return Value

True if both colors are equal, otherwise false.

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/op_inequality.md

#### operator !=

Compares two `Rgb24Color` colors and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(Rgb24Color left, Rgb24Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rgb24Color | The first `Rgb24Color` to check |
| right | Rgb24Color | The second `Rgb24Color` color to check |

##### Return Value

True if both colors are not equal, otherwise false.

#### operator !=

Compares one `Rgb24Color` color with another `Argb32Color` color and returns a boolean indicating if the two do not match.

```csharp
public static bool operator !=(Rgb24Color left, Argb32Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Rgb24Color | The first `Rgb24Color` to check |
| right | Argb32Color | The second `Argb32Color` color to check |

##### Return Value

True if both colors are not equal, otherwise false.

### R
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/r.md

#### Rgb24Color.R property

Gets the red part of the color as 8-bit unsigned integer [0..255]

```csharp
public byte R { get; }
```

### ToArgb
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/toargb.md

#### Rgb24Color.ToArgb method

Returns the ARGB value of this `Rgb24Color` instance, compatible with Color

```csharp
public int ToArgb()
```

##### Return Value

32-bit ARGB value of this instance as Int32, the identical to ToArgb call for the same color. Never throws an exception.

### ToHex
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/tohex.md

#### Rgb24Color.ToHex method

Returns this color in hexadecimal string representation

```csharp
public string ToHex()
```

##### Return Value

Color hex representation string

##### Examples

Returns "#FF0000" for `Red`

### ToRGB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/torgb.md

#### Rgb24Color.ToRGB method

Serializes this `Rgb24Color` instance to the 'rgb' CSS function notation.

```csharp
public string ToRGB()
```

##### Return Value

A string in 'rgb(r, g, b)' format

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.drawing/rgb24color/tostring.md

#### Rgb24Color.ToString method

Serializes this `Rgb24Color` instance to 'rgb(r, g, b)' format

```csharp
public override string ToString()
```

##### Return Value

A string with 'rgb(r, g, b)' format

### GroupDocs.Viewer.Exceptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions.md

The namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| GroupDocsViewerException | Represents the generic errors that occur during document processing. |
| IncorrectPasswordException | The exception that is thrown when specified password is incorrect. |
| 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 unexpected and/or unsupported 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 and/or unsupported format or not an image at all. |
| PasswordRequiredException | The exception that is thrown when password is required to load the document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### GroupDocsViewerException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/groupdocsviewerexception.md

#### GroupDocsViewerException class

Represents the generic errors that occur during document processing.

```csharp
public class GroupDocsViewerException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| GroupDocsViewerException(string) | Initializes a new instance of the `GroupDocsViewerException` class with a specified error message. |

### GroupDocsViewerException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/groupdocsviewerexception/groupdocsviewerexception.md

#### GroupDocsViewerException constructor

Initializes a new instance of the `GroupDocsViewerException` class with a specified error message.

```csharp
public GroupDocsViewerException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

### IncorrectPasswordException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

```csharp
public class IncorrectPasswordException : GroupDocsViewerException
```

### InvalidFontFormatException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/invalidfontformatexception.md

#### InvalidFontFormatException class

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 unexpected and/or unsupported format or not a font at all.

```csharp
public class InvalidFontFormatException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidFontFormatException(string) | Creates new instance of `InvalidFontFormatException` with specified error message |
| InvalidFontFormatException(string, Exception) | Creates new instance of `InvalidFontFormatException` with specified error message and a reference to the inner exception that is the cause of this exception |

### InvalidFontFormatException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/invalidfontformatexception/invalidfontformatexception.md

#### InvalidFontFormatException(string)

Creates new instance of `InvalidFontFormatException` with specified error message

```csharp
public InvalidFontFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |

#### InvalidFontFormatException(string, Exception)

Creates new instance of `InvalidFontFormatException` with specified error message and a reference to the inner exception that is the cause of this exception

```csharp
public InvalidFontFormatException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |
| innerException | Exception | 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/viewer/net/groupdocs.viewer.exceptions/invalidimageformatexception.md

#### InvalidImageFormatException class

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 and/or unsupported format or not an image at all.

```csharp
public class InvalidImageFormatException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidImageFormatException(string) | Creates new instance of `InvalidImageFormatException` with specified error message |
| InvalidImageFormatException(string, Exception) | Creates new instance of `InvalidImageFormatException` with specified error message and a reference to the inner exception that is the cause of this exception |

### InvalidImageFormatException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/invalidimageformatexception/invalidimageformatexception.md

#### InvalidImageFormatException(string)

Creates new instance of `InvalidImageFormatException` with specified error message

```csharp
public InvalidImageFormatException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |

#### InvalidImageFormatException(string, Exception)

Creates new instance of `InvalidImageFormatException` with specified error message and a reference to the inner exception that is the cause of this exception

```csharp
public InvalidImageFormatException(string message, Exception innerException)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | Textual message, that describes the error, can be null or empty |
| innerException | Exception | The exception that is the cause of the current exception, or a null reference if no inner exception is specified. |

### PasswordRequiredException
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

```csharp
public class PasswordRequiredException : GroupDocsViewerException
```

### GroupDocs.Viewer.Fonts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts.md

The namespace provides classes and enumerations to manage fonts used during rendering process.

#### Classes

| Class | Description |
| --- | --- |
| FolderFontSource | Represents the folder that contains TrueType fonts. |
| FontSettings | Provides methods for working with sources to look for TrueType fonts. |
#### Structures

| Structure | Description |
| --- | --- |
| FontStyles | Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic |
| PdfFontInfo | Encapsulates metainfo and binary data of one font from the PDF document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running. |
| PresentationFontInfo | Encapsulates metainfo and binary data of one font from the Presentation document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running. |
| SpreadsheetFontInfo | Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the `Viewer` instance. Spreadsheet documents cannot have embedded fonts, so this particular font, if was returned by the `GetAllFonts` method, is installed in the operating system, where the GroupDocs.Viewer is running. |
| WordProcessingFontInfo | Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running. |
| WordProcessingSubstitutedFontInfo | Encapsulates metainfo and binary data of one font from WordProcessing document, which originally is not used in the loaded into the `Viewer` instance document, but serves as a substitution font for those, which cannot be found on the target machine. Substituted fonts exist only for the WordProcessing formats family. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IFontInfo | Common interface for all fonts, which can be extracted from all supported families of document formats: PDF, WordProcessing, Spreadsheet, and Presentation. |
| IFontSource | Marker interface for the font sources. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FontFormat | Represents all font formats, which may be present in the `IFontInfo` inheritors |
| SearchOption | Specifies whether to search the current folder, or the current folder and all subfolders. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### FolderFontSource
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource.md

#### FolderFontSource class

Represents the folder that contains TrueType fonts.

```csharp
public sealed class FolderFontSource : IEquatable<FolderFontSource>, IFontSource
```

#### Constructors

| Name | Description |
| --- | --- |
| FolderFontSource(string, SearchOption) | Initializes new instance of `FolderFontSource` class. |

#### Properties

| Name | Description |
| --- | --- |
| FolderPath { get; } | Path to the folder that contains TrueType fonts. |
| SearchOption { get; } | Specifies whether to search the current folder, or the current folder and all subfolders. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FolderFontSource) | Determines whether the current `FolderFontSource` is the same as specified `FolderFontSource` object. |
| override Equals(object) | Determines whether the current `FolderFontSource` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FolderFontSource` object. |
| override ToString() | Returns a string that represents the current object. |
| operator == | Determines whether two `FolderFontSource` objects are the same. |
| operator != | Determines whether two `FolderFontSource` objects are not the same. |

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/equals.md

#### Equals(FolderFontSource)

Determines whether the current `FolderFontSource` is the same as specified `FolderFontSource` object.

```csharp
public bool Equals(FolderFontSource other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FolderFontSource | The object to compare with the current `FolderFontSource` object. |

##### Return Value

```csharp
true
```

if both `FolderFontSource` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FolderFontSource` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FolderFontSource` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FolderFontSource` and is the same as current `FolderFontSource` object; otherwise,

```csharp
false
```

### FolderFontSource
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/folderfontsource.md

#### FolderFontSource constructor

Initializes new instance of `FolderFontSource` class.

```csharp
public FolderFontSource(string folderPath, SearchOption searchOption)
```

| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | String | Path to the folder that contains TrueType fonts. |
| searchOption | SearchOption | Specifies whether to search the current folder, or the current folder and all sub-folders. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *folderPath* is null. |
| DirectoryNotFoundException | Thrown when path specified in *folderPath* can't be located. |

### FolderPath
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/folderpath.md

#### FolderFontSource.FolderPath property

Path to the folder that contains TrueType fonts.

```csharp
public string FolderPath { get; }
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/gethashcode.md

#### FolderFontSource.GetHashCode method

Returns the hash code for the current `FolderFontSource` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FolderFontSource` object.

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/op_equality.md

#### FolderFontSource Equality operator

Determines whether two `FolderFontSource` objects are the same.

```csharp
public static bool operator ==(FolderFontSource left, FolderFontSource right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | Left `FolderFontSource` object. |
| right | FolderFontSource | Right `FolderFontSource` object. |

##### Return Value

```csharp
true
```

if both `FolderFontSource` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/op_inequality.md

#### FolderFontSource Inequality operator

Determines whether two `FolderFontSource` objects are not the same.

```csharp
public static bool operator !=(FolderFontSource left, FolderFontSource right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | Left `FolderFontSource` object. |
| right | FolderFontSource | Right `FolderFontSource` object. |

##### Return Value

```csharp
true
```

if both `FolderFontSource` objects are not the same; otherwise,

```csharp
false
```

### SearchOption
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/searchoption.md

#### FolderFontSource.SearchOption property

Specifies whether to search the current folder, or the current folder and all subfolders.

```csharp
public SearchOption SearchOption { get; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/folderfontsource/tostring.md

#### FolderFontSource.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### FontFormat
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontformat.md

#### FontFormat enumeration

Represents all font formats, which may be present in the `IFontInfo` inheritors

```csharp
public enum FontFormat : byte
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Unknown or invalid font format |
| TrueType | `1` | TrueType font format (TTF) |
| OpenType | `2` | OpenType font format (OTF) |
| TrueTypeCollection | `3` | TrueType Collection font format (TTC) |
| EmbeddedOpenType | `4` | Embedded OpenType font format (EOT) |

### FontSettings
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontsettings.md

#### FontSettings class

Provides methods for working with sources to look for TrueType fonts.

```csharp
public static class FontSettings
```

#### Methods

| Name | Description |
| --- | --- |
| static ResetFontSources() | Resets font sources that have been set before. |
| static SetFontSources(params IFontSource[]) | Set the sources to look for TrueType fonts when rendering documents. |

### ResetFontSources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontsettings/resetfontsources.md

#### FontSettings.ResetFontSources method

Resets font sources that have been set before.

```csharp
public static void ResetFontSources()
```

### SetFontSources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontsettings/setfontsources.md

#### FontSettings.SetFontSources method

Set the sources to look for TrueType fonts when rendering documents.

```csharp
public static void SetFontSources(params IFontSource[] fontSources)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontSources | IFontSource[] | The font sources. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fontSources* is null. |

### FontStyles
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles.md

#### FontStyles structure

Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic

```csharp
public struct FontStyles : IEquatable<FontStyles>
```

#### Constructors

| Name | Description |
| --- | --- |
| FontStyles(bool, bool) | Creates one `FontStyles` instance from specified bold and italic flags |

#### Properties

| Name | Description |
| --- | --- |
| IsBold { get; } | Indicates whether this `FontStyles` instance has a **bold** flag enabled (`true`) or disabled (`false`) |
| IsItalic { get; } | Indicates whether this `FontStyles` instance has an **italic** flag enabled (`true`) or disabled (`false`) |
| Name { get; } | Name of this font style |

#### Methods

| Name | Description |
| --- | --- |
| Equals(FontStyles) | Indicates whether this `FontStyles` instance is equal to specified |
| override Equals(object) | Indicates whether this `FontStyles` instance is equal to specified uncasted |
| override GetHashCode() | Returns a hash-code of this instance |
| override ToString() | Returns a name of this font style, same as `Name` |
| static TryParse(string, out FontStyles) | Tries to parse specified raw string as a font style name |
| operator + | Combines (merges) two specified font styles and produces new resultant font style, where flags are merged (union) |
| operator == | Checks whether two `FontStyles` values are equal |
| explicit operator | Casts specified `FontStyles` instance to the equivalint octet (8-bit bitfield) in [0..3] decimal range |
| operator != | Checks whether two `FontStyles` values are not equal |
| operator - | Subtracts second (subtrahend) specified font style from the first (minuend) specified font style and produces new resultant font style, where are present only those flags from the first operand, which are not found in the second operand (difference) |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Bold | Bold font style (bold only, without italic) |
| static readonly BoldItalic | BoldItalic font style (bold and italic together) |
| static readonly Italic | Italic font style (italic only, without bold) |
| static readonly Regular | Regular font style, default value (no bold and italic) |

##### Remarks

Immutable struct with convenient API and combining operations

### Bold
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/bold.md

#### FontStyles.Bold field

Bold font style (bold only, without italic)

```csharp
public static readonly FontStyles Bold;
```

### BoldItalic
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/bolditalic.md

#### FontStyles.BoldItalic field

BoldItalic font style (bold and italic together)

```csharp
public static readonly FontStyles BoldItalic;
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/equals.md

#### Equals(FontStyles)

Indicates whether this `FontStyles` instance is equal to specified

```csharp
public bool Equals(FontStyles other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FontStyles | Other `FontStyles` instance |

##### Return Value

`true` if are equal, `false` otherwise

#### Equals(object)

Indicates whether this `FontStyles` instance is equal to specified uncasted

```csharp
public override bool Equals(object other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Object | Other `FontStyles` instance, casted to object |

##### Return Value

`true` if are equal, `false` otherwise

### FontStyles
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/fontstyles.md

#### FontStyles constructor

Creates one `FontStyles` instance from specified bold and italic flags

```csharp
public FontStyles(bool isBold, bool isItalic)
```

| Parameter | Type | Description |
| --- | --- | --- |
| isBold | Boolean | Bold flag |
| isItalic | Boolean | Italic flag |

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/gethashcode.md

#### FontStyles.GetHashCode method

Returns a hash-code of this instance

```csharp
public override int GetHashCode()
```

##### Return Value

Signed integer hash-code

### IsBold
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/isbold.md

#### FontStyles.IsBold property

Indicates whether this `FontStyles` instance has a **bold** flag enabled (`true`) or disabled (`false`)

```csharp
public bool IsBold { get; }
```

### IsItalic
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/isitalic.md

#### FontStyles.IsItalic property

Indicates whether this `FontStyles` instance has an **italic** flag enabled (`true`) or disabled (`false`)

```csharp
public bool IsItalic { get; }
```

### Italic
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/italic.md

#### FontStyles.Italic field

Italic font style (italic only, without bold)

```csharp
public static readonly FontStyles Italic;
```

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/name.md

#### FontStyles.Name property

Name of this font style

```csharp
public string Name { get; }
```

### op_Addition
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/op_addition.md

#### FontStyles Addition operator

Combines (merges) two specified font styles and produces new resultant font style, where flags are merged (union)

```csharp
public static FontStyles operator +(FontStyles first, FontStyles second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyles | First font style operant |
| second | FontStyles | Second font style operand |

##### Return Value

Result of the union between specified operands

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/op_equality.md

#### FontStyles Equality operator

Checks whether two `FontStyles` values are equal

```csharp
public static bool operator ==(FontStyles first, FontStyles second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyles | First operand to check |
| second | FontStyles | Second operand to check |

##### Return Value

`true` if are equal, `false` otherwise

### op_Explicit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/op_explicit.md

#### FontStyles Explicit operator

Casts specified `FontStyles` instance to the equivalint octet (8-bit bitfield) in [0..3] decimal range

```csharp
public static explicit operator byte(FontStyles input)
```

| Parameter | Type | Description |
| --- | --- | --- |
| input | FontStyles | `FontStyles` instance to cast |

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/op_inequality.md

#### FontStyles Inequality operator

Checks whether two `FontStyles` values are not equal

```csharp
public static bool operator !=(FontStyles first, FontStyles second)
```

| Parameter | Type | Description |
| --- | --- | --- |
| first | FontStyles | First operand to check |
| second | FontStyles | Second operand to check |

##### Return Value

`true` if are unequal, `false` otherwise

### op_Subtraction
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/op_subtraction.md

#### FontStyles Subtraction operator

Subtracts second (subtrahend) specified font style from the first (minuend) specified font style and produces new resultant font style, where are present only those flags from the first operand, which are not found in the second operand (difference)

```csharp
public static FontStyles operator -(FontStyles minuend, FontStyles subtrahend)
```

| Parameter | Type | Description |
| --- | --- | --- |
| minuend | FontStyles | Minuend font style operand |
| subtrahend | FontStyles | Subtrahend font style operand |

##### Return Value

Result of the difference between the first (minuend) and second (subtrahend) operands

### Regular
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/regular.md

#### FontStyles.Regular field

Regular font style, default value (no bold and italic)

```csharp
public static readonly FontStyles Regular;
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/tostring.md

#### FontStyles.ToString method

Returns a name of this font style, same as `Name`

```csharp
public override string ToString()
```

##### Return Value

String with the name of this style

### TryParse
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/fontstyles/tryparse.md

#### FontStyles.TryParse method

Tries to parse specified raw string as a font style name

```csharp
public static bool TryParse(string style, out FontStyles parsed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| style | String | String that should be parsed as a font style |
| parsed | FontStyles& | Parsed font style on success or `Regular` on failure |

##### Return Value

`true` if string was successfully parsed as a correct font style; `false` otherwise

### IFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo.md

#### IFontInfo interface

Common interface for all fonts, which can be extracted from all supported families of document formats: PDF, WordProcessing, Spreadsheet, and Presentation.

```csharp
public interface IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Binary content of the font as byte array, if available, or `null`, if not |
| FamilyName { get; } | Family name of the font as a string |
| Format { get; } | Format of this font as enum — TrueType, TrueType Collection, OpenType, Embedded OpenType, or Unknown. |
| Style { get; } | Style of the font as enum — Regular, Bold, Italic, or Bold Italic. Some document formats may have fonts of only a `Regular` style. |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo/content.md

#### IFontInfo.Content property

Binary content of the font as byte array, if available, or `null`, if not

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo/familyname.md

#### IFontInfo.FamilyName property

Family name of the font as a string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo/format.md

#### IFontInfo.Format property

Format of this font as enum — TrueType, TrueType Collection, OpenType, Embedded OpenType, or Unknown.

```csharp
public FontFormat Format { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo/serializetocss.md

#### IFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontinfo/style.md

#### IFontInfo.Style property

Style of the font as enum — Regular, Bold, Italic, or Bold Italic. Some document formats may have fonts of only a `Regular` style.

```csharp
public FontStyles Style { get; }
```

### IFontSource
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/ifontsource.md

#### IFontSource interface

Marker interface for the font sources.

```csharp
public interface IFontSource
```

### PdfFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo.md

#### PdfFontInfo structure

Encapsulates metainfo and binary data of one font from the PDF document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running.

```csharp
public struct PdfFontInfo : IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`. |
| FamilyName { get; } | Family name of the font, without style, never is null or empty string |
| Format { get; } | Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value. |
| IsEmbedded { get; } | Indicates whether this font is embedded inside the PDF document, loaded into the `Viewer` instance (`true`), or not. |
| IsInstalled { get; } | Indicates whether this font is present (installed) in the operating system, where the GroupDocs.Viewer is running |
| Style { get; } | Style of the font — may be Regular, Bold, Italic, or Bold Italic. |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/content.md

#### PdfFontInfo.Content property

Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`.

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/familyname.md

#### PdfFontInfo.FamilyName property

Family name of the font, without style, never is null or empty string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/format.md

#### PdfFontInfo.Format property

Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value.

```csharp
public FontFormat Format { get; }
```

### IsEmbedded
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/isembedded.md

#### PdfFontInfo.IsEmbedded property

Indicates whether this font is embedded inside the PDF document, loaded into the `Viewer` instance (`true`), or not.

```csharp
public bool IsEmbedded { get; }
```

### IsInstalled
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/isinstalled.md

#### PdfFontInfo.IsInstalled property

Indicates whether this font is present (installed) in the operating system, where the GroupDocs.Viewer is running

```csharp
public bool IsInstalled { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/serializetocss.md

#### PdfFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Output device is `null` |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/pdffontinfo/style.md

#### PdfFontInfo.Style property

Style of the font — may be Regular, Bold, Italic, or Bold Italic.

```csharp
public FontStyles Style { get; }
```

### PresentationFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo.md

#### PresentationFontInfo structure

Encapsulates metainfo and binary data of one font from the Presentation document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running.

```csharp
public struct PresentationFontInfo : IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`. |
| FamilyName { get; } | Family name of the font, without style, never is null or empty string |
| Format { get; } | Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value. |
| IsEmbedded { get; } | Indicates whether this font is embedded inside the document, loaded into the `Viewer` instance (`true`), or it is a system font (`false`). Spreadsheet documents cannot hold embedded fonts, so for them this property always returns `false`. |
| Style { get; } | Style of the font — may be Regular, Bold, Italic, or Bold Italic |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/content.md

#### PresentationFontInfo.Content property

Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`.

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/familyname.md

#### PresentationFontInfo.FamilyName property

Family name of the font, without style, never is null or empty string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/format.md

#### PresentationFontInfo.Format property

Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value.

```csharp
public FontFormat Format { get; }
```

### IsEmbedded
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/isembedded.md

#### PresentationFontInfo.IsEmbedded property

Indicates whether this font is embedded inside the document, loaded into the `Viewer` instance (`true`), or it is a system font (`false`). Spreadsheet documents cannot hold embedded fonts, so for them this property always returns `false`.

```csharp
public bool IsEmbedded { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/serializetocss.md

#### PresentationFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Output device is `null` |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/presentationfontinfo/style.md

#### PresentationFontInfo.Style property

Style of the font — may be Regular, Bold, Italic, or Bold Italic

```csharp
public FontStyles Style { get; }
```

### SearchOption
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/searchoption.md

#### SearchOption enumeration

Specifies whether to search the current folder, or the current folder and all subfolders.

```csharp
public enum SearchOption
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| TopFolderOnly | `0` | Includes only the current folder in a search. |
| AllFolders | `1` | Includes the current folder and all the subfolders in a search. |

### SpreadsheetFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo.md

#### SpreadsheetFontInfo structure

Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the `Viewer` instance. Spreadsheet documents cannot have embedded fonts, so this particular font, if was returned by the `GetAllFonts` method, is installed in the operating system, where the GroupDocs.Viewer is running.

```csharp
public struct SpreadsheetFontInfo : IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Charset { get; } | Character set of this font |
| Color { get; } | Color of this font |
| Content { get; } | Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`. |
| FamilyName { get; } | Family name of the font, without style, never is null or empty string |
| Format { get; } | Format of this font |
| IsStrikeout { get; } | Indicates whether the font is a single strikeout |
| IsUnderline { get; } | Indicates whether the font has an underline |
| Style { get; } | Style of this font — may be Regular, Bold, Italic, or Bold Italic |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |

### Charset
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/charset.md

#### SpreadsheetFontInfo.Charset property

Character set of this font

```csharp
public int Charset { get; }
```

### Color
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/color.md

#### SpreadsheetFontInfo.Color property

Color of this font

```csharp
public Argb32Color Color { get; }
```

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/content.md

#### SpreadsheetFontInfo.Content property

Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`.

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/familyname.md

#### SpreadsheetFontInfo.FamilyName property

Family name of the font, without style, never is null or empty string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/format.md

#### SpreadsheetFontInfo.Format property

Format of this font

```csharp
public FontFormat Format { get; }
```

### IsStrikeout
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/isstrikeout.md

#### SpreadsheetFontInfo.IsStrikeout property

Indicates whether the font is a single strikeout

```csharp
public bool IsStrikeout { get; }
```

### IsUnderline
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/isunderline.md

#### SpreadsheetFontInfo.IsUnderline property

Indicates whether the font has an underline

```csharp
public bool IsUnderline { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/serializetocss.md

#### SpreadsheetFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Output device is `null` |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/spreadsheetfontinfo/style.md

#### SpreadsheetFontInfo.Style property

Style of this font — may be Regular, Bold, Italic, or Bold Italic

```csharp
public FontStyles Style { get; }
```

### WordProcessingFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo.md

#### WordProcessingFontInfo structure

Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the `Viewer` instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system, where the GroupDocs.Viewer is running.

```csharp
public struct WordProcessingFontInfo : IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| AltFamilyName { get; } | Alternative family name of the font. If missing, then empty string. |
| Charset { get; } | Character set of this font |
| Content { get; } | Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`. |
| FamilyName { get; } | Family name of the font, without style, never is null or empty string |
| Format { get; } | Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value. |
| IsEmbedded { get; } | Indicates whether this font is embedded inside the document, loaded into the `Viewer` instance (`true`), or it is a system font (`false`). |
| Style { get; } | Style of the font — may be Regular, Bold, Italic, or Bold Italic. |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |
| override ToString() | Returns a debug info about this font data as the next template: "name style, embedded/system, format" |

##### Remarks

Immutable struct. Its instances are produced and returned by the GroupDocs.Viewer public API and normally should not be created by the user. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/getting-used-fonts/).

### AltFamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/altfamilyname.md

#### WordProcessingFontInfo.AltFamilyName property

Alternative family name of the font. If missing, then empty string.

```csharp
public string AltFamilyName { get; }
```

### Charset
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/charset.md

#### WordProcessingFontInfo.Charset property

Character set of this font

```csharp
public int Charset { get; }
```

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/content.md

#### WordProcessingFontInfo.Content property

Content of this font as a byte array. If there is only metainfo about this font, but its binary content is unavailable, this property returns `null`.

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/familyname.md

#### WordProcessingFontInfo.FamilyName property

Family name of the font, without style, never is null or empty string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/format.md

#### WordProcessingFontInfo.Format property

Format of this font. Documents may use fonts in the next formats: TrueType, TrueType Collection, OpenType, Embedded OpenType. If there is only metainfo about this font, but its binary content is unavailable, this property returns an Unknown value.

```csharp
public FontFormat Format { get; }
```

### IsEmbedded
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/isembedded.md

#### WordProcessingFontInfo.IsEmbedded property

Indicates whether this font is embedded inside the document, loaded into the `Viewer` instance (`true`), or it is a system font (`false`).

```csharp
public bool IsEmbedded { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/serializetocss.md

#### WordProcessingFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Output device is `null` |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/style.md

#### WordProcessingFontInfo.Style property

Style of the font — may be Regular, Bold, Italic, or Bold Italic.

```csharp
public FontStyles Style { get; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingfontinfo/tostring.md

#### WordProcessingFontInfo.ToString method

Returns a debug info about this font data as the next template: "name style, embedded/system, format"

```csharp
public override string ToString()
```

##### Return Value

String with debug info about this font

### WordProcessingSubstitutedFontInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo.md

#### WordProcessingSubstitutedFontInfo structure

Encapsulates metainfo and binary data of one font from WordProcessing document, which originally is not used in the loaded into the `Viewer` instance document, but serves as a substitution font for those, which cannot be found on the target machine. Substituted fonts exist only for the WordProcessing formats family.

```csharp
public struct WordProcessingSubstitutedFontInfo : IFontInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Content { get; } | Content of this substituted font as a byte array. Never is `null`. |
| FamilyName { get; } | Family name of the **substituted** font, without style, never is null or empty string |
| Format { get; } | Format of this substituted (not original) font. May be TrueType, TrueType Collection, OpenType, Embedded OpenType. For the substituted font, because its binary content is available by definition, this property never returns an Unknown value. |
| OriginalFamilyName { get; } | Family name of the original font, which cannot be found on a target machine, without style, never is null or empty string |
| Style { get; } | Style of the original font — may be Regular, Bold, Italic, or Bold Italic. Substituted font is usually (but not always) of the same style. |

#### Methods

| Name | Description |
| --- | --- |
| SerializeToCss(TextWriter) | Serializes this font info as a @font-face at-rule and writes it to the specified text writer |
| override ToString() | Returns a debug info about this font data as the next template: "original-name -&gt; substituted-name style, format" |

##### Remarks

Immutable struct. Its instances are produced and returned by the GroupDocs.Viewer public API and normally should not be created by the user. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/getting-used-fonts/).

### Content
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/content.md

#### WordProcessingSubstitutedFontInfo.Content property

Content of this substituted font as a byte array. Never is `null`.

```csharp
public byte[] Content { get; }
```

### FamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/familyname.md

#### WordProcessingSubstitutedFontInfo.FamilyName property

Family name of the **substituted** font, without style, never is null or empty string

```csharp
public string FamilyName { get; }
```

### Format
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/format.md

#### WordProcessingSubstitutedFontInfo.Format property

Format of this substituted (not original) font. May be TrueType, TrueType Collection, OpenType, Embedded OpenType. For the substituted font, because its binary content is available by definition, this property never returns an Unknown value.

```csharp
public FontFormat Format { get; }
```

### OriginalFamilyName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/originalfamilyname.md

#### WordProcessingSubstitutedFontInfo.OriginalFamilyName property

Family name of the original font, which cannot be found on a target machine, without style, never is null or empty string

```csharp
public string OriginalFamilyName { get; }
```

### SerializeToCss
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/serializetocss.md

#### WordProcessingSubstitutedFontInfo.SerializeToCss method

Serializes this font info as a @font-face at-rule and writes it to the specified text writer

```csharp
public void SerializeToCss(TextWriter output)
```

| Parameter | Type | Description |
| --- | --- | --- |
| output | TextWriter | Device, into which the serialized text data should be written |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Output device is `null` |

### Style
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/style.md

#### WordProcessingSubstitutedFontInfo.Style property

Style of the original font — may be Regular, Bold, Italic, or Bold Italic. Substituted font is usually (but not always) of the same style.

```csharp
public FontStyles Style { get; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/tostring.md

#### WordProcessingSubstitutedFontInfo.ToString method

Returns a debug info about this font data as the next template: "original-name -&gt; substituted-name style, format"

```csharp
public override string ToString()
```

##### Return Value

String with debug info about this font

### GroupDocs.Viewer.Interfaces
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces.md

The namespace provides interfaces to instantiate and release output document and it's resources.

#### Classes

| Class | Description |
| --- | --- |
| CreateFileStream | Represents the method that instantiates stream used to write output file data. |
| CreatePageStream | Represents the method that instantiates stream used to write output page data. |
| CreateResourceStream | Represents the method that instantiates stream used to write output HTML resource data. |
| CreateResourceUrl | Represents the method that creates URL for HTML resource. |
| ReleaseFileStream | Releases stream which was instantiated by the method associated with `CreateFileStream` delegate. |
| ReleasePageStream | Releases stream which was instantiated by the method associated with `CreatePageStream` delegate. |
| ReleaseResourceStream | Releases stream which was instantiated by the method associated with `CreateResourceStream` delegate. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IFileStreamFactory | Defines the methods that are required for instantiating and releasing output file stream. |
| IPageStreamFactory | Defines the methods that are required for instantiating and releasing output page stream. |
| IResourceStreamFactory | Defines the methods that are required for creating resource URL, instantiating and releasing output HTML resource stream. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### CreateFileStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/createfilestream.md

#### CreateFileStream delegate

Represents the method that instantiates stream used to write output file data.

```csharp
public delegate Stream CreateFileStream();
```

##### Return Value

The stream used to write output file data.

### CreatePageStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/createpagestream.md

#### CreatePageStream delegate

Represents the method that instantiates stream used to write output page data.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The |

##### Return Value

The stream used to write output page data.

### CreateResourceStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/createresourcestream.md

#### CreateResourceStream delegate

Represents the method that instantiates stream used to write output HTML resource data.

```csharp
public delegate Stream CreateResourceStream(int pageNumber, Resource resource);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Number of the page. |
| resource | Resource | HTML resource such as font, style, image or graphics. |

##### Return Value

The stream used to write output HTML resource data.

### CreateResourceUrl
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/createresourceurl.md

#### CreateResourceUrl delegate

Represents the method that creates URL for HTML resource.

```csharp
public delegate string CreateResourceUrl(int pageNumber, Resource resource);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Number of the page. |
| resource | Resource | HTML resource such as font, style, image or graphics. |

##### Return Value

The URL of the HTML resource.

### IFileStreamFactory
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ifilestreamfactory.md

#### IFileStreamFactory interface

Defines the methods that are required for instantiating and releasing output file stream.

```csharp
public interface IFileStreamFactory
```

#### Methods

| Name | Description |
| --- | --- |
| CreateFileStream() | Creates the stream used to write output file data. |
| ReleaseFileStream(Stream) | Releases the stream created by `CreateFileStream` method. |

### CreateFileStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ifilestreamfactory/createfilestream.md

#### IFileStreamFactory.CreateFileStream method

Creates the stream used to write output file data.

```csharp
public Stream CreateFileStream()
```

##### Return Value

Stream used to write output file data.

### ReleaseFileStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ifilestreamfactory/releasefilestream.md

#### IFileStreamFactory.ReleaseFileStream method

Releases the stream created by `CreateFileStream` method.

```csharp
public void ReleaseFileStream(Stream fileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | Stream | Stream created by `CreateFileStream` method. |

### IPageStreamFactory
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ipagestreamfactory.md

#### IPageStreamFactory interface

Defines the methods that are required for instantiating and releasing output page stream.

```csharp
public interface IPageStreamFactory
```

#### Methods

| Name | Description |
| --- | --- |
| CreatePageStream(int) | Creates the stream used to write output page data. |
| ReleasePageStream(int, Stream) | Releases the stream created by `CreatePageStream` method. |

### CreatePageStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ipagestreamfactory/createpagestream.md

#### IPageStreamFactory.CreatePageStream method

Creates the stream used to write output page data.

```csharp
public Stream CreatePageStream(int pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of a page. |

##### Return Value

Stream used to write output page data.

### ReleasePageStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/ipagestreamfactory/releasepagestream.md

#### IPageStreamFactory.ReleasePageStream method

Releases the stream created by `CreatePageStream` method.

```csharp
public void ReleasePageStream(int pageNumber, Stream pageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of a page. |
| pageStream | Stream | Stream created by `CreatePageStream` method. |

### IResourceStreamFactory
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/iresourcestreamfactory.md

#### IResourceStreamFactory interface

Defines the methods that are required for creating resource URL, instantiating and releasing output HTML resource stream.

```csharp
public interface IResourceStreamFactory
```

#### Methods

| Name | Description |
| --- | --- |
| CreateResourceStream(int, Resource) | Creates the stream used to write output HTML resource data. |
| CreateResourceUrl(int, Resource) | Creates the URL for HTML resource. |
| ReleaseResourceStream(int, Resource, Stream) | Releases the stream created by `CreateResourceStream` method. |

### CreateResourceStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/iresourcestreamfactory/createresourcestream.md

#### IResourceStreamFactory.CreateResourceStream method

Creates the stream used to write output HTML resource data.

```csharp
public Stream CreateResourceStream(int pageNumber, Resource resource)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of a page. |
| resource | Resource | The HTML resource such as font, style, image or graphics. |

##### Return Value

Stream used to write output resource data.

### CreateResourceUrl
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/iresourcestreamfactory/createresourceurl.md

#### IResourceStreamFactory.CreateResourceUrl method

Creates the URL for HTML resource.

```csharp
public string CreateResourceUrl(int pageNumber, Resource resource)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of a page. |
| resource | Resource | The HTML resource such as font, style, image or graphics. |

##### Return Value

URL for HTML resource.

### ReleaseResourceStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/iresourcestreamfactory/releaseresourcestream.md

#### IResourceStreamFactory.ReleaseResourceStream method

Releases the stream created by `CreateResourceStream` method.

```csharp
public void ReleaseResourceStream(int pageNumber, Resource resource, Stream resourceStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The number of a page. |
| resource | Resource | The HTML resource such as font, style, image or graphics. |
| resourceStream | Stream | Stream created by `CreateResourceStream` method. |

### ReleaseFileStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/releasefilestream.md

#### ReleaseFileStream delegate

Releases stream which was instantiated by the method associated with `CreateFileStream` delegate.

```csharp
public delegate void ReleaseFileStream(Stream fileStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | Stream | The stream created by the method associated with `CreateFileStream` delegate. |

### ReleasePageStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/releasepagestream.md

#### ReleasePageStream delegate

Releases stream which was instantiated by the method associated with `CreatePageStream` delegate.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Number of the page. |
| pageStream | Stream | The stream created by the method associated with `CreatePageStream` delegate. |

### ReleaseResourceStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.interfaces/releaseresourcestream.md

#### ReleaseResourceStream delegate

Releases stream which was instantiated by the method associated with `CreateResourceStream` delegate.

```csharp
public delegate void ReleaseResourceStream(int pageNumber, Resource resource, 
    Stream resourceStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | Number of the page. |
| resource | Resource | HTML resource such as font, style, image or graphics. |
| resourceStream | Stream | The stream created by the method associated with `CreateResourceStream` delegate. |

### GroupDocs.Viewer.Logging
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging.md

The namespace provides classes to customize logging behaviour.

#### Classes

| Class | Description |
| --- | --- |
| ConsoleLogger | Writes log messages to the console. |
| FileLogger | Writes log messages to the file. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the methods that are used to perform logging. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### ConsoleLogger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/consolelogger.md

#### ConsoleLogger class

Writes log messages to the console.

```csharp
public class ConsoleLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| ConsoleLogger() | The default constructor. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. |
| Trace(string) | Writes a trace message to the console. Trace log messages provide generally useful information about application flow. |
| Warning(string) | Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow. |

### ConsoleLogger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/consolelogger/consolelogger.md

#### ConsoleLogger constructor

The default constructor.

```csharp
public ConsoleLogger()
```

### Error
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/consolelogger/error.md

#### ConsoleLogger.Error method

Writes an error message to the console. Error log messages provide 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *exception* is null. |

### Trace
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/consolelogger/trace.md

#### ConsoleLogger.Trace method

Writes a trace message to the console. Trace log messages provide generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/consolelogger/warning.md

#### ConsoleLogger.Warning method

Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### FileLogger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/filelogger.md

#### FileLogger class

Writes log messages to the file.

```csharp
public class FileLogger : ILogger
```

#### Constructors

| Name | Description |
| --- | --- |
| FileLogger(string) | Create logger to file. |

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Writes an error message to the console. Error log messages provide information about unrecoverable events in application flow. |
| Trace(string) | Writes a trace message to the console. Trace log messages provide generally useful information about application flow. |
| Warning(string) | Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow. |

### Error
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/filelogger/error.md

#### FileLogger.Error method

Writes an error message to the console. Error log messages provide 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *exception* is null. |

### FileLogger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/filelogger/filelogger.md

#### FileLogger constructor

Create logger to file.

```csharp
public FileLogger(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Full file name with path |

### Trace
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/filelogger/trace.md

#### FileLogger.Trace method

Writes a trace message to the console. Trace log messages provide generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/filelogger/warning.md

#### FileLogger.Warning method

Writes a warning message to the console. Warning log messages provide information about unexpected and recoverable events in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### ILogger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.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 an error message. Error log messages provide information about unrecoverable events in application flow. |
| Trace(string) | Writes a trace message. Trace log messages provide generally useful information about application flow. |
| Warning(string) | Writes a warning message. Warning log messages provide information about unexpected and recoverable events in application flow. |

### Error
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/ilogger/error.md

#### ILogger.Error method

Writes an error message. Error log messages provide 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. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |
| ArgumentNullException | Thrown when *exception* is null. |

### Trace
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/ilogger/trace.md

#### ILogger.Trace method

Writes a trace message. Trace log messages provide generally useful information about application flow.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The trace message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### Warning
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.logging/ilogger/warning.md

#### ILogger.Warning method

Writes a warning message. Warning log messages provide information about unexpected and recoverable events in application flow.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *message* is null. |

### GroupDocs.Viewer.Options
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options.md

The namespace provides classes to specify additional options when rendering documents.

#### Classes

| Class | Description |
| --- | --- |
| ArchiveOptions | Contains options for rendering the archive files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/). |
| BaseViewOptions | Contains the base rendering options. |
| CadOptions | Contains options for rendering CAD drawings. For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/). |
| EmailOptions | Contains options for rendering email messages. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/). |
| Field | Represents email message field e.g. From, To, Subject etc. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#rename-fields-in-the-message-header). |
| FileName | The filename. |
| HtmlViewOptions | Contains options for rendering documents into HTML format. For details, see the [topic](https://docs.groupdocs.com/viewer/net/rendering-to-html/) and its children. |
| JpgViewOptions | Provides options for rendering documents into JPG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. |
| LoadOptions | Contains options that used to open the file. For details, see this [page](https://docs.groupdocs.com/viewer/net/loading/) and its children. |
| MailStorageOptions | Contains options for rendering Mail storage (Lotus Notes, MBox) data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). |
| OutlookOptions | Contains options for rendering Outlook data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options). |
| PdfOptimizationOptions | Contains the PDF optimization options to apply to the output PDF file. For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children. |
| PdfOptions | Contains options for rendering to PDF documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/). |
| PdfViewOptions | Contains options for rendering documents into PDF format. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/). |
| PngViewOptions | Contains options for rendering documents into PNG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children. |
| PresentationOptions | Contains options for rendering presentations. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/). |
| ProjectManagementOptions | Contains options for rendering project management files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/). |
| Resolution | Contains option to set resolution for images in output document. |
| SearchHighlightOptions | Provides options for searching and highlighting text in the documents, loaded to the `Viewer` class |
| Security | Contains the PDF document security options. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/). |
| Size | Contains the watermark size. |
| SpreadsheetOptions | Contains options for rendering spreadsheets. For details, see children of the [Render spreadsheet files](https://docs.groupdocs.com/viewer/net/render-spreadsheets/) topic. |
| TextOptions | Text files splitting to pages options. |
| Tile | Represents the drawing region. |
| ViewInfoOptions | Contains options for retrieving information about view. |
| ViewOptions | Contains the rendering options. |
| VisioRenderingOptions | Contains options for rendering Visio documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/). |
| Watermark | Represents a text watermark. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/). |
| WebDocumentOptions | Contains options for rendering web documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/). |
| WordProcessingOptions | Contains options for rendering Word documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/). |
#### Interfaces

| Interface | Description |
| --- | --- |
| IMaxSizeOptions | Limits of image size options interface. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| ImageQuality | The quality of images in the output HTML contained by the PDF documents. |
| PageSize | The size of the page. |
| Permissions | Defines PDF document permissions. |
| Position | Defines the watermark position. |
| Rotation | Contains page rotation in degrees (clockwise). |
| TextOverflowMode | Sets the text overflow mode for rendering spreadsheet documents into HTML. |
| TimeUnit | Time unit of the project duration. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### ArchiveOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/archiveoptions.md

#### ArchiveOptions class

Contains options for rendering the archive files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/).

```csharp
public class ArchiveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ArchiveOptions() | Initializes an instance of the `ArchiveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileName { get; set; } | Sets the displayed archive file name. |
| Folder { get; set; } | Sets the folder to be rendered. |

### ArchiveOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/archiveoptions/archiveoptions.md

#### ArchiveOptions constructor

Initializes an instance of the `ArchiveOptions` class.

```csharp
public ArchiveOptions()
```

### FileName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/archiveoptions/filename.md

#### ArchiveOptions.FileName property

Sets the displayed archive file name.

```csharp
public FileName FileName { get; set; }
```

##### Remarks

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property.

For more information and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#specify-the-archive-document-name).

### Folder
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/archiveoptions/folder.md

#### ArchiveOptions.Folder property

Sets the folder to be rendered.

```csharp
public string Folder { get; set; }
```

##### Remarks

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#render-a-specific-folder).

### BaseViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions.md

#### BaseViewOptions class

Contains the base rendering options.

```csharp
public abstract class BaseViewOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

### ArchiveOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/archiveoptions.md

#### BaseViewOptions.ArchiveOptions property

The archive files view options.

```csharp
public ArchiveOptions ArchiveOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/).

### CadOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/cadoptions.md

#### BaseViewOptions.CadOptions property

The CAD drawing view options.

```csharp
public CadOptions CadOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/).

### DefaultFontName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/defaultfontname.md

#### BaseViewOptions.DefaultFontName property

Sets the default font for a document.

```csharp
public string DefaultFontName { get; set; }
```

##### Remarks

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts.

For code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/replace-missing-font/).

### EmailOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/emailoptions.md

#### BaseViewOptions.EmailOptions property

The email messages view options.

```csharp
public EmailOptions EmailOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/).

### MailStorageOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/mailstorageoptions.md

#### BaseViewOptions.MailStorageOptions property

Mail storage data files view options.

```csharp
public MailStorageOptions MailStorageOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/).

### OutlookOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/outlookoptions.md

#### BaseViewOptions.OutlookOptions property

The Microsoft Outlook data files view options.

```csharp
public OutlookOptions OutlookOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/).

### PdfOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/pdfoptions.md

#### BaseViewOptions.PdfOptions property

The PDF document view options.

```csharp
public PdfOptions PdfOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/).

### PresentationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/presentationoptions.md

#### BaseViewOptions.PresentationOptions property

The presentation files view options.

```csharp
public PresentationOptions PresentationOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/).

### ProjectManagementOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/projectmanagementoptions.md

#### BaseViewOptions.ProjectManagementOptions property

The project management files view options.

```csharp
public ProjectManagementOptions ProjectManagementOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/).

### RemoveComments
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/removecomments.md

#### BaseViewOptions.RemoveComments property

Disables rendering comments when set to `true`. By default is `false` — all comments are displayed.

```csharp
public bool RemoveComments { get; set; }
```

##### Remarks

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to `true` the comments may be excluded from the resultant document.

This option replaces the obsolete 'RenderComments' property.

### RenderHiddenPages
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/renderhiddenpages.md

#### BaseViewOptions.RenderHiddenPages property

Enables rendering of hidden pages.

```csharp
public bool RenderHiddenPages { get; set; }
```

##### Remarks

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to `true`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#render-hidden-slides).

### RenderNotes
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/rendernotes.md

#### BaseViewOptions.RenderNotes property

Enables rendering notes.

```csharp
public bool RenderNotes { get; set; }
```

##### Remarks

Some files, such as presentations or Microsoft project files, may contain notes. By default, GroupDocs.Viewer does not render notes. To do this, set this property to `true`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#render-speaker-notes).

### SpreadsheetOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/spreadsheetoptions.md

#### BaseViewOptions.SpreadsheetOptions property

The spreadsheet files view options.

```csharp
public SpreadsheetOptions SpreadsheetOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/), [Split a worksheet into pages](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/), and [Specify spreadsheet rendering options](https://docs.groupdocs.com/viewer/net/specify-rendering-options/).

### TextOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/textoptions.md

#### BaseViewOptions.TextOptions property

Text files view options.

```csharp
public TextOptions TextOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/).

### VisioRenderingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/visiorenderingoptions.md

#### BaseViewOptions.VisioRenderingOptions property

The Visio files view options.

```csharp
public VisioRenderingOptions VisioRenderingOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/).

### WebDocumentOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/webdocumentoptions.md

#### BaseViewOptions.WebDocumentOptions property

The Web files view options.

```csharp
public WebDocumentOptions WebDocumentOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/).

### WordProcessingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/baseviewoptions/wordprocessingoptions.md

#### BaseViewOptions.WordProcessingOptions property

The Word processing files view options.

```csharp
public WordProcessingOptions WordProcessingOptions { get; set; }
```

##### Remarks

For more information and code examples, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/).

### CadOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions.md

#### CadOptions class

Contains options for rendering CAD drawings. For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files](https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/) and [Specify rendering options for CAD files](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/).

```csharp
public class CadOptions
```

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Image background color. |
| EnablePerformanceConversionMode { get; set; } | Setting this flag to `true` enables a special performance-oriented conversion mode for all formats within CAD family — in this mode the conversion speed is much faster, but the quality of the resultant documents is signifiantly worser. By default is disabled (`false`) — the quality of the resultant documents is the best possible at the expense of performance. |
| Height { get; } | The height of the output result (in pixels). |
| Layers { get; set; } | The CAD drawing layers to render. |
| LayoutName { get; set; } | The name of the specific layout to render. Layout name is case-sensitive. |
| Pc3File { get; set; } | PC3 - plotter configuration file |
| RenderLayouts { get; set; } | Flag if layouts from CAD document should be rendered. |
| ScaleFactor { get; } | Value higher than 1 enlarges output result; value between 0 and 1 reduces output result. |
| Tiles { get; set; } | The drawing regions to render. |
| Width { get; } | The width of the output result (in pixels). |

#### Methods

| Name | Description |
| --- | --- |
| static ForRenderingByHeight(int) | Initializes an instance of the `CadOptions` class for rendering by height. |
| static ForRenderingByScaleFactor(float) | Initializes an instance of the `CadOptions` class for rendering by scale factor. |
| static ForRenderingByWidth(int) | Initializes an instance of the `CadOptions` class for rendering by width. |
| static ForRenderingByWidthAndHeight(int, int) | Initializes an instance of the `CadOptions` class for rendering by width and height. |

### BackgroundColor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/backgroundcolor.md

#### CadOptions.BackgroundColor property

Image background color.

```csharp
public Argb32Color BackgroundColor { get; set; }
```

### EnablePerformanceConversionMode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/enableperformanceconversionmode.md

#### CadOptions.EnablePerformanceConversionMode property

Setting this flag to `true` enables a special performance-oriented conversion mode for all formats within CAD family — in this mode the conversion speed is much faster, but the quality of the resultant documents is signifiantly worser. By default is disabled (`false`) — the quality of the resultant documents is the best possible at the expense of performance.

```csharp
public bool EnablePerformanceConversionMode { get; set; }
```

### ForRenderingByHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/forrenderingbyheight.md

#### CadOptions.ForRenderingByHeight method

Initializes an instance of the `CadOptions` class for rendering by height.

```csharp
public static CadOptions ForRenderingByHeight(int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| height | Int32 | The height of the output result (in pixels). |

##### Return Value

New instance of the `CadOptions` class for rendering by height.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *height* is less or equal to zero. |

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size).

### ForRenderingByScaleFactor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/forrenderingbyscalefactor.md

#### CadOptions.ForRenderingByScaleFactor method

Initializes an instance of the `CadOptions` class for rendering by scale factor.

```csharp
public static CadOptions ForRenderingByScaleFactor(float scaleFactor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| scaleFactor | Single | Value higher than 1 enlarges output result; value between 0 and 1 reduces output result. |

##### Return Value

New instance of the `CadOptions` class for rendering by scale factor.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *scaleFactor* is less or equal to zero. |

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size).

### ForRenderingByWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/forrenderingbywidth.md

#### CadOptions.ForRenderingByWidth method

Initializes an instance of the `CadOptions` class for rendering by width.

```csharp
public static CadOptions ForRenderingByWidth(int width)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Int32 | The width of the output result (in pixels). |

##### Return Value

New instance of the `CadOptions` class for rendering by width.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *width* is less or equal to zero. |

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size).

### ForRenderingByWidthAndHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/forrenderingbywidthandheight.md

#### CadOptions.ForRenderingByWidthAndHeight method

Initializes an instance of the `CadOptions` class for rendering by width and height.

```csharp
public static CadOptions ForRenderingByWidthAndHeight(int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| width | Int32 | The width of the output result (in pixels). |
| height | Int32 | The height of the output result (in pixels). |

##### Return Value

New instance of `CadOptions` class for rendering by width and height.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#configure-the-output-image-size).

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/height.md

#### CadOptions.Height property

The height of the output result (in pixels).

```csharp
public int Height { get; }
```

### Layers
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/layers.md

#### CadOptions.Layers property

The CAD drawing layers to render.

```csharp
public IList<Layer> Layers { get; set; }
```

##### Remarks

By default all layers are rendered. Layer names are case-sensitive.

### LayoutName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/layoutname.md

#### CadOptions.LayoutName property

The name of the specific layout to render. Layout name is case-sensitive.

```csharp
public string LayoutName { get; set; }
```

##### Remarks

This option is available only for the CAD drawings that support layouts: `DXF`, `DWG`, `DWT`, `DWF`, and `DWFX`; By default only the Model is rendered.

### Pc3File
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/pc3file.md

#### CadOptions.Pc3File property

PC3 - plotter configuration file

```csharp
public string Pc3File { get; set; }
```

### RenderLayouts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/renderlayouts.md

#### CadOptions.RenderLayouts property

Flag if layouts from CAD document should be rendered.

```csharp
public bool RenderLayouts { get; set; }
```

##### Remarks

This option is available only for the CAD drawings that support layouts `DXF`, `DWG`, `DWT`, and `DWF`, and `DWFX`. By default only the Model is rendered.

### ScaleFactor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/scalefactor.md

#### CadOptions.ScaleFactor property

Value higher than 1 enlarges output result; value between 0 and 1 reduces output result.

```csharp
public float ScaleFactor { get; }
```

### Tiles
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/tiles.md

#### CadOptions.Tiles property

The drawing regions to render.

```csharp
public IList<Tile> Tiles { get; set; }
```

##### Remarks

This option is available only for the `DWG` and `DWT` file types. The `RenderLayouts` and `LayoutName` options are ignored when rendering by tiles.

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/cadoptions/width.md

#### CadOptions.Width property

The width of the output result (in pixels).

```csharp
public int Width { get; }
```

### EmailOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions.md

#### EmailOptions class

Contains options for rendering email messages. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/).

```csharp
public class EmailOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailOptions() | Initializes an instance of the `EmailOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DateTimeFormat { get; set; } | Time Format (can be include TimeZone). For example: 'MM d yyyy HH:mm tt', if not set - current system format is used |
| FieldTextMap { get; set; } | The mapping between email message `Field` and field text representation. |
| PageSize { get; set; } | The size of the output page. |
| TimeZoneOffset { get; set; } | Message time zone offset. |

### DateTimeFormat
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions/datetimeformat.md

#### EmailOptions.DateTimeFormat property

Time Format (can be include TimeZone). For example: 'MM d yyyy HH:mm tt', if not set - current system format is used

```csharp
public string DateTimeFormat { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone).

### EmailOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions/emailoptions.md

#### EmailOptions constructor

Initializes an instance of the `EmailOptions` class.

```csharp
public EmailOptions()
```

### FieldTextMap
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions/fieldtextmap.md

#### EmailOptions.FieldTextMap property

The mapping between email message `Field` and field text representation.

```csharp
public Dictionary<Field, string> FieldTextMap { get; set; }
```

### PageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions/pagesize.md

#### EmailOptions.PageSize property

The size of the output page.

```csharp
public PageSize PageSize { get; set; }
```

### TimeZoneOffset
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/emailoptions/timezoneoffset.md

#### EmailOptions.TimeZoneOffset property

Message time zone offset.

```csharp
public TimeSpan TimeZoneOffset { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone).

### Field
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field.md

#### Field class

Represents email message field e.g. From, To, Subject etc. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-email-messages/#rename-fields-in-the-message-header).

```csharp
public class Field
```

#### Properties

| Name | Description |
| --- | --- |
| Name { get; } | Field name. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Anniversary | Default field text is "Anniversary". |
| static readonly Attachments | Default field text is "Attachments". |
| static readonly Bcc | Default field text is "Bcc". |
| static readonly Birthday | Default field text is "Birthday". |
| static readonly Business | Default field text is "Business". |
| static readonly BusinessAddress | Default field text is "Business Address". |
| static readonly BusinessFax | Default field text is "Business Fax". |
| static readonly BusinessHomepage | Default field text is "BusinessHomepage". |
| static readonly Cc | Default field text is "Cc". |
| static readonly Company | Default field text is "Company". |
| static readonly Department | Default field text is "Department". |
| static readonly Email | Default field text is "Email". |
| static readonly Email2 | Default field text is "Email2". |
| static readonly Email2DisplayAs | Default field text is "Email2 Display As". |
| static readonly Email3 | Default field text is "Email3". |
| static readonly Email3DisplayAs | Default field text is "Email3 Display As". |
| static readonly EmailDisplayAs | Default field text is "Email Display As". |
| static readonly End | Default field text is "End". |
| static readonly FirstName | Default field text is "First Name". |
| static readonly From | Default field text is "From". |
| static readonly FullName | Default field text is "Full Name". |
| static readonly Gender | Default field text is "Gender". |
| static readonly Hobbies | Default field text is "Hobbies". |
| static readonly Home | Default field text is "Home". |
| static readonly HomeAddress | Default field text is "Home Address". |
| static readonly Importance | Default field text is "Importance". |
| static readonly JobTitle | Default field text is "Job Title". |
| static readonly LastName | Default field text is "Last Name". |
| static readonly Location | Default field text is "Location". |
| static readonly MiddleName | Default field text is "Middle Name". |
| static readonly Mobile | Default field text is "Mobile". |
| static readonly Organizer | Default field text is "Organizer". |
| static readonly OtherAddress | Default field text is "Other Address". |
| static readonly PersonalHomepage | Default field text is "Personal Homepage". |
| static readonly Profession | Default field text is "Profession". |
| static readonly Recurrence | Default field text is "Recurrence" |
| static readonly RecurrencePattern | Default field text is "Recurrence Pattern". |
| static readonly RequiredAttendees | Default field text is "Required Attendees". |
| static readonly Sent | Default field text is "Sent". |
| static readonly ShowTimeAs | Default field text is "Show Time As". |
| static readonly SpousePartner | Default field text is "Spouse/Partner". |
| static readonly Start | Default field text is "Start". |
| static readonly Subject | Default field text is "Subject". |
| static readonly To | Default field text is "To". |
| static readonly UserField1 | Default field text is "User Field 1". |
| static readonly UserField2 | Default field text is "User Field 2". |
| static readonly UserField3 | Default field text is "User Field 3". |
| static readonly UserField4 | Default field text is "User Field 4". |

### Anniversary
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/anniversary.md

#### Field.Anniversary field

Default field text is "Anniversary".

```csharp
public static readonly Field Anniversary;
```

### Attachments
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/attachments.md

#### Field.Attachments field

Default field text is "Attachments".

```csharp
public static readonly Field Attachments;
```

### Bcc
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/bcc.md

#### Field.Bcc field

Default field text is "Bcc".

```csharp
public static readonly Field Bcc;
```

### Birthday
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/birthday.md

#### Field.Birthday field

Default field text is "Birthday".

```csharp
public static readonly Field Birthday;
```

### Business
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/business.md

#### Field.Business field

Default field text is "Business".

```csharp
public static readonly Field Business;
```

### BusinessAddress
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/businessaddress.md

#### Field.BusinessAddress field

Default field text is "Business Address".

```csharp
public static readonly Field BusinessAddress;
```

### BusinessFax
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/businessfax.md

#### Field.BusinessFax field

Default field text is "Business Fax".

```csharp
public static readonly Field BusinessFax;
```

### BusinessHomepage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/businesshomepage.md

#### Field.BusinessHomepage field

Default field text is "BusinessHomepage".

```csharp
public static readonly Field BusinessHomepage;
```

### Cc
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/cc.md

#### Field.Cc field

Default field text is "Cc".

```csharp
public static readonly Field Cc;
```

### Company
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/company.md

#### Field.Company field

Default field text is "Company".

```csharp
public static readonly Field Company;
```

### Department
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/department.md

#### Field.Department field

Default field text is "Department".

```csharp
public static readonly Field Department;
```

### Email
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/email.md

#### Field.Email field

Default field text is "Email".

```csharp
public static readonly Field Email;
```

### Email2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/email2.md

#### Field.Email2 field

Default field text is "Email2".

```csharp
public static readonly Field Email2;
```

### Email2DisplayAs
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/email2displayas.md

#### Field.Email2DisplayAs field

Default field text is "Email2 Display As".

```csharp
public static readonly Field Email2DisplayAs;
```

### Email3
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/email3.md

#### Field.Email3 field

Default field text is "Email3".

```csharp
public static readonly Field Email3;
```

### Email3DisplayAs
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/email3displayas.md

#### Field.Email3DisplayAs field

Default field text is "Email3 Display As".

```csharp
public static readonly Field Email3DisplayAs;
```

### EmailDisplayAs
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/emaildisplayas.md

#### Field.EmailDisplayAs field

Default field text is "Email Display As".

```csharp
public static readonly Field EmailDisplayAs;
```

### End
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/end.md

#### Field.End field

Default field text is "End".

```csharp
public static readonly Field End;
```

### FirstName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/firstname.md

#### Field.FirstName field

Default field text is "First Name".

```csharp
public static readonly Field FirstName;
```

### From
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/from.md

#### Field.From field

Default field text is "From".

```csharp
public static readonly Field From;
```

### FullName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/fullname.md

#### Field.FullName field

Default field text is "Full Name".

```csharp
public static readonly Field FullName;
```

### Gender
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/gender.md

#### Field.Gender field

Default field text is "Gender".

```csharp
public static readonly Field Gender;
```

### Hobbies
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/hobbies.md

#### Field.Hobbies field

Default field text is "Hobbies".

```csharp
public static readonly Field Hobbies;
```

### Home
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/home.md

#### Field.Home field

Default field text is "Home".

```csharp
public static readonly Field Home;
```

### HomeAddress
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/homeaddress.md

#### Field.HomeAddress field

Default field text is "Home Address".

```csharp
public static readonly Field HomeAddress;
```

### Importance
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/importance.md

#### Field.Importance field

Default field text is "Importance".

```csharp
public static readonly Field Importance;
```

### JobTitle
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/jobtitle.md

#### Field.JobTitle field

Default field text is "Job Title".

```csharp
public static readonly Field JobTitle;
```

### LastName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/lastname.md

#### Field.LastName field

Default field text is "Last Name".

```csharp
public static readonly Field LastName;
```

### Location
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/location.md

#### Field.Location field

Default field text is "Location".

```csharp
public static readonly Field Location;
```

### MiddleName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/middlename.md

#### Field.MiddleName field

Default field text is "Middle Name".

```csharp
public static readonly Field MiddleName;
```

### Mobile
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/mobile.md

#### Field.Mobile field

Default field text is "Mobile".

```csharp
public static readonly Field Mobile;
```

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/name.md

#### Field.Name property

Field name.

```csharp
public string Name { get; }
```

### Organizer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/organizer.md

#### Field.Organizer field

Default field text is "Organizer".

```csharp
public static readonly Field Organizer;
```

### OtherAddress
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/otheraddress.md

#### Field.OtherAddress field

Default field text is "Other Address".

```csharp
public static readonly Field OtherAddress;
```

### PersonalHomepage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/personalhomepage.md

#### Field.PersonalHomepage field

Default field text is "Personal Homepage".

```csharp
public static readonly Field PersonalHomepage;
```

### Profession
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/profession.md

#### Field.Profession field

Default field text is "Profession".

```csharp
public static readonly Field Profession;
```

### Recurrence
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/recurrence.md

#### Field.Recurrence field

Default field text is "Recurrence"

```csharp
public static readonly Field Recurrence;
```

### RecurrencePattern
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/recurrencepattern.md

#### Field.RecurrencePattern field

Default field text is "Recurrence Pattern".

```csharp
public static readonly Field RecurrencePattern;
```

### RequiredAttendees
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/requiredattendees.md

#### Field.RequiredAttendees field

Default field text is "Required Attendees".

```csharp
public static readonly Field RequiredAttendees;
```

### Sent
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/sent.md

#### Field.Sent field

Default field text is "Sent".

```csharp
public static readonly Field Sent;
```

### ShowTimeAs
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/showtimeas.md

#### Field.ShowTimeAs field

Default field text is "Show Time As".

```csharp
public static readonly Field ShowTimeAs;
```

### SpousePartner
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/spousepartner.md

#### Field.SpousePartner field

Default field text is "Spouse/Partner".

```csharp
public static readonly Field SpousePartner;
```

### Start
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/start.md

#### Field.Start field

Default field text is "Start".

```csharp
public static readonly Field Start;
```

### Subject
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/subject.md

#### Field.Subject field

Default field text is "Subject".

```csharp
public static readonly Field Subject;
```

### To
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/to.md

#### Field.To field

Default field text is "To".

```csharp
public static readonly Field To;
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/tostring.md

#### Field.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### UserField1
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/userfield1.md

#### Field.UserField1 field

Default field text is "User Field 1".

```csharp
public static readonly Field UserField1;
```

### UserField2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/userfield2.md

#### Field.UserField2 field

Default field text is "User Field 2".

```csharp
public static readonly Field UserField2;
```

### UserField3
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/userfield3.md

#### Field.UserField3 field

Default field text is "User Field 3".

```csharp
public static readonly Field UserField3;
```

### UserField4
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/field/userfield4.md

#### Field.UserField4 field

Default field text is "User Field 4".

```csharp
public static readonly Field UserField4;
```

### FileName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/filename.md

#### FileName class

The filename.

```csharp
public class FileName
```

#### Constructors

| Name | Description |
| --- | --- |
| FileName(string) | Initializes an instance of the `FileName` class. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Empty | The empty filename. |
| static readonly Source | The name of the source file. |

### Empty
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/filename/empty.md

#### FileName.Empty field

The empty filename.

```csharp
public static readonly FileName Empty;
```

### FileName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/filename/filename.md

#### FileName constructor

Initializes an instance of the `FileName` class.

```csharp
public FileName(string fileName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | The name of the file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileName* is null. |

### Source
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/filename/source.md

#### FileName.Source field

The name of the source file.

```csharp
public static readonly FileName Source;
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/filename/tostring.md

#### FileName.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### HtmlViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions.md

#### HtmlViewOptions class

Contains options for rendering documents into HTML format. For details, see the [topic](https://docs.groupdocs.com/viewer/net/rendering-to-html/) and its children.

```csharp
public class HtmlViewOptions : ViewOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| ExcludeFonts { get; set; } | Disables adding any fonts into HTML document. |
| FontsToExclude { get; set; } | The list of font names to exclude from HTML document. |
| ForPrinting { get; set; } | Enables optimization the output HTML for printing. |
| ImageHeight { get; set; } | The height of an output image (in pixels). The property is available when converting single image to HTML only. |
| ImageMaxHeight { get; set; } | Max height of an output image (in pixels). The property is available when converting single image to HTML only. |
| ImageMaxWidth { get; set; } | Max width of an output image (in pixels). The property is available when converting single image to HTML only. |
| ImageWidth { get; set; } | The width of the output image (in pixels). The property is available when converting single image to HTML only. |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| Minify { get; set; } | Enables HTML content and HTML resources minification. |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RemoveJavaScript { get; set; } | Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (`true`). |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| RenderResponsive { get; set; } | Enables responsive rendering. |
| RenderToSinglePage { get; set; } | Enables rendering an entire document to one HTML file. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| Watermark { get; set; } | The text watermark to be applied to each page. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| static ForEmbeddedResources() | Initializes an instance of the `HtmlViewOptions` class. |
| static ForEmbeddedResources(CreatePageStream) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources. |
| static ForEmbeddedResources(IPageStreamFactory) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources. |
| static ForEmbeddedResources(string) | Initializes an instance of the `HtmlViewOptions` class. |
| static ForEmbeddedResources(CreatePageStream, ReleasePageStream) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources. |
| static ForExternalResources() | Initializes an instance of the `HtmlViewOptions` class. |
| static ForExternalResources(IPageStreamFactory, IResourceStreamFactory) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources. |
| static ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources. |
| static ForExternalResources(string, string, string) | Initializes an instance of the `HtmlViewOptions` class. |
| static ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream) | Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources. |
| RotatePage(int, Rotation) | Applies the clockwise rotation to a page. |

#### Fields

| Name | Description |
| --- | --- |
| readonly PageRotations | The page rotation. |

### ExcludeFonts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/excludefonts.md

#### HtmlViewOptions.ExcludeFonts property

Disables adding any fonts into HTML document.

```csharp
public bool ExcludeFonts { get; set; }
```

##### Remarks

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML markup, abd this property has a `false` value. To prevent embedding fonts, set this property to `true`.

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/exclude-fonts/).

### FontsToExclude
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/fontstoexclude.md

#### HtmlViewOptions.FontsToExclude property

The list of font names to exclude from HTML document.

```csharp
public List<string> FontsToExclude { get; set; }
```

##### Remarks

The fonts that are added into the HTML document improve stability of the output view, at the same time they increase the size of the rendering result. This option lets you balance between stability and output size. Include the font names that are popular and installed into most systems.

Please note, this property is active only when the `ExcludeFonts` options is disabled.

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/exclude-fonts/).

### ForEmbeddedResources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/forembeddedresources.md

#### ForEmbeddedResources(CreatePageStream)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

```csharp
public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources).

#### ForEmbeddedResources(CreatePageStream, ReleasePageStream)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

```csharp
public static HtmlViewOptions ForEmbeddedResources(CreatePageStream createPageStream, 
    ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases stream created by method assigned to delegate that passed to *createPageStream* parameter. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |
| ArgumentNullException | Thrown when *releasePageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources).

#### ForEmbeddedResources(IPageStreamFactory)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

```csharp
public static HtmlViewOptions ForEmbeddedResources(IPageStreamFactory pageStreamFactory)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | IPageStreamFactory | The factory which implements methods for creating and releasing output page stream. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with embedded resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pageStreamFactory* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources).

#### ForEmbeddedResources()

Initializes an instance of the `HtmlViewOptions` class.

```csharp
public static HtmlViewOptions ForEmbeddedResources()
```

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources).

#### ForEmbeddedResources(string)

Initializes an instance of the `HtmlViewOptions` class.

```csharp
public static HtmlViewOptions ForEmbeddedResources(string filePathFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'page_{0}.html'. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePathFormat* is null or empty. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-embedded-resources).

### ForExternalResources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/forexternalresources.md

#### ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

```csharp
public static HtmlViewOptions ForExternalResources(CreatePageStream createPageStream, 
    CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that releases stream created by *createPageStream* method. |
| createResourceUrl | CreateResourceUrl | The method that creates URL for HTML resource. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |
| ArgumentNullException | Thrown when *createResourceStream* is null. |
| ArgumentNullException | Thrown when *createResourceUrl* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources).

#### ForExternalResources(CreatePageStream, CreateResourceStream, CreateResourceUrl, ReleasePageStream, ReleaseResourceStream)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

```csharp
public static HtmlViewOptions ForExternalResources(CreatePageStream createPageStream, 
    CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, 
    ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that instantiates stream used to write output HTML resource data. |
| createResourceUrl | CreateResourceUrl | The method that creates URL for HTML resource. |
| releasePageStream | ReleasePageStream | The method that releases stream created by method assigned to delegate that passed to *createPageStream* parameter. |
| releaseResourceStream | ReleaseResourceStream | The method that releases stream created by method assigned to delegate that passed to *createResourceStream* parameter. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |
| ArgumentNullException | Thrown when *createResourceStream* is null. |
| ArgumentNullException | Thrown when *createResourceUrl* is null. |
| ArgumentNullException | Thrown when *releasePageStream* is null. |
| ArgumentNullException | Thrown when *releaseResourceStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources).

#### ForExternalResources(IPageStreamFactory, IResourceStreamFactory)

Initializes an instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

```csharp
public static HtmlViewOptions ForExternalResources(IPageStreamFactory pageStreamFactory, 
    IResourceStreamFactory resourceStreamFactory)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | IPageStreamFactory | The factory which implements methods for creating and releasing output page stream. |
| resourceStreamFactory | IResourceStreamFactory | The factory which implements methods that are required for creating resource URL, instantiating and releasing output HTML resource stream. |

##### Return Value

New instance of the `HtmlViewOptions` class for rendering into HTML with external resources.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pageStreamFactory* is null. |
| ArgumentNullException | Thrown when *resourceStreamFactory* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources).

#### ForExternalResources()

Initializes an instance of the `HtmlViewOptions` class.

```csharp
public static HtmlViewOptions ForExternalResources()
```

##### Remarks

This constructor initializes an instance of the `HtmlViewOptions`

* with "p_{0}.html" as file path format for the output HTML files
* with "p_{0}_{1}" as file path format for the output HTML-resource files
* with "p_{0}_{1}" as URL format for HTML-resources

The output files will be placed into current working directory of the application.

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources).

#### ForExternalResources(string, string, string)

Initializes an instance of the `HtmlViewOptions` class.

```csharp
public static HtmlViewOptions ForExternalResources(string filePathFormat, 
    string resourceFilePathFormat, string resourceUrlFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'page_{0}.html'. |
| resourceFilePathFormat | String | The resource file path format e.g. 'page_{0}/resource_{1}'. |
| resourceUrlFormat | String | The resource URL format e.g. 'page_{0}/resource_{1}'. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePathFormat* is null or empty. |
| ArgumentException | Thrown when *resourceFilePathFormat* is null or empty. |
| ArgumentException | Thrown when *resourceUrlFormat* is null or empty. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#rendering-to-html-with-external-resources).

### ForPrinting
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/forprinting.md

#### HtmlViewOptions.ForPrinting property

Enables optimization the output HTML for printing.

```csharp
public bool ForPrinting { get; set; }
```

##### Remarks

Enable this option to convert the output HTML pages to the vector SVG format.

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/how-to-optimize-output-html-for-printing/).

### ImageHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/imageheight.md

#### HtmlViewOptions.ImageHeight property

The height of an output image (in pixels). The property is available when converting single image to HTML only.

```csharp
public int ImageHeight { get; set; }
```

##### Remarks

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/).

### ImageMaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/imagemaxheight.md

#### HtmlViewOptions.ImageMaxHeight property

Max height of an output image (in pixels). The property is available when converting single image to HTML only.

```csharp
public int ImageMaxHeight { get; set; }
```

##### Remarks

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/).

### ImageMaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/imagemaxwidth.md

#### HtmlViewOptions.ImageMaxWidth property

Max width of an output image (in pixels). The property is available when converting single image to HTML only.

```csharp
public int ImageMaxWidth { get; set; }
```

##### Remarks

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/).

### ImageWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/imagewidth.md

#### HtmlViewOptions.ImageWidth property

The width of the output image (in pixels). The property is available when converting single image to HTML only.

```csharp
public int ImageWidth { get; set; }
```

##### Remarks

For details and code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-html/).

### Minify
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/minify.md

#### HtmlViewOptions.Minify property

Enables HTML content and HTML resources minification.

```csharp
public bool Minify { get; set; }
```

##### Remarks

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to `true`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/minify-html/).

### RemoveJavaScript
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/removejavascript.md

#### HtmlViewOptions.RemoveJavaScript property

Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (`true`).

```csharp
public bool RemoveJavaScript { get; set; }
```

##### Remarks

For details about removing JavaScript, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-html/#preserving-or-disabling-javascript-when-rendering-to-html).

### RenderResponsive
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/renderresponsive.md

#### HtmlViewOptions.RenderResponsive property

Enables responsive rendering.

```csharp
public bool RenderResponsive { get; set; }
```

##### Remarks

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to `true`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-with-responsive-layout/).

### RenderToSinglePage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/htmlviewoptions/rendertosinglepage.md

#### HtmlViewOptions.RenderToSinglePage property

Enables rendering an entire document to one HTML file.

```csharp
public bool RenderToSinglePage { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-archive-files/#create-a-single-html-page).

### ImageQuality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/imagequality.md

#### ImageQuality enumeration

The quality of images in the output HTML contained by the PDF documents.

```csharp
public enum ImageQuality
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Low | `96` | The acceptable quality and best performance. |
| Medium | `198` | Better quality and slower performance. |
| High | `300` | The best quality but slow performance. |

### IMaxSizeOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/imaxsizeoptions.md

#### IMaxSizeOptions interface

Limits of image size options interface.

```csharp
public interface IMaxSizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| MaxHeight { get; set; } | Maximum height of an output image in pixels. |
| MaxWidth { get; set; } | Maximum width of an output image in pixels. |

### MaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/imaxsizeoptions/maxheight.md

#### IMaxSizeOptions.MaxHeight property

Maximum height of an output image in pixels.

```csharp
public int MaxHeight { get; set; }
```

### MaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/imaxsizeoptions/maxwidth.md

#### IMaxSizeOptions.MaxWidth property

Maximum width of an output image in pixels.

```csharp
public int MaxWidth { get; set; }
```

### JpgViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions.md

#### JpgViewOptions class

Provides options for rendering documents into JPG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children.

```csharp
public class JpgViewOptions : ViewOptions, IMaxSizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| JpgViewOptions() | Initializes an instance of the `JpgViewOptions` class. |
| JpgViewOptions(CreatePageStream) | Initializes an instance of the `JpgViewOptions` class. |
| JpgViewOptions(IPageStreamFactory) | Initializes an instance of the `JpgViewOptions` class. |
| JpgViewOptions(string) | Initializes an instance of the `JpgViewOptions` class. |
| JpgViewOptions(CreatePageStream, ReleasePageStream) | Initializes an instance of the `JpgViewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| ExtractText { get; set; } | Enables text extraction. |
| Height { get; set; } | Sets the height of an output image (in pixels). |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| MaxHeight { get; set; } | Sets the maximum height of an output image (in pixels). |
| MaxWidth { get; set; } | Sets the maximum width of an output image (in pixels). |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| Quality { get; set; } | Sets the quality of the output image. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| Watermark { get; set; } | The text watermark to be applied to each page. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| Width { get; set; } | Sets the width of the output image (in pixels). |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| RotatePage(int, Rotation) | Applies the clockwise rotation to a page. |

#### Fields

| Name | Description |
| --- | --- |
| readonly PageRotations | The page rotation. |

### ExtractText
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/extracttext.md

#### JpgViewOptions.ExtractText property

Enables text extraction.

```csharp
public bool ExtractText { get; set; }
```

##### Remarks

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/).

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/height.md

#### JpgViewOptions.Height property

Sets the height of an output image (in pixels).

```csharp
public int Height { get; set; }
```

##### Remarks

Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxHeight` property is ignored.

### JpgViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/jpgviewoptions.md

#### JpgViewOptions(CreatePageStream)

Initializes an instance of the `JpgViewOptions` class.

```csharp
public JpgViewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg).

#### JpgViewOptions(CreatePageStream, ReleasePageStream)

Initializes an instance of the `JpgViewOptions` class.

```csharp
public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases a stream created by method assigned to delegate that passed to *createPageStream* parameter. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |
| ArgumentNullException | Thrown when *releasePageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg).

#### JpgViewOptions(IPageStreamFactory)

Initializes an instance of the `JpgViewOptions` class.

```csharp
public JpgViewOptions(IPageStreamFactory pageStreamFactory)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | IPageStreamFactory | The factory which implements methods for creating and releasing output page stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pageStreamFactory* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg).

#### JpgViewOptions()

Initializes an instance of the `JpgViewOptions` class.

```csharp
public JpgViewOptions()
```

##### Remarks

This constructor initializes an instance of the `JpgViewOptions` with "p_{0}.jpg" as file path format for the output files. The output files are placed into current working directory of the application.

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg).

#### JpgViewOptions(string)

Initializes an instance of the `JpgViewOptions` class.

```csharp
public JpgViewOptions(string filePathFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'page_{0}.jpg'. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePathFormat* is null or empty. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-jpeg).

### MaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/maxheight.md

#### JpgViewOptions.MaxHeight property

Sets the maximum height of an output image (in pixels).

```csharp
public int MaxHeight { get; set; }
```

##### Remarks

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Height` property, this property is ignored.

### MaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/maxwidth.md

#### JpgViewOptions.MaxWidth property

Sets the maximum width of an output image (in pixels).

```csharp
public int MaxWidth { get; set; }
```

##### Remarks

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Width` property, this property is ignored.

### Quality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/quality.md

#### JpgViewOptions.Quality property

Sets the quality of the output image.

```csharp
public byte Quality { get; set; }
```

##### Remarks

Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-quality-for-jpg/).

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/jpgviewoptions/width.md

#### JpgViewOptions.Width property

Sets the width of the output image (in pixels).

```csharp
public int Width { get; set; }
```

##### Remarks

Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxWidth` property is ignored.

### LoadOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions.md

#### LoadOptions class

Contains options that used to open the file. For details, see this [page](https://docs.groupdocs.com/viewer/net/loading/) and its children.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes an instance of the `LoadOptions` class. |
| LoadOptions(FileType) | Initializes an instance of the `LoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DetectEncoding { get; set; } | Enables the encoding detection for the `TXT`, `CSV`, and `TSV` files. |
| Encoding { get; set; } | Sets the encoding used when opening text-based files or email messages such as `CSV`, `TXT`, and `MSG`. Default value is UTF8. |
| FileType { get; set; } | Sets the type of the file to open. |
| Password { get; set; } | Sets the password to open encrypted file. |
| ResourceLoadingTimeout { get; set; } | Sets the timeout to load external resources. |
| SkipExternalResources { get; set; } | Disables loading of all external resource such as images except `WhitelistedResources`. |
| TryRepair { get; set; } | When enabled GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is `false`. |
| WhitelistedResources { get; set; } | The list of URL fragments corresponding to external resources that should be loaded when `SkipExternalResources` is set to `true`. |

### DetectEncoding
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/detectencoding.md

#### LoadOptions.DetectEncoding property

Enables the encoding detection for the `TXT`, `CSV`, and `TSV` files.

```csharp
public bool DetectEncoding { get; set; }
```

##### Remarks

If the encoding cannot be detected, the default `Encoding` is used. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/detect-encoding-when-loading-documents/).

### Encoding
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/encoding.md

#### LoadOptions.Encoding property

Sets the encoding used when opening text-based files or email messages such as `CSV`, `TXT`, and `MSG`. Default value is UTF8.

```csharp
public Encoding Encoding { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-encoding-when-loading-documents/).

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/filetype.md

#### LoadOptions.FileType property

Sets the type of the file to open.

```csharp
public FileType FileType { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-file-type-when-loading-a-document/).

### LoadOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes an instance of the `LoadOptions` class.

```csharp
public LoadOptions()
```

#### LoadOptions(FileType)

Initializes an instance of the `LoadOptions` class.

```csharp
public LoadOptions(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to open. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-file-type-when-loading-a-document/).

### Password
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/password.md

#### LoadOptions.Password property

Sets the password to open encrypted file.

```csharp
public string Password { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/load-password-protected-document/).

### ResourceLoadingTimeout
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/resourceloadingtimeout.md

#### LoadOptions.ResourceLoadingTimeout property

Sets the timeout to load external resources.

```csharp
public TimeSpan ResourceLoadingTimeout { get; set; }
```

##### Remarks

The default value is 30 seconds. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/detect-encoding-when-loading-documents).

### SkipExternalResources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/skipexternalresources.md

#### LoadOptions.SkipExternalResources property

Disables loading of all external resource such as images except `WhitelistedResources`.

```csharp
public bool SkipExternalResources { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/loading-external-resources/#skip-loading-of-external-resources).

### TryRepair
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/tryrepair.md

#### LoadOptions.TryRepair property

When enabled GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is `false`.

```csharp
public bool TryRepair { get; set; }
```

##### Remarks

This feature addresses the following issues in a PDF document:

* Broken references within the document (incorrect object offsets in the Cross-reference list).
* Missing critical elements like root object, page object, or page content.
* Circular references (Form X-object referencing itself).

### WhitelistedResources
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/loadoptions/whitelistedresources.md

#### LoadOptions.WhitelistedResources property

The list of URL fragments corresponding to external resources that should be loaded when `SkipExternalResources` is set to `true`.

```csharp
public List<string> WhitelistedResources { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/loading-external-resources/#manage-a-safelist-for-loading-external-resources).

### MailStorageOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/mailstorageoptions.md

#### MailStorageOptions class

Contains options for rendering Mail storage (Lotus Notes, MBox) data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options).

```csharp
public class MailStorageOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MailStorageOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AddressFilter { get; set; } | Sets the email-address used to filter messages by sender or recipient. |
| MaxItems { get; set; } | Sets the maximum number of messages or items to render. |
| TextFilter { get; set; } | Sets the keywords used to filter messages. |

### AddressFilter
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/mailstorageoptions/addressfilter.md

#### MailStorageOptions.AddressFilter property

Sets the email-address used to filter messages by sender or recipient.

```csharp
public string AddressFilter { get; set; }
```

##### Remarks

Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#filter-messages).

### MailStorageOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/mailstorageoptions/mailstorageoptions.md

#### MailStorageOptions constructor

The default constructor.

```csharp
public MailStorageOptions()
```

### MaxItems
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/mailstorageoptions/maxitems.md

#### MailStorageOptions.MaxItems property

Sets the maximum number of messages or items to render.

```csharp
public int MaxItems { get; set; }
```

##### Remarks

Mail storage data files can be large and retrieving all messages can take significant time. This property limits the maximum number of messages or items that are rendered. Default value is 0 - all messages are rendered.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#limit-the-number-of-items-to-render).

### TextFilter
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/mailstorageoptions/textfilter.md

#### MailStorageOptions.TextFilter property

Sets the keywords used to filter messages.

```csharp
public string TextFilter { get; set; }
```

##### Remarks

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#filter-messages).

### OutlookOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions.md

#### OutlookOptions class

Contains options for rendering Outlook data files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-lotus-notes-database-files/#specify-rendering-options).

```csharp
public class OutlookOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OutlookOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| AddressFilter { get; set; } | Sets the email-address used to filter messages by sender or recipient. |
| Folder { get; set; } | Sets the name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render. |
| MaxItemsInFolder { get; set; } | The maximum number of messages or items, that can be rendered from one folder. |
| TextFilter { get; set; } | Sets the keywords used to filter messages. |

### AddressFilter
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions/addressfilter.md

#### OutlookOptions.AddressFilter property

Sets the email-address used to filter messages by sender or recipient.

```csharp
public string AddressFilter { get; set; }
```

##### Remarks

Use this property to render all messages that contain specific text in the sender’s or recipient’s address. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#filter-messages).

### Folder
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions/folder.md

#### OutlookOptions.Folder property

Sets the name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render.

```csharp
public string Folder { get; set; }
```

##### Remarks

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder.

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#render-a-specific-folder).

### MaxItemsInFolder
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions/maxitemsinfolder.md

#### OutlookOptions.MaxItemsInFolder property

The maximum number of messages or items, that can be rendered from one folder.

```csharp
public int MaxItemsInFolder { get; set; }
```

##### Remarks

Outlook data files can be large and retrieving all messages can take significant time. This property limits the maximum number of messages or items that are rendered. Default value is `50`. To render all messages, set the value to `0`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#limit-the-number-of-folder-items-to-render).

### OutlookOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions/outlookoptions.md

#### OutlookOptions constructor

The default constructor.

```csharp
public OutlookOptions()
```

### TextFilter
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/outlookoptions/textfilter.md

#### OutlookOptions.TextFilter property

Sets the keywords used to filter messages.

```csharp
public string TextFilter { get; set; }
```

##### Remarks

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-outlook-data-files/#filter-messages).

### PageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pagesize.md

#### PageSize enumeration

The size of the page.

```csharp
public enum PageSize
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unspecified | `0` | The default, unspecified page size. |
| Letter | `1` | The size of the Letter page in points is 792 x 612 |
| Ledger | `2` | The size of the Ledger page in points is 1224 x 792 |
| A0 | `3` | The size of the A0 page in points is 3371 x 2384 |
| A1 | `4` | The size of the A1 page in points is 2384 x 1685 |
| A2 | `5` | The size of the A2 page in points is 1684 x 1190 |
| A3 | `6` | The size of the A3 page in points is 1190 x 842 |
| A4 | `7` | The size of the A4 page in points is 842 x 595 |

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions.md

#### PdfOptimizationOptions class

Contains the PDF optimization options to apply to the output PDF file. For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children.

```csharp
public class PdfOptimizationOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfOptimizationOptions() | Sets up default values of MaxResolution option to 300 and ImageQuality option to 100 |

#### Properties

| Name | Description |
| --- | --- |
| CompressImages { get; set; } | Enables compressing images in the output PDF file. |
| ConvertToGrayScale { get; set; } | Enables converting the output PDF file to a grayscale. |
| ImageQuality { get; set; } | Sets the image quality in the output PDF file (in percent). |
| Lineriaze { get; set; } | Enables optimization the output PDF file for viewing online with a web browser. |
| MaxResolution { get; set; } | Sets the maximum resolution in the output PDF file. |
| OptimizeSpreadsheets { get; set; } | Enables optimization of spreadsheets in the PDF files. |
| RemoveAnnotations { get; set; } | Enables removing annotation from the output PDF file. |
| RemoveFormFields { get; set; } | Enables removing form fields from a PDF file. |
| RemoveUnusedObjects { get; set; } | Removes unused (orphaned) objects from a PDF file, which are placed in the PDF document, but are not referenced from resource dictionaries of any page and thus are not used at all. Activating this property (`true`) will decrease the output PDF document size. By default is disabled (`false`). |
| RemoveUnusedStreams { get; set; } | Removes unused (orphaned) streams from a PDF file, which are still referenced from the resource dictionary of the page, but actually are never used in the page contents. By default is disabled (`false`), its enabling (`true`) will decrease the output PDF document size. |
| ResizeImages { get; set; } | Enables setting the maximum resolution in the output PDF file. |
| SubsetFonts { get; set; } | Subsets fonts in the output PDF file. |

### CompressImages
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/compressimages.md

#### PdfOptimizationOptions.CompressImages property

Enables compressing images in the output PDF file.

```csharp
public bool CompressImages { get; set; }
```

##### Remarks

Use this option to allow other compressing options: `ImageQuality` and `MaxResolution`. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-reduce-image-quality/).

### ConvertToGrayScale
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/converttograyscale.md

#### PdfOptimizationOptions.ConvertToGrayScale property

Enables converting the output PDF file to a grayscale.

```csharp
public bool ConvertToGrayScale { get; set; }
```

##### Remarks

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-convert-grayscale/).

### ImageQuality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/imagequality.md

#### PdfOptimizationOptions.ImageQuality property

Sets the image quality in the output PDF file (in percent).

```csharp
public int ImageQuality { get; set; }
```

##### Remarks

To change the image quality, first set the `CompressImages` property to `true`. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-reduce-image-quality/).

### Lineriaze
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze.md

#### PdfOptimizationOptions.Lineriaze property

Enables optimization the output PDF file for viewing online with a web browser.

```csharp
public bool Lineriaze { get; set; }
```

##### Remarks

This optimization allows a browser to display the first pages of a PDF file when you open the document, instead of waiting for the entire file to download. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-for-web/).

### MaxResolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/maxresolution.md

#### PdfOptimizationOptions.MaxResolution property

Sets the maximum resolution in the output PDF file.

```csharp
public int MaxResolution { get; set; }
```

##### Remarks

To allow this option, set the `CompressImages` and `MaxResolution` properties to `true`.

The default value is `300`.

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-set-max-resolution/).

### OptimizeSpreadsheets
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/optimizespreadsheets.md

#### PdfOptimizationOptions.OptimizeSpreadsheets property

Enables optimization of spreadsheets in the PDF files.

```csharp
public bool OptimizeSpreadsheets { get; set; }
```

##### Remarks

This optimization allows to reduce the output file size by setting up border lines. Besides that, it removes the Arial and Times New Roman characters of 32-127 codes.

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-spreadsheets/).

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/pdfoptimizationoptions.md

#### PdfOptimizationOptions constructor

Sets up default values of MaxResolution option to 300 and ImageQuality option to 100

```csharp
public PdfOptimizationOptions()
```

##### Remarks

For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children.

### RemoveAnnotations
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/removeannotations.md

#### PdfOptimizationOptions.RemoveAnnotations property

Enables removing annotation from the output PDF file.

```csharp
public bool RemoveAnnotations { get; set; }
```

##### Remarks

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-remove-annotations/).

### RemoveFormFields
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/removeformfields.md

#### PdfOptimizationOptions.RemoveFormFields property

Enables removing form fields from a PDF file.

```csharp
public bool RemoveFormFields { get; set; }
```

##### Remarks

For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-remove-fields/).

### RemoveUnusedObjects
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/removeunusedobjects.md

#### PdfOptimizationOptions.RemoveUnusedObjects property

Removes unused (orphaned) objects from a PDF file, which are placed in the PDF document, but are not referenced from resource dictionaries of any page and thus are not used at all. Activating this property (`true`) will decrease the output PDF document size. By default is disabled (`false`).

```csharp
public bool RemoveUnusedObjects { get; set; }
```

### RemoveUnusedStreams
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/removeunusedstreams.md

#### PdfOptimizationOptions.RemoveUnusedStreams property

Removes unused (orphaned) streams from a PDF file, which are still referenced from the resource dictionary of the page, but actually are never used in the page contents. By default is disabled (`false`), its enabling (`true`) will decrease the output PDF document size.

```csharp
public bool RemoveUnusedStreams { get; set; }
```

### ResizeImages
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/resizeimages.md

#### PdfOptimizationOptions.ResizeImages property

Enables setting the maximum resolution in the output PDF file.

```csharp
public bool ResizeImages { get; set; }
```

##### Remarks

To allow this option, set the `CompressImages` property to `true`. This option allows setting the `MaxResolution` property. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-set-max-resolution/).

### SubsetFonts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptimizationoptions/subsetfonts.md

#### PdfOptimizationOptions.SubsetFonts property

Subsets fonts in the output PDF file.

```csharp
public bool SubsetFonts { get; set; }
```

##### Remarks

If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation](https://docs.groupdocs.com/viewer/net/optimization-pdf-subset-fonts/).

### PdfOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions.md

#### PdfOptions class

Contains options for rendering to PDF documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/).

```csharp
public class PdfOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfOptions() | Initializes new instance of the `PdfOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| DisableCharsGrouping { get; set; } | Disables symbol grouping for precise symbol positioning during page rendering. |
| DisableCopyProtection { get; set; } | Turns off content copy protection when rendering to HTML. |
| DisableFontLicenseVerifications { get; set; } | Disables any license restrictions for all fonts in the current XPS/OXPS document. |
| EnableFontHinting { get; set; } | Enables font hinting. |
| EnableLayeredRendering { get; set; } | Enables rendering text and graphics in the original PDF document's z-order when rendering to HTML. |
| FixedLayout { get; set; } | Enables rendering the PDF and EPUB documents to HTML with a fixed layout. |
| ImageQuality { get; set; } | Sets the output image quality for image resources when rendering to HTML. The default quality is `Low`. |
| RenderOriginalPageSize { get; set; } | Sets the output page size the same as the source PDF document's page size. |
| RenderTextAsImage { get; set; } | Enables rendering texts in the PDF files as an image in the HTML output. |
| WrapImagesInSvg { get; set; } | Enables wrapping each image in the output HTML document in SVG tag to improve the output quality. |

### DisableCharsGrouping
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/disablecharsgrouping.md

#### PdfOptions.DisableCharsGrouping property

Disables symbol grouping for precise symbol positioning during page rendering.

```csharp
public bool DisableCharsGrouping { get; set; }
```

##### Remarks

When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is `false`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-character-grouping).

### DisableCopyProtection
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/disablecopyprotection.md

#### PdfOptions.DisableCopyProtection property

Turns off content copy protection when rendering to HTML.

```csharp
public bool DisableCopyProtection { get; set; }
```

##### Remarks

When rendering PDF files with protection against copying text and images to HTML, GroupDocs.Viewer adds an 'inert' HTML attribute to the HTML BODY tag. The default value of this option is `false`, indicating that the 'intent' HTML attribute is added only if the PDF document is protected.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-copy-protection).

### DisableFontLicenseVerifications
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/disablefontlicenseverifications.md

#### PdfOptions.DisableFontLicenseVerifications property

Disables any license restrictions for all fonts in the current XPS/OXPS document.

```csharp
public bool DisableFontLicenseVerifications { get; set; }
```

##### Remarks

Many operations with font cannot be executed if they are prohibited by license of this font. For example, some font cannot be embedded into PDF document if license rules disable embedding for this font. This option allows you to skip verification of these rules.

Be careful when using this flag. When it is set, it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So he takes it on its own risk. It is strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. The default value is `false`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files).

### EnableFontHinting
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/enablefonthinting.md

#### PdfOptions.EnableFontHinting property

Enables font hinting.

```csharp
public bool EnableFontHinting { get; set; }
```

##### Remarks

Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is `false`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enable-font-hinting).

### EnableLayeredRendering
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/enablelayeredrendering.md

#### PdfOptions.EnableLayeredRendering property

Enables rendering text and graphics in the original PDF document's z-order when rendering to HTML.

```csharp
public bool EnableLayeredRendering { get; set; }
```

##### Remarks

By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is `false`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enable-multi-layer-rendering).

### FixedLayout
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/fixedlayout.md

#### PdfOptions.FixedLayout property

Enables rendering the PDF and EPUB documents to HTML with a fixed layout.

```csharp
public bool FixedLayout { get; set; }
```

##### Remarks

PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document.

This option is only available when rendering to HTML. The default value is `true`. To render with a fluid layout, set this property to `false`.

When rendering to fluid layout, images are skipped. Use fluid layout when rendering PDF documents with text content.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#create-html-with-fluid-layout).

### ImageQuality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/imagequality.md

#### PdfOptions.ImageQuality property

Sets the output image quality for image resources when rendering to HTML. The default quality is `Low`.

```csharp
public ImageQuality ImageQuality { get; set; }
```

##### Remarks

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#adjust-image-quality-in-the-output-html-file).

### PdfOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/pdfoptions.md

#### PdfOptions constructor

Initializes new instance of the `PdfOptions` class.

```csharp
public PdfOptions()
```

### RenderOriginalPageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/renderoriginalpagesize.md

#### PdfOptions.RenderOriginalPageSize property

Sets the output page size the same as the source PDF document's page size.

```csharp
public bool RenderOriginalPageSize { get; set; }
```

##### Remarks

By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is `false`.

This option is available for rendering to PNG or JPG formats.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#preserve-the-size-of-document-pages).

### RenderTextAsImage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/rendertextasimage.md

#### PdfOptions.RenderTextAsImage property

Enables rendering texts in the PDF files as an image in the HTML output.

```csharp
public bool RenderTextAsImage { get; set; }
```

##### Remarks

When this option is set to `true`, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is `false`.

This option is available for rendering to HTML.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#render-text-as-an-image).

### WrapImagesInSvg
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfoptions/wrapimagesinsvg.md

#### PdfOptions.WrapImagesInSvg property

Enables wrapping each image in the output HTML document in SVG tag to improve the output quality.

```csharp
public bool WrapImagesInSvg { get; set; }
```

##### Remarks

By default, when rendering PDF and Page Layout files to HTML, all images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document.

This option is available when rendering [PDF and Page Layout file formats](https://docs.groupdocs.com/viewer/net/supported-document-formats/#pdf-and-page-layout-file-formats) to HTML with embedded and external resources. It enables wrapping each image in the output HTML document in SVG tag. The default value is `false`.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/render-pdf-documents/#enclose-images-in-svg-when-rendering-pdf-and-page-layout-files).

### PdfViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions.md

#### PdfViewOptions class

Contains options for rendering documents into PDF format. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

```csharp
public class PdfViewOptions : ViewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfViewOptions() | Initializes an instance of `PdfViewOptions` class. |
| PdfViewOptions(CreateFileStream) | Initializes an instance of `PdfViewOptions` class. |
| PdfViewOptions(IFileStreamFactory) | Initializes an instance of `PdfViewOptions` class. |
| PdfViewOptions(string) | Initializes an instance of `PdfViewOptions` class. |
| PdfViewOptions(CreateFileStream, ReleaseFileStream) | Initializes an instance of `PdfViewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| ImageHeight { get; set; } | Sets the height of an output image (in pixels). |
| ImageMaxHeight { get; set; } | Sets the maximum height of an output image (in pixels). |
| ImageMaxWidth { get; set; } | Sets the maximum width of an output image (in pixels). |
| ImageWidth { get; set; } | Sets the width of an output image (in pixels). |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptimizationOptions { get; set; } | Reduces output PDF file size by applying optimization techniques with different options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| Security { get; set; } | Sets the output PDF document security options. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| Watermark { get; set; } | The text watermark to be applied to each page. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| RotatePage(int, Rotation) | Applies the clockwise rotation to a page. |

#### Fields

| Name | Description |
| --- | --- |
| readonly PageRotations | The page rotation. |

### ImageHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/imageheight.md

#### PdfViewOptions.ImageHeight property

Sets the height of an output image (in pixels).

```csharp
public int ImageHeight { get; set; }
```

##### Remarks

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/).

If you set this property, the `ImageMaxHeight` property is ignored.

### ImageMaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/imagemaxheight.md

#### PdfViewOptions.ImageMaxHeight property

Sets the maximum height of an output image (in pixels).

```csharp
public int ImageMaxHeight { get; set; }
```

##### Remarks

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/).

If you set the `ImageHeight` property, this property is ignored.

### ImageMaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/imagemaxwidth.md

#### PdfViewOptions.ImageMaxWidth property

Sets the maximum width of an output image (in pixels).

```csharp
public int ImageMaxWidth { get; set; }
```

##### Remarks

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/).

If you set the `ImageWidth` property, this property is ignored.

### ImageWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/imagewidth.md

#### PdfViewOptions.ImageWidth property

Sets the width of an output image (in pixels).

```csharp
public int ImageWidth { get; set; }
```

##### Remarks

Use this property to set the output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/).

If you set this property, the `ImageMaxWidth` property is ignored.

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/pdfoptimizationoptions.md

#### PdfViewOptions.PdfOptimizationOptions property

Reduces output PDF file size by applying optimization techniques with different options.

```csharp
public PdfOptimizationOptions PdfOptimizationOptions { get; set; }
```

##### Remarks

For details and code samples, see this [page](https://docs.groupdocs.com/viewer/net/optimization-pdf-options/) and its children.

### PdfViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/pdfviewoptions.md

#### PdfViewOptions(CreateFileStream)

Initializes an instance of `PdfViewOptions` class.

```csharp
public PdfViewOptions(CreateFileStream createFileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream | The method that instantiates stream used to write output file data. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createFileStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

#### PdfViewOptions(CreateFileStream, ReleaseFileStream)

Initializes an instance of `PdfViewOptions` class.

```csharp
public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream | The method that instantiates stream used to write output file data. |
| releaseFileStream | ReleaseFileStream | The method that releases stream created by method assigned to delegate that passed to *createFileStream* parameter. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createFileStream* is null. |
| ArgumentNullException | Thrown when *releaseFileStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

#### PdfViewOptions(IFileStreamFactory)

Initializes an instance of `PdfViewOptions` class.

```csharp
public PdfViewOptions(IFileStreamFactory fileStreamFactory)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileStreamFactory | IFileStreamFactory | The factory which implements methods for creating and releasing output file stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileStreamFactory* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

#### PdfViewOptions()

Initializes an instance of `PdfViewOptions` class.

```csharp
public PdfViewOptions()
```

##### Remarks

This constructor Initializes an instance of `PdfViewOptions` with "output.pdf" as file path format for the output file. The output file will be placed into current working directory of the application.

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

#### PdfViewOptions(string)

Initializes an instance of `PdfViewOptions` class.

```csharp
public PdfViewOptions(string outputFilePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | String | The path for output PDF file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *outputFilePath* is null or empty. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-pdf/).

### Security
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pdfviewoptions/security.md

#### PdfViewOptions.Security property

Sets the output PDF document security options.

```csharp
public Security Security { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/).

### Permissions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/permissions.md

#### Permissions enumeration

Defines PDF document permissions.

```csharp
[Flags]
public enum Permissions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllowAll | `0` | Allow printing, modification and data extraction. |
| DenyPrinting | `1` | Deny printing. |
| DenyModification | `2` | Deny content modification, filling in forms, adding or modifying annotations. |
| DenyDataExtraction | `4` | Deny text and graphics extraction. |
| DenyAll | `7` | Deny printing, content modification and data extraction. |

### PngViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions.md

#### PngViewOptions class

Contains options for rendering documents into PNG format. For details, see this [page](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/) and its children.

```csharp
public class PngViewOptions : ViewOptions, IMaxSizeOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PngViewOptions() | Initializes an instance of the `PngViewOptions` class. |
| PngViewOptions(CreatePageStream) | Initializes an instance of the `PngViewOptions` class. |
| PngViewOptions(IPageStreamFactory) | Initializes an instance of the `PngViewOptions` class. |
| PngViewOptions(string) | Initializes an instance of the `PngViewOptions` class. |
| PngViewOptions(CreatePageStream, ReleasePageStream) | Initializes an instance of the `PngViewOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| ExtractText { get; set; } | Enables text extraction. |
| Height { get; set; } | Sets the height of an output image (in pixels). |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| MaxHeight { get; set; } | Sets the maximum height of an output image (in pixels). |
| MaxWidth { get; set; } | Sets the maximum width of an output image (in pixels). |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| Watermark { get; set; } | The text watermark to be applied to each page. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| Width { get; set; } | The width of the output image (in pixels). |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| RotatePage(int, Rotation) | Applies the clockwise rotation to a page. |

#### Fields

| Name | Description |
| --- | --- |
| readonly PageRotations | The page rotation. |

### ExtractText
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/extracttext.md

#### PngViewOptions.ExtractText property

Enables text extraction.

```csharp
public bool ExtractText { get; set; }
```

##### Remarks

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/).

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/height.md

#### PngViewOptions.Height property

Sets the height of an output image (in pixels).

```csharp
public int Height { get; set; }
```

##### Remarks

Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxHeight` property is ignored.

### MaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/maxheight.md

#### PngViewOptions.MaxHeight property

Sets the maximum height of an output image (in pixels).

```csharp
public int MaxHeight { get; set; }
```

##### Remarks

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Height` property, this property is ignored.

### MaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/maxwidth.md

#### PngViewOptions.MaxWidth property

Sets the maximum width of an output image (in pixels).

```csharp
public int MaxWidth { get; set; }
```

##### Remarks

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Width` property, this property is ignored.

### PngViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/pngviewoptions.md

#### PngViewOptions(CreatePageStream)

Initializes an instance of the `PngViewOptions` class.

```csharp
public PngViewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png).

#### PngViewOptions(CreatePageStream, ReleasePageStream)

Initializes an instance of the `PngViewOptions` class.

```csharp
public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases a stream created by method assigned to delegate that passed to *createPageStream* parameter. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *createPageStream* is null. |
| ArgumentNullException | Thrown when *releasePageStream* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png).

#### PngViewOptions(IPageStreamFactory)

Initializes an instance of the `PngViewOptions` class.

```csharp
public PngViewOptions(IPageStreamFactory pageStreamFactory)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | IPageStreamFactory | The factory which implements methods for creating and releasing output page stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pageStreamFactory* is null. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png).

#### PngViewOptions()

Initializes an instance of the `PngViewOptions` class.

```csharp
public PngViewOptions()
```

##### Remarks

This constructor initializes an instance of the `PngViewOptions` with "p_{0}.png" as file path format for the output files. The output files are placed into current working directory of the application.

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png).

#### PngViewOptions(string)

Initializes an instance of the `PngViewOptions` class.

```csharp
public PngViewOptions(string filePathFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | String | The file path format e.g. 'page_{0}.png'. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePathFormat* is null or empty. |

##### Remarks

For the code example, see the [documentation](https://docs.groupdocs.com/viewer/net/rendering-to-png-or-jpeg/#rendering-to-png).

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/pngviewoptions/width.md

#### PngViewOptions.Width property

The width of the output image (in pixels).

```csharp
public int Width { get; set; }
```

##### Remarks

Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxWidth` property is ignored.

### Position
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/position.md

#### Position enumeration

Defines the watermark position.

```csharp
public enum Position
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Diagonal | `0` | The diagonal position. |
| TopLeft | `1` | The top left position. |
| TopCenter | `2` | The top center position. |
| TopRight | `3` | The top right position. |
| BottomLeft | `4` | The bottom left position. |
| BottomCenter | `5` | The bottom center position. |
| BottomRight | `6` | The bottom right position. |

### PresentationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/presentationoptions.md

#### PresentationOptions class

Contains options for rendering presentations. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/).

```csharp
public class PresentationOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| RenderHeaderFooterPlaceholders { get; set; } | Enables rendering placeholders in header and footer of a slide. Disabled by default (`false`). This option applies for all 4 rendering modes of presentations: HTML, PDF, PNG, and JPEG. Is not applicable when rendering presentation to pure HTML/CSS markup using `RenderToPureHtml`. |
| RenderToPureHtml { get; set; } | Enables a new HTML rendering mode for the Presentation documents — in this mode the Presentation files are rendered to **pure HTML/CSS markup**, without SVG images. By default is disabled (`false`) — existing SVG-based HTML-renderer is used. |
| Resolution { get; set; } | Resolution of the presentation images (for rendering to HTML/PDF only). |

### PresentationOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/presentationoptions/presentationoptions.md

#### PresentationOptions constructor

The default constructor.

```csharp
public PresentationOptions()
```

### RenderHeaderFooterPlaceholders
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/presentationoptions/renderheaderfooterplaceholders.md

#### PresentationOptions.RenderHeaderFooterPlaceholders property

Enables rendering placeholders in header and footer of a slide. Disabled by default (`false`). This option applies for all 4 rendering modes of presentations: HTML, PDF, PNG, and JPEG. Is not applicable when rendering presentation to pure HTML/CSS markup using `RenderToPureHtml`.

```csharp
public bool RenderHeaderFooterPlaceholders { get; set; }
```

### RenderToPureHtml
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/presentationoptions/rendertopurehtml.md

#### PresentationOptions.RenderToPureHtml property

Enables a new HTML rendering mode for the Presentation documents — in this mode the Presentation files are rendered to **pure HTML/CSS markup**, without SVG images. By default is disabled (`false`) — existing SVG-based HTML-renderer is used.

```csharp
public bool RenderToPureHtml { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#generate-pure-htmlcss-markup).

### Resolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/presentationoptions/resolution.md

#### PresentationOptions.Resolution property

Resolution of the presentation images (for rendering to HTML/PDF only).

```csharp
public Resolution Resolution { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-presentations/#specify-image-resolution).

### ProjectManagementOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions.md

#### ProjectManagementOptions class

Contains options for rendering project management files. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/).

```csharp
public class ProjectManagementOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ProjectManagementOptions() | Creates an instance of the `ProjectManagementOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| EndDate { get; set; } | The end date of the Gantt Chart View to be included into the output. |
| PageSize { get; set; } | The output page size. |
| StartDate { get; set; } | The start date of the Gantt Chart View to be included into the output. |
| TimeUnit { get; set; } | The time unit. |

### EndDate
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions/enddate.md

#### ProjectManagementOptions.EndDate property

The end date of the Gantt Chart View to be included into the output.

```csharp
public DateTime EndDate { get; set; }
```

### PageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions/pagesize.md

#### ProjectManagementOptions.PageSize property

The output page size.

```csharp
public PageSize PageSize { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#specify-the-output-page-size).

### ProjectManagementOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions/projectmanagementoptions.md

#### ProjectManagementOptions constructor

Creates an instance of the `ProjectManagementOptions` class.

```csharp
public ProjectManagementOptions()
```

### StartDate
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions/startdate.md

#### ProjectManagementOptions.StartDate property

The start date of the Gantt Chart View to be included into the output.

```csharp
public DateTime StartDate { get; set; }
```

### TimeUnit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/projectmanagementoptions/timeunit.md

#### ProjectManagementOptions.TimeUnit property

The time unit.

```csharp
public TimeUnit TimeUnit { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#adjust-the-time-unit).

### Resolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution.md

#### Resolution class

Contains option to set resolution for images in output document.

```csharp
public class Resolution
```

#### Constructors

| Name | Description |
| --- | --- |
| Resolution(int) | Sets resolution in DPI. |

#### Properties

| Name | Description |
| --- | --- |
| Value { get; } | Quality DPI. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly DocumentResolution | Default compression level - as in the document. |
| static readonly Dpi150 | Good for web pages and projectors. |
| static readonly Dpi220 | Excellent quality on most printers and screens. |
| static readonly Dpi330 | Good quality for high-definition (HD) displays. |
| static readonly Dpi72 | Default compression level. |
| static readonly Dpi96 | Good for web pages and projectors. |

### DocumentResolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/documentresolution.md

#### Resolution.DocumentResolution field

Default compression level - as in the document.

```csharp
public static readonly Resolution DocumentResolution;
```

### Dpi150
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/dpi150.md

#### Resolution.Dpi150 field

Good for web pages and projectors.

```csharp
public static readonly Resolution Dpi150;
```

### Dpi220
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/dpi220.md

#### Resolution.Dpi220 field

Excellent quality on most printers and screens.

```csharp
public static readonly Resolution Dpi220;
```

### Dpi330
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/dpi330.md

#### Resolution.Dpi330 field

Good quality for high-definition (HD) displays.

```csharp
public static readonly Resolution Dpi330;
```

### Dpi72
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/dpi72.md

#### Resolution.Dpi72 field

Default compression level.

```csharp
public static readonly Resolution Dpi72;
```

### Dpi96
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/dpi96.md

#### Resolution.Dpi96 field

Good for web pages and projectors.

```csharp
public static readonly Resolution Dpi96;
```

### Resolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/resolution.md

#### Resolution constructor

Sets resolution in DPI.

```csharp
public Resolution(int value)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | Int32 | Resolution in DPI. |

### Value
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/resolution/value.md

#### Resolution.Value property

Quality DPI.

```csharp
public int Value { get; }
```

### Rotation
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/rotation.md

#### Rotation enumeration

Contains page rotation in degrees (clockwise).

```csharp
public enum Rotation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| On90Degree | `0` | The 90 degree page rotation. |
| On180Degree | `1` | The 180 degree page rotation. |
| On270Degree | `2` | The 270 degree page rotation. |

### SearchHighlightOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions.md

#### SearchHighlightOptions class

Provides options for searching and highlighting text in the documents, loaded to the `Viewer` class

```csharp
public sealed class SearchHighlightOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SearchHighlightOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets the background color for highlighting |
| ForegroundColor { get; set; } | Gets or sets the foreground (text) color for highlighting |
| IsSearchTermRegEx { get; set; } | Gets or sets a value indicating whether the search term should be treated as a regular expression or as a text literal. Default is `false` — treat as a text literal. |
| SearchTerm { get; set; } | Gets or sets the text (or regex pattern, if `IsSearchTermRegEx` property is `true`) to search for. |

### BackgroundColor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions/backgroundcolor.md

#### SearchHighlightOptions.BackgroundColor property

Gets or sets the background color for highlighting

```csharp
public Argb32Color BackgroundColor { get; set; }
```

##### Remarks

If this color is empty or fully transparent, a default color `Argb32Color.Yellow` will be used

### ForegroundColor
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions/foregroundcolor.md

#### SearchHighlightOptions.ForegroundColor property

Gets or sets the foreground (text) color for highlighting

```csharp
public Argb32Color ForegroundColor { get; set; }
```

##### Remarks

If this color is empty or fully transparent, no explicit foreground color is applied (leaving the original text color)

### IsSearchTermRegEx
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions/issearchtermregex.md

#### SearchHighlightOptions.IsSearchTermRegEx property

Gets or sets a value indicating whether the search term should be treated as a regular expression or as a text literal. Default is `false` — treat as a text literal.

```csharp
public bool IsSearchTermRegEx { get; set; }
```

##### Remarks

If `true`, `SearchTerm` is interpreted as a .NET Regex pattern.

If `false`, `SearchTerm` is searched as a text literal in the document.

### SearchHighlightOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions/searchhighlightoptions.md

#### SearchHighlightOptions constructor

The default constructor.

```csharp
public SearchHighlightOptions()
```

### SearchTerm
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/searchhighlightoptions/searchterm.md

#### SearchHighlightOptions.SearchTerm property

Gets or sets the text (or regex pattern, if `IsSearchTermRegEx` property is `true`) to search for.

```csharp
public string SearchTerm { get; set; }
```

##### Remarks

If `IsSearchTermRegEx` is `true`, this property should contain a valid regular expression pattern.

### Security
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/security.md

#### Security class

Contains the PDF document security options. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/).

```csharp
public class Security
```

#### Constructors

| Name | Description |
| --- | --- |
| Security() | Initializes an instance of the `Security` class. |

#### Properties

| Name | Description |
| --- | --- |
| DocumentOpenPassword { get; set; } | The password required to open the PDF document. |
| Permissions { get; set; } | The PDF document permissions such as printing, modification and data extraction. |
| PermissionsPassword { get; set; } | The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction. |

### DocumentOpenPassword
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/security/documentopenpassword.md

#### Security.DocumentOpenPassword property

The password required to open the PDF document.

```csharp
public string DocumentOpenPassword { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/).

### Permissions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/security/permissions.md

#### Security.Permissions property

The PDF document permissions such as printing, modification and data extraction.

```csharp
public Permissions Permissions { get; set; }
```

##### Remarks

For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/).

### PermissionsPassword
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/security/permissionspassword.md

#### Security.PermissionsPassword property

The password required to change permission settings. Using a permissions password you can restrict printing, modification and data extraction.

```csharp
public string PermissionsPassword { get; set; }
```

##### Remarks

Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation](https://docs.groupdocs.com/viewer/net/protect-pdf-documents/).

### Security
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/security/security.md

#### Security constructor

Initializes an instance of the `Security` class.

```csharp
public Security()
```

### Size
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size.md

#### Size class

Contains the watermark size.

```csharp
public class Size
```

#### Constructors

| Name | Description |
| --- | --- |
| Size(byte) | Initializes an instance of the `Size` class. |

#### Properties

| Name | Description |
| --- | --- |
| RelativeSize { get; } | The watermark text size in percentages in relation to page width. Valid values are between 1 and 100. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly FullSize | The maximum size of watermark text that fits page. |
| static readonly HalfSize | The half of the maximum size of watermark text that fits page. |
| static readonly OneThird | The one third of the maximum size of watermark text that fits page. |

### FullSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size/fullsize.md

#### Size.FullSize field

The maximum size of watermark text that fits page.

```csharp
public static readonly Size FullSize;
```

### HalfSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size/halfsize.md

#### Size.HalfSize field

The half of the maximum size of watermark text that fits page.

```csharp
public static readonly Size HalfSize;
```

### OneThird
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size/onethird.md

#### Size.OneThird field

The one third of the maximum size of watermark text that fits page.

```csharp
public static readonly Size OneThird;
```

### RelativeSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size/relativesize.md

#### Size.RelativeSize property

The watermark text size in percentages in relation to page width. Valid values are between 1 and 100.

```csharp
public byte RelativeSize { get; }
```

### Size
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/size/size.md

#### Size constructor

Initializes an instance of the `Size` class.

```csharp
public Size(byte relativeSize)
```

| Parameter | Type | Description |
| --- | --- | --- |
| relativeSize | Byte | The size in percents in relation to page size. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Thrown when *relativeSize* is zero or higher than 100. |

### SpreadsheetOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions.md

#### SpreadsheetOptions class

Contains options for rendering spreadsheets. For details, see children of the [Render spreadsheet files](https://docs.groupdocs.com/viewer/net/render-spreadsheets/) topic.

```csharp
public class SpreadsheetOptions
```

#### Properties

| Name | Description |
| --- | --- |
| BottomMargin { get; set; } | Sets the bottom margin of a page when converting to PDF. |
| CountColumnsPerPage { get; } | The columns count to include on each page when splitting the worksheet into pages. |
| CountRowsPerPage { get; } | The rows count to include on each page when splitting the worksheet into pages. |
| DetectSeparator { get; set; } | Detect a separator (for CSV/TSV files). |
| HorizontalResolution { get; set; } | Gets or sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only. |
| LeftMargin { get; set; } | Sets the left margin of a page when converting to PDF. |
| RenderGridLines { get; set; } | Enables grid lines rendering. |
| RenderHeadings { get; set; } | Enables headings rendering. |
| RenderHiddenColumns { get; set; } | Enables hidden columns rendering. |
| RenderHiddenRows { get; set; } | Enables hidden rows rendering. |
| RightMargin { get; set; } | Sets the right margin of a page when converting to PDF. |
| SkipEmptyColumns { get; set; } | Disables empty columns rendering. |
| SkipEmptyRows { get; set; } | Disables empty rows rendering. |
| TextOverflowMode { get; set; } | Sets the text overflow mode for rendering spreadsheet documents into HTML. By default is , which mimics the default MS Excel behavior. |
| TopMargin { get; set; } | Sets the top margin of a page when converting to PDF. |
| VerticalResolution { get; set; } | Gets or sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only. |

#### Methods

| Name | Description |
| --- | --- |
| static ForOnePagePerSheet() | Initializes an instance of the `SpreadsheetOptions` class for rendering the whole sheet into one page. |
| static ForRenderingByPageBreaks() | Initializes an instance of the `SpreadsheetOptions` class for splitting to pages by page breaks. |
| static ForRenderingPrintArea() | Initializes an instance of the `SpreadsheetOptions` class for rendering the print areas only. |
| static ForRenderingPrintAreaAndPageBreaks() | Initializes an instance of the `SpreadsheetOptions` class for rendering print areas and page breaks. |
| static ForSplitSheetIntoPages(int) | Initializes an instance of the `SpreadsheetOptions` class for rendering sheet into pages. |
| static ForSplitSheetIntoPages(int, int) | Initializes an instance of the `SpreadsheetOptions` class for rendering sheet into pages. |

### BottomMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/bottommargin.md

#### SpreadsheetOptions.BottomMargin property

Sets the bottom margin of a page when converting to PDF.

```csharp
public double BottomMargin { get; set; }
```

##### Remarks

If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages).

### CountColumnsPerPage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/countcolumnsperpage.md

#### SpreadsheetOptions.CountColumnsPerPage property

The columns count to include on each page when splitting the worksheet into pages.

```csharp
public int CountColumnsPerPage { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns).

### CountRowsPerPage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/countrowsperpage.md

#### SpreadsheetOptions.CountRowsPerPage property

The rows count to include on each page when splitting the worksheet into pages.

```csharp
public int CountRowsPerPage { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows).

### DetectSeparator
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/detectseparator.md

#### SpreadsheetOptions.DetectSeparator property

Detect a separator (for CSV/TSV files).

```csharp
public bool DetectSeparator { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator).

### ForOnePagePerSheet
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/foronepagepersheet.md

#### SpreadsheetOptions.ForOnePagePerSheet method

Initializes an instance of the `SpreadsheetOptions` class for rendering the whole sheet into one page.

```csharp
public static SpreadsheetOptions ForOnePagePerSheet()
```

##### Return Value

New instance of the `SpreadsheetOptions` class for rendering the whole sheet into one page.

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-a-worksheet-on-one-page).

### ForRenderingByPageBreaks
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingbypagebreaks.md

#### SpreadsheetOptions.ForRenderingByPageBreaks method

Initializes an instance of the `SpreadsheetOptions` class for splitting to pages by page breaks.

```csharp
public static SpreadsheetOptions ForRenderingByPageBreaks()
```

##### Return Value

New instance of `SpreadsheetOptions` for splitting to pages by page breaks. The behavior is similar to printing in Excel.

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/).

### ForRenderingPrintArea
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintarea.md

#### SpreadsheetOptions.ForRenderingPrintArea method

Initializes an instance of the `SpreadsheetOptions` class for rendering the print areas only.

```csharp
public static SpreadsheetOptions ForRenderingPrintArea()
```

##### Return Value

New instance of the `SpreadsheetOptions` class for rendering print areas only.

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-a-print-area).

### ForRenderingPrintAreaAndPageBreaks
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/forrenderingprintareaandpagebreaks.md

#### SpreadsheetOptions.ForRenderingPrintAreaAndPageBreaks method

Initializes an instance of the `SpreadsheetOptions` class for rendering print areas and page breaks.

```csharp
public static SpreadsheetOptions ForRenderingPrintAreaAndPageBreaks()
```

##### Return Value

New instance of the `SpreadsheetOptions` class for rendering pages basing on page brakes that are included into print area. The behavior is similar to printing in Excel.

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#render-worksheet-by-page-breaks-and-print-area).

### ForSplitSheetIntoPages
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/forsplitsheetintopages.md

#### ForSplitSheetIntoPages(int)

Initializes an instance of the `SpreadsheetOptions` class for rendering sheet into pages.

```csharp
public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage)
```

| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | Int32 | Count of rows to include into each page. |

##### Return Value

New instance of the `SpreadsheetOptions` class for rendering sheet into pages.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *countRowsPerPage* is equals or less than zero. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows).

#### ForSplitSheetIntoPages(int, int)

Initializes an instance of the `SpreadsheetOptions` class for rendering sheet into pages.

```csharp
public static SpreadsheetOptions ForSplitSheetIntoPages(int countRowsPerPage, 
    int countColumnsPerPage)
```

| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | Int32 | Count of rows to include into each page. |
| countColumnsPerPage | Int32 | Count of columns to include into each page. |

##### Return Value

New instance of the `SpreadsheetOptions` class for rendering sheet into pages.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *countRowsPerPage* is equals or less than zero. |
| ArgumentException | Thrown when *countColumnsPerPage* is equals or less than zero. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns).

### HorizontalResolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/horizontalresolution.md

#### SpreadsheetOptions.HorizontalResolution property

Gets or sets the horizontal resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

```csharp
public int HorizontalResolution { get; set; }
```

##### Remarks

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If user-specified value is out of these limits, the min or max possible value will be applied.

### LeftMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/leftmargin.md

#### SpreadsheetOptions.LeftMargin property

Sets the left margin of a page when converting to PDF.

```csharp
public double LeftMargin { get; set; }
```

##### Remarks

If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages).

### RenderGridLines
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/rendergridlines.md

#### SpreadsheetOptions.RenderGridLines property

Enables grid lines rendering.

```csharp
public bool RenderGridLines { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-worksheet-gridlines).

### RenderHeadings
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/renderheadings.md

#### SpreadsheetOptions.RenderHeadings property

Enables headings rendering.

```csharp
public bool RenderHeadings { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-row-and-column-headings).

### RenderHiddenColumns
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddencolumns.md

#### SpreadsheetOptions.RenderHiddenColumns property

Enables hidden columns rendering.

```csharp
public bool RenderHiddenColumns { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-hidden-rows-and-columns).

### RenderHiddenRows
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/renderhiddenrows.md

#### SpreadsheetOptions.RenderHiddenRows property

Enables hidden rows rendering.

```csharp
public bool RenderHiddenRows { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#render-hidden-rows-and-columns).

### RightMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/rightmargin.md

#### SpreadsheetOptions.RightMargin property

Sets the right margin of a page when converting to PDF.

```csharp
public double RightMargin { get; set; }
```

##### Remarks

If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages).

### SkipEmptyColumns
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/skipemptycolumns.md

#### SpreadsheetOptions.SkipEmptyColumns property

Disables empty columns rendering.

```csharp
public bool SkipEmptyColumns { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#skip-empty-rows-and-columns).

### SkipEmptyRows
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/skipemptyrows.md

#### SpreadsheetOptions.SkipEmptyRows property

Disables empty rows rendering.

```csharp
public bool SkipEmptyRows { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#skip-empty-rows-and-columns).

### TextOverflowMode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/textoverflowmode.md

#### SpreadsheetOptions.TextOverflowMode property

Sets the text overflow mode for rendering spreadsheet documents into HTML. By default is , which mimics the default MS Excel behavior.

```csharp
public TextOverflowMode TextOverflowMode { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#control-cell-text-overflow).

### TopMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/topmargin.md

#### SpreadsheetOptions.TopMargin property

Sets the top margin of a page when converting to PDF.

```csharp
public double TopMargin { get; set; }
```

##### Remarks

If the parameter is less than 0, then the default value is used. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages).

### VerticalResolution
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/spreadsheetoptions/verticalresolution.md

#### SpreadsheetOptions.VerticalResolution property

Gets or sets the vertical resolution for generated images in dots per inch. This option is used when rendering spreadsheets to PNG or JPEG formats only.

```csharp
public int VerticalResolution { get; set; }
```

##### Remarks

Default value is 96 DPI. Min possible value - 72 DPI, max possible value - 600 DPI. If user-specified value is out of these limits, the min or max possible value will be applied.

### TextOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/textoptions.md

#### TextOptions class

Text files splitting to pages options.

```csharp
public class TextOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TextOptions() | Initializes an instance of the `TextOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| MaxCharsPerRow { get; set; } | The maximum number of characters per row on a page. |
| MaxRowsPerPage { get; set; } | The maximum number of rows per page. |

### MaxCharsPerRow
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/textoptions/maxcharsperrow.md

#### TextOptions.MaxCharsPerRow property

The maximum number of characters per row on a page.

```csharp
public int MaxCharsPerRow { get; set; }
```

##### Remarks

The default value is 85. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options).

### MaxRowsPerPage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/textoptions/maxrowsperpage.md

#### TextOptions.MaxRowsPerPage property

The maximum number of rows per page.

```csharp
public int MaxRowsPerPage { get; set; }
```

##### Remarks

The default value is 55. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options).

### TextOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/textoptions/textoptions.md

#### TextOptions constructor

Initializes an instance of the `TextOptions` class.

```csharp
public TextOptions()
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-text-files/#specify-rendering-options).

### TextOverflowMode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/textoverflowmode.md

#### TextOverflowMode enumeration

Sets the text overflow mode for rendering spreadsheet documents into HTML.

```csharp
public enum TextOverflowMode
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Overlay | `0` | Overlay next cells even they are not empty. |
| OverlayIfNextIsEmpty | `1` | Overlay next cells only if they are empty. Default value. |
| AutoFitColumn | `2` | Expand columns to fit the text. |
| HideText | `3` | Hide overflow text. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-rendering-options/#control-cell-text-overflow).

### Tile
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile.md

#### Tile class

Represents the drawing region.

```csharp
public class Tile
```

#### Constructors

| Name | Description |
| --- | --- |
| Tile(int, int, int, int) | Initializes an instance of the `Tile` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | The height of the tile in pixels. |
| StartPointX { get; } | The X coordinate of the lowest left point on the drawing where the tile begins. |
| StartPointY { get; } | The Y coordinate of the lowest left point on the drawing where the tile begins. |
| Width { get; } | The width of the tile in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| GetEndPointX() | Returns the X coordinate of the highest right point on the drawing where the tile ends. |
| GetEndPointY() | Returns the Y coordinate of the highest right point on the drawing where the tile ends. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### GetEndPointX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/getendpointx.md

#### Tile.GetEndPointX method

Returns the X coordinate of the highest right point on the drawing where the tile ends.

```csharp
public int GetEndPointX()
```

### GetEndPointY
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/getendpointy.md

#### Tile.GetEndPointY method

Returns the Y coordinate of the highest right point on the drawing where the tile ends.

```csharp
public int GetEndPointY()
```

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/height.md

#### Tile.Height property

The height of the tile in pixels.

```csharp
public int Height { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### StartPointX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/startpointx.md

#### Tile.StartPointX property

The X coordinate of the lowest left point on the drawing where the tile begins.

```csharp
public int StartPointX { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### StartPointY
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/startpointy.md

#### Tile.StartPointY property

The Y coordinate of the lowest left point on the drawing where the tile begins.

```csharp
public int StartPointY { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### Tile
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/tile.md

#### Tile constructor

Initializes an instance of the `Tile` class.

```csharp
public Tile(int startPointX, int startPointY, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| startPointX | Int32 | The X coordinate of the lowest left point on the drawing where the tile begins |
| startPointY | Int32 | The Y coordinate of the lowest left point on the drawing where the tile begins. |
| width | Int32 | The width of the tile in pixels. |
| height | Int32 | The height of the tile in pixels. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/tile/width.md

#### Tile.Width property

The width of the tile in pixels.

```csharp
public int Width { get; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/specify-cad-rendering-options/#split-a-drawing-into-tiles).

### TimeUnit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/timeunit.md

#### TimeUnit enumeration

Time unit of the project duration.

```csharp
public enum TimeUnit
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unspecified | `0` | The unknown, unspecified time scale. |
| Days | `1` | The one day interval. |
| ThirdsOfMonths | `10` | The one third of the month. |
| Months | `30` | The one month interval. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-ms-project-files/#adjust-the-time-unit).

### ViewInfoOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions.md

#### ViewInfoOptions class

Contains options for retrieving information about view.

```csharp
public class ViewInfoOptions : BaseViewOptions, IMaxSizeOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| ExtractText { get; set; } | Enables text extraction. |
| Height { get; set; } | The height of the output image (in pixels, for rendering to PNG/JPG only). |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| MaxHeight { get; set; } | Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only). |
| MaxWidth { get; set; } | Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only). |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| Width { get; set; } | The width of the output image (in pixels, for rendering to PNG/JPG only). |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| static ForHtmlView() | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into HTML. |
| static ForHtmlView(bool) | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into HTML. |
| static ForJpgView() | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into JPG. |
| static ForJpgView(bool) | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into JPG. |
| static ForPdfView() | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PDF. |
| static ForPngView() | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PNG. |
| static ForPngView(bool) | Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PNG. |
| static FromHtmlViewOptions(HtmlViewOptions) | Initializes an instance of the `ViewInfoOptions` class based on the `HtmlViewOptions` object. |
| static FromJpgViewOptions(JpgViewOptions) | Initializes an instance of the `ViewInfoOptions` class based on the `JpgViewOptions` object. |
| static FromPdfViewOptions(PdfViewOptions) | Initializes an instance of the `ViewInfoOptions` class based on the `PdfViewOptions` object. |
| static FromPngViewOptions(PngViewOptions) | Initializes an instance of the `ViewInfoOptions` class based on the `PngViewOptions` object. |

### ExtractText
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/extracttext.md

#### ViewInfoOptions.ExtractText property

Enables text extraction.

```csharp
public bool ExtractText { get; set; }
```

##### Remarks

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.

For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/).

### ForHtmlView
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/forhtmlview.md

#### ForHtmlView()

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into HTML.

```csharp
public static ViewInfoOptions ForHtmlView()
```

##### Return Value

New instance of the `ViewInfoOptions` class.

#### ForHtmlView(bool)

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into HTML.

```csharp
public static ViewInfoOptions ForHtmlView(bool renderSinglePage)
```

| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | Boolean | Enables HTML content rendering to a single page. |

##### Return Value

New instance of the `ViewInfoOptions` class.

### ForJpgView
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/forjpgview.md

#### ForJpgView()

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into JPG.

```csharp
public static ViewInfoOptions ForJpgView()
```

##### Return Value

New instance of the `ViewInfoOptions` class.

#### ForJpgView(bool)

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into JPG.

```csharp
public static ViewInfoOptions ForJpgView(bool extractText)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extractText | Boolean | Enables text extraction. |

##### Return Value

New instance of the `ViewInfoOptions` class.

### ForPdfView
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/forpdfview.md

#### ViewInfoOptions.ForPdfView method

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PDF.

```csharp
public static ViewInfoOptions ForPdfView()
```

##### Return Value

New instance of the `ViewInfoOptions` class.

### ForPngView
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/forpngview.md

#### ForPngView()

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PNG.

```csharp
public static ViewInfoOptions ForPngView()
```

##### Return Value

New instance of the `ViewInfoOptions` class.

#### ForPngView(bool)

Initializes an instance of the `ViewInfoOptions` class to retrieve information about view when rendering into PNG.

```csharp
public static ViewInfoOptions ForPngView(bool extractText)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extractText | Boolean | Enables text extraction. |

##### Return Value

New instance of the `ViewInfoOptions` class.

### FromHtmlViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/fromhtmlviewoptions.md

#### ViewInfoOptions.FromHtmlViewOptions method

Initializes an instance of the `ViewInfoOptions` class based on the `HtmlViewOptions` object.

```csharp
public static ViewInfoOptions FromHtmlViewOptions(HtmlViewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | HtmlViewOptions | The HTML view options. |

##### Return Value

New instance of the `ViewInfoOptions` class.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |

### FromJpgViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/fromjpgviewoptions.md

#### ViewInfoOptions.FromJpgViewOptions method

Initializes an instance of the `ViewInfoOptions` class based on the `JpgViewOptions` object.

```csharp
public static ViewInfoOptions FromJpgViewOptions(JpgViewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | JpgViewOptions | The JPG view options. |

##### Return Value

New instance of the `ViewInfoOptions` class.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |

### FromPdfViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/frompdfviewoptions.md

#### ViewInfoOptions.FromPdfViewOptions method

Initializes an instance of the `ViewInfoOptions` class based on the `PdfViewOptions` object.

```csharp
public static ViewInfoOptions FromPdfViewOptions(PdfViewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PdfViewOptions | The PDF view options. |

##### Return Value

New instance of the `ViewInfoOptions` class.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |

### FromPngViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/frompngviewoptions.md

#### ViewInfoOptions.FromPngViewOptions method

Initializes an instance of the `ViewInfoOptions` class based on the `PngViewOptions` object.

```csharp
public static ViewInfoOptions FromPngViewOptions(PngViewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | PngViewOptions | The PNG view options. |

##### Return Value

New instance of the `ViewInfoOptions` class.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/height.md

#### ViewInfoOptions.Height property

The height of the output image (in pixels, for rendering to PNG/JPG only).

```csharp
public int Height { get; set; }
```

##### Remarks

Use this property to set the output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxHeight` property is ignored.

### MaxHeight
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/maxheight.md

#### ViewInfoOptions.MaxHeight property

Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).

```csharp
public int MaxHeight { get; set; }
```

##### Remarks

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Height` property, this property is ignored.

### MaxWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/maxwidth.md

#### ViewInfoOptions.MaxWidth property

Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).

```csharp
public int MaxWidth { get; set; }
```

##### Remarks

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/).

If you set the `Width` property, this property is ignored.

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewinfooptions/width.md

#### ViewInfoOptions.Width property

The width of the output image (in pixels, for rendering to PNG/JPG only).

```csharp
public int Width { get; set; }
```

##### Remarks

Use this property to set the output image width (in pixels). For code example, see the [documentation](https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/).

If you set this property, the `MaxWidth` property is ignored.

### ViewOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewoptions.md

#### ViewOptions class

Contains the rendering options.

```csharp
public abstract class ViewOptions : BaseViewOptions
```

#### Properties

| Name | Description |
| --- | --- |
| ArchiveOptions { get; set; } | The archive files view options. |
| CadOptions { get; set; } | The CAD drawing view options. |
| DefaultFontName { get; set; } | Sets the default font for a document. |
| EmailOptions { get; set; } | The email messages view options. |
| MailStorageOptions { get; set; } | Mail storage data files view options. |
| OutlookOptions { get; set; } | The Microsoft Outlook data files view options. |
| PdfOptions { get; set; } | The PDF document view options. |
| PresentationOptions { get; set; } | The presentation files view options. |
| ProjectManagementOptions { get; set; } | The project management files view options. |
| RemoveComments { get; set; } | Disables rendering comments when set to `true`. By default is `false` — all comments are displayed. |
| RenderHiddenPages { get; set; } | Enables rendering of hidden pages. |
| RenderNotes { get; set; } | Enables rendering notes. |
| SpreadsheetOptions { get; set; } | The spreadsheet files view options. |
| TextOptions { get; set; } | Text files view options. |
| VisioRenderingOptions { get; set; } | The Visio files view options. |
| Watermark { get; set; } | The text watermark to be applied to each page. |
| WebDocumentOptions { get; set; } | The Web files view options. |
| WordProcessingOptions { get; set; } | The Word processing files view options. |

#### Methods

| Name | Description |
| --- | --- |
| RotatePage(int, Rotation) | Applies the clockwise rotation to a page. |

#### Fields

| Name | Description |
| --- | --- |
| readonly PageRotations | The page rotation. |

### PageRotations
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewoptions/pagerotations.md

#### ViewOptions.PageRotations field

The page rotation.

```csharp
public readonly Dictionary<int, Rotation> PageRotations;
```

##### Remarks

If both `Watermark` and `PageRotations` are specified, the watermark is applied to the rotated pages.

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/flip-or-rotate-pages/).

### RotatePage
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewoptions/rotatepage.md

#### ViewOptions.RotatePage method

Applies the clockwise rotation to a page.

```csharp
public void RotatePage(int pageNumber, Rotation rotation)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number, must be strictly greater than 0 |
| rotation | Rotation | The rotation value. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Thrown when *pageNumber* is less or equal to zero. |
| ArgumentException | Thrown when rotation for the page with number *pageNumber* was already added. |

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/flip-or-rotate-pages/).

### Watermark
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/viewoptions/watermark.md

#### ViewOptions.Watermark property

The text watermark to be applied to each page.

```csharp
public Watermark Watermark { get; set; }
```

##### Remarks

If both `Watermark` and `PageRotations` are specified, the watermark is applied to the rotated pages.

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/).

### VisioRenderingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/visiorenderingoptions.md

#### VisioRenderingOptions class

Contains options for rendering Visio documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/).

```csharp
public class VisioRenderingOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| VisioRenderingOptions() | Initializes an instance of the `VisioRenderingOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| FigureWidth { get; set; } | Figure width, height will be calculated automatically. Default value is 100. |
| RenderFiguresOnly { get; set; } | Render only Visio figures, not a diagram. |

### FigureWidth
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/visiorenderingoptions/figurewidth.md

#### VisioRenderingOptions.FigureWidth property

Figure width, height will be calculated automatically. Default value is 100.

```csharp
public int FigureWidth { get; set; }
```

### RenderFiguresOnly
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/visiorenderingoptions/renderfiguresonly.md

#### VisioRenderingOptions.RenderFiguresOnly property

Render only Visio figures, not a diagram.

```csharp
public bool RenderFiguresOnly { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-visio-documents/#render-only-diagram-shapes).

### VisioRenderingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/visiorenderingoptions/visiorenderingoptions.md

#### VisioRenderingOptions constructor

Initializes an instance of the `VisioRenderingOptions` class.

```csharp
public VisioRenderingOptions()
```

### Watermark
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark.md

#### Watermark class

Represents a text watermark. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/add-text-watermark/).

```csharp
public class Watermark
```

#### Constructors

| Name | Description |
| --- | --- |
| Watermark(string) | Initializes an instance of the `Watermark` class. |

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | The watermark color. Default value is `Red`. |
| FontName { get; set; } | The font name used for the watermark. |
| Position { get; set; } | The watermark position. Default value is Diagonal. |
| Size { get; set; } | The watermark size. Default value is `FullSize`. |
| Text { get; } | The watermark text. |

### Color
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/color.md

#### Watermark.Color property

The watermark color. Default value is `Red`.

```csharp
public Argb32Color Color { get; set; }
```

### FontName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/fontname.md

#### Watermark.FontName property

The font name used for the watermark.

```csharp
public string FontName { get; set; }
```

### Position
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/position.md

#### Watermark.Position property

The watermark position. Default value is Diagonal.

```csharp
public Position Position { get; set; }
```

### Size
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/size.md

#### Watermark.Size property

The watermark size. Default value is `FullSize`.

```csharp
public Size Size { get; set; }
```

### Text
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/text.md

#### Watermark.Text property

The watermark text.

```csharp
public string Text { get; }
```

### Watermark
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/watermark/watermark.md

#### Watermark constructor

Initializes an instance of the `Watermark` class.

```csharp
public Watermark(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | Watermark text. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *text* is null or empty. |

### WebDocumentOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions.md

#### WebDocumentOptions class

Contains options for rendering web documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/).

```csharp
public class WebDocumentOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WebDocumentOptions() | Initializes an instance of the `WebDocumentOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BottomMargin { get; set; } | Sets the bottom margin of a page. The default value is 72 points. |
| LeftMargin { get; set; } | Sets the left margin of a page. The default value is 5 points. |
| PageSize { get; set; } | Sets the size of the output page. |
| RightMargin { get; set; } | Sets the right margin of a page. The default value is 5 points. |
| TopMargin { get; set; } | Sets the top margin of a page. The default value is 72 points. |

### BottomMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/bottommargin.md

#### WebDocumentOptions.BottomMargin property

Sets the bottom margin of a page. The default value is 72 points.

```csharp
public float BottomMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins).

### LeftMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/leftmargin.md

#### WebDocumentOptions.LeftMargin property

Sets the left margin of a page. The default value is 5 points.

```csharp
public float LeftMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins).

### PageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/pagesize.md

#### WebDocumentOptions.PageSize property

Sets the size of the output page.

```csharp
public PageSize PageSize { get; set; }
```

##### Remarks

The default value is Letter, 792 x 612 points. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#set-the-output-page-size).

### RightMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/rightmargin.md

#### WebDocumentOptions.RightMargin property

Sets the right margin of a page. The default value is 5 points.

```csharp
public float RightMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins).

### TopMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/topmargin.md

#### WebDocumentOptions.TopMargin property

Sets the top margin of a page. The default value is 72 points.

```csharp
public float TopMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/#adjust-page-margins).

### WebDocumentOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/webdocumentoptions/webdocumentoptions.md

#### WebDocumentOptions constructor

Initializes an instance of the `WebDocumentOptions` class.

```csharp
public WebDocumentOptions()
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-web-documents/).

### WordProcessingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions.md

#### WordProcessingOptions class

Contains options for rendering Word documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/).

```csharp
public class WordProcessingOptions : ICloneable, IEquatable<WordProcessingOptions>
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingOptions() | Contains options for rendering word processing documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/). |

#### Properties

| Name | Description |
| --- | --- |
| BottomMargin { get; set; } | Sets the bottom margin of a page. |
| EnableOpenTypeFeatures { get; set; } | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts. |
| LeftMargin { get; set; } | Sets the left margin of a page. |
| PageSize { get; set; } | The size of the output page. The default value is Unspecified which means that a page size is set in a page settings (Page Setup) is used.  When rendering HTM and HTML files the default page size is set to Letter 792 x 612 points. As a result, some of the content may not fit into the page frame. Set a larger page size e.g. A3 to fit the contents. |
| RenderTrackedChanges { get; set; } | Enables tracked changes (revisions) rendering. |
| RightMargin { get; set; } | Sets the right margin of a page. |
| TopMargin { get; set; } | Sets the top margin of a page. |
| UnlinkTableOfContents { get; set; } | When rendering to HTML or PDF, you can set this option to `true` to disable navigation from the table of contents. For HTML rendering, `a` tags with relative links will be replaced with `span` tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links to document sections. |
| UpdateFields { get; set; } | Gets or sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is `true` — fields will be updated before saving. |

#### Methods

| Name | Description |
| --- | --- |
| Clone() | Creates and returns a full deep copy of this options |
| Equals(WordProcessingOptions) | Determines whether specified instance of `WordProcessingOptions` is equal to this |

### BottomMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/bottommargin.md

#### WordProcessingOptions.BottomMargin property

Sets the bottom margin of a page.

```csharp
public float? BottomMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins).

### Clone
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/clone.md

#### WordProcessingOptions.Clone method

Creates and returns a full deep copy of this options

```csharp
public WordProcessingOptions Clone()
```

##### Return Value

New instance of the `WordProcessingOptions` class

### EnableOpenTypeFeatures
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/enableopentypefeatures.md

#### WordProcessingOptions.EnableOpenTypeFeatures property

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian Latin-based, or Cyrillic-based scripts.

```csharp
public bool EnableOpenTypeFeatures { get; set; }
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/equals.md

#### WordProcessingOptions.Equals method

Determines whether specified instance of `WordProcessingOptions` is equal to this

```csharp
public bool Equals(WordProcessingOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | WordProcessingOptions | Other `WordProcessingOptions` instance, may be `null` |

##### Return Value

`true` if are equal, `false` is are unequal

### LeftMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/leftmargin.md

#### WordProcessingOptions.LeftMargin property

Sets the left margin of a page.

```csharp
public float? LeftMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins).

### PageSize
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/pagesize.md

#### WordProcessingOptions.PageSize property

The size of the output page. The default value is Unspecified which means that a page size is set in a page settings (Page Setup) is used.  When rendering HTM and HTML files the default page size is set to Letter 792 x 612 points. As a result, some of the content may not fit into the page frame. Set a larger page size e.g. A3 to fit the contents.

```csharp
public PageSize PageSize { get; set; }
```

### RenderTrackedChanges
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/rendertrackedchanges.md

#### WordProcessingOptions.RenderTrackedChanges property

Enables tracked changes (revisions) rendering.

```csharp
public bool RenderTrackedChanges { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes).

### RightMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/rightmargin.md

#### WordProcessingOptions.RightMargin property

Sets the right margin of a page.

```csharp
public float? RightMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins).

### TopMargin
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/topmargin.md

#### WordProcessingOptions.TopMargin property

Sets the top margin of a page.

```csharp
public float? TopMargin { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins).

### UnlinkTableOfContents
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/unlinktableofcontents.md

#### WordProcessingOptions.UnlinkTableOfContents property

When rendering to HTML or PDF, you can set this option to `true` to disable navigation from the table of contents. For HTML rendering, `a` tags with relative links will be replaced with `span` tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links to document sections.

```csharp
public bool UnlinkTableOfContents { get; set; }
```

##### Remarks

Default value is `false`.

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#unlink-table-of-contents).

### UpdateFields
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/updatefields.md

#### WordProcessingOptions.UpdateFields property

Gets or sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is `true` — fields will be updated before saving.

```csharp
public bool UpdateFields { get; set; }
```

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/#disable-updating-fields-when-saving).

### WordProcessingOptions
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.options/wordprocessingoptions/wordprocessingoptions.md

#### WordProcessingOptions constructor

Contains options for rendering word processing documents. For details, see the [documentation](https://docs.groupdocs.com/viewer/net/render-word-documents/).

```csharp
public WordProcessingOptions()
```

### GroupDocs.Viewer.Results
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results.md

The namespace provides classes which represent document rendering results.

#### Classes

| Class | Description |
| --- | --- |
| ArchiveViewInfo | Represents view information for archive file. |
| Attachment | Represents attachment file contained by email message, archive, PDF document or Outlook data file. |
| CadViewInfo | Represents view information for CAD drawing. |
| Character | Represents relatively positioned rectangle which contains single character. |
| FileInfo | Contains information about file. |
| Layer | Represents layer contained by the CAD drawing. |
| Layout | Represents layout contained by the CAD drawing. |
| Line | Represents relatively positioned rectangle which contains single line. |
| LotusNotesViewInfo | Represents view information for Lotus notes database storage |
| MailMessageViewInfo | Represents a view information about one email message |
| MboxViewInfo | Represents view information for Mbox files storage |
| OutlookViewInfo | Represents view information for Outlook Data file. |
| Page | Represents single page that can be viewed. |
| PdfViewInfo | Represents view information for PDF document. |
| ProjectManagementViewInfo | Represents view information for MS Project document. |
| Resource | Represents HTML resource such as font, style, image or graphics. |
| TextElement&lt;T&gt; | Represents generic text element. |
| ViewInfo | Represents view information for generic document. |
| Word | Represents relatively positioned rectangle which contains single word. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### ArchiveViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/archiveviewinfo.md

#### ArchiveViewInfo class

Represents view information for archive file.

```csharp
public class ArchiveViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| ArchiveViewInfo() | Initializes new instance of `ArchiveViewInfo` class. |
| ArchiveViewInfo(FileType, List&lt;Page&gt;, List&lt;string&gt;) | Initializes new instance of `ArchiveViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| Folders { get; set; } | The folders contained by the archive file. |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### ArchiveViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/archiveviewinfo/archiveviewinfo.md

#### ArchiveViewInfo()

Initializes new instance of `ArchiveViewInfo` class.

```csharp
public ArchiveViewInfo()
```

#### ArchiveViewInfo(FileType, List&lt;Page&gt;, List&lt;string&gt;)

Initializes new instance of `ArchiveViewInfo` class.

```csharp
public ArchiveViewInfo(FileType fileType, List<Page> pages, List<string> folders)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| folders | List`1 | The list of folders contained by the archive file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |
| ArgumentNullException | Thrown when *folders* is null. |

### Folders
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/archiveviewinfo/folders.md

#### ArchiveViewInfo.Folders property

The folders contained by the archive file.

```csharp
public List<string> Folders { get; set; }
```

### Attachment
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment.md

#### Attachment class

Represents attachment file contained by email message, archive, PDF document or Outlook data file.

```csharp
public class Attachment
```

#### Constructors

| Name | Description |
| --- | --- |
| Attachment() | Initializes new instance of `Attachment` class. |
| Attachment(string, string) | Initializes new instance of `Attachment` class. |
| Attachment(string, string, string, long) | Initializes new instance of `Attachment` class. |
| Attachment(string, string, string, FileType, long) | Initializes new instance of `Attachment` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileName { get; set; } | Attachment file name. |
| FilePath { get; set; } | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |
| FileType { get; set; } | Attachment file type. |
| Id { get; set; } | Unique identifier of the attachment in context of a single file that contains this attachment. |
| Size { get; set; } | Attachment file size in bytes. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Attachment
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/attachment.md

#### Attachment()

Initializes new instance of `Attachment` class.

```csharp
public Attachment()
```

#### Attachment(string, string)

Initializes new instance of `Attachment` class.

```csharp
public Attachment(string fileName, string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Attachment file name. |
| filePath | String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *fileName* is null or empty. |
| ArgumentException | Thrown when *filePath* is null or empty. |

#### Attachment(string, string, string, long)

Initializes new instance of `Attachment` class.

```csharp
public Attachment(string id, string fileName, string filePath, long size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | Unique (in context of single file) identifier of the attachment. |
| fileName | String | Attachment file name. |
| filePath | String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |
| size | Int64 | Attachment file size in bytes. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *id* is null or empty. |
| ArgumentException | Thrown when *fileName* is null or empty. |
| ArgumentException | Thrown when *filePath* is null or empty. |

#### Attachment(string, string, string, FileType, long)

Initializes new instance of `Attachment` class.

```csharp
public Attachment(string id, string fileName, string filePath, FileType fileType, long size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| id | String | Unique (in context of single file) identifier of the attachment. |
| fileName | String | Attachment file name. |
| filePath | String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |
| fileType | FileType | Attachment file type. |
| size | Int64 | Attachment file size in bytes. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *id* is null or empty. |
| ArgumentException | Thrown when *fileName* is null or empty. |
| ArgumentException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *fileType* is null. |

### FileName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/filename.md

#### Attachment.FileName property

Attachment file name.

```csharp
public string FileName { get; set; }
```

### FilePath
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/filepath.md

#### Attachment.FilePath property

Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file.

```csharp
public string FilePath { get; set; }
```

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/filetype.md

#### Attachment.FileType property

Attachment file type.

```csharp
public FileType FileType { get; set; }
```

### Id
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/id.md

#### Attachment.Id property

Unique identifier of the attachment in context of a single file that contains this attachment.

```csharp
public string Id { get; set; }
```

### Size
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/size.md

#### Attachment.Size property

Attachment file size in bytes.

```csharp
public long Size { get; set; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/attachment/tostring.md

#### Attachment.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### CadViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/cadviewinfo.md

#### CadViewInfo class

Represents view information for CAD drawing.

```csharp
public class CadViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| CadViewInfo(FileType, List&lt;Page&gt;, List&lt;Layer&gt;, List&lt;Layout&gt;) | Initializes new instance of `CadViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| Layers { get; set; } | The list of layers contained by the CAD drawing. |
| Layouts { get; set; } | The list of layouts contained by the CAD drawing. |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### CadViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/cadviewinfo/cadviewinfo.md

#### CadViewInfo constructor

Initializes new instance of `CadViewInfo` class.

```csharp
public CadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| layers | List`1 | The list of layers contained by the CAD drawing. |
| layouts | List`1 | The list of layers contained by the CAD drawing. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |
| ArgumentNullException | Thrown when *layers* is null. |
| ArgumentNullException | Thrown when *layouts* is null. |

### Layers
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/cadviewinfo/layers.md

#### CadViewInfo.Layers property

The list of layers contained by the CAD drawing.

```csharp
public List<Layer> Layers { get; set; }
```

### Layouts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/cadviewinfo/layouts.md

#### CadViewInfo.Layouts property

The list of layouts contained by the CAD drawing.

```csharp
public List<Layout> Layouts { get; set; }
```

### Character
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/character.md

#### Character class

Represents relatively positioned rectangle which contains single character.

```csharp
public class Character : TextElement<char>
```

#### Constructors

| Name | Description |
| --- | --- |
| Character() | Initializes new instance of `Character` class. |
| Character(char, double, double, double, double) | Initializes new instance of `Character` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the rectangle which contains the element (in pixels). |
| Value { get; set; } | The element value. |
| Width { get; set; } | The width of the rectangle which contains the element (in pixels). |
| X { get; set; } | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| Y { get; set; } | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Character
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/character/character.md

#### Character()

Initializes new instance of `Character` class.

```csharp
public Character()
```

#### Character(char, double, double, double, double)

Initializes new instance of `Character` class.

```csharp
public Character(char character, double x, double y, double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| character | Char | The character. |
| x | Double | The X coordinate of the highest left point on the page layout where the rectangle that contains character begins. |
| y | Double | The Y coordinate of the highest left point on the page layout where the rectangle that contains character begins. |
| width | Double | The width of the rectangle which contains single character (in pixels). |
| height | Double | The height of the rectangle which contains single character (in pixels). |

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/character/tostring.md

#### Character.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### FileInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/fileinfo.md

#### FileInfo class

Contains information about file.

```csharp
public class FileInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| FileInfo() | Initializes new instance of `FileType` class. |
| FileInfo(FileType) | Initializes new instance of `FileType` class. |

#### Properties

| Name | Description |
| --- | --- |
| Encrypted { get; set; } | Indicates that file is encrypted. |
| FileType { get; set; } | The type of the file. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Encrypted
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/fileinfo/encrypted.md

#### FileInfo.Encrypted property

Indicates that file is encrypted.

```csharp
public bool Encrypted { get; set; }
```

### FileInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/fileinfo/fileinfo.md

#### FileInfo()

Initializes new instance of `FileType` class.

```csharp
public FileInfo()
```

#### FileInfo(FileType)

Initializes new instance of `FileType` class.

```csharp
public FileInfo(FileType fileType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/fileinfo/filetype.md

#### FileInfo.FileType property

The type of the file.

```csharp
public FileType FileType { get; set; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/fileinfo/tostring.md

#### FileInfo.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Layer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer.md

#### Layer class

Represents layer contained by the CAD drawing.

```csharp
public sealed class Layer : IEquatable<Layer>
```

#### Constructors

| Name | Description |
| --- | --- |
| Layer() | Initializes new instance of `Layer` class. |
| Layer(string) | Initializes new instance of `Layer` class. |
| Layer(string, bool) | Initializes new instance of `Layer` class. |

#### Properties

| Name | Description |
| --- | --- |
| Name { get; set; } | The name of the layer. |
| Visible { get; set; } | The layer visibility indicator. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(Layer) | Determines whether the current `Layer` is the same as specified `Layer` object. |
| override Equals(object) | Determines whether the current `Layer` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `Layer` object. |
| override ToString() | Returns a string that represents the current object. |
| operator == | Determines whether two `Layer` objects are the same. |
| operator != | Determines whether two `Layer` objects are not the same. |

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/equals.md

#### Equals(Layer)

Determines whether the current `Layer` is the same as specified `Layer` object.

```csharp
public bool Equals(Layer other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Layer | The object to compare with the current `Layer` object. |

##### Return Value

```csharp
true
```

if both `Layer` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `Layer` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `Layer` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `Layer` and is the same as current `Layer` object; otherwise,

```csharp
false
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/gethashcode.md

#### Layer.GetHashCode method

Returns the hash code for the current `Layer` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `Layer` object.

### Layer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/layer.md

#### Layer()

Initializes new instance of `Layer` class.

```csharp
public Layer()
```

#### Layer(string)

Initializes new instance of `Layer` class.

```csharp
public Layer(string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the layer. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *name* is null or empty. |

#### Layer(string, bool)

Initializes new instance of `Layer` class.

```csharp
public Layer(string name, bool visible)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the layer. |
| visible | Boolean | The layer visibility indicator. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *name* is null or empty. |

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/name.md

#### Layer.Name property

The name of the layer.

```csharp
public string Name { get; set; }
```

##### Remarks

Layer names are case sensitive.

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/op_equality.md

#### Layer Equality operator

Determines whether two `Layer` objects are the same.

```csharp
public static bool operator ==(Layer left, Layer right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Layer | Left `Layer` object. |
| right | Layer | Right `Layer` object. |

##### Return Value

```csharp
true
```

if both `Layer` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/op_inequality.md

#### Layer Inequality operator

Determines whether two `Layer` objects are not the same.

```csharp
public static bool operator !=(Layer left, Layer right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Layer | Left `Layer` object. |
| right | Layer | Right `Layer` object. |

##### Return Value

```csharp
true
```

if both `Layer` objects are not the same; otherwise,

```csharp
false
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/tostring.md

#### Layer.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Visible
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layer/visible.md

#### Layer.Visible property

The layer visibility indicator.

```csharp
public bool Visible { get; set; }
```

##### Remarks

The CAD drawing layers that are switched off or frozen are invisible. To render layers that are invisible, use `Layers` option.

### Layout
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout.md

#### Layout class

Represents layout contained by the CAD drawing.

```csharp
public sealed class Layout : IEquatable<Layout>
```

#### Constructors

| Name | Description |
| --- | --- |
| Layout() | Initializes new instance of `Layout` class. |
| Layout(string, float, float) | Initializes new instance of `Layout` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the layout. |
| Name { get; set; } | The name of the layout. |
| Width { get; set; } | The width of the layout. |

#### Methods

| Name | Description |
| --- | --- |
| Equals(Layout) | Determines whether the current `Layout` is the same as specified `Layout` object. |
| override Equals(object) | Determines whether the current `Layout` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `Layout` object. |
| override ToString() | Returns a string that represents the current object. |
| operator == | Determines whether two `Layout` objects are the same. |
| operator != | Determines whether two `Layout` objects are not the same. |

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/equals.md

#### Equals(Layout)

Determines whether the current `Layout` is the same as specified `Layout` object.

```csharp
public bool Equals(Layout other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Layout | The object to compare with the current `Layout` object. |

##### Return Value

```csharp
true
```

if both `Layout` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `Layout` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `Layout` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `Layout` and is the same as current `Layout` object; otherwise,

```csharp
false
```

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/gethashcode.md

#### Layout.GetHashCode method

Returns the hash code for the current `Layout` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `Layout` object.

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/height.md

#### Layout.Height property

The height of the layout.

```csharp
public float Height { get; set; }
```

### Layout
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/layout.md

#### Layout()

Initializes new instance of `Layout` class.

```csharp
public Layout()
```

#### Layout(string, float, float)

Initializes new instance of `Layout` class.

```csharp
public Layout(string name, float width, float height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| name | String | The name of the layout. |
| width | Single | The width of the layout in pixels. |
| height | Single | The height of the layout in pixels. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *name* is null or empty. |

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/name.md

#### Layout.Name property

The name of the layout.

```csharp
public string Name { get; set; }
```

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/op_equality.md

#### Layout Equality operator

Determines whether two `Layout` objects are the same.

```csharp
public static bool operator ==(Layout left, Layout right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Layout | Left `Layout` object. |
| right | Layout | Right `Layout` object. |

##### Return Value

```csharp
true
```

if both `Layout` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/op_inequality.md

#### Layout Inequality operator

Determines whether two `Layout` objects are not the same.

```csharp
public static bool operator !=(Layout left, Layout right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Layout | Left `Layout` object. |
| right | Layout | Right `Layout` object. |

##### Return Value

```csharp
true
```

if both `Layout` objects are not the same; otherwise,

```csharp
false
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/tostring.md

#### Layout.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/layout/width.md

#### Layout.Width property

The width of the layout.

```csharp
public float Width { get; set; }
```

### Line
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/line.md

#### Line class

Represents relatively positioned rectangle which contains single line.

```csharp
public class Line : TextElement<string>
```

#### Constructors

| Name | Description |
| --- | --- |
| Line() | Initializes new instance of `Line` class. |
| Line(string, double, double, double, double, List&lt;Word&gt;) | Initializes new instance of `Line` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the rectangle which contains the element (in pixels). |
| Value { get; set; } | The element value. |
| Width { get; set; } | The width of the rectangle which contains the element (in pixels). |
| Words { get; set; } | The words contained by the line. |
| X { get; set; } | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| Y { get; set; } | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Line
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/line/line.md

#### Line()

Initializes new instance of `Line` class.

```csharp
public Line()
```

#### Line(string, double, double, double, double, List&lt;Word&gt;)

Initializes new instance of `Line` class.

```csharp
public Line(string line, double x, double y, double width, double height, List<Word> words)
```

| Parameter | Type | Description |
| --- | --- | --- |
| line | String | The line. |
| x | Double | The X coordinate of the highest left point on the page layout where the rectangle that contains line begins. |
| y | Double | The Y coordinate of the highest left point on the page layout where the rectangle that contains line begins. |
| width | Double | The width of the rectangle which contains the line (in pixels). |
| height | Double | The height of the rectangle which contains the line (in pixels). |
| words | List`1 | The words contained by the line. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *line* is null or empty. |
| ArgumentNullException | Thrown when *words* is null. |

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/line/tostring.md

#### Line.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Words
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/line/words.md

#### Line.Words property

The words contained by the line.

```csharp
public List<Word> Words { get; set; }
```

### LotusNotesViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/lotusnotesviewinfo.md

#### LotusNotesViewInfo class

Represents view information for Lotus notes database storage

```csharp
public class LotusNotesViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| LotusNotesViewInfo() | Initializes new instance of `LotusNotesViewInfo` class. |
| LotusNotesViewInfo(FileType, List&lt;Page&gt;, int) | Initializes new instance of `LotusNotesViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| NotesCount { get; set; } | Notes count in storage |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### LotusNotesViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/lotusnotesviewinfo/lotusnotesviewinfo.md

#### LotusNotesViewInfo()

Initializes new instance of `LotusNotesViewInfo` class.

```csharp
public LotusNotesViewInfo()
```

#### LotusNotesViewInfo(FileType, List&lt;Page&gt;, int)

Initializes new instance of `LotusNotesViewInfo` class.

```csharp
public LotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| notesCount | Int32 | The notes count contained by the Lotus database storage file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |
| ArgumentNullException | Thrown when *notesCount* is null. |

### NotesCount
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/lotusnotesviewinfo/notescount.md

#### LotusNotesViewInfo.NotesCount property

Notes count in storage

```csharp
public int NotesCount { get; set; }
```

### MailMessageViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mailmessageviewinfo.md

#### MailMessageViewInfo class

Represents a view information about one email message

```csharp
public sealed class MailMessageViewInfo : ViewInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| From { get; } | Returns a "From" email address of the email message as a string |
| Pages { get; set; } | The list of pages to view. |
| Sent { get; } | Returns original "Sent" datetime of the email message |
| Subject { get; } | Returns a "Subject" line |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### From
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mailmessageviewinfo/from.md

#### MailMessageViewInfo.From property

Returns a "From" email address of the email message as a string

```csharp
public string From { get; }
```

### Sent
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mailmessageviewinfo/sent.md

#### MailMessageViewInfo.Sent property

Returns original "Sent" datetime of the email message

```csharp
public DateTime Sent { get; }
```

### Subject
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mailmessageviewinfo/subject.md

#### MailMessageViewInfo.Subject property

Returns a "Subject" line

```csharp
public string Subject { get; }
```

### MboxViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mboxviewinfo.md

#### MboxViewInfo class

Represents view information for Mbox files storage

```csharp
public class MboxViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| MboxViewInfo() | Initializes new instance of `MboxViewInfo` class. |
| MboxViewInfo(FileType, List&lt;Page&gt;, int) | Initializes new instance of `MboxViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| MessagesCount { get; set; } | Notes count in storage |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### MboxViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mboxviewinfo/mboxviewinfo.md

#### MboxViewInfo()

Initializes new instance of `MboxViewInfo` class.

```csharp
public MboxViewInfo()
```

#### MboxViewInfo(FileType, List&lt;Page&gt;, int)

Initializes new instance of `MboxViewInfo` class.

```csharp
public MboxViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| notesCount | Int32 | The notes count contained by the Lotus database storage file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |
| ArgumentNullException | Thrown when *notesCount* is null. |

### MessagesCount
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/mboxviewinfo/messagescount.md

#### MboxViewInfo.MessagesCount property

Notes count in storage

```csharp
public int MessagesCount { get; set; }
```

### OutlookViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/outlookviewinfo.md

#### OutlookViewInfo class

Represents view information for Outlook Data file.

```csharp
public class OutlookViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| OutlookViewInfo() | Initializes new instance of `OutlookViewInfo` class. |
| OutlookViewInfo(FileType, List&lt;Page&gt;, List&lt;string&gt;) | Initializes new instance of `OutlookViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| Folders { get; set; } | The list of folders contained by the Outlook Data file. |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Folders
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/outlookviewinfo/folders.md

#### OutlookViewInfo.Folders property

The list of folders contained by the Outlook Data file.

```csharp
public List<string> Folders { get; set; }
```

### OutlookViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/outlookviewinfo/outlookviewinfo.md

#### OutlookViewInfo()

Initializes new instance of `OutlookViewInfo` class.

```csharp
public OutlookViewInfo()
```

#### OutlookViewInfo(FileType, List&lt;Page&gt;, List&lt;string&gt;)

Initializes new instance of `OutlookViewInfo` class.

```csharp
public OutlookViewInfo(FileType fileType, List<Page> pages, List<string> folders)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| folders | List`1 | The list of folders contained by the Outlook Data file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |
| ArgumentNullException | Thrown when *folders* is null. |

### Page
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page.md

#### Page class

Represents single page that can be viewed.

```csharp
public class Page
```

#### Constructors

| Name | Description |
| --- | --- |
| Page() | Initializes new instance of `Page` class. |
| Page(int, bool) | Initializes new instance of `Page` class. |
| Page(int, string, bool) | Initializes new instance of `Page` class. |
| Page(int, bool, int, int) | Initializes new instance of `Page` class. |
| Page(int, bool, int, int, List&lt;Line&gt;) | Initializes new instance of `Page` class. |
| Page(int, string, bool, int, int) | Initializes new instance of `Page` class. |
| Page(int, string, bool, int, int, List&lt;Line&gt;) | Initializes new instance of `Page` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the page in pixels when viewing as JPG or PNG. |
| Lines { get; set; } | The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction. |
| Name { get; set; } | The worksheet or page name. |
| Number { get; set; } | The page number. |
| Visible { get; set; } | The page visibility indicator. |
| Width { get; set; } | The width of the page in pixels when viewing as JPG or PNG. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/height.md

#### Page.Height property

The height of the page in pixels when viewing as JPG or PNG.

```csharp
public int Height { get; set; }
```

### Lines
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/lines.md

#### Page.Lines property

The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction.

```csharp
public List<Line> Lines { get; set; }
```

### Name
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/name.md

#### Page.Name property

The worksheet or page name.

```csharp
public string Name { get; set; }
```

### Number
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/number.md

#### Page.Number property

The page number.

```csharp
public int Number { get; set; }
```

### Page
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/page.md

#### Page()

Initializes new instance of `Page` class.

```csharp
public Page()
```

#### Page(int, bool)

Initializes new instance of `Page` class.

```csharp
public Page(int number, bool visible)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| visible | Boolean | The page visibility indicator. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |

#### Page(int, string, bool)

Initializes new instance of `Page` class.

```csharp
public Page(int number, string name, bool visible)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| name | String | The worksheet or page name. |
| visible | Boolean | The page visibility indicator. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |

#### Page(int, bool, int, int)

Initializes new instance of `Page` class.

```csharp
public Page(int number, bool visible, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| visible | Boolean | The page visibility indicator. |
| width | Int32 | The width of the page in pixels when viewing as JPG or PNG. |
| height | Int32 | The height of the page in pixels when viewing as JPG or PNG. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |

#### Page(int, string, bool, int, int)

Initializes new instance of `Page` class.

```csharp
public Page(int number, string name, bool visible, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| name | String | The worksheet or page name. |
| visible | Boolean | The page visibility indicator. |
| width | Int32 | The width of the page in pixels when viewing as JPG or PNG. |
| height | Int32 | The height of the page in pixels when viewing as JPG or PNG. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |

#### Page(int, bool, int, int, List&lt;Line&gt;)

Initializes new instance of `Page` class.

```csharp
public Page(int number, bool visible, int width, int height, List<Line> lines)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| visible | Boolean | The page visibility indicator. |
| width | Int32 | The width of the page in pixels when viewing as JPG or PNG. |
| height | Int32 | The height of the page in pixels when viewing as JPG or PNG. |
| lines | List`1 | The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |
| ArgumentNullException | Thrown when *lines* is null. |

#### Page(int, string, bool, int, int, List&lt;Line&gt;)

Initializes new instance of `Page` class.

```csharp
public Page(int number, string name, bool visible, int width, int height, List<Line> lines)
```

| Parameter | Type | Description |
| --- | --- | --- |
| number | Int32 | The page number. |
| name | String | The worksheet or page name. |
| visible | Boolean | The page visibility indicator. |
| width | Int32 | The width of the page in pixels when viewing as JPG or PNG. |
| height | Int32 | The height of the page in pixels when viewing as JPG or PNG. |
| lines | List`1 | The lines contained by the page when viewing as JPG or PNG with enabled Text Extraction. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *number* is less or equal to zero. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |
| ArgumentNullException | Thrown when *lines* is null. |

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/tostring.md

#### Page.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Visible
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/visible.md

#### Page.Visible property

The page visibility indicator.

```csharp
public bool Visible { get; set; }
```

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/page/width.md

#### Page.Width property

The width of the page in pixels when viewing as JPG or PNG.

```csharp
public int Width { get; set; }
```

### PdfViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/pdfviewinfo.md

#### PdfViewInfo class

Represents view information for PDF document.

```csharp
public class PdfViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfViewInfo() | Initializes new instance of `PdfViewInfo` class. |
| PdfViewInfo(FileType, List&lt;Page&gt;, bool) | Initializes new instance of `PdfViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| Pages { get; set; } | The list of pages to view. |
| PrintingAllowed { get; set; } | Indicates if printing of the document is allowed. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### PdfViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/pdfviewinfo/pdfviewinfo.md

#### PdfViewInfo()

Initializes new instance of `PdfViewInfo` class.

```csharp
public PdfViewInfo()
```

#### PdfViewInfo(FileType, List&lt;Page&gt;, bool)

Initializes new instance of `PdfViewInfo` class.

```csharp
public PdfViewInfo(FileType fileType, List<Page> pages, bool printingAllowed)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| printingAllowed | Boolean | The printing permission indicator. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *pages* is null. |

### PrintingAllowed
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/pdfviewinfo/printingallowed.md

#### PdfViewInfo.PrintingAllowed property

Indicates if printing of the document is allowed.

```csharp
public bool PrintingAllowed { get; set; }
```

### ProjectManagementViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/projectmanagementviewinfo.md

#### ProjectManagementViewInfo class

Represents view information for MS Project document.

```csharp
public class ProjectManagementViewInfo : ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| ProjectManagementViewInfo() | Initializes new instance of `ProjectManagementViewInfo` class. |
| ProjectManagementViewInfo(FileType, List&lt;Page&gt;, DateTime, DateTime) | Initializes new instance of `ProjectManagementViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| EndDate { get; set; } | The date time when the project is to be completed. |
| FileType { get; set; } | The type of the file. |
| Pages { get; set; } | The list of pages to view. |
| StartDate { get; set; } | The date time from which the project started. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### EndDate
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/projectmanagementviewinfo/enddate.md

#### ProjectManagementViewInfo.EndDate property

The date time when the project is to be completed.

```csharp
public DateTime EndDate { get; set; }
```

### ProjectManagementViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/projectmanagementviewinfo/projectmanagementviewinfo.md

#### ProjectManagementViewInfo()

Initializes new instance of `ProjectManagementViewInfo` class.

```csharp
public ProjectManagementViewInfo()
```

#### ProjectManagementViewInfo(FileType, List&lt;Page&gt;, DateTime, DateTime)

Initializes new instance of `ProjectManagementViewInfo` class.

```csharp
public ProjectManagementViewInfo(FileType fileType, List<Page> pages, DateTime startDate, 
    DateTime endDate)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |
| startDate | DateTime | The date time from which the project started. |
| endDate | DateTime | The date time when the project is to be completed. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |

### StartDate
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/projectmanagementviewinfo/startdate.md

#### ProjectManagementViewInfo.StartDate property

The date time from which the project started.

```csharp
public DateTime StartDate { get; set; }
```

### Resource
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/resource.md

#### Resource class

Represents HTML resource such as font, style, image or graphics.

```csharp
public class Resource
```

#### Constructors

| Name | Description |
| --- | --- |
| Resource() | Creates new instance of `Resource` class. |
| Resource(string, bool) | Creates new instance of `Resource` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileName { get; set; } | The resource file name. |
| Nested { get; set; } | Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### FileName
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/resource/filename.md

#### Resource.FileName property

The resource file name.

```csharp
public string FileName { get; set; }
```

### Nested
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/resource/nested.md

#### Resource.Nested property

Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource.

```csharp
public bool Nested { get; set; }
```

### Resource
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/resource/resource.md

#### Resource()

Creates new instance of `Resource` class.

```csharp
public Resource()
```

#### Resource(string, bool)

Creates new instance of `Resource` class.

```csharp
public Resource(string fileName, bool nested)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileName | String | Resource file name. |
| nested | Boolean | Indicates whether resource resides inside another resource, e.g. font resource that resides in CSS or SVG resource. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *fileName* is null or empty. |

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/resource/tostring.md

#### Resource.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TextElementT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1.md

#### TextElement&lt;T&gt; class

Represents generic text element.

```csharp
public class TextElement<T>
```

| Parameter | Description |
| --- | --- |
| T | The text element type. |

#### Constructors

| Name | Description |
| --- | --- |
| TextElement() | Initializes new instance of `TextElement` class. |
| TextElement(T, double, double, double, double) | Initializes new instance of `TextElement` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; set; } | The height of the rectangle which contains the element (in pixels). |
| Value { get; set; } | The element value. |
| Width { get; set; } | The width of the rectangle which contains the element (in pixels). |
| X { get; set; } | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| Y { get; set; } | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Height
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/height.md

#### TextElement&lt;T&gt;.Height property

The height of the rectangle which contains the element (in pixels).

```csharp
public double Height { get; set; }
```

### TextElement
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/textelement.md

#### TextElement()

Initializes new instance of `TextElement` class.

```csharp
public TextElement()
```

#### TextElement(T, double, double, double, double)

Initializes new instance of `TextElement` class.

```csharp
public TextElement(T value, double x, double y, double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| value | T | The text element value. |
| x | Double | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| y | Double | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| width | Double | The width of the rectangle which contains the element (in pixels). |
| height | Double | The height of the rectangle which contains the element (in pixels). |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *value* is null. |
| ArgumentException | Thrown when *width* is less or equal to zero. |
| ArgumentException | Thrown when *height* is less or equal to zero. |

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/tostring.md

#### TextElement&lt;T&gt;.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Value
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/value.md

#### TextElement&lt;T&gt;.Value property

The element value.

```csharp
public T Value { get; set; }
```

### Width
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/width.md

#### TextElement&lt;T&gt;.Width property

The width of the rectangle which contains the element (in pixels).

```csharp
public double Width { get; set; }
```

### X
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/x.md

#### TextElement&lt;T&gt;.X property

The X coordinate of the highest left point on the page layout where the rectangle that contains element begins.

```csharp
public double X { get; set; }
```

### Y
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/textelement-1/y.md

#### TextElement&lt;T&gt;.Y property

The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins.

```csharp
public double Y { get; set; }
```

### ViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/viewinfo.md

#### ViewInfo class

Represents view information for generic document.

```csharp
public class ViewInfo
```

#### Constructors

| Name | Description |
| --- | --- |
| ViewInfo() | Initializes new instance of `ViewInfo` class. |
| ViewInfo(FileType, List&lt;Page&gt;) | Initializes new instance of `ViewInfo` class. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | The type of the file. |
| Pages { get; set; } | The list of pages to view. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/viewinfo/filetype.md

#### ViewInfo.FileType property

The type of the file.

```csharp
public FileType FileType { get; set; }
```

### Pages
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/viewinfo/pages.md

#### ViewInfo.Pages property

The list of pages to view.

```csharp
public List<Page> Pages { get; set; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/viewinfo/tostring.md

#### ViewInfo.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### ViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/viewinfo/viewinfo.md

#### ViewInfo()

Initializes new instance of `ViewInfo` class.

```csharp
public ViewInfo()
```

#### ViewInfo(FileType, List&lt;Page&gt;)

Initializes new instance of `ViewInfo` class.

```csharp
public ViewInfo(FileType fileType, List<Page> pages)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | List`1 | The list of pages to view. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *fileType* is null. |
| ArgumentNullException | Thrown when *pages* is null. |

### Word
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/word.md

#### Word class

Represents relatively positioned rectangle which contains single word.

```csharp
public class Word : TextElement<string>
```

#### Constructors

| Name | Description |
| --- | --- |
| Word() | Initializes new instance of `Word` class. |
| Word(string, double, double, double, double, List&lt;Character&gt;) | Initializes new instance of `Word` class. |

#### Properties

| Name | Description |
| --- | --- |
| Characters { get; set; } | The characters contained by the word. |
| Height { get; set; } | The height of the rectangle which contains the element (in pixels). |
| Value { get; set; } | The element value. |
| Width { get; set; } | The width of the rectangle which contains the element (in pixels). |
| X { get; set; } | The X coordinate of the highest left point on the page layout where the rectangle that contains element begins. |
| Y { get; set; } | The Y coordinate of the highest left point on the page layout where the rectangle that contains element begins. |

#### Methods

| Name | Description |
| --- | --- |
| override ToString() | Returns a string that represents the current object. |

### Characters
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/word/characters.md

#### Word.Characters property

The characters contained by the word.

```csharp
public List<Character> Characters { get; set; }
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/word/tostring.md

#### Word.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Word
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.results/word/word.md

#### Word()

Initializes new instance of `Word` class.

```csharp
public Word()
```

#### Word(string, double, double, double, double, List&lt;Character&gt;)

Initializes new instance of `Word` class.

```csharp
public Word(string word, double x, double y, double width, double height, 
    List<Character> characters)
```

| Parameter | Type | Description |
| --- | --- | --- |
| word | String | The word. |
| x | Double | The X coordinate of the highest left point on the page layout where the rectangle that contains word begins. |
| y | Double | The Y coordinate of the highest left point on the page layout where the rectangle that contains word begins. |
| width | Double | The width of the rectangle which contains the word. |
| height | Double | The height of the rectangle which contains the word. |
| characters | List`1 | The characters contained by the word. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *word* is null or empty. |
| ArgumentNullException | Thrown when *characters* is null. |

### GroupDocs.Viewer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer.md

The namespace provides classes for rendering documents in HTML5, Image or PDF modes fast and with high quality.

#### Classes

| Class | Description |
| --- | --- |
| FileType | Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Viewer**. |
| 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. |
| Viewer | Represents main class that controls document rendering process. |
| ViewerSettings | Defines settings for customizing `Viewer` behaviour. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IAuxDisposable | Expands the standard IDisposable interface, allows to obtain a current state of an object and subscribe to disposing event |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.viewer.dll -->

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype.md

#### FileType class

Represents file type. Provides methods to obtain list of all file types supported by **GroupDocs.Viewer**.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Constructors

| Name | Description |
| --- | --- |
| FileType() | Initializes new instance of `FileType` class. |
| FileType(string, string) | Initializes new instance of `FileType` class. |

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; set; } | Filename suffix (including the period ".") e.g. ".doc". |
| FileFormat { get; set; } | File type name e.g. "Microsoft Word Document". |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps file extension to file type. |
| static FromFilePath(string) | Extracts file extension and maps it to file type. |
| static FromMediaType(string) | Maps file media type to file type e.g. 'application/pdf' will be mapped to `PDF`. |
| static FromStream(Stream) | Detects file type by reading the file signature. |
| static FromStream(Stream, ILogger) | Detects file type by reading the file signature. |
| static FromStream(Stream, string) | Detects file type by reading the file signature. |
| static FromStream(Stream, string, ILogger) | Detects file type by reading the file signature. |
| Equals(FileType) | Determines whether the current `FileType` is the same as specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as specified object. |
| override GetHashCode() | Returns the hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static DetectEncoding(Stream) | Attempts to detect text `TXT`, `TSV`, and `CSV` file encoding by stream. |
| static DetectEncoding(string) | Attempts to detect text `TXT`, `TSV`, and `CSV` files encoding by path. |
| static GetSupportedFileTypes() | Retrieves supported file types |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly AI | Adobe Illustrator (.ai) is a file format for Adobe Illustrator drawings. Learn more about this file format [here](https://fileinfo.com/extension/ai#adobe_illustrator_file). |
| static readonly APNG | Animated Portable Network Graphic (.apng) is extension of PNG format that support animation. Learn more about this file format [here](https://wiki.fileformat.com/image/apng). |
| static readonly AS | ActionScript File (.as) |
| static readonly AS3 | ActionScript File (.as) |
| static readonly ASM | Assembly Language Source Code File (.asm) |
| static readonly AZW3 | Amazon Kindle Format 8 (KF8) ebook is the 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://wiki.fileformat.com/ebook/azw3). |
| static readonly BAT | DOS Batch File (.bat) |
| static readonly BMP | Bitmap Image File (.bmp) is 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 BZ2 | Bzip2 Compressed File (.bz2) are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. Learn more about this file format [here](https://wiki.fileformat.com/compression/bz2). |
| static readonly C | C/C++ Source Code File (.c) |
| static readonly Cab | Cabinet (or CAB) is an archive-file format for Microsoft Windows. Learn more about this file format [here](https://en.wikipedia.org/wiki/Cabinet_(file_format)). |
| static readonly CC | C++ Source Code File (.cc) |
| static readonly CDR | CorelDraw Vector Graphic Drawing (.cdr) 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 CF2 | Common File Format File Learn more about this file format [here](https://fileinfo.com/extension/cf2). |
| static readonly CGM | Computer Graphics Metafile (.cgm) is a 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 CHM | Microsoft Compiled HTML Help File (.chm) is a well-known format for HELP (documentation to some application) documents. Learn more about this file format [here](https://docs.fileformat.com/web/chm/). |
| static readonly CMAKE | CMake File (.cmake) |
| static readonly CMX | Corel Exchange (.cmx) is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here](https://wiki.fileformat.com/image/cmx). |
| 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. Learn more about this file format [here](https://wiki.fileformat.com/compression/cpio). |
| static readonly CPP | C++ Source Code File (.cpp) |
| static readonly CS | C# Source Code File (.cs) is a source code file for C# programming language. Introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here](https://wiki.fileformat.com/programming/cs). |
| static readonly CSS | Cascading Style Sheet (.css) |
| static readonly CSV | Comma Separated Values File (.csv) represents 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 CXX | C++ Source Code File (.cxx) |
| static readonly DCM | DICOM Image (.dcm) represents 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 DGN | MicroStation Design File (.dgn) 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 DIB | Device Independent Bitmap File (.dib) |
| static readonly DIFF | Patch File (.diff) |
| static readonly DJVU | DjVu Image (.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 | Digital Negative Specification (.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 DOC | Microsoft Word Document (.doc) represents 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 | Word Open XML Macro-Enabled Document (.docm) is a 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 | Microsoft Word Open XML Document (.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 | Word Document 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](https://wiki.fileformat.com/word-processing/dot). |
| static readonly DOTM | Word Open XML Macro-Enabled Document Template (.dotm) 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 | Word Open XML Document 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](https://wiki.fileformat.com/word-processing/dotx). |
| static readonly DWF | Design Web Format File (.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 | Design Web Format File XPS (.dwfx) represents 2D/3D drawing as XPS document 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/dwfx). |
| static readonly DWG | AutoCAD Drawing Database File (.dwg) represents 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 | AutoCAD Drawing Template (.dwt) 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 | Drawing Exchange Format File (.dxf) is a tagged data representation of AutoCAD drawing file. Learn more about this file format [here](https://wiki.fileformat.com/cad/dxf). |
| static readonly EMF | Enhanced Windows Metafile (.emf) represents 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 EML | E-Mail Message (.eml) 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 | Apple Mail Message (.emlx) 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 EMZ | Enhanced Windows Metafile compressed (.emz) represents graphical images device-independently compressed by GZIP. 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/emz). |
| static readonly EPS | Encapsulated PostScript File (.eps) describes 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 EPUB | Open eBook File (.epub) is 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 ERB | Ruby ERB Script (.erb) |
| static readonly Excel2003XML | Excel 2003 XML (SpreadsheetML) 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 FBX | Autodesk FBX Interchange File (FilmBoX) (.fbx) represents 3D model format. Learn more about this file format [here](https://wiki.fileformat.com/cad/fbx). |
| static readonly FODG | Flat XML ODF Template (.fodg) 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/fodg). |
| static readonly FODP | OpenDocument Presentation (.fodp) represents OpenDocument Flat XML Presentation. Learn more about this file format [here](https://fileinfo.com/extension/fodp). |
| static readonly FODS | OpenDocument Flat XML Spreadsheet (.fods) |
| static readonly GIF | Graphical Interchange Format File (.gif) 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 GROOVY | Groovy Source Code File (.groovy) |
| static readonly GZ | Gnu Zipped File (.gz) are compressed files created with gzip compression application. It can contain multiple compressed files and is commonly used on UNIX and Linux systems. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz). |
| static readonly GZIP | Gnu Zipped File (.gzip) was introduced as a free utility for replacing the Compress program used in Unix systems. Such files can be opened and extracted with a several applications such as WinZip which is available on both Windows and MacOS. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz). |
| static readonly H | C/C++/Objective-C Header File (.h) |
| static readonly HAML | Haml Source Code File (.haml) |
| static readonly HH | C++ Header File (.hh) |
| static readonly HPG | PLT (HPGL) (.hpg) |
| static readonly HTM | Hypertext Markup Language File (.htm) 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 | Hypertext Markup Language File (.html) 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 ICO | Icon File (.ico) 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 IFC | Industry Foundation Classes File (.ifc) is a 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 | Initial Graphics Exchange Specification (IGES) (.igs) |
| static readonly Iso | ISO optical disc image 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. Learn more about this file format [here](https://docs.fileformat.com/compression/iso/). |
| static readonly J2C | JPEG 2000 Code Stream (.j2c) |
| static readonly J2K | JPEG 2000 Code Stream (.j2k) 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 JAVA | Java Source Code File (.java) |
| static readonly JFIF | JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. This format uses JPEG compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jfif). |
| static readonly JLS | JPEG-LS (JLS) (.jls) |
| static readonly JP2 | JPEG 2000 Core Image File (.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 | JPEG 2000 Code Stream (.jpc) |
| static readonly JPEG | JPEG Image (.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 | JPEG 2000 Image File (.jpf) |
| static readonly JPG | JPEG Image (.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 | JPEG 2000 Image File (.jpm) |
| static readonly JPX | JPEG 2000 Image File (.jpx) |
| static readonly JS | JavaScript File (.js) |
| static readonly JSON | JavaScript Object Notation File (.json) |
| static readonly LESS | LESS Style Sheet (.less) |
| static readonly Lha | LHA or LZH is a freeware compression utility and associated file format. Learn more about this file format [here](https://docs.fileformat.com/compression/lzh/). |
| static readonly LOG | Log File (.log) |
| static readonly M | Objective-C Implementation File (.m) |
| static readonly MAKE | Xcode Makefile Script (.make) |
| static readonly MBOX | Email Mailbox File (.mbox) Learn more about this file format [here](https://fileinfo.com/extension/mbox). |
| static readonly MD | Markdown Documentation File (.md) |
| static readonly MHT | MHTML Web Archive (.mht) |
| static readonly MHTML | MIME HTML File (.mhtml) |
| static readonly ML | ML Source Code File (.ml) |
| static readonly MM | Objective-C++ Source File (.mm) |
| static readonly MOBI | Mobipocket eBook (.mobi) 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). |
| static readonly MPP | Microsoft Project File (.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 (.mpt) contains 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 Project Exchange file (.mpx) 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 MSG | Outlook Mail Message (.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 NSF | Lotus Notes Database (.nsf) Learn more about this file format [here](https://fileinfo.com/extension/nsf). |
| static readonly NUMBERS | Apple numbers represents Excel like Binary File Format. Such files can be created by Apple numbers application. Learn more about this file format [here](https://fileinfo.com/extension/numbers). |
| static readonly OBJ | Wavefront 3D Object File (.obj) is 3D image file introduced by Wavefront Technologies Learn more about this file format [here](https://wiki.fileformat.com/3d/obj/). |
| static readonly ODG | OpenDocument Graphic File (.odg) 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 ODP | OpenDocument Presentation (.odp) represents 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 ODS | OpenDocument Spreadsheet (.ods) stands 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 ODT | OpenDocument Text Document (.odt) 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 OFD | Open Fixed-layout Document (OFD) format defined by GB/T 33190-2016 aims to replace PDF in Chinese public institutions |
| static readonly ONE | OneNote Document (.one) is 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). |
| static readonly OST | Outlook Offline Data File (.ost) represents 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 OTG | OpenDocument Graphic Template (.otg) |
| static readonly OTP | OpenDocument Presentation Template (.otp) represents 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 OTS | OpenDocument Spreadsheet Template (.ots) |
| static readonly OTT | OpenDocument Document Template (.ott) represents 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 OXPS | OpenXPS File (.oxps) |
| static readonly PCL | Printer Command Language Document (.pcl) |
| static readonly PDF | Portable Document Format File (.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). |
| static readonly PHP | PHP Source Code File (.php) |
| static readonly PL | Perl Script (.pl) |
| static readonly PLT | PLT (HPGL) (.plt) 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 PNG | Portable Network Graphic (.png) is 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 POT | PowerPoint Template (.pot) represents 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 | PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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 | PowerPoint Open XML Presentation Template (.potx) represents 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 | PowerPoint Slide Show (.pps) 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 | PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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 | PowerPoint Open XML Slide Show (.ppsx) files 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 | PowerPoint Presentation (.ppt) 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 | PowerPoint Open XML Macro-Enabled Presentation 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 | PowerPoint Open XML Presentation (.pptx) 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). |
| static readonly PROPERTIES | Java Properties File (.properties) |
| static readonly PS | PostScript File (.ps) |
| static readonly PS1 | PowerShell script file (.ps1) a file format for Windows PowerShell Cmdlet files. Learn more about this file format [here](https://fileinfo.com/extension/ps1). |
| static readonly PSB | Photoshop Large Document Format (.psb) represents Photoshop Large Document Format used for graphics designing and development. Learn more about this file format [here](https://wiki.fileformat.com/image/psb). |
| static readonly PSD | Adobe Photoshop Document (.psd) 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 PSD1 | PowerShell script module manifest (.psd1) a file format for PowerShell module manifest scripts. Learn more about this file format [here](https://fileinfo.com/extension/psd1). |
| static readonly PSM1 | PowerShell script module (.psm1) a file format for PowerShell module scripts. Learn more about this file format [here](https://fileinfo.com/extension/psm1). |
| static readonly PST | Outlook Personal Information Store File (.pst) represents 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 PY | Python Script (.py) |
| static readonly RAR | Roshal ARchive (.rar) are compressed files generated using the RAR (WINRAR) compression method. Learn more about this file format [here](https://wiki.fileformat.com/compression/rar). |
| static readonly RB | Ruby Source Code (.rb) |
| static readonly RST | reStructuredText File (.rst) |
| static readonly RTF | Rich Text Format File (.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 SASS | Syntactically Awesome StyleSheets File (.sass) |
| static readonly SCALA | Scala Source Code File (.scala) |
| static readonly SCM | Scheme Source Code File (.scm) |
| static readonly SCRIPT | Generic Script File (.script) |
| static readonly SevenZip | 7Zip (.7z, .7zip) is free open source archiver with LZMA and LZMA2 compression. Learn more about this file format [here](https://docs.fileformat.com/compression/7z/). |
| static readonly SH | Bash Shell Script (.sh) |
| static readonly SML | Standard ML Source Code File (.sml) |
| static readonly SQL | Structured Query Language Data File (.sql) |
| static readonly STL | Stereolithography File (.stl) 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). |
| static readonly SVG | Scalable Vector Graphics File (.svg) 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 | Scalable Vector Graphics File (.svgz) is a Scalar Vector Graphics file that uses XML based text format, compressed by GZIP for describing the appearance of an image. Learn more about this file format [here](https://fileinfo.com/extension/svgz). |
| static readonly SXC | StarOffice Calc Spreadsheet (.sxc) |
| static readonly TAR | Consolidated Unix File Archive (.tar) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://wiki.fileformat.com/compression/tar). |
| static readonly TARGZ | Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/tgz). |
| static readonly TARXZ | Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/txz). |
| static readonly TarZst | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| static readonly TEX | LaTeX Source Document (.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 TGA | Truevision TGA (Truevision Advanced Raster Adapter - TARGA) is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here](https://wiki.fileformat.com/image/tga). |
| static readonly TGZ | Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/tgz). |
| static readonly TIF | Tagged Image File (.tif) 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 | Tagged Image File Format (.tiff) 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 TSV | Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/tsv). |
| static readonly TXT | Plain Text File (.txt) 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). |
| static readonly TXZ | Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/txz). |
| static readonly Tzst | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| static readonly Unknown | Represents unknown file type. |
| static readonly VB | Visual Basic Project Item File (.vb) is a source code file created in Visual Basic language that was created by Microsoft for development of .NET applications. Learn more about this file format [here](https://wiki.fileformat.com/programming/vb). |
| static readonly VCF | vCard File (.vcf) 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). |
| static readonly VDW | Visio Web Drawing (.vdw) represents 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 | Visio Drawing XML File (.vdx) represents 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 VIM | Vim Settings File (.vim) |
| static readonly VSD | Visio Drawing File (.vsd) 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 | Visio Macro-Enabled Drawing (.vsdm) 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 | Visio Drawing (.vsdx) represents 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 | Visio Stencil File(.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 | Visio Macro-Enabled Stencil File (.vssm) 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 | Visio Stencil File (.vssx) 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 | Visio Drawing Template (.vst) 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 | Visio Macro-Enabled Drawing Template (.vstm) 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 | Visio Drawing Template (.vstx) 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 | Visio Stencil XML File (.vsx) refers 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 | Visio Template XML File (.vtx) 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). |
| static readonly WEBP | WebP Image (.webp) 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 | Windows Metafile (.wmf) represents 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 | Compressed Windows Metafile (.wmz) represents Microsoft Windows Metafile (WMF) compressed in GZIP archvive - for storing vector as well as bitmap-format images data. Learn more about this file format [here](https://fileinfo.com/extension/wmz#compressed_windows_metafile). |
| static readonly XLAM | Microsoft Excel Add-in (.xlam) |
| static readonly XLS | Excel Spreadsheet (.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 | Excel Binary Spreadsheet (.xlsb) 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 | Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm). |
| static readonly XLSX | Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 | Microsoft Excel Template (.xlt) 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 | Microsoft Excel Macro-Enabled Template (.xltm) 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 | Excel Open XML Spreadsheet Template (.xltx) 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). |
| static readonly XML | XML File (.xml). GroupDocs.Viewer has a special processor for handling the XML files, see [documentation](https://docs.groupdocs.com/viewer/net/render-xml-documents/). |
| static readonly XPS | XML Paper Specification File (.xps) 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). |
| static readonly XZ | XZ file (.xz) is archive compressed a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here](https://fileinfo.com/extension/xz). |
| static readonly YAML | YAML Document (.yaml) |
| static readonly ZIP | Zipped File (.zip) represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip). |
| static readonly Zstandard | 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. ZST files can be used to compress different types of files such as databases, file systems, networks, and games. Learn more about this file format [here](https://docs.fileformat.com/compression/zst/). |

### AI
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ai.md

#### FileType.AI field

Adobe Illustrator (.ai) is a file format for Adobe Illustrator drawings. Learn more about this file format [here](https://fileinfo.com/extension/ai#adobe_illustrator_file).

```csharp
public static readonly FileType AI;
```

### APNG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/apng.md

#### FileType.APNG field

Animated Portable Network Graphic (.apng) is extension of PNG format that support animation. Learn more about this file format [here](https://wiki.fileformat.com/image/apng).

```csharp
public static readonly FileType APNG;
```

### AS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/as.md

#### FileType.AS field

ActionScript File (.as)

```csharp
public static readonly FileType AS;
```

### AS3
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/as3.md

#### FileType.AS3 field

ActionScript File (.as)

```csharp
public static readonly FileType AS3;
```

### ASM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/asm.md

#### FileType.ASM field

Assembly Language Source Code File (.asm)

```csharp
public static readonly FileType ASM;
```

### AZW3
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/azw3.md

#### FileType.AZW3 field

Amazon Kindle Format 8 (KF8) ebook is the 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://wiki.fileformat.com/ebook/azw3).

```csharp
public static readonly FileType AZW3;
```

### BAT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/bat.md

#### FileType.BAT field

DOS Batch File (.bat)

```csharp
public static readonly FileType BAT;
```

### BMP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/bmp.md

#### FileType.BMP field

Bitmap Image File (.bmp) is 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 FileType BMP;
```

### BZ2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/bz2.md

#### FileType.BZ2 field

Bzip2 Compressed File (.bz2) are compressed files generated using the BZIP2 open source compression method, mostly on UNIX or Linux system. Learn more about this file format [here](https://wiki.fileformat.com/compression/bz2).

```csharp
public static readonly FileType BZ2;
```

### C
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/c.md

#### FileType.C field

C/C++ Source Code File (.c)

```csharp
public static readonly FileType C;
```

### Cab
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cab.md

#### FileType.Cab field

Cabinet (or CAB) is an archive-file format for Microsoft Windows. Learn more about this file format [here](https://en.wikipedia.org/wiki/Cabinet_(file_format)).

```csharp
public static readonly FileType Cab;
```

### CC
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cc.md

#### FileType.CC field

C++ Source Code File (.cc)

```csharp
public static readonly FileType CC;
```

### CDR
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cdr.md

#### FileType.CDR field

CorelDraw Vector Graphic Drawing (.cdr) 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 FileType CDR;
```

### CF2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cf2.md

#### FileType.CF2 field

Common File Format File Learn more about this file format [here](https://fileinfo.com/extension/cf2).

```csharp
public static readonly FileType CF2;
```

### CGM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cgm.md

#### FileType.CGM field

Computer Graphics Metafile (.cgm) is a 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 FileType CGM;
```

### CHM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/chm.md

#### FileType.CHM field

Microsoft Compiled HTML Help File (.chm) is a well-known format for HELP (documentation to some application) documents. Learn more about this file format [here](https://docs.fileformat.com/web/chm/).

```csharp
public static readonly FileType CHM;
```

### CMAKE
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cmake.md

#### FileType.CMAKE field

CMake File (.cmake)

```csharp
public static readonly FileType CMAKE;
```

### CMX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cmx.md

#### FileType.CMX field

Corel Exchange (.cmx) is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here](https://wiki.fileformat.com/image/cmx).

```csharp
public static readonly FileType CMX;
```

### CPIO
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cpio.md

#### FileType.CPIO field

Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems. Learn more about this file format [here](https://wiki.fileformat.com/compression/cpio).

```csharp
public static readonly FileType CPIO;
```

### CPP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cpp.md

#### FileType.CPP field

C++ Source Code File (.cpp)

```csharp
public static readonly FileType CPP;
```

### CS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cs.md

#### FileType.CS field

C# Source Code File (.cs) is a source code file for C# programming language. Introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here](https://wiki.fileformat.com/programming/cs).

```csharp
public static readonly FileType CS;
```

### CSS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/css.md

#### FileType.CSS field

Cascading Style Sheet (.css)

```csharp
public static readonly FileType CSS;
```

### CSV
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/csv.md

#### FileType.CSV field

Comma Separated Values File (.csv) represents 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 FileType CSV;
```

### CXX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/cxx.md

#### FileType.CXX field

C++ Source Code File (.cxx)

```csharp
public static readonly FileType CXX;
```

### DCM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dcm.md

#### FileType.DCM field

DICOM Image (.dcm) represents 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 FileType DCM;
```

### DetectEncoding
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/detectencoding.md

#### DetectEncoding(string)

Attempts to detect text `TXT`, `TSV`, and `CSV` files encoding by path.

```csharp
public static Encoding DetectEncoding(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file name or file path. |

##### Return Value

Encoding or null when fails to detect a file encoding.

##### Examples

The example demonstrates how to detect text file encoding.

```csharp
Encoding encoding = FileType.DetectEncoding("message.txt");
```

#### DetectEncoding(Stream)

Attempts to detect text `TXT`, `TSV`, and `CSV` file encoding by stream.

```csharp
public static Encoding DetectEncoding(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |

##### Return Value

Encoding or null when fails to detect a file encoding.

##### Examples

The example demonstrates how to detect text file encoding.

```csharp
Stream stream = File.OpenRead("message.txt");
Encoding encoding = FileType.DetectEncoding(stream);
```

### DGN
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dgn.md

#### FileType.DGN field

MicroStation Design File (.dgn) 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 FileType DGN;
```

### DIB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dib.md

#### FileType.DIB field

Device Independent Bitmap File (.dib)

```csharp
public static readonly FileType DIB;
```

### DIFF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/diff.md

#### FileType.DIFF field

Patch File (.diff)

```csharp
public static readonly FileType DIFF;
```

### DJVU
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/djvu.md

#### FileType.DJVU field

DjVu Image (.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 FileType DJVU;
```

### DNG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dng.md

#### FileType.DNG field

Digital Negative Specification (.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 FileType DNG;
```

### DOC
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/doc.md

#### FileType.DOC field

Microsoft Word Document (.doc) represents 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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/docm.md

#### FileType.DOCM field

Word Open XML Macro-Enabled Document (.docm) is a 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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/docx.md

#### FileType.DOCX field

Microsoft Word Open XML Document (.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dot.md

#### FileType.DOT field

Word Document 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](https://wiki.fileformat.com/word-processing/dot).

```csharp
public static readonly FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dotm.md

#### FileType.DOTM field

Word Open XML Macro-Enabled Document Template (.dotm) 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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dotx.md

#### FileType.DOTX field

Word Open XML Document 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](https://wiki.fileformat.com/word-processing/dotx).

```csharp
public static readonly FileType DOTX;
```

### DWF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dwf.md

#### FileType.DWF field

Design Web Format File (.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 FileType DWF;
```

### DWFX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dwfx.md

#### FileType.DWFX field

Design Web Format File XPS (.dwfx) represents 2D/3D drawing as XPS document 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/dwfx).

```csharp
public static readonly FileType DWFX;
```

### DWG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dwg.md

#### FileType.DWG field

AutoCAD Drawing Database File (.dwg) represents 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 FileType DWG;
```

### DWT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dwt.md

#### FileType.DWT field

AutoCAD Drawing Template (.dwt) 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 FileType DWT;
```

### DXF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/dxf.md

#### FileType.DXF field

Drawing Exchange Format File (.dxf) 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 FileType DXF;
```

### EMF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/emf.md

#### FileType.EMF field

Enhanced Windows Metafile (.emf) represents 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 FileType EMF;
```

### EML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/eml.md

#### FileType.EML field

E-Mail Message (.eml) 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 FileType EML;
```

### EMLX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/emlx.md

#### FileType.EMLX field

Apple Mail Message (.emlx) 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 FileType EMLX;
```

### EMZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/emz.md

#### FileType.EMZ field

Enhanced Windows Metafile compressed (.emz) represents graphical images device-independently compressed by GZIP. 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/emz).

```csharp
public static readonly FileType EMZ;
```

### EPS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/eps.md

#### FileType.EPS field

Encapsulated PostScript File (.eps) describes 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 FileType EPS;
```

### EPUB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/epub.md

#### FileType.EPUB field

Open eBook File (.epub) is 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 FileType EPUB;
```

### Equals
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

#### Equals(object)

Determines whether the current `FileType` is the same as specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

### ERB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/erb.md

#### FileType.ERB field

Ruby ERB Script (.erb)

```csharp
public static readonly FileType ERB;
```

### Excel2003XML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/excel2003xml.md

#### FileType.Excel2003XML field

Excel 2003 XML (SpreadsheetML) 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 FileType Excel2003XML;
```

### Extension
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/extension.md

#### FileType.Extension property

Filename suffix (including the period ".") e.g. ".doc".

```csharp
public string Extension { get; set; }
```

### FBX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fbx.md

#### FileType.FBX field

Autodesk FBX Interchange File (FilmBoX) (.fbx) represents 3D model format. Learn more about this file format [here](https://wiki.fileformat.com/cad/fbx).

```csharp
public static readonly FileType FBX;
```

### FileFormat
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fileformat.md

#### FileType.FileFormat property

File type name e.g. "Microsoft Word Document".

```csharp
public string FileFormat { get; set; }
```

### FileType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/filetype.md

#### FileType()

Initializes new instance of `FileType` class.

```csharp
public FileType()
```

#### FileType(string, string)

Initializes new instance of `FileType` class.

```csharp
public FileType(string fileFormat, string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileFormat | String | File format e.g. "Drawing Exchange Format File" |
| extension | String | File extension with dot e.g. ".dxf" |

### FODG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fodg.md

#### FileType.FODG field

Flat XML ODF Template (.fodg) 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/fodg).

```csharp
public static readonly FileType FODG;
```

### FODP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fodp.md

#### FileType.FODP field

OpenDocument Presentation (.fodp) represents OpenDocument Flat XML Presentation. Learn more about this file format [here](https://fileinfo.com/extension/fodp).

```csharp
public static readonly FileType FODP;
```

### FODS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fods.md

#### FileType.FODS field

OpenDocument Flat XML Spreadsheet (.fods)

```csharp
public static readonly FileType FODS;
```

### FromExtension
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fromextension.md

#### FileType.FromExtension method

Maps file extension to file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | File extension with or without the period ".". |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

### FromFilePath
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fromfilepath.md

#### FileType.FromFilePath method

Extracts file extension and maps it to file type.

```csharp
public static FileType FromFilePath(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file name or file path. |

##### Return Value

When file type is supported returns it, otherwise returns default `Unknown` file type.

### FromMediaType
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/frommediatype.md

#### FileType.FromMediaType method

Maps file media type to file type e.g. 'application/pdf' will be mapped to `PDF`.

```csharp
public static FileType FromMediaType(string mediaType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| mediaType | String | File media type e.g. application/pdf. |

##### Return Value

Returns corresponding media type when found, otherwise returns default `Unknown` file type.

### FromStream
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/fromstream.md

#### FromStream(Stream)

Detects file type by reading the file signature.

```csharp
public static FileType FromStream(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |

#### FromStream(Stream, string)

Detects file type by reading the file signature.

```csharp
public static FileType FromStream(Stream stream, string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| password | String | The password to open the file. |

#### FromStream(Stream, ILogger)

Detects file type by reading the file signature.

```csharp
public static FileType FromStream(Stream stream, ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| logger | ILogger | The logger. |

##### Return Value

Returns file type in case it was detected successfully otherwise returns default `Unknown` file type.

#### FromStream(Stream, string, ILogger)

Detects file type by reading the file signature.

```csharp
public static FileType FromStream(Stream stream, string password, ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| password | String | The password to open the file. |
| logger | ILogger | The logger. |

##### Return Value

Returns file type in case it was detected successfully otherwise returns default `Unknown` file type.

### GetHashCode
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns the hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves supported file types

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns sequence of supported file types

### GIF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/gif.md

#### FileType.GIF field

Graphical Interchange Format File (.gif) 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 FileType GIF;
```

### GROOVY
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/groovy.md

#### FileType.GROOVY field

Groovy Source Code File (.groovy)

```csharp
public static readonly FileType GROOVY;
```

### GZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/gz.md

#### FileType.GZ field

Gnu Zipped File (.gz) are compressed files created with gzip compression application. It can contain multiple compressed files and is commonly used on UNIX and Linux systems. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz).

```csharp
public static readonly FileType GZ;
```

### GZIP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/gzip.md

#### FileType.GZIP field

Gnu Zipped File (.gzip) was introduced as a free utility for replacing the Compress program used in Unix systems. Such files can be opened and extracted with a several applications such as WinZip which is available on both Windows and MacOS. Learn more about this file format [here](https://wiki.fileformat.com/compression/gz).

```csharp
public static readonly FileType GZIP;
```

### H
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/h.md

#### FileType.H field

C/C++/Objective-C Header File (.h)

```csharp
public static readonly FileType H;
```

### HAML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/haml.md

#### FileType.HAML field

Haml Source Code File (.haml)

```csharp
public static readonly FileType HAML;
```

### HH
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/hh.md

#### FileType.HH field

C++ Header File (.hh)

```csharp
public static readonly FileType HH;
```

### HPG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/hpg.md

#### FileType.HPG field

PLT (HPGL) (.hpg)

```csharp
public static readonly FileType HPG;
```

### HTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/htm.md

#### FileType.HTM field

Hypertext Markup Language File (.htm) 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 FileType HTM;
```

### HTML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/html.md

#### FileType.HTML field

Hypertext Markup Language File (.html) 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 FileType HTML;
```

### ICO
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ico.md

#### FileType.ICO field

Icon File (.ico) 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 FileType ICO;
```

### IFC
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ifc.md

#### FileType.IFC field

Industry Foundation Classes File (.ifc) is a 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 FileType IFC;
```

### IGS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/igs.md

#### FileType.IGS field

Initial Graphics Exchange Specification (IGES) (.igs)

```csharp
public static readonly FileType IGS;
```

### Iso
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/iso.md

#### FileType.Iso field

ISO optical disc image 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. Learn more about this file format [here](https://docs.fileformat.com/compression/iso/).

```csharp
public static readonly FileType Iso;
```

### J2C
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/j2c.md

#### FileType.J2C field

JPEG 2000 Code Stream (.j2c)

```csharp
public static readonly FileType J2C;
```

### J2K
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/j2k.md

#### FileType.J2K field

JPEG 2000 Code Stream (.j2k) 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 FileType J2K;
```

### JAVA
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/java.md

#### FileType.JAVA field

Java Source Code File (.java)

```csharp
public static readonly FileType JAVA;
```

### JFIF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jfif.md

#### FileType.JFIF field

JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. This format uses JPEG compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jfif).

```csharp
public static readonly FileType JFIF;
```

### JLS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jls.md

#### FileType.JLS field

JPEG-LS (JLS) (.jls)

```csharp
public static readonly FileType JLS;
```

### JP2
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jp2.md

#### FileType.JP2 field

JPEG 2000 Core Image File (.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 FileType JP2;
```

### JPC
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpc.md

#### FileType.JPC field

JPEG 2000 Code Stream (.jpc)

```csharp
public static readonly FileType JPC;
```

### JPEG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpeg.md

#### FileType.JPEG field

JPEG Image (.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 FileType JPEG;
```

### JPF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpf.md

#### FileType.JPF field

JPEG 2000 Image File (.jpf)

```csharp
public static readonly FileType JPF;
```

### JPG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpg.md

#### FileType.JPG field

JPEG Image (.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 FileType JPG;
```

### JPM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpm.md

#### FileType.JPM field

JPEG 2000 Image File (.jpm)

```csharp
public static readonly FileType JPM;
```

### JPX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/jpx.md

#### FileType.JPX field

JPEG 2000 Image File (.jpx)

```csharp
public static readonly FileType JPX;
```

### JS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/js.md

#### FileType.JS field

JavaScript File (.js)

```csharp
public static readonly FileType JS;
```

### JSON
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/json.md

#### FileType.JSON field

JavaScript Object Notation File (.json)

```csharp
public static readonly FileType JSON;
```

### LESS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/less.md

#### FileType.LESS field

LESS Style Sheet (.less)

```csharp
public static readonly FileType LESS;
```

### Lha
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/lha.md

#### FileType.Lha field

LHA or LZH is a freeware compression utility and associated file format. Learn more about this file format [here](https://docs.fileformat.com/compression/lzh/).

```csharp
public static readonly FileType Lha;
```

### LOG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/log.md

#### FileType.LOG field

Log File (.log)

```csharp
public static readonly FileType LOG;
```

### M
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/m.md

#### FileType.M field

Objective-C Implementation File (.m)

```csharp
public static readonly FileType M;
```

### MAKE
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/make.md

#### FileType.MAKE field

Xcode Makefile Script (.make)

```csharp
public static readonly FileType MAKE;
```

### MBOX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mbox.md

#### FileType.MBOX field

Email Mailbox File (.mbox) Learn more about this file format [here](https://fileinfo.com/extension/mbox).

```csharp
public static readonly FileType MBOX;
```

### MD
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/md.md

#### FileType.MD field

Markdown Documentation File (.md)

```csharp
public static readonly FileType MD;
```

### MHT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mht.md

#### FileType.MHT field

MHTML Web Archive (.mht)

```csharp
public static readonly FileType MHT;
```

### MHTML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mhtml.md

#### FileType.MHTML field

MIME HTML File (.mhtml)

```csharp
public static readonly FileType MHTML;
```

### ML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ml.md

#### FileType.ML field

ML Source Code File (.ml)

```csharp
public static readonly FileType ML;
```

### MM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mm.md

#### FileType.MM field

Objective-C++ Source File (.mm)

```csharp
public static readonly FileType MM;
```

### MOBI
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mobi.md

#### FileType.MOBI field

Mobipocket eBook (.mobi) 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 FileType MOBI;
```

### MPP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mpp.md

#### FileType.MPP field

Microsoft Project File (.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 FileType MPP;
```

### MPT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mpt.md

#### FileType.MPT field

Microsoft Project Template (.mpt) contains 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 FileType MPT;
```

### MPX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/mpx.md

#### FileType.MPX field

Microsoft Project Exchange file (.mpx) 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 FileType MPX;
```

### MSG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/msg.md

#### FileType.MSG field

Outlook Mail Message (.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 FileType MSG;
```

### NSF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/nsf.md

#### FileType.NSF field

Lotus Notes Database (.nsf) Learn more about this file format [here](https://fileinfo.com/extension/nsf).

```csharp
public static readonly FileType NSF;
```

### NUMBERS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/numbers.md

#### FileType.NUMBERS field

Apple numbers represents Excel like Binary File Format. Such files can be created by Apple numbers application. Learn more about this file format [here](https://fileinfo.com/extension/numbers).

```csharp
public static readonly FileType NUMBERS;
```

### OBJ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/obj.md

#### FileType.OBJ field

Wavefront 3D Object File (.obj) is 3D image file introduced by Wavefront Technologies Learn more about this file format [here](https://wiki.fileformat.com/3d/obj/).

```csharp
public static readonly FileType OBJ;
```

### ODG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/odg.md

#### FileType.ODG field

OpenDocument Graphic File (.odg) 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 FileType ODG;
```

### ODP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/odp.md

#### FileType.ODP field

OpenDocument Presentation (.odp) represents 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 FileType ODP;
```

### ODS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ods.md

#### FileType.ODS field

OpenDocument Spreadsheet (.ods) stands 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 FileType ODS;
```

### ODT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/odt.md

#### FileType.ODT field

OpenDocument Text Document (.odt) 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 FileType ODT;
```

### OFD
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ofd.md

#### FileType.OFD field

Open Fixed-layout Document (OFD) format defined by GB/T 33190-2016 aims to replace PDF in Chinese public institutions

```csharp
public static readonly FileType OFD;
```

### ONE
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/one.md

#### FileType.ONE field

OneNote Document (.one) is 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 FileType ONE;
```

### op_Equality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

### op_Inequality
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

### OST
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ost.md

#### FileType.OST field

Outlook Offline Data File (.ost) represents 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 FileType OST;
```

### OTG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/otg.md

#### FileType.OTG field

OpenDocument Graphic Template (.otg)

```csharp
public static readonly FileType OTG;
```

### OTP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/otp.md

#### FileType.OTP field

OpenDocument Presentation Template (.otp) represents 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 FileType OTP;
```

### OTS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ots.md

#### FileType.OTS field

OpenDocument Spreadsheet Template (.ots)

```csharp
public static readonly FileType OTS;
```

### OTT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ott.md

#### FileType.OTT field

OpenDocument Document Template (.ott) represents 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 FileType OTT;
```

### OXPS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/oxps.md

#### FileType.OXPS field

OpenXPS File (.oxps)

```csharp
public static readonly FileType OXPS;
```

### PCL
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pcl.md

#### FileType.PCL field

Printer Command Language Document (.pcl)

```csharp
public static readonly FileType PCL;
```

### PDF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pdf.md

#### FileType.PDF field

Portable Document Format File (.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 FileType PDF;
```

### PHP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/php.md

#### FileType.PHP field

PHP Source Code File (.php)

```csharp
public static readonly FileType PHP;
```

### PL
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pl.md

#### FileType.PL field

Perl Script (.pl)

```csharp
public static readonly FileType PL;
```

### PLT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/plt.md

#### FileType.PLT field

PLT (HPGL) (.plt) 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 FileType PLT;
```

### PNG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/png.md

#### FileType.PNG field

Portable Network Graphic (.png) is 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 FileType PNG;
```

### POT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pot.md

#### FileType.POT field

PowerPoint Template (.pot) represents 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 FileType POT;
```

### POTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/potm.md

#### FileType.POTM field

PowerPoint Open XML Macro-Enabled Presentation Template (.potm) 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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/potx.md

#### FileType.POTX field

PowerPoint Open XML Presentation Template (.potx) represents 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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pps.md

#### FileType.PPS field

PowerPoint Slide Show (.pps) 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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ppsm.md

#### FileType.PPSM field

PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents 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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ppsx.md

#### FileType.PPSX field

PowerPoint Open XML Slide Show (.ppsx) files 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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ppt.md

#### FileType.PPT field

PowerPoint Presentation (.ppt) 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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pptm.md

#### FileType.PPTM field

PowerPoint Open XML Macro-Enabled Presentation 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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pptx.md

#### FileType.PPTX field

PowerPoint Open XML Presentation (.pptx) 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 FileType PPTX;
```

### PROPERTIES
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/properties.md

#### FileType.PROPERTIES field

Java Properties File (.properties)

```csharp
public static readonly FileType PROPERTIES;
```

### PS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ps.md

#### FileType.PS field

PostScript File (.ps)

```csharp
public static readonly FileType PS;
```

### PS1
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/ps1.md

#### FileType.PS1 field

PowerShell script file (.ps1) a file format for Windows PowerShell Cmdlet files. Learn more about this file format [here](https://fileinfo.com/extension/ps1).

```csharp
public static readonly FileType PS1;
```

### PSB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/psb.md

#### FileType.PSB field

Photoshop Large Document Format (.psb) represents Photoshop Large Document Format used for graphics designing and development. Learn more about this file format [here](https://wiki.fileformat.com/image/psb).

```csharp
public static readonly FileType PSB;
```

### PSD
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/psd.md

#### FileType.PSD field

Adobe Photoshop Document (.psd) 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 FileType PSD;
```

### PSD1
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/psd1.md

#### FileType.PSD1 field

PowerShell script module manifest (.psd1) a file format for PowerShell module manifest scripts. Learn more about this file format [here](https://fileinfo.com/extension/psd1).

```csharp
public static readonly FileType PSD1;
```

### PSM1
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/psm1.md

#### FileType.PSM1 field

PowerShell script module (.psm1) a file format for PowerShell module scripts. Learn more about this file format [here](https://fileinfo.com/extension/psm1).

```csharp
public static readonly FileType PSM1;
```

### PST
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/pst.md

#### FileType.PST field

Outlook Personal Information Store File (.pst) represents 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 FileType PST;
```

### PY
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/py.md

#### FileType.PY field

Python Script (.py)

```csharp
public static readonly FileType PY;
```

### RAR
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/rar.md

#### FileType.RAR field

Roshal ARchive (.rar) are compressed files generated using the RAR (WINRAR) compression method. Learn more about this file format [here](https://wiki.fileformat.com/compression/rar).

```csharp
public static readonly FileType RAR;
```

### RB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/rb.md

#### FileType.RB field

Ruby Source Code (.rb)

```csharp
public static readonly FileType RB;
```

### RST
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/rst.md

#### FileType.RST field

reStructuredText File (.rst)

```csharp
public static readonly FileType RST;
```

### RTF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/rtf.md

#### FileType.RTF field

Rich Text Format File (.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 FileType RTF;
```

### SASS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sass.md

#### FileType.SASS field

Syntactically Awesome StyleSheets File (.sass)

```csharp
public static readonly FileType SASS;
```

### SCALA
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/scala.md

#### FileType.SCALA field

Scala Source Code File (.scala)

```csharp
public static readonly FileType SCALA;
```

### SCM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/scm.md

#### FileType.SCM field

Scheme Source Code File (.scm)

```csharp
public static readonly FileType SCM;
```

### SCRIPT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/script.md

#### FileType.SCRIPT field

Generic Script File (.script)

```csharp
public static readonly FileType SCRIPT;
```

### SevenZip
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sevenzip.md

#### FileType.SevenZip field

7Zip (.7z, .7zip) is free open source archiver with LZMA and LZMA2 compression. Learn more about this file format [here](https://docs.fileformat.com/compression/7z/).

```csharp
public static readonly FileType SevenZip;
```

### SH
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sh.md

#### FileType.SH field

Bash Shell Script (.sh)

```csharp
public static readonly FileType SH;
```

### SML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sml.md

#### FileType.SML field

Standard ML Source Code File (.sml)

```csharp
public static readonly FileType SML;
```

### SQL
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sql.md

#### FileType.SQL field

Structured Query Language Data File (.sql)

```csharp
public static readonly FileType SQL;
```

### STL
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/stl.md

#### FileType.STL field

Stereolithography File (.stl) 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 FileType STL;
```

### SVG
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/svg.md

#### FileType.SVG field

Scalable Vector Graphics File (.svg) 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 FileType SVG;
```

### SVGZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/svgz.md

#### FileType.SVGZ field

Scalable Vector Graphics File (.svgz) is a Scalar Vector Graphics file that uses XML based text format, compressed by GZIP for describing the appearance of an image. Learn more about this file format [here](https://fileinfo.com/extension/svgz).

```csharp
public static readonly FileType SVGZ;
```

### SXC
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/sxc.md

#### FileType.SXC field

StarOffice Calc Spreadsheet (.sxc)

```csharp
public static readonly FileType SXC;
```

### TAR
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tar.md

#### FileType.TAR field

Consolidated Unix File Archive (.tar) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://wiki.fileformat.com/compression/tar).

```csharp
public static readonly FileType TAR;
```

### TARGZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/targz.md

#### FileType.TARGZ field

Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/tgz).

```csharp
public static readonly FileType TARGZ;
```

### TARXZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tarxz.md

#### FileType.TARXZ field

Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/txz).

```csharp
public static readonly FileType TARXZ;
```

### TarZst
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tarzst.md

#### FileType.TarZst field

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

```csharp
public static readonly FileType TarZst;
```

### TEX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tex.md

#### FileType.TEX field

LaTeX Source Document (.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 FileType TEX;
```

### TGA
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tga.md

#### FileType.TGA field

Truevision TGA (Truevision Advanced Raster Adapter - TARGA) is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here](https://wiki.fileformat.com/image/tga).

```csharp
public static readonly FileType TGA;
```

### TGZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tgz.md

#### FileType.TGZ field

Consolidated Unix File Archive (.tgz, .tar.gz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/tgz).

```csharp
public static readonly FileType TGZ;
```

### TIF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tif.md

#### FileType.TIF field

Tagged Image File (.tif) 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 FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tiff.md

#### FileType.TIFF field

Tagged Image File Format (.tiff) 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 FileType TIFF;
```

### ToString
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### TSV
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tsv.md

#### FileType.TSV field

Tab Separated Values File (.tsv) 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 FileType TSV;
```

### TXT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/txt.md

#### FileType.TXT field

Plain Text File (.txt) 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 FileType TXT;
```

### TXZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/txz.md

#### FileType.TXZ field

Consolidated Unix File Archive (.txz, .tar.xz) are archives created with Unix-based utility for collecting one or more files. Learn more about this file format [here](https://fileinfo.com/extension/txz).

```csharp
public static readonly FileType TXZ;
```

### Tzst
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/tzst.md

#### FileType.Tzst field

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

```csharp
public static readonly FileType Tzst;
```

### Unknown
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vb.md

#### FileType.VB field

Visual Basic Project Item File (.vb) is a source code file created in Visual Basic language that was created by Microsoft for development of .NET applications. Learn more about this file format [here](https://wiki.fileformat.com/programming/vb).

```csharp
public static readonly FileType VB;
```

### VCF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vcf.md

#### FileType.VCF field

vCard File (.vcf) 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 FileType VCF;
```

### VDW
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vdw.md

#### FileType.VDW field

Visio Web Drawing (.vdw) represents 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 FileType VDW;
```

### VDX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vdx.md

#### FileType.VDX field

Visio Drawing XML File (.vdx) represents 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 FileType VDX;
```

### VIM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vim.md

#### FileType.VIM field

Vim Settings File (.vim)

```csharp
public static readonly FileType VIM;
```

### VSD
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vsd.md

#### FileType.VSD field

Visio Drawing File (.vsd) 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 FileType VSD;
```

### VSDM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vsdm.md

#### FileType.VSDM field

Visio Macro-Enabled Drawing (.vsdm) 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 FileType VSDM;
```

### VSDX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vsdx.md

#### FileType.VSDX field

Visio Drawing (.vsdx) represents 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 FileType VSDX;
```

### VSS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vss.md

#### FileType.VSS field

Visio Stencil File(.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 FileType VSS;
```

### VSSM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vssm.md

#### FileType.VSSM field

Visio Macro-Enabled Stencil File (.vssm) 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 FileType VSSM;
```

### VSSX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vssx.md

#### FileType.VSSX field

Visio Stencil File (.vssx) 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 FileType VSSX;
```

### VST
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vst.md

#### FileType.VST field

Visio Drawing Template (.vst) 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 FileType VST;
```

### VSTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vstm.md

#### FileType.VSTM field

Visio Macro-Enabled Drawing Template (.vstm) 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 FileType VSTM;
```

### VSTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vstx.md

#### FileType.VSTX field

Visio Drawing Template (.vstx) 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 FileType VSTX;
```

### VSX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vsx.md

#### FileType.VSX field

Visio Stencil XML File (.vsx) refers 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 FileType VSX;
```

### VTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/vtx.md

#### FileType.VTX field

Visio Template XML File (.vtx) 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 FileType VTX;
```

### WEBP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/webp.md

#### FileType.WEBP field

WebP Image (.webp) 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 FileType WEBP;
```

### WMF
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/wmf.md

#### FileType.WMF field

Windows Metafile (.wmf) represents 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 FileType WMF;
```

### WMZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/wmz.md

#### FileType.WMZ field

Compressed Windows Metafile (.wmz) represents Microsoft Windows Metafile (WMF) compressed in GZIP archvive - for storing vector as well as bitmap-format images data. Learn more about this file format [here](https://fileinfo.com/extension/wmz#compressed_windows_metafile).

```csharp
public static readonly FileType WMZ;
```

### XLAM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xlam.md

#### FileType.XLAM field

Microsoft Excel Add-in (.xlam)

```csharp
public static readonly FileType XLAM;
```

### XLS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xls.md

#### FileType.XLS field

Excel Spreadsheet (.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 FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xlsb.md

#### FileType.XLSB field

Excel Binary Spreadsheet (.xlsb) 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 FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xlsm.md

#### FileType.XLSM field

Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreasheet files that support macros. Learn more about this file format [here](https://wiki.fileformat.com/spreadsheet/xlsm).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xlsx.md

#### FileType.XLSX field

Microsoft Excel Open XML Spreadsheet (.xlsx) is a 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 FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xlt.md

#### FileType.XLT field

Microsoft Excel Template (.xlt) 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 FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xltm.md

#### FileType.XLTM field

Microsoft Excel Macro-Enabled Template (.xltm) 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 FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xltx.md

#### FileType.XLTX field

Excel Open XML Spreadsheet Template (.xltx) 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 FileType XLTX;
```

### XML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xml.md

#### FileType.XML field

XML File (.xml). GroupDocs.Viewer has a special processor for handling the XML files, see [documentation](https://docs.groupdocs.com/viewer/net/render-xml-documents/).

```csharp
public static readonly FileType XML;
```

### XPS
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xps.md

#### FileType.XPS field

XML Paper Specification File (.xps) 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 FileType XPS;
```

### XZ
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/xz.md

#### FileType.XZ field

XZ file (.xz) is archive compressed a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here](https://fileinfo.com/extension/xz).

```csharp
public static readonly FileType XZ;
```

### YAML
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/yaml.md

#### FileType.YAML field

YAML Document (.yaml)

```csharp
public static readonly FileType YAML;
```

### ZIP
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/zip.md

#### FileType.ZIP field

Zipped File (.zip) represents archives that can hold one or more files or directories. Learn more about this file format [here](https://wiki.fileformat.com/compression/zip).

```csharp
public static readonly FileType ZIP;
```

### Zstandard
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/filetype/zstandard.md

#### FileType.Zstandard field

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. ZST files can be used to compress different types of files such as databases, file systems, networks, and games. Learn more about this file format [here](https://docs.fileformat.com/compression/zst/).

```csharp
public static readonly FileType Zstandard;
```

### IAuxDisposable
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/iauxdisposable.md

#### IAuxDisposable interface

Expands the standard IDisposable interface, allows to obtain a current state of an object and subscribe to disposing event

```csharp
public interface IAuxDisposable : IDisposable
```

#### Properties

| Name | Description |
| --- | --- |
| IsDisposed { get; } | Indicates whether a resource is already disposed (`true`) or not (`false`) |

#### Events

| Name | Description |
| --- | --- |
| event Disposed | Occurs when object is disposed, right after the resources disposing is successfully completed |

### Disposed
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/iauxdisposable/disposed.md

#### IAuxDisposable.Disposed event

Occurs when object is disposed, right after the resources disposing is successfully completed

```csharp
public event EventHandler Disposed;
```

### IsDisposed
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/iauxdisposable/isdisposed.md

#### IAuxDisposable.IsDisposed property

Indicates whether a resource is already disposed (`true`) or not (`false`)

```csharp
public bool IsDisposed { get; }
```

### License
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/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
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/license/license.md

#### License constructor

The default constructor.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/license/setlicense.md

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream licenseStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | Stream | The license stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *licenseStream* is null. |

##### Examples

The following example demonstrates how to set a license passing Stream of the license file.

```csharp
using (FileStream licenseStream = File.OpenRead("GroupDocs.Viewer.lic"))
{
    License license = new License();
    license.SetLicense(licenseStream);
}
```

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string licensePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | String | The license file path. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *licensePath* is null or empty string. |

##### Examples

The following example demonstrates how to set a license passing a path to the license file.

```csharp
string licensePath = "GroupDocs.Viewer.lic";
License license = new License();
license.SetLicense(licensePath);
```

### Metered
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/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. |

### GetConsumptionCredit
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/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/viewer/net/groupdocs.viewer/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/viewer/net/groupdocs.viewer/metered/metered.md

#### Metered constructor

The default constructor.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/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);
```

### Viewer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer.md

#### Viewer class

Represents main class that controls document rendering process.

```csharp
public class Viewer : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Viewer(Func&lt;Stream&gt;) | Initializes new instance of `Viewer` class. |
| Viewer(Stream) | Initializes new instance of `Viewer` class. |
| Viewer(string) | Initializes new instance of `Viewer` class. |
| Viewer(Func&lt;Stream&gt;, Func&lt;LoadOptions&gt;) | Initializes new instance of `Viewer` class. |
| Viewer(Func&lt;Stream&gt;, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, bool) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, LoadOptions) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(string, LoadOptions) | Initializes new instance of `Viewer` class. |
| Viewer(string, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(Func&lt;Stream&gt;, Func&lt;LoadOptions&gt;, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, LoadOptions, bool) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, LoadOptions, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, ViewerSettings, bool) | Initializes new instance of `Viewer` class. |
| Viewer(string, LoadOptions, ViewerSettings) | Initializes new instance of `Viewer` class. |
| Viewer(Stream, LoadOptions, ViewerSettings, bool) | Initializes new instance of `Viewer` class. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Releases file stream and managed internal resources. |
| GetAllFonts() | Returns all fonts, used in the loaded documents, including those, which are embedded inside the document itself and those system fonts, which are installed in the OS and used in the document |
| GetAttachments() | Returns attachments contained by the document. |
| GetAttachments(CancellationToken) | Returns attachments contained by the document. |
| GetFileInfo() | Returns information about file such as file-type and flag that indicates if file is encrypted. |
| GetViewInfo(ViewInfoOptions) | Returns information about view and document specific information. |
| GetViewInfo(ViewInfoOptions, CancellationToken) | Returns information about view and document specific information. |
| SaveAttachment(Attachment, Stream) | Saves attachment file to *destination* stream. |
| SaveAttachment(Attachment, Stream, CancellationToken) | Saves attachment file to *destination* stream. |
| Search(SearchHighlightOptions) | Performs a text search and its highlighting (if found) in the loaded document according to the loaded options |
| View(ViewOptions) | Creates view of all document pages. |
| View(ViewOptions, CancellationToken) | Creates view of all document pages. |
| View(ViewOptions, params int[]) | Creates view of specific document pages. |
| View(ViewOptions, CancellationToken, params int[]) | Creates view of specific document pages. |

### Dispose
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/dispose.md

#### Viewer.Dispose method

Releases file stream and managed internal resources.

```csharp
public void Dispose()
```

### GetAllFonts
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/getallfonts.md

#### Viewer.GetAllFonts method

Returns all fonts, used in the loaded documents, including those, which are embedded inside the document itself and those system fonts, which are installed in the OS and used in the document

```csharp
public IFontInfo[] GetAllFonts()
```

##### Return Value

Non-null list of all fonts used in the document, loaded into this `Viewer` instance

##### Remarks

For details, see the [documentation](https://docs.groupdocs.com/viewer/net/getting-used-fonts/).

### GetAttachments
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/getattachments.md

#### GetAttachments()

Returns attachments contained by the document.

```csharp
public IList<Attachment> GetAttachments()
```

##### Return Value

Attachments contained by the document.

##### Exceptions

| exception | condition |
| --- | --- |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |

#### GetAttachments(CancellationToken)

Returns attachments contained by the document.

```csharp
public IList<Attachment> GetAttachments(CancellationToken cancellationToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cancellationToken | CancellationToken | Cancellation token. |

##### Return Value

Attachments contained by the document.

##### Exceptions

| exception | condition |
| --- | --- |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |

### GetFileInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/getfileinfo.md

#### Viewer.GetFileInfo method

Returns information about file such as file-type and flag that indicates if file is encrypted.

```csharp
public FileInfo GetFileInfo()
```

##### Return Value

The file information.

### GetViewInfo
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/getviewinfo.md

#### GetViewInfo(ViewInfoOptions)

Returns information about view and document specific information.

```csharp
public ViewInfo GetViewInfo(ViewInfoOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewInfoOptions | The view info options. |

##### Return Value

Information about view and document specific information.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |

#### GetViewInfo(ViewInfoOptions, CancellationToken)

Returns information about view and document specific information.

```csharp
public ViewInfo GetViewInfo(ViewInfoOptions options, CancellationToken cancellationToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewInfoOptions | The view info options. |
| cancellationToken | CancellationToken | Cancellation token. |

##### Return Value

Information about view and document specific information.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |

### SaveAttachment
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/saveattachment.md

#### SaveAttachment(Attachment, Stream, CancellationToken)

Saves attachment file to *destination* stream.

```csharp
public void SaveAttachment(Attachment attachment, Stream destination, 
    CancellationToken cancellationToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attachment | Attachment | The attachment. |
| destination | Stream | The writable stream. |
| cancellationToken | CancellationToken | Cancellation token. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *attachment* is null. |
| ArgumentNullException | Thrown when *destination* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

#### SaveAttachment(Attachment, Stream)

Saves attachment file to *destination* stream.

```csharp
public void SaveAttachment(Attachment attachment, Stream destination)
```

| Parameter | Type | Description |
| --- | --- | --- |
| attachment | Attachment | The attachment. |
| destination | Stream | The writable stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *attachment* is null. |
| ArgumentNullException | Thrown when *destination* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

### Search
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/search.md

#### Viewer.Search method

Performs a text search and its highlighting (if found) in the loaded document according to the loaded options

```csharp
public void Search(SearchHighlightOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | SearchHighlightOptions | Search and highlight options, this includes a text phrase to search. Cannot be `null`. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Is thrown when the *options* argument is `null` |

### View
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/view.md

#### View(ViewOptions)

Creates view of all document pages.

```csharp
public void View(ViewOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

#### View(ViewOptions, CancellationToken)

Creates view of all document pages.

```csharp
public void View(ViewOptions options, CancellationToken cancellationToken)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |
| cancellationToken | CancellationToken | Cancellation token to send a request to cancel current view process. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

#### View(ViewOptions, params int[])

Creates view of specific document pages.

```csharp
public void View(ViewOptions options, params int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |
| pageNumbers | Int32[] | The page numbers to view. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| ArgumentNullException | Thrown when *pageNumbers* is null. |
| ArgumentException | Thrown when *pageNumbers* is empty. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

#### View(ViewOptions, CancellationToken, params int[])

Creates view of specific document pages.

```csharp
public void View(ViewOptions options, CancellationToken cancellationToken, params int[] pageNumbers)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |
| pageNumbers | CancellationToken | The page numbers to view. |
| cancellationToken | Int32[] | Cancellation token to cancel processing. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *options* is null. |
| ArgumentNullException | Thrown when *pageNumbers* is null. |
| ArgumentException | Thrown when *pageNumbers* is empty. |
| PasswordRequiredException | Thrown when password is required to open the document. |
| IncorrectPasswordException | Thrown when password that was specified is incorrect. |
| GroupDocsViewerException | Thrown when attachment could not be found. |

### Viewer
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewer/viewer.md

#### Viewer(Func&lt;Stream&gt;)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Func<Stream> getFileStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |

#### Viewer(Func&lt;Stream&gt;, Func&lt;LoadOptions&gt;)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Func<Stream> getFileStream, Func<LoadOptions> getLoadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| getLoadOptions | Func`1 | The methods that returns document load options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *getLoadOptions* is null. |

#### Viewer(Func&lt;Stream&gt;, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Func<Stream> getFileStream, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(Func&lt;Stream&gt;, Func&lt;LoadOptions&gt;, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Func<Stream> getFileStream, Func<LoadOptions> getLoadOptions, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| getFileStream | Func`1 | The method that returns readable stream. |
| getLoadOptions | Func`1 | The methods that returns document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *getFileStream* is null. |
| ArgumentNullException | Thrown when *getLoadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(Stream)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |

#### Viewer(Stream, bool)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, bool leaveOpen)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| leaveOpen | Boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |

#### Viewer(Stream, LoadOptions)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| loadOptions | LoadOptions | The document load options. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Viewer(Stream, LoadOptions, bool)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, LoadOptions loadOptions, bool leaveOpen)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| leaveOpen | Boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Viewer(Stream, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(Stream, ViewerSettings, bool)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, ViewerSettings settings, bool leaveOpen)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | Boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(Stream, LoadOptions, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, LoadOptions loadOptions, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(Stream, LoadOptions, ViewerSettings, bool)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(Stream stream, LoadOptions loadOptions, ViewerSettings settings, bool leaveOpen)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | Boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *stream* is null. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(string)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file to render. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePath* is null or empty. |

#### Viewer(string, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(string filePath, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file to render. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *settings* is null. |

#### Viewer(string, LoadOptions)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(string filePath, LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file to render. |
| loadOptions | LoadOptions | The options that used to open the file. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *loadOptions* is null. |

#### Viewer(string, LoadOptions, ViewerSettings)

Initializes new instance of `Viewer` class.

```csharp
public Viewer(string filePath, LoadOptions loadOptions, ViewerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the file to render. |
| loadOptions | LoadOptions | The options that used to open the file. |
| settings | ViewerSettings | The Viewer settings. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *filePath* is null or empty. |
| ArgumentNullException | Thrown when *loadOptions* is null. |
| ArgumentNullException | Thrown when *settings* is null. |

### ViewerSettings
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewersettings.md

#### ViewerSettings class

Defines settings for customizing `Viewer` behaviour.

```csharp
public class ViewerSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| ViewerSettings(ICache) | Initializes new instance of `ViewerSettings` class. |
| ViewerSettings(ILogger) | Initializes new instance of `ViewerSettings` class. |
| ViewerSettings(ICache, ILogger) | Initializes new instance of `ViewerSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| Cache { get; } | The cache implementation used for storing rendering results. |
| Logger { get; } | The logger implementation used for logging (Errors, Warnings, Traces). |

### Cache
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewersettings/cache.md

#### ViewerSettings.Cache property

The cache implementation used for storing rendering results.

```csharp
public ICache Cache { get; }
```

### Logger
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewersettings/logger.md

#### ViewerSettings.Logger property

The logger implementation used for logging (Errors, Warnings, Traces).

```csharp
public ILogger Logger { get; }
```

### ViewerSettings
Path: https://reference.groupdocs.com/viewer/net/groupdocs.viewer/viewersettings/viewersettings.md

#### ViewerSettings(ICache, ILogger)

Initializes new instance of `ViewerSettings` class.

```csharp
public ViewerSettings(ICache cache, ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cache | ICache | The cache. |
| logger | ILogger | The logger. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *cache* is null. |

#### ViewerSettings(ICache)

Initializes new instance of `ViewerSettings` class.

```csharp
public ViewerSettings(ICache cache)
```

| Parameter | Type | Description |
| --- | --- | --- |
| cache | ICache | The cache. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *cache* is null. |

#### ViewerSettings(ILogger)

Initializes new instance of `ViewerSettings` class.

```csharp
public ViewerSettings(ILogger logger)
```

| Parameter | Type | Description |
| --- | --- | --- |
| logger | ILogger | The logger. |

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentNullException | Thrown when *logger* is null. |

## Node.js

### GroupDocs.Viewer for Node.js via Java
Path: https://reference.groupdocs.com/viewer/nodejs-java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.viewer | The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results. |
| com.groupdocs.viewer.caching | The package provides classes for customizing caching behavior. |
| com.groupdocs.viewer.caching.extra | The package provides functionality for using custom models in cache implementation. |
| com.groupdocs.viewer.exception | The package provides classes for exceptions that can occur while working with a document. |
| com.groupdocs.viewer.fonts | The package provides classes and enumerations to manage fonts used during the rendering process. |
| com.groupdocs.viewer.interfaces | The package provides interfaces for instantiating and releasing the output document and its resources. |
| com.groupdocs.viewer.logging | The package provides classes for configuring the logging system in GroupDocs.Viewer. |
| com.groupdocs.viewer.options | The package provides classes to specify additional options when rendering documents. |
| com.groupdocs.viewer.results | The package provides classes and interfaces that represent document rendering results. |
| com.groupdocs.viewer.utils | The package provides helper and utility classes for various functionalities. |

### com.groupdocs.viewer.caching.extra
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching.extra.md

The package provides functionality for using custom models in cache implementation.

The main class in this package is CacheableFactory, which helps in customizing the cache by providing additional functionality.

For more details on using custom models in cache implementation in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| CacheableFactory | This class helps customize Cache. |

### CacheableFactory
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching.extra/cacheablefactory.md

**Inheritance:**
java.lang.Object
```
public class CacheableFactory
```

This class helps customize Cache.

Custom models for serialization can be implemented by overriding methods in this class to return them instead of the embedded ones. To achieve this, extend CacheableFactory and activate it passing new instance of custom factory to setInstance(CacheableFactory) method.

Example usage:

```

 CacheableFactory.setInstance(new YourCustomCacheableFactory());
 // Custom cacheable factory is now in use. You can start rendering documents.
 
```

For more details, guidelines, and examples on customizing the cache, please refer to the [GroupDocs.Viewer documentation][].

[GroupDocs.Viewer documentation]: https://docs.groupdocs.com/viewer/java/getting-started/
#### Constructors

| Constructor | Description |
| --- | --- |
| CacheableFactory() |  |
#### Methods

| Method | Description |
| --- | --- |
| getInstance() | Gets an instance of  CacheableFactory  that can be used to create cacheable objects. |
| setInstance(CacheableFactory instance) | Sets the instance of  CacheableFactory  to be used. |
| newViewInfo(FileType fileType, List<Page> pages) | Creates an implementation of the ViewInfo interface for the specified file type and pages. |
| newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount) | Creates an implementation of the LotusNotesViewInfo interface for the specified file type, pages, and notes count. |
| newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders) | Creates an implementation of the ArchiveViewInfo interface for the specified file type, pages, and folders. |
| newCharacter(char character, double x, double y, double width, double height) | Creates an implementation of the Character interface for the specified character, position, and dimensions. |
| newFileInfo(FileType fileType) | Creates an implementation of the FileInfo interface for the specified file type. |
| newLayer(String name, boolean visible) | Creates an implementation of the Layer interface with the specified name and visibility. |
| newLayer(String name) | Creates an implementation of the Layer interface with the specified name. |
| newLayout(String name, double width, double height) | Creates an implementation of the Layout interface with the specified name, width, and height. |
| newLine(String line, double x, double y, double width, double height, List<Word> words) | Creates an implementation of the Line interface with the specified line, position, dimensions, and words. |
| newAttachment(String fileName, String filePath) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, String filePath, long size) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, Path filePath, long size) | Creates an implementation of the Attachment interface. |
| newAttachment(String id, String fileName, String filePath, FileType fileType, long size) | Creates an implementation of the Attachment interface. |
| newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders) | Creates an implementation of the OutlookViewInfo interface based on the specified file type, list of pages, and list of folders. |
| newPage(int number, boolean visible) | Creates an implementation of the Page interface representing a page with the specified number and visibility. |
| newPage(int number, String name, boolean visible) | Creates an implementation of the Page interface representing a page with the specified number, name, and visibility. |
| newPage(int number, String name, boolean visible, int width, int height) | Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, and height. |
| newPage(int number, boolean visible, int width, int height) | Creates an implementation of the Page interface representing a page with the specified number, visibility, width, and height. |
| newPage(int number, String name, boolean visible, int width, int height, List<Line> lines) | Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, height, and lines. |
| newPage(int number, boolean visible, int width, int height, List<Line> lines) | Creates an implementation of the Page interface representing a page with the specified number, visibility, width, height, and lines. |
| newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed) | Creates an implementation of the PdfViewInfo interface with the specified file type, pages, and printing allowed flag. |
| newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts) | Creates an implementation of the CadViewInfo interface with the specified file type, pages, layers, and layouts. |
| newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate) | Creates an implementation of the ProjectManagementViewInfo interface with the specified file type, pages, start date, and end date. |
| <T>newTextElement(T value, double x, double y, double width, double height) | Creates an implementation of the TextElement interface with the specified value, coordinates, and dimensions. |
| newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount) | Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count. |
| newWord(String word, double x, double y, double width, double height, List<Character> characters) | Creates an implementation of the Word interface with the specified word, coordinates, dimensions, and characters. |
##### CacheableFactory()
```
public CacheableFactory()
```

##### getInstance()
```
public static CacheableFactory getInstance()
```

Gets an instance of  CacheableFactory  that can be used to create cacheable objects.

**Returns:**
CacheableFactory - an instance of  CacheableFactory .
##### setInstance(CacheableFactory instance)
```
public static void setInstance(CacheableFactory instance)
```

Sets the instance of  CacheableFactory  to be used. This allows custom implementation of the cacheable factory.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| instance | CacheableFactory | The instance of  CacheableFactory  to set. |

##### newViewInfo(FileType fileType, List<Page> pages)
```
public ViewInfo newViewInfo(FileType fileType, List<Page> pages)
```

Creates an implementation of the ViewInfo interface for the specified file type and pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |

**Returns:**
ViewInfo - a new instance of the ViewInfo implementation.
##### newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount)
```
public LotusNotesViewInfo newLotusNotesViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

Creates an implementation of the LotusNotesViewInfo interface for the specified file type, pages, and notes count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |
| notesCount | int | The count of Lotus Notes in the document. |

**Returns:**
LotusNotesViewInfo - a new instance of the LotusNotesViewInfo implementation.
##### newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```
public ArchiveViewInfo newArchiveViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```

Creates an implementation of the ArchiveViewInfo interface for the specified file type, pages, and folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages representing the document pages. |
| folders | java.util.List<java.lang.String> | The list of folders in the archive. |

**Returns:**
ArchiveViewInfo - a new instance of the ArchiveViewInfo implementation.
##### newCharacter(char character, double x, double y, double width, double height)
```
public Character newCharacter(char character, double x, double y, double width, double height)
```

Creates an implementation of the Character interface for the specified character, position, and dimensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| character | char | The character. |
| x | double | The x-coordinate of the character position. |
| y | double | The y-coordinate of the character position. |
| width | double | The width of the character. |
| height | double | The height of the character. |

**Returns:**
Character - a new instance of the Character implementation.
##### newFileInfo(FileType fileType)
```
public FileInfo newFileInfo(FileType fileType)
```

Creates an implementation of the FileInfo interface for the specified file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

**Returns:**
FileInfo - a new instance of the FileInfo implementation.
##### newLayer(String name, boolean visible)
```
public Layer newLayer(String name, boolean visible)
```

Creates an implementation of the Layer interface with the specified name and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layer. |
| visible | boolean | The visibility of the layer. |

**Returns:**
Layer - a new instance of the Layer implementation.
##### newLayer(String name)
```
public Layer newLayer(String name)
```

Creates an implementation of the Layer interface with the specified name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layer. |

**Returns:**
Layer - a new instance of the Layer implementation.
##### newLayout(String name, double width, double height)
```
public Layout newLayout(String name, double width, double height)
```

Creates an implementation of the Layout interface with the specified name, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name of the layout. |
| width | double | The width of the layout. |
| height | double | The height of the layout. |

**Returns:**
Layout - a new instance of the Layout implementation.
##### newLine(String line, double x, double y, double width, double height, List<Word> words)
```
public Line newLine(String line, double x, double y, double width, double height, List<Word> words)
```

Creates an implementation of the Line interface with the specified line, position, dimensions, and words.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| line | java.lang.String | The line content. |
| x | double | The X coordinate of the top-left point of the rectangle that contains the line. |
| y | double | The Y coordinate of the top-left point of the rectangle that contains the line. |
| width | double | The width of the rectangle that contains the line (in pixels). |
| height | double | The height of the rectangle that contains the line (in pixels). |
| words | java.util.List<com.groupdocs.viewer.results.Word> | The words contained in the line. |

**Returns:**
Line - a new instance of the Line implementation.
##### newAttachment(String fileName, String filePath)
```
public Attachment newAttachment(String fileName, String filePath)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, String filePath, long size)
```
public Attachment newAttachment(String id, String fileName, String filePath, long size)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative path of the attachment, e.g., "folder/file.docx". When the file is located in the root of an archive, in an email message, or a data file, specify the filename. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, Path filePath, long size)
```
public Attachment newAttachment(String id, String fileName, Path filePath, long size)
```

Creates an implementation of the Attachment interface.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.nio.file.Path | The relative or absolute path of the attachment. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newAttachment(String id, String fileName, String filePath, FileType fileType, long size)
```
public Attachment newAttachment(String id, String fileName, String filePath, FileType fileType, long size)
```

Creates an implementation of the Attachment interface. The attachment represents a file attached to a document or an email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | The ID of the attachment. |
| fileName | java.lang.String | The name of the attachment. |
| filePath | java.lang.String | The relative or absolute path of the attachment. It can be a file path within a folder or the filename itself if the file is located in the root of an archive, in an email message, or in a data file. |
| fileType | FileType | The type of the attachment file. |
| size | long | The size of the attachment. |

**Returns:**
Attachment - a new instance of the Attachment implementation.
##### newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```
public OutlookViewInfo newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders)
```

Creates an implementation of the OutlookViewInfo interface based on the specified file type, list of pages, and list of folders.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| folders | java.util.List<java.lang.String> | The list of folders. |

**Returns:**
OutlookViewInfo - a new instance of the OutlookViewInfo implementation.
##### newPage(int number, boolean visible)
```
public Page newPage(int number, boolean visible)
```

Creates an implementation of the Page interface representing a page with the specified number and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible)
```
public Page newPage(int number, String name, boolean visible)
```

Creates an implementation of the Page interface representing a page with the specified number, name, and visibility.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible, int width, int height)
```
public Page newPage(int number, String name, boolean visible, int width, int height)
```

Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, boolean visible, int width, int height)
```
public Page newPage(int number, boolean visible, int width, int height)
```

Creates an implementation of the Page interface representing a page with the specified number, visibility, width, and height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, String name, boolean visible, int width, int height, List<Line> lines)
```
public Page newPage(int number, String name, boolean visible, int width, int height, List<Line> lines)
```

Creates an implementation of the Page interface representing a page with the specified number, name, visibility, width, height, and lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| name | java.lang.String | The page name. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | The lines contained in the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPage(int number, boolean visible, int width, int height, List<Line> lines)
```
public Page newPage(int number, boolean visible, int width, int height, List<Line> lines)
```

Creates an implementation of the Page interface representing a page with the specified number, visibility, width, height, and lines.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | The page number. |
| visible | boolean | The visibility flag. |
| width | int | The width of the page. |
| height | int | The height of the page. |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | The lines contained in the page. |

**Returns:**
Page - a new instance of the Page implementation.
##### newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed)
```
public PdfViewInfo newPdfViewInfo(FileType fileType, List<Page> pages, boolean printingAllowed)
```

Creates an implementation of the PdfViewInfo interface with the specified file type, pages, and printing allowed flag.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| printingAllowed | boolean | The flag indicating whether printing is allowed. |

**Returns:**
PdfViewInfo - a new instance of the PdfViewInfo implementation.
##### newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts)
```
public CadViewInfo newCadViewInfo(FileType fileType, List<Page> pages, List<Layer> layers, List<Layout> layouts)
```

Creates an implementation of the CadViewInfo interface with the specified file type, pages, layers, and layouts.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| layers | java.util.List<com.groupdocs.viewer.results.Layer> | The list of layers. |
| layouts | java.util.List<com.groupdocs.viewer.results.Layout> | The list of layouts. |

**Returns:**
CadViewInfo - a new instance of the CadViewInfo implementation.
##### newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate)
```
public ProjectManagementViewInfo newProjectManagementViewInfo(FileType fileType, List<Page> pages, Date startDate, Date endDate)
```

Creates an implementation of the ProjectManagementViewInfo interface with the specified file type, pages, start date, and end date.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages. |
| startDate | java.util.Date | The start date. |
| endDate | java.util.Date | The end date. |

**Returns:**
ProjectManagementViewInfo - a new instance of the ProjectManagementViewInfo implementation.
##### <T>newTextElement(T value, double x, double y, double width, double height)
```
public TextElement<T> <T>newTextElement(T value, double x, double y, double width, double height)
```

Creates an implementation of the TextElement interface with the specified value, coordinates, and dimensions.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | T | The value. |
| x | double | The X coordinate. |
| y | double | The Y coordinate. |
| width | double | The width. |
| height | double | The height. |

**Returns:**
TextElement - a new instance of the TextElement implementation.
##### newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount)
```
public MboxViewInfo newMboxViewInfo(FileType fileType, List<Page> pages, int notesCount)
```

Creates an implementation of the MboxViewInfo interface with the specified file type, pages, and notes count.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file. |
| pages | java.util.List<com.groupdocs.viewer.results.Page> | The list of pages to view. |
| notesCount | int | The notes count contained by the Lotus database storage file. |

**Returns:**
com.groupdocs.viewer.results.MboxViewInfo - a new instance of the MboxViewInfo implementation.
##### newWord(String word, double x, double y, double width, double height, List<Character> characters)
```
public Word newWord(String word, double x, double y, double width, double height, List<Character> characters)
```

Creates an implementation of the Word interface with the specified word, coordinates, dimensions, and characters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| word | java.lang.String | The word. |
| x | double | The X coordinate of the highest left point on the page layout where the rectangle that contains the word begins. |
| y | double | The Y coordinate of the highest left point on the page layout where the rectangle that contains the word begins. |
| width | double | The width of the rectangle which contains the word (in pixels). |
| height | double | The height of the rectangle which contains the word (in pixels). |
| characters | java.util.List<com.groupdocs.viewer.results.Character> | The characters contained by the word. |

**Returns:**
Word - a new instance of the Word implementation.

### com.groupdocs.viewer.caching
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching.md

The package provides classes for customizing caching behavior.

The main classes and interfaces in this package are:

 *  CacheKeys - Provides methods to retrieve unique identifiers for the cache entry.
 *  FileCache - Represents a local on-disk cache.

The Cache interface defines methods required for storing rendered documents and document resources in the cache.

For more details on customizing caching behavior in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| CacheKeys | Provides methods to retrieve the unique identifier for a cache entry. |
| FileCache | Represents a local on-disk cache. |

#### Interfaces

| Interface | Description |
| --- | --- |
| Cache | Defines methods required for storing rendered documents and document resources cache. |

### Cache
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching/cache.md

### CacheKeys
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching/cachekeys.md

**Inheritance:**
java.lang.Object
```
public class CacheKeys
```

Provides methods to retrieve the unique identifier for a cache entry.

The class allows you to generate cache keys based on different parameters, such as the document path, rendering options, and resource name. These cache keys can be used to store and retrieve cached data for efficient document rendering.

Example usage:

```

 // Generate a cache key for a file
 String fileKey = CacheKeys.getFileKey("filename.pdf");

 // Generate a cache key for a page
 String pageKey = CacheKeys.getPageKey(pageNumber, FileType.HTML.getExtension());

 // Generate a cache key for a resource
 Resource resource = new Resource("styles.css", false);
 String pageKey = CacheKeys.getResourceKey(pageNumber, resource);
 
```
#### Fields

| Field | Description |
| --- | --- |
| PAGE_NUMBER |  |
#### Methods

| Method | Description |
| --- | --- |
| getAttachmentsKey() | Returns the unique identifier for the cache entry that represents a collection of Attachment objects. |
| getAttachmentKey(String attachmentId) | Retrieves the unique identifier for the cache entry representing an attachment file. |
| getViewInfoKey() | Retrieves the unique identifier for the cache entry that represents a ViewInfo object. |
| getFileInfoKey() | Retrieves the unique identifier for the cache entry that represents a ViewInfo object. |
| getFileKey(String extension) | Retrieves the unique identifier for the cache entry that represents a file. |
| getPageKey(int pageNumber, String extension) | Retrieves the unique identifier for the cache entry that represents a page file. |
| getResourceKey(int pageNumber, Resource resource) | Returns a unique identifier for the cache entry that represents a Resource object. |
| getResourceFilter(int pageNumber) | Returns a filter string to search for cache entries that represent Resource objects. |
##### PAGE_NUMBER
```
public static final String PAGE_NUMBER
```

##### getAttachmentsKey()
```
public static String getAttachmentsKey()
```

Returns the unique identifier for the cache entry that represents a collection of Attachment objects.

**Returns:**
java.lang.String - the unique identifier for the attachments cache entry.
##### getAttachmentKey(String attachmentId)
```
public static String getAttachmentKey(String attachmentId)
```

Retrieves the unique identifier for the cache entry representing an attachment file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attachmentId | java.lang.String | The unique identifier of the attachment (in the context of a single file). |

**Returns:**
java.lang.String - the unique identifier for the attachment file cache entry.
##### getViewInfoKey()
```
public static String getViewInfoKey()
```

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

**Returns:**
java.lang.String - the unique identifier for the cache entry.
##### getFileInfoKey()
```
public static String getFileInfoKey()
```

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a ViewInfo object.
##### getFileKey(String extension)
```
public static String getFileKey(String extension)
```

Retrieves the unique identifier for the cache entry that represents a file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". |

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a file.
##### getPageKey(int pageNumber, String extension)
```
public static String getPageKey(int pageNumber, String extension)
```

Retrieves the unique identifier for the cache entry that represents a page file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |
| extension | java.lang.String | The filename suffix (including the period ".") e.g. ".doc". |

**Returns:**
java.lang.String - the unique identifier for the cache entry representing a page file.
##### getResourceKey(int pageNumber, Resource resource)
```
public static String getResourceKey(int pageNumber, Resource resource)
```

Returns a unique identifier for the cache entry that represents a Resource object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |
| resource | Resource | The HTML resource. |

**Returns:**
java.lang.String - the unique identifier for the cache entry.
##### getResourceFilter(int pageNumber)
```
public static String getResourceFilter(int pageNumber)
```

Returns a filter string to search for cache entries that represent Resource objects.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The number of the page. |

**Returns:**
java.lang.String - the filter string to search for cache entries.

### FileCache
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.caching/filecache.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.caching.Cache
```
public class FileCache implements Cache
```

Represents a local on-disk cache.

The FileCache class represents a local on-disk cache in the GroupDocs.Viewer component. It provides functionality to store and retrieve cached data on the disk for efficient document rendering.

Example usage:

```

 FileCache fileCache = new FileCache(cachePath, cacheSubFolder);

 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setCache(fileCache);

 try (Viewer viewer = new Viewer(documentPath, viewerSettings)) {
     // Use the viewer object for document rendering
 }
 
```

To use the FileCache, you need to create an instance of this class and pass it to the ViewerSettings object. The Viewer object will then use the FileCache for caching purposes while rendering documents.

***Note:** The FileCache is just one of the cache implementations provided by GroupDocs.Viewer. You can also implement your own custom cache by implementing the Cache interface.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileCache(String cachePath) | Creates a new instance of the  FileCache  class. |
| FileCache(Path cachePath) | Creates a new instance of the  FileCache  class. |
| FileCache(String cachePath, String cacheSubFolder) | Creates a new instance of the  FileCache  class. |
| FileCache(Path cachePath, String cacheSubFolder) | Creates a new instance of the  FileCache  class. |
#### Fields

| Field | Description |
| --- | --- |
| CACHE_PATH |  |
#### Methods

| Method | Description |
| --- | --- |
| getCachePath() | Gets the relative or absolute path to the cache folder. |
| getCacheSubFolder() | The sub-folder to append to the cache path. |
| set(String key, Object value) | Serializes data to the local disk. |
| <T>get(String key, Class<T> clazz) | Deserializes data associated with this key if present. |
| getKeys(String filter) | Returns all file names that contain the filter in the filename. |
##### FileCache(String cachePath)
```
public FileCache(String cachePath)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. |

##### FileCache(Path cachePath)
```
public FileCache(Path cachePath)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. |

##### FileCache(String cachePath, String cacheSubFolder)
```
public FileCache(String cachePath, String cacheSubFolder)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.lang.String | The relative or absolute path where the document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to  cachePath . |

##### FileCache(Path cachePath, String cacheSubFolder)
```
public FileCache(Path cachePath, String cacheSubFolder)
```

Creates a new instance of the  FileCache  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | The relative or absolute path where the document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to  cachePath . |

##### CACHE_PATH
```
public static final String CACHE_PATH
```

##### getCachePath()
```
public final String getCachePath()
```

Gets the relative or absolute path to the cache folder.

**Returns:**
java.lang.String - Path to the cache folder.
##### getCacheSubFolder()
```
public final String getCacheSubFolder()
```

The sub-folder to append to the cache path.

**Returns:**
java.lang.String - the sub-folder to append.
##### 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 | The unique identifier for the cache entry. |
| value | java.lang.Object | The object to serialize. |

##### <T>get(String key, Class<T> clazz)
```
public final T <T>get(String key, Class<T> clazz)
```

Deserializes data associated with this key if present.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |
| clazz | java.lang.Class<T> | The class of the expected value. |

**Returns:**
T - the located value or null.
##### getKeys(String filter)
```
public final List<String> getKeys(String filter)
```

Returns all file names that contain the filter in the filename.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filter | java.lang.String | The filter to use. |

**Returns:**
java.util.List<java.lang.String> - File names that contain the filter in the filename.

### com.groupdocs.viewer.exception
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception.md

The package provides classes for exceptions that can occur while working with a document.

The main classes in this package are:

 *  com.groupdocs.viewer.exception.ArchiveSecurityException - Thrown when an archive being opened exceeds specified limits.
 *  FileNotFoundException - Represents an exception thrown when a file or directory is not found.
 *  GroupDocsViewerException - Represents generic errors that occur during document processing.

For more details on working with exceptions in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| ArchiveSecurityException | This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions. |
| FileNotFoundException | This exception is thrown when a file or directory is not found. |
| GroupDocsViewerException | This exception represents generic errors that can occur during document processing. |
| IncorrectPasswordException | This exception is thrown when the specified password is incorrect. |
| NotSupportedException | This exception is thrown when the requested operation is not supported. |
| PasswordRequiredException | This exception is thrown when a password is required to load the document. |

### ArchiveSecurityException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/archivesecurityexception.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.viewer.exception.GroupDocsViewerException
```
public class ArchiveSecurityException extends GroupDocsViewerException
```

This exception is thrown when an archive being opened exceeds any of the limits specified in the ArchiveSecurityOptions.
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveSecurityException(String message) | Creates an instance of the  ArchiveSecurityException  class with the specified message. |
##### ArchiveSecurityException(String message)
```
public ArchiveSecurityException(String message)
```

Creates an instance of the  ArchiveSecurityException  class with the specified message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

### FileNotFoundException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/filenotfoundexception.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.viewer.exception.GroupDocsViewerException
```
public class FileNotFoundException extends GroupDocsViewerException
```

This exception is thrown when a file or directory is not found. It indicates that the specified file or directory does not exist or cannot be accessed.
#### Constructors

| Constructor | Description |
| --- | --- |
| FileNotFoundException(String message) | Creates an instance of the FileNotFoundException class with the specified message. |
| FileNotFoundException(Path path) | Initializes a new instance of the FileNotFoundException class with a specified file path. |
| FileNotFoundException(String messageTemplate, Object[] params) | Creates a new instance of the FileNotFoundException class with a specified error message. |
| FileNotFoundException(Throwable cause) | Instantiates a new instance of the FileNotFoundException class. |
| FileNotFoundException(String message, Throwable throwable) | Initializes a new instance of the FileNotFoundException class with a specified error message. |
##### FileNotFoundException(String message)
```
public FileNotFoundException(String message)
```

Creates an instance of the FileNotFoundException class with the specified message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### FileNotFoundException(Path path)
```
public FileNotFoundException(Path path)
```

Initializes a new instance of the FileNotFoundException class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.nio.file.Path | The path of the file that does not exist. |

##### FileNotFoundException(String messageTemplate, Object[] params)
```
public FileNotFoundException(String messageTemplate, Object[] params)
```

Creates a new instance of the FileNotFoundException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| messageTemplate | java.lang.String | The message that describes the error. |
| params | java.lang.Object[] | The parameters that will be set into the error message. |

##### FileNotFoundException(Throwable cause)
```
public FileNotFoundException(Throwable cause)
```

Instantiates a new instance of the FileNotFoundException class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception. |

##### FileNotFoundException(String message, Throwable throwable)
```
public FileNotFoundException(String message, Throwable throwable)
```

Initializes a new instance of the FileNotFoundException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| throwable | java.lang.Throwable | The throwable that caused the exception. |

### GroupDocsViewerException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/groupdocsviewerexception.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 GroupDocsViewerException extends GroupDocsException
```

This exception represents generic errors that can occur during document processing. It is a broad exception that indicates an error or failure, but does not provide specific details about the nature of the error.
#### Constructors

| Constructor | Description |
| --- | --- |
| GroupDocsViewerException(String message) | Initializes a new instance of the GroupDocsViewerException class with a specified error message. |
| GroupDocsViewerException(Throwable cause) | Initializes a new instance of the GroupDocsViewerException class with a cause of the exception. |
| GroupDocsViewerException(String message, Throwable throwable) | Initializes a new instance of the  GroupDocsViewerException  class with a specified error message. |
#### Methods

| Method | Description |
| --- | --- |
| toString() |  |
##### GroupDocsViewerException(String message)
```
public GroupDocsViewerException(String message)
```

Initializes a new instance of the GroupDocsViewerException class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

##### GroupDocsViewerException(Throwable cause)
```
public GroupDocsViewerException(Throwable cause)
```

Initializes a new instance of the GroupDocsViewerException class with a cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cause | java.lang.Throwable | The cause of the exception. |

##### GroupDocsViewerException(String message, Throwable throwable)
```
public GroupDocsViewerException(String message, Throwable throwable)
```

Initializes a new instance of the  GroupDocsViewerException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |
| throwable | java.lang.Throwable | The throwable that caused the exception. |

##### toString()
```
public String toString()
```

**Returns:**
java.lang.String

### IncorrectPasswordException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/incorrectpasswordexception.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.viewer.exception.GroupDocsViewerException
```
public class IncorrectPasswordException extends GroupDocsViewerException
```

This exception is thrown when the specified password is incorrect. This exception is typically thrown when attempting to access or decrypt a protected document with an invalid password.
#### Constructors

| Constructor | Description |
| --- | --- |
| IncorrectPasswordException() | Initializes a new instance of the  IncorrectPasswordException  class. |
| IncorrectPasswordException(String message, Throwable throwable) | Initializes a new instance of the  IncorrectPasswordException  class with a specified error message. |
##### IncorrectPasswordException()
```
public IncorrectPasswordException()
```

Initializes a new instance of the  IncorrectPasswordException  class.

##### IncorrectPasswordException(String message, Throwable throwable)
```
public IncorrectPasswordException(String message, Throwable throwable)
```

Initializes a new instance of the  IncorrectPasswordException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### NotSupportedException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/notsupportedexception.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.viewer.exception.GroupDocsViewerException
```
public class NotSupportedException extends GroupDocsViewerException
```

This exception is thrown when the requested operation is not supported. It indicates that the current operation is not supported by the underlying system or implementation.
#### Constructors

| Constructor | Description |
| --- | --- |
| NotSupportedException(String message) | Initializes a new instance of the  NotSupportedException  class with a specified error message. |
| NotSupportedException(String message, Throwable throwable) | Initializes a new instance of the  NotSupportedException  class with a specified error message and the cause of the exception. |
##### NotSupportedException(String message)
```
public NotSupportedException(String message)
```

Initializes a new instance of the  NotSupportedException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

##### NotSupportedException(String message, Throwable throwable)
```
public NotSupportedException(String message, Throwable throwable)
```

Initializes a new instance of the  NotSupportedException  class with a specified error message and the cause of the exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### PasswordRequiredException
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.exception/passwordrequiredexception.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.viewer.exception.GroupDocsViewerException
```
public class PasswordRequiredException extends GroupDocsViewerException
```

This exception is thrown when a password is required to load the document. This exception typically occurs when attempting to load or open a document that is encrypted or password-protected without providing valid password.
#### Constructors

| Constructor | Description |
| --- | --- |
| PasswordRequiredException() | Initializes a new instance of the  PasswordRequiredException  class. |
| PasswordRequiredException(String message) | Initializes a new instance of the  PasswordRequiredException  class with a custom exception message. |
| PasswordRequiredException(String message, Throwable throwable) | Initializes a new instance of the  PasswordRequiredException  class with a specified error message. |
##### PasswordRequiredException()
```
public PasswordRequiredException()
```

Initializes a new instance of the  PasswordRequiredException  class.

##### PasswordRequiredException(String message)
```
public PasswordRequiredException(String message)
```

Initializes a new instance of the  PasswordRequiredException  class with a custom exception message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String |  |

##### PasswordRequiredException(String message, Throwable throwable)
```
public PasswordRequiredException(String message, Throwable throwable)
```

Initializes a new instance of the  PasswordRequiredException  class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |
| throwable | java.lang.Throwable | The throwable. |

### com.groupdocs.viewer.fonts
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts.md

The package provides classes and enumerations to manage fonts used during the rendering process.

The main classes and interfaces in this package are:

 *  FolderFontSource - Represents a folder that contains TrueType fonts.
 *  FontSettings - Provides methods for working with sources to look for TrueType fonts.
 *  FontSource - Marker interface for the font sources.

For more details on working with fonts in GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| FolderFontSource | Represents a folder that contains TrueType fonts. |
| FontFormat | Represents all font formats, which may be present in the UsedFontInfo class. |
| FontSettings | Provides methods for working with sources to look for TrueType fonts. |
| FontStyles | Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic. |
| PdfFontInfo | Encapsulates meta-information and binary data of one font from a PDF document, loaded into the Viewer instance. |
| PresentationFontInfo | Encapsulates metadata and binary data of a font used in a Presentation document, loaded into the Viewer instance. |
| SpreadsheetFontInfo | Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the Viewer instance. |
| WordProcessingFontInfo | Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the Viewer instance. |
| WordProcessingSubstitutedFontInfo | Encapsulates metadata and binary data of one substituted font used in a WordProcessing document via GroupDocs.Viewer. |

#### Interfaces

| Interface | Description |
| --- | --- |
| FontSource | Marker interface for the font sources. |
| IFontInfo | Common interface for all fonts that can be extracted from document formats: PDF, WordProcessing, Spreadsheet, and Presentation. |

#### Enumerations

| Enum | Description |
| --- | --- |
| SearchOption | Specifies whether to search the current folder, or the current folder and all subfolders. |

### FolderFontSource
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/folderfontsource.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.FontSource, com.aspose.ms.System.IEquatable
```
public final class FolderFontSource implements FontSource, System.IEquatable<FolderFontSource>
```

Represents a folder that contains TrueType fonts.

The FolderFontSource class is used to specify a folder location that contains TrueType fonts. It allows the GroupDocs.Viewer API to access the fonts stored in the specified folder for document rendering purposes.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| FolderFontSource(String folderPath, SearchOption searchOption) | Initializes a new instance of the  FolderFontSource  class. |
#### Methods

| Method | Description |
| --- | --- |
| isEqualTo(FolderFontSource left, FolderFontSource right) | Determines whether two  FolderFontSource  objects are the same. |
| isNotEqualTo(FolderFontSource left, FolderFontSource right) | Determines whether two  FolderFontSource  objects are not the same. |
| getFolderPath() | Gets the path to the folder that contains TrueType fonts. |
| getSearchOption() | Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders. |
| isRecursive() | Checks if the fonts would be searched recursively. |
| equals(FolderFontSource other) | Determines whether the current  FolderFontSource  is the same as the specified  FolderFontSource  object. |
| equals(Object o) | Determines whether the current  FolderFontSource  is the same as the specified object. |
| hashCode() | Returns the hash code for the current  FolderFontSource  object. |
| toString() | Returns a string that represents the current object. |
##### FolderFontSource(String folderPath, SearchOption searchOption)
```
public FolderFontSource(String folderPath, SearchOption searchOption)
```

Initializes a new instance of the  FolderFontSource  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | java.lang.String | Path to the folder that contains TrueType fonts. |
| searchOption | SearchOption | Specifies whether to search the current folder, or the current folder and all sub-folders. |

##### isEqualTo(FolderFontSource left, FolderFontSource right)
```
public static boolean isEqualTo(FolderFontSource left, FolderFontSource right)
```

Determines whether two  FolderFontSource  objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | The left  FolderFontSource  object. |
| right | FolderFontSource | The right  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are the same; otherwise,  false .
##### isNotEqualTo(FolderFontSource left, FolderFontSource right)
```
public static boolean isNotEqualTo(FolderFontSource left, FolderFontSource right)
```

Determines whether two  FolderFontSource  objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FolderFontSource | The left  FolderFontSource  object. |
| right | FolderFontSource | The right  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are not the same; otherwise,  false .
##### getFolderPath()
```
public String getFolderPath()
```

Gets the path to the folder that contains TrueType fonts.

**Returns:**
java.lang.String - the path to the folder that contains TrueType fonts.
##### getSearchOption()
```
public SearchOption getSearchOption()
```

Gets the search option that specifies whether to search the current folder, or the current folder and all subfolders.

**Returns:**
SearchOption - the search option.
##### isRecursive()
```
public boolean isRecursive()
```

Checks if the fonts would be searched recursively.

**Returns:**
boolean -  true  if the fonts would be searched recursively,  false  otherwise.
##### equals(FolderFontSource other)
```
public boolean equals(FolderFontSource other)
```

Determines whether the current  FolderFontSource  is the same as the specified  FolderFontSource  object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FolderFontSource | The object to compare with the current  FolderFontSource  object. |

**Returns:**
boolean -  true  if both  FolderFontSource  objects are the same; otherwise,  false
##### equals(Object o)
```
public boolean equals(Object o)
```

Determines whether the current  FolderFontSource  is the same as the specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with the current  FolderFontSource  object. |

**Returns:**
boolean -  true  if the  obj  parameter is of type  FolderFontSource  and is the same as the current  FolderFontSource  object; otherwise,  false
##### hashCode()
```
public int hashCode()
```

Returns the hash code for the current  FolderFontSource  object.

**Returns:**
int - a hash code for the current  FolderFontSource  object.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - a string that represents the current object.

### FontFormat
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/fontformat.md

**Inheritance:**
java.lang.Object
```
public final class FontFormat
```

Represents all font formats, which may be present in the UsedFontInfo class.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Unknown or invalid font format. |
| TrueType | TrueType font format (TTF). |
| OpenType | OpenType font format (OTF). |
| TrueTypeCollection | TrueType Collection font format (TTC). |
| EmbeddedOpenType | Embedded OpenType font format (EOT). |
#### Methods

| Method | Description |
| --- | --- |
| toString(int format) | Converts a format value to a human-readable string. |
##### Unknown
```
public static final int Unknown
```

Unknown or invalid font format.

##### TrueType
```
public static final int TrueType
```

TrueType font format (TTF).

##### OpenType
```
public static final int OpenType
```

OpenType font format (OTF).

##### TrueTypeCollection
```
public static final int TrueTypeCollection
```

TrueType Collection font format (TTC).

##### EmbeddedOpenType
```
public static final int EmbeddedOpenType
```

Embedded OpenType font format (EOT).

##### toString(int format)
```
public static String toString(int format)
```

Converts a format value to a human-readable string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | int | the font format value |

**Returns:**
java.lang.String - a string representation of the font format

### FontSettings
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/fontsettings.md

**Inheritance:**
java.lang.Object
```
public class FontSettings
```

Provides methods for working with sources to look for TrueType fonts.

The FontSettings class is used to specify and manage sources for locating TrueType fonts. It provides methods to add and reset font sources for the GroupDocs.Viewer API.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| FontSettings() |  |
#### Methods

| Method | Description |
| --- | --- |
| setFontSources(FontSource[] fontSources) | Sets the sources to look for TrueType fonts when rendering documents. |
| resetFontSources() | Resets the font sources that have been set before. |
##### FontSettings()
```
public FontSettings()
```

##### setFontSources(FontSource[] fontSources)
```
public static void setFontSources(FontSource[] fontSources)
```

Sets the sources to look for TrueType fonts when rendering documents.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontSources | FontSource\[\] | The font sources to set. |

##### resetFontSources()
```
public static void resetFontSources()
```

Resets the font sources that have been set before.

### FontSource
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/fontsource.md

### FontStyles
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/fontstyles.md

**Inheritance:**
java.lang.Object
```
public final class FontStyles
```

Represents 4 possible styles of the font, used in the document: Regular, Bold, Italic, or Bold Italic.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontStyles(boolean isBold, boolean isItalic) | Creates a FontStyles instance from bold/italic flags. |
#### Fields

| Field | Description |
| --- | --- |
| Regular |  |
| Bold |  |
| Italic |  |
| BoldItalic |  |
| REGULAR |  |
| BOLD |  |
| ITALIC |  |
| BOLD_ITALIC |  |
#### Methods

| Method | Description |
| --- | --- |
| toString(int style) | Converts a style value to a human-readable string. |
| getName() | Returns readable name of this font style. |
| isBold() | Returns true if bold bit is set. |
| isItalic() | Returns true if italic bit is set. |
| toString() |  |
| equals(Object obj) |  |
| hashCode() |  |
| combine(FontStyles first, FontStyles second) | Union (C\# operator +) |
| subtract(FontStyles minuend, FontStyles subtrahend) | Difference (C\# operator -) |
| tryParse(String style, FontStyles[] parsed) | Parses a font style name to FontStyles. |
##### FontStyles(boolean isBold, boolean isItalic)
```
public FontStyles(boolean isBold, boolean isItalic)
```

Creates a FontStyles instance from bold/italic flags.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isBold | boolean |  |
| isItalic | boolean |  |

##### Regular
```
public static final int Regular
```

##### Bold
```
public static final int Bold
```

##### Italic
```
public static final int Italic
```

##### BoldItalic
```
public static final int BoldItalic
```

##### REGULAR
```
public static final FontStyles REGULAR
```

##### BOLD
```
public static final FontStyles BOLD
```

##### ITALIC
```
public static final FontStyles ITALIC
```

##### BOLD_ITALIC
```
public static final FontStyles BOLD_ITALIC
```

##### toString(int style)
```
public static String toString(int style)
```

Converts a style value to a human-readable string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | int | the font style value |

**Returns:**
java.lang.String - a string representation of the font style
##### getName()
```
public String getName()
```

Returns readable name of this font style.

**Returns:**
java.lang.String
##### isBold()
```
public boolean isBold()
```

Returns true if bold bit is set.

**Returns:**
boolean
##### isItalic()
```
public boolean isItalic()
```

Returns true if italic bit is set.

**Returns:**
boolean
##### toString()
```
public String toString()
```

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### combine(FontStyles first, FontStyles second)
```
public static FontStyles combine(FontStyles first, FontStyles second)
```

Union (C\# operator +)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| first | com.groupdocs.viewer.fonts.FontStyles |  |
| second | com.groupdocs.viewer.fonts.FontStyles |  |

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### subtract(FontStyles minuend, FontStyles subtrahend)
```
public static FontStyles subtract(FontStyles minuend, FontStyles subtrahend)
```

Difference (C\# operator -)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| minuend | com.groupdocs.viewer.fonts.FontStyles |  |
| subtrahend | com.groupdocs.viewer.fonts.FontStyles |  |

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### tryParse(String style, FontStyles[] parsed)
```
public static boolean tryParse(String style, FontStyles[] parsed)
```

Parses a font style name to FontStyles.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | java.lang.String |  |
| parsed | com.groupdocs.viewer.fonts.FontStyles[] |  |

**Returns:**
boolean - true on success, false otherwise.

### IFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/ifontinfo.md

### PdfFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/pdffontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public class PdfFontInfo implements IFontInfo
```

Encapsulates meta-information and binary data of one font from a PDF document, loaded into the Viewer instance.

This font is used in the document content and is either:

 *  embedded inside the PDF document
 *  or installed in the operating system where GroupDocs.Viewer is running
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format) | Internal constructor used by PDF font extraction. |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Gets the font family name. |
| getStyle() | Gets the style of this font. |
| isEmbedded() | Returns whether the font is embedded inside the PDF document. |
| isInstalled() | Returns whether the font is installed in the OS. |
| getFormat() | Returns the file format of the font. |
| getContent() | Returns the binary content of the font. |
| serializeToCss(Writer output) | Serializes this font as a CSS  @font-face  rule. |
##### PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format)
```
public PdfFontInfo(String familyName, FontStyles style, boolean isEmbedded, boolean isInstalled, byte[] content, int format)
```

Internal constructor used by PDF font extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| familyName | java.lang.String | font family name |
| style | com.groupdocs.viewer.fonts.FontStyles | style (Regular, Bold, Italic, BoldItalic) |
| isEmbedded | boolean | true if the font is embedded in the PDF |
| isInstalled | boolean | true if the font is installed in the OS |
| content | byte[] | binary font data (nullable) |
| format | int | font file format |

##### getFamilyName()
```
public String getFamilyName()
```

Gets the font family name.

**Returns:**
java.lang.String - family name string (never null or empty)
##### getStyle()
```
public FontStyles getStyle()
```

Gets the style of this font.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles - the font style
##### isEmbedded()
```
public boolean isEmbedded()
```

Returns whether the font is embedded inside the PDF document.

**Returns:**
boolean - true if embedded
##### isInstalled()
```
public boolean isInstalled()
```

Returns whether the font is installed in the OS.

**Returns:**
boolean - true if installed
##### getFormat()
```
public int getFormat()
```

Returns the file format of the font.

**Returns:**
int - the font format enum
##### getContent()
```
public byte[] getContent()
```

Returns the binary content of the font.

**Returns:**
byte[] - byte array or null if not available
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font as a CSS  @font-face  rule.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | writer to which CSS will be written |

### PresentationFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/presentationfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class PresentationFontInfo implements IFontInfo
```

Encapsulates metadata and binary data of a font used in a Presentation document, loaded into the Viewer instance. This font is used in the document content and may be embedded inside the document itself or installed in the operating system where GroupDocs.Viewer is running.
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Gets the font family name (never null or empty). |
| getStyle() | Gets the style of the font: Regular, Bold, Italic, or BoldItalic. |
| isEmbedded() | Indicates whether this font is embedded inside the document loaded into the Viewer instance. |
| getFormat() | Gets the font format (TrueType, OpenType, etc.). |
| getContent() | Gets the binary font content, or null if font data is unavailable. |
| serializeToCss(Writer output) | Serializes this font info into CSS @font-face rule using the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Gets the font family name (never null or empty).

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Gets the style of the font: Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isEmbedded()
```
public boolean isEmbedded()
```

Indicates whether this font is embedded inside the document loaded into the Viewer instance. Note: Spreadsheet documents cannot contain embedded fonts, so for them this always returns false.

**Returns:**
boolean
##### getFormat()
```
public int getFormat()
```

Gets the font format (TrueType, OpenType, etc.). If only metadata is available, returns FontFormat.Unknown.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Gets the binary font content, or null if font data is unavailable.

**Returns:**
byte[]
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info into CSS @font-face rule using the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | writer to write CSS into (must not be null) |

### SearchOption
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/searchoption.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum SearchOption extends Enum<SearchOption>
```

Specifies whether to search the current folder, or the current folder and all subfolders.

The SearchOption enum is used to specify the scope of font search operation in the GroupDocs.Viewer API.

Example usage:

```

 FontSettings.setFontSources(new FolderFontSource("/path/to/fonts/folder", SearchOption.ALL_FOLDERS));
 
```

***Note:** This enum is typically used to specify strategy of searching fonts in provided directory.*
#### Fields

| Field | Description |
| --- | --- |
| TOP_FOLDER_ONLY | Includes only the current folder in a search. |
| ALL_FOLDERS | Includes the current folder and all the subfolders in a search. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### TOP_FOLDER_ONLY
```
public static final SearchOption TOP_FOLDER_ONLY
```

Includes only the current folder in a search.

##### ALL_FOLDERS
```
public static final SearchOption ALL_FOLDERS
```

Includes the current folder and all the subfolders in a search.

##### values()
```
public static SearchOption[] values()
```

**Returns:**
com.groupdocs.viewer.fonts.SearchOption[]
##### valueOf(String name)
```
public static SearchOption valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
SearchOption

### SpreadsheetFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/spreadsheetfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class SpreadsheetFontInfo implements IFontInfo
```

Encapsulates metainfo and binary data of one font from the Spreadsheet document, loaded into the Viewer instance. Spreadsheet documents cannot have embedded fonts, so this particular font, if returned by the Viewer.getAllFonts() method, is installed in the operating system where GroupDocs.Viewer is running.
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Family name of the font, without style, never null or empty. |
| getStyle() | Style of this font \\u2014 may be Regular, Bold, Italic, or BoldItalic. |
| isStrikeout() | Indicates whether the font is a single strikeout. |
| isUnderline() | Indicates whether the font has an underline. |
| getColor() | Color of this font. |
| getCharset() | Character set of this font. |
| getContent() | Content of this font as a byte array. |
| getFormat() | Format of this font. |
| serializeToCss(Writer output) | Serializes this font info as a @font-face at-rule and writes it to the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Family name of the font, without style, never null or empty.

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Style of this font \\u2014 may be Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isStrikeout()
```
public boolean isStrikeout()
```

Indicates whether the font is a single strikeout.

**Returns:**
boolean
##### isUnderline()
```
public boolean isUnderline()
```

Indicates whether the font has an underline.

**Returns:**
boolean
##### getColor()
```
public Argb32Color getColor()
```

Color of this font.

**Returns:**
com.groupdocs.viewer.drawing.Argb32Color
##### getCharset()
```
public int getCharset()
```

Character set of this font.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Content of this font as a byte array. May be null if only meta info is available.

**Returns:**
byte[]
##### getFormat()
```
public int getFormat()
```

Format of this font.

**Returns:**
int
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info as a @font-face at-rule and writes it to the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | Device to write serialized text data into. |

### WordProcessingFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/wordprocessingfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class WordProcessingFontInfo implements IFontInfo
```

Encapsulates metainfo and binary data of one font from the WordProcessing document, loaded into the Viewer instance. This font is used in the document content and is embedded inside the document itself or is installed in the operating system where GroupDocs.Viewer is running.

Immutable class. Its instances are produced and returned by the GroupDocs.Viewer public API and normally should not be created by the user. For details, see the documentation: https://docs.groupdocs.com/viewer/net/getting-used-fonts/
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Family name of the font, without style, never null or empty. |
| getAltFamilyName() | Alternative family name of the font. |
| getStyle() | Style of the font \\u2014 may be Regular, Bold, Italic, or BoldItalic. |
| isEmbedded() | Indicates whether this font is embedded inside the document (true) or a system font (false). |
| getFormat() | Format of this font. |
| getContent() | Content of this font as a byte array, or null if unavailable. |
| getCharset() | Character set of this font. |
| toString() | Returns debug info about this font in the following template: "name style, embedded/system, format" |
| serializeToCss(Writer output) | Serializes this font info as a @font-face CSS rule and writes it to the specified writer. |
##### getFamilyName()
```
public String getFamilyName()
```

Family name of the font, without style, never null or empty.

**Returns:**
java.lang.String
##### getAltFamilyName()
```
public String getAltFamilyName()
```

Alternative family name of the font. If missing, returns empty string.

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Style of the font \\u2014 may be Regular, Bold, Italic, or BoldItalic.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### isEmbedded()
```
public boolean isEmbedded()
```

Indicates whether this font is embedded inside the document (true) or a system font (false).

**Returns:**
boolean
##### getFormat()
```
public int getFormat()
```

Format of this font. If there is only metainfo and binary content is missing, may return FontFormat.UNKNOWN.

**Returns:**
int
##### getContent()
```
public byte[] getContent()
```

Content of this font as a byte array, or null if unavailable.

**Returns:**
byte[]
##### getCharset()
```
public int getCharset()
```

Character set of this font.

**Returns:**
int
##### toString()
```
public String toString()
```

Returns debug info about this font in the following template: "name style, embedded/system, format"

**Returns:**
java.lang.String
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serializes this font info as a @font-face CSS rule and writes it to the specified writer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer | Writer to receive the serialized CSS. |

### WordProcessingSubstitutedFontInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.viewer.fonts.IFontInfo
```
public final class WordProcessingSubstitutedFontInfo implements IFontInfo
```

Encapsulates metadata and binary data of one substituted font used in a WordProcessing document via GroupDocs.Viewer. Immutable class.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format) | Constructor to initialize all fields. |
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Returns the family name of the substituted font (never null). |
| getOriginalFamilyName() | Returns the family name of the original font (never null). |
| getStyle() | Returns the style of the original font. |
| getContent() | Returns the binary content of the substituted font (never null). |
| getFormat() | Returns the font format of the substituted font. |
| toString() | Returns a string describing this substituted font: "original-name -> substituted-name style, format" |
| equals(Object obj) | Equality based on original family, substituted family, and style. |
| hashCode() |  |
| serializeToCss(Writer output) | Serialize this font as a @font-face CSS rule using a utility method. |
##### WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format)
```
public WordProcessingSubstitutedFontInfo(String originalFamilyName, String substitutedFamilyName, FontStyles style, byte[] content, int format)
```

Constructor to initialize all fields.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| originalFamilyName | java.lang.String | The original font name (not found on system) |
| substitutedFamilyName | java.lang.String | The substituted font name (available) |
| style | com.groupdocs.viewer.fonts.FontStyles | Font style (Regular, Bold, Italic, BoldItalic) |
| content | byte[] | Binary content of substituted font (never null) |
| format | int | Font format (TrueType, OpenType, etc.) |

##### getFamilyName()
```
public String getFamilyName()
```

Returns the family name of the substituted font (never null).

**Returns:**
java.lang.String
##### getOriginalFamilyName()
```
public String getOriginalFamilyName()
```

Returns the family name of the original font (never null).

**Returns:**
java.lang.String
##### getStyle()
```
public FontStyles getStyle()
```

Returns the style of the original font.

**Returns:**
com.groupdocs.viewer.fonts.FontStyles
##### getContent()
```
public byte[] getContent()
```

Returns the binary content of the substituted font (never null).

**Returns:**
byte[]
##### getFormat()
```
public int getFormat()
```

Returns the font format of the substituted font.

**Returns:**
int
##### toString()
```
public String toString()
```

Returns a string describing this substituted font: "original-name -> substituted-name style, format"

**Returns:**
java.lang.String
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Equality based on original family, substituted family, and style. Required for usage in HashSet or HashMap like C\# IEqualityComparer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object |  |

**Returns:**
boolean
##### hashCode()
```
public int hashCode()
```

**Returns:**
int
##### serializeToCss(Writer output)
```
public void serializeToCss(Writer output)
```

Serialize this font as a @font-face CSS rule using a utility method.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.Writer |  |

### com.groupdocs.viewer.interfaces
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces.md

The package provides interfaces for instantiating and releasing the output document and its resources.

These interfaces are used to manage the creation and release of streams and URLs associated with the output file, pages, and HTML resources.

The main interfaces in this package are:

 *  CreateFileStream - Represents an interface for instantiating a stream used to write output file data.
 *  FileStreamFactory - Defines methods for instantiating and releasing the output file stream.
 *  ReleasePageStream - Releases a stream that was instantiated by a method associated with the CreatePageStream interface.

For more details on working with these interfaces and customizing the output document and resource handling in GroupDocs.Viewer, lease refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Interfaces

| Interface | Description |
| --- | --- |
| CreateFileStream | Represents an interface that instantiates a stream used to write output file data. |
| CreatePageStream | Represents an interface that instantiates a stream used to write output page data. |
| CreateResourceStream | Represents an interface that instantiates a stream used to write output HTML resource data. |
| CreateResourceUrl | Represents an interface that creates a URL for an HTML resource. |
| FileReader | Declares an interface for reading a file stream. |
| FileStreamFactory | Defines methods that are required for instantiating and releasing an output file stream. |
| PageStreamFactory | Defines the methods that are required for instantiating and releasing an output page stream. |
| ReleaseFileStream | Releases an interface that was instantiated by the method associated with the CreateFileStream interface. |
| ReleasePageStream | Releases a stream that was instantiated by the method associated with the CreatePageStream interface. |
| ReleaseResourceStream | Releases a stream that was instantiated by the method associated with the CreateResourceStream interface. |
| ResourceStreamFactory | Defines the methods that are required for creating a resource URL, instantiating, and releasing an output HTML resource stream. |

### CreateFileStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/createfilestream.md

### CreatePageStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/createpagestream.md

### CreateResourceStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/createresourcestream.md

### CreateResourceUrl
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/createresourceurl.md

### FileReader
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/filereader.md

**All Implemented Interfaces:**
java.io.Closeable
```
public interface FileReader extends Closeable
```

Declares an interface for reading a file stream.

The FileReader interface provides a method for reading a file stream. It is used for accessing and reading the contents of a file in a sequential manner. Implementations of this interface should handle the necessary operations to read data from a file.

Example usage:

```

 FileReader fileReader = new FileReader() {
     @Override
     public InputStream read() {
         // Create document stream
     }

     @Override
     public void close() {
         // Close the stream
     }
 };
 try (Viewer viewer = new Viewer(fileReader, new ViewerSettings())){
     // Process document
 }
 
```
#### Methods

| Method | Description |
| --- | --- |
| read() | Returns an InputStream that represents a readable stream for the file. |
| close() | Disposes the object and releases any system resources associated with it. |
##### read()
```
public abstract InputStream read()
```

Returns an InputStream that represents a readable stream for the file.

**Returns:**
java.io.InputStream - the InputStream readable stream.
##### close()
```
public abstract void close()
```

Disposes the object and releases any system resources associated with it.

### FileStreamFactory
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/filestreamfactory.md

### PageStreamFactory
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/pagestreamfactory.md

### ReleaseFileStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/releasefilestream.md

### ReleasePageStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/releasepagestream.md

### ReleaseResourceStream
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/releaseresourcestream.md

### ResourceStreamFactory
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.interfaces/resourcestreamfactory.md

### com.groupdocs.viewer.logging
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.logging.md

The package provides classes for configuring the logging system in GroupDocs.Viewer.

By using these classes, you can control how log messages are handled, such as writing them to a file or directing them to a specific logger implementation.

The main classes in this package are:

 *  FileLogger - Writes log messages to a file.
 *  ViewerLogger - Implements logging messages to an integrated or user-defined logger.

For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| FileLogger | Writes log messages to a file. |
| ViewerLogger | Global viewer logger. |

### FileLogger
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.logging/filelogger.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.foundation.logging.ILogger
```
public class FileLogger implements ILogger
```

Writes log messages to a file.

The  FileLogger  class provides functionality to write log messages to a file. It implements the ILogger interface and can be used to log various events and messages in an application. Log messages are written to the specified file.

Example usage:

```

 // Create a new instance of FileLogger with the specified log file path
 FileLogger fileLogger = new FileLogger("/path/to/logfile.txt");

 // Log an informational message
 fileLogger.debug("Debug message");

 // Log an error message
 fileLogger.error("Error message");

 // Check is logging warning messages enabled
 boolean warningEnabled = fileLogger.isWarningEnabled();
 
```

***Note:** The  FileLogger  class provides basic logging functionality. You can extend this class to add custom log levels or additional logging features as per your requirements.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileLogger(String fileName) | Creates a logger that logs messages to a file specified by the provided file name. |
| FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled) | Creates a logger that logs messages to a file with specified logging levels. |
#### Fields

| Field | Description |
| --- | --- |
| MESSAGE |  |
| EXCEPTION |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes a trace message to the console. |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace log message to the console. |
| isTraceEnabled() | Checks if the trace level is enabled for logging. |
| debug(String message, Object[] arguments) | Writes a debug log message to the console. |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug log message to the console. |
| isDebugEnabled() | Checks if the debug level is enabled for logging. |
| warning(String message, Object[] arguments) | Writes a warning log message to the console. |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning log message to the console. |
| isWarningEnabled() | Checks if the warning level is enabled for logging. |
| error(String message, Object[] arguments) | Writes an error log message to the console. |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error log message to the console. |
| isErrorEnabled() | Checks if error-level logging is enabled. |
##### FileLogger(String fileName)
```
public FileLogger(String fileName)
```

Creates a logger that logs messages to a file specified by the provided file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The full file name with path. |

##### FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```
public FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)
```

Creates a logger that logs messages to a file with specified logging levels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The full file name with path. |
| isTraceEnabled | boolean | Specifies whether trace level logging is enabled. |
| isDebugEnabled | boolean | Specifies whether debug level logging is enabled. |
| isWarningEnabled | boolean | Specifies whether warning level logging is enabled. |
| isErrorEnabled | boolean | Specifies whether error level logging is enabled. |

##### 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 console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public void trace(Throwable throwable, String message, Object[] arguments)
```

Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the trace log message. |
| message | java.lang.String | The trace log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isTraceEnabled()
```
public boolean isTraceEnabled()
```

Checks if the trace level is enabled for logging.

**Returns:**
boolean -  true  if the trace level is enabled,  false  otherwise.
##### debug(String message, Object[] arguments)
```
public void debug(String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public void debug(Throwable throwable, String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the debug log message. |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isDebugEnabled()
```
public boolean isDebugEnabled()
```

Checks if the debug level is enabled for logging.

**Returns:**
boolean -  true  if the debug level is enabled,  false  otherwise.
##### warning(String message, Object[] arguments)
```
public void warning(String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public void warning(Throwable throwable, String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the warning log message. |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isWarningEnabled()
```
public boolean isWarningEnabled()
```

Checks if the warning level is enabled for logging.

**Returns:**
boolean -  true  if the warning level is enabled,  false  otherwise.
##### error(String message, Object[] arguments)
```
public void error(String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### error(Throwable throwable, String message, Object[] arguments)
```
public void error(Throwable throwable, String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the error log message. |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isErrorEnabled()
```
public boolean isErrorEnabled()
```

Checks if error-level logging is enabled.

**Returns:**
boolean -  true  if error-level logging is enabled,  false  otherwise.

### ViewerLogger
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.logging/viewerlogger.md

**Inheritance:**
java.lang.Object
```
public class ViewerLogger
```

Global viewer logger.

The  ViewerLogger  class provides functionality to log messages to an integrated or user-defined logger. It serves as the global logger for the viewer module and can be used to log various events and messages.

Example usage:

```

 // Configure the viewer logger to use the default integrated logger
 ViewerLogger.setLogger(new FileLogger("/path/to/file.log"));

 // Log an debug message
 ViewerLogger.debug("Debug message");

 // Log an error message
 ViewerLogger.error("Error message");
 
```

***Note:** The  ViewerLogger  class can be configured to use a custom logger implementation by calling the setLogger(ILogger) method. By default, it uses the integrated logger provided by the viewer module.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewerLogger() |  |
#### Methods

| Method | Description |
| --- | --- |
| trace(String message, Object[] arguments) | Writes a trace message to the console. |
| trace(Throwable throwable, String message, Object[] arguments) | Writes a trace log message to the console. |
| isTraceEnabled() | Checks if the trace level is enabled for logging. |
| debug(String message, Object[] arguments) | Writes a debug log message to the console. |
| debug(Throwable throwable, String message, Object[] arguments) | Writes a debug log message to the console. |
| isDebugEnabled() | Checks if the debug level is enabled for logging. |
| warning(String message, Object[] arguments) | Writes a warning log message to the console. |
| warning(Throwable throwable, String message, Object[] arguments) | Writes a warning log message to the console. |
| isWarningEnabled() | Checks if the warning level is enabled for logging. |
| error(String message, Object[] arguments) | Writes an error log message to the console. |
| error(Throwable throwable, String message, Object[] arguments) | Writes an error log message to the console. |
| isErrorEnabled() | Checks if error-level logging is enabled. |
| getLogger() | Gets the logger instance that will be used for logging messages. |
| setLogger(ILogger logger) | Sets the logger instance that will be used for logging messages. |
##### ViewerLogger()
```
public ViewerLogger()
```

##### trace(String message, Object[] arguments)
```
public static void trace(String message, Object[] arguments)
```

Writes a trace message to the console. Trace log messages provide generally useful information about application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The trace message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in order of passing. |

##### trace(Throwable throwable, String message, Object[] arguments)
```
public static void trace(Throwable throwable, String message, Object[] arguments)
```

Writes a trace log message to the console. Trace log messages provide generally useful information about the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the trace log message. |
| message | java.lang.String | The trace log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isTraceEnabled()
```
public static boolean isTraceEnabled()
```

Checks if the trace level is enabled for logging.

**Returns:**
boolean -  true  if the trace level is enabled,  false  otherwise.
##### debug(String message, Object[] arguments)
```
public static void debug(String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### debug(Throwable throwable, String message, Object[] arguments)
```
public static void debug(Throwable throwable, String message, Object[] arguments)
```

Writes a debug log message to the console. Debug log messages provide information about different processes in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the debug log message. |
| message | java.lang.String | The debug log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isDebugEnabled()
```
public static boolean isDebugEnabled()
```

Checks if the debug level is enabled for logging.

**Returns:**
boolean -  true  if the debug level is enabled,  false  otherwise.
##### warning(String message, Object[] arguments)
```
public static void warning(String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### warning(Throwable throwable, String message, Object[] arguments)
```
public static void warning(Throwable throwable, String message, Object[] arguments)
```

Writes a warning log message to the console. Warning log messages provide information about unexpected and recoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the warning log message. |
| message | java.lang.String | The warning log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isWarningEnabled()
```
public static boolean isWarningEnabled()
```

Checks if the warning level is enabled for logging.

**Returns:**
boolean -  true  if the warning level is enabled,  false  otherwise.
##### error(String message, Object[] arguments)
```
public static void error(String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### error(Throwable throwable, String message, Object[] arguments)
```
public static void error(Throwable throwable, String message, Object[] arguments)
```

Writes an error log message to the console. Error log messages provide information about unrecoverable events in the application flow.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| throwable | java.lang.Throwable | The exception associated with the error log message. |
| message | java.lang.String | The error log message. |
| arguments | java.lang.Object[] | The arguments to be replaced in the message. They will replace \{\} placeholders in the order they are passed. |

##### isErrorEnabled()
```
public static boolean isErrorEnabled()
```

Checks if error-level logging is enabled.

**Returns:**
boolean -  true  if error-level logging is enabled,  false  otherwise.
##### getLogger()
```
public static synchronized ILogger getLogger()
```

Gets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error.

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger instance.
##### setLogger(ILogger logger)
```
public static synchronized void setLogger(ILogger logger)
```

Sets the logger instance that will be used for logging messages. The logger instance can be used to log messages of different levels such as trace, debug, warning, and error.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger instance to set. |

### com.groupdocs.viewer.options
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options.md

The package provides classes to specify additional options when rendering documents.

It includes options for rendering various document formats, defining permissions and security settings, specifying watermark properties, and retrieving information about views.

The main classes in this package are:

 *  ArchiveOptions - Provides options for rendering archive files.
 *  PdfOptions - Provides options for rendering PDF documents.
 *  WordProcessingOptions - Provides options for rendering word processing documents.

For more details on configuring the logging system in GroupDocs.Viewer and customizing the log message handling, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| ArchiveOptions | Provides options for rendering archive files. |
| ArchiveSecurityOptions | Class that can be used to limit the archives extraction process. |
| BaseViewOptions | Contains the base rendering options. |
| CadOptions | Provides options for rendering CAD drawings. |
| EmailOptions | Provides options for rendering email messages. |
| FileName | Represents the name of a file in an archive. |
| HtmlViewOptions | Provides options for rendering documents into HTML format. |
| JpgViewOptions | Provides options for rendering documents into JPG format. |
| LoadOptions | Provides options that are used to open a file. |
| MailStorageOptions | Provides options for rendering Mail storage (Lotus Notes, MBox) data files. |
| OutlookOptions | Provides options for rendering Outlook data files. |
| PdfOptimizationOptions | Use this class to specify PDF optimization options to apply to the output PDF file. |
| PdfOptions | Provides options for rendering PDF documents. |
| PdfViewOptions | Provides options for rendering documents into PDF format. |
| Permissions | Defines PDF document permissions. |
| PngViewOptions | Provides options for rendering documents into PNG format. |
| PresentationOptions | Provides options for rendering presentations options. |
| ProjectManagementOptions | Provides options for rendering project management files. |
| SearchHighlightOptions | Provides options for searching and highlighting text in the documents, loaded to the Viewer class. |
| Security | Provides PDF document security options. |
| Size | Contains the watermark size. |
| SpreadsheetOptions | Provides options for rendering spreadsheets. |
| TextOptions | Text files splitting to pages options. |
| Tile | Represents drawing region. |
| ViewInfoOptions | Provides options used for retrieving information about view. |
| ViewOptions | Contains the rendering options. |
| VisioRenderingOptions | Contains options for rendering Visio documents. |
| Watermark | Represents a text watermark. |
| WordProcessingOptions | Provides options for rendering word processing documents. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IMaxSizeOptions | Limits of image size options interface. |

#### Enumerations

| Enum | Description |
| --- | --- |
| Field | Represents email message fields e.g. From, To, Subject etc. |
| ImageQuality | The quality of images in the output HTML contained by the PDF documents. |
| PageSize | The size of the page. |
| Position | Defines watermark position. |
| Resolution | Provides option to set resolution for images : output document. |
| Rotation | Contains page rotation in degrees (clockwise). |
| TextOverflowMode | Defines text overflow mode for rendering spreadsheet documents into HTML. |
| TimeUnit | Time unit of the project duration. |

### ArchiveOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/archiveoptions.md

**Inheritance:**
java.lang.Object
```
public class ArchiveOptions
```

Provides options for rendering archive files.

The  ArchiveOptions  class represents a set of options that can be used to configure the rendering of archive files in the viewer module. It allows you to customize various aspects of the rendering process, such as the count of items on each page and so on.

Example usage:

```

 // Create an instance of ArchiveOptions
 ArchiveOptions options = new ArchiveOptions();

 // Set the count of items to be shown on each page
 options.setItemsPerPage(16);

 // Create a Viewer instance with the specified options
 try (final Viewer viewer = new Viewer(documentPath, options)) {
     // Use the viewer object for document rendering
 }
 
```

***Note:** The  ArchiveOptions  class provides a range of customization options for rendering archive files. You can configure these options based on your specific requirements to achieve the desired output.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveOptions() | Creates a new instance of the ArchiveOptions class with default settings. |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Gets the folder inside the archive that will be used for rendering. |
| setFolder(String value) | Sets the folder inside the archive that will be used for rendering. |
| getFileName() | Gets the filename to be displayed in the header. |
| setFileName(FileName fileName) | Sets the filename to be displayed in the header. |
##### ArchiveOptions()
```
public ArchiveOptions()
```

Creates a new instance of the ArchiveOptions class with default settings.

##### getFolder()
```
public final String getFolder()
```

Gets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-archive-files/#render-a-specific-folder

**Returns:**
java.lang.String - the folder to be rendered.
##### setFolder(String value)
```
public final void setFolder(String value)
```

Sets the folder inside the archive that will be used for rendering.

By default, GroupDocs.Viewer renders items from all folders contained in the archive. To render items from a specific folder, set this property. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#render-a-specific-folder

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The folder to be rendered. |

##### getFileName()
```
public FileName getFileName()
```

Gets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#specify-the-archive-file-name

**Returns:**
FileName - the filename to be displayed.
##### setFileName(FileName fileName)
```
public void setFileName(FileName fileName)
```

Sets the filename to be displayed in the header.

By default, GroupDocs.Viewer displays the archive file name in the header of each page. To change or hide this name, set this property. For more information and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/#specify-the-archive-file-name

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | FileName | The filename to be displayed. |

### ArchiveSecurityOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/archivesecurityoptions.md

**Inheritance:**
java.lang.Object
```
public class ArchiveSecurityOptions
```

Class that can be used to limit the archives extraction process.

The ArchiveSecurityOptions class provides a way to limit the extraction of archives and enforce certain restrictions.

Example usage:

```

 ArchiveSecurityOptions securityOptions = new ArchiveSecurityOptions();
 securityOptions.setMaxAllowedEntryNameLength(255);
 securityOptions.setMaxAllowedEntrySize(10737418240L);
 securityOptions.setMaxAllowedEntriesCount(1000);
 securityOptions.setMaxAllowedEntryCompressionRatio(100);

 final LoadOptions loadOptions = new LoadOptions();
 loadOptions.setArchiveSecurityOptions(securityOptions);

 // Create a Viewer instance with the specified options
 try (final Viewer viewer = new Viewer(documentPath, loadOptions)) {
     // Use the viewer object for archive document rendering
 }
 
```

***Note:** Not each archive type supports all options.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ArchiveSecurityOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getMaxAllowedEntryNameLength() | This option specifies the maximum length that an archive entry name can have. |
| setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength) | Sets the maximum allowed length for the archive entry names. |
| getMaxAllowedEntrySize() | Retrieves the maximum allowed size for archive entries. |
| setMaxAllowedEntrySize(long maxAllowedEntrySize) | Sets the maximum allowed size for archive entries. |
| getMaxAllowedEntriesCount() | Retrieves the maximum allowed count of entries in an archive. |
| setMaxAllowedEntriesCount(long maxAllowedEntriesCount) | Sets the maximum allowed count of entries in an archive. |
| getMaxAllowedEntryCompressionRatio() | Specifies the maximum compression ratio allowed for extracting archive entries. |
| setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio) | Specifies the maximum compression ratio allowed for extracting archive entries. |
##### ArchiveSecurityOptions()
```
public ArchiveSecurityOptions()
```

##### getMaxAllowedEntryNameLength()
```
public int getMaxAllowedEntryNameLength()
```

This option specifies the maximum length that an archive entry name can have. If an entry name exceeds this limit, it will cause an error.

***Note:** The default value for this option is 255.*

**Returns:**
int - the maximum allowed length for the archive entry names.
##### setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)
```
public void setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)
```

Sets the maximum allowed length for the archive entry names. The maximum allowed length specifies the limit for the length of an archive entry name. If the length of an entry name exceeds this limit, it will cause an error.

***Note:** The default value for the maximum allowed entry name length is 255.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryNameLength | int | The maximum archive entry name length to be set. |

##### getMaxAllowedEntrySize()
```
public long getMaxAllowedEntrySize()
```

Retrieves the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error.

***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).*

**Returns:**
long - the maximum archive entry size.
##### setMaxAllowedEntrySize(long maxAllowedEntrySize)
```
public void setMaxAllowedEntrySize(long maxAllowedEntrySize)
```

Sets the maximum allowed size for archive entries. The maximum allowed entry size specifies the limit for the size of an archive entry. If the size of an entry exceeds this limit, it will result in an error.

***Note:** The default value for the maximum allowed entry size is 10GB (10737418240 bytes).*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntrySize | long | The maximum archive entry size. |

##### getMaxAllowedEntriesCount()
```
public long getMaxAllowedEntriesCount()
```

Retrieves the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted.

***Note:** The default value for the maximum allowed entries count is 1000.*

**Returns:**
long - the maximum count of entries in an archive.
##### setMaxAllowedEntriesCount(long maxAllowedEntriesCount)
```
public void setMaxAllowedEntriesCount(long maxAllowedEntriesCount)
```

Sets the maximum allowed count of entries in an archive. The maximum allowed entries count specifies the limit for the number of entries that an archive can contain. If an archive contains more entries than this limit, it cannot be extracted.

***Note:** The default value for the maximum allowed entries count is 1000.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntriesCount | long | The maximum count of entries in an archive. |

##### getMaxAllowedEntryCompressionRatio()
```
public double getMaxAllowedEntryCompressionRatio()
```

Specifies the maximum compression ratio allowed for extracting archive entries.

***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.*

**Returns:**
double - the maximum allowed compression ratio for archive entries.
##### setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)
```
public void setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)
```

Specifies the maximum compression ratio allowed for extracting archive entries.

***Note:** Archive entries with a compression ratio higher than the specified value cannot be extracted.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryCompressionRatio | double | The maximum allowed compression ratio for archive entries. |

### BaseViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/baseviewoptions.md

**Inheritance:**
java.lang.Object
```
public abstract class BaseViewOptions
```

Contains the base rendering options.

The  BaseViewOptions  class serves as the base for rendering options in GroupDocs.Viewer. It allows you to customize the rendering behavior of the output HTML, PDF, PNG, and JPEG files when rendering specific document formats.

***Note:** For internal usage.*
#### Constructors

| Constructor | Description |
| --- | --- |
| BaseViewOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTextOptions() | Retrieves the options for splitting text files into pages. |
| setTextOptions(TextOptions textOptions) | Sets the options for splitting text files into pages. |
| isRenderComments() | Enables rendering comments. |
| setRenderComments(boolean value) | Enables rendering comments. |
| isRemoveComments() | Disables rendering comments when set to true. |
| setRemoveComments(boolean value) | Disables rendering comments when set to true. |
| isRenderNotes() | Enables rendering notes. |
| setRenderNotes(boolean value) | Enables rendering notes. |
| isRenderHiddenPages() | Enables rendering of hidden pages. |
| setRenderHiddenPages(boolean value) | Enables rendering of hidden pages. |
| getDefaultFontName() | Default font to be used when a particular font used in the document can't be found. |
| setDefaultFontName(String value) | Default font to be used when a particular font used in the document can't be found. |
| getArchiveOptions() | Retrieves the archive files view options. |
| setArchiveOptions(ArchiveOptions value) | Sets the archive files view options. |
| getCadOptions() | Retrieves the CAD drawing view options. |
| setCadOptions(CadOptions value) | Sets the CAD drawing view options. |
| isCadOptionsInitialized_Internal() |  |
| getEmailOptions() | Retrieves the email messages view options. |
| setEmailOptions(EmailOptions value) | Sets the email messages view options. |
| getOutlookOptions() | Retrieves the MS Outlook data files view options. |
| setOutlookOptions(OutlookOptions value) | Sets the MS Outlook data files view options. |
| getPdfOptions() | Retrieves the PDF documents view options. |
| setPdfOptions(PdfOptions value) | Retrieves the PDF documents view options. |
| getMailStorageOptions() | Retrieves the Lotus Notes storage data files view options. |
| setMailStorageOptions(MailStorageOptions mailStorageOptions) | Sets the Lotus Notes storage data files view options. |
| getProjectManagementOptions() | Retrieves the project management files view options. |
| setProjectManagementOptions(ProjectManagementOptions projectManagementOptions) | Sets the project management files view options. |
| getSpreadsheetOptions() | Retrieves the spreadsheet files view options. |
| setSpreadsheetOptions(SpreadsheetOptions value) | Sets the spreadsheet files view options. |
| getWordProcessingOptions() | The Word processing files view options. |
| setWordProcessingOptions(WordProcessingOptions wordProcessingOptions) | The Word processing files view options. |
| getVisioRenderingOptions() | Retrieves the rendering options for processing Visio files when viewing documents. |
| setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions) | Sets the rendering options for processing Visio files when viewing documents. |
| getPresentationOptions() | Retrieves the view options for processing presentation documents. |
| setPresentationOptions(PresentationOptions presentationOptions) | Sets the view options for processing presentation documents. |
| getWebDocumentOptions() | Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. |
| setWebDocumentOptions(WebDocumentOptions webDocumentOptions) | Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents. |
##### BaseViewOptions()
```
public BaseViewOptions()
```

##### getTextOptions()
```
public TextOptions getTextOptions()
```

Retrieves the options for splitting text files into pages.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/

**Returns:**
TextOptions - the text file splitting options.
##### setTextOptions(TextOptions textOptions)
```
public void setTextOptions(TextOptions textOptions)
```

Sets the options for splitting text files into pages.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textOptions | TextOptions | The text file splitting options. |

##### isRenderComments()
```
public final boolean isRenderComments()
```

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/#render-comments

**Returns:**
boolean -  true  if comments should be rendered,  false  otherwise.
##### setRenderComments(boolean value)
```
public final void setRenderComments(boolean value)
```

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/#render-comments

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if comments should be rendered,  false  otherwise. |

##### isRemoveComments()
```
public final boolean isRemoveComments()
```

Disables rendering comments when set to true. By default is false \\u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete 'RenderComments' property.

**Returns:**
boolean -  true  if comments should be rendered,  false  otherwise.
##### setRemoveComments(boolean value)
```
public final void setRemoveComments(boolean value)
```

Disables rendering comments when set to true. By default is false \\u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete 'RenderComments' property.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if comments should be rendered,  false  otherwise. |

##### isRenderNotes()
```
public final boolean isRenderNotes()
```

Enables rendering notes.

Some files, such as presentations or Microsoft project files, may contain notes. By default, GroupDocs.Viewer does not render notes. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-speaker-notes

**Returns:**
boolean -  true  if notes should be rendered,  false  otherwise.
##### setRenderNotes(boolean value)
```
public final void setRenderNotes(boolean value)
```

Enables rendering notes.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if notes should be rendered,  false  otherwise. |

##### isRenderHiddenPages()
```
public final boolean isRenderHiddenPages()
```

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-hidden-slides

**Returns:**
boolean -  true  if hidden pages should be rendered,  false  otherwise.
##### setRenderHiddenPages(boolean value)
```
public final void setRenderHiddenPages(boolean value)
```

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#render-hidden-slides

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  if hidden pages should be rendered,  false  otherwise. |

##### getDefaultFontName()
```
public final String getDefaultFontName()
```

Default font to be used when a particular font used in the document can't be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/replace-missing-font/

**Returns:**
java.lang.String - the name of the default font.
##### setDefaultFontName(String value)
```
public final void setDefaultFontName(String value)
```

Default font to be used when a particular font used in the document can't be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/replace-missing-font/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the default font. |

##### getArchiveOptions()
```
public final ArchiveOptions getArchiveOptions()
```

Retrieves the archive files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/

**Returns:**
ArchiveOptions - the archive files view options.
##### setArchiveOptions(ArchiveOptions value)
```
public final void setArchiveOptions(ArchiveOptions value)
```

Sets the archive files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-archive-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ArchiveOptions | The archive files view options. |

##### getCadOptions()
```
public final CadOptions getCadOptions()
```

Retrieves the CAD drawing view options.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/

**Returns:**
CadOptions - the CAD drawing view options.
##### setCadOptions(CadOptions value)
```
public final void setCadOptions(CadOptions value)
```

Sets the CAD drawing view options.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/net/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | CadOptions | The CAD drawing view options. |

##### isCadOptionsInitialized_Internal()
```
public boolean isCadOptionsInitialized_Internal()
```

**Returns:**
boolean
##### getEmailOptions()
```
public final EmailOptions getEmailOptions()
```

Retrieves the email messages view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Returns:**
EmailOptions - Email messages view options.
##### setEmailOptions(EmailOptions value)
```
public final void setEmailOptions(EmailOptions value)
```

Sets the email messages view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | EmailOptions | Email messages view options. |

##### getOutlookOptions()
```
public final OutlookOptions getOutlookOptions()
```

Retrieves the MS Outlook data files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/

**Returns:**
OutlookOptions - MS Outlook data files view options.
##### setOutlookOptions(OutlookOptions value)
```
public final void setOutlookOptions(OutlookOptions value)
```

Sets the MS Outlook data files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | OutlookOptions | The MS Outlook data files view options to set. |

##### getPdfOptions()
```
public final PdfOptions getPdfOptions()
```

Retrieves the PDF documents view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/

**Returns:**
PdfOptions - the PDF documents view options.
##### setPdfOptions(PdfOptions value)
```
public final void setPdfOptions(PdfOptions value)
```

Retrieves the PDF documents view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfOptions | The PDF documents view options. |

##### getMailStorageOptions()
```
public MailStorageOptions getMailStorageOptions()
```

Retrieves the Lotus Notes storage data files view options.

**Returns:**
MailStorageOptions - the Lotus Notes storage data files view options.
##### setMailStorageOptions(MailStorageOptions mailStorageOptions)
```
public void setMailStorageOptions(MailStorageOptions mailStorageOptions)
```

Sets the Lotus Notes storage data files view options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mailStorageOptions | MailStorageOptions | The Lotus Notes storage data files view options. |

##### getProjectManagementOptions()
```
public final ProjectManagementOptions getProjectManagementOptions()
```

Retrieves the project management files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/

**Returns:**
ProjectManagementOptions - the project management files view options.
##### setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
```
public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
```

Sets the project management files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| projectManagementOptions | ProjectManagementOptions | The project management files view options to be set. |

##### getSpreadsheetOptions()
```
public final SpreadsheetOptions getSpreadsheetOptions()
```

Retrieves the spreadsheet files view options.

For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files], [Split a worksheet into pages][], and [Specify spreadsheet rendering options][].

[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Split a worksheet into pages]: https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/
[Specify spreadsheet rendering options]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/

**Returns:**
SpreadsheetOptions - the spreadsheet files view options.
##### setSpreadsheetOptions(SpreadsheetOptions value)
```
public final void setSpreadsheetOptions(SpreadsheetOptions value)
```

Sets the spreadsheet files view options.

For more information and code examples, see the [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files], [Split a worksheet into pages][], and [Specify spreadsheet rendering options][].

[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Split a worksheet into pages]: https://docs.groupdocs.com/viewer/net/split-worksheet-into-pages/
[Specify spreadsheet rendering options]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetOptions | The spreadsheet files view options. |

##### getWordProcessingOptions()
```
public final WordProcessingOptions getWordProcessingOptions()
```

The Word processing files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/

**Returns:**
WordProcessingOptions - the Word processing options for rendering Word documents.
##### setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
```
public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
```

The Word processing files view options.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-word-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordProcessingOptions | WordProcessingOptions | The Word processing options for rendering Word documents. |

##### getVisioRenderingOptions()
```
public VisioRenderingOptions getVisioRenderingOptions()
```

Retrieves the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/

**Returns:**
VisioRenderingOptions - the Visio rendering options for processing Visio files.
##### setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
```
public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
```

Sets the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visioRenderingOptions | VisioRenderingOptions | The Visio rendering options for processing Visio files. |

##### getPresentationOptions()
```
public PresentationOptions getPresentationOptions()
```

Retrieves the view options for processing presentation documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/

**Returns:**
com.groupdocs.viewer.options.PresentationOptions - the presentation view options for processing presentation documents.
##### setPresentationOptions(PresentationOptions presentationOptions)
```
public void setPresentationOptions(PresentationOptions presentationOptions)
```

Sets the view options for processing presentation documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| presentationOptions | com.groupdocs.viewer.options.PresentationOptions | The presentation view options for processing presentation documents. |

##### getWebDocumentOptions()
```
public WebDocumentOptions getWebDocumentOptions()
```

Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-web-documents/

**Returns:**
com.groupdocs.viewer.options.WebDocumentOptions - The WebDocumentOptions object for customizing the rendering options.
##### setWebDocumentOptions(WebDocumentOptions webDocumentOptions)
```
public void setWebDocumentOptions(WebDocumentOptions webDocumentOptions)
```

Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-web-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| webDocumentOptions | com.groupdocs.viewer.options.WebDocumentOptions | The WebDocumentOptions object for customizing the rendering options. |

### CadOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/cadoptions.md

**Inheritance:**
java.lang.Object
```
public class CadOptions
```

Provides options for rendering CAD drawings.

The CadOptions class encapsulates various settings and parameters that can be used to control the rendering of CAD drawings in the GroupDocs.Viewer component.

For more information and code examples, see the [Render CAD drawings and models as HTML, PDF, and image files][Render CAD drawings and models as HTML_ PDF_ and image files] and [Specify rendering options for CAD files][].

Example usage:

```

 CadOptions options = CadOptions.forRenderingByWidth(256);
 options.setRenderLayouts(true);
 options.setBackgroundColor(Color.YELLOW);
 options.setLayers(Arrays.asList(
         CacheableFactory.getInstance().newLayer("Layer1"),
         CacheableFactory.getInstance().newLayer("Layer2")
 ));

 try (Viewer viewer = new Viewer("document.dwg")) {
     PdfViewOptions pdfViewOptions = new PdfViewOptions();
     pdfViewOptions.setCadOptions(options);
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[Render CAD drawings and models as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-cad-drawings-and-models/
[Specify rendering options for CAD files]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/
#### Fields

| Field | Description |
| --- | --- |
| WIDTH |  |
| HEIGHT |  |
#### Methods

| Method | Description |
| --- | --- |
| getPc3File() | Retrieves the PC3 (Plotter Configuration) file associated with the plotter. |
| setPc3File(String pc3File) | Sets the PC3 (Plotter Configuration) file associated with the plotter. |
| forRenderingByScaleFactor(double scaleFactor) | Initializes a new instance of the  CadOptions  class for rendering by scale factor. |
| forRenderingByWidth(int width) | Initializes a new instance of the  CadOptions  class for rendering by width. |
| forRenderingByHeight(int height) | Initializes a new instance of the  CadOptions  class for rendering by height. |
| forRenderingByWidthAndHeight(int width, int height) | Initializes a new instance of the  CadOptions  class for rendering by width and height. |
| getScaleFactor() | Gets the scale factor for rendering. |
| getWidth() | Gets the width of the output result in pixels. |
| getHeight() | Gets the height of the output result in pixels. |
| getBackgroundColor() | Gets the background color of the image. |
| getBackgroundColorAsHex() | Gets the background color of the image. |
| setBackgroundColor(Color backgroundColor) | Sets the background color of the image. |
| setBackgroundColor(String colorName) | Sets the background color of the image. |
| getTiles() | Gets the drawing regions to render. |
| setTiles(List<Tile> value) | Sets the drawing regions to render. |
| isRenderLayouts() | Indicates whether layouts from the CAD document should be rendered. |
| setRenderLayouts(boolean value) | Sets whether layouts from the CAD document should be rendered. |
| getLayoutName() | Gets the name of the specific layout to render. |
| setLayoutName(String value) | Sets the name of the specific layout to render. |
| getLayers() | Gets the CAD drawing layers to render. |
| setLayers(List<Layer> value) | Gets the CAD drawing layers to render. |
| isEnablePerformanceConversionMode() | Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. |
| setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode) | Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. |
| equals(Object o) | Checks if this CadOptions object is equal to another object. |
| hashCode() | \{@inheritDoc\} |
| toString() | \{@inheritDoc\} |
| toString(ToStringStyle style) | \{@inheritDoc\} |
##### WIDTH
```
public static final String WIDTH
```

##### HEIGHT
```
public static final String HEIGHT
```

##### getPc3File()
```
public String getPc3File()
```

Retrieves the PC3 (Plotter Configuration) file associated with the plotter.

**Returns:**
java.lang.String - the PC3 file path.
##### setPc3File(String pc3File)
```
public void setPc3File(String pc3File)
```

Sets the PC3 (Plotter Configuration) file associated with the plotter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pc3File | java.lang.String | The PC3 file path. |

##### forRenderingByScaleFactor(double scaleFactor)
```
public static CadOptions forRenderingByScaleFactor(double scaleFactor)
```

Initializes a new instance of the  CadOptions  class for rendering by scale factor.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| scaleFactor | double | The scale factor for rendering. Values greater than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by scale factor.
##### forRenderingByWidth(int width)
```
public static CadOptions forRenderingByWidth(int width)
```

Initializes a new instance of the  CadOptions  class for rendering by width.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by width.
##### forRenderingByHeight(int height)
```
public static CadOptions forRenderingByHeight(int height)
```

Initializes a new instance of the  CadOptions  class for rendering by height.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | The height of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by height.
##### forRenderingByWidthAndHeight(int width, int height)
```
public static CadOptions forRenderingByWidthAndHeight(int width, int height)
```

Initializes a new instance of the  CadOptions  class for rendering by width and height.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#configure-the-output-image-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the output result in pixels. |
| height | int | The height of the output result in pixels. |

**Returns:**
CadOptions - a new instance of the  CadOptions  class for rendering by width and height.
##### getScaleFactor()
```
public final double getScaleFactor()
```

Gets the scale factor for rendering. Values higher than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller.

**Returns:**
double - the scale factor for rendering.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the output result in pixels.

**Returns:**
int - the width of the output result.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the output result in pixels.

**Returns:**
int - the height of the output result.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the image.

**Returns:**
java.awt.Color - the background color of the image.
##### getBackgroundColorAsHex()
```
public String getBackgroundColorAsHex()
```

Gets the background color of the image.

**Returns:**
java.lang.String - the background color of the image in 0xFFFFFF format.
##### setBackgroundColor(Color backgroundColor)
```
public void setBackgroundColor(Color backgroundColor)
```

Sets the background color of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | java.awt.Color | The background color of the image. |

##### setBackgroundColor(String colorName)
```
public void setBackgroundColor(String colorName)
```

Sets the background color of the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String | The background color name of the image. |

##### getTiles()
```
public final List<Tile> getTiles()
```

Gets the drawing regions to render.

**Note:** This option is supported only for FileType.DWG and FileType.DWT file types. The  RenderLayouts  (isRenderLayouts()/setRenderLayouts(boolean)) and  LayoutName  (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.

**Returns:**
java.util.List<com.groupdocs.viewer.options.Tile> - the list of drawing regions to render.
##### setTiles(List<Tile> value)
```
public final void setTiles(List<Tile> value)
```

Sets the drawing regions to render.

**Note:** This option is supported only for FileType.DWG and FileType.DWT file types. The  RenderLayouts  (isRenderLayouts()/setRenderLayouts(boolean)) and  LayoutName  (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.viewer.options.Tile> | The list of drawing regions to render. |

##### isRenderLayouts()
```
public final boolean isRenderLayouts()
```

Indicates whether layouts from the CAD document should be rendered.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Returns:**
boolean -  true  if layouts should be rendered,  false  otherwise.
##### setRenderLayouts(boolean value)
```
public final void setRenderLayouts(boolean value)
```

Sets whether layouts from the CAD document should be rendered.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to render layouts,  false  otherwise. |

##### getLayoutName()
```
public final String getLayoutName()
```

Gets the name of the specific layout to render. The layout name is case-sensitive.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Returns:**
java.lang.String - the name of the specific layout to render.
##### setLayoutName(String value)
```
public final void setLayoutName(String value)
```

Sets the name of the specific layout to render. The layout name is case-sensitive.

**Note:** This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the specific layout to render. |

##### getLayers()
```
public final List<Layer> getLayers()
```

Gets the CAD drawing layers to render.

**Note:** By default, all layers are rendered. Layer names are case-sensitive.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layer> - the CAD drawing layers.
##### setLayers(List<Layer> value)
```
public final void setLayers(List<Layer> value)
```

Gets the CAD drawing layers to render.

**Note:** By default, all layers are rendered. Layer names are case-sensitive.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<com.groupdocs.viewer.results.Layer> | The CAD drawing layers. |

##### isEnablePerformanceConversionMode()
```
public boolean isEnablePerformanceConversionMode()
```

Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.

**Returns:**
boolean -  true  if performance-oriented conversion mode is enabled,  false  otherwise.
##### setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)
```
public void setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)
```

Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enablePerformanceConversionMode | boolean |  true  to enable the performance-oriented conversion mode,  false  to disable it. |

##### equals(Object o)
```
public boolean equals(Object o)
```

Checks if this CadOptions object is equal to another object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.
##### toString()
```
public String toString()
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Returns:**
java.lang.String - a string representation of this object.
##### toString(ToStringStyle style)
```
public String toString(ToStringStyle style)
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. |

**Returns:**
java.lang.String - a string representation of this object using the specified ToStringStyle.

### EmailOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/emailoptions.md

**Inheritance:**
java.lang.Object
```
public class EmailOptions
```

Provides options for rendering email messages.

The EmailOptions class encapsulates various settings and parameters that can be used to control the rendering of email messages in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 EmailOptions options = new EmailOptions();
 options.setDateTimeFormat("MM d yyyy HH:mm tt");
 options.setPageSize(PageSize.A4);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setEmailOptions(options);

 try (Viewer viewer = new Viewer("email.msg")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailOptions() | Initializes a new instance of the  EmailOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDateTimeFormat() | Gets the time format for the date and time values. |
| setDateTimeFormat(String dateTimeFormat) | Gets the time format for the date and time values. |
| getTimeZoneOffset() | Gets the time zone offset for the message. |
| getTimeZoneOffsetMinutes() | Gets the time zone minutes offset minutes for the message. |
| setTimeZoneOffset(TimeZone timeZoneOffset) | Gets the time zone offset for the message. |
| setTimeZoneOffset(int offsetMinutes) | Gets the time zone offset minutes offset for the message. |
| getPageSize() | Gets the size of the output page. |
| setPageSize(PageSize value) | Gets the size of the output page. |
| getFieldTextMap() | Retrieves the mapping between email message fields and their text representations. |
| setFieldTextMap(Map<Field,String> value) | Sets the mapping between email message fields and their text representations. |
| equals(Object o) | Overrides the equals() method of the Object class. |
| hashCode() | \{@inheritDoc\} |
| toString() | Overrides the toString() method of the Object class. |
| toString(ToStringStyle style) | \{@inheritDoc\} |
##### EmailOptions()
```
public EmailOptions()
```

Initializes a new instance of the  EmailOptions  class. This constructor is used to create a new instance of the  EmailOptions  class with default settings.

##### getDateTimeFormat()
```
public String getDateTimeFormat()
```

Gets the time format for the date and time values.

**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
java.lang.String - the time format for date and time values.
##### setDateTimeFormat(String dateTimeFormat)
```
public void setDateTimeFormat(String dateTimeFormat)
```

Gets the time format for the date and time values.

**Note:** The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dateTimeFormat | java.lang.String | The time format for date and time values. |

##### getTimeZoneOffset()
```
public TimeZone getTimeZoneOffset()
```

Gets the time zone offset for the message.

**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC). For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
java.util.TimeZone - the time zone offset.
##### getTimeZoneOffsetMinutes()
```
public int getTimeZoneOffsetMinutes()
```

Gets the time zone minutes offset minutes for the message.

**Note:** The time zone offset minutes represents the minutes difference between the message's time and Coordinated Universal Time (UTC). For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#specify-the-date-and-time-format-and-change-the-time-zone

**Returns:**
int - the time zone offset.
##### setTimeZoneOffset(TimeZone timeZoneOffset)
```
public void setTimeZoneOffset(TimeZone timeZoneOffset)
```

Gets the time zone offset for the message.

**Note:** The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| timeZoneOffset | java.util.TimeZone | The time zone offset. |

##### setTimeZoneOffset(int offsetMinutes)
```
public void setTimeZoneOffset(int offsetMinutes)
```

Gets the time zone offset minutes offset for the message.

**Note:** The time zone minutes offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| offsetMinutes | int | The time zone offset. |

##### getPageSize()
```
public final PageSize getPageSize()
```

Gets the size of the output page.

**Returns:**
PageSize - the page size.
##### setPageSize(PageSize value)
```
public final void setPageSize(PageSize value)
```

Gets the size of the output page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageSize | The page size. |

##### getFieldTextMap()
```
public final Map<Field,String> getFieldTextMap()
```

Retrieves the mapping between email message fields and their text representations.

**Returns:**
java.util.Map<com.groupdocs.viewer.options.Field,java.lang.String> - the mapping between email message fields and their text representations.
##### setFieldTextMap(Map<Field,String> value)
```
public final void setFieldTextMap(Map<Field,String> value)
```

Sets the mapping between email message fields and their text representations.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Map<com.groupdocs.viewer.options.Field,java.lang.String> | The mapping between email message fields and their text representations. |

##### equals(Object o)
```
public boolean equals(Object o)
```

Overrides the equals() method of the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare with. |

**Returns:**
boolean - true if the objects are equal, false otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.
##### toString()
```
public String toString()
```

Overrides the toString() method of the Object class.

**Returns:**
java.lang.String - a string representation of the object.
##### toString(ToStringStyle style)
```
public String toString(ToStringStyle style)
```

Returns a string representation of this object.

**Note:** This method overrides the default implementation of the toString() method defined in the Object class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | org.apache.commons.lang3.builder.ToStringStyle | The ToStringStyle to use for generating the string representation. |

**Returns:**
java.lang.String - a string representation of this object using the specified ToStringStyle.

### Field
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/field.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Field extends Enum<Field>
```

Represents email message fields e.g. From, To, Subject etc.

The Field enum represents common email message fields in the GroupDocs.Viewer component. It provides a set of predefined fields that can be used to identify and access specific information in email messages, such as the sender, recipient, subject, and more.

For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 EmailOptions emailOptions = htmlViewOptions.getEmailOptions();
 emailOptions.getFieldTextMap().put(Field.FROM, "Sender");

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-email-messages/#rename-fields-in-the-message-header
#### Fields

| Field | Description |
| --- | --- |
| ANNIVERSARY | Represents the "Anniversary" field. |
| ATTACHMENTS | Represents the "Attachments" field. |
| BCC | Represents the "Bcc" field. |
| BIRTHDAY | Represents the "Birthday" field. |
| BUSINESS | Represents the "Business" field. |
| BUSINESS_ADDRESS | Represents the "Business Address" field. |
| BUSINESS_FAX | Represents the "Business Fax" field. |
| BUSINESS_HOMEPAGE | Represents the "BusinessHomepage" field. |
| CC | Represents the "Cc" field. |
| COMPANY | Represents the "Company" field. |
| DEPARTMENT | Represents the "Department" field. |
| EMAIL | Represents the "Email" field. |
| EMAIL_DISPLAY_AS | Represents the "Email Display As" field. |
| EMAIL_2 | Represents the "Email2" field. |
| EMAIL_2_DISPLAY_AS | Represents the "Email2 Display As" field. |
| EMAIL_3 | Represents the "Email3" field. |
| EMAIL_3_DISPLAY_AS | Represents the "Email3 Display As" field. |
| END | Represents the "End" field. |
| FIRST_NAME | Represents the "First Name" field. |
| FROM | Represents the "From" field. |
| FULL_NAME | Represents the "Full Name" field. |
| GENDER | Represents the "Gender" field. |
| HOBBIES | Represents the "Hobbies" field. |
| HOME | Represents the "Home" field. |
| HOME_ADDRESS | Represents the "Home Address" field. |
| IMPORTANCE | Represents the "Importance" field. |
| JOB_TITLE | Represents the "Job Title" field. |
| LAST_NAME | Represents the "Last Name" field. |
| LOCATION | Represents the "Location" field. |
| MIDDLE_NAME | Represents the "Middle Name" field. |
| MOBILE | Represents the "Mobile" field. |
| ORGANIZER | Represents the "Organizer" field. |
| OTHER_ADDRESS | Represents the "Other Address" field. |
| PERSONAL_HOMEPAGE | Represents the "Personal Homepage" field. |
| PROFESSION | Represents the "Profession" field. |
| RECURRENCE | Represents the "Recurrence" field. |
| RECURRENCE_PATTERN | Represents the "Recurrence Pattern" field. |
| REQUIRED_ATTENDEES | Represents the "Required Attendees" field. |
| SENT | Represents the "Sent" field. |
| SHOW_TIME_AS | Represents the "Show Time As" field. |
| SPOUSE_PARTNER | Represents the "Spouse/Partner" field. |
| START | Represents the "Start" field. |
| SUBJECT | Represents the "Subject" field. |
| TO | Represents the "To" field. |
| USER_FIELD_1 | Represents the "User Field 1" field. |
| USER_FIELD_2 | Represents the "User Field 2" field. |
| USER_FIELD_3 | Represents the "User Field 3" field. |
| USER_FIELD_4 | Represents the "User Field 4" field. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getName() | Field name. |
| toString() | Returns a string that represents the current object. |
##### ANNIVERSARY
```
public static final Field ANNIVERSARY
```

Represents the "Anniversary" field.

##### ATTACHMENTS
```
public static final Field ATTACHMENTS
```

Represents the "Attachments" field.

##### BCC
```
public static final Field BCC
```

Represents the "Bcc" field.

##### BIRTHDAY
```
public static final Field BIRTHDAY
```

Represents the "Birthday" field.

##### BUSINESS
```
public static final Field BUSINESS
```

Represents the "Business" field.

##### BUSINESS_ADDRESS
```
public static final Field BUSINESS_ADDRESS
```

Represents the "Business Address" field.

##### BUSINESS_FAX
```
public static final Field BUSINESS_FAX
```

Represents the "Business Fax" field.

##### BUSINESS_HOMEPAGE
```
public static final Field BUSINESS_HOMEPAGE
```

Represents the "BusinessHomepage" field.

##### CC
```
public static final Field CC
```

Represents the "Cc" field.

##### COMPANY
```
public static final Field COMPANY
```

Represents the "Company" field.

##### DEPARTMENT
```
public static final Field DEPARTMENT
```

Represents the "Department" field.

##### EMAIL
```
public static final Field EMAIL
```

Represents the "Email" field.

##### EMAIL_DISPLAY_AS
```
public static final Field EMAIL_DISPLAY_AS
```

Represents the "Email Display As" field.

##### EMAIL_2
```
public static final Field EMAIL_2
```

Represents the "Email2" field.

##### EMAIL_2_DISPLAY_AS
```
public static final Field EMAIL_2_DISPLAY_AS
```

Represents the "Email2 Display As" field.

##### EMAIL_3
```
public static final Field EMAIL_3
```

Represents the "Email3" field.

##### EMAIL_3_DISPLAY_AS
```
public static final Field EMAIL_3_DISPLAY_AS
```

Represents the "Email3 Display As" field.

##### END
```
public static final Field END
```

Represents the "End" field.

##### FIRST_NAME
```
public static final Field FIRST_NAME
```

Represents the "First Name" field.

##### FROM
```
public static final Field FROM
```

Represents the "From" field.

##### FULL_NAME
```
public static final Field FULL_NAME
```

Represents the "Full Name" field.

##### GENDER
```
public static final Field GENDER
```

Represents the "Gender" field.

##### HOBBIES
```
public static final Field HOBBIES
```

Represents the "Hobbies" field.

##### HOME
```
public static final Field HOME
```

Represents the "Home" field.

##### HOME_ADDRESS
```
public static final Field HOME_ADDRESS
```

Represents the "Home Address" field.

##### IMPORTANCE
```
public static final Field IMPORTANCE
```

Represents the "Importance" field.

##### JOB_TITLE
```
public static final Field JOB_TITLE
```

Represents the "Job Title" field.

##### LAST_NAME
```
public static final Field LAST_NAME
```

Represents the "Last Name" field.

##### LOCATION
```
public static final Field LOCATION
```

Represents the "Location" field.

##### MIDDLE_NAME
```
public static final Field MIDDLE_NAME
```

Represents the "Middle Name" field.

##### MOBILE
```
public static final Field MOBILE
```

Represents the "Mobile" field.

##### ORGANIZER
```
public static final Field ORGANIZER
```

Represents the "Organizer" field.

##### OTHER_ADDRESS
```
public static final Field OTHER_ADDRESS
```

Represents the "Other Address" field.

##### PERSONAL_HOMEPAGE
```
public static final Field PERSONAL_HOMEPAGE
```

Represents the "Personal Homepage" field.

##### PROFESSION
```
public static final Field PROFESSION
```

Represents the "Profession" field.

##### RECURRENCE
```
public static final Field RECURRENCE
```

Represents the "Recurrence" field.

##### RECURRENCE_PATTERN
```
public static final Field RECURRENCE_PATTERN
```

Represents the "Recurrence Pattern" field.

##### REQUIRED_ATTENDEES
```
public static final Field REQUIRED_ATTENDEES
```

Represents the "Required Attendees" field.

##### SENT
```
public static final Field SENT
```

Represents the "Sent" field.

##### SHOW_TIME_AS
```
public static final Field SHOW_TIME_AS
```

Represents the "Show Time As" field.

##### SPOUSE_PARTNER
```
public static final Field SPOUSE_PARTNER
```

Represents the "Spouse/Partner" field.

##### START
```
public static final Field START
```

Represents the "Start" field.

##### SUBJECT
```
public static final Field SUBJECT
```

Represents the "Subject" field.

##### TO
```
public static final Field TO
```

Represents the "To" field.

##### USER_FIELD_1
```
public static final Field USER_FIELD_1
```

Represents the "User Field 1" field.

##### USER_FIELD_2
```
public static final Field USER_FIELD_2
```

Represents the "User Field 2" field.

##### USER_FIELD_3
```
public static final Field USER_FIELD_3
```

Represents the "User Field 3" field.

##### USER_FIELD_4
```
public static final Field USER_FIELD_4
```

Represents the "User Field 4" field.

##### values()
```
public static Field[] values()
```

**Returns:**
com.groupdocs.viewer.options.Field[]
##### valueOf(String name)
```
public static Field valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Field
##### getName()
```
public final String getName()
```

Field name.

This method retrieves the name of the field.

**Returns:**
java.lang.String - the name of the field.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - a string that represents the current object.

### FileName
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/filename.md

**Inheritance:**
java.lang.Object
```
public class FileName
```

Represents the name of a file in an archive.

The FileName class encapsulates the name of a file without any path or directory information. It provides methods to manipulate and retrieve information about the file name.

Example usage:

```

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.getArchiveOptions().setFileName(new FileName("my-file-name"));

 final LoadOptions loadOptions = new LoadOptions(FileType.ZIP);
 try (final Viewer viewer = new Viewer(documentPath, loadOptions)) {
     viewer.view(options);
     // Use the viewer object for archive document rendering
 }
 
```

***Note:** The FileName class is used to work with file names and does not handle file operations or manipulation.*
#### Constructors

| Constructor | Description |
| --- | --- |
| FileName(String fileName) | Initializes a new instance of the  FileName  class. |
#### Fields

| Field | Description |
| --- | --- |
| EMPTY | Represents an empty filename. |
| SOURCE | Represents the name of the source file. |
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| toString() | Returns a string representation of the current object. |
##### FileName(String fileName)
```
public FileName(String fileName)
```

Initializes a new instance of the  FileName  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The name of the file. |

##### EMPTY
```
public static final FileName EMPTY
```

Represents an empty filename.

##### SOURCE
```
public static final FileName SOURCE
```

Represents the name of the source file.

##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### toString()
```
public String toString()
```

Returns a string representation of the current object.

**Returns:**
java.lang.String - a string representation of the current object.

### HtmlViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/htmlviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions
```
public class HtmlViewOptions extends ViewOptions
```

Provides options for rendering documents into HTML format.

The HtmlViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into HTML format in the GroupDocs.Viewer component.

For details, see the [topic][] and its children.

Example usage:

```

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.setExcludeFonts(true);
 options.setFontsToExclude(Arrays.asList("font-name"));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

[topic]: https://docs.groupdocs.com/viewer/java/rendering-to-html/
#### Fields

| Field | Description |
| --- | --- |
| CREATE_PAGE_STREAM |  |
| FILE_PATH_FORMAT |  |
#### Methods

| Method | Description |
| --- | --- |
| isRenderResponsive() | Determines whether responsive rendering is enabled. |
| setRenderResponsive(boolean value) | Sets whether responsive rendering is enabled. |
| isMinify() | Checks if HTML content and HTML resources minification is enabled. |
| setMinify(boolean value) | Sets whether HTML content and HTML resources minification is enabled. |
| isRenderToSinglePage() | Enables rendering an entire document to one HTML file. |
| setRenderToSinglePage(boolean renderSinglePage) | Enables rendering an entire document to one HTML file. |
| getImageMaxWidth() | Returns the maximum width of an output image in pixels. |
| setImageMaxWidth(int imageMaxWidth) | Sets the maximum width of an output image in pixels. |
| getImageMaxHeight() | Gets the maximum height of an output image in pixels. |
| setImageMaxHeight(int imageMaxHeight) | Sets the maximum height of an output image in pixels. |
| getImageWidth() | Gets the width of the output image in pixels. |
| setImageWidth(int imageWidth) | Sets the width of the output image in pixels. |
| getImageHeight() | Gets the height of the output image in pixels when converting a single image to HTML. |
| setImageHeight(int imageHeight) | Sets the height of the output image in pixels when converting a single image to HTML. |
| isForPrinting() | Checks if the output HTML should be optimized for printing. |
| setForPrinting(boolean value) | Sets whether the output HTML should be optimized for printing. |
| isExcludeFonts() | Determines whether to exclude fonts from the HTML document. |
| setExcludeFonts(boolean value) | Sets whether to exclude fonts from the HTML document. |
| getFontsToExclude() | Retrieves the list of font names to exclude from the HTML document. |
| setFontsToExclude(List<String> value) | Sets the list of font names to exclude from the HTML document. |
| isRemoveJavaScript() | Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. |
| setRemoveJavaScript(boolean value) | Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. |
| getDocumentSavingCallback() | Retrieves the callback used to estimate the saving progress of a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback used to estimate the saving progress of a Words or Email document. |
| forEmbeddedResources(CreatePageStream createPageStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources. |
| forEmbeddedResources() | Initializes a new instance of the  HtmlViewOptions  class. |
| forEmbeddedResources(String filePathFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
| forEmbeddedResources(Path filePathFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
| forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory) | Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources. |
| forExternalResources() | Initializes new instance of  HtmlViewOptions  class. |
| forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat) | Initializes a new instance of the  HtmlViewOptions  class. |
##### CREATE_PAGE_STREAM
```
public static final String CREATE_PAGE_STREAM
```

##### FILE_PATH_FORMAT
```
public static final String FILE_PATH_FORMAT
```

##### isRenderResponsive()
```
public final boolean isRenderResponsive()
```

Determines whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-with-responsive-layout/

**Returns:**
boolean -  true  if responsive rendering is enabled,  false  otherwise.
##### setRenderResponsive(boolean value)
```
public final void setRenderResponsive(boolean value)
```

Sets whether responsive rendering is enabled. Responsive web pages render well on devices with different screen sizes.

Responsive design aims to make web pages render well on a variety of devices. To render with a responsive layout, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-with-responsive-layout/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable responsive rendering,  false  to disable it. |

##### isMinify()
```
public final boolean isMinify()
```

Checks if HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/minify-html/

**Returns:**
boolean -  true  if minification is enabled,  false  otherwise.
##### setMinify(boolean value)
```
public final void setMinify(boolean value)
```

Sets whether HTML content and HTML resources minification is enabled.

Compression of the output content (HTML, CSS, and SVG) is one of the ways to optimize the HTML file. To do this, set this property to true. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/minify-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable minification,  false  to disable. |

##### isRenderToSinglePage()
```
public boolean isRenderToSinglePage()
```

Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

 *  [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
 *  [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }
```

[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/#create-a-single-html-page
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file
[Render web documents as PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Returns:**
boolean
##### setRenderToSinglePage(boolean renderSinglePage)
```
public void setRenderToSinglePage(boolean renderSinglePage)
```

Enables rendering an entire document to one HTML file.

**See the following topics for more information:**

 *  [Render archives as HTML, PDF, and image files][Render archives as HTML_ PDF_ and image files]
 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]
 *  [Render web documents as PDF, PNG, and JPEG files][Render web documents as PDF_ PNG_ and JPEG files]

**Example:**

```
try (final Viewer viewer = new Viewer("invoice.docx")) {
   HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();
   viewOptions.setRenderToSinglePage(true);

   viewer.view(viewOptions);
 }
```

[Render archives as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-archive-files/#create-a-single-html-page
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/#create-a-single-html-page
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#convert-all-excel-worksheets-to-one-html-file
[Render web documents as PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-web-documents/#create-an-html-file-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | boolean |  |

##### getImageMaxWidth()
```
public int getImageMaxWidth()
```

Returns the maximum width of an output image in pixels.

**Note:** This value is used when converting a single image to HTML. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the maximum width of an output image.
##### setImageMaxWidth(int imageMaxWidth)
```
public void setImageMaxWidth(int imageMaxWidth)
```

Sets the maximum width of an output image in pixels.

**Note:** This value is used when converting a single image to HTML. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxWidth | int | The maximum width of an output image. |

##### getImageMaxHeight()
```
public int getImageMaxHeight()
```

Gets the maximum height of an output image in pixels.

**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the maximum height of an output image.
##### setImageMaxHeight(int imageMaxHeight)
```
public void setImageMaxHeight(int imageMaxHeight)
```

Sets the maximum height of an output image in pixels.

**Note:** This option applies when converting a single image to HTML. It specifies the maximum height of the output image. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxHeight | int | The maximum height of an output image. |

##### getImageWidth()
```
public int getImageWidth()
```

Gets the width of the output image in pixels.

***Note:** This value is applicable only when converting a single image to HTML.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the width of the output image.
##### setImageWidth(int imageWidth)
```
public void setImageWidth(int imageWidth)
```

Sets the width of the output image in pixels.

***Note:** This value is applicable only when converting a single image to HTML.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageWidth | int | The width of the output image. |

##### getImageHeight()
```
public int getImageHeight()
```

Gets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Returns:**
int - the height of the output image in pixels.
##### setImageHeight(int imageHeight)
```
public void setImageHeight(int imageHeight)
```

Sets the height of the output image in pixels when converting a single image to HTML.

For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageHeight | int | The height of the output image in pixels. |

##### isForPrinting()
```
public final boolean isForPrinting()
```

Checks if the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/how-to-optimize-output-html-for-printing/

**Returns:**
boolean -  true  if the output HTML should be optimized for printing,  false  otherwise.
##### setForPrinting(boolean value)
```
public final void setForPrinting(boolean value)
```

Sets whether the output HTML should be optimized for printing.

Enable this option to convert the output HTML pages to the vector SVG format. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/how-to-optimize-output-html-for-printing/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to optimize the output HTML for printing,  false  otherwise. |

##### isExcludeFonts()
```
public final boolean isExcludeFonts()
```

Determines whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Returns:**
boolean -  true  if fonts should be excluded,  false  otherwise.
##### setExcludeFonts(boolean value)
```
public final void setExcludeFonts(boolean value)
```

Sets whether to exclude fonts from the HTML document.

By default, GroupDocs.Viewer embeds the fonts used in the document into HTML. To prevent it, set this property to true. For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to exclude fonts,  false  otherwise. |

##### getFontsToExclude()
```
public final List<String> getFontsToExclude()
```

Retrieves the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

***Note:** Please note that this property is active only when the  ExcludeFonts  (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Returns:**
java.util.List<java.lang.String> - the list of font names to exclude from the HTML document.
##### setFontsToExclude(List<String> value)
```
public final void setFontsToExclude(List<String> value)
```

Sets the list of font names to exclude from the HTML document.

This option is supported for presentations only. Including fonts in the HTML document improves the stability of the output view but increases the rendering result's size. Use this option to find a compromise between stability and output size. Include font names that are popular and installed on most systems.

***Note:** Please note that this property is active only when the  ExcludeFonts  (\#isExcludeFonts().isExcludeFonts()/\#setExcludeFonts(boolean).setExcludeFonts(boolean)) option is disabled.* For details and code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/exclude-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.List<java.lang.String> | The list of font names to exclude from the HTML document. |

##### isRemoveJavaScript()
```
public final boolean isRemoveJavaScript()
```

Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-html/#preserving-or-disabling-javascript-when-rendering-to-html

**Returns:**
boolean
##### setRemoveJavaScript(boolean value)
```
public void setRemoveJavaScript(boolean value)
```

Sets permission to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

For details about removing JavaScript, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-html/#preserving-or-disabling-javascript-when-rendering-to-html

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback used to estimate the saving progress of a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback used to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback used to estimate the saving progress of a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback used to estimate the document saving progress. |

##### forEmbeddedResources(CreatePageStream createPageStream)
```
public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

***Note:** The method takes a  CreatePageStream  parameter, which is a method used to instantiate a stream for writing output page data.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public static HtmlViewOptions forEmbeddedResources(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates a stream used to write output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the  createPageStream  parameter. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources(PageStreamFactory pageStreamFactory)
```
public static HtmlViewOptions forEmbeddedResources(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with embedded resources.
##### forEmbeddedResources()
```
public static HtmlViewOptions forEmbeddedResources()
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forEmbeddedResources(String filePathFormat)
```
public static HtmlViewOptions forEmbeddedResources(String filePathFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forEmbeddedResources(Path filePathFormat)
```
public static HtmlViewOptions forEmbeddedResources(Path filePathFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-embedded-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.html'. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class.
##### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)
```
public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

***Note:** This method should be used when rendering HTML with external resources, such as CSS and JavaScript files.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that releases the stream created by the  createPageStream  method. |
| createResourceUrl | CreateResourceUrl | The method that creates the URL for the HTML resource. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)
```
public static HtmlViewOptions forExternalResources(CreatePageStream createPageStream, CreateResourceStream createResourceStream, CreateResourceUrl createResourceUrl, ReleasePageStream releasePageStream, ReleaseResourceStream releaseResourceStream)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write output page data. |
| createResourceStream | CreateResourceStream | The method that instantiates the stream used to write output HTML resource data. |
| createResourceUrl | CreateResourceUrl | The method that creates the URL for the HTML resource. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the  createPageStream  method. |
| releaseResourceStream | ReleaseResourceStream | The method that releases the stream created by the  createResourceStream  method. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)
```
public static HtmlViewOptions forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)
```

Initializes a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |
| resourceStreamFactory | ResourceStreamFactory | The factory that implements methods for creating resource URLs and instantiating/releasing the output HTML resource stream. |

**Returns:**
HtmlViewOptions - a new instance of the  HtmlViewOptions  class for rendering into HTML with external resources.
##### forExternalResources()
```
public static HtmlViewOptions forExternalResources()
```

Initializes new instance of  HtmlViewOptions  class.

 *  \- with "p\_\{0\}.html" as file path format for the output HTML files;
 *  \- with "p\_\{0\}\_\{1\}" as file path format for the output HTML-resource files;
 *  \- with "p\_\{0\}\_\{1\}" as URL format for HTML-resources;

The output files will be placed into current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Returns:**
HtmlViewOptions
##### forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)
```
public static HtmlViewOptions forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)
```

Initializes a new instance of the  HtmlViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-html/#rendering-to-html-with-external-resources

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.html'. |
| resourceFilePathFormat | java.lang.String | The resource file path format, e.g., 'page\_\{0\}/resource\_\{1\}'. |
| resourceUrlFormat | java.lang.String | The resource URL format, e.g., 'page\_\{0\}/resource\_\{1\}'. |

**Returns:**
HtmlViewOptions

### ImageQuality
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/imagequality.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum ImageQuality extends Enum<ImageQuality>
```

The quality of images in the output HTML contained by the PDF documents.

The ImageQuality enum represents the quality of images in the output HTML contained by the PDF documents in the GroupDocs.Viewer component. It provides different levels of image quality that can be used to control the rendering and compression of images in the generated HTML output.

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 PdfOptions pdfOptions = htmlViewOptions.getPdfOptions();
 pdfOptions.setImageQuality(ImageQuality.HIGH);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| LOW | The acceptable quality and best performance. |
| MEDIUM | Better quality and slower performance. |
| HIGH | The best quality but slow performance. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### LOW
```
public static final ImageQuality LOW
```

The acceptable quality and best performance. This setting prioritizes rendering speed over image quality.

##### MEDIUM
```
public static final ImageQuality MEDIUM
```

Better quality and slower performance. This setting provides a balance between image quality and rendering speed.

##### HIGH
```
public static final ImageQuality HIGH
```

The best quality but slow performance. This setting prioritizes image quality over rendering speed.

##### values()
```
public static ImageQuality[] values()
```

**Returns:**
com.groupdocs.viewer.options.ImageQuality[]
##### valueOf(String name)
```
public static ImageQuality valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
ImageQuality

### IMaxSizeOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/imaxsizeoptions.md

### JpgViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/jpgviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class JpgViewOptions extends ViewOptions implements IMaxSizeOptions
```

Provides options for rendering documents into JPG format.

The JpgViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into JPG format in the GroupDocs.Viewer component.

Example usage:

```

 JpgViewOptions options = new JpgViewOptions();
 options.setMaxWidth(1920);
 options.setMaxHeight(1080);
 options.setQuality((byte) 96);
 options.setRenderComments(true);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

***Note:** The JpgViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output JPG images.*
#### Constructors

| Constructor | Description |
| --- | --- |
| JpgViewOptions(CreatePageStream createPageStream) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions() | Initializes a new instance of  JpgViewOptions  with "p\_\{0\}.jpg" as the file path format for the output files. |
| JpgViewOptions(String filePathFormat) | Initializes a new instance of the  JpgViewOptions  class. |
| JpgViewOptions(Path filePathFormat) | Initializes a new instance of the  JpgViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxWidth() | Gets the maximum width of an output image in pixels. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image in pixels. |
| getMaxHeight() | Gets the maximum height of an output image in pixels. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image in pixels. |
| getQuality() | Gets the quality of the output image. |
| setQuality(byte value) | Sets the quality of the output image. |
| isExtractText() | Enables text extraction. |
| setExtractText(boolean value) | Enables or disables text extraction. |
| getWidth() | Gets the width of the output image in pixels. |
| setWidth(int value) | Sets the width of the output image in pixels. |
| getHeight() | Gets the height of the output image in pixels. |
| setHeight(int value) | Sets the height of the output image in pixels. |
| getPageStreamFactory() | Gets the factory that implements methods for creating and releasing the output page stream. |
| getDocumentSavingCallback() | Gets the callback to estimate the saving progress of a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback to estimate the saving progress of a Words or Email document. |
##### JpgViewOptions(CreatePageStream createPageStream)
```
public JpgViewOptions(CreatePageStream createPageStream)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |

##### JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the delegate passed to the  createPageStream  parameter. |

##### JpgViewOptions(PageStreamFactory pageStreamFactory)
```
public JpgViewOptions(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

##### JpgViewOptions()
```
public JpgViewOptions()
```

Initializes a new instance of  JpgViewOptions  with "p\_\{0\}.jpg" as the file path format for the output files. The output files will be placed into the current working directory of the application.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

##### JpgViewOptions(String filePathFormat)
```
public JpgViewOptions(String filePathFormat)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.jpg'. |

##### JpgViewOptions(Path filePathFormat)
```
public JpgViewOptions(Path filePathFormat)
```

Initializes a new instance of the  JpgViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-jpeg

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.jpg'. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Gets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the \#setWidth(int).setWidth(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of an output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the \#setWidth(int).setWidth(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of an output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Gets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the \#setHeight(int).setHeight(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of an output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the \#setHeight(int).setHeight(int) property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of an output image. |

##### getQuality()
```
public final byte getQuality()
```

Gets the quality of the output image.

***Note:** Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-quality-for-jpg/

**Returns:**
byte - the quality of the output image.
##### setQuality(byte value)
```
public final void setQuality(byte value)
```

Sets the quality of the output image.

***Note:** Use this property to adjust images quality. The value must be between 1 (minimum quality) and 100. The default value is 90.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-quality-for-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | The quality of the output image. |

##### isExtractText()
```
public final boolean isExtractText()
```

Enables text extraction.

***Note:** Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Returns:**
boolean -  true  if text extraction is enabled,  false  otherwise.
##### setExtractText(boolean value)
```
public final void setExtractText(boolean value)
```

Enables or disables text extraction.

***Note:** Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable text extraction,  false  to disable it. |

##### getWidth()
```
public final int getWidth()
```

Gets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxWidth(int).setMaxWidth(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the width of the output image.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxWidth(int).setMaxWidth(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the output image. |

##### getHeight()
```
public final int getHeight()
```

Gets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxHeight(int).setMaxHeight(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the height of the output image.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the \#setMaxHeight(int).setMaxHeight(int) property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the output image. |

##### getPageStreamFactory()
```
public final PageStreamFactory getPageStreamFactory()
```

Gets the factory that implements methods for creating and releasing the output page stream.

**Returns:**
PageStreamFactory - the factory for the output page stream.
##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Gets the callback to estimate the saving progress of a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback to estimate the saving progress of a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### LoadOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Provides options that are used to open a file.

The LoadOptions class encapsulates various settings and parameters that can be used to specify how a file should be opened and loaded in the GroupDocs.Viewer component. For details, see this [page][] and its children.

Example usage:

```

 LoadOptions options = new LoadOptions();
 options.setPassword("myPassword");
 options.setFileType(PDF);
 options.setCharset(Charset.forName("UTF-8"));

 try (Viewer viewer = new Viewer(pdfFileInputStream, options)) {
     // Use the viewer object for further operations
 }
 
```

[page]: https://docs.groupdocs.com/viewer/java/loading/
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the  LoadOptions  class. |
| LoadOptions(FileType fileType) | Initializes a new instance of the  LoadOptions  class. |
#### Fields

| Field | Description |
| --- | --- |
| DEFAULT_URL_CONNECT_TIMEOUT |  |
| DEFAULT_URL_READ_TIMEOUT |  |
| _tryRepair |  |
#### Methods

| Method | Description |
| --- | --- |
| isTryRepair() | When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. |
| setTryRepair(boolean tryRepair) | When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. |
| getFileType() | Gets the type of the file to open. |
| setFileType(FileType value) | Sets the type of the file to open. |
| getPassword() | Gets the password for opening an encrypted file. |
| setPassword(String value) | Sets the password for opening an encrypted file. |
| getCharset() | The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG. |
| setCharset(Charset value) | The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG. |
| isDetectCharset() | This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. |
| setDetectCharset(boolean detectCharset) | This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. |
| getResourceLoadingTimeout() | Gets the timeout for loading external resources. |
| setResourceLoadingTimeout(int resourceLoadingTimeout) | Sets the timeout for loading external resources, such as graphics. |
| getUrlConnectTimeout() | Gets the connection timeout for creating a Viewer using java.net.URL to load a document. |
| setUrlConnectTimeout(int urlConnectTimeout) | Sets the connection timeout for creating a Viewer using java.net.URL to load a document. |
| getUrlReadTimeout() | Gets the read timeout for creating a Viewer using java.net.URL to load a document. |
| setUrlReadTimeout(int urlReadTimeout) | Sets the read timeout for creating a Viewer using java.net.URL to load a document. |
| getArchiveSecurityOptions() | Gets the security options to control the process of extracting archives. |
| setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions) | Sets the security options to control the process of extracting archives. |
| isSkipExternalResources() | When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources(). |
| setSkipExternalResources(boolean skipExternalResources) | When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources(). |
| getWhitelistedResources() | The list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`. |
| setWhitelistedResources(List<String> whitelistedResources) | Sets the list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`. |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the  LoadOptions  class.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

##### LoadOptions(FileType fileType)
```
public LoadOptions(FileType fileType)
```

Initializes a new instance of the  LoadOptions  class.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The type of the file to open. |

##### DEFAULT_URL_CONNECT_TIMEOUT
```
public static final int DEFAULT_URL_CONNECT_TIMEOUT
```

##### DEFAULT_URL_READ_TIMEOUT
```
public static final int DEFAULT_URL_READ_TIMEOUT
```

##### _tryRepair
```
public boolean _tryRepair
```

##### isTryRepair()
```
public boolean isTryRepair()
```

When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is false.

This feature addresses the following issues in a PDF document:

 *  Broken references within the document (incorrect object offsets in the Cross-reference list).
 *  Missing critical elements like root object, page object, or page content.
 *  Circular references (Form X-object referencing itself).

**Returns:**
boolean
##### setTryRepair(boolean tryRepair)
```
public void setTryRepair(boolean tryRepair)
```

When enabled, GroupDocs.Viewer tries to repair structural corruption in PDF documents. Default value is false.

This feature addresses the following issues in a PDF document:

 *  Broken references within the document (incorrect object offsets in the Cross-reference list).
 *  Missing critical elements like root object, page object, or page content.
 *  Circular references (Form X-object referencing itself).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tryRepair | boolean |  |

##### getFileType()
```
public final FileType getFileType()
```

Gets the type of the file to open.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Returns:**
FileType - the file type.
##### setFileType(FileType value)
```
public final void setFileType(FileType value)
```

Sets the type of the file to open.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-file-type-when-loading-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | FileType | The file type. |

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening an encrypted file.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/load-password-protected-document/

**Returns:**
java.lang.String - the password for opening the file.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening an encrypted file.

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/load-password-protected-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password for opening the file. |

##### getCharset()
```
public final Charset getCharset()
```

The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.

Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-encoding-when-loading-documents/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Returns:**
java.nio.charset.Charset
##### setCharset(Charset value)
```
public final void setCharset(Charset value)
```

The charset used when opening text-based files or email messages such as FileType.CSV, FileType.TXT, and FileType.MSG.

Default value is java.nio.charset.StandardCharsets\#UTF\_8.UTF\_8. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setCharset(StandardCharsets.US_ASCII); // Set the charset

 try (Viewer viewer = new Viewer("message.txt", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-encoding-when-loading-documents/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files
[Render email messages as HTML_ PDF_ PNG_ and JPEG files]: https://docs.groupdocs.com/viewer/java/render-email-messages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset |  |

##### isDetectCharset()
```
public boolean isDetectCharset()
```

This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.

**Learn more about rendering text and tab/comma delimited files**

 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

If the encoding cannot be detected, the default  is used. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents/

**Returns:**
boolean
##### setDetectCharset(boolean detectCharset)
```
public void setDetectCharset(boolean detectCharset)
```

This option enables FileType.TXT, FileType.TSV, and FileType.CSV files charset detection. In case the charset can't be detected the default getCharset() is used.

**Learn more about rendering text and tab/comma delimited files**

 *  [Render text documents as HTML, PDF, and image files][Render text documents as HTML_ PDF_ and image files]
 *  [Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files][Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]

If the encoding cannot be detected, the default  is used. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDetectCharset(true); // Enable encoding detection

 try (Viewer viewer = new Viewer("employees.csv", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Render text documents as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-text-files/
[Render Excel and Apple Numbers spreadsheets as HTML_ PDF_ and image files]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| detectCharset | boolean |  |

##### getResourceLoadingTimeout()
```
public int getResourceLoadingTimeout()
```

Gets the timeout for loading external resources.

**Note:** The default value is 10 seconds.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

The default value is 30 seconds. For code example, see the [documentation][].

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setResourceLoadingTimeout(5000); // Set resource loading timeout to 5 seconds

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/
[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents

**Returns:**
int
##### setResourceLoadingTimeout(int resourceLoadingTimeout)
```
public void setResourceLoadingTimeout(int resourceLoadingTimeout)
```

Sets the timeout for loading external resources, such as graphics.

***Note:** The default value is 30 seconds.*

This option is supported for Word Processing documents that contain external resources. The default value is 30 seconds. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/detect-encoding-when-loading-documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resourceLoadingTimeout | int | The loading timeout, milliseconds. |

##### getUrlConnectTimeout()
```
public int getUrlConnectTimeout()
```

Gets the connection timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 5 seconds.*

**Returns:**
int - the connection timeout.
##### setUrlConnectTimeout(int urlConnectTimeout)
```
public void setUrlConnectTimeout(int urlConnectTimeout)
```

Sets the connection timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 5 seconds.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| urlConnectTimeout | int | The connection timeout. |

##### getUrlReadTimeout()
```
public int getUrlReadTimeout()
```

Gets the read timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 30 seconds.*

**Returns:**
int - the read timeout.
##### setUrlReadTimeout(int urlReadTimeout)
```
public void setUrlReadTimeout(int urlReadTimeout)
```

Sets the read timeout for creating a Viewer using java.net.URL to load a document.

***Note:** The default value is 30 seconds.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| urlReadTimeout | int | The read timeout. |

##### getArchiveSecurityOptions()
```
public ArchiveSecurityOptions getArchiveSecurityOptions()
```

Gets the security options to control the process of extracting archives.

***Note:** Not each archive type supports all options.*

**Returns:**
com.groupdocs.viewer.options.ArchiveSecurityOptions - the options object to configure the process of extracting archives.
##### setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)
```
public void setArchiveSecurityOptions(ArchiveSecurityOptions archiveSecurityOptions)
```

Sets the security options to control the process of extracting archives.

***Note:** Not each archive type supports all options.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| archiveSecurityOptions | com.groupdocs.viewer.options.ArchiveSecurityOptions | The options object to configure the process of extracting archives. |

##### isSkipExternalResources()
```
public boolean isSkipExternalResources()
```

When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources().

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Returns:**
boolean
##### setSkipExternalResources(boolean skipExternalResources)
```
public void setSkipExternalResources(boolean skipExternalResources)
```

When set to true, all external resources such as images will not be loaded except \#getWhitelistedResources().getWhitelistedResources().

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources

 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| skipExternalResources | boolean | The flag to enable or disable loading of external resources. |

##### getWhitelistedResources()
```
public List<String> getWhitelistedResources()
```

The list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.getWhitelistedResources().add("avatars.githubusercontent.com"); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Returns:**
java.util.List<java.lang.String>
##### setWhitelistedResources(List<String> whitelistedResources)
```
public void setWhitelistedResources(List<String> whitelistedResources)
```

Sets the list of URL fragments corresponding to external resources that should be loaded when \#isSkipExternalResources().isSkipExternalResources() is set to `true`.

**This option applies to the following file formats:**

 *  [Presentation file formats][]
 *  [Spreadsheet file formats][]
 *  [Web file formats][]
 *  [Word processing file formats][]

**Learn more about options to manage external resources:**

 *  [Set timeout for loading external resources][]

**Example:**

```
LoadOptions loadOptions = new LoadOptions();
 loadOptions.setSkipExternalResources(true); // Skip loading of external resources
 loadOptions.setWhitelistedResources(Arrays.asList("avatars.githubusercontent.com")); // Enable loading of external resources that have 'avatars.githubusercontent.com' fragment in resource URL.
 try (Viewer viewer = new Viewer("business-flyer.docx", loadOptions)) {
     HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources();

     viewer.view(viewOptions);
 }
```

[Presentation file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#presentation-file-formats
[Spreadsheet file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#spreadsheet-file-formats
[Web file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#web-file-formats
[Word processing file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#word-processing-file-formats
[Set timeout for loading external resources]: https://docs.groupdocs.com/viewer/java/set-timeout-for-loading-external-resources-contained-by-a-document/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| whitelistedResources | java.util.List<java.lang.String> | The list of URL fragments corresponding to external resources that should be loaded. |

### MailStorageOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/mailstorageoptions.md

**Inheritance:**
java.lang.Object
```
public class MailStorageOptions
```

Provides options for rendering Mail storage (Lotus Notes, MBox) data files.

The MailStorageOptions class encapsulates various settings and parameters that can be used to control the rendering of Mail storage data files (such as Lotus Notes or MBox) in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 MailStorageOptions options = new MailStorageOptions();
 options.setAddressFilter("@gmail.com");
 options.setMaxItems(10);

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setMailStorageOptions(options);

 try (Viewer viewer = new Viewer("mail.msg")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#specify-rendering-options
#### Constructors

| Constructor | Description |
| --- | --- |
| MailStorageOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTextFilter() | Gets the keywords used to filter messages. |
| setTextFilter(String textFilter) | Sets the keywords used to filter messages. |
| getAddressFilter() | Gets the email address used to filter messages by sender or recipient. |
| setAddressFilter(String addressFilter) | Sets the email address used to filter messages by sender or recipient. |
| getMaxItems() | Gets the maximum number of messages or items to render. |
| setMaxItems(int maxItems) | Sets the maximum number of messages or items to render. |
##### MailStorageOptions()
```
public MailStorageOptions()
```

##### getTextFilter()
```
public String getTextFilter()
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Returns:**
java.lang.String - the keywords used for filtering messages.
##### setTextFilter(String textFilter)
```
public void setTextFilter(String textFilter)
```

Sets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textFilter | java.lang.String | The keywords used for filtering messages. |

##### getAddressFilter()
```
public String getAddressFilter()
```

Gets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\u2019s or recipient\\u2019s address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Returns:**
java.lang.String - the email address used for filtering messages.
##### setAddressFilter(String addressFilter)
```
public void setAddressFilter(String addressFilter)
```

Sets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\u2019s or recipient\\u2019s address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| addressFilter | java.lang.String | The email address used for filtering messages. |

##### getMaxItems()
```
public int getMaxItems()
```

Gets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

***Note:** The default value is 0, which means all messages will be rendered.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#limit-the-number-of-items-to-render

**Returns:**
int - the maximum number of messages or items to render.
##### setMaxItems(int maxItems)
```
public void setMaxItems(int maxItems)
```

Sets the maximum number of messages or items to render.

Lotus Notes data files can be large, and retrieving all messages can take significant time. This setting limits the maximum number of messages or items that are rendered.

***Note:** The default value is 0, which means all messages will be rendered.* For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#limit-the-number-of-items-to-render

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxItems | int | The maximum number of messages or items to render. |

### OutlookOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/outlookoptions.md

**Inheritance:**
java.lang.Object
```
public class OutlookOptions
```

Provides options for rendering Outlook data files.

The OutlookOptions class encapsulates various settings and parameters that can be used to control the rendering of Outlook data files (such as PST or OST files) in the GroupDocs.Viewer component.

For details, see the [documentation][].

Example usage:

```

 OutlookOptions options = new OutlookOptions();
 options.setAddressFilter("@gmail.com");
 options.setFolder("folderName");

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setOutlookOptions(options);

 try (Viewer viewer = new Viewer("mail.pst")) {
   viewer.view(htmlViewOptions);
   // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-lotus-notes-database-files/#specify-rendering-options
#### Constructors

| Constructor | Description |
| --- | --- |
| OutlookOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFolder() | Gets the name of the folder to render. |
| setFolder(String value) | Sets the name of the folder to render. |
| getTextFilter() | Gets the keywords used to filter messages. |
| setTextFilter(String value) | Gets the keywords used to filter messages. |
| getAddressFilter() | Gets the email address used to filter messages by sender or recipient. |
| setAddressFilter(String value) | Sets the email address used to filter messages by sender or recipient. |
| getMaxItemsInFolder() | Gets the maximum number of messages or items that can be rendered from one folder. |
| setMaxItemsInFolder(int value) | Sets the maximum number of messages or items that can be rendered from one folder. |
##### OutlookOptions()
```
public OutlookOptions()
```

##### getFolder()
```
public final String getFolder()
```

Gets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#render-a-specific-folder

**Returns:**
java.lang.String - the name of the folder to render.
##### setFolder(String value)
```
public final void setFolder(String value)
```

Sets the name of the folder to render. The name of the folder (e.g., Inbox, Sent Item, or Deleted Items) to render.

When rendering an Outlook data file, GroupDocs.Viewer renders messages from all folders contained in the file (including nested folders). Use this property to render items from a specific folder. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#render-a-specific-folder

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the folder to render. |

##### getTextFilter()
```
public final String getTextFilter()
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Returns:**
java.lang.String - the keywords.
##### setTextFilter(String value)
```
public final void setTextFilter(String value)
```

Gets the keywords used to filter messages.

Use this property to render all messages that contain specific text in the subject or body. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The keywords. |

##### getAddressFilter()
```
public final String getAddressFilter()
```

Gets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\ufffds or recipient\\ufffds address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Returns:**
java.lang.String - the email address used to filter messages.
##### setAddressFilter(String value)
```
public final void setAddressFilter(String value)
```

Sets the email address used to filter messages by sender or recipient.

Use this property to render all messages that contain specific text in the sender\\ufffds or recipient\\ufffds address. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#filter-messages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The email address used to filter messages. |

##### getMaxItemsInFolder()
```
public final int getMaxItemsInFolder()
```

Gets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#limit-the-number-of-folder-items-to-render

**Returns:**
int - the maximum number of messages or items that can be rendered from one folder.
##### setMaxItemsInFolder(int value)
```
public final void setMaxItemsInFolder(int value)
```

Sets the maximum number of messages or items that can be rendered from one folder.

Outlook data files can be large and retrieving all messages can take significant time. This setting limits the maximum number of messages or items (such as contacts and tasks) that are rendered. The default value is 50. Set the value to 0 to render all messages. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-outlook-data-files/#limit-the-number-of-folder-items-to-render

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The maximum number of messages or items that can be rendered from one folder. |

### PageSize
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/pagesize.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum PageSize extends Enum<PageSize>
```

The size of the page.

The PageSize enum represents different page sizes in the GroupDocs.Viewer component. It provides a set of predefined page sizes that can be used to specify the dimensions of a page in various document rendering scenarios.

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 ProjectManagementOptions projectManagementOptions = htmlViewOptions.getProjectManagementOptions();
 projectManagementOptions.setPageSize(PageSize.A4);

 try (Viewer viewer = new Viewer("document.mpp")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| UNSPECIFIED | The default, unspecified page size. |
| LETTER | The size of the Letter page in points is 792 x 612. |
| LEDGER | The size of the A0 page in points is 3371 x 2384. |
| A0 | The size of the A1 page in points is 2384 x 1685. |
| A1 | The size of the A2 page in points is 1684 x 1190. |
| A2 | The size of the A3 page in points is 1190 x 842. |
| A3 | The size of the A3 page in points is 1190 x 842. |
| A4 | The size of the A4 page in points is 842 x 595. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### UNSPECIFIED
```
public static final PageSize UNSPECIFIED
```

The default, unspecified page size. This size is used when no specific page size is specified.

##### LETTER
```
public static final PageSize LETTER
```

The size of the Letter page in points is 792 x 612. This page size is commonly used for letters and documents in North America.

##### LEDGER
```
public static final PageSize LEDGER
```

The size of the A0 page in points is 3371 x 2384. This large page size is part of the ISO 216 international standard.

##### A0
```
public static final PageSize A0
```

The size of the A1 page in points is 2384 x 1685. This page size is part of the ISO 216 international standard.

##### A1
```
public static final PageSize A1
```

The size of the A2 page in points is 1684 x 1190. This page size is part of the ISO 216 international standard.

##### A2
```
public static final PageSize A2
```

The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard.

##### A3
```
public static final PageSize A3
```

The size of the A3 page in points is 1190 x 842. This page size is part of the ISO 216 international standard.

##### A4
```
public static final PageSize A4
```

The size of the A4 page in points is 842 x 595. This page size is part of the ISO 216 international standard.

##### values()
```
public static PageSize[] values()
```

**Returns:**
com.groupdocs.viewer.options.PageSize[]
##### valueOf(String name)
```
public static PageSize valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
PageSize

### PdfOptimizationOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/pdfoptimizationoptions.md

**Inheritance:**
java.lang.Object
```
public class PdfOptimizationOptions
```

Use this class to specify PDF optimization options to apply to the output PDF file.

These optimization options are supported for any input file formats which are supported for export to PDF. For details and code samples, see this [page][] and its children.

Example usage:

```

 try (Viewer viewer = new Viewer("sample.docx")) {
     PdfViewOptions viewOptions = new PdfViewOptions();
     viewOptions.setPdfOptimizationOptions(new PdfOptimizationOptions());
     viewOptions.getPdfOptimizationOptions().setLinearize(true);
     viewOptions.getPdfOptimizationOptions().setRemoveAnnotations(true);
     viewOptions.getPdfOptimizationOptions().setRemoveFormFields(true);
     viewOptions.getPdfOptimizationOptions().setConvertToGrayScale(true);
     viewOptions.getPdfOptimizationOptions().setSubsetFonts(true);
     viewOptions.getPdfOptimizationOptions().setCompressImages(true);
     viewOptions.getPdfOptimizationOptions().setImageQuality(50);
     viewOptions.getPdfOptimizationOptions().setResizeImages(true);
     viewOptions.getPdfOptimizationOptions().setMaxResolution(50);
     viewOptions.getPdfOptimizationOptions().setRemovePrivateInfo(true);
     viewOptions.getPdfOptimizationOptions().setUnembedFonts(true);
     viewOptions.getPdfOptimizationOptions().setLinkDuplicateStreams(true);
     viewOptions.getPdfOptimizationOptions().setAllowReusePageContent(true);

     viewer.view(viewOptions);
 }
 
```

[page]: https://docs.groupdocs.com/viewer/java/optimization-pdf-options/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptimizationOptions() | Sets up default values of MaxResolution option to 300 and ImageQuality option to 100. |
#### Methods

| Method | Description |
| --- | --- |
| isLinearize() | Enables optimization the output PDF file for viewing online with a web browser. |
| setLinearize(boolean linearize) | Sets whether to optimize output PDF for online browsing with a web browser. |
| isRemoveAnnotations() | Annotations can be deleted when they are unnecessary. |
| setRemoveAnnotations(boolean removeAnnotations) | Sets whether to remove unnecessary annotations from the PDF. |
| isRemoveFormFields() | If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields. |
| setRemoveFormFields(boolean removeFormFields) | Sets whether to remove form fields from the PDF. |
| isConvertToGrayScale() | PDF file is composed of Text, Image, Attachment, Annotations, Graphs and other objects. |
| setConvertToGrayScale(boolean convertToGrayScale) | Sets whether to convert the PDF to grayscale. |
| isSubsetFonts() | Every font used to display text on the page contains set of glyphs for font characters. |
| setSubsetFonts(boolean subsetFonts) | Sets whether to subset the fonts in the PDF. |
| isCompressImages() | If the source PDF file contains images, consider compressing the images and setting their quality. |
| setCompressImages(boolean compressImages) | Sets whether to compress the images in the PDF. |
| getImageQuality() | If the source PDF file contains images, consider compressing the images and setting their quality. |
| setImageQuality(int imageQuality) | Sets the image quality for compressing the images in the PDF. |
| isResizeImages() | Can be used with CompressImages option to resize the images with a lower resolution. |
| setResizeImages(boolean resizeImages) | Sets whether to resize the images in the PDF. |
| getMaxResolution() | Can be used with CompressImages option to resize the images with a lower resolution. |
| setMaxResolution(int maxResolution) | Sets the maximum resolution for resizing the images in the PDF. |
| isOptimizeSpreadsheets() | Optimize Excel spreadsheets border lines and fonts for smaller output file size. |
| setOptimizeSpreadsheets(boolean optimizeSpreadsheets) | Sets whether to optimize the spreadsheets in the PDF. |
| isRemovePrivateInfo() | Remove private information (page piece info) if set to true. |
| setRemovePrivateInfo(boolean removePrivateInfo) | Sets whether to remove private information from the PDF. |
| isUnembedFonts() | If the document uses embedded fonts it means that all font data is placed in the document. |
| setUnembedFonts(boolean unembedFonts) | Sets whether to unembed the embedded fonts in the PDF. |
| isLinkDuplicateStreams() | Sometimes a document contains several identical resource streams (for example images). |
| setLinkDuplicateStreams(boolean linkDuplicateStreams) | Sets whether to link duplicate streams in the PDF. |
| isAllowReusePageContent() | If this property is set to true, the page content will be reused when optimizing the document for identical pages. |
| setAllowReusePageContent(boolean allowReusePageContent) | Sets whether to allow reusing page content in the PDF. |
| isRemoveUnusedStreams() | Sometimes a document contains unused resource streams. |
| setRemoveUnusedStreams(boolean removeUnusedStreams) | Sets whether to remove unused streams from the PDF. |
| isRemoveUnusedObjects() | A PDF document sometimes contains the PDF objects that are not referenced from any other object in the document. |
| setRemoveUnusedObjects(boolean removeUnusedObjects) | Sets whether to remove unused objects from the PDF. |
##### PdfOptimizationOptions()
```
public PdfOptimizationOptions()
```

Sets up default values of MaxResolution option to 300 and ImageQuality option to 100.

For details and code samples, see this [page][] and its children.

[page]: https://docs.groupdocs.com/viewer/java/optimization-pdf-options/

##### isLinearize()
```
public boolean isLinearize()
```

Enables optimization the output PDF file for viewing online with a web browser.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-for-web/

**Returns:**
boolean -  true  if the output PDF is optimized for online browsing,  false  otherwise.
##### setLinearize(boolean linearize)
```
public void setLinearize(boolean linearize)
```

Sets whether to optimize output PDF for online browsing with a web browser.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-for-web/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linearize | boolean |  true  to optimize the output PDF for online browsing,  false  otherwise. |

##### isRemoveAnnotations()
```
public boolean isRemoveAnnotations()
```

Annotations can be deleted when they are unnecessary. When they are needed but do not require additional editing, they can be flattened. It will reduce the file size.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-annotations/

**Returns:**
boolean -  true  if annotations are removed,  false  otherwise.
##### setRemoveAnnotations(boolean removeAnnotations)
```
public void setRemoveAnnotations(boolean removeAnnotations)
```

Sets whether to remove unnecessary annotations from the PDF.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-annotations/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeAnnotations | boolean |  true  to remove unnecessary annotations,  false  otherwise. |

##### isRemoveFormFields()
```
public boolean isRemoveFormFields()
```

If the PDF document contains AcroForms, we can try to reduce the file size by flattening form fields.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-fields/

**Returns:**
boolean -  true  if form fields are removed,  false  otherwise.
##### setRemoveFormFields(boolean removeFormFields)
```
public void setRemoveFormFields(boolean removeFormFields)
```

Sets whether to remove form fields from the PDF.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-remove-fields/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeFormFields | boolean |  true  to remove form fields,  false  otherwise. |

##### isConvertToGrayScale()
```
public boolean isConvertToGrayScale()
```

PDF file is composed of Text, Image, Attachment, Annotations, Graphs and other objects. You may come across a requirement to convert a PDF from RGB colorspace to grayscale so that it would be faster while printing those PDF files. Also when the file is converted to grayscale, the size of the document is also reduced but with this change, the quality of the document may drop. Currently, this feature is supported by the Pre-Flight feature of Adobe Acrobat.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-convert-grayscale/

**Returns:**
boolean -  true  if the PDF is converted to grayscale,  false  otherwise.
##### setConvertToGrayScale(boolean convertToGrayScale)
```
public void setConvertToGrayScale(boolean convertToGrayScale)
```

Sets whether to convert the PDF to grayscale.

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-convert-grayscale/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| convertToGrayScale | boolean |  true  to convert the PDF to grayscale,  false  otherwise. |

##### isSubsetFonts()
```
public boolean isSubsetFonts()
```

Every font used to display text on the page contains set of glyphs for font characters. PDF specification supports "font subset" i.e. font with only those glyphs which are used. This may cause issues when text should be updated (since probably required glyphs are absent in the font), but for the document which is not planned to change this allows to decrease size.

***Note:** The default value is  false .* If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-subset-fonts/

**Returns:**
boolean -  true  if fonts are subsetted,  false  otherwise.
##### setSubsetFonts(boolean subsetFonts)
```
public void setSubsetFonts(boolean subsetFonts)
```

Sets whether to subset the fonts in the PDF.

***Note:** The default value is  false .* If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-subset-fonts/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subsetFonts | boolean |  true  to subset the fonts,  false  otherwise. |

##### isCompressImages()
```
public boolean isCompressImages()
```

If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set this option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the ImageQuality property less than 100.

***Note:** The default value is  false .* Use this option to allow other compressing options: \#setImageQuality(int).setImageQuality(int) and . For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Returns:**
boolean -  true  if images are compressed,  false  otherwise.
##### setCompressImages(boolean compressImages)
```
public void setCompressImages(boolean compressImages)
```

Sets whether to compress the images in the PDF.

***Note:** The default value is  false .* Use this option to allow other compressing options: \#setImageQuality(int).setImageQuality(int) and . For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| compressImages | boolean |  true  to compress the images,  false  otherwise. |

##### getImageQuality()
```
public int getImageQuality()
```

If the source PDF file contains images, consider compressing the images and setting their quality. In order to enable image compression, set CompressImages option to true. All the images in a document will be re-compressed. The compression is defined by the ImageQuality property, which is the value of the quality in percent. 100% is unchanged quality. To decrease image quality, set the CompressImages option to true and ImageQuality property less than 100.

***Note:** The default value is  100 .* To change the image quality, first set the \#setCompressImages(boolean).setCompressImages(boolean) property to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Returns:**
int - the image quality (value between 1 and 100).
##### setImageQuality(int imageQuality)
```
public void setImageQuality(int imageQuality)
```

Sets the image quality for compressing the images in the PDF.

***Note:** The default value is  100 .* To change the image quality, first set the \#setCompressImages(boolean).setCompressImages(boolean) property to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-reduce-image-quality/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageQuality | int | the image quality (value between 1 and 100). |

##### isResizeImages()
```
public boolean isResizeImages()
```

Can be used with CompressImages option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value.

***Note:** The default value is  false .* To allow this option, set the  property to true. This option allows setting the  property. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Returns:**
boolean -  true  if images are resized,  false  otherwise.
##### setResizeImages(boolean resizeImages)
```
public void setResizeImages(boolean resizeImages)
```

Sets whether to resize the images in the PDF.

***Note:** The default value is  false .* To allow this option, set the  property to true. This option allows setting the  property. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resizeImages | boolean |  true  to resize the images,  false  otherwise. |

##### getMaxResolution()
```
public int getMaxResolution()
```

Can be used with CompressImages option to resize the images with a lower resolution. In this case, we should set CompressImage to true, ResizeImages to true and MaxResolution to the appropriate value.

***Note:** The default value is  300 .* To allow this option, set the \#setCompressImages(boolean).setCompressImages(boolean) and \#setMaxResolution(int).setMaxResolution(int) properties to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Returns:**
int - the maximum resolution for the images.
##### setMaxResolution(int maxResolution)
```
public void setMaxResolution(int maxResolution)
```

Sets the maximum resolution for resizing the images in the PDF.

***Note:** The default value is  300 .* To allow this option, set the \#setCompressImages(boolean).setCompressImages(boolean) and \#setMaxResolution(int).setMaxResolution(int) properties to true. For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-set-max-resolution/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxResolution | int | the maximum resolution for the images. |

##### isOptimizeSpreadsheets()
```
public boolean isOptimizeSpreadsheets()
```

Optimize Excel spreadsheets border lines and fonts for smaller output file size.

*The output PDF will not include embedded Arial and Times New Roman fonts with characters 32-127.*

***Note:** The default value is  false .* For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-spreadsheets/

**Returns:**
boolean -  true  if spreadsheets are optimized,  false  otherwise.
##### setOptimizeSpreadsheets(boolean optimizeSpreadsheets)
```
public void setOptimizeSpreadsheets(boolean optimizeSpreadsheets)
```

Sets whether to optimize the spreadsheets in the PDF.

For code example, see this [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/optimization-pdf-spreadsheets/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| optimizeSpreadsheets | boolean |  true  to optimize the spreadsheets,  false  otherwise. |

##### isRemovePrivateInfo()
```
public boolean isRemovePrivateInfo()
```

Remove private information (page piece info) if set to true.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if private information is removed,  false  otherwise.
##### setRemovePrivateInfo(boolean removePrivateInfo)
```
public void setRemovePrivateInfo(boolean removePrivateInfo)
```

Sets whether to remove private information from the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removePrivateInfo | boolean |  true  to remove private information,  false  otherwise. |

##### isUnembedFonts()
```
public boolean isUnembedFonts()
```

If the document uses embedded fonts it means that all font data is placed in the document. The advantage is that the document is viewable regardless of whether the font is installed on the user\\u2019s machine or not. But embedding fonts makes the document larger. The unembed fonts method removes all embedded fonts. This decreases the document size but the document may become unreadable if the correct font is not installed.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if embedded fonts are unembedded,  false  otherwise.
##### setUnembedFonts(boolean unembedFonts)
```
public void setUnembedFonts(boolean unembedFonts)
```

Sets whether to unembed the embedded fonts in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unembedFonts | boolean |  true  to unembed the embedded fonts,  false  otherwise. |

##### isLinkDuplicateStreams()
```
public boolean isLinkDuplicateStreams()
```

Sometimes a document contains several identical resource streams (for example images). This may happen for example when a document is concatenated with itself. The output document contains two independent copies of the same resource stream. We analyze all resource streams and compare them. If streams are duplicated they are merged, that is, only one copy is left, references are changed appropriately and copies of the object are removed. Sometimes this decreases the document size.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if duplicate streams are linked,  false  otherwise.
##### setLinkDuplicateStreams(boolean linkDuplicateStreams)
```
public void setLinkDuplicateStreams(boolean linkDuplicateStreams)
```

Sets whether to link duplicate streams in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| linkDuplicateStreams | boolean |  true  to link duplicate streams,  false  otherwise. |

##### isAllowReusePageContent()
```
public boolean isAllowReusePageContent()
```

If this property is set to true, the page content will be reused when optimizing the document for identical pages.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if page content is reused,  false  otherwise.
##### setAllowReusePageContent(boolean allowReusePageContent)
```
public void setAllowReusePageContent(boolean allowReusePageContent)
```

Sets whether to allow reusing page content in the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allowReusePageContent | boolean |  true  to allow reusing page content,  false  otherwise. |

##### isRemoveUnusedStreams()
```
public boolean isRemoveUnusedStreams()
```

Sometimes a document contains unused resource streams. These streams are not \\u201cunused objects\\u201d because they are referenced from a page\\u2019s resource dictionary. This may happen in cases where an image has been removed from the page but not from the page resources. Also, this situation often occurs when pages are extracted from the document and document pages have \\u201ccommon\\u201d resources, that is, the same Resources object. Page contents are analyzed in order to determine if a resource stream is used or not. Unused streams are removed. Sometimes this decreases the document size.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if unused streams are removed,  false  otherwise.
##### setRemoveUnusedStreams(boolean removeUnusedStreams)
```
public void setRemoveUnusedStreams(boolean removeUnusedStreams)
```

Sets whether to remove unused streams from the PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeUnusedStreams | boolean |  true  to remove unused streams,  false  otherwise. |

##### isRemoveUnusedObjects()
```
public boolean isRemoveUnusedObjects()
```

A PDF document sometimes contains the PDF objects that are not referenced from any other object in the document. This may happen, for example, when a page is removed from the document page tree but the page object itself isn\\u2019t removed. Removing these objects doesn\\u2019t make the document invalid but rather shrinks it.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if unused objects are removed,  false  otherwise.
##### setRemoveUnusedObjects(boolean removeUnusedObjects)
```
public void setRemoveUnusedObjects(boolean removeUnusedObjects)
```

Sets whether to remove unused objects from the PDF.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| removeUnusedObjects | boolean |  true  to remove unused objects,  false  otherwise. |

### PdfOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/pdfoptions.md

**Inheritance:**
java.lang.Object
```
public class PdfOptions
```

Provides options for rendering PDF documents.

The PdfOptions class encapsulates various settings and parameters that can be used to control the rendering of PDF documents in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PdfOptions options = new PdfOptions();
 options.setDisableCharsGrouping(true);
 options.setRenderTextAsImage(true);
 options.setEnableFontHinting(true);

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 htmlViewOptions.setPdfOptions(options);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfOptions() | Initializes a new instance of  PdfOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| isDisableCopyProtection() | Turns off content copy protection when rendering to HTML. |
| setDisableCopyProtection(boolean disableCopyProtection) | Turns off content copy protection when rendering to HTML. |
| isRenderTextAsImage() | Determines whether the text from the source is rendered as an image in HTML. |
| setRenderTextAsImage(boolean renderTextAsImage) | Sets whether the text from the source is rendered as an image in HTML. |
| isDisableCharsGrouping() | Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. |
| setDisableCharsGrouping(boolean value) | Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. |
| isEnableLayeredRendering() | Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. |
| setEnableLayeredRendering(boolean value) | Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML. |
| isEnableFontHinting() | Determines whether font hinting is enabled. |
| setEnableFontHinting(boolean value) | Enables font hinting. |
| isRenderOriginalPageSize() | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. |
| setRenderOriginalPageSize(boolean renderOriginalPageSize) | Enables rendering of pages with the same size in pixels as the page size in the source PDF document. |
| getImageQuality() | Retrieves the output image quality for image resources when rendering into HTML. |
| setImageQuality(ImageQuality value) | Sets the output image quality for image resources when rendering into HTML. |
| isFixedLayout() | PDF is a fixed format so all of the elements have a specific place on a page. |
| setFixedLayout(boolean fixedLayout) | PDF is a fixed format so all of the elements have a specific place on a page. |
| isWrapImagesInSvg() | Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. |
| setWrapImagesInSvg(boolean wrapImagesInSvg) | Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality. |
| isFixLinkIssue() | Tries to fix the issue when whole HTML page content is a link. |
| setFixLinkIssue(boolean fixLinkIssue) | Tries to fix the issue when whole HTML page content is a link. |
| isAnalyzeFonts() | Replaces fonts as necessary to ensure all characters in the text can be displayed. |
| setAnalyzeFonts(boolean analyzeFonts) | Replaces fonts as necessary to ensure all characters in the text can be displayed. |
| isDisableFontLicenseVerifications() | Disable any license restrictions for all fonts in current XPS/OXPS document. |
| setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications) | Set the flag to disable any license restrictions for all fonts in current XPS/OXPS document. |
##### PdfOptions()
```
public PdfOptions()
```

Initializes a new instance of  PdfOptions  class.

##### isDisableCopyProtection()
```
public boolean isDisableCopyProtection()
```

Turns off content copy protection when rendering to HTML.

When rendering PDF files with protection against copying text and images to HTML, GroupDocs.Viewer adds an 'inert' HTML attribute to the HTML BODY tag. The default value of this option is  false .

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-copy-protection

**Returns:**
boolean
##### setDisableCopyProtection(boolean disableCopyProtection)
```
public void setDisableCopyProtection(boolean disableCopyProtection)
```

Turns off content copy protection when rendering to HTML.

When rendering PDF files with protection against copying text and images to HTML, GroupDocs.Viewer adds an 'inert' HTML attribute to the HTML BODY tag. The default value of this option is  false .

For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-pdf-documents/#disable-copy-protection

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| disableCopyProtection | boolean |  |

##### isRenderTextAsImage()
```
public boolean isRenderTextAsImage()
```

Determines whether the text from the source is rendered as an image in HTML.

When this option is set to  true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML.

***Note:** The default value is  false .*

**Returns:**
boolean -  true  if the text is rendered as an image in HTML,  false  otherwise.
##### setRenderTextAsImage(boolean renderTextAsImage)
```
public void setRenderTextAsImage(boolean renderTextAsImage)
```

Sets whether the text from the source is rendered as an image in HTML.

When this option is set to  true , the text is rendered as an image in the output HTML. Enable this option to make the text unselectable or to fix character rendering and make the HTML look like PDF. This option is supported when rendering into HTML.

***Note:** The default value is  false .*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderTextAsImage | boolean |  true  to render the text as an image in HTML,  false  otherwise. |

##### isDisableCharsGrouping()
```
public final boolean isDisableCharsGrouping()
```

Checks if character grouping is disabled to maintain maximum precision during character positioning when rendering the page. When this option is enabled, the characters are rendered without any grouping, which ensures maximum precision.

***Note:** By default, character grouping is enabled.* When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#disable-character-grouping

**Returns:**
boolean -  true  if character grouping is disabled,  false  otherwise.
##### setDisableCharsGrouping(boolean value)
```
public final void setDisableCharsGrouping(boolean value)
```

Sets the option to disable character grouping, ensuring maximum precision during character positioning when rendering the page. When this option is enabled by setting the value to  true , character grouping is disabled, which ensures maximum precision.

***Note:** Disabling character grouping can help preserve the exact positioning of characters on the rendered page.* When converting PDF files, GroupDocs.Viewer groups individual characters into words for enhanced rendering performance. If your document includes hieroglyphics or special symbols, you might want to prohibit character grouping to ensure a more precise layout. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#disable-character-grouping

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to disable character grouping,  false  to enable it. |

##### isEnableLayeredRendering()
```
public final boolean isEnableLayeredRendering()
```

Checks whether rendering of text and graphics should follow the z-order in the original PDF document when rendering into HTML. When this option is enabled by returning  true , text and graphics are rendered according to their z-order in the original PDF document.

***Note:** By default, text and graphics are rendered into HTML as a single layer.* By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-multi-layer-rendering

**Returns:**
boolean -  true  if layered rendering is enabled,  false  otherwise.
##### setEnableLayeredRendering(boolean value)
```
public final void setEnableLayeredRendering(boolean value)
```

Enables or disables rendering of text and graphics according to the z-order in the original PDF document when rendering into HTML.

***Note:** By default, text and graphics are rendered into HTML as a single layer.* By default, GroupDocs.Veiewer renders text and graphics as a single layer in HTML. This option lets you arrange objects in the same order as in the source file. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-multi-layer-rendering

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable layered rendering,  false  to disable it. |

##### isEnableFontHinting()
```
public final boolean isEnableFontHinting()
```

Determines whether font hinting is enabled. Font hinting adjusts the display of an outline font. This option is supported only for TrueType (TTF) fonts when used in the source document.

***Note:** This option is supported when rendering into PNG or JPG formats.* Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-font-hinting

**Returns:**
boolean -  true  if font hinting is enabled,  false  otherwise.
##### setEnableFontHinting(boolean value)
```
public final void setEnableFontHinting(boolean value)
```

Enables font hinting. Font hinting adjusts the display of an outline font and is supported only for TrueType (TTF) fonts when used in the source document.

***Note:** This option is supported when rendering into PNG or JPG formats.* Font hinting adjusts how an outline font is displayed. Only applicable to TTF fonts used in the source document. This option is available for rendering to PNG or JPG formats. The default value is false. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#enable-font-hinting

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable font hinting,  false  to disable it. |

##### isRenderOriginalPageSize()
```
public boolean isRenderOriginalPageSize()
```

Enables rendering of pages with the same size in pixels as the page size in the source PDF document.

***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is false. This option is available for rendering to PNG or JPG formats. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#preserve-the-size-of-document-pages

**Returns:**
boolean -  true  if the option is enabled,  false  otherwise.
##### setRenderOriginalPageSize(boolean renderOriginalPageSize)
```
public void setRenderOriginalPageSize(boolean renderOriginalPageSize)
```

Enables rendering of pages with the same size in pixels as the page size in the source PDF document.

***Note:** By default, GroupDocs.Viewer calculates the output image page size for better rendering quality.* By default, GroupDocs.Viewer calculates output image page size for better rendering quality. Enable this option to ensure the output pages have the same size as the source PDF document's page size (in pixels). The default value is false. This option is available for rendering to PNG or JPG formats. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#preserve-the-size-of-document-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderOriginalPageSize | boolean |  true  to enable rendering with the original page size,  false  otherwise. |

##### getImageQuality()
```
public final ImageQuality getImageQuality()
```

Retrieves the output image quality for image resources when rendering into HTML. The default value is Low.

When this option is set to true, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is false. This option is available for rendering to HTML. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#render-text-as-an-image

**Returns:**
ImageQuality - the output image quality for image resources when rendering into HTML.
##### setImageQuality(ImageQuality value)
```
public final void setImageQuality(ImageQuality value)
```

Sets the output image quality for image resources when rendering into HTML. The default value is Low.

When this option is set to true, GroupDocs.Viewer renders text as an image in the HTML output. This makes the text unselectable and enhances character rendering, ensuring a PDF-like appearance in HTML. The default value is false. This option is available for rendering to HTML. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#render-text-as-an-image

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ImageQuality | The output image quality for image resources when rendering into HTML. |

##### isFixedLayout()
```
public boolean isFixedLayout()
```

PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to false.

***Note:** The default value is true. This option is supported when rendering into HTML. When rendering to fluid layout images are skipped. Use fluid layout when rendering PDF documents with textual content.* PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document. This option is only available when rendering to HTML. The default value is true. To render with a fluid layout, set this property to false.

Example usage:

```

 try (Viewer viewer = new Viewer("resume.pdf")) {
      HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources("page_{0}.html");
      viewOptions.setFixedLayout(false);
      viewer.view(viewOptions);
 }
 
```

**Returns:**
boolean - true if it is fixed layout
##### setFixedLayout(boolean fixedLayout)
```
public void setFixedLayout(boolean fixedLayout)
```

PDF is a fixed format so all of the elements have a specific place on a page. To ensure that the output HTML looks the same as the source PDF the documents are rendered to HTML with a fixed layout by default. When rendering with fixed layout the output HTML has fixed size so the elements will stay on the same place regardless of window size. To render to HTML with fluid layout set this property to false.

***Note:** The default value is true. This option is supported when rendering into HTML. When rendering to fluid layout images are skipped. Use fluid layout when rendering PDF documents with textual content.* PDF and EPUB documents are initially rendered to HTML with a fixed layout to maintain the appearance of the source document. This fixed layout means all HTML elements have precise positions within a container with a set size. Resizing the browser window is not affect the position and size of elements in the document. This option is only available when rendering to HTML. The default value is true. To render with a fluid layout, set this property to false.

Example usage:

```

 try (Viewer viewer = new Viewer("resume.pdf")) {
      HtmlViewOptions viewOptions = HtmlViewOptions.forEmbeddedResources("page_{0}.html");
      viewOptions.setFixedLayout(false);
      viewer.view(viewOptions);
 }
 
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixedLayout | boolean | true if it is fixed layout |

##### isWrapImagesInSvg()
```
public boolean isWrapImagesInSvg()
```

Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.

This option is supported when rendering [PDF and Page Layout file formats][] to HTML with embedded and external resources.

By default, when rendering to PDF and Page Layout files, all the images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document.

Learn more:

 *  [Render PDF documents as HTML and image files][]
 *  [Render to HTML][]

[PDF and Page Layout file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#pdf-and-page-layout-file-formats
[Render PDF documents as HTML and image files]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
[Render to HTML]: https://docs.groupdocs.com/viewer/java/rendering-to-html/

**Returns:**
boolean -  true  if images are wrapped in SVG,  false  otherwise.
##### setWrapImagesInSvg(boolean wrapImagesInSvg)
```
public void setWrapImagesInSvg(boolean wrapImagesInSvg)
```

Enable this option to wrap each image in the output HTML document in SVG tag to improve output quality.

This option is supported when rendering [PDF and Page Layout file formats][] to HTML with embedded and external resources.

By default, when rendering to PDF and Page Layout files, all the images are rendered as one PNG image. The rendered PNG image is used as the background for the output HTML document.

Learn more:

 *  [Render PDF documents as HTML and image files][]
 *  [Render to HTML][]

[PDF and Page Layout file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/#pdf-and-page-layout-file-formats
[Render PDF documents as HTML and image files]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/
[Render to HTML]: https://docs.groupdocs.com/viewer/java/rendering-to-html/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wrapImagesInSvg | boolean |  true  if images should be wrapped in SVG,  false  otherwise. |

##### isFixLinkIssue()
```
public boolean isFixLinkIssue()
```

Tries to fix the issue when whole HTML page content is a link. Works only when input format is PDF and output format is HTML (with embedded or external resources). By default is disabled (false). Turn it on only when you know what and why you're doing. Turing this option on increases the document processing time.

**Returns:**
boolean
##### setFixLinkIssue(boolean fixLinkIssue)
```
public void setFixLinkIssue(boolean fixLinkIssue)
```

Tries to fix the issue when whole HTML page content is a link. Works only when input format is PDF and output format is HTML (with embedded or external resources). By default is disabled (false). Turn it on only when you know what and why you're doing. Turing this option on increases the document processing time.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fixLinkIssue | boolean | true if the issue should be fixed, false otherwise. |

##### isAnalyzeFonts()
```
public boolean isAnalyzeFonts()
```

Replaces fonts as necessary to ensure all characters in the text can be displayed.

**Returns:**
boolean
##### setAnalyzeFonts(boolean analyzeFonts)
```
public void setAnalyzeFonts(boolean analyzeFonts)
```

Replaces fonts as necessary to ensure all characters in the text can be displayed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| analyzeFonts | boolean | true if the fonts should be displayed, false otherwise. |

##### isDisableFontLicenseVerifications()
```
public boolean isDisableFontLicenseVerifications()
```

Disable any license restrictions for all fonts in current XPS/OXPS document.

Many operations with font can't be executed if these operations are prohibited by the license of this font. For example, some font can't be embedded into a PDF document if the license rules disable embedding for this font. Be careful when using this flag. When it is set, it means that the person who sets this flag takes all responsibility for possible license/law violations on themselves. So they take it on their own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. For code example, see the [documentation][].

Example usage:

```

 try (Viewer viewer = new Viewer("resume.oxps")) {
     HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources("result.html");
     options.getPdfOptions().setDisableFontLicenseVerifications(true);
     viewer.view(options);
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files

**Returns:**
boolean
##### setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications)
```
public void setDisableFontLicenseVerifications(boolean disableFontLicenseVerifications)
```

Set the flag to disable any license restrictions for all fonts in current XPS/OXPS document.

Many operations with font can't be executed if these operations are prohibited by the license of this font. For example, some font can't be embedded into a PDF document if the license rules disable embedding for this font. Be careful when using this flag. When it is set, it means that the person who sets this flag takes all responsibility for possible license/law violations on themselves. So they take it on their own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. For code example, see the [documentation][].

Example usage:

```

 try (Viewer viewer = new Viewer("resume.oxps")) {
     HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources("result.html");
     options.getPdfOptions().setDisableFontLicenseVerifications(true);
     viewer.view(options);
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-pdf-documents/#skip-font-license-verification-when-rendering-xps-and-oxps-files

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| disableFontLicenseVerifications | boolean |  |

### PdfViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/pdfviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions
```
public class PdfViewOptions extends ViewOptions
```

Provides options for rendering documents into PDF format.

The PdfViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PDF format in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setImageHeight(256);
 pdfViewOptions.setImageWidth(128);
 pdfViewOptions.setDefaultFontName("font-name");

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfViewOptions(CreateFileStream createFileStream) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(FileStreamFactory fileStreamFactory) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions() | Initializes a new instance of the  PdfViewOptions  class with default settings. |
| PdfViewOptions(String outputFilePath) | Initializes a new instance of the  PdfViewOptions  class. |
| PdfViewOptions(Path outputFilePath) | Initializes a new instance of the  PdfViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPdfOptimizationOptions() | Reduce output PDF file size applying optimization techniques with different options. |
| setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions) | Reduce output PDF file size applying optimization techniques with different options. |
| getImageMaxWidth() | Retrieves the maximum width of an output image in pixels. |
| setImageMaxWidth(int imageMaxWidth) | Sets the maximum width of an output image in pixels. |
| getImageMaxHeight() | Retrieves the maximum height of an output image in pixels. |
| setImageMaxHeight(int imageMaxHeight) | Sets the maximum height of an output image in pixels. |
| getImageWidth() | Retrieves the width of the output image in pixels. |
| setImageWidth(int imageWidth) | Sets the width of the output image in pixels. |
| getImageHeight() | Retrieves the height of the output image in pixels. |
| setImageHeight(int imageHeight) | Sets the height of the output image in pixels. |
| getSecurity() | Retrieves the security options for the output PDF document. |
| setSecurity(Security value) | Sets the security options for the output PDF document. |
| getDocumentSavingCallback() | Retrieves the callback used to estimate the progress of saving a Words or Email document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback used to estimate the progress of saving a Words or Email document. |
##### PdfViewOptions(CreateFileStream createFileStream)
```
public PdfViewOptions(CreateFileStream createFileStream)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream |  |

##### PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)
```
public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createFileStream | CreateFileStream | The method used to instantiate the stream for writing the output file data. |
| releaseFileStream | ReleaseFileStream | The method used to release the stream created by the  createFileStream  method. |

##### PdfViewOptions(FileStreamFactory fileStreamFactory)
```
public PdfViewOptions(FileStreamFactory fileStreamFactory)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStreamFactory | FileStreamFactory | The factory that implements methods for creating and releasing the output file stream. |

##### PdfViewOptions()
```
public PdfViewOptions()
```

Initializes a new instance of the  PdfViewOptions  class with default settings.

This constructor creates a new  PdfViewOptions  object with "output.pdf" as the file path format for the output file. The output file will be placed into the current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

##### PdfViewOptions(String outputFilePath)
```
public PdfViewOptions(String outputFilePath)
```

Initializes a new instance of the  PdfViewOptions  class.

This constructor creates a new  PdfViewOptions  object with the specified  outputFilePath  parameter representing the path for the output PDF file. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | java.lang.String | The path for the output PDF file. |

##### PdfViewOptions(Path outputFilePath)
```
public PdfViewOptions(Path outputFilePath)
```

Initializes a new instance of the  PdfViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputFilePath | java.nio.file.Path | The path for the output PDF file. |

##### getPdfOptimizationOptions()
```
public PdfOptimizationOptions getPdfOptimizationOptions()
```

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: [Supported document formats][] For details and code samples, see this [page][] and its children.

[Supported document formats]: https://docs.groupdocs.com/viewer/net/supported-document-formats/
[page]: https://docs.groupdocs.com/viewer/net/optimization-pdf-options/

**Returns:**
PdfOptimizationOptions - PdfOptimizationOptions object or null.
##### setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions)
```
public void setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions)
```

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: [Supported document formats][] For details and code samples, see this [page][] and its children.

[Supported document formats]: https://docs.groupdocs.com/viewer/net/supported-document-formats/
[page]: https://docs.groupdocs.com/viewer/net/optimization-pdf-options/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pdfOptimizationOptions | PdfOptimizationOptions | PdfOptimizationOptions object or null. |

##### getImageMaxWidth()
```
public int getImageMaxWidth()
```

Retrieves the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the maximum width of the output image in pixels.
##### setImageMaxWidth(int imageMaxWidth)
```
public void setImageMaxWidth(int imageMaxWidth)
```

Sets the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxWidth | int | The maximum width of the output image in pixels. |

##### getImageMaxHeight()
```
public int getImageMaxHeight()
```

Retrieves the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the maximum height of the output image in pixels.
##### setImageMaxHeight(int imageMaxHeight)
```
public void setImageMaxHeight(int imageMaxHeight)
```

Sets the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageMaxHeight | int | The maximum height of the output image in pixels. |

##### getImageWidth()
```
public int getImageWidth()
```

Retrieves the width of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the width of the output image in pixels.
##### setImageWidth(int imageWidth)
```
public void setImageWidth(int imageWidth)
```

Sets the width of the output image in pixels. This parameter applies only when converting a single image PDF.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageWidth | int | The width of the output image in pixels. |

##### getImageHeight()
```
public int getImageHeight()
```

Retrieves the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Returns:**
int - the height of the output image in pixels.
##### setImageHeight(int imageHeight)
```
public void setImageHeight(int imageHeight)
```

Sets the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-pdf/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageHeight | int | The height of the output image in pixels. |

##### getSecurity()
```
public final Security getSecurity()
```

Retrieves the security options for the output PDF document.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
Security - the security options for the output PDF document.
##### setSecurity(Security value)
```
public final void setSecurity(Security value)
```

Sets the security options for the output PDF document.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Security | The security options for the output PDF document. |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback used to estimate the progress of saving a Words or Email document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback used to estimate the progress of saving a Words or Email document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### Permissions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/permissions.md

**Inheritance:**
java.lang.Object
```
public class Permissions
```

Defines PDF document permissions.

The Permissions class provides constants that represent different permissions that can be applied to a PDF document in the GroupDocs.Viewer component. These permissions control the actions that can be performed on the PDF document, such as printing, copying text, modifying annotations, and more.

Example usage:

```

 int permissions = Permissions.DENY_PRINTING | Permissions.DENY_MODIFICATION;
 final Security security = new Security();
 security.setPermissions(permissions);
 final PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setSecurity(security);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Permissions() |  |
#### Fields

| Field | Description |
| --- | --- |
| ALLOW_ALL | Allow printing, modification, and data extraction. |
| DENY_PRINTING | Deny printing. |
| DENY_MODIFICATION | Deny content modification, filling in forms, adding or modifying annotations. |
| DENY_DATA_EXTRACTION | Deny text and graphics extraction. |
| DENY_ALL | Deny printing, modification, and data extraction. |
##### Permissions()
```
public Permissions()
```

##### ALLOW_ALL
```
public static final int ALLOW_ALL
```

Allow printing, modification, and data extraction.

##### DENY_PRINTING
```
public static final int DENY_PRINTING
```

Deny printing.

##### DENY_MODIFICATION
```
public static final int DENY_MODIFICATION
```

Deny content modification, filling in forms, adding or modifying annotations.

##### DENY_DATA_EXTRACTION
```
public static final int DENY_DATA_EXTRACTION
```

Deny text and graphics extraction.

##### DENY_ALL
```
public static final int DENY_ALL
```

Deny printing, modification, and data extraction.

### PngViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/pngviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class PngViewOptions extends ViewOptions implements IMaxSizeOptions
```

Provides options for rendering documents into PNG format.

The PngViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PNG format in the GroupDocs.Viewer component.

Example usage:

```

 PngViewOptions options = new PngViewOptions();
 options.setHeight(1080);
 options.setWidth(1920);
 options.setRenderComments(true);
 options.setRenderComments(true);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(options);
     // Use the viewer object for further operations
 }
 
```

***Note:** The PngViewOptions class implements the IMaxSizeOptions interface to specify the maximum size of the output PNG images.* For details, see this [page][] and its children.

[page]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/
#### Constructors

| Constructor | Description |
| --- | --- |
| PngViewOptions(CreatePageStream createPageStream) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(PageStreamFactory pageStreamFactory) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions() | Initializes new instance of  PngViewOptions  class. |
| PngViewOptions(String filePathFormat) | Initializes a new instance of the  PngViewOptions  class. |
| PngViewOptions(Path filePathFormat) | Initializes a new instance of the  PngViewOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxWidth() | Returns the maximum width of an output image in pixels. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image in pixels. |
| getMaxHeight() | Returns the maximum height of an output image in pixels. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image in pixels. |
| isExtractText() | Determines whether text extraction is enabled. |
| setExtractText(boolean value) | Enables or disables text extraction. |
| getWidth() | Returns the width of the output image in pixels. |
| setWidth(int value) | Sets the width of the output image in pixels. |
| getHeight() | Returns the height of the output image in pixels. |
| setHeight(int value) | Sets the height of the output image in pixels. |
| getDocumentSavingCallback() | Retrieves the callback for estimating the saving progress of a document. |
| setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback) | Sets the callback for estimating the saving progress of a document. |
##### PngViewOptions(CreatePageStream createPageStream)
```
public PngViewOptions(CreatePageStream createPageStream)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |

##### PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```
public PngViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | The method that instantiates the stream used to write the output page data. |
| releasePageStream | ReleasePageStream | The method that releases the stream created by the method assigned to the createPageStream parameter. |

##### PngViewOptions(PageStreamFactory pageStreamFactory)
```
public PngViewOptions(PageStreamFactory pageStreamFactory)
```

Initializes a new instance of the  PngViewOptions  class.

For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageStreamFactory | PageStreamFactory | The factory that implements methods for creating and releasing the output page stream. |

##### PngViewOptions()
```
public PngViewOptions()
```

Initializes new instance of  PngViewOptions  class.

This constructor initializes new instance of  PngViewOptions  with "p\_\{0\}.png" as file path format for the output files. The output files will be placed into current working directory of the application. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

##### PngViewOptions(String filePathFormat)
```
public PngViewOptions(String filePathFormat)
```

Initializes a new instance of the  PngViewOptions  class.

For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number.

***Note:** It is important to note that the output files will be placed into the current working directory of the application.* For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.lang.String | The file path format, e.g., 'page\_\{0\}.png'. |

##### PngViewOptions(Path filePathFormat)
```
public PngViewOptions(Path filePathFormat)
```

Initializes a new instance of the  PngViewOptions  class.

For example, if the file path format is 'page\_\{0\}.png', the output files will be named as 'page\_1.png', 'page\_2.png', and so on, based on the page number. For the code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/rendering-to-png-or-jpeg/#rendering-to-png

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePathFormat | java.nio.file.Path | The file path format, e.g., 'page\_\{0\}.png'. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Returns the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of the output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image in pixels.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of the output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Returns the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of the output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image in pixels.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of the output image. |

##### isExtractText()
```
public final boolean isExtractText()
```

Determines whether text extraction is enabled.

This option might be useful when you want to add a selectable text layer over the image. Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-get-text-coordinates/

**Returns:**
boolean -  true  if text extraction is enabled,  false  otherwise.
##### setExtractText(boolean value)
```
public final void setExtractText(boolean value)
```

Enables or disables text extraction.

This option might be useful when you want to add a selectable text layer over the image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable text extraction,  false  to disable it. |

##### getWidth()
```
public final int getWidth()
```

Returns the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the width of the output image.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the width of the output image in pixels.

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The width of the output image. |

##### getHeight()
```
public final int getHeight()
```

Returns the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Returns:**
int - the height of the output image.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the height of the output image in pixels.

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/java/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the output image. |

##### getDocumentSavingCallback()
```
public IDocumentSavingCallback getDocumentSavingCallback()
```

Retrieves the callback for estimating the saving progress of a document.

**Returns:**
com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.
##### setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```
public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)
```

Sets the callback for estimating the saving progress of a document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| documentSavingCallback | com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback | The callback to estimate the document saving progress. |

### Position
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/position.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Position extends Enum<Position>
```

Defines watermark position.

The Position enum represents different positions for a watermark in the GroupDocs.Viewer component. It provides a set of predefined positions that can be used to specify the placement of a watermark on a document or image during the rendering process.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| DIAGONAL | The diagonal position. |
| TOP_LEFT | The top left position. |
| TOP_CENTER | The top center position. |
| TOP_RIGHT | The top right position. |
| BOTTOM_LEFT | The bottom left position. |
| BOTTOM_CENTER | The bottom center position. |
| BOTTOM_RIGHT | The bottom right position. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### DIAGONAL
```
public static final Position DIAGONAL
```

The diagonal position. This position represents a diagonal alignment or placement.

##### TOP_LEFT
```
public static final Position TOP_LEFT
```

The top left position. This position represents the top left corner alignment or placement.

##### TOP_CENTER
```
public static final Position TOP_CENTER
```

The top center position. This position represents the top center alignment or placement.

##### TOP_RIGHT
```
public static final Position TOP_RIGHT
```

The top right position. This position represents the top right corner alignment or placement.

##### BOTTOM_LEFT
```
public static final Position BOTTOM_LEFT
```

The bottom left position. This position represents the bottom left corner alignment or placement.

##### BOTTOM_CENTER
```
public static final Position BOTTOM_CENTER
```

The bottom center position. This position represents the bottom center alignment or placement.

##### BOTTOM_RIGHT
```
public static final Position BOTTOM_RIGHT
```

The bottom right position. This position represents the bottom right corner alignment or placement.

##### values()
```
public static Position[] values()
```

**Returns:**
com.groupdocs.viewer.options.Position[]
##### valueOf(String name)
```
public static Position valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Position

### PresentationOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/presentationoptions.md

**Inheritance:**
java.lang.Object
```
public class PresentationOptions
```

Provides options for rendering presentations options.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| isRenderToPureHtml() | Enables a new HTML rendering mode for Presentation documents. |
| setRenderToPureHtml(boolean renderToPureHtml) | Enables a new HTML rendering mode for Presentation documents. |
| getResolution() | Resolution for images inside presentation (for to HTML/PDF rendering only). |
| setResolution(Resolution resolution) | Resolution for images inside presentation (for to HTML/PDF rendering only). |
##### PresentationOptions()
```
public PresentationOptions()
```

##### isRenderToPureHtml()
```
public boolean isRenderToPureHtml()
```

Enables a new HTML rendering mode for Presentation documents.

In this mode, the Presentation files are rendered to pure HTML/CSS markup, without SVG images. By default, this feature is disabled (false). Existing SVG-based HTML renderer is used if this option is not enabled.

**Returns:**
boolean
##### setRenderToPureHtml(boolean renderToPureHtml)
```
public void setRenderToPureHtml(boolean renderToPureHtml)
```

Enables a new HTML rendering mode for Presentation documents.

In this mode, the Presentation files are rendered to pure HTML/CSS markup, without SVG images. By default, this feature is disabled (false). Existing SVG-based HTML renderer is used if this option is not enabled.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderToPureHtml | boolean |  |

##### getResolution()
```
public Resolution getResolution()
```

Resolution for images inside presentation (for to HTML/PDF rendering only).

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#specify-image-resolution

**Returns:**
com.groupdocs.viewer.options.Resolution
##### setResolution(Resolution resolution)
```
public void setResolution(Resolution resolution)
```

Resolution for images inside presentation (for to HTML/PDF rendering only).

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-presentations/#specify-image-resolution

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resolution | com.groupdocs.viewer.options.Resolution |  |

### ProjectManagementOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/projectmanagementoptions.md

**Inheritance:**
java.lang.Object
```
public class ProjectManagementOptions
```

Provides options for rendering project management files.

The ProjectManagementOptions class encapsulates various settings and parameters that can be used to control the rendering of project management files (such as Microsoft Project or similar) in the GroupDocs.Viewer component. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 ProjectManagementOptions projectManagementOptions = pngViewOptions.getProjectManagementOptions();
 projectManagementOptions.setPageSize(PageSize.A4);
 projectManagementOptions.setStartDate(new Date(2021, 11, 23));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/
#### Constructors

| Constructor | Description |
| --- | --- |
| ProjectManagementOptions() | Initializes a new instance of the  ProjectManagementOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() | Retrieves the output page size. |
| setPageSize(PageSize value) | Sets the output page size. |
| getTimeUnit() | Retrieves the time unit. |
| setTimeUnit(TimeUnit value) | Retrieves the time unit. |
| getStartDate() | Retrieves the start date of the Gantt Chart View to be included in the output. |
| setStartDate(Date value) | Sets the start date of the Gantt Chart View to be included in the output. |
| getEndDate() | Retrieves the end date of the Gantt Chart View to be included in the output. |
| setEndDate(Date value) | Sets the end date of the Gantt Chart View to be included in the output. |
##### ProjectManagementOptions()
```
public ProjectManagementOptions()
```

Initializes a new instance of the  ProjectManagementOptions  class.

##### getPageSize()
```
public final PageSize getPageSize()
```

Retrieves the output page size.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#specify-the-output-page-size

**Returns:**
PageSize - the output page size.
##### setPageSize(PageSize value)
```
public final void setPageSize(PageSize value)
```

Sets the output page size.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#specify-the-output-page-size

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PageSize | The output page size. |

##### getTimeUnit()
```
public final TimeUnit getTimeUnit()
```

Retrieves the time unit.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

**Returns:**
TimeUnit - the time unit.
##### setTimeUnit(TimeUnit value)
```
public final void setTimeUnit(TimeUnit value)
```

Retrieves the time unit.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TimeUnit | The time unit. |

##### getStartDate()
```
public final Date getStartDate()
```

Retrieves the start date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Returns:**
java.util.Date - the start date of the Gantt Chart View.
##### setStartDate(Date value)
```
public final void setStartDate(Date value)
```

Sets the start date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The start date of the Gantt Chart View. |

##### getEndDate()
```
public final Date getEndDate()
```

Retrieves the end date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Returns:**
java.util.Date - the end date of the Gantt Chart View.
##### setEndDate(Date value)
```
public final void setEndDate(Date value)
```

Sets the end date of the Gantt Chart View to be included in the output.

***Note:** Use this option when you need to render a specific time interval of the project within the Gantt Chart View.* For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#render-specific-dates

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.Date | The end date of the Gantt Chart View. |

### Resolution
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/resolution.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Resolution extends Enum<Resolution>
```

Provides option to set resolution for images : output document.
#### Fields

| Field | Description |
| --- | --- |
| DPI_330 | Good quality for high-definition (HD) displays. |
| DPI_220 | Excellent quality on most printers and screens. |
| DPI_150 | Good for web pages and projectors. |
| DPI_96 | Good for web pages and projectors. |
| DPI_72 | Default compression level. |
| DOCUMENT_RESOLUTION | Default compression level - as the document. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| getValue() | Quality DPI. |
| getSlidesPicturesResolution() | Get Aspose.Slides pictures resolution from options Resolution class. |
##### DPI_330
```
public static final Resolution DPI_330
```

Good quality for high-definition (HD) displays.

##### DPI_220
```
public static final Resolution DPI_220
```

Excellent quality on most printers and screens.

##### DPI_150
```
public static final Resolution DPI_150
```

Good for web pages and projectors.

##### DPI_96
```
public static final Resolution DPI_96
```

Good for web pages and projectors.

##### DPI_72
```
public static final Resolution DPI_72
```

Default compression level.

##### DOCUMENT_RESOLUTION
```
public static final Resolution DOCUMENT_RESOLUTION
```

Default compression level - as the document.

##### values()
```
public static Resolution[] values()
```

**Returns:**
com.groupdocs.viewer.options.Resolution[]
##### valueOf(String name)
```
public static Resolution valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
com.groupdocs.viewer.options.Resolution
##### getValue()
```
public int getValue()
```

Quality DPI.

**Returns:**
int
##### getSlidesPicturesResolution()
```
public int getSlidesPicturesResolution()
```

Get Aspose.Slides pictures resolution from options Resolution class.

**Returns:**
int

### Rotation
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/rotation.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum Rotation extends Enum<Rotation>
```

Contains page rotation in degrees (clockwise).

The Rotation enum represents different rotation angles for a page in the GroupDocs.Viewer component. It provides a set of predefined rotation options that can be used to specify the rotation angle for rendering a page in various document viewing or conversion scenarios.

Example usage:

```

 PdfViewOptions pdfViewOptions = new PdfViewOptions();

 pdfViewOptions.rotatePage(1, Rotation.ON_90_DEGREE);
 pdfViewOptions.rotatePage(2, Rotation.ON_180_DEGREE);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Fields

| Field | Description |
| --- | --- |
| ON_90_DEGREE | The 90 degree page rotation. |
| ON_180_DEGREE | The 180 degree page rotation. |
| ON_270_DEGREE | The 270 degree page rotation. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### ON_90_DEGREE
```
public static final Rotation ON_90_DEGREE
```

The 90 degree page rotation. This rotation represents a 90-degree clockwise rotation of the page.

##### ON_180_DEGREE
```
public static final Rotation ON_180_DEGREE
```

The 180 degree page rotation. This rotation represents a 180-degree clockwise rotation of the page.

##### ON_270_DEGREE
```
public static final Rotation ON_270_DEGREE
```

The 270 degree page rotation. This rotation represents a 270-degree clockwise rotation of the page.

##### values()
```
public static Rotation[] values()
```

**Returns:**
com.groupdocs.viewer.options.Rotation[]
##### valueOf(String name)
```
public static Rotation valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
Rotation

### SearchHighlightOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/searchhighlightoptions.md

**Inheritance:**
java.lang.Object
```
public final class SearchHighlightOptions
```

Provides options for searching and highlighting text in the documents, loaded to the Viewer class.
#### Constructors

| Constructor | Description |
| --- | --- |
| SearchHighlightOptions() |  |
| SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor) |  |
#### Methods

| Method | Description |
| --- | --- |
| isSearchTermRegEx() |  |
| setSearchTermRegEx(boolean searchTermRegEx) |  |
| getSearchTerm() |  |
| setSearchTerm(String searchTerm) |  |
| getBackgroundColor() |  |
| setBackgroundColor(Argb32Color backgroundColor) |  |
| getForegroundColor() |  |
| setForegroundColor(Argb32Color foregroundColor) |  |
##### SearchHighlightOptions()
```
public SearchHighlightOptions()
```

##### SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
```
public SearchHighlightOptions(String searchTerm, boolean searchTermRegEx, Argb32Color backgroundColor, Argb32Color foregroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTerm | java.lang.String |  |
| searchTermRegEx | boolean |  |
| backgroundColor | com.groupdocs.viewer.drawing.Argb32Color |  |
| foregroundColor | com.groupdocs.viewer.drawing.Argb32Color |  |

##### isSearchTermRegEx()
```
public boolean isSearchTermRegEx()
```

**Returns:**
boolean
##### setSearchTermRegEx(boolean searchTermRegEx)
```
public void setSearchTermRegEx(boolean searchTermRegEx)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTermRegEx | boolean |  |

##### getSearchTerm()
```
public String getSearchTerm()
```

**Returns:**
java.lang.String
##### setSearchTerm(String searchTerm)
```
public void setSearchTerm(String searchTerm)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchTerm | java.lang.String |  |

##### getBackgroundColor()
```
public Argb32Color getBackgroundColor()
```

**Returns:**
com.groupdocs.viewer.drawing.Argb32Color
##### setBackgroundColor(Argb32Color backgroundColor)
```
public void setBackgroundColor(Argb32Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| backgroundColor | com.groupdocs.viewer.drawing.Argb32Color |  |

##### getForegroundColor()
```
public Argb32Color getForegroundColor()
```

**Returns:**
com.groupdocs.viewer.drawing.Argb32Color
##### setForegroundColor(Argb32Color foregroundColor)
```
public void setForegroundColor(Argb32Color foregroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| foregroundColor | com.groupdocs.viewer.drawing.Argb32Color |  |

### Security
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/security.md

**Inheritance:**
java.lang.Object
```
public class Security
```

Provides PDF document security options.

The Security class encapsulates various settings and options that can be used to apply security measures to a PDF document in the GroupDocs.Viewer component. These options include password protection, permissions, and more. For details, see the [documentation][].

Example usage:

```

 Security security = new Security();
 security.setDocumentOpenPassword("myPassword");
 security.setPermissions(Permissions.DENY_MODIFICATION);

 final PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setSecurity(security);

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| Security() | Initializes a new instance of the  Security  class. |
#### Methods

| Method | Description |
| --- | --- |
| getDocumentOpenPassword() | Gets the password required to open the PDF document. |
| setDocumentOpenPassword(String value) | Sets the password required to open the PDF document. |
| getPermissionsPassword() | Gets the password required to change permission settings. |
| setPermissionsPassword(String value) | Sets the password required to change permission settings. |
| getPermissions() | Gets the PDF document permissions such as printing, modification, and data extraction. |
| setPermissions(int value) | Sets the PDF document permissions such as printing, modification, and data extraction. |
##### Security()
```
public Security()
```

Initializes a new instance of the  Security  class.

##### getDocumentOpenPassword()
```
public final String getDocumentOpenPassword()
```

Gets the password required to open the PDF document.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
java.lang.String - the document open password.
##### setDocumentOpenPassword(String value)
```
public final void setDocumentOpenPassword(String value)
```

Sets the password required to open the PDF document.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The document open password. |

##### getPermissionsPassword()
```
public final String getPermissionsPassword()
```

Gets the password required to change permission settings.

Using a permissions password, you can restrict printing, modification, and data extraction. Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
java.lang.String - the permissions password.
##### setPermissionsPassword(String value)
```
public final void setPermissionsPassword(String value)
```

Sets the password required to change permission settings.

Using a permissions password, you can restrict printing, modification, and data extraction. Use a permissions password to restrict printing, modification and data extraction. For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The permissions password. |

##### getPermissions()
```
public final int getPermissions()
```

Gets the PDF document permissions such as printing, modification, and data extraction.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Returns:**
int - the PDF document permissions.
##### setPermissions(int value)
```
public final void setPermissions(int value)
```

Sets the PDF document permissions such as printing, modification, and data extraction.

For code sample, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/protect-pdf-documents/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The PDF document permissions. |

### Size
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/size.md

**Inheritance:**
java.lang.Object
```
public class Size
```

Contains the watermark size.

The Size class represents the size of a watermark in the GroupDocs.Viewer component. It provides options to specify the dimensions of the watermark, such as width and height.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Size(byte relativeSize) | Initializes a new instance of the  Size  class. |
#### Fields

| Field | Description |
| --- | --- |
| FULL_SIZE | Represents the maximum size of watermark text that fits the page. |
| HALF_SIZE | Represents half of the maximum size of watermark text that fits the page. |
| ONE_THIRD | Represents one third of the maximum size of watermark text that fits the page. |
#### Methods

| Method | Description |
| --- | --- |
| getRelativeSize() | Returns the watermark text size in percentages in relation to the page width. |
##### Size(byte relativeSize)
```
public Size(byte relativeSize)
```

Initializes a new instance of the  Size  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| relativeSize | byte | The size in percentages in relation to the page size. |

##### FULL_SIZE
```
public static final Size FULL_SIZE
```

Represents the maximum size of watermark text that fits the page.

##### HALF_SIZE
```
public static final Size HALF_SIZE
```

Represents half of the maximum size of watermark text that fits the page.

##### ONE_THIRD
```
public static final Size ONE_THIRD
```

Represents one third of the maximum size of watermark text that fits the page.

##### getRelativeSize()
```
public final byte getRelativeSize()
```

Returns the watermark text size in percentages in relation to the page width.

**Returns:**
byte - the watermark text size in percentages.

### SpreadsheetOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/spreadsheetoptions.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetOptions
```

Provides options for rendering spreadsheets.

The SpreadsheetOptions class encapsulates various settings and parameters that can be used to control the rendering of spreadsheet files (such as Excel or CSV files) in the GroupDocs.Viewer component. For details, see children of the [Render spreadsheet files][] topic.

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 SpreadsheetOptions spreadsheetOptions = pngViewOptions.getSpreadsheetOptions();
 spreadsheetOptions.setRenderHeadings(true);
 spreadsheetOptions.setCountColumnsPerPage(24);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[Render spreadsheet files]: https://docs.groupdocs.com/viewer/java/render-spreadsheets/
#### Methods

| Method | Description |
| --- | --- |
| isRenderByPageBreaks() | Determines whether the worksheet should be rendered by page breaks. |
| setRenderByPageBreaks(boolean renderByPageBreaks) | Sets whether the worksheet should be rendered by page breaks. |
| isDetectSeparator() | Detects the separator for CSV/TSV files. |
| setDetectSeparator(boolean detectSeparator) | Sets whether to detect the separator for CSV/TSV files. |
| forOnePagePerSheet() | Creates a new instance of  SpreadsheetOptions  class for rendering one sheet into one page. |
| forSplitSheetIntoPages(int countRowsPerPage) | Creates a new instance of  SpreadsheetOptions  class for rendering a sheet into multiple pages. |
| forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage) | Initializes a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages. |
| forRenderingPrintArea() | Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. |
| isOnePagePerSheet() | Indicates whether one sheet is rendered into one page. |
| getCountRowsPerPage() | Gets the count of rows to include into each page when splitting the worksheet into pages. |
| getCountColumnsPerPage() | Gets the count of columns to include into each page when splitting the worksheet into pages. |
| setCountColumnsPerPage(int countColumnsPerPage) | Sets the count of columns to include into each page when splitting the worksheet into pages. |
| isRenderPrintAreaOnly() | Indicates whether only the print areas are rendered. |
| isRenderingPrintAreaAndPageBreaks() | When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area. |
| setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks) | Sets whether to render a worksheet by page breaks that fall within the print area. |
| isRenderGridLines() | Enables rendering of grid lines. |
| setRenderGridLines(boolean value) | Enables or disables the rendering of grid lines. |
| isSkipEmptyRows() | Indicates whether empty rows should be skipped during rendering. |
| setSkipEmptyRows(boolean value) | Sets whether empty rows should be skipped during rendering. |
| isSkipEmptyColumns() | Indicates whether empty columns should be skipped during rendering. |
| setSkipEmptyColumns(boolean value) | Sets whether empty columns should be skipped during rendering. |
| isRenderHiddenRows() | Determines whether hidden rows should be rendered. |
| setRenderHiddenRows(boolean value) | Sets whether hidden rows should be rendered. |
| isRenderHeadings() | Checks if headings rendering is enabled. |
| setRenderHeadings(boolean renderHeadings) | Enables headings rendering. |
| isRenderHiddenColumns() | Enables hidden columns rendering. |
| setRenderHiddenColumns(boolean value) | Enables hidden columns rendering. |
| getTextOverflowMode() | Returns the text overflow mode for rendering spreadsheet documents into HTML. |
| setTextOverflowMode(TextOverflowMode value) | Sets the text overflow mode for rendering spreadsheet documents into HTML. |
| getLeftMargin() | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| setLeftMargin(double leftMargin) | To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used |
| getRightMargin() | To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setRightMargin(double rightMargin) | To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| getTopMargin() | To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setTopMargin(double topMargin) | To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| getBottomMargin() | To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| setBottomMargin(double bottomMargin) | To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. |
| forRenderingPrintAreaAndPageBreaks() | Initializes a new instance of  SpreadsheetOptions  for rendering print areas and page breaks. |
| forRenderingByPageBreaks() | Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. |
##### isRenderByPageBreaks()
```
public boolean isRenderByPageBreaks()
```

Determines whether the worksheet should be rendered by page breaks.

***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.*

**Returns:**
boolean -  true  if the worksheet should be rendered by page breaks,  false  otherwise.
##### setRenderByPageBreaks(boolean renderByPageBreaks)
```
public void setRenderByPageBreaks(boolean renderByPageBreaks)
```

Sets whether the worksheet should be rendered by page breaks.

***Note:** This option controls the rendering behavior of the worksheet, similar to printing a spreadsheet in Excel.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderByPageBreaks | boolean |  true  if the worksheet should be rendered by page breaks,  false  otherwise. |

##### isDetectSeparator()
```
public boolean isDetectSeparator()
```

Detects the separator for CSV/TSV files.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator

**Returns:**
boolean -  true  if the separator should be automatically detected,  false  otherwise.
##### setDetectSeparator(boolean detectSeparator)
```
public void setDetectSeparator(boolean detectSeparator)
```

Sets whether to detect the separator for CSV/TSV files.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-excel-and-apple-numbers-spreadsheets/#detect-a-csvtsv-separator

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| detectSeparator | boolean |  true  to automatically detect the separator,  false  otherwise. |

##### forOnePagePerSheet()
```
public static SpreadsheetOptions forOnePagePerSheet()
```

Creates a new instance of  SpreadsheetOptions  class for rendering one sheet into one page.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-a-worksheet-on-one-page

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  class for rendering one sheet into one page.
##### forSplitSheetIntoPages(int countRowsPerPage)
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage)
```

Creates a new instance of  SpreadsheetOptions  class for rendering a sheet into multiple pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | int | The number of rows to include in each page. |

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  for rendering a sheet into pages.
##### forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)
```
public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage, int countColumnsPerPage)
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countRowsPerPage | int | The number of rows to include on each page. |
| countColumnsPerPage | int | The number of columns to include on each page. |

**Returns:**
SpreadsheetOptions - a new instance of the  SpreadsheetOptions  class for rendering a sheet into pages.
##### forRenderingPrintArea()
```
public static SpreadsheetOptions forRenderingPrintArea()
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-a-print-area

**Returns:**
SpreadsheetOptions - a new instance of the  SpreadsheetOptions  class for rendering print areas only.
##### isOnePagePerSheet()
```
public final boolean isOnePagePerSheet()
```

Indicates whether one sheet is rendered into one page.

**Returns:**
boolean -  true  if one sheet is rendered into one page;  false  otherwise.
##### getCountRowsPerPage()
```
public final int getCountRowsPerPage()
```

Gets the count of rows to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows

**Returns:**
int - the count of rows to include into each page.
##### getCountColumnsPerPage()
```
public int getCountColumnsPerPage()
```

Gets the count of columns to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns

**Returns:**
int - the count of columns to include into each page.
##### setCountColumnsPerPage(int countColumnsPerPage)
```
public void setCountColumnsPerPage(int countColumnsPerPage)
```

Sets the count of columns to include into each page when splitting the worksheet into pages.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#split-a-worksheet-into-pages-by-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| countColumnsPerPage | int | The count of columns to include into each page. |

##### isRenderPrintAreaOnly()
```
public final boolean isRenderPrintAreaOnly()
```

Indicates whether only the print areas are rendered.

**Returns:**
boolean -  true  if only the print areas are rendered,  false  otherwise.
##### isRenderingPrintAreaAndPageBreaks()
```
public boolean isRenderingPrintAreaAndPageBreaks()
```

When this option is enabled, a worksheet will be rendered by page breaks that fall within the print area.

**Returns:**
boolean
##### setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
```
public void setRenderingPrintAreaAndPageBreaks(boolean renderingPrintAreaAndPageBreaks)
```

Sets whether to render a worksheet by page breaks that fall within the print area.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderingPrintAreaAndPageBreaks | boolean | Set to true to enable, false to disable. |

##### isRenderGridLines()
```
public final boolean isRenderGridLines()
```

Enables rendering of grid lines.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-worksheet-gridlines

**Returns:**
boolean -  true  if grid lines are enabled,  false  otherwise.
##### setRenderGridLines(boolean value)
```
public final void setRenderGridLines(boolean value)
```

Enables or disables the rendering of grid lines.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-worksheet-gridlines

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable grid lines rendering,  false  to disable it. |

##### isSkipEmptyRows()
```
public final boolean isSkipEmptyRows()
```

Indicates whether empty rows should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Returns:**
boolean -  true  if empty rows should be skipped,  false  otherwise.
##### setSkipEmptyRows(boolean value)
```
public final void setSkipEmptyRows(boolean value)
```

Sets whether empty rows should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to skip empty rows,  false  otherwise. |

##### isSkipEmptyColumns()
```
public final boolean isSkipEmptyColumns()
```

Indicates whether empty columns should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Returns:**
boolean -  true  if empty columns are skipped,  false  otherwise.
##### setSkipEmptyColumns(boolean value)
```
public final void setSkipEmptyColumns(boolean value)
```

Sets whether empty columns should be skipped during rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#skip-empty-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to skip empty columns,  false  otherwise. |

##### isRenderHiddenRows()
```
public final boolean isRenderHiddenRows()
```

Determines whether hidden rows should be rendered.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Returns:**
boolean -  true  if hidden rows should be rendered,  false  otherwise.
##### setRenderHiddenRows(boolean value)
```
public final void setRenderHiddenRows(boolean value)
```

Sets whether hidden rows should be rendered.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable rendering of hidden rows,  false  to disable it. |

##### isRenderHeadings()
```
public boolean isRenderHeadings()
```

Checks if headings rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-row-and-column-headings

**Returns:**
boolean -  true  if headings rendering is enabled,  false  otherwise.
##### setRenderHeadings(boolean renderHeadings)
```
public void setRenderHeadings(boolean renderHeadings)
```

Enables headings rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-row-and-column-headings

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderHeadings | boolean |  true  to enable headings rendering,  false  to disable. |

##### isRenderHiddenColumns()
```
public final boolean isRenderHiddenColumns()
```

Enables hidden columns rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Returns:**
boolean -  true  if hidden columns rendering is enabled,  false  otherwise.
##### setRenderHiddenColumns(boolean value)
```
public final void setRenderHiddenColumns(boolean value)
```

Enables hidden columns rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#render-hidden-rows-and-columns

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable hidden columns rendering,  false  to disable. |

##### getTextOverflowMode()
```
public final TextOverflowMode getTextOverflowMode()
```

Returns the text overflow mode for rendering spreadsheet documents into HTML.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

**Returns:**
TextOverflowMode - the text overflow mode.
##### setTextOverflowMode(TextOverflowMode value)
```
public final void setTextOverflowMode(TextOverflowMode value)
```

Sets the text overflow mode for rendering spreadsheet documents into HTML. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TextOverflowMode | The text overflow mode to be set. |

##### getLeftMargin()
```
public double getLeftMargin()
```

To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used

If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setLeftMargin(double leftMargin)
```
public void setLeftMargin(double leftMargin)
```

To set left margin of the worksheet when converting to pdf if less than 0 then default convert value is used

If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftMargin | double |  |

##### getRightMargin()
```
public double getRightMargin()
```

To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setRightMargin(double rightMargin)
```
public void setRightMargin(double rightMargin)
```

To set right margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rightMargin | double |  |

##### getTopMargin()
```
public double getTopMargin()
```

To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setTopMargin(double topMargin)
```
public void setTopMargin(double topMargin)
```

To set top margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topMargin | double |  |

##### getBottomMargin()
```
public double getBottomMargin()
```

To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Returns:**
double
##### setBottomMargin(double bottomMargin)
```
public void setBottomMargin(double bottomMargin)
```

To set bottom margin of the worksheet when converting to pdf if less than 0 then default convert value is used If the parameter is less than 0, then the default value is used. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#set-worksheet-margins-in-the-output-pdf-pages

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bottomMargin | double |  |

##### forRenderingPrintAreaAndPageBreaks()
```
public static SpreadsheetOptions forRenderingPrintAreaAndPageBreaks()
```

Initializes a new instance of  SpreadsheetOptions  for rendering print areas and page breaks. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/#render-worksheet-by-page-breaks-and-print-area

**Returns:**
SpreadsheetOptions - New instance of  SpreadsheetOptions  for rendering pages based on page breaks that are included into print area. The behavior is similar to printing in Excel.
##### forRenderingByPageBreaks()
```
public static SpreadsheetOptions forRenderingByPageBreaks()
```

Initializes a new instance of the  SpreadsheetOptions  class for rendering print areas only. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/split-worksheet-into-pages/

**Returns:**
SpreadsheetOptions - a new instance of  SpreadsheetOptions  for rendering print areas only. The behavior is similar to printing in Excel, where the worksheet is rendered by page breaks.

### TextOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/textoptions.md

**Inheritance:**
java.lang.Object
```
public class TextOptions
```

Text files splitting to pages options.

The TextOptions class provides options for splitting text files into pages in the GroupDocs.Viewer component. It allows you to control how text files are divided into individual pages for rendering and viewing purposes.

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 TextOptions options = pngViewOptions.getTextOptions();
 options.setMaxCharsPerRow(96);
 options.setMaxRowsPerPage(48);

 try (Viewer viewer = new Viewer("document.txt")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| TextOptions() | Initializes a new instance of the  TextOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getMaxCharsPerRow() | Gets the maximum number of characters per row on a page. |
| setMaxCharsPerRow(int maxCharsPerRow) | Sets the maximum number of characters per row on a page. |
| getMaxRowsPerPage() | Gets the maximum number of rows per page. |
| setMaxRowsPerPage(int maxRowsPerPage) | Sets the maximum number of rows per page. |
##### TextOptions()
```
public TextOptions()
```

Initializes a new instance of the  TextOptions  class.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

##### getMaxCharsPerRow()
```
public int getMaxCharsPerRow()
```

Gets the maximum number of characters per row on a page.

***Note:** The default value is 85.* The default value is 85. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Returns:**
int - the maximum number of characters per row on a page.
##### setMaxCharsPerRow(int maxCharsPerRow)
```
public void setMaxCharsPerRow(int maxCharsPerRow)
```

Sets the maximum number of characters per row on a page.

***Note:** The default value is 85.* The default value is 85. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxCharsPerRow | int | The maximum number of characters per row on a page. |

##### getMaxRowsPerPage()
```
public int getMaxRowsPerPage()
```

Gets the maximum number of rows per page.

***Note:** The default value is 55.* The default value is 55. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Returns:**
int - the maximum number of rows.
##### setMaxRowsPerPage(int maxRowsPerPage)
```
public void setMaxRowsPerPage(int maxRowsPerPage)
```

Sets the maximum number of rows per page.

***Note:** The default value is 55.* The default value is 55. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-text-files/#specify-rendering-options

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxRowsPerPage | int | The maximum number of rows. |

### TextOverflowMode
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/textoverflowmode.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum TextOverflowMode extends Enum<TextOverflowMode>
```

Defines text overflow mode for rendering spreadsheet documents into HTML.

The TextOverflowMode enum represents different modes for handling text overflow in the GroupDocs.Viewer component. It provides a set of predefined options that can be used to control how text is displayed when it exceeds the available space in cells during the rendering of spreadsheet documents into HTML. For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();

 htmlViewOptions.setSpreadsheetOptions(SpreadsheetOptions.forOnePagePerSheet());
 htmlViewOptions.getSpreadsheetOptions().setTextOverflowMode(TextOverflowMode.HIDE_TEXT);

 try (Viewer viewer = new Viewer("document.xlsx")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow
#### Fields

| Field | Description |
| --- | --- |
| OVERLAY | Overlay next cells even if they are not empty. |
| OVERLAY_IF_NEXT_IS_EMPTY | Overlay next cells only if they are empty. |
| AUTO_FIT_COLUMN | Expand columns to fit the text. |
| HIDE_TEXT | Hide the overflow text. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### OVERLAY
```
public static final TextOverflowMode OVERLAY
```

Overlay next cells even if they are not empty. This mode allows the text to overflow into the adjacent cells, regardless of their content.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### OVERLAY_IF_NEXT_IS_EMPTY
```
public static final TextOverflowMode OVERLAY_IF_NEXT_IS_EMPTY
```

Overlay next cells only if they are empty. This mode allows the text to overflow into the adjacent cells only if those cells are empty.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### AUTO_FIT_COLUMN
```
public static final TextOverflowMode AUTO_FIT_COLUMN
```

Expand columns to fit the text. This mode automatically adjusts the width of the columns to accommodate the overflowing text.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### HIDE_TEXT
```
public static final TextOverflowMode HIDE_TEXT
```

Hide the overflow text. This mode hides the overflowing text, preventing it from being displayed.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-rendering-options/#control-cell-text-overflow

##### values()
```
public static TextOverflowMode[] values()
```

**Returns:**
com.groupdocs.viewer.options.TextOverflowMode[]
##### valueOf(String name)
```
public static TextOverflowMode valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TextOverflowMode

### Tile
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/tile.md

**Inheritance:**
java.lang.Object
```
public class Tile
```

Represents drawing region.

The Tile class represents a drawing region in the GroupDocs.Viewer component. It is used to define a specific area or region within a document that needs to be rendered or processed separately. For details, see the [documentation][].

Example usage:

```

 Tile tile = new Tile(100, 100, 200, 200);

 PngViewOptions pngViewOptions = new PngViewOptions();
 pngViewOptions.getCadOptions().setTiles(Arrays.asList(tile));

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles
#### Constructors

| Constructor | Description |
| --- | --- |
| Tile(int startPointX, int startPointY, int width, int height) | Initializes a new instance of the  Tile  class. |
#### Methods

| Method | Description |
| --- | --- |
| getStartPointX() | Gets the X coordinate of the lowest left point on the drawing where the tile begins. |
| getStartPointY() | Gets the Y coordinate of the lowest left point on the drawing where the tile begins. |
| getWidth() | Gets the width of the tile in pixels. |
| getHeight() | Gets the height of the tile in pixels. |
| getEndPointX() | Returns the X coordinate of the highest right point on the drawing where the tile ends. |
| getEndPointY() | Returns the Y coordinate of the highest right point on the drawing where the tile ends. |
##### Tile(int startPointX, int startPointY, int width, int height)
```
public Tile(int startPointX, int startPointY, int width, int height)
```

Initializes a new instance of the  Tile  class.

This constructor creates a new tile object with the specified starting point, width, and height. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startPointX | int | The X coordinate of the lowest left point on the drawing where the tile begins. |
| startPointY | int | The Y coordinate of the lowest left point on the drawing where the tile begins. |
| width | int | The width of the tile in pixels. |
| height | int | The height of the tile in pixels. |

##### getStartPointX()
```
public final int getStartPointX()
```

Gets the X coordinate of the lowest left point on the drawing where the tile begins.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the X coordinate of the lowest left point.
##### getStartPointY()
```
public final int getStartPointY()
```

Gets the Y coordinate of the lowest left point on the drawing where the tile begins.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the Y coordinate of the lowest left point.
##### getWidth()
```
public final int getWidth()
```

Gets the width of the tile in pixels.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the width of the tile.
##### getHeight()
```
public final int getHeight()
```

Gets the height of the tile in pixels.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/specify-cad-rendering-options/#split-a-drawing-into-tiles

**Returns:**
int - the height of the tile.
##### getEndPointX()
```
public final int getEndPointX()
```

Returns the X coordinate of the highest right point on the drawing where the tile ends.

**Returns:**
int - the X coordinate of the highest right point.
##### getEndPointY()
```
public final int getEndPointY()
```

Returns the Y coordinate of the highest right point on the drawing where the tile ends.

**Returns:**
int - the Y coordinate of the highest right point.

### TimeUnit
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/timeunit.md

**Inheritance:**
java.lang.Object, java.lang.Enum
```
public enum TimeUnit extends Enum<TimeUnit>
```

Time unit of the project duration.

The TimeUnit enum represents different time units for specifying the duration of a project in the GroupDocs.Viewer component. It provides a set of predefined time units that can be used to represent and calculate the duration of a project, such as days, months and so on. For details, see the [documentation][].

Example usage:

```

 HtmlViewOptions pdfViewOptions = HtmlViewOptions.forEmbeddedResources();
 ProjectManagementOptions projectManagementOptions = pdfViewOptions.getProjectManagementOptions();
 projectManagementOptions.setTimeUnit(TimeUnit.MONTHS);

 try (Viewer viewer = new Viewer("document.mpp")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit
#### Fields

| Field | Description |
| --- | --- |
| UNSPECIFIED | The unknown time scale. |
| DAYS | Days time scale. |
| THIRDS_OF_MONTHS | Thirds of months time scale. |
| MONTHS | Months time scale. |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
##### UNSPECIFIED
```
public static final TimeUnit UNSPECIFIED
```

The unknown time scale. This time unit represents an unknown or unspecified time scale.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### DAYS
```
public static final TimeUnit DAYS
```

Days time scale. This time unit represents a one-day interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### THIRDS_OF_MONTHS
```
public static final TimeUnit THIRDS_OF_MONTHS
```

Thirds of months time scale. This time unit represents a one-third of the month interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### MONTHS
```
public static final TimeUnit MONTHS
```

Months time scale. This time unit represents a one-month interval.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-ms-project-files/#adjust-the-time-unit

##### values()
```
public static TimeUnit[] values()
```

**Returns:**
com.groupdocs.viewer.options.TimeUnit[]
##### valueOf(String name)
```
public static TimeUnit valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
TimeUnit

### ViewInfoOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/viewinfooptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions

**All Implemented Interfaces:**
com.groupdocs.viewer.options.IMaxSizeOptions
```
public class ViewInfoOptions extends BaseViewOptions implements IMaxSizeOptions
```

Provides options used for retrieving information about view.

The ViewInfoOptions class encapsulates additional settings and parameters that can be used to retrieve information about a view in the GroupDocs.Viewer component.

Example usage:

```

 ViewInfoOptions viewInfoOptions = ViewInfoOptions.forPngView(false);
 try (Viewer viewer = new Viewer("document.pdf")) {
     ViewInfo viewInfo = viewer.getViewInfo(viewInfoOptions);
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The ViewInfoOptions class implements the IMaxSizeOptions interface to provide additional settings and size constraints for view information retrieval.*
#### Methods

| Method | Description |
| --- | --- |
| isExtractText() | Indicates whether text extraction is enabled. |
| setExtractText(boolean extractText) | Sets the flag indicating whether text extraction is enabled. |
| getMaxWidth() | Returns the maximum width of the output image for rendering to PNG/JPG. |
| setMaxWidth(int maxWidth) | Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only). |
| getMaxHeight() | Returns the maximum height of the output image for rendering to PNG/JPG. |
| setMaxHeight(int maxHeight) | Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only). |
| getWidth() | The width of the output image (in pixels, for rendering to PNG/JPG only). |
| setWidth(int width) | The width of the output image (in pixels, for rendering to PNG/JPG only). |
| getHeight() | The height of the output image (in pixels, for rendering to PNG/JPG only). |
| setHeight(int height) | The height of the output image (in pixels, for rendering to PNG/JPG only). |
| forHtmlView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML. |
| forHtmlView(boolean renderSinglePage) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML. |
| forJpgView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG. |
| forJpgView(boolean extractText) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG. |
| forPngView() | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG. |
| forPngView(boolean extractText) | Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG. |
| forPdfView() | Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF. |
| fromHtmlViewOptions(HtmlViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the HtmlViewOptions object. |
| fromPngViewOptions(PngViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the PngViewOptions object. |
| fromJpgViewOptions(JpgViewOptions options) | Initializes a new instance of the  ViewInfoOptions  class based on the JpgViewOptions object. |
| fromPdfViewOptions(PdfViewOptions options) | Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object. |
##### isExtractText()
```
public boolean isExtractText()
```

Indicates whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/

**Returns:**
boolean - True if text extraction is enabled, false otherwise.
##### setExtractText(boolean extractText)
```
public void setExtractText(boolean extractText)
```

Sets the flag indicating whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-get-text-coordinates/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | True to enable text extraction, false to disable. |

##### getMaxWidth()
```
public int getMaxWidth()
```

Returns the maximum width of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum width of the output image.
##### setMaxWidth(int maxWidth)
```
public void setMaxWidth(int maxWidth)
```

Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image width (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxWidth | int | The maximum width of the output image. |

##### getMaxHeight()
```
public int getMaxHeight()
```

Returns the maximum height of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Returns:**
int - the maximum height of the output image.
##### setMaxHeight(int maxHeight)
```
public void setMaxHeight(int maxHeight)
```

Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image height (in pixels). For code example, see the [documentation][]. If you set the  property, this property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/set-image-size-limits-when-rendering-to-png-jpg/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxHeight | int | The maximum height of the output image. |

##### getWidth()
```
public int getWidth()
```

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Returns:**
int - the width of the image.
##### setWidth(int width)
```
public void setWidth(int width)
```

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | The width of the image. |

##### getHeight()
```
public int getHeight()
```

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Returns:**
int - the height of the image.
##### setHeight(int height)
```
public void setHeight(int height)
```

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the [documentation][]. If you set this property, the  property is ignored.

[documentation]: https://docs.groupdocs.com/viewer/net/image-viewer-adjust-image-size/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | The height of the image. |

##### forHtmlView()
```
public static ViewInfoOptions forHtmlView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML.

**Returns:**
ViewInfoOptions - New instance of the  ViewInfoOptions  class.
##### forHtmlView(boolean renderSinglePage)
```
public static ViewInfoOptions forHtmlView(boolean renderSinglePage)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into HTML.

***Note:** By default, HTML content will be rendered on multiple pages.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderSinglePage | boolean | Enables HTML content to be rendered on a single page. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forJpgView()
```
public static ViewInfoOptions forJpgView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG.

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forJpgView(boolean extractText)
```
public static ViewInfoOptions forJpgView(boolean extractText)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into JPG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | Enables text extraction. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPngView()
```
public static ViewInfoOptions forPngView()
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG.

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPngView(boolean extractText)
```
public static ViewInfoOptions forPngView(boolean extractText)
```

Initializes a new instance of the  ViewInfoOptions  class to retrieve information about the view when rendering into PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extractText | boolean | Enables text extraction. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### forPdfView()
```
public static ViewInfoOptions forPdfView()
```

Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF.

**Returns:**
ViewInfoOptions - A new instance of the ViewInfoOptions class.
##### fromHtmlViewOptions(HtmlViewOptions options)
```
public static ViewInfoOptions fromHtmlViewOptions(HtmlViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the HtmlViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | HtmlViewOptions | The HTML view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromPngViewOptions(PngViewOptions options)
```
public static ViewInfoOptions fromPngViewOptions(PngViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the PngViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PngViewOptions | The PNG view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromJpgViewOptions(JpgViewOptions options)
```
public static ViewInfoOptions fromJpgViewOptions(JpgViewOptions options)
```

Initializes a new instance of the  ViewInfoOptions  class based on the JpgViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | JpgViewOptions | The JPG view options. |

**Returns:**
ViewInfoOptions - New instance of  ViewInfoOptions  class.
##### fromPdfViewOptions(PdfViewOptions options)
```
public static ViewInfoOptions fromPdfViewOptions(PdfViewOptions options)
```

Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | PdfViewOptions | The PDF view options. |

**Returns:**
ViewInfoOptions - A new instance of the ViewInfoOptions class.

### ViewOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/viewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions
```
public abstract class ViewOptions extends BaseViewOptions
```

Contains the rendering options.

The ViewOptions class extends the BaseViewOptions class and serves as a base class for rendering options in the GroupDocs.Viewer component. It encapsulates common settings and parameters that can be used for rendering various types of documents into different formats.

***Note:** The ViewOptions class should not be used directly, use HtmlViewOptions, PdfViewOptions, PngViewOptions and so on instead.*
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewOptions() |  |
#### Methods

| Method | Description |
| --- | --- |
| getWatermark() | Gets the text watermark applied to each page. |
| setWatermark(Watermark value) | Sets the text watermark to be applied to each page. |
| rotatePage(int pageNumber, Rotation rotation) | Applies a clockwise rotation to the specified page. |
| getPageRotations() | Retrieves the page rotations. |
| isPageRotationsInitialized_Internal() | To prevent creating the instance just to check that it is empty |
##### ViewOptions()
```
public ViewOptions()
```

##### getWatermark()
```
public final Watermark getWatermark()
```

Gets the text watermark applied to each page.

In case both \#setWatermark(Watermark).setWatermark(Watermark) and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/add-text-watermark/

**Returns:**
Watermark - the text watermark applied to each page.
##### setWatermark(Watermark value)
```
public final void setWatermark(Watermark value)
```

Sets the text watermark to be applied to each page.

In case both  ViewOptions.Watermark  and \#getPageRotations().getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/add-text-watermark/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Watermark | The text watermark to be set. |

##### rotatePage(int pageNumber, Rotation rotation)
```
public final void rotatePage(int pageNumber, Rotation rotation)
```

Applies a clockwise rotation to the specified page.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/flip-or-rotate-pages/

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int | The page number, must be strictly greater than 0. |
| rotation | Rotation | The rotation value. |

##### getPageRotations()
```
public Map<Integer,Rotation> getPageRotations()
```

Retrieves the page rotations.

If both setWatermark(Watermark) and  getPageRotations()  are specified, the watermark will be applied to the rotated pages. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/flip-or-rotate-pages/

**Returns:**
java.util.Map<java.lang.Integer,com.groupdocs.viewer.options.Rotation> - a map containing the page numbers as keys and their corresponding rotations as values.
##### isPageRotationsInitialized_Internal()
```
public boolean isPageRotationsInitialized_Internal()
```

To prevent creating the instance just to check that it is empty

**Returns:**
boolean

### VisioRenderingOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/visiorenderingoptions.md

**Inheritance:**
java.lang.Object
```
public class VisioRenderingOptions
```

Contains options for rendering Visio documents.

The VisioRenderingOptions class provides options for processing and rendering Visio files in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for Visio documents. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 VisioRenderingOptions visioRenderingOptions = pngViewOptions.getVisioRenderingOptions();
 visioRenderingOptions.setRenderFiguresOnly(true);

 try (Viewer viewer = new Viewer(visioDocument)) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| VisioRenderingOptions() | Initializes a new instance of the  VisioRenderingOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| isRenderFiguresOnly() | Render only Visio figures, excluding the diagram. |
| setRenderFiguresOnly(boolean renderFiguresOnly) | Sets the flag to render only Visio figures, excluding the diagram. |
| getFigureWidth() | Retrieves the width of the figure. |
| setFigureWidth(int figureWidth) | Sets the width of the figure. |
##### VisioRenderingOptions()
```
public VisioRenderingOptions()
```

Initializes a new instance of the  VisioRenderingOptions  class.

##### isRenderFiguresOnly()
```
public boolean isRenderFiguresOnly()
```

Render only Visio figures, excluding the diagram.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/#render-only-diagram-shapes

**Returns:**
boolean -  true  if only Visio figures should be rendered,  false  otherwise.
##### setRenderFiguresOnly(boolean renderFiguresOnly)
```
public void setRenderFiguresOnly(boolean renderFiguresOnly)
```

Sets the flag to render only Visio figures, excluding the diagram.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/java/render-visio-documents/#render-only-diagram-shapes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| renderFiguresOnly | boolean |  true  to render only Visio figures,  false  to include the diagram. |

##### getFigureWidth()
```
public int getFigureWidth()
```

Retrieves the width of the figure. The height will be calculated automatically.

**Returns:**
int - the width of the figure.
##### setFigureWidth(int figureWidth)
```
public void setFigureWidth(int figureWidth)
```

Sets the width of the figure. The height will be calculated automatically.

***Note:** Default value is 100.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| figureWidth | int | The width of the figure. |

### Watermark
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/watermark.md

**Inheritance:**
java.lang.Object
```
public class Watermark
```

Represents a text watermark. For details, see the [documentation][].

The Watermark class represents a text watermark in the GroupDocs.Viewer component. It is used to define and apply a watermark to the rendered output of documents.

Example usage:

```

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/add-text-watermark/
#### Constructors

| Constructor | Description |
| --- | --- |
| Watermark(String text) | Initializes a new instance of the  Watermark  class. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Returns the watermark text. |
| getColor() | Returns the watermark color. |
| getColorAsHex() | Returns the watermark color in hex format. |
| setColor(Color value) | Sets the watermark color. |
| setColor(String colorName) | Sets the watermark color. |
| getPosition() | Returns the watermark position. |
| setPosition(Position value) | Sets the watermark position. |
| getSize() | Returns the watermark size. |
| setSize(Size value) | Sets the watermark size. |
| getFontName() | Returns the font name used for the watermark. |
| setFontName(String value) | Sets the font name used for the watermark. |
##### Watermark(String text)
```
public Watermark(String text)
```

Initializes a new instance of the  Watermark  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The watermark text. |

##### getText()
```
public final String getText()
```

Returns the watermark text. This method retrieves the text of the watermark applied to the document.

**Returns:**
java.lang.String - the watermark text.
##### getColor()
```
public final Color getColor()
```

Returns the watermark color. This method retrieves the color of the watermark applied to the document.

***Note:** The default value is the red color obtained from Color\#getRed().getRed().*

**Returns:**
java.awt.Color - the watermark color.
##### getColorAsHex()
```
public final String getColorAsHex()
```

Returns the watermark color in hex format. This method retrieves the color of the watermark applied to the document.

***Note:** The default value is the red color obtained from Color\#getRed().getRed().*

**Returns:**
java.lang.String - the watermark color in hex format.
##### setColor(Color value)
```
public final void setColor(Color value)
```

Sets the watermark color. This method sets the color of the watermark applied to the document.

***Note:** The default value is obtained from Color\#getRed().getRed().*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.awt.Color | The watermark color to set. |

##### setColor(String colorName)
```
public final void setColor(String colorName)
```

Sets the watermark color. This method sets the color of the watermark applied to the document.

***Note:** The default value is obtained from Color\#getRed().getRed().*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| colorName | java.lang.String | The watermark color to set. |

##### getPosition()
```
public final Position getPosition()
```

Returns the watermark position. This method returns the position of the watermark applied to the document.

***Note:** The default value is Position.DIAGONAL.*

**Returns:**
Position - the watermark position.
##### setPosition(Position value)
```
public final void setPosition(Position value)
```

Sets the watermark position. This method sets the position of the watermark applied to the document.

***Note:** The default value is Position.DIAGONAL.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Position | The watermark position. |

##### getSize()
```
public final Size getSize()
```

Returns the watermark size. This method retrieves the size of the watermark applied to the document.

***Note:** The default value is Size.FULL\_SIZE.*

**Returns:**
Size - the watermark size.
##### setSize(Size value)
```
public final void setSize(Size value)
```

Sets the watermark size. This method sets the size of the watermark to be applied to the document.

***Note:** The default value is Size.FULL\_SIZE.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Size | The watermark size. |

##### getFontName()
```
public final String getFontName()
```

Returns the font name used for the watermark.

**Returns:**
java.lang.String - the font name used for the watermark.
##### setFontName(String value)
```
public final void setFontName(String value)
```

Sets the font name used for the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font name used for the watermark. |

### WordProcessingOptions
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.options/wordprocessingoptions.md

**Inheritance:**
java.lang.Object
```
public class WordProcessingOptions
```

Provides options for rendering word processing documents.

The WordProcessingOptions class provides options for rendering word processing documents in the GroupDocs.Viewer component. It encapsulates settings and parameters that can be used to control the rendering process and output format for word processing files. For details, see the [documentation][].

Example usage:

```

 PngViewOptions pngViewOptions = new PngViewOptions();
 WordProcessingOptions wordProcessingOptions = pngViewOptions.getWordProcessingOptions();
 wordProcessingOptions.setRenderTrackedChanges(true);
 wordProcessingOptions.setLeftMargin(32f);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pngViewOptions);
     // Use the viewer object for further operations
 }
 
```

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingOptions() | Initializes a new instance of the  WordProcessingOptions  class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageSize() | Retrieves the page size for rendering HTM and HTML files. |
| setPageSize(PageSize pageSize) | Sets the page size for rendering HTM and HTML files. |
| isRenderTrackedChanges() | Indicates whether tracked changes (revisions) rendering is enabled. |
| setRenderTrackedChanges(boolean value) | Sets whether tracked changes (revisions) rendering is enabled. |
| getLeftMargin() | Retrieves the left page margin for HTML rendering. |
| setLeftMargin(Double leftMargin) | Sets the left page margin for HTML rendering. |
| getRightMargin() | Gets the right page margin for HTML rendering. |
| setRightMargin(Double rightMargin) | Sets the right page margin for HTML rendering. |
| getTopMargin() | Retrieves the top page margin for HTML rendering. |
| setTopMargin(Double topMargin) | Sets the top page margin for HTML rendering. |
| getBottomMargin() | Bottom page margin (for HTML rendering only) |
| setBottomMargin(Double bottomMargin) | Sets the bottom page margin for HTML rendering. |
| isEnableOpenTypeFeatures() | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. |
| setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures) | This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts. |
| isUnlinkTableOfContents() | Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF. |
| setUnlinkTableOfContents(boolean unlinkTableOfContents) | Sets whether table of contents navigation should be disabled when rendering to HTML or PDF. |
| isUpdateFields() | Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. |
| setUpdateFields(boolean updateFields) | Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. |
| equals(Object o) | Check if the options are changed. |
| hashCode() | \{@inheritDoc\} |
##### WordProcessingOptions()
```
public WordProcessingOptions()
```

Initializes a new instance of the  WordProcessingOptions  class. Contains options for rendering word processing documents. For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

##### getPageSize()
```
public PageSize getPageSize()
```

Retrieves the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

***Note:** The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.*

**Returns:**
PageSize - The size of the output page.
##### setPageSize(PageSize pageSize)
```
public void setPageSize(PageSize pageSize)
```

Sets the page size for rendering HTM and HTML files.

When using the default page size, some content may not fit into the page frame. To fit the contents, you can set a larger page size, such as A3, using PageSize.A3.

***Note:** The default value is PageSize.UNSPECIFIED, which means that a page size set in the page settings (Page Setup) will be used.*

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageSize | PageSize | The size of the output page. |

##### isRenderTrackedChanges()
```
public final boolean isRenderTrackedChanges()
```

Indicates whether tracked changes (revisions) rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

**Returns:**
boolean -  true  if tracked changes rendering is enabled,  false  otherwise.
##### setRenderTrackedChanges(boolean value)
```
public final void setRenderTrackedChanges(boolean value)
```

Sets whether tracked changes (revisions) rendering is enabled.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#render-tracked-changes

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  true  to enable tracked changes rendering,  false  to disable it. |

##### getLeftMargin()
```
public Double getLeftMargin()
```

Retrieves the left page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the left page margin value.
##### setLeftMargin(Double leftMargin)
```
public void setLeftMargin(Double leftMargin)
```

Sets the left page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| leftMargin | java.lang.Double | The left page margin value to set. |

##### getRightMargin()
```
public Double getRightMargin()
```

Gets the right page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the right page margin value.
##### setRightMargin(Double rightMargin)
```
public void setRightMargin(Double rightMargin)
```

Sets the right page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rightMargin | java.lang.Double | The right page margin value to set. |

##### getTopMargin()
```
public Double getTopMargin()
```

Retrieves the top page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the top page margin.
##### setTopMargin(Double topMargin)
```
public void setTopMargin(Double topMargin)
```

Sets the top page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| topMargin | java.lang.Double | The top page margin to set. |

##### getBottomMargin()
```
public Double getBottomMargin()
```

Bottom page margin (for HTML rendering only)

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Returns:**
java.lang.Double - the bottom page margin.
##### setBottomMargin(Double bottomMargin)
```
public void setBottomMargin(Double bottomMargin)
```

Sets the bottom page margin for HTML rendering.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#define-page-margins

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| bottomMargin | java.lang.Double | The bottom page margin to set. |

##### isEnableOpenTypeFeatures()
```
public boolean isEnableOpenTypeFeatures()
```

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

**Returns:**
boolean - True if OpenType features are enabled, false otherwise.
##### setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)
```
public void setEnableOpenTypeFeatures(boolean enableOpenTypeFeatures)
```

This option enables kerning and other OpenType Features when rendering Arabic, Hebrew, Indian scripts, Latin-based or Cyrillic-based scripts.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| enableOpenTypeFeatures | boolean | True to enable OpenType features, false otherwise. |

##### isUnlinkTableOfContents()
```
public boolean isUnlinkTableOfContents()
```

Indicates whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

**Returns:**
boolean - True if table of content navigation is disabled; otherwise, false.
##### setUnlinkTableOfContents(boolean unlinkTableOfContents)
```
public void setUnlinkTableOfContents(boolean unlinkTableOfContents)
```

Sets whether table of contents navigation should be disabled when rendering to HTML or PDF. When this option is set to true, for HTML rendering, relative links from the table of contents will be replaced with span tags, removing functionality but preserving visual appearance. For PDF rendering, the table of contents will be rendered as plain text without links.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| unlinkTableOfContents | boolean | Indicates whether table of content navigation should be disabled. |

##### isUpdateFields()
```
public boolean isUpdateFields()
```

Gets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true \\u2014 fields will be updated before saving.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#disable-updating-fields-when-saving

**Returns:**
boolean
##### setUpdateFields(boolean updateFields)
```
public void setUpdateFields(boolean updateFields)
```

Sets a value determining if fields of certain types should be updated before saving the input WordProcessing document to the HTML, PDF, PNG, or JPEG output formats. Default value for this property is true \\u2014 fields will be updated before saving.

For details, see the [documentation][].

[documentation]: https://docs.groupdocs.com/viewer/net/render-word-documents/#disable-updating-fields-when-saving

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updateFields | boolean |  |

##### equals(Object o)
```
public boolean equals(Object o)
```

Check if the options are changed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| o | java.lang.Object | The object to compare for equality. |

**Returns:**
boolean -  true  if the options are equal to the specified object,  false  otherwise.
##### hashCode()
```
public int hashCode()
```

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

**Note:** This method overrides the default implementation of the hashCode() method defined in the Object class.

**Returns:**
int - the hash code value for this object.

### com.groupdocs.viewer.results
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results.md

The package provides classes and interfaces that represent document rendering results.

These classes encapsulate information about various elements and components of the rendered document, such as pages, attachments, views, resources, and more.

The main classes in this package are:

 *  Page - Represents a single page that can be viewed.
 *  Attachment - Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file.
 *  PdfViewInfo - Represents view information for a PDF document.

For more details on working with document rendering results using GroupDocs.Viewer, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| Resource | Represents HTML resource such as font, style, image or graphics. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ArchiveViewInfo | Represents view information for an archive file. |
| Attachment | Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file. |
| CadViewInfo | Represents view information for a CAD drawing. |
| Character | Represents a relatively positioned rectangle that contains a single character. |
| FileInfo | Contains information about a file. |
| Layer | Represents a layer contained by a CAD drawing. |
| Layout | Represents a layout contained by a CAD drawing. |
| Line | Represents a relatively positioned rectangle that contains a single line. |
| LotusNotesViewInfo | Represents view information for Lotus Notes database storage. |
| OutlookViewInfo | Represents view information for an Outlook Data file. |
| Page | Represents a single page that can be viewed. |
| PdfViewInfo | Represents view information for a PDF document. |
| ProjectManagementViewInfo | Represents view information for an MS Project document. |
| TextElement<T> | Represents a generic text element. |
| ViewInfo | Represents view information for a generic document. |
| Word | Represents a relatively positioned rectangle that contains a single word. |

### ArchiveViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/archiveviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface ArchiveViewInfo extends ViewInfo
```

Represents view information for an archive file.

The ArchiveViewInfo interface defines the contract for retrieving view information specific to an archive file in the GroupDocs.Viewer component. It provides methods to access details such as page count, dimensions, and rendering options specific to archive files.

Example usage:

```

 try (Viewer viewer = new Viewer("document.zip")) {
     ArchiveViewInfo viewInfo = (ArchiveViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());

     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is ArchiveViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getFolders() | Retrieves the list of folders contained within the archive file. |
| setFolders(List<String> folders) | Sets the list of folders contained within the archive file. |
##### getFolders()
```
public abstract List<String> getFolders()
```

Retrieves the list of folders contained within the archive file.

**Returns:**
java.util.List<java.lang.String> - the list of folders.
##### setFolders(List<String> folders)
```
public abstract void setFolders(List<String> folders)
```

Sets the list of folders contained within the archive file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folders | java.util.List<java.lang.String> | the list of folders. |

### Attachment
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/attachment.md

### CadViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/cadviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface CadViewInfo extends ViewInfo
```

Represents view information for a CAD drawing.

The CadViewInfo interface defines the contract for retrieving view information specific to a CAD drawing in the GroupDocs.Viewer component. It provides methods to access to CAD drawings layers.

Example usage:

```

 try (Viewer viewer = new Viewer("document.plt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());

     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is CadViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getLayers() | Retrieves the list of layers in the CAD drawing. |
| setLayers(List<Layer> layers) | Sets the list of layers in the CAD drawing. |
| getLayouts() | Retrieves the list of layouts contained within the CAD drawing. |
| setLayouts(List<Layout> layouts) | Sets the list of layouts contained within the CAD drawing. |
##### getLayers()
```
public abstract List<Layer> getLayers()
```

Retrieves the list of layers in the CAD drawing.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layer> - the layers in the CAD drawing.
##### setLayers(List<Layer> layers)
```
public abstract void setLayers(List<Layer> layers)
```

Sets the list of layers in the CAD drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layers | java.util.List<com.groupdocs.viewer.results.Layer> | the layers to set for the CAD drawing. |

##### getLayouts()
```
public abstract List<Layout> getLayouts()
```

Retrieves the list of layouts contained within the CAD drawing.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Layout> - the layouts in the CAD drawing.
##### setLayouts(List<Layout> layouts)
```
public abstract void setLayouts(List<Layout> layouts)
```

Sets the list of layouts contained within the CAD drawing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| layouts | java.util.List<com.groupdocs.viewer.results.Layout> | the layouts to set for the CAD drawing. |

### Character
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/character.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Character extends TextElement<Character>, Serializable
```

Represents a relatively positioned rectangle that contains a single character.

The Character interface defines the contract for accessing and manipulating a character represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the character itself, position, and size of the rectangle.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List characters = viewInfo.getPages().get(0).getLines().get(0).getWords().get(0).getCharacters();
     Character character = characters.get(0);

     // Use the character object for further operations
 }
 
```

***Note:** The default implementation of this interface is CharacterImpl.*

### FileInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/fileinfo.md

### Layer
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/layer.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Layer extends Serializable
```

Represents a layer contained by a CAD drawing.

The Layer interface defines the contract for accessing and manipulating a layer within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layer name, visibility, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List layers = viewInfo.getLayers();
     for (Layer layer : layers) {
         // Use the layer object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LayerImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the layer. |
| setName(String name) | Sets the name of the layer. |
| isVisible() | Checks the visibility of the layer. |
| setVisible(boolean isVisible) | Sets the visibility of the layer. |
| equals(Object other) | Checks if this object is equal to the provided object. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the layer.

**Note:** Layer names are case sensitive.

**Returns:**
java.lang.String - the name of the layer.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the layer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The new name for the layer. |

##### isVisible()
```
public abstract boolean isVisible()
```

Checks the visibility of the layer.

The CAD drawing layers that are switched off or frozen are invisible. To render layers that are invisible, use the CadOptions.setLayers(List) option.

**Returns:**
boolean -  true  if the layer is visible,  false  otherwise.
##### setVisible(boolean isVisible)
```
public abstract void setVisible(boolean isVisible)
```

Sets the visibility of the layer.

If  true , the layer will be visible; if  false , it will be hidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isVisible | boolean | Whether the layer should be visible or not. |

##### equals(Object other)
```
public abstract boolean equals(Object other)
```

Checks if this object is equal to the provided object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | The object to compare. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.

### Layout
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/layout.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Layout extends Serializable
```

Represents a layout contained by a CAD drawing.

The Layout interface defines the contract for accessing and manipulating a layout within a CAD drawing in the GroupDocs.Viewer component. It provides methods to retrieve information such as the layout name, dimensions, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpt")) {
     CadViewInfo viewInfo = (CadViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List layouts = viewInfo.getLayouts();
     for (Layout layout : layouts) {
         // Use the layout object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LayoutImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the layout. |
| setName(String name) | Sets the name of the layout. |
| getWidth() | Retrieves the width of the layout. |
| setWidth(double width) | Sets the width of the layout. |
| getHeight() | Retrieves the height of the layout. |
| setHeight(double height) | Sets the height of the layout. |
| equals(Object other) | Checks if this object is equal to the provided object. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the layout.

**Returns:**
java.lang.String - the name of the layout.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | The name to set for the layout. |

##### getWidth()
```
public abstract double getWidth()
```

Retrieves the width of the layout.

**Returns:**
double - the width of the layout.
##### setWidth(double width)
```
public abstract void setWidth(double width)
```

Sets the width of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | double | The width to set for the layout. |

##### getHeight()
```
public abstract double getHeight()
```

Retrieves the height of the layout.

**Returns:**
double - the height of the layout.
##### setHeight(double height)
```
public abstract void setHeight(double height)
```

Sets the height of the layout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | double | The height to set for the layout. |

##### equals(Object other)
```
public abstract boolean equals(Object other)
```

Checks if this object is equal to the provided object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | java.lang.Object | The object to compare. |

**Returns:**
boolean -  true  if the objects are equal,  false  otherwise.

### Line
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/line.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Line extends TextElement<String>, Serializable
```

Represents a relatively positioned rectangle that contains a single line.

The Line interface defines the contract for accessing and manipulating a line represented by a rectangle in the GroupDocs.Viewer component. It provides methods to retrieve information such as the line text, position, and size of the rectangle.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List lines = viewInfo.getPages().get(0).getLines();
     for (Line line : lines) {
         // Use the line object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is LineImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getWords() | Retrieves the words contained in the line. |
| setWords(List<Word> wordList) | Sets the words contained in the line. |
##### getWords()
```
public abstract List<Word> getWords()
```

Retrieves the words contained in the line.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Word> - the words contained in the line.
##### setWords(List<Word> wordList)
```
public abstract void setWords(List<Word> wordList)
```

Sets the words contained in the line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| wordList | java.util.List<com.groupdocs.viewer.results.Word> | the words contained in the line. |

### LotusNotesViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/lotusnotesviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface LotusNotesViewInfo extends ViewInfo
```

Represents view information for Lotus Notes database storage.

The LotusNotesViewInfo interface defines the contract for accessing and manipulating view information for Lotus Notes database storage in the GroupDocs.Viewer component. It provides methods to retrieve information such as notes count, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.nsf")) {
     final LotusNotesViewInfo viewInfo = (LotusNotesViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is LotusNotesViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getNotesCount() | Retrieves the count of notes in the storage. |
| setNotesCount(int count) | Sets the count of notes in the storage. |
##### getNotesCount()
```
public abstract int getNotesCount()
```

Retrieves the count of notes in the storage.

**Returns:**
int - the count of notes in the storage.
##### setNotesCount(int count)
```
public abstract void setNotesCount(int count)
```

Sets the count of notes in the storage.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| count | int | the count of notes in the storage. |

### OutlookViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/outlookviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface OutlookViewInfo extends ViewInfo
```

Represents view information for an Outlook Data file.

The OutlookViewInfo interface defines the contract for accessing and manipulating view information for an Outlook Data file in the GroupDocs.Viewer component. It provides methods to retrieve information such as a list of folders, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pst")) {
     final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is OutlookViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getFolders() | Retrieves the list of folders contained in the Outlook Data file. |
| setFolders(List<String> list) | Sets the list of folders contained in the Outlook Data file. |
##### getFolders()
```
public abstract List<String> getFolders()
```

Retrieves the list of folders contained in the Outlook Data file.

**Returns:**
java.util.List<java.lang.String> - the list of folders.
##### setFolders(List<String> list)
```
public abstract void setFolders(List<String> list)
```

Sets the list of folders contained in the Outlook Data file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| list | java.util.List<java.lang.String> | the list of folders. |

### Page
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/page.md

**All Implemented Interfaces:**
java.io.Serializable
```
public interface Page extends Serializable
```

Represents a single page that can be viewed.

The Page interface defines the contract for accessing and manipulating a single page that can be viewed in the GroupDocs.Viewer component. It provides methods to retrieve information such as the page number, size, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pst")) {
     final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List pages = viewInfo.getPages();
     for (Page page : pages) {
         // Use the page object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is PageImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getName() | Retrieves the name of the worksheet or page. |
| setName(String name) | Sets the name of the worksheet or page. |
| getNumber() | Retrieves the page number. |
| setNumber(int number) | Sets the page number. |
| isVisible() | Retrieves the page visibility indicator. |
| setVisible(boolean visible) | Sets the page visibility indicator. |
| getWidth() | Retrieves the width of the page in pixels when viewing as JPG or PNG. |
| setWidth(int width) | Sets the width of the page in pixels when viewing as JPG or PNG. |
| getHeight() | Retrieves the height of the page in pixels when viewing as JPG or PNG. |
| setHeight(int height) | Sets the height of the page in pixels when viewing as JPG or PNG. |
| getLines() | Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. |
| setLines(List<Line> lines) | Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction. |
##### getName()
```
public abstract String getName()
```

Retrieves the name of the worksheet or page.

**Returns:**
java.lang.String - the name of the worksheet or page.
##### setName(String name)
```
public abstract void setName(String name)
```

Sets the name of the worksheet or page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String | the name to set for the worksheet or page. |

##### getNumber()
```
public abstract int getNumber()
```

Retrieves the page number.

**Returns:**
int - the page number.
##### setNumber(int number)
```
public abstract void setNumber(int number)
```

Sets the page number.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| number | int | the page number to set. |

##### isVisible()
```
public abstract boolean isVisible()
```

Retrieves the page visibility indicator.

**Returns:**
boolean - the page visibility indicator.
##### setVisible(boolean visible)
```
public abstract void setVisible(boolean visible)
```

Sets the page visibility indicator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visible | boolean | true if the page is visible, false otherwise. |

##### getWidth()
```
public abstract int getWidth()
```

Retrieves the width of the page in pixels when viewing as JPG or PNG.

**Returns:**
int - the width of the page.
##### setWidth(int width)
```
public abstract void setWidth(int width)
```

Sets the width of the page in pixels when viewing as JPG or PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int | the width to set for the page. |

##### getHeight()
```
public abstract int getHeight()
```

Retrieves the height of the page in pixels when viewing as JPG or PNG.

**Returns:**
int - the height of the page.
##### setHeight(int height)
```
public abstract void setHeight(int height)
```

Sets the height of the page in pixels when viewing as JPG or PNG.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| height | int | the height to set for the page. |

##### getLines()
```
public abstract List<Line> getLines()
```

Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Line> - the lines contained in the page.
##### setLines(List<Line> lines)
```
public abstract void setLines(List<Line> lines)
```

Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| lines | java.util.List<com.groupdocs.viewer.results.Line> | the list of lines to set for the page. |

### PdfViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/pdfviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface PdfViewInfo extends ViewInfo
```

Represents view information for a PDF document.

The PdfViewInfo interface defines the contract for accessing and manipulating view information for a PDF document in the GroupDocs.Viewer component. It provides methods to retrieve information such as allowing printing, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     final PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is PdfViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| isPrintingAllowed() | Checks if printing of the document is allowed. |
| setPrintingAllowed(boolean allowPrinting) | Sets whether printing of the document is allowed. |
##### isPrintingAllowed()
```
public abstract boolean isPrintingAllowed()
```

Checks if printing of the document is allowed.

**Returns:**
boolean -  true  if printing is allowed,  false  otherwise.
##### setPrintingAllowed(boolean allowPrinting)
```
public abstract void setPrintingAllowed(boolean allowPrinting)
```

Sets whether printing of the document is allowed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allowPrinting | boolean |  true  to allow printing,  false  otherwise. |

### ProjectManagementViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/projectmanagementviewinfo.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.ViewInfo
```
public interface ProjectManagementViewInfo extends ViewInfo
```

Represents view information for an MS Project document.

The ProjectManagementViewInfo interface defines the contract for accessing and manipulating view information for an MS Project document in the GroupDocs.Viewer component. It provides methods to retrieve information such as the start and end dates, and other properties.

Example usage:

```

 try (Viewer viewer = new Viewer("document.mpp")) {
     final ProjectManagementViewInfo viewInfo = (ProjectManagementViewInfo) viewer.getViewInfo(ViewInfoOptions.forPngView());
     // Use the viewInfo object for further operations
 }
 
```

***Note:** The default implementation of this interface is ProjectManagementViewInfoImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getStartDate() | Retrieves the date and time from which the project started. |
| setStartDate(Date startDate) | Sets the start date and time for the project. |
| getEndDate() | Retrieves the date and time when the project is to be completed. |
| setEndDate(Date endDate) | Sets the end date and time for the project. |
##### getStartDate()
```
public abstract Date getStartDate()
```

Retrieves the date and time from which the project started.

**Returns:**
java.util.Date - the start date and time of the project.
##### setStartDate(Date startDate)
```
public abstract void setStartDate(Date startDate)
```

Sets the start date and time for the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startDate | java.util.Date | the new start date and time to be set. |

##### getEndDate()
```
public abstract Date getEndDate()
```

Retrieves the date and time when the project is to be completed.

**Returns:**
java.util.Date - the end date and time of the project.
##### setEndDate(Date endDate)
```
public abstract void setEndDate(Date endDate)
```

Sets the end date and time for the project.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| endDate | java.util.Date | the new end date and time to be set. |

### Resource
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/resource.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Serializable
```
public class Resource implements Serializable
```

Represents HTML resource such as font, style, image or graphics.

The Resource class represents a resource used in HTML rendering in the GroupDocs.Viewer component. It can represent various types of resources, such as fonts, styles, images, or graphics, that are included or referenced in the generated HTML output during the rendering process.

Example usage:

```

 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageNumber -> , new ReleaseResourceStream() {
     @Override
     public void invoke(int pageNumber, Resource resource, OutputStream resourceStream) {
         // Handle resource
     }
 });
 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Resource(String fileName, boolean nested) | Creates a new instance of the  Resource  class. |
#### Methods

| Method | Description |
| --- | --- |
| getFileName() | Returns the file name of the resource. |
| setFileName(String fileName) | Sets the file name of the resource. |
| isNested() | Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource. |
| setNested(boolean nested) | Sets whether the resource resides inside another resource. |
| toString() | Returns a string that represents the current object. |
##### Resource(String fileName, boolean nested)
```
public Resource(String fileName, boolean nested)
```

Creates a new instance of the  Resource  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The resource file name. |
| nested | boolean | Indicates whether the resource resides inside another resource, e.g., a font resource that resides in a CSS or SVG resource. |

##### getFileName()
```
public final String getFileName()
```

Returns the file name of the resource.

**Returns:**
java.lang.String - the file name of the resource.
##### setFileName(String fileName)
```
public void setFileName(String fileName)
```

Sets the file name of the resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | The new file name for the resource. |

##### isNested()
```
public final boolean isNested()
```

Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource.

**Returns:**
boolean - Whether the resource resides inside another resource.
##### setNested(boolean nested)
```
public void setNested(boolean nested)
```

Sets whether the resource resides inside another resource.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| nested | boolean | Whether the resource should be set as nested. |

##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - the string representation of the current object.

### TextElement
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/textelement.md

### ViewInfo
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/viewinfo.md

### Word
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.results/word.md

**All Implemented Interfaces:**
com.groupdocs.viewer.results.TextElement, java.io.Serializable
```
public interface Word extends TextElement<String>, Serializable
```

Represents a relatively positioned rectangle that contains a single word.

The Word interface represents a word within a relatively positioned rectangle in the GroupDocs.Viewer component. It extends the TextElement interface and provides additional methods to access and manipulate the word content.

Example usage:

```

 try (Viewer viewer = new Viewer("document.pdf")) {
     PdfViewInfo viewInfo = (PdfViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List words = viewInfo.getPages().get(0).getLines().get(0).getWords();
     for (Word word : words) {
         // Use the word object for further operations
     }
 }
 
```

***Note:** The default implementation of this interface is WordImpl.*
#### Methods

| Method | Description |
| --- | --- |
| getCharacters() | Retrieves the characters contained by the word. |
| setCharacters(List<Character> characters) | Sets the characters contained by the word. |
##### getCharacters()
```
public abstract List<Character> getCharacters()
```

Retrieves the characters contained by the word.

**Returns:**
java.util.List<com.groupdocs.viewer.results.Character> - the list of characters.
##### setCharacters(List<Character> characters)
```
public abstract void setCharacters(List<Character> characters)
```

Sets the characters contained by the word.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| characters | java.util.List<com.groupdocs.viewer.results.Character> | the list of characters to set. |

### com.groupdocs.viewer.utils
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.utils.md

The package provides helper and utility classes for various functionalities.

These classes offer convenient methods and functionalities to assist in different operations.

The main classes in this package are:

 *  MemoryCleaner - Provides methods to clean up resources and free memory.
 *  PathUtils - Represents the type for working with paths.

For more details on using the utility classes in the com.groupdocs.viewer.utils package, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| MemoryCleaner | Cleans different resources to free memory. |
| PathUtils | The PathUtils class provides utility methods for working with file paths. |

### MemoryCleaner
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.utils/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.Viewer 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.Viewer 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.

### PathUtils
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.utils/pathutils.md

**Inheritance:**
java.lang.Object
```
public class PathUtils
```

The PathUtils class provides utility methods for working with file paths.

The PathUtils class contains static methods that allow you to perform various operations on file paths in the GroupDocs.Viewer component.

Example usage:

```

 String combinedPath = PathUtils.combine("part", "of", "path");
 String fileName = PathUtils.getFileName("/path/to/file.txt");
 
```
#### Methods

| Method | Description |
| --- | --- |
| combine(String[] params) | Combine paths parts using separator. |
| getFileName(String path) | Gets file name. |
##### combine(String[] params)
```
public static String combine(String[] params)
```

Combine paths parts using separator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| params | java.lang.String[] | the paths parts |

**Returns:**
java.lang.String - the result path
##### getFileName(String path)
```
public static String getFileName(String path)
```

Gets file name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path |

**Returns:**
java.lang.String - the file name

### com.groupdocs.viewer
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer.md

The package provides classes for rendering documents in HTML5, Image, or PDF modes with fast and high-quality results.

The main classes in this package are:

 *  License - Provides methods for licensing Viewer.
 *  Viewer - Represents the main class that controls the document rendering process.
 *  ViewerSettings - Defines settings for customizing the behavior of the Viewer.

For more details on working with the document rendering process using GroupDocs.Viewer for Java, please refer to the [GroupDocs.Viewer Documentation][].

[GroupDocs.Viewer Documentation]: https://docs.groupdocs.com/viewer/java/

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component and unlock its full functionality. |
| Metered | Provides methods for applying metered license to the GroupDocs.Viewer component. |
| Viewer | Represents the main class that controls the document rendering process. |
| ViewerSettings | Defines settings for customizing the behavior of the Viewer component. |

#### Enumerations

| Enum | Description |
| --- | --- |
| FileType | Represents the file type. |

### FileType
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer/filetype.md

**Inheritance:**
java.lang.Object, java.lang.Enum

**All Implemented Interfaces:**
com.aspose.ms.System.IEquatable, com.groupdocs.viewer.caching.Cacheable
```
public enum FileType extends Enum<FileType> implements System.IEquatable<FileType>, Cacheable
```

Represents the file type. Provides methods to obtain a list of all file types supported by the GroupDocs.Viewer component.

The FileType enum provides constants representing different file types that are supported by the GroupDocs.Viewer component. You can use the methods in this enum to obtain a list of all supported file types or check if a specific file type is supported.

Example usage:

```

 // Try to detect file type using stream
 final FileType fileTypeFromStream = FileType.fromStream(new FileInputStream("document.pdf"));
 // Detect file type by extension
 final FileType fileTypeFromExtension = FileType.fromExtension(".png");
 // Iterate all supported file types
 for (FileType supportedFileType : FileType.getSupportedFileTypes()) {
     System.out.println("File type: " + supportedFileType);
 }
 final LoadOptions loadOptions = new LoadOptions(fileTypeFromExtension);
 // Usage of loadOptions
 
```
#### Fields

| Field | Description |
| --- | --- |
| UNKNOWN | Represents an unknown file type. |
| ZIP | Represents a zipped file (.zip) that can hold one or more files or directories. |
| TAR | Represents a consolidated Unix file archive (.tar) created for collecting one or more files. |
| XZ | Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. |
| TXZ | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. |
| TARXZ | Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. |
| TGZ | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. |
| TARGZ | Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. |
| BZ_2 | Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. |
| RAR | Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. |
| GZ | Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. |
| GZIP | Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. |
| SEVEN_ZIP | Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. |
| CPIO | Cpio is a general file archiver utility and its associated file format. |
| ZSTANDARD | ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm. |
| TZST | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| TAR_ZST | TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files. |
| ISO | ISO optical disc image 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. |
| LHA | LHA or LZH is a freeware compression utility and associated file format. |
| CAB | Cabinet (or CAB) is an archive-file format for Microsoft Windows. |
| DXF | Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. |
| DWG | Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. |
| DWT | Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files. |
| STL | Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. |
| IFC | Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. |
| DWF | Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. |
| FBX | Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. |
| DWFX | Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. |
| DGN | Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. |
| PLT | Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. |
| CF2 | Represents a Common File Format File (.cf2). |
| OBJ | Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. |
| HPG | Represents a PLT (HPGL) File (.hpg). |
| IGS | Represents an Initial Graphics Exchange Specification (IGES) File (.igs). |
| VSD | Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. |
| VSDX | Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. |
| VSS | Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier. |
| VSSX | Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above. |
| VSDM | Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros. |
| VST | Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. |
| VSTX | Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. |
| VSTM | Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. |
| VSSM | Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. |
| VSX | Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. |
| VTX | Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. |
| VDW | Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing. |
| VDX | Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. |
| EPUB | Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. |
| MOBI | Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. |
| AZW_3 | Amazon Kindle Format 8 (KF8) ebook is the digital file format developed for Amazon Kindle devices. |
| MSG | Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. |
| EML | Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. |
| EMLX | Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. |
| PST | Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. |
| OST | Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. |
| TIF | Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| TIFF | Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. |
| JPG | Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. |
| JPEG | Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. |
| JFIF | JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. |
| PNG | Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. |
| GIF | Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. |
| APNG | Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. |
| BMP | Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. |
| ICO | Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. |
| TGA | Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. |
| JP_2 | Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard. |
| JPF | Represents a JPEG 2000 Image File (.jpf). |
| JPX | Represents a JPEG 2000 Image File (.jpx). |
| JPM | Represents a JPEG 2000 Image File (.jpm). |
| J2C | Represents a JPEG 2000 Code InputStream (.j2c). |
| J2K | Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. |
| JPC | Represents a JPEG 2000 Code Stream (.jpc). |
| JLS | Represents a JPEG-LS (JLS) file (.jls). |
| DIB | Represents a Device Independent Bitmap File (.dib). |
| WMF | Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. |
| WMZ | Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. |
| EMF | Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. |
| EMZ | Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. |
| WEBP | Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. |
| DNG | Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. |
| CDR | Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. |
| CMX | Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. |
| DJVU | Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. |
| CGM | Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. |
| PCL | Represents a Printer Command Language Document (.pcl). |
| PSD | Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop's native file format used for graphics designing and development. |
| PSB | Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. |
| DCM | Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images. |
| PS | Represents a PostScript File (.ps). |
| EPS | Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. |
| ODG | Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| FODG | Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice's Draw application to store drawing elements as a vector image. |
| SVG | Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image. |
| SVGZ | Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. |
| OTG | Represents an OpenDocument Graphic Template (.otg). |
| HTM | Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers. |
| HTML | Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers. |
| MHT | Represents an MHTML Web Archive (.mht). |
| NSF | Represents a Lotus Notes Database (.nsf). |
| MBOX | Represents an Email Mailbox File (.mbox). |
| MHTML | Represents a MIME HTML File (.mhtml). |
| XML | Represents an XML File (.xml). |
| ONE | Represents a OneNote Document (.one) created by Microsoft OneNote application. |
| PDF | Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. |
| XPS | Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. |
| OXPS | Represents an OpenXPS File (.oxps). |
| TEX | Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents. |
| PPT | Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow. |
| PPTX | Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. |
| PPS | Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. |
| PPSX | Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. |
| ODP | Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard. |
| FODP | Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. |
| POT | Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. |
| PPTM | Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. |
| POTX | Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. |
| POTM | Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. |
| PPSM | Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher. |
| OTP | Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. |
| XLS | Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format. |
| EXCEL_2003_XML | Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format. |
| NUMBERS | Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. |
| XLSX | Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. |
| XLSM | Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. |
| XLSB | Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. |
| CSV | Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values. |
| TSV | Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. |
| ODS | Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. |
| FODS | Represents an OpenDocument Flat XML Spreadsheet (.fods). |
| OTS | Represents an OpenDocument Spreadsheet Template (.ots). |
| XLAM | Represents a Microsoft Excel Add-in (.xlam). |
| XLTM | Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. |
| XLT | Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. |
| XLTX | Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications. |
| SXC | Represents a StarOffice Calc Spreadsheet (.sxc). |
| MPP | Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner. |
| MPT | Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files. |
| MPX | Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring 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. |
| AS | Represents an ActionScript File (.as). |
| AS_3 | Represents an ActionScript File (.as3). |
| ASM | Represents an Assembly Language Source Code File (.asm). |
| BAT | Represents a DOS Batch File (.bat). |
| C | Represents a C/C++ Source Code File (.c). |
| CC | Represents a C++ Source Code File (.cc). |
| CMAKE | Represents a CMake File (.cmake). |
| CPP | Represents a C++ Source Code File (.cpp). |
| CS | Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. |
| VB | Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. |
| CSS | Represents a Cascading Style Sheet (.css) file. |
| CXX | Represents a C++ Source Code File (.cxx). |
| DIFF | Represents a Patch File (.diff). |
| ERB | Represents a Ruby ERB Script (.erb). |
| GROOVY | Represents a Groovy Source Code File (.groovy). |
| H | Represents a C/C++/Objective-C Header File (.h). |
| HAML | Represents a Haml Source Code File (.haml). |
| HH | Represents a C++ Header File (.hh). |
| JAVA | Represents a Java Source Code File (.java). |
| JS | Represents a JavaScript File (.js). |
| JSON | Represents a JavaScript Object Notation File (.json). |
| LESS | Represents a LESS Style Sheet (.less) file. |
| LOG | Represents a Log File (.log). |
| M | Represents an Objective-C Implementation File (.m). |
| MAKE | Represents an Xcode Makefile Script (.make). |
| MD | Represents a Markdown Documentation File (.md). |
| ML | Represents an ML Source Code File (.ml). |
| MM | Represents an Objective-C++ Source File (.mm). |
| PHP | Represents a PHP Source Code File (.php). |
| PL | Represents a Perl Script (.pl). |
| PROPERTIES | Represents a Java Properties File (.properties). |
| PY | Represents a Python Script (.py). |
| RB | Represents a Ruby Source Code (.rb) file. |
| RST | Represents a reStructuredText File (.rst). |
| SASS | Represents a Syntactically Awesome StyleSheets File (.sass). |
| SCALA | Represents a Scala Source Code File (.scala). |
| SCM | Represents a Scheme Source Code File (.scm). |
| SCRIPT | Represents a Generic Script File (.script). |
| SH | Represents a Bash Shell Script (.sh). |
| SML | Represents a Standard ML Source Code File (.sml). |
| SQL | Represents a Structured Query Language Data File (.sql). |
| VIM | Represents a Vim Settings File (.vim). |
| YAML | Represents a YAML Document (.yaml). |
| DOC | Represents a Microsoft Word Document (.doc) file. |
| DOCX | Represents a Microsoft Word Open XML Document (.docx) file. |
| CHM | Represents a Microsoft Compiled HTML Help File (.chm). |
| DOCM | Represents a Word Open XML Macro-Enabled Document (.docm) file. |
| DOT | Represents a Word Document Template (.dot) file. |
| DOTX | Represents a Word Open XML Document Template (.dotx) file. |
| DOTM | Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. |
| RTF | Represents a Rich Text Format File (.rtf). |
| TXT | Represents a Plain Text File (.txt). |
| ODT | Represents an OpenDocument Text Document (.odt). |
| OTT | Represents an OpenDocument Document Template (.ott). |
| VCF | Represents a vCard File (.vcf), which is a digital file format for storing contact information. |
| AI | Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. |
| PSM1 | Represents a PowerShell script module file (.psm1). |
| PS1 | Represents a PowerShell script file (.ps1). |
| PSD1 | Represents a PowerShell script module manifest file (.psd1). |
#### Methods

| Method | Description |
| --- | --- |
| values() |  |
| valueOf(String name) |  |
| fromExtension(String extension) | Maps a file extension to a file type. |
| fromFilePath(String filePath) | Extracts the file extension from a file name or file path and maps it to a file type. |
| fromMediaType(String mediaType) | Maps a file media type to a file type. |
| fromStream(InputStream stream) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, String password) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, ILogger logger) | Detects the file type by reading the file signature. |
| fromStream(InputStream stream, String password, ILogger logger) | Detects the file type by reading the file signature. |
| getSupportedFileTypes() | Retrieves the supported file types. |
| detectCharset(String filePath) | Attempts to detect text TXT, TSV, and CSV files charset by path. |
| detectCharset(InputStream stream) | Attempts to detect text TXT, TSV, and CSV file charset by stream. |
| getFileFormat() | Gets the name of the file format, e.g., "Microsoft Word Document". |
| getExtension() | Gets the file extension suffix (including the period "."), e.g., ".doc". |
| toString() | Returns a string representation of the current object. |
##### UNKNOWN
```
public static final FileType UNKNOWN
```

Represents an unknown file type.

##### ZIP
```
public static final FileType ZIP
```

Represents a zipped file (.zip) that can hold one or more files or directories. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/zip

##### TAR
```
public static final FileType TAR
```

Represents a consolidated Unix file archive (.tar) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/tar

##### XZ
```
public static final FileType XZ
```

Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/xz

##### TXZ
```
public static final FileType TXZ
```

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/txz

##### TARXZ
```
public static final FileType TARXZ
```

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/txz

##### TGZ
```
public static final FileType TGZ
```

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/tgz

##### TARGZ
```
public static final FileType TARGZ
```

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/tgz

##### BZ_2
```
public static final FileType BZ_2
```

Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/bz2

##### RAR
```
public static final FileType RAR
```

Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/rar

##### GZ
```
public static final FileType GZ
```

Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/gz

##### GZIP
```
public static final FileType GZIP
```

Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/gz

##### SEVEN_ZIP
```
public static final FileType SEVEN_ZIP
```

Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/7z/

##### CPIO
```
public static final FileType CPIO
```

Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/compression/cpio

##### ZSTANDARD
```
public static final FileType ZSTANDARD
```

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. ZST files can be used to compress different types of files such as databases, file systems, networks, and games. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/zst/

##### TZST
```
public static final FileType TZST
```

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

##### TAR_ZST
```
public static final FileType TAR_ZST
```

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

##### ISO
```
public static final FileType ISO
```

ISO optical disc image 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. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/iso/

##### LHA
```
public static final FileType LHA
```

LHA or LZH is a freeware compression utility and associated file format. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/compression/lzh/

##### CAB
```
public static final FileType CAB
```

Cabinet (or CAB) is an archive-file format for Microsoft Windows. Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Cabinet_%28file_format%29

##### DXF
```
public static final FileType DXF
```

Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dxf

##### DWG
```
public static final FileType DWG
```

Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwg

##### DWT
```
public static final FileType DWT
```

Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a 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

##### STL
```
public static final FileType STL
```

Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. It is commonly used in 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 FileType IFC
```

Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. It enables interoperability between different software applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/ifc

##### DWF
```
public static final FileType DWF
```

Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwf

##### FBX
```
public static final FileType FBX
```

Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/fbx

##### DWFX
```
public static final FileType DWFX
```

Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/dwfx

##### DGN
```
public static final FileType DGN
```

Represents a MicroStation Design File (.dgn), which are drawings created 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

##### PLT
```
public static final FileType PLT
```

Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. It contains information for a certain CAD file, and all images are printed using lines instead of dots, ensuring accuracy and precision in production. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/cad/plt

##### CF2
```
public static final FileType CF2
```

Represents a Common File Format File (.cf2). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/cf2

##### OBJ
```
public static final FileType OBJ
```

Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/3d/obj/

##### HPG
```
public static final FileType HPG
```

Represents a PLT (HPGL) File (.hpg). It is a file format used for plotter files in the HP Graphics Language (HPGL). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/hpg

##### IGS
```
public static final FileType IGS
```

Represents an Initial Graphics Exchange Specification (IGES) File (.igs).

##### VSD
```
public static final FileType VSD
```

Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsd

##### VSDX
```
public static final FileType VSDX
```

Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It replaced the binary file format (.VSD) 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 FileType VSS
```

Represents a Visio Stencil File (.vss), which 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

##### VSSX
```
public static final FileType VSSX
```

Represents a Visio Stencil File (.vssx), which 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 representing a variety of drawing elements such as shapes, connectors, flowcharts, network layout, UML diagrams, etc. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssx

##### VSDM
```
public static final FileType VSDM
```

Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support 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

##### VST
```
public static final FileType VST
```

Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. They act as templates for creating further files and contain the default layout and settings used for creating new Visio drawings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vst

##### VSTX
```
public static final FileType VSTX
```

Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide a 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

##### VSTM
```
public static final FileType VSTM
```

Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. Files created from VSTM templates can run macros developed in Visual Basic for Applications (VBA) code. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstm

##### VSSM
```
public static final FileType VSSM
```

Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. When a VSSM file is opened, macros can be run 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

##### VSX
```
public static final FileType VSX
```

Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and were supported until Visio 2013. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsx

##### VTX
```
public static final FileType VTX
```

Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. The template provides basic settings for creating multiple Visio files with the same settings. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vtx

##### VDW
```
public static final FileType VDW
```

Represents a Visio Web Drawing (.vdw), which 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 FileType VDX
```

Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. A Visio drawing XML file is created in the Visio software developed by Microsoft. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vdx

##### EPUB
```
public static final FileType EPUB
```

Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. The format 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 FileType MOBI
```

Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as a proprietary format for Mobipocket Reader. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/ebook/mobi

##### AZW_3
```
public static final FileType AZW_3
```

Amazon Kindle Format 8 (KF8) ebook is the 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://wiki.fileformat.com/ebook/azw3

##### MSG
```
public static final FileType MSG
```

Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/msg

##### EML
```
public static final FileType EML
```

Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. Almost all email clients support this file format due to its compliance with the RFC-822 Internet Message Format Standard. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml

##### EMLX
```
public static final FileType EMLX
```

Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting emails. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/emlx

##### PST
```
public static final FileType PST
```

Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/pst

##### OST
```
public static final FileType OST
```

Represents an Outlook Offline Data File (.ost), which represents a user's mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/ost

##### TIF
```
public static final FileType TIF
```

Represents a Tagged Image File (.tif), which 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

##### TIFF
```
public static final FileType TIFF
```

Represents a Tagged Image File Format (.tiff), which 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 FileType JPG
```

Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. The output image, as a 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 FileType JPEG
```

Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. The output image, as a 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

##### JFIF
```
public static final FileType JFIF
```

JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. This format uses JPEG compression.Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jfif

##### PNG
```
public static final FileType PNG
```

Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. This file format was created as a replacement for the 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 FileType GIF
```

Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. For each image, GIF typically allows up to 8 bits per pixel, and up to 256 colors are allowed across the image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif

##### APNG
```
public static final FileType APNG
```

Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/apng

##### BMP
```
public static final FileType BMP
```

Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. These images are independent of the 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 FileType ICO
```

Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/ico

##### TGA
```
public static final FileType TGA
```

Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tga

##### JP_2
```
public static final FileType JP_2
```

Represents a JPEG 2000 Core Image File (.jp2), which 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

##### JPF
```
public static final FileType JPF
```

Represents a JPEG 2000 Image File (.jpf). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/jpf

##### JPX
```
public static final FileType JPX
```

Represents a JPEG 2000 Image File (.jpx). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpx

##### JPM
```
public static final FileType JPM
```

Represents a JPEG 2000 Image File (.jpm). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpm

##### J2C
```
public static final FileType J2C
```

Represents a JPEG 2000 Code InputStream (.j2c). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2c

##### J2K
```
public static final FileType J2K
```

Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/j2k

##### JPC
```
public static final FileType JPC
```

Represents a JPEG 2000 Code Stream (.jpc). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpc

##### JLS
```
public static final FileType JLS
```

Represents a JPEG-LS (JLS) file (.jls). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/jls

##### DIB
```
public static final FileType DIB
```

Represents a Device Independent Bitmap File (.dib). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dib

##### WMF
```
public static final FileType WMF
```

Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/wmf

##### WMZ
```
public static final FileType WMZ
```

Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/wmz#compressed_windows_metafile

##### EMF
```
public static final FileType EMF
```

Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. Metafiles of EMF comprise 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

##### EMZ
```
public static final FileType EMZ
```

Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprise 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/emz

##### WEBP
```
public static final FileType WEBP
```

Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. It provides the 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 FileType DNG
```

Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. It was developed by Adobe in September 2004 and is primarily used for digital photography. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/dng

##### CDR
```
public static final FileType CDR
```

Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. A CDR drawing file contains text, lines, shapes, images, colors, 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 FileType CMX
```

Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/cmx

##### DJVU
```
public static final FileType DJVU
```

Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/djvu

##### CGM
```
public static final FileType CGM
```

Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. CGM uses an object-oriented approach and provides many functions for image production. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/cgm

##### PCL
```
public static final FileType PCL
```

Represents a Printer Command Language Document (.pcl). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/pcl

##### PSD
```
public static final FileType PSD
```

Represents an Adobe Photoshop Document (.psd), which is 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

##### PSB
```
public static final FileType PSB
```

Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/psb

##### DCM
```
public static final FileType DCM
```

Represents a DICOM Image (.dcm), which represents a digital image that 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

##### PS
```
public static final FileType PS
```

Represents a PostScript File (.ps). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/ps

##### EPS
```
public static final FileType EPS
```

Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/eps

##### ODG
```
public static final FileType ODG
```

Represents an OpenDocument Graphic File (.odg), which 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

##### FODG
```
public static final FileType FODG
```

Represents a Flat XML ODF Template (.fodg), which 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/fodg

##### SVG
```
public static final FileType SVG
```

Represents a Scalable Vector Graphics File (.svg), which 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

##### SVGZ
```
public static final FileType SVGZ
```

Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/svgz

##### OTG
```
public static final FileType OTG
```

Represents an OpenDocument Graphic Template (.otg). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/otg

##### HTM
```
public static final FileType HTM
```

Represents a Hypertext Markup Language File (.htm), which 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

##### HTML
```
public static final FileType HTML
```

Represents a Hypertext Markup Language File (.html), which 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 FileType MHT
```

Represents an MHTML Web Archive (.mht). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mht

##### NSF
```
public static final FileType NSF
```

Represents a Lotus Notes Database (.nsf). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/nsf

##### MBOX
```
public static final FileType MBOX
```

Represents an Email Mailbox File (.mbox). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/mbox

##### MHTML
```
public static final FileType MHTML
```

Represents a MIME HTML File (.mhtml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/mhtml

##### XML
```
public static final FileType XML
```

Represents an XML File (.xml). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/xml

##### ONE
```
public static final FileType ONE
```

Represents a OneNote Document (.one) 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

##### PDF
```
public static final FileType PDF
```

Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. The purpose of this file format was to introduce a standard for the representation of documents and other reference material in a format that is independent of application software, hardware, and operating systems. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/view/pdf

##### XPS
```
public static final FileType XPS
```

Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement for the EMF file format and is similar to the PDF file format, but uses XML in the layout, appearance, and printing information of a document. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/xps

##### OXPS
```
public static final FileType OXPS
```

Represents an OpenXPS File (.oxps). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/page-description-language/oxps

##### TEX
```
public static final FileType TEX
```

Represents a LaTeX Source Document (.tex), which is a language that comprises 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

##### PPT
```
public static final FileType PPT
```

Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a 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

##### PPTX
```
public static final FileType PPTX
```

Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. Unlike the previous version of the 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

##### PPS
```
public static final FileType PPS
```

Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. PPS file reading and creation are supported by Microsoft PowerPoint 97-2003. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pps

##### PPSX
```
public static final FileType PPSX
```

Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/ppsx

##### ODP
```
public static final FileType ODP
```

Represents an OpenDocument Presentation (.odp), which represents a 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

##### FODP
```
public static final FileType FODP
```

Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/fodp

##### POT
```
public static final FileType POT
```

Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pot

##### PPTM
```
public static final FileType PPTM
```

Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/pptm

##### POTX
```
public static final FileType POTX
```

Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/potx

##### POTM
```
public static final FileType POTM
```

Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. POTM files are created with PowerPoint 2007 or above and contain 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

##### PPSM
```
public static final FileType PPSM
```

Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a 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

##### OTP
```
public static final FileType OTP
```

Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/presentation/otp

##### XLS
```
public static final FileType XLS
```

Represents an Excel Spreadsheet (.xls), which represents the 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

##### EXCEL_2003_XML
```
public static final FileType EXCEL_2003_XML
```

Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the 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

##### NUMBERS
```
public static final FileType NUMBERS
```

Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. Such files can be created by Apple Numbers application. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/numbers

##### XLSX
```
public static final FileType XLSX
```

Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a 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 FileType XLSM
```

Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlsm

##### XLSB
```
public static final FileType XLSB
```

Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. It 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

##### CSV
```
public static final FileType CSV
```

Represents a Comma Separated Values File (.csv), which represents 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

##### TSV
```
public static final FileType TSV
```

Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/tsv

##### ODS
```
public static final FileType ODS
```

Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. Data is stored inside ODF files in rows and columns. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ods

##### FODS
```
public static final FileType FODS
```

Represents an OpenDocument Flat XML Spreadsheet (.fods). It is a spreadsheet document format based on XML used by OpenOffice and LibreOffice. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/fods

##### OTS
```
public static final FileType OTS
```

Represents an OpenDocument Spreadsheet Template (.ots). It is a template document format used by OpenOffice and LibreOffice for spreadsheets. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/ots

##### XLAM
```
public static final FileType XLAM
```

Represents a Microsoft Excel Add-in (.xlam). It is a file format used by Microsoft Excel to create add-ins with custom functionality. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/xlam

##### XLTM
```
public static final FileType XLTM
```

Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure except that the latter doesn't support creating template files with macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltm

##### XLT
```
public static final FileType XLT
```

Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening them. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xlt

##### XLTX
```
public static final FileType XLTX
```

Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates 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 with the same settings specified in the XLTX file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/xltx

##### SXC
```
public static final FileType SXC
```

Represents a StarOffice Calc Spreadsheet (.sxc). It is a spreadsheet document created with StarOffice Calc, a spreadsheet program. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/spreadsheet/sxc

##### MPP
```
public static final FileType MPP
```

Represents a Microsoft Project File (.mpp), which is a 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

##### MPT
```
public static final FileType MPT
```

Represents a Microsoft Project Template (.mpt), which contains 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

##### MPX
```
public static final FileType MPX
```

Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring 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

##### AS
```
public static final FileType AS
```

Represents an ActionScript File (.as). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/as

##### AS_3
```
public static final FileType AS_3
```

Represents an ActionScript File (.as3). Learn more about this file format [here][].

[here]: https://datatypes.net/open-as3-files

##### ASM
```
public static final FileType ASM
```

Represents an Assembly Language Source Code File (.asm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/cad/asm

##### BAT
```
public static final FileType BAT
```

Represents a DOS Batch File (.bat). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/executable/bat

##### C
```
public static final FileType C
```

Represents a C/C++ Source Code File (.c). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/c

##### CC
```
public static final FileType CC
```

Represents a C++ Source Code File (.cc). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/cc

##### CMAKE
```
public static final FileType CMAKE
```

Represents a CMake File (.cmake). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cmake

##### CPP
```
public static final FileType CPP
```

Represents a C++ Source Code File (.cpp). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cpp

##### CS
```
public static final FileType CS
```

Represents a C\# Source Code File (.cs), which is a source code file for the C\# programming language. It was introduced by Microsoft for use with the .NET Framework. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/cs

##### VB
```
public static final FileType VB
```

Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. It was created by Microsoft for the development of .NET applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/vb

##### CSS
```
public static final FileType CSS
```

Represents a Cascading Style Sheet (.css) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/css

##### CXX
```
public static final FileType CXX
```

Represents a C++ Source Code File (.cxx). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/cxx

##### DIFF
```
public static final FileType DIFF
```

Represents a Patch File (.diff). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/diff

##### ERB
```
public static final FileType ERB
```

Represents a Ruby ERB Script (.erb). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/erb

##### GROOVY
```
public static final FileType GROOVY
```

Represents a Groovy Source Code File (.groovy). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/groovy

##### H
```
public static final FileType H
```

Represents a C/C++/Objective-C Header File (.h). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/h

##### HAML
```
public static final FileType HAML
```

Represents a Haml Source Code File (.haml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/haml

##### HH
```
public static final FileType HH
```

Represents a C++ Header File (.hh). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/hh

##### JAVA
```
public static final FileType JAVA
```

Represents a Java Source Code File (.java). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/java

##### JS
```
public static final FileType JS
```

Represents a JavaScript File (.js). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/js

##### JSON
```
public static final FileType JSON
```

Represents a JavaScript Object Notation File (.json). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/json

##### LESS
```
public static final FileType LESS
```

Represents a LESS Style Sheet (.less) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/web/less

##### LOG
```
public static final FileType LOG
```

Represents a Log File (.log). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/database/log

##### M
```
public static final FileType M
```

Represents an Objective-C Implementation File (.m). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/m

##### MAKE
```
public static final FileType MAKE
```

Represents an Xcode Makefile Script (.make). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/make

##### MD
```
public static final FileType MD
```

Represents a Markdown Documentation File (.md). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/word-processing/md

##### ML
```
public static final FileType ML
```

Represents an ML Source Code File (.ml). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/ml

##### MM
```
public static final FileType MM
```

Represents an Objective-C++ Source File (.mm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/mm

##### PHP
```
public static final FileType PHP
```

Represents a PHP Source Code File (.php). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/programming/php

##### PL
```
public static final FileType PL
```

Represents a Perl Script (.pl). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/pl

##### PROPERTIES
```
public static final FileType PROPERTIES
```

Represents a Java Properties File (.properties). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/properties

##### PY
```
public static final FileType PY
```

Represents a Python Script (.py). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/py

##### RB
```
public static final FileType RB
```

Represents a Ruby Source Code (.rb) file. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/rb

##### RST
```
public static final FileType RST
```

Represents a reStructuredText File (.rst). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/rst

##### SASS
```
public static final FileType SASS
```

Represents a Syntactically Awesome StyleSheets File (.sass). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/sass

##### SCALA
```
public static final FileType SCALA
```

Represents a Scala Source Code File (.scala). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/scala

##### SCM
```
public static final FileType SCM
```

Represents a Scheme Source Code File (.scm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/scm

##### SCRIPT
```
public static final FileType SCRIPT
```

Represents a Generic Script File (.script). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/script

##### SH
```
public static final FileType SH
```

Represents a Bash Shell Script (.sh). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/cs/programming/sh

##### SML
```
public static final FileType SML
```

Represents a Standard ML Source Code File (.sml). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/sml

##### SQL
```
public static final FileType SQL
```

Represents a Structured Query Language Data File (.sql). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/database/sql

##### VIM
```
public static final FileType VIM
```

Represents a Vim Settings File (.vim). Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/vim

##### YAML
```
public static final FileType YAML
```

Represents a YAML Document (.yaml). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/programming/yaml

##### DOC
```
public static final FileType DOC
```

Represents a Microsoft Word Document (.doc) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/doc

##### DOCX
```
public static final FileType DOCX
```

Represents a Microsoft Word Open XML Document (.docx) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docx

##### CHM
```
public static final FileType CHM
```

Represents a Microsoft Compiled HTML Help File (.chm). Learn more about this file format [here][].

[here]: https://docs.fileformat.com/web/chm

##### DOCM
```
public static final FileType DOCM
```

Represents a Word Open XML Macro-Enabled Document (.docm) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/docm

##### DOT
```
public static final FileType DOT
```

Represents a Word Document Template (.dot) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dot

##### DOTX
```
public static final FileType DOTX
```

Represents a Word Open XML Document Template (.dotx) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotx

##### DOTM
```
public static final FileType DOTM
```

Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/dotm

##### RTF
```
public static final FileType RTF
```

Represents a Rich Text Format File (.rtf). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/rtf

##### TXT
```
public static final FileType TXT
```

Represents a Plain Text File (.txt). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/txt

##### ODT
```
public static final FileType ODT
```

Represents an OpenDocument Text Document (.odt). Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt

##### OTT
```
public static final FileType OTT
```

Represents an OpenDocument Document Template (.ott). It is a template document generated in compliance with the OASIS' OpenDocument standard format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/ott

##### VCF
```
public static final FileType VCF
```

Represents a vCard File (.vcf), which is a digital file format for storing contact information. It 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

##### AI
```
public static final FileType AI
```

Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. Learn more about this file format [here][].

[here]: https://docs.fileformat.com/image/ai

##### PSM1
```
public static final FileType PSM1
```

Represents a PowerShell script module file (.psm1). It is a file format for PowerShell module scripts. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/psm1

##### PS1
```
public static final FileType PS1
```

Represents a PowerShell script file (.ps1). It is a file format for Windows PowerShell Cmdlet files. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/ps1

##### PSD1
```
public static final FileType PSD1
```

Represents a PowerShell script module manifest file (.psd1). It is a file format for PowerShell module manifest scripts. Learn more about this file format [here][].

[here]: https://fileinfo.com/extension/psd1

##### values()
```
public static FileType[] values()
```

**Returns:**
com.groupdocs.viewer.FileType[]
##### valueOf(String name)
```
public static FileType valueOf(String name)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | java.lang.String |  |

**Returns:**
FileType
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps a file extension to a file type.

This method takes a file extension, with or without the period ".", and returns the corresponding file type if it is supported. If the file type is not supported, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension with or without the period ".". |

**Returns:**
FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.
##### fromFilePath(String filePath)
```
public static FileType fromFilePath(String filePath)
```

Extracts the file extension from a file name or file path and maps it to a file type.

If the file type is supported, the method returns the corresponding  FileType , otherwise it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or file path. |

**Returns:**
FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.
##### fromMediaType(String mediaType)
```
public static FileType fromMediaType(String mediaType)
```

Maps a file media type to a file type. For example, 'application/pdf' will be mapped to PDF.

This method takes a file media type as input and maps it to the corresponding  FileType . If the media type is supported, the method returns the corresponding file type. If the media type is not supported, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| mediaType | java.lang.String | The file media type, e.g., 'application/pdf'. |

**Returns:**
FileType - the corresponding file type if found, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream)
```
public static FileType fromStream(InputStream stream)
```

Detects the file type by reading the file signature.

This method takes an input stream representing a file and tries to detect its file type by analyzing the file signature. The file signature is a unique sequence of bytes at the beginning of the file that indicates its file type. The method reads the file signature from the input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, String password)
```
public static FileType fromStream(InputStream stream, String password)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

If the file is encrypted and requires a password to open, the password should be provided as a parameter to this method. The password will be used to decrypt the file and analyze its signature for determining the file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| password | java.lang.String | The password to open the file. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, ILogger logger)
```
public static FileType fromStream(InputStream stream, ILogger logger)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### fromStream(InputStream stream, String password, ILogger logger)
```
public static FileType fromStream(InputStream stream, String password, ILogger logger)
```

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

A password can be provided if the file is encrypted or protected. The password will be used to open the file before analyzing the file signature. If the file does not require a password, this parameter can be set to null.

A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The input stream representing the file. |
| password | java.lang.String | The password to open the file. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger for logging information or errors. |

**Returns:**
FileType - the detected file type if successful, otherwise the default UNKNOWN file type.
##### getSupportedFileTypes()
```
public static List<FileType> getSupportedFileTypes()
```

Retrieves the supported file types.

This method returns a sequence of all the supported file types by the system. The file types represent various document formats that can be processed or recognized by the system.

[Full list of supported file formats]: https://docs.groupdocs.com/viewer/java/supported-document-formats/

**Returns:**
java.util.List<com.groupdocs.viewer.FileType> - a sequence of supported file types.
##### detectCharset(String filePath)
```
public static Charset detectCharset(String filePath)
```

Attempts to detect text TXT, TSV, and CSV files charset by path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file name or file path. |

**Returns:**
java.nio.charset.Charset - Charset or null when fails to detect a file charset.

**Example:**

```
Charset charset = FileType.detectCharset("message.txt");
```
##### detectCharset(InputStream stream)
```
public static Charset detectCharset(InputStream stream)
```

Attempts to detect text TXT, TSV, and CSV file charset by stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The file stream. |

**Returns:**
java.nio.charset.Charset - Charset or null when fails to detect a file charset.

**Example:**

```
InputStream stream = new FileInputStream("message.txt");
 Charset charset = FileType.detectCharset(stream);
```
##### getFileFormat()
```
public final String getFileFormat()
```

Gets the name of the file format, e.g., "Microsoft Word Document".

**Returns:**
java.lang.String - the name of the file format.
##### getExtension()
```
public final String getExtension()
```

Gets the file extension suffix (including the period "."), e.g., ".doc".

**Returns:**
java.lang.String - the file extension suffix.
##### toString()
```
public String toString()
```

Returns a string representation of the current object.

**Returns:**
java.lang.String - a string representation of the current object.

### License
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer/license.md

**Inheritance:**
java.lang.Object
```
public class License
```

Provides methods to license the component and unlock its full functionality.

The License class allows you to apply a valid license to the GroupDocs.Viewer component, enabling you to utilize all the features and remove any evaluation limitations.

Example usage:

```

 License license = new License();
 license.setLicense("path/to/license/file.lic");
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| License() |  |
#### Methods

| Method | Description |
| --- | --- |
| resetLicense() |  |
| setLicense(InputStream licenseStream) | Licenses the component. |
| setLicense(Path licensePath) | Licenses the component. |
| setLicense(String licensePath) | Licenses the component. |
| setLicense(URL licenseUri) | Licenses the component. |
| isLicensed() |  |
##### License()
```
public License()
```

##### resetLicense()
```
public static void resetLicense()
```

##### setLicense(InputStream licenseStream)
```
public final void setLicense(InputStream licenseStream)
```

Licenses the component.

The following example demonstrates how to set a license passing InputStream of the license file.

For more information about licensing, please refer to the [GroupDocs Licensing FAQ][]. You can also find detailed information about GroupDocs.Viewer licensing in the [Evaluation Limitations and Licensing][] documentation.

**Example:**

```

 FileInputStream licenseStream = new FileInputStream("LicenseFile.lic");
 License license = new License();
 license.setLicense(licenseStream);
 
```

[GroupDocs Licensing FAQ]: https://purchase.groupdocs.com/faqs/licensing
[Evaluation Limitations and Licensing]: https://docs.groupdocs.com/display/viewernet/Evaluation+Limitations+and+Licensing+of+GroupDocs.Viewer

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseStream | java.io.InputStream | The license stream. |

##### setLicense(Path licensePath)
```
public final void setLicense(Path licensePath)
```

Licenses the component.

Sets the license for the component using the specified license path.

**Note:** This method should be called before using any functionality of 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.

This method should be called before using any functionality.

Example usage:

```

 String licensePath = "GroupDocs.Viewer.lic";
 License license = new License();
 license.setLicense(licensePath);
 
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licensePath | java.lang.String | The license path or url. |

##### setLicense(URL licenseUri)
```
public void setLicense(URL licenseUri)
```

Licenses the component.

This method should be called before using any functionality.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| licenseUri | java.net.URL | The license URI. |

##### isLicensed()
```
public final boolean isLicensed()
```

**Returns:**
boolean

### Metered
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer/metered.md

**Inheritance:**
java.lang.Object
```
public class Metered
```

Provides methods for applying metered license to the GroupDocs.Viewer component.

Metered licensing allows you to dynamically monitor and control the usage of GroupDocs.Viewer based on the number of document pages processed instead of a traditional per-server or per-developer license. This flexible licensing model is suitable for scenarios where the document processing requirements vary over time or when you want to pay only for what you use.

Example usage:

```

 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 // Perform document processing operations using GroupDocs.Viewer
 // ...
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Metered() |  |
#### Methods

| Method | Description |
| --- | --- |
| getConsumptionQuantity() | Retrieves the amount of megabytes (MB) processed. |
| getConsumptionCredit() | Retrieves the count of credits consumed. |
| setMeteredKey(String publicKey, String privateKey) | Activates the product with Metered keys. |
##### Metered()
```
public Metered()
```

##### getConsumptionQuantity()
```
public static double getConsumptionQuantity()
```

Retrieves the amount of megabytes (MB) processed.

This method returns the total amount of MB processed by the component.

**Example:**

```

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double mbProcessed = Metered.getConsumptionQuantity();
 
```

**Returns:**
double - the amount of MB processed.
##### getConsumptionCredit()
```
public static double getConsumptionCredit()
```

Retrieves the count of credits consumed.

This method returns the total count of credits consumed by the component.

**Example:**

```

 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double creditsConsumed = Metered.getConsumptionCredit();
 
```

**Returns:**
double - the count of credits consumed.
##### setMeteredKey(String publicKey, String privateKey)
```
public final void setMeteredKey(String publicKey, String privateKey)
```

Activates the product with Metered keys.

Following example demonstrates how to activate product with Metered keys.

**Example:**

```

 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. |

### Viewer
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer/viewer.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Viewer implements Closeable
```

Represents the main class that controls the document rendering process.

The Viewer class is the entry point for rendering documents using the GroupDocs.Viewer component. It provides methods and options to load documents from various sources, customize the rendering process, and retrieve the rendered output in different formats.

Example usage:

```

 try (Viewer viewer = new Viewer("source.pdf")) {
     viewer.view(new PngViewOptions("result-page{0}.png"));
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| Viewer(InputStream fileStream) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) | Initializes new instance of Viewer class. |
| Viewer(URL url) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(FileReader fileReader, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, LoadOptions loadOptions) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
| Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings) | Initializes a new instance of the Viewer class. |
#### Fields

| Field | Description |
| --- | --- |
| LOAD_OPTIONS |  |
| SETTINGS |  |
| FILE_READER |  |
| OPTIONS |  |
#### Methods

| Method | Description |
| --- | --- |
| getViewInfo(ViewInfoOptions options) | Returns information about the view and document specific information. |
| getAttachments() | Returns attachments contained by the document. |
| saveAttachment(Attachment attachment, OutputStream destination) | Saves an attachment file to the destination stream. |
| view(ViewOptions options) | Creates a view of all document pages. |
| view(ViewOptions options, int[] pageNumbers) | Creates a view of specific document pages. |
| getAllFonts() | Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document. |
| search(SearchHighlightOptions options) | Performs a text search and highlights matches (if found) in the loaded document according to the provided options. |
| getFileInfo() | Returns information about the file, such as file type and a flag that indicates if the file is encrypted. |
| close() | Releases the file stream and managed internal resources. |
##### Viewer(InputStream fileStream)
```
public Viewer(InputStream fileStream)
```

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The method that returns a readable stream. |

##### Viewer(InputStream fileStream, boolean leaveOpen)
```
public Viewer(InputStream fileStream, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The readable stream. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, ViewerSettings settings)
```
public Viewer(InputStream fileStream, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)
```
public Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)
```
public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)
```

Initializes new instance of Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileStream | java.io.InputStream | The file stream. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |
| leaveOpen | boolean | true to leave the stream open after the Viewer object is disposed; otherwise, false. |

##### Viewer(URL url)
```
public Viewer(URL url)
```

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |

##### Viewer(URL url, LoadOptions loadOptions)
```
public Viewer(URL url, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(URL url, ViewerSettings settings)
```
public Viewer(URL url, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| url | java.net.URL | A URL to a file that should be loaded into the Viewer. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(FileReader fileReader, ViewerSettings settings)
```
public Viewer(FileReader fileReader, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

This constructor allows you to create a Viewer object to view a document from a FileReader with the specified ViewerSettings.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileReader | FileReader | The FileReader containing the document to be loaded into the Viewer. |
| settings | ViewerSettings | The ViewerSettings to be applied to the Viewer. |

##### Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

Provides functionality to load and view documents using GroupDocs.Viewer.

**Note:** Ensure that the file reader, load options, and settings are properly configured for accurate document processing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileReader | FileReader | The file reader. |
| loadOptions | LoadOptions | The load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(String filePath)
```
public Viewer(String filePath)
```

Initializes a new instance of the Viewer class.

 **Learn more:**

 *  More about file types supported by GroupDocs.Viewer: [Document formats supported by GroupDocs.Viewer][]
 *  More about GroupDocs.Viewer for Java features: [Developer Guide][]

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |

##### Viewer(Path filePath)
```
public Viewer(Path filePath)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |

##### Viewer(String filePath, LoadOptions loadOptions)
```
public Viewer(String filePath, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(Path filePath, LoadOptions loadOptions)
```
public Viewer(Path filePath, LoadOptions loadOptions)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view a document with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |

##### Viewer(String filePath, ViewerSettings settings)
```
public Viewer(String filePath, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(Path filePath, ViewerSettings settings)
```
public Viewer(Path filePath, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)
```
public Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)
```

Initializes a new instance of the Viewer class.

[Document formats supported by GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Supported+Document+Formats
[Developer Guide]: https://docs.groupdocs.com/display/viewerjava/Developer+Guide
[How to load and view documents with GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Loading

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.nio.file.Path | The path to the file to render. |
| loadOptions | LoadOptions | The document load options. |
| settings | ViewerSettings | The Viewer settings. |

##### LOAD_OPTIONS
```
public static final String LOAD_OPTIONS
```

##### SETTINGS
```
public static final String SETTINGS
```

##### FILE_READER
```
public static final String FILE_READER
```

##### OPTIONS
```
public static final String OPTIONS
```

##### getViewInfo(ViewInfoOptions options)
```
public final ViewInfo getViewInfo(ViewInfoOptions options)
```

Returns information about the view and document specific information.

 **Learn more:**

 *  Learn more about the document - file type, page count, and other format specific properties: [How to get file information using GroupDocs.Viewer][]

[How to get file information using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+file+information

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewInfoOptions | The view info options. |

**Returns:**
ViewInfo - Information about the view and document specific information.
##### getAttachments()
```
public final List<Attachment> getAttachments()
```

Returns attachments contained by the document.

 **Learn more:**

 *  Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][]
 *  Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][]

[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments
[How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments

**Returns:**
java.util.List<com.groupdocs.viewer.results.Attachment> - attachments contained by the document.
##### saveAttachment(Attachment attachment, OutputStream destination)
```
public void saveAttachment(Attachment attachment, OutputStream destination)
```

Saves an attachment file to the destination stream.

 **Learn more:**

 *  Learn more about getting document attachments in Java: [How to get a list of document attachments using GroupDocs.Viewer][]
 *  Learn more about saving document attachments in Java: [How to save document attachments using GroupDocs.Viewer][]

[How to get a list of document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Get+attachments
[How to save document attachments using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Save+attachments

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| attachment | Attachment | The attachment. |
| destination | java.io.OutputStream | The writable stream. |

##### view(ViewOptions options)
```
public final void view(ViewOptions options)
```

Creates a view of all document pages.

[How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |

##### view(ViewOptions options, int[] pageNumbers)
```
public final void view(ViewOptions options, int[] pageNumbers)
```

Creates a view of specific document pages.

[How to customize document viewing output using GroupDocs.Viewer]: https://docs.groupdocs.com/display/viewerjava/Viewing

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | ViewOptions | The view options. |
| pageNumbers | int[] | The page numbers to view. |

##### getAllFonts()
```
public IFontInfo[] getAllFonts()
```

Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.

For details, see the [ documentation][documentation].

[documentation]: https://docs.groupdocs.com/viewer/net/getting-used-fonts/

**Returns:**
com.groupdocs.viewer.fonts.IFontInfo[] - Non-null list of all fonts used in the document loaded into this Viewer instance.
##### search(SearchHighlightOptions options)
```
public void search(SearchHighlightOptions options)
```

Performs a text search and highlights matches (if found) in the loaded document according to the provided options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | com.groupdocs.viewer.options.SearchHighlightOptions | Search and highlight options, including a text phrase to search. Cannot be  null . |

##### getFileInfo()
```
public FileInfo getFileInfo()
```

Returns information about the file, such as file type and a flag that indicates if the file is encrypted.

**Learn more:**

 *  Learn more about how to check if a file is encrypted: [How to check if a file is encrypted][]

[How to check if a file is encrypted]: https://docs.groupdocs.com/viewer/net/how-to-check-if-file-is-encrypted/

**Returns:**
FileInfo - the file information.
##### close()
```
public final void close()
```

Releases the file stream and managed internal resources.

### ViewerSettings
Path: https://reference.groupdocs.com/viewer/nodejs-java/com.groupdocs.viewer/viewersettings.md

**Inheritance:**
java.lang.Object
```
public class ViewerSettings
```

Defines settings for customizing the behavior of the Viewer component.

The ViewerSettings class provides options and properties to customize the behavior of the GroupDocs.Viewer component during the document rendering process. You can use this class to specify various settings, such as logger, custom cache implementation, and more.

Example usage:

```

 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setLogger(new ConsoleLogger(false, true));

 try (Viewer viewer = new Viewer("source.pdf", viewerSettings)) {
     // Document processing
 }
 
```
#### Constructors

| Constructor | Description |
| --- | --- |
| ViewerSettings(Cache cache, ILogger logger) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings(ILogger logger) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings(Cache cache) | Initializes a new instance of the  ViewerSettings  class. |
| ViewerSettings() | Initializes a new instance of the  ViewerSettings  class. |
#### Methods

| Method | Description |
| --- | --- |
| getLogger() | Gets the logger implementation used for logging (Errors, Warnings, Traces). |
| setLogger(ILogger logger) | Sets the logger implementation used for logging (Errors, Warnings, Traces). |
| getCache() | Gets the cache implementation used for storing rendering results. |
| setCache(Cache cache) | Sets the cache implementation used for storing rendering results. |
##### ViewerSettings(Cache cache, ILogger logger)
```
public ViewerSettings(Cache cache, ILogger logger)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache. |
| logger | com.groupdocs.foundation.logging.ILogger | The logger. |

##### ViewerSettings(ILogger logger)
```
public ViewerSettings(ILogger logger)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger. |

##### ViewerSettings(Cache cache)
```
public ViewerSettings(Cache cache)
```

Initializes a new instance of the  ViewerSettings  class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache. |

##### ViewerSettings()
```
public ViewerSettings()
```

Initializes a new instance of the  ViewerSettings  class.

##### getLogger()
```
public ILogger getLogger()
```

Gets the logger implementation used for logging (Errors, Warnings, Traces).

**Returns:**
com.groupdocs.foundation.logging.ILogger - the logger implementation.
##### setLogger(ILogger logger)
```
public void setLogger(ILogger logger)
```

Sets the logger implementation used for logging (Errors, Warnings, Traces).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| logger | com.groupdocs.foundation.logging.ILogger | The logger implementation to set. |

##### getCache()
```
public final Cache getCache()
```

Gets the cache implementation used for storing rendering results.

**Returns:**
Cache - the cache implementation.
##### setCache(Cache cache)
```
public void setCache(Cache cache)
```

Sets the cache implementation used for storing rendering results.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cache | Cache | The cache implementation. |

## Python

### GroupDocs.Viewer.CrossPlatform for Python via .NET
Path: https://reference.groupdocs.com/viewer/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.viewer` | Main GroupDocs.Viewer.CrossPlatform namespace with top-level API classes. |
| `groupdocs.viewer.caching` | Types under `groupdocs.viewer.caching`. |
| `groupdocs.viewer.drawing` | Types under `groupdocs.viewer.drawing`. |
| `groupdocs.viewer.fonts` | Font loading and substitution configuration. |
| `groupdocs.viewer.interfaces` | Types under `groupdocs.viewer.interfaces`. |
| `groupdocs.viewer.logging` | Logging hooks and listener interfaces. |
| `groupdocs.viewer.options` | Option classes for configuring conversions and operations. |
| `groupdocs.viewer.results` | Result types produced by converter and processor methods. |

### groupdocs.viewer.caching
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching.md

Types under `groupdocs.viewer.caching`.

##### Classes
| Class | Description |
| :- | :- |
| `CacheKeys` |  |
| `FileCache` |  |
| `ICache` |  |

### CacheKeys class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys.md

#### CacheKeys class

The CacheKeys type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_attachment_key |  |
| get_attachments_key |  |
| get_file_info_key |  |
| get_file_key |  |
| get_page_key |  |
| get_resource_filter |  |
| get_resource_key |  |
| get_view_info_key |  |

### get_attachment_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_attachment_key.md

#### get_attachment_key

```python
def get_attachment_key(cls, attachment_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attachment_id | `str` |  |

**Returns:** str

### get_attachments_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_attachments_key.md

#### get_attachments_key

```python
def get_attachments_key(cls):
    ...
```

**Returns:** str

### get_file_info_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_file_info_key.md

#### get_file_info_key

```python
def get_file_info_key(cls):
    ...
```

**Returns:** str

### get_file_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_file_key.md

#### get_file_key

```python
def get_file_key(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** str

### get_page_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_page_key.md

#### get_page_key

```python
def get_page_key(cls, page_number, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| extension | `str` |  |

**Returns:** str

### get_resource_filter method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_resource_filter.md

#### get_resource_filter

```python
def get_resource_filter(cls, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** str

### get_resource_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_resource_key.md

#### get_resource_key

```python
def get_resource_key(cls, page_number, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |

**Returns:** str

### get_view_info_key method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/cachekeys/get_view_info_key.md

#### get_view_info_key

```python
def get_view_info_key(cls):
    ...
```

**Returns:** str

### FileCache class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache.md

#### FileCache class

The FileCache type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_keys_string |  |
| _init_string |  |
| _init_string_string |  |
| _set_string_object |  |
| _try_get_value_string_arg |  |
| get_keys |  |
| get_keys_file |  |
| get_keys_string |  |
| set |  |
| set_file |  |
| set_string |  |
| try_get_value |  |
| try_get_value_file |  |
| try_get_value_string |  |

##### Properties
| Property | Description |
| :- | :- |
| cache_path |  |
| cache_sub_folder |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_keys_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.caching/filecache/_init_string.md

#### _init_string

```python
def _init_string(self, cache_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cache_path | `str` |  |

### _init_string_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, cache_path, cache_sub_folder):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cache_path | `str` |  |
| cache_sub_folder | `str` |  |

### _set_string_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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_arg method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/_try_get_value_string_arg.md

#### _try_get_value_string_arg

```python
def _try_get_value_string_arg(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

**Returns:** bool

### cache_path property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/cache_path.md

##### Definition:
```python
@property
def cache_path(self):
    ...
```

### cache_sub_folder property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/cache_sub_folder.md

##### Definition:
```python
@property
def cache_sub_folder(self):
    ...
```

### get_keys method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/get_keys.md

#### get_keys

```python
def get_keys(self):
    ...
```

### get_keys_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/set.md

#### set

```python
def set(self):
    ...
```

### set_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/filecache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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_arg |  |
| 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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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_arg method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/_try_get_value_string_arg.md

#### _try_get_value_string_arg

```python
def _try_get_value_string_arg(self, key, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| key | `str` |  |
| value | `Any` |  |

**Returns:** bool

### get_keys method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/get_keys.md

#### get_keys

```python
def get_keys(self):
    ...
```

### get_keys_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/get_keys_file.md

#### get_keys_file

```python
def get_keys_file(self):
    ...
```

### get_keys_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/get_keys_string.md

#### get_keys_string

```python
def get_keys_string(self):
    ...
```

### set method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/set.md

#### set

```python
def set(self):
    ...
```

### set_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/set_file.md

#### set_file

```python
def set_file(self):
    ...
```

### set_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.caching/icache/set_string.md

#### set_string

```python
def set_string(self):
    ...
```

### try_get_value method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.caching/icache/try_get_value_string.md

#### try_get_value_string

```python
def try_get_value_string(self):
    ...
```

### groupdocs.viewer.drawing
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing.md

Types under `groupdocs.viewer.drawing`.

##### Classes
| Class | Description |
| :- | :- |
| `Argb32Color` |  |
| `Image2DFormat` |  |
| `KnownColors` |  |
| `Rgb24Color` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `CssLevel1` |  |
| `CssLevel2` |  |
| `CssLevel3` |  |
| `CssLevel4` |  |

### Argb32Color class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color.md

#### Argb32Color class

The Argb32Color type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_argb_32_color |  |
| _equals_object |  |
| _equals_rgb_24_color |  |
| _from_other_with_alpha_argb_32_color_byte |  |
| _from_other_with_alpha_rgb_24_color_byte |  |
| _get_brightness_noargs |  |
| _get_hash_code_noargs |  |
| _get_hue_noargs |  |
| _get_saturation_noargs |  |
| _to_argb_noargs |  |
| _to_hex_rgb_noargs |  |
| _to_hex_rgba_noargs |  |
| _to_rgb_noargs |  |
| _to_rgba_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_argb_32_color |  |
| equals_object |  |
| equals_rgb_24_color |  |
| from_argb |  |
| from_other_with_alpha |  |
| from_other_with_alpha_argb_32_color |  |
| from_other_with_alpha_rgb_24_color |  |
| from_rgb |  |
| from_rgba |  |
| from_single_value_rgb |  |
| get_brightness |  |
| get_hash_code |  |
| get_hue |  |
| get_saturation |  |
| to_argb |  |
| to_hex_rgb |  |
| to_hex_rgba |  |
| to_rgb |  |
| to_rgba |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| a |  |
| alpha |  |
| b |  |
| g |  |
| is_default |  |
| is_empty |  |
| is_fully_opaque |  |
| is_fully_transparent |  |
| is_translucent |  |
| r |  |
| value |  |

### _equals_argb_32_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_equals_argb_32_color.md

#### _equals_argb_32_color

```python
def _equals_argb_32_color(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Argb32Color` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_rgb_24_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_equals_rgb_24_color.md

#### _equals_rgb_24_color

```python
def _equals_rgb_24_color(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Rgb24Color` |  |

**Returns:** bool

### _from_other_with_alpha_argb_32_color_byte method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_from_other_with_alpha_argb_32_color_byte.md

#### _from_other_with_alpha_argb_32_color_byte

```python
def _from_other_with_alpha_argb_32_color_byte(cls, other, new_alpha):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Argb32Color` |  |
| new_alpha | `int` |  |

**Returns:** Argb32Color

### _from_other_with_alpha_rgb_24_color_byte method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_from_other_with_alpha_rgb_24_color_byte.md

#### _from_other_with_alpha_rgb_24_color_byte

```python
def _from_other_with_alpha_rgb_24_color_byte(cls, other, new_alpha):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Rgb24Color` |  |
| new_alpha | `int` |  |

**Returns:** Argb32Color

### _get_brightness_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_get_brightness_noargs.md

#### _get_brightness_noargs

```python
def _get_brightness_noargs(self):
    ...
```

**Returns:** float

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _get_hue_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_get_hue_noargs.md

#### _get_hue_noargs

```python
def _get_hue_noargs(self):
    ...
```

**Returns:** float

### _get_saturation_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_get_saturation_noargs.md

#### _get_saturation_noargs

```python
def _get_saturation_noargs(self):
    ...
```

**Returns:** float

### _to_argb_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_argb_noargs.md

#### _to_argb_noargs

```python
def _to_argb_noargs(self):
    ...
```

**Returns:** int

### _to_hex_rgb_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_hex_rgb_noargs.md

#### _to_hex_rgb_noargs

```python
def _to_hex_rgb_noargs(self):
    ...
```

**Returns:** str

### _to_hex_rgba_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_hex_rgba_noargs.md

#### _to_hex_rgba_noargs

```python
def _to_hex_rgba_noargs(self):
    ...
```

**Returns:** str

### _to_rgb_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_rgb_noargs.md

#### _to_rgb_noargs

```python
def _to_rgb_noargs(self):
    ...
```

**Returns:** str

### _to_rgba_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_rgba_noargs.md

#### _to_rgba_noargs

```python
def _to_rgba_noargs(self):
    ...
```

**Returns:** str

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### a property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/a.md

##### Definition:
```python
@property
def a(self):
    ...
```

### alpha property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/alpha.md

##### Definition:
```python
@property
def alpha(self):
    ...
```

### b property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/b.md

##### Definition:
```python
@property
def b(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_argb_32_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/equals_argb_32_color.md

#### equals_argb_32_color

```python
def equals_argb_32_color(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_rgb_24_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/equals_rgb_24_color.md

#### equals_rgb_24_color

```python
def equals_rgb_24_color(self):
    ...
```

### from_argb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_argb.md

#### from_argb

```python
def from_argb(cls, argb):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| argb | `int` |  |

**Returns:** Argb32Color

### from_other_with_alpha method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_other_with_alpha.md

#### from_other_with_alpha

```python
def from_other_with_alpha(cls):
    ...
```

### from_other_with_alpha_argb_32_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_other_with_alpha_argb_32_color.md

#### from_other_with_alpha_argb_32_color

```python
def from_other_with_alpha_argb_32_color(cls):
    ...
```

### from_other_with_alpha_rgb_24_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_other_with_alpha_rgb_24_color.md

#### from_other_with_alpha_rgb_24_color

```python
def from_other_with_alpha_rgb_24_color(cls):
    ...
```

### from_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_rgb.md

#### from_rgb

```python
def from_rgb(cls, red, green, blue):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| red | `int` |  |
| green | `int` |  |
| blue | `int` |  |

**Returns:** Argb32Color

### from_rgba method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_rgba.md

#### from_rgba

```python
def from_rgba(cls, red, green, blue, alpha):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| red | `int` |  |
| green | `int` |  |
| blue | `int` |  |
| alpha | `int` |  |

**Returns:** Argb32Color

### from_single_value_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/from_single_value_rgb.md

#### from_single_value_rgb

```python
def from_single_value_rgb(cls, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

**Returns:** Argb32Color

### g property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/g.md

##### Definition:
```python
@property
def g(self):
    ...
```

### get_brightness method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/get_brightness.md

#### get_brightness

```python
def get_brightness(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_hue method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/get_hue.md

#### get_hue

```python
def get_hue(self):
    ...
```

### get_saturation method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/get_saturation.md

#### get_saturation

```python
def get_saturation(self):
    ...
```

### is_default property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/is_default.md

##### Definition:
```python
@property
def is_default(self):
    ...
```

### is_empty property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/is_empty.md

##### Definition:
```python
@property
def is_empty(self):
    ...
```

### is_fully_opaque property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/is_fully_opaque.md

##### Definition:
```python
@property
def is_fully_opaque(self):
    ...
```

### is_fully_transparent property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/is_fully_transparent.md

##### Definition:
```python
@property
def is_fully_transparent(self):
    ...
```

### is_translucent property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/is_translucent.md

##### Definition:
```python
@property
def is_translucent(self):
    ...
```

### r property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/r.md

##### Definition:
```python
@property
def r(self):
    ...
```

### to_argb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_argb.md

#### to_argb

```python
def to_argb(self):
    ...
```

### to_hex_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_hex_rgb.md

#### to_hex_rgb

```python
def to_hex_rgb(self):
    ...
```

### to_hex_rgba method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_hex_rgba.md

#### to_hex_rgba

```python
def to_hex_rgba(self):
    ...
```

### to_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_rgb.md

#### to_rgb

```python
def to_rgb(self):
    ...
```

### to_rgba method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_rgba.md

#### to_rgba

```python
def to_rgba(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/argb32color/value.md

##### Definition:
```python
@property
def value(self):
    ...
```

### CssLevel1 class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/csslevel1.md

#### CssLevel1 class

The CssLevel1 type exposes the following members:

### CssLevel2 class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/csslevel2.md

#### CssLevel2 class

The CssLevel2 type exposes the following members:

### CssLevel3 class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/csslevel3.md

#### CssLevel3 class

The CssLevel3 type exposes the following members:

### CssLevel4 class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/csslevel4.md

#### CssLevel4 class

The CssLevel4 type exposes the following members:

### Image2DFormat class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat.md

#### Image2DFormat class

The Image2DFormat type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_image_2d_format |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_image_2d_format |  |
| equals_object |  |
| get_hash_code |  |
| parse_from_filename_with_extension |  |
| parse_from_mime |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| file_extension |  |
| is_vector |  |
| mime_code |  |
| name |  |

### _equals_image_2d_format method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/_equals_image_2d_format.md

#### _equals_image_2d_format

```python
def _equals_image_2d_format(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Image2DFormat` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/_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/viewer/python-net/groupdocs.viewer.drawing/image2dformat/_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/viewer/python-net/groupdocs.viewer.drawing/image2dformat/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_image_2d_format method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/equals_image_2d_format.md

#### equals_image_2d_format

```python
def equals_image_2d_format(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### file_extension property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/file_extension.md

##### Definition:
```python
@property
def file_extension(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### is_vector property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/is_vector.md

##### Definition:
```python
@property
def is_vector(self):
    ...
```

### mime_code property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/mime_code.md

##### Definition:
```python
@property
def mime_code(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### parse_from_filename_with_extension method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/parse_from_filename_with_extension.md

#### parse_from_filename_with_extension

```python
def parse_from_filename_with_extension(cls, filename):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| filename | `str` |  |

**Returns:** Image2DFormat

### parse_from_mime method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/parse_from_mime.md

#### parse_from_mime

```python
def parse_from_mime(cls, mime_code):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| mime_code | `str` |  |

**Returns:** Image2DFormat

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/image2dformat/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### KnownColors class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/knowncolors.md

#### KnownColors class

The KnownColors type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| try_find_color |  |
| try_find_name |  |

### try_find_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/knowncolors/try_find_color.md

#### try_find_color

```python
def try_find_color(cls, keyword, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| keyword | `str` |  |
| output | `Any` |  |

**Returns:** bool

### try_find_name method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/knowncolors/try_find_name.md

#### try_find_name

```python
def try_find_name(cls, color, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| color | `Rgb24Color` |  |
| name | `Any` |  |

**Returns:** bool

### Rgb24Color class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color.md

#### Rgb24Color class

The Rgb24Color type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _equals_argb_32_color |  |
| _equals_object |  |
| _equals_rgb_24_color |  |
| _get_brightness_noargs |  |
| _get_hash_code_noargs |  |
| _get_hue_noargs |  |
| _get_saturation_noargs |  |
| _to_argb_noargs |  |
| _to_hex_noargs |  |
| _to_rgb_noargs |  |
| _to_string_noargs |  |
| equals |  |
| equals_argb_32_color |  |
| equals_object |  |
| equals_rgb_24_color |  |
| from_rgb |  |
| get_brightness |  |
| get_hash_code |  |
| get_hue |  |
| get_saturation |  |
| to_argb |  |
| to_hex |  |
| to_rgb |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| b |  |
| g |  |
| is_default |  |
| r |  |

### _equals_argb_32_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_equals_argb_32_color.md

#### _equals_argb_32_color

```python
def _equals_argb_32_color(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Argb32Color` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _equals_rgb_24_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_equals_rgb_24_color.md

#### _equals_rgb_24_color

```python
def _equals_rgb_24_color(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Rgb24Color` |  |

**Returns:** bool

### _get_brightness_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_get_brightness_noargs.md

#### _get_brightness_noargs

```python
def _get_brightness_noargs(self):
    ...
```

**Returns:** float

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _get_hue_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_get_hue_noargs.md

#### _get_hue_noargs

```python
def _get_hue_noargs(self):
    ...
```

**Returns:** float

### _get_saturation_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_get_saturation_noargs.md

#### _get_saturation_noargs

```python
def _get_saturation_noargs(self):
    ...
```

**Returns:** float

### _to_argb_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_to_argb_noargs.md

#### _to_argb_noargs

```python
def _to_argb_noargs(self):
    ...
```

**Returns:** int

### _to_hex_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_to_hex_noargs.md

#### _to_hex_noargs

```python
def _to_hex_noargs(self):
    ...
```

**Returns:** str

### _to_rgb_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_to_rgb_noargs.md

#### _to_rgb_noargs

```python
def _to_rgb_noargs(self):
    ...
```

**Returns:** str

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### b property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/b.md

##### Definition:
```python
@property
def b(self):
    ...
```

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_argb_32_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/equals_argb_32_color.md

#### equals_argb_32_color

```python
def equals_argb_32_color(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### equals_rgb_24_color method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/equals_rgb_24_color.md

#### equals_rgb_24_color

```python
def equals_rgb_24_color(self):
    ...
```

### from_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/from_rgb.md

#### from_rgb

```python
def from_rgb(cls, red, green, blue):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| red | `int` |  |
| green | `int` |  |
| blue | `int` |  |

**Returns:** Rgb24Color

### g property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/g.md

##### Definition:
```python
@property
def g(self):
    ...
```

### get_brightness method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/get_brightness.md

#### get_brightness

```python
def get_brightness(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_hue method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/get_hue.md

#### get_hue

```python
def get_hue(self):
    ...
```

### get_saturation method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/get_saturation.md

#### get_saturation

```python
def get_saturation(self):
    ...
```

### is_default property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/is_default.md

##### Definition:
```python
@property
def is_default(self):
    ...
```

### r property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/r.md

##### Definition:
```python
@property
def r(self):
    ...
```

### to_argb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/to_argb.md

#### to_argb

```python
def to_argb(self):
    ...
```

### to_hex method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/to_hex.md

#### to_hex

```python
def to_hex(self):
    ...
```

### to_rgb method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/to_rgb.md

#### to_rgb

```python
def to_rgb(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.drawing/rgb24color/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### groupdocs.viewer.exceptions
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions.md

The namespace provides different exceptions classes.

#### Classes
| Class | Description |
| :- | :- |
|GroupDocsViewerException|Represents the generic errors that occur during document processing.|
|IncorrectPasswordException|The exception that is thrown when specified password is incorrect.|
|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 unexpected and/or unsupported 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),<br/>            but actually is an image of unexpected and/or unsupported format or not an image at all.|
|PasswordRequiredException|The exception that is thrown when password is required to load the document.|

### GroupDocsViewerException
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions/groupdocsviewerexception.md

#### GroupDocsViewerException class

Represents the generic errors that occur during document processing.

The GroupDocsViewerException type exposes the following members:
#### Constructors
| Name | Description |
| :- | :- |
|GroupDocsViewerException(message)|Initializes a new instance of the GroupDocsViewerException class|

### IncorrectPasswordException
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions/incorrectpasswordexception.md

#### IncorrectPasswordException class

The exception that is thrown when specified password is incorrect.

The IncorrectPasswordException type exposes the following members:

### InvalidFontFormatException
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions/invalidfontformatexception.md

#### InvalidFontFormatException class

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 unexpected and/or unsupported format or not a font at all.

The InvalidFontFormatException type exposes the following members:
#### Constructors
| Name | Description |
| :- | :- |
|InvalidFontFormatException(message)|Initializes a new instance of the InvalidFontFormatException class|

### InvalidImageFormatException
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions/invalidimageformatexception.md

#### InvalidImageFormatException class

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),<br/>            but actually is an image of unexpected and/or unsupported format or not an image at all.

The InvalidImageFormatException type exposes the following members:
#### Constructors
| Name | Description |
| :- | :- |
|InvalidImageFormatException(message)|Initializes a new instance of the InvalidImageFormatException class|

### PasswordRequiredException
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.exceptions/passwordrequiredexception.md

#### PasswordRequiredException class

The exception that is thrown when password is required to load the document.

The PasswordRequiredException type exposes the following members:

### groupdocs.viewer.fonts
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts.md

Font loading and substitution configuration.

##### Classes
| Class | Description |
| :- | :- |
| `FolderFontSource` |  |
| `FontSettings` |  |
| `FontStyles` |  |
| `IFontInfo` |  |
| `PdfFontInfo` |  |
| `PresentationFontInfo` |  |
| `SpreadsheetFontInfo` |  |
| `WordProcessingFontInfo` |  |
| `WordProcessingSubstitutedFontInfo` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FontFormat` |  |
| `IFontSource` |  |
| `SearchOption` |  |

### FolderFontSource class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource.md

#### FolderFontSource class

The FolderFontSource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_folder_font_source |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _init_string_search_option |  |
| _to_string_noargs |  |
| equals |  |
| equals_folder_font_source |  |
| equals_object |  |
| get_hash_code |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| folder_path |  |
| search_option |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_folder_font_source method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/_equals_folder_font_source.md

#### _equals_folder_font_source

```python
def _equals_folder_font_source(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FolderFontSource` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/_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/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _init_string_search_option method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/_init_string_search_option.md

#### _init_string_search_option

```python
def _init_string_search_option(self, folder_path, search_option):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| folder_path | `str` |  |
| search_option | `SearchOption` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_folder_font_source method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/equals_folder_font_source.md

#### equals_folder_font_source

```python
def equals_folder_font_source(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### folder_path property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/folder_path.md

##### Definition:
```python
@property
def folder_path(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### search_option property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/search_option.md

##### Definition:
```python
@property
def search_option(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/folderfontsource/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### FontFormat class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat.md

#### FontFormat class

The FontFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN |  |
| TRUE_TYPE |  |
| OPEN_TYPE |  |
| TRUE_TYPE_COLLECTION |  |
| EMBEDDED_OPEN_TYPE |  |

### EMBEDDED_OPEN_TYPE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat/embedded_open_type.md

##### Value
`4`

### OPEN_TYPE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat/open_type.md

##### Value
`2`

### TRUE_TYPE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat/true_type.md

##### Value
`1`

### TRUE_TYPE_COLLECTION field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat/true_type_collection.md

##### Value
`3`

### UNKNOWN field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontformat/unknown.md

##### Value
`0`

### FontSettings class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontsettings.md

#### FontSettings class

The FontSettings type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| reset_font_sources |  |
| set_font_sources |  |

### reset_font_sources method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontsettings/reset_font_sources.md

#### reset_font_sources

```python
def reset_font_sources(cls):
    ...
```

### set_font_sources method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontsettings/set_font_sources.md

#### set_font_sources

```python
def set_font_sources(cls):
    ...
```

### FontStyles class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles.md

#### FontStyles class

The FontStyles type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_font_styles |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _init_boolean_boolean |  |
| _to_string_noargs |  |
| equals |  |
| equals_font_styles |  |
| equals_object |  |
| get_hash_code |  |
| to_string |  |
| try_parse |  |

##### Properties
| Property | Description |
| :- | :- |
| is_bold |  |
| is_italic |  |
| name |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_font_styles method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/_equals_font_styles.md

#### _equals_font_styles

```python
def _equals_font_styles(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FontStyles` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/_equals_object.md

#### _equals_object

```python
def _equals_object(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Any` |  |

**Returns:** bool

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/_get_hash_code_noargs.md

#### _get_hash_code_noargs

```python
def _get_hash_code_noargs(self):
    ...
```

**Returns:** int

### _init_boolean_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/_init_boolean_boolean.md

#### _init_boolean_boolean

```python
def _init_boolean_boolean(self, is_bold, is_italic):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| is_bold | `bool` |  |
| is_italic | `bool` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_font_styles method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/equals_font_styles.md

#### equals_font_styles

```python
def equals_font_styles(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### is_bold property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/is_bold.md

##### Definition:
```python
@property
def is_bold(self):
    ...
```

### is_italic property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/is_italic.md

##### Definition:
```python
@property
def is_italic(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### try_parse method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/fontstyles/try_parse.md

#### try_parse

```python
def try_parse(cls, style, parsed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| style | `str` |  |
| parsed | `Any` |  |

**Returns:** bool

### IFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo.md

#### IFontInfo class

The IFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |

##### Properties
| Property | Description |
| :- | :- |
| content |  |
| family_name |  |
| format |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### IFontSource class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/ifontsource.md

#### IFontSource class

The IFontSource type exposes the following members:

### PdfFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo.md

#### PdfFontInfo class

The PdfFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |

##### Properties
| Property | Description |
| :- | :- |
| content |  |
| family_name |  |
| format |  |
| is_embedded |  |
| is_installed |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_embedded property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/is_embedded.md

##### Definition:
```python
@property
def is_embedded(self):
    ...
```

### is_installed property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/is_installed.md

##### Definition:
```python
@property
def is_installed(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/pdffontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### PresentationFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo.md

#### PresentationFontInfo class

The PresentationFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |

##### Properties
| Property | Description |
| :- | :- |
| content |  |
| family_name |  |
| format |  |
| is_embedded |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_embedded property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/is_embedded.md

##### Definition:
```python
@property
def is_embedded(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/presentationfontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### SearchOption class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/searchoption.md

#### SearchOption class

The SearchOption type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TOP_FOLDER_ONLY |  |
| ALL_FOLDERS |  |

### ALL_FOLDERS field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/searchoption/all_folders.md

##### Value
`1`

### TOP_FOLDER_ONLY field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/searchoption/top_folder_only.md

##### Value
`0`

### SpreadsheetFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo.md

#### SpreadsheetFontInfo class

The SpreadsheetFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |

##### Properties
| Property | Description |
| :- | :- |
| charset |  |
| color |  |
| content |  |
| family_name |  |
| format |  |
| is_strikeout |  |
| is_underline |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### charset property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/charset.md

##### Definition:
```python
@property
def charset(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/color.md

##### Definition:
```python
@property
def color(self):
    ...
```

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_strikeout property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/is_strikeout.md

##### Definition:
```python
@property
def is_strikeout(self):
    ...
```

### is_underline property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/is_underline.md

##### Definition:
```python
@property
def is_underline(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/spreadsheetfontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### WordProcessingFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo.md

#### WordProcessingFontInfo class

The WordProcessingFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| _to_string_noargs |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| alt_family_name |  |
| charset |  |
| content |  |
| family_name |  |
| format |  |
| is_embedded |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### alt_family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/alt_family_name.md

##### Definition:
```python
@property
def alt_family_name(self):
    ...
```

### charset property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/charset.md

##### Definition:
```python
@property
def charset(self):
    ...
```

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### is_embedded property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/is_embedded.md

##### Definition:
```python
@property
def is_embedded(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingfontinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### WordProcessingSubstitutedFontInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo.md

#### WordProcessingSubstitutedFontInfo class

The WordProcessingSubstitutedFontInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _serialize_to_css_text_writer |  |
| _to_string_noargs |  |
| serialize_to_css |  |
| serialize_to_css_text_writer |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| content |  |
| family_name |  |
| format |  |
| original_family_name |  |
| style |  |

### _serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/_serialize_to_css_text_writer.md

#### _serialize_to_css_text_writer

```python
def _serialize_to_css_text_writer(self, output):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output | `TextWriter` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### content property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/content.md

##### Definition:
```python
@property
def content(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/family_name.md

##### Definition:
```python
@property
def family_name(self):
    ...
```

### format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/format.md

##### Definition:
```python
@property
def format(self):
    ...
```

### original_family_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/original_family_name.md

##### Definition:
```python
@property
def original_family_name(self):
    ...
```

### serialize_to_css method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/serialize_to_css.md

#### serialize_to_css

```python
def serialize_to_css(self):
    ...
```

### serialize_to_css_text_writer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/serialize_to_css_text_writer.md

#### serialize_to_css_text_writer

```python
def serialize_to_css_text_writer(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/style.md

##### Definition:
```python
@property
def style(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.fonts/wordprocessingsubstitutedfontinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### groupdocs.viewer.interfaces
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces.md

Types under `groupdocs.viewer.interfaces`.

##### Classes
| Class | Description |
| :- | :- |
| `CreateFileStream` |  |
| `CreatePageStream` |  |
| `CreateResourceStream` |  |
| `CreateResourceUrl` |  |
| `IFileStreamFactory` |  |
| `IPageStreamFactory` |  |
| `IResourceStreamFactory` |  |
| `ReleaseFileStream` |  |
| `ReleasePageStream` |  |
| `ReleaseResourceStream` |  |

### CreateFileStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream.md

#### CreateFileStream class

The CreateFileStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_noargs |  |
| begin_invoke |  |
| begin_invoke_async_callback |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/_begin_invoke_async_callback_object.md

#### _begin_invoke_async_callback_object

```python
def _begin_invoke_async_callback_object(self, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/_invoke_noargs.md

#### _invoke_noargs

```python
def _invoke_noargs(self):
    ...
```

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_async_callback method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/begin_invoke_async_callback.md

#### begin_invoke_async_callback

```python
def begin_invoke_async_callback(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createfilestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### CreatePageStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream.md

#### CreatePageStream class

The CreatePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32 |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/_begin_invoke_int32_async_callback_object.md

#### _begin_invoke_int32_async_callback_object

```python
def _begin_invoke_int32_async_callback_object(self, page_number, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/_invoke_int32.md

#### _invoke_int32

```python
def _invoke_int32(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### CreateResourceStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream.md

#### CreateResourceStream class

The CreateResourceStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_resource_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_resource |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_resource_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/_begin_invoke_int32_resource_async_callback_object.md

#### _begin_invoke_int32_resource_async_callback_object

```python
def _begin_invoke_int32_resource_async_callback_object(self, page_number, resource, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** Stream

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_resource method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/_invoke_int32_resource.md

#### _invoke_int32_resource

```python
def _invoke_int32_resource(self, page_number, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |

**Returns:** Stream

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourcestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### CreateResourceUrl class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl.md

#### CreateResourceUrl class

The CreateResourceUrl type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_resource_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_resource |  |
| begin_invoke |  |
| begin_invoke_int32 |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_int32 |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_resource_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/_begin_invoke_int32_resource_async_callback_object.md

#### _begin_invoke_int32_resource_async_callback_object

```python
def _begin_invoke_int32_resource_async_callback_object(self, page_number, resource, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

**Returns:** str

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_resource method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/_invoke_int32_resource.md

#### _invoke_int32_resource

```python
def _invoke_int32_resource(self, page_number, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |

**Returns:** str

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/createresourceurl/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### IFileStreamFactory class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory.md

#### IFileStreamFactory class

The IFileStreamFactory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _create_file_stream_noargs |  |
| _release_file_stream_stream |  |
| create_file_stream |  |
| release_file_stream |  |
| release_file_stream_stream |  |
| release_file_stream_streams |  |

### _create_file_stream_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/_create_file_stream_noargs.md

#### _create_file_stream_noargs

```python
def _create_file_stream_noargs(self):
    ...
```

**Returns:** Stream

### _release_file_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/_release_file_stream_stream.md

#### _release_file_stream_stream

```python
def _release_file_stream_stream(self, file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_stream | `Stream` |  |

### create_file_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/create_file_stream.md

#### create_file_stream

```python
def create_file_stream(self):
    ...
```

### release_file_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/release_file_stream.md

#### release_file_stream

```python
def release_file_stream(self):
    ...
```

### release_file_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/release_file_stream_stream.md

#### release_file_stream_stream

```python
def release_file_stream_stream(self):
    ...
```

### release_file_stream_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ifilestreamfactory/release_file_stream_streams.md

#### release_file_stream_streams

```python
def release_file_stream_streams(self):
    ...
```

### IPageStreamFactory class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory.md

#### IPageStreamFactory class

The IPageStreamFactory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _create_page_stream_int32 |  |
| _release_page_stream_int32_stream |  |
| create_page_stream |  |
| create_page_stream_int32 |  |
| release_page_stream |  |
| release_page_stream_int32 |  |
| release_page_stream_stream |  |
| release_page_stream_streams |  |

### _create_page_stream_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/_create_page_stream_int32.md

#### _create_page_stream_int32

```python
def _create_page_stream_int32(self, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |

**Returns:** Stream

### _release_page_stream_int32_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/_release_page_stream_int32_stream.md

#### _release_page_stream_int32_stream

```python
def _release_page_stream_int32_stream(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |

### create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/create_page_stream.md

#### create_page_stream

```python
def create_page_stream(self):
    ...
```

### create_page_stream_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/create_page_stream_int32.md

#### create_page_stream_int32

```python
def create_page_stream_int32(self):
    ...
```

### release_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/release_page_stream.md

#### release_page_stream

```python
def release_page_stream(self):
    ...
```

### release_page_stream_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/release_page_stream_int32.md

#### release_page_stream_int32

```python
def release_page_stream_int32(self):
    ...
```

### release_page_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/release_page_stream_stream.md

#### release_page_stream_stream

```python
def release_page_stream_stream(self):
    ...
```

### release_page_stream_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/ipagestreamfactory/release_page_stream_streams.md

#### release_page_stream_streams

```python
def release_page_stream_streams(self):
    ...
```

### IResourceStreamFactory class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory.md

#### IResourceStreamFactory class

The IResourceStreamFactory type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _create_resource_stream_int32_resource |  |
| _create_resource_url_int32_resource |  |
| _release_resource_stream_int32_resource_stream |  |
| create_resource_stream |  |
| create_resource_stream_int32 |  |
| create_resource_url |  |
| create_resource_url_int32 |  |
| release_resource_stream |  |
| release_resource_stream_int32 |  |
| release_resource_stream_stream |  |
| release_resource_stream_streams |  |

### _create_resource_stream_int32_resource method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/_create_resource_stream_int32_resource.md

#### _create_resource_stream_int32_resource

```python
def _create_resource_stream_int32_resource(self, page_number, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |

**Returns:** Stream

### _create_resource_url_int32_resource method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/_create_resource_url_int32_resource.md

#### _create_resource_url_int32_resource

```python
def _create_resource_url_int32_resource(self, page_number, resource):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |

**Returns:** str

### _release_resource_stream_int32_resource_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/_release_resource_stream_int32_resource_stream.md

#### _release_resource_stream_int32_resource_stream

```python
def _release_resource_stream_int32_resource_stream(self, page_number, resource, resource_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |
| resource_stream | `Stream` |  |

### create_resource_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/create_resource_stream.md

#### create_resource_stream

```python
def create_resource_stream(self):
    ...
```

### create_resource_stream_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/create_resource_stream_int32.md

#### create_resource_stream_int32

```python
def create_resource_stream_int32(self):
    ...
```

### create_resource_url method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/create_resource_url.md

#### create_resource_url

```python
def create_resource_url(self):
    ...
```

### create_resource_url_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/create_resource_url_int32.md

#### create_resource_url_int32

```python
def create_resource_url_int32(self):
    ...
```

### release_resource_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/release_resource_stream.md

#### release_resource_stream

```python
def release_resource_stream(self):
    ...
```

### release_resource_stream_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/release_resource_stream_int32.md

#### release_resource_stream_int32

```python
def release_resource_stream_int32(self):
    ...
```

### release_resource_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/release_resource_stream_stream.md

#### release_resource_stream_stream

```python
def release_resource_stream_stream(self):
    ...
```

### release_resource_stream_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/iresourcestreamfactory/release_resource_stream_streams.md

#### release_resource_stream_streams

```python
def release_resource_stream_streams(self):
    ...
```

### ReleaseFileStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream.md

#### ReleaseFileStream class

The ReleaseFileStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_stream |  |
| begin_invoke |  |
| begin_invoke_stream |  |
| begin_invoke_streams |  |
| end_invoke |  |
| end_invoke_iasync_result |  |
| invoke |  |
| invoke_stream |  |
| invoke_streams |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_stream_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/_begin_invoke_stream_async_callback_object.md

#### _begin_invoke_stream_async_callback_object

```python
def _begin_invoke_stream_async_callback_object(self, file_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/_invoke_stream.md

#### _invoke_stream

```python
def _invoke_stream(self, file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasefilestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream.md

#### ReleasePageStream class

The ReleasePageStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_stream |  |
| 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/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_stream_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/_begin_invoke_int32_stream_async_callback_object.md

#### _begin_invoke_int32_stream_async_callback_object

```python
def _begin_invoke_int32_stream_async_callback_object(self, page_number, page_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/_invoke_int32_stream.md

#### _invoke_int32_stream

```python
def _invoke_int32_stream(self, page_number, page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| page_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### ReleaseResourceStream class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream.md

#### ReleaseResourceStream class

The ReleaseResourceStream type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _begin_invoke_int32_resource_stream_async_callback_object |  |
| _end_invoke_iasync_result |  |
| _init_object_int_ptr |  |
| _invoke_int32_resource_stream |  |
| 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/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _begin_invoke_int32_resource_stream_async_callback_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/_begin_invoke_int32_resource_stream_async_callback_object.md

#### _begin_invoke_int32_resource_stream_async_callback_object

```python
def _begin_invoke_int32_resource_stream_async_callback_object(self, page_number, resource, resource_stream, callback, object):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |
| resource_stream | `Stream` |  |
| callback | `AsyncCallback` |  |
| object | `Any` |  |

**Returns:** IAsyncResult

### _end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/_end_invoke_iasync_result.md

#### _end_invoke_iasync_result

```python
def _end_invoke_iasync_result(self, result):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| result | `IAsyncResult` |  |

### _init_object_int_ptr method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/_init_object_int_ptr.md

#### _init_object_int_ptr

```python
def _init_object_int_ptr(self, object, method):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| object | `Any` |  |
| method | `IntPtr` |  |

### _invoke_int32_resource_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/_invoke_int32_resource_stream.md

#### _invoke_int32_resource_stream

```python
def _invoke_int32_resource_stream(self, page_number, resource, resource_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| resource | `Resource` |  |
| resource_stream | `Stream` |  |

### begin_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/begin_invoke.md

#### begin_invoke

```python
def begin_invoke(self):
    ...
```

### begin_invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/end_invoke.md

#### end_invoke

```python
def end_invoke(self):
    ...
```

### end_invoke_iasync_result method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/end_invoke_iasync_result.md

#### end_invoke_iasync_result

```python
def end_invoke_iasync_result(self):
    ...
```

### invoke method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/invoke.md

#### invoke

```python
def invoke(self):
    ...
```

### invoke_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.interfaces/releaseresourcestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### groupdocs.viewer.logging
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging.md

Logging hooks and listener interfaces.

##### Classes
| Class | Description |
| :- | :- |
| `ConsoleLogger` |  |
| `FileLogger` |  |
| `ILogger` |  |

### ConsoleLogger class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.logging/consolelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.logging/consolelogger/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _trace_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.logging/consolelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/consolelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### FileLogger class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger.md

#### FileLogger class

The FileLogger type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _error_string_exception |  |
| _init_string |  |
| _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/viewer/python-net/groupdocs.viewer.logging/filelogger/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _error_string_exception method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/_error_string_exception.md

#### _error_string_exception

```python
def _error_string_exception(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |
| exception | `Exception` |  |

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/_init_string.md

#### _init_string

```python
def _init_string(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

### _trace_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/_trace_string.md

#### _trace_string

```python
def _trace_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### _warning_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/_warning_string.md

#### _warning_string

```python
def _warning_string(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` |  |

### error method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/filelogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.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/viewer/python-net/groupdocs.viewer.logging/ilogger/error.md

#### error

```python
def error(self):
    ...
```

### error_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/trace.md

#### trace

```python
def trace(self):
    ...
```

### trace_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/warning.md

#### warning

```python
def warning(self):
    ...
```

### warning_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.logging/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### groupdocs.viewer.options
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `ArchiveOptions` |  |
| `BaseViewOptions` |  |
| `CadOptions` |  |
| `EmailOptions` |  |
| `Field` |  |
| `FileName` |  |
| `HtmlViewOptions` |  |
| `IMaxSizeOptions` |  |
| `JpgViewOptions` |  |
| `LoadOptions` |  |
| `MailStorageOptions` |  |
| `OutlookOptions` |  |
| `PdfOptimizationOptions` |  |
| `PdfOptions` |  |
| `PdfViewOptions` |  |
| `PngViewOptions` |  |
| `PresentationOptions` |  |
| `Resolution` |  |
| `SearchHighlightOptions` |  |
| `Security` |  |
| `Size` |  |
| `SpreadsheetOptions` |  |
| `TextOptions` |  |
| `Tile` |  |
| `ViewInfoOptions` |  |
| `ViewOptions` |  |
| `VisioRenderingOptions` |  |
| `Watermark` |  |
| `WebDocumentOptions` |  |
| `WordProcessingOptions` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ImageQuality` |  |
| `PageSize` |  |
| `Permissions` |  |
| `Position` |  |
| `Rotation` |  |
| `TextOverflowMode` |  |
| `TimeUnit` |  |

### ArchiveOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/archiveoptions.md

#### ArchiveOptions class

The ArchiveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| file_name |  |
| folder |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/archiveoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/archiveoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### file_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/archiveoptions/file_name.md

##### Definition:
```python
@property
def file_name(self):
    ...
@file_name.setter
def file_name(self, value):
    ...
```

### folder property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/archiveoptions/folder.md

##### Definition:
```python
@property
def folder(self):
    ...
@folder.setter
def folder(self, value):
    ...
```

### BaseViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions.md

#### BaseViewOptions class

The BaseViewOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| archive_options |  |
| cad_options |  |
| default_font_name |  |
| email_options |  |
| mail_storage_options |  |
| outlook_options |  |
| pdf_options |  |
| presentation_options |  |
| remove_comments |  |
| render_comments |  |
| render_hidden_pages |  |
| render_notes |  |
| spreadsheet_options |  |
| text_options |  |
| visio_rendering_options |  |
| web_document_options |  |
| word_processing_options |  |

### archive_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/archive_options.md

##### Definition:
```python
@property
def archive_options(self):
    ...
@archive_options.setter
def archive_options(self, value):
    ...
```

### cad_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/cad_options.md

##### Definition:
```python
@property
def cad_options(self):
    ...
@cad_options.setter
def cad_options(self, value):
    ...
```

### default_font_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/default_font_name.md

##### Definition:
```python
@property
def default_font_name(self):
    ...
@default_font_name.setter
def default_font_name(self, value):
    ...
```

### email_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/email_options.md

##### Definition:
```python
@property
def email_options(self):
    ...
@email_options.setter
def email_options(self, value):
    ...
```

### mail_storage_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/mail_storage_options.md

##### Definition:
```python
@property
def mail_storage_options(self):
    ...
@mail_storage_options.setter
def mail_storage_options(self, value):
    ...
```

### outlook_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/outlook_options.md

##### Definition:
```python
@property
def outlook_options(self):
    ...
@outlook_options.setter
def outlook_options(self, value):
    ...
```

### pdf_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/pdf_options.md

##### Definition:
```python
@property
def pdf_options(self):
    ...
@pdf_options.setter
def pdf_options(self, value):
    ...
```

### presentation_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/presentation_options.md

##### Definition:
```python
@property
def presentation_options(self):
    ...
@presentation_options.setter
def presentation_options(self, value):
    ...
```

### project_management_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/project_management_options.md

##### Definition:
```python
@property
def project_management_options(self):
    ...
@project_management_options.setter
def project_management_options(self, value):
    ...
```

### remove_comments property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/remove_comments.md

##### Definition:
```python
@property
def remove_comments(self):
    ...
@remove_comments.setter
def remove_comments(self, value):
    ...
```

### render_comments property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/render_comments.md

##### Definition:
```python
@property
def render_comments(self):
    ...
@render_comments.setter
def render_comments(self, value):
    ...
```

### render_hidden_pages property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/render_hidden_pages.md

##### Definition:
```python
@property
def render_hidden_pages(self):
    ...
@render_hidden_pages.setter
def render_hidden_pages(self, value):
    ...
```

### render_notes property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/render_notes.md

##### Definition:
```python
@property
def render_notes(self):
    ...
@render_notes.setter
def render_notes(self, value):
    ...
```

### spreadsheet_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/spreadsheet_options.md

##### Definition:
```python
@property
def spreadsheet_options(self):
    ...
@spreadsheet_options.setter
def spreadsheet_options(self, value):
    ...
```

### text_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/text_options.md

##### Definition:
```python
@property
def text_options(self):
    ...
@text_options.setter
def text_options(self, value):
    ...
```

### visio_rendering_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/visio_rendering_options.md

##### Definition:
```python
@property
def visio_rendering_options(self):
    ...
@visio_rendering_options.setter
def visio_rendering_options(self, value):
    ...
```

### web_document_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/web_document_options.md

##### Definition:
```python
@property
def web_document_options(self):
    ...
@web_document_options.setter
def web_document_options(self, value):
    ...
```

### word_processing_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/baseviewoptions/word_processing_options.md

##### Definition:
```python
@property
def word_processing_options(self):
    ...
@word_processing_options.setter
def word_processing_options(self, value):
    ...
```

### CadOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions.md

#### CadOptions class

The CadOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| for_rendering_by_height |  |
| for_rendering_by_scale_factor |  |
| for_rendering_by_width |  |
| for_rendering_by_width_and_height |  |

##### Properties
| Property | Description |
| :- | :- |
| background_color |  |
| enable_performance_conversion_mode |  |
| height |  |
| layers |  |
| layout_name |  |
| pc3_file |  |
| render_layouts |  |
| scale_factor |  |
| tiles |  |
| width |  |

### background_color property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/background_color.md

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### enable_performance_conversion_mode property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/enable_performance_conversion_mode.md

##### Definition:
```python
@property
def enable_performance_conversion_mode(self):
    ...
@enable_performance_conversion_mode.setter
def enable_performance_conversion_mode(self, value):
    ...
```

### for_rendering_by_height method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/for_rendering_by_height.md

#### for_rendering_by_height

```python
def for_rendering_by_height(cls, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| height | `int` |  |

**Returns:** CadOptions

### for_rendering_by_scale_factor method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/for_rendering_by_scale_factor.md

#### for_rendering_by_scale_factor

```python
def for_rendering_by_scale_factor(cls, scale_factor):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| scale_factor | `float` |  |

**Returns:** CadOptions

### for_rendering_by_width method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/for_rendering_by_width.md

#### for_rendering_by_width

```python
def for_rendering_by_width(cls, width):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | `int` |  |

**Returns:** CadOptions

### for_rendering_by_width_and_height method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/for_rendering_by_width_and_height.md

#### for_rendering_by_width_and_height

```python
def for_rendering_by_width_and_height(cls, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| width | `int` |  |
| height | `int` |  |

**Returns:** CadOptions

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### layers property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/layers.md

##### Definition:
```python
@property
def layers(self):
    ...
@layers.setter
def layers(self, value):
    ...
```

### layout_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/layout_name.md

##### Definition:
```python
@property
def layout_name(self):
    ...
@layout_name.setter
def layout_name(self, value):
    ...
```

### pc3_file property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/pc3_file.md

##### Definition:
```python
@property
def pc3_file(self):
    ...
@pc3_file.setter
def pc3_file(self, value):
    ...
```

### render_layouts property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/render_layouts.md

##### Definition:
```python
@property
def render_layouts(self):
    ...
@render_layouts.setter
def render_layouts(self, value):
    ...
```

### scale_factor property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/scale_factor.md

##### Definition:
```python
@property
def scale_factor(self):
    ...
```

### tiles property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/tiles.md

##### Definition:
```python
@property
def tiles(self):
    ...
@tiles.setter
def tiles(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/cadoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### EmailOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions.md

#### EmailOptions class

The EmailOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| date_time_format |  |
| field_text_map |  |
| page_size |  |
| time_zone_offset |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### date_time_format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/date_time_format.md

##### Definition:
```python
@property
def date_time_format(self):
    ...
@date_time_format.setter
def date_time_format(self, value):
    ...
```

### field_text_map property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/field_text_map.md

##### Definition:
```python
@property
def field_text_map(self):
    ...
@field_text_map.setter
def field_text_map(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### time_zone_offset property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/emailoptions/time_zone_offset.md

##### Definition:
```python
@property
def time_zone_offset(self):
    ...
@time_zone_offset.setter
def time_zone_offset(self, value):
    ...
```

### Field class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/field.md

#### Field class

The Field type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| name |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/field/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/field/name.md

##### Definition:
```python
@property
def name(self):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/field/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### FileName class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/filename.md

#### FileName class

The FileName type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |
| _to_string_noargs |  |
| to_string |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/filename/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/filename/_init_string.md

#### _init_string

```python
def _init_string(self, file_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/filename/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/filename/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### HtmlViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions.md

#### HtmlViewOptions class

The HtmlViewOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _for_embedded_resources_create_page_stream |  |
| _for_embedded_resources_create_page_stream_release_page_stream |  |
| _for_embedded_resources_ipage_stream_factory |  |
| _for_embedded_resources_noargs |  |
| _for_embedded_resources_string |  |
| _for_external_resources_create_page_stream_create_resource_stream_create_resource_url |  |
| _for_external_resources_create_page_stream_create_resource_stream_create_resource_url_release_page_stream_release_resource_stream |  |
| _for_external_resources_ipage_stream_factory_iresource_stream_factory |  |
| _for_external_resources_noargs |  |
| _for_external_resources_string_string_string |  |
| for_embedded_resources |  |
| for_embedded_resources_create_page_stream |  |
| for_embedded_resources_file |  |
| for_embedded_resources_ipage_stream_factory |  |
| for_embedded_resources_string |  |
| for_external_resources |  |
| for_external_resources_create_page_stream |  |
| for_external_resources_file |  |
| for_external_resources_ipage_stream_factory |  |
| for_external_resources_string |  |
| _rotate_page_int32_rotation |  (inherited from `ViewOptions`) |
| rotate_page |  (inherited from `ViewOptions`) |
| rotate_page_int32 |  (inherited from `ViewOptions`) |

##### Properties
| Property | Description |
| :- | :- |
| exclude_fonts |  |
| fonts_to_exclude |  |
| for_printing |  |
| image_height |  |
| image_max_height |  |
| image_max_width |  |
| image_width |  |
| minify |  |
| remove_java_script |  |
| render_responsive |  |
| render_to_single_page |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| watermark |  (inherited from `ViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### _for_embedded_resources_create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_embedded_resources_create_page_stream.md

#### _for_embedded_resources_create_page_stream

```python
def _for_embedded_resources_create_page_stream(cls, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |

**Returns:** HtmlViewOptions

### _for_embedded_resources_create_page_stream_release_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_embedded_resources_create_page_stream_release_page_stream.md

#### _for_embedded_resources_create_page_stream_release_page_stream

```python
def _for_embedded_resources_create_page_stream_release_page_stream(cls, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| release_page_stream | `ReleasePageStream` |  |

**Returns:** HtmlViewOptions

### _for_embedded_resources_ipage_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_embedded_resources_ipage_stream_factory.md

#### _for_embedded_resources_ipage_stream_factory

```python
def _for_embedded_resources_ipage_stream_factory(cls, page_stream_factory):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_stream_factory | `IPageStreamFactory` |  |

**Returns:** HtmlViewOptions

### _for_embedded_resources_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_embedded_resources_noargs.md

#### _for_embedded_resources_noargs

```python
def _for_embedded_resources_noargs(cls):
    ...
```

**Returns:** HtmlViewOptions

### _for_embedded_resources_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_embedded_resources_string.md

#### _for_embedded_resources_string

```python
def _for_embedded_resources_string(cls, file_path_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |

**Returns:** HtmlViewOptions

### _for_external_resources_create_page_stream_create_resource_stream_create_resource_url method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_external_resources_create_page_stream_create_resource_stream_create_resource_url.md

#### _for_external_resources_create_page_stream_create_resource_stream_create_resource_url

```python
def _for_external_resources_create_page_stream_create_resource_stream_create_resource_url(cls, create_page_stream, create_resource_stream, create_resource_url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| create_resource_stream | `CreateResourceStream` |  |
| create_resource_url | `CreateResourceUrl` |  |

**Returns:** HtmlViewOptions

### _for_external_resources_create_page_stream_create_resource_stream_create_resource_url_release_page_stream_release_resource_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_external_resources_create_page_stream_create_resource_stream_create_resource_url_release_page_stream_release_resource_stream.md

#### _for_external_resources_create_page_stream_create_resource_stream_create_resource_url_release_page_stream_release_resource_stream

```python
def _for_external_resources_create_page_stream_create_resource_stream_create_resource_url_release_page_stream_release_resource_stream(cls, create_page_stream, create_resource_stream, create_resource_url, release_page_stream, release_resource_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` |  |
| create_resource_stream | `CreateResourceStream` |  |
| create_resource_url | `CreateResourceUrl` |  |
| release_page_stream | `ReleasePageStream` |  |
| release_resource_stream | `ReleaseResourceStream` |  |

**Returns:** HtmlViewOptions

### _for_external_resources_ipage_stream_factory_iresource_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_external_resources_ipage_stream_factory_iresource_stream_factory.md

#### _for_external_resources_ipage_stream_factory_iresource_stream_factory

```python
def _for_external_resources_ipage_stream_factory_iresource_stream_factory(cls, page_stream_factory, resource_stream_factory):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_stream_factory | `IPageStreamFactory` |  |
| resource_stream_factory | `IResourceStreamFactory` |  |

**Returns:** HtmlViewOptions

### _for_external_resources_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_external_resources_noargs.md

#### _for_external_resources_noargs

```python
def _for_external_resources_noargs(cls):
    ...
```

**Returns:** HtmlViewOptions

### _for_external_resources_string_string_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/_for_external_resources_string_string_string.md

#### _for_external_resources_string_string_string

```python
def _for_external_resources_string_string_string(cls, file_path_format, resource_file_path_format, resource_url_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |
| resource_file_path_format | `str` |  |
| resource_url_format | `str` |  |

**Returns:** HtmlViewOptions

### exclude_fonts property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/exclude_fonts.md

##### Definition:
```python
@property
def exclude_fonts(self):
    ...
@exclude_fonts.setter
def exclude_fonts(self, value):
    ...
```

### fonts_to_exclude property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/fonts_to_exclude.md

##### Definition:
```python
@property
def fonts_to_exclude(self):
    ...
@fonts_to_exclude.setter
def fonts_to_exclude(self, value):
    ...
```

### for_embedded_resources method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_embedded_resources.md

#### for_embedded_resources

```python
def for_embedded_resources(cls):
    ...
```

### for_embedded_resources_create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_embedded_resources_create_page_stream.md

#### for_embedded_resources_create_page_stream

```python
def for_embedded_resources_create_page_stream(cls):
    ...
```

### for_embedded_resources_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_embedded_resources_file.md

#### for_embedded_resources_file

```python
def for_embedded_resources_file(cls):
    ...
```

### for_embedded_resources_ipage_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_embedded_resources_ipage_stream_factory.md

#### for_embedded_resources_ipage_stream_factory

```python
def for_embedded_resources_ipage_stream_factory(cls):
    ...
```

### for_embedded_resources_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_embedded_resources_string.md

#### for_embedded_resources_string

```python
def for_embedded_resources_string(cls):
    ...
```

### for_external_resources method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_external_resources.md

#### for_external_resources

```python
def for_external_resources(cls):
    ...
```

### for_external_resources_create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_external_resources_create_page_stream.md

#### for_external_resources_create_page_stream

```python
def for_external_resources_create_page_stream(cls):
    ...
```

### for_external_resources_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_external_resources_file.md

#### for_external_resources_file

```python
def for_external_resources_file(cls):
    ...
```

### for_external_resources_ipage_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_external_resources_ipage_stream_factory.md

#### for_external_resources_ipage_stream_factory

```python
def for_external_resources_ipage_stream_factory(cls):
    ...
```

### for_external_resources_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_external_resources_string.md

#### for_external_resources_string

```python
def for_external_resources_string(cls):
    ...
```

### for_printing property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/for_printing.md

##### Definition:
```python
@property
def for_printing(self):
    ...
@for_printing.setter
def for_printing(self, value):
    ...
```

### image_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/image_height.md

##### Definition:
```python
@property
def image_height(self):
    ...
@image_height.setter
def image_height(self, value):
    ...
```

### image_max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/image_max_height.md

##### Definition:
```python
@property
def image_max_height(self):
    ...
@image_max_height.setter
def image_max_height(self, value):
    ...
```

### image_max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/image_max_width.md

##### Definition:
```python
@property
def image_max_width(self):
    ...
@image_max_width.setter
def image_max_width(self, value):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/image_width.md

##### Definition:
```python
@property
def image_width(self):
    ...
@image_width.setter
def image_width(self, value):
    ...
```

### minify property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/minify.md

##### Definition:
```python
@property
def minify(self):
    ...
@minify.setter
def minify(self, value):
    ...
```

### remove_java_script property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/remove_java_script.md

##### Definition:
```python
@property
def remove_java_script(self):
    ...
@remove_java_script.setter
def remove_java_script(self, value):
    ...
```

### render_responsive property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/render_responsive.md

##### Definition:
```python
@property
def render_responsive(self):
    ...
@render_responsive.setter
def render_responsive(self, value):
    ...
```

### render_to_single_page property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/htmlviewoptions/render_to_single_page.md

##### Definition:
```python
@property
def render_to_single_page(self):
    ...
@render_to_single_page.setter
def render_to_single_page(self, value):
    ...
```

### ImageQuality class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imagequality.md

#### ImageQuality class

The ImageQuality type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LOW |  |
| MEDIUM |  |
| HIGH |  |

### HIGH field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imagequality/high.md

##### Value
`300`

### LOW field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imagequality/low.md

##### Value
`96`

### MEDIUM field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imagequality/medium.md

##### Value
`198`

### IMaxSizeOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imaxsizeoptions.md

#### IMaxSizeOptions class

The IMaxSizeOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| max_height |  |
| max_width |  |

### max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imaxsizeoptions/max_height.md

##### Definition:
```python
@property
def max_height(self):
    ...
@max_height.setter
def max_height(self, value):
    ...
```

### max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/imaxsizeoptions/max_width.md

##### Definition:
```python
@property
def max_width(self):
    ...
@max_width.setter
def max_width(self, value):
    ...
```

### JpgViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions.md

#### JpgViewOptions class

The JpgViewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_create_page_stream |  |
| _init_create_page_stream_release_page_stream |  |
| _init_ipage_stream_factory |  |
| _init_noargs |  |
| _init_string |  |
| _rotate_page_int32_rotation |  (inherited from `ViewOptions`) |
| rotate_page |  (inherited from `ViewOptions`) |
| rotate_page_int32 |  (inherited from `ViewOptions`) |

##### Properties
| Property | Description |
| :- | :- |
| extract_text |  |
| height |  |
| max_height |  |
| max_width |  |
| quality |  |
| width |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| watermark |  (inherited from `ViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/_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/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/_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` |  |

### _init_ipage_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/_init_ipage_stream_factory.md

#### _init_ipage_stream_factory

```python
def _init_ipage_stream_factory(self, page_stream_factory):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_stream_factory | `IPageStreamFactory` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/_init_string.md

#### _init_string

```python
def _init_string(self, file_path_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |

### extract_text property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/extract_text.md

##### Definition:
```python
@property
def extract_text(self):
    ...
@extract_text.setter
def extract_text(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/max_height.md

##### Definition:
```python
@property
def max_height(self):
    ...
@max_height.setter
def max_height(self, value):
    ...
```

### max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/max_width.md

##### Definition:
```python
@property
def max_width(self):
    ...
@max_width.setter
def max_width(self, value):
    ...
```

### quality property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/quality.md

##### Definition:
```python
@property
def quality(self):
    ...
@quality.setter
def quality(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/jpgviewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions.md

#### LoadOptions class

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| detect_encoding |  |
| encoding |  |
| file_type |  |
| password |  |
| resource_loading_timeout |  |
| skip_external_resources |  |
| try_repair |  |
| whitelisted_resources |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### detect_encoding property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/detect_encoding.md

##### Definition:
```python
@property
def detect_encoding(self):
    ...
@detect_encoding.setter
def detect_encoding(self, value):
    ...
```

### encoding property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/encoding.md

##### Definition:
```python
@property
def encoding(self):
    ...
@encoding.setter
def encoding(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/password.md

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### resource_loading_timeout property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/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/viewer/python-net/groupdocs.viewer.options/loadoptions/skip_external_resources.md

##### Definition:
```python
@property
def skip_external_resources(self):
    ...
@skip_external_resources.setter
def skip_external_resources(self, value):
    ...
```

### try_repair property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/try_repair.md

##### Definition:
```python
@property
def try_repair(self):
    ...
@try_repair.setter
def try_repair(self, value):
    ...
```

### whitelisted_resources property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/loadoptions/whitelisted_resources.md

##### Definition:
```python
@property
def whitelisted_resources(self):
    ...
@whitelisted_resources.setter
def whitelisted_resources(self, value):
    ...
```

### MailStorageOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions.md

#### MailStorageOptions class

The MailStorageOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| address_filter |  |
| max_items |  |
| text_filter |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### address_filter property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions/address_filter.md

##### Definition:
```python
@property
def address_filter(self):
    ...
@address_filter.setter
def address_filter(self, value):
    ...
```

### max_items property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions/max_items.md

##### Definition:
```python
@property
def max_items(self):
    ...
@max_items.setter
def max_items(self, value):
    ...
```

### text_filter property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/mailstorageoptions/text_filter.md

##### Definition:
```python
@property
def text_filter(self):
    ...
@text_filter.setter
def text_filter(self, value):
    ...
```

### OutlookOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions.md

#### OutlookOptions class

The OutlookOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| address_filter |  |
| folder |  |
| max_items_in_folder |  |
| text_filter |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### address_filter property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/address_filter.md

##### Definition:
```python
@property
def address_filter(self):
    ...
@address_filter.setter
def address_filter(self, value):
    ...
```

### folder property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/folder.md

##### Definition:
```python
@property
def folder(self):
    ...
@folder.setter
def folder(self, value):
    ...
```

### max_items_in_folder property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/max_items_in_folder.md

##### Definition:
```python
@property
def max_items_in_folder(self):
    ...
@max_items_in_folder.setter
def max_items_in_folder(self, value):
    ...
```

### text_filter property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/outlookoptions/text_filter.md

##### Definition:
```python
@property
def text_filter(self):
    ...
@text_filter.setter
def text_filter(self, value):
    ...
```

### PageSize class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize.md

#### PageSize class

The PageSize type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNSPECIFIED |  |
| LETTER |  |
| LEDGER |  |
| A0 |  |
| A1 |  |
| A2 |  |
| A3 |  |
| A4 |  |

### A0 field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/a0.md

##### Value
`3`

### A1 field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/a1.md

##### Value
`4`

### A2 field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/a2.md

##### Value
`5`

### A3 field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/a3.md

##### Value
`6`

### A4 field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/a4.md

##### Value
`7`

### LEDGER field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/ledger.md

##### Value
`2`

### LETTER field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/letter.md

##### Value
`1`

### UNSPECIFIED field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pagesize/unspecified.md

##### Value
`0`

### PdfOptimizationOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions.md

#### PdfOptimizationOptions class

The PdfOptimizationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| compress_images |  |
| convert_to_gray_scale |  |
| image_quality |  |
| lineriaze |  |
| max_resolution |  |
| optimize_spreadsheets |  |
| remove_annotations |  |
| remove_form_fields |  |
| remove_unused_objects |  |
| remove_unused_streams |  |
| resize_images |  |
| subset_fonts |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### compress_images property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/compress_images.md

##### Definition:
```python
@property
def compress_images(self):
    ...
@compress_images.setter
def compress_images(self, value):
    ...
```

### convert_to_gray_scale property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/convert_to_gray_scale.md

##### Definition:
```python
@property
def convert_to_gray_scale(self):
    ...
@convert_to_gray_scale.setter
def convert_to_gray_scale(self, value):
    ...
```

### image_quality property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/image_quality.md

##### Definition:
```python
@property
def image_quality(self):
    ...
@image_quality.setter
def image_quality(self, value):
    ...
```

### lineriaze property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/lineriaze.md

##### Definition:
```python
@property
def lineriaze(self):
    ...
@lineriaze.setter
def lineriaze(self, value):
    ...
```

### max_resolution property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/max_resolution.md

##### Definition:
```python
@property
def max_resolution(self):
    ...
@max_resolution.setter
def max_resolution(self, value):
    ...
```

### optimize_spreadsheets property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/optimize_spreadsheets.md

##### Definition:
```python
@property
def optimize_spreadsheets(self):
    ...
@optimize_spreadsheets.setter
def optimize_spreadsheets(self, value):
    ...
```

### remove_annotations property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/remove_annotations.md

##### Definition:
```python
@property
def remove_annotations(self):
    ...
@remove_annotations.setter
def remove_annotations(self, value):
    ...
```

### remove_form_fields property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/remove_form_fields.md

##### Definition:
```python
@property
def remove_form_fields(self):
    ...
@remove_form_fields.setter
def remove_form_fields(self, value):
    ...
```

### remove_unused_objects property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/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/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/remove_unused_streams.md

##### Definition:
```python
@property
def remove_unused_streams(self):
    ...
@remove_unused_streams.setter
def remove_unused_streams(self, value):
    ...
```

### resize_images property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/resize_images.md

##### Definition:
```python
@property
def resize_images(self):
    ...
@resize_images.setter
def resize_images(self, value):
    ...
```

### subset_fonts property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptimizationoptions/subset_fonts.md

##### Definition:
```python
@property
def subset_fonts(self):
    ...
@subset_fonts.setter
def subset_fonts(self, value):
    ...
```

### PdfOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions.md

#### PdfOptions class

The PdfOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| disable_chars_grouping |  |
| disable_copy_protection |  |
| disable_font_license_verifications |  |
| enable_font_hinting |  |
| enable_layered_rendering |  |
| fixed_layout |  |
| image_quality |  |
| render_original_page_size |  |
| render_text_as_image |  |
| wrap_images_in_svg |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### disable_chars_grouping property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/disable_chars_grouping.md

##### Definition:
```python
@property
def disable_chars_grouping(self):
    ...
@disable_chars_grouping.setter
def disable_chars_grouping(self, value):
    ...
```

### disable_copy_protection property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/disable_copy_protection.md

##### Definition:
```python
@property
def disable_copy_protection(self):
    ...
@disable_copy_protection.setter
def disable_copy_protection(self, value):
    ...
```

### disable_font_license_verifications property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/disable_font_license_verifications.md

##### Definition:
```python
@property
def disable_font_license_verifications(self):
    ...
@disable_font_license_verifications.setter
def disable_font_license_verifications(self, value):
    ...
```

### enable_font_hinting property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/enable_font_hinting.md

##### Definition:
```python
@property
def enable_font_hinting(self):
    ...
@enable_font_hinting.setter
def enable_font_hinting(self, value):
    ...
```

### enable_layered_rendering property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/enable_layered_rendering.md

##### Definition:
```python
@property
def enable_layered_rendering(self):
    ...
@enable_layered_rendering.setter
def enable_layered_rendering(self, value):
    ...
```

### fixed_layout property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/fixed_layout.md

##### Definition:
```python
@property
def fixed_layout(self):
    ...
@fixed_layout.setter
def fixed_layout(self, value):
    ...
```

### image_quality property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/image_quality.md

##### Definition:
```python
@property
def image_quality(self):
    ...
@image_quality.setter
def image_quality(self, value):
    ...
```

### render_original_page_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/render_original_page_size.md

##### Definition:
```python
@property
def render_original_page_size(self):
    ...
@render_original_page_size.setter
def render_original_page_size(self, value):
    ...
```

### render_text_as_image property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/render_text_as_image.md

##### Definition:
```python
@property
def render_text_as_image(self):
    ...
@render_text_as_image.setter
def render_text_as_image(self, value):
    ...
```

### wrap_images_in_svg property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfoptions/wrap_images_in_svg.md

##### Definition:
```python
@property
def wrap_images_in_svg(self):
    ...
@wrap_images_in_svg.setter
def wrap_images_in_svg(self, value):
    ...
```

### PdfViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions.md

#### PdfViewOptions class

The PdfViewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_create_file_stream |  |
| _init_create_file_stream_release_file_stream |  |
| _init_ifile_stream_factory |  |
| _init_noargs |  |
| _init_string |  |
| _rotate_page_int32_rotation |  (inherited from `ViewOptions`) |
| rotate_page |  (inherited from `ViewOptions`) |
| rotate_page_int32 |  (inherited from `ViewOptions`) |

##### Properties
| Property | Description |
| :- | :- |
| image_height |  |
| image_max_height |  |
| image_max_width |  |
| image_width |  |
| pdf_optimization_options |  |
| security |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| watermark |  (inherited from `ViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_file_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/_init_create_file_stream.md

#### _init_create_file_stream

```python
def _init_create_file_stream(self, create_file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_file_stream | `CreateFileStream` |  |

### _init_create_file_stream_release_file_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/_init_create_file_stream_release_file_stream.md

#### _init_create_file_stream_release_file_stream

```python
def _init_create_file_stream_release_file_stream(self, create_file_stream, release_file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_file_stream | `CreateFileStream` |  |
| release_file_stream | `ReleaseFileStream` |  |

### _init_ifile_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/_init_ifile_stream_factory.md

#### _init_ifile_stream_factory

```python
def _init_ifile_stream_factory(self, file_stream_factory):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_stream_factory | `IFileStreamFactory` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/_init_string.md

#### _init_string

```python
def _init_string(self, output_file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| output_file_path | `str` |  |

### image_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/image_height.md

##### Definition:
```python
@property
def image_height(self):
    ...
@image_height.setter
def image_height(self, value):
    ...
```

### image_max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/image_max_height.md

##### Definition:
```python
@property
def image_max_height(self):
    ...
@image_max_height.setter
def image_max_height(self, value):
    ...
```

### image_max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/image_max_width.md

##### Definition:
```python
@property
def image_max_width(self):
    ...
@image_max_width.setter
def image_max_width(self, value):
    ...
```

### image_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/image_width.md

##### Definition:
```python
@property
def image_width(self):
    ...
@image_width.setter
def image_width(self, value):
    ...
```

### pdf_optimization_options property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/pdf_optimization_options.md

##### Definition:
```python
@property
def pdf_optimization_options(self):
    ...
@pdf_optimization_options.setter
def pdf_optimization_options(self, value):
    ...
```

### security property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pdfviewoptions/security.md

##### Definition:
```python
@property
def security(self):
    ...
@security.setter
def security(self, value):
    ...
```

### Permissions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions.md

#### Permissions class

The Permissions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ALL |  |
| DENY_PRINTING |  |
| DENY_MODIFICATION |  |
| DENY_DATA_EXTRACTION |  |
| DENY_ALL |  |

### ALLOW_ALL field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions/allow_all.md

##### Value
`0`

### DENY_ALL field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions/deny_all.md

##### Value
`7`

### DENY_DATA_EXTRACTION field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions/deny_data_extraction.md

##### Value
`4`

### DENY_MODIFICATION field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions/deny_modification.md

##### Value
`2`

### DENY_PRINTING field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/permissions/deny_printing.md

##### Value
`1`

### PngViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions.md

#### PngViewOptions class

The PngViewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_create_page_stream |  |
| _init_create_page_stream_release_page_stream |  |
| _init_ipage_stream_factory |  |
| _init_noargs |  |
| _init_string |  |
| _rotate_page_int32_rotation |  (inherited from `ViewOptions`) |
| rotate_page |  (inherited from `ViewOptions`) |
| rotate_page_int32 |  (inherited from `ViewOptions`) |

##### Properties
| Property | Description |
| :- | :- |
| extract_text |  |
| height |  |
| max_height |  |
| max_width |  |
| width |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| watermark |  (inherited from `ViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_create_page_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/_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/viewer/python-net/groupdocs.viewer.options/pngviewoptions/_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` |  |

### _init_ipage_stream_factory method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/_init_ipage_stream_factory.md

#### _init_ipage_stream_factory

```python
def _init_ipage_stream_factory(self, page_stream_factory):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_stream_factory | `IPageStreamFactory` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/_init_string.md

#### _init_string

```python
def _init_string(self, file_path_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path_format | `str` |  |

### extract_text property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/extract_text.md

##### Definition:
```python
@property
def extract_text(self):
    ...
@extract_text.setter
def extract_text(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/max_height.md

##### Definition:
```python
@property
def max_height(self):
    ...
@max_height.setter
def max_height(self, value):
    ...
```

### max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/max_width.md

##### Definition:
```python
@property
def max_width(self):
    ...
@max_width.setter
def max_width(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/pngviewoptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### Position class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position.md

#### Position class

The Position type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DIAGONAL |  |
| TOP_LEFT |  |
| TOP_CENTER |  |
| TOP_RIGHT |  |
| BOTTOM_LEFT |  |
| BOTTOM_CENTER |  |
| BOTTOM_RIGHT |  |

### BOTTOM_CENTER field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/bottom_center.md

##### Value
`5`

### BOTTOM_LEFT field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/bottom_left.md

##### Value
`4`

### BOTTOM_RIGHT field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/bottom_right.md

##### Value
`6`

### DIAGONAL field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/diagonal.md

##### Value
`0`

### TOP_CENTER field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/top_center.md

##### Value
`2`

### TOP_LEFT field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/top_left.md

##### Value
`1`

### TOP_RIGHT field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/position/top_right.md

##### Value
`3`

### PresentationOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions.md

#### PresentationOptions class

The PresentationOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| render_header_footer_placeholders |  |
| render_to_pure_html |  |
| resolution |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### render_header_footer_placeholders property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions/render_header_footer_placeholders.md

##### Definition:
```python
@property
def render_header_footer_placeholders(self):
    ...
@render_header_footer_placeholders.setter
def render_header_footer_placeholders(self, value):
    ...
```

### render_to_pure_html property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions/render_to_pure_html.md

##### Definition:
```python
@property
def render_to_pure_html(self):
    ...
@render_to_pure_html.setter
def render_to_pure_html(self, value):
    ...
```

### resolution property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/presentationoptions/resolution.md

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### ProjectManagementOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions.md

#### ProjectManagementOptions class

The ProjectManagementOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| end_date |  |
| page_size |  |
| start_date |  |
| time_unit |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### end_date property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/end_date.md

##### Definition:
```python
@property
def end_date(self):
    ...
@end_date.setter
def end_date(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### start_date property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/start_date.md

##### Definition:
```python
@property
def start_date(self):
    ...
@start_date.setter
def start_date(self, value):
    ...
```

### time_unit property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/projectmanagementoptions/time_unit.md

##### Definition:
```python
@property
def time_unit(self):
    ...
@time_unit.setter
def time_unit(self, value):
    ...
```

### Resolution class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/resolution.md

#### Resolution class

The Resolution type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| value |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/resolution/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/resolution/_init_int32.md

#### _init_int32

```python
def _init_int32(self, value):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `int` |  |

### value property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/resolution/value.md

##### Definition:
```python
@property
def value(self):
    ...
```

### Rotation class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/rotation.md

#### Rotation class

The Rotation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ON_90_DEGREE |  |
| ON_180_DEGREE |  |
| ON_270_DEGREE |  |

### ON_180_DEGREE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/rotation/on_180_degree.md

##### Value
`1`

### ON_270_DEGREE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/rotation/on_270_degree.md

##### Value
`2`

### ON_90_DEGREE field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/rotation/on_90_degree.md

##### Value
`0`

### SearchHighlightOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions.md

#### SearchHighlightOptions class

The SearchHighlightOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| background_color |  |
| foreground_color |  |
| is_search_term_reg_ex |  |
| search_term |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### background_color property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/background_color.md

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/foreground_color.md

##### Definition:
```python
@property
def foreground_color(self):
    ...
@foreground_color.setter
def foreground_color(self, value):
    ...
```

### is_search_term_reg_ex property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/is_search_term_reg_ex.md

##### Definition:
```python
@property
def is_search_term_reg_ex(self):
    ...
@is_search_term_reg_ex.setter
def is_search_term_reg_ex(self, value):
    ...
```

### search_term property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/searchhighlightoptions/search_term.md

##### Definition:
```python
@property
def search_term(self):
    ...
@search_term.setter
def search_term(self, value):
    ...
```

### Security class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security.md

#### Security class

The Security type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| document_open_password |  |
| permissions |  |
| permissions_password |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### document_open_password property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security/document_open_password.md

##### Definition:
```python
@property
def document_open_password(self):
    ...
@document_open_password.setter
def document_open_password(self, value):
    ...
```

### permissions property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security/permissions.md

##### Definition:
```python
@property
def permissions(self):
    ...
@permissions.setter
def permissions(self, value):
    ...
```

### permissions_password property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/security/permissions_password.md

##### Definition:
```python
@property
def permissions_password(self):
    ...
@permissions_password.setter
def permissions_password(self, value):
    ...
```

### Size class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/size.md

#### Size class

The Size type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_byte |  |

##### Properties
| Property | Description |
| :- | :- |
| relative_size |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/size/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_byte method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/size/_init_byte.md

#### _init_byte

```python
def _init_byte(self, relative_size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| relative_size | `int` |  |

### relative_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/size/relative_size.md

##### Definition:
```python
@property
def relative_size(self):
    ...
```

### SpreadsheetOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions.md

#### SpreadsheetOptions class

The SpreadsheetOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _for_split_sheet_into_pages_int32 |  |
| _for_split_sheet_into_pages_int32_int32 |  |
| for_one_page_per_sheet |  |
| for_rendering_by_page_breaks |  |
| for_rendering_print_area |  |
| for_rendering_print_area_and_page_breaks |  |
| for_split_sheet_into_pages |  |
| for_split_sheet_into_pages_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| bottom_margin |  |
| count_columns_per_page |  |
| count_rows_per_page |  |
| detect_separator |  |
| horizontal_resolution |  |
| left_margin |  |
| render_grid_lines |  |
| render_headings |  |
| render_hidden_columns |  |
| render_hidden_rows |  |
| right_margin |  |
| skip_empty_columns |  |
| skip_empty_rows |  |
| text_overflow_mode |  |
| top_margin |  |
| vertical_resolution |  |

### _for_split_sheet_into_pages_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/_for_split_sheet_into_pages_int32.md

#### _for_split_sheet_into_pages_int32

```python
def _for_split_sheet_into_pages_int32(cls, count_rows_per_page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| count_rows_per_page | `int` |  |

**Returns:** SpreadsheetOptions

### _for_split_sheet_into_pages_int32_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/_for_split_sheet_into_pages_int32_int32.md

#### _for_split_sheet_into_pages_int32_int32

```python
def _for_split_sheet_into_pages_int32_int32(cls, count_rows_per_page, count_columns_per_page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| count_rows_per_page | `int` |  |
| count_columns_per_page | `int` |  |

**Returns:** SpreadsheetOptions

### bottom_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/bottom_margin.md

##### Definition:
```python
@property
def bottom_margin(self):
    ...
@bottom_margin.setter
def bottom_margin(self, value):
    ...
```

### count_columns_per_page property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/count_columns_per_page.md

##### Definition:
```python
@property
def count_columns_per_page(self):
    ...
```

### count_rows_per_page property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/count_rows_per_page.md

##### Definition:
```python
@property
def count_rows_per_page(self):
    ...
```

### detect_separator property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/detect_separator.md

##### Definition:
```python
@property
def detect_separator(self):
    ...
@detect_separator.setter
def detect_separator(self, value):
    ...
```

### for_one_page_per_sheet method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_one_page_per_sheet.md

#### for_one_page_per_sheet

```python
def for_one_page_per_sheet(cls):
    ...
```

**Returns:** SpreadsheetOptions

### for_rendering_by_page_breaks method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_rendering_by_page_breaks.md

#### for_rendering_by_page_breaks

```python
def for_rendering_by_page_breaks(cls):
    ...
```

**Returns:** SpreadsheetOptions

### for_rendering_print_area method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_rendering_print_area.md

#### for_rendering_print_area

```python
def for_rendering_print_area(cls):
    ...
```

**Returns:** SpreadsheetOptions

### for_rendering_print_area_and_page_breaks method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_rendering_print_area_and_page_breaks.md

#### for_rendering_print_area_and_page_breaks

```python
def for_rendering_print_area_and_page_breaks(cls):
    ...
```

**Returns:** SpreadsheetOptions

### for_split_sheet_into_pages method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_split_sheet_into_pages.md

#### for_split_sheet_into_pages

```python
def for_split_sheet_into_pages(cls):
    ...
```

### for_split_sheet_into_pages_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/for_split_sheet_into_pages_int32.md

#### for_split_sheet_into_pages_int32

```python
def for_split_sheet_into_pages_int32(cls):
    ...
```

### horizontal_resolution property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/horizontal_resolution.md

##### Definition:
```python
@property
def horizontal_resolution(self):
    ...
@horizontal_resolution.setter
def horizontal_resolution(self, value):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/left_margin.md

##### Definition:
```python
@property
def left_margin(self):
    ...
@left_margin.setter
def left_margin(self, value):
    ...
```

### render_grid_lines property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/render_grid_lines.md

##### Definition:
```python
@property
def render_grid_lines(self):
    ...
@render_grid_lines.setter
def render_grid_lines(self, value):
    ...
```

### render_headings property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/render_headings.md

##### Definition:
```python
@property
def render_headings(self):
    ...
@render_headings.setter
def render_headings(self, value):
    ...
```

### render_hidden_columns property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/render_hidden_columns.md

##### Definition:
```python
@property
def render_hidden_columns(self):
    ...
@render_hidden_columns.setter
def render_hidden_columns(self, value):
    ...
```

### render_hidden_rows property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/render_hidden_rows.md

##### Definition:
```python
@property
def render_hidden_rows(self):
    ...
@render_hidden_rows.setter
def render_hidden_rows(self, value):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/right_margin.md

##### Definition:
```python
@property
def right_margin(self):
    ...
@right_margin.setter
def right_margin(self, value):
    ...
```

### skip_empty_columns property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/skip_empty_columns.md

##### Definition:
```python
@property
def skip_empty_columns(self):
    ...
@skip_empty_columns.setter
def skip_empty_columns(self, value):
    ...
```

### skip_empty_rows property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/skip_empty_rows.md

##### Definition:
```python
@property
def skip_empty_rows(self):
    ...
@skip_empty_rows.setter
def skip_empty_rows(self, value):
    ...
```

### text_overflow_mode property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/text_overflow_mode.md

##### Definition:
```python
@property
def text_overflow_mode(self):
    ...
@text_overflow_mode.setter
def text_overflow_mode(self, value):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/top_margin.md

##### Definition:
```python
@property
def top_margin(self):
    ...
@top_margin.setter
def top_margin(self, value):
    ...
```

### vertical_resolution property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/spreadsheetoptions/vertical_resolution.md

##### Definition:
```python
@property
def vertical_resolution(self):
    ...
@vertical_resolution.setter
def vertical_resolution(self, value):
    ...
```

### TextOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoptions.md

#### TextOptions class

The TextOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| max_chars_per_row |  |
| max_rows_per_page |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### max_chars_per_row property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoptions/max_chars_per_row.md

##### Definition:
```python
@property
def max_chars_per_row(self):
    ...
@max_chars_per_row.setter
def max_chars_per_row(self, value):
    ...
```

### max_rows_per_page property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoptions/max_rows_per_page.md

##### Definition:
```python
@property
def max_rows_per_page(self):
    ...
@max_rows_per_page.setter
def max_rows_per_page(self, value):
    ...
```

### TextOverflowMode class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoverflowmode.md

#### TextOverflowMode class

The TextOverflowMode type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| OVERLAY |  |
| OVERLAY_IF_NEXT_IS_EMPTY |  |
| AUTO_FIT_COLUMN |  |
| HIDE_TEXT |  |

### AUTO_FIT_COLUMN field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoverflowmode/auto_fit_column.md

##### Value
`2`

### HIDE_TEXT field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoverflowmode/hide_text.md

##### Value
`3`

### OVERLAY field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoverflowmode/overlay.md

##### Value
`0`

### OVERLAY_IF_NEXT_IS_EMPTY field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/textoverflowmode/overlay_if_next_is_empty.md

##### Value
`1`

### Tile class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile.md

#### Tile class

The Tile type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _get_end_point_x_noargs |  |
| _get_end_point_y_noargs |  |
| _init_int32_int32_int32_int32 |  |
| get_end_point_x |  |
| get_end_point_y |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| start_point_x |  |
| start_point_y |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _get_end_point_x_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/_get_end_point_x_noargs.md

#### _get_end_point_x_noargs

```python
def _get_end_point_x_noargs(self):
    ...
```

**Returns:** int

### _get_end_point_y_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/_get_end_point_y_noargs.md

#### _get_end_point_y_noargs

```python
def _get_end_point_y_noargs(self):
    ...
```

**Returns:** int

### _init_int32_int32_int32_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/_init_int32_int32_int32_int32.md

#### _init_int32_int32_int32_int32

```python
def _init_int32_int32_int32_int32(self, start_point_x, start_point_y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| start_point_x | `int` |  |
| start_point_y | `int` |  |
| width | `int` |  |
| height | `int` |  |

### get_end_point_x method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/get_end_point_x.md

#### get_end_point_x

```python
def get_end_point_x(self):
    ...
```

### get_end_point_y method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/get_end_point_y.md

#### get_end_point_y

```python
def get_end_point_y(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### start_point_x property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/start_point_x.md

##### Definition:
```python
@property
def start_point_x(self):
    ...
```

### start_point_y property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/start_point_y.md

##### Definition:
```python
@property
def start_point_y(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/tile/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### TimeUnit class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/timeunit.md

#### TimeUnit class

The TimeUnit type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNSPECIFIED |  |
| DAYS |  |
| THIRDS_OF_MONTHS |  |
| MONTHS |  |

### DAYS field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/timeunit/days.md

##### Value
`1`

### MONTHS field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/timeunit/months.md

##### Value
`30`

### THIRDS_OF_MONTHS field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/timeunit/thirds_of_months.md

##### Value
`10`

### UNSPECIFIED field
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/timeunit/unspecified.md

##### Value
`0`

### ViewInfoOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions.md

#### ViewInfoOptions class

The ViewInfoOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _for_html_view_boolean |  |
| _for_html_view_noargs |  |
| _for_jpg_view_boolean |  |
| _for_jpg_view_noargs |  |
| _for_png_view_boolean |  |
| _for_png_view_noargs |  |
| for_html_view |  |
| for_html_view_boolean |  |
| for_jpg_view |  |
| for_jpg_view_boolean |  |
| for_pdf_view |  |
| for_png_view |  |
| for_png_view_boolean |  |
| from_html_view_options |  |
| from_jpg_view_options |  |
| from_pdf_view_options |  |
| from_png_view_options |  |

##### Properties
| Property | Description |
| :- | :- |
| extract_text |  |
| height |  |
| max_height |  |
| max_width |  |
| width |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### _for_html_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_html_view_boolean.md

#### _for_html_view_boolean

```python
def _for_html_view_boolean(cls, render_single_page):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| render_single_page | `bool` |  |

**Returns:** ViewInfoOptions

### _for_html_view_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_html_view_noargs.md

#### _for_html_view_noargs

```python
def _for_html_view_noargs(cls):
    ...
```

**Returns:** ViewInfoOptions

### _for_jpg_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_jpg_view_boolean.md

#### _for_jpg_view_boolean

```python
def _for_jpg_view_boolean(cls, extract_text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extract_text | `bool` |  |

**Returns:** ViewInfoOptions

### _for_jpg_view_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_jpg_view_noargs.md

#### _for_jpg_view_noargs

```python
def _for_jpg_view_noargs(cls):
    ...
```

**Returns:** ViewInfoOptions

### _for_png_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_png_view_boolean.md

#### _for_png_view_boolean

```python
def _for_png_view_boolean(cls, extract_text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extract_text | `bool` |  |

**Returns:** ViewInfoOptions

### _for_png_view_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/_for_png_view_noargs.md

#### _for_png_view_noargs

```python
def _for_png_view_noargs(cls):
    ...
```

**Returns:** ViewInfoOptions

### extract_text property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/extract_text.md

##### Definition:
```python
@property
def extract_text(self):
    ...
@extract_text.setter
def extract_text(self, value):
    ...
```

### for_html_view method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_html_view.md

#### for_html_view

```python
def for_html_view(cls):
    ...
```

### for_html_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_html_view_boolean.md

#### for_html_view_boolean

```python
def for_html_view_boolean(cls):
    ...
```

### for_jpg_view method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_jpg_view.md

#### for_jpg_view

```python
def for_jpg_view(cls):
    ...
```

### for_jpg_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_jpg_view_boolean.md

#### for_jpg_view_boolean

```python
def for_jpg_view_boolean(cls):
    ...
```

### for_pdf_view method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_pdf_view.md

#### for_pdf_view

```python
def for_pdf_view(cls):
    ...
```

**Returns:** ViewInfoOptions

### for_png_view method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_png_view.md

#### for_png_view

```python
def for_png_view(cls):
    ...
```

### for_png_view_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/for_png_view_boolean.md

#### for_png_view_boolean

```python
def for_png_view_boolean(cls):
    ...
```

### from_html_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/from_html_view_options.md

#### from_html_view_options

```python
def from_html_view_options(cls, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `HtmlViewOptions` |  |

**Returns:** ViewInfoOptions

### from_jpg_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/from_jpg_view_options.md

#### from_jpg_view_options

```python
def from_jpg_view_options(cls, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `JpgViewOptions` |  |

**Returns:** ViewInfoOptions

### from_pdf_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/from_pdf_view_options.md

#### from_pdf_view_options

```python
def from_pdf_view_options(cls, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `PdfViewOptions` |  |

**Returns:** ViewInfoOptions

### from_png_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/from_png_view_options.md

#### from_png_view_options

```python
def from_png_view_options(cls, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `PngViewOptions` |  |

**Returns:** ViewInfoOptions

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### max_height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/max_height.md

##### Definition:
```python
@property
def max_height(self):
    ...
@max_height.setter
def max_height(self, value):
    ...
```

### max_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/max_width.md

##### Definition:
```python
@property
def max_width(self):
    ...
@max_width.setter
def max_width(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewinfooptions/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ViewOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewoptions.md

#### ViewOptions class

The ViewOptions type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _rotate_page_int32_rotation |  |
| rotate_page |  |
| rotate_page_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| watermark |  |
| archive_options |  (inherited from `BaseViewOptions`) |
| cad_options |  (inherited from `BaseViewOptions`) |
| default_font_name |  (inherited from `BaseViewOptions`) |
| email_options |  (inherited from `BaseViewOptions`) |
| mail_storage_options |  (inherited from `BaseViewOptions`) |
| outlook_options |  (inherited from `BaseViewOptions`) |
| pdf_options |  (inherited from `BaseViewOptions`) |
| presentation_options |  (inherited from `BaseViewOptions`) |
| remove_comments |  (inherited from `BaseViewOptions`) |
| render_comments |  (inherited from `BaseViewOptions`) |
| render_hidden_pages |  (inherited from `BaseViewOptions`) |
| render_notes |  (inherited from `BaseViewOptions`) |
| spreadsheet_options |  (inherited from `BaseViewOptions`) |
| text_options |  (inherited from `BaseViewOptions`) |
| visio_rendering_options |  (inherited from `BaseViewOptions`) |
| web_document_options |  (inherited from `BaseViewOptions`) |
| word_processing_options |  (inherited from `BaseViewOptions`) |

### _rotate_page_int32_rotation method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewoptions/_rotate_page_int32_rotation.md

#### _rotate_page_int32_rotation

```python
def _rotate_page_int32_rotation(self, page_number, rotation):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| page_number | `int` |  |
| rotation | `Rotation` |  |

### rotate_page method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewoptions/rotate_page.md

#### rotate_page

```python
def rotate_page(self):
    ...
```

### rotate_page_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewoptions/rotate_page_int32.md

#### rotate_page_int32

```python
def rotate_page_int32(self):
    ...
```

### watermark property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/viewoptions/watermark.md

##### Definition:
```python
@property
def watermark(self):
    ...
@watermark.setter
def watermark(self, value):
    ...
```

### VisioRenderingOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/visiorenderingoptions.md

#### VisioRenderingOptions class

The VisioRenderingOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| figure_width |  |
| render_figures_only |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/visiorenderingoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/visiorenderingoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### figure_width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/visiorenderingoptions/figure_width.md

##### Definition:
```python
@property
def figure_width(self):
    ...
@figure_width.setter
def figure_width(self, value):
    ...
```

### render_figures_only property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/visiorenderingoptions/render_figures_only.md

##### Definition:
```python
@property
def render_figures_only(self):
    ...
@render_figures_only.setter
def render_figures_only(self, value):
    ...
```

### Watermark class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark.md

#### Watermark class

The Watermark type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_string |  |

##### Properties
| Property | Description |
| :- | :- |
| color |  |
| font_name |  |
| position |  |
| size |  |
| text |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/_init_string.md

#### _init_string

```python
def _init_string(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` |  |

### color property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/color.md

##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### font_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/font_name.md

##### Definition:
```python
@property
def font_name(self):
    ...
@font_name.setter
def font_name(self, value):
    ...
```

### position property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/position.md

##### Definition:
```python
@property
def position(self):
    ...
@position.setter
def position(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/size.md

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/watermark/text.md

##### Definition:
```python
@property
def text(self):
    ...
```

### WebDocumentOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions.md

#### WebDocumentOptions class

The WebDocumentOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |

##### Properties
| Property | Description |
| :- | :- |
| bottom_margin |  |
| left_margin |  |
| page_size |  |
| right_margin |  |
| top_margin |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### bottom_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/bottom_margin.md

##### Definition:
```python
@property
def bottom_margin(self):
    ...
@bottom_margin.setter
def bottom_margin(self, value):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/left_margin.md

##### Definition:
```python
@property
def left_margin(self):
    ...
@left_margin.setter
def left_margin(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/right_margin.md

##### Definition:
```python
@property
def right_margin(self):
    ...
@right_margin.setter
def right_margin(self, value):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/webdocumentoptions/top_margin.md

##### Definition:
```python
@property
def top_margin(self):
    ...
@top_margin.setter
def top_margin(self, value):
    ...
```

### WordProcessingOptions class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions.md

#### WordProcessingOptions class

The WordProcessingOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _clone_noargs |  |
| _equals_word_processing_options |  |
| _init_noargs |  |
| clone |  |
| equals |  |
| equals_word_processing_options |  |

##### Properties
| Property | Description |
| :- | :- |
| bottom_margin |  |
| enable_open_type_features |  |
| left_margin |  |
| page_size |  |
| render_tracked_changes |  |
| right_margin |  |
| top_margin |  |
| unlink_table_of_contents |  |
| update_fields |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _clone_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/_clone_noargs.md

#### _clone_noargs

```python
def _clone_noargs(self):
    ...
```

**Returns:** WordProcessingOptions

### _equals_word_processing_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/_equals_word_processing_options.md

#### _equals_word_processing_options

```python
def _equals_word_processing_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `WordProcessingOptions` |  |

**Returns:** bool

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### bottom_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/bottom_margin.md

##### Definition:
```python
@property
def bottom_margin(self):
    ...
@bottom_margin.setter
def bottom_margin(self, value):
    ...
```

### clone method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/clone.md

#### clone

```python
def clone(self):
    ...
```

### enable_open_type_features property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/enable_open_type_features.md

##### Definition:
```python
@property
def enable_open_type_features(self):
    ...
@enable_open_type_features.setter
def enable_open_type_features(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_word_processing_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/equals_word_processing_options.md

#### equals_word_processing_options

```python
def equals_word_processing_options(self):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/left_margin.md

##### Definition:
```python
@property
def left_margin(self):
    ...
@left_margin.setter
def left_margin(self, value):
    ...
```

### page_size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/page_size.md

##### Definition:
```python
@property
def page_size(self):
    ...
@page_size.setter
def page_size(self, value):
    ...
```

### render_tracked_changes property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/render_tracked_changes.md

##### Definition:
```python
@property
def render_tracked_changes(self):
    ...
@render_tracked_changes.setter
def render_tracked_changes(self, value):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/right_margin.md

##### Definition:
```python
@property
def right_margin(self):
    ...
@right_margin.setter
def right_margin(self, value):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/top_margin.md

##### Definition:
```python
@property
def top_margin(self):
    ...
@top_margin.setter
def top_margin(self, value):
    ...
```

### unlink_table_of_contents property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/unlink_table_of_contents.md

##### Definition:
```python
@property
def unlink_table_of_contents(self):
    ...
@unlink_table_of_contents.setter
def unlink_table_of_contents(self, value):
    ...
```

### update_fields property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.options/wordprocessingoptions/update_fields.md

##### Definition:
```python
@property
def update_fields(self):
    ...
@update_fields.setter
def update_fields(self, value):
    ...
```

### groupdocs.viewer.results
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results.md

Result types produced by converter and processor methods.

##### Classes
| Class | Description |
| :- | :- |
| `ArchiveViewInfo` |  |
| `Attachment` |  |
| `CadViewInfo` |  |
| `Character` |  |
| `FileInfo` |  |
| `Layer` |  |
| `Layout` |  |
| `Line` |  |
| `LotusNotesViewInfo` |  |
| `MailMessageViewInfo` |  |
| `MboxViewInfo` |  |
| `OutlookViewInfo` |  |
| `Page` |  |
| `PdfViewInfo` |  |
| `ProjectManagementViewInfo` |  |
| `Resource` |  |
| `TextElement` |  |
| `ViewInfo` |  |
| `Word` |  |

### ArchiveViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/archiveviewinfo.md

#### ArchiveViewInfo class

The ArchiveViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_list_1_1352 |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| folders |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/archiveviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_list_1_1352 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/archiveviewinfo/_init_file_type_list_1_3205_list_1_1352.md

#### _init_file_type_list_1_3205_list_1_1352

```python
def _init_file_type_list_1_3205_list_1_1352(self, file_type, pages, folders):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| folders | `List[Any]` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/archiveviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### folders property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/archiveviewinfo/folders.md

##### Definition:
```python
@property
def folders(self):
    ...
@folders.setter
def folders(self, value):
    ...
```

### Attachment class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment.md

#### Attachment class

The Attachment type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_string_string |  |
| _init_string_string_string_file_type_int64 |  |
| _init_string_string_string_int64 |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| file_name |  |
| file_path |  |
| file_type |  |
| id |  |
| size |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, file_name, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |
| file_path | `str` |  |

### _init_string_string_string_file_type_int64 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/_init_string_string_string_file_type_int64.md

#### _init_string_string_string_file_type_int64

```python
def _init_string_string_string_file_type_int64(self, id, file_name, file_path, file_type, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | `str` |  |
| file_name | `str` |  |
| file_path | `str` |  |
| file_type | `FileType` |  |
| size | `int` |  |

### _init_string_string_string_int64 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/_init_string_string_string_int64.md

#### _init_string_string_string_int64

```python
def _init_string_string_string_int64(self, id, file_name, file_path, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| id | `str` |  |
| file_name | `str` |  |
| file_path | `str` |  |
| size | `int` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### file_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/file_name.md

##### Definition:
```python
@property
def file_name(self):
    ...
@file_name.setter
def file_name(self, value):
    ...
```

### file_path property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/file_path.md

##### Definition:
```python
@property
def file_path(self):
    ...
@file_path.setter
def file_path(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/id.md

##### Definition:
```python
@property
def id(self):
    ...
@id.setter
def id(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/size.md

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/attachment/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### CadViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/cadviewinfo.md

#### CadViewInfo class

The CadViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_list_1_8bb6_list_1_06a2 |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _init_noargs |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| layers |  |
| layouts |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/cadviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_list_1_8bb6_list_1_06a2 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/cadviewinfo/_init_file_type_list_1_3205_list_1_8bb6_list_1_06a2.md

#### _init_file_type_list_1_3205_list_1_8bb6_list_1_06a2

```python
def _init_file_type_list_1_3205_list_1_8bb6_list_1_06a2(self, file_type, pages, layers, layouts):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| layers | `List[Any]` |  |
| layouts | `List[Any]` |  |

### layers property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/cadviewinfo/layers.md

##### Definition:
```python
@property
def layers(self):
    ...
@layers.setter
def layers(self, value):
    ...
```

### layouts property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/cadviewinfo/layouts.md

##### Definition:
```python
@property
def layouts(self):
    ...
@layouts.setter
def layouts(self, value):
    ...
```

### Character class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character.md

#### Character class

The Character type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_char_double_double_double_double |  |
| _init_noargs |  |
| _to_string_noargs |  |
| to_string |  |
| _init_arg_double_double_double_double |  (inherited from `TextElement`) |

##### Properties
| Property | Description |
| :- | :- |
| height |  (inherited from `TextElement`) |
| value |  (inherited from `TextElement`) |
| width |  (inherited from `TextElement`) |
| x |  (inherited from `TextElement`) |
| y |  (inherited from `TextElement`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_char_double_double_double_double method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character/_init_char_double_double_double_double.md

#### _init_char_double_double_double_double

```python
def _init_char_double_double_double_double(self, character, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| character | `str` |  |
| x | `float` |  |
| y | `float` |  |
| width | `float` |  |
| height | `float` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/character/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### FileInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo.md

#### FileInfo class

The FileInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type |  |
| _init_noargs |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| encrypted |  |
| file_type |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/_init_file_type.md

#### _init_file_type

```python
def _init_file_type(self, file_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### encrypted property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/encrypted.md

##### Definition:
```python
@property
def encrypted(self):
    ...
@encrypted.setter
def encrypted(self, value):
    ...
```

### file_type property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/fileinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### Layer class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer.md

#### Layer class

The Layer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_layer |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _init_noargs |  |
| _init_string |  |
| _init_string_boolean |  |
| _to_string_noargs |  |
| equals |  |
| equals_layer |  |
| equals_object |  |
| get_hash_code |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| name |  |
| visible |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_layer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/_equals_layer.md

#### _equals_layer

```python
def _equals_layer(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Layer` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/_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/viewer/python-net/groupdocs.viewer.results/layer/_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/viewer/python-net/groupdocs.viewer.results/layer/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/_init_string.md

#### _init_string

```python
def _init_string(self, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | `str` |  |

### _init_string_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/_init_string_boolean.md

#### _init_string_boolean

```python
def _init_string_boolean(self, name, visible):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | `str` |  |
| visible | `bool` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_layer method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/equals_layer.md

#### equals_layer

```python
def equals_layer(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### visible property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layer/visible.md

##### Definition:
```python
@property
def visible(self):
    ...
@visible.setter
def visible(self, value):
    ...
```

### Layout class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout.md

#### Layout class

The Layout type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _equals_layout |  |
| _equals_object |  |
| _get_hash_code_noargs |  |
| _init_noargs |  |
| _init_string_single_single |  |
| _to_string_noargs |  |
| equals |  |
| equals_layout |  |
| equals_object |  |
| get_hash_code |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| name |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _equals_layout method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/_equals_layout.md

#### _equals_layout

```python
def _equals_layout(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Layout` |  |

**Returns:** bool

### _equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/_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/viewer/python-net/groupdocs.viewer.results/layout/_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/viewer/python-net/groupdocs.viewer.results/layout/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_single_single method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/_init_string_single_single.md

#### _init_string_single_single

```python
def _init_string_single_single(self, name, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| name | `str` |  |
| width | `float` |  |
| height | `float` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_layout method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/equals_layout.md

#### equals_layout

```python
def equals_layout(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/layout/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### Line class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line.md

#### Line class

The Line type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_string_double_double_double_double_list_1_e328 |  |
| _to_string_noargs |  |
| to_string |  |
| _init_arg_double_double_double_double |  (inherited from `TextElement`) |

##### Properties
| Property | Description |
| :- | :- |
| words |  |
| height |  (inherited from `TextElement`) |
| value |  (inherited from `TextElement`) |
| width |  (inherited from `TextElement`) |
| x |  (inherited from `TextElement`) |
| y |  (inherited from `TextElement`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_double_double_double_double_list_1_e328 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/_init_string_double_double_double_double_list_1_e328.md

#### _init_string_double_double_double_double_list_1_e328

```python
def _init_string_double_double_double_double_list_1_e328(self, line, x, y, width, height, words):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| line | `str` |  |
| x | `float` |  |
| y | `float` |  |
| width | `float` |  |
| height | `float` |  |
| words | `List[Any]` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### words property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/line/words.md

##### Definition:
```python
@property
def words(self):
    ...
@words.setter
def words(self, value):
    ...
```

### LotusNotesViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/lotusnotesviewinfo.md

#### LotusNotesViewInfo class

The LotusNotesViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_int32 |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| notes_count |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/lotusnotesviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/lotusnotesviewinfo/_init_file_type_list_1_3205_int32.md

#### _init_file_type_list_1_3205_int32

```python
def _init_file_type_list_1_3205_int32(self, file_type, pages, notes_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| notes_count | `int` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/lotusnotesviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### notes_count property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/lotusnotesviewinfo/notes_count.md

##### Definition:
```python
@property
def notes_count(self):
    ...
@notes_count.setter
def notes_count(self, value):
    ...
```

### MailMessageViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mailmessageviewinfo.md

#### MailMessageViewInfo class

The MailMessageViewInfo type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _init_noargs |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| from_ |  |
| sent |  |
| subject |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### from_ property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mailmessageviewinfo/from_.md

##### Definition:
```python
@property
def from_(self):
    ...
```

### sent property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mailmessageviewinfo/sent.md

##### Definition:
```python
@property
def sent(self):
    ...
```

### subject property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mailmessageviewinfo/subject.md

##### Definition:
```python
@property
def subject(self):
    ...
```

### MboxViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mboxviewinfo.md

#### MboxViewInfo class

The MboxViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_int32 |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| messages_count |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mboxviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mboxviewinfo/_init_file_type_list_1_3205_int32.md

#### _init_file_type_list_1_3205_int32

```python
def _init_file_type_list_1_3205_int32(self, file_type, pages, notes_count):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| notes_count | `int` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mboxviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### messages_count property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/mboxviewinfo/messages_count.md

##### Definition:
```python
@property
def messages_count(self):
    ...
@messages_count.setter
def messages_count(self, value):
    ...
```

### OutlookViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/outlookviewinfo.md

#### OutlookViewInfo class

The OutlookViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_list_1_1352 |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| folders |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/outlookviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_list_1_1352 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/outlookviewinfo/_init_file_type_list_1_3205_list_1_1352.md

#### _init_file_type_list_1_3205_list_1_1352

```python
def _init_file_type_list_1_3205_list_1_1352(self, file_type, pages, folders):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| folders | `List[Any]` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/outlookviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### folders property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/outlookviewinfo/folders.md

##### Definition:
```python
@property
def folders(self):
    ...
@folders.setter
def folders(self, value):
    ...
```

### Page class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page.md

#### Page class

The Page type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_int32_boolean |  |
| _init_int32_boolean_int32_int32 |  |
| _init_int32_boolean_int32_int32_list_1_61c1 |  |
| _init_int32_string_boolean |  |
| _init_int32_string_boolean_int32_int32 |  |
| _init_int32_string_boolean_int32_int32_list_1_61c1 |  |
| _init_noargs |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| lines |  |
| name |  |
| number |  |
| visible |  |
| width |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_int32_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_boolean.md

#### _init_int32_boolean

```python
def _init_int32_boolean(self, number, visible):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| visible | `bool` |  |

### _init_int32_boolean_int32_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_boolean_int32_int32.md

#### _init_int32_boolean_int32_int32

```python
def _init_int32_boolean_int32_int32(self, number, visible, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| visible | `bool` |  |
| width | `int` |  |
| height | `int` |  |

### _init_int32_boolean_int32_int32_list_1_61c1 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_boolean_int32_int32_list_1_61c1.md

#### _init_int32_boolean_int32_int32_list_1_61c1

```python
def _init_int32_boolean_int32_int32_list_1_61c1(self, number, visible, width, height, lines):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| visible | `bool` |  |
| width | `int` |  |
| height | `int` |  |
| lines | `List[Any]` |  |

### _init_int32_string_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_string_boolean.md

#### _init_int32_string_boolean

```python
def _init_int32_string_boolean(self, number, name, visible):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| name | `str` |  |
| visible | `bool` |  |

### _init_int32_string_boolean_int32_int32 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_string_boolean_int32_int32.md

#### _init_int32_string_boolean_int32_int32

```python
def _init_int32_string_boolean_int32_int32(self, number, name, visible, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| name | `str` |  |
| visible | `bool` |  |
| width | `int` |  |
| height | `int` |  |

### _init_int32_string_boolean_int32_int32_list_1_61c1 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_int32_string_boolean_int32_int32_list_1_61c1.md

#### _init_int32_string_boolean_int32_int32_list_1_61c1

```python
def _init_int32_string_boolean_int32_int32_list_1_61c1(self, number, name, visible, width, height, lines):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| number | `int` |  |
| name | `str` |  |
| visible | `bool` |  |
| width | `int` |  |
| height | `int` |  |
| lines | `List[Any]` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### lines property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/lines.md

##### Definition:
```python
@property
def lines(self):
    ...
@lines.setter
def lines(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/name.md

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### number property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/number.md

##### Definition:
```python
@property
def number(self):
    ...
@number.setter
def number(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### visible property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/visible.md

##### Definition:
```python
@property
def visible(self):
    ...
@visible.setter
def visible(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/page/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### PdfViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/pdfviewinfo.md

#### PdfViewInfo class

The PdfViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_boolean |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| printing_allowed |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/pdfviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/pdfviewinfo/_init_file_type_list_1_3205_boolean.md

#### _init_file_type_list_1_3205_boolean

```python
def _init_file_type_list_1_3205_boolean(self, file_type, pages, printing_allowed):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| printing_allowed | `bool` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/pdfviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### printing_allowed property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/pdfviewinfo/printing_allowed.md

##### Definition:
```python
@property
def printing_allowed(self):
    ...
@printing_allowed.setter
def printing_allowed(self, value):
    ...
```

### ProjectManagementViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo.md

#### ProjectManagementViewInfo class

The ProjectManagementViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205_date_time_date_time |  |
| _init_noargs |  |
| _init_file_type_list_1_3205 |  (inherited from `ViewInfo`) |
| _to_string_noargs |  (inherited from `ViewInfo`) |
| to_string |  (inherited from `ViewInfo`) |

##### Properties
| Property | Description |
| :- | :- |
| end_date |  |
| start_date |  |
| file_type |  (inherited from `ViewInfo`) |
| pages |  (inherited from `ViewInfo`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205_date_time_date_time method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo/_init_file_type_list_1_3205_date_time_date_time.md

#### _init_file_type_list_1_3205_date_time_date_time

```python
def _init_file_type_list_1_3205_date_time_date_time(self, file_type, pages, start_date, end_date):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |
| start_date | `datetime` |  |
| end_date | `datetime` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### end_date property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo/end_date.md

##### Definition:
```python
@property
def end_date(self):
    ...
@end_date.setter
def end_date(self, value):
    ...
```

### start_date property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/projectmanagementviewinfo/start_date.md

##### Definition:
```python
@property
def start_date(self):
    ...
@start_date.setter
def start_date(self, value):
    ...
```

### Resource class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource.md

#### Resource class

The Resource type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_string_boolean |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| file_name |  |
| nested |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/_init_string_boolean.md

#### _init_string_boolean

```python
def _init_string_boolean(self, file_name, nested):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_name | `str` |  |
| nested | `bool` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### file_name property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/file_name.md

##### Definition:
```python
@property
def file_name(self):
    ...
@file_name.setter
def file_name(self, value):
    ...
```

### nested property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/nested.md

##### Definition:
```python
@property
def nested(self):
    ...
@nested.setter
def nested(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/resource/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### TextElement class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement.md

#### TextElement class

The TextElement type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_arg_double_double_double_double |  |
| _init_noargs |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| value |  |
| width |  |
| x |  |
| y |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_arg_double_double_double_double method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/_init_arg_double_double_double_double.md

#### _init_arg_double_double_double_double

```python
def _init_arg_double_double_double_double(self, value, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| value | `Any` |  |
| x | `float` |  |
| y | `float` |  |
| width | `float` |  |
| height | `float` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### height property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/height.md

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### value property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/value.md

##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/width.md

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/x.md

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/textelement/y.md

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### ViewInfo class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo.md

#### ViewInfo class

The ViewInfo type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_file_type_list_1_3205 |  |
| _init_noargs |  |
| _to_string_noargs |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| file_type |  |
| pages |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_file_type_list_1_3205 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/_init_file_type_list_1_3205.md

#### _init_file_type_list_1_3205

```python
def _init_file_type_list_1_3205(self, file_type, pages):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_type | `FileType` |  |
| pages | `List[Any]` |  |

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### file_type property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/file_type.md

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/pages.md

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/viewinfo/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### Word class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word.md

#### Word class

The Word type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_noargs |  |
| _init_string_double_double_double_double_list_1_a_76d |  |
| _to_string_noargs |  |
| to_string |  |
| _init_arg_double_double_double_double |  (inherited from `TextElement`) |

##### Properties
| Property | Description |
| :- | :- |
| characters |  |
| height |  (inherited from `TextElement`) |
| value |  (inherited from `TextElement`) |
| width |  (inherited from `TextElement`) |
| x |  (inherited from `TextElement`) |
| y |  (inherited from `TextElement`) |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_double_double_double_double_list_1_a_76d method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/_init_string_double_double_double_double_list_1_a_76d.md

#### _init_string_double_double_double_double_list_1_a_76d

```python
def _init_string_double_double_double_double_list_1_a_76d(self, word, x, y, width, height, characters):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| word | `str` |  |
| x | `float` |  |
| y | `float` |  |
| width | `float` |  |
| height | `float` |  |
| characters | `List[Any]` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### characters property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/characters.md

##### Definition:
```python
@property
def characters(self):
    ...
@characters.setter
def characters(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.results/word/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### groupdocs.viewer
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer.md

Main GroupDocs.Viewer.CrossPlatform namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `FileType` |  |
| `IAuxDisposable` |  |
| `License` | Manages GroupDocs.Viewer licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |
| `Viewer` |  |
| `ViewerSettings` |  |

##### Exceptions
| Exception | Description |
| :- | :- |
| `GroupDocsViewerException` |  |
| `IncorrectPasswordException` |  |
| `InvalidFontFormatException` |  |
| `InvalidImageFormatException` |  |
| `PasswordRequiredException` |  |

### FileType class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype.md

#### FileType class

The FileType type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _detect_encoding_stream |  |
| _detect_encoding_string |  |
| _equals_file_type |  |
| _equals_object |  |
| _from_stream_stream |  |
| _from_stream_stream_ilogger |  |
| _from_stream_stream_string |  |
| _from_stream_stream_string_ilogger |  |
| _get_hash_code_noargs |  |
| _init_noargs |  |
| _init_string_string |  |
| _to_string_noargs |  |
| detect_encoding |  |
| detect_encoding_file |  |
| detect_encoding_stream |  |
| detect_encoding_streams |  |
| detect_encoding_string |  |
| equals |  |
| equals_file_type |  |
| equals_object |  |
| from_extension |  |
| from_file_path |  |
| from_media_type |  |
| from_stream |  |
| from_stream_file |  |
| from_stream_stream |  |
| from_stream_streams |  |
| from_stream_string |  |
| get_hash_code |  |
| get_supported_file_types |  |
| to_string |  |

##### Properties
| Property | Description |
| :- | :- |
| extension |  |
| file_format |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _detect_encoding_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_detect_encoding_stream.md

#### _detect_encoding_stream

```python
def _detect_encoding_stream(cls, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

**Returns:** Encoding

### _detect_encoding_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_detect_encoding_string.md

#### _detect_encoding_string

```python
def _detect_encoding_string(cls, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** Encoding

### _equals_file_type method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/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/viewer/python-net/groupdocs.viewer/filetype/_equals_object.md

#### _equals_object

```python
def _equals_object(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` |  |

**Returns:** bool

### _from_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_from_stream_stream.md

#### _from_stream_stream

```python
def _from_stream_stream(cls, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

**Returns:** FileType

### _from_stream_stream_ilogger method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_from_stream_stream_ilogger.md

#### _from_stream_stream_ilogger

```python
def _from_stream_stream_ilogger(cls, stream, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| logger | `ILogger` |  |

**Returns:** FileType

### _from_stream_stream_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_from_stream_stream_string.md

#### _from_stream_stream_string

```python
def _from_stream_stream_string(cls, stream, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| password | `str` |  |

**Returns:** FileType

### _from_stream_stream_string_ilogger method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_from_stream_stream_string_ilogger.md

#### _from_stream_stream_string_ilogger

```python
def _from_stream_stream_string_ilogger(cls, stream, password, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| password | `str` |  |
| logger | `ILogger` |  |

**Returns:** FileType

### _get_hash_code_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_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/viewer/python-net/groupdocs.viewer/filetype/_init_noargs.md

#### _init_noargs

```python
def _init_noargs(self):
    ...
```

### _init_string_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_init_string_string.md

#### _init_string_string

```python
def _init_string_string(self, file_format, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_format | `str` |  |
| extension | `str` |  |

### _to_string_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/_to_string_noargs.md

#### _to_string_noargs

```python
def _to_string_noargs(self):
    ...
```

**Returns:** str

### detect_encoding method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/detect_encoding.md

#### detect_encoding

```python
def detect_encoding(cls):
    ...
```

### detect_encoding_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/detect_encoding_file.md

#### detect_encoding_file

```python
def detect_encoding_file(cls):
    ...
```

### detect_encoding_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/detect_encoding_stream.md

#### detect_encoding_stream

```python
def detect_encoding_stream(cls):
    ...
```

### detect_encoding_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/detect_encoding_streams.md

#### detect_encoding_streams

```python
def detect_encoding_streams(cls):
    ...
```

### detect_encoding_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/detect_encoding_string.md

#### detect_encoding_string

```python
def detect_encoding_string(cls):
    ...
```

### equals method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/equals.md

#### equals

```python
def equals(self):
    ...
```

### equals_file_type method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/extension.md

##### Definition:
```python
@property
def extension(self):
    ...
@extension.setter
def extension(self, value):
    ...
```

### file_format property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/file_format.md

##### Definition:
```python
@property
def file_format(self):
    ...
@file_format.setter
def file_format(self, value):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_extension.md

#### from_extension

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` |  |

**Returns:** FileType

### from_file_path method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_file_path.md

#### from_file_path

```python
def from_file_path(cls, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

**Returns:** FileType

### from_media_type method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_media_type.md

#### from_media_type

```python
def from_media_type(cls, media_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| media_type | `str` |  |

**Returns:** FileType

### from_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_stream.md

#### from_stream

```python
def from_stream(cls):
    ...
```

### from_stream_file method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_stream_file.md

#### from_stream_file

```python
def from_stream_file(cls):
    ...
```

### from_stream_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_stream_stream.md

#### from_stream_stream

```python
def from_stream_stream(cls):
    ...
```

### from_stream_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_stream_streams.md

#### from_stream_streams

```python
def from_stream_streams(cls):
    ...
```

### from_stream_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/from_stream_string.md

#### from_stream_string

```python
def from_stream_string(cls):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/get_hash_code.md

#### get_hash_code

```python
def get_hash_code(self):
    ...
```

### get_supported_file_types method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/get_supported_file_types.md

#### get_supported_file_types

```python
def get_supported_file_types(cls):
    ...
```

**Returns:** List[Any]

### to_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/filetype/to_string.md

#### to_string

```python
def to_string(self):
    ...
```

### GroupDocsViewerException class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/groupdocsviewerexception.md

#### GroupDocsViewerException class

The GroupDocsViewerException type exposes the following members:

### IAuxDisposable class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/iauxdisposable.md

#### IAuxDisposable class

The IAuxDisposable type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| is_disposed |  |

### is_disposed property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/iauxdisposable/is_disposed.md

##### Definition:
```python
@property
def is_disposed(self):
    ...
```

### IncorrectPasswordException class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/incorrectpasswordexception.md

#### IncorrectPasswordException class

The IncorrectPasswordException type exposes the following members:

### InvalidFontFormatException class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/invalidfontformatexception.md

#### InvalidFontFormatException class

The InvalidFontFormatException type exposes the following members:

### InvalidImageFormatException class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/invalidimageformatexception.md

#### InvalidImageFormatException class

The InvalidImageFormatException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/license.md

#### License class

Manages GroupDocs.Viewer 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. |

### set_license method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/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/viewer/python-net/groupdocs.viewer/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. |

### get_consumption_credit method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/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/viewer/python-net/groupdocs.viewer/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/viewer/python-net/groupdocs.viewer/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/viewer/python-net/groupdocs.viewer/passwordrequiredexception.md

#### PasswordRequiredException class

The PasswordRequiredException type exposes the following members:

### Viewer class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer.md

#### Viewer class

The Viewer type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _dispose_noargs |  |
| _get_all_fonts_noargs |  |
| _get_attachments_noargs |  |
| _get_file_info_noargs |  |
| _get_view_info_view_info_options |  |
| _init_func_1_e_2e2 |  |
| _init_func_1_e_2e2_func_1_6f12 |  |
| _init_func_1_e_2e2_func_1_6f12_viewer_settings |  |
| _init_func_1_e_2e2_viewer_settings |  |
| _init_stream |  |
| _init_stream_boolean |  |
| _init_stream_load_options |  |
| _init_stream_load_options_boolean |  |
| _init_stream_load_options_viewer_settings |  |
| _init_stream_load_options_viewer_settings_boolean |  |
| _init_stream_viewer_settings |  |
| _init_stream_viewer_settings_boolean |  |
| _init_string |  |
| _init_string_load_options |  |
| _init_string_load_options_viewer_settings |  |
| _init_string_viewer_settings |  |
| _save_attachment_attachment_stream |  |
| _search_search_highlight_options |  |
| _view_view_options |  |
| _view_view_options_cancellation_token_int32_array |  |
| _view_view_options_int32_array |  |
| dispose |  |
| get_all_fonts |  |
| get_attachments |  |
| get_file_info |  |
| get_view_info |  |
| get_view_info_view_info_options |  |
| save_attachment |  |
| save_attachment_attachment |  |
| save_attachment_stream |  |
| save_attachment_streams |  |
| search |  |
| search_search_highlight_options |  |
| view |  |
| view_view_options |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _dispose_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_dispose_noargs.md

#### _dispose_noargs

```python
def _dispose_noargs(self):
    ...
```

### _get_all_fonts_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_get_all_fonts_noargs.md

#### _get_all_fonts_noargs

```python
def _get_all_fonts_noargs(self):
    ...
```

**Returns:** List[IFontInfo]

### _get_attachments_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_get_attachments_noargs.md

#### _get_attachments_noargs

```python
def _get_attachments_noargs(self):
    ...
```

**Returns:** List[Any]

### _get_file_info_noargs method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_get_file_info_noargs.md

#### _get_file_info_noargs

```python
def _get_file_info_noargs(self):
    ...
```

**Returns:** FileInfo

### _get_view_info_view_info_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_get_view_info_view_info_options.md

#### _get_view_info_view_info_options

```python
def _get_view_info_view_info_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `ViewInfoOptions` |  |

**Returns:** ViewInfo

### _init_func_1_e_2e2 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_func_1_e_2e2.md

#### _init_func_1_e_2e2

```python
def _init_func_1_e_2e2(self, get_file_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |

### _init_func_1_e_2e2_func_1_6f12 method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_func_1_e_2e2_func_1_6f12.md

#### _init_func_1_e_2e2_func_1_6f12

```python
def _init_func_1_e_2e2_func_1_6f12(self, get_file_stream, get_load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| get_load_options | `LoadOptions` |  |

### _init_func_1_e_2e2_func_1_6f12_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_func_1_e_2e2_func_1_6f12_viewer_settings.md

#### _init_func_1_e_2e2_func_1_6f12_viewer_settings

```python
def _init_func_1_e_2e2_func_1_6f12_viewer_settings(self, get_file_stream, get_load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| get_load_options | `LoadOptions` |  |
| settings | `ViewerSettings` |  |

### _init_func_1_e_2e2_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_func_1_e_2e2_viewer_settings.md

#### _init_func_1_e_2e2_viewer_settings

```python
def _init_func_1_e_2e2_viewer_settings(self, get_file_stream, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| get_file_stream | `Stream` |  |
| settings | `ViewerSettings` |  |

### _init_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream.md

#### _init_stream

```python
def _init_stream(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |

### _init_stream_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_boolean.md

#### _init_stream_boolean

```python
def _init_stream_boolean(self, stream, leave_open):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| leave_open | `bool` |  |

### _init_stream_load_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_load_options.md

#### _init_stream_load_options

```python
def _init_stream_load_options(self, stream, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| load_options | `LoadOptions` |  |

### _init_stream_load_options_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_load_options_boolean.md

#### _init_stream_load_options_boolean

```python
def _init_stream_load_options_boolean(self, stream, load_options, leave_open):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| load_options | `LoadOptions` |  |
| leave_open | `bool` |  |

### _init_stream_load_options_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_load_options_viewer_settings.md

#### _init_stream_load_options_viewer_settings

```python
def _init_stream_load_options_viewer_settings(self, stream, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| load_options | `LoadOptions` |  |
| settings | `ViewerSettings` |  |

### _init_stream_load_options_viewer_settings_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_load_options_viewer_settings_boolean.md

#### _init_stream_load_options_viewer_settings_boolean

```python
def _init_stream_load_options_viewer_settings_boolean(self, stream, load_options, settings, leave_open):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| load_options | `LoadOptions` |  |
| settings | `ViewerSettings` |  |
| leave_open | `bool` |  |

### _init_stream_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_viewer_settings.md

#### _init_stream_viewer_settings

```python
def _init_stream_viewer_settings(self, stream, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| settings | `ViewerSettings` |  |

### _init_stream_viewer_settings_boolean method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_stream_viewer_settings_boolean.md

#### _init_stream_viewer_settings_boolean

```python
def _init_stream_viewer_settings_boolean(self, stream, settings, leave_open):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `Stream` |  |
| settings | `ViewerSettings` |  |
| leave_open | `bool` |  |

### _init_string method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_string.md

#### _init_string

```python
def _init_string(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |

### _init_string_load_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_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_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_string_load_options_viewer_settings.md

#### _init_string_load_options_viewer_settings

```python
def _init_string_load_options_viewer_settings(self, file_path, load_options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| load_options | `LoadOptions` |  |
| settings | `ViewerSettings` |  |

### _init_string_viewer_settings method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_init_string_viewer_settings.md

#### _init_string_viewer_settings

```python
def _init_string_viewer_settings(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` |  |
| settings | `ViewerSettings` |  |

### _save_attachment_attachment_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_save_attachment_attachment_stream.md

#### _save_attachment_attachment_stream

```python
def _save_attachment_attachment_stream(self, attachment, destination):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| attachment | `Attachment` |  |
| destination | `Stream` |  |

### _search_search_highlight_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_search_search_highlight_options.md

#### _search_search_highlight_options

```python
def _search_search_highlight_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `SearchHighlightOptions` |  |

### _view_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_view_view_options.md

#### _view_view_options

```python
def _view_view_options(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `ViewOptions` |  |

### _view_view_options_cancellation_token_int32_array method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_view_view_options_cancellation_token_int32_array.md

#### _view_view_options_cancellation_token_int32_array

```python
def _view_view_options_cancellation_token_int32_array(self, options, cancellation_token, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `ViewOptions` |  |
| cancellation_token | `CancellationToken` |  |
| page_numbers | `List[int]` |  |

### _view_view_options_int32_array method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/_view_view_options_int32_array.md

#### _view_view_options_int32_array

```python
def _view_view_options_int32_array(self, options, page_numbers):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `ViewOptions` |  |
| page_numbers | `List[int]` |  |

### dispose method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/dispose.md

#### dispose

```python
def dispose(self):
    ...
```

### get_all_fonts method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/get_all_fonts.md

#### get_all_fonts

```python
def get_all_fonts(self):
    ...
```

### get_attachments method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/get_attachments.md

#### get_attachments

```python
def get_attachments(self):
    ...
```

### get_file_info method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/get_file_info.md

#### get_file_info

```python
def get_file_info(self):
    ...
```

### get_view_info method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/get_view_info.md

#### get_view_info

```python
def get_view_info(self):
    ...
```

### get_view_info_view_info_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/get_view_info_view_info_options.md

#### get_view_info_view_info_options

```python
def get_view_info_view_info_options(self):
    ...
```

### save_attachment method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/save_attachment.md

#### save_attachment

```python
def save_attachment(self):
    ...
```

### save_attachment_attachment method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/save_attachment_attachment.md

#### save_attachment_attachment

```python
def save_attachment_attachment(self):
    ...
```

### save_attachment_stream method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/save_attachment_stream.md

#### save_attachment_stream

```python
def save_attachment_stream(self):
    ...
```

### save_attachment_streams method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/save_attachment_streams.md

#### save_attachment_streams

```python
def save_attachment_streams(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/search.md

#### search

```python
def search(self):
    ...
```

### search_search_highlight_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/search_search_highlight_options.md

#### search_search_highlight_options

```python
def search_search_highlight_options(self):
    ...
```

### view method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/view.md

#### view

```python
def view(self):
    ...
```

### view_view_options method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewer/view_view_options.md

#### view_view_options

```python
def view_view_options(self):
    ...
```

### ViewerSettings class
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings.md

#### ViewerSettings class

The ViewerSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Methods
| Method | Description |
| :- | :- |
| _init_icache |  |
| _init_icache_ilogger |  |
| _init_ilogger |  |

##### Properties
| Property | Description |
| :- | :- |
| cache |  |
| logger |  |

### __init__ constructor
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### _init_icache method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/_init_icache.md

#### _init_icache

```python
def _init_icache(self, cache):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cache | `ICache` |  |

### _init_icache_ilogger method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/_init_icache_ilogger.md

#### _init_icache_ilogger

```python
def _init_icache_ilogger(self, cache, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| cache | `ICache` |  |
| logger | `ILogger` |  |

### _init_ilogger method
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/_init_ilogger.md

#### _init_ilogger

```python
def _init_ilogger(self, logger):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| logger | `ILogger` |  |

### cache property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/cache.md

##### Definition:
```python
@property
def cache(self):
    ...
```

### logger property
Path: https://reference.groupdocs.com/viewer/python-net/groupdocs.viewer/viewersettings/logger.md

##### Definition:
```python
@property
def logger(self):
    ...
```


# GroupDocs.Watermark

> Add, find, edit, and remove watermarks in documents, images, and PDFs.

## Java

### GroupDocs.Watermark for Java
Path: https://reference.groupdocs.com/watermark/java.md

#### Packages
| Package | Description |
| --- | --- |
| com.groupdocs.watermark |  |
| com.groupdocs.watermark.common |  |
| com.groupdocs.watermark.contents |  |
| com.groupdocs.watermark.exceptions |  |
| com.groupdocs.watermark.licenses |  |
| com.groupdocs.watermark.logging |  |
| com.groupdocs.watermark.options |  |
| com.groupdocs.watermark.search |  |
| com.groupdocs.watermark.watermarks |  |

### com.groupdocs.watermark.common
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common.md

#### Classes

| Class | Description |
| --- | --- |
| Attachment | Represents a file attached to a document. |
| Dimension | Represents dimensions of a 2d object. |
| FileType | Represents file type. |
| FormatFamily | Enumeration of supported format families. |
| HorizontalAlignment | Enumeration of possible horizontal alignment values. |
| PageInfo | Represents a document page description. |
| ReadOnlyListBase<T> | Provides the abstract base class for a strongly typed read-only list. |
| RemoveOnlyListBase<T> | Provides the abstract base class for a strongly typed remove-only list. |
| UnitOfMeasurement | Represents units of measurement. |
| VerticalAlignment | Enumeration of possible vertical alignment values. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines the methods that are required for getting the basic document information. |

### Attachment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/attachment.md

**Inheritance:**
java.lang.Object
```
public abstract class Attachment
```

Represents a file attached to a document.

[Email attachments]: https://docs.groupdocs.com/display/watermarkjava/Email+attachments
[Attachments in PDF document]: https://docs.groupdocs.com/display/watermarkjava/Attachments+in+PDF+document
[Working with spreadsheet document attachments]: https://docs.groupdocs.com/display/watermarkjava/Working+with+spreadsheet+document+attachments
#### Methods

| Method | Description |
| --- | --- |
| getDocumentInfo() | Gets the information about a document stored in the attached file. |
| getContent() | Gets the attached file content. |
| setContent(byte[] value) | Sets the attached file content. |
| createWatermarker() | Loads a content from the attached file. |
| createWatermarker(LoadOptions loadOptions) | Loads a content from the attached file with the specified load options. |
| createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| getContentStream() | Gets a stream from the attached file. |
| setContentStream(System.IO.Stream stream) | Updates attached file from a stream. |
| updateContent(Watermarker updatedVersion) | Updates the attached content. |
##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets the information about a document stored in the attached file.

**Returns:**
IDocumentInfo - The `IDocumentInfo` instance that contains detected information.
##### getContent()
```
public abstract byte[] getContent()
```

Gets the attached file content.

**Returns:**
byte[] - The attached file content.
##### setContent(byte[] value)
```
public abstract void setContent(byte[] value)
```

Sets the attached file content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The attached file content. |

##### createWatermarker()
```
public final Watermarker createWatermarker()
```

Loads a content from the attached file.

**Returns:**
Watermarker - The instance of appropriate descendant of `Content` class.
##### createWatermarker(LoadOptions loadOptions)
```
public final Watermarker createWatermarker(LoadOptions loadOptions)
```

Loads a content from the attached file with the specified load options.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | Additional options to use when loading an attachment content. |

**Returns:**
Watermarker - The instance of appropriate descendant of `Content` class.
##### createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)
```
public final Watermarker createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)
```

Loads a content from the attached file with the specified load options and settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | Additional options to use when loading an attachment content. |
| watermarkerSettings | WatermarkerSettings | Additional settings to use when working with loaded document. |

**Returns:**
Watermarker - The instance of appropriate descendant of `Content` class.
##### getContentStream()
```
public System.IO.Stream getContentStream()
```

Gets a stream from the attached file.

**Returns:**
com.aspose.ms.System.IO.Stream - The stream to read the file content from.
##### setContentStream(System.IO.Stream stream)
```
public void setContentStream(System.IO.Stream stream)
```

Updates attached file from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream | The stream to update attached file from. |

##### updateContent(Watermarker updatedVersion)
```
public final void updateContent(Watermarker updatedVersion)
```

Updates the attached content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| updatedVersion | Watermarker | The updated version of the content. |

### Dimension
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/dimension.md

**Inheritance:**
java.lang.Object
```
public final class Dimension
```

Represents dimensions of a 2d object.
#### Fields

| Field | Description |
| --- | --- |
| Width | Object width. |
| Height | Object height. |
##### Width
```
public static final int Width
```

Object width.

##### Height
```
public static final int Height
```

Object height.

### FileType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/filetype.md

**Inheritance:**
java.lang.Object
```
public final class FileType
```

Represents file type.

This class provides methods to obtain list of all file types supported by **GroupDocs.Watermark**.

[Supported Document Formats]: https://docs.groupdocs.com/display/watermarkjava/Supported+Document+Formats
[Get supported file formats]: https://docs.groupdocs.com/display/watermarkjava/Get+supported+file+formats
[Get document info]: https://docs.groupdocs.com/display/watermarkjava/Get+document+info
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Represents unknown file type. |
| OOXML | Office open xml file (.ooxml). |
| 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. |
| VSSX | Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. |
| VSDM | Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. |
| VST | Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. |
| VSTX | Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. |
| VSTM | Files with VSTM extension are template files created with Microsoft Visio that support macros. |
| VSSM | Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. |
| 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. |
| 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. |
| OFT | Files with .OFT extension represent message template files that are created using Microsoft Outlook. |
| TIF | TIFF or 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. |
| TIFF | TIFF or 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. |
| JPG | A JPEG 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 | Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images. |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. |
| WEBP | WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. |
| PDF | Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. |
| PPT | A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. |
| PPTX | Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. |
| PPS | PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. |
| PPSX | PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. |
| PPTM | Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. |
| POTX | Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. |
| POTM | Files with POTM extension are Microsoft PowerPoint template files with support for Macros. |
| PPSM | Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. |
| XLS | Files with XLS extension represent 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 | Files with XLSM extension is a type of Spreasheet files that support Macros. |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. |
| XLSB | XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. |
| 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. |
| DOC | Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| DOCX | DOCX is a well-known format for Microsoft Word documents. |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| 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. |
| DOTX | Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. |
| 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. |
| FlatOpc | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). |
| FlatOpcMacroEnabled | Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). |
| FlatOpcTemplate | Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). |
| FlatOpcTemplateMacroEnabled | Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). |
#### Methods

| Method | Description |
| --- | --- |
| getFileFormatName() | Gets the file type name e.g., "Microsoft Word Document". |
| getExtension() | Gets the file name suffix (including the period ".") e.g., ".doc". |
| getFormatFamily() | Gets the format family. |
| getFileFormat() |  |
| equals(FileType other) | Determines whether the current `FileType` is the same as the specified `FileType` object. |
| fromExtension(String extension) | Maps the file extension to the file type. |
| getSupportedFileTypes() | Retrieves the supported file types. |
| equals(Object obj) | Determines whether the current `FileType` is the same as the specified object. |
| hashCode() | Returns a hash code for the current `FileType` object. |
| op_Equality(FileType left, FileType right) | Determines whether two `FileType` objects are the same. |
| op_Inequality(FileType left, FileType right) | Determines whether two `FileType` objects are not the same. |
| toString() | Returns a string that represents the current object. |
| isImage() |  |
##### Unknown
```
public static final FileType Unknown
```

Represents unknown file type.

##### OOXML
```
public static final FileType OOXML
```

Office open xml file (.ooxml).

##### VSD
```
public static final FileType 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 FileType VSDX
```

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsdx/

##### VSS
```
public static final FileType 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/

##### VSSX
```
public static final FileType VSSX
```

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssx/

##### VSDM
```
public static final FileType VSDM
```

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsdm/

##### VST
```
public static final FileType VST
```

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vst/

##### VSTX
```
public static final FileType VSTX
```

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstx/

##### VSTM
```
public static final FileType VSTM
```

Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vstm/

##### VSSM
```
public static final FileType VSSM
```

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vssm/

##### VSX
```
public static final FileType VSX
```

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vsx/

##### VTX
```
public static final FileType VTX
```

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vtx/

##### VDW
```
public static final FileType 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 FileType VDX
```

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/vdx/

##### MSG
```
public static final FileType 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 FileType EML
```

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/eml/

##### EMLX
```
public static final FileType 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/

##### OFT
```
public static final FileType OFT
```

Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/email/oft/

##### TIF
```
public static final FileType TIF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### TIFF
```
public static final FileType TIFF
```

TIFF or 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/tiff/

##### JPG
```
public static final FileType JPG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### JPEG
```
public static final FileType JPEG
```

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jpeg/

##### PNG
```
public static final FileType PNG
```

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/png/

##### GIF
```
public static final FileType GIF
```

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/gif/

##### BMP
```
public static final FileType BMP
```

Files having extension .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/

##### JPF
```
public static final FileType JPF
```

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2/

##### JPX
```
public static final FileType JPX
```

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2/

##### JPM
```
public static final FileType JPM
```

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/image/jp2/

##### WEBP
```
public static final FileType 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][].

[here]: https://wiki.fileformat.com/image/webp/

##### PDF
```
public static final FileType 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/

##### PPT
```
public static final FileType 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/

##### PPTX
```
public static final FileType 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/

##### PPS
```
public static final FileType 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/

##### PPSX
```
public static final FileType 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/

##### PPTM
```
public static final FileType 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/

##### POTX
```
public static final FileType 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/

##### POTM
```
public static final FileType 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/

##### PPSM
```
public static final FileType 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/

##### XLS
```
public static final FileType XLS
```

Files with XLS extension represent 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/specification/spreadsheet/xls/

##### XLSX
```
public static final FileType 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/specification/spreadsheet/xlsx/

##### XLSM
```
public static final FileType XLSM
```

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlsm/

##### XLTX
```
public static final FileType XLTX
```

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltx/

##### XLTM
```
public static final FileType XLTM
```

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xltm/

##### XLSB
```
public static final FileType 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/specification/spreadsheet/xlsb/

##### XLT
```
public static final FileType 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. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/specification/spreadsheet/xlt/

##### DOC
```
public static final FileType 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/

##### DOCX
```
public static final FileType 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/

##### DOCM
```
public static final FileType 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/

##### DOT
```
public static final FileType 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/

##### DOTX
```
public static final FileType 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/

##### DOTM
```
public static final FileType 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/

##### RTF
```
public static final FileType RTF
```

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/rtf/

##### ODT
```
public static final FileType ODT
```

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here][].

[here]: https://wiki.fileformat.com/word-processing/odt/

##### FlatOpc
```
public static final FileType FlatOpc
```

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Office_Open_XML

##### FlatOpcMacroEnabled
```
public static final FileType FlatOpcMacroEnabled
```

Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Office_Open_XML

##### FlatOpcTemplate
```
public static final FileType FlatOpcTemplate
```

Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Office_Open_XML

##### FlatOpcTemplateMacroEnabled
```
public static final FileType FlatOpcTemplateMacroEnabled
```

Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here][].

[here]: https://en.wikipedia.org/wiki/Office_Open_XML

##### getFileFormatName()
```
public final String getFileFormatName()
```

Gets the file type name e.g., "Microsoft Word Document".

**Returns:**
java.lang.String - The file type name.
##### getExtension()
```
public final String getExtension()
```

Gets the file name suffix (including the period ".") e.g., ".doc".

**Returns:**
java.lang.String - The file name suffix (including the period ".").
##### getFormatFamily()
```
public final int getFormatFamily()
```

Gets the format family.

**Returns:**
int - The format family.
##### getFileFormat()
```
public final int getFileFormat()
```

**Returns:**
int
##### equals(FileType other)
```
public final boolean equals(FileType other)
```

Determines whether the current `FileType` is the same as the specified `FileType` object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

**Returns:**
boolean - `true` if both `FileType` objects are the same; otherwise, `false`.
##### fromExtension(String extension)
```
public static FileType fromExtension(String extension)
```

Maps the file extension to the file type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| extension | java.lang.String | The file extension (including the period "."). |

**Returns:**
FileType - When the file type is supported returns it, otherwise returns the default `#Unknown.Unknown` file type.
##### getSupportedFileTypes()
```
public static FileType[] getSupportedFileTypes()
```

Retrieves the supported file types.

**Returns:**
com.groupdocs.watermark.common.FileType[] - Returns the sequence of the supported file types.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the current `FileType` is the same as the specified object.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to compare with the current `FileType` object. |

**Returns:**
boolean - `true` if `obj` parameter is `FileType` and is the same as the current `FileType` object; otherwise, `false`.
##### hashCode()
```
public int hashCode()
```

Returns a hash code for the current `FileType` object.

**Returns:**
int - A hash code for the current `FileType` object.
##### op_Equality(FileType left, FileType right)
```
public static boolean op_Equality(FileType left, FileType right)
```

Determines whether two `FileType` objects are the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

**Returns:**
boolean - `true` if both `FileType` objects are the same; otherwise, `false`.
##### op_Inequality(FileType left, FileType right)
```
public static boolean op_Inequality(FileType left, FileType right)
```

Determines whether two `FileType` objects are not the same.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

**Returns:**
boolean - `true` if both `FileType` objects are not the same; otherwise, `false`.
##### toString()
```
public String toString()
```

Returns a string that represents the current object.

**Returns:**
java.lang.String - A string that represents the current object.
##### isImage()
```
public final boolean isImage()
```

**Returns:**
boolean

### FormatFamily
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/formatfamily.md

**Inheritance:**
java.lang.Object
```
public final class FormatFamily
```

Enumeration of supported format families.
#### Fields

| Field | Description |
| --- | --- |
| Unknown | Unknown format family. |
| Diagram | Diagram format family. |
| Email | Email format family. |
| Image | Image format family. |
| MultiframeImage | Multi frame image format family. |
| Pdf | PDF format family. |
| Presentation | Presentation format family. |
| Spreadsheet | Spreadsheet format family. |
| WordProcessing | Word processing format family. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `FormatFamily` value. |
##### Unknown
```
public static final int Unknown
```

Unknown format family.

##### Diagram
```
public static final int Diagram
```

Diagram format family.

##### Email
```
public static final int Email
```

Email format family.

##### Image
```
public static final int Image
```

Image format family.

##### MultiframeImage
```
public static final int MultiframeImage
```

Multi frame image format family.

##### Pdf
```
public static final int Pdf
```

PDF format family.

##### Presentation
```
public static final int Presentation
```

Presentation format family.

##### Spreadsheet
```
public static final int Spreadsheet
```

Spreadsheet format family.

##### WordProcessing
```
public static final int WordProcessing
```

Word processing format family.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `FormatFamily` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `FormatFamily` value.

### HorizontalAlignment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/horizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class HorizontalAlignment
```

Enumeration of possible horizontal alignment values.
#### Fields

| Field | Description |
| --- | --- |
| None | No alignment (use specified position). |
| Left | Align to left. |
| Center | Center alignment. |
| Right | Align to right. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `HorizontalAlignment` value. |
| parse(String value) | Parses a string to a `HorizontalAlignment` enumeration value. |
##### None
```
public static final int None
```

No alignment (use specified position).

##### Left
```
public static final int Left
```

Align to left.

##### Center
```
public static final int Center
```

Center alignment.

##### Right
```
public static final int Right
```

Align to right.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `HorizontalAlignment` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `HorizontalAlignment` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `HorizontalAlignment` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `HorizontalAlignment` enumeration value.

### IDocumentInfo
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/idocumentinfo.md

### PageInfo
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/pageinfo.md

**Inheritance:**
java.lang.Object
```
public final class PageInfo
```

Represents a document page description.
#### Constructors

| Constructor | Description |
| --- | --- |
| PageInfo(int pageNumber, double width, double height) |  |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets the document page height. |
| getWidth() | Gets the document page width. |
| getPageNumber() | Gets the document page number. |
##### PageInfo(int pageNumber, double width, double height)
```
public PageInfo(int pageNumber, double width, double height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |
| width | double |  |
| height | double |  |

##### getHeight()
```
public final double getHeight()
```

Gets the document page height.

**Returns:**
double - The document page height.
##### getWidth()
```
public final double getWidth()
```

Gets the document page width.

**Returns:**
double - The document page width.
##### getPageNumber()
```
public final int getPageNumber()
```

Gets the document page number.

**Returns:**
int - The document page number.

### ReadOnlyListBase
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/readonlylistbase.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IReadOnlyList
```
public abstract class ReadOnlyListBase<T> implements IReadOnlyList<T>
```

Provides the abstract base class for a strongly typed read-only list.

 T : The type of the element.
#### Methods

| Method | Description |
| --- | --- |
| getCount() | Gets the number of elements contained in the collection. |
| getInnerList() |  |
| get_Item(int index) | Gets the element at the specified index in the collection. |
| contains(T item) | Determines whether the collection contains a specific item. |
| indexOf(T item) | Determines the index of a specific item in the collection. |
| iterator() | Returns an enumerator that iterates through a collection. |
| addInternally(T item) |  |
##### getCount()
```
public int getCount()
```

Gets the number of elements contained in the collection.

**Returns:**
int - The number of elements contained in the collection.
##### getInnerList()
```
public final System.Collections.Generic.List<T> getInnerList()
```

**Returns:**
com.aspose.ms.System.Collections.Generic.List<T>
##### get_Item(int index)
```
public T get_Item(int index)
```

Gets the element at the specified index in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the element to get. Value: The element at the specified index. |

**Returns:**
T
##### contains(T item)
```
public boolean contains(T item)
```

Determines whether the collection contains a specific item.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
boolean - True if the item is found in the collection; otherwise, false.
##### indexOf(T item)
```
public int indexOf(T item)
```

Determines the index of a specific item in the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

**Returns:**
int - The index of  item  if found in the collection; otherwise, -1.
##### iterator()
```
public Iterator<T> iterator()
```

Returns an enumerator that iterates through a collection.

**Returns:**
java.util.Iterator<T> - An  IEnumerator\{T\}  object that can be used to iterate through the collection.
##### addInternally(T item)
```
public void addInternally(T item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T |  |

### RemoveOnlyListBase
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/removeonlylistbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public abstract class RemoveOnlyListBase<T> extends ReadOnlyListBase<T>
```

Provides the abstract base class for a strongly typed remove-only list.

 T : The type of the element.
#### Methods

| Method | Description |
| --- | --- |
| isReadOnly() | Gets a value indicating whether the collection is read-only. |
| clear() | Removes all items from the collection. |
| remove(T item) | Removes the first occurrence of a specific object from the collection. |
| removeAt(int index) | Removes the item at the specified index. |
| removeFromDocument(T item) |  |
##### isReadOnly()
```
public boolean isReadOnly()
```

Gets a value indicating whether the collection is read-only.

**Returns:**
boolean - Returns true if the collection is read-only; otherwise, false.
##### clear()
```
public final void clear()
```

Removes all items from the collection.

##### remove(T item)
```
public final boolean remove(T item)
```

Removes the first occurrence of a specific object from the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to remove from the collection. |

**Returns:**
boolean - True if  item  was successfully removed; otherwise false.
##### removeAt(int index)
```
public final void removeAt(int index)
```

Removes the item at the specified index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index of the item to remove. |

##### removeFromDocument(T item)
```
public void removeFromDocument(T item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | T |  |

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/unitofmeasurement.md

**Inheritance:**
java.lang.Object
```
public final class UnitOfMeasurement
```

Represents units of measurement.
#### Fields

| Field | Description |
| --- | --- |
| Pixel | Specifies that the unit of measurement is pixel. |
| Point | Specifies that the unit of measurement is point. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `UnitOfMeasurement` value. |
##### Pixel
```
public static final int Pixel
```

Specifies that the unit of measurement is pixel.

##### Point
```
public static final int Point
```

Specifies that the unit of measurement is point.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `UnitOfMeasurement` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `UnitOfMeasurement` value.

### VerticalAlignment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.common/verticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class VerticalAlignment
```

Enumeration of possible vertical alignment values.
#### Fields

| Field | Description |
| --- | --- |
| None | No alignment (use specified position). |
| Top | Align to top. |
| Center | Center alignment. |
| Bottom | Align to bottom. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `VerticalAlignment` value. |
| parse(String value) | Parses a string to a `VerticalAlignment` enumeration value. |
##### None
```
public static final int None
```

No alignment (use specified position).

##### Top
```
public static final int Top
```

Align to top.

##### Center
```
public static final int Center
```

Center alignment.

##### Bottom
```
public static final int Bottom
```

Align to bottom.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `VerticalAlignment` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `VerticalAlignment` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `VerticalAlignment` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `VerticalAlignment` enumeration value.

### com.groupdocs.watermark.contents
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents.md

#### Classes

| Class | Description |
| --- | --- |
| AsposeImageContainer |  |
| AttachmentWatermarkableImage | Represents an attached image inside a content of any supported type. |
| Content | Represents a content where a watermark can be placed. |
| ContentPart | Represents any logical part of a content (page, frame, header or a whole content) where watermark can be placed. |
| ContentsProxy |  |
| DiagramContent | Represents a Visio document. |
| DiagramFormattedTextFragment | Represents a fragment of formatted text in a Visio document. |
| DiagramFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Visio document. |
| DiagramHeaderFooter | Represents a header/footer in a Visio document. |
| DiagramHeaderFooterFont | Represents a font that is used in Visio header/footer. |
| DiagramHyperlink | Represents a hyperlink in a Visio document. |
| DiagramHyperlinkCollection | Represents a collection of hyperlinks in a Visio document. |
| DiagramPage | Represents a Visio document page. |
| DiagramPageCollection | Represents a collection of pages in a Visio document. |
| DiagramShape | Represents a drawing shape in a Visio document. |
| DiagramShapeCollection | Represents a collection of drawing shapes in a Visio document. |
| DiagramWatermarkPlacementType | Specifies to what pages a watermark should be added. |
| DiagramWatermarkableImage | Represents an image inside a Visio document. |
| EmailAddress | Represents an address of an email message. |
| EmailAddressCollection | Represents a collection of addresses in an email message. |
| EmailAttachment | Represents a file attached to an email message. |
| EmailAttachmentBase | Provides a base class for email attachments. |
| EmailAttachmentCollection | Represents a collection of attachments in an email message. |
| EmailBodyType | Represents a content type of an email message body. |
| EmailContent | Represents an email message. |
| EmailEmbeddedObject | Represents an object embedded to an email message body. |
| EmailEmbeddedObjectCollection | Represents a collection of embedded objects in an email message. |
| GifImageContent | Represents a gif image where a watermark can be placed. |
| ImageContent | Represents an image where a watermark can be placed. |
| ImageFrame | Represents an image frame where a watermark can be placed. |
| ImageFrameCollection | Represents a collection of frames in multiframe image. |
| ImageUtils |  |
| MultiframeImageContent | Represents a multiframe image where a watermark can be placed. |
| OfficeDashStyle | Represents a dashed line style. |
| OfficeHeaderFooterType | Identifies the type of header or footer. |
| OfficeImageEffects | Represents effects that can be applied to an image watermark for an office content. |
| OfficeImageFillFormat<TWatermarkableImage> | Represents the image fill format settings in any supported office content. |
| OfficeLineFormat | Represents a shape line format. |
| OfficeLineStyle | Represents the compound line style of a `OfficeLineFormat`. |
| OfficeShapeSettings | Represents settings that can be applied to a shape watermark for an office content. |
| OfficeTextEffects | Represents effects that can be applied to a text watermark for an office content. |
| PdfAnnotation | Represents an annotation in a pdf document. |
| PdfAnnotationCollection | Represents a collection of annotations in a pdf document. |
| PdfAnnotationType | Enumeration of annotation types. |
| PdfArtifact | Represents an artifact in a pdf content. |
| PdfArtifactCollection | Represents a collection of artifacts in a pdf content. |
| PdfArtifactSubtype | Enumeration of possible artifacts subtype. |
| PdfArtifactType | Enumeration of possible artifact types. |
| PdfAttachment | Represents a file attached to a pdf content. |
| PdfAttachmentCollection | Represents a collection of attachments in a pdf document. |
| PdfContent | Represents a pdf document where a watermark can be placed. |
| PdfCryptoAlgorithm | Represent type of cryptographic algorithm that used in encryption routine. |
| PdfFormattedTextFragment | Represents a fragment of formatted text in a pdf document. |
| PdfFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf document. |
| PdfImageConversionFormat | Represents image formats that can be used for pdf document pages rasterization. |
| PdfPage | Represents pdf document page. |
| PdfPageCollection | Represents a collection of pages in a pdf content. |
| PdfPageMarginType | Represents pdf crop margins to be used during watermark adding. |
| PdfPermissions | Represents user's permissions for a pdf document. |
| PdfShape | Provides base class for XObjects, Artifacts and Annotations. |
| PdfShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation. |
| PdfTextFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf content main text. |
| PdfWatermarkableImage | Represents an image inside a Pdf document. |
| PdfXForm | Represents an XForm in a pdf content. |
| PdfXImage | Represents an XImage in a pdf content. |
| PdfXObject | Represents an XObject in a pdf document. |
| PdfXObjectCollection | Represents a collection of XObjects in a pdf document. |
| PresentationBaseShape | Provides the abstract base class for shapes of all types in a PowerPoint document. |
| PresentationBaseSlide | Provides the abstract base class for slides of all types in a PowerPoint document. |
| PresentationChart | Represents a chart in a PowerPoint document. |
| PresentationChartCollection | Represents a collection of charts in a PowerPoint document. |
| PresentationContent | Represents a PowerPoint document where a watermark can be placed. |
| PresentationFormattedTextFragment | Represents a fragment of formatted text in a PowerPoint document. |
| PresentationFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a PowerPoint document. |
| PresentationHyperlinkActionType | Specifies hyperlink action type. |
| PresentationImageFillFormat | Represents the image fill format settings in a PowerPoint document. |
| PresentationLayoutSlide | Represents a PowerPoint content layout slide. |
| PresentationLayoutSlideCollection | Represents a collection of layout slides in a PowerPoint document. |
| PresentationMasterHandoutSlide | Represents a master handout slide in a PowerPoint content. |
| PresentationMasterNotesSlide | Represents a master slide for all notes slides in a PowerPoint document. |
| PresentationMasterSlide | Represents a PowerPoint document master slide. |
| PresentationMasterSlideCollection | Represents a collection of master slides in a PowerPoint document. |
| PresentationNotesSlide | Represents a PowerPoint document notes slide. |
| PresentationShape | Represents a drawing shape in a PowerPoint document. |
| PresentationShapeCollection | Represents a collection of drawing shapes in a PowerPoint document. |
| PresentationShapeSettings | Represents settings that can be applied to a shape watermark for a PowerPoint document. |
| PresentationShapeType | Represents a shape geometry preset type. |
| PresentationSlide | Represents a PowerPoint document slide. |
| PresentationSlideCollection | Represents a collection of slides in a PowerPoint document. |
| PresentationSlideImageFillFormat | Represents the image fill format settings for a slide in a PowerPoint document. |
| PresentationWatermarkableImage | Represents an image inside a PowerPoint document. |
| SpreadsheetAttachment | Represents a file attached to an Excel document. |
| SpreadsheetAttachmentCollection | Represents a collection of attachments in an Excel document. |
| SpreadsheetAutoShapeType | Represents auto shape type. |
| SpreadsheetCellFormattedTextFragment | Represents a fragment of formatted text in Excel document cell. |
| SpreadsheetCellFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document cell. |
| SpreadsheetChart | Represents a chart in an Excel document. |
| SpreadsheetChartCollection | Represents a collection of charts in an Excel document. |
| SpreadsheetContent | Represents an Excel document where a watermark can be placed. |
| SpreadsheetHeaderFooter | Represents a header/footer in an Excel document. |
| SpreadsheetHeaderFooterCollection | Represents a collection of headers and footers in an Excel document. |
| SpreadsheetHeaderFooterSection | Represents a header/footer section in an Excel document. |
| SpreadsheetHeaderFooterSectionCollection | Represents a collection of header/footer sections. |
| SpreadsheetHeaderFooterSectionType | Represents header/footer section in Excel document. |
| SpreadsheetImageFillFormat | Represents the image fill format settings in an Excel document. |
| SpreadsheetMsoDrawingType | Represents office drawing object type. |
| SpreadsheetPageSetup | Represents printing page properties for a worksheet. |
| SpreadsheetShape | Represents a drawing shape in an Excel document. |
| SpreadsheetShapeCollection | Represents a collection of drawing shapes in an Excel document. |
| SpreadsheetShapeFormattedTextFragment | Represents a fragment of formatted text in Excel document shape. |
| SpreadsheetShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document text shape. |
| SpreadsheetTextEffectFormattedTextFragment | Represents a fragment of formatted text in Excel document WordArt shape. |
| SpreadsheetTextEffectFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document WordArt shape. |
| SpreadsheetWatermarkableImage | Represents an image inside an Excel document. |
| SpreadsheetWorksheet | Represents an Excel document worksheet. |
| SpreadsheetWorksheetCollection | Represents a collection of worksheets in an Excel document. |
| TiffImageContent | Represents a tiff image where a watermark can be placed. |
| WatermarkableImage | Represents an image inside a document. |
| WatermarkableImageCollection | Represents a collection of images found in a document. |
| WordProcessingContent | Class representing Word document (doc, docx etc) where watermark should be placed. |
| WordProcessingFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document. |
| WordProcessingHeaderFooter | Represents a header/footer in a Word document. |
| WordProcessingHeaderFooterCollection | Represents a collection of headers and footers in a Word document. |
| WordProcessingHorizontalAlignment | Specifies horizontal alignment of a floating object. |
| WordProcessingPageSetup | Represents printing page properties for a section of a Word document. |
| WordProcessingPageSplitter |  |
| WordProcessingProtectionType | Represents protection type for a Word document. |
| WordProcessingRelativeHorizontalPosition | Specifies to what the horizontal position of an object is relative. |
| WordProcessingRelativeVerticalPosition | Specifies to what the vertical position of an object is relative. |
| WordProcessingSection | Represents a Word document section. |
| WordProcessingSectionCollection | Represents a collection of sections in a Word document. |
| WordProcessingShape | Represents a drawing shape in a Word document. |
| WordProcessingShapeCollection | Represents a collection of shapes in a Word document. |
| WordProcessingShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document shape. |
| WordProcessingShapeType | Represents the type of a shape in a Word document. |
| WordProcessingTextFormattedTextFragment | Represents a fragment of formatted text in a Word document. |
| WordProcessingTextFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document main text. |
| WordProcessingUtils |  |
| WordProcessingVerticalAlignment | Specifies vertical alignment of a floating object. |
| WordProcessingWatermarkableImage | Represents an image inside a Word document. |
| WordProcessingWordArtShapeFormattedTextFragment | Represents a fragment of formatted text in a WordArt shape. |
| WordProcessingWordArtShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document WordArt shape. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IPresentationHyperlinkContainer | Represents PowerPoint document object that contains a hyperlink. |

### AsposeImageContainer
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/asposeimagecontainer.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class AsposeImageContainer extends ContentPart
```
#### Constructors

| Constructor | Description |
| --- | --- |
| AsposeImageContainer(byte[] data) |  |
| AsposeImageContainer(System.IO.Stream stream) |  |
| AsposeImageContainer(Image image) |  |
| AsposeImageContainer(int width, int height) |  |
| AsposeImageContainer(String filePath) |  |
#### Methods

| Method | Description |
| --- | --- |
| getAsposeImage() |  |
| replaceImage(Image newImage) |  |
| getStreamContainer() |  |
| getAsTiffImage() |  |
| getAsTiffFrame() |  |
| isTiffImage() |  |
| isTiffFrame() |  |
| getAsGifImage() |  |
| isGifImage() |  |
| isJpegImage() |  |
| isBmpImage() |  |
| isEmfImage() |  |
| getAsRasterImage() |  |
| getWidth() |  |
| getHeight() |  |
| getDisposed() |  |
| dispose() | Disposes the current instance. |
| getFileFormat(System.IO.Stream stream) |  |
| getFileFormat(byte[] imageData) |  |
| checkWatermarkingLicenseRestrictions(Watermark watermark) |  |
| save() |  |
| save(String filePath, boolean overwrite) |  |
| save(OutputStream stream) |  |
| convert(ImageOptionsBase options) |  |
##### AsposeImageContainer(byte[] data)
```
public AsposeImageContainer(byte[] data)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| data | byte[] |  |

##### AsposeImageContainer(System.IO.Stream stream)
```
public AsposeImageContainer(System.IO.Stream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

##### AsposeImageContainer(Image image)
```
public AsposeImageContainer(Image image)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| image | com.aspose.imaging.Image |  |

##### AsposeImageContainer(int width, int height)
```
public AsposeImageContainer(int width, int height)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| width | int |  |
| height | int |  |

##### AsposeImageContainer(String filePath)
```
public AsposeImageContainer(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### getAsposeImage()
```
public final Image getAsposeImage()
```

**Returns:**
com.aspose.imaging.Image
##### replaceImage(Image newImage)
```
public final void replaceImage(Image newImage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| newImage | com.aspose.imaging.Image |  |

##### getStreamContainer()
```
public final StreamContainer getStreamContainer()
```

**Returns:**
StreamContainer
##### getAsTiffImage()
```
public final TiffImage getAsTiffImage()
```

**Returns:**
com.aspose.imaging.fileformats.tiff.TiffImage
##### getAsTiffFrame()
```
public final TiffFrame getAsTiffFrame()
```

**Returns:**
com.aspose.imaging.fileformats.tiff.TiffFrame
##### isTiffImage()
```
public final boolean isTiffImage()
```

**Returns:**
boolean
##### isTiffFrame()
```
public final boolean isTiffFrame()
```

**Returns:**
boolean
##### getAsGifImage()
```
public final GifImage getAsGifImage()
```

**Returns:**
com.aspose.imaging.fileformats.gif.GifImage
##### isGifImage()
```
public final boolean isGifImage()
```

**Returns:**
boolean
##### isJpegImage()
```
public final boolean isJpegImage()
```

**Returns:**
boolean
##### isBmpImage()
```
public final boolean isBmpImage()
```

**Returns:**
boolean
##### isEmfImage()
```
public final boolean isEmfImage()
```

**Returns:**
boolean
##### getAsRasterImage()
```
public final RasterImage getAsRasterImage()
```

**Returns:**
com.aspose.imaging.RasterImage
##### getWidth()
```
public final int getWidth()
```

**Returns:**
int
##### getHeight()
```
public final int getHeight()
```

**Returns:**
int
##### getDisposed()
```
public final boolean getDisposed()
```

**Returns:**
boolean
##### dispose()
```
public final void dispose()
```

Disposes the current instance.

##### getFileFormat(System.IO.Stream stream)
```
public static long getFileFormat(System.IO.Stream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

**Returns:**
long
##### getFileFormat(byte[] imageData)
```
public static long getFileFormat(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

**Returns:**
long
##### checkWatermarkingLicenseRestrictions(Watermark watermark)
```
public void checkWatermarkingLicenseRestrictions(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### save()
```
public final void save()
```

##### save(String filePath, boolean overwrite)
```
public final void save(String filePath, boolean overwrite)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| overwrite | boolean |  |

##### save(OutputStream stream)
```
public final void save(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### convert(ImageOptionsBase options)
```
public final AsposeImageContainer convert(ImageOptionsBase options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | com.aspose.imaging.ImageOptionsBase |  |

**Returns:**
AsposeImageContainer

### AttachmentWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/attachmentwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class AttachmentWatermarkableImage extends WatermarkableImage
```

Represents an attached image inside a content of any supported type.
#### Constructors

| Constructor | Description |
| --- | --- |
| AttachmentWatermarkableImage(Content content, Attachment attachment) |  |
##### AttachmentWatermarkableImage(Content content, Attachment attachment)
```
public AttachmentWatermarkableImage(Content content, Attachment attachment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | Content |  |
| attachment | Attachment |  |

### Content
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/content.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart

**All Implemented Interfaces:**
java.io.Closeable
```
public abstract class Content extends ContentPart implements Closeable
```

Represents a content where a watermark can be placed.
#### Constructors

| Constructor | Description |
| --- | --- |
| Content(StreamContainer stream, IStrategyManager strategyManager, LoadOptions loadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWatermarkerSettings() |  |
| getDocumentInfo() |  |
| getFileType() |  |
| getSearchableObjects() |  |
| setSearchableObjects(SearchableObjects value) |  |
| getStream() |  |
| save(String filePath) |  |
| save(String filePath, SaveOptions saveOptions) |  |
| save(OutputStream stream) |  |
| save(OutputStream stream, SaveOptions saveOptions) |  |
| dispose() |  |
| performSave(String filePath) |  |
| performSave(OutputStream stream) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| registerDisposableResource(System.IDisposable resource) |  |
| getInfo(String filePath) |  |
| getInfo(System.IO.Stream stream) |  |
| close() | Disposes the current instance. |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### Content(StreamContainer stream, IStrategyManager strategyManager, LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)
```
public Content(StreamContainer stream, IStrategyManager strategyManager, LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | IStrategyManager |  |
| loadOptions | LoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getWatermarkerSettings()
```
public final WatermarkerSettings getWatermarkerSettings()
```

**Returns:**
WatermarkerSettings
##### getDocumentInfo()
```
public abstract IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public abstract FileType getFileType()
```

**Returns:**
FileType
##### getSearchableObjects()
```
public final SearchableObjects getSearchableObjects()
```

**Returns:**
SearchableObjects
##### setSearchableObjects(SearchableObjects value)
```
public final void setSearchableObjects(SearchableObjects value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SearchableObjects |  |

##### getStream()
```
public final StreamContainer getStream()
```

**Returns:**
StreamContainer
##### save(String filePath)
```
public final void save(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### save(String filePath, SaveOptions saveOptions)
```
public final void save(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### save(OutputStream stream)
```
public final void save(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### save(OutputStream stream, SaveOptions saveOptions)
```
public final void save(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### dispose()
```
public final void dispose()
```

##### performSave(String filePath)
```
public abstract void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(OutputStream stream)
```
public abstract void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public abstract void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public abstract void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### registerDisposableResource(System.IDisposable resource)
```
public final void registerDisposableResource(System.IDisposable resource)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| resource | com.aspose.ms.System.IDisposable |  |

##### getInfo(String filePath)
```
public static InfoInternal getInfo(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

**Returns:**
InfoInternal
##### getInfo(System.IO.Stream stream)
```
public static InfoInternal getInfo(System.IO.Stream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

**Returns:**
InfoInternal
##### close()
```
public final void close()
```

Disposes the current instance.

##### add(Watermark watermark, WatermarkOptions options)
```
public abstract void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public abstract void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### ContentPart
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/contentpart.md

**Inheritance:**
java.lang.Object
```
public abstract class ContentPart
```

Represents any logical part of a content (page, frame, header or a whole content) where watermark can be placed.
#### Methods

| Method | Description |
| --- | --- |
| getParts() |  |
| setParts(IReadOnlyList<? extends ContentPart> value) |  |
| getSearchWatermarksInParts() |  |
| getStrategyManager() |  |
| findImages(ImageSearchCriteria searchCriteria) | Finds images according to the specified search criteria. |
| findImages() | Finds all images in the content. |
| search(SearchCriteria searchCriteria) | Finds possible watermarks according to specified search criteria. |
| search() | Finds all possible watermarks in the content. |
| addWatermark(Watermark watermark) |  |
| afterWatermarkAdding() |  |
| checkWatermarkingLicenseRestrictions(Watermark watermark) |  |
| getTopParent() |  |
| tryGetWatermarkerSettings() |  |
##### getParts()
```
public final IReadOnlyList<? extends ContentPart> getParts()
```

**Returns:**
IReadOnlyList
##### setParts(IReadOnlyList<? extends ContentPart> value)
```
public final void setParts(IReadOnlyList<? extends ContentPart> value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.groupdocs.watermark.internal.IReadOnlyList<? extends com.groupdocs.watermark.contents.ContentPart> |  |

##### getSearchWatermarksInParts()
```
public boolean getSearchWatermarksInParts()
```

**Returns:**
boolean
##### getStrategyManager()
```
public final IStrategyManager getStrategyManager()
```

**Returns:**
IStrategyManager
##### findImages(ImageSearchCriteria searchCriteria)
```
public final WatermarkableImageCollection findImages(ImageSearchCriteria searchCriteria)
```

Finds images according to the specified search criteria.

The search is conducted in the objects specified in `Watermarker.getSearchableObjects()`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | ImageSearchCriteria | The search criteria to use. |

**Returns:**
WatermarkableImageCollection - The collection of the found images.
##### findImages()
```
public final WatermarkableImageCollection findImages()
```

Finds all images in the content.

The search is conducted in the objects specified in `Watermarker.getSearchableObjects()`.

**Returns:**
WatermarkableImageCollection - The collection of the found images.
##### search(SearchCriteria searchCriteria)
```
public final PossibleWatermarkCollection search(SearchCriteria searchCriteria)
```

Finds possible watermarks according to specified search criteria.

The search is conducted in the objects specified in `Watermarker.getSearchableObjects()`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | SearchCriteria | The search criteria to use. |

**Returns:**
PossibleWatermarkCollection - The collection of the possible watermarks.
##### search()
```
public final PossibleWatermarkCollection search()
```

Finds all possible watermarks in the content.

The search is conducted in the objects specified in `Watermarker.getSearchableObjects()`.

**Returns:**
PossibleWatermarkCollection - The collection of the possible watermarks.
##### addWatermark(Watermark watermark)
```
public void addWatermark(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### afterWatermarkAdding()
```
public void afterWatermarkAdding()
```

##### checkWatermarkingLicenseRestrictions(Watermark watermark)
```
public void checkWatermarkingLicenseRestrictions(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### getTopParent()
```
public final Content getTopParent()
```

**Returns:**
Content
##### tryGetWatermarkerSettings()
```
public final WatermarkerSettings tryGetWatermarkerSettings()
```

**Returns:**
WatermarkerSettings

### ContentsProxy
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/contentsproxy.md

**Inheritance:**
java.lang.Object
```
public class ContentsProxy
```
#### Constructors

| Constructor | Description |
| --- | --- |
| ContentsProxy() |  |
#### Methods

| Method | Description |
| --- | --- |
| watermarkableImageLoadImage(WatermarkableImage watermarkableImage) |  |
| watermarkableImageSaveImage(WatermarkableImage watermarkableImage, byte[] data) |  |
##### ContentsProxy()
```
public ContentsProxy()
```

##### watermarkableImageLoadImage(WatermarkableImage watermarkableImage)
```
public static byte[] watermarkableImageLoadImage(WatermarkableImage watermarkableImage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermarkableImage | WatermarkableImage |  |

**Returns:**
byte[]
##### watermarkableImageSaveImage(WatermarkableImage watermarkableImage, byte[] data)
```
public static void watermarkableImageSaveImage(WatermarkableImage watermarkableImage, byte[] data)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermarkableImage | WatermarkableImage |  |
| data | byte[] |  |

### DiagramContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content
```
public final class DiagramContent extends Content
```

Represents a Visio document.

**Learn more:**

 *  [Add watermarks to diagram documents][]
 *  [Existing objects in diagram document][]

[Add watermarks to diagram documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+diagram+documents
[Existing objects in diagram document]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+diagram+document
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo formatInfo, DiagramLoadOptions diagramLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Gets the collection of all pages of this `DiagramContent`. |
| getHeaderFooter() | Gets the header and footer of this `DiagramContent`. |
| getAsposeDiagram() |  |
| addWatermark(Watermark watermark, int watermarkPlacementType, DiagramShapeSettings shapeSettings) |  |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
| afterWatermarkAdding() |  |
| getDocumentInfo() |  |
| getFileType() |  |
| getFontIdByName(String fontName) |  |
| addFont(String fontName) |  |
| isNewFormat() |  |
##### DiagramContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo formatInfo, DiagramLoadOptions diagramLoadOptions, WatermarkerSettings watermarkerSettings)
```
public DiagramContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo formatInfo, DiagramLoadOptions diagramLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| formatInfo | com.aspose.diagram.FileFormatInfo |  |
| diagramLoadOptions | DiagramLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getPages()
```
public final DiagramPageCollection getPages()
```

Gets the collection of all pages of this `DiagramContent`.

**Returns:**
DiagramPageCollection - The collection of all pages of this `DiagramContent.`
##### getHeaderFooter()
```
public final DiagramHeaderFooter getHeaderFooter()
```

Gets the header and footer of this `DiagramContent`.

**Returns:**
DiagramHeaderFooter - The header and footer of this `DiagramContent.`
##### getAsposeDiagram()
```
public final Diagram getAsposeDiagram()
```

**Returns:**
com.aspose.diagram.Diagram
##### addWatermark(Watermark watermark, int watermarkPlacementType, DiagramShapeSettings shapeSettings)
```
public final void addWatermark(Watermark watermark, int watermarkPlacementType, DiagramShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| watermarkPlacementType | int |  |
| shapeSettings | DiagramShapeSettings |  |

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

##### afterWatermarkAdding()
```
public void afterWatermarkAdding()
```

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### getFontIdByName(String fontName)
```
public final int getFontIdByName(String fontName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontName | java.lang.String |  |

**Returns:**
int
##### addFont(String fontName)
```
public final int addFont(String fontName)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontName | java.lang.String |  |

**Returns:**
int
##### isNewFormat()
```
public final boolean isNewFormat()
```

**Returns:**
boolean

### DiagramFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class DiagramFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in a Visio document.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### DiagramFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class DiagramFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a Visio document.

This collection contains items of `DiagramFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### DiagramHeaderFooter
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramheaderfooter.md

**Inheritance:**
java.lang.Object
```
public class DiagramHeaderFooter
```

Represents a header/footer in a Visio document.
#### Methods

| Method | Description |
| --- | --- |
| getHeaderLeft() | Gets the text string that appears in the left portion of document header. |
| setHeaderLeft(String value) | Sets the text string that appears in the left portion of document header. |
| getHeaderCenter() | Gets the text string that appears in the center portion of document header. |
| setHeaderCenter(String value) | Sets the text string that appears in the center portion of document header. |
| getHeaderRight() | Gets the text string that appears in the right portion of document header. |
| setHeaderRight(String value) | Sets the text string that appears in the right portion of document header. |
| getFooterLeft() | Gets the text string that appears in the left portion of document footer. |
| setFooterLeft(String value) | Sets the text string that appears in the left portion of document footer. |
| getFooterCenter() | Gets the text string that appears in the center portion of document footer. |
| setFooterCenter(String value) | Sets the text string that appears in the center portion of document footer. |
| getFooterRight() | Gets the text string that appears in the right portion of document footer. |
| setFooterRight(String value) | Sets the text string that appears in the right portion of document footer. |
| getHeaderMargin() | Gets the margin of document header. |
| setHeaderMargin(double value) | Sets the margin of document header. |
| getFooterMargin() | Gets the margin of document header. |
| setFooterMargin(double value) | Sets the margin of document header. |
| getTextColor() | Gets the text color for header and footer. |
| setTextColor(Color value) | Sets the text color for header and footer. |
| getFont() | Gets the font used for header and footer text. |
| getByDiagramHeaderFooterType(int headerFooterType) |  |
| setByDiagramHeaderFooterType(int headerFooterType, String value) |  |
##### getHeaderLeft()
```
public final String getHeaderLeft()
```

Gets the text string that appears in the left portion of document header.

**Returns:**
java.lang.String - The text string that appears in the left portion of document header.
##### setHeaderLeft(String value)
```
public final void setHeaderLeft(String value)
```

Sets the text string that appears in the left portion of document header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the left portion of document header. |

##### getHeaderCenter()
```
public final String getHeaderCenter()
```

Gets the text string that appears in the center portion of document header.

**Returns:**
java.lang.String - The text string that appears in the center portion of document header.
##### setHeaderCenter(String value)
```
public final void setHeaderCenter(String value)
```

Sets the text string that appears in the center portion of document header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the center portion of document header. |

##### getHeaderRight()
```
public final String getHeaderRight()
```

Gets the text string that appears in the right portion of document header.

**Returns:**
java.lang.String - The text string that appears in the right portion of document header.
##### setHeaderRight(String value)
```
public final void setHeaderRight(String value)
```

Sets the text string that appears in the right portion of document header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the right portion of document header. |

##### getFooterLeft()
```
public final String getFooterLeft()
```

Gets the text string that appears in the left portion of document footer.

**Returns:**
java.lang.String - The text string that appears in the left portion of document footer.
##### setFooterLeft(String value)
```
public final void setFooterLeft(String value)
```

Sets the text string that appears in the left portion of document footer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the left portion of document footer. |

##### getFooterCenter()
```
public final String getFooterCenter()
```

Gets the text string that appears in the center portion of document footer.

**Returns:**
java.lang.String - The text string that appears in the center portion of document footer.
##### setFooterCenter(String value)
```
public final void setFooterCenter(String value)
```

Sets the text string that appears in the center portion of document footer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the center portion of document footer. |

##### getFooterRight()
```
public final String getFooterRight()
```

Gets the text string that appears in the right portion of document footer.

**Returns:**
java.lang.String - The text string that appears in the right portion of document footer.
##### setFooterRight(String value)
```
public final void setFooterRight(String value)
```

Sets the text string that appears in the right portion of document footer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text string that appears in the right portion of document footer. |

##### getHeaderMargin()
```
public final double getHeaderMargin()
```

Gets the margin of document header.

**Returns:**
double - The margin of document header.
##### setHeaderMargin(double value)
```
public final void setHeaderMargin(double value)
```

Sets the margin of document header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The margin of document header. |

##### getFooterMargin()
```
public final double getFooterMargin()
```

Gets the margin of document header.

**Returns:**
double - The margin of document header.
##### setFooterMargin(double value)
```
public final void setFooterMargin(double value)
```

Sets the margin of document header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The margin of document header. |

##### getTextColor()
```
public final Color getTextColor()
```

Gets the text color for header and footer.

**Returns:**
Color - The text color for header and footer.
##### setTextColor(Color value)
```
public final void setTextColor(Color value)
```

Sets the text color for header and footer.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | The text color for header and footer. |

##### getFont()
```
public final DiagramHeaderFooterFont getFont()
```

Gets the font used for header and footer text.

**Returns:**
DiagramHeaderFooterFont - The font used for header and footer text.
##### getByDiagramHeaderFooterType(int headerFooterType)
```
public final String getByDiagramHeaderFooterType(int headerFooterType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterType | int |  |

**Returns:**
java.lang.String
##### setByDiagramHeaderFooterType(int headerFooterType, String value)
```
public final void setByDiagramHeaderFooterType(int headerFooterType, String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterType | int |  |
| value | java.lang.String |  |

### DiagramHeaderFooterFont
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramheaderfooterfont.md

**Inheritance:**
java.lang.Object
```
public class DiagramHeaderFooterFont
```

Represents a font that is used in Visio header/footer.
#### Methods

| Method | Description |
| --- | --- |
| getFamilyName() | Gets the font family name. |
| setFamilyName(String value) | Sets the font family name. |
| getSize() | Gets the height of the font. |
| setSize(int value) | Sets the height of the font. |
| getItalic() | Gets a value indicating whether the font is italic. |
| setItalic(boolean value) | Sets a value indicating whether the font is italic. |
| getUnderline() | Gets a value indicating whether the font is underline. |
| setUnderline(boolean value) | Sets a value indicating whether the font is underline. |
| getStrikeout() | Gets a value indicating whether the font is strikeout. |
| setStrikeout(boolean value) | Sets a value indicating whether the font is strikeout. |
| getBold() | Gets a value indicating whether the font is bold. |
| setBold(boolean value) | Sets a value indicating whether the font is bold. |
##### getFamilyName()
```
public final String getFamilyName()
```

Gets the font family name.

**Returns:**
java.lang.String - The font family name.
##### setFamilyName(String value)
```
public final void setFamilyName(String value)
```

Sets the font family name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The font family name. |

##### getSize()
```
public final int getSize()
```

Gets the height of the font.

**Returns:**
int - The height of the font.
##### setSize(int value)
```
public final void setSize(int value)
```

Sets the height of the font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The height of the font. |

##### getItalic()
```
public final boolean getItalic()
```

Gets a value indicating whether the font is italic.

**Returns:**
boolean - True if this font is italic; otherwise, false.
##### setItalic(boolean value)
```
public final void setItalic(boolean value)
```

Sets a value indicating whether the font is italic.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if this font is italic; otherwise, false. |

##### getUnderline()
```
public final boolean getUnderline()
```

Gets a value indicating whether the font is underline.

**Returns:**
boolean - True if this font is underline; otherwise, false.
##### setUnderline(boolean value)
```
public final void setUnderline(boolean value)
```

Sets a value indicating whether the font is underline.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if this font is underline; otherwise, false. |

##### getStrikeout()
```
public final boolean getStrikeout()
```

Gets a value indicating whether the font is strikeout.

**Returns:**
boolean - True if this font is strikeout; otherwise, false.
##### setStrikeout(boolean value)
```
public final void setStrikeout(boolean value)
```

Sets a value indicating whether the font is strikeout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if this font is strikeout; otherwise, false. |

##### getBold()
```
public final boolean getBold()
```

Gets a value indicating whether the font is bold.

**Returns:**
boolean - True if this font is bold; otherwise, false.
##### setBold(boolean value)
```
public final void setBold(boolean value)
```

Sets a value indicating whether the font is bold.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if this font is bold; otherwise, false. |

### DiagramHyperlink
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramhyperlink.md

**Inheritance:**
java.lang.Object
```
public class DiagramHyperlink
```

Represents a hyperlink in a Visio document.
#### Methods

| Method | Description |
| --- | --- |
| getAddress() | Gets the hyperlink address. |
| getSubAddress() | Gets a location within the target content to link to. |
| getDescription() | Gets the description of the hyperlink. |
##### getAddress()
```
public final String getAddress()
```

Gets the hyperlink address.

**Returns:**
java.lang.String - The hyperlink address.
##### getSubAddress()
```
public final String getSubAddress()
```

Gets a location within the target content to link to.

**Returns:**
java.lang.String - A location within the target content to link to.
##### getDescription()
```
public final String getDescription()
```

Gets the description of the hyperlink.

**Returns:**
java.lang.String - The description of the hyperlink.

### DiagramHyperlinkCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramhyperlinkcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class DiagramHyperlinkCollection extends RemoveOnlyListBase<DiagramHyperlink>
```

Represents a collection of hyperlinks in a Visio document.

This collection contains items of `DiagramHyperlink` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(DiagramHyperlink item) |  |
##### removeFromDocument(DiagramHyperlink item)
```
public void removeFromDocument(DiagramHyperlink item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | DiagramHyperlink |  |

### DiagramPage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagrampage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class DiagramPage extends ContentPart
```

Represents a Visio document page.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() |  |
| getShapes() | Gets the collection of all shapes of the page. |
| isBackground() | Gets a value indicating whether the page is a background page. |
| getBackgroundPage() | Gets the background page for this . |
| getWidth() | Gets the width of this  in points. |
| getHeight() | Gets the height of this  in points. |
| getTopMargin() | Gets the size of the top margin in points. |
| getRightMargin() | Gets the size of the right margin in points. |
| getBottomMargin() | Gets the size of the bottom margin in points. |
| getLeftMargin() | Gets the size of the left margin in points. |
| isVisible() | Gets a value indicating whether the page is visible in UI. |
| setVisible(boolean value) | Sets a value indicating whether the page is visible in UI. |
| getName() | Gets the name of this  DiagramPage . |
| getAsposeDiagramPage() |  |
| getContent() |  |
| getPageToDrawingScale() |  |
| addWatermark(Watermark watermark, DiagramShapeSettings shapeSettings) |  |
| convertValueFromDrawingScaleToPageScale(DoubleValue value) |  |
##### getPageNumber()
```
public Integer getPageNumber()
```

**Returns:**
java.lang.Integer
##### getShapes()
```
public final DiagramShapeCollection getShapes()
```

Gets the collection of all shapes of the page.

**Returns:**
DiagramShapeCollection - The collection of all shapes of the page.
##### isBackground()
```
public final boolean isBackground()
```

Gets a value indicating whether the page is a background page.

**Returns:**
boolean - True if the page is a background page; otherwise, false.
##### getBackgroundPage()
```
public final DiagramPage getBackgroundPage()
```

Gets the background page for this .

**Returns:**
DiagramPage - The background page for this .
##### getWidth()
```
public final double getWidth()
```

Gets the width of this  in points.

**Returns:**
double - The width of this  in points.
##### getHeight()
```
public final double getHeight()
```

Gets the height of this  in points.

**Returns:**
double - The height of this  in points.
##### getTopMargin()
```
public final double getTopMargin()
```

Gets the size of the top margin in points.

**Returns:**
double - The size of the top margin in points.
##### getRightMargin()
```
public final double getRightMargin()
```

Gets the size of the right margin in points.

**Returns:**
double - The size of the right margin in points.
##### getBottomMargin()
```
public final double getBottomMargin()
```

Gets the size of the bottom margin in points.

**Returns:**
double - The size of the bottom margin in points.
##### getLeftMargin()
```
public final double getLeftMargin()
```

Gets the size of the left margin in points.

**Returns:**
double - The size of the left margin in points.
##### isVisible()
```
public final boolean isVisible()
```

Gets a value indicating whether the page is visible in UI.

**Returns:**
boolean - The value indicating whether the page is visible in UI. True if the page is visible; otherwise, false.
##### setVisible(boolean value)
```
public final void setVisible(boolean value)
```

Sets a value indicating whether the page is visible in UI.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value indicating whether the page is visible in UI. True if the page is visible; otherwise, false. |

##### getName()
```
public final String getName()
```

Gets the name of this  DiagramPage .

**Returns:**
java.lang.String - The name of this  DiagramPage .
##### getAsposeDiagramPage()
```
public final Page getAsposeDiagramPage()
```

**Returns:**
com.aspose.diagram.Page
##### getContent()
```
public final DiagramContent getContent()
```

**Returns:**
DiagramContent
##### getPageToDrawingScale()
```
public final double getPageToDrawingScale()
```

**Returns:**
double
##### addWatermark(Watermark watermark, DiagramShapeSettings shapeSettings)
```
public final void addWatermark(Watermark watermark, DiagramShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | DiagramShapeSettings |  |

##### convertValueFromDrawingScaleToPageScale(DoubleValue value)
```
public final double convertValueFromDrawingScaleToPageScale(DoubleValue value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.diagram.DoubleValue |  |

**Returns:**
double

### DiagramPageCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagrampagecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class DiagramPageCollection extends ReadOnlyListBase<DiagramPage>
```

Represents a collection of pages in a Visio document.

This collection contains the items of `DiagramPage` type.
#### Methods

| Method | Description |
| --- | --- |
| findPage(Page asposePage) |  |
##### findPage(Page asposePage)
```
public final DiagramPage findPage(Page asposePage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| asposePage | com.aspose.diagram.Page |  |

**Returns:**
DiagramPage

### DiagramShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IRotatableTwoDObject
```
public class DiagramShape extends ShapeSearchAdapter implements IRotatableTwoDObject
```

Represents a drawing shape in a Visio document.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() |  |
| getPage() | Gets the parent page of this `DiagramShape`. |
| getWidth() | Gets the width of this `DiagramShape` in points. |
| setWidth(double value) | Sets the width of this `DiagramShape` in points. |
| getHeight() | Gets the height of this `DiagramShape` in points. |
| setHeight(double value) | Sets the height of this `DiagramShape` in points. |
| getX() | Gets the horizontal offset of this `DiagramShape` from page left border in points. |
| setX(double value) | Sets the horizontal offset of this `DiagramShape` from page left border in points. |
| getY() | Gets the vertical offset of this `DiagramShape` from page bottom border in points. |
| setY(double value) | Sets the vertical offset of this `DiagramShape` from page bottom border in points. |
| getRotateAngle() | Gets or sets the rotate angle of this `DiagramShape` in degrees. |
| setRotateAngle(double value) | Gets or sets the rotate angle of this `DiagramShape` in degrees. |
| getText() | Gets or sets the text of this `DiagramShape`. |
| setText(String value) | Gets or sets the text of this `DiagramShape`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `DiagramShape`. |
| getImage() | Gets the image of this `DiagramShape`. |
| setImage(DiagramWatermarkableImage value) | Sets the image of this `DiagramShape`. |
| getId() | Gets the identifier of this `DiagramShape`. |
| getName() | Gets the name of this `DiagramShape`. |
| getHyperlinks() | Gets the collection of hyperlinks attached to this `DiagramShape`. |
| getAsposeShape() |  |
| getFormattedTextFragmentsForSearch() |  |
| getImageForSearch() |  |
| setFoundWatermarkImage(byte[] imageData) |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
##### getPageNumber()
```
public Integer getPageNumber()
```

**Returns:**
java.lang.Integer
##### getPage()
```
public final DiagramPage getPage()
```

Gets the parent page of this `DiagramShape`.

**Returns:**
DiagramPage - The parent page of this `DiagramShape`.
##### getWidth()
```
public final double getWidth()
```

Gets the width of this `DiagramShape` in points.

**Returns:**
double - The width of this `DiagramShape` in points.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the width of this `DiagramShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of this `DiagramShape` in points. |

##### getHeight()
```
public final double getHeight()
```

Gets the height of this `DiagramShape` in points.

**Returns:**
double - The height of this `DiagramShape` in points.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the height of this `DiagramShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of this `DiagramShape` in points. |

##### getX()
```
public final double getX()
```

Gets the horizontal offset of this `DiagramShape` from page left border in points.

**Returns:**
double - The horizontal offset of this `DiagramShape` from page left border in points.
##### setX(double value)
```
public final void setX(double value)
```

Sets the horizontal offset of this `DiagramShape` from page left border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The horizontal offset of this `DiagramShape` from page left border in points. |

##### getY()
```
public final double getY()
```

Gets the vertical offset of this `DiagramShape` from page bottom border in points.

**Returns:**
double - The vertical offset of this `DiagramShape` from page bottom border in points.
##### setY(double value)
```
public final void setY(double value)
```

Sets the vertical offset of this `DiagramShape` from page bottom border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The vertical offset of this `DiagramShape` from page bottom border in points. |

##### getRotateAngle()
```
public final double getRotateAngle()
```

Gets or sets the rotate angle of this `DiagramShape` in degrees.

**Returns:**
double - The rotate angle of this `DiagramShape` in degrees.
##### setRotateAngle(double value)
```
public final void setRotateAngle(double value)
```

Gets or sets the rotate angle of this `DiagramShape` in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rotate angle of this `DiagramShape` in degrees. |

##### getText()
```
public final String getText()
```

Gets or sets the text of this `DiagramShape`.

**Returns:**
java.lang.String - The text of this `DiagramShape`.
##### setText(String value)
```
public final void setText(String value)
```

Gets or sets the text of this `DiagramShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `DiagramShape`. |

##### getFormattedTextFragments()
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `DiagramShape`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `DiagramShape`.
##### getImage()
```
public final DiagramWatermarkableImage getImage()
```

Gets the image of this `DiagramShape`.

**Returns:**
DiagramWatermarkableImage - The image of this `DiagramShape`.
##### setImage(DiagramWatermarkableImage value)
```
public final void setImage(DiagramWatermarkableImage value)
```

Sets the image of this `DiagramShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | DiagramWatermarkableImage | The image of this `DiagramShape`. |

##### getId()
```
public final long getId()
```

Gets the identifier of this `DiagramShape`.

**Returns:**
long - The identifier of this `DiagramShape`.
##### getName()
```
public final String getName()
```

Gets the name of this `DiagramShape`.

**Returns:**
java.lang.String - The name of this `DiagramShape`.
##### getHyperlinks()
```
public final DiagramHyperlinkCollection getHyperlinks()
```

Gets the collection of hyperlinks attached to this `DiagramShape`.

**Returns:**
DiagramHyperlinkCollection - The collection of hyperlinks attached to this `DiagramShape`.
##### getAsposeShape()
```
public final Shape getAsposeShape()
```

**Returns:**
com.aspose.diagram.Shape
##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### DiagramShapeCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramshapecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class DiagramShapeCollection extends RemoveOnlyListBase<DiagramShape>
```

Represents a collection of drawing shapes in a Visio document.

This collection contains the items of `DiagramShape` type.
#### Methods

| Method | Description |
| --- | --- |
| addShape(Shape shape) |  |
| removeFromDocument(DiagramShape item) |  |
##### addShape(Shape shape)
```
public final void addShape(Shape shape)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | com.aspose.diagram.Shape |  |

##### removeFromDocument(DiagramShape item)
```
public void removeFromDocument(DiagramShape item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | DiagramShape |  |

### DiagramWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class DiagramWatermarkableImage extends WatermarkableImage
```

Represents an image inside a Visio document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramWatermarkableImage(byte[] imageData) | Initializes a new instance of the `DiagramWatermarkableImage` class using specified image data. |
##### DiagramWatermarkableImage(byte[] imageData)
```
public DiagramWatermarkableImage(byte[] imageData)
```

Initializes a new instance of the `DiagramWatermarkableImage` class using specified image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] | The array of unsigned bytes from which to create the `DiagramWatermarkableImage`. |

### DiagramWatermarkPlacementType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/diagramwatermarkplacementtype.md

**Inheritance:**
java.lang.Object
```
public final class DiagramWatermarkPlacementType
```

Specifies to what pages a watermark should be added.
#### Fields

| Field | Description |
| --- | --- |
| ForegroundPages | A watermark should be added to foreground pages only. |
| BackgroundPages | A watermark should be added to background pages only. |
| AllPages | A watermark should be added to all pages. |
| SeparateBackgrounds | Separate background pages with a watermark should be created and assigned to all pages without background. |
| Default | The same as `#ForegroundPages.ForegroundPages`. |
##### ForegroundPages
```
public static final int ForegroundPages
```

A watermark should be added to foreground pages only.

##### BackgroundPages
```
public static final int BackgroundPages
```

A watermark should be added to background pages only.

##### AllPages
```
public static final int AllPages
```

A watermark should be added to all pages.

##### SeparateBackgrounds
```
public static final int SeparateBackgrounds
```

Separate background pages with a watermark should be created and assigned to all pages without background.

##### Default
```
public static final int Default
```

The same as `#ForegroundPages.ForegroundPages`.

### EmailAddress
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailaddress.md

**Inheritance:**
java.lang.Object
```
public class EmailAddress
```

Represents an address of an email message.
#### Methods

| Method | Description |
| --- | --- |
| getAddress() | Gets the string representation of the email address. |
| getDisplayName() | Gets the display name associated with the address. |
| getOriginalAddressString() | Gets the original address string. |
| getHost() | Gets the host portion of the address. |
| getUser() | Gets the username. |
##### getAddress()
```
public final String getAddress()
```

Gets the string representation of the email address.

**Returns:**
java.lang.String - The string representation of the email address.
##### getDisplayName()
```
public final String getDisplayName()
```

Gets the display name associated with the address.

**Returns:**
java.lang.String - The display name associated with the address.
##### getOriginalAddressString()
```
public final String getOriginalAddressString()
```

Gets the original address string.

**Returns:**
java.lang.String - The original address string.
##### getHost()
```
public final String getHost()
```

Gets the host portion of the address.

**Returns:**
java.lang.String - The host portion of the address.
##### getUser()
```
public final String getUser()
```

Gets the username.

**Returns:**
java.lang.String - The username.

### EmailAddressCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailaddresscollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class EmailAddressCollection extends ReadOnlyListBase<EmailAddress>
```

Represents a collection of addresses in an email message.

This collection contains the items of `EmailAddress` type.

### EmailAttachment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailattachment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.Attachment, com.groupdocs.watermark.contents.EmailAttachmentBase
```
public class EmailAttachment extends EmailAttachmentBase
```

Represents a file attached to an email message.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the attached file. |
| setName(String value) | Sets the name of the attached file. |
##### getName()
```
public final String getName()
```

Gets the name of the attached file.

**Returns:**
java.lang.String - The name of the attached file.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name of the attached file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the attached file. |

### EmailAttachmentBase
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailattachmentbase.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.Attachment
```
public abstract class EmailAttachmentBase extends Attachment
```

Provides a base class for email attachments.
#### Methods

| Method | Description |
| --- | --- |
| getContentId() | Gets the content id of this . |
| getMediaType() | Gets the media type of this . |
| getContent() | Gets the attached file content. |
| setContent(byte[] value) | Sets the attached file content. |
| getContentStream() |  |
| setContentStream(System.IO.Stream stream) |  |
##### getContentId()
```
public final String getContentId()
```

Gets the content id of this .

**Returns:**
java.lang.String - The content id of this .
##### getMediaType()
```
public final String getMediaType()
```

Gets the media type of this .

**Returns:**
java.lang.String - The media type of this .
##### getContent()
```
public byte[] getContent()
```

Gets the attached file content.

**Returns:**
byte[] - The attached file content.
##### setContent(byte[] value)
```
public void setContent(byte[] value)
```

Sets the attached file content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The attached file content. |

##### getContentStream()
```
public System.IO.Stream getContentStream()
```

Gets a stream from the attached file.

**Returns:**
com.aspose.ms.System.IO.Stream
##### setContentStream(System.IO.Stream stream)
```
public void setContentStream(System.IO.Stream stream)
```

Updates attached file from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

### EmailAttachmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailattachmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class EmailAttachmentCollection extends RemoveOnlyListBase<EmailAttachment>
```

Represents a collection of attachments in an email message.

This collection contains the items of `EmailAttachment` type.
#### Methods

| Method | Description |
| --- | --- |
| add(byte[] fileContent, String name) | Adds an attachment to the `EmailContent`. |
| removeFromDocument(EmailAttachment item) |  |
##### add(byte[] fileContent, String name)
```
public final void add(byte[] fileContent, String name)
```

Adds an attachment to the `EmailContent`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | byte[] | The content of the file to be attached. |
| name | java.lang.String | The name of the file. |

##### removeFromDocument(EmailAttachment item)
```
public void removeFromDocument(EmailAttachment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | EmailAttachment |  |

### EmailBodyType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailbodytype.md

**Inheritance:**
java.lang.Object
```
public final class EmailBodyType
```

Represents a content type of an email message body.
#### Fields

| Field | Description |
| --- | --- |
| PlainText | Plain text body. |
| Html | Html-formatted body. |
##### PlainText
```
public static final int PlainText
```

Plain text body.

##### Html
```
public static final int Html
```

Html-formatted body.

### EmailContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content
```
public final class EmailContent extends Content
```

Represents an email message.

**Learn more:**

 *  [Add watermarks to email attachments][]
 *  [Email attachments][]
 *  [Email messages][]

[Add watermarks to email attachments]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+email+attachments
[Email attachments]: https://docs.groupdocs.com/display/watermarkjava/Email+attachments
[Email messages]: https://docs.groupdocs.com/display/watermarkjava/Email+messages
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, EmailLoadOptions emailLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getAttachments() | Gets the collection of all attachments of the email message. |
| getEmbeddedObjects() | Gets the collection of all embedded objects of the email message. |
| getFrom() | Gets the from address of the email message. |
| getTo() | Gets the collection of recipients of the email message. |
| getCc() | Gets the collection of CC (carbon copy) recipients of the email message. |
| getBcc() | Gets the collection of BCC (blind carbon copy) recipients of the email message. |
| getSubject() | Gets the subject of the email message. |
| setSubject(String value) | Sets the subject of the email message. |
| getBody() | Gets the plain text representation of the message body. |
| setBody(String value) | Sets the plain text representation of the message body. |
| getHtmlBody() | Gets the html representation of the message body. |
| setHtmlBody(String value) | Sets the html representation of the message body. |
| getBodyType() | Gets the type of the email message body. |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| getDocumentInfo() |  |
| getFileType() |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### EmailContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, EmailLoadOptions emailLoadOptions, WatermarkerSettings watermarkerSettings)
```
public EmailContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, EmailLoadOptions emailLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| fileFormatInfo | com.aspose.email.FileFormatInfo |  |
| emailLoadOptions | EmailLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getAttachments()
```
public final EmailAttachmentCollection getAttachments()
```

Gets the collection of all attachments of the email message.

**Returns:**
EmailAttachmentCollection - The collection of all attachments of the email message.
##### getEmbeddedObjects()
```
public final EmailEmbeddedObjectCollection getEmbeddedObjects()
```

Gets the collection of all embedded objects of the email message.

**Returns:**
EmailEmbeddedObjectCollection - The collection of all embedded objects of the email message.
##### getFrom()
```
public final EmailAddress getFrom()
```

Gets the from address of the email message.

**Returns:**
EmailAddress - The from address of the email message.
##### getTo()
```
public final EmailAddressCollection getTo()
```

Gets the collection of recipients of the email message.

**Returns:**
EmailAddressCollection - The collection of recipients of the email message.
##### getCc()
```
public final EmailAddressCollection getCc()
```

Gets the collection of CC (carbon copy) recipients of the email message.

**Returns:**
EmailAddressCollection - The collection of CC (carbon copy) recipients of the email message.
##### getBcc()
```
public final EmailAddressCollection getBcc()
```

Gets the collection of BCC (blind carbon copy) recipients of the email message.

**Returns:**
EmailAddressCollection - The collection of BCC (blind carbon copy) recipients of the email message.
##### getSubject()
```
public final String getSubject()
```

Gets the subject of the email message.

**Returns:**
java.lang.String - The subject of the email message.
##### setSubject(String value)
```
public final void setSubject(String value)
```

Sets the subject of the email message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The subject of the email message. |

##### getBody()
```
public final String getBody()
```

Gets the plain text representation of the message body.

**Returns:**
java.lang.String - The plain text representation of the message body.
##### setBody(String value)
```
public final void setBody(String value)
```

Sets the plain text representation of the message body.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The plain text representation of the message body. |

##### getHtmlBody()
```
public final String getHtmlBody()
```

Gets the html representation of the message body.

**Returns:**
java.lang.String - The html representation of the message body.
##### setHtmlBody(String value)
```
public final void setHtmlBody(String value)
```

Sets the html representation of the message body.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The html representation of the message body. |

##### getBodyType()
```
public final int getBodyType()
```

Gets the type of the email message body.

**Returns:**
int - The type of the email message body.
##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### EmailEmbeddedObject
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailembeddedobject.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.Attachment, com.groupdocs.watermark.contents.EmailAttachmentBase
```
public class EmailEmbeddedObject extends EmailAttachmentBase
```

Represents an object embedded to an email message body.

### EmailEmbeddedObjectCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/emailembeddedobjectcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class EmailEmbeddedObjectCollection extends RemoveOnlyListBase<EmailEmbeddedObject>
```

Represents a collection of embedded objects in an email message.

This collection contains the items of `EmailEmbeddedObject` type.
#### Methods

| Method | Description |
| --- | --- |
| add(byte[] fileContent, String name) | Adds an embedded resource to the `EmailContent`. |
| removeFromDocument(EmailEmbeddedObject item) |  |
##### add(byte[] fileContent, String name)
```
public final void add(byte[] fileContent, String name)
```

Adds an embedded resource to the `EmailContent`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | byte[] | The content of the file to be added. |
| name | java.lang.String | The name of the file. |

##### removeFromDocument(EmailEmbeddedObject item)
```
public void removeFromDocument(EmailEmbeddedObject item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | EmailEmbeddedObject |  |

### GifImageContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/gifimagecontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content, com.groupdocs.watermark.contents.ImageContent, com.groupdocs.watermark.contents.MultiframeImageContent
```
public final class GifImageContent extends MultiframeImageContent
```

Represents a gif image where a watermark can be placed.
#### Constructors

| Constructor | Description |
| --- | --- |
| GifImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, GifImageLoadOptions gifImageLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| performSave(String filePath) |  |
| performSave(OutputStream stream) |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### GifImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, GifImageLoadOptions gifImageLoadOptions, WatermarkerSettings watermarkerSettings)
```
public GifImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, GifImageLoadOptions gifImageLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| gifImageLoadOptions | GifImageLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### ImageContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/imagecontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content
```
public class ImageContent extends Content
```

Represents an image where a watermark can be placed.

**Learn more:**

 *  [Add watermarks to images][]

[Add watermarks to images]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+images
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileType fileType, ImageLoadOptions imageLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets the height of this `ImageContent` in pixels. |
| getWidth() | Gets the width of this `ImageContent` in pixels. |
| getAsposeImageContainer() | Gets underlying  GroupDocs.Watermark.Internal.AsposeImageContainer . |
| getDocumentInfo() |  |
| getFileType() |  |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) | Saves the content to the specified stream. |
| performSave(OutputStream stream, SaveOptions saveOptions) | Saves the content to the specified stream. |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### ImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileType fileType, ImageLoadOptions imageLoadOptions, WatermarkerSettings watermarkerSettings)
```
public ImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileType fileType, ImageLoadOptions imageLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| fileType | FileType |  |
| imageLoadOptions | ImageLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getHeight()
```
public final int getHeight()
```

Gets the height of this `ImageContent` in pixels.

Returns the height of the active frame for a multiframe image.

**Returns:**
int - The height of this `ImageContent` in pixels.
##### getWidth()
```
public final int getWidth()
```

Gets the width of this `ImageContent` in pixels.

Returns the width of the active frame for a multiframe image.

**Returns:**
int - The width of this `ImageContent` in pixels.
##### getAsposeImageContainer()
```
public final AsposeImageContainer getAsposeImageContainer()
```

Gets underlying  GroupDocs.Watermark.Internal.AsposeImageContainer .

**Returns:**
AsposeImageContainer
##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

Saves the content to the specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

Saves the content to the specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | The stream to save the content data to. |
| saveOptions | SaveOptions | The options tha should be used when saving the content data. |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### ImageFrame
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/imageframe.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class ImageFrame extends ContentPart
```

Represents an image frame where a watermark can be placed.
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets the height of this `ImageFrame` in pixels. |
| getWidth() | Gets the width of this `ImageFrame` in pixels. |
| getAsposeImageContainer() |  |
##### getHeight()
```
public final int getHeight()
```

Gets the height of this `ImageFrame` in pixels.

**Returns:**
int - The height of this `ImageFrame` in pixels.
##### getWidth()
```
public final int getWidth()
```

Gets the width of this `ImageFrame` in pixels.

**Returns:**
int - The width of this `ImageFrame` in pixels.
##### getAsposeImageContainer()
```
public final AsposeImageContainer getAsposeImageContainer()
```

**Returns:**
AsposeImageContainer

### ImageFrameCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/imageframecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class ImageFrameCollection extends ReadOnlyListBase<ImageFrame>
```

Represents a collection of frames in multiframe image.

This collection contains the items of `ImageFrame` type.

### ImageUtils
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/imageutils.md

**Inheritance:**
java.lang.Object
```
public class ImageUtils
```
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageUtils() |  |
#### Methods

| Method | Description |
| --- | --- |
| getFrames(IGifBlock[] blocks) |  |
##### ImageUtils()
```
public ImageUtils()
```

##### getFrames(IGifBlock[] blocks)
```
public static GifFrameBlock[] getFrames(IGifBlock[] blocks)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| blocks | com.aspose.imaging.fileformats.gif.IGifBlock[] |  |

**Returns:**
com.aspose.imaging.fileformats.gif.blocks.GifFrameBlock[]

### IPresentationHyperlinkContainer
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/ipresentationhyperlinkcontainer.md

### MultiframeImageContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/multiframeimagecontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content, com.groupdocs.watermark.contents.ImageContent
```
public abstract class MultiframeImageContent extends ImageContent
```

Represents a multiframe image where a watermark can be placed.
#### Methods

| Method | Description |
| --- | --- |
| getFrames() | Gets the collection of all frames of the image. |
| getDocumentInfo() |  |
##### getFrames()
```
public final ImageFrameCollection getFrames()
```

Gets the collection of all frames of the image.

**Returns:**
ImageFrameCollection - The collection of image frames.
##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo

### OfficeDashStyle
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officedashstyle.md

**Inheritance:**
java.lang.Object
```
public final class OfficeDashStyle
```

Represents a dashed line style.
#### Fields

| Field | Description |
| --- | --- |
| Solid | Solid (continuous) pen. |
| Default | Same as  Solid . |
| Dot | Dot style. |
| Dash | Dash style. |
| DashDot | Dash dot style. |
| DashDotDot | Dash dot dot style. |
##### Solid
```
public static final int Solid
```

Solid (continuous) pen.

##### Default
```
public static final int Default
```

Same as  Solid .

##### Dot
```
public static final int Dot
```

Dot style.

##### Dash
```
public static final int Dash
```

Dash style.

##### DashDot
```
public static final int DashDot
```

Dash dot style.

##### DashDotDot
```
public static final int DashDotDot
```

Dash dot dot style.

### OfficeHeaderFooterType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officeheaderfootertype.md

**Inheritance:**
java.lang.Object
```
public final class OfficeHeaderFooterType
```

Identifies the type of header or footer.
#### Fields

| Field | Description |
| --- | --- |
| HeaderPrimary | Primary header, also used for odd numbered pages. |
| HeaderEven | Header for even numbered pages. |
| HeaderFirst | Header for the first page. |
| FooterPrimary | Primary footer, also used for odd numbered pages. |
| FooterEven | Footer for even numbered pages. |
| FooterFirst | Footer for the first page. |
##### HeaderPrimary
```
public static final int HeaderPrimary
```

Primary header, also used for odd numbered pages.

##### HeaderEven
```
public static final int HeaderEven
```

Header for even numbered pages.

##### HeaderFirst
```
public static final int HeaderFirst
```

Header for the first page.

##### FooterPrimary
```
public static final int FooterPrimary
```

Primary footer, also used for odd numbered pages.

##### FooterEven
```
public static final int FooterEven
```

Footer for even numbered pages.

##### FooterFirst
```
public static final int FooterFirst
```

Footer for the first page.

### OfficeImageEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officeimageeffects.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IDocumentSpecificSettings
```
public abstract class OfficeImageEffects implements IDocumentSpecificSettings
```

Represents effects that can be applied to an image watermark for an office content.
#### Methods

| Method | Description |
| --- | --- |
| getBorderLineFormat() | Gets a line format settings for the image border. |
| setBorderLineFormat(OfficeLineFormat value) | Sets a line format settings for the image border. |
| getGrayScale() | Gets a value indicating whether a picture will be displayed in grayscale mode. |
| setGrayScale(boolean value) | Sets a value indicating whether a picture will be displayed in grayscale mode. |
| getChromaKey() | Gets the color value of the image that will be treated as transparent. |
| setChromaKey(Color value) | Sets the color value of the image that will be treated as transparent. |
| getBrightness() | Gets the brightness of the picture. |
| setBrightness(double value) | Sets the brightness of the picture. |
| getContrast() | Gets the contrast for the specified picture. |
| setContrast(double value) | Sets the contrast for the specified picture. |
##### getBorderLineFormat()
```
public final OfficeLineFormat getBorderLineFormat()
```

Gets a line format settings for the image border.

**Returns:**
OfficeLineFormat - Instance of  OfficeLineFormat  class, representing shape line format.
##### setBorderLineFormat(OfficeLineFormat value)
```
public final void setBorderLineFormat(OfficeLineFormat value)
```

Sets a line format settings for the image border.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | OfficeLineFormat | Instance of  OfficeLineFormat  class, representing shape line format. |

##### getGrayScale()
```
public final boolean getGrayScale()
```

Gets a value indicating whether a picture will be displayed in grayscale mode.

**Returns:**
boolean - The default value is false.
##### setGrayScale(boolean value)
```
public final void setGrayScale(boolean value)
```

Sets a value indicating whether a picture will be displayed in grayscale mode.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The default value is false. |

##### getChromaKey()
```
public final Color getChromaKey()
```

Gets the color value of the image that will be treated as transparent.

**Returns:**
Color - The default value is fully transparent color.
##### setChromaKey(Color value)
```
public final void setChromaKey(Color value)
```

Sets the color value of the image that will be treated as transparent.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | The default value is fully transparent color. |

##### getBrightness()
```
public final double getBrightness()
```

Gets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

**Returns:**
double - The default value is 0.5.
##### setBrightness(double value)
```
public final void setBrightness(double value)
```

Sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The default value is 0.5. |

##### getContrast()
```
public final double getContrast()
```

Gets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

**Returns:**
double - The default value is 0.5.
##### setContrast(double value)
```
public final void setContrast(double value)
```

Sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The default value is 0.5. |

### OfficeImageFillFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officeimagefillformat.md

**Inheritance:**
java.lang.Object
```
public abstract class OfficeImageFillFormat<TWatermarkableImage>
```

Represents the image fill format settings in any supported office content.

 TWatermarkableImage : The exact type of the watermarkable image that is used as background.
#### Constructors

| Constructor | Description |
| --- | --- |
| OfficeImageFillFormat() |  |
#### Methods

| Method | Description |
| --- | --- |
| getTileAsTexture() | Gets a value indicating whether the image is tiled across the background. |
| setTileAsTexture(boolean value) | Sets a value indicating whether the image is tiled across the background. |
| getTransparency() | Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| setTransparency(double value) | Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(TWatermarkableImage value) | Sets the background image. |
| checkIfBackgroundImageIsSet() |  |
##### OfficeImageFillFormat()
```
public OfficeImageFillFormat()
```

##### getTileAsTexture()
```
public abstract boolean getTileAsTexture()
```

Gets a value indicating whether the image is tiled across the background.

**Returns:**
boolean - True if the image is tiled across the background; otherwise, false (the image is stretched).
##### setTileAsTexture(boolean value)
```
public abstract void setTileAsTexture(boolean value)
```

Sets a value indicating whether the image is tiled across the background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if the image is tiled across the background; otherwise, false (the image is stretched). |

##### getTransparency()
```
public abstract double getTransparency()
```

Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Returns:**
double - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
##### setTransparency(double value)
```
public abstract void setTransparency(double value)
```

Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

##### getBackgroundImage()
```
public abstract TWatermarkableImage getBackgroundImage()
```

Gets the background image.

**Returns:**
TWatermarkableImage - The background image. Returns null if the image is not set.
##### setBackgroundImage(TWatermarkableImage value)
```
public abstract void setBackgroundImage(TWatermarkableImage value)
```

Sets the background image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | TWatermarkableImage | The background image. Returns null if the image is not set. |

##### checkIfBackgroundImageIsSet()
```
public final void checkIfBackgroundImageIsSet()
```

### OfficeLineFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officelineformat.md

**Inheritance:**
java.lang.Object
```
public final class OfficeLineFormat
```

Represents a shape line format.
#### Constructors

| Constructor | Description |
| --- | --- |
| OfficeLineFormat() | Initializes a new instance of the `OfficeLineFormat` class. |
#### Methods

| Method | Description |
| --- | --- |
| getWeight() | Gets the brush thickness that strokes the path of a shape. |
| setWeight(double value) | Sets the brush thickness that strokes the path of a shape. |
| getColor() | Gets the color of the line. |
| setColor(Color value) | Sets the color of the line. |
| getOpacity() | Gets the line opacity. |
| setOpacity(double value) | Sets the line opacity. |
| getEnabled() | Gets a value indicating whether a shape will be stroked. |
| setEnabled(boolean value) | Sets a value indicating whether a shape will be stroked. |
| getDashStyle() | Gets the dot and dash pattern for a line. |
| setDashStyle(int value) | Sets the dot and dash pattern for a line. |
| getLineStyle() | Gets the line style. |
| setLineStyle(int value) | Sets the line style. |
| getTransparency() |  |
| getColorConsideringOpacity() |  |
##### OfficeLineFormat()
```
public OfficeLineFormat()
```

Initializes a new instance of the `OfficeLineFormat` class.

##### getWeight()
```
public final double getWeight()
```

Gets the brush thickness that strokes the path of a shape.

**Returns:**
double - The line thickness in points. The default value is 0.75.
##### setWeight(double value)
```
public final void setWeight(double value)
```

Sets the brush thickness that strokes the path of a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The line thickness in points. The default value is 0.75. |

##### getColor()
```
public final Color getColor()
```

Gets the color of the line.

The default value is `Color.getBlack()`.

**Returns:**
Color - The color of the line.
##### setColor(Color value)
```
public final void setColor(Color value)
```

Sets the color of the line.

The default value is `Color.getBlack()`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | The color of the line. |

##### getOpacity()
```
public final double getOpacity()
```

Gets the line opacity.

**Returns:**
double - The value should be between 0 and 1. Default value is 1.
##### setOpacity(double value)
```
public final void setOpacity(double value)
```

Sets the line opacity.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The value should be between 0 and 1. Default value is 1. |

##### getEnabled()
```
public final boolean getEnabled()
```

Gets a value indicating whether a shape will be stroked.

**Returns:**
boolean - The default value is false.
##### setEnabled(boolean value)
```
public final void setEnabled(boolean value)
```

Sets a value indicating whether a shape will be stroked.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The default value is false. |

##### getDashStyle()
```
public final int getDashStyle()
```

Gets the dot and dash pattern for a line.

**Returns:**
int
##### setDashStyle(int value)
```
public final void setDashStyle(int value)
```

Sets the dot and dash pattern for a line.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getLineStyle()
```
public final int getLineStyle()
```

Gets the line style.

The default value is `OfficeLineStyle.Single`.

**Returns:**
int - The line style.
##### setLineStyle(int value)
```
public final void setLineStyle(int value)
```

Sets the line style.

The default value is `OfficeLineStyle.Single`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The line style. |

##### getTransparency()
```
public final double getTransparency()
```

**Returns:**
double
##### getColorConsideringOpacity()
```
public final Color getColorConsideringOpacity()
```

**Returns:**
Color

### OfficeLineStyle
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officelinestyle.md

**Inheritance:**
java.lang.Object
```
public final class OfficeLineStyle
```

Represents the compound line style of a `OfficeLineFormat`.
#### Fields

| Field | Description |
| --- | --- |
| Single | Single line. |
| Default | Default value is `#Single.Single`. |
| Double | Double lines of equal width. |
| ThickThin | Double lines, one thick, one thin. |
| ThinThick | Double lines, one thin, one thick. |
| Triple | Three lines, thin, thick, thin. |
##### Single
```
public static final int Single
```

Single line.

##### Default
```
public static final int Default
```

Default value is `#Single.Single`.

##### Double
```
public static final int Double
```

Double lines of equal width.

##### ThickThin
```
public static final int ThickThin
```

Double lines, one thick, one thin.

##### ThinThick
```
public static final int ThinThick
```

Double lines, one thin, one thick.

##### Triple
```
public static final int Triple
```

Three lines, thin, thick, thin.

### OfficeShapeSettings
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officeshapesettings.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IDocumentSpecificSettings
```
public class OfficeShapeSettings implements IDocumentSpecificSettings
```

Represents settings that can be applied to a shape watermark for an office content.
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name a shape. |
| setName(String value) | Sets the name a shape. |
| getAlternativeText() | Gets the descriptive (alternative) text that will be associated with a shape. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text that will be associated with a shape. |
##### getName()
```
public final String getName()
```

Gets the name a shape.

**Returns:**
java.lang.String - The shape name.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The shape name. |

##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text that will be associated with a shape.

**Returns:**
java.lang.String - The descriptive (alternative) text that will be associated with a shape.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text that will be associated with a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text that will be associated with a shape. |

### OfficeTextEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/officetexteffects.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IDocumentSpecificSettings
```
public abstract class OfficeTextEffects implements IDocumentSpecificSettings
```

Represents effects that can be applied to a text watermark for an office content.
#### Methods

| Method | Description |
| --- | --- |
| getLineFormat() | Gets the line format settings. |
| setLineFormat(OfficeLineFormat value) | Sets the line format settings. |
##### getLineFormat()
```
public final OfficeLineFormat getLineFormat()
```

Gets the line format settings.

**Returns:**
OfficeLineFormat - The instance of `OfficeLineFormat` class, representing shape line format.
##### setLineFormat(OfficeLineFormat value)
```
public final void setLineFormat(OfficeLineFormat value)
```

Sets the line format settings.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | OfficeLineFormat | The instance of `OfficeLineFormat` class, representing shape line format. |

### PdfAnnotation
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfannotation.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PdfShape
```
public class PdfAnnotation extends PdfShape
```

Represents an annotation in a pdf document.

**Learn more:**

 *  [Working with annotations][]

[Working with annotations]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithannotations
#### Fields

| Field | Description |
| --- | --- |
| NormalAppearanceKey |  |
#### Methods

| Method | Description |
| --- | --- |
| getPage() | Gets the parent page of this `PdfAnnotation`. |
| getAnnotationType() | Gets the type of this `PdfAnnotation`. |
| getX() | Gets the horizontal offset of this `PdfAnnotation` from page left border in points. |
| getY() | Gets the vertical offset of this `PdfAnnotation` from worksheet bottom border in points. |
| getRotateAngle() | Gets the rotate angle of this `PdfAnnotation` in degrees. |
| getWidth() | Gets the width of this `PdfAnnotation` in points. |
| getHeight() | Gets the height of this `PdfAnnotation` in points. |
| getAsposePdfAnnotation() |  |
| getOuterForm() |  |
##### NormalAppearanceKey
```
public static final String NormalAppearanceKey
```

##### getPage()
```
public final PdfPage getPage()
```

Gets the parent page of this `PdfAnnotation`.

**Returns:**
PdfPage - The parent page of this `PdfAnnotation`.
##### getAnnotationType()
```
public final int getAnnotationType()
```

Gets the type of this `PdfAnnotation`.

**Returns:**
int - The type of this `PdfAnnotation`.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `PdfAnnotation` from page left border in points.

**Returns:**
double - The horizontal offset of this `PdfAnnotation` from page left border in points.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `PdfAnnotation` from worksheet bottom border in points.

**Returns:**
double - The vertical offset of this `PdfAnnotation` from worksheet bottom border in points.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PdfAnnotation` in degrees.

**Returns:**
double - The rotate angle of this `PdfAnnotation` in degrees.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PdfAnnotation` in points.

**Returns:**
double - The width of this `PdfAnnotation` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PdfAnnotation` in points.

**Returns:**
double - The height of this `PdfAnnotation` in points.
##### getAsposePdfAnnotation()
```
public final Annotation getAsposePdfAnnotation()
```

**Returns:**
com.aspose.pdf.Annotation
##### getOuterForm()
```
public XForm getOuterForm()
```

**Returns:**
com.aspose.pdf.XForm

### PdfAnnotationCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfannotationcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PdfAnnotationCollection extends RemoveOnlyListBase<PdfAnnotation>
```

Represents a collection of annotations in a pdf document.

This collection contains the items of `PdfAnnotation` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(PdfAnnotation item) |  |
##### removeFromDocument(PdfAnnotation item)
```
public void removeFromDocument(PdfAnnotation item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PdfAnnotation |  |

### PdfAnnotationType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfannotationtype.md

**Inheritance:**
java.lang.Object
```
public final class PdfAnnotationType
```

Enumeration of annotation types.
#### Fields

| Field | Description |
| --- | --- |
| Text | Text annotation type. |
| Circle | Circle annotation type. |
| Polygon | Polygon annotation type. |
| PolyLine | Polyline annotation type. |
| Line | Line annotation type. |
| Square | Square annotation type. |
| FreeText | Free text annotation type. |
| Highlight | Highlight annotation type. |
| Underline | Underline annotation type. |
| Squiggly | Squiggle annotation type. |
| StrikeOut | Strikeout annotation type. |
| Caret | Caret annotation type. |
| Ink | Ink annotation type. |
| Link | Link annotation type. |
| Popup | Popup annotation type. |
| FileAttachment | File attachment annotation type. |
| Sound | Sound annotation type. |
| Movie | Movie annotation type. |
| Screen | Screen annotation type. |
| Widget | Widget annotation type. |
| Watermark | Watermark annotation type. |
| TrapNet | Trap network annotation type. |
| PrinterMark | Printer mark annotation type. |
| Redaction | Redaction annotation type. |
| Stamp | Rubber stamp annotation type. |
| RichMedia | RichMedia annotation type. |
| Unknown | Unknown annotation. |
| Pdf3D | PDF3D annotation. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `PdfAnnotationType` value. |
| parse(String value) | Parses a string to a `PdfAnnotationType` enumeration value. |
| isDefined(int value) | Checks if a value defined for `PdfAnnotationType` enumeration. |
##### Text
```
public static final int Text
```

Text annotation type.

##### Circle
```
public static final int Circle
```

Circle annotation type.

##### Polygon
```
public static final int Polygon
```

Polygon annotation type.

##### PolyLine
```
public static final int PolyLine
```

Polyline annotation type.

##### Line
```
public static final int Line
```

Line annotation type.

##### Square
```
public static final int Square
```

Square annotation type.

##### FreeText
```
public static final int FreeText
```

Free text annotation type.

##### Highlight
```
public static final int Highlight
```

Highlight annotation type.

##### Underline
```
public static final int Underline
```

Underline annotation type.

##### Squiggly
```
public static final int Squiggly
```

Squiggle annotation type.

##### StrikeOut
```
public static final int StrikeOut
```

Strikeout annotation type.

##### Caret
```
public static final int Caret
```

Caret annotation type.

##### Ink
```
public static final int Ink
```

Ink annotation type.

##### Link
```
public static final int Link
```

Link annotation type.

##### Popup
```
public static final int Popup
```

Popup annotation type.

##### FileAttachment
```
public static final int FileAttachment
```

File attachment annotation type.

##### Sound
```
public static final int Sound
```

Sound annotation type.

##### Movie
```
public static final int Movie
```

Movie annotation type.

##### Screen
```
public static final int Screen
```

Screen annotation type.

##### Widget
```
public static final int Widget
```

Widget annotation type.

##### Watermark
```
public static final int Watermark
```

Watermark annotation type.

##### TrapNet
```
public static final int TrapNet
```

Trap network annotation type.

##### PrinterMark
```
public static final int PrinterMark
```

Printer mark annotation type.

##### Redaction
```
public static final int Redaction
```

Redaction annotation type.

##### Stamp
```
public static final int Stamp
```

Rubber stamp annotation type.

##### RichMedia
```
public static final int RichMedia
```

RichMedia annotation type.

##### Unknown
```
public static final int Unknown
```

Unknown annotation.

##### Pdf3D
```
public static final int Pdf3D
```

PDF3D annotation.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `PdfAnnotationType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `PdfAnnotationType` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `PdfAnnotationType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `PdfAnnotationType` enumeration value.
##### isDefined(int value)
```
public static final Boolean isDefined(int value)
```

Checks if a value defined for `PdfAnnotationType` enumeration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to check. |

**Returns:**
java.lang.Boolean - true if the value is defined, false otherwise.

### PdfArtifact
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfartifact.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PdfShape
```
public class PdfArtifact extends PdfShape
```

Represents an artifact in a pdf content.

**Lean more**

 *  [Working with artifacts][]

[Working with artifacts]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithartifacts
#### Methods

| Method | Description |
| --- | --- |
| getPage() | Gets the parent page of this `PdfArtifact`. |
| getText() | Gets the text of this `PdfArtifact`. |
| setText(String value) | Sets the text of this `PdfArtifact`. |
| getArtifactType() | Gets the type of this `PdfArtifact`. |
| getArtifactSubtype() | Gets the subtype of this `PdfArtifact`. |
| getOpacity() | Gets the opacity of this `PdfArtifact`. |
| getX() | Gets the horizontal offset of this `PdfArtifact` from page left border in points. |
| getY() | Gets the vertical offset of this `PdfArtifact` from page bottom border in points. |
| getRotateAngle() | Gets the rotate angle of this `PdfArtifact` in degrees. |
| getWidth() | Gets the width of this `PdfArtifact` in points. |
| getHeight() | Gets the height of this `PdfArtifact` in points. |
| getAsposePdfArtifact() |  |
| getOuterForm() |  |
##### getPage()
```
public final PdfPage getPage()
```

Gets the parent page of this `PdfArtifact`.

**Returns:**
PdfPage - The parent page of this `PdfArtifact`.
##### getText()
```
public String getText()
```

Gets the text of this `PdfArtifact`.

**Returns:**
java.lang.String - The text of this `PdfArtifact`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `PdfArtifact`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `PdfArtifact`. |

##### getArtifactType()
```
public final int getArtifactType()
```

Gets the type of this `PdfArtifact`.

**Returns:**
int - The type of this `PdfArtifact`.
##### getArtifactSubtype()
```
public final int getArtifactSubtype()
```

Gets the subtype of this `PdfArtifact`.

**Returns:**
int - The subtype of this `PdfArtifact`.
##### getOpacity()
```
public final double getOpacity()
```

Gets the opacity of this `PdfArtifact`.

Possible values are in range [0, 1].

**Returns:**
double - The opacity of this `PdfArtifact`.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `PdfArtifact` from page left border in points.

**Returns:**
double - The x-coordinate of this `PdfArtifact`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `PdfArtifact` from page bottom border in points.

**Returns:**
double - The y-coordinate of this `PdfArtifact`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PdfArtifact` in degrees.

**Returns:**
double - The rotate angle of this `PdfArtifact` in degrees.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PdfArtifact` in points.

**Returns:**
double - The width of this `PdfArtifact` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PdfArtifact` in points.

**Returns:**
double - The height of this `PdfArtifact` in points.
##### getAsposePdfArtifact()
```
public final Artifact getAsposePdfArtifact()
```

**Returns:**
com.aspose.pdf.Artifact
##### getOuterForm()
```
public XForm getOuterForm()
```

**Returns:**
com.aspose.pdf.XForm

### PdfArtifactCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfartifactcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PdfArtifactCollection extends RemoveOnlyListBase<PdfArtifact>
```

Represents a collection of artifacts in a pdf content.

This collection contains the items of `PdfArtifact` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(PdfArtifact item) |  |
##### removeFromDocument(PdfArtifact item)
```
public void removeFromDocument(PdfArtifact item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PdfArtifact |  |

### PdfArtifactSubtype
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfartifactsubtype.md

**Inheritance:**
java.lang.Object
```
public final class PdfArtifactSubtype
```

Enumeration of possible artifacts subtype.
#### Fields

| Field | Description |
| --- | --- |
| Header | Header subtype. |
| Footer | Footer subtype. |
| Watermark | Watermark subtype. |
| Background | Background subtype. |
| Undefined | UndefinedDocument subtype. |
##### Header
```
public static final int Header
```

Header subtype.

##### Footer
```
public static final int Footer
```

Footer subtype.

##### Watermark
```
public static final int Watermark
```

Watermark subtype.

##### Background
```
public static final int Background
```

Background subtype.

##### Undefined
```
public static final int Undefined
```

UndefinedDocument subtype.

### PdfArtifactType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfartifacttype.md

**Inheritance:**
java.lang.Object
```
public final class PdfArtifactType
```

Enumeration of possible artifact types.
#### Fields

| Field | Description |
| --- | --- |
| Pagination | Pagination type. |
| Layout | Layout type. |
| Page | Page type. |
| Background | Background type. |
| Undefined | UndefinedDocument type. |
##### Pagination
```
public static final int Pagination
```

Pagination type.

##### Layout
```
public static final int Layout
```

Layout type.

##### Page
```
public static final int Page
```

Page type.

##### Background
```
public static final int Background
```

Background type.

##### Undefined
```
public static final int Undefined
```

UndefinedDocument type.

### PdfAttachment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfattachment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.Attachment
```
public class PdfAttachment extends Attachment
```

Represents a file attached to a pdf content.

**Learn more:**

 *  [Attachments in PDF document][]

[Attachments in PDF document]: https://docs.groupdocs.com/display/watermarkjava/Attachments+in+PDF+document
#### Methods

| Method | Description |
| --- | --- |
| getName() | Gets the name of the attached file. |
| setName(String value) | Sets the name of the attached file. |
| getDescription() | Gets the description of the attached file. |
| setDescription(String value) | Sets the description of the attached file. |
| getContent() | Gets the attached file content. |
| setContent(byte[] value) | Sets the attached file content. |
| setContentStream(System.IO.Stream stream) |  |
| getContentStream() |  |
##### getName()
```
public final String getName()
```

Gets the name of the attached file.

**Returns:**
java.lang.String - The name of the attached file.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name of the attached file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The name of the attached file. |

##### getDescription()
```
public final String getDescription()
```

Gets the description of the attached file.

**Returns:**
java.lang.String - The description of the attached file.
##### setDescription(String value)
```
public final void setDescription(String value)
```

Sets the description of the attached file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The description of the attached file. |

##### getContent()
```
public byte[] getContent()
```

Gets the attached file content.

**Returns:**
byte[] - The attached file content.
##### setContent(byte[] value)
```
public void setContent(byte[] value)
```

Sets the attached file content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The attached file content. |

##### setContentStream(System.IO.Stream stream)
```
public void setContentStream(System.IO.Stream stream)
```

Updates attached file from a stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

##### getContentStream()
```
public System.IO.Stream getContentStream()
```

Gets a stream from the attached file.

**Returns:**
com.aspose.ms.System.IO.Stream

### PdfAttachmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfattachmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PdfAttachmentCollection extends RemoveOnlyListBase<PdfAttachment>
```

Represents a collection of attachments in a pdf document.

This collection contains the items of `PdfAttachment` type.
#### Methods

| Method | Description |
| --- | --- |
| add(byte[] fileContent, String name, String description) | Adds an attachment to the `PdfContent`. |
| removeFromDocument(PdfAttachment item) |  |
##### add(byte[] fileContent, String name, String description)
```
public final void add(byte[] fileContent, String name, String description)
```

Adds an attachment to the `PdfContent`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | byte[] | The content of the file to be attached. |
| name | java.lang.String | The name of the file. |
| description | java.lang.String | The description of the file. |

##### removeFromDocument(PdfAttachment item)
```
public void removeFromDocument(PdfAttachment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PdfAttachment |  |

### PdfContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IEncryptable
```
public class PdfContent extends Content implements IEncryptable
```

Represents a pdf document where a watermark can be placed.

**Learn more:**

 *  [Add watermarks to PDF documents][]
 *  [Existing objects in PDF document][]
 *  [Rasterize document or page][]
 *  [Watermarks in PDF document][]

[Add watermarks to PDF documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+PDF+documents
[Existing objects in PDF document]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+PDF+document
[Rasterize document or page]: https://docs.groupdocs.com/display/watermarkjava/Rasterize+document+or+page
[Watermarks in PDF document]: https://docs.groupdocs.com/display/watermarkjava/Watermarks+in+PDF+document
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PdfLoadOptions pdfLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getPages() | Gets the collection of all pages of this `PdfContent`. |
| getAttachments() | Gets the collection of all attachments of this `PdfContent`. |
| getPageMarginType() | Gets pdf page margins to be used during watermark adding. |
| setPageMarginType(int value) | Sets pdf page margins to be used during watermark adding. |
| getAsposePdfDocument() |  |
| addArtifactWatermark(Watermark watermark) |  |
| addAnnotationWatermark(Watermark watermark, boolean isPrintOnly) |  |
| getDocumentInfo() |  |
| getFileType() |  |
| encrypt(String password) | Encrypts the document using the same password as user password and owner password. |
| encrypt(String userPassword, String ownerPassword, int permissions, int cryptoAlgorithm) | Encrypts the content. |
| decrypt() | Decrypts the content. |
| rasterize(int horizontalResolution, int verticalResolution, int imageFormat) | Converts all content pages into images. |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) | Saves the document data to the specified stream. |
| performSave(OutputStream stream, SaveOptions saveOptions) | Saves the document data to the specified stream. |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### PdfContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PdfLoadOptions pdfLoadOptions, WatermarkerSettings watermarkerSettings)
```
public PdfContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PdfLoadOptions pdfLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| pdfLoadOptions | PdfLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getPages()
```
public final PdfPageCollection getPages()
```

Gets the collection of all pages of this `PdfContent`.

**Returns:**
PdfPageCollection - The collection of all pages of this `PdfContent`.
##### getAttachments()
```
public final PdfAttachmentCollection getAttachments()
```

Gets the collection of all attachments of this `PdfContent`.

**Returns:**
PdfAttachmentCollection - The collection of all attachments of this `PdfContent`.
##### getPageMarginType()
```
public final int getPageMarginType()
```

Gets pdf page margins to be used during watermark adding.

This property works only when `Watermark.getConsiderParentMargins()` is true. If `Watermark.getConsiderParentMargins()` is false, when pdf CropBox is used as watermarking area.

The default value is `PdfPageMarginType.TrimBox`.

**Returns:**
int
##### setPageMarginType(int value)
```
public final void setPageMarginType(int value)
```

Sets pdf page margins to be used during watermark adding.

This property works only when `Watermark.getConsiderParentMargins()` is set to true. If `Watermark.getConsiderParentMargins()` is false, when pdf CropBox is used as watermarking area.

The default value is `PdfPageMarginType.TrimBox`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int |  |

##### getAsposePdfDocument()
```
public final Document getAsposePdfDocument()
```

**Returns:**
com.aspose.pdf.Document
##### addArtifactWatermark(Watermark watermark)
```
public final void addArtifactWatermark(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### addAnnotationWatermark(Watermark watermark, boolean isPrintOnly)
```
public final void addAnnotationWatermark(Watermark watermark, boolean isPrintOnly)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| isPrintOnly | boolean |  |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### encrypt(String password)
```
public final void encrypt(String password)
```

Encrypts the document using the same password as user password and owner password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | User and owner password. |

##### encrypt(String userPassword, String ownerPassword, int permissions, int cryptoAlgorithm)
```
public final void encrypt(String userPassword, String ownerPassword, int permissions, int cryptoAlgorithm)
```

Encrypts the content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| userPassword | java.lang.String | User password. |
| ownerPassword | java.lang.String | Owner password. |
| permissions | int | Content permissions. |
| cryptoAlgorithm | int | Cryptographic algorithm. |

##### decrypt()
```
public final void decrypt()
```

Decrypts the content.

##### rasterize(int horizontalResolution, int verticalResolution, int imageFormat)
```
public final void rasterize(int horizontalResolution, int verticalResolution, int imageFormat)
```

Converts all content pages into images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| horizontalResolution | int | Horizontal image resolution. |
| verticalResolution | int | Vertical image resolution. |
| imageFormat | int | Image format. |

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

Saves the document data to the specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | The stream to save the content data to. |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

Saves the document data to the specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream | The stream to save the content data to. |
| saveOptions | SaveOptions | The options tha should be used when saving the content data. |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### PdfCryptoAlgorithm
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfcryptoalgorithm.md

**Inheritance:**
java.lang.Object
```
public final class PdfCryptoAlgorithm
```

Represent type of cryptographic algorithm that used in encryption routine.
#### Fields

| Field | Description |
| --- | --- |
| RC4x40 | RC4 with key length 40. |
| RC4x128 | RC4 with key length 128. |
| AESx128 | AES with key length 128. |
| AESx256 | AES with key length 256. |
##### RC4x40
```
public static final int RC4x40
```

RC4 with key length 40.

##### RC4x128
```
public static final int RC4x128
```

RC4 with key length 128.

##### AESx128
```
public static final int AESx128
```

AES with key length 128.

##### AESx256
```
public static final int AESx256
```

AES with key length 256.

### PdfFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class PdfFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in a pdf document.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### PdfFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class PdfFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a pdf document.

This collection contains the items of `PdfFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(FormattedTextFragment item) |  |
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

### PdfImageConversionFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfimageconversionformat.md

**Inheritance:**
java.lang.Object
```
public final class PdfImageConversionFormat
```

Represents image formats that can be used for pdf document pages rasterization.
#### Fields

| Field | Description |
| --- | --- |
| Jpeg | Jpeg image. |
| Png | Png image. |
| Gif | Gif image. |
##### Jpeg
```
public static final int Jpeg
```

Jpeg image.

##### Png
```
public static final int Png
```

Png image.

##### Gif
```
public static final int Gif
```

Gif image.

### PdfPage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfpage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class PdfPage extends ContentPart
```

Represents pdf document page.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPage(PdfContent parent, StrategyManager<Integer> strategyManager, Page asposePdfPage) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of this `PdfPage` in points. |
| getHeight() | Gets the height of this `PdfPage` in points. |
| getArtifacts() | Gets the collection of all artifacts of this `PdfPage`. |
| getXObjects() | Gets the collection of all XObjects of this `PdfPage`. |
| getAnnotations() | Gets the collection of all annotations of this `PdfPage`. |
| getAsposePdfPage() |  |
| getContent() |  |
| getPageRectangle() |  |
| addArtifactWatermark(Watermark watermark) |  |
| addAnnotationWatermark(Watermark watermark, boolean isPrintOnly) |  |
| rasterize(int horizontalResolution, int verticalResolution, int imageFormat) | Converts page content into an image. |
| addArtifactToCollection(Artifact artifact) |  |
| addAnnotationToCollection(Annotation annotation) |  |
##### PdfPage(PdfContent parent, StrategyManager<Integer> strategyManager, Page asposePdfPage)
```
public PdfPage(PdfContent parent, StrategyManager<Integer> strategyManager, Page asposePdfPage)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | PdfContent |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| asposePdfPage | com.aspose.pdf.Page |  |

##### getWidth()
```
public final double getWidth()
```

Gets the width of this `PdfPage` in points.

**Returns:**
double - The width of this `PdfPage` in points.
##### getHeight()
```
public final double getHeight()
```

Gets the height of this `PdfPage` in points.

**Returns:**
double - The height of this `PdfPage` in points.
##### getArtifacts()
```
public final PdfArtifactCollection getArtifacts()
```

Gets the collection of all artifacts of this `PdfPage`.

**Returns:**
PdfArtifactCollection - The collection of all artifacts of this `PdfPage`.
##### getXObjects()
```
public final PdfXObjectCollection getXObjects()
```

Gets the collection of all XObjects of this `PdfPage`.

**Returns:**
PdfXObjectCollection - The collection of all XObjects of this `PdfPage`.
##### getAnnotations()
```
public final PdfAnnotationCollection getAnnotations()
```

Gets the collection of all annotations of this `PdfPage`.

**Returns:**
PdfAnnotationCollection - The collection of all annotations of this `PdfPage`.
##### getAsposePdfPage()
```
public final Page getAsposePdfPage()
```

**Returns:**
com.aspose.pdf.Page
##### getContent()
```
public final PdfContent getContent()
```

**Returns:**
PdfContent
##### getPageRectangle()
```
public final Rectangle getPageRectangle()
```

**Returns:**
Rectangle
##### addArtifactWatermark(Watermark watermark)
```
public final void addArtifactWatermark(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### addAnnotationWatermark(Watermark watermark, boolean isPrintOnly)
```
public final void addAnnotationWatermark(Watermark watermark, boolean isPrintOnly)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| isPrintOnly | boolean |  |

##### rasterize(int horizontalResolution, int verticalResolution, int imageFormat)
```
public void rasterize(int horizontalResolution, int verticalResolution, int imageFormat)
```

Converts page content into an image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| horizontalResolution | int | Horizontal image resolution. |
| verticalResolution | int | Vertical image resolution. |
| imageFormat | int | Image format. |

##### addArtifactToCollection(Artifact artifact)
```
public final void addArtifactToCollection(Artifact artifact)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| artifact | com.aspose.pdf.Artifact |  |

##### addAnnotationToCollection(Annotation annotation)
```
public final void addAnnotationToCollection(Annotation annotation)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotation | com.aspose.pdf.Annotation |  |

### PdfPageCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfpagecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class PdfPageCollection extends ReadOnlyListBase<PdfPage>
```

Represents a collection of pages in a pdf content.

This collection contains the items of `PdfPage` type.

### PdfPageMarginType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfpagemargintype.md

**Inheritance:**
java.lang.Object
```
public final class PdfPageMarginType
```

Represents pdf crop margins to be used during watermark adding.
#### Fields

| Field | Description |
| --- | --- |
| BleedBox | Pdf BleedBox is used as watermarking area. |
| TrimBox | Pdf TrimBox is used as watermarking area. |
| ArtBox | Pdf ArtBox is used as watermarking area. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `PdfPageMarginType` value. |
| parse(String value) | Parses a string to a `PdfPageMarginType` enumeration value. |
##### BleedBox
```
public static final int BleedBox
```

Pdf BleedBox is used as watermarking area.

##### TrimBox
```
public static final int TrimBox
```

Pdf TrimBox is used as watermarking area.

##### ArtBox
```
public static final int ArtBox
```

Pdf ArtBox is used as watermarking area.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `PdfPageMarginType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `PdfPageMarginType` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `PdfPageMarginType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `PdfPageMarginType` enumeration value.

### PdfPermissions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfpermissions.md

**Inheritance:**
java.lang.Object
```
public final class PdfPermissions
```

Represents user's permissions for a pdf document.
#### Fields

| Field | Description |
| --- | --- |
| PrintDocument | Print the content. |
| ModifyContent | Modify the content. |
| ExtractContent | Copy or otherwise extract text and graphics from the document. |
| ModifyTextAnnotations | Add or modify text annotations. |
| FillForm | Fill in existing interactive form fields. |
| ExtractContentWithDisabilities | Extract text and graphics. |
| AssembleDocument | Assemble the content. |
| PrintingQuality | Print the content to a representation from which a faithful digital copy of the PDF document could be generated. |
##### PrintDocument
```
public static final int PrintDocument
```

Print the content.

Security handlers of revision 2: Print the content.

Security handlers of revision 3 or greater: Print the content (possibly not at the highest quality level, depending on whether `#PrintingQuality.PrintingQuality` is also set).

##### ModifyContent
```
public static final int ModifyContent
```

Modify the content.

Modify the contents of the document by operations other than those controlled by `#ModifyTextAnnotations.ModifyTextAnnotations`, `#FillForm.FillForm`.

##### ExtractContent
```
public static final int ExtractContent
```

Copy or otherwise extract text and graphics from the document.

Security handlers of revision 2: Copy or otherwise extract text and graphics from the content, including extracting text and graphics (in support of accessibility to users with disabilities or for other purposes).

Security handlers of revision 3 or greater: Copy or otherwise extract text and graphics from the content by operations other than that controlled by `#ExtractContentWithDisabilities.ExtractContentWithDisabilities`.

##### ModifyTextAnnotations
```
public static final int ModifyTextAnnotations
```

Add or modify text annotations.

Add or modify text annotations, fill in interactive form fields, and, if `#ModifyContent.ModifyContent` is also set, create or modify interactive form fields (including signature fields).

##### FillForm
```
public static final int FillForm
```

Fill in existing interactive form fields.

Security handlers of revision 3 or greater: Fill in existing interactive form fields (including signature fields), even if `#ModifyTextAnnotations.ModifyTextAnnotations` is clear.

##### ExtractContentWithDisabilities
```
public static final int ExtractContentWithDisabilities
```

Extract text and graphics.

Security handlers of revision 3 or greater: Extract text and graphics (in support of accessibility to users with disabilities or for other purposes).

##### AssembleDocument
```
public static final int AssembleDocument
```

Assemble the content.

Security handlers of revision 3 or greater: Assemble the content (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if `#ModifyContent.ModifyContent` is clear.

##### PrintingQuality
```
public static final int PrintingQuality
```

Print the content to a representation from which a faithful digital copy of the PDF document could be generated.

Security handlers of revision 3 or greater: Print the content to a representation from which a faithful digital copy of the PDF document could be generated. When this bit is clear (and `#PrintDocument.PrintDocument` is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.

### PdfShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IRotatableTwoDObject
```
public abstract class PdfShape extends ShapeSearchAdapter implements IRotatableTwoDObject
```

Provides base class for XObjects, Artifacts and Annotations.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the text of this `PdfShape`. |
| setText(String value) | Gets or sets the text of this `PdfShape`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `PdfShape`. |
| getImage() | Gets the image of this `PdfShape`. |
| setImage(PdfWatermarkableImage value) | Sets the image of this `PdfShape`. |
| getX() | Gets the x-coordinate of the object. |
| getY() | Gets the y-coordinate of the object. |
| getWidth() | Gets the width of the object. |
| getHeight() | Gets the height of the object. |
| getRotateAngle() | Gets the rotate angle of the object in degrees. |
| getOuterForm() |  |
| extractImageAppearance() |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
| getFormattedTextFragmentsForSearch() |  |
| getImageForSearch() |  |
| setFoundWatermarkImage(byte[] imageData) |  |
##### getText()
```
public String getText()
```

Gets the text of this `PdfShape`.

**Returns:**
java.lang.String - The text of this `PdfShape`.
##### setText(String value)
```
public void setText(String value)
```

Gets or sets the text of this `PdfShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `PdfShape`. |

##### getFormattedTextFragments()
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `PdfShape`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `PdfShape`.
##### getImage()
```
public final PdfWatermarkableImage getImage()
```

Gets the image of this `PdfShape`.

**Returns:**
PdfWatermarkableImage - The image of this `PdfShape`.
##### setImage(PdfWatermarkableImage value)
```
public final void setImage(PdfWatermarkableImage value)
```

Sets the image of this `PdfShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PdfWatermarkableImage | The image of this `PdfShape`. |

##### getX()
```
public abstract double getX()
```

Gets the x-coordinate of the object.

**Returns:**
double - The x-coordinate of the object.
##### getY()
```
public abstract double getY()
```

Gets the y-coordinate of the object.

**Returns:**
double - The y-coordinate of the object.
##### getWidth()
```
public abstract double getWidth()
```

Gets the width of the object.

**Returns:**
double - The width of the object.
##### getHeight()
```
public abstract double getHeight()
```

Gets the height of the object.

**Returns:**
double - The height of the object.
##### getRotateAngle()
```
public abstract double getRotateAngle()
```

Gets the rotate angle of the object in degrees.

**Returns:**
double - The rotate angle of the object in degrees.
##### getOuterForm()
```
public abstract XForm getOuterForm()
```

**Returns:**
com.aspose.pdf.XForm
##### extractImageAppearance()
```
public PdfXImageAppearance extractImageAppearance()
```

**Returns:**
PdfXImageAppearance
##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

### PdfShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfshapeformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection, com.groupdocs.watermark.contents.PdfFormattedTextFragmentCollection
```
public class PdfShapeFormattedTextFragmentCollection extends PdfFormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation.

This collection contains the items of `PdfFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| setText(String text) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### PdfTextFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdftextformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection, com.groupdocs.watermark.contents.PdfFormattedTextFragmentCollection
```
public class PdfTextFormattedTextFragmentCollection extends PdfFormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a pdf content main text.

This collection contains the items of `PdfFormattedTextFragment` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextFormattedTextFragmentCollection(TextFragment textFragment) |  |
#### Methods

| Method | Description |
| --- | --- |
| setText(String text) |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### PdfTextFormattedTextFragmentCollection(TextFragment textFragment)
```
public PdfTextFormattedTextFragmentCollection(TextFragment textFragment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| textFragment | com.aspose.pdf.TextFragment |  |

##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### PdfWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class PdfWatermarkableImage extends WatermarkableImage
```

Represents an image inside a Pdf document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfWatermarkableImage(byte[] imageData) | Initializes a new instance of the `PdfWatermarkableImage` class using specified image data. |
#### Methods

| Method | Description |
| --- | --- |
| fetchOrCreate(XImageCollection imageCollection, String nameInCollection, PdfContent content) |  |
##### PdfWatermarkableImage(byte[] imageData)
```
public PdfWatermarkableImage(byte[] imageData)
```

Initializes a new instance of the `PdfWatermarkableImage` class using specified image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] | The array of unsigned bytes from which to create the `PdfWatermarkableImage`. |

##### fetchOrCreate(XImageCollection imageCollection, String nameInCollection, PdfContent content)
```
public static PdfWatermarkableImage fetchOrCreate(XImageCollection imageCollection, String nameInCollection, PdfContent content)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageCollection | com.aspose.pdf.XImageCollection |  |
| nameInCollection | java.lang.String |  |
| content | PdfContent |  |

**Returns:**
PdfWatermarkableImage

### PdfXForm
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfxform.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PdfShape, com.groupdocs.watermark.contents.PdfXObject
```
public class PdfXForm extends PdfXObject
```

Represents an XForm in a pdf content.
#### Methods

| Method | Description |
| --- | --- |
| getOuterForm() |  |
##### getOuterForm()
```
public XForm getOuterForm()
```

**Returns:**
com.aspose.pdf.XForm

### PdfXImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfximage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PdfShape, com.groupdocs.watermark.contents.PdfXObject
```
public class PdfXImage extends PdfXObject
```

Represents an XImage in a pdf content.
#### Methods

| Method | Description |
| --- | --- |
| getOuterForm() |  |
| extractImageAppearance() |  |
##### getOuterForm()
```
public XForm getOuterForm()
```

**Returns:**
com.aspose.pdf.XForm
##### extractImageAppearance()
```
public PdfXImageAppearance extractImageAppearance()
```

**Returns:**
PdfXImageAppearance

### PdfXObject
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfxobject.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PdfShape
```
public abstract class PdfXObject extends PdfShape
```

Represents an XObject in a pdf document.

**Learn more:**

 *  [Working with XObjects][]

[Working with XObjects]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-WorkingwithXObjects
#### Methods

| Method | Description |
| --- | --- |
| getPage() | Gets the parent page of this `PdfXObject`. |
| getX() | Gets the horizontal offset of this `PdfXObject` from page left border in points. |
| getY() | Gets the vertical offset of this `PdfXObject` from page bottom border in points. |
| getWidth() | Gets the width of this `PdfXObject` in points. |
| getHeight() | Gets the height of this `PdfXObject` in points. |
| getRotateAngle() | Gets the rotate angle of this `PdfXObject` in degrees. |
| getMatrix() |  |
##### getPage()
```
public final PdfPage getPage()
```

Gets the parent page of this `PdfXObject`.

**Returns:**
PdfPage - The parent page of this `PdfXObject`.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `PdfXObject` from page left border in points.

**Returns:**
double - The x-coordinate of this `PdfXObject`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `PdfXObject` from page bottom border in points.

**Returns:**
double - The y-coordinate of this `PdfXObject`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PdfXObject` in points.

**Returns:**
double - The width of this `PdfXObject` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PdfXObject` in points.

**Returns:**
double - The height of this `PdfXObject` in points.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PdfXObject` in degrees.

**Returns:**
double - The rotate angle of this `PdfXObject` in degrees.
##### getMatrix()
```
public final Matrix getMatrix()
```

**Returns:**
com.aspose.pdf.Matrix

### PdfXObjectCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/pdfxobjectcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PdfXObjectCollection extends RemoveOnlyListBase<PdfXObject>
```

Represents a collection of XObjects in a pdf document.

This collection contains the items of `PdfXObject` type.
#### Methods

| Method | Description |
| --- | --- |
| removeFromDocument(PdfXObject item) |  |
##### removeFromDocument(PdfXObject item)
```
public void removeFromDocument(PdfXObject item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PdfXObject |  |

### PresentationBaseShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationbaseshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

**All Implemented Interfaces:**
com.groupdocs.watermark.search.ITwoDObject, com.groupdocs.watermark.contents.IPresentationHyperlinkContainer
```
public abstract class PresentationBaseShape extends ShapeSearchAdapter implements ITwoDObject, IPresentationHyperlinkContainer
```

Provides the abstract base class for shapes of all types in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getPresentation() | Gets the parent presentation of this `PresentationBaseShape`. |
| getImageFillFormat() | Gets the image fill format settings of this `PresentationBaseShape`. |
| getName() | Gets the name of this `PresentationBaseShape`. |
| getAlternativeText() | Gets the descriptive (alternative) text associated with this `PresentationBaseShape`. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text associated with this `PresentationBaseShape`. |
| getId() | Gets the identifier of this `PresentationBaseShape`. |
| getZOrderPosition() | Gets the position of this `PresentationBaseShape` in the z-order. |
| getHyperlink(int actionType) | Gets the hyperlink associated with this `PresentationBaseShape`. |
| setHyperlink(int actionType, String url) | Sets the hyperlink associated with this `PresentationBaseShape`. |
| getX() | Gets the horizontal offset of this `PresentationBaseShape` from presentation left border in points. |
| setX(double value) | Sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points. |
| getY() | Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points. |
| setY(double value) | Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points. |
| getWidth() | Gets the width of this `PresentationBaseShape` in points. |
| setWidth(double value) | Sets the width of this `PresentationBaseShape` in points. |
| getHeight() | Gets the height of this `PresentationBaseShape` in points. |
| setHeight(double value) | Sets the height of this `PresentationBaseShape` in points. |
##### getPresentation()
```
public final PresentationBaseSlide getPresentation()
```

Gets the parent presentation of this `PresentationBaseShape`.

**Returns:**
PresentationBaseSlide - The parent presentation of this `PresentationBaseShape`.
##### getImageFillFormat()
```
public final PresentationImageFillFormat getImageFillFormat()
```

Gets the image fill format settings of this `PresentationBaseShape`.

**Returns:**
PresentationImageFillFormat - The image fill format settings of this `PresentationBaseShape`.
##### getName()
```
public final String getName()
```

Gets the name of this `PresentationBaseShape`.

**Returns:**
java.lang.String - The name of this `PresentationBaseShape`.
##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text associated with this `PresentationBaseShape`.

**Returns:**
java.lang.String - The descriptive (alternative) text associated with this `PresentationBaseShape`.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text associated with this `PresentationBaseShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text associated with this `PresentationBaseShape`. |

##### getId()
```
public final long getId()
```

Gets the identifier of this `PresentationBaseShape`.

**Returns:**
long - The identifier of this `PresentationBaseShape`.
##### getZOrderPosition()
```
public final int getZOrderPosition()
```

Gets the position of this `PresentationBaseShape` in the z-order.

A shape with greater z-order is always in front of a shape with a lower z-order.

**Returns:**
int - The position of this `PresentationBaseShape` in the z-order.
##### getHyperlink(int actionType)
```
public final String getHyperlink(int actionType)
```

Gets the hyperlink associated with this `PresentationBaseShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| actionType | int | The action that activates the hyperlink. |

**Returns:**
java.lang.String - The url of the hyperlink that is activated on specified action.
##### setHyperlink(int actionType, String url)
```
public final void setHyperlink(int actionType, String url)
```

Sets the hyperlink associated with this `PresentationBaseShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| actionType | int | The action that activates the hyperlink. |
| url | java.lang.String | The hyperlink url. |

##### getX()
```
public final double getX()
```

Gets the horizontal offset of this `PresentationBaseShape` from presentation left border in points.

**Returns:**
double - The x-coordinate of this `PresentationBaseShape`.
##### setX(double value)
```
public final void setX(double value)
```

Sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of this `PresentationBaseShape`. |

##### getY()
```
public final double getY()
```

Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points.

**Returns:**
double - The y-coordinate of this `PresentationBaseShape`.
##### setY(double value)
```
public final void setY(double value)
```

Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of this `PresentationBaseShape`. |

##### getWidth()
```
public final double getWidth()
```

Gets the width of this `PresentationBaseShape` in points.

**Returns:**
double - The width of this `PresentationBaseShape` in points.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the width of this `PresentationBaseShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of this `PresentationBaseShape` in points. |

##### getHeight()
```
public final double getHeight()
```

Gets the height of this `PresentationBaseShape` in points.

**Returns:**
double - The height of this `PresentationBaseShape` in points.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the height of this `PresentationBaseShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of this `PresentationBaseShape` in points. |

### PresentationBaseSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationbaseslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public abstract class PresentationBaseSlide extends ContentPart
```

Provides the abstract base class for slides of all types in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getShapes() | Gets the collection of all shapes of the presentation. |
| getCharts() | Gets the collection of all charts on the presentation. |
| getImageFillFormat() | Gets the image fill format settings of the presentation. |
| getAsposeSlidesSlide() |  |
| getWidth() |  |
| getHeight() |  |
| addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects) |  |
##### getShapes()
```
public final PresentationShapeCollection getShapes()
```

Gets the collection of all shapes of the presentation.

**Returns:**
PresentationShapeCollection - The collection of all shapes of the presentation.
##### getCharts()
```
public final PresentationChartCollection getCharts()
```

Gets the collection of all charts on the presentation.

**Returns:**
PresentationChartCollection - The collection of all charts on the presentation.
##### getImageFillFormat()
```
public final PresentationImageFillFormat getImageFillFormat()
```

Gets the image fill format settings of the presentation.

**Returns:**
PresentationImageFillFormat - The image fill format settings of the presentation.
##### getAsposeSlidesSlide()
```
public final IBaseSlide getAsposeSlidesSlide()
```

**Returns:**
com.aspose.slides.IBaseSlide
##### getWidth()
```
public double getWidth()
```

**Returns:**
double
##### getHeight()
```
public double getHeight()
```

**Returns:**
double
##### addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects)
```
public final void addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | PresentationShapeSettings |  |
| effects | IPresentationWatermarkEffects |  |

### PresentationChart
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationchart.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PresentationBaseShape
```
public class PresentationChart extends PresentationBaseShape
```

Represents a chart in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getImageForSearch() |  |
##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage

### PresentationChartCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationchartcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class PresentationChartCollection extends ReadOnlyListBase<PresentationChart>
```

Represents a collection of charts in a PowerPoint document.

This collection contains the items of `PresentationChart` type.

### PresentationContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IEncryptable
```
public class PresentationContent extends Content implements IEncryptable
```

Represents a PowerPoint document where a watermark can be placed.

**Learn more:**

 *  [Add watermarks to presentation documents][]
 *  [Working with slide backgrounds][]

The following example demonstrates how to load and save PowerPoint document of any supported type.

> ```
> ```
>
>    PresentationLoadOptions loadOptions = new PresentationLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\input.ppt", loadOptions);
>
>    // Use add method to add watermark to a particular slide or all slides.
>
>    // Save changes.
>    watermarker.save("D:\\output.ppt");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
[Working with slide backgrounds]: https://docs.groupdocs.com/display/watermarkjava/Working+with+slide+backgrounds
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PresentationLoadOptions presentationLoadOptions, IPresentationInfo presentationInfo, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getSlideWidth() | Gets the width of a slide in points. |
| getSlideHeight() | Gets the height of a slide in points. |
| getNotesSlideWidth() | Gets the width of a notes slide in points. |
| getNotesSlideHeight() | Gets the height of a notes slide in points. |
| getSlides() | Gets the collection of all slides of this `PresentationContent`. |
| getMasterSlides() | Gets the collection of all master slides of this `PresentationContent`. |
| getLayoutSlides() | Gets the collection of all layout slides of this `PresentationContent`. |
| getMasterNotesSlide() | Gets the master slide for all notes slides of this `PresentationContent`. |
| getMasterHandoutSlide() | Gets the master handout slide of this `PresentationContent`. |
| getAsposeSlidesPresentation() |  |
| addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects) |  |
| encrypt(String password) | Encrypts the document. |
| decrypt() | Decrypts the document. |
| setWriteProtection(String password) |  |
| removeWriteProtection() |  |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| getDocumentInfo() |  |
| getFileType() |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### PresentationContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PresentationLoadOptions presentationLoadOptions, IPresentationInfo presentationInfo, WatermarkerSettings watermarkerSettings)
```
public PresentationContent(StreamContainer stream, StrategyManager<Integer> strategyManager, PresentationLoadOptions presentationLoadOptions, IPresentationInfo presentationInfo, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| presentationLoadOptions | PresentationLoadOptions |  |
| presentationInfo | com.aspose.slides.IPresentationInfo |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getSlideWidth()
```
public final double getSlideWidth()
```

Gets the width of a slide in points.

**Returns:**
double - The width of a slide in points.
##### getSlideHeight()
```
public final double getSlideHeight()
```

Gets the height of a slide in points.

**Returns:**
double - The height of a slide in points.
##### getNotesSlideWidth()
```
public final double getNotesSlideWidth()
```

Gets the width of a notes slide in points.

**Returns:**
double - The width of a notes slide in points.
##### getNotesSlideHeight()
```
public final double getNotesSlideHeight()
```

Gets the height of a notes slide in points.

**Returns:**
double - The height of a notes slide in points.
##### getSlides()
```
public final PresentationSlideCollection getSlides()
```

Gets the collection of all slides of this `PresentationContent`.

**Returns:**
PresentationSlideCollection - The collection of all slides of this `PresentationContent`.
##### getMasterSlides()
```
public final PresentationMasterSlideCollection getMasterSlides()
```

Gets the collection of all master slides of this `PresentationContent`.

**Returns:**
PresentationMasterSlideCollection - The collection of all master slides of this `PresentationContent`.
##### getLayoutSlides()
```
public final PresentationLayoutSlideCollection getLayoutSlides()
```

Gets the collection of all layout slides of this `PresentationContent`.

**Returns:**
PresentationLayoutSlideCollection - The collection of all layout slides of this `PresentationContent`.
##### getMasterNotesSlide()
```
public final PresentationMasterNotesSlide getMasterNotesSlide()
```

Gets the master slide for all notes slides of this `PresentationContent`.

**Returns:**
PresentationMasterNotesSlide - The master slide for all notes slides of this `PresentationContent`.
##### getMasterHandoutSlide()
```
public final PresentationMasterHandoutSlide getMasterHandoutSlide()
```

Gets the master handout slide of this `PresentationContent`.

**Returns:**
PresentationMasterHandoutSlide - The master handout slide of this `PresentationContent`.
##### getAsposeSlidesPresentation()
```
public final Presentation getAsposeSlidesPresentation()
```

**Returns:**
com.aspose.slides.Presentation
##### addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects)
```
public final void addWatermark(Watermark watermark, PresentationShapeSettings shapeSettings, IPresentationWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | PresentationShapeSettings |  |
| effects | IPresentationWatermarkEffects |  |

##### encrypt(String password)
```
public final void encrypt(String password)
```

Encrypts the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password that will be required to open the document. |

##### decrypt()
```
public final void decrypt()
```

Decrypts the document.

##### setWriteProtection(String password)
```
public final void setWriteProtection(String password)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String |  |

##### removeWriteProtection()
```
public final void removeWriteProtection()
```

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### PresentationFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment

**All Implemented Interfaces:**
com.groupdocs.watermark.contents.IPresentationHyperlinkContainer
```
public class PresentationFormattedTextFragment extends FormattedTextFragment implements IPresentationHyperlinkContainer
```

Represents a fragment of formatted text in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
| getHyperlink(int actionType) | Gets the hyperlink associated with the text. |
| setHyperlink(int actionType, String url) | Sets the hyperlink associated with the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.
##### getHyperlink(int actionType)
```
public final String getHyperlink(int actionType)
```

Gets the hyperlink associated with the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| actionType | int | The action that activates the hyperlink. |

**Returns:**
java.lang.String - The url of the hyperlink that is activated on specified action.
##### setHyperlink(int actionType, String url)
```
public final void setHyperlink(int actionType, String url)
```

Sets the hyperlink associated with the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| actionType | int | The action that activates the hyperlink. |
| url | java.lang.String | The hyperlink url. |

### PresentationFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class PresentationFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a PowerPoint document.

This collection contains the items of `PresentationFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
| setText(String text) |  |
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

### PresentationHyperlinkActionType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationhyperlinkactiontype.md

**Inheritance:**
java.lang.Object
```
public final class PresentationHyperlinkActionType
```

Specifies hyperlink action type.
#### Fields

| Field | Description |
| --- | --- |
| MouseClick | Hyperlink is activated on mouse click. |
| MouseOver | Hyperlink is activated on mouse over. |
##### MouseClick
```
public static final int MouseClick
```

Hyperlink is activated on mouse click.

##### MouseOver
```
public static final int MouseOver
```

Hyperlink is activated on mouse over.

### PresentationImageFillFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationimagefillformat.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageFillFormat
```
public class PresentationImageFillFormat extends OfficeImageFillFormat<PresentationWatermarkableImage>
```

Represents the image fill format settings in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getTileAsTexture() | Gets a value indicating whether the image is tiled across the background. |
| setTileAsTexture(boolean value) | Sets a value indicating whether the image is tiled across the background. |
| getTransparency() | Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| setTransparency(double value) | Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(PresentationWatermarkableImage value) | Sets the background image. |
##### getTileAsTexture()
```
public boolean getTileAsTexture()
```

Gets a value indicating whether the image is tiled across the background.

**Returns:**
boolean - True if the image is tiled across the background; otherwise, false (the image is stretched). The default value is false.
##### setTileAsTexture(boolean value)
```
public void setTileAsTexture(boolean value)
```

Sets a value indicating whether the image is tiled across the background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if the image is tiled across the background; otherwise, false (the image is stretched). The default value is false. |

##### getTransparency()
```
public double getTransparency()
```

Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Returns:**
double - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
##### setTransparency(double value)
```
public void setTransparency(double value)
```

Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

##### getBackgroundImage()
```
public PresentationWatermarkableImage getBackgroundImage()
```

Gets the background image.

**Returns:**
PresentationWatermarkableImage - The background image. Returns null if the image is not set.
##### setBackgroundImage(PresentationWatermarkableImage value)
```
public void setBackgroundImage(PresentationWatermarkableImage value)
```

Sets the background image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PresentationWatermarkableImage | The background image. Returns null if the image is not set. |

### PresentationLayoutSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationlayoutslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationLayoutSlide extends PresentationBaseSlide
```

Represents a PowerPoint content layout slide.
#### Methods

| Method | Description |
| --- | --- |
| getMasterSlide() | Gets the master slide for this `PresentationLayoutSlide`. |
##### getMasterSlide()
```
public final PresentationMasterSlide getMasterSlide()
```

Gets the master slide for this `PresentationLayoutSlide`.

**Returns:**
PresentationMasterSlide - The master slide for this `PresentationLayoutSlide`.

### PresentationLayoutSlideCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationlayoutslidecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class PresentationLayoutSlideCollection extends ReadOnlyListBase<PresentationLayoutSlide>
```

Represents a collection of layout slides in a PowerPoint document.

This collection contains the items of `PresentationLayoutSlide` type.

### PresentationMasterHandoutSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationmasterhandoutslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationMasterHandoutSlide extends PresentationBaseSlide
```

Represents a master handout slide in a PowerPoint content.

### PresentationMasterNotesSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationmasternotesslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationMasterNotesSlide extends PresentationBaseSlide
```

Represents a master slide for all notes slides in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() |  |
| getHeight() |  |
##### getWidth()
```
public double getWidth()
```

**Returns:**
double
##### getHeight()
```
public double getHeight()
```

**Returns:**
double

### PresentationMasterSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationmasterslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationMasterSlide extends PresentationBaseSlide
```

Represents a PowerPoint document master slide.

### PresentationMasterSlideCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationmasterslidecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class PresentationMasterSlideCollection extends ReadOnlyListBase<PresentationMasterSlide>
```

Represents a collection of master slides in a PowerPoint document.

This collection contains the items of `PresentationMasterSlide` type.

### PresentationNotesSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationnotesslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationNotesSlide extends PresentationBaseSlide
```

Represents a PowerPoint document notes slide.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() |  |
| getHeight() |  |
##### getWidth()
```
public double getWidth()
```

**Returns:**
double
##### getHeight()
```
public double getHeight()
```

**Returns:**
double

### PresentationShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter, com.groupdocs.watermark.contents.PresentationBaseShape

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IRotatableTwoDObject
```
public class PresentationShape extends PresentationBaseShape implements IRotatableTwoDObject
```

Represents a drawing shape in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getRotateAngle() | Gets the rotate angle of this `PresentationShape` in degrees. |
| setRotateAngle(double value) | Sets the rotate angle of this `PresentationShape` in degrees. |
| getText() | Gets the text of this `PresentationShape`. |
| setText(String value) | Sets the text of this `PresentationShape`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `PresentationShape`. |
| getShapeType() | Gets the shape geometry preset type. |
| getImage() | Gets the image of this `PresentationShape`. |
| setImage(PresentationWatermarkableImage value) | Sets the image of this `PresentationShape`. |
| getImageForSearch() |  |
| setFoundWatermarkImage(byte[] imageData) |  |
| getFormattedTextFragmentsForSearch() |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
##### getRotateAngle()
```
public final double getRotateAngle()
```

Gets the rotate angle of this `PresentationShape` in degrees.

**Returns:**
double - The rotate angle of this `PresentationShape` in degrees.
##### setRotateAngle(double value)
```
public final void setRotateAngle(double value)
```

Sets the rotate angle of this `PresentationShape` in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rotate angle of this `PresentationShape` in degrees. |

##### getText()
```
public final String getText()
```

Gets the text of this `PresentationShape`.

**Returns:**
java.lang.String - The text of this `PresentationShape`.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text of this `PresentationShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `PresentationShape`. |

##### getFormattedTextFragments()
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `PresentationShape`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `PresentationShape`.
##### getShapeType()
```
public final int getShapeType()
```

Gets the shape geometry preset type.

**Returns:**
int - The geometry preset type.
##### getImage()
```
public final PresentationWatermarkableImage getImage()
```

Gets the image of this `PresentationShape`.

**Returns:**
PresentationWatermarkableImage - The image of this `PresentationShape` or null if the shape has no image.
##### setImage(PresentationWatermarkableImage value)
```
public final void setImage(PresentationWatermarkableImage value)
```

Sets the image of this `PresentationShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PresentationWatermarkableImage | The image of this `PresentationShape` or null if the image should be removed. |

##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### PresentationShapeCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationshapecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PresentationShapeCollection extends RemoveOnlyListBase<PresentationShape>
```

Represents a collection of drawing shapes in a PowerPoint document.

This collection contains the items of `PresentationShape` type.
#### Methods

| Method | Description |
| --- | --- |
| addShape(IShape shape) |  |
| removeFromDocument(PresentationShape item) |  |
##### addShape(IShape shape)
```
public final void addShape(IShape shape)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | com.aspose.slides.IShape |  |

##### removeFromDocument(PresentationShape item)
```
public void removeFromDocument(PresentationShape item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PresentationShape |  |

### PresentationShapeSettings
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationshapesettings.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeShapeSettings
```
public final class PresentationShapeSettings extends OfficeShapeSettings
```

Represents settings that can be applied to a shape watermark for a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationShapeSettings() | Initializes a new instance of the `PresentationShapeSettings` class. |
#### Fields

| Field | Description |
| --- | --- |
| UnreadableCharacter |  |
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| getProtectWithUnreadableCharacters() | Gets a value indicating whether the text watermark characters are mixed with unreadable characters. |
| setProtectWithUnreadableCharacters(boolean value) | Sets a value indicating whether the text watermark characters are mixed with unreadable characters. |
##### PresentationShapeSettings()
```
public PresentationShapeSettings()
```

Initializes a new instance of the `PresentationShapeSettings` class.

##### UnreadableCharacter
```
public static final char UnreadableCharacter
```

##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in PowerPoint is forbidden.

**Returns:**
boolean - `true` if shape editing is forbidden, `false` if the shape can be edited in PowerPoint.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | `true` if shape editing should be forbidden, `false` if the shape can be edited in PowerPoint. |

##### getProtectWithUnreadableCharacters()
```
public final boolean getProtectWithUnreadableCharacters()
```

Gets a value indicating whether the text watermark characters are mixed with unreadable characters.

This protection applies only when the `#isLocked().isLocked()` returns `true`.

**Returns:**
boolean - A value indicating whether the text watermark characters are mixed with unreadable characters.
##### setProtectWithUnreadableCharacters(boolean value)
```
public final void setProtectWithUnreadableCharacters(boolean value)
```

Sets a value indicating whether the text watermark characters are mixed with unreadable characters.

This protection applies only when the `#isLocked().isLocked()` returns `true`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the text watermark characters are mixed with unreadable characters. |

### PresentationShapeType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationshapetype.md

**Inheritance:**
java.lang.Object
```
public final class PresentationShapeType
```

Represents a shape geometry preset type.
#### Fields

| Field | Description |
| --- | --- |
| NotDefined | UndefinedDocument shape type. |
| Custom | Built-in shape geometry preset type. |
| Line | Built-in shape geometry preset type. |
| LineInverse | Built-in shape geometry preset type. |
| Triangle | Built-in shape geometry preset type. |
| RightTriangle | Built-in shape geometry preset type. |
| Rectangle | Built-in shape geometry preset type. |
| Diamond | Built-in shape geometry preset type. |
| Parallelogram | Built-in shape geometry preset type. |
| Trapezoid | Built-in shape geometry preset type. |
| NonIsoscelesTrapezoid | Built-in shape geometry preset type. |
| Pentagon | Built-in shape geometry preset type. |
| Hexagon | Built-in shape geometry preset type. |
| Heptagon | Built-in shape geometry preset type. |
| Octagon | Built-in shape geometry preset type. |
| Decagon | Built-in shape geometry preset type. |
| Dodecagon | Built-in shape geometry preset type. |
| FourPointedStar | Built-in shape geometry preset type. |
| FivePointedStar | Built-in shape geometry preset type. |
| SixPointedStar | Built-in shape geometry preset type. |
| SevenPointedStar | Built-in shape geometry preset type. |
| EightPointedStar | Built-in shape geometry preset type. |
| TenPointedStar | Built-in shape geometry preset type. |
| TwelvePointedStar | Built-in shape geometry preset type. |
| SixteenPointedStar | Built-in shape geometry preset type. |
| TwentyFourPointedStar | Built-in shape geometry preset type. |
| ThirtyTwoPointedStar | Built-in shape geometry preset type. |
| RoundCornerRectangle | Built-in shape geometry preset type. |
| OneRoundCornerRectangle | Built-in shape geometry preset type. |
| TwoSamesideRoundCornerRectangle | Built-in shape geometry preset type. |
| TwoDiagonalRoundCornerRectangle | Built-in shape geometry preset type. |
| OneSnipOneRoundCornerRectangle | Built-in shape geometry preset type. |
| OneSnipCornerRectangle | Built-in shape geometry preset type. |
| TwoSamesideSnipCornerRectangle | Built-in shape geometry preset type. |
| TwoDiagonalSnipCornerRectangle | Built-in shape geometry preset type. |
| Plaque | Built-in shape geometry preset type. |
| Ellipse | Built-in shape geometry preset type. |
| Teardrop | Built-in shape geometry preset type. |
| HomePlate | Built-in shape geometry preset type. |
| Chevron | Built-in shape geometry preset type. |
| PieWedge | Built-in shape geometry preset type. |
| Pie | Built-in shape geometry preset type. |
| BlockArc | Built-in shape geometry preset type. |
| Donut | Built-in shape geometry preset type. |
| NoSmoking | Built-in shape geometry preset type. |
| RightArrow | Built-in shape geometry preset type. |
| LeftArrow | Built-in shape geometry preset type. |
| UpArrow | Built-in shape geometry preset type. |
| DownArrow | Built-in shape geometry preset type. |
| StripedRightArrow | Built-in shape geometry preset type. |
| NotchedRightArrow | Built-in shape geometry preset type. |
| BentUpArrow | Built-in shape geometry preset type. |
| LeftRightArrow | Built-in shape geometry preset type. |
| UpDownArrow | Built-in shape geometry preset type. |
| LeftUpArrow | Built-in shape geometry preset type. |
| LeftRightUpArrow | Built-in shape geometry preset type. |
| QuadArrow | Built-in shape geometry preset type. |
| CalloutLeftArrow | Built-in shape geometry preset type. |
| CalloutRightArrow | Built-in shape geometry preset type. |
| CalloutUpArrow | Built-in shape geometry preset type. |
| CalloutDownArrow | Built-in shape geometry preset type. |
| CalloutLeftRightArrow | Built-in shape geometry preset type. |
| CalloutUpDownArrow | Built-in shape geometry preset type. |
| CalloutQuadArrow | Built-in shape geometry preset type. |
| BentArrow | Built-in shape geometry preset type. |
| UTurnArrow | Built-in shape geometry preset type. |
| CircularArrow | Built-in shape geometry preset type. |
| LeftCircularArrow | Built-in shape geometry preset type. |
| LeftRightCircularArrow | Built-in shape geometry preset type. |
| CurvedRightArrow | Built-in shape geometry preset type. |
| CurvedLeftArrow | Built-in shape geometry preset type. |
| CurvedUpArrow | Built-in shape geometry preset type. |
| CurvedDownArrow | Built-in shape geometry preset type. |
| SwooshArrow | Built-in shape geometry preset type. |
| Cube | Built-in shape geometry preset type. |
| Can | Built-in shape geometry preset type. |
| LightningBolt | Built-in shape geometry preset type. |
| Heart | Built-in shape geometry preset type. |
| Sun | Built-in shape geometry preset type. |
| Moon | Built-in shape geometry preset type. |
| SmileyFace | Built-in shape geometry preset type. |
| IrregularSeal1 | Built-in shape geometry preset type. |
| IrregularSeal2 | Built-in shape geometry preset type. |
| FoldedCorner | Built-in shape geometry preset type. |
| Bevel | Built-in shape geometry preset type. |
| Frame | Built-in shape geometry preset type. |
| HalfFrame | Built-in shape geometry preset type. |
| Corner | Built-in shape geometry preset type. |
| DiagonalStripe | Built-in shape geometry preset type. |
| Chord | Built-in shape geometry preset type. |
| CurvedArc | Built-in shape geometry preset type. |
| LeftBracket | Built-in shape geometry preset type. |
| RightBracket | Built-in shape geometry preset type. |
| LeftBrace | Built-in shape geometry preset type. |
| RightBrace | Built-in shape geometry preset type. |
| BracketPair | Built-in shape geometry preset type. |
| BracePair | Built-in shape geometry preset type. |
| StraightConnector1 | Built-in shape geometry preset type. |
| BentConnector2 | Built-in shape geometry preset type. |
| BentConnector3 | Built-in shape geometry preset type. |
| BentConnector4 | Built-in shape geometry preset type. |
| BentConnector5 | Built-in shape geometry preset type. |
| CurvedConnector2 | Built-in shape geometry preset type. |
| CurvedConnector3 | Built-in shape geometry preset type. |
| CurvedConnector4 | Built-in shape geometry preset type. |
| CurvedConnector5 | Built-in shape geometry preset type. |
| Callout1 | Built-in shape geometry preset type. |
| Callout2 | Built-in shape geometry preset type. |
| Callout3 | Built-in shape geometry preset type. |
| Callout1WithAccent | Built-in shape geometry preset type. |
| Callout2WithAccent | Built-in shape geometry preset type. |
| Callout3WithAccent | Built-in shape geometry preset type. |
| Callout1WithBorder | Built-in shape geometry preset type. |
| Callout2WithBorder | Built-in shape geometry preset type. |
| Callout3WithBorder | Built-in shape geometry preset type. |
| Callout1WithBorderAndAccent | Built-in shape geometry preset type. |
| Callout2WithBorderAndAccent | Built-in shape geometry preset type. |
| Callout3WithBorderAndAccent | Built-in shape geometry preset type. |
| CalloutWedgeRectangle | Built-in shape geometry preset type. |
| CalloutWedgeRoundRectangle | Built-in shape geometry preset type. |
| CalloutWedgeEllipse | Built-in shape geometry preset type. |
| CalloutCloud | Built-in shape geometry preset type. |
| Cloud | Built-in shape geometry preset type. |
| Ribbon | Built-in shape geometry preset type. |
| Ribbon2 | Built-in shape geometry preset type. |
| EllipseRibbon | Built-in shape geometry preset type. |
| EllipseRibbon2 | Built-in shape geometry preset type. |
| LeftRightRibbon | Built-in shape geometry preset type. |
| VerticalScroll | Built-in shape geometry preset type. |
| HorizontalScroll | Built-in shape geometry preset type. |
| Wave | Built-in shape geometry preset type. |
| DoubleWave | Built-in shape geometry preset type. |
| Plus | Built-in shape geometry preset type. |
| ProcessFlow | Built-in shape geometry preset type. |
| DecisionFlow | Built-in shape geometry preset type. |
| InputOutputFlow | Built-in shape geometry preset type. |
| PredefinedProcessFlow | Built-in shape geometry preset type. |
| InternalStorageFlow | Built-in shape geometry preset type. |
| DocumentFlow | Built-in shape geometry preset type. |
| MultiDocumentFlow | Built-in shape geometry preset type. |
| TerminatorFlow | Built-in shape geometry preset type. |
| PreparationFlow | Built-in shape geometry preset type. |
| ManualInputFlow | Built-in shape geometry preset type. |
| ManualOperationFlow | Built-in shape geometry preset type. |
| ConnectorFlow | Built-in shape geometry preset type. |
| PunchedCardFlow | Built-in shape geometry preset type. |
| PunchedTapeFlow | Built-in shape geometry preset type. |
| SummingJunctionFlow | Built-in shape geometry preset type. |
| OrFlow | Built-in shape geometry preset type. |
| CollateFlow | Built-in shape geometry preset type. |
| SortFlow | Built-in shape geometry preset type. |
| ExtractFlow | Built-in shape geometry preset type. |
| MergeFlow | Built-in shape geometry preset type. |
| OfflineStorageFlow | Built-in shape geometry preset type. |
| OnlineStorageFlow | Built-in shape geometry preset type. |
| MagneticTapeFlow | Built-in shape geometry preset type. |
| MagneticDiskFlow | Built-in shape geometry preset type. |
| MagneticDrumFlow | Built-in shape geometry preset type. |
| DisplayFlow | Built-in shape geometry preset type. |
| DelayFlow | Built-in shape geometry preset type. |
| AlternateProcessFlow | Built-in shape geometry preset type. |
| OffPageConnectorFlow | Built-in shape geometry preset type. |
| BlankButton | Built-in shape geometry preset type. |
| HomeButton | Built-in shape geometry preset type. |
| HelpButton | Built-in shape geometry preset type. |
| InformationButton | Built-in shape geometry preset type. |
| ForwardOrNextButton | Built-in shape geometry preset type. |
| BackOrPreviousButton | Built-in shape geometry preset type. |
| EndButton | Built-in shape geometry preset type. |
| BeginningButton | Built-in shape geometry preset type. |
| ReturnButton | Built-in shape geometry preset type. |
| DocumentButton | Built-in shape geometry preset type. |
| SoundButton | Built-in shape geometry preset type. |
| MovieButton | Built-in shape geometry preset type. |
| Gear6 | Built-in shape geometry preset type. |
| Gear9 | Built-in shape geometry preset type. |
| Funnel | Built-in shape geometry preset type. |
| PlusMath | Built-in shape geometry preset type. |
| MinusMath | Built-in shape geometry preset type. |
| MultiplyMath | Built-in shape geometry preset type. |
| DivideMath | Built-in shape geometry preset type. |
| EqualMath | Built-in shape geometry preset type. |
| NotEqualMath | Built-in shape geometry preset type. |
| CornerTabs | Built-in shape geometry preset type. |
| SquareTabs | Built-in shape geometry preset type. |
| PlaqueTabs | Built-in shape geometry preset type. |
| ChartX | Built-in shape geometry preset type. |
| ChartStar | Built-in shape geometry preset type. |
| ChartPlus | Built-in shape geometry preset type. |
##### NotDefined
```
public static final int NotDefined
```

UndefinedDocument shape type.

##### Custom
```
public static final int Custom
```

Built-in shape geometry preset type.

##### Line
```
public static final int Line
```

Built-in shape geometry preset type.

##### LineInverse
```
public static final int LineInverse
```

Built-in shape geometry preset type.

##### Triangle
```
public static final int Triangle
```

Built-in shape geometry preset type.

##### RightTriangle
```
public static final int RightTriangle
```

Built-in shape geometry preset type.

##### Rectangle
```
public static final int Rectangle
```

Built-in shape geometry preset type.

##### Diamond
```
public static final int Diamond
```

Built-in shape geometry preset type.

##### Parallelogram
```
public static final int Parallelogram
```

Built-in shape geometry preset type.

##### Trapezoid
```
public static final int Trapezoid
```

Built-in shape geometry preset type.

##### NonIsoscelesTrapezoid
```
public static final int NonIsoscelesTrapezoid
```

Built-in shape geometry preset type.

##### Pentagon
```
public static final int Pentagon
```

Built-in shape geometry preset type.

##### Hexagon
```
public static final int Hexagon
```

Built-in shape geometry preset type.

##### Heptagon
```
public static final int Heptagon
```

Built-in shape geometry preset type.

##### Octagon
```
public static final int Octagon
```

Built-in shape geometry preset type.

##### Decagon
```
public static final int Decagon
```

Built-in shape geometry preset type.

##### Dodecagon
```
public static final int Dodecagon
```

Built-in shape geometry preset type.

##### FourPointedStar
```
public static final int FourPointedStar
```

Built-in shape geometry preset type.

##### FivePointedStar
```
public static final int FivePointedStar
```

Built-in shape geometry preset type.

##### SixPointedStar
```
public static final int SixPointedStar
```

Built-in shape geometry preset type.

##### SevenPointedStar
```
public static final int SevenPointedStar
```

Built-in shape geometry preset type.

##### EightPointedStar
```
public static final int EightPointedStar
```

Built-in shape geometry preset type.

##### TenPointedStar
```
public static final int TenPointedStar
```

Built-in shape geometry preset type.

##### TwelvePointedStar
```
public static final int TwelvePointedStar
```

Built-in shape geometry preset type.

##### SixteenPointedStar
```
public static final int SixteenPointedStar
```

Built-in shape geometry preset type.

##### TwentyFourPointedStar
```
public static final int TwentyFourPointedStar
```

Built-in shape geometry preset type.

##### ThirtyTwoPointedStar
```
public static final int ThirtyTwoPointedStar
```

Built-in shape geometry preset type.

##### RoundCornerRectangle
```
public static final int RoundCornerRectangle
```

Built-in shape geometry preset type.

##### OneRoundCornerRectangle
```
public static final int OneRoundCornerRectangle
```

Built-in shape geometry preset type.

##### TwoSamesideRoundCornerRectangle
```
public static final int TwoSamesideRoundCornerRectangle
```

Built-in shape geometry preset type.

##### TwoDiagonalRoundCornerRectangle
```
public static final int TwoDiagonalRoundCornerRectangle
```

Built-in shape geometry preset type.

##### OneSnipOneRoundCornerRectangle
```
public static final int OneSnipOneRoundCornerRectangle
```

Built-in shape geometry preset type.

##### OneSnipCornerRectangle
```
public static final int OneSnipCornerRectangle
```

Built-in shape geometry preset type.

##### TwoSamesideSnipCornerRectangle
```
public static final int TwoSamesideSnipCornerRectangle
```

Built-in shape geometry preset type.

##### TwoDiagonalSnipCornerRectangle
```
public static final int TwoDiagonalSnipCornerRectangle
```

Built-in shape geometry preset type.

##### Plaque
```
public static final int Plaque
```

Built-in shape geometry preset type.

##### Ellipse
```
public static final int Ellipse
```

Built-in shape geometry preset type.

##### Teardrop
```
public static final int Teardrop
```

Built-in shape geometry preset type.

##### HomePlate
```
public static final int HomePlate
```

Built-in shape geometry preset type.

##### Chevron
```
public static final int Chevron
```

Built-in shape geometry preset type.

##### PieWedge
```
public static final int PieWedge
```

Built-in shape geometry preset type.

##### Pie
```
public static final int Pie
```

Built-in shape geometry preset type.

##### BlockArc
```
public static final int BlockArc
```

Built-in shape geometry preset type.

##### Donut
```
public static final int Donut
```

Built-in shape geometry preset type.

##### NoSmoking
```
public static final int NoSmoking
```

Built-in shape geometry preset type.

##### RightArrow
```
public static final int RightArrow
```

Built-in shape geometry preset type.

##### LeftArrow
```
public static final int LeftArrow
```

Built-in shape geometry preset type.

##### UpArrow
```
public static final int UpArrow
```

Built-in shape geometry preset type.

##### DownArrow
```
public static final int DownArrow
```

Built-in shape geometry preset type.

##### StripedRightArrow
```
public static final int StripedRightArrow
```

Built-in shape geometry preset type.

##### NotchedRightArrow
```
public static final int NotchedRightArrow
```

Built-in shape geometry preset type.

##### BentUpArrow
```
public static final int BentUpArrow
```

Built-in shape geometry preset type.

##### LeftRightArrow
```
public static final int LeftRightArrow
```

Built-in shape geometry preset type.

##### UpDownArrow
```
public static final int UpDownArrow
```

Built-in shape geometry preset type.

##### LeftUpArrow
```
public static final int LeftUpArrow
```

Built-in shape geometry preset type.

##### LeftRightUpArrow
```
public static final int LeftRightUpArrow
```

Built-in shape geometry preset type.

##### QuadArrow
```
public static final int QuadArrow
```

Built-in shape geometry preset type.

##### CalloutLeftArrow
```
public static final int CalloutLeftArrow
```

Built-in shape geometry preset type.

##### CalloutRightArrow
```
public static final int CalloutRightArrow
```

Built-in shape geometry preset type.

##### CalloutUpArrow
```
public static final int CalloutUpArrow
```

Built-in shape geometry preset type.

##### CalloutDownArrow
```
public static final int CalloutDownArrow
```

Built-in shape geometry preset type.

##### CalloutLeftRightArrow
```
public static final int CalloutLeftRightArrow
```

Built-in shape geometry preset type.

##### CalloutUpDownArrow
```
public static final int CalloutUpDownArrow
```

Built-in shape geometry preset type.

##### CalloutQuadArrow
```
public static final int CalloutQuadArrow
```

Built-in shape geometry preset type.

##### BentArrow
```
public static final int BentArrow
```

Built-in shape geometry preset type.

##### UTurnArrow
```
public static final int UTurnArrow
```

Built-in shape geometry preset type.

##### CircularArrow
```
public static final int CircularArrow
```

Built-in shape geometry preset type.

##### LeftCircularArrow
```
public static final int LeftCircularArrow
```

Built-in shape geometry preset type.

##### LeftRightCircularArrow
```
public static final int LeftRightCircularArrow
```

Built-in shape geometry preset type.

##### CurvedRightArrow
```
public static final int CurvedRightArrow
```

Built-in shape geometry preset type.

##### CurvedLeftArrow
```
public static final int CurvedLeftArrow
```

Built-in shape geometry preset type.

##### CurvedUpArrow
```
public static final int CurvedUpArrow
```

Built-in shape geometry preset type.

##### CurvedDownArrow
```
public static final int CurvedDownArrow
```

Built-in shape geometry preset type.

##### SwooshArrow
```
public static final int SwooshArrow
```

Built-in shape geometry preset type.

##### Cube
```
public static final int Cube
```

Built-in shape geometry preset type.

##### Can
```
public static final int Can
```

Built-in shape geometry preset type.

##### LightningBolt
```
public static final int LightningBolt
```

Built-in shape geometry preset type.

##### Heart
```
public static final int Heart
```

Built-in shape geometry preset type.

##### Sun
```
public static final int Sun
```

Built-in shape geometry preset type.

##### Moon
```
public static final int Moon
```

Built-in shape geometry preset type.

##### SmileyFace
```
public static final int SmileyFace
```

Built-in shape geometry preset type.

##### IrregularSeal1
```
public static final int IrregularSeal1
```

Built-in shape geometry preset type.

##### IrregularSeal2
```
public static final int IrregularSeal2
```

Built-in shape geometry preset type.

##### FoldedCorner
```
public static final int FoldedCorner
```

Built-in shape geometry preset type.

##### Bevel
```
public static final int Bevel
```

Built-in shape geometry preset type.

##### Frame
```
public static final int Frame
```

Built-in shape geometry preset type.

##### HalfFrame
```
public static final int HalfFrame
```

Built-in shape geometry preset type.

##### Corner
```
public static final int Corner
```

Built-in shape geometry preset type.

##### DiagonalStripe
```
public static final int DiagonalStripe
```

Built-in shape geometry preset type.

##### Chord
```
public static final int Chord
```

Built-in shape geometry preset type.

##### CurvedArc
```
public static final int CurvedArc
```

Built-in shape geometry preset type.

##### LeftBracket
```
public static final int LeftBracket
```

Built-in shape geometry preset type.

##### RightBracket
```
public static final int RightBracket
```

Built-in shape geometry preset type.

##### LeftBrace
```
public static final int LeftBrace
```

Built-in shape geometry preset type.

##### RightBrace
```
public static final int RightBrace
```

Built-in shape geometry preset type.

##### BracketPair
```
public static final int BracketPair
```

Built-in shape geometry preset type.

##### BracePair
```
public static final int BracePair
```

Built-in shape geometry preset type.

##### StraightConnector1
```
public static final int StraightConnector1
```

Built-in shape geometry preset type.

##### BentConnector2
```
public static final int BentConnector2
```

Built-in shape geometry preset type.

##### BentConnector3
```
public static final int BentConnector3
```

Built-in shape geometry preset type.

##### BentConnector4
```
public static final int BentConnector4
```

Built-in shape geometry preset type.

##### BentConnector5
```
public static final int BentConnector5
```

Built-in shape geometry preset type.

##### CurvedConnector2
```
public static final int CurvedConnector2
```

Built-in shape geometry preset type.

##### CurvedConnector3
```
public static final int CurvedConnector3
```

Built-in shape geometry preset type.

##### CurvedConnector4
```
public static final int CurvedConnector4
```

Built-in shape geometry preset type.

##### CurvedConnector5
```
public static final int CurvedConnector5
```

Built-in shape geometry preset type.

##### Callout1
```
public static final int Callout1
```

Built-in shape geometry preset type.

##### Callout2
```
public static final int Callout2
```

Built-in shape geometry preset type.

##### Callout3
```
public static final int Callout3
```

Built-in shape geometry preset type.

##### Callout1WithAccent
```
public static final int Callout1WithAccent
```

Built-in shape geometry preset type.

##### Callout2WithAccent
```
public static final int Callout2WithAccent
```

Built-in shape geometry preset type.

##### Callout3WithAccent
```
public static final int Callout3WithAccent
```

Built-in shape geometry preset type.

##### Callout1WithBorder
```
public static final int Callout1WithBorder
```

Built-in shape geometry preset type.

##### Callout2WithBorder
```
public static final int Callout2WithBorder
```

Built-in shape geometry preset type.

##### Callout3WithBorder
```
public static final int Callout3WithBorder
```

Built-in shape geometry preset type.

##### Callout1WithBorderAndAccent
```
public static final int Callout1WithBorderAndAccent
```

Built-in shape geometry preset type.

##### Callout2WithBorderAndAccent
```
public static final int Callout2WithBorderAndAccent
```

Built-in shape geometry preset type.

##### Callout3WithBorderAndAccent
```
public static final int Callout3WithBorderAndAccent
```

Built-in shape geometry preset type.

##### CalloutWedgeRectangle
```
public static final int CalloutWedgeRectangle
```

Built-in shape geometry preset type.

##### CalloutWedgeRoundRectangle
```
public static final int CalloutWedgeRoundRectangle
```

Built-in shape geometry preset type.

##### CalloutWedgeEllipse
```
public static final int CalloutWedgeEllipse
```

Built-in shape geometry preset type.

##### CalloutCloud
```
public static final int CalloutCloud
```

Built-in shape geometry preset type.

##### Cloud
```
public static final int Cloud
```

Built-in shape geometry preset type.

##### Ribbon
```
public static final int Ribbon
```

Built-in shape geometry preset type.

##### Ribbon2
```
public static final int Ribbon2
```

Built-in shape geometry preset type.

##### EllipseRibbon
```
public static final int EllipseRibbon
```

Built-in shape geometry preset type.

##### EllipseRibbon2
```
public static final int EllipseRibbon2
```

Built-in shape geometry preset type.

##### LeftRightRibbon
```
public static final int LeftRightRibbon
```

Built-in shape geometry preset type.

##### VerticalScroll
```
public static final int VerticalScroll
```

Built-in shape geometry preset type.

##### HorizontalScroll
```
public static final int HorizontalScroll
```

Built-in shape geometry preset type.

##### Wave
```
public static final int Wave
```

Built-in shape geometry preset type.

##### DoubleWave
```
public static final int DoubleWave
```

Built-in shape geometry preset type.

##### Plus
```
public static final int Plus
```

Built-in shape geometry preset type.

##### ProcessFlow
```
public static final int ProcessFlow
```

Built-in shape geometry preset type.

##### DecisionFlow
```
public static final int DecisionFlow
```

Built-in shape geometry preset type.

##### InputOutputFlow
```
public static final int InputOutputFlow
```

Built-in shape geometry preset type.

##### PredefinedProcessFlow
```
public static final int PredefinedProcessFlow
```

Built-in shape geometry preset type.

##### InternalStorageFlow
```
public static final int InternalStorageFlow
```

Built-in shape geometry preset type.

##### DocumentFlow
```
public static final int DocumentFlow
```

Built-in shape geometry preset type.

##### MultiDocumentFlow
```
public static final int MultiDocumentFlow
```

Built-in shape geometry preset type.

##### TerminatorFlow
```
public static final int TerminatorFlow
```

Built-in shape geometry preset type.

##### PreparationFlow
```
public static final int PreparationFlow
```

Built-in shape geometry preset type.

##### ManualInputFlow
```
public static final int ManualInputFlow
```

Built-in shape geometry preset type.

##### ManualOperationFlow
```
public static final int ManualOperationFlow
```

Built-in shape geometry preset type.

##### ConnectorFlow
```
public static final int ConnectorFlow
```

Built-in shape geometry preset type.

##### PunchedCardFlow
```
public static final int PunchedCardFlow
```

Built-in shape geometry preset type.

##### PunchedTapeFlow
```
public static final int PunchedTapeFlow
```

Built-in shape geometry preset type.

##### SummingJunctionFlow
```
public static final int SummingJunctionFlow
```

Built-in shape geometry preset type.

##### OrFlow
```
public static final int OrFlow
```

Built-in shape geometry preset type.

##### CollateFlow
```
public static final int CollateFlow
```

Built-in shape geometry preset type.

##### SortFlow
```
public static final int SortFlow
```

Built-in shape geometry preset type.

##### ExtractFlow
```
public static final int ExtractFlow
```

Built-in shape geometry preset type.

##### MergeFlow
```
public static final int MergeFlow
```

Built-in shape geometry preset type.

##### OfflineStorageFlow
```
public static final int OfflineStorageFlow
```

Built-in shape geometry preset type.

##### OnlineStorageFlow
```
public static final int OnlineStorageFlow
```

Built-in shape geometry preset type.

##### MagneticTapeFlow
```
public static final int MagneticTapeFlow
```

Built-in shape geometry preset type.

##### MagneticDiskFlow
```
public static final int MagneticDiskFlow
```

Built-in shape geometry preset type.

##### MagneticDrumFlow
```
public static final int MagneticDrumFlow
```

Built-in shape geometry preset type.

##### DisplayFlow
```
public static final int DisplayFlow
```

Built-in shape geometry preset type.

##### DelayFlow
```
public static final int DelayFlow
```

Built-in shape geometry preset type.

##### AlternateProcessFlow
```
public static final int AlternateProcessFlow
```

Built-in shape geometry preset type.

##### OffPageConnectorFlow
```
public static final int OffPageConnectorFlow
```

Built-in shape geometry preset type.

##### BlankButton
```
public static final int BlankButton
```

Built-in shape geometry preset type.

##### HomeButton
```
public static final int HomeButton
```

Built-in shape geometry preset type.

##### HelpButton
```
public static final int HelpButton
```

Built-in shape geometry preset type.

##### InformationButton
```
public static final int InformationButton
```

Built-in shape geometry preset type.

##### ForwardOrNextButton
```
public static final int ForwardOrNextButton
```

Built-in shape geometry preset type.

##### BackOrPreviousButton
```
public static final int BackOrPreviousButton
```

Built-in shape geometry preset type.

##### EndButton
```
public static final int EndButton
```

Built-in shape geometry preset type.

##### BeginningButton
```
public static final int BeginningButton
```

Built-in shape geometry preset type.

##### ReturnButton
```
public static final int ReturnButton
```

Built-in shape geometry preset type.

##### DocumentButton
```
public static final int DocumentButton
```

Built-in shape geometry preset type.

##### SoundButton
```
public static final int SoundButton
```

Built-in shape geometry preset type.

##### MovieButton
```
public static final int MovieButton
```

Built-in shape geometry preset type.

##### Gear6
```
public static final int Gear6
```

Built-in shape geometry preset type.

##### Gear9
```
public static final int Gear9
```

Built-in shape geometry preset type.

##### Funnel
```
public static final int Funnel
```

Built-in shape geometry preset type.

##### PlusMath
```
public static final int PlusMath
```

Built-in shape geometry preset type.

##### MinusMath
```
public static final int MinusMath
```

Built-in shape geometry preset type.

##### MultiplyMath
```
public static final int MultiplyMath
```

Built-in shape geometry preset type.

##### DivideMath
```
public static final int DivideMath
```

Built-in shape geometry preset type.

##### EqualMath
```
public static final int EqualMath
```

Built-in shape geometry preset type.

##### NotEqualMath
```
public static final int NotEqualMath
```

Built-in shape geometry preset type.

##### CornerTabs
```
public static final int CornerTabs
```

Built-in shape geometry preset type.

##### SquareTabs
```
public static final int SquareTabs
```

Built-in shape geometry preset type.

##### PlaqueTabs
```
public static final int PlaqueTabs
```

Built-in shape geometry preset type.

##### ChartX
```
public static final int ChartX
```

Built-in shape geometry preset type.

##### ChartStar
```
public static final int ChartStar
```

Built-in shape geometry preset type.

##### ChartPlus
```
public static final int ChartPlus
```

Built-in shape geometry preset type.

### PresentationSlide
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationslide.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.PresentationBaseSlide
```
public class PresentationSlide extends PresentationBaseSlide
```

Represents a PowerPoint document slide.
#### Methods

| Method | Description |
| --- | --- |
| getLayoutSlide() | Gets the layout slide for this `PresentationSlide`. |
| getMasterSlide() | Gets the master slide for this `PresentationSlide`. |
| getNotesSlide() | Gets the notes slide for this `PresentationSlide`. |
##### getLayoutSlide()
```
public final PresentationLayoutSlide getLayoutSlide()
```

Gets the layout slide for this `PresentationSlide`.

**Returns:**
PresentationLayoutSlide - The layout slide for this `PresentationSlide`.
##### getMasterSlide()
```
public final PresentationMasterSlide getMasterSlide()
```

Gets the master slide for this `PresentationSlide`.

**Returns:**
PresentationMasterSlide - The master slide for this `PresentationSlide`.
##### getNotesSlide()
```
public final PresentationNotesSlide getNotesSlide()
```

Gets the notes slide for this `PresentationSlide`.

**Returns:**
PresentationNotesSlide - The notes slide for this `PresentationSlide`.

### PresentationSlideCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationslidecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class PresentationSlideCollection extends ReadOnlyListBase<PresentationSlide>
```

Represents a collection of slides in a PowerPoint document.

This collection contains the items of `PresentationSlide` type.

### PresentationSlideImageFillFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationslideimagefillformat.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageFillFormat, com.groupdocs.watermark.contents.PresentationImageFillFormat
```
public class PresentationSlideImageFillFormat extends PresentationImageFillFormat
```

Represents the image fill format settings for a slide in a PowerPoint document.
#### Methods

| Method | Description |
| --- | --- |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(PresentationWatermarkableImage value) | Sets the background image. |
##### getBackgroundImage()
```
public PresentationWatermarkableImage getBackgroundImage()
```

Gets the background image.

**Returns:**
PresentationWatermarkableImage - The background image or `null` if the image is not set.
##### setBackgroundImage(PresentationWatermarkableImage value)
```
public void setBackgroundImage(PresentationWatermarkableImage value)
```

Sets the background image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PresentationWatermarkableImage | The background image or `null` if the image should be removed. |

### PresentationWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/presentationwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class PresentationWatermarkableImage extends WatermarkableImage
```

Represents an image inside a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkableImage(byte[] imageData) | Initializes a new instance of the `PresentationWatermarkableImage` class using specified image data. |
#### Methods

| Method | Description |
| --- | --- |
| getAsposeSlidesImage() |  |
| setAsposeSlidesImage(IPPImage value) |  |
##### PresentationWatermarkableImage(byte[] imageData)
```
public PresentationWatermarkableImage(byte[] imageData)
```

Initializes a new instance of the `PresentationWatermarkableImage` class using specified image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] | The array of unsigned bytes from which to create the `PresentationWatermarkableImage`. |

##### getAsposeSlidesImage()
```
public final IPPImage getAsposeSlidesImage()
```

**Returns:**
com.aspose.slides.IPPImage
##### setAsposeSlidesImage(IPPImage value)
```
public final void setAsposeSlidesImage(IPPImage value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.slides.IPPImage |  |

### SpreadsheetAttachment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetattachment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.Attachment

**All Implemented Interfaces:**
com.groupdocs.watermark.search.ITwoDObject
```
public class SpreadsheetAttachment extends Attachment implements ITwoDObject
```

Represents a file attached to an Excel document.
#### Methods

| Method | Description |
| --- | --- |
| getContent() | Gets the attached file content. |
| setContent(byte[] value) | Sets the attached file content. |
| getPreviewImageContent() | Gets the attached file preview image as a byte array. |
| setPreviewImageContent(byte[] value) | Sets the attached file preview image as a byte array. |
| isLink() | Gets a value indicating whether the content contains only a link to the file. |
| getSourceFullName() | Gets the full name of the attached file. |
| getAlternativeText() | Gets the descriptive (alternative) text associated with the attached file. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text associated with the attached file. |
| getAsposeOleObject() |  |
| getX() | Gets the horizontal offset of the attachment frame from worksheet left border in points. |
| setX(double value) | Sets the horizontal offset of the attachment frame from worksheet left border in points. |
| getY() | Gets the vertical offset of the attachment frame from worksheet top border in points. |
| setY(double value) | Sets the vertical offset of the attachment frame from worksheet top border in points. |
| getWidth() | Gets the width of the attachment frame in points. |
| setWidth(double value) | Sets the width of the attachment frame in points. |
| getHeight() | Gets the height of the attachment frame in points. |
| setHeight(double value) | Sets the height of the attachment frame in points. |
| checkImageType() |  |
##### getContent()
```
public byte[] getContent()
```

Gets the attached file content.

**Returns:**
byte[] - The attached file content.
##### setContent(byte[] value)
```
public void setContent(byte[] value)
```

Sets the attached file content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The attached file content. |

##### getPreviewImageContent()
```
public final byte[] getPreviewImageContent()
```

Gets the attached file preview image as a byte array.

**Returns:**
byte[] - The attached file preview image as a byte array.
##### setPreviewImageContent(byte[] value)
```
public final void setPreviewImageContent(byte[] value)
```

Sets the attached file preview image as a byte array.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] | The attached file preview image as a byte array. |

##### isLink()
```
public final boolean isLink()
```

Gets a value indicating whether the content contains only a link to the file.

**Returns:**
boolean - True if the attached file is referenced by a link (the content does not contain attached file content); otherwise, false.
##### getSourceFullName()
```
public final String getSourceFullName()
```

Gets the full name of the attached file.

**Returns:**
java.lang.String - The full name of the attached file.

The extension is used to determine appropriate application to open the file.
##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text associated with the attached file.

**Returns:**
java.lang.String - The descriptive (alternative) text associated with the attached file.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text associated with the attached file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text associated with the attached file. |

##### getAsposeOleObject()
```
public final OleObject getAsposeOleObject()
```

**Returns:**
com.aspose.cells.OleObject
##### getX()
```
public final double getX()
```

Gets the horizontal offset of the attachment frame from worksheet left border in points.

**Returns:**
double - The x-coordinate of the attachment frame.
##### setX(double value)
```
public final void setX(double value)
```

Sets the horizontal offset of the attachment frame from worksheet left border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of the attachment frame. |

##### getY()
```
public final double getY()
```

Gets the vertical offset of the attachment frame from worksheet top border in points.

**Returns:**
double - The y-coordinate of the attachment frame.
##### setY(double value)
```
public final void setY(double value)
```

Sets the vertical offset of the attachment frame from worksheet top border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of the attachment frame. |

##### getWidth()
```
public final double getWidth()
```

Gets the width of the attachment frame in points.

**Returns:**
double - The width of the attachment frame in points.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the width of the attachment frame in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of the attachment frame in points. |

##### getHeight()
```
public final double getHeight()
```

Gets the height of the attachment frame in points.

**Returns:**
double - The height of the attachment frame in points.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the height of the attachment frame in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of the attachment frame in points. |

##### checkImageType()
```
public final void checkImageType()
```

### SpreadsheetAttachmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetattachmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class SpreadsheetAttachmentCollection extends RemoveOnlyListBase<SpreadsheetAttachment>
```

Represents a collection of attachments in an Excel document.

This collection contains the items of `SpreadsheetAttachment` type.
#### Methods

| Method | Description |
| --- | --- |
| addAttachment(byte[] fileContent, String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height) | Adds an attachment to the `SpreadsheetWorksheet`. |
| addLink(String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height) | Adds an attachment by a link (the document will not contain attached file content). |
| removeFromDocument(SpreadsheetAttachment item) |  |
##### addAttachment(byte[] fileContent, String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height)
```
public final void addAttachment(byte[] fileContent, String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height)
```

Adds an attachment to the `SpreadsheetWorksheet`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | byte[] | The content of the file to be attached. |
| sourceFullName | java.lang.String | The full name of the attached file (The extension is used to determine appropriate application to open the file). |
| previewImageContent | byte[] | The attached file preview image as a byte array. |
| x | double | The x-coordinate of the attachment frame (in points). |
| y | double | The y-coordinate of the attachment frame (in points). |
| width | double | The width of the attachment frame in points. |
| height | double | The height of the attachment frame in points. |

##### addLink(String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height)
```
public final void addLink(String sourceFullName, byte[] previewImageContent, double x, double y, double width, double height)
```

Adds an attachment by a link (the document will not contain attached file content).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceFullName | java.lang.String | The linked file path. |
| previewImageContent | byte[] | The attached file preview image as a byte array. |
| x | double | The x-coordinate of the attachment frame (in points). |
| y | double | The y-coordinate of the attachment frame (in points). |
| width | double | The width of the attachment frame in points. |
| height | double | The height of the attachment frame in points. |

##### removeFromDocument(SpreadsheetAttachment item)
```
public void removeFromDocument(SpreadsheetAttachment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | SpreadsheetAttachment |  |

### SpreadsheetAutoShapeType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetautoshapetype.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetAutoShapeType
```

Represents auto shape type.
#### Fields

| Field | Description |
| --- | --- |
| NotPrimitive | Built-in auto shape type. |
| Rectangle | Built-in auto shape type. |
| RoundedRectangle | Built-in auto shape type. |
| Oval | Built-in auto shape type. |
| Diamond | Built-in auto shape type. |
| IsoscelesTriangle | Built-in auto shape type. |
| RightTriangle | Built-in auto shape type. |
| Parallelogram | Built-in auto shape type. |
| Trapezoid | Built-in auto shape type. |
| Hexagon | Built-in auto shape type. |
| Octagon | Built-in auto shape type. |
| Cross | Built-in auto shape type. |
| Star5 | Built-in auto shape type. |
| RightArrow | Built-in auto shape type. |
| HomePlate | Built-in auto shape type. |
| Cube | Built-in auto shape type. |
| Balloon | Built-in auto shape type. |
| Seal | Built-in auto shape type. |
| Arc | Built-in auto shape type. |
| Line | Built-in auto shape type. |
| Plaque | Built-in auto shape type. |
| Can | Built-in auto shape type. |
| Donut | Built-in auto shape type. |
| TextSimple | Built-in auto shape type. |
| TextOctagon | Built-in auto shape type. |
| TextHexagon | Built-in auto shape type. |
| TextCurve | Built-in auto shape type. |
| TextWave | Built-in auto shape type. |
| TextRing | Built-in auto shape type. |
| TextOnCurve | Built-in auto shape type. |
| TextOnRing | Built-in auto shape type. |
| StraightConnector | Built-in auto shape type. |
| BentConnector2 | Built-in auto shape type. |
| ElbowConnector | Built-in auto shape type. |
| BentConnector4 | Built-in auto shape type. |
| BentConnector5 | Built-in auto shape type. |
| CurvedConnector2 | Built-in auto shape type. |
| CurvedConnector | Built-in auto shape type. |
| CurvedConnector4 | Built-in auto shape type. |
| CurvedConnector5 | Built-in auto shape type. |
| LineCalloutNoBorder2 | Built-in auto shape type. |
| LineCalloutNoBorder3 | Built-in auto shape type. |
| LineCalloutNoBorder4 | Built-in auto shape type. |
| LineCalloutWithAccentBar2 | Built-in auto shape type. |
| LineCalloutWithAccentBar3 | Built-in auto shape type. |
| LineCalloutWithAccentBar4 | Built-in auto shape type. |
| LineCalloutWithBorder2 | Built-in auto shape type. |
| LineCalloutWithBorder3 | Built-in auto shape type. |
| LineCalloutWithBorder4 | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar2 | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar3 | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar4 | Built-in auto shape type. |
| DownRibbon | Built-in auto shape type. |
| UpRibbon | Built-in auto shape type. |
| Chevron | Built-in auto shape type. |
| RegularPentagon | Built-in auto shape type. |
| NoSymbol | Built-in auto shape type. |
| Star8 | Built-in auto shape type. |
| Star16 | Built-in auto shape type. |
| Star32 | Built-in auto shape type. |
| RectangularCallout | Built-in auto shape type. |
| RoundedRectangularCallout | Built-in auto shape type. |
| OvalCallout | Built-in auto shape type. |
| Wave | Built-in auto shape type. |
| FoldedCorner | Built-in auto shape type. |
| LeftArrow | Built-in auto shape type. |
| DownArrow | Built-in auto shape type. |
| UpArrow | Built-in auto shape type. |
| LeftRightArrow | Built-in auto shape type. |
| UpDownArrow | Built-in auto shape type. |
| Explosion1 | Built-in auto shape type. |
| Explosion2 | Built-in auto shape type. |
| LightningBolt | Built-in auto shape type. |
| Heart | Built-in auto shape type. |
| PictureFrame | Built-in auto shape type. |
| QuadArrow | Built-in auto shape type. |
| LeftArrowCallout | Built-in auto shape type. |
| RightArrowCallout | Built-in auto shape type. |
| UpArrowCallout | Built-in auto shape type. |
| DownArrowCallout | Built-in auto shape type. |
| LeftRightArrowCallout | Built-in auto shape type. |
| UpDownArrowCallout | Built-in auto shape type. |
| QuadArrowCallout | Built-in auto shape type. |
| Bevel | Built-in auto shape type. |
| LeftBracket | Built-in auto shape type. |
| RightBracket | Built-in auto shape type. |
| LeftBrace | Built-in auto shape type. |
| RightBrace | Built-in auto shape type. |
| LeftUpArrow | Built-in auto shape type. |
| BentUpArrow | Built-in auto shape type. |
| BentArrow | Built-in auto shape type. |
| Star24 | Built-in auto shape type. |
| StripedRightArrow | Built-in auto shape type. |
| NotchedRightArrow | Built-in auto shape type. |
| BlockArc | Built-in auto shape type. |
| SmileyFace | Built-in auto shape type. |
| VerticalScroll | Built-in auto shape type. |
| HorizontalScroll | Built-in auto shape type. |
| CircularArrow | Built-in auto shape type. |
| NotchedCircularArrow | Built-in auto shape type. |
| UTurnArrow | Built-in auto shape type. |
| CurvedRightArrow | Built-in auto shape type. |
| CurvedLeftArrow | Built-in auto shape type. |
| CurvedUpArrow | Built-in auto shape type. |
| CurvedDownArrow | Built-in auto shape type. |
| CloudCallout | Built-in auto shape type. |
| CurvedDownRibbon | Built-in auto shape type. |
| CurvedUpRibbon | Built-in auto shape type. |
| FlowChartProcess | Built-in auto shape type. |
| FlowChartDecision | Built-in auto shape type. |
| FlowChartData | Built-in auto shape type. |
| FlowChartPredefinedProcess | Built-in auto shape type. |
| FlowChartInternalStorage | Built-in auto shape type. |
| FlowChartDocument | Built-in auto shape type. |
| FlowChartMultidocument | Built-in auto shape type. |
| FlowChartTerminator | Built-in auto shape type. |
| FlowChartPreparation | Built-in auto shape type. |
| FlowChartManualInput | Built-in auto shape type. |
| FlowChartManualOperation | Built-in auto shape type. |
| FlowChartConnector | Built-in auto shape type. |
| FlowChartCard | Built-in auto shape type. |
| FlowChartPunchedTape | Built-in auto shape type. |
| FlowChartSummingJunction | Built-in auto shape type. |
| FlowChartOr | Built-in auto shape type. |
| FlowChartCollate | Built-in auto shape type. |
| FlowChartSort | Built-in auto shape type. |
| FlowChartExtract | Built-in auto shape type. |
| FlowChartMerge | Built-in auto shape type. |
| FlowChartOfflineStorage | Built-in auto shape type. |
| FlowChartStoredData | Built-in auto shape type. |
| FlowChartSequentialAccessStorage | Built-in auto shape type. |
| FlowChartMagneticDisk | Built-in auto shape type. |
| FlowChartDirectAccessStorage | Built-in auto shape type. |
| FlowChartDisplay | Built-in auto shape type. |
| FlowChartDelay | Built-in auto shape type. |
| TextPlainText | Built-in auto shape type. |
| TextStop | Built-in auto shape type. |
| TextTriangle | Built-in auto shape type. |
| TextTriangleInverted | Built-in auto shape type. |
| TextChevron | Built-in auto shape type. |
| TextChevronInverted | Built-in auto shape type. |
| TextRingInside | Built-in auto shape type. |
| TextRingOutside | Built-in auto shape type. |
| TextArchUpCurve | Built-in auto shape type. |
| TextArchDownCurve | Built-in auto shape type. |
| TextCircleCurve | Built-in auto shape type. |
| TextButtonCurve | Built-in auto shape type. |
| TextArchUpPour | Built-in auto shape type. |
| TextArchDownPour | Built-in auto shape type. |
| TextCirclePour | Built-in auto shape type. |
| TextButtonPour | Built-in auto shape type. |
| TextCurveUp | Built-in auto shape type. |
| TextCurveDown | Built-in auto shape type. |
| TextCascadeUp | Built-in auto shape type. |
| TextCascadeDown | Built-in auto shape type. |
| TextWave1 | Built-in auto shape type. |
| TextWave2 | Built-in auto shape type. |
| TextDoubleWave1 | Built-in auto shape type. |
| TextDoubleWave2 | Built-in auto shape type. |
| TextInflate | Built-in auto shape type. |
| TextDeflate | Built-in auto shape type. |
| TextInflateBottom | Built-in auto shape type. |
| TextDeflateBottom | Built-in auto shape type. |
| TextInflateTop | Built-in auto shape type. |
| TextDeflateTop | Built-in auto shape type. |
| TextDeflateInflate | Built-in auto shape type. |
| TextDeflateInflateDeflate | Built-in auto shape type. |
| TextFadeRight | Built-in auto shape type. |
| TextFadeLeft | Built-in auto shape type. |
| TextFadeUp | Built-in auto shape type. |
| TextFadeDown | Built-in auto shape type. |
| TextSlantUp | Built-in auto shape type. |
| TextSlantDown | Built-in auto shape type. |
| TextCanUp | Built-in auto shape type. |
| TextCanDown | Built-in auto shape type. |
| FlowChartAlternateProcess | Built-in auto shape type. |
| FlowChartOffpageConnector | Built-in auto shape type. |
| LineCalloutNoBorder1 | Built-in auto shape type. |
| LineCalloutWithAccentBar1 | Built-in auto shape type. |
| LineCalloutWithBorder1 | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar1 | Built-in auto shape type. |
| LeftRightUpArrow | Built-in auto shape type. |
| Sun | Built-in auto shape type. |
| Moon | Built-in auto shape type. |
| DoubleBracket | Built-in auto shape type. |
| DoubleBrace | Built-in auto shape type. |
| Star4 | Built-in auto shape type. |
| DoubleWave | Built-in auto shape type. |
| BlankActionButton | Built-in auto shape type. |
| HomeActionButton | Built-in auto shape type. |
| HelpActionButton | Built-in auto shape type. |
| InformationActionButton | Built-in auto shape type. |
| ForwardNextActionButton | Built-in auto shape type. |
| BackPreviousActionButton | Built-in auto shape type. |
| EndActionButton | Built-in auto shape type. |
| BeginningActionButton | Built-in auto shape type. |
| ReturnActionButton | Built-in auto shape type. |
| DocumentActionButton | Built-in auto shape type. |
| SoundActionButton | Built-in auto shape type. |
| MovieActionButton | Built-in auto shape type. |
| HostControl | Built-in auto shape type. |
| TextBox | Built-in auto shape type. |
| Heptagon | Built-in auto shape type. |
| Decagon | Built-in auto shape type. |
| Dodecagon | Built-in auto shape type. |
| Star6 | Built-in auto shape type. |
| Star7 | Built-in auto shape type. |
| Star10 | Built-in auto shape type. |
| Star12 | Built-in auto shape type. |
| RoundSingleCornerRectangle | Built-in auto shape type. |
| RoundSameSideCornerRectangle | Built-in auto shape type. |
| RoundDiagonalCornerRectangle | Built-in auto shape type. |
| SnipRoundSingleCornerRectangle | Built-in auto shape type. |
| SnipSingleCornerRectangle | Built-in auto shape type. |
| SnipSameSideCornerRectangle | Built-in auto shape type. |
| SnipDiagonalCornerRectangle | Built-in auto shape type. |
| Teardrop | Built-in auto shape type. |
| Pie | Built-in auto shape type. |
| HalfFrame | Built-in auto shape type. |
| LShape | Built-in auto shape type. |
| DiagonalStripe | Built-in auto shape type. |
| Chord | Built-in auto shape type. |
| Cloud | Built-in auto shape type. |
| MathPlus | Built-in auto shape type. |
| MathMinus | Built-in auto shape type. |
| MathMultiply | Built-in auto shape type. |
| MathDivide | Built-in auto shape type. |
| MathEqual | Built-in auto shape type. |
| MathNotEqual | Built-in auto shape type. |
| LineInv | Built-in auto shape type. |
| NonIsoscelesTrapezoid | Built-in auto shape type. |
| PieWedge | Built-in auto shape type. |
| LeftCircularArrow | Built-in auto shape type. |
| LeftRightCircularArrow | Built-in auto shape type. |
| SwooshArrow | Built-in auto shape type. |
| LeftRightRibbon | Built-in auto shape type. |
| TextNoShape | Built-in auto shape type. |
| Gear6 | Built-in auto shape type. |
| Gear9 | Built-in auto shape type. |
| Funnel | Built-in auto shape type. |
| CornerTabs | Built-in auto shape type. |
| SquareTabs | Built-in auto shape type. |
| PlaqueTabs | Built-in auto shape type. |
| ChartX | Built-in auto shape type. |
| ChartStar | Built-in auto shape type. |
| ChartPlus | Built-in auto shape type. |
| Frame | Built-in auto shape type. |
| Model3D | Built-in auto shape type. |
| RoundCallout | There is no such type in Excel. |
| TextArchLeftPour | There is no such type in Excel. |
| TextArchRightPour | There is no such type in Excel. |
| TextArchLeftCurve | There is no such type in Excel. |
| TextArchRightCurve | There is no such type in Excel. |
| Unknown | Unknown auto shape type. |
#### Methods

| Method | Description |
| --- | --- |
| parse(String value) | Parses a string to a `SpreadsheetAutoShapeType` enumeration value. |
| toString(int value) | Returns a string representation of the `SpreadsheetAutoShapeType` value. |
| isDefined(int value) | Checks if a value defined for `SpreadsheetAutoShapeType` enumeration. |
##### NotPrimitive
```
public static final int NotPrimitive
```

Built-in auto shape type.

##### Rectangle
```
public static final int Rectangle
```

Built-in auto shape type.

##### RoundedRectangle
```
public static final int RoundedRectangle
```

Built-in auto shape type.

##### Oval
```
public static final int Oval
```

Built-in auto shape type.

##### Diamond
```
public static final int Diamond
```

Built-in auto shape type.

##### IsoscelesTriangle
```
public static final int IsoscelesTriangle
```

Built-in auto shape type.

##### RightTriangle
```
public static final int RightTriangle
```

Built-in auto shape type.

##### Parallelogram
```
public static final int Parallelogram
```

Built-in auto shape type.

##### Trapezoid
```
public static final int Trapezoid
```

Built-in auto shape type.

##### Hexagon
```
public static final int Hexagon
```

Built-in auto shape type.

##### Octagon
```
public static final int Octagon
```

Built-in auto shape type.

##### Cross
```
public static final int Cross
```

Built-in auto shape type.

##### Star5
```
public static final int Star5
```

Built-in auto shape type.

##### RightArrow
```
public static final int RightArrow
```

Built-in auto shape type.

##### HomePlate
```
public static final int HomePlate
```

Built-in auto shape type.

##### Cube
```
public static final int Cube
```

Built-in auto shape type.

##### Balloon
```
public static final int Balloon
```

Built-in auto shape type.

##### Seal
```
public static final int Seal
```

Built-in auto shape type.

##### Arc
```
public static final int Arc
```

Built-in auto shape type.

##### Line
```
public static final int Line
```

Built-in auto shape type.

##### Plaque
```
public static final int Plaque
```

Built-in auto shape type.

##### Can
```
public static final int Can
```

Built-in auto shape type.

##### Donut
```
public static final int Donut
```

Built-in auto shape type.

##### TextSimple
```
public static final int TextSimple
```

Built-in auto shape type.

##### TextOctagon
```
public static final int TextOctagon
```

Built-in auto shape type.

##### TextHexagon
```
public static final int TextHexagon
```

Built-in auto shape type.

##### TextCurve
```
public static final int TextCurve
```

Built-in auto shape type.

##### TextWave
```
public static final int TextWave
```

Built-in auto shape type.

##### TextRing
```
public static final int TextRing
```

Built-in auto shape type.

##### TextOnCurve
```
public static final int TextOnCurve
```

Built-in auto shape type.

##### TextOnRing
```
public static final int TextOnRing
```

Built-in auto shape type.

##### StraightConnector
```
public static final int StraightConnector
```

Built-in auto shape type.

##### BentConnector2
```
public static final int BentConnector2
```

Built-in auto shape type.

##### ElbowConnector
```
public static final int ElbowConnector
```

Built-in auto shape type.

##### BentConnector4
```
public static final int BentConnector4
```

Built-in auto shape type.

##### BentConnector5
```
public static final int BentConnector5
```

Built-in auto shape type.

##### CurvedConnector2
```
public static final int CurvedConnector2
```

Built-in auto shape type.

##### CurvedConnector
```
public static final int CurvedConnector
```

Built-in auto shape type.

##### CurvedConnector4
```
public static final int CurvedConnector4
```

Built-in auto shape type.

##### CurvedConnector5
```
public static final int CurvedConnector5
```

Built-in auto shape type.

##### LineCalloutNoBorder2
```
public static final int LineCalloutNoBorder2
```

Built-in auto shape type.

##### LineCalloutNoBorder3
```
public static final int LineCalloutNoBorder3
```

Built-in auto shape type.

##### LineCalloutNoBorder4
```
public static final int LineCalloutNoBorder4
```

Built-in auto shape type.

##### LineCalloutWithAccentBar2
```
public static final int LineCalloutWithAccentBar2
```

Built-in auto shape type.

##### LineCalloutWithAccentBar3
```
public static final int LineCalloutWithAccentBar3
```

Built-in auto shape type.

##### LineCalloutWithAccentBar4
```
public static final int LineCalloutWithAccentBar4
```

Built-in auto shape type.

##### LineCalloutWithBorder2
```
public static final int LineCalloutWithBorder2
```

Built-in auto shape type.

##### LineCalloutWithBorder3
```
public static final int LineCalloutWithBorder3
```

Built-in auto shape type.

##### LineCalloutWithBorder4
```
public static final int LineCalloutWithBorder4
```

Built-in auto shape type.

##### LineCalloutWithBorderAndAccentBar2
```
public static final int LineCalloutWithBorderAndAccentBar2
```

Built-in auto shape type.

##### LineCalloutWithBorderAndAccentBar3
```
public static final int LineCalloutWithBorderAndAccentBar3
```

Built-in auto shape type.

##### LineCalloutWithBorderAndAccentBar4
```
public static final int LineCalloutWithBorderAndAccentBar4
```

Built-in auto shape type.

##### DownRibbon
```
public static final int DownRibbon
```

Built-in auto shape type.

##### UpRibbon
```
public static final int UpRibbon
```

Built-in auto shape type.

##### Chevron
```
public static final int Chevron
```

Built-in auto shape type.

##### RegularPentagon
```
public static final int RegularPentagon
```

Built-in auto shape type.

##### NoSymbol
```
public static final int NoSymbol
```

Built-in auto shape type.

##### Star8
```
public static final int Star8
```

Built-in auto shape type.

##### Star16
```
public static final int Star16
```

Built-in auto shape type.

##### Star32
```
public static final int Star32
```

Built-in auto shape type.

##### RectangularCallout
```
public static final int RectangularCallout
```

Built-in auto shape type.

##### RoundedRectangularCallout
```
public static final int RoundedRectangularCallout
```

Built-in auto shape type.

##### OvalCallout
```
public static final int OvalCallout
```

Built-in auto shape type.

##### Wave
```
public static final int Wave
```

Built-in auto shape type.

##### FoldedCorner
```
public static final int FoldedCorner
```

Built-in auto shape type.

##### LeftArrow
```
public static final int LeftArrow
```

Built-in auto shape type.

##### DownArrow
```
public static final int DownArrow
```

Built-in auto shape type.

##### UpArrow
```
public static final int UpArrow
```

Built-in auto shape type.

##### LeftRightArrow
```
public static final int LeftRightArrow
```

Built-in auto shape type.

##### UpDownArrow
```
public static final int UpDownArrow
```

Built-in auto shape type.

##### Explosion1
```
public static final int Explosion1
```

Built-in auto shape type.

##### Explosion2
```
public static final int Explosion2
```

Built-in auto shape type.

##### LightningBolt
```
public static final int LightningBolt
```

Built-in auto shape type.

##### Heart
```
public static final int Heart
```

Built-in auto shape type.

##### PictureFrame
```
public static final int PictureFrame
```

Built-in auto shape type.

##### QuadArrow
```
public static final int QuadArrow
```

Built-in auto shape type.

##### LeftArrowCallout
```
public static final int LeftArrowCallout
```

Built-in auto shape type.

##### RightArrowCallout
```
public static final int RightArrowCallout
```

Built-in auto shape type.

##### UpArrowCallout
```
public static final int UpArrowCallout
```

Built-in auto shape type.

##### DownArrowCallout
```
public static final int DownArrowCallout
```

Built-in auto shape type.

##### LeftRightArrowCallout
```
public static final int LeftRightArrowCallout
```

Built-in auto shape type.

##### UpDownArrowCallout
```
public static final int UpDownArrowCallout
```

Built-in auto shape type.

##### QuadArrowCallout
```
public static final int QuadArrowCallout
```

Built-in auto shape type.

##### Bevel
```
public static final int Bevel
```

Built-in auto shape type.

##### LeftBracket
```
public static final int LeftBracket
```

Built-in auto shape type.

##### RightBracket
```
public static final int RightBracket
```

Built-in auto shape type.

##### LeftBrace
```
public static final int LeftBrace
```

Built-in auto shape type.

##### RightBrace
```
public static final int RightBrace
```

Built-in auto shape type.

##### LeftUpArrow
```
public static final int LeftUpArrow
```

Built-in auto shape type.

##### BentUpArrow
```
public static final int BentUpArrow
```

Built-in auto shape type.

##### BentArrow
```
public static final int BentArrow
```

Built-in auto shape type.

##### Star24
```
public static final int Star24
```

Built-in auto shape type.

##### StripedRightArrow
```
public static final int StripedRightArrow
```

Built-in auto shape type.

##### NotchedRightArrow
```
public static final int NotchedRightArrow
```

Built-in auto shape type.

##### BlockArc
```
public static final int BlockArc
```

Built-in auto shape type.

##### SmileyFace
```
public static final int SmileyFace
```

Built-in auto shape type.

##### VerticalScroll
```
public static final int VerticalScroll
```

Built-in auto shape type.

##### HorizontalScroll
```
public static final int HorizontalScroll
```

Built-in auto shape type.

##### CircularArrow
```
public static final int CircularArrow
```

Built-in auto shape type.

##### NotchedCircularArrow
```
public static final int NotchedCircularArrow
```

Built-in auto shape type.

##### UTurnArrow
```
public static final int UTurnArrow
```

Built-in auto shape type.

##### CurvedRightArrow
```
public static final int CurvedRightArrow
```

Built-in auto shape type.

##### CurvedLeftArrow
```
public static final int CurvedLeftArrow
```

Built-in auto shape type.

##### CurvedUpArrow
```
public static final int CurvedUpArrow
```

Built-in auto shape type.

##### CurvedDownArrow
```
public static final int CurvedDownArrow
```

Built-in auto shape type.

##### CloudCallout
```
public static final int CloudCallout
```

Built-in auto shape type.

##### CurvedDownRibbon
```
public static final int CurvedDownRibbon
```

Built-in auto shape type.

##### CurvedUpRibbon
```
public static final int CurvedUpRibbon
```

Built-in auto shape type.

##### FlowChartProcess
```
public static final int FlowChartProcess
```

Built-in auto shape type.

##### FlowChartDecision
```
public static final int FlowChartDecision
```

Built-in auto shape type.

##### FlowChartData
```
public static final int FlowChartData
```

Built-in auto shape type.

##### FlowChartPredefinedProcess
```
public static final int FlowChartPredefinedProcess
```

Built-in auto shape type.

##### FlowChartInternalStorage
```
public static final int FlowChartInternalStorage
```

Built-in auto shape type.

##### FlowChartDocument
```
public static final int FlowChartDocument
```

Built-in auto shape type.

##### FlowChartMultidocument
```
public static final int FlowChartMultidocument
```

Built-in auto shape type.

##### FlowChartTerminator
```
public static final int FlowChartTerminator
```

Built-in auto shape type.

##### FlowChartPreparation
```
public static final int FlowChartPreparation
```

Built-in auto shape type.

##### FlowChartManualInput
```
public static final int FlowChartManualInput
```

Built-in auto shape type.

##### FlowChartManualOperation
```
public static final int FlowChartManualOperation
```

Built-in auto shape type.

##### FlowChartConnector
```
public static final int FlowChartConnector
```

Built-in auto shape type.

##### FlowChartCard
```
public static final int FlowChartCard
```

Built-in auto shape type.

##### FlowChartPunchedTape
```
public static final int FlowChartPunchedTape
```

Built-in auto shape type.

##### FlowChartSummingJunction
```
public static final int FlowChartSummingJunction
```

Built-in auto shape type.

##### FlowChartOr
```
public static final int FlowChartOr
```

Built-in auto shape type.

##### FlowChartCollate
```
public static final int FlowChartCollate
```

Built-in auto shape type.

##### FlowChartSort
```
public static final int FlowChartSort
```

Built-in auto shape type.

##### FlowChartExtract
```
public static final int FlowChartExtract
```

Built-in auto shape type.

##### FlowChartMerge
```
public static final int FlowChartMerge
```

Built-in auto shape type.

##### FlowChartOfflineStorage
```
public static final int FlowChartOfflineStorage
```

Built-in auto shape type.

##### FlowChartStoredData
```
public static final int FlowChartStoredData
```

Built-in auto shape type.

##### FlowChartSequentialAccessStorage
```
public static final int FlowChartSequentialAccessStorage
```

Built-in auto shape type.

##### FlowChartMagneticDisk
```
public static final int FlowChartMagneticDisk
```

Built-in auto shape type.

##### FlowChartDirectAccessStorage
```
public static final int FlowChartDirectAccessStorage
```

Built-in auto shape type.

##### FlowChartDisplay
```
public static final int FlowChartDisplay
```

Built-in auto shape type.

##### FlowChartDelay
```
public static final int FlowChartDelay
```

Built-in auto shape type.

##### TextPlainText
```
public static final int TextPlainText
```

Built-in auto shape type.

##### TextStop
```
public static final int TextStop
```

Built-in auto shape type.

##### TextTriangle
```
public static final int TextTriangle
```

Built-in auto shape type.

##### TextTriangleInverted
```
public static final int TextTriangleInverted
```

Built-in auto shape type.

##### TextChevron
```
public static final int TextChevron
```

Built-in auto shape type.

##### TextChevronInverted
```
public static final int TextChevronInverted
```

Built-in auto shape type.

##### TextRingInside
```
public static final int TextRingInside
```

Built-in auto shape type.

##### TextRingOutside
```
public static final int TextRingOutside
```

Built-in auto shape type.

##### TextArchUpCurve
```
public static final int TextArchUpCurve
```

Built-in auto shape type.

##### TextArchDownCurve
```
public static final int TextArchDownCurve
```

Built-in auto shape type.

##### TextCircleCurve
```
public static final int TextCircleCurve
```

Built-in auto shape type.

##### TextButtonCurve
```
public static final int TextButtonCurve
```

Built-in auto shape type.

##### TextArchUpPour
```
public static final int TextArchUpPour
```

Built-in auto shape type.

##### TextArchDownPour
```
public static final int TextArchDownPour
```

Built-in auto shape type.

##### TextCirclePour
```
public static final int TextCirclePour
```

Built-in auto shape type.

##### TextButtonPour
```
public static final int TextButtonPour
```

Built-in auto shape type.

##### TextCurveUp
```
public static final int TextCurveUp
```

Built-in auto shape type.

##### TextCurveDown
```
public static final int TextCurveDown
```

Built-in auto shape type.

##### TextCascadeUp
```
public static final int TextCascadeUp
```

Built-in auto shape type.

##### TextCascadeDown
```
public static final int TextCascadeDown
```

Built-in auto shape type.

##### TextWave1
```
public static final int TextWave1
```

Built-in auto shape type.

##### TextWave2
```
public static final int TextWave2
```

Built-in auto shape type.

##### TextDoubleWave1
```
public static final int TextDoubleWave1
```

Built-in auto shape type.

##### TextDoubleWave2
```
public static final int TextDoubleWave2
```

Built-in auto shape type.

##### TextInflate
```
public static final int TextInflate
```

Built-in auto shape type.

##### TextDeflate
```
public static final int TextDeflate
```

Built-in auto shape type.

##### TextInflateBottom
```
public static final int TextInflateBottom
```

Built-in auto shape type.

##### TextDeflateBottom
```
public static final int TextDeflateBottom
```

Built-in auto shape type.

##### TextInflateTop
```
public static final int TextInflateTop
```

Built-in auto shape type.

##### TextDeflateTop
```
public static final int TextDeflateTop
```

Built-in auto shape type.

##### TextDeflateInflate
```
public static final int TextDeflateInflate
```

Built-in auto shape type.

##### TextDeflateInflateDeflate
```
public static final int TextDeflateInflateDeflate
```

Built-in auto shape type.

##### TextFadeRight
```
public static final int TextFadeRight
```

Built-in auto shape type.

##### TextFadeLeft
```
public static final int TextFadeLeft
```

Built-in auto shape type.

##### TextFadeUp
```
public static final int TextFadeUp
```

Built-in auto shape type.

##### TextFadeDown
```
public static final int TextFadeDown
```

Built-in auto shape type.

##### TextSlantUp
```
public static final int TextSlantUp
```

Built-in auto shape type.

##### TextSlantDown
```
public static final int TextSlantDown
```

Built-in auto shape type.

##### TextCanUp
```
public static final int TextCanUp
```

Built-in auto shape type.

##### TextCanDown
```
public static final int TextCanDown
```

Built-in auto shape type.

##### FlowChartAlternateProcess
```
public static final int FlowChartAlternateProcess
```

Built-in auto shape type.

##### FlowChartOffpageConnector
```
public static final int FlowChartOffpageConnector
```

Built-in auto shape type.

##### LineCalloutNoBorder1
```
public static final int LineCalloutNoBorder1
```

Built-in auto shape type.

##### LineCalloutWithAccentBar1
```
public static final int LineCalloutWithAccentBar1
```

Built-in auto shape type.

##### LineCalloutWithBorder1
```
public static final int LineCalloutWithBorder1
```

Built-in auto shape type.

##### LineCalloutWithBorderAndAccentBar1
```
public static final int LineCalloutWithBorderAndAccentBar1
```

Built-in auto shape type.

##### LeftRightUpArrow
```
public static final int LeftRightUpArrow
```

Built-in auto shape type.

##### Sun
```
public static final int Sun
```

Built-in auto shape type.

##### Moon
```
public static final int Moon
```

Built-in auto shape type.

##### DoubleBracket
```
public static final int DoubleBracket
```

Built-in auto shape type.

##### DoubleBrace
```
public static final int DoubleBrace
```

Built-in auto shape type.

##### Star4
```
public static final int Star4
```

Built-in auto shape type.

##### DoubleWave
```
public static final int DoubleWave
```

Built-in auto shape type.

##### BlankActionButton
```
public static final int BlankActionButton
```

Built-in auto shape type.

##### HomeActionButton
```
public static final int HomeActionButton
```

Built-in auto shape type.

##### HelpActionButton
```
public static final int HelpActionButton
```

Built-in auto shape type.

##### InformationActionButton
```
public static final int InformationActionButton
```

Built-in auto shape type.

##### ForwardNextActionButton
```
public static final int ForwardNextActionButton
```

Built-in auto shape type.

##### BackPreviousActionButton
```
public static final int BackPreviousActionButton
```

Built-in auto shape type.

##### EndActionButton
```
public static final int EndActionButton
```

Built-in auto shape type.

##### BeginningActionButton
```
public static final int BeginningActionButton
```

Built-in auto shape type.

##### ReturnActionButton
```
public static final int ReturnActionButton
```

Built-in auto shape type.

##### DocumentActionButton
```
public static final int DocumentActionButton
```

Built-in auto shape type.

##### SoundActionButton
```
public static final int SoundActionButton
```

Built-in auto shape type.

##### MovieActionButton
```
public static final int MovieActionButton
```

Built-in auto shape type.

##### HostControl
```
public static final int HostControl
```

Built-in auto shape type.

##### TextBox
```
public static final int TextBox
```

Built-in auto shape type.

##### Heptagon
```
public static final int Heptagon
```

Built-in auto shape type.

##### Decagon
```
public static final int Decagon
```

Built-in auto shape type.

##### Dodecagon
```
public static final int Dodecagon
```

Built-in auto shape type.

##### Star6
```
public static final int Star6
```

Built-in auto shape type.

##### Star7
```
public static final int Star7
```

Built-in auto shape type.

##### Star10
```
public static final int Star10
```

Built-in auto shape type.

##### Star12
```
public static final int Star12
```

Built-in auto shape type.

##### RoundSingleCornerRectangle
```
public static final int RoundSingleCornerRectangle
```

Built-in auto shape type.

##### RoundSameSideCornerRectangle
```
public static final int RoundSameSideCornerRectangle
```

Built-in auto shape type.

##### RoundDiagonalCornerRectangle
```
public static final int RoundDiagonalCornerRectangle
```

Built-in auto shape type.

##### SnipRoundSingleCornerRectangle
```
public static final int SnipRoundSingleCornerRectangle
```

Built-in auto shape type.

##### SnipSingleCornerRectangle
```
public static final int SnipSingleCornerRectangle
```

Built-in auto shape type.

##### SnipSameSideCornerRectangle
```
public static final int SnipSameSideCornerRectangle
```

Built-in auto shape type.

##### SnipDiagonalCornerRectangle
```
public static final int SnipDiagonalCornerRectangle
```

Built-in auto shape type.

##### Teardrop
```
public static final int Teardrop
```

Built-in auto shape type.

##### Pie
```
public static final int Pie
```

Built-in auto shape type.

##### HalfFrame
```
public static final int HalfFrame
```

Built-in auto shape type.

##### LShape
```
public static final int LShape
```

Built-in auto shape type.

##### DiagonalStripe
```
public static final int DiagonalStripe
```

Built-in auto shape type.

##### Chord
```
public static final int Chord
```

Built-in auto shape type.

##### Cloud
```
public static final int Cloud
```

Built-in auto shape type.

##### MathPlus
```
public static final int MathPlus
```

Built-in auto shape type.

##### MathMinus
```
public static final int MathMinus
```

Built-in auto shape type.

##### MathMultiply
```
public static final int MathMultiply
```

Built-in auto shape type.

##### MathDivide
```
public static final int MathDivide
```

Built-in auto shape type.

##### MathEqual
```
public static final int MathEqual
```

Built-in auto shape type.

##### MathNotEqual
```
public static final int MathNotEqual
```

Built-in auto shape type.

##### LineInv
```
public static final int LineInv
```

Built-in auto shape type.

##### NonIsoscelesTrapezoid
```
public static final int NonIsoscelesTrapezoid
```

Built-in auto shape type.

##### PieWedge
```
public static final int PieWedge
```

Built-in auto shape type.

##### LeftCircularArrow
```
public static final int LeftCircularArrow
```

Built-in auto shape type.

##### LeftRightCircularArrow
```
public static final int LeftRightCircularArrow
```

Built-in auto shape type.

##### SwooshArrow
```
public static final int SwooshArrow
```

Built-in auto shape type.

##### LeftRightRibbon
```
public static final int LeftRightRibbon
```

Built-in auto shape type.

##### TextNoShape
```
public static final int TextNoShape
```

Built-in auto shape type.

##### Gear6
```
public static final int Gear6
```

Built-in auto shape type.

##### Gear9
```
public static final int Gear9
```

Built-in auto shape type.

##### Funnel
```
public static final int Funnel
```

Built-in auto shape type.

##### CornerTabs
```
public static final int CornerTabs
```

Built-in auto shape type.

##### SquareTabs
```
public static final int SquareTabs
```

Built-in auto shape type.

##### PlaqueTabs
```
public static final int PlaqueTabs
```

Built-in auto shape type.

##### ChartX
```
public static final int ChartX
```

Built-in auto shape type.

##### ChartStar
```
public static final int ChartStar
```

Built-in auto shape type.

##### ChartPlus
```
public static final int ChartPlus
```

Built-in auto shape type.

##### Frame
```
public static final int Frame
```

Built-in auto shape type.

##### Model3D
```
public static final int Model3D
```

Built-in auto shape type.

##### RoundCallout
```
public static final int RoundCallout
```

There is no such type in Excel.

##### TextArchLeftPour
```
public static final int TextArchLeftPour
```

There is no such type in Excel.

##### TextArchRightPour
```
public static final int TextArchRightPour
```

There is no such type in Excel.

##### TextArchLeftCurve
```
public static final int TextArchLeftCurve
```

There is no such type in Excel.

##### TextArchRightCurve
```
public static final int TextArchRightCurve
```

There is no such type in Excel.

##### Unknown
```
public static final int Unknown
```

Unknown auto shape type.

##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `SpreadsheetAutoShapeType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `SpreadsheetAutoShapeType` enumeration value.
##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `SpreadsheetAutoShapeType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `SpreadsheetAutoShapeType` value.
##### isDefined(int value)
```
public static final Boolean isDefined(int value)
```

Checks if a value defined for `SpreadsheetAutoShapeType` enumeration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to check. |

**Returns:**
java.lang.Boolean - true if the value is defined, false otherwise.

### SpreadsheetCellFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetcellformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class SpreadsheetCellFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in Excel document cell.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### SpreadsheetCellFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetcellformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class SpreadsheetCellFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in an Excel document cell.

This collection contains the items of `SpreadsheetCellFormattedTextFragment` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetCellFormattedTextFragmentCollection(Cell cell) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
| setText(String text) |  |
##### SpreadsheetCellFormattedTextFragmentCollection(Cell cell)
```
public SpreadsheetCellFormattedTextFragmentCollection(Cell cell)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cell | com.aspose.cells.Cell |  |

##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

### SpreadsheetChart
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetchart.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IHyperlinkContainer, com.groupdocs.watermark.search.ITwoDObject
```
public class SpreadsheetChart implements IHyperlinkContainer, ITwoDObject
```

Represents a chart in an Excel document.
#### Methods

| Method | Description |
| --- | --- |
| getWorksheet() | Gets the parent worksheet of this `SpreadsheetChart`. |
| getId() | Gets the identifier of this `SpreadsheetChart`. |
| getImageFillFormat() | Gets the image fill format settings of this `SpreadsheetChart`. |
| getName() | Gets the name of this `SpreadsheetChart`. |
| getAlternativeText() | Gets the descriptive (alternative) text associated with this `SpreadsheetChart`. |
| getHyperlink() | Gets the hyperlink associated with this `SpreadsheetChart`. |
| setHyperlink(String value) | Sets the hyperlink associated with this `SpreadsheetChart`. |
| getX() | Gets the horizontal offset of this `SpreadsheetChart` from worksheet left border in points. |
| getY() | Gets the vertical offset of this `SpreadsheetChart` from worksheet top border in points. |
| getWidth() | Gets the width of this `SpreadsheetChart` in points. |
| getHeight() | Gets the height of this `SpreadsheetChart` in points. |
##### getWorksheet()
```
public final SpreadsheetWorksheet getWorksheet()
```

Gets the parent worksheet of this `SpreadsheetChart`.

**Returns:**
SpreadsheetWorksheet - The parent worksheet of this `SpreadsheetChart`.
##### getId()
```
public final int getId()
```

Gets the identifier of this `SpreadsheetChart`.

**Returns:**
int - The identifier of this `SpreadsheetChart`.
##### getImageFillFormat()
```
public final SpreadsheetImageFillFormat getImageFillFormat()
```

Gets the image fill format settings of this `SpreadsheetChart`.

**Returns:**
SpreadsheetImageFillFormat - The image fill format settings of this `SpreadsheetChart`.
##### getName()
```
public final String getName()
```

Gets the name of this `SpreadsheetChart`.

**Returns:**
java.lang.String - The name of this `SpreadsheetChart`.
##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text associated with this `SpreadsheetChart`.

**Returns:**
java.lang.String - The descriptive (alternative) text associated with this `SpreadsheetChart`.
##### getHyperlink()
```
public final String getHyperlink()
```

Gets the hyperlink associated with this `SpreadsheetChart`.

**Returns:**
java.lang.String - The hyperlink associated with this `SpreadsheetChart`.
##### setHyperlink(String value)
```
public final void setHyperlink(String value)
```

Sets the hyperlink associated with this `SpreadsheetChart`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink associated with this `SpreadsheetChart`. |

##### getX()
```
public final double getX()
```

Gets the horizontal offset of this `SpreadsheetChart` from worksheet left border in points.

**Returns:**
double - The x-coordinate of this `SpreadsheetChart`.
##### getY()
```
public final double getY()
```

Gets the vertical offset of this `SpreadsheetChart` from worksheet top border in points.

**Returns:**
double - The y-coordinate of this `SpreadsheetChart`.
##### getWidth()
```
public final double getWidth()
```

Gets the width of this `SpreadsheetChart` in points.

**Returns:**
double - The width of this `SpreadsheetChart` in points.
##### getHeight()
```
public final double getHeight()
```

Gets the height of this `SpreadsheetChart` in points.

**Returns:**
double - The height of this `SpreadsheetChart` in points.

### SpreadsheetChartCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetchartcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class SpreadsheetChartCollection extends ReadOnlyListBase<SpreadsheetChart>
```

Represents a collection of charts in an Excel document.

This collection contains the items of `SpreadsheetChart` type.

### SpreadsheetContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IEncryptable
```
public class SpreadsheetContent extends Content implements IEncryptable
```

Represents an Excel document where a watermark can be placed.

**Learn more:**

 *  [Add watermarks to spreadsheet documents][]
 *  [Shapes in spreadsheet document][]
 *  [Working with spreadsheet document attachments][]
 *  [Working with worksheet backgrounds][]
 *  [Working with worksheet headers and footers][]

The following example demonstrates how to load and save Excel content of any supported type.

> ```
> ```
>
>    SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\input.xls", loadOptions);
>
>    // Use add method to add watermark to a particular or all worksheets.
>
>    // Save changes.
>    watermarker.save("D:\\output.xls");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to spreadsheet documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+spreadsheet+documents
[Shapes in spreadsheet document]: https://docs.groupdocs.com/display/watermarkjava/Shapes+in+spreadsheet+document
[Working with spreadsheet document attachments]: https://docs.groupdocs.com/display/watermarkjava/Working+with+spreadsheet+document+attachments
[Working with worksheet backgrounds]: https://docs.groupdocs.com/display/watermarkjava/Working+with+worksheet+backgrounds
[Working with worksheet headers and footers]: https://docs.groupdocs.com/display/watermarkjava/Working+with+worksheet+headers+and+footers
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, SpreadsheetLoadOptions spreadsheetLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheets() | Gets the collection of all worksheets of this `SpreadsheetContent`. |
| getAsposeCellsWorkbook() |  |
| addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects) |  |
| addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight) |  |
| addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings) |  |
| addWatermarkIntoHeaderFooter(Watermark watermark) |  |
| encrypt(String password) | Encrypts the content. |
| decrypt() | Decrypts the document. |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| getDocumentInfo() |  |
| getFileType() |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### SpreadsheetContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, SpreadsheetLoadOptions spreadsheetLoadOptions, WatermarkerSettings watermarkerSettings)
```
public SpreadsheetContent(StreamContainer stream, StrategyManager<Integer> strategyManager, FileFormatInfo fileFormatInfo, SpreadsheetLoadOptions spreadsheetLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| fileFormatInfo | com.aspose.cells.FileFormatInfo |  |
| spreadsheetLoadOptions | SpreadsheetLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getWorksheets()
```
public final SpreadsheetWorksheetCollection getWorksheets()
```

Gets the collection of all worksheets of this `SpreadsheetContent`.

**Returns:**
SpreadsheetWorksheetCollection - The collection of all worksheets of this `SpreadsheetContent`.
##### getAsposeCellsWorkbook()
```
public final Workbook getAsposeCellsWorkbook()
```

**Returns:**
com.aspose.cells.Workbook
##### addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```
public final void addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | SpreadsheetShapeSettings |  |
| effects | ISpreadsheetWatermarkEffects |  |

##### addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
```
public final void addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| backgroundWidth | int |  |
| backgroundHeight | int |  |

##### addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
```
public final void addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | TextWatermark |  |
| shapeSettings | SpreadsheetShapeSettings |  |

##### addWatermarkIntoHeaderFooter(Watermark watermark)
```
public final void addWatermarkIntoHeaderFooter(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### encrypt(String password)
```
public final void encrypt(String password)
```

Encrypts the content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password that will be required to open the document. |

##### decrypt()
```
public final void decrypt()
```

Decrypts the document.

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### SpreadsheetHeaderFooter
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetheaderfooter.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetHeaderFooter
```

Represents a header/footer in an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetHeaderFooter(SpreadsheetWorksheet worksheet, int headerFooterType) |  |
#### Methods

| Method | Description |
| --- | --- |
| getHeaderFooterType() | Gets the type of this `SpreadsheetHeaderFooter`. |
| getSections() | Gets the collection of header/footer sections. |
| getWorksheet() | Gets the parent worksheet of this `SpreadsheetHeaderFooter`. |
##### SpreadsheetHeaderFooter(SpreadsheetWorksheet worksheet, int headerFooterType)
```
public SpreadsheetHeaderFooter(SpreadsheetWorksheet worksheet, int headerFooterType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheet | SpreadsheetWorksheet |  |
| headerFooterType | int |  |

##### getHeaderFooterType()
```
public final int getHeaderFooterType()
```

Gets the type of this `SpreadsheetHeaderFooter`.

**Returns:**
int - The type of this `SpreadsheetHeaderFooter`.
##### getSections()
```
public final SpreadsheetHeaderFooterSectionCollection getSections()
```

Gets the collection of header/footer sections.

**Returns:**
SpreadsheetHeaderFooterSectionCollection - The collection of header/footer sections.
##### getWorksheet()
```
public final SpreadsheetWorksheet getWorksheet()
```

Gets the parent worksheet of this `SpreadsheetHeaderFooter`.

**Returns:**
SpreadsheetWorksheet - The parent worksheet of this `SpreadsheetHeaderFooter`.

### SpreadsheetHeaderFooterCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetheaderfootercollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class SpreadsheetHeaderFooterCollection extends ReadOnlyListBase<SpreadsheetHeaderFooter>
```

Represents a collection of headers and footers in an Excel document.

This collection contains the items of `SpreadsheetHeaderFooter` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetHeaderFooterCollection(SpreadsheetWorksheet worksheet) |  |
#### Methods

| Method | Description |
| --- | --- |
| getByOfficeHeaderFooterType(int headerFooterType) | Gets the header or footer of specified type. |
##### SpreadsheetHeaderFooterCollection(SpreadsheetWorksheet worksheet)
```
public SpreadsheetHeaderFooterCollection(SpreadsheetWorksheet worksheet)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheet | SpreadsheetWorksheet |  |

##### getByOfficeHeaderFooterType(int headerFooterType)
```
public final SpreadsheetHeaderFooter getByOfficeHeaderFooterType(int headerFooterType)
```

Gets the header or footer of specified type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterType | int | A `OfficeHeaderFooterType` value that specifies the type of the header/footer to get. |

**Returns:**
SpreadsheetHeaderFooter - The `SpreadsheetHeaderFooter` of specified type.

### SpreadsheetHeaderFooterSection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetheaderfootersection.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetHeaderFooterSection
```

Represents a header/footer section in an Excel document.
#### Methods

| Method | Description |
| --- | --- |
| getSectionType() | Gets the type of this `SpreadsheetHeaderFooterSection`. |
| getHeaderFooter() | Gets the parent header/footer of this `SpreadsheetHeaderFooterSection`. |
| getScript() | Gets the script formatting of this `SpreadsheetHeaderFooterSection`. |
| setScript(String value) | Sets the script formatting of this `SpreadsheetHeaderFooterSection`. |
| getImage() | Gets the image of this `SpreadsheetHeaderFooterSection`. |
| setImage(SpreadsheetWatermarkableImage value) | Sets the image of this `SpreadsheetHeaderFooterSection`. |
| getImageData() |  |
| setImageData(byte[] value) |  |
| resetImageReference() |  |
##### getSectionType()
```
public final int getSectionType()
```

Gets the type of this `SpreadsheetHeaderFooterSection`.

**Returns:**
int - The type of this `SpreadsheetHeaderFooterSection`.
##### getHeaderFooter()
```
public final SpreadsheetHeaderFooter getHeaderFooter()
```

Gets the parent header/footer of this `SpreadsheetHeaderFooterSection`.

**Returns:**
SpreadsheetHeaderFooter - The parent header/footer of this `SpreadsheetHeaderFooterSection`.
##### getScript()
```
public final String getScript()
```

Gets the script formatting of this `SpreadsheetHeaderFooterSection`.

**Returns:**
java.lang.String - The script content of this `SpreadsheetHeaderFooterSection`.
##### setScript(String value)
```
public final void setScript(String value)
```

Sets the script formatting of this `SpreadsheetHeaderFooterSection`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The script content of this `SpreadsheetHeaderFooterSection`. |

##### getImage()
```
public final SpreadsheetWatermarkableImage getImage()
```

Gets the image of this `SpreadsheetHeaderFooterSection`.

**Returns:**
SpreadsheetWatermarkableImage - The image of this `SpreadsheetHeaderFooterSection` or `null` if the section has no image.
##### setImage(SpreadsheetWatermarkableImage value)
```
public final void setImage(SpreadsheetWatermarkableImage value)
```

Sets the image of this `SpreadsheetHeaderFooterSection`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetWatermarkableImage | The image of this `SpreadsheetHeaderFooterSection` or `null` if the image should be removed. |

##### getImageData()
```
public final byte[] getImageData()
```

**Returns:**
byte[]
##### setImageData(byte[] value)
```
public final void setImageData(byte[] value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] |  |

##### resetImageReference()
```
public final void resetImageReference()
```

### SpreadsheetHeaderFooterSectionCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetheaderfootersectioncollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class SpreadsheetHeaderFooterSectionCollection extends ReadOnlyListBase<SpreadsheetHeaderFooterSection>
```

Represents a collection of header/footer sections.

This collection contains the items of `SpreadsheetHeaderFooterSection` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetHeaderFooterSectionCollection(SpreadsheetHeaderFooter headerFooter) |  |
#### Methods

| Method | Description |
| --- | --- |
| getBySpreadsheetHeaderFooterSectionType(int headerFooterSectionType) | Gets the header/footer section of specified type. |
##### SpreadsheetHeaderFooterSectionCollection(SpreadsheetHeaderFooter headerFooter)
```
public SpreadsheetHeaderFooterSectionCollection(SpreadsheetHeaderFooter headerFooter)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooter | SpreadsheetHeaderFooter |  |

##### getBySpreadsheetHeaderFooterSectionType(int headerFooterSectionType)
```
public final SpreadsheetHeaderFooterSection getBySpreadsheetHeaderFooterSectionType(int headerFooterSectionType)
```

Gets the header/footer section of specified type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterSectionType | int | A `SpreadsheetHeaderFooterSectionType` value that specifies the type of the section to get. |

**Returns:**
SpreadsheetHeaderFooterSection - The `SpreadsheetHeaderFooterSection` of specified type.

### SpreadsheetHeaderFooterSectionType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetheaderfootersectiontype.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetHeaderFooterSectionType
```

Represents header/footer section in Excel document.
#### Fields

| Field | Description |
| --- | --- |
| Left | Left section. |
| Center | Center section. |
| Right | Right section. |
##### Left
```
public static final int Left
```

Left section.

##### Center
```
public static final int Center
```

Center section.

##### Right
```
public static final int Right
```

Right section.

### SpreadsheetImageFillFormat
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetimagefillformat.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageFillFormat
```
public class SpreadsheetImageFillFormat extends OfficeImageFillFormat<SpreadsheetWatermarkableImage>
```

Represents the image fill format settings in an Excel document.
#### Methods

| Method | Description |
| --- | --- |
| getTileAsTexture() | Gets a value indicating whether the image is tiled across the background. |
| setTileAsTexture(boolean value) | Sets a value indicating whether the image is tiled across the background. |
| getTransparency() | Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| setTransparency(double value) | Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |
| getBackgroundImage() | Gets the background image. |
| setBackgroundImage(SpreadsheetWatermarkableImage value) | Sets the background image. |
##### getTileAsTexture()
```
public boolean getTileAsTexture()
```

Gets a value indicating whether the image is tiled across the background.

**Returns:**
boolean - True if the image is tiled across the background; otherwise, false (the image is stretched).
##### setTileAsTexture(boolean value)
```
public void setTileAsTexture(boolean value)
```

Sets a value indicating whether the image is tiled across the background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if the image is tiled across the background; otherwise, false (the image is stretched). |

##### getTransparency()
```
public double getTransparency()
```

Gets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Returns:**
double - The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).
##### setTransparency(double value)
```
public void setTransparency(double value)
```

Sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

##### getBackgroundImage()
```
public SpreadsheetWatermarkableImage getBackgroundImage()
```

Gets the background image.

**Returns:**
SpreadsheetWatermarkableImage - The background image. Returns null if the image is not set.
##### setBackgroundImage(SpreadsheetWatermarkableImage value)
```
public void setBackgroundImage(SpreadsheetWatermarkableImage value)
```

Sets the background image.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetWatermarkableImage | The background image. Returns null if the image is not set. |

### SpreadsheetMsoDrawingType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetmsodrawingtype.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetMsoDrawingType
```

Represents office drawing object type.
#### Fields

| Field | Description |
| --- | --- |
| Group | Built-in drawing type. |
| Line | Built-in drawing type. |
| Rectangle | Built-in drawing type. |
| Oval | Built-in drawing type. |
| Arc | Built-in drawing type. |
| Chart | Built-in drawing type. |
| TextBox | Built-in drawing type. |
| Button | Built-in drawing type. |
| Picture | Built-in drawing type. |
| Polygon | Built-in drawing type. |
| CheckBox | Built-in drawing type. |
| RadioButton | Built-in drawing type. |
| Label | Built-in drawing type. |
| DialogBox | Built-in drawing type. |
| Spinner | Built-in drawing type. |
| ScrollBar | Built-in drawing type. |
| ListBox | Built-in drawing type. |
| GroupBox | Built-in drawing type. |
| ComboBox | Built-in drawing type. |
| OleObject | Built-in drawing type. |
| Comment | Built-in drawing type. |
| Unknown | Built-in drawing type. |
| CellsDrawing | Built-in drawing type. |
| Slicer | Built-in drawing type. |
| WebExtension | Built-in drawing type. |
| SmartArt | Built-in drawing type. |
| CustomXml | Built-in drawing type. |
| Model3D | Built-in drawing type. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `SpreadsheetMsoDrawingType` value. |
| parse(String value) | Parses a string to a `SpreadsheetMsoDrawingType` enumeration value. |
| isDefined(int value) | Checks if a value defined for `SpreadsheetMsoDrawingType` enumeration. |
##### Group
```
public static final int Group
```

Built-in drawing type.

##### Line
```
public static final int Line
```

Built-in drawing type.

##### Rectangle
```
public static final int Rectangle
```

Built-in drawing type.

##### Oval
```
public static final int Oval
```

Built-in drawing type.

##### Arc
```
public static final int Arc
```

Built-in drawing type.

##### Chart
```
public static final int Chart
```

Built-in drawing type.

##### TextBox
```
public static final int TextBox
```

Built-in drawing type.

##### Button
```
public static final int Button
```

Built-in drawing type.

##### Picture
```
public static final int Picture
```

Built-in drawing type.

##### Polygon
```
public static final int Polygon
```

Built-in drawing type.

##### CheckBox
```
public static final int CheckBox
```

Built-in drawing type.

##### RadioButton
```
public static final int RadioButton
```

Built-in drawing type.

##### Label
```
public static final int Label
```

Built-in drawing type.

##### DialogBox
```
public static final int DialogBox
```

Built-in drawing type.

##### Spinner
```
public static final int Spinner
```

Built-in drawing type.

##### ScrollBar
```
public static final int ScrollBar
```

Built-in drawing type.

##### ListBox
```
public static final int ListBox
```

Built-in drawing type.

##### GroupBox
```
public static final int GroupBox
```

Built-in drawing type.

##### ComboBox
```
public static final int ComboBox
```

Built-in drawing type.

##### OleObject
```
public static final int OleObject
```

Built-in drawing type.

##### Comment
```
public static final int Comment
```

Built-in drawing type.

##### Unknown
```
public static final int Unknown
```

Built-in drawing type.

##### CellsDrawing
```
public static final int CellsDrawing
```

Built-in drawing type.

##### Slicer
```
public static final int Slicer
```

Built-in drawing type.

##### WebExtension
```
public static final int WebExtension
```

Built-in drawing type.

##### SmartArt
```
public static final int SmartArt
```

Built-in drawing type.

##### CustomXml
```
public static final int CustomXml
```

Built-in drawing type.

##### Model3D
```
public static final int Model3D
```

Built-in drawing type.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `SpreadsheetMsoDrawingType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `SpreadsheetMsoDrawingType` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `SpreadsheetMsoDrawingType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `SpreadsheetMsoDrawingType` enumeration value.
##### isDefined(int value)
```
public static final Boolean isDefined(int value)
```

Checks if a value defined for `SpreadsheetMsoDrawingType` enumeration.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to check. |

**Returns:**
java.lang.Boolean - true if the value is defined, false otherwise.

### SpreadsheetPageSetup
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetpagesetup.md

**Inheritance:**
java.lang.Object
```
public class SpreadsheetPageSetup
```

Represents printing page properties for a worksheet.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of a printing page in points. |
| getHeight() | Gets the height of a printing page in points. |
| getLeftMargin() | Gets the size of the left margin in points. |
| getRightMargin() | Gets the size of the right margin in points. |
| getTopMargin() | Gets the size of the top margin in points. |
| getBottomMargin() | Gets the size of the bottom margin in points. |
| getAsposePageSetup() |  |
##### getWidth()
```
public final double getWidth()
```

Gets the width of a printing page in points.

**Returns:**
double - The width of a printing page in points.
##### getHeight()
```
public final double getHeight()
```

Gets the height of a printing page in points.

**Returns:**
double - The height of a printing page in points.
##### getLeftMargin()
```
public final double getLeftMargin()
```

Gets the size of the left margin in points.

**Returns:**
double - The size of the left margin in points.
##### getRightMargin()
```
public final double getRightMargin()
```

Gets the size of the right margin in points.

**Returns:**
double - The size of the right margin in points.
##### getTopMargin()
```
public final double getTopMargin()
```

Gets the size of the top margin in points.

**Returns:**
double - The size of the top margin in points.
##### getBottomMargin()
```
public final double getBottomMargin()
```

Gets the size of the bottom margin in points.

**Returns:**
double - The size of the bottom margin in points.
##### getAsposePageSetup()
```
public final PageSetup getAsposePageSetup()
```

**Returns:**
com.aspose.cells.PageSetup

### SpreadsheetShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IRotatableTwoDObject, com.groupdocs.watermark.search.IHyperlinkContainer
```
public class SpreadsheetShape extends ShapeSearchAdapter implements IRotatableTwoDObject, IHyperlinkContainer
```

Represents a drawing shape in an Excel document.
#### Methods

| Method | Description |
| --- | --- |
| getWorksheet() | Gets the parent worksheet of this `SpreadsheetShape`. |
| getAutoShapeType() | Gets the auto shape type. |
| getMsoDrawingType() | Gets the mso drawing type. |
| getText() | Gets the text of this `SpreadsheetShape`. |
| setText(String value) | Sets the text of this `SpreadsheetShape`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `SpreadsheetShape`. |
| getImage() | Gets the image of this `SpreadsheetShape`. |
| setImage(SpreadsheetWatermarkableImage value) | Sets the image of this `SpreadsheetShape`. |
| getImageFillFormat() | Gets the image fill format settings of this `SpreadsheetShape`. |
| getId() | Gets the identifier of this `SpreadsheetShape`. |
| getAlternativeText() | Gets the descriptive (alternative) text associated with this `SpreadsheetShape`. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text associated with this `SpreadsheetShape`. |
| isWordArt() | Gets a value indicating whether this `SpreadsheetShape` is a WordArt object. |
| getName() | Gets the name of this `SpreadsheetShape`. |
| getAsposeCellsShape() |  |
| getHyperlink() | Gets the hyperlink associated with this `SpreadsheetShape`. |
| setHyperlink(String value) | Sets the hyperlink associated with this `SpreadsheetShape`. |
| getX() | Gets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points. |
| setX(double value) | Sets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points. |
| getY() | Gets the vertical offset of this `SpreadsheetShape` from worksheet top border in points. |
| setY(double value) | Sets the vertical offset of this `SpreadsheetShape` from worksheet top border in points. |
| getWidth() | Gets the width of this `SpreadsheetShape` in points. |
| setWidth(double value) | Sets the width of this `SpreadsheetShape` in points. |
| getHeight() | Gets the height of this `SpreadsheetShape` in points. |
| setHeight(double value) | Sets the height of this `SpreadsheetShape` in points. |
| getRotateAngle() | Gets or sets the rotate angle of this `SpreadsheetShape` in degrees. |
| setRotateAngle(double value) | Gets or sets the rotate angle of this `SpreadsheetShape` in degrees. |
| getImageForSearch() |  |
| setFoundWatermarkImage(byte[] imageData) |  |
| getFormattedTextFragmentsForSearch() |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
##### getWorksheet()
```
public final SpreadsheetWorksheet getWorksheet()
```

Gets the parent worksheet of this `SpreadsheetShape`.

**Returns:**
SpreadsheetWorksheet - The parent worksheet of this `SpreadsheetShape`.
##### getAutoShapeType()
```
public final int getAutoShapeType()
```

Gets the auto shape type.

**Returns:**
int - The auto shape type.
##### getMsoDrawingType()
```
public final int getMsoDrawingType()
```

Gets the mso drawing type.

**Returns:**
int - The mso drawing type.
##### getText()
```
public final String getText()
```

Gets the text of this `SpreadsheetShape`.

**Returns:**
java.lang.String - The text of this `SpreadsheetShape`.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text of this `SpreadsheetShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `SpreadsheetShape`. |

##### getFormattedTextFragments()
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `SpreadsheetShape`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `SpreadsheetShape`.
##### getImage()
```
public final SpreadsheetWatermarkableImage getImage()
```

Gets the image of this `SpreadsheetShape`.

**Returns:**
SpreadsheetWatermarkableImage - The image of this `SpreadsheetShape` or null if the shape has no image.
##### setImage(SpreadsheetWatermarkableImage value)
```
public final void setImage(SpreadsheetWatermarkableImage value)
```

Sets the image of this `SpreadsheetShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetWatermarkableImage | The image of this `SpreadsheetShape` or null if the image should be removed. |

##### getImageFillFormat()
```
public final SpreadsheetImageFillFormat getImageFillFormat()
```

Gets the image fill format settings of this `SpreadsheetShape`.

**Returns:**
SpreadsheetImageFillFormat - The image fill format settings of this `SpreadsheetShape`.
##### getId()
```
public final int getId()
```

Gets the identifier of this `SpreadsheetShape`.

**Returns:**
int - The identifier of this `SpreadsheetShape`.
##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text associated with this `SpreadsheetShape`.

**Returns:**
java.lang.String - The descriptive (alternative) text associated with this `SpreadsheetShape`.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text associated with this `SpreadsheetShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text associated with this `SpreadsheetShape`. |

##### isWordArt()
```
public final boolean isWordArt()
```

Gets a value indicating whether this `SpreadsheetShape` is a WordArt object.

**Returns:**
boolean - True if the shape is a WordArt object; otherwise, false.
##### getName()
```
public final String getName()
```

Gets the name of this `SpreadsheetShape`.

**Returns:**
java.lang.String - The name of this `SpreadsheetShape`.
##### getAsposeCellsShape()
```
public final Shape getAsposeCellsShape()
```

**Returns:**
com.aspose.cells.Shape
##### getHyperlink()
```
public final String getHyperlink()
```

Gets the hyperlink associated with this `SpreadsheetShape`.

**Returns:**
java.lang.String - The hyperlink associated with this `SpreadsheetShape`.
##### setHyperlink(String value)
```
public final void setHyperlink(String value)
```

Sets the hyperlink associated with this `SpreadsheetShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink associated with this `SpreadsheetShape`. |

##### getX()
```
public final double getX()
```

Gets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points.

**Returns:**
double - The x-coordinate of this `SpreadsheetShape`.
##### setX(double value)
```
public final void setX(double value)
```

Sets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of this `SpreadsheetShape`. |

##### getY()
```
public final double getY()
```

Gets the vertical offset of this `SpreadsheetShape` from worksheet top border in points.

**Returns:**
double - The y-coordinate of this `SpreadsheetShape`.
##### setY(double value)
```
public final void setY(double value)
```

Sets the vertical offset of this `SpreadsheetShape` from worksheet top border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of this `SpreadsheetShape`. |

##### getWidth()
```
public final double getWidth()
```

Gets the width of this `SpreadsheetShape` in points.

**Returns:**
double - The width of this `SpreadsheetShape` in points.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the width of this `SpreadsheetShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of this `SpreadsheetShape` in points. |

##### getHeight()
```
public final double getHeight()
```

Gets the height of this `SpreadsheetShape` in points.

**Returns:**
double - The height of this `SpreadsheetShape` in points.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the height of this `SpreadsheetShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of this `SpreadsheetShape` in points. |

##### getRotateAngle()
```
public final double getRotateAngle()
```

Gets or sets the rotate angle of this `SpreadsheetShape` in degrees.

**Returns:**
double - The rotate angle of this `SpreadsheetShape` in degrees.
##### setRotateAngle(double value)
```
public final void setRotateAngle(double value)
```

Gets or sets the rotate angle of this `SpreadsheetShape` in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rotate angle of this `SpreadsheetShape` in degrees. |

##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

### SpreadsheetShapeCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetshapecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class SpreadsheetShapeCollection extends RemoveOnlyListBase<SpreadsheetShape>
```

Represents a collection of drawing shapes in an Excel document.

This collection contains the items of `SpreadsheetShape` type.
#### Methods

| Method | Description |
| --- | --- |
| addShape(Shape shape) |  |
| removeFromDocument(SpreadsheetShape item) |  |
##### addShape(Shape shape)
```
public final void addShape(Shape shape)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | com.aspose.cells.Shape |  |

##### removeFromDocument(SpreadsheetShape item)
```
public void removeFromDocument(SpreadsheetShape item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | SpreadsheetShape |  |

### SpreadsheetShapeFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetshapeformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class SpreadsheetShapeFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in Excel document shape.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### SpreadsheetShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetshapeformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class SpreadsheetShapeFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in an Excel document text shape.

This collection contains the items of `SpreadsheetShapeFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### SpreadsheetTextEffectFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheettexteffectformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class SpreadsheetTextEffectFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in Excel document WordArt shape.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### SpreadsheetTextEffectFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheettexteffectformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public class SpreadsheetTextEffectFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in an Excel document WordArt shape.

This collection contains the items of `SpreadsheetTextEffectFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
| setText(String text) |  |
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

### SpreadsheetWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class SpreadsheetWatermarkableImage extends WatermarkableImage
```

Represents an image inside an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetWatermarkableImage(byte[] imageData) | Initializes a new instance of the `SpreadsheetWatermarkableImage` class using specified image data. |
##### SpreadsheetWatermarkableImage(byte[] imageData)
```
public SpreadsheetWatermarkableImage(byte[] imageData)
```

Initializes a new instance of the `SpreadsheetWatermarkableImage` class using specified image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] | The array of unsigned bytes from which to create the `SpreadsheetWatermarkableImage`. |

### SpreadsheetWorksheet
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetworksheet.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class SpreadsheetWorksheet extends ContentPart
```

Represents an Excel document worksheet.
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetDataSizeInPoints() |  |
| getPageSetup() | Gets the printing page setup for this `SpreadsheetWorksheet`. |
| getContentAreaWidth() | Gets the width of the content area in points. |
| getContentAreaWidthPx() | Gets the width of the content area in pixels. |
| getContentAreaHeight() | Gets the height of the content area in points. |
| getContentAreaHeightPx() | Gets the height of the content area in pixels. |
| getShapes() | Gets the collection of all shapes of this `SpreadsheetWorksheet`. |
| getAttachments() | Gets the collection of all attachments of this `SpreadsheetWorksheet`. |
| getCharts() | Gets the collection of all charts of this `SpreadsheetWorksheet`. |
| getBackgroundImage() | Gets the background image of this `SpreadsheetWorksheet`. |
| setBackgroundImage(SpreadsheetWatermarkableImage value) | Sets the background image of this `SpreadsheetWorksheet`. |
| getHeadersFooters() | Gets the collection of worksheet headers and footers. |
| getAsposeCellsWorksheet() |  |
| getColumnWidth(int column) | Gets the width of the specified column in points. |
| getColumnWidthPx(int column) | Gets the width of the specified column in pixels. |
| getRowHeight(int row) | Gets the height of the specified row in points. |
| getRowHeightPx(int row) | Gets the height of the specified row in pixels. |
| addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects) |  |
| addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight) |  |
| addWatermarkIntoHeaderFooter(Watermark watermark) |  |
| addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings) |  |
| addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects) |  |
| getRowY(int rowIndex) |  |
| getColumnX(int columnIndex) |  |
| getRowRangeHeight(int startRow, int endRow) |  |
| getColumnRangeWidth(int startColumn, int endColumn) |  |
| resetBackgroundImageReference() |  |
##### getSpreadsheetDataSizeInPoints()
```
public Size getSpreadsheetDataSizeInPoints()
```

**Returns:**
Size
##### getPageSetup()
```
public final SpreadsheetPageSetup getPageSetup()
```

Gets the printing page setup for this `SpreadsheetWorksheet`.

**Returns:**
SpreadsheetPageSetup - The printing page setup for this `SpreadsheetWorksheet`.
##### getContentAreaWidth()
```
public final double getContentAreaWidth()
```

Gets the width of the content area in points.

**Returns:**
double - The width of the content area in points.
##### getContentAreaWidthPx()
```
public final int getContentAreaWidthPx()
```

Gets the width of the content area in pixels.

**Returns:**
int - The width of the content area in pixels.
##### getContentAreaHeight()
```
public final double getContentAreaHeight()
```

Gets the height of the content area in points.

**Returns:**
double - The height of the content area in points.
##### getContentAreaHeightPx()
```
public final int getContentAreaHeightPx()
```

Gets the height of the content area in pixels.

**Returns:**
int - The height of the content area in pixels.
##### getShapes()
```
public final SpreadsheetShapeCollection getShapes()
```

Gets the collection of all shapes of this `SpreadsheetWorksheet`.

**Returns:**
SpreadsheetShapeCollection - The collection of all shapes of this `SpreadsheetWorksheet`.
##### getAttachments()
```
public final SpreadsheetAttachmentCollection getAttachments()
```

Gets the collection of all attachments of this `SpreadsheetWorksheet`.

**Returns:**
SpreadsheetAttachmentCollection - The collection of all attachments of this `SpreadsheetWorksheet`.
##### getCharts()
```
public final SpreadsheetChartCollection getCharts()
```

Gets the collection of all charts of this `SpreadsheetWorksheet`.

**Returns:**
SpreadsheetChartCollection - The collection of all charts of this `SpreadsheetWorksheet`.
##### getBackgroundImage()
```
public final SpreadsheetWatermarkableImage getBackgroundImage()
```

Gets the background image of this `SpreadsheetWorksheet`.

**Returns:**
SpreadsheetWatermarkableImage - The background image of this `SpreadsheetWorksheet` or `null` if the worksheet has no background image.
##### setBackgroundImage(SpreadsheetWatermarkableImage value)
```
public final void setBackgroundImage(SpreadsheetWatermarkableImage value)
```

Sets the background image of this `SpreadsheetWorksheet`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SpreadsheetWatermarkableImage | The background image of this `SpreadsheetWorksheet` or `null` if the background image should be removed. |

##### getHeadersFooters()
```
public final SpreadsheetHeaderFooterCollection getHeadersFooters()
```

Gets the collection of worksheet headers and footers.

**Returns:**
SpreadsheetHeaderFooterCollection - The collection of headers and footers.
##### getAsposeCellsWorksheet()
```
public final Worksheet getAsposeCellsWorksheet()
```

**Returns:**
com.aspose.cells.Worksheet
##### getColumnWidth(int column)
```
public final double getColumnWidth(int column)
```

Gets the width of the specified column in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | int | The column index. |

**Returns:**
double - The width of the column in points.
##### getColumnWidthPx(int column)
```
public final int getColumnWidthPx(int column)
```

Gets the width of the specified column in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| column | int | The column index. |

**Returns:**
int - The width of the column in pixels.
##### getRowHeight(int row)
```
public final double getRowHeight(int row)
```

Gets the height of the specified row in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | int | The row index. |

**Returns:**
double - The height of the row in points.
##### getRowHeightPx(int row)
```
public final int getRowHeightPx(int row)
```

Gets the height of the specified row in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| row | int | The row index. |

**Returns:**
int - The height of the row in pixels.
##### addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```
public final void addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | SpreadsheetShapeSettings |  |
| effects | ISpreadsheetWatermarkEffects |  |

##### addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
```
public final void addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| backgroundWidth | int |  |
| backgroundHeight | int |  |

##### addWatermarkIntoHeaderFooter(Watermark watermark)
```
public final void addWatermarkIntoHeaderFooter(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

##### addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
```
public final void addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | TextWatermark |  |
| shapeSettings | SpreadsheetShapeSettings |  |

##### addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```
public final void addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | SpreadsheetShapeSettings |  |
| effects | ISpreadsheetWatermarkEffects |  |

##### getRowY(int rowIndex)
```
public final double getRowY(int rowIndex)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rowIndex | int |  |

**Returns:**
double
##### getColumnX(int columnIndex)
```
public final double getColumnX(int columnIndex)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| columnIndex | int |  |

**Returns:**
double
##### getRowRangeHeight(int startRow, int endRow)
```
public final double getRowRangeHeight(int startRow, int endRow)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startRow | int |  |
| endRow | int |  |

**Returns:**
double
##### getColumnRangeWidth(int startColumn, int endColumn)
```
public final double getColumnRangeWidth(int startColumn, int endColumn)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| startColumn | int |  |
| endColumn | int |  |

**Returns:**
double
##### resetBackgroundImageReference()
```
public final void resetBackgroundImageReference()
```

### SpreadsheetWorksheetCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/spreadsheetworksheetcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class SpreadsheetWorksheetCollection extends ReadOnlyListBase<SpreadsheetWorksheet>
```

Represents a collection of worksheets in an Excel document.

This collection contains the items of `SpreadsheetWorksheet` type.

### TiffImageContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/tiffimagecontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content, com.groupdocs.watermark.contents.ImageContent, com.groupdocs.watermark.contents.MultiframeImageContent
```
public class TiffImageContent extends MultiframeImageContent
```

Represents a tiff image where a watermark can be placed.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, TiffImageLoadOptions tiffImageLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| performSave(String filePath) |  |
| performSave(OutputStream stream) |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
##### TiffImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, TiffImageLoadOptions tiffImageLoadOptions, WatermarkerSettings watermarkerSettings)
```
public TiffImageContent(StreamContainer stream, StrategyManager<Integer> strategyManager, TiffImageLoadOptions tiffImageLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | com.groupdocs.watermark.internal.StrategyManager<java.lang.Integer> |  |
| tiffImageLoadOptions | TiffImageLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

Saves the content to the specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

### WatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/watermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public abstract class WatermarkableImage extends ContentPart
```

Represents an image inside a document.

**Learn more:**

 *  [Adding watermark to images inside a document][]

The following example demonstrates how to add watermark to all images inside a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\input.doc");
>
>    // Initialize text or image watermark.
>    TextWatermark watermark = new TextWatermark("DRAFT", new Font("Arial", 19));
>
>    // Find all images in the content.
>    WatermarkableImageCollection images = watermarker.getImages();
>
>    // Add watermark.
>    for (WatermarkableImage watermarkableImage : images)
>    {
>        watermarkableImage.add(watermark);
>    }
>
>    // Save changes.
>    watermarker.save("D:\\output.doc");
>    watermarker.close();
>
> ```
> ```

[Adding watermark to images inside a document]: https://docs.groupdocs.com/display/watermarkjava/Adding+watermark+to+images+inside+a+document
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkableImage(Content content) |  |
#### Methods

| Method | Description |
| --- | --- |
| getHeight() | Gets the height of this `WatermarkableImage` in pixels. |
| getWidth() | Gets the width of this `WatermarkableImage` in pixels. |
| add(Watermark watermark) | Adds a watermark to this `WatermarkableImage`. |
| getBytes() | Gets the image as byte array. |
| updateDocumentReference(Content parentContent) |  |
##### WatermarkableImage(Content content)
```
public WatermarkableImage(Content content)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | Content |  |

##### getHeight()
```
public final int getHeight()
```

Gets the height of this `WatermarkableImage` in pixels.

**Returns:**
int - The height of this `WatermarkableImage` in pixels.
##### getWidth()
```
public final int getWidth()
```

Gets the width of this `WatermarkableImage` in pixels.

**Returns:**
int - The width of this `WatermarkableImage` in pixels.
##### add(Watermark watermark)
```
public final void add(Watermark watermark)
```

Adds a watermark to this `WatermarkableImage`.

This method assumes that watermark offset and size are measured in pixels (if they are assigned).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the image. |

##### getBytes()
```
public final byte[] getBytes()
```

Gets the image as byte array.

**Returns:**
byte[] - The image data.
##### updateDocumentReference(Content parentContent)
```
public final void updateDocumentReference(Content parentContent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentContent | Content |  |

### WatermarkableImageCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/watermarkableimagecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class WatermarkableImageCollection extends ReadOnlyListBase<WatermarkableImage>
```

Represents a collection of images found in a document.

This collection contains the items of `WatermarkableImage` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkableImageCollection() |  |
##### WatermarkableImageCollection()
```
public WatermarkableImageCollection()
```

### WordProcessingContent
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingcontent.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.Content

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IEncryptable
```
public class WordProcessingContent extends Content implements IEncryptable
```

Class representing Word document (doc, docx etc) where watermark should be placed.

**Learn more:**

 *  [Add watermarks to word processing documents][]
 *  [Existing objects in word processing document][]
 *  [Locking watermark in word processing document][]
 *  [Protecting word processing documents][]
 *  [Watermarks in word processing document][]

The following example demonstrates how to load and save Word document of any supported type.

> ```
> ```
>
>    WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\input.doc", loadOptions);
>
>    // Use add method to add watermark to a particular or all sections.
>
>    // Save changes.
>    watermarker.save("D:\\output.doc");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to word processing documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+word+processing+documents
[Existing objects in word processing document]: https://docs.groupdocs.com/display/watermarkjava/Existing+objects+in+word+processing+document
[Locking watermark in word processing document]: https://docs.groupdocs.com/display/watermarkjava/Locking+watermark+in+word+processing+document
[Protecting word processing documents]: https://docs.groupdocs.com/display/watermarkjava/Protecting+word+processing+documents
[Watermarks in word processing document]: https://docs.groupdocs.com/display/watermarkjava/Watermarks+in+word+processing+document
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingContent(StreamContainer stream, IStrategyManager strategyManager, FileFormatInfo fileFormatInfo, WordProcessingLoadOptions wordProcessingLoadOptions, WatermarkerSettings watermarkerSettings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getSections() | Gets the collection of all sections of this `WordProcessingContent`. |
| setSections(WordProcessingSectionCollection value) |  |
| getPageCount() | Gets the number of pages in the document. |
| getAsposeWordsDocument() |  |
| encrypt(String password) | Encrypts the document. |
| decrypt() | Decrypts the document. |
| addWatermark(Watermark watermark, int pageNumber) |  |
| addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings) |  |
| protect(int protectionType, String password) | Protects the document from changes and sets a protection password. |
| unprotect() | Removes protection from the document regardless of the password. |
| performSave(String filePath) |  |
| performSave(String filePath, SaveOptions saveOptions) |  |
| performSave(OutputStream stream) |  |
| performSave(OutputStream stream, SaveOptions saveOptions) |  |
| add(Watermark watermark, WatermarkOptions options) |  |
| generatePreview(PreviewOptions previewOptions) |  |
| getDocumentInfo() |  |
| getFileType() |  |
| addWatermark(Watermark watermark) |  |
##### WordProcessingContent(StreamContainer stream, IStrategyManager strategyManager, FileFormatInfo fileFormatInfo, WordProcessingLoadOptions wordProcessingLoadOptions, WatermarkerSettings watermarkerSettings)
```
public WordProcessingContent(StreamContainer stream, IStrategyManager strategyManager, FileFormatInfo fileFormatInfo, WordProcessingLoadOptions wordProcessingLoadOptions, WatermarkerSettings watermarkerSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | StreamContainer |  |
| strategyManager | IStrategyManager |  |
| fileFormatInfo | com.aspose.words.FileFormatInfo |  |
| wordProcessingLoadOptions | WordProcessingLoadOptions |  |
| watermarkerSettings | WatermarkerSettings |  |

##### getSections()
```
public final WordProcessingSectionCollection getSections()
```

Gets the collection of all sections of this `WordProcessingContent`.

**Returns:**
WordProcessingSectionCollection - The collection of all sections of this `WordProcessingContent`.
##### setSections(WordProcessingSectionCollection value)
```
public final void setSections(WordProcessingSectionCollection value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingSectionCollection |  |

##### getPageCount()
```
public final int getPageCount()
```

Gets the number of pages in the document.

**Returns:**
int - The number of pages in the document.
##### getAsposeWordsDocument()
```
public final Document getAsposeWordsDocument()
```

**Returns:**
com.aspose.words.Document
##### encrypt(String password)
```
public final void encrypt(String password)
```

Encrypts the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password that will be required to open the document. |

##### decrypt()
```
public final void decrypt()
```

Decrypts the document.

##### addWatermark(Watermark watermark, int pageNumber)
```
public final void addWatermark(Watermark watermark, int pageNumber)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| pageNumber | int |  |

##### addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
```
public final void addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| effects | IWordProcessingWatermarkEffects |  |
| shapeSettings | WordProcessingShapeSettings |  |

##### protect(int protectionType, String password)
```
public final void protect(int protectionType, String password)
```

Protects the document from changes and sets a protection password.

To have the content of the document editable use appropriate method of adding watermark with `WordProcessingLockType.AllowOnlyFormFields` or `WordProcessingLockType.ReadOnlyWithEditableContent` parameter.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | int | The protection type for the document. |
| password | java.lang.String | The password to protect the document with. |

##### unprotect()
```
public final void unprotect()
```

Removes protection from the document regardless of the password.

##### performSave(String filePath)
```
public void performSave(String filePath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |

##### performSave(String filePath, SaveOptions saveOptions)
```
public void performSave(String filePath, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String |  |
| saveOptions | SaveOptions |  |

##### performSave(OutputStream stream)
```
public void performSave(OutputStream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |

##### performSave(OutputStream stream, SaveOptions saveOptions)
```
public void performSave(OutputStream stream, SaveOptions saveOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.OutputStream |  |
| saveOptions | SaveOptions |  |

##### add(Watermark watermark, WatermarkOptions options)
```
public void add(Watermark watermark, WatermarkOptions options)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| options | WatermarkOptions |  |

##### generatePreview(PreviewOptions previewOptions)
```
public void generatePreview(PreviewOptions previewOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions |  |

##### getDocumentInfo()
```
public IDocumentInfo getDocumentInfo()
```

**Returns:**
IDocumentInfo
##### getFileType()
```
public FileType getFileType()
```

**Returns:**
FileType
##### addWatermark(Watermark watermark)
```
public void addWatermark(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

### WordProcessingFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection
```
public abstract class WordProcessingFormattedTextFragmentCollection extends FormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a Word document.

### WordProcessingHeaderFooter
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingheaderfooter.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class WordProcessingHeaderFooter extends ContentPart
```

Represents a header/footer in a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper) |  |
#### Methods

| Method | Description |
| --- | --- |
| getWrapper() |  |
| getHeaderFooterType() | Gets the type of this `WordProcessingHeaderFooter`. |
| getSection() | Gets the parent section of this `WordProcessingHeaderFooter`. |
| isLinkedToPrevious() | Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section. |
| setLinkedToPrevious(boolean value) | Sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section. |
| isVisible() |  |
| addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings) |  |
##### WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper)
```
public WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterHeaderFooterType | int |  |
| parent | WordProcessingSection |  |
| strategyManager | IStrategyManager |  |
| wrapper | WordProcessingHeaderFooterWrapper |  |

##### getWrapper()
```
public final WordProcessingHeaderFooterWrapper getWrapper()
```

**Returns:**
WordProcessingHeaderFooterWrapper
##### getHeaderFooterType()
```
public final int getHeaderFooterType()
```

Gets the type of this `WordProcessingHeaderFooter`.

**Returns:**
int - The type of this `WordProcessingHeaderFooter`.
##### getSection()
```
public final WordProcessingSection getSection()
```

Gets the parent section of this `WordProcessingHeaderFooter`.

**Returns:**
WordProcessingSection - The parent section of this `WordProcessingHeaderFooter`.
##### isLinkedToPrevious()
```
public final boolean isLinkedToPrevious()
```

Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.

Default is true.

**Returns:**
boolean - `true` if this header/footer is linked to the corresponding header/footer in the previous section; `false` otherwise.
##### setLinkedToPrevious(boolean value)
```
public final void setLinkedToPrevious(boolean value)
```

Sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.

Note, when your link a header or footer, its contents is cleared.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | `true` if this header/footer has to be linked to the corresponding header/footer in the previous section; `false` otherwise. |

##### isVisible()
```
public final boolean isVisible()
```

**Returns:**
boolean
##### addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
```
public final void addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| effects | IWordProcessingWatermarkEffects |  |
| shapeSettings | WordProcessingShapeSettings |  |

### WordProcessingHeaderFooterCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingheaderfootercollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class WordProcessingHeaderFooterCollection extends ReadOnlyListBase<WordProcessingHeaderFooter>
```

Represents a collection of headers and footers in a Word document.

This collection contains the items of `WordProcessingHeaderFooter` type.
#### Methods

| Method | Description |
| --- | --- |
| getByOfficeHeaderFooterType(int headerFooterType) | Gets the header or footer of specified type. |
| linkToPrevious(boolean isLinkToPrevious) | Links or unlinks all headers and footers to the corresponding headers and footers in the previous section. |
##### getByOfficeHeaderFooterType(int headerFooterType)
```
public final WordProcessingHeaderFooter getByOfficeHeaderFooterType(int headerFooterType)
```

Gets the header or footer of specified type.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| headerFooterType | int | A `OfficeHeaderFooterType` value that specifies the type of the header/footer to get. |

**Returns:**
WordProcessingHeaderFooter - The `WordProcessingHeaderFooter` of specified type.
##### linkToPrevious(boolean isLinkToPrevious)
```
public final void linkToPrevious(boolean isLinkToPrevious)
```

Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isLinkToPrevious | boolean | True to link the headers and footers to the previous section; false to unlink them. |

### WordProcessingHorizontalAlignment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessinghorizontalalignment.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingHorizontalAlignment
```

Specifies horizontal alignment of a floating object.
#### Fields

| Field | Description |
| --- | --- |
| None | Object is explicitly positioned using its x-coordinate. |
| Left | Specifies that the object is left aligned to the horizontal alignment base. |
| Center | Specifies that the object is centered with respect to the horizontal alignment base. |
| Right | Specifies that the object is right aligned to the horizontal alignment base. |
| Inside | Specifies that the object is inside of the horizontal alignment base. |
| Outside | Specifies that the object is outside of the horizontal alignment base. |
##### None
```
public static final int None
```

Object is explicitly positioned using its x-coordinate.

##### Left
```
public static final int Left
```

Specifies that the object is left aligned to the horizontal alignment base.

##### Center
```
public static final int Center
```

Specifies that the object is centered with respect to the horizontal alignment base.

##### Right
```
public static final int Right
```

Specifies that the object is right aligned to the horizontal alignment base.

##### Inside
```
public static final int Inside
```

Specifies that the object is inside of the horizontal alignment base.

##### Outside
```
public static final int Outside
```

Specifies that the object is outside of the horizontal alignment base.

### WordProcessingPageSetup
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingpagesetup.md

**Inheritance:**
java.lang.Object
```
public class WordProcessingPageSetup
```

Represents printing page properties for a section of a Word document.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of a printing page in points. |
| getHeight() | Gets the height of a printing page in points. |
| getLeftMargin() | Gets the size of the left margin in points. |
| getTopMargin() | Gets the size of the top margin in points. |
| getRightMargin() | Gets the size of the right margin in points. |
| getBottomMargin() | Gets the size of the bottom margin in points. |
| getDifferentFirstPageHeaderFooter() | Gets a value indicating whether a different header/footer is used for the first page. |
| setDifferentFirstPageHeaderFooter(boolean value) | Sets a value indicating whether a different header/footer is used for the first page. |
| getOddAndEvenPagesHeaderFooter() | Gets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. |
| setOddAndEvenPagesHeaderFooter(boolean value) | Sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. |
##### getWidth()
```
public final double getWidth()
```

Gets the width of a printing page in points.

**Returns:**
double - The width of a printing page in points.
##### getHeight()
```
public final double getHeight()
```

Gets the height of a printing page in points.

**Returns:**
double - The height of a printing page in points.
##### getLeftMargin()
```
public final double getLeftMargin()
```

Gets the size of the left margin in points.

**Returns:**
double - The size of the left margin in points.
##### getTopMargin()
```
public final double getTopMargin()
```

Gets the size of the top margin in points.

**Returns:**
double - The size of the top margin in points.
##### getRightMargin()
```
public final double getRightMargin()
```

Gets the size of the right margin in points.

**Returns:**
double - The size of the right margin in points.
##### getBottomMargin()
```
public final double getBottomMargin()
```

Gets the size of the bottom margin in points.

**Returns:**
double - The size of the bottom margin in points.
##### getDifferentFirstPageHeaderFooter()
```
public final boolean getDifferentFirstPageHeaderFooter()
```

Gets a value indicating whether a different header/footer is used for the first page.

**Returns:**
boolean - True if a different header/footer is used for the first page; otherwise, false.
##### setDifferentFirstPageHeaderFooter(boolean value)
```
public final void setDifferentFirstPageHeaderFooter(boolean value)
```

Sets a value indicating whether a different header/footer is used for the first page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if a different header/footer is used for the first page; otherwise, false. |

##### getOddAndEvenPagesHeaderFooter()
```
public final boolean getOddAndEvenPagesHeaderFooter()
```

Gets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. Note, changing this property affects all sections in the content.

**Returns:**
boolean - True if different headers/footers are used for odd-numbered and even-numbered pages; otherwise, false.
##### setOddAndEvenPagesHeaderFooter(boolean value)
```
public final void setOddAndEvenPagesHeaderFooter(boolean value)
```

Sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. Note, changing this property affects all sections in the content.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if different headers/footers are used for odd-numbered and even-numbered pages; otherwise, false. |

### WordProcessingPageSplitter
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingpagesplitter.md

**Inheritance:**
java.lang.Object
```
public class WordProcessingPageSplitter
```
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingPageSplitter(WordProcessingContent content) |  |
#### Methods

| Method | Description |
| --- | --- |
| dispose() | Disposes the current instance. |
| getPageFirstParagraph(int pageNumber) |  |
##### WordProcessingPageSplitter(WordProcessingContent content)
```
public WordProcessingPageSplitter(WordProcessingContent content)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | WordProcessingContent |  |

##### dispose()
```
public final void dispose()
```

Disposes the current instance.

##### getPageFirstParagraph(int pageNumber)
```
public final Paragraph getPageFirstParagraph(int pageNumber)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | int |  |

**Returns:**
com.aspose.words.Paragraph

### WordProcessingProtectionType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingprotectiontype.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingProtectionType
```

Represents protection type for a Word document.
#### Fields

| Field | Description |
| --- | --- |
| 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. |
##### 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.

### WordProcessingRelativeHorizontalPosition
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingrelativehorizontalposition.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingRelativeHorizontalPosition
```

Specifies to what the horizontal position of an object is relative.
#### Fields

| Field | Description |
| --- | --- |
| Margin | Specifies that the horizontal positioning is relative to the page margins. |
| Page | The object is positioned relative to the left edge of the page. |
| Column | The object is positioned relative to the left side of the column. |
| Character | The object is positioned relative to the left side of the paragraph. |
| LeftMargin | Specifies that the horizontal positioning is relative to the left margin of the page. |
| RightMargin | Specifies that the horizontal positioning is relative to the right margin of the page. |
| InsideMargin | Specifies that the horizontal positioning is relative to the inside margin of the current page (the left margin on odd pages, right on even pages). |
| OutsideMargin | Specifies that the horizontal positioning is relative to the outside margin of the current page (the right margin on odd pages, left on even pages). |
##### Margin
```
public static final int Margin
```

Specifies that the horizontal positioning is relative to the page margins.

##### Page
```
public static final int Page
```

The object is positioned relative to the left edge of the page.

##### Column
```
public static final int Column
```

The object is positioned relative to the left side of the column.

##### Character
```
public static final int Character
```

The object is positioned relative to the left side of the paragraph.

##### LeftMargin
```
public static final int LeftMargin
```

Specifies that the horizontal positioning is relative to the left margin of the page.

##### RightMargin
```
public static final int RightMargin
```

Specifies that the horizontal positioning is relative to the right margin of the page.

##### InsideMargin
```
public static final int InsideMargin
```

Specifies that the horizontal positioning is relative to the inside margin of the current page (the left margin on odd pages, right on even pages).

##### OutsideMargin
```
public static final int OutsideMargin
```

Specifies that the horizontal positioning is relative to the outside margin of the current page (the right margin on odd pages, left on even pages).

### WordProcessingRelativeVerticalPosition
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingrelativeverticalposition.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingRelativeVerticalPosition
```

Specifies to what the vertical position of an object is relative.
#### Fields

| Field | Description |
| --- | --- |
| Margin | Specifies that the vertical positioning is relative to the page margins. |
| Page | The object is positioned relative to the top edge of the page. |
| Paragraph | The object is positioned relative to the top of the paragraph that contains the anchor. |
| Line | Undocumented feature. |
| TopMargin | Specifies that the vertical positioning is relative to the top margin of the current page. |
| BottomMargin | Specifies that the vertical positioning is relative to the bottom margin of the current page. |
| InsideMargin | Specifies that the vertical positioning is relative to the inside margin of the current page. |
| OutsideMargin | Specifies that the vertical positioning is relative to the outside margin of the current page. |
##### Margin
```
public static final int Margin
```

Specifies that the vertical positioning is relative to the page margins.

##### Page
```
public static final int Page
```

The object is positioned relative to the top edge of the page.

##### Paragraph
```
public static final int Paragraph
```

The object is positioned relative to the top of the paragraph that contains the anchor.

##### Line
```
public static final int Line
```

Undocumented feature.

##### TopMargin
```
public static final int TopMargin
```

Specifies that the vertical positioning is relative to the top margin of the current page.

##### BottomMargin
```
public static final int BottomMargin
```

Specifies that the vertical positioning is relative to the bottom margin of the current page.

##### InsideMargin
```
public static final int InsideMargin
```

Specifies that the vertical positioning is relative to the inside margin of the current page.

##### OutsideMargin
```
public static final int OutsideMargin
```

Specifies that the vertical positioning is relative to the outside margin of the current page.

### WordProcessingSection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingsection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart
```
public class WordProcessingSection extends ContentPart
```

Represents a Word document section.
#### Methods

| Method | Description |
| --- | --- |
| getPageSetup() | Gets the printing page setup for this `WordProcessingSection`. |
| getHeadersFooters() | Gets the collection of all headers and footers of this `WordProcessingSection`. |
| getShapes() | Gets the collection of all shapes contained in this `WordProcessingSection`. |
| getAsposeWordsSection() |  |
| getSearchWatermarksInParts() |  |
| getContent() |  |
| addWatermark(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects) |  |
| getSectionIndex() |  |
##### getPageSetup()
```
public final WordProcessingPageSetup getPageSetup()
```

Gets the printing page setup for this `WordProcessingSection`.

**Returns:**
WordProcessingPageSetup - The printing page setup for this `WordProcessingSection`.
##### getHeadersFooters()
```
public final WordProcessingHeaderFooterCollection getHeadersFooters()
```

Gets the collection of all headers and footers of this `WordProcessingSection`.

**Returns:**
WordProcessingHeaderFooterCollection - The collection of all headers and footers of this `WordProcessingSection`.
##### getShapes()
```
public final WordProcessingShapeCollection getShapes()
```

Gets the collection of all shapes contained in this `WordProcessingSection`.

**Returns:**
WordProcessingShapeCollection - The collection of all shapes contained in this `WordProcessingSection`.
##### getAsposeWordsSection()
```
public final Section getAsposeWordsSection()
```

**Returns:**
com.aspose.words.Section
##### getSearchWatermarksInParts()
```
public boolean getSearchWatermarksInParts()
```

**Returns:**
boolean
##### getContent()
```
public final WordProcessingContent getContent()
```

**Returns:**
WordProcessingContent
##### addWatermark(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects)
```
public final void addWatermark(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | WordProcessingShapeSettings |  |
| effects | IWordProcessingWatermarkEffects |  |

##### getSectionIndex()
```
public final int getSectionIndex()
```

**Returns:**
int

### WordProcessingSectionCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingsectioncollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase
```
public class WordProcessingSectionCollection extends ReadOnlyListBase<WordProcessingSection>
```

Represents a collection of sections in a Word document.

This collection contains the items of `WordProcessingSection` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSectionCollection(WordProcessingContent parent, SectionCollection sourceCollection, IStrategyManager strategyManager) |  |
#### Methods

| Method | Description |
| --- | --- |
| findSection(Section section) |  |
##### WordProcessingSectionCollection(WordProcessingContent parent, SectionCollection sourceCollection, IStrategyManager strategyManager)
```
public WordProcessingSectionCollection(WordProcessingContent parent, SectionCollection sourceCollection, IStrategyManager strategyManager)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | WordProcessingContent |  |
| sourceCollection | com.aspose.words.SectionCollection |  |
| strategyManager | IStrategyManager |  |

##### findSection(Section section)
```
public final WordProcessingSection findSection(Section section)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| section | com.aspose.words.Section |  |

**Returns:**
WordProcessingSection

### WordProcessingShape
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingshape.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.ShapeSearchAdapter

**All Implemented Interfaces:**
com.groupdocs.watermark.search.IRotatableTwoDObject, com.groupdocs.watermark.search.IHyperlinkContainer
```
public class WordProcessingShape extends ShapeSearchAdapter implements IRotatableTwoDObject, IHyperlinkContainer
```

Represents a drawing shape in a Word document.
#### Methods

| Method | Description |
| --- | --- |
| getSection() | Gets the parent section of this `WordProcessingShape`. |
| getHeaderFooter() | Gets the parent header/footer of this `WordProcessingShape` (if presents). |
| getShapeType() | Gets the shape type. |
| isWordArt() | Gets a value indicating whether this `WordProcessingShape` is a WordArt object. |
| getAlternativeText() | Gets the descriptive (alternative) text associated with this `WordProcessingShape`. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text associated with this `WordProcessingShape`. |
| getName() | Gets the name of this `WordProcessingShape`. |
| getBehindText() | Gets a value indicating whether the shape is over or behind the text. |
| setBehindText(boolean value) | Sets a value indicating whether the shape is over or behind the text. |
| getText() | Gets the text of this `WordProcessingShape`. |
| setText(String value) | Sets the text of this `WordProcessingShape`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `WordProcessingShape`. |
| getImage() | Gets the image of this `WordProcessingShape`. |
| setImage(WordProcessingWatermarkableImage value) | Sets the image of this `WordProcessingShape`. |
| getHorizontalAlignment() | Gets a value specifying how the shape is positioned horizontally. |
| getVerticalAlignment() | Gets a value specifying how the shape is positioned vertically. |
| getRelativeHorizontalPosition() | Gets a value specifying to what the shape is positioned horizontally. |
| getRelativeVerticalPosition() | Gets a value specifying to what the shape is positioned vertically. |
| getImageFillFormat() |  |
| getAsposeWordsShape() |  |
| getHyperlink() | Gets the hyperlink associated with this `WordProcessingShape`. |
| setHyperlink(String value) | Sets the hyperlink associated with this `WordProcessingShape`. |
| getWidth() | Gets the width of this `WordProcessingShape` in points. |
| setWidth(double value) | Sets the width of this `WordProcessingShape` in points. |
| getHeight() | Gets the height of this `WordProcessingShape` in points. |
| setHeight(double value) | Sets the height of this `WordProcessingShape` in points. |
| getRotateAngle() | Gets the rotate angle of this `WordProcessingShape` in degrees. |
| setRotateAngle(double value) | Sets the rotate angle of this `WordProcessingShape` in degrees. |
| getX() | Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points. |
| setX(double value) | Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points. |
| getY() | Gets the vertical offset of this `WordProcessingShape` from page top border in points. |
| setY(double value) | Sets the vertical offset of this `WordProcessingShape` from page top border in points. |
| getFormattedTextFragmentsForSearch() |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
| getImageForSearch() |  |
| setFoundWatermarkImage(byte[] imageData) |  |
##### getSection()
```
public final WordProcessingSection getSection()
```

Gets the parent section of this `WordProcessingShape`.

**Returns:**
WordProcessingSection - The parent section of this `WordProcessingShape`.
##### getHeaderFooter()
```
public final WordProcessingHeaderFooter getHeaderFooter()
```

Gets the parent header/footer of this `WordProcessingShape` (if presents).

**Returns:**
WordProcessingHeaderFooter - The parent header/footer of this `WordProcessingShape`.
##### getShapeType()
```
public final int getShapeType()
```

Gets the shape type.

**Returns:**
int - The shape type.
##### isWordArt()
```
public final boolean isWordArt()
```

Gets a value indicating whether this `WordProcessingShape` is a WordArt object.

**Returns:**
boolean - True if the shape is a WordArt object; otherwise, false.
##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text associated with this `WordProcessingShape`.

**Returns:**
java.lang.String - The descriptive (alternative) text associated with this `WordProcessingShape`.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text associated with this `WordProcessingShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text associated with this `WordProcessingShape`. |

##### getName()
```
public final String getName()
```

Gets the name of this `WordProcessingShape`.

**Returns:**
java.lang.String - The name of this `WordProcessingShape`.
##### getBehindText()
```
public final boolean getBehindText()
```

Gets a value indicating whether the shape is over or behind the text.

**Returns:**
boolean - The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.
##### setBehindText(boolean value)
```
public final void setBehindText(boolean value)
```

Sets a value indicating whether the shape is over or behind the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false. |

##### getText()
```
public final String getText()
```

Gets the text of this `WordProcessingShape`.

**Returns:**
java.lang.String - The text of this `WordProcessingShape`.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text of this `WordProcessingShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `WordProcessingShape`. |

##### getFormattedTextFragments()
```
public final FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `WordProcessingShape`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `WordProcessingShape`.
##### getImage()
```
public final WordProcessingWatermarkableImage getImage()
```

Gets the image of this `WordProcessingShape`.

**Returns:**
WordProcessingWatermarkableImage - The image of this `WordProcessingShape` or `null` if the shape has no image.
##### setImage(WordProcessingWatermarkableImage value)
```
public final void setImage(WordProcessingWatermarkableImage value)
```

Sets the image of this `WordProcessingShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | WordProcessingWatermarkableImage | The image of this `WordProcessingShape` or `null` if the image should be removed. |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Gets a value specifying how the shape is positioned horizontally.

**Returns:**
int - The horizontal alignment value.
##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Gets a value specifying how the shape is positioned vertically.

**Returns:**
int - The vertical alignment value.
##### getRelativeHorizontalPosition()
```
public final int getRelativeHorizontalPosition()
```

Gets a value specifying to what the shape is positioned horizontally.

**Returns:**
int - The relative horizontal position value.
##### getRelativeVerticalPosition()
```
public final int getRelativeVerticalPosition()
```

Gets a value specifying to what the shape is positioned vertically.

**Returns:**
int - The relative vertical position value.
##### getImageFillFormat()
```
public final WordProcessingImageFillFormat getImageFillFormat()
```

**Returns:**
WordProcessingImageFillFormat
##### getAsposeWordsShape()
```
public final Shape getAsposeWordsShape()
```

**Returns:**
com.aspose.words.Shape
##### getHyperlink()
```
public final String getHyperlink()
```

Gets the hyperlink associated with this `WordProcessingShape`.

**Returns:**
java.lang.String - The hyperlink associated with this `WordProcessingShape`.
##### setHyperlink(String value)
```
public final void setHyperlink(String value)
```

Sets the hyperlink associated with this `WordProcessingShape`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The hyperlink associated with this `WordProcessingShape`. |

##### getWidth()
```
public final double getWidth()
```

Gets the width of this `WordProcessingShape` in points.

**Returns:**
double - The width of this `WordProcessingShape` in points.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the width of this `WordProcessingShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The width of this `WordProcessingShape` in points. |

##### getHeight()
```
public final double getHeight()
```

Gets the height of this `WordProcessingShape` in points.

**Returns:**
double - The height of this `WordProcessingShape` in points.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the height of this `WordProcessingShape` in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The height of this `WordProcessingShape` in points. |

##### getRotateAngle()
```
public final double getRotateAngle()
```

Gets the rotate angle of this `WordProcessingShape` in degrees.

**Returns:**
double - The rotate angle of this `WordProcessingShape` in degrees.
##### setRotateAngle(double value)
```
public final void setRotateAngle(double value)
```

Sets the rotate angle of this `WordProcessingShape` in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rotate angle of this `WordProcessingShape` in degrees. |

##### getX()
```
public final double getX()
```

Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.

**Returns:**
double - The x-coordinate of this `WordProcessingShape`.
##### setX(double value)
```
public final void setX(double value)
```

Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of this `WordProcessingShape`. |

##### getY()
```
public final double getY()
```

Gets the vertical offset of this `WordProcessingShape` from page top border in points.

**Returns:**
double - The y-coordinate of this `WordProcessingShape`.
##### setY(double value)
```
public final void setY(double value)
```

Sets the vertical offset of this `WordProcessingShape` from page top border in points.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of this `WordProcessingShape`. |

##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

### WordProcessingShapeCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingshapecollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class WordProcessingShapeCollection extends RemoveOnlyListBase<WordProcessingShape>
```

Represents a collection of shapes in a Word document.

This collection contains the items of `WordProcessingShape` type.
#### Methods

| Method | Description |
| --- | --- |
| refresh() |  |
| removeFromDocument(WordProcessingShape item) |  |
##### refresh()
```
public final void refresh()
```

##### removeFromDocument(WordProcessingShape item)
```
public void removeFromDocument(WordProcessingShape item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | WordProcessingShape |  |

### WordProcessingShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingshapeformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection, com.groupdocs.watermark.contents.WordProcessingFormattedTextFragmentCollection
```
public class WordProcessingShapeFormattedTextFragmentCollection extends WordProcessingFormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a Word document shape.

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| setText(String text) |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### WordProcessingShapeType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingshapetype.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingShapeType
```

Represents the type of a shape in a Word document.
#### Fields

| Field | Description |
| --- | --- |
| MinValue | Built-in shape type. |
| OleObject | Built-in shape type. |
| Group | Built-in shape type. |
| NonPrimitive | Built-in shape type. |
| Rectangle | Built-in shape type. |
| RoundRectangle | Built-in shape type. |
| Ellipse | Built-in shape type. |
| Diamond | Built-in shape type. |
| Triangle | Built-in shape type. |
| RightTriangle | Built-in shape type. |
| Parallelogram | Built-in shape type. |
| Trapezoid | Built-in shape type. |
| Hexagon | Built-in shape type. |
| Octagon | Built-in shape type. |
| Plus | Built-in shape type. |
| Star | Built-in shape type. |
| Arrow | Built-in shape type. |
| ThickArrow | Built-in shape type. |
| HomePlate | Built-in shape type. |
| Cube | Built-in shape type. |
| Balloon | Built-in shape type. |
| Seal | Built-in shape type. |
| Arc | Built-in shape type. |
| Line | Built-in shape type. |
| Plaque | Built-in shape type. |
| Can | Built-in shape type. |
| Donut | Built-in shape type. |
| TextSimple | Built-in shape type. |
| TextOctagon | Built-in shape type. |
| TextHexagon | Built-in shape type. |
| TextCurve | Built-in shape type. |
| TextWave | Built-in shape type. |
| TextRing | Built-in shape type. |
| TextOnCurve | Built-in shape type. |
| TextOnRing | Built-in shape type. |
| StraightConnector1 | Built-in shape type. |
| BentConnector2 | Built-in shape type. |
| BentConnector3 | Built-in shape type. |
| BentConnector4 | Built-in shape type. |
| BentConnector5 | Built-in shape type. |
| CurvedConnector2 | Built-in shape type. |
| CurvedConnector3 | Built-in shape type. |
| CurvedConnector4 | Built-in shape type. |
| CurvedConnector5 | Built-in shape type. |
| Callout1 | Built-in shape type. |
| Callout2 | Built-in shape type. |
| Callout3 | Built-in shape type. |
| AccentCallout1 | Built-in shape type. |
| AccentCallout2 | Built-in shape type. |
| AccentCallout3 | Built-in shape type. |
| BorderCallout1 | Built-in shape type. |
| BorderCallout2 | Built-in shape type. |
| BorderCallout3 | Built-in shape type. |
| AccentBorderCallout1 | Built-in shape type. |
| AccentBorderCallout2 | Built-in shape type. |
| AccentBorderCallout3 | Built-in shape type. |
| Ribbon | Built-in shape type. |
| Ribbon2 | Built-in shape type. |
| Chevron | Built-in shape type. |
| Pentagon | Built-in shape type. |
| NoSmoking | Built-in shape type. |
| Seal8 | Built-in shape type. |
| Seal16 | Built-in shape type. |
| Seal32 | Built-in shape type. |
| WedgeRectCallout | Built-in shape type. |
| WedgeRRectCallout | Built-in shape type. |
| WedgeEllipseCallout | Built-in shape type. |
| Wave | Built-in shape type. |
| FoldedCorner | Built-in shape type. |
| LeftArrow | Built-in shape type. |
| DownArrow | Built-in shape type. |
| UpArrow | Built-in shape type. |
| LeftRightArrow | Built-in shape type. |
| UpDownArrow | Built-in shape type. |
| IrregularSeal1 | Built-in shape type. |
| IrregularSeal2 | Built-in shape type. |
| LightningBolt | Built-in shape type. |
| Heart | Built-in shape type. |
| Image | Built-in shape type. |
| QuadArrow | Built-in shape type. |
| LeftArrowCallout | Built-in shape type. |
| RightArrowCallout | Built-in shape type. |
| UpArrowCallout | Built-in shape type. |
| DownArrowCallout | Built-in shape type. |
| LeftRightArrowCallout | Built-in shape type. |
| UpDownArrowCallout | Built-in shape type. |
| QuadArrowCallout | Built-in shape type. |
| Bevel | Built-in shape type. |
| LeftBracket | Built-in shape type. |
| RightBracket | Built-in shape type. |
| LeftBrace | Built-in shape type. |
| RightBrace | Built-in shape type. |
| LeftUpArrow | Built-in shape type. |
| BentUpArrow | Built-in shape type. |
| BentArrow | Built-in shape type. |
| Seal24 | Built-in shape type. |
| StripedRightArrow | Built-in shape type. |
| NotchedRightArrow | Built-in shape type. |
| BlockArc | Built-in shape type. |
| SmileyFace | Built-in shape type. |
| VerticalScroll | Built-in shape type. |
| HorizontalScroll | Built-in shape type. |
| CircularArrow | Built-in shape type. |
| CustomShape | Built-in shape type. |
| UturnArrow | Built-in shape type. |
| CurvedRightArrow | Built-in shape type. |
| CurvedLeftArrow | Built-in shape type. |
| CurvedUpArrow | Built-in shape type. |
| CurvedDownArrow | Built-in shape type. |
| CloudCallout | Built-in shape type. |
| EllipseRibbon | Built-in shape type. |
| EllipseRibbon2 | Built-in shape type. |
| FlowChartProcess | Built-in shape type. |
| FlowChartDecision | Built-in shape type. |
| FlowChartInputOutput | Built-in shape type. |
| FlowChartPredefinedProcess | Built-in shape type. |
| FlowChartInternalStorage | Built-in shape type. |
| FlowChartDocument | Built-in shape type. |
| FlowChartMultidocument | Built-in shape type. |
| FlowChartTerminator | Built-in shape type. |
| FlowChartPreparation | Built-in shape type. |
| FlowChartManualInput | Built-in shape type. |
| FlowChartManualOperation | Built-in shape type. |
| FlowChartConnector | Built-in shape type. |
| FlowChartPunchedCard | Built-in shape type. |
| FlowChartPunchedTape | Built-in shape type. |
| FlowChartSummingJunction | Built-in shape type. |
| FlowChartOr | Built-in shape type. |
| FlowChartCollate | Built-in shape type. |
| FlowChartSort | Built-in shape type. |
| FlowChartExtract | Built-in shape type. |
| FlowChartMerge | Built-in shape type. |
| FlowChartOfflineStorage | Built-in shape type. |
| FlowChartOnlineStorage | Built-in shape type. |
| FlowChartMagneticTape | Built-in shape type. |
| FlowChartMagneticDisk | Built-in shape type. |
| FlowChartMagneticDrum | Built-in shape type. |
| FlowChartDisplay | Built-in shape type. |
| FlowChartDelay | Built-in shape type. |
| TextPlainText | Built-in shape type. |
| TextStop | Built-in shape type. |
| TextTriangle | Built-in shape type. |
| TextTriangleInverted | Built-in shape type. |
| TextChevron | Built-in shape type. |
| TextChevronInverted | Built-in shape type. |
| TextRingInside | Built-in shape type. |
| TextRingOutside | Built-in shape type. |
| TextArchUpCurve | Built-in shape type. |
| TextArchDownCurve | Built-in shape type. |
| TextCircleCurve | Built-in shape type. |
| TextButtonCurve | Built-in shape type. |
| TextArchUpPour | Built-in shape type. |
| TextArchDownPour | Built-in shape type. |
| TextCirclePour | Built-in shape type. |
| TextButtonPour | Built-in shape type. |
| TextCurveUp | Built-in shape type. |
| TextCurveDown | Built-in shape type. |
| TextCascadeUp | Built-in shape type. |
| TextCascadeDown | Built-in shape type. |
| TextWave1 | Built-in shape type. |
| TextWave2 | Built-in shape type. |
| TextWave3 | Built-in shape type. |
| TextWave4 | Built-in shape type. |
| TextInflate | Built-in shape type. |
| TextDeflate | Built-in shape type. |
| TextInflateBottom | Built-in shape type. |
| TextDeflateBottom | Built-in shape type. |
| TextInflateTop | Built-in shape type. |
| TextDeflateTop | Built-in shape type. |
| TextDeflateInflate | Built-in shape type. |
| TextDeflateInflateDeflate | Built-in shape type. |
| TextFadeRight | Built-in shape type. |
| TextFadeLeft | Built-in shape type. |
| TextFadeUp | Built-in shape type. |
| TextFadeDown | Built-in shape type. |
| TextSlantUp | Built-in shape type. |
| TextSlantDown | Built-in shape type. |
| TextCanUp | Built-in shape type. |
| TextCanDown | Built-in shape type. |
| FlowChartAlternateProcess | Built-in shape type. |
| FlowChartOffpageConnector | Built-in shape type. |
| Callout90 | Built-in shape type. |
| AccentCallout90 | Built-in shape type. |
| BorderCallout90 | Built-in shape type. |
| AccentBorderCallout90 | Built-in shape type. |
| LeftRightUpArrow | Built-in shape type. |
| Sun | Built-in shape type. |
| Moon | Built-in shape type. |
| BracketPair | Built-in shape type. |
| BracePair | Built-in shape type. |
| Seal4 | Built-in shape type. |
| DoubleWave | Built-in shape type. |
| ActionButtonBlank | Built-in shape type. |
| ActionButtonHome | Built-in shape type. |
| ActionButtonHelp | Built-in shape type. |
| ActionButtonInformation | Built-in shape type. |
| ActionButtonForwardNext | Built-in shape type. |
| ActionButtonBackPrevious | Built-in shape type. |
| ActionButtonEnd | Built-in shape type. |
| ActionButtonBeginning | Built-in shape type. |
| ActionButtonReturn | Built-in shape type. |
| ActionButtonDocument | Built-in shape type. |
| ActionButtonSound | Built-in shape type. |
| ActionButtonMovie | Built-in shape type. |
| OleControl | Built-in shape type. |
| TextBox | Built-in shape type. |
| SingleCornerSnipped | Built-in shape type. |
| TopCornersSnipped | Built-in shape type. |
| DiagonalCornersSnipped | Built-in shape type. |
| TopCornersOneRoundedOneSnipped | Built-in shape type. |
| SingleCornerRounded | Built-in shape type. |
| TopCornersRounded | Built-in shape type. |
| DiagonalCornersRounded | Built-in shape type. |
##### MinValue
```
public static final int MinValue
```

Built-in shape type.

##### OleObject
```
public static final int OleObject
```

Built-in shape type.

##### Group
```
public static final int Group
```

Built-in shape type.

##### NonPrimitive
```
public static final int NonPrimitive
```

Built-in shape type.

##### Rectangle
```
public static final int Rectangle
```

Built-in shape type.

##### RoundRectangle
```
public static final int RoundRectangle
```

Built-in shape type.

##### Ellipse
```
public static final int Ellipse
```

Built-in shape type.

##### Diamond
```
public static final int Diamond
```

Built-in shape type.

##### Triangle
```
public static final int Triangle
```

Built-in shape type.

##### RightTriangle
```
public static final int RightTriangle
```

Built-in shape type.

##### Parallelogram
```
public static final int Parallelogram
```

Built-in shape type.

##### Trapezoid
```
public static final int Trapezoid
```

Built-in shape type.

##### Hexagon
```
public static final int Hexagon
```

Built-in shape type.

##### Octagon
```
public static final int Octagon
```

Built-in shape type.

##### Plus
```
public static final int Plus
```

Built-in shape type.

##### Star
```
public static final int Star
```

Built-in shape type.

##### Arrow
```
public static final int Arrow
```

Built-in shape type.

##### ThickArrow
```
public static final int ThickArrow
```

Built-in shape type.

##### HomePlate
```
public static final int HomePlate
```

Built-in shape type.

##### Cube
```
public static final int Cube
```

Built-in shape type.

##### Balloon
```
public static final int Balloon
```

Built-in shape type.

##### Seal
```
public static final int Seal
```

Built-in shape type.

##### Arc
```
public static final int Arc
```

Built-in shape type.

##### Line
```
public static final int Line
```

Built-in shape type.

##### Plaque
```
public static final int Plaque
```

Built-in shape type.

##### Can
```
public static final int Can
```

Built-in shape type.

##### Donut
```
public static final int Donut
```

Built-in shape type.

##### TextSimple
```
public static final int TextSimple
```

Built-in shape type.

##### TextOctagon
```
public static final int TextOctagon
```

Built-in shape type.

##### TextHexagon
```
public static final int TextHexagon
```

Built-in shape type.

##### TextCurve
```
public static final int TextCurve
```

Built-in shape type.

##### TextWave
```
public static final int TextWave
```

Built-in shape type.

##### TextRing
```
public static final int TextRing
```

Built-in shape type.

##### TextOnCurve
```
public static final int TextOnCurve
```

Built-in shape type.

##### TextOnRing
```
public static final int TextOnRing
```

Built-in shape type.

##### StraightConnector1
```
public static final int StraightConnector1
```

Built-in shape type.

##### BentConnector2
```
public static final int BentConnector2
```

Built-in shape type.

##### BentConnector3
```
public static final int BentConnector3
```

Built-in shape type.

##### BentConnector4
```
public static final int BentConnector4
```

Built-in shape type.

##### BentConnector5
```
public static final int BentConnector5
```

Built-in shape type.

##### CurvedConnector2
```
public static final int CurvedConnector2
```

Built-in shape type.

##### CurvedConnector3
```
public static final int CurvedConnector3
```

Built-in shape type.

##### CurvedConnector4
```
public static final int CurvedConnector4
```

Built-in shape type.

##### CurvedConnector5
```
public static final int CurvedConnector5
```

Built-in shape type.

##### Callout1
```
public static final int Callout1
```

Built-in shape type.

##### Callout2
```
public static final int Callout2
```

Built-in shape type.

##### Callout3
```
public static final int Callout3
```

Built-in shape type.

##### AccentCallout1
```
public static final int AccentCallout1
```

Built-in shape type.

##### AccentCallout2
```
public static final int AccentCallout2
```

Built-in shape type.

##### AccentCallout3
```
public static final int AccentCallout3
```

Built-in shape type.

##### BorderCallout1
```
public static final int BorderCallout1
```

Built-in shape type.

##### BorderCallout2
```
public static final int BorderCallout2
```

Built-in shape type.

##### BorderCallout3
```
public static final int BorderCallout3
```

Built-in shape type.

##### AccentBorderCallout1
```
public static final int AccentBorderCallout1
```

Built-in shape type.

##### AccentBorderCallout2
```
public static final int AccentBorderCallout2
```

Built-in shape type.

##### AccentBorderCallout3
```
public static final int AccentBorderCallout3
```

Built-in shape type.

##### Ribbon
```
public static final int Ribbon
```

Built-in shape type.

##### Ribbon2
```
public static final int Ribbon2
```

Built-in shape type.

##### Chevron
```
public static final int Chevron
```

Built-in shape type.

##### Pentagon
```
public static final int Pentagon
```

Built-in shape type.

##### NoSmoking
```
public static final int NoSmoking
```

Built-in shape type.

##### Seal8
```
public static final int Seal8
```

Built-in shape type.

##### Seal16
```
public static final int Seal16
```

Built-in shape type.

##### Seal32
```
public static final int Seal32
```

Built-in shape type.

##### WedgeRectCallout
```
public static final int WedgeRectCallout
```

Built-in shape type.

##### WedgeRRectCallout
```
public static final int WedgeRRectCallout
```

Built-in shape type.

##### WedgeEllipseCallout
```
public static final int WedgeEllipseCallout
```

Built-in shape type.

##### Wave
```
public static final int Wave
```

Built-in shape type.

##### FoldedCorner
```
public static final int FoldedCorner
```

Built-in shape type.

##### LeftArrow
```
public static final int LeftArrow
```

Built-in shape type.

##### DownArrow
```
public static final int DownArrow
```

Built-in shape type.

##### UpArrow
```
public static final int UpArrow
```

Built-in shape type.

##### LeftRightArrow
```
public static final int LeftRightArrow
```

Built-in shape type.

##### UpDownArrow
```
public static final int UpDownArrow
```

Built-in shape type.

##### IrregularSeal1
```
public static final int IrregularSeal1
```

Built-in shape type.

##### IrregularSeal2
```
public static final int IrregularSeal2
```

Built-in shape type.

##### LightningBolt
```
public static final int LightningBolt
```

Built-in shape type.

##### Heart
```
public static final int Heart
```

Built-in shape type.

##### Image
```
public static final int Image
```

Built-in shape type.

##### QuadArrow
```
public static final int QuadArrow
```

Built-in shape type.

##### LeftArrowCallout
```
public static final int LeftArrowCallout
```

Built-in shape type.

##### RightArrowCallout
```
public static final int RightArrowCallout
```

Built-in shape type.

##### UpArrowCallout
```
public static final int UpArrowCallout
```

Built-in shape type.

##### DownArrowCallout
```
public static final int DownArrowCallout
```

Built-in shape type.

##### LeftRightArrowCallout
```
public static final int LeftRightArrowCallout
```

Built-in shape type.

##### UpDownArrowCallout
```
public static final int UpDownArrowCallout
```

Built-in shape type.

##### QuadArrowCallout
```
public static final int QuadArrowCallout
```

Built-in shape type.

##### Bevel
```
public static final int Bevel
```

Built-in shape type.

##### LeftBracket
```
public static final int LeftBracket
```

Built-in shape type.

##### RightBracket
```
public static final int RightBracket
```

Built-in shape type.

##### LeftBrace
```
public static final int LeftBrace
```

Built-in shape type.

##### RightBrace
```
public static final int RightBrace
```

Built-in shape type.

##### LeftUpArrow
```
public static final int LeftUpArrow
```

Built-in shape type.

##### BentUpArrow
```
public static final int BentUpArrow
```

Built-in shape type.

##### BentArrow
```
public static final int BentArrow
```

Built-in shape type.

##### Seal24
```
public static final int Seal24
```

Built-in shape type.

##### StripedRightArrow
```
public static final int StripedRightArrow
```

Built-in shape type.

##### NotchedRightArrow
```
public static final int NotchedRightArrow
```

Built-in shape type.

##### BlockArc
```
public static final int BlockArc
```

Built-in shape type.

##### SmileyFace
```
public static final int SmileyFace
```

Built-in shape type.

##### VerticalScroll
```
public static final int VerticalScroll
```

Built-in shape type.

##### HorizontalScroll
```
public static final int HorizontalScroll
```

Built-in shape type.

##### CircularArrow
```
public static final int CircularArrow
```

Built-in shape type.

##### CustomShape
```
public static final int CustomShape
```

Built-in shape type.

##### UturnArrow
```
public static final int UturnArrow
```

Built-in shape type.

##### CurvedRightArrow
```
public static final int CurvedRightArrow
```

Built-in shape type.

##### CurvedLeftArrow
```
public static final int CurvedLeftArrow
```

Built-in shape type.

##### CurvedUpArrow
```
public static final int CurvedUpArrow
```

Built-in shape type.

##### CurvedDownArrow
```
public static final int CurvedDownArrow
```

Built-in shape type.

##### CloudCallout
```
public static final int CloudCallout
```

Built-in shape type.

##### EllipseRibbon
```
public static final int EllipseRibbon
```

Built-in shape type.

##### EllipseRibbon2
```
public static final int EllipseRibbon2
```

Built-in shape type.

##### FlowChartProcess
```
public static final int FlowChartProcess
```

Built-in shape type.

##### FlowChartDecision
```
public static final int FlowChartDecision
```

Built-in shape type.

##### FlowChartInputOutput
```
public static final int FlowChartInputOutput
```

Built-in shape type.

##### FlowChartPredefinedProcess
```
public static final int FlowChartPredefinedProcess
```

Built-in shape type.

##### FlowChartInternalStorage
```
public static final int FlowChartInternalStorage
```

Built-in shape type.

##### FlowChartDocument
```
public static final int FlowChartDocument
```

Built-in shape type.

##### FlowChartMultidocument
```
public static final int FlowChartMultidocument
```

Built-in shape type.

##### FlowChartTerminator
```
public static final int FlowChartTerminator
```

Built-in shape type.

##### FlowChartPreparation
```
public static final int FlowChartPreparation
```

Built-in shape type.

##### FlowChartManualInput
```
public static final int FlowChartManualInput
```

Built-in shape type.

##### FlowChartManualOperation
```
public static final int FlowChartManualOperation
```

Built-in shape type.

##### FlowChartConnector
```
public static final int FlowChartConnector
```

Built-in shape type.

##### FlowChartPunchedCard
```
public static final int FlowChartPunchedCard
```

Built-in shape type.

##### FlowChartPunchedTape
```
public static final int FlowChartPunchedTape
```

Built-in shape type.

##### FlowChartSummingJunction
```
public static final int FlowChartSummingJunction
```

Built-in shape type.

##### FlowChartOr
```
public static final int FlowChartOr
```

Built-in shape type.

##### FlowChartCollate
```
public static final int FlowChartCollate
```

Built-in shape type.

##### FlowChartSort
```
public static final int FlowChartSort
```

Built-in shape type.

##### FlowChartExtract
```
public static final int FlowChartExtract
```

Built-in shape type.

##### FlowChartMerge
```
public static final int FlowChartMerge
```

Built-in shape type.

##### FlowChartOfflineStorage
```
public static final int FlowChartOfflineStorage
```

Built-in shape type.

##### FlowChartOnlineStorage
```
public static final int FlowChartOnlineStorage
```

Built-in shape type.

##### FlowChartMagneticTape
```
public static final int FlowChartMagneticTape
```

Built-in shape type.

##### FlowChartMagneticDisk
```
public static final int FlowChartMagneticDisk
```

Built-in shape type.

##### FlowChartMagneticDrum
```
public static final int FlowChartMagneticDrum
```

Built-in shape type.

##### FlowChartDisplay
```
public static final int FlowChartDisplay
```

Built-in shape type.

##### FlowChartDelay
```
public static final int FlowChartDelay
```

Built-in shape type.

##### TextPlainText
```
public static final int TextPlainText
```

Built-in shape type.

##### TextStop
```
public static final int TextStop
```

Built-in shape type.

##### TextTriangle
```
public static final int TextTriangle
```

Built-in shape type.

##### TextTriangleInverted
```
public static final int TextTriangleInverted
```

Built-in shape type.

##### TextChevron
```
public static final int TextChevron
```

Built-in shape type.

##### TextChevronInverted
```
public static final int TextChevronInverted
```

Built-in shape type.

##### TextRingInside
```
public static final int TextRingInside
```

Built-in shape type.

##### TextRingOutside
```
public static final int TextRingOutside
```

Built-in shape type.

##### TextArchUpCurve
```
public static final int TextArchUpCurve
```

Built-in shape type.

##### TextArchDownCurve
```
public static final int TextArchDownCurve
```

Built-in shape type.

##### TextCircleCurve
```
public static final int TextCircleCurve
```

Built-in shape type.

##### TextButtonCurve
```
public static final int TextButtonCurve
```

Built-in shape type.

##### TextArchUpPour
```
public static final int TextArchUpPour
```

Built-in shape type.

##### TextArchDownPour
```
public static final int TextArchDownPour
```

Built-in shape type.

##### TextCirclePour
```
public static final int TextCirclePour
```

Built-in shape type.

##### TextButtonPour
```
public static final int TextButtonPour
```

Built-in shape type.

##### TextCurveUp
```
public static final int TextCurveUp
```

Built-in shape type.

##### TextCurveDown
```
public static final int TextCurveDown
```

Built-in shape type.

##### TextCascadeUp
```
public static final int TextCascadeUp
```

Built-in shape type.

##### TextCascadeDown
```
public static final int TextCascadeDown
```

Built-in shape type.

##### TextWave1
```
public static final int TextWave1
```

Built-in shape type.

##### TextWave2
```
public static final int TextWave2
```

Built-in shape type.

##### TextWave3
```
public static final int TextWave3
```

Built-in shape type.

##### TextWave4
```
public static final int TextWave4
```

Built-in shape type.

##### TextInflate
```
public static final int TextInflate
```

Built-in shape type.

##### TextDeflate
```
public static final int TextDeflate
```

Built-in shape type.

##### TextInflateBottom
```
public static final int TextInflateBottom
```

Built-in shape type.

##### TextDeflateBottom
```
public static final int TextDeflateBottom
```

Built-in shape type.

##### TextInflateTop
```
public static final int TextInflateTop
```

Built-in shape type.

##### TextDeflateTop
```
public static final int TextDeflateTop
```

Built-in shape type.

##### TextDeflateInflate
```
public static final int TextDeflateInflate
```

Built-in shape type.

##### TextDeflateInflateDeflate
```
public static final int TextDeflateInflateDeflate
```

Built-in shape type.

##### TextFadeRight
```
public static final int TextFadeRight
```

Built-in shape type.

##### TextFadeLeft
```
public static final int TextFadeLeft
```

Built-in shape type.

##### TextFadeUp
```
public static final int TextFadeUp
```

Built-in shape type.

##### TextFadeDown
```
public static final int TextFadeDown
```

Built-in shape type.

##### TextSlantUp
```
public static final int TextSlantUp
```

Built-in shape type.

##### TextSlantDown
```
public static final int TextSlantDown
```

Built-in shape type.

##### TextCanUp
```
public static final int TextCanUp
```

Built-in shape type.

##### TextCanDown
```
public static final int TextCanDown
```

Built-in shape type.

##### FlowChartAlternateProcess
```
public static final int FlowChartAlternateProcess
```

Built-in shape type.

##### FlowChartOffpageConnector
```
public static final int FlowChartOffpageConnector
```

Built-in shape type.

##### Callout90
```
public static final int Callout90
```

Built-in shape type.

##### AccentCallout90
```
public static final int AccentCallout90
```

Built-in shape type.

##### BorderCallout90
```
public static final int BorderCallout90
```

Built-in shape type.

##### AccentBorderCallout90
```
public static final int AccentBorderCallout90
```

Built-in shape type.

##### LeftRightUpArrow
```
public static final int LeftRightUpArrow
```

Built-in shape type.

##### Sun
```
public static final int Sun
```

Built-in shape type.

##### Moon
```
public static final int Moon
```

Built-in shape type.

##### BracketPair
```
public static final int BracketPair
```

Built-in shape type.

##### BracePair
```
public static final int BracePair
```

Built-in shape type.

##### Seal4
```
public static final int Seal4
```

Built-in shape type.

##### DoubleWave
```
public static final int DoubleWave
```

Built-in shape type.

##### ActionButtonBlank
```
public static final int ActionButtonBlank
```

Built-in shape type.

##### ActionButtonHome
```
public static final int ActionButtonHome
```

Built-in shape type.

##### ActionButtonHelp
```
public static final int ActionButtonHelp
```

Built-in shape type.

##### ActionButtonInformation
```
public static final int ActionButtonInformation
```

Built-in shape type.

##### ActionButtonForwardNext
```
public static final int ActionButtonForwardNext
```

Built-in shape type.

##### ActionButtonBackPrevious
```
public static final int ActionButtonBackPrevious
```

Built-in shape type.

##### ActionButtonEnd
```
public static final int ActionButtonEnd
```

Built-in shape type.

##### ActionButtonBeginning
```
public static final int ActionButtonBeginning
```

Built-in shape type.

##### ActionButtonReturn
```
public static final int ActionButtonReturn
```

Built-in shape type.

##### ActionButtonDocument
```
public static final int ActionButtonDocument
```

Built-in shape type.

##### ActionButtonSound
```
public static final int ActionButtonSound
```

Built-in shape type.

##### ActionButtonMovie
```
public static final int ActionButtonMovie
```

Built-in shape type.

##### OleControl
```
public static final int OleControl
```

Built-in shape type.

##### TextBox
```
public static final int TextBox
```

Built-in shape type.

##### SingleCornerSnipped
```
public static final int SingleCornerSnipped
```

Built-in shape type.

##### TopCornersSnipped
```
public static final int TopCornersSnipped
```

Built-in shape type.

##### DiagonalCornersSnipped
```
public static final int DiagonalCornersSnipped
```

Built-in shape type.

##### TopCornersOneRoundedOneSnipped
```
public static final int TopCornersOneRoundedOneSnipped
```

Built-in shape type.

##### SingleCornerRounded
```
public static final int SingleCornerRounded
```

Built-in shape type.

##### TopCornersRounded
```
public static final int TopCornersRounded
```

Built-in shape type.

##### DiagonalCornersRounded
```
public static final int DiagonalCornersRounded
```

Built-in shape type.

### WordProcessingTextFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingtextformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class WordProcessingTextFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in a Word document.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### WordProcessingTextFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingtextformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection, com.groupdocs.watermark.contents.WordProcessingFormattedTextFragmentCollection
```
public class WordProcessingTextFormattedTextFragmentCollection extends WordProcessingFormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a Word document main text.

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingTextFormattedTextFragmentCollection(ReplacingArgs replacingArgs, WordProcessingTextPossibleWatermark parentWatermark) |  |
#### Methods

| Method | Description |
| --- | --- |
| setText(String text) |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
##### WordProcessingTextFormattedTextFragmentCollection(ReplacingArgs replacingArgs, WordProcessingTextPossibleWatermark parentWatermark)
```
public WordProcessingTextFormattedTextFragmentCollection(ReplacingArgs replacingArgs, WordProcessingTextPossibleWatermark parentWatermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| replacingArgs | com.aspose.words.ReplacingArgs |  |
| parentWatermark | WordProcessingTextPossibleWatermark |  |

##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment

### WordProcessingUtils
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingutils.md

**Inheritance:**
java.lang.Object
```
public class WordProcessingUtils
```
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingUtils() |  |
#### Methods

| Method | Description |
| --- | --- |
| <T>getParent(Class<T> type, Node node) |  |
| buildSettings(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects, WordProcessingPlacementSettings placementSettings, Content parent) |  |
##### WordProcessingUtils()
```
public WordProcessingUtils()
```

##### <T>getParent(Class<T> type, Node node)
```
public static T <T>getParent(Class<T> type, Node node)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | java.lang.Class<T> |  |
| node | com.aspose.words.Node |  |

**Returns:**
T
##### buildSettings(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects, WordProcessingPlacementSettings placementSettings, Content parent)
```
public static DocumentSpecificSettingsCollection buildSettings(Watermark watermark, WordProcessingShapeSettings shapeSettings, IWordProcessingWatermarkEffects effects, WordProcessingPlacementSettings placementSettings, Content parent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |
| shapeSettings | WordProcessingShapeSettings |  |
| effects | IWordProcessingWatermarkEffects |  |
| placementSettings | WordProcessingPlacementSettings |  |
| parent | Content |  |

**Returns:**
DocumentSpecificSettingsCollection

### WordProcessingVerticalAlignment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingverticalalignment.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingVerticalAlignment
```

Specifies vertical alignment of a floating object.
#### Fields

| Field | Description |
| --- | --- |
| Inline | Not documented. |
| None | The object is explicitly positioned using its y-coordinate. |
| Top | Specifies that the object is at the top of the vertical alignment base. |
| Center | Specifies that the object is centered with respect to the vertical alignment bas. |
| Bottom | Specifies that the object is at the bottom of the vertical alignment base. |
| Inside | Specifies that the object is inside of the horizontal alignment base. |
| Outside | Specifies that the object is outside of the vertical alignment base. |
##### Inline
```
public static final int Inline
```

Not documented. Seems to be a possible value for floating paragraphs and tables.

##### None
```
public static final int None
```

The object is explicitly positioned using its y-coordinate.

##### Top
```
public static final int Top
```

Specifies that the object is at the top of the vertical alignment base.

##### Center
```
public static final int Center
```

Specifies that the object is centered with respect to the vertical alignment bas.

##### Bottom
```
public static final int Bottom
```

Specifies that the object is at the bottom of the vertical alignment base.

##### Inside
```
public static final int Inside
```

Specifies that the object is inside of the horizontal alignment base.

##### Outside
```
public static final int Outside
```

Specifies that the object is outside of the vertical alignment base.

### WordProcessingWatermarkableImage
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingwatermarkableimage.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.ContentPart, com.groupdocs.watermark.contents.WatermarkableImage
```
public class WordProcessingWatermarkableImage extends WatermarkableImage
```

Represents an image inside a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingWatermarkableImage(byte[] imageData) | Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data. |
| WordProcessingWatermarkableImage(Content content, ImageData imageData, byte[] imageBytes) |  |
#### Methods

| Method | Description |
| --- | --- |
| addReference(ImageData imageData) |  |
| removeReference(ImageData imageData) |  |
##### WordProcessingWatermarkableImage(byte[] imageData)
```
public WordProcessingWatermarkableImage(byte[] imageData)
```

Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] | The array of unsigned bytes from which to create the `WordProcessingWatermarkableImage`. |

##### WordProcessingWatermarkableImage(Content content, ImageData imageData, byte[] imageBytes)
```
public WordProcessingWatermarkableImage(Content content, ImageData imageData, byte[] imageBytes)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | Content |  |
| imageData | com.aspose.words.ImageData |  |
| imageBytes | byte[] |  |

##### addReference(ImageData imageData)
```
public final void addReference(ImageData imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | com.aspose.words.ImageData |  |

##### removeReference(ImageData imageData)
```
public final void removeReference(ImageData imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | com.aspose.words.ImageData |  |

### WordProcessingWordArtShapeFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingwordartshapeformattedtextfragment.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.FormattedTextFragment
```
public class WordProcessingWordArtShapeFormattedTextFragment extends FormattedTextFragment
```

Represents a fragment of formatted text in a WordArt shape.
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### getText()
```
public String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### WordProcessingWordArtShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.contents/wordprocessingwordartshapeformattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase, com.groupdocs.watermark.search.FormattedTextFragmentCollection, com.groupdocs.watermark.contents.WordProcessingFormattedTextFragmentCollection
```
public class WordProcessingWordArtShapeFormattedTextFragmentCollection extends WordProcessingFormattedTextFragmentCollection
```

Represents a collection of formatted text fragments in a Word document WordArt shape.

This collection contains the items of `WordProcessingWordArtShapeFormattedTextFragment` type.
#### Methods

| Method | Description |
| --- | --- |
| getText() |  |
| removeFromDocument(FormattedTextFragment item) |  |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
| setText(String text) |  |
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### removeFromDocument(FormattedTextFragment item)
```
public void removeFromDocument(FormattedTextFragment item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | FormattedTextFragment |  |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

### com.groupdocs.watermark.exceptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions.md

#### Classes

| Class | Description |
| --- | --- |
| DetachedImageException | The exception that is thrown when manipulating detached image. |
| EncryptionIsNotSupportedException | The exception that is thrown when content encryption is not supported. |
| FontNotFoundException | The exception that is thrown when requested font is not found. |
| ImageEffectsForTextWatermarkException | The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`. |
| InvalidPasswordException | The exception that is thrown when supplied password is incorrect. |
| PreviewNotSupportedException | The exception that is thrown when a preview image cannot be generated for the content. |
| TextEffectsForImageWatermarkException | The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`. |
| UnexpectedDocumentStructureException | The exception that is thrown when a content cannot be parsed due to unexpected structure. |
| UnknownLoadOptionsTypeException | The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`. |
| UnknownWatermarkOptionsTypeException | The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`. |
| UnsupportedFileTypeException | The exception that is thrown when a file cannot be loaded. |
| WatermarkException | Represents base exception in **GroupDocs.Watermark** product. |

### DetachedImageException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/detachedimageexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class DetachedImageException extends WatermarkException
```

The exception that is thrown when manipulating detached image.
#### Constructors

| Constructor | Description |
| --- | --- |
| DetachedImageException() | Initializes a new instance of the `DetachedImageException` class. |
##### DetachedImageException()
```
public DetachedImageException()
```

Initializes a new instance of the `DetachedImageException` class.

### EncryptionIsNotSupportedException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/encryptionisnotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class EncryptionIsNotSupportedException extends WatermarkException
```

The exception that is thrown when content encryption is not supported.
#### Constructors

| Constructor | Description |
| --- | --- |
| EncryptionIsNotSupportedException() | Initializes a new instance of the `EncryptionIsNotSupportedException` class. |
##### EncryptionIsNotSupportedException()
```
public EncryptionIsNotSupportedException()
```

Initializes a new instance of the `EncryptionIsNotSupportedException` class.

### FontNotFoundException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/fontnotfoundexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class FontNotFoundException extends WatermarkException
```

The exception that is thrown when requested font is not found.
#### Constructors

| Constructor | Description |
| --- | --- |
| FontNotFoundException() | Initializes a new instance of the `FontNotFoundException` class. |
| FontNotFoundException(String fontName) | Initializes a new instance of the `FontNotFoundException` class with a specified font name. |
#### Methods

| Method | Description |
| --- | --- |
| getFontName() | Gets the requested font name. |
##### FontNotFoundException()
```
public FontNotFoundException()
```

Initializes a new instance of the `FontNotFoundException` class.

##### FontNotFoundException(String fontName)
```
public FontNotFoundException(String fontName)
```

Initializes a new instance of the `FontNotFoundException` class with a specified font name.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontName | java.lang.String | The requested font name. |

##### getFontName()
```
public final String getFontName()
```

Gets the requested font name.

**Returns:**
java.lang.String - The requested font name.

### ImageEffectsForTextWatermarkException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/imageeffectsfortextwatermarkexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public final class ImageEffectsForTextWatermarkException extends WatermarkException
```

The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageEffectsForTextWatermarkException() | Initializes a new instance of the `ImageEffectsForTextWatermarkException` class. |
##### ImageEffectsForTextWatermarkException()
```
public ImageEffectsForTextWatermarkException()
```

Initializes a new instance of the `ImageEffectsForTextWatermarkException` class.

### InvalidPasswordException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/invalidpasswordexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class InvalidPasswordException extends WatermarkException
```

The exception that is thrown when supplied 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.

### PreviewNotSupportedException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/previewnotsupportedexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class PreviewNotSupportedException extends WatermarkException
```

The exception that is thrown when a preview image cannot be generated for the content.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewNotSupportedException() | Initializes a new instance of the `PreviewNotSupportedException` class. |
##### PreviewNotSupportedException()
```
public PreviewNotSupportedException()
```

Initializes a new instance of the `PreviewNotSupportedException` class.

### TextEffectsForImageWatermarkException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/texteffectsforimagewatermarkexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public final class TextEffectsForImageWatermarkException extends WatermarkException
```

The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`.
#### Constructors

| Constructor | Description |
| --- | --- |
| TextEffectsForImageWatermarkException() | Initializes a new instance of the `TextEffectsForImageWatermarkException` class. |
##### TextEffectsForImageWatermarkException()
```
public TextEffectsForImageWatermarkException()
```

Initializes a new instance of the `TextEffectsForImageWatermarkException` class.

### UnexpectedDocumentStructureException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/unexpecteddocumentstructureexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class UnexpectedDocumentStructureException extends WatermarkException
```

The exception that is thrown when a content cannot be parsed due to unexpected structure.
#### Constructors

| Constructor | Description |
| --- | --- |
| UnexpectedDocumentStructureException() | Initializes a new instance of the `UnexpectedDocumentStructureException` class. |
##### UnexpectedDocumentStructureException()
```
public UnexpectedDocumentStructureException()
```

Initializes a new instance of the `UnexpectedDocumentStructureException` class.

### UnknownLoadOptionsTypeException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/unknownloadoptionstypeexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public final class UnknownLoadOptionsTypeException extends WatermarkException
```

The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`.
#### Constructors

| Constructor | Description |
| --- | --- |
| UnknownLoadOptionsTypeException() | Initializes a new instance of the `UnknownLoadOptionsTypeException` class. |
##### UnknownLoadOptionsTypeException()
```
public UnknownLoadOptionsTypeException()
```

Initializes a new instance of the `UnknownLoadOptionsTypeException` class.

### UnknownWatermarkOptionsTypeException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/unknownwatermarkoptionstypeexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public final class UnknownWatermarkOptionsTypeException extends WatermarkException
```

The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`.
#### Constructors

| Constructor | Description |
| --- | --- |
| UnknownWatermarkOptionsTypeException() | Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class. |
##### UnknownWatermarkOptionsTypeException()
```
public UnknownWatermarkOptionsTypeException()
```

Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class.

### UnsupportedFileTypeException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/unsupportedfiletypeexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.groupdocs.watermark.exceptions.WatermarkException
```
public class UnsupportedFileTypeException extends WatermarkException
```

The exception that is thrown when a file cannot be loaded.
#### Constructors

| Constructor | Description |
| --- | --- |
| UnsupportedFileTypeException() | Initializes a new instance of the `UnsupportedFileTypeException` class. |
##### UnsupportedFileTypeException()
```
public UnsupportedFileTypeException()
```

Initializes a new instance of the `UnsupportedFileTypeException` class.

### WatermarkException
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.exceptions/watermarkexception.md

**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException
```
public class WatermarkException extends RuntimeException
```

Represents base exception in **GroupDocs.Watermark** product.
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkException() | Initializes a new instance of the `WatermarkException` class. |
| WatermarkException(String message) | Initializes a new instance of the `WatermarkException` class with a specified error message. |
##### WatermarkException()
```
public WatermarkException()
```

Initializes a new instance of the `WatermarkException` class.

##### WatermarkException(String message)
```
public WatermarkException(String message)
```

Initializes a new instance of the `WatermarkException` class with a specified error message.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message that describes the error. |

### com.groupdocs.watermark.licenses
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.licenses.md

### com.groupdocs.watermark.logging
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.logging.md

### com.groupdocs.watermark.options
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options.md

#### Classes

| Class | Description |
| --- | --- |
| DiagramLoadOptions | Represents document loading options for a Visio document. |
| DiagramPageWatermarkOptions | Represents watermark adding options when adding shape watermark to a particular page of a Visio document. |
| DiagramPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Diagram document. |
| DiagramSaveOptions | Represents document saving options when saving a Visio document. |
| DiagramShapeWatermarkOptions | Represents watermark adding options when adding shape watermark to a Visio document. |
| DiagramWatermarkOptions | Base class for watermark adding options to a Visio document. |
| EmailLoadOptions | Represents the document loading options for an email message. |
| EmailPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Email document. |
| EmailSaveOptions | Represents the document saving options when saving an email message. |
| GifImageLoadOptions | Represents image loading options for a GIF image. |
| GifImageSaveOptions | Represents image saving options when saving a GIF image. |
| GifImageWatermarkOptions | Represents watermark adding options when adding watermark to a GIF image. |
| ImageLoadOptions | Represents image loading options when loading an image. |
| ImageSaveOptions | Represents image saving options when saving an image. |
| LoadOptions | Represents document loading options when loading a document. |
| MultiframeImageLoadOptions | Represents image loading options when loading a multiframe image. |
| MultiframeImageWatermarkOptions | Represents watermark adding options when adding watermark to a multi-frame image. |
| OoxmlLoadOptions | Represents document loading options for a OOXML document. |
| PdfAnnotationWatermarkOptions | Represents watermark adding options when adding annotation watermark to a pdf document. |
| PdfArtifactWatermarkOptions | Represents watermark adding options when adding artifact watermark to a pdf document. |
| PdfLoadOptions | Represents document loading options for a pdf document. |
| PdfPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of PDF document. |
| PdfSaveOptions | Represents document saving options when saving a pdf document. |
| PdfWatermarkOptions | Base class for watermark adding options to a pdf document. |
| PdfXObjectWatermarkOptions | Represents watermark adding options when adding XObject watermark to a pdf document. |
| PresentationImageEffects | Represents effects that can be applied to an image watermark for a PowerPoint document. |
| PresentationLoadOptions | Represents document loading options for a Presentation document. |
| PresentationSaveOptions | Represents document saving options when saving a Presentation document. |
| PresentationTextEffects | Represents effects that can be applied to a text watermark for a PowerPoint content. |
| PresentationWatermarkBaseSlideOptions | Base class for watermark adding options to a Presentation document. |
| PresentationWatermarkLayoutSlideOptions | Represents options when adding watermark to a Presentation document layout slide. |
| PresentationWatermarkMasterHandoutSlideOptions | Represents options when adding watermark to a Presentation document master handout slide. |
| PresentationWatermarkMasterNotesSlideOptions | Represents options when adding watermark to a Presentation document master notes slide. |
| PresentationWatermarkMasterSlideOptions | Represents options when adding watermark to a Presentation document master slide. |
| PresentationWatermarkNoteSlideOptions | Represents options when adding watermark to a Presentation document note slide. |
| PresentationWatermarkOptions | Base class for watermark adding options to a Presentation document. |
| PresentationWatermarkSlideOptions | Represents options when adding watermark to a Presentation document slide. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| SaveOptions | Represents document saving options when saving a document. |
| SpreadsheetBackgroundWatermarkOptions | Represents options when adding the watermark as a background to a Spreadsheet worksheet. |
| SpreadsheetImageEffects | Represents effects that can be applied to an image watermark for an Excel document. |
| SpreadsheetLoadOptions | Represents document loading options for a Spreadsheet document. |
| SpreadsheetPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document. |
| SpreadsheetSaveOptions | Represents document saving options when saving a Spreadsheet document. |
| SpreadsheetShapeSettings | Represents settings that can be applied to a shape watermark for an Excel document. |
| SpreadsheetTextEffects | Represents effects that can be applied to a text watermark for an Excel document. |
| SpreadsheetWatermarkBaseOptions | Base class for watermark adding options to a Spreadsheet document. |
| SpreadsheetWatermarkHeaderFooterOptions | Represents options when adding the watermark to a Spreadsheet header/footer. |
| SpreadsheetWatermarkModernWordArtOptions | Represents options when adding modern word art watermark to a Spreadsheet worksheet. |
| SpreadsheetWatermarkOptions | Base class for watermark adding options to a Spreadsheet document. |
| SpreadsheetWatermarkShapeOptions | Represents options when adding shape watermark to a Spreadsheet worksheet. |
| TiffImageLoadOptions | Represents image loading options for a TIFF image. |
| TiffImageSaveOptions | Represents image saving options when saving a TIFF image. |
| TiffImageWatermarkOptions | Represents watermark adding options when adding watermark to a TIFF image. |
| WatermarkOptions | Represents watermark adding options when adding watermark to a document. |
| WordProcessingFlipOrientation | Possible values for the orientation of a shape. |
| WordProcessingImageEffects | Represents effects that can be applied to an image watermark for a Word document. |
| WordProcessingLoadOptions | Represents document loading options for a Word document. |
| WordProcessingLockType | Specifies watermark lock type in Word document. |
| WordProcessingPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of WordProcessing document. |
| WordProcessingSaveOptions | Represents document saving options when saving a Word document. |
| WordProcessingShapeSettings | Represents settings that can be applied to a shape watermark for a Word document. |
| WordProcessingTextEffects | Represents effects that can be applied to a text watermark for a Word document. |
| WordProcessingWatermarkBaseOptions | Base class for watermark adding options to a Word document. |
| WordProcessingWatermarkHeaderFooterOptions | Represents options when adding the watermark to a Word section header/footer. |
| WordProcessingWatermarkOptions | Base class for watermark adding options to a Word document. |
| WordProcessingWatermarkPagesOptions | Represents options when adding watermark to Word document pages. |
| WordProcessingWatermarkSectionOptions | Represents options when adding shape watermark to a Word document section. |

#### Interfaces

| Interface | Description |
| --- | --- |
| ICreatePageStream | Provides method that returns a stream to write page preview data. |
| ILogger | Defines the interface of a logger that is used for logging events and errors during watermarking. |
| IPresentationWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |
| IReleasePageStream | Represents a method which releases the stream created by `ICreatePageStream` object. |
| ISpreadsheetWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |
| IWordProcessingWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |

### DiagramLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagramloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class DiagramLoadOptions extends LoadOptions
```

Represents document loading options for a Visio document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramLoadOptions() | Initializes a new instance of the `DiagramLoadOptions` class. |
| DiagramLoadOptions(String password) | Initializes a new instance of the `DiagramLoadOptions` class with a specified password. |
##### DiagramLoadOptions()
```
public DiagramLoadOptions()
```

Initializes a new instance of the `DiagramLoadOptions` class.

##### DiagramLoadOptions(String password)
```
public DiagramLoadOptions(String password)
```

Initializes a new instance of the `DiagramLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted Visio document. |

### DiagramPageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagrampagewatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.DiagramWatermarkOptions
```
public final class DiagramPageWatermarkOptions extends DiagramWatermarkOptions
```

Represents watermark adding options when adding shape watermark to a particular page of a Visio document.

**Learn more:**

 *  [Add watermarks to diagram documents][]

The following example demonstrates how to add a protected watermark to the first page of a Visio document.

> ```
> ```
>
>    DiagramLoadOptions loadOptions = new DiagramLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.vsdx", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("watermark test", new Font("Arial", 42));
>
>    DiagramPageWatermarkOptions options = new DiagramPageWatermarkOptions();
>    options.setLocked(true);
>    options.setPageIndex(0);
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.vsdx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to diagram documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+diagram+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramPageWatermarkOptions() | Initializes a new instance of the `DiagramPageWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageIndex() | Gets the page index to add watermark to. |
| setPageIndex(int value) | Sets the page index to add watermark to. |
##### DiagramPageWatermarkOptions()
```
public DiagramPageWatermarkOptions()
```

Initializes a new instance of the `DiagramPageWatermarkOptions` class.

##### getPageIndex()
```
public final int getPageIndex()
```

Gets the page index to add watermark to.

**Returns:**
int - The page index to add watermark to.
##### setPageIndex(int value)
```
public final void setPageIndex(int value)
```

Sets the page index to add watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page index to add watermark to. |

### DiagramPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagrampreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class DiagramPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of Diagram document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `DiagramPreviewOptions` class causing the output stream to be closed. |
| DiagramPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(float value) | Sets the resolution for the generated images, in dots per inch. |
| getHighQualityRendering() | Gets the flag for high quality rendering. |
| setHighQualityRendering(boolean value) | Sets the flag for high quality rendering. |
##### DiagramPreviewOptions(ICreatePageStream createPageStream)
```
public DiagramPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `DiagramPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### DiagramPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public DiagramPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final float DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final float getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
float - The resolution for the generated images, in dots per inch.

The default value is 300.
##### setResolution(float value)
```
public final void setResolution(float value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The resolution for the generated images, in dots per inch.

The default value is 300. |

##### getHighQualityRendering()
```
public final boolean getHighQualityRendering()
```

Gets the flag for high quality rendering.

**Returns:**
boolean - The flag for high quality rendering.

The high quality rendering uses more resources. The default value is  false .
##### setHighQualityRendering(boolean value)
```
public final void setHighQualityRendering(boolean value)
```

Sets the flag for high quality rendering.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag for high quality rendering.

The high quality rendering uses more resources. The default value is  false . |

### DiagramSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagramsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class DiagramSaveOptions extends SaveOptions
```

Represents document saving options when saving a Visio document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramSaveOptions() | Initializes a new instance of the `DiagramSaveOptions` class. |
##### DiagramSaveOptions()
```
public DiagramSaveOptions()
```

Initializes a new instance of the `DiagramSaveOptions` class.

### DiagramShapeWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagramshapewatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.DiagramWatermarkOptions
```
public final class DiagramShapeWatermarkOptions extends DiagramWatermarkOptions
```

Represents watermark adding options when adding shape watermark to a Visio document.

**Learn more:**

 *  [Add watermarks to diagram documents][]

The following example demonstrates how to add a protected watermark to all pages of the Visio document.

> ```
> ```
>
>    DiagramLoadOptions loadOptions = new DiagramLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.vsdx", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("watermark test", new Font("Arial", 42));
>
>    DiagramShapeWatermarkOptions options = new DiagramShapeWatermarkOptions();
>    options.setLocked(true);
>    options.setPlacementType(DiagramWatermarkPlacementType.AllPages);
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.vsdx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to diagram documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+diagram+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramShapeWatermarkOptions() | Initializes a new instance of the `DiagramShapeWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPlacementType() | Gets a value specifying to what pages a watermark should be added. |
| setPlacementType(int value) | Gets or sets a value specifying to what pages a watermark should be added. |
##### DiagramShapeWatermarkOptions()
```
public DiagramShapeWatermarkOptions()
```

Initializes a new instance of the `DiagramShapeWatermarkOptions` class.

##### getPlacementType()
```
public final int getPlacementType()
```

Gets a value specifying to what pages a watermark should be added.

**Returns:**
int - The `DiagramWatermarkPlacementType`, that specifies to what pages a watermark should be added.
##### setPlacementType(int value)
```
public final void setPlacementType(int value)
```

Gets or sets a value specifying to what pages a watermark should be added.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The `DiagramWatermarkPlacementType`, that specifies to what pages a watermark should be added. |

### DiagramWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/diagramwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public abstract class DiagramWatermarkOptions extends WatermarkOptions
```

Base class for watermark adding options to a Visio document.
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in Visio is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Visio is forbidden. |
##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in Visio is forbidden.

**Returns:**
boolean - If the value is true, shape editing will be forbidden.

By default, the value is false, the shape can be edited in Visio.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in Visio is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, shape editing will be forbidden.

By default, the value is false, the shape can be edited in Visio. |

### EmailLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/emailloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class EmailLoadOptions extends LoadOptions
```

Represents the document loading options for an email message.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailLoadOptions() | Initializes a new instance of the `EmailLoadOptions` class. |
##### EmailLoadOptions()
```
public EmailLoadOptions()
```

Initializes a new instance of the `EmailLoadOptions` class.

### EmailPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/emailpreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class EmailPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of Email document.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `EmailPreviewOptions` class causing the output stream to be closed. |
| EmailPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `EmailPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(float value) | Sets the resolution for the generated images, in dots per inch. |
##### EmailPreviewOptions(ICreatePageStream createPageStream)
```
public EmailPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `EmailPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### EmailPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public EmailPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `EmailPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final float DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final float getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
float - The resolution for the generated images, in dots per inch.

The default value is 96.
##### setResolution(float value)
```
public final void setResolution(float value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The resolution for the generated images, in dots per inch.

The default value is 96. |

### EmailSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/emailsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class EmailSaveOptions extends SaveOptions
```

Represents the document saving options when saving an email message.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailSaveOptions() | Initializes a new instance of the `EmailSaveOptions` class. |
##### EmailSaveOptions()
```
public EmailSaveOptions()
```

Initializes a new instance of the `EmailSaveOptions` class.

### GifImageLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/gifimageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions, com.groupdocs.watermark.options.ImageLoadOptions, com.groupdocs.watermark.options.MultiframeImageLoadOptions
```
public final class GifImageLoadOptions extends MultiframeImageLoadOptions
```

Represents image loading options for a GIF image.
#### Constructors

| Constructor | Description |
| --- | --- |
| GifImageLoadOptions() | Initializes a new instance of the `GifImageLoadOptions` class. |
##### GifImageLoadOptions()
```
public GifImageLoadOptions()
```

Initializes a new instance of the `GifImageLoadOptions` class.

### GifImageSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/gifimagesaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions, com.groupdocs.watermark.options.ImageSaveOptions
```
public final class GifImageSaveOptions extends ImageSaveOptions
```

Represents image saving options when saving a GIF image.
#### Constructors

| Constructor | Description |
| --- | --- |
| GifImageSaveOptions() | Initializes a new instance of the `GifImageSaveOptions` class. |
##### GifImageSaveOptions()
```
public GifImageSaveOptions()
```

Initializes a new instance of the `GifImageSaveOptions` class.

### GifImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/gifimagewatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.MultiframeImageWatermarkOptions
```
public final class GifImageWatermarkOptions extends MultiframeImageWatermarkOptions
```

Represents watermark adding options when adding watermark to a GIF image.

**Learn more:**

 *  [Add watermarks to images][]

The following example demonstrates how to add a watermark to a particular frame of GIF image.

> ```
> ```
>
>    GifImageLoadOptions loadOptions = new GifImageLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\test.gif", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));
>
>    GifImageWatermarkOptions options = new GifImageWatermarkOptions();
>    options.setFrameIndex(0);
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.gif");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to images]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+images
#### Constructors

| Constructor | Description |
| --- | --- |
| GifImageWatermarkOptions() | Initializes a new instance of the `GifImageWatermarkOptions` class. |
| GifImageWatermarkOptions(int frameIndex) | Initializes a new instance of the `GifImageWatermarkOptions` class with a specified index of a frame. |
##### GifImageWatermarkOptions()
```
public GifImageWatermarkOptions()
```

Initializes a new instance of the `GifImageWatermarkOptions` class.

##### GifImageWatermarkOptions(int frameIndex)
```
public GifImageWatermarkOptions(int frameIndex)
```

Initializes a new instance of the `GifImageWatermarkOptions` class with a specified index of a frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | int | The index of frame to add watermark. |

### ICreatePageStream
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/icreatepagestream.md

### ILogger
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/ilogger.md

### ImageLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/imageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public class ImageLoadOptions extends LoadOptions
```

Represents image loading options when loading an image.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageLoadOptions() | Initializes a new instance of the `ImageLoadOptions` class. |
##### ImageLoadOptions()
```
public ImageLoadOptions()
```

Initializes a new instance of the `ImageLoadOptions` class.

### ImageSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/imagesaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public class ImageSaveOptions extends SaveOptions
```

Represents image saving options when saving an image.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageSaveOptions() | Initializes a new instance of the `ImageSaveOptions` class. |
##### ImageSaveOptions()
```
public ImageSaveOptions()
```

Initializes a new instance of the `ImageSaveOptions` class.

### IPresentationWatermarkEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/ipresentationwatermarkeffects.md

### IReleasePageStream
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/ireleasepagestream.md

### ISpreadsheetWatermarkEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/ispreadsheetwatermarkeffects.md

### IWordProcessingWatermarkEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/iwordprocessingwatermarkeffects.md

### LoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/loadoptions.md

**Inheritance:**
java.lang.Object
```
public class LoadOptions
```

Represents document loading options when loading a document.

**Learn more:**

 *  [Loading documents][]
 *  [Load from local disk][]
 *  [Load from stream][]
 *  [Load document of specific format][]
 *  [Load password-protected document][]

[Loading documents]: https://docs.groupdocs.com/display/watermarkjava/Loading+documents
[Load from local disk]: https://docs.groupdocs.com/display/watermarkjava/Load+from+local+disk
[Load from stream]: https://docs.groupdocs.com/display/watermarkjava/Load+from+stream
[Load document of specific format]: https://docs.groupdocs.com/display/watermarkjava/Load+document+of+specific+format
[Load password-protected document]: https://docs.groupdocs.com/display/watermarkjava/Load+password-protected+document
#### Constructors

| Constructor | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the `LoadOptions` class. |
| LoadOptions(String password) | Initializes a new instance of the `LoadOptions` class with a specified password. |
#### Methods

| Method | Description |
| --- | --- |
| getPassword() | Gets the password for opening an encrypted document. |
| setPassword(String value) | Sets the password for opening an encrypted document. |
| getFormatFamily() | Get the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| setFormatFamily(int formatFamily) | Set the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| getFileType() | Get the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| setFileType(FileType fileType) | Set the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
##### LoadOptions()
```
public LoadOptions()
```

Initializes a new instance of the `LoadOptions` class.

##### LoadOptions(String password)
```
public LoadOptions(String password)
```

Initializes a new instance of the `LoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted content. |

##### getPassword()
```
public final String getPassword()
```

Gets the password for opening an encrypted document.

**Returns:**
java.lang.String - The password for opening an encrypted document.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets the password for opening an encrypted document.

The password be null or empty string. The default value is null. If the content is not encrypted, set this to null or empty string.

The following example demonstrates how to load a document protected with a password.

> ```
> ```
>
>    LoadOptions loadOptions = new LoadOptions();
>    loadOptions.setPassword("pwd123");
>
>    Watermarker watermarker = new Watermarker("D:\\doc.vsdx", loadOptions);
>    // ...
>    watermarker.close();
>
> ```
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The password for opening an encrypted document. |

##### getFormatFamily()
```
public int getFormatFamily()
```

Get the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

**Returns:**
int - formatFamily The file type.
##### setFormatFamily(int formatFamily)
```
public void setFormatFamily(int formatFamily)
```

Set the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| formatFamily | int | The file type. |

##### getFileType()
```
public FileType getFileType()
```

Get the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

**Returns:**
FileType - fileType The file type.
##### setFileType(FileType fileType)
```
public void setFileType(FileType fileType)
```

Set the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileType | FileType | The file type. |

### MultiframeImageLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/multiframeimageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions, com.groupdocs.watermark.options.ImageLoadOptions
```
public class MultiframeImageLoadOptions extends ImageLoadOptions
```

Represents image loading options when loading a multiframe image.
#### Constructors

| Constructor | Description |
| --- | --- |
| MultiframeImageLoadOptions() | Initializes a new instance of the `MultiframeImageLoadOptions` class. |
##### MultiframeImageLoadOptions()
```
public MultiframeImageLoadOptions()
```

Initializes a new instance of the `MultiframeImageLoadOptions` class.

### MultiframeImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/multiframeimagewatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public class MultiframeImageWatermarkOptions extends WatermarkOptions
```

Represents watermark adding options when adding watermark to a multi-frame image.

**Learn more:**

 *  [Add watermarks to images][]

The following example demonstrates how to add a watermark to a particular frame of multi-frame image.

> ```
> ```
>
>    ImageLoadOptions loadOptions = new ImageLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\test.gif", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));
>
>    MultiframeImageWatermarkOptions options = new MultiframeImageWatermarkOptions();
>    options.setFrameIndex(0);
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.gif");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to images]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+images
#### Constructors

| Constructor | Description |
| --- | --- |
| MultiframeImageWatermarkOptions() | Initializes a new instance of the `MultiframeImageWatermarkOptions` class. |
| MultiframeImageWatermarkOptions(int frameIndex) | Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified index of the frame. |
#### Methods

| Method | Description |
| --- | --- |
| getFrameIndex() | Gets the index of frame to add watermark. |
| setFrameIndex(int value) | Sets the index of frame to add watermark. |
##### MultiframeImageWatermarkOptions()
```
public MultiframeImageWatermarkOptions()
```

Initializes a new instance of the `MultiframeImageWatermarkOptions` class.

##### MultiframeImageWatermarkOptions(int frameIndex)
```
public MultiframeImageWatermarkOptions(int frameIndex)
```

Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified index of the frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | int | The index of frame to add watermark. |

##### getFrameIndex()
```
public final int getFrameIndex()
```

Gets the index of frame to add watermark.

**Returns:**
int - The index of frame to add watermark.

\-1 means all frames.
##### setFrameIndex(int value)
```
public final void setFrameIndex(int value)
```

Sets the index of frame to add watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of frame to add watermark.

\-1 means all frames. |

### OoxmlLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/ooxmlloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public class OoxmlLoadOptions extends LoadOptions
```

Represents document loading options for a OOXML document.
#### Constructors

| Constructor | Description |
| --- | --- |
| OoxmlLoadOptions() | Initializes a new instance of the `OoxmlLoadOptions` class. |
| OoxmlLoadOptions(String password) | Initializes a new instance of the `OoxmlLoadOptions` class with a specified password. |
##### OoxmlLoadOptions()
```
public OoxmlLoadOptions()
```

Initializes a new instance of the `OoxmlLoadOptions` class.

##### OoxmlLoadOptions(String password)
```
public OoxmlLoadOptions(String password)
```

Initializes a new instance of the `OoxmlLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted content. |

### PdfAnnotationWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfannotationwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PdfWatermarkOptions
```
public final class PdfAnnotationWatermarkOptions extends PdfWatermarkOptions
```

Represents watermark adding options when adding annotation watermark to a pdf document.

**Learn more:**

 *  [Add watermarks to PDF documents][]

The following example demonstrates how to add an image annotation watermark to a PDF document.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.pdf", loadOptions);
>
>    ImageWatermark watermark = new ImageWatermark("D:\\icon.png");
>
>    PdfAnnotationWatermarkOptions options = new PdfAnnotationWatermarkOptions();
>    options.setPageIndex(-1); // default - all pages
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.pdf");
>    watermark.close();
>    watermarker.close();
>
> ```
> ```

[Add watermarks to PDF documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+PDF+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfAnnotationWatermarkOptions() | Initializes a new instance of the `PdfAnnotationWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageIndex() | Gets the page index to add watermark to. |
| setPageIndex(int value) | Sets the page index to add watermark to. |
| getPrintOnly() | Get the value indicating whether annotation will be printed, but not displayed in pdf viewing application. |
| setPrintOnly(boolean value) | Sets the value indicating whether annotation will be printed, but not displayed in pdf viewing application. |
##### PdfAnnotationWatermarkOptions()
```
public PdfAnnotationWatermarkOptions()
```

Initializes a new instance of the `PdfAnnotationWatermarkOptions` class.

##### getPageIndex()
```
public final int getPageIndex()
```

Gets the page index to add watermark to.

**Returns:**
int - The page index to add watermark to.

\-1 means all pages.
##### setPageIndex(int value)
```
public final void setPageIndex(int value)
```

Sets the page index to add watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page index to add watermark to.

\-1 means all pages. |

##### getPrintOnly()
```
public final boolean getPrintOnly()
```

Get the value indicating whether annotation will be printed, but not displayed in pdf viewing application.

**Returns:**
boolean - The value indicating whether annotation will be printed, but not displayed in pdf viewing application.
##### setPrintOnly(boolean value)
```
public final void setPrintOnly(boolean value)
```

Sets the value indicating whether annotation will be printed, but not displayed in pdf viewing application.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value indicating whether annotation will be printed, but not displayed in pdf viewing application. |

### PdfArtifactWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfartifactwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PdfWatermarkOptions
```
public final class PdfArtifactWatermarkOptions extends PdfWatermarkOptions
```

Represents watermark adding options when adding artifact watermark to a pdf document.

**Leran more:**

 *  [Add watermarks to PDF documents][]

The following example demonstrates how to add an image artifact watermark to a PDF document.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.pdf", loadOptions);
>
>    ImageWatermark watermark = new ImageWatermark("D:\\icon.png");
>
>    PdfArtifactWatermarkOptions options = new PdfArtifactWatermarkOptions();
>    options.setPageIndex(-1); // default - all pages
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.pdf");
>    watermark.close();
>    watermarker.close();
>
> ```
> ```

[Add watermarks to PDF documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+PDF+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfArtifactWatermarkOptions() | Initializes a new instance of the `PdfArtifactWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageIndex() | Gets the page index to add watermark to. |
| setPageIndex(int value) | Sets the page index to add watermark to. |
##### PdfArtifactWatermarkOptions()
```
public PdfArtifactWatermarkOptions()
```

Initializes a new instance of the `PdfArtifactWatermarkOptions` class.

##### getPageIndex()
```
public final int getPageIndex()
```

Gets the page index to add watermark to.

**Returns:**
int - The page index to add watermark to.
##### setPageIndex(int value)
```
public final void setPageIndex(int value)
```

Sets the page index to add watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page index to add watermark to. |

### PdfLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class PdfLoadOptions extends LoadOptions
```

Represents document loading options for a pdf document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfLoadOptions() | Initializes a new instance of the `PdfLoadOptions` class. |
| PdfLoadOptions(String password) | Initializes a new instance of the `PdfLoadOptions` class with a specified password. |
##### PdfLoadOptions()
```
public PdfLoadOptions()
```

Initializes a new instance of the `PdfLoadOptions` class.

##### PdfLoadOptions(String password)
```
public PdfLoadOptions(String password)
```

Initializes a new instance of the `PdfLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted document. |

### PdfPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfpreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class PdfPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of PDF document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `PdfPreviewOptions` class causing the output stream to be closed. |
| PdfPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(int value) | Sets the resolution for the generated images, in dots per inch. |
##### PdfPreviewOptions(ICreatePageStream createPageStream)
```
public PdfPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `PdfPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### PdfPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PdfPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final int DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final int getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
int - The resolution for the generated images, in dots per inch.

The default value is 150.
##### setResolution(int value)
```
public final void setResolution(int value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The resolution for the generated images, in dots per inch.

The default value is 150. |

### PdfSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class PdfSaveOptions extends SaveOptions
```

Represents document saving options when saving a pdf document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of the `PdfSaveOptions` class. |
##### PdfSaveOptions()
```
public PdfSaveOptions()
```

Initializes a new instance of the `PdfSaveOptions` class.

### PdfWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public abstract class PdfWatermarkOptions extends WatermarkOptions
```

Base class for watermark adding options to a pdf document.

### PdfXObjectWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/pdfxobjectwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PdfWatermarkOptions
```
public final class PdfXObjectWatermarkOptions extends PdfWatermarkOptions
```

Represents watermark adding options when adding XObject watermark to a pdf document.

**Learn more:**

 *  [Add watermarks to PDF documents][]

The following example demonstrates how to add a watermark to a particular page of a pdf document.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\doc.pdf", loadOptions);
>
>    ImageWatermark watermark = new ImageWatermark("C:\\watermark.png");
>
>    PdfXObjectWatermarkOptions options = new PdfXObjectWatermarkOptions();
>    options.setPageIndex(0);
>
>    watermarker.add(watermark, options);
>    watermarker.save("C:\\watermarked_doc.pdf");
>    watermark.close();
>    watermarker.close();
>
> ```
> ```

[Add watermarks to PDF documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+PDF+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfXObjectWatermarkOptions() | Initializes a new instance of the `PdfXObjectWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageIndex() | Gets the page index to add watermark to. |
| setPageIndex(int value) | Sets the page index to add watermark to. |
##### PdfXObjectWatermarkOptions()
```
public PdfXObjectWatermarkOptions()
```

Initializes a new instance of the `PdfXObjectWatermarkOptions` class.

##### getPageIndex()
```
public final int getPageIndex()
```

Gets the page index to add watermark to.

**Returns:**
int - The page index to add watermark to.
##### setPageIndex(int value)
```
public final void setPageIndex(int value)
```

Sets the page index to add watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page index to add watermark to. |

### PresentationImageEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationimageeffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.IPresentationWatermarkEffects
```
public final class PresentationImageEffects extends OfficeImageEffects implements IPresentationWatermarkEffects
```

Represents effects that can be applied to an image watermark for a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationImageEffects() | Initializes a new instance of the `PresentationImageEffects` class. |
##### PresentationImageEffects()
```
public PresentationImageEffects()
```

Initializes a new instance of the `PresentationImageEffects` class.

### PresentationLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class PresentationLoadOptions extends LoadOptions
```

Represents document loading options for a Presentation document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationLoadOptions() | Initializes a new instance of the `PresentationLoadOptions` class. |
| PresentationLoadOptions(String password) | Initializes a new instance of the `PresentationLoadOptions` class with a specified password. |
##### PresentationLoadOptions()
```
public PresentationLoadOptions()
```

Initializes a new instance of the `PresentationLoadOptions` class.

##### PresentationLoadOptions(String password)
```
public PresentationLoadOptions(String password)
```

Initializes a new instance of the `PresentationLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted content. |

### PresentationSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class PresentationSaveOptions extends SaveOptions
```

Represents document saving options when saving a Presentation document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationSaveOptions() | Initializes a new instance of the `PresentationSaveOptions` class. |
##### PresentationSaveOptions()
```
public PresentationSaveOptions()
```

Initializes a new instance of the `PresentationSaveOptions` class.

### PresentationTextEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationtexteffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeTextEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.IPresentationWatermarkEffects
```
public final class PresentationTextEffects extends OfficeTextEffects implements IPresentationWatermarkEffects
```

Represents effects that can be applied to a text watermark for a PowerPoint content.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationTextEffects() | Initializes a new instance of the `PresentationTextEffects` class. |
##### PresentationTextEffects()
```
public PresentationTextEffects()
```

Initializes a new instance of the `PresentationTextEffects` class.

### PresentationWatermarkBaseSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkbaseslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions
```
public abstract class PresentationWatermarkBaseSlideOptions extends PresentationWatermarkOptions
```

Base class for watermark adding options to a Presentation document.

**Learn more:**

 *  [Add watermarks to presentation documents][]

The following example demonstrates how to add a watermark to different service slides of a Power Point presentation.

> ```
> ```
>
>    PresentationLoadOptions loadOptions = new PresentationLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.pptx", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 8));
>
>    // Add watermark to all master slides
>    PresentationWatermarkMasterSlideOptions masterSlideOptions = new PresentationWatermarkMasterSlideOptions();
>    masterSlideOptions.setMasterSlideIndex(-1); // default
>    watermarker.add(watermark, masterSlideOptions);
>
>    // Add watermark to all layout slides
>    PresentationWatermarkLayoutSlideOptions layoutSlideOptions = new PresentationWatermarkLayoutSlideOptions();
>    layoutSlideOptions.setLayoutSlideIndex(-1); // default
>    watermarker.add(watermark, layoutSlideOptions);
>
>    // Add watermark to all notes slides
>    PresentationWatermarkNoteSlideOptions noteSlideOptions = new PresentationWatermarkNoteSlideOptions();
>    noteSlideOptions.setSlideIndex(-1); // default
>    watermarker.add(watermark, noteSlideOptions);
>
>    // Add watermark to handout master
>    PresentationWatermarkMasterHandoutSlideOptions masterHandoutSlideOptions = new PresentationWatermarkMasterHandoutSlideOptions();
>    watermarker.add(watermark, masterHandoutSlideOptions);
>
>    // Add watermark to notes master
>    PresentationWatermarkMasterNotesSlideOptions masterNotesSlideOptions = new PresentationWatermarkMasterNotesSlideOptions();
>    watermarker.add(watermark, masterNotesSlideOptions);
>
>    watermarker.save("D:\\watermarked_test.pptx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| getProtectWithUnreadableCharacters() | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |
| setProtectWithUnreadableCharacters(boolean value) | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |
| getName() | Gets the name a shape. |
| setName(String value) | Sets the name a shape. |
| getAlternativeText() | Gets the descriptive (alternative) text that will be associated with a shape. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text that will be associated with a shape. |
| getEffects() | Gets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| setEffects(IPresentationWatermarkEffects value) | Sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in PowerPoint is forbidden.

**Returns:**
boolean - If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in PowerPoint.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in PowerPoint. |

##### getProtectWithUnreadableCharacters()
```
public final boolean getProtectWithUnreadableCharacters()
```

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

This protection applies only when `#isLocked().isLocked()` returns `true`.

**Returns:**
boolean - A value indicating whether the text watermark characters are mixed with unreadable characters.
##### setProtectWithUnreadableCharacters(boolean value)
```
public final void setProtectWithUnreadableCharacters(boolean value)
```

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

This protection applies only when `#isLocked().isLocked()` returns `true`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating whether the text watermark characters are mixed with unreadable characters. |

##### getName()
```
public final String getName()
```

Gets the name a shape.

**Returns:**
java.lang.String - The shape name.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The shape name. |

##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text that will be associated with a shape.

**Returns:**
java.lang.String - The descriptive (alternative) text that will be associated with a shape.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text that will be associated with a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text that will be associated with a shape. |

##### getEffects()
```
public final IPresentationWatermarkEffects getEffects()
```

Gets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark.

**Returns:**
IPresentationWatermarkEffects - The value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark.
##### setEffects(IPresentationWatermarkEffects value)
```
public final void setEffects(IPresentationWatermarkEffects value)
```

Sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IPresentationWatermarkEffects | The value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |

### PresentationWatermarkLayoutSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarklayoutslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkLayoutSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document layout slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkLayoutSlideOptions() | Initializes a new instance of the `PresentationWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getLayoutSlideIndex() | Gets the index of layout slide to add the watermark to. |
| setLayoutSlideIndex(int value) | Sets the index of layout slide to add the watermark to. |
##### PresentationWatermarkLayoutSlideOptions()
```
public PresentationWatermarkLayoutSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkOptions` class.

##### getLayoutSlideIndex()
```
public final int getLayoutSlideIndex()
```

Gets the index of layout slide to add the watermark to.

**Returns:**
int - The index of layout slide to add the watermark to.

\-1 means all slides.
##### setLayoutSlideIndex(int value)
```
public final void setLayoutSlideIndex(int value)
```

Sets the index of layout slide to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of layout slide to add the watermark to.

\-1 means all slides. |

### PresentationWatermarkMasterHandoutSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkmasterhandoutslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkMasterHandoutSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document master handout slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkMasterHandoutSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class. |
##### PresentationWatermarkMasterHandoutSlideOptions()
```
public PresentationWatermarkMasterHandoutSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class.

### PresentationWatermarkMasterNotesSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkmasternotesslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkMasterNotesSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document master notes slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkMasterNotesSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class. |
##### PresentationWatermarkMasterNotesSlideOptions()
```
public PresentationWatermarkMasterNotesSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class.

### PresentationWatermarkMasterSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkmasterslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkMasterSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document master slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkMasterSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterSlideOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getMasterSlideIndex() | Gets the index of master slide to add the watermark to. |
| setMasterSlideIndex(int value) | Sets the index of master slide to add the watermark to. |
##### PresentationWatermarkMasterSlideOptions()
```
public PresentationWatermarkMasterSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkMasterSlideOptions` class.

##### getMasterSlideIndex()
```
public final int getMasterSlideIndex()
```

Gets the index of master slide to add the watermark to.

**Returns:**
int - The index of master slide to add the watermark to.

\-1 means all slides.
##### setMasterSlideIndex(int value)
```
public final void setMasterSlideIndex(int value)
```

Sets the index of master slide to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of master slide to add the watermark to.

\-1 means all slides. |

### PresentationWatermarkNoteSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarknoteslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkNoteSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document note slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkNoteSlideOptions() | Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getSlideIndex() | Gets the index of a slide to add the watermark to note slide of it. |
| setSlideIndex(int value) | Sets the index of a slide to add the watermark to note slide of it. |
##### PresentationWatermarkNoteSlideOptions()
```
public PresentationWatermarkNoteSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class.

##### getSlideIndex()
```
public final int getSlideIndex()
```

Gets the index of a slide to add the watermark to note slide of it.

**Returns:**
int - The index of slide to add the watermark to note slide of it.

\-1 means all slides.
##### setSlideIndex(int value)
```
public final void setSlideIndex(int value)
```

Sets the index of a slide to add the watermark to note slide of it.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of slide to add the watermark to note slide of it.

\-1 means all slides. |

### PresentationWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public abstract class PresentationWatermarkOptions extends WatermarkOptions
```

Base class for watermark adding options to a Presentation document.

### PresentationWatermarkSlideOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/presentationwatermarkslideoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkOptions, com.groupdocs.watermark.options.PresentationWatermarkBaseSlideOptions
```
public final class PresentationWatermarkSlideOptions extends PresentationWatermarkBaseSlideOptions
```

Represents options when adding watermark to a Presentation document slide.

**Learn more:**

 *  [Add watermarks to presentation documents][]

The following example demonstrates how to add a watermark to a particular slide of a Power Point presentation.

> ```
> ```
>
>    PresentationLoadOptions loadOptions = new PresentationLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\Documents\\test.ppt", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36, FontStyle.Bold | FontStyle.Italic));
>    watermark.setHorizontalAlignment(HorizontalAlignment.Center);
>    watermark.setVerticalAlignment(VerticalAlignment.Center);
>
>    PresentationWatermarkSlideOptions options = new PresentationWatermarkSlideOptions();
>    options.setSlideIndex(0);
>    options.setLocked(false); // default
>    options.setProtectWithUnreadableCharacters(false); // default
>    options.setName(null); // default
>    options.setAlternativeText(null); // default
>
>    watermarker.save("C:\\Documents\\watermarked_test.ppt");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to presentation documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+presentation+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationWatermarkSlideOptions() | Initializes a new instance of the `PresentationWatermarkSlideOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getSlideIndex() | Gets the index of slide to add the watermark to. |
| setSlideIndex(int value) | Sets the index of slide to add the watermark to. |
##### PresentationWatermarkSlideOptions()
```
public PresentationWatermarkSlideOptions()
```

Initializes a new instance of the `PresentationWatermarkSlideOptions` class.

##### getSlideIndex()
```
public final int getSlideIndex()
```

Gets the index of slide to add the watermark to.

**Returns:**
int - The index of slide to add the watermark to.

\-1 means all slides.
##### setSlideIndex(int value)
```
public final void setSlideIndex(int value)
```

Sets the index of slide to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of slide to add the watermark to.

\-1 means all slides. |

### PreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/previewoptions.md

**Inheritance:**
java.lang.Object
```
public class PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation.
#### Constructors

| Constructor | Description |
| --- | --- |
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the page preview width. |
| setWidth(int value) | Sets the page preview width. |
| getHeight() | Gets the page preview height. |
| setHeight(int value) | Sets the page preview height. |
| getPageNumbers() | Gets an array of page numbers to generate previews. |
| setPageNumbers(int[] value) | Sets an array of page numbers to generate previews. |
| getPreviewFormat() | Gets the preview image format. |
| setPreviewFormat(int value) | Sets the preview image format. |
| getCreatePageStream() | Gets an instance of the page stream creation class. |
| setCreatePageStream(ICreatePageStream value) | Sets an instance of the page stream creation class. |
| getReleasePageStream() | Gets an instance of the page preview completion class. |
| setReleasePageStream(IReleasePageStream value) | Sets an instance of the page preview completion class. |
##### PreviewOptions(ICreatePageStream createPageStream)
```
public PreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### getWidth()
```
public final int getWidth()
```

Gets the page preview width.

**Returns:**
int - The page preview width.
##### setWidth(int value)
```
public final void setWidth(int value)
```

Sets the page preview width.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview width. |

##### getHeight()
```
public final int getHeight()
```

Gets the page preview height.

**Returns:**
int - The page preview height.
##### setHeight(int value)
```
public final void setHeight(int value)
```

Sets the page preview height.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The page preview height. |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets an array of page numbers to generate previews.

**Returns:**
int[] - The array of page numbers to generate previews.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets an array of page numbers to generate previews.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The array of page numbers to generate previews. |

##### getPreviewFormat()
```
public final int getPreviewFormat()
```

Gets the preview image format.

**Returns:**
int - The preview image format.
##### setPreviewFormat(int value)
```
public final void setPreviewFormat(int value)
```

Sets the preview image format.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The preview image format. |

##### getCreatePageStream()
```
public final ICreatePageStream getCreatePageStream()
```

Gets an instance of the page stream creation class.

**Returns:**
ICreatePageStream - The instance of the page stream creation class.
##### setCreatePageStream(ICreatePageStream value)
```
public final void setCreatePageStream(ICreatePageStream value)
```

Sets an instance of the page stream creation class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ICreatePageStream | The instance of the page stream creation class. |

##### getReleasePageStream()
```
public final IReleasePageStream getReleasePageStream()
```

Gets an instance of the page preview completion class.

**Returns:**
IReleasePageStream - The instance of the page preview completion delegate.
##### setReleasePageStream(IReleasePageStream value)
```
public final void setReleasePageStream(IReleasePageStream value)
```

Sets an instance of the page preview completion class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IReleasePageStream | The instance of the page preview completion delegate. |

### SaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/saveoptions.md

**Inheritance:**
java.lang.Object
```
public class SaveOptions
```

Represents document saving options when saving a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of the `SaveOptions` class. |
##### SaveOptions()
```
public SaveOptions()
```

Initializes a new instance of the `SaveOptions` class.

### SpreadsheetBackgroundWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetbackgroundwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions
```
public final class SpreadsheetBackgroundWatermarkOptions extends SpreadsheetWatermarkOptions
```

Represents options when adding the watermark as a background to a Spreadsheet worksheet.

**Learn more:**

 *  [Add watermarks to spreadsheet documents][]

The following example demonstrates how to add a text watermark to an Excel document worksheet as background.

> ```
> ```
>
>    SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\Documents\\test.xlsx", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36));
>
>    SpreadsheetBackgroundWatermarkOptions options = new SpreadsheetBackgroundWatermarkOptions();
>    options.setWorksheetIndex(-1); // default
>    options.setBackgroundWidth(800);
>    options.setBackgroundHeight(600);
>
>    watermarker.save("C:\\Documents\\watermarked_test.xlsx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to spreadsheet documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+spreadsheet+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetBackgroundWatermarkOptions() | Initializes a new instance of the `SpreadsheetBackgroundWatermarkOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() | Get the index of worksheet to add the watermark to. |
| setWorksheetIndex(int value) | Sets the index of worksheet to add the watermark to. |
| getBackgroundWidth() | Get the desired width of the background image in pixels. |
| setBackgroundWidth(int value) | Sets the desired width of the background image in pixels. |
| getBackgroundHeight() | Gets or sets the desired height of the background image in pixels. |
| setBackgroundHeight(int value) | Gets or sets the desired height of the background image in pixels. |
##### SpreadsheetBackgroundWatermarkOptions()
```
public SpreadsheetBackgroundWatermarkOptions()
```

Initializes a new instance of the `SpreadsheetBackgroundWatermarkOptions` class.

##### getWorksheetIndex()
```
public final int getWorksheetIndex()
```

Get the index of worksheet to add the watermark to.

\-1 means every worksheet.

**Returns:**
int - The index of worksheet to add the watermark to.
##### setWorksheetIndex(int value)
```
public final void setWorksheetIndex(int value)
```

Sets the index of worksheet to add the watermark to.

\-1 means every worksheet.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of worksheet to add the watermark to. |

##### getBackgroundWidth()
```
public final int getBackgroundWidth()
```

Get the desired width of the background image in pixels.

**Returns:**
int - The desired width of the background image in pixels.
##### setBackgroundWidth(int value)
```
public final void setBackgroundWidth(int value)
```

Sets the desired width of the background image in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The desired width of the background image in pixels. |

##### getBackgroundHeight()
```
public final int getBackgroundHeight()
```

Gets or sets the desired height of the background image in pixels.

**Returns:**
int - The desired height of the background image in pixels.
##### setBackgroundHeight(int value)
```
public final void setBackgroundHeight(int value)
```

Gets or sets the desired height of the background image in pixels.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The desired height of the background image in pixels. |

### SpreadsheetImageEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetimageeffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.ISpreadsheetWatermarkEffects
```
public final class SpreadsheetImageEffects extends OfficeImageEffects implements ISpreadsheetWatermarkEffects
```

Represents effects that can be applied to an image watermark for an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetImageEffects() | Initializes a new instance of the `SpreadsheetImageEffects` class. |
##### SpreadsheetImageEffects()
```
public SpreadsheetImageEffects()
```

Initializes a new instance of the `SpreadsheetImageEffects` class.

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class SpreadsheetLoadOptions extends LoadOptions
```

Represents document loading options for a Spreadsheet document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Initializes a new instance of the `SpreadsheetLoadOptions` class. |
| SpreadsheetLoadOptions(String password) | Initializes a new instance of the `SpreadsheetLoadOptions` class with a specified password. |
##### SpreadsheetLoadOptions()
```
public SpreadsheetLoadOptions()
```

Initializes a new instance of the `SpreadsheetLoadOptions` class.

##### SpreadsheetLoadOptions(String password)
```
public SpreadsheetLoadOptions(String password)
```

Initializes a new instance of the `SpreadsheetLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted content. |

### SpreadsheetPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetpreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class SpreadsheetPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `SpreadsheetPreviewOptions` class causing the output stream to be closed. |
| SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `SpreadsheetPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(int value) | Sets the resolution for the generated images, in dots per inch. |
| getOnlyDataArea() | Gets the flag for rendering the data area only without headers, footers, margins. |
| setOnlyDataArea(boolean value) | Sets the flag for rendering the data area only without headers, footers, margins. |
##### SpreadsheetPreviewOptions(ICreatePageStream createPageStream)
```
public SpreadsheetPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `SpreadsheetPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `SpreadsheetPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final int DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final int getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
int - The resolution for the generated images, in dots per inch.

The default value is 96.
##### setResolution(int value)
```
public final void setResolution(int value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The resolution for the generated images, in dots per inch.

The default value is 96. |

##### getOnlyDataArea()
```
public final boolean getOnlyDataArea()
```

Gets the flag for rendering the data area only without headers, footers, margins.

**Returns:**
boolean - The flag for rendering the data area only without headers, footers, margins.

This flags leads to rendering the whole worksheet on one page. The default value is  false .
##### setOnlyDataArea(boolean value)
```
public final void setOnlyDataArea(boolean value)
```

Sets the flag for rendering the data area only without headers, footers, margins.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The flag for rendering the data area only without headers, footers, margins.

This flags leads to rendering the whole worksheet on one page. The default value is  false . |

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class SpreadsheetSaveOptions extends SaveOptions
```

Represents document saving options when saving a Spreadsheet document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetSaveOptions() | Initializes a new instance of the `SpreadsheetSaveOptions` class. |
##### SpreadsheetSaveOptions()
```
public SpreadsheetSaveOptions()
```

Initializes a new instance of the `SpreadsheetSaveOptions` class.

### SpreadsheetShapeSettings
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetshapesettings.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeShapeSettings
```
public final class SpreadsheetShapeSettings extends OfficeShapeSettings
```

Represents settings that can be applied to a shape watermark for an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetShapeSettings() | Initializes a new instance of the `SpreadsheetShapeSettings` class. |
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in Excel is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Excel is forbidden. |
##### SpreadsheetShapeSettings()
```
public SpreadsheetShapeSettings()
```

Initializes a new instance of the `SpreadsheetShapeSettings` class.

##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in Excel is forbidden.

**Returns:**
boolean - If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in Excel is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel. |

### SpreadsheetTextEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheettexteffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeTextEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.ISpreadsheetWatermarkEffects
```
public final class SpreadsheetTextEffects extends OfficeTextEffects implements ISpreadsheetWatermarkEffects
```

Represents effects that can be applied to a text watermark for an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetTextEffects() | Initializes a new instance of the `SpreadsheetTextEffects` class. |
##### SpreadsheetTextEffects()
```
public SpreadsheetTextEffects()
```

Initializes a new instance of the `SpreadsheetTextEffects` class.

### SpreadsheetWatermarkBaseOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetwatermarkbaseoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions
```
public abstract class SpreadsheetWatermarkBaseOptions extends SpreadsheetWatermarkOptions
```

Base class for watermark adding options to a Spreadsheet document.
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in Excel is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Excel is forbidden. |
| getName() | Gets the name a shape. |
| setName(String value) | Sets the name a shape. |
| getAlternativeText() | Gets the descriptive (alternative) text that will be associated with a shape. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text that will be associated with a shape. |
##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in Excel is forbidden.

**Returns:**
boolean - If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in Excel is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel. |

##### getName()
```
public final String getName()
```

Gets the name a shape.

**Returns:**
java.lang.String - The shape name.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The shape name. |

##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text that will be associated with a shape.

**Returns:**
java.lang.String - The descriptive (alternative) text that will be associated with a shape.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text that will be associated with a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text that will be associated with a shape. |

### SpreadsheetWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetwatermarkheaderfooteroptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions
```
public final class SpreadsheetWatermarkHeaderFooterOptions extends SpreadsheetWatermarkOptions
```

Represents options when adding the watermark to a Spreadsheet header/footer.

**Learn more:**

 *  [Add watermarks to spreadsheet documents][]

The following example demonstrates how to add a text watermark into Excel worksheet header.

> ```
> ```
>
>    SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.xls", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));
>
>    SpreadsheetWatermarkHeaderFooterOptions options = new SpreadsheetWatermarkHeaderFooterOptions();
>    options.setWorksheetIndex(0);
>
>    watermarker.save("D:\\watermarked_test.xlsx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to spreadsheet documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+spreadsheet+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetWatermarkHeaderFooterOptions() | Initializes a new instance of the `SpreadsheetWatermarkHeaderFooterOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() | Gets the index of worksheet to add the watermark to. |
| setWorksheetIndex(int value) | Sets the index of worksheet to add the watermark to. |
##### SpreadsheetWatermarkHeaderFooterOptions()
```
public SpreadsheetWatermarkHeaderFooterOptions()
```

Initializes a new instance of the `SpreadsheetWatermarkHeaderFooterOptions` class.

##### getWorksheetIndex()
```
public final int getWorksheetIndex()
```

Gets the index of worksheet to add the watermark to.

**Returns:**
int - The index of worksheet to add the watermark to.

\-1 means every worksheet.
##### setWorksheetIndex(int value)
```
public final void setWorksheetIndex(int value)
```

Sets the index of worksheet to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of worksheet to add the watermark to.

\-1 means every worksheet. |

### SpreadsheetWatermarkModernWordArtOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetwatermarkmodernwordartoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions
```
public final class SpreadsheetWatermarkModernWordArtOptions extends SpreadsheetWatermarkBaseOptions
```

Represents options when adding modern word art watermark to a Spreadsheet worksheet.

**Learn more:**

 *  [Add watermarks to spreadsheet documents][]

The following example demonstrates how to add a modern WordArt watermark to an Excel document.

> ```
> ```
>
>    SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.xls", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));
>
>    SpreadsheetWatermarkModernWordArtOptions options = new SpreadsheetWatermarkModernWordArtOptions();
>    options.setWorksheetIndex(-1); // default
>    options.setLocked(false); // default
>
>    watermarker.save("D:\\watermarked_test.xlsx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to spreadsheet documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+spreadsheet+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetWatermarkModernWordArtOptions() | Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() | Gets the index of worksheet to add the watermark to. |
| setWorksheetIndex(int value) | Sets the index of worksheet to add the watermark to. |
##### SpreadsheetWatermarkModernWordArtOptions()
```
public SpreadsheetWatermarkModernWordArtOptions()
```

Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class.

##### getWorksheetIndex()
```
public final int getWorksheetIndex()
```

Gets the index of worksheet to add the watermark to.

**Returns:**
int - The index of worksheet to add the watermark to.

\-1 means every worksheet.
##### setWorksheetIndex(int value)
```
public final void setWorksheetIndex(int value)
```

Sets the index of worksheet to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of worksheet to add the watermark to.

\-1 means every worksheet. |

### SpreadsheetWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public abstract class SpreadsheetWatermarkOptions extends WatermarkOptions
```

Base class for watermark adding options to a Spreadsheet document.

### SpreadsheetWatermarkShapeOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/spreadsheetwatermarkshapeoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkOptions, com.groupdocs.watermark.options.SpreadsheetWatermarkBaseOptions
```
public final class SpreadsheetWatermarkShapeOptions extends SpreadsheetWatermarkBaseOptions
```

Represents options when adding shape watermark to a Spreadsheet worksheet.

**Learn more:**

 *  [Add watermarks to spreadsheet documents][]

The following example demonstrates how to add a watermark to a particular worksheet of an Excel document.

> ```
> ```
>
>    SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.xls", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));
>
>    SpreadsheetWatermarkShapeOptions options = new SpreadsheetWatermarkShapeOptions();
>    options.setWorksheetIndex(0);
>
>    watermarker.save("D:\\watermarked_test.xlsx");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to spreadsheet documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+spreadsheet+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetWatermarkShapeOptions() | Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getWorksheetIndex() | Gets the index of worksheet to add the watermark to. |
| setWorksheetIndex(int value) | Sets the index of worksheet to add the watermark to. |
| getEffects() | Gets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark. |
| setEffects(ISpreadsheetWatermarkEffects value) | Gets or sets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark. |
##### SpreadsheetWatermarkShapeOptions()
```
public SpreadsheetWatermarkShapeOptions()
```

Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class.

##### getWorksheetIndex()
```
public final int getWorksheetIndex()
```

Gets the index of worksheet to add the watermark to.

**Returns:**
int - The index of worksheet to add the watermark to.

\-1 means every worksheet.
##### setWorksheetIndex(int value)
```
public final void setWorksheetIndex(int value)
```

Sets the index of worksheet to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of worksheet to add the watermark to.

\-1 means every worksheet. |

##### getEffects()
```
public final ISpreadsheetWatermarkEffects getEffects()
```

Gets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark.

**Returns:**
ISpreadsheetWatermarkEffects - The `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark.
##### setEffects(ISpreadsheetWatermarkEffects value)
```
public final void setEffects(ISpreadsheetWatermarkEffects value)
```

Gets or sets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ISpreadsheetWatermarkEffects | The `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark. |

### TiffImageLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/tiffimageloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions, com.groupdocs.watermark.options.ImageLoadOptions, com.groupdocs.watermark.options.MultiframeImageLoadOptions
```
public final class TiffImageLoadOptions extends MultiframeImageLoadOptions
```

Represents image loading options for a TIFF image.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffImageLoadOptions() | Initializes a new instance of the `TiffImageLoadOptions` class. |
##### TiffImageLoadOptions()
```
public TiffImageLoadOptions()
```

Initializes a new instance of the `TiffImageLoadOptions` class.

### TiffImageSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/tiffimagesaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions, com.groupdocs.watermark.options.ImageSaveOptions
```
public final class TiffImageSaveOptions extends ImageSaveOptions
```

Represents image saving options when saving a TIFF image.
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffImageSaveOptions() | Initializes a new instance of the `TiffImageSaveOptions` class. |
##### TiffImageSaveOptions()
```
public TiffImageSaveOptions()
```

Initializes a new instance of the `TiffImageSaveOptions` class.

### TiffImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/tiffimagewatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.MultiframeImageWatermarkOptions
```
public final class TiffImageWatermarkOptions extends MultiframeImageWatermarkOptions
```

Represents watermark adding options when adding watermark to a TIFF image.

**Learn more:**

 *  [Add watermarks to images][]

The following example demonstrates how to add a watermark to a particular frame of TIFF image.

> ```
> ```
>
>    TiffImageImageLoadOptions loadOptions = new TiffImageImageLoadOptions();
>    Watermarker watermarker = new Watermarker("C:\\test.tiff", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));
>
>    TiffImageWatermarkOptions options = new TiffImageWatermarkOptions();
>    options.setFrameIndex(0);
>
>    watermarker.add(watermark, options);
>    watermarker.save("D:\\watermarked_test.tiff");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to images]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+images
#### Constructors

| Constructor | Description |
| --- | --- |
| TiffImageWatermarkOptions() | Initializes a new instance of the `TiffImageWatermarkOptions` class. |
| TiffImageWatermarkOptions(int frameIndex) | Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified index of the frame. |
##### TiffImageWatermarkOptions()
```
public TiffImageWatermarkOptions()
```

Initializes a new instance of the `TiffImageWatermarkOptions` class.

##### TiffImageWatermarkOptions(int frameIndex)
```
public TiffImageWatermarkOptions(int frameIndex)
```

Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified index of the frame.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | int | The index of frame to add watermark. |

### WatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/watermarkoptions.md

**Inheritance:**
java.lang.Object
```
public class WatermarkOptions
```

Represents watermark adding options when adding watermark to a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkOptions() | Initializes a new instance of the `WatermarkOptions` class. |
##### WatermarkOptions()
```
public WatermarkOptions()
```

Initializes a new instance of the `WatermarkOptions` class.

### WordProcessingFlipOrientation
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingfliporientation.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingFlipOrientation
```

Possible values for the orientation of a shape.
#### Fields

| Field | Description |
| --- | --- |
| None | Coordinates are not flipped. |
| Horizontal | Flip along the y-axis, reversing the x-coordinates. |
| Vertical | Flip along the x-axis, reversing the y-coordinates. |
| Both | Flip along both the y- and x-axis. |
##### None
```
public static final int None
```

Coordinates are not flipped.

##### Horizontal
```
public static final int Horizontal
```

Flip along the y-axis, reversing the x-coordinates.

##### Vertical
```
public static final int Vertical
```

Flip along the x-axis, reversing the y-coordinates.

##### Both
```
public static final int Both
```

Flip along both the y- and x-axis.

### WordProcessingImageEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingimageeffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeImageEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.IWordProcessingWatermarkEffects
```
public final class WordProcessingImageEffects extends OfficeImageEffects implements IWordProcessingWatermarkEffects
```

Represents effects that can be applied to an image watermark for a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingImageEffects() | Initializes a new instance of the `WordProcessingImageEffects` class. |
##### WordProcessingImageEffects()
```
public WordProcessingImageEffects()
```

Initializes a new instance of the `WordProcessingImageEffects` class.

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingloadoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.LoadOptions
```
public final class WordProcessingLoadOptions extends LoadOptions
```

Represents document loading options for a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingLoadOptions() | Initializes a new instance of the `WordProcessingLoadOptions` class. |
| WordProcessingLoadOptions(String password) | Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password. |
##### WordProcessingLoadOptions()
```
public WordProcessingLoadOptions()
```

Initializes a new instance of the `WordProcessingLoadOptions` class.

##### WordProcessingLoadOptions(String password)
```
public WordProcessingLoadOptions(String password)
```

Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | java.lang.String | The password for opening an encrypted content. |

### WordProcessingLockType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessinglocktype.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingLockType
```

Specifies watermark lock type in Word document.
#### Fields

| Field | Description |
| --- | --- |
| 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 | The entire document is read-only. |
| ReadOnlyWithEditableContent | The document is read-only, but all the content except of the watermark is marked as editable. |
| NoLock | Disable any lock on watermark and document. |
##### 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.

The document is splitted into one-page sections and locked section with watermark is added between each two adjacent content sections.

##### ReadOnly
```
public static final int ReadOnly
```

The entire document is read-only.

##### ReadOnlyWithEditableContent
```
public static final int ReadOnlyWithEditableContent
```

The document is read-only, but all the content except of the watermark is marked as editable.

##### NoLock
```
public static final int NoLock
```

Disable any lock on watermark and document.

### WordProcessingPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingpreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class WordProcessingPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of WordProcessing document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `WordProcessingPreviewOptions` class causing the output stream to be closed. |
| WordProcessingPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(float value) | Sets the resolution for the generated images, in dots per inch. |
##### WordProcessingPreviewOptions(ICreatePageStream createPageStream)
```
public WordProcessingPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `WordProcessingPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### WordProcessingPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public WordProcessingPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final float DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final float getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
float - The resolution for the generated images, in dots per inch.

The default value is 96.
##### setResolution(float value)
```
public final void setResolution(float value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The resolution for the generated images, in dots per inch.

The default value is 96. |

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingsaveoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.SaveOptions
```
public final class WordProcessingSaveOptions extends SaveOptions
```

Represents document saving options when saving a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingSaveOptions() | Initializes a new instance of the `WordProcessingSaveOptions` class. |
##### WordProcessingSaveOptions()
```
public WordProcessingSaveOptions()
```

Initializes a new instance of the `WordProcessingSaveOptions` class.

### WordProcessingShapeSettings
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingshapesettings.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeShapeSettings
```
public final class WordProcessingShapeSettings extends OfficeShapeSettings
```

Represents settings that can be applied to a shape watermark for a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingShapeSettings() | Initializes a new instance of the `WordProcessingShapeSettings` class. |
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in Word is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Word is forbidden. |
| getLockType() | Gets the watermark lock type. |
| setLockType(int value) | Sets the watermark lock type. |
| getPassword() | Gets a password used to lock the watermark. |
| setPassword(String value) | Sets a password used to lock the watermark. |
| getPageNumbers() | Gets the page numbers to add the watermark. |
| setPageNumbers(int[] value) | Sets the page numbers to add the watermark. |
##### WordProcessingShapeSettings()
```
public WordProcessingShapeSettings()
```

Initializes a new instance of the `WordProcessingShapeSettings` class.

##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in Word is forbidden.

**Returns:**
boolean - If the value is  true , shape editing will be forbidden. By default, the value is  false , the shape can be edited in Word.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in Word is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is  true , shape editing will be forbidden. By default, the value is  false , the shape can be edited in Word. |

##### getLockType()
```
public final int getLockType()
```

Gets the watermark lock type.

**Returns:**
int - The watermark lock type of `WordProcessingLockType`.
##### setLockType(int value)
```
public final void setLockType(int value)
```

Sets the watermark lock type.

Value `WordProcessingLockType.AllowOnlyFormFields` can not be used with an object of type `WordProcessingHeaderFooter`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The watermark lock type of `WordProcessingLockType`. |

##### getPassword()
```
public final String getPassword()
```

Gets a password used to lock the watermark.

**Returns:**
java.lang.String - A password used to lock the watermark.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password used to lock the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A password used to lock the watermark. |

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets the page numbers to add the watermark.

**Returns:**
int[] - The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is  null , the watermark is added to all pages.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets the page numbers to add the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is  null , the watermark is added to all pages. |

### WordProcessingTextEffects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingtexteffects.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.contents.OfficeTextEffects

**All Implemented Interfaces:**
com.groupdocs.watermark.options.IWordProcessingWatermarkEffects
```
public final class WordProcessingTextEffects extends OfficeTextEffects implements IWordProcessingWatermarkEffects
```

Represents effects that can be applied to a text watermark for a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingTextEffects() | Initializes a new instance of the `WordProcessingTextEffects` class. |
#### Methods

| Method | Description |
| --- | --- |
| getFlipOrientation() | Gets the orientation of a shape. |
| setFlipOrientation(int value) | Sets the orientation of a shape. |
##### WordProcessingTextEffects()
```
public WordProcessingTextEffects()
```

Initializes a new instance of the `WordProcessingTextEffects` class.

##### getFlipOrientation()
```
public final int getFlipOrientation()
```

Gets the orientation of a shape.

The default value is `WordProcessingFlipOrientation.None`.

**Returns:**
int - The orientation `WordProcessingFlipOrientation` of a shape.
##### setFlipOrientation(int value)
```
public final void setFlipOrientation(int value)
```

Sets the orientation of a shape.

The default value is `WordProcessingFlipOrientation.None`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The orientation `WordProcessingFlipOrientation` of a shape. |

### WordProcessingWatermarkBaseOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingwatermarkbaseoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkOptions
```
public abstract class WordProcessingWatermarkBaseOptions extends WordProcessingWatermarkOptions
```

Base class for watermark adding options to a Word document.
#### Methods

| Method | Description |
| --- | --- |
| isLocked() | Gets a value indicating whether an editing of the shape in Word is forbidden. |
| setLocked(boolean value) | Sets a value indicating whether an editing of the shape in Word is forbidden. |
| getLockType() | Gets the watermark lock type. |
| setLockType(int value) | Sets the watermark lock type. |
| getPassword() | Gets a password used to lock the watermark. |
| setPassword(String value) | Sets a password used to lock the watermark. |
| getName() | Gets the name a shape. |
| setName(String value) | Sets the name a shape. |
| getAlternativeText() | Gets the descriptive (alternative) text that will be associated with a shape. |
| setAlternativeText(String value) | Sets the descriptive (alternative) text that will be associated with a shape. |
| getEffects() |  |
| setEffects(IWordProcessingWatermarkEffects value) |  |
##### isLocked()
```
public final boolean isLocked()
```

Gets a value indicating whether an editing of the shape in Word is forbidden.

**Returns:**
boolean - If the value is  true , shape editing will be forbidden. By default, the value is  false , the shape can be edited in Word.
##### setLocked(boolean value)
```
public final void setLocked(boolean value)
```

Sets a value indicating whether an editing of the shape in Word is forbidden.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is  true , shape editing will be forbidden. By default, the value is  false , the shape can be edited in Word. |

##### getLockType()
```
public final int getLockType()
```

Gets the watermark lock type.

**Returns:**
int - The watermark `WordProcessingLockType` lock type.
##### setLockType(int value)
```
public final void setLockType(int value)
```

Sets the watermark lock type.

The value `WordProcessingLockType.AllowOnlyFormFields` can not be used with an object of type `WordProcessingHeaderFooter`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The watermark `WordProcessingLockType` lock type. |

##### getPassword()
```
public final String getPassword()
```

Gets a password used to lock the watermark.

**Returns:**
java.lang.String - A password used to lock the watermark.
##### setPassword(String value)
```
public final void setPassword(String value)
```

Sets a password used to lock the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | A password used to lock the watermark. |

##### getName()
```
public final String getName()
```

Gets the name a shape.

**Returns:**
java.lang.String - The shape name.
##### setName(String value)
```
public final void setName(String value)
```

Sets the name a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The shape name. |

##### getAlternativeText()
```
public final String getAlternativeText()
```

Gets the descriptive (alternative) text that will be associated with a shape.

**Returns:**
java.lang.String - The descriptive (alternative) text that will be associated with a shape.
##### setAlternativeText(String value)
```
public final void setAlternativeText(String value)
```

Sets the descriptive (alternative) text that will be associated with a shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The descriptive (alternative) text that will be associated with a shape. |

##### getEffects()
```
public final IWordProcessingWatermarkEffects getEffects()
```

**Returns:**
IWordProcessingWatermarkEffects
##### setEffects(IWordProcessingWatermarkEffects value)
```
public final void setEffects(IWordProcessingWatermarkEffects value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | IWordProcessingWatermarkEffects |  |

### WordProcessingWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingwatermarkheaderfooteroptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkBaseOptions
```
public final class WordProcessingWatermarkHeaderFooterOptions extends WordProcessingWatermarkBaseOptions
```

Represents options when adding the watermark to a Word section header/footer.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingWatermarkHeaderFooterOptions() | Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getSectionIndex() | Gets the index of a section to add the watermark to. |
| setSectionIndex(int value) | Sets the index of a section to add the watermark to. |
| getHeaderFooterType() | Gets the value that identifies the type of header or footer to add the watermark to. |
| setHeaderFooterType(int value) | Sets the value that identifies the type of header or footer to add the watermark to. |
##### WordProcessingWatermarkHeaderFooterOptions()
```
public WordProcessingWatermarkHeaderFooterOptions()
```

Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class.

##### getSectionIndex()
```
public final int getSectionIndex()
```

Gets the index of a section to add the watermark to.

**Returns:**
int - The index of a section to add the watermark to.

\-1 means all sections.
##### setSectionIndex(int value)
```
public final void setSectionIndex(int value)
```

Sets the index of a section to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of a section to add the watermark to.

\-1 means all sections. |

##### getHeaderFooterType()
```
public final int getHeaderFooterType()
```

Gets the value that identifies the type of header or footer to add the watermark to.

**Returns:**
int - The value of type `OfficeHeaderFooterType` that identifies the type of header or footer to add the watermark to.
##### setHeaderFooterType(int value)
```
public final void setHeaderFooterType(int value)
```

Sets the value that identifies the type of header or footer to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value of type `OfficeHeaderFooterType` that identifies the type of header or footer to add the watermark to. |

### WordProcessingWatermarkOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingwatermarkoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions
```
public abstract class WordProcessingWatermarkOptions extends WatermarkOptions
```

Base class for watermark adding options to a Word document.

### WordProcessingWatermarkPagesOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingwatermarkpagesoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkBaseOptions
```
public final class WordProcessingWatermarkPagesOptions extends WordProcessingWatermarkBaseOptions
```

Represents options when adding watermark to Word document pages.

**Learn more:**

 *  [Add watermarks to word processing documents][]

The following example demonstrates how to add a watermark to a particular page of a Word document.

> ```
> ```
>
>    WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.doc", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));
>
>    WordProcessingWatermarkPagesOptions options = new WordProcessingWatermarkPagesOptions();
>    options.setPageNumbers(new int[] { 1 });
>
>    watermarker.save("D:\\watermarked_test.doc");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to word processing documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+word+processing+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingWatermarkPagesOptions() | Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getPageNumbers() | Gets the page numbers to add the watermark. |
| setPageNumbers(int[] value) | Sets the page numbers to add the watermark. |
##### WordProcessingWatermarkPagesOptions()
```
public WordProcessingWatermarkPagesOptions()
```

Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class.

##### getPageNumbers()
```
public final int[] getPageNumbers()
```

Gets the page numbers to add the watermark.

**Returns:**
int[] - The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is  null  or empty, the watermark is added to all pages.
##### setPageNumbers(int[] value)
```
public final void setPageNumbers(int[] value)
```

Sets the page numbers to add the watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int[] | The page numbers to add the watermark.

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is  null  or empty, the watermark is added to all pages. |

### WordProcessingWatermarkSectionOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.options/wordprocessingwatermarksectionoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.WatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkOptions, com.groupdocs.watermark.options.WordProcessingWatermarkBaseOptions
```
public final class WordProcessingWatermarkSectionOptions extends WordProcessingWatermarkBaseOptions
```

Represents options when adding shape watermark to a Word document section.

**Learn more:**

 *  [Add watermarks to word processing documents][]

The following example demonstrates how to add a watermark to a particular section of a Word document.

> ```
> ```
>
>    WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.doc", loadOptions);
>
>    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));
>
>    WordProcessingWatermarkSectionOptions options = new WordProcessingWatermarkSectionOptions();
>    options.setSectionIndex(0);
>
>    watermarker.save("D:\\watermarked_test.doc");
>    watermarker.close();
>
> ```
> ```

[Add watermarks to word processing documents]: https://docs.groupdocs.com/display/watermarkjava/Add+watermarks+to+word+processing+documents
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingWatermarkSectionOptions() | Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class. |
#### Methods

| Method | Description |
| --- | --- |
| getSectionIndex() | Gets the index of a section to add the watermark to. |
| setSectionIndex(int value) | Sets the index of a section to add the watermark to. |
##### WordProcessingWatermarkSectionOptions()
```
public WordProcessingWatermarkSectionOptions()
```

Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class.

##### getSectionIndex()
```
public final int getSectionIndex()
```

Gets the index of a section to add the watermark to.

**Returns:**
int - The index of a section to add the watermark to.

\-1 means all sections.
##### setSectionIndex(int value)
```
public final void setSectionIndex(int value)
```

Sets the index of a section to add the watermark to.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The index of a section to add the watermark to.

\-1 means all sections. |

### com.groupdocs.watermark.search
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search.md

#### Classes

| Class | Description |
| --- | --- |
| AndSearchCriteria | Represents AND composite search criteria. |
| AttachedImagePossibleWatermark<T> | Represents attached image watermark in a content of any supported format. |
| ColorRange | Represents a range of colors. |
| DiagramCommentPossibleWatermark | Represents possible watermark in a Visio document comment. |
| DiagramHeaderFooterPossibleWatermark | Represents possible watermark in a Visio document header/footer. |
| DiagramHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a Visio document. |
| DiagramSearchableObjects | Specifies flags representing Visio document objects that are to be included in a watermark search. |
| DiagramShapePossibleWatermark | Represents possible shape watermark in a Visio document. |
| EmailAttachedImagePossibleWatermark | Represents possible image watermark in email message attachment. |
| EmailBodyTextPossibleWatermark | Represents possible watermark in email message body. |
| EmailEmbeddedImagePossibleWatermark | Represents possible image watermark embedded to email message body. |
| EmailHtmlBodyTextPossibleWatermark | Represents possible watermark in email message html body. |
| EmailSearchableObjects | Specifies flags representing email message objects that are to be included in a watermark search. |
| EmailSubjectTextPossibleWatermark | Represents possible watermark in email message subject. |
| EmailTextPossibleWatermark | Represents possible watermark in email message text fields. |
| FloatingAttachedImagePossibleWatermark<T> | Represents attached image watermark in a content of any supported format. |
| FormattedTextFragment | Provides abstract base class for a fragment of formatted text in a content. |
| FormattedTextFragmentCollection | Represents a mutable collection of formatted text fragments. |
| FormattedTextFragmentCollectionType | Specifies the number of elements a formatted text fragment collection can contain. |
| HyperlinkPossibleWatermark | Represents possible hyperlink watermark in a PowerPoint content. |
| ImageColorHistogramSearchCriteria | Represents search criteria for finding images in a content. |
| ImageDctHashSearchCriteria | Represents a search criteria for finding images in a document. |
| ImageSearchCriteria | Provides base class for image search criteria. |
| ImageThumbnailSearchCriteria | Represents search criteria for finding images in a content. |
| IsImageSearchCriteria | Represents search criteria for filtering image watermarks only. |
| IsTextSearchCriteria | Represents search criteria for filtering text watermarks only. |
| NotSearchCriteria | Represents NOT composite search criteria. |
| OrSearchCriteria | Represents OR composite search criteria. |
| PdfAnnotationPossibleWatermark | Represents possible annotation watermark in a pdf document. |
| PdfArtifactPossibleWatermark | Represents possible artifact watermark in a pdf content. |
| PdfAttachedImagePossibleWatermark | Represents possible image watermark in pdf document attachment. |
| PdfHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a pdf document. |
| PdfSearchableObjects | Specifies flags representing pdf content objects that are to be included in a watermark search. |
| PdfTextPossibleWatermark | Represents possible watermark in a pdf document text. |
| PdfXObjectPossibleWatermark | Represents possible XObject watermark in a pdf content. |
| PossibleWatermark | Represents possible watermark found in a document. |
| PossibleWatermarkCollection | Represents a collection of possible watermarks found in a content. |
| PresentationBackgroundPossibleWatermark | Represents possible background watermark in a PowerPoint document. |
| PresentationChartBackgroundPossibleWatermark | Represents possible background watermark in a PowerPoint chart. |
| PresentationHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a PowerPoint document. |
| PresentationSearchableObjects | Specifies flags representing PowerPoint content objects that are to be included in a watermark search. |
| PresentationShapePossibleWatermark | Represents possible shape watermark in a PowerPoint document. |
| RotateAngleSearchCriteria | Represents criteria allowing filtering by watermark rotate angle. |
| SearchCriteria | Class that can be used to construct criteria when searching for watermarks. |
| SearchableObjects | Specifies document objects that are to be included in a watermark search. |
| ShapePossibleWatermark<T> | Represents shape watermark in a content of any supported format. |
| ShapeSearchAdapter | Provides base class for a shape containing specific pieces of document that are to be included in watermark search. |
| SizeSearchCriteria | Represents criteria allowing filtering by watermark size. |
| SpreadsheetAttachedImagePossibleWatermark | Represents possible image watermark in Excel document attachment. |
| SpreadsheetBackgroundPossibleWatermark | Represents possible background watermark in an Excel document. |
| SpreadsheetCellPossibleWatermark | Represents possible cell watermark in an Excel document. |
| SpreadsheetChartBackgroundPossibleWatermark | Represents possible image watermark in Excel chart background. |
| SpreadsheetHeaderFooterPossibleWatermark | Represents possible watermark in a header or footer of an Excel document. |
| SpreadsheetHyperlinkPossibleWatermark | Represents possible hyperlink watermark in an Excel document. |
| SpreadsheetSearchableObjects | Specifies flags representing Excel content objects that are to be included in a watermark search. |
| SpreadsheetShapePossibleWatermark | Represents possible shape watermark in an Excel document. |
| TextFormattingSearchCriteria | Represents criteria allowing filtering by text formatting. |
| TextSearchCriteria | Represents criteria allowing filtering by watermark text. |
| TwoDObjectPossibleWatermark | Represents 2D object watermark in a content of any supported format. |
| WordProcessingSearchableObjects | Specifies flags representing Word content objects that are to be included in a watermark search. |
| WordProcessingShapePossibleWatermark | Represents possible shape watermark in a Word document. |
| WordProcessingTextHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a Word document. |
| WordProcessingTextPossibleWatermark | Represents possible watermark in a Word document text. |

#### Interfaces

| Interface | Description |
| --- | --- |
| IHyperlinkContainer |  |
| IRotatableTwoDObject | Represents any rotatable two dimensional object in a content structure. |
| ITwoDObject | Represents any two dimensional object in a content structure. |

### AndSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/andsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IBinaryOperation
```
public class AndSearchCriteria extends SearchCriteria implements IBinaryOperation
```

Represents AND composite search criteria.
#### Methods

| Method | Description |
| --- | --- |
| getRight() | Gets the right search criteria. |
| getLeft() | Gets the left search criteria. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### getRight()
```
public final SearchCriteria getRight()
```

Gets the right search criteria.

**Returns:**
SearchCriteria - The right search criteria.
##### getLeft()
```
public final SearchCriteria getLeft()
```

Gets the left search criteria.

**Returns:**
SearchCriteria - The left search criteria.
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### AttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/attachedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public abstract class AttachedImagePossibleWatermark<T> extends PossibleWatermark
```

Represents attached image watermark in a content of any supported format.

 T : The type of the attachment.
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `AttachedImagePossibleWatermark`. |
| getWidth() | Gets the width of this `AttachedImagePossibleWatermark`. |
| getHeight() | Gets the height of this `AttachedImagePossibleWatermark`. |
| getX() | Gets the x-coordinate of this `AttachedImagePossibleWatermark`. |
| getY() | Gets the y-coordinate of this `AttachedImagePossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| getUnitOfMeasurement() | Gets the unit of measurement `UnitOfMeasurement` of this `AttachedImagePossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `AttachedImagePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `AttachedImagePossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `AttachedImagePossibleWatermark`.

**Returns:**
double - The width of this `AttachedImagePossibleWatermark`.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `AttachedImagePossibleWatermark`.

**Returns:**
double - The height of this `AttachedImagePossibleWatermark`.
##### getX()
```
public double getX()
```

Gets the x-coordinate of this `AttachedImagePossibleWatermark`.

**Returns:**
double - The x-coordinate of this `AttachedImagePossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the y-coordinate of this `AttachedImagePossibleWatermark`.

**Returns:**
double - The y-coordinate of this `AttachedImagePossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `AttachedImagePossibleWatermark`.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the unit of measurement `UnitOfMeasurement` of this `AttachedImagePossibleWatermark`.

**Returns:**
int - The unit of measurement `UnitOfMeasurement` of this `AttachedImagePossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### ColorRange
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/colorrange.md

**Inheritance:**
java.lang.Object
```
public class ColorRange
```

Represents a range of colors. Specifies ranges using HSB representation of RGB color.
#### Constructors

| Constructor | Description |
| --- | --- |
| ColorRange() | Initializes a new instance of the `ColorRange` class. |
| ColorRange(Color exactColor) | Initializes a new instance of the `ColorRange` class with a specified exact color. |
#### Methods

| Method | Description |
| --- | --- |
| getMinHue() | Gets the starting hue value, in degrees. |
| setMinHue(float value) | Sets the starting hue value, in degrees. |
| getMaxHue() | Gets the ending hue value, in degrees. |
| setMaxHue(float value) | Sets the ending hue value, in degrees. |
| getMinSaturation() | Gets the starting saturation value. |
| setMinSaturation(float value) | Sets the starting saturation value. |
| getMaxSaturation() | Gets the ending saturation value. |
| setMaxSaturation(float value) | Sets the ending saturation value. |
| getMinBrightness() | Gets the starting brightness value. |
| setMinBrightness(float value) | Sets the starting brightness value. |
| getMaxBrightness() | Gets the ending brightness value. |
| setMaxBrightness(float value) | Sets the ending brightness value. |
| isEmpty() | Gets a value indicating whether only the empty color is in range. |
| setEmpty(boolean value) | Sets a value indicating whether only the empty color is in range. |
##### ColorRange()
```
public ColorRange()
```

Initializes a new instance of the `ColorRange` class.

##### ColorRange(Color exactColor)
```
public ColorRange(Color exactColor)
```

Initializes a new instance of the `ColorRange` class with a specified exact color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| exactColor | Color | The exact color from which the range is created. |

##### getMinHue()
```
public final float getMinHue()
```

Gets the starting hue value, in degrees.

**Returns:**
float - The starting hue value, in degrees.
##### setMinHue(float value)
```
public final void setMinHue(float value)
```

Sets the starting hue value, in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The starting hue value, in degrees. |

##### getMaxHue()
```
public final float getMaxHue()
```

Gets the ending hue value, in degrees.

**Returns:**
float - The ending hue value, in degrees.
##### setMaxHue(float value)
```
public final void setMaxHue(float value)
```

Sets the ending hue value, in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The ending hue value, in degrees. |

##### getMinSaturation()
```
public final float getMinSaturation()
```

Gets the starting saturation value.

**Returns:**
float - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.
##### setMinSaturation(float value)
```
public final void setMinSaturation(float value)
```

Sets the starting saturation value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated. |

##### getMaxSaturation()
```
public final float getMaxSaturation()
```

Gets the ending saturation value.

**Returns:**
float - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.
##### setMaxSaturation(float value)
```
public final void setMaxSaturation(float value)
```

Sets the ending saturation value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated. |

##### getMinBrightness()
```
public final float getMinBrightness()
```

Gets the starting brightness value.

**Returns:**
float - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.
##### setMinBrightness(float value)
```
public final void setMinBrightness(float value)
```

Sets the starting brightness value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white. |

##### getMaxBrightness()
```
public final float getMaxBrightness()
```

Gets the ending brightness value.

**Returns:**
float - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.
##### setMaxBrightness(float value)
```
public final void setMaxBrightness(float value)
```

Sets the ending brightness value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white. |

##### isEmpty()
```
public final boolean isEmpty()
```

Gets a value indicating whether only the empty color is in range.

**Returns:**
boolean - True if only the empty color is in range (HSB ranges are ignored); otherwise, false.
##### setEmpty(boolean value)
```
public final void setEmpty(boolean value)
```

Sets a value indicating whether only the empty color is in range.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | True if only the empty color is in range (HSB ranges are ignored); otherwise, false. |

### DiagramCommentPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/diagramcommentpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class DiagramCommentPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in a Visio document comment.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `DiagramCommentPossibleWatermark`. |
| getWidth() | Gets the width of this `DiagramCommentPossibleWatermark` in points. |
| getHeight() | Gets the height of this `DiagramCommentPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `DiagramCommentPossibleWatermark` from page left border in points. |
| getY() | Gets the vertical offset of this `DiagramCommentPossibleWatermark` from page bottom border in points. |
| getRotateAngle() | Gets the rotate angle of this `DiagramCommentPossibleWatermark` in degrees. |
| getText() | Gets the text of this `DiagramCommentPossibleWatermark`. |
| setText(String value) | Sets the text of this `DiagramCommentPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `DiagramCommentPossibleWatermark`. |
| remove() |  |
##### DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page)
```
public DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotation | com.aspose.diagram.Annotation |  |
| annotationCollection | com.aspose.diagram.AnnotationCollection |  |
| page | DiagramPage |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `DiagramCommentPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `DiagramCommentPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `DiagramCommentPossibleWatermark` in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `DiagramCommentPossibleWatermark` in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `DiagramCommentPossibleWatermark` from page left border in points.

**Returns:**
double - The x-coordinate of this `DiagramCommentPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `DiagramCommentPossibleWatermark` from page bottom border in points.

**Returns:**
double - The y-coordinate of this `DiagramCommentPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `DiagramCommentPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getText()
```
public String getText()
```

Gets the text of this `DiagramCommentPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `DiagramCommentPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `DiagramCommentPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `DiagramCommentPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `DiagramCommentPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `DiagramCommentPossibleWatermark`.
##### remove()
```
public void remove()
```

### DiagramHeaderFooterPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class DiagramHeaderFooterPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in a Visio document header/footer.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `DiagramHeaderFooterPossibleWatermark`. |
| getWidth() | Gets the width of this `DiagramHeaderFooterPossibleWatermark` in points. |
| getHeight() | Gets the height of this `DiagramHeaderFooterPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `DiagramHeaderFooterPossibleWatermark` from page left border in points. |
| getY() | Gets the vertical offset of this `DiagramHeaderFooterPossibleWatermark` from page bottom border in points. |
| getRotateAngle() | Gets the rotate angle of this `DiagramHeaderFooterPossibleWatermark` in degrees. |
| getText() | Gets the text of this `DiagramHeaderFooterPossibleWatermark`. |
| setText(String value) | Sets the text of this `DiagramHeaderFooterPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `DiagramHeaderFooterPossibleWatermark`. |
| remove() |  |
##### DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType)
```
public DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | DiagramContent |  |
| headerFooterType | int |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `DiagramHeaderFooterPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `DiagramHeaderFooterPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `DiagramHeaderFooterPossibleWatermark` in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `DiagramHeaderFooterPossibleWatermark` in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `DiagramHeaderFooterPossibleWatermark` from page left border in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `DiagramHeaderFooterPossibleWatermark` from page bottom border in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `DiagramHeaderFooterPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getText()
```
public String getText()
```

Gets the text of this `DiagramHeaderFooterPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `DiagramHeaderFooterPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `DiagramHeaderFooterPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `DiagramHeaderFooterPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `DiagramHeaderFooterPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `DiagramHeaderFooterPossibleWatermark`.
##### remove()
```
public void remove()
```

### DiagramHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/diagramhyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark
```
public class DiagramHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark
```

Represents possible hyperlink watermark in a Visio document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the url of this `DiagramHyperlinkPossibleWatermark`. |
| setText(String value) |  |
| remove() |  |
##### DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection)
```
public DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentWatermark | DiagramShapePossibleWatermark |  |
| hyperlink | DiagramHyperlink |  |
| collection | DiagramHyperlinkCollection |  |

##### getText()
```
public String getText()
```

Gets the url of this `DiagramHyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `DiagramHyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `HyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### remove()
```
public void remove()
```

### DiagramSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/diagramsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class DiagramSearchableObjects
```

Specifies flags representing Visio document objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| Shapes | Search in shapes. |
| Comments | Search in comments. |
| HeadersFooters | Search in headers and footers. |
| Hyperlinks | Search in hyperlinks. |
| All | Search in all content objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `DiagramSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### Shapes
```
public static final int Shapes
```

Search in shapes.

##### Comments
```
public static final int Comments
```

Search in comments.

##### HeadersFooters
```
public static final int HeadersFooters
```

Search in headers and footers.

##### Hyperlinks
```
public static final int Hyperlinks
```

Search in hyperlinks.

##### All
```
public static final int All
```

Search in all content objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `DiagramSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `DiagramSearchableObjects` enumeration.

### DiagramShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/diagramshapepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class DiagramShapePossibleWatermark extends ShapePossibleWatermark<DiagramShape>
```

Represents possible shape watermark in a Visio document.
#### Constructors

| Constructor | Description |
| --- | --- |
| DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `DiagramShapePossibleWatermark`. |
##### DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection)
```
public DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | DiagramShape |  |
| shapeCollection | DiagramShapeCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `DiagramShapePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `DiagramShapePossibleWatermark`.

### EmailAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailattachedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark
```
public class EmailAttachedImagePossibleWatermark extends AttachedImagePossibleWatermark<EmailAttachment>
```

Represents possible image watermark in email message attachment.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment) |  |
##### EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment)
```
public EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | EmailContent |  |
| attachment | EmailAttachment |  |

### EmailBodyTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailbodytextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark
```
public class EmailBodyTextPossibleWatermark extends EmailTextPossibleWatermark
```

Represents possible watermark in email message body.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match) |  |
##### EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```
public EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | EmailContent |  |
| match | com.aspose.ms.System.Text.RegularExpressions.Match |  |

### EmailEmbeddedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailembeddedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark
```
public class EmailEmbeddedImagePossibleWatermark extends AttachedImagePossibleWatermark<EmailEmbeddedObject>
```

Represents possible image watermark embedded to email message body.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject) |  |
##### EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject)
```
public EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | EmailContent |  |
| embeddedObject | EmailEmbeddedObject |  |

### EmailHtmlBodyTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailhtmlbodytextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark
```
public class EmailHtmlBodyTextPossibleWatermark extends EmailTextPossibleWatermark
```

Represents possible watermark in email message html body.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match) |  |
##### EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```
public EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | EmailContent |  |
| match | com.aspose.ms.System.Text.RegularExpressions.Match |  |

### EmailSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class EmailSearchableObjects
```

Specifies flags representing email message objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| Subject | Search in message subject. |
| PlainTextBody | Search in message plain text body. |
| HtmlBody | Search in message html body. |
| AttachedImages | Search in attached images. |
| EmbeddedImages | Search in embedded images. |
| All | Search in all email objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `EmailSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### Subject
```
public static final int Subject
```

Search in message subject.

##### PlainTextBody
```
public static final int PlainTextBody
```

Search in message plain text body.

##### HtmlBody
```
public static final int HtmlBody
```

Search in message html body.

##### AttachedImages
```
public static final int AttachedImages
```

Search in attached images.

##### EmbeddedImages
```
public static final int EmbeddedImages
```

Search in embedded images.

##### All
```
public static final int All
```

Search in all email objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `EmailSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `EmailSearchableObjects` enumeration.

### EmailSubjectTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailsubjecttextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark
```
public class EmailSubjectTextPossibleWatermark extends EmailTextPossibleWatermark
```

Represents possible watermark in email message subject.
#### Constructors

| Constructor | Description |
| --- | --- |
| EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match) |  |
##### EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```
public EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | EmailContent |  |
| match | com.aspose.ms.System.Text.RegularExpressions.Match |  |

### EmailTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/emailtextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public abstract class EmailTextPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in email message text fields.
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this . |
| getText() | Gets the text of this `EmailTextPossibleWatermark`. |
| setText(String value) | Sets the text of this `EmailTextPossibleWatermark`. |
| remove() |  |
##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this .

**Returns:**
ContentPart - The parent of this .
##### getText()
```
public String getText()
```

Gets the text of this `EmailTextPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `EmailTextPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `EmailTextPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `EmailTextPossibleWatermark`. |

##### remove()
```
public void remove()
```

### FloatingAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark
```
public class FloatingAttachedImagePossibleWatermark<T> extends AttachedImagePossibleWatermark<T>
```

Represents attached image watermark in a content of any supported format.

 T : The type of the attachment.
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `FloatingAttachedImagePossibleWatermark`. |
| getWidth() | Gets the width of this `FloatingAttachedImagePossibleWatermark`. |
| getHeight() | Gets the height of this `FloatingAttachedImagePossibleWatermark`. |
| getX() | Gets the x-coordinate of this `FloatingAttachedImagePossibleWatermark`. |
| getY() | Gets the y-coordinate of this `FloatingAttachedImagePossibleWatermark`. |
##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `FloatingAttachedImagePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `FloatingAttachedImagePossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `FloatingAttachedImagePossibleWatermark`.

**Returns:**
double - The width of this `FloatingAttachedImagePossibleWatermark`.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `FloatingAttachedImagePossibleWatermark`.

**Returns:**
double - The height of this `FloatingAttachedImagePossibleWatermark`.
##### getX()
```
public double getX()
```

Gets the x-coordinate of this `FloatingAttachedImagePossibleWatermark`.

**Returns:**
double - The x-coordinate of this `FloatingAttachedImagePossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the y-coordinate of this `FloatingAttachedImagePossibleWatermark`.

**Returns:**
double - The y-coordinate of this `FloatingAttachedImagePossibleWatermark`.

### FormattedTextFragment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/formattedtextfragment.md

**Inheritance:**
java.lang.Object
```
public abstract class FormattedTextFragment
```

Provides abstract base class for a fragment of formatted text in a content.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormattedTextFragment() |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the fragment text. |
| getFont() | Gets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
##### FormattedTextFragment()
```
public FormattedTextFragment()
```

##### getText()
```
public abstract String getText()
```

Gets the fragment text.

**Returns:**
java.lang.String - The fragment text.
##### getFont()
```
public abstract Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### getForegroundColor()
```
public abstract Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### getBackgroundColor()
```
public abstract Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.

### FormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/formattedtextfragmentcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class FormattedTextFragmentCollection extends RemoveOnlyListBase<FormattedTextFragment>
```

Represents a mutable collection of formatted text fragments.

This collection contains the items of `FormattedTextFragment` base type.
#### Constructors

| Constructor | Description |
| --- | --- |
| FormattedTextFragmentCollection(int collectionType) |  |
#### Methods

| Method | Description |
| --- | --- |
| getCollectionType() | Gets the formatted fragment collection type. |
| getDefaultFont() |  |
| getDefaultForegroundColor() |  |
| getDefaultBackgroundColor() |  |
| getText() |  |
| add(String text) | Adds a formatted text fragment to the collection. |
| add(String text, Font font) | Adds a formatted text fragment to the collection. |
| add(String text, Font font, Color foregroundColor) | Adds a formatted text fragment to the collection. |
| add(String text, Font font, Color foregroundColor, Color backgroundColor) | Adds a formatted text fragment to the collection. |
| insert(int index, String text) | Inserts a formatted text fragment into the collection at a given index. |
| insert(int index, String text, Font font) | Inserts a formatted text fragment into the collection at a given index. |
| insert(int index, String text, Font font, Color foregroundColor) | Inserts a formatted text fragment into the collection at a given index. |
| insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor) | Inserts a formatted text fragment into the collection at a given index. |
| createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor) |  |
| setText(String text) |  |
##### FormattedTextFragmentCollection(int collectionType)
```
public FormattedTextFragmentCollection(int collectionType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| collectionType | int |  |

##### getCollectionType()
```
public final int getCollectionType()
```

Gets the formatted fragment collection type.

**Returns:**
int - The formatted fragment collection type.
##### getDefaultFont()
```
public final Font getDefaultFont()
```

**Returns:**
Font
##### getDefaultForegroundColor()
```
public final Color getDefaultForegroundColor()
```

**Returns:**
Color
##### getDefaultBackgroundColor()
```
public final Color getDefaultBackgroundColor()
```

**Returns:**
Color
##### getText()
```
public String getText()
```

**Returns:**
java.lang.String
##### add(String text)
```
public final void add(String text)
```

Adds a formatted text fragment to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The fragment text. |

##### add(String text, Font font)
```
public final void add(String text, Font font)
```

Adds a formatted text fragment to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |

##### add(String text, Font font, Color foregroundColor)
```
public final void add(String text, Font font, Color foregroundColor)
```

Adds a formatted text fragment to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |

##### add(String text, Font font, Color foregroundColor, Color backgroundColor)
```
public final void add(String text, Font font, Color foregroundColor, Color backgroundColor)
```

Adds a formatted text fragment to the collection.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |
| backgroundColor | Color | The background color of the text. |

##### insert(int index, String text)
```
public final void insert(int index, String text)
```

Inserts a formatted text fragment into the collection at a given index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index at which formatted text fragment should be inserted. |
| text | java.lang.String | The fragment text. |

##### insert(int index, String text, Font font)
```
public final void insert(int index, String text, Font font)
```

Inserts a formatted text fragment into the collection at a given index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index at which formatted text fragment should be inserted. |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |

##### insert(int index, String text, Font font, Color foregroundColor)
```
public final void insert(int index, String text, Font font, Color foregroundColor)
```

Inserts a formatted text fragment into the collection at a given index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index at which formatted text fragment should be inserted. |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |

##### insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public final void insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

Inserts a formatted text fragment into the collection at a given index.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int | The zero-based index at which formatted text fragment should be inserted. |
| text | java.lang.String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |
| backgroundColor | Color | The background color of the text. |

##### createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```
public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | int |  |
| text | java.lang.String |  |
| font | Font |  |
| foregroundColor | Color |  |
| backgroundColor | Color |  |

**Returns:**
FormattedTextFragment
##### setText(String text)
```
public void setText(String text)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String |  |

### FormattedTextFragmentCollectionType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/formattedtextfragmentcollectiontype.md

**Inheritance:**
java.lang.Object
```
public final class FormattedTextFragmentCollectionType
```

Specifies the number of elements a formatted text fragment collection can contain.
#### Fields

| Field | Description |
| --- | --- |
| UnlimitedFragments | Multiple styles are allowed, the collection can contain unlimited count of fragments. |
| SingleFragment | Whole text can be formatted with a single style, the collection can contain only one fragment. |
| NoFormattedText | Parent object doesn't support text formatting, the collection is always empty. |
##### UnlimitedFragments
```
public static final int UnlimitedFragments
```

Multiple styles are allowed, the collection can contain unlimited count of fragments.

##### SingleFragment
```
public static final int SingleFragment
```

Whole text can be formatted with a single style, the collection can contain only one fragment.

##### NoFormattedText
```
public static final int NoFormattedText
```

Parent object doesn't support text formatting, the collection is always empty.

### HyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/hyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class HyperlinkPossibleWatermark extends PossibleWatermark
```

Represents possible hyperlink watermark in a PowerPoint content.
#### Constructors

| Constructor | Description |
| --- | --- |
| HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `HyperlinkPossibleWatermark`. |
| getWidth() | Gets the width of this `HyperlinkPossibleWatermark`. |
| getHeight() | Gets the height of this `HyperlinkPossibleWatermark`. |
| getX() | Gets the x-coordinate of this `HyperlinkPossibleWatermark`. |
| getY() | Gets the y-coordinate of this `HyperlinkPossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| getText() | Gets the url of this `HyperlinkPossibleWatermark`. |
| setText(String value) | Sets the url of this `HyperlinkPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the unit of measurement `UnitOfMeasurement` of this `HyperlinkPossibleWatermark`. |
| remove() |  |
##### HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer)
```
public HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentWatermark | PossibleWatermark |  |
| hyperlinkContainer | IHyperlinkContainer |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `HyperlinkPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `HyperlinkPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `HyperlinkPossibleWatermark`.

**Returns:**
double - The width of this `HyperlinkPossibleWatermark`.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `HyperlinkPossibleWatermark`.

**Returns:**
double - The height of this `HyperlinkPossibleWatermark`.
##### getX()
```
public double getX()
```

Gets the x-coordinate of this `HyperlinkPossibleWatermark`.

**Returns:**
double - The x-coordinate of this `HyperlinkPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the y-coordinate of this `HyperlinkPossibleWatermark`.

**Returns:**
double - The y-coordinate of this `HyperlinkPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `HyperlinkPossibleWatermark`.
##### getText()
```
public String getText()
```

Gets the url of this `HyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `HyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `HyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The url of this `HyperlinkPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the unit of measurement `UnitOfMeasurement` of this `HyperlinkPossibleWatermark`.

**Returns:**
int - The unit of measurement `UnitOfMeasurement` of this `HyperlinkPossibleWatermark`.
##### remove()
```
public void remove()
```

### IHyperlinkContainer
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/ihyperlinkcontainer.md

### ImageColorHistogramSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/imagecolorhistogramsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria
```
public class ImageColorHistogramSearchCriteria extends ImageSearchCriteria
```

Represents search criteria for finding images in a content.

This search criteria uses image color histograms for calculating image similarity.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageColorHistogramSearchCriteria(String filePath) | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path. |
| ImageColorHistogramSearchCriteria(InputStream stream) | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream. |
#### Methods

| Method | Description |
| --- | --- |
| getBinsCount() | Gets a count of bins that will be used for building color histograms. |
| setBinsCount(byte value) | Sets a count of bins that will be used for building color histograms. |
##### ImageColorHistogramSearchCriteria(String filePath)
```
public ImageColorHistogramSearchCriteria(String filePath)
```

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load image from. |

##### ImageColorHistogramSearchCriteria(InputStream stream)
```
public ImageColorHistogramSearchCriteria(InputStream stream)
```

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The stream to load image from. |

##### getBinsCount()
```
public final byte getBinsCount()
```

Gets a count of bins that will be used for building color histograms.

**Returns:**
byte - The default value is 10.
##### setBinsCount(byte value)
```
public final void setBinsCount(byte value)
```

Sets a count of bins that will be used for building color histograms.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | The default value is 10. |

### ImageDctHashSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/imagedcthashsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria
```
public class ImageDctHashSearchCriteria extends ImageSearchCriteria
```

Represents a search criteria for finding images in a document.

This search criteria uses DCT based perceptual image hash for calculating image similarity.

**Learn more:**

 *  [Searching watermarks][]

The following example demonstrates how to search for images in the attached files (pdf).

> ```
> ```
>
>    WatermarkerSettings settings = new WatermarkerSettings();
>    settings.setSearchableObjects(new SearchableObjects());
>    settings.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.All);
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.pdf", loadOptions);
>
>    // Specify sample image to compare document images with
>    ImageSearchCriteria criteria = new ImageDctHashSearchCriteria("D:\\sample.png");
>    // Search for similar images
>    PossibleWatermarkCollection possibleWatermarks = watermarker.search(criteria);
>    // Remove or modify found image watermarks
>    // ...
>
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageDctHashSearchCriteria(String filePath) | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path. |
| ImageDctHashSearchCriteria(InputStream stream) | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream. |
| ImageDctHashSearchCriteria(System.IO.Stream stream) |  |
##### ImageDctHashSearchCriteria(String filePath)
```
public ImageDctHashSearchCriteria(String filePath)
```

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load image from. |

##### ImageDctHashSearchCriteria(InputStream stream)
```
public ImageDctHashSearchCriteria(InputStream stream)
```

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The stream to load image from. |

##### ImageDctHashSearchCriteria(System.IO.Stream stream)
```
public ImageDctHashSearchCriteria(System.IO.Stream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

### ImageSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/imagesearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria
```
public abstract class ImageSearchCriteria extends PageSearchCriteria
```

Provides base class for image search criteria.
#### Methods

| Method | Description |
| --- | --- |
| getMaxDifference() | Gets maximum allowed difference between images. |
| setMaxDifference(double value) | Sets maximum allowed difference between images. |
| getStream() |  |
| getTrueImages() |  |
| getFalseImages() |  |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
| resetCache() |  |
##### getMaxDifference()
```
public final double getMaxDifference()
```

Gets maximum allowed difference between images.

**Returns:**
double - The value should be between 0 and 1. 0 means that only identical images will be found.
##### setMaxDifference(double value)
```
public final void setMaxDifference(double value)
```

Sets maximum allowed difference between images.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The value should be between 0 and 1. 0 means that only identical images will be found. |

##### getStream()
```
public final StreamContainer getStream()
```

**Returns:**
StreamContainer
##### getTrueImages()
```
public final System.Collections.Generic.List<WatermarkableImage> getTrueImages()
```

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.groupdocs.watermark.contents.WatermarkableImage>
##### getFalseImages()
```
public final System.Collections.Generic.List<WatermarkableImage> getFalseImages()
```

**Returns:**
com.aspose.ms.System.Collections.Generic.List<com.groupdocs.watermark.contents.WatermarkableImage>
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

##### resetCache()
```
public final void resetCache()
```

### ImageThumbnailSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/imagethumbnailsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria
```
public class ImageThumbnailSearchCriteria extends ImageSearchCriteria
```

Represents search criteria for finding images in a content.

This search criteria uses image binarized thumbnail for calculating image similarity.
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageThumbnailSearchCriteria(String filePath) | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path. |
| ImageThumbnailSearchCriteria(InputStream stream) | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream. |
#### Methods

| Method | Description |
| --- | --- |
| getThumbnailSize() | Gets thumbnail size. |
| setThumbnailSize(byte value) | Sets thumbnail size. |
##### ImageThumbnailSearchCriteria(String filePath)
```
public ImageThumbnailSearchCriteria(String filePath)
```

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load image from. |

##### ImageThumbnailSearchCriteria(InputStream stream)
```
public ImageThumbnailSearchCriteria(InputStream stream)
```

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The stream to load image from. |

##### getThumbnailSize()
```
public final byte getThumbnailSize()
```

Gets thumbnail size.

**Returns:**
byte - By default 32X32 thumbnail will be used.
##### setThumbnailSize(byte value)
```
public final void setThumbnailSize(byte value)
```

Sets thumbnail size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte | By default 32X32 thumbnail will be used. |

### IRotatableTwoDObject
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/irotatabletwodobject.md

**All Implemented Interfaces:**
com.groupdocs.watermark.search.ITwoDObject
```
public interface IRotatableTwoDObject extends ITwoDObject
```

Represents any rotatable two dimensional object in a content structure.
#### Methods

| Method | Description |
| --- | --- |
| getRotateAngle() | Gets the rotate angle of the object in degrees. |
##### getRotateAngle()
```
public abstract double getRotateAngle()
```

Gets the rotate angle of the object in degrees.

**Returns:**
double - The rotate angle of the object in degrees.

### IsImageSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/isimagesearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public final class IsImageSearchCriteria extends SearchCriteria
```

Represents search criteria for filtering image watermarks only.
#### Constructors

| Constructor | Description |
| --- | --- |
| IsImageSearchCriteria() | Initializes a new instance of the `IsImageSearchCriteria` class. |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### IsImageSearchCriteria()
```
public IsImageSearchCriteria()
```

Initializes a new instance of the `IsImageSearchCriteria` class.

##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### IsTextSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/istextsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public final class IsTextSearchCriteria extends SearchCriteria
```

Represents search criteria for filtering text watermarks only.
#### Constructors

| Constructor | Description |
| --- | --- |
| IsTextSearchCriteria() | Initializes a new instance of the `IsTextSearchCriteria` class. |
#### Methods

| Method | Description |
| --- | --- |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### IsTextSearchCriteria()
```
public IsTextSearchCriteria()
```

Initializes a new instance of the `IsTextSearchCriteria` class.

##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### ITwoDObject
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/itwodobject.md

### NotSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/notsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public class NotSearchCriteria extends SearchCriteria
```

Represents NOT composite search criteria.
#### Methods

| Method | Description |
| --- | --- |
| getWrapped() |  |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### getWrapped()
```
public final SearchCriteria getWrapped()
```

**Returns:**
SearchCriteria
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### OrSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/orsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

**All Implemented Interfaces:**
com.groupdocs.watermark.internal.IBinaryOperation
```
public class OrSearchCriteria extends SearchCriteria implements IBinaryOperation
```

Represents OR composite search criteria.
#### Methods

| Method | Description |
| --- | --- |
| getLeft() | Gets the left search criteria. |
| getRight() | Gets the right search criteria. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### getLeft()
```
public final SearchCriteria getLeft()
```

Gets the left search criteria.

**Returns:**
SearchCriteria - The left search criteria.
##### getRight()
```
public final SearchCriteria getRight()
```

Gets the right search criteria.

**Returns:**
SearchCriteria - The right search criteria.
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### PdfAnnotationPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfannotationpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class PdfAnnotationPossibleWatermark extends ShapePossibleWatermark<PdfAnnotation>
```

Represents possible annotation watermark in a pdf document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PdfAnnotationPossibleWatermark`. |
##### PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection)
```
public PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| annotation | PdfAnnotation |  |
| annotationCollection | PdfAnnotationCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PdfAnnotationPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PdfAnnotationPossibleWatermark`.

### PdfArtifactPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfartifactpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class PdfArtifactPossibleWatermark extends ShapePossibleWatermark<PdfArtifact>
```

Represents possible artifact watermark in a pdf content.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PdfArtifactPossibleWatermark`. |
##### PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection)
```
public PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| artifact | PdfArtifact |  |
| artifactCollection | PdfArtifactCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PdfArtifactPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PdfArtifactPossibleWatermark`.

### PdfAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfattachedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark
```
public class PdfAttachedImagePossibleWatermark extends AttachedImagePossibleWatermark<PdfAttachment>
```

Represents possible image watermark in pdf document attachment.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment) |  |
##### PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment)
```
public PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| content | PdfContent |  |
| attachment | PdfAttachment |  |

### PdfHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfhyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark
```
public class PdfHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark
```

Represents possible hyperlink watermark in a pdf document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark) |  |
| PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the url of this `PdfHyperlinkPossibleWatermark`. |
| setText(String value) |  |
| remove() |  |
##### PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark)
```
public PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| action | com.aspose.pdf.GoToURIAction |  |
| parentWatermark | PdfAnnotationPossibleWatermark |  |

##### PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark)
```
public PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| action | com.aspose.pdf.LaunchAction |  |
| parentWatermark | PdfAnnotationPossibleWatermark |  |

##### getText()
```
public String getText()
```

Gets the url of this `PdfHyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `PdfHyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `HyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### remove()
```
public void remove()
```

### PdfSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class PdfSearchableObjects
```

Specifies flags representing pdf content objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| XObjects | Search in XObjects. |
| Artifacts | Search in artifacts. |
| Annotations | Search in annotations. |
| Text | Search in content text. |
| Hyperlinks | Search in hyperlinks. |
| AttachedImages | Search in attached images. |
| Vector | Search in attached operators. |
| All | Search in all content objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `PdfSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### XObjects
```
public static final int XObjects
```

Search in XObjects.

##### Artifacts
```
public static final int Artifacts
```

Search in artifacts.

##### Annotations
```
public static final int Annotations
```

Search in annotations.

##### Text
```
public static final int Text
```

Search in content text.

##### Hyperlinks
```
public static final int Hyperlinks
```

Search in hyperlinks.

##### AttachedImages
```
public static final int AttachedImages
```

Search in attached images.

##### Vector
```
public static final int Vector
```

Search in attached operators.

##### All
```
public static final int All
```

Search in all content objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `PdfSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `PdfSearchableObjects` enumeration.

### PdfTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdftextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class PdfTextPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in a pdf document text.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PdfTextPossibleWatermark`. |
| getWidth() | Gets the width of this `PdfTextPossibleWatermark` in points. |
| getHeight() | Gets the height of this `PdfTextPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `PdfTextPossibleWatermark` from page left border in points. |
| getY() | Gets the vertical offset of this `PdfTextPossibleWatermark` from page bottom border in points. |
| getRotateAngle() | Gets the rotate angle of this `PdfTextPossibleWatermark` in degrees. |
| getText() | Gets the text of this `PdfTextPossibleWatermark`. |
| setText(String value) | Sets the text of this `PdfTextPossibleWatermark`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `PdfTextPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `PdfTextPossibleWatermark`. |
| remove() |  |
##### PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment)
```
public PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | PdfPage |  |
| fragment | com.aspose.pdf.TextFragment |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PdfTextPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PdfTextPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PdfTextPossibleWatermark` in points.

**Returns:**
double - The width of this `PdfTextPossibleWatermark` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PdfTextPossibleWatermark` in points.

**Returns:**
double - The height of this `PdfTextPossibleWatermark` in points.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `PdfTextPossibleWatermark` from page left border in points.

**Returns:**
double - The x-coordinate of this `PdfTextPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `PdfTextPossibleWatermark` from page bottom border in points.

**Returns:**
double - The y-coordinate of this `PdfTextPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PdfTextPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getText()
```
public String getText()
```

Gets the text of this `PdfTextPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `PdfTextPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `PdfTextPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `PdfTextPossibleWatermark`. |

##### getFormattedTextFragments()
```
public FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `PdfTextPossibleWatermark`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `PdfTextPossibleWatermark`.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `PdfTextPossibleWatermark`.

**Returns:**
int - `UnitOfMeasurement` of this `PdfTextPossibleWatermark`.
##### remove()
```
public void remove()
```

### PdfXObjectPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/pdfxobjectpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class PdfXObjectPossibleWatermark extends ShapePossibleWatermark<PdfXObject>
```

Represents possible XObject watermark in a pdf content.
#### Constructors

| Constructor | Description |
| --- | --- |
| PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PdfXObjectPossibleWatermark`. |
##### PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection)
```
public PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| xObject | PdfXObject |  |
| xObjectCollection | PdfXObjectCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PdfXObjectPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PdfXObjectPossibleWatermark`.

### PossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/possiblewatermark.md

**Inheritance:**
java.lang.Object
```
public abstract class PossibleWatermark
```

Represents possible watermark found in a document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PossibleWatermark() |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PossibleWatermark`. |
| getPageNumber() |  |
| getWidth() | Gets the width of this `PossibleWatermark`. |
| getHeight() | Gets the height of this `PossibleWatermark`. |
| getX() | Gets the x-coordinate of this `PossibleWatermark`. |
| getY() | Gets the y-coordinate of this `PossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| getText() | Gets the text of this `PossibleWatermark`. |
| setText(String value) | Sets the text of this `PossibleWatermark`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| getImageData() | Gets or sets the image of this `PossibleWatermark`. |
| setImageData(byte[] value) |  |
| getUnitOfMeasurement() | Gets the unit of measurement `UnitOfMeasurement` of this `PossibleWatermark`. |
| getCollection() |  |
| setCollection(PossibleWatermarkCollection value) |  |
| getImageSize() |  |
| getImageInternally() |  |
| remove() |  |
##### PossibleWatermark()
```
public PossibleWatermark()
```

##### getParent()
```
public abstract ContentPart getParent()
```

Gets the parent of this `PossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PossibleWatermark`.
##### getPageNumber()
```
public Integer getPageNumber()
```

**Returns:**
java.lang.Integer
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PossibleWatermark`.

**Returns:**
double - The width of this `PossibleWatermark`.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PossibleWatermark`.

**Returns:**
double - The height of this `PossibleWatermark`.
##### getX()
```
public double getX()
```

Gets the x-coordinate of this `PossibleWatermark`.

**Returns:**
double - The x-coordinate of this `PossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the y-coordinate of this `PossibleWatermark`.

**Returns:**
double - The y-coordinate of this `PossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `PossibleWatermark`.
##### getText()
```
public String getText()
```

Gets the text of this `PossibleWatermark`.

**Returns:**
java.lang.String - The text of this `PossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `PossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `PossibleWatermark`. |

##### getFormattedTextFragments()
```
public FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `PossibleWatermark`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `PossibleWatermark`.
##### getImageData()
```
public final byte[] getImageData()
```

Gets or sets the image of this `PossibleWatermark`.

**Returns:**
byte[] - The image of this `PossibleWatermark` or null if the watermark has no image.
##### setImageData(byte[] value)
```
public final void setImageData(byte[] value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | byte[] |  |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the unit of measurement `UnitOfMeasurement` of this `PossibleWatermark`.

**Returns:**
int - The unit of measurement `UnitOfMeasurement` of this `PossibleWatermark`.
##### getCollection()
```
public final PossibleWatermarkCollection getCollection()
```

**Returns:**
PossibleWatermarkCollection
##### setCollection(PossibleWatermarkCollection value)
```
public final void setCollection(PossibleWatermarkCollection value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PossibleWatermarkCollection |  |

##### getImageSize()
```
public final Size getImageSize()
```

**Returns:**
Size
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public abstract void remove()
```

### PossibleWatermarkCollection
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/possiblewatermarkcollection.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase, com.groupdocs.watermark.common.RemoveOnlyListBase
```
public class PossibleWatermarkCollection extends RemoveOnlyListBase<PossibleWatermark>
```

Represents a collection of possible watermarks found in a content.

This collection contains the items of `PossibleWatermark` type.
#### Constructors

| Constructor | Description |
| --- | --- |
| PossibleWatermarkCollection() |  |
#### Methods

| Method | Description |
| --- | --- |
| addRangeInternally(System.Collections.Generic.IGenericEnumerable<PossibleWatermark> collection) |  |
| addInternally(PossibleWatermark item) |  |
| removeFromDocument(PossibleWatermark item) |  |
##### PossibleWatermarkCollection()
```
public PossibleWatermarkCollection()
```

##### addRangeInternally(System.Collections.Generic.IGenericEnumerable<PossibleWatermark> collection)
```
public final void addRangeInternally(System.Collections.Generic.IGenericEnumerable<PossibleWatermark> collection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| collection | com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.groupdocs.watermark.search.PossibleWatermark> |  |

##### addInternally(PossibleWatermark item)
```
public void addInternally(PossibleWatermark item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PossibleWatermark |  |

##### removeFromDocument(PossibleWatermark item)
```
public void removeFromDocument(PossibleWatermark item)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| item | PossibleWatermark |  |

### PresentationBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class PresentationBackgroundPossibleWatermark extends PossibleWatermark
```

Represents possible background watermark in a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PresentationBackgroundPossibleWatermark`. |
| getWidth() | Gets the width of this `PresentationBackgroundPossibleWatermark` in points. |
| getHeight() | Gets the height of this `PresentationBackgroundPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `PresentationBackgroundPossibleWatermark` from slide left border in points. |
| getY() | Gets the vertical offset of this `PresentationBackgroundPossibleWatermark` from slide top border in points. |
| getRotateAngle() | Gets the rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `PresentationBackgroundPossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide)
```
public PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| slide | PresentationBaseSlide |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PresentationBackgroundPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PresentationBackgroundPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `PresentationBackgroundPossibleWatermark` in points.

**Returns:**
double - The width of this `PresentationBackgroundPossibleWatermark` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `PresentationBackgroundPossibleWatermark` in points.

**Returns:**
double - The height of this `PresentationBackgroundPossibleWatermark` in points.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `PresentationBackgroundPossibleWatermark` from slide left border in points.

**Returns:**
double - The x-coordinate of this `PresentationBackgroundPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `PresentationBackgroundPossibleWatermark` from slide top border in points.

**Returns:**
double - The y-coordinate of this `PresentationBackgroundPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `PresentationBackgroundPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `PresentationBackgroundPossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### PresentationChartBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark
```
public class PresentationChartBackgroundPossibleWatermark extends TwoDObjectPossibleWatermark
```

Represents possible background watermark in a PowerPoint chart.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationChartBackgroundPossibleWatermark(PresentationChart chart) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PresentationChartBackgroundPossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `PresentationChartBackgroundPossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### PresentationChartBackgroundPossibleWatermark(PresentationChart chart)
```
public PresentationChartBackgroundPossibleWatermark(PresentationChart chart)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chart | PresentationChart |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PresentationChartBackgroundPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PresentationChartBackgroundPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `PresentationChartBackgroundPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `PresentationChartBackgroundPossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### PresentationHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/presentationhyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark
```
public class PresentationHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark
```

Represents possible hyperlink watermark in a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType) |  |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the url of this `HyperlinkPossibleWatermark`. |
| setText(String value) | Sets the url of this `HyperlinkPossibleWatermark`. |
| remove() |  |
##### PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType)
```
public PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parentWatermark | PossibleWatermark |  |
| hyperlinkContainer | IPresentationHyperlinkContainer |  |
| actionType | int |  |

##### getText()
```
public String getText()
```

Gets the url of this `HyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `HyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `HyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The url of this `HyperlinkPossibleWatermark`. |

##### remove()
```
public void remove()
```

### PresentationSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/presentationsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class PresentationSearchableObjects
```

Specifies flags representing PowerPoint content objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| Shapes | Search in shapes. |
| ChartsBackgrounds | Search in charts backgrounds. |
| SlidesBackgrounds | Search in slides backgrounds. |
| Hyperlinks | Search in hyperlinks. |
| All | Search in all content objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `PresentationSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### Shapes
```
public static final int Shapes
```

Search in shapes.

##### ChartsBackgrounds
```
public static final int ChartsBackgrounds
```

Search in charts backgrounds.

##### SlidesBackgrounds
```
public static final int SlidesBackgrounds
```

Search in slides backgrounds.

##### Hyperlinks
```
public static final int Hyperlinks
```

Search in hyperlinks.

##### All
```
public static final int All
```

Search in all content objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `PresentationSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `PresentationSearchableObjects` enumeration.

### PresentationShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/presentationshapepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class PresentationShapePossibleWatermark extends ShapePossibleWatermark<PresentationShape>
```

Represents possible shape watermark in a PowerPoint document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `PresentationShapePossibleWatermark`. |
##### PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection)
```
public PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | PresentationShape |  |
| shapeCollection | PresentationShapeCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `PresentationShapePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `PresentationShapePossibleWatermark`.

### RotateAngleSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/rotateanglesearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public class RotateAngleSearchCriteria extends SearchCriteria
```

Represents criteria allowing filtering by watermark rotate angle.

**Learn more:**

 *  [Searching watermarks][]

The following example demonstrates how to find and remove watermarks using search criteria.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("C:\\test.some_ext");
>    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
>    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
>    TextSearchCriteria textCriteria = new TextSearchCriteria(Pattern.compile("^Test watermark$"));
>
>    PossibleWatermarkCollection watermarks = watermarker.search(textCriteria.and(widthRange.or(rotateAngle)));
>    watermarks.clear();
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| RotateAngleSearchCriteria(double minAngle, double maxAngle) | Initializes a new instance of the `RotateAngleSearchCriteria` class with a starting angle and a ending angle. |
#### Methods

| Method | Description |
| --- | --- |
| getMinimumAngle() | Gets the starting angle in degrees. |
| getMaximumAngle() | Gets the ending angle in degrees. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### RotateAngleSearchCriteria(double minAngle, double maxAngle)
```
public RotateAngleSearchCriteria(double minAngle, double maxAngle)
```

Initializes a new instance of the `RotateAngleSearchCriteria` class with a starting angle and a ending angle.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| minAngle | double | The starting angle in degrees. |
| maxAngle | double | The ending angle in degrees. |

##### getMinimumAngle()
```
public final double getMinimumAngle()
```

Gets the starting angle in degrees.

**Returns:**
double - The starting angle.
##### getMaximumAngle()
```
public final double getMaximumAngle()
```

Gets the ending angle in degrees.

**Returns:**
double - The ending angle.
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### SearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/searchableobjects.md

**Inheritance:**
java.lang.Object
```
public class SearchableObjects
```

Specifies document objects that are to be included in a watermark search.

**Learn more:**

 *  [Searching watermarks][]

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| SearchableObjects() | Initializes a new instance of the `SearchableObjects` class. |
#### Methods

| Method | Description |
| --- | --- |
| getSpreadsheetSearchableObjects() | Gets the objects inside an Excel document that are to be included in a watermark search. |
| setSpreadsheetSearchableObjects(int value) | Sets the objects inside an Excel document that are to be included in a watermark search. |
| getDiagramSearchableObjects() | Gets the objects inside a Visio document that are to be included in a watermark search. |
| setDiagramSearchableObjects(int value) | Sets the objects inside a Visio document that are to be included in a watermark search. |
| getPresentationSearchableObjects() | Gets the objects inside a PowerPoint document that are to be included in a watermark search. |
| setPresentationSearchableObjects(int value) | Sets the objects inside a PowerPoint document that are to be included in a watermark search. |
| getWordProcessingSearchableObjects() | Gets the objects inside a Word document that are to be included in a watermark search. |
| setWordProcessingSearchableObjects(int value) | Sets the objects inside a Word document that are to be included in a watermark search. |
| getPdfSearchableObjects() | Gets the objects inside a PDF document that are to be included in a watermark search. |
| setPdfSearchableObjects(int value) | Sets the objects inside a PDF document that are to be included in a watermark search. |
| getEmailSearchableObjects() | Gets the objects inside an email message that are to be included in a watermark search. |
| setEmailSearchableObjects(int value) | Sets the objects inside an email message that are to be included in a watermark search. |
##### SearchableObjects()
```
public SearchableObjects()
```

Initializes a new instance of the `SearchableObjects` class.

##### getSpreadsheetSearchableObjects()
```
public final int getSpreadsheetSearchableObjects()
```

Gets the objects inside an Excel document that are to be included in a watermark search.

**Returns:**
int - The objects inside an Excel document that are to be included in a watermark search.
##### setSpreadsheetSearchableObjects(int value)
```
public final void setSpreadsheetSearchableObjects(int value)
```

Sets the objects inside an Excel document that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside an Excel document that are to be included in a watermark search. |

##### getDiagramSearchableObjects()
```
public final int getDiagramSearchableObjects()
```

Gets the objects inside a Visio document that are to be included in a watermark search.

**Returns:**
int - The objects inside a Visio document that are to be included in a watermark search.
##### setDiagramSearchableObjects(int value)
```
public final void setDiagramSearchableObjects(int value)
```

Sets the objects inside a Visio document that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside a Visio document that are to be included in a watermark search. |

##### getPresentationSearchableObjects()
```
public final int getPresentationSearchableObjects()
```

Gets the objects inside a PowerPoint document that are to be included in a watermark search.

**Returns:**
int - The objects inside a PowerPoint document that are to be included in a watermark search.
##### setPresentationSearchableObjects(int value)
```
public final void setPresentationSearchableObjects(int value)
```

Sets the objects inside a PowerPoint document that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside a PowerPoint document that are to be included in a watermark search. |

##### getWordProcessingSearchableObjects()
```
public final int getWordProcessingSearchableObjects()
```

Gets the objects inside a Word document that are to be included in a watermark search.

**Returns:**
int - The objects inside a Word document that are to be included in a watermark search.
##### setWordProcessingSearchableObjects(int value)
```
public final void setWordProcessingSearchableObjects(int value)
```

Sets the objects inside a Word document that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside a Word document that are to be included in a watermark search. |

##### getPdfSearchableObjects()
```
public final int getPdfSearchableObjects()
```

Gets the objects inside a PDF document that are to be included in a watermark search.

**Returns:**
int - The objects inside a PDF document that are to be included in a watermark search.
##### setPdfSearchableObjects(int value)
```
public final void setPdfSearchableObjects(int value)
```

Sets the objects inside a PDF document that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside a PDF document that are to be included in a watermark search. |

##### getEmailSearchableObjects()
```
public final int getEmailSearchableObjects()
```

Gets the objects inside an email message that are to be included in a watermark search.

**Returns:**
int - The objects inside an email message that are to be included in a watermark search.
##### setEmailSearchableObjects(int value)
```
public final void setEmailSearchableObjects(int value)
```

Sets the objects inside an email message that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The objects inside an email message that are to be included in a watermark search. |

### SearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/searchcriteria.md

**Inheritance:**
java.lang.Object
```
public abstract class SearchCriteria
```

Class that can be used to construct criteria when searching for watermarks.
#### Methods

| Method | Description |
| --- | --- |
| and(SearchCriteria other) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| or(SearchCriteria other) | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| not() | Negates this `SearchCriteria`. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### and(SearchCriteria other)
```
public final SearchCriteria and(SearchCriteria other)
```

Combines this `SearchCriteria` with other criteria using logical AND operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchCriteria | Search criteria to combine with. |

**Returns:**
SearchCriteria - Combined search criteria.
##### or(SearchCriteria other)
```
public final SearchCriteria or(SearchCriteria other)
```

Combines this `SearchCriteria` with other criteria using logical OR operator.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchCriteria | Search criteria to combine with. |

**Returns:**
SearchCriteria - Combined search criteria.
##### not()
```
public final SearchCriteria not()
```

Negates this `SearchCriteria`.

**Returns:**
SearchCriteria - Combined search criteria.
##### isSatisfiedBy(PossibleWatermark candidate)
```
public abstract boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public abstract void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### ShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/shapepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark
```
public abstract class ShapePossibleWatermark<T> extends TwoDObjectPossibleWatermark
```

Represents shape watermark in a content of any supported format.

 T : The type of the shape.
#### Methods

| Method | Description |
| --- | --- |
| getRotateAngle() | Gets the rotate angle of the shape in degrees. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of the shape. |
| getText() | Gets the text of the shape. |
| setText(String value) | Sets the text of the shape. |
| getImageInternally() |  |
| remove() |  |
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of the shape in degrees.

**Returns:**
double - The rotate angle of the shape in degrees.
##### getFormattedTextFragments()
```
public FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of the shape.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of shape.
##### getText()
```
public String getText()
```

Gets the text of the shape.

**Returns:**
java.lang.String - The text of the shape.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of the shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of the shape. |

##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### ShapeSearchAdapter
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/shapesearchadapter.md

**Inheritance:**
java.lang.Object
```
public abstract class ShapeSearchAdapter
```

Provides base class for a shape containing specific pieces of document that are to be included in watermark search.
#### Methods

| Method | Description |
| --- | --- |
| getPageNumber() |  |
| getImageForSearch() |  |
| getFormattedTextFragmentsForSearch() |  |
| getTextForSearch() |  |
| setFoundWatermarkText(String value) |  |
| setFoundWatermarkImage(byte[] imageData) |  |
##### getPageNumber()
```
public Integer getPageNumber()
```

**Returns:**
java.lang.Integer
##### getImageForSearch()
```
public WatermarkableImage getImageForSearch()
```

**Returns:**
WatermarkableImage
##### getFormattedTextFragmentsForSearch()
```
public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()
```

**Returns:**
FormattedTextFragmentCollection
##### getTextForSearch()
```
public String getTextForSearch()
```

**Returns:**
java.lang.String
##### setFoundWatermarkText(String value)
```
public void setFoundWatermarkText(String value)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String |  |

##### setFoundWatermarkImage(byte[] imageData)
```
public void setFoundWatermarkImage(byte[] imageData)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| imageData | byte[] |  |

### SizeSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/sizesearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public class SizeSearchCriteria extends SearchCriteria
```

Represents criteria allowing filtering by watermark size.

**Learn more:**

 *  [Searching watermarks][]

The following example demonstrates how to find and remove watermarks using search criteria.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("C:\\test.some_ext");
>    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
>    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
>    TextSearchCriteria textCriteria = new TextSearchCriteria(Pattern.compile("^Test watermark$"));
>
>    PossibleWatermarkCollection watermarks = watermarker.search(textCriteria.and(widthRange.or(rotateAngle)));
>    watermarks.clear();
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| SizeSearchCriteria(int dimension, double min, double max) | Initializes a new instance of the `SizeSearchCriteria` class with a specified dimension, a starting value and an ending value. |
#### Methods

| Method | Description |
| --- | --- |
| getMinimum() | Gets the starting value. |
| getMaximum() | Gets the ending value. |
| getDimension() | Gets the dimension of watermark to search by. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### SizeSearchCriteria(int dimension, double min, double max)
```
public SizeSearchCriteria(int dimension, double min, double max)
```

Initializes a new instance of the `SizeSearchCriteria` class with a specified dimension, a starting value and an ending value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| dimension | int | The dimension `Dimension` of a watermark to search by. |
| min | double | The starting value. |
| max | double | The ending value. |

##### getMinimum()
```
public final double getMinimum()
```

Gets the starting value.

**Returns:**
double - The starting value.
##### getMaximum()
```
public final double getMaximum()
```

Gets the ending value.

**Returns:**
double - The ending value.
##### getDimension()
```
public final int getDimension()
```

Gets the dimension of watermark to search by.

**Returns:**
int - The dimension of watermark to search by.
##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### SpreadsheetAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetattachedimagepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark, com.groupdocs.watermark.search.FloatingAttachedImagePossibleWatermark
```
public class SpreadsheetAttachedImagePossibleWatermark extends FloatingAttachedImagePossibleWatermark<SpreadsheetAttachment>
```

Represents possible image watermark in Excel document attachment.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment) |  |
##### SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment)
```
public SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheet | SpreadsheetWorksheet |  |
| attachment | SpreadsheetAttachment |  |

### SpreadsheetBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class SpreadsheetBackgroundPossibleWatermark extends PossibleWatermark
```

Represents possible background watermark in an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetBackgroundPossibleWatermark`. |
| getWidth() | Gets the width of this `SpreadsheetBackgroundPossibleWatermark` in pixels. |
| getHeight() | Gets the height of this `SpreadsheetBackgroundPossibleWatermark` in pixels. |
| getX() | Gets the horizontal offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet left border in pixels. |
| getY() | Gets the vertical offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet top border in pixels. |
| getRotateAngle() | Gets the rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `SpreadsheetBackgroundPossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet)
```
public SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheet | SpreadsheetWorksheet |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetBackgroundPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetBackgroundPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

**Returns:**
double - The width of this `SpreadsheetBackgroundPossibleWatermark` in pixels.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

**Returns:**
double - The height of this `SpreadsheetBackgroundPossibleWatermark` in pixels.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet left border in pixels.

**Returns:**
double - The x-coordinate of this `SpreadsheetBackgroundPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet top border in pixels.

**Returns:**
double - The y-coordinate of this `SpreadsheetBackgroundPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `SpreadsheetBackgroundPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `SpreadsheetBackgroundPossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### SpreadsheetCellPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetcellpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class SpreadsheetCellPossibleWatermark extends PossibleWatermark
```

Represents possible cell watermark in an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetCellPossibleWatermark(Cell cell, SpreadsheetWorksheet parent) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetCellPossibleWatermark`. |
| getWidth() | Gets the width of this `SpreadsheetCellPossibleWatermark` in points. |
| getHeight() | Gets the height of this `SpreadsheetCellPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `SpreadsheetCellPossibleWatermark` from content left border in points. |
| getY() | Gets the vertical offset of this `SpreadsheetCellPossibleWatermark` from content top border in points. |
| getRotateAngle() | Gets the rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees. |
| getText() | Gets the text of this `SpreadsheetCellPossibleWatermark`. |
| setText(String value) | Sets the text of this `SpreadsheetCellPossibleWatermark`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `SpreadsheetCellPossibleWatermark`. |
| remove() |  |
##### SpreadsheetCellPossibleWatermark(Cell cell, SpreadsheetWorksheet parent)
```
public SpreadsheetCellPossibleWatermark(Cell cell, SpreadsheetWorksheet parent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cell | com.aspose.cells.Cell |  |
| parent | SpreadsheetWorksheet |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetCellPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetCellPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `SpreadsheetCellPossibleWatermark` in points.

**Returns:**
double - The width of this `SpreadsheetCellPossibleWatermark` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `SpreadsheetCellPossibleWatermark` in points.

**Returns:**
double - The height of this `SpreadsheetCellPossibleWatermark` in points.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `SpreadsheetCellPossibleWatermark` from content left border in points.

**Returns:**
double - The x-coordinate of this `SpreadsheetCellPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `SpreadsheetCellPossibleWatermark` from content top border in points.

**Returns:**
double - The y-coordinate of this `SpreadsheetCellPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees.
##### getText()
```
public String getText()
```

Gets the text of this `SpreadsheetCellPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `SpreadsheetCellPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `SpreadsheetCellPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `SpreadsheetCellPossibleWatermark`. |

##### getFormattedTextFragments()
```
public FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `SpreadsheetCellPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `SpreadsheetCellPossibleWatermark`.
##### remove()
```
public void remove()
```

### SpreadsheetChartBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetchartbackgroundpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark
```
public class SpreadsheetChartBackgroundPossibleWatermark extends TwoDObjectPossibleWatermark
```

Represents possible image watermark in Excel chart background.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetChartBackgroundPossibleWatermark(SpreadsheetChart chart) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetChartBackgroundPossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `SpreadsheetChartBackgroundPossibleWatermark` in degrees. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `SpreadsheetChartBackgroundPossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### SpreadsheetChartBackgroundPossibleWatermark(SpreadsheetChart chart)
```
public SpreadsheetChartBackgroundPossibleWatermark(SpreadsheetChart chart)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| chart | SpreadsheetChart |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetChartBackgroundPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetChartBackgroundPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `SpreadsheetChartBackgroundPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `SpreadsheetChartBackgroundPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `SpreadsheetChartBackgroundPossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### SpreadsheetHeaderFooterPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetheaderfooterpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class SpreadsheetHeaderFooterPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in a header or footer of an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetHeaderFooterPossibleWatermark(SpreadsheetHeaderFooterSection section) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| getWidth() | Gets the width of this `SpreadsheetHeaderFooterPossibleWatermark` in points. |
| getHeight() | Gets the height of this `SpreadsheetHeaderFooterPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet left border in points. |
| getY() | Gets the vertical offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet top border in points. |
| getRotateAngle() | Gets the rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees. |
| getText() | Gets the text of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| setText(String value) | Sets the text of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| getImageInternally() |  |
| remove() |  |
##### SpreadsheetHeaderFooterPossibleWatermark(SpreadsheetHeaderFooterSection section)
```
public SpreadsheetHeaderFooterPossibleWatermark(SpreadsheetHeaderFooterSection section)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| section | SpreadsheetHeaderFooterSection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetHeaderFooterPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetHeaderFooterPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

**Returns:**
double - The width of this `SpreadsheetHeaderFooterPossibleWatermark` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

**Returns:**
double - The height of this `SpreadsheetHeaderFooterPossibleWatermark` in points.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet left border in points.

**Returns:**
double - The x-coordinate of this `SpreadsheetHeaderFooterPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet top border in points.

**Returns:**
double - The y-coordinate of this `SpreadsheetHeaderFooterPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees.
##### getText()
```
public String getText()
```

Gets the text of this `SpreadsheetHeaderFooterPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `SpreadsheetHeaderFooterPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `SpreadsheetHeaderFooterPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `SpreadsheetHeaderFooterPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `SpreadsheetHeaderFooterPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `SpreadsheetHeaderFooterPossibleWatermark`.
##### getImageInternally()
```
public WatermarkableImage getImageInternally()
```

**Returns:**
WatermarkableImage
##### remove()
```
public void remove()
```

### SpreadsheetHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheethyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark
```
public class SpreadsheetHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark
```

Represents possible hyperlink watermark in an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetHyperlinkPossibleWatermark(SpreadsheetWorksheet worksheet, Hyperlink hyperlink) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetHyperlinkPossibleWatermark`. |
| getWidth() | Gets the width of this `SpreadsheetHyperlinkPossibleWatermark` in points. |
| getHeight() | Gets the height of this `SpreadsheetHyperlinkPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet left border in points. |
| getY() | Gets the vertical offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet top border in points. |
| getRotateAngle() | Gets the rotate angle of this `SpreadsheetHyperlinkPossibleWatermark` in degrees. |
| getText() | Gets the url of this `SpreadsheetHyperlinkPossibleWatermark`. |
| setText(String value) | Sets the url of this `SpreadsheetHyperlinkPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `SpreadsheetHyperlinkPossibleWatermark`. |
| remove() |  |
##### SpreadsheetHyperlinkPossibleWatermark(SpreadsheetWorksheet worksheet, Hyperlink hyperlink)
```
public SpreadsheetHyperlinkPossibleWatermark(SpreadsheetWorksheet worksheet, Hyperlink hyperlink)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| worksheet | SpreadsheetWorksheet |  |
| hyperlink | com.aspose.cells.Hyperlink |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetHyperlinkPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetHyperlinkPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `SpreadsheetHyperlinkPossibleWatermark` in points.

**Returns:**
double - The width of this `SpreadsheetHyperlinkPossibleWatermark` in points.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `SpreadsheetHyperlinkPossibleWatermark` in points.

**Returns:**
double - The height of this `SpreadsheetHyperlinkPossibleWatermark` in points.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet left border in points.

**Returns:**
double - The x-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet top border in points.

**Returns:**
double - The y-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `SpreadsheetHyperlinkPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getText()
```
public String getText()
```

Gets the url of this `SpreadsheetHyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `SpreadsheetHyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `SpreadsheetHyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The url of this `SpreadsheetHyperlinkPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `SpreadsheetHyperlinkPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `SpreadsheetHyperlinkPossibleWatermark`.
##### remove()
```
public void remove()
```

### SpreadsheetSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class SpreadsheetSearchableObjects
```

Specifies flags representing Excel content objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| Shapes | Search in shapes. |
| ChartsBackgrounds | Search in charts backgrounds. |
| HeadersFooters | Search in headers and footers. |
| WorksheetBackgrounds | Search in worksheets backgrounds. |
| Cells | Search in cells. |
| Hyperlinks | Search in hyperlinks. |
| AttachedImages | Search in attached images. |
| All | Search in all content objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `SpreadsheetSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### Shapes
```
public static final int Shapes
```

Search in shapes.

##### ChartsBackgrounds
```
public static final int ChartsBackgrounds
```

Search in charts backgrounds.

##### HeadersFooters
```
public static final int HeadersFooters
```

Search in headers and footers.

##### WorksheetBackgrounds
```
public static final int WorksheetBackgrounds
```

Search in worksheets backgrounds.

##### Cells
```
public static final int Cells
```

Search in cells.

##### Hyperlinks
```
public static final int Hyperlinks
```

Search in hyperlinks.

##### AttachedImages
```
public static final int AttachedImages
```

Search in attached images.

##### All
```
public static final int All
```

Search in all content objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `SpreadsheetSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `SpreadsheetSearchableObjects` enumeration.

### SpreadsheetShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/spreadsheetshapepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class SpreadsheetShapePossibleWatermark extends ShapePossibleWatermark<SpreadsheetShape>
```

Represents possible shape watermark in an Excel document.
#### Constructors

| Constructor | Description |
| --- | --- |
| SpreadsheetShapePossibleWatermark(SpreadsheetShape shape, SpreadsheetShapeCollection shapeCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `SpreadsheetShapePossibleWatermark`. |
##### SpreadsheetShapePossibleWatermark(SpreadsheetShape shape, SpreadsheetShapeCollection shapeCollection)
```
public SpreadsheetShapePossibleWatermark(SpreadsheetShape shape, SpreadsheetShapeCollection shapeCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | SpreadsheetShape |  |
| shapeCollection | SpreadsheetShapeCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `SpreadsheetShapePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `SpreadsheetShapePossibleWatermark`.

### TextFormattingSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/textformattingsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria
```
public class TextFormattingSearchCriteria extends SearchCriteria
```

Represents criteria allowing filtering by text formatting.

**Learn more:**

 *  [Searching watermarks][]

The following example demonstrates how to remove possible watermarks with a particular text formatting (regardless of document type).

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\test.doc");
>    TextFormattingSearchCriteria criteria = new TextFormattingSearchCriteria();
>
>    criteria.setForegroundColorRange(new ColorRange());
>    criteria.getForegroundColorRange().setMinHue(-5);
>    criteria.getForegroundColorRange().setMaxHue(10);
>    criteria.getForegroundColorRange().setMinBrightness(0.01f);
>    criteria.getForegroundColorRange().setMaxBrightness(0.99f);
>    criteria.setBackgroundColorRange(new ColorRange());
>    criteria.getBackgroundColorRange().setEmpty(true);
>    criteria.setFontName("Arial");
>    criteria.setMinFontSize(19);
>    criteria.setMaxFontSize(42);
>    criteria.setFontBold(true);
>
>    PossibleWatermarkCollection watermarks = watermarker.search(criteria);
>    watermarks.clear();
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| TextFormattingSearchCriteria() | Initializes a new instance of the `TextFormattingSearchCriteria` class. |
#### Methods

| Method | Description |
| --- | --- |
| getForegroundColorRange() | Gets the range of colors which are used to filter watermarks by text foreground color. |
| setForegroundColorRange(ColorRange value) | Sets the range of colors which are used to filter watermarks by text foreground color. |
| getBackgroundColorRange() | Gets the range of colors which are used to filter watermarks by text background color. |
| setBackgroundColorRange(ColorRange value) | Sets the range of colors which are used to filter watermarks by text background color. |
| getFontName() | Gets the name of the font which is used in possible watermark text formatting. |
| setFontName(String value) | Sets the name of the font which is used in possible watermark text formatting. |
| getMinFontSize() | Gets the starting value of the font size. |
| setMinFontSize(float value) | Sets the starting value of the font size. |
| getMaxFontSize() | Gets the ending value of the font size. |
| setMaxFontSize(float value) | Sets the ending value of the font size. |
| getFontBold() | Gets a value indicating whether the font used in watermark text formatting is bold. |
| setFontBold(Boolean value) | Sets a value indicating whether the font used in watermark text formatting is bold. |
| getFontItalic() | Gets a value indicating whether the font used in watermark text formatting is italic. |
| setFontItalic(Boolean value) | Sets a value indicating whether the font used in watermark text formatting is italic. |
| getFontUnderline() | Gets a value indicating whether the font used in watermark text formatting is underline. |
| setFontUnderline(Boolean value) | Sets a value indicating whether the font used in watermark text formatting is underline. |
| getFontStrikeout() | Gets a value indicating whether the font used in watermark text formatting is strikeout. |
| setFontStrikeout(Boolean value) | Sets a value indicating whether the font used in watermark text formatting is strikeout. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### TextFormattingSearchCriteria()
```
public TextFormattingSearchCriteria()
```

Initializes a new instance of the `TextFormattingSearchCriteria` class.

##### getForegroundColorRange()
```
public final ColorRange getForegroundColorRange()
```

Gets the range of colors which are used to filter watermarks by text foreground color.

**Returns:**
ColorRange - The range of colors which are used to filter watermarks by text foreground color.
##### setForegroundColorRange(ColorRange value)
```
public final void setForegroundColorRange(ColorRange value)
```

Sets the range of colors which are used to filter watermarks by text foreground color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ColorRange | The range of colors which are used to filter watermarks by text foreground color. |

##### getBackgroundColorRange()
```
public final ColorRange getBackgroundColorRange()
```

Gets the range of colors which are used to filter watermarks by text background color.

**Returns:**
ColorRange - The range of colors which are used to filter watermarks by text background color.
##### setBackgroundColorRange(ColorRange value)
```
public final void setBackgroundColorRange(ColorRange value)
```

Sets the range of colors which are used to filter watermarks by text background color.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ColorRange | The range of colors which are used to filter watermarks by text background color. |

##### getFontName()
```
public final String getFontName()
```

Gets the name of the font which is used in possible watermark text formatting.

**Returns:**
java.lang.String - The default value is null, which means that the filter is not applied.
##### setFontName(String value)
```
public final void setFontName(String value)
```

Sets the name of the font which is used in possible watermark text formatting.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The default value is null, which means that the filter is not applied. |

##### getMinFontSize()
```
public final float getMinFontSize()
```

Gets the starting value of the font size.

**Returns:**
float - The starting value of the font size.
##### setMinFontSize(float value)
```
public final void setMinFontSize(float value)
```

Sets the starting value of the font size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The starting value of the font size. |

##### getMaxFontSize()
```
public final float getMaxFontSize()
```

Gets the ending value of the font size.

**Returns:**
float - The ending value of the font size.
##### setMaxFontSize(float value)
```
public final void setMaxFontSize(float value)
```

Sets the ending value of the font size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | float | The ending value of the font size. |

##### getFontBold()
```
public final Boolean getFontBold()
```

Gets a value indicating whether the font used in watermark text formatting is bold.

**Returns:**
java.lang.Boolean - The default value is null, which means that the filter is not applied.
##### setFontBold(Boolean value)
```
public final void setFontBold(Boolean value)
```

Sets a value indicating whether the font used in watermark text formatting is bold.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | The default value is null, which means that the filter is not applied. |

##### getFontItalic()
```
public final Boolean getFontItalic()
```

Gets a value indicating whether the font used in watermark text formatting is italic.

**Returns:**
java.lang.Boolean - The default value is null, which means that the filter is not applied.
##### setFontItalic(Boolean value)
```
public final void setFontItalic(Boolean value)
```

Sets a value indicating whether the font used in watermark text formatting is italic.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | The default value is null, which means that the filter is not applied. |

##### getFontUnderline()
```
public final Boolean getFontUnderline()
```

Gets a value indicating whether the font used in watermark text formatting is underline.

**Returns:**
java.lang.Boolean - The default value is null, which means that the filter is not applied.
##### setFontUnderline(Boolean value)
```
public final void setFontUnderline(Boolean value)
```

Sets a value indicating whether the font used in watermark text formatting is underline.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | The default value is null, which means that the filter is not applied. |

##### getFontStrikeout()
```
public final Boolean getFontStrikeout()
```

Gets a value indicating whether the font used in watermark text formatting is strikeout.

**Returns:**
java.lang.Boolean - The default value is null, which means that the filter is not applied.
##### setFontStrikeout(Boolean value)
```
public final void setFontStrikeout(Boolean value)
```

Sets a value indicating whether the font used in watermark text formatting is strikeout.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.Boolean | The default value is null, which means that the filter is not applied. |

##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### TextSearchCriteria
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/textsearchcriteria.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria
```
public class TextSearchCriteria extends PageSearchCriteria
```

Represents criteria allowing filtering by watermark text.

**Learn more:**

 *  [Searching watermarks][]

The following example demonstrates how to find and remove watermark using search criteria.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("C:\\test.some_ext");
>    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
>    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
>    TextSearchCriteria textCriteria = new TextSearchCriteria(Pattern.compile("^Test watermark$"));
>
>    PossibleWatermarkCollection watermarks = watermarker.search(textCriteria.and(widthRange.or(rotateAngle)));
>    watermarks.clear();
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| TextSearchCriteria(Pattern pattern) | Initializes a new instance of the `TextSearchCriteria` class with a specified regular expression. |
| TextSearchCriteria(System.Text.RegularExpressions.Regex pattern) |  |
| TextSearchCriteria(String searchString, boolean isMatchCase) | Initializes a new instance of the `TextSearchCriteria` class with a search string and a flag for comparison. |
| TextSearchCriteria(String searchString) | Initializes a new instance of the `TextSearchCriteria` class with a search string. |
#### Methods

| Method | Description |
| --- | --- |
| getPattern() | Gets the search pattern. |
| getPatternInternal() |  |
| getSkipUnreadableCharacters() | Gets a value indicating that unreadable characters will be skipped during string comparison. |
| setSkipUnreadableCharacters(boolean value) | Sets a value indicating that unreadable characters will be skipped during string comparison. |
| isSatisfiedBy(PossibleWatermark candidate) |  |
| accept(ICriteriaVisitor visitor) |  |
##### TextSearchCriteria(Pattern pattern)
```
public TextSearchCriteria(Pattern pattern)
```

Initializes a new instance of the `TextSearchCriteria` class with a specified regular expression.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | java.util.regex.Pattern | The regular expression to match. |

##### TextSearchCriteria(System.Text.RegularExpressions.Regex pattern)
```
public TextSearchCriteria(System.Text.RegularExpressions.Regex pattern)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | com.aspose.ms.System.Text.RegularExpressions.Regex |  |

##### TextSearchCriteria(String searchString, boolean isMatchCase)
```
public TextSearchCriteria(String searchString, boolean isMatchCase)
```

Initializes a new instance of the `TextSearchCriteria` class with a search string and a flag for comparison.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchString | java.lang.String | The exact string to search for. |
| isMatchCase | boolean | `false` to ignore case during the comparison; otherwise, `true`. |

##### TextSearchCriteria(String searchString)
```
public TextSearchCriteria(String searchString)
```

Initializes a new instance of the `TextSearchCriteria` class with a search string.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchString | java.lang.String | The exact string to search for. |

##### getPattern()
```
public final Pattern getPattern()
```

Gets the search pattern.

**Returns:**
java.util.regex.Pattern - The regular expression pattern to match.
##### getPatternInternal()
```
public final System.Text.RegularExpressions.Regex getPatternInternal()
```

**Returns:**
com.aspose.ms.System.Text.RegularExpressions.Regex
##### getSkipUnreadableCharacters()
```
public final boolean getSkipUnreadableCharacters()
```

Gets a value indicating that unreadable characters will be skipped during string comparison.

**Returns:**
boolean - A value indicating that unreadable characters will be skipped during string comparison.
##### setSkipUnreadableCharacters(boolean value)
```
public final void setSkipUnreadableCharacters(boolean value)
```

Sets a value indicating that unreadable characters will be skipped during string comparison.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | A value indicating that unreadable characters will be skipped during string comparison. |

##### isSatisfiedBy(PossibleWatermark candidate)
```
public boolean isSatisfiedBy(PossibleWatermark candidate)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| candidate | PossibleWatermark |  |

**Returns:**
boolean
##### accept(ICriteriaVisitor visitor)
```
public void accept(ICriteriaVisitor visitor)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| visitor | ICriteriaVisitor |  |

### TwoDObjectPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/twodobjectpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public abstract class TwoDObjectPossibleWatermark extends PossibleWatermark
```

Represents 2D object watermark in a content of any supported format.
#### Methods

| Method | Description |
| --- | --- |
| getWidth() | Gets the width of the 2D object. |
| getHeight() | Gets the height of the 2D object. |
| getX() | Gets the x-coordinate of the 2D object. |
| getY() | Gets the y-coordinate of the 2D object. |
| getRotateAngle() | Gets the rotate angle of the 2D object in degrees. |
| getUnitOfMeasurement() | Gets the unit of measurement `UnitOfMeasurement` of the 2D object. |
##### getWidth()
```
public double getWidth()
```

Gets the width of the 2D object.

**Returns:**
double - The width of the 2D object.
##### getHeight()
```
public double getHeight()
```

Gets the height of the 2D object.

**Returns:**
double - The height of the 2D object.
##### getX()
```
public double getX()
```

Gets the x-coordinate of the 2D object.

**Returns:**
double - The x-coordinate of the 2D object.
##### getY()
```
public double getY()
```

Gets the y-coordinate of the 2D object.

**Returns:**
double - The y-coordinate of the 2D object.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of the 2D object in degrees.

**Returns:**
double - The rotate angle of the 2D object in degrees.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the unit of measurement `UnitOfMeasurement` of the 2D object.

**Returns:**
int - The unit of measurement `UnitOfMeasurement` of the 2D object.

### WordProcessingSearchableObjects
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/wordprocessingsearchableobjects.md

**Inheritance:**
java.lang.Object
```
public final class WordProcessingSearchableObjects
```

Specifies flags representing Word content objects that are to be included in a watermark search.
#### Fields

| Field | Description |
| --- | --- |
| None | Specifies no search objects. |
| Shapes | Search in shapes. |
| Text | Search in content text. |
| Hyperlinks | Search in hyperlinks. |
| All | Search in all content objects. |
#### Methods

| Method | Description |
| --- | --- |
| getValues() | Gets an array of all values of `WordProcessingSearchableObjects` enumeration. |
##### None
```
public static final int None
```

Specifies no search objects.

##### Shapes
```
public static final int Shapes
```

Search in shapes.

##### Text
```
public static final int Text
```

Search in content text.

##### Hyperlinks
```
public static final int Hyperlinks
```

Search in hyperlinks.

##### All
```
public static final int All
```

Search in all content objects.

##### getValues()
```
public static final int[] getValues()
```

Gets an array of all values of `WordProcessingSearchableObjects` enumeration.

**Returns:**
int[] - The array of all values of `WordProcessingSearchableObjects` enumeration.

### WordProcessingShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/wordprocessingshapepossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark
```
public class WordProcessingShapePossibleWatermark extends ShapePossibleWatermark<WordProcessingShape>
```

Represents possible shape watermark in a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingShapePossibleWatermark(WordProcessingShape shape, WordProcessingShapeCollection shapeCollection) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `WordProcessingShapePossibleWatermark`. |
| getShape() |  |
##### WordProcessingShapePossibleWatermark(WordProcessingShape shape, WordProcessingShapeCollection shapeCollection)
```
public WordProcessingShapePossibleWatermark(WordProcessingShape shape, WordProcessingShapeCollection shapeCollection)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| shape | WordProcessingShape |  |
| shapeCollection | WordProcessingShapeCollection |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `WordProcessingShapePossibleWatermark`.

**Returns:**
ContentPart - The parent of this `WordProcessingShapePossibleWatermark`.
##### getShape()
```
public final WordProcessingShape getShape()
```

**Returns:**
WordProcessingShape

### WordProcessingTextHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/wordprocessingtexthyperlinkpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark
```
public class WordProcessingTextHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark
```

Represents possible hyperlink watermark in a Word document.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingTextHyperlinkPossibleWatermark(ContentPart parent, FieldHyperlink fieldHyperlink) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getWidth() | Gets the width of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getHeight() | Gets the height of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getX() | Gets the x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getY() | Gets the y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getRotateAngle() | Gets the rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees. |
| getText() | Gets the url of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| setText(String value) | Sets the url of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| remove() |  |
##### WordProcessingTextHyperlinkPossibleWatermark(ContentPart parent, FieldHyperlink fieldHyperlink)
```
public WordProcessingTextHyperlinkPossibleWatermark(ContentPart parent, FieldHyperlink fieldHyperlink)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | ContentPart |  |
| fieldHyperlink | com.aspose.words.FieldHyperlink |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
double - The width of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
double - The height of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getX()
```
public double getX()
```

Gets the x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
double - The x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getY()
```
public double getY()
```

Gets the y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
double - The y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees.

**Returns:**
double - The rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### getText()
```
public String getText()
```

Gets the url of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
java.lang.String - The url of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the url of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The url of this `WordProcessingTextHyperlinkPossibleWatermark`. |

##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `WordProcessingTextHyperlinkPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `WordProcessingTextHyperlinkPossibleWatermark`.
##### remove()
```
public void remove()
```

### WordProcessingTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.search/wordprocessingtextpossiblewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark
```
public class WordProcessingTextPossibleWatermark extends PossibleWatermark
```

Represents possible watermark in a Word document text.
#### Constructors

| Constructor | Description |
| --- | --- |
| WordProcessingTextPossibleWatermark(ContentPart parent, ReplacingArgs replacingArgs) |  |
#### Methods

| Method | Description |
| --- | --- |
| getParent() | Gets the parent of this `WordProcessingTextPossibleWatermark`. |
| getWidth() | Gets the width of this `WordProcessingTextPossibleWatermark`> in points. |
| getHeight() | Gets the height of this `WordProcessingTextPossibleWatermark` in points. |
| getX() | Gets the horizontal offset of this `WordProcessingTextPossibleWatermark` from document left border in points. |
| getY() | Gets the vertical offset of this `WordProcessingTextPossibleWatermark` from document top border in points. |
| getRotateAngle() | Gets the rotate angle of this `WordProcessingTextPossibleWatermark` in degrees. |
| getText() | Gets the text of this `WordProcessingTextPossibleWatermark`. |
| setText(String value) | Sets the text of this `WordProcessingTextPossibleWatermark`. |
| getFormattedTextFragments() | Gets the collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`. |
| getUnitOfMeasurement() | Gets the `UnitOfMeasurement` of this `WordProcessingTextPossibleWatermark`. |
| remove() |  |
##### WordProcessingTextPossibleWatermark(ContentPart parent, ReplacingArgs replacingArgs)
```
public WordProcessingTextPossibleWatermark(ContentPart parent, ReplacingArgs replacingArgs)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | ContentPart |  |
| replacingArgs | com.aspose.words.ReplacingArgs |  |

##### getParent()
```
public ContentPart getParent()
```

Gets the parent of this `WordProcessingTextPossibleWatermark`.

**Returns:**
ContentPart - The parent of this `WordProcessingTextPossibleWatermark`.
##### getWidth()
```
public double getWidth()
```

Gets the width of this `WordProcessingTextPossibleWatermark`> in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getHeight()
```
public double getHeight()
```

Gets the height of this `WordProcessingTextPossibleWatermark` in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getX()
```
public double getX()
```

Gets the horizontal offset of this `WordProcessingTextPossibleWatermark` from document left border in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getY()
```
public double getY()
```

Gets the vertical offset of this `WordProcessingTextPossibleWatermark` from document top border in points.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getRotateAngle()
```
public double getRotateAngle()
```

Gets the rotate angle of this `WordProcessingTextPossibleWatermark` in degrees.

**Returns:**
double - The value is always 0 for this type of possible watermark.
##### getText()
```
public String getText()
```

Gets the text of this `WordProcessingTextPossibleWatermark`.

**Returns:**
java.lang.String - The text of this `WordProcessingTextPossibleWatermark`.
##### setText(String value)
```
public void setText(String value)
```

Sets the text of this `WordProcessingTextPossibleWatermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The text of this `WordProcessingTextPossibleWatermark`. |

##### getFormattedTextFragments()
```
public FormattedTextFragmentCollection getFormattedTextFragments()
```

Gets the collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`.

**Returns:**
FormattedTextFragmentCollection - The collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`.
##### getUnitOfMeasurement()
```
public int getUnitOfMeasurement()
```

Gets the `UnitOfMeasurement` of this `WordProcessingTextPossibleWatermark`.

**Returns:**
int - The `UnitOfMeasurement` of this `WordProcessingTextPossibleWatermark`.
##### remove()
```
public void remove()
```

### com.groupdocs.watermark.watermarks
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks.md

#### Classes

| Class | Description |
| --- | --- |
| Color | Structure representing a color. |
| Font | Class representing a font. |
| FontStyle | Represents a font style. |
| ImageWatermark | Represents an image watermark. |
| MarginType | Specifies how margin values should be interpreted. |
| Margins | Represents margin settings for each edge of an object. |
| SizingType | Specifies how watermark size should be calculated. |
| TextAlignment | Enumeration of possible text alignment values. |
| TextWatermark | Represents a text watermark. |

### Color
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/color.md

**Inheritance:**
java.lang.Object
```
public class Color
```

Structure representing a color.
#### Constructors

| Constructor | Description |
| --- | --- |
| Color() |  |
#### Methods

| Method | Description |
| --- | --- |
| getEmpty() | Gets a system-defined color. |
| getTransparent() | Gets a system-defined color. |
| getAliceBlue() | Gets a system-defined color. |
| getAntiqueWhite() | Gets a system-defined color. |
| getAqua() | Gets a system-defined color. |
| getAquamarine() | Gets a system-defined color. |
| getAzure() | Gets a system-defined color. |
| getBeige() | Gets a system-defined color. |
| getBisque() | Gets a system-defined color. |
| getBlack() | Gets a system-defined color. |
| getBlanchedAlmond() | Gets a system-defined color. |
| getBlue() | Gets a system-defined color. |
| getBlueViolet() | Gets a system-defined color. |
| getBrown() | Gets a system-defined color. |
| getBurlyWood() | Gets a system-defined color. |
| getCadetBlue() | Gets a system-defined color. |
| getChartreuse() | Gets a system-defined color. |
| getChocolate() | Gets a system-defined color. |
| getCoral() | Gets a system-defined color. |
| getCornflowerBlue() | Gets a system-defined color. |
| getCornsilk() | Gets a system-defined color. |
| getCrimson() | Gets a system-defined color. |
| getCyan() | Gets a system-defined color. |
| getDarkBlue() | Gets a system-defined color. |
| getDarkCyan() | Gets a system-defined color. |
| getDarkGoldenrod() | Gets a system-defined color. |
| getDarkGray() | Gets a system-defined color. |
| getDarkGreen() | Gets a system-defined color. |
| getDarkKhaki() | Gets a system-defined color. |
| getDarkMagenta() | Gets a system-defined color. |
| getDarkOliveGreen() | Gets a system-defined color. |
| getDarkOrange() | Gets a system-defined color. |
| getDarkOrchid() | Gets a system-defined color. |
| getDarkRed() | Gets a system-defined color. |
| getDarkSalmon() | Gets a system-defined color. |
| getDarkSeaGreen() | Gets a system-defined color. |
| getDarkSlateBlue() | Gets a system-defined color. |
| getDarkSlateGray() | Gets a system-defined color. |
| getDarkTurquoise() | Gets a system-defined color. |
| getDarkViolet() | Gets a system-defined color. |
| getDeepPink() | Gets a system-defined color. |
| getDeepSkyBlue() | Gets a system-defined color. |
| getDimGray() | Gets a system-defined color. |
| getDodgerBlue() | Gets a system-defined color. |
| getFirebrick() | Gets a system-defined color. |
| getFloralWhite() | Gets a system-defined color. |
| getForestGreen() | Gets a system-defined color. |
| getFuchsia() | Gets a system-defined color. |
| getGainsboro() | Gets a system-defined color. |
| getGhostWhite() | Gets a system-defined color. |
| getGold() | Gets a system-defined color. |
| getGoldenrod() | Gets a system-defined color. |
| getGray() | Gets a system-defined color. |
| getGreen() | Gets a system-defined color. |
| getGreenYellow() | Gets a system-defined color. |
| getHoneydew() | Gets a system-defined color. |
| getHotPink() | Gets a system-defined color. |
| getIndianRed() | Gets a system-defined color. |
| getIndigo() | Gets a system-defined color. |
| getIvory() | Gets a system-defined color. |
| getKhaki() | Gets a system-defined color. |
| getLavender() | Gets a system-defined color. |
| getLavenderBlush() | Gets a system-defined color. |
| getLawnGreen() | Gets a system-defined color. |
| getLemonChiffon() | Gets a system-defined color. |
| getLightBlue() | Gets a system-defined color. |
| getLightCoral() | Gets a system-defined color. |
| getLightCyan() | Gets a system-defined color. |
| getLightGoldenrodYellow() | Gets a system-defined color. |
| getLightGray() | Gets a system-defined color. |
| getLightGreen() | Gets a system-defined color. |
| getLightPink() | Gets a system-defined color. |
| getLightSalmon() | Gets a system-defined color. |
| getLightSeaGreen() | Gets a system-defined color. |
| getLightSkyBlue() | Gets a system-defined color. |
| getLightSlateGray() | Gets a system-defined color. |
| getLightSteelBlue() | Gets a system-defined color. |
| getLightYellow() | Gets a system-defined color. |
| getLime() | Gets a system-defined color. |
| getLimeGreen() | Gets a system-defined color. |
| getLinen() | Gets a system-defined color. |
| getMagenta() | Gets a system-defined color. |
| getMaroon() | Gets a system-defined color. |
| getMediumAquamarine() | Gets a system-defined color. |
| getMediumBlue() | Gets a system-defined color. |
| getMediumOrchid() | Gets a system-defined color. |
| getMediumPurple() | Gets a system-defined color. |
| getMediumSeaGreen() | Gets a system-defined color. |
| getMediumSlateBlue() | Gets a system-defined color. |
| getMediumSpringGreen() | Gets a system-defined color. |
| getMediumTurquoise() | Gets a system-defined color. |
| getMediumVioletRed() | Gets a system-defined color. |
| getMidnightBlue() | Gets a system-defined color. |
| getMintCream() | Gets a system-defined color. |
| getMistyRose() | Gets a system-defined color. |
| getMoccasin() | Gets a system-defined color. |
| getNavajoWhite() | Gets a system-defined color. |
| getNavy() | Gets a system-defined color. |
| getOldLace() | Gets a system-defined color. |
| getOlive() | Gets a system-defined color. |
| getOliveDrab() | Gets a system-defined color. |
| getOrange() | Gets a system-defined color. |
| getOrangeRed() | Gets a system-defined color. |
| getOrchid() | Gets a system-defined color. |
| getPaleGoldenrod() | Gets a system-defined color. |
| getPaleGreen() | Gets a system-defined color. |
| getPaleTurquoise() | Gets a system-defined color. |
| getPaleVioletRed() | Gets a system-defined color. |
| getPapayaWhip() | Gets a system-defined color. |
| getPeachPuff() | Gets a system-defined color. |
| getPeru() | Gets a system-defined color. |
| getPink() | Gets a system-defined color. |
| getPlum() | Gets a system-defined color. |
| getPowderBlue() | Gets a system-defined color. |
| getPurple() | Gets a system-defined color. |
| getRed() | Gets a system-defined color. |
| getRosyBrown() | Gets a system-defined color. |
| getRoyalBlue() | Gets a system-defined color. |
| getSaddleBrown() | Gets a system-defined color. |
| getSalmon() | Gets a system-defined color. |
| getSandyBrown() | Gets a system-defined color. |
| getSeaGreen() | Gets a system-defined color. |
| getSeaShell() | Gets a system-defined color. |
| getSienna() | Gets a system-defined color. |
| getSilver() | Gets a system-defined color. |
| getSkyBlue() | Gets a system-defined color. |
| getSlateBlue() | Gets a system-defined color. |
| getSlateGray() | Gets a system-defined color. |
| getSnow() | Gets a system-defined color. |
| getSpringGreen() | Gets a system-defined color. |
| getSteelBlue() | Gets a system-defined color. |
| getTan() | Gets a system-defined color. |
| getTeal() | Gets a system-defined color. |
| getThistle() | Gets a system-defined color. |
| getTomato() | Gets a system-defined color. |
| getTurquoise() | Gets a system-defined color. |
| getViolet() | Gets a system-defined color. |
| getWheat() | Gets a system-defined color. |
| getWhite() | Gets a system-defined color. |
| getWhiteSmoke() | Gets a system-defined color. |
| getYellow() | Gets a system-defined color. |
| getYellowGreen() | Gets a system-defined color. |
| getR() | Gets the red component value of the color. |
| getG() | Gets the green component value of the color. |
| getB() | Gets the blue component value of the color. |
| getA() | Gets the alpha component value of the color. |
| isEmpty() | Gets a value indicating whether this  Color  structure is uninitialized. |
| fromArgb(int argb) | Creates a `Color` structure from a 32-bit ARGB value. |
| fromArgb(int alpha, Color baseColor) | Creates a  Color  structure from the specified  Color  structure, but with the new specified alpha value. |
| fromArgb(int red, int green, int blue) | Creates a  Color  structure from the specified 8-bit color values (red, green, and blue) and the alpha value is implicitly 255 (fully opaque). |
| fromArgb(int alpha, int red, int green, int blue) | Creates a  Color  structure from the four ARGB component (alpha, red, green, and blue) values. |
| toArgb() | Gets the 32-bit ARGB value of this  Color  structure. |
| getHue() | Gets the hue-saturation-brightness (HSB) hue value, in degrees, for this  Color  structure. |
| getSaturation() | Gets the hue-saturation-brightness (HSB) saturation value for this  Color  structure. |
| getBrightness() | Gets the hue-saturation-brightness (HSB) brightness value for this  Color  structure. |
| equals(Color other) | Determines whether the specified  Color  structure is equivalent to this  Color  structure. |
| equals(Object obj) | Determines whether the specified object is a  Color > structure and is equivalent to this  Color  structure. |
| hashCode() | Gets a hash code for this  Color  structure. |
| CloneTo(Color that) |  |
| Clone() |  |
| clone() |  |
| equals(Color obj1, Color obj2) |  |
##### Color()
```
public Color()
```

##### getEmpty()
```
public static Color getEmpty()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getTransparent()
```
public static Color getTransparent()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getAliceBlue()
```
public static Color getAliceBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getAntiqueWhite()
```
public static Color getAntiqueWhite()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getAqua()
```
public static Color getAqua()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getAquamarine()
```
public static Color getAquamarine()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getAzure()
```
public static Color getAzure()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBeige()
```
public static Color getBeige()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBisque()
```
public static Color getBisque()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBlack()
```
public static Color getBlack()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBlanchedAlmond()
```
public static Color getBlanchedAlmond()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBlue()
```
public static Color getBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBlueViolet()
```
public static Color getBlueViolet()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBrown()
```
public static Color getBrown()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getBurlyWood()
```
public static Color getBurlyWood()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCadetBlue()
```
public static Color getCadetBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getChartreuse()
```
public static Color getChartreuse()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getChocolate()
```
public static Color getChocolate()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCoral()
```
public static Color getCoral()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCornflowerBlue()
```
public static Color getCornflowerBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCornsilk()
```
public static Color getCornsilk()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCrimson()
```
public static Color getCrimson()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getCyan()
```
public static Color getCyan()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkBlue()
```
public static Color getDarkBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkCyan()
```
public static Color getDarkCyan()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkGoldenrod()
```
public static Color getDarkGoldenrod()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkGray()
```
public static Color getDarkGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkGreen()
```
public static Color getDarkGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkKhaki()
```
public static Color getDarkKhaki()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkMagenta()
```
public static Color getDarkMagenta()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkOliveGreen()
```
public static Color getDarkOliveGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkOrange()
```
public static Color getDarkOrange()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkOrchid()
```
public static Color getDarkOrchid()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkRed()
```
public static Color getDarkRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkSalmon()
```
public static Color getDarkSalmon()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkSeaGreen()
```
public static Color getDarkSeaGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkSlateBlue()
```
public static Color getDarkSlateBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkSlateGray()
```
public static Color getDarkSlateGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkTurquoise()
```
public static Color getDarkTurquoise()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDarkViolet()
```
public static Color getDarkViolet()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDeepPink()
```
public static Color getDeepPink()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDeepSkyBlue()
```
public static Color getDeepSkyBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDimGray()
```
public static Color getDimGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getDodgerBlue()
```
public static Color getDodgerBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getFirebrick()
```
public static Color getFirebrick()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getFloralWhite()
```
public static Color getFloralWhite()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getForestGreen()
```
public static Color getForestGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getFuchsia()
```
public static Color getFuchsia()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGainsboro()
```
public static Color getGainsboro()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGhostWhite()
```
public static Color getGhostWhite()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGold()
```
public static Color getGold()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGoldenrod()
```
public static Color getGoldenrod()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGray()
```
public static Color getGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGreen()
```
public static Color getGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getGreenYellow()
```
public static Color getGreenYellow()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getHoneydew()
```
public static Color getHoneydew()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getHotPink()
```
public static Color getHotPink()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getIndianRed()
```
public static Color getIndianRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getIndigo()
```
public static Color getIndigo()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getIvory()
```
public static Color getIvory()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getKhaki()
```
public static Color getKhaki()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLavender()
```
public static Color getLavender()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLavenderBlush()
```
public static Color getLavenderBlush()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLawnGreen()
```
public static Color getLawnGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLemonChiffon()
```
public static Color getLemonChiffon()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightBlue()
```
public static Color getLightBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightCoral()
```
public static Color getLightCoral()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightCyan()
```
public static Color getLightCyan()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightGoldenrodYellow()
```
public static Color getLightGoldenrodYellow()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightGray()
```
public static Color getLightGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightGreen()
```
public static Color getLightGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightPink()
```
public static Color getLightPink()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightSalmon()
```
public static Color getLightSalmon()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightSeaGreen()
```
public static Color getLightSeaGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightSkyBlue()
```
public static Color getLightSkyBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightSlateGray()
```
public static Color getLightSlateGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightSteelBlue()
```
public static Color getLightSteelBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLightYellow()
```
public static Color getLightYellow()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLime()
```
public static Color getLime()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLimeGreen()
```
public static Color getLimeGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getLinen()
```
public static Color getLinen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMagenta()
```
public static Color getMagenta()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMaroon()
```
public static Color getMaroon()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumAquamarine()
```
public static Color getMediumAquamarine()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumBlue()
```
public static Color getMediumBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumOrchid()
```
public static Color getMediumOrchid()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumPurple()
```
public static Color getMediumPurple()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumSeaGreen()
```
public static Color getMediumSeaGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumSlateBlue()
```
public static Color getMediumSlateBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumSpringGreen()
```
public static Color getMediumSpringGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumTurquoise()
```
public static Color getMediumTurquoise()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMediumVioletRed()
```
public static Color getMediumVioletRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMidnightBlue()
```
public static Color getMidnightBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMintCream()
```
public static Color getMintCream()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMistyRose()
```
public static Color getMistyRose()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getMoccasin()
```
public static Color getMoccasin()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getNavajoWhite()
```
public static Color getNavajoWhite()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getNavy()
```
public static Color getNavy()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOldLace()
```
public static Color getOldLace()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOlive()
```
public static Color getOlive()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOliveDrab()
```
public static Color getOliveDrab()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOrange()
```
public static Color getOrange()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOrangeRed()
```
public static Color getOrangeRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getOrchid()
```
public static Color getOrchid()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPaleGoldenrod()
```
public static Color getPaleGoldenrod()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPaleGreen()
```
public static Color getPaleGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPaleTurquoise()
```
public static Color getPaleTurquoise()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPaleVioletRed()
```
public static Color getPaleVioletRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPapayaWhip()
```
public static Color getPapayaWhip()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPeachPuff()
```
public static Color getPeachPuff()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPeru()
```
public static Color getPeru()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPink()
```
public static Color getPink()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPlum()
```
public static Color getPlum()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPowderBlue()
```
public static Color getPowderBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getPurple()
```
public static Color getPurple()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getRed()
```
public static Color getRed()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getRosyBrown()
```
public static Color getRosyBrown()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getRoyalBlue()
```
public static Color getRoyalBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSaddleBrown()
```
public static Color getSaddleBrown()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSalmon()
```
public static Color getSalmon()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSandyBrown()
```
public static Color getSandyBrown()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSeaGreen()
```
public static Color getSeaGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSeaShell()
```
public static Color getSeaShell()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSienna()
```
public static Color getSienna()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSilver()
```
public static Color getSilver()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSkyBlue()
```
public static Color getSkyBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSlateBlue()
```
public static Color getSlateBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSlateGray()
```
public static Color getSlateGray()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSnow()
```
public static Color getSnow()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSpringGreen()
```
public static Color getSpringGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getSteelBlue()
```
public static Color getSteelBlue()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getTan()
```
public static Color getTan()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getTeal()
```
public static Color getTeal()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getThistle()
```
public static Color getThistle()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getTomato()
```
public static Color getTomato()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getTurquoise()
```
public static Color getTurquoise()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getViolet()
```
public static Color getViolet()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getWheat()
```
public static Color getWheat()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getWhite()
```
public static Color getWhite()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getWhiteSmoke()
```
public static Color getWhiteSmoke()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getYellow()
```
public static Color getYellow()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getYellowGreen()
```
public static Color getYellowGreen()
```

Gets a system-defined color.

**Returns:**
Color - A  Color  representing a system-defined color.
##### getR()
```
public final int getR()
```

Gets the red component value of the color.

**Returns:**
int - The red component of the color. Valid values are 0 through 255.
##### getG()
```
public final int getG()
```

Gets the green component value of the color.

**Returns:**
int - The green component of the color. Valid values are 0 through 255.
##### getB()
```
public final int getB()
```

Gets the blue component value of the color.

**Returns:**
int - The blue component of the color. Valid values are 0 through 255.
##### getA()
```
public final int getA()
```

Gets the alpha component value of the color.

**Returns:**
int - The alpha component of the color. Valid values are 0 through 255.
##### isEmpty()
```
public final boolean isEmpty()
```

Gets a value indicating whether this  Color  structure is uninitialized.

**Returns:**
boolean - This property returns true if this color is uninitialized; otherwise, false.
##### fromArgb(int argb)
```
public static Color fromArgb(int argb)
```

Creates a `Color` structure from a 32-bit ARGB value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| argb | int | A value specifying the 32-bit ARGB value. |

**Returns:**
Color - The `Color` structure that this method creates.
##### fromArgb(int alpha, Color baseColor)
```
public static Color fromArgb(int alpha, Color baseColor)
```

Creates a  Color  structure from the specified  Color  structure, but with the new specified alpha value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alpha | int | The alpha value for the new  Color . Valid values are 0 through 255. |
| baseColor | Color | The  Color  from which to create the new  Color .

Although this method allows a 32-bit value to be passed for the alpha value, the value is limited to 8 bits. |

**Returns:**
Color - The  Color  that this method creates.
##### fromArgb(int red, int green, int blue)
```
public static Color fromArgb(int red, int green, int blue)
```

Creates a  Color  structure from the specified 8-bit color values (red, green, and blue) and the alpha value is implicitly 255 (fully opaque).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| red | int | The red component value for the new  Color . Valid values are 0 through 255. |
| green | int | The green component value for the new  Color . Valid values are 0 through 255. |
| blue | int | The blue component value for the new  Color . Valid values are 0 through 255.

Although this method allows a 32-bit value to be passed for each color component, the value of each component is limited to 8 bits. |

**Returns:**
Color - The  Color  that this method creates.
##### fromArgb(int alpha, int red, int green, int blue)
```
public static Color fromArgb(int alpha, int red, int green, int blue)
```

Creates a  Color  structure from the four ARGB component (alpha, red, green, and blue) values.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| alpha | int | The alpha component value for the new  Color . Valid values are 0 through 255. |
| red | int | The red component value for the new  Color . Valid values are 0 through 255. |
| green | int | The green component value for the new  Color . Valid values are 0 through 255. |
| blue | int | The blue component value for the new  Color . Valid values are 0 through 255.

Although this method allows a 32-bit value to be passed for each component, the value of each component is limited to 8 bits. |

**Returns:**
Color - The  Color  that this method creates.
##### toArgb()
```
public final int toArgb()
```

Gets the 32-bit ARGB value of this  Color  structure.

**Returns:**
int - The 32-bit ARGB value of this  Color  structure.
##### getHue()
```
public final float getHue()
```

Gets the hue-saturation-brightness (HSB) hue value, in degrees, for this  Color  structure.

**Returns:**
float - The hue, in degrees, of this  Color . The hue is measured in degrees, ranging from 0.0 through 360.0, in HSB color space.
##### getSaturation()
```
public final float getSaturation()
```

Gets the hue-saturation-brightness (HSB) saturation value for this  Color  structure.

**Returns:**
float - The saturation of this  Color . The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.
##### getBrightness()
```
public final float getBrightness()
```

Gets the hue-saturation-brightness (HSB) brightness value for this  Color  structure.

**Returns:**
float - The brightness of this  Color . The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.
##### equals(Color other)
```
public final boolean equals(Color other)
```

Determines whether the specified  Color  structure is equivalent to this  Color  structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| other | Color | The color to test. |

**Returns:**
boolean - True if other is equivalent to this  Color  structure; otherwise, false.
##### equals(Object obj)
```
public boolean equals(Object obj)
```

Determines whether the specified object is a  Color > structure and is equivalent to this  Color  structure.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | java.lang.Object | The object to test. |

**Returns:**
boolean - True if object is a  Color  structure equivalent to this  Color  structure; otherwise, false.
##### hashCode()
```
public int hashCode()
```

Gets a hash code for this  Color  structure.

**Returns:**
int - An integer value that specifies the hash code for this  Color
##### CloneTo(Color that)
```
public void CloneTo(Color that)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| that | Color |  |

##### Clone()
```
public Color Clone()
```

**Returns:**
Color
##### clone()
```
public Object clone()
```

**Returns:**
java.lang.Object
##### equals(Color obj1, Color obj2)
```
public static boolean equals(Color obj1, Color obj2)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj1 | Color |  |
| obj2 | Color |  |

**Returns:**
boolean

### Font
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/font.md

**Inheritance:**
java.lang.Object
```
public final class Font
```

Class representing a font.
#### Constructors

| Constructor | Description |
| --- | --- |
| Font(String fontFamilyName, float size) | Initializes a new instance of the `Font` class with a specified font family name and a size. |
| Font(String fontFamilyName, float size, int style) | Initializes a new instance of the `Font` class with a specified font family name, a size and a style. |
| Font(String fontFamilyName, String folderPath, float size) |  |
| Font(String fontFamilyName, String folderPath, float size, FontStyle style) |  |
#### Methods

| Method | Description |
| --- | --- |
| getFolderPath() |  |
| setFolderPath(String folderPath) |  |
| getFamilyName() | Gets the family name of this `Font`. |
| getSize() | Gets the size of this `Font`. |
| getStyle() | Gets the `FontStyle` for this `Font`. |
| getBold() | Gets a value indicating whether the font is bold. |
| getItalic() | Gets a value indicating whether the font is italic. |
| getStrikeout() | Gets a value indicating whether the font specifies a horizontal line through the font. |
| getUnderline() | Gets a value indicating whether the font is underlined. |
##### Font(String fontFamilyName, float size)
```
public Font(String fontFamilyName, float size)
```

Initializes a new instance of the `Font` class with a specified font family name and a size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String | The font family name. |
| size | float | The size of the new font. |

##### Font(String fontFamilyName, float size, int style)
```
public Font(String fontFamilyName, float size, int style)
```

Initializes a new instance of the `Font` class with a specified font family name, a size and a style.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String | The font family name. |
| size | float | The size of the new font. |
| style | int | The `FontStyle` of the new font. |

##### Font(String fontFamilyName, String folderPath, float size)
```
public Font(String fontFamilyName, String folderPath, float size)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String |  |
| folderPath | java.lang.String |  |
| size | float |  |

##### Font(String fontFamilyName, String folderPath, float size, FontStyle style)
```
public Font(String fontFamilyName, String folderPath, float size, FontStyle style)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | java.lang.String |  |
| folderPath | java.lang.String |  |
| size | float |  |
| style | FontStyle |  |

##### getFolderPath()
```
public String getFolderPath()
```

**Returns:**
java.lang.String
##### setFolderPath(String folderPath)
```
public void setFolderPath(String folderPath)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | java.lang.String |  |

##### getFamilyName()
```
public final String getFamilyName()
```

Gets the family name of this `Font`.

**Returns:**
java.lang.String - The family name of this `Font`.
##### getSize()
```
public final float getSize()
```

Gets the size of this `Font`.

**Returns:**
float - The size of this `Font`.
##### getStyle()
```
public final int getStyle()
```

Gets the `FontStyle` for this `Font`.

Default value is `FontStyle.Regular` (normal text).

**Returns:**
int - The `FontStyle` of this `Font`.
##### getBold()
```
public final boolean getBold()
```

Gets a value indicating whether the font is bold.

**Returns:**
boolean - True if this font is bold; otherwise, false.
##### getItalic()
```
public final boolean getItalic()
```

Gets a value indicating whether the font is italic.

**Returns:**
boolean - True if this font is italic; otherwise, false.
##### getStrikeout()
```
public final boolean getStrikeout()
```

Gets a value indicating whether the font specifies a horizontal line through the font.

**Returns:**
boolean - True if this font specifies a horizontal line through the font; otherwise, false.
##### getUnderline()
```
public final boolean getUnderline()
```

Gets a value indicating whether the font is underlined.

**Returns:**
boolean - True if this font is underlined; otherwise, false.

### FontStyle
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/fontstyle.md

**Inheritance:**
java.lang.Object
```
public final class FontStyle
```

Represents a font style.
#### Fields

| Field | Description |
| --- | --- |
| Regular | Normal text. |
| Bold | Bold text. |
| Italic | Italic text. |
| Underline | Underlined text. |
| Strikeout | Text with a line through the middle. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `FontStyle` value. |
| parse(String value) | Parses a string to a `FontStyle` enumeration value. |
##### Regular
```
public static final int Regular
```

Normal text.

##### Bold
```
public static final int Bold
```

Bold text.

##### Italic
```
public static final int Italic
```

Italic text.

##### Underline
```
public static final int Underline
```

Underlined text.

##### Strikeout
```
public static final int Strikeout
```

Text with a line through the middle.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `FontStyle` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `FontStyle` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `FontStyle` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `FontStyle` enumeration value.

### ImageWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/imagewatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.Watermark

**All Implemented Interfaces:**
java.io.Closeable
```
public final class ImageWatermark extends Watermark implements Closeable
```

Represents an image watermark.

**Learn more:**

 *  [Adding image watermarks][]

The following example demonstrates how to add image watermark to a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("C:\\test.some_ext");
>    ImageWatermark watermark = new ImageWatermark("C:\\watermark.png");
>
>    watermark.setHorizontalAlignment(HorizontalAlignment.Center);
>    watermark.setVerticalAlignment(VerticalAlignment.Center);
>    watermarker.add(watermark);
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermark.close();
>    watermarker.close();
>
> ```
> ```

[Adding image watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+image+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| ImageWatermark(String filePath) | Initializes a new instance of the `ImageWatermark` class with a specified file path. |
| ImageWatermark(InputStream stream) | Initializes a new instance of the `ImageWatermark` class with a specified stream. |
| ImageWatermark(System.IO.Stream stream) |  |
#### Methods

| Method | Description |
| --- | --- |
| isImageWatermark() |  |
| isTextWatermark() |  |
| getStream() |  |
| getTransparentImageContainer() |  |
| getSize() |  |
| dispose() |  |
| deepClone() |  |
| hasSameValues(Watermark watermark) |  |
| createGeometry(ContentPartGeometry parent) |  |
| close() | Disposes the current instance. |
##### ImageWatermark(String filePath)
```
public ImageWatermark(String filePath)
```

Initializes a new instance of the `ImageWatermark` class with a specified file path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The path to the image that will be used as watermark. |

##### ImageWatermark(InputStream stream)
```
public ImageWatermark(InputStream stream)
```

Initializes a new instance of the `ImageWatermark` class with a specified stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | java.io.InputStream | The stream containing the image that will be used as watermark. |

##### ImageWatermark(System.IO.Stream stream)
```
public ImageWatermark(System.IO.Stream stream)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | com.aspose.ms.System.IO.Stream |  |

##### isImageWatermark()
```
public boolean isImageWatermark()
```

**Returns:**
boolean
##### isTextWatermark()
```
public boolean isTextWatermark()
```

**Returns:**
boolean
##### getStream()
```
public final StreamContainer getStream()
```

**Returns:**
StreamContainer
##### getTransparentImageContainer()
```
public final StreamContainer getTransparentImageContainer()
```

**Returns:**
StreamContainer
##### getSize()
```
public SizeD getSize()
```

**Returns:**
SizeD
##### dispose()
```
public final void dispose()
```

##### deepClone()
```
public Watermark deepClone()
```

**Returns:**
Watermark
##### hasSameValues(Watermark watermark)
```
public boolean hasSameValues(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

**Returns:**
boolean
##### createGeometry(ContentPartGeometry parent)
```
public WatermarkGeometry createGeometry(ContentPartGeometry parent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | ContentPartGeometry |  |

**Returns:**
WatermarkGeometry
##### close()
```
public final void close()
```

Disposes the current instance.

### Margins
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/margins.md

**Inheritance:**
java.lang.Object
```
public class Margins
```

Represents margin settings for each edge of an object.
#### Constructors

| Constructor | Description |
| --- | --- |
| Margins() | Initializes a new instance of the `Margins` class. |
| Margins(int marginType, double left, double right, double top, double bottom) | Initializes a new instance of the `Margins` class with the specified type, location and size. |
#### Methods

| Method | Description |
| --- | --- |
| getMarginType() | Gets `MarginType`. |
| setMarginType(int value) | Sets `MarginType`. |
| getLeft() | Gets the left margin. |
| setLeft(double value) | Sets the left margin. |
| getRight() | Gets the right margin. |
| setRight(double value) | Sets the right margin. |
| getTop() | Gets the top margin. |
| setTop(double value) | Sets the top margin. |
| getBottom() | Gets the bottom margin. |
| setBottom(double value) | Sets the bottom margin. |
##### Margins()
```
public Margins()
```

Initializes a new instance of the `Margins` class.

##### Margins(int marginType, double left, double right, double top, double bottom)
```
public Margins(int marginType, double left, double right, double top, double bottom)
```

Initializes a new instance of the `Margins` class with the specified type, location and size.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| marginType | int | The `MarginType`. Specifies how margin values should be interpreted. |
| left | double | The left margin value. |
| right | double | The right margin value. |
| top | double | The top margin value. |
| bottom | double | The bottom margin value. |

##### getMarginType()
```
public final int getMarginType()
```

Gets `MarginType`. Setting a new value to this property automatically returns all margins to their default values (zero).

The default value is `MarginType.Absolute`

**Returns:**
int - The value specifying how margins should be interpreted.
##### setMarginType(int value)
```
public final void setMarginType(int value)
```

Sets `MarginType`. Setting a new value to this property automatically returns all margins to their default values (zero).

The default value is `MarginType.Absolute`

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value specifying how margins should be interpreted. |

##### getLeft()
```
public final double getLeft()
```

Gets the left margin.

**Returns:**
double - Horizontal offset from parent left border.
##### setLeft(double value)
```
public final void setLeft(double value)
```

Sets the left margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Horizontal offset from parent left border. |

##### getRight()
```
public final double getRight()
```

Gets the right margin.

**Returns:**
double - Horizontal offset from parent right border.
##### setRight(double value)
```
public final void setRight(double value)
```

Sets the right margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Horizontal offset from parent right border. |

##### getTop()
```
public final double getTop()
```

Gets the top margin.

**Returns:**
double - Horizontal offset from parent top border.
##### setTop(double value)
```
public final void setTop(double value)
```

Sets the top margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Horizontal offset from parent top border. |

##### getBottom()
```
public final double getBottom()
```

Gets the bottom margin.

**Returns:**
double - Horizontal offset from parent bottom border.
##### setBottom(double value)
```
public final void setBottom(double value)
```

Sets the bottom margin.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | Horizontal offset from parent bottom border. |

### MarginType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/margintype.md

**Inheritance:**
java.lang.Object
```
public final class MarginType
```

Specifies how margin values should be interpreted.
#### Fields

| Field | Description |
| --- | --- |
| Absolute | Margin value measured in content units. |
| RelativeToParentDimensions | Margin value should be interpreted as a portion of appropriate parent dimension. |
| RelativeToParentMinDimension | Margin value should be interpreted as a portion of parent minimum dimension. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `MarginType` value. |
| parse(String value) | Parses a string to a `MarginType` enumeration value. |
##### Absolute
```
public static final int Absolute
```

Margin value measured in content units.

##### RelativeToParentDimensions
```
public static final int RelativeToParentDimensions
```

Margin value should be interpreted as a portion of appropriate parent dimension.

Left and right margins are relative to parent width, top and bottom margins are relative to parent height. If this type is chosen, margin value must be between 0.0 and 1.0.

##### RelativeToParentMinDimension
```
public static final int RelativeToParentMinDimension
```

Margin value should be interpreted as a portion of parent minimum dimension.

If this type is chosen, margin value must be between 0.0 and 1.0.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `MarginType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `MarginType` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `MarginType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `MarginType` enumeration value.

### SizingType
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/sizingtype.md

**Inheritance:**
java.lang.Object
```
public final class SizingType
```

Specifies how watermark size should be calculated.
#### Fields

| Field | Description |
| --- | --- |
| Auto | Watermark should be sized automatically according to its content. |
| Absolute | Watermark should be sized to an exact `Watermark.getWidth()` and `Watermark.getHeight()`. |
| ScaleToParentDimensions | Watermark should be scaled relative to parent dimensions using specified `Watermark.getScaleFactor()`. |
| ScaleToParentArea | Watermark should be scaled relative to parent area using specified `Watermark.getScaleFactor()`. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `SizingType` value. |
| parse(String value) | Parses a string to a `SizingType` enumeration value. |
##### Auto
```
public static final int Auto
```

Watermark should be sized automatically according to its content.

##### Absolute
```
public static final int Absolute
```

Watermark should be sized to an exact `Watermark.getWidth()` and `Watermark.getHeight()`.

##### ScaleToParentDimensions
```
public static final int ScaleToParentDimensions
```

Watermark should be scaled relative to parent dimensions using specified `Watermark.getScaleFactor()`.

##### ScaleToParentArea
```
public static final int ScaleToParentArea
```

Watermark should be scaled relative to parent area using specified `Watermark.getScaleFactor()`.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `SizingType` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `SizingType` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `SizingType` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `SizingType` enumeration value.

### TextAlignment
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/textalignment.md

**Inheritance:**
java.lang.Object
```
public final class TextAlignment
```

Enumeration of possible text alignment values.
#### Fields

| Field | Description |
| --- | --- |
| Left | Align to left. |
| Center | Center alignment. |
| Right | Align to right. |
| Justify | Justify alignment. |
#### Methods

| Method | Description |
| --- | --- |
| toString(int value) | Returns a string representation of the `TextAlignment` value. |
| parse(String value) | Parses a string to a `TextAlignment` enumeration value. |
##### Left
```
public static final int Left
```

Align to left.

##### Center
```
public static final int Center
```

Center alignment.

##### Right
```
public static final int Right
```

Align to right.

##### Justify
```
public static final int Justify
```

Justify alignment. Text will be aligned on both left and right margins.

##### toString(int value)
```
public static final String toString(int value)
```

Returns a string representation of the `TextAlignment` value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The value to convert. |

**Returns:**
java.lang.String - The string representation of the `TextAlignment` value.
##### parse(String value)
```
public static final int parse(String value)
```

Parses a string to a `TextAlignment` enumeration value.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string to parse. |

**Returns:**
int - The `TextAlignment` enumeration value.

### TextWatermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.watermarks/textwatermark.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.Watermark
```
public class TextWatermark extends Watermark
```

Represents a text watermark.

**Learn more:**

 *  [Adding text watermarks][]

The following example demonstrates how to scale the text watermark depending on the parent size.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("C:\\test.some_ext");
>    TextWatermark watermark = new TextWatermark("test watermark", new Font("Arial", 36));
>
>    watermark.setHorizontalAlignment(HorizontalAlignment.Center);
>    watermark.setVerticalAlignment(VerticalAlignment.Center);
>    watermark.setSizingType(SizingType.ScaleToParentDimensions);
>    watermark.setRotateAngle(45);
>    watermark.setScaleFactor(0.4);
>
>    watermarker.add(watermark);
>
>    watermarker.save("C:\\modified_test.some_ext");
>    watermarker.close();
>
> ```
> ```

[Adding text watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+text+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| TextWatermark(String text, Font font) | Initializes a new instance of the `TextWatermark` class with a specified text and a font. |
#### Methods

| Method | Description |
| --- | --- |
| getText() | Gets the text to be used as watermark. |
| setText(String value) | Sets the text to be used as watermark. |
| getFont() | Gets the font of the text. |
| setFont(Font value) | Sets the font of the text. |
| getForegroundColor() | Gets the foreground color of the text. |
| setForegroundColor(Color value) | Sets the foreground color of the text. |
| getBackgroundColor() | Gets the background color of the text. |
| setBackgroundColor(Color value) | Sets the background color of the text. |
| getTextAlignment() | Gets the watermark `TextAlignment`. |
| setTextAlignment(int value) | Sets the watermark `TextAlignment`. |
| isImageWatermark() |  |
| isTextWatermark() |  |
| getForegroundColorConsideringOpacity() |  |
| getBackgroundColorConsideringOpacity() |  |
| getSize() |  |
| getPadding() | Gets the padding settings of this `TextWatermark`. |
| setPadding(Thickness value) | Sets the padding settings of this `TextWatermark`. |
| deepClone() |  |
| hasSameValues(Watermark watermark) |  |
| createGeometry(ContentPartGeometry parent) |  |
##### TextWatermark(String text, Font font)
```
public TextWatermark(String text, Font font)
```

Initializes a new instance of the `TextWatermark` class with a specified text and a font.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| text | java.lang.String | The text to be used as watermark. |
| font | Font | The font of the text. |

##### getText()
```
public final String getText()
```

Gets the text to be used as watermark.

**Returns:**
java.lang.String - The string representing watermark text.
##### setText(String value)
```
public final void setText(String value)
```

Sets the text to be used as watermark.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | The string representing watermark text. |

##### getFont()
```
public final Font getFont()
```

Gets the font of the text.

**Returns:**
Font - The font of the text.
##### setFont(Font value)
```
public final void setFont(Font value)
```

Sets the font of the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Font | The font of the text. |

##### getForegroundColor()
```
public final Color getForegroundColor()
```

Gets the foreground color of the text.

**Returns:**
Color - The foreground color of the text.
##### setForegroundColor(Color value)
```
public final void setForegroundColor(Color value)
```

Sets the foreground color of the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | The foreground color of the text. |

##### getBackgroundColor()
```
public final Color getBackgroundColor()
```

Gets the background color of the text.

**Returns:**
Color - The background color of the text.
##### setBackgroundColor(Color value)
```
public final void setBackgroundColor(Color value)
```

Sets the background color of the text.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Color | The background color of the text. |

##### getTextAlignment()
```
public final int getTextAlignment()
```

Gets the watermark `TextAlignment`.

Default value is `TextAlignment.Left`.

**Returns:**
int - The watermark `TextAlignment`.
##### setTextAlignment(int value)
```
public final void setTextAlignment(int value)
```

Sets the watermark `TextAlignment`.

Default value is `TextAlignment.Left`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The watermark `TextAlignment`. |

##### isImageWatermark()
```
public boolean isImageWatermark()
```

**Returns:**
boolean
##### isTextWatermark()
```
public boolean isTextWatermark()
```

**Returns:**
boolean
##### getForegroundColorConsideringOpacity()
```
public final Color getForegroundColorConsideringOpacity()
```

**Returns:**
Color
##### getBackgroundColorConsideringOpacity()
```
public final Color getBackgroundColorConsideringOpacity()
```

**Returns:**
Color
##### getSize()
```
public SizeD getSize()
```

**Returns:**
SizeD
##### getPadding()
```
public final Thickness getPadding()
```

Gets the padding settings of this `TextWatermark`. This property is applicable only to image files.

**Returns:**
Thickness - The padding settings of this `TextWatermark`.
##### setPadding(Thickness value)
```
public final void setPadding(Thickness value)
```

Sets the padding settings of this `TextWatermark`. This property is applicable only to image files.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Thickness | The padding settings of this `TextWatermark`. |

##### deepClone()
```
public Watermark deepClone()
```

**Returns:**
Watermark
##### hasSameValues(Watermark watermark)
```
public boolean hasSameValues(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

**Returns:**
boolean
##### createGeometry(ContentPartGeometry parent)
```
public WatermarkGeometry createGeometry(ContentPartGeometry parent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | ContentPartGeometry |  |

**Returns:**
WatermarkGeometry

### com.groupdocs.watermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark.md

#### Classes

| Class | Description |
| --- | --- |
| PagesSelector |  |
| PagesSetup | Represents the setup for pages. |
| PresentationPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Presentation document. |
| Watermark | Represents a watermark to be added to a document. |
| Watermarker | Represents a class for watermark management in a document. |
| WatermarkerSettings | Defines settings for customizing Watermarker behaviour. |

### PagesSelector
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/pagesselector.md

**Inheritance:**
java.lang.Object
```
public class PagesSelector
```
#### Constructors

| Constructor | Description |
| --- | --- |
| PagesSelector() |  |
#### Methods

| Method | Description |
| --- | --- |
| getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, System.Nullable<Integer> pageIndex) | Gets a list of pages based on the specified setup. |
| getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, int[] pageNumbers, boolean fromOne) | Gets a list of selected pages based on the specified criteria. |
##### PagesSelector()
```
public PagesSelector()
```

##### getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, System.Nullable<Integer> pageIndex)
```
public static System.Collections.Generic.List<Integer> getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, System.Nullable<Integer> pageIndex)
```

Gets a list of pages based on the specified setup.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allPages | boolean | Whether to include all pages. |
| pagesSetup | PagesSetup | The pages setup configuration. |
| totalPages | int | The total number of pages. |
| pageIndex | com.aspose.ms.System.Nullable<java.lang.Integer> | The specific page index (starting with 0). |

**Returns:**
com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> - A list of pages based on the specified setup.
##### getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, int[] pageNumbers, boolean fromOne)
```
public static System.Collections.Generic.List<Integer> getPages(boolean allPages, PagesSetup pagesSetup, int totalPages, int[] pageNumbers, boolean fromOne)
```

Gets a list of selected pages based on the specified criteria.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allPages | boolean | A flag indicating whether to include all pages. |
| pagesSetup | PagesSetup | The setup configuration for pages. |
| totalPages | int | The total number of pages in the document. |
| pageNumbers | int[] | An array of specific page numbers to include. |
| fromOne | boolean |  |

**Returns:**
com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> - A sorted and distinct list of selected page numbers.

### PagesSetup
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/pagessetup.md

**Inheritance:**
java.lang.Object
```
public class PagesSetup
```

Represents the setup for pages.
#### Constructors

| Constructor | Description |
| --- | --- |
| PagesSetup() | Initializes a new instance of the  PagesSetup  class. |
| PagesSetup(boolean allPages, boolean firstPage, boolean lastPage, boolean oddPages, boolean evenPages, System.Collections.Generic.List<Integer> pages, System.Nullable<Integer> pageNumber) | Initializes a new instance of the  PagesSetup  class with specified parameters. |
#### Methods

| Method | Description |
| --- | --- |
| getAllPages() | Gets or sets a value indicating whether to include all pages. |
| setAllPages(boolean value) | Gets or sets a value indicating whether to include all pages. |
| getFirstPage() | Gets or sets a value indicating whether to include the first page. |
| setFirstPage(boolean value) | Gets or sets a value indicating whether to include the first page. |
| getLastPage() | Gets or sets a value indicating whether to include the last page. |
| setLastPage(boolean value) | Gets or sets a value indicating whether to include the last page. |
| getOddPages() | Gets or sets a value indicating whether to include odd pages. |
| setOddPages(boolean value) | Gets or sets a value indicating whether to include odd pages. |
| getEvenPages() | Gets or sets a value indicating whether to include even pages. |
| setEvenPages(boolean value) | Gets or sets a value indicating whether to include even pages. |
| getPages() | Gets or sets the list of specific page numbers to include. |
| setPages(System.Collections.Generic.List<Integer> value) | Gets or sets the list of specific page numbers to include. |
| getPageNumber() | Gets or sets the index of the page when considering only specified pages. |
| setPageNumber(System.Nullable<Integer> value) | Gets or sets the page number when considering only specified pages. |
| getSpecified() | Gets a value indicating whether any specific pages are specified. |
##### PagesSetup()
```
public PagesSetup()
```

Initializes a new instance of the  PagesSetup  class.

##### PagesSetup(boolean allPages, boolean firstPage, boolean lastPage, boolean oddPages, boolean evenPages, System.Collections.Generic.List<Integer> pages, System.Nullable<Integer> pageNumber)
```
public PagesSetup(boolean allPages, boolean firstPage, boolean lastPage, boolean oddPages, boolean evenPages, System.Collections.Generic.List<Integer> pages, System.Nullable<Integer> pageNumber)
```

Initializes a new instance of the  PagesSetup  class with specified parameters.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| allPages | boolean | Whether to include all pages. |
| firstPage | boolean | Whether to include the first page. |
| lastPage | boolean | Whether to include the last page. |
| oddPages | boolean | Whether to include odd pages. |
| evenPages | boolean | Whether to include even pages. |
| pages | com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> | The list of specific page numbers to include. |
| pageNumber | com.aspose.ms.System.Nullable<java.lang.Integer> | The index of the current page. |

##### getAllPages()
```
public final boolean getAllPages()
```

Gets or sets a value indicating whether to include all pages.

**Returns:**
boolean
##### setAllPages(boolean value)
```
public final void setAllPages(boolean value)
```

Gets or sets a value indicating whether to include all pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getFirstPage()
```
public final boolean getFirstPage()
```

Gets or sets a value indicating whether to include the first page.

**Returns:**
boolean
##### setFirstPage(boolean value)
```
public final void setFirstPage(boolean value)
```

Gets or sets a value indicating whether to include the first page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getLastPage()
```
public final boolean getLastPage()
```

Gets or sets a value indicating whether to include the last page.

**Returns:**
boolean
##### setLastPage(boolean value)
```
public final void setLastPage(boolean value)
```

Gets or sets a value indicating whether to include the last page.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getOddPages()
```
public final boolean getOddPages()
```

Gets or sets a value indicating whether to include odd pages.

**Returns:**
boolean
##### setOddPages(boolean value)
```
public final void setOddPages(boolean value)
```

Gets or sets a value indicating whether to include odd pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getEvenPages()
```
public final boolean getEvenPages()
```

Gets or sets a value indicating whether to include even pages.

**Returns:**
boolean
##### setEvenPages(boolean value)
```
public final void setEvenPages(boolean value)
```

Gets or sets a value indicating whether to include even pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean |  |

##### getPages()
```
public final System.Collections.Generic.List<Integer> getPages()
```

Gets or sets the list of specific page numbers to include.

**Returns:**
com.aspose.ms.System.Collections.Generic.List<java.lang.Integer>
##### setPages(System.Collections.Generic.List<Integer> value)
```
public final void setPages(System.Collections.Generic.List<Integer> value)
```

Gets or sets the list of specific page numbers to include.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Collections.Generic.List<java.lang.Integer> |  |

##### getPageNumber()
```
public final System.Nullable<Integer> getPageNumber()
```

Gets or sets the index of the page when considering only specified pages.

**Returns:**
com.aspose.ms.System.Nullable<java.lang.Integer>
##### setPageNumber(System.Nullable<Integer> value)
```
public final void setPageNumber(System.Nullable<Integer> value)
```

Gets or sets the page number when considering only specified pages.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.ms.System.Nullable<java.lang.Integer> |  |

##### getSpecified()
```
public final boolean getSpecified()
```

Gets a value indicating whether any specific pages are specified.

**Returns:**
boolean

### PresentationPreviewOptions
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/presentationpreviewoptions.md

**Inheritance:**
java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
```
public class PresentationPreviewOptions extends PreviewOptions
```

Provides options to sets requirements and stream delegates for preview generation of Presentation document.
#### Constructors

| Constructor | Description |
| --- | --- |
| PresentationPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the `PresentationPreviewOptions` class causing the output stream to be closed. |
| PresentationPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use. |
#### Fields

| Field | Description |
| --- | --- |
| DefaultResolution | Default resolution in dots per inch. |
#### Methods

| Method | Description |
| --- | --- |
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(long value) | Sets the resolution for the generated images, in dots per inch. |
##### PresentationPreviewOptions(ICreatePageStream createPageStream)
```
public PresentationPreviewOptions(ICreatePageStream createPageStream)
```

Initializes a new instance of the `PresentationPreviewOptions` class causing the output stream to be closed.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |

##### PresentationPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```
public PresentationPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
```

Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

##### DefaultResolution
```
public static final long DefaultResolution
```

Default resolution in dots per inch.

##### getResolution()
```
public final long getResolution()
```

Gets the resolution for the generated images, in dots per inch.

**Returns:**
long - The resolution for the generated images, in dots per inch.
##### setResolution(long value)
```
public final void setResolution(long value)
```

Sets the resolution for the generated images, in dots per inch.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | long | The resolution for the generated images, in dots per inch. |

### Watermark
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/watermark.md

**Inheritance:**
java.lang.Object
```
public abstract class Watermark
```

Represents a watermark to be added to a document.

[Adding text watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+text+watermarks
[Adding watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+watermarks
#### Constructors

| Constructor | Description |
| --- | --- |
| Watermark() |  |
#### Methods

| Method | Description |
| --- | --- |
| getOpacity() | Gets or sets the opacity of this `Watermark`. |
| setOpacity(double value) | Gets or sets the opacity of this `Watermark`. |
| getY() | Gets the y-coordinate of this `Watermark`. |
| setY(double value) | Sets the y-coordinate of this `Watermark`. |
| getX() | Gets the x-coordinate of this `Watermark`. |
| setX(double value) | Sets the x-coordinate of this `Watermark`. |
| getVerticalAlignment() | Gets the vertical alignment of this `Watermark`. |
| setVerticalAlignment(int value) | Sets the vertical alignment of this `Watermark`. |
| getHorizontalAlignment() | Gets the horizontal alignment of this `Watermark`. |
| setHorizontalAlignment(int value) | Sets the horizontal alignment of this `Watermark`. |
| getRotateAngle() | Gets the rotate angle of this `Watermark` in degrees. |
| setRotateAngle(double value) | Sets the rotate angle of this `Watermark` in degrees. |
| isBackground() | Gets a value indicating whether the watermark should be placed at background. |
| setBackground(boolean value) | Sets a value indicating whether the watermark should be placed at background. |
| getMargins() | Gets the margin settings of this `Watermark`. |
| setMargins(Margins value) | Sets the margin settings of this `Watermark`. |
| getPagesSetup() | Gets the pages setup settings of this `Watermark`. |
| setPagesSetup(PagesSetup value) | Sets the pages setup settings of this `Watermark`. |
| getHeight() | Gets the desired height of this `Watermark`. |
| setHeight(double value) | Sets the desired height of this `Watermark`. |
| getWidth() | Gets the desired width of this `Watermark`. |
| setWidth(double value) | Sets the desired width of this `Watermark`. |
| getScaleFactor() | Gets a value that defines how watermark size depends on parent size. |
| setScaleFactor(double value) | Sets a value that defines how watermark size depends on parent size. |
| getSizingType() | Gets a value specifying a way watermark should be sized. |
| setSizingType(int value) | Sets a value specifying a way watermark should be sized. |
| getConsiderParentMargins() | Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins. |
| setConsiderParentMargins(boolean value) | Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins. |
| isImageWatermark() |  |
| isTextWatermark() |  |
| getTransparency() |  |
| getSize() |  |
| getTileOptions() |  |
| setTileOptions(TileOptions tileOptions) |  |
| copyPropertiesValues(Watermark source, Watermark destination) |  |
| deepClone() |  |
| hasSameValues(Watermark watermark) |  |
| createGeometry(ContentPartGeometry parent) |  |
##### Watermark()
```
public Watermark()
```

##### getOpacity()
```
public final double getOpacity()
```

Gets or sets the opacity of this `Watermark`.

The value of opacity should be between 0 and 1. The default value is 1.

**Returns:**
double - The opacity of this `Watermark`.
##### setOpacity(double value)
```
public final void setOpacity(double value)
```

Gets or sets the opacity of this `Watermark`.

The value of opacity should be between 0 and 1. The default value is 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The opacity of this `Watermark`. |

##### getY()
```
public final double getY()
```

Gets the y-coordinate of this `Watermark`.

**Returns:**
double - The y-coordinate of this `Watermark`.
##### setY(double value)
```
public final void setY(double value)
```

Sets the y-coordinate of this `Watermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The y-coordinate of this `Watermark`. |

##### getX()
```
public final double getX()
```

Gets the x-coordinate of this `Watermark`.

**Returns:**
double - The x-coordinate of this `Watermark`.
##### setX(double value)
```
public final void setX(double value)
```

Sets the x-coordinate of this `Watermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The x-coordinate of this `Watermark`. |

##### getVerticalAlignment()
```
public final int getVerticalAlignment()
```

Gets the vertical alignment of this `Watermark`.

Default value is `VerticalAlignment.None`.

**Returns:**
int - The `VerticalAlignment` of this `Watermark`.
##### setVerticalAlignment(int value)
```
public final void setVerticalAlignment(int value)
```

Sets the vertical alignment of this `Watermark`.

Default value is `VerticalAlignment.None`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The `VerticalAlignment` of this `Watermark`. |

##### getHorizontalAlignment()
```
public final int getHorizontalAlignment()
```

Gets the horizontal alignment of this `Watermark`.

Default value is `HorizontalAlignment.None`.

**Returns:**
int - The `HorizontalAlignment` of this `Watermark`.
##### setHorizontalAlignment(int value)
```
public final void setHorizontalAlignment(int value)
```

Sets the horizontal alignment of this `Watermark`.

Default value is `HorizontalAlignment.None`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The `HorizontalAlignment` of this `Watermark`. |

##### getRotateAngle()
```
public final double getRotateAngle()
```

Gets the rotate angle of this `Watermark` in degrees.

**Returns:**
double - The rotate angle of this `Watermark` in degrees.
##### setRotateAngle(double value)
```
public final void setRotateAngle(double value)
```

Sets the rotate angle of this `Watermark` in degrees.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The rotate angle of this `Watermark` in degrees. |

##### isBackground()
```
public final boolean isBackground()
```

Gets a value indicating whether the watermark should be placed at background.

**Returns:**
boolean - If the value is true, the watermark will be placed at the bottom. By default, the value is false, the watermark will be placed at the top.
##### setBackground(boolean value)
```
public final void setBackground(boolean value)
```

Sets a value indicating whether the watermark should be placed at background.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, the watermark will be placed at the bottom. By default, the value is false, the watermark will be placed at the top. |

##### getMargins()
```
public final Margins getMargins()
```

Gets the margin settings of this `Watermark`.

**Returns:**
Margins - The margin settings of this `Watermark`.
##### setMargins(Margins value)
```
public final void setMargins(Margins value)
```

Sets the margin settings of this `Watermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | Margins | The margin settings of this `Watermark`. |

##### getPagesSetup()
```
public final PagesSetup getPagesSetup()
```

Gets the pages setup settings of this `Watermark`.

**Returns:**
PagesSetup - The pages setup settings of this `Watermark`.
##### setPagesSetup(PagesSetup value)
```
public final void setPagesSetup(PagesSetup value)
```

Sets the pages setup settings of this `Watermark`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | PagesSetup | The pages setup settings of this `Watermark`. |

##### getHeight()
```
public final double getHeight()
```

Gets the desired height of this `Watermark`.

**Returns:**
double - The desired height of this `Watermark`.
##### setHeight(double value)
```
public final void setHeight(double value)
```

Sets the desired height of this `Watermark`.

Setting this property will also change the value of `#getSizingType().getSizingType()` property to `SizingType.Absolute`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The desired height of this `Watermark`. |

##### getWidth()
```
public final double getWidth()
```

Gets the desired width of this `Watermark`.

**Returns:**
double - The desired width of this `Watermark`.
##### setWidth(double value)
```
public final void setWidth(double value)
```

Sets the desired width of this `Watermark`.

Setting this property will also change the value of `#getSizingType().getSizingType()` property to `SizingType.Absolute`.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The desired width of this `Watermark`. |

##### getScaleFactor()
```
public final double getScaleFactor()
```

Gets a value that defines how watermark size depends on parent size.

The value must be between 0 and 1.

**Returns:**
double - The scale factor of this `Watermark`.
##### setScaleFactor(double value)
```
public final void setScaleFactor(double value)
```

Sets a value that defines how watermark size depends on parent size.

The value must be between 0 and 1.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The scale factor of this `Watermark`. |

##### getSizingType()
```
public final int getSizingType()
```

Gets a value specifying a way watermark should be sized.

**Returns:**
int - The sizing type.
##### setSizingType(int value)
```
public final void setSizingType(int value)
```

Sets a value specifying a way watermark should be sized.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The sizing type. |

##### getConsiderParentMargins()
```
public final boolean getConsiderParentMargins()
```

Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins.

**Returns:**
boolean - If the value is true, watermark size and coordinates are calculated considering parent margins. By default, the value is false, parent margins are ignored.
##### setConsiderParentMargins(boolean value)
```
public final void setConsiderParentMargins(boolean value)
```

Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | If the value is true, watermark size and coordinates are calculated considering parent margins. By default, the value is false, parent margins are ignored. |

##### isImageWatermark()
```
public abstract boolean isImageWatermark()
```

**Returns:**
boolean
##### isTextWatermark()
```
public abstract boolean isTextWatermark()
```

**Returns:**
boolean
##### getTransparency()
```
public final double getTransparency()
```

**Returns:**
double
##### getSize()
```
public abstract SizeD getSize()
```

**Returns:**
SizeD
##### getTileOptions()
```
public TileOptions getTileOptions()
```

**Returns:**
TileOptions
##### setTileOptions(TileOptions tileOptions)
```
public void setTileOptions(TileOptions tileOptions)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| tileOptions | TileOptions |  |

##### copyPropertiesValues(Watermark source, Watermark destination)
```
public static void copyPropertiesValues(Watermark source, Watermark destination)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | Watermark |  |
| destination | Watermark |  |

##### deepClone()
```
public abstract Watermark deepClone()
```

**Returns:**
Watermark
##### hasSameValues(Watermark watermark)
```
public boolean hasSameValues(Watermark watermark)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark |  |

**Returns:**
boolean
##### createGeometry(ContentPartGeometry parent)
```
public abstract WatermarkGeometry createGeometry(ContentPartGeometry parent)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| parent | ContentPartGeometry |  |

**Returns:**
WatermarkGeometry

### Watermarker
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/watermarker.md

**Inheritance:**
java.lang.Object

**All Implemented Interfaces:**
java.io.Closeable
```
public class Watermarker implements Closeable
```

Represents a class for watermark management in a document.

The following example demonstrates how to load and save a content of any supported format.

> ```
> ```
>
>    // Load a content from a file.
>    Watermarker watermarker = new Watermarker("D:\\input.pdf");
>
>    // Use methods of Watermarker class to add, search or remove watermarks.
>
>    // Save changes.
>    watermarker.save("D:\\output.pdf");
>
>    // Free resources.
>    watermarker.close();
>
> ```
> ```
#### Constructors

| Constructor | Description |
| --- | --- |
| Watermarker(String filePath) | Initializes a new instance of the `Watermarker` class with the specified document path. |
| Watermarker(String filePath, LoadOptions options) | Initializes a new instance of the `Watermarker` class with the specified document path and load options. |
| Watermarker(String filePath, WatermarkerSettings settings) | Initializes a new instance of the `Watermarker` class with the specified document path and settings. |
| Watermarker(String filePath, LoadOptions options, WatermarkerSettings settings) | Initializes a new instance of the `Watermarker` class with the specified document path, load options and settings. |
| Watermarker(InputStream document) | Initializes a new instance of the `Watermarker` class with the specified stream. |
| Watermarker(InputStream document, LoadOptions options) | Initializes a new instance of the `Watermarker` class with the specified stream and load options. |
| Watermarker(InputStream document, WatermarkerSettings settings) | Initializes a new instance of the `Watermarker` class with the specified stream and settings. |
| Watermarker(InputStream document, LoadOptions options, WatermarkerSettings settings) | Initializes a new instance of the  class with the specified stream, load options and settings. |
| Watermarker(System.IO.Stream document, LoadOptions options, WatermarkerSettings settings) |  |
#### Methods

| Method | Description |
| --- | --- |
| getSearchableObjects() | Gets the content objects that are to be included in a watermark search. |
| setSearchableObjects(SearchableObjects value) | Sets the content objects that are to be included in a watermark search. |
| dispose() |  |
| close() | Disposes the current instance. |
| getDocumentInfo() | Gets the information about the format of the loaded document. |
| add(Watermark watermark) | Adds a watermark to the loaded document. |
| add(Watermark watermark, WatermarkOptions options) | Adds a watermark to the loaded document using watermark options. |
| remove(PossibleWatermark possibleWatermark) | Removes watermark from the document. |
| remove(PossibleWatermarkCollection possibleWatermarks) | Removes all watermarks in the collection from the document. |
| save(String filePath) | Saves the document to the specified file location. |
| save(OutputStream document) | Saves the document to the specified stream. |
| save(String filePath, SaveOptions options) | Saves the document to the specified file location using save options. |
| save(OutputStream document, SaveOptions options) | Saves the document to the specified stream using save options. |
| generatePreview(PreviewOptions previewOptions) | Generates preview images for the document. |
| search() | Searches all possible watermarks in the document. |
| search(SearchCriteria searchCriteria) | Searches possible watermarks according to specified search criteria. |
| getImages(ImageSearchCriteria searchCriteria) | Finds images according to specified search criteria. |
| getImages() | Finds all images in the document. |
| <T>getContent(Class<T> contentType) | Returns the `Content` object for the loaded document. |
##### Watermarker(String filePath)
```
public Watermarker(String filePath)
```

Initializes a new instance of the `Watermarker` class with the specified document path.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to load and save a content of any supported format.

> ```
> ```
>
>    // Load a content from a file.
>    Watermarker watermarker = new Watermarker("D:\\input.pdf");
>
>    // Use methods of Watermarker class to add, search or remove watermarks.
>
>    // Save changes.
>    watermarker.save("D:\\output.pdf");
>
>    // Free resources.
>    watermarker.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarkjava/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load the document from. |

##### Watermarker(String filePath, LoadOptions options)
```
public Watermarker(String filePath, LoadOptions options)
```

Initializes a new instance of the `Watermarker` class with the specified document path and load options.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to load encrypted PDF document using password.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    loadOptions.setPassword("123");
>    Watermarker watermarker = new Watermarker("C:\\Documents\\test.pdf", loadOptions);
>    // ...
>    watermarker.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarkjava/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |

##### Watermarker(String filePath, WatermarkerSettings settings)
```
public Watermarker(String filePath, WatermarkerSettings settings)
```

Initializes a new instance of the `Watermarker` class with the specified document path and settings.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to set searchable objects globally (for all documents that will be loaded after that).

> ```
> ```
>
>    WatermarkerSettings settings = new WatermarkerSettings();
>    settings.setSearchableObjects(new SearchableObjects());
>    settings.getSearchableObjects().setWordProcessingSearchableObjects(WordProcessingSearchableObjects.Hyperlinks
>                                                                     | WordProcessingSearchableObjects.Text);
>    settings.getSearchableObjects().setSpreadsheetSearchableObjects(SpreadsheetSearchableObjects.HeadersFooters);
>    settings.getSearchableObjects().setPresentationSearchableObjects(PresentationSearchableObjects.SlidesBackgrounds
>                                                                   | PresentationSearchableObjects.Shapes);
>    settings.getSearchableObjects().setDiagramSearchableObjects(DiagramSearchableObjects.None);
>    settings.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.All);
>
>    for (final File fileEntry : new File("D:\\files").listFiles())
>    {
>       if (fileEntry.isFile()) {
>           Watermarker watermarker = new Watermarker(fileEntry.getPath(), settings);
>           PossibleWatermarkCollection watermarks = watermarker.search();
>           // The code for working with found watermarks goes here.
>           watermarker.close();
>       }
>    }
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarkjava/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load document from. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Watermarker(String filePath, LoadOptions options, WatermarkerSettings settings)
```
public Watermarker(String filePath, LoadOptions options, WatermarkerSettings settings)
```

Initializes a new instance of the `Watermarker` class with the specified document path, load options and settings.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to find particular text fragments in email message body/subject.

> ```
> ```
>
>    WatermarkerSettings settings = new WatermarkerSettings();
>    settings.setSearchableObjects(new SearchableObjects());
>    settings.getSearchableObjects().setEmailSearchableObjects(EmailSearchableObjects.Subject
>                                                            | EmailSearchableObjects.HtmlBody
>                                                            | EmailSearchableObjects.PlainTextBody);
>    EmailLoadOptions loadOptions = new EmailLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\test.msg", loadOptions, settings);
>    SearchCriteria criteria = new TextSearchCriteria("test", false);
>    // Note, search is performed only if you pass TextSearchCriteria instance to search() method
>    PossibleWatermarkCollection watermarks = watermarker.search(criteria);
>    // Remove found text fragments
>    watermarks.clear();
>    // Save changes
>    watermarker.save("D:\\modified_test.msg");
>    watermarker.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarknet/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Watermarker(InputStream document)
```
public Watermarker(InputStream document)
```

Initializes a new instance of the `Watermarker` class with the specified stream.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to load and save a document of any supported format.

> ```
> ```
>
>    // Load a content from a stream.
>    FileInputStream inputStream = new FileInputStream("D:\\input.pdf");
>    FileOutputStream outputStream = new FileOutputStream("D:\\output.pdf");
>    Watermarker watermarker = new Watermarker(inputStream);
>    // Use methods of Watermarker class to add, search or remove watermarks.
>
>    // Save changes.
>    watermarker.save(outputStream);
>    watermarker.close();
>    outputStream.close();
>    inputStream.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarknet/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream to load document from. |

##### Watermarker(InputStream document, LoadOptions options)
```
public Watermarker(InputStream document, LoadOptions options)
```

Initializes a new instance of the `Watermarker` class with the specified stream and load options.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to load encrypted PDF document using password

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    loadOptions.setPassword("123");
>    FileInputStream inputStream = new FileInputStream("D:\\input.pdf");
>    Watermarker watermarker = new Watermarker(inputStream, loadOptions);
>    // ...
>
>    watermarker.close();
>    inputStream.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarknet/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |

##### Watermarker(InputStream document, WatermarkerSettings settings)
```
public Watermarker(InputStream document, WatermarkerSettings settings)
```

Initializes a new instance of the `Watermarker` class with the specified stream and settings.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to set searchable objects globally (for all documents that will be loaded after that).

> ```
> ```
>
>    WatermarkerSettings settings = new WatermarkerSettings();
>    settings.setSearchableObjects(new SearchableObjects());
>    settings.getSearchableObjects().setWordProcessingSearchableObjects(WordProcessingSearchableObjects.Hyperlinks
>                                                                     | WordProcessingSearchableObjects.Text);
>    settings.getSearchableObjects().setSpreadsheetSearchableObjects(SpreadsheetSearchableObjects.HeadersFooters);
>    settings.getSearchableObjects().setPresentationSearchableObjects(PresentationSearchableObjects.SlidesBackgrounds
>                                                                   | PresentationSearchableObjects.Shapes);
>    settings.getSearchableObjects().setDiagramSearchableObjects(DiagramSearchableObjects.None);
>    settings.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.All);
>
>    for (final File fileEntry : new File("D:\\files").listFiles())
>    {
>       if (fileEntry.isFile()) {
>           FileInputStream inputStream = new FileInputStream(fileEntry.getPath());
>           Watermarker watermarker = new Watermarker(inputStream, settings);
>           PossibleWatermarkCollection watermarks = watermarker.Search();
>           // The code for working with found watermarks goes here.
>           watermarker.close();
>           inputStream.close();
>       }
>    }
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarknet/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream to load document from. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Watermarker(InputStream document, LoadOptions options, WatermarkerSettings settings)
```
public Watermarker(InputStream document, LoadOptions options, WatermarkerSettings settings)
```

Initializes a new instance of the  class with the specified stream, load options and settings.

Learn more about loading documents: [Loading documents][].

The following example demonstrates how to set searchable objects globally (for all documents that will be loaded after that).

> ```
> ```
>
>    WatermarkerSettings settings = new WatermarkerSettings();
>    settings.setSearchableObjects(new SearchableObjects());
>    settings.getSearchableObjects().setEmailSearchableObjects(EmailSearchableObjects.Subject
>                                                            | EmailSearchableObjects.HtmlBody
>                                                            | EmailSearchableObjects.PlainTextBody);
>    FileInputStream inputStream = new FileInputStream("D:\\test.msg");
>    FileOutputStream outputStream = new FileOutputStream("D:\\modified_test.msg");
>    EmailLoadOptions loadOptions = new EmailLoadOptions();
>    Watermarker watermarker = new Watermarker(inputStream, loadOptions, settings);
>    SearchCriteria criteria = new TextSearchCriteria("test", false);
>    // Note, search is performed only if you pass TextSearchCriteria instance to search() method
>    PossibleWatermarkCollection watermarks = watermarker.search(criteria);
>    // Remove found text fragments
>    watermarks.clear();
>    // Save changes
>    watermarker.save(outputStream);
>    watermarker.close();
>    outputStream.close();
>    inputStream.close();
>
> ```
> ```

[Loading documents]: https://docs.groupdocs.com/display/watermarknet/Loading+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.InputStream | The stream to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Watermarker(System.IO.Stream document, LoadOptions options, WatermarkerSettings settings)
```
public Watermarker(System.IO.Stream document, LoadOptions options, WatermarkerSettings settings)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | com.aspose.ms.System.IO.Stream |  |
| options | LoadOptions |  |
| settings | WatermarkerSettings |  |

##### getSearchableObjects()
```
public final SearchableObjects getSearchableObjects()
```

Gets the content objects that are to be included in a watermark search.

This mathod also specifies content objects which are used in image search. For more information see `#search(SearchCriteria).search(SearchCriteria)` and `#getImages().getImages()` methods.

Learn more about searching watermarks: [Searching watermarks][].

The following example demonstrates how to remove all XObjects and Artifacts from a pdf document.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\test.pdf");
>    watermarker.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.XObjects
>                                                             | PdfSearchableObjects.Artifacts);
>    PossibleWatermarkCollection watermarks = watermarker.search();
>    // Remove all found objects.
>    watermarks.clear();
>    // Save changes.
>    watermarker.save("D:\\modified_test.pdf");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Returns:**
SearchableObjects - The objects that are to be included in a watermark search.
##### setSearchableObjects(SearchableObjects value)
```
public final void setSearchableObjects(SearchableObjects value)
```

Sets the content objects that are to be included in a watermark search.

This mathod also specifies content objects which are used in image search. For more information see `#search(SearchCriteria).search(SearchCriteria)` and `#getImages().getImages()` methods. Learn more about searching watermarks: [Searching watermarks][].

The following example demonstrates how to remove all XObjects and Artifacts from a pdf document.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\test.pdf");
>    watermarker.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.XObjects
>                                                             | PdfSearchableObjects.Artifacts);
>    PossibleWatermarkCollection watermarks = watermarker.search();
>    // Remove all found objects.
>    watermarks.clear();
>    // Save changes.
>    watermarker.save("D:\\modified_test.pdf");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SearchableObjects | The objects that are to be included in a watermark search. |

##### dispose()
```
public final void dispose()
```

##### close()
```
public final void close()
```

Disposes the current instance.

##### getDocumentInfo()
```
public final IDocumentInfo getDocumentInfo()
```

Gets the information about the format of the loaded document.

Learn more about getting the document information [Get document info][].

The following example demonstrates how to get information about a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\test.ppt");
>    IDocumentInfo info = watermarker.getDocumentInfo();
>    System.out.println("File type: " + info.getFileType());
>    System.out.println("Number of pages: " + info.getPageCount());
>    System.out.println("Document size: " + info.getSize() + " bytes");
>    watermarker.close();
>
> ```
> ```

[Get document info]: https://docs.groupdocs.com/display/watermarkjava/Get+document+info

**Returns:**
IDocumentInfo - The `IDocumentInfo` instance that contains detected information.
##### add(Watermark watermark)
```
public final void add(Watermark watermark)
```

Adds a watermark to the loaded document.

Learn more about adding watermarks: [Adding watermarks][].

The following example demonstrates how to add image and text watermark to a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\input.pdf");
>
>    TextWatermark textWatermark = new TextWatermark("DRAFT", new Font("Arial", 19));
>    textWatermark.setHorizontalAlignment(HorizontalAlignment.Center);
>    textWatermark.setVerticalAlignment(VerticalAlignment.Top);
>    textWatermark.setConsiderParentMargins(true);
>    textWatermark.setForegroundColor(Color.getRed());
>    textWatermark.setBackground(true);
>    textWatermark.setOpacity(0.5);
>    watermarker.add(textWatermark);
>
>    ImageWatermark imageWatermark = new ImageWatermark("D:\\draft.png"));
>    imageWatermark.setHorizontalAlignment(HorizontalAlignment.Center);
>    imageWatermark.setVerticalAlignment(VerticalAlignment.Bottom);
>    imageWatermark.setConsiderParentMargins(true);
>    imageWatermark.setBackground(true);
>    imageWatermark.setOpacity(0.5);
>    watermarker.add(imageWatermark);
>    imageWatermark.close();
>
>    watermarker.save("D:\\output.pdf");
>    watermarker.close();
>
> ```
> ```

[Adding watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the document. |

##### add(Watermark watermark, WatermarkOptions options)
```
public final void add(Watermark watermark, WatermarkOptions options)
```

Adds a watermark to the loaded document using watermark options.

Learn more about adding watermarks: [Adding watermarks][].

The following example demonstrates how to add an image watermark to a particular page of a pdf document.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("D:\\input.pdf", loadOptions);
>
>    ImageWatermark imageWatermark = new ImageWatermark("D:\\draft.png"));
>    PdfXObjectWatermarkOptions options = new PdfXObjectWatermarkOptions();
>    options.setPageIndex(0);
>    watermarker.add(imageWatermark, options);
>    imageWatermark.close();
>
>    watermarker.save("D:\\output.pdf");
>    watermarker.close();
>
> ```
> ```

[Adding watermarks]: https://docs.groupdocs.com/display/watermarkjava/Adding+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the document. |
| options | WatermarkOptions | Additional options to use when adding the watermark. |

##### remove(PossibleWatermark possibleWatermark)
```
public final void remove(PossibleWatermark possibleWatermark)
```

Removes watermark from the document.

Learn more about removing watermarks: [Removing found watermarks][].

The following example demonstrates how to find and remove the first possible watermark containing particular text or image from a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\input.doc");
>    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria("D:\\logo.png");
>    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(Pattern.compile("^Company\\sName$"));
>    PossibleWatermarkCollection watermarks = watermarker.search(textSearchCriteria.or(imageSearchCriteria));
>    if (watermarks.getCount() > 0)
>    {
>        watermarker.remove(watermarks.get_Item(0));
>    }
>
>    watermarker.save("D:\\output.doc");
>    watermarker.close();
>
> ```
> ```

[Removing found watermarks]: https://docs.groupdocs.com/display/watermarkjava/Removing+found+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| possibleWatermark | PossibleWatermark | The watermark to remove. |

##### remove(PossibleWatermarkCollection possibleWatermarks)
```
public final void remove(PossibleWatermarkCollection possibleWatermarks)
```

Removes all watermarks in the collection from the document.

Learn more about removing watermarks: [Removing found watermarks][].

The following example demonstrates how to find and remove all possible watermarks containing particular text or image from a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("D:\\input.doc");
>    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria("D:\\logo.png");
>    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(Pattern.compile("^Company\\sName$"));
>    PossibleWatermarkCollection watermarks = watermarker.search(textSearchCriteria.or(imageSearchCriteria));
>    watermarker.remove(watermarks);
>    watermarker.save("D:\\output.doc");
>    watermarker.close();
>
> ```
> ```

[Removing found watermarks]: https://docs.groupdocs.com/display/watermarkjava/Removing+found+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| possibleWatermarks | PossibleWatermarkCollection | The collection of watermarks to remove. |

##### save(String filePath)
```
public final void save(String filePath)
```

Saves the document to the specified file location.

Learn more about saving the documents [Saving documents][].

The following example demonstrates how to add the watermark and save the document to another file.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.pdf");
>    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
>    watermarker.add(watermark);
>    watermarker.save("output.pdf");
>    watermarker.close();
>
> ```
> ```

[Saving documents]: https://docs.groupdocs.com/display/watermarkjava/Saving+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to save the document data to. |

##### save(OutputStream document)
```
public final void save(OutputStream document)
```

Saves the document to the specified stream.

Learn more about saving the documents [Saving documents][].

The following example demonstrates how to add watermark and save the document to the memory stream.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.pdf");
>    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
>    watermarker.add(watermark);
>    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
>    watermarker.save(outputStream);
>    // ...
>    outputStream.close();
>    watermarker.close();
>
> ```
> ```

[Saving documents]: https://docs.groupdocs.com/display/watermarkjava/Saving+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The stream to save the document data to. |

##### save(String filePath, SaveOptions options)
```
public final void save(String filePath, SaveOptions options)
```

Saves the document to the specified file location using save options.

Learn more about saving the documents [Saving documents][].

The following example demonstrates how to add the watermark and save the document to another file with default `SaveOptions`.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.pdf");
>    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
>    watermarker.add(watermark);
>    watermarker.save("output.pdf", new SaveOptions());
>    watermarker.close();
>
> ```
> ```

[Saving documents]: https://docs.groupdocs.com/display/watermarkjava/Saving+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | java.lang.String | The file path to save the document data to. |
| options | SaveOptions | Additional options to use when saving a document. |

##### save(OutputStream document, SaveOptions options)
```
public final void save(OutputStream document, SaveOptions options)
```

Saves the document to the specified stream using save options.

Learn more about saving the documents [Saving documents][].

The following example demonstrates how to add watermark and save the document to the memory stream with default `SaveOptions`.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.pdf");
>    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
>    watermarker.add(watermark);
>    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
>    watermarker.save(outputStream, new SaveOptions());
>    // ...
>    outputStream.close();
>    watermarker.close();
>
> ```
> ```

[Saving documents]: https://docs.groupdocs.com/display/watermarkjava/Saving+documents

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| document | java.io.OutputStream | The stream to save the document data to. |
| options | SaveOptions | Additional options to use when saving a document. |

##### generatePreview(PreviewOptions previewOptions)
```
public final void generatePreview(PreviewOptions previewOptions)
```

Generates preview images for the document.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | Additional options to use when generating preview images. |

##### search()
```
public final PossibleWatermarkCollection search()
```

Searches all possible watermarks in the document.

The search is conducted in objects specified with `#setSearchableObjects(SearchableObjects).setSearchableObjects(SearchableObjects)`.

Learn more about searching watermarks [Searching watermarks][].

The following example demonstrates how to count the possible watermarks in a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.doc");
>    PossibleWatermarkCollection watermarks = watermarker.search();
>    System.out.println(watermarks.getCount());
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Returns:**
PossibleWatermarkCollection
##### search(SearchCriteria searchCriteria)
```
public final PossibleWatermarkCollection search(SearchCriteria searchCriteria)
```

Searches possible watermarks according to specified search criteria.

The search is conducted in objects specified with `#setSearchableObjects(SearchableObjects).setSearchableObjects(SearchableObjects)`.

Learn more about searching watermarks [Searching watermarks][].

The following example demonstrates how to find and remove all possible watermarks containing particular text or image from a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.doc");
>    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria("logo.png");
>    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(Pattern.compile("^Company\\sName$"));
>    PossibleWatermarkCollection watermarks = watermarker.search(textSearchCriteria.or(imageSearchCriteria));
>    watermarks.clear();
>    watermarker.save("output.doc");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | SearchCriteria | The search criteria to use. |

**Returns:**
PossibleWatermarkCollection
##### getImages(ImageSearchCriteria searchCriteria)
```
public final WatermarkableImageCollection getImages(ImageSearchCriteria searchCriteria)
```

Finds images according to specified search criteria.

The search is conducted in objects specified with `#setSearchableObjects(SearchableObjects).setSearchableObjects(SearchableObjects)`.

Learn more about searching watermarks [Searching watermarks][].

The following example demonstrates how to remove all images that are similar to the reference from a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.doc");
>    ImageThumbnailSearchCriteria criteria = new ImageThumbnailSearchCriteria("reference.png");
>    WatermarkableImageCollection images = watermarker.getImages(criteria);
>    images.clear();
>    watermarker.save("output.doc");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | ImageSearchCriteria | The search criteria to use. |

**Returns:**
WatermarkableImageCollection
##### getImages()
```
public final WatermarkableImageCollection getImages()
```

Finds all images in the document.

The search is conducted in objects specified with `#setSearchableObjects(SearchableObjects).setSearchableObjects(SearchableObjects)`.

Learn more about searching watermarks [Searching watermarks][].

The following example demonstrates how to add watermark to all images in a document of any supported type.

> ```
> ```
>
>    Watermarker watermarker = new Watermarker("input.doc");
>    // Initialize text or image watermark.
>    TextWatermark watermark = new TextWatermark("DRAFT", new Font("Arial", 19));
>
>    // Find all images in the document.
>    WatermarkableImageCollection images = watermarker.getImages();
>
>    // Add watermark.
>    for (WatermarkableImage watermarkableImage : images)
>    {
>        watermarkableImage.addWatermark(watermark);
>    }
>
>    // Save changes.
>    watermarker.save("output.doc");
>    watermarker.close();
>
> ```
> ```

[Searching watermarks]: https://docs.groupdocs.com/display/watermarkjava/Searching+watermarks

**Returns:**
WatermarkableImageCollection - The collection of found images.
##### <T>getContent(Class<T> contentType)
```
public final T <T>getContent(Class<T> contentType)
```

Returns the `Content` object for the loaded document.

The following example demonstrates how to rasterize pdf document page with added watermark.

> ```
> ```
>
>    PdfLoadOptions loadOptions = new PdfLoadOptions();
>    Watermarker watermarker = new Watermarker("input.pdf", loadOptions);
>    ImageWatermark watermark = new ImageWatermark("watermark.png")
>    watermarker.add(watermark);
>    PdfContent content = watermarker.getContent(PdfContent.class);
>    content.rasterize(300, 300, PdfImageConversionFormat.Png);
>    watermarker.save("output.pdf");
>    watermarker.close();
>
> ```
> ```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| contentType | java.lang.Class<T> | The requested type of a `Content` object. |

**Returns:**
T - The `Content` object for the loaded document.

### WatermarkerSettings
Path: https://reference.groupdocs.com/watermark/java/com.groupdocs.watermark/watermarkersettings.md

**Inheritance:**
java.lang.Object
```
public final class WatermarkerSettings
```

Defines settings for customizing Watermarker behaviour.
#### Constructors

| Constructor | Description |
| --- | --- |
| WatermarkerSettings() | Initializes new instance of  WatermarkerSettings  class. |
#### Methods

| Method | Description |
| --- | --- |
| getSearchableObjects() | Gets  SearchableObjects  that are to be included in a watermark search. |
| setSearchableObjects(SearchableObjects value) | Sets  SearchableObjects  that are to be included in a watermark search. |
| getLogger() | Gets the logger which is used for logging events and errors during watermarking. |
| setLogger(ILogger value) | Sets the logger which is used for logging events and errors during watermarking. |
| logError(WatermarkException exception, String format, Object[] args) |  |
| logError(WatermarkException exception) |  |
| logWarning(String format, Object[] args) |  |
| logTrace(String format, Object[] args) |  |
##### WatermarkerSettings()
```
public WatermarkerSettings()
```

Initializes new instance of  WatermarkerSettings  class.

##### getSearchableObjects()
```
public final SearchableObjects getSearchableObjects()
```

Gets  SearchableObjects  that are to be included in a watermark search.

**Returns:**
SearchableObjects - The  SearchableObjects  that are to be included in a watermark search.
##### setSearchableObjects(SearchableObjects value)
```
public final void setSearchableObjects(SearchableObjects value)
```

Sets  SearchableObjects  that are to be included in a watermark search.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | SearchableObjects | The  SearchableObjects  that are to be included in a watermark search. |

##### getLogger()
```
public final ILogger getLogger()
```

Gets the logger which is used for logging events and errors during watermarking.

**Returns:**
ILogger - An instance of class that implements `ILogger` interface.
##### setLogger(ILogger value)
```
public final void setLogger(ILogger value)
```

Sets the logger which is used for logging events and errors during watermarking.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | ILogger | An instance of class that implements `ILogger` interface. |

##### logError(WatermarkException exception, String format, Object[] args)
```
public final void logError(WatermarkException exception, String format, Object[] args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| exception | WatermarkException |  |
| format | java.lang.String |  |
| args | java.lang.Object[] |  |

##### logError(WatermarkException exception)
```
public final void logError(WatermarkException exception)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| exception | WatermarkException |  |

##### logWarning(String format, Object[] args)
```
public final void logWarning(String format, Object[] args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String |  |
| args | java.lang.Object[] |  |

##### logTrace(String format, Object[] args)
```
public final void logTrace(String format, Object[] args)
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| format | java.lang.String |  |
| args | java.lang.Object[] |  |

## .NET

### GroupDocs.Watermark for .NET
Path: https://reference.groupdocs.com/watermark/net.md

#### Namespaces

| Namespace | Description |
| --- | --- |
| GroupDocs.Watermark | The namespace provides classes for working with watermarks in a document of any supported type. |
| GroupDocs.Watermark.Common | The namespace provides helper classes. |
| GroupDocs.Watermark.Contents | The namespace provides classes for working with documents of any supported types. |
| GroupDocs.Watermark.Contents.Diagram | The namespace provides classes for working with watermarks in Visio documents. |
| GroupDocs.Watermark.Contents.Email | The namespace provides classes for working with email messages. |
| GroupDocs.Watermark.Contents.Image | The namespace provides classes for adding watermarks to images of different formats. |
| GroupDocs.Watermark.Contents.Pdf | The namespace provides classes for working with watermarks in pdf documents. |
| GroupDocs.Watermark.Contents.Presentation | The namespace provides classes for working with watermarks in PowerPoint documents. |
| GroupDocs.Watermark.Contents.Spreadsheet | The namespace provides classes for working with watermarks in Excel documents. |
| GroupDocs.Watermark.Contents.WordProcessing | The namespace provides classes for working with watermarks in Word documents. |
| GroupDocs.Watermark.Exceptions | The namespace provides different exceptions classes. |
| GroupDocs.Watermark.Internal | The namespace provides internal classes. |
| GroupDocs.Watermark.Options | The namespace provides classes to specify additional options when working with documents and watermarks. |
| GroupDocs.Watermark.Options.Diagram | The namespace provides classes to specify additional options when working with watermarks in Visio documents. |
| GroupDocs.Watermark.Options.Email | The namespace provides classes to specify additional options when loading and saving Email messages. |
| GroupDocs.Watermark.Options.Image | The namespace provides classes to specify additional options when working with watermarks and images. |
| GroupDocs.Watermark.Options.Pdf | The namespace provides classes to specify additional options when working with watermarks and PDF documents. |
| GroupDocs.Watermark.Options.Presentation | The namespace provides classes to specify additional options when working witharks and PowerPoint documents. |
| GroupDocs.Watermark.Options.Spreadsheet | The namespace provides classes to specify additional options when working with watermarks and Excel documents. |
| GroupDocs.Watermark.Options.WordProcessing | The namespace provides classes to specify additional options when working with watermarks and Word documents. |
| GroupDocs.Watermark.Search | The namespace provides classes for searching, editing and removing watermarks in documents of different types. |
| GroupDocs.Watermark.Search.Objects | The namespace provides classes for document objects that are to be included in a watermark search. |
| GroupDocs.Watermark.Search.SearchCriteria | The namespace provides classes that can be used to construct criteria when searching for watermarks. |
| GroupDocs.Watermark.Search.Watermarks | The namespace provides classes of possible watermarks found in documents of different formats. |
| GroupDocs.Watermark.Watermarks | The namespace provides classes to specify properties of watermarks. |
| GroupDocs.Watermark.Watermarks.Results |  |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### GroupDocs.Watermark.Common
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common.md

The namespace provides helper classes.

#### Classes

| Class | Description |
| --- | --- |
| Attachment | Represents a file attached to a document. |
| AttachmentWatermarkableImage | Represents an attached image inside a content of any supported type. |
| FileType | Represents file type. |
| PageInfo | Represents a document page description. |
| Point | Represents a point with integer pixel coordinates. |
| ReadOnlyListBase&lt;T&gt; | Provides the abstract base class for a strongly typed read-only list. |
| Rectangle | Represents a rectangle with integer pixel coordinates. |
| RemoveOnlyListBase&lt;T&gt; | Provides the abstract base class for a strongly typed remove-only list. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IDocumentInfo | Defines the methods that are required for getting the basic document information. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| Dimension | Represents dimensions of a 2d object. |
| FormatFamily | Enumeration of supported format families. |
| HorizontalAlignment | Enumeration of possible horizontal alignment values. |
| InpaintingMethod | Specifies the algorithm used for image inpainting. |
| VerticalAlignment | Enumeration of possible vertical alignment values. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### Attachment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/attachment.md

#### Attachment class

Represents a file attached to a document.

```csharp
public abstract class Attachment
```

#### Properties

| Name | Description |
| --- | --- |
| abstract Content { get; set; } | Gets or sets the attached file content. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

### Content
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/attachment/content.md

#### Attachment.Content property

Gets or sets the attached file content.

```csharp
public abstract byte[] Content { get; set; }
```

##### Property Value

The attached file content.

### CreateWatermarker
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/attachment/createwatermarker.md

#### CreateWatermarker()

Loads a content from the attached file.

```csharp
public Watermarker CreateWatermarker()
```

##### Return Value

The instance of appropriate descendant of `Content` class.

#### CreateWatermarker(LoadOptions)

Loads a content from the attached file with the specified load options.

```csharp
public Watermarker CreateWatermarker(LoadOptions loadOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | Additional options to use when loading an attachment content. |

##### Return Value

The instance of appropriate descendant of `Content` class.

#### CreateWatermarker(LoadOptions, WatermarkerSettings)

Loads a content from the attached file with the specified load options and settings.

```csharp
public Watermarker CreateWatermarker(LoadOptions loadOptions, 
    WatermarkerSettings watermarkerSettings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | LoadOptions | Additional options to use when loading an attachment content. |
| watermarkerSettings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Return Value

The instance of appropriate descendant of `Content` class.

### GetDocumentInfo
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/attachment/getdocumentinfo.md

#### Attachment.GetDocumentInfo method

Gets the information about a document stored in the attached file.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

The `IDocumentInfo` instance that contains detected information

### AttachmentWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/attachmentwatermarkableimage.md

#### AttachmentWatermarkableImage class

Represents an attached image inside a content of any supported type.

```csharp
public class AttachmentWatermarkableImage : WatermarkableImage
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Dimension
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/dimension.md

#### Dimension enumeration

Represents dimensions of a 2d object.

```csharp
public enum Dimension
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Width | `0` | Object width. |
| Height | `1` | Object height. |

### FileType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype.md

#### FileType class

Represents file type.

```csharp
public sealed class FileType : IEquatable<FileType>
```

#### Properties

| Name | Description |
| --- | --- |
| Extension { get; } | Gets the file name suffix (including the period ".") e.g., ".doc". |
| FileFormatName { get; } | Gets the file type name e.g., "Microsoft Word Document". |
| FormatFamily { get; } | Gets the format family. |

#### Methods

| Name | Description |
| --- | --- |
| static FromExtension(string) | Maps the file extension to the file type. |
| Equals(FileType) | Determines whether the current `FileType` is the same as the specified `FileType` object. |
| override Equals(object) | Determines whether the current `FileType` is the same as the specified object. |
| override GetHashCode() | Returns a hash code for the current `FileType` object. |
| override ToString() | Returns a string that represents the current object. |
| static GetSupportedFileTypes() | Retrieves the supported file types. |
| operator == | Determines whether two `FileType` objects are the same. |
| operator != | Determines whether two `FileType` objects are not the same. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly BMP | Files having extension .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 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 EML | EML file format represents email messages saved using Outlook and other relevant applications. 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 FlatOpc | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML). |
| static readonly FlatOpcMacroEnabled | Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML). |
| static readonly FlatOpcTemplate | Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML). |
| static readonly FlatOpcTemplateMacroEnabled | Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML). |
| static readonly GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/). |
| static readonly JPEG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/). |
| static readonly JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| static readonly JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/). |
| 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 ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/). |
| static readonly OFT | Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format [here](https://wiki.fileformat.com/email/oft/). |
| static readonly OOXML | Office open xml file (.ooxml). |
| 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/). |
| static readonly PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/). |
| 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/). |
| 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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/). |
| static readonly TIF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly TIFF | TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/). |
| static readonly Unknown | Represents unknown file type. |
| 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Learn more about this file format [here](https://wiki.fileformat.com/image/vtx/). |
| 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 XLS | Files with XLS extension represent 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/specification/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/specification/spreadsheet/xlsb/). |
| static readonly XLSM | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/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/specification/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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/). |
| static readonly XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/). |
| static readonly XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/). |

##### Remarks

This class provides methods to obtain list of all file types supported by **GroupDocs.Watermark**.**Learn more**

* [Supported Document Formats](https://docs.groupdocs.com/display/watermarknet/Supported+Document+Formats)
* [Get supported file formats](https://docs.groupdocs.com/display/watermarknet/Get+supported+file+formats)
* [Get document info](https://docs.groupdocs.com/display/watermarknet/Get+document+info)

### BMP
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/bmp.md

#### FileType.BMP field

Files having extension .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 FileType BMP;
```

### DOC
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/doc.md

#### FileType.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 FileType DOC;
```

### DOCM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/docm.md

#### FileType.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 FileType DOCM;
```

### DOCX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/docx.md

#### FileType.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 FileType DOCX;
```

### DOT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/dot.md

#### FileType.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 FileType DOT;
```

### DOTM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/dotm.md

#### FileType.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 FileType DOTM;
```

### DOTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/dotx.md

#### FileType.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 FileType DOTX;
```

### EML
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/eml.md

#### FileType.EML field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format [here](https://wiki.fileformat.com/email/eml/).

```csharp
public static readonly FileType EML;
```

### EMLX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/emlx.md

#### FileType.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 FileType EMLX;
```

### Equals
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/equals.md

#### Equals(FileType)

Determines whether the current `FileType` is the same as the specified `FileType` object.

```csharp
public bool Equals(FileType other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | FileType | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

.

#### Equals(object)

Determines whether the current `FileType` is the same as the specified object.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to compare with the current `FileType` object. |

##### Return Value

```csharp
true
```

if

```csharp
obj
```

parameter is `FileType` and is the same as current `FileType` object; otherwise,

```csharp
false
```

.

### Extension
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/extension.md

#### FileType.Extension property

Gets the file name suffix (including the period ".") e.g., ".doc".

```csharp
public string Extension { get; }
```

##### Property Value

The file name suffix (including the period ".").

### FileFormatName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/fileformatname.md

#### FileType.FileFormatName property

Gets the file type name e.g., "Microsoft Word Document".

```csharp
public string FileFormatName { get; }
```

##### Property Value

The file type name.

### FlatOpc
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/flatopc.md

#### FileType.FlatOpc field

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML).

```csharp
public static readonly FileType FlatOpc;
```

### FlatOpcMacroEnabled
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/flatopcmacroenabled.md

#### FileType.FlatOpcMacroEnabled field

Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML).

```csharp
public static readonly FileType FlatOpcMacroEnabled;
```

### FlatOpcTemplate
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/flatopctemplate.md

#### FileType.FlatOpcTemplate field

Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML).

```csharp
public static readonly FileType FlatOpcTemplate;
```

### FlatOpcTemplateMacroEnabled
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/flatopctemplatemacroenabled.md

#### FileType.FlatOpcTemplateMacroEnabled field

Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format [here](https://en.wikipedia.org/wiki/Office_Open_XML).

```csharp
public static readonly FileType FlatOpcTemplateMacroEnabled;
```

### FormatFamily
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/formatfamily.md

#### FileType.FormatFamily property

Gets the format family.

```csharp
public FormatFamily FormatFamily { get; }
```

##### Property Value

The format family.

### FromExtension
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/fromextension.md

#### FileType.FromExtension method

Maps the file extension to the file type.

```csharp
public static FileType FromExtension(string extension)
```

| Parameter | Type | Description |
| --- | --- | --- |
| extension | String | The file extension (including the period "."). |

##### Return Value

When the file type is supported returns it, otherwise returns the default `Unknown` file type.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentException | Thrown when *extension* is null or empty string. |

### GetHashCode
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/gethashcode.md

#### FileType.GetHashCode method

Returns a hash code for the current `FileType` object.

```csharp
public override int GetHashCode()
```

##### Return Value

A hash code for the current `FileType` object.

### GetSupportedFileTypes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/getsupportedfiletypes.md

#### FileType.GetSupportedFileTypes method

Retrieves the supported file types.

```csharp
public static IEnumerable<FileType> GetSupportedFileTypes()
```

##### Return Value

Returns the sequence of the supported file types.

### GIF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/gif.md

#### FileType.GIF field

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format [here](https://wiki.fileformat.com/image/gif/).

```csharp
public static readonly FileType GIF;
```

### JPEG
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/jpeg.md

#### FileType.JPEG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPEG;
```

### JPF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/jpf.md

#### FileType.JPF field

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPF;
```

### JPG
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/jpg.md

#### FileType.JPG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format [here](https://wiki.fileformat.com/image/jpeg/).

```csharp
public static readonly FileType JPG;
```

### JPM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/jpm.md

#### FileType.JPM field

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPM;
```

### JPX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/jpx.md

#### FileType.JPX field

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format [here](https://wiki.fileformat.com/image/jp2/).

```csharp
public static readonly FileType JPX;
```

### MSG
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/msg.md

#### FileType.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 FileType MSG;
```

### ODT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/odt.md

#### FileType.ODT field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/odt/).

```csharp
public static readonly FileType ODT;
```

### OFT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/oft.md

#### FileType.OFT field

Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format [here](https://wiki.fileformat.com/email/oft/).

```csharp
public static readonly FileType OFT;
```

### OOXML
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/ooxml.md

#### FileType.OOXML field

Office open xml file (.ooxml).

```csharp
public static readonly FileType OOXML;
```

### op_Equality
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/op_equality.md

#### FileType Equality operator

Determines whether two `FileType` objects are the same.

```csharp
public static bool operator ==(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are the same; otherwise,

```csharp
false
```

.

### op_Inequality
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/op_inequality.md

#### FileType Inequality operator

Determines whether two `FileType` objects are not the same.

```csharp
public static bool operator !=(FileType left, FileType right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | FileType | Left `FileType` object. |
| right | FileType | Right `FileType` object. |

##### Return Value

```csharp
true
```

if both `FileType` objects are not the same; otherwise,

```csharp
false
```

.

### PDF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/pdf.md

#### FileType.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 FileType PDF;
```

### PNG
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/png.md

#### FileType.PNG field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format [here](https://wiki.fileformat.com/image/png/).

```csharp
public static readonly FileType PNG;
```

### POTM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/potm.md

#### FileType.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 FileType POTM;
```

### POTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/potx.md

#### FileType.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 FileType POTX;
```

### PPS
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/pps.md

#### FileType.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 FileType PPS;
```

### PPSM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/ppsm.md

#### FileType.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 FileType PPSM;
```

### PPSX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/ppsx.md

#### FileType.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 FileType PPSX;
```

### PPT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/ppt.md

#### FileType.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 FileType PPT;
```

### PPTM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/pptm.md

#### FileType.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 FileType PPTM;
```

### PPTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/pptx.md

#### FileType.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 FileType PPTX;
```

### RTF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/rtf.md

#### FileType.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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format [here](https://wiki.fileformat.com/word-processing/rtf/).

```csharp
public static readonly FileType RTF;
```

### TIF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/tif.md

#### FileType.TIF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIF;
```

### TIFF
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/tiff.md

#### FileType.TIFF field

TIFF or 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. Learn more about this file format [here](https://wiki.fileformat.com/image/tiff/).

```csharp
public static readonly FileType TIFF;
```

### ToString
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/tostring.md

#### FileType.ToString method

Returns a string that represents the current object.

```csharp
public override string ToString()
```

##### Return Value

A string that represents the current object.

### Unknown
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/unknown.md

#### FileType.Unknown field

Represents unknown file type.

```csharp
public static readonly FileType Unknown;
```

### VDW
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vdw.md

#### FileType.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 FileType VDW;
```

### VDX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vdx.md

#### FileType.VDX field

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format [here](https://wiki.fileformat.com/image/vdx/).

```csharp
public static readonly FileType VDX;
```

### VSD
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vsd.md

#### FileType.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 FileType VSD;
```

### VSDM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vsdm.md

#### FileType.VSDM field

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdm/).

```csharp
public static readonly FileType VSDM;
```

### VSDX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vsdx.md

#### FileType.VSDX field

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format [here](https://wiki.fileformat.com/image/vsdx/).

```csharp
public static readonly FileType VSDX;
```

### VSS
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vss.md

#### FileType.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 FileType VSS;
```

### VSSM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vssm.md

#### FileType.VSSM field

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format [here](https://wiki.fileformat.com/image/vssm/).

```csharp
public static readonly FileType VSSM;
```

### VSSX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vssx.md

#### FileType.VSSX field

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format [here](https://wiki.fileformat.com/image/vssx/).

```csharp
public static readonly FileType VSSX;
```

### VST
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vst.md

#### FileType.VST field

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. Learn more about this file format [here](https://wiki.fileformat.com/image/vst/).

```csharp
public static readonly FileType VST;
```

### VSTM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vstm.md

#### FileType.VSTM field

Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format [here](https://wiki.fileformat.com/image/vstm/).

```csharp
public static readonly FileType VSTM;
```

### VSTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vstx.md

#### FileType.VSTX field

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format [here](https://wiki.fileformat.com/image/vstx/).

```csharp
public static readonly FileType VSTX;
```

### VSX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vsx.md

#### FileType.VSX field

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format [here](https://wiki.fileformat.com/image/vsx/).

```csharp
public static readonly FileType VSX;
```

### VTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/vtx.md

#### FileType.VTX field

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format [here](https://wiki.fileformat.com/image/vtx/).

```csharp
public static readonly FileType VTX;
```

### WEBP
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/webp.md

#### FileType.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 FileType WEBP;
```

### XLS
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xls.md

#### FileType.XLS field

Files with XLS extension represent 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/specification/spreadsheet/xls/).

```csharp
public static readonly FileType XLS;
```

### XLSB
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xlsb.md

#### FileType.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/specification/spreadsheet/xlsb/).

```csharp
public static readonly FileType XLSB;
```

### XLSM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xlsm.md

#### FileType.XLSM field

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlsm/).

```csharp
public static readonly FileType XLSM;
```

### XLSX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xlsx.md

#### FileType.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/specification/spreadsheet/xlsx/).

```csharp
public static readonly FileType XLSX;
```

### XLT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xlt.md

#### FileType.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. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xlt/).

```csharp
public static readonly FileType XLT;
```

### XLTM
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xltm.md

#### FileType.XLTM field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltm/).

```csharp
public static readonly FileType XLTM;
```

### XLTX
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/filetype/xltx.md

#### FileType.XLTX field

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format [here](https://wiki.fileformat.com/specification/spreadsheet/xltx/).

```csharp
public static readonly FileType XLTX;
```

### FormatFamily
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/formatfamily.md

#### FormatFamily enumeration

Enumeration of supported format families.

```csharp
public enum FormatFamily
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Unknown | `0` | Unknown format family. |
| Diagram | `1` | Diagram format family. |
| Email | `2` | Email format family. |
| Image | `3` | Image format family. |
| MultiframeImage | `4` | Multi frame image format family. |
| Pdf | `5` | PDF format family. |
| Presentation | `6` | Presentation format family. |
| Spreadsheet | `7` | Spreadsheet format family. |
| WordProcessing | `8` | Word processing format family. |

### HorizontalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/horizontalalignment.md

#### HorizontalAlignment enumeration

Enumeration of possible horizontal alignment values.

```csharp
public enum HorizontalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No alignment (use specified position). |
| Left | `1` | Align to left. |
| Center | `2` | Center alignment. |
| Right | `3` | Align to right. |

### IDocumentInfo
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo.md

#### IDocumentInfo interface

Defines the methods that are required for getting the basic document information.

```csharp
public interface IDocumentInfo
```

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; } | Gets the file format description. |
| IsEncrypted { get; } | Gets a value indicating whether the document is encrypted and requires a password to open. |
| PageCount { get; } | Gets the total page count. |
| Pages { get; } | Gets the collection of document pages descriptions. |
| Size { get; } | Gets the document size in bytes. |

##### Examples

The following example demonstrates how to retrieve the general document information using `IDocumentInfo`.

```csharp
using (Watermarker watermarker = new Watermarker("D:\\input.pdf"))
{
    IDocumentInfo docInfo = watermarker.GetDocumentInfo();
    Console.WriteLine("Document size: {0}", docInfo.Size);
    Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
    Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
}
```

### FileType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo/filetype.md

#### IDocumentInfo.FileType property

Gets the file format description.

```csharp
public FileType FileType { get; }
```

##### Property Value

The file format description.

### IsEncrypted
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo/isencrypted.md

#### IDocumentInfo.IsEncrypted property

Gets a value indicating whether the document is encrypted and requires a password to open.

```csharp
public bool IsEncrypted { get; }
```

##### Property Value

True if the document is encrypted and requires a password to open; otherwise, false.

### PageCount
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo/pagecount.md

#### IDocumentInfo.PageCount property

Gets the total page count.

```csharp
public int PageCount { get; }
```

##### Property Value

The total page count.

### Pages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo/pages.md

#### IDocumentInfo.Pages property

Gets the collection of document pages descriptions.

```csharp
public IList<PageInfo> Pages { get; }
```

##### Property Value

The collection of document pages descriptions.

### Size
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/idocumentinfo/size.md

#### IDocumentInfo.Size property

Gets the document size in bytes.

```csharp
public long Size { get; }
```

##### Property Value

The document size in bytes.

### InpaintingMethod
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/inpaintingmethod.md

#### InpaintingMethod enumeration

Specifies the algorithm used for image inpainting.

```csharp
public enum InpaintingMethod
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PatchBased | `0` | Patch-based inpainting (Criminisi-style). Finds similar texture patches in the known region and copies them into the mask. |
| Telea | `1` | Telea algorithm. A fast marching method that propagates pixel values from the region boundary inward. |

### PageInfo
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/pageinfo.md

#### PageInfo class

Represents a document page description.

```csharp
public sealed class PageInfo
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the document page height. |
| PageNumber { get; } | Gets the document page number. |
| Width { get; } | Gets the document page width. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/pageinfo/height.md

#### PageInfo.Height property

Gets the document page height.

```csharp
public double Height { get; }
```

##### Property Value

The document page height.

### PageNumber
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/pageinfo/pagenumber.md

#### PageInfo.PageNumber property

Gets the document page number.

```csharp
public int PageNumber { get; }
```

##### Property Value

The document page number.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/pageinfo/width.md

#### PageInfo.Width property

Gets the document page width.

```csharp
public double Width { get; }
```

##### Property Value

The document page width.

### Point
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/point.md

#### Point class

Represents a point with integer pixel coordinates.

```csharp
public class Point
```

#### Constructors

| Name | Description |
| --- | --- |
| Point(int, int) | Initializes a new instance of the `Point` class. |

#### Properties

| Name | Description |
| --- | --- |
| X { get; } | Gets the x-coordinate of this point. |
| Y { get; } | Gets the y-coordinate of this point. |

### Point
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/point/point.md

#### Point constructor

Initializes a new instance of the `Point` class.

```csharp
public Point(int x, int y)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Int32 | The x-coordinate of the point. |
| y | Int32 | The y-coordinate of the point. |

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/point/x.md

#### Point.X property

Gets the x-coordinate of this point.

```csharp
public int X { get; }
```

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/point/y.md

#### Point.Y property

Gets the y-coordinate of this point.

```csharp
public int Y { get; }
```

### ReadOnlyListBaseT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1.md

#### ReadOnlyListBase&lt;T&gt; class

Provides the abstract base class for a strongly typed read-only list.

```csharp
public abstract class ReadOnlyListBase<T> : IList, IList<T>
```

| Parameter | Description |
| --- | --- |
| T | The type of the element. |

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(T) | Determines whether the collection contains a specific item. |
| virtual GetEnumerator() | Returns an enumerator that iterates through a collection. |
| virtual IndexOf(T) | Determines the index of a specific item in the collection. |

### Contains
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/contains.md

#### ReadOnlyListBase&lt;T&gt;.Contains method

Determines whether the collection contains a specific item.

```csharp
public virtual bool Contains(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

True if the item is found in the collection; otherwise, false.

### Count
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/count.md

#### ReadOnlyListBase&lt;T&gt;.Count property

Gets the number of elements contained in the collection.

```csharp
public virtual int Count { get; }
```

##### Property Value

The number of elements contained in the collection.

### GetEnumerator
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/getenumerator.md

#### ReadOnlyListBase&lt;T&gt;.GetEnumerator method

Returns an enumerator that iterates through a collection.

```csharp
public virtual IEnumerator<T> GetEnumerator()
```

##### Return Value

An IEnumerator object that can be used to iterate through the collection.

### IndexOf
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/indexof.md

#### ReadOnlyListBase&lt;T&gt;.IndexOf method

Determines the index of a specific item in the collection.

```csharp
public virtual int IndexOf(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to locate in the collection. |

##### Return Value

The index of *item* if found in the collection; otherwise, -1.

### IsReadOnly
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/isreadonly.md

#### ReadOnlyListBase&lt;T&gt;.IsReadOnly property

Gets a value indicating whether the collection is read-only.

```csharp
public virtual bool IsReadOnly { get; }
```

##### Property Value

True if the collection is read-only; otherwise, false.

### Item
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/readonlylistbase-1/item.md

#### ReadOnlyListBase&lt;T&gt; indexer

Gets the element at the specified index in the collection.

```csharp
public virtual T this[int index] { get; }
```

| Parameter | Description |
| --- | --- |
| index | The zero-based index of the element to get. |

##### Property Value

The element at the specified index.

### Rectangle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle.md

#### Rectangle class

Represents a rectangle with integer pixel coordinates.

```csharp
public class Rectangle
```

#### Constructors

| Name | Description |
| --- | --- |
| Rectangle(int, int, int, int) | Initializes a new instance of the `Rectangle` class. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of the rectangle. |
| Width { get; } | Gets the width of the rectangle. |
| X { get; } | Gets the x-coordinate of the upper-left corner. |
| Y { get; } | Gets the y-coordinate of the upper-left corner. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle/height.md

#### Rectangle.Height property

Gets the height of the rectangle.

```csharp
public int Height { get; }
```

### Rectangle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle/rectangle.md

#### Rectangle constructor

Initializes a new instance of the `Rectangle` class.

```csharp
public Rectangle(int x, int y, int width, int height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| x | Int32 | The x-coordinate of the upper-left corner. |
| y | Int32 | The y-coordinate of the upper-left corner. |
| width | Int32 | The width of the rectangle. |
| height | Int32 | The height of the rectangle. |

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle/width.md

#### Rectangle.Width property

Gets the width of the rectangle.

```csharp
public int Width { get; }
```

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle/x.md

#### Rectangle.X property

Gets the x-coordinate of the upper-left corner.

```csharp
public int X { get; }
```

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/rectangle/y.md

#### Rectangle.Y property

Gets the y-coordinate of the upper-left corner.

```csharp
public int Y { get; }
```

### RemoveOnlyListBaseT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/removeonlylistbase-1.md

#### RemoveOnlyListBase&lt;T&gt; class

Provides the abstract base class for a strongly typed remove-only list.

```csharp
public abstract class RemoveOnlyListBase<T> : ReadOnlyListBase<T>
```

| Parameter | Description |
| --- | --- |
| T | The type of the element. |

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() | Removes all items from the collection. |
| virtual Contains(T) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(T) |  |
| Remove(T) | Removes the first occurrence of a specific object from the collection. |
| RemoveAt(int) | Removes the item at the specified index. |

### Clear
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/removeonlylistbase-1/clear.md

#### RemoveOnlyListBase&lt;T&gt;.Clear method

Removes all items from the collection.

```csharp
public void Clear()
```

### IsReadOnly
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/removeonlylistbase-1/isreadonly.md

#### RemoveOnlyListBase&lt;T&gt;.IsReadOnly property

Gets a value indicating whether the collection is read-only.

```csharp
public override bool IsReadOnly { get; }
```

##### Property Value

Returns true if the collection is read-only; otherwise, false.

### Remove
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/removeonlylistbase-1/remove.md

#### RemoveOnlyListBase&lt;T&gt;.Remove method

Removes the first occurrence of a specific object from the collection.

```csharp
public bool Remove(T item)
```

| Parameter | Type | Description |
| --- | --- | --- |
| item | T | The item to remove from the collection. |

##### Return Value

True if *item* was successfully removed; otherwise false.

### RemoveAt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/removeonlylistbase-1/removeat.md

#### RemoveOnlyListBase&lt;T&gt;.RemoveAt method

Removes the item at the specified index.

```csharp
public void RemoveAt(int index)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index of the item to remove. |

### VerticalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.common/verticalalignment.md

#### VerticalAlignment enumeration

Enumeration of possible vertical alignment values.

```csharp
public enum VerticalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | No alignment (use specified position). |
| Top | `1` | Align to top. |
| Center | `2` | Center alignment. |
| Bottom | `3` | Align to bottom. |

### GroupDocs.Watermark.Contents.Diagram
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram.md

The namespace provides classes for working with watermarks in Visio documents.

#### Classes

| Class | Description |
| --- | --- |
| DiagramContent | Represents a Visio document. |
| DiagramFormattedTextFragment | Represents a fragment of formatted text in a Visio document. |
| DiagramFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Visio document. |
| DiagramHeaderFooter | Represents a header/footer in a Visio document. |
| DiagramHeaderFooterFont | Represents a font that is used in Visio header/footer. |
| DiagramHyperlink | Represents a hyperlink in a Visio document. |
| DiagramHyperlinkCollection | Represents a collection of hyperlinks in a Visio document. |
| DiagramPage | Represents a Visio document page. |
| DiagramPageCollection | Represents a collection of pages in a Visio document. |
| DiagramShape | Represents a drawing shape in a Visio document. |
| DiagramShapeCollection | Represents a collection of drawing shapes in a Visio document. |
| DiagramWatermarkableImage | Represents an image inside a Visio document. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| DiagramWatermarkPlacementType | Specifies to what pages a watermark should be added. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### DiagramContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramcontent.md

#### DiagramContent class

Represents a Visio document.

```csharp
public sealed class DiagramContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| HeaderFooter { get; } | Gets the header and footer of this `DiagramContent`. |
| Pages { get; } | Gets the collection of all pages of this `DiagramContent`. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to diagram documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents)
* [Existing objects in diagram document](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+diagram+document)

### HeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramcontent/headerfooter.md

#### DiagramContent.HeaderFooter property

Gets the header and footer of this `DiagramContent`.

```csharp
public DiagramHeaderFooter HeaderFooter { get; }
```

##### Property Value

The header and footer of this `DiagramContent`.

### Pages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramcontent/pages.md

#### DiagramContent.Pages property

Gets the collection of all pages of this `DiagramContent`.

```csharp
public DiagramPageCollection Pages { get; }
```

##### Property Value

The collection of all pages of this `DiagramContent`.

### DiagramFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment.md

#### DiagramFormattedTextFragment class

Represents a fragment of formatted text in a Visio document.

```csharp
public class DiagramFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/backgroundcolor.md

#### DiagramFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/font.md

#### DiagramFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/foregroundcolor.md

#### DiagramFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/text.md

#### DiagramFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### DiagramFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramformattedtextfragmentcollection.md

#### DiagramFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Visio document.

```csharp
public class DiagramFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains items of `DiagramFormattedTextFragment` type.

### DiagramHeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter.md

#### DiagramHeaderFooter class

Represents a header/footer in a Visio document.

```csharp
public class DiagramHeaderFooter
```

#### Properties

| Name | Description |
| --- | --- |
| Font { get; } | Gets the font used for header and footer text. |
| FooterCenter { get; set; } | Gets or sets the text string that appears in the center portion of document footer. |
| FooterLeft { get; set; } | Gets or sets the text string that appears in the left portion of document footer. |
| FooterMargin { get; set; } | Gets or sets the margin of document header. |
| FooterRight { get; set; } | Gets or sets the text string that appears in the right portion of document footer. |
| HeaderCenter { get; set; } | Gets or sets the text string that appears in the center portion of document header. |
| HeaderLeft { get; set; } | Gets or sets the text string that appears in the left portion of document header. |
| HeaderMargin { get; set; } | Gets or sets the margin of document header. |
| HeaderRight { get; set; } | Gets or sets the text string that appears in the right portion of document header. |
| TextColor { get; set; } | Gets or sets the text color for header and footer. |

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/font.md

#### DiagramHeaderFooter.Font property

Gets the font used for header and footer text.

```csharp
public DiagramHeaderFooterFont Font { get; }
```

##### Property Value

The font used for header and footer text.

### FooterCenter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footercenter.md

#### DiagramHeaderFooter.FooterCenter property

Gets or sets the text string that appears in the center portion of document footer.

```csharp
public string FooterCenter { get; set; }
```

##### Property Value

The text string that appears in the center portion of document footer.

### FooterLeft
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footerleft.md

#### DiagramHeaderFooter.FooterLeft property

Gets or sets the text string that appears in the left portion of document footer.

```csharp
public string FooterLeft { get; set; }
```

##### Property Value

The text string that appears in the left portion of document footer.

### FooterMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footermargin.md

#### DiagramHeaderFooter.FooterMargin property

Gets or sets the margin of document header.

```csharp
public double FooterMargin { get; set; }
```

##### Property Value

The margin of document header.

### FooterRight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footerright.md

#### DiagramHeaderFooter.FooterRight property

Gets or sets the text string that appears in the right portion of document footer.

```csharp
public string FooterRight { get; set; }
```

##### Property Value

The text string that appears in the right portion of document footer.

### HeaderCenter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/headercenter.md

#### DiagramHeaderFooter.HeaderCenter property

Gets or sets the text string that appears in the center portion of document header.

```csharp
public string HeaderCenter { get; set; }
```

##### Property Value

The text string that appears in the center portion of document header.

### HeaderLeft
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/headerleft.md

#### DiagramHeaderFooter.HeaderLeft property

Gets or sets the text string that appears in the left portion of document header.

```csharp
public string HeaderLeft { get; set; }
```

##### Property Value

The text string that appears in the left portion of document header.

### HeaderMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/headermargin.md

#### DiagramHeaderFooter.HeaderMargin property

Gets or sets the margin of document header.

```csharp
public double HeaderMargin { get; set; }
```

##### Property Value

The margin of document header.

### HeaderRight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/headerright.md

#### DiagramHeaderFooter.HeaderRight property

Gets or sets the text string that appears in the right portion of document header.

```csharp
public string HeaderRight { get; set; }
```

##### Property Value

The text string that appears in the right portion of document header.

### TextColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooter/textcolor.md

#### DiagramHeaderFooter.TextColor property

Gets or sets the text color for header and footer.

```csharp
public Color TextColor { get; set; }
```

##### Property Value

The text color for header and footer.

### DiagramHeaderFooterFont
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont.md

#### DiagramHeaderFooterFont class

Represents a font that is used in Visio header/footer.

```csharp
public class DiagramHeaderFooterFont
```

#### Properties

| Name | Description |
| --- | --- |
| Bold { get; set; } | Gets or sets a value indicating whether the font is bold. |
| FamilyName { get; set; } | Gets or sets the font family name. |
| Italic { get; set; } | Gets or sets a value indicating whether the font is italic. |
| Size { get; set; } | Gets or sets the height of the font. |
| Strikeout { get; set; } | Gets or sets a value indicating whether the font is strikeout. |
| Underline { get; set; } | Gets or sets a value indicating whether the font is underline. |

### Bold
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/bold.md

#### DiagramHeaderFooterFont.Bold property

Gets or sets a value indicating whether the font is bold.

```csharp
public bool Bold { get; set; }
```

##### Property Value

True if this font is bold; otherwise, false.

### FamilyName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/familyname.md

#### DiagramHeaderFooterFont.FamilyName property

Gets or sets the font family name.

```csharp
public string FamilyName { get; set; }
```

##### Property Value

The font family name.

### Italic
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/italic.md

#### DiagramHeaderFooterFont.Italic property

Gets or sets a value indicating whether the font is italic.

```csharp
public bool Italic { get; set; }
```

##### Property Value

True if this font is italic; otherwise, false.

### Size
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/size.md

#### DiagramHeaderFooterFont.Size property

Gets or sets the height of the font.

```csharp
public int Size { get; set; }
```

##### Property Value

The height of the font.

### Strikeout
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/strikeout.md

#### DiagramHeaderFooterFont.Strikeout property

Gets or sets a value indicating whether the font is strikeout.

```csharp
public bool Strikeout { get; set; }
```

##### Property Value

True if this font is strikeout; otherwise, false.

### Underline
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/underline.md

#### DiagramHeaderFooterFont.Underline property

Gets or sets a value indicating whether the font is underline.

```csharp
public bool Underline { get; set; }
```

##### Property Value

True if this font is underline; otherwise, false.

### DiagramHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramhyperlink.md

#### DiagramHyperlink class

Represents a hyperlink in a Visio document.

```csharp
public class DiagramHyperlink
```

#### Properties

| Name | Description |
| --- | --- |
| Address { get; } | Gets the hyperlink address. |
| Description { get; } | Gets the description of the hyperlink. |
| SubAddress { get; } | Gets a location within the target content to link to. |

### Address
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramhyperlink/address.md

#### DiagramHyperlink.Address property

Gets the hyperlink address.

```csharp
public string Address { get; }
```

##### Property Value

The hyperlink address.

### Description
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramhyperlink/description.md

#### DiagramHyperlink.Description property

Gets the description of the hyperlink.

```csharp
public string Description { get; }
```

##### Property Value

The description of the hyperlink.

### SubAddress
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramhyperlink/subaddress.md

#### DiagramHyperlink.SubAddress property

Gets a location within the target content to link to.

```csharp
public string SubAddress { get; }
```

##### Property Value

A location within the target content to link to.

### DiagramHyperlinkCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramhyperlinkcollection.md

#### DiagramHyperlinkCollection class

Represents a collection of hyperlinks in a Visio document.

```csharp
public class DiagramHyperlinkCollection : RemoveOnlyListBase<DiagramHyperlink>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(DiagramHyperlink) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(DiagramHyperlink) |  |
| Remove(DiagramHyperlink) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `DiagramHyperlink` type.

### DiagramPage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage.md

#### DiagramPage class

Represents a Visio document page.

```csharp
public class DiagramPage : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| BackgroundPage { get; } | Gets the background page for this `DiagramPage`. |
| BottomMargin { get; } | Gets the size of the bottom margin in points. |
| Height { get; } | Gets the height of this `DiagramPage` in points. |
| IsBackground { get; } | Gets a value indicating whether the page is a background page. |
| IsVisible { get; set; } | Gets or sets a value indicating whether the page is visible in UI. |
| LeftMargin { get; } | Gets the size of the left margin in points. |
| Name { get; } | Gets the name of this `DiagramPage`. |
| RightMargin { get; } | Gets the size of the right margin in points. |
| Shapes { get; } | Gets the collection of all shapes of the page. |
| TopMargin { get; } | Gets the size of the top margin in points. |
| Width { get; } | Gets the width of this `DiagramPage` in points. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### BackgroundPage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/backgroundpage.md

#### DiagramPage.BackgroundPage property

Gets the background page for this `DiagramPage`.

```csharp
public DiagramPage BackgroundPage { get; }
```

##### Property Value

The background page for this `DiagramPage`.

### BottomMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/bottommargin.md

#### DiagramPage.BottomMargin property

Gets the size of the bottom margin in points.

```csharp
public double BottomMargin { get; }
```

##### Property Value

The size of the bottom margin in points.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/height.md

#### DiagramPage.Height property

Gets the height of this `DiagramPage` in points.

```csharp
public double Height { get; }
```

##### Property Value

The height of this `DiagramPage` in points.

### IsBackground
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/isbackground.md

#### DiagramPage.IsBackground property

Gets a value indicating whether the page is a background page.

```csharp
public bool IsBackground { get; }
```

##### Property Value

True if the page is a background page; otherwise, false.

### IsVisible
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/isvisible.md

#### DiagramPage.IsVisible property

Gets or sets a value indicating whether the page is visible in UI.

```csharp
public bool IsVisible { get; set; }
```

##### Property Value

The value indicating whether the page is visible in UI. True if the page is visible; otherwise, false.

### LeftMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/leftmargin.md

#### DiagramPage.LeftMargin property

Gets the size of the left margin in points.

```csharp
public double LeftMargin { get; }
```

##### Property Value

The size of the left margin in points.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/name.md

#### DiagramPage.Name property

Gets the name of this `DiagramPage`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `DiagramPage`.

### RightMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/rightmargin.md

#### DiagramPage.RightMargin property

Gets the size of the right margin in points.

```csharp
public double RightMargin { get; }
```

##### Property Value

The size of the right margin in points.

### Shapes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/shapes.md

#### DiagramPage.Shapes property

Gets the collection of all shapes of the page.

```csharp
public DiagramShapeCollection Shapes { get; }
```

##### Property Value

The collection of all shapes of the page.

### TopMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/topmargin.md

#### DiagramPage.TopMargin property

Gets the size of the top margin in points.

```csharp
public double TopMargin { get; }
```

##### Property Value

The size of the top margin in points.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampage/width.md

#### DiagramPage.Width property

Gets the width of this `DiagramPage` in points.

```csharp
public double Width { get; }
```

##### Property Value

The width of this `DiagramPage` in points.

### DiagramPageCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagrampagecollection.md

#### DiagramPageCollection class

Represents a collection of pages in a Visio document.

```csharp
public class DiagramPageCollection : ReadOnlyListBase<DiagramPage>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(DiagramPage) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(DiagramPage) |  |

##### Remarks

This collection contains the items of `DiagramPage` type.

### DiagramShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape.md

#### DiagramShape class

Represents a drawing shape in a Visio document.

```csharp
public class DiagramShape : ShapeSearchAdapter, IRotatableTwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `DiagramShape`. |
| Height { get; set; } | Gets or sets the height of this `DiagramShape` in points. |
| Hyperlinks { get; } | Gets the collection of hyperlinks attached to this `DiagramShape`. |
| Id { get; } | Gets the identifier of this `DiagramShape`. |
| Image { get; set; } | Gets or sets the image of this `DiagramShape`. |
| Name { get; } | Gets the name of this `DiagramShape`. |
| Page { get; } | Gets the parent page of this `DiagramShape`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `DiagramShape` in degrees. |
| Text { get; set; } | Gets or sets the text of this `DiagramShape`. |
| Width { get; set; } | Gets or sets the width of this `DiagramShape` in points. |
| X { get; set; } | Gets or sets the horizontal offset of this `DiagramShape` from page left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `DiagramShape` from page bottom border in points. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/formattedtextfragments.md

#### DiagramShape.FormattedTextFragments property

Gets the collection of formatted text fragments of this `DiagramShape`.

```csharp
public FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `DiagramShape`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/height.md

#### DiagramShape.Height property

Gets or sets the height of this `DiagramShape` in points.

```csharp
public double Height { get; set; }
```

##### Property Value

The height of this `DiagramShape` in points.

### Hyperlinks
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/hyperlinks.md

#### DiagramShape.Hyperlinks property

Gets the collection of hyperlinks attached to this `DiagramShape`.

```csharp
public DiagramHyperlinkCollection Hyperlinks { get; }
```

##### Property Value

The collection of hyperlinks attached to this `DiagramShape`.

### Id
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/id.md

#### DiagramShape.Id property

Gets the identifier of this `DiagramShape`.

```csharp
public long Id { get; }
```

##### Property Value

The identifier of this `DiagramShape`.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/image.md

#### DiagramShape.Image property

Gets or sets the image of this `DiagramShape`.

```csharp
public DiagramWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `DiagramShape`. Returns null if the shape has no image.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/name.md

#### DiagramShape.Name property

Gets the name of this `DiagramShape`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `DiagramShape`.

### Page
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/page.md

#### DiagramShape.Page property

Gets the parent page of this `DiagramShape`.

```csharp
public DiagramPage Page { get; }
```

##### Property Value

The parent page of this `DiagramShape`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/rotateangle.md

#### DiagramShape.RotateAngle property

Gets or sets the rotate angle of this `DiagramShape` in degrees.

```csharp
public double RotateAngle { get; set; }
```

##### Property Value

The rotate angle of this `DiagramShape` in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/text.md

#### DiagramShape.Text property

Gets or sets the text of this `DiagramShape`.

```csharp
public string Text { get; set; }
```

##### Property Value

The text of this `DiagramShape`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/width.md

#### DiagramShape.Width property

Gets or sets the width of this `DiagramShape` in points.

```csharp
public double Width { get; set; }
```

##### Property Value

The width of this `DiagramShape` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/x.md

#### DiagramShape.X property

Gets or sets the horizontal offset of this `DiagramShape` from page left border in points.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of this `DiagramShape`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshape/y.md

#### DiagramShape.Y property

Gets or sets the vertical offset of this `DiagramShape` from page bottom border in points.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of this `DiagramShape`.

### DiagramShapeCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramshapecollection.md

#### DiagramShapeCollection class

Represents a collection of drawing shapes in a Visio document.

```csharp
public class DiagramShapeCollection : RemoveOnlyListBase<DiagramShape>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(DiagramShape) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(DiagramShape) |  |
| Remove(DiagramShape) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `DiagramShape` type.

### DiagramWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage.md

#### DiagramWatermarkableImage class

Represents an image inside a Visio document.

```csharp
public class DiagramWatermarkableImage : WatermarkableImage
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramWatermarkableImage(byte[]) | Initializes a new instance of the `DiagramWatermarkableImage` class using specified image data. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### DiagramWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/diagramwatermarkableimage.md

#### DiagramWatermarkableImage constructor

Initializes a new instance of the `DiagramWatermarkableImage` class using specified image data.

```csharp
public DiagramWatermarkableImage(byte[] imageData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageData | Byte[] | The array of unsigned bytes from which to create the `DiagramWatermarkableImage`. |

### DiagramWatermarkPlacementType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype.md

#### DiagramWatermarkPlacementType enumeration

Specifies to what pages a watermark should be added.

```csharp
public enum DiagramWatermarkPlacementType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| ForegroundPages | `0` | A watermark should be added to foreground pages only. |
| BackgroundPages | `1` | A watermark should be added to background pages only. |
| AllPages | `2` | A watermark should be added to all pages. |
| SeparateBackgrounds | `3` | Separate background pages with a watermark should be created and assigned to all pages without background. |
| Default | `0` | The same as ForegroundPages. |

### GroupDocs.Watermark.Contents.Email
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email.md

The namespace provides classes for working with email messages.

#### Classes

| Class | Description |
| --- | --- |
| EmailAddress | Represents an address of an email message. |
| EmailAddressCollection | Represents a collection of addresses in an email message. |
| EmailAttachment | Represents a file attached to an email message. |
| EmailAttachmentBase | Provides a base class for email attachments. |
| EmailAttachmentCollection | Represents a collection of attachments in an email message. |
| EmailContent | Represents an email message. |
| EmailEmbeddedObject | Represents an object embedded to an email message body. |
| EmailEmbeddedObjectCollection | Represents a collection of embedded objects in an email message. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| EmailBodyType | Represents a content type of an email message body. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### EmailAddress
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress.md

#### EmailAddress class

Represents an address of an email message.

```csharp
public class EmailAddress
```

#### Properties

| Name | Description |
| --- | --- |
| Address { get; } | Gets the string representation of the email address. |
| DisplayName { get; } | Gets the display name associated with the address. |
| Host { get; } | Gets the host portion of the address. |
| OriginalAddressString { get; } | Gets the original address string. |
| User { get; } | Gets the username. |

### Address
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress/address.md

#### EmailAddress.Address property

Gets the string representation of the email address.

```csharp
public string Address { get; }
```

##### Property Value

The string representation of the email address.

### DisplayName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress/displayname.md

#### EmailAddress.DisplayName property

Gets the display name associated with the address.

```csharp
public string DisplayName { get; }
```

##### Property Value

The display name associated with the address.

### Host
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress/host.md

#### EmailAddress.Host property

Gets the host portion of the address.

```csharp
public string Host { get; }
```

##### Property Value

The host portion of the address.

### OriginalAddressString
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress/originaladdressstring.md

#### EmailAddress.OriginalAddressString property

Gets the original address string.

```csharp
public string OriginalAddressString { get; }
```

##### Property Value

The original address string.

### User
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddress/user.md

#### EmailAddress.User property

Gets the username.

```csharp
public string User { get; }
```

##### Property Value

The username.

### EmailAddressCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailaddresscollection.md

#### EmailAddressCollection class

Represents a collection of addresses in an email message.

```csharp
public class EmailAddressCollection : ReadOnlyListBase<EmailAddress>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(EmailAddress) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(EmailAddress) |  |

##### Remarks

This collection contains the items of `EmailAddress` type.

### EmailAttachment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachment.md

#### EmailAttachment class

Represents a file attached to an email message.

```csharp
public class EmailAttachment : EmailAttachmentBase
```

#### Properties

| Name | Description |
| --- | --- |
| override Content { get; set; } | Gets or sets the attached file content. |
| ContentId { get; } | Gets the content id of this `EmailAttachmentBase`. |
| MediaType { get; } | Gets the media type of this `EmailAttachmentBase`. |
| Name { get; set; } | Gets or sets the name of the attached file. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachment/name.md

#### EmailAttachment.Name property

Gets or sets the name of the attached file.

```csharp
public string Name { get; set; }
```

##### Property Value

The name of the attached file.

### EmailAttachmentBase
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentbase.md

#### EmailAttachmentBase class

Provides a base class for email attachments.

```csharp
public abstract class EmailAttachmentBase : Attachment
```

#### Properties

| Name | Description |
| --- | --- |
| override Content { get; set; } | Gets or sets the attached file content. |
| ContentId { get; } | Gets the content id of this `EmailAttachmentBase`. |
| MediaType { get; } | Gets the media type of this `EmailAttachmentBase`. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

### Content
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentbase/content.md

#### EmailAttachmentBase.Content property

Gets or sets the attached file content.

```csharp
public override byte[] Content { get; set; }
```

##### Property Value

The attached file content.

### ContentId
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentbase/contentid.md

#### EmailAttachmentBase.ContentId property

Gets the content id of this `EmailAttachmentBase`.

```csharp
public string ContentId { get; }
```

##### Property Value

The content id of this `EmailAttachmentBase`.

### MediaType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentbase/mediatype.md

#### EmailAttachmentBase.MediaType property

Gets the media type of this `EmailAttachmentBase`.

```csharp
public string MediaType { get; }
```

##### Property Value

The media type of this `EmailAttachmentBase`.

### EmailAttachmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentcollection.md

#### EmailAttachmentCollection class

Represents a collection of attachments in an email message.

```csharp
public class EmailAttachmentCollection : RemoveOnlyListBase<EmailAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(byte[], string) | Adds an attachment to the `EmailContent`. |
| Clear() |  |
| virtual Contains(EmailAttachment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(EmailAttachment) |  |
| Remove(EmailAttachment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `EmailAttachment` type.

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailattachmentcollection/add.md

#### EmailAttachmentCollection.Add method

Adds an attachment to the `EmailContent`.

```csharp
public void Add(byte[] fileContent, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | Byte[] | The content of the file to be attached. |
| name | String | The name of the file. |

### EmailBodyType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailbodytype.md

#### EmailBodyType enumeration

Represents a content type of an email message body.

```csharp
public enum EmailBodyType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PlainText | `0` | Plain text body. |
| Html | `1` | Html-formatted body. |

### EmailContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent.md

#### EmailContent class

Represents an email message.

```csharp
public sealed class EmailContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| Attachments { get; } | Gets the collection of all attachments of the email message. |
| Bcc { get; } | Gets the collection of BCC (blind carbon copy) recipients of the email message. |
| Body { get; set; } | Gets or sets the plain text representation of the message body. |
| BodyType { get; } | Gets the type of the email message body. |
| Cc { get; } | Gets the collection of CC (carbon copy) recipients of the email message. |
| EmbeddedObjects { get; } | Gets the collection of all embedded objects of the email message. |
| From { get; } | Gets the from address of the email message. |
| HtmlBody { get; set; } | Gets or sets the html representation of the message body. |
| Subject { get; set; } | Gets or sets the subject of the email message. |
| To { get; } | Gets the collection of recipients of the email message. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to email attachments](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+email+attachments)
* [Email attachments](https://docs.groupdocs.com/display/watermarknet/Email+attachments)
* [Email messages](https://docs.groupdocs.com/display/watermarknet/Email+messages)

### Attachments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/attachments.md

#### EmailContent.Attachments property

Gets the collection of all attachments of the email message.

```csharp
public EmailAttachmentCollection Attachments { get; }
```

##### Property Value

The collection of all attachments of the email message.

### Bcc
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/bcc.md

#### EmailContent.Bcc property

Gets the collection of BCC (blind carbon copy) recipients of the email message.

```csharp
public EmailAddressCollection Bcc { get; }
```

##### Property Value

The collection of BCC (blind carbon copy) recipients of the email message.

### Body
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/body.md

#### EmailContent.Body property

Gets or sets the plain text representation of the message body.

```csharp
public string Body { get; set; }
```

##### Property Value

The plain text representation of the message body.

### BodyType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/bodytype.md

#### EmailContent.BodyType property

Gets the type of the email message body.

```csharp
public EmailBodyType BodyType { get; }
```

##### Property Value

The type of the email message body.

### Cc
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/cc.md

#### EmailContent.Cc property

Gets the collection of CC (carbon copy) recipients of the email message.

```csharp
public EmailAddressCollection Cc { get; }
```

##### Property Value

The collection of CC (carbon copy) recipients of the email message.

### EmbeddedObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/embeddedobjects.md

#### EmailContent.EmbeddedObjects property

Gets the collection of all embedded objects of the email message.

```csharp
public EmailEmbeddedObjectCollection EmbeddedObjects { get; }
```

##### Property Value

The collection of all embedded objects of the email message.

### From
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/from.md

#### EmailContent.From property

Gets the from address of the email message.

```csharp
public EmailAddress From { get; }
```

##### Property Value

The from address of the email message.

### HtmlBody
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/htmlbody.md

#### EmailContent.HtmlBody property

Gets or sets the html representation of the message body.

```csharp
public string HtmlBody { get; set; }
```

##### Property Value

The html representation of the message body.

### Subject
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/subject.md

#### EmailContent.Subject property

Gets or sets the subject of the email message.

```csharp
public string Subject { get; set; }
```

##### Property Value

The subject of the email message.

### To
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailcontent/to.md

#### EmailContent.To property

Gets the collection of recipients of the email message.

```csharp
public EmailAddressCollection To { get; }
```

##### Property Value

The collection of recipients of the email message.

### EmailEmbeddedObject
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailembeddedobject.md

#### EmailEmbeddedObject class

Represents an object embedded to an email message body.

```csharp
public class EmailEmbeddedObject : EmailAttachmentBase
```

#### Properties

| Name | Description |
| --- | --- |
| override Content { get; set; } | Gets or sets the attached file content. |
| ContentId { get; } | Gets the content id of this `EmailAttachmentBase`. |
| MediaType { get; } | Gets the media type of this `EmailAttachmentBase`. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

### EmailEmbeddedObjectCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailembeddedobjectcollection.md

#### EmailEmbeddedObjectCollection class

Represents a collection of embedded objects in an email message.

```csharp
public class EmailEmbeddedObjectCollection : RemoveOnlyListBase<EmailEmbeddedObject>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(byte[], string) | Adds an embedded resource to the `EmailContent`. |
| Clear() |  |
| virtual Contains(EmailEmbeddedObject) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(EmailEmbeddedObject) |  |
| Remove(EmailEmbeddedObject) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `EmailEmbeddedObject` type.

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.email/emailembeddedobjectcollection/add.md

#### EmailEmbeddedObjectCollection.Add method

Adds an embedded resource to the `EmailContent`.

```csharp
public void Add(byte[] fileContent, string name)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | Byte[] | The content of the file to be added. |
| name | String | The name of the file. |

### GroupDocs.Watermark.Contents.Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image.md

The namespace provides classes for adding watermarks to images of different formats.

#### Classes

| Class | Description |
| --- | --- |
| GifImageContent | Represents a gif image where a watermark can be placed. |
| ImageContent | Represents an image where a watermark can be placed. |
| ImageFrame | Represents an image frame where a watermark can be placed. |
| ImageFrameCollection | Represents a collection of frames in multiframe image. |
| MultiframeImageContent | Represents a multiframe image where a watermark can be placed. |
| SystemDrawingImageFrame | Represents an image frame where a watermark can be placed (System.Drawing implementation). |
| SystemDrawingImageFrameCollection | Represents a collection of frames in multiframe image. |
| TiffImageContent | Represents a tiff image where a watermark can be placed. |
| WatermarkableImage | Represents an image inside a document. |
| WatermarkableImageCollection | Represents a collection of images found in a document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### GifImageContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/gifimagecontent.md

#### GifImageContent class

Represents a gif image where a watermark can be placed.

```csharp
public sealed class GifImageContent : MultiframeImageContent
```

#### Properties

| Name | Description |
| --- | --- |
| Frames { get; } | Gets the collection of all frames of the image. |
| virtual Height { get; } | Gets the height of this `ImageContent` in pixels. |
| virtual Width { get; } | Gets the width of this `ImageContent` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### ImageContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imagecontent.md

#### ImageContent class

Represents an image where a watermark can be placed.

```csharp
public class ImageContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Height { get; } | Gets the height of this `ImageContent` in pixels. |
| virtual Width { get; } | Gets the width of this `ImageContent` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to images](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images)

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imagecontent/height.md

#### ImageContent.Height property

Gets the height of this `ImageContent` in pixels.

```csharp
public virtual int Height { get; }
```

##### Property Value

The height of this `ImageContent` in pixels.

##### Remarks

Returns the height of the active frame for a multiframe image.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imagecontent/width.md

#### ImageContent.Width property

Gets the width of this `ImageContent` in pixels.

```csharp
public virtual int Width { get; }
```

##### Property Value

The width of this `ImageContent` in pixels.

##### Remarks

Returns the width of the active frame for a multiframe image.

### ImageFrame
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imageframe.md

#### ImageFrame class

Represents an image frame where a watermark can be placed.

```csharp
public class ImageFrame : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `ImageFrame` in pixels. |
| Width { get; } | Gets the width of this `ImageFrame` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imageframe/height.md

#### ImageFrame.Height property

Gets the height of this `ImageFrame` in pixels.

```csharp
public int Height { get; }
```

##### Property Value

The height of this `ImageFrame` in pixels.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imageframe/width.md

#### ImageFrame.Width property

Gets the width of this `ImageFrame` in pixels.

```csharp
public int Width { get; }
```

##### Property Value

The width of this `ImageFrame` in pixels.

### ImageFrameCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/imageframecollection.md

#### ImageFrameCollection class

Represents a collection of frames in multiframe image.

```csharp
public class ImageFrameCollection : ReadOnlyListBase<ImageFrame>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(ImageFrame) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(ImageFrame) |  |

##### Remarks

This collection contains the items of `ImageFrame` type.

### MultiframeImageContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/multiframeimagecontent.md

#### MultiframeImageContent class

Represents a multiframe image where a watermark can be placed.

```csharp
public abstract class MultiframeImageContent : ImageContent
```

#### Properties

| Name | Description |
| --- | --- |
| Frames { get; } | Gets the collection of all frames of the image. |
| virtual Height { get; } | Gets the height of this `ImageContent` in pixels. |
| virtual Width { get; } | Gets the width of this `ImageContent` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Frames
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/multiframeimagecontent/frames.md

#### MultiframeImageContent.Frames property

Gets the collection of all frames of the image.

```csharp
public ImageFrameCollection Frames { get; }
```

##### Property Value

The collection of image frames.

### SystemDrawingImageFrame
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/systemdrawingimageframe.md

#### SystemDrawingImageFrame class

Represents an image frame where a watermark can be placed (System.Drawing implementation).

```csharp
public class SystemDrawingImageFrame : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `SystemDrawingImageFrame` in pixels. |
| Width { get; } | Gets the width of this `SystemDrawingImageFrame` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/systemdrawingimageframe/height.md

#### SystemDrawingImageFrame.Height property

Gets the height of this `SystemDrawingImageFrame` in pixels.

```csharp
public int Height { get; }
```

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/systemdrawingimageframe/width.md

#### SystemDrawingImageFrame.Width property

Gets the width of this `SystemDrawingImageFrame` in pixels.

```csharp
public int Width { get; }
```

### SystemDrawingImageFrameCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/systemdrawingimageframecollection.md

#### SystemDrawingImageFrameCollection class

Represents a collection of frames in multiframe image.

```csharp
public class SystemDrawingImageFrameCollection : ReadOnlyListBase<SystemDrawingImageFrame>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(SystemDrawingImageFrame) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SystemDrawingImageFrame) |  |

##### Remarks

This collection contains the items of `ImageFrame` type.

### TiffImageContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/tiffimagecontent.md

#### TiffImageContent class

Represents a tiff image where a watermark can be placed.

```csharp
public class TiffImageContent : MultiframeImageContent
```

#### Properties

| Name | Description |
| --- | --- |
| Frames { get; } | Gets the collection of all frames of the image. |
| virtual Height { get; } | Gets the height of this `ImageContent` in pixels. |
| virtual Width { get; } | Gets the width of this `ImageContent` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### WatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimage.md

#### WatermarkableImage class

Represents an image inside a document.

```csharp
public abstract class WatermarkableImage : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Adding watermark to images inside a document](https://docs.groupdocs.com/display/watermarknet/Adding+watermark+to+images+inside+a+document)

##### Examples

Add watermark to all images inside a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    // Initialize text or image watermark.
    TextWatermark watermark = new TextWatermark("DRAFT", new Font("Arial", 19));

    // Find all images in the content.
    WatermarkableImageCollection images = watermarker.GetImages();

    // Add watermark.
    foreach (WatermarkableImage watermarkableImage in images)
    {
        watermarkableImage.Add(watermark);
    }

    // Save changes.
    watermarker.Save(@"D:\output.doc");
}
```

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimage/add.md

#### WatermarkableImage.Add method

Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```csharp
public void Add(Watermark watermark)
```

| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the image. |

### GetBytes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimage/getbytes.md

#### WatermarkableImage.GetBytes method

Gets the image as byte array.

```csharp
public byte[] GetBytes()
```

##### Return Value

The image data.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimage/height.md

#### WatermarkableImage.Height property

Gets the height of this `WatermarkableImage` in pixels.

```csharp
public int Height { get; }
```

##### Property Value

The height of this `WatermarkableImage` in pixels.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimage/width.md

#### WatermarkableImage.Width property

Gets the width of this `WatermarkableImage` in pixels.

```csharp
public int Width { get; }
```

##### Property Value

The width of this `WatermarkableImage` in pixels.

### WatermarkableImageCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.image/watermarkableimagecollection.md

#### WatermarkableImageCollection class

Represents a collection of images found in a document.

```csharp
public class WatermarkableImageCollection : ReadOnlyListBase<WatermarkableImage>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(WatermarkableImage) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(WatermarkableImage) |  |

##### Remarks

This collection contains the items of `WatermarkableImage` type.

### GroupDocs.Watermark.Contents.Pdf
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf.md

The namespace provides classes for working with watermarks in pdf documents.

#### Classes

| Class | Description |
| --- | --- |
| PdfAnnotation | Represents an annotation in a pdf document. |
| PdfAnnotationCollection | Represents a collection of annotations in a pdf document. |
| PdfArtifact | Represents an artifact in a pdf content. |
| PdfArtifactCollection | Represents a collection of artifacts in a pdf content. |
| PdfAttachment | Represents a file attached to a pdf content. |
| PdfAttachmentCollection | Represents a collection of attachments in a pdf document. |
| PdfContent | Represents a pdf document where a watermark can be placed. |
| PdfFormattedTextFragment | Represents a fragment of formatted text in a pdf document. |
| PdfFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf document. |
| PdfOperator | Represents an operator of vector content in a pdf document. |
| PdfOperatorCollection | Represents a collection of operators in a pdf content. |
| PdfPage | Represents pdf document page. |
| PdfPageCollection | Represents a collection of pages in a pdf content. |
| PdfShape | Provides base class for XObjects, Artifacts and Annotations. |
| PdfShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation. |
| PdfTextFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a pdf content main text. |
| PdfWatermarkableImage | Represents an image inside a Pdf document. |
| PdfXForm | Represents an XForm in a pdf content. |
| PdfXImage | Represents an XImage in a pdf content. |
| PdfXObject | Represents an XObject in a pdf document. |
| PdfXObjectCollection | Represents a collection of XObjects in a pdf document. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| PdfAnnotationType | Enumeration of annotation types. |
| PdfArtifactSubtype | Enumeration of possible artifacts subtype. |
| PdfArtifactType | Enumeration of possible artifact types. |
| PdfCryptoAlgorithm | Represent type of cryptographic algorithm that used in encryption routine. |
| PdfImageConversionFormat | Represents image formats that can be used for pdf document pages rasterization. |
| PdfPageMarginType | Represents pdf crop margins to be used during watermark adding. |
| PdfPermissions | Represents user's permissions for a pdf document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### PdfAnnotation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation.md

#### PdfAnnotation class

Represents an annotation in a pdf document.

```csharp
public class PdfAnnotation : PdfShape
```

#### Properties

| Name | Description |
| --- | --- |
| AnnotationType { get; } | Gets the type of this `PdfAnnotation`. |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| override Height { get; } | Gets the height of this `PdfAnnotation` in points. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| Page { get; } | Gets the parent page of this `PdfAnnotation`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfAnnotation` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PdfShape`. |
| override Width { get; } | Gets the width of this `PdfAnnotation` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfAnnotation` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfAnnotation` from worksheet bottom border in points. |

##### Remarks

**Learn more:**

* [Working with annotations](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithannotations)

### AnnotationType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/annotationtype.md

#### PdfAnnotation.AnnotationType property

Gets the type of this `PdfAnnotation`.

```csharp
public PdfAnnotationType AnnotationType { get; }
```

##### Property Value

The type of this `PdfAnnotation`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/height.md

#### PdfAnnotation.Height property

Gets the height of this `PdfAnnotation` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `PdfAnnotation` in points.

### Page
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/page.md

#### PdfAnnotation.Page property

Gets the parent page of this `PdfAnnotation`.

```csharp
public PdfPage Page { get; }
```

##### Property Value

The parent page of this `PdfAnnotation`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/rotateangle.md

#### PdfAnnotation.RotateAngle property

Gets the rotate angle of this `PdfAnnotation` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PdfAnnotation` in degrees.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/width.md

#### PdfAnnotation.Width property

Gets the width of this `PdfAnnotation` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `PdfAnnotation` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/x.md

#### PdfAnnotation.X property

Gets the horizontal offset of this `PdfAnnotation` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `PdfAnnotation`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotation/y.md

#### PdfAnnotation.Y property

Gets the vertical offset of this `PdfAnnotation` from worksheet bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `PdfAnnotation`.

### PdfAnnotationCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotationcollection.md

#### PdfAnnotationCollection class

Represents a collection of annotations in a pdf document.

```csharp
public class PdfAnnotationCollection : RemoveOnlyListBase<PdfAnnotation>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PdfAnnotation) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfAnnotation) |  |
| Remove(PdfAnnotation) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfAnnotation` type.

### PdfAnnotationType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfannotationtype.md

#### PdfAnnotationType enumeration

Enumeration of annotation types.

```csharp
public enum PdfAnnotationType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Text | `0` | Text annotation type. |
| Circle | `1` | Circle annotation type. |
| Polygon | `2` | Polygon annotation type. |
| PolyLine | `3` | Polyline annotation type. |
| Line | `4` | Line annotation type. |
| Square | `5` | Square annotation type. |
| FreeText | `6` | Free text annotation type. |
| Highlight | `7` | Highlight annotation type. |
| Underline | `8` | Underline annotation type. |
| Squiggly | `9` | Squiggle annotation type. |
| StrikeOut | `10` | Strikeout annotation type. |
| Caret | `11` | Caret annotation type. |
| Ink | `12` | Ink annotation type. |
| Link | `13` | Link annotation type. |
| Popup | `14` | Popup annotation type. |
| FileAttachment | `15` | File attachment annotation type. |
| Sound | `16` | Sound annotation type. |
| Movie | `17` | Movie annotation type. |
| Screen | `18` | Screen annotation type. |
| Widget | `19` | Widget annotation type. |
| Watermark | `20` | Watermark annotation type. |
| TrapNet | `21` | Trap network annotation type. |
| PrinterMark | `22` | Printer mark annotation type. |
| Redaction | `23` | Redaction annotation type. |
| Stamp | `24` | Rubber stamp annotation type. |
| RichMedia | `25` | RichMedia annotation type. |
| Unknown | `26` | Unknown annotation. |
| Pdf3D | `27` | PDF3D annotation. |
| ColorBar | `28` | ColorBar annotation. |
| TrimMark | `29` | Trim mark annotation. |
| BleedMark | `30` | Bleed mark annotation. |
| RegistrationMark | `31` | Registration mark annotation. |
| PageInformation | `32` | Page information annotation. |

### PdfArtifact
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact.md

#### PdfArtifact class

Represents an artifact in a pdf content.

```csharp
public class PdfArtifact : PdfShape
```

#### Properties

| Name | Description |
| --- | --- |
| ArtifactSubtype { get; } | Gets the subtype of this `PdfArtifact`. |
| ArtifactType { get; } | Gets the type of this `PdfArtifact`. |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| override Height { get; } | Gets the height of this `PdfArtifact` in points. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| Opacity { get; } | Gets the opacity of this `PdfArtifact`. |
| Page { get; } | Gets the parent page of this `PdfArtifact`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfArtifact` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `PdfArtifact`. |
| override Width { get; } | Gets the width of this `PdfArtifact` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfArtifact` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfArtifact` from page bottom border in points. |

##### Remarks

**Learn more:**

* [Working with artifacts](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithartifacts)

### ArtifactSubtype
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/artifactsubtype.md

#### PdfArtifact.ArtifactSubtype property

Gets the subtype of this `PdfArtifact`.

```csharp
public PdfArtifactSubtype ArtifactSubtype { get; }
```

##### Property Value

The subtype of this `PdfArtifact`.

### ArtifactType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/artifacttype.md

#### PdfArtifact.ArtifactType property

Gets the type of this `PdfArtifact`.

```csharp
public PdfArtifactType ArtifactType { get; }
```

##### Property Value

The type of this `PdfArtifact`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/height.md

#### PdfArtifact.Height property

Gets the height of this `PdfArtifact` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `PdfArtifact` in points.

### Opacity
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/opacity.md

#### PdfArtifact.Opacity property

Gets the opacity of this `PdfArtifact`.

```csharp
public double Opacity { get; }
```

##### Property Value

The opacity of this `PdfArtifact`.

##### Remarks

Possible values are in range [0, 1].

### Page
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/page.md

#### PdfArtifact.Page property

Gets the parent page of this `PdfArtifact`.

```csharp
public PdfPage Page { get; }
```

##### Property Value

The parent page of this `PdfArtifact`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/rotateangle.md

#### PdfArtifact.RotateAngle property

Gets the rotate angle of this `PdfArtifact` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PdfArtifact` in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/text.md

#### PdfArtifact.Text property

Gets or sets the text of this `PdfArtifact`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `PdfArtifact`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/width.md

#### PdfArtifact.Width property

Gets the width of this `PdfArtifact` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `PdfArtifact` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/x.md

#### PdfArtifact.X property

Gets the horizontal offset of this `PdfArtifact` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `PdfArtifact`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifact/y.md

#### PdfArtifact.Y property

Gets the vertical offset of this `PdfArtifact` from page bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `PdfArtifact`.

### PdfArtifactCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifactcollection.md

#### PdfArtifactCollection class

Represents a collection of artifacts in a pdf content.

```csharp
public class PdfArtifactCollection : RemoveOnlyListBase<PdfArtifact>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PdfArtifact) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfArtifact) |  |
| Remove(PdfArtifact) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfArtifact` type.

### PdfArtifactSubtype
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifactsubtype.md

#### PdfArtifactSubtype enumeration

Enumeration of possible artifacts subtype.

```csharp
public enum PdfArtifactSubtype
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Header | `0` | Header subtype. |
| Footer | `1` | Footer subtype. |
| Watermark | `2` | Watermark subtype. |
| Background | `3` | Background subtype. |
| Undefined | `4` | UndefinedDocument subtype. |

### PdfArtifactType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfartifacttype.md

#### PdfArtifactType enumeration

Enumeration of possible artifact types.

```csharp
public enum PdfArtifactType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pagination | `0` | Pagination type. |
| Layout | `1` | Layout type. |
| Page | `2` | Page type. |
| Background | `3` | Background type. |
| Undefined | `4` | UndefinedDocument type. |

### PdfAttachment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachment.md

#### PdfAttachment class

Represents a file attached to a pdf content.

```csharp
public class PdfAttachment : Attachment
```

#### Properties

| Name | Description |
| --- | --- |
| override Content { get; set; } | Gets or sets the attached file content. |
| Description { get; set; } | Gets or sets the description of the attached file. |
| Name { get; set; } | Gets or sets the name of the attached file. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

##### Remarks

**Learn more:**

* [Attachments in PDF document](https://docs.groupdocs.com/display/watermarknet/Attachments+in+PDF+document)

### Content
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachment/content.md

#### PdfAttachment.Content property

Gets or sets the attached file content.

```csharp
public override byte[] Content { get; set; }
```

##### Property Value

The attached file content.

### Description
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachment/description.md

#### PdfAttachment.Description property

Gets or sets the description of the attached file.

```csharp
public string Description { get; set; }
```

##### Property Value

The description of the attached file.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachment/name.md

#### PdfAttachment.Name property

Gets or sets the name of the attached file.

```csharp
public string Name { get; set; }
```

##### Property Value

The name of the attached file.

### PdfAttachmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachmentcollection.md

#### PdfAttachmentCollection class

Represents a collection of attachments in a pdf document.

```csharp
public class PdfAttachmentCollection : RemoveOnlyListBase<PdfAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(byte[], string, string) | Adds an attachment to the `PdfContent`. |
| Clear() |  |
| virtual Contains(PdfAttachment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfAttachment) |  |
| Remove(PdfAttachment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfAttachment` type.

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfattachmentcollection/add.md

#### PdfAttachmentCollection.Add method

Adds an attachment to the `PdfContent`.

```csharp
public void Add(byte[] fileContent, string name, string description)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | Byte[] | The content of the file to be attached. |
| name | String | The name of the file. |
| description | String | The description of the file. |

### PdfContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent.md

#### PdfContent class

Represents a pdf document where a watermark can be placed.

```csharp
public class PdfContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| Attachments { get; } | Gets the collection of all attachments of this `PdfContent`. |
| PageMarginType { get; set; } | Gets or sets pdf page margins to be used during watermark adding. |
| Pages { get; } | Gets the collection of all pages of this `PdfContent`. |

#### Methods

| Name | Description |
| --- | --- |
| Decrypt() | Decrypts the content. |
| Dispose() | Disposes the current instance. |
| Encrypt(string) | Encrypts the document using the same password as user password and owner password. |
| Encrypt(string, string, PdfPermissions, PdfCryptoAlgorithm) | Encrypts the content. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Rasterize(int, int, PdfImageConversionFormat) | Converts all content pages into images. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to PDF documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents)
* [Existing objects in PDF document](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document)
* [Rasterize document or page](https://docs.groupdocs.com/display/watermarknet/Rasterize+document+or+page)
* [Watermarks in PDF document](https://docs.groupdocs.com/display/watermarknet/Watermarks+in+PDF+document)

### Attachments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/attachments.md

#### PdfContent.Attachments property

Gets the collection of all attachments of this `PdfContent`.

```csharp
public PdfAttachmentCollection Attachments { get; }
```

##### Property Value

The collection of all attachments of this `PdfContent`.

### Decrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/decrypt.md

#### PdfContent.Decrypt method

Decrypts the content.

```csharp
public void Decrypt()
```

### Encrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/encrypt.md

#### Encrypt(string)

Encrypts the document using the same password as user password and owner password.

```csharp
public void Encrypt(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | User and owner password. |

#### Encrypt(string, string, PdfPermissions, PdfCryptoAlgorithm)

Encrypts the content.

```csharp
public void Encrypt(string userPassword, string ownerPassword, PdfPermissions permissions, 
    PdfCryptoAlgorithm cryptoAlgorithm)
```

| Parameter | Type | Description |
| --- | --- | --- |
| userPassword | String | User password. |
| ownerPassword | String | Owner password. |
| permissions | PdfPermissions | Content permissions. |
| cryptoAlgorithm | PdfCryptoAlgorithm | Cryptographic algorithm. |

### PageMarginType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/pagemargintype.md

#### PdfContent.PageMarginType property

Gets or sets pdf page margins to be used during watermark adding.

```csharp
public PdfPageMarginType PageMarginType { get; set; }
```

##### Property Value

Pdf page margins to be used during watermark adding.

##### Remarks

This property works only when `ConsiderParentMargins` is set to true. If `ConsiderParentMargins` is false, when pdf CropBox is used as watermarking area.

The default value is TrimBox.

### Pages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/pages.md

#### PdfContent.Pages property

Gets the collection of all pages of this `PdfContent`.

```csharp
public PdfPageCollection Pages { get; }
```

##### Property Value

The collection of all pages of this `PdfContent`.

### Rasterize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcontent/rasterize.md

#### PdfContent.Rasterize method

Converts all content pages into images.

```csharp
public void Rasterize(int horizontalResolution, int verticalResolution, 
    PdfImageConversionFormat imageFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| horizontalResolution | Int32 | Horizontal image resolution. |
| verticalResolution | Int32 | Vertical image resolution. |
| imageFormat | PdfImageConversionFormat | Image format. |

### PdfCryptoAlgorithm
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm.md

#### PdfCryptoAlgorithm enumeration

Represent type of cryptographic algorithm that used in encryption routine.

```csharp
public enum PdfCryptoAlgorithm
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| RC4x40 | `0` | RC4 with key length 40. |
| RC4x128 | `1` | RC4 with key length 128. |
| AESx128 | `2` | AES with key length 128. |
| AESx256 | `3` | AES with key length 256. |

### PdfFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment.md

#### PdfFormattedTextFragment class

Represents a fragment of formatted text in a pdf document.

```csharp
public class PdfFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/backgroundcolor.md

#### PdfFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/font.md

#### PdfFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/foregroundcolor.md

#### PdfFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/text.md

#### PdfFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### PdfFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfformattedtextfragmentcollection.md

#### PdfFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf document.

```csharp
public class PdfFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfFormattedTextFragment` type.

### PdfImageConversionFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfimageconversionformat.md

#### PdfImageConversionFormat enumeration

Represents image formats that can be used for pdf document pages rasterization.

```csharp
public enum PdfImageConversionFormat
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Jpeg | `0` | Jpeg image. |
| Png | `1` | Png image. |
| Gif | `2` | Gif image. |

### PdfOperator
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfoperator.md

#### PdfOperator class

Represents an operator of vector content in a pdf document.

```csharp
public class PdfOperator
```

#### Properties

| Name | Description |
| --- | --- |
| ForegroundColor { get; } | Gets the foreground color of this `PdfOperator`. |

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfoperator/foregroundcolor.md

#### PdfOperator.ForegroundColor property

Gets the foreground color of this `PdfOperator`.

```csharp
public Color ForegroundColor { get; }
```

##### Property Value

The foreground color of this `PdfOperator`.

### PdfOperatorCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfoperatorcollection.md

#### PdfOperatorCollection class

Represents a collection of operators in a pdf content.

```csharp
public class PdfOperatorCollection : RemoveOnlyListBase<PdfOperator>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PdfOperator) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfOperator) |  |
| Remove(PdfOperator) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfOperator` type.

### PdfPage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage.md

#### PdfPage class

Represents pdf document page.

```csharp
public class PdfPage : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Annotations { get; } | Gets the collection of all annotations of this `PdfPage`. |
| Artifacts { get; } | Gets the collection of all artifacts of this `PdfPage`. |
| Height { get; } | Gets the height of this `PdfPage` in points. |
| Width { get; } | Gets the width of this `PdfPage` in points. |
| XObjects { get; } | Gets the collection of all XObjects of this `PdfPage`. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| virtual Rasterize(int, int, PdfImageConversionFormat) | Converts page content into an image. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Annotations
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/annotations.md

#### PdfPage.Annotations property

Gets the collection of all annotations of this `PdfPage`.

```csharp
public PdfAnnotationCollection Annotations { get; }
```

##### Property Value

The collection of all annotations of this `PdfPage`.

### Artifacts
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/artifacts.md

#### PdfPage.Artifacts property

Gets the collection of all artifacts of this `PdfPage`.

```csharp
public PdfArtifactCollection Artifacts { get; }
```

##### Property Value

The collection of all artifacts of this `PdfPage`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/height.md

#### PdfPage.Height property

Gets the height of this `PdfPage` in points.

```csharp
public double Height { get; }
```

##### Property Value

The height of this `PdfPage` in points.

### Rasterize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/rasterize.md

#### PdfPage.Rasterize method

Converts page content into an image.

```csharp
public virtual void Rasterize(int horizontalResolution, int verticalResolution, 
    PdfImageConversionFormat imageFormat)
```

| Parameter | Type | Description |
| --- | --- | --- |
| horizontalResolution | Int32 | Horizontal image resolution. |
| verticalResolution | Int32 | Vertical image resolution. |
| imageFormat | PdfImageConversionFormat | Image format. |

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/width.md

#### PdfPage.Width property

Gets the width of this `PdfPage` in points.

```csharp
public double Width { get; }
```

##### Property Value

The width of this `PdfPage` in points.

### XObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpage/xobjects.md

#### PdfPage.XObjects property

Gets the collection of all XObjects of this `PdfPage`.

```csharp
public PdfXObjectCollection XObjects { get; }
```

##### Property Value

The collection of all XObjects of this `PdfPage`.

### PdfPageCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpagecollection.md

#### PdfPageCollection class

Represents a collection of pages in a pdf content.

```csharp
public class PdfPageCollection : ReadOnlyListBase<PdfPage>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(PdfPage) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfPage) |  |

##### Remarks

This collection contains the items of `PdfPage` type.

### PdfPageMarginType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpagemargintype.md

#### PdfPageMarginType enumeration

Represents pdf crop margins to be used during watermark adding.

```csharp
public enum PdfPageMarginType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| BleedBox | `0` | Pdf BleedBox is used as watermarking area. |
| TrimBox | `1` | Pdf TrimBox is used as watermarking area. |
| ArtBox | `2` | Pdf ArtBox is used as watermarking area. |

### PdfPermissions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfpermissions.md

#### PdfPermissions enumeration

Represents user's permissions for a pdf document.

```csharp
[Flags]
public enum PdfPermissions
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PrintDocument | `4` | Print the content. |
| ModifyContent | `8` | Modify the content. |
| ExtractContent | `10` | Copy or otherwise extract text and graphics from the document. |
| ModifyTextAnnotations | `20` | Add or modify text annotations. |
| FillForm | `100` | Fill in existing interactive form fields. |
| ExtractContentWithDisabilities | `200` | Extract text and graphics. |
| AssembleDocument | `400` | Assemble the content. |
| PrintingQuality | `800` | Print the content to a representation from which a faithful digital copy of the PDF document could be generated. |

### PdfShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape.md

#### PdfShape class

Provides base class for XObjects, Artifacts and Annotations.

```csharp
public abstract class PdfShape : ShapeSearchAdapter, IRotatableTwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| abstract Height { get; } | Gets the height of the object. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| abstract RotateAngle { get; } | Gets the rotate angle of the object in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PdfShape`. |
| abstract Width { get; } | Gets the width of the object. |
| abstract X { get; } | Gets the x-coordinate of the object. |
| abstract Y { get; } | Gets the y-coordinate of the object. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/formattedtextfragments.md

#### PdfShape.FormattedTextFragments property

Gets the collection of formatted text fragments of this `PdfShape`.

```csharp
public FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `PdfShape`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/height.md

#### PdfShape.Height property

Gets the height of the object.

```csharp
public abstract double Height { get; }
```

##### Property Value

The height of the object.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/image.md

#### PdfShape.Image property

Gets or sets the image of this `PdfShape`.

```csharp
public PdfWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `PdfShape`. Returns null if the object has no image.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/rotateangle.md

#### PdfShape.RotateAngle property

Gets the rotate angle of the object in degrees.

```csharp
public abstract double RotateAngle { get; }
```

##### Property Value

The rotate angle of the object in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/text.md

#### PdfShape.Text property

Gets or sets the text of this `PdfShape`.

```csharp
public virtual string Text { get; set; }
```

##### Property Value

The text of this `PdfShape`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/width.md

#### PdfShape.Width property

Gets the width of the object.

```csharp
public abstract double Width { get; }
```

##### Property Value

The width of the object.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/x.md

#### PdfShape.X property

Gets the x-coordinate of the object.

```csharp
public abstract double X { get; }
```

##### Property Value

The x-coordinate of the object.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshape/y.md

#### PdfShape.Y property

Gets the y-coordinate of the object.

```csharp
public abstract double Y { get; }
```

##### Property Value

The y-coordinate of the object.

### PdfShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfshapeformattedtextfragmentcollection.md

#### PdfShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation.

```csharp
public class PdfShapeFormattedTextFragmentCollection : PdfFormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfFormattedTextFragment` type.

### PdfTextFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdftextformattedtextfragmentcollection.md

#### PdfTextFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf content main text.

```csharp
public class PdfTextFormattedTextFragmentCollection : PdfFormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfFormattedTextFragment` type.

### PdfWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage.md

#### PdfWatermarkableImage class

Represents an image inside a Pdf document.

```csharp
public class PdfWatermarkableImage : WatermarkableImage
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfWatermarkableImage(byte[]) | Initializes a new instance of the `PdfWatermarkableImage` class using specified image data. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PdfWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/pdfwatermarkableimage.md

#### PdfWatermarkableImage constructor

Initializes a new instance of the `PdfWatermarkableImage` class using specified image data.

```csharp
public PdfWatermarkableImage(byte[] imageData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageData | Byte[] | The array of unsigned bytes from which to create the `PdfWatermarkableImage`. |

### PdfXForm
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxform.md

#### PdfXForm class

Represents an XForm in a pdf content.

```csharp
public class PdfXForm : PdfXObject
```

#### Properties

| Name | Description |
| --- | --- |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| override Height { get; } | Gets the height of this `PdfXObject` in points. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| Page { get; } | Gets the parent page of this `PdfXObject`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfXObject` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PdfShape`. |
| override Width { get; } | Gets the width of this `PdfXObject` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfXObject` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfXObject` from page bottom border in points. |

### PdfXImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfximage.md

#### PdfXImage class

Represents an XImage in a pdf content.

```csharp
public class PdfXImage : PdfXObject
```

#### Properties

| Name | Description |
| --- | --- |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| override Height { get; } | Gets the height of this `PdfXObject` in points. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| Page { get; } | Gets the parent page of this `PdfXObject`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfXObject` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PdfShape`. |
| override Width { get; } | Gets the width of this `PdfXObject` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfXObject` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfXObject` from page bottom border in points. |

### PdfXObject
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject.md

#### PdfXObject class

Represents an XObject in a pdf document.

```csharp
public abstract class PdfXObject : PdfShape
```

#### Properties

| Name | Description |
| --- | --- |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfShape`. |
| override Height { get; } | Gets the height of this `PdfXObject` in points. |
| Image { get; set; } | Gets or sets the image of this `PdfShape`. |
| Page { get; } | Gets the parent page of this `PdfXObject`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfXObject` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PdfShape`. |
| override Width { get; } | Gets the width of this `PdfXObject` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfXObject` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfXObject` from page bottom border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/height.md

#### PdfXObject.Height property

Gets the height of this `PdfXObject` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `PdfXObject` in points.

### Page
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/page.md

#### PdfXObject.Page property

Gets the parent page of this `PdfXObject`.

```csharp
public PdfPage Page { get; }
```

##### Property Value

The parent page of this `PdfXObject`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/rotateangle.md

#### PdfXObject.RotateAngle property

Gets the rotate angle of this `PdfXObject` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PdfXObject` in degrees.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/width.md

#### PdfXObject.Width property

Gets the width of this `PdfXObject` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `PdfXObject` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/x.md

#### PdfXObject.X property

Gets the horizontal offset of this `PdfXObject` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `PdfXObject`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobject/y.md

#### PdfXObject.Y property

Gets the vertical offset of this `PdfXObject` from page bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `PdfXObject`.

### PdfXObjectCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.pdf/pdfxobjectcollection.md

#### PdfXObjectCollection class

Represents a collection of XObjects in a pdf document.

```csharp
public class PdfXObjectCollection : RemoveOnlyListBase<PdfXObject>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PdfXObject) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PdfXObject) |  |
| Remove(PdfXObject) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PdfXObject` type.

### GroupDocs.Watermark.Contents.Presentation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation.md

The namespace provides classes for working with watermarks in PowerPoint documents.

#### Classes

| Class | Description |
| --- | --- |
| PresentationBaseShape | Provides the abstract base class for shapes of all types in a PowerPoint document. |
| PresentationBaseSlide | Provides the abstract base class for slides of all types in a PowerPoint document. |
| PresentationChart | Represents a chart in a PowerPoint document. |
| PresentationChartCollection | Represents a collection of charts in a PowerPoint document. |
| PresentationContent | Represents a PowerPoint document where a watermark can be placed. |
| PresentationFormattedTextFragment | Represents a fragment of formatted text in a PowerPoint document. |
| PresentationFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a PowerPoint document. |
| PresentationImageFillFormat | Represents the image fill format settings in a PowerPoint document. |
| PresentationLayoutSlide | Represents a PowerPoint content layout slide. |
| PresentationLayoutSlideCollection | Represents a collection of layout slides in a PowerPoint document. |
| PresentationMasterHandoutSlide | Represents a master handout slide in a PowerPoint content. |
| PresentationMasterNotesSlide | Represents a master slide for all notes slides in a PowerPoint document. |
| PresentationMasterSlide | Represents a PowerPoint document master slide. |
| PresentationMasterSlideCollection | Represents a collection of master slides in a PowerPoint document. |
| PresentationNotesSlide | Represents a PowerPoint document notes slide. |
| PresentationShape | Represents a drawing shape in a PowerPoint document. |
| PresentationShapeCollection | Represents a collection of drawing shapes in a PowerPoint document. |
| PresentationShapeSettings | Represents settings that can be applied to a shape watermark for a PowerPoint document. |
| PresentationSlide | Represents a PowerPoint document slide. |
| PresentationSlideCollection | Represents a collection of slides in a PowerPoint document. |
| PresentationSlideImageFillFormat | Represents the image fill format settings for a slide in a PowerPoint document. |
| PresentationWatermarkableImage | Represents an image inside a PowerPoint document. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IPresentationHyperlinkContainer | Represents PowerPoint document object that contains a hyperlink. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| PresentationHyperlinkActionType | Specifies hyperlink action type. |
| PresentationShapeType | Represents a shape geometry preset type. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### IPresentationHyperlinkContainer
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer.md

#### IPresentationHyperlinkContainer interface

Represents PowerPoint document object that contains a hyperlink.

```csharp
public interface IPresentationHyperlinkContainer
```

#### Methods

| Name | Description |
| --- | --- |
| GetHyperlink(PresentationHyperlinkActionType) | Gets the hyperlink associated with this `IPresentationHyperlinkContainer`. |
| SetHyperlink(PresentationHyperlinkActionType, string) | Sets the hyperlink associated with this `PresentationBaseShape`. |

### GetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/gethyperlink.md

#### IPresentationHyperlinkContainer.GetHyperlink method

Gets the hyperlink associated with this `IPresentationHyperlinkContainer`.

```csharp
public string GetHyperlink(PresentationHyperlinkActionType actionType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |

##### Return Value

The url of the hyperlink that is activated on specified action.

### SetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/sethyperlink.md

#### IPresentationHyperlinkContainer.SetHyperlink method

Sets the hyperlink associated with this `PresentationBaseShape`.

```csharp
public void SetHyperlink(PresentationHyperlinkActionType actionType, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |
| url | String | The hyperlink url. |

### PresentationBaseShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape.md

#### PresentationBaseShape class

Provides the abstract base class for shapes of all types in a PowerPoint document.

```csharp
public abstract class PresentationBaseShape : ShapeSearchAdapter, IPresentationHyperlinkContainer, 
    ITwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with this `PresentationBaseShape`. |
| Height { get; set; } | Gets or sets the height of this `PresentationBaseShape` in points. |
| Id { get; } | Gets the identifier of this `PresentationBaseShape`. |
| ImageFillFormat { get; } | Gets the image fill format settings of this `PresentationBaseShape`. |
| Name { get; } | Gets the name of this `PresentationBaseShape`. |
| Presentation { get; } | Gets the parent presentation of this `PresentationBaseShape`. |
| Width { get; set; } | Gets or sets the width of this `PresentationBaseShape` in points. |
| X { get; set; } | Gets or sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points. |
| ZOrderPosition { get; } | Gets the position of this `PresentationBaseShape` in the z-order. |

#### Methods

| Name | Description |
| --- | --- |
| GetHyperlink(PresentationHyperlinkActionType) | Gets the hyperlink associated with this `PresentationBaseShape`. |
| SetHyperlink(PresentationHyperlinkActionType, string) | Sets the hyperlink associated with this `PresentationBaseShape`. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/alternativetext.md

#### PresentationBaseShape.AlternativeText property

Gets or sets the descriptive (alternative) text associated with this `PresentationBaseShape`.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text associated with this `PresentationBaseShape`.

### GetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/gethyperlink.md

#### PresentationBaseShape.GetHyperlink method

Gets the hyperlink associated with this `PresentationBaseShape`.

```csharp
public string GetHyperlink(PresentationHyperlinkActionType actionType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |

##### Return Value

The url of the hyperlink that is activated on specified action.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/height.md

#### PresentationBaseShape.Height property

Gets or sets the height of this `PresentationBaseShape` in points.

```csharp
public double Height { get; set; }
```

##### Property Value

The height of this `PresentationBaseShape` in points.

### Id
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/id.md

#### PresentationBaseShape.Id property

Gets the identifier of this `PresentationBaseShape`.

```csharp
public uint Id { get; }
```

##### Property Value

The identifier of this `PresentationBaseShape`.

### ImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/imagefillformat.md

#### PresentationBaseShape.ImageFillFormat property

Gets the image fill format settings of this `PresentationBaseShape`.

```csharp
public PresentationImageFillFormat ImageFillFormat { get; }
```

##### Property Value

The image fill format settings of this `PresentationBaseShape`.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/name.md

#### PresentationBaseShape.Name property

Gets the name of this `PresentationBaseShape`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `PresentationBaseShape`.

### Presentation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/presentation.md

#### PresentationBaseShape.Presentation property

Gets the parent presentation of this `PresentationBaseShape`.

```csharp
public PresentationBaseSlide Presentation { get; }
```

##### Property Value

The parent presentation of this `PresentationBaseShape`.

### SetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/sethyperlink.md

#### PresentationBaseShape.SetHyperlink method

Sets the hyperlink associated with this `PresentationBaseShape`.

```csharp
public void SetHyperlink(PresentationHyperlinkActionType actionType, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |
| url | String | The hyperlink url. |

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/width.md

#### PresentationBaseShape.Width property

Gets or sets the width of this `PresentationBaseShape` in points.

```csharp
public double Width { get; set; }
```

##### Property Value

The width of this `PresentationBaseShape` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/x.md

#### PresentationBaseShape.X property

Gets or sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of this `PresentationBaseShape`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/y.md

#### PresentationBaseShape.Y property

Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of this `PresentationBaseShape`.

### ZOrderPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseshape/zorderposition.md

#### PresentationBaseShape.ZOrderPosition property

Gets the position of this `PresentationBaseShape` in the z-order.

```csharp
public int ZOrderPosition { get; }
```

##### Property Value

The position of this `PresentationBaseShape` in the z-order.

##### Remarks

A shape with greater z-order is always in front of a shape with a lower z-order.

### PresentationBaseSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseslide.md

#### PresentationBaseSlide class

Provides the abstract base class for slides of all types in a PowerPoint document.

```csharp
public abstract class PresentationBaseSlide : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Charts
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseslide/charts.md

#### PresentationBaseSlide.Charts property

Gets the collection of all charts on the presentation.

```csharp
public PresentationChartCollection Charts { get; }
```

##### Property Value

The collection of all charts on the presentation.

### ImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseslide/imagefillformat.md

#### PresentationBaseSlide.ImageFillFormat property

Gets the image fill format settings of the presentation.

```csharp
public PresentationImageFillFormat ImageFillFormat { get; }
```

##### Property Value

The image fill format settings of the presentation.

### Shapes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationbaseslide/shapes.md

#### PresentationBaseSlide.Shapes property

Gets the collection of all shapes of the presentation.

```csharp
public PresentationShapeCollection Shapes { get; }
```

##### Property Value

The collection of all shapes of the presentation.

### PresentationChart
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationchart.md

#### PresentationChart class

Represents a chart in a PowerPoint document.

```csharp
public class PresentationChart : PresentationBaseShape
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with this `PresentationBaseShape`. |
| Height { get; set; } | Gets or sets the height of this `PresentationBaseShape` in points. |
| Id { get; } | Gets the identifier of this `PresentationBaseShape`. |
| ImageFillFormat { get; } | Gets the image fill format settings of this `PresentationBaseShape`. |
| Name { get; } | Gets the name of this `PresentationBaseShape`. |
| Presentation { get; } | Gets the parent presentation of this `PresentationBaseShape`. |
| Width { get; set; } | Gets or sets the width of this `PresentationBaseShape` in points. |
| X { get; set; } | Gets or sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points. |
| ZOrderPosition { get; } | Gets the position of this `PresentationBaseShape` in the z-order. |

#### Methods

| Name | Description |
| --- | --- |
| GetHyperlink(PresentationHyperlinkActionType) | Gets the hyperlink associated with this `PresentationBaseShape`. |
| SetHyperlink(PresentationHyperlinkActionType, string) | Sets the hyperlink associated with this `PresentationBaseShape`. |

### PresentationChartCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationchartcollection.md

#### PresentationChartCollection class

Represents a collection of charts in a PowerPoint document.

```csharp
public class PresentationChartCollection : ReadOnlyListBase<PresentationChart>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(PresentationChart) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PresentationChart) |  |

##### Remarks

This collection contains the items of `PresentationChart` type.

### PresentationContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent.md

#### PresentationContent class

Represents a PowerPoint document where a watermark can be placed.

```csharp
public class PresentationContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| LayoutSlides { get; } | Gets the collection of all layout slides of this `PresentationContent`. |
| MasterHandoutSlide { get; } | Gets the master handout slide of this `PresentationContent`. |
| MasterNotesSlide { get; } | Gets the master slide for all notes slides of this `PresentationContent`. |
| MasterSlides { get; } | Gets the collection of all master slides of this `PresentationContent`. |
| NotesSlideHeight { get; } | Gets the height of a notes slide in points. |
| NotesSlideWidth { get; } | Gets the width of a notes slide in points. |
| SlideHeight { get; } | Gets the height of a slide in points. |
| Slides { get; } | Gets the collection of all slides of this `PresentationContent`. |
| SlideWidth { get; } | Gets the width of a slide in points. |

#### Methods

| Name | Description |
| --- | --- |
| Decrypt() | Decrypts the document. |
| Dispose() | Disposes the current instance. |
| Encrypt(string) | Encrypts the document. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)
* [Working with slide backgrounds](https://docs.groupdocs.com/display/watermarknet/Working+with+slide+backgrounds)

##### Examples

Load and save PowerPoint document of any supported type.

```csharp
PresentationLoadOptions loadOptions = new PresentationLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\input.ppt", loadOptions))
{
    // Use Add method to add watermark to a particular slide or all slides.

    // Save changes.
    watermarker.Save(@"D:\output.ppt");
}
```

### Decrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/decrypt.md

#### PresentationContent.Decrypt method

Decrypts the document.

```csharp
public void Decrypt()
```

### Encrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/encrypt.md

#### PresentationContent.Encrypt method

Encrypts the document.

```csharp
public void Encrypt(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password that will be required to open the document. |

### LayoutSlides
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/layoutslides.md

#### PresentationContent.LayoutSlides property

Gets the collection of all layout slides of this `PresentationContent`.

```csharp
public PresentationLayoutSlideCollection LayoutSlides { get; }
```

##### Property Value

The collection of all layout slides of this `PresentationContent`.

### MasterHandoutSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/masterhandoutslide.md

#### PresentationContent.MasterHandoutSlide property

Gets the master handout slide of this `PresentationContent`.

```csharp
public PresentationMasterHandoutSlide MasterHandoutSlide { get; }
```

##### Property Value

The master handout slide of this `PresentationContent`.

### MasterNotesSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/masternotesslide.md

#### PresentationContent.MasterNotesSlide property

Gets the master slide for all notes slides of this `PresentationContent`.

```csharp
public PresentationMasterNotesSlide MasterNotesSlide { get; }
```

##### Property Value

The master slide for all notes slides of this `PresentationContent`.

### MasterSlides
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/masterslides.md

#### PresentationContent.MasterSlides property

Gets the collection of all master slides of this `PresentationContent`.

```csharp
public PresentationMasterSlideCollection MasterSlides { get; }
```

##### Property Value

The collection of all master slides of this `PresentationContent`.

### NotesSlideHeight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/notesslideheight.md

#### PresentationContent.NotesSlideHeight property

Gets the height of a notes slide in points.

```csharp
public double NotesSlideHeight { get; }
```

##### Property Value

The height of a notes slide in points.

### NotesSlideWidth
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/notesslidewidth.md

#### PresentationContent.NotesSlideWidth property

Gets the width of a notes slide in points.

```csharp
public double NotesSlideWidth { get; }
```

##### Property Value

The width of a notes slide in points.

### SlideHeight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/slideheight.md

#### PresentationContent.SlideHeight property

Gets the height of a slide in points.

```csharp
public double SlideHeight { get; }
```

##### Property Value

The height of a slide in points.

### Slides
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/slides.md

#### PresentationContent.Slides property

Gets the collection of all slides of this `PresentationContent`.

```csharp
public PresentationSlideCollection Slides { get; }
```

##### Property Value

The collection of all slides of this `PresentationContent`.

### SlideWidth
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationcontent/slidewidth.md

#### PresentationContent.SlideWidth property

Gets the width of a slide in points.

```csharp
public double SlideWidth { get; }
```

##### Property Value

The width of a slide in points.

### PresentationFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment.md

#### PresentationFormattedTextFragment class

Represents a fragment of formatted text in a PowerPoint document.

```csharp
public class PresentationFormattedTextFragment : FormattedTextFragment, 
    IPresentationHyperlinkContainer
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

#### Methods

| Name | Description |
| --- | --- |
| GetHyperlink(PresentationHyperlinkActionType) | Gets the hyperlink associated with the text. |
| SetHyperlink(PresentationHyperlinkActionType, string) | Sets the hyperlink associated with the text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/backgroundcolor.md

#### PresentationFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/font.md

#### PresentationFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/foregroundcolor.md

#### PresentationFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### GetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/gethyperlink.md

#### PresentationFormattedTextFragment.GetHyperlink method

Gets the hyperlink associated with the text.

```csharp
public string GetHyperlink(PresentationHyperlinkActionType actionType)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |

##### Return Value

The url of the hyperlink that is activated on specified action.

### SetHyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/sethyperlink.md

#### PresentationFormattedTextFragment.SetHyperlink method

Sets the hyperlink associated with the text.

```csharp
public void SetHyperlink(PresentationHyperlinkActionType actionType, string url)
```

| Parameter | Type | Description |
| --- | --- | --- |
| actionType | PresentationHyperlinkActionType | The action that activates the hyperlink. |
| url | String | The hyperlink url. |

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/text.md

#### PresentationFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### PresentationFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationformattedtextfragmentcollection.md

#### PresentationFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a PowerPoint document.

```csharp
public class PresentationFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PresentationFormattedTextFragment` type.

### PresentationHyperlinkActionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationhyperlinkactiontype.md

#### PresentationHyperlinkActionType enumeration

Specifies hyperlink action type.

```csharp
public enum PresentationHyperlinkActionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| MouseClick | `0` | Hyperlink is activated on mouse click. |
| MouseOver | `1` | Hyperlink is activated on mouse over. |

### PresentationImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationimagefillformat.md

#### PresentationImageFillFormat class

Represents the image fill format settings in a PowerPoint document.

```csharp
public class PresentationImageFillFormat : OfficeImageFillFormat<PresentationWatermarkableImage>
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundImage { get; set; } | Gets or sets the background image. |
| override TileAsTexture { get; set; } | Gets or sets a value indicating whether the image is tiled across the background. |
| override Transparency { get; set; } | Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### BackgroundImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationimagefillformat/backgroundimage.md

#### PresentationImageFillFormat.BackgroundImage property

Gets or sets the background image.

```csharp
public override PresentationWatermarkableImage BackgroundImage { get; set; }
```

##### Property Value

The background image. Returns null if the image is not set.

### TileAsTexture
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationimagefillformat/tileastexture.md

#### PresentationImageFillFormat.TileAsTexture property

Gets or sets a value indicating whether the image is tiled across the background.

```csharp
public override bool TileAsTexture { get; set; }
```

##### Property Value

True if the image is tiled across the background; otherwise, false (the image is stretched). The default value is false.

### Transparency
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationimagefillformat/transparency.md

#### PresentationImageFillFormat.Transparency property

Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

```csharp
public override double Transparency { get; set; }
```

##### Property Value

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

### PresentationLayoutSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationlayoutslide.md

#### PresentationLayoutSlide class

Represents a PowerPoint content layout slide.

```csharp
public class PresentationLayoutSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| MasterSlide { get; } | Gets the master slide for this `PresentationLayoutSlide`. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### MasterSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationlayoutslide/masterslide.md

#### PresentationLayoutSlide.MasterSlide property

Gets the master slide for this `PresentationLayoutSlide`.

```csharp
public PresentationMasterSlide MasterSlide { get; }
```

##### Property Value

The master slide for this `PresentationLayoutSlide`.

### PresentationLayoutSlideCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationlayoutslidecollection.md

#### PresentationLayoutSlideCollection class

Represents a collection of layout slides in a PowerPoint document.

```csharp
public class PresentationLayoutSlideCollection : ReadOnlyListBase<PresentationLayoutSlide>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(PresentationLayoutSlide) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PresentationLayoutSlide) |  |

##### Remarks

This collection contains the items of `PresentationLayoutSlide` type.

### PresentationMasterHandoutSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide.md

#### PresentationMasterHandoutSlide class

Represents a master handout slide in a PowerPoint content.

```csharp
public class PresentationMasterHandoutSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PresentationMasterNotesSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationmasternotesslide.md

#### PresentationMasterNotesSlide class

Represents a master slide for all notes slides in a PowerPoint document.

```csharp
public class PresentationMasterNotesSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PresentationMasterSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationmasterslide.md

#### PresentationMasterSlide class

Represents a PowerPoint document master slide.

```csharp
public class PresentationMasterSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PresentationMasterSlideCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationmasterslidecollection.md

#### PresentationMasterSlideCollection class

Represents a collection of master slides in a PowerPoint document.

```csharp
public class PresentationMasterSlideCollection : ReadOnlyListBase<PresentationMasterSlide>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(PresentationMasterSlide) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PresentationMasterSlide) |  |

##### Remarks

This collection contains the items of `PresentationMasterSlide` type.

### PresentationNotesSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationnotesslide.md

#### PresentationNotesSlide class

Represents a PowerPoint document notes slide.

```csharp
public class PresentationNotesSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PresentationShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape.md

#### PresentationShape class

Represents a drawing shape in a PowerPoint document.

```csharp
public class PresentationShape : PresentationBaseShape, IRotatableTwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with this `PresentationBaseShape`. |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PresentationShape`. |
| Height { get; set; } | Gets or sets the height of this `PresentationBaseShape` in points. |
| Id { get; } | Gets the identifier of this `PresentationBaseShape`. |
| Image { get; set; } | Gets or sets the image of this `PresentationShape`. |
| ImageFillFormat { get; } | Gets the image fill format settings of this `PresentationBaseShape`. |
| Name { get; } | Gets the name of this `PresentationBaseShape`. |
| Presentation { get; } | Gets the parent presentation of this `PresentationBaseShape`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `PresentationShape` in degrees. |
| ShapeType { get; } | Gets the shape geometry preset type. |
| Text { get; set; } | Gets or sets the text of this `PresentationShape`. |
| Width { get; set; } | Gets or sets the width of this `PresentationBaseShape` in points. |
| X { get; set; } | Gets or sets the horizontal offset of this `PresentationBaseShape` from presentation left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `PresentationBaseShape` from presentation top border in points. |
| ZOrderPosition { get; } | Gets the position of this `PresentationBaseShape` in the z-order. |

#### Methods

| Name | Description |
| --- | --- |
| GetHyperlink(PresentationHyperlinkActionType) | Gets the hyperlink associated with this `PresentationBaseShape`. |
| SetHyperlink(PresentationHyperlinkActionType, string) | Sets the hyperlink associated with this `PresentationBaseShape`. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape/formattedtextfragments.md

#### PresentationShape.FormattedTextFragments property

Gets the collection of formatted text fragments of this `PresentationShape`.

```csharp
public FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `PresentationShape`.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape/image.md

#### PresentationShape.Image property

Gets or sets the image of this `PresentationShape`.

```csharp
public PresentationWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `PresentationShape` or null if the shape has no image.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape/rotateangle.md

#### PresentationShape.RotateAngle property

Gets or sets the rotate angle of this `PresentationShape` in degrees.

```csharp
public double RotateAngle { get; set; }
```

##### Property Value

The rotate angle of this `PresentationShape` in degrees.

### ShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape/shapetype.md

#### PresentationShape.ShapeType property

Gets the shape geometry preset type.

```csharp
public PresentationShapeType ShapeType { get; }
```

##### Property Value

The geometry preset type.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshape/text.md

#### PresentationShape.Text property

Gets or sets the text of this `PresentationShape`.

```csharp
public string Text { get; set; }
```

##### Property Value

The text of this `PresentationShape`.

### PresentationShapeCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapecollection.md

#### PresentationShapeCollection class

Represents a collection of drawing shapes in a PowerPoint document.

```csharp
public class PresentationShapeCollection : RemoveOnlyListBase<PresentationShape>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PresentationShape) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PresentationShape) |  |
| Remove(PresentationShape) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PresentationShape` type.

### PresentationShapeSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapesettings.md

#### PresentationShapeSettings class

Represents settings that can be applied to a shape watermark for a PowerPoint document.

```csharp
public sealed class PresentationShapeSettings : OfficeShapeSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationShapeSettings() | Initializes a new instance of the `PresentationShapeSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapesettings/islocked.md

#### PresentationShapeSettings.IsLocked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in PowerPoint.

### PresentationShapeSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapesettings/presentationshapesettings.md

#### PresentationShapeSettings constructor

Initializes a new instance of the `PresentationShapeSettings` class.

```csharp
public PresentationShapeSettings()
```

### ProtectWithUnreadableCharacters
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapesettings/protectwithunreadablecharacters.md

#### PresentationShapeSettings.ProtectWithUnreadableCharacters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

```csharp
public bool ProtectWithUnreadableCharacters { get; set; }
```

##### Property Value

A value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `IsLocked` property is `true`.

### PresentationShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationshapetype.md

#### PresentationShapeType enumeration

Represents a shape geometry preset type.

```csharp
public enum PresentationShapeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NotDefined | `-1` | UndefinedDocument shape type. |
| Custom | `0` | Built-in shape geometry preset type. |
| Line | `1` | Built-in shape geometry preset type. |
| LineInverse | `2` | Built-in shape geometry preset type. |
| Triangle | `3` | Built-in shape geometry preset type. |
| RightTriangle | `4` | Built-in shape geometry preset type. |
| Rectangle | `5` | Built-in shape geometry preset type. |
| Diamond | `6` | Built-in shape geometry preset type. |
| Parallelogram | `7` | Built-in shape geometry preset type. |
| Trapezoid | `8` | Built-in shape geometry preset type. |
| NonIsoscelesTrapezoid | `9` | Built-in shape geometry preset type. |
| Pentagon | `10` | Built-in shape geometry preset type. |
| Hexagon | `11` | Built-in shape geometry preset type. |
| Heptagon | `12` | Built-in shape geometry preset type. |
| Octagon | `13` | Built-in shape geometry preset type. |
| Decagon | `14` | Built-in shape geometry preset type. |
| Dodecagon | `15` | Built-in shape geometry preset type. |
| FourPointedStar | `16` | Built-in shape geometry preset type. |
| FivePointedStar | `17` | Built-in shape geometry preset type. |
| SixPointedStar | `18` | Built-in shape geometry preset type. |
| SevenPointedStar | `19` | Built-in shape geometry preset type. |
| EightPointedStar | `20` | Built-in shape geometry preset type. |
| TenPointedStar | `21` | Built-in shape geometry preset type. |
| TwelvePointedStar | `22` | Built-in shape geometry preset type. |
| SixteenPointedStar | `23` | Built-in shape geometry preset type. |
| TwentyFourPointedStar | `24` | Built-in shape geometry preset type. |
| ThirtyTwoPointedStar | `25` | Built-in shape geometry preset type. |
| RoundCornerRectangle | `26` | Built-in shape geometry preset type. |
| OneRoundCornerRectangle | `27` | Built-in shape geometry preset type. |
| TwoSamesideRoundCornerRectangle | `28` | Built-in shape geometry preset type. |
| TwoDiagonalRoundCornerRectangle | `29` | Built-in shape geometry preset type. |
| OneSnipOneRoundCornerRectangle | `30` | Built-in shape geometry preset type. |
| OneSnipCornerRectangle | `31` | Built-in shape geometry preset type. |
| TwoSamesideSnipCornerRectangle | `32` | Built-in shape geometry preset type. |
| TwoDiagonalSnipCornerRectangle | `33` | Built-in shape geometry preset type. |
| Plaque | `34` | Built-in shape geometry preset type. |
| Ellipse | `35` | Built-in shape geometry preset type. |
| Teardrop | `36` | Built-in shape geometry preset type. |
| HomePlate | `37` | Built-in shape geometry preset type. |
| Chevron | `38` | Built-in shape geometry preset type. |
| PieWedge | `39` | Built-in shape geometry preset type. |
| Pie | `40` | Built-in shape geometry preset type. |
| BlockArc | `41` | Built-in shape geometry preset type. |
| Donut | `42` | Built-in shape geometry preset type. |
| NoSmoking | `43` | Built-in shape geometry preset type. |
| RightArrow | `44` | Built-in shape geometry preset type. |
| LeftArrow | `45` | Built-in shape geometry preset type. |
| UpArrow | `46` | Built-in shape geometry preset type. |
| DownArrow | `47` | Built-in shape geometry preset type. |
| StripedRightArrow | `48` | Built-in shape geometry preset type. |
| NotchedRightArrow | `49` | Built-in shape geometry preset type. |
| BentUpArrow | `50` | Built-in shape geometry preset type. |
| LeftRightArrow | `51` | Built-in shape geometry preset type. |
| UpDownArrow | `52` | Built-in shape geometry preset type. |
| LeftUpArrow | `53` | Built-in shape geometry preset type. |
| LeftRightUpArrow | `54` | Built-in shape geometry preset type. |
| QuadArrow | `55` | Built-in shape geometry preset type. |
| CalloutLeftArrow | `56` | Built-in shape geometry preset type. |
| CalloutRightArrow | `57` | Built-in shape geometry preset type. |
| CalloutUpArrow | `58` | Built-in shape geometry preset type. |
| CalloutDownArrow | `59` | Built-in shape geometry preset type. |
| CalloutLeftRightArrow | `60` | Built-in shape geometry preset type. |
| CalloutUpDownArrow | `61` | Built-in shape geometry preset type. |
| CalloutQuadArrow | `62` | Built-in shape geometry preset type. |
| BentArrow | `63` | Built-in shape geometry preset type. |
| UTurnArrow | `64` | Built-in shape geometry preset type. |
| CircularArrow | `65` | Built-in shape geometry preset type. |
| LeftCircularArrow | `66` | Built-in shape geometry preset type. |
| LeftRightCircularArrow | `67` | Built-in shape geometry preset type. |
| CurvedRightArrow | `68` | Built-in shape geometry preset type. |
| CurvedLeftArrow | `69` | Built-in shape geometry preset type. |
| CurvedUpArrow | `70` | Built-in shape geometry preset type. |
| CurvedDownArrow | `71` | Built-in shape geometry preset type. |
| SwooshArrow | `72` | Built-in shape geometry preset type. |
| Cube | `73` | Built-in shape geometry preset type. |
| Can | `74` | Built-in shape geometry preset type. |
| LightningBolt | `75` | Built-in shape geometry preset type. |
| Heart | `76` | Built-in shape geometry preset type. |
| Sun | `77` | Built-in shape geometry preset type. |
| Moon | `78` | Built-in shape geometry preset type. |
| SmileyFace | `79` | Built-in shape geometry preset type. |
| IrregularSeal1 | `80` | Built-in shape geometry preset type. |
| IrregularSeal2 | `81` | Built-in shape geometry preset type. |
| FoldedCorner | `82` | Built-in shape geometry preset type. |
| Bevel | `83` | Built-in shape geometry preset type. |
| Frame | `84` | Built-in shape geometry preset type. |
| HalfFrame | `85` | Built-in shape geometry preset type. |
| Corner | `86` | Built-in shape geometry preset type. |
| DiagonalStripe | `87` | Built-in shape geometry preset type. |
| Chord | `88` | Built-in shape geometry preset type. |
| CurvedArc | `89` | Built-in shape geometry preset type. |
| LeftBracket | `90` | Built-in shape geometry preset type. |
| RightBracket | `91` | Built-in shape geometry preset type. |
| LeftBrace | `92` | Built-in shape geometry preset type. |
| RightBrace | `93` | Built-in shape geometry preset type. |
| BracketPair | `94` | Built-in shape geometry preset type. |
| BracePair | `95` | Built-in shape geometry preset type. |
| StraightConnector1 | `96` | Built-in shape geometry preset type. |
| BentConnector2 | `97` | Built-in shape geometry preset type. |
| BentConnector3 | `98` | Built-in shape geometry preset type. |
| BentConnector4 | `99` | Built-in shape geometry preset type. |
| BentConnector5 | `100` | Built-in shape geometry preset type. |
| CurvedConnector2 | `101` | Built-in shape geometry preset type. |
| CurvedConnector3 | `102` | Built-in shape geometry preset type. |
| CurvedConnector4 | `103` | Built-in shape geometry preset type. |
| CurvedConnector5 | `104` | Built-in shape geometry preset type. |
| Callout1 | `105` | Built-in shape geometry preset type. |
| Callout2 | `106` | Built-in shape geometry preset type. |
| Callout3 | `107` | Built-in shape geometry preset type. |
| Callout1WithAccent | `108` | Built-in shape geometry preset type. |
| Callout2WithAccent | `109` | Built-in shape geometry preset type. |
| Callout3WithAccent | `110` | Built-in shape geometry preset type. |
| Callout1WithBorder | `111` | Built-in shape geometry preset type. |
| Callout2WithBorder | `112` | Built-in shape geometry preset type. |
| Callout3WithBorder | `113` | Built-in shape geometry preset type. |
| Callout1WithBorderAndAccent | `114` | Built-in shape geometry preset type. |
| Callout2WithBorderAndAccent | `115` | Built-in shape geometry preset type. |
| Callout3WithBorderAndAccent | `116` | Built-in shape geometry preset type. |
| CalloutWedgeRectangle | `117` | Built-in shape geometry preset type. |
| CalloutWedgeRoundRectangle | `118` | Built-in shape geometry preset type. |
| CalloutWedgeEllipse | `119` | Built-in shape geometry preset type. |
| CalloutCloud | `120` | Built-in shape geometry preset type. |
| Cloud | `121` | Built-in shape geometry preset type. |
| Ribbon | `122` | Built-in shape geometry preset type. |
| Ribbon2 | `123` | Built-in shape geometry preset type. |
| EllipseRibbon | `124` | Built-in shape geometry preset type. |
| EllipseRibbon2 | `125` | Built-in shape geometry preset type. |
| LeftRightRibbon | `126` | Built-in shape geometry preset type. |
| VerticalScroll | `127` | Built-in shape geometry preset type. |
| HorizontalScroll | `128` | Built-in shape geometry preset type. |
| Wave | `129` | Built-in shape geometry preset type. |
| DoubleWave | `130` | Built-in shape geometry preset type. |
| Plus | `131` | Built-in shape geometry preset type. |
| ProcessFlow | `132` | Built-in shape geometry preset type. |
| DecisionFlow | `133` | Built-in shape geometry preset type. |
| InputOutputFlow | `134` | Built-in shape geometry preset type. |
| PredefinedProcessFlow | `135` | Built-in shape geometry preset type. |
| InternalStorageFlow | `136` | Built-in shape geometry preset type. |
| DocumentFlow | `137` | Built-in shape geometry preset type. |
| MultiDocumentFlow | `138` | Built-in shape geometry preset type. |
| TerminatorFlow | `139` | Built-in shape geometry preset type. |
| PreparationFlow | `140` | Built-in shape geometry preset type. |
| ManualInputFlow | `141` | Built-in shape geometry preset type. |
| ManualOperationFlow | `142` | Built-in shape geometry preset type. |
| ConnectorFlow | `143` | Built-in shape geometry preset type. |
| PunchedCardFlow | `144` | Built-in shape geometry preset type. |
| PunchedTapeFlow | `145` | Built-in shape geometry preset type. |
| SummingJunctionFlow | `146` | Built-in shape geometry preset type. |
| OrFlow | `147` | Built-in shape geometry preset type. |
| CollateFlow | `148` | Built-in shape geometry preset type. |
| SortFlow | `149` | Built-in shape geometry preset type. |
| ExtractFlow | `150` | Built-in shape geometry preset type. |
| MergeFlow | `151` | Built-in shape geometry preset type. |
| OfflineStorageFlow | `152` | Built-in shape geometry preset type. |
| OnlineStorageFlow | `153` | Built-in shape geometry preset type. |
| MagneticTapeFlow | `154` | Built-in shape geometry preset type. |
| MagneticDiskFlow | `155` | Built-in shape geometry preset type. |
| MagneticDrumFlow | `156` | Built-in shape geometry preset type. |
| DisplayFlow | `157` | Built-in shape geometry preset type. |
| DelayFlow | `158` | Built-in shape geometry preset type. |
| AlternateProcessFlow | `159` | Built-in shape geometry preset type. |
| OffPageConnectorFlow | `160` | Built-in shape geometry preset type. |
| BlankButton | `161` | Built-in shape geometry preset type. |
| HomeButton | `162` | Built-in shape geometry preset type. |
| HelpButton | `163` | Built-in shape geometry preset type. |
| InformationButton | `164` | Built-in shape geometry preset type. |
| ForwardOrNextButton | `165` | Built-in shape geometry preset type. |
| BackOrPreviousButton | `166` | Built-in shape geometry preset type. |
| EndButton | `167` | Built-in shape geometry preset type. |
| BeginningButton | `168` | Built-in shape geometry preset type. |
| ReturnButton | `169` | Built-in shape geometry preset type. |
| DocumentButton | `170` | Built-in shape geometry preset type. |
| SoundButton | `171` | Built-in shape geometry preset type. |
| MovieButton | `172` | Built-in shape geometry preset type. |
| Gear6 | `173` | Built-in shape geometry preset type. |
| Gear9 | `174` | Built-in shape geometry preset type. |
| Funnel | `175` | Built-in shape geometry preset type. |
| PlusMath | `176` | Built-in shape geometry preset type. |
| MinusMath | `177` | Built-in shape geometry preset type. |
| MultiplyMath | `178` | Built-in shape geometry preset type. |
| DivideMath | `179` | Built-in shape geometry preset type. |
| EqualMath | `180` | Built-in shape geometry preset type. |
| NotEqualMath | `181` | Built-in shape geometry preset type. |
| CornerTabs | `182` | Built-in shape geometry preset type. |
| SquareTabs | `183` | Built-in shape geometry preset type. |
| PlaqueTabs | `184` | Built-in shape geometry preset type. |
| ChartX | `185` | Built-in shape geometry preset type. |
| ChartStar | `186` | Built-in shape geometry preset type. |
| ChartPlus | `187` | Built-in shape geometry preset type. |

### PresentationSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslide.md

#### PresentationSlide class

Represents a PowerPoint document slide.

```csharp
public class PresentationSlide : PresentationBaseSlide
```

#### Properties

| Name | Description |
| --- | --- |
| Charts { get; } | Gets the collection of all charts on the presentation. |
| ImageFillFormat { get; } | Gets the image fill format settings of the presentation. |
| LayoutSlide { get; } | Gets the layout slide for this `PresentationSlide`. |
| MasterSlide { get; } | Gets the master slide for this `PresentationSlide`. |
| NotesSlide { get; } | Gets the notes slide for this `PresentationSlide`. |
| Shapes { get; } | Gets the collection of all shapes of the presentation. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### LayoutSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslide/layoutslide.md

#### PresentationSlide.LayoutSlide property

Gets the layout slide for this `PresentationSlide`.

```csharp
public PresentationLayoutSlide LayoutSlide { get; }
```

##### Property Value

The layout slide for this `PresentationSlide`.

### MasterSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslide/masterslide.md

#### PresentationSlide.MasterSlide property

Gets the master slide for this `PresentationSlide`.

```csharp
public PresentationMasterSlide MasterSlide { get; }
```

##### Property Value

The master slide for this `PresentationSlide`.

### NotesSlide
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslide/notesslide.md

#### PresentationSlide.NotesSlide property

Gets the notes slide for this `PresentationSlide`.

```csharp
public PresentationNotesSlide NotesSlide { get; }
```

##### Property Value

The notes slide for this `PresentationSlide`.

### PresentationSlideCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslidecollection.md

#### PresentationSlideCollection class

Represents a collection of slides in a PowerPoint document.

```csharp
public class PresentationSlideCollection : ReadOnlyListBase<PresentationSlide>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(PresentationSlide) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PresentationSlide) |  |

##### Remarks

This collection contains the items of `PresentationSlide` type.

### PresentationSlideImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat.md

#### PresentationSlideImageFillFormat class

Represents the image fill format settings for a slide in a PowerPoint document.

```csharp
public class PresentationSlideImageFillFormat : PresentationImageFillFormat
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundImage { get; set; } | Gets or sets the background image. |
| override TileAsTexture { get; set; } | Gets or sets a value indicating whether the image is tiled across the background. |
| override Transparency { get; set; } | Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### BackgroundImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat/backgroundimage.md

#### PresentationSlideImageFillFormat.BackgroundImage property

Gets or sets the background image.

```csharp
public override PresentationWatermarkableImage BackgroundImage { get; set; }
```

##### Property Value

The background image. Returns null if the image is not set.

### PresentationWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage.md

#### PresentationWatermarkableImage class

Represents an image inside a PowerPoint document.

```csharp
public class PresentationWatermarkableImage : WatermarkableImage
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkableImage(byte[]) | Initializes a new instance of the `PresentationWatermarkableImage` class using specified image data. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### PresentationWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/presentationwatermarkableimage.md

#### PresentationWatermarkableImage constructor

Initializes a new instance of the `PresentationWatermarkableImage` class using specified image data.

```csharp
public PresentationWatermarkableImage(byte[] imageData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageData | Byte[] | The array of unsigned bytes from which to create the `PresentationWatermarkableImage`. |

### GroupDocs.Watermark.Contents.Spreadsheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet.md

The namespace provides classes for working with watermarks in Excel documents.

#### Classes

| Class | Description |
| --- | --- |
| SpreadsheetAttachment | Represents a file attached to an Excel document. |
| SpreadsheetAttachmentCollection | Represents a collection of attachments in an Excel document. |
| SpreadsheetCellFormattedTextFragment | Represents a fragment of formatted text in Excel document cell. |
| SpreadsheetCellFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document cell. |
| SpreadsheetChart | Represents a chart in an Excel document. |
| SpreadsheetChartCollection | Represents a collection of charts in an Excel document. |
| SpreadsheetContent | Represents an Excel document where a watermark can be placed. |
| SpreadsheetHeaderFooter | Represents a header/footer in an Excel document. |
| SpreadsheetHeaderFooterCollection | Represents a collection of headers and footers in an Excel document. |
| SpreadsheetHeaderFooterSection | Represents a header/footer section in an Excel document. |
| SpreadsheetHeaderFooterSectionCollection | Represents a collection of header/footer sections. |
| SpreadsheetImageFillFormat | Represents the image fill format settings in an Excel document. |
| SpreadsheetPageSetup | Represents printing page properties for a worksheet. |
| SpreadsheetShape | Represents a drawing shape in an Excel document. |
| SpreadsheetShapeCollection | Represents a collection of drawing shapes in an Excel document. |
| SpreadsheetShapeFormattedTextFragment | Represents a fragment of formatted text in Excel document shape. |
| SpreadsheetShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document text shape. |
| SpreadsheetTextEffectFormattedTextFragment | Represents a fragment of formatted text in Excel document WordArt shape. |
| SpreadsheetTextEffectFormattedTextFragmentCollection | Represents a collection of formatted text fragments in an Excel document WordArt shape. |
| SpreadsheetWatermarkableImage | Represents an image inside an Excel document. |
| SpreadsheetWorksheet | Represents an Excel document worksheet. |
| SpreadsheetWorksheetCollection | Represents a collection of worksheets in an Excel document. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| SpreadsheetAutoShapeType | Represents auto shape type. |
| SpreadsheetHeaderFooterSectionType | Represents header/footer section in Excel document. |
| SpreadsheetMsoDrawingType | Represents office drawing object type. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### SpreadsheetAttachment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment.md

#### SpreadsheetAttachment class

Represents a file attached to an Excel document.

```csharp
public class SpreadsheetAttachment : Attachment, ITwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with the attached file. |
| override Content { get; set; } | Gets or sets the attached file content. |
| Height { get; set; } | Gets or sets the height of the attachment frame in points. |
| IsLink { get; } | Gets a value indicating whether the content contains only a link to the file. |
| PreviewImageContent { get; set; } | Gets or sets the attached file preview image as a byte array. |
| SourceFullName { get; } | Gets the full name of the attached file. |
| Width { get; set; } | Gets or sets the width of the attachment frame in points. |
| X { get; set; } | Gets or sets the horizontal offset of the attachment frame from worksheet left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of the attachment frame from worksheet top border in points. |

#### Methods

| Name | Description |
| --- | --- |
| CreateWatermarker() | Loads a content from the attached file. |
| CreateWatermarker(LoadOptions) | Loads a content from the attached file with the specified load options. |
| CreateWatermarker(LoadOptions, WatermarkerSettings) | Loads a content from the attached file with the specified load options and settings. |
| GetDocumentInfo() | Gets the information about a document stored in the attached file. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/alternativetext.md

#### SpreadsheetAttachment.AlternativeText property

Gets or sets the descriptive (alternative) text associated with the attached file.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text associated with the attached file.

### Content
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/content.md

#### SpreadsheetAttachment.Content property

Gets or sets the attached file content.

```csharp
public override byte[] Content { get; set; }
```

##### Property Value

The attached file content.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/height.md

#### SpreadsheetAttachment.Height property

Gets or sets the height of the attachment frame in points.

```csharp
public double Height { get; set; }
```

##### Property Value

The height of the attachment frame in points.

### IsLink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/islink.md

#### SpreadsheetAttachment.IsLink property

Gets a value indicating whether the content contains only a link to the file.

```csharp
public bool IsLink { get; }
```

##### Property Value

True if the attached file is referenced by a link (the content does not contain attached file content); otherwise, false.

### PreviewImageContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/previewimagecontent.md

#### SpreadsheetAttachment.PreviewImageContent property

Gets or sets the attached file preview image as a byte array.

```csharp
public byte[] PreviewImageContent { get; set; }
```

##### Property Value

The attached file preview image as a byte array.

### SourceFullName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/sourcefullname.md

#### SpreadsheetAttachment.SourceFullName property

Gets the full name of the attached file.

```csharp
public string SourceFullName { get; }
```

##### Property Value

The full name of the attached file.

##### Remarks

The extension is used to determine appropriate application to open the file.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/width.md

#### SpreadsheetAttachment.Width property

Gets or sets the width of the attachment frame in points.

```csharp
public double Width { get; set; }
```

##### Property Value

The width of the attachment frame in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/x.md

#### SpreadsheetAttachment.X property

Gets or sets the horizontal offset of the attachment frame from worksheet left border in points.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of the attachment frame.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/y.md

#### SpreadsheetAttachment.Y property

Gets or sets the vertical offset of the attachment frame from worksheet top border in points.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of the attachment frame.

### SpreadsheetAttachmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection.md

#### SpreadsheetAttachmentCollection class

Represents a collection of attachments in an Excel document.

```csharp
public class SpreadsheetAttachmentCollection : RemoveOnlyListBase<SpreadsheetAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| AddAttachment(byte[], string, byte[], double, double, double, double) | Adds an attachment to the `SpreadsheetWorksheet`. |
| AddLink(string, byte[], double, double, double, double) | Adds an attachment by a link (the document will not contain attached file content). |
| Clear() |  |
| virtual Contains(SpreadsheetAttachment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetAttachment) |  |
| Remove(SpreadsheetAttachment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `SpreadsheetAttachment` type.

### AddAttachment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/addattachment.md

#### SpreadsheetAttachmentCollection.AddAttachment method

Adds an attachment to the `SpreadsheetWorksheet`.

```csharp
public void AddAttachment(byte[] fileContent, string sourceFullName, byte[] previewImageContent, 
    double x, double y, double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fileContent | Byte[] | The content of the file to be attached. |
| sourceFullName | String | The full name of the attached file (The extension is used to determine appropriate application to open the file). |
| previewImageContent | Byte[] | The attached file preview image as a byte array. |
| x | Double | The x-coordinate of the attachment frame (in points). |
| y | Double | The y-coordinate of the attachment frame (in points). |
| width | Double | The width of the attachment frame in points. |
| height | Double | The height of the attachment frame in points. |

### AddLink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/addlink.md

#### SpreadsheetAttachmentCollection.AddLink method

Adds an attachment by a link (the document will not contain attached file content).

```csharp
public void AddLink(string sourceFullName, byte[] previewImageContent, double x, double y, 
    double width, double height)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceFullName | String | The linked file path. |
| previewImageContent | Byte[] | The attached file preview image as a byte array. |
| x | Double | The x-coordinate of the attachment frame (in points). |
| y | Double | The y-coordinate of the attachment frame (in points). |
| width | Double | The width of the attachment frame in points. |
| height | Double | The height of the attachment frame in points. |

### SpreadsheetAutoShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype.md

#### SpreadsheetAutoShapeType enumeration

Represents auto shape type.

```csharp
public enum SpreadsheetAutoShapeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| NotPrimitive | `0` | Built-in auto shape type. |
| Rectangle | `1` | Built-in auto shape type. |
| RoundedRectangle | `2` | Built-in auto shape type. |
| Oval | `3` | Built-in auto shape type. |
| Diamond | `4` | Built-in auto shape type. |
| IsoscelesTriangle | `5` | Built-in auto shape type. |
| RightTriangle | `6` | Built-in auto shape type. |
| Parallelogram | `7` | Built-in auto shape type. |
| Trapezoid | `8` | Built-in auto shape type. |
| Hexagon | `9` | Built-in auto shape type. |
| Octagon | `10` | Built-in auto shape type. |
| Cross | `11` | Built-in auto shape type. |
| Star5 | `12` | Built-in auto shape type. |
| RightArrow | `13` | Built-in auto shape type. |
| HomePlate | `15` | Built-in auto shape type. |
| Cube | `16` | Built-in auto shape type. |
| Balloon | `17` | Built-in auto shape type. |
| Seal | `18` | Built-in auto shape type. |
| Arc | `19` | Built-in auto shape type. |
| Line | `20` | Built-in auto shape type. |
| Plaque | `21` | Built-in auto shape type. |
| Can | `22` | Built-in auto shape type. |
| Donut | `23` | Built-in auto shape type. |
| TextSimple | `24` | Built-in auto shape type. |
| TextOctagon | `25` | Built-in auto shape type. |
| TextHexagon | `26` | Built-in auto shape type. |
| TextCurve | `27` | Built-in auto shape type. |
| TextWave | `28` | Built-in auto shape type. |
| TextRing | `29` | Built-in auto shape type. |
| TextOnCurve | `30` | Built-in auto shape type. |
| TextOnRing | `31` | Built-in auto shape type. |
| StraightConnector | `32` | Built-in auto shape type. |
| BentConnector2 | `33` | Built-in auto shape type. |
| ElbowConnector | `34` | Built-in auto shape type. |
| BentConnector4 | `35` | Built-in auto shape type. |
| BentConnector5 | `36` | Built-in auto shape type. |
| CurvedConnector2 | `37` | Built-in auto shape type. |
| CurvedConnector | `38` | Built-in auto shape type. |
| CurvedConnector4 | `39` | Built-in auto shape type. |
| CurvedConnector5 | `40` | Built-in auto shape type. |
| LineCalloutNoBorder2 | `41` | Built-in auto shape type. |
| LineCalloutNoBorder3 | `42` | Built-in auto shape type. |
| LineCalloutNoBorder4 | `43` | Built-in auto shape type. |
| LineCalloutWithAccentBar2 | `44` | Built-in auto shape type. |
| LineCalloutWithAccentBar3 | `45` | Built-in auto shape type. |
| LineCalloutWithAccentBar4 | `46` | Built-in auto shape type. |
| LineCalloutWithBorder2 | `47` | Built-in auto shape type. |
| LineCalloutWithBorder3 | `48` | Built-in auto shape type. |
| LineCalloutWithBorder4 | `49` | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar2 | `50` | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar3 | `51` | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar4 | `52` | Built-in auto shape type. |
| DownRibbon | `53` | Built-in auto shape type. |
| UpRibbon | `54` | Built-in auto shape type. |
| Chevron | `55` | Built-in auto shape type. |
| RegularPentagon | `56` | Built-in auto shape type. |
| NoSymbol | `57` | Built-in auto shape type. |
| Star8 | `58` | Built-in auto shape type. |
| Star16 | `59` | Built-in auto shape type. |
| Star32 | `60` | Built-in auto shape type. |
| RectangularCallout | `61` | Built-in auto shape type. |
| RoundedRectangularCallout | `62` | Built-in auto shape type. |
| OvalCallout | `63` | Built-in auto shape type. |
| Wave | `64` | Built-in auto shape type. |
| FoldedCorner | `65` | Built-in auto shape type. |
| LeftArrow | `66` | Built-in auto shape type. |
| DownArrow | `67` | Built-in auto shape type. |
| UpArrow | `68` | Built-in auto shape type. |
| LeftRightArrow | `69` | Built-in auto shape type. |
| UpDownArrow | `70` | Built-in auto shape type. |
| Explosion1 | `71` | Built-in auto shape type. |
| Explosion2 | `72` | Built-in auto shape type. |
| LightningBolt | `73` | Built-in auto shape type. |
| Heart | `74` | Built-in auto shape type. |
| PictureFrame | `75` | Built-in auto shape type. |
| QuadArrow | `76` | Built-in auto shape type. |
| LeftArrowCallout | `77` | Built-in auto shape type. |
| RightArrowCallout | `78` | Built-in auto shape type. |
| UpArrowCallout | `79` | Built-in auto shape type. |
| DownArrowCallout | `80` | Built-in auto shape type. |
| LeftRightArrowCallout | `81` | Built-in auto shape type. |
| UpDownArrowCallout | `82` | Built-in auto shape type. |
| QuadArrowCallout | `83` | Built-in auto shape type. |
| Bevel | `84` | Built-in auto shape type. |
| LeftBracket | `85` | Built-in auto shape type. |
| RightBracket | `86` | Built-in auto shape type. |
| LeftBrace | `87` | Built-in auto shape type. |
| RightBrace | `88` | Built-in auto shape type. |
| LeftUpArrow | `89` | Built-in auto shape type. |
| BentUpArrow | `90` | Built-in auto shape type. |
| BentArrow | `91` | Built-in auto shape type. |
| Star24 | `92` | Built-in auto shape type. |
| StripedRightArrow | `93` | Built-in auto shape type. |
| NotchedRightArrow | `94` | Built-in auto shape type. |
| BlockArc | `95` | Built-in auto shape type. |
| SmileyFace | `96` | Built-in auto shape type. |
| VerticalScroll | `97` | Built-in auto shape type. |
| HorizontalScroll | `98` | Built-in auto shape type. |
| CircularArrow | `99` | Built-in auto shape type. |
| NotchedCircularArrow | `100` | Built-in auto shape type. |
| UTurnArrow | `101` | Built-in auto shape type. |
| CurvedRightArrow | `102` | Built-in auto shape type. |
| CurvedLeftArrow | `103` | Built-in auto shape type. |
| CurvedUpArrow | `104` | Built-in auto shape type. |
| CurvedDownArrow | `105` | Built-in auto shape type. |
| CloudCallout | `106` | Built-in auto shape type. |
| CurvedDownRibbon | `107` | Built-in auto shape type. |
| CurvedUpRibbon | `108` | Built-in auto shape type. |
| FlowChartProcess | `109` | Built-in auto shape type. |
| FlowChartDecision | `110` | Built-in auto shape type. |
| FlowChartData | `111` | Built-in auto shape type. |
| FlowChartPredefinedProcess | `112` | Built-in auto shape type. |
| FlowChartInternalStorage | `113` | Built-in auto shape type. |
| FlowChartDocument | `114` | Built-in auto shape type. |
| FlowChartMultidocument | `115` | Built-in auto shape type. |
| FlowChartTerminator | `116` | Built-in auto shape type. |
| FlowChartPreparation | `117` | Built-in auto shape type. |
| FlowChartManualInput | `118` | Built-in auto shape type. |
| FlowChartManualOperation | `119` | Built-in auto shape type. |
| FlowChartConnector | `120` | Built-in auto shape type. |
| FlowChartCard | `121` | Built-in auto shape type. |
| FlowChartPunchedTape | `122` | Built-in auto shape type. |
| FlowChartSummingJunction | `123` | Built-in auto shape type. |
| FlowChartOr | `124` | Built-in auto shape type. |
| FlowChartCollate | `125` | Built-in auto shape type. |
| FlowChartSort | `126` | Built-in auto shape type. |
| FlowChartExtract | `127` | Built-in auto shape type. |
| FlowChartMerge | `128` | Built-in auto shape type. |
| FlowChartOfflineStorage | `129` | Built-in auto shape type. |
| FlowChartStoredData | `130` | Built-in auto shape type. |
| FlowChartSequentialAccessStorage | `131` | Built-in auto shape type. |
| FlowChartMagneticDisk | `132` | Built-in auto shape type. |
| FlowChartDirectAccessStorage | `133` | Built-in auto shape type. |
| FlowChartDisplay | `134` | Built-in auto shape type. |
| FlowChartDelay | `135` | Built-in auto shape type. |
| TextPlainText | `136` | Built-in auto shape type. |
| TextStop | `137` | Built-in auto shape type. |
| TextTriangle | `138` | Built-in auto shape type. |
| TextTriangleInverted | `139` | Built-in auto shape type. |
| TextChevron | `140` | Built-in auto shape type. |
| TextChevronInverted | `141` | Built-in auto shape type. |
| TextRingInside | `142` | Built-in auto shape type. |
| TextRingOutside | `143` | Built-in auto shape type. |
| TextArchUpCurve | `144` | Built-in auto shape type. |
| TextArchDownCurve | `145` | Built-in auto shape type. |
| TextCircleCurve | `146` | Built-in auto shape type. |
| TextButtonCurve | `147` | Built-in auto shape type. |
| TextArchUpPour | `148` | Built-in auto shape type. |
| TextArchDownPour | `149` | Built-in auto shape type. |
| TextCirclePour | `150` | Built-in auto shape type. |
| TextButtonPour | `151` | Built-in auto shape type. |
| TextCurveUp | `152` | Built-in auto shape type. |
| TextCurveDown | `153` | Built-in auto shape type. |
| TextCascadeUp | `154` | Built-in auto shape type. |
| TextCascadeDown | `155` | Built-in auto shape type. |
| TextWave1 | `156` | Built-in auto shape type. |
| TextWave2 | `157` | Built-in auto shape type. |
| TextDoubleWave1 | `158` | Built-in auto shape type. |
| TextDoubleWave2 | `159` | Built-in auto shape type. |
| TextInflate | `160` | Built-in auto shape type. |
| TextDeflate | `161` | Built-in auto shape type. |
| TextInflateBottom | `162` | Built-in auto shape type. |
| TextDeflateBottom | `163` | Built-in auto shape type. |
| TextInflateTop | `164` | Built-in auto shape type. |
| TextDeflateTop | `165` | Built-in auto shape type. |
| TextDeflateInflate | `166` | Built-in auto shape type. |
| TextDeflateInflateDeflate | `167` | Built-in auto shape type. |
| TextFadeRight | `168` | Built-in auto shape type. |
| TextFadeLeft | `169` | Built-in auto shape type. |
| TextFadeUp | `170` | Built-in auto shape type. |
| TextFadeDown | `171` | Built-in auto shape type. |
| TextSlantUp | `172` | Built-in auto shape type. |
| TextSlantDown | `173` | Built-in auto shape type. |
| TextCanUp | `174` | Built-in auto shape type. |
| TextCanDown | `175` | Built-in auto shape type. |
| FlowChartAlternateProcess | `176` | Built-in auto shape type. |
| FlowChartOffpageConnector | `177` | Built-in auto shape type. |
| LineCalloutNoBorder1 | `178` | Built-in auto shape type. |
| LineCalloutWithAccentBar1 | `179` | Built-in auto shape type. |
| LineCalloutWithBorder1 | `180` | Built-in auto shape type. |
| LineCalloutWithBorderAndAccentBar1 | `181` | Built-in auto shape type. |
| LeftRightUpArrow | `182` | Built-in auto shape type. |
| Sun | `183` | Built-in auto shape type. |
| Moon | `184` | Built-in auto shape type. |
| DoubleBracket | `185` | Built-in auto shape type. |
| DoubleBrace | `186` | Built-in auto shape type. |
| Star4 | `187` | Built-in auto shape type. |
| DoubleWave | `188` | Built-in auto shape type. |
| BlankActionButton | `189` | Built-in auto shape type. |
| HomeActionButton | `190` | Built-in auto shape type. |
| HelpActionButton | `191` | Built-in auto shape type. |
| InformationActionButton | `192` | Built-in auto shape type. |
| ForwardNextActionButton | `193` | Built-in auto shape type. |
| BackPreviousActionButton | `194` | Built-in auto shape type. |
| EndActionButton | `195` | Built-in auto shape type. |
| BeginningActionButton | `196` | Built-in auto shape type. |
| ReturnActionButton | `197` | Built-in auto shape type. |
| DocumentActionButton | `198` | Built-in auto shape type. |
| SoundActionButton | `199` | Built-in auto shape type. |
| MovieActionButton | `200` | Built-in auto shape type. |
| HostControl | `201` | Built-in auto shape type. |
| TextBox | `202` | Built-in auto shape type. |
| Heptagon | `2049` | Built-in auto shape type. |
| Decagon | `2050` | Built-in auto shape type. |
| Dodecagon | `2051` | Built-in auto shape type. |
| Star6 | `2052` | Built-in auto shape type. |
| Star7 | `2053` | Built-in auto shape type. |
| Star10 | `2054` | Built-in auto shape type. |
| Star12 | `2055` | Built-in auto shape type. |
| RoundSingleCornerRectangle | `2056` | Built-in auto shape type. |
| RoundSameSideCornerRectangle | `2057` | Built-in auto shape type. |
| RoundDiagonalCornerRectangle | `2058` | Built-in auto shape type. |
| SnipRoundSingleCornerRectangle | `2059` | Built-in auto shape type. |
| SnipSingleCornerRectangle | `2060` | Built-in auto shape type. |
| SnipSameSideCornerRectangle | `2061` | Built-in auto shape type. |
| SnipDiagonalCornerRectangle | `2062` | Built-in auto shape type. |
| Teardrop | `2063` | Built-in auto shape type. |
| Pie | `2064` | Built-in auto shape type. |
| HalfFrame | `2066` | Built-in auto shape type. |
| LShape | `2067` | Built-in auto shape type. |
| DiagonalStripe | `2068` | Built-in auto shape type. |
| Chord | `2069` | Built-in auto shape type. |
| Cloud | `2070` | Built-in auto shape type. |
| MathPlus | `2071` | Built-in auto shape type. |
| MathMinus | `2072` | Built-in auto shape type. |
| MathMultiply | `2073` | Built-in auto shape type. |
| MathDivide | `2074` | Built-in auto shape type. |
| MathEqual | `2075` | Built-in auto shape type. |
| MathNotEqual | `2076` | Built-in auto shape type. |
| LineInv | `2077` | Built-in auto shape type. |
| NonIsoscelesTrapezoid | `2078` | Built-in auto shape type. |
| PieWedge | `2079` | Built-in auto shape type. |
| LeftCircularArrow | `2080` | Built-in auto shape type. |
| LeftRightCircularArrow | `2081` | Built-in auto shape type. |
| SwooshArrow | `2082` | Built-in auto shape type. |
| LeftRightRibbon | `2083` | Built-in auto shape type. |
| TextNoShape | `2084` | Built-in auto shape type. |
| Gear6 | `2097` | Built-in auto shape type. |
| Gear9 | `2098` | Built-in auto shape type. |
| Funnel | `2099` | Built-in auto shape type. |
| CornerTabs | `2100` | Built-in auto shape type. |
| SquareTabs | `2101` | Built-in auto shape type. |
| PlaqueTabs | `2102` | Built-in auto shape type. |
| ChartX | `2103` | Built-in auto shape type. |
| ChartStar | `2104` | Built-in auto shape type. |
| ChartPlus | `2105` | Built-in auto shape type. |
| Frame | `2106` | Built-in auto shape type. |
| Model3D | `2107` | Built-in auto shape type. |
| RoundCallout | `2108` | There is no such type in Excel. |
| TextArchLeftPour | `2109` | There is no such type in Excel. |
| TextArchRightPour | `2110` | There is no such type in Excel. |
| TextArchLeftCurve | `2111` | There is no such type in Excel. |
| TextArchRightCurve | `2112` | There is no such type in Excel. |
| Unknown | `4095` | Unknown auto shape type. |

### SpreadsheetCellFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment.md

#### SpreadsheetCellFormattedTextFragment class

Represents a fragment of formatted text in Excel document cell.

```csharp
public class SpreadsheetCellFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/backgroundcolor.md

#### SpreadsheetCellFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/font.md

#### SpreadsheetCellFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/foregroundcolor.md

#### SpreadsheetCellFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/text.md

#### SpreadsheetCellFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### SpreadsheetCellFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragmentcollection.md

#### SpreadsheetCellFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document cell.

```csharp
public class SpreadsheetCellFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `SpreadsheetCellFormattedTextFragment` type.

### SpreadsheetChart
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart.md

#### SpreadsheetChart class

Represents a chart in an Excel document.

```csharp
public class SpreadsheetChart : ITwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; } | Gets the descriptive (alternative) text associated with this `SpreadsheetChart`. |
| Height { get; } | Gets the height of this `SpreadsheetChart` in points. |
| Hyperlink { get; set; } | Gets or sets the hyperlink associated with this `SpreadsheetChart`. |
| Id { get; } | Gets the identifier of this `SpreadsheetChart`. |
| ImageFillFormat { get; } | Gets the image fill format settings of this `SpreadsheetChart`. |
| Name { get; } | Gets the name of this `SpreadsheetChart`. |
| Width { get; } | Gets the width of this `SpreadsheetChart` in points. |
| Worksheet { get; } | Gets the parent worksheet of this `SpreadsheetChart`. |
| X { get; } | Gets the horizontal offset of this `SpreadsheetChart` from worksheet left border in points. |
| Y { get; } | Gets the vertical offset of this `SpreadsheetChart` from worksheet top border in points. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/alternativetext.md

#### SpreadsheetChart.AlternativeText property

Gets the descriptive (alternative) text associated with this `SpreadsheetChart`.

```csharp
public string AlternativeText { get; }
```

##### Property Value

The descriptive (alternative) text associated with this `SpreadsheetChart`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/height.md

#### SpreadsheetChart.Height property

Gets the height of this `SpreadsheetChart` in points.

```csharp
public double Height { get; }
```

##### Property Value

The height of this `SpreadsheetChart` in points.

### Hyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/hyperlink.md

#### SpreadsheetChart.Hyperlink property

Gets or sets the hyperlink associated with this `SpreadsheetChart`.

```csharp
public string Hyperlink { get; set; }
```

##### Property Value

The hyperlink associated with this `SpreadsheetChart`.

### Id
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/id.md

#### SpreadsheetChart.Id property

Gets the identifier of this `SpreadsheetChart`.

```csharp
public int Id { get; }
```

##### Property Value

The identifier of this `SpreadsheetChart`.

### ImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/imagefillformat.md

#### SpreadsheetChart.ImageFillFormat property

Gets the image fill format settings of this `SpreadsheetChart`.

```csharp
public SpreadsheetImageFillFormat ImageFillFormat { get; }
```

##### Property Value

The image fill format settings of this `SpreadsheetChart`.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/name.md

#### SpreadsheetChart.Name property

Gets the name of this `SpreadsheetChart`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `SpreadsheetChart`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/width.md

#### SpreadsheetChart.Width property

Gets the width of this `SpreadsheetChart` in points.

```csharp
public double Width { get; }
```

##### Property Value

The width of this `SpreadsheetChart` in points.

### Worksheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/worksheet.md

#### SpreadsheetChart.Worksheet property

Gets the parent worksheet of this `SpreadsheetChart`.

```csharp
public SpreadsheetWorksheet Worksheet { get; }
```

##### Property Value

The parent worksheet of this `SpreadsheetChart`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/x.md

#### SpreadsheetChart.X property

Gets the horizontal offset of this `SpreadsheetChart` from worksheet left border in points.

```csharp
public double X { get; }
```

##### Property Value

The x-coordinate of this `SpreadsheetChart`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/y.md

#### SpreadsheetChart.Y property

Gets the vertical offset of this `SpreadsheetChart` from worksheet top border in points.

```csharp
public double Y { get; }
```

##### Property Value

The y-coordinate of this `SpreadsheetChart`.

### SpreadsheetChartCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetchartcollection.md

#### SpreadsheetChartCollection class

Represents a collection of charts in an Excel document.

```csharp
public class SpreadsheetChartCollection : ReadOnlyListBase<SpreadsheetChart>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(SpreadsheetChart) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetChart) |  |

##### Remarks

This collection contains the items of `SpreadsheetChart` type.

### SpreadsheetContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent.md

#### SpreadsheetContent class

Represents an Excel document where a watermark can be placed.

```csharp
public class SpreadsheetContent : Content
```

#### Properties

| Name | Description |
| --- | --- |
| Worksheets { get; } | Gets the collection of all worksheets of this `SpreadsheetContent`. |

#### Methods

| Name | Description |
| --- | --- |
| Decrypt() | Decrypts the document. |
| Dispose() | Disposes the current instance. |
| Encrypt(string) | Encrypts the content. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

##### Remarks

**Learn more:**

* [Add watermarks to spreadsheet documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents)
* [Shapes in spreadsheet document](https://docs.groupdocs.com/display/watermarknet/Shapes+in+spreadsheet+document)
* [Working with spreadsheet document attachments](https://docs.groupdocs.com/display/watermarknet/Working+with+spreadsheet+document+attachments)
* [Working with worksheet backgrounds](https://docs.groupdocs.com/display/watermarknet/Working+with+worksheet+backgrounds)
* [Working with worksheet headers and footers](https://docs.groupdocs.com/display/watermarknet/Working+with+worksheet+headers+and+footers)

##### Examples

Load and save Excel document of any supported type.

```csharp
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\input.xls", loadOptions))
{
    // Use Add method to add watermark to a particular or all worksheets.

    // Save changes.
    watermarker.Save(@"D:\output.xls");
}
```

### Decrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/decrypt.md

#### SpreadsheetContent.Decrypt method

Decrypts the document.

```csharp
public void Decrypt()
```

### Encrypt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/encrypt.md

#### SpreadsheetContent.Encrypt method

Encrypts the content.

```csharp
public void Encrypt(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password that will be required to open the document. |

### Worksheets
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/worksheets.md

#### SpreadsheetContent.Worksheets property

Gets the collection of all worksheets of this `SpreadsheetContent`.

```csharp
public SpreadsheetWorksheetCollection Worksheets { get; }
```

##### Property Value

The collection of all worksheets of this `SpreadsheetContent`.

### SpreadsheetHeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter.md

#### SpreadsheetHeaderFooter class

Represents a header/footer in an Excel document.

```csharp
public class SpreadsheetHeaderFooter
```

#### Properties

| Name | Description |
| --- | --- |
| HeaderFooterType { get; } | Gets the type of this `SpreadsheetHeaderFooter`. |
| Sections { get; } | Gets the collection of header/footer sections. |
| Worksheet { get; } | Gets the parent worksheet of this `SpreadsheetHeaderFooter`. |

### HeaderFooterType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/headerfootertype.md

#### SpreadsheetHeaderFooter.HeaderFooterType property

Gets the type of this `SpreadsheetHeaderFooter`.

```csharp
public OfficeHeaderFooterType HeaderFooterType { get; }
```

##### Property Value

The type of this `SpreadsheetHeaderFooter`.

### Sections
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/sections.md

#### SpreadsheetHeaderFooter.Sections property

Gets the collection of header/footer sections.

```csharp
public SpreadsheetHeaderFooterSectionCollection Sections { get; }
```

##### Property Value

The collection of header/footer sections.

### Worksheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/worksheet.md

#### SpreadsheetHeaderFooter.Worksheet property

Gets the parent worksheet of this `SpreadsheetHeaderFooter`.

```csharp
public SpreadsheetWorksheet Worksheet { get; }
```

##### Property Value

The parent worksheet of this `SpreadsheetHeaderFooter`.

### SpreadsheetHeaderFooterCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootercollection.md

#### SpreadsheetHeaderFooterCollection class

Represents a collection of headers and footers in an Excel document.

```csharp
public class SpreadsheetHeaderFooterCollection : ReadOnlyListBase<SpreadsheetHeaderFooter>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |
| Item { get; } | Gets the header or footer of specified type. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(SpreadsheetHeaderFooter) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetHeaderFooter) |  |

##### Remarks

This collection contains the items of `SpreadsheetHeaderFooter` type.

### Item
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootercollection/item.md

#### SpreadsheetHeaderFooterCollection indexer

Gets the header or footer of specified type.

```csharp
public SpreadsheetHeaderFooter this[OfficeHeaderFooterType headerFooterType] { get; }
```

| Parameter | Description |
| --- | --- |
| headerFooterType | A `OfficeHeaderFooterType` value that specifies the type of the header/footer to get. |

##### Property Value

The `SpreadsheetHeaderFooter` of specified type.

### SpreadsheetHeaderFooterSection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection.md

#### SpreadsheetHeaderFooterSection class

Represents a header/footer section in an Excel document.

```csharp
public class SpreadsheetHeaderFooterSection
```

#### Properties

| Name | Description |
| --- | --- |
| HeaderFooter { get; } | Gets the parent header/footer of this `SpreadsheetHeaderFooterSection`. |
| Image { get; set; } | Gets or sets the image of this `SpreadsheetHeaderFooterSection`. |
| Script { get; set; } | Gets or sets the script formatting of this `SpreadsheetHeaderFooterSection`. |
| SectionType { get; } | Gets the type of this `SpreadsheetHeaderFooterSection`. |

### HeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/headerfooter.md

#### SpreadsheetHeaderFooterSection.HeaderFooter property

Gets the parent header/footer of this `SpreadsheetHeaderFooterSection`.

```csharp
public SpreadsheetHeaderFooter HeaderFooter { get; }
```

##### Property Value

The parent header/footer of this `SpreadsheetHeaderFooterSection`.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/image.md

#### SpreadsheetHeaderFooterSection.Image property

Gets or sets the image of this `SpreadsheetHeaderFooterSection`.

```csharp
public SpreadsheetWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `SpreadsheetHeaderFooterSection`. Returns null if the section has no image.

### Script
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/script.md

#### SpreadsheetHeaderFooterSection.Script property

Gets or sets the script formatting of this `SpreadsheetHeaderFooterSection`.

```csharp
public string Script { get; set; }
```

##### Property Value

The script content of this `SpreadsheetHeaderFooterSection`.

### SectionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/sectiontype.md

#### SpreadsheetHeaderFooterSection.SectionType property

Gets the type of this `SpreadsheetHeaderFooterSection`.

```csharp
public SpreadsheetHeaderFooterSectionType SectionType { get; }
```

##### Property Value

The type of this `SpreadsheetHeaderFooterSection`.

### SpreadsheetHeaderFooterSectionCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectioncollection.md

#### SpreadsheetHeaderFooterSectionCollection class

Represents a collection of header/footer sections.

```csharp
public class SpreadsheetHeaderFooterSectionCollection : 
    ReadOnlyListBase<SpreadsheetHeaderFooterSection>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |
| Item { get; } | Gets the header/footer section of specified type. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(SpreadsheetHeaderFooterSection) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetHeaderFooterSection) |  |

##### Remarks

This collection contains the items of `SpreadsheetHeaderFooterSection` type.

### Item
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectioncollection/item.md

#### SpreadsheetHeaderFooterSectionCollection indexer

Gets the header/footer section of specified type.

```csharp
public SpreadsheetHeaderFooterSection this[
    SpreadsheetHeaderFooterSectionType headerFooterSectionType] { get; }
```

| Parameter | Description |
| --- | --- |
| headerFooterSectionType | A `SpreadsheetHeaderFooterSectionType` value that specifies the type of the section to get. |

##### Property Value

The `SpreadsheetHeaderFooterSection` of specified type.

### SpreadsheetHeaderFooterSectionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectiontype.md

#### SpreadsheetHeaderFooterSectionType enumeration

Represents header/footer section in Excel document.

```csharp
public enum SpreadsheetHeaderFooterSectionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Left | `0` | Left section. |
| Center | `1` | Center section. |
| Right | `2` | Right section. |

### SpreadsheetImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat.md

#### SpreadsheetImageFillFormat class

Represents the image fill format settings in an Excel document.

```csharp
public class SpreadsheetImageFillFormat : OfficeImageFillFormat<SpreadsheetWatermarkableImage>
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundImage { get; set; } | Gets or sets the background image. |
| override TileAsTexture { get; set; } | Gets or sets a value indicating whether the image is tiled across the background. |
| override Transparency { get; set; } | Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### BackgroundImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/backgroundimage.md

#### SpreadsheetImageFillFormat.BackgroundImage property

Gets or sets the background image.

```csharp
public override SpreadsheetWatermarkableImage BackgroundImage { get; set; }
```

##### Property Value

The background image. Returns null if the image is not set.

### TileAsTexture
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/tileastexture.md

#### SpreadsheetImageFillFormat.TileAsTexture property

Gets or sets a value indicating whether the image is tiled across the background.

```csharp
public override bool TileAsTexture { get; set; }
```

##### Property Value

True if the image is tiled across the background; otherwise, false (the image is stretched).

### Transparency
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/transparency.md

#### SpreadsheetImageFillFormat.Transparency property

Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

```csharp
public override double Transparency { get; set; }
```

##### Property Value

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

### SpreadsheetMsoDrawingType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype.md

#### SpreadsheetMsoDrawingType enumeration

Represents office drawing object type.

```csharp
public enum SpreadsheetMsoDrawingType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Group | `0` | Built-in drawing type. |
| Line | `1` | Built-in drawing type. |
| Rectangle | `2` | Built-in drawing type. |
| Oval | `3` | Built-in drawing type. |
| Arc | `4` | Built-in drawing type. |
| Chart | `5` | Built-in drawing type. |
| TextBox | `6` | Built-in drawing type. |
| Button | `7` | Built-in drawing type. |
| Picture | `8` | Built-in drawing type. |
| Polygon | `9` | Built-in drawing type. |
| CheckBox | `11` | Built-in drawing type. |
| RadioButton | `12` | Built-in drawing type. |
| Label | `14` | Built-in drawing type. |
| DialogBox | `15` | Built-in drawing type. |
| Spinner | `16` | Built-in drawing type. |
| ScrollBar | `17` | Built-in drawing type. |
| ListBox | `18` | Built-in drawing type. |
| GroupBox | `19` | Built-in drawing type. |
| ComboBox | `20` | Built-in drawing type. |
| OleObject | `24` | Built-in drawing type. |
| Comment | `25` | Built-in drawing type. |
| Unknown | `29` | Built-in drawing type. |
| CellsDrawing | `30` | Built-in drawing type. |
| Slicer | `31` | Built-in drawing type. |
| WebExtension | `32` | Built-in drawing type. |
| SmartArt | `33` | Built-in drawing type. |
| CustomXml | `34` | Built-in drawing type. |
| Timeline | `35` | Built-in drawing type. |
| Model3D | `36` | Built-in drawing type. |

### SpreadsheetPageSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup.md

#### SpreadsheetPageSetup class

Represents printing page properties for a worksheet.

```csharp
public class SpreadsheetPageSetup
```

#### Properties

| Name | Description |
| --- | --- |
| BottomMargin { get; } | Gets the size of the bottom margin in points. |
| Height { get; } | Gets the height of a printing page in points. |
| LeftMargin { get; } | Gets the size of the left margin in points. |
| RightMargin { get; } | Gets the size of the right margin in points. |
| TopMargin { get; } | Gets the size of the top margin in points. |
| Width { get; } | Gets the width of a printing page in points. |

### BottomMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/bottommargin.md

#### SpreadsheetPageSetup.BottomMargin property

Gets the size of the bottom margin in points.

```csharp
public double BottomMargin { get; }
```

##### Property Value

The size of the bottom margin in points.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/height.md

#### SpreadsheetPageSetup.Height property

Gets the height of a printing page in points.

```csharp
public double Height { get; }
```

##### Property Value

The height of a printing page in points.

### LeftMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/leftmargin.md

#### SpreadsheetPageSetup.LeftMargin property

Gets the size of the left margin in points.

```csharp
public double LeftMargin { get; }
```

##### Property Value

The size of the left margin in points.

### RightMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/rightmargin.md

#### SpreadsheetPageSetup.RightMargin property

Gets the size of the right margin in points.

```csharp
public double RightMargin { get; }
```

##### Property Value

The size of the right margin in points.

### TopMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/topmargin.md

#### SpreadsheetPageSetup.TopMargin property

Gets the size of the top margin in points.

```csharp
public double TopMargin { get; }
```

##### Property Value

The size of the top margin in points.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/width.md

#### SpreadsheetPageSetup.Width property

Gets the width of a printing page in points.

```csharp
public double Width { get; }
```

##### Property Value

The width of a printing page in points.

### SpreadsheetShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape.md

#### SpreadsheetShape class

Represents a drawing shape in an Excel document.

```csharp
public class SpreadsheetShape : ShapeSearchAdapter, IRotatableTwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with this `SpreadsheetShape`. |
| AutoShapeType { get; } | Gets the auto shape type. |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `SpreadsheetShape`. |
| Height { get; set; } | Gets or sets the height of this `SpreadsheetShape` in points. |
| Hyperlink { get; set; } | Gets or sets the hyperlink associated with this `SpreadsheetShape`. |
| Id { get; } | Gets the identifier of this `SpreadsheetShape`. |
| Image { get; set; } | Gets or sets the image of this `SpreadsheetShape`. |
| ImageFillFormat { get; } | Gets the image fill format settings of this `SpreadsheetShape`. |
| IsWordArt { get; } | Gets a value indicating whether this `SpreadsheetShape` is a WordArt object. |
| MsoDrawingType { get; } | Gets the mso drawing type. |
| Name { get; } | Gets the name of this `SpreadsheetShape`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `SpreadsheetShape` in degrees. |
| Text { get; set; } | Gets or sets the text of this `SpreadsheetShape`. |
| Width { get; set; } | Gets or sets the width of this `SpreadsheetShape` in points. |
| Worksheet { get; } | Gets the parent worksheet of this `SpreadsheetShape`. |
| X { get; set; } | Gets or sets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `SpreadsheetShape` from worksheet top border in points. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/alternativetext.md

#### SpreadsheetShape.AlternativeText property

Gets or sets the descriptive (alternative) text associated with this `SpreadsheetShape`.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text associated with this `SpreadsheetShape`.

### AutoShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/autoshapetype.md

#### SpreadsheetShape.AutoShapeType property

Gets the auto shape type.

```csharp
public SpreadsheetAutoShapeType AutoShapeType { get; }
```

##### Property Value

The auto shape type.

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/formattedtextfragments.md

#### SpreadsheetShape.FormattedTextFragments property

Gets the collection of formatted text fragments of this `SpreadsheetShape`.

```csharp
public FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `SpreadsheetShape`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/height.md

#### SpreadsheetShape.Height property

Gets or sets the height of this `SpreadsheetShape` in points.

```csharp
public double Height { get; set; }
```

##### Property Value

The height of this `SpreadsheetShape` in points.

### Hyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/hyperlink.md

#### SpreadsheetShape.Hyperlink property

Gets or sets the hyperlink associated with this `SpreadsheetShape`.

```csharp
public string Hyperlink { get; set; }
```

##### Property Value

The hyperlink associated with this `SpreadsheetShape`.

### Id
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/id.md

#### SpreadsheetShape.Id property

Gets the identifier of this `SpreadsheetShape`.

```csharp
public int Id { get; }
```

##### Property Value

The identifier of this `SpreadsheetShape`.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/image.md

#### SpreadsheetShape.Image property

Gets or sets the image of this `SpreadsheetShape`.

```csharp
public SpreadsheetWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `SpreadsheetShape`. Returns null if the shape has no image.

### ImageFillFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/imagefillformat.md

#### SpreadsheetShape.ImageFillFormat property

Gets the image fill format settings of this `SpreadsheetShape`.

```csharp
public SpreadsheetImageFillFormat ImageFillFormat { get; }
```

##### Property Value

The image fill format settings of this `SpreadsheetShape`.

### IsWordArt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/iswordart.md

#### SpreadsheetShape.IsWordArt property

Gets a value indicating whether this `SpreadsheetShape` is a WordArt object.

```csharp
public bool IsWordArt { get; }
```

##### Property Value

True if the shape is a WordArt object; otherwise, false.

### MsoDrawingType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/msodrawingtype.md

#### SpreadsheetShape.MsoDrawingType property

Gets the mso drawing type.

```csharp
public SpreadsheetMsoDrawingType MsoDrawingType { get; }
```

##### Property Value

The mso drawing type.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/name.md

#### SpreadsheetShape.Name property

Gets the name of this `SpreadsheetShape`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `SpreadsheetShape`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/rotateangle.md

#### SpreadsheetShape.RotateAngle property

Gets or sets the rotate angle of this `SpreadsheetShape` in degrees.

```csharp
public double RotateAngle { get; set; }
```

##### Property Value

The rotate angle of this `SpreadsheetShape` in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/text.md

#### SpreadsheetShape.Text property

Gets or sets the text of this `SpreadsheetShape`.

```csharp
public string Text { get; set; }
```

##### Property Value

The text of this `SpreadsheetShape`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/width.md

#### SpreadsheetShape.Width property

Gets or sets the width of this `SpreadsheetShape` in points.

```csharp
public double Width { get; set; }
```

##### Property Value

The width of this `SpreadsheetShape` in points.

### Worksheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/worksheet.md

#### SpreadsheetShape.Worksheet property

Gets the parent worksheet of this `SpreadsheetShape`.

```csharp
public SpreadsheetWorksheet Worksheet { get; }
```

##### Property Value

The parent worksheet of this `SpreadsheetShape`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/x.md

#### SpreadsheetShape.X property

Gets or sets the horizontal offset of this `SpreadsheetShape` from worksheet left border in points.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of this `SpreadsheetShape`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/y.md

#### SpreadsheetShape.Y property

Gets or sets the vertical offset of this `SpreadsheetShape` from worksheet top border in points.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of this `SpreadsheetShape`.

### SpreadsheetShapeCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapecollection.md

#### SpreadsheetShapeCollection class

Represents a collection of drawing shapes in an Excel document.

```csharp
public class SpreadsheetShapeCollection : RemoveOnlyListBase<SpreadsheetShape>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(SpreadsheetShape) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetShape) |  |
| Remove(SpreadsheetShape) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `SpreadsheetShape` type.

### SpreadsheetShapeFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment.md

#### SpreadsheetShapeFormattedTextFragment class

Represents a fragment of formatted text in Excel document shape.

```csharp
public class SpreadsheetShapeFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/backgroundcolor.md

#### SpreadsheetShapeFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/font.md

#### SpreadsheetShapeFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/foregroundcolor.md

#### SpreadsheetShapeFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/text.md

#### SpreadsheetShapeFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### SpreadsheetShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragmentcollection.md

#### SpreadsheetShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document text shape.

```csharp
public class SpreadsheetShapeFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `SpreadsheetShapeFormattedTextFragment` type.

### SpreadsheetTextEffectFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment.md

#### SpreadsheetTextEffectFormattedTextFragment class

Represents a fragment of formatted text in Excel document WordArt shape.

```csharp
public class SpreadsheetTextEffectFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/backgroundcolor.md

#### SpreadsheetTextEffectFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/font.md

#### SpreadsheetTextEffectFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/foregroundcolor.md

#### SpreadsheetTextEffectFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/text.md

#### SpreadsheetTextEffectFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### SpreadsheetTextEffectFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragmentcollection.md

#### SpreadsheetTextEffectFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document WordArt shape.

```csharp
public class SpreadsheetTextEffectFormattedTextFragmentCollection : FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `SpreadsheetTextEffectFormattedTextFragment` type.

### SpreadsheetWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage.md

#### SpreadsheetWatermarkableImage class

Represents an image inside an Excel document.

```csharp
public class SpreadsheetWatermarkableImage : WatermarkableImage
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetWatermarkableImage(byte[]) | Initializes a new instance of the `SpreadsheetWatermarkableImage` class using specified image data. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### SpreadsheetWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/spreadsheetwatermarkableimage.md

#### SpreadsheetWatermarkableImage constructor

Initializes a new instance of the `SpreadsheetWatermarkableImage` class using specified image data.

```csharp
public SpreadsheetWatermarkableImage(byte[] imageData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageData | Byte[] | The array of unsigned bytes from which to create the `SpreadsheetWatermarkableImage`. |

### SpreadsheetWorksheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet.md

#### SpreadsheetWorksheet class

Represents an Excel document worksheet.

```csharp
public class SpreadsheetWorksheet : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| Attachments { get; } | Gets the collection of all attachments of this `SpreadsheetWorksheet`. |
| BackgroundImage { get; set; } | Gets or sets the background image of this `SpreadsheetWorksheet`. |
| Charts { get; } | Gets the collection of all charts of this `SpreadsheetWorksheet`. |
| ContentAreaHeight { get; } | Gets the height of the content area in points. |
| ContentAreaHeightPx { get; } | Gets the height of the content area in pixels. |
| ContentAreaWidth { get; } | Gets the width of the content area in points. |
| ContentAreaWidthPx { get; } | Gets the width of the content area in pixels. |
| HeadersFooters { get; } | Gets the collection of worksheet headers and footers. |
| PageSetup { get; } | Gets the printing page setup for this `SpreadsheetWorksheet`. |
| Shapes { get; } | Gets the collection of all shapes of this `SpreadsheetWorksheet`. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetColumnWidth(int) | Gets the width of the specified column in points. |
| GetColumnWidthPx(int) | Gets the width of the specified column in pixels. |
| GetRowHeight(int) | Gets the height of the specified row in points. |
| GetRowHeightPx(int) | Gets the height of the specified row in pixels. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Attachments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/attachments.md

#### SpreadsheetWorksheet.Attachments property

Gets the collection of all attachments of this `SpreadsheetWorksheet`.

```csharp
public SpreadsheetAttachmentCollection Attachments { get; }
```

##### Property Value

The collection of all attachments of this `SpreadsheetWorksheet`.

### BackgroundImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/backgroundimage.md

#### SpreadsheetWorksheet.BackgroundImage property

Gets or sets the background image of this `SpreadsheetWorksheet`.

```csharp
public SpreadsheetWatermarkableImage BackgroundImage { get; set; }
```

##### Property Value

The background image of this `SpreadsheetWorksheet`. Returns null if the worksheet has no background image.

### Charts
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/charts.md

#### SpreadsheetWorksheet.Charts property

Gets the collection of all charts of this `SpreadsheetWorksheet`.

```csharp
public SpreadsheetChartCollection Charts { get; }
```

##### Property Value

The collection of all charts of this `SpreadsheetWorksheet`.

### ContentAreaHeight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/contentareaheight.md

#### SpreadsheetWorksheet.ContentAreaHeight property

Gets the height of the content area in points.

```csharp
public double ContentAreaHeight { get; }
```

##### Property Value

The height of the content area in points.

### ContentAreaHeightPx
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/contentareaheightpx.md

#### SpreadsheetWorksheet.ContentAreaHeightPx property

Gets the height of the content area in pixels.

```csharp
public int ContentAreaHeightPx { get; }
```

##### Property Value

The height of the content area in pixels.

### ContentAreaWidth
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/contentareawidth.md

#### SpreadsheetWorksheet.ContentAreaWidth property

Gets the width of the content area in points.

```csharp
public double ContentAreaWidth { get; }
```

##### Property Value

The width of the content area in points.

### ContentAreaWidthPx
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/contentareawidthpx.md

#### SpreadsheetWorksheet.ContentAreaWidthPx property

Gets the width of the content area in pixels.

```csharp
public int ContentAreaWidthPx { get; }
```

##### Property Value

The width of the content area in pixels.

### GetColumnWidth
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/getcolumnwidth.md

#### SpreadsheetWorksheet.GetColumnWidth method

Gets the width of the specified column in points.

```csharp
public double GetColumnWidth(int column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| column | Int32 | The column index. |

##### Return Value

The width of the column in points.

### GetColumnWidthPx
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/getcolumnwidthpx.md

#### SpreadsheetWorksheet.GetColumnWidthPx method

Gets the width of the specified column in pixels.

```csharp
public int GetColumnWidthPx(int column)
```

| Parameter | Type | Description |
| --- | --- | --- |
| column | Int32 | The column index. |

##### Return Value

The width of the column in pixels.

### GetRowHeight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/getrowheight.md

#### SpreadsheetWorksheet.GetRowHeight method

Gets the height of the specified row in points.

```csharp
public double GetRowHeight(int row)
```

| Parameter | Type | Description |
| --- | --- | --- |
| row | Int32 | The row index. |

##### Return Value

The height of the row in points.

### GetRowHeightPx
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/getrowheightpx.md

#### SpreadsheetWorksheet.GetRowHeightPx method

Gets the height of the specified row in pixels.

```csharp
public int GetRowHeightPx(int row)
```

| Parameter | Type | Description |
| --- | --- | --- |
| row | Int32 | The row index. |

##### Return Value

The height of the row in pixels.

### HeadersFooters
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/headersfooters.md

#### SpreadsheetWorksheet.HeadersFooters property

Gets the collection of worksheet headers and footers.

```csharp
public SpreadsheetHeaderFooterCollection HeadersFooters { get; }
```

##### Property Value

The collection of headers and footers.

### PageSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/pagesetup.md

#### SpreadsheetWorksheet.PageSetup property

Gets the printing page setup for this `SpreadsheetWorksheet`.

```csharp
public SpreadsheetPageSetup PageSetup { get; }
```

##### Property Value

Page setup for the worksheet.

### Shapes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/shapes.md

#### SpreadsheetWorksheet.Shapes property

Gets the collection of all shapes of this `SpreadsheetWorksheet`.

```csharp
public SpreadsheetShapeCollection Shapes { get; }
```

##### Property Value

The collection of all shapes of this `SpreadsheetWorksheet`.

### SpreadsheetWorksheetCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheetcollection.md

#### SpreadsheetWorksheetCollection class

Represents a collection of worksheets in an Excel document.

```csharp
public class SpreadsheetWorksheetCollection : ReadOnlyListBase<SpreadsheetWorksheet>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(SpreadsheetWorksheet) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(SpreadsheetWorksheet) |  |

##### Remarks

This collection contains the items of `SpreadsheetWorksheet` type.

### GroupDocs.Watermark.Contents.WordProcessing
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing.md

The namespace provides classes for working with watermarks in Word documents.

#### Classes

| Class | Description |
| --- | --- |
| WordProcessingFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document. |
| WordProcessingHeaderFooter | Represents a header/footer in a Word document. |
| WordProcessingHeaderFooterCollection | Represents a collection of headers and footers in a Word document. |
| WordProcessingPageSetup | Represents printing page properties for a section of a Word document. |
| WordProcessingSection | Represents a Word document section. |
| WordProcessingSectionCollection | Represents a collection of sections in a Word document. |
| WordProcessingShape | Represents a drawing shape in a Word document. |
| WordProcessingShapeCollection | Represents a collection of shapes in a Word document. |
| WordProcessingShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document shape. |
| WordProcessingTextFormattedTextFragment | Represents a fragment of formatted text in a Word document. |
| WordProcessingTextFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document main text. |
| WordProcessingWatermarkableImage | Represents an image inside a Word document. |
| WordProcessingWordArtShapeFormattedTextFragment | Represents a fragment of formatted text in a WordArt shape. |
| WordProcessingWordArtShapeFormattedTextFragmentCollection | Represents a collection of formatted text fragments in a Word document WordArt shape. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| WordProcessingHorizontalAlignment | Specifies horizontal alignment of a floating object. |
| WordProcessingProtectionType | Represents protection type for a Word document. |
| WordProcessingRelativeHorizontalPosition | Specifies to what the horizontal position of an object is relative. |
| WordProcessingRelativeVerticalPosition | Specifies to what the vertical position of an object is relative. |
| WordProcessingShapeType | Represents the type of a shape in a Word document. |
| WordProcessingVerticalAlignment | Specifies vertical alignment of a floating object. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### WordProcessingFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingformattedtextfragmentcollection.md

#### WordProcessingFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document.

```csharp
public abstract class WordProcessingFormattedTextFragmentCollection : 
    FormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

### WordProcessingHeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter.md

#### WordProcessingHeaderFooter class

Represents a header/footer in a Word document.

```csharp
public class WordProcessingHeaderFooter : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| HeaderFooterType { get; } | Gets the type of this `WordProcessingHeaderFooter`. |
| IsLinkedToPrevious { get; set; } | Gets or sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section. |
| Section { get; } | Gets the parent section of this `WordProcessingHeaderFooter`. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### HeaderFooterType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/headerfootertype.md

#### WordProcessingHeaderFooter.HeaderFooterType property

Gets the type of this `WordProcessingHeaderFooter`.

```csharp
public OfficeHeaderFooterType HeaderFooterType { get; }
```

##### Property Value

The type of this `WordProcessingHeaderFooter`.

### IsLinkedToPrevious
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/islinkedtoprevious.md

#### WordProcessingHeaderFooter.IsLinkedToPrevious property

Gets or sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.

```csharp
public bool IsLinkedToPrevious { get; set; }
```

##### Property Value

True if this header/footer is linked to the corresponding header/footer in the previous section; false otherwise.

##### Remarks

Default is true. Note, when your link a header or footer, its contents is cleared.

### Section
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/section.md

#### WordProcessingHeaderFooter.Section property

Gets the parent section of this `WordProcessingHeaderFooter`.

```csharp
public WordProcessingSection Section { get; }
```

##### Property Value

The parent section of this `WordProcessingHeaderFooter`.

### WordProcessingHeaderFooterCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfootercollection.md

#### WordProcessingHeaderFooterCollection class

Represents a collection of headers and footers in a Word document.

```csharp
public class WordProcessingHeaderFooterCollection : ReadOnlyListBase<WordProcessingHeaderFooter>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |
| Item { get; } | Gets the header or footer of specified type. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(WordProcessingHeaderFooter) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(WordProcessingHeaderFooter) |  |
| LinkToPrevious(bool) | Links or unlinks all headers and footers to the corresponding headers and footers in the previous section. |

##### Remarks

This collection contains the items of `WordProcessingHeaderFooter` type.

### Item
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfootercollection/item.md

#### WordProcessingHeaderFooterCollection indexer

Gets the header or footer of specified type.

```csharp
public WordProcessingHeaderFooter this[OfficeHeaderFooterType headerFooterType] { get; }
```

| Parameter | Description |
| --- | --- |
| headerFooterType | A `OfficeHeaderFooterType` value that specifies the type of the header/footer to get. |

##### Property Value

The `WordProcessingHeaderFooter` of specified type.

### LinkToPrevious
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfootercollection/linktoprevious.md

#### WordProcessingHeaderFooterCollection.LinkToPrevious method

Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.

```csharp
public void LinkToPrevious(bool isLinkToPrevious)
```

| Parameter | Type | Description |
| --- | --- | --- |
| isLinkToPrevious | Boolean | True to link the headers and footers to the previous section; false to unlink them. |

### WordProcessingHorizontalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessinghorizontalalignment.md

#### WordProcessingHorizontalAlignment enumeration

Specifies horizontal alignment of a floating object.

```csharp
public enum WordProcessingHorizontalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Object is explicitly positioned using its x-coordinate. |
| Left | `1` | Specifies that the object is left aligned to the horizontal alignment base. |
| Center | `2` | Specifies that the object is centered with respect to the horizontal alignment base. |
| Right | `3` | Specifies that the object is right aligned to the horizontal alignment base. |
| Inside | `4` | Specifies that the object is inside of the horizontal alignment base. |
| Outside | `5` | Specifies that the object is outside of the horizontal alignment base. |

### WordProcessingPageSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup.md

#### WordProcessingPageSetup class

Represents printing page properties for a section of a Word document.

```csharp
public class WordProcessingPageSetup
```

#### Properties

| Name | Description |
| --- | --- |
| BottomMargin { get; } | Gets the size of the bottom margin in points. |
| DifferentFirstPageHeaderFooter { get; set; } | Gets or sets a value indicating whether a different header/footer is used for the first page. |
| Height { get; } | Gets the height of a printing page in points. |
| LeftMargin { get; } | Gets the size of the left margin in points. |
| OddAndEvenPagesHeaderFooter { get; set; } | Gets or sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. Note, changing this property affects all sections in the content. |
| RightMargin { get; } | Gets the size of the right margin in points. |
| TopMargin { get; } | Gets the size of the top margin in points. |
| Width { get; } | Gets the width of a printing page in points. |

### BottomMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/bottommargin.md

#### WordProcessingPageSetup.BottomMargin property

Gets the size of the bottom margin in points.

```csharp
public double BottomMargin { get; }
```

##### Property Value

The size of the bottom margin in points.

### DifferentFirstPageHeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/differentfirstpageheaderfooter.md

#### WordProcessingPageSetup.DifferentFirstPageHeaderFooter property

Gets or sets a value indicating whether a different header/footer is used for the first page.

```csharp
public bool DifferentFirstPageHeaderFooter { get; set; }
```

##### Property Value

True if a different header/footer is used for the first page; otherwise, false.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/height.md

#### WordProcessingPageSetup.Height property

Gets the height of a printing page in points.

```csharp
public double Height { get; }
```

##### Property Value

The height of a printing page in points.

### LeftMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/leftmargin.md

#### WordProcessingPageSetup.LeftMargin property

Gets the size of the left margin in points.

```csharp
public double LeftMargin { get; }
```

##### Property Value

The size of the left margin in points.

### OddAndEvenPagesHeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/oddandevenpagesheaderfooter.md

#### WordProcessingPageSetup.OddAndEvenPagesHeaderFooter property

Gets or sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered pages. Note, changing this property affects all sections in the content.

```csharp
public bool OddAndEvenPagesHeaderFooter { get; set; }
```

##### Property Value

True if different headers/footers are used for odd-numbered and even-numbered pages; otherwise, false.

### RightMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/rightmargin.md

#### WordProcessingPageSetup.RightMargin property

Gets the size of the right margin in points.

```csharp
public double RightMargin { get; }
```

##### Property Value

The size of the right margin in points.

### TopMargin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/topmargin.md

#### WordProcessingPageSetup.TopMargin property

Gets the size of the top margin in points.

```csharp
public double TopMargin { get; }
```

##### Property Value

The size of the top margin in points.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/width.md

#### WordProcessingPageSetup.Width property

Gets the width of a printing page in points.

```csharp
public double Width { get; }
```

##### Property Value

The width of a printing page in points.

### WordProcessingProtectionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingprotectiontype.md

#### WordProcessingProtectionType enumeration

Represents protection type for a Word document.

```csharp
public enum WordProcessingProtectionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllowOnlyRevisions | `0` | User can only add revision marks to the document. |
| AllowOnlyComments | `1` | User can only modify comments in the document. |
| AllowOnlyFormFields | `2` | User can only enter data in the form fields in the document. |
| ReadOnly | `3` | No changes are allowed to the document. |

### WordProcessingRelativeHorizontalPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingrelativehorizontalposition.md

#### WordProcessingRelativeHorizontalPosition enumeration

Specifies to what the horizontal position of an object is relative.

```csharp
public enum WordProcessingRelativeHorizontalPosition
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Margin | `0` | Specifies that the horizontal positioning is relative to the page margins. |
| Page | `1` | The object is positioned relative to the left edge of the page. |
| Column | `2` | The object is positioned relative to the left side of the column. |
| Character | `3` | The object is positioned relative to the left side of the paragraph. |
| LeftMargin | `4` | Specifies that the horizontal positioning is relative to the left margin of the page. |
| RightMargin | `5` | Specifies that the horizontal positioning is relative to the right margin of the page. |
| InsideMargin | `6` | Specifies that the horizontal positioning is relative to the inside margin of the current page (the left margin on odd pages, right on even pages). |
| OutsideMargin | `7` | Specifies that the horizontal positioning is relative to the outside margin of the current page (the right margin on odd pages, left on even pages). |

### WordProcessingRelativeVerticalPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingrelativeverticalposition.md

#### WordProcessingRelativeVerticalPosition enumeration

Specifies to what the vertical position of an object is relative.

```csharp
public enum WordProcessingRelativeVerticalPosition
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Margin | `0` | Specifies that the vertical positioning is relative to the page margins. |
| Page | `1` | The object is positioned relative to the top edge of the page. |
| Paragraph | `2` | The object is positioned relative to the top of the paragraph that contains the anchor. |
| Line | `3` | Undocumented feature. |
| TopMargin | `4` | Specifies that the vertical positioning is relative to the top margin of the current page. |
| BottomMargin | `5` | Specifies that the vertical positioning is relative to the bottom margin of the current page. |
| InsideMargin | `6` | Specifies that the vertical positioning is relative to the inside margin of the current page. |
| OutsideMargin | `7` | Specifies that the vertical positioning is relative to the outside margin of the current page. |

### WordProcessingSection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection.md

#### WordProcessingSection class

Represents a Word document section.

```csharp
public class WordProcessingSection : ContentPart
```

#### Properties

| Name | Description |
| --- | --- |
| HeadersFooters { get; } | Gets the collection of all headers and footers of this `WordProcessingSection`. |
| PageSetup { get; } | Gets the printing page setup for this `WordProcessingSection`. |
| Shapes { get; } | Gets the collection of all shapes contained in this `WordProcessingSection`. |

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### HeadersFooters
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/headersfooters.md

#### WordProcessingSection.HeadersFooters property

Gets the collection of all headers and footers of this `WordProcessingSection`.

```csharp
public WordProcessingHeaderFooterCollection HeadersFooters { get; }
```

##### Property Value

The collection of all headers and footers of this `WordProcessingSection`.

### PageSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/pagesetup.md

#### WordProcessingSection.PageSetup property

Gets the printing page setup for this `WordProcessingSection`.

```csharp
public WordProcessingPageSetup PageSetup { get; }
```

##### Property Value

The printing page setup for this `WordProcessingSection`.

### Shapes
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/shapes.md

#### WordProcessingSection.Shapes property

Gets the collection of all shapes contained in this `WordProcessingSection`.

```csharp
public WordProcessingShapeCollection Shapes { get; }
```

##### Property Value

The collection of all shapes contained in this `WordProcessingSection`.

### WordProcessingSectionCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingsectioncollection.md

#### WordProcessingSectionCollection class

Represents a collection of sections in a Word document.

```csharp
public class WordProcessingSectionCollection : ReadOnlyListBase<WordProcessingSection>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| virtual IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| virtual Contains(WordProcessingSection) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(WordProcessingSection) |  |

##### Remarks

This collection contains the items of `WordProcessingSection` type.

### WordProcessingShape
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape.md

#### WordProcessingShape class

Represents a drawing shape in a Word document.

```csharp
public class WordProcessingShape : ShapeSearchAdapter, IRotatableTwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text associated with this `WordProcessingShape`. |
| BehindText { get; set; } | Gets or sets a value indicating whether the shape is over or behind the text. |
| FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `WordProcessingShape`. |
| HeaderFooter { get; } | Gets the parent header/footer of this `WordProcessingShape` (if presents). |
| Height { get; set; } | Gets or sets the height of this `WordProcessingShape` in points. |
| HorizontalAlignment { get; } | Gets a value specifying how the shape is positioned horizontally. |
| Hyperlink { get; set; } | Gets or sets the hyperlink associated with this `WordProcessingShape`. |
| Image { get; set; } | Gets or sets the image of this `WordProcessingShape`. |
| IsWordArt { get; } | Gets a value indicating whether this `WordProcessingShape` is a WordArt object. |
| Name { get; } | Gets the name of this `WordProcessingShape`. |
| RelativeHorizontalPosition { get; } | Gets a value specifying to what the shape is positioned horizontally. |
| RelativeVerticalPosition { get; } | Gets a value specifying to what the shape is positioned vertically. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `WordProcessingShape` in degrees. |
| Section { get; } | Gets the parent section of this `WordProcessingShape`. |
| ShapeType { get; } | Gets the shape type. |
| Text { get; set; } | Gets or sets the text of this `WordProcessingShape`. |
| VerticalAlignment { get; } | Gets a value specifying how the shape is positioned vertically. |
| Width { get; set; } | Gets or sets the width of this `WordProcessingShape` in points. |
| X { get; set; } | Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points. |
| Y { get; set; } | Gets or sets the vertical offset of this `WordProcessingShape` from page top border in points. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/alternativetext.md

#### WordProcessingShape.AlternativeText property

Gets or sets the descriptive (alternative) text associated with this `WordProcessingShape`.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text associated with this `WordProcessingShape`.

### BehindText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/behindtext.md

#### WordProcessingShape.BehindText property

Gets or sets a value indicating whether the shape is over or behind the text.

```csharp
public bool BehindText { get; set; }
```

##### Property Value

The value indicating whether the shape is over or behind the text. True if the shape is behind the text; otherwise, false.

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/formattedtextfragments.md

#### WordProcessingShape.FormattedTextFragments property

Gets the collection of formatted text fragments of this `WordProcessingShape`.

```csharp
public FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `WordProcessingShape`.

### HeaderFooter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/headerfooter.md

#### WordProcessingShape.HeaderFooter property

Gets the parent header/footer of this `WordProcessingShape` (if presents).

```csharp
public WordProcessingHeaderFooter HeaderFooter { get; }
```

##### Property Value

The parent header/footer of this `WordProcessingShape`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/height.md

#### WordProcessingShape.Height property

Gets or sets the height of this `WordProcessingShape` in points.

```csharp
public double Height { get; set; }
```

##### Property Value

The height of this `WordProcessingShape` in points.

### HorizontalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/horizontalalignment.md

#### WordProcessingShape.HorizontalAlignment property

Gets a value specifying how the shape is positioned horizontally.

```csharp
public WordProcessingHorizontalAlignment HorizontalAlignment { get; }
```

##### Property Value

The horizontal alignment value.

### Hyperlink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/hyperlink.md

#### WordProcessingShape.Hyperlink property

Gets or sets the hyperlink associated with this `WordProcessingShape`.

```csharp
public string Hyperlink { get; set; }
```

##### Property Value

The hyperlink associated with this `WordProcessingShape`.

### Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/image.md

#### WordProcessingShape.Image property

Gets or sets the image of this `WordProcessingShape`.

```csharp
public WordProcessingWatermarkableImage Image { get; set; }
```

##### Property Value

The image of this `WordProcessingShape`. Returns null if the shape has no image.

### IsWordArt
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/iswordart.md

#### WordProcessingShape.IsWordArt property

Gets a value indicating whether this `WordProcessingShape` is a WordArt object.

```csharp
public bool IsWordArt { get; }
```

##### Property Value

True if the shape is a WordArt object; otherwise, false.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/name.md

#### WordProcessingShape.Name property

Gets the name of this `WordProcessingShape`.

```csharp
public string Name { get; }
```

##### Property Value

The name of this `WordProcessingShape`.

### RelativeHorizontalPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/relativehorizontalposition.md

#### WordProcessingShape.RelativeHorizontalPosition property

Gets a value specifying to what the shape is positioned horizontally.

```csharp
public WordProcessingRelativeHorizontalPosition RelativeHorizontalPosition { get; }
```

##### Property Value

The relative horizontal position value.

### RelativeVerticalPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/relativeverticalposition.md

#### WordProcessingShape.RelativeVerticalPosition property

Gets a value specifying to what the shape is positioned vertically.

```csharp
public WordProcessingRelativeVerticalPosition RelativeVerticalPosition { get; }
```

##### Property Value

The relative vertical position value.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/rotateangle.md

#### WordProcessingShape.RotateAngle property

Gets or sets the rotate angle of this `WordProcessingShape` in degrees.

```csharp
public double RotateAngle { get; set; }
```

##### Property Value

The rotate angle of this `WordProcessingShape` in degrees.

### Section
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/section.md

#### WordProcessingShape.Section property

Gets the parent section of this `WordProcessingShape`.

```csharp
public WordProcessingSection Section { get; }
```

##### Property Value

The parent section of this `WordProcessingShape`.

### ShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/shapetype.md

#### WordProcessingShape.ShapeType property

Gets the shape type.

```csharp
public WordProcessingShapeType ShapeType { get; }
```

##### Property Value

The shape type.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/text.md

#### WordProcessingShape.Text property

Gets or sets the text of this `WordProcessingShape`.

```csharp
public string Text { get; set; }
```

##### Property Value

The text of this `WordProcessingShape`.

### VerticalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/verticalalignment.md

#### WordProcessingShape.VerticalAlignment property

Gets a value specifying how the shape is positioned vertically.

```csharp
public WordProcessingVerticalAlignment VerticalAlignment { get; }
```

##### Property Value

The vertical alignment value.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/width.md

#### WordProcessingShape.Width property

Gets or sets the width of this `WordProcessingShape` in points.

```csharp
public double Width { get; set; }
```

##### Property Value

The width of this `WordProcessingShape` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/x.md

#### WordProcessingShape.X property

Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of this `WordProcessingShape`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/y.md

#### WordProcessingShape.Y property

Gets or sets the vertical offset of this `WordProcessingShape` from page top border in points.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of this `WordProcessingShape`.

### WordProcessingShapeCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapecollection.md

#### WordProcessingShapeCollection class

Represents a collection of shapes in a Word document.

```csharp
public class WordProcessingShapeCollection : RemoveOnlyListBase<WordProcessingShape>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(WordProcessingShape) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(WordProcessingShape) |  |
| Remove(WordProcessingShape) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `WordProcessingShape` type.

### WordProcessingShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapeformattedtextfragmentcollection.md

#### WordProcessingShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document shape.

```csharp
public class WordProcessingShapeFormattedTextFragmentCollection : 
    WordProcessingFormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

### WordProcessingShapeType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapetype.md

#### WordProcessingShapeType enumeration

Represents the type of a shape in a Word document.

```csharp
public enum WordProcessingShapeType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| MinValue | `-2` | Built-in shape type. |
| OleObject | `-2` | Built-in shape type. |
| Group | `-1` | Built-in shape type. |
| NonPrimitive | `0` | Built-in shape type. |
| Rectangle | `1` | Built-in shape type. |
| RoundRectangle | `2` | Built-in shape type. |
| Ellipse | `3` | Built-in shape type. |
| Diamond | `4` | Built-in shape type. |
| Triangle | `5` | Built-in shape type. |
| RightTriangle | `6` | Built-in shape type. |
| Parallelogram | `7` | Built-in shape type. |
| Trapezoid | `8` | Built-in shape type. |
| Hexagon | `9` | Built-in shape type. |
| Octagon | `10` | Built-in shape type. |
| Plus | `11` | Built-in shape type. |
| Star | `12` | Built-in shape type. |
| Arrow | `13` | Built-in shape type. |
| ThickArrow | `14` | Built-in shape type. |
| HomePlate | `15` | Built-in shape type. |
| Cube | `16` | Built-in shape type. |
| Balloon | `17` | Built-in shape type. |
| Seal | `18` | Built-in shape type. |
| Arc | `19` | Built-in shape type. |
| Line | `20` | Built-in shape type. |
| Plaque | `21` | Built-in shape type. |
| Can | `22` | Built-in shape type. |
| Donut | `23` | Built-in shape type. |
| TextSimple | `24` | Built-in shape type. |
| TextOctagon | `25` | Built-in shape type. |
| TextHexagon | `26` | Built-in shape type. |
| TextCurve | `27` | Built-in shape type. |
| TextWave | `28` | Built-in shape type. |
| TextRing | `29` | Built-in shape type. |
| TextOnCurve | `30` | Built-in shape type. |
| TextOnRing | `31` | Built-in shape type. |
| StraightConnector1 | `32` | Built-in shape type. |
| BentConnector2 | `33` | Built-in shape type. |
| BentConnector3 | `34` | Built-in shape type. |
| BentConnector4 | `35` | Built-in shape type. |
| BentConnector5 | `36` | Built-in shape type. |
| CurvedConnector2 | `37` | Built-in shape type. |
| CurvedConnector3 | `38` | Built-in shape type. |
| CurvedConnector4 | `39` | Built-in shape type. |
| CurvedConnector5 | `40` | Built-in shape type. |
| Callout1 | `41` | Built-in shape type. |
| Callout2 | `42` | Built-in shape type. |
| Callout3 | `43` | Built-in shape type. |
| AccentCallout1 | `44` | Built-in shape type. |
| AccentCallout2 | `45` | Built-in shape type. |
| AccentCallout3 | `46` | Built-in shape type. |
| BorderCallout1 | `47` | Built-in shape type. |
| BorderCallout2 | `48` | Built-in shape type. |
| BorderCallout3 | `49` | Built-in shape type. |
| AccentBorderCallout1 | `50` | Built-in shape type. |
| AccentBorderCallout2 | `51` | Built-in shape type. |
| AccentBorderCallout3 | `52` | Built-in shape type. |
| Ribbon | `53` | Built-in shape type. |
| Ribbon2 | `54` | Built-in shape type. |
| Chevron | `55` | Built-in shape type. |
| Pentagon | `56` | Built-in shape type. |
| NoSmoking | `57` | Built-in shape type. |
| Seal8 | `58` | Built-in shape type. |
| Seal16 | `59` | Built-in shape type. |
| Seal32 | `60` | Built-in shape type. |
| WedgeRectCallout | `61` | Built-in shape type. |
| WedgeRRectCallout | `62` | Built-in shape type. |
| WedgeEllipseCallout | `63` | Built-in shape type. |
| Wave | `64` | Built-in shape type. |
| FoldedCorner | `65` | Built-in shape type. |
| LeftArrow | `66` | Built-in shape type. |
| DownArrow | `67` | Built-in shape type. |
| UpArrow | `68` | Built-in shape type. |
| LeftRightArrow | `69` | Built-in shape type. |
| UpDownArrow | `70` | Built-in shape type. |
| IrregularSeal1 | `71` | Built-in shape type. |
| IrregularSeal2 | `72` | Built-in shape type. |
| LightningBolt | `73` | Built-in shape type. |
| Heart | `74` | Built-in shape type. |
| Image | `75` | Built-in shape type. |
| QuadArrow | `76` | Built-in shape type. |
| LeftArrowCallout | `77` | Built-in shape type. |
| RightArrowCallout | `78` | Built-in shape type. |
| UpArrowCallout | `79` | Built-in shape type. |
| DownArrowCallout | `80` | Built-in shape type. |
| LeftRightArrowCallout | `81` | Built-in shape type. |
| UpDownArrowCallout | `82` | Built-in shape type. |
| QuadArrowCallout | `83` | Built-in shape type. |
| Bevel | `84` | Built-in shape type. |
| LeftBracket | `85` | Built-in shape type. |
| RightBracket | `86` | Built-in shape type. |
| LeftBrace | `87` | Built-in shape type. |
| RightBrace | `88` | Built-in shape type. |
| LeftUpArrow | `89` | Built-in shape type. |
| BentUpArrow | `90` | Built-in shape type. |
| BentArrow | `91` | Built-in shape type. |
| Seal24 | `92` | Built-in shape type. |
| StripedRightArrow | `93` | Built-in shape type. |
| NotchedRightArrow | `94` | Built-in shape type. |
| BlockArc | `95` | Built-in shape type. |
| SmileyFace | `96` | Built-in shape type. |
| VerticalScroll | `97` | Built-in shape type. |
| HorizontalScroll | `98` | Built-in shape type. |
| CircularArrow | `99` | Built-in shape type. |
| CustomShape | `100` | Built-in shape type. |
| UturnArrow | `101` | Built-in shape type. |
| CurvedRightArrow | `102` | Built-in shape type. |
| CurvedLeftArrow | `103` | Built-in shape type. |
| CurvedUpArrow | `104` | Built-in shape type. |
| CurvedDownArrow | `105` | Built-in shape type. |
| CloudCallout | `106` | Built-in shape type. |
| EllipseRibbon | `107` | Built-in shape type. |
| EllipseRibbon2 | `108` | Built-in shape type. |
| FlowChartProcess | `109` | Built-in shape type. |
| FlowChartDecision | `110` | Built-in shape type. |
| FlowChartInputOutput | `111` | Built-in shape type. |
| FlowChartPredefinedProcess | `112` | Built-in shape type. |
| FlowChartInternalStorage | `113` | Built-in shape type. |
| FlowChartDocument | `114` | Built-in shape type. |
| FlowChartMultidocument | `115` | Built-in shape type. |
| FlowChartTerminator | `116` | Built-in shape type. |
| FlowChartPreparation | `117` | Built-in shape type. |
| FlowChartManualInput | `118` | Built-in shape type. |
| FlowChartManualOperation | `119` | Built-in shape type. |
| FlowChartConnector | `120` | Built-in shape type. |
| FlowChartPunchedCard | `121` | Built-in shape type. |
| FlowChartPunchedTape | `122` | Built-in shape type. |
| FlowChartSummingJunction | `123` | Built-in shape type. |
| FlowChartOr | `124` | Built-in shape type. |
| FlowChartCollate | `125` | Built-in shape type. |
| FlowChartSort | `126` | Built-in shape type. |
| FlowChartExtract | `127` | Built-in shape type. |
| FlowChartMerge | `128` | Built-in shape type. |
| FlowChartOfflineStorage | `129` | Built-in shape type. |
| FlowChartOnlineStorage | `130` | Built-in shape type. |
| FlowChartMagneticTape | `131` | Built-in shape type. |
| FlowChartMagneticDisk | `132` | Built-in shape type. |
| FlowChartMagneticDrum | `133` | Built-in shape type. |
| FlowChartDisplay | `134` | Built-in shape type. |
| FlowChartDelay | `135` | Built-in shape type. |
| TextPlainText | `136` | Built-in shape type. |
| TextStop | `137` | Built-in shape type. |
| TextTriangle | `138` | Built-in shape type. |
| TextTriangleInverted | `139` | Built-in shape type. |
| TextChevron | `140` | Built-in shape type. |
| TextChevronInverted | `141` | Built-in shape type. |
| TextRingInside | `142` | Built-in shape type. |
| TextRingOutside | `143` | Built-in shape type. |
| TextArchUpCurve | `144` | Built-in shape type. |
| TextArchDownCurve | `145` | Built-in shape type. |
| TextCircleCurve | `146` | Built-in shape type. |
| TextButtonCurve | `147` | Built-in shape type. |
| TextArchUpPour | `148` | Built-in shape type. |
| TextArchDownPour | `149` | Built-in shape type. |
| TextCirclePour | `150` | Built-in shape type. |
| TextButtonPour | `151` | Built-in shape type. |
| TextCurveUp | `152` | Built-in shape type. |
| TextCurveDown | `153` | Built-in shape type. |
| TextCascadeUp | `154` | Built-in shape type. |
| TextCascadeDown | `155` | Built-in shape type. |
| TextWave1 | `156` | Built-in shape type. |
| TextWave2 | `157` | Built-in shape type. |
| TextWave3 | `158` | Built-in shape type. |
| TextWave4 | `159` | Built-in shape type. |
| TextInflate | `160` | Built-in shape type. |
| TextDeflate | `161` | Built-in shape type. |
| TextInflateBottom | `162` | Built-in shape type. |
| TextDeflateBottom | `163` | Built-in shape type. |
| TextInflateTop | `164` | Built-in shape type. |
| TextDeflateTop | `165` | Built-in shape type. |
| TextDeflateInflate | `166` | Built-in shape type. |
| TextDeflateInflateDeflate | `167` | Built-in shape type. |
| TextFadeRight | `168` | Built-in shape type. |
| TextFadeLeft | `169` | Built-in shape type. |
| TextFadeUp | `170` | Built-in shape type. |
| TextFadeDown | `171` | Built-in shape type. |
| TextSlantUp | `172` | Built-in shape type. |
| TextSlantDown | `173` | Built-in shape type. |
| TextCanUp | `174` | Built-in shape type. |
| TextCanDown | `175` | Built-in shape type. |
| FlowChartAlternateProcess | `176` | Built-in shape type. |
| FlowChartOffpageConnector | `177` | Built-in shape type. |
| Callout90 | `178` | Built-in shape type. |
| AccentCallout90 | `179` | Built-in shape type. |
| BorderCallout90 | `180` | Built-in shape type. |
| AccentBorderCallout90 | `181` | Built-in shape type. |
| LeftRightUpArrow | `182` | Built-in shape type. |
| Sun | `183` | Built-in shape type. |
| Moon | `184` | Built-in shape type. |
| BracketPair | `185` | Built-in shape type. |
| BracePair | `186` | Built-in shape type. |
| Seal4 | `187` | Built-in shape type. |
| DoubleWave | `188` | Built-in shape type. |
| ActionButtonBlank | `189` | Built-in shape type. |
| ActionButtonHome | `190` | Built-in shape type. |
| ActionButtonHelp | `191` | Built-in shape type. |
| ActionButtonInformation | `192` | Built-in shape type. |
| ActionButtonForwardNext | `193` | Built-in shape type. |
| ActionButtonBackPrevious | `194` | Built-in shape type. |
| ActionButtonEnd | `195` | Built-in shape type. |
| ActionButtonBeginning | `196` | Built-in shape type. |
| ActionButtonReturn | `197` | Built-in shape type. |
| ActionButtonDocument | `198` | Built-in shape type. |
| ActionButtonSound | `199` | Built-in shape type. |
| ActionButtonMovie | `200` | Built-in shape type. |
| OleControl | `201` | Built-in shape type. |
| TextBox | `202` | Built-in shape type. |
| SingleCornerSnipped | `203` | Built-in shape type. |
| TopCornersSnipped | `204` | Built-in shape type. |
| DiagonalCornersSnipped | `205` | Built-in shape type. |
| TopCornersOneRoundedOneSnipped | `206` | Built-in shape type. |
| SingleCornerRounded | `207` | Built-in shape type. |
| TopCornersRounded | `208` | Built-in shape type. |
| DiagonalCornersRounded | `209` | Built-in shape type. |

### WordProcessingTextFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment.md

#### WordProcessingTextFormattedTextFragment class

Represents a fragment of formatted text in a Word document.

```csharp
public class WordProcessingTextFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/backgroundcolor.md

#### WordProcessingTextFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/font.md

#### WordProcessingTextFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/foregroundcolor.md

#### WordProcessingTextFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/text.md

#### WordProcessingTextFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### WordProcessingTextFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragmentcollection.md

#### WordProcessingTextFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document main text.

```csharp
public class WordProcessingTextFormattedTextFragmentCollection : 
    WordProcessingFormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

### WordProcessingVerticalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingverticalalignment.md

#### WordProcessingVerticalAlignment enumeration

Specifies vertical alignment of a floating object.

```csharp
public enum WordProcessingVerticalAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Inline | `-1` | Not documented. Seems to be a possible value for floating paragraphs and tables. |
| None | `0` | The object is explicitly positioned using its y-coordinate. |
| Top | `1` | Specifies that the object is at the top of the vertical alignment base. |
| Center | `2` | Specifies that the object is centered with respect to the vertical alignment bas. |
| Bottom | `3` | Specifies that the object is at the bottom of the vertical alignment base. |
| Inside | `4` | Specifies that the object is inside of the horizontal alignment base. |
| Outside | `5` | Specifies that the object is outside of the vertical alignment base. |

### WordProcessingWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage.md

#### WordProcessingWatermarkableImage class

Represents an image inside a Word document.

```csharp
public class WordProcessingWatermarkableImage : WatermarkableImage
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingWatermarkableImage(byte[]) | Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data. |

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of this `WatermarkableImage` in pixels. |
| Width { get; } | Gets the width of this `WatermarkableImage` in pixels. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| GetBytes() | Gets the image as byte array. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### WordProcessingWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/wordprocessingwatermarkableimage.md

#### WordProcessingWatermarkableImage constructor

Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data.

```csharp
public WordProcessingWatermarkableImage(byte[] imageData)
```

| Parameter | Type | Description |
| --- | --- | --- |
| imageData | Byte[] | The array of unsigned bytes from which to create the `WordProcessingWatermarkableImage`. |

### WordProcessingWordArtShapeFormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment.md

#### WordProcessingWordArtShapeFormattedTextFragment class

Represents a fragment of formatted text in a WordArt shape.

```csharp
public class WordProcessingWordArtShapeFormattedTextFragment : FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| override BackgroundColor { get; } | Gets the background color of the text. |
| override Font { get; } | Gets the font of the text. |
| override ForegroundColor { get; } | Gets the foreground color of the text. |
| override Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/backgroundcolor.md

#### WordProcessingWordArtShapeFormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public override Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/font.md

#### WordProcessingWordArtShapeFormattedTextFragment.Font property

Gets the font of the text.

```csharp
public override Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/foregroundcolor.md

#### WordProcessingWordArtShapeFormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public override Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/text.md

#### WordProcessingWordArtShapeFormattedTextFragment.Text property

Gets the fragment text.

```csharp
public override string Text { get; }
```

##### Property Value

The fragment text.

### WordProcessingWordArtShapeFormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragmentcollection.md

#### WordProcessingWordArtShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document WordArt shape.

```csharp
public class WordProcessingWordArtShapeFormattedTextFragmentCollection : 
    WordProcessingFormattedTextFragmentCollection
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `WordProcessingWordArtShapeFormattedTextFragment` type.

### GroupDocs.Watermark.Contents
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents.md

The namespace provides classes for working with documents of any supported types.

#### Classes

| Class | Description |
| --- | --- |
| Content | Represents a content where a watermark can be placed. |
| ContentPart | Represents any logical part of a content (page, frame, header or a whole content) where watermark can be placed. |
| OfficeImageEffects | Represents effects that can be applied to an image watermark for an office content. |
| OfficeImageFillFormat&lt;TWatermarkableImage&gt; | Represents the image fill format settings in any supported office content. |
| OfficeLineFormat | Represents a shape line format. |
| OfficeShapeSettings | Represents settings that can be applied to a shape watermark for an office content. |
| OfficeTextEffects | Represents effects that can be applied to a text watermark for an office content. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| OfficeDashStyle | Represents a dashed line style. |
| OfficeHeaderFooterType | Identifies the type of header or footer. |
| OfficeLineStyle | Represents the compound line style of a `OfficeLineFormat`. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### Content
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/content.md

#### Content class

Represents a content where a watermark can be placed.

```csharp
public abstract class Content : ContentPart, IDisposable
```

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### Dispose
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/content/dispose.md

#### Content.Dispose method

Disposes the current instance.

```csharp
public void Dispose()
```

### ContentPart
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/contentpart.md

#### ContentPart class

Represents any logical part of a content (page, frame, header or a whole content) where watermark can be placed.

```csharp
public abstract class ContentPart
```

#### Methods

| Name | Description |
| --- | --- |
| FindImages() | Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| FindImages(ImageSearchCriteria) | Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |
| Search() | Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`. |
| Search(SearchCriteria) | Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`. |

### FindImages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/contentpart/findimages.md

#### FindImages(ImageSearchCriteria)

Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`.

```csharp
public WatermarkableImageCollection FindImages(ImageSearchCriteria searchCriteria)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | ImageSearchCriteria | The search criteria to use. |

##### Return Value

The collection of the found images.

#### FindImages()

Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`.

```csharp
public WatermarkableImageCollection FindImages()
```

##### Return Value

The collection of the found images.

### Search
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/contentpart/search.md

#### Search(SearchCriteria)

Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`.

```csharp
public PossibleWatermarkCollection Search(SearchCriteria searchCriteria)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | SearchCriteria | The search criteria to use. |

##### Return Value

The collection of the possible watermarks.

#### Search()

Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`.

```csharp
public PossibleWatermarkCollection Search()
```

##### Return Value

The collection of the possible watermarks.

### OfficeDashStyle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officedashstyle.md

#### OfficeDashStyle enumeration

Represents a dashed line style.

```csharp
public enum OfficeDashStyle
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Solid | `0` | Solid (continuous) pen. |
| Default | `0` | Same as Solid. |
| Dot | `1` | Dot style. |
| Dash | `2` | Dash style. |
| DashDot | `3` | Dash dot style. |
| DashDotDot | `4` | Dash dot dot style. |

### OfficeHeaderFooterType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeheaderfootertype.md

#### OfficeHeaderFooterType enumeration

Identifies the type of header or footer.

```csharp
public enum OfficeHeaderFooterType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| HeaderPrimary | `0` | Primary header, also used for odd numbered pages. |
| HeaderEven | `1` | Header for even numbered pages. |
| HeaderFirst | `2` | Header for the first page. |
| FooterPrimary | `3` | Primary footer, also used for odd numbered pages. |
| FooterEven | `4` | Footer for even numbered pages. |
| FooterFirst | `5` | Footer for the first page. |

### OfficeImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects.md

#### OfficeImageEffects class

Represents effects that can be applied to an image watermark for an office content.

```csharp
public abstract class OfficeImageEffects
```

#### Properties

| Name | Description |
| --- | --- |
| BorderLineFormat { get; set; } | Gets or sets a line format settings for the image border. |
| Brightness { get; set; } | Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). |
| ChromaKey { get; set; } | Gets or sets the color value of the image that will be treated as transparent. |
| Contrast { get; set; } | Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). |
| GrayScale { get; set; } | Gets or sets a value indicating whether a picture will be displayed in grayscale mode. |

### BorderLineFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects/borderlineformat.md

#### OfficeImageEffects.BorderLineFormat property

Gets or sets a line format settings for the image border.

```csharp
public OfficeLineFormat BorderLineFormat { get; set; }
```

##### Property Value

Instance of `OfficeLineFormat` class, representing shape line format.

### Brightness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects/brightness.md

#### OfficeImageEffects.Brightness property

Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

```csharp
public double Brightness { get; set; }
```

##### Property Value

The default value is 0.5.

### ChromaKey
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects/chromakey.md

#### OfficeImageEffects.ChromaKey property

Gets or sets the color value of the image that will be treated as transparent.

```csharp
public Color ChromaKey { get; set; }
```

##### Property Value

The default value is fully transparent color.

### Contrast
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects/contrast.md

#### OfficeImageEffects.Contrast property

Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

```csharp
public double Contrast { get; set; }
```

##### Property Value

The default value is 0.5.

### GrayScale
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimageeffects/grayscale.md

#### OfficeImageEffects.GrayScale property

Gets or sets a value indicating whether a picture will be displayed in grayscale mode.

```csharp
public bool GrayScale { get; set; }
```

##### Property Value

The default value is false.

### OfficeImageFillFormatTWatermarkableImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimagefillformat-1.md

#### OfficeImageFillFormat&lt;TWatermarkableImage&gt; class

Represents the image fill format settings in any supported office content.

```csharp
public abstract class OfficeImageFillFormat<TWatermarkableImage>
    where TWatermarkableImage : WatermarkableImage
```

| Parameter | Description |
| --- | --- |
| TWatermarkableImage | The exact type of the watermarkable image that is used as background. |

#### Properties

| Name | Description |
| --- | --- |
| abstract BackgroundImage { get; set; } | Gets or sets the background image. |
| abstract TileAsTexture { get; set; } | Gets or sets a value indicating whether the image is tiled across the background. |
| abstract Transparency { get; set; } | Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### BackgroundImage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimagefillformat-1/backgroundimage.md

#### OfficeImageFillFormat&lt;TWatermarkableImage&gt;.BackgroundImage property

Gets or sets the background image.

```csharp
public abstract TWatermarkableImage BackgroundImage { get; set; }
```

##### Property Value

The background image. Returns null if the image is not set.

### TileAsTexture
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimagefillformat-1/tileastexture.md

#### OfficeImageFillFormat&lt;TWatermarkableImage&gt;.TileAsTexture property

Gets or sets a value indicating whether the image is tiled across the background.

```csharp
public abstract bool TileAsTexture { get; set; }
```

##### Property Value

True if the image is tiled across the background; otherwise, false (the image is stretched).

### Transparency
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeimagefillformat-1/transparency.md

#### OfficeImageFillFormat&lt;TWatermarkableImage&gt;.Transparency property

Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

```csharp
public abstract double Transparency { get; set; }
```

##### Property Value

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

### OfficeLineFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat.md

#### OfficeLineFormat class

Represents a shape line format.

```csharp
public sealed class OfficeLineFormat
```

#### Constructors

| Name | Description |
| --- | --- |
| OfficeLineFormat() | Initializes a new instance of the `OfficeLineFormat` class. |

#### Properties

| Name | Description |
| --- | --- |
| Color { get; set; } | Gets or sets the color of the line. |
| DashStyle { get; set; } | Gets or sets the dot and dash pattern for a line. |
| Enabled { get; set; } | Gets or sets a value indicating whether a shape will be stroked. |
| LineStyle { get; set; } | Gets or sets the line style. |
| Opacity { get; set; } | Gets or sets the line opacity. |
| Weight { get; set; } | Gets or sets the brush thickness that strokes the path of a shape. |

### Color
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/color.md

#### OfficeLineFormat.Color property

Gets or sets the color of the line.

```csharp
public Color Color { get; set; }
```

##### Property Value

The default value is `Black`.

### DashStyle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/dashstyle.md

#### OfficeLineFormat.DashStyle property

Gets or sets the dot and dash pattern for a line.

```csharp
public OfficeDashStyle DashStyle { get; set; }
```

##### Property Value

The default value is Solid.

### Enabled
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/enabled.md

#### OfficeLineFormat.Enabled property

Gets or sets a value indicating whether a shape will be stroked.

```csharp
public bool Enabled { get; set; }
```

##### Property Value

The default value is false.

### LineStyle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/linestyle.md

#### OfficeLineFormat.LineStyle property

Gets or sets the line style.

```csharp
public OfficeLineStyle LineStyle { get; set; }
```

##### Property Value

The default value is Single.

### OfficeLineFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/officelineformat.md

#### OfficeLineFormat constructor

Initializes a new instance of the `OfficeLineFormat` class.

```csharp
public OfficeLineFormat()
```

### Opacity
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/opacity.md

#### OfficeLineFormat.Opacity property

Gets or sets the line opacity.

```csharp
public double Opacity { get; set; }
```

##### Property Value

The value should be between 0 and 1. Default value is 1.

### Weight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelineformat/weight.md

#### OfficeLineFormat.Weight property

Gets or sets the brush thickness that strokes the path of a shape.

```csharp
public double Weight { get; set; }
```

##### Property Value

The line thickness in points. The default value is 0.75.

### OfficeLineStyle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officelinestyle.md

#### OfficeLineStyle enumeration

Represents the compound line style of a `OfficeLineFormat`.

```csharp
public enum OfficeLineStyle
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Single | `0` | Single line. |
| Default | `0` | Default value is Single. |
| Double | `1` | Double lines of equal width. |
| ThickThin | `2` | Double lines, one thick, one thin. |
| ThinThick | `3` | Double lines, one thin, one thick. |
| Triple | `4` | Three lines, thin, thick, thin. |

### OfficeShapeSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeshapesettings.md

#### OfficeShapeSettings class

Represents settings that can be applied to a shape watermark for an office content.

```csharp
public class OfficeShapeSettings
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Name { get; set; } | Gets or sets the name a shape. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeshapesettings/alternativetext.md

#### OfficeShapeSettings.AlternativeText property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text that will be associated with a shape.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officeshapesettings/name.md

#### OfficeShapeSettings.Name property

Gets or sets the name a shape.

```csharp
public string Name { get; set; }
```

##### Property Value

The shape name.

### OfficeTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officetexteffects.md

#### OfficeTextEffects class

Represents effects that can be applied to a text watermark for an office content.

```csharp
public abstract class OfficeTextEffects
```

#### Properties

| Name | Description |
| --- | --- |
| LineFormat { get; set; } | Gets or sets the line format settings. |

### LineFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.contents/officetexteffects/lineformat.md

#### OfficeTextEffects.LineFormat property

Gets or sets the line format settings.

```csharp
public OfficeLineFormat LineFormat { get; set; }
```

##### Property Value

The instance of `OfficeLineFormat` class, representing shape line format.

### GroupDocs.Watermark.Exceptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions.md

The namespace provides different exceptions classes.

#### Classes

| Class | Description |
| --- | --- |
| DetachedImageException | The exception that is thrown when manipulating detached image. |
| EncryptionIsNotSupportedException | The exception that is thrown when content encryption is not supported. |
| FontNotFoundException | The exception that is thrown when requested font is not found. |
| ImageEffectsForTextWatermarkException | The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`. |
| InvalidPasswordException | The exception that is thrown when supplied password is incorrect. |
| PreviewNotSupportedException | The exception that is thrown when a preview image cannot be generated for the content. |
| TextEffectsForImageWatermarkException | The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`. |
| UnexpectedDocumentStructureException | The exception that is thrown when a content cannot be parsed due to unexpected structure. |
| UnknownLoadOptionsTypeException | The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`. |
| UnknownWatermarkOptionsTypeException | The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`. |
| UnsupportedFileTypeException | The exception that is thrown when a file cannot be loaded. |
| WatermarkException | Represents base exception in **GroupDocs.Watermark** product. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### DetachedImageException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/detachedimageexception.md

#### DetachedImageException class

The exception that is thrown when manipulating detached image.

```csharp
public class DetachedImageException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| DetachedImageException() | Initializes a new instance of the `DetachedImageException` class. |

### DetachedImageException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/detachedimageexception/detachedimageexception.md

#### DetachedImageException constructor

Initializes a new instance of the `DetachedImageException` class.

```csharp
public DetachedImageException()
```

### EncryptionIsNotSupportedException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/encryptionisnotsupportedexception.md

#### EncryptionIsNotSupportedException class

The exception that is thrown when content encryption is not supported.

```csharp
public class EncryptionIsNotSupportedException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| EncryptionIsNotSupportedException() | Initializes a new instance of the `EncryptionIsNotSupportedException` class. |

### EncryptionIsNotSupportedException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/encryptionisnotsupportedexception/encryptionisnotsupportedexception.md

#### EncryptionIsNotSupportedException constructor

Initializes a new instance of the `EncryptionIsNotSupportedException` class.

```csharp
public EncryptionIsNotSupportedException()
```

### FontNotFoundException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/fontnotfoundexception.md

#### FontNotFoundException class

The exception that is thrown when requested font is not found.

```csharp
public class FontNotFoundException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| FontNotFoundException() | Initializes a new instance of the `FontNotFoundException` class. |
| FontNotFoundException(string) | Initializes a new instance of the `FontNotFoundException` class with a specified font name. |

#### Properties

| Name | Description |
| --- | --- |
| FontName { get; } | Gets the requested font name. |

### FontName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/fontnotfoundexception/fontname.md

#### FontNotFoundException.FontName property

Gets the requested font name.

```csharp
public string FontName { get; }
```

##### Property Value

The requested font name.

### FontNotFoundException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/fontnotfoundexception/fontnotfoundexception.md

#### FontNotFoundException()

Initializes a new instance of the `FontNotFoundException` class.

```csharp
public FontNotFoundException()
```

#### FontNotFoundException(string)

Initializes a new instance of the `FontNotFoundException` class with a specified font name.

```csharp
public FontNotFoundException(string fontName)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontName | String | The requested font name. |

### ImageEffectsForTextWatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/imageeffectsfortextwatermarkexception.md

#### ImageEffectsForTextWatermarkException class

The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`.

```csharp
public sealed class ImageEffectsForTextWatermarkException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageEffectsForTextWatermarkException() | Initializes a new instance of the `ImageEffectsForTextWatermarkException` class. |

### ImageEffectsForTextWatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/imageeffectsfortextwatermarkexception/imageeffectsfortextwatermarkexception.md

#### ImageEffectsForTextWatermarkException constructor

Initializes a new instance of the `ImageEffectsForTextWatermarkException` class.

```csharp
public ImageEffectsForTextWatermarkException()
```

### InvalidPasswordException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

The exception that is thrown when supplied password is incorrect.

```csharp
public class InvalidPasswordException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| InvalidPasswordException() | Initializes a new instance of the `InvalidPasswordException` class. |

### InvalidPasswordException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/invalidpasswordexception/invalidpasswordexception.md

#### InvalidPasswordException constructor

Initializes a new instance of the `InvalidPasswordException` class.

```csharp
public InvalidPasswordException()
```

### PreviewNotSupportedException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/previewnotsupportedexception.md

#### PreviewNotSupportedException class

The exception that is thrown when a preview image cannot be generated for the content.

```csharp
public class PreviewNotSupportedException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewNotSupportedException() | Initializes a new instance of the `PreviewNotSupportedException` class. |

### PreviewNotSupportedException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/previewnotsupportedexception/previewnotsupportedexception.md

#### PreviewNotSupportedException constructor

Initializes a new instance of the `PreviewNotSupportedException` class.

```csharp
public PreviewNotSupportedException()
```

### TextEffectsForImageWatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/texteffectsforimagewatermarkexception.md

#### TextEffectsForImageWatermarkException class

The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`.

```csharp
public sealed class TextEffectsForImageWatermarkException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| TextEffectsForImageWatermarkException() | Initializes a new instance of the `TextEffectsForImageWatermarkException` class. |

### TextEffectsForImageWatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/texteffectsforimagewatermarkexception/texteffectsforimagewatermarkexception.md

#### TextEffectsForImageWatermarkException constructor

Initializes a new instance of the `TextEffectsForImageWatermarkException` class.

```csharp
public TextEffectsForImageWatermarkException()
```

### UnexpectedDocumentStructureException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unexpecteddocumentstructureexception.md

#### UnexpectedDocumentStructureException class

The exception that is thrown when a content cannot be parsed due to unexpected structure.

```csharp
public class UnexpectedDocumentStructureException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnexpectedDocumentStructureException() | Initializes a new instance of the `UnexpectedDocumentStructureException` class. |

### UnexpectedDocumentStructureException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unexpecteddocumentstructureexception/unexpecteddocumentstructureexception.md

#### UnexpectedDocumentStructureException constructor

Initializes a new instance of the `UnexpectedDocumentStructureException` class.

```csharp
public UnexpectedDocumentStructureException()
```

### UnknownLoadOptionsTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unknownloadoptionstypeexception.md

#### UnknownLoadOptionsTypeException class

The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`.

```csharp
public sealed class UnknownLoadOptionsTypeException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnknownLoadOptionsTypeException() | Initializes a new instance of the `UnknownLoadOptionsTypeException` class. |

### UnknownLoadOptionsTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unknownloadoptionstypeexception/unknownloadoptionstypeexception.md

#### UnknownLoadOptionsTypeException constructor

Initializes a new instance of the `UnknownLoadOptionsTypeException` class.

```csharp
public UnknownLoadOptionsTypeException()
```

### UnknownWatermarkOptionsTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unknownwatermarkoptionstypeexception.md

#### UnknownWatermarkOptionsTypeException class

The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`.

```csharp
public sealed class UnknownWatermarkOptionsTypeException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnknownWatermarkOptionsTypeException() | Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class. |

### UnknownWatermarkOptionsTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unknownwatermarkoptionstypeexception/unknownwatermarkoptionstypeexception.md

#### UnknownWatermarkOptionsTypeException constructor

Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class.

```csharp
public UnknownWatermarkOptionsTypeException()
```

### UnsupportedFileTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unsupportedfiletypeexception.md

#### UnsupportedFileTypeException class

The exception that is thrown when a file cannot be loaded.

```csharp
public class UnsupportedFileTypeException : WatermarkException
```

#### Constructors

| Name | Description |
| --- | --- |
| UnsupportedFileTypeException() | Initializes a new instance of the `UnsupportedFileTypeException` class. |

### UnsupportedFileTypeException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/unsupportedfiletypeexception/unsupportedfiletypeexception.md

#### UnsupportedFileTypeException constructor

Initializes a new instance of the `UnsupportedFileTypeException` class.

```csharp
public UnsupportedFileTypeException()
```

### WatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/watermarkexception.md

#### WatermarkException class

Represents base exception in **GroupDocs.Watermark** product.

```csharp
public class WatermarkException : Exception
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkException() | Initializes a new instance of the `WatermarkException` class. |
| WatermarkException(string) | Initializes a new instance of the `WatermarkException` class with a specified error message. |
| WatermarkException(string, Exception) | Initializes a new instance of the `WatermarkException` class with a specified error message and a reference to the inner exception that is the cause of this exception. |

### WatermarkException
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.exceptions/watermarkexception/watermarkexception.md

#### WatermarkException()

Initializes a new instance of the `WatermarkException` class.

```csharp
public WatermarkException()
```

#### WatermarkException(string)

Initializes a new instance of the `WatermarkException` class with a specified error message.

```csharp
public WatermarkException(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The message that describes the error. |

#### WatermarkException(string, Exception)

Initializes a new instance of the `WatermarkException` class with a specified error message and a reference to the inner exception that is the cause of this exception.

```csharp
public WatermarkException(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.Watermark.Internal
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal.md

The namespace provides internal classes.

#### Classes

| Class | Description |
| --- | --- |
| WatermarkResult | Represents the result of watermarking operation, including details such as document sizes, processing time, and the number of applied watermarks. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### WatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult.md

#### WatermarkResult class

Represents the result of watermarking operation, including details such as document sizes, processing time, and the number of applied watermarks.

```csharp
public class WatermarkResult
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkResult() | Initializes a new instance of the `WatermarkResult` class. |
| WatermarkResult(long, TimeSpan, long, int) | Initializes a new instance of the `WatermarkResult` class with specific values. |

#### Properties

| Name | Description |
| --- | --- |
| FinalDocumentSize { get; } | Gets or sets the size of the final processed document in bytes. |
| NumberWatermarksApplied { get; } | Gets or sets the total number of watermarks applied to the document. |
| ProcessingTime { get; } | Gets or sets the processing time for the watermarking operation. |
| SourceDocumentSize { get; } | Gets or sets the size of the source document in bytes. |

### FinalDocumentSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult/finaldocumentsize.md

#### WatermarkResult.FinalDocumentSize property

Gets or sets the size of the final processed document in bytes.

```csharp
public long FinalDocumentSize { get; }
```

### NumberWatermarksApplied
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult/numberwatermarksapplied.md

#### WatermarkResult.NumberWatermarksApplied property

Gets or sets the total number of watermarks applied to the document.

```csharp
public int NumberWatermarksApplied { get; }
```

### ProcessingTime
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult/processingtime.md

#### WatermarkResult.ProcessingTime property

Gets or sets the processing time for the watermarking operation.

```csharp
public TimeSpan ProcessingTime { get; }
```

### SourceDocumentSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult/sourcedocumentsize.md

#### WatermarkResult.SourceDocumentSize property

Gets or sets the size of the source document in bytes.

```csharp
public long SourceDocumentSize { get; }
```

### WatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.internal/watermarkresult/watermarkresult.md

#### WatermarkResult()

Initializes a new instance of the `WatermarkResult` class.

```csharp
public WatermarkResult()
```

#### WatermarkResult(long, TimeSpan, long, int)

Initializes a new instance of the `WatermarkResult` class with specific values.

```csharp
public WatermarkResult(long sourceDocumentSize, TimeSpan processingTime, long finalDocumentSize, 
    int numberWatermarksApplied)
```

| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocumentSize | Int64 | The size of the source document in bytes. |
| processingTime | TimeSpan | The processing time in milliseconds. |
| finalDocumentSize | Int64 | The size of the final processed document in bytes. |
| numberWatermarksApplied | Int32 | The total number of watermarks applied to the document. |

### GroupDocs.Watermark.Options.Diagram
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram.md

The namespace provides classes to specify additional options when working with watermarks in Visio documents.

#### Classes

| Class | Description |
| --- | --- |
| DiagramLoadOptions | Represents document loading options for a Visio document. |
| DiagramPageWatermarkOptions | Represents watermark adding options when adding shape watermark to a particular page of a Visio document. |
| DiagramPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Diagram document. |
| DiagramSaveOptions | Represents document saving options when saving a Visio document. |
| DiagramShapeWatermarkOptions | Represents watermark adding options when adding shape watermark to a Visio document. |
| DiagramWatermarkOptions | Base class for watermark adding options to a Visio document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### DiagramLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramloadoptions.md

#### DiagramLoadOptions class

Represents document loading options for a Visio document.

```csharp
public sealed class DiagramLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramLoadOptions() | Initializes a new instance of the `DiagramLoadOptions` class. |
| DiagramLoadOptions(string) | Initializes a new instance of the `DiagramLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `DiagramLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramloadoptions/default.md

#### DiagramLoadOptions.Default property

Gets the default value for the `DiagramLoadOptions` class.

```csharp
public static DiagramLoadOptions Default { get; }
```

##### Property Value

The default value for the `DiagramLoadOptions` class.

### DiagramLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramloadoptions/diagramloadoptions.md

#### DiagramLoadOptions()

Initializes a new instance of the `DiagramLoadOptions` class.

```csharp
public DiagramLoadOptions()
```

#### DiagramLoadOptions(string)

Initializes a new instance of the `DiagramLoadOptions` class with a specified password.

```csharp
public DiagramLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted Visio document. |

### DiagramPageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions.md

#### DiagramPageWatermarkOptions class

Represents watermark adding options when adding shape watermark to a particular page of a Visio document.

```csharp
public sealed class DiagramPageWatermarkOptions : DiagramWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramPageWatermarkOptions() | Initializes a new instance of the `DiagramPageWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Visio is forbidden. |
| PageIndex { get; set; } | Gets or sets the page index to add watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to diagram documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents)

##### Examples

Add a protected watermark to the first page of a Visio document.

```csharp
DiagramLoadOptions loadOptions = new DiagramLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.vsdx", loadOptions))
{
    TextWatermark watermark = new TextWatermark("watermark test", new Font("Arial", 42));

    DiagramPageWatermarkOptions options = new DiagramPageWatermarkOptions();
    options.IsLocked = true;
    options.PageIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### DiagramPageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/diagrampagewatermarkoptions.md

#### DiagramPageWatermarkOptions constructor

Initializes a new instance of the `DiagramPageWatermarkOptions` class.

```csharp
public DiagramPageWatermarkOptions()
```

### PageIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/pageindex.md

#### DiagramPageWatermarkOptions.PageIndex property

Gets or sets the page index to add watermark to.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index to add watermark to.

### DiagramPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampreviewoptions.md

#### DiagramPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of Diagram document.

```csharp
public class DiagramPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramPreviewOptions(CreatePageStream) | Initializes a new instance of the `DiagramPreviewOptions` class causing the output stream to be closed. |
| DiagramPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| HighQualityRendering { get; set; } | Gets or sets the flag for high quality rendering. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampreviewoptions/defaultresolution.md

#### DiagramPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const float DefaultResolution;
```

### DiagramPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampreviewoptions/diagrampreviewoptions.md

#### DiagramPreviewOptions(CreatePageStream)

Initializes a new instance of the `DiagramPreviewOptions` class causing the output stream to be closed.

```csharp
public DiagramPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### DiagramPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public DiagramPreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### HighQualityRendering
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampreviewoptions/highqualityrendering.md

#### DiagramPreviewOptions.HighQualityRendering property

Gets or sets the flag for high quality rendering.

```csharp
public bool HighQualityRendering { get; set; }
```

##### Property Value

The flag for high quality rendering.

##### Remarks

The high quality rendering uses more resources. The default value is `false`.

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagrampreviewoptions/resolution.md

#### DiagramPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public float Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 300.

### DiagramSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramsaveoptions.md

#### DiagramSaveOptions class

Represents document saving options when saving a Visio document.

```csharp
public sealed class DiagramSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramSaveOptions() | Initializes a new instance of the `DiagramSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `DiagramSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramsaveoptions/default.md

#### DiagramSaveOptions.Default property

Gets the default value for the `DiagramSaveOptions` class.

```csharp
public static DiagramSaveOptions Default { get; }
```

##### Property Value

The default value for the `DiagramSaveOptions` class.

### DiagramSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramsaveoptions/diagramsaveoptions.md

#### DiagramSaveOptions constructor

Initializes a new instance of the `DiagramSaveOptions` class.

```csharp
public DiagramSaveOptions()
```

### DiagramShapeWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions.md

#### DiagramShapeWatermarkOptions class

Represents watermark adding options when adding shape watermark to a Visio document.

```csharp
public sealed class DiagramShapeWatermarkOptions : DiagramWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| DiagramShapeWatermarkOptions() | Initializes a new instance of the `DiagramShapeWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Visio is forbidden. |
| PlacementType { get; set; } | Gets or sets a value specifying to what pages a watermark should be added. |

##### Remarks

**Learn more:**

* [Add watermarks to diagram documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents)

##### Examples

Add protected watermark to all pages of the Visio document.

```csharp
DiagramLoadOptions loadOptions = new DiagramLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.vsdx", loadOptions))
{
    TextWatermark watermark = new TextWatermark("watermark test", new Font("Arial", 42));

    DiagramShapeWatermarkOptions options = new DiagramShapeWatermarkOptions();
    options.IsLocked = true;
    options.PlacementType = DiagramWatermarkPlacementType.AllPages; // default

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### DiagramShapeWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/diagramshapewatermarkoptions.md

#### DiagramShapeWatermarkOptions constructor

Initializes a new instance of the `DiagramShapeWatermarkOptions` class.

```csharp
public DiagramShapeWatermarkOptions()
```

### PlacementType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/placementtype.md

#### DiagramShapeWatermarkOptions.PlacementType property

Gets or sets a value specifying to what pages a watermark should be added.

```csharp
public DiagramWatermarkPlacementType PlacementType { get; set; }
```

##### Property Value

The value specifying to what pages a watermark should be added.

### DiagramWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramwatermarkoptions.md

#### DiagramWatermarkOptions class

Base class for watermark adding options to a Visio document.

```csharp
public abstract class DiagramWatermarkOptions : WatermarkOptions
```

#### Properties

| Name | Description |
| --- | --- |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Visio is forbidden. |

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.diagram/diagramwatermarkoptions/islocked.md

#### DiagramWatermarkOptions.IsLocked property

Gets or sets a value indicating whether an editing of the shape in Visio is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is true, shape editing will be forbidden.

##### Remarks

By default, the value is false, the shape can be edited in Visio.

### GroupDocs.Watermark.Options.Email
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email.md

The namespace provides classes to specify additional options when loading and saving Email messages.

#### Classes

| Class | Description |
| --- | --- |
| EmailLoadOptions | Represents the document loading options for an email message. |
| EmailPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Email document. |
| EmailSaveOptions | Represents the document saving options when saving an email message. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### EmailLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailloadoptions.md

#### EmailLoadOptions class

Represents the document loading options for an email message.

```csharp
public sealed class EmailLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailLoadOptions() | Initializes a new instance of the `EmailLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for `EmailLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailloadoptions/default.md

#### EmailLoadOptions.Default property

Gets the default value for `EmailLoadOptions` class.

```csharp
public static EmailLoadOptions Default { get; }
```

##### Property Value

The default value for `EmailLoadOptions` class.

### EmailLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailloadoptions/emailloadoptions.md

#### EmailLoadOptions constructor

Initializes a new instance of the `EmailLoadOptions` class.

```csharp
public EmailLoadOptions()
```

### EmailPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailpreviewoptions.md

#### EmailPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of Email document.

```csharp
public class EmailPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailPreviewOptions(CreatePageStream) | Initializes a new instance of the `EmailPreviewOptions` class causing the output stream to be closed. |
| EmailPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `EmailPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailpreviewoptions/defaultresolution.md

#### EmailPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const float DefaultResolution;
```

### EmailPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailpreviewoptions/emailpreviewoptions.md

#### EmailPreviewOptions(CreatePageStream)

Initializes a new instance of the `EmailPreviewOptions` class causing the output stream to be closed.

```csharp
public EmailPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### EmailPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `EmailPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public EmailPreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailpreviewoptions/resolution.md

#### EmailPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public float Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 96.

### EmailSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailsaveoptions.md

#### EmailSaveOptions class

Represents the document saving options when saving an email message.

```csharp
public sealed class EmailSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| EmailSaveOptions() | Initializes a new instance of the `EmailSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `EmailSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailsaveoptions/default.md

#### EmailSaveOptions.Default property

Gets the default value for the `EmailSaveOptions` class.

```csharp
public static EmailSaveOptions Default { get; }
```

##### Property Value

The default value for the `EmailSaveOptions` class.

### EmailSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.email/emailsaveoptions/emailsaveoptions.md

#### EmailSaveOptions constructor

Initializes a new instance of the `EmailSaveOptions` class.

```csharp
public EmailSaveOptions()
```

### GroupDocs.Watermark.Options.Image
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image.md

The namespace provides classes to specify additional options when working with watermarks and images.

#### Classes

| Class | Description |
| --- | --- |
| GifImageLoadOptions | Represents image loading options for a GIF image. |
| GifImageSaveOptions | Represents image saving options when saving a GIF image. |
| GifImageWatermarkOptions | Represents watermark adding options when adding watermark to a GIF image. |
| ImageLoadOptions | Represents image loading options when loading an image. |
| ImageSaveOptions | Represents image saving options when saving an image. |
| MultiframeImageLoadOptions | Represents image loading options when loading a multiframe image. |
| MultiframeImageWatermarkOptions | Represents watermark adding options when adding watermark to a multi-frame image. |
| TiffImageLoadOptions | Represents image loading options for a TIFF image. |
| TiffImageSaveOptions | Represents image saving options when saving a TIFF image. |
| TiffImageWatermarkOptions | Represents watermark adding options when adding watermark to a TIFF image. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### GifImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimageloadoptions.md

#### GifImageLoadOptions class

Represents image loading options for a GIF image.

```csharp
public sealed class GifImageLoadOptions : MultiframeImageLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GifImageLoadOptions() | Initializes a new instance of the `GifImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for `GifImageLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimageloadoptions/default.md

#### GifImageLoadOptions.Default property

Gets the default value for `GifImageLoadOptions` class.

```csharp
public static GifImageLoadOptions Default { get; }
```

##### Property Value

The default value for `GifImageLoadOptions` class.

### GifImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimageloadoptions/gifimageloadoptions.md

#### GifImageLoadOptions constructor

Initializes a new instance of the `GifImageLoadOptions` class.

```csharp
public GifImageLoadOptions()
```

### GifImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimagesaveoptions.md

#### GifImageSaveOptions class

Represents image saving options when saving a GIF image.

```csharp
public sealed class GifImageSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GifImageSaveOptions() | Initializes a new instance of the `GifImageSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `GifImageSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimagesaveoptions/default.md

#### GifImageSaveOptions.Default property

Gets the default value for the `GifImageSaveOptions` class.

```csharp
public static GifImageSaveOptions Default { get; }
```

##### Property Value

The default value for the `GifImageSaveOptions` class.

### GifImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimagesaveoptions/gifimagesaveoptions.md

#### GifImageSaveOptions constructor

Initializes a new instance of the `GifImageSaveOptions` class.

```csharp
public GifImageSaveOptions()
```

### GifImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimagewatermarkoptions.md

#### GifImageWatermarkOptions class

Represents watermark adding options when adding watermark to a GIF image.

```csharp
public sealed class GifImageWatermarkOptions : MultiframeImageWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| GifImageWatermarkOptions() | Initializes a new instance of the `GifImageWatermarkOptions` class. |
| GifImageWatermarkOptions(int) | Initializes a new instance of the `GifImageWatermarkOptions` class with a specified index of a frame. |

#### Properties

| Name | Description |
| --- | --- |
| FrameIndex { get; set; } | Gets or sets the index of frame to add watermark. |

##### Remarks

**Learn more:**

* [Add watermarks to images](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images)

##### Examples

Add a watermark to a particular frame of GIF image.

```csharp
GifImageLoadOptions loadOptions = new GifImageLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\test.gif", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));

    GifImageWatermarkOptions options = new GifImageWatermarkOptions();
    options.FrameIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### GifImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/gifimagewatermarkoptions/gifimagewatermarkoptions.md

#### GifImageWatermarkOptions()

Initializes a new instance of the `GifImageWatermarkOptions` class.

```csharp
public GifImageWatermarkOptions()
```

#### GifImageWatermarkOptions(int)

Initializes a new instance of the `GifImageWatermarkOptions` class with a specified index of a frame.

```csharp
public GifImageWatermarkOptions(int frameIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | Int32 | The index of frame to add watermark. |

### ImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imageloadoptions.md

#### ImageLoadOptions class

Represents image loading options when loading an image.

```csharp
public class ImageLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageLoadOptions() | Initializes a new instance of the `ImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `ImageLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imageloadoptions/default.md

#### ImageLoadOptions.Default property

Gets the default value for the `ImageLoadOptions` class.

```csharp
public static ImageLoadOptions Default { get; }
```

##### Property Value

The default value for the `ImageLoadOptions` class.

### ImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imageloadoptions/imageloadoptions.md

#### ImageLoadOptions constructor

Initializes a new instance of the `ImageLoadOptions` class.

```csharp
public ImageLoadOptions()
```

### ImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imagesaveoptions.md

#### ImageSaveOptions class

Represents image saving options when saving an image.

```csharp
public class ImageSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageSaveOptions() | Initializes a new instance of the `ImageSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `ImageSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imagesaveoptions/default.md

#### ImageSaveOptions.Default property

Gets the default value for the `ImageSaveOptions` class.

```csharp
public static ImageSaveOptions Default { get; }
```

##### Property Value

The default value for the `ImageSaveOptions` class.

### ImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/imagesaveoptions/imagesaveoptions.md

#### ImageSaveOptions constructor

Initializes a new instance of the `ImageSaveOptions` class.

```csharp
public ImageSaveOptions()
```

### MultiframeImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimageloadoptions.md

#### MultiframeImageLoadOptions class

Represents image loading options when loading a multiframe image.

```csharp
public class MultiframeImageLoadOptions : ImageLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MultiframeImageLoadOptions() | Initializes a new instance of the `MultiframeImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `MultiframeImageLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimageloadoptions/default.md

#### MultiframeImageLoadOptions.Default property

Gets the default value for the `MultiframeImageLoadOptions` class.

```csharp
public static MultiframeImageLoadOptions Default { get; }
```

##### Property Value

The default value for the `MultiframeImageLoadOptions` class.

### MultiframeImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimageloadoptions/multiframeimageloadoptions.md

#### MultiframeImageLoadOptions constructor

Initializes a new instance of the `MultiframeImageLoadOptions` class.

```csharp
public MultiframeImageLoadOptions()
```

### MultiframeImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions.md

#### MultiframeImageWatermarkOptions class

Represents watermark adding options when adding watermark to a multi-frame image.

```csharp
public class MultiframeImageWatermarkOptions : WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| MultiframeImageWatermarkOptions() | Initializes a new instance of the `MultiframeImageWatermarkOptions` class. |
| MultiframeImageWatermarkOptions(int) | Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified index of the frame. |

#### Properties

| Name | Description |
| --- | --- |
| FrameIndex { get; set; } | Gets or sets the index of frame to add watermark. |

##### Remarks

**Learn more:**

* [Add watermarks to images](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images)

##### Examples

Add watermark to a particular frame of multi-frame image.

```csharp
ImageLoadOptions loadOptions = new ImageLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\test.gif", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));

    MultiframeImageWatermarkOptions options = new MultiframeImageWatermarkOptions();
    options.FrameIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### FrameIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions/frameindex.md

#### MultiframeImageWatermarkOptions.FrameIndex property

Gets or sets the index of frame to add watermark.

```csharp
public int FrameIndex { get; set; }
```

##### Property Value

The index of frame to add watermark.

##### Remarks

-1 means all frames.

### MultiframeImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions/multiframeimagewatermarkoptions.md

#### MultiframeImageWatermarkOptions()

Initializes a new instance of the `MultiframeImageWatermarkOptions` class.

```csharp
public MultiframeImageWatermarkOptions()
```

#### MultiframeImageWatermarkOptions(int)

Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified index of the frame.

```csharp
public MultiframeImageWatermarkOptions(int frameIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | Int32 | The index of frame to add watermark. |

### TiffImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimageloadoptions.md

#### TiffImageLoadOptions class

Represents image loading options for a TIFF image.

```csharp
public sealed class TiffImageLoadOptions : MultiframeImageLoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffImageLoadOptions() | Initializes a new instance of the `TiffImageLoadOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for `TiffImageLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimageloadoptions/default.md

#### TiffImageLoadOptions.Default property

Gets the default value for `TiffImageLoadOptions` class.

```csharp
public static TiffImageLoadOptions Default { get; }
```

##### Property Value

The default value for `TiffImageLoadOptions` class.

### TiffImageLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimageloadoptions/tiffimageloadoptions.md

#### TiffImageLoadOptions constructor

Initializes a new instance of the `TiffImageLoadOptions` class.

```csharp
public TiffImageLoadOptions()
```

### TiffImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimagesaveoptions.md

#### TiffImageSaveOptions class

Represents image saving options when saving a TIFF image.

```csharp
public sealed class TiffImageSaveOptions : ImageSaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffImageSaveOptions() | Initializes a new instance of the `TiffImageSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `TiffImageSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimagesaveoptions/default.md

#### TiffImageSaveOptions.Default property

Gets the default value for the `TiffImageSaveOptions` class.

```csharp
public static TiffImageSaveOptions Default { get; }
```

##### Property Value

The default value for the `TiffImageSaveOptions` class.

### TiffImageSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimagesaveoptions/tiffimagesaveoptions.md

#### TiffImageSaveOptions constructor

Initializes a new instance of the `TiffImageSaveOptions` class.

```csharp
public TiffImageSaveOptions()
```

### TiffImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimagewatermarkoptions.md

#### TiffImageWatermarkOptions class

Represents watermark adding options when adding watermark to a TIFF image.

```csharp
public sealed class TiffImageWatermarkOptions : MultiframeImageWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TiffImageWatermarkOptions() | Initializes a new instance of the `TiffImageWatermarkOptions` class. |
| TiffImageWatermarkOptions(int) | Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified index of the frame. |

#### Properties

| Name | Description |
| --- | --- |
| FrameIndex { get; set; } | Gets or sets the index of frame to add watermark. |

##### Remarks

**Learn more:**

* [Add watermarks to images](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images)

##### Examples

Add watermark to a particular frame of TIFF image.

```csharp
TiffImageLoadOptions loadOptions = new TiffImageLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\test.tiff", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 12));

    TiffImageWatermarkOptions options = new TiffImageWatermarkOptions();
    options.FrameIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### TiffImageWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.image/tiffimagewatermarkoptions/tiffimagewatermarkoptions.md

#### TiffImageWatermarkOptions()

Initializes a new instance of the `TiffImageWatermarkOptions` class.

```csharp
public TiffImageWatermarkOptions()
```

#### TiffImageWatermarkOptions(int)

Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified index of the frame.

```csharp
public TiffImageWatermarkOptions(int frameIndex)
```

| Parameter | Type | Description |
| --- | --- | --- |
| frameIndex | Int32 | The index of frame to add watermark. |

### GroupDocs.Watermark.Options.Pdf
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf.md

The namespace provides classes to specify additional options when working with watermarks and PDF documents.

#### Classes

| Class | Description |
| --- | --- |
| PdfAnnotationWatermarkOptions | Represents watermark adding options when adding annotation watermark to a pdf document. |
| PdfArtifactWatermarkOptions | Represents watermark adding options when adding artifact watermark to a pdf document. |
| PdfLoadOptions | Represents document loading options for a pdf document. |
| PdfPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of PDF document. |
| PdfSaveOptions | Represents document saving options when saving a pdf document. |
| PdfWatermarkOptions | Base class for watermark adding options to a pdf document. |
| PdfXObjectWatermarkOptions | Represents watermark adding options when adding XObject watermark to a pdf document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### PdfAnnotationWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions.md

#### PdfAnnotationWatermarkOptions class

Represents watermark adding options when adding annotation watermark to a pdf document.

```csharp
public sealed class PdfAnnotationWatermarkOptions : PdfWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfAnnotationWatermarkOptions() | Initializes a new instance of the `PdfAnnotationWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| PageIndex { get; set; } | Gets or sets the page index to add watermark to. |
| PrintOnly { get; set; } | Get or sets the value indicating whether annotation will be printed, but not displayed in pdf viewing application. |

##### Remarks

**Learn more:**

* [Add watermarks to PDF documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents)

##### Examples

Add an image annotation watermark to a PDF document.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.pdf", loadOptions))
{
    using (ImageWatermark watermark = new ImageWatermark(@"D:\icon.png"))
    {
        PdfAnnotationWatermarkOptions options = new PdfAnnotationWatermarkOptions();
        options.PageIndex = -1; // default - all pages

        watermarker.Add(watermark, options);
    }

    watermarker.Save();
}
```

### PageIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/pageindex.md

#### PdfAnnotationWatermarkOptions.PageIndex property

Gets or sets the page index to add watermark to.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index to add watermark to.

##### Remarks

-1 means all pages.

### PdfAnnotationWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/pdfannotationwatermarkoptions.md

#### PdfAnnotationWatermarkOptions constructor

Initializes a new instance of the `PdfAnnotationWatermarkOptions` class.

```csharp
public PdfAnnotationWatermarkOptions()
```

### PrintOnly
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/printonly.md

#### PdfAnnotationWatermarkOptions.PrintOnly property

Get or sets the value indicating whether annotation will be printed, but not displayed in pdf viewing application.

```csharp
public bool PrintOnly { get; set; }
```

##### Property Value

The value indicating whether annotation will be printed, but not displayed in pdf viewing application.

### PdfArtifactWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions.md

#### PdfArtifactWatermarkOptions class

Represents watermark adding options when adding artifact watermark to a pdf document.

```csharp
public sealed class PdfArtifactWatermarkOptions : PdfWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfArtifactWatermarkOptions() | Initializes a new instance of the `PdfArtifactWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| PageIndex { get; set; } | Gets or sets the page index to add watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to PDF documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents)

##### Examples

Add image artifact watermark to a PDF document.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.pdf", loadOptions))
{
    using (ImageWatermark watermark = new ImageWatermark(@"D:\icon.png"))
    {
        watermark.HorizontalAlignment = HorizontalAlignment.Right;
        watermark.VerticalAlignment = VerticalAlignment.Bottom;

        PdfArtifactWatermarkOptions options = new PdfArtifactWatermarkOptions();
        options.PageIndex = -1; // default - all pages

        watermarker.Add(watermark, options);
        watermarker.Save();
    }
}
```

### PageIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions/pageindex.md

#### PdfArtifactWatermarkOptions.PageIndex property

Gets or sets the page index to add watermark to.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index to add watermark to.

### PdfArtifactWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions/pdfartifactwatermarkoptions.md

#### PdfArtifactWatermarkOptions constructor

Initializes a new instance of the `PdfArtifactWatermarkOptions` class.

```csharp
public PdfArtifactWatermarkOptions()
```

### PdfLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfloadoptions.md

#### PdfLoadOptions class

Represents document loading options for a pdf document.

```csharp
public sealed class PdfLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfLoadOptions() | Initializes a new instance of the `PdfLoadOptions` class. |
| PdfLoadOptions(string) | Initializes a new instance of the `PdfLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `PdfLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfloadoptions/default.md

#### PdfLoadOptions.Default property

Gets the default value for the `PdfLoadOptions` class.

```csharp
public static PdfLoadOptions Default { get; }
```

##### Property Value

The default value for the `PdfLoadOptions` class.

### PdfLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfloadoptions/pdfloadoptions.md

#### PdfLoadOptions()

Initializes a new instance of the `PdfLoadOptions` class.

```csharp
public PdfLoadOptions()
```

#### PdfLoadOptions(string)

Initializes a new instance of the `PdfLoadOptions` class with a specified password.

```csharp
public PdfLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted document. |

### PdfPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfpreviewoptions.md

#### PdfPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of PDF document.

```csharp
public class PdfPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfPreviewOptions(CreatePageStream) | Initializes a new instance of the `PdfPreviewOptions` class causing the output stream to be closed. |
| PdfPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfpreviewoptions/defaultresolution.md

#### PdfPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const int DefaultResolution;
```

### PdfPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfpreviewoptions/pdfpreviewoptions.md

#### PdfPreviewOptions(CreatePageStream)

Initializes a new instance of the `PdfPreviewOptions` class causing the output stream to be closed.

```csharp
public PdfPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### PdfPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public PdfPreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfpreviewoptions/resolution.md

#### PdfPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public int Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 150.

### PdfSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfsaveoptions.md

#### PdfSaveOptions class

Represents document saving options when saving a pdf document.

```csharp
public sealed class PdfSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfSaveOptions() | Initializes a new instance of the `PdfSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `PdfSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfsaveoptions/default.md

#### PdfSaveOptions.Default property

Gets the default value for the `PdfSaveOptions` class.

```csharp
public static PdfSaveOptions Default { get; }
```

##### Property Value

The default value for the `PdfSaveOptions` class.

### PdfSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfsaveoptions/pdfsaveoptions.md

#### PdfSaveOptions constructor

Initializes a new instance of the `PdfSaveOptions` class.

```csharp
public PdfSaveOptions()
```

### PdfWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfwatermarkoptions.md

#### PdfWatermarkOptions class

Base class for watermark adding options to a pdf document.

```csharp
public abstract class PdfWatermarkOptions : WatermarkOptions
```

### PdfXObjectWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions.md

#### PdfXObjectWatermarkOptions class

Represents watermark adding options when adding XObject watermark to a pdf document.

```csharp
public sealed class PdfXObjectWatermarkOptions : PdfWatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PdfXObjectWatermarkOptions() | Initializes a new instance of the `PdfXObjectWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| PageIndex { get; set; } | Gets or sets the page index to add watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to PDF documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents)

##### Examples

Add a watermark to a particular page of a pdf document.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\doc.pdf", loadOptions))
using (ImageWatermark watermark = new ImageWatermark(@"C:\watermark.png"))
{
    PdfXObjectWatermarkOptions options = new PdfXObjectWatermarkOptions();
    options.PageIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### PageIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions/pageindex.md

#### PdfXObjectWatermarkOptions.PageIndex property

Gets or sets the page index to add watermark to.

```csharp
public int PageIndex { get; set; }
```

##### Property Value

The page index to add watermark to.

### PdfXObjectWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions/pdfxobjectwatermarkoptions.md

#### PdfXObjectWatermarkOptions constructor

Initializes a new instance of the `PdfXObjectWatermarkOptions` class.

```csharp
public PdfXObjectWatermarkOptions()
```

### GroupDocs.Watermark.Options.Presentation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation.md

The namespace provides classes to specify additional options when working witharks and PowerPoint documents.

#### Classes

| Class | Description |
| --- | --- |
| PresentationImageEffects | Represents effects that can be applied to an image watermark for a PowerPoint document. |
| PresentationLoadOptions | Represents document loading options for a Presentation document. |
| PresentationPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Presentation document. |
| PresentationSaveOptions | Represents document saving options when saving a Presentation document. |
| PresentationTextEffects | Represents effects that can be applied to a text watermark for a PowerPoint content. |
| PresentationWatermarkBaseSlideOptions | Base class for watermark adding options to a Presentation document. |
| PresentationWatermarkLayoutSlideOptions | Represents options when adding watermark to a Presentation document layout slide. |
| PresentationWatermarkMasterHandoutSlideOptions | Represents options when adding watermark to a Presentation document master handout slide. |
| PresentationWatermarkMasterNotesSlideOptions | Represents options when adding watermark to a Presentation document master notes slide. |
| PresentationWatermarkMasterSlideOptions | Represents options when adding watermark to a Presentation document master slide. |
| PresentationWatermarkNoteSlideOptions | Represents options when adding watermark to a Presentation document note slide. |
| PresentationWatermarkOptions | Base class for watermark adding options to a Presentation document. |
| PresentationWatermarkSlideOptions | Represents options when adding watermark to a Presentation document slide. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IPresentationWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### IPresentationWatermarkEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/ipresentationwatermarkeffects.md

#### IPresentationWatermarkEffects interface

Represents interface for watermark effects that should be applied to the watermark.

```csharp
public interface IPresentationWatermarkEffects
```

### PresentationImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationimageeffects.md

#### PresentationImageEffects class

Represents effects that can be applied to an image watermark for a PowerPoint document.

```csharp
public sealed class PresentationImageEffects : OfficeImageEffects, IPresentationWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationImageEffects() | Initializes a new instance of the `PresentationImageEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| BorderLineFormat { get; set; } | Gets or sets a line format settings for the image border. |
| Brightness { get; set; } | Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). |
| ChromaKey { get; set; } | Gets or sets the color value of the image that will be treated as transparent. |
| Contrast { get; set; } | Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). |
| GrayScale { get; set; } | Gets or sets a value indicating whether a picture will be displayed in grayscale mode. |

### PresentationImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationimageeffects/presentationimageeffects.md

#### PresentationImageEffects constructor

Initializes a new instance of the `PresentationImageEffects` class.

```csharp
public PresentationImageEffects()
```

### PresentationLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationloadoptions.md

#### PresentationLoadOptions class

Represents document loading options for a Presentation document.

```csharp
public sealed class PresentationLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationLoadOptions() | Initializes a new instance of the `PresentationLoadOptions` class. |
| PresentationLoadOptions(string) | Initializes a new instance of the `PresentationLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `PresentationLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationloadoptions/default.md

#### PresentationLoadOptions.Default property

Gets the default value for the `PresentationLoadOptions` class.

```csharp
public static PresentationLoadOptions Default { get; }
```

##### Property Value

The default value for the `PresentationLoadOptions` class.

### PresentationLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationloadoptions/presentationloadoptions.md

#### PresentationLoadOptions()

Initializes a new instance of the `PresentationLoadOptions` class.

```csharp
public PresentationLoadOptions()
```

#### PresentationLoadOptions(string)

Initializes a new instance of the `PresentationLoadOptions` class with a specified password.

```csharp
public PresentationLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted content. |

### PresentationPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationpreviewoptions.md

#### PresentationPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of Presentation document.

```csharp
public class PresentationPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationPreviewOptions(CreatePageStream) | Initializes a new instance of the `PresentationPreviewOptions` class causing the output stream to be closed. |
| PresentationPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationpreviewoptions/defaultresolution.md

#### PresentationPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const uint DefaultResolution;
```

### PresentationPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationpreviewoptions/presentationpreviewoptions.md

#### PresentationPreviewOptions(CreatePageStream)

Initializes a new instance of the `PresentationPreviewOptions` class causing the output stream to be closed.

```csharp
public PresentationPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### PresentationPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public PresentationPreviewOptions(CreatePageStream createPageStream, 
    ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationpreviewoptions/resolution.md

#### PresentationPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public uint Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 300.

### PresentationSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationsaveoptions.md

#### PresentationSaveOptions class

Represents document saving options when saving a Presentation document.

```csharp
public sealed class PresentationSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationSaveOptions() | Initializes a new instance of the `PresentationSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `PresentationSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationsaveoptions/default.md

#### PresentationSaveOptions.Default property

Gets the default value for the `PresentationSaveOptions` class.

```csharp
public static PresentationSaveOptions Default { get; }
```

##### Property Value

The default value for the `PresentationSaveOptions` class.

### PresentationSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationsaveoptions/presentationsaveoptions.md

#### PresentationSaveOptions constructor

Initializes a new instance of the `PresentationSaveOptions` class.

```csharp
public PresentationSaveOptions()
```

### PresentationTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationtexteffects.md

#### PresentationTextEffects class

Represents effects that can be applied to a text watermark for a PowerPoint content.

```csharp
public sealed class PresentationTextEffects : OfficeTextEffects, IPresentationWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationTextEffects() | Initializes a new instance of the `PresentationTextEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| LineFormat { get; set; } | Gets or sets the line format settings. |

### PresentationTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationtexteffects/presentationtexteffects.md

#### PresentationTextEffects constructor

Initializes a new instance of the `PresentationTextEffects` class.

```csharp
public PresentationTextEffects()
```

### PresentationWatermarkBaseSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions.md

#### PresentationWatermarkBaseSlideOptions class

Base class for watermark adding options to a Presentation document.

```csharp
public abstract class PresentationWatermarkBaseSlideOptions : PresentationWatermarkOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

##### Examples

Add watermark to different service slides of a Power Point presentation.

```csharp
PresentationLoadOptions loadOptions = new PresentationLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.pptx", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 8));

    // Add watermark to all master slides
    PresentationWatermarkMasterSlideOptions masterSlideOptions = new PresentationWatermarkMasterSlideOptions();
    masterSlideOptions.MasterSlideIndex = -1; // default
    watermarker.Add(watermark, masterSlideOptions);

    // Add watermark to all layout slides
    PresentationWatermarkLayoutSlideOptions layoutSlideOptions = new PresentationWatermarkLayoutSlideOptions();
    layoutSlideOptions.LayoutSlideIndex = -1; // default
    watermarker.Add(watermark, layoutSlideOptions);

    // Add watermark to all notes slides
    PresentationWatermarkNoteSlideOptions noteSlideOptions = new PresentationWatermarkNoteSlideOptions();
    noteSlideOptions.SlideIndex = -1; // default
    watermarker.Add(watermark, noteSlideOptions);

    // Add watermark to handout master
    PresentationWatermarkMasterHandoutSlideOptions masterHandoutSlideOptions = new PresentationWatermarkMasterHandoutSlideOptions();
    watermarker.Add(watermark, masterHandoutSlideOptions);

    // Add watermark to notes master
    PresentationWatermarkMasterNotesSlideOptions masterNotesSlideOptions = new PresentationWatermarkMasterNotesSlideOptions();
    watermarker.Add(watermark, masterNotesSlideOptions);

    watermarker.Save();
}
```

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/alternativetext.md

#### PresentationWatermarkBaseSlideOptions.AlternativeText property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text that will be associated with a shape.

### Effects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/effects.md

#### PresentationWatermarkBaseSlideOptions.Effects property

Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark.

```csharp
public IPresentationWatermarkEffects Effects { get; set; }
```

##### Property Value

The value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark.

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/islocked.md

#### PresentationWatermarkBaseSlideOptions.IsLocked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in PowerPoint.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/name.md

#### PresentationWatermarkBaseSlideOptions.Name property

Gets or sets the name a shape.

```csharp
public string Name { get; set; }
```

##### Property Value

The shape name.

### ProtectWithUnreadableCharacters
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/protectwithunreadablecharacters.md

#### PresentationWatermarkBaseSlideOptions.ProtectWithUnreadableCharacters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

```csharp
public bool ProtectWithUnreadableCharacters { get; set; }
```

##### Property Value

A value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `IsLocked` property is `true`.

### PresentationWatermarkLayoutSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions.md

#### PresentationWatermarkLayoutSlideOptions class

Represents options when adding watermark to a Presentation document layout slide.

```csharp
public sealed class PresentationWatermarkLayoutSlideOptions : PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkLayoutSlideOptions() | Initializes a new instance of the `PresentationWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| LayoutSlideIndex { get; set; } | Gets or sets the index of layout slide to add the watermark to. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

### LayoutSlideIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/layoutslideindex.md

#### PresentationWatermarkLayoutSlideOptions.LayoutSlideIndex property

Gets or sets the index of layout slide to add the watermark to.

```csharp
public int LayoutSlideIndex { get; set; }
```

##### Property Value

The index of layout slide to add the watermark to.

##### Remarks

-1 means all slides.

### PresentationWatermarkLayoutSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/presentationwatermarklayoutslideoptions.md

#### PresentationWatermarkLayoutSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkOptions` class.

```csharp
public PresentationWatermarkLayoutSlideOptions()
```

### PresentationWatermarkMasterHandoutSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions.md

#### PresentationWatermarkMasterHandoutSlideOptions class

Represents options when adding watermark to a Presentation document master handout slide.

```csharp
public sealed class PresentationWatermarkMasterHandoutSlideOptions : 
    PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkMasterHandoutSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

### PresentationWatermarkMasterHandoutSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/presentationwatermarkmasterhandoutslideoptions.md

#### PresentationWatermarkMasterHandoutSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class.

```csharp
public PresentationWatermarkMasterHandoutSlideOptions()
```

### PresentationWatermarkMasterNotesSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions.md

#### PresentationWatermarkMasterNotesSlideOptions class

Represents options when adding watermark to a Presentation document master notes slide.

```csharp
public sealed class PresentationWatermarkMasterNotesSlideOptions : 
    PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkMasterNotesSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

### PresentationWatermarkMasterNotesSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/presentationwatermarkmasternotesslideoptions.md

#### PresentationWatermarkMasterNotesSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class.

```csharp
public PresentationWatermarkMasterNotesSlideOptions()
```

### PresentationWatermarkMasterSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions.md

#### PresentationWatermarkMasterSlideOptions class

Represents options when adding watermark to a Presentation document master slide.

```csharp
public sealed class PresentationWatermarkMasterSlideOptions : PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkMasterSlideOptions() | Initializes a new instance of the `PresentationWatermarkMasterSlideOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| MasterSlideIndex { get; set; } | Gets or sets the index of master slide to add the watermark to. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

### MasterSlideIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/masterslideindex.md

#### PresentationWatermarkMasterSlideOptions.MasterSlideIndex property

Gets or sets the index of master slide to add the watermark to.

```csharp
public int MasterSlideIndex { get; set; }
```

##### Property Value

The index of master slide to add the watermark to.

##### Remarks

-1 means all slides.

### PresentationWatermarkMasterSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/presentationwatermarkmasterslideoptions.md

#### PresentationWatermarkMasterSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkMasterSlideOptions` class.

```csharp
public PresentationWatermarkMasterSlideOptions()
```

### PresentationWatermarkNoteSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions.md

#### PresentationWatermarkNoteSlideOptions class

Represents options when adding watermark to a Presentation document note slide.

```csharp
public sealed class PresentationWatermarkNoteSlideOptions : PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkNoteSlideOptions() | Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |
| SlideIndex { get; set; } | Gets or sets the index of a slide to add the watermark to note slide of it. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

### PresentationWatermarkNoteSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/presentationwatermarknoteslideoptions.md

#### PresentationWatermarkNoteSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class.

```csharp
public PresentationWatermarkNoteSlideOptions()
```

### SlideIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/slideindex.md

#### PresentationWatermarkNoteSlideOptions.SlideIndex property

Gets or sets the index of a slide to add the watermark to note slide of it.

```csharp
public int SlideIndex { get; set; }
```

##### Property Value

The index of slide to add the watermark to note slide of it.

##### Remarks

-1 means all slides.

### PresentationWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkoptions.md

#### PresentationWatermarkOptions class

Base class for watermark adding options to a Presentation document.

```csharp
public abstract class PresentationWatermarkOptions : WatermarkOptions
```

### PresentationWatermarkSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions.md

#### PresentationWatermarkSlideOptions class

Represents options when adding watermark to a Presentation document slide.

```csharp
public sealed class PresentationWatermarkSlideOptions : PresentationWatermarkBaseSlideOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PresentationWatermarkSlideOptions() | Initializes a new instance of the `PresentationWatermarkSlideOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `PresentationImageEffects` or `PresentationTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| ProtectWithUnreadableCharacters { get; set; } | Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters. |
| SlideIndex { get; set; } | Gets or sets the index of slide to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

##### Examples

Add watermark to a particular slide of a Power Point presentation.

```csharp
PresentationLoadOptions loadOptions = new PresentationLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.ppt", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36, FontStyle.Bold | FontStyle.Italic));
    watermark.HorizontalAlignment = HorizontalAlignment.Center;
    watermark.VerticalAlignment = VerticalAlignment.Center;

    PresentationWatermarkSlideOptions options = new PresentationWatermarkSlideOptions();
    options.SlideIndex = 0;
    options.IsLocked = false; // default
    options.ProtectWithUnreadableCharacters = false; // default
    options.Name = null; // default
    options.AlternativeText = null; // default

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### PresentationWatermarkSlideOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/presentationwatermarkslideoptions.md

#### PresentationWatermarkSlideOptions constructor

Initializes a new instance of the `PresentationWatermarkSlideOptions` class.

```csharp
public PresentationWatermarkSlideOptions()
```

### SlideIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/slideindex.md

#### PresentationWatermarkSlideOptions.SlideIndex property

Gets or sets the index of slide to add the watermark to.

```csharp
public int SlideIndex { get; set; }
```

##### Property Value

The index of slide to add the watermark to.

##### Remarks

-1 means all slides.

### GroupDocs.Watermark.Options.Spreadsheet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet.md

The namespace provides classes to specify additional options when working with watermarks and Excel documents.

#### Classes

| Class | Description |
| --- | --- |
| SpreadsheetBackgroundWatermarkOptions | Represents options when adding the watermark as a background to a Spreadsheet worksheet. |
| SpreadsheetImageEffects | Represents effects that can be applied to an image watermark for an Excel document. |
| SpreadsheetLoadOptions | Represents document loading options for a Spreadsheet document. |
| SpreadsheetPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document. |
| SpreadsheetSaveOptions | Represents document saving options when saving a Spreadsheet document. |
| SpreadsheetShapeSettings | Represents settings that can be applied to a shape watermark for an Excel document. |
| SpreadsheetTextEffects | Represents effects that can be applied to a text watermark for an Excel document. |
| SpreadsheetWatermarkBaseOptions | Base class for watermark adding options to a Spreadsheet document. |
| SpreadsheetWatermarkHeaderFooterOptions | Represents options when adding the watermark to a Spreadsheet header/footer. |
| SpreadsheetWatermarkModernWordArtOptions | Represents options when adding modern word art watermark to a Spreadsheet worksheet. |
| SpreadsheetWatermarkShapeOptions | Represents options when adding shape watermark to a Spreadsheet worksheet. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ISpreadsheetWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### ISpreadsheetWatermarkEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/ispreadsheetwatermarkeffects.md

#### ISpreadsheetWatermarkEffects interface

Represents interface for watermark effects that should be applied to the watermark.

```csharp
public interface ISpreadsheetWatermarkEffects
```

### SpreadsheetBackgroundWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions.md

#### SpreadsheetBackgroundWatermarkOptions class

Represents options when adding the watermark as a background to a Spreadsheet worksheet.

```csharp
public sealed class SpreadsheetBackgroundWatermarkOptions : WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetBackgroundWatermarkOptions() | Initializes a new instance of the `SpreadsheetBackgroundWatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundHeight { get; set; } | Gets or sets the desired height of the background image in pixels. |
| BackgroundWidth { get; set; } | Get or sets the desired width of the background image in pixels. |
| WorksheetIndex { get; set; } | Get or sets the index of worksheet to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to spreadsheet documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents)

##### Examples

Add text watermark to an Excel document worksheet as background.

```csharp
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.xlsx", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36));

    SpreadsheetBackgroundWatermarkOptions options = new SpreadsheetBackgroundWatermarkOptions();
    options.WorksheetIndex = -1; // default
    options.BackgroundWidth = 800;
    options.BackgroundHeight = 600;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### BackgroundHeight
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/backgroundheight.md

#### SpreadsheetBackgroundWatermarkOptions.BackgroundHeight property

Gets or sets the desired height of the background image in pixels.

```csharp
public int BackgroundHeight { get; set; }
```

##### Property Value

The desired height of the background image in pixels.

### BackgroundWidth
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/backgroundwidth.md

#### SpreadsheetBackgroundWatermarkOptions.BackgroundWidth property

Get or sets the desired width of the background image in pixels.

```csharp
public int BackgroundWidth { get; set; }
```

##### Property Value

The desired width of the background image in pixels.

### SpreadsheetBackgroundWatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/spreadsheetbackgroundwatermarkoptions.md

#### SpreadsheetBackgroundWatermarkOptions constructor

Initializes a new instance of the `SpreadsheetBackgroundWatermarkOptions` class.

```csharp
public SpreadsheetBackgroundWatermarkOptions()
```

### WorksheetIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/worksheetindex.md

#### SpreadsheetBackgroundWatermarkOptions.WorksheetIndex property

Get or sets the index of worksheet to add the watermark to.

```csharp
public int WorksheetIndex { get; set; }
```

##### Property Value

The index of worksheet to add the watermark to.

##### Remarks

-1 means every worksheet.

### SpreadsheetImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects.md

#### SpreadsheetImageEffects class

Represents effects that can be applied to an image watermark for an Excel document.

```csharp
public sealed class SpreadsheetImageEffects : OfficeImageEffects, ISpreadsheetWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetImageEffects() | Initializes a new instance of the `SpreadsheetImageEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| BorderLineFormat { get; set; } | Gets or sets a line format settings for the image border. |
| Brightness { get; set; } | Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). |
| ChromaKey { get; set; } | Gets or sets the color value of the image that will be treated as transparent. |
| Contrast { get; set; } | Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). |
| GrayScale { get; set; } | Gets or sets a value indicating whether a picture will be displayed in grayscale mode. |

### SpreadsheetImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/spreadsheetimageeffects.md

#### SpreadsheetImageEffects constructor

Initializes a new instance of the `SpreadsheetImageEffects` class.

```csharp
public SpreadsheetImageEffects()
```

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

Represents document loading options for a Spreadsheet document.

```csharp
public sealed class SpreadsheetLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetLoadOptions() | Initializes a new instance of the `SpreadsheetLoadOptions` class. |
| SpreadsheetLoadOptions(string) | Initializes a new instance of the `SpreadsheetLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `SpreadsheetLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/default.md

#### SpreadsheetLoadOptions.Default property

Gets the default value for the `SpreadsheetLoadOptions` class.

```csharp
public static SpreadsheetLoadOptions Default { get; }
```

##### Property Value

The default value for the `SpreadsheetLoadOptions` class.

### SpreadsheetLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions()

Initializes a new instance of the `SpreadsheetLoadOptions` class.

```csharp
public SpreadsheetLoadOptions()
```

#### SpreadsheetLoadOptions(string)

Initializes a new instance of the `SpreadsheetLoadOptions` class with a specified password.

```csharp
public SpreadsheetLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted content. |

### SpreadsheetPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions.md

#### SpreadsheetPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document.

```csharp
public class SpreadsheetPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetPreviewOptions(CreatePageStream) | Initializes a new instance of the `SpreadsheetPreviewOptions` class causing the output stream to be closed. |
| SpreadsheetPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `SpreadsheetPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| OnlyDataArea { get; set; } | Gets or sets the flag for rendering the data area only without headers, footers, margins. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/defaultresolution.md

#### SpreadsheetPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const int DefaultResolution;
```

### OnlyDataArea
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/onlydataarea.md

#### SpreadsheetPreviewOptions.OnlyDataArea property

Gets or sets the flag for rendering the data area only without headers, footers, margins.

```csharp
public bool OnlyDataArea { get; set; }
```

##### Property Value

The flag for rendering the data area only without headers, footers, margins.

##### Remarks

This flags leads to rendering the whole worksheet on one page. The default value is `false`.

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/resolution.md

#### SpreadsheetPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public int Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 96.

### SpreadsheetPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/spreadsheetpreviewoptions.md

#### SpreadsheetPreviewOptions(CreatePageStream)

Initializes a new instance of the `SpreadsheetPreviewOptions` class causing the output stream to be closed.

```csharp
public SpreadsheetPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### SpreadsheetPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `SpreadsheetPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public SpreadsheetPreviewOptions(CreatePageStream createPageStream, 
    ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

Represents document saving options when saving a Spreadsheet document.

```csharp
public sealed class SpreadsheetSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetSaveOptions() | Initializes a new instance of the `SpreadsheetSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `SpreadsheetSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions/default.md

#### SpreadsheetSaveOptions.Default property

Gets the default value for the `SpreadsheetSaveOptions` class.

```csharp
public static SpreadsheetSaveOptions Default { get; }
```

##### Property Value

The default value for the `SpreadsheetSaveOptions` class.

### SpreadsheetSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions constructor

Initializes a new instance of the `SpreadsheetSaveOptions` class.

```csharp
public SpreadsheetSaveOptions()
```

### SpreadsheetShapeSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings.md

#### SpreadsheetShapeSettings class

Represents settings that can be applied to a shape watermark for an Excel document.

```csharp
public sealed class SpreadsheetShapeSettings : OfficeShapeSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetShapeSettings() | Initializes a new instance of the `SpreadsheetShapeSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Excel is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/islocked.md

#### SpreadsheetShapeSettings.IsLocked property

Gets or sets a value indicating whether an editing of the shape in Excel is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.

### SpreadsheetShapeSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/spreadsheetshapesettings.md

#### SpreadsheetShapeSettings constructor

Initializes a new instance of the `SpreadsheetShapeSettings` class.

```csharp
public SpreadsheetShapeSettings()
```

### SpreadsheetTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheettexteffects.md

#### SpreadsheetTextEffects class

Represents effects that can be applied to a text watermark for an Excel document.

```csharp
public sealed class SpreadsheetTextEffects : OfficeTextEffects, ISpreadsheetWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetTextEffects() | Initializes a new instance of the `SpreadsheetTextEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| LineFormat { get; set; } | Gets or sets the line format settings. |

### SpreadsheetTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheettexteffects/spreadsheettexteffects.md

#### SpreadsheetTextEffects constructor

Initializes a new instance of the `SpreadsheetTextEffects` class.

```csharp
public SpreadsheetTextEffects()
```

### SpreadsheetWatermarkBaseOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions.md

#### SpreadsheetWatermarkBaseOptions class

Base class for watermark adding options to a Spreadsheet document.

```csharp
public abstract class SpreadsheetWatermarkBaseOptions : WatermarkOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Excel is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/alternativetext.md

#### SpreadsheetWatermarkBaseOptions.AlternativeText property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text that will be associated with a shape.

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/islocked.md

#### SpreadsheetWatermarkBaseOptions.IsLocked property

Gets or sets a value indicating whether an editing of the shape in Excel is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Excel.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/name.md

#### SpreadsheetWatermarkBaseOptions.Name property

Gets or sets the name a shape.

```csharp
public string Name { get; set; }
```

##### Property Value

The shape name.

### SpreadsheetWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions.md

#### SpreadsheetWatermarkHeaderFooterOptions class

Represents options when adding the watermark to a Spreadsheet header/footer.

```csharp
public sealed class SpreadsheetWatermarkHeaderFooterOptions : WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetWatermarkHeaderFooterOptions() | Initializes a new instance of the `SpreadsheetWatermarkHeaderFooterOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| WorksheetIndex { get; set; } | Gets or sets the index of worksheet to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to spreadsheet documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents)

##### Examples

Add text watermark into Excel worksheet header.

```csharp
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.xls", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test", new Font("Arial", 14));

    SpreadsheetWatermarkHeaderFooterOptions options = new SpreadsheetWatermarkHeaderFooterOptions();
    options.WorksheetIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### SpreadsheetWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions/spreadsheetwatermarkheaderfooteroptions.md

#### SpreadsheetWatermarkHeaderFooterOptions constructor

Initializes a new instance of the `SpreadsheetWatermarkHeaderFooterOptions` class.

```csharp
public SpreadsheetWatermarkHeaderFooterOptions()
```

### WorksheetIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions/worksheetindex.md

#### SpreadsheetWatermarkHeaderFooterOptions.WorksheetIndex property

Gets or sets the index of worksheet to add the watermark to.

```csharp
public int WorksheetIndex { get; set; }
```

##### Property Value

The index of worksheet to add the watermark to.

##### Remarks

-1 means every worksheet.

### SpreadsheetWatermarkModernWordArtOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions.md

#### SpreadsheetWatermarkModernWordArtOptions class

Represents options when adding modern word art watermark to a Spreadsheet worksheet.

```csharp
public sealed class SpreadsheetWatermarkModernWordArtOptions : SpreadsheetWatermarkBaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetWatermarkModernWordArtOptions() | Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Excel is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| WorksheetIndex { get; set; } | Gets or sets the index of worksheet to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to spreadsheet documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents)

##### Examples

Add modern WordArt watermark to an Excel document.

```csharp
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.xls", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36));

    SpreadsheetWatermarkModernWordArtOptions options = new SpreadsheetWatermarkModernWordArtOptions();
    options.WorksheetIndex = -1; // default
    options.IsLocked = false; // default

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### SpreadsheetWatermarkModernWordArtOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/spreadsheetwatermarkmodernwordartoptions.md

#### SpreadsheetWatermarkModernWordArtOptions constructor

Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class.

```csharp
public SpreadsheetWatermarkModernWordArtOptions()
```

### WorksheetIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/worksheetindex.md

#### SpreadsheetWatermarkModernWordArtOptions.WorksheetIndex property

Gets or sets the index of worksheet to add the watermark to.

```csharp
public int WorksheetIndex { get; set; }
```

##### Property Value

The index of worksheet to add the watermark to.

##### Remarks

-1 means every worksheet.

### SpreadsheetWatermarkShapeOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions.md

#### SpreadsheetWatermarkShapeOptions class

Represents options when adding shape watermark to a Spreadsheet worksheet.

```csharp
public sealed class SpreadsheetWatermarkShapeOptions : SpreadsheetWatermarkBaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SpreadsheetWatermarkShapeOptions() | Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Excel is forbidden. |
| Name { get; set; } | Gets or sets the name a shape. |
| WorksheetIndex { get; set; } | Gets or sets the index of worksheet to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to spreadsheet documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents)

##### Examples

Add watermark to a particular worksheet of an Excel document.

```csharp
SpreadsheetLoadOptions loadOptions = new SpreadsheetLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.xls", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36, FontStyle.Bold | FontStyle.Italic));
    watermark.HorizontalAlignment = HorizontalAlignment.Center;
    watermark.VerticalAlignment = VerticalAlignment.Center;

    SpreadsheetWatermarkShapeOptions options = new SpreadsheetWatermarkShapeOptions();
    options.WorksheetIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### Effects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/effects.md

#### SpreadsheetWatermarkShapeOptions.Effects property

Gets or sets a value of `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark.

```csharp
public ISpreadsheetWatermarkEffects Effects { get; set; }
```

##### Property Value

The `SpreadsheetImageEffects` or `SpreadsheetTextEffects` for effects that should be applied to the watermark.

### SpreadsheetWatermarkShapeOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/spreadsheetwatermarkshapeoptions.md

#### SpreadsheetWatermarkShapeOptions constructor

Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class.

```csharp
public SpreadsheetWatermarkShapeOptions()
```

### WorksheetIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/worksheetindex.md

#### SpreadsheetWatermarkShapeOptions.WorksheetIndex property

Gets or sets the index of worksheet to add the watermark to.

```csharp
public int WorksheetIndex { get; set; }
```

##### Property Value

The index of worksheet to add the watermark to.

##### Remarks

-1 means every worksheet.

### GroupDocs.Watermark.Options.WordProcessing
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing.md

The namespace provides classes to specify additional options when working with watermarks and Word documents.

#### Classes

| Class | Description |
| --- | --- |
| WordProcessingImageEffects | Represents effects that can be applied to an image watermark for a Word document. |
| WordProcessingLoadOptions | Represents document loading options for a Word document. |
| WordProcessingPreviewOptions | Provides options to sets requirements and stream delegates for preview generation of WordProcessing document. |
| WordProcessingSaveOptions | Represents document saving options when saving a Word document. |
| WordProcessingTextEffects | Represents effects that can be applied to a text watermark for a Word document. |
| WordProcessingWatermarkBaseOptions | Base class for watermark adding options to a Word document. |
| WordProcessingWatermarkHeaderFooterOptions | Represents options when adding the watermark to a Word section header/footer. |
| WordProcessingWatermarkPagesOptions | Represents options when adding watermark to Word document pages. |
| WordProcessingWatermarkSectionOptions | Represents options when adding shape watermark to a Word document section. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IWordProcessingWatermarkEffects | Represents interface for watermark effects that should be applied to the watermark. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| WordProcessingFlipOrientation | Possible values for the orientation of a shape. |
| WordProcessingLockType | Specifies watermark lock type in Word document. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### IWordProcessingWatermarkEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/iwordprocessingwatermarkeffects.md

#### IWordProcessingWatermarkEffects interface

Represents interface for watermark effects that should be applied to the watermark.

```csharp
public interface IWordProcessingWatermarkEffects
```

### WordProcessingFlipOrientation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingfliporientation.md

#### WordProcessingFlipOrientation enumeration

Possible values for the orientation of a shape.

```csharp
[Flags]
public enum WordProcessingFlipOrientation
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Coordinates are not flipped. |
| Horizontal | `1` | Flip along the y-axis, reversing the x-coordinates. |
| Vertical | `2` | Flip along the x-axis, reversing the y-coordinates. |
| Both | `3` | Flip along both the y- and x-axis. |

### WordProcessingImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects.md

#### WordProcessingImageEffects class

Represents effects that can be applied to an image watermark for a Word document.

```csharp
public sealed class WordProcessingImageEffects : OfficeImageEffects, IWordProcessingWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingImageEffects() | Initializes a new instance of the `WordProcessingImageEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| BorderLineFormat { get; set; } | Gets or sets a line format settings for the image border. |
| Brightness { get; set; } | Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). |
| ChromaKey { get; set; } | Gets or sets the color value of the image that will be treated as transparent. |
| Contrast { get; set; } | Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). |
| GrayScale { get; set; } | Gets or sets a value indicating whether a picture will be displayed in grayscale mode. |

### WordProcessingImageEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/wordprocessingimageeffects.md

#### WordProcessingImageEffects constructor

Initializes a new instance of the `WordProcessingImageEffects` class.

```csharp
public WordProcessingImageEffects()
```

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

Represents document loading options for a Word document.

```csharp
public sealed class WordProcessingLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingLoadOptions() | Initializes a new instance of the `WordProcessingLoadOptions` class. |
| WordProcessingLoadOptions(string) | Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `WordProcessingLoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/default.md

#### WordProcessingLoadOptions.Default property

Gets the default value for the `WordProcessingLoadOptions` class.

```csharp
public static WordProcessingLoadOptions Default { get; }
```

##### Property Value

The default value for the `WordProcessingLoadOptions` class.

### WordProcessingLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/wordprocessingloadoptions.md

#### WordProcessingLoadOptions()

Initializes a new instance of the `WordProcessingLoadOptions` class.

```csharp
public WordProcessingLoadOptions()
```

#### WordProcessingLoadOptions(string)

Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password.

```csharp
public WordProcessingLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted content. |

### WordProcessingLockType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessinglocktype.md

#### WordProcessingLockType enumeration

Specifies watermark lock type in Word document.

```csharp
public enum WordProcessingLockType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| AllowOnlyRevisions | `0` | User can only add revision marks to the document. |
| AllowOnlyComments | `1` | User can only modify comments in the document. |
| AllowOnlyFormFields | `2` | User can only enter data in the form fields in the document. |
| ReadOnly | `3` | The entire document is read-only. |
| ReadOnlyWithEditableContent | `4` | The document is read-only, but all the content except of the watermark is marked as editable. |
| NoLock | `-1` | Disable any lock on watermark and document. |

### WordProcessingPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions.md

#### WordProcessingPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of WordProcessing document.

```csharp
public class WordProcessingPreviewOptions : PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingPreviewOptions(CreatePageStream) | Initializes a new instance of the `WordProcessingPreviewOptions` class causing the output stream to be closed. |
| WordProcessingPreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Resolution { get; set; } | Gets or sets the resolution for the generated images, in dots per inch. |
| Width { get; set; } | Gets or sets the page preview width. |

#### Fields

| Name | Description |
| --- | --- |
| const DefaultResolution | Default resolution in dots per inch. |

### DefaultResolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/defaultresolution.md

#### WordProcessingPreviewOptions.DefaultResolution field

Default resolution in dots per inch.

```csharp
public const float DefaultResolution;
```

### Resolution
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/resolution.md

#### WordProcessingPreviewOptions.Resolution property

Gets or sets the resolution for the generated images, in dots per inch.

```csharp
public float Resolution { get; set; }
```

##### Property Value

The resolution for the generated images, in dots per inch.

##### Remarks

The default value is 96.

### WordProcessingPreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/wordprocessingpreviewoptions.md

#### WordProcessingPreviewOptions(CreatePageStream)

Initializes a new instance of the `WordProcessingPreviewOptions` class causing the output stream to be closed.

```csharp
public WordProcessingPreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### WordProcessingPreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public WordProcessingPreviewOptions(CreatePageStream createPageStream, 
    ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Represents document saving options when saving a Word document.

```csharp
public sealed class WordProcessingSaveOptions : SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingSaveOptions() | Initializes a new instance of the `WordProcessingSaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `WordProcessingSaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions/default.md

#### WordProcessingSaveOptions.Default property

Gets the default value for the `WordProcessingSaveOptions` class.

```csharp
public static WordProcessingSaveOptions Default { get; }
```

##### Property Value

The default value for the `WordProcessingSaveOptions` class.

### WordProcessingSaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions constructor

Initializes a new instance of the `WordProcessingSaveOptions` class.

```csharp
public WordProcessingSaveOptions()
```

### WordProcessingTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects.md

#### WordProcessingTextEffects class

Represents effects that can be applied to a text watermark for a Word document.

```csharp
public sealed class WordProcessingTextEffects : OfficeTextEffects, IWordProcessingWatermarkEffects
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingTextEffects() | Initializes a new instance of the `WordProcessingTextEffects` class. |

#### Properties

| Name | Description |
| --- | --- |
| FlipOrientation { get; set; } | Gets or sets the orientation of a shape. |
| LineFormat { get; set; } | Gets or sets the line format settings. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Default | Gets the default value for the `WordProcessingTextEffects` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/default.md

#### WordProcessingTextEffects.Default field

Gets the default value for the `WordProcessingTextEffects` class.

```csharp
public static readonly WordProcessingTextEffects Default;
```

##### Property Value

The default value for the `WordProcessingTextEffects` class.

### FlipOrientation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/fliporientation.md

#### WordProcessingTextEffects.FlipOrientation property

Gets or sets the orientation of a shape.

```csharp
public WordProcessingFlipOrientation FlipOrientation { get; set; }
```

##### Property Value

The orientation of a shape.

##### Remarks

The default value is None.

### WordProcessingTextEffects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/wordprocessingtexteffects.md

#### WordProcessingTextEffects constructor

Initializes a new instance of the `WordProcessingTextEffects` class.

```csharp
public WordProcessingTextEffects()
```

### WordProcessingWatermarkBaseOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions.md

#### WordProcessingWatermarkBaseOptions class

Base class for watermark adding options to a Word document.

```csharp
public abstract class WordProcessingWatermarkBaseOptions : WatermarkOptions
```

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| LockType { get; set; } | Gets or sets the watermark lock type. |
| Name { get; set; } | Gets or sets the name a shape. |
| Password { get; set; } | Gets or sets a password used to lock the watermark. |

### AlternativeText
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/alternativetext.md

#### WordProcessingWatermarkBaseOptions.AlternativeText property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

```csharp
public string AlternativeText { get; set; }
```

##### Property Value

The descriptive (alternative) text that will be associated with a shape.

### Effects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/effects.md

#### WordProcessingWatermarkBaseOptions.Effects property

Gets or sets a value of `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark.

```csharp
public IWordProcessingWatermarkEffects Effects { get; set; }
```

##### Property Value

The `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark.

### IsLocked
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/islocked.md

#### WordProcessingWatermarkBaseOptions.IsLocked property

Gets or sets a value indicating whether an editing of the shape in Word is forbidden.

```csharp
public bool IsLocked { get; set; }
```

##### Property Value

If the value is `true`, shape editing will be forbidden. By default, the value is `false`, the shape can be edited in Word.

### LockType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/locktype.md

#### WordProcessingWatermarkBaseOptions.LockType property

Gets or sets the watermark lock type.

```csharp
public WordProcessingLockType LockType { get; set; }
```

##### Property Value

The watermark lock type.

##### Remarks

The value AllowOnlyFormFields can not be used with an object of type `WordProcessingHeaderFooter`.

### Name
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/name.md

#### WordProcessingWatermarkBaseOptions.Name property

Gets or sets the name a shape.

```csharp
public string Name { get; set; }
```

##### Property Value

The shape name.

### Password
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/password.md

#### WordProcessingWatermarkBaseOptions.Password property

Gets or sets a password used to lock the watermark.

```csharp
public string Password { get; set; }
```

##### Property Value

A password used to lock the watermark.

### WordProcessingWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions.md

#### WordProcessingWatermarkHeaderFooterOptions class

Represents options when adding the watermark to a Word section header/footer.

```csharp
public sealed class WordProcessingWatermarkHeaderFooterOptions : WordProcessingWatermarkBaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingWatermarkHeaderFooterOptions() | Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark. |
| HeaderFooterType { get; set; } | Gets or sets the value that identifies the type of header or footer to add the watermark to. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| LockType { get; set; } | Gets or sets the watermark lock type. |
| Name { get; set; } | Gets or sets the name a shape. |
| Password { get; set; } | Gets or sets a password used to lock the watermark. |
| SectionIndex { get; set; } | Gets or sets the index of a section to add the watermark to. |

### HeaderFooterType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/headerfootertype.md

#### WordProcessingWatermarkHeaderFooterOptions.HeaderFooterType property

Gets or sets the value that identifies the type of header or footer to add the watermark to.

```csharp
public OfficeHeaderFooterType HeaderFooterType { get; set; }
```

##### Property Value

The value that identifies the type of header or footer to add the watermark to.

### SectionIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/sectionindex.md

#### WordProcessingWatermarkHeaderFooterOptions.SectionIndex property

Gets or sets the index of a section to add the watermark to.

```csharp
public int SectionIndex { get; set; }
```

##### Property Value

The index of a section to add the watermark to.

##### Remarks

-1 means all sections.

### WordProcessingWatermarkHeaderFooterOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/wordprocessingwatermarkheaderfooteroptions.md

#### WordProcessingWatermarkHeaderFooterOptions constructor

Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class.

```csharp
public WordProcessingWatermarkHeaderFooterOptions()
```

### WordProcessingWatermarkPagesOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions.md

#### WordProcessingWatermarkPagesOptions class

Represents options when adding watermark to Word document pages.

```csharp
public sealed class WordProcessingWatermarkPagesOptions : WordProcessingWatermarkBaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingWatermarkPagesOptions() | Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| LockType { get; set; } | Gets or sets the watermark lock type. |
| Name { get; set; } | Gets or sets the name a shape. |
| PageNumbers { get; set; } | Gets or sets the page numbers to add the watermark. |
| Password { get; set; } | Gets or sets a password used to lock the watermark. |

##### Remarks

**Learn more:**

* [Add watermarks to word processing documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+word+processing+documents)

##### Examples

Add watermark to a particular page of a Word document.

```csharp
WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.doc", loadOptions))
{
    TextWatermark watermark = new TextWatermark("text", new Font("Arial", 42));

    WordProcessingWatermarkPagesOptions options = new WordProcessingWatermarkPagesOptions();
    options.PageNumbers = new[] { 1 };

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### PageNumbers
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/pagenumbers.md

#### WordProcessingWatermarkPagesOptions.PageNumbers property

Gets or sets the page numbers to add the watermark.

```csharp
public int[] PageNumbers { get; set; }
```

##### Property Value

The page numbers to add the watermark.

##### Remarks

All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a document. If this value is `null` or empty, the watermark is added to all pages.

### WordProcessingWatermarkPagesOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/wordprocessingwatermarkpagesoptions.md

#### WordProcessingWatermarkPagesOptions constructor

Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class.

```csharp
public WordProcessingWatermarkPagesOptions()
```

### WordProcessingWatermarkSectionOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions.md

#### WordProcessingWatermarkSectionOptions class

Represents options when adding shape watermark to a Word document section.

```csharp
public sealed class WordProcessingWatermarkSectionOptions : WordProcessingWatermarkBaseOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WordProcessingWatermarkSectionOptions() | Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| AlternativeText { get; set; } | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| Effects { get; set; } | Gets or sets a value of `WordProcessingImageEffects` or `WordProcessingTextEffects` for effects that should be applied to the watermark. |
| IsLocked { get; set; } | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| LockType { get; set; } | Gets or sets the watermark lock type. |
| Name { get; set; } | Gets or sets the name a shape. |
| Password { get; set; } | Gets or sets a password used to lock the watermark. |
| SectionIndex { get; set; } | Gets or sets the index of a section to add the watermark to. |

##### Remarks

**Learn more:**

* [Add watermarks to word processing documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+word+processing+documents)

##### Examples

Add watermark to a particular section of a Word document.

```csharp
WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.doc", loadOptions))
{
    TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 36, FontStyle.Bold | FontStyle.Italic));
    watermark.HorizontalAlignment = HorizontalAlignment.Center;
    watermark.VerticalAlignment = VerticalAlignment.Center;
    watermark.ForegroundColor = Color.Red;

    WordProcessingWatermarkSectionOptions options = new WordProcessingWatermarkSectionOptions();
    options.SectionIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### SectionIndex
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/sectionindex.md

#### WordProcessingWatermarkSectionOptions.SectionIndex property

Gets or sets the index of a section to add the watermark to.

```csharp
public int SectionIndex { get; set; }
```

##### Property Value

The index of a section to add the watermark to.

##### Remarks

-1 means all sections.

### WordProcessingWatermarkSectionOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/wordprocessingwatermarksectionoptions.md

#### WordProcessingWatermarkSectionOptions constructor

Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class.

```csharp
public WordProcessingWatermarkSectionOptions()
```

### GroupDocs.Watermark.Options
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options.md

The namespace provides classes to specify additional options when working with documents and watermarks.

#### Classes

| Class | Description |
| --- | --- |
| CreatePageStream | Represents a method that returns a stream to write page preview data. |
| LoadOptions | Represents document loading options when loading a document. |
| OoxmlLoadOptions | Represents document loading options for a OOXML document. |
| PreviewOptions | Provides options to sets requirements and stream delegates for preview generation. |
| ReleasePageStream | Represents a method which releases the stream created by the `CreatePageStream` delegate. |
| SaveOptions | Represents document saving options when saving a document. |
| WatermarkOptions | Represents watermark adding options when adding watermark to a document. |
#### Interfaces

| Interface | Description |
| --- | --- |
| ILogger | Defines the interface of a logger that is used for logging events and errors during watermarking. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| PreviewOptions.PreviewFormats | Represents supported preview formats. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### CreatePageStream
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/createpagestream.md

#### CreatePageStream delegate

Represents a method that returns a stream to write page preview data.

```csharp
public delegate Stream CreatePageStream(int pageNumber);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a page to generate a thumbnail. |

##### Return Value

The stream to write the page preview.

### ILogger
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ilogger.md

#### ILogger interface

Defines the interface of a logger that is used for logging events and errors during watermarking.

```csharp
public interface ILogger
```

#### Methods

| Name | Description |
| --- | --- |
| Error(string, Exception) | Logs an error that occurred during watermarking. |
| Trace(string) | Logs an event occurred during watermarking. |
| Warning(string) | Logs a warning that occurred during watermarking. |

### Error
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ilogger/error.md

#### ILogger.Error method

Logs an error that occurred during watermarking.

```csharp
public void Error(string message, Exception exception)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The error message. |
| exception | Exception | The instance of occured exception. |

### Trace
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ilogger/trace.md

#### ILogger.Trace method

Logs an event occurred during watermarking.

```csharp
public void Trace(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The event message. |

### Warning
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ilogger/warning.md

#### ILogger.Warning method

Logs a warning that occurred during watermarking.

```csharp
public void Warning(string message)
```

| Parameter | Type | Description |
| --- | --- | --- |
| message | String | The warning message. |

### LoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions.md

#### LoadOptions class

Represents document loading options when loading a document.

```csharp
public class LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| LoadOptions() | Initializes a new instance of the `LoadOptions` class. |
| LoadOptions(string) | Initializes a new instance of the `LoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for `LoadOptions` class. |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

##### Remarks

**Learn more:**

* [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents)
* [Load from local disk](https://docs.groupdocs.com/display/watermarknet/Load+from+local+disk)
* [Load from stream](https://docs.groupdocs.com/display/watermarknet/Load+from+stream)
* [Load document of specific format](https://docs.groupdocs.com/display/watermarknet/Load+document+of+specific+format)
* [Load password-protected document](https://docs.groupdocs.com/display/watermarknet/Load+password-protected+document)

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions/default.md

#### LoadOptions.Default property

Gets the default value for `LoadOptions` class.

```csharp
public static LoadOptions Default { get; }
```

##### Property Value

The default value for `LoadOptions` class.

### FileType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions/filetype.md

#### LoadOptions.FileType property

Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.).

```csharp
public FileType FileType { get; set; }
```

### FormatFamily
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions/formatfamily.md

#### LoadOptions.FormatFamily property

Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

```csharp
public FormatFamily? FormatFamily { get; set; }
```

### LoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions/loadoptions.md

#### LoadOptions()

Initializes a new instance of the `LoadOptions` class.

```csharp
public LoadOptions()
```

#### LoadOptions(string)

Initializes a new instance of the `LoadOptions` class with a specified password.

```csharp
public LoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted content. |

### Password
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/loadoptions/password.md

#### LoadOptions.Password property

Gets or sets the password for opening an encrypted document.

```csharp
public string Password { get; set; }
```

##### Property Value

The password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null. If the content is not encrypted, set this to null or empty string.

##### Examples

Load a content protected with a password.

```csharp
LoadOptions loadOptions = new LoadOptions
{
    Password = "pwd123"
};
using (Watermarker watermarker = new Watermarker(@"D:\doc.vsdx", loadOptions))
{
    // ...
}
```

### OoxmlLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ooxmlloadoptions.md

#### OoxmlLoadOptions class

Represents document loading options for a OOXML document.

```csharp
public class OoxmlLoadOptions : LoadOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| OoxmlLoadOptions() | Initializes a new instance of the `OoxmlLoadOptions` class. |
| OoxmlLoadOptions(string) | Initializes a new instance of the `OoxmlLoadOptions` class with a specified password. |

#### Properties

| Name | Description |
| --- | --- |
| FileType { get; set; } | Gets or sets the type of the file, indicating its type (e.g., docx, pdf, xlsx, etc.). |
| FormatFamily { get; set; } | Gets or sets the format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| Password { get; set; } | Gets or sets the password for opening an encrypted document. |

#### Fields

| Name | Description |
| --- | --- |
| static readonly Default | Gets the default value for the `OoxmlLoadOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ooxmlloadoptions/default.md

#### OoxmlLoadOptions.Default field

Gets the default value for the `OoxmlLoadOptions` class.

```csharp
public static readonly OoxmlLoadOptions Default;
```

##### Property Value

The default value for the `OoxmlLoadOptions` class.

### OoxmlLoadOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/ooxmlloadoptions/ooxmlloadoptions.md

#### OoxmlLoadOptions()

Initializes a new instance of the `OoxmlLoadOptions` class.

```csharp
public OoxmlLoadOptions()
```

#### OoxmlLoadOptions(string)

Initializes a new instance of the `OoxmlLoadOptions` class with a specified password.

```csharp
public OoxmlLoadOptions(string password)
```

| Parameter | Type | Description |
| --- | --- | --- |
| password | String | The password for opening an encrypted content. |

### PreviewOptions.PreviewFormats
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions.previewformats.md

#### PreviewOptions.PreviewFormats enumeration

Represents supported preview formats.

```csharp
public enum PreviewFormats
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| PNG | `0` |  |
| JPEG | `1` |  |
| BMP | `2` |  |

### PreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions.md

#### PreviewOptions class

Provides options to sets requirements and stream delegates for preview generation.

```csharp
public class PreviewOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| PreviewOptions(CreatePageStream) | Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed. |
| PreviewOptions(CreatePageStream, ReleasePageStream) | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |

#### Properties

| Name | Description |
| --- | --- |
| CreatePageStream { get; set; } | Gets or sets an instance of the page stream creation delegate. |
| Height { get; set; } | Gets or sets the page preview height. |
| PageNumbers { get; set; } | Gets or sets an array of page numbers to generate previews. |
| PreviewFormat { get; set; } | Gets or sets the preview image format. |
| ReleasePageStream { get; set; } | Gets or sets an instance of the page preview completion delegate. |
| Width { get; set; } | Gets or sets the page preview width. |

### CreatePageStream
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/createpagestream.md

#### PreviewOptions.CreatePageStream property

Gets or sets an instance of the page stream creation delegate.

```csharp
public CreatePageStream CreatePageStream { get; set; }
```

##### Property Value

The page stream creation delegate.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/height.md

#### PreviewOptions.Height property

Gets or sets the page preview height.

```csharp
public int Height { get; set; }
```

##### Property Value

The page preview height.

### PageNumbers
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/pagenumbers.md

#### PreviewOptions.PageNumbers property

Gets or sets an array of page numbers to generate previews.

```csharp
public int[] PageNumbers { get; set; }
```

##### Property Value

The array of page numbers to generate previews.

### PreviewFormat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/previewformat.md

#### PreviewOptions.PreviewFormat property

Gets or sets the preview image format.

```csharp
public PreviewFormats PreviewFormat { get; set; }
```

##### Property Value

The preview image format.

### PreviewOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/previewoptions.md

#### PreviewOptions(CreatePageStream)

Initializes a new instance of the `PreviewOptions` class causing the output stream to be closed.

```csharp
public PreviewOptions(CreatePageStream createPageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |

#### PreviewOptions(CreatePageStream, ReleasePageStream)

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

```csharp
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| createPageStream | CreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | ReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |

### ReleasePageStream
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/releasepagestream.md

#### PreviewOptions.ReleasePageStream property

Gets or sets an instance of the page preview completion delegate.

```csharp
public ReleasePageStream ReleasePageStream { get; set; }
```

##### Property Value

The page preview completion delegate.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/previewoptions/width.md

#### PreviewOptions.Width property

Gets or sets the page preview width.

```csharp
public int Width { get; set; }
```

##### Property Value

The page preview width.

### ReleasePageStream
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/releasepagestream.md

#### ReleasePageStream delegate

Represents a method which releases the stream created by the `CreatePageStream` delegate.

```csharp
public delegate void ReleasePageStream(int pageNumber, Stream pageStream);
```

| Parameter | Type | Description |
| --- | --- | --- |
| pageNumber | Int32 | The page number of a generated page preview. |
| pageStream | Stream | The stream containing the generated page preview. |

### SaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/saveoptions.md

#### SaveOptions class

Represents document saving options when saving a document.

```csharp
public class SaveOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| SaveOptions() | Initializes a new instance of the `SaveOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `SaveOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/saveoptions/default.md

#### SaveOptions.Default property

Gets the default value for the `SaveOptions` class.

```csharp
public static SaveOptions Default { get; }
```

##### Property Value

The default value for the `SaveOptions` class.

### SaveOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/saveoptions/saveoptions.md

#### SaveOptions constructor

Initializes a new instance of the `SaveOptions` class.

```csharp
public SaveOptions()
```

### WatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/watermarkoptions.md

#### WatermarkOptions class

Represents watermark adding options when adding watermark to a document.

```csharp
public class WatermarkOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkOptions() | Initializes a new instance of the `WatermarkOptions` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `WatermarkOptions` class. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/watermarkoptions/default.md

#### WatermarkOptions.Default property

Gets the default value for the `WatermarkOptions` class.

```csharp
public static WatermarkOptions Default { get; }
```

##### Property Value

The default value for the `WatermarkOptions` class.

### WatermarkOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.options/watermarkoptions/watermarkoptions.md

#### WatermarkOptions constructor

Initializes a new instance of the `WatermarkOptions` class.

```csharp
public WatermarkOptions()
```

### GroupDocs.Watermark.Search.Objects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects.md

The namespace provides classes for document objects that are to be included in a watermark search.

#### Classes

| Class | Description |
| --- | --- |
| SearchableObjects | Specifies document objects that are to be included in a watermark search. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| DiagramSearchableObjects | Specifies flags representing Visio document objects that are to be included in a watermark search. |
| EmailSearchableObjects | Specifies flags representing email message objects that are to be included in a watermark search. |
| PdfSearchableObjects | Specifies flags representing pdf content objects that are to be included in a watermark search. |
| PresentationSearchableObjects | Specifies flags representing PowerPoint content objects that are to be included in a watermark search. |
| SpreadsheetSearchableObjects | Specifies flags representing Excel content objects that are to be included in a watermark search. |
| WordProcessingSearchableObjects | Specifies flags representing Word content objects that are to be included in a watermark search. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### DiagramSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/diagramsearchableobjects.md

#### DiagramSearchableObjects enumeration

Specifies flags representing Visio document objects that are to be included in a watermark search.

```csharp
[Flags]
public enum DiagramSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| Shapes | `1` | Search in shapes. |
| Comments | `2` | Search in comments. |
| HeadersFooters | `4` | Search in headers and footers. |
| Hyperlinks | `8` | Search in hyperlinks. |
| All | `F` | Search in all content objects. |

### EmailSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/emailsearchableobjects.md

#### EmailSearchableObjects enumeration

Specifies flags representing email message objects that are to be included in a watermark search.

```csharp
[Flags]
public enum EmailSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| Subject | `1` | Search in message subject. |
| PlainTextBody | `2` | Search in message plain text body. |
| HtmlBody | `4` | Search in message html body. |
| AttachedImages | `8` | Search in attached images. |
| EmbeddedImages | `10` | Search in embedded images. |
| All | `1F` | Search in all email objects. |

### PdfSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/pdfsearchableobjects.md

#### PdfSearchableObjects enumeration

Specifies flags representing pdf content objects that are to be included in a watermark search.

```csharp
[Flags]
public enum PdfSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| XObjects | `1` | Search in XObjects. |
| Artifacts | `2` | Search in artifacts. |
| Annotations | `4` | Search in annotations. |
| Text | `8` | Search in content text. |
| Hyperlinks | `10` | Search in hyperlinks. |
| AttachedImages | `20` | Search in attached images. |
| Vector | `40` | Search in operators. |
| All | `7F` | Search in all content objects. |

### PresentationSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/presentationsearchableobjects.md

#### PresentationSearchableObjects enumeration

Specifies flags representing PowerPoint content objects that are to be included in a watermark search.

```csharp
[Flags]
public enum PresentationSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| Shapes | `1` | Search in shapes. |
| ChartsBackgrounds | `2` | Search in charts backgrounds. |
| SlidesBackgrounds | `4` | Search in slides backgrounds. |
| Hyperlinks | `8` | Search in hyperlinks. |
| All | `F` | Search in all content objects. |

### SearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects.md

#### SearchableObjects class

Specifies document objects that are to be included in a watermark search.

```csharp
public class SearchableObjects
```

#### Constructors

| Name | Description |
| --- | --- |
| SearchableObjects() | Initializes a new instance of the `SearchableObjects` class. |

#### Properties

| Name | Description |
| --- | --- |
| DiagramSearchableObjects { get; set; } | Gets or sets the objects inside a Visio document that are to be included in a watermark search. |
| EmailSearchableObjects { get; set; } | Gets or sets the objects inside an email message that are to be included in a watermark search. |
| PdfSearchableObjects { get; set; } | Gets or sets the objects inside a PDF document that are to be included in a watermark search. |
| PresentationSearchableObjects { get; set; } | Gets or sets the objects inside a PowerPoint document that are to be included in a watermark search. |
| SpreadsheetSearchableObjects { get; set; } | Gets or sets the objects inside an Excel document that are to be included in a watermark search. |
| WordProcessingSearchableObjects { get; set; } | Gets or sets the objects inside a Word document that are to be included in a watermark search. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

### DiagramSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/diagramsearchableobjects.md

#### SearchableObjects.DiagramSearchableObjects property

Gets or sets the objects inside a Visio document that are to be included in a watermark search.

```csharp
public DiagramSearchableObjects DiagramSearchableObjects { get; set; }
```

##### Property Value

The objects inside a Visio document that are to be included in a watermark search.

### EmailSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/emailsearchableobjects.md

#### SearchableObjects.EmailSearchableObjects property

Gets or sets the objects inside an email message that are to be included in a watermark search.

```csharp
public EmailSearchableObjects EmailSearchableObjects { get; set; }
```

##### Property Value

The objects inside an email message that are to be included in a watermark search.

### PdfSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/pdfsearchableobjects.md

#### SearchableObjects.PdfSearchableObjects property

Gets or sets the objects inside a PDF document that are to be included in a watermark search.

```csharp
public PdfSearchableObjects PdfSearchableObjects { get; set; }
```

##### Property Value

The objects inside a PDF document that are to be included in a watermark search.

### PresentationSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/presentationsearchableobjects.md

#### SearchableObjects.PresentationSearchableObjects property

Gets or sets the objects inside a PowerPoint document that are to be included in a watermark search.

```csharp
public PresentationSearchableObjects PresentationSearchableObjects { get; set; }
```

##### Property Value

The objects inside a PowerPoint document that are to be included in a watermark search.

### SearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/searchableobjects.md

#### SearchableObjects constructor

Initializes a new instance of the `SearchableObjects` class.

```csharp
public SearchableObjects()
```

### SpreadsheetSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/spreadsheetsearchableobjects.md

#### SearchableObjects.SpreadsheetSearchableObjects property

Gets or sets the objects inside an Excel document that are to be included in a watermark search.

```csharp
public SpreadsheetSearchableObjects SpreadsheetSearchableObjects { get; set; }
```

##### Property Value

The objects inside an Excel document that are to be included in a watermark search.

### WordProcessingSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/searchableobjects/wordprocessingsearchableobjects.md

#### SearchableObjects.WordProcessingSearchableObjects property

Gets or sets the objects inside a Word document that are to be included in a watermark search.

```csharp
public WordProcessingSearchableObjects WordProcessingSearchableObjects { get; set; }
```

##### Property Value

The objects inside a Word document that are to be included in a watermark search.

### SpreadsheetSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects.md

#### SpreadsheetSearchableObjects enumeration

Specifies flags representing Excel content objects that are to be included in a watermark search.

```csharp
[Flags]
public enum SpreadsheetSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| Shapes | `1` | Search in shapes. |
| ChartsBackgrounds | `2` | Search in charts backgrounds. |
| HeadersFooters | `4` | Search in headers and footers. |
| WorksheetBackgrounds | `8` | Search in worksheets backgrounds. |
| Cells | `10` | Search in cells. |
| Hyperlinks | `20` | Search in hyperlinks. |
| AttachedImages | `40` | Search in attached images. |
| All | `7F` | Search in all content objects. |

### WordProcessingSearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects.md

#### WordProcessingSearchableObjects enumeration

Specifies flags representing Word content objects that are to be included in a watermark search.

```csharp
[Flags]
public enum WordProcessingSearchableObjects
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| None | `0` | Specifies no search objects. |
| Shapes | `1` | Search in shapes. |
| Text | `2` | Search in content text. |
| Hyperlinks | `4` | Search in hyperlinks. |
| All | `7` | Search in all content objects. |

### GroupDocs.Watermark.Search.SearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria.md

The namespace provides classes that can be used to construct criteria when searching for watermarks.

#### Classes

| Class | Description |
| --- | --- |
| AndSearchCriteria | Represents AND composite search criteria. |
| ColorRange | Represents a range of colors. Specifies ranges using HSB representation of RGB color. |
| ImageColorHistogramSearchCriteria | Represents search criteria for finding images in a content. |
| ImageDctHashSearchCriteria | Represents a search criteria for finding images in a document. |
| ImageSearchCriteria | Provides base class for image search criteria. |
| ImageThumbnailSearchCriteria | Represents search criteria for finding images in a content. |
| IsImageSearchCriteria | Represents search criteria for filtering image watermarks only. |
| IsTextSearchCriteria | Represents search criteria for filtering text watermarks only. |
| NotSearchCriteria | Represents NOT composite search criteria. |
| OrSearchCriteria | Represents OR composite search criteria. |
| PageSearchCriteria | Represents criteria allowing filtering by page number |
| RotateAngleSearchCriteria | Represents criteria allowing filtering by watermark rotate angle. |
| SearchCriteria | Class that can be used to construct criteria when searching for watermarks. |
| SizeSearchCriteria | Represents criteria allowing filtering by watermark size. |
| TextFormattingSearchCriteria | Represents criteria allowing filtering by text formatting. |
| TextSearchCriteria | Represents criteria allowing filtering by watermark text. |
| VectorSearchCriteria | Represents criteria allowing filtering by watermark color. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### AndSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/andsearchcriteria.md

#### AndSearchCriteria class

Represents AND composite search criteria.

```csharp
public class AndSearchCriteria : SearchCriteria
```

#### Properties

| Name | Description |
| --- | --- |
| Left { get; } | Gets the left search criteria. |
| Right { get; } | Gets the right search criteria. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### Left
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/left.md

#### AndSearchCriteria.Left property

Gets the left search criteria.

```csharp
public SearchCriteria Left { get; }
```

##### Property Value

The left search criteria.

### Right
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/right.md

#### AndSearchCriteria.Right property

Gets the right search criteria.

```csharp
public SearchCriteria Right { get; }
```

##### Property Value

The right search criteria.

### ColorRange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange.md

#### ColorRange class

Represents a range of colors. Specifies ranges using HSB representation of RGB color.

```csharp
public class ColorRange
```

#### Constructors

| Name | Description |
| --- | --- |
| ColorRange() | Initializes a new instance of the `ColorRange` class. |
| ColorRange(Color) | Initializes a new instance of the `ColorRange` class with a specified exact color. |

#### Properties

| Name | Description |
| --- | --- |
| IsEmpty { get; set; } | Gets or sets a value indicating whether only the empty color is in range. |
| MaxBrightness { get; set; } | Gets or sets the ending brightness value. |
| MaxHue { get; set; } | Gets or sets the ending hue value, in degrees. |
| MaxSaturation { get; set; } | Gets or sets the ending saturation value. |
| MinBrightness { get; set; } | Gets or sets the starting brightness value. |
| MinHue { get; set; } | Gets or sets the starting hue value, in degrees. |
| MinSaturation { get; set; } | Gets or sets the starting saturation value. |

### ColorRange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/colorrange.md

#### ColorRange()

Initializes a new instance of the `ColorRange` class.

```csharp
public ColorRange()
```

#### ColorRange(Color)

Initializes a new instance of the `ColorRange` class with a specified exact color.

```csharp
public ColorRange(Color exactColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| exactColor | Color | The exact color from which the range is created. |

### IsEmpty
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/isempty.md

#### ColorRange.IsEmpty property

Gets or sets a value indicating whether only the empty color is in range.

```csharp
public bool IsEmpty { get; set; }
```

##### Property Value

True if only the empty color is in range (HSB ranges are ignored); otherwise, false.

### MaxBrightness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/maxbrightness.md

#### ColorRange.MaxBrightness property

Gets or sets the ending brightness value.

```csharp
public float MaxBrightness { get; set; }
```

##### Property Value

The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

### MaxHue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/maxhue.md

#### ColorRange.MaxHue property

Gets or sets the ending hue value, in degrees.

```csharp
public float MaxHue { get; set; }
```

##### Property Value

The ending hue value, in degrees.

### MaxSaturation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/maxsaturation.md

#### ColorRange.MaxSaturation property

Gets or sets the ending saturation value.

```csharp
public float MaxSaturation { get; set; }
```

##### Property Value

The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

### MinBrightness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/minbrightness.md

#### ColorRange.MinBrightness property

Gets or sets the starting brightness value.

```csharp
public float MinBrightness { get; set; }
```

##### Property Value

The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

### MinHue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/minhue.md

#### ColorRange.MinHue property

Gets or sets the starting hue value, in degrees.

```csharp
public float MinHue { get; set; }
```

##### Property Value

The starting hue value, in degrees.

### MinSaturation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/colorrange/minsaturation.md

#### ColorRange.MinSaturation property

Gets or sets the starting saturation value.

```csharp
public float MinSaturation { get; set; }
```

##### Property Value

The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

### ImageColorHistogramSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria.md

#### ImageColorHistogramSearchCriteria class

Represents search criteria for finding images in a content.

```csharp
public class ImageColorHistogramSearchCriteria : ImageSearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageColorHistogramSearchCriteria(Stream) | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream. |
| ImageColorHistogramSearchCriteria(string) | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path. |

#### Properties

| Name | Description |
| --- | --- |
| BinsCount { get; set; } | Gets or sets a count of bins that will be used for building color histograms. |
| MaxDifference { get; set; } | Gets or sets maximum allowed difference between images. |
| Pages { get; set; } | Gets or sets the list of specific page numbers |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

This search criteria uses image color histograms for calculating image similarity.

### BinsCount
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/binscount.md

#### ImageColorHistogramSearchCriteria.BinsCount property

Gets or sets a count of bins that will be used for building color histograms.

```csharp
public byte BinsCount { get; set; }
```

##### Property Value

The default value is 10.

### ImageColorHistogramSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/imagecolorhistogramsearchcriteria.md

#### ImageColorHistogramSearchCriteria(string)

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path.

```csharp
public ImageColorHistogramSearchCriteria(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load image from. |

#### ImageColorHistogramSearchCriteria(Stream)

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream.

```csharp
public ImageColorHistogramSearchCriteria(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream to load image from. |

### ImageDctHashSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria.md

#### ImageDctHashSearchCriteria class

Represents a search criteria for finding images in a document.

```csharp
public class ImageDctHashSearchCriteria : ImageSearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageDctHashSearchCriteria(Stream) | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream. |
| ImageDctHashSearchCriteria(string) | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path. |

#### Properties

| Name | Description |
| --- | --- |
| MaxDifference { get; set; } | Gets or sets maximum allowed difference between images. |
| Pages { get; set; } | Gets or sets the list of specific page numbers |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

This search criteria uses DCT based perceptual image hash for calculating image similarity. **Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Search for images in the attached files (pdf).

```csharp
WatermarkerSettings settings = new WatermarkerSettings();
settings.SearchableObjects = new SearchableObjects
{
    PdfSearchableObjects = PdfSearchableObjects.All
};
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.pdf", loadOptions, settings))
{
    // Specify sample image to compare document images with
    ImageSearchCriteria criteria = new ImageDctHashSearchCriteria(@"D:\sample.png");
    // Search for similar images
    PossibleWatermarkCollection possibleWatermarks = watermarker.Search(criteria);
    // Remove or modify found image watermarks
    // ...
}
```

### ImageDctHashSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/imagedcthashsearchcriteria.md

#### ImageDctHashSearchCriteria(string)

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path.

```csharp
public ImageDctHashSearchCriteria(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load image from. |

#### ImageDctHashSearchCriteria(Stream)

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream.

```csharp
public ImageDctHashSearchCriteria(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream to load image from. |

### ImageSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria.md

#### ImageSearchCriteria class

Provides base class for image search criteria.

```csharp
public abstract class ImageSearchCriteria : PageSearchCriteria
```

#### Properties

| Name | Description |
| --- | --- |
| MaxDifference { get; set; } | Gets or sets maximum allowed difference between images. |
| Pages { get; set; } | Gets or sets the list of specific page numbers |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### MaxDifference
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/maxdifference.md

#### ImageSearchCriteria.MaxDifference property

Gets or sets maximum allowed difference between images.

```csharp
public double MaxDifference { get; set; }
```

##### Property Value

The value should be between 0 and 1. 0 means that only identical images will be found.

### ImageThumbnailSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria.md

#### ImageThumbnailSearchCriteria class

Represents search criteria for finding images in a content.

```csharp
public class ImageThumbnailSearchCriteria : ImageSearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageThumbnailSearchCriteria(Stream) | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream. |
| ImageThumbnailSearchCriteria(string) | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path. |

#### Properties

| Name | Description |
| --- | --- |
| MaxDifference { get; set; } | Gets or sets maximum allowed difference between images. |
| Pages { get; set; } | Gets or sets the list of specific page numbers |
| ThumbnailSize { get; set; } | Gets or sets thumbnail size. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

This search criteria uses image binarized thumbnail for calculating image similarity.

### ImageThumbnailSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/imagethumbnailsearchcriteria.md

#### ImageThumbnailSearchCriteria(string)

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path.

```csharp
public ImageThumbnailSearchCriteria(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load image from. |

#### ImageThumbnailSearchCriteria(Stream)

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream.

```csharp
public ImageThumbnailSearchCriteria(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream to load image from. |

### ThumbnailSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/thumbnailsize.md

#### ImageThumbnailSearchCriteria.ThumbnailSize property

Gets or sets thumbnail size.

```csharp
public byte ThumbnailSize { get; set; }
```

##### Property Value

By default 32X32 thumbnail will be used.

### IsImageSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria.md

#### IsImageSearchCriteria class

Represents search criteria for filtering image watermarks only.

```csharp
public sealed class IsImageSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| IsImageSearchCriteria() | Initializes a new instance of the `IsImageSearchCriteria` class. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### IsImageSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria/isimagesearchcriteria.md

#### IsImageSearchCriteria constructor

Initializes a new instance of the `IsImageSearchCriteria` class.

```csharp
public IsImageSearchCriteria()
```

### IsTextSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria.md

#### IsTextSearchCriteria class

Represents search criteria for filtering text watermarks only.

```csharp
public sealed class IsTextSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| IsTextSearchCriteria() | Initializes a new instance of the `IsTextSearchCriteria` class. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### IsTextSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria/istextsearchcriteria.md

#### IsTextSearchCriteria constructor

Initializes a new instance of the `IsTextSearchCriteria` class.

```csharp
public IsTextSearchCriteria()
```

### NotSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/notsearchcriteria.md

#### NotSearchCriteria class

Represents NOT composite search criteria.

```csharp
public class NotSearchCriteria : SearchCriteria
```

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### OrSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/orsearchcriteria.md

#### OrSearchCriteria class

Represents OR composite search criteria.

```csharp
public class OrSearchCriteria : SearchCriteria
```

#### Properties

| Name | Description |
| --- | --- |
| Left { get; } | Gets the left search criteria. |
| Right { get; } | Gets the right search criteria. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### Left
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/left.md

#### OrSearchCriteria.Left property

Gets the left search criteria.

```csharp
public SearchCriteria Left { get; }
```

##### Property Value

The left search criteria.

### Right
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/right.md

#### OrSearchCriteria.Right property

Gets the right search criteria.

```csharp
public SearchCriteria Right { get; }
```

##### Property Value

The right search criteria.

### PageSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria.md

#### PageSearchCriteria class

Represents criteria allowing filtering by page number

```csharp
public abstract class PageSearchCriteria : SearchCriteria
```

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; set; } | Gets or sets the list of specific page numbers |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### Pages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria/pages.md

#### PageSearchCriteria.Pages property

Gets or sets the list of specific page numbers

```csharp
public List<int> Pages { get; set; }
```

### RotateAngleSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria.md

#### RotateAngleSearchCriteria class

Represents criteria allowing filtering by watermark rotate angle.

```csharp
public class RotateAngleSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| RotateAngleSearchCriteria(double, double) | Initializes a new instance of the `RotateAngleSearchCriteria` class with a starting angle and a ending angle. |

#### Properties

| Name | Description |
| --- | --- |
| MaximumAngle { get; } | Gets the ending angle in degrees. |
| MinimumAngle { get; } | Gets the starting angle in degrees. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Find and remove watermarks using search criteria.

```csharp
using (Watermarker watermarker = new Watermarker(@"C:\test.some_ext"))
{
    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
    TextSearchCriteria textCriteria = new TextSearchCriteria(new Regex("^Test watermark$"));
    PossibleWatermarkCollection watermarks = watermarker.Search(textCriteria.And(widthRange.Or(rotateAngle)));
    watermarks.Clear();
    watermarker.Save();
}
```

### MaximumAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/maximumangle.md

#### RotateAngleSearchCriteria.MaximumAngle property

Gets the ending angle in degrees.

```csharp
public double MaximumAngle { get; }
```

##### Property Value

The ending angle.

### MinimumAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/minimumangle.md

#### RotateAngleSearchCriteria.MinimumAngle property

Gets the starting angle in degrees.

```csharp
public double MinimumAngle { get; }
```

##### Property Value

The starting angle.

### RotateAngleSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/rotateanglesearchcriteria.md

#### RotateAngleSearchCriteria constructor

Initializes a new instance of the `RotateAngleSearchCriteria` class with a starting angle and a ending angle.

```csharp
public RotateAngleSearchCriteria(double minAngle, double maxAngle)
```

| Parameter | Type | Description |
| --- | --- | --- |
| minAngle | Double | The starting angle in degrees. |
| maxAngle | Double | The ending angle in degrees. |

### SearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/searchcriteria.md

#### SearchCriteria class

Class that can be used to construct criteria when searching for watermarks.

```csharp
public abstract class SearchCriteria
```

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

### And
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/searchcriteria/and.md

#### SearchCriteria.And method

Combines this `SearchCriteria` with other criteria using logical AND operator.

```csharp
public SearchCriteria And(SearchCriteria other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchCriteria | Search criteria to combine with. |

##### Return Value

Combined search criteria.

### Not
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/searchcriteria/not.md

#### SearchCriteria.Not method

Negates this `SearchCriteria`.

```csharp
public SearchCriteria Not()
```

##### Return Value

Combined search criteria.

### Or
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/searchcriteria/or.md

#### SearchCriteria.Or method

Combines this `SearchCriteria` with other criteria using logical OR operator.

```csharp
public SearchCriteria Or(SearchCriteria other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | SearchCriteria | Search criteria to combine with. |

##### Return Value

Combined search criteria.

### SizeSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria.md

#### SizeSearchCriteria class

Represents criteria allowing filtering by watermark size.

```csharp
public class SizeSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| SizeSearchCriteria(Dimension, double, double) | Initializes a new instance of the `SizeSearchCriteria` class with a specified dimension, a starting value and an ending value. |

#### Properties

| Name | Description |
| --- | --- |
| Dimension { get; } | Gets the dimension of watermark to search by. |
| Maximum { get; } | Gets the ending value. |
| Minimum { get; } | Gets the starting value. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Find and remove watermark using search criteria.

```csharp
using (Watermarker watermarker = new Watermarker(@"C:\test.some_ext"))
{
    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
    TextSearchCriteria textCriteria = new TextSearchCriteria(new Regex("^Test watermark$"));
    PossibleWatermarkCollection watermarks = watermarker.Search(textCriteria.And(widthRange.Or(rotateAngle)));
    watermarks.Clear();
    watermarker.Save();
}
```

### Dimension
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/dimension.md

#### SizeSearchCriteria.Dimension property

Gets the dimension of watermark to search by.

```csharp
public Dimension Dimension { get; }
```

##### Property Value

The dimension of watermark to search by.

### Maximum
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/maximum.md

#### SizeSearchCriteria.Maximum property

Gets the ending value.

```csharp
public double Maximum { get; }
```

##### Property Value

The ending value.

### Minimum
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/minimum.md

#### SizeSearchCriteria.Minimum property

Gets the starting value.

```csharp
public double Minimum { get; }
```

##### Property Value

The starting value.

### SizeSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/sizesearchcriteria.md

#### SizeSearchCriteria constructor

Initializes a new instance of the `SizeSearchCriteria` class with a specified dimension, a starting value and an ending value.

```csharp
public SizeSearchCriteria(Dimension dimension, double min, double max)
```

| Parameter | Type | Description |
| --- | --- | --- |
| dimension | Dimension | The dimension of a watermark to search by. |
| min | Double | The starting value. |
| max | Double | The ending value. |

### TextFormattingSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria.md

#### TextFormattingSearchCriteria class

Represents criteria allowing filtering by text formatting.

```csharp
public class TextFormattingSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| TextFormattingSearchCriteria() | Initializes a new instance of the `TextFormattingSearchCriteria` class. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColorRange { get; set; } | Gets or sets the range of colors which are used to filter watermarks by text background color. |
| FontBold { get; set; } | Gets or sets a value indicating whether the font used in watermark text formatting is bold. |
| FontItalic { get; set; } | Gets or sets a value indicating whether the font used in watermark text formatting is italic. |
| FontName { get; set; } | Gets or sets the name of the font which is used in possible watermark text formatting. |
| FontStrikeout { get; set; } | Gets or sets a value indicating whether the font used in watermark text formatting is strikeout. |
| FontUnderline { get; set; } | Gets or sets a value indicating whether the font used in watermark text formatting is underline. |
| ForegroundColorRange { get; set; } | Gets or sets the range of colors which are used to filter watermarks by text foreground color. |
| MaxFontSize { get; set; } | Gets or sets the ending value of the font size. |
| MinFontSize { get; set; } | Gets or sets the starting value of the font size. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Remove possible watermarks with a particular text formatting (regardless of document type).

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\test.doc"))
{
    TextFormattingSearchCriteria criteria = new TextFormattingSearchCriteria();
    criteria.ForegroundColorRange = new ColorRange();
    criteria.ForegroundColorRange.MinHue = -5;
    criteria.ForegroundColorRange.MaxHue = 10;
    criteria.ForegroundColorRange.MinBrightness = 0.01f;
    criteria.ForegroundColorRange.MaxBrightness = 0.99f;
    criteria.BackgroundColorRange = new ColorRange();
    criteria.BackgroundColorRange.IsEmpty = true;
    criteria.FontName = "Arial";
    criteria.MinFontSize = 19;
    criteria.MaxFontSize = 42;
    criteria.FontBold = true;

    PossibleWatermarkCollection watermarks = watermarker.Search(criteria);
    watermarks.Clear();
    watermarker.Save();
}
```

### BackgroundColorRange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/backgroundcolorrange.md

#### TextFormattingSearchCriteria.BackgroundColorRange property

Gets or sets the range of colors which are used to filter watermarks by text background color.

```csharp
public ColorRange BackgroundColorRange { get; set; }
```

##### Property Value

The range of colors which are used to filter watermarks by text background color.

### FontBold
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/fontbold.md

#### TextFormattingSearchCriteria.FontBold property

Gets or sets a value indicating whether the font used in watermark text formatting is bold.

```csharp
public bool? FontBold { get; set; }
```

##### Property Value

The default value is null, which means that the filter is not applied.

### FontItalic
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/fontitalic.md

#### TextFormattingSearchCriteria.FontItalic property

Gets or sets a value indicating whether the font used in watermark text formatting is italic.

```csharp
public bool? FontItalic { get; set; }
```

##### Property Value

The default value is null, which means that the filter is not applied.

### FontName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/fontname.md

#### TextFormattingSearchCriteria.FontName property

Gets or sets the name of the font which is used in possible watermark text formatting.

```csharp
public string FontName { get; set; }
```

##### Property Value

The default value is null, which means that the filter is not applied.

### FontStrikeout
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/fontstrikeout.md

#### TextFormattingSearchCriteria.FontStrikeout property

Gets or sets a value indicating whether the font used in watermark text formatting is strikeout.

```csharp
public bool? FontStrikeout { get; set; }
```

##### Property Value

The default value is null, which means that the filter is not applied.

### FontUnderline
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/fontunderline.md

#### TextFormattingSearchCriteria.FontUnderline property

Gets or sets a value indicating whether the font used in watermark text formatting is underline.

```csharp
public bool? FontUnderline { get; set; }
```

##### Property Value

The default value is null, which means that the filter is not applied.

### ForegroundColorRange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/foregroundcolorrange.md

#### TextFormattingSearchCriteria.ForegroundColorRange property

Gets or sets the range of colors which are used to filter watermarks by text foreground color.

```csharp
public ColorRange ForegroundColorRange { get; set; }
```

##### Property Value

The range of colors which are used to filter watermarks by text foreground color.

### MaxFontSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/maxfontsize.md

#### TextFormattingSearchCriteria.MaxFontSize property

Gets or sets the ending value of the font size.

```csharp
public float MaxFontSize { get; set; }
```

##### Property Value

The ending value of the font size.

### MinFontSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/minfontsize.md

#### TextFormattingSearchCriteria.MinFontSize property

Gets or sets the starting value of the font size.

```csharp
public float MinFontSize { get; set; }
```

##### Property Value

The starting value of the font size.

### TextFormattingSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/textformattingsearchcriteria.md

#### TextFormattingSearchCriteria constructor

Initializes a new instance of the `TextFormattingSearchCriteria` class.

```csharp
public TextFormattingSearchCriteria()
```

### TextSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textsearchcriteria.md

#### TextSearchCriteria class

Represents criteria allowing filtering by watermark text.

```csharp
public class TextSearchCriteria : PageSearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| TextSearchCriteria(Regex) | Initializes a new instance of the `TextSearchCriteria` class with a specified regular expression. |
| TextSearchCriteria(string) | Initializes a new instance of the `TextSearchCriteria` class with a search string. |
| TextSearchCriteria(string, bool) | Initializes a new instance of the `TextSearchCriteria` class with a search string and a flag for comparison. |

#### Properties

| Name | Description |
| --- | --- |
| Pages { get; set; } | Gets or sets the list of specific page numbers |
| Pattern { get; } | Gets the search pattern. |
| SkipUnreadableCharacters { get; set; } | Gets or sets a value indicating that unreadable characters will be skipped during string comparison. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Find and remove watermark using search criteria.

```csharp
using (Watermarker watermarker = new Watermarker(@"C:\test.some_ext"))
{
    SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100);
    RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45);
    TextSearchCriteria textCriteria = new TextSearchCriteria(new Regex("^Test watermark$"));
    PossibleWatermarkCollection watermarks = watermarker.Search(textCriteria.And(widthRange.Or(rotateAngle)));
    watermarks.Clear();
    watermarker.Save();
}
```

### Pattern
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/pattern.md

#### TextSearchCriteria.Pattern property

Gets the search pattern.

```csharp
public Regex Pattern { get; }
```

##### Property Value

The regular expression pattern to match.

### SkipUnreadableCharacters
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/skipunreadablecharacters.md

#### TextSearchCriteria.SkipUnreadableCharacters property

Gets or sets a value indicating that unreadable characters will be skipped during string comparison.

```csharp
public bool SkipUnreadableCharacters { get; set; }
```

##### Property Value

A value indicating that unreadable characters will be skipped during string comparison.

### TextSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/textsearchcriteria.md

#### TextSearchCriteria(Regex)

Initializes a new instance of the `TextSearchCriteria` class with a specified regular expression.

```csharp
public TextSearchCriteria(Regex pattern)
```

| Parameter | Type | Description |
| --- | --- | --- |
| pattern | Regex | The regular expression to match. |

#### TextSearchCriteria(string, bool)

Initializes a new instance of the `TextSearchCriteria` class with a search string and a flag for comparison.

```csharp
public TextSearchCriteria(string searchString, bool isMatchCase)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchString | String | The exact string to search for. |
| isMatchCase | Boolean | false |

#### TextSearchCriteria(string)

Initializes a new instance of the `TextSearchCriteria` class with a search string.

```csharp
public TextSearchCriteria(string searchString)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchString | String | The exact string to search for. |

### VectorSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria.md

#### VectorSearchCriteria class

Represents criteria allowing filtering by watermark color.

```csharp
public class VectorSearchCriteria : SearchCriteria
```

#### Constructors

| Name | Description |
| --- | --- |
| VectorSearchCriteria() | Initializes a new instance of the `VectorSearchCriteria` class. |

#### Properties

| Name | Description |
| --- | --- |
| VectorColorRange { get; set; } | Gets or sets the range of colors which are used to filter vector watermarks by foreground color. |

#### Methods

| Name | Description |
| --- | --- |
| And(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| Not() | Negates this `SearchCriteria`. |
| Or(SearchCriteria) | Combines this `SearchCriteria` with other criteria using logical OR operator. |

##### Remarks

**Learn more:**

* [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks)

##### Examples

Find and remove watermark using search criteria.

```csharp
using (Watermarker watermarker = new Watermarker(@"C:\test.pdf"))
{
    VectorSearchCriteria searchCriteria = new VectorSearchCriteria();
    Color watermarkColor = ColorTranslator.FromHtml("#a9aaae");
    GroupDocs.Watermark.Watermarks.Color fromSystemColor = GroupDocs.Watermark.Watermarks.Color.FromArgb(watermarkColor.A, watermarkColor.R, watermarkColor.G, watermarkColor.B);
    ColorRange criteriaVectorColorRange = new ColorRange(fromSystemColor)
    {
       MinBrightness = 0.1f,
       MaxBrightness = 0.7f
    };
    searchCriteria.VectorColorRange = criteriaVectorColorRange;
    PossibleWatermarkCollection possibleWatermarkCollection = watermarker.Search(searchCriteria);
    possibleWatermarkCollection.Clear();
    watermarker.Save(@"C:\modified_test.pdf");
}
```

### VectorColorRange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/vectorcolorrange.md

#### VectorSearchCriteria.VectorColorRange property

Gets or sets the range of colors which are used to filter vector watermarks by foreground color.

```csharp
public ColorRange VectorColorRange { get; set; }
```

##### Property Value

The range of colors which are used to filter vector watermarks by foreground color.

### VectorSearchCriteria
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/vectorsearchcriteria.md

#### VectorSearchCriteria constructor

Initializes a new instance of the `VectorSearchCriteria` class.

```csharp
public VectorSearchCriteria()
```

### GroupDocs.Watermark.Search.Watermarks
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks.md

The namespace provides classes of possible watermarks found in documents of different formats.

#### Classes

| Class | Description |
| --- | --- |
| DiagramCommentPossibleWatermark | Represents possible watermark in a Visio document comment. |
| DiagramHeaderFooterPossibleWatermark | Represents possible watermark in a Visio document header/footer. |
| DiagramHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a Visio document. |
| DiagramShapePossibleWatermark | Represents possible shape watermark in a Visio document. |
| EmailAttachedImagePossibleWatermark | Represents possible image watermark in email message attachment. |
| EmailBodyTextPossibleWatermark | Represents possible watermark in email message body. |
| EmailEmbeddedImagePossibleWatermark | Represents possible image watermark embedded to email message body. |
| EmailHtmlBodyTextPossibleWatermark | Represents possible watermark in email message html body. |
| EmailSubjectTextPossibleWatermark | Represents possible watermark in email message subject. |
| EmailTextPossibleWatermark | Represents possible watermark in email message text fields. |
| ImageInpaintingPossibleWatermark | Represents a manually specified image region that should be inpainted (filled using surrounding pixels). |
| PdfAnnotationPossibleWatermark | Represents possible annotation watermark in a pdf document. |
| PdfArtifactPossibleWatermark | Represents possible artifact watermark in a pdf content. |
| PdfAttachedImagePossibleWatermark | Represents possible image watermark in pdf document attachment. |
| PdfHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a pdf document. |
| PdfTextPossibleWatermark | Represents possible watermark in a pdf document text. |
| PdfVectorPossibleWatermark | Represents possible vector watermark in a pdf document. |
| PdfXObjectPossibleWatermark | Represents possible XObject watermark in a pdf content. |
| PresentationBackgroundPossibleWatermark | Represents possible background watermark in a PowerPoint document. |
| PresentationChartBackgroundPossibleWatermark | Represents possible background watermark in a PowerPoint chart. |
| PresentationHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a PowerPoint document. |
| PresentationShapePossibleWatermark | Represents possible shape watermark in a PowerPoint document. |
| SpreadsheetAttachedImagePossibleWatermark | Represents possible image watermark in Excel document attachment. |
| SpreadsheetBackgroundPossibleWatermark | Represents possible background watermark in an Excel document. |
| SpreadsheetCellPossibleWatermark | Represents possible cell watermark in an Excel document. |
| SpreadsheetChartBackgroundPossibleWatermark | Represents possible image watermark in Excel chart background. |
| SpreadsheetHeaderFooterPossibleWatermark | Represents possible watermark in a header or footer of an Excel document. |
| SpreadsheetHyperlinkPossibleWatermark | Represents possible hyperlink watermark in an Excel document. |
| SpreadsheetShapePossibleWatermark | Represents possible shape watermark in an Excel document. |
| WordProcessingShapePossibleWatermark | Represents possible shape watermark in a Word document. |
| WordProcessingTextHyperlinkPossibleWatermark | Represents possible hyperlink watermark in a Word document. |
| WordProcessingTextPossibleWatermark | Represents possible watermark in a Word document text. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### DiagramCommentPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark.md

#### DiagramCommentPossibleWatermark class

Represents possible watermark in a Visio document comment.

```csharp
public class DiagramCommentPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `DiagramCommentPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `DiagramCommentPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `DiagramCommentPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `DiagramCommentPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `DiagramCommentPossibleWatermark`. |
| override Width { get; } | Gets the width of this `DiagramCommentPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `DiagramCommentPossibleWatermark` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `DiagramCommentPossibleWatermark` from page bottom border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/height.md

#### DiagramCommentPossibleWatermark.Height property

Gets the height of this `DiagramCommentPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/parent.md

#### DiagramCommentPossibleWatermark.Parent property

Gets the parent of this `DiagramCommentPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `DiagramCommentPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/rotateangle.md

#### DiagramCommentPossibleWatermark.RotateAngle property

Gets the rotate angle of this `DiagramCommentPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/text.md

#### DiagramCommentPossibleWatermark.Text property

Gets or sets the text of this `DiagramCommentPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `DiagramCommentPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/unitofmeasurement.md

#### DiagramCommentPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `DiagramCommentPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `DiagramCommentPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/width.md

#### DiagramCommentPossibleWatermark.Width property

Gets the width of this `DiagramCommentPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/x.md

#### DiagramCommentPossibleWatermark.X property

Gets the horizontal offset of this `DiagramCommentPossibleWatermark` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `DiagramCommentPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/y.md

#### DiagramCommentPossibleWatermark.Y property

Gets the vertical offset of this `DiagramCommentPossibleWatermark` from page bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `DiagramCommentPossibleWatermark`.

### DiagramHeaderFooterPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark.md

#### DiagramHeaderFooterPossibleWatermark class

Represents possible watermark in a Visio document header/footer.

```csharp
public class DiagramHeaderFooterPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `DiagramHeaderFooterPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `DiagramHeaderFooterPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `DiagramHeaderFooterPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `DiagramHeaderFooterPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `DiagramHeaderFooterPossibleWatermark`. |
| override Width { get; } | Gets the width of this `DiagramHeaderFooterPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `DiagramHeaderFooterPossibleWatermark` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `DiagramHeaderFooterPossibleWatermark` from page bottom border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/height.md

#### DiagramHeaderFooterPossibleWatermark.Height property

Gets the height of this `DiagramHeaderFooterPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/parent.md

#### DiagramHeaderFooterPossibleWatermark.Parent property

Gets the parent of this `DiagramHeaderFooterPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `DiagramHeaderFooterPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/rotateangle.md

#### DiagramHeaderFooterPossibleWatermark.RotateAngle property

Gets the rotate angle of this `DiagramHeaderFooterPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/text.md

#### DiagramHeaderFooterPossibleWatermark.Text property

Gets or sets the text of this `DiagramHeaderFooterPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `DiagramHeaderFooterPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/unitofmeasurement.md

#### DiagramHeaderFooterPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `DiagramHeaderFooterPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `DiagramHeaderFooterPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/width.md

#### DiagramHeaderFooterPossibleWatermark.Width property

Gets the width of this `DiagramHeaderFooterPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/x.md

#### DiagramHeaderFooterPossibleWatermark.X property

Gets the horizontal offset of this `DiagramHeaderFooterPossibleWatermark` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/y.md

#### DiagramHeaderFooterPossibleWatermark.Y property

Gets the vertical offset of this `DiagramHeaderFooterPossibleWatermark` from page bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### DiagramHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark.md

#### DiagramHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a Visio document.

```csharp
public class DiagramHyperlinkPossibleWatermark : HyperlinkPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `HyperlinkPossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `HyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `DiagramHyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `HyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `HyperlinkPossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `HyperlinkPossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `HyperlinkPossibleWatermark`. |

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/text.md

#### DiagramHyperlinkPossibleWatermark.Text property

Gets or sets the url of this `DiagramHyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `DiagramHyperlinkPossibleWatermark`.

### DiagramShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark.md

#### DiagramShapePossibleWatermark class

Represents possible shape watermark in a Visio document.

```csharp
public class DiagramShapePossibleWatermark : ShapePossibleWatermark<DiagramShape>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `DiagramShapePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/parent.md

#### DiagramShapePossibleWatermark.Parent property

Gets the parent of this `DiagramShapePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `DiagramShapePossibleWatermark`.

### EmailAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark.md

#### EmailAttachedImagePossibleWatermark class

Represents possible image watermark in email message attachment.

```csharp
public class EmailAttachedImagePossibleWatermark : AttachedImagePossibleWatermark<EmailAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `AttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `AttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `AttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `AttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `AttachedImagePossibleWatermark`. |

### EmailBodyTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark.md

#### EmailBodyTextPossibleWatermark class

Represents possible watermark in email message body.

```csharp
public class EmailBodyTextPossibleWatermark : EmailTextPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `EmailTextPossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `EmailTextPossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### EmailEmbeddedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark.md

#### EmailEmbeddedImagePossibleWatermark class

Represents possible image watermark embedded to email message body.

```csharp
public class EmailEmbeddedImagePossibleWatermark : 
    AttachedImagePossibleWatermark<EmailEmbeddedObject>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `AttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `AttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `AttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `AttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `AttachedImagePossibleWatermark`. |

### EmailHtmlBodyTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark.md

#### EmailHtmlBodyTextPossibleWatermark class

Represents possible watermark in email message html body.

```csharp
public class EmailHtmlBodyTextPossibleWatermark : EmailTextPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `EmailTextPossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `EmailTextPossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### EmailSubjectTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark.md

#### EmailSubjectTextPossibleWatermark class

Represents possible watermark in email message subject.

```csharp
public class EmailSubjectTextPossibleWatermark : EmailTextPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `EmailTextPossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `EmailTextPossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### EmailTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark.md

#### EmailTextPossibleWatermark class

Represents possible watermark in email message text fields.

```csharp
public abstract class EmailTextPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `EmailTextPossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `EmailTextPossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/parent.md

#### EmailTextPossibleWatermark.Parent property

Gets the parent of this `EmailTextPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `EmailTextPossibleWatermark`.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/text.md

#### EmailTextPossibleWatermark.Text property

Gets or sets the text of this `EmailTextPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `EmailTextPossibleWatermark`.

### ImageInpaintingPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark.md

#### ImageInpaintingPossibleWatermark class

Represents a manually specified image region that should be inpainted (filled using surrounding pixels).

```csharp
public class ImageInpaintingPossibleWatermark : PossibleWatermark
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageInpaintingPossibleWatermark() | Initializes a new instance of the `ImageInpaintingPossibleWatermark` class. |

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| Method { get; set; } | Gets or sets the inpainting algorithm. Default is PatchBased. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `ImageInpaintingPossibleWatermark`. Always returns `null` because the region is specified manually. |
| PatchSize { get; set; } | Gets or sets patch size used by the algorithm (odd, 5-11). Default is 7. For Telea this is used as HalfPatchSize. |
| Polygons { get; set; } | Gets or sets polygonal regions to be inpainted, in image pixels. Each polygon is an array of vertices. Either `Rectangles` or `Polygons` must be specified, but not both. |
| Rectangles { get; set; } | Gets or sets rectangular areas to be inpainted, in image pixels. Either `Rectangles` or `Polygons` must be specified, but not both. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### ImageInpaintingPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/imageinpaintingpossiblewatermark.md

#### ImageInpaintingPossibleWatermark constructor

Initializes a new instance of the `ImageInpaintingPossibleWatermark` class.

```csharp
public ImageInpaintingPossibleWatermark()
```

### Method
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/method.md

#### ImageInpaintingPossibleWatermark.Method property

Gets or sets the inpainting algorithm. Default is PatchBased.

```csharp
public InpaintingMethod Method { get; set; }
```

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/parent.md

#### ImageInpaintingPossibleWatermark.Parent property

Gets the parent of this `ImageInpaintingPossibleWatermark`. Always returns `null` because the region is specified manually.

```csharp
public override ContentPart Parent { get; }
```

### PatchSize
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/patchsize.md

#### ImageInpaintingPossibleWatermark.PatchSize property

Gets or sets patch size used by the algorithm (odd, 5-11). Default is 7. For Telea this is used as HalfPatchSize.

```csharp
public int PatchSize { get; set; }
```

### Polygons
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/polygons.md

#### ImageInpaintingPossibleWatermark.Polygons property

Gets or sets polygonal regions to be inpainted, in image pixels. Each polygon is an array of vertices. Either `Rectangles` or `Polygons` must be specified, but not both.

```csharp
public Point[][] Polygons { get; set; }
```

### Rectangles
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/imageinpaintingpossiblewatermark/rectangles.md

#### ImageInpaintingPossibleWatermark.Rectangles property

Gets or sets rectangular areas to be inpainted, in image pixels. Either `Rectangles` or `Polygons` must be specified, but not both.

```csharp
public Rectangle[] Rectangles { get; set; }
```

### PdfAnnotationPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark.md

#### PdfAnnotationPossibleWatermark class

Represents possible annotation watermark in a pdf document.

```csharp
public class PdfAnnotationPossibleWatermark : ShapePossibleWatermark<PdfAnnotation>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PdfAnnotationPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/parent.md

#### PdfAnnotationPossibleWatermark.Parent property

Gets the parent of this `PdfAnnotationPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PdfAnnotationPossibleWatermark`.

### PdfArtifactPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark.md

#### PdfArtifactPossibleWatermark class

Represents possible artifact watermark in a pdf content.

```csharp
public class PdfArtifactPossibleWatermark : ShapePossibleWatermark<PdfArtifact>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PdfArtifactPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/parent.md

#### PdfArtifactPossibleWatermark.Parent property

Gets the parent of this `PdfArtifactPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PdfArtifactPossibleWatermark`.

### PdfAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark.md

#### PdfAttachedImagePossibleWatermark class

Represents possible image watermark in pdf document attachment.

```csharp
public class PdfAttachedImagePossibleWatermark : AttachedImagePossibleWatermark<PdfAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `AttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `AttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `AttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `AttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `AttachedImagePossibleWatermark`. |

### PdfHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark.md

#### PdfHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a pdf document.

```csharp
public class PdfHyperlinkPossibleWatermark : HyperlinkPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `HyperlinkPossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `HyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `PdfHyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `HyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `HyperlinkPossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `HyperlinkPossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `HyperlinkPossibleWatermark`. |

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/text.md

#### PdfHyperlinkPossibleWatermark.Text property

Gets or sets the url of this `PdfHyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `PdfHyperlinkPossibleWatermark`.

### PdfTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark.md

#### PdfTextPossibleWatermark class

Represents possible watermark in a pdf document text.

```csharp
public class PdfTextPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PdfTextPossibleWatermark`. |
| override Height { get; } | Gets the height of this `PdfTextPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PdfTextPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PdfTextPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `PdfTextPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `PdfTextPossibleWatermark`. |
| override Width { get; } | Gets the width of this `PdfTextPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `PdfTextPossibleWatermark` from page left border in points. |
| override Y { get; } | Gets the vertical offset of this `PdfTextPossibleWatermark` from page bottom border in points. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/formattedtextfragments.md

#### PdfTextPossibleWatermark.FormattedTextFragments property

Gets the collection of formatted text fragments of this `PdfTextPossibleWatermark`.

```csharp
public override FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `PdfTextPossibleWatermark`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/height.md

#### PdfTextPossibleWatermark.Height property

Gets the height of this `PdfTextPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `PdfTextPossibleWatermark` in points.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/parent.md

#### PdfTextPossibleWatermark.Parent property

Gets the parent of this `PdfTextPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PdfTextPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/rotateangle.md

#### PdfTextPossibleWatermark.RotateAngle property

Gets the rotate angle of this `PdfTextPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/text.md

#### PdfTextPossibleWatermark.Text property

Gets or sets the text of this `PdfTextPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `PdfTextPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/unitofmeasurement.md

#### PdfTextPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `PdfTextPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `PdfTextPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/width.md

#### PdfTextPossibleWatermark.Width property

Gets the width of this `PdfTextPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `PdfTextPossibleWatermark` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/x.md

#### PdfTextPossibleWatermark.X property

Gets the horizontal offset of this `PdfTextPossibleWatermark` from page left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `PdfTextPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/y.md

#### PdfTextPossibleWatermark.Y property

Gets the vertical offset of this `PdfTextPossibleWatermark` from page bottom border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `PdfTextPossibleWatermark`.

### PdfVectorPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark.md

#### PdfVectorPossibleWatermark class

Represents possible vector watermark in a pdf document.

```csharp
public class PdfVectorPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PdfVectorPossibleWatermark`. |
| PdfOperatorCollection { get; } | Gets the collection of vector operators of this `PdfVectorPossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/parent.md

#### PdfVectorPossibleWatermark.Parent property

Gets the parent of this `PdfVectorPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PdfVectorPossibleWatermark`.

### PdfOperatorCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/pdfoperatorcollection.md

#### PdfVectorPossibleWatermark.PdfOperatorCollection property

Gets the collection of vector operators of this `PdfVectorPossibleWatermark`.

```csharp
public PdfOperatorCollection PdfOperatorCollection { get; }
```

##### Property Value

The collection of vector operators of this `PdfVectorPossibleWatermark`.

### PdfXObjectPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark.md

#### PdfXObjectPossibleWatermark class

Represents possible XObject watermark in a pdf content.

```csharp
public class PdfXObjectPossibleWatermark : ShapePossibleWatermark<PdfXObject>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PdfXObjectPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/parent.md

#### PdfXObjectPossibleWatermark.Parent property

Gets the parent of this `PdfXObjectPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PdfXObjectPossibleWatermark`.

### PresentationBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark.md

#### PresentationBackgroundPossibleWatermark class

Represents possible background watermark in a PowerPoint document.

```csharp
public class PresentationBackgroundPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `PresentationBackgroundPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PresentationBackgroundPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `PresentationBackgroundPossibleWatermark`. |
| override Width { get; } | Gets the width of this `PresentationBackgroundPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `PresentationBackgroundPossibleWatermark` from slide left border in points. |
| override Y { get; } | Gets the vertical offset of this `PresentationBackgroundPossibleWatermark` from slide top border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/height.md

#### PresentationBackgroundPossibleWatermark.Height property

Gets the height of this `PresentationBackgroundPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `PresentationBackgroundPossibleWatermark` in points.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/parent.md

#### PresentationBackgroundPossibleWatermark.Parent property

Gets the parent of this `PresentationBackgroundPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PresentationBackgroundPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/rotateangle.md

#### PresentationBackgroundPossibleWatermark.RotateAngle property

Gets the rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/unitofmeasurement.md

#### PresentationBackgroundPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `PresentationBackgroundPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `PresentationBackgroundPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/width.md

#### PresentationBackgroundPossibleWatermark.Width property

Gets the width of this `PresentationBackgroundPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `PresentationBackgroundPossibleWatermark` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/x.md

#### PresentationBackgroundPossibleWatermark.X property

Gets the horizontal offset of this `PresentationBackgroundPossibleWatermark` from slide left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `PresentationBackgroundPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/y.md

#### PresentationBackgroundPossibleWatermark.Y property

Gets the vertical offset of this `PresentationBackgroundPossibleWatermark` from slide top border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `PresentationBackgroundPossibleWatermark`.

### PresentationChartBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark.md

#### PresentationChartBackgroundPossibleWatermark class

Represents possible background watermark in a PowerPoint chart.

```csharp
public class PresentationChartBackgroundPossibleWatermark : TwoDObjectPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PresentationChartBackgroundPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `PresentationChartBackgroundPossibleWatermark`. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/parent.md

#### PresentationChartBackgroundPossibleWatermark.Parent property

Gets the parent of this `PresentationChartBackgroundPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PresentationChartBackgroundPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/rotateangle.md

#### PresentationChartBackgroundPossibleWatermark.RotateAngle property

Gets the rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PresentationChartBackgroundPossibleWatermark` in degrees.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/unitofmeasurement.md

#### PresentationChartBackgroundPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `PresentationChartBackgroundPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `PresentationChartBackgroundPossibleWatermark`.

### PresentationHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark.md

#### PresentationHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a PowerPoint document.

```csharp
public class PresentationHyperlinkPossibleWatermark : HyperlinkPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `HyperlinkPossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `HyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `HyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `HyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `HyperlinkPossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `HyperlinkPossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `HyperlinkPossibleWatermark`. |

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/text.md

#### PresentationHyperlinkPossibleWatermark.Text property

Gets or sets the url of this `HyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `HyperlinkPossibleWatermark`.

### PresentationShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark.md

#### PresentationShapePossibleWatermark class

Represents possible shape watermark in a PowerPoint document.

```csharp
public class PresentationShapePossibleWatermark : ShapePossibleWatermark<PresentationShape>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `PresentationShapePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/parent.md

#### PresentationShapePossibleWatermark.Parent property

Gets the parent of this `PresentationShapePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `PresentationShapePossibleWatermark`.

### SpreadsheetAttachedImagePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark.md

#### SpreadsheetAttachedImagePossibleWatermark class

Represents possible image watermark in Excel document attachment.

```csharp
public class SpreadsheetAttachedImagePossibleWatermark : 
    FloatingAttachedImagePossibleWatermark<SpreadsheetAttachment>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `FloatingAttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `FloatingAttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `FloatingAttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `FloatingAttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `FloatingAttachedImagePossibleWatermark`. |

### SpreadsheetBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark.md

#### SpreadsheetBackgroundPossibleWatermark class

Represents possible background watermark in an Excel document.

```csharp
public class SpreadsheetBackgroundPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `SpreadsheetBackgroundPossibleWatermark` in pixels. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetBackgroundPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `SpreadsheetBackgroundPossibleWatermark`. |
| override Width { get; } | Gets the width of this `SpreadsheetBackgroundPossibleWatermark` in pixels. |
| override X { get; } | Gets the horizontal offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet left border in pixels. |
| override Y { get; } | Gets the vertical offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet top border in pixels. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/height.md

#### SpreadsheetBackgroundPossibleWatermark.Height property

Gets the height of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/parent.md

#### SpreadsheetBackgroundPossibleWatermark.Parent property

Gets the parent of this `SpreadsheetBackgroundPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetBackgroundPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/rotateangle.md

#### SpreadsheetBackgroundPossibleWatermark.RotateAngle property

Gets the rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `SpreadsheetBackgroundPossibleWatermark` in degrees.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/unitofmeasurement.md

#### SpreadsheetBackgroundPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `SpreadsheetBackgroundPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `SpreadsheetBackgroundPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/width.md

#### SpreadsheetBackgroundPossibleWatermark.Width property

Gets the width of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/x.md

#### SpreadsheetBackgroundPossibleWatermark.X property

Gets the horizontal offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet left border in pixels.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `SpreadsheetBackgroundPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/y.md

#### SpreadsheetBackgroundPossibleWatermark.Y property

Gets the vertical offset of this `SpreadsheetBackgroundPossibleWatermark` from worksheet top border in pixels.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `SpreadsheetBackgroundPossibleWatermark`.

### SpreadsheetCellPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark.md

#### SpreadsheetCellPossibleWatermark class

Represents possible cell watermark in an Excel document.

```csharp
public class SpreadsheetCellPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`. |
| override Height { get; } | Gets the height of this `SpreadsheetCellPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetCellPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `SpreadsheetCellPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `SpreadsheetCellPossibleWatermark`. |
| override Width { get; } | Gets the width of this `SpreadsheetCellPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `SpreadsheetCellPossibleWatermark` from content left border in points. |
| override Y { get; } | Gets the vertical offset of this `SpreadsheetCellPossibleWatermark` from content top border in points. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/formattedtextfragments.md

#### SpreadsheetCellPossibleWatermark.FormattedTextFragments property

Gets the collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`.

```csharp
public override FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `SpreadsheetCellPossibleWatermark`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/height.md

#### SpreadsheetCellPossibleWatermark.Height property

Gets the height of this `SpreadsheetCellPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `SpreadsheetCellPossibleWatermark` in points.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/parent.md

#### SpreadsheetCellPossibleWatermark.Parent property

Gets the parent of this `SpreadsheetCellPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetCellPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/rotateangle.md

#### SpreadsheetCellPossibleWatermark.RotateAngle property

Gets the rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `SpreadsheetCellPossibleWatermark` in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/text.md

#### SpreadsheetCellPossibleWatermark.Text property

Gets or sets the text of this `SpreadsheetCellPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `SpreadsheetCellPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/unitofmeasurement.md

#### SpreadsheetCellPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `SpreadsheetCellPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `SpreadsheetCellPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/width.md

#### SpreadsheetCellPossibleWatermark.Width property

Gets the width of this `SpreadsheetCellPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `SpreadsheetCellPossibleWatermark` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/x.md

#### SpreadsheetCellPossibleWatermark.X property

Gets the horizontal offset of this `SpreadsheetCellPossibleWatermark` from content left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `SpreadsheetCellPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/y.md

#### SpreadsheetCellPossibleWatermark.Y property

Gets the vertical offset of this `SpreadsheetCellPossibleWatermark` from content top border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `SpreadsheetCellPossibleWatermark`.

### SpreadsheetChartBackgroundPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark.md

#### SpreadsheetChartBackgroundPossibleWatermark class

Represents possible image watermark in Excel chart background.

```csharp
public class SpreadsheetChartBackgroundPossibleWatermark : TwoDObjectPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetChartBackgroundPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `SpreadsheetChartBackgroundPossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `SpreadsheetChartBackgroundPossibleWatermark`. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/parent.md

#### SpreadsheetChartBackgroundPossibleWatermark.Parent property

Gets the parent of this `SpreadsheetChartBackgroundPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetChartBackgroundPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/rotateangle.md

#### SpreadsheetChartBackgroundPossibleWatermark.RotateAngle property

Gets the rotate angle of this `SpreadsheetChartBackgroundPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/unitofmeasurement.md

#### SpreadsheetChartBackgroundPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `SpreadsheetChartBackgroundPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `SpreadsheetChartBackgroundPossibleWatermark`.

### SpreadsheetHeaderFooterPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark.md

#### SpreadsheetHeaderFooterPossibleWatermark class

Represents possible watermark in a header or footer of an Excel document.

```csharp
public class SpreadsheetHeaderFooterPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `SpreadsheetHeaderFooterPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| override Width { get; } | Gets the width of this `SpreadsheetHeaderFooterPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet left border in points. |
| override Y { get; } | Gets the vertical offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet top border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/height.md

#### SpreadsheetHeaderFooterPossibleWatermark.Height property

Gets the height of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/parent.md

#### SpreadsheetHeaderFooterPossibleWatermark.Parent property

Gets the parent of this `SpreadsheetHeaderFooterPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetHeaderFooterPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/rotateangle.md

#### SpreadsheetHeaderFooterPossibleWatermark.RotateAngle property

Gets the rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `SpreadsheetHeaderFooterPossibleWatermark` in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/text.md

#### SpreadsheetHeaderFooterPossibleWatermark.Text property

Gets or sets the text of this `SpreadsheetHeaderFooterPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `SpreadsheetHeaderFooterPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/unitofmeasurement.md

#### SpreadsheetHeaderFooterPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `SpreadsheetHeaderFooterPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `SpreadsheetHeaderFooterPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/width.md

#### SpreadsheetHeaderFooterPossibleWatermark.Width property

Gets the width of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `SpreadsheetHeaderFooterPossibleWatermark` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/x.md

#### SpreadsheetHeaderFooterPossibleWatermark.X property

Gets the horizontal offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `SpreadsheetHeaderFooterPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/y.md

#### SpreadsheetHeaderFooterPossibleWatermark.Y property

Gets the vertical offset of this `SpreadsheetHeaderFooterPossibleWatermark` from worksheet top border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `SpreadsheetHeaderFooterPossibleWatermark`.

### SpreadsheetHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark.md

#### SpreadsheetHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in an Excel document.

```csharp
public class SpreadsheetHyperlinkPossibleWatermark : HyperlinkPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `SpreadsheetHyperlinkPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetHyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `SpreadsheetHyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `SpreadsheetHyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `SpreadsheetHyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `SpreadsheetHyperlinkPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet left border in points. |
| override Y { get; } | Gets the vertical offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet top border in points. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/height.md

#### SpreadsheetHyperlinkPossibleWatermark.Height property

Gets the height of this `SpreadsheetHyperlinkPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `SpreadsheetHyperlinkPossibleWatermark` in points.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/parent.md

#### SpreadsheetHyperlinkPossibleWatermark.Parent property

Gets the parent of this `SpreadsheetHyperlinkPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetHyperlinkPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/rotateangle.md

#### SpreadsheetHyperlinkPossibleWatermark.RotateAngle property

Gets the rotate angle of this `SpreadsheetHyperlinkPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/text.md

#### SpreadsheetHyperlinkPossibleWatermark.Text property

Gets or sets the url of this `SpreadsheetHyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `SpreadsheetHyperlinkPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/unitofmeasurement.md

#### SpreadsheetHyperlinkPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `SpreadsheetHyperlinkPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `SpreadsheetHyperlinkPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/width.md

#### SpreadsheetHyperlinkPossibleWatermark.Width property

Gets the width of this `SpreadsheetHyperlinkPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `SpreadsheetHyperlinkPossibleWatermark` in points.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/x.md

#### SpreadsheetHyperlinkPossibleWatermark.X property

Gets the horizontal offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/y.md

#### SpreadsheetHyperlinkPossibleWatermark.Y property

Gets the vertical offset of this `SpreadsheetHyperlinkPossibleWatermark` from worksheet top border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`.

### SpreadsheetShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark.md

#### SpreadsheetShapePossibleWatermark class

Represents possible shape watermark in an Excel document.

```csharp
public class SpreadsheetShapePossibleWatermark : ShapePossibleWatermark<SpreadsheetShape>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `SpreadsheetShapePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/parent.md

#### SpreadsheetShapePossibleWatermark.Parent property

Gets the parent of this `SpreadsheetShapePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `SpreadsheetShapePossibleWatermark`.

### WordProcessingShapePossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark.md

#### WordProcessingShapePossibleWatermark class

Represents possible shape watermark in a Word document.

```csharp
public class WordProcessingShapePossibleWatermark : ShapePossibleWatermark<WordProcessingShape>
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `WordProcessingShapePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/parent.md

#### WordProcessingShapePossibleWatermark.Parent property

Gets the parent of this `WordProcessingShapePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `WordProcessingShapePossibleWatermark`.

### WordProcessingTextHyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark.md

#### WordProcessingTextHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a Word document.

```csharp
public class WordProcessingTextHyperlinkPossibleWatermark : HyperlinkPossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/height.md

#### WordProcessingTextHyperlinkPossibleWatermark.Height property

Gets the height of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `WordProcessingTextHyperlinkPossibleWatermark`.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/parent.md

#### WordProcessingTextHyperlinkPossibleWatermark.Parent property

Gets the parent of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `WordProcessingTextHyperlinkPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/rotateangle.md

#### WordProcessingTextHyperlinkPossibleWatermark.RotateAngle property

Gets the rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark`.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/text.md

#### WordProcessingTextHyperlinkPossibleWatermark.Text property

Gets or sets the url of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `WordProcessingTextHyperlinkPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/unitofmeasurement.md

#### WordProcessingTextHyperlinkPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `WordProcessingTextHyperlinkPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/width.md

#### WordProcessingTextHyperlinkPossibleWatermark.Width property

Gets the width of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `WordProcessingTextHyperlinkPossibleWatermark`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/x.md

#### WordProcessingTextHyperlinkPossibleWatermark.X property

Gets the x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/y.md

#### WordProcessingTextHyperlinkPossibleWatermark.Y property

Gets the y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

### WordProcessingTextPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark.md

#### WordProcessingTextPossibleWatermark class

Represents possible watermark in a Word document text.

```csharp
public class WordProcessingTextPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`. |
| override Height { get; } | Gets the height of this `WordProcessingTextPossibleWatermark` in points. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `WordProcessingTextPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `WordProcessingTextPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the text of this `WordProcessingTextPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `WordProcessingTextPossibleWatermark`. |
| override Width { get; } | Gets the width of this `WordProcessingTextPossibleWatermark` in points. |
| override X { get; } | Gets the horizontal offset of this `WordProcessingTextPossibleWatermark` from document left border in points. |
| override Y { get; } | Gets the vertical offset of this `WordProcessingTextPossibleWatermark` from document top border in points. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/formattedtextfragments.md

#### WordProcessingTextPossibleWatermark.FormattedTextFragments property

Gets the collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`.

```csharp
public override FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/height.md

#### WordProcessingTextPossibleWatermark.Height property

Gets the height of this `WordProcessingTextPossibleWatermark` in points.

```csharp
public override double Height { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/parent.md

#### WordProcessingTextPossibleWatermark.Parent property

Gets the parent of this `WordProcessingTextPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `WordProcessingTextPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/rotateangle.md

#### WordProcessingTextPossibleWatermark.RotateAngle property

Gets the rotate angle of this `WordProcessingTextPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/text.md

#### WordProcessingTextPossibleWatermark.Text property

Gets or sets the text of this `WordProcessingTextPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of this `WordProcessingTextPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/unitofmeasurement.md

#### WordProcessingTextPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `WordProcessingTextPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `WordProcessingTextPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/width.md

#### WordProcessingTextPossibleWatermark.Width property

Gets the width of this `WordProcessingTextPossibleWatermark` in points.

```csharp
public override double Width { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/x.md

#### WordProcessingTextPossibleWatermark.X property

Gets the horizontal offset of this `WordProcessingTextPossibleWatermark` from document left border in points.

```csharp
public override double X { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/y.md

#### WordProcessingTextPossibleWatermark.Y property

Gets the vertical offset of this `WordProcessingTextPossibleWatermark` from document top border in points.

```csharp
public override double Y { get; }
```

##### Property Value

The value is always 0 for this type of possible watermark.

### GroupDocs.Watermark.Search
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search.md

The namespace provides classes for searching, editing and removing watermarks in documents of different types.

#### Classes

| Class | Description |
| --- | --- |
| AttachedImagePossibleWatermark&lt;T&gt; | Represents attached image watermark in a content of any supported format. |
| FloatingAttachedImagePossibleWatermark&lt;T&gt; | Represents attached image watermark in a content of any supported format. |
| FormattedTextFragment | Provides abstract base class for a fragment of formatted text in a content. |
| FormattedTextFragmentCollection | Represents a mutable collection of formatted text fragments. |
| HyperlinkPossibleWatermark | Represents possible hyperlink watermark in a PowerPoint content. |
| PossibleWatermark | Represents possible watermark found in a document. |
| PossibleWatermarkCollection | Represents a collection of possible watermarks found in a content. |
| ShapePossibleWatermark&lt;T&gt; | Represents shape watermark in a content of any supported format. |
| ShapeSearchAdapter | Provides base class for a shape containing specific pieces of document that are to be included in watermark search. |
| TwoDObjectPossibleWatermark | Represents 2D object watermark in a content of any supported format. |
#### Interfaces

| Interface | Description |
| --- | --- |
| IRotatableTwoDObject | Represents any rotatable two dimensional object in a content structure. |
| ITwoDObject | Represents any two dimensional object in a content structure. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FormattedTextFragmentCollectionType | Specifies the number of elements a formatted text fragment collection can contain. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### AttachedImagePossibleWatermarkT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1.md

#### AttachedImagePossibleWatermark&lt;T&gt; class

Represents attached image watermark in a content of any supported format.

```csharp
public abstract class AttachedImagePossibleWatermark<T> : PossibleWatermark
    where T : Attachment
```

| Parameter | Description |
| --- | --- |
| T | The type of the attachment. |

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `AttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `AttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `AttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `AttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `AttachedImagePossibleWatermark`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/height.md

#### AttachedImagePossibleWatermark&lt;T&gt;.Height property

Gets the height of this `AttachedImagePossibleWatermark`.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `AttachedImagePossibleWatermark`.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/parent.md

#### AttachedImagePossibleWatermark&lt;T&gt;.Parent property

Gets the parent of this `AttachedImagePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `AttachedImagePossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/rotateangle.md

#### AttachedImagePossibleWatermark&lt;T&gt;.RotateAngle property

Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `AttachedImagePossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/unitofmeasurement.md

#### AttachedImagePossibleWatermark&lt;T&gt;.UnitOfMeasurement property

Gets the unit of measurement of this `AttachedImagePossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `AttachedImagePossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/width.md

#### AttachedImagePossibleWatermark&lt;T&gt;.Width property

Gets the width of this `AttachedImagePossibleWatermark`.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `AttachedImagePossibleWatermark`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/x.md

#### AttachedImagePossibleWatermark&lt;T&gt;.X property

Gets the x-coordinate of this `AttachedImagePossibleWatermark`.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `AttachedImagePossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/attachedimagepossiblewatermark-1/y.md

#### AttachedImagePossibleWatermark&lt;T&gt;.Y property

Gets the y-coordinate of this `AttachedImagePossibleWatermark`.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `AttachedImagePossibleWatermark`.

### FloatingAttachedImagePossibleWatermarkT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt; class

Represents attached image watermark in a content of any supported format.

```csharp
public class FloatingAttachedImagePossibleWatermark<T> : AttachedImagePossibleWatermark<T>
    where T : Attachment, ITwoDObject
```

| Parameter | Description |
| --- | --- |
| T | The type of the attachment. |

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `FloatingAttachedImagePossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `FloatingAttachedImagePossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `AttachedImagePossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `AttachedImagePossibleWatermark`. |
| override Width { get; } | Gets the width of this `FloatingAttachedImagePossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `FloatingAttachedImagePossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `FloatingAttachedImagePossibleWatermark`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1/height.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt;.Height property

Gets the height of this `FloatingAttachedImagePossibleWatermark`.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `FloatingAttachedImagePossibleWatermark`.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1/parent.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt;.Parent property

Gets the parent of this `FloatingAttachedImagePossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `FloatingAttachedImagePossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1/width.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt;.Width property

Gets the width of this `FloatingAttachedImagePossibleWatermark`.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `FloatingAttachedImagePossibleWatermark`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1/x.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt;.X property

Gets the x-coordinate of this `FloatingAttachedImagePossibleWatermark`.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `FloatingAttachedImagePossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark-1/y.md

#### FloatingAttachedImagePossibleWatermark&lt;T&gt;.Y property

Gets the y-coordinate of this `FloatingAttachedImagePossibleWatermark`.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `FloatingAttachedImagePossibleWatermark`.

### FormattedTextFragment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragment.md

#### FormattedTextFragment class

Provides abstract base class for a fragment of formatted text in a content.

```csharp
public abstract class FormattedTextFragment
```

#### Properties

| Name | Description |
| --- | --- |
| abstract BackgroundColor { get; } | Gets the background color of the text. |
| abstract Font { get; } | Gets the font of the text. |
| abstract ForegroundColor { get; } | Gets the foreground color of the text. |
| abstract Text { get; } | Gets the fragment text. |

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragment/backgroundcolor.md

#### FormattedTextFragment.BackgroundColor property

Gets the background color of the text.

```csharp
public abstract Color BackgroundColor { get; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragment/font.md

#### FormattedTextFragment.Font property

Gets the font of the text.

```csharp
public abstract Font Font { get; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragment/foregroundcolor.md

#### FormattedTextFragment.ForegroundColor property

Gets the foreground color of the text.

```csharp
public abstract Color ForegroundColor { get; }
```

##### Property Value

The foreground color of the text.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragment/text.md

#### FormattedTextFragment.Text property

Gets the fragment text.

```csharp
public abstract string Text { get; }
```

##### Property Value

The fragment text.

### FormattedTextFragmentCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragmentcollection.md

#### FormattedTextFragmentCollection class

Represents a mutable collection of formatted text fragments.

```csharp
public class FormattedTextFragmentCollection : RemoveOnlyListBase<FormattedTextFragment>
```

#### Properties

| Name | Description |
| --- | --- |
| CollectionType { get; } | Gets the formatted fragment collection type. |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Add(string) | Adds a formatted text fragment to the collection. |
| Add(string, Font) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color) | Adds a formatted text fragment to the collection. |
| Add(string, Font, Color, Color) | Adds a formatted text fragment to the collection. |
| Clear() |  |
| virtual Contains(FormattedTextFragment) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(FormattedTextFragment) |  |
| Insert(int, string) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Insert(int, string, Font, Color, Color) | Inserts a formatted text fragment into the collection at a given index. |
| Remove(FormattedTextFragment) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `FormattedTextFragment` base type.

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragmentcollection/add.md

#### Add(string)

Adds a formatted text fragment to the collection.

```csharp
public void Add(string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The fragment text. |

#### Add(string, Font)

Adds a formatted text fragment to the collection.

```csharp
public void Add(string text, Font font)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The fragment text. |
| font | Font | The font of the text. |

#### Add(string, Font, Color)

Adds a formatted text fragment to the collection.

```csharp
public void Add(string text, Font font, Color foregroundColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |

#### Add(string, Font, Color, Color)

Adds a formatted text fragment to the collection.

```csharp
public void Add(string text, Font font, Color foregroundColor, Color backgroundColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |
| backgroundColor | Color | The background color of the text. |

### CollectionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragmentcollection/collectiontype.md

#### FormattedTextFragmentCollection.CollectionType property

Gets the formatted fragment collection type.

```csharp
public FormattedTextFragmentCollectionType CollectionType { get; }
```

##### Property Value

The formatted fragment collection type.

### Insert
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragmentcollection/insert.md

#### Insert(int, string)

Inserts a formatted text fragment into the collection at a given index.

```csharp
public void Insert(int index, string text)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index at which formatted text fragment should be inserted. |
| text | String | The fragment text. |

#### Insert(int, string, Font)

Inserts a formatted text fragment into the collection at a given index.

```csharp
public void Insert(int index, string text, Font font)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index at which formatted text fragment should be inserted. |
| text | String | The fragment text. |
| font | Font | The font of the text. |

#### Insert(int, string, Font, Color)

Inserts a formatted text fragment into the collection at a given index.

```csharp
public void Insert(int index, string text, Font font, Color foregroundColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index at which formatted text fragment should be inserted. |
| text | String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |

#### Insert(int, string, Font, Color, Color)

Inserts a formatted text fragment into the collection at a given index.

```csharp
public void Insert(int index, string text, Font font, Color foregroundColor, Color backgroundColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| index | Int32 | The zero-based index at which formatted text fragment should be inserted. |
| text | String | The fragment text. |
| font | Font | The font of the text. |
| foregroundColor | Color | The foreground color of the text. |
| backgroundColor | Color | The background color of the text. |

### FormattedTextFragmentCollectionType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/formattedtextfragmentcollectiontype.md

#### FormattedTextFragmentCollectionType enumeration

Specifies the number of elements a formatted text fragment collection can contain.

```csharp
public enum FormattedTextFragmentCollectionType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| UnlimitedFragments | `0` | Multiple styles are allowed, the collection can contain unlimited count of fragments. |
| SingleFragment | `1` | Whole text can be formatted with a single style, the collection can contain only one fragment. |
| NoFormattedText | `2` | Parent object doesn't support text formatting, the collection is always empty. |

### HyperlinkPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark.md

#### HyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a PowerPoint content.

```csharp
public class HyperlinkPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of this `HyperlinkPossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| override Parent { get; } | Gets the parent of this `HyperlinkPossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| override Text { get; set; } | Gets or sets the url of this `HyperlinkPossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of this `HyperlinkPossibleWatermark`. |
| override Width { get; } | Gets the width of this `HyperlinkPossibleWatermark`. |
| override X { get; } | Gets the x-coordinate of this `HyperlinkPossibleWatermark`. |
| override Y { get; } | Gets the y-coordinate of this `HyperlinkPossibleWatermark`. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/height.md

#### HyperlinkPossibleWatermark.Height property

Gets the height of this `HyperlinkPossibleWatermark`.

```csharp
public override double Height { get; }
```

##### Property Value

The height of this `HyperlinkPossibleWatermark`.

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/parent.md

#### HyperlinkPossibleWatermark.Parent property

Gets the parent of this `HyperlinkPossibleWatermark`.

```csharp
public override ContentPart Parent { get; }
```

##### Property Value

The parent of this `HyperlinkPossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/rotateangle.md

#### HyperlinkPossibleWatermark.RotateAngle property

Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `HyperlinkPossibleWatermark`.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/text.md

#### HyperlinkPossibleWatermark.Text property

Gets or sets the url of this `HyperlinkPossibleWatermark`.

```csharp
public override string Text { get; set; }
```

##### Property Value

The url of this `HyperlinkPossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/unitofmeasurement.md

#### HyperlinkPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `HyperlinkPossibleWatermark`.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `HyperlinkPossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/width.md

#### HyperlinkPossibleWatermark.Width property

Gets the width of this `HyperlinkPossibleWatermark`.

```csharp
public override double Width { get; }
```

##### Property Value

The width of this `HyperlinkPossibleWatermark`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/x.md

#### HyperlinkPossibleWatermark.X property

Gets the x-coordinate of this `HyperlinkPossibleWatermark`.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of this `HyperlinkPossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/hyperlinkpossiblewatermark/y.md

#### HyperlinkPossibleWatermark.Y property

Gets the y-coordinate of this `HyperlinkPossibleWatermark`.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of this `HyperlinkPossibleWatermark`.

### IRotatableTwoDObject
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/irotatabletwodobject.md

#### IRotatableTwoDObject interface

Represents any rotatable two dimensional object in a content structure.

```csharp
public interface IRotatableTwoDObject : ITwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| RotateAngle { get; } | Gets the rotate angle of the object in degrees. |

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/irotatabletwodobject/rotateangle.md

#### IRotatableTwoDObject.RotateAngle property

Gets the rotate angle of the object in degrees.

```csharp
public double RotateAngle { get; }
```

##### Property Value

The rotate angle of the object in degrees.

### ITwoDObject
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/itwodobject.md

#### ITwoDObject interface

Represents any two dimensional object in a content structure.

```csharp
public interface ITwoDObject
```

#### Properties

| Name | Description |
| --- | --- |
| Height { get; } | Gets the height of the object. |
| Width { get; } | Gets the width of the object. |
| X { get; } | Gets the x-coordinate of the object. |
| Y { get; } | Gets the y-coordinate of the object. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/itwodobject/height.md

#### ITwoDObject.Height property

Gets the height of the object.

```csharp
public double Height { get; }
```

##### Property Value

The height of the object.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/itwodobject/width.md

#### ITwoDObject.Width property

Gets the width of the object.

```csharp
public double Width { get; }
```

##### Property Value

The width of the object.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/itwodobject/x.md

#### ITwoDObject.X property

Gets the x-coordinate of the object.

```csharp
public double X { get; }
```

##### Property Value

The x-coordinate of the object.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/itwodobject/y.md

#### ITwoDObject.Y property

Gets the y-coordinate of the object.

```csharp
public double Y { get; }
```

##### Property Value

The y-coordinate of the object.

### PossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark.md

#### PossibleWatermark class

Represents possible watermark found in a document.

```csharp
public abstract class PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| virtual Height { get; } | Gets the height of this `PossibleWatermark`. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| abstract Parent { get; } | Gets the parent of this `PossibleWatermark`. |
| virtual RotateAngle { get; } | Gets the rotate angle of this `PossibleWatermark` in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| virtual UnitOfMeasurement { get; } | Gets the unit of measurement of this `PossibleWatermark`. |
| virtual Width { get; } | Gets the width of this `PossibleWatermark`. |
| virtual X { get; } | Gets the x-coordinate of this `PossibleWatermark`. |
| virtual Y { get; } | Gets the y-coordinate of this `PossibleWatermark`. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/formattedtextfragments.md

#### PossibleWatermark.FormattedTextFragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

```csharp
public virtual FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of this `PossibleWatermark`.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/height.md

#### PossibleWatermark.Height property

Gets the height of this `PossibleWatermark`.

```csharp
public virtual double Height { get; }
```

##### Property Value

The height of this `PossibleWatermark`.

### ImageData
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/imagedata.md

#### PossibleWatermark.ImageData property

Gets or sets the image of this `PossibleWatermark`.

```csharp
public byte[] ImageData { get; set; }
```

##### Property Value

The image of this `PossibleWatermark` or null if the watermark has no image.

### PageNumber
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/pagenumber.md

#### PossibleWatermark.PageNumber property

Gets the page watermark is placed on.

```csharp
public virtual int? PageNumber { get; }
```

### Parent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/parent.md

#### PossibleWatermark.Parent property

Gets the parent of this `PossibleWatermark`.

```csharp
public abstract ContentPart Parent { get; }
```

##### Property Value

The parent of this `PossibleWatermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/rotateangle.md

#### PossibleWatermark.RotateAngle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

```csharp
public virtual double RotateAngle { get; }
```

##### Property Value

The rotate angle of this `PossibleWatermark`.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/text.md

#### PossibleWatermark.Text property

Gets or sets the text of this `PossibleWatermark`.

```csharp
public virtual string Text { get; set; }
```

##### Property Value

The text of this `PossibleWatermark`.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/unitofmeasurement.md

#### PossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of this `PossibleWatermark`.

```csharp
public virtual UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of this `PossibleWatermark`.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/width.md

#### PossibleWatermark.Width property

Gets the width of this `PossibleWatermark`.

```csharp
public virtual double Width { get; }
```

##### Property Value

The width of this `PossibleWatermark`.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/x.md

#### PossibleWatermark.X property

Gets the x-coordinate of this `PossibleWatermark`.

```csharp
public virtual double X { get; }
```

##### Property Value

The x-coordinate of this `PossibleWatermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermark/y.md

#### PossibleWatermark.Y property

Gets the y-coordinate of this `PossibleWatermark`.

```csharp
public virtual double Y { get; }
```

##### Property Value

The y-coordinate of this `PossibleWatermark`.

### PossibleWatermarkCollection
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/possiblewatermarkcollection.md

#### PossibleWatermarkCollection class

Represents a collection of possible watermarks found in a content.

```csharp
public class PossibleWatermarkCollection : RemoveOnlyListBase<PossibleWatermark>
```

#### Properties

| Name | Description |
| --- | --- |
| virtual Count { get; } | Gets the number of elements contained in the collection. |
| override IsReadOnly { get; } | Gets a value indicating whether the collection is read-only. |
| virtual Item { get; } | Gets the element at the specified index in the collection. |

#### Methods

| Name | Description |
| --- | --- |
| Clear() |  |
| virtual Contains(PossibleWatermark) |  |
| virtual GetEnumerator() |  |
| virtual IndexOf(PossibleWatermark) |  |
| Remove(PossibleWatermark) |  |
| RemoveAt(int) |  |

##### Remarks

This collection contains the items of `PossibleWatermark` type.

### ShapePossibleWatermarkT
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapepossiblewatermark-1.md

#### ShapePossibleWatermark&lt;T&gt; class

Represents shape watermark in a content of any supported format.

```csharp
public abstract class ShapePossibleWatermark<T> : TwoDObjectPossibleWatermark
    where T : ShapeSearchAdapter, ITwoDObject
```

| Parameter | Description |
| --- | --- |
| T | The type of the shape. |

#### Properties

| Name | Description |
| --- | --- |
| override FormattedTextFragments { get; } | Gets the collection of formatted text fragments of the shape. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| override PageNumber { get; } | Gets the page watermark is placed on. |
| abstract Parent { get; } | Gets the parent of this `PossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the shape in degrees. |
| override Text { get; set; } | Gets or sets the text of the shape. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### FormattedTextFragments
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapepossiblewatermark-1/formattedtextfragments.md

#### ShapePossibleWatermark&lt;T&gt;.FormattedTextFragments property

Gets the collection of formatted text fragments of the shape.

```csharp
public override FormattedTextFragmentCollection FormattedTextFragments { get; }
```

##### Property Value

The collection of formatted text fragments of shape.

### PageNumber
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapepossiblewatermark-1/pagenumber.md

#### ShapePossibleWatermark&lt;T&gt;.PageNumber property

Gets the page watermark is placed on.

```csharp
public override int? PageNumber { get; }
```

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapepossiblewatermark-1/rotateangle.md

#### ShapePossibleWatermark&lt;T&gt;.RotateAngle property

Gets the rotate angle of the shape in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of the shape in degrees.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapepossiblewatermark-1/text.md

#### ShapePossibleWatermark&lt;T&gt;.Text property

Gets or sets the text of the shape.

```csharp
public override string Text { get; set; }
```

##### Property Value

The text of the shape.

### ShapeSearchAdapter
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/shapesearchadapter.md

#### ShapeSearchAdapter class

Provides base class for a shape containing specific pieces of document that are to be included in watermark search.

```csharp
public abstract class ShapeSearchAdapter
```

### TwoDObjectPossibleWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark.md

#### TwoDObjectPossibleWatermark class

Represents 2D object watermark in a content of any supported format.

```csharp
public abstract class TwoDObjectPossibleWatermark : PossibleWatermark
```

#### Properties

| Name | Description |
| --- | --- |
| virtual FormattedTextFragments { get; } | Gets the collection of formatted text fragments of this `PossibleWatermark`. |
| override Height { get; } | Gets the height of the 2D object. |
| ImageData { get; set; } | Gets or sets the image of this `PossibleWatermark`. |
| virtual PageNumber { get; } | Gets the page watermark is placed on. |
| abstract Parent { get; } | Gets the parent of this `PossibleWatermark`. |
| override RotateAngle { get; } | Gets the rotate angle of the 2D object in degrees. |
| virtual Text { get; set; } | Gets or sets the text of this `PossibleWatermark`. |
| override UnitOfMeasurement { get; } | Gets the unit of measurement of the 2D object. |
| override Width { get; } | Gets the width of the 2D object. |
| override X { get; } | Gets the x-coordinate of the 2D object. |
| override Y { get; } | Gets the y-coordinate of the 2D object. |

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/height.md

#### TwoDObjectPossibleWatermark.Height property

Gets the height of the 2D object.

```csharp
public override double Height { get; }
```

##### Property Value

The height of the 2D object.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/rotateangle.md

#### TwoDObjectPossibleWatermark.RotateAngle property

Gets the rotate angle of the 2D object in degrees.

```csharp
public override double RotateAngle { get; }
```

##### Property Value

The rotate angle of the 2D object in degrees.

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/unitofmeasurement.md

#### TwoDObjectPossibleWatermark.UnitOfMeasurement property

Gets the unit of measurement of the 2D object.

```csharp
public override UnitOfMeasurement UnitOfMeasurement { get; }
```

##### Property Value

The unit of measurement of the 2D object.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/width.md

#### TwoDObjectPossibleWatermark.Width property

Gets the width of the 2D object.

```csharp
public override double Width { get; }
```

##### Property Value

The width of the 2D object.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/x.md

#### TwoDObjectPossibleWatermark.X property

Gets the x-coordinate of the 2D object.

```csharp
public override double X { get; }
```

##### Property Value

The x-coordinate of the 2D object.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.search/twodobjectpossiblewatermark/y.md

#### TwoDObjectPossibleWatermark.Y property

Gets the y-coordinate of the 2D object.

```csharp
public override double Y { get; }
```

##### Property Value

The y-coordinate of the 2D object.

### GroupDocs.Watermark.Watermarks.Results
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results.md

#### Classes

| Class | Description |
| --- | --- |
| AddWatermarkResult | Represents the result of adding watermarks to a document. |
| BaseWatermarkResult | Describes base class for watermark result |
| ImageWatermarkResult | Contains Image watermark properties. |
| TextWatermarkResult | Contains Text watermark properties. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| WatermarkPosition | Defines watermark position in the document layout |
| WatermarkType | Defines supported types of watermarks for various processes |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### AddWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/addwatermarkresult.md

#### AddWatermarkResult class

Represents the result of adding watermarks to a document.

```csharp
public class AddWatermarkResult
```

#### Properties

| Name | Description |
| --- | --- |
| NumberAppliedWatermarks { get; } | Gets the number of applied watermarks. |
| Succeeded { get; } | List of newly created watermarks |

### NumberAppliedWatermarks
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/addwatermarkresult/numberappliedwatermarks.md

#### AddWatermarkResult.NumberAppliedWatermarks property

Gets the number of applied watermarks.

```csharp
public int NumberAppliedWatermarks { get; }
```

### Succeeded
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/addwatermarkresult/succeeded.md

#### AddWatermarkResult.Succeeded property

List of newly created watermarks

```csharp
public IEnumerable<BaseWatermarkResult> Succeeded { get; }
```

### BaseWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult.md

#### BaseWatermarkResult class

Describes base class for watermark result

```csharp
public abstract class BaseWatermarkResult
```

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the watermark creation date. |
| Height { get; set; } | Specifies height of watermark. |
| Left { get; set; } | Specifies left position of watermark. |
| ModifiedOn { get; set; } | Get or set the watermark modification date. |
| PageNumber { get; } | Specifies the page watermark was placed on. |
| Top { get; set; } | Specifies top position of watermark. |
| WatermarkId { get; } | Unique watermark identifier to modify watermark in the document over Update or Delete methods. This property will be set automatically after Add method being called. If this property was saved before it can be set manually to manipulate the watermark. |
| WatermarkPosition { get; } | Specifies watermark position |
| WatermarkType { get; } | Specifies the type of watermark. |
| Width { get; set; } | Specifies width of watermark. |

### CreatedOn
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/createdon.md

#### BaseWatermarkResult.CreatedOn property

Get or set the watermark creation date.

```csharp
public DateTime CreatedOn { get; set; }
```

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/height.md

#### BaseWatermarkResult.Height property

Specifies height of watermark.

```csharp
public int Height { get; set; }
```

### Left
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/left.md

#### BaseWatermarkResult.Left property

Specifies left position of watermark.

```csharp
public int Left { get; set; }
```

### ModifiedOn
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/modifiedon.md

#### BaseWatermarkResult.ModifiedOn property

Get or set the watermark modification date.

```csharp
public DateTime ModifiedOn { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/pagenumber.md

#### BaseWatermarkResult.PageNumber property

Specifies the page watermark was placed on.

```csharp
public int? PageNumber { get; }
```

### Top
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/top.md

#### BaseWatermarkResult.Top property

Specifies top position of watermark.

```csharp
public int Top { get; set; }
```

### WatermarkId
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermarkid.md

#### BaseWatermarkResult.WatermarkId property

Unique watermark identifier to modify watermark in the document over Update or Delete methods. This property will be set automatically after Add method being called. If this property was saved before it can be set manually to manipulate the watermark.

```csharp
public string WatermarkId { get; }
```

### WatermarkPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermarkposition.md

#### BaseWatermarkResult.WatermarkPosition property

Specifies watermark position

```csharp
public WatermarkPosition WatermarkPosition { get; }
```

### WatermarkType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermarktype.md

#### BaseWatermarkResult.WatermarkType property

Specifies the type of watermark.

```csharp
public WatermarkType WatermarkType { get; }
```

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/basewatermarkresult/width.md

#### BaseWatermarkResult.Width property

Specifies width of watermark.

```csharp
public int Width { get; set; }
```

### ImageWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/imagewatermarkresult.md

#### ImageWatermarkResult class

Contains Image watermark properties.

```csharp
public class ImageWatermarkResult : BaseWatermarkResult
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageWatermarkResult(string) | Initialize ImageWatermarkResult object with watermark identifier that was obtained after search process. This unique identifier is used to find additional properties for this watermark from document watermark information layer. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the watermark creation date. |
| Height { get; set; } | Specifies height of watermark. |
| Left { get; set; } | Specifies left position of watermark. |
| ModifiedOn { get; set; } | Get or set the watermark modification date. |
| PageNumber { get; } | Specifies the page watermark was placed on. |
| Size { get; } | Specifies the size in bytes of watermark image. |
| Top { get; set; } | Specifies top position of watermark. |
| WatermarkId { get; } | Unique watermark identifier to modify watermark in the document over Update or Delete methods. This property will be set automatically after Add method being called. If this property was saved before it can be set manually to manipulate the watermark. |
| WatermarkPosition { get; } | Specifies watermark position |
| WatermarkType { get; } | Specifies the type of watermark. |
| Width { get; set; } | Specifies width of watermark. |

### ImageWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/imagewatermarkresult/imagewatermarkresult.md

#### ImageWatermarkResult constructor

Initialize ImageWatermarkResult object with watermark identifier that was obtained after search process. This unique identifier is used to find additional properties for this watermark from document watermark information layer.

```csharp
public ImageWatermarkResult(string watermarkId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| watermarkId | String | Unique watermark identifier obtained by Sign or Search method of Signature class !:GroupDocs.Signature.Signature. |

### Size
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/imagewatermarkresult/size.md

#### ImageWatermarkResult.Size property

Specifies the size in bytes of watermark image.

```csharp
public int Size { get; }
```

### TextWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/textwatermarkresult.md

#### TextWatermarkResult class

Contains Text watermark properties.

```csharp
public class TextWatermarkResult : BaseWatermarkResult
```

#### Constructors

| Name | Description |
| --- | --- |
| TextWatermarkResult(string) | Initialize TextWatermarkResult object with watermark identifier that was obtained after search process. This unique identifier is used to find additional properties for this watermark from document watermark information layer. |

#### Properties

| Name | Description |
| --- | --- |
| CreatedOn { get; set; } | Get or set the watermark creation date. |
| Height { get; set; } | Specifies height of watermark. |
| Left { get; set; } | Specifies left position of watermark. |
| ModifiedOn { get; set; } | Get or set the watermark modification date. |
| PageNumber { get; } | Specifies the page watermark was placed on. |
| Text { get; set; } | Specifies text in watermark. |
| Top { get; set; } | Specifies top position of watermark. |
| WatermarkId { get; } | Unique watermark identifier to modify watermark in the document over Update or Delete methods. This property will be set automatically after Add method being called. If this property was saved before it can be set manually to manipulate the watermark. |
| WatermarkPosition { get; } | Specifies watermark position |
| WatermarkType { get; } | Specifies the type of watermark. |
| Width { get; set; } | Specifies width of watermark. |

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/textwatermarkresult/text.md

#### TextWatermarkResult.Text property

Specifies text in watermark.

```csharp
public string Text { get; set; }
```

### TextWatermarkResult
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/textwatermarkresult/textwatermarkresult.md

#### TextWatermarkResult constructor

Initialize TextWatermarkResult object with watermark identifier that was obtained after search process. This unique identifier is used to find additional properties for this watermark from document watermark information layer.

```csharp
public TextWatermarkResult(string watermarkId)
```

| Parameter | Type | Description |
| --- | --- | --- |
| watermarkId | String | Unique watermark identifier obtained by sign or search method. |

### WatermarkPosition
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/watermarkposition.md

#### WatermarkPosition enumeration

Defines watermark position in the document layout

```csharp
public enum WatermarkPosition
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Default | `1` | The Watermark is placed in the document body |
| HeaderFooter | `2` | The Watermark is placed in the document header or footer |
| Background | `3` | The watermark is placed as the background of the document |

### WatermarkType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.results/watermarktype.md

#### WatermarkType enumeration

Defines supported types of watermarks for various processes

```csharp
public enum WatermarkType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Text | `0` | The Text type |
| Image | `1` | The Image type |

### GroupDocs.Watermark.Watermarks
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks.md

The namespace provides classes to specify properties of watermarks.

#### Classes

| Class | Description |
| --- | --- |
| Font | Class representing a font. |
| ImageWatermark | Represents an image watermark. |
| Margins | Represents margin settings for each edge of an object. |
| MeasureValue | Represents a measurement value with a specific type and numerical value. |
| PagesSetup | Represents the setup for pages. |
| TextWatermark | Represents a text watermark. |
| Thickness | Describes the thickness of a frame around a rectangle. |
| TileOptions | Represents options for configuring watermarks in tile mode. |
#### Structures

| Structure | Description |
| --- | --- |
| Color | Structure representing a color. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| FontStyle | Represents a font style. |
| MarginType | Specifies how margin values should be interpreted. |
| SizingType | Specifies how watermark size should be calculated. |
| TextAlignment | Enumeration of possible text alignment values. |
| TileMeasureType | Represents measure types |
| TileType | Enumeration representing different visual templates for arranging watermark tiles. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### Color
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color.md

#### Color structure

Structure representing a color.

```csharp
public struct Color
```

#### Properties

| Name | Description |
| --- | --- |
| static AliceBlue { get; } | Gets a system-defined color. |
| static AntiqueWhite { get; } | Gets a system-defined color. |
| static Aqua { get; } | Gets a system-defined color. |
| static Aquamarine { get; } | Gets a system-defined color. |
| static Azure { get; } | Gets a system-defined color. |
| static Beige { get; } | Gets a system-defined color. |
| static Bisque { get; } | Gets a system-defined color. |
| static Black { get; } | Gets a system-defined color. |
| static BlanchedAlmond { get; } | Gets a system-defined color. |
| static Blue { get; } | Gets a system-defined color. |
| static BlueViolet { get; } | Gets a system-defined color. |
| static Brown { get; } | Gets a system-defined color. |
| static BurlyWood { get; } | Gets a system-defined color. |
| static CadetBlue { get; } | Gets a system-defined color. |
| static Chartreuse { get; } | Gets a system-defined color. |
| static Chocolate { get; } | Gets a system-defined color. |
| static Coral { get; } | Gets a system-defined color. |
| static CornflowerBlue { get; } | Gets a system-defined color. |
| static Cornsilk { get; } | Gets a system-defined color. |
| static Crimson { get; } | Gets a system-defined color. |
| static Cyan { get; } | Gets a system-defined color. |
| static DarkBlue { get; } | Gets a system-defined color. |
| static DarkCyan { get; } | Gets a system-defined color. |
| static DarkGoldenrod { get; } | Gets a system-defined color. |
| static DarkGray { get; } | Gets a system-defined color. |
| static DarkGreen { get; } | Gets a system-defined color. |
| static DarkKhaki { get; } | Gets a system-defined color. |
| static DarkMagenta { get; } | Gets a system-defined color. |
| static DarkOliveGreen { get; } | Gets a system-defined color. |
| static DarkOrange { get; } | Gets a system-defined color. |
| static DarkOrchid { get; } | Gets a system-defined color. |
| static DarkRed { get; } | Gets a system-defined color. |
| static DarkSalmon { get; } | Gets a system-defined color. |
| static DarkSeaGreen { get; } | Gets a system-defined color. |
| static DarkSlateBlue { get; } | Gets a system-defined color. |
| static DarkSlateGray { get; } | Gets a system-defined color. |
| static DarkTurquoise { get; } | Gets a system-defined color. |
| static DarkViolet { get; } | Gets a system-defined color. |
| static DeepPink { get; } | Gets a system-defined color. |
| static DeepSkyBlue { get; } | Gets a system-defined color. |
| static DimGray { get; } | Gets a system-defined color. |
| static DodgerBlue { get; } | Gets a system-defined color. |
| static Empty { get; } | Gets a system-defined color. |
| static Firebrick { get; } | Gets a system-defined color. |
| static FloralWhite { get; } | Gets a system-defined color. |
| static ForestGreen { get; } | Gets a system-defined color. |
| static Fuchsia { get; } | Gets a system-defined color. |
| static Gainsboro { get; } | Gets a system-defined color. |
| static GhostWhite { get; } | Gets a system-defined color. |
| static Gold { get; } | Gets a system-defined color. |
| static Goldenrod { get; } | Gets a system-defined color. |
| static Gray { get; } | Gets a system-defined color. |
| static Green { get; } | Gets a system-defined color. |
| static GreenYellow { get; } | Gets a system-defined color. |
| static Honeydew { get; } | Gets a system-defined color. |
| static HotPink { get; } | Gets a system-defined color. |
| static IndianRed { get; } | Gets a system-defined color. |
| static Indigo { get; } | Gets a system-defined color. |
| static Ivory { get; } | Gets a system-defined color. |
| static Khaki { get; } | Gets a system-defined color. |
| static Lavender { get; } | Gets a system-defined color. |
| static LavenderBlush { get; } | Gets a system-defined color. |
| static LawnGreen { get; } | Gets a system-defined color. |
| static LemonChiffon { get; } | Gets a system-defined color. |
| static LightBlue { get; } | Gets a system-defined color. |
| static LightCoral { get; } | Gets a system-defined color. |
| static LightCyan { get; } | Gets a system-defined color. |
| static LightGoldenrodYellow { get; } | Gets a system-defined color. |
| static LightGray { get; } | Gets a system-defined color. |
| static LightGreen { get; } | Gets a system-defined color. |
| static LightPink { get; } | Gets a system-defined color. |
| static LightSalmon { get; } | Gets a system-defined color. |
| static LightSeaGreen { get; } | Gets a system-defined color. |
| static LightSkyBlue { get; } | Gets a system-defined color. |
| static LightSlateGray { get; } | Gets a system-defined color. |
| static LightSteelBlue { get; } | Gets a system-defined color. |
| static LightYellow { get; } | Gets a system-defined color. |
| static Lime { get; } | Gets a system-defined color. |
| static LimeGreen { get; } | Gets a system-defined color. |
| static Linen { get; } | Gets a system-defined color. |
| static Magenta { get; } | Gets a system-defined color. |
| static Maroon { get; } | Gets a system-defined color. |
| static MediumAquamarine { get; } | Gets a system-defined color. |
| static MediumBlue { get; } | Gets a system-defined color. |
| static MediumOrchid { get; } | Gets a system-defined color. |
| static MediumPurple { get; } | Gets a system-defined color. |
| static MediumSeaGreen { get; } | Gets a system-defined color. |
| static MediumSlateBlue { get; } | Gets a system-defined color. |
| static MediumSpringGreen { get; } | Gets a system-defined color. |
| static MediumTurquoise { get; } | Gets a system-defined color. |
| static MediumVioletRed { get; } | Gets a system-defined color. |
| static MidnightBlue { get; } | Gets a system-defined color. |
| static MintCream { get; } | Gets a system-defined color. |
| static MistyRose { get; } | Gets a system-defined color. |
| static Moccasin { get; } | Gets a system-defined color. |
| static NavajoWhite { get; } | Gets a system-defined color. |
| static Navy { get; } | Gets a system-defined color. |
| static OldLace { get; } | Gets a system-defined color. |
| static Olive { get; } | Gets a system-defined color. |
| static OliveDrab { get; } | Gets a system-defined color. |
| static Orange { get; } | Gets a system-defined color. |
| static OrangeRed { get; } | Gets a system-defined color. |
| static Orchid { get; } | Gets a system-defined color. |
| static PaleGoldenrod { get; } | Gets a system-defined color. |
| static PaleGreen { get; } | Gets a system-defined color. |
| static PaleTurquoise { get; } | Gets a system-defined color. |
| static PaleVioletRed { get; } | Gets a system-defined color. |
| static PapayaWhip { get; } | Gets a system-defined color. |
| static PeachPuff { get; } | Gets a system-defined color. |
| static Peru { get; } | Gets a system-defined color. |
| static Pink { get; } | Gets a system-defined color. |
| static Plum { get; } | Gets a system-defined color. |
| static PowderBlue { get; } | Gets a system-defined color. |
| static Purple { get; } | Gets a system-defined color. |
| static Red { get; } | Gets a system-defined color. |
| static RosyBrown { get; } | Gets a system-defined color. |
| static RoyalBlue { get; } | Gets a system-defined color. |
| static SaddleBrown { get; } | Gets a system-defined color. |
| static Salmon { get; } | Gets a system-defined color. |
| static SandyBrown { get; } | Gets a system-defined color. |
| static SeaGreen { get; } | Gets a system-defined color. |
| static SeaShell { get; } | Gets a system-defined color. |
| static Sienna { get; } | Gets a system-defined color. |
| static Silver { get; } | Gets a system-defined color. |
| static SkyBlue { get; } | Gets a system-defined color. |
| static SlateBlue { get; } | Gets a system-defined color. |
| static SlateGray { get; } | Gets a system-defined color. |
| static Snow { get; } | Gets a system-defined color. |
| static SpringGreen { get; } | Gets a system-defined color. |
| static SteelBlue { get; } | Gets a system-defined color. |
| static Tan { get; } | Gets a system-defined color. |
| static Teal { get; } | Gets a system-defined color. |
| static Thistle { get; } | Gets a system-defined color. |
| static Tomato { get; } | Gets a system-defined color. |
| static Transparent { get; } | Gets a system-defined color. |
| static Turquoise { get; } | Gets a system-defined color. |
| static Violet { get; } | Gets a system-defined color. |
| static Wheat { get; } | Gets a system-defined color. |
| static White { get; } | Gets a system-defined color. |
| static WhiteSmoke { get; } | Gets a system-defined color. |
| static Yellow { get; } | Gets a system-defined color. |
| static YellowGreen { get; } | Gets a system-defined color. |
| A { get; } | Gets the alpha component value of the color. |
| B { get; } | Gets the blue component value of the color. |
| G { get; } | Gets the green component value of the color. |
| IsEmpty { get; } | Gets a value indicating whether this `Color` structure is uninitialized. |
| R { get; } | Gets the red component value of the color. |

#### Methods

| Name | Description |
| --- | --- |
| static FromArgb(int) | Creates a `Color` structure from a 32-bit ARGB value. |
| static FromArgb(int, Color) | Creates a `Color` structure from the specified `Color` structure, but with the new specified alpha value. |
| static FromArgb(int, int, int) | Creates a `Color` structure from the specified 8-bit color values (red, green, and blue) and the alpha value is implicitly 255 (fully opaque). |
| static FromArgb(int, int, int, int) | Creates a `Color` structure from the four ARGB component (alpha, red, green, and blue) values. |
| Equals(Color) | Determines whether the specified `Color` structure is equivalent to this `Color` structure. |
| override Equals(object) | Determines whether the specified object is a `Color`&gt; structure and is equivalent to this `Color` structure. |
| GetBrightness() | Gets the hue-saturation-brightness (HSB) brightness value for this `Color` structure. |
| override GetHashCode() | Gets a hash code for this `Color` structure. |
| GetHue() | Gets the hue-saturation-brightness (HSB) hue value, in degrees, for this `Color` structure. |
| GetSaturation() | Gets the hue-saturation-brightness (HSB) saturation value for this `Color` structure. |
| ToArgb() | Gets the 32-bit ARGB value of this `Color` structure. |
| operator == | Determines whether two specified `Color` structures are equivalent. |
| operator != | Determines whether two specified `Color` structures are different. |

### A
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/a.md

#### Color.A property

Gets the alpha component value of the color.

```csharp
public byte A { get; }
```

##### Property Value

The alpha component of the color. Valid values are 0 through 255.

### AliceBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/aliceblue.md

#### Color.AliceBlue property

Gets a system-defined color.

```csharp
public static Color AliceBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### AntiqueWhite
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/antiquewhite.md

#### Color.AntiqueWhite property

Gets a system-defined color.

```csharp
public static Color AntiqueWhite { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Aqua
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/aqua.md

#### Color.Aqua property

Gets a system-defined color.

```csharp
public static Color Aqua { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Aquamarine
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/aquamarine.md

#### Color.Aquamarine property

Gets a system-defined color.

```csharp
public static Color Aquamarine { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Azure
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/azure.md

#### Color.Azure property

Gets a system-defined color.

```csharp
public static Color Azure { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### B
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/b.md

#### Color.B property

Gets the blue component value of the color.

```csharp
public byte B { get; }
```

##### Property Value

The blue component of the color. Valid values are 0 through 255.

### Beige
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/beige.md

#### Color.Beige property

Gets a system-defined color.

```csharp
public static Color Beige { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Bisque
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/bisque.md

#### Color.Bisque property

Gets a system-defined color.

```csharp
public static Color Bisque { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Black
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/black.md

#### Color.Black property

Gets a system-defined color.

```csharp
public static Color Black { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### BlanchedAlmond
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/blanchedalmond.md

#### Color.BlanchedAlmond property

Gets a system-defined color.

```csharp
public static Color BlanchedAlmond { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Blue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/blue.md

#### Color.Blue property

Gets a system-defined color.

```csharp
public static Color Blue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### BlueViolet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/blueviolet.md

#### Color.BlueViolet property

Gets a system-defined color.

```csharp
public static Color BlueViolet { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Brown
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/brown.md

#### Color.Brown property

Gets a system-defined color.

```csharp
public static Color Brown { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### BurlyWood
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/burlywood.md

#### Color.BurlyWood property

Gets a system-defined color.

```csharp
public static Color BurlyWood { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### CadetBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/cadetblue.md

#### Color.CadetBlue property

Gets a system-defined color.

```csharp
public static Color CadetBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Chartreuse
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/chartreuse.md

#### Color.Chartreuse property

Gets a system-defined color.

```csharp
public static Color Chartreuse { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Chocolate
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/chocolate.md

#### Color.Chocolate property

Gets a system-defined color.

```csharp
public static Color Chocolate { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Coral
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/coral.md

#### Color.Coral property

Gets a system-defined color.

```csharp
public static Color Coral { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### CornflowerBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/cornflowerblue.md

#### Color.CornflowerBlue property

Gets a system-defined color.

```csharp
public static Color CornflowerBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Cornsilk
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/cornsilk.md

#### Color.Cornsilk property

Gets a system-defined color.

```csharp
public static Color Cornsilk { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Crimson
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/crimson.md

#### Color.Crimson property

Gets a system-defined color.

```csharp
public static Color Crimson { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Cyan
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/cyan.md

#### Color.Cyan property

Gets a system-defined color.

```csharp
public static Color Cyan { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkblue.md

#### Color.DarkBlue property

Gets a system-defined color.

```csharp
public static Color DarkBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkCyan
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkcyan.md

#### Color.DarkCyan property

Gets a system-defined color.

```csharp
public static Color DarkCyan { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkGoldenrod
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkgoldenrod.md

#### Color.DarkGoldenrod property

Gets a system-defined color.

```csharp
public static Color DarkGoldenrod { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkgray.md

#### Color.DarkGray property

Gets a system-defined color.

```csharp
public static Color DarkGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkgreen.md

#### Color.DarkGreen property

Gets a system-defined color.

```csharp
public static Color DarkGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkKhaki
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkkhaki.md

#### Color.DarkKhaki property

Gets a system-defined color.

```csharp
public static Color DarkKhaki { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkMagenta
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkmagenta.md

#### Color.DarkMagenta property

Gets a system-defined color.

```csharp
public static Color DarkMagenta { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkOliveGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkolivegreen.md

#### Color.DarkOliveGreen property

Gets a system-defined color.

```csharp
public static Color DarkOliveGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkOrange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkorange.md

#### Color.DarkOrange property

Gets a system-defined color.

```csharp
public static Color DarkOrange { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkOrchid
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkorchid.md

#### Color.DarkOrchid property

Gets a system-defined color.

```csharp
public static Color DarkOrchid { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkRed
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkred.md

#### Color.DarkRed property

Gets a system-defined color.

```csharp
public static Color DarkRed { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkSalmon
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darksalmon.md

#### Color.DarkSalmon property

Gets a system-defined color.

```csharp
public static Color DarkSalmon { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkSeaGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkseagreen.md

#### Color.DarkSeaGreen property

Gets a system-defined color.

```csharp
public static Color DarkSeaGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkSlateBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkslateblue.md

#### Color.DarkSlateBlue property

Gets a system-defined color.

```csharp
public static Color DarkSlateBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkSlateGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkslategray.md

#### Color.DarkSlateGray property

Gets a system-defined color.

```csharp
public static Color DarkSlateGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkTurquoise
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkturquoise.md

#### Color.DarkTurquoise property

Gets a system-defined color.

```csharp
public static Color DarkTurquoise { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DarkViolet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/darkviolet.md

#### Color.DarkViolet property

Gets a system-defined color.

```csharp
public static Color DarkViolet { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DeepPink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/deeppink.md

#### Color.DeepPink property

Gets a system-defined color.

```csharp
public static Color DeepPink { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DeepSkyBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/deepskyblue.md

#### Color.DeepSkyBlue property

Gets a system-defined color.

```csharp
public static Color DeepSkyBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DimGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/dimgray.md

#### Color.DimGray property

Gets a system-defined color.

```csharp
public static Color DimGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### DodgerBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/dodgerblue.md

#### Color.DodgerBlue property

Gets a system-defined color.

```csharp
public static Color DodgerBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Empty
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/empty.md

#### Color.Empty property

Gets a system-defined color.

```csharp
public static Color Empty { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Equals
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/equals.md

#### Equals(Color)

Determines whether the specified `Color` structure is equivalent to this `Color` structure.

```csharp
public bool Equals(Color other)
```

| Parameter | Type | Description |
| --- | --- | --- |
| other | Color | The color to test. |

##### Return Value

True if other is equivalent to this `Color` structure; otherwise, false.

#### Equals(object)

Determines whether the specified object is a `Color`&gt; structure and is equivalent to this `Color` structure.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The object to test. |

##### Return Value

True if object is a `Color` structure equivalent to this `Color` structure; otherwise, false.

### Firebrick
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/firebrick.md

#### Color.Firebrick property

Gets a system-defined color.

```csharp
public static Color Firebrick { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### FloralWhite
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/floralwhite.md

#### Color.FloralWhite property

Gets a system-defined color.

```csharp
public static Color FloralWhite { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### ForestGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/forestgreen.md

#### Color.ForestGreen property

Gets a system-defined color.

```csharp
public static Color ForestGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### FromArgb
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/fromargb.md

#### FromArgb(int)

Creates a `Color` structure from a 32-bit ARGB value.

```csharp
public static Color FromArgb(int argb)
```

| Parameter | Type | Description |
| --- | --- | --- |
| argb | Int32 | A value specifying the 32-bit ARGB value. |

##### Return Value

The `Color` structure that this method creates.

#### FromArgb(int, Color)

Creates a `Color` structure from the specified `Color` structure, but with the new specified alpha value.

```csharp
public static Color FromArgb(int alpha, Color baseColor)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alpha | Int32 | The alpha value for the new `Color`. Valid values are 0 through 255. |
| baseColor | Color | The `Color` from which to create the new `Color`. |

##### Return Value

The `Color` that this method creates.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Alpha is less than 0 or greater than 255. |

##### Remarks

Although this method allows a 32-bit value to be passed for the alpha value, the value is limited to 8 bits.

#### FromArgb(int, int, int)

Creates a `Color` structure from the specified 8-bit color values (red, green, and blue) and the alpha value is implicitly 255 (fully opaque).

```csharp
public static Color FromArgb(int red, int green, int blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| red | Int32 | The red component value for the new `Color`. Valid values are 0 through 255. |
| green | Int32 | The green component value for the new `Color`. Valid values are 0 through 255. |
| blue | Int32 | The blue component value for the new `Color`. Valid values are 0 through 255. |

##### Return Value

The `Color` that this method creates.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Red, green, or blue is less than 0 or greater than 255. |

##### Remarks

Although this method allows a 32-bit value to be passed for each color component, the value of each component is limited to 8 bits.

#### FromArgb(int, int, int, int)

Creates a `Color` structure from the four ARGB component (alpha, red, green, and blue) values.

```csharp
public static Color FromArgb(int alpha, int red, int green, int blue)
```

| Parameter | Type | Description |
| --- | --- | --- |
| alpha | Int32 | The alpha component value for the new `Color`. Valid values are 0 through 255. |
| red | Int32 | The red component value for the new `Color`. Valid values are 0 through 255. |
| green | Int32 | The green component value for the new `Color`. Valid values are 0 through 255. |
| blue | Int32 | The blue component value for the new `Color`. Valid values are 0 through 255. |

##### Return Value

The `Color` that this method creates.

##### Exceptions

| exception | condition |
| --- | --- |
| ArgumentOutOfRangeException | Red, green, or blue is less than 0 or greater than 255. |

##### Remarks

Although this method allows a 32-bit value to be passed for each component, the value of each component is limited to 8 bits.

### Fuchsia
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/fuchsia.md

#### Color.Fuchsia property

Gets a system-defined color.

```csharp
public static Color Fuchsia { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### G
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/g.md

#### Color.G property

Gets the green component value of the color.

```csharp
public byte G { get; }
```

##### Property Value

The green component of the color. Valid values are 0 through 255.

### Gainsboro
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/gainsboro.md

#### Color.Gainsboro property

Gets a system-defined color.

```csharp
public static Color Gainsboro { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### GetBrightness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/getbrightness.md

#### Color.GetBrightness method

Gets the hue-saturation-brightness (HSB) brightness value for this `Color` structure.

```csharp
public float GetBrightness()
```

##### Return Value

The brightness of this `Color`. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

### GetHashCode
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/gethashcode.md

#### Color.GetHashCode method

Gets a hash code for this `Color` structure.

```csharp
public override int GetHashCode()
```

##### Return Value

An integer value that specifies the hash code for this `Color`

### GetHue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/gethue.md

#### Color.GetHue method

Gets the hue-saturation-brightness (HSB) hue value, in degrees, for this `Color` structure.

```csharp
public float GetHue()
```

##### Return Value

The hue, in degrees, of this `Color`. The hue is measured in degrees, ranging from 0.0 through 360.0, in HSB color space.

### GetSaturation
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/getsaturation.md

#### Color.GetSaturation method

Gets the hue-saturation-brightness (HSB) saturation value for this `Color` structure.

```csharp
public float GetSaturation()
```

##### Return Value

The saturation of this `Color`. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

### GhostWhite
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/ghostwhite.md

#### Color.GhostWhite property

Gets a system-defined color.

```csharp
public static Color GhostWhite { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Gold
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/gold.md

#### Color.Gold property

Gets a system-defined color.

```csharp
public static Color Gold { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Goldenrod
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/goldenrod.md

#### Color.Goldenrod property

Gets a system-defined color.

```csharp
public static Color Goldenrod { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Gray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/gray.md

#### Color.Gray property

Gets a system-defined color.

```csharp
public static Color Gray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Green
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/green.md

#### Color.Green property

Gets a system-defined color.

```csharp
public static Color Green { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### GreenYellow
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/greenyellow.md

#### Color.GreenYellow property

Gets a system-defined color.

```csharp
public static Color GreenYellow { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Honeydew
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/honeydew.md

#### Color.Honeydew property

Gets a system-defined color.

```csharp
public static Color Honeydew { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### HotPink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/hotpink.md

#### Color.HotPink property

Gets a system-defined color.

```csharp
public static Color HotPink { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### IndianRed
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/indianred.md

#### Color.IndianRed property

Gets a system-defined color.

```csharp
public static Color IndianRed { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Indigo
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/indigo.md

#### Color.Indigo property

Gets a system-defined color.

```csharp
public static Color Indigo { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### IsEmpty
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/isempty.md

#### Color.IsEmpty property

Gets a value indicating whether this `Color` structure is uninitialized.

```csharp
public bool IsEmpty { get; }
```

##### Property Value

This property returns true if this color is uninitialized; otherwise, false.

### Ivory
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/ivory.md

#### Color.Ivory property

Gets a system-defined color.

```csharp
public static Color Ivory { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Khaki
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/khaki.md

#### Color.Khaki property

Gets a system-defined color.

```csharp
public static Color Khaki { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Lavender
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lavender.md

#### Color.Lavender property

Gets a system-defined color.

```csharp
public static Color Lavender { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LavenderBlush
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lavenderblush.md

#### Color.LavenderBlush property

Gets a system-defined color.

```csharp
public static Color LavenderBlush { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LawnGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lawngreen.md

#### Color.LawnGreen property

Gets a system-defined color.

```csharp
public static Color LawnGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LemonChiffon
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lemonchiffon.md

#### Color.LemonChiffon property

Gets a system-defined color.

```csharp
public static Color LemonChiffon { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightblue.md

#### Color.LightBlue property

Gets a system-defined color.

```csharp
public static Color LightBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightCoral
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightcoral.md

#### Color.LightCoral property

Gets a system-defined color.

```csharp
public static Color LightCoral { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightCyan
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightcyan.md

#### Color.LightCyan property

Gets a system-defined color.

```csharp
public static Color LightCyan { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightGoldenrodYellow
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightgoldenrodyellow.md

#### Color.LightGoldenrodYellow property

Gets a system-defined color.

```csharp
public static Color LightGoldenrodYellow { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightgray.md

#### Color.LightGray property

Gets a system-defined color.

```csharp
public static Color LightGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightgreen.md

#### Color.LightGreen property

Gets a system-defined color.

```csharp
public static Color LightGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightPink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightpink.md

#### Color.LightPink property

Gets a system-defined color.

```csharp
public static Color LightPink { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightSalmon
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightsalmon.md

#### Color.LightSalmon property

Gets a system-defined color.

```csharp
public static Color LightSalmon { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightSeaGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightseagreen.md

#### Color.LightSeaGreen property

Gets a system-defined color.

```csharp
public static Color LightSeaGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightSkyBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightskyblue.md

#### Color.LightSkyBlue property

Gets a system-defined color.

```csharp
public static Color LightSkyBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightSlateGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightslategray.md

#### Color.LightSlateGray property

Gets a system-defined color.

```csharp
public static Color LightSlateGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightSteelBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightsteelblue.md

#### Color.LightSteelBlue property

Gets a system-defined color.

```csharp
public static Color LightSteelBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LightYellow
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lightyellow.md

#### Color.LightYellow property

Gets a system-defined color.

```csharp
public static Color LightYellow { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Lime
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/lime.md

#### Color.Lime property

Gets a system-defined color.

```csharp
public static Color Lime { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### LimeGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/limegreen.md

#### Color.LimeGreen property

Gets a system-defined color.

```csharp
public static Color LimeGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Linen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/linen.md

#### Color.Linen property

Gets a system-defined color.

```csharp
public static Color Linen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Magenta
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/magenta.md

#### Color.Magenta property

Gets a system-defined color.

```csharp
public static Color Magenta { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Maroon
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/maroon.md

#### Color.Maroon property

Gets a system-defined color.

```csharp
public static Color Maroon { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumAquamarine
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumaquamarine.md

#### Color.MediumAquamarine property

Gets a system-defined color.

```csharp
public static Color MediumAquamarine { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumblue.md

#### Color.MediumBlue property

Gets a system-defined color.

```csharp
public static Color MediumBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumOrchid
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumorchid.md

#### Color.MediumOrchid property

Gets a system-defined color.

```csharp
public static Color MediumOrchid { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumPurple
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumpurple.md

#### Color.MediumPurple property

Gets a system-defined color.

```csharp
public static Color MediumPurple { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumSeaGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumseagreen.md

#### Color.MediumSeaGreen property

Gets a system-defined color.

```csharp
public static Color MediumSeaGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumSlateBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumslateblue.md

#### Color.MediumSlateBlue property

Gets a system-defined color.

```csharp
public static Color MediumSlateBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumSpringGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumspringgreen.md

#### Color.MediumSpringGreen property

Gets a system-defined color.

```csharp
public static Color MediumSpringGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumTurquoise
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumturquoise.md

#### Color.MediumTurquoise property

Gets a system-defined color.

```csharp
public static Color MediumTurquoise { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MediumVioletRed
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mediumvioletred.md

#### Color.MediumVioletRed property

Gets a system-defined color.

```csharp
public static Color MediumVioletRed { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MidnightBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/midnightblue.md

#### Color.MidnightBlue property

Gets a system-defined color.

```csharp
public static Color MidnightBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MintCream
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mintcream.md

#### Color.MintCream property

Gets a system-defined color.

```csharp
public static Color MintCream { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### MistyRose
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/mistyrose.md

#### Color.MistyRose property

Gets a system-defined color.

```csharp
public static Color MistyRose { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Moccasin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/moccasin.md

#### Color.Moccasin property

Gets a system-defined color.

```csharp
public static Color Moccasin { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### NavajoWhite
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/navajowhite.md

#### Color.NavajoWhite property

Gets a system-defined color.

```csharp
public static Color NavajoWhite { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Navy
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/navy.md

#### Color.Navy property

Gets a system-defined color.

```csharp
public static Color Navy { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### OldLace
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/oldlace.md

#### Color.OldLace property

Gets a system-defined color.

```csharp
public static Color OldLace { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Olive
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/olive.md

#### Color.Olive property

Gets a system-defined color.

```csharp
public static Color Olive { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### OliveDrab
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/olivedrab.md

#### Color.OliveDrab property

Gets a system-defined color.

```csharp
public static Color OliveDrab { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### op_Equality
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/op_equality.md

#### Color Equality operator

Determines whether two specified `Color` structures are equivalent.

```csharp
public static bool operator ==(Color left, Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Color | The `Color` that is to the left of the equality operator. |
| right | Color | The `Color` that is to the right of the equality operator. |

##### Return Value

True if the two `Color` structures are equal; otherwise, false.

### op_Inequality
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/op_inequality.md

#### Color Inequality operator

Determines whether two specified `Color` structures are different.

```csharp
public static bool operator !=(Color left, Color right)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Color | The `Color` that is to the left of the inequality operator. |
| right | Color | The `Color` that is to the right of the inequality operator. |

##### Return Value

True if the two `Color` structures are different; otherwise, false.

### Orange
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/orange.md

#### Color.Orange property

Gets a system-defined color.

```csharp
public static Color Orange { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### OrangeRed
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/orangered.md

#### Color.OrangeRed property

Gets a system-defined color.

```csharp
public static Color OrangeRed { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Orchid
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/orchid.md

#### Color.Orchid property

Gets a system-defined color.

```csharp
public static Color Orchid { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PaleGoldenrod
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/palegoldenrod.md

#### Color.PaleGoldenrod property

Gets a system-defined color.

```csharp
public static Color PaleGoldenrod { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PaleGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/palegreen.md

#### Color.PaleGreen property

Gets a system-defined color.

```csharp
public static Color PaleGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PaleTurquoise
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/paleturquoise.md

#### Color.PaleTurquoise property

Gets a system-defined color.

```csharp
public static Color PaleTurquoise { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PaleVioletRed
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/palevioletred.md

#### Color.PaleVioletRed property

Gets a system-defined color.

```csharp
public static Color PaleVioletRed { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PapayaWhip
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/papayawhip.md

#### Color.PapayaWhip property

Gets a system-defined color.

```csharp
public static Color PapayaWhip { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PeachPuff
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/peachpuff.md

#### Color.PeachPuff property

Gets a system-defined color.

```csharp
public static Color PeachPuff { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Peru
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/peru.md

#### Color.Peru property

Gets a system-defined color.

```csharp
public static Color Peru { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Pink
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/pink.md

#### Color.Pink property

Gets a system-defined color.

```csharp
public static Color Pink { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Plum
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/plum.md

#### Color.Plum property

Gets a system-defined color.

```csharp
public static Color Plum { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### PowderBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/powderblue.md

#### Color.PowderBlue property

Gets a system-defined color.

```csharp
public static Color PowderBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Purple
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/purple.md

#### Color.Purple property

Gets a system-defined color.

```csharp
public static Color Purple { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### R
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/r.md

#### Color.R property

Gets the red component value of the color.

```csharp
public byte R { get; }
```

##### Property Value

The red component of the color. Valid values are 0 through 255.

### Red
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/red.md

#### Color.Red property

Gets a system-defined color.

```csharp
public static Color Red { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### RosyBrown
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/rosybrown.md

#### Color.RosyBrown property

Gets a system-defined color.

```csharp
public static Color RosyBrown { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### RoyalBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/royalblue.md

#### Color.RoyalBlue property

Gets a system-defined color.

```csharp
public static Color RoyalBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SaddleBrown
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/saddlebrown.md

#### Color.SaddleBrown property

Gets a system-defined color.

```csharp
public static Color SaddleBrown { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Salmon
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/salmon.md

#### Color.Salmon property

Gets a system-defined color.

```csharp
public static Color Salmon { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SandyBrown
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/sandybrown.md

#### Color.SandyBrown property

Gets a system-defined color.

```csharp
public static Color SandyBrown { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SeaGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/seagreen.md

#### Color.SeaGreen property

Gets a system-defined color.

```csharp
public static Color SeaGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SeaShell
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/seashell.md

#### Color.SeaShell property

Gets a system-defined color.

```csharp
public static Color SeaShell { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Sienna
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/sienna.md

#### Color.Sienna property

Gets a system-defined color.

```csharp
public static Color Sienna { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Silver
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/silver.md

#### Color.Silver property

Gets a system-defined color.

```csharp
public static Color Silver { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SkyBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/skyblue.md

#### Color.SkyBlue property

Gets a system-defined color.

```csharp
public static Color SkyBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SlateBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/slateblue.md

#### Color.SlateBlue property

Gets a system-defined color.

```csharp
public static Color SlateBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SlateGray
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/slategray.md

#### Color.SlateGray property

Gets a system-defined color.

```csharp
public static Color SlateGray { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Snow
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/snow.md

#### Color.Snow property

Gets a system-defined color.

```csharp
public static Color Snow { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SpringGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/springgreen.md

#### Color.SpringGreen property

Gets a system-defined color.

```csharp
public static Color SpringGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### SteelBlue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/steelblue.md

#### Color.SteelBlue property

Gets a system-defined color.

```csharp
public static Color SteelBlue { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Tan
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/tan.md

#### Color.Tan property

Gets a system-defined color.

```csharp
public static Color Tan { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Teal
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/teal.md

#### Color.Teal property

Gets a system-defined color.

```csharp
public static Color Teal { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Thistle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/thistle.md

#### Color.Thistle property

Gets a system-defined color.

```csharp
public static Color Thistle { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### ToArgb
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/toargb.md

#### Color.ToArgb method

Gets the 32-bit ARGB value of this `Color` structure.

```csharp
public int ToArgb()
```

##### Return Value

The 32-bit ARGB value of this `Color` structure.

### Tomato
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/tomato.md

#### Color.Tomato property

Gets a system-defined color.

```csharp
public static Color Tomato { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Transparent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/transparent.md

#### Color.Transparent property

Gets a system-defined color.

```csharp
public static Color Transparent { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Turquoise
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/turquoise.md

#### Color.Turquoise property

Gets a system-defined color.

```csharp
public static Color Turquoise { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Violet
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/violet.md

#### Color.Violet property

Gets a system-defined color.

```csharp
public static Color Violet { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Wheat
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/wheat.md

#### Color.Wheat property

Gets a system-defined color.

```csharp
public static Color Wheat { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### White
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/white.md

#### Color.White property

Gets a system-defined color.

```csharp
public static Color White { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### WhiteSmoke
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/whitesmoke.md

#### Color.WhiteSmoke property

Gets a system-defined color.

```csharp
public static Color WhiteSmoke { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Yellow
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/yellow.md

#### Color.Yellow property

Gets a system-defined color.

```csharp
public static Color Yellow { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### YellowGreen
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/color/yellowgreen.md

#### Color.YellowGreen property

Gets a system-defined color.

```csharp
public static Color YellowGreen { get; }
```

##### Property Value

A `Color` representing a system-defined color.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font.md

#### Font class

Class representing a font.

```csharp
public sealed class Font
```

#### Constructors

| Name | Description |
| --- | --- |
| Font(string, float) | Initializes a new instance of the `Font` class with a specified font family name and a size. |
| Font(string, float, FontStyle) | Initializes a new instance of the `Font` class with a specified font family name, a size and a style. |
| Font(string, string, float) | Initializes a new instance of the `Font` class with a specified custom font family name, folder path with a font and a size. |
| Font(string, string, float, FontStyle) | Initializes a new instance of the `Font` class with a specified custom font family name, folder path with a font and a size. |

#### Properties

| Name | Description |
| --- | --- |
| Bold { get; } | Gets a value indicating whether the font is bold. |
| FamilyName { get; } | Gets the family name of this `Font`. |
| FolderPath { get; } | Represents the folder that contains TrueType font files. |
| Italic { get; } | Gets a value indicating whether the font is italic. |
| Size { get; } | Gets the size of this `Font`. |
| Strikeout { get; } | Gets a value indicating whether the font specifies a horizontal line through the font. |
| Style { get; } | Gets the style information for this `Font`. |
| Underline { get; } | Gets a value indicating whether the font is underlined. |

### Bold
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/bold.md

#### Font.Bold property

Gets a value indicating whether the font is bold.

```csharp
public bool Bold { get; }
```

##### Property Value

True if this font is bold; otherwise, false.

### FamilyName
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/familyname.md

#### Font.FamilyName property

Gets the family name of this `Font`.

```csharp
public string FamilyName { get; }
```

##### Property Value

The family name of this `Font`.

### FolderPath
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/folderpath.md

#### Font.FolderPath property

Represents the folder that contains TrueType font files.

```csharp
public string FolderPath { get; }
```

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/font.md

#### Font(string, float)

Initializes a new instance of the `Font` class with a specified font family name and a size.

```csharp
public Font(string fontFamilyName, float size)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | String | The font family name. |
| size | Single | The size of the new font. |

#### Font(string, float, FontStyle)

Initializes a new instance of the `Font` class with a specified font family name, a size and a style.

```csharp
public Font(string fontFamilyName, float size, FontStyle style)
```

| Parameter | Type | Description |
| --- | --- | --- |
| fontFamilyName | String | The font family name. |
| size | Single | The size of the new font. |
| style | FontStyle | The style of the new font. |

#### Font(string, string, float)

Initializes a new instance of the `Font` class with a specified custom font family name, folder path with a font and a size.

```csharp
public Font(string fontFamilyName, string folderPath, float size)
```

| Parameter | Description |
| --- | --- |
| fontFamilyName | The font family name. |
| folderPath | Folder path which contains TrueType font files |
| size | The size of the new font. |
| style | The style of the new font. |

#### Font(string, string, float, FontStyle)

Initializes a new instance of the `Font` class with a specified custom font family name, folder path with a font and a size.

```csharp
public Font(string fontFamilyName, string folderPath, float size, FontStyle style)
```

| Parameter | Description |
| --- | --- |
| fontFamilyName | The font family name. |
| folderPath | Folder path which contains TrueType font files |
| size | The size of the new font. |

### Italic
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/italic.md

#### Font.Italic property

Gets a value indicating whether the font is italic.

```csharp
public bool Italic { get; }
```

##### Property Value

True if this font is italic; otherwise, false.

### Size
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/size.md

#### Font.Size property

Gets the size of this `Font`.

```csharp
public float Size { get; }
```

##### Property Value

The size of this `Font`.

### Strikeout
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/strikeout.md

#### Font.Strikeout property

Gets a value indicating whether the font specifies a horizontal line through the font.

```csharp
public bool Strikeout { get; }
```

##### Property Value

True if this font specifies a horizontal line through the font; otherwise, false.

### Style
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/style.md

#### Font.Style property

Gets the style information for this `Font`.

```csharp
public FontStyle Style { get; }
```

##### Property Value

The style of this `Font`.

##### Remarks

Default value is Regular (normal text).

### Underline
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/font/underline.md

#### Font.Underline property

Gets a value indicating whether the font is underlined.

```csharp
public bool Underline { get; }
```

##### Property Value

True if this font is underlined; otherwise, false.

### FontStyle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/fontstyle.md

#### FontStyle enumeration

Represents a font style.

```csharp
[Flags]
public enum FontStyle
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Regular | `0` | Normal text. |
| Bold | `1` | Bold text. |
| Italic | `2` | Italic text. |
| Underline | `4` | Underlined text. |
| Strikeout | `8` | Text with a line through the middle. |

### ImageWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/imagewatermark.md

#### ImageWatermark class

Represents an image watermark.

```csharp
public sealed class ImageWatermark : Watermark, IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| ImageWatermark(Stream) | Initializes a new instance of the `ImageWatermark` class with a specified stream. |
| ImageWatermark(string) | Initializes a new instance of the `ImageWatermark` class with a specified file path. |

#### Properties

| Name | Description |
| --- | --- |
| ConsiderParentMargins { get; set; } | Gets or sets a value indicating whether the watermark size and coordinates are calculated considering parent margins. |
| Height { get; set; } | Gets or sets the desired height of this `Watermark`. |
| HorizontalAlignment { get; set; } | Gets or sets the horizontal alignment of this `Watermark`. |
| IsBackground { get; set; } | Gets or sets a value indicating whether the watermark should be placed at background. |
| Margins { get; set; } | Gets or sets the margin settings of this `Watermark`. |
| Opacity { get; set; } | Gets or sets the opacity of this `Watermark`. |
| PagesSetup { get; set; } | Gets or sets the pages setup settings of this `Watermark`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `Watermark` in degrees. |
| SaveResultInMetadata { get; set; } | Gets or sets a value indicating whether to save information about added watermarks in the document metadata. |
| ScaleFactor { get; set; } | Gets or sets a value that defines how watermark size depends on parent size. |
| SizingType { get; set; } | Gets or sets a value specifying a way watermark should be sized. |
| TileOptions { get; set; } | Get or sets options to define repeated watermark |
| VerticalAlignment { get; set; } | Gets or sets the vertical alignment of this `Watermark`. |
| Width { get; set; } | Gets or sets the desired width of this `Watermark`. |
| X { get; set; } | Gets or sets the x-coordinate of this `Watermark`. |
| Y { get; set; } | Gets or sets the y-coordinate of this `Watermark`. |

#### Methods

| Name | Description |
| --- | --- |
| Dispose() | Disposes the current instance. |

##### Remarks

**Learn more:**

* [Adding image watermarks](https://docs.groupdocs.com/display/watermarknet/Adding+image+watermarks)

##### Examples

Add image watermark to a document of any supported type.

```csharp
foreach (string filePath in Directory.GetFiles(@"C:\Documents"))
{
    using (Watermarker watermarker = new Watermarker(filePath))
    {
        using (ImageWatermark watermark = new ImageWatermark(@"C:\watermark.png"))
        {
            watermark.HorizontalAlignment = HorizontalAlignment.Center;
            watermark.VerticalAlignment = VerticalAlignment.Center;
            watermarker.Add(watermark);
        }

        watermarker.Save();
    }
}
```

### Dispose
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/imagewatermark/dispose.md

#### ImageWatermark.Dispose method

Disposes the current instance.

```csharp
public void Dispose()
```

### ImageWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/imagewatermark/imagewatermark.md

#### ImageWatermark(string)

Initializes a new instance of the `ImageWatermark` class with a specified file path.

```csharp
public ImageWatermark(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The path to the image that will be used as watermark. |

#### ImageWatermark(Stream)

Initializes a new instance of the `ImageWatermark` class with a specified stream.

```csharp
public ImageWatermark(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | The stream containing the image that will be used as watermark. |

### Margins
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins.md

#### Margins class

Represents margin settings for each edge of an object.

```csharp
public class Margins
```

#### Constructors

| Name | Description |
| --- | --- |
| Margins() | Initializes a new instance of the `Margins` class. |
| Margins(MarginType, double, double, double, double) | Initializes a new instance of the `Margins` class with the specified type, location and size. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; set; } | Gets or sets the bottom margin. |
| Left { get; set; } | Gets or sets the left margin. |
| MarginType { get; set; } | Gets or sets margin type. Setting a new value to this property automatically returns all margins to their default values (zero). |
| Right { get; set; } | Gets or sets the right margin. |
| Top { get; set; } | Gets or sets the top margin. |

### Bottom
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/bottom.md

#### Margins.Bottom property

Gets or sets the bottom margin.

```csharp
public double Bottom { get; set; }
```

##### Property Value

Horizontal offset from parent bottom border.

### Left
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/left.md

#### Margins.Left property

Gets or sets the left margin.

```csharp
public double Left { get; set; }
```

##### Property Value

Horizontal offset from parent left border.

### Margins
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/margins.md

#### Margins()

Initializes a new instance of the `Margins` class.

```csharp
public Margins()
```

#### Margins(MarginType, double, double, double, double)

Initializes a new instance of the `Margins` class with the specified type, location and size.

```csharp
public Margins(MarginType marginType, double left, double right, double top, double bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| marginType | MarginType | The margin type. Specifies how margin values should be interpreted. |
| left | Double | The left margin value. |
| right | Double | The right margin value. |
| top | Double | The top margin value. |
| bottom | Double | The bottom margin value. |

### MarginType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/margintype.md

#### Margins.MarginType property

Gets or sets margin type. Setting a new value to this property automatically returns all margins to their default values (zero).

```csharp
public MarginType MarginType { get; set; }
```

##### Property Value

The value specifying how margins should be interpreted.

##### Remarks

The default value is Absolute

### Right
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/right.md

#### Margins.Right property

Gets or sets the right margin.

```csharp
public double Right { get; set; }
```

##### Property Value

Horizontal offset from parent right border.

### Top
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margins/top.md

#### Margins.Top property

Gets or sets the top margin.

```csharp
public double Top { get; set; }
```

##### Property Value

Horizontal offset from parent top border.

### MarginType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/margintype.md

#### MarginType enumeration

Specifies how margin values should be interpreted.

```csharp
public enum MarginType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Absolute | `0` | Margin value measured in content units. |
| RelativeToParentDimensions | `1` | Margin value should be interpreted as a portion of appropriate parent dimension. |
| RelativeToParentMinDimension | `2` | Margin value should be interpreted as a portion of parent minimum dimension. |

### MeasureValue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/measurevalue.md

#### MeasureValue class

Represents a measurement value with a specific type and numerical value.

```csharp
public class MeasureValue
```

#### Constructors

| Name | Description |
| --- | --- |
| MeasureValue() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| MeasureType { get; set; } | Gets or sets the type of measurement. |
| Value { get; set; } | Gets or sets the numerical value of the measurement. Value must be greater than 0. |

### MeasureType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/measurevalue/measuretype.md

#### MeasureValue.MeasureType property

Gets or sets the type of measurement.

```csharp
public TileMeasureType MeasureType { get; set; }
```

### MeasureValue
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/measurevalue/measurevalue.md

#### MeasureValue constructor

The default constructor.

```csharp
public MeasureValue()
```

### Value
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/measurevalue/value.md

#### MeasureValue.Value property

Gets or sets the numerical value of the measurement. Value must be greater than 0.

```csharp
public double Value { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup.md

#### PagesSetup class

Represents the setup for pages.

```csharp
public class PagesSetup
```

#### Constructors

| Name | Description |
| --- | --- |
| PagesSetup() | Initializes a new instance of the `PagesSetup` class. |
| PagesSetup(bool, bool, bool, bool, bool, List&lt;int&gt;, int?) | Initializes a new instance of the `PagesSetup` class with specified parameters. |

#### Properties

| Name | Description |
| --- | --- |
| AllPages { get; set; } | Gets or sets a value indicating whether to include all pages. |
| EvenPages { get; set; } | Gets or sets a value indicating whether to include even pages. |
| FirstPage { get; set; } | Gets or sets a value indicating whether to include the first page. |
| LastPage { get; set; } | Gets or sets a value indicating whether to include the last page. |
| OddPages { get; set; } | Gets or sets a value indicating whether to include odd pages. |
| PageNumber { get; set; } | Gets or sets the page number when considering only specified pages. |
| Pages { get; set; } | Gets or sets the list of specific page numbers to include. |
| Specified { get; } | Gets a value indicating whether any specific pages are specified. |

### AllPages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/allpages.md

#### PagesSetup.AllPages property

Gets or sets a value indicating whether to include all pages.

```csharp
public bool AllPages { get; set; }
```

### EvenPages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/evenpages.md

#### PagesSetup.EvenPages property

Gets or sets a value indicating whether to include even pages.

```csharp
public bool EvenPages { get; set; }
```

### FirstPage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/firstpage.md

#### PagesSetup.FirstPage property

Gets or sets a value indicating whether to include the first page.

```csharp
public bool FirstPage { get; set; }
```

### LastPage
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/lastpage.md

#### PagesSetup.LastPage property

Gets or sets a value indicating whether to include the last page.

```csharp
public bool LastPage { get; set; }
```

### OddPages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/oddpages.md

#### PagesSetup.OddPages property

Gets or sets a value indicating whether to include odd pages.

```csharp
public bool OddPages { get; set; }
```

### PageNumber
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/pagenumber.md

#### PagesSetup.PageNumber property

Gets or sets the page number when considering only specified pages.

```csharp
public int? PageNumber { get; set; }
```

### Pages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/pages.md

#### PagesSetup.Pages property

Gets or sets the list of specific page numbers to include.

```csharp
public List<int> Pages { get; set; }
```

### PagesSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/pagessetup.md

#### PagesSetup()

Initializes a new instance of the `PagesSetup` class.

```csharp
public PagesSetup()
```

#### PagesSetup(bool, bool, bool, bool, bool, List&lt;int&gt;, int?)

Initializes a new instance of the `PagesSetup` class with specified parameters.

```csharp
public PagesSetup(bool allPages, bool firstPage, bool lastPage, bool oddPages, bool evenPages, 
    List<int> pages, int? pageNumber)
```

| Parameter | Type | Description |
| --- | --- | --- |
| allPages | Boolean | Whether to include all pages. |
| firstPage | Boolean | Whether to include the first page. |
| lastPage | Boolean | Whether to include the last page. |
| oddPages | Boolean | Whether to include odd pages. |
| evenPages | Boolean | Whether to include even pages. |
| pages | List`1 | The list of specific page numbers to include. |
| pageNumber | Nullable`1 | The index of the current page. |

### Specified
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/pagessetup/specified.md

#### PagesSetup.Specified property

Gets a value indicating whether any specific pages are specified.

```csharp
public bool Specified { get; }
```

### SizingType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/sizingtype.md

#### SizingType enumeration

Specifies how watermark size should be calculated.

```csharp
public enum SizingType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Auto | `0` | Watermark should be sized automatically according to its content. |
| Absolute | `1` | Watermark should be sized to an exact `Width` and `Height` |
| ScaleToParentDimensions | `2` | Watermark should be scaled relative to parent dimensions using specified `ScaleFactor`. |
| ScaleToParentArea | `3` | Watermark should be scaled relative to parent area using specified `ScaleFactor` |

### TextAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textalignment.md

#### TextAlignment enumeration

Enumeration of possible text alignment values.

```csharp
public enum TextAlignment
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Left | `0` | Align to left. |
| Center | `1` | Center alignment. |
| Right | `2` | Align to right. |
| Justify | `3` | Justify alignment. Text will be aligned on both left and right margins. |

### TextWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark.md

#### TextWatermark class

Represents a text watermark.

```csharp
public class TextWatermark : Watermark
```

#### Constructors

| Name | Description |
| --- | --- |
| TextWatermark(string, Font) | Initializes a new instance of the `TextWatermark` class with a specified text and a font. |

#### Properties

| Name | Description |
| --- | --- |
| BackgroundColor { get; set; } | Gets or sets the background color of the text. |
| ConsiderParentMargins { get; set; } | Gets or sets a value indicating whether the watermark size and coordinates are calculated considering parent margins. |
| Font { get; set; } | Gets or sets the font of the text. |
| ForegroundColor { get; set; } | Gets or sets the foreground color of the text. |
| Height { get; set; } | Gets or sets the desired height of this `Watermark`. |
| HorizontalAlignment { get; set; } | Gets or sets the horizontal alignment of this `Watermark`. |
| IsBackground { get; set; } | Gets or sets a value indicating whether the watermark should be placed at background. |
| Margins { get; set; } | Gets or sets the margin settings of this `Watermark`. |
| Opacity { get; set; } | Gets or sets the opacity of this `Watermark`. |
| Padding { get; set; } | Gets or sets the padding settings of this `TextWatermark`. This property is applicable only to image files. |
| PagesSetup { get; set; } | Gets or sets the pages setup settings of this `Watermark`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `Watermark` in degrees. |
| SaveResultInMetadata { get; set; } | Gets or sets a value indicating whether to save information about added watermarks in the document metadata. |
| ScaleFactor { get; set; } | Gets or sets a value that defines how watermark size depends on parent size. |
| SizingType { get; set; } | Gets or sets a value specifying a way watermark should be sized. |
| Text { get; set; } | Gets or sets the text to be used as watermark. |
| TextAlignment { get; set; } | Gets or sets the watermark text alignment. |
| TileOptions { get; set; } | Get or sets options to define repeated watermark |
| VerticalAlignment { get; set; } | Gets or sets the vertical alignment of this `Watermark`. |
| Width { get; set; } | Gets or sets the desired width of this `Watermark`. |
| X { get; set; } | Gets or sets the x-coordinate of this `Watermark`. |
| Y { get; set; } | Gets or sets the y-coordinate of this `Watermark`. |

##### Remarks

**Learn more:**

* [Adding text watermarks](https://docs.groupdocs.com/display/watermarknet/Adding+text+watermarks)

##### Examples

Scale the text watermark depending on the parent size.

```csharp
foreach (string file in Directory.GetFiles("C:\\test"))
{
    using (Watermarker watermarker = new Watermarker(file))
    {
        TextWatermark watermark = new TextWatermark("test watermark", new Font("Arial", 36));
        watermark.HorizontalAlignment = HorizontalAlignment.Center;
        watermark.VerticalAlignment = VerticalAlignment.Center;
        watermark.SizingType = SizingType.ScaleToParentDimensions;
        watermark.RotateAngle = 45;
        watermark.ScaleFactor = 0.4;

        watermarker.Add(watermark);
        watermarker.Save();
    }
}
```

### BackgroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/backgroundcolor.md

#### TextWatermark.BackgroundColor property

Gets or sets the background color of the text.

```csharp
public Color BackgroundColor { get; set; }
```

##### Property Value

The background color of the text.

### Font
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/font.md

#### TextWatermark.Font property

Gets or sets the font of the text.

```csharp
public Font Font { get; set; }
```

##### Property Value

The font of the text.

### ForegroundColor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/foregroundcolor.md

#### TextWatermark.ForegroundColor property

Gets or sets the foreground color of the text.

```csharp
public Color ForegroundColor { get; set; }
```

##### Property Value

The foreground color of the text.

### Padding
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/padding.md

#### TextWatermark.Padding property

Gets or sets the padding settings of this `TextWatermark`. This property is applicable only to image files.

```csharp
public Thickness Padding { get; set; }
```

##### Property Value

The padding settings of this `TextWatermark`.

### Text
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/text.md

#### TextWatermark.Text property

Gets or sets the text to be used as watermark.

```csharp
public string Text { get; set; }
```

##### Property Value

The string representing watermark text.

### TextAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/textalignment.md

#### TextWatermark.TextAlignment property

Gets or sets the watermark text alignment.

```csharp
public TextAlignment TextAlignment { get; set; }
```

##### Property Value

The watermark text alignment.

##### Remarks

Default value is Left.

### TextWatermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/textwatermark/textwatermark.md

#### TextWatermark constructor

Initializes a new instance of the `TextWatermark` class with a specified text and a font.

```csharp
public TextWatermark(string text, Font font)
```

| Parameter | Type | Description |
| --- | --- | --- |
| text | String | The text to be used as watermark. |
| font | Font | The font of the text. |

### Thickness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness.md

#### Thickness class

Describes the thickness of a frame around a rectangle.

```csharp
public class Thickness
```

#### Constructors

| Name | Description |
| --- | --- |
| Thickness(double) | Initializes a new instance of the `Thickness` class that has the specified uniform length on each side. |
| Thickness(double, double, double, double) | Initializes a new instance of the `Thickness` class that has specific lengths applied to each side of the rectangle. |

#### Properties

| Name | Description |
| --- | --- |
| Bottom { get; set; } | Gets or sets the width of the bottom side of the bounding rectangle. |
| Left { get; set; } | Gets or sets the width of the left side of the bounding rectangle. |
| Right { get; set; } | Gets or sets the width of the right side of the bounding rectangle. |
| Top { get; set; } | Gets or sets the width of the top side of the bounding rectangle. |

#### Methods

| Name | Description |
| --- | --- |
| override Equals(object) | Determines whether the specified `Thickness` is equal to the current `Thickness`. |
| override GetHashCode() | Returns the hash code for this instance. |
| override ToString() | Returns the string representation of the `Thickness` class. |

### Bottom
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/bottom.md

#### Thickness.Bottom property

Gets or sets the width of the bottom side of the bounding rectangle.

```csharp
public double Bottom { get; set; }
```

##### Property Value

The width of the bottom side of the bounding rectangle.

### Equals
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/equals.md

#### Thickness.Equals method

Determines whether the specified `Thickness` is equal to the current `Thickness`.

```csharp
public override bool Equals(object obj)
```

| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The `Thickness` to compare with the current `Thickness`. |

##### Return Value

`true` if the specified `Thickness` is equal to the current `Thickness`; otherwise, `false`.

### GetHashCode
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/gethashcode.md

#### Thickness.GetHashCode method

Returns the hash code for this instance.

```csharp
public override int GetHashCode()
```

##### Return Value

A 32-bit signed integer hash code.

### Left
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/left.md

#### Thickness.Left property

Gets or sets the width of the left side of the bounding rectangle.

```csharp
public double Left { get; set; }
```

##### Property Value

The width of the left side of the bounding rectangle.

### Right
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/right.md

#### Thickness.Right property

Gets or sets the width of the right side of the bounding rectangle.

```csharp
public double Right { get; set; }
```

##### Property Value

The width of the right side of the bounding rectangle.

### Thickness
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/thickness.md

#### Thickness(double, double, double, double)

Initializes a new instance of the `Thickness` class that has specific lengths applied to each side of the rectangle.

```csharp
public Thickness(double left, double right, double top, double bottom)
```

| Parameter | Type | Description |
| --- | --- | --- |
| left | Double | The thickness for the left side of the rectangle. |
| right | Double | The thickness for the right side of the rectangle. |
| top | Double | The thickness for the top side of the rectangle. |
| bottom | Double | The thickness for the bottom side of the rectangle. |

#### Thickness(double)

Initializes a new instance of the `Thickness` class that has the specified uniform length on each side.

```csharp
public Thickness(double uniformLength)
```

| Parameter | Type | Description |
| --- | --- | --- |
| uniformLength | Double | The uniform length applied to all four sides of the bounding rectangle. |

### Top
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/top.md

#### Thickness.Top property

Gets or sets the width of the top side of the bounding rectangle.

```csharp
public double Top { get; set; }
```

##### Property Value

The width of the top side of the bounding rectangle.

### ToString
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/thickness/tostring.md

#### Thickness.ToString method

Returns the string representation of the `Thickness` class.

```csharp
public override string ToString()
```

##### Return Value

A String that represents the `Thickness` value.

### TileMeasureType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tilemeasuretype.md

#### TileMeasureType enumeration

Represents measure types

```csharp
public enum TileMeasureType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pixel | `0` | Specifies that the unit of measurement is pixel. |
| Percent | `1` | Specifies that the unit of measurement is percent. |
| Points | `2` | Specifies that the unit of measurement is point. |

### TileOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions.md

#### TileOptions class

Represents options for configuring watermarks in tile mode.

```csharp
public class TileOptions
```

#### Constructors

| Name | Description |
| --- | --- |
| TileOptions() | The default constructor. |

#### Properties

| Name | Description |
| --- | --- |
| LineSpacing { get; set; } | Gets or sets the spacing between lines for watermarks in tile mode. |
| RotateAroundOrigin { get; set; } | Gets or sets a value indicating whether the repeated watermarks should be rotated around the center of the document. |
| TileType { get; set; } | Gets or sets the type of tile alignment for watermarks. |
| WatermarkSpacing { get; set; } | Gets or sets the spacing between serials for watermarks in tile mode. |

### LineSpacing
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions/linespacing.md

#### TileOptions.LineSpacing property

Gets or sets the spacing between lines for watermarks in tile mode.

```csharp
public MeasureValue LineSpacing { get; set; }
```

### RotateAroundOrigin
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions/rotatearoundorigin.md

#### TileOptions.RotateAroundOrigin property

Gets or sets a value indicating whether the repeated watermarks should be rotated around the center of the document.

```csharp
public bool RotateAroundOrigin { get; set; }
```

##### Property Value

`true` if the repeated watermarks should be rotated around the bottom left point of the document; otherwise, `false`, in such case the rotation will be relative to the left edge of the document. The default is `false`.

### TileOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions/tileoptions.md

#### TileOptions constructor

The default constructor.

```csharp
public TileOptions()
```

### TileType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions/tiletype.md

#### TileOptions.TileType property

Gets or sets the type of tile alignment for watermarks.

```csharp
public TileType TileType { get; set; }
```

### WatermarkSpacing
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tileoptions/watermarkspacing.md

#### TileOptions.WatermarkSpacing property

Gets or sets the spacing between serials for watermarks in tile mode.

```csharp
public MeasureValue WatermarkSpacing { get; set; }
```

### TileType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.watermarks/tiletype.md

#### TileType enumeration

Enumeration representing different visual templates for arranging watermark tiles.

```csharp
public enum TileType
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Straight | `0` | Represents straight tile alignment. |
| Offset | `1` | Represents offset tile alignment. |
| OneThirdOffset | `2` | Represents 1/3 offset tile alignment. |
| BasketWeave | `3` | Represents basket weave tile pattern |

### GroupDocs.Watermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark.md

The namespace provides classes for working with watermarks in a document of any supported type.

#### Classes

| Class | Description |
| --- | --- |
| License | Provides methods to license the component. |
| Metered | Provides methods to license the component with Metered license. |
| Watermark | Represents a watermark to be added to a document. |
| Watermarker | Represents a class for watermark management in a document. |
| WatermarkerSettings | Defines settings for customizing Watermarker behaviour. |
#### Enumeration

| Enumeration | Description |
| --- | --- |
| UnitOfMeasurement | Represents units of measurement. |

<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.watermark.dll -->

### License
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/license.md

#### License class

Provides methods to license the component.

```csharp
public sealed class License
```

#### Constructors

| Name | Description |
| --- | --- |
| License() | Initializes a new instance of the `License` class. |

#### Methods

| Name | Description |
| --- | --- |
| SetLicense(Stream) | Licenses the component. |
| SetLicense(string) | Licenses the component. |

##### Remarks

* More about licensing: [GroupDocs Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing)
* More about **GroupDocs.Watermark** licensing: [Evaluation Limitations and Licensing](https://docs.groupdocs.com/display/watermarknet/Evaluation+Limitations+and+Licensing)

##### Examples

This example demonstrates how to setup license from the local file.

```csharp
// Initialize License class.
License license = new License();

// Set path to .lic file.
license.SetLicense("C:\\GroupDocs.Watermark.lic");
```

### License
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/license/license.md

#### License constructor

Initializes a new instance of the `License` class.

```csharp
public License()
```

### SetLicense
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/license/setlicense.md

#### SetLicense(string)

Licenses the component.

```csharp
public void SetLicense(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | Absolute path to license file. |

##### Remarks

Use this method to load a license from a file.

#### SetLicense(Stream)

Licenses the component.

```csharp
public void SetLicense(Stream stream)
```

| Parameter | Type | Description |
| --- | --- | --- |
| stream | Stream | License stream. |

##### Remarks

Use this method to load a license from a stream.

### Metered
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/metered.md

#### Metered class

Provides methods to license the component with Metered license.

```csharp
public class Metered
```

#### Constructors

| Name | Description |
| --- | --- |
| Metered() | Initializes a new instance of the `Metered` class. |

#### 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. |

##### 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);
```

### GetConsumptionCredit
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/metered/getconsumptioncredit.md

#### Metered.GetConsumptionCredit method

Retrieves count of credits consumed.

```csharp
public static long GetConsumptionCredit()
```

##### Return Value

The count of credits consumed.

##### 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/watermark/net/groupdocs.watermark/metered/getconsumptionquantity.md

#### Metered.GetConsumptionQuantity method

Retrieves amount of MBs processed.

```csharp
public static decimal GetConsumptionQuantity()
```

##### Return Value

The amount of MBs processed.

##### 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/watermark/net/groupdocs.watermark/metered/metered.md

#### Metered constructor

Initializes a new instance of the `Metered` class.

```csharp
public Metered()
```

### SetMeteredKey
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/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. |

### UnitOfMeasurement
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/unitofmeasurement.md

#### UnitOfMeasurement enumeration

Represents units of measurement.

```csharp
public enum UnitOfMeasurement
```

##### Values

| Name | Value | Description |
| --- | --- | --- |
| Pixel | `0` | Specifies that the unit of measurement is pixel. |
| Point | `1` | Specifies that the unit of measurement is point. |

### Watermark
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark.md

#### Watermark class

Represents a watermark to be added to a document.

```csharp
public abstract class Watermark
```

#### Properties

| Name | Description |
| --- | --- |
| ConsiderParentMargins { get; set; } | Gets or sets a value indicating whether the watermark size and coordinates are calculated considering parent margins. |
| Height { get; set; } | Gets or sets the desired height of this `Watermark`. |
| HorizontalAlignment { get; set; } | Gets or sets the horizontal alignment of this `Watermark`. |
| IsBackground { get; set; } | Gets or sets a value indicating whether the watermark should be placed at background. |
| Margins { get; set; } | Gets or sets the margin settings of this `Watermark`. |
| Opacity { get; set; } | Gets or sets the opacity of this `Watermark`. |
| PagesSetup { get; set; } | Gets or sets the pages setup settings of this `Watermark`. |
| RotateAngle { get; set; } | Gets or sets the rotate angle of this `Watermark` in degrees. |
| SaveResultInMetadata { get; set; } | Gets or sets a value indicating whether to save information about added watermarks in the document metadata. |
| ScaleFactor { get; set; } | Gets or sets a value that defines how watermark size depends on parent size. |
| SizingType { get; set; } | Gets or sets a value specifying a way watermark should be sized. |
| TileOptions { get; set; } | Get or sets options to define repeated watermark |
| VerticalAlignment { get; set; } | Gets or sets the vertical alignment of this `Watermark`. |
| Width { get; set; } | Gets or sets the desired width of this `Watermark`. |
| X { get; set; } | Gets or sets the x-coordinate of this `Watermark`. |
| Y { get; set; } | Gets or sets the y-coordinate of this `Watermark`. |

### ConsiderParentMargins
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/considerparentmargins.md

#### Watermark.ConsiderParentMargins property

Gets or sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.

```csharp
public bool ConsiderParentMargins { get; set; }
```

##### Property Value

If the value is true, watermark size and coordinates are calculated considering parent margins. By default, the value is false, parent margins are ignored.

### Height
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/height.md

#### Watermark.Height property

Gets or sets the desired height of this `Watermark`.

```csharp
public double Height { get; set; }
```

##### Property Value

The desired height of this `Watermark`.

##### Remarks

Setting this property will also change the value of `SizingType` property to Absolute.

### HorizontalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/horizontalalignment.md

#### Watermark.HorizontalAlignment property

Gets or sets the horizontal alignment of this `Watermark`.

```csharp
public HorizontalAlignment HorizontalAlignment { get; set; }
```

##### Property Value

The horizontal alignment of this `Watermark`.

##### Remarks

Default value is None.

### IsBackground
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/isbackground.md

#### Watermark.IsBackground property

Gets or sets a value indicating whether the watermark should be placed at background.

```csharp
public bool IsBackground { get; set; }
```

##### Property Value

If the value is true, the watermark will be placed at the bottom. By default, the value is false, the watermark will be placed at the top.

### Margins
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/margins.md

#### Watermark.Margins property

Gets or sets the margin settings of this `Watermark`.

```csharp
public Margins Margins { get; set; }
```

##### Property Value

The margin settings of this `Watermark`.

### Opacity
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/opacity.md

#### Watermark.Opacity property

Gets or sets the opacity of this `Watermark`.

```csharp
public double Opacity { get; set; }
```

##### Property Value

The opacity of this `Watermark`.

##### Remarks

The value of opacity should be between 0 and 1. The default value is 1.

### PagesSetup
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/pagessetup.md

#### Watermark.PagesSetup property

Gets or sets the pages setup settings of this `Watermark`.

```csharp
public PagesSetup PagesSetup { get; set; }
```

##### Property Value

The pages setup settings of this `Watermark`.

### RotateAngle
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/rotateangle.md

#### Watermark.RotateAngle property

Gets or sets the rotate angle of this `Watermark` in degrees.

```csharp
public double RotateAngle { get; set; }
```

##### Property Value

The rotate angle of this `Watermark` in degrees.

### SaveResultInMetadata
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/saveresultinmetadata.md

#### Watermark.SaveResultInMetadata property

Gets or sets a value indicating whether to save information about added watermarks in the document metadata.

```csharp
public bool SaveResultInMetadata { get; set; }
```

### ScaleFactor
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/scalefactor.md

#### Watermark.ScaleFactor property

Gets or sets a value that defines how watermark size depends on parent size.

```csharp
public double ScaleFactor { get; set; }
```

##### Property Value

The scale factor of this `Watermark`.

##### Remarks

The value must be between 0 and 1.

### SizingType
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/sizingtype.md

#### Watermark.SizingType property

Gets or sets a value specifying a way watermark should be sized.

```csharp
public SizingType SizingType { get; set; }
```

##### Property Value

The sizing type.

### TileOptions
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/tileoptions.md

#### Watermark.TileOptions property

Get or sets options to define repeated watermark

```csharp
public TileOptions TileOptions { get; set; }
```

### VerticalAlignment
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/verticalalignment.md

#### Watermark.VerticalAlignment property

Gets or sets the vertical alignment of this `Watermark`.

```csharp
public VerticalAlignment VerticalAlignment { get; set; }
```

##### Property Value

The vertical alignment of this `Watermark`.

##### Remarks

Default value is None.

### Width
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/width.md

#### Watermark.Width property

Gets or sets the desired width of this `Watermark`.

```csharp
public double Width { get; set; }
```

##### Property Value

The desired width of this `Watermark`.

##### Remarks

Setting this property will also change the value of `SizingType` property to Absolute.

### X
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/x.md

#### Watermark.X property

Gets or sets the x-coordinate of this `Watermark`.

```csharp
public double X { get; set; }
```

##### Property Value

The x-coordinate of this `Watermark`.

### Y
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermark/y.md

#### Watermark.Y property

Gets or sets the y-coordinate of this `Watermark`.

```csharp
public double Y { get; set; }
```

##### Property Value

The y-coordinate of this `Watermark`.

### Watermarker
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker.md

#### Watermarker class

Represents a class for watermark management in a document.

```csharp
public class Watermarker : IDisposable
```

#### Constructors

| Name | Description |
| --- | --- |
| Watermarker(Stream) | Initializes a new instance of the `Watermarker` class with the specified stream. |
| Watermarker(string) | Initializes a new instance of the `Watermarker` class with the specified document path. |
| Watermarker(Stream, LoadOptions) | Initializes a new instance of the `Watermarker` class with the specified stream and load options. |
| Watermarker(Stream, WatermarkerSettings) | Initializes a new instance of the `Watermarker` class with the specified stream and settings. |
| Watermarker(string, LoadOptions) | Initializes a new instance of the `Watermarker` class with the specified document path and load options. |
| Watermarker(string, WatermarkerSettings) | Initializes a new instance of the `Watermarker` class with the specified document path and settings. |
| Watermarker(Stream, LoadOptions, WatermarkerSettings) | Initializes a new instance of the `Watermarker` class with the specified stream, load options and settings. |
| Watermarker(string, LoadOptions, WatermarkerSettings) | Initializes a new instance of the `Watermarker` class with the specified document path, load options and settings. |

#### Properties

| Name | Description |
| --- | --- |
| SearchableObjects { get; set; } | Gets or sets the content objects that are to be included in a watermark search. |

#### Methods

| Name | Description |
| --- | --- |
| Add(Watermark) | Adds a watermark to the loaded document. |
| Add(Watermark, WatermarkOptions) | Adds a watermark to the loaded document using watermark options. |
| Dispose() | Disposes the current instance. |
| GeneratePreview(PreviewOptions) | Generates preview images for the document. |
| GetContent&lt;T&gt;() | Returns the `Content` object for the loaded document. |
| GetDocumentInfo() | Gets the information about the format of the loaded document. |
| GetImages() | Finds all images in the document. |
| GetImages(ImageSearchCriteria) | Finds images according to specified search criteria. |
| Remove(PossibleWatermark) | Removes watermark from the document. |
| Remove(PossibleWatermarkCollection) | Removes all watermarks in the collection from the document. |
| Save() | Saves the document data to the underlying stream. |
| Save(SaveOptions) | Saves the document data to the underlying stream using save options. |
| Save(Stream) | Saves the document to the specified stream. |
| Save(string) | Saves the document to the specified file location. |
| Save(Stream, SaveOptions) | Saves the document to the specified stream using save options. |
| Save(string, SaveOptions) | Saves the document to the specified file location using save options. |
| Search() | Searches all possible watermarks in the document. |
| Search(SearchCriteria) | Searches possible watermarks according to specified search criteria. |

##### Examples

Load and save a content of any supported format.

```csharp
// Load a content from a file.
using (Watermarker watermarker = new Watermarker("D:\\input.pdf"))
{
    // Use methods of Watermarker class to add, search or remove watermarks.

    // Save changes.
    watermarker.Save("D:\\output.pdf");
}
```

### Add
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/add.md

#### Add(Watermark)

Adds a watermark to the loaded document.

```csharp
public AddWatermarkResult Add(Watermark watermark)
```

| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the document. |

##### Remarks

Learn more about adding watermarks: [Adding watermarks](https://docs.groupdocs.com/display/watermarknet/Adding+watermarks).

##### Examples

Add image and text watermark to a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.pdf"))
{
    TextWatermark textWatermark = new TextWatermark("DRAFT", new Font("Arial", 19));
    textWatermark.HorizontalAlignment = HorizontalAlignment.Center;
    textWatermark.VerticalAlignment = VerticalAlignment.Top;
    textWatermark.ConsiderParentMargins = true;
    textWatermark.ForegroundColor = Color.Red;
    textWatermark.IsBackground = true;
    textWatermark.Opacity = 0.5;
    watermarker.Add(textWatermark);

    using (ImageWatermark imageWatermark = new ImageWatermark(@"D:\draft.png"))
    {
        imageWatermark.HorizontalAlignment = HorizontalAlignment.Center;
        imageWatermark.VerticalAlignment = VerticalAlignment.Bottom;
        imageWatermark.ConsiderParentMargins = true;
        imageWatermark.IsBackground = true;
        imageWatermark.Opacity = 0.5;
        watermarker.Add(imageWatermark);
    }

    watermarker.Save(@"D:\output.pdf");
}
```

#### Add(Watermark, WatermarkOptions)

Adds a watermark to the loaded document using watermark options.

```csharp
public AddWatermarkResult Add(Watermark watermark, WatermarkOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| watermark | Watermark | The watermark to add to the document. |
| options | WatermarkOptions | Additional options to use when adding the watermark. |

##### Remarks

Learn more about adding watermarks [Adding watermarks](https://docs.groupdocs.com/display/watermarknet/Adding+watermarks).

##### Examples

Add an image watermark to a particular page of a pdf document.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\doc.pdf", loadOptions))
using (ImageWatermark watermark = new ImageWatermark(@"C:\watermark.png"))
{
    PdfXObjectWatermarkOptions options = new PdfXObjectWatermarkOptions();
    options.PageIndex = 0;

    watermarker.Add(watermark, options);
    watermarker.Save();
}
```

### Dispose
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/dispose.md

#### Watermarker.Dispose method

Disposes the current instance.

```csharp
public void Dispose()
```

### GeneratePreview
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/generatepreview.md

#### Watermarker.GeneratePreview method

Generates preview images for the document.

```csharp
public void GeneratePreview(PreviewOptions previewOptions)
```

| Parameter | Type | Description |
| --- | --- | --- |
| previewOptions | PreviewOptions | Additional options to use when generating preview images. |

##### Examples

Generate preview image for the first page of Word document.

```csharp
CreatePageStream createPageStreamDelegate = delegate(int number)
                                            {
                                                string previewImageFileName = string.Format("page{0}.png", number);
                                                return File.OpenWrite(previewImageFileName);
                                            };
ReleasePageStream releasePageStreamDelegate = delegate(int number, Stream stream)
                                              {
                                                  stream.Close();
                                              };
PreviewOptions previewOptions = new PreviewOptions(createPageStreamDelegate, releasePageStreamDelegate)
                                {
                                    PreviewFormat = PreviewOptions.PreviewFormats.PNG,
                                    PageNumbers = new []{1}
                                };

using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.docx"))
{
    watermarker.GeneratePreview(previewOptions);
}
```

### GetContent
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/getcontent.md

#### Watermarker.GetContent&lt;T&gt; method

Returns the `Content` object for the loaded document.

```csharp
public T GetContent<T>()
    where T : Content
```

| Parameter | Description |
| --- | --- |
| T | The requested type of a `Content` object. |

##### Return Value

The `Content` object for the loaded document.

##### Examples

Rasterize pdf document page with added watermark.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
using (Watermarker watermarker = new Watermarker(@"C:\doc.pdf", loadOptions))
{ 
    using (ImageWatermark watermark = new ImageWatermark(@"C:\watermark.png"))
    {
        watermarker.Add(watermark);
    }

    PdfContent content = watermarker.GetContent<PdfContent>();
    content.Rasterize(300, 300, PdfImageConversionFormat.Png);

    watermarker.Save();
}
```

### GetDocumentInfo
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/getdocumentinfo.md

#### Watermarker.GetDocumentInfo method

Gets the information about the format of the loaded document.

```csharp
public IDocumentInfo GetDocumentInfo()
```

##### Return Value

The `IDocumentInfo` instance that contains detected information.

##### Remarks

Learn more about getting the document information [Get document info](https://docs.groupdocs.com/display/watermarknet/Get+document+info).

##### Examples

Get information about a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\test.ppt"))
{
    IDocumentInfo docInfo = watermarker.GetDocumentInfo();
    Console.WriteLine("Document size: {0}", docInfo.Size);
    Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
    Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
}
```

### GetImages
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/getimages.md

#### GetImages(ImageSearchCriteria)

Finds images according to specified search criteria.

```csharp
public WatermarkableImageCollection GetImages(ImageSearchCriteria searchCriteria)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | ImageSearchCriteria | The search criteria to use. |

##### Return Value

The collection of found images.

##### Remarks

The search is conducted in objects specified in `SearchableObjects`.

Learn more about searching watermarks [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks).

##### Examples

Remove all images that are similar to the reference from a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    ImageThumbnailSearchCriteria criteria = new ImageThumbnailSearchCriteria("reference.png");
    WatermarkableImageCollection images = watermarker.GetImages(criteria);
    images.Clear();
    watermarker.Save(@"D:\output.doc");
}
```

#### GetImages()

Finds all images in the document.

```csharp
public WatermarkableImageCollection GetImages()
```

##### Return Value

The collection of found images.

##### Remarks

The search is conducted in objects specified in `SearchableObjects`.

Learn more about searching watermarks [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks).

##### Examples

Add watermark to all images in a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    // Initialize text or image watermark.
    TextWatermark watermark = new TextWatermark("DRAFT", new Font("Arial", 19));

    // Find all images in the document.
    WatermarkableImageCollection images = watermarker.GetImages();

    // Add watermark.
    foreach (WatermarkableImage watermarkableImage in images)
    {
        watermarkableImage.AddWatermark(watermark);
    }

    // Save changes.
    watermarker.Save(@"D:\output.doc");
}
```

### Remove
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/remove.md

#### Remove(PossibleWatermark)

Removes watermark from the document.

```csharp
public void Remove(PossibleWatermark possibleWatermark)
```

| Parameter | Type | Description |
| --- | --- | --- |
| possibleWatermark | PossibleWatermark | The watermark to remove. |

##### Remarks

Learn more about removing watermarks: [Removing found watermarks](https://docs.groupdocs.com/display/watermarknet/Removing+found+watermarks).

##### Examples

Find and remove the first possible watermark containing particular text or image from a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria(@"D:\logo.png");
    Regex regex = new Regex(@"^Company\sName$", RegexOptions.IgnoreCase);
    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(regex);
    PossibleWatermarkCollection watermarks = watermarker.Search(textSearchCriteria.Or(imageSearchCriteria));
    if (watermarks.Count > 0)
    {
        watermarker.Remove(watermarks[0]);
    }

    watermarker.Save(@"D:\output.doc");
}
```

#### Remove(PossibleWatermarkCollection)

Removes all watermarks in the collection from the document.

```csharp
public void Remove(PossibleWatermarkCollection possibleWatermarks)
```

| Parameter | Type | Description |
| --- | --- | --- |
| possibleWatermarks | PossibleWatermarkCollection | The collection of watermarks to remove. |

##### Remarks

Learn more about removing watermarks [Removing found watermarks](https://docs.groupdocs.com/display/watermarknet/Removing+found+watermarks).

##### Examples

Find and remove all possible watermarks containing particular text or image from a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria(@"D:\logo.png");
    Regex regex = new Regex(@"^Company\sName$", RegexOptions.IgnoreCase);
    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(regex);
    PossibleWatermarkCollection watermarks = watermarker.Search(textSearchCriteria.Or(imageSearchCriteria));
    watermarker.Remove(watermarks);
    watermarker.Save(@"D:\output.doc");
}
```

### Save
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/save.md

#### Save()

Saves the document data to the underlying stream.

```csharp
public WatermarkResult Save()
```

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Remove particular text fragments from the email message body/subject and save the email message.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\test.msg"))
{
    SearchCriteria criteria = new TextSearchCriteria("test", false);
    // Note, search is performed only if you pass TextSearchCriteria instance to Search method
    PossibleWatermarkCollection watermarks = watermarker.Search(criteria);
    // Remove found text fragments
    watermarker.Remove(watermarks);
    // Save changes
    watermarker.Save();
}
```

#### Save(string)

Saves the document to the specified file location.

```csharp
public WatermarkResult Save(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to save the document data to. |

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Add the watermark and save the document to another file.

```csharp
using (Watermarker watermarker = new Watermarker("input.pdf"))
{                                                                                   
    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
    watermarker.Add(watermark);                                            
    watermarker.Save("ouput.pdf");                                   
}                                                                                   
```

#### Save(Stream)

Saves the document to the specified stream.

```csharp
public WatermarkResult Save(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to save the document data to. |

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Add watermark and save the document to the memory stream.

```csharp
using (Watermarker watermarker = new Watermarker("input.pdf"))
{
    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
    watermarker.Add(watermark);
    using (MemoryStream stream = new MemoryStream())
    {
        watermarker.Save(stream);
        // ...
    }
}
```

#### Save(SaveOptions)

Saves the document data to the underlying stream using save options.

```csharp
public WatermarkResult Save(SaveOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| options | SaveOptions | Additional options to use when saving a document. |

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Add watermark and save the document with default `SaveOptions`.

```csharp
using (Watermarker watermarker = new Watermarker("input.pdf"))
{
    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
    watermarker.Add(watermark);
    watermarker.Save(new SaveOptions());
}
```

#### Save(string, SaveOptions)

Saves the document to the specified file location using save options.

```csharp
public WatermarkResult Save(string filePath, SaveOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to save the document data to. |
| options | SaveOptions | Additional options to use when saving a document. |

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Add the watermark and save the document to another file with default `SaveOptions`.

```csharp
using (Watermarker watermarker = new Watermarker("input.pdf"))
{                                                                                   
    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
    watermarker.Add(watermark);                                            
    watermarker.Save("ouput.pdf", new SaveOptions());
}                                                                                   
```

#### Save(Stream, SaveOptions)

Saves the document to the specified stream using save options.

```csharp
public WatermarkResult Save(Stream document, SaveOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to save the document data to. |
| options | SaveOptions | Additional options to use when saving a document. |

##### Remarks

Learn more about saving the documents [Saving documents](https://docs.groupdocs.com/display/watermarknet/Saving+documents).

##### Examples

Add watermark and save the document to the memory stream with default `SaveOptions`.

```csharp
using (Watermarker watermarker = new Watermarker("input.pdf"))
{
    TextWatermark watermark = new TextWatermark("top secret", new Font("Arial", 36));
    watermarker.Add(watermark);
    using (MemoryStream stream = new MemoryStream())
    {
        watermarker.Save(stream, new SaveOptions());
        // ...
    }
}
```

### Search
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/search.md

#### Search()

Searches all possible watermarks in the document.

```csharp
public PossibleWatermarkCollection Search()
```

##### Return Value

The collection of possible watermarks.

##### Remarks

The search is conducted in objects specified in `SearchableObjects`.

Learn more about searching watermarks [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks).

##### Examples

Count the possible watermarks in a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    PossibleWatermarkCollection watermarks = watermarker.Search();
    Console.WrileLine(watermarks.Count);
}
```

#### Search(SearchCriteria)

Searches possible watermarks according to specified search criteria.

```csharp
public PossibleWatermarkCollection Search(SearchCriteria searchCriteria)
```

| Parameter | Type | Description |
| --- | --- | --- |
| searchCriteria | SearchCriteria | The search criteria to use. |

##### Return Value

The collection of possible watermarks.

##### Remarks

The search is conducted in objects specified in `SearchableObjects`.

Learn more about searching watermarks [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks).

##### Examples

Find and remove all possible watermarks containing particular text or image from a document of any supported type.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\input.doc"))
{
    ImageSearchCriteria imageSearchCriteria = new ImageDctHashSearchCriteria(@"D:\logo.png");
    Regex regex = new Regex(@"^Company\sName$", RegexOptions.IgnoreCase);
    TextSearchCriteria textSearchCriteria = new TextSearchCriteria(regex);
    PossibleWatermarkCollection watermarks = watermarker.Search(textSearchCriteria.Or(imageSearchCriteria));
    watermarks.Clear();
    watermarker.Save(@"D:\output.doc");
}
```

### SearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/searchableobjects.md

#### Watermarker.SearchableObjects property

Gets or sets the content objects that are to be included in a watermark search.

```csharp
public SearchableObjects SearchableObjects { get; set; }
```

##### Property Value

The objects that are to be included in a watermark search.

##### Remarks

This property also specifies content objects which are used in image search. For more information see `Search` and `GetImages` methods.

Learn more about searching watermarks: [Searching watermarks](https://docs.groupdocs.com/display/watermarknet/Searching+watermarks).

##### Examples

Remove all XObjects and Artifacts from a pdf document.

```csharp
using (Watermarker watermarker = new Watermarker(@"D:\test.pdf"))
{
    // Specify that only XObjects and Artifacts should be searched for.
    watermarker.SearchableObjects.PdfSearchableObjects
        = PdfSearchableObjects.XObjects | PdfSearchableObjects.Artifacts; 

    PossibleWatermarkCollection watermarks = watermarker.Search();

    // Remove all found objects.
    watermarks.Clear();

    // Save changes.
    watermarker.Save();
}
```

### Watermarker
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarker/watermarker.md

#### Watermarker(string)

Initializes a new instance of the `Watermarker` class with the specified document path.

```csharp
public Watermarker(string filePath)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load the document from. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents: [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Load and save a content of any supported format.

```csharp
// Load a content from a file.
using (Watermarker watermarker = new Watermarker("D:\\input.pdf"))
{
    // Use methods of Watermarker class to add, search or remove watermarks.

    // Save the document.
    watermarker.Save("D:\\output.pdf");
}
```

#### Watermarker(string, LoadOptions)

Initializes a new instance of the `Watermarker` class with the specified document path and load options.

```csharp
public Watermarker(string filePath, LoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents: [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Load encrypted PDF document using password.

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
loadOptions.Password = "123";
using (Watermarker watermarker = new Watermarker(@"C:\Documents\test.pdf", loadOptions))
{
    // ...
}
```

#### Watermarker(string, WatermarkerSettings)

Initializes a new instance of the `Watermarker` class with the specified document path and settings.

```csharp
public Watermarker(string filePath, WatermarkerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load document from. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents: [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Set searchable objects globally (for all documents that will be loaded after that).

```csharp
WatermarkerSettings settings = new WatermarkerSettings();
settings.SearchableObjects = new SearchableObjects
{
    WordProcessingSearchableObjects = WordProcessingSearchableObjects.Hyperlinks
                                    | WordProcessingSearchableObjects.Text,
    SpreadsheetSearchableObjects = SpreadsheetSearchableObjects.HeadersFooters,
    PresentationSearchableObjects = PresentationSearchableObjects.SlidesBackgrounds
                                  | PresentationSearchableObjects.Shapes,
    DiagramSearchableObjects = DiagramSearchableObjects.None,
    PdfSearchableObjects = PdfSearchableObjects.All
};

foreach (string file in Directory.GetFiles(@"D:\files"))
{
    using (Watermarker watermarker = new Watermarker(file, settings))
    {
        PossibleWatermarkCollection watermarks = watermarker.Search();

        // The code for working with found watermarks goes here.
    }
}
```

#### Watermarker(string, LoadOptions, WatermarkerSettings)

Initializes a new instance of the `Watermarker` class with the specified document path, load options and settings.

```csharp
public Watermarker(string filePath, LoadOptions options, WatermarkerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| filePath | String | The file path to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents: [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Find particular text fragments in email message body/subject.

```csharp
WatermarkerSettings settings = new WatermarkerSettings();
settings.SearchableObjects = new SearchableObjects
{
    EmailSearchableObjects = EmailSearchableObjects.Subject
                           | EmailSearchableObjects.HtmlBody
                           | EmailSearchableObjects.PlainTextBody
};
EmailLoadOptions loadOptions = new EmailLoadOptions();
using (Watermarker watermarker = new Watermarker(@"D:\test.msg", loadOptions, settings))
{
    SearchCriteria criteria = new TextSearchCriteria("test", false);
    // Note, search is performed only if you pass TextSearchCriteria instance to Search method
    PossibleWatermarkCollection watermarks = watermarker.Search(criteria);
    // Remove found text fragments
    watermarks.Clear();
    // Save changes
    watermarker.Save();
}
```

#### Watermarker(Stream)

Initializes a new instance of the `Watermarker` class with the specified stream.

```csharp
public Watermarker(Stream document)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to load document from. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Load and save a document of any supported format.

```csharp
// Load a content from a stream.
using (FileStream inputStream = File.Open("D:\\input.pdf", FileMode.Open))
using (FileStream outputStream = File.Open("D:\\output.pdf", FileMode.Create))
using (Watermarker watermarker = new Watermarker(inputStream))
{
    // Use methods of Watermarker class to add, search or remove watermarks.

    // Save changes.
    watermarker.Save(outputStream);
}
```

#### Watermarker(Stream, LoadOptions)

Initializes a new instance of the `Watermarker` class with the specified stream and load options.

```csharp
public Watermarker(Stream document, LoadOptions options)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Load encrypted PDF document using password

```csharp
PdfLoadOptions loadOptions = new PdfLoadOptions();
loadOptions.Password = "123";
using (FileStream fileStream = File.Open(@"C:\Documents\test.pdf", FileMode.Open))
using (Watermarker watermarker = new Watermarker(fileStream, loadOptions))
{
    // ...
}
```

#### Watermarker(Stream, WatermarkerSettings)

Initializes a new instance of the `Watermarker` class with the specified stream and settings.

```csharp
public Watermarker(Stream document, WatermarkerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to load document from. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Set searchable objects globally (for all documents that will be loaded after that).

```csharp
WatermarkerSettings settings = new WatermarkerSettings();
settings.SearchableObjects = new SearchableObjects
{
    WordProcessingSearchableObjects = WordProcessingSearchableObjects.Hyperlinks
                                    | WordProcessingSearchableObjects.Text,
    SpreadsheetSearchableObjects = SpreadsheetSearchableObjects.HeadersFooters,
    PresentationSearchableObjects = PresentationSearchableObjects.SlidesBackgrounds
                                  | PresentationSearchableObjects.Shapes,
    DiagramSearchableObjects = DiagramSearchableObjects.None,
    PdfSearchableObjects = PdfSearchableObjects.All
};

foreach (string file in Directory.GetFiles(@"D:\files"))
{
    using (FileStream fileStream = File.Open(file, FileMode.Open))
    using (Watermarker watermarker = new Watermarker(fileStream, settings))
    {
        PossibleWatermarkCollection watermarks = watermarker.Search();

        // The code for working with found watermarks goes here.
    }
}
```

#### Watermarker(Stream, LoadOptions, WatermarkerSettings)

Initializes a new instance of the `Watermarker` class with the specified stream, load options and settings.

```csharp
public Watermarker(Stream document, LoadOptions options, WatermarkerSettings settings)
```

| Parameter | Type | Description |
| --- | --- | --- |
| document | Stream | The stream to load document from. |
| options | LoadOptions | Additional options to use when loading a document. |
| settings | WatermarkerSettings | Additional settings to use when working with loaded document. |

##### Exceptions

| exception | condition |
| --- | --- |
| UnsupportedFileTypeException | Supplied document type is not supported. |
| InvalidPasswordException | Supplied password is incorrect. |

##### Remarks

Learn more about loading documents [Loading documents](https://docs.groupdocs.com/display/watermarknet/Loading+documents).

##### Examples

Find particular text fragments in email message body/subject.

```csharp
WatermarkerSettings settings = new WatermarkerSettings();
settings.SearchableObjects = new SearchableObjects
{
    EmailSearchableObjects = EmailSearchableObjects.Subject
                           | EmailSearchableObjects.HtmlBody
                           | EmailSearchableObjects.PlainTextBody
};
EmailLoadOptions loadOptions = new EmailLoadOptions();
using (FileStream fileStream = File.Open(@"D:\test.msg", FileMode.Open))
using (Watermarker watermarker = new Watermarker(fileStream, loadOptions, settings))
{
    SearchCriteria criteria = new TextSearchCriteria("test", false);
    // Note, search is performed only if you pass TextSearchCriteria instance to Search method
    PossibleWatermarkCollection watermarks = watermarker.Search(criteria);
    // Remove found text fragments
    watermarks.Clear();
    // Save changes
    watermarker.Save();
}
```

### WatermarkerSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarkersettings.md

#### WatermarkerSettings class

Defines settings for customizing Watermarker behaviour.

```csharp
public sealed class WatermarkerSettings
```

#### Constructors

| Name | Description |
| --- | --- |
| WatermarkerSettings() | Initializes new instance of `WatermarkerSettings` class. |

#### Properties

| Name | Description |
| --- | --- |
| static Default { get; } | Gets the default value for the `WatermarkerSettings` class. |
| Logger { get; set; } | Gets or sets the logger which is used for logging events and errors during watermarking. |
| SearchableObjects { get; set; } | Gets or sets `SearchableObjects` that are to be included in a watermark search. |

### Default
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarkersettings/default.md

#### WatermarkerSettings.Default property

Gets the default value for the `WatermarkerSettings` class.

```csharp
public static WatermarkerSettings Default { get; }
```

##### Property Value

The default value for the `WatermarkerSettings` class.

### Logger
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarkersettings/logger.md

#### WatermarkerSettings.Logger property

Gets or sets the logger which is used for logging events and errors during watermarking.

```csharp
public ILogger Logger { get; set; }
```

##### Property Value

An instance of class that implements `ILogger` interface.

### SearchableObjects
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarkersettings/searchableobjects.md

#### WatermarkerSettings.SearchableObjects property

Gets or sets `SearchableObjects` that are to be included in a watermark search.

```csharp
public SearchableObjects SearchableObjects { get; set; }
```

##### Property Value

The `SearchableObjects` that are to be included in a watermark search.

### WatermarkerSettings
Path: https://reference.groupdocs.com/watermark/net/groupdocs.watermark/watermarkersettings/watermarkersettings.md

#### WatermarkerSettings constructor

Initializes new instance of `WatermarkerSettings` class.

```csharp
public WatermarkerSettings()
```

## Python

### GroupDocs.Watermark for Python via .NET
Path: https://reference.groupdocs.com/watermark/python-net.md

##### Modules
| Module | Description |
| :- | :- |
| `groupdocs.watermark` | Main GroupDocs.Watermark namespace with top-level API classes. |
| `groupdocs.watermark.common` | Types under `groupdocs.watermark.common`. |
| `groupdocs.watermark.contents` | Types under `groupdocs.watermark.contents`. |
| `groupdocs.watermark.contents.diagram` | Types under `groupdocs.watermark.contents.diagram`. |
| `groupdocs.watermark.contents.email` | Types under `groupdocs.watermark.contents.email`. |
| `groupdocs.watermark.contents.image` | Types under `groupdocs.watermark.contents.image`. |
| `groupdocs.watermark.contents.pdf` | Types under `groupdocs.watermark.contents.pdf`. |
| `groupdocs.watermark.contents.presentation` | Types under `groupdocs.watermark.contents.presentation`. |
| `groupdocs.watermark.contents.spreadsheet` | Types under `groupdocs.watermark.contents.spreadsheet`. |
| `groupdocs.watermark.contents.word_processing` | Types under `groupdocs.watermark.contents.word_processing`. |
| `groupdocs.watermark.internal` | Types under `groupdocs.watermark.internal`. |
| `groupdocs.watermark.options` | Option classes for configuring conversions and operations. |
| `groupdocs.watermark.options.diagram` | Types under `groupdocs.watermark.options.diagram`. |
| `groupdocs.watermark.options.email` | Types under `groupdocs.watermark.options.email`. |
| `groupdocs.watermark.options.image` | Types under `groupdocs.watermark.options.image`. |
| `groupdocs.watermark.options.pdf` | Types under `groupdocs.watermark.options.pdf`. |
| `groupdocs.watermark.options.presentation` | Types under `groupdocs.watermark.options.presentation`. |
| `groupdocs.watermark.options.spreadsheet` | Types under `groupdocs.watermark.options.spreadsheet`. |
| `groupdocs.watermark.options.word_processing` | Types under `groupdocs.watermark.options.word_processing`. |
| `groupdocs.watermark.search` | Types under `groupdocs.watermark.search`. |
| `groupdocs.watermark.search.objects` | Types under `groupdocs.watermark.search.objects`. |
| `groupdocs.watermark.search.search_criteria` | Types under `groupdocs.watermark.search.search_criteria`. |
| `groupdocs.watermark.search.watermarks` | Types under `groupdocs.watermark.search.watermarks`. |
| `groupdocs.watermark.watermarks` | Types under `groupdocs.watermark.watermarks`. |
| `groupdocs.watermark.watermarks.results` | Result types produced by converter and processor methods. |

##### Developer Guide
* Task guides with runnable examples

### groupdocs.watermark.common
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common.md

Types under `groupdocs.watermark.common`.

##### Classes
| Class | Description |
| :- | :- |
| `Attachment` | Represents a file attached to a document. |
| `FileType` | Represents file type. |
| `IDocumentInfo` | Provides methods required for retrieving basic document information. |
| `PageInfo` | Represents a document page description. |
| `ReadOnlyListBase` |  |
| `RemoveOnlyListBase` |  |

##### Enumerations
| Enum | Description |
| :- | :- |
| `AttachmentWatermarkableImage` | Represents an attached image inside a content of any supported type. |
| `Dimension` |  |
| `FormatFamily` |  |
| `HorizontalAlignment` |  |
| `VerticalAlignment` |  |

### Attachment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachment.md

#### Attachment class

Represents a file attached to a document.

Learn more
- [Email attachments](https://docs.groupdocs.com/display/watermarknet/Email+attachments)
- [Attachments in PDF document](https://docs.groupdocs.com/display/watermarknet/Attachments+in+PDF+document)
- [Working with spreadsheet document attachments](https://docs.groupdocs.com/display/watermarknet/Working+with+spreadsheet+document+attachments)

The Attachment type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. |
| create_watermarker | Loads a content from the attached file with the specified load options. |
| create_watermarker | Loads a content from the attached file with the specified load options and settings. |
| create_watermarker_load_options |  |
| get_document_info | Gets the information about a document stored in the attached file. |

##### Properties
| Property | Description |
| :- | :- |
| content | The attached file content. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
from groupdocs.watermark.common import FileType

watermark = gww.TextWatermark("This is WaterMark on Attachment", gww.Font("Arial", 19.0))

with gw.Watermarker("document.pdf", gw.PdfLoadOptions()) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for attachment in pdf_content.attachments:
        info = attachment.get_document_info()
        if info.file_type != FileType.UNKNOWN and not info.is_encrypted:
            with attachment.create_watermarker() as attached:
                attached.add(watermark)
                attached.save()
    watermarker.save("document.pdf")
```

##### Guides
Task guides that use `Attachment`:

* Working with spreadsheet document attachments

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachment/content.md

#### content property

The attached file content.

##### Definition:
```python
@property
def content(self):
    ...
@content.setter
def content(self, value):
    ...
```

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachment/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

```python
def create_watermarker(self):
    ...
```

**Returns:** An instance of a subclass of `Content` representing the loaded content.

##### Example

```python
    import groupdocs.watermark as gw
    import groupdocs.watermark.contents.pdf as gwc_pdf
    import groupdocs.watermark.watermarks as gww

    watermark = gww.TextWatermark("Sample", gww.Font("Arial", 19.0))

    with gw.Watermarker("document.pdf") as watermarker:
        pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
        for attachment in pdf_content.attachments:
            with attachment.create_watermarker() as attached:
                attached.add(watermark)
                attached.save()
    ```

#### create_watermarker

Loads a content from the attached file with the specified load options.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | `LoadOptions` | Additional options to use when loading an attachment content. |

**Returns:** The instance of appropriate descendant of `Content` class.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww

watermark = gww.TextWatermark("Sample watermark", gww.Font("Arial", 19.0))

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for attachment in pdf_content.attachments:
        with attachment.create_watermarker() as attached:
            attached.add(watermark)
            attached.save()
    watermarker.save("document.pdf")
```

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | `LoadOptions` | Additional options to use when loading an attachment content. |
| watermarker_settings | `WatermarkerSettings` | Additional settings to use when working with loaded document. |

**Returns:** An instance of a subclass of `Content` representing the loaded content.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
from groupdocs.watermark.common import FileType

watermark = gww.TextWatermark("This is WaterMark on Attachment", gww.Font("Arial", 19.0))

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for attachment in pdf_content.attachments:
        info = attachment.get_document_info()
        if info.file_type != FileType.UNKNOWN and not info.is_encrypted:
            with attachment.create_watermarker() as attached:
                attached.add(watermark)
                attached.save()
    watermarker.save("document.pdf")
```

### create_watermarker_load_options method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachment/create_watermarker_load_options.md

#### create_watermarker_load_options

```python
def create_watermarker_load_options(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachment/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

```python
def get_document_info(self):
    ...
```

**Returns:** `IDocumentInfo`: Instance that contains detected information.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

with gw.Watermarker("document.pdf", gw.PdfLoadOptions()) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for attachment in pdf_content.attachments:
        info = attachment.get_document_info()
        print(info.file_type, info.is_encrypted)
```

### AttachmentWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage.md

#### AttachmentWatermarkableImage class

Represents an attached image inside a content of any supported type.

The AttachmentWatermarkableImage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/attachmentwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### Dimension class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/dimension.md

#### Dimension class

The Dimension type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| WIDTH | Object width. |
| HEIGHT | Object height. |

### HEIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/dimension/height.md

#### HEIGHT field

Object height.

##### Value
`1`

### WIDTH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/dimension/width.md

#### WIDTH field

Object width.

##### Value
`0`

### FileType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype.md

#### FileType class

Represents file type.

Provides methods to obtain the list of all file types supported by GroupDocs.Watermark.

- Supported Document Formats: https://docs.groupdocs.com/display/watermarknet/Supported+Document+Formats
- Get supported file formats: https://docs.groupdocs.com/display/watermarknet/Get+supported+file+formats
- Get document info: https://docs.groupdocs.com/display/watermarknet/Get+document+info

The FileType type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the current `FileType` is the same as the specified `FileType` object. |
| equals | Returns True if the current `FileType` is equal to the specified object, otherwise False. |
| equals_file_type |  |
| equals_object |  |
| from_extension | Maps the file extension to the file type. |
| get_hash_code | Returns a hash code for the current `FileType` object. |
| get_supported_file_types | Retrieves the supported file types. |
| to_string | Returns a string that represents the current object. |

##### Properties
| Property | Description |
| :- | :- |
| extension | The file name suffix (including the period "."). |
| file_format_name | The file type name, e.g., "Microsoft Word Document". |
| format_family | The format family. |

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Represents unknown file type. |
| OOXML | Office open xml file (.ooxml). |
| 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 | Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format here. |
| 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. |
| VSSX | Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format here. |
| VSDM | Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format here. |
| VST | Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. Learn more about this file format here. |
| VSTX | Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format here. |
| VSTM | Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format here. |
| VSSM | Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format here. |
| VSX | Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format here. |
| VTX | A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format here. |
| 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 | Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format here. |
| 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 | EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format here. |
| 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. |
| OFT | Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format here. |
| TIF | TIFF or 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. Learn more about this file format here. |
| TIFF | TIFF or 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. Learn more about this file format here. |
| JPG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here. |
| JPEG | A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here. |
| PNG | PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format here. |
| GIF | A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format here. |
| BMP | Files having extension .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. |
| JPF | JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here. |
| JPX | JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here. |
| JPM | JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| XLS | Files with XLS extension represent 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 | 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 | Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format here. |
| XLTX | Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format here. |
| XLTM | The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format here. |
| 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. |
| 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. Learn more about this file format here. |
| 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. |
| 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. |
| DOCM | DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here. |
| 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. |
| 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. |
| DOTM | A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here. |
| RTF | Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format here. |
| ODT | ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format here. |
| FLAT_OPC | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here. |
| FLAT_OPC_MACRO_ENABLED | Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here. |
| FLAT_OPC_TEMPLATE | Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here. |
| FLAT_OPC_TEMPLATE_MACRO_ENABLED | Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here. |

##### Example

```python
from groupdocs.watermark.common import FileType

supported = FileType.get_supported_file_types()
for ft in supported:
    print(ft)
```

##### Guides
Task guides that use `FileType`:

* Email attachments
* Email messages
* Attachments in PDF document
* Working with spreadsheet document attachments
* Get supported file formats

### BMP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/bmp.md

#### BMP field

Files having extension .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.

### DOC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/doc.md

#### 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.

### DOCM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/docm.md

#### 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.

### DOCX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/docx.md

#### 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.

### DOT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/dot.md

#### 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.

### DOTM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/dotm.md

#### DOTM field

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.

### DOTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/dotx.md

#### 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.

### EML field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/eml.md

#### EML field

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format here.

### EMLX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/emlx.md

#### 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.

### equals method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/equals.md

#### equals

Determines whether the current `FileType` is the same as the specified `FileType` object.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `FileType` | The object to compare with the current `FileType` object. |

**Returns:** True if both `FileType` objects are the same; otherwise, False.

#### equals

Returns True if the current `FileType` is equal to the specified object, otherwise False.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to compare with the current `FileType` object. |

**Returns:** bool: True if `obj` is a `FileType` and is the same as the current `FileType`; otherwise False.

### equals_file_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/equals_file_type.md

#### equals_file_type

```python
def equals_file_type(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### extension property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/extension.md

#### extension property

The file name suffix (including the period ".").

##### Definition:
```python
@property
def extension(self):
    ...
```

### file_format_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/file_format_name.md

#### file_format_name property

The file type name, e.g., "Microsoft Word Document".

##### Definition:
```python
@property
def file_format_name(self):
    ...
```

### FLAT_OPC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/flat_opc.md

#### FLAT_OPC field

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

### FLAT_OPC_MACRO_ENABLED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/flat_opc_macro_enabled.md

#### FLAT_OPC_MACRO_ENABLED field

Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

### FLAT_OPC_TEMPLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/flat_opc_template.md

#### FLAT_OPC_TEMPLATE field

Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

### FLAT_OPC_TEMPLATE_MACRO_ENABLED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/flat_opc_template_macro_enabled.md

#### FLAT_OPC_TEMPLATE_MACRO_ENABLED field

Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/format_family.md

#### format_family property

The format family.

##### Definition:
```python
@property
def format_family(self):
    ...
```

### from_extension method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/from_extension.md

#### from_extension

Maps the file extension to the file type.

```python
def from_extension(cls, extension):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| extension | `str` | The file extension (including the period "."). |

**Returns:** FileType: The corresponding file type if supported; otherwise returns `FileType.Unknown`.

| Raises | Description |
| :- | :- |
| `ValueError` | When `extension` is None or an empty string. |

### get_hash_code method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/get_hash_code.md

#### get_hash_code

Returns a hash code for the current `FileType` object.

```python
def get_hash_code(self):
    ...
```

**Returns:** A hash code for the current `FileType` object.

### get_supported_file_types method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/get_supported_file_types.md

#### get_supported_file_types

Retrieves the supported file types.

```python
def get_supported_file_types(cls):
    ...
```

**Returns:** Iterable[FileType]: The sequence of supported file types.

##### Example

```python
    from groupdocs.watermark.common import FileType

    supported = FileType.get_supported_file_types()
    for ft in supported:
        print(ft)
    ```

### GIF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/gif.md

#### GIF field

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format here.

### JPEG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/jpeg.md

#### JPEG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

### JPF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/jpf.md

#### JPF field

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

### JPG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/jpg.md

#### JPG field

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

### JPM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/jpm.md

#### JPM field

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

### JPX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/jpx.md

#### JPX field

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

### MSG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/msg.md

#### 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.

### ODT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/odt.md

#### ODT field

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format here.

### OFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/oft.md

#### OFT field

Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format here.

### OOXML field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/ooxml.md

#### OOXML field

Office open xml file (.ooxml).

### PDF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/pdf.md

#### 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.

### PNG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/png.md

#### PNG field

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format here.

### POTM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/potm.md

#### 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.

### POTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/potx.md

#### 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.

### PPS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/pps.md

#### 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.

### PPSM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/ppsm.md

#### 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.

### PPSX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/ppsx.md

#### 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.

### PPT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/ppt.md

#### 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.

### PPTM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/pptm.md

#### 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.

### PPTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/pptx.md

#### 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.

### RTF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/rtf.md

#### 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. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format here.

### TIF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/tif.md

#### TIF field

TIFF or 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. Learn more about this file format here.

### TIFF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/tiff.md

#### TIFF field

TIFF or 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. Learn more about this file format here.

### to_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/to_string.md

#### to_string

Returns a string that represents the current object.

```python
def to_string(self):
    ...
```

**Returns:** str: A string that represents the current object.

### UNKNOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/unknown.md

#### UNKNOWN field

Represents unknown file type.

### VDW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vdw.md

#### 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.

### VDX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vdx.md

#### VDX field

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format here.

### VSD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vsd.md

#### 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.

### VSDM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vsdm.md

#### VSDM field

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format here.

### VSDX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vsdx.md

#### VSDX field

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format here.

### VSS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vss.md

#### 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.

### VSSM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vssm.md

#### VSSM field

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format here.

### VSSX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vssx.md

#### VSSX field

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format here.

### VST field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vst.md

#### VST field

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. Learn more about this file format here.

### VSTM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vstm.md

#### VSTM field

Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format here.

### VSTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vstx.md

#### VSTX field

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format here.

### VSX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vsx.md

#### VSX field

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format here.

### VTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/vtx.md

#### VTX field

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format here.

### WEBP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/webp.md

#### 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.

### XLS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xls.md

#### XLS field

Files with XLS extension represent 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.

### XLSB field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xlsb.md

#### 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.

### XLSM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xlsm.md

#### XLSM field

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format here.

### XLSX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xlsx.md

#### 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.

### XLT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xlt.md

#### 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. Learn more about this file format here.

### XLTM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xltm.md

#### XLTM field

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format here.

### XLTX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/filetype/xltx.md

#### XLTX field

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format here.

### FormatFamily class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily.md

#### FormatFamily class

The FormatFamily type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNKNOWN | Unknown format family. |
| DIAGRAM | Diagram format family. |
| EMAIL | Email format family. |
| IMAGE | Image format family. |
| MULTIFRAME_IMAGE | Multi frame image format family. |
| PDF | PDF format family. |
| PRESENTATION | Presentation format family. |
| SPREADSHEET | Spreadsheet format family. |
| WORD_PROCESSING | Word processing format family. |

### DIAGRAM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/diagram.md

#### DIAGRAM field

Diagram format family.

##### Value
`1`

### EMAIL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/email.md

#### EMAIL field

Email format family.

##### Value
`2`

### IMAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/image.md

#### IMAGE field

Image format family.

##### Value
`3`

### MULTIFRAME_IMAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/multiframe_image.md

#### MULTIFRAME_IMAGE field

Multi frame image format family.

##### Value
`4`

### PDF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/pdf.md

#### PDF field

PDF format family.

##### Value
`5`

### PRESENTATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/presentation.md

#### PRESENTATION field

Presentation format family.

##### Value
`6`

### SPREADSHEET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/spreadsheet.md

#### SPREADSHEET field

Spreadsheet format family.

##### Value
`7`

### UNKNOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/unknown.md

#### UNKNOWN field

Unknown format family.

##### Value
`0`

### WORD_PROCESSING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/formatfamily/word_processing.md

#### WORD_PROCESSING field

Word processing format family.

##### Value
`8`

### HorizontalAlignment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/horizontalalignment.md

#### HorizontalAlignment class

The HorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No alignment (use specified position). |
| LEFT | Align to left. |
| CENTER | Center alignment. |
| RIGHT | Align to right. |

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/horizontalalignment/center.md

#### CENTER field

Center alignment.

##### Value
`2`

### LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/horizontalalignment/left.md

#### LEFT field

Align to left.

##### Value
`1`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/horizontalalignment/none.md

#### NONE field

No alignment (use specified position).

##### Value
`0`

### RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/horizontalalignment/right.md

#### RIGHT field

Align to right.

##### Value
`3`

### IDocumentInfo class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo.md

#### IDocumentInfo class

Provides methods required for retrieving basic document information.

Learn more:

- Get document info (https://docs.groupdocs.com/display/watermarknet/Get+document+info)

The IDocumentInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file format description. |
| is_encrypted | The document is encrypted and requires a password to open; returns True if encrypted, otherwise False. |
| page_count | The total page count. |
| pages | The collection of document pages descriptions. |
| size | The document size in bytes. |

##### Example

```python
from groupdocs.watermark import Watermarker

with Watermarker(r"D:\input.pdf") as watermarker:
    doc_info = watermarker.get_document_info()
    print(f"Document size: {doc_info.size}")
    print(f"Document format: {doc_info.file_type.file_format}")
    print(f"Document contains {doc_info.page_count} pages")
```

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo/file_type.md

#### file_type property

The file format description.

##### Definition:
```python
@property
def file_type(self):
    ...
```

### is_encrypted property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo/is_encrypted.md

#### is_encrypted property

The document is encrypted and requires a password to open; returns True if encrypted, otherwise False.

##### Definition:
```python
@property
def is_encrypted(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo/page_count.md

#### page_count property

The total page count.

##### Definition:
```python
@property
def page_count(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo/pages.md

#### pages property

The collection of document pages descriptions.

##### Definition:
```python
@property
def pages(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/idocumentinfo/size.md

#### size property

The document size in bytes.

##### Definition:
```python
@property
def size(self):
    ...
```

### PageInfo class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/pageinfo.md

#### PageInfo class

Represents a document page description.

The PageInfo type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The document page height. |
| page_number | The document page number. |
| width | The document page width. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/pageinfo/height.md

#### height property

The document page height.

##### Definition:
```python
@property
def height(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/pageinfo/page_number.md

#### page_number property

The document page number.

##### Definition:
```python
@property
def page_number(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/pageinfo/width.md

#### width property

The document page width.

##### Definition:
```python
@property
def width(self):
    ...
```

### ReadOnlyListBase class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase.md

#### ReadOnlyListBase class

The ReadOnlyListBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  |
| get_enumerator |  |
| index_of |  |

##### Properties
| Property | Description |
| :- | :- |
| count |  |
| is_read_only |  |
| item |  |

### contains method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/contains.md

#### contains

```python
def contains(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item |  |  |

### count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/count.md

##### Definition:
```python
@property
def count(self):
    ...
```

### get_enumerator method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/get_enumerator.md

#### get_enumerator

```python
def get_enumerator(self):
    ...
```

### index_of method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/index_of.md

#### index_of

```python
def index_of(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item |  |  |

### is_read_only property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/is_read_only.md

##### Definition:
```python
@property
def is_read_only(self):
    ...
```

### item property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/readonlylistbase/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### RemoveOnlyListBase class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase.md

#### RemoveOnlyListBase class

The RemoveOnlyListBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  |
| remove |  |
| remove_at |  |
| remove_at_int32 |  |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  |

### clear method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase/clear.md

#### clear

```python
def clear(self):
    ...
```

### is_read_only property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase/is_read_only.md

##### Definition:
```python
@property
def is_read_only(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase/remove.md

#### remove

```python
def remove(self, item):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| item |  |  |

### remove_at method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase/remove_at.md

#### remove_at

```python
def remove_at(self, index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` |  |

### remove_at_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/removeonlylistbase/remove_at_int32.md

#### remove_at_int32

```python
def remove_at_int32(self):
    ...
```

### VerticalAlignment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/verticalalignment.md

#### VerticalAlignment class

The VerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | No alignment (use specified position). |
| TOP | Align to top. |
| CENTER | Center alignment. |
| BOTTOM | Align to bottom. |

### BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/verticalalignment/bottom.md

#### BOTTOM field

Align to bottom.

##### Value
`3`

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/verticalalignment/center.md

#### CENTER field

Center alignment.

##### Value
`2`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/verticalalignment/none.md

#### NONE field

No alignment (use specified position).

##### Value
`0`

### TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.common/verticalalignment/top.md

#### TOP field

Align to top.

##### Value
`1`

### groupdocs.watermark.contents.diagram
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram.md

Types under `groupdocs.watermark.contents.diagram`.

##### Classes
| Class | Description |
| :- | :- |
| `DiagramContent` | Represents a Visio document. |
| `DiagramFormattedTextFragment` | Represents a fragment of formatted text in a Visio document. |
| `DiagramHeaderFooter` | Represents a header/footer in a Visio document. |
| `DiagramHeaderFooterFont` | Represents a font that is used in Visio header/footer. |
| `DiagramHyperlink` | Represents a hyperlink in a Visio document. |
| `DiagramPage` | Represents a Visio document page. |
| `DiagramShape` | Represents a drawing shape in a Visio document. |
| `DiagramWatermarkableImage` | Represents an image inside a Visio document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `DiagramFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Visio document. |
| `DiagramHyperlinkCollection` | Represents a collection of hyperlinks in a Visio document. |
| `DiagramPageCollection` | Represents a collection of pages in a Visio document. |
| `DiagramShapeCollection` | Represents a collection of drawing shapes in a Visio document. |
| `DiagramWatermarkPlacementType` |  |

### DiagramContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramcontent.md

#### DiagramContent class

Represents a Visio document.

Learn more:

- Add watermarks to diagram documents: https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents
- Existing objects in diagram document: https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+diagram+document

The DiagramContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| header_footer | The header and footer of this DiagramContent. |
| pages | The collection of all pages of this `DiagramContent`. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramcontent/header_footer.md

#### header_footer property

The header and footer of this DiagramContent.

##### Definition:
```python
@property
def header_footer(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramcontent/pages.md

#### pages property

The collection of all pages of this `DiagramContent`.

##### Definition:
```python
@property
def pages(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### DiagramFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment.md

#### DiagramFormattedTextFragment class

Represents a fragment of formatted text in a Visio document.

The DiagramFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### DiagramFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragmentcollection.md

#### DiagramFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Visio document.

This collection contains items of `DiagramFormattedTextFragment` type.

The DiagramFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### DiagramHeaderFooter class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter.md

#### DiagramHeaderFooter class

Represents a header/footer in a Visio document.

The DiagramHeaderFooter type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| font | The font used for header and footer text. |
| footer_center | The text string that appears in the center portion of document footer. |
| footer_left | The text string that appears in the left portion of the document footer. |
| footer_margin | The margin of the document footer. |
| footer_right | The text string that appears in the right portion of document footer. |
| header_center | The text string that appears in the center portion of document header. |
| header_left | The text string that appears in the left portion of the document header. |
| header_margin | The margin of document header. |
| header_right | The text string that appears in the right portion of document header. |
| text_color | The text color for header and footer. |

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/font.md

#### font property

The font used for header and footer text.

##### Definition:
```python
@property
def font(self):
    ...
```

### footer_center property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footer_center.md

#### footer_center property

The text string that appears in the center portion of document footer.

##### Definition:
```python
@property
def footer_center(self):
    ...
@footer_center.setter
def footer_center(self, value):
    ...
```

### footer_left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footer_left.md

#### footer_left property

The text string that appears in the left portion of the document footer.

##### Definition:
```python
@property
def footer_left(self):
    ...
@footer_left.setter
def footer_left(self, value):
    ...
```

### footer_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footer_margin.md

#### footer_margin property

The margin of the document footer.

##### Definition:
```python
@property
def footer_margin(self):
    ...
@footer_margin.setter
def footer_margin(self, value):
    ...
```

### footer_right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/footer_right.md

#### footer_right property

The text string that appears in the right portion of document footer.

##### Definition:
```python
@property
def footer_right(self):
    ...
@footer_right.setter
def footer_right(self, value):
    ...
```

### header_center property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/header_center.md

#### header_center property

The text string that appears in the center portion of document header.

##### Definition:
```python
@property
def header_center(self):
    ...
@header_center.setter
def header_center(self, value):
    ...
```

### header_left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/header_left.md

#### header_left property

The text string that appears in the left portion of the document header.

##### Definition:
```python
@property
def header_left(self):
    ...
@header_left.setter
def header_left(self, value):
    ...
```

### header_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/header_margin.md

#### header_margin property

The margin of document header.

##### Definition:
```python
@property
def header_margin(self):
    ...
@header_margin.setter
def header_margin(self, value):
    ...
```

### header_right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/header_right.md

#### header_right property

The text string that appears in the right portion of document header.

##### Definition:
```python
@property
def header_right(self):
    ...
@header_right.setter
def header_right(self, value):
    ...
```

### text_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooter/text_color.md

#### text_color property

The text color for header and footer.

##### Definition:
```python
@property
def text_color(self):
    ...
@text_color.setter
def text_color(self, value):
    ...
```

### DiagramHeaderFooterFont class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont.md

#### DiagramHeaderFooterFont class

Represents a font that is used in Visio header/footer.

The DiagramHeaderFooterFont type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| bold | The font is bold. |
| family_name | The font family name. |
| italic | The font is italic. |
| size | The height of the font. |
| strikeout | The font is strikeout. True if this font is strikeout; otherwise False. |
| underline | The underline state of the font. |

### bold property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/bold.md

#### bold property

The font is bold.

##### Definition:
```python
@property
def bold(self):
    ...
@bold.setter
def bold(self, value):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/family_name.md

#### family_name property

The font family name.

##### Definition:
```python
@property
def family_name(self):
    ...
@family_name.setter
def family_name(self, value):
    ...
```

### italic property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/italic.md

#### italic property

The font is italic.

True if the font is italic; otherwise, False.

##### Definition:
```python
@property
def italic(self):
    ...
@italic.setter
def italic(self, value):
    ...
```

### size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/size.md

#### size property

The height of the font.

##### Definition:
```python
@property
def size(self):
    ...
@size.setter
def size(self, value):
    ...
```

### strikeout property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/strikeout.md

#### strikeout property

The font is strikeout. True if this font is strikeout; otherwise False.

##### Definition:
```python
@property
def strikeout(self):
    ...
@strikeout.setter
def strikeout(self, value):
    ...
```

### underline property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramheaderfooterfont/underline.md

#### underline property

The underline state of the font.

True if the font is underlined; otherwise, False.

##### Definition:
```python
@property
def underline(self):
    ...
@underline.setter
def underline(self, value):
    ...
```

### DiagramHyperlink class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramhyperlink.md

#### DiagramHyperlink class

Represents a hyperlink in a Visio document.

The DiagramHyperlink type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| address | The hyperlink address. |
| description | The description of the hyperlink. |
| sub_address | The sub-address of the hyperlink, a location within the target content to link to. |

### address property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramhyperlink/address.md

#### address property

The hyperlink address.

##### Definition:
```python
@property
def address(self):
    ...
```

### description property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramhyperlink/description.md

#### description property

The description of the hyperlink.

##### Definition:
```python
@property
def description(self):
    ...
```

### sub_address property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramhyperlink/sub_address.md

#### sub_address property

The sub-address of the hyperlink, a location within the target content to link to.

##### Definition:
```python
@property
def sub_address(self):
    ...
```

### DiagramHyperlinkCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramhyperlinkcollection.md

#### DiagramHyperlinkCollection class

Represents a collection of hyperlinks in a Visio document.

This collection contains the items of `DiagramHyperlink` type.

The DiagramHyperlinkCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### DiagramPage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage.md

#### DiagramPage class

Represents a Visio document page.

The DiagramPage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| background_page | The background page for this DiagramPage. |
| bottom_margin | The size of the bottom margin in points. |
| height | The height of this DiagramPage in points. |
| is_background | The page is a background page flag. |
| is_visible | The value indicating whether the page is visible in UI. |
| left_margin | The size of the left margin in points. |
| name | The name of this DiagramPage. |
| right_margin | The size of the right margin in points. |
| shapes | The collection of all shapes of the page. |
| top_margin | The size of the top margin in points. |
| width | The width of this DiagramPage in points. |

### background_page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/background_page.md

#### background_page property

The background page for this DiagramPage.

##### Definition:
```python
@property
def background_page(self):
    ...
```

### bottom_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/bottom_margin.md

#### bottom_margin property

The size of the bottom margin in points.

##### Definition:
```python
@property
def bottom_margin(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/height.md

#### height property

The height of this DiagramPage in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### is_background property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/is_background.md

#### is_background property

The page is a background page flag.

##### Definition:
```python
@property
def is_background(self):
    ...
```

### is_visible property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/is_visible.md

#### is_visible property

The value indicating whether the page is visible in UI.

True if the page is visible; otherwise, False.

##### Definition:
```python
@property
def is_visible(self):
    ...
@is_visible.setter
def is_visible(self, value):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/left_margin.md

#### left_margin property

The size of the left margin in points.

##### Definition:
```python
@property
def left_margin(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/name.md

#### name property

The name of this DiagramPage.

##### Definition:
```python
@property
def name(self):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/right_margin.md

#### right_margin property

The size of the right margin in points.

##### Definition:
```python
@property
def right_margin(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/shapes.md

#### shapes property

The collection of all shapes of the page.

##### Definition:
```python
@property
def shapes(self):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/top_margin.md

#### top_margin property

The size of the top margin in points.

##### Definition:
```python
@property
def top_margin(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampage/width.md

#### width property

The width of this DiagramPage in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### DiagramPageCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagrampagecollection.md

#### DiagramPageCollection class

Represents a collection of pages in a Visio document.

This collection contains the items of `DiagramPage` type.

The DiagramPageCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### DiagramShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape.md

#### DiagramShape class

Represents a drawing shape in a Visio document.

The DiagramShape type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this DiagramShape. |
| height | The height of this `DiagramShape` in points. |
| hyperlinks | The collection of hyperlinks attached to this `DiagramShape`. |
| id | The identifier of this DiagramShape. |
| image | The image of this `DiagramShape`. Returns `None` if the shape has no image. |
| name | The name of this DiagramShape. |
| page | The parent page of this DiagramShape. |
| rotate_angle | The rotate angle of this DiagramShape in degrees. |
| text | The text of this DiagramShape. |
| width | The width of this DiagramShape in points. |
| x | The horizontal offset of this DiagramShape from the page left border in points. The x-coordinate of this DiagramShape. |
| y | The vertical offset of this DiagramShape from the page bottom border in points. |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this DiagramShape.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/height.md

#### height property

The height of this `DiagramShape` in points.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### hyperlinks property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/hyperlinks.md

#### hyperlinks property

The collection of hyperlinks attached to this `DiagramShape`.

##### Definition:
```python
@property
def hyperlinks(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/id.md

#### id property

The identifier of this DiagramShape.

##### Definition:
```python
@property
def id(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/image.md

#### image property

The image of this `DiagramShape`. Returns `None` if the shape has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/name.md

#### name property

The name of this DiagramShape.

##### Definition:
```python
@property
def name(self):
    ...
```

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/page.md

#### page property

The parent page of this DiagramShape.

##### Definition:
```python
@property
def page(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/rotate_angle.md

#### rotate_angle property

The rotate angle of this DiagramShape in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/text.md

#### text property

The text of this DiagramShape.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/width.md

#### width property

The width of this DiagramShape in points.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/x.md

#### x property

The horizontal offset of this DiagramShape from the page left border in points. The x-coordinate of this DiagramShape.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshape/y.md

#### y property

The vertical offset of this DiagramShape from the page bottom border in points.

The y-coordinate of this DiagramShape.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### DiagramShapeCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramshapecollection.md

#### DiagramShapeCollection class

Represents a collection of drawing shapes in a Visio document.

This collection contains the items of `DiagramShape` type.

The DiagramShapeCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### DiagramWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage.md

#### DiagramWatermarkableImage class

Represents an image inside a Visio document.

The DiagramWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `DiagramWatermarkableImage` instance using the specified image data. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/__init__.md

#### __init__

Initializes a new `DiagramWatermarkableImage` instance using the specified image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | `list[int]` | The array of unsigned bytes from which to create the `DiagramWatermarkableImage`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

with open("test.png", "rb") as f:
    img = gwc_vsdx.DiagramWatermarkableImage(f.read())
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### DiagramWatermarkPlacementType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype.md

#### DiagramWatermarkPlacementType class

The DiagramWatermarkPlacementType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| FOREGROUND_PAGES | A watermark should be added to foreground pages only. |
| BACKGROUND_PAGES | A watermark should be added to background pages only. |
| ALL_PAGES | A watermark should be added to all pages. |
| SEPARATE_BACKGROUNDS | Separate background pages with a watermark should be created and assigned to all pages without background. |

### ALL_PAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype/all_pages.md

#### ALL_PAGES field

A watermark should be added to all pages.

##### Value
`2`

### BACKGROUND_PAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype/background_pages.md

#### BACKGROUND_PAGES field

A watermark should be added to background pages only.

##### Value
`1`

### FOREGROUND_PAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype/foreground_pages.md

#### FOREGROUND_PAGES field

A watermark should be added to foreground pages only.

##### Value
`0`

### SEPARATE_BACKGROUNDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.diagram/diagramwatermarkplacementtype/separate_backgrounds.md

#### SEPARATE_BACKGROUNDS field

Separate background pages with a watermark should be created and assigned to all pages without background.

##### Value
`3`

### groupdocs.watermark.contents.email
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email.md

Types under `groupdocs.watermark.contents.email`.

##### Classes
| Class | Description |
| :- | :- |
| `EmailAddress` | Represents an address of an email message. |
| `EmailAttachment` | Represents a file attached to an email message. |
| `EmailAttachmentBase` | Provides a base class for email attachments. |
| `EmailAttachmentCollection` | Represents a collection of attachments in an email message. |
| `EmailContent` | Represents an email message. |
| `EmailEmbeddedObjectCollection` | Represents a collection of embedded objects in an email message. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `EmailAddressCollection` | Represents a collection of addresses in an email message. |
| `EmailBodyType` |  |
| `EmailEmbeddedObject` | Represents an object embedded to an email message body. |

### EmailAddress class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress.md

#### EmailAddress class

Represents an address of an email message.

The EmailAddress type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| address | The string representation of the email address. |
| display_name | The display name associated with the address. |
| host | The host portion of the address. |
| original_address_string | The original address string. |
| user | The username. |

### address property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress/address.md

#### address property

The string representation of the email address.

##### Definition:
```python
@property
def address(self):
    ...
```

### display_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress/display_name.md

#### display_name property

The display name associated with the address.

##### Definition:
```python
@property
def display_name(self):
    ...
```

### host property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress/host.md

#### host property

The host portion of the address.

##### Definition:
```python
@property
def host(self):
    ...
```

### original_address_string property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress/original_address_string.md

#### original_address_string property

The original address string.

##### Definition:
```python
@property
def original_address_string(self):
    ...
```

### user property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddress/user.md

#### user property

The username.

##### Definition:
```python
@property
def user(self):
    ...
```

### EmailAddressCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailaddresscollection.md

#### EmailAddressCollection class

Represents a collection of addresses in an email message.

This collection contains the items of `EmailAddress` type.

The EmailAddressCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### EmailAttachment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment.md

#### EmailAttachment class

Represents a file attached to an email message.

The EmailAttachment type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. (inherited from `Attachment`) |
| create_watermarker_load_options |  (inherited from `Attachment`) |
| get_document_info | Gets the information about a document stored in the attached file. (inherited from `Attachment`) |

##### Properties
| Property | Description |
| :- | :- |
| name | The name of the attached file. |
| content | The attached file content. (inherited from `EmailAttachmentBase`) |
| content_id | The content id of this `EmailAttachmentBase`. (inherited from `EmailAttachmentBase`) |
| media_type | The media type of this `EmailAttachmentBase`. (inherited from `EmailAttachmentBase`) |

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/content.md

#### content property

Gets or sets the attached file content.

### content_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/content_id.md

#### content_id property

Gets the content id of this `EmailAttachmentBase`.

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self):
    ...
```

#### create_watermarker

Loads a content from the attached file with the specified load options.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |
| watermarker_settings | groupdocs.watermark.WatermarkerSettings | Additional settings to use when working with loaded document. |

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

##### Returns

The `IDocumentInfo` instance that contains detected information

```python
def get_document_info(self):
    ...
```

### media_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/media_type.md

#### media_type property

Gets the media type of this `EmailAttachmentBase`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachment/name.md

#### name property

The name of the attached file.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### EmailAttachmentBase class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase.md

#### EmailAttachmentBase class

Provides a base class for email attachments.

The EmailAttachmentBase type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. (inherited from `Attachment`) |
| create_watermarker_load_options |  (inherited from `Attachment`) |
| get_document_info | Gets the information about a document stored in the attached file. (inherited from `Attachment`) |

##### Properties
| Property | Description |
| :- | :- |
| content | The attached file content. |
| content_id | The content id of this `EmailAttachmentBase`. |
| media_type | The media type of this `EmailAttachmentBase`. |

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase/content.md

#### content property

The attached file content.

##### Definition:
```python
@property
def content(self):
    ...
@content.setter
def content(self, value):
    ...
```

### content_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase/content_id.md

#### content_id property

The content id of this `EmailAttachmentBase`.

##### Definition:
```python
@property
def content_id(self):
    ...
```

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self):
    ...
```

#### create_watermarker

Loads a content from the attached file with the specified load options.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |
| watermarker_settings | groupdocs.watermark.WatermarkerSettings | Additional settings to use when working with loaded document. |

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

##### Returns

The `IDocumentInfo` instance that contains detected information

```python
def get_document_info(self):
    ...
```

### media_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentbase/media_type.md

#### media_type property

The media type of this `EmailAttachmentBase`.

##### Definition:
```python
@property
def media_type(self):
    ...
```

### EmailAttachmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentcollection.md

#### EmailAttachmentCollection class

Represents a collection of attachments in an email message.

This collection contains the items of `EmailAttachment` type.

The EmailAttachmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds an attachment to the EmailContent. |
| add_bytes |  |
| add_file |  |
| add_string |  |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentcollection/add.md

#### add

Adds an attachment to the EmailContent.

```python
def add(self, file_content, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_content | `list[int]` | The content of the file to be attached. |
| name | `str` | The name of the file. |

### add_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentcollection/add_bytes.md

#### add_bytes

```python
def add_bytes(self):
    ...
```

### add_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentcollection/add_file.md

#### add_file

```python
def add_file(self):
    ...
```

### add_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailattachmentcollection/add_string.md

#### add_string

```python
def add_string(self):
    ...
```

### EmailBodyType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailbodytype.md

#### EmailBodyType class

The EmailBodyType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PLAIN_TEXT | Plain text body. |
| HTML | Html-formatted body. |

### HTML field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailbodytype/html.md

#### HTML field

Html-formatted body.

##### Value
`1`

### PLAIN_TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailbodytype/plain_text.md

#### PLAIN_TEXT field

Plain text body.

##### Value
`0`

### EmailContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent.md

#### EmailContent class

Represents an email message.

Learn more:

- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+email+attachments
- https://docs.groupdocs.com/display/watermarknet/Email+attachments
- https://docs.groupdocs.com/display/watermarknet/Email+messages

The EmailContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| attachments | The collection of all attachments of the email message. |
| bcc | The collection of BCC (blind carbon copy) recipients of the email message. |
| body | The plain text representation of the message body. |
| body_type | The type of the email message body. |
| cc | The collection of CC (carbon copy) recipients of the email message. |
| embedded_objects | The collection of all embedded objects of the email message. |
| from_ | The from address of the email message. |
| html_body | The HTML representation of the message body. |
| subject | The subject of the email message. |
| to | The collection of recipients of the email message. |

### attachments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/attachments.md

#### attachments property

The collection of all attachments of the email message.

##### Definition:
```python
@property
def attachments(self):
    ...
```

### bcc property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/bcc.md

#### bcc property

The collection of BCC (blind carbon copy) recipients of the email message.

##### Definition:
```python
@property
def bcc(self):
    ...
```

### body property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/body.md

#### body property

The plain text representation of the message body.

##### Definition:
```python
@property
def body(self):
    ...
@body.setter
def body(self, value):
    ...
```

### body_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/body_type.md

#### body_type property

The type of the email message body.

##### Definition:
```python
@property
def body_type(self):
    ...
```

### cc property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/cc.md

#### cc property

The collection of CC (carbon copy) recipients of the email message.

##### Definition:
```python
@property
def cc(self):
    ...
```

### embedded_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/embedded_objects.md

#### embedded_objects property

The collection of all embedded objects of the email message.

##### Definition:
```python
@property
def embedded_objects(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### from_ property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/from_.md

#### from_ property

The from address of the email message.

##### Definition:
```python
@property
def from_(self):
    ...
```

### from_address property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/from_address.md

#### from_address property

Gets the from address of the email message.
##### Definition:
```python
@property
def from_address(self):
    ...
```

### html_body property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/html_body.md

#### html_body property

The HTML representation of the message body.

##### Definition:
```python
@property
def html_body(self):
    ...
@html_body.setter
def html_body(self, value):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### subject property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/subject.md

#### subject property

The subject of the email message.

##### Definition:
```python
@property
def subject(self):
    ...
@subject.setter
def subject(self, value):
    ...
```

### to property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailcontent/to.md

#### to property

The collection of recipients of the email message.

##### Definition:
```python
@property
def to(self):
    ...
```

### EmailEmbeddedObject class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject.md

#### EmailEmbeddedObject class

Represents an object embedded to an email message body.

The EmailEmbeddedObject type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. (inherited from `Attachment`) |
| create_watermarker_load_options |  (inherited from `Attachment`) |
| get_document_info | Gets the information about a document stored in the attached file. (inherited from `Attachment`) |

##### Properties
| Property | Description |
| :- | :- |
| content | The attached file content. (inherited from `EmailAttachmentBase`) |
| content_id | The content id of this `EmailAttachmentBase`. (inherited from `EmailAttachmentBase`) |
| media_type | The media type of this `EmailAttachmentBase`. (inherited from `EmailAttachmentBase`) |

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject/content.md

#### content property

Gets or sets the attached file content.

### content_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject/content_id.md

#### content_id property

Gets the content id of this `EmailAttachmentBase`.

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self):
    ...
```

#### create_watermarker

Loads a content from the attached file with the specified load options.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |
| watermarker_settings | groupdocs.watermark.WatermarkerSettings | Additional settings to use when working with loaded document. |

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

##### Returns

The `IDocumentInfo` instance that contains detected information

```python
def get_document_info(self):
    ...
```

### media_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobject/media_type.md

#### media_type property

Gets the media type of this `EmailAttachmentBase`.

### EmailEmbeddedObjectCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobjectcollection.md

#### EmailEmbeddedObjectCollection class

Represents a collection of embedded objects in an email message.

This collection contains the items of `EmailEmbeddedObject` type.

The EmailEmbeddedObjectCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds an embedded resource to the `EmailContent`. |
| add_bytes |  |
| add_file |  |
| add_string |  |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobjectcollection/add.md

#### add

Adds an embedded resource to the `EmailContent`.

```python
def add(self, file_content, name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_content | `list[int]` | The content of the file to be added. |
| name | `str` | The name of the file. |

### add_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobjectcollection/add_bytes.md

#### add_bytes

```python
def add_bytes(self):
    ...
```

### add_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobjectcollection/add_file.md

#### add_file

```python
def add_file(self):
    ...
```

### add_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.email/emailembeddedobjectcollection/add_string.md

#### add_string

```python
def add_string(self):
    ...
```

### groupdocs.watermark.contents.image
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image.md

Types under `groupdocs.watermark.contents.image`.

##### Classes
| Class | Description |
| :- | :- |
| `ImageContent` | Represents an image where a watermark can be placed. |
| `ImageFrame` | Represents an image frame where a watermark can be placed. |
| `MultiframeImageContent` | Represents a multiframe image where a watermark can be placed. |
| `SystemDrawingImageFrame` | Represents an image frame where a watermark can be placed (System.Drawing implementation). |
| `WatermarkableImage` | Represents an image inside a document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `GifImageContent` | Represents a gif image where a watermark can be placed. |
| `ImageFrameCollection` | Represents a collection of frames in multiframe image. |
| `SystemDrawingImageFrameCollection` | Represents a collection of frames in multiframe image. |
| `TiffImageContent` | Represents a tiff image where a watermark can be placed. |
| `WatermarkableImageCollection` | Represents a collection of images found in a document. |

### GifImageContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent.md

#### GifImageContent class

Represents a gif image where a watermark can be placed.

The GifImageContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| frames | The collection of all frames of the image. (inherited from `MultiframeImageContent`) |
| height | The height of this ImageContent in pixels. (inherited from `ImageContent`) |
| width | The width of this `ImageContent` in pixels. (inherited from `ImageContent`) |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### frames property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent/frames.md

#### frames property

Gets the collection of all frames of the image.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent/height.md

#### height property

Gets the height of this `ImageContent` in pixels.

##### Remarks

Returns the height of the active frame for a multiframe image.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/gifimagecontent/width.md

#### width property

Gets the width of this `ImageContent` in pixels.

##### Remarks

Returns the width of the active frame for a multiframe image.

### ImageContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imagecontent.md

#### ImageContent class

Represents an image where a watermark can be placed.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images

The ImageContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this ImageContent in pixels. |
| width | The width of this `ImageContent` in pixels. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imagecontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imagecontent/height.md

#### height property

The height of this ImageContent in pixels.

Returns the height of the active frame for a multiframe image.

##### Definition:
```python
@property
def height(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imagecontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imagecontent/width.md

#### width property

The width of this `ImageContent` in pixels.

Returns the width of the active frame for a multiframe image.

##### Definition:
```python
@property
def width(self):
    ...
```

### ImageFrame class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframe.md

#### ImageFrame class

Represents an image frame where a watermark can be placed.

The ImageFrame type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this ImageFrame in pixels. |
| width | The width of this ImageFrame in pixels. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframe/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframe/height.md

#### height property

The height of this ImageFrame in pixels.

##### Definition:
```python
@property
def height(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframe/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframe/width.md

#### width property

The width of this ImageFrame in pixels.

##### Definition:
```python
@property
def width(self):
    ...
```

### ImageFrameCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/imageframecollection.md

#### ImageFrameCollection class

Represents a collection of frames in multiframe image.

This collection contains the items of `ImageFrame` type.

The ImageFrameCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### MultiframeImageContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent.md

#### MultiframeImageContent class

Represents a multiframe image where a watermark can be placed.

The MultiframeImageContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| frames | The collection of all frames of the image. |
| height | The height of this ImageContent in pixels. (inherited from `ImageContent`) |
| width | The width of this `ImageContent` in pixels. (inherited from `ImageContent`) |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### frames property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent/frames.md

#### frames property

The collection of all frames of the image.

##### Definition:
```python
@property
def frames(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent/height.md

#### height property

Gets the height of this `ImageContent` in pixels.

##### Remarks

Returns the height of the active frame for a multiframe image.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/multiframeimagecontent/width.md

#### width property

Gets the width of this `ImageContent` in pixels.

##### Remarks

Returns the width of the active frame for a multiframe image.

### SystemDrawingImageFrame class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframe.md

#### SystemDrawingImageFrame class

Represents an image frame where a watermark can be placed (System.Drawing implementation).

The SystemDrawingImageFrame type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this `SystemDrawingImageFrame` in pixels. |
| width | The width of this `SystemDrawingImageFrame` in pixels. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframe/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframe/height.md

#### height property

The height of this `SystemDrawingImageFrame` in pixels.

##### Definition:
```python
@property
def height(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframe/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframe/width.md

#### width property

The width of this `SystemDrawingImageFrame` in pixels.

##### Definition:
```python
@property
def width(self):
    ...
```

### SystemDrawingImageFrameCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/systemdrawingimageframecollection.md

#### SystemDrawingImageFrameCollection class

Represents a collection of frames in multiframe image.

This collection contains the items of `ImageFrame` type.

The SystemDrawingImageFrameCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### TiffImageContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent.md

#### TiffImageContent class

Represents a tiff image where a watermark can be placed.

The TiffImageContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| frames | The collection of all frames of the image. (inherited from `MultiframeImageContent`) |
| height | The height of this ImageContent in pixels. (inherited from `ImageContent`) |
| width | The width of this `ImageContent` in pixels. (inherited from `ImageContent`) |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### frames property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent/frames.md

#### frames property

Gets the collection of all frames of the image.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent/height.md

#### height property

Gets the height of this `ImageContent` in pixels.

##### Remarks

Returns the height of the active frame for a multiframe image.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/tiffimagecontent/width.md

#### width property

Gets the width of this `ImageContent` in pixels.

##### Remarks

Returns the width of the active frame for a multiframe image.

### WatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage.md

#### WatermarkableImage class

Represents an image inside a document.

Learn more:
- Adding watermark to images inside a document (https://docs.groupdocs.com/display/watermarknet/Adding+watermark+to+images+inside+a+document)

The WatermarkableImage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). |
| add_watermark |  |
| get_bytes | Gets the image as a byte array. |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. |
| width | The width of this WatermarkableImage in pixels. |

##### Example

```python
from groupdocs.watermark import Watermarker, TextWatermark, Font

with Watermarker(r"D:\input.doc") as watermarker:
    watermark = TextWatermark("DRAFT", Font("Arial", 19))
    images = watermarker.get_images()
    for img in images:
        img.add(watermark)
    watermarker.save(r"D:\output.doc")
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | `Watermark` | The watermark to add to the image. |

### add_watermark method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/add_watermark.md

#### add_watermark

```python
def add_watermark(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/get_bytes.md

#### get_bytes

Gets the image as a byte array.

```python
def get_bytes(self):
    ...
```

**Returns:** bytes: The image data.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    for slide in content.slides:
        bg = slide.image_fill_format.background_image
        if bg is not None:
            data = bg.get_bytes()
            print(len(data))
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/height.md

#### height property

The height of this WatermarkableImage in pixels.

##### Definition:
```python
@property
def height(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimage/width.md

#### width property

The width of this WatermarkableImage in pixels.

##### Definition:
```python
@property
def width(self):
    ...
```

### WatermarkableImageCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.image/watermarkableimagecollection.md

#### WatermarkableImageCollection class

Represents a collection of images found in a document.

This collection contains the items of `WatermarkableImage` type.

The WatermarkableImageCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### groupdocs.watermark.contents.pdf
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf.md

Types under `groupdocs.watermark.contents.pdf`.

##### Classes
| Class | Description |
| :- | :- |
| `PdfAnnotation` | Represents an annotation in a pdf document. |
| `PdfArtifact` | Represents an artifact in a pdf content. |
| `PdfAttachment` | Represents a file attached to a pdf content. |
| `PdfAttachmentCollection` | Represents a collection of attachments in a pdf document. |
| `PdfContent` | Represents a PDF document where a watermark can be placed. |
| `PdfFormattedTextFragment` | Represents a fragment of formatted text in a pdf document. |
| `PdfOperator` | Represents an operator of vector content in a pdf document. |
| `PdfPage` | Represents pdf document page. |
| `PdfShape` | Provides base class for XObjects, Artifacts and Annotations. |
| `PdfWatermarkableImage` | Represents an image inside a Pdf document. |
| `PdfXForm` | Represents an XForm in a pdf content. |
| `PdfXImage` | Represents an XImage in a pdf content. |
| `PdfXObject` | Represents an XObject in a pdf document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PdfAnnotationCollection` | Represents a collection of annotations in a pdf document. |
| `PdfAnnotationType` |  |
| `PdfArtifactCollection` | Represents a collection of artifacts in a pdf content. |
| `PdfArtifactSubtype` |  |
| `PdfArtifactType` |  |
| `PdfCryptoAlgorithm` |  |
| `PdfFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a pdf document. |
| `PdfImageConversionFormat` |  |
| `PdfOperatorCollection` | Represents a collection of operators in a pdf content. |
| `PdfPageCollection` | Represents a collection of pages in a pdf content. |
| `PdfPageMarginType` |  |
| `PdfPermissions` |  |
| `PdfShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation. |
| `PdfTextFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a pdf content main text. |
| `PdfXObjectCollection` | Represents a collection of XObjects in a pdf document. |

### PdfAnnotation class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation.md

#### PdfAnnotation class

Represents an annotation in a pdf document.

Learn more:

- [Working with annotations](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithannotations)

The PdfAnnotation type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| annotation_type | The type of this PdfAnnotation. |
| height | The height of this `PdfAnnotation` in points. |
| page | The parent page of this `PdfAnnotation`. |
| rotate_angle | The rotate angle of this `PdfAnnotation` in degrees. |
| width | The width of this PdfAnnotation in points. |
| x | The horizontal offset of this PdfAnnotation from the page left border in points. |
| y | The vertical offset of this `PdfAnnotation` from the worksheet bottom border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. (inherited from `PdfShape`) |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. (inherited from `PdfShape`) |
| text | The text of this `PdfShape`. (inherited from `PdfShape`) |

### annotation_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/annotation_type.md

#### annotation_type property

The type of this PdfAnnotation.

##### Definition:
```python
@property
def annotation_type(self):
    ...
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PdfShape`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/height.md

#### height property

The height of this `PdfAnnotation` in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/image.md

#### image property

Gets or sets the image of this `PdfShape`.

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/page.md

#### page property

The parent page of this `PdfAnnotation`.

##### Definition:
```python
@property
def page(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/rotate_angle.md

#### rotate_angle property

The rotate angle of this `PdfAnnotation` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/text.md

#### text property

Gets or sets the text of this `PdfShape`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/width.md

#### width property

The width of this PdfAnnotation in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/x.md

#### x property

The horizontal offset of this PdfAnnotation from the page left border in points.

The x-coordinate of this PdfAnnotation.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotation/y.md

#### y property

The vertical offset of this `PdfAnnotation` from the worksheet bottom border in points.

The y-coordinate of this annotation.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfAnnotationCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationcollection.md

#### PdfAnnotationCollection class

Represents a collection of annotations in a pdf document.

This collection contains the items of `PdfAnnotation` type.

The PdfAnnotationCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### PdfAnnotationType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype.md

#### PdfAnnotationType class

The PdfAnnotationType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TEXT | Text annotation type. |
| CIRCLE | Circle annotation type. |
| POLYGON | Polygon annotation type. |
| POLY_LINE | Polyline annotation type. |
| LINE | Line annotation type. |
| SQUARE | Square annotation type. |
| FREE_TEXT | Free text annotation type. |
| HIGHLIGHT | Highlight annotation type. |
| UNDERLINE | Underline annotation type. |
| SQUIGGLY | Squiggle annotation type. |
| STRIKE_OUT | Strikeout annotation type. |
| CARET | Caret annotation type. |
| INK | Ink annotation type. |
| LINK | Link annotation type. |
| POPUP | Popup annotation type. |
| FILE_ATTACHMENT | File attachment annotation type. |
| SOUND | Sound annotation type. |
| MOVIE | Movie annotation type. |
| SCREEN | Screen annotation type. |
| WIDGET | Widget annotation type. |
| WATERMARK | Watermark annotation type. |
| TRAP_NET | Trap network annotation type. |
| PRINTER_MARK | Printer mark annotation type. |
| REDACTION | Redaction annotation type. |
| STAMP | Rubber stamp annotation type. |
| RICH_MEDIA | RichMedia annotation type. |
| UNKNOWN | Unknown annotation. |
| PDF_3D | PDF3D annotation. |
| COLOR_BAR | ColorBar annotation. |
| TRIM_MARK | Trim mark annotation. |
| BLEED_MARK | Bleed mark annotation. |
| REGISTRATION_MARK | Registration mark annotation. |
| PAGE_INFORMATION | Page information annotation. |

### BLEED_MARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/bleed_mark.md

#### BLEED_MARK field

Bleed mark annotation.

##### Value
`30`

### CARET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/caret.md

#### CARET field

Caret annotation type.

##### Value
`11`

### CIRCLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/circle.md

#### CIRCLE field

Circle annotation type.

##### Value
`1`

### COLOR_BAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/color_bar.md

#### COLOR_BAR field

ColorBar annotation.

##### Value
`28`

### FILE_ATTACHMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/file_attachment.md

#### FILE_ATTACHMENT field

File attachment annotation type.

##### Value
`15`

### FREE_TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/free_text.md

#### FREE_TEXT field

Free text annotation type.

##### Value
`6`

### HIGHLIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/highlight.md

#### HIGHLIGHT field

Highlight annotation type.

##### Value
`7`

### INK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/ink.md

#### INK field

Ink annotation type.

##### Value
`12`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/line.md

#### LINE field

Line annotation type.

##### Value
`4`

### LINK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/link.md

#### LINK field

Link annotation type.

##### Value
`13`

### MOVIE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/movie.md

#### MOVIE field

Movie annotation type.

##### Value
`17`

### PAGE_INFORMATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/page_information.md

#### PAGE_INFORMATION field

Page information annotation.

##### Value
`32`

### PDF_3D field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/pdf_3d.md

#### PDF_3D field

PDF3D annotation.

##### Value
`27`

### POLY_LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/poly_line.md

#### POLY_LINE field

Polyline annotation type.

##### Value
`3`

### POLYGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/polygon.md

#### POLYGON field

Polygon annotation type.

##### Value
`2`

### POPUP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/popup.md

#### POPUP field

Popup annotation type.

##### Value
`14`

### PRINTER_MARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/printer_mark.md

#### PRINTER_MARK field

Printer mark annotation type.

##### Value
`22`

### REDACTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/redaction.md

#### REDACTION field

Redaction annotation type.

##### Value
`23`

### REGISTRATION_MARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/registration_mark.md

#### REGISTRATION_MARK field

Registration mark annotation.

##### Value
`31`

### RICH_MEDIA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/rich_media.md

#### RICH_MEDIA field

RichMedia annotation type.

##### Value
`25`

### SCREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/screen.md

#### SCREEN field

Screen annotation type.

##### Value
`18`

### SOUND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/sound.md

#### SOUND field

Sound annotation type.

##### Value
`16`

### SQUARE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/square.md

#### SQUARE field

Square annotation type.

##### Value
`5`

### SQUIGGLY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/squiggly.md

#### SQUIGGLY field

Squiggle annotation type.

##### Value
`9`

### STAMP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/stamp.md

#### STAMP field

Rubber stamp annotation type.

##### Value
`24`

### STRIKE_OUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/strike_out.md

#### STRIKE_OUT field

Strikeout annotation type.

##### Value
`10`

### TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/text.md

#### TEXT field

Text annotation type.

##### Value
`0`

### TRAP_NET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/trap_net.md

#### TRAP_NET field

Trap network annotation type.

##### Value
`21`

### TRIM_MARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/trim_mark.md

#### TRIM_MARK field

Trim mark annotation.

##### Value
`29`

### UNDERLINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/underline.md

#### UNDERLINE field

Underline annotation type.

##### Value
`8`

### UNKNOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/unknown.md

#### UNKNOWN field

Unknown annotation.

##### Value
`26`

### WATERMARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/watermark.md

#### WATERMARK field

Watermark annotation type.

##### Value
`20`

### WIDGET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfannotationtype/widget.md

#### WIDGET field

Widget annotation type.

##### Value
`19`

### PdfArtifact class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact.md

#### PdfArtifact class

Represents an artifact in a pdf content.

Learn more:
- Working with artifacts: https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-Workingwithartifacts

The PdfArtifact type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| artifact_subtype | The subtype of this `PdfArtifact`. |
| artifact_type | The type of this `PdfArtifact`. |
| height | The height of this `PdfArtifact` in points. |
| opacity | The opacity of this PdfArtifact. |
| page | The parent page of this `PdfArtifact`. |
| rotate_angle | The rotate angle of this PdfArtifact in degrees. |
| text | The text of this `PdfArtifact`. |
| width | The width of this `PdfArtifact` in points. |
| x | The horizontal offset of this `PdfArtifact` from the page left border in points. |
| y | The vertical offset of this `PdfArtifact` from page bottom border in points. The y-coordinate of this `PdfArtifact`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. (inherited from `PdfShape`) |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. (inherited from `PdfShape`) |

### artifact_subtype property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/artifact_subtype.md

#### artifact_subtype property

The subtype of this `PdfArtifact`.

##### Definition:
```python
@property
def artifact_subtype(self):
    ...
```

### artifact_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/artifact_type.md

#### artifact_type property

The type of this `PdfArtifact`.

##### Definition:
```python
@property
def artifact_type(self):
    ...
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PdfShape`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/height.md

#### height property

The height of this `PdfArtifact` in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/image.md

#### image property

Gets or sets the image of this `PdfShape`.

### opacity property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/opacity.md

#### opacity property

The opacity of this PdfArtifact.

Possible values are in range [0, 1].

##### Definition:
```python
@property
def opacity(self):
    ...
```

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/page.md

#### page property

The parent page of this `PdfArtifact`.

##### Definition:
```python
@property
def page(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/rotate_angle.md

#### rotate_angle property

The rotate angle of this PdfArtifact in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/text.md

#### text property

The text of this `PdfArtifact`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/width.md

#### width property

The width of this `PdfArtifact` in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/x.md

#### x property

The horizontal offset of this `PdfArtifact` from the page left border in points.

The x-coordinate of this `PdfArtifact`.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifact/y.md

#### y property

The vertical offset of this `PdfArtifact` from page bottom border in points. The y-coordinate of this `PdfArtifact`.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfArtifactCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactcollection.md

#### PdfArtifactCollection class

Represents a collection of artifacts in a pdf content.

This collection contains the items of `PdfArtifact` type.

The PdfArtifactCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### PdfArtifactSubtype class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype.md

#### PdfArtifactSubtype class

The PdfArtifactSubtype type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HEADER | Header subtype. |
| FOOTER | Footer subtype. |
| WATERMARK | Watermark subtype. |
| BACKGROUND | Background subtype. |
| UNDEFINED | UndefinedDocument subtype. |

### BACKGROUND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype/background.md

#### BACKGROUND field

Background subtype.

##### Value
`3`

### FOOTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype/footer.md

#### FOOTER field

Footer subtype.

##### Value
`1`

### HEADER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype/header.md

#### HEADER field

Header subtype.

##### Value
`0`

### UNDEFINED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype/undefined.md

#### UNDEFINED field

UndefinedDocument subtype.

##### Value
`4`

### WATERMARK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifactsubtype/watermark.md

#### WATERMARK field

Watermark subtype.

##### Value
`2`

### PdfArtifactType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype.md

#### PdfArtifactType class

The PdfArtifactType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PAGINATION | Pagination type. |
| LAYOUT | Layout type. |
| PAGE | Page type. |
| BACKGROUND | Background type. |
| UNDEFINED | UndefinedDocument type. |

### BACKGROUND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype/background.md

#### BACKGROUND field

Background type.

##### Value
`3`

### LAYOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype/layout.md

#### LAYOUT field

Layout type.

##### Value
`1`

### PAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype/page.md

#### PAGE field

Page type.

##### Value
`2`

### PAGINATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype/pagination.md

#### PAGINATION field

Pagination type.

##### Value
`0`

### UNDEFINED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfartifacttype/undefined.md

#### UNDEFINED field

UndefinedDocument type.

##### Value
`4`

### PdfAttachment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment.md

#### PdfAttachment class

Represents a file attached to a pdf content.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Attachments+in+PDF+document

The PdfAttachment type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. (inherited from `Attachment`) |
| create_watermarker_load_options |  (inherited from `Attachment`) |
| get_document_info | Gets the information about a document stored in the attached file. (inherited from `Attachment`) |

##### Properties
| Property | Description |
| :- | :- |
| content | The attached file content. |
| description | The description of the attached file. |
| name | The name of the attached file. |

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment/content.md

#### content property

The attached file content.

##### Definition:
```python
@property
def content(self):
    ...
@content.setter
def content(self, value):
    ...
```

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self):
    ...
```

#### create_watermarker

Loads a content from the attached file with the specified load options.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |
| watermarker_settings | groupdocs.watermark.WatermarkerSettings | Additional settings to use when working with loaded document. |

### description property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment/description.md

#### description property

The description of the attached file.

##### Definition:
```python
@property
def description(self):
    ...
@description.setter
def description(self, value):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

##### Returns

The `IDocumentInfo` instance that contains detected information

```python
def get_document_info(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachment/name.md

#### name property

The name of the attached file.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### PdfAttachmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachmentcollection.md

#### PdfAttachmentCollection class

Represents a collection of attachments in a pdf document.

This collection contains the items of `PdfAttachment` type.

The PdfAttachmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds an attachment to the `PdfContent`. |
| add_bytes |  |
| add_file |  |
| add_string |  |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachmentcollection/add.md

#### add

Adds an attachment to the `PdfContent`.

```python
def add(self, file_content, name, description):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_content | `list[int]` | The content of the file to be attached. |
| name | `str` | The name of the file. |
| description | `str` | The description of the file. |

### add_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachmentcollection/add_bytes.md

#### add_bytes

```python
def add_bytes(self):
    ...
```

### add_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachmentcollection/add_file.md

#### add_file

```python
def add_file(self):
    ...
```

### add_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfattachmentcollection/add_string.md

#### add_string

```python
def add_string(self):
    ...
```

### PdfContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent.md

#### PdfContent class

Represents a PDF document where a watermark can be placed.

Learn more:
- [Add watermarks to PDF documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents)
- [Existing objects in PDF document](https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document)
- [Rasterize document or page](https://docs.groupdocs.com/display/watermarknet/Rasterize+document+or+page)
- [Watermarks in PDF document](https://docs.groupdocs.com/display/watermarknet/Watermarks+in+PDF+document)

The PdfContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| decrypt | Decrypts the content. |
| encrypt | Encrypts the document using the same password for both user and owner. |
| encrypt | Encrypts the content. |
| encrypt_file |  |
| encrypt_string |  |
| rasterize | Converts all content pages into images. |
| rasterize_int32 |  |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| attachments | The collection of all attachments of this `PdfContent`. |
| page_margin_type | The PDF page margins to be used during watermark adding. |
| pages | The collection of all pages of this `PdfContent`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    print(pdf_content.pages[0].width)
    print(pdf_content.pages[0].height)
```

### attachments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/attachments.md

#### attachments property

The collection of all attachments of this `PdfContent`.

##### Definition:
```python
@property
def attachments(self):
    ...
```

### decrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/decrypt.md

#### decrypt

Decrypts the content.

```python
def decrypt(self):
    ...
```

### encrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/encrypt.md

#### encrypt

Encrypts the document using the same password for both user and owner.

```python
def encrypt(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | User and owner password. |

**Returns:** None.

#### encrypt

Encrypts the content.

```python
def encrypt(self, user_password, owner_password, permissions, crypto_algorithm):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| user_password | `str` | User password. |
| owner_password | `str` | Owner password. |
| permissions | `PdfPermissions` | Content permissions. |
| crypto_algorithm | `PdfCryptoAlgorithm` | Cryptographic algorithm. |

### encrypt_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/encrypt_file.md

#### encrypt_file

```python
def encrypt_file(self):
    ...
```

### encrypt_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/encrypt_string.md

#### encrypt_string

```python
def encrypt_string(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### page_margin_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/page_margin_type.md

#### page_margin_type property

The PDF page margins to be used during watermark adding.

Works only when `Watermark.ConsiderParentMargins` is True; otherwise the PDF CropBox is used as the watermarking area.

The default value is `PdfPageMarginType.TrimBox`.

##### Definition:
```python
@property
def page_margin_type(self):
    ...
@page_margin_type.setter
def page_margin_type(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/pages.md

#### pages property

The collection of all pages of this `PdfContent`.

##### Definition:
```python
@property
def pages(self):
    ...
```

### rasterize method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/rasterize.md

#### rasterize

Converts all content pages into images.

```python
def rasterize(self, horizontal_resolution, vertical_resolution, image_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| horizontal_resolution | `int` | Horizontal image resolution. |
| vertical_resolution | `int` | Vertical image resolution. |
| image_format | `PdfImageConversionFormat` | Image format. |

**Returns:** None.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.TextWatermark("Do not copy", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0
    watermark.opacity = 0.5

    watermarker.add(watermark)
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    pdf_content.rasterize(100, 100, gwc_pdf.PdfImageConversionFormat.PNG)
    watermarker.save("document.pdf")
```

### rasterize_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/rasterize_int32.md

#### rasterize_int32

```python
def rasterize_int32(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### PdfCryptoAlgorithm class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm.md

#### PdfCryptoAlgorithm class

The PdfCryptoAlgorithm type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| RC4X40 | RC4 with key length 40. |
| RC4X128 | RC4 with key length 128. |
| AE_SX128 | AES with key length 128. |
| AE_SX256 | AES with key length 256. |

### AE_SX128 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm/ae_sx128.md

#### AE_SX128 field

AES with key length 128.

##### Value
`2`

### AE_SX256 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm/ae_sx256.md

#### AE_SX256 field

AES with key length 256.

##### Value
`3`

### RC4X128 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm/rc4x128.md

#### RC4X128 field

RC4 with key length 128.

##### Value
`1`

### RC4X40 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfcryptoalgorithm/rc4x40.md

#### RC4X40 field

RC4 with key length 40.

##### Value
`0`

### PdfFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment.md

#### PdfFormattedTextFragment class

Represents a fragment of formatted text in a pdf document.

The PdfFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### PdfFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragmentcollection.md

#### PdfFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf document.

This collection contains the items of `PdfFormattedTextFragment` type.

The PdfFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### PdfImageConversionFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfimageconversionformat.md

#### PdfImageConversionFormat class

The PdfImageConversionFormat type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| JPEG | Jpeg image. |
| PNG | Png image. |
| GIF | Gif image. |

### GIF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfimageconversionformat/gif.md

#### GIF field

Gif image.

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfimageconversionformat/jpeg.md

#### JPEG field

Jpeg image.

##### Value
`0`

### PNG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfimageconversionformat/png.md

#### PNG field

Png image.

##### Value
`1`

### PdfOperator class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfoperator.md

#### PdfOperator class

Represents an operator of vector content in a pdf document.

The PdfOperator type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| foreground_color | The foreground color of this PdfOperator. |

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfoperator/foreground_color.md

#### foreground_color property

The foreground color of this PdfOperator.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### PdfOperatorCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfoperatorcollection.md

#### PdfOperatorCollection class

Represents a collection of operators in a pdf content.

This collection contains the items of `PdfOperator` type.

The PdfOperatorCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### PdfPage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage.md

#### PdfPage class

Represents pdf document page.

The PdfPage type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| rasterize | Converts page content into an image. |
| rasterize_int32 |  |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| annotations | The collection of all annotations of this `PdfPage`. |
| artifacts | The collection of all artifacts of this `PdfPage`. |
| height | The height of this `PdfPage` in points. |
| width | The width of this `PdfPage` in points. |
| xobjects | The collection of all XObjects of this `PdfPage`. |

### annotations property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/annotations.md

#### annotations property

The collection of all annotations of this `PdfPage`.

##### Definition:
```python
@property
def annotations(self):
    ...
```

### artifacts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/artifacts.md

#### artifacts property

The collection of all artifacts of this `PdfPage`.

##### Definition:
```python
@property
def artifacts(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/height.md

#### height property

The height of this `PdfPage` in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### rasterize method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/rasterize.md

#### rasterize

Converts page content into an image.

```python
def rasterize(self, horizontal_resolution, vertical_resolution, image_format):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| horizontal_resolution | `int` | Horizontal image resolution. |
| vertical_resolution | `int` | Vertical image resolution. |
| image_format | `PdfImageConversionFormat` | Image format. |

**Returns:** None.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc
import groupdocs.watermark.options.pdf as gwo_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.TextWatermark("Do not copy", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0
    watermark.opacity = 0.5

    options = gwo_pdf.PdfArtifactWatermarkOptions()
    options.page_index = 0
    watermarker.add(watermark, options)

    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    pdf_content.pages[0].rasterize(100, 100, gwc_pdf.PdfImageConversionFormat.PNG)
    watermarker.save("document.pdf")
```

### rasterize_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/rasterize_int32.md

#### rasterize_int32

```python
def rasterize_int32(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/width.md

#### width property

The width of this `PdfPage` in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/x_objects.md

#### x_objects property

Gets the collection of all XObjects of this `PdfPage`.
##### Definition:
```python
@property
def x_objects(self):
    ...
```

### xobjects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpage/xobjects.md

#### xobjects property

The collection of all XObjects of this `PdfPage`.

##### Definition:
```python
@property
def xobjects(self):
    ...
```

### PdfPageCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpagecollection.md

#### PdfPageCollection class

Represents a collection of pages in a pdf content.

This collection contains the items of `PdfPage` type.

The PdfPageCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### PdfPageMarginType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpagemargintype.md

#### PdfPageMarginType class

The PdfPageMarginType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| BLEED_BOX | Pdf BleedBox is used as watermarking area. |
| TRIM_BOX | Pdf TrimBox is used as watermarking area. |
| ART_BOX | Pdf ArtBox is used as watermarking area. |

### ART_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpagemargintype/art_box.md

#### ART_BOX field

Pdf ArtBox is used as watermarking area.

##### Value
`2`

### BLEED_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpagemargintype/bleed_box.md

#### BLEED_BOX field

Pdf BleedBox is used as watermarking area.

##### Value
`0`

### TRIM_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpagemargintype/trim_box.md

#### TRIM_BOX field

Pdf TrimBox is used as watermarking area.

##### Value
`1`

### PdfPermissions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions.md

#### PdfPermissions class

The PdfPermissions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PRINT_DOCUMENT | Print the content. |
| MODIFY_CONTENT | Modify the content. |
| EXTRACT_CONTENT | Copy or otherwise extract text and graphics from the document. |
| MODIFY_TEXT_ANNOTATIONS | Add or modify text annotations. |
| FILL_FORM | Fill in existing interactive form fields. |
| EXTRACT_CONTENT_WITH_DISABILITIES | Extract text and graphics. |
| ASSEMBLE_DOCUMENT | Assemble the content. |
| PRINTING_QUALITY | Print the content to a representation from which a faithful digital copy of the PDF document could be generated. |

### ASSEMBLE_DOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/assemble_document.md

#### ASSEMBLE_DOCUMENT field

Assemble the content.

##### Value
`1024`

### EXTRACT_CONTENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/extract_content.md

#### EXTRACT_CONTENT field

Copy or otherwise extract text and graphics from the document.

##### Value
`16`

### EXTRACT_CONTENT_WITH_DISABILITIES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/extract_content_with_disabilities.md

#### EXTRACT_CONTENT_WITH_DISABILITIES field

Extract text and graphics.

##### Value
`512`

### FILL_FORM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/fill_form.md

#### FILL_FORM field

Fill in existing interactive form fields.

##### Value
`256`

### MODIFY_CONTENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/modify_content.md

#### MODIFY_CONTENT field

Modify the content.

##### Value
`8`

### MODIFY_TEXT_ANNOTATIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/modify_text_annotations.md

#### MODIFY_TEXT_ANNOTATIONS field

Add or modify text annotations.

##### Value
`32`

### PRINT_DOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/print_document.md

#### PRINT_DOCUMENT field

Print the content.

##### Value
`4`

### PRINTING_QUALITY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfpermissions/printing_quality.md

#### PRINTING_QUALITY field

Print the content to a representation from which a faithful digital copy of the PDF document could be generated.

##### Value
`2048`

### PdfShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape.md

#### PdfShape class

Provides base class for XObjects, Artifacts and Annotations.

The PdfShape type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. |
| height | The height of the object. |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. |
| rotate_angle | The rotate angle of the object in degrees. |
| text | The text of this `PdfShape`. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `PdfShape`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/image.md

#### image property

The image of this `PdfShape`. Returns `None` if the object has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/rotate_angle.md

#### rotate_angle property

The rotate angle of the object in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/text.md

#### text property

The text of this `PdfShape`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshape/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshapeformattedtextfragmentcollection.md

#### PdfShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf document XObject, Artifact or Annotation.

This collection contains the items of `PdfFormattedTextFragment` type.

The PdfShapeFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshapeformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfshapeformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### PdfTextFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdftextformattedtextfragmentcollection.md

#### PdfTextFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a pdf content main text.

This collection contains the items of `PdfFormattedTextFragment` type.

The PdfTextFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdftextformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdftextformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### PdfWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage.md

#### PdfWatermarkableImage class

Represents an image inside a Pdf document.

The PdfWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PdfWatermarkableImage instance using the specified image data. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

##### Example

```python
from groupdocs.watermark.contents.pdf import PdfWatermarkableImage

with open("test.png", "rb") as f:
    img = PdfWatermarkableImage(f.read())
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/__init__.md

#### __init__

Initializes a new PdfWatermarkableImage instance using the specified image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | `list[int]` | The array of unsigned bytes from which to create the PdfWatermarkableImage. |

##### Example

```python
import groupdocs.watermark.contents.pdf as gwc_pdf

with open("test.png", "rb") as f:
    img = gwc_pdf.PdfWatermarkableImage(f.read())
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### PdfXForm class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform.md

#### PdfXForm class

Represents an XForm in a pdf content.

The PdfXForm type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the object. |
| rotate_angle | The rotate angle of the object in degrees. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. (inherited from `PdfShape`) |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. (inherited from `PdfShape`) |
| page | The parent page of this `PdfXObject`. (inherited from `PdfXObject`) |
| text | The text of this `PdfShape`. (inherited from `PdfShape`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PdfShape`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/image.md

#### image property

Gets or sets the image of this `PdfShape`.

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/page.md

#### page property

Gets the parent page of this `PdfXObject`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/rotate_angle.md

#### rotate_angle property

The rotate angle of the object in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/text.md

#### text property

Gets or sets the text of this `PdfShape`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxform/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfXImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage.md

#### PdfXImage class

Represents an XImage in a pdf content.

The PdfXImage type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the object. |
| rotate_angle | The rotate angle of the object in degrees. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. (inherited from `PdfShape`) |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. (inherited from `PdfShape`) |
| page | The parent page of this `PdfXObject`. (inherited from `PdfXObject`) |
| text | The text of this `PdfShape`. (inherited from `PdfShape`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PdfShape`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/image.md

#### image property

Gets or sets the image of this `PdfShape`.

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/page.md

#### page property

Gets the parent page of this `PdfXObject`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/rotate_angle.md

#### rotate_angle property

The rotate angle of the object in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/text.md

#### text property

Gets or sets the text of this `PdfShape`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfximage/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfXObject class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject.md

#### PdfXObject class

Represents an XObject in a pdf document.

Learn more

- Working with XObjects: https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+PDF+document#ExistingobjectsinPDFdocument-WorkingwithXObjects

The PdfXObject type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this PdfXObject in points. |
| page | The parent page of this `PdfXObject`. |
| rotate_angle | The rotate angle of this PdfXObject in degrees. |
| width | The width of this PdfXObject in points. |
| x | The horizontal offset of this PdfXObject from the page left border in points. |
| y | The vertical offset of this `PdfXObject` from the page bottom border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfShape`. (inherited from `PdfShape`) |
| image | The image of this `PdfShape`. Returns `None` if the object has no image. (inherited from `PdfShape`) |
| text | The text of this `PdfShape`. (inherited from `PdfShape`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PdfShape`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/height.md

#### height property

The height of this PdfXObject in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/image.md

#### image property

Gets or sets the image of this `PdfShape`.

### page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/page.md

#### page property

The parent page of this `PdfXObject`.

##### Definition:
```python
@property
def page(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/rotate_angle.md

#### rotate_angle property

The rotate angle of this PdfXObject in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/text.md

#### text property

Gets or sets the text of this `PdfShape`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/width.md

#### width property

The width of this PdfXObject in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/x.md

#### x property

The horizontal offset of this PdfXObject from the page left border in points.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobject/y.md

#### y property

The vertical offset of this `PdfXObject` from the page bottom border in points.

The y-coordinate of this `PdfXObject`.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfXObjectCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.pdf/pdfxobjectcollection.md

#### PdfXObjectCollection class

Represents a collection of XObjects in a pdf document.

This collection contains the items of `PdfXObject` type.

The PdfXObjectCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### groupdocs.watermark.contents.presentation
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation.md

Types under `groupdocs.watermark.contents.presentation`.

##### Classes
| Class | Description |
| :- | :- |
| `IPresentationHyperlinkContainer` | Represents PowerPoint document object that contains a hyperlink. |
| `PresentationBaseShape` | Provides the abstract base class for shapes of all types in a PowerPoint document. |
| `PresentationBaseSlide` | Provides the abstract base class for slides of all types in a PowerPoint document. |
| `PresentationChart` | Represents a chart in a PowerPoint document. |
| `PresentationContent` | Represents a PowerPoint document where a watermark can be placed. |
| `PresentationFormattedTextFragment` | Represents a fragment of formatted text in a PowerPoint document. |
| `PresentationImageFillFormat` | Represents the image fill format settings in a PowerPoint document. |
| `PresentationLayoutSlide` | Represents a PowerPoint content layout slide. |
| `PresentationShape` | Represents a drawing shape in a PowerPoint document. |
| `PresentationShapeSettings` | Represents settings that can be applied to a shape watermark for a PowerPoint document. |
| `PresentationSlide` | Represents a PowerPoint document slide. |
| `PresentationSlideImageFillFormat` | Represents the image fill format settings for a slide in a PowerPoint document. |
| `PresentationWatermarkableImage` | Represents an image inside a PowerPoint document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PresentationChartCollection` | Represents a collection of charts in a PowerPoint document. |
| `PresentationFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a PowerPoint document. |
| `PresentationHyperlinkActionType` |  |
| `PresentationLayoutSlideCollection` | Represents a collection of layout slides in a PowerPoint document. |
| `PresentationMasterHandoutSlide` | Represents a master handout slide in a PowerPoint content. |
| `PresentationMasterNotesSlide` | Represents a master slide for all notes slides in a PowerPoint document. |
| `PresentationMasterSlide` | Represents a PowerPoint document master slide. |
| `PresentationMasterSlideCollection` | Represents a collection of master slides in a PowerPoint document. |
| `PresentationNotesSlide` | Represents a PowerPoint document notes slide. |
| `PresentationShapeCollection` | Represents a collection of drawing shapes in a PowerPoint document. |
| `PresentationShapeType` |  |
| `PresentationSlideCollection` | Represents a collection of slides in a PowerPoint document. |

### IPresentationHyperlinkContainer class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer.md

#### IPresentationHyperlinkContainer class

Represents PowerPoint document object that contains a hyperlink.

The IPresentationHyperlinkContainer type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_hyperlink | Gets the hyperlink associated with this `IPresentationHyperlinkContainer`. |
| get_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink | Sets the hyperlink associated with this `PresentationBaseShape`. |
| set_hyperlink_file |  |
| set_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink_string |  |

### get_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/get_hyperlink.md

#### get_hyperlink

Gets the hyperlink associated with this `IPresentationHyperlinkContainer`.

```python
def get_hyperlink(self, action_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |

**Returns:** The url of the hyperlink that is activated on specified action.

### get_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/get_hyperlink_presentation_hyperlink_action_type.md

#### get_hyperlink_presentation_hyperlink_action_type

```python
def get_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/set_hyperlink.md

#### set_hyperlink

Sets the hyperlink associated with this `PresentationBaseShape`.

```python
def set_hyperlink(self, action_type, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |
| url | `str` | The hyperlink url. |

### set_hyperlink_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/set_hyperlink_file.md

#### set_hyperlink_file

```python
def set_hyperlink_file(self):
    ...
```

### set_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/set_hyperlink_presentation_hyperlink_action_type.md

#### set_hyperlink_presentation_hyperlink_action_type

```python
def set_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/ipresentationhyperlinkcontainer/set_hyperlink_string.md

#### set_hyperlink_string

```python
def set_hyperlink_string(self):
    ...
```

### PresentationBaseShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape.md

#### PresentationBaseShape class

Provides the abstract base class for shapes of all types in a PowerPoint document.

The PresentationBaseShape type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_hyperlink | Retrieves the hyperlink associated with this PresentationBaseShape. |
| get_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink | Sets the hyperlink associated with this `PresentationBaseShape`. |
| set_hyperlink_file |  |
| set_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink_string |  |

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text associated with this PresentationBaseShape. |
| height | The height of this PresentationBaseShape in points. |
| id | The identifier of this PresentationBaseShape. |
| image_fill_format | The image fill format settings of this PresentationBaseShape. |
| name | The name of this PresentationBaseShape. |
| presentation | The parent presentation of this PresentationBaseShape. |
| width | The width of this `PresentationBaseShape` in points. |
| x | The horizontal offset of this PresentationBaseShape from the presentation left border in points. The x-coordinate of this PresentationBaseShape. |
| y | The vertical offset of this `PresentationBaseShape` from the presentation top border in points. |
| z_order_position | The position of this `PresentationBaseShape` in the z-order. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/alternative_text.md

#### alternative_text property

The descriptive (alternative) text associated with this PresentationBaseShape.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### get_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/get_hyperlink.md

#### get_hyperlink

Retrieves the hyperlink associated with this PresentationBaseShape.

```python
def get_hyperlink(self, action_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |

**Returns:** str: The URL of the hyperlink that is activated on the specified action.

### get_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/get_hyperlink_presentation_hyperlink_action_type.md

#### get_hyperlink_presentation_hyperlink_action_type

```python
def get_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/height.md

#### height property

The height of this PresentationBaseShape in points.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/id.md

#### id property

The identifier of this PresentationBaseShape.

##### Definition:
```python
@property
def id(self):
    ...
```

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/image_fill_format.md

#### image_fill_format property

The image fill format settings of this PresentationBaseShape.

##### Definition:
```python
@property
def image_fill_format(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/name.md

#### name property

The name of this PresentationBaseShape.

##### Definition:
```python
@property
def name(self):
    ...
```

### presentation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/presentation.md

#### presentation property

The parent presentation of this PresentationBaseShape.

##### Definition:
```python
@property
def presentation(self):
    ...
```

### set_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/set_hyperlink.md

#### set_hyperlink

Sets the hyperlink associated with this `PresentationBaseShape`.

```python
def set_hyperlink(self, action_type, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |
| url | `str` | The hyperlink url. |

### set_hyperlink_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/set_hyperlink_file.md

#### set_hyperlink_file

```python
def set_hyperlink_file(self):
    ...
```

### set_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/set_hyperlink_presentation_hyperlink_action_type.md

#### set_hyperlink_presentation_hyperlink_action_type

```python
def set_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/set_hyperlink_string.md

#### set_hyperlink_string

```python
def set_hyperlink_string(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/width.md

#### width property

The width of this `PresentationBaseShape` in points.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/x.md

#### x property

The horizontal offset of this PresentationBaseShape from the presentation left border in points. The x-coordinate of this PresentationBaseShape.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/y.md

#### y property

The vertical offset of this `PresentationBaseShape` from the presentation top border in points.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### z_order_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseshape/z_order_position.md

#### z_order_position property

The position of this `PresentationBaseShape` in the z-order.

A shape with greater z-order is always in front of a shape with a lower z-order.

##### Definition:
```python
@property
def z_order_position(self):
    ...
```

### PresentationBaseSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide.md

#### PresentationBaseSlide class

Provides the abstract base class for slides of all types in a PowerPoint document.

The PresentationBaseSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| charts | The collection of all charts on the presentation. |
| image_fill_format | The image fill format settings of the presentation. |
| shapes | The collection of all shapes of the presentation. |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide/charts.md

#### charts property

The collection of all charts on the presentation.

##### Definition:
```python
@property
def charts(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide/image_fill_format.md

#### image_fill_format property

The image fill format settings of the presentation.

##### Definition:
```python
@property
def image_fill_format(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationbaseslide/shapes.md

#### shapes property

The collection of all shapes of the presentation.

##### Definition:
```python
@property
def shapes(self):
    ...
```

### PresentationChart class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart.md

#### PresentationChart class

Represents a chart in a PowerPoint document.

The PresentationChart type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_hyperlink | Gets the hyperlink associated with this `IPresentationHyperlinkContainer`. |
| get_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink | Sets the hyperlink associated with the PresentationBaseShape. |
| set_hyperlink_file |  |
| set_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink_string |  |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the object. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |
| alternative_text | The descriptive (alternative) text associated with this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| id | The identifier of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| image_fill_format | The image fill format settings of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| name | The name of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| presentation | The parent presentation of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| z_order_position | The position of this `PresentationBaseShape` in the z-order. (inherited from `PresentationBaseShape`) |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text associated with
this `PresentationBaseShape`.

### get_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/get_hyperlink.md

#### get_hyperlink

Gets the hyperlink associated with this `IPresentationHyperlinkContainer`.

```python
def get_hyperlink(self, action_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |

**Returns:** The url of the hyperlink that is activated on specified action.

### get_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/get_hyperlink_presentation_hyperlink_action_type.md

#### get_hyperlink_presentation_hyperlink_action_type

```python
def get_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/id.md

#### id property

Gets the identifier of this `PresentationBaseShape`.

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of this `PresentationBaseShape`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/name.md

#### name property

Gets the name of this `PresentationBaseShape`.

### presentation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/presentation.md

#### presentation property

Gets the parent presentation of this `PresentationBaseShape`.

### set_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/set_hyperlink.md

#### set_hyperlink

Sets the hyperlink associated with the PresentationBaseShape.

```python
def set_hyperlink(self, action_type, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |
| url | `str` | The hyperlink url. |

### set_hyperlink_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/set_hyperlink_file.md

#### set_hyperlink_file

```python
def set_hyperlink_file(self):
    ...
```

### set_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/set_hyperlink_presentation_hyperlink_action_type.md

#### set_hyperlink_presentation_hyperlink_action_type

```python
def set_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/set_hyperlink_string.md

#### set_hyperlink_string

```python
def set_hyperlink_string(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### z_order_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchart/z_order_position.md

#### z_order_position property

Gets the position of this `PresentationBaseShape` in the z-order.

##### Remarks

A shape with greater z-order is always in front of a shape with a lower z-order.

### PresentationChartCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationchartcollection.md

#### PresentationChartCollection class

Represents a collection of charts in a PowerPoint document.

This collection contains the items of `PresentationChart` type.

The PresentationChartCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### PresentationContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent.md

#### PresentationContent class

Represents a PowerPoint document where a watermark can be placed.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents
- https://docs.groupdocs.com/display/watermarknet/Working+with+slide+backgrounds

The PresentationContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| decrypt | Decrypts the document. |
| encrypt | Encrypts the document. |
| encrypt_file |  |
| encrypt_string |  |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| layout_slides | The collection of all layout slides of this PresentationContent. |
| master_handout_slide | The master handout slide of this `PresentationContent`. |
| master_notes_slide | The master slide for all notes slides of this `PresentationContent`. |
| master_slides | The collection of all master slides of this `PresentationContent`. |
| notes_slide_height | The height of a notes slide in points. |
| notes_slide_width | The width of a notes slide in points. |
| slide_height | The height of a slide in points. |
| slide_width | The width of a slide in points. |
| slides | The collection of all slides of this `PresentationContent`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    print(content.slide_width)
    print(content.slide_height)
```

### decrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/decrypt.md

#### decrypt

Decrypts the document.

```python
def decrypt(self):
    ...
```

### encrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/encrypt.md

#### encrypt

Encrypts the document.

```python
def encrypt(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password that will be required to open the document. |

### encrypt_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/encrypt_file.md

#### encrypt_file

```python
def encrypt_file(self):
    ...
```

### encrypt_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/encrypt_string.md

#### encrypt_string

```python
def encrypt_string(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### layout_slides property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/layout_slides.md

#### layout_slides property

The collection of all layout slides of this PresentationContent.

##### Definition:
```python
@property
def layout_slides(self):
    ...
```

### master_handout_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/master_handout_slide.md

#### master_handout_slide property

The master handout slide of this `PresentationContent`.

##### Definition:
```python
@property
def master_handout_slide(self):
    ...
```

### master_notes_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/master_notes_slide.md

#### master_notes_slide property

The master slide for all notes slides of this `PresentationContent`.

##### Definition:
```python
@property
def master_notes_slide(self):
    ...
```

### master_slides property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/master_slides.md

#### master_slides property

The collection of all master slides of this `PresentationContent`.

##### Definition:
```python
@property
def master_slides(self):
    ...
```

### notes_slide_height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/notes_slide_height.md

#### notes_slide_height property

The height of a notes slide in points.

##### Definition:
```python
@property
def notes_slide_height(self):
    ...
```

### notes_slide_width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/notes_slide_width.md

#### notes_slide_width property

The width of a notes slide in points.

##### Definition:
```python
@property
def notes_slide_width(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### slide_height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/slide_height.md

#### slide_height property

The height of a slide in points.

##### Definition:
```python
@property
def slide_height(self):
    ...
```

### slide_width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/slide_width.md

#### slide_width property

The width of a slide in points.

##### Definition:
```python
@property
def slide_width(self):
    ...
```

### slides property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationcontent/slides.md

#### slides property

The collection of all slides of this `PresentationContent`.

##### Definition:
```python
@property
def slides(self):
    ...
```

### PresentationFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment.md

#### PresentationFormattedTextFragment class

Represents a fragment of formatted text in a PowerPoint document.

The PresentationFormattedTextFragment type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_hyperlink | Retrieves the hyperlink associated with the text. |
| get_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink | Sets the hyperlink associated with the text. |
| set_hyperlink_file |  |
| set_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink_string |  |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### get_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/get_hyperlink.md

#### get_hyperlink

Retrieves the hyperlink associated with the text.

```python
def get_hyperlink(self, action_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |

**Returns:** str: The URL of the hyperlink that is activated on the specified action.

### get_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/get_hyperlink_presentation_hyperlink_action_type.md

#### get_hyperlink_presentation_hyperlink_action_type

```python
def get_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/set_hyperlink.md

#### set_hyperlink

Sets the hyperlink associated with the text.

```python
def set_hyperlink(self, action_type, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |
| url | `str` | The hyperlink url. |

### set_hyperlink_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/set_hyperlink_file.md

#### set_hyperlink_file

```python
def set_hyperlink_file(self):
    ...
```

### set_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/set_hyperlink_presentation_hyperlink_action_type.md

#### set_hyperlink_presentation_hyperlink_action_type

```python
def set_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/set_hyperlink_string.md

#### set_hyperlink_string

```python
def set_hyperlink_string(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### PresentationFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragmentcollection.md

#### PresentationFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a PowerPoint document.

This collection contains the items of `PresentationFormattedTextFragment` type.

The PresentationFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### PresentationHyperlinkActionType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationhyperlinkactiontype.md

#### PresentationHyperlinkActionType class

The PresentationHyperlinkActionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MOUSE_CLICK | Hyperlink is activated on mouse click. |
| MOUSE_OVER | Hyperlink is activated on mouse over. |

### MOUSE_CLICK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationhyperlinkactiontype/mouse_click.md

#### MOUSE_CLICK field

Hyperlink is activated on mouse click.

##### Value
`0`

### MOUSE_OVER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationhyperlinkactiontype/mouse_over.md

#### MOUSE_OVER field

Hyperlink is activated on mouse over.

##### Value
`1`

### PresentationImageFillFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationimagefillformat.md

#### PresentationImageFillFormat class

Represents the image fill format settings in a PowerPoint document.

The PresentationImageFillFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_image | The background image. |
| tile_as_texture | The property indicating whether the image is tiled across the background. |
| transparency | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### background_image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationimagefillformat/background_image.md

#### background_image property

The background image.

Returns None if the image is not set.

##### Definition:
```python
@property
def background_image(self):
    ...
@background_image.setter
def background_image(self, value):
    ...
```

### tile_as_texture property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationimagefillformat/tile_as_texture.md

#### tile_as_texture property

The property indicating whether the image is tiled across the background.

True if the image is tiled across the background; otherwise, False (the image is stretched). The default value is False.

##### Definition:
```python
@property
def tile_as_texture(self):
    ...
@tile_as_texture.setter
def tile_as_texture(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationimagefillformat/transparency.md

#### transparency property

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### PresentationLayoutSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide.md

#### PresentationLayoutSlide class

Represents a PowerPoint content layout slide.

The PresentationLayoutSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| master_slide | The master slide for this PresentationLayoutSlide. |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### master_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/master_slide.md

#### master_slide property

The master slide for this PresentationLayoutSlide.

##### Definition:
```python
@property
def master_slide(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationLayoutSlideCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationlayoutslidecollection.md

#### PresentationLayoutSlideCollection class

Represents a collection of layout slides in a PowerPoint document.

This collection contains the items of `PresentationLayoutSlide` type.

The PresentationLayoutSlideCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### PresentationMasterHandoutSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide.md

#### PresentationMasterHandoutSlide class

Represents a master handout slide in a PowerPoint content.

The PresentationMasterHandoutSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterhandoutslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationMasterNotesSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide.md

#### PresentationMasterNotesSlide class

Represents a master slide for all notes slides in a PowerPoint document.

The PresentationMasterNotesSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasternotesslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationMasterSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide.md

#### PresentationMasterSlide class

Represents a PowerPoint document master slide.

The PresentationMasterSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationMasterSlideCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationmasterslidecollection.md

#### PresentationMasterSlideCollection class

Represents a collection of master slides in a PowerPoint document.

This collection contains the items of `PresentationMasterSlide` type.

The PresentationMasterSlideCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### PresentationNotesSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide.md

#### PresentationNotesSlide class

Represents a PowerPoint document notes slide.

The PresentationNotesSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationnotesslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape.md

#### PresentationShape class

Represents a drawing shape in a PowerPoint document.

The PresentationShape type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_hyperlink | Gets the hyperlink associated with this `IPresentationHyperlinkContainer`. |
| get_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink | Sets the hyperlink associated with the PresentationBaseShape. |
| set_hyperlink_file |  |
| set_hyperlink_presentation_hyperlink_action_type |  |
| set_hyperlink_string |  |

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this PresentationShape. |
| height | The height of the object. |
| image | The image of this PresentationShape, or None if the shape has no image. |
| rotate_angle | The rotate angle of this PresentationShape in degrees. |
| shape_type | The geometry preset type of the shape. |
| text | The text of this `PresentationShape`. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |
| alternative_text | The descriptive (alternative) text associated with this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| id | The identifier of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| image_fill_format | The image fill format settings of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| name | The name of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| presentation | The parent presentation of this PresentationBaseShape. (inherited from `PresentationBaseShape`) |
| z_order_position | The position of this `PresentationBaseShape` in the z-order. (inherited from `PresentationBaseShape`) |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text associated with
this `PresentationBaseShape`.

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this PresentationShape.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### get_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/get_hyperlink.md

#### get_hyperlink

Gets the hyperlink associated with this `IPresentationHyperlinkContainer`.

```python
def get_hyperlink(self, action_type):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |

**Returns:** The url of the hyperlink that is activated on specified action.

### get_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/get_hyperlink_presentation_hyperlink_action_type.md

#### get_hyperlink_presentation_hyperlink_action_type

```python
def get_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/id.md

#### id property

Gets the identifier of this `PresentationBaseShape`.

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/image.md

#### image property

The image of this PresentationShape, or None if the shape has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of this `PresentationBaseShape`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/name.md

#### name property

Gets the name of this `PresentationBaseShape`.

### presentation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/presentation.md

#### presentation property

Gets the parent presentation of this `PresentationBaseShape`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/rotate_angle.md

#### rotate_angle property

The rotate angle of this PresentationShape in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### set_hyperlink method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/set_hyperlink.md

#### set_hyperlink

Sets the hyperlink associated with the PresentationBaseShape.

```python
def set_hyperlink(self, action_type, url):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| action_type | `PresentationHyperlinkActionType` | The action that activates the hyperlink. |
| url | `str` | The hyperlink url. |

### set_hyperlink_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/set_hyperlink_file.md

#### set_hyperlink_file

```python
def set_hyperlink_file(self):
    ...
```

### set_hyperlink_presentation_hyperlink_action_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/set_hyperlink_presentation_hyperlink_action_type.md

#### set_hyperlink_presentation_hyperlink_action_type

```python
def set_hyperlink_presentation_hyperlink_action_type(self):
    ...
```

### set_hyperlink_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/set_hyperlink_string.md

#### set_hyperlink_string

```python
def set_hyperlink_string(self):
    ...
```

### shape_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/shape_type.md

#### shape_type property

The geometry preset type of the shape.

##### Definition:
```python
@property
def shape_type(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/text.md

#### text property

The text of this `PresentationShape`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### z_order_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshape/z_order_position.md

#### z_order_position property

Gets the position of this `PresentationBaseShape` in the z-order.

##### Remarks

A shape with greater z-order is always in front of a shape with a lower z-order.

### PresentationShapeCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapecollection.md

#### PresentationShapeCollection class

Represents a collection of drawing shapes in a PowerPoint document.

This collection contains the items of `PresentationShape` type.

The PresentationShapeCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### PresentationShapeSettings class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings.md

#### PresentationShapeSettings class

Represents settings that can be applied to a shape watermark for a PowerPoint document.

The PresentationShapeSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of PresentationShapeSettings. |

##### Properties
| Property | Description |
| :- | :- |
| is_locked | The `is_locked` property indicates whether editing of the shape in PowerPoint is forbidden. |
| protect_with_unreadable_characters | The property indicating whether the text watermark characters are mixed with unreadable characters. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `OfficeShapeSettings`) |
| name | The name of the shape. (inherited from `OfficeShapeSettings`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings/__init__.md

#### __init__

Initializes a new instance of PresentationShapeSettings.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings/is_locked.md

#### is_locked property

The `is_locked` property indicates whether editing of the shape in PowerPoint is forbidden.

When set to True, shape editing is forbidden; the default is False, allowing editing.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapesettings/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

The property indicating whether the text watermark characters are mixed with unreadable characters.

This protection applies only when `PresentationShapeSettings.is_locked` is True.

##### Definition:
```python
@property
def protect_with_unreadable_characters(self):
    ...
@protect_with_unreadable_characters.setter
def protect_with_unreadable_characters(self, value):
    ...
```

### PresentationShapeType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype.md

#### PresentationShapeType class

The PresentationShapeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| CUSTOM | Built-in shape geometry preset type. |
| LINE | Built-in shape geometry preset type. |
| LINE_INVERSE | Built-in shape geometry preset type. |
| TRIANGLE | Built-in shape geometry preset type. |
| RIGHT_TRIANGLE | Built-in shape geometry preset type. |
| RECTANGLE | Built-in shape geometry preset type. |
| DIAMOND | Built-in shape geometry preset type. |
| PARALLELOGRAM | Built-in shape geometry preset type. |
| TRAPEZOID | Built-in shape geometry preset type. |
| NON_ISOSCELES_TRAPEZOID | Built-in shape geometry preset type. |
| PENTAGON | Built-in shape geometry preset type. |
| HEXAGON | Built-in shape geometry preset type. |
| HEPTAGON | Built-in shape geometry preset type. |
| OCTAGON | Built-in shape geometry preset type. |
| DECAGON | Built-in shape geometry preset type. |
| DODECAGON | Built-in shape geometry preset type. |
| FOUR_POINTED_STAR | Built-in shape geometry preset type. |
| FIVE_POINTED_STAR | Built-in shape geometry preset type. |
| SIX_POINTED_STAR | Built-in shape geometry preset type. |
| SEVEN_POINTED_STAR | Built-in shape geometry preset type. |
| EIGHT_POINTED_STAR | Built-in shape geometry preset type. |
| TEN_POINTED_STAR | Built-in shape geometry preset type. |
| TWELVE_POINTED_STAR | Built-in shape geometry preset type. |
| SIXTEEN_POINTED_STAR | Built-in shape geometry preset type. |
| TWENTY_FOUR_POINTED_STAR | Built-in shape geometry preset type. |
| THIRTY_TWO_POINTED_STAR | Built-in shape geometry preset type. |
| ROUND_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| ONE_ROUND_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| TWO_SAMESIDE_ROUND_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| TWO_DIAGONAL_ROUND_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| ONE_SNIP_ONE_ROUND_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| ONE_SNIP_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| TWO_SAMESIDE_SNIP_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| TWO_DIAGONAL_SNIP_CORNER_RECTANGLE | Built-in shape geometry preset type. |
| PLAQUE | Built-in shape geometry preset type. |
| ELLIPSE | Built-in shape geometry preset type. |
| TEARDROP | Built-in shape geometry preset type. |
| HOME_PLATE | Built-in shape geometry preset type. |
| CHEVRON | Built-in shape geometry preset type. |
| PIE_WEDGE | Built-in shape geometry preset type. |
| PIE | Built-in shape geometry preset type. |
| BLOCK_ARC | Built-in shape geometry preset type. |
| DONUT | Built-in shape geometry preset type. |
| NO_SMOKING | Built-in shape geometry preset type. |
| RIGHT_ARROW | Built-in shape geometry preset type. |
| LEFT_ARROW | Built-in shape geometry preset type. |
| UP_ARROW | Built-in shape geometry preset type. |
| DOWN_ARROW | Built-in shape geometry preset type. |
| STRIPED_RIGHT_ARROW | Built-in shape geometry preset type. |
| NOTCHED_RIGHT_ARROW | Built-in shape geometry preset type. |
| BENT_UP_ARROW | Built-in shape geometry preset type. |
| LEFT_RIGHT_ARROW | Built-in shape geometry preset type. |
| UP_DOWN_ARROW | Built-in shape geometry preset type. |
| LEFT_UP_ARROW | Built-in shape geometry preset type. |
| LEFT_RIGHT_UP_ARROW | Built-in shape geometry preset type. |
| QUAD_ARROW | Built-in shape geometry preset type. |
| CALLOUT_LEFT_ARROW | Built-in shape geometry preset type. |
| CALLOUT_RIGHT_ARROW | Built-in shape geometry preset type. |
| CALLOUT_UP_ARROW | Built-in shape geometry preset type. |
| CALLOUT_DOWN_ARROW | Built-in shape geometry preset type. |
| CALLOUT_LEFT_RIGHT_ARROW | Built-in shape geometry preset type. |
| CALLOUT_UP_DOWN_ARROW | Built-in shape geometry preset type. |
| CALLOUT_QUAD_ARROW | Built-in shape geometry preset type. |
| BENT_ARROW | Built-in shape geometry preset type. |
| UTURN_ARROW | Built-in shape geometry preset type. |
| CIRCULAR_ARROW | Built-in shape geometry preset type. |
| LEFT_CIRCULAR_ARROW | Built-in shape geometry preset type. |
| LEFT_RIGHT_CIRCULAR_ARROW | Built-in shape geometry preset type. |
| CURVED_RIGHT_ARROW | Built-in shape geometry preset type. |
| CURVED_LEFT_ARROW | Built-in shape geometry preset type. |
| CURVED_UP_ARROW | Built-in shape geometry preset type. |
| CURVED_DOWN_ARROW | Built-in shape geometry preset type. |
| SWOOSH_ARROW | Built-in shape geometry preset type. |
| CUBE | Built-in shape geometry preset type. |
| CAN | Built-in shape geometry preset type. |
| LIGHTNING_BOLT | Built-in shape geometry preset type. |
| HEART | Built-in shape geometry preset type. |
| SUN | Built-in shape geometry preset type. |
| MOON | Built-in shape geometry preset type. |
| SMILEY_FACE | Built-in shape geometry preset type. |
| IRREGULAR_SEAL1 | Built-in shape geometry preset type. |
| IRREGULAR_SEAL2 | Built-in shape geometry preset type. |
| FOLDED_CORNER | Built-in shape geometry preset type. |
| BEVEL | Built-in shape geometry preset type. |
| FRAME | Built-in shape geometry preset type. |
| HALF_FRAME | Built-in shape geometry preset type. |
| CORNER | Built-in shape geometry preset type. |
| DIAGONAL_STRIPE | Built-in shape geometry preset type. |
| CHORD | Built-in shape geometry preset type. |
| CURVED_ARC | Built-in shape geometry preset type. |
| LEFT_BRACKET | Built-in shape geometry preset type. |
| RIGHT_BRACKET | Built-in shape geometry preset type. |
| LEFT_BRACE | Built-in shape geometry preset type. |
| RIGHT_BRACE | Built-in shape geometry preset type. |
| BRACKET_PAIR | Built-in shape geometry preset type. |
| BRACE_PAIR | Built-in shape geometry preset type. |
| STRAIGHT_CONNECTOR1 | Built-in shape geometry preset type. |
| BENT_CONNECTOR2 | Built-in shape geometry preset type. |
| BENT_CONNECTOR3 | Built-in shape geometry preset type. |
| BENT_CONNECTOR4 | Built-in shape geometry preset type. |
| BENT_CONNECTOR5 | Built-in shape geometry preset type. |
| CURVED_CONNECTOR2 | Built-in shape geometry preset type. |
| CURVED_CONNECTOR3 | Built-in shape geometry preset type. |
| CURVED_CONNECTOR4 | Built-in shape geometry preset type. |
| CURVED_CONNECTOR5 | Built-in shape geometry preset type. |
| CALLOUT1 | Built-in shape geometry preset type. |
| CALLOUT2 | Built-in shape geometry preset type. |
| CALLOUT3 | Built-in shape geometry preset type. |
| CALLOUT1_WITH_ACCENT | Built-in shape geometry preset type. |
| CALLOUT2_WITH_ACCENT | Built-in shape geometry preset type. |
| CALLOUT3_WITH_ACCENT | Built-in shape geometry preset type. |
| CALLOUT1_WITH_BORDER | Built-in shape geometry preset type. |
| CALLOUT2_WITH_BORDER | Built-in shape geometry preset type. |
| CALLOUT3_WITH_BORDER | Built-in shape geometry preset type. |
| CALLOUT1_WITH_BORDER_AND_ACCENT | Built-in shape geometry preset type. |
| CALLOUT2_WITH_BORDER_AND_ACCENT | Built-in shape geometry preset type. |
| CALLOUT3_WITH_BORDER_AND_ACCENT | Built-in shape geometry preset type. |
| CALLOUT_WEDGE_RECTANGLE | Built-in shape geometry preset type. |
| CALLOUT_WEDGE_ROUND_RECTANGLE | Built-in shape geometry preset type. |
| CALLOUT_WEDGE_ELLIPSE | Built-in shape geometry preset type. |
| CALLOUT_CLOUD | Built-in shape geometry preset type. |
| CLOUD | Built-in shape geometry preset type. |
| RIBBON | Built-in shape geometry preset type. |
| RIBBON2 | Built-in shape geometry preset type. |
| ELLIPSE_RIBBON | Built-in shape geometry preset type. |
| ELLIPSE_RIBBON2 | Built-in shape geometry preset type. |
| LEFT_RIGHT_RIBBON | Built-in shape geometry preset type. |
| VERTICAL_SCROLL | Built-in shape geometry preset type. |
| HORIZONTAL_SCROLL | Built-in shape geometry preset type. |
| WAVE | Built-in shape geometry preset type. |
| DOUBLE_WAVE | Built-in shape geometry preset type. |
| PLUS | Built-in shape geometry preset type. |
| PROCESS_FLOW | Built-in shape geometry preset type. |
| DECISION_FLOW | Built-in shape geometry preset type. |
| INPUT_OUTPUT_FLOW | Built-in shape geometry preset type. |
| PREDEFINED_PROCESS_FLOW | Built-in shape geometry preset type. |
| INTERNAL_STORAGE_FLOW | Built-in shape geometry preset type. |
| DOCUMENT_FLOW | Built-in shape geometry preset type. |
| MULTI_DOCUMENT_FLOW | Built-in shape geometry preset type. |
| TERMINATOR_FLOW | Built-in shape geometry preset type. |
| PREPARATION_FLOW | Built-in shape geometry preset type. |
| MANUAL_INPUT_FLOW | Built-in shape geometry preset type. |
| MANUAL_OPERATION_FLOW | Built-in shape geometry preset type. |
| CONNECTOR_FLOW | Built-in shape geometry preset type. |
| PUNCHED_CARD_FLOW | Built-in shape geometry preset type. |
| PUNCHED_TAPE_FLOW | Built-in shape geometry preset type. |
| SUMMING_JUNCTION_FLOW | Built-in shape geometry preset type. |
| OR_FLOW | Built-in shape geometry preset type. |
| COLLATE_FLOW | Built-in shape geometry preset type. |
| SORT_FLOW | Built-in shape geometry preset type. |
| EXTRACT_FLOW | Built-in shape geometry preset type. |
| MERGE_FLOW | Built-in shape geometry preset type. |
| OFFLINE_STORAGE_FLOW | Built-in shape geometry preset type. |
| ONLINE_STORAGE_FLOW | Built-in shape geometry preset type. |
| MAGNETIC_TAPE_FLOW | Built-in shape geometry preset type. |
| MAGNETIC_DISK_FLOW | Built-in shape geometry preset type. |
| MAGNETIC_DRUM_FLOW | Built-in shape geometry preset type. |
| DISPLAY_FLOW | Built-in shape geometry preset type. |
| DELAY_FLOW | Built-in shape geometry preset type. |
| ALTERNATE_PROCESS_FLOW | Built-in shape geometry preset type. |
| OFF_PAGE_CONNECTOR_FLOW | Built-in shape geometry preset type. |
| BLANK_BUTTON | Built-in shape geometry preset type. |
| HOME_BUTTON | Built-in shape geometry preset type. |
| HELP_BUTTON | Built-in shape geometry preset type. |
| INFORMATION_BUTTON | Built-in shape geometry preset type. |
| FORWARD_OR_NEXT_BUTTON | Built-in shape geometry preset type. |
| BACK_OR_PREVIOUS_BUTTON | Built-in shape geometry preset type. |
| END_BUTTON | Built-in shape geometry preset type. |
| BEGINNING_BUTTON | Built-in shape geometry preset type. |
| RETURN_BUTTON | Built-in shape geometry preset type. |
| DOCUMENT_BUTTON | Built-in shape geometry preset type. |
| SOUND_BUTTON | Built-in shape geometry preset type. |
| MOVIE_BUTTON | Built-in shape geometry preset type. |
| GEAR6 | Built-in shape geometry preset type. |
| GEAR9 | Built-in shape geometry preset type. |
| FUNNEL | Built-in shape geometry preset type. |
| PLUS_MATH | Built-in shape geometry preset type. |
| MINUS_MATH | Built-in shape geometry preset type. |
| MULTIPLY_MATH | Built-in shape geometry preset type. |
| DIVIDE_MATH | Built-in shape geometry preset type. |
| EQUAL_MATH | Built-in shape geometry preset type. |
| NOT_EQUAL_MATH | Built-in shape geometry preset type. |
| CORNER_TABS | Built-in shape geometry preset type. |
| SQUARE_TABS | Built-in shape geometry preset type. |
| PLAQUE_TABS | Built-in shape geometry preset type. |
| CHART_X | Built-in shape geometry preset type. |
| CHART_STAR | Built-in shape geometry preset type. |
| CHART_PLUS | Built-in shape geometry preset type. |
| NOT_DEFINED | UndefinedDocument shape type. |

### ALTERNATE_PROCESS_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/alternate_process_flow.md

#### ALTERNATE_PROCESS_FLOW field

Built-in shape geometry preset type.

##### Value
`159`

### BACK_OR_PREVIOUS_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/back_or_previous_button.md

#### BACK_OR_PREVIOUS_BUTTON field

Built-in shape geometry preset type.

##### Value
`166`

### BEGINNING_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/beginning_button.md

#### BEGINNING_BUTTON field

Built-in shape geometry preset type.

##### Value
`168`

### BENT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_arrow.md

#### BENT_ARROW field

Built-in shape geometry preset type.

##### Value
`63`

### BENT_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_connector2.md

#### BENT_CONNECTOR2 field

Built-in shape geometry preset type.

##### Value
`97`

### BENT_CONNECTOR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_connector3.md

#### BENT_CONNECTOR3 field

Built-in shape geometry preset type.

##### Value
`98`

### BENT_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_connector4.md

#### BENT_CONNECTOR4 field

Built-in shape geometry preset type.

##### Value
`99`

### BENT_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_connector5.md

#### BENT_CONNECTOR5 field

Built-in shape geometry preset type.

##### Value
`100`

### BENT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bent_up_arrow.md

#### BENT_UP_ARROW field

Built-in shape geometry preset type.

##### Value
`50`

### BEVEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bevel.md

#### BEVEL field

Built-in shape geometry preset type.

##### Value
`83`

### BLANK_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/blank_button.md

#### BLANK_BUTTON field

Built-in shape geometry preset type.

##### Value
`161`

### BLOCK_ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/block_arc.md

#### BLOCK_ARC field

Built-in shape geometry preset type.

##### Value
`41`

### BRACE_PAIR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/brace_pair.md

#### BRACE_PAIR field

Built-in shape geometry preset type.

##### Value
`95`

### BRACKET_PAIR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/bracket_pair.md

#### BRACKET_PAIR field

Built-in shape geometry preset type.

##### Value
`94`

### CALLOUT1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout1.md

#### CALLOUT1 field

Built-in shape geometry preset type.

##### Value
`105`

### CALLOUT1_WITH_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout1_with_accent.md

#### CALLOUT1_WITH_ACCENT field

Built-in shape geometry preset type.

##### Value
`108`

### CALLOUT1_WITH_BORDER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout1_with_border.md

#### CALLOUT1_WITH_BORDER field

Built-in shape geometry preset type.

##### Value
`111`

### CALLOUT1_WITH_BORDER_AND_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout1_with_border_and_accent.md

#### CALLOUT1_WITH_BORDER_AND_ACCENT field

Built-in shape geometry preset type.

##### Value
`114`

### CALLOUT2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout2.md

#### CALLOUT2 field

Built-in shape geometry preset type.

##### Value
`106`

### CALLOUT2_WITH_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout2_with_accent.md

#### CALLOUT2_WITH_ACCENT field

Built-in shape geometry preset type.

##### Value
`109`

### CALLOUT2_WITH_BORDER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout2_with_border.md

#### CALLOUT2_WITH_BORDER field

Built-in shape geometry preset type.

##### Value
`112`

### CALLOUT2_WITH_BORDER_AND_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout2_with_border_and_accent.md

#### CALLOUT2_WITH_BORDER_AND_ACCENT field

Built-in shape geometry preset type.

##### Value
`115`

### CALLOUT3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout3.md

#### CALLOUT3 field

Built-in shape geometry preset type.

##### Value
`107`

### CALLOUT3_WITH_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout3_with_accent.md

#### CALLOUT3_WITH_ACCENT field

Built-in shape geometry preset type.

##### Value
`110`

### CALLOUT3_WITH_BORDER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout3_with_border.md

#### CALLOUT3_WITH_BORDER field

Built-in shape geometry preset type.

##### Value
`113`

### CALLOUT3_WITH_BORDER_AND_ACCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout3_with_border_and_accent.md

#### CALLOUT3_WITH_BORDER_AND_ACCENT field

Built-in shape geometry preset type.

##### Value
`116`

### CALLOUT_CLOUD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_cloud.md

#### CALLOUT_CLOUD field

Built-in shape geometry preset type.

##### Value
`120`

### CALLOUT_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_down_arrow.md

#### CALLOUT_DOWN_ARROW field

Built-in shape geometry preset type.

##### Value
`59`

### CALLOUT_LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_left_arrow.md

#### CALLOUT_LEFT_ARROW field

Built-in shape geometry preset type.

##### Value
`56`

### CALLOUT_LEFT_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_left_right_arrow.md

#### CALLOUT_LEFT_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`60`

### CALLOUT_QUAD_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_quad_arrow.md

#### CALLOUT_QUAD_ARROW field

Built-in shape geometry preset type.

##### Value
`62`

### CALLOUT_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_right_arrow.md

#### CALLOUT_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`57`

### CALLOUT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_up_arrow.md

#### CALLOUT_UP_ARROW field

Built-in shape geometry preset type.

##### Value
`58`

### CALLOUT_UP_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_up_down_arrow.md

#### CALLOUT_UP_DOWN_ARROW field

Built-in shape geometry preset type.

##### Value
`61`

### CALLOUT_WEDGE_ELLIPSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_wedge_ellipse.md

#### CALLOUT_WEDGE_ELLIPSE field

Built-in shape geometry preset type.

##### Value
`119`

### CALLOUT_WEDGE_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_wedge_rectangle.md

#### CALLOUT_WEDGE_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`117`

### CALLOUT_WEDGE_ROUND_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/callout_wedge_round_rectangle.md

#### CALLOUT_WEDGE_ROUND_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`118`

### CAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/can.md

#### CAN field

Built-in shape geometry preset type.

##### Value
`74`

### CHART_PLUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/chart_plus.md

#### CHART_PLUS field

Built-in shape geometry preset type.

##### Value
`187`

### CHART_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/chart_star.md

#### CHART_STAR field

Built-in shape geometry preset type.

##### Value
`186`

### CHART_X field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/chart_x.md

#### CHART_X field

Built-in shape geometry preset type.

##### Value
`185`

### CHEVRON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/chevron.md

#### CHEVRON field

Built-in shape geometry preset type.

##### Value
`38`

### CHORD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/chord.md

#### CHORD field

Built-in shape geometry preset type.

##### Value
`88`

### CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/circular_arrow.md

#### CIRCULAR_ARROW field

Built-in shape geometry preset type.

##### Value
`65`

### CLOUD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/cloud.md

#### CLOUD field

Built-in shape geometry preset type.

##### Value
`121`

### COLLATE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/collate_flow.md

#### COLLATE_FLOW field

Built-in shape geometry preset type.

##### Value
`148`

### CONNECTOR_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/connector_flow.md

#### CONNECTOR_FLOW field

Built-in shape geometry preset type.

##### Value
`143`

### CORNER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/corner.md

#### CORNER field

Built-in shape geometry preset type.

##### Value
`86`

### CORNER_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/corner_tabs.md

#### CORNER_TABS field

Built-in shape geometry preset type.

##### Value
`182`

### CUBE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/cube.md

#### CUBE field

Built-in shape geometry preset type.

##### Value
`73`

### CURVED_ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_arc.md

#### CURVED_ARC field

Built-in shape geometry preset type.

##### Value
`89`

### CURVED_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_connector2.md

#### CURVED_CONNECTOR2 field

Built-in shape geometry preset type.

##### Value
`101`

### CURVED_CONNECTOR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_connector3.md

#### CURVED_CONNECTOR3 field

Built-in shape geometry preset type.

##### Value
`102`

### CURVED_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_connector4.md

#### CURVED_CONNECTOR4 field

Built-in shape geometry preset type.

##### Value
`103`

### CURVED_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_connector5.md

#### CURVED_CONNECTOR5 field

Built-in shape geometry preset type.

##### Value
`104`

### CURVED_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_down_arrow.md

#### CURVED_DOWN_ARROW field

Built-in shape geometry preset type.

##### Value
`71`

### CURVED_LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_left_arrow.md

#### CURVED_LEFT_ARROW field

Built-in shape geometry preset type.

##### Value
`69`

### CURVED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_right_arrow.md

#### CURVED_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`68`

### CURVED_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/curved_up_arrow.md

#### CURVED_UP_ARROW field

Built-in shape geometry preset type.

##### Value
`70`

### CUSTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/custom.md

#### CUSTOM field

Built-in shape geometry preset type.

##### Value
`0`

### DECAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/decagon.md

#### DECAGON field

Built-in shape geometry preset type.

##### Value
`14`

### DECISION_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/decision_flow.md

#### DECISION_FLOW field

Built-in shape geometry preset type.

##### Value
`133`

### DELAY_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/delay_flow.md

#### DELAY_FLOW field

Built-in shape geometry preset type.

##### Value
`158`

### DIAGONAL_STRIPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/diagonal_stripe.md

#### DIAGONAL_STRIPE field

Built-in shape geometry preset type.

##### Value
`87`

### DIAMOND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/diamond.md

#### DIAMOND field

Built-in shape geometry preset type.

##### Value
`6`

### DISPLAY_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/display_flow.md

#### DISPLAY_FLOW field

Built-in shape geometry preset type.

##### Value
`157`

### DIVIDE_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/divide_math.md

#### DIVIDE_MATH field

Built-in shape geometry preset type.

##### Value
`179`

### DOCUMENT_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/document_button.md

#### DOCUMENT_BUTTON field

Built-in shape geometry preset type.

##### Value
`170`

### DOCUMENT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/document_flow.md

#### DOCUMENT_FLOW field

Built-in shape geometry preset type.

##### Value
`137`

### DODECAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/dodecagon.md

#### DODECAGON field

Built-in shape geometry preset type.

##### Value
`15`

### DONUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/donut.md

#### DONUT field

Built-in shape geometry preset type.

##### Value
`42`

### DOUBLE_WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/double_wave.md

#### DOUBLE_WAVE field

Built-in shape geometry preset type.

##### Value
`130`

### DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/down_arrow.md

#### DOWN_ARROW field

Built-in shape geometry preset type.

##### Value
`47`

### EIGHT_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/eight_pointed_star.md

#### EIGHT_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`20`

### ELLIPSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ellipse.md

#### ELLIPSE field

Built-in shape geometry preset type.

##### Value
`35`

### ELLIPSE_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ellipse_ribbon.md

#### ELLIPSE_RIBBON field

Built-in shape geometry preset type.

##### Value
`124`

### ELLIPSE_RIBBON2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ellipse_ribbon2.md

#### ELLIPSE_RIBBON2 field

Built-in shape geometry preset type.

##### Value
`125`

### END_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/end_button.md

#### END_BUTTON field

Built-in shape geometry preset type.

##### Value
`167`

### EQUAL_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/equal_math.md

#### EQUAL_MATH field

Built-in shape geometry preset type.

##### Value
`180`

### EXTRACT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/extract_flow.md

#### EXTRACT_FLOW field

Built-in shape geometry preset type.

##### Value
`150`

### FIVE_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/five_pointed_star.md

#### FIVE_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`17`

### FOLDED_CORNER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/folded_corner.md

#### FOLDED_CORNER field

Built-in shape geometry preset type.

##### Value
`82`

### FORWARD_OR_NEXT_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/forward_or_next_button.md

#### FORWARD_OR_NEXT_BUTTON field

Built-in shape geometry preset type.

##### Value
`165`

### FOUR_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/four_pointed_star.md

#### FOUR_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`16`

### FRAME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/frame.md

#### FRAME field

Built-in shape geometry preset type.

##### Value
`84`

### FUNNEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/funnel.md

#### FUNNEL field

Built-in shape geometry preset type.

##### Value
`175`

### GEAR6 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/gear6.md

#### GEAR6 field

Built-in shape geometry preset type.

##### Value
`173`

### GEAR9 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/gear9.md

#### GEAR9 field

Built-in shape geometry preset type.

##### Value
`174`

### HALF_FRAME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/half_frame.md

#### HALF_FRAME field

Built-in shape geometry preset type.

##### Value
`85`

### HEART field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/heart.md

#### HEART field

Built-in shape geometry preset type.

##### Value
`76`

### HELP_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/help_button.md

#### HELP_BUTTON field

Built-in shape geometry preset type.

##### Value
`163`

### HEPTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/heptagon.md

#### HEPTAGON field

Built-in shape geometry preset type.

##### Value
`12`

### HEXAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/hexagon.md

#### HEXAGON field

Built-in shape geometry preset type.

##### Value
`11`

### HOME_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/home_button.md

#### HOME_BUTTON field

Built-in shape geometry preset type.

##### Value
`162`

### HOME_PLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/home_plate.md

#### HOME_PLATE field

Built-in shape geometry preset type.

##### Value
`37`

### HORIZONTAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/horizontal_scroll.md

#### HORIZONTAL_SCROLL field

Built-in shape geometry preset type.

##### Value
`128`

### INFORMATION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/information_button.md

#### INFORMATION_BUTTON field

Built-in shape geometry preset type.

##### Value
`164`

### INPUT_OUTPUT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/input_output_flow.md

#### INPUT_OUTPUT_FLOW field

Built-in shape geometry preset type.

##### Value
`134`

### INTERNAL_STORAGE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/internal_storage_flow.md

#### INTERNAL_STORAGE_FLOW field

Built-in shape geometry preset type.

##### Value
`136`

### IRREGULAR_SEAL1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/irregular_seal1.md

#### IRREGULAR_SEAL1 field

Built-in shape geometry preset type.

##### Value
`80`

### IRREGULAR_SEAL2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/irregular_seal2.md

#### IRREGULAR_SEAL2 field

Built-in shape geometry preset type.

##### Value
`81`

### LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_arrow.md

#### LEFT_ARROW field

Built-in shape geometry preset type.

##### Value
`45`

### LEFT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_brace.md

#### LEFT_BRACE field

Built-in shape geometry preset type.

##### Value
`92`

### LEFT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_bracket.md

#### LEFT_BRACKET field

Built-in shape geometry preset type.

##### Value
`90`

### LEFT_CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_circular_arrow.md

#### LEFT_CIRCULAR_ARROW field

Built-in shape geometry preset type.

##### Value
`66`

### LEFT_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_right_arrow.md

#### LEFT_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`51`

### LEFT_RIGHT_CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_right_circular_arrow.md

#### LEFT_RIGHT_CIRCULAR_ARROW field

Built-in shape geometry preset type.

##### Value
`67`

### LEFT_RIGHT_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_right_ribbon.md

#### LEFT_RIGHT_RIBBON field

Built-in shape geometry preset type.

##### Value
`126`

### LEFT_RIGHT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_right_up_arrow.md

#### LEFT_RIGHT_UP_ARROW field

Built-in shape geometry preset type.

##### Value
`54`

### LEFT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/left_up_arrow.md

#### LEFT_UP_ARROW field

Built-in shape geometry preset type.

##### Value
`53`

### LIGHTNING_BOLT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/lightning_bolt.md

#### LIGHTNING_BOLT field

Built-in shape geometry preset type.

##### Value
`75`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/line.md

#### LINE field

Built-in shape geometry preset type.

##### Value
`1`

### LINE_INVERSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/line_inverse.md

#### LINE_INVERSE field

Built-in shape geometry preset type.

##### Value
`2`

### MAGNETIC_DISK_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/magnetic_disk_flow.md

#### MAGNETIC_DISK_FLOW field

Built-in shape geometry preset type.

##### Value
`155`

### MAGNETIC_DRUM_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/magnetic_drum_flow.md

#### MAGNETIC_DRUM_FLOW field

Built-in shape geometry preset type.

##### Value
`156`

### MAGNETIC_TAPE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/magnetic_tape_flow.md

#### MAGNETIC_TAPE_FLOW field

Built-in shape geometry preset type.

##### Value
`154`

### MANUAL_INPUT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/manual_input_flow.md

#### MANUAL_INPUT_FLOW field

Built-in shape geometry preset type.

##### Value
`141`

### MANUAL_OPERATION_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/manual_operation_flow.md

#### MANUAL_OPERATION_FLOW field

Built-in shape geometry preset type.

##### Value
`142`

### MERGE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/merge_flow.md

#### MERGE_FLOW field

Built-in shape geometry preset type.

##### Value
`151`

### MINUS_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/minus_math.md

#### MINUS_MATH field

Built-in shape geometry preset type.

##### Value
`177`

### MOON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/moon.md

#### MOON field

Built-in shape geometry preset type.

##### Value
`78`

### MOVIE_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/movie_button.md

#### MOVIE_BUTTON field

Built-in shape geometry preset type.

##### Value
`172`

### MULTI_DOCUMENT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/multi_document_flow.md

#### MULTI_DOCUMENT_FLOW field

Built-in shape geometry preset type.

##### Value
`138`

### MULTIPLY_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/multiply_math.md

#### MULTIPLY_MATH field

Built-in shape geometry preset type.

##### Value
`178`

### NO_SMOKING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/no_smoking.md

#### NO_SMOKING field

Built-in shape geometry preset type.

##### Value
`43`

### NON_ISOSCELES_TRAPEZOID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/non_isosceles_trapezoid.md

#### NON_ISOSCELES_TRAPEZOID field

Built-in shape geometry preset type.

##### Value
`9`

### NOT_DEFINED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/not_defined.md

#### NOT_DEFINED field

UndefinedDocument shape type.

##### Value
`-1`

### NOT_EQUAL_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/not_equal_math.md

#### NOT_EQUAL_MATH field

Built-in shape geometry preset type.

##### Value
`181`

### NOTCHED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/notched_right_arrow.md

#### NOTCHED_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`49`

### OCTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/octagon.md

#### OCTAGON field

Built-in shape geometry preset type.

##### Value
`13`

### OFF_PAGE_CONNECTOR_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/off_page_connector_flow.md

#### OFF_PAGE_CONNECTOR_FLOW field

Built-in shape geometry preset type.

##### Value
`160`

### OFFLINE_STORAGE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/offline_storage_flow.md

#### OFFLINE_STORAGE_FLOW field

Built-in shape geometry preset type.

##### Value
`152`

### ONE_ROUND_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/one_round_corner_rectangle.md

#### ONE_ROUND_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`27`

### ONE_SNIP_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/one_snip_corner_rectangle.md

#### ONE_SNIP_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`31`

### ONE_SNIP_ONE_ROUND_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/one_snip_one_round_corner_rectangle.md

#### ONE_SNIP_ONE_ROUND_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`30`

### ONLINE_STORAGE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/online_storage_flow.md

#### ONLINE_STORAGE_FLOW field

Built-in shape geometry preset type.

##### Value
`153`

### OR_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/or_flow.md

#### OR_FLOW field

Built-in shape geometry preset type.

##### Value
`147`

### PARALLELOGRAM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/parallelogram.md

#### PARALLELOGRAM field

Built-in shape geometry preset type.

##### Value
`7`

### PENTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/pentagon.md

#### PENTAGON field

Built-in shape geometry preset type.

##### Value
`10`

### PIE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/pie.md

#### PIE field

Built-in shape geometry preset type.

##### Value
`40`

### PIE_WEDGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/pie_wedge.md

#### PIE_WEDGE field

Built-in shape geometry preset type.

##### Value
`39`

### PLAQUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/plaque.md

#### PLAQUE field

Built-in shape geometry preset type.

##### Value
`34`

### PLAQUE_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/plaque_tabs.md

#### PLAQUE_TABS field

Built-in shape geometry preset type.

##### Value
`184`

### PLUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/plus.md

#### PLUS field

Built-in shape geometry preset type.

##### Value
`131`

### PLUS_MATH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/plus_math.md

#### PLUS_MATH field

Built-in shape geometry preset type.

##### Value
`176`

### PREDEFINED_PROCESS_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/predefined_process_flow.md

#### PREDEFINED_PROCESS_FLOW field

Built-in shape geometry preset type.

##### Value
`135`

### PREPARATION_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/preparation_flow.md

#### PREPARATION_FLOW field

Built-in shape geometry preset type.

##### Value
`140`

### PROCESS_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/process_flow.md

#### PROCESS_FLOW field

Built-in shape geometry preset type.

##### Value
`132`

### PUNCHED_CARD_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/punched_card_flow.md

#### PUNCHED_CARD_FLOW field

Built-in shape geometry preset type.

##### Value
`144`

### PUNCHED_TAPE_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/punched_tape_flow.md

#### PUNCHED_TAPE_FLOW field

Built-in shape geometry preset type.

##### Value
`145`

### QUAD_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/quad_arrow.md

#### QUAD_ARROW field

Built-in shape geometry preset type.

##### Value
`55`

### RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/rectangle.md

#### RECTANGLE field

Built-in shape geometry preset type.

##### Value
`5`

### RETURN_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/return_button.md

#### RETURN_BUTTON field

Built-in shape geometry preset type.

##### Value
`169`

### RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ribbon.md

#### RIBBON field

Built-in shape geometry preset type.

##### Value
`122`

### RIBBON2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ribbon2.md

#### RIBBON2 field

Built-in shape geometry preset type.

##### Value
`123`

### RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/right_arrow.md

#### RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`44`

### RIGHT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/right_brace.md

#### RIGHT_BRACE field

Built-in shape geometry preset type.

##### Value
`93`

### RIGHT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/right_bracket.md

#### RIGHT_BRACKET field

Built-in shape geometry preset type.

##### Value
`91`

### RIGHT_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/right_triangle.md

#### RIGHT_TRIANGLE field

Built-in shape geometry preset type.

##### Value
`4`

### ROUND_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/round_corner_rectangle.md

#### ROUND_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`26`

### SEVEN_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/seven_pointed_star.md

#### SEVEN_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`19`

### SIX_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/six_pointed_star.md

#### SIX_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`18`

### SIXTEEN_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/sixteen_pointed_star.md

#### SIXTEEN_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`23`

### SMILEY_FACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/smiley_face.md

#### SMILEY_FACE field

Built-in shape geometry preset type.

##### Value
`79`

### SORT_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/sort_flow.md

#### SORT_FLOW field

Built-in shape geometry preset type.

##### Value
`149`

### SOUND_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/sound_button.md

#### SOUND_BUTTON field

Built-in shape geometry preset type.

##### Value
`171`

### SQUARE_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/square_tabs.md

#### SQUARE_TABS field

Built-in shape geometry preset type.

##### Value
`183`

### STRAIGHT_CONNECTOR1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/straight_connector1.md

#### STRAIGHT_CONNECTOR1 field

Built-in shape geometry preset type.

##### Value
`96`

### STRIPED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/striped_right_arrow.md

#### STRIPED_RIGHT_ARROW field

Built-in shape geometry preset type.

##### Value
`48`

### SUMMING_JUNCTION_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/summing_junction_flow.md

#### SUMMING_JUNCTION_FLOW field

Built-in shape geometry preset type.

##### Value
`146`

### SUN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/sun.md

#### SUN field

Built-in shape geometry preset type.

##### Value
`77`

### SWOOSH_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/swoosh_arrow.md

#### SWOOSH_ARROW field

Built-in shape geometry preset type.

##### Value
`72`

### TEARDROP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/teardrop.md

#### TEARDROP field

Built-in shape geometry preset type.

##### Value
`36`

### TEN_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/ten_pointed_star.md

#### TEN_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`21`

### TERMINATOR_FLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/terminator_flow.md

#### TERMINATOR_FLOW field

Built-in shape geometry preset type.

##### Value
`139`

### THIRTY_TWO_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/thirty_two_pointed_star.md

#### THIRTY_TWO_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`25`

### TRAPEZOID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/trapezoid.md

#### TRAPEZOID field

Built-in shape geometry preset type.

##### Value
`8`

### TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/triangle.md

#### TRIANGLE field

Built-in shape geometry preset type.

##### Value
`3`

### TWELVE_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/twelve_pointed_star.md

#### TWELVE_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`22`

### TWENTY_FOUR_POINTED_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/twenty_four_pointed_star.md

#### TWENTY_FOUR_POINTED_STAR field

Built-in shape geometry preset type.

##### Value
`24`

### TWO_DIAGONAL_ROUND_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/two_diagonal_round_corner_rectangle.md

#### TWO_DIAGONAL_ROUND_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`29`

### TWO_DIAGONAL_SNIP_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/two_diagonal_snip_corner_rectangle.md

#### TWO_DIAGONAL_SNIP_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`33`

### TWO_SAMESIDE_ROUND_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/two_sameside_round_corner_rectangle.md

#### TWO_SAMESIDE_ROUND_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`28`

### TWO_SAMESIDE_SNIP_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/two_sameside_snip_corner_rectangle.md

#### TWO_SAMESIDE_SNIP_CORNER_RECTANGLE field

Built-in shape geometry preset type.

##### Value
`32`

### UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/up_arrow.md

#### UP_ARROW field

Built-in shape geometry preset type.

##### Value
`46`

### UP_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/up_down_arrow.md

#### UP_DOWN_ARROW field

Built-in shape geometry preset type.

##### Value
`52`

### UTURN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/uturn_arrow.md

#### UTURN_ARROW field

Built-in shape geometry preset type.

##### Value
`64`

### VERTICAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/vertical_scroll.md

#### VERTICAL_SCROLL field

Built-in shape geometry preset type.

##### Value
`127`

### WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationshapetype/wave.md

#### WAVE field

Built-in shape geometry preset type.

##### Value
`129`

### PresentationSlide class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide.md

#### PresentationSlide class

Represents a PowerPoint document slide.

The PresentationSlide type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| layout_slide | The layout slide for this PresentationSlide. |
| master_slide | The master slide for this PresentationSlide. |
| notes_slide | The notes slide for this PresentationSlide. |
| charts | The collection of all charts on the presentation. (inherited from `PresentationBaseSlide`) |
| image_fill_format | The image fill format settings of the presentation. (inherited from `PresentationBaseSlide`) |
| shapes | The collection of all shapes of the presentation. (inherited from `PresentationBaseSlide`) |

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/charts.md

#### charts property

Gets the collection of all charts on the presentation.

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/image_fill_format.md

#### image_fill_format property

Gets the image fill format settings of the presentation.

### layout_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/layout_slide.md

#### layout_slide property

The layout slide for this PresentationSlide.

##### Definition:
```python
@property
def layout_slide(self):
    ...
```

### master_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/master_slide.md

#### master_slide property

The master slide for this PresentationSlide.

##### Definition:
```python
@property
def master_slide(self):
    ...
```

### notes_slide property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/notes_slide.md

#### notes_slide property

The notes slide for this PresentationSlide.

##### Definition:
```python
@property
def notes_slide(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslide/shapes.md

#### shapes property

Gets the collection of all shapes of the presentation.

### PresentationSlideCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslidecollection.md

#### PresentationSlideCollection class

Represents a collection of slides in a PowerPoint document.

This collection contains the items of `PresentationSlide` type.

The PresentationSlideCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### PresentationSlideImageFillFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat.md

#### PresentationSlideImageFillFormat class

Represents the image fill format settings for a slide in a PowerPoint document.

The PresentationSlideImageFillFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_image | The background image. Returns None if the image is not set. |
| tile_as_texture | The property indicating whether the image is tiled across the background. (inherited from `PresentationImageFillFormat`) |
| transparency | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). (inherited from `PresentationImageFillFormat`) |

### background_image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat/background_image.md

#### background_image property

The background image. Returns None if the image is not set.

##### Definition:
```python
@property
def background_image(self):
    ...
@background_image.setter
def background_image(self, value):
    ...
```

### tile_as_texture property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat/tile_as_texture.md

#### tile_as_texture property

Gets or sets a value indicating whether the image is tiled across the background.

### transparency property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationslideimagefillformat/transparency.md

#### transparency property

Gets or sets the transparency of the background image as a value from 0.0 (opaque) through 1.0
(fully transparent).

### PresentationWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage.md

#### PresentationWatermarkableImage class

Represents an image inside a PowerPoint document.

The PresentationWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `PresentationWatermarkableImage` using the provided image data. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    slide = content.slides[0]
    with open("background.png", "rb") as f:
        slide.image_fill_format.background_image = gwc_ppt.PresentationWatermarkableImage(f.read())
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/__init__.md

#### __init__

Initializes a new instance of `PresentationWatermarkableImage` using the provided image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | `list[int]` | The array of unsigned bytes from which to create the `PresentationWatermarkableImage`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

with open("background.png", "rb") as f:
    img = gwc_ppt.PresentationWatermarkableImage(f.read())
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.presentation/presentationwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### groupdocs.watermark.contents.spreadsheet
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet.md

Types under `groupdocs.watermark.contents.spreadsheet`.

##### Classes
| Class | Description |
| :- | :- |
| `SpreadsheetAttachment` | Represents a file attached to an Excel document. |
| `SpreadsheetAttachmentCollection` | Represents a collection of attachments in an Excel document. |
| `SpreadsheetCellFormattedTextFragment` | Represents a fragment of formatted text in an Excel document cell. |
| `SpreadsheetChart` | Represents a chart in an Excel document. |
| `SpreadsheetContent` | Represents an Excel document where a watermark can be placed. |
| `SpreadsheetHeaderFooter` | Represents a header/footer in an Excel document. |
| `SpreadsheetHeaderFooterCollection` | Represents a collection of headers and footers in an Excel document. |
| `SpreadsheetHeaderFooterSection` | Represents a header/footer section in an Excel document. |
| `SpreadsheetHeaderFooterSectionCollection` | Represents a collection of header/footer sections. |
| `SpreadsheetImageFillFormat` | Represents the image fill format settings in an Excel document. |
| `SpreadsheetPageSetup` | Represents printing page properties for a worksheet. |
| `SpreadsheetShape` | Represents a drawing shape in an Excel document. |
| `SpreadsheetShapeFormattedTextFragment` | Represents a fragment of formatted text in Excel document shape. |
| `SpreadsheetTextEffectFormattedTextFragment` | Represents a fragment of formatted text in Excel document WordArt shape. |
| `SpreadsheetWatermarkableImage` | Represents an image inside an Excel document. |
| `SpreadsheetWorksheet` | Represents an Excel document worksheet. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `SpreadsheetAutoShapeType` |  |
| `SpreadsheetCellFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in an Excel document cell. |
| `SpreadsheetChartCollection` | Represents a collection of charts in an Excel document. |
| `SpreadsheetHeaderFooterSectionType` |  |
| `SpreadsheetMsoDrawingType` |  |
| `SpreadsheetShapeCollection` | Represents a collection of drawing shapes in an Excel document. |
| `SpreadsheetShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in an Excel document text shape. |
| `SpreadsheetTextEffectFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in an Excel document WordArt shape. |
| `SpreadsheetWorksheetCollection` | Represents a collection of worksheets in an Excel document. |

### SpreadsheetAttachment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment.md

#### SpreadsheetAttachment class

Represents a file attached to an Excel document.

The SpreadsheetAttachment type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| create_watermarker | Loads a content from the attached file. (inherited from `Attachment`) |
| create_watermarker_load_options |  (inherited from `Attachment`) |
| get_document_info | Gets the information about a document stored in the attached file. (inherited from `Attachment`) |

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text associated with the attached file. |
| content | The attached file content. |
| height | The height of the attachment frame in points. |
| is_link | The attachment references the file via a link rather than containing its content. |
| preview_image_content | The attached file preview image as a byte array. |
| source_full_name | The full name of the attached file. |
| width | The width of the attachment frame in points. |
| x | The horizontal offset of the attachment frame from the worksheet left border in points, representing the x-coordinate of the attachment frame. |
| y | The vertical offset of the attachment frame from the worksheet top border in points (the y-coordinate of the attachment frame). |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/alternative_text.md

#### alternative_text property

The descriptive (alternative) text associated with the attached file.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/content.md

#### content property

The attached file content.

##### Definition:
```python
@property
def content(self):
    ...
@content.setter
def content(self, value):
    ...
```

### create_watermarker method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/create_watermarker.md

#### create_watermarker

Loads a content from the attached file.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self):
    ...
```

#### create_watermarker

Loads a content from the attached file with the specified load options.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |

#### create_watermarker

Loads a content from the attached file with the specified load options and settings.

##### Returns

The instance of appropriate descendant of `Content` class.

```python
def create_watermarker(self, load_options, watermarker_settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| load_options | groupdocs.watermark.options.LoadOptions | Additional options to use when loading an attachment content. |
| watermarker_settings | groupdocs.watermark.WatermarkerSettings | Additional settings to use when working with loaded document. |

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/get_document_info.md

#### get_document_info

Gets the information about a document stored in the attached file.

##### Returns

The `IDocumentInfo` instance that contains detected information

```python
def get_document_info(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/height.md

#### height property

The height of the attachment frame in points.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### is_link property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/is_link.md

#### is_link property

The attachment references the file via a link rather than containing its content.

True if the attached file is referenced by a link (the content does not contain attached file content); otherwise, False.

##### Definition:
```python
@property
def is_link(self):
    ...
```

### preview_image_content property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/preview_image_content.md

#### preview_image_content property

The attached file preview image as a byte array.

##### Definition:
```python
@property
def preview_image_content(self):
    ...
@preview_image_content.setter
def preview_image_content(self, value):
    ...
```

### source_full_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/source_full_name.md

#### source_full_name property

The full name of the attached file.

The extension is used to determine appropriate application to open the file.

##### Definition:
```python
@property
def source_full_name(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/width.md

#### width property

The width of the attachment frame in points.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/x.md

#### x property

The horizontal offset of the attachment frame from the worksheet left border in points, representing the x-coordinate of the attachment frame.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachment/y.md

#### y property

The vertical offset of the attachment frame from the worksheet top border in points (the y-coordinate of the attachment frame).

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### SpreadsheetAttachmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection.md

#### SpreadsheetAttachmentCollection class

Represents a collection of attachments in an Excel document.

This collection contains the items of `SpreadsheetAttachment` type.

The SpreadsheetAttachmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add_attachment | Adds an attachment to the SpreadsheetWorksheet. |
| add_attachment_bytes |  |
| add_attachment_file |  |
| add_attachment_string |  |
| add_link | Adds an attachment by a link (the document will not contain attached file content). |
| add_link_bytes |  |
| add_link_file |  |
| add_link_string |  |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add_attachment method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_attachment.md

#### add_attachment

Adds an attachment to the SpreadsheetWorksheet.

```python
def add_attachment(self, file_content, source_full_name, preview_image_content, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_content | `list[int]` | The content of the file to be attached. |
| source_full_name | `str` | The full name of the attached file. The extension is used to determine the appropriate application to open the file. |
| preview_image_content | `list[int]` | The attached file preview image as a byte array. |
| x | `float` | The x-coordinate of the attachment frame (in points). |
| y | `float` | The y-coordinate of the attachment frame (in points). |
| width | `float` | The width of the attachment frame in points. |
| height | `float` | The height of the attachment frame in points. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    worksheet = content.worksheets[0]
    with open("document.docx", "rb") as f_doc, open("document_preview.png", "rb") as f_prev:
        worksheet.attachments.add_attachment(
            f_doc.read(),
            "sample document.docx",
            f_prev.read(),
            50,
            100,
            200,
            400,
        )
    watermarker.save("spreadsheet.xlsx")
```

### add_attachment_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_attachment_bytes.md

#### add_attachment_bytes

```python
def add_attachment_bytes(self):
    ...
```

### add_attachment_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_attachment_file.md

#### add_attachment_file

```python
def add_attachment_file(self):
    ...
```

### add_attachment_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_attachment_string.md

#### add_attachment_string

```python
def add_attachment_string(self):
    ...
```

### add_link method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_link.md

#### add_link

Adds an attachment by a link (the document will not contain attached file content).

```python
def add_link(self, source_full_name, preview_image_content, x, y, width, height):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_full_name | `str` | The linked file path. |
| preview_image_content | `list[int]` | The attached file preview image as a byte array. |
| x | `float` | The x-coordinate of the attachment frame (in points). |
| y | `float` | The y-coordinate of the attachment frame (in points). |
| width | `float` | The width of the attachment frame in points. |
| height | `float` | The height of the attachment frame in points. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    worksheet = content.worksheets[0]
    with open("document_preview.png", "rb") as f_prev:
        worksheet.attachments.add_link(
            "document.docx",
            f_prev.read(),
            50,
            100,
            200,
            400,
        )
    watermarker.save("spreadsheet.xlsx")
```

### add_link_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_link_bytes.md

#### add_link_bytes

```python
def add_link_bytes(self):
    ...
```

### add_link_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_link_file.md

#### add_link_file

```python
def add_link_file(self):
    ...
```

### add_link_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetattachmentcollection/add_link_string.md

#### add_link_string

```python
def add_link_string(self):
    ...
```

### SpreadsheetAutoShapeType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype.md

#### SpreadsheetAutoShapeType class

The SpreadsheetAutoShapeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NOT_PRIMITIVE | Built-in auto shape type. |
| RECTANGLE | Built-in auto shape type. |
| ROUNDED_RECTANGLE | Built-in auto shape type. |
| OVAL | Built-in auto shape type. |
| DIAMOND | Built-in auto shape type. |
| ISOSCELES_TRIANGLE | Built-in auto shape type. |
| RIGHT_TRIANGLE | Built-in auto shape type. |
| PARALLELOGRAM | Built-in auto shape type. |
| TRAPEZOID | Built-in auto shape type. |
| HEXAGON | Built-in auto shape type. |
| OCTAGON | Built-in auto shape type. |
| CROSS | Built-in auto shape type. |
| STAR5 | Built-in auto shape type. |
| RIGHT_ARROW | Built-in auto shape type. |
| HOME_PLATE | Built-in auto shape type. |
| CUBE | Built-in auto shape type. |
| BALLOON | Built-in auto shape type. |
| SEAL | Built-in auto shape type. |
| ARC | Built-in auto shape type. |
| LINE | Built-in auto shape type. |
| PLAQUE | Built-in auto shape type. |
| CAN | Built-in auto shape type. |
| DONUT | Built-in auto shape type. |
| TEXT_SIMPLE | Built-in auto shape type. |
| TEXT_OCTAGON | Built-in auto shape type. |
| TEXT_HEXAGON | Built-in auto shape type. |
| TEXT_CURVE | Built-in auto shape type. |
| TEXT_WAVE | Built-in auto shape type. |
| TEXT_RING | Built-in auto shape type. |
| TEXT_ON_CURVE | Built-in auto shape type. |
| TEXT_ON_RING | Built-in auto shape type. |
| STRAIGHT_CONNECTOR | Built-in auto shape type. |
| BENT_CONNECTOR2 | Built-in auto shape type. |
| ELBOW_CONNECTOR | Built-in auto shape type. |
| BENT_CONNECTOR4 | Built-in auto shape type. |
| BENT_CONNECTOR5 | Built-in auto shape type. |
| CURVED_CONNECTOR2 | Built-in auto shape type. |
| CURVED_CONNECTOR | Built-in auto shape type. |
| CURVED_CONNECTOR4 | Built-in auto shape type. |
| CURVED_CONNECTOR5 | Built-in auto shape type. |
| LINE_CALLOUT_NO_BORDER2 | Built-in auto shape type. |
| LINE_CALLOUT_NO_BORDER3 | Built-in auto shape type. |
| LINE_CALLOUT_NO_BORDER4 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_ACCENT_BAR2 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_ACCENT_BAR3 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_ACCENT_BAR4 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER2 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER3 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER4 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR2 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR3 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR4 | Built-in auto shape type. |
| DOWN_RIBBON | Built-in auto shape type. |
| UP_RIBBON | Built-in auto shape type. |
| CHEVRON | Built-in auto shape type. |
| REGULAR_PENTAGON | Built-in auto shape type. |
| NO_SYMBOL | Built-in auto shape type. |
| STAR8 | Built-in auto shape type. |
| STAR16 | Built-in auto shape type. |
| STAR32 | Built-in auto shape type. |
| RECTANGULAR_CALLOUT | Built-in auto shape type. |
| ROUNDED_RECTANGULAR_CALLOUT | Built-in auto shape type. |
| OVAL_CALLOUT | Built-in auto shape type. |
| WAVE | Built-in auto shape type. |
| FOLDED_CORNER | Built-in auto shape type. |
| LEFT_ARROW | Built-in auto shape type. |
| DOWN_ARROW | Built-in auto shape type. |
| UP_ARROW | Built-in auto shape type. |
| LEFT_RIGHT_ARROW | Built-in auto shape type. |
| UP_DOWN_ARROW | Built-in auto shape type. |
| EXPLOSION1 | Built-in auto shape type. |
| EXPLOSION2 | Built-in auto shape type. |
| LIGHTNING_BOLT | Built-in auto shape type. |
| HEART | Built-in auto shape type. |
| PICTURE_FRAME | Built-in auto shape type. |
| QUAD_ARROW | Built-in auto shape type. |
| LEFT_ARROW_CALLOUT | Built-in auto shape type. |
| RIGHT_ARROW_CALLOUT | Built-in auto shape type. |
| UP_ARROW_CALLOUT | Built-in auto shape type. |
| DOWN_ARROW_CALLOUT | Built-in auto shape type. |
| LEFT_RIGHT_ARROW_CALLOUT | Built-in auto shape type. |
| UP_DOWN_ARROW_CALLOUT | Built-in auto shape type. |
| QUAD_ARROW_CALLOUT | Built-in auto shape type. |
| BEVEL | Built-in auto shape type. |
| LEFT_BRACKET | Built-in auto shape type. |
| RIGHT_BRACKET | Built-in auto shape type. |
| LEFT_BRACE | Built-in auto shape type. |
| RIGHT_BRACE | Built-in auto shape type. |
| LEFT_UP_ARROW | Built-in auto shape type. |
| BENT_UP_ARROW | Built-in auto shape type. |
| BENT_ARROW | Built-in auto shape type. |
| STAR24 | Built-in auto shape type. |
| STRIPED_RIGHT_ARROW | Built-in auto shape type. |
| NOTCHED_RIGHT_ARROW | Built-in auto shape type. |
| BLOCK_ARC | Built-in auto shape type. |
| SMILEY_FACE | Built-in auto shape type. |
| VERTICAL_SCROLL | Built-in auto shape type. |
| HORIZONTAL_SCROLL | Built-in auto shape type. |
| CIRCULAR_ARROW | Built-in auto shape type. |
| NOTCHED_CIRCULAR_ARROW | Built-in auto shape type. |
| UTURN_ARROW | Built-in auto shape type. |
| CURVED_RIGHT_ARROW | Built-in auto shape type. |
| CURVED_LEFT_ARROW | Built-in auto shape type. |
| CURVED_UP_ARROW | Built-in auto shape type. |
| CURVED_DOWN_ARROW | Built-in auto shape type. |
| CLOUD_CALLOUT | Built-in auto shape type. |
| CURVED_DOWN_RIBBON | Built-in auto shape type. |
| CURVED_UP_RIBBON | Built-in auto shape type. |
| FLOW_CHART_PROCESS | Built-in auto shape type. |
| FLOW_CHART_DECISION | Built-in auto shape type. |
| FLOW_CHART_DATA | Built-in auto shape type. |
| FLOW_CHART_PREDEFINED_PROCESS | Built-in auto shape type. |
| FLOW_CHART_INTERNAL_STORAGE | Built-in auto shape type. |
| FLOW_CHART_DOCUMENT | Built-in auto shape type. |
| FLOW_CHART_MULTIDOCUMENT | Built-in auto shape type. |
| FLOW_CHART_TERMINATOR | Built-in auto shape type. |
| FLOW_CHART_PREPARATION | Built-in auto shape type. |
| FLOW_CHART_MANUAL_INPUT | Built-in auto shape type. |
| FLOW_CHART_MANUAL_OPERATION | Built-in auto shape type. |
| FLOW_CHART_CONNECTOR | Built-in auto shape type. |
| FLOW_CHART_CARD | Built-in auto shape type. |
| FLOW_CHART_PUNCHED_TAPE | Built-in auto shape type. |
| FLOW_CHART_SUMMING_JUNCTION | Built-in auto shape type. |
| FLOW_CHART_OR | Built-in auto shape type. |
| FLOW_CHART_COLLATE | Built-in auto shape type. |
| FLOW_CHART_SORT | Built-in auto shape type. |
| FLOW_CHART_EXTRACT | Built-in auto shape type. |
| FLOW_CHART_MERGE | Built-in auto shape type. |
| FLOW_CHART_OFFLINE_STORAGE | Built-in auto shape type. |
| FLOW_CHART_STORED_DATA | Built-in auto shape type. |
| FLOW_CHART_SEQUENTIAL_ACCESS_STORAGE | Built-in auto shape type. |
| FLOW_CHART_MAGNETIC_DISK | Built-in auto shape type. |
| FLOW_CHART_DIRECT_ACCESS_STORAGE | Built-in auto shape type. |
| FLOW_CHART_DISPLAY | Built-in auto shape type. |
| FLOW_CHART_DELAY | Built-in auto shape type. |
| TEXT_PLAIN_TEXT | Built-in auto shape type. |
| TEXT_STOP | Built-in auto shape type. |
| TEXT_TRIANGLE | Built-in auto shape type. |
| TEXT_TRIANGLE_INVERTED | Built-in auto shape type. |
| TEXT_CHEVRON | Built-in auto shape type. |
| TEXT_CHEVRON_INVERTED | Built-in auto shape type. |
| TEXT_RING_INSIDE | Built-in auto shape type. |
| TEXT_RING_OUTSIDE | Built-in auto shape type. |
| TEXT_ARCH_UP_CURVE | Built-in auto shape type. |
| TEXT_ARCH_DOWN_CURVE | Built-in auto shape type. |
| TEXT_CIRCLE_CURVE | Built-in auto shape type. |
| TEXT_BUTTON_CURVE | Built-in auto shape type. |
| TEXT_ARCH_UP_POUR | Built-in auto shape type. |
| TEXT_ARCH_DOWN_POUR | Built-in auto shape type. |
| TEXT_CIRCLE_POUR | Built-in auto shape type. |
| TEXT_BUTTON_POUR | Built-in auto shape type. |
| TEXT_CURVE_UP | Built-in auto shape type. |
| TEXT_CURVE_DOWN | Built-in auto shape type. |
| TEXT_CASCADE_UP | Built-in auto shape type. |
| TEXT_CASCADE_DOWN | Built-in auto shape type. |
| TEXT_WAVE1 | Built-in auto shape type. |
| TEXT_WAVE2 | Built-in auto shape type. |
| TEXT_DOUBLE_WAVE1 | Built-in auto shape type. |
| TEXT_DOUBLE_WAVE2 | Built-in auto shape type. |
| TEXT_INFLATE | Built-in auto shape type. |
| TEXT_DEFLATE | Built-in auto shape type. |
| TEXT_INFLATE_BOTTOM | Built-in auto shape type. |
| TEXT_DEFLATE_BOTTOM | Built-in auto shape type. |
| TEXT_INFLATE_TOP | Built-in auto shape type. |
| TEXT_DEFLATE_TOP | Built-in auto shape type. |
| TEXT_DEFLATE_INFLATE | Built-in auto shape type. |
| TEXT_DEFLATE_INFLATE_DEFLATE | Built-in auto shape type. |
| TEXT_FADE_RIGHT | Built-in auto shape type. |
| TEXT_FADE_LEFT | Built-in auto shape type. |
| TEXT_FADE_UP | Built-in auto shape type. |
| TEXT_FADE_DOWN | Built-in auto shape type. |
| TEXT_SLANT_UP | Built-in auto shape type. |
| TEXT_SLANT_DOWN | Built-in auto shape type. |
| TEXT_CAN_UP | Built-in auto shape type. |
| TEXT_CAN_DOWN | Built-in auto shape type. |
| FLOW_CHART_ALTERNATE_PROCESS | Built-in auto shape type. |
| FLOW_CHART_OFFPAGE_CONNECTOR | Built-in auto shape type. |
| LINE_CALLOUT_NO_BORDER1 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_ACCENT_BAR1 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER1 | Built-in auto shape type. |
| LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR1 | Built-in auto shape type. |
| LEFT_RIGHT_UP_ARROW | Built-in auto shape type. |
| SUN | Built-in auto shape type. |
| MOON | Built-in auto shape type. |
| DOUBLE_BRACKET | Built-in auto shape type. |
| DOUBLE_BRACE | Built-in auto shape type. |
| STAR4 | Built-in auto shape type. |
| DOUBLE_WAVE | Built-in auto shape type. |
| BLANK_ACTION_BUTTON | Built-in auto shape type. |
| HOME_ACTION_BUTTON | Built-in auto shape type. |
| HELP_ACTION_BUTTON | Built-in auto shape type. |
| INFORMATION_ACTION_BUTTON | Built-in auto shape type. |
| FORWARD_NEXT_ACTION_BUTTON | Built-in auto shape type. |
| BACK_PREVIOUS_ACTION_BUTTON | Built-in auto shape type. |
| END_ACTION_BUTTON | Built-in auto shape type. |
| BEGINNING_ACTION_BUTTON | Built-in auto shape type. |
| RETURN_ACTION_BUTTON | Built-in auto shape type. |
| DOCUMENT_ACTION_BUTTON | Built-in auto shape type. |
| SOUND_ACTION_BUTTON | Built-in auto shape type. |
| MOVIE_ACTION_BUTTON | Built-in auto shape type. |
| HOST_CONTROL | Built-in auto shape type. |
| TEXT_BOX | Built-in auto shape type. |
| HEPTAGON | Built-in auto shape type. |
| DECAGON | Built-in auto shape type. |
| DODECAGON | Built-in auto shape type. |
| STAR6 | Built-in auto shape type. |
| STAR7 | Built-in auto shape type. |
| STAR10 | Built-in auto shape type. |
| STAR12 | Built-in auto shape type. |
| ROUND_SINGLE_CORNER_RECTANGLE | Built-in auto shape type. |
| ROUND_SAME_SIDE_CORNER_RECTANGLE | Built-in auto shape type. |
| ROUND_DIAGONAL_CORNER_RECTANGLE | Built-in auto shape type. |
| SNIP_ROUND_SINGLE_CORNER_RECTANGLE | Built-in auto shape type. |
| SNIP_SINGLE_CORNER_RECTANGLE | Built-in auto shape type. |
| SNIP_SAME_SIDE_CORNER_RECTANGLE | Built-in auto shape type. |
| SNIP_DIAGONAL_CORNER_RECTANGLE | Built-in auto shape type. |
| TEARDROP | Built-in auto shape type. |
| PIE | Built-in auto shape type. |
| HALF_FRAME | Built-in auto shape type. |
| LSHAPE | Built-in auto shape type. |
| DIAGONAL_STRIPE | Built-in auto shape type. |
| CHORD | Built-in auto shape type. |
| CLOUD | Built-in auto shape type. |
| MATH_PLUS | Built-in auto shape type. |
| MATH_MINUS | Built-in auto shape type. |
| MATH_MULTIPLY | Built-in auto shape type. |
| MATH_DIVIDE | Built-in auto shape type. |
| MATH_EQUAL | Built-in auto shape type. |
| MATH_NOT_EQUAL | Built-in auto shape type. |
| LINE_INV | Built-in auto shape type. |
| NON_ISOSCELES_TRAPEZOID | Built-in auto shape type. |
| PIE_WEDGE | Built-in auto shape type. |
| LEFT_CIRCULAR_ARROW | Built-in auto shape type. |
| LEFT_RIGHT_CIRCULAR_ARROW | Built-in auto shape type. |
| SWOOSH_ARROW | Built-in auto shape type. |
| LEFT_RIGHT_RIBBON | Built-in auto shape type. |
| TEXT_NO_SHAPE | Built-in auto shape type. |
| GEAR6 | Built-in auto shape type. |
| GEAR9 | Built-in auto shape type. |
| FUNNEL | Built-in auto shape type. |
| CORNER_TABS | Built-in auto shape type. |
| SQUARE_TABS | Built-in auto shape type. |
| PLAQUE_TABS | Built-in auto shape type. |
| CHART_X | Built-in auto shape type. |
| CHART_STAR | Built-in auto shape type. |
| CHART_PLUS | Built-in auto shape type. |
| FRAME | Built-in auto shape type. |
| MODEL_3D | Built-in auto shape type. |
| ROUND_CALLOUT | There is no such type in Excel. |
| TEXT_ARCH_LEFT_POUR | There is no such type in Excel. |
| TEXT_ARCH_RIGHT_POUR | There is no such type in Excel. |
| TEXT_ARCH_LEFT_CURVE | There is no such type in Excel. |
| TEXT_ARCH_RIGHT_CURVE | There is no such type in Excel. |
| UNKNOWN | Unknown auto shape type. |

### ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/arc.md

#### ARC field

Built-in auto shape type.

##### Value
`19`

### BACK_PREVIOUS_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/back_previous_action_button.md

#### BACK_PREVIOUS_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`194`

### BALLOON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/balloon.md

#### BALLOON field

Built-in auto shape type.

##### Value
`17`

### BEGINNING_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/beginning_action_button.md

#### BEGINNING_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`196`

### BENT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bent_arrow.md

#### BENT_ARROW field

Built-in auto shape type.

##### Value
`91`

### BENT_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bent_connector2.md

#### BENT_CONNECTOR2 field

Built-in auto shape type.

##### Value
`33`

### BENT_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bent_connector4.md

#### BENT_CONNECTOR4 field

Built-in auto shape type.

##### Value
`35`

### BENT_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bent_connector5.md

#### BENT_CONNECTOR5 field

Built-in auto shape type.

##### Value
`36`

### BENT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bent_up_arrow.md

#### BENT_UP_ARROW field

Built-in auto shape type.

##### Value
`90`

### BEVEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/bevel.md

#### BEVEL field

Built-in auto shape type.

##### Value
`84`

### BLANK_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/blank_action_button.md

#### BLANK_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`189`

### BLOCK_ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/block_arc.md

#### BLOCK_ARC field

Built-in auto shape type.

##### Value
`95`

### CAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/can.md

#### CAN field

Built-in auto shape type.

##### Value
`22`

### CHART_PLUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/chart_plus.md

#### CHART_PLUS field

Built-in auto shape type.

##### Value
`2105`

### CHART_STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/chart_star.md

#### CHART_STAR field

Built-in auto shape type.

##### Value
`2104`

### CHART_X field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/chart_x.md

#### CHART_X field

Built-in auto shape type.

##### Value
`2103`

### CHEVRON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/chevron.md

#### CHEVRON field

Built-in auto shape type.

##### Value
`55`

### CHORD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/chord.md

#### CHORD field

Built-in auto shape type.

##### Value
`2069`

### CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/circular_arrow.md

#### CIRCULAR_ARROW field

Built-in auto shape type.

##### Value
`99`

### CLOUD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/cloud.md

#### CLOUD field

Built-in auto shape type.

##### Value
`2070`

### CLOUD_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/cloud_callout.md

#### CLOUD_CALLOUT field

Built-in auto shape type.

##### Value
`106`

### CORNER_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/corner_tabs.md

#### CORNER_TABS field

Built-in auto shape type.

##### Value
`2100`

### CROSS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/cross.md

#### CROSS field

Built-in auto shape type.

##### Value
`11`

### CUBE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/cube.md

#### CUBE field

Built-in auto shape type.

##### Value
`16`

### CURVED_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_connector.md

#### CURVED_CONNECTOR field

Built-in auto shape type.

##### Value
`38`

### CURVED_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_connector2.md

#### CURVED_CONNECTOR2 field

Built-in auto shape type.

##### Value
`37`

### CURVED_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_connector4.md

#### CURVED_CONNECTOR4 field

Built-in auto shape type.

##### Value
`39`

### CURVED_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_connector5.md

#### CURVED_CONNECTOR5 field

Built-in auto shape type.

##### Value
`40`

### CURVED_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_down_arrow.md

#### CURVED_DOWN_ARROW field

Built-in auto shape type.

##### Value
`105`

### CURVED_DOWN_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_down_ribbon.md

#### CURVED_DOWN_RIBBON field

Built-in auto shape type.

##### Value
`107`

### CURVED_LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_left_arrow.md

#### CURVED_LEFT_ARROW field

Built-in auto shape type.

##### Value
`103`

### CURVED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_right_arrow.md

#### CURVED_RIGHT_ARROW field

Built-in auto shape type.

##### Value
`102`

### CURVED_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_up_arrow.md

#### CURVED_UP_ARROW field

Built-in auto shape type.

##### Value
`104`

### CURVED_UP_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/curved_up_ribbon.md

#### CURVED_UP_RIBBON field

Built-in auto shape type.

##### Value
`108`

### DECAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/decagon.md

#### DECAGON field

Built-in auto shape type.

##### Value
`2050`

### DIAGONAL_STRIPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/diagonal_stripe.md

#### DIAGONAL_STRIPE field

Built-in auto shape type.

##### Value
`2068`

### DIAMOND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/diamond.md

#### DIAMOND field

Built-in auto shape type.

##### Value
`4`

### DOCUMENT_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/document_action_button.md

#### DOCUMENT_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`198`

### DODECAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/dodecagon.md

#### DODECAGON field

Built-in auto shape type.

##### Value
`2051`

### DONUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/donut.md

#### DONUT field

Built-in auto shape type.

##### Value
`23`

### DOUBLE_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/double_brace.md

#### DOUBLE_BRACE field

Built-in auto shape type.

##### Value
`186`

### DOUBLE_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/double_bracket.md

#### DOUBLE_BRACKET field

Built-in auto shape type.

##### Value
`185`

### DOUBLE_WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/double_wave.md

#### DOUBLE_WAVE field

Built-in auto shape type.

##### Value
`188`

### DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/down_arrow.md

#### DOWN_ARROW field

Built-in auto shape type.

##### Value
`67`

### DOWN_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/down_arrow_callout.md

#### DOWN_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`80`

### DOWN_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/down_ribbon.md

#### DOWN_RIBBON field

Built-in auto shape type.

##### Value
`53`

### ELBOW_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/elbow_connector.md

#### ELBOW_CONNECTOR field

Built-in auto shape type.

##### Value
`34`

### END_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/end_action_button.md

#### END_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`195`

### EXPLOSION1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/explosion1.md

#### EXPLOSION1 field

Built-in auto shape type.

##### Value
`71`

### EXPLOSION2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/explosion2.md

#### EXPLOSION2 field

Built-in auto shape type.

##### Value
`72`

### FLOW_CHART_ALTERNATE_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_alternate_process.md

#### FLOW_CHART_ALTERNATE_PROCESS field

Built-in auto shape type.

##### Value
`176`

### FLOW_CHART_CARD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_card.md

#### FLOW_CHART_CARD field

Built-in auto shape type.

##### Value
`121`

### FLOW_CHART_COLLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_collate.md

#### FLOW_CHART_COLLATE field

Built-in auto shape type.

##### Value
`125`

### FLOW_CHART_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_connector.md

#### FLOW_CHART_CONNECTOR field

Built-in auto shape type.

##### Value
`120`

### FLOW_CHART_DATA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_data.md

#### FLOW_CHART_DATA field

Built-in auto shape type.

##### Value
`111`

### FLOW_CHART_DECISION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_decision.md

#### FLOW_CHART_DECISION field

Built-in auto shape type.

##### Value
`110`

### FLOW_CHART_DELAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_delay.md

#### FLOW_CHART_DELAY field

Built-in auto shape type.

##### Value
`135`

### FLOW_CHART_DIRECT_ACCESS_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_direct_access_storage.md

#### FLOW_CHART_DIRECT_ACCESS_STORAGE field

Built-in auto shape type.

##### Value
`133`

### FLOW_CHART_DISPLAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_display.md

#### FLOW_CHART_DISPLAY field

Built-in auto shape type.

##### Value
`134`

### FLOW_CHART_DOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_document.md

#### FLOW_CHART_DOCUMENT field

Built-in auto shape type.

##### Value
`114`

### FLOW_CHART_EXTRACT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_extract.md

#### FLOW_CHART_EXTRACT field

Built-in auto shape type.

##### Value
`127`

### FLOW_CHART_INTERNAL_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_internal_storage.md

#### FLOW_CHART_INTERNAL_STORAGE field

Built-in auto shape type.

##### Value
`113`

### FLOW_CHART_MAGNETIC_DISK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_magnetic_disk.md

#### FLOW_CHART_MAGNETIC_DISK field

Built-in auto shape type.

##### Value
`132`

### FLOW_CHART_MANUAL_INPUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_manual_input.md

#### FLOW_CHART_MANUAL_INPUT field

Built-in auto shape type.

##### Value
`118`

### FLOW_CHART_MANUAL_OPERATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_manual_operation.md

#### FLOW_CHART_MANUAL_OPERATION field

Built-in auto shape type.

##### Value
`119`

### FLOW_CHART_MERGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_merge.md

#### FLOW_CHART_MERGE field

Built-in auto shape type.

##### Value
`128`

### FLOW_CHART_MULTIDOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_multidocument.md

#### FLOW_CHART_MULTIDOCUMENT field

Built-in auto shape type.

##### Value
`115`

### FLOW_CHART_OFFLINE_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_offline_storage.md

#### FLOW_CHART_OFFLINE_STORAGE field

Built-in auto shape type.

##### Value
`129`

### FLOW_CHART_OFFPAGE_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_offpage_connector.md

#### FLOW_CHART_OFFPAGE_CONNECTOR field

Built-in auto shape type.

##### Value
`177`

### FLOW_CHART_OR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_or.md

#### FLOW_CHART_OR field

Built-in auto shape type.

##### Value
`124`

### FLOW_CHART_PREDEFINED_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_predefined_process.md

#### FLOW_CHART_PREDEFINED_PROCESS field

Built-in auto shape type.

##### Value
`112`

### FLOW_CHART_PREPARATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_preparation.md

#### FLOW_CHART_PREPARATION field

Built-in auto shape type.

##### Value
`117`

### FLOW_CHART_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_process.md

#### FLOW_CHART_PROCESS field

Built-in auto shape type.

##### Value
`109`

### FLOW_CHART_PUNCHED_TAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_punched_tape.md

#### FLOW_CHART_PUNCHED_TAPE field

Built-in auto shape type.

##### Value
`122`

### FLOW_CHART_SEQUENTIAL_ACCESS_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_sequential_access_storage.md

#### FLOW_CHART_SEQUENTIAL_ACCESS_STORAGE field

Built-in auto shape type.

##### Value
`131`

### FLOW_CHART_SORT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_sort.md

#### FLOW_CHART_SORT field

Built-in auto shape type.

##### Value
`126`

### FLOW_CHART_STORED_DATA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_stored_data.md

#### FLOW_CHART_STORED_DATA field

Built-in auto shape type.

##### Value
`130`

### FLOW_CHART_SUMMING_JUNCTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_summing_junction.md

#### FLOW_CHART_SUMMING_JUNCTION field

Built-in auto shape type.

##### Value
`123`

### FLOW_CHART_TERMINATOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/flow_chart_terminator.md

#### FLOW_CHART_TERMINATOR field

Built-in auto shape type.

##### Value
`116`

### FOLDED_CORNER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/folded_corner.md

#### FOLDED_CORNER field

Built-in auto shape type.

##### Value
`65`

### FORWARD_NEXT_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/forward_next_action_button.md

#### FORWARD_NEXT_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`193`

### FRAME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/frame.md

#### FRAME field

Built-in auto shape type.

##### Value
`2106`

### FUNNEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/funnel.md

#### FUNNEL field

Built-in auto shape type.

##### Value
`2099`

### GEAR6 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/gear6.md

#### GEAR6 field

Built-in auto shape type.

##### Value
`2097`

### GEAR9 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/gear9.md

#### GEAR9 field

Built-in auto shape type.

##### Value
`2098`

### HALF_FRAME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/half_frame.md

#### HALF_FRAME field

Built-in auto shape type.

##### Value
`2066`

### HEART field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/heart.md

#### HEART field

Built-in auto shape type.

##### Value
`74`

### HELP_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/help_action_button.md

#### HELP_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`191`

### HEPTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/heptagon.md

#### HEPTAGON field

Built-in auto shape type.

##### Value
`2049`

### HEXAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/hexagon.md

#### HEXAGON field

Built-in auto shape type.

##### Value
`9`

### HOME_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/home_action_button.md

#### HOME_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`190`

### HOME_PLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/home_plate.md

#### HOME_PLATE field

Built-in auto shape type.

##### Value
`15`

### HORIZONTAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/horizontal_scroll.md

#### HORIZONTAL_SCROLL field

Built-in auto shape type.

##### Value
`98`

### HOST_CONTROL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/host_control.md

#### HOST_CONTROL field

Built-in auto shape type.

##### Value
`201`

### INFORMATION_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/information_action_button.md

#### INFORMATION_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`192`

### ISOSCELES_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/isosceles_triangle.md

#### ISOSCELES_TRIANGLE field

Built-in auto shape type.

##### Value
`5`

### LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_arrow.md

#### LEFT_ARROW field

Built-in auto shape type.

##### Value
`66`

### LEFT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_arrow_callout.md

#### LEFT_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`77`

### LEFT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_brace.md

#### LEFT_BRACE field

Built-in auto shape type.

##### Value
`87`

### LEFT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_bracket.md

#### LEFT_BRACKET field

Built-in auto shape type.

##### Value
`85`

### LEFT_CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_circular_arrow.md

#### LEFT_CIRCULAR_ARROW field

Built-in auto shape type.

##### Value
`2080`

### LEFT_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_right_arrow.md

#### LEFT_RIGHT_ARROW field

Built-in auto shape type.

##### Value
`69`

### LEFT_RIGHT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_right_arrow_callout.md

#### LEFT_RIGHT_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`81`

### LEFT_RIGHT_CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_right_circular_arrow.md

#### LEFT_RIGHT_CIRCULAR_ARROW field

Built-in auto shape type.

##### Value
`2081`

### LEFT_RIGHT_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_right_ribbon.md

#### LEFT_RIGHT_RIBBON field

Built-in auto shape type.

##### Value
`2083`

### LEFT_RIGHT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_right_up_arrow.md

#### LEFT_RIGHT_UP_ARROW field

Built-in auto shape type.

##### Value
`182`

### LEFT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/left_up_arrow.md

#### LEFT_UP_ARROW field

Built-in auto shape type.

##### Value
`89`

### LIGHTNING_BOLT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/lightning_bolt.md

#### LIGHTNING_BOLT field

Built-in auto shape type.

##### Value
`73`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line.md

#### LINE field

Built-in auto shape type.

##### Value
`20`

### LINE_CALLOUT_NO_BORDER1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_no_border1.md

#### LINE_CALLOUT_NO_BORDER1 field

Built-in auto shape type.

##### Value
`178`

### LINE_CALLOUT_NO_BORDER2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_no_border2.md

#### LINE_CALLOUT_NO_BORDER2 field

Built-in auto shape type.

##### Value
`41`

### LINE_CALLOUT_NO_BORDER3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_no_border3.md

#### LINE_CALLOUT_NO_BORDER3 field

Built-in auto shape type.

##### Value
`42`

### LINE_CALLOUT_NO_BORDER4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_no_border4.md

#### LINE_CALLOUT_NO_BORDER4 field

Built-in auto shape type.

##### Value
`43`

### LINE_CALLOUT_WITH_ACCENT_BAR1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_accent_bar1.md

#### LINE_CALLOUT_WITH_ACCENT_BAR1 field

Built-in auto shape type.

##### Value
`179`

### LINE_CALLOUT_WITH_ACCENT_BAR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_accent_bar2.md

#### LINE_CALLOUT_WITH_ACCENT_BAR2 field

Built-in auto shape type.

##### Value
`44`

### LINE_CALLOUT_WITH_ACCENT_BAR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_accent_bar3.md

#### LINE_CALLOUT_WITH_ACCENT_BAR3 field

Built-in auto shape type.

##### Value
`45`

### LINE_CALLOUT_WITH_ACCENT_BAR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_accent_bar4.md

#### LINE_CALLOUT_WITH_ACCENT_BAR4 field

Built-in auto shape type.

##### Value
`46`

### LINE_CALLOUT_WITH_BORDER1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border1.md

#### LINE_CALLOUT_WITH_BORDER1 field

Built-in auto shape type.

##### Value
`180`

### LINE_CALLOUT_WITH_BORDER2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border2.md

#### LINE_CALLOUT_WITH_BORDER2 field

Built-in auto shape type.

##### Value
`47`

### LINE_CALLOUT_WITH_BORDER3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border3.md

#### LINE_CALLOUT_WITH_BORDER3 field

Built-in auto shape type.

##### Value
`48`

### LINE_CALLOUT_WITH_BORDER4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border4.md

#### LINE_CALLOUT_WITH_BORDER4 field

Built-in auto shape type.

##### Value
`49`

### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border_and_accent_bar1.md

#### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR1 field

Built-in auto shape type.

##### Value
`181`

### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border_and_accent_bar2.md

#### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR2 field

Built-in auto shape type.

##### Value
`50`

### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border_and_accent_bar3.md

#### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR3 field

Built-in auto shape type.

##### Value
`51`

### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_callout_with_border_and_accent_bar4.md

#### LINE_CALLOUT_WITH_BORDER_AND_ACCENT_BAR4 field

Built-in auto shape type.

##### Value
`52`

### LINE_INV field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/line_inv.md

#### LINE_INV field

Built-in auto shape type.

##### Value
`2077`

### LSHAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/lshape.md

#### LSHAPE field

Built-in auto shape type.

##### Value
`2067`

### MATH_DIVIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_divide.md

#### MATH_DIVIDE field

Built-in auto shape type.

##### Value
`2074`

### MATH_EQUAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_equal.md

#### MATH_EQUAL field

Built-in auto shape type.

##### Value
`2075`

### MATH_MINUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_minus.md

#### MATH_MINUS field

Built-in auto shape type.

##### Value
`2072`

### MATH_MULTIPLY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_multiply.md

#### MATH_MULTIPLY field

Built-in auto shape type.

##### Value
`2073`

### MATH_NOT_EQUAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_not_equal.md

#### MATH_NOT_EQUAL field

Built-in auto shape type.

##### Value
`2076`

### MATH_PLUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/math_plus.md

#### MATH_PLUS field

Built-in auto shape type.

##### Value
`2071`

### MODEL_3D field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/model_3d.md

#### MODEL_3D field

Built-in auto shape type.

##### Value
`2107`

### MOON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/moon.md

#### MOON field

Built-in auto shape type.

##### Value
`184`

### MOVIE_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/movie_action_button.md

#### MOVIE_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`200`

### NO_SYMBOL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/no_symbol.md

#### NO_SYMBOL field

Built-in auto shape type.

##### Value
`57`

### NON_ISOSCELES_TRAPEZOID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/non_isosceles_trapezoid.md

#### NON_ISOSCELES_TRAPEZOID field

Built-in auto shape type.

##### Value
`2078`

### NOT_PRIMITIVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/not_primitive.md

#### NOT_PRIMITIVE field

Built-in auto shape type.

##### Value
`0`

### NOTCHED_CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/notched_circular_arrow.md

#### NOTCHED_CIRCULAR_ARROW field

Built-in auto shape type.

##### Value
`100`

### NOTCHED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/notched_right_arrow.md

#### NOTCHED_RIGHT_ARROW field

Built-in auto shape type.

##### Value
`94`

### OCTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/octagon.md

#### OCTAGON field

Built-in auto shape type.

##### Value
`10`

### OVAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/oval.md

#### OVAL field

Built-in auto shape type.

##### Value
`3`

### OVAL_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/oval_callout.md

#### OVAL_CALLOUT field

Built-in auto shape type.

##### Value
`63`

### PARALLELOGRAM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/parallelogram.md

#### PARALLELOGRAM field

Built-in auto shape type.

##### Value
`7`

### PICTURE_FRAME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/picture_frame.md

#### PICTURE_FRAME field

Built-in auto shape type.

##### Value
`75`

### PIE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/pie.md

#### PIE field

Built-in auto shape type.

##### Value
`2064`

### PIE_WEDGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/pie_wedge.md

#### PIE_WEDGE field

Built-in auto shape type.

##### Value
`2079`

### PLAQUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/plaque.md

#### PLAQUE field

Built-in auto shape type.

##### Value
`21`

### PLAQUE_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/plaque_tabs.md

#### PLAQUE_TABS field

Built-in auto shape type.

##### Value
`2102`

### QUAD_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/quad_arrow.md

#### QUAD_ARROW field

Built-in auto shape type.

##### Value
`76`

### QUAD_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/quad_arrow_callout.md

#### QUAD_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`83`

### RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/rectangle.md

#### RECTANGLE field

Built-in auto shape type.

##### Value
`1`

### RECTANGULAR_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/rectangular_callout.md

#### RECTANGULAR_CALLOUT field

Built-in auto shape type.

##### Value
`61`

### REGULAR_PENTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/regular_pentagon.md

#### REGULAR_PENTAGON field

Built-in auto shape type.

##### Value
`56`

### RETURN_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/return_action_button.md

#### RETURN_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`197`

### RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/right_arrow.md

#### RIGHT_ARROW field

Built-in auto shape type.

##### Value
`13`

### RIGHT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/right_arrow_callout.md

#### RIGHT_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`78`

### RIGHT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/right_brace.md

#### RIGHT_BRACE field

Built-in auto shape type.

##### Value
`88`

### RIGHT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/right_bracket.md

#### RIGHT_BRACKET field

Built-in auto shape type.

##### Value
`86`

### RIGHT_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/right_triangle.md

#### RIGHT_TRIANGLE field

Built-in auto shape type.

##### Value
`6`

### ROUND_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/round_callout.md

#### ROUND_CALLOUT field

There is no such type in Excel.

##### Value
`2108`

### ROUND_DIAGONAL_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/round_diagonal_corner_rectangle.md

#### ROUND_DIAGONAL_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2058`

### ROUND_SAME_SIDE_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/round_same_side_corner_rectangle.md

#### ROUND_SAME_SIDE_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2057`

### ROUND_SINGLE_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/round_single_corner_rectangle.md

#### ROUND_SINGLE_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2056`

### ROUNDED_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/rounded_rectangle.md

#### ROUNDED_RECTANGLE field

Built-in auto shape type.

##### Value
`2`

### ROUNDED_RECTANGULAR_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/rounded_rectangular_callout.md

#### ROUNDED_RECTANGULAR_CALLOUT field

Built-in auto shape type.

##### Value
`62`

### SEAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/seal.md

#### SEAL field

Built-in auto shape type.

##### Value
`18`

### SMILEY_FACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/smiley_face.md

#### SMILEY_FACE field

Built-in auto shape type.

##### Value
`96`

### SNIP_DIAGONAL_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/snip_diagonal_corner_rectangle.md

#### SNIP_DIAGONAL_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2062`

### SNIP_ROUND_SINGLE_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/snip_round_single_corner_rectangle.md

#### SNIP_ROUND_SINGLE_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2059`

### SNIP_SAME_SIDE_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/snip_same_side_corner_rectangle.md

#### SNIP_SAME_SIDE_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2061`

### SNIP_SINGLE_CORNER_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/snip_single_corner_rectangle.md

#### SNIP_SINGLE_CORNER_RECTANGLE field

Built-in auto shape type.

##### Value
`2060`

### SOUND_ACTION_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/sound_action_button.md

#### SOUND_ACTION_BUTTON field

Built-in auto shape type.

##### Value
`199`

### SQUARE_TABS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/square_tabs.md

#### SQUARE_TABS field

Built-in auto shape type.

##### Value
`2101`

### STAR10 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star10.md

#### STAR10 field

Built-in auto shape type.

##### Value
`2054`

### STAR12 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star12.md

#### STAR12 field

Built-in auto shape type.

##### Value
`2055`

### STAR16 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star16.md

#### STAR16 field

Built-in auto shape type.

##### Value
`59`

### STAR24 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star24.md

#### STAR24 field

Built-in auto shape type.

##### Value
`92`

### STAR32 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star32.md

#### STAR32 field

Built-in auto shape type.

##### Value
`60`

### STAR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star4.md

#### STAR4 field

Built-in auto shape type.

##### Value
`187`

### STAR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star5.md

#### STAR5 field

Built-in auto shape type.

##### Value
`12`

### STAR6 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star6.md

#### STAR6 field

Built-in auto shape type.

##### Value
`2052`

### STAR7 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star7.md

#### STAR7 field

Built-in auto shape type.

##### Value
`2053`

### STAR8 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/star8.md

#### STAR8 field

Built-in auto shape type.

##### Value
`58`

### STRAIGHT_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/straight_connector.md

#### STRAIGHT_CONNECTOR field

Built-in auto shape type.

##### Value
`32`

### STRIPED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/striped_right_arrow.md

#### STRIPED_RIGHT_ARROW field

Built-in auto shape type.

##### Value
`93`

### SUN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/sun.md

#### SUN field

Built-in auto shape type.

##### Value
`183`

### SWOOSH_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/swoosh_arrow.md

#### SWOOSH_ARROW field

Built-in auto shape type.

##### Value
`2082`

### TEARDROP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/teardrop.md

#### TEARDROP field

Built-in auto shape type.

##### Value
`2063`

### TEXT_ARCH_DOWN_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_down_curve.md

#### TEXT_ARCH_DOWN_CURVE field

Built-in auto shape type.

##### Value
`145`

### TEXT_ARCH_DOWN_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_down_pour.md

#### TEXT_ARCH_DOWN_POUR field

Built-in auto shape type.

##### Value
`149`

### TEXT_ARCH_LEFT_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_left_curve.md

#### TEXT_ARCH_LEFT_CURVE field

There is no such type in Excel.

##### Value
`2111`

### TEXT_ARCH_LEFT_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_left_pour.md

#### TEXT_ARCH_LEFT_POUR field

There is no such type in Excel.

##### Value
`2109`

### TEXT_ARCH_RIGHT_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_right_curve.md

#### TEXT_ARCH_RIGHT_CURVE field

There is no such type in Excel.

##### Value
`2112`

### TEXT_ARCH_RIGHT_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_right_pour.md

#### TEXT_ARCH_RIGHT_POUR field

There is no such type in Excel.

##### Value
`2110`

### TEXT_ARCH_UP_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_up_curve.md

#### TEXT_ARCH_UP_CURVE field

Built-in auto shape type.

##### Value
`144`

### TEXT_ARCH_UP_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_arch_up_pour.md

#### TEXT_ARCH_UP_POUR field

Built-in auto shape type.

##### Value
`148`

### TEXT_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_box.md

#### TEXT_BOX field

Built-in auto shape type.

##### Value
`202`

### TEXT_BUTTON_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_button_curve.md

#### TEXT_BUTTON_CURVE field

Built-in auto shape type.

##### Value
`147`

### TEXT_BUTTON_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_button_pour.md

#### TEXT_BUTTON_POUR field

Built-in auto shape type.

##### Value
`151`

### TEXT_CAN_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_can_down.md

#### TEXT_CAN_DOWN field

Built-in auto shape type.

##### Value
`175`

### TEXT_CAN_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_can_up.md

#### TEXT_CAN_UP field

Built-in auto shape type.

##### Value
`174`

### TEXT_CASCADE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_cascade_down.md

#### TEXT_CASCADE_DOWN field

Built-in auto shape type.

##### Value
`155`

### TEXT_CASCADE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_cascade_up.md

#### TEXT_CASCADE_UP field

Built-in auto shape type.

##### Value
`154`

### TEXT_CHEVRON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_chevron.md

#### TEXT_CHEVRON field

Built-in auto shape type.

##### Value
`140`

### TEXT_CHEVRON_INVERTED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_chevron_inverted.md

#### TEXT_CHEVRON_INVERTED field

Built-in auto shape type.

##### Value
`141`

### TEXT_CIRCLE_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_circle_curve.md

#### TEXT_CIRCLE_CURVE field

Built-in auto shape type.

##### Value
`146`

### TEXT_CIRCLE_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_circle_pour.md

#### TEXT_CIRCLE_POUR field

Built-in auto shape type.

##### Value
`150`

### TEXT_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_curve.md

#### TEXT_CURVE field

Built-in auto shape type.

##### Value
`27`

### TEXT_CURVE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_curve_down.md

#### TEXT_CURVE_DOWN field

Built-in auto shape type.

##### Value
`153`

### TEXT_CURVE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_curve_up.md

#### TEXT_CURVE_UP field

Built-in auto shape type.

##### Value
`152`

### TEXT_DEFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_deflate.md

#### TEXT_DEFLATE field

Built-in auto shape type.

##### Value
`161`

### TEXT_DEFLATE_BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_deflate_bottom.md

#### TEXT_DEFLATE_BOTTOM field

Built-in auto shape type.

##### Value
`163`

### TEXT_DEFLATE_INFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_deflate_inflate.md

#### TEXT_DEFLATE_INFLATE field

Built-in auto shape type.

##### Value
`166`

### TEXT_DEFLATE_INFLATE_DEFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_deflate_inflate_deflate.md

#### TEXT_DEFLATE_INFLATE_DEFLATE field

Built-in auto shape type.

##### Value
`167`

### TEXT_DEFLATE_TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_deflate_top.md

#### TEXT_DEFLATE_TOP field

Built-in auto shape type.

##### Value
`165`

### TEXT_DOUBLE_WAVE1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_double_wave1.md

#### TEXT_DOUBLE_WAVE1 field

Built-in auto shape type.

##### Value
`158`

### TEXT_DOUBLE_WAVE2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_double_wave2.md

#### TEXT_DOUBLE_WAVE2 field

Built-in auto shape type.

##### Value
`159`

### TEXT_FADE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_fade_down.md

#### TEXT_FADE_DOWN field

Built-in auto shape type.

##### Value
`171`

### TEXT_FADE_LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_fade_left.md

#### TEXT_FADE_LEFT field

Built-in auto shape type.

##### Value
`169`

### TEXT_FADE_RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_fade_right.md

#### TEXT_FADE_RIGHT field

Built-in auto shape type.

##### Value
`168`

### TEXT_FADE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_fade_up.md

#### TEXT_FADE_UP field

Built-in auto shape type.

##### Value
`170`

### TEXT_HEXAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_hexagon.md

#### TEXT_HEXAGON field

Built-in auto shape type.

##### Value
`26`

### TEXT_INFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_inflate.md

#### TEXT_INFLATE field

Built-in auto shape type.

##### Value
`160`

### TEXT_INFLATE_BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_inflate_bottom.md

#### TEXT_INFLATE_BOTTOM field

Built-in auto shape type.

##### Value
`162`

### TEXT_INFLATE_TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_inflate_top.md

#### TEXT_INFLATE_TOP field

Built-in auto shape type.

##### Value
`164`

### TEXT_NO_SHAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_no_shape.md

#### TEXT_NO_SHAPE field

Built-in auto shape type.

##### Value
`2084`

### TEXT_OCTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_octagon.md

#### TEXT_OCTAGON field

Built-in auto shape type.

##### Value
`25`

### TEXT_ON_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_on_curve.md

#### TEXT_ON_CURVE field

Built-in auto shape type.

##### Value
`30`

### TEXT_ON_RING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_on_ring.md

#### TEXT_ON_RING field

Built-in auto shape type.

##### Value
`31`

### TEXT_PLAIN_TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_plain_text.md

#### TEXT_PLAIN_TEXT field

Built-in auto shape type.

##### Value
`136`

### TEXT_RING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_ring.md

#### TEXT_RING field

Built-in auto shape type.

##### Value
`29`

### TEXT_RING_INSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_ring_inside.md

#### TEXT_RING_INSIDE field

Built-in auto shape type.

##### Value
`142`

### TEXT_RING_OUTSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_ring_outside.md

#### TEXT_RING_OUTSIDE field

Built-in auto shape type.

##### Value
`143`

### TEXT_SIMPLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_simple.md

#### TEXT_SIMPLE field

Built-in auto shape type.

##### Value
`24`

### TEXT_SLANT_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_slant_down.md

#### TEXT_SLANT_DOWN field

Built-in auto shape type.

##### Value
`173`

### TEXT_SLANT_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_slant_up.md

#### TEXT_SLANT_UP field

Built-in auto shape type.

##### Value
`172`

### TEXT_STOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_stop.md

#### TEXT_STOP field

Built-in auto shape type.

##### Value
`137`

### TEXT_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_triangle.md

#### TEXT_TRIANGLE field

Built-in auto shape type.

##### Value
`138`

### TEXT_TRIANGLE_INVERTED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_triangle_inverted.md

#### TEXT_TRIANGLE_INVERTED field

Built-in auto shape type.

##### Value
`139`

### TEXT_WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_wave.md

#### TEXT_WAVE field

Built-in auto shape type.

##### Value
`28`

### TEXT_WAVE1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_wave1.md

#### TEXT_WAVE1 field

Built-in auto shape type.

##### Value
`156`

### TEXT_WAVE2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/text_wave2.md

#### TEXT_WAVE2 field

Built-in auto shape type.

##### Value
`157`

### TRAPEZOID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/trapezoid.md

#### TRAPEZOID field

Built-in auto shape type.

##### Value
`8`

### UNKNOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/unknown.md

#### UNKNOWN field

Unknown auto shape type.

##### Value
`4095`

### UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/up_arrow.md

#### UP_ARROW field

Built-in auto shape type.

##### Value
`68`

### UP_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/up_arrow_callout.md

#### UP_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`79`

### UP_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/up_down_arrow.md

#### UP_DOWN_ARROW field

Built-in auto shape type.

##### Value
`70`

### UP_DOWN_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/up_down_arrow_callout.md

#### UP_DOWN_ARROW_CALLOUT field

Built-in auto shape type.

##### Value
`82`

### UP_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/up_ribbon.md

#### UP_RIBBON field

Built-in auto shape type.

##### Value
`54`

### UTURN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/uturn_arrow.md

#### UTURN_ARROW field

Built-in auto shape type.

##### Value
`101`

### VERTICAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/vertical_scroll.md

#### VERTICAL_SCROLL field

Built-in auto shape type.

##### Value
`97`

### WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetautoshapetype/wave.md

#### WAVE field

Built-in auto shape type.

##### Value
`64`

### SpreadsheetCellFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment.md

#### SpreadsheetCellFormattedTextFragment class

Represents a fragment of formatted text in an Excel document cell.

The SpreadsheetCellFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### SpreadsheetCellFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragmentcollection.md

#### SpreadsheetCellFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document cell.

This collection contains the items of `SpreadsheetCellFormattedTextFragment` type.

The SpreadsheetCellFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcellformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### SpreadsheetChart class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart.md

#### SpreadsheetChart class

Represents a chart in an Excel document.

The SpreadsheetChart type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text associated with this SpreadsheetChart. |
| height | The height of this SpreadsheetChart in points. |
| hyperlink | The hyperlink associated with this SpreadsheetChart. |
| id | The identifier of this SpreadsheetChart. |
| image_fill_format | The image fill format settings of this `SpreadsheetChart`. |
| name | The name of this SpreadsheetChart. |
| width | The width of this `SpreadsheetChart` in points. |
| worksheet | The parent worksheet of this SpreadsheetChart. |
| x | The horizontal offset of this SpreadsheetChart from worksheet left border in points. |
| y | The y-coordinate of this SpreadsheetChart in points. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/alternative_text.md

#### alternative_text property

The descriptive (alternative) text associated with this SpreadsheetChart.

##### Definition:
```python
@property
def alternative_text(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/height.md

#### height property

The height of this SpreadsheetChart in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### hyperlink property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/hyperlink.md

#### hyperlink property

The hyperlink associated with this SpreadsheetChart.

##### Definition:
```python
@property
def hyperlink(self):
    ...
@hyperlink.setter
def hyperlink(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/id.md

#### id property

The identifier of this SpreadsheetChart.

##### Definition:
```python
@property
def id(self):
    ...
```

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/image_fill_format.md

#### image_fill_format property

The image fill format settings of this `SpreadsheetChart`.

##### Definition:
```python
@property
def image_fill_format(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/name.md

#### name property

The name of this SpreadsheetChart.

##### Definition:
```python
@property
def name(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/width.md

#### width property

The width of this `SpreadsheetChart` in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### worksheet property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/worksheet.md

#### worksheet property

The parent worksheet of this SpreadsheetChart.

##### Definition:
```python
@property
def worksheet(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/x.md

#### x property

The horizontal offset of this SpreadsheetChart from worksheet left border in points.

The x-coordinate of this SpreadsheetChart.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchart/y.md

#### y property

The y-coordinate of this SpreadsheetChart in points.

##### Definition:
```python
@property
def y(self):
    ...
```

### SpreadsheetChartCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetchartcollection.md

#### SpreadsheetChartCollection class

Represents a collection of charts in an Excel document.

This collection contains the items of `SpreadsheetChart` type.

The SpreadsheetChartCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### SpreadsheetContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent.md

#### SpreadsheetContent class

Represents an Excel document where a watermark can be placed.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents
- https://docs.groupdocs.com/display/watermarknet/Shapes+in+spreadsheet+document
- https://docs.groupdocs.com/display/watermarknet/Working+with+spreadsheet+document+attachments
- https://docs.groupdocs.com/display/watermarknet/Working+with+worksheet+backgrounds
- https://docs.groupdocs.com/display/watermarknet/Working+with+worksheet+headers+and+footers

The SpreadsheetContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| decrypt | Decrypts the document. |
| encrypt | Encrypts the content. |
| encrypt_file |  |
| encrypt_string |  |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| worksheets | The collection of all worksheets of this `SpreadsheetContent`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("input.xls", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    # perform watermark operations on content here
    watermarker.save("output.xls")
```

### decrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/decrypt.md

#### decrypt

Decrypts the document.

```python
def decrypt(self):
    ...
```

### encrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/encrypt.md

#### encrypt

Encrypts the content.

```python
def encrypt(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password that will be required to open the document. |

### encrypt_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/encrypt_file.md

#### encrypt_file

```python
def encrypt_file(self):
    ...
```

### encrypt_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/encrypt_string.md

#### encrypt_string

```python
def encrypt_string(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### worksheets property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetcontent/worksheets.md

#### worksheets property

The collection of all worksheets of this `SpreadsheetContent`.

##### Definition:
```python
@property
def worksheets(self):
    ...
```

### SpreadsheetHeaderFooter class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter.md

#### SpreadsheetHeaderFooter class

Represents a header/footer in an Excel document.

The SpreadsheetHeaderFooter type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| header_footer_type | The type of this SpreadsheetHeaderFooter. |
| sections | The collection of header/footer sections. |
| worksheet | The parent worksheet of this SpreadsheetHeaderFooter. |

### header_footer_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/header_footer_type.md

#### header_footer_type property

The type of this SpreadsheetHeaderFooter.

##### Definition:
```python
@property
def header_footer_type(self):
    ...
```

### sections property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/sections.md

#### sections property

The collection of header/footer sections.

##### Definition:
```python
@property
def sections(self):
    ...
```

### worksheet property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfooter/worksheet.md

#### worksheet property

The parent worksheet of this SpreadsheetHeaderFooter.

##### Definition:
```python
@property
def worksheet(self):
    ...
```

### SpreadsheetHeaderFooterCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootercollection.md

#### SpreadsheetHeaderFooterCollection class

Represents a collection of headers and footers in an Excel document.

This collection contains the items of `SpreadsheetHeaderFooter` type.

The SpreadsheetHeaderFooterCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| item |  |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |

### item property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootercollection/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### SpreadsheetHeaderFooterSection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection.md

#### SpreadsheetHeaderFooterSection class

Represents a header/footer section in an Excel document.

The SpreadsheetHeaderFooterSection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| header_footer | The parent header/footer of this SpreadsheetHeaderFooterSection. |
| image | The image of this SpreadsheetHeaderFooterSection. Returns None if the section has no image. |
| script | The script content of this SpreadsheetHeaderFooterSection. |
| section_type | The type of this SpreadsheetHeaderFooterSection. |

### header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/header_footer.md

#### header_footer property

The parent header/footer of this SpreadsheetHeaderFooterSection.

##### Definition:
```python
@property
def header_footer(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/image.md

#### image property

The image of this SpreadsheetHeaderFooterSection. Returns None if the section has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### script property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/script.md

#### script property

The script content of this SpreadsheetHeaderFooterSection.

##### Definition:
```python
@property
def script(self):
    ...
@script.setter
def script(self, value):
    ...
```

### section_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersection/section_type.md

#### section_type property

The type of this SpreadsheetHeaderFooterSection.

##### Definition:
```python
@property
def section_type(self):
    ...
```

### SpreadsheetHeaderFooterSectionCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectioncollection.md

#### SpreadsheetHeaderFooterSectionCollection class

Represents a collection of header/footer sections.

This collection contains the items of `SpreadsheetHeaderFooterSection` type.

The SpreadsheetHeaderFooterSectionCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| item |  |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |

### item property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectioncollection/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### SpreadsheetHeaderFooterSectionType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectiontype.md

#### SpreadsheetHeaderFooterSectionType class

The SpreadsheetHeaderFooterSectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LEFT | Left section. |
| CENTER | Center section. |
| RIGHT | Right section. |

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectiontype/center.md

#### CENTER field

Center section.

##### Value
`1`

### LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectiontype/left.md

#### LEFT field

Left section.

##### Value
`0`

### RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetheaderfootersectiontype/right.md

#### RIGHT field

Right section.

##### Value
`2`

### SpreadsheetImageFillFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat.md

#### SpreadsheetImageFillFormat class

Represents the image fill format settings in an Excel document.

The SpreadsheetImageFillFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_image | The background image. Returns None if the image is not set. |
| tile_as_texture | The image is tiled across the background when True; otherwise the image is stretched. |
| transparency | The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent). |

### background_image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/background_image.md

#### background_image property

The background image. Returns None if the image is not set.

##### Definition:
```python
@property
def background_image(self):
    ...
@background_image.setter
def background_image(self, value):
    ...
```

### tile_as_texture property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/tile_as_texture.md

#### tile_as_texture property

The image is tiled across the background when True; otherwise the image is stretched.

##### Definition:
```python
@property
def tile_as_texture(self):
    ...
@tile_as_texture.setter
def tile_as_texture(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetimagefillformat/transparency.md

#### transparency property

The transparency of the background image as a value from 0.0 (opaque) through 1.0 (fully transparent).

##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### SpreadsheetMsoDrawingType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype.md

#### SpreadsheetMsoDrawingType class

The SpreadsheetMsoDrawingType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| GROUP | Built-in drawing type. |
| LINE | Built-in drawing type. |
| RECTANGLE | Built-in drawing type. |
| OVAL | Built-in drawing type. |
| ARC | Built-in drawing type. |
| CHART | Built-in drawing type. |
| TEXT_BOX | Built-in drawing type. |
| BUTTON | Built-in drawing type. |
| PICTURE | Built-in drawing type. |
| POLYGON | Built-in drawing type. |
| CHECK_BOX | Built-in drawing type. |
| RADIO_BUTTON | Built-in drawing type. |
| LABEL | Built-in drawing type. |
| DIALOG_BOX | Built-in drawing type. |
| SPINNER | Built-in drawing type. |
| SCROLL_BAR | Built-in drawing type. |
| LIST_BOX | Built-in drawing type. |
| GROUP_BOX | Built-in drawing type. |
| COMBO_BOX | Built-in drawing type. |
| OLE_OBJECT | Built-in drawing type. |
| COMMENT | Built-in drawing type. |
| UNKNOWN | Built-in drawing type. |
| CELLS_DRAWING | Built-in drawing type. |
| SLICER | Built-in drawing type. |
| WEB_EXTENSION | Built-in drawing type. |
| SMART_ART | Built-in drawing type. |
| CUSTOM_XML | Built-in drawing type. |
| TIMELINE | Built-in drawing type. |
| MODEL_3D | Built-in drawing type. |

### ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/arc.md

#### ARC field

Built-in drawing type.

##### Value
`4`

### BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/button.md

#### BUTTON field

Built-in drawing type.

##### Value
`7`

### CELLS_DRAWING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/cells_drawing.md

#### CELLS_DRAWING field

Built-in drawing type.

##### Value
`30`

### CHART field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/chart.md

#### CHART field

Built-in drawing type.

##### Value
`5`

### CHECK_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/check_box.md

#### CHECK_BOX field

Built-in drawing type.

##### Value
`11`

### COMBO_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/combo_box.md

#### COMBO_BOX field

Built-in drawing type.

##### Value
`20`

### COMMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/comment.md

#### COMMENT field

Built-in drawing type.

##### Value
`25`

### CUSTOM_XML field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/custom_xml.md

#### CUSTOM_XML field

Built-in drawing type.

##### Value
`34`

### DIALOG_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/dialog_box.md

#### DIALOG_BOX field

Built-in drawing type.

##### Value
`15`

### GROUP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/group.md

#### GROUP field

Built-in drawing type.

##### Value
`0`

### GROUP_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/group_box.md

#### GROUP_BOX field

Built-in drawing type.

##### Value
`19`

### LABEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/label.md

#### LABEL field

Built-in drawing type.

##### Value
`14`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/line.md

#### LINE field

Built-in drawing type.

##### Value
`1`

### LIST_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/list_box.md

#### LIST_BOX field

Built-in drawing type.

##### Value
`18`

### MODEL_3D field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/model_3d.md

#### MODEL_3D field

Built-in drawing type.

##### Value
`36`

### OLE_OBJECT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/ole_object.md

#### OLE_OBJECT field

Built-in drawing type.

##### Value
`24`

### OVAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/oval.md

#### OVAL field

Built-in drawing type.

##### Value
`3`

### PICTURE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/picture.md

#### PICTURE field

Built-in drawing type.

##### Value
`8`

### POLYGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/polygon.md

#### POLYGON field

Built-in drawing type.

##### Value
`9`

### RADIO_BUTTON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/radio_button.md

#### RADIO_BUTTON field

Built-in drawing type.

##### Value
`12`

### RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/rectangle.md

#### RECTANGLE field

Built-in drawing type.

##### Value
`2`

### SCROLL_BAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/scroll_bar.md

#### SCROLL_BAR field

Built-in drawing type.

##### Value
`17`

### SLICER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/slicer.md

#### SLICER field

Built-in drawing type.

##### Value
`31`

### SMART_ART field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/smart_art.md

#### SMART_ART field

Built-in drawing type.

##### Value
`33`

### SPINNER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/spinner.md

#### SPINNER field

Built-in drawing type.

##### Value
`16`

### TEXT_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/text_box.md

#### TEXT_BOX field

Built-in drawing type.

##### Value
`6`

### TIMELINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/timeline.md

#### TIMELINE field

Built-in drawing type.

##### Value
`35`

### UNKNOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/unknown.md

#### UNKNOWN field

Built-in drawing type.

##### Value
`29`

### WEB_EXTENSION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetmsodrawingtype/web_extension.md

#### WEB_EXTENSION field

Built-in drawing type.

##### Value
`32`

### SpreadsheetPageSetup class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup.md

#### SpreadsheetPageSetup class

Represents printing page properties for a worksheet.

The SpreadsheetPageSetup type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| bottom_margin | The size of the bottom margin in points. |
| height | The height of a printing page in points. |
| left_margin | The size of the left margin in points. |
| right_margin | The size of the right margin in points. |
| top_margin | The size of the top margin in points. |
| width | The width of a printing page in points. |

### bottom_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/bottom_margin.md

#### bottom_margin property

The size of the bottom margin in points.

##### Definition:
```python
@property
def bottom_margin(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/height.md

#### height property

The height of a printing page in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/left_margin.md

#### left_margin property

The size of the left margin in points.

##### Definition:
```python
@property
def left_margin(self):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/right_margin.md

#### right_margin property

The size of the right margin in points.

##### Definition:
```python
@property
def right_margin(self):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/top_margin.md

#### top_margin property

The size of the top margin in points.

##### Definition:
```python
@property
def top_margin(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetpagesetup/width.md

#### width property

The width of a printing page in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### SpreadsheetShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape.md

#### SpreadsheetShape class

Represents a drawing shape in an Excel document.

The SpreadsheetShape type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text associated with this `SpreadsheetShape`. |
| auto_shape_type | The auto shape type. |
| formatted_text_fragments | The collection of formatted text fragments of this `SpreadsheetShape`. |
| height | The height of this SpreadsheetShape in points. |
| hyperlink | The hyperlink associated with this SpreadsheetShape. |
| id | The identifier of this SpreadsheetShape. |
| image | The image of this SpreadsheetShape, or None if the shape has no image. |
| image_fill_format | The image fill format settings of this SpreadsheetShape. |
| is_word_art | The property indicates whether the SpreadsheetShape is a WordArt object. |
| mso_drawing_type | The mso drawing type. |
| name | The name of this SpreadsheetShape. |
| rotate_angle | The rotate angle of this SpreadsheetShape in degrees. |
| text | The text of this SpreadsheetShape. |
| width | The width of this `SpreadsheetShape` in points. |
| worksheet | The parent worksheet of this SpreadsheetShape. |
| x | The horizontal offset of this SpreadsheetShape from worksheet left border in points. The x-coordinate of this SpreadsheetShape. |
| y | The y-coordinate of this SpreadsheetShape, representing the vertical offset from the worksheet top border in points. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/alternative_text.md

#### alternative_text property

The descriptive (alternative) text associated with this `SpreadsheetShape`.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### auto_shape_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/auto_shape_type.md

#### auto_shape_type property

The auto shape type.

##### Definition:
```python
@property
def auto_shape_type(self):
    ...
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `SpreadsheetShape`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/height.md

#### height property

The height of this SpreadsheetShape in points.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### hyperlink property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/hyperlink.md

#### hyperlink property

The hyperlink associated with this SpreadsheetShape.

##### Definition:
```python
@property
def hyperlink(self):
    ...
@hyperlink.setter
def hyperlink(self, value):
    ...
```

### id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/id.md

#### id property

The identifier of this SpreadsheetShape.

##### Definition:
```python
@property
def id(self):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/image.md

#### image property

The image of this SpreadsheetShape, or None if the shape has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### image_fill_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/image_fill_format.md

#### image_fill_format property

The image fill format settings of this SpreadsheetShape.

##### Definition:
```python
@property
def image_fill_format(self):
    ...
```

### is_word_art property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/is_word_art.md

#### is_word_art property

The property indicates whether the SpreadsheetShape is a WordArt object.

True if the shape is a WordArt object; otherwise, False.

##### Definition:
```python
@property
def is_word_art(self):
    ...
```

### mso_drawing_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/mso_drawing_type.md

#### mso_drawing_type property

The mso drawing type.

##### Definition:
```python
@property
def mso_drawing_type(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/name.md

#### name property

The name of this SpreadsheetShape.

##### Definition:
```python
@property
def name(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetShape in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/text.md

#### text property

The text of this SpreadsheetShape.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/width.md

#### width property

The width of this `SpreadsheetShape` in points.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### worksheet property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/worksheet.md

#### worksheet property

The parent worksheet of this SpreadsheetShape.

##### Definition:
```python
@property
def worksheet(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/x.md

#### x property

The horizontal offset of this SpreadsheetShape from worksheet left border in points. The x-coordinate of this SpreadsheetShape.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshape/y.md

#### y property

The y-coordinate of this SpreadsheetShape, representing the vertical offset from the worksheet top border in points.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### SpreadsheetShapeCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapecollection.md

#### SpreadsheetShapeCollection class

Represents a collection of drawing shapes in an Excel document.

This collection contains the items of `SpreadsheetShape` type.

The SpreadsheetShapeCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### SpreadsheetShapeFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment.md

#### SpreadsheetShapeFormattedTextFragment class

Represents a fragment of formatted text in Excel document shape.

The SpreadsheetShapeFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### SpreadsheetShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragmentcollection.md

#### SpreadsheetShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document text shape.

This collection contains the items of `SpreadsheetShapeFormattedTextFragment` type.

The SpreadsheetShapeFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetshapeformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### SpreadsheetTextEffectFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment.md

#### SpreadsheetTextEffectFormattedTextFragment class

Represents a fragment of formatted text in Excel document WordArt shape.

The SpreadsheetTextEffectFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### SpreadsheetTextEffectFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragmentcollection.md

#### SpreadsheetTextEffectFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in an Excel document WordArt shape.

This collection contains the items of `SpreadsheetTextEffectFormattedTextFragment` type.

The SpreadsheetTextEffectFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheettexteffectformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### SpreadsheetWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage.md

#### SpreadsheetWatermarkableImage class

Represents an image inside an Excel document.

The SpreadsheetWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new SpreadsheetWatermarkableImage instance using the provided image data. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

with open("test.png", "rb") as f:
    img = gwc_xls.SpreadsheetWatermarkableImage(f.read())
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/__init__.md

#### __init__

Initializes a new SpreadsheetWatermarkableImage instance using the provided image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | `list[int]` | The array of unsigned bytes from which to create the SpreadsheetWatermarkableImage. |

##### Example

```python
import groupdocs.watermark.contents.spreadsheet as gwc_xls

with open("test.png", "rb") as f:
    image = gwc_xls.SpreadsheetWatermarkableImage(f.read())
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### SpreadsheetWorksheet class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet.md

#### SpreadsheetWorksheet class

Represents an Excel document worksheet.

The SpreadsheetWorksheet type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| get_column_width | Returns the width of the specified column in points. |
| get_column_width_int32 |  |
| get_column_width_px | Gets the width of the specified column in pixels. |
| get_column_width_px_int32 |  |
| get_row_height | Returns the height of the specified row in points. |
| get_row_height_int32 |  |
| get_row_height_px | Returns the height of the specified row in pixels. |
| get_row_height_px_int32 |  |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| attachments | The collection of all attachments of this `SpreadsheetWorksheet`. |
| background_image | The background image of this SpreadsheetWorksheet. Returns None if the worksheet has no background image. |
| charts | The collection of all charts of this SpreadsheetWorksheet. |
| content_area_height | The height of the content area in points. |
| content_area_height_px | The height of the content area in pixels. |
| content_area_width | The width of the content area in points. |
| content_area_width_px | The width of the content area in pixels. |
| headers_footers | The collection of worksheet headers and footers. |
| page_setup | The printing page setup for the worksheet. |
| shapes | The collection of all shapes of this SpreadsheetWorksheet. |

### attachments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/attachments.md

#### attachments property

The collection of all attachments of this `SpreadsheetWorksheet`.

##### Definition:
```python
@property
def attachments(self):
    ...
```

### background_image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/background_image.md

#### background_image property

The background image of this SpreadsheetWorksheet. Returns None if the worksheet has no background image.

##### Definition:
```python
@property
def background_image(self):
    ...
@background_image.setter
def background_image(self, value):
    ...
```

### charts property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/charts.md

#### charts property

The collection of all charts of this SpreadsheetWorksheet.

##### Definition:
```python
@property
def charts(self):
    ...
```

### content_area_height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/content_area_height.md

#### content_area_height property

The height of the content area in points.

##### Definition:
```python
@property
def content_area_height(self):
    ...
```

### content_area_height_px property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/content_area_height_px.md

#### content_area_height_px property

The height of the content area in pixels.

##### Definition:
```python
@property
def content_area_height_px(self):
    ...
```

### content_area_width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/content_area_width.md

#### content_area_width property

The width of the content area in points.

##### Definition:
```python
@property
def content_area_width(self):
    ...
```

### content_area_width_px property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/content_area_width_px.md

#### content_area_width_px property

The width of the content area in pixels.

##### Definition:
```python
@property
def content_area_width_px(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_column_width method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_column_width.md

#### get_column_width

Returns the width of the specified column in points.

```python
def get_column_width(self, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| column | `int` | The column index. |

**Returns:** float: The width of the column in points.

##### Example

```python
    import groupdocs.watermark as gw
    import groupdocs.watermark.contents.spreadsheet as gwc_xls

    load_options = gw.SpreadsheetLoadOptions()
    with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
        content = watermarker.get_content(gwc_xls.SpreadsheetContent)
        width = content.worksheets[0].get_column_width(0)
        print(width)
    ```

### get_column_width_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_column_width_int32.md

#### get_column_width_int32

```python
def get_column_width_int32(self):
    ...
```

### get_column_width_px method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_column_width_px.md

#### get_column_width_px

Gets the width of the specified column in pixels.

```python
def get_column_width_px(self, column):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| column | `int` | The column index. |

**Returns:** int: The width of the column in pixels.

### get_column_width_px_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_column_width_px_int32.md

#### get_column_width_px_int32

```python
def get_column_width_px_int32(self):
    ...
```

### get_row_height method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_row_height.md

#### get_row_height

Returns the height of the specified row in points.

```python
def get_row_height(self, row):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row | `int` | The row index. |

**Returns:** float: The height of the row in points.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    height = content.worksheets[0].get_row_height(0)
    print(height)
```

### get_row_height_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_row_height_int32.md

#### get_row_height_int32

```python
def get_row_height_int32(self):
    ...
```

### get_row_height_px method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_row_height_px.md

#### get_row_height_px

Returns the height of the specified row in pixels.

```python
def get_row_height_px(self, row):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| row | `int` | The row index. |

**Returns:** int: The height of the row in pixels.

### get_row_height_px_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/get_row_height_px_int32.md

#### get_row_height_px_int32

```python
def get_row_height_px_int32(self):
    ...
```

### headers_footers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/headers_footers.md

#### headers_footers property

The collection of worksheet headers and footers.

##### Definition:
```python
@property
def headers_footers(self):
    ...
```

### page_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/page_setup.md

#### page_setup property

The printing page setup for the worksheet.

##### Definition:
```python
@property
def page_setup(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheet/shapes.md

#### shapes property

The collection of all shapes of this SpreadsheetWorksheet.

##### Definition:
```python
@property
def shapes(self):
    ...
```

### SpreadsheetWorksheetCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.spreadsheet/spreadsheetworksheetcollection.md

#### SpreadsheetWorksheetCollection class

Represents a collection of worksheets in an Excel document.

This collection contains the items of `SpreadsheetWorksheet` type.

The SpreadsheetWorksheetCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### groupdocs.watermark.contents.word_processing
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing.md

Types under `groupdocs.watermark.contents.word_processing`.

##### Classes
| Class | Description |
| :- | :- |
| `WordProcessingContent` | Represents a Word document (doc, docx, etc.) where a watermark can be placed. |
| `WordProcessingHeaderFooter` | Represents a header/footer in a Word document. |
| `WordProcessingHeaderFooterCollection` | Represents a collection of headers and footers in a Word document. |
| `WordProcessingPageSetup` | Represents printing page properties for a section of a Word document. |
| `WordProcessingSection` | Represents a Word document section. |
| `WordProcessingShape` | Represents a drawing shape in a Word document. |
| `WordProcessingTextFormattedTextFragment` | Represents a fragment of formatted text in a Word document. |
| `WordProcessingWatermarkableImage` | Represents an image inside a Word document. |
| `WordProcessingWordArtShapeFormattedTextFragment` | Represents a fragment of formatted text in a WordArt shape. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `WordProcessingFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document. |
| `WordProcessingHorizontalAlignment` |  |
| `WordProcessingProtectionType` |  |
| `WordProcessingRelativeHorizontalPosition` |  |
| `WordProcessingRelativeVerticalPosition` |  |
| `WordProcessingSectionCollection` | Represents a collection of sections in a Word document. |
| `WordProcessingShapeCollection` | Represents a collection of shapes in a Word document. |
| `WordProcessingShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document shape. |
| `WordProcessingShapeType` |  |
| `WordProcessingTextFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document main text. |
| `WordProcessingVerticalAlignment` |  |
| `WordProcessingWordArtShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document WordArt shape. |

### WordProcessingContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent.md

#### WordProcessingContent class

Represents a Word document (doc, docx, etc.) where a watermark can be placed.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+word+processing+documents
- https://docs.groupdocs.com/display/watermarknet/Existing+objects+in+word+processing+document
- https://docs.groupdocs.com/display/watermarknet/Locking+watermark+in+word+processing+document
- https://docs.groupdocs.com/display/watermarknet/Protecting+word+processing+documents
- https://docs.groupdocs.com/display/watermarknet/Watermarks+in+word+processing+document

The WordProcessingContent type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| decrypt | Decrypts the document. |
| encrypt | Encrypts the document. |
| encrypt_file |  |
| encrypt_string |  |
| protect | Protects the document from changes and sets a protection password. |
| protect_file |  |
| protect_string |  |
| protect_word_processing_protection_type |  |
| unprotect | Removes protection from the document regardless of the password. |
| dispose | Disposes the current instance. (inherited from `Content`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| page_count | The number of pages in the document. |
| sections | The collection of all sections of this `WordProcessingContent`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    # modify the document, e.g., remove protection or edit shapes
    content.unprotect()
    watermarker.save("document.docx")
```

### decrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/decrypt.md

#### decrypt

Decrypts the document.

```python
def decrypt(self):
    ...
```

### encrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/encrypt.md

#### encrypt

Encrypts the document.

```python
def encrypt(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password that will be required to open the document. |

### encrypt_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/encrypt_file.md

#### encrypt_file

```python
def encrypt_file(self):
    ...
```

### encrypt_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/encrypt_string.md

#### encrypt_string

```python
def encrypt_string(self):
    ...
```

### page_count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/page_count.md

#### page_count property

The number of pages in the document.

##### Definition:
```python
@property
def page_count(self):
    ...
```

### protect method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/protect.md

#### protect

Protects the document from changes and sets a protection password.

To have the content of the document editable use appropriate method of adding watermark with `WordProcessingLockType.allow_only_form_fields` or `WordProcessingLockType.read_only_with_editable_content` parameter.

```python
def protect(self, protection_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| protection_type | `WordProcessingProtectionType` | Specifies the protection type for the document. |
| password | `str` | The password to protect the document with. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    content.protect(gwc_wp.WordProcessingProtectionType.READ_ONLY, "7654321")
    watermarker.save("document.docx")
```

### protect_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/protect_file.md

#### protect_file

```python
def protect_file(self):
    ...
```

### protect_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/protect_string.md

#### protect_string

```python
def protect_string(self):
    ...
```

### protect_word_processing_protection_type method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/protect_word_processing_protection_type.md

#### protect_word_processing_protection_type

```python
def protect_word_processing_protection_type(self):
    ...
```

### sections property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/sections.md

#### sections property

The collection of all sections of this `WordProcessingContent`.

##### Definition:
```python
@property
def sections(self):
    ...
```

### unprotect method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingcontent/unprotect.md

#### unprotect

Removes protection from the document regardless of the password.

```python
def unprotect(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    content.unprotect()
    watermarker.save("document.docx")
```

### WordProcessingFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingformattedtextfragmentcollection.md

#### WordProcessingFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document.

The WordProcessingFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### WordProcessingHeaderFooter class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfooter.md

#### WordProcessingHeaderFooter class

Represents a header/footer in a Word document.

The WordProcessingHeaderFooter type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| header_footer_type | The type of this WordProcessingHeaderFooter. |
| is_linked_to_previous | The header/footer is linked to the corresponding header/footer in the previous section. |
| section | The parent section of this `WordProcessingHeaderFooter`. |

### header_footer_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfooter/header_footer_type.md

#### header_footer_type property

The type of this WordProcessingHeaderFooter.

##### Definition:
```python
@property
def header_footer_type(self):
    ...
```

### is_linked_to_previous property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfooter/is_linked_to_previous.md

#### is_linked_to_previous property

The header/footer is linked to the corresponding header/footer in the previous section.

Default is True. Note that when you link a header or footer, its contents are cleared.

##### Definition:
```python
@property
def is_linked_to_previous(self):
    ...
@is_linked_to_previous.setter
def is_linked_to_previous(self, value):
    ...
```

### section property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfooter/section.md

#### section property

The parent section of this `WordProcessingHeaderFooter`.

##### Definition:
```python
@property
def section(self):
    ...
```

### WordProcessingHeaderFooterCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfootercollection.md

#### WordProcessingHeaderFooterCollection class

Represents a collection of headers and footers in a Word document.

This collection contains the items of `WordProcessingHeaderFooter` type.

The WordProcessingHeaderFooterCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| link_to_previous | Links or unlinks all headers and footers to the corresponding headers and footers in the previous section. |
| link_to_previous_boolean |  |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| item |  |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |

### item property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfootercollection/item.md

##### Definition:
```python
@property
def item(self):
    ...
```

### link_to_previous method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfootercollection/link_to_previous.md

#### link_to_previous

Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.

```python
def link_to_previous(self, is_link_to_previous):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| is_link_to_previous | `bool` | True to link the headers and footers to the previous section; False to unlink them. |

##### Example

```python
for i in range(1, content.sections.count):
    content.sections[i].headers_footers.link_to_previous(True)
```

### link_to_previous_boolean method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingheaderfootercollection/link_to_previous_boolean.md

#### link_to_previous_boolean

```python
def link_to_previous_boolean(self):
    ...
```

### WordProcessingHorizontalAlignment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment.md

#### WordProcessingHorizontalAlignment class

The WordProcessingHorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Object is explicitly positioned using its x-coordinate. |
| LEFT | Specifies that the object is left aligned to the horizontal alignment base. |
| CENTER | Specifies that the object is centered with respect to the horizontal alignment base. |
| RIGHT | Specifies that the object is right aligned to the horizontal alignment base. |
| INSIDE | Specifies that the object is inside of the horizontal alignment base. |
| OUTSIDE | Specifies that the object is outside of the horizontal alignment base. |

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/center.md

#### CENTER field

Specifies that the object is centered with respect to the horizontal alignment base.

##### Value
`2`

### INSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/inside.md

#### INSIDE field

Specifies that the object is inside of the horizontal alignment base.

##### Value
`4`

### LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/left.md

#### LEFT field

Specifies that the object is left aligned to the horizontal alignment base.

##### Value
`1`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/none.md

#### NONE field

Object is explicitly positioned using its x-coordinate.

##### Value
`0`

### OUTSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/outside.md

#### OUTSIDE field

Specifies that the object is outside of the horizontal alignment base.

##### Value
`5`

### RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessinghorizontalalignment/right.md

#### RIGHT field

Specifies that the object is right aligned to the horizontal alignment base.

##### Value
`3`

### WordProcessingPageSetup class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup.md

#### WordProcessingPageSetup class

Represents printing page properties for a section of a Word document.

The WordProcessingPageSetup type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| bottom_margin | The size of the bottom margin in points. |
| different_first_page_header_footer | The property indicating whether a different header/footer is used for the first page. |
| height | The height of a printing page in points. |
| left_margin | The size of the left margin in points. |
| odd_and_even_pages_header_footer | The property indicates whether different headers/footers are used for odd-numbered and even-numbered pages. |
| right_margin | The size of the right margin in points. |
| top_margin | The size of the top margin in points. |
| width | The width of a printing page in points. |

### bottom_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/bottom_margin.md

#### bottom_margin property

The size of the bottom margin in points.

##### Definition:
```python
@property
def bottom_margin(self):
    ...
```

### different_first_page_header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/different_first_page_header_footer.md

#### different_first_page_header_footer property

The property indicating whether a different header/footer is used for the first page.

True if a different header/footer is used for the first page; otherwise, False.

##### Definition:
```python
@property
def different_first_page_header_footer(self):
    ...
@different_first_page_header_footer.setter
def different_first_page_header_footer(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/height.md

#### height property

The height of a printing page in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/left_margin.md

#### left_margin property

The size of the left margin in points.

##### Definition:
```python
@property
def left_margin(self):
    ...
```

### odd_and_even_pages_header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/odd_and_even_pages_header_footer.md

#### odd_and_even_pages_header_footer property

The property indicates whether different headers/footers are used for odd-numbered and even-numbered pages.

Note, changing this property affects all sections in the content.

##### Definition:
```python
@property
def odd_and_even_pages_header_footer(self):
    ...
@odd_and_even_pages_header_footer.setter
def odd_and_even_pages_header_footer(self, value):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/right_margin.md

#### right_margin property

The size of the right margin in points.

##### Definition:
```python
@property
def right_margin(self):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/top_margin.md

#### top_margin property

The size of the top margin in points.

##### Definition:
```python
@property
def top_margin(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingpagesetup/width.md

#### width property

The width of a printing page in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### WordProcessingProtectionType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingprotectiontype.md

#### WordProcessingProtectionType class

The WordProcessingProtectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ONLY_REVISIONS | User can only add revision marks to the document. |
| ALLOW_ONLY_COMMENTS | User can only modify comments in the document. |
| ALLOW_ONLY_FORM_FIELDS | User can only enter data in the form fields in the document. |
| READ_ONLY | No changes are allowed to the document. |

### ALLOW_ONLY_COMMENTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingprotectiontype/allow_only_comments.md

#### ALLOW_ONLY_COMMENTS field

User can only modify comments in the document.

##### Value
`1`

### ALLOW_ONLY_FORM_FIELDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingprotectiontype/allow_only_form_fields.md

#### ALLOW_ONLY_FORM_FIELDS field

User can only enter data in the form fields in the document.

##### Value
`2`

### ALLOW_ONLY_REVISIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingprotectiontype/allow_only_revisions.md

#### ALLOW_ONLY_REVISIONS field

User can only add revision marks to the document.

##### Value
`0`

### READ_ONLY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingprotectiontype/read_only.md

#### READ_ONLY field

No changes are allowed to the document.

##### Value
`3`

### WordProcessingRelativeHorizontalPosition class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition.md

#### WordProcessingRelativeHorizontalPosition class

The WordProcessingRelativeHorizontalPosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MARGIN | Specifies that the horizontal positioning is relative to the page margins. |
| PAGE | The object is positioned relative to the left edge of the page. |
| COLUMN | The object is positioned relative to the left side of the column. |
| CHARACTER | The object is positioned relative to the left side of the paragraph. |
| LEFT_MARGIN | Specifies that the horizontal positioning is relative to the left margin of the page. |
| RIGHT_MARGIN | Specifies that the horizontal positioning is relative to the right margin of the page. |
| INSIDE_MARGIN | Specifies that the horizontal positioning is relative to the inside margin of the current page (the left margin on odd pages, right on even pages). |
| OUTSIDE_MARGIN | Specifies that the horizontal positioning is relative to the outside margin of the current page (the right margin on odd pages, left on even pages). |

### CHARACTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/character.md

#### CHARACTER field

The object is positioned relative to the left side of the paragraph.

##### Value
`3`

### COLUMN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/column.md

#### COLUMN field

The object is positioned relative to the left side of the column.

##### Value
`2`

### INSIDE_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/inside_margin.md

#### INSIDE_MARGIN field

Specifies that the horizontal positioning is relative to the inside margin of the current page (the left margin on odd pages, right on even pages).

##### Value
`6`

### LEFT_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/left_margin.md

#### LEFT_MARGIN field

Specifies that the horizontal positioning is relative to the left margin of the page.

##### Value
`4`

### MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/margin.md

#### MARGIN field

Specifies that the horizontal positioning is relative to the page margins.

##### Value
`0`

### OUTSIDE_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/outside_margin.md

#### OUTSIDE_MARGIN field

Specifies that the horizontal positioning is relative to the outside margin of the current page (the right margin on odd pages, left on even pages).

##### Value
`7`

### PAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/page.md

#### PAGE field

The object is positioned relative to the left edge of the page.

##### Value
`1`

### RIGHT_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativehorizontalposition/right_margin.md

#### RIGHT_MARGIN field

Specifies that the horizontal positioning is relative to the right margin of the page.

##### Value
`5`

### WordProcessingRelativeVerticalPosition class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition.md

#### WordProcessingRelativeVerticalPosition class

The WordProcessingRelativeVerticalPosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MARGIN | Specifies that the vertical positioning is relative to the page margins. |
| PAGE | The object is positioned relative to the top edge of the page. |
| PARAGRAPH | The object is positioned relative to the top of the paragraph that contains the anchor. |
| LINE | Undocumented feature. |
| TOP_MARGIN | Specifies that the vertical positioning is relative to the top margin of the current page. |
| BOTTOM_MARGIN | Specifies that the vertical positioning is relative to the bottom margin of the current page. |
| INSIDE_MARGIN | Specifies that the vertical positioning is relative to the inside margin of the current page. |
| OUTSIDE_MARGIN | Specifies that the vertical positioning is relative to the outside margin of the current page. |

### BOTTOM_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/bottom_margin.md

#### BOTTOM_MARGIN field

Specifies that the vertical positioning is relative to the bottom margin of the current page.

##### Value
`5`

### INSIDE_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/inside_margin.md

#### INSIDE_MARGIN field

Specifies that the vertical positioning is relative to the inside margin of the current page.

##### Value
`6`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/line.md

#### LINE field

Undocumented feature.

##### Value
`3`

### MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/margin.md

#### MARGIN field

Specifies that the vertical positioning is relative to the page margins.

##### Value
`0`

### OUTSIDE_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/outside_margin.md

#### OUTSIDE_MARGIN field

Specifies that the vertical positioning is relative to the outside margin of the current page.

##### Value
`7`

### PAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/page.md

#### PAGE field

The object is positioned relative to the top edge of the page.

##### Value
`1`

### PARAGRAPH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/paragraph.md

#### PARAGRAPH field

The object is positioned relative to the top of the paragraph that contains the anchor.

##### Value
`2`

### TOP_MARGIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingrelativeverticalposition/top_margin.md

#### TOP_MARGIN field

Specifies that the vertical positioning is relative to the top margin of the current page.

##### Value
`4`

### WordProcessingSection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingsection.md

#### WordProcessingSection class

Represents a Word document section.

The WordProcessingSection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| headers_footers | The collection of all headers and footers of this `WordProcessingSection`. |
| page_setup | The printing page setup for this `WordProcessingSection`. |
| shapes | The collection of all shapes contained in this WordProcessingSection. |

### headers_footers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingsection/headers_footers.md

#### headers_footers property

The collection of all headers and footers of this `WordProcessingSection`.

##### Definition:
```python
@property
def headers_footers(self):
    ...
```

### page_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingsection/page_setup.md

#### page_setup property

The printing page setup for this `WordProcessingSection`.

##### Definition:
```python
@property
def page_setup(self):
    ...
```

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingsection/shapes.md

#### shapes property

The collection of all shapes contained in this WordProcessingSection.

##### Definition:
```python
@property
def shapes(self):
    ...
```

### WordProcessingSectionCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingsectioncollection.md

#### WordProcessingSectionCollection class

Represents a collection of sections in a Word document.

This collection contains the items of `WordProcessingSection` type.

The WordProcessingSectionCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| contains |  (inherited from `ReadOnlyListBase`) |
| get_enumerator |  (inherited from `ReadOnlyListBase`) |
| index_of |  (inherited from `ReadOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| count |  (inherited from `ReadOnlyListBase`) |
| is_read_only |  (inherited from `ReadOnlyListBase`) |
| item |  (inherited from `ReadOnlyListBase`) |

### WordProcessingShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape.md

#### WordProcessingShape class

Represents a drawing shape in a Word document.

The WordProcessingShape type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text associated with this `WordProcessingShape`. |
| behind_text | The value indicating whether the shape is behind the text. |
| formatted_text_fragments | The collection of formatted text fragments of this `WordProcessingShape`. |
| header_footer | The parent header/footer of this `WordProcessingShape`. |
| height | The height of this `WordProcessingShape` in points. |
| horizontal_alignment | The horizontal alignment of the shape, specifying how it is positioned horizontally. |
| hyperlink | The hyperlink associated with this `WordProcessingShape`. |
| image | The image of this `WordProcessingShape`. Returns `None` if the shape has no image. |
| is_word_art | The property indicates whether the shape is a WordArt object. |
| name | The name of this WordProcessingShape. |
| relative_horizontal_position | The relative horizontal position of the shape, specifying how the shape is positioned horizontally. |
| relative_vertical_position | The relative vertical position value specifying where the shape is positioned vertically. |
| rotate_angle | The rotate angle of this `WordProcessingShape` in degrees. |
| section | The parent section of this `WordProcessingShape`. |
| shape_type | The shape type. |
| text | The text of this `WordProcessingShape`. |
| vertical_alignment | The vertical alignment of the shape, specifying how it is positioned vertically. |
| width | The width of this `WordProcessingShape` in points. |
| x | The horizontal offset of this WordProcessingShape from the page left border in points. |
| y | The y-coordinate of this `WordProcessingShape`, representing the vertical offset from the page top border in points. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/alternative_text.md

#### alternative_text property

The descriptive (alternative) text associated with this `WordProcessingShape`.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### behind_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/behind_text.md

#### behind_text property

The value indicating whether the shape is behind the text.

True if the shape is behind the text; otherwise, False.

##### Definition:
```python
@property
def behind_text(self):
    ...
@behind_text.setter
def behind_text(self, value):
    ...
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `WordProcessingShape`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/header_footer.md

#### header_footer property

The parent header/footer of this `WordProcessingShape`.

##### Definition:
```python
@property
def header_footer(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/height.md

#### height property

The height of this `WordProcessingShape` in points.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/horizontal_alignment.md

#### horizontal_alignment property

The horizontal alignment of the shape, specifying how it is positioned horizontally.

##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
```

### hyperlink property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/hyperlink.md

#### hyperlink property

The hyperlink associated with this `WordProcessingShape`.

##### Definition:
```python
@property
def hyperlink(self):
    ...
@hyperlink.setter
def hyperlink(self, value):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/image.md

#### image property

The image of this `WordProcessingShape`. Returns `None` if the shape has no image.

##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### is_word_art property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/is_word_art.md

#### is_word_art property

The property indicates whether the shape is a WordArt object.

##### Definition:
```python
@property
def is_word_art(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/name.md

#### name property

The name of this WordProcessingShape.

##### Definition:
```python
@property
def name(self):
    ...
```

### relative_horizontal_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/relative_horizontal_position.md

#### relative_horizontal_position property

The relative horizontal position of the shape, specifying how the shape is positioned horizontally.

##### Definition:
```python
@property
def relative_horizontal_position(self):
    ...
```

### relative_vertical_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/relative_vertical_position.md

#### relative_vertical_position property

The relative vertical position value specifying where the shape is positioned vertically.

##### Definition:
```python
@property
def relative_vertical_position(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/rotate_angle.md

#### rotate_angle property

The rotate angle of this `WordProcessingShape` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### section property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/section.md

#### section property

The parent section of this `WordProcessingShape`.

##### Definition:
```python
@property
def section(self):
    ...
```

### shape_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/shape_type.md

#### shape_type property

The shape type.

##### Definition:
```python
@property
def shape_type(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/text.md

#### text property

The text of this `WordProcessingShape`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/vertical_alignment.md

#### vertical_alignment property

The vertical alignment of the shape, specifying how it is positioned vertically.

##### Definition:
```python
@property
def vertical_alignment(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/width.md

#### width property

The width of this `WordProcessingShape` in points.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/x.md

#### x property

The horizontal offset of this WordProcessingShape from the page left border in points.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshape/y.md

#### y property

The y-coordinate of this `WordProcessingShape`, representing the vertical offset from the page top border in points.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### WordProcessingShapeCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapecollection.md

#### WordProcessingShapeCollection class

Represents a collection of shapes in a Word document.

This collection contains the items of `WordProcessingShape` type.

The WordProcessingShapeCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### WordProcessingShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapeformattedtextfragmentcollection.md

#### WordProcessingShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document shape.

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

The WordProcessingShapeFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### WordProcessingShapeType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype.md

#### WordProcessingShapeType class

The WordProcessingShapeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NON_PRIMITIVE | Built-in shape type. |
| RECTANGLE | Built-in shape type. |
| ROUND_RECTANGLE | Built-in shape type. |
| ELLIPSE | Built-in shape type. |
| DIAMOND | Built-in shape type. |
| TRIANGLE | Built-in shape type. |
| RIGHT_TRIANGLE | Built-in shape type. |
| PARALLELOGRAM | Built-in shape type. |
| TRAPEZOID | Built-in shape type. |
| HEXAGON | Built-in shape type. |
| OCTAGON | Built-in shape type. |
| PLUS | Built-in shape type. |
| STAR | Built-in shape type. |
| ARROW | Built-in shape type. |
| THICK_ARROW | Built-in shape type. |
| HOME_PLATE | Built-in shape type. |
| CUBE | Built-in shape type. |
| BALLOON | Built-in shape type. |
| SEAL | Built-in shape type. |
| ARC | Built-in shape type. |
| LINE | Built-in shape type. |
| PLAQUE | Built-in shape type. |
| CAN | Built-in shape type. |
| DONUT | Built-in shape type. |
| TEXT_SIMPLE | Built-in shape type. |
| TEXT_OCTAGON | Built-in shape type. |
| TEXT_HEXAGON | Built-in shape type. |
| TEXT_CURVE | Built-in shape type. |
| TEXT_WAVE | Built-in shape type. |
| TEXT_RING | Built-in shape type. |
| TEXT_ON_CURVE | Built-in shape type. |
| TEXT_ON_RING | Built-in shape type. |
| STRAIGHT_CONNECTOR1 | Built-in shape type. |
| BENT_CONNECTOR2 | Built-in shape type. |
| BENT_CONNECTOR3 | Built-in shape type. |
| BENT_CONNECTOR4 | Built-in shape type. |
| BENT_CONNECTOR5 | Built-in shape type. |
| CURVED_CONNECTOR2 | Built-in shape type. |
| CURVED_CONNECTOR3 | Built-in shape type. |
| CURVED_CONNECTOR4 | Built-in shape type. |
| CURVED_CONNECTOR5 | Built-in shape type. |
| CALLOUT1 | Built-in shape type. |
| CALLOUT2 | Built-in shape type. |
| CALLOUT3 | Built-in shape type. |
| ACCENT_CALLOUT1 | Built-in shape type. |
| ACCENT_CALLOUT2 | Built-in shape type. |
| ACCENT_CALLOUT3 | Built-in shape type. |
| BORDER_CALLOUT1 | Built-in shape type. |
| BORDER_CALLOUT2 | Built-in shape type. |
| BORDER_CALLOUT3 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT1 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT2 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT3 | Built-in shape type. |
| RIBBON | Built-in shape type. |
| RIBBON2 | Built-in shape type. |
| CHEVRON | Built-in shape type. |
| PENTAGON | Built-in shape type. |
| NO_SMOKING | Built-in shape type. |
| SEAL8 | Built-in shape type. |
| SEAL16 | Built-in shape type. |
| SEAL32 | Built-in shape type. |
| WEDGE_RECT_CALLOUT | Built-in shape type. |
| WEDGE_R_RECT_CALLOUT | Built-in shape type. |
| WEDGE_ELLIPSE_CALLOUT | Built-in shape type. |
| WAVE | Built-in shape type. |
| FOLDED_CORNER | Built-in shape type. |
| LEFT_ARROW | Built-in shape type. |
| DOWN_ARROW | Built-in shape type. |
| UP_ARROW | Built-in shape type. |
| LEFT_RIGHT_ARROW | Built-in shape type. |
| UP_DOWN_ARROW | Built-in shape type. |
| IRREGULAR_SEAL1 | Built-in shape type. |
| IRREGULAR_SEAL2 | Built-in shape type. |
| LIGHTNING_BOLT | Built-in shape type. |
| HEART | Built-in shape type. |
| IMAGE | Built-in shape type. |
| QUAD_ARROW | Built-in shape type. |
| LEFT_ARROW_CALLOUT | Built-in shape type. |
| RIGHT_ARROW_CALLOUT | Built-in shape type. |
| UP_ARROW_CALLOUT | Built-in shape type. |
| DOWN_ARROW_CALLOUT | Built-in shape type. |
| LEFT_RIGHT_ARROW_CALLOUT | Built-in shape type. |
| UP_DOWN_ARROW_CALLOUT | Built-in shape type. |
| QUAD_ARROW_CALLOUT | Built-in shape type. |
| BEVEL | Built-in shape type. |
| LEFT_BRACKET | Built-in shape type. |
| RIGHT_BRACKET | Built-in shape type. |
| LEFT_BRACE | Built-in shape type. |
| RIGHT_BRACE | Built-in shape type. |
| LEFT_UP_ARROW | Built-in shape type. |
| BENT_UP_ARROW | Built-in shape type. |
| BENT_ARROW | Built-in shape type. |
| SEAL24 | Built-in shape type. |
| STRIPED_RIGHT_ARROW | Built-in shape type. |
| NOTCHED_RIGHT_ARROW | Built-in shape type. |
| BLOCK_ARC | Built-in shape type. |
| SMILEY_FACE | Built-in shape type. |
| VERTICAL_SCROLL | Built-in shape type. |
| HORIZONTAL_SCROLL | Built-in shape type. |
| CIRCULAR_ARROW | Built-in shape type. |
| CUSTOM_SHAPE | Built-in shape type. |
| UTURN_ARROW | Built-in shape type. |
| CURVED_RIGHT_ARROW | Built-in shape type. |
| CURVED_LEFT_ARROW | Built-in shape type. |
| CURVED_UP_ARROW | Built-in shape type. |
| CURVED_DOWN_ARROW | Built-in shape type. |
| CLOUD_CALLOUT | Built-in shape type. |
| ELLIPSE_RIBBON | Built-in shape type. |
| ELLIPSE_RIBBON2 | Built-in shape type. |
| FLOW_CHART_PROCESS | Built-in shape type. |
| FLOW_CHART_DECISION | Built-in shape type. |
| FLOW_CHART_INPUT_OUTPUT | Built-in shape type. |
| FLOW_CHART_PREDEFINED_PROCESS | Built-in shape type. |
| FLOW_CHART_INTERNAL_STORAGE | Built-in shape type. |
| FLOW_CHART_DOCUMENT | Built-in shape type. |
| FLOW_CHART_MULTIDOCUMENT | Built-in shape type. |
| FLOW_CHART_TERMINATOR | Built-in shape type. |
| FLOW_CHART_PREPARATION | Built-in shape type. |
| FLOW_CHART_MANUAL_INPUT | Built-in shape type. |
| FLOW_CHART_MANUAL_OPERATION | Built-in shape type. |
| FLOW_CHART_CONNECTOR | Built-in shape type. |
| FLOW_CHART_PUNCHED_CARD | Built-in shape type. |
| FLOW_CHART_PUNCHED_TAPE | Built-in shape type. |
| FLOW_CHART_SUMMING_JUNCTION | Built-in shape type. |
| FLOW_CHART_OR | Built-in shape type. |
| FLOW_CHART_COLLATE | Built-in shape type. |
| FLOW_CHART_SORT | Built-in shape type. |
| FLOW_CHART_EXTRACT | Built-in shape type. |
| FLOW_CHART_MERGE | Built-in shape type. |
| FLOW_CHART_OFFLINE_STORAGE | Built-in shape type. |
| FLOW_CHART_ONLINE_STORAGE | Built-in shape type. |
| FLOW_CHART_MAGNETIC_TAPE | Built-in shape type. |
| FLOW_CHART_MAGNETIC_DISK | Built-in shape type. |
| FLOW_CHART_MAGNETIC_DRUM | Built-in shape type. |
| FLOW_CHART_DISPLAY | Built-in shape type. |
| FLOW_CHART_DELAY | Built-in shape type. |
| TEXT_PLAIN_TEXT | Built-in shape type. |
| TEXT_STOP | Built-in shape type. |
| TEXT_TRIANGLE | Built-in shape type. |
| TEXT_TRIANGLE_INVERTED | Built-in shape type. |
| TEXT_CHEVRON | Built-in shape type. |
| TEXT_CHEVRON_INVERTED | Built-in shape type. |
| TEXT_RING_INSIDE | Built-in shape type. |
| TEXT_RING_OUTSIDE | Built-in shape type. |
| TEXT_ARCH_UP_CURVE | Built-in shape type. |
| TEXT_ARCH_DOWN_CURVE | Built-in shape type. |
| TEXT_CIRCLE_CURVE | Built-in shape type. |
| TEXT_BUTTON_CURVE | Built-in shape type. |
| TEXT_ARCH_UP_POUR | Built-in shape type. |
| TEXT_ARCH_DOWN_POUR | Built-in shape type. |
| TEXT_CIRCLE_POUR | Built-in shape type. |
| TEXT_BUTTON_POUR | Built-in shape type. |
| TEXT_CURVE_UP | Built-in shape type. |
| TEXT_CURVE_DOWN | Built-in shape type. |
| TEXT_CASCADE_UP | Built-in shape type. |
| TEXT_CASCADE_DOWN | Built-in shape type. |
| TEXT_WAVE1 | Built-in shape type. |
| TEXT_WAVE2 | Built-in shape type. |
| TEXT_WAVE3 | Built-in shape type. |
| TEXT_WAVE4 | Built-in shape type. |
| TEXT_INFLATE | Built-in shape type. |
| TEXT_DEFLATE | Built-in shape type. |
| TEXT_INFLATE_BOTTOM | Built-in shape type. |
| TEXT_DEFLATE_BOTTOM | Built-in shape type. |
| TEXT_INFLATE_TOP | Built-in shape type. |
| TEXT_DEFLATE_TOP | Built-in shape type. |
| TEXT_DEFLATE_INFLATE | Built-in shape type. |
| TEXT_DEFLATE_INFLATE_DEFLATE | Built-in shape type. |
| TEXT_FADE_RIGHT | Built-in shape type. |
| TEXT_FADE_LEFT | Built-in shape type. |
| TEXT_FADE_UP | Built-in shape type. |
| TEXT_FADE_DOWN | Built-in shape type. |
| TEXT_SLANT_UP | Built-in shape type. |
| TEXT_SLANT_DOWN | Built-in shape type. |
| TEXT_CAN_UP | Built-in shape type. |
| TEXT_CAN_DOWN | Built-in shape type. |
| FLOW_CHART_ALTERNATE_PROCESS | Built-in shape type. |
| FLOW_CHART_OFFPAGE_CONNECTOR | Built-in shape type. |
| CALLOUT90 | Built-in shape type. |
| ACCENT_CALLOUT90 | Built-in shape type. |
| BORDER_CALLOUT90 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT90 | Built-in shape type. |
| LEFT_RIGHT_UP_ARROW | Built-in shape type. |
| SUN | Built-in shape type. |
| MOON | Built-in shape type. |
| BRACKET_PAIR | Built-in shape type. |
| BRACE_PAIR | Built-in shape type. |
| SEAL4 | Built-in shape type. |
| DOUBLE_WAVE | Built-in shape type. |
| ACTION_BUTTON_BLANK | Built-in shape type. |
| ACTION_BUTTON_HOME | Built-in shape type. |
| ACTION_BUTTON_HELP | Built-in shape type. |
| ACTION_BUTTON_INFORMATION | Built-in shape type. |
| ACTION_BUTTON_FORWARD_NEXT | Built-in shape type. |
| ACTION_BUTTON_BACK_PREVIOUS | Built-in shape type. |
| ACTION_BUTTON_END | Built-in shape type. |
| ACTION_BUTTON_BEGINNING | Built-in shape type. |
| ACTION_BUTTON_RETURN | Built-in shape type. |
| ACTION_BUTTON_DOCUMENT | Built-in shape type. |
| ACTION_BUTTON_SOUND | Built-in shape type. |
| ACTION_BUTTON_MOVIE | Built-in shape type. |
| OLE_CONTROL | Built-in shape type. |
| TEXT_BOX | Built-in shape type. |
| SINGLE_CORNER_SNIPPED | Built-in shape type. |
| TOP_CORNERS_SNIPPED | Built-in shape type. |
| DIAGONAL_CORNERS_SNIPPED | Built-in shape type. |
| TOP_CORNERS_ONE_ROUNDED_ONE_SNIPPED | Built-in shape type. |
| SINGLE_CORNER_ROUNDED | Built-in shape type. |
| TOP_CORNERS_ROUNDED | Built-in shape type. |
| DIAGONAL_CORNERS_ROUNDED | Built-in shape type. |
| OLE_OBJECT | Built-in shape type. |
| GROUP | Built-in shape type. |

### ACCENT_BORDER_CALLOUT1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_border_callout1.md

#### ACCENT_BORDER_CALLOUT1 field

Built-in shape type.

##### Value
`50`

### ACCENT_BORDER_CALLOUT2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_border_callout2.md

#### ACCENT_BORDER_CALLOUT2 field

Built-in shape type.

##### Value
`51`

### ACCENT_BORDER_CALLOUT3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_border_callout3.md

#### ACCENT_BORDER_CALLOUT3 field

Built-in shape type.

##### Value
`52`

### ACCENT_BORDER_CALLOUT90 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_border_callout90.md

#### ACCENT_BORDER_CALLOUT90 field

Built-in shape type.

##### Value
`181`

### ACCENT_CALLOUT1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_callout1.md

#### ACCENT_CALLOUT1 field

Built-in shape type.

##### Value
`44`

### ACCENT_CALLOUT2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_callout2.md

#### ACCENT_CALLOUT2 field

Built-in shape type.

##### Value
`45`

### ACCENT_CALLOUT3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_callout3.md

#### ACCENT_CALLOUT3 field

Built-in shape type.

##### Value
`46`

### ACCENT_CALLOUT90 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/accent_callout90.md

#### ACCENT_CALLOUT90 field

Built-in shape type.

##### Value
`179`

### ACTION_BUTTON_BACK_PREVIOUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_back_previous.md

#### ACTION_BUTTON_BACK_PREVIOUS field

Built-in shape type.

##### Value
`194`

### ACTION_BUTTON_BEGINNING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_beginning.md

#### ACTION_BUTTON_BEGINNING field

Built-in shape type.

##### Value
`196`

### ACTION_BUTTON_BLANK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_blank.md

#### ACTION_BUTTON_BLANK field

Built-in shape type.

##### Value
`189`

### ACTION_BUTTON_DOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_document.md

#### ACTION_BUTTON_DOCUMENT field

Built-in shape type.

##### Value
`198`

### ACTION_BUTTON_END field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_end.md

#### ACTION_BUTTON_END field

Built-in shape type.

##### Value
`195`

### ACTION_BUTTON_FORWARD_NEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_forward_next.md

#### ACTION_BUTTON_FORWARD_NEXT field

Built-in shape type.

##### Value
`193`

### ACTION_BUTTON_HELP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_help.md

#### ACTION_BUTTON_HELP field

Built-in shape type.

##### Value
`191`

### ACTION_BUTTON_HOME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_home.md

#### ACTION_BUTTON_HOME field

Built-in shape type.

##### Value
`190`

### ACTION_BUTTON_INFORMATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_information.md

#### ACTION_BUTTON_INFORMATION field

Built-in shape type.

##### Value
`192`

### ACTION_BUTTON_MOVIE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_movie.md

#### ACTION_BUTTON_MOVIE field

Built-in shape type.

##### Value
`200`

### ACTION_BUTTON_RETURN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_return.md

#### ACTION_BUTTON_RETURN field

Built-in shape type.

##### Value
`197`

### ACTION_BUTTON_SOUND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/action_button_sound.md

#### ACTION_BUTTON_SOUND field

Built-in shape type.

##### Value
`199`

### ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/arc.md

#### ARC field

Built-in shape type.

##### Value
`19`

### ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/arrow.md

#### ARROW field

Built-in shape type.

##### Value
`13`

### BALLOON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/balloon.md

#### BALLOON field

Built-in shape type.

##### Value
`17`

### BENT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_arrow.md

#### BENT_ARROW field

Built-in shape type.

##### Value
`91`

### BENT_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_connector2.md

#### BENT_CONNECTOR2 field

Built-in shape type.

##### Value
`33`

### BENT_CONNECTOR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_connector3.md

#### BENT_CONNECTOR3 field

Built-in shape type.

##### Value
`34`

### BENT_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_connector4.md

#### BENT_CONNECTOR4 field

Built-in shape type.

##### Value
`35`

### BENT_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_connector5.md

#### BENT_CONNECTOR5 field

Built-in shape type.

##### Value
`36`

### BENT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bent_up_arrow.md

#### BENT_UP_ARROW field

Built-in shape type.

##### Value
`90`

### BEVEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bevel.md

#### BEVEL field

Built-in shape type.

##### Value
`84`

### BLOCK_ARC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/block_arc.md

#### BLOCK_ARC field

Built-in shape type.

##### Value
`95`

### BORDER_CALLOUT1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/border_callout1.md

#### BORDER_CALLOUT1 field

Built-in shape type.

##### Value
`47`

### BORDER_CALLOUT2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/border_callout2.md

#### BORDER_CALLOUT2 field

Built-in shape type.

##### Value
`48`

### BORDER_CALLOUT3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/border_callout3.md

#### BORDER_CALLOUT3 field

Built-in shape type.

##### Value
`49`

### BORDER_CALLOUT90 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/border_callout90.md

#### BORDER_CALLOUT90 field

Built-in shape type.

##### Value
`180`

### BRACE_PAIR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/brace_pair.md

#### BRACE_PAIR field

Built-in shape type.

##### Value
`186`

### BRACKET_PAIR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/bracket_pair.md

#### BRACKET_PAIR field

Built-in shape type.

##### Value
`185`

### CALLOUT1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/callout1.md

#### CALLOUT1 field

Built-in shape type.

##### Value
`41`

### CALLOUT2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/callout2.md

#### CALLOUT2 field

Built-in shape type.

##### Value
`42`

### CALLOUT3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/callout3.md

#### CALLOUT3 field

Built-in shape type.

##### Value
`43`

### CALLOUT90 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/callout90.md

#### CALLOUT90 field

Built-in shape type.

##### Value
`178`

### CAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/can.md

#### CAN field

Built-in shape type.

##### Value
`22`

### CHEVRON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/chevron.md

#### CHEVRON field

Built-in shape type.

##### Value
`55`

### CIRCULAR_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/circular_arrow.md

#### CIRCULAR_ARROW field

Built-in shape type.

##### Value
`99`

### CLOUD_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/cloud_callout.md

#### CLOUD_CALLOUT field

Built-in shape type.

##### Value
`106`

### CUBE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/cube.md

#### CUBE field

Built-in shape type.

##### Value
`16`

### CURVED_CONNECTOR2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_connector2.md

#### CURVED_CONNECTOR2 field

Built-in shape type.

##### Value
`37`

### CURVED_CONNECTOR3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_connector3.md

#### CURVED_CONNECTOR3 field

Built-in shape type.

##### Value
`38`

### CURVED_CONNECTOR4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_connector4.md

#### CURVED_CONNECTOR4 field

Built-in shape type.

##### Value
`39`

### CURVED_CONNECTOR5 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_connector5.md

#### CURVED_CONNECTOR5 field

Built-in shape type.

##### Value
`40`

### CURVED_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_down_arrow.md

#### CURVED_DOWN_ARROW field

Built-in shape type.

##### Value
`105`

### CURVED_LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_left_arrow.md

#### CURVED_LEFT_ARROW field

Built-in shape type.

##### Value
`103`

### CURVED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_right_arrow.md

#### CURVED_RIGHT_ARROW field

Built-in shape type.

##### Value
`102`

### CURVED_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/curved_up_arrow.md

#### CURVED_UP_ARROW field

Built-in shape type.

##### Value
`104`

### CUSTOM_SHAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/custom_shape.md

#### CUSTOM_SHAPE field

Built-in shape type.

##### Value
`100`

### DIAGONAL_CORNERS_ROUNDED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/diagonal_corners_rounded.md

#### DIAGONAL_CORNERS_ROUNDED field

Built-in shape type.

##### Value
`209`

### DIAGONAL_CORNERS_SNIPPED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/diagonal_corners_snipped.md

#### DIAGONAL_CORNERS_SNIPPED field

Built-in shape type.

##### Value
`205`

### DIAMOND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/diamond.md

#### DIAMOND field

Built-in shape type.

##### Value
`4`

### DONUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/donut.md

#### DONUT field

Built-in shape type.

##### Value
`23`

### DOUBLE_WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/double_wave.md

#### DOUBLE_WAVE field

Built-in shape type.

##### Value
`188`

### DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/down_arrow.md

#### DOWN_ARROW field

Built-in shape type.

##### Value
`67`

### DOWN_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/down_arrow_callout.md

#### DOWN_ARROW_CALLOUT field

Built-in shape type.

##### Value
`80`

### ELLIPSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ellipse.md

#### ELLIPSE field

Built-in shape type.

##### Value
`3`

### ELLIPSE_RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ellipse_ribbon.md

#### ELLIPSE_RIBBON field

Built-in shape type.

##### Value
`107`

### ELLIPSE_RIBBON2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ellipse_ribbon2.md

#### ELLIPSE_RIBBON2 field

Built-in shape type.

##### Value
`108`

### FLOW_CHART_ALTERNATE_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_alternate_process.md

#### FLOW_CHART_ALTERNATE_PROCESS field

Built-in shape type.

##### Value
`176`

### FLOW_CHART_COLLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_collate.md

#### FLOW_CHART_COLLATE field

Built-in shape type.

##### Value
`125`

### FLOW_CHART_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_connector.md

#### FLOW_CHART_CONNECTOR field

Built-in shape type.

##### Value
`120`

### FLOW_CHART_DECISION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_decision.md

#### FLOW_CHART_DECISION field

Built-in shape type.

##### Value
`110`

### FLOW_CHART_DELAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_delay.md

#### FLOW_CHART_DELAY field

Built-in shape type.

##### Value
`135`

### FLOW_CHART_DISPLAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_display.md

#### FLOW_CHART_DISPLAY field

Built-in shape type.

##### Value
`134`

### FLOW_CHART_DOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_document.md

#### FLOW_CHART_DOCUMENT field

Built-in shape type.

##### Value
`114`

### FLOW_CHART_EXTRACT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_extract.md

#### FLOW_CHART_EXTRACT field

Built-in shape type.

##### Value
`127`

### FLOW_CHART_INPUT_OUTPUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_input_output.md

#### FLOW_CHART_INPUT_OUTPUT field

Built-in shape type.

##### Value
`111`

### FLOW_CHART_INTERNAL_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_internal_storage.md

#### FLOW_CHART_INTERNAL_STORAGE field

Built-in shape type.

##### Value
`113`

### FLOW_CHART_MAGNETIC_DISK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_magnetic_disk.md

#### FLOW_CHART_MAGNETIC_DISK field

Built-in shape type.

##### Value
`132`

### FLOW_CHART_MAGNETIC_DRUM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_magnetic_drum.md

#### FLOW_CHART_MAGNETIC_DRUM field

Built-in shape type.

##### Value
`133`

### FLOW_CHART_MAGNETIC_TAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_magnetic_tape.md

#### FLOW_CHART_MAGNETIC_TAPE field

Built-in shape type.

##### Value
`131`

### FLOW_CHART_MANUAL_INPUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_manual_input.md

#### FLOW_CHART_MANUAL_INPUT field

Built-in shape type.

##### Value
`118`

### FLOW_CHART_MANUAL_OPERATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_manual_operation.md

#### FLOW_CHART_MANUAL_OPERATION field

Built-in shape type.

##### Value
`119`

### FLOW_CHART_MERGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_merge.md

#### FLOW_CHART_MERGE field

Built-in shape type.

##### Value
`128`

### FLOW_CHART_MULTIDOCUMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_multidocument.md

#### FLOW_CHART_MULTIDOCUMENT field

Built-in shape type.

##### Value
`115`

### FLOW_CHART_OFFLINE_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_offline_storage.md

#### FLOW_CHART_OFFLINE_STORAGE field

Built-in shape type.

##### Value
`129`

### FLOW_CHART_OFFPAGE_CONNECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_offpage_connector.md

#### FLOW_CHART_OFFPAGE_CONNECTOR field

Built-in shape type.

##### Value
`177`

### FLOW_CHART_ONLINE_STORAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_online_storage.md

#### FLOW_CHART_ONLINE_STORAGE field

Built-in shape type.

##### Value
`130`

### FLOW_CHART_OR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_or.md

#### FLOW_CHART_OR field

Built-in shape type.

##### Value
`124`

### FLOW_CHART_PREDEFINED_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_predefined_process.md

#### FLOW_CHART_PREDEFINED_PROCESS field

Built-in shape type.

##### Value
`112`

### FLOW_CHART_PREPARATION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_preparation.md

#### FLOW_CHART_PREPARATION field

Built-in shape type.

##### Value
`117`

### FLOW_CHART_PROCESS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_process.md

#### FLOW_CHART_PROCESS field

Built-in shape type.

##### Value
`109`

### FLOW_CHART_PUNCHED_CARD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_punched_card.md

#### FLOW_CHART_PUNCHED_CARD field

Built-in shape type.

##### Value
`121`

### FLOW_CHART_PUNCHED_TAPE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_punched_tape.md

#### FLOW_CHART_PUNCHED_TAPE field

Built-in shape type.

##### Value
`122`

### FLOW_CHART_SORT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_sort.md

#### FLOW_CHART_SORT field

Built-in shape type.

##### Value
`126`

### FLOW_CHART_SUMMING_JUNCTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_summing_junction.md

#### FLOW_CHART_SUMMING_JUNCTION field

Built-in shape type.

##### Value
`123`

### FLOW_CHART_TERMINATOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/flow_chart_terminator.md

#### FLOW_CHART_TERMINATOR field

Built-in shape type.

##### Value
`116`

### FOLDED_CORNER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/folded_corner.md

#### FOLDED_CORNER field

Built-in shape type.

##### Value
`65`

### GROUP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/group.md

#### GROUP field

Built-in shape type.

##### Value
`-1`

### HEART field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/heart.md

#### HEART field

Built-in shape type.

##### Value
`74`

### HEXAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/hexagon.md

#### HEXAGON field

Built-in shape type.

##### Value
`9`

### HOME_PLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/home_plate.md

#### HOME_PLATE field

Built-in shape type.

##### Value
`15`

### HORIZONTAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/horizontal_scroll.md

#### HORIZONTAL_SCROLL field

Built-in shape type.

##### Value
`98`

### IMAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/image.md

#### IMAGE field

Built-in shape type.

##### Value
`75`

### IRREGULAR_SEAL1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/irregular_seal1.md

#### IRREGULAR_SEAL1 field

Built-in shape type.

##### Value
`71`

### IRREGULAR_SEAL2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/irregular_seal2.md

#### IRREGULAR_SEAL2 field

Built-in shape type.

##### Value
`72`

### LEFT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_arrow.md

#### LEFT_ARROW field

Built-in shape type.

##### Value
`66`

### LEFT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_arrow_callout.md

#### LEFT_ARROW_CALLOUT field

Built-in shape type.

##### Value
`77`

### LEFT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_brace.md

#### LEFT_BRACE field

Built-in shape type.

##### Value
`87`

### LEFT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_bracket.md

#### LEFT_BRACKET field

Built-in shape type.

##### Value
`85`

### LEFT_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_right_arrow.md

#### LEFT_RIGHT_ARROW field

Built-in shape type.

##### Value
`69`

### LEFT_RIGHT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_right_arrow_callout.md

#### LEFT_RIGHT_ARROW_CALLOUT field

Built-in shape type.

##### Value
`81`

### LEFT_RIGHT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_right_up_arrow.md

#### LEFT_RIGHT_UP_ARROW field

Built-in shape type.

##### Value
`182`

### LEFT_UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/left_up_arrow.md

#### LEFT_UP_ARROW field

Built-in shape type.

##### Value
`89`

### LIGHTNING_BOLT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/lightning_bolt.md

#### LIGHTNING_BOLT field

Built-in shape type.

##### Value
`73`

### LINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/line.md

#### LINE field

Built-in shape type.

##### Value
`20`

### MOON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/moon.md

#### MOON field

Built-in shape type.

##### Value
`184`

### NO_SMOKING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/no_smoking.md

#### NO_SMOKING field

Built-in shape type.

##### Value
`57`

### NON_PRIMITIVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/non_primitive.md

#### NON_PRIMITIVE field

Built-in shape type.

##### Value
`0`

### NOTCHED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/notched_right_arrow.md

#### NOTCHED_RIGHT_ARROW field

Built-in shape type.

##### Value
`94`

### OCTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/octagon.md

#### OCTAGON field

Built-in shape type.

##### Value
`10`

### OLE_CONTROL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ole_control.md

#### OLE_CONTROL field

Built-in shape type.

##### Value
`201`

### OLE_OBJECT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ole_object.md

#### OLE_OBJECT field

Built-in shape type.

##### Value
`-2`

### PARALLELOGRAM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/parallelogram.md

#### PARALLELOGRAM field

Built-in shape type.

##### Value
`7`

### PENTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/pentagon.md

#### PENTAGON field

Built-in shape type.

##### Value
`56`

### PLAQUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/plaque.md

#### PLAQUE field

Built-in shape type.

##### Value
`21`

### PLUS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/plus.md

#### PLUS field

Built-in shape type.

##### Value
`11`

### QUAD_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/quad_arrow.md

#### QUAD_ARROW field

Built-in shape type.

##### Value
`76`

### QUAD_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/quad_arrow_callout.md

#### QUAD_ARROW_CALLOUT field

Built-in shape type.

##### Value
`83`

### RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/rectangle.md

#### RECTANGLE field

Built-in shape type.

##### Value
`1`

### RIBBON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ribbon.md

#### RIBBON field

Built-in shape type.

##### Value
`53`

### RIBBON2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/ribbon2.md

#### RIBBON2 field

Built-in shape type.

##### Value
`54`

### RIGHT_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/right_arrow_callout.md

#### RIGHT_ARROW_CALLOUT field

Built-in shape type.

##### Value
`78`

### RIGHT_BRACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/right_brace.md

#### RIGHT_BRACE field

Built-in shape type.

##### Value
`88`

### RIGHT_BRACKET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/right_bracket.md

#### RIGHT_BRACKET field

Built-in shape type.

##### Value
`86`

### RIGHT_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/right_triangle.md

#### RIGHT_TRIANGLE field

Built-in shape type.

##### Value
`6`

### ROUND_RECTANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/round_rectangle.md

#### ROUND_RECTANGLE field

Built-in shape type.

##### Value
`2`

### SEAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal.md

#### SEAL field

Built-in shape type.

##### Value
`18`

### SEAL16 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal16.md

#### SEAL16 field

Built-in shape type.

##### Value
`59`

### SEAL24 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal24.md

#### SEAL24 field

Built-in shape type.

##### Value
`92`

### SEAL32 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal32.md

#### SEAL32 field

Built-in shape type.

##### Value
`60`

### SEAL4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal4.md

#### SEAL4 field

Built-in shape type.

##### Value
`187`

### SEAL8 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/seal8.md

#### SEAL8 field

Built-in shape type.

##### Value
`58`

### SINGLE_CORNER_ROUNDED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/single_corner_rounded.md

#### SINGLE_CORNER_ROUNDED field

Built-in shape type.

##### Value
`207`

### SINGLE_CORNER_SNIPPED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/single_corner_snipped.md

#### SINGLE_CORNER_SNIPPED field

Built-in shape type.

##### Value
`203`

### SMILEY_FACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/smiley_face.md

#### SMILEY_FACE field

Built-in shape type.

##### Value
`96`

### STAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/star.md

#### STAR field

Built-in shape type.

##### Value
`12`

### STRAIGHT_CONNECTOR1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/straight_connector1.md

#### STRAIGHT_CONNECTOR1 field

Built-in shape type.

##### Value
`32`

### STRIPED_RIGHT_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/striped_right_arrow.md

#### STRIPED_RIGHT_ARROW field

Built-in shape type.

##### Value
`93`

### SUN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/sun.md

#### SUN field

Built-in shape type.

##### Value
`183`

### TEXT_ARCH_DOWN_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_arch_down_curve.md

#### TEXT_ARCH_DOWN_CURVE field

Built-in shape type.

##### Value
`145`

### TEXT_ARCH_DOWN_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_arch_down_pour.md

#### TEXT_ARCH_DOWN_POUR field

Built-in shape type.

##### Value
`149`

### TEXT_ARCH_UP_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_arch_up_curve.md

#### TEXT_ARCH_UP_CURVE field

Built-in shape type.

##### Value
`144`

### TEXT_ARCH_UP_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_arch_up_pour.md

#### TEXT_ARCH_UP_POUR field

Built-in shape type.

##### Value
`148`

### TEXT_BOX field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_box.md

#### TEXT_BOX field

Built-in shape type.

##### Value
`202`

### TEXT_BUTTON_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_button_curve.md

#### TEXT_BUTTON_CURVE field

Built-in shape type.

##### Value
`147`

### TEXT_BUTTON_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_button_pour.md

#### TEXT_BUTTON_POUR field

Built-in shape type.

##### Value
`151`

### TEXT_CAN_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_can_down.md

#### TEXT_CAN_DOWN field

Built-in shape type.

##### Value
`175`

### TEXT_CAN_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_can_up.md

#### TEXT_CAN_UP field

Built-in shape type.

##### Value
`174`

### TEXT_CASCADE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_cascade_down.md

#### TEXT_CASCADE_DOWN field

Built-in shape type.

##### Value
`155`

### TEXT_CASCADE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_cascade_up.md

#### TEXT_CASCADE_UP field

Built-in shape type.

##### Value
`154`

### TEXT_CHEVRON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_chevron.md

#### TEXT_CHEVRON field

Built-in shape type.

##### Value
`140`

### TEXT_CHEVRON_INVERTED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_chevron_inverted.md

#### TEXT_CHEVRON_INVERTED field

Built-in shape type.

##### Value
`141`

### TEXT_CIRCLE_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_circle_curve.md

#### TEXT_CIRCLE_CURVE field

Built-in shape type.

##### Value
`146`

### TEXT_CIRCLE_POUR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_circle_pour.md

#### TEXT_CIRCLE_POUR field

Built-in shape type.

##### Value
`150`

### TEXT_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_curve.md

#### TEXT_CURVE field

Built-in shape type.

##### Value
`27`

### TEXT_CURVE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_curve_down.md

#### TEXT_CURVE_DOWN field

Built-in shape type.

##### Value
`153`

### TEXT_CURVE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_curve_up.md

#### TEXT_CURVE_UP field

Built-in shape type.

##### Value
`152`

### TEXT_DEFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_deflate.md

#### TEXT_DEFLATE field

Built-in shape type.

##### Value
`161`

### TEXT_DEFLATE_BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_deflate_bottom.md

#### TEXT_DEFLATE_BOTTOM field

Built-in shape type.

##### Value
`163`

### TEXT_DEFLATE_INFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_deflate_inflate.md

#### TEXT_DEFLATE_INFLATE field

Built-in shape type.

##### Value
`166`

### TEXT_DEFLATE_INFLATE_DEFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_deflate_inflate_deflate.md

#### TEXT_DEFLATE_INFLATE_DEFLATE field

Built-in shape type.

##### Value
`167`

### TEXT_DEFLATE_TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_deflate_top.md

#### TEXT_DEFLATE_TOP field

Built-in shape type.

##### Value
`165`

### TEXT_FADE_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_fade_down.md

#### TEXT_FADE_DOWN field

Built-in shape type.

##### Value
`171`

### TEXT_FADE_LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_fade_left.md

#### TEXT_FADE_LEFT field

Built-in shape type.

##### Value
`169`

### TEXT_FADE_RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_fade_right.md

#### TEXT_FADE_RIGHT field

Built-in shape type.

##### Value
`168`

### TEXT_FADE_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_fade_up.md

#### TEXT_FADE_UP field

Built-in shape type.

##### Value
`170`

### TEXT_HEXAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_hexagon.md

#### TEXT_HEXAGON field

Built-in shape type.

##### Value
`26`

### TEXT_INFLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_inflate.md

#### TEXT_INFLATE field

Built-in shape type.

##### Value
`160`

### TEXT_INFLATE_BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_inflate_bottom.md

#### TEXT_INFLATE_BOTTOM field

Built-in shape type.

##### Value
`162`

### TEXT_INFLATE_TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_inflate_top.md

#### TEXT_INFLATE_TOP field

Built-in shape type.

##### Value
`164`

### TEXT_OCTAGON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_octagon.md

#### TEXT_OCTAGON field

Built-in shape type.

##### Value
`25`

### TEXT_ON_CURVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_on_curve.md

#### TEXT_ON_CURVE field

Built-in shape type.

##### Value
`30`

### TEXT_ON_RING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_on_ring.md

#### TEXT_ON_RING field

Built-in shape type.

##### Value
`31`

### TEXT_PLAIN_TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_plain_text.md

#### TEXT_PLAIN_TEXT field

Built-in shape type.

##### Value
`136`

### TEXT_RING field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_ring.md

#### TEXT_RING field

Built-in shape type.

##### Value
`29`

### TEXT_RING_INSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_ring_inside.md

#### TEXT_RING_INSIDE field

Built-in shape type.

##### Value
`142`

### TEXT_RING_OUTSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_ring_outside.md

#### TEXT_RING_OUTSIDE field

Built-in shape type.

##### Value
`143`

### TEXT_SIMPLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_simple.md

#### TEXT_SIMPLE field

Built-in shape type.

##### Value
`24`

### TEXT_SLANT_DOWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_slant_down.md

#### TEXT_SLANT_DOWN field

Built-in shape type.

##### Value
`173`

### TEXT_SLANT_UP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_slant_up.md

#### TEXT_SLANT_UP field

Built-in shape type.

##### Value
`172`

### TEXT_STOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_stop.md

#### TEXT_STOP field

Built-in shape type.

##### Value
`137`

### TEXT_TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_triangle.md

#### TEXT_TRIANGLE field

Built-in shape type.

##### Value
`138`

### TEXT_TRIANGLE_INVERTED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_triangle_inverted.md

#### TEXT_TRIANGLE_INVERTED field

Built-in shape type.

##### Value
`139`

### TEXT_WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_wave.md

#### TEXT_WAVE field

Built-in shape type.

##### Value
`28`

### TEXT_WAVE1 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_wave1.md

#### TEXT_WAVE1 field

Built-in shape type.

##### Value
`156`

### TEXT_WAVE2 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_wave2.md

#### TEXT_WAVE2 field

Built-in shape type.

##### Value
`157`

### TEXT_WAVE3 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_wave3.md

#### TEXT_WAVE3 field

Built-in shape type.

##### Value
`158`

### TEXT_WAVE4 field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/text_wave4.md

#### TEXT_WAVE4 field

Built-in shape type.

##### Value
`159`

### THICK_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/thick_arrow.md

#### THICK_ARROW field

Built-in shape type.

##### Value
`14`

### TOP_CORNERS_ONE_ROUNDED_ONE_SNIPPED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/top_corners_one_rounded_one_snipped.md

#### TOP_CORNERS_ONE_ROUNDED_ONE_SNIPPED field

Built-in shape type.

##### Value
`206`

### TOP_CORNERS_ROUNDED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/top_corners_rounded.md

#### TOP_CORNERS_ROUNDED field

Built-in shape type.

##### Value
`208`

### TOP_CORNERS_SNIPPED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/top_corners_snipped.md

#### TOP_CORNERS_SNIPPED field

Built-in shape type.

##### Value
`204`

### TRAPEZOID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/trapezoid.md

#### TRAPEZOID field

Built-in shape type.

##### Value
`8`

### TRIANGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/triangle.md

#### TRIANGLE field

Built-in shape type.

##### Value
`5`

### UP_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/up_arrow.md

#### UP_ARROW field

Built-in shape type.

##### Value
`68`

### UP_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/up_arrow_callout.md

#### UP_ARROW_CALLOUT field

Built-in shape type.

##### Value
`79`

### UP_DOWN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/up_down_arrow.md

#### UP_DOWN_ARROW field

Built-in shape type.

##### Value
`70`

### UP_DOWN_ARROW_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/up_down_arrow_callout.md

#### UP_DOWN_ARROW_CALLOUT field

Built-in shape type.

##### Value
`82`

### UTURN_ARROW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/uturn_arrow.md

#### UTURN_ARROW field

Built-in shape type.

##### Value
`101`

### VERTICAL_SCROLL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/vertical_scroll.md

#### VERTICAL_SCROLL field

Built-in shape type.

##### Value
`97`

### WAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/wave.md

#### WAVE field

Built-in shape type.

##### Value
`64`

### WEDGE_ELLIPSE_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/wedge_ellipse_callout.md

#### WEDGE_ELLIPSE_CALLOUT field

Built-in shape type.

##### Value
`63`

### WEDGE_R_RECT_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/wedge_r_rect_callout.md

#### WEDGE_R_RECT_CALLOUT field

Built-in shape type.

##### Value
`62`

### WEDGE_RECT_CALLOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingshapetype/wedge_rect_callout.md

#### WEDGE_RECT_CALLOUT field

Built-in shape type.

##### Value
`61`

### WordProcessingTextFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragment.md

#### WordProcessingTextFormattedTextFragment class

Represents a fragment of formatted text in a Word document.

The WordProcessingTextFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### WordProcessingTextFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingtextformattedtextfragmentcollection.md

#### WordProcessingTextFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document main text.

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

The WordProcessingTextFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### WordProcessingVerticalAlignment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment.md

#### WordProcessingVerticalAlignment class

The WordProcessingVerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | The object is explicitly positioned using its y-coordinate. |
| TOP | Specifies that the object is at the top of the vertical alignment base. |
| CENTER | Specifies that the object is centered with respect to the vertical alignment bas. |
| BOTTOM | Specifies that the object is at the bottom of the vertical alignment base. |
| INSIDE | Specifies that the object is inside of the horizontal alignment base. |
| OUTSIDE | Specifies that the object is outside of the vertical alignment base. |
| INLINE | Not documented. Seems to be a possible value for floating paragraphs and tables. |

### BOTTOM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/bottom.md

#### BOTTOM field

Specifies that the object is at the bottom of the vertical alignment base.

##### Value
`3`

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/center.md

#### CENTER field

Specifies that the object is centered with respect to the vertical alignment bas.

##### Value
`2`

### INLINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/inline.md

#### INLINE field

Not documented. Seems to be a possible value for floating paragraphs and tables.

##### Value
`-1`

### INSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/inside.md

#### INSIDE field

Specifies that the object is inside of the horizontal alignment base.

##### Value
`4`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/none.md

#### NONE field

The object is explicitly positioned using its y-coordinate.

##### Value
`0`

### OUTSIDE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/outside.md

#### OUTSIDE field

Specifies that the object is outside of the vertical alignment base.

##### Value
`5`

### TOP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingverticalalignment/top.md

#### TOP field

Specifies that the object is at the top of the vertical alignment base.

##### Value
`1`

### WordProcessingWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwatermarkableimage.md

#### WordProcessingWatermarkableImage class

Represents an image inside a Word document.

The WordProcessingWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `WordProcessingWatermarkableImage` using the specified image data. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to this `WatermarkableImage`. Assumes that watermark offset and size are measured in pixels (if they are assigned). (inherited from `WatermarkableImage`) |
| add_watermark |  (inherited from `WatermarkableImage`) |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| get_bytes | Gets the image as a byte array. (inherited from `WatermarkableImage`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |
| width | The width of this WatermarkableImage in pixels. (inherited from `WatermarkableImage`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as wp

# Load image bytes from a file
with open("test.png", "rb") as f:
    img_bytes = f.read()

# Create a watermarkable image for use in a Word shape
image = wp.WordProcessingWatermarkableImage(img_bytes)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwatermarkableimage/__init__.md

#### __init__

Initializes a new instance of `WordProcessingWatermarkableImage` using the specified image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | `list[int]` | The array of unsigned bytes from which to create the `WordProcessingWatermarkableImage`. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

with open("test.png", "rb") as f:
    img_bytes = f.read()

image = gwc_wp.WordProcessingWatermarkableImage(img_bytes)
```

### WordProcessingWordArtShapeFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragment.md

#### WordProcessingWordArtShapeFormattedTextFragment class

Represents a fragment of formatted text in a WordArt shape.

The WordProcessingWordArtShapeFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### WordProcessingWordArtShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.word_processing/wordprocessingwordartshapeformattedtextfragmentcollection.md

#### WordProcessingWordArtShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document WordArt shape.

This collection contains the items of `WordProcessingWordArtShapeFormattedTextFragment` type.

The WordProcessingWordArtShapeFormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. (inherited from `FormattedTextFragmentCollection`) |
| add_file |  (inherited from `FormattedTextFragmentCollection`) |
| add_string |  (inherited from `FormattedTextFragmentCollection`) |
| clear |  (inherited from `RemoveOnlyListBase`) |
| insert | Inserts a formatted text fragment into the collection at a given index. (inherited from `FormattedTextFragmentCollection`) |
| insert_file |  (inherited from `FormattedTextFragmentCollection`) |
| insert_int32 |  (inherited from `FormattedTextFragmentCollection`) |
| insert_string |  (inherited from `FormattedTextFragmentCollection`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. (inherited from `FormattedTextFragmentCollection`) |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### groupdocs.watermark.contents.wordprocessing
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing.md

The namespace provides classes for working with watermarks in Word documents.

##### Classes
| Class | Description |
| :- | :- |
| `WordProcessingContent` | Class representing Word document (doc, docx etc) where watermark should be placed. |
| `WordProcessingFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document. |
| `WordProcessingHeaderFooter` | Represents a header/footer in a Word document. |
| `WordProcessingHeaderFooterCollection` | Represents a collection of headers and footers in a Word document. |
| `WordProcessingPageSetup` | Represents printing page properties for a section of a Word document. |
| `WordProcessingSection` | Represents a Word document section. |
| `WordProcessingSectionCollection` | Represents a collection of sections in a Word document. |
| `WordProcessingShape` | Represents a drawing shape in a Word document. |
| `WordProcessingShapeCollection` | Represents a collection of shapes in a Word document. |
| `WordProcessingShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document shape. |
| `WordProcessingTextFormattedTextFragment` | Represents a fragment of formatted text in a Word document. |
| `WordProcessingTextFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document main text. |
| `WordProcessingWatermarkableImage` | Represents an image inside a Word document. |
| `WordProcessingWordArtShapeFormattedTextFragment` | Represents a fragment of formatted text in a WordArt shape. |
| `WordProcessingWordArtShapeFormattedTextFragmentCollection` | Represents a collection of formatted text fragments in a Word document WordArt shape. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `WordProcessingHorizontalAlignment` | Specifies horizontal alignment of a floating object. |
| `WordProcessingProtectionType` | Represents protection type for a Word document. |
| `WordProcessingRelativeHorizontalPosition` | Specifies to what the horizontal position of an object is relative. |
| `WordProcessingRelativeVerticalPosition` | Specifies to what the vertical position of an object is relative. |
| `WordProcessingShapeType` | Represents the type of a shape in a Word document. |
| `WordProcessingVerticalAlignment` | Specifies vertical alignment of a floating object. |

### WordProcessingContent class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent.md

#### WordProcessingContent class

Class representing Word document (doc, docx etc) where watermark should be placed.

**Inheritance:** `WordProcessingContent` →
`Content` →
`ContentPart`

The WordProcessingContent type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| sections | Gets the collection of all sections of this `WordProcessingContent`. |
| page_count | Gets the number of pages in the document. |

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| find_images | Finds all images in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds possible watermarks according to specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds all possible watermarks in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| encrypt | Encrypts the document. |
| decrypt | Decrypts the document. |
| protect | Protects the document from changes and sets a protection password. |
| unprotect | Removes protection from the document regardless of the password. |

##### Remarks

**Learn more:** |
|
 |
 |
 |
 |
 |

##### Example

Load and save Word document of any supported type.

### decrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/decrypt.md

#### decrypt

Decrypts the document.

```python
def decrypt(self):
    ...
```

### encrypt method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/encrypt.md

#### encrypt

Encrypts the document.

```python
def encrypt(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | System.String | The password that will be required to open the document. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### page_count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/page_count.md

#### page_count property

Gets the number of pages in the document.
##### Definition:
```python
@property
def page_count(self):
    ...
```

### protect method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/protect.md

#### protect

Protects the document from changes and sets a protection password.

```python
def protect(self, protection_type, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| protection_type | groupdocs.watermark.contents.wordprocessing.WordProcessingProtectionType | Specifies the protection type for the document. |
| password | System.String | The password to protect the document with. |

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### sections property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/sections.md

#### sections property

Gets the collection of all sections of this `WordProcessingContent`.
##### Definition:
```python
@property
def sections(self):
    ...
```

### unprotect method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingcontent/unprotect.md

#### unprotect

Removes protection from the document regardless of the password.

```python
def unprotect(self):
    ...
```

### WordProcessingFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingformattedtextfragmentcollection.md

#### WordProcessingFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document.

**Inheritance:** `WordProcessingFormattedTextFragmentCollection` →
`FormattedTextFragmentCollection`

The WordProcessingFormattedTextFragmentCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| collection_type | Gets the formatted fragment collection type. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### WordProcessingHeaderFooter class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter.md

#### WordProcessingHeaderFooter class

Represents a header/footer in a Word document.

**Inheritance:** `WordProcessingHeaderFooter` →
`ContentPart`

The WordProcessingHeaderFooter type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| header_footer_type | Gets the type of this `WordProcessingHeaderFooter`. |
| section | Gets the parent section of this `WordProcessingHeaderFooter`. |
| is_linked_to_previous | Gets or sets a value indicating whether this header/footer is linked to
<br/>the corresponding header/footer in the previous section. |

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| find_images | Finds all images in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds possible watermarks according to specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds all possible watermarks in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### header_footer_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/header_footer_type.md

#### header_footer_type property

Gets the type of this `WordProcessingHeaderFooter`.
##### Definition:
```python
@property
def header_footer_type(self):
    ...
```

### is_linked_to_previous property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/is_linked_to_previous.md

#### is_linked_to_previous property

Gets or sets a value indicating whether this header/footer is linked to
the corresponding header/footer in the previous section.

##### Remarks

Default is true. Note, when your link a header or footer, its contents is cleared.
##### Definition:
```python
@property
def is_linked_to_previous(self):
    ...
@is_linked_to_previous.setter
def is_linked_to_previous(self, value):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### section property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfooter/section.md

#### section property

Gets the parent section of this `WordProcessingHeaderFooter`.
##### Definition:
```python
@property
def section(self):
    ...
```

### WordProcessingHeaderFooterCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfootercollection.md

#### WordProcessingHeaderFooterCollection class

Represents a collection of headers and footers in a Word document.

The WordProcessingHeaderFooterCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| link_to_previous | Links or unlinks all headers and footers to the corresponding
<br/>headers and footers in the previous section. |

##### Remarks

This collection contains the items of `WordProcessingHeaderFooter` type.

### link_to_previous method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingheaderfootercollection/link_to_previous.md

#### link_to_previous

Links or unlinks all headers and footers to the corresponding
headers and footers in the previous section.

```python
def link_to_previous(self, is_link_to_previous):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| is_link_to_previous | bool | True to link the headers and footers to the previous section;
<br/>false to unlink them. |

### WordProcessingHorizontalAlignment enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessinghorizontalalignment.md

#### WordProcessingHorizontalAlignment enumeration

Specifies horizontal alignment of a floating object.

The WordProcessingHorizontalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Object is explicitly positioned using its x-coordinate. |
| LEFT | Specifies that the object is left aligned to the horizontal alignment base. |
| CENTER | Specifies that the object is centered with respect to the horizontal alignment base. |
| RIGHT | Specifies that the object is right aligned to the horizontal alignment base. |
| INSIDE | Specifies that the object is inside of the horizontal alignment base. |
| OUTSIDE | Specifies that the object is outside of the horizontal alignment base. |

### WordProcessingPageSetup class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup.md

#### WordProcessingPageSetup class

Represents printing page properties for a section of a Word document.

The WordProcessingPageSetup type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| width | Gets the width of a printing page in points. |
| height | Gets the height of a printing page in points. |
| left_margin | Gets the size of the left margin in points. |
| top_margin | Gets the size of the top margin in points. |
| right_margin | Gets the size of the right margin in points. |
| bottom_margin | Gets the size of the bottom margin in points. |
| different_first_page_header_footer | Gets or sets a value indicating whether a different header/footer is used for the first page. |
| odd_and_even_pages_header_footer | Gets or sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered
<br/>pages.
<br/>Note, changing this property affects all sections in the content. |

### bottom_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/bottom_margin.md

#### bottom_margin property

Gets the size of the bottom margin in points.
##### Definition:
```python
@property
def bottom_margin(self):
    ...
```

### different_first_page_header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/different_first_page_header_footer.md

#### different_first_page_header_footer property

Gets or sets a value indicating whether a different header/footer is used for the first page.
##### Definition:
```python
@property
def different_first_page_header_footer(self):
    ...
@different_first_page_header_footer.setter
def different_first_page_header_footer(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/height.md

#### height property

Gets the height of a printing page in points.
##### Definition:
```python
@property
def height(self):
    ...
```

### left_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/left_margin.md

#### left_margin property

Gets the size of the left margin in points.
##### Definition:
```python
@property
def left_margin(self):
    ...
```

### odd_and_even_pages_header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/odd_and_even_pages_header_footer.md

#### odd_and_even_pages_header_footer property

Gets or sets a value indicating whether different headers/footers are used for odd-numbered and even-numbered
pages.
Note, changing this property affects all sections in the content.
##### Definition:
```python
@property
def odd_and_even_pages_header_footer(self):
    ...
@odd_and_even_pages_header_footer.setter
def odd_and_even_pages_header_footer(self, value):
    ...
```

### right_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/right_margin.md

#### right_margin property

Gets the size of the right margin in points.
##### Definition:
```python
@property
def right_margin(self):
    ...
```

### top_margin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/top_margin.md

#### top_margin property

Gets the size of the top margin in points.
##### Definition:
```python
@property
def top_margin(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingpagesetup/width.md

#### width property

Gets the width of a printing page in points.
##### Definition:
```python
@property
def width(self):
    ...
```

### WordProcessingProtectionType enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingprotectiontype.md

#### WordProcessingProtectionType enumeration

Represents protection type for a Word document.

The WordProcessingProtectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ONLY_REVISIONS | User can only add revision marks to the document. |
| ALLOW_ONLY_COMMENTS | User can only modify comments in the document. |
| ALLOW_ONLY_FORM_FIELDS | User can only enter data in the form fields in the document. |
| READ_ONLY | No changes are allowed to the document. |

### WordProcessingRelativeHorizontalPosition enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingrelativehorizontalposition.md

#### WordProcessingRelativeHorizontalPosition enumeration

Specifies to what the horizontal position of an object is relative.

The WordProcessingRelativeHorizontalPosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MARGIN | Specifies that the horizontal positioning is relative to the page margins. |
| PAGE | The object is positioned relative to the left edge of the page. |
| COLUMN | The object is positioned relative to the left side of the column. |
| CHARACTER | The object is positioned relative to the left side of the paragraph. |
| LEFT_MARGIN | Specifies that the horizontal positioning is relative to the left margin of the page. |
| RIGHT_MARGIN | Specifies that the horizontal positioning is relative to the right margin of the page. |
| INSIDE_MARGIN | Specifies that the horizontal positioning is relative to the inside margin
<br/>of the current page (the left margin on odd pages, right on even pages). |
| OUTSIDE_MARGIN | Specifies that the horizontal positioning is relative to the outside margin
<br/>of the current page (the right margin on odd pages, left on even pages). |

### WordProcessingRelativeVerticalPosition enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingrelativeverticalposition.md

#### WordProcessingRelativeVerticalPosition enumeration

Specifies to what the vertical position of an object is relative.

The WordProcessingRelativeVerticalPosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MARGIN | Specifies that the vertical positioning is relative to the page margins. |
| PAGE | The object is positioned relative to the top edge of the page. |
| PARAGRAPH | The object is positioned relative to the top of the paragraph that contains the anchor. |
| LINE | Undocumented feature. |
| TOP_MARGIN | Specifies that the vertical positioning is relative to the top margin of
<br/>the current page. |
| BOTTOM_MARGIN | Specifies that the vertical positioning is relative to the bottom margin
<br/>of the current page. |
| INSIDE_MARGIN | Specifies that the vertical positioning is relative to the inside margin
<br/>of the current page. |
| OUTSIDE_MARGIN | Specifies that the vertical positioning is relative to the outside margin
<br/>of the current page. |

### WordProcessingSection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection.md

#### WordProcessingSection class

Represents a Word document section.

**Inheritance:** `WordProcessingSection` →
`ContentPart`

The WordProcessingSection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| page_setup | Gets the printing page setup for this `WordProcessingSection`. |
| headers_footers | Gets the collection of all headers and footers of this `WordProcessingSection`. |
| shapes | Gets the collection of all shapes contained in this `WordProcessingSection`. |

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| find_images | Finds all images in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds possible watermarks according to specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds all possible watermarks in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### headers_footers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/headers_footers.md

#### headers_footers property

Gets the collection of all headers and footers of this `WordProcessingSection`.
##### Definition:
```python
@property
def headers_footers(self):
    ...
```

### page_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/page_setup.md

#### page_setup property

Gets the printing page setup for this `WordProcessingSection`.
##### Definition:
```python
@property
def page_setup(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### shapes property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsection/shapes.md

#### shapes property

Gets the collection of all shapes contained in this `WordProcessingSection`.
##### Definition:
```python
@property
def shapes(self):
    ...
```

### WordProcessingSectionCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingsectioncollection.md

#### WordProcessingSectionCollection class

Represents a collection of sections in a Word document.

The WordProcessingSectionCollection type exposes the following members:

##### Remarks

This collection contains the items of `WordProcessingSection` type.

### WordProcessingShape class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape.md

#### WordProcessingShape class

Represents a drawing shape in a Word document.

**Inheritance:** `WordProcessingShape` →
`ShapeSearchAdapter`

The WordProcessingShape type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| section | Gets the parent section of this `WordProcessingShape`. |
| header_footer | Gets the parent header/footer of this `WordProcessingShape` (if presents). |
| shape_type | Gets the shape type. |
| is_word_art | Gets a value indicating whether this `WordProcessingShape` is a WordArt object. |
| alternative_text | Gets or sets the descriptive (alternative) text associated with this `WordProcessingShape`. |
| name | Gets the name of this `WordProcessingShape`. |
| behind_text | Gets or sets a value indicating whether the shape is over or behind the text. |
| text | Gets or sets the text of this `WordProcessingShape`. |
| formatted_text_fragments | Gets the collection of formatted text fragments of this `WordProcessingShape`. |
| image | Gets or sets the image of this `WordProcessingShape`. |
| horizontal_alignment | Gets a value specifying how the shape is positioned horizontally. |
| vertical_alignment | Gets a value specifying how the shape is positioned vertically. |
| relative_horizontal_position | Gets a value specifying to what the shape is positioned horizontally. |
| relative_vertical_position | Gets a value specifying to what the shape is positioned vertically. |
| hyperlink | Gets or sets the hyperlink associated with this `WordProcessingShape`. |
| width | Gets or sets the width of this `WordProcessingShape` in points. |
| height | Gets or sets the height of this `WordProcessingShape` in points. |
| rotate_angle | Gets or sets the rotate angle of this `WordProcessingShape` in degrees. |
| x | Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points. |
| y | Gets or sets the vertical offset of this `WordProcessingShape` from page top border in points. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text associated with this `WordProcessingShape`.
##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### behind_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/behind_text.md

#### behind_text property

Gets or sets a value indicating whether the shape is over or behind the text.
##### Definition:
```python
@property
def behind_text(self):
    ...
@behind_text.setter
def behind_text(self, value):
    ...
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `WordProcessingShape`.
##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### header_footer property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/header_footer.md

#### header_footer property

Gets the parent header/footer of this `WordProcessingShape` (if presents).
##### Definition:
```python
@property
def header_footer(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/height.md

#### height property

Gets or sets the height of this `WordProcessingShape` in points.
##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/horizontal_alignment.md

#### horizontal_alignment property

Gets a value specifying how the shape is positioned horizontally.
##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
```

### hyperlink property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/hyperlink.md

#### hyperlink property

Gets or sets the hyperlink associated with this `WordProcessingShape`.
##### Definition:
```python
@property
def hyperlink(self):
    ...
@hyperlink.setter
def hyperlink(self, value):
    ...
```

### image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/image.md

#### image property

Gets or sets the image of this `WordProcessingShape`.
##### Definition:
```python
@property
def image(self):
    ...
@image.setter
def image(self, value):
    ...
```

### is_word_art property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/is_word_art.md

#### is_word_art property

Gets a value indicating whether this `WordProcessingShape` is a WordArt object.
##### Definition:
```python
@property
def is_word_art(self):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/name.md

#### name property

Gets the name of this `WordProcessingShape`.
##### Definition:
```python
@property
def name(self):
    ...
```

### relative_horizontal_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/relative_horizontal_position.md

#### relative_horizontal_position property

Gets a value specifying to what the shape is positioned horizontally.
##### Definition:
```python
@property
def relative_horizontal_position(self):
    ...
```

### relative_vertical_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/relative_vertical_position.md

#### relative_vertical_position property

Gets a value specifying to what the shape is positioned vertically.
##### Definition:
```python
@property
def relative_vertical_position(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/rotate_angle.md

#### rotate_angle property

Gets or sets the rotate angle of this `WordProcessingShape` in degrees.
##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### section property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/section.md

#### section property

Gets the parent section of this `WordProcessingShape`.
##### Definition:
```python
@property
def section(self):
    ...
```

### shape_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/shape_type.md

#### shape_type property

Gets the shape type.
##### Definition:
```python
@property
def shape_type(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/text.md

#### text property

Gets or sets the text of this `WordProcessingShape`.
##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/vertical_alignment.md

#### vertical_alignment property

Gets a value specifying how the shape is positioned vertically.
##### Definition:
```python
@property
def vertical_alignment(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/width.md

#### width property

Gets or sets the width of this `WordProcessingShape` in points.
##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/x.md

#### x property

Gets or sets the horizontal offset of this `WordProcessingShape` from page left border in points.
##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshape/y.md

#### y property

Gets or sets the vertical offset of this `WordProcessingShape` from page top border in points.
##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### WordProcessingShapeCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapecollection.md

#### WordProcessingShapeCollection class

Represents a collection of shapes in a Word document.

The WordProcessingShapeCollection type exposes the following members:

##### Remarks

This collection contains the items of `WordProcessingShape` type.

### WordProcessingShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapeformattedtextfragmentcollection.md

#### WordProcessingShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document shape.

**Inheritance:** `WordProcessingShapeFormattedTextFragmentCollection` →
`WordProcessingFormattedTextFragmentCollection` →
`FormattedTextFragmentCollection`

The WordProcessingShapeFormattedTextFragmentCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| collection_type | Gets the formatted fragment collection type. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |

##### Remarks

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapeformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapeformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### WordProcessingShapeType enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingshapetype.md

#### WordProcessingShapeType enumeration

Represents the type of a shape in a Word document.

The WordProcessingShapeType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| MIN_VALUE | Built-in shape type. |
| OLE_OBJECT | Built-in shape type. |
| GROUP | Built-in shape type. |
| NON_PRIMITIVE | Built-in shape type. |
| RECTANGLE | Built-in shape type. |
| ROUND_RECTANGLE | Built-in shape type. |
| ELLIPSE | Built-in shape type. |
| DIAMOND | Built-in shape type. |
| TRIANGLE | Built-in shape type. |
| RIGHT_TRIANGLE | Built-in shape type. |
| PARALLELOGRAM | Built-in shape type. |
| TRAPEZOID | Built-in shape type. |
| HEXAGON | Built-in shape type. |
| OCTAGON | Built-in shape type. |
| PLUS | Built-in shape type. |
| STAR | Built-in shape type. |
| ARROW | Built-in shape type. |
| THICK_ARROW | Built-in shape type. |
| HOME_PLATE | Built-in shape type. |
| CUBE | Built-in shape type. |
| BALLOON | Built-in shape type. |
| SEAL | Built-in shape type. |
| ARC | Built-in shape type. |
| LINE | Built-in shape type. |
| PLAQUE | Built-in shape type. |
| CAN | Built-in shape type. |
| DONUT | Built-in shape type. |
| TEXT_SIMPLE | Built-in shape type. |
| TEXT_OCTAGON | Built-in shape type. |
| TEXT_HEXAGON | Built-in shape type. |
| TEXT_CURVE | Built-in shape type. |
| TEXT_WAVE | Built-in shape type. |
| TEXT_RING | Built-in shape type. |
| TEXT_ON_CURVE | Built-in shape type. |
| TEXT_ON_RING | Built-in shape type. |
| STRAIGHT_CONNECTOR1 | Built-in shape type. |
| BENT_CONNECTOR2 | Built-in shape type. |
| BENT_CONNECTOR3 | Built-in shape type. |
| BENT_CONNECTOR4 | Built-in shape type. |
| BENT_CONNECTOR5 | Built-in shape type. |
| CURVED_CONNECTOR2 | Built-in shape type. |
| CURVED_CONNECTOR3 | Built-in shape type. |
| CURVED_CONNECTOR4 | Built-in shape type. |
| CURVED_CONNECTOR5 | Built-in shape type. |
| CALLOUT1 | Built-in shape type. |
| CALLOUT2 | Built-in shape type. |
| CALLOUT3 | Built-in shape type. |
| ACCENT_CALLOUT1 | Built-in shape type. |
| ACCENT_CALLOUT2 | Built-in shape type. |
| ACCENT_CALLOUT3 | Built-in shape type. |
| BORDER_CALLOUT1 | Built-in shape type. |
| BORDER_CALLOUT2 | Built-in shape type. |
| BORDER_CALLOUT3 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT1 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT2 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT3 | Built-in shape type. |
| RIBBON | Built-in shape type. |
| RIBBON2 | Built-in shape type. |
| CHEVRON | Built-in shape type. |
| PENTAGON | Built-in shape type. |
| NO_SMOKING | Built-in shape type. |
| SEAL8 | Built-in shape type. |
| SEAL16 | Built-in shape type. |
| SEAL32 | Built-in shape type. |
| WEDGE_RECT_CALLOUT | Built-in shape type. |
| WEDGE_R_RECT_CALLOUT | Built-in shape type. |
| WEDGE_ELLIPSE_CALLOUT | Built-in shape type. |
| WAVE | Built-in shape type. |
| FOLDED_CORNER | Built-in shape type. |
| LEFT_ARROW | Built-in shape type. |
| DOWN_ARROW | Built-in shape type. |
| UP_ARROW | Built-in shape type. |
| LEFT_RIGHT_ARROW | Built-in shape type. |
| UP_DOWN_ARROW | Built-in shape type. |
| IRREGULAR_SEAL1 | Built-in shape type. |
| IRREGULAR_SEAL2 | Built-in shape type. |
| LIGHTNING_BOLT | Built-in shape type. |
| HEART | Built-in shape type. |
| IMAGE | Built-in shape type. |
| QUAD_ARROW | Built-in shape type. |
| LEFT_ARROW_CALLOUT | Built-in shape type. |
| RIGHT_ARROW_CALLOUT | Built-in shape type. |
| UP_ARROW_CALLOUT | Built-in shape type. |
| DOWN_ARROW_CALLOUT | Built-in shape type. |
| LEFT_RIGHT_ARROW_CALLOUT | Built-in shape type. |
| UP_DOWN_ARROW_CALLOUT | Built-in shape type. |
| QUAD_ARROW_CALLOUT | Built-in shape type. |
| BEVEL | Built-in shape type. |
| LEFT_BRACKET | Built-in shape type. |
| RIGHT_BRACKET | Built-in shape type. |
| LEFT_BRACE | Built-in shape type. |
| RIGHT_BRACE | Built-in shape type. |
| LEFT_UP_ARROW | Built-in shape type. |
| BENT_UP_ARROW | Built-in shape type. |
| BENT_ARROW | Built-in shape type. |
| SEAL24 | Built-in shape type. |
| STRIPED_RIGHT_ARROW | Built-in shape type. |
| NOTCHED_RIGHT_ARROW | Built-in shape type. |
| BLOCK_ARC | Built-in shape type. |
| SMILEY_FACE | Built-in shape type. |
| VERTICAL_SCROLL | Built-in shape type. |
| HORIZONTAL_SCROLL | Built-in shape type. |
| CIRCULAR_ARROW | Built-in shape type. |
| CUSTOM_SHAPE | Built-in shape type. |
| UTURN_ARROW | Built-in shape type. |
| CURVED_RIGHT_ARROW | Built-in shape type. |
| CURVED_LEFT_ARROW | Built-in shape type. |
| CURVED_UP_ARROW | Built-in shape type. |
| CURVED_DOWN_ARROW | Built-in shape type. |
| CLOUD_CALLOUT | Built-in shape type. |
| ELLIPSE_RIBBON | Built-in shape type. |
| ELLIPSE_RIBBON2 | Built-in shape type. |
| FLOW_CHART_PROCESS | Built-in shape type. |
| FLOW_CHART_DECISION | Built-in shape type. |
| FLOW_CHART_INPUT_OUTPUT | Built-in shape type. |
| FLOW_CHART_PREDEFINED_PROCESS | Built-in shape type. |
| FLOW_CHART_INTERNAL_STORAGE | Built-in shape type. |
| FLOW_CHART_DOCUMENT | Built-in shape type. |
| FLOW_CHART_MULTIDOCUMENT | Built-in shape type. |
| FLOW_CHART_TERMINATOR | Built-in shape type. |
| FLOW_CHART_PREPARATION | Built-in shape type. |
| FLOW_CHART_MANUAL_INPUT | Built-in shape type. |
| FLOW_CHART_MANUAL_OPERATION | Built-in shape type. |
| FLOW_CHART_CONNECTOR | Built-in shape type. |
| FLOW_CHART_PUNCHED_CARD | Built-in shape type. |
| FLOW_CHART_PUNCHED_TAPE | Built-in shape type. |
| FLOW_CHART_SUMMING_JUNCTION | Built-in shape type. |
| FLOW_CHART_OR | Built-in shape type. |
| FLOW_CHART_COLLATE | Built-in shape type. |
| FLOW_CHART_SORT | Built-in shape type. |
| FLOW_CHART_EXTRACT | Built-in shape type. |
| FLOW_CHART_MERGE | Built-in shape type. |
| FLOW_CHART_OFFLINE_STORAGE | Built-in shape type. |
| FLOW_CHART_ONLINE_STORAGE | Built-in shape type. |
| FLOW_CHART_MAGNETIC_TAPE | Built-in shape type. |
| FLOW_CHART_MAGNETIC_DISK | Built-in shape type. |
| FLOW_CHART_MAGNETIC_DRUM | Built-in shape type. |
| FLOW_CHART_DISPLAY | Built-in shape type. |
| FLOW_CHART_DELAY | Built-in shape type. |
| TEXT_PLAIN_TEXT | Built-in shape type. |
| TEXT_STOP | Built-in shape type. |
| TEXT_TRIANGLE | Built-in shape type. |
| TEXT_TRIANGLE_INVERTED | Built-in shape type. |
| TEXT_CHEVRON | Built-in shape type. |
| TEXT_CHEVRON_INVERTED | Built-in shape type. |
| TEXT_RING_INSIDE | Built-in shape type. |
| TEXT_RING_OUTSIDE | Built-in shape type. |
| TEXT_ARCH_UP_CURVE | Built-in shape type. |
| TEXT_ARCH_DOWN_CURVE | Built-in shape type. |
| TEXT_CIRCLE_CURVE | Built-in shape type. |
| TEXT_BUTTON_CURVE | Built-in shape type. |
| TEXT_ARCH_UP_POUR | Built-in shape type. |
| TEXT_ARCH_DOWN_POUR | Built-in shape type. |
| TEXT_CIRCLE_POUR | Built-in shape type. |
| TEXT_BUTTON_POUR | Built-in shape type. |
| TEXT_CURVE_UP | Built-in shape type. |
| TEXT_CURVE_DOWN | Built-in shape type. |
| TEXT_CASCADE_UP | Built-in shape type. |
| TEXT_CASCADE_DOWN | Built-in shape type. |
| TEXT_WAVE1 | Built-in shape type. |
| TEXT_WAVE2 | Built-in shape type. |
| TEXT_WAVE3 | Built-in shape type. |
| TEXT_WAVE4 | Built-in shape type. |
| TEXT_INFLATE | Built-in shape type. |
| TEXT_DEFLATE | Built-in shape type. |
| TEXT_INFLATE_BOTTOM | Built-in shape type. |
| TEXT_DEFLATE_BOTTOM | Built-in shape type. |
| TEXT_INFLATE_TOP | Built-in shape type. |
| TEXT_DEFLATE_TOP | Built-in shape type. |
| TEXT_DEFLATE_INFLATE | Built-in shape type. |
| TEXT_DEFLATE_INFLATE_DEFLATE | Built-in shape type. |
| TEXT_FADE_RIGHT | Built-in shape type. |
| TEXT_FADE_LEFT | Built-in shape type. |
| TEXT_FADE_UP | Built-in shape type. |
| TEXT_FADE_DOWN | Built-in shape type. |
| TEXT_SLANT_UP | Built-in shape type. |
| TEXT_SLANT_DOWN | Built-in shape type. |
| TEXT_CAN_UP | Built-in shape type. |
| TEXT_CAN_DOWN | Built-in shape type. |
| FLOW_CHART_ALTERNATE_PROCESS | Built-in shape type. |
| FLOW_CHART_OFFPAGE_CONNECTOR | Built-in shape type. |
| CALLOUT90 | Built-in shape type. |
| ACCENT_CALLOUT90 | Built-in shape type. |
| BORDER_CALLOUT90 | Built-in shape type. |
| ACCENT_BORDER_CALLOUT90 | Built-in shape type. |
| LEFT_RIGHT_UP_ARROW | Built-in shape type. |
| SUN | Built-in shape type. |
| MOON | Built-in shape type. |
| BRACKET_PAIR | Built-in shape type. |
| BRACE_PAIR | Built-in shape type. |
| SEAL4 | Built-in shape type. |
| DOUBLE_WAVE | Built-in shape type. |
| ACTION_BUTTON_BLANK | Built-in shape type. |
| ACTION_BUTTON_HOME | Built-in shape type. |
| ACTION_BUTTON_HELP | Built-in shape type. |
| ACTION_BUTTON_INFORMATION | Built-in shape type. |
| ACTION_BUTTON_FORWARD_NEXT | Built-in shape type. |
| ACTION_BUTTON_BACK_PREVIOUS | Built-in shape type. |
| ACTION_BUTTON_END | Built-in shape type. |
| ACTION_BUTTON_BEGINNING | Built-in shape type. |
| ACTION_BUTTON_RETURN | Built-in shape type. |
| ACTION_BUTTON_DOCUMENT | Built-in shape type. |
| ACTION_BUTTON_SOUND | Built-in shape type. |
| ACTION_BUTTON_MOVIE | Built-in shape type. |
| OLE_CONTROL | Built-in shape type. |
| TEXT_BOX | Built-in shape type. |
| SINGLE_CORNER_SNIPPED | Built-in shape type. |
| TOP_CORNERS_SNIPPED | Built-in shape type. |
| DIAGONAL_CORNERS_SNIPPED | Built-in shape type. |
| TOP_CORNERS_ONE_ROUNDED_ONE_SNIPPED | Built-in shape type. |
| SINGLE_CORNER_ROUNDED | Built-in shape type. |
| TOP_CORNERS_ROUNDED | Built-in shape type. |
| DIAGONAL_CORNERS_ROUNDED | Built-in shape type. |

### WordProcessingTextFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment.md

#### WordProcessingTextFormattedTextFragment class

Represents a fragment of formatted text in a Word document.

**Inheritance:** `WordProcessingTextFormattedTextFragment` →
`FormattedTextFragment`

The WordProcessingTextFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | Gets the fragment text. |
| font | Gets the font of the text. |
| foreground_color | Gets the foreground color of the text. |
| background_color | Gets the background color of the text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/background_color.md

#### background_color property

Gets the background color of the text.
##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/font.md

#### font property

Gets the font of the text.
##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/foreground_color.md

#### foreground_color property

Gets the foreground color of the text.
##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragment/text.md

#### text property

Gets the fragment text.
##### Definition:
```python
@property
def text(self):
    ...
```

### WordProcessingTextFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragmentcollection.md

#### WordProcessingTextFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document main text.

**Inheritance:** `WordProcessingTextFormattedTextFragmentCollection` →
`WordProcessingFormattedTextFragmentCollection` →
`FormattedTextFragmentCollection`

The WordProcessingTextFormattedTextFragmentCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| collection_type | Gets the formatted fragment collection type. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |

##### Remarks

This collection contains the items of `WordProcessingTextFormattedTextFragment` type.

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingtextformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### WordProcessingVerticalAlignment enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingverticalalignment.md

#### WordProcessingVerticalAlignment enumeration

Specifies vertical alignment of a floating object.

The WordProcessingVerticalAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| INLINE | Not documented. Seems to be a possible value for floating paragraphs and tables. |
| NONE | The object is explicitly positioned using its y-coordinate. |
| TOP | Specifies that the object is at the top of the vertical alignment base. |
| CENTER | Specifies that the object is centered with respect to the vertical alignment bas. |
| BOTTOM | Specifies that the object is at the bottom of the vertical alignment base. |
| INSIDE | Specifies that the object is inside of the horizontal alignment base. |
| OUTSIDE | Specifies that the object is outside of the vertical alignment base. |

### WordProcessingWatermarkableImage class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage.md

#### WordProcessingWatermarkableImage class

Represents an image inside a Word document.

**Inheritance:** `WordProcessingWatermarkableImage` →
`WatermarkableImage` →
`ContentPart`

The WordProcessingWatermarkableImage type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data. |

##### Properties
| Property | Description |
| :- | :- |
| height | Gets the height of this `WatermarkableImage` in pixels. |
| width | Gets the width of this `WatermarkableImage` in pixels. |

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| find_images | Finds all images in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds possible watermarks according to specified search criteria.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search | Finds all possible watermarks in the content.
<br/>The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| add | Adds a watermark to this `WatermarkableImage`.
<br/>This method assumes that watermark offset and size are measured in pixels (if they are assigned). |
| get_bytes | Gets the image as byte array. |

### WordProcessingWatermarkableImage constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkableImage` class using specified image data.

```python
def __init__(self, image_data):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| image_data | bytes | The array of unsigned bytes from which to create the `WordProcessingWatermarkableImage`. |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/add.md

#### add

Adds a watermark to this `WatermarkableImage`.
This method assumes that watermark offset and size are measured in pixels (if they are assigned).

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | groupdocs.watermark.Watermark | The watermark to add to the image. |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### get_bytes method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/get_bytes.md

#### get_bytes

Gets the image as byte array.

##### Returns

The image data.

```python
def get_bytes(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/height.md

#### height property

Gets the height of this `WatermarkableImage` in pixels.

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwatermarkableimage/width.md

#### width property

Gets the width of this `WatermarkableImage` in pixels.

### WordProcessingWordArtShapeFormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment.md

#### WordProcessingWordArtShapeFormattedTextFragment class

Represents a fragment of formatted text in a WordArt shape.

**Inheritance:** `WordProcessingWordArtShapeFormattedTextFragment` →
`FormattedTextFragment`

The WordProcessingWordArtShapeFormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | Gets the fragment text. |
| font | Gets the font of the text. |
| foreground_color | Gets the foreground color of the text. |
| background_color | Gets the background color of the text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/background_color.md

#### background_color property

Gets the background color of the text.
##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/font.md

#### font property

Gets the font of the text.
##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/foreground_color.md

#### foreground_color property

Gets the foreground color of the text.
##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragment/text.md

#### text property

Gets the fragment text.
##### Definition:
```python
@property
def text(self):
    ...
```

### WordProcessingWordArtShapeFormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragmentcollection.md

#### WordProcessingWordArtShapeFormattedTextFragmentCollection class

Represents a collection of formatted text fragments in a Word document WordArt shape.

**Inheritance:** `WordProcessingWordArtShapeFormattedTextFragmentCollection` →
`WordProcessingFormattedTextFragmentCollection` →
`FormattedTextFragmentCollection`

The WordProcessingWordArtShapeFormattedTextFragmentCollection type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| collection_type | Gets the formatted fragment collection type. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |

##### Remarks

This collection contains the items of `WordProcessingWordArtShapeFormattedTextFragment` type.

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | System.String | The fragment text. |
| font | groupdocs.watermark.watermarks.Font | The font of the text. |
| foreground_color | groupdocs.watermark.watermarks.Color | The foreground color of the text. |
| background_color | groupdocs.watermark.watermarks.Color | The background color of the text. |

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.wordprocessing/wordprocessingwordartshapeformattedtextfragmentcollection/collection_type.md

#### collection_type property

Gets the formatted fragment collection type.

### groupdocs.watermark.contents
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents.md

Types under `groupdocs.watermark.contents`.

##### Classes
| Class | Description |
| :- | :- |
| `Content` | Represents a content where a watermark can be placed. |
| `ContentPart` | Represents any logical part of a content (page, frame, header, or a whole content) where a watermark can be placed. |
| `OfficeImageEffects` | Represents effects that can be applied to an image watermark for an office content. |
| `OfficeImageFillFormat` |  |
| `OfficeLineFormat` | Represents a shape line format. |
| `OfficeShapeSettings` | Represents settings that can be applied to a shape watermark for an office content. |
| `OfficeTextEffects` | Represents effects that can be applied to a text watermark for an office content. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `OfficeDashStyle` |  |
| `OfficeHeaderFooterType` |  |
| `OfficeLineStyle` |  |

### Content class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/content.md

#### Content class

Represents a content where a watermark can be placed.

The Content type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. (inherited from `ContentPart`) |
| find_images_image_search_criteria |  (inherited from `ContentPart`) |
| search | Finds possible watermarks according to the specified search criteria. (inherited from `ContentPart`) |
| search_search_criteria |  (inherited from `ContentPart`) |

### dispose method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/content/dispose.md

#### dispose

Disposes the current instance.

```python
def dispose(self):
    ...
```

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/content/find_images.md

#### find_images

Finds all images in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self):
    ...
```

#### find_images

Finds images according to the specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the found images.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.ImageSearchCriteria | The search criteria to use. |

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/content/search.md

#### search

Finds all possible watermarks in the content.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self):
    ...
```

#### search

Finds possible watermarks according to specified search criteria.
The search is conducted in the objects specified in `Watermarker.searchable_objects`.

##### Returns

The collection of the possible watermarks.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | groupdocs.watermark.search.searchcriteria.SearchCriteria | The search criteria to use. |

### ContentPart class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/contentpart.md

#### ContentPart class

Represents any logical part of a content (page, frame, header, or a whole content) where a watermark can be placed.

The ContentPart type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| find_images | Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| find_images | Finds all images in the content. |
| find_images_image_search_criteria |  |
| search | Finds possible watermarks according to the specified search criteria. |
| search | Finds all possible watermarks in the content. The search is conducted in the objects specified in `Watermarker.searchable_objects`. |
| search_search_criteria |  |

### find_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/contentpart/find_images.md

#### find_images

Finds images according to the specified search criteria. The search is conducted in the objects specified in `Watermarker.searchable_objects`.

```python
def find_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | `ImageSearchCriteria` | The search criteria to use. |

**Returns:** The collection of the found images.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    images = pdf_content.pages[0].find_images(searchCriteria=None)
    for image in images:
        image.add(watermark)

    watermarker.save("document.pdf")
```

#### find_images

Finds all images in the content.

The search is performed on the objects specified in `Watermarker.searchable_objects`.

```python
def find_images(self):
    ...
```

**Returns:** ``list[GroupDocs.Watermark.Image]`` – The collection of the found images.

### find_images_image_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/contentpart/find_images_image_search_criteria.md

#### find_images_image_search_criteria

```python
def find_images_image_search_criteria(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/contentpart/search.md

#### search

Finds possible watermarks according to the specified search criteria.

The search is conducted in the objects specified in `Watermarker.searchable_objects`.

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | `SearchCriteria` | The search criteria to use. |

**Returns:** The collection of the possible watermarks.

#### search

Finds all possible watermarks in the content. The search is conducted in the objects specified in `Watermarker.searchable_objects`.

```python
def search(self):
    ...
```

**Returns:** The collection of the possible watermarks.

### search_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/contentpart/search_search_criteria.md

#### search_search_criteria

```python
def search_search_criteria(self):
    ...
```

### OfficeDashStyle class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle.md

#### OfficeDashStyle class

The OfficeDashStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SOLID | Solid (continuous) pen. |
| DOT | Dot style. |
| DASH | Dash style. |
| DASH_DOT | Dash dot style. |
| DASH_DOT_DOT | Dash dot dot style. |

### DASH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle/dash.md

#### DASH field

Dash style.

##### Value
`2`

### DASH_DOT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle/dash_dot.md

#### DASH_DOT field

Dash dot style.

##### Value
`3`

### DASH_DOT_DOT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle/dash_dot_dot.md

#### DASH_DOT_DOT field

Dash dot dot style.

##### Value
`4`

### DOT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle/dot.md

#### DOT field

Dot style.

##### Value
`1`

### SOLID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officedashstyle/solid.md

#### SOLID field

Solid (continuous) pen.

##### Value
`0`

### OfficeHeaderFooterType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype.md

#### OfficeHeaderFooterType class

The OfficeHeaderFooterType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| HEADER_PRIMARY | Primary header, also used for odd numbered pages. |
| HEADER_EVEN | Header for even numbered pages. |
| HEADER_FIRST | Header for the first page. |
| FOOTER_PRIMARY | Primary footer, also used for odd numbered pages. |
| FOOTER_EVEN | Footer for even numbered pages. |
| FOOTER_FIRST | Footer for the first page. |

### FOOTER_EVEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/footer_even.md

#### FOOTER_EVEN field

Footer for even numbered pages.

##### Value
`4`

### FOOTER_FIRST field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/footer_first.md

#### FOOTER_FIRST field

Footer for the first page.

##### Value
`5`

### FOOTER_PRIMARY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/footer_primary.md

#### FOOTER_PRIMARY field

Primary footer, also used for odd numbered pages.

##### Value
`3`

### HEADER_EVEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/header_even.md

#### HEADER_EVEN field

Header for even numbered pages.

##### Value
`1`

### HEADER_FIRST field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/header_first.md

#### HEADER_FIRST field

Header for the first page.

##### Value
`2`

### HEADER_PRIMARY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeheaderfootertype/header_primary.md

#### HEADER_PRIMARY field

Primary header, also used for odd numbered pages.

##### Value
`0`

### OfficeImageEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects.md

#### OfficeImageEffects class

Represents effects that can be applied to an image watermark for an office content.

The OfficeImageEffects type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| border_line_format | The line format settings for the image border. |
| brightness | The brightness of the picture, a float between 0.0 (dimmest) and 1.0 (brightest); defaults to 0.5. |
| chroma_key | The color value of the image that will be treated as transparent. The default value is a fully transparent color. |
| contrast | The contrast for the specified picture, ranging from 0.0 (least contrast) to 1.0 (greatest contrast). The default value is 0.5. |
| gray_scale | The property indicates whether a picture will be displayed in grayscale mode. |

### border_line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects/border_line_format.md

#### border_line_format property

The line format settings for the image border.

##### Definition:
```python
@property
def border_line_format(self):
    ...
@border_line_format.setter
def border_line_format(self, value):
    ...
```

### brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects/brightness.md

#### brightness property

The brightness of the picture, a float between 0.0 (dimmest) and 1.0 (brightest); defaults to 0.5.

##### Definition:
```python
@property
def brightness(self):
    ...
@brightness.setter
def brightness(self, value):
    ...
```

### chroma_key property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects/chroma_key.md

#### chroma_key property

The color value of the image that will be treated as transparent. The default value is a fully transparent color.

##### Definition:
```python
@property
def chroma_key(self):
    ...
@chroma_key.setter
def chroma_key(self, value):
    ...
```

### contrast property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects/contrast.md

#### contrast property

The contrast for the specified picture, ranging from 0.0 (least contrast) to 1.0 (greatest contrast). The default value is 0.5.

##### Definition:
```python
@property
def contrast(self):
    ...
@contrast.setter
def contrast(self, value):
    ...
```

### gray_scale property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimageeffects/gray_scale.md

#### gray_scale property

The property indicates whether a picture will be displayed in grayscale mode.

The default value is False.

##### Definition:
```python
@property
def gray_scale(self):
    ...
@gray_scale.setter
def gray_scale(self, value):
    ...
```

### OfficeImageFillFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimagefillformat.md

#### OfficeImageFillFormat class

The OfficeImageFillFormat type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_image |  |
| tile_as_texture |  |
| transparency |  |

### background_image property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimagefillformat/background_image.md

##### Definition:
```python
@property
def background_image(self):
    ...
@background_image.setter
def background_image(self, value):
    ...
```

### tile_as_texture property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimagefillformat/tile_as_texture.md

##### Definition:
```python
@property
def tile_as_texture(self):
    ...
@tile_as_texture.setter
def tile_as_texture(self, value):
    ...
```

### transparency property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeimagefillformat/transparency.md

##### Definition:
```python
@property
def transparency(self):
    ...
@transparency.setter
def transparency(self, value):
    ...
```

### OfficeLineFormat class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat.md

#### OfficeLineFormat class

Represents a shape line format.

The OfficeLineFormat type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `OfficeLineFormat` class. |

##### Properties
| Property | Description |
| :- | :- |
| color | The color of the line. |
| dash_style | The dot and dash pattern for a line. |
| enabled | The enabled flag indicates whether a shape will be stroked. The default value is False. |
| line_style | The line style. The default value is `OfficeLineStyle.single`. |
| opacity | The line opacity. |
| weight | The line thickness in points that strokes the path of a shape. The default value is 0.75. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/__init__.md

#### __init__

Initializes a new instance of the `OfficeLineFormat` class.

```python
def __init__(self):
    ...
```

### color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/color.md

#### color property

The color of the line.

The default value is `Color.black`.

##### Definition:
```python
@property
def color(self):
    ...
@color.setter
def color(self, value):
    ...
```

### dash_style property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/dash_style.md

#### dash_style property

The dot and dash pattern for a line.

The default value is `OfficeDashStyle.solid`.

##### Definition:
```python
@property
def dash_style(self):
    ...
@dash_style.setter
def dash_style(self, value):
    ...
```

### enabled property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/enabled.md

#### enabled property

The enabled flag indicates whether a shape will be stroked. The default value is False.

##### Definition:
```python
@property
def enabled(self):
    ...
@enabled.setter
def enabled(self, value):
    ...
```

### line_style property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/line_style.md

#### line_style property

The line style. The default value is `OfficeLineStyle.single`.

##### Definition:
```python
@property
def line_style(self):
    ...
@line_style.setter
def line_style(self, value):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/opacity.md

#### opacity property

The line opacity.

The value should be between 0 and 1. Default value is 1.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### weight property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelineformat/weight.md

#### weight property

The line thickness in points that strokes the path of a shape. The default value is 0.75.

##### Definition:
```python
@property
def weight(self):
    ...
@weight.setter
def weight(self, value):
    ...
```

### OfficeLineStyle class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle.md

#### OfficeLineStyle class

The OfficeLineStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| SINGLE | Single line. |
| DOUBLE | Double lines of equal width. |
| THICK_THIN | Double lines, one thick, one thin. |
| THIN_THICK | Double lines, one thin, one thick. |
| TRIPLE | Three lines, thin, thick, thin. |

### DOUBLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle/double.md

#### DOUBLE field

Double lines of equal width.

##### Value
`1`

### SINGLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle/single.md

#### SINGLE field

Single line.

##### Value
`0`

### THICK_THIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle/thick_thin.md

#### THICK_THIN field

Double lines, one thick, one thin.

##### Value
`2`

### THIN_THICK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle/thin_thick.md

#### THIN_THICK field

Double lines, one thin, one thick.

##### Value
`3`

### TRIPLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officelinestyle/triple.md

#### TRIPLE field

Three lines, thin, thick, thin.

##### Value
`4`

### OfficeShapeSettings class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeshapesettings.md

#### OfficeShapeSettings class

Represents settings that can be applied to a shape watermark for an office content.

The OfficeShapeSettings type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. |
| name | The name of the shape. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeshapesettings/alternative_text.md

#### alternative_text property

The descriptive (alternative) text that will be associated with a shape.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officeshapesettings/name.md

#### name property

The name of the shape.

The shape name.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### OfficeTextEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officetexteffects.md

#### OfficeTextEffects class

Represents effects that can be applied to a text watermark for an office content.

The OfficeTextEffects type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| line_format | The line format settings. |

### line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.contents/officetexteffects/line_format.md

#### line_format property

The line format settings.

Provides an instance of `OfficeLineFormat` that defines the shape line format.

##### Definition:
```python
@property
def line_format(self):
    ...
@line_format.setter
def line_format(self, value):
    ...
```

### groupdocs.watermark.exceptions
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions.md

The namespace provides different exceptions classes.

##### Classes
| Class | Description |
| :- | :- |
| `DetachedImageException` | The exception that is thrown when manipulating detached image. |
| `EncryptionIsNotSupportedException` | The exception that is thrown when content encryption is not supported. |
| `FontNotFoundException` | The exception that is thrown when requested font is not found. |
| `ImageEffectsForTextWatermarkException` | The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`. |
| `InvalidPasswordException` | The exception that is thrown when supplied password is incorrect. |
| `PreviewNotSupportedException` | The exception that is thrown when a preview image cannot be generated for the content. |
| `TextEffectsForImageWatermarkException` | The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`. |
| `UnexpectedDocumentStructureException` | The exception that is thrown when a content cannot be parsed due to unexpected structure. |
| `UnknownLoadOptionsTypeException` | The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`. |
| `UnknownWatermarkOptionsTypeException` | The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`. |
| `UnsupportedFileTypeException` | The exception that is thrown when a file cannot be loaded. |
| `WatermarkException` | Represents base exception in **GroupDocs.Watermark**  product. |

### DetachedImageException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/detachedimageexception.md

#### DetachedImageException class

The exception that is thrown when manipulating detached image.

**Inheritance:** `DetachedImageException` →
`WatermarkException`

The DetachedImageException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `DetachedImageException` class. |

### DetachedImageException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/detachedimageexception/__init__.md

#### __init__

Initializes a new instance of the `DetachedImageException` class.

```python
def __init__(self):
    ...
```

### EncryptionIsNotSupportedException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/encryptionisnotsupportedexception.md

#### EncryptionIsNotSupportedException class

The exception that is thrown when content encryption is not supported.

**Inheritance:** `EncryptionIsNotSupportedException` →
`WatermarkException`

The EncryptionIsNotSupportedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EncryptionIsNotSupportedException` class. |

### EncryptionIsNotSupportedException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/encryptionisnotsupportedexception/__init__.md

#### __init__

Initializes a new instance of the `EncryptionIsNotSupportedException` class.

```python
def __init__(self):
    ...
```

### FontNotFoundException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/fontnotfoundexception.md

#### FontNotFoundException class

The exception that is thrown when requested font is not found.

**Inheritance:** `FontNotFoundException` →
`WatermarkException`

The FontNotFoundException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `FontNotFoundException` class. |
| __init__ | Initializes a new instance of the `FontNotFoundException` class with a specified font name. |

##### Properties
| Property | Description |
| :- | :- |
| font_name | Gets the requested font name. |

### FontNotFoundException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/fontnotfoundexception/__init__.md

#### __init__

Initializes a new instance of the `FontNotFoundException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `FontNotFoundException` class with a specified font name.

```python
def __init__(self, font_name):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_name | System.String | The requested font name. |

### font_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/fontnotfoundexception/font_name.md

#### font_name property

Gets the requested font name.
##### Definition:
```python
@property
def font_name(self):
    ...
```

### ImageEffectsForTextWatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/imageeffectsfortextwatermarkexception.md

#### ImageEffectsForTextWatermarkException class

The exception that is thrown when `OfficeImageEffects` is supplied for `TextWatermark`.

**Inheritance:** `ImageEffectsForTextWatermarkException` →
`WatermarkException`

The ImageEffectsForTextWatermarkException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageEffectsForTextWatermarkException` class. |

### ImageEffectsForTextWatermarkException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/imageeffectsfortextwatermarkexception/__init__.md

#### __init__

Initializes a new instance of the `ImageEffectsForTextWatermarkException` class.

```python
def __init__(self):
    ...
```

### InvalidPasswordException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/invalidpasswordexception.md

#### InvalidPasswordException class

The exception that is thrown when supplied password is incorrect.

**Inheritance:** `InvalidPasswordException` →
`WatermarkException`

The InvalidPasswordException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `InvalidPasswordException` class. |

### InvalidPasswordException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/invalidpasswordexception/__init__.md

#### __init__

Initializes a new instance of the `InvalidPasswordException` class.

```python
def __init__(self):
    ...
```

### PreviewNotSupportedException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/previewnotsupportedexception.md

#### PreviewNotSupportedException class

The exception that is thrown when a preview image cannot be generated for the content.

**Inheritance:** `PreviewNotSupportedException` →
`WatermarkException`

The PreviewNotSupportedException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PreviewNotSupportedException` class. |

### PreviewNotSupportedException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/previewnotsupportedexception/__init__.md

#### __init__

Initializes a new instance of the `PreviewNotSupportedException` class.

```python
def __init__(self):
    ...
```

### TextEffectsForImageWatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/texteffectsforimagewatermarkexception.md

#### TextEffectsForImageWatermarkException class

The exception that is thrown when `OfficeTextEffects` is supplied for `ImageWatermark`.

**Inheritance:** `TextEffectsForImageWatermarkException` →
`WatermarkException`

The TextEffectsForImageWatermarkException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextEffectsForImageWatermarkException` class. |

### TextEffectsForImageWatermarkException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/texteffectsforimagewatermarkexception/__init__.md

#### __init__

Initializes a new instance of the `TextEffectsForImageWatermarkException` class.

```python
def __init__(self):
    ...
```

### UnexpectedDocumentStructureException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unexpecteddocumentstructureexception.md

#### UnexpectedDocumentStructureException class

The exception that is thrown when a content cannot be parsed due to unexpected structure.

**Inheritance:** `UnexpectedDocumentStructureException` →
`WatermarkException`

The UnexpectedDocumentStructureException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `UnexpectedDocumentStructureException` class. |

### UnexpectedDocumentStructureException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unexpecteddocumentstructureexception/__init__.md

#### __init__

Initializes a new instance of the `UnexpectedDocumentStructureException` class.

```python
def __init__(self):
    ...
```

### UnknownLoadOptionsTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unknownloadoptionstypeexception.md

#### UnknownLoadOptionsTypeException class

The exception that is thrown when a document cannot be loaded with supplied `LoadOptions`.

**Inheritance:** `UnknownLoadOptionsTypeException` →
`WatermarkException`

The UnknownLoadOptionsTypeException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `UnknownLoadOptionsTypeException` class. |

### UnknownLoadOptionsTypeException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unknownloadoptionstypeexception/__init__.md

#### __init__

Initializes a new instance of the `UnknownLoadOptionsTypeException` class.

```python
def __init__(self):
    ...
```

### UnknownWatermarkOptionsTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unknownwatermarkoptionstypeexception.md

#### UnknownWatermarkOptionsTypeException class

The exception that is thrown when a watermark cannot be added with supplied `WatermarkOptions`.

**Inheritance:** `UnknownWatermarkOptionsTypeException` →
`WatermarkException`

The UnknownWatermarkOptionsTypeException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class. |

### UnknownWatermarkOptionsTypeException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unknownwatermarkoptionstypeexception/__init__.md

#### __init__

Initializes a new instance of the `UnknownWatermarkOptionsTypeException` class.

```python
def __init__(self):
    ...
```

### UnsupportedFileTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unsupportedfiletypeexception.md

#### UnsupportedFileTypeException class

The exception that is thrown when a file cannot be loaded.

**Inheritance:** `UnsupportedFileTypeException` →
`WatermarkException`

The UnsupportedFileTypeException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `UnsupportedFileTypeException` class. |

### UnsupportedFileTypeException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/unsupportedfiletypeexception/__init__.md

#### __init__

Initializes a new instance of the `UnsupportedFileTypeException` class.

```python
def __init__(self):
    ...
```

### WatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/watermarkexception.md

#### WatermarkException class

Represents base exception in **GroupDocs.Watermark**  product.

The WatermarkException type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WatermarkException` class. |
| __init__ | Initializes a new instance of the `WatermarkException` class with a specified error message. |

### WatermarkException constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.exceptions/watermarkexception/__init__.md

#### __init__

Initializes a new instance of the `WatermarkException` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `WatermarkException` class with a specified error message.

```python
def __init__(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | System.String | The message that describes the error. |

### groupdocs.watermark.internal
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal.md

Types under `groupdocs.watermark.internal`.

##### Classes
| Class | Description |
| :- | :- |
| `WatermarkResult` | Represents the result of watermarking operation, including details such as document sizes, processing time, and the number of applied watermarks. |

### WatermarkResult class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult.md

#### WatermarkResult class

Represents the result of watermarking operation, including details such as document sizes, processing time, and the number of applied watermarks.

The WatermarkResult type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WatermarkResult` class. |
| __init__ | Initializes a new instance of `WatermarkResult` with specific values. |

##### Properties
| Property | Description |
| :- | :- |
| final_document_size | The size of the final processed document in bytes. |
| number_watermarks_applied | The total number of watermarks applied to the document. |
| processing_time | The processing time for the watermarking operation. |
| source_document_size | The size of the source document in bytes. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult/__init__.md

#### __init__

Initializes a new instance of the `WatermarkResult` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of `WatermarkResult` with specific values.

```python
def __init__(self, source_document_size, processing_time, final_document_size, number_watermarks_applied):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| source_document_size | `int` | The size of the source document in bytes. |
| processing_time | `timedelta` | The processing time in milliseconds. |
| final_document_size | `int` | The size of the final processed document in bytes. |
| number_watermarks_applied | `int` | The total number of watermarks applied to the document. |

### final_document_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult/final_document_size.md

#### final_document_size property

The size of the final processed document in bytes.

##### Definition:
```python
@property
def final_document_size(self):
    ...
```

### number_watermarks_applied property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult/number_watermarks_applied.md

#### number_watermarks_applied property

The total number of watermarks applied to the document.

##### Definition:
```python
@property
def number_watermarks_applied(self):
    ...
```

### processing_time property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult/processing_time.md

#### processing_time property

The processing time for the watermarking operation.

##### Definition:
```python
@property
def processing_time(self):
    ...
```

### source_document_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.internal/watermarkresult/source_document_size.md

#### source_document_size property

The size of the source document in bytes.

##### Definition:
```python
@property
def source_document_size(self):
    ...
```

### groupdocs.watermark.options.diagram
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram.md

Types under `groupdocs.watermark.options.diagram`.

##### Classes
| Class | Description |
| :- | :- |
| `DiagramLoadOptions` | Represents document loading options for a Visio document. |
| `DiagramPageWatermarkOptions` | Represents watermark adding options when adding a shape watermark to a particular page of a Visio document. |
| `DiagramPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of a Diagram document. |
| `DiagramSaveOptions` | Represents document saving options when saving a Visio document. |
| `DiagramShapeWatermarkOptions` | Represents watermark adding options when adding shape watermark to a Visio document. |
| `DiagramWatermarkOptions` | Represents the base class for watermark adding options to a Visio document. |

### DiagramLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions.md

#### DiagramLoadOptions class

Represents document loading options for a Visio document.

The DiagramLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the DiagramLoadOptions class. |
| __init__ | Initializes a new instance of the DiagramLoadOptions class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    # manipulate shapes, e.g., replace text or images
    watermarker.save("diagram.vsdx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions/__init__.md

#### __init__

Initializes a new instance of the DiagramLoadOptions class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the DiagramLoadOptions class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted Visio document. |

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### DiagramPageWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions.md

#### DiagramPageWatermarkOptions class

Represents watermark adding options when adding a shape watermark to a particular page of a Visio document.

Learn more: https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents

The DiagramPageWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `DiagramPageWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_index | The page index to add watermark to. |
| is_locked | The lock state of the shape in Visio. If true, shape editing is forbidden. (inherited from `DiagramWatermarkOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
from groupdocs.watermark import Watermarker, DiagramLoadOptions, TextWatermark, DiagramPageWatermarkOptions, Font

load_options = DiagramLoadOptions()
with Watermarker(r"D:\test.vsdx", load_options) as watermarker:
    watermark = TextWatermark("watermark test", Font("Arial", 42))
    options = DiagramPageWatermarkOptions()
    options.is_locked = True
    options.page_index = 0
    watermarker.add(watermark, options)
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `DiagramPageWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Visio is forbidden.

##### Remarks

By default, the value is false, the shape can be edited in Visio.

### page_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampagewatermarkoptions/page_index.md

#### page_index property

The page index to add watermark to.

##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### DiagramPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions.md

#### DiagramPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of a Diagram document.

The DiagramPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new DiagramPreviewOptions instance that causes the output stream to be closed. |
| __init__ | Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| high_quality_rendering | The flag for high quality rendering. |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/__init__.md

#### __init__

Initializes a new DiagramPreviewOptions instance that causes the output stream to be closed.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `DiagramPreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### high_quality_rendering property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/high_quality_rendering.md

#### high_quality_rendering property

The flag for high quality rendering.

The high quality rendering uses more resources. The default value is False.

##### Definition:
```python
@property
def high_quality_rendering(self):
    ...
@high_quality_rendering.setter
def high_quality_rendering(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/resolution.md

#### resolution property

The resolution for the generated images, in dots per inch.

The default value is 300.

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagrampreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### DiagramSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramsaveoptions.md

#### DiagramSaveOptions class

Represents document saving options when saving a Visio document.

The DiagramSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the DiagramSaveOptions class. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramsaveoptions/__init__.md

#### __init__

Initializes a new instance of the DiagramSaveOptions class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### DiagramShapeWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions.md

#### DiagramShapeWatermarkOptions class

Represents watermark adding options when adding shape watermark to a Visio document.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+diagram+documents

The DiagramShapeWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `DiagramShapeWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| placement_type | The value specifying to what pages a watermark should be added. |
| is_locked | The lock state of the shape in Visio. If true, shape editing is forbidden. (inherited from `DiagramWatermarkOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
from groupdocs.watermark import (
    Watermarker,
    DiagramLoadOptions,
    TextWatermark,
    Font,
    DiagramShapeWatermarkOptions,
    DiagramWatermarkPlacementType,
)

load_options = DiagramLoadOptions()
with Watermarker(r"D:\test.vsdx", load_options) as watermarker:
    watermark = TextWatermark("watermark test", Font("Arial", 42))
    options = DiagramShapeWatermarkOptions()
    options.is_locked = True
    options.placement_type = DiagramWatermarkPlacementType.ALL_PAGES  # default
    watermarker.add(watermark, options)
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `DiagramShapeWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Visio is forbidden.

##### Remarks

By default, the value is false, the shape can be edited in Visio.

### placement_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramshapewatermarkoptions/placement_type.md

#### placement_type property

The value specifying to what pages a watermark should be added.

##### Definition:
```python
@property
def placement_type(self):
    ...
@placement_type.setter
def placement_type(self, value):
    ...
```

### DiagramWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramwatermarkoptions.md

#### DiagramWatermarkOptions class

Represents the base class for watermark adding options to a Visio document.

The DiagramWatermarkOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| is_locked | The lock state of the shape in Visio. If true, shape editing is forbidden. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.diagram/diagramwatermarkoptions/is_locked.md

#### is_locked property

The lock state of the shape in Visio. If true, shape editing is forbidden.

By default, the value is False; the shape can be edited in Visio.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### groupdocs.watermark.options.email
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email.md

Types under `groupdocs.watermark.options.email`.

##### Classes
| Class | Description |
| :- | :- |
| `EmailLoadOptions` | Represents the document loading options for an email message. |
| `EmailPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of an email document. |
| `EmailSaveOptions` | Represents the document saving options when saving an email message. |

### EmailLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions.md

#### EmailLoadOptions class

Represents the document loading options for an email message.

The EmailLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailLoadOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    # work with the email content, e.g., add or extract attachments
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions/__init__.md

#### __init__

Initializes a new instance of the `EmailLoadOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions/default.md

#### DEFAULT field

Gets the default value for class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### EmailPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions.md

#### EmailPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of an email document.

The EmailPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new EmailPreviewOptions instance that closes the output stream. |
| __init__ | Initializes a new EmailPreviewOptions instance that returns the output stream to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/__init__.md

#### __init__

Initializes a new EmailPreviewOptions instance that closes the output stream.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new EmailPreviewOptions instance that returns the output stream to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/resolution.md

#### resolution property

The resolution for the 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/watermark/python-net/groupdocs.watermark.options.email/emailpreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### EmailSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailsaveoptions.md

#### EmailSaveOptions class

Represents the document saving options when saving an email message.

The EmailSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `EmailSaveOptions` class. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailsaveoptions/__init__.md

#### __init__

Initializes a new instance of the `EmailSaveOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.email/emailsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### groupdocs.watermark.options.image
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image.md

Types under `groupdocs.watermark.options.image`.

##### Classes
| Class | Description |
| :- | :- |
| `GifImageLoadOptions` | Represents image loading options for a GIF image. |
| `GifImageSaveOptions` | Represents image saving options when saving a GIF image. |
| `GifImageWatermarkOptions` | Represents watermark adding options when adding watermark to a GIF image. |
| `ImageLoadOptions` | Represents image loading options when loading an image. |
| `ImageSaveOptions` | Represents image saving options when saving an image. |
| `MultiframeImageLoadOptions` | Represents image loading options when loading a multiframe image. |
| `MultiframeImageWatermarkOptions` | Represents watermark adding options when adding a watermark to a multi-frame image. |
| `TiffImageLoadOptions` | Represents image loading options for a TIFF image. |
| `TiffImageSaveOptions` | Represents image saving options when saving a TIFF image. |
| `TiffImageWatermarkOptions` | Represents watermark adding options when adding a watermark to a TIFF image. |

### GifImageLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions.md

#### GifImageLoadOptions class

Represents image loading options for a GIF image.

The GifImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `GifImageLoadOptions` instance. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions/__init__.md

#### __init__

Initializes a new `GifImageLoadOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions/default.md

#### DEFAULT field

Gets the default value for class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimageloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### GifImageSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagesaveoptions.md

#### GifImageSaveOptions class

Represents image saving options when saving a GIF image.

The GifImageSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `GifImageSaveOptions` instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagesaveoptions/__init__.md

#### __init__

Initializes a new `GifImageSaveOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagesaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### GifImageWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagewatermarkoptions.md

#### GifImageWatermarkOptions class

Represents watermark adding options when adding watermark to a GIF image.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images

The GifImageWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the GifImageWatermarkOptions class. |
| __init__ | Initializes a new GifImageWatermarkOptions with a specified frame index. |

##### Properties
| Property | Description |
| :- | :- |
| frame_index | The index of the frame to add a watermark. (inherited from `MultiframeImageWatermarkOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.GifImageLoadOptions()
with gw.Watermarker("test.gif", load_options) as watermarker:
    watermark = gww.TextWatermark("Test", gww.Font("Arial", 12))
    options = gwo_img.GifImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagewatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the GifImageWatermarkOptions class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new GifImageWatermarkOptions with a specified frame index.

```python
def __init__(self, frame_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_index | `int` | The index of the frame to add the watermark. |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagewatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### frame_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/gifimagewatermarkoptions/frame_index.md

#### frame_index property

Gets or sets the index of frame to add watermark.

##### Remarks

-1 means all frames.

### ImageLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions.md

#### ImageLoadOptions class

Represents image loading options when loading an image.

The ImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageLoadOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions/__init__.md

#### __init__

Initializes a new instance of the `ImageLoadOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imageloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### ImageSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imagesaveoptions.md

#### ImageSaveOptions class

Represents image saving options when saving an image.

The ImageSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageSaveOptions` class. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imagesaveoptions/__init__.md

#### __init__

Initializes a new instance of the `ImageSaveOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/imagesaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### MultiframeImageLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions.md

#### MultiframeImageLoadOptions class

Represents image loading options when loading a multiframe image.

The MultiframeImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `MultiframeImageLoadOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions/__init__.md

#### __init__

Initializes a new instance of the `MultiframeImageLoadOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimageloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### MultiframeImageWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions.md

#### MultiframeImageWatermarkOptions class

Represents watermark adding options when adding a watermark to a multi-frame image.

Learn more:
- [Add watermarks to images](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images)

The MultiframeImageWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `MultiframeImageWatermarkOptions` class. |
| __init__ | Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified frame index. |

##### Properties
| Property | Description |
| :- | :- |
| frame_index | The index of the frame to add a watermark. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
from groupdocs.watermark import Watermarker, ImageLoadOptions, TextWatermark, Font, MultiframeImageWatermarkOptions

load_options = ImageLoadOptions()
with Watermarker(r"C:\test.gif", load_options) as watermarker:
    watermark = TextWatermark("Test", Font("Arial", 12))
    options = MultiframeImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `MultiframeImageWatermarkOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `MultiframeImageWatermarkOptions` class with a specified frame index.

```python
def __init__(self, frame_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_index | `int` | The index of the frame to add the watermark. |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### frame_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/multiframeimagewatermarkoptions/frame_index.md

#### frame_index property

The index of the frame to add a watermark.

-1 means all frames.

##### Definition:
```python
@property
def frame_index(self):
    ...
@frame_index.setter
def frame_index(self, value):
    ...
```

### TiffImageLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions.md

#### TiffImageLoadOptions class

Represents image loading options for a TIFF image.

The TiffImageLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TiffImageLoadOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.TiffImageLoadOptions()
with gw.Watermarker("image.tiff", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_img.TiffImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save("image.tiff")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions/__init__.md

#### __init__

Initializes a new instance of the `TiffImageLoadOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.TiffImageLoadOptions()
with gw.Watermarker("image.tiff", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_img.TiffImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save("image.tiff")
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions/default.md

#### DEFAULT field

Gets the default value for class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimageloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### TiffImageSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagesaveoptions.md

#### TiffImageSaveOptions class

Represents image saving options when saving a TIFF image.

The TiffImageSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `TiffImageSaveOptions` instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagesaveoptions/__init__.md

#### __init__

Initializes a new `TiffImageSaveOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagesaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### TiffImageWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagewatermarkoptions.md

#### TiffImageWatermarkOptions class

Represents watermark adding options when adding a watermark to a TIFF image.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+images

The TiffImageWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TiffImageWatermarkOptions` class. |
| __init__ | Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified frame index. |

##### Properties
| Property | Description |
| :- | :- |
| frame_index | The index of the frame to add a watermark. (inherited from `MultiframeImageWatermarkOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.TiffImageLoadOptions()
with gw.Watermarker("image.tiff", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_img.TiffImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save("image.tiff")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagewatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `TiffImageWatermarkOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.TiffImageLoadOptions()
with gw.Watermarker("image.tiff", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_img.TiffImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save("image.tiff")
```

#### __init__

Initializes a new instance of the `TiffImageWatermarkOptions` class with a specified frame index.

```python
def __init__(self, frame_index):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| frame_index | `int` | The index of the frame to add watermark. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.image as gwo_img

load_options = gw.TiffImageLoadOptions()
with gw.Watermarker("image.tiff", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_img.TiffImageWatermarkOptions()
    options.frame_index = 0
    watermarker.add(watermark, options)
    watermarker.save("image.tiff")
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagewatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### frame_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.image/tiffimagewatermarkoptions/frame_index.md

#### frame_index property

Gets or sets the index of frame to add watermark.

##### Remarks

-1 means all frames.

### groupdocs.watermark.options.pdf
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf.md

Types under `groupdocs.watermark.options.pdf`.

##### Classes
| Class | Description |
| :- | :- |
| `PdfAnnotationWatermarkOptions` | Represents watermark adding options when adding annotation watermark to a PDF document. |
| `PdfArtifactWatermarkOptions` | Represents watermark adding options when adding an artifact watermark to a PDF document. |
| `PdfLoadOptions` | Represents document loading options for a PDF document. |
| `PdfPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of PDF documents. |
| `PdfSaveOptions` | Represents document saving options when saving a pdf document. |
| `PdfXObjectWatermarkOptions` | Represents watermark adding options when adding XObject watermark to a pdf document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PdfWatermarkOptions` | Represents the base class for watermark adding options to a PDF document. |

### PdfAnnotationWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions.md

#### PdfAnnotationWatermarkOptions class

Represents watermark adding options when adding annotation watermark to a PDF document.

Learn more: Add watermarks to PDF documents (https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents).

The PdfAnnotationWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PdfAnnotationWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_index | The page index to add watermark to. |
| print_only | The value indicating whether annotation will be printed, but not displayed in PDF viewing applications. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.pdf as gwo_pdf
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    options = gwo_pdf.PdfAnnotationWatermarkOptions()
    options.page_index = -1  # default - all pages

    text_watermark = gww.TextWatermark("Annotation watermark", gww.Font("Arial", 8.0))
    text_watermark.horizontal_alignment = gwc.HorizontalAlignment.LEFT
    text_watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermarker.add(text_watermark, options)

    with gww.ImageWatermark("protect.jpg") as image_watermark:
        image_watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
        image_watermark.vertical_alignment = gwc.VerticalAlignment.TOP
        watermarker.add(image_watermark, options)

    watermarker.save("document.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `PdfAnnotationWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### page_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/page_index.md

#### page_index property

The page index to add watermark to.

-1 means all pages.

##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### print_only property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfannotationwatermarkoptions/print_only.md

#### print_only property

The value indicating whether annotation will be printed, but not displayed in PDF viewing applications.

##### Definition:
```python
@property
def print_only(self):
    ...
@print_only.setter
def print_only(self, value):
    ...
```

### PdfArtifactWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions.md

#### PdfArtifactWatermarkOptions class

Represents watermark adding options when adding an artifact watermark to a PDF document.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents

The PdfArtifactWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PdfArtifactWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_index | The page index to add the watermark to. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.pdf as gwo_pdf
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.ImageWatermark("icon.png")
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.BOTTOM

    options = gwo_pdf.PdfArtifactWatermarkOptions()
    options.page_index = -1  # default - all pages

    watermarker.add(watermark, options)
    watermarker.save("document.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `PdfArtifactWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### page_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfartifactwatermarkoptions/page_index.md

#### page_index property

The page index to add the watermark to.

##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### PdfLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions.md

#### PdfLoadOptions class

Represents document loading options for a PDF document.

The PdfLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PdfLoadOptions` class. |
| __init__ | Initializes a new instance of the `PdfLoadOptions` class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PdfLoadOptions()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions/__init__.md

#### __init__

Initializes a new instance of the `PdfLoadOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PdfLoadOptions()
```

#### __init__

Initializes a new instance of the `PdfLoadOptions` class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted document. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    print(pdf_content.pages[0].width)
    print(pdf_content.pages[0].height)
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### PdfPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions.md

#### PdfPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of PDF documents.

The PdfPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PdfPreviewOptions instance that causes the output stream to be closed. |
| __init__ | Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/__init__.md

#### __init__

Initializes a new PdfPreviewOptions instance that causes the output stream to be closed.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `PdfPreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/resolution.md

#### resolution property

The resolution for the generated images, in dots per inch.

The default value is 150.

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfpreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### PdfSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfsaveoptions.md

#### PdfSaveOptions class

Represents document saving options when saving a pdf document.

The PdfSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PdfSaveOptions` class. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfsaveoptions/__init__.md

#### __init__

Initializes a new instance of the `PdfSaveOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### PdfWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfwatermarkoptions.md

#### PdfWatermarkOptions class

Represents the base class for watermark adding options to a PDF document.

The PdfWatermarkOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### PdfXObjectWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions.md

#### PdfXObjectWatermarkOptions class

Represents watermark adding options when adding XObject watermark to a pdf document.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+PDF+documents

The PdfXObjectWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PdfXObjectWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_index | The page index to add the watermark to. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
from groupdocs.watermark import Watermarker, ImageWatermark, PdfLoadOptions, PdfXObjectWatermarkOptions

load_options = PdfLoadOptions()
with Watermarker(r"C:\doc.pdf", load_options) as watermarker:
    watermark = ImageWatermark(r"C:\watermark.png")
    options = PdfXObjectWatermarkOptions()
    options.page_index = 0

    watermarker.add(watermark, options)
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `PdfXObjectWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### page_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.pdf/pdfxobjectwatermarkoptions/page_index.md

#### page_index property

The page index to add the watermark to.

##### Definition:
```python
@property
def page_index(self):
    ...
@page_index.setter
def page_index(self, value):
    ...
```

### groupdocs.watermark.options.presentation
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation.md

Types under `groupdocs.watermark.options.presentation`.

##### Classes
| Class | Description |
| :- | :- |
| `PresentationImageEffects` | Represents effects that can be applied to an image watermark for a PowerPoint document. |
| `PresentationLoadOptions` | Represents document loading options for a Presentation document. |
| `PresentationPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of Presentation documents. |
| `PresentationSaveOptions` | Represents document saving options when saving a Presentation document. |
| `PresentationTextEffects` | Represents effects that can be applied to a text watermark for a PowerPoint content. |
| `PresentationWatermarkBaseSlideOptions` | Base class for watermark adding options to a Presentation document. |
| `PresentationWatermarkLayoutSlideOptions` | Represents options when adding watermark to a Presentation document layout slide. |
| `PresentationWatermarkMasterHandoutSlideOptions` | Represents options when adding a watermark to a Presentation document master handout slide. |
| `PresentationWatermarkMasterNotesSlideOptions` | Represents options when adding watermark to a Presentation document master notes slide. |
| `PresentationWatermarkMasterSlideOptions` | Represents options when adding watermark to a Presentation document master slide. |
| `PresentationWatermarkNoteSlideOptions` | Represents options when adding a watermark to a Presentation document note slide. |
| `PresentationWatermarkSlideOptions` | Represents options when adding a watermark to a Presentation document slide. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `IPresentationWatermarkEffects` | Represents interface for watermark effects that should be applied to the watermark. |
| `PresentationWatermarkOptions` | Represents the base class for watermark adding options to a Presentation document. |

### IPresentationWatermarkEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/ipresentationwatermarkeffects.md

#### IPresentationWatermarkEffects class

Represents interface for watermark effects that should be applied to the watermark.

The IPresentationWatermarkEffects type exposes the following members:

### PresentationImageEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects.md

#### PresentationImageEffects class

Represents effects that can be applied to an image watermark for a PowerPoint document.

The PresentationImageEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationImageEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| border_line_format | The line format settings for the image border. (inherited from `OfficeImageEffects`) |
| brightness | The brightness of the picture, a float between 0.0 (dimmest) and 1.0 (brightest); defaults to 0.5. (inherited from `OfficeImageEffects`) |
| chroma_key | The color value of the image that will be treated as transparent. The default value is a fully transparent color. (inherited from `OfficeImageEffects`) |
| contrast | The contrast for the specified picture, ranging from 0.0 (least contrast) to 1.0 (greatest contrast). The default value is 0.5. (inherited from `OfficeImageEffects`) |
| gray_scale | The property indicates whether a picture will be displayed in grayscale mode. (inherited from `OfficeImageEffects`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/__init__.md

#### __init__

Initializes a new instance of the `PresentationImageEffects` class.

```python
def __init__(self):
    ...
```

### border_line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/border_line_format.md

#### border_line_format property

Gets or sets a line format settings for the image border.

### brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/brightness.md

#### brightness property

Gets or sets the brightness of the picture. The value for this property must
be a number from 0.0 (dimmest) to 1.0 (brightest).

### chroma_key property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/chroma_key.md

#### chroma_key property

Gets or sets the color value of the image that will be treated as transparent.

### contrast property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/contrast.md

#### contrast property

Gets or sets the contrast for the specified picture. The value for this property
must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

### gray_scale property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationimageeffects/gray_scale.md

#### gray_scale property

Gets or sets a value indicating whether a picture will be displayed in grayscale mode.

### PresentationLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions.md

#### PresentationLoadOptions class

Represents document loading options for a Presentation document.

The PresentationLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationLoadOptions` class. |
| __init__ | Initializes a new instance of the PresentationLoadOptions class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    print(content.slide_width)
    print(content.slide_height)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationLoadOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the PresentationLoadOptions class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted content. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PresentationLoadOptions(password="mySecret")
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### PresentationPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions.md

#### PresentationPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of Presentation documents.

The PresentationPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PresentationPreviewOptions instance that closes the output stream. |
| __init__ | Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/__init__.md

#### __init__

Initializes a new PresentationPreviewOptions instance that closes the output stream.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `PresentationPreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/resolution.md

#### resolution property

The resolution for the generated images, in dots per inch.

The default value is 300.

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationpreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### PresentationSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationsaveoptions.md

#### PresentationSaveOptions class

Represents document saving options when saving a Presentation document.

The PresentationSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PresentationSaveOptions instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationsaveoptions/__init__.md

#### __init__

Initializes a new PresentationSaveOptions instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### PresentationTextEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationtexteffects.md

#### PresentationTextEffects class

Represents effects that can be applied to a text watermark for a PowerPoint content.

The PresentationTextEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new PresentationTextEffects instance. |

##### Properties
| Property | Description |
| :- | :- |
| line_format | The line format settings. (inherited from `OfficeTextEffects`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationtexteffects/__init__.md

#### __init__

Initializes a new PresentationTextEffects instance.

```python
def __init__(self):
    ...
```

### line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationtexteffects/line_format.md

#### line_format property

Gets or sets the line format settings.

### PresentationWatermarkBaseSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions.md

#### PresentationWatermarkBaseSlideOptions class

Base class for watermark adding options to a Presentation document.

Learn more:
- [Add watermarks to presentation documents](https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

The PresentationWatermarkBaseSlideOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. |
| is_locked | The shape editing lock state for a PowerPoint slide. |
| name | The shape name. |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/alternative_text.md

#### alternative_text property

The descriptive (alternative) text that will be associated with a shape.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/effects.md

#### effects property

The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance.

##### Definition:
```python
@property
def effects(self):
    ...
@effects.setter
def effects(self, value):
    ...
```

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/is_locked.md

#### is_locked property

The shape editing lock state for a PowerPoint slide.

If True, editing the shape in PowerPoint is forbidden; otherwise the shape can be edited. By default the value is False.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/name.md

#### name property

The shape name.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkbaseslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

The property indicates whether the text watermark characters are mixed with unreadable characters.

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.IsLocked` property is True.

##### Definition:
```python
@property
def protect_with_unreadable_characters(self):
    ...
@protect_with_unreadable_characters.setter
def protect_with_unreadable_characters(self, value):
    ...
```

### PresentationWatermarkLayoutSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions.md

#### PresentationWatermarkLayoutSlideOptions class

Represents options when adding watermark to a Presentation document layout slide.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

The PresentationWatermarkLayoutSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationWatermarkOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| layout_slide_index | The index of the layout slide to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    layout_opts = gwo_ppt.PresentationWatermarkLayoutSlideOptions()
    layout_opts.layout_slide_index = -1  # -1 applies to all layout slides
    watermarker.add(watermark, layout_opts)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationWatermarkOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### layout_slide_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/layout_slide_index.md

#### layout_slide_index property

The index of the layout slide to add the watermark to.

-1 means all slides.

##### Definition:
```python
@property
def layout_slide_index(self):
    ...
@layout_slide_index.setter
def layout_slide_index(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarklayoutslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### PresentationWatermarkMasterHandoutSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions.md

#### PresentationWatermarkMasterHandoutSlideOptions class

Represents options when adding a watermark to a Presentation document master handout slide.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

The PresentationWatermarkMasterHandoutSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    content = watermarker.get_content(gwc_ppt.PresentationContent)

    handout_opts = gwo_ppt.PresentationWatermarkMasterHandoutSlideOptions()
    watermarker.add(watermark, handout_opts)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationWatermarkMasterHandoutSlideOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterhandoutslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### PresentationWatermarkMasterNotesSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions.md

#### PresentationWatermarkMasterNotesSlideOptions class

Represents options when adding watermark to a Presentation document master notes slide.

Learn more:
- Add watermarks to presentation documents (https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

The PresentationWatermarkMasterNotesSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationWatermarkMasterNotesSlideOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasternotesslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### PresentationWatermarkMasterSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions.md

#### PresentationWatermarkMasterSlideOptions class

Represents options when adding watermark to a Presentation document master slide.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

The PresentationWatermarkMasterSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the PresentationWatermarkMasterSlideOptions class. |

##### Properties
| Property | Description |
| :- | :- |
| master_slide_index | The index of the master slide to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    master_opts = gwo_ppt.PresentationWatermarkMasterSlideOptions()
    master_opts.master_slide_index = -1  # Apply to all master slides
    watermarker.add(watermark, master_opts)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/__init__.md

#### __init__

Initializes a new instance of the PresentationWatermarkMasterSlideOptions class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### master_slide_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/master_slide_index.md

#### master_slide_index property

The index of the master slide to add the watermark to.

-1 means all slides.

##### Definition:
```python
@property
def master_slide_index(self):
    ...
@master_slide_index.setter
def master_slide_index(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkmasterslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### PresentationWatermarkNoteSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions.md

#### PresentationWatermarkNoteSlideOptions class

Represents options when adding a watermark to a Presentation document note slide.

Learn more:
- Add watermarks to presentation documents (https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents)

See the usage examples in `PresentationWatermarkBaseSlideOptions`.

The PresentationWatermarkNoteSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| slide_index | The index of the slide whose note slide will receive the watermark. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    content = watermarker.get_content(gwc_ppt.PresentationContent)

    note_opts = gwo_ppt.PresentationWatermarkNoteSlideOptions()
    note_opts.slide_index = 0  # index of the slide whose notes will receive the watermark
    watermarker.add(watermark, note_opts)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationWatermarkNoteSlideOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### slide_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarknoteslideoptions/slide_index.md

#### slide_index property

The index of the slide whose note slide will receive the watermark.

-1 means all slides.

##### Definition:
```python
@property
def slide_index(self):
    ...
@slide_index.setter
def slide_index(self, value):
    ...
```

### PresentationWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkoptions.md

#### PresentationWatermarkOptions class

Represents the base class for watermark adding options to a Presentation document.

The PresentationWatermarkOptions type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### PresentationWatermarkSlideOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions.md

#### PresentationWatermarkSlideOptions class

Represents options when adding a watermark to a Presentation document slide.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+presentation+documents

The PresentationWatermarkSlideOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PresentationWatermarkSlideOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| slide_index | The index of the slide to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| effects | The effects applied to the watermark, specified as a `PresentationImageEffects` or `PresentationTextEffects` instance. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| is_locked | The shape editing lock state for a PowerPoint slide. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| name | The shape name. (inherited from `PresentationWatermarkBaseSlideOptions`) |
| protect_with_unreadable_characters | The property indicates whether the text watermark characters are mixed with unreadable characters. (inherited from `PresentationWatermarkBaseSlideOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    # Add a text watermark to the first slide
    text_wm = gww.TextWatermark("Test watermark", gww.Font("Arial", 36.0))
    text_opts = gwo_ppt.PresentationWatermarkSlideOptions()
    text_opts.slide_index = 0
    text_opts.is_locked = False
    text_opts.protect_with_unreadable_characters = False
    watermarker.add(text_wm, text_opts)

    # Add an image watermark to the second slide and lock it
    with gww.ImageWatermark("logo.jpg") as img_wm:
        img_opts = gwo_ppt.PresentationWatermarkSlideOptions()
        img_opts.slide_index = 1
        img_opts.is_locked = True
        img_opts.protect_with_unreadable_characters = True
        watermarker.add(img_wm, img_opts)

    watermarker.save("presentation.pptx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/__init__.md

#### __init__

Initializes a new instance of the `PresentationWatermarkSlideOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.presentation as gwo_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    options = gwo_ppt.PresentationWatermarkSlideOptions()
    options.slide_index = 0
    text_wm = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    watermarker.add(text_wm, options)
    watermarker.save("presentation.pptx")
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/effects.md

#### effects property

Gets or sets a value of `PresentationImageEffects` or
`PresentationTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in PowerPoint is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/name.md

#### name property

Gets or sets the name a shape.

### protect_with_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/protect_with_unreadable_characters.md

#### protect_with_unreadable_characters property

Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

##### Remarks

This protection applies only when the value of `PresentationWatermarkBaseSlideOptions.is_locked` property is `true`.

### slide_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.presentation/presentationwatermarkslideoptions/slide_index.md

#### slide_index property

The index of the slide to add the watermark to.

-1 means all slides.

##### Definition:
```python
@property
def slide_index(self):
    ...
@slide_index.setter
def slide_index(self, value):
    ...
```

### groupdocs.watermark.options.spreadsheet
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet.md

Types under `groupdocs.watermark.options.spreadsheet`.

##### Classes
| Class | Description |
| :- | :- |
| `SpreadsheetBackgroundWatermarkOptions` | Represents options when adding the watermark as a background to a Spreadsheet worksheet. |
| `SpreadsheetImageEffects` | Represents effects that can be applied to an image watermark for an Excel document. |
| `SpreadsheetLoadOptions` | Represents document loading options for a Spreadsheet document. |
| `SpreadsheetPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of a spreadsheet document. |
| `SpreadsheetSaveOptions` | Represents document saving options when saving a Spreadsheet document. |
| `SpreadsheetShapeSettings` | Represents settings that can be applied to a shape watermark for an Excel document. |
| `SpreadsheetTextEffects` | Represents effects that can be applied to a text watermark for an Excel document. |
| `SpreadsheetWatermarkBaseOptions` | Represents the base class for watermark adding options to a Spreadsheet document. |
| `SpreadsheetWatermarkHeaderFooterOptions` | Represents options when adding the watermark to a Spreadsheet header/footer. |
| `SpreadsheetWatermarkModernWordArtOptions` | Represents options when adding modern WordArt watermark to a Spreadsheet worksheet. |
| `SpreadsheetWatermarkShapeOptions` | Represents options when adding a shape watermark to a Spreadsheet worksheet. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `ISpreadsheetWatermarkEffects` | Represents interface for watermark effects that should be applied to the watermark. |

### ISpreadsheetWatermarkEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/ispreadsheetwatermarkeffects.md

#### ISpreadsheetWatermarkEffects class

Represents interface for watermark effects that should be applied to the watermark.

The ISpreadsheetWatermarkEffects type exposes the following members:

### SpreadsheetBackgroundWatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions.md

#### SpreadsheetBackgroundWatermarkOptions class

Represents options when adding the watermark as a background to a Spreadsheet worksheet.

- Learn more: https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents

The SpreadsheetBackgroundWatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the SpreadsheetBackgroundWatermarkOptions class. |

##### Properties
| Property | Description |
| :- | :- |
| background_height | The desired height of the background image in pixels. |
| background_width | The desired width of the background image in pixels. |
| worksheet_index | The index of worksheet to add the watermark to. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    with gww.ImageWatermark("logo.gif") as watermark:
        options = gwo_xls.SpreadsheetBackgroundWatermarkOptions()
        watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/__init__.md

#### __init__

Initializes a new instance of the SpreadsheetBackgroundWatermarkOptions class.

```python
def __init__(self):
    ...
```

### background_height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/background_height.md

#### background_height property

The desired height of the background image in pixels.

##### Definition:
```python
@property
def background_height(self):
    ...
@background_height.setter
def background_height(self, value):
    ...
```

### background_width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/background_width.md

#### background_width property

The desired width of the background image in pixels.

##### Definition:
```python
@property
def background_width(self):
    ...
@background_width.setter
def background_width(self, value):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### worksheet_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetbackgroundwatermarkoptions/worksheet_index.md

#### worksheet_index property

The index of worksheet to add the watermark to.

-1 means every worksheet.

##### Definition:
```python
@property
def worksheet_index(self):
    ...
@worksheet_index.setter
def worksheet_index(self, value):
    ...
```

### SpreadsheetImageEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects.md

#### SpreadsheetImageEffects class

Represents effects that can be applied to an image watermark for an Excel document.

The SpreadsheetImageEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SpreadsheetImageEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| border_line_format | The line format settings for the image border. (inherited from `OfficeImageEffects`) |
| brightness | The brightness of the picture, a float between 0.0 (dimmest) and 1.0 (brightest); defaults to 0.5. (inherited from `OfficeImageEffects`) |
| chroma_key | The color value of the image that will be treated as transparent. The default value is a fully transparent color. (inherited from `OfficeImageEffects`) |
| contrast | The contrast for the specified picture, ranging from 0.0 (least contrast) to 1.0 (greatest contrast). The default value is 0.5. (inherited from `OfficeImageEffects`) |
| gray_scale | The property indicates whether a picture will be displayed in grayscale mode. (inherited from `OfficeImageEffects`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    with gww.ImageWatermark("logo.png") as watermark:
        effects = gwo_xls.SpreadsheetImageEffects()
        effects.brightness = 0.7
        effects.contrast = 0.6
        effects.chroma_key = gww.Color.red
        effects.border_line_format.enabled = True
        effects.border_line_format.weight = 1
        options = gwo_xls.SpreadsheetWatermarkShapeOptions()
        options.effects = effects
        watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/__init__.md

#### __init__

Initializes a new instance of the `SpreadsheetImageEffects` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

effects = gwo_xls.SpreadsheetImageEffects()
effects.brightness = 0.7
effects.contrast = 0.6
```

### border_line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/border_line_format.md

#### border_line_format property

Gets or sets a line format settings for the image border.

### brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/brightness.md

#### brightness property

Gets or sets the brightness of the picture. The value for this property must
be a number from 0.0 (dimmest) to 1.0 (brightest).

### chroma_key property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/chroma_key.md

#### chroma_key property

Gets or sets the color value of the image that will be treated as transparent.

### contrast property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/contrast.md

#### contrast property

Gets or sets the contrast for the specified picture. The value for this property
must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

### gray_scale property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetimageeffects/gray_scale.md

#### gray_scale property

Gets or sets a value indicating whether a picture will be displayed in grayscale mode.

### SpreadsheetLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions.md

#### SpreadsheetLoadOptions class

Represents document loading options for a Spreadsheet document.

The SpreadsheetLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of SpreadsheetLoadOptions. |
| __init__ | Initializes a new instance of the SpreadsheetLoadOptions class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    # perform operations on the spreadsheet content
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/__init__.md

#### __init__

Initializes a new instance of SpreadsheetLoadOptions.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the SpreadsheetLoadOptions class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted content. |

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### SpreadsheetPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions.md

#### SpreadsheetPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of a spreadsheet document.

The SpreadsheetPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the SpreadsheetPreviewOptions class causing the output stream to be closed. |
| __init__ | Initializes a new instance of `SpreadsheetPreviewOptions` that returns the output stream to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| only_data_area | The flag for rendering the data area only without headers, footers, margins. |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/__init__.md

#### __init__

Initializes a new instance of the SpreadsheetPreviewOptions class causing the output stream to be closed.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `SpreadsheetPreviewOptions` that returns the output stream to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### only_data_area property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/only_data_area.md

#### only_data_area property

The flag for rendering the data area only without headers, footers, margins.

This flag leads to rendering the whole worksheet on one page. The default value is False.

##### Definition:
```python
@property
def only_data_area(self):
    ...
@only_data_area.setter
def only_data_area(self, value):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/resolution.md

#### resolution property

The resolution for the 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/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetpreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### SpreadsheetSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions.md

#### SpreadsheetSaveOptions class

Represents document saving options when saving a Spreadsheet document.

The SpreadsheetSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `SpreadsheetSaveOptions` instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions/__init__.md

#### __init__

Initializes a new `SpreadsheetSaveOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### SpreadsheetShapeSettings class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings.md

#### SpreadsheetShapeSettings class

Represents settings that can be applied to a shape watermark for an Excel document.

The SpreadsheetShapeSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SpreadsheetShapeSettings` class. |

##### Properties
| Property | Description |
| :- | :- |
| is_locked | The shape editing lock state for Excel. If True, shape editing is forbidden; by default False, the shape can be edited. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `OfficeShapeSettings`) |
| name | The name of the shape. (inherited from `OfficeShapeSettings`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/__init__.md

#### __init__

Initializes a new instance of the `SpreadsheetShapeSettings` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/is_locked.md

#### is_locked property

The shape editing lock state for Excel. If True, shape editing is forbidden; by default False, the shape can be edited.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetshapesettings/name.md

#### name property

Gets or sets the name a shape.

### SpreadsheetTextEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheettexteffects.md

#### SpreadsheetTextEffects class

Represents effects that can be applied to a text watermark for an Excel document.

The SpreadsheetTextEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SpreadsheetTextEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| line_format | The line format settings. (inherited from `OfficeTextEffects`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Segoe UI", 19.0))
    effects = gwo_xls.SpreadsheetTextEffects()
    effects.line_format.enabled = True
    effects.line_format.color = gww.Color.red
    effects.line_format.dash_style = gwc.OfficeDashStyle.DASH_DOT_DOT
    effects.line_format.line_style = gwc.OfficeLineStyle.TRIPLE
    effects.line_format.weight = 1
    options = gwo_xls.SpreadsheetWatermarkShapeOptions()
    options.effects = effects
    watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheettexteffects/__init__.md

#### __init__

Initializes a new instance of the `SpreadsheetTextEffects` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Segoe UI", 19.0))
    effects = gwo_xls.SpreadsheetTextEffects()
    effects.line_format.enabled = True
    effects.line_format.color = gww.Color.red
    effects.line_format.dash_style = gwc.OfficeDashStyle.DASH_DOT_DOT
    effects.line_format.line_style = gwc.OfficeLineStyle.TRIPLE
    effects.line_format.weight = 1
    options = gwo_xls.SpreadsheetWatermarkShapeOptions()
    options.effects = effects
    watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheettexteffects/line_format.md

#### line_format property

Gets or sets the line format settings.

### SpreadsheetWatermarkBaseOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions.md

#### SpreadsheetWatermarkBaseOptions class

Represents the base class for watermark adding options to a Spreadsheet document.

The SpreadsheetWatermarkBaseOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. |
| is_locked | The `is_locked` property indicates whether editing of the shape in Excel is forbidden. If set to True, shape editing is prohibited; by default it is False, allowing editing. |
| name | The name of the shape. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/alternative_text.md

#### alternative_text property

The descriptive (alternative) text that will be associated with a shape.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/is_locked.md

#### is_locked property

The `is_locked` property indicates whether editing of the shape in Excel is forbidden. If set to True, shape editing is prohibited; by default it is False, allowing editing.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkbaseoptions/name.md

#### name property

The name of the shape.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### SpreadsheetWatermarkHeaderFooterOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions.md

#### SpreadsheetWatermarkHeaderFooterOptions class

Represents options when adding the watermark to a Spreadsheet header/footer.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents

The SpreadsheetWatermarkHeaderFooterOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the SpreadsheetWatermarkHeaderFooterOptions class. |

##### Properties
| Property | Description |
| :- | :- |
| worksheet_index | The index of the worksheet to add the watermark to. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark(
        "Test watermark",
        gww.Font("Segoe UI", 19.0, gww.FontStyle.BOLD)
    )
    watermark.foreground_color = gww.Color.red
    watermark.background_color = gww.Color.aqua
    watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER

    options = gwo_xls.SpreadsheetWatermarkHeaderFooterOptions()
    options.worksheet_index = 0

    watermarker.add(watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions/__init__.md

#### __init__

Initializes a new instance of the SpreadsheetWatermarkHeaderFooterOptions class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark.options.spreadsheet as gwo_xls

options = gwo_xls.SpreadsheetWatermarkHeaderFooterOptions()
options.worksheet_index = 0
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### worksheet_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkheaderfooteroptions/worksheet_index.md

#### worksheet_index property

The index of the worksheet to add the watermark to.

-1 means every worksheet.

##### Definition:
```python
@property
def worksheet_index(self):
    ...
@worksheet_index.setter
def worksheet_index(self, value):
    ...
```

### SpreadsheetWatermarkModernWordArtOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions.md

#### SpreadsheetWatermarkModernWordArtOptions class

Represents options when adding modern WordArt watermark to a Spreadsheet worksheet.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents

The SpreadsheetWatermarkModernWordArtOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| worksheet_index | The index of worksheet to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `SpreadsheetWatermarkBaseOptions`) |
| is_locked | The `is_locked` property indicates whether editing of the shape in Excel is forbidden. If set to True, shape editing is prohibited; by default it is False, allowing editing. (inherited from `SpreadsheetWatermarkBaseOptions`) |
| name | The name of the shape. (inherited from `SpreadsheetWatermarkBaseOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    text_watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    options = gwo_xls.SpreadsheetWatermarkModernWordArtOptions()
    options.worksheet_index = 0
    watermarker.add(text_watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/__init__.md

#### __init__

Initializes a new instance of the `SpreadsheetWatermarkModernWordArtOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    text_watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 8.0))
    options = gwo_xls.SpreadsheetWatermarkModernWordArtOptions()
    options.worksheet_index = 0
    watermarker.add(text_watermark, options)
    watermarker.save("spreadsheet.xlsx")
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Excel is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/name.md

#### name property

Gets or sets the name a shape.

### worksheet_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkmodernwordartoptions/worksheet_index.md

#### worksheet_index property

The index of worksheet to add the watermark to.

-1 means every worksheet.

##### Definition:
```python
@property
def worksheet_index(self):
    ...
@worksheet_index.setter
def worksheet_index(self, value):
    ...
```

### SpreadsheetWatermarkShapeOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions.md

#### SpreadsheetWatermarkShapeOptions class

Represents options when adding a shape watermark to a Spreadsheet worksheet.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+spreadsheet+documents

The SpreadsheetWatermarkShapeOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| effects | The effects to apply to the watermark, specified as a SpreadsheetImageEffects or SpreadsheetTextEffects instance. |
| worksheet_index | The index of the worksheet to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `SpreadsheetWatermarkBaseOptions`) |
| is_locked | The `is_locked` property indicates whether editing of the shape in Excel is forbidden. If set to True, shape editing is prohibited; by default it is False, allowing editing. (inherited from `SpreadsheetWatermarkBaseOptions`) |
| name | The name of the shape. (inherited from `SpreadsheetWatermarkBaseOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.spreadsheet as gwo_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    text_watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 36))
    opts = gwo_xls.SpreadsheetWatermarkShapeOptions()
    opts.worksheet_index = 0
    watermarker.add(text_watermark, opts)
    watermarker.save("spreadsheet.xlsx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/__init__.md

#### __init__

Initializes a new instance of the `SpreadsheetWatermarkShapeOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark.options.spreadsheet as gwo_xls

options = gwo_xls.SpreadsheetWatermarkShapeOptions()
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/effects.md

#### effects property

The effects to apply to the watermark, specified as a SpreadsheetImageEffects or SpreadsheetTextEffects instance.

##### Definition:
```python
@property
def effects(self):
    ...
@effects.setter
def effects(self, value):
    ...
```

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Excel is forbidden.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/name.md

#### name property

Gets or sets the name a shape.

### worksheet_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.spreadsheet/spreadsheetwatermarkshapeoptions/worksheet_index.md

#### worksheet_index property

The index of the worksheet to add the watermark to.

-1 means every worksheet.

##### Definition:
```python
@property
def worksheet_index(self):
    ...
@worksheet_index.setter
def worksheet_index(self, value):
    ...
```

### groupdocs.watermark.options.word_processing
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing.md

Types under `groupdocs.watermark.options.word_processing`.

##### Classes
| Class | Description |
| :- | :- |
| `WordProcessingImageEffects` | Represents effects that can be applied to an image watermark for a Word document. |
| `WordProcessingLoadOptions` | Represents document loading options for a Word document. |
| `WordProcessingPreviewOptions` | Provides options to set requirements and stream delegates for preview generation of WordProcessing document. |
| `WordProcessingSaveOptions` | Represents document saving options when saving a Word document. |
| `WordProcessingTextEffects` | Represents effects that can be applied to a text watermark for a Word document. |
| `WordProcessingWatermarkBaseOptions` | Represents the base class for watermark adding options to a Word document. |
| `WordProcessingWatermarkHeaderFooterOptions` | Represents options when adding the watermark to a Word section header/footer. |
| `WordProcessingWatermarkPagesOptions` | Represents options when adding a watermark to Word document pages. |
| `WordProcessingWatermarkSectionOptions` | Represents options when adding shape watermark to a Word document section. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `IWordProcessingWatermarkEffects` | Represents interface for watermark effects that should be applied to the watermark. |
| `WordProcessingFlipOrientation` |  |
| `WordProcessingLockType` |  |

### IWordProcessingWatermarkEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/iwordprocessingwatermarkeffects.md

#### IWordProcessingWatermarkEffects class

Represents interface for watermark effects that should be applied to the watermark.

The IWordProcessingWatermarkEffects type exposes the following members:

### WordProcessingFlipOrientation class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingfliporientation.md

#### WordProcessingFlipOrientation class

The WordProcessingFlipOrientation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Coordinates are not flipped. |
| HORIZONTAL | Flip along the y-axis, reversing the x-coordinates. |
| VERTICAL | Flip along the x-axis, reversing the y-coordinates. |
| BOTH | Flip along both the y- and x-axis. |

### BOTH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingfliporientation/both.md

#### BOTH field

Flip along both the y- and x-axis.

##### Value
`3`

### HORIZONTAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingfliporientation/horizontal.md

#### HORIZONTAL field

Flip along the y-axis, reversing the x-coordinates.

##### Value
`1`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingfliporientation/none.md

#### NONE field

Coordinates are not flipped.

##### Value
`0`

### VERTICAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingfliporientation/vertical.md

#### VERTICAL field

Flip along the x-axis, reversing the y-coordinates.

##### Value
`2`

### WordProcessingImageEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingimageeffects.md

#### WordProcessingImageEffects class

Represents effects that can be applied to an image watermark for a Word document.

The WordProcessingImageEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the WordProcessingImageEffects class. |

##### Properties
| Property | Description |
| :- | :- |
| border_line_format | The line format settings for the image border. (inherited from `OfficeImageEffects`) |
| brightness | The brightness of the picture, a float between 0.0 (dimmest) and 1.0 (brightest); defaults to 0.5. (inherited from `OfficeImageEffects`) |
| chroma_key | The color value of the image that will be treated as transparent. The default value is a fully transparent color. (inherited from `OfficeImageEffects`) |
| contrast | The contrast for the specified picture, ranging from 0.0 (least contrast) to 1.0 (greatest contrast). The default value is 0.5. (inherited from `OfficeImageEffects`) |
| gray_scale | The property indicates whether a picture will be displayed in grayscale mode. (inherited from `OfficeImageEffects`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    with gww.ImageWatermark("logo.png") as watermark:
        effects = gwo_wp.WordProcessingImageEffects()
        effects.brightness = 0.7
        effects.contrast = 0.6
        effects.chroma_key = gww.Color.red
        effects.border_line_format.enabled = True
        effects.border_line_format.weight = 1

        options = gwo_wp.WordProcessingWatermarkSectionOptions()
        options.effects = effects

        watermarker.add(watermark, options)

    watermarker.save("document.docx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingimageeffects/__init__.md

#### __init__

Initializes a new instance of the WordProcessingImageEffects class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark.options.wordprocessing as gwo_wp

effects = gwo_wp.WordProcessingImageEffects()
```

### WordProcessingLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

Represents document loading options for a Word document.

The WordProcessingLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingLoadOptions` class. |
| __init__ | Initializes a new instance of `gw.WordProcessingLoadOptions` with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.WordProcessingLoadOptions()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingloadoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingLoadOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of `gw.WordProcessingLoadOptions` with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted content. |

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### WordProcessingLockType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype.md

#### WordProcessingLockType class

The WordProcessingLockType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ONLY_REVISIONS | User can only add revision marks to the document. |
| ALLOW_ONLY_COMMENTS | User can only modify comments in the document. |
| ALLOW_ONLY_FORM_FIELDS | User can only enter data in the form fields in the document. |
| READ_ONLY | The entire document is read-only. |
| READ_ONLY_WITH_EDITABLE_CONTENT | The document is read-only, but all the content except of the watermark is marked as editable. |
| NO_LOCK | Disable any lock on watermark and document. |

### ALLOW_ONLY_COMMENTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/allow_only_comments.md

#### ALLOW_ONLY_COMMENTS field

User can only modify comments in the document.

##### Value
`1`

### ALLOW_ONLY_FORM_FIELDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/allow_only_form_fields.md

#### ALLOW_ONLY_FORM_FIELDS field

User can only enter data in the form fields in the document.

##### Value
`2`

### ALLOW_ONLY_REVISIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/allow_only_revisions.md

#### ALLOW_ONLY_REVISIONS field

User can only add revision marks to the document.

##### Value
`0`

### NO_LOCK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/no_lock.md

#### NO_LOCK field

Disable any lock on watermark and document.

##### Value
`-1`

### READ_ONLY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/read_only.md

#### READ_ONLY field

The entire document is read-only.

##### Value
`3`

### READ_ONLY_WITH_EDITABLE_CONTENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessinglocktype/read_only_with_editable_content.md

#### READ_ONLY_WITH_EDITABLE_CONTENT field

The document is read-only, but all the content except of the watermark is marked as editable.

##### Value
`4`

### WordProcessingPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingpreviewoptions.md

#### WordProcessingPreviewOptions class

Provides options to set requirements and stream delegates for preview generation of WordProcessing document.

The WordProcessingPreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the WordProcessingPreviewOptions class causing the output stream to be closed. |
| __init__ | Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| resolution | The resolution for the generated images, in dots per inch. |
| create_page_stream | The page stream creation delegate. (inherited from `PreviewOptions`) |
| height | The page preview height. (inherited from `PreviewOptions`) |
| page_numbers | The array of page numbers to generate previews. (inherited from `PreviewOptions`) |
| preview_format | The preview image format. (inherited from `PreviewOptions`) |
| release_page_stream | The page preview completion delegate. (inherited from `PreviewOptions`) |
| width | The page preview width. (inherited from `PreviewOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingpreviewoptions/__init__.md

#### __init__

Initializes a new instance of the WordProcessingPreviewOptions class causing the output stream to be closed.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

#### __init__

Initializes a new instance of `WordProcessingPreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

### DEFAULT_RESOLUTION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION field

Default resolution in dots per inch.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingpreviewoptions/resolution.md

#### resolution property

The resolution for the generated images, in dots per inch.

The default value is 96.

##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### WordProcessingSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Represents document saving options when saving a Word document.

The WordProcessingSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `WordProcessingSaveOptions` instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingsaveoptions/__init__.md

#### __init__

Initializes a new `WordProcessingSaveOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingsaveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### WordProcessingTextEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingtexteffects.md

#### WordProcessingTextEffects class

Represents effects that can be applied to a text watermark for a Word document.

The WordProcessingTextEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingTextEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| flip_orientation | The orientation of a shape. |
| line_format | The line format settings. (inherited from `OfficeTextEffects`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))

    effects = gwo_wp.WordProcessingTextEffects()
    effects.line_format.enabled = True
    effects.line_format.color = gww.Color.red
    effects.line_format.dash_style = gwc.OfficeDashStyle.DASH_DOT_DOT
    effects.line_format.line_style = gwc.OfficeLineStyle.TRIPLE
    effects.line_format.weight = 1

    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.effects = effects

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingtexteffects/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingTextEffects` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))

    effects = gwo_wp.WordProcessingTextEffects()
    effects.line_format.enabled = True
    effects.line_format.color = gww.Color.red
    effects.line_format.dash_style = gwc.OfficeDashStyle.DASH_DOT_DOT
    effects.line_format.line_style = gwc.OfficeLineStyle.TRIPLE
    effects.line_format.weight = 1

    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.effects = effects

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingtexteffects/default.md

#### DEFAULT field

Gets the default value for the class.

### flip_orientation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingtexteffects/flip_orientation.md

#### flip_orientation property

The orientation of a shape.

The default value is `WordProcessingFlipOrientation.none`.

##### Definition:
```python
@property
def flip_orientation(self):
    ...
@flip_orientation.setter
def flip_orientation(self, value):
    ...
```

### WordProcessingWatermarkBaseOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions.md

#### WordProcessingWatermarkBaseOptions class

Represents the base class for watermark adding options to a Word document.

Use `lock_type` to set the lock type for the watermark, restricting editing of the document. Available lock types include `AllowOnlyRevisions`, `AllowOnlyComments`, `AllowOnlyFormFields`, `ReadOnly`, and `ReadOnlyWithEditableContent`.

The WordProcessingWatermarkBaseOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. |
| effects | The image or text effects applied to the watermark. |
| is_locked | The property indicates whether editing of the shape in Word is forbidden. |
| lock_type | The watermark lock type. |
| name | The shape name. |
| password | The password used to lock the watermark. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
from groupdocs.watermark import Watermark
from groupdocs.watermark.options import WordProcessingWatermarkBaseOptions
from groupdocs.watermark.enums import WatermarkLockType

options = WordProcessingWatermarkBaseOptions()
options.lock_type = WatermarkLockType.ReadOnly

Watermark.add(watermark_text="Confidential", options=options)
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/alternative_text.md

#### alternative_text property

The descriptive (alternative) text that will be associated with a shape.

##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/effects.md

#### effects property

The image or text effects applied to the watermark.

##### Definition:
```python
@property
def effects(self):
    ...
@effects.setter
def effects(self, value):
    ...
```

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/is_locked.md

#### is_locked property

The property indicates whether editing of the shape in Word is forbidden.

If set to True, shape editing will be forbidden. By default it is False, allowing the shape to be edited in Word.

##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### lock_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/lock_type.md

#### lock_type property

The watermark lock type.

The value `WordProcessingLockType.allow_only_form_fields` cannot be used with an object of type `WordProcessingHeaderFooter`.

##### Definition:
```python
@property
def lock_type(self):
    ...
@lock_type.setter
def lock_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/name.md

#### name property

The shape name.

##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkbaseoptions/password.md

#### password property

The password used to lock the watermark.

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### WordProcessingWatermarkHeaderFooterOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkheaderfooteroptions.md

#### WordProcessingWatermarkHeaderFooterOptions class

Represents options when adding the watermark to a Word section header/footer.

The WordProcessingWatermarkHeaderFooterOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| header_footer_type | The value that identifies the type of header or footer to add the watermark to. |
| section_index | The index of a section to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `WordProcessingWatermarkBaseOptions`) |
| effects | The image or text effects applied to the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |
| is_locked | The property indicates whether editing of the shape in Word is forbidden. (inherited from `WordProcessingWatermarkBaseOptions`) |
| lock_type | The watermark lock type. (inherited from `WordProcessingWatermarkBaseOptions`) |
| name | The shape name. (inherited from `WordProcessingWatermarkBaseOptions`) |
| password | The password used to lock the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkheaderfooteroptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class.

```python
def __init__(self):
    ...
```

### header_footer_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkheaderfooteroptions/header_footer_type.md

#### header_footer_type property

The value that identifies the type of header or footer to add the watermark to.

##### Definition:
```python
@property
def header_footer_type(self):
    ...
@header_footer_type.setter
def header_footer_type(self, value):
    ...
```

### section_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkheaderfooteroptions/section_index.md

#### section_index property

The index of a section to add the watermark to.

-1 means all sections.

##### Definition:
```python
@property
def section_index(self):
    ...
@section_index.setter
def section_index(self, value):
    ...
```

### WordProcessingWatermarkPagesOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkpagesoptions.md

#### WordProcessingWatermarkPagesOptions class

Represents options when adding a watermark to Word document pages.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+word+processing+documents

The WordProcessingWatermarkPagesOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| page_numbers | The page numbers to add the watermark. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `WordProcessingWatermarkBaseOptions`) |
| effects | The image or text effects applied to the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |
| is_locked | The property indicates whether editing of the shape in Word is forbidden. (inherited from `WordProcessingWatermarkBaseOptions`) |
| lock_type | The watermark lock type. (inherited from `WordProcessingWatermarkBaseOptions`) |
| name | The shape name. (inherited from `WordProcessingWatermarkBaseOptions`) |
| password | The password used to lock the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    text_watermark = gww.TextWatermark("DRAFT", gww.Font("Arial", 42.0))

    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    options = gwo_wp.WordProcessingWatermarkPagesOptions()
    options.page_numbers = [content.page_count]

    watermarker.add(text_watermark, options)
    watermarker.save("document.docx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkpagesoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class.

```python
def __init__(self):
    ...
```

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarkpagesoptions/page_numbers.md

#### page_numbers property

The page numbers to add the watermark.

All numbers must be greater than or equal to 1.
This property is only used when adding the watermark to a document.
If this value is None or empty, the watermark is added to all pages.

##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### WordProcessingWatermarkSectionOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarksectionoptions.md

#### WordProcessingWatermarkSectionOptions class

Represents options when adding shape watermark to a Word document section.

Learn more:
- Add watermarks to word processing documents: https://docs.groupdocs.com/display/watermarknet/Add+watermarks+to+word+processing+documents

The WordProcessingWatermarkSectionOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| section_index | The index of a section to add the watermark to. |
| alternative_text | The descriptive (alternative) text that will be associated with a shape. (inherited from `WordProcessingWatermarkBaseOptions`) |
| effects | The image or text effects applied to the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |
| is_locked | The property indicates whether editing of the shape in Word is forbidden. (inherited from `WordProcessingWatermarkBaseOptions`) |
| lock_type | The watermark lock type. (inherited from `WordProcessingWatermarkBaseOptions`) |
| name | The shape name. (inherited from `WordProcessingWatermarkBaseOptions`) |
| password | The password used to lock the watermark. (inherited from `WordProcessingWatermarkBaseOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. (inherited from `WatermarkOptions`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.section_index = 0
    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarksectionoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark.options.wordprocessing as gwo_wp

options = gwo_wp.WordProcessingWatermarkSectionOptions()
```

### section_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.word_processing/wordprocessingwatermarksectionoptions/section_index.md

#### section_index property

The index of a section to add the watermark to.

-1 means all sections.

##### Definition:
```python
@property
def section_index(self):
    ...
@section_index.setter
def section_index(self, value):
    ...
```

### groupdocs.watermark.options.wordprocessing
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing.md

The namespace provides classes to specify additional options when working with
watermarks and Word documents.

##### Classes
| Class | Description |
| :- | :- |
| `IWordProcessingWatermarkEffects` | Represents interface for watermark effects that should be applied to the watermark. |
| `WordProcessingImageEffects` | Represents effects that can be applied to an image watermark for a Word document. |
| `WordProcessingLoadOptions` | Represents document loading options for a Word document. |
| `WordProcessingPreviewOptions` | Provides options to sets requirements and stream delegates for preview generation of WordProcessing document. |
| `WordProcessingSaveOptions` | Represents document saving options when saving a Word document. |
| `WordProcessingTextEffects` | Represents effects that can be applied to a text watermark for a Word document. |
| `WordProcessingWatermarkBaseOptions` | Base class for watermark adding options to a Word document. |
| `WordProcessingWatermarkHeaderFooterOptions` | Represents options when adding the watermark to a Word section header/footer. |
| `WordProcessingWatermarkPagesOptions` | Represents options when adding watermark to Word document pages. |
| `WordProcessingWatermarkSectionOptions` | Represents options when adding shape watermark to a Word document section. |

##### Enumerations
| Enumeration | Description |
| :- | :- |
| `WordProcessingFlipOrientation` | Possible values for the orientation of a shape. |
| `WordProcessingLockType` | Specifies watermark lock type in Word document. |

### IWordProcessingWatermarkEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/iwordprocessingwatermarkeffects.md

#### IWordProcessingWatermarkEffects class

Represents interface for watermark effects that should be applied to the watermark.

The IWordProcessingWatermarkEffects type exposes the following members:

### WordProcessingFlipOrientation enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingfliporientation.md

#### WordProcessingFlipOrientation enumeration

Possible values for the orientation of a shape.

The WordProcessingFlipOrientation type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Coordinates are not flipped. |
| HORIZONTAL | Flip along the y-axis, reversing the x-coordinates. |
| VERTICAL | Flip along the x-axis, reversing the y-coordinates. |
| BOTH | Flip along both the y- and x-axis. |

### WordProcessingImageEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects.md

#### WordProcessingImageEffects class

Represents effects that can be applied to an image watermark for a Word document.

**Inheritance:** `WordProcessingImageEffects` →
`OfficeImageEffects`

The WordProcessingImageEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingImageEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| border_line_format | Gets or sets a line format settings for the image border. |
| gray_scale | Gets or sets a value indicating whether a picture will be displayed in grayscale mode. |
| chroma_key | Gets or sets the color value of the image that will be treated as transparent. |
| brightness | Gets or sets the brightness of the picture. The value for this property must
<br/>be a number from 0.0 (dimmest) to 1.0 (brightest). |
| contrast | Gets or sets the contrast for the specified picture. The value for this property
<br/>must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast). |

### WordProcessingImageEffects constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingImageEffects` class.

```python
def __init__(self):
    ...
```

### border_line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/border_line_format.md

#### border_line_format property

Gets or sets a line format settings for the image border.

### brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/brightness.md

#### brightness property

Gets or sets the brightness of the picture. The value for this property must
be a number from 0.0 (dimmest) to 1.0 (brightest).

### chroma_key property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/chroma_key.md

#### chroma_key property

Gets or sets the color value of the image that will be treated as transparent.

### contrast property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/contrast.md

#### contrast property

Gets or sets the contrast for the specified picture. The value for this property
must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

### gray_scale property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingimageeffects/gray_scale.md

#### gray_scale property

Gets or sets a value indicating whether a picture will be displayed in grayscale mode.

### WordProcessingLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions.md

#### WordProcessingLoadOptions class

Represents document loading options for a Word document.

**Inheritance:** `WordProcessingLoadOptions` →
`LoadOptions`

The WordProcessingLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingLoadOptions` class. |
| __init__ | Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| password | Gets or sets the password for opening an encrypted document. |
| format_family | Gets or sets the format family of the document,
<br/>indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| file_type | Gets or sets the type of the file,
<br/>indicating its type (e.g., docx, pdf, xlsx, etc.). |
| default | Gets the default value for the `WordProcessingLoadOptions` class. |

### WordProcessingLoadOptions constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingLoadOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `WordProcessingLoadOptions` class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | System.String | The password for opening an encrypted content. |

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/default.md

#### default property

Gets the default value for the `WordProcessingLoadOptions` class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### WordProcessingLockType enumeration
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessinglocktype.md

#### WordProcessingLockType enumeration

Specifies watermark lock type in Word document.

The WordProcessingLockType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ALLOW_ONLY_REVISIONS | User can only add revision marks to the document. |
| ALLOW_ONLY_COMMENTS | User can only modify comments in the document. |
| ALLOW_ONLY_FORM_FIELDS | User can only enter data in the form fields in the document. |
| READ_ONLY | The entire document is read-only. |
| READ_ONLY_WITH_EDITABLE_CONTENT | The document is read-only, but all the content except of the watermark is marked as editable. |
| NO_LOCK | Disable any lock on watermark and document. |

### WordProcessingPreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions.md

#### WordProcessingPreviewOptions class

Provides options to sets requirements and stream delegates for preview generation of WordProcessing document.

**Inheritance:** `WordProcessingPreviewOptions` →
`PreviewOptions`

The WordProcessingPreviewOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| width | Gets or sets the page preview width. |
| height | Gets or sets the page preview height. |
| page_numbers | Gets or sets an array of page numbers to generate previews. |
| preview_format | Gets or sets the preview image format. |
| resolution | Gets or sets the resolution for the generated images, in dots per inch. |
| DEFAULT_RESOLUTION | Default resolution in dots per inch. |

### DEFAULT_RESOLUTION property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/default_resolution.md

#### DEFAULT_RESOLUTION property

Default resolution in dots per inch.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/height.md

#### height property

Gets or sets the page preview height.

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/page_numbers.md

#### page_numbers property

Gets or sets an array of page numbers to generate previews.

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/preview_format.md

#### preview_format property

Gets or sets the preview image format.

### resolution property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/resolution.md

#### resolution property

Gets or sets the resolution for the generated images, in dots per inch.

##### Remarks

The default value is 96.
##### Definition:
```python
@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingpreviewoptions/width.md

#### width property

Gets or sets the page preview width.

### WordProcessingSaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions.md

#### WordProcessingSaveOptions class

Represents document saving options when saving a Word document.

**Inheritance:** `WordProcessingSaveOptions` →
`SaveOptions`

The WordProcessingSaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingSaveOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| default | Gets the default value for the `WordProcessingSaveOptions` class. |

### WordProcessingSaveOptions constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingSaveOptions` class.

```python
def __init__(self):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingsaveoptions/default.md

#### default property

Gets the default value for the `WordProcessingSaveOptions` class.

### WordProcessingTextEffects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects.md

#### WordProcessingTextEffects class

Represents effects that can be applied to a text watermark for a Word document.

**Inheritance:** `WordProcessingTextEffects` →
`OfficeTextEffects`

The WordProcessingTextEffects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingTextEffects` class. |

##### Properties
| Property | Description |
| :- | :- |
| line_format | Gets or sets the line format settings. |
| flip_orientation | Gets or sets the orientation of a shape. |
| DEFAULT | Gets the default value for the `WordProcessingTextEffects` class. |

### WordProcessingTextEffects constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingTextEffects` class.

```python
def __init__(self):
    ...
```

### DEFAULT property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/default.md

#### DEFAULT property

Gets the default value for the `WordProcessingTextEffects` class.

### flip_orientation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/flip_orientation.md

#### flip_orientation property

Gets or sets the orientation of a shape.

##### Remarks

The default value is `WordProcessingFlipOrientation.NONE`.
##### Definition:
```python
@property
def flip_orientation(self):
    ...
@flip_orientation.setter
def flip_orientation(self, value):
    ...
```

### line_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingtexteffects/line_format.md

#### line_format property

Gets or sets the line format settings.

### WordProcessingWatermarkBaseOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions.md

#### WordProcessingWatermarkBaseOptions class

Base class for watermark adding options to a Word document.

**Inheritance:** `WordProcessingWatermarkBaseOptions` →
`WatermarkOptions`

The WordProcessingWatermarkBaseOptions type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| default | Gets the default value for the `WatermarkOptions` class. |
| is_locked | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| lock_type | Gets or sets the watermark lock type. |
| password | Gets or sets a password used to lock the watermark. |
| name | Gets or sets the name a shape. |
| alternative_text | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| effects | Gets or sets a value of `WordProcessingImageEffects` or
<br/>`WordProcessingTextEffects` for effects that should be applied to the watermark. |

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.
##### Definition:
```python
@property
def alternative_text(self):
    ...
@alternative_text.setter
def alternative_text(self, value):
    ...
```

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/effects.md

#### effects property

Gets or sets a value of `WordProcessingImageEffects` or
`WordProcessingTextEffects` for effects that should be applied to the watermark.
##### Definition:
```python
@property
def effects(self):
    ...
@effects.setter
def effects(self, value):
    ...
```

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Word is forbidden.
##### Definition:
```python
@property
def is_locked(self):
    ...
@is_locked.setter
def is_locked(self, value):
    ...
```

### lock_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/lock_type.md

#### lock_type property

Gets or sets the watermark lock type.

##### Remarks

The value `WordProcessingLockType.ALLOW_ONLY_FORM_FIELDS`
can not be used with an object of type `WordProcessingHeaderFooter`.
##### Definition:
```python
@property
def lock_type(self):
    ...
@lock_type.setter
def lock_type(self, value):
    ...
```

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/name.md

#### name property

Gets or sets the name a shape.
##### Definition:
```python
@property
def name(self):
    ...
@name.setter
def name(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkbaseoptions/password.md

#### password property

Gets or sets a password used to lock the watermark.
##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### WordProcessingWatermarkHeaderFooterOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions.md

#### WordProcessingWatermarkHeaderFooterOptions class

Represents options when adding the watermark to a Word section header/footer.

**Inheritance:** `WordProcessingWatermarkHeaderFooterOptions` →
`WordProcessingWatermarkBaseOptions` →
`WatermarkOptions`

The WordProcessingWatermarkHeaderFooterOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| default | Gets the default value for the `WatermarkOptions` class. |
| is_locked | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| lock_type | Gets or sets the watermark lock type. |
| password | Gets or sets a password used to lock the watermark. |
| name | Gets or sets the name a shape. |
| alternative_text | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| effects | Gets or sets a value of `WordProcessingImageEffects` or
<br/>`WordProcessingTextEffects` for effects that should be applied to the watermark. |
| section_index | Gets or sets the index of a section to add the watermark to. |
| header_footer_type | Gets or sets the value that identifies the type of header or footer to add the watermark to. |

### WordProcessingWatermarkHeaderFooterOptions constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkHeaderFooterOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/effects.md

#### effects property

Gets or sets a value of `WordProcessingImageEffects` or
`WordProcessingTextEffects` for effects that should be applied to the watermark.

### header_footer_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/header_footer_type.md

#### header_footer_type property

Gets or sets the value that identifies the type of header or footer to add the watermark to.
##### Definition:
```python
@property
def header_footer_type(self):
    ...
@header_footer_type.setter
def header_footer_type(self, value):
    ...
```

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Word is forbidden.

### lock_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/lock_type.md

#### lock_type property

Gets or sets the watermark lock type.

##### Remarks

The value `WordProcessingLockType.ALLOW_ONLY_FORM_FIELDS`
can not be used with an object of type `WordProcessingHeaderFooter`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/name.md

#### name property

Gets or sets the name a shape.

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/password.md

#### password property

Gets or sets a password used to lock the watermark.

### section_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkheaderfooteroptions/section_index.md

#### section_index property

Gets or sets the index of a section to add the watermark to.

##### Remarks

-1 means all sections.
##### Definition:
```python
@property
def section_index(self):
    ...
@section_index.setter
def section_index(self, value):
    ...
```

### WordProcessingWatermarkPagesOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions.md

#### WordProcessingWatermarkPagesOptions class

Represents options when adding watermark to Word document pages.

**Inheritance:** `WordProcessingWatermarkPagesOptions` →
`WordProcessingWatermarkBaseOptions` →
`WatermarkOptions`

The WordProcessingWatermarkPagesOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| default | Gets the default value for the `WatermarkOptions` class. |
| is_locked | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| lock_type | Gets or sets the watermark lock type. |
| password | Gets or sets a password used to lock the watermark. |
| name | Gets or sets the name a shape. |
| alternative_text | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| effects | Gets or sets a value of `WordProcessingImageEffects` or
<br/>`WordProcessingTextEffects` for effects that should be applied to the watermark. |
| page_numbers | Gets or sets the page numbers to add the watermark. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Add watermark to a particular page of a Word document.

### WordProcessingWatermarkPagesOptions constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkPagesOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/effects.md

#### effects property

Gets or sets a value of `WordProcessingImageEffects` or
`WordProcessingTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Word is forbidden.

### lock_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/lock_type.md

#### lock_type property

Gets or sets the watermark lock type.

##### Remarks

The value `WordProcessingLockType.ALLOW_ONLY_FORM_FIELDS`
can not be used with an object of type `WordProcessingHeaderFooter`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/name.md

#### name property

Gets or sets the name a shape.

### page_numbers property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/page_numbers.md

#### page_numbers property

Gets or sets the page numbers to add the watermark.

##### Remarks

All numbers must be greater than or equal to 1.
This property is only used when adding the watermark to a document.
If this value is `null` or empty, the watermark is added to all pages.
##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarkpagesoptions/password.md

#### password property

Gets or sets a password used to lock the watermark.

### WordProcessingWatermarkSectionOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions.md

#### WordProcessingWatermarkSectionOptions class

Represents options when adding shape watermark to a Word document section.

**Inheritance:** `WordProcessingWatermarkSectionOptions` →
`WordProcessingWatermarkBaseOptions` →
`WatermarkOptions`

The WordProcessingWatermarkSectionOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class. |

##### Properties
| Property | Description |
| :- | :- |
| default | Gets the default value for the `WatermarkOptions` class. |
| is_locked | Gets or sets a value indicating whether an editing of the shape in Word is forbidden. |
| lock_type | Gets or sets the watermark lock type. |
| password | Gets or sets a password used to lock the watermark. |
| name | Gets or sets the name a shape. |
| alternative_text | Gets or sets the descriptive (alternative) text that will be associated with a shape. |
| effects | Gets or sets a value of `WordProcessingImageEffects` or
<br/>`WordProcessingTextEffects` for effects that should be applied to the watermark. |
| section_index | Gets or sets the index of a section to add the watermark to. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Add watermark to a particular section of a Word document.

### WordProcessingWatermarkSectionOptions constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/__init__.md

#### __init__

Initializes a new instance of the `WordProcessingWatermarkSectionOptions` class.

```python
def __init__(self):
    ...
```

### alternative_text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/alternative_text.md

#### alternative_text property

Gets or sets the descriptive (alternative) text that will be associated with a shape.

### default property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/default.md

#### default property

Gets the default value for the `WatermarkOptions` class.

### effects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/effects.md

#### effects property

Gets or sets a value of `WordProcessingImageEffects` or
`WordProcessingTextEffects` for effects that should be applied to the watermark.

### is_locked property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/is_locked.md

#### is_locked property

Gets or sets a value indicating whether an editing of the shape in Word is forbidden.

### lock_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/lock_type.md

#### lock_type property

Gets or sets the watermark lock type.

##### Remarks

The value `WordProcessingLockType.ALLOW_ONLY_FORM_FIELDS`
can not be used with an object of type `WordProcessingHeaderFooter`.

### name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/name.md

#### name property

Gets or sets the name a shape.

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/password.md

#### password property

Gets or sets a password used to lock the watermark.

### section_index property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.wordprocessing/wordprocessingwatermarksectionoptions/section_index.md

#### section_index property

Gets or sets the index of a section to add the watermark to.

##### Remarks

-1 means all sections.
##### Definition:
```python
@property
def section_index(self):
    ...
@section_index.setter
def section_index(self, value):
    ...
```

### groupdocs.watermark.options
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options.md

Option classes for configuring conversions and operations.

##### Classes
| Class | Description |
| :- | :- |
| `CreatePageStream` | Represents a method that returns a stream to write page preview data. |
| `ILogger` | Defines the interface for a logger used to record events and errors during watermarking. |
| `LoadOptions` | Represents document loading options when loading a document. |
| `OoxmlLoadOptions` | Represents document loading options for an OOXML document. |
| `PreviewOptions` | Provides options to set requirements and stream delegates for preview generation. |
| `ReleasePageStream` | Represents a method which releases the stream created by the `CreatePageStream` delegate. |
| `SaveOptions` | Represents document saving options when saving a document. |
| `WatermarkOptions` | Represents watermark adding options when adding watermark to a document. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `PreviewFormats` |  |

### CreatePageStream class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/createpagestream.md

#### CreatePageStream class

Represents a method that returns a stream to write page preview data.

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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/createpagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/createpagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### ILogger class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger.md

#### ILogger class

Defines the interface for a logger used to record events and errors during watermarking.

The ILogger type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| error | Logs an error that occurred during watermarking. |
| error_file |  |
| error_string |  |
| trace | Logs an event that occurred during watermarking. |
| trace_file |  |
| trace_string |  |
| warning | Logs a warning that occurred during watermarking. |
| warning_file |  |
| warning_string |  |

### error method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/error.md

#### error

Logs an error that occurred during watermarking.

```python
def error(self, message, exception):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The error message. |
| exception | `Exception` | The instance of occured exception. |

### error_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/error_file.md

#### error_file

```python
def error_file(self):
    ...
```

### error_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/error_string.md

#### error_string

```python
def error_string(self):
    ...
```

### trace method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/trace.md

#### trace

Logs an event that occurred during watermarking.

```python
def trace(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The event message. |

### trace_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/trace_file.md

#### trace_file

```python
def trace_file(self):
    ...
```

### trace_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/trace_string.md

#### trace_string

```python
def trace_string(self):
    ...
```

### warning method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/warning.md

#### warning

Logs a warning that occurred during watermarking.

```python
def warning(self, message):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| message | `str` | The warning message. |

### warning_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/warning_file.md

#### warning_file

```python
def warning_file(self):
    ...
```

### warning_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ilogger/warning_string.md

#### warning_string

```python
def warning_string(self):
    ...
```

### LoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions.md

#### LoadOptions class

Represents document loading options when loading a document.

Learn more:

- Loading documents
- Load from local disk
- Load from stream
- Load document of specific format
- Load password-protected document

The LoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the LoadOptions class. |
| __init__ | Initializes a new instance of the `LoadOptions` class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). |
| password | The password for opening an encrypted document. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions/__init__.md

#### __init__

Initializes a new instance of the LoadOptions class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `LoadOptions` class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted content. |

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions/default.md

#### DEFAULT field

Gets the default value for class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions/file_type.md

#### file_type property

The file type, indicating its format (e.g., docx, pdf, xlsx, etc.).

##### Definition:
```python
@property
def file_type(self):
    ...
@file_type.setter
def file_type(self, value):
    ...
```

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions/format_family.md

#### format_family property

The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

##### Definition:
```python
@property
def format_family(self):
    ...
@format_family.setter
def format_family(self, value):
    ...
```

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/loadoptions/password.md

#### password property

The password for opening an encrypted document.

The password may be `None` or an empty string. The default value is `None`.
If the content is not encrypted, set this to `None` or an empty string.

##### Definition:
```python
@property
def password(self):
    ...
@password.setter
def password(self, value):
    ...
```

### OoxmlLoadOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions.md

#### OoxmlLoadOptions class

Represents document loading options for an OOXML document.

The OoxmlLoadOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `OoxmlLoadOptions` class. |
| __init__ | Initializes a new instance of the `OoxmlLoadOptions` class with a specified password. |

##### Properties
| Property | Description |
| :- | :- |
| file_type | The file type, indicating its format (e.g., docx, pdf, xlsx, etc.). (inherited from `LoadOptions`) |
| format_family | The format family of the document, indicating its type (e.g., Image, Pdf, Spreadsheet, etc.). (inherited from `LoadOptions`) |
| password | The password for opening an encrypted document. (inherited from `LoadOptions`) |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions/__init__.md

#### __init__

Initializes a new instance of the `OoxmlLoadOptions` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `OoxmlLoadOptions` class with a specified password.

```python
def __init__(self, password):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| password | `str` | The password for opening an encrypted content. |

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### file_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions/file_type.md

#### file_type property

Gets or sets the type of the file,
indicating its type (e.g., docx, pdf, xlsx, etc.).

### format_family property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions/format_family.md

#### format_family property

Gets or sets the format family of the document,
indicating its type (e.g., Image, Pdf, Spreadsheet, etc.).

### password property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/ooxmlloadoptions/password.md

#### password property

Gets or sets the password for opening an encrypted document.

##### Remarks

The password be null or empty string. The default value is null.
If the content is not encrypted, set this to null or empty string.

##### Example

Load a content protected with a password.

### PreviewFormats class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/previewformats/bmp.md

##### Value
`2`

### JPEG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewformats/jpeg.md

##### Value
`1`

### PNG field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewformats/png.md

##### Value
`0`

### PreviewOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewoptions.md

#### PreviewOptions class

Provides options to set requirements and stream delegates for preview generation.

The PreviewOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `PreviewOptions` that closes the output stream when done. |
| __init__ | Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use. |

##### Properties
| Property | Description |
| :- | :- |
| create_page_stream | The page stream creation delegate. |
| height | The page preview height. |
| page_numbers | The array of page numbers to generate previews. |
| preview_format | The preview image format. |
| release_page_stream | The page preview completion delegate. |
| width | The page preview width. |

##### Example

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo

output_directory = os.path.join(os.getcwd(), "preview")
os.makedirs(output_directory, exist_ok=True)

def create_page_stream(number: int):
    path = os.path.join(output_directory, f"page{number}.png")
    return open(path, "wb")

def release_page_stream(number: int, stream):
    stream.close()

with gw.Watermarker("sample.pdf") as watermarker:
    preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
    preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
    preview_options.page_numbers = [1, 2]
    watermarker.generate_preview(preview_options)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewoptions/__init__.md

#### __init__

Initializes a new instance of `PreviewOptions` that closes the output stream when done.

```python
def __init__(self, create_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |

##### Example

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo

output_dir = os.path.join(os.getcwd(), "preview")
os.makedirs(output_dir, exist_ok=True)

def create_page_stream(number: int):
    path = os.path.join(output_dir, f"page{number}.png")
    return open(path, "wb")

def release_page_stream(number: int, stream):
    stream.close()

with gw.Watermarker("sample.pdf") as watermarker:
    preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
    preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
    preview_options.page_numbers = [1, 2]
    watermarker.generate_preview(preview_options)
```

#### __init__

Initializes a new instance of `PreviewOptions` class causing the output stream to be returned to the client for further use.

```python
def __init__(self, create_page_stream, release_page_stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| create_page_stream | `CreatePageStream` | Creates a stream for a specific page preview. |
| release_page_stream | `ReleasePageStream` | Notifies that the page preview generation is done and gets the output stream. |

##### Example

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo

output_dir = os.path.join(os.getcwd(), "preview")
os.makedirs(output_dir, exist_ok=True)

def create_page_stream(number: int):
    path = os.path.join(output_dir, f"page{number}.png")
    return open(path, "wb")

def release_page_stream(number: int, stream):
    stream.close()

with gw.Watermarker("sample.pdf") as watermarker:
    preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
    preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
    preview_options.page_numbers = [1, 2]
    watermarker.generate_preview(preview_options)
```

### create_page_stream property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewoptions/create_page_stream.md

#### create_page_stream property

The page stream creation delegate.

##### 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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/previewoptions/page_numbers.md

#### page_numbers property

The array of page numbers to generate previews.

##### Definition:
```python
@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...
```

### preview_format property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/previewoptions/release_page_stream.md

#### release_page_stream property

The page preview completion delegate.

A callable that is invoked after a page preview stream has been created. The callable receives the page number (`int`) and the preview stream (`io.RawIOBase`).

##### Definition:
```python
@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/previewoptions/width.md

#### width property

The page preview width.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ReleasePageStream class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/releasepagestream.md

#### ReleasePageStream class

Represents a method which releases the stream created by the `CreatePageStream` delegate.

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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/releasepagestream/begin_invoke_int32.md

#### begin_invoke_int32

```python
def begin_invoke_int32(self):
    ...
```

### begin_invoke_stream method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/releasepagestream/begin_invoke_stream.md

#### begin_invoke_stream

```python
def begin_invoke_stream(self):
    ...
```

### begin_invoke_streams method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/releasepagestream/begin_invoke_streams.md

#### begin_invoke_streams

```python
def begin_invoke_streams(self):
    ...
```

### end_invoke method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.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/watermark/python-net/groupdocs.watermark.options/releasepagestream/invoke_int32.md

#### invoke_int32

```python
def invoke_int32(self):
    ...
```

### invoke_stream method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/releasepagestream/invoke_stream.md

#### invoke_stream

```python
def invoke_stream(self):
    ...
```

### invoke_streams method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/releasepagestream/invoke_streams.md

#### invoke_streams

```python
def invoke_streams(self):
    ...
```

### SaveOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/saveoptions.md

#### SaveOptions class

Represents document saving options when saving a document.

The SaveOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new `SaveOptions` instance. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/saveoptions/__init__.md

#### __init__

Initializes a new `SaveOptions` instance.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/saveoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### WatermarkOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/watermarkoptions.md

#### WatermarkOptions class

Represents watermark adding options when adding watermark to a document.

The WatermarkOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `WatermarkOptions` class. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/watermarkoptions/__init__.md

#### __init__

Initializes a new instance of the `WatermarkOptions` class.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.options/watermarkoptions/default.md

#### DEFAULT field

Gets the default value for the class.

### groupdocs.watermark.search.objects
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects.md

Types under `groupdocs.watermark.search.objects`.

##### Classes
| Class | Description |
| :- | :- |
| `SearchableObjects` | Specifies document objects that are to be included in a watermark search. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `DiagramSearchableObjects` |  |
| `EmailSearchableObjects` |  |
| `PdfSearchableObjects` |  |
| `PresentationSearchableObjects` |  |
| `SpreadsheetSearchableObjects` |  |
| `WordProcessingSearchableObjects` |  |

### DiagramSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects.md

#### DiagramSearchableObjects class

The DiagramSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| SHAPES | Search in shapes. |
| COMMENTS | Search in comments. |
| HEADERS_FOOTERS | Search in headers and footers. |
| HYPERLINKS | Search in hyperlinks. |
| ALL | Search in all content objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/all.md

#### ALL field

Search in all content objects.

##### Value
`15`

### COMMENTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/comments.md

#### COMMENTS field

Search in comments.

##### Value
`2`

### HEADERS_FOOTERS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/headers_footers.md

#### HEADERS_FOOTERS field

Search in headers and footers.

##### Value
`4`

### HYPERLINKS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/hyperlinks.md

#### HYPERLINKS field

Search in hyperlinks.

##### Value
`8`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### SHAPES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/diagramsearchableobjects/shapes.md

#### SHAPES field

Search in shapes.

##### Value
`1`

### EmailSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects.md

#### EmailSearchableObjects class

The EmailSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| SUBJECT | Search in message subject. |
| PLAIN_TEXT_BODY | Search in message plain text body. |
| HTML_BODY | Search in message html body. |
| ATTACHED_IMAGES | Search in attached images. |
| EMBEDDED_IMAGES | Search in embedded images. |
| ALL | Search in all email objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/all.md

#### ALL field

Search in all email objects.

##### Value
`31`

### ATTACHED_IMAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/attached_images.md

#### ATTACHED_IMAGES field

Search in attached images.

##### Value
`8`

### EMBEDDED_IMAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/embedded_images.md

#### EMBEDDED_IMAGES field

Search in embedded images.

##### Value
`16`

### HTML_BODY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/html_body.md

#### HTML_BODY field

Search in message html body.

##### Value
`4`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### PLAIN_TEXT_BODY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/plain_text_body.md

#### PLAIN_TEXT_BODY field

Search in message plain text body.

##### Value
`2`

### SUBJECT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/emailsearchableobjects/subject.md

#### SUBJECT field

Search in message subject.

##### Value
`1`

### PdfSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects.md

#### PdfSearchableObjects class

The PdfSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| XOBJECTS | Search in XObjects. |
| ARTIFACTS | Search in artifacts. |
| ANNOTATIONS | Search in annotations. |
| TEXT | Search in content text. |
| HYPERLINKS | Search in hyperlinks. |
| ATTACHED_IMAGES | Search in attached images. |
| VECTOR | Search in operators. |
| ALL | Search in all content objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/all.md

#### ALL field

Search in all content objects.

##### Value
`127`

### ANNOTATIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/annotations.md

#### ANNOTATIONS field

Search in annotations.

##### Value
`4`

### ARTIFACTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/artifacts.md

#### ARTIFACTS field

Search in artifacts.

##### Value
`2`

### ATTACHED_IMAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/attached_images.md

#### ATTACHED_IMAGES field

Search in attached images.

##### Value
`32`

### HYPERLINKS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/hyperlinks.md

#### HYPERLINKS field

Search in hyperlinks.

##### Value
`16`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/text.md

#### TEXT field

Search in content text.

##### Value
`8`

### VECTOR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/vector.md

#### VECTOR field

Search in operators.

##### Value
`64`

### XOBJECTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/pdfsearchableobjects/xobjects.md

#### XOBJECTS field

Search in XObjects.

##### Value
`1`

### PresentationSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects.md

#### PresentationSearchableObjects class

The PresentationSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| SHAPES | Search in shapes. |
| CHARTS_BACKGROUNDS | Search in charts backgrounds. |
| SLIDES_BACKGROUNDS | Search in slides backgrounds. |
| HYPERLINKS | Search in hyperlinks. |
| ALL | Search in all content objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/all.md

#### ALL field

Search in all content objects.

##### Value
`15`

### CHARTS_BACKGROUNDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/charts_backgrounds.md

#### CHARTS_BACKGROUNDS field

Search in charts backgrounds.

##### Value
`2`

### HYPERLINKS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/hyperlinks.md

#### HYPERLINKS field

Search in hyperlinks.

##### Value
`8`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### SHAPES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/shapes.md

#### SHAPES field

Search in shapes.

##### Value
`1`

### SLIDES_BACKGROUNDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/presentationsearchableobjects/slides_backgrounds.md

#### SLIDES_BACKGROUNDS field

Search in slides backgrounds.

##### Value
`4`

### SearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects.md

#### SearchableObjects class

Specifies document objects that are to be included in a watermark search.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The SearchableObjects type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SearchableObjects` class. |

##### Properties
| Property | Description |
| :- | :- |
| diagram_searchable_objects | The objects inside a Visio document that are included in a watermark search. |
| email_searchable_objects | The objects inside an email message that are to be included in a watermark search. |
| pdf_searchable_objects | The objects inside a PDF document that are to be included in a watermark search. |
| presentation_searchable_objects | The objects inside a PowerPoint document that are to be included in a watermark search. |
| spreadsheet_searchable_objects | The objects inside an Excel document that are to be included in a watermark search. |
| word_processing_searchable_objects | The objects inside a Word document that are to be included in a watermark search. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

settings = gw.WatermarkerSettings()
settings.searchable_objects = gws.SearchableObjects(
    word_processing_searchable_objects=gws.WordProcessingSearchableObjects.HYPERLINKS | gws.WordProcessingSearchableObjects.TEXT,
    spreadsheet_searchable_objects=gws.SpreadsheetSearchableObjects.HEADERS_FOOTERS,
    presentation_searchable_objects=gws.PresentationSearchableObjects.SLIDES_BACKGROUNDS | gws.PresentationSearchableObjects.SHAPES,
    diagram_searchable_objects=gws.DiagramSearchableObjects.NONE,
    pdf_searchable_objects=gws.PdfSearchableObjects.ALL,
)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/__init__.md

#### __init__

Initializes a new instance of the `SearchableObjects` class.

```python
def __init__(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

searchable = gws.SearchableObjects(
    word_processing_searchable_objects=gws.WordProcessingSearchableObjects.HYPERLINKS
    | gws.WordProcessingSearchableObjects.TEXT,
    spreadsheet_searchable_objects=gws.SpreadsheetSearchableObjects.HEADERS_FOOTERS,
    presentation_searchable_objects=gws.PresentationSearchableObjects.SLIDES_BACKGROUNDS
    | gws.PresentationSearchableObjects.SHAPES,
    diagram_searchable_objects=gws.DiagramSearchableObjects.NONE,
    pdf_searchable_objects=gws.PdfSearchableObjects.ALL,
)
```

### diagram_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/diagram_searchable_objects.md

#### diagram_searchable_objects property

The objects inside a Visio document that are included in a watermark search.

##### Definition:
```python
@property
def diagram_searchable_objects(self):
    ...
@diagram_searchable_objects.setter
def diagram_searchable_objects(self, value):
    ...
```

### email_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/email_searchable_objects.md

#### email_searchable_objects property

The objects inside an email message that are to be included in a watermark search.

##### Definition:
```python
@property
def email_searchable_objects(self):
    ...
@email_searchable_objects.setter
def email_searchable_objects(self, value):
    ...
```

### pdf_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/pdf_searchable_objects.md

#### pdf_searchable_objects property

The objects inside a PDF document that are to be included in a watermark search.

##### Definition:
```python
@property
def pdf_searchable_objects(self):
    ...
@pdf_searchable_objects.setter
def pdf_searchable_objects(self, value):
    ...
```

### presentation_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/presentation_searchable_objects.md

#### presentation_searchable_objects property

The objects inside a PowerPoint document that are to be included in a watermark search.

##### Definition:
```python
@property
def presentation_searchable_objects(self):
    ...
@presentation_searchable_objects.setter
def presentation_searchable_objects(self, value):
    ...
```

### spreadsheet_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/spreadsheet_searchable_objects.md

#### spreadsheet_searchable_objects property

The objects inside an Excel document that are to be included in a watermark search.

##### Definition:
```python
@property
def spreadsheet_searchable_objects(self):
    ...
@spreadsheet_searchable_objects.setter
def spreadsheet_searchable_objects(self, value):
    ...
```

### word_processing_searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/searchableobjects/word_processing_searchable_objects.md

#### word_processing_searchable_objects property

The objects inside a Word document that are to be included in a watermark search.

##### Definition:
```python
@property
def word_processing_searchable_objects(self):
    ...
@word_processing_searchable_objects.setter
def word_processing_searchable_objects(self, value):
    ...
```

### SpreadsheetSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects.md

#### SpreadsheetSearchableObjects class

The SpreadsheetSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| SHAPES | Search in shapes. |
| CHARTS_BACKGROUNDS | Search in charts backgrounds. |
| HEADERS_FOOTERS | Search in headers and footers. |
| WORKSHEET_BACKGROUNDS | Search in worksheets backgrounds. |
| CELLS | Search in cells. |
| HYPERLINKS | Search in hyperlinks. |
| ATTACHED_IMAGES | Search in attached images. |
| ALL | Search in all content objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/all.md

#### ALL field

Search in all content objects.

##### Value
`127`

### ATTACHED_IMAGES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/attached_images.md

#### ATTACHED_IMAGES field

Search in attached images.

##### Value
`64`

### CELLS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/cells.md

#### CELLS field

Search in cells.

##### Value
`16`

### CHARTS_BACKGROUNDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/charts_backgrounds.md

#### CHARTS_BACKGROUNDS field

Search in charts backgrounds.

##### Value
`2`

### HEADERS_FOOTERS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/headers_footers.md

#### HEADERS_FOOTERS field

Search in headers and footers.

##### Value
`4`

### HYPERLINKS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/hyperlinks.md

#### HYPERLINKS field

Search in hyperlinks.

##### Value
`32`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### SHAPES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/shapes.md

#### SHAPES field

Search in shapes.

##### Value
`1`

### WORKSHEET_BACKGROUNDS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/spreadsheetsearchableobjects/worksheet_backgrounds.md

#### WORKSHEET_BACKGROUNDS field

Search in worksheets backgrounds.

##### Value
`8`

### WordProcessingSearchableObjects class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects.md

#### WordProcessingSearchableObjects class

The WordProcessingSearchableObjects type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| NONE | Specifies no search objects. |
| SHAPES | Search in shapes. |
| TEXT | Search in content text. |
| HYPERLINKS | Search in hyperlinks. |
| ALL | Search in all content objects. |

### ALL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects/all.md

#### ALL field

Search in all content objects.

##### Value
`7`

### HYPERLINKS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects/hyperlinks.md

#### HYPERLINKS field

Search in hyperlinks.

##### Value
`4`

### NONE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects/none.md

#### NONE field

Specifies no search objects.

##### Value
`0`

### SHAPES field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects/shapes.md

#### SHAPES field

Search in shapes.

##### Value
`1`

### TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.objects/wordprocessingsearchableobjects/text.md

#### TEXT field

Search in content text.

##### Value
`2`

### groupdocs.watermark.search.search_criteria
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria.md

Types under `groupdocs.watermark.search.search_criteria`.

##### Classes
| Class | Description |
| :- | :- |
| `AndSearchCriteria` | Represents AND composite search criteria. |
| `ColorRange` | Represents a range of colors using HSB representation of RGB color. |
| `ImageColorHistogramSearchCriteria` | Represents search criteria for finding images in a content. |
| `ImageDctHashSearchCriteria` | Represents a search criteria for finding images in a document. |
| `ImageSearchCriteria` | Provides base class for image search criteria. |
| `ImageThumbnailSearchCriteria` | Represents search criteria for finding images in a content. |
| `IsImageSearchCriteria` | Represents search criteria for filtering image watermarks only. |
| `IsTextSearchCriteria` | Represents search criteria for filtering text watermarks only. |
| `OrSearchCriteria` | Represents OR composite search criteria. |
| `PageSearchCriteria` | Represents criteria allowing filtering by page number. |
| `RotateAngleSearchCriteria` | Represents criteria allowing filtering by watermark rotate angle. |
| `SearchCriteria` | Represents criteria used to search for watermarks. |
| `SizeSearchCriteria` | Represents criteria allowing filtering by watermark size. |
| `TextFormattingSearchCriteria` | Represents criteria allowing filtering by text formatting. |
| `TextSearchCriteria` | Represents criteria allowing filtering by watermark text. |
| `VectorSearchCriteria` | Represents criteria allowing filtering by watermark color. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `NotSearchCriteria` | Represents NOT composite search criteria. |

### AndSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/andsearchcriteria.md

#### AndSearchCriteria class

Represents AND composite search criteria.

The AndSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| left | The left search criteria. |
| right | The right search criteria. |

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/andsearchcriteria/left.md

#### left property

The left search criteria.

##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/andsearchcriteria/right.md

#### right property

The right search criteria.

##### Definition:
```python
@property
def right(self):
    ...
```

### ColorRange class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange.md

#### ColorRange class

Represents a range of colors using HSB representation of RGB color.

The ColorRange type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ColorRange` class. |
| __init__ | Initializes a new ColorRange with the specified exact color. |

##### Properties
| Property | Description |
| :- | :- |
| is_empty | The flag indicating whether only the empty color is in range. |
| max_brightness | The ending brightness value. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white. |
| max_hue | The ending hue value, in degrees. |
| max_saturation | The ending saturation value. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated. |
| min_brightness | The starting brightness value. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white. |
| min_hue | The starting hue value, in degrees. |
| min_saturation | The starting saturation value. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/__init__.md

#### __init__

Initializes a new instance of the `ColorRange` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new ColorRange with the specified exact color.

```python
def __init__(self, exact_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| exact_color | `Color` | The exact color from which the range is created. |

### is_empty property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/is_empty.md

#### is_empty property

The flag indicating whether only the empty color is in range.

True if only the empty color is in range (HSB ranges are ignored); otherwise, False.

##### Definition:
```python
@property
def is_empty(self):
    ...
@is_empty.setter
def is_empty(self, value):
    ...
```

### max_brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/max_brightness.md

#### max_brightness property

The ending brightness value. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

##### Definition:
```python
@property
def max_brightness(self):
    ...
@max_brightness.setter
def max_brightness(self, value):
    ...
```

### max_hue property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/max_hue.md

#### max_hue property

The ending hue value, in degrees.

##### Definition:
```python
@property
def max_hue(self):
    ...
@max_hue.setter
def max_hue(self, value):
    ...
```

### max_saturation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/max_saturation.md

#### max_saturation property

The ending saturation value. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

##### Definition:
```python
@property
def max_saturation(self):
    ...
@max_saturation.setter
def max_saturation(self, value):
    ...
```

### min_brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/min_brightness.md

#### min_brightness property

The starting brightness value. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

##### Definition:
```python
@property
def min_brightness(self):
    ...
@min_brightness.setter
def min_brightness(self, value):
    ...
```

### min_hue property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/min_hue.md

#### min_hue property

The starting hue value, in degrees.

##### Definition:
```python
@property
def min_hue(self):
    ...
@min_hue.setter
def min_hue(self, value):
    ...
```

### min_saturation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/colorrange/min_saturation.md

#### min_saturation property

The starting saturation value. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

##### Definition:
```python
@property
def min_saturation(self):
    ...
@min_saturation.setter
def min_saturation(self, value):
    ...
```

### ImageColorHistogramSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagecolorhistogramsearchcriteria.md

#### ImageColorHistogramSearchCriteria class

Represents search criteria for finding images in a content.

This search criteria uses image color histograms for calculating image similarity.

The ImageColorHistogramSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new ImageColorHistogramSearchCriteria with a specified file path. |
| __init__ | Initializes a new ImageColorHistogramSearchCriteria instance with a specified stream. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| bins_count | The number of bins used for building color histograms. |
| max_difference | The maximum allowed difference between images. (inherited from `ImageSearchCriteria`) |
| pages | The list of specific page numbers. (inherited from `PageSearchCriteria`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagecolorhistogramsearchcriteria/__init__.md

#### __init__

Initializes a new ImageColorHistogramSearchCriteria with a specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load image from. |

#### __init__

Initializes a new ImageColorHistogramSearchCriteria instance with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The stream to load the image from. |

### bins_count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagecolorhistogramsearchcriteria/bins_count.md

#### bins_count property

The number of bins used for building color histograms.

The default value is 10.

##### Definition:
```python
@property
def bins_count(self):
    ...
@bins_count.setter
def bins_count(self, value):
    ...
```

### ImageDctHashSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagedcthashsearchcriteria.md

#### ImageDctHashSearchCriteria class

Represents a search criteria for finding images in a document.

This search criteria uses a DCT‑based perceptual image hash to calculate image similarity.

Learn more: https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The ImageDctHashSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the ImageDctHashSearchCriteria class with a specified file path. |
| __init__ | Initializes a new instance of the ImageDctHashSearchCriteria class with a specified stream. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| max_difference | The maximum allowed difference between images. (inherited from `ImageSearchCriteria`) |
| pages | The list of specific page numbers. (inherited from `PageSearchCriteria`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("watermarked-sample.docx") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    image_criteria.max_difference = 0.9
    possible = watermarker.search(image_criteria)
    possible.clear()
    watermarker.save("clean-sample.docx")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagedcthashsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the ImageDctHashSearchCriteria class with a specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load image from. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
```

#### __init__

Initializes a new instance of the ImageDctHashSearchCriteria class with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The stream to load image from. |

### ImageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagesearchcriteria.md

#### ImageSearchCriteria class

Provides base class for image search criteria.

The ImageSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| max_difference | The maximum allowed difference between images. |
| pages | The list of specific page numbers. (inherited from `PageSearchCriteria`) |

### max_difference property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagesearchcriteria/max_difference.md

#### max_difference property

The maximum allowed difference between images.

The value should be between 0 and 1. 0 means that only identical images will be found.

##### Definition:
```python
@property
def max_difference(self):
    ...
@max_difference.setter
def max_difference(self, value):
    ...
```

### ImageThumbnailSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagethumbnailsearchcriteria.md

#### ImageThumbnailSearchCriteria class

Represents search criteria for finding images in a content.

This search criteria uses image binarized thumbnail for calculating image similarity.

The ImageThumbnailSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new ImageThumbnailSearchCriteria with the specified file path. |
| __init__ | Initializes a new ImageThumbnailSearchCriteria instance with a specified stream. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| thumbnail_size | The thumbnail size. By default a 32x32 thumbnail is used. |
| max_difference | The maximum allowed difference between images. (inherited from `ImageSearchCriteria`) |
| pages | The list of specific page numbers. (inherited from `PageSearchCriteria`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagethumbnailsearchcriteria/__init__.md

#### __init__

Initializes a new ImageThumbnailSearchCriteria with the specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load image from. |

#### __init__

Initializes a new ImageThumbnailSearchCriteria instance with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The stream to load image from. |

### thumbnail_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/imagethumbnailsearchcriteria/thumbnail_size.md

#### thumbnail_size property

The thumbnail size. By default a 32x32 thumbnail is used.

##### Definition:
```python
@property
def thumbnail_size(self):
    ...
@thumbnail_size.setter
def thumbnail_size(self, value):
    ...
```

### IsImageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/isimagesearchcriteria.md

#### IsImageSearchCriteria class

Represents search criteria for filtering image watermarks only.

The IsImageSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `IsImageSearchCriteria` class. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/isimagesearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `IsImageSearchCriteria` class.

```python
def __init__(self):
    ...
```

### IsTextSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/istextsearchcriteria.md

#### IsTextSearchCriteria class

Represents search criteria for filtering text watermarks only.

The IsTextSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `IsTextSearchCriteria`. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/istextsearchcriteria/__init__.md

#### __init__

Initializes a new instance of `IsTextSearchCriteria`.

```python
def __init__(self):
    ...
```

### NotSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/notsearchcriteria.md

#### NotSearchCriteria class

Represents NOT composite search criteria.

The NotSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

### OrSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/orsearchcriteria.md

#### OrSearchCriteria class

Represents OR composite search criteria.

The OrSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| left | The left search criteria. |
| right | The right search criteria. |

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/orsearchcriteria/left.md

#### left property

The left search criteria.

##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/orsearchcriteria/right.md

#### right property

The right search criteria.

##### Definition:
```python
@property
def right(self):
    ...
```

### PageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/pagesearchcriteria.md

#### PageSearchCriteria class

Represents criteria allowing filtering by page number.

The PageSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| pages | The list of specific page numbers. |

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/pagesearchcriteria/pages.md

#### pages property

The list of specific page numbers.

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### RotateAngleSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/rotateanglesearchcriteria.md

#### RotateAngleSearchCriteria class

Represents criteria allowing filtering by watermark rotate angle.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The RotateAngleSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the RotateAngleSearchCriteria class with a starting angle and an ending angle. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| maximum_angle | The ending angle in degrees. |
| minimum_angle | The starting angle in degrees. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    # Find watermarks whose rotation angle is between 30 and 60 degrees
    angle_criteria = gws_sc.RotateAngleSearchCriteria(30, 60)

    # Optionally combine with other criteria
    text_criteria = gws_sc.TextSearchCriteria("Company Name")
    combined = angle_criteria.and_(text_criteria)

    results = watermarker.search(combined)
    print("Found", results.count, "possible watermark(s)")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/rotateanglesearchcriteria/__init__.md

#### __init__

Initializes a new instance of the RotateAngleSearchCriteria class with a starting angle and an ending angle.

```python
def __init__(self, min_angle, max_angle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| min_angle | `float` | The starting angle in degrees. |
| max_angle | `float` | The ending angle in degrees. |

##### Example

```python
import groupdocs.watermark.search.searchcriteria as gws_sc

angle_criteria = gws_sc.RotateAngleSearchCriteria(30, 60)
```

### maximum_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/rotateanglesearchcriteria/maximum_angle.md

#### maximum_angle property

The ending angle in degrees.

##### Definition:
```python
@property
def maximum_angle(self):
    ...
```

### minimum_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/rotateanglesearchcriteria/minimum_angle.md

#### minimum_angle property

The starting angle in degrees.

##### Definition:
```python
@property
def minimum_angle(self):
    ...
```

### SearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria.md

#### SearchCriteria class

Represents criteria used to search for watermarks.

The SearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| and_search_criteria |  |
| not_ | Negates the SearchCriteria. |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. |
| or_search_criteria |  |

### and_ method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria/and_.md

#### and_

Combines this `SearchCriteria` with other criteria using logical AND operator.

```python
def and_(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `SearchCriteria` | Search criteria to combine with. |

**Returns:** SearchCriteria: Combined search criteria.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    image_criteria.max_difference = 0.9
    text_criteria = gws_sc.TextSearchCriteria("Company Name")
    angle_criteria = gws_sc.RotateAngleSearchCriteria(30, 60)

    combined = image_criteria.or_(text_criteria).and_(angle_criteria)
    possible = watermarker.search(combined)
    print("Found", possible.count, "possible watermark(s)")
```

### and_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria/and_search_criteria.md

#### and_search_criteria

```python
def and_search_criteria(self):
    ...
```

### not_ method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria/not_.md

#### not_

Negates the SearchCriteria.

```python
def not_(self):
    ...
```

**Returns:** Combined search criteria.

### or_ method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria/or_.md

#### or_

Combines this SearchCriteria with other criteria using logical OR operator.

```python
def or_(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `SearchCriteria` | Search criteria to combine with. |

**Returns:** Combined search criteria.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    text_criteria = gws_sc.TextSearchCriteria("Company Name")
    combined = image_criteria.or_(text_criteria)
    possible = watermarker.search(combined)
    print("Found", possible.count, "possible watermark(s)")
```

### or_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/searchcriteria/or_search_criteria.md

#### or_search_criteria

```python
def or_search_criteria(self):
    ...
```

### SizeSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/sizesearchcriteria.md

#### SizeSearchCriteria class

Represents criteria allowing filtering by watermark size.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The SizeSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new SizeSearchCriteria with a specified dimension, a starting value and an ending value. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| dimension | The dimension of watermark to search by. |
| maximum | The ending value. |
| minimum | The starting value. |

##### Example

```python
import re
from groupdocs.watermark import Watermarker, SizeSearchCriteria, Dimension, RotateAngleSearchCriteria, TextSearchCriteria

with Watermarker(r"C:\test.some_ext") as watermarker:
    width_range = SizeSearchCriteria(Dimension.Width, 50, 100)
    rotate_angle = RotateAngleSearchCriteria(0, 45)
    text_criteria = TextSearchCriteria(re.compile(r"^Test watermark$"))
    watermarks = watermarker.search(text_criteria.and_(width_range.or_(rotate_angle)))
    watermarks.clear()
    watermarker.save()
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/sizesearchcriteria/__init__.md

#### __init__

Initializes a new SizeSearchCriteria with a specified dimension, a starting value and an ending value.

```python
def __init__(self, dimension, min, max):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| dimension | `Dimension` | The dimension of a watermark to search by. |
| min | `float` | The starting value. |
| max | `float` | The ending value. |

### dimension property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/sizesearchcriteria/dimension.md

#### dimension property

The dimension of watermark to search by.

##### Definition:
```python
@property
def dimension(self):
    ...
```

### maximum property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/sizesearchcriteria/maximum.md

#### maximum property

The ending value.

##### Definition:
```python
@property
def maximum(self):
    ...
```

### minimum property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/sizesearchcriteria/minimum.md

#### minimum property

The starting value.

##### Definition:
```python
@property
def minimum(self):
    ...
```

### TextFormattingSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria.md

#### TextFormattingSearchCriteria class

Represents criteria allowing filtering by text formatting.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The TextFormattingSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextFormattingSearchCriteria` class. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| background_color_range | The range of colors used to filter watermarks by text background color. |
| font_bold | The font used in watermark text formatting is bold. |
| font_italic | The font italic flag indicating whether the watermark text uses an italic font. |
| font_name | The name of the font used in possible watermark text formatting. |
| font_strikeout | The font strikeout flag for watermark text formatting. The default value is None, which means that the filter is not applied. |
| font_underline | The font underline flag for the watermark text formatting. The default value is None, which means that the filter is not applied. |
| foreground_color_range | The range of colors used to filter watermarks by text foreground color. |
| max_font_size | The ending value of the font size. |
| min_font_size | The starting value of the font size. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextFormattingSearchCriteria()
    criteria.foreground_color_range = gws_sc.ColorRange()
    criteria.foreground_color_range.min_hue = -5
    criteria.foreground_color_range.max_hue = 10
    criteria.foreground_color_range.min_brightness = 0.01
    criteria.foreground_color_range.max_brightness = 0.99
    criteria.background_color_range = gws_sc.ColorRange()
    criteria.background_color_range.is_empty = True
    criteria.font_name = "Arial"
    criteria.min_font_size = 19
    criteria.max_font_size = 42
    criteria.font_bold = True

    possible = watermarker.search(criteria)
    possible.clear()
    watermarker.save("document.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `TextFormattingSearchCriteria` class.

```python
def __init__(self):
    ...
```

### background_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/background_color_range.md

#### background_color_range property

The range of colors used to filter watermarks by text background color.

##### Definition:
```python
@property
def background_color_range(self):
    ...
@background_color_range.setter
def background_color_range(self, value):
    ...
```

### font_bold property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/font_bold.md

#### font_bold property

The font used in watermark text formatting is bold.

The default value is None, which means that the filter is not applied.

##### Definition:
```python
@property
def font_bold(self):
    ...
@font_bold.setter
def font_bold(self, value):
    ...
```

### font_italic property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/font_italic.md

#### font_italic property

The font italic flag indicating whether the watermark text uses an italic font.

The default value is None, which means that the filter is not applied.

##### Definition:
```python
@property
def font_italic(self):
    ...
@font_italic.setter
def font_italic(self, value):
    ...
```

### font_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/font_name.md

#### font_name property

The name of the font used in possible watermark text formatting.

The default value is None, which means that the filter is not applied.

##### Definition:
```python
@property
def font_name(self):
    ...
@font_name.setter
def font_name(self, value):
    ...
```

### font_strikeout property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/font_strikeout.md

#### font_strikeout property

The font strikeout flag for watermark text formatting. The default value is None, which means that the filter is not applied.

##### Definition:
```python
@property
def font_strikeout(self):
    ...
@font_strikeout.setter
def font_strikeout(self, value):
    ...
```

### font_underline property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/font_underline.md

#### font_underline property

The font underline flag for the watermark text formatting. The default value is None, which means that the filter is not applied.

##### Definition:
```python
@property
def font_underline(self):
    ...
@font_underline.setter
def font_underline(self, value):
    ...
```

### foreground_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/foreground_color_range.md

#### foreground_color_range property

The range of colors used to filter watermarks by text foreground color.

##### Definition:
```python
@property
def foreground_color_range(self):
    ...
@foreground_color_range.setter
def foreground_color_range(self, value):
    ...
```

### max_font_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/max_font_size.md

#### max_font_size property

The ending value of the font size.

##### Definition:
```python
@property
def max_font_size(self):
    ...
@max_font_size.setter
def max_font_size(self, value):
    ...
```

### min_font_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textformattingsearchcriteria/min_font_size.md

#### min_font_size property

The starting value of the font size.

##### Definition:
```python
@property
def min_font_size(self):
    ...
@min_font_size.setter
def min_font_size(self, value):
    ...
```

### TextSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textsearchcriteria.md

#### TextSearchCriteria class

Represents criteria allowing filtering by watermark text.

Learn more: Searching watermarks.

The TextSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `TextSearchCriteria` with a regular expression. |
| __init__ | Initializes a new TextSearchCriteria with a search string and a case‑sensitivity flag. |
| __init__ | Initializes a new instance of the TextSearchCriteria class with a search string. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| pattern | The search pattern. |
| skip_unreadable_characters | The property indicating whether unreadable characters are skipped during string comparison. |
| pages | The list of specific page numbers. (inherited from `PageSearchCriteria`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textsearchcriteria/__init__.md

#### __init__

Initializes a new instance of `TextSearchCriteria` with a regular expression.

```python
def __init__(self, pattern):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| pattern | `System.Text.RegularExpressions.Regex` | The regular expression to match. |

##### Example

```python
import re
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    regex = re.compile(r"^© \d{4}$")
    criteria = gws_sc.TextSearchCriteria(regex)
    possible = watermarker.search(criteria)
    print("Found", possible.count, "possible watermark(s)")
```

#### __init__

Initializes a new TextSearchCriteria with a search string and a case‑sensitivity flag.

```python
def __init__(self, search_string, is_match_case):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_string | `str` | The exact string to search for. |
| is_match_case | `bool` | False to ignore case during the comparison; otherwise, True. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

#### __init__

Initializes a new instance of the TextSearchCriteria class with a search string.

```python
def __init__(self, search_string):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_string | `str` | The exact string to search for. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

### pattern property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textsearchcriteria/pattern.md

#### pattern property

The search pattern.

The regular expression pattern to match.

##### Definition:
```python
@property
def pattern(self):
    ...
```

### skip_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/textsearchcriteria/skip_unreadable_characters.md

#### skip_unreadable_characters property

The property indicating whether unreadable characters are skipped during string comparison.

When set to True, unreadable characters are ignored during comparison.

##### Definition:
```python
@property
def skip_unreadable_characters(self):
    ...
@skip_unreadable_characters.setter
def skip_unreadable_characters(self, value):
    ...
```

### VectorSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/vectorsearchcriteria.md

#### VectorSearchCriteria class

Represents criteria allowing filtering by watermark color.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

The VectorSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `VectorSearchCriteria` class. |

##### Methods
| Method | Description |
| :- | :- |
| and_ | Combines this `SearchCriteria` with other criteria using logical AND operator. (inherited from `SearchCriteria`) |
| and_search_criteria |  (inherited from `SearchCriteria`) |
| not_ | Negates the SearchCriteria. (inherited from `SearchCriteria`) |
| or_ | Combines this SearchCriteria with other criteria using logical OR operator. (inherited from `SearchCriteria`) |
| or_search_criteria |  (inherited from `SearchCriteria`) |

##### Properties
| Property | Description |
| :- | :- |
| vector_color_range | The range of colors used to filter vector watermarks by foreground color. |

##### Example

```python
from GroupDocs.Watermark import Watermarker, VectorSearchCriteria
from GroupDocs.Watermark.Watermarks import Color, ColorRange
from System.Drawing import ColorTranslator

with Watermarker(r"C:\test.pdf") as watermarker:
    search_criteria = VectorSearchCriteria()
    watermark_color = ColorTranslator.FromHtml("#a9aaae")
    system_color = Color.FromArgb(watermark_color.A, watermark_color.R,
                                 watermark_color.G, watermark_color.B)
    criteria_vector_color_range = ColorRange(system_color)
    criteria_vector_color_range.MinBrightness = 0.1
    criteria_vector_color_range.MaxBrightness = 0.7
    search_criteria.VectorColorRange = criteria_vector_color_range

    possible_watermarks = watermarker.Search(search_criteria)
    possible_watermarks.Clear()
    watermarker.Save(r"C:\modified_test.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/vectorsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `VectorSearchCriteria` class.

```python
def __init__(self):
    ...
```

### vector_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.search_criteria/vectorsearchcriteria/vector_color_range.md

#### vector_color_range property

The range of colors used to filter vector watermarks by foreground color.

##### Definition:
```python
@property
def vector_color_range(self):
    ...
@vector_color_range.setter
def vector_color_range(self, value):
    ...
```

### groupdocs.watermark.search.searchcriteria
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria.md

The namespace provides classes that can be used to construct criteria
when searching for watermarks.

##### Classes
| Class | Description |
| :- | :- |
| `AndSearchCriteria` | Represents AND composite search criteria. |
| `ColorRange` | Represents a range of colors. Specifies ranges using HSB representation of RGB color. |
| `ImageColorHistogramSearchCriteria` | Represents search criteria for finding images in a content. |
| `ImageDctHashSearchCriteria` | Represents a search criteria for finding images in a document. |
| `ImageSearchCriteria` | Provides base class for image search criteria. |
| `ImageThumbnailSearchCriteria` | Represents search criteria for finding images in a content. |
| `IsImageSearchCriteria` | Represents search criteria for filtering image watermarks only. |
| `IsTextSearchCriteria` | Represents search criteria for filtering text watermarks only. |
| `NotSearchCriteria` | Represents NOT composite search criteria. |
| `OrSearchCriteria` | Represents OR composite search criteria. |
| `PageSearchCriteria` | Represents criteria allowing filtering by page number |
| `RotateAngleSearchCriteria` | Represents criteria allowing filtering by watermark rotate angle. |
| `SearchCriteria` | Class that can be used to construct criteria when searching for watermarks. |
| `SizeSearchCriteria` | Represents criteria allowing filtering by watermark size. |
| `TextFormattingSearchCriteria` | Represents criteria allowing filtering by text formatting. |
| `TextSearchCriteria` | Represents criteria allowing filtering by watermark text. |
| `VectorSearchCriteria` | Represents criteria allowing filtering by watermark color. |

### AndSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria.md

#### AndSearchCriteria class

Represents AND composite search criteria.

**Inheritance:** `AndSearchCriteria` →
`SearchCriteria`

The AndSearchCriteria type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| right | Gets the right search criteria. |
| left | Gets the left search criteria. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/left.md

#### left property

Gets the left search criteria.
##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/andsearchcriteria/right.md

#### right property

Gets the right search criteria.
##### Definition:
```python
@property
def right(self):
    ...
```

### ColorRange class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange.md

#### ColorRange class

Represents a range of colors. Specifies ranges using HSB representation of RGB color.

The ColorRange type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ColorRange` class. |
| __init__ | Initializes a new instance of the `ColorRange` class with a specified exact color. |

##### Properties
| Property | Description |
| :- | :- |
| min_hue | Gets or sets the starting hue value, in degrees. |
| max_hue | Gets or sets the ending hue value, in degrees. |
| min_saturation | Gets or sets the starting saturation value. |
| max_saturation | Gets or sets the ending saturation value. |
| min_brightness | Gets or sets the starting brightness value. |
| max_brightness | Gets or sets the ending brightness value. |
| is_empty | Gets or sets a value indicating whether only the empty color is in range. |

### ColorRange constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/__init__.md

#### __init__

Initializes a new instance of the `ColorRange` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `ColorRange` class with a specified exact color.

```python
def __init__(self, exact_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| exact_color | groupdocs.watermark.watermarks.Color | The exact color from which the range is created. |

### is_empty property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/is_empty.md

#### is_empty property

Gets or sets a value indicating whether only the empty color is in range.
##### Definition:
```python
@property
def is_empty(self):
    ...
@is_empty.setter
def is_empty(self, value):
    ...
```

### max_brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/max_brightness.md

#### max_brightness property

Gets or sets the ending brightness value.
##### Definition:
```python
@property
def max_brightness(self):
    ...
@max_brightness.setter
def max_brightness(self, value):
    ...
```

### max_hue property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/max_hue.md

#### max_hue property

Gets or sets the ending hue value, in degrees.
##### Definition:
```python
@property
def max_hue(self):
    ...
@max_hue.setter
def max_hue(self, value):
    ...
```

### max_saturation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/max_saturation.md

#### max_saturation property

Gets or sets the ending saturation value.
##### Definition:
```python
@property
def max_saturation(self):
    ...
@max_saturation.setter
def max_saturation(self, value):
    ...
```

### min_brightness property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/min_brightness.md

#### min_brightness property

Gets or sets the starting brightness value.
##### Definition:
```python
@property
def min_brightness(self):
    ...
@min_brightness.setter
def min_brightness(self, value):
    ...
```

### min_hue property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/min_hue.md

#### min_hue property

Gets or sets the starting hue value, in degrees.
##### Definition:
```python
@property
def min_hue(self):
    ...
@min_hue.setter
def min_hue(self, value):
    ...
```

### min_saturation property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/colorrange/min_saturation.md

#### min_saturation property

Gets or sets the starting saturation value.
##### Definition:
```python
@property
def min_saturation(self):
    ...
@min_saturation.setter
def min_saturation(self, value):
    ...
```

### ImageColorHistogramSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria.md

#### ImageColorHistogramSearchCriteria class

Represents search criteria for finding images in a content.

**Inheritance:** `ImageColorHistogramSearchCriteria` →
`ImageSearchCriteria` →
`PageSearchCriteria` →
`SearchCriteria`

The ImageColorHistogramSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path. |
| __init__ | Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream. |

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |
| max_difference | Gets or sets maximum allowed difference between images. |
| bins_count | Gets or sets a count of bins that will be used for building color histograms. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

This search criteria uses image color histograms for calculating image similarity.

### ImageColorHistogramSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The file path to load image from. |

#### __init__

Initializes a new instance of the `ImageColorHistogramSearchCriteria` class with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The stream to load image from. |

### bins_count property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/bins_count.md

#### bins_count property

Gets or sets a count of bins that will be used for building color histograms.
##### Definition:
```python
@property
def bins_count(self):
    ...
@bins_count.setter
def bins_count(self, value):
    ...
```

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### max_difference property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/max_difference.md

#### max_difference property

Gets or sets maximum allowed difference between images.

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagecolorhistogramsearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers

### ImageDctHashSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria.md

#### ImageDctHashSearchCriteria class

Represents a search criteria for finding images in a document.

**Inheritance:** `ImageDctHashSearchCriteria` →
`ImageSearchCriteria` →
`PageSearchCriteria` →
`SearchCriteria`

The ImageDctHashSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path. |
| __init__ | Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream. |

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |
| max_difference | Gets or sets maximum allowed difference between images. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

This search criteria uses DCT based perceptual image hash for calculating image similarity.
**Learn more:** |
|
 |

##### Example

Search for images in the attached files (pdf).

### ImageDctHashSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The file path to load image from. |

#### __init__

Initializes a new instance of the `ImageDctHashSearchCriteria` class with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The stream to load image from. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### max_difference property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/max_difference.md

#### max_difference property

Gets or sets maximum allowed difference between images.

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagedcthashsearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers

### ImageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria.md

#### ImageSearchCriteria class

Provides base class for image search criteria.

**Inheritance:** `ImageSearchCriteria` →
`PageSearchCriteria` →
`SearchCriteria`

The ImageSearchCriteria type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |
| max_difference | Gets or sets maximum allowed difference between images. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### max_difference property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/max_difference.md

#### max_difference property

Gets or sets maximum allowed difference between images.
##### Definition:
```python
@property
def max_difference(self):
    ...
@max_difference.setter
def max_difference(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagesearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers

### ImageThumbnailSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria.md

#### ImageThumbnailSearchCriteria class

Represents search criteria for finding images in a content.

**Inheritance:** `ImageThumbnailSearchCriteria` →
`ImageSearchCriteria` →
`PageSearchCriteria` →
`SearchCriteria`

The ImageThumbnailSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path. |
| __init__ | Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream. |

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |
| max_difference | Gets or sets maximum allowed difference between images. |
| thumbnail_size | Gets or sets thumbnail size. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

This search criteria uses image binarized thumbnail for calculating image similarity.

### ImageThumbnailSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | System.String | The file path to load image from. |

#### __init__

Initializes a new instance of the `ImageThumbnailSearchCriteria` class with a specified stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | io.RawIOBase | The stream to load image from. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### max_difference property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/max_difference.md

#### max_difference property

Gets or sets maximum allowed difference between images.

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers

### thumbnail_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/imagethumbnailsearchcriteria/thumbnail_size.md

#### thumbnail_size property

Gets or sets thumbnail size.
##### Definition:
```python
@property
def thumbnail_size(self):
    ...
@thumbnail_size.setter
def thumbnail_size(self, value):
    ...
```

### IsImageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria.md

#### IsImageSearchCriteria class

Represents search criteria for filtering image watermarks only.

**Inheritance:** `IsImageSearchCriteria` →
`SearchCriteria`

The IsImageSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `IsImageSearchCriteria` class. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### IsImageSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `IsImageSearchCriteria` class.

```python
def __init__(self):
    ...
```

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/isimagesearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### IsTextSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria.md

#### IsTextSearchCriteria class

Represents search criteria for filtering text watermarks only.

**Inheritance:** `IsTextSearchCriteria` →
`SearchCriteria`

The IsTextSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `IsTextSearchCriteria` class. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### IsTextSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `IsTextSearchCriteria` class.

```python
def __init__(self):
    ...
```

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/istextsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### NotSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/notsearchcriteria.md

#### NotSearchCriteria class

Represents NOT composite search criteria.

**Inheritance:** `NotSearchCriteria` →
`SearchCriteria`

The NotSearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/notsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/notsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/notsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### OrSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria.md

#### OrSearchCriteria class

Represents OR composite search criteria.

**Inheritance:** `OrSearchCriteria` →
`SearchCriteria`

The OrSearchCriteria type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| left | Gets the left search criteria. |
| right | Gets the right search criteria. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/left.md

#### left property

Gets the left search criteria.
##### Definition:
```python
@property
def left(self):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/orsearchcriteria/right.md

#### right property

Gets the right search criteria.
##### Definition:
```python
@property
def right(self):
    ...
```

### PageSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria.md

#### PageSearchCriteria class

Represents criteria allowing filtering by page number

**Inheritance:** `PageSearchCriteria` →
`SearchCriteria`

The PageSearchCriteria type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/pagesearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers
##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### RotateAngleSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria.md

#### RotateAngleSearchCriteria class

Represents criteria allowing filtering by watermark rotate angle.

**Inheritance:** `RotateAngleSearchCriteria` →
`SearchCriteria`

The RotateAngleSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `RotateAngleSearchCriteria` class
<br/>with a starting angle and a ending angle. |

##### Properties
| Property | Description |
| :- | :- |
| minimum_angle | Gets the starting angle in degrees. |
| maximum_angle | Gets the ending angle in degrees. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Find and remove watermarks using search criteria.

### RotateAngleSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `RotateAngleSearchCriteria` class
with a starting angle and a ending angle.

```python
def __init__(self, min_angle, max_angle):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| min_angle | float | The starting angle in degrees. |
| max_angle | float | The ending angle in degrees. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### maximum_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/maximum_angle.md

#### maximum_angle property

Gets the ending angle in degrees.
##### Definition:
```python
@property
def maximum_angle(self):
    ...
```

### minimum_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/rotateanglesearchcriteria/minimum_angle.md

#### minimum_angle property

Gets the starting angle in degrees.
##### Definition:
```python
@property
def minimum_angle(self):
    ...
```

### SearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/searchcriteria.md

#### SearchCriteria class

Class that can be used to construct criteria when searching for watermarks.

The SearchCriteria type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/searchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/searchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/searchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### SizeSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria.md

#### SizeSearchCriteria class

Represents criteria allowing filtering by watermark size.

**Inheritance:** `SizeSearchCriteria` →
`SearchCriteria`

The SizeSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `SizeSearchCriteria` class
<br/>with a specified dimension, a starting value and an ending value. |

##### Properties
| Property | Description |
| :- | :- |
| minimum | Gets the starting value. |
| maximum | Gets the ending value. |
| dimension | Gets the dimension of watermark to search by. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Find and remove watermark using search criteria.

### SizeSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `SizeSearchCriteria` class
with a specified dimension, a starting value and an ending value.

```python
def __init__(self, dimension, min, max):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| dimension | groupdocs.watermark.common.Dimension | The dimension of a watermark to search by. |
| min | float | The starting value. |
| max | float | The ending value. |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### dimension property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/dimension.md

#### dimension property

Gets the dimension of watermark to search by.
##### Definition:
```python
@property
def dimension(self):
    ...
```

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### maximum property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/maximum.md

#### maximum property

Gets the ending value.
##### Definition:
```python
@property
def maximum(self):
    ...
```

### minimum property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/sizesearchcriteria/minimum.md

#### minimum property

Gets the starting value.
##### Definition:
```python
@property
def minimum(self):
    ...
```

### TextFormattingSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria.md

#### TextFormattingSearchCriteria class

Represents criteria allowing filtering by text formatting.

**Inheritance:** `TextFormattingSearchCriteria` →
`SearchCriteria`

The TextFormattingSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextFormattingSearchCriteria` class. |

##### Properties
| Property | Description |
| :- | :- |
| foreground_color_range | Gets or sets the range of colors which are used to filter watermarks by text foreground color. |
| background_color_range | Gets or sets the range of colors which are used to filter watermarks by text background color. |
| font_name | Gets or sets the name of the font which is used in possible watermark text formatting. |
| min_font_size | Gets or sets the starting value of the font size. |
| max_font_size | Gets or sets the ending value of the font size. |
| font_bold | Gets or sets a value indicating whether the font used in watermark text formatting is bold. |
| font_italic | Gets or sets a value indicating whether the font used in watermark text formatting is italic. |
| font_underline | Gets or sets a value indicating whether the font used in watermark text formatting is underline. |
| font_strikeout | Gets or sets a value indicating whether the font used in watermark text formatting is strikeout. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Remove possible watermarks with a particular text formatting (regardless of document type).

### TextFormattingSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `TextFormattingSearchCriteria` class.

```python
def __init__(self):
    ...
```

### background_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/background_color_range.md

#### background_color_range property

Gets or sets the range of colors which are used to filter watermarks by text background color.
##### Definition:
```python
@property
def background_color_range(self):
    ...
@background_color_range.setter
def background_color_range(self, value):
    ...
```

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### font_bold property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/font_bold.md

#### font_bold property

Gets or sets a value indicating whether the font used in watermark text formatting is bold.
##### Definition:
```python
@property
def font_bold(self):
    ...
@font_bold.setter
def font_bold(self, value):
    ...
```

### font_italic property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/font_italic.md

#### font_italic property

Gets or sets a value indicating whether the font used in watermark text formatting is italic.
##### Definition:
```python
@property
def font_italic(self):
    ...
@font_italic.setter
def font_italic(self, value):
    ...
```

### font_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/font_name.md

#### font_name property

Gets or sets the name of the font which is used in possible watermark text formatting.
##### Definition:
```python
@property
def font_name(self):
    ...
@font_name.setter
def font_name(self, value):
    ...
```

### font_strikeout property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/font_strikeout.md

#### font_strikeout property

Gets or sets a value indicating whether the font used in watermark text formatting is strikeout.
##### Definition:
```python
@property
def font_strikeout(self):
    ...
@font_strikeout.setter
def font_strikeout(self, value):
    ...
```

### font_underline property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/font_underline.md

#### font_underline property

Gets or sets a value indicating whether the font used in watermark text formatting is underline.
##### Definition:
```python
@property
def font_underline(self):
    ...
@font_underline.setter
def font_underline(self, value):
    ...
```

### foreground_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/foreground_color_range.md

#### foreground_color_range property

Gets or sets the range of colors which are used to filter watermarks by text foreground color.
##### Definition:
```python
@property
def foreground_color_range(self):
    ...
@foreground_color_range.setter
def foreground_color_range(self, value):
    ...
```

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### max_font_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/max_font_size.md

#### max_font_size property

Gets or sets the ending value of the font size.
##### Definition:
```python
@property
def max_font_size(self):
    ...
@max_font_size.setter
def max_font_size(self, value):
    ...
```

### min_font_size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textformattingsearchcriteria/min_font_size.md

#### min_font_size property

Gets or sets the starting value of the font size.
##### Definition:
```python
@property
def min_font_size(self):
    ...
@min_font_size.setter
def min_font_size(self, value):
    ...
```

### TextSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria.md

#### TextSearchCriteria class

Represents criteria allowing filtering by watermark text.

**Inheritance:** `TextSearchCriteria` →
`PageSearchCriteria` →
`SearchCriteria`

The TextSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `TextSearchCriteria` class
<br/>with a search string and a flag for comparison. |
| __init__ | Initializes a new instance of the `TextSearchCriteria` class with a search string. |

##### Properties
| Property | Description |
| :- | :- |
| pages | Gets or sets the list of specific page numbers |
| skip_unreadable_characters | Gets or sets a value indicating that unreadable characters will be skipped during string comparison. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Find and remove watermark using search criteria.

### TextSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `TextSearchCriteria` class with a search string.

```python
def __init__(self, search_string):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_string | System.String | The exact string to search for. |

#### __init__

Initializes a new instance of the `TextSearchCriteria` class
with a search string and a flag for comparison.

```python
def __init__(self, search_string, is_match_case):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_string | System.String | The exact string to search for. |
| is_match_case | bool | to ignore case during the comparison; otherwise, . |

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/pages.md

#### pages property

Gets or sets the list of specific page numbers

### skip_unreadable_characters property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/textsearchcriteria/skip_unreadable_characters.md

#### skip_unreadable_characters property

Gets or sets a value indicating that unreadable characters will be skipped during string comparison.
##### Definition:
```python
@property
def skip_unreadable_characters(self):
    ...
@skip_unreadable_characters.setter
def skip_unreadable_characters(self, value):
    ...
```

### VectorSearchCriteria class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria.md

#### VectorSearchCriteria class

Represents criteria allowing filtering by watermark color.

**Inheritance:** `VectorSearchCriteria` →
`SearchCriteria`

The VectorSearchCriteria type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `VectorSearchCriteria` class. |

##### Properties
| Property | Description |
| :- | :- |
| vector_color_range | Gets or sets the range of colors which are used to filter vector watermarks by foreground color. |

##### Methods
| Method | Description |
| :- | :- |
| both | Combines this `SearchCriteria` with other criteria using logical AND operator. |
| either | Combines this `SearchCriteria` with other criteria using logical OR operator. |
| is_not | Negates this `SearchCriteria`. |

##### Remarks

**Learn more:** |
|
 |

##### Example

Find and remove watermark using search criteria.

### VectorSearchCriteria constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/__init__.md

#### __init__

Initializes a new instance of the `VectorSearchCriteria` class.

```python
def __init__(self):
    ...
```

### both method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/both.md

#### both

Combines this `SearchCriteria` with other criteria using logical AND operator.

##### Returns

Combined search criteria.

```python
def both(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### either method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/either.md

#### either

Combines this `SearchCriteria` with other criteria using logical OR operator.

##### Returns

Combined search criteria.

```python
def either(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | groupdocs.watermark.search.searchcriteria.SearchCriteria | Search criteria to combine with. |

### is_not method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/is_not.md

#### is_not

Negates this `SearchCriteria`.

##### Returns

Combined search criteria.

```python
def is_not(self):
    ...
```

### vector_color_range property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.searchcriteria/vectorsearchcriteria/vector_color_range.md

#### vector_color_range property

Gets or sets the range of colors which are used to filter vector watermarks by foreground color.
##### Definition:
```python
@property
def vector_color_range(self):
    ...
@vector_color_range.setter
def vector_color_range(self, value):
    ...
```

### groupdocs.watermark.search.watermarks
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks.md

Types under `groupdocs.watermark.search.watermarks`.

##### Classes
| Class | Description |
| :- | :- |
| `DiagramCommentPossibleWatermark` | Represents possible watermark in a Visio document comment. |
| `DiagramHeaderFooterPossibleWatermark` | Represents possible watermark in a Visio document header/footer. |
| `DiagramHyperlinkPossibleWatermark` | Represents possible hyperlink watermark in a Visio document. |
| `DiagramShapePossibleWatermark` | Represents possible shape watermark in a Visio document. |
| `EmailTextPossibleWatermark` | Represents possible watermark in email message text fields. |
| `PdfAnnotationPossibleWatermark` | Represents possible annotation watermark in a pdf document. |
| `PdfArtifactPossibleWatermark` | Represents possible artifact watermark in a pdf content. |
| `PdfHyperlinkPossibleWatermark` | Represents possible hyperlink watermark in a pdf document. |
| `PdfTextPossibleWatermark` | Represents possible watermark in a pdf document text. |
| `PdfVectorPossibleWatermark` | Represents possible vector watermark in a pdf document. |
| `PdfXObjectPossibleWatermark` | Represents possible XObject watermark in a PDF content. |
| `PresentationBackgroundPossibleWatermark` | Represents possible background watermark in a PowerPoint document. |
| `PresentationChartBackgroundPossibleWatermark` | Represents possible background watermark in a PowerPoint chart. |
| `PresentationHyperlinkPossibleWatermark` | Represents possible hyperlink watermark in a PowerPoint document. |
| `PresentationShapePossibleWatermark` | Represents possible shape watermark in a PowerPoint document. |
| `SpreadsheetBackgroundPossibleWatermark` | Represents possible background watermark in an Excel document. |
| `SpreadsheetCellPossibleWatermark` | Represents possible cell watermark in an Excel document. |
| `SpreadsheetChartBackgroundPossibleWatermark` | Represents possible image watermark in Excel chart background. |
| `SpreadsheetHeaderFooterPossibleWatermark` | Represents possible watermark in a header or footer of an Excel document. |
| `SpreadsheetHyperlinkPossibleWatermark` | Represents possible hyperlink watermark in an Excel document. |
| `SpreadsheetShapePossibleWatermark` | Represents possible shape watermark in an Excel document. |
| `WordProcessingShapePossibleWatermark` | Represents possible shape watermark in a Word document. |
| `WordProcessingTextHyperlinkPossibleWatermark` | Represents possible hyperlink watermark in a Word document. |
| `WordProcessingTextPossibleWatermark` | Represents possible watermark in a Word document text. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `EmailAttachedImagePossibleWatermark` | Represents possible image watermark in email message attachment. |
| `EmailBodyTextPossibleWatermark` | Represents possible watermark in email message body. |
| `EmailEmbeddedImagePossibleWatermark` | Represents possible image watermark embedded to email message body. |
| `EmailHtmlBodyTextPossibleWatermark` | Represents possible watermark in email message html body. |
| `EmailSubjectTextPossibleWatermark` | Represents possible watermark in email message subject. |
| `PdfAttachedImagePossibleWatermark` | Represents possible image watermark in pdf document attachment. |
| `SpreadsheetAttachedImagePossibleWatermark` | Represents possible image watermark in Excel document attachment. |

### DiagramCommentPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark.md

#### DiagramCommentPossibleWatermark class

Represents possible watermark in a Visio document comment.

The DiagramCommentPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this DiagramCommentPossibleWatermark in points. |
| parent | The parent of this `DiagramCommentPossibleWatermark`. |
| rotate_angle | The rotate angle of this DiagramCommentPossibleWatermark in degrees. |
| text | The text of this `DiagramCommentPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `DiagramCommentPossibleWatermark`. |
| width | The width of this `DiagramCommentPossibleWatermark` in points. |
| x | The x-coordinate of this `DiagramCommentPossibleWatermark`, representing the horizontal offset from the page left border in points. |
| y | The vertical offset of this `DiagramCommentPossibleWatermark` from the page bottom border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/height.md

#### height property

The height of this DiagramCommentPossibleWatermark in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/parent.md

#### parent property

The parent of this `DiagramCommentPossibleWatermark`.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this DiagramCommentPossibleWatermark in degrees.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/text.md

#### text property

The text of this `DiagramCommentPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `DiagramCommentPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/width.md

#### width property

The width of this `DiagramCommentPossibleWatermark` in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/x.md

#### x property

The x-coordinate of this `DiagramCommentPossibleWatermark`, representing the horizontal offset from the page left border in points.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramcommentpossiblewatermark/y.md

#### y property

The vertical offset of this `DiagramCommentPossibleWatermark` from the page bottom border in points.

##### Definition:
```python
@property
def y(self):
    ...
```

### DiagramHeaderFooterPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark.md

#### DiagramHeaderFooterPossibleWatermark class

Represents possible watermark in a Visio document header/footer.

The DiagramHeaderFooterPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this `DiagramHeaderFooterPossibleWatermark` in points. The value is always 0 for this type of possible watermark. |
| parent | The parent of this DiagramHeaderFooterPossibleWatermark. |
| rotate_angle | The rotate angle of this DiagramHeaderFooterPossibleWatermark in degrees. |
| text | The text of this `DiagramHeaderFooterPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `DiagramHeaderFooterPossibleWatermark`. |
| width | The width of this DiagramHeaderFooterPossibleWatermark in points. The value is always 0 for this type of possible watermark. |
| x | The horizontal offset of this DiagramHeaderFooterPossibleWatermark from the page left border in points. |
| y | The vertical offset of this `DiagramHeaderFooterPossibleWatermark` from the page bottom border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/height.md

#### height property

The height of this `DiagramHeaderFooterPossibleWatermark` in points. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/parent.md

#### parent property

The parent of this DiagramHeaderFooterPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this DiagramHeaderFooterPossibleWatermark in degrees.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/text.md

#### text property

The text of this `DiagramHeaderFooterPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `DiagramHeaderFooterPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/width.md

#### width property

The width of this DiagramHeaderFooterPossibleWatermark in points. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/x.md

#### x property

The horizontal offset of this DiagramHeaderFooterPossibleWatermark from the page left border in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramheaderfooterpossiblewatermark/y.md

#### y property

The vertical offset of this `DiagramHeaderFooterPossibleWatermark` from the page bottom border in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def y(self):
    ...
```

### DiagramHyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark.md

#### DiagramHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a Visio document.

The DiagramHyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | The URL of this `DiagramHyperlinkPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| rotate_angle | The rotate angle of this `HyperlinkPossibleWatermark` in degrees. (inherited from `HyperlinkPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |
| width | The width of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| x | The x-coordinate of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| y | The y-coordinate of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/height.md

#### height property

Gets the height of this `HyperlinkPossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/parent.md

#### parent property

Gets the parent of this `HyperlinkPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/text.md

#### text property

The URL of this `DiagramHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `HyperlinkPossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/width.md

#### width property

Gets the width of this `HyperlinkPossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `HyperlinkPossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramhyperlinkpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `HyperlinkPossibleWatermark`.

### DiagramShapePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark.md

#### DiagramShapePossibleWatermark class

Represents possible shape watermark in a Visio document.

The DiagramShapePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this DiagramShapePossibleWatermark. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/parent.md

#### parent property

The parent of this DiagramShapePossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/diagramshapepossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### EmailAttachedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark.md

#### EmailAttachedImagePossibleWatermark class

Represents possible image watermark in email message attachment.

The EmailAttachedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height |  (inherited from `AttachedImagePossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent |  (inherited from `AttachedImagePossibleWatermark`) |
| rotate_angle |  (inherited from `AttachedImagePossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| unit_of_measurement |  (inherited from `AttachedImagePossibleWatermark`) |
| width |  (inherited from `AttachedImagePossibleWatermark`) |
| x |  (inherited from `AttachedImagePossibleWatermark`) |
| y |  (inherited from `AttachedImagePossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/parent.md

#### parent property

Gets the parent of this `PossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailattachedimagepossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### EmailBodyTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark.md

#### EmailBodyTextPossibleWatermark class

Represents possible watermark in email message body.

The EmailBodyTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. (inherited from `PossibleWatermark`) |
| text | The text of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| x | The x-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| y | The y-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/parent.md

#### parent property

Gets the parent of this `EmailTextPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/text.md

#### text property

Gets or sets the text of this `EmailTextPossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailbodytextpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### EmailEmbeddedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark.md

#### EmailEmbeddedImagePossibleWatermark class

Represents possible image watermark embedded to email message body.

The EmailEmbeddedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height |  (inherited from `AttachedImagePossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent |  (inherited from `AttachedImagePossibleWatermark`) |
| rotate_angle |  (inherited from `AttachedImagePossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| unit_of_measurement |  (inherited from `AttachedImagePossibleWatermark`) |
| width |  (inherited from `AttachedImagePossibleWatermark`) |
| x |  (inherited from `AttachedImagePossibleWatermark`) |
| y |  (inherited from `AttachedImagePossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/parent.md

#### parent property

Gets the parent of this `PossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailembeddedimagepossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### EmailHtmlBodyTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark.md

#### EmailHtmlBodyTextPossibleWatermark class

Represents possible watermark in email message html body.

The EmailHtmlBodyTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. (inherited from `PossibleWatermark`) |
| text | The text of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| x | The x-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| y | The y-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/parent.md

#### parent property

Gets the parent of this `EmailTextPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/text.md

#### text property

Gets or sets the text of this `EmailTextPossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailhtmlbodytextpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### EmailSubjectTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark.md

#### EmailSubjectTextPossibleWatermark class

Represents possible watermark in email message subject.

The EmailSubjectTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. (inherited from `PossibleWatermark`) |
| text | The text of this EmailTextPossibleWatermark. (inherited from `EmailTextPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| x | The x-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| y | The y-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/parent.md

#### parent property

Gets the parent of this `EmailTextPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/text.md

#### text property

Gets or sets the text of this `EmailTextPossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailsubjecttextpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### EmailTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark.md

#### EmailTextPossibleWatermark class

Represents possible watermark in email message text fields.

The EmailTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this EmailTextPossibleWatermark. |
| text | The text of this EmailTextPossibleWatermark. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. (inherited from `PossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| x | The x-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| y | The y-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/parent.md

#### parent property

The parent of this EmailTextPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/text.md

#### text property

The text of this EmailTextPossibleWatermark.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/emailtextpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### PdfAnnotationPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark.md

#### PdfAnnotationPossibleWatermark class

Represents possible annotation watermark in a pdf document.

The PdfAnnotationPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this `PdfAnnotationPossibleWatermark`. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/parent.md

#### parent property

The parent of this `PdfAnnotationPossibleWatermark`.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfannotationpossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### PdfArtifactPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark.md

#### PdfArtifactPossibleWatermark class

Represents possible artifact watermark in a pdf content.

The PdfArtifactPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this PdfArtifactPossibleWatermark. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/parent.md

#### parent property

The parent of this PdfArtifactPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfartifactpossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### PdfAttachedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark.md

#### PdfAttachedImagePossibleWatermark class

Represents possible image watermark in pdf document attachment.

The PdfAttachedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height |  (inherited from `AttachedImagePossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent |  (inherited from `AttachedImagePossibleWatermark`) |
| rotate_angle |  (inherited from `AttachedImagePossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| unit_of_measurement |  (inherited from `AttachedImagePossibleWatermark`) |
| width |  (inherited from `AttachedImagePossibleWatermark`) |
| x |  (inherited from `AttachedImagePossibleWatermark`) |
| y |  (inherited from `AttachedImagePossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/parent.md

#### parent property

Gets the parent of this `PossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfattachedimagepossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### PdfHyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark.md

#### PdfHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a pdf document.

The PdfHyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | The url of this PdfHyperlinkPossibleWatermark. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| rotate_angle | The rotate angle of this `HyperlinkPossibleWatermark` in degrees. (inherited from `HyperlinkPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |
| width | The width of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| x | The x-coordinate of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| y | The y-coordinate of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/height.md

#### height property

Gets the height of this `HyperlinkPossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/parent.md

#### parent property

Gets the parent of this `HyperlinkPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/text.md

#### text property

The url of this PdfHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `HyperlinkPossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/width.md

#### width property

Gets the width of this `HyperlinkPossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `HyperlinkPossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfhyperlinkpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `HyperlinkPossibleWatermark`.

### PdfTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark.md

#### PdfTextPossibleWatermark class

Represents possible watermark in a pdf document text.

The PdfTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PdfTextPossibleWatermark`. |
| height | The height of this PdfTextPossibleWatermark in points. |
| parent | The parent of this PdfTextPossibleWatermark. |
| rotate_angle | The rotate angle of this `PdfTextPossibleWatermark` in degrees. The value is always 0 for this type of possible watermark. |
| text | The text of this `PdfTextPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `PdfTextPossibleWatermark`. |
| width | The width of this PdfTextPossibleWatermark in points. |
| x | The horizontal offset of this PdfTextPossibleWatermark from the page left border in points. |
| y | The y-coordinate of this `PdfTextPossibleWatermark` from the page bottom border in points. |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `PdfTextPossibleWatermark`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/height.md

#### height property

The height of this PdfTextPossibleWatermark in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/parent.md

#### parent property

The parent of this PdfTextPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `PdfTextPossibleWatermark` in degrees. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/text.md

#### text property

The text of this `PdfTextPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `PdfTextPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/width.md

#### width property

The width of this PdfTextPossibleWatermark in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/x.md

#### x property

The horizontal offset of this PdfTextPossibleWatermark from the page left border in points.

The x-coordinate of this PdfTextPossibleWatermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdftextpossiblewatermark/y.md

#### y property

The y-coordinate of this `PdfTextPossibleWatermark` from the page bottom border in points.

##### Definition:
```python
@property
def y(self):
    ...
```

### PdfVectorPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark.md

#### PdfVectorPossibleWatermark class

Represents possible vector watermark in a pdf document.

The PdfVectorPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this PdfVectorPossibleWatermark. |
| pdf_operator_collection | The collection of vector operators of this `PdfVectorPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| x | The x-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| y | The y-coordinate of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/parent.md

#### parent property

The parent of this PdfVectorPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### pdf_operator_collection property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/pdf_operator_collection.md

#### pdf_operator_collection property

The collection of vector operators of this `PdfVectorPossibleWatermark`.

##### Definition:
```python
@property
def pdf_operator_collection(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfvectorpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### PdfXObjectPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark.md

#### PdfXObjectPossibleWatermark class

Represents possible XObject watermark in a PDF content.

The PdfXObjectPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this `PdfXObjectPossibleWatermark`. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/parent.md

#### parent property

The parent of this `PdfXObjectPossibleWatermark`.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/pdfxobjectpossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### PresentationBackgroundPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark.md

#### PresentationBackgroundPossibleWatermark class

Represents possible background watermark in a PowerPoint document.

The PresentationBackgroundPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this PresentationBackgroundPossibleWatermark in points. |
| parent | The parent of this PresentationBackgroundPossibleWatermark. |
| rotate_angle | The rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees. |
| unit_of_measurement | The unit of measurement of this PresentationBackgroundPossibleWatermark. |
| width | The width of this PresentationBackgroundPossibleWatermark in points. |
| x | The horizontal offset of this PresentationBackgroundPossibleWatermark from the slide left border, in points. |
| y | The vertical offset of this PresentationBackgroundPossibleWatermark from the slide top border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/height.md

#### height property

The height of this PresentationBackgroundPossibleWatermark in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/parent.md

#### parent property

The parent of this PresentationBackgroundPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `PresentationBackgroundPossibleWatermark` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this PresentationBackgroundPossibleWatermark.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/width.md

#### width property

The width of this PresentationBackgroundPossibleWatermark in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/x.md

#### x property

The horizontal offset of this PresentationBackgroundPossibleWatermark from the slide left border, in points.

The x-coordinate of this PresentationBackgroundPossibleWatermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationbackgroundpossiblewatermark/y.md

#### y property

The vertical offset of this PresentationBackgroundPossibleWatermark from the slide top border in points.

The y-coordinate of this PresentationBackgroundPossibleWatermark.

##### Definition:
```python
@property
def y(self):
    ...
```

### PresentationChartBackgroundPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark.md

#### PresentationChartBackgroundPossibleWatermark class

Represents possible background watermark in a PowerPoint chart.

The PresentationChartBackgroundPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this PresentationChartBackgroundPossibleWatermark. |
| rotate_angle | The rotate angle of this PresentationChartBackgroundPossibleWatermark in degrees. |
| unit_of_measurement | The unit of measurement of this `PresentationChartBackgroundPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/parent.md

#### parent property

The parent of this PresentationChartBackgroundPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this PresentationChartBackgroundPossibleWatermark in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `PresentationChartBackgroundPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationchartbackgroundpossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### PresentationHyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark.md

#### PresentationHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a PowerPoint document.

The PresentationHyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| text | The URL of this `HyperlinkPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| rotate_angle | The rotate angle of this `HyperlinkPossibleWatermark` in degrees. (inherited from `HyperlinkPossibleWatermark`) |
| unit_of_measurement | The unit of measurement of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |
| width | The width of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| x | The x-coordinate of this HyperlinkPossibleWatermark. (inherited from `HyperlinkPossibleWatermark`) |
| y | The y-coordinate of this `HyperlinkPossibleWatermark`. (inherited from `HyperlinkPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/height.md

#### height property

Gets the height of this `HyperlinkPossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/parent.md

#### parent property

Gets the parent of this `HyperlinkPossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `HyperlinkPossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/text.md

#### text property

The URL of this `HyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `HyperlinkPossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/width.md

#### width property

Gets the width of this `HyperlinkPossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `HyperlinkPossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationhyperlinkpossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `HyperlinkPossibleWatermark`.

### PresentationShapePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark.md

#### PresentationShapePossibleWatermark class

Represents possible shape watermark in a PowerPoint document.

The PresentationShapePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this PresentationShapePossibleWatermark. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/parent.md

#### parent property

The parent of this PresentationShapePossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/presentationshapepossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### SpreadsheetAttachedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark.md

#### SpreadsheetAttachedImagePossibleWatermark class

Represents possible image watermark in Excel document attachment.

The SpreadsheetAttachedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height |  (inherited from `FloatingAttachedImagePossibleWatermark`) |
| parent |  (inherited from `FloatingAttachedImagePossibleWatermark`) |
| width |  (inherited from `FloatingAttachedImagePossibleWatermark`) |
| x |  (inherited from `FloatingAttachedImagePossibleWatermark`) |
| y |  (inherited from `FloatingAttachedImagePossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/height.md

#### height property

Gets the height of this `PossibleWatermark`.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/parent.md

#### parent property

Gets the parent of this `PossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of this `PossibleWatermark` in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of this `PossibleWatermark`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/width.md

#### width property

Gets the width of this `PossibleWatermark`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/x.md

#### x property

Gets the x-coordinate of this `PossibleWatermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetattachedimagepossiblewatermark/y.md

#### y property

Gets the y-coordinate of this `PossibleWatermark`.

### SpreadsheetBackgroundPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark.md

#### SpreadsheetBackgroundPossibleWatermark class

Represents possible background watermark in an Excel document.

The SpreadsheetBackgroundPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this `SpreadsheetBackgroundPossibleWatermark` in pixels. |
| parent | The parent of this SpreadsheetBackgroundPossibleWatermark. |
| rotate_angle | The rotate angle of this SpreadsheetBackgroundPossibleWatermark in degrees. |
| unit_of_measurement | The unit of measurement of this `SpreadsheetBackgroundPossibleWatermark`. |
| width | The width of this SpreadsheetBackgroundPossibleWatermark in pixels. |
| x | The horizontal offset of this SpreadsheetBackgroundPossibleWatermark from the worksheet left border in pixels. |
| y | The y-coordinate of this SpreadsheetBackgroundPossibleWatermark in pixels. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/height.md

#### height property

The height of this `SpreadsheetBackgroundPossibleWatermark` in pixels.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetBackgroundPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetBackgroundPossibleWatermark in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `SpreadsheetBackgroundPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/width.md

#### width property

The width of this SpreadsheetBackgroundPossibleWatermark in pixels.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/x.md

#### x property

The horizontal offset of this SpreadsheetBackgroundPossibleWatermark from the worksheet left border in pixels.

The x-coordinate of this SpreadsheetBackgroundPossibleWatermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetbackgroundpossiblewatermark/y.md

#### y property

The y-coordinate of this SpreadsheetBackgroundPossibleWatermark in pixels.

##### Definition:
```python
@property
def y(self):
    ...
```

### SpreadsheetCellPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark.md

#### SpreadsheetCellPossibleWatermark class

Represents possible cell watermark in an Excel document.

The SpreadsheetCellPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this SpreadsheetCellPossibleWatermark. |
| height | The height of this SpreadsheetCellPossibleWatermark in points. |
| parent | The parent of this SpreadsheetCellPossibleWatermark. |
| rotate_angle | The rotate angle of this SpreadsheetCellPossibleWatermark in degrees. |
| text | The text of this `SpreadsheetCellPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `SpreadsheetCellPossibleWatermark`. |
| width | The width of this SpreadsheetCellPossibleWatermark in points. |
| x | The horizontal offset of this SpreadsheetCellPossibleWatermark from the content left border in points. |
| y | The vertical offset of this SpreadsheetCellPossibleWatermark from the content top border in points. |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this SpreadsheetCellPossibleWatermark.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/height.md

#### height property

The height of this SpreadsheetCellPossibleWatermark in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetCellPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetCellPossibleWatermark in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/text.md

#### text property

The text of this `SpreadsheetCellPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `SpreadsheetCellPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/width.md

#### width property

The width of this SpreadsheetCellPossibleWatermark in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/x.md

#### x property

The horizontal offset of this SpreadsheetCellPossibleWatermark from the content left border in points.

This is the x-coordinate of the watermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetcellpossiblewatermark/y.md

#### y property

The vertical offset of this SpreadsheetCellPossibleWatermark from the content top border in points.

The y-coordinate of this SpreadsheetCellPossibleWatermark.

##### Definition:
```python
@property
def y(self):
    ...
```

### SpreadsheetChartBackgroundPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark.md

#### SpreadsheetChartBackgroundPossibleWatermark class

Represents possible image watermark in Excel chart background.

The SpreadsheetChartBackgroundPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this SpreadsheetChartBackgroundPossibleWatermark. |
| rotate_angle | The rotate angle of this SpreadsheetChartBackgroundPossibleWatermark in degrees. |
| unit_of_measurement | The unit of measurement of this `SpreadsheetChartBackgroundPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetChartBackgroundPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetChartBackgroundPossibleWatermark in degrees.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `SpreadsheetChartBackgroundPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetchartbackgroundpossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### SpreadsheetHeaderFooterPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark.md

#### SpreadsheetHeaderFooterPossibleWatermark class

Represents possible watermark in a header or footer of an Excel document.

The SpreadsheetHeaderFooterPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this SpreadsheetHeaderFooterPossibleWatermark in points. |
| parent | The parent of this SpreadsheetHeaderFooterPossibleWatermark. |
| rotate_angle | The rotate angle of this SpreadsheetHeaderFooterPossibleWatermark in degrees. |
| text | The text of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `SpreadsheetHeaderFooterPossibleWatermark`. |
| width | The width of this SpreadsheetHeaderFooterPossibleWatermark in points. |
| x | The horizontal offset of this SpreadsheetHeaderFooterPossibleWatermark from the worksheet left border in points. This is the x-coordinate of the watermark. |
| y | The y-coordinate of this SpreadsheetHeaderFooterPossibleWatermark, representing the vertical offset from the worksheet top border in points. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/height.md

#### height property

The height of this SpreadsheetHeaderFooterPossibleWatermark in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetHeaderFooterPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetHeaderFooterPossibleWatermark in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/text.md

#### text property

The text of this `SpreadsheetHeaderFooterPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `SpreadsheetHeaderFooterPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/width.md

#### width property

The width of this SpreadsheetHeaderFooterPossibleWatermark in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/x.md

#### x property

The horizontal offset of this SpreadsheetHeaderFooterPossibleWatermark from the worksheet left border in points. This is the x-coordinate of the watermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetheaderfooterpossiblewatermark/y.md

#### y property

The y-coordinate of this SpreadsheetHeaderFooterPossibleWatermark, representing the vertical offset from the worksheet top border in points.

##### Definition:
```python
@property
def y(self):
    ...
```

### SpreadsheetHyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark.md

#### SpreadsheetHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in an Excel document.

The SpreadsheetHyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this SpreadsheetHyperlinkPossibleWatermark in points. |
| parent | The parent of this SpreadsheetHyperlinkPossibleWatermark. |
| rotate_angle | The rotate angle of this SpreadsheetHyperlinkPossibleWatermark in degrees. The value is always 0 for this type of possible watermark. |
| text | The URL of this SpreadsheetHyperlinkPossibleWatermark. |
| unit_of_measurement | The unit of measurement of this SpreadsheetHyperlinkPossibleWatermark. |
| width | The width of this SpreadsheetHyperlinkPossibleWatermark in points. |
| x | The x-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`, representing the horizontal offset from the worksheet left border in points. |
| y | The y-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`, measured in points from the worksheet top border. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/height.md

#### height property

The height of this SpreadsheetHyperlinkPossibleWatermark in points.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this SpreadsheetHyperlinkPossibleWatermark in degrees. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/text.md

#### text property

The URL of this SpreadsheetHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this SpreadsheetHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/width.md

#### width property

The width of this SpreadsheetHyperlinkPossibleWatermark in points.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/x.md

#### x property

The x-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`, representing the horizontal offset from the worksheet left border in points.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheethyperlinkpossiblewatermark/y.md

#### y property

The y-coordinate of this `SpreadsheetHyperlinkPossibleWatermark`, measured in points from the worksheet top border.

##### Definition:
```python
@property
def y(self):
    ...
```

### SpreadsheetShapePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark.md

#### SpreadsheetShapePossibleWatermark class

Represents possible shape watermark in an Excel document.

The SpreadsheetShapePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this SpreadsheetShapePossibleWatermark. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/parent.md

#### parent property

The parent of this SpreadsheetShapePossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/spreadsheetshapepossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### WordProcessingShapePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark.md

#### WordProcessingShapePossibleWatermark class

Represents possible shape watermark in a Word document.

The WordProcessingShapePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| parent | The parent of this WordProcessingShapePossibleWatermark. |
| formatted_text_fragments |  (inherited from `ShapePossibleWatermark`) |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number |  (inherited from `ShapePossibleWatermark`) |
| rotate_angle |  (inherited from `ShapePossibleWatermark`) |
| text |  (inherited from `ShapePossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/height.md

#### height property

Gets the height of the 2D object.

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/parent.md

#### parent property

The parent of this WordProcessingShapePossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/rotate_angle.md

#### rotate_angle property

Gets the rotate angle of the 2D object in degrees.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

Gets the unit of measurement of the 2D object.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/width.md

#### width property

Gets the width of the 2D object.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/x.md

#### x property

Gets the x-coordinate of the 2D object.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingshapepossiblewatermark/y.md

#### y property

Gets the y-coordinate of the 2D object.

### WordProcessingTextHyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark.md

#### WordProcessingTextHyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a Word document.

The WordProcessingTextHyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this WordProcessingTextHyperlinkPossibleWatermark. |
| parent | The parent of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| rotate_angle | The rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees. |
| text | The URL of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| width | The width of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| x | The x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`. |
| y | The y-coordinate of this WordProcessingTextHyperlinkPossibleWatermark. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/height.md

#### height property

The height of this WordProcessingTextHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/parent.md

#### parent property

The parent of this `WordProcessingTextHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `WordProcessingTextHyperlinkPossibleWatermark` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/text.md

#### text property

The URL of this `WordProcessingTextHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `WordProcessingTextHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/width.md

#### width property

The width of this `WordProcessingTextHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/x.md

#### x property

The x-coordinate of this `WordProcessingTextHyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtexthyperlinkpossiblewatermark/y.md

#### y property

The y-coordinate of this WordProcessingTextHyperlinkPossibleWatermark.

##### Definition:
```python
@property
def y(self):
    ...
```

### WordProcessingTextPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark.md

#### WordProcessingTextPossibleWatermark class

Represents possible watermark in a Word document text.

The WordProcessingTextPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`. |
| height | The height of this `WordProcessingTextPossibleWatermark` in points. |
| parent | The parent of this WordProcessingTextPossibleWatermark. |
| rotate_angle | The rotate angle of this `WordProcessingTextPossibleWatermark` in degrees. |
| text | The text of this `WordProcessingTextPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `WordProcessingTextPossibleWatermark`. |
| width | The width of this WordProcessingTextPossibleWatermark in points. The value is always 0 for this type of possible watermark. |
| x | The horizontal offset of this `WordProcessingTextPossibleWatermark` from the document left border in points. |
| y | The vertical offset of this `WordProcessingTextPossibleWatermark` from the document top border in points. The value is always 0 for this type of possible watermark. |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `WordProcessingTextPossibleWatermark`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/height.md

#### height property

The height of this `WordProcessingTextPossibleWatermark` in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/parent.md

#### parent property

The parent of this WordProcessingTextPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `WordProcessingTextPossibleWatermark` in degrees.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/text.md

#### text property

The text of this `WordProcessingTextPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `WordProcessingTextPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/width.md

#### width property

The width of this WordProcessingTextPossibleWatermark in points. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/x.md

#### x property

The horizontal offset of this `WordProcessingTextPossibleWatermark` from the document left border in points.

The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.watermarks/wordprocessingtextpossiblewatermark/y.md

#### y property

The vertical offset of this `WordProcessingTextPossibleWatermark` from the document top border in points. The value is always 0 for this type of possible watermark.

##### Definition:
```python
@property
def y(self):
    ...
```

### groupdocs.watermark.search
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search.md

Types under `groupdocs.watermark.search`.

##### Classes
| Class | Description |
| :- | :- |
| `AttachedImagePossibleWatermark` |  |
| `FloatingAttachedImagePossibleWatermark` |  |
| `FormattedTextFragment` | Provides abstract base class for a fragment of formatted text in a content. |
| `FormattedTextFragmentCollection` | Represents a mutable collection of formatted text fragments. |
| `HyperlinkPossibleWatermark` | Represents possible hyperlink watermark in a PowerPoint content. |
| `IRotatableTwoDObject` | Represents any rotatable two dimensional object in a content structure. |
| `ITwoDObject` | Represents any two dimensional object in a content structure. |
| `PossibleWatermark` | Represents possible watermark found in a document. |
| `ShapePossibleWatermark` |  |
| `TwoDObjectPossibleWatermark` | Represents 2D object watermark in a content of any supported format. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FormattedTextFragmentCollectionType` |  |
| `PossibleWatermarkCollection` | Represents a collection of possible watermarks found in a content. |
| `ShapeSearchAdapter` | Provides a base class for a shape containing specific pieces of a document that are to be included in watermark search. |

### AttachedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark.md

#### AttachedImagePossibleWatermark class

The AttachedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| parent |  |
| rotate_angle |  |
| unit_of_measurement |  |
| width |  |
| x |  |
| y |  |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/parent.md

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/rotate_angle.md

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/unit_of_measurement.md

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/x.md

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/attachedimagepossiblewatermark/y.md

##### Definition:
```python
@property
def y(self):
    ...
```

### FloatingAttachedImagePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark.md

#### FloatingAttachedImagePossibleWatermark class

The FloatingAttachedImagePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height |  |
| parent |  |
| width |  |
| x |  |
| y |  |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark/height.md

##### Definition:
```python
@property
def height(self):
    ...
```

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark/parent.md

##### Definition:
```python
@property
def parent(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark/width.md

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark/x.md

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/floatingattachedimagepossiblewatermark/y.md

##### Definition:
```python
@property
def y(self):
    ...
```

### FormattedTextFragment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragment.md

#### FormattedTextFragment class

Provides abstract base class for a fragment of formatted text in a content.

The FormattedTextFragment type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| text | The fragment text. |

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragment/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
```

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragment/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragment/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragment/text.md

#### text property

The fragment text.

##### Definition:
```python
@property
def text(self):
    ...
```

### FormattedTextFragmentCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection.md

#### FormattedTextFragmentCollection class

Represents a mutable collection of formatted text fragments.

This collection contains the items of `FormattedTextFragment` base type.

The FormattedTextFragmentCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add | Adds a formatted text fragment to the collection. |
| add_file |  |
| add_string |  |
| insert | Inserts a formatted text fragment into the collection at a given index. |
| insert | Inserts a formatted text fragment into the collection at a given index. |
| insert | Inserts a formatted text fragment into the collection at a given index. |
| insert | Inserts a formatted text fragment into the collection at a given index. |
| insert_file |  |
| insert_int32 |  |
| insert_string |  |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| collection_type | The formatted fragment collection type. |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/add.md

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` | The fragment text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |
| foreground_color | `Color` | The foreground color of the text. |

#### add

Adds a formatted text fragment to the collection.

```python
def add(self, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |
| foreground_color | `Color` | The foreground color of the text. |
| background_color | `Color` | The background color of the text. |

### add_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/add_file.md

#### add_file

```python
def add_file(self):
    ...
```

### add_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/add_string.md

#### add_string

```python
def add_string(self):
    ...
```

### collection_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/collection_type.md

#### collection_type property

The formatted fragment collection type.

##### Definition:
```python
@property
def collection_type(self):
    ...
```

### insert method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/insert.md

#### insert

Inserts a formatted text fragment into the collection at a given index.

```python
def insert(self, index, text):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` | The zero-based index at which formatted text fragment should be inserted. |
| text | `str` | The fragment text. |

#### insert

Inserts a formatted text fragment into the collection at a given index.

```python
def insert(self, index, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` | The zero-based index at which formatted text fragment should be inserted. |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |

#### insert

Inserts a formatted text fragment into the collection at a given index.

```python
def insert(self, index, text, font, foreground_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` | The zero-based index at which formatted text fragment should be inserted. |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |
| foreground_color | `Color` | The foreground color of the text. |

**Returns:** None.

#### insert

Inserts a formatted text fragment into the collection at a given index.

```python
def insert(self, index, text, font, foreground_color, background_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| index | `int` | The zero-based index at which formatted text fragment should be inserted. |
| text | `str` | The fragment text. |
| font | `Font` | The font of the text. |
| foreground_color | `Color` | The foreground color of the text. |
| background_color | `Color` | The background color of the text. |

### insert_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/insert_file.md

#### insert_file

```python
def insert_file(self):
    ...
```

### insert_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/insert_int32.md

#### insert_int32

```python
def insert_int32(self):
    ...
```

### insert_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollection/insert_string.md

#### insert_string

```python
def insert_string(self):
    ...
```

### FormattedTextFragmentCollectionType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollectiontype.md

#### FormattedTextFragmentCollectionType class

The FormattedTextFragmentCollectionType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| UNLIMITED_FRAGMENTS | Multiple styles are allowed, the collection can contain unlimited count of fragments. |
| SINGLE_FRAGMENT | Whole text can be formatted with a single style, the collection can contain only one fragment. |
| NO_FORMATTED_TEXT | Parent object doesn't support text formatting, the collection is always empty. |

### NO_FORMATTED_TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollectiontype/no_formatted_text.md

#### NO_FORMATTED_TEXT field

Parent object doesn't support text formatting, the collection is always empty.

##### Value
`2`

### SINGLE_FRAGMENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollectiontype/single_fragment.md

#### SINGLE_FRAGMENT field

Whole text can be formatted with a single style, the collection can contain only one fragment.

##### Value
`1`

### UNLIMITED_FRAGMENTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/formattedtextfragmentcollectiontype/unlimited_fragments.md

#### UNLIMITED_FRAGMENTS field

Multiple styles are allowed, the collection can contain unlimited count of fragments.

##### Value
`0`

### HyperlinkPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark.md

#### HyperlinkPossibleWatermark class

Represents possible hyperlink watermark in a PowerPoint content.

The HyperlinkPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of this HyperlinkPossibleWatermark. |
| parent | The parent of this HyperlinkPossibleWatermark. |
| rotate_angle | The rotate angle of this `HyperlinkPossibleWatermark` in degrees. |
| text | The URL of this `HyperlinkPossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `HyperlinkPossibleWatermark`. |
| width | The width of this HyperlinkPossibleWatermark. |
| x | The x-coordinate of this HyperlinkPossibleWatermark. |
| y | The y-coordinate of this `HyperlinkPossibleWatermark`. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |

##### Example

```python
import re
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc
import groupdocs.watermark.search as gws

with gw.Watermarker("document.pdf") as watermarker:
    possible = watermarker.search(gws_sc.TextSearchCriteria(re.compile(r"someurl\.com")))
    # iterate backwards when removing by index
    for i in range(possible.count - 1, -1, -1):
        if isinstance(possible[i], gws.HyperlinkPossibleWatermark):
            print(possible[i].text)
            possible.remove_at(i)

    watermarker.save("document.pdf")
```

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/height.md

#### height property

The height of this HyperlinkPossibleWatermark.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/parent.md

#### parent property

The parent of this HyperlinkPossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `HyperlinkPossibleWatermark` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/text.md

#### text property

The URL of this `HyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `HyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/width.md

#### width property

The width of this HyperlinkPossibleWatermark.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/x.md

#### x property

The x-coordinate of this HyperlinkPossibleWatermark.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/hyperlinkpossiblewatermark/y.md

#### y property

The y-coordinate of this `HyperlinkPossibleWatermark`.

##### Definition:
```python
@property
def y(self):
    ...
```

### IRotatableTwoDObject class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject.md

#### IRotatableTwoDObject class

Represents any rotatable two dimensional object in a content structure.

The IRotatableTwoDObject type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the object. |
| rotate_angle | The rotate angle of the object in degrees. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject/rotate_angle.md

#### rotate_angle property

The rotate angle of the object in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/irotatabletwodobject/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### ITwoDObject class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/itwodobject.md

#### ITwoDObject class

Represents any two dimensional object in a content structure.

The ITwoDObject type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the object. |
| width | The width of the object. |
| x | The x-coordinate of the object. |
| y | The y-coordinate of the object. |

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/itwodobject/height.md

#### height property

The height of the object.

##### Definition:
```python
@property
def height(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/itwodobject/width.md

#### width property

The width of the object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/itwodobject/x.md

#### x property

The x-coordinate of the object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/itwodobject/y.md

#### y property

The y-coordinate of the object.

##### Definition:
```python
@property
def y(self):
    ...
```

### PossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark.md

#### PossibleWatermark class

Represents possible watermark found in a document.

The PossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. |
| height | The height of this `PossibleWatermark`. |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. |
| page_number | The page number where the watermark is placed. |
| parent | The parent of this PossibleWatermark. |
| rotate_angle | The rotate angle of this `PossibleWatermark` in degrees. |
| text | The text of this `PossibleWatermark`. |
| unit_of_measurement | The unit of measurement of this `PossibleWatermark`. |
| width | The width of this `PossibleWatermark`. |
| x | The x-coordinate of this `PossibleWatermark`. |
| y | The y-coordinate of this `PossibleWatermark`. |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

The collection of formatted text fragments of this `PossibleWatermark`.

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/height.md

#### height property

The height of this `PossibleWatermark`.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/image_data.md

#### image_data property

The image of this `PossibleWatermark` or None if the watermark has no image.

##### Definition:
```python
@property
def image_data(self):
    ...
@image_data.setter
def image_data(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/page_number.md

#### page_number property

The page number where the watermark is placed.

##### Definition:
```python
@property
def page_number(self):
    ...
```

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/parent.md

#### parent property

The parent of this PossibleWatermark.

##### Definition:
```python
@property
def parent(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this `PossibleWatermark` in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/text.md

#### text property

The text of this `PossibleWatermark`.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of this `PossibleWatermark`.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/width.md

#### width property

The width of this `PossibleWatermark`.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/x.md

#### x property

The x-coordinate of this `PossibleWatermark`.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermark/y.md

#### y property

The y-coordinate of this `PossibleWatermark`.

##### Definition:
```python
@property
def y(self):
    ...
```

### PossibleWatermarkCollection class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/possiblewatermarkcollection.md

#### PossibleWatermarkCollection class

Represents a collection of possible watermarks found in a content.

This collection contains the items of `PossibleWatermark` type.

The PossibleWatermarkCollection type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| clear |  (inherited from `RemoveOnlyListBase`) |
| remove |  (inherited from `RemoveOnlyListBase`) |
| remove_at |  (inherited from `RemoveOnlyListBase`) |
| remove_at_int32 |  (inherited from `RemoveOnlyListBase`) |

##### Properties
| Property | Description |
| :- | :- |
| is_read_only |  (inherited from `RemoveOnlyListBase`) |

### ShapePossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapepossiblewatermark.md

#### ShapePossibleWatermark class

The ShapePossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| formatted_text_fragments |  |
| page_number |  |
| rotate_angle |  |
| text |  |
| height | The height of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| parent | The parent of this PossibleWatermark. (inherited from `PossibleWatermark`) |
| unit_of_measurement | The unit of measurement of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| width | The width of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| x | The x-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |
| y | The y-coordinate of the 2D object. (inherited from `TwoDObjectPossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapepossiblewatermark/formatted_text_fragments.md

##### Definition:
```python
@property
def formatted_text_fragments(self):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapepossiblewatermark/page_number.md

##### Definition:
```python
@property
def page_number(self):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapepossiblewatermark/rotate_angle.md

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapepossiblewatermark/text.md

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### ShapeSearchAdapter class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/shapesearchadapter.md

#### ShapeSearchAdapter class

Provides a base class for a shape containing specific pieces of a document that are to be included in watermark search.

The ShapeSearchAdapter type exposes the following members:

### TwoDObjectPossibleWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark.md

#### TwoDObjectPossibleWatermark class

Represents 2D object watermark in a content of any supported format.

The TwoDObjectPossibleWatermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| height | The height of the 2D object. |
| rotate_angle | The rotate angle of the 2D object in degrees. |
| unit_of_measurement | The unit of measurement of the 2D object. |
| width | The width of the 2D object. |
| x | The x-coordinate of the 2D object. |
| y | The y-coordinate of the 2D object. |
| formatted_text_fragments | The collection of formatted text fragments of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |
| image_data | The image of this `PossibleWatermark` or None if the watermark has no image. (inherited from `PossibleWatermark`) |
| page_number | The page number where the watermark is placed. (inherited from `PossibleWatermark`) |
| parent | The parent of this PossibleWatermark. (inherited from `PossibleWatermark`) |
| text | The text of this `PossibleWatermark`. (inherited from `PossibleWatermark`) |

### formatted_text_fragments property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/formatted_text_fragments.md

#### formatted_text_fragments property

Gets the collection of formatted text fragments of this `PossibleWatermark`.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/height.md

#### height property

The height of the 2D object.

##### Definition:
```python
@property
def height(self):
    ...
```

### image_data property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/image_data.md

#### image_data property

Gets or sets the image of this `PossibleWatermark`.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/page_number.md

#### page_number property

Gets the page watermark is placed on.

### parent property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/parent.md

#### parent property

Gets the parent of this `PossibleWatermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/rotate_angle.md

#### rotate_angle property

The rotate angle of the 2D object in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
```

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/text.md

#### text property

Gets or sets the text of this `PossibleWatermark`.

### unit_of_measurement property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/unit_of_measurement.md

#### unit_of_measurement property

The unit of measurement of the 2D object.

##### Definition:
```python
@property
def unit_of_measurement(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/width.md

#### width property

The width of the 2D object.

##### Definition:
```python
@property
def width(self):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/x.md

#### x property

The x-coordinate of the 2D object.

##### Definition:
```python
@property
def x(self):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.search/twodobjectpossiblewatermark/y.md

#### y property

The y-coordinate of the 2D object.

##### Definition:
```python
@property
def y(self):
    ...
```

### groupdocs.watermark.watermarks.results
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results.md

Result types produced by converter and processor methods.

##### Classes
| Class | Description |
| :- | :- |
| `AddWatermarkResult` | Represents the result of adding watermarks to a document. |
| `BaseWatermarkResult` | Describes the base class for watermark result. |
| `ImageWatermarkResult` | Contains image watermark properties. |
| `TextWatermarkResult` | Contains Text watermark properties. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `WatermarkPosition` |  |
| `WatermarkType` |  |

### AddWatermarkResult class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/addwatermarkresult.md

#### AddWatermarkResult class

Represents the result of adding watermarks to a document.

The AddWatermarkResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| number_applied_watermarks | The number of applied watermarks. |
| succeeded | The list of newly created watermarks. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample_2_pages.pdf") as watermarker:
    font = gww.Font("Arial", 19.0, gww.FontStyle.BOLD | gww.FontStyle.ITALIC)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.foreground_color = gww.Color.red
    watermark.background_color = gww.Color.blue
    watermark.text_alignment = gww.TextAlignment.RIGHT
    watermark.opacity = 0.5

    result = watermarker.add(watermark)

    for item in result.succeeded:
        print("WatermarkId:", item.watermark_id)
        print("WatermarkType:", item.watermark_type)
        print("PageNumber:", item.page_number)
        print("WatermarkPosition:", item.watermark_position)

    watermarker.save("output.pdf")
```

### number_applied_watermarks property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/addwatermarkresult/number_applied_watermarks.md

#### number_applied_watermarks property

The number of applied watermarks.

##### Definition:
```python
@property
def number_applied_watermarks(self):
    ...
```

### succeeded property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/addwatermarkresult/succeeded.md

#### succeeded property

The list of newly created watermarks.

##### Definition:
```python
@property
def succeeded(self):
    ...
```

### BaseWatermarkResult class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult.md

#### BaseWatermarkResult class

Describes the base class for watermark result.

The BaseWatermarkResult type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| created_on | The creation date of the watermark. |
| height | The height of the watermark. |
| left | The left position of the watermark. |
| modified_on | The watermark modification date. |
| page_number | The page number where the watermark was placed. |
| top | The top position of the watermark. |
| watermark_id | The unique identifier of the watermark, used to modify the watermark via Update or Delete methods. |
| watermark_position | The watermark position. |
| watermark_type | The type of watermark. |
| width | The width of the watermark. |

### created_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/created_on.md

#### created_on property

The creation date of the watermark.

##### Definition:
```python
@property
def created_on(self):
    ...
@created_on.setter
def created_on(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/height.md

#### height property

The height of the watermark.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/left.md

#### left property

The left position of the watermark.

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### modified_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/modified_on.md

#### modified_on property

The watermark modification date.

##### Definition:
```python
@property
def modified_on(self):
    ...
@modified_on.setter
def modified_on(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/page_number.md

#### page_number property

The page number where the watermark was placed.

##### Definition:
```python
@property
def page_number(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/top.md

#### top property

The top position of the watermark.

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### watermark_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermark_id.md

#### watermark_id property

The unique identifier of the watermark, used to modify the watermark via Update or Delete methods.

It is set automatically after calling the Add method; if previously saved, it can be set manually to manipulate the watermark.

##### Definition:
```python
@property
def watermark_id(self):
    ...
```

### watermark_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermark_position.md

#### watermark_position property

The watermark position.

##### Definition:
```python
@property
def watermark_position(self):
    ...
```

### watermark_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/watermark_type.md

#### watermark_type property

The type of watermark.

##### Definition:
```python
@property
def watermark_type(self):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/basewatermarkresult/width.md

#### width property

The width of the watermark.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### ImageWatermarkResult class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult.md

#### ImageWatermarkResult class

Contains image watermark properties.

The ImageWatermarkResult type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes ImageWatermarkResult with the unique watermark identifier obtained after a search process. This identifier is used to retrieve additional properties for the watermark from the document watermark information layer. |

##### Properties
| Property | Description |
| :- | :- |
| size | The size in bytes of the watermark image. |
| created_on | The creation date of the watermark. (inherited from `BaseWatermarkResult`) |
| height | The height of the watermark. (inherited from `BaseWatermarkResult`) |
| left | The left position of the watermark. (inherited from `BaseWatermarkResult`) |
| modified_on | The watermark modification date. (inherited from `BaseWatermarkResult`) |
| page_number | The page number where the watermark was placed. (inherited from `BaseWatermarkResult`) |
| top | The top position of the watermark. (inherited from `BaseWatermarkResult`) |
| watermark_id | The unique identifier of the watermark, used to modify the watermark via Update or Delete methods. (inherited from `BaseWatermarkResult`) |
| watermark_position | The watermark position. (inherited from `BaseWatermarkResult`) |
| watermark_type | The type of watermark. (inherited from `BaseWatermarkResult`) |
| width | The width of the watermark. (inherited from `BaseWatermarkResult`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/__init__.md

#### __init__

Initializes ImageWatermarkResult with the unique watermark identifier obtained after a search process. This identifier is used to retrieve additional properties for the watermark from the document watermark information layer.

```python
def __init__(self, watermark_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark_id | `str` | Unique watermark identifier obtained by Sign or Search method of Signature class `GroupDocs.Signature.Signature`. |

### created_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/created_on.md

#### created_on property

Get or set the watermark creation date.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/height.md

#### height property

Specifies height of watermark.

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/left.md

#### left property

Specifies left position of watermark.

### modified_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/modified_on.md

#### modified_on property

Get or set the watermark modification date.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/page_number.md

#### page_number property

Specifies the page watermark was placed on.

### size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/size.md

#### size property

The size in bytes of the watermark image.

##### Definition:
```python
@property
def size(self):
    ...
```

### top property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/top.md

#### top property

Specifies top position of watermark.

### watermark_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/watermark_id.md

#### watermark_id property

Unique watermark identifier to modify watermark in the document over Update or Delete methods.
This property will be set automatically after Add method being called.
If this property was saved before it can be set manually to manipulate the watermark.

### watermark_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/watermark_position.md

#### watermark_position property

Specifies watermark position

### watermark_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/watermark_type.md

#### watermark_type property

Specifies the type of watermark.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/imagewatermarkresult/width.md

#### width property

Specifies width of watermark.

### TextWatermarkResult class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult.md

#### TextWatermarkResult class

Contains Text watermark properties.

The TextWatermarkResult type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a TextWatermarkResult object with the watermark identifier obtained after a search process. |

##### Properties
| Property | Description |
| :- | :- |
| text | The text in the watermark. |
| created_on | The creation date of the watermark. (inherited from `BaseWatermarkResult`) |
| height | The height of the watermark. (inherited from `BaseWatermarkResult`) |
| left | The left position of the watermark. (inherited from `BaseWatermarkResult`) |
| modified_on | The watermark modification date. (inherited from `BaseWatermarkResult`) |
| page_number | The page number where the watermark was placed. (inherited from `BaseWatermarkResult`) |
| top | The top position of the watermark. (inherited from `BaseWatermarkResult`) |
| watermark_id | The unique identifier of the watermark, used to modify the watermark via Update or Delete methods. (inherited from `BaseWatermarkResult`) |
| watermark_position | The watermark position. (inherited from `BaseWatermarkResult`) |
| watermark_type | The type of watermark. (inherited from `BaseWatermarkResult`) |
| width | The width of the watermark. (inherited from `BaseWatermarkResult`) |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/__init__.md

#### __init__

Initializes a TextWatermarkResult object with the watermark identifier obtained after a search process.

This unique identifier is used to find additional properties for this watermark from the document watermark information layer.

```python
def __init__(self, watermark_id):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark_id | `str` | Unique watermark identifier obtained by sign or search method. |

### created_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/created_on.md

#### created_on property

Get or set the watermark creation date.

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/height.md

#### height property

Specifies height of watermark.

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/left.md

#### left property

Specifies left position of watermark.

### modified_on property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/modified_on.md

#### modified_on property

Get or set the watermark modification date.

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/page_number.md

#### page_number property

Specifies the page watermark was placed on.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/text.md

#### text property

The text in the watermark.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/top.md

#### top property

Specifies top position of watermark.

### watermark_id property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/watermark_id.md

#### watermark_id property

Unique watermark identifier to modify watermark in the document over Update or Delete methods.
This property will be set automatically after Add method being called.
If this property was saved before it can be set manually to manipulate the watermark.

### watermark_position property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/watermark_position.md

#### watermark_position property

Specifies watermark position

### watermark_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/watermark_type.md

#### watermark_type property

Specifies the type of watermark.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/textwatermarkresult/width.md

#### width property

Specifies width of watermark.

### WatermarkPosition class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarkposition.md

#### WatermarkPosition class

The WatermarkPosition type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | The Watermark is placed in the document body |
| HEADER_FOOTER | The Watermark is placed in the document header or footer |
| BACKGROUND | The watermark is placed as the background of the document |

##### Guides
Task guides that use `WatermarkPosition`:

* Result of added watermarks

### BACKGROUND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarkposition/background.md

#### BACKGROUND field

The watermark is placed as the background of the document

##### Value
`3`

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarkposition/default.md

#### DEFAULT field

The Watermark is placed in the document body

##### Value
`1`

### HEADER_FOOTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarkposition/header_footer.md

#### HEADER_FOOTER field

The Watermark is placed in the document header or footer

##### Value
`2`

### WatermarkType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarktype.md

#### WatermarkType class

The WatermarkType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| TEXT | The Text type |
| IMAGE | The Image type |

##### Guides
Task guides that use `WatermarkType`:

* Result of added watermarks

### IMAGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarktype/image.md

#### IMAGE field

The Image type

##### Value
`1`

### TEXT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.results/watermarktype/text.md

#### TEXT field

The Text type

##### Value
`0`

### groupdocs.watermark.watermarks
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks.md

Types under `groupdocs.watermark.watermarks`.

##### Classes
| Class | Description |
| :- | :- |
| `Color` | Represents a color. |
| `Font` | Represents a font. |
| `ImageWatermark` | Represents an image watermark. |
| `Margins` | Represents margin settings for each edge of an object. |
| `MeasureValue` | Represents a measurement value with a specific type and numerical value. |
| `PagesSetup` | Represents the setup for pages. |
| `TextWatermark` | Represents a text watermark. |
| `Thickness` | Represents the thickness of a frame around a rectangle. |
| `TileOptions` | Represents options for configuring watermarks in tile mode. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `FontStyle` |  |
| `MarginType` |  |
| `SizingType` |  |
| `TextAlignment` |  |
| `TileMeasureType` |  |
| `TileType` |  |

### Color class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color.md

#### Color class

Represents a color.

The Color type exposes the following members:

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified `Color` structure is equivalent to this `Color` structure. |
| equals | Determines whether the specified object is a `Color` structure and is equivalent to this `Color` structure. |
| equals_color |  |
| equals_object |  |
| from_argb | Creates a Color structure from a 32-bit ARGB value. |
| from_argb | Creates a `Color` structure from the specified `Color` structure, but with the new specified alpha value. |
| from_argb | Creates a Color structure from the specified 8-bit color values (red, green, and blue) with an implicit alpha value of 255 (fully opaque). |
| from_argb | Creates a Color structure from the four ARGB component (alpha, red, green, and blue) values. |
| from_argb_int32 |  |
| get_brightness | Returns the hue‑saturation‑brightness (HSB) brightness value for this Color structure. |
| get_hash_code | Returns a hash code for this Color structure. |
| get_hue | Returns the hue-saturation-brightness (HSB) hue value, in degrees, for this `Color` structure. |
| get_saturation | Gets the hue-saturation-brightness (HSB) saturation value for this `Color` structure. |
| to_argb | Returns the 32-bit ARGB value of this Color structure. |

##### Properties
| Property | Description |
| :- | :- |
| a | The alpha component of the color. Valid values are 0 through 255. |
| b | The blue component of the color. Valid values are 0 through 255. |
| g | The green component of the color. Valid values are 0 through 255. |
| is_empty | The property indicates whether this `Color` structure is uninitialized. |
| r | The red component of the color. Valid values are 0 through 255. |

##### Fields
| Field | Description |
| :- | :- |
| EMPTY | Gets a system-defined color. |
| TRANSPARENT | Gets a system-defined color. |
| ALICE_BLUE | Gets a system-defined color. |
| ANTIQUE_WHITE | Gets a system-defined color. |
| AQUA | Gets a system-defined color. |
| AQUAMARINE | Gets a system-defined color. |
| AZURE | Gets a system-defined color. |
| BEIGE | Gets a system-defined color. |
| BISQUE | Gets a system-defined color. |
| BLACK | Gets a system-defined color. |
| BLANCHED_ALMOND | Gets a system-defined color. |
| BLUE | Gets a system-defined color. |
| BLUE_VIOLET | Gets a system-defined color. |
| BROWN | Gets a system-defined color. |
| BURLY_WOOD | Gets a system-defined color. |
| CADET_BLUE | Gets a system-defined color. |
| CHARTREUSE | Gets a system-defined color. |
| CHOCOLATE | Gets a system-defined color. |
| CORAL | Gets a system-defined color. |
| CORNFLOWER_BLUE | Gets a system-defined color. |
| CORNSILK | Gets a system-defined color. |
| CRIMSON | Gets a system-defined color. |
| CYAN | Gets a system-defined color. |
| DARK_BLUE | Gets a system-defined color. |
| DARK_CYAN | Gets a system-defined color. |
| DARK_GOLDENROD | Gets a system-defined color. |
| DARK_GRAY | Gets a system-defined color. |
| DARK_GREEN | Gets a system-defined color. |
| DARK_KHAKI | Gets a system-defined color. |
| DARK_MAGENTA | Gets a system-defined color. |
| DARK_OLIVE_GREEN | Gets a system-defined color. |
| DARK_ORANGE | Gets a system-defined color. |
| DARK_ORCHID | Gets a system-defined color. |
| DARK_RED | Gets a system-defined color. |
| DARK_SALMON | Gets a system-defined color. |
| DARK_SEA_GREEN | Gets a system-defined color. |
| DARK_SLATE_BLUE | Gets a system-defined color. |
| DARK_SLATE_GRAY | Gets a system-defined color. |
| DARK_TURQUOISE | Gets a system-defined color. |
| DARK_VIOLET | Gets a system-defined color. |
| DEEP_PINK | Gets a system-defined color. |
| DEEP_SKY_BLUE | Gets a system-defined color. |
| DIM_GRAY | Gets a system-defined color. |
| DODGER_BLUE | Gets a system-defined color. |
| FIREBRICK | Gets a system-defined color. |
| FLORAL_WHITE | Gets a system-defined color. |
| FOREST_GREEN | Gets a system-defined color. |
| FUCHSIA | Gets a system-defined color. |
| GAINSBORO | Gets a system-defined color. |
| GHOST_WHITE | Gets a system-defined color. |
| GOLD | Gets a system-defined color. |
| GOLDENROD | Gets a system-defined color. |
| GRAY | Gets a system-defined color. |
| GREEN | Gets a system-defined color. |
| GREEN_YELLOW | Gets a system-defined color. |
| HONEYDEW | Gets a system-defined color. |
| HOT_PINK | Gets a system-defined color. |
| INDIAN_RED | Gets a system-defined color. |
| INDIGO | Gets a system-defined color. |
| IVORY | Gets a system-defined color. |
| KHAKI | Gets a system-defined color. |
| LAVENDER | Gets a system-defined color. |
| LAVENDER_BLUSH | Gets a system-defined color. |
| LAWN_GREEN | Gets a system-defined color. |
| LEMON_CHIFFON | Gets a system-defined color. |
| LIGHT_BLUE | Gets a system-defined color. |
| LIGHT_CORAL | Gets a system-defined color. |
| LIGHT_CYAN | Gets a system-defined color. |
| LIGHT_GOLDENROD_YELLOW | Gets a system-defined color. |
| LIGHT_GRAY | Gets a system-defined color. |
| LIGHT_GREEN | Gets a system-defined color. |
| LIGHT_PINK | Gets a system-defined color. |
| LIGHT_SALMON | Gets a system-defined color. |
| LIGHT_SEA_GREEN | Gets a system-defined color. |
| LIGHT_SKY_BLUE | Gets a system-defined color. |
| LIGHT_SLATE_GRAY | Gets a system-defined color. |
| LIGHT_STEEL_BLUE | Gets a system-defined color. |
| LIGHT_YELLOW | Gets a system-defined color. |
| LIME | Gets a system-defined color. |
| LIME_GREEN | Gets a system-defined color. |
| LINEN | Gets a system-defined color. |
| MAGENTA | Gets a system-defined color. |
| MAROON | Gets a system-defined color. |
| MEDIUM_AQUAMARINE | Gets a system-defined color. |
| MEDIUM_BLUE | Gets a system-defined color. |
| MEDIUM_ORCHID | Gets a system-defined color. |
| MEDIUM_PURPLE | Gets a system-defined color. |
| MEDIUM_SEA_GREEN | Gets a system-defined color. |
| MEDIUM_SLATE_BLUE | Gets a system-defined color. |
| MEDIUM_SPRING_GREEN | Gets a system-defined color. |
| MEDIUM_TURQUOISE | Gets a system-defined color. |
| MEDIUM_VIOLET_RED | Gets a system-defined color. |
| MIDNIGHT_BLUE | Gets a system-defined color. |
| MINT_CREAM | Gets a system-defined color. |
| MISTY_ROSE | Gets a system-defined color. |
| MOCCASIN | Gets a system-defined color. |
| NAVAJO_WHITE | Gets a system-defined color. |
| NAVY | Gets a system-defined color. |
| OLD_LACE | Gets a system-defined color. |
| OLIVE | Gets a system-defined color. |
| OLIVE_DRAB | Gets a system-defined color. |
| ORANGE | Gets a system-defined color. |
| ORANGE_RED | Gets a system-defined color. |
| ORCHID | Gets a system-defined color. |
| PALE_GOLDENROD | Gets a system-defined color. |
| PALE_GREEN | Gets a system-defined color. |
| PALE_TURQUOISE | Gets a system-defined color. |
| PALE_VIOLET_RED | Gets a system-defined color. |
| PAPAYA_WHIP | Gets a system-defined color. |
| PEACH_PUFF | Gets a system-defined color. |
| PERU | Gets a system-defined color. |
| PINK | Gets a system-defined color. |
| PLUM | Gets a system-defined color. |
| POWDER_BLUE | Gets a system-defined color. |
| PURPLE | Gets a system-defined color. |
| RED | Gets a system-defined color. |
| ROSY_BROWN | Gets a system-defined color. |
| ROYAL_BLUE | Gets a system-defined color. |
| SADDLE_BROWN | Gets a system-defined color. |
| SALMON | Gets a system-defined color. |
| SANDY_BROWN | Gets a system-defined color. |
| SEA_GREEN | Gets a system-defined color. |
| SEA_SHELL | Gets a system-defined color. |
| SIENNA | Gets a system-defined color. |
| SILVER | Gets a system-defined color. |
| SKY_BLUE | Gets a system-defined color. |
| SLATE_BLUE | Gets a system-defined color. |
| SLATE_GRAY | Gets a system-defined color. |
| SNOW | Gets a system-defined color. |
| SPRING_GREEN | Gets a system-defined color. |
| STEEL_BLUE | Gets a system-defined color. |
| TAN | Gets a system-defined color. |
| TEAL | Gets a system-defined color. |
| THISTLE | Gets a system-defined color. |
| TOMATO | Gets a system-defined color. |
| TURQUOISE | Gets a system-defined color. |
| VIOLET | Gets a system-defined color. |
| WHEAT | Gets a system-defined color. |
| WHITE | Gets a system-defined color. |
| WHITE_SMOKE | Gets a system-defined color. |
| YELLOW | Gets a system-defined color. |
| YELLOW_GREEN | Gets a system-defined color. |

### Color constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/__init__.md

#### __init__

Constructs a new instance of Color

```python
def __init__(self):
    ...
```

### a property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/a.md

#### a property

The alpha component of the color. Valid values are 0 through 255.

##### Definition:
```python
@property
def a(self):
    ...
```

### ALICE_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/alice_blue.md

#### ALICE_BLUE field

Gets a system-defined color.

### ANTIQUE_WHITE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/antique_white.md

#### ANTIQUE_WHITE field

Gets a system-defined color.

### AQUA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/aqua.md

#### AQUA field

Gets a system-defined color.

### AQUAMARINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/aquamarine.md

#### AQUAMARINE field

Gets a system-defined color.

### AZURE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/azure.md

#### AZURE field

Gets a system-defined color.

### b property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/b.md

#### b property

The blue component of the color. Valid values are 0 through 255.

##### Definition:
```python
@property
def b(self):
    ...
```

### BEIGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/beige.md

#### BEIGE field

Gets a system-defined color.

### BISQUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/bisque.md

#### BISQUE field

Gets a system-defined color.

### BLACK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/black.md

#### BLACK field

Gets a system-defined color.

### BLANCHED_ALMOND field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/blanched_almond.md

#### BLANCHED_ALMOND field

Gets a system-defined color.

### BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/blue.md

#### BLUE field

Gets a system-defined color.

### BLUE_VIOLET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/blue_violet.md

#### BLUE_VIOLET field

Gets a system-defined color.

### BROWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/brown.md

#### BROWN field

Gets a system-defined color.

### BURLY_WOOD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/burly_wood.md

#### BURLY_WOOD field

Gets a system-defined color.

### CADET_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/cadet_blue.md

#### CADET_BLUE field

Gets a system-defined color.

### CHARTREUSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/chartreuse.md

#### CHARTREUSE field

Gets a system-defined color.

### CHOCOLATE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/chocolate.md

#### CHOCOLATE field

Gets a system-defined color.

### CORAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/coral.md

#### CORAL field

Gets a system-defined color.

### CORNFLOWER_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/cornflower_blue.md

#### CORNFLOWER_BLUE field

Gets a system-defined color.

### CORNSILK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/cornsilk.md

#### CORNSILK field

Gets a system-defined color.

### CRIMSON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/crimson.md

#### CRIMSON field

Gets a system-defined color.

### CYAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/cyan.md

#### CYAN field

Gets a system-defined color.

### DARK_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_blue.md

#### DARK_BLUE field

Gets a system-defined color.

### DARK_CYAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_cyan.md

#### DARK_CYAN field

Gets a system-defined color.

### DARK_GOLDENROD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_goldenrod.md

#### DARK_GOLDENROD field

Gets a system-defined color.

### DARK_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_gray.md

#### DARK_GRAY field

Gets a system-defined color.

### DARK_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_green.md

#### DARK_GREEN field

Gets a system-defined color.

### DARK_KHAKI field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_khaki.md

#### DARK_KHAKI field

Gets a system-defined color.

### DARK_MAGENTA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_magenta.md

#### DARK_MAGENTA field

Gets a system-defined color.

### DARK_OLIVE_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_olive_green.md

#### DARK_OLIVE_GREEN field

Gets a system-defined color.

### DARK_ORANGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_orange.md

#### DARK_ORANGE field

Gets a system-defined color.

### DARK_ORCHID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_orchid.md

#### DARK_ORCHID field

Gets a system-defined color.

### DARK_RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_red.md

#### DARK_RED field

Gets a system-defined color.

### DARK_SALMON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_salmon.md

#### DARK_SALMON field

Gets a system-defined color.

### DARK_SEA_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_sea_green.md

#### DARK_SEA_GREEN field

Gets a system-defined color.

### DARK_SLATE_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_slate_blue.md

#### DARK_SLATE_BLUE field

Gets a system-defined color.

### DARK_SLATE_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_slate_gray.md

#### DARK_SLATE_GRAY field

Gets a system-defined color.

### DARK_TURQUOISE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_turquoise.md

#### DARK_TURQUOISE field

Gets a system-defined color.

### DARK_VIOLET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dark_violet.md

#### DARK_VIOLET field

Gets a system-defined color.

### DEEP_PINK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/deep_pink.md

#### DEEP_PINK field

Gets a system-defined color.

### DEEP_SKY_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/deep_sky_blue.md

#### DEEP_SKY_BLUE field

Gets a system-defined color.

### DIM_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dim_gray.md

#### DIM_GRAY field

Gets a system-defined color.

### DODGER_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/dodger_blue.md

#### DODGER_BLUE field

Gets a system-defined color.

### EMPTY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/empty.md

#### EMPTY field

Gets a system-defined color.

### equals method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/equals.md

#### equals

Determines whether the specified `Color` structure is equivalent to this `Color` structure.

```python
def equals(self, other):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| other | `Color` | The color to test. |

**Returns:** bool: True if `other` is equivalent to this `Color` structure; otherwise, False.

#### equals

Determines whether the specified object is a `Color` structure and is equivalent to this `Color` structure.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The object to test. |

**Returns:** True if object is a `Color` structure equivalent to this `Color` structure; otherwise, False.

### equals_color method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/equals_color.md

#### equals_color

```python
def equals_color(self):
    ...
```

### equals_object method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### FIREBRICK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/firebrick.md

#### FIREBRICK field

Gets a system-defined color.

### FLORAL_WHITE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/floral_white.md

#### FLORAL_WHITE field

Gets a system-defined color.

### FOREST_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/forest_green.md

#### FOREST_GREEN field

Gets a system-defined color.

### from_argb method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/from_argb.md

#### from_argb

Creates a Color structure from a 32-bit ARGB value.

```python
def from_argb(cls, argb):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| argb | `int` | A value specifying the 32-bit ARGB value. |

**Returns:** Color: The Color structure that this method creates.

#### from_argb

Creates a `Color` structure from the specified `Color` structure, but with the new specified alpha value.

Although a 32-bit value can be passed for the alpha value, the value is limited to 8 bits.

```python
def from_argb(cls, alpha, base_color):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| alpha | `int` | The alpha value for the new `Color`. Valid values are 0 through 255. |
| base_color | `Color` | The `Color` from which to create the new `Color`. |

**Returns:** `Color`: The `Color` that this method creates.

| Raises | Description |
| :- | :- |
| `ValueError` | Alpha is less than 0 or greater than 255. |

#### from_argb

Creates a Color structure from the specified 8-bit color values (red, green, and blue) with an implicit alpha value of 255 (fully opaque).

Although the function allows a 32-bit value to be passed for each color component, the value of each component is limited to 8 bits.

```python
def from_argb(cls, red, green, blue):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| red | `int` | The red component value for the new Color. Valid values are 0 through 255. |
| green | `int` | The green component value for the new Color. Valid values are 0 through 255. |
| blue | `int` | The blue component value for the new Color. Valid values are 0 through 255. |

**Returns:** Color: The Color created.

| Raises | Description |
| :- | :- |
| `ValueError` | Red, green, or blue is less than 0 or greater than 255. |

#### from_argb

Creates a Color structure from the four ARGB component (alpha, red, green, and blue) values.

Although the function allows a 32-bit value to be passed for each component, the value of each component is limited to 8 bits.

```python
def from_argb(cls, alpha, red, green, blue):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| alpha | `int` | The alpha component value for the new `Color`. Valid values are 0 through 255. |
| red | `int` | The red component value for the new `Color`. Valid values are 0 through 255. |
| green | `int` | The green component value for the new `Color`. Valid values are 0 through 255. |
| blue | `int` | The blue component value for the new `Color`. Valid values are 0 through 255. |

**Returns:** Color: The `Color` created.

| Raises | Description |
| :- | :- |
| `ValueError` | Red, green, or blue is less than 0 or greater than 255. |

### from_argb_int32 method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/from_argb_int32.md

#### from_argb_int32

```python
def from_argb_int32(cls):
    ...
```

### FUCHSIA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/fuchsia.md

#### FUCHSIA field

Gets a system-defined color.

### g property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/g.md

#### g property

The green component of the color. Valid values are 0 through 255.

##### Definition:
```python
@property
def g(self):
    ...
```

### GAINSBORO field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/gainsboro.md

#### GAINSBORO field

Gets a system-defined color.

### get_brightness method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/get_brightness.md

#### get_brightness

Returns the hue‑saturation‑brightness (HSB) brightness value for this Color structure.

```python
def get_brightness(self):
    ...
```

**Returns:** The brightness of this Color. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

### get_hash_code method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/get_hash_code.md

#### get_hash_code

Returns a hash code for this Color structure.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: An integer value that specifies the hash code for this Color.

### get_hue method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/get_hue.md

#### get_hue

Returns the hue-saturation-brightness (HSB) hue value, in degrees, for this `Color` structure.

```python
def get_hue(self):
    ...
```

**Returns:** float: The hue in degrees of this `Color`. The hue is measured in degrees, ranging from 0.0 through 360.0 in HSB color space.

### get_saturation method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/get_saturation.md

#### get_saturation

Gets the hue-saturation-brightness (HSB) saturation value for this `Color` structure.

```python
def get_saturation(self):
    ...
```

**Returns:** float: The saturation of this `Color`. The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

### GHOST_WHITE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/ghost_white.md

#### GHOST_WHITE field

Gets a system-defined color.

### GOLD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/gold.md

#### GOLD field

Gets a system-defined color.

### GOLDENROD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/goldenrod.md

#### GOLDENROD field

Gets a system-defined color.

### GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/gray.md

#### GRAY field

Gets a system-defined color.

### GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/green.md

#### GREEN field

Gets a system-defined color.

### GREEN_YELLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/green_yellow.md

#### GREEN_YELLOW field

Gets a system-defined color.

### HONEYDEW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/honeydew.md

#### HONEYDEW field

Gets a system-defined color.

### HOT_PINK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/hot_pink.md

#### HOT_PINK field

Gets a system-defined color.

### INDIAN_RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/indian_red.md

#### INDIAN_RED field

Gets a system-defined color.

### INDIGO field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/indigo.md

#### INDIGO field

Gets a system-defined color.

### is_empty property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/is_empty.md

#### is_empty property

The property indicates whether this `Color` structure is uninitialized.

##### Definition:
```python
@property
def is_empty(self):
    ...
```

### IVORY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/ivory.md

#### IVORY field

Gets a system-defined color.

### KHAKI field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/khaki.md

#### KHAKI field

Gets a system-defined color.

### LAVENDER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lavender.md

#### LAVENDER field

Gets a system-defined color.

### LAVENDER_BLUSH field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lavender_blush.md

#### LAVENDER_BLUSH field

Gets a system-defined color.

### LAWN_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lawn_green.md

#### LAWN_GREEN field

Gets a system-defined color.

### LEMON_CHIFFON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lemon_chiffon.md

#### LEMON_CHIFFON field

Gets a system-defined color.

### LIGHT_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_blue.md

#### LIGHT_BLUE field

Gets a system-defined color.

### LIGHT_CORAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_coral.md

#### LIGHT_CORAL field

Gets a system-defined color.

### LIGHT_CYAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_cyan.md

#### LIGHT_CYAN field

Gets a system-defined color.

### LIGHT_GOLDENROD_YELLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_goldenrod_yellow.md

#### LIGHT_GOLDENROD_YELLOW field

Gets a system-defined color.

### LIGHT_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_gray.md

#### LIGHT_GRAY field

Gets a system-defined color.

### LIGHT_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_green.md

#### LIGHT_GREEN field

Gets a system-defined color.

### LIGHT_PINK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_pink.md

#### LIGHT_PINK field

Gets a system-defined color.

### LIGHT_SALMON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_salmon.md

#### LIGHT_SALMON field

Gets a system-defined color.

### LIGHT_SEA_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_sea_green.md

#### LIGHT_SEA_GREEN field

Gets a system-defined color.

### LIGHT_SKY_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_sky_blue.md

#### LIGHT_SKY_BLUE field

Gets a system-defined color.

### LIGHT_SLATE_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_slate_gray.md

#### LIGHT_SLATE_GRAY field

Gets a system-defined color.

### LIGHT_STEEL_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_steel_blue.md

#### LIGHT_STEEL_BLUE field

Gets a system-defined color.

### LIGHT_YELLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/light_yellow.md

#### LIGHT_YELLOW field

Gets a system-defined color.

### LIME field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lime.md

#### LIME field

Gets a system-defined color.

### LIME_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/lime_green.md

#### LIME_GREEN field

Gets a system-defined color.

### LINEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/linen.md

#### LINEN field

Gets a system-defined color.

### MAGENTA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/magenta.md

#### MAGENTA field

Gets a system-defined color.

### MAROON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/maroon.md

#### MAROON field

Gets a system-defined color.

### MEDIUM_AQUAMARINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_aquamarine.md

#### MEDIUM_AQUAMARINE field

Gets a system-defined color.

### MEDIUM_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_blue.md

#### MEDIUM_BLUE field

Gets a system-defined color.

### MEDIUM_ORCHID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_orchid.md

#### MEDIUM_ORCHID field

Gets a system-defined color.

### MEDIUM_PURPLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_purple.md

#### MEDIUM_PURPLE field

Gets a system-defined color.

### MEDIUM_SEA_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_sea_green.md

#### MEDIUM_SEA_GREEN field

Gets a system-defined color.

### MEDIUM_SLATE_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_slate_blue.md

#### MEDIUM_SLATE_BLUE field

Gets a system-defined color.

### MEDIUM_SPRING_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_spring_green.md

#### MEDIUM_SPRING_GREEN field

Gets a system-defined color.

### MEDIUM_TURQUOISE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_turquoise.md

#### MEDIUM_TURQUOISE field

Gets a system-defined color.

### MEDIUM_VIOLET_RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/medium_violet_red.md

#### MEDIUM_VIOLET_RED field

Gets a system-defined color.

### MIDNIGHT_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/midnight_blue.md

#### MIDNIGHT_BLUE field

Gets a system-defined color.

### MINT_CREAM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/mint_cream.md

#### MINT_CREAM field

Gets a system-defined color.

### MISTY_ROSE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/misty_rose.md

#### MISTY_ROSE field

Gets a system-defined color.

### MOCCASIN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/moccasin.md

#### MOCCASIN field

Gets a system-defined color.

### NAVAJO_WHITE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/navajo_white.md

#### NAVAJO_WHITE field

Gets a system-defined color.

### NAVY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/navy.md

#### NAVY field

Gets a system-defined color.

### OLD_LACE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/old_lace.md

#### OLD_LACE field

Gets a system-defined color.

### OLIVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/olive.md

#### OLIVE field

Gets a system-defined color.

### OLIVE_DRAB field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/olive_drab.md

#### OLIVE_DRAB field

Gets a system-defined color.

### ORANGE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/orange.md

#### ORANGE field

Gets a system-defined color.

### ORANGE_RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/orange_red.md

#### ORANGE_RED field

Gets a system-defined color.

### ORCHID field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/orchid.md

#### ORCHID field

Gets a system-defined color.

### PALE_GOLDENROD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/pale_goldenrod.md

#### PALE_GOLDENROD field

Gets a system-defined color.

### PALE_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/pale_green.md

#### PALE_GREEN field

Gets a system-defined color.

### PALE_TURQUOISE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/pale_turquoise.md

#### PALE_TURQUOISE field

Gets a system-defined color.

### PALE_VIOLET_RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/pale_violet_red.md

#### PALE_VIOLET_RED field

Gets a system-defined color.

### PAPAYA_WHIP field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/papaya_whip.md

#### PAPAYA_WHIP field

Gets a system-defined color.

### PEACH_PUFF field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/peach_puff.md

#### PEACH_PUFF field

Gets a system-defined color.

### PERU field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/peru.md

#### PERU field

Gets a system-defined color.

### PINK field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/pink.md

#### PINK field

Gets a system-defined color.

### PLUM field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/plum.md

#### PLUM field

Gets a system-defined color.

### POWDER_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/powder_blue.md

#### POWDER_BLUE field

Gets a system-defined color.

### PURPLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/purple.md

#### PURPLE field

Gets a system-defined color.

### r property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/r.md

#### r property

The red component of the color. Valid values are 0 through 255.

##### Definition:
```python
@property
def r(self):
    ...
```

### RED field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/red.md

#### RED field

Gets a system-defined color.

### ROSY_BROWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/rosy_brown.md

#### ROSY_BROWN field

Gets a system-defined color.

### ROYAL_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/royal_blue.md

#### ROYAL_BLUE field

Gets a system-defined color.

### SADDLE_BROWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/saddle_brown.md

#### SADDLE_BROWN field

Gets a system-defined color.

### SALMON field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/salmon.md

#### SALMON field

Gets a system-defined color.

### SANDY_BROWN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/sandy_brown.md

#### SANDY_BROWN field

Gets a system-defined color.

### SEA_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/sea_green.md

#### SEA_GREEN field

Gets a system-defined color.

### SEA_SHELL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/sea_shell.md

#### SEA_SHELL field

Gets a system-defined color.

### SIENNA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/sienna.md

#### SIENNA field

Gets a system-defined color.

### SILVER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/silver.md

#### SILVER field

Gets a system-defined color.

### SKY_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/sky_blue.md

#### SKY_BLUE field

Gets a system-defined color.

### SLATE_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/slate_blue.md

#### SLATE_BLUE field

Gets a system-defined color.

### SLATE_GRAY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/slate_gray.md

#### SLATE_GRAY field

Gets a system-defined color.

### SNOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/snow.md

#### SNOW field

Gets a system-defined color.

### SPRING_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/spring_green.md

#### SPRING_GREEN field

Gets a system-defined color.

### STEEL_BLUE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/steel_blue.md

#### STEEL_BLUE field

Gets a system-defined color.

### TAN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/tan.md

#### TAN field

Gets a system-defined color.

### TEAL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/teal.md

#### TEAL field

Gets a system-defined color.

### THISTLE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/thistle.md

#### THISTLE field

Gets a system-defined color.

### to_argb method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/to_argb.md

#### to_argb

Returns the 32-bit ARGB value of this Color structure.

```python
def to_argb(self):
    ...
```

**Returns:** The 32-bit ARGB value of this Color structure.

##### Example

```python
    import groupdocs.watermark as gw
    import groupdocs.watermark.contents.diagram as gwc_vsdx

    load_options = gw.DiagramLoadOptions()
    with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
        content = watermarker.get_content(gwc_vsdx.DiagramContent)
        argb = content.header_footer.text_color.to_argb()
        print(argb)
    ```

### TOMATO field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/tomato.md

#### TOMATO field

Gets a system-defined color.

### TRANSPARENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/transparent.md

#### TRANSPARENT field

Gets a system-defined color.

### TURQUOISE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/turquoise.md

#### TURQUOISE field

Gets a system-defined color.

### VIOLET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/violet.md

#### VIOLET field

Gets a system-defined color.

### WHEAT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/wheat.md

#### WHEAT field

Gets a system-defined color.

### WHITE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/white.md

#### WHITE field

Gets a system-defined color.

### WHITE_SMOKE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/white_smoke.md

#### WHITE_SMOKE field

Gets a system-defined color.

### YELLOW field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/yellow.md

#### YELLOW field

Gets a system-defined color.

### YELLOW_GREEN field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/color/yellow_green.md

#### YELLOW_GREEN field

Gets a system-defined color.

### Font class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font.md

#### Font class

Represents a font.

The Font type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new Font instance with a specified font family name and size. |
| __init__ | Initializes a new Font with the specified font family name, size, and style. |
| __init__ | Initializes a Font with a custom font family name, a folder path containing TrueType font files, a size, and a style. |
| __init__ | Initializes a new instance of the `Font` class with a specified custom font family name, folder path containing TrueType font files, and a size. |

##### Properties
| Property | Description |
| :- | :- |
| bold | The font is bold. |
| family_name | The family name of this Font. |
| folder_path | The folder that contains TrueType font files. |
| italic | The font is italic. |
| size | The size of this Font. |
| strikeout | The font specifies a horizontal line through the characters. |
| style | The style information for this `Font`. |
| underline | The font is underlined. |

##### Example

```python
import groupdocs.watermark.watermarks as gww

# Create a font using a custom TrueType font located in a folder
font = gww.Font("CustomFontName", r"c:\CustomFonts\", 36.0)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/__init__.md

#### __init__

Initializes a new Font instance with a specified font family name and size.

```python
def __init__(self, font_family_name, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` | The font family name. |
| size | `float` | The size of the new font. |

##### Example

```python
import groupdocs.watermark.watermarks as gww

font = gww.Font("Arial", 8.0)
```

#### __init__

Initializes a new Font with the specified font family name, size, and style.

```python
def __init__(self, font_family_name, size, style):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` | The font family name. |
| size | `float` | The size of the new font. |
| style | `FontStyle` | The style of the new font. |

##### Example

```python
import groupdocs.watermark.watermarks as gww

font = gww.Font("Arial", 12.0, gww.FontStyle.Regular)
```

#### __init__

Initializes a Font with a custom font family name, a folder path containing TrueType font files, a size, and a style.

```python
def __init__(self, font_family_name, folder_path, size):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` | The font family name. |
| folder_path | `str` | Folder path which contains TrueType font files. |
| size | `float` | The size of the new font. |

##### Example

```python
import groupdocs.watermark.watermarks as gww

fonts_folder = r"c:\\CustomFonts\\"
font = gww.Font("CustomFontName", fonts_folder, 36.0)
```

#### __init__

Initializes a new instance of the `Font` class with a specified custom font family name, folder path containing TrueType font files, and a size.

```python
def __init__(self, font_family_name, folder_path, size, style):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| font_family_name | `str` | The font family name. |
| folder_path | `str` | Folder path which contains TrueType font files. |
| size | `float` | The size of the new font. |
| style | `FontStyle` |  |

##### Example

```python
import groupdocs.watermark.watermarks as gww

fonts_folder = r"c:\\CustomFonts\\"
font = gww.Font("CustomFontName", fonts_folder, 36.0)
```

### bold property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/bold.md

#### bold property

The font is bold.

True if the font is bold; otherwise, False.

##### Definition:
```python
@property
def bold(self):
    ...
```

### family_name property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/family_name.md

#### family_name property

The family name of this Font.

##### Definition:
```python
@property
def family_name(self):
    ...
```

### folder_path property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/folder_path.md

#### folder_path property

The folder that contains TrueType font files.

##### Definition:
```python
@property
def folder_path(self):
    ...
```

### italic property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/italic.md

#### italic property

The font is italic.

Returns True if the font is italic; otherwise, False.

##### Definition:
```python
@property
def italic(self):
    ...
```

### size property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/size.md

#### size property

The size of this Font.

##### Definition:
```python
@property
def size(self):
    ...
```

### strikeout property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/strikeout.md

#### strikeout property

The font specifies a horizontal line through the characters.

##### Definition:
```python
@property
def strikeout(self):
    ...
```

### style property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/style.md

#### style property

The style information for this `Font`.

Default value is `FontStyle.regular` (normal text).

##### Definition:
```python
@property
def style(self):
    ...
```

### underline property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/font/underline.md

#### underline property

The font is underlined.

True if the font is underlined; otherwise, False.

##### Definition:
```python
@property
def underline(self):
    ...
```

### FontStyle class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle.md

#### FontStyle class

The FontStyle type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| REGULAR | Normal text. |
| BOLD | Bold text. |
| ITALIC | Italic text. |
| UNDERLINE | Underlined text. |
| STRIKEOUT | Text with a line through the middle. |

### BOLD field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle/bold.md

#### BOLD field

Bold text.

##### Value
`1`

### ITALIC field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle/italic.md

#### ITALIC field

Italic text.

##### Value
`2`

### REGULAR field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle/regular.md

#### REGULAR field

Normal text.

##### Value
`0`

### STRIKEOUT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle/strikeout.md

#### STRIKEOUT field

Text with a line through the middle.

##### Value
`8`

### UNDERLINE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/fontstyle/underline.md

#### UNDERLINE field

Underlined text.

##### Value
`4`

### ImageWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark.md

#### ImageWatermark class

Represents an image watermark.

Learn more:
- Adding image watermarks: https://docs.groupdocs.com/display/watermarknet/Adding+image+watermarks

The ImageWatermark type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new ImageWatermark instance using the specified file path. |
| __init__ | Initializes a new ImageWatermark instance using the provided image stream. |

##### Methods
| Method | Description |
| :- | :- |
| dispose | Disposes the current instance. |

##### Properties
| Property | Description |
| :- | :- |
| consider_parent_margins | The consider_parent_margins property indicates whether the watermark size and coordinates are calculated considering parent margins. If set to True, margins are taken into account; otherwise (default False) they are ignored. (inherited from `Watermark`) |
| height | The desired height of this `Watermark`. (inherited from `Watermark`) |
| horizontal_alignment | The horizontal alignment of this Watermark. (inherited from `Watermark`) |
| is_background | The watermark is placed in the background when True; otherwise it is placed in the foreground (top). The default is False. (inherited from `Watermark`) |
| margins | The margin settings of this Watermark. (inherited from `Watermark`) |
| opacity | The opacity of this Watermark. (inherited from `Watermark`) |
| pages_setup | The pages setup settings of this Watermark. (inherited from `Watermark`) |
| rotate_angle | The rotate angle of this Watermark in degrees. (inherited from `Watermark`) |
| save_result_in_metadata | The flag indicating whether information about added watermarks is saved in the document metadata. (inherited from `Watermark`) |
| scale_factor | The scale factor of this Watermark, defining how the watermark size depends on the parent size. (inherited from `Watermark`) |
| sizing_type | The sizing type specifying how the watermark should be sized. (inherited from `Watermark`) |
| tile_options | The options to define a repeated watermark. (inherited from `Watermark`) |
| vertical_alignment | The vertical alignment of this Watermark. (inherited from `Watermark`) |
| width | The desired width of this `Watermark`. (inherited from `Watermark`) |
| x | The x-coordinate of this Watermark. (inherited from `Watermark`) |
| y | The y-coordinate of this Watermark. (inherited from `Watermark`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("document.pdf") as watermarker:
    with gww.ImageWatermark("watermark.png") as watermark:
        watermarker.add(watermark)
        watermarker.save("document.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/__init__.md

#### __init__

Initializes a new ImageWatermark instance using the specified file path.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The path to the image that will be used as watermark. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("presentation.pptx") as watermarker:
    with gww.ImageWatermark("watermark.jpg") as watermark:
        watermarker.add(watermark)
        watermarker.save("presentation.pptx")
```

#### __init__

Initializes a new ImageWatermark instance using the provided image stream.

```python
def __init__(self, stream):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| stream | `io.RawIOBase` | The stream containing the image that will be used as watermark. |

##### Example

```python
    import io
    import groupdocs.watermark as gw
    import groupdocs.watermark.watermarks as gww

    with open("watermark.jpg", "rb") as f:
        data = f.read()

    with gw.Watermarker("image.png") as watermarker:
        with gww.ImageWatermark(io.BytesIO(data)) as watermark:
            watermarker.add(watermark)
            watermarker.save("image.png")
    ```

### consider_parent_margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/consider_parent_margins.md

#### consider_parent_margins property

Gets or sets a value indicating whether the watermark size and coordinates are calculated
considering parent margins.

### dispose method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/dispose.md

#### dispose

Disposes the current instance.

```python
def dispose(self):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/height.md

#### height property

Gets or sets the desired height of this `Watermark`.

##### Remarks

Setting this property will also change the value of `Watermark.sizing_type`
property to `SizingType.ABSOLUTE`.

### horizontal_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/horizontal_alignment.md

#### horizontal_alignment property

Gets or sets the horizontal alignment of this `Watermark`.

##### Remarks

Default value is `HorizontalAlignment.NONE`.

### is_background property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/is_background.md

#### is_background property

Gets or sets a value indicating whether the watermark should be placed at background.

### margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/margins.md

#### margins property

Gets or sets the margin settings of this `Watermark`.

### opacity property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/opacity.md

#### opacity property

Gets or sets the opacity of this `Watermark`.

##### Remarks

The value of opacity should be between 0 and 1. The default value is 1.

### pages_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/pages_setup.md

#### pages_setup property

Gets or sets the pages setup settings of this `Watermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/rotate_angle.md

#### rotate_angle property

Gets or sets the rotate angle of this `Watermark` in degrees.

### save_result_in_metadata property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/save_result_in_metadata.md

#### save_result_in_metadata property

Gets or sets a value indicating whether to save information about added watermarks in the document metadata.

### scale_factor property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/scale_factor.md

#### scale_factor property

Gets or sets a value that defines how watermark size depends on parent size.

##### Remarks

The value must be between 0 and 1.

### sizing_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/sizing_type.md

#### sizing_type property

Gets or sets a value specifying a way watermark should be sized.

### tile_options property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/tile_options.md

#### tile_options property

Get or sets options to define repeated watermark

### vertical_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/vertical_alignment.md

#### vertical_alignment property

Gets or sets the vertical alignment of this `Watermark`.

##### Remarks

Default value is `VerticalAlignment.NONE`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/width.md

#### width property

Gets or sets the desired width of this `Watermark`.

##### Remarks

Setting this property will also change the value of `Watermark.sizing_type`
property to `SizingType.ABSOLUTE`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/x.md

#### x property

Gets or sets the x-coordinate of this `Watermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/imagewatermark/y.md

#### y property

Gets or sets the y-coordinate of this `Watermark`.

### Margins class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins.md

#### Margins class

Represents margin settings for each edge of an object.

The Margins type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `Margins` class. |
| __init__ | Initializes a new instance of the `Margins` class with the specified type, location and size. |

##### Properties
| Property | Description |
| :- | :- |
| bottom | The bottom margin, expressed as the horizontal offset from the parent bottom border. |
| left | The left margin, expressed as the horizontal offset from the parent left border. |
| margin_type | The margin type, specifying how margins should be interpreted. Setting a new value automatically resets all margins to their default values (zero). |
| right | The right margin, expressed as the horizontal offset from the parent right border. |
| top | The top margin, expressed as the horizontal offset from the parent top border. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/__init__.md

#### __init__

Initializes a new instance of the `Margins` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new instance of the `Margins` class with the specified type, location and size.

```python
def __init__(self, margin_type, left, right, top, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| margin_type | `MarginType` | The margin type. Specifies how margin values should be interpreted. |
| left | `float` | The left margin value. |
| right | `float` | The right margin value. |
| top | `float` | The top margin value. |
| bottom | `float` | The bottom margin value. |

### bottom property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/bottom.md

#### bottom property

The bottom margin, expressed as the horizontal offset from the parent bottom border.

##### Definition:
```python
@property
def bottom(self):
    ...
@bottom.setter
def bottom(self, value):
    ...
```

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/left.md

#### left property

The left margin, expressed as the horizontal offset from the parent left border.

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### margin_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/margin_type.md

#### margin_type property

The margin type, specifying how margins should be interpreted. Setting a new value automatically resets all margins to their default values (zero).

The default value is `MarginType.absolute`.

##### Definition:
```python
@property
def margin_type(self):
    ...
@margin_type.setter
def margin_type(self, value):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/right.md

#### right property

The right margin, expressed as the horizontal offset from the parent right border.

##### Definition:
```python
@property
def right(self):
    ...
@right.setter
def right(self, value):
    ...
```

### top property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margins/top.md

#### top property

The top margin, expressed as the horizontal offset from the parent top border.

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### MarginType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margintype.md

#### MarginType class

The MarginType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| ABSOLUTE | Margin value measured in content units. |
| RELATIVE_TO_PARENT_DIMENSIONS | Margin value should be interpreted as a portion of appropriate parent dimension. |
| RELATIVE_TO_PARENT_MIN_DIMENSION | Margin value should be interpreted as a portion of parent minimum dimension. |

### ABSOLUTE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margintype/absolute.md

#### ABSOLUTE field

Margin value measured in content units.

##### Value
`0`

### RELATIVE_TO_PARENT_DIMENSIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margintype/relative_to_parent_dimensions.md

#### RELATIVE_TO_PARENT_DIMENSIONS field

Margin value should be interpreted as a portion of appropriate parent dimension.

##### Value
`1`

### RELATIVE_TO_PARENT_MIN_DIMENSION field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/margintype/relative_to_parent_min_dimension.md

#### RELATIVE_TO_PARENT_MIN_DIMENSION field

Margin value should be interpreted as a portion of parent minimum dimension.

##### Value
`2`

### MeasureValue class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/measurevalue.md

#### MeasureValue class

Represents a measurement value with a specific type and numerical value.

The MeasureValue type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Properties
| Property | Description |
| :- | :- |
| measure_type | The type of measurement. |
| value | The numerical value of the measurement. Must be greater than 0. |

##### Example

```python
import groupdocs.watermark.watermarks as gww

# Create a measurement of 12 percent
value = gww.MeasureValue(gww.TileMeasureType.PERCENT, 12)
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/measurevalue/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### measure_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/measurevalue/measure_type.md

#### measure_type property

The type of measurement.

##### Definition:
```python
@property
def measure_type(self):
    ...
@measure_type.setter
def measure_type(self, value):
    ...
```

### value property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/measurevalue/value.md

#### value property

The numerical value of the measurement. Must be greater than 0.

##### Definition:
```python
@property
def value(self):
    ...
@value.setter
def value(self, value):
    ...
```

### PagesSetup class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup.md

#### PagesSetup class

Represents the setup for pages.

The PagesSetup type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the `PagesSetup` class. |
| __init__ | Initializes a new PagesSetup instance with specified parameters. |

##### Properties
| Property | Description |
| :- | :- |
| all_pages | The property indicating whether to include all pages. |
| even_pages | The flag indicating whether to include even pages. |
| first_page | The first_page property indicates whether to include the first page. |
| last_page | The last_page property indicates whether to include the last page. |
| odd_pages | The odd_pages property indicates whether to include odd pages. |
| page_number | The page number when considering only specified pages. |
| pages | The list of specific page numbers to include. |
| specified | The value indicates whether any specific pages are specified. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/__init__.md

#### __init__

Initializes a new instance of the `PagesSetup` class.

```python
def __init__(self):
    ...
```

#### __init__

Initializes a new PagesSetup instance with specified parameters.

```python
def __init__(self, all_pages, first_page, last_page, odd_pages, even_pages, pages, page_number):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| all_pages | `bool` | Whether to include all pages. |
| first_page | `bool` | Whether to include the first page. |
| last_page | `bool` | Whether to include the last page. |
| odd_pages | `bool` | Whether to include odd pages. |
| even_pages | `bool` | Whether to include even pages. |
| pages | `List[int]` | The list of specific page numbers to include. |
| page_number | `Optional[int]` | The index of the current page. |

### all_pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/all_pages.md

#### all_pages property

The property indicating whether to include all pages.

##### Definition:
```python
@property
def all_pages(self):
    ...
@all_pages.setter
def all_pages(self, value):
    ...
```

### even_pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/even_pages.md

#### even_pages property

The flag indicating whether to include even pages.

##### Definition:
```python
@property
def even_pages(self):
    ...
@even_pages.setter
def even_pages(self, value):
    ...
```

### first_page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/first_page.md

#### first_page property

The first_page property indicates whether to include the first page.

##### Definition:
```python
@property
def first_page(self):
    ...
@first_page.setter
def first_page(self, value):
    ...
```

### last_page property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/last_page.md

#### last_page property

The last_page property indicates whether to include the last page.

##### Definition:
```python
@property
def last_page(self):
    ...
@last_page.setter
def last_page(self, value):
    ...
```

### odd_pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/odd_pages.md

#### odd_pages property

The odd_pages property indicates whether to include odd pages.

##### Definition:
```python
@property
def odd_pages(self):
    ...
@odd_pages.setter
def odd_pages(self, value):
    ...
```

### page_number property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/page_number.md

#### page_number property

The page number when considering only specified pages.

##### Definition:
```python
@property
def page_number(self):
    ...
@page_number.setter
def page_number(self, value):
    ...
```

### pages property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/pages.md

#### pages property

The list of specific page numbers to include.

##### Definition:
```python
@property
def pages(self):
    ...
@pages.setter
def pages(self, value):
    ...
```

### specified property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/pagessetup/specified.md

#### specified property

The value indicates whether any specific pages are specified.

##### Definition:
```python
@property
def specified(self):
    ...
```

### SizingType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/sizingtype.md

#### SizingType class

The SizingType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| AUTO | Watermark should be sized automatically according to its content. |
| ABSOLUTE | Watermark should be sized to an exact and |
| SCALE_TO_PARENT_DIMENSIONS | Watermark should be scaled relative to parent dimensions using specified . |
| SCALE_TO_PARENT_AREA | Watermark should be scaled relative to parent area using specified |

### ABSOLUTE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/sizingtype/absolute.md

#### ABSOLUTE field

Watermark should be sized to an exact and

##### Value
`1`

### AUTO field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/sizingtype/auto.md

#### AUTO field

Watermark should be sized automatically according to its content.

##### Value
`0`

### SCALE_TO_PARENT_AREA field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/sizingtype/scale_to_parent_area.md

#### SCALE_TO_PARENT_AREA field

Watermark should be scaled relative to parent area using specified

##### Value
`3`

### SCALE_TO_PARENT_DIMENSIONS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/sizingtype/scale_to_parent_dimensions.md

#### SCALE_TO_PARENT_DIMENSIONS field

Watermark should be scaled relative to parent dimensions using specified .

##### Value
`2`

### TextAlignment class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textalignment.md

#### TextAlignment class

The TextAlignment type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| LEFT | Align to left. |
| CENTER | Center alignment. |
| RIGHT | Align to right. |
| JUSTIFY | Justify alignment. Text will be aligned on both left and right margins. |

### CENTER field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textalignment/center.md

#### CENTER field

Center alignment.

##### Value
`1`

### JUSTIFY field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textalignment/justify.md

#### JUSTIFY field

Justify alignment. Text will be aligned on both left and right margins.

##### Value
`3`

### LEFT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textalignment/left.md

#### LEFT field

Align to left.

##### Value
`0`

### RIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textalignment/right.md

#### RIGHT field

Align to right.

##### Value
`2`

### TextWatermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark.md

#### TextWatermark class

Represents a text watermark.

Learn more:
- https://docs.groupdocs.com/display/watermarknet/Adding+text+watermarks

The TextWatermark type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of the TextWatermark class with a specified text and a font. |

##### Properties
| Property | Description |
| :- | :- |
| background_color | The background color of the text. |
| font | The font of the text. |
| foreground_color | The foreground color of the text. |
| padding | The padding settings of this TextWatermark. |
| text | The text to be used as watermark. |
| text_alignment | The watermark text alignment. |
| consider_parent_margins | The consider_parent_margins property indicates whether the watermark size and coordinates are calculated considering parent margins. If set to True, margins are taken into account; otherwise (default False) they are ignored. (inherited from `Watermark`) |
| height | The desired height of this `Watermark`. (inherited from `Watermark`) |
| horizontal_alignment | The horizontal alignment of this Watermark. (inherited from `Watermark`) |
| is_background | The watermark is placed in the background when True; otherwise it is placed in the foreground (top). The default is False. (inherited from `Watermark`) |
| margins | The margin settings of this Watermark. (inherited from `Watermark`) |
| opacity | The opacity of this Watermark. (inherited from `Watermark`) |
| pages_setup | The pages setup settings of this Watermark. (inherited from `Watermark`) |
| rotate_angle | The rotate angle of this Watermark in degrees. (inherited from `Watermark`) |
| save_result_in_metadata | The flag indicating whether information about added watermarks is saved in the document metadata. (inherited from `Watermark`) |
| scale_factor | The scale factor of this Watermark, defining how the watermark size depends on the parent size. (inherited from `Watermark`) |
| sizing_type | The sizing type specifying how the watermark should be sized. (inherited from `Watermark`) |
| tile_options | The options to define a repeated watermark. (inherited from `Watermark`) |
| vertical_alignment | The vertical alignment of this Watermark. (inherited from `Watermark`) |
| width | The desired width of this `Watermark`. (inherited from `Watermark`) |
| x | The x-coordinate of this Watermark. (inherited from `Watermark`) |
| y | The y-coordinate of this Watermark. (inherited from `Watermark`) |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Calibri", 12.0)
    watermark = gww.TextWatermark("This is a test watermark", font)
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 0.5
    watermarker.add(watermark)
    watermarker.save("image.png")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/__init__.md

#### __init__

Initializes a new instance of the TextWatermark class with a specified text and a font.

```python
def __init__(self, text, font):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| text | `str` | The text to be used as watermark. |
| font | `Font` | The font of the text. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Calibri", 12.0)
    watermark = gww.TextWatermark("This is a test watermark", font)
    watermarker.add(watermark)
    watermarker.save("image.png")
```

### background_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/background_color.md

#### background_color property

The background color of the text.

##### Definition:
```python
@property
def background_color(self):
    ...
@background_color.setter
def background_color(self, value):
    ...
```

### consider_parent_margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/consider_parent_margins.md

#### consider_parent_margins property

Gets or sets a value indicating whether the watermark size and coordinates are calculated
considering parent margins.

### font property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/font.md

#### font property

The font of the text.

##### Definition:
```python
@property
def font(self):
    ...
@font.setter
def font(self, value):
    ...
```

### foreground_color property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/foreground_color.md

#### foreground_color property

The foreground color of the text.

##### Definition:
```python
@property
def foreground_color(self):
    ...
@foreground_color.setter
def foreground_color(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/height.md

#### height property

Gets or sets the desired height of this `Watermark`.

##### Remarks

Setting this property will also change the value of `Watermark.sizing_type`
property to `SizingType.ABSOLUTE`.

### horizontal_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/horizontal_alignment.md

#### horizontal_alignment property

Gets or sets the horizontal alignment of this `Watermark`.

##### Remarks

Default value is `HorizontalAlignment.NONE`.

### is_background property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/is_background.md

#### is_background property

Gets or sets a value indicating whether the watermark should be placed at background.

### margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/margins.md

#### margins property

Gets or sets the margin settings of this `Watermark`.

### opacity property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/opacity.md

#### opacity property

Gets or sets the opacity of this `Watermark`.

##### Remarks

The value of opacity should be between 0 and 1. The default value is 1.

### padding property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/padding.md

#### padding property

The padding settings of this TextWatermark.

This property is applicable only to image files.

##### Definition:
```python
@property
def padding(self):
    ...
@padding.setter
def padding(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/pages_setup.md

#### pages_setup property

Gets or sets the pages setup settings of this `Watermark`.

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/rotate_angle.md

#### rotate_angle property

Gets or sets the rotate angle of this `Watermark` in degrees.

### save_result_in_metadata property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/save_result_in_metadata.md

#### save_result_in_metadata property

Gets or sets a value indicating whether to save information about added watermarks in the document metadata.

### scale_factor property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/scale_factor.md

#### scale_factor property

Gets or sets a value that defines how watermark size depends on parent size.

##### Remarks

The value must be between 0 and 1.

### sizing_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/sizing_type.md

#### sizing_type property

Gets or sets a value specifying a way watermark should be sized.

### text property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/text.md

#### text property

The text to be used as watermark.

##### Definition:
```python
@property
def text(self):
    ...
@text.setter
def text(self, value):
    ...
```

### text_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/text_alignment.md

#### text_alignment property

The watermark text alignment.

Default value is `TextAlignment.left`.

##### Definition:
```python
@property
def text_alignment(self):
    ...
@text_alignment.setter
def text_alignment(self, value):
    ...
```

### tile_options property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/tile_options.md

#### tile_options property

Get or sets options to define repeated watermark

### vertical_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/vertical_alignment.md

#### vertical_alignment property

Gets or sets the vertical alignment of this `Watermark`.

##### Remarks

Default value is `VerticalAlignment.NONE`.

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/width.md

#### width property

Gets or sets the desired width of this `Watermark`.

##### Remarks

Setting this property will also change the value of `Watermark.sizing_type`
property to `SizingType.ABSOLUTE`.

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/x.md

#### x property

Gets or sets the x-coordinate of this `Watermark`.

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/textwatermark/y.md

#### y property

Gets or sets the y-coordinate of this `Watermark`.

### Thickness class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness.md

#### Thickness class

Represents the thickness of a frame around a rectangle.

The Thickness type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new Thickness instance with specific lengths applied to each side of the rectangle. |
| __init__ | Initializes a new instance of the `Thickness` class that has the specified uniform length on each side. |

##### Methods
| Method | Description |
| :- | :- |
| equals | Determines whether the specified `Thickness` is equal to the current `Thickness`. |
| equals_object |  |
| get_hash_code | Returns the hash code for this instance. |
| to_string | Returns the string representation of the `Thickness` class. |

##### Properties
| Property | Description |
| :- | :- |
| bottom | The width of the bottom side of the bounding rectangle. |
| left | The width of the left side of the bounding rectangle. |
| right | The width of the right side of the bounding rectangle. |
| top | The width of the top side of the bounding rectangle. |

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/__init__.md

#### __init__

Initializes a new Thickness instance with specific lengths applied to each side of the rectangle.

```python
def __init__(self, left, right, top, bottom):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| left | `float` | The thickness for the left side of the rectangle. |
| right | `float` | The thickness for the right side of the rectangle. |
| top | `float` | The thickness for the top side of the rectangle. |
| bottom | `float` | The thickness for the bottom side of the rectangle. |

#### __init__

Initializes a new instance of the `Thickness` class that has the specified uniform length on each side.

```python
def __init__(self, uniform_length):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| uniform_length | `float` | The uniform length applied to all four sides of the bounding rectangle. |

### bottom property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/bottom.md

#### bottom property

The width of the bottom side of the bounding rectangle.

##### Definition:
```python
@property
def bottom(self):
    ...
@bottom.setter
def bottom(self, value):
    ...
```

### equals method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/equals.md

#### equals

Determines whether the specified `Thickness` is equal to the current `Thickness`.

```python
def equals(self, obj):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| obj | `Any` | The `Thickness` to compare with the current `Thickness`. |

**Returns:** bool: True if the specified `Thickness` is equal to the current `Thickness`; otherwise, False.

### equals_object method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/equals_object.md

#### equals_object

```python
def equals_object(self):
    ...
```

### get_hash_code method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/get_hash_code.md

#### get_hash_code

Returns the hash code for this instance.

```python
def get_hash_code(self):
    ...
```

**Returns:** int: A 32-bit signed integer hash code.

### left property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/left.md

#### left property

The width of the left side of the bounding rectangle.

##### Definition:
```python
@property
def left(self):
    ...
@left.setter
def left(self, value):
    ...
```

### right property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/right.md

#### right property

The width of the right side of the bounding rectangle.

##### Definition:
```python
@property
def right(self):
    ...
@right.setter
def right(self, value):
    ...
```

### to_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/to_string.md

#### to_string

Returns the string representation of the `Thickness` class.

```python
def to_string(self):
    ...
```

**Returns:** str: A string that represents the `Thickness` value.

### top property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/thickness/top.md

#### top property

The width of the top side of the bounding rectangle.

##### Definition:
```python
@property
def top(self):
    ...
@top.setter
def top(self, value):
    ...
```

### TileMeasureType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tilemeasuretype.md

#### TileMeasureType class

The TileMeasureType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PIXEL | Specifies that the unit of measurement is pixel. |
| PERCENT | Specifies that the unit of measurement is percent. |
| POINTS | Specifies that the unit of measurement is point. |

### PERCENT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tilemeasuretype/percent.md

#### PERCENT field

Specifies that the unit of measurement is percent.

##### Value
`1`

### PIXEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tilemeasuretype/pixel.md

#### PIXEL field

Specifies that the unit of measurement is pixel.

##### Value
`0`

### POINTS field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tilemeasuretype/points.md

#### POINTS field

Specifies that the unit of measurement is point.

##### Value
`2`

### TileOptions class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions.md

#### TileOptions class

Represents options for configuring watermarks in tile mode.

The TileOptions type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ |  |

##### Properties
| Property | Description |
| :- | :- |
| line_spacing | The spacing between lines for watermarks in tile mode. |
| rotate_around_origin | The property indicates whether repeated watermarks are rotated around the bottom left point of the document; if `False`, rotation is relative to the left edge (default is `False`). |
| tile_type | The type of tile alignment for watermarks. |
| watermark_spacing | The spacing between serials for watermarks in tile mode. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample.pdf") as watermarker:
    watermark = gww.ImageWatermark("watermark.jpg")
    watermark.tile_options = gww.TileOptions()
    watermark.tile_options.line_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 12)
    watermark.tile_options.watermark_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 10)
    watermarker.add(watermark)
    watermarker.save("result.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions/__init__.md

#### __init__

```python
def __init__(self):
    ...
```

### line_spacing property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions/line_spacing.md

#### line_spacing property

The spacing between lines for watermarks in tile mode.

##### Definition:
```python
@property
def line_spacing(self):
    ...
@line_spacing.setter
def line_spacing(self, value):
    ...
```

### rotate_around_origin property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions/rotate_around_origin.md

#### rotate_around_origin property

The property indicates whether repeated watermarks are rotated around the bottom left point of the document; if `False`, rotation is relative to the left edge (default is `False`).

##### Definition:
```python
@property
def rotate_around_origin(self):
    ...
@rotate_around_origin.setter
def rotate_around_origin(self, value):
    ...
```

### tile_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions/tile_type.md

#### tile_type property

The type of tile alignment for watermarks.

##### Definition:
```python
@property
def tile_type(self):
    ...
@tile_type.setter
def tile_type(self, value):
    ...
```

### watermark_spacing property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tileoptions/watermark_spacing.md

#### watermark_spacing property

The spacing between serials for watermarks in tile mode.

##### Definition:
```python
@property
def watermark_spacing(self):
    ...
@watermark_spacing.setter
def watermark_spacing(self, value):
    ...
```

### TileType class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tiletype.md

#### TileType class

The TileType type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| STRAIGHT | Represents straight tile alignment. |
| OFFSET | Represents offset tile alignment. |
| ONE_THIRD_OFFSET | Represents 1/3 offset tile alignment. |
| BASKET_WEAVE | Represents basket weave tile pattern |

### BASKET_WEAVE field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tiletype/basket_weave.md

#### BASKET_WEAVE field

Represents basket weave tile pattern

##### Value
`3`

### OFFSET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tiletype/offset.md

#### OFFSET field

Represents offset tile alignment.

##### Value
`1`

### ONE_THIRD_OFFSET field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tiletype/one_third_offset.md

#### ONE_THIRD_OFFSET field

Represents 1/3 offset tile alignment.

##### Value
`2`

### STRAIGHT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.watermarks/tiletype/straight.md

#### STRAIGHT field

Represents straight tile alignment.

##### Value
`0`

### groupdocs.watermark
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark.md

Main GroupDocs.Watermark namespace with top-level API classes.

##### Classes
| Class | Description |
| :- | :- |
| `License` | Manages GroupDocs.Watermark licensing. |
| `Metered` | Manages metered (pay-per-use) licensing. |
| `Watermark` | Represents a watermark to be added to a document. |
| `Watermarker` | Represents a class for watermark management in a document. |
| `WatermarkerSettings` | Defines settings for customizing Watermarker behaviour. |

##### Enumerations
| Enum | Description |
| :- | :- |
| `UnitOfMeasurement` |  |

##### Exceptions
| Exception | Description |
| :- | :- |
| `DetachedImageException` | The exception that is thrown when manipulating detached image. |
| `EncryptionIsNotSupportedException` | The exception that is thrown when content encryption is not supported. |
| `FontNotFoundException` | The exception that is thrown when requested font is not found. |
| `GroupDocsWatermarkException` | Product-root exception for 'watermark' — every |
| `ImageEffectsForTextWatermarkException` | The exception that is thrown when is supplied for . |
| `InvalidPasswordException` | The exception that is thrown when supplied password is incorrect. |
| `PreviewNotSupportedException` | The exception that is thrown when a preview image cannot be generated for the content. |
| `TextEffectsForImageWatermarkException` | The exception that is thrown when is supplied for . |
| `UnexpectedDocumentStructureException` | The exception that is thrown when a content cannot be parsed due to unexpected structure. |
| `UnknownLoadOptionsTypeException` | The exception that is thrown when a document cannot be loaded with supplied . |
| `UnknownWatermarkOptionsTypeException` | The exception that is thrown when a watermark cannot be added with supplied . |
| `UnsupportedFileTypeException` | The exception that is thrown when a file cannot be loaded. |
| `WatermarkException` | Represents base exception in GroupDocs.Watermark product. |

### DetachedImageException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/detachedimageexception.md

#### DetachedImageException class

The exception that is thrown when manipulating detached image.

The DetachedImageException type exposes the following members:

### EncryptionIsNotSupportedException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/encryptionisnotsupportedexception.md

#### EncryptionIsNotSupportedException class

The exception that is thrown when content encryption is not supported.

The EncryptionIsNotSupportedException type exposes the following members:

### FontNotFoundException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/fontnotfoundexception.md

#### FontNotFoundException class

The exception that is thrown when requested font is not found.

The FontNotFoundException type exposes the following members:

### GroupDocsWatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/groupdocswatermarkexception.md

#### GroupDocsWatermarkException class

Product-root exception for 'watermark' — every

generated exception subclasses this, and callers can
``except GroupDocsWatermarkException:`` as a catch-all for
this product without catching other GroupDocs errors.

The GroupDocsWatermarkException type exposes the following members:

### ImageEffectsForTextWatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/imageeffectsfortextwatermarkexception.md

#### ImageEffectsForTextWatermarkException class

The exception that is thrown when is supplied for .

The ImageEffectsForTextWatermarkException type exposes the following members:

### InvalidPasswordException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/invalidpasswordexception.md

#### InvalidPasswordException class

The exception that is thrown when supplied password is incorrect.

The InvalidPasswordException type exposes the following members:

### License class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/license.md

#### License class

Manages GroupDocs.Watermark 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`:

* Licensing and evaluation

### License constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/license/__init__.md

#### __init__

Initializes a new instance of the `License` class.

```python
def __init__(self):
    ...
```

### set_license method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/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/watermark/python-net/groupdocs.watermark/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/watermark/python-net/groupdocs.watermark/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/watermark/python-net/groupdocs.watermark/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/watermark/python-net/groupdocs.watermark/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/watermark/python-net/groupdocs.watermark/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. |

### PreviewNotSupportedException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/previewnotsupportedexception.md

#### PreviewNotSupportedException class

The exception that is thrown when a preview image cannot be generated for the content.

The PreviewNotSupportedException type exposes the following members:

### TextEffectsForImageWatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/texteffectsforimagewatermarkexception.md

#### TextEffectsForImageWatermarkException class

The exception that is thrown when is supplied for .

The TextEffectsForImageWatermarkException type exposes the following members:

### UnexpectedDocumentStructureException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unexpecteddocumentstructureexception.md

#### UnexpectedDocumentStructureException class

The exception that is thrown when a content cannot be parsed due to unexpected structure.

The UnexpectedDocumentStructureException type exposes the following members:

### UnitOfMeasurement class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unitofmeasurement.md

#### UnitOfMeasurement class

The UnitOfMeasurement type exposes the following members:

##### Fields
| Field | Description |
| :- | :- |
| PIXEL | Specifies that the unit of measurement is pixel. |
| POINT | Specifies that the unit of measurement is point. |

### PIXEL field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unitofmeasurement/pixel.md

#### PIXEL field

Specifies that the unit of measurement is pixel.

##### Value
`0`

### POINT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unitofmeasurement/point.md

#### POINT field

Specifies that the unit of measurement is point.

##### Value
`1`

### UnknownLoadOptionsTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unknownloadoptionstypeexception.md

#### UnknownLoadOptionsTypeException class

The exception that is thrown when a document cannot be loaded with supplied .

The UnknownLoadOptionsTypeException type exposes the following members:

### UnknownWatermarkOptionsTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unknownwatermarkoptionstypeexception.md

#### UnknownWatermarkOptionsTypeException class

The exception that is thrown when a watermark cannot be added with supplied .

The UnknownWatermarkOptionsTypeException type exposes the following members:

### UnsupportedFileTypeException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/unsupportedfiletypeexception.md

#### UnsupportedFileTypeException class

The exception that is thrown when a file cannot be loaded.

The UnsupportedFileTypeException type exposes the following members:

### Watermark class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark.md

#### Watermark class

Represents a watermark to be added to a document.

Learn more

- More details about watermark properties: Adding text watermarks (https://docs.groupdocs.com/display/watermarknet/Adding+text+watermarks)
- More advanced watermarking topics: Adding watermarks (https://docs.groupdocs.com/display/watermarknet/Adding+watermarks)

The Watermark type exposes the following members:

##### Properties
| Property | Description |
| :- | :- |
| consider_parent_margins | The consider_parent_margins property indicates whether the watermark size and coordinates are calculated considering parent margins. If set to True, margins are taken into account; otherwise (default False) they are ignored. |
| height | The desired height of this `Watermark`. |
| horizontal_alignment | The horizontal alignment of this Watermark. |
| is_background | The watermark is placed in the background when True; otherwise it is placed in the foreground (top). The default is False. |
| margins | The margin settings of this Watermark. |
| opacity | The opacity of this Watermark. |
| pages_setup | The pages setup settings of this Watermark. |
| rotate_angle | The rotate angle of this Watermark in degrees. |
| save_result_in_metadata | The flag indicating whether information about added watermarks is saved in the document metadata. |
| scale_factor | The scale factor of this Watermark, defining how the watermark size depends on the parent size. |
| sizing_type | The sizing type specifying how the watermark should be sized. |
| tile_options | The options to define a repeated watermark. |
| vertical_alignment | The vertical alignment of this Watermark. |
| width | The desired width of this `Watermark`. |
| x | The x-coordinate of this Watermark. |
| y | The y-coordinate of this Watermark. |

##### Guides
Task guides that use `Watermark`:

* Locking watermark in word processing document
* Adding repeated watermarks

### consider_parent_margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/consider_parent_margins.md

#### consider_parent_margins property

The consider_parent_margins property indicates whether the watermark size and coordinates are calculated considering parent margins. If set to True, margins are taken into account; otherwise (default False) they are ignored.

##### Definition:
```python
@property
def consider_parent_margins(self):
    ...
@consider_parent_margins.setter
def consider_parent_margins(self, value):
    ...
```

### height property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/height.md

#### height property

The desired height of this `Watermark`.

Setting this property also changes the `Watermark.sizing_type` property to `SizingType.absolute`.

##### Definition:
```python
@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...
```

### horizontal_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/horizontal_alignment.md

#### horizontal_alignment property

The horizontal alignment of this Watermark.

Default value is `HorizontalAlignment.none`.

##### Definition:
```python
@property
def horizontal_alignment(self):
    ...
@horizontal_alignment.setter
def horizontal_alignment(self, value):
    ...
```

### is_background property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/is_background.md

#### is_background property

The watermark is placed in the background when True; otherwise it is placed in the foreground (top). The default is False.

##### Definition:
```python
@property
def is_background(self):
    ...
@is_background.setter
def is_background(self, value):
    ...
```

### margins property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/margins.md

#### margins property

The margin settings of this Watermark.

##### Definition:
```python
@property
def margins(self):
    ...
@margins.setter
def margins(self, value):
    ...
```

### opacity property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/opacity.md

#### opacity property

The opacity of this Watermark.

The value of opacity should be between 0 and 1. The default value is 1.

##### Definition:
```python
@property
def opacity(self):
    ...
@opacity.setter
def opacity(self, value):
    ...
```

### pages_setup property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/pages_setup.md

#### pages_setup property

The pages setup settings of this Watermark.

##### Definition:
```python
@property
def pages_setup(self):
    ...
@pages_setup.setter
def pages_setup(self, value):
    ...
```

### rotate_angle property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/rotate_angle.md

#### rotate_angle property

The rotate angle of this Watermark in degrees.

##### Definition:
```python
@property
def rotate_angle(self):
    ...
@rotate_angle.setter
def rotate_angle(self, value):
    ...
```

### save_result_in_metadata property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/save_result_in_metadata.md

#### save_result_in_metadata property

The flag indicating whether information about added watermarks is saved in the document metadata.

##### Definition:
```python
@property
def save_result_in_metadata(self):
    ...
@save_result_in_metadata.setter
def save_result_in_metadata(self, value):
    ...
```

### scale_factor property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/scale_factor.md

#### scale_factor property

The scale factor of this Watermark, defining how the watermark size depends on the parent size.

The value must be between 0 and 1.

##### Definition:
```python
@property
def scale_factor(self):
    ...
@scale_factor.setter
def scale_factor(self, value):
    ...
```

### sizing_type property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/sizing_type.md

#### sizing_type property

The sizing type specifying how the watermark should be sized.

##### Definition:
```python
@property
def sizing_type(self):
    ...
@sizing_type.setter
def sizing_type(self, value):
    ...
```

### tile_options property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/tile_options.md

#### tile_options property

The options to define a repeated watermark.

##### Definition:
```python
@property
def tile_options(self):
    ...
@tile_options.setter
def tile_options(self, value):
    ...
```

### vertical_alignment property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/vertical_alignment.md

#### vertical_alignment property

The vertical alignment of this Watermark.

Default value is `VerticalAlignment.none`.

##### Definition:
```python
@property
def vertical_alignment(self):
    ...
@vertical_alignment.setter
def vertical_alignment(self, value):
    ...
```

### width property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/width.md

#### width property

The desired width of this `Watermark`.

Setting this property will also change the value of `Watermark.sizing_type` property to `SizingType.absolute`.

##### Definition:
```python
@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...
```

### x property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/x.md

#### x property

The x-coordinate of this Watermark.

##### Definition:
```python
@property
def x(self):
    ...
@x.setter
def x(self, value):
    ...
```

### y property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermark/y.md

#### y property

The y-coordinate of this Watermark.

##### Definition:
```python
@property
def y(self):
    ...
@y.setter
def y(self, value):
    ...
```

### Watermarker class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker.md

#### Watermarker class

Represents a class for watermark management in a document.

Load and save the content of any supported format.

The Watermarker type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of Watermarker with the specified document path. |
| __init__ | Initializes a new Watermarker with the specified document path and load options. |
| __init__ | Initializes a new Watermarker instance with the specified document path and optional settings. |
| __init__ | Initializes a new Watermarker instance with the specified document path, load options, and settings. |
| __init__ | Initializes a new Watermarker instance with the specified stream. |
| __init__ | Initializes a new instance of the `Watermarker` class with the specified stream and load options. |
| __init__ | Initializes a new Watermarker instance with the given document stream and optional settings. |
| __init__ | Initializes a new Watermarker instance with the given document stream, load options, and settings. |

##### Methods
| Method | Description |
| :- | :- |
| add | Adds a watermark to the loaded document. |
| add | Adds a watermark to the loaded document using watermark options. |
| add_watermark |  |
| dispose | Disposes the current instance. |
| generate_preview | Generates preview images for the document. |
| generate_preview_preview_options |  |
| get_content |  |
| get_document_info | Gets information about the format of the loaded document. |
| get_images | Finds images according to specified search criteria. |
| get_images | Finds all images in the document. |
| get_images_image_search_criteria |  |
| remove | Removes a watermark from the document. |
| remove | Removes all watermarks in the collection from the document. |
| remove_possible_watermark |  |
| remove_possible_watermark_collection |  |
| save | Saves the document data to the underlying stream. |
| save | Saves the document to the specified file location. |
| save | Saves the document to the specified stream. |
| save | Saves the document data to the underlying stream using save options. |
| save | Saves the document to the specified file location using save options. |
| save | Saves the document to the specified stream using save options. |
| save_file |  |
| save_save_options |  |
| save_stream |  |
| save_streams |  |
| save_string |  |
| search | Searches all possible watermarks in the document. |
| search | Searches possible watermarks according to specified search criteria. |
| search_search_criteria |  |

##### Properties
| Property | Description |
| :- | :- |
| searchable_objects | The objects that are to be included in a watermark search. |

##### Example

```python
import groupdocs.watermark as gw

with gw.Watermarker("D:\\input.pdf") as watermarker:
    # Use methods of Watermarker to add, search, or remove watermarks.
    watermarker.save("D:\\output.pdf")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/__init__.md

#### __init__

Initializes a new instance of Watermarker with the specified document path.

Learn more about loading documents: https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load the document from. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw

with gw.Watermarker("input.pdf") as watermarker:
    # Use methods of Watermarker to add, search, or remove watermarks.
    watermarker.save("output.pdf")
```

#### __init__

Initializes a new Watermarker with the specified document path and load options.

Learn more about loading documents: https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, file_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load document from. |
| options | `LoadOptions` | Additional options to use when loading a document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PdfLoadOptions()
load_options.password = "123"
with gw.Watermarker(r"C:\Documents\test.pdf", load_options) as watermarker:
    # ...
    pass
```

#### __init__

Initializes a new Watermarker instance with the specified document path and optional settings.

Learn more about loading documents: https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, file_path, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load document from. |
| settings | `WatermarkerSettings` | Additional settings to use when working with loaded document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw

# Load a PDF document
with gw.Watermarker("document.pdf") as watermarker:
    # Perform operations, e.g., search for watermarks
    pass
```

#### __init__

Initializes a new Watermarker instance with the specified document path, load options, and settings.

Learn more about loading documents: https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, file_path, options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to load document from. |
| options | `LoadOptions` | Additional options to use when loading a document. |
| settings | `WatermarkerSettings` | Additional settings to use when working with loaded document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PdfLoadOptions()
settings = gw.WatermarkerSettings()
with gw.Watermarker("document.pdf", load_options, settings) as watermarker:
    # perform operations, e.g., search, modify, or save the document
    pass
```

#### __init__

Initializes a new Watermarker instance with the specified stream.

Learn more about loading documents.

```python
def __init__(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to load document from. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

#### __init__

Initializes a new instance of the `Watermarker` class with the specified stream and load options.

Learn more about loading documents at https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, document, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to load the document from (`io.RawIOBase`). |
| options | `LoadOptions` | Additional options to use when loading a document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw

load_options = gw.PdfLoadOptions()
load_options.password = "123"

with open(r"C:\Documents\test.pdf", "rb") as stream:
    with gw.Watermarker(stream, load_options) as watermarker:
        # Perform operations with the watermarker
        pass
```

#### __init__

Initializes a new Watermarker instance with the given document stream and optional settings.

Learn more about loading documents: https://docs.groupdocs.com/display/watermarknet/Loading+documents.

```python
def __init__(self, document, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to load the document from. |
| settings | `WatermarkerSettings` | Additional settings to use when working with the loaded document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw
from groupdocs.watermark import WatermarkerSettings, SearchableObjects
from groupdocs.watermark.contents import (
    WordProcessingSearchableObjects,
    SpreadsheetSearchableObjects,
    PresentationSearchableObjects,
    DiagramSearchableObjects,
    PdfSearchableObjects,
)

# Configure searchable objects globally
settings = WatermarkerSettings()
settings.searchable_objects = SearchableObjects(
    word_processing_searchable_objects=WordProcessingSearchableObjects.HYPERLINKS
    | WordProcessingSearchableObjects.TEXT,
    spreadsheet_searchable_objects=SpreadsheetSearchableObjects.HEADERS_FOOTERS,
    presentation_searchable_objects=PresentationSearchableObjects.SLIDES_BACKGROUNDS
    | PresentationSearchableObjects.SHAPES,
    diagram_searchable_objects=DiagramSearchableObjects.NONE,
    pdf_searchable_objects=PdfSearchableObjects.ALL,
)

# Load a document from a file stream
with open("example.pdf", "rb") as stream:
    with gw.Watermarker(stream, settings) as watermarker:
        # Work with the watermarker instance here
        pass
```

#### __init__

Initializes a new Watermarker instance with the given document stream, load options, and settings.

Learn more about loading documents.

```python
def __init__(self, document, options, settings):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to load document from. |
| options | `LoadOptions` | Additional options to use when loading a document. |
| settings | `WatermarkerSettings` | Additional settings to use when working with loaded document. |

| Raises | Description |
| :- | :- |
| `UnsupportedFileTypeException` | Supplied document type is not supported. |
| `InvalidPasswordException` | Supplied password is incorrect. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    print(pdf_content.pages[0].width)
    print(pdf_content.pages[0].height)
```

### add method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/add.md

#### add

Adds a watermark to the loaded document.

Learn more about adding watermarks: https://docs.groupdocs.com/display/watermarknet/Adding+watermarks.

```python
def add(self, watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | `Watermark` | The watermark to add to the document. |

##### Example

```python
import io
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with open("watermark.jpg", "rb") as f:
    data = f.read()

with gw.Watermarker("image.png") as watermarker:
    with gww.ImageWatermark(io.BytesIO(data)) as watermark:
        watermarker.add(watermark)
    watermarker.save("image.png")
```

#### add

Adds a watermark to the loaded document using watermark options.

Learn more about adding watermarks.

```python
def add(self, watermark, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| watermark | `Watermark` | The watermark to add to the document. |
| options | `WatermarkOptions` | Additional options to use when adding the watermark. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.pdf as gwo_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    with gww.ImageWatermark("watermark.png") as watermark:
        options = gwo_pdf.PdfXObjectWatermarkOptions()
        options.page_index = 0
        watermarker.add(watermark, options)
    watermarker.save("document.pdf")
```

### add_watermark method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/add_watermark.md

#### add_watermark

```python
def add_watermark(self):
    ...
```

### dispose method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/dispose.md

#### dispose

Disposes the current instance.

```python
def dispose(self):
    ...
```

### generate_preview method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/generate_preview.md

#### generate_preview

Generates preview images for the document.

```python
def generate_preview(self, preview_options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| preview_options | `PreviewOptions` | Additional options to use when generating preview images. |

##### Example

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo

output_directory = os.path.join(os.getcwd(), "preview")
os.makedirs(output_directory, exist_ok=True)

def create_page_stream(number: int):
    path = os.path.join(output_directory, f"page{number}.png")
    return open(path, "wb")

def release_page_stream(number: int, stream):
    stream.close()

with gw.Watermarker("sample.pdf") as watermarker:
    preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
    preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
    preview_options.page_numbers = [1, 2]
    watermarker.generate_preview(preview_options)
```

### generate_preview_preview_options method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/generate_preview_preview_options.md

#### generate_preview_preview_options

```python
def generate_preview_preview_options(self):
    ...
```

### get_content method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/get_content.md

#### get_content

```python
def get_content(self):
    ...
```

### get_document_info method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/get_document_info.md

#### get_document_info

Gets information about the format of the loaded document.

Learn more about getting the document information.

```python
def get_document_info(self):
    ...
```

**Returns:** IDocumentInfo: An instance that contains detected information.

##### Example

```python
import groupdocs.watermark as gw

with gw.Watermarker("source.docx") as watermarker:
    info = watermarker.get_document_info()
    print("File type:", info.file_type)
    print("Number of pages:", info.page_count)
    print("Document size:", info.size)
```

### get_images method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/get_images.md

#### get_images

Finds images according to specified search criteria.

The search is conducted in objects specified in `Watermarker.searchable_objects`.

Learn more about searching watermarks.

```python
def get_images(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | `ImageSearchCriteria` | The search criteria to use. |

**Returns:** GroupDocs.Watermark.WatermarkableImageCollection: The collection of found images.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

with gw.Watermarker("input.doc") as watermarker:
    criteria = gws.ImageThumbnailSearchCriteria("reference.png")
    images = watermarker.get_images(criteria)
    images.clear()
    watermarker.save("output.doc")
```

#### get_images

Finds all images in the document.

The search is conducted in objects specified in `Watermarker.searchable_objects`.

Learn more about searching watermarks: https://docs.groupdocs.com/display/watermarknet/Searching+watermarks.

```python
def get_images(self):
    ...
```

**Returns:** The collection of found images.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermarker.searchable_objects.pdf_searchable_objects = gwc.PdfSearchableObjects.ATTACHED_IMAGES
    images = watermarker.get_images()
    print("Found", images.count, "image(s).")
```

### get_images_image_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/get_images_image_search_criteria.md

#### get_images_image_search_criteria

```python
def get_images_image_search_criteria(self):
    ...
```

### remove method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/remove.md

#### remove

Removes a watermark from the document.

Learn more about removing watermarks: Removing found watermarks.

```python
def remove(self, possible_watermark):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| possible_watermark | `PossibleWatermark` | The watermark to remove. |

**Returns:** None.

##### Example

```python
import groupdocs.watermark as gw

with gw.Watermarker("document.pdf") as watermarker:
    possible = watermarker.search()
    if possible.count > 0:
        watermarker.remove(possible[0])
    watermarker.save("document.pdf")
```

#### remove

Removes all watermarks in the collection from the document.

Learn more about removing watermarks at the GroupDocs documentation: https://docs.groupdocs.com/display/watermarknet/Removing+found+watermarks.

```python
def remove(self, possible_watermarks):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| possible_watermarks | `PossibleWatermarkCollection` | The collection of watermarks to remove. |

**Returns:** None.

##### Example

```python
import groupdocs.watermark as gw

with gw.Watermarker("input.doc") as watermarker:
    # Find watermarks matching specific criteria
    watermarks = watermarker.search()
    # Remove all found watermarks from the document
    watermarker.remove(watermarks)
    watermarker.save("output.doc")
```

### remove_possible_watermark method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/remove_possible_watermark.md

#### remove_possible_watermark

```python
def remove_possible_watermark(self):
    ...
```

### remove_possible_watermark_collection method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/remove_possible_watermark_collection.md

#### remove_possible_watermark_collection

```python
def remove_possible_watermark_collection(self):
    ...
```

### save method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save.md

#### save

Saves the document data to the underlying stream.

Learn more about saving the documents.

```python
def save(self):
    ...
```

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextSearchCriteria("test", False)
    possible = watermarker.search(criteria)
    for wm in possible:
        try:
            wm.text = "passed"
        except Exception:
            pass
    watermarker.save("document.pdf")
```

#### save

Saves the document to the specified file location.

Learn more about saving the documents at https://docs.groupdocs.com/display/watermarknet/Saving+documents.

```python
def save(self, file_path):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to save the document data to. |

##### Example

```python
    import groupdocs.watermark as gw

    with gw.Watermarker("input.pdf") as watermarker:
        watermark = gw.TextWatermark("top secret", gw.Font("Arial", 36))
        watermarker.add(watermark)
        watermarker.save("output.pdf")
    ```

#### save

Saves the document to the specified stream.

Learn more about saving the documents at https://docs.groupdocs.com/display/watermarknet/Saving+documents.

```python
def save(self, document):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to save the document data to. |

#### save

Saves the document data to the underlying stream using save options.

Learn more about saving the documents.

```python
def save(self, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| options | `SaveOptions` | Additional options to use when saving a document. |

##### Example

```python
import groupdocs.watermark as gw
from groupdocs.watermark import TextWatermark, Font

with gw.Watermarker("input.pdf") as watermarker:
    watermark = TextWatermark("top secret", Font("Arial", 36))
    watermarker.add(watermark)
    # Save the document with default options
    watermarker.save("output.pdf")
```

#### save

Saves the document to the specified file location using save options.

Learn more about saving the documents.

```python
def save(self, file_path, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| file_path | `str` | The file path to save the document data to. |
| options | `SaveOptions` | Additional options to use when saving a document. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextSearchCriteria("test", False)
    for wm in watermarker.search(criteria):
        try:
            wm.text = "passed"
        except Exception:
            pass
    watermarker.save("document.pdf")
```

#### save

Saves the document to the specified stream using save options.

Learn more about saving the documents at the GroupDocs documentation.

```python
def save(self, document, options):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| document | `io.RawIOBase` | The stream to save the document data to. |
| options | `SaveOptions` | Additional options to use when saving a document. |

##### Example

```python
import groupdocs.watermark as gw
from io import BytesIO
from groupdocs.watermark.options import SaveOptions

with gw.Watermarker("input.pdf") as watermarker:
    watermark = gw.TextWatermark("top secret", gw.Font("Arial", 36))
    watermarker.add(watermark)
    stream = BytesIO()
    watermarker.save(stream, SaveOptions())
    # stream now contains the saved document
```

### save_file method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save_file.md

#### save_file

```python
def save_file(self):
    ...
```

### save_save_options method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save_save_options.md

#### save_save_options

```python
def save_save_options(self):
    ...
```

### save_stream method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save_stream.md

#### save_stream

```python
def save_stream(self):
    ...
```

### save_streams method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save_streams.md

#### save_streams

```python
def save_streams(self):
    ...
```

### save_string method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/save_string.md

#### save_string

```python
def save_string(self):
    ...
```

### search method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/search.md

#### search

Searches all possible watermarks in the document.

The search is conducted in objects specified in `Watermarker.searchable_objects`.

Learn more about searching watermarks: https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

```python
def search(self):
    ...
```

**Returns:** PossibleWatermarkCollection: The collection of possible watermarks.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

#### search

Searches possible watermarks according to specified search criteria.

The search is conducted in objects specified in `Watermarker.searchable_objects`.

Learn more about searching watermarks: https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

```python
def search(self, search_criteria):
    ...
```

| Parameter | Type | Description |
| :- | :- | :- |
| search_criteria | `SearchCriteria` | The search criteria to use. |

**Returns:** The collection of possible watermarks.

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

### search_search_criteria method
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/search_search_criteria.md

#### search_search_criteria

```python
def search_search_criteria(self):
    ...
```

### searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarker/searchable_objects.md

#### searchable_objects property

The objects that are to be included in a watermark search.

This property also specifies content objects which are used in image search. For more information see `Watermarker.search` and `Watermarker.get_images` methods.

Learn more about searching watermarks: https://docs.groupdocs.com/display/watermarknet/Searching+watermarks

##### Definition:
```python
@property
def searchable_objects(self):
    ...
@searchable_objects.setter
def searchable_objects(self, value):
    ...
```

### WatermarkerSettings class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkersettings.md

#### WatermarkerSettings class

Defines settings for customizing Watermarker behaviour.

The WatermarkerSettings type exposes the following members:

##### Constructors
| Constructor | Description |
| :- | :- |
| __init__ | Initializes a new instance of `WatermarkerSettings`. |

##### Properties
| Property | Description |
| :- | :- |
| logger | The logger used for logging events and errors during watermarking. Must be an instance implementing `ILogger`. |
| searchable_objects | The `SearchableObjects` that are to be included in a watermark search. |

##### Fields
| Field | Description |
| :- | :- |
| DEFAULT | Gets the default value for the class. |

##### Example

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

settings = gw.WatermarkerSettings()
settings.searchable_objects = gws.SearchableObjects(
    word_processing_searchable_objects=gws.WordProcessingSearchableObjects.HYPERLINKS | gws.WordProcessingSearchableObjects.TEXT,
    spreadsheet_searchable_objects=gws.SpreadsheetSearchableObjects.HEADERS_FOOTERS,
    presentation_searchable_objects=gws.PresentationSearchableObjects.SLIDES_BACKGROUNDS | gws.PresentationSearchableObjects.SHAPES,
    diagram_searchable_objects=gws.DiagramSearchableObjects.NONE,
    pdf_searchable_objects=gws.PdfSearchableObjects.ALL,
)

with gw.Watermarker("document.docx", settings) as watermarker:
    possible = watermarker.search()
    print(f"Found {possible.count} possible watermark(s).")
```

### __init__ constructor
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkersettings/__init__.md

#### __init__

Initializes a new instance of `WatermarkerSettings`.

```python
def __init__(self):
    ...
```

### DEFAULT field
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkersettings/default.md

#### DEFAULT field

Gets the default value for the class.

### logger property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkersettings/logger.md

#### logger property

The logger used for logging events and errors during watermarking. Must be an instance implementing `ILogger`.

##### Definition:
```python
@property
def logger(self):
    ...
@logger.setter
def logger(self, value):
    ...
```

### searchable_objects property
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkersettings/searchable_objects.md

#### searchable_objects property

The `SearchableObjects` that are to be included in a watermark search.

##### Definition:
```python
@property
def searchable_objects(self):
    ...
@searchable_objects.setter
def searchable_objects(self, value):
    ...
```

### WatermarkException class
Path: https://reference.groupdocs.com/watermark/python-net/groupdocs.watermark/watermarkexception.md

#### WatermarkException class

Represents base exception in GroupDocs.Watermark product.

The WatermarkException type exposes the following members:

### Developer Guide
Path: https://reference.groupdocs.com/watermark/python-net/guides.md

#### Developer Guide

Task-oriented guides with runnable Python examples.

| Guide | |
| :- | :- |
| Add text watermarks | |
| Adding text watermarks | |
| Adding watermark to images inside a document | |
| Attachments in PDF document | |
| Email attachments | |
| Existing objects in diagrams | |
| Existing objects in word processing document | |
| GroupDocs.Watermark for Python overview | |
| Install GroupDocs.Watermark for Python via .NET | |
| Searching watermarks | |
| Shapes in spreadsheet document | |
| Working with slide backgrounds | |
| Add image watermarks | |
| Adding image watermarks | |
| Email messages | |
| Existing objects in PDF document | |
| Hello, World! | |
| Locking watermark in word processing document | |
| Modifying found watermark properties | |
| Working with spreadsheet document attachments | |
| Adding repeated watermarks | |
| Features overview | |
| Protecting word processing documents | |
| Rasterize document or page | |
| Removing found watermarks | |
| Result of added watermarks | |
| Working with worksheet backgrounds | |
| Customize watermarks | |
| Supported file formats | |
| Watermarks in PDF document | |
| Watermarks in word processing document | |
| Working with worksheet headers and footers | |
| Licensing and evaluation | |
| Update watermarks | |
| Clear watermarks | |
| System requirements | |
| Document preview | |
| How to run examples | |
| Technical Support | |
| Get document info | |
| Get supported file formats | |

### Add image watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/add-image.md

One of the main features of the GroupDocs.Watermark library is adding image watermarks to documents. You may add watermarks to documents or images from local disks, as well as from streams. For a full list of supported document formats, check [Supported formats]().

To add an image watermark perform the following sample:

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwс

def run():
  with gw.Watermarker("sample.xlsx") as watermarker:
      watermark = gww.ImageWatermark("logo.png")
      watermark.horizontal_alignment = gwс.HorizontalAlignment.CENTER
      watermark.vertical_alignment = gwс.VerticalAlignment.CENTER

      watermarker.add(watermark)
      watermarker.save(join(output_directory, "result.xlsx"))
```

##### What's next

GroupDocs.Watermark offers many more capabilities for adding image watermarks. It's possible  from streams, use absolute or relative positioning, and so on.

### Add text watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/add-text.md

One of the main features of the GroupDocs.Watermark library is adding text watermarks to documents. You may add watermarks to documents or images from local disks, as well as from streams. For a full list of supported document formats, check [Supported formats]().

To add a text watermark perform follow next code sample:

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwс

def run():
  with gw.Watermarker("sample.docx") as watermarker:
      font = gww.Font("Arial", 36.0)
      watermark = gww.TextWatermark("top secret", font)
      watermark.foreground_color = gww.Color.red;
      watermark.horizontal_alignment = gwс.HorizontalAlignment.CENTER
      watermark.vertical_alignment = gwс.VerticalAlignment.CENTER

      watermarker.add(watermark)
      watermarker.save(join(output_directory, "result.docx"))
```

Run the program. A new watermarked document will appear in the specified path.

##### What's next

GroupDocs.Watermark offers many more capabilities for adding text watermarks. For example, it allows specifying background and foreground colors, formatting, text opacity, use of absolute or relative positioning, and so on.

### Adding image watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/adding-image-watermarks.md

GroupDocs.Watermark supports adding the following image formats as watermarks:

- BMP
- PNG
- GIF
- JPEG

#### Add image watermark from local file

The following example shows how to add an `ImageWatermark` to a document. If the document consists of multiple parts (pages, worksheets, slides, frames, etc.), the watermark will be added to each of them.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("presentation.pptx") as watermarker:
    with gww.ImageWatermark("watermark.jpg") as watermark:
        watermarker.add(watermark)
        watermarker.save("presentation.pptx")
```

#### Add image watermark from stream

You can also use a stream of the image to initialize an `ImageWatermark` instance.

```python
import io
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with open("watermark.jpg", "rb") as f:
    data = f.read()

with gw.Watermarker("image.png") as watermarker:
    with gww.ImageWatermark(io.BytesIO(data)) as watermark:
        watermarker.add(watermark)
        watermarker.save("image.png")
```

For advanced usage of watermark properties (tiling, alignment, sizing, rotation, margins), see the text watermark article; the same techniques apply to image watermarks as well:

- [Adding Text Watermarks]()

### Adding repeated watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/adding-repeated-watermarks.md

#### Repeated watermark

Repeated (tiled) watermarks let you cover entire pages with a pattern of text or images. You can control spacing, rotation, offsets, and choose different tiling templates.

##### Text repeated watermark

Apply a text watermark across the whole page in a repeated pattern.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample.pdf") as watermarker:
    font = gww.Font("Arial", 19.0, gww.FontStyle.BOLD | gww.FontStyle.ITALIC)
    watermark = gww.TextWatermark("Watermark", font)
    watermark.foreground_color = gww.Color.red

    watermark.tile_options = gww.TileOptions()
    watermark.tile_options.line_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 12)
    watermark.tile_options.watermark_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 10)

    watermark.opacity = 0.2
    watermark.rotate_angle = -30

    watermarker.add(watermark)
    watermarker.save("result.pdf")
```

Rotate around the page origin instead of the center:

```python
watermark.tile_options.rotate_around_origin = True
```

Use offset/basket-weave and other templates:

```python
watermark.tile_options.tile_type = gww.TileType.OFFSET
# or
watermark.tile_options.tile_type = gww.TileType.BASKET_WEAVE
```

##### Image repeated watermark

Apply a repeated image (such as a logo or seal) to cover the page.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample.pdf") as watermarker:
    watermark = gww.ImageWatermark("watermark.jpg")

    watermark.tile_options = gww.TileOptions()
    watermark.tile_options.line_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 12)
    watermark.tile_options.watermark_spacing = gww.MeasureValue(gww.TileMeasureType.PERCENT, 10)

    watermark.opacity = 0.3
    watermark.rotate_angle = -30

    watermarker.add(watermark)
    watermarker.save("result.pdf")
```
🔹 Use case: Protect sensitive PDFs by overlaying “Confidential” text across every page, or reinforce branding by repeating a logo in the background.

### Adding text watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/adding-text-watermarks.md

Using text watermarks is an effective way to protect document content. By overlaying sensitive documents with watermarks such as "Confidential" or "Draft", you can deter unauthorized distribution and reinforce data security.

The following example shows how to add a text watermark to a document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("sample.pdf") as watermarker:
    font = gww.Font("Arial", 19.0, gww.FontStyle.BOLD | gww.FontStyle.ITALIC)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.foreground_color = gww.Color.red
    watermark.background_color = gww.Color.blue
    watermark.text_alignment = gww.TextAlignment.RIGHT
    watermark.opacity = 0.5

    watermarker.add(watermark)
    watermarker.save("output.pdf")
```

If a document consists of multiple parts (pages, worksheets, slides, frames, etc.), the watermark will be added to each of them. You can configure this behavior via the `PagesSetup` property:

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample.pdf") as watermarker:
    font = gww.Font("Arial", 19.0)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.pages_setup = gww.PagesSetup()
    watermark.pages_setup.pages = [1, 3]

    watermarker.add(watermark)
    watermarker.save("output.pdf")
```

##### Absolute watermark positioning

You can add a watermark to an absolute position by setting `x`, `y`, `width`, and `height`. Values are measured in default document units.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Times New Roman", 8.0)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.x = 10
    watermark.y = 20
    watermark.width = 100
    watermark.height = 40

    watermarker.add(watermark)
    watermarker.save("image.png")
```

Note that the origin of coordinates may be different for different document types (relative positioning doesn't have these specifics and can be used as a unified positioning approach).

Following are the origin of the coordinates for different formats of the documents.

| Document Format | Unit of Measure | Origin of Coordinates |
| --- | --- | --- |
| PDF | Point | Left bottom corner of page |
| WordProcessing | Point | Left top corner of page  |
| Spreadsheet | Point | Left top corner of worksheet  |
| Presentation | Point | Left top corner of slide  |
| Image | Pixel | Left top corner of image (frame)  |
| Diagram | Point | Left top corner of page |

##### Relative watermark positioning

Instead of exact coordinates, use parent-relative alignment and set offsets with `margins`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Calibri", 12.0)
    watermark = gww.TextWatermark("Test watermark", font)
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.BOTTOM

    watermark.margins.right = 10
    watermark.margins.bottom = 5

    watermarker.add(watermark)
    watermarker.save("image.png")
```

Excel worksheets don't have explicit borders, therefore, the most right bottom non-empty cell is used to determine working area size.

##### Using the MarginType property

Set relative margins using `MarginType`, where values are interpreted as a portion of the parent size (0.0–1.0).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Calibri", 12.0)
    watermark = gww.TextWatermark("Test watermark", font)
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.BOTTOM

    watermark.margins.margin_type = gww.MarginType.RELATIVE_TO_PARENT_DIMENSIONS
    watermark.margins.right = 0.1
    watermark.margins.bottom = 0.2

    watermarker.add(watermark)
    watermarker.save("image.png")
```

##### Size types

Scale watermark depending on the parent size using `sizing_type` and `scale_factor`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("image.png") as watermarker:
    font = gww.Font("Calibri", 12.0)
    watermark = gww.TextWatermark("This is a test watermark", font)

    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 0.5

    watermarker.add(watermark)
    watermarker.save("image.png")
```

Using of relative size and positioning is the simplest way to add watermark to a document of any type.

##### Watermark rotation

Rotate watermark by setting `rotate_angle` in degrees. Positive values mean clockwise.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("test.docx") as watermarker:
    font = gww.Font("Calibri", 8.0)
    watermark = gww.TextWatermark("Test watermark", font)
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 0.5
    watermark.rotate_angle = 45

    watermarker.add(watermark)
    watermarker.save("test.docx")
```

If rotation angle is set, it is assumed that watermark size is equal to axis-aligned bounding box size. The following picture illustrates what is the watermark bounding box and how it is used for sizing and positioning. The picture shows a result of execution of the above code snippet. The actual watermark bounds are colored in blue and the bounding box is colored in red. As you can see, the bounding box size is used to calculate watermark relative size.

![adding-text-watermarks](https://docs.groupdocs.com/watermark/python-net/images/adding-text-watermarks.png)

##### Using custom fonts

You can use custom TrueType fonts by specifying a folder path in the `Font` constructor.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

fonts_folder = r"c:\\CustomFonts\\"
with gw.Watermarker("test.pdf") as watermarker:
    font = gww.Font("CustomFontName", fonts_folder, 36.0)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.foreground_color = gww.Color.blue
    watermark.opacity = 0.5
    watermark.x = 10
    watermark.y = 10

    watermarker.add(watermark)
    watermarker.save("result.pdf")
```

##### Considering parent margins

By default, page margins are ignored and the maximum available space is used. To align with page margins, set `consider_parent_margins` to `True`.

![adding-text-watermarks_1](https://docs.groupdocs.com/watermark/python-net/images/adding-text-watermarks_1.png)

As you can see, the watermark goes beyond page margins. To change this behavior, set [ConsiderParentMargins](https://reference.groupdocs.com/net/watermark/groupdocs.watermark/watermark/properties/considerparentmargins) property to true (as shown in below example).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("input.vsdx") as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 42.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0
    watermark.rotate_angle = 45
    watermark.foreground_color = gww.Color.red
    watermark.background_color = gww.Color.aqua
    watermark.consider_parent_margins = True

    watermarker.add(watermark)
    watermarker.save("input.vsdx")
```

Now, the watermark is aligned with respect to page margins.

![adding-text-watermarks_2](https://docs.groupdocs.com/watermark/python-net/images/adding-text-watermarks_2.png)

#### Watermark in documents of different types

Watermarks are represented by different objects in different formats. Some properties may not be supported for specific formats (for example, background color for WordArt in Word documents). See [Features Overview]() for details.

### Adding watermark to images inside a document
Path: https://reference.groupdocs.com/watermark/python-net/guides/adding-watermark-to-images-inside-a-document.md

Many document formats allow embedding images. To add watermarks to images inside a document, follow these steps:

1. Load the document
2. Create and initialize watermark object
3. Set watermark properties
4. Find images in the document
5. Add watermark to all found images
6. Save the document

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("document.pdf") as watermarker:
    text_watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    text_watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    text_watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    text_watermark.rotate_angle = 45
    text_watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    text_watermark.scale_factor = 1.0

    with gww.ImageWatermark("protect.jpg") as image_watermark:
        image_watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
        image_watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
        image_watermark.rotate_angle = -45
        image_watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
        image_watermark.scale_factor = 1.0

        images = watermarker.get_images()
        for i in range(images.count):
            if images[i].width > 100 and images[i].height > 100:
                if i % 2 == 0:
                    images[i].add(text_watermark)
                else:
                    images[i].add(image_watermark)

    watermarker.save("document.pdf")
```

### Attachments in PDF document
Path: https://reference.groupdocs.com/watermark/python-net/guides/attachments-in-pdf-document.md

#### Extract all attachments from PDF document
This sample extracts every embedded file from a PDF, prints basic metadata (name, description, file type), and writes the attachment bytes to an output folder.

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

output_dir = os.path.join("SampleFiles", "Output")
os.makedirs(output_dir, exist_ok=True)

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for attachment in pdf_content.attachments:
        print("Name:", attachment.name)
        print("Description:", attachment.description)
        print("File type:", attachment.get_document_info().file_type)

        with open(os.path.join(output_dir, attachment.name), "wb") as f:
            f.write(attachment.content)
```

#### Add an attachment to PDF document
This sample embeds an external file into the PDF as an attachment, assigning a display name and description, and then saves the updated document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    with open("sample.docx", "rb") as f:
        pdf_content.attachments.add(f.read(), "sample doc", "sample doc as attachment")

    watermarker.save("document.pdf")
```

#### Remove attachment from PDF document
This sample finds and removes attachments that match custom criteria (for example, a name containing "sample" and the DOCX file type), and then saves the PDF.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
from groupdocs.watermark.common import FileType

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for i in range(pdf_content.attachments.count - 1, -1, -1):
        attachment = pdf_content.attachments[i]
        if ("sample" in attachment.name) and (attachment.get_document_info().file_type == FileType.DOCX):
            pdf_content.attachments.remove_at(i)

    watermarker.save("document.pdf")
```

#### Search for images attachments
This sample limits the search scope to images inside attachments and returns the found image collection for further processing or inspection.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermarker.searchable_objects.pdf_searchable_objects = gwc.PdfSearchableObjects.ATTACHED_IMAGES
    images = watermarker.get_images()
    print("Found", images.count, "image(s).")
```

### Clear watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/clear.md

Removing existing watermarks is supported for many formats. Check supported formats to confirm availability.

#### Deleting text watermarks

Search for and remove specific text watermarks from documents. You can target them by their text value and clear them in a single step.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("C:\\Docs\\watermarked-sample.docx") as watermarker:
    criteria = gws_sc.TextSearchCriteria("Contract Draft", False)
    possible = watermarker.search(criteria)
    possible.clear()
    watermarker.save("C:\\Docs\\clean-sample.docx")
```
🔹 Use case: Remove outdated labels such as “Draft” or “Internal Use Only” before sharing the document externally.

#### Deleting image watermarks

Easily find and delete image watermarks (such as logos, stamps, or backgrounds) using perceptual image matching.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("watermarked-sample.docx") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    image_criteria.max_difference = 0.9
    possible = watermarker.search(image_criteria)
    possible.clear()
    watermarker.save("clean-sample.docx")
```

🔹 Use case: Clean up old branding or remove unauthorized third-party logos from documents.

### Customize watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/customize.md

GroupDocs.Watermark lets you control how a watermark looks and where it appears.

#### Customizing text watermarks

GroupDocs.Watermark lets you fully control the look and position of text watermarks. Adjust color, font, alignment, rotation, opacity, and scaling to match your document’s style.

Use `TextWatermark` properties like `foreground_color`, `opacity`, `rotate_angle`, `sizing_type`, `scale_factor`, `horizontal_alignment`, `vertical_alignment`, `x`, `y`, `width`, `height`, and `consider_parent_margins`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("C:\\Docs\\sample.docx") as watermarker:
    watermark = gww.TextWatermark("Customized watermark.", gww.Font("Arial", 24.0, gww.FontStyle.BOLD))
    watermark.foreground_color = gww.Color.dark_orange
    watermark.consider_parent_margins = True
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.rotate_angle = 45
    watermark.scale_factor = 0.7
    watermarker.add(watermark)
    watermarker.save("C:\\Docs\\watermarked-sample.docx")
```
🔹 Use case: Apply branded or legal disclaimers in a consistent style across pages (e.g., “Confidential – Do Not Distribute”).

#### Customizing image watermarks

You can also personalize image watermarks by adjusting their alignment, rotation, opacity, and layering. This allows you to place logos, stamps, or seals exactly where needed.

Use `ImageWatermark` with similar properties for position, rotation, background/foreground layering, and opacity.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

with gw.Watermarker("C:\\Docs\\seagull.jpg") as watermarker:
    watermark = gww.ImageWatermark("C:\\Docs\\greetings-stamp.png")
    watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermark.rotate_angle = 15
    watermark.is_background = False
    watermark.opacity = 0.8
    watermarker.add(watermark)
    watermarker.save("C:\\Docs\\custom-image-watermark.jpg")
```
🔹 Use case: Place a semi-transparent company logo in the corner of each page, or overlay a stamp image for approvals and certifications.

### Email attachments
Path: https://reference.groupdocs.com/watermark/python-net/guides/email-attachments.md

#### Extracting all attachments from email message

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

output_dir = os.path.join("SampleFiles", "Output")
os.makedirs(output_dir, exist_ok=True)

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    for attachment in content.attachments:
        print("Name:", attachment.name)
        print("File format:", attachment.get_document_info().file_type)
        with open(os.path.join(output_dir, attachment.name), "wb") as f:
            f.write(attachment.content)
```

#### Removing particular attachment from email message

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email
from groupdocs.watermark.common import FileType

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    for i in range(content.attachments.count - 1, -1, -1):
        attachment = content.attachments[i]
        if ("sample" in attachment.name) and (attachment.get_document_info().file_type == FileType.DOCX):
            content.attachments.remove_at(i)
    watermarker.save("message.msg")
```

#### Adding attachment to email message

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    with open("sample.msg", "rb") as f:
        content.attachments.add(f.read(), "sample.msg")
    watermarker.save("message.msg")
```

### Email messages
Path: https://reference.groupdocs.com/watermark/python-net/guides/email-messages.md

#### Modifying body and subject of email message

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    content.body = "Test plain text body"
    content.html_body = "<html><body>Test html body</body></html>"
    content.subject = "Test subject"
    watermarker.save("message.msg")
```

#### Embedding image to email message body

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    with open("sample.jpg", "rb") as f:
        content.embedded_objects.add(f.read(), "sample.jpg")
    embedded_object = content.embedded_objects[content.embedded_objects.count - 1]
    content.html_body = f"<html><body>This is an embedded image: <img src=\"cid:{embedded_object.content_id}\"></body></html>"
    watermarker.save("message.msg")
```

#### Removing all embedded images from email message body

```python
import re
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email
from groupdocs.watermark.common import FileType

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    for i in range(content.embedded_objects.count - 1, -1, -1):
        if content.embedded_objects[i].get_document_info().file_type == FileType.JPEG:
            pattern = rf"<img[^>]*src=\"cid:{re.escape(content.embedded_objects[i].content_id)}\"[^>]*>"
            content.html_body = re.sub(pattern, "", content.html_body)
            content.embedded_objects.remove_at(i)
    watermarker.save("message.msg")
```

#### Searching text in email message body or subject

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email
import groupdocs.watermark.search.searchcriteria as gws_sc
import groupdocs.watermark.search.objects as gws_objs

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    criteria = gws_sc.TextSearchCriteria("test", False)
    watermarker.searchable_objects.email_searchable_objects = (
        gws_objs.EmailSearchableObjects.SUBJECT
        | gws_objs.EmailSearchableObjects.HTML_BODY
        | gws_objs.EmailSearchableObjects.PLAIN_TEXT_BODY
    )
    watermarks = watermarker.search(criteria)
    watermarks.clear()
    watermarker.save("message.msg")
```

#### Listing all message recipients

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.email as gwc_email

load_options = gw.EmailLoadOptions()
with gw.Watermarker("message.msg", load_options) as watermarker:
    content = watermarker.get_content(gwc_email.EmailContent)
    for address in content.to:
        print(address.address)
    for address in content.cc:
        print(address.address)
    for address in content.bcc:
        print(address.address)
```

### Existing objects in diagrams
Path: https://reference.groupdocs.com/watermark/python-net/guides/existing-objects-in-diagram-document.md

Watermarks in Visio documents are usually shapes; sometimes headers and footers also contain text considered as watermark. You can find and remove watermarks of both types.

#### Removing watermark from a particular page

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx
import groupdocs.watermark.search.searchcriteria as gws_sc

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    text_criteria = gws_sc.TextSearchCriteria("Company Name")
    possible = content.pages[0].search(text_criteria.or_(image_criteria))
    possible.clear()
    watermarker.save("diagram.vsdx")
```

##### Extracting information about all shapes

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    for page in content.pages:
        for shape in page.shapes:
            if shape.image is not None:
                print(shape.image.width)
                print(shape.image.height)
                print(len(shape.image.get_bytes()))
            print(shape.name)
            print(shape.x)
            print(shape.y)
            print(shape.width)
            print(shape.height)
            print(shape.rotate_angle)
            print(shape.text)
            print(shape.id)
```

##### Removing a particular shape

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    content.pages[0].shapes.remove_at(0)
    content.pages[0].shapes.remove(content.pages[0].shapes[0])
    watermarker.save("diagram.vsdx")
```

##### Removing shapes with particular text formatting

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx
import groupdocs.watermark.watermarks as gww

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    for page in content.pages:
        for i in range(page.shapes.count - 1, -1, -1):
            for fragment in page.shapes[i].formatted_text_fragments:
                if fragment.foreground_color == gww.Color.red and fragment.font.family_name == "Arial":
                    page.shapes.remove_at(i)
                    break
    watermarker.save("diagram.vsdx")
```

##### Removing hyperlink associated with a particular shape

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    shape = content.pages[0].shapes[0]
    for i in range(shape.hyperlinks.count - 1, -1, -1):
        if "http://someurl.com" in shape.hyperlinks[i].address:
            shape.hyperlinks.remove_at(i)
    watermarker.save("diagram.vsdx")
```

##### Replacing text for particular shapes

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    for shape in content.pages[0].shapes:
        if shape.text and "© Aspose 2016" in shape.text:
            shape.text = "© GroupDocs 2017"
    watermarker.save("diagram.vsdx")
```

##### Replacing text for particular shapes with formatted text

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx
import groupdocs.watermark.watermarks as gww

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    for shape in content.pages[0].shapes:
        if shape.text and "© Aspose 2016" in shape.text:
            shape.formatted_text_fragments.clear()
            shape.formatted_text_fragments.add(
                "© GroupDocs 2017", gww.Font("Calibri", 19.0, gww.FontStyle.BOLD), gww.Color.red, gww.Color.aqua
            )
    watermarker.save("diagram.vsdx")
```

##### Replacing shape image

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    for shape in content.pages[0].shapes:
        if shape.image is not None:
            with open("test.png", "rb") as f:
                shape.image = gwc_vsdx.DiagramWatermarkableImage(f.read())
    watermarker.save("diagram.vsdx")
```

##### Extracting information about all headers and footers

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    print(content.header_footer.font.family_name)
    print(content.header_footer.font.size)
    print(content.header_footer.font.bold)
    print(content.header_footer.font.italic)
    print(content.header_footer.font.underline)
    print(content.header_footer.font.strikeout)
    print(content.header_footer.header_left)
    print(content.header_footer.header_center)
    print(content.header_footer.header_right)
    print(content.header_footer.footer_left)
    print(content.header_footer.footer_center)
    print(content.header_footer.footer_right)
    print(content.header_footer.text_color.to_argb())
    print(content.header_footer.footer_margin)
    print(content.header_footer.header_margin)
```

##### Removing or replacing a particular header and footer

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.diagram as gwc_vsdx
import groupdocs.watermark.watermarks as gww

load_options = gw.DiagramLoadOptions()
with gw.Watermarker("diagram.vsdx", load_options) as watermarker:
    content = watermarker.get_content(gwc_vsdx.DiagramContent)
    content.header_footer.header_center = None
    content.header_footer.footer_center = "Footer center"
    content.header_footer.font.size = 19
    content.header_footer.font.family_name = "Calibri"
    content.header_footer.text_color = gww.Color.red
    watermarker.save("diagram.vsdx")
```

### Existing objects in PDF document
Path: https://reference.groupdocs.com/watermark/python-net/guides/existing-objects-in-pdf-document.md

#### Removing watermark from a particular page
This sample searches a specific page for objects matching image or text criteria and removes the found items.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.search.searchcriteria as gws_sc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    text_criteria = gws_sc.TextSearchCriteria("Company Name")

    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    possible = pdf_content.pages[0].search(image_criteria.or_(text_criteria))
    for i in range(len(possible) - 1, -1, -1):
        possible.remove_at(i)

    watermarker.save("document.pdf")
```

#### Working with XObjects
These samples read and modify XObjects (reusable content) on PDF pages, including extracting info, deleting, watermarking images, and replacing text or images.

##### Extracting information about all XObjects in PDF document
This sample iterates through all XObjects on all pages and prints basic image, text, position, size, and rotation details.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for xobj in page.x_objects:
            if xobj.image is not None:
                print(xobj.image.width)
                print(xobj.image.height)
                print(len(xobj.image.get_bytes()))

            print(xobj.text)
            print(xobj.x)
            print(xobj.y)
            print(xobj.width)
            print(xobj.height)
            print(xobj.rotate_angle)
```

##### Removing a particular XObject
This sample removes XObjects by index and by reference from a selected page and then saves the document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    page = pdf_content.pages[0]
    page.x_objects.remove_at(0)
    page.x_objects.remove(page.x_objects[0])
    watermarker.save("document.pdf")
```

##### Removing XObjects containing text with particular text formatting
This sample scans XObjects for formatted text fragments and removes those that match a specific formatting condition (e.g., red foreground color).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for i in range(page.x_objects.count - 1, -1, -1):
            for fragment in page.x_objects[i].formatted_text_fragments:
                if fragment.foreground_color == gww.Color.red:
                    page.x_objects.remove_at(i)
                    break

    watermarker.save("document.pdf")
```

##### Adding watermark to all image XObjects
This sample overlays a centered, rotated text watermark onto every image contained inside XObjects across all pages.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    for page in pdf_content.pages:
        for xobj in page.x_objects:
            if xobj.image is not None:
                xobj.image.add(watermark)

    watermarker.save("document.pdf")
```

##### Replacing text for particular XObjects
These samples demonstrate updating XObject text content, either plain replacement or with custom font and colors.

###### Replacing text
This sample finds XObjects whose text contains a target substring and replaces it with new plain text.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for xobj in pdf_content.pages[0].x_objects:
        if "Test" in (xobj.text or ""):
            xobj.text = "Passed"

    watermarker.save("document.pdf")
```

###### Replacing text with formatting
This sample clears existing formatted fragments and inserts new text with specific font, style, and colors.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for xobj in pdf_content.pages[0].x_objects:
        if "Test" in (xobj.text or ""):
            xobj.formatted_text_fragments.clear()
            xobj.formatted_text_fragments.add(
                "Passed", gww.Font("Calibri", 19.0, gww.FontStyle.BOLD), gww.Color.red, gww.Color.aqua
            )

    watermarker.save("document.pdf")
```

##### Replacing image for particular XObjects
This sample replaces the image content of XObjects with a new image loaded from disk.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for xobj in pdf_content.pages[0].x_objects:
        if xobj.image is not None:
            with open("test.png", "rb") as f:
                xobj.image = gwc_pdf.PdfWatermarkableImage(f.read())

    watermarker.save("document.pdf")
```

#### Working with artifacts
These samples operate on PDF artifacts (headers, footers, watermarks, etc.), allowing extraction, deletion, conditional removal, watermarking, and content replacement.

##### Extracting information about all artifacts in PDF document
This sample iterates all artifacts on all pages and prints type, image details, text, opacity, position, size, and rotation.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for artifact in page.artifacts:
            print(artifact.artifact_type)
            print(artifact.artifact_subtype)
            if artifact.image is not None:
                print(artifact.image.width)
                print(artifact.image.height)
                print(len(artifact.image.get_bytes()))

            print(artifact.text)
            print(artifact.opacity)
            print(artifact.x)
            print(artifact.y)
            print(artifact.width)
            print(artifact.height)
            print(artifact.rotate_angle)
```

##### Removing a particular artifact
This sample removes artifacts by index and reference from a given page and saves the result.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    page = pdf_content.pages[0]
    page.artifacts.remove_at(0)
    page.artifacts.remove(page.artifacts[0])
    watermarker.save("document.pdf")
```

##### Removing artifacts containing text with particular text formatting
This sample deletes artifacts that contain text fragments satisfying a formatting rule (for example, font size greater than a threshold).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for i in range(page.artifacts.count - 1, -1, -1):
            for fragment in page.artifacts[i].formatted_text_fragments:
                if fragment.font.size > 42:
                    page.artifacts.remove_at(i)
                    break

    watermarker.save("document.pdf")
```

##### Adding watermark to all image artifacts
This sample applies a centered, rotated text watermark to every artifact that contains an image.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    for page in pdf_content.pages:
        for artifact in page.artifacts:
            if artifact.image is not None:
                artifact.image.add(watermark)

    watermarker.save("document.pdf")
```

##### Replacing text for particular artifacts
These samples show how to replace artifact text directly or recreate it with custom formatting.

###### Replacing artifact text
This sample replaces plain artifact text when it contains a target substring.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for artifact in pdf_content.pages[0].artifacts:
        if "Test" in (artifact.text or ""):
            artifact.text = "Passed"

    watermarker.save("document.pdf")
```

###### Replacing artifact text with formatting
This sample clears existing formatted text and adds new text with chosen font, style, and colors.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for artifact in pdf_content.pages[0].artifacts:
        if "Test" in (artifact.text or ""):
            artifact.formatted_text_fragments.clear()
            artifact.formatted_text_fragments.add(
                "Passed", gww.Font("Calibri", 19.0, gww.FontStyle.BOLD), gww.Color.red, gww.Color.aqua
            )

    watermarker.save("document.pdf")
```

##### Replacing image for particular artifacts
This sample replaces the image of matching artifacts with a new image loaded from disk.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for artifact in pdf_content.pages[0].artifacts:
        if artifact.image is not None:
            with open("test.png", "rb") as f:
                artifact.image = gwc_pdf.PdfWatermarkableImage(f.read())

    watermarker.save("document.pdf")
```

#### Working with annotations
These samples work with PDF annotations: extracting details, removing, conditionally deleting, watermarking images, and replacing text or images.

##### Extracting information about all annotations in PDF document
This sample walks through all annotations on all pages and prints image stats, text, position, size, and rotation.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for annotation in page.annotations:
            print(annotation.annotation_type)
            if annotation.image is not None:
                print(annotation.image.width)
                print(annotation.image.height)
                print(len(annotation.image.get_bytes()))

            print(annotation.text)
            print(annotation.x)
            print(annotation.y)
            print(annotation.width)
            print(annotation.height)
            print(annotation.rotate_angle)
```

##### Removing a particular annotation
This sample removes annotations from a page using index and reference methods and saves the document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    page = pdf_content.pages[0]
    page.annotations.remove_at(0)
    page.annotations.remove(page.annotations[0])
    watermarker.save("document.pdf")
```

##### Removing annotations containing text with particular text formatting
This sample deletes annotations whose formatted text fragments meet a specific condition (e.g., a particular font family).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for page in pdf_content.pages:
        for i in range(page.annotations.count - 1, -1, -1):
            for fragment in page.annotations[i].formatted_text_fragments:
                if fragment.font.family_name == "Verdana":
                    page.annotations.remove_at(i)
                    break

    watermarker.save("document.pdf")
```

##### Adding watermark to all image annotations
This sample places a centered, rotated text watermark over every annotation image in the document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    for page in pdf_content.pages:
        for annotation in page.annotations:
            if annotation.image is not None:
                annotation.image.add(watermark)

    watermarker.save("document.pdf")
```

##### Replacing text for particular annotations
These samples demonstrate replacing annotation text, either plain or with full formatting control.

###### Replacing annotation text
This sample replaces plain annotation text when it contains a target substring.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for annotation in pdf_content.pages[0].annotations:
        if "Test" in (annotation.text or ""):
            annotation.text = "Passed"

    watermarker.save("document.pdf")
```

###### Replacing annotation text with formatting
This sample clears existing formatted annotation text and adds new formatted content with specific font and colors.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for annotation in pdf_content.pages[0].annotations:
        if "Test" in (annotation.text or ""):
            annotation.formatted_text_fragments.clear()
            annotation.formatted_text_fragments.add(
                "Passed", gww.Font("Calibri", 19.0, gww.FontStyle.BOLD), gww.Color.red, gww.Color.aqua
            )

    watermarker.save("document.pdf")
```

##### Replacing image for particular annotations
This sample replaces the image within annotations with a new image read from disk.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    for annotation in pdf_content.pages[0].annotations:
        if annotation.image is not None:
            with open("test.png", "rb") as f:
                annotation.image = gwc_pdf.PdfWatermarkableImage(f.read())

    watermarker.save("document.pdf")
```

### Existing objects in word processing document
Path: https://reference.groupdocs.com/watermark/python-net/guides/existing-objects-in-word-processing-document.md

Watermarks in Word documents are usually represented by shapes. Using GroupDocs.Watermark you can remove shapes of any type from any level of the document structure, or inspect and modify them.

#### Removing watermark from a particular section
This sample searches a section for shapes matching image or text criteria and removes the found watermarks.

Steps:

1. Load the document
2. Create and initialize image or text search criteria
3. Find possible watermarks
4. Remove found watermarks
5. Save the document

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp
import groupdocs.watermark.search.searchcriteria as gws_sc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    text_criteria = gws_sc.TextSearchCriteria("Company Name")

    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    possible = content.sections[0].search(text_criteria.or_(image_criteria))

    for i in range(len(possible) - 1, -1, -1):
        possible.remove_at(i)

    watermarker.save("document.docx")
```

##### Search for particular header or footer
This sample narrows the search to a specific header or footer and removes matching shapes.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp
import groupdocs.watermark.search.searchcriteria as gws_sc
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    text_criteria = gws_sc.TextSearchCriteria("Company Name")

    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    header_footer = content.sections[0].headers_footers[gwc.OfficeHeaderFooterType.HEADER_PRIMARY]
    possible = header_footer.search(text_criteria.or_(image_criteria))

    for i in range(len(possible) - 1, -1, -1):
        possible.remove_at(i)

    watermarker.save("document.docx")
```

#### Extracting information about all shapes in a Word document
This sample iterates all shapes across sections and prints type, geometry, alignment, position, text, and image details.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for section in content.sections:
        for shape in section.shapes:
            if shape.header_footer is not None:
                print("In header/footer")

            print(shape.shape_type)
            print(shape.width)
            print(shape.height)
            print(shape.is_word_art)
            print(shape.rotate_angle)
            print(shape.alternative_text)
            print(shape.name)
            print(shape.x)
            print(shape.y)
            print(shape.text)

            if shape.image is not None:
                print(shape.image.width)
                print(shape.image.height)
                print(len(shape.image.get_bytes()))

            print(shape.horizontal_alignment)
            print(shape.vertical_alignment)
            print(shape.relative_horizontal_position)
            print(shape.relative_vertical_position)
```

#### Working with shape types
This sample detects specific shape types and modifies their formatted text fragments if matched.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for section in content.sections:
        for shape in section.shapes:
            if shape.shape_type == gwc_wp.WordProcessingShapeType.DIAGONAL_CORNERS_ROUNDED:
                print("Diagonal Corners Rounded shape found")
                shape.formatted_text_fragments.add(
                    "I am Diagonal Corner Rounded",
                    gww.Font("Calibri", 8.0, gww.FontStyle.BOLD),
                    gww.Color.red,
                    gww.Color.aqua,
                )

    watermarker.save("document.docx")
```

#### Removing a particular shape
This sample removes shapes by index and by reference within a section, then saves the document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)

    # Remove shape by index
    content.sections[0].shapes.remove_at(0)

    # Remove shape by reference
    shp = content.sections[0].shapes[0]
    content.sections[0].shapes.remove(shp)

    watermarker.save("document.docx")
```

#### Removing shapes with particular text formatting
This sample deletes shapes whose formatted text matches a condition (for example, red Arial fragments).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp
import groupdocs.watermark.watermarks as gww

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for section in content.sections:
        for i in range(section.shapes.count - 1, -1, -1):
            for fragment in section.shapes[i].formatted_text_fragments:
                if fragment.foreground_color == gww.Color.red and fragment.font.family_name == "Arial":
                    section.shapes.remove_at(i)
                    break

    watermarker.save("document.docx")
```

#### Removing or replacing hyperlink associated with a particular shape
This sample updates or clears hyperlinks assigned to shapes.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)

    # Replace hyperlink
    content.sections[0].shapes[0].hyperlink = "https://www.groupdocs.com/"

    # Remove hyperlink
    content.sections[0].shapes[1].hyperlink = None

    watermarker.save("document.docx")
```

#### Replacing text for particular shapes
These samples show how to replace shape text either plainly or using formatted text fragments.

##### Replacing shape's text
This sample finds shapes containing target text and replaces it with new plain text.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for shape in content.sections[0].shapes:
        if "Some text" in (shape.text or ""):
            shape.text = "Another text"

    watermarker.save("document.docx")
```

##### Replacing shape's text with formatted text
This sample clears existing formatted fragments and inserts new text with specific font, style, and colors.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp
import groupdocs.watermark.watermarks as gww

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for shape in content.sections[0].shapes:
        if "Some text" in (shape.text or ""):
            shape.formatted_text_fragments.clear()
            shape.formatted_text_fragments.add(
                "Another text",
                gww.Font("Calibri", 19.0, gww.FontStyle.BOLD),
                gww.Color.red,
                gww.Color.aqua,
            )

    watermarker.save("document.docx")
```

#### Replacing shape's image
This sample replaces the raster image content of shapes with a new image loaded from disk.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for shape in content.sections[0].shapes:
        if shape.image is not None:
            with open("test.png", "rb") as f:
                img_bytes = f.read()
            shape.image = gwc_wp.WordProcessingWatermarkableImage(img_bytes)

    watermarker.save("document.docx")
```

#### Modifying shape properties
This sample updates shape properties like alternative text, rotation, position, layering, width, and height.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    for shape in content.sections[0].shapes:
        if "Some text" in (shape.text or ""):
            shape.alternative_text = "watermark"
            shape.rotate_angle = 30
            shape.x = 200
            shape.y = 200
            shape.height = 100
            shape.width = 400
            shape.behind_text = False

    watermarker.save("document.docx")
```

### Features overview
Path: https://reference.groupdocs.com/watermark/python-net/guides/features-overview.md

#### What Is GroupDocs.Watermark?

GroupDocs.Watermark for Java is a powerful API for managing watermarks in the documents of different file formats. It provides the effective watermarking methods that allow you to add watermarks that are hard to be automatically removed by third-party tools. It also allows you to search and remove previously added watermarks of popular types (including watermarks added by third-party tools) in a document. The API provides straightforward and easy to use set of methods to add, search, and remove watermarks in supported file formats.

#### Why Use GroupDocs.Watermark as a Developer?

*   Fetch all Documents of Various Formats from a Folder and Apply or Remove Watermarks
*   Add or Remove Watermark from a Particular Section or whole Document
*   Attach Watermark to all Images in a Particular Section, Page, Slide, or Document
*   Assign Watermark to only Particular Frames of a Multi-Framed Image
*   Allocate Hidden Watermark to PDF that only Appears when Printing Document
*   Set Watermark to all Attachments in an Excel Document & all Image Shapes in Slides
*   Place Watermark or Remove it from the Background Images of Spreadsheet or Slides
*   Employ Watermark to Supported Files in all Attachments of an Email or PDF Document
*   Apply or Remove Watermark as XObjects, Artifacts & Annotations in PDF Documents
*   Eliminate Watermark Containing Text with Particular Formatting
*   Look for Image Watermarks that Resemble a Particular Image
*   Identify Text Watermark Even if there are Unreadable Characters between Letters
*   Search Watermarks Based on Specific Parameters or by Combining Multiple Criteria
*   Specify Font Formatting to Look for Matching Text Watermark
*   Programmatically Extract Page Setup & Other Information for Supported Formats
*   Add Watermark to Images inside any Header & Footer in Supported Document Formats
*   Add Watermark to Image Shapes in a Word Document & Lock Watermarks to Restrict Editing
*   Protect Text Watermark using Unreadable Characters in Presentations
*   Rasterize Particular Page or Whole PDF Document to Protect Added Watermarks
*   Change Text Formatting While Replacing Existing Text Watermark
*   Align Watermark to Bleed Box, Art Box, Crop Box, or Trim Box in PDF Document

### Get document info
Path: https://reference.groupdocs.com/watermark/python-net/guides/get-document-info.md

GroupDocs.Watermark can obtain document information:

- FileType
- PageCount
- Size
- IsEncrypted

#### Get document information from a file from local disk

GroupDocs.Watermark lets you extract key details about a document before working with it. You can check its format, size, number of pages, and encryption status either from a file on disk or directly from a stream.

```python
import groupdocs.watermark as gw

with gw.Watermarker("source.docx") as watermarker:
    info = watermarker.get_document_info()
    print("File type:", info.file_type)
    print("Number of pages:", info.page_count)
    print("Document size:", info.size)
```

#### Get document information from a stream

```python
import io
import groupdocs.watermark as gw

with open("source.docx", "rb") as f:
    stream = io.BytesIO(f.read())

with gw.Watermarker(stream) as watermarker:
    info = watermarker.get_document_info()
    print("File type:", info.file_type)
    print("Number of pages:", info.page_count)
    print("Document size:", info.size)
```

🔹 Use case: Validate documents before processing (e.g., reject encrypted files, check page limits, or confirm file type).

### Get supported file formats
Path: https://reference.groupdocs.com/watermark/python-net/guides/get-supported-file-formats.md

Get the list of all supported file formats.

Quickly retrieve the complete list of file formats supported by GroupDocs.Watermark. This allows Python developers to dynamically check compatibility before processing documents.

```python
from groupdocs.watermark.common import FileType

supported = FileType.get_supported_file_types()
for ft in supported:
    print(ft)
```

🔹 Use case: Build flexible applications that can automatically validate user-uploaded files and inform them if watermarking is supported.

### Hello, World!
Path: https://reference.groupdocs.com/watermark/python-net/guides/hello-world.md

#### Introduction
A "Hello, World!" code is often the first simple example to write uisng "GroupDocs.Watermark for Python via .NET", and it can also be used as a sanity test to ensure the software intended to compile or run source code is correctly installed.

#### Overview
"GroupDocs.Watermark for Python via .NET" library allows you to add, search and remove watermarks from the documents in various formats. There are many other file formats are [supported](https://docs.groupdocs.com/watermark/python-net/supported-document-formats/).

#### Steps to Render a Document
The following steps outline how to render a document to HTML format using the GroupDocs.Watermark for Python via .Net:

1. Import `groupDocs.watermark`.
2. Import `groupDocs.watermark.watermarks` class.
3. Initialize a `Watermarker` object with the path to the sample document.
4. Initialize an `TextWatermark` object with the desired text and font for watermark.
5. Call add() method to add the watermark.

#### Code Snippet
Here is a "Hello, World!" example to demonstrate the working of the "GroupDocs.Watermark for Python via .Net" API:

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gwo

def run():
    with gw.Watermarker("sample.docx") as watermarker:
        font = gwo.Font("Arial", 36.0)
        watermark = gwo.TextWatermark("top secret", font)
        watermark.x = 100.0;
        watermark.y = 250.0;

        watermarker.add(watermark)
        watermarker.save("result.docx")
```
#### Run the Application
Steps to run the sample application:
1. Download the Sample Application:
    * [Download Hello World Sample Application](https://github.com/groupdocs-watermark/GroupDocs.Watermark-for-Python-via-.NET/blob/master/Examples/quick_start/hello_world.py)

2. Run the Application:
    * Navigate to the directory containing the `hello_world.py` script.
    * Run the script:
        ```bash 
        python hello_world.py
        ```

#### Expected Output
After running the application, you will find Docx document with added text watermark in the output directory.

#### Additional Resources
This demo application references the GroupDocs.Watermark for Python via .Net [code samples](https://github.com/groupdocs-watermark/GroupDocs.Watermark-for-Python-via-.NET).

### How to run examples
Path: https://reference.groupdocs.com/watermark/python-net/guides/how-to-run-examples.md

The complete project [GroupDocs.Watermark Examples](https://github.com/groupdocs-watermark/GroupDocs.Watermark-for-Python-via-.NET) with code examples and sample files is hosted at GitHub.

#### Run examples using PyPI

To get started make sure that [Python](https://www.python.org/) is installed.

1. Clone repository with examples `git clone https://github.com/groupdocs-watermark/GroupDocs.Watermark-for-Python-via-.NET.git`
2. Navigate to the examples folder `cd ./GroupDocs.Watermark-for-Python-via-.NET/`
3. Install the necessary packages with the `pip install groupdocs-watermark-net` command.
4. Navigate to the examples folder `cd ./Examples`
5. Run the examples with the `python runExamples.py` command.

To check what examples are available open `Examples/runExamples.py` file using your favorite text editor. Uncomment examples that you want to run and type `python runExamples.py` to start them.

#### Contribute

If you 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, you can fork the repository, edit the source code and create a pull request. We will review the changes and include them in the repository if found helpful.

### Install GroupDocs.Watermark for Python via .NET
Path: https://reference.groupdocs.com/watermark/python-net/guides/installation.md

#### Install using PIP from PyPI

All Python packages are hosted at [PyPI](https://pypi.org/project/groupdocs-watermark-net). You can easily reference GroupDocs.Watermark for Python via .NET API directly in your Python project by installing it with the following command.

```batch
pip install groupdocs-watermark-net
```

#### Download GroupDocs.Watermark from the official website

Visit [https://releases.groupdocs.com/watermark/python-net/](https://releases.groupdocs.com/watermark/net/) and download the **GroupDocs.Watermark** assemblies.

1. Download the Wheel File: On the download page, locate the latest version of the **GroupDocs.Watermark** package.
Click on the download link to download the wheel file containing the package.
2. Choose the destination folder where you want to place the package.
3. Install package via pip using downloaded package. For example,
```batch 
pip install .../groupdocs_watermark_net-24.5-py3-none-win32.whl
```

### Licensing and evaluation
Path: https://reference.groupdocs.com/watermark/python-net/guides/licensing-and-subscription.md

To study the system, you may want quick access to the API. To make this easier, GroupDocs.Watermark provides different plans for purchase and offers a Free Trial and a 30-day Temporary License for evaluation.

Note that there are a number of general policies and practices that guide you on how to evaluate, properly license, and purchase our products. You can find them in the [Purchase Policies and FAQ](https://purchase.groupdocs.com/policies) section.

#### Purchased License

After buying, apply the license file or include it as an embedded resource.

License needs to be set:
- Only once per application domain
- Before using any other GroupDocs.Watermark classes

##### License Applying Options

Licenses can be applied from different locations:

*   Explicit path
*   The folder containing the _GroupDocs.Watermark.dll_ file
*   The folder containing the assembly that called _GroupDocs.Watermark.dll_
*   The folder containing the entry assembly (your _.exe_)
*   As a Metered License that allows you to pay for your usage. For details, see the [Metered Licensing FAQ](https://purchase.groupdocs.com/faqs/licensing/metered/).

When you reference _GroupDocs.Watermark.dll_ in the application, the library is copied to your output directory (unless **Copy Local** in the properties for that entry is set to false). The easiest way to set a license is often to place the license file in the same folder as _GroupDocs.Watermark.dll_ and specify just the filename without the path.

Use the [setLicense](https://reference.groupdocs.com/watermark/net/groupdocs.watermark/license/setlicense/) method to license a component.

Calling `setLicense` multiple times is not harmful, it simply wastes processor time.

Calling [setMeteredKey](https://reference.groupdocs.com/watermark/net/groupdocs.watermark/metered/setmeteredkey/) multiple times is not harmful either but wastes processor time and can accumulate consumption improperly.

###### Apply the License

After obtaining the license, set it. This section explains how to do this. When developing your application, call the `setLicense` method in your startup code before using the GroupDocs.Watermark classes.

###### Set a License from a File

The following code snippet shows how to set a license from file:

```python
def run():
    if os.path.exists("path to .lic file"):    
        license = gv.License()
        license.set_license("path to .lic file")
        print("License set successfully.")
    else:
       print("\n")
```

###### Set a License from a Stream

The following code snippet shows how to set a license from a stream:

```python
if os.path.exists("path to .lic file"):
        with open("path to .lic file", "rb") as stream:
            gv.License().set_license(stream)

        print("License set successfully.")
    else:
        print("\n")
```

##### Changing the License File Name

You do not have to name the license file "GroupDocs.Watermark.lic". Feel free to rename it as you prefer, and use that name when setting the license in your application.

##### "Cannot find license filename" Exception

When you buy and download a license from the GroupDocs website, the license file is named "GroupDocs.Watermark.lic." Download it using your browser. Sometimes, browsers recognize it as XML and add the .xml extension, making the full file name "GroupDocs.Watermark.lic.XML" on your computer.

If Microsoft Windows is set to hide file extensions (which is the default in most installations), the license file will show as "GroupDocs.Watermark.lic" in Windows Explorer. You might assume this is the actual file name and call the `setLicense` method with "GroupDocs.Watermark.lic", but there is no such file, leading to an exception.

To fix this issue, rename the file to remove the hidden .xml extension. Additionally, we suggest disabling the "Hide extensions" option in Microsoft Windows.

#### How to Evaluate GroupDocs.Watermark

You can also try GroupDocs.Watermark without buying a license.

##### Free Trial

The evaluation version is identical to the purchased one; it becomes licensed once you set the license. You can set the license using methods described in the following sections of this article.

The evaluation version has the following limitations:

- Rendering is limited to the first 2 pages.
- Trial badges are added to the top of a rendered page.

##### Temporary License

If you want to test GroupDocs.Watermark without the limitations of the trial version,   request a 30-day Temporary License. For details, see the ["Get a Temporary License"](https://purchase.groupdocs.com/temporary-license) page.

### Locking watermark in word processing document
Path: https://reference.groupdocs.com/watermark/python-net/guides/locking-watermark-in-word-processing-document.md

You can lock watermarks in a Word document to restrict editing. GroupDocs.Watermark provides several lock types:

- AllowOnlyRevisions
- AllowOnlyComments
- AllowOnlyFormFields
- ReadOnly
- ReadOnlyWithEditableContent

Use `lock_type` in `WordProcessingWatermarkBaseOptions` (and descendants) to set the lock type.

#### Adding watermark to all pages
This sample adds a locked text watermark across all pages using a chosen lock type (and optional password).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Watermark text", gww.Font("Arial", 19.0))
    watermark.foreground_color = gww.Color.red

    options = gwo_wp.WordProcessingWatermarkPagesOptions()
    options.is_locked = True
    options.lock_type = gwo_wp.WordProcessingLockType.ALLOW_ONLY_FORM_FIELDS
    # options.password = "7654321"

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

#### Adding watermark to particular pages
This sample applies a locked watermark only to specific pages referenced by their numbers.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Watermark text", gww.Font("Arial", 19.0))
    watermark.foreground_color = gww.Color.red

    options = gwo_wp.WordProcessingWatermarkPagesOptions()
    options.page_numbers = [1, 3]
    options.is_locked = True
    options.lock_type = gwo_wp.WordProcessingLockType.ALLOW_ONLY_COMMENTS
    # options.password = "7654321"

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

#### Adding watermark to a section
This sample inserts a locked watermark into a specific section, restricting edits according to the lock type.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Watermark text", gww.Font("Arial", 19.0))
    watermark.foreground_color = gww.Color.red

    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.section_index = 0
    options.is_locked = True
    options.lock_type = gwo_wp.WordProcessingLockType.READ_ONLY_WITH_EDITABLE_CONTENT
    # options.password = "7654321"

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

### Modifying found watermark properties
Path: https://reference.groupdocs.com/watermark/python-net/guides/modifying-found-watermark-properties.md

GroupDocs.Watermark lets you replace text or images in watermarks that already exist in a document.

#### Replacing text

Loop through found watermarks and set the `text` property.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextSearchCriteria("test", False)
    possible = watermarker.search(criteria)
    for wm in possible:
        try:
            wm.text = "passed"
        except Exception:
            # Entity may not support text editing or the value is invalid
            pass
    watermarker.save("document.pdf")
```

#### Replacing text with formatting

Use `formatted_text_fragments` to set styled text.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextSearchCriteria("test", False)
    possible = watermarker.search(criteria)
    for wm in possible:
        try:
            wm.formatted_text_fragments.clear()
            wm.formatted_text_fragments.add(
                "passed",
                gww.Font("Calibri", 19.0, gww.FontStyle.BOLD),
                gww.Color.red,
                gww.Color.aqua,
            )
        except Exception:
            # Entity may not support formatted text or values may be invalid
            pass
    watermarker.save("document.pdf")
```

#### Replacing image

Swap the image data of matched watermarks.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with open("image.png", "rb") as f:
    image_data = f.read()

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.ImageDctHashSearchCriteria("logo.bmp")
    possible = watermarker.search(criteria)
    for wm in possible:
        try:
            wm.image_data = image_data
        except Exception:
            # Entity may not support image replacement or image format is invalid
            pass
    watermarker.save("document.pdf")
```

### Document preview
Path: https://reference.groupdocs.com/watermark/python-net/guides/preview.md

Generate preview images for document pages.

Easily render document pages as images for preview purposes. With Python, you can generate page thumbnails (e.g., PNG or JPG) to display documents without fully opening them in a viewer.

#### Generate document preview

```python
import os
import io
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo

output_directory = os.path.join(os.getcwd(), "preview")
os.makedirs(output_directory, exist_ok=True)

def create_page_stream(number: int):
    path = os.path.join(output_directory, f"page{number}.png")
    return open(path, "wb")

def release_page_stream(number: int, stream):
    stream.close()

with gw.Watermarker("sample.pdf") as watermarker:
    preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
    preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
    preview_options.page_numbers = [1, 2]
    watermarker.generate_preview(preview_options)
```

The images will be created in the specified output directory.

🔹 Use case: Generate page previews for displaying in a web app, dashboard, or document management system without requiring end users to download the full file.

### GroupDocs.Watermark for Python overview
Path: https://reference.groupdocs.com/watermark/python-net/guides/product-overview.md

[GroupDocs.Watermark](https://products.groupdocs.com/watermark/nodejs-java) is a robust cross-platform library that allows to add watermarks that are hard to be automatically removed by third-party tools, search and remove previously added watermarks of popular types (including watermarks added by third-party tools) in a document.

The API provides the following features:

- Add text and image watermark to supported document formats.
- Search and remove text and image watermarks.
- Search watermarks in particular objects.
- Apply a watermark to images inside a document.
- Work with existing watermark objects.
- Extract information of watermark objects in a document.
- Perform PDF document rasterization.
- Fetch document basic information.
- Search watermarks by text formatting (font, color, etc.).
- Set background image for charts in Excel and PowerPoint documents.

* Windows, Linux, and macOS
* .NET Core 3.1 and higher

#### Get started with GroupDocs.Watermark for Python

If you are new to GroupDocs.Watermark, see the following topics first:

* [System requirements](https://docs.groupdocs.com/watermark/python-net/system-requirements/)
* [Installation](https://docs.groupdocs.com/watermark/python-net/installation/)
* [Licensing](https://docs.groupdocs.com/watermark/python-net/licensing-and-subscription/)

#### Technical support

If you encounter an issue while using GroupDocs.Watermark or have a technical question, feel free to create a post in our [Free Support Forum](https://forum.groupdocs.com/c/watermark/9). If free support is not sufficient, you can submit a ticket to our [Paid Support Helpdesk](https://helpdesk.groupdocs.com/).

### Protecting word processing documents
Path: https://reference.groupdocs.com/watermark/python-net/guides/protecting-word-processing-documents.md

You can protect Word documents with a password or remove protection. Supported protection types:

- AllowOnlyRevisions
- AllowOnlyComments
- AllowOnlyFormFields
- ReadOnly

#### Protecting a document
This sample enables document protection with a specified protection type and password.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    content.protect(gwc_wp.WordProcessingProtectionType.READ_ONLY, "7654321")
    watermarker.save("document.docx")
```

#### Unprotecting a document
This sample removes protection from the document so it can be edited freely.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.wordprocessing as gwc_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    content = watermarker.get_content(gwc_wp.WordProcessingContent)
    content.unprotect()
    watermarker.save("document.docx")
```

### Rasterize document or page
Path: https://reference.groupdocs.com/watermark/python-net/guides/rasterize-document-or-page.md

#### How to remove a watermark from a PDF
Watermarks in PDFs can be removed by third-party tools. If you need watermarks that are very hard to remove, rasterize the document: convert pages to images so content becomes non-editable.

#### Rasterize PDF document
This sample converts all PDF pages to images (after adding a watermark) to lock down content and make subsequent removal extremely difficult.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.TextWatermark("Do not copy", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0
    watermark.opacity = 0.5

    watermarker.add(watermark)
    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    pdf_content.rasterize(100, 100, gwc_pdf.PdfImageConversionFormat.PNG)
    watermarker.save("document.pdf")
```

You can't restore document content after saving the document. Rasterization significantly increases the size of the resultant PDF file.

#### Rasterize particular page of the PDF document
This sample rasterizes only a specified page of the PDF (with an applied watermark), leaving the rest of the document editable.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc
import groupdocs.watermark.options.pdf as gwo_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    watermark = gww.TextWatermark("Do not copy", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0
    watermark.opacity = 0.5

    options = gwo_pdf.PdfArtifactWatermarkOptions()
    options.page_index = 0
    watermarker.add(watermark, options)

    pdf_content = watermarker.get_content(gwc_pdf.PdfContent)
    pdf_content.pages[0].rasterize(100, 100, gwc_pdf.PdfImageConversionFormat.PNG)
    watermarker.save("document.pdf")
```

### Removing found watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/removing-found-watermarks.md

#### Remove watermark

Search for possible watermarks and remove them from the document.

```python
import groupdocs.watermark as gw

with gw.Watermarker("document.pdf") as watermarker:
    possible = watermarker.search()

    # Remove watermark at the specified index
    possible.remove_at(0)

    # Remove a specific watermark instance
    if possible.count > 0:
        possible.remove(possible[0])

    watermarker.save("document.pdf")
```

#### Remove watermark with particular text formatting

Search and clear watermarks that match font and color parameters.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextFormattingSearchCriteria()
    criteria.foreground_color_range = gws_sc.ColorRange()
    criteria.foreground_color_range.min_hue = -5
    criteria.foreground_color_range.max_hue = 10
    criteria.foreground_color_range.min_brightness = 0.01
    criteria.foreground_color_range.max_brightness = 0.99
    criteria.background_color_range = gws_sc.ColorRange()
    criteria.background_color_range.is_empty = True
    criteria.font_name = "Arial"
    criteria.min_font_size = 19
    criteria.max_font_size = 42
    criteria.font_bold = True

    possible = watermarker.search(criteria)
    possible.clear()

    watermarker.save("document.pdf")
```

#### Remove hyperlink watermarks

Find and remove hyperlinks with a particular URL using a regex. Ensure only hyperlinks are cleared.

```python
import re
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc
import groupdocs.watermark.search as gws

with gw.Watermarker("document.pdf") as watermarker:
    possible = watermarker.search(gws_sc.TextSearchCriteria(re.compile(r"someurl\.com")))
    # iterate backwards when removing by index
    for i in range(possible.count - 1, -1, -1):
        if isinstance(possible[i], gws.HyperlinkPossibleWatermark):
            print(possible[i].text)
            possible.remove_at(i)

    watermarker.save("document.pdf")
```

### Result of added watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/result-of-added-watermarks.md

GroupDocs.Watermark can return details about each added watermark, including a unique identifier (GUID), type, page number, and position. This enables scenarios such as tracing, searching, and removing specific watermarks by ID.

#### Reviewing the result of added watermarks

The following example shows how to review `AddWatermarkResult` with information about added watermarks in a document.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww

with gw.Watermarker("sample_2_pages.pdf") as watermarker:
    font = gww.Font("Arial", 19.0, gww.FontStyle.BOLD | gww.FontStyle.ITALIC)
    watermark = gww.TextWatermark("Test watermark", font)

    watermark.foreground_color = gww.Color.red
    watermark.background_color = gww.Color.blue
    watermark.text_alignment = gww.TextAlignment.RIGHT
    watermark.opacity = 0.5

    result = watermarker.add(watermark)

    for item in result.succeeded:
        print("WatermarkId:", item.watermark_id)
        print("WatermarkType:", item.watermark_type)
        print("PageNumber:", item.page_number)
        print("WatermarkPosition:", item.watermark_position)

    watermarker.save("output.pdf")
```

Example output:

```text
WatermarkId: 1a78ef44-d497-451f-8f03-ca08ea537cc8
WatermarkType: Text
PageNumber: 1
WatermarkPosition: Default

WatermarkId: 658179cf-7b6e-472a-8b24-30f845dc2a9a
WatermarkType: Text
PageNumber: 2
WatermarkPosition: Default
```

### Searching watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/searching-watermarks.md

#### Searching possible watermarks

Use `Watermarker.search()` to scan a document for objects that can be treated as watermarks. This includes watermarks added by third‑party tools.

```python
import groupdocs.watermark as gw

with gw.Watermarker("document.pdf") as watermarker:
    possible = watermarker.search()
    for wm in possible:
        if wm.image_data is not None:
            print(len(wm.image_data))

        print("Text", wm.text)
        print("X", wm.x)
        print("Y", wm.y)
        print("RotateAngle", wm.rotate_angle)
        print("Width", wm.width)
        print("Height", wm.height)
        print("PageNumber", wm.page_number)
        print("")
```

#### Search criteria

Large documents may contain many candidates. Without parameters, `search()` returns a subset such as backgrounds or floating objects. Use dedicated criteria to narrow results.

##### Text search criteria

Find watermarks by exact text.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    text_criteria = gws_sc.TextSearchCriteria("© 2017")
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

##### Regular expression search criteria

Use regex with `TextSearchCriteria`.

```python
import re
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    regex = re.compile(r"^© \d{4}$")
    text_criteria = gws_sc.TextSearchCriteria(regex)
    possible = watermarker.search(text_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

When `TextSearchCriteria` is provided, the API also scans the main document text along with shapes, XObjects, annotations, and other objects.

##### Image search criteria

Find image watermarks that are visually similar to a sample image using perceptual hashing (DCT hash). Control sensitivity with `max_difference` (0–1).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("watermark.jpg")
    image_criteria.max_difference = 0.9
    possible = watermarker.search(image_criteria)
    print("Found", possible.count, "possible watermark(s)")
```

Other image criteria:

- `ImageColorHistogramSearchCriteria`: robust to rotation, scaling, translation.
- `ImageThumbnailSearchCriteria`: robust to rotation, scaling, minor color changes.

##### Combined search criteria

Combine multiple criteria with logical And/Or/Not.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("logo.png")
    image_criteria.max_difference = 0.9
    text_criteria = gws_sc.TextSearchCriteria("Company Name")
    angle_criteria = gws_sc.RotateAngleSearchCriteria(30, 60)

    combined = image_criteria.or_(text_criteria).and_(angle_criteria)
    possible = watermarker.search(combined)
    print("Found", possible.count, "possible watermark(s)")
```

##### Text formatting search criteria

Find watermarks by text formatting such as font, size, and color ranges.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criteria = gws_sc.TextFormattingSearchCriteria()
    criteria.foreground_color_range = gws_sc.ColorRange()
    criteria.foreground_color_range.min_hue = -5
    criteria.foreground_color_range.max_hue = 10
    criteria.foreground_color_range.min_brightness = 0.01
    criteria.foreground_color_range.max_brightness = 0.99
    criteria.background_color_range = gws_sc.ColorRange()
    criteria.background_color_range.is_empty = True
    criteria.font_name = "Arial"
    criteria.min_font_size = 19
    criteria.max_font_size = 42
    criteria.font_bold = True

    possible = watermarker.search(criteria)
    print("Found", possible.count, "possible watermark(s)")
```

#### Searching watermarks in particular objects

Limit search to specific object types to improve performance, either globally via `WatermarkerSettings.searchable_objects` or per instance via `Watermarker.searchable_objects`.

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

settings = gw.WatermarkerSettings()
settings.searchable_objects = gws.SearchableObjects(
    word_processing_searchable_objects=gws.WordProcessingSearchableObjects.HYPERLINKS | gws.WordProcessingSearchableObjects.TEXT,
    spreadsheet_searchable_objects=gws.SpreadsheetSearchableObjects.HEADERS_FOOTERS,
    presentation_searchable_objects=gws.PresentationSearchableObjects.SLIDES_BACKGROUNDS | gws.PresentationSearchableObjects.SHAPES,
    diagram_searchable_objects=gws.DiagramSearchableObjects.NONE,
    pdf_searchable_objects=gws.PdfSearchableObjects.ALL,
)

files = ["document.docx", "spreadsheet.xlsx", "presentation.pptx", "diagram.vsdx", "document.pdf"]
for file in files:
    with gw.Watermarker(file, settings) as watermarker:
        possible = watermarker.search()
        print(f"In {os.path.basename(file)} found {possible.count} possible watermark(s).")
```

##### Searching for hyperlink watermarks

Restrict search to hyperlinks for a specific `Watermarker` instance.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search as gws

with gw.Watermarker("document.pdf") as watermarker:
    watermarker.searchable_objects.pdf_searchable_objects = gws.PdfSearchableObjects.HYPERLINKS
    possible = watermarker.search()
    print("Found", possible.count, "hyperlink watermark(s)")
```

#### Searching text watermark while skipping unreadable characters

Enable tolerant matching when text contains unreadable characters between letters.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("document.pdf") as watermarker:
    criterion = gws_sc.TextSearchCriteria("Company name")
    criterion.skip_unreadable_characters = True
    result = watermarker.search(criterion)
    print("Found", result.count, "possible watermark(s)")
```

### Shapes in spreadsheet document
Path: https://reference.groupdocs.com/watermark/python-net/guides/shapes-in-spreadsheet-document.md

#### Extracting information about all shapes in an Excel document
This sample iterates all worksheets and prints shape metadata, text, positioning, size, rotation, and image details.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for shape in worksheet.shapes:
            print(shape.auto_shape_type)
            print(shape.mso_drawing_type)
            print(shape.text)
            if shape.image is not None:
                print(shape.image.width)
                print(shape.image.height)
                print(len(shape.image.get_bytes())))

            print(shape.id)
            print(shape.alternative_text)
            print(shape.x)
            print(shape.y)
            print(shape.width)
            print(shape.height)
            print(shape.rotate_angle)
            print(shape.is_word_art)
            print(shape.name)
```

#### Removing a particular shape
This sample removes shapes from a worksheet by index and by reference, then saves the workbook.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    content.worksheets[0].shapes.remove_at(0)
    content.worksheets[0].shapes.remove(content.worksheets[0].shapes[0])
    watermarker.save("spreadsheet.xlsx")
```

#### Removing shapes with particular text formatting
This sample deletes shapes whose formatted text matches a condition (for example, red Arial fragments).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.watermarks as gww

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for i in range(worksheet.shapes.count - 1, -1, -1):
            for fragment in worksheet.shapes[i].formatted_text_fragments:
                if fragment.foreground_color == gww.Color.red and fragment.font.family_name == "Arial":
                    worksheet.shapes.remove_at(i)
                    break
    watermarker.save("spreadsheet.xlsx")
```

#### Removing/replacing hyperlink associated with a particular shape
This sample sets or clears hyperlinks on shapes and charts across worksheets.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    content.worksheets[0].charts[0].hyperlink = "https://www.aspose.com/"
    content.worksheets[0].shapes[0].hyperlink = "https://www.groupdocs.com/"
    content.worksheets[1].charts[0].hyperlink = None
    content.worksheets[1].shapes[0].hyperlink = None
    watermarker.save("spreadsheet.xlsx")
```

#### Replacing text for particular shapes
This sample finds shapes by exact text and replaces their text content with new plain text.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for shape in content.worksheets[0].shapes:
        if shape.text == "© Aspose 2016":
            shape.text = "© GroupDocs 2017"
    watermarker.save("spreadsheet.xlsx")
```

#### Replacing text for particular shapes with formatted text
This sample rebuilds a shape’s text using formatted fragments (font, style, and colors).

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.watermarks as gww

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for shape in content.worksheets[0].shapes:
        if shape.text == "© Aspose 2016":
            shape.formatted_text_fragments.clear()
            shape.formatted_text_fragments.add(
                "© GroupDocs 2017",
                gww.Font("Calibri", 19.0, gww.FontStyle.BOLD),
                gww.Color.red,
                gww.Color.aqua,
            )
    watermarker.save("spreadsheet.xlsx")
```

#### Replacing shape image
This sample replaces the image content of shapes with a new image loaded from disk.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for shape in content.worksheets[0].shapes:
        if shape.image is not None:
            with open("test.png", "rb") as f:
                shape.image = gwc_xls.SpreadsheetWatermarkableImage(f.read())
    watermarker.save("spreadsheet.xlsx")
```

#### Setting background image for particular shapes
This sample assigns a background image to shapes and configures transparency and tiling options.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for shape in content.worksheets[0].shapes:
        if shape.text == "© Aspose 2016":
            with open("test.png", "rb") as f:
                shape.image_fill_format.background_image = gwc_xls.SpreadsheetWatermarkableImage(f.read())
            shape.image_fill_format.transparency = 0.5
            shape.image_fill_format.tile_as_texture = True
    watermarker.save("spreadsheet.xlsx")
```

#### Updating shape properties
This sample updates several shape properties such as alternative text, rotation, position, and size.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for shape in content.worksheets[0].shapes:
        if shape.text == "© Aspose 2019":
            shape.alternative_text = "watermark"
            shape.rotate_angle = 30
            shape.x = 200
            shape.y = 200
            shape.width = 400
            shape.height = 100
    watermarker.save("spreadsheet.xlsx")
```

### Supported file formats
Path: https://reference.groupdocs.com/watermark/python-net/guides/supported-document-formats.md

<div style="margin: 20px 0; padding: 15px; background: #f8f9fa; border-radius: 8px; border-left: 4px solid #007bff;">
  <div style="margin-bottom: 15px;">
    <input type="text" id="formatSearch" placeholder="🔍 Search for a file format (e.g., docx, pdf, png)..."
           style="width: 100%; padding: 10px; border: 2px solid #ddd; border-radius: 6px; font-size: 16px;">
  </div>
  <div id="searchResults" style="display: none; margin-top: 15px; padding: 10px; background: white; border-radius: 6px; border: 1px solid #ddd;">
    <strong>Search Results:</strong>
    <div id="resultsList"></div>
  </div>
</div>

#### 🚀 Quick Format Lookup

**Popular Formats:** .docx | .pdf | .xlsx | .pptx | .png | .jpg

Each format may support different watermarking capabilities:
- ✅ Full support (Add / Search / Remove)
- ⚠️ Partial support (some limitations)
- ❌ Not supported

#### 📄 Microsoft Word Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.doc` | Microsoft Word 97 - 2007 Document | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.dot` | Microsoft Word 97 - 2007 Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.docx` | Office Open XML WordprocessingML Document (macro-free) | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.docm` | Office Open XML WordprocessingML Macro-Enabled Document | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.dotx` | Office Open XML WordprocessingML Template (macro-free) | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.dotm` | Word Open XML Macro-Enabled Document | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.rtf` | Rich Text Format File | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.odt` | ODF Text Document | ✅ | ✅ | ✅ | ✅ | ✅ | |

📘 See examples for [Word]() formats

#### 📊 Microsoft Excel Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.xlsx` | OOXML 2007-2010 | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.xlsm` | OOXML Macro Enabled Workbook | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.xltm` | OOXML Macro Enabled Workbook Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.xlt` | Microsoft Excel Template File | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.xltx` | Excel Open XML Spreadsheet Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.xls` | Excel Workbook 97-2003 | ✅ | ✅ | ✅ | ✅ | ✅ | |

📘 Excel watermarking [examples]()

#### 📈 Microsoft PowerPoint Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.pptx` | OOXML Presentation | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.pptm` | OOXML Macro Enabled Presentation | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.ppsx` | OOXML SlideShow | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.ppsm` | OOXML Macros Enabled Presentation | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.potx` | OOXML Presentation Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.potm` | OOXML Macro Enabled Presentation Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.ppt` | PowerPoint Presentation 97-2003 | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.pps` | PowerPoint SlideShow 97-2003 | ✅ | ✅ | ✅ | ✅ | ✅ | |

📘 PowerPoint watermarking [examples]()

#### 🧾 PDF Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.pdf` | PDF (Adobe Portable Document) format | ✅ | ✅ | ✅ | ✅ | ✅ | Watermark searching and removing is not available for rasterized pages |

📘 Add watermark to [PDF]()

#### ✉️ Email Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.eml` | Email Message Format | ✅ | ✅ | ⚠️ | ⚠️ | ⚠️ | Watermark management is available for attached documents and images |
| `.emlx` | Apple Mail Message | ✅ | ✅ | ⚠️ | ⚠️ | ⚠️ | Watermark management is available for attached documents and images |
| `.oft` | Microsoft Outlook Email Template | ✅ | ✅ | ⚠️ | ⚠️ | ⚠️ | Watermark management is available for attached documents and images |
| `.msg` | Outlook Email Message Format | ✅ | ✅ | ⚠️ | ⚠️ | ⚠️ | Watermark management is available for attached documents and images |

📘 Add watermark to MSG [files]()

#### 🖼️ Image Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.bmp` | Bitmap Picture (BMP) | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.gif` | Graphics Interchange Format (GIF) | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.jpg` / `.jpeg` / `.jpe` | Joint Photographic Experts Group (JPEG) | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.jp2` | JPEG2000 Core Image File | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.png` | Portable Network Graphics (PNG) | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.tiff` | Tagged Image File Format (TIFF) | ✅ | ✅ | ✅ | ❌ | ❌ | |
| `.webp` | WebP Image | ✅ | ✅ | ✅ | ❌ | ❌ | |

📘 Image watermarking [examples]()

#### 🎨 Microsoft Visio Formats

| Format | Description | Load | Save | Add | Search | Remove | Remarks |
|--------|-------------|------|------|-----|--------|--------|---------|
| `.vsd` | Microsoft Visio 2003-2010 Drawing | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vdx` | Microsoft Visio 2003-2010 XML Drawing | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vsdx` | Microsoft Visio Drawing | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vstx` | Microsoft Visio File Format | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vss` | Microsoft Visio 2003-2010 Stencil | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vssx` | Visio Stencil File Format | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vsdm` | Visio Macro-Enabled Drawing | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vssm` | Microsoft Visio Macro Enabled File Format | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vstm` | Visio Macro-Enabled Drawing Template | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vtx` | VTX Chiptune File | ✅ | ✅ | ✅ | ✅ | ✅ | |
| `.vsx` | Microsoft Visio 2003-2010 XML Stencil | ✅ | ✅ | ✅ | ✅ | ✅ | |

#### ℹ️ Notes

- Watermarking capabilities may vary depending on the document content and structure.
- For email formats, watermark operations are limited to attached documents and images within the email.
- For image formats, search and remove operations are not supported - only adding watermarks is available.
- PDF watermark searching and removing is not available for rasterized pages.
- For the latest updates, refer to the [Changelog](https://docs.groupdocs.com/watermark/python-net/release-notes/).
- If a format you need is not listed, feel free to [contact support](https://forum.groupdocs.com/).

**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/watermark/19), and our team will assist you.

<script>
document.addEventListener('DOMContentLoaded', function() {
    const searchInput = document.getElementById('formatSearch');
    const searchResults = document.getElementById('searchResults');
    const resultsList = document.getElementById('resultsList');

    // Format database for search
    const formats = [
        { ext: '.doc', name: 'Microsoft Word 97-2007 Document', category: 'Word', support: 'Full' },
        { ext: '.docx', name: 'Office Open XML WordprocessingML Document', category: 'Word', support: 'Full' },
        { ext: '.docm', name: 'Office Open XML WordprocessingML Macro-Enabled Document', category: 'Word', support: 'Full' },
        { ext: '.dot', name: 'Microsoft Word 97-2007 Template', category: 'Word', support: 'Full' },
        { ext: '.dotx', name: 'Office Open XML WordprocessingML Template', category: 'Word', support: 'Full' },
        { ext: '.dotm', name: 'Word Open XML Macro-Enabled Document', category: 'Word', support: 'Full' },
        { ext: '.rtf', name: 'Rich Text Format File', category: 'Word', support: 'Full' },
        { ext: '.odt', name: 'ODF Text Document', category: 'Word', support: 'Full' },

        { ext: '.xlsx', name: 'OOXML 2007-2010', category: 'Excel', support: 'Full' },
        { ext: '.xlsm', name: 'OOXML Macro Enabled Workbook', category: 'Excel', support: 'Full' },
        { ext: '.xltm', name: 'OOXML Macro Enabled Workbook Template', category: 'Excel', support: 'Full' },
        { ext: '.xlt', name: 'Microsoft Excel Template File', category: 'Excel', support: 'Full' },
        { ext: '.xltx', name: 'Excel Open XML Spreadsheet Template', category: 'Excel', support: 'Full' },
        { ext: '.xls', name: 'Excel Workbook 97-2003', category: 'Excel', support: 'Full' },

        { ext: '.pptx', name: 'OOXML Presentation', category: 'PowerPoint', support: 'Full' },
        { ext: '.pptm', name: 'OOXML Macro Enabled Presentation', category: 'PowerPoint', support: 'Full' },
        { ext: '.ppsx', name: 'OOXML SlideShow', category: 'PowerPoint', support: 'Full' },
        { ext: '.ppsm', name: 'OOXML Macros Enabled Presentation', category: 'PowerPoint', support: 'Full' },
        { ext: '.potx', name: 'OOXML Presentation Template', category: 'PowerPoint', support: 'Full' },
        { ext: '.potm', name: 'OOXML Macro Enabled Presentation Template', category: 'PowerPoint', support: 'Full' },
        { ext: '.ppt', name: 'PowerPoint Presentation 97-2003', category: 'PowerPoint', support: 'Full' },
        { ext: '.pps', name: 'PowerPoint SlideShow 97-2003', category: 'PowerPoint', support: 'Full' },

        { ext: '.pdf', name: 'PDF (Adobe Portable Document) format', category: 'PDF', support: 'Full*' },

        { ext: '.eml', name: 'Email Message Format', category: 'Email', support: 'Partial' },
        { ext: '.emlx', name: 'Apple Mail Message', category: 'Email', support: 'Partial' },
        { ext: '.oft', name: 'Microsoft Outlook Email Template', category: 'Email', support: 'Partial' },
        { ext: '.msg', name: 'Outlook Email Message Format', category: 'Email', support: 'Partial' },

        { ext: '.bmp', name: 'Bitmap Picture', category: 'Image', support: 'Add Only' },
        { ext: '.gif', name: 'Graphics Interchange Format', category: 'Image', support: 'Add Only' },
        { ext: '.jpg', name: 'Joint Photographic Experts Group', category: 'Image', support: 'Add Only' },
        { ext: '.jpeg', name: 'Joint Photographic Experts Group', category: 'Image', support: 'Add Only' },
        { ext: '.jpe', name: 'Joint Photographic Experts Group', category: 'Image', support: 'Add Only' },
        { ext: '.jp2', name: 'JPEG2000 Core Image File', category: 'Image', support: 'Add Only' },
        { ext: '.png', name: 'Portable Network Graphics', category: 'Image', support: 'Add Only' },
        { ext: '.tiff', name: 'Tagged Image File Format', category: 'Image', support: 'Add Only' },
        { ext: '.webp', name: 'WebP Image', category: 'Image', support: 'Add Only' },

        { ext: '.vsd', name: 'Microsoft Visio 2003-2010 Drawing', category: 'Visio', support: 'Full' },
        { ext: '.vdx', name: 'Microsoft Visio 2003-2010 XML Drawing', category: 'Visio', support: 'Full' },
        { ext: '.vsdx', name: 'Microsoft Visio Drawing', category: 'Visio', support: 'Full' },
        { ext: '.vstx', name: 'Microsoft Visio File Format', category: 'Visio', support: 'Full' },
        { ext: '.vss', name: 'Microsoft Visio 2003-2010 Stencil', category: 'Visio', support: 'Full' },
        { ext: '.vssx', name: 'Visio Stencil File Format', category: 'Visio', support: 'Full' },
        { ext: '.vsdm', name: 'Visio Macro-Enabled Drawing', category: 'Visio', support: 'Full' },
        { ext: '.vssm', name: 'Microsoft Visio Macro Enabled File Format', category: 'Visio', support: 'Full' },
        { ext: '.vstm', name: 'Visio Macro-Enabled Drawing Template', category: 'Visio', support: 'Full' },
        { ext: '.vtx', name: 'VTX Chiptune File', category: 'Visio', support: 'Full' },
        { ext: '.vsx', name: 'Microsoft Visio 2003-2010 XML Stencil', category: 'Visio', support: 'Full' }
    ];

    function getSupportIcon(support) {
        switch(support) {
            case 'Full': return '✅';
            case 'Full*': return '✅*';
            case 'Partial': return '⚠️';
            case 'Add Only': return '🔸';
            default: return '❌';
        }
    }

    function performSearch(query) {
        if (!query || query.length < 2) {
            searchResults.style.display = 'none';
            return;
        }

        query = query.toLowerCase();
        const matches = formats.filter(format =>
            format.ext.toLowerCase().includes(query) ||
            format.name.toLowerCase().includes(query) ||
            format.category.toLowerCase().includes(query)
        );

        if (matches.length > 0) {
            resultsList.innerHTML = matches.map(match => `
                <div style="padding: 8px; margin: 5px 0; background: #f0f8ff; border-left: 3px solid #007bff; border-radius: 4px;">
                    <strong>${match.ext}</strong> - ${match.name}
                    <br><small>Category: ${match.category} | Support: ${getSupportIcon(match.support)} ${match.support}</small>
                </div>
            `).join('');
            searchResults.style.display = 'block';
        } else {
            resultsList.innerHTML = '<div style="padding: 8px; color: #666;">No formats found matching your search.</div>';
            searchResults.style.display = 'block';
        }
    }

    searchInput.addEventListener('input', function(e) {
        performSearch(e.target.value);
    });

    searchInput.addEventListener('keydown', function(e) {
        if (e.key === 'Escape') {
            searchResults.style.display = 'none';
            searchInput.value = '';
        }
    });

    // Hide search results when clicking outside
    document.addEventListener('click', function(e) {
        if (!e.target.closest('#formatSearch') && !e.target.closest('#searchResults')) {
            searchResults.style.display = 'none';
        }
    });
});
</script>

### System requirements
Path: https://reference.groupdocs.com/watermark/python-net/guides/system-requirements.md

GroupDocs.Watermark for Python via .NET does not require any external software to be installed such as Microsoft Word, Microsoft Excel or Microsoft PowerPoint. To install GroupDocs.Watermark for Python just follow one of the ways as described in the [Installation]() section.

#### Requirements

* [Python 3.9](https://www.python.org/downloads/) or above
* [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) Runtime or above

#### Supported Operating Systems

GroupDocs.Watermark for Python can be used on any 32-bit or 64-bit operating system. Dependencies of .NET Core Runtime. Installing .NET Core Runtime itself is NOT required.

##### Windows

* Microsoft Windows Server 2003 and later
* Microsoft Windows XP (x64, x86)
* Microsoft Windows Vista (x64, x86)
* Microsoft Windows 7, 8, 8.1 (x64, x86)
* Microsoft Windows 10 (x64, x86)
* Microsoft Windows 11 (x64)

##### Linux
* Ubuntu
* OpenSUSE
* CentOS
* and others

#### Development Environments

GroupDocs.Watermark for Python requirements Python and .NET. You  can use any text editor like Atom, Sublime, Visual Studio Code, etc.

### Technical Support
Path: https://reference.groupdocs.com/watermark/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 [Free Support Forum](https://forum.groupdocs.com/) and [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.Watermark, consider the following:

* Make sure you are using the latest GroupDocs.Watermark version before reporting an issue. See [PyPI](https://pypi.org/project/groupdocs-watermark-net) to find out about the latest version.
* Have a look through the forums, this documentation, and the API Reference before reporting an issue – perhaps your question has already been answered.
* Post your question at [GroupDocs.Watermark Free Support Forum](https://forum.groupdocs.com/c/watermark/9), and we'll assist you. Questions are answered directly by the GroupDocs.Watermark development team.
* When expecting a reply on the forums, please allow for time zone differences.

#### Paid Support Helpdesk

The paid support issues has higher priority comparing to the free support requests.

* Post your question at the [Paid Support Helpdesk](https://helpdesk.groupdocs.com/) to set higher priority for the issue.

#### Report an Issue or Feature Request

When posting your issue, question, or feature request with GroupDocs.Watermark, follow these simple steps to make sure it is resolved in the most efficient way:

* Include the original document and possibly 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 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.
* Try to report one issue per thread. If you have another issue, question, or feature request, please report it in a separate thread.

### Update watermarks
Path: https://reference.groupdocs.com/watermark/python-net/guides/update.md

Search for existing watermarks and update them.

#### Updating text watermarks

Easily find and modify existing text watermarks in documents. With Python, you can search for a watermark by its text content and update it with a new value.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("C:\\Docs\\watermarked-sample.docx") as watermarker:
    criteria = gws_sc.TextSearchCriteria("Contract Draft", False)
    possible = watermarker.search(criteria)
    print("Found", possible.count, "possible watermark(s).")
    for wm in possible:
        try:
            wm.text = "Contract is no longer valid"
        except Exception:
            pass
    watermarker.save("C:\\Docs\\updated-sample.docx")
```

#### Updating image watermarks

Quickly replace old or incorrect image watermarks with new ones. Python developers can search for an image watermark using perceptual hashing and swap it with an updated logo or graphic.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.searchcriteria as gws_sc

with gw.Watermarker("C:\\Docs\\watermarked-sample.docx") as watermarker:
    image_criteria = gws_sc.ImageDctHashSearchCriteria("C:\\Docs\\logo.png")
    image_criteria.max_difference = 0.9
    possible = watermarker.search(image_criteria)
    print("Found", possible.count, "possible watermark(s).")
    with open("C:\\Docs\\new-logo.png", "rb") as f:
        image_data = f.read()
    for wm in possible:
        try:
            wm.image_data = image_data
        except Exception:
            pass
    watermarker.save("C:\\Docs\\updated-sample.docx")
```

### Watermarks in PDF document
Path: https://reference.groupdocs.com/watermark/python-net/guides/watermarks-in-pdf-document.md

Learn the ways GroupDocs.Watermark adds watermarks in PDF documents.

#### XObjects

When `add` on `Watermarker` is called, a simple XObject is added to the PDF.

Image XObject and Form XObject are used to add `ImageWatermark` and `TextWatermark` respectively. XObjects are page real content and are not removed by Adobe Acrobat sanitization.

#### Artifacts

Watermarks can be represented by artifacts. Add an artifact watermark using `PdfArtifactWatermarkOptions`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.options.pdf as gwo_pdf
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    options = gwo_pdf.PdfArtifactWatermarkOptions()

    text_watermark = gww.TextWatermark("This is an artifact watermark", gww.Font("Arial", 8.0))
    text_watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
    watermarker.add(text_watermark, options)

    with gww.ImageWatermark("logo.bmp") as image_watermark:
        watermarker.add(image_watermark, options)

    watermarker.save("document.pdf")
```

#### Annotations

Add annotation watermarks using `PdfAnnotationWatermarkOptions`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.contents.pdf as gwc_pdf
import groupdocs.watermark.options.pdf as gwo_pdf
import groupdocs.watermark.common as gwc

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    options = gwo_pdf.PdfAnnotationWatermarkOptions()

    text_watermark = gww.TextWatermark("This is a annotation watermark", gww.Font("Arial", 8.0))
    text_watermark.horizontal_alignment = gwc.HorizontalAlignment.LEFT
    text_watermark.vertical_alignment = gwc.VerticalAlignment.TOP
    watermarker.add(text_watermark, options)

    with gww.ImageWatermark("protect.jpg") as image_watermark:
        image_watermark.horizontal_alignment = gwc.HorizontalAlignment.RIGHT
        image_watermark.vertical_alignment = gwc.VerticalAlignment.TOP
        watermarker.add(image_watermark, options)

    watermarker.save("document.pdf")
```

#### Print-only annotations

Make an annotation print-only using `print_only`.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.pdf as gwo_pdf

load_options = gw.PdfLoadOptions()
with gw.Watermarker("document.pdf", load_options) as watermarker:
    text_watermark = gww.TextWatermark(
        "This is a print only test watermark. It won't appear in view mode.",
        gww.Font("Arial", 8.0),
    )

    options = gwo_pdf.PdfAnnotationWatermarkOptions()
    options.page_index = 0
    options.print_only = True

    watermarker.add(text_watermark, options)
    watermarker.save("document.pdf")
```

### Watermarks in word processing document
Path: https://reference.groupdocs.com/watermark/python-net/guides/watermarks-in-word-processing-document.md

When adding a watermark in Microsoft Word, a shape with appropriate content is placed in section headers. GroupDocs.Watermark uses the same approach. When calling `add` on `Watermarker`, a shape is added to the document.

#### Using properties of WordProcessingWatermarkBaseOptions
This sample sets additional shape watermark properties such as name and alternative text when inserting it.

Set additional options like `name` and `alternative_text` when adding a shape watermark.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.rotate_angle = 25.0
    watermark.foreground_color = gww.Color.red
    watermark.opacity = 1.0

    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.name = "Shape 1"
    options.alternative_text = "Test watermark"

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

#### Using WordProcessingTextEffects
This sample enables and configures line and outline effects for text-based shape watermarks.

Apply text effects to shape watermarks.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp
import groupdocs.watermark.common as gwc

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))

    effects = gwo_wp.WordProcessingTextEffects()
    effects.line_format.enabled = True
    effects.line_format.color = gww.Color.red
    effects.line_format.dash_style = gwc.OfficeDashStyle.DASH_DOT_DOT
    effects.line_format.line_style = gwc.OfficeLineStyle.TRIPLE
    effects.line_format.weight = 1

    options = gwo_wp.WordProcessingWatermarkSectionOptions()
    options.effects = effects

    watermarker.add(watermark, options)
    watermarker.save("document.docx")
```

#### Using WordProcessingImageEffects
This sample applies image effects (brightness, contrast, chroma key, border) to image-based shape watermarks.

Apply image effects to image-based shape watermarks.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.options.wordprocessing as gwo_wp

load_options = gw.WordProcessingLoadOptions()
with gw.Watermarker("document.docx", load_options) as watermarker:
    with gww.ImageWatermark("logo.png") as watermark:
        effects = gwo_wp.WordProcessingImageEffects()
        effects.brightness = 0.7
        effects.contrast = 0.6
        effects.chroma_key = gww.Color.red
        effects.border_line_format.enabled = True
        effects.border_line_format.weight = 1

        options = gwo_wp.WordProcessingWatermarkSectionOptions()
        options.effects = effects

        watermarker.add(watermark, options)

    watermarker.save("document.docx")
```

### Working with slide backgrounds
Path: https://reference.groupdocs.com/watermark/python-net/guides/working-with-slide-backgrounds.md

The API allows you to extract information about all slide backgrounds, remove a particular background, and add watermark to all background images.

#### Extracting information about all slide backgrounds
This sample iterates slides and prints size and byte-length details for each background image.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    for slide in content.slides:
        if slide.image_fill_format.background_image is not None:
            print(slide.image_fill_format.background_image.width)
            print(slide.image_fill_format.background_image.height)
            print(len(slide.image_fill_format.background_image.get_bytes()))
```

#### Removing a particular background
This sample clears the background image for a specific slide and saves the updated presentation.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    content.slides[0].image_fill_format.background_image = None
    watermarker.save("presentation.pptx")
```

#### Adding watermark to all background images
This sample applies a centered, rotated text watermark to every slide background image in the deck.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    content = watermarker.get_content(gwc_ppt.PresentationContent)
    for slide in content.slides:
        if slide.image_fill_format.background_image is not None:
            slide.image_fill_format.background_image.add(watermark)

    watermarker.save("presentation.pptx")
```

#### Additional settings for slide background image
This sample sets a custom background image and adjusts tiling and transparency options for a specific slide.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    slide = content.slides[0]
    with open("background.png", "rb") as f:
        slide.image_fill_format.background_image = gwc_ppt.PresentationWatermarkableImage(f.read())
    slide.image_fill_format.tile_as_texture = True
    slide.image_fill_format.transparency = 0.5
    watermarker.save("presentation.pptx")
```

#### Settings background image for charts
This sample assigns a background image to a chart and configures its transparency and tiling behavior.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.presentation as gwc_ppt

load_options = gw.PresentationLoadOptions()
with gw.Watermarker("presentation.pptx", load_options) as watermarker:
    content = watermarker.get_content(gwc_ppt.PresentationContent)
    with open("test.png", "rb") as f:
        content.slides[0].charts[0].image_fill_format.background_image = \
            gwc_ppt.PresentationWatermarkableImage(f.read())
    content.slides[0].charts[0].image_fill_format.transparency = 0.5
    content.slides[0].charts[0].image_fill_format.tile_as_texture = True
    watermarker.save("presentation.pptx")
```

### Working with spreadsheet document attachments
Path: https://reference.groupdocs.com/watermark/python-net/guides/working-with-spreadsheet-document-attachments.md

#### Extract all attachments from Excel document
This sample walks worksheets and lists metadata for each attachment, including placement, preview image size, and file details.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for attachment in worksheet.attachments:
            print("Alternative text:", attachment.alternative_text)
            print("Attachment frame x-coordinate:", attachment.x)
            print("Attachment frame y-coordinate:", attachment.y)
            print("Attachment frame width:", attachment.width)
            print("Attachment frame height:", attachment.height)
            print("Preview image size:", len(attachment.preview_image_content) if attachment.preview_image_content else 0)
            if attachment.is_link:
                print("Full path to the attached file:", attachment.source_full_name)
            else:
                info = attachment.get_document_info()
                print("File type:", info.file_type)
                print("Name of the source file:", attachment.source_full_name)
                print("File size:", len(attachment.content))
```

#### Add an attachment to Excel document
This sample embeds a file into a worksheet with a preview image and frame coordinates/sizes.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    worksheet = content.worksheets[0]
    with open("document.docx", "rb") as f_doc, open("document_preview.png", "rb") as f_prev:
        worksheet.attachments.add_attachment(
            f_doc.read(),
            "sample document.docx",
            f_prev.read(),
            50,
            100,
            200,
            400,
        )
    watermarker.save("spreadsheet.xlsx")
```

#### Add linked attachment to Excel document
This sample adds a link to an external file with a preview image and placement settings.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    worksheet = content.worksheets[0]
    with open("document_preview.png", "rb") as f_prev:
        worksheet.attachments.add_link(
            "document.docx",
            f_prev.read(),
            50,
            100,
            200,
            400,
        )
    watermarker.save("spreadsheet.xlsx")
```

#### Remove attachment from Excel document
This sample removes attachments based on conditions (e.g., broken link paths or encrypted files).

```python
import os
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for i in range(worksheet.attachments.count - 1, -1, -1):
            attachment = worksheet.attachments[i]
            if (attachment.is_link and not os.path.exists(attachment.source_full_name)) or \
               attachment.get_document_info().is_encrypted:
                worksheet.attachments.remove_at(i)
    watermarker.save("spreadsheet.xlsx")
```

#### Add watermark to all attachments
This sample opens each non-encrypted attached file and applies a text watermark in-place.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.watermarks as gww
from groupdocs.watermark.common import FileType

watermark = gww.TextWatermark("Test watermark", gww.Font("Arial", 19.0))

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for attachment in worksheet.attachments:
            info = attachment.get_document_info()
            if info.file_type != FileType.UNKNOWN and not info.is_encrypted:
                with attachment.create_watermarker() as attached_watermarker:
                    attached_watermarker.add(watermark)
                    attached_watermarker.save()
    watermarker.save("spreadsheet.xlsx")
```

#### Search for images in attached files
This sample searches inside attached files for image watermarks using DCT hash matching and reports findings.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.search.objects as gws_objs
import groupdocs.watermark.search.searchcriteria as gws_sc

settings = gw.WatermarkerSettings()
settings.searchable_objects.spreadsheet_searchable_objects = gws_objs.SpreadsheetSearchableObjects.ATTACHED_IMAGES

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options, settings) as watermarker:
    criteria = gws_sc.ImageDctHashSearchCriteria("attachment.png")
    possible = watermarker.search(criteria)
    print("Found", possible.count, "possible watermark(s).")
```

### Working with worksheet backgrounds
Path: https://reference.groupdocs.com/watermark/python-net/guides/working-with-worksheet-backgrounds.md

#### Extracting information about all worksheet backgrounds in an Excel document
This sample iterates worksheets and prints size and byte-length details for each background image.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        if worksheet.background_image is not None:
            print(worksheet.background_image.width)
            print(worksheet.background_image.height)
            print(len(worksheet.background_image.get_bytes()))
```

#### Removing a particular background
This sample clears the background image for a selected worksheet and saves the updated workbook.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    content.worksheets[0].background_image = None
    watermarker.save("spreadsheet.xlsx")
```

#### Adding watermark to all backgrounds in an Excel worksheet
This sample applies a centered, rotated text watermark to each worksheet’s background image.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        if worksheet.background_image is not None:
            worksheet.background_image.add(watermark)
    watermarker.save("spreadsheet.xlsx")
```

#### Settings background image for charts
This sample sets a chart’s background image and configures its transparency and tiling.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    with open("test.png", "rb") as f:
        content.worksheets[0].charts[0].image_fill_format.background_image = \
            gwc_xls.SpreadsheetWatermarkableImage(f.read())
    content.worksheets[0].charts[0].image_fill_format.transparency = 0.5
    content.worksheets[0].charts[0].image_fill_format.tile_as_texture = True
    watermarker.save("spreadsheet.xlsx")
```

### Working with worksheet headers and footers
Path: https://reference.groupdocs.com/watermark/python-net/guides/working-with-worksheet-headers-and-footers.md

#### Extracting information about all headers and footers in an Excel document
This sample enumerates all headers/footers and prints section details, including image stats and script content.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for header_footer in worksheet.headers_footers:
            print(header_footer.header_footer_type)
            for section in header_footer.sections:
                print(section.section_type)
                if section.image is not None:
                    print(section.image.width)
                    print(section.image.height)
                    print(len(section.image.get_bytes()))
                print(section.script)
```

#### Clearing a particular header or footer
This sample clears both text and image content from a chosen header or footer type on a worksheet.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for section in content.worksheets[0].headers_footers[gwc.OfficeHeaderFooterType.HEADER_PRIMARY].sections:
        section.script = None
        section.image = None
    watermarker.save("spreadsheet.xlsx")
```

#### Clearing a particular section of header or footer
This sample targets a specific header/footer section and clears its image and script.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    section = content.worksheets[0].headers_footers[gwc.OfficeHeaderFooterType.HEADER_EVEN].sections[gwc_xls.SpreadsheetHeaderFooterSectionType.LEFT]
    section.image = None
    section.script = None
    watermarker.save("spreadsheet.xlsx")
```

#### Adding watermark to all images in header and footer
This sample applies a centered, rotated text watermark over all header/footer images across worksheets.

```python
import groupdocs.watermark as gw
import groupdocs.watermark.contents.spreadsheet as gwc_xls
import groupdocs.watermark.watermarks as gww
import groupdocs.watermark.common as gwc

load_options = gw.SpreadsheetLoadOptions()
with gw.Watermarker("spreadsheet.xlsx", load_options) as watermarker:
    watermark = gww.TextWatermark("Protected image", gww.Font("Arial", 8.0))
    watermark.horizontal_alignment = gwc.HorizontalAlignment.CENTER
    watermark.vertical_alignment = gwc.VerticalAlignment.CENTER
    watermark.rotate_angle = 45
    watermark.sizing_type = gww.SizingType.SCALE_TO_PARENT_DIMENSIONS
    watermark.scale_factor = 1.0

    content = watermarker.get_content(gwc_xls.SpreadsheetContent)
    for worksheet in content.worksheets:
        for header_footer in worksheet.headers_footers:
            for section in header_footer.sections:
                if section.image is not None:
                    section.image.add(watermark)
    watermarker.save("spreadsheet.xlsx")
```